SiteConfiguration.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Core\Configuration;
 
use Psr\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\DependencyInjection\Attribute\Autowire;
use Symfony\Component\Finder\Finder;
use Symfony\Component\Yaml\Yaml;
use ‪TYPO3\CMS\Core\Attribute\AsEventListener;
use ‪TYPO3\CMS\Core\Cache\Event\CacheWarmupEvent;
use ‪TYPO3\CMS\Core\Cache\Exception\InvalidDataException;
use ‪TYPO3\CMS\Core\Cache\Frontend\PhpFrontend;
use ‪TYPO3\CMS\Core\Configuration\Event\SiteConfigurationChangedEvent;
use ‪TYPO3\CMS\Core\Configuration\Event\SiteConfigurationLoadedEvent;
use ‪TYPO3\CMS\Core\Configuration\Loader\YamlFileLoader;
use ‪TYPO3\CMS\Core\SingletonInterface;
use ‪TYPO3\CMS\Core\Site\Entity\Site;
use ‪TYPO3\CMS\Core\Site\Entity\SiteSettings;
use ‪TYPO3\CMS\Core\Site\Entity\SiteTSconfig;
use ‪TYPO3\CMS\Core\Site\Entity\SiteTypoScript;
use ‪TYPO3\CMS\Core\Site\SiteSettingsFactory;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪SiteConfiguration implements ‪SingletonInterface
{
    protected string ‪$configFileName = 'config.yaml';
 
    protected string ‪$typoScriptSetupFileName = 'setup.typoscript';
 
    protected string ‪$typoScriptConstantsFileName = 'constants.typoscript';
 
    protected string ‪$pageTSconfigFileName = 'page.tsconfig';
 
    protected string ‪$contentSecurityFileName = 'csp.yaml';
 
    protected string ‪$cacheIdentifier = 'sites-configuration';
 
    protected ‪$firstLevelCache;
 
    public function ‪__construct(
        #[Autowire('%env(TYPO3:configPath)%/sites')]
        protected string $configPath,
        protected ‪SiteSettingsFactory $siteSettingsFactory,
        protected EventDispatcherInterface $eventDispatcher,
        #[Autowire(service: 'cache.core')]
        protected ‪PhpFrontend $cache
    ) {}
 
    public function ‪getAllExistingSites(bool $useCache = true): array
    {
        if ($useCache && $this->firstLevelCache !== null) {
            return ‪$this->firstLevelCache;
        }
        return $this->‪resolveAllExistingSites($useCache);
    }
 
    public function ‪resolveAllExistingSites(bool $useCache = true): array
    {
        $sites = [];
        $siteConfiguration = $this->‪getAllSiteConfigurationFromFiles($useCache);
        foreach ($siteConfiguration as ‪$identifier => $configuration) {
            // cast $identifier to string, as the identifier can potentially only consist of (int) digit numbers
            ‪$identifier = (string)‪$identifier;
            $siteSettings = $this->siteSettingsFactory->getSettings(‪$identifier, $configuration);
            $siteTypoScript = $this->‪getSiteTypoScript(‪$identifier);
            $siteTSconfig = $this->‪getSiteTSconfig(‪$identifier);
            $configuration['contentSecurityPolicies'] = $this->‪getContentSecurityPolicies(‪$identifier);
 
            $rootPageId = (int)($configuration['rootPageId'] ?? 0);
            if ($rootPageId > 0) {
                $sites[‪$identifier] = new Site(‪$identifier, $rootPageId, $configuration, $siteSettings, $siteTypoScript, $siteTSconfig);
            }
        }
        $this->firstLevelCache = $sites;
        return $sites;
    }
 
    public function ‪resolveAllExistingSitesRaw(): array
    {
        $sites = [];
        $siteConfiguration = $this->‪getAllSiteConfigurationFromFiles(false);
        foreach ($siteConfiguration as ‪$identifier => $configuration) {
            // cast $identifier to string, as the identifier can potentially only consist of (int) digit numbers
            ‪$identifier = (string)‪$identifier;
            $siteSettings = new SiteSettings($configuration['settings'] ?? []);
            $siteTypoScript = $this->‪getSiteTypoScript(‪$identifier);
 
            $rootPageId = (int)($configuration['rootPageId'] ?? 0);
            if ($rootPageId > 0) {
                $sites[‪$identifier] = new Site(‪$identifier, $rootPageId, $configuration, $siteSettings, $siteTypoScript);
            }
        }
        return $sites;
    }
 
    public function ‪getAllSiteConfigurationPaths(): array
    {
        ‪$finder = new Finder();
        $paths = [];
        try {
            ‪$finder->files()->depth(0)->name($this->configFileName)->in($this->configPath . '/*');
        } catch (\InvalidArgumentException $e) {
            ‪$finder = [];
        }
 
        foreach (‪$finder as $fileInfo) {
            $path = $fileInfo->getPath();
            $paths[basename($path)] = $path;
        }
        return $paths;
    }
 
    protected function ‪getAllSiteConfigurationFromFiles(bool $useCache = true): array
    {
        // Check if the data is already cached
        $siteConfiguration = $useCache ? $this->cache->require($this->cacheIdentifier) : false;
        if ($siteConfiguration !== false) {
            return $siteConfiguration;
        }
        ‪$finder = new Finder();
        try {
            ‪$finder->files()->depth(0)->name($this->configFileName)->in($this->configPath . '/*');
        } catch (\InvalidArgumentException $e) {
            // Directory $this->configPath does not exist yet
            ‪$finder = [];
        }
        $loader = GeneralUtility::makeInstance(YamlFileLoader::class);
        $siteConfiguration = [];
        foreach (‪$finder as $fileInfo) {
            $configuration = $loader->load(GeneralUtility::fixWindowsFilePath((string)$fileInfo));
            ‪$identifier = basename($fileInfo->getPath());
            $event = $this->eventDispatcher->dispatch(new SiteConfigurationLoadedEvent(‪$identifier, $configuration));
            $siteConfiguration[‪$identifier] = $event->getConfiguration();
        }
        $this->cache->set($this->cacheIdentifier, 'return ' . var_export($siteConfiguration, true) . ';');
 
        return $siteConfiguration;
    }
 
    public function ‪load(string ‪$siteIdentifier): array
    {
        $fileName = $this->configPath . '/' . ‪$siteIdentifier . '/' . ‪$this->configFileName;
        $loader = GeneralUtility::makeInstance(YamlFileLoader::class);
        return $loader->load(GeneralUtility::fixWindowsFilePath($fileName), ‪YamlFileLoader::PROCESS_IMPORTS);
    }
 
    protected function ‪getSiteTypoScript(string ‪$siteIdentifier): ?‪SiteTypoScript
    {
        $data = [
            'setup' => ‪$this->typoScriptSetupFileName,
            'constants' => ‪$this->typoScriptConstantsFileName,
        ];
        $definitions = [];
        foreach ($data as $type => $fileName) {
            $path = $this->configPath . '/' . ‪$siteIdentifier . '/' . $fileName;
            if (file_exists($path)) {
                $contents = @file_get_contents(GeneralUtility::fixWindowsFilePath($path));
                if ($contents !== false) {
                    $definitions[$type] = $contents;
                }
            }
        }
        if ($definitions === []) {
            return null;
        }
        return new ‪SiteTypoScript(...$definitions);
    }
 
    protected function ‪getSiteTSconfig(string ‪$siteIdentifier): ?‪SiteTSconfig
    {
        $pageTSconfig = null;
        $path = $this->configPath . '/' . ‪$siteIdentifier . '/' . ‪$this->pageTSconfigFileName;
        if (file_exists($path)) {
            $contents = @file_get_contents(GeneralUtility::fixWindowsFilePath($path));
            if ($contents !== false) {
                $pageTSconfig = $contents;
            }
        }
        if ($pageTSconfig === null) {
            return null;
        }
 
        return new ‪SiteTSconfig(
            pageTSconfig: $pageTSconfig
        );
    }
 
    protected function ‪getContentSecurityPolicies(string ‪$siteIdentifier): array
    {
        $fileName = $this->configPath . '/' . ‪$siteIdentifier . '/' . ‪$this->contentSecurityFileName;
        if (file_exists($fileName)) {
            $loader = GeneralUtility::makeInstance(YamlFileLoader::class);
            return $loader->load(GeneralUtility::fixWindowsFilePath($fileName), ‪YamlFileLoader::PROCESS_IMPORTS);
        }
        return [];
    }
 
    #[AsEventListener(event: SiteConfigurationChangedEvent::class)]
    public function ‪siteConfigurationChanged()
    {
        $this->firstLevelCache = null;
    }
 
    #[AsEventListener('typo3-core/site-configuration')]
    public function ‪warmupCaches(‪CacheWarmupEvent $event): void
    {
        if ($event->‪hasGroup('system')) {
            $this->‪getAllSiteConfigurationFromFiles(false);
        }
    }
}