Bootstrap.php

Go to the documentation of this file.

<?php
 
/*
 * 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\Core;
 
use Composer\Autoload\ClassLoader;
use Composer\InstalledVersions;
use Doctrine\Common\Annotations\AnnotationReader;
use Psr\Container\ContainerInterface;
use Psr\EventDispatcher\EventDispatcherInterface;
use Psr\Http\Message\ServerRequestInterface;
use ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
use ‪TYPO3\CMS\Core\Cache\Backend\BackendInterface;
use ‪TYPO3\CMS\Core\Cache\Backend\NullBackend;
use ‪TYPO3\CMS\Core\Cache\Backend\Typo3DatabaseBackend;
use ‪TYPO3\CMS\Core\Cache\Exception\InvalidBackendException;
use ‪TYPO3\CMS\Core\Cache\Exception\InvalidCacheException;
use ‪TYPO3\CMS\Core\Cache\Frontend\FrontendInterface;
use ‪TYPO3\CMS\Core\Cache\Frontend\PhpFrontend;
use ‪TYPO3\CMS\Core\Cache\Frontend\VariableFrontend;
use TYPO3\CMS\Core\Configuration\ConfigurationManager;
use ‪TYPO3\CMS\Core\Configuration\Extension\ExtLocalconfFactory;
use ‪TYPO3\CMS\Core\Configuration\Extension\ExtTablesFactory;
use ‪TYPO3\CMS\Core\Configuration\Tca\TcaFactory;
use ‪TYPO3\CMS\Core\Core\Event\BootCompletedEvent;
use ‪TYPO3\CMS\Core\DependencyInjection\Cache\ContainerBackend;
use TYPO3\CMS\Core\DependencyInjection\ContainerBuilder;
use ‪TYPO3\CMS\Core\Log\LogManager;
use TYPO3\CMS\Core\Package\Cache\ComposerPackageArtifact;
use ‪TYPO3\CMS\Core\Package\Cache\PackageCacheInterface;
use ‪TYPO3\CMS\Core\Package\Cache\PackageStatesPackageCache;
use ‪TYPO3\CMS\Core\Package\FailsafePackageManager;
use TYPO3\CMS\Core\Package\PackageManager;
use ‪TYPO3\CMS\Core\Service\DependencyOrderingService;
use ‪TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪Bootstrap
{
    public static function ‪init(
        ClassLoader $classLoader,
        bool $failsafe = false
    ): ContainerInterface {
        $requestId = new ‪RequestId();
 
        static::initializeClassLoader($classLoader);
        if (!‪Environment::isComposerMode() && ‪ClassLoadingInformation::isClassLoadingInformationAvailable()) {
            ‪ClassLoadingInformation::registerClassLoadingInformation();
        }
 
        static::startOutputBuffering();
 
        $configurationManager = static::createConfigurationManager();
        if (!static::checkIfEssentialConfigurationExists($configurationManager)) {
            $failsafe = true;
        }
        static::populateLocalConfiguration($configurationManager);
 
        $logManager = new ‪LogManager((string)$requestId);
        // LogManager is used by the core ErrorHandler (using GeneralUtility::makeInstance),
        // therefore we have to push the LogManager to GeneralUtility, in case there
        // happen errors before we call GeneralUtility::setContainer().
        GeneralUtility::setSingletonInstance(LogManager::class, $logManager);
 
        static::initializeErrorHandling();
 
        $disableCaching = $failsafe ? true : false;
        $coreCache = static::createCache('core', $disableCaching);
        $packageCache = static::createPackageCache($coreCache);
        $packageManager = static::createPackageManager(
            $failsafe ? FailsafePackageManager::class : PackageManager::class,
            $packageCache
        );
 
        static::setDefaultTimezone();
        static::setMemoryLimit();
 
        $assetsCache = static::createCache('assets', $disableCaching);
        $dependencyInjectionContainerCache = static::createCache('di');
 
        $bootState = new \stdClass();
        $bootState->complete = false;
        $bootState->cacheDisabled = $disableCaching;
 
        $builder = new ContainerBuilder([
            ClassLoader::class => $classLoader,
            ApplicationContext::class => ‪Environment::getContext(),
            ConfigurationManager::class => $configurationManager,
            LogManager::class => $logManager,
            RequestId::class => $requestId,
            'cache.di' => $dependencyInjectionContainerCache,
            'cache.core' => $coreCache,
            'cache.assets' => $assetsCache,
            PackageManager::class => $packageManager,
 
            // @internal
            'boot.state' => $bootState,
        ]);
 
        $container = $builder->createDependencyInjectionContainer($packageManager, $dependencyInjectionContainerCache, $failsafe);
 
        // Push the container to GeneralUtility as we want to make sure its
        // makeInstance() method creates classes using the container from now on.
        GeneralUtility::setContainer($container);
 
        // Reset LogManager singleton instance in order for GeneralUtility::makeInstance()
        // to proxy LogManager retrieval to ContainerInterface->get() from now on.
        GeneralUtility::removeSingletonInstance(LogManager::class, $logManager);
 
        // Push PackageManager instance to ExtensionManagementUtility
        ‪ExtensionManagementUtility::setPackageManager($packageManager);
 
        if ($failsafe) {
            $bootState->complete = true;
            return $container;
        }
 
        $eventDispatcher = $container->get(EventDispatcherInterface::class);
        $tcaFactory = $container->get(TcaFactory::class);
        $container->get(ExtLocalconfFactory::class)->load();
        static::unsetReservedGlobalVariables();
        ‪$GLOBALS['TCA'] = $tcaFactory->get();
        static::checkEncryptionKey();
        $bootState->complete = true;
        $eventDispatcher->dispatch(new ‪BootCompletedEvent(true));
 
        return $container;
    }
 
    public static function ‪startOutputBuffering()
    {
        ob_start();
    }
 
    public static function ‪baseSetup()
    {
        if (!‪Environment::isComposerMode() && ‪ClassLoadingInformation::isClassLoadingInformationAvailable()) {
            ‪ClassLoadingInformation::registerClassLoadingInformation();
        }
    }
 
    public static function ‪initializeClassLoader(ClassLoader $classLoader)
    {
        ‪ClassLoadingInformation::setClassLoader($classLoader);
 
        // Annotations used in unit tests
        AnnotationReader::addGlobalIgnoredName('test');
 
        // Annotations that control the extension scanner
        AnnotationReader::addGlobalIgnoredName('extensionScannerIgnoreFile');
        AnnotationReader::addGlobalIgnoredName('extensionScannerIgnoreLine');
    }
 
    public static function ‪checkIfEssentialConfigurationExists(ConfigurationManager $configurationManager): bool
    {
        if (!‪Environment::isComposerMode()
            && !file_exists(‪Environment::getLegacyConfigPath() . '/PackageStates.php')
        ) {
            // Early return in case system is not properly set up
            return false;
        }
 
        $systemConfigurationPath = $configurationManager->getSystemConfigurationFileLocation();
        $additionalConfigurationPath = $configurationManager->getAdditionalConfigurationFileLocation();
 
        $systemConfigurationFileExists = file_exists($systemConfigurationPath);
        $additionalConfigurationFileExists = file_exists($additionalConfigurationPath);
        if ($systemConfigurationFileExists && $additionalConfigurationFileExists) {
            // We have a complete configuration, off we go
            return true;
        }
 
        // If system configuration file exists and no legacy additional configuration is present, we are good
        $legacyAdditionConfigurationPath = ‪Environment::getLegacyConfigPath() . '/AdditionalConfiguration.php';
        $legacyAdditionalConfigurationFileExists = file_exists($legacyAdditionConfigurationPath);
        if ($systemConfigurationFileExists && !$legacyAdditionalConfigurationFileExists) {
            return true;
        }
 
        // @deprecated All code below is deprecated and can be removed with TYPO3 v14.0 and replaced with `return false;`
 
        // All other cases will probably need some migration work
        $migrated = false;
 
        // In case no system configuration file exists at this point, check for the legacy "LocalConfiguration"
        // file. If it exists, move it to the new location. Otherwise, the system is not complete.
        if (!$systemConfigurationFileExists) {
            $legacyLocalConfigurationPath = $configurationManager->getLocalConfigurationFileLocation();
            $legacySystemConfigurationFileExists = file_exists($legacyLocalConfigurationPath);
            if ($legacySystemConfigurationFileExists) {
                mkdir(dirname($systemConfigurationPath), 02775, true);
                rename($legacyLocalConfigurationPath, $systemConfigurationPath);
                $migrated = true;
            } else {
                // Directly return as essential system configuration does not exist
                return false;
            }
        }
        // In case no additional configuration file exists at this point, check for the legacy
        // "AdditionalConfiguration" file. If it exists, move it to the new location as well.
        if (!$additionalConfigurationFileExists && $legacyAdditionalConfigurationFileExists) {
            rename($legacyAdditionConfigurationPath, $additionalConfigurationPath);
            $migrated = true;
        }
 
        return $migrated;
    }
 
    public static function ‪createPackageManager($packageManagerClassName, ‪PackageCacheInterface $packageCache): PackageManager
    {
        $dependencyOrderingService = GeneralUtility::makeInstance(DependencyOrderingService::class);
        $packageManager = new $packageManagerClassName($dependencyOrderingService);
        $packageManager->setPackageCache($packageCache);
        $packageManager->initialize();
 
        return $packageManager;
    }
 
    public static function ‪createPackageCache(‪FrontendInterface $coreCache): ‪PackageCacheInterface
    {
        if (!‪Environment::isComposerMode()) {
            return new ‪PackageStatesPackageCache(‪Environment::getLegacyConfigPath() . '/PackageStates.php', $coreCache);
        }
 
        $composerInstallersPath = InstalledVersions::getInstallPath('typo3/cms-composer-installers');
        if ($composerInstallersPath === null) {
            throw new \RuntimeException('Package "typo3/cms-composer-installers" not found. Replacing the package is not allowed. Fork the package instead and pull in the fork with the same name.', 1636145677);
        }
 
        return new ComposerPackageArtifact(dirname($composerInstallersPath));
    }
 
    public static function ‪createConfigurationManager(): ConfigurationManager
    {
        return new ConfigurationManager();
    }
 
    protected static function ‪populateLocalConfiguration(ConfigurationManager $configurationManager)
    {
        $configurationManager->exportConfiguration();
    }
 
    public static function ‪createCache(string ‪$identifier, bool $disableCaching = false): ‪FrontendInterface
    {
        $cacheConfigurations = ‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['caching']['cacheConfigurations'] ?? [];
        $cacheConfigurations['di']['frontend'] = PhpFrontend::class;
        $cacheConfigurations['di']['backend'] = ContainerBackend::class;
        $cacheConfigurations['di']['options'] = [];
        $configuration = $cacheConfigurations[‪$identifier] ?? [];
 
        $frontend = $configuration['frontend'] ?? VariableFrontend::class;
        $backend = $configuration['backend'] ?? Typo3DatabaseBackend::class;
        $options = $configuration['options'] ?? [];
 
        if ($disableCaching) {
            $backend = NullBackend::class;
            $options = [];
        }
 
        $backendInstance = new $backend('production', $options);
        if (!$backendInstance instanceof ‪BackendInterface) {
            throw new ‪InvalidBackendException('"' . $backend . '" is not a valid cache backend object.', 1545260108);
        }
        if (is_callable([$backendInstance, 'initializeObject'])) {
            $backendInstance->initializeObject();
        }
 
        $frontendInstance = new $frontend(‪$identifier, $backendInstance);
        if (!$frontendInstance instanceof ‪FrontendInterface) {
            throw new ‪InvalidCacheException('"' . $frontend . '" is not a valid cache frontend object.', 1545260109);
        }
        if (is_callable([$frontendInstance, 'initializeObject'])) {
            $frontendInstance->initializeObject();
        }
 
        return $frontendInstance;
    }
 
    protected static function ‪setDefaultTimezone()
    {
        $timeZone = ‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['phpTimeZone'];
        if (empty($timeZone)) {
            // Time zone from the server environment (TZ env or OS query)
            $defaultTimeZone = @date_default_timezone_get();
            if ($defaultTimeZone !== '') {
                $timeZone = $defaultTimeZone;
            } else {
                $timeZone = 'UTC';
            }
        }
        // Set default to avoid E_WARNINGs with PHP > 5.3
        date_default_timezone_set($timeZone);
    }
 
    protected static function ‪initializeErrorHandling()
    {
        $productionExceptionHandlerClassName = ‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['productionExceptionHandler'];
        $debugExceptionHandlerClassName = ‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['debugExceptionHandler'];
 
        $errorHandlerClassName = ‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['errorHandler'];
        $errorHandlerErrors = ‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['errorHandlerErrors'] | E_USER_DEPRECATED;
        $exceptionalErrors = ‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['exceptionalErrors'];
 
        $displayErrorsSetting = (int)‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['displayErrors'];
        switch ($displayErrorsSetting) {
            case -1:
                $ipMatchesDevelopmentSystem = ‪GeneralUtility::cmpIP(GeneralUtility::getIndpEnv('REMOTE_ADDR'), ‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['devIPmask']);
                $exceptionHandlerClassName = $ipMatchesDevelopmentSystem ? $debugExceptionHandlerClassName : $productionExceptionHandlerClassName;
                $displayErrors = $ipMatchesDevelopmentSystem ? 1 : 0;
                $exceptionalErrors = $ipMatchesDevelopmentSystem ? $exceptionalErrors : 0;
                break;
            case 0:
                $exceptionHandlerClassName = $productionExceptionHandlerClassName;
                $displayErrors = 0;
                break;
            case 1:
                $exceptionHandlerClassName = $debugExceptionHandlerClassName;
                $displayErrors = 1;
                break;
            default:
                // Throw exception if an invalid option is set. A default for displayErrors is set
                // in very early install tool, coming from DefaultConfiguration.php. It is safe here
                // to just throw if there is no value for whatever reason.
                throw new \RuntimeException(
                    'The option $TYPO3_CONF_VARS[SYS][displayErrors] is not set to "-1", "0" or "1".',
                    1476046290
                );
        }
        @ini_set('display_errors', (string)$displayErrors);
 
        if (!empty($errorHandlerClassName)) {
            // Register an error handler for the given errorHandlerError
            $errorHandler = GeneralUtility::makeInstance($errorHandlerClassName, $errorHandlerErrors);
            $errorHandler->setExceptionalErrors($exceptionalErrors);
            if (is_callable([$errorHandler, 'setDebugMode'])) {
                $errorHandler->setDebugMode($displayErrors === 1);
            }
            if (is_callable([$errorHandler, 'registerErrorHandler'])) {
                $errorHandler->registerErrorHandler();
            }
        }
        if (!empty($exceptionHandlerClassName)) {
            // Registering the exception handler is done in the constructor
            GeneralUtility::makeInstance($exceptionHandlerClassName);
        }
    }
 
    protected static function ‪setMemoryLimit()
    {
        if ((int)‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['setMemoryLimit'] > 16) {
            @ini_set('memory_limit', (string)((int)‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['setMemoryLimit'] . 'm'));
        }
    }
 
    public static function ‪unsetReservedGlobalVariables()
    {
        unset(‪$GLOBALS['TCA']);
        unset(‪$GLOBALS['BE_USER']);
    }
 
    protected static function ‪checkEncryptionKey()
    {
        if (empty(‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'])) {
            throw new \RuntimeException(
                'TYPO3 Encryption is empty. $GLOBALS[\'TYPO3_CONF_VARS\'][\'SYS\'][\'encryptionKey\'] needs to be set for TYPO3 to work securely',
                1502987245
            );
        }
    }
 
    public static function ‪loadExtTables(bool $allowCaching = true, ‪FrontendInterface $coreCache = null)
    {
        $container = GeneralUtility::getContainer();
        if ($allowCaching) {
            $container->get(ExtTablesFactory::class)->load();
        } else {
            $container->get(ExtTablesFactory::class)->loadUncached();
        }
    }
 
    public static function ‪initializeBackendUser($className = BackendUserAuthentication::class, ServerRequestInterface $request = null)
    {
        $backendUser = GeneralUtility::makeInstance($className);
        // The global must be available very early, because methods below
        // might trigger code which relies on it. See: #45625
        ‪$GLOBALS['BE_USER'] = $backendUser;
        $backendUser->start($request);
    }
 
    public static function ‪initializeBackendAuthentication()
    {
        ‪$GLOBALS['BE_USER']->backendCheckLogin();
    }
}