SystemEnvironmentBuilder.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 ‪TYPO3\CMS\Core\Resource\Security\FileNameValidator;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Core\Utility\PathUtility;
 
class ‪SystemEnvironmentBuilder
{
    const ‪REQUESTTYPE_FE = 1;
    const ‪REQUESTTYPE_BE = 2;
    const ‪REQUESTTYPE_CLI = 4;
    const ‪REQUESTTYPE_AJAX = 8;
    const ‪REQUESTTYPE_INSTALL = 16;
 
    public static function ‪run(int $entryPointLevel = 0, int $requestType = self::REQUESTTYPE_FE)
    {
        ‪self::defineBaseConstants();
        ‪self::defineTypo3RequestTypes();
        ‪self::setRequestType($requestType | ($requestType === self::REQUESTTYPE_BE && strpos($_REQUEST['route'] ?? '', '/ajax/') === 0 ? TYPO3_REQUESTTYPE_AJAX : 0));
        ‪self::defineLegacyConstants($requestType === self::REQUESTTYPE_FE ? 'FE' : 'BE');
        $scriptPath = ‪self::calculateScriptPath($entryPointLevel, $requestType);
        $rootPath = ‪self::calculateRootPath($entryPointLevel, $requestType);
 
        ‪self::initializeGlobalVariables();
        ‪self::initializeGlobalTimeTrackingVariables();
        ‪self::initializeEnvironment($requestType, $scriptPath, $rootPath);
    }
 
    protected static function ‪createApplicationContext(): ‪ApplicationContext
    {
        $applicationContext = getenv('TYPO3_CONTEXT') ?: (getenv('REDIRECT_TYPO3_CONTEXT') ?: (getenv('HTTP_TYPO3_CONTEXT') ?: 'Production'));
        return new ‪ApplicationContext($applicationContext);
    }
 
    protected static function ‪defineBaseConstants()
    {
        // Check one of the constants and return early if already defined,
        // needed if multiple requests are handled in one process, for instance in functional testing.
        // This check can be removed in TYPO3 v11.0.
        if (defined('FILE_DENY_PATTERN_DEFAULT')) {
            return;
        }
 
        // A linefeed, a carriage return, a CR-LF combination
        defined('LF') ?: define('LF', chr(10));
        defined('CR') ?: define('CR', chr(13));
        defined('CRLF') ?: define('CRLF', CR . LF);
 
        // A generic constant to state we are in TYPO3 scope. This is especially used in script files
        // like ext_localconf.php that run in global scope without class encapsulation: "defined('TYPO3') or die();"
        // This is a security measure to prevent script output if those files are located within document root and
        // called directly without bootstrap and error handling setup.
        defined('TYPO3') ?: define('TYPO3', true);
 
        // Relative path from document root to typo3/ directory, hardcoded to "typo3/"
        if (!defined('TYPO3_mainDir')) {
            define('TYPO3_mainDir', 'typo3/');
        }
 
        define('FILE_DENY_PATTERN_DEFAULT', ‪FileNameValidator::DEFAULT_FILE_DENY_PATTERN);
        define('PHP_EXTENSIONS_DEFAULT', 'php,php3,php4,php5,php6,php7,php8,phpsh,inc,phtml,pht,phar');
        define('TYPO3_copyright_year', '1998-' . date('Y'));
        define('TYPO3_URL_GENERAL', 'https://typo3.org/');
        define('TYPO3_URL_LICENSE', 'https://typo3.org/project/licenses/');
        define('TYPO3_URL_EXCEPTION', 'https://typo3.org/go/exception/CMS/');
        define('TYPO3_URL_DONATE', 'https://typo3.org/community/contribute/donate/');
        define('TYPO3_URL_WIKI_OPCODECACHE', 'https://docs.typo3.org/m/typo3/guide-installation/master/en-us/Troubleshooting/Index.html#opcode-cache-messages');
    }
 
    protected static function ‪calculateScriptPath(int $entryPointLevel, int $requestType): string
    {
        $isCli = ‪self::isCliRequestType($requestType);
        // Absolute path of the entry script that was called
        $scriptPath = GeneralUtility::fixWindowsFilePath(self::getPathThisScript($isCli));
        $rootPath = ‪self::getRootPathFromScriptPath($scriptPath, $entryPointLevel);
        // Check if the root path has been set in the environment (e.g. by the composer installer)
        if (getenv('TYPO3_PATH_ROOT')) {
            if ($isCli && self::usesComposerClassLoading()) {
                // $scriptPath is used for various path calculations based on the document root
                // Therefore we assume it is always a subdirectory of the document root, which is not the case
                // in composer mode on cli, as the binary is in the composer bin directory.
                // Because of that, we enforce the document root path of this binary to be set
                $scriptName = 'typo3/sysext/core/bin/typo3';
            } else {
                // Base the script path on the path taken from the environment
                // to make relative path calculations work in case only one of both is symlinked
                // or has the real path
                $scriptName = ltrim(substr($scriptPath, strlen($rootPath)), '/');
            }
            $rootPath = rtrim(GeneralUtility::fixWindowsFilePath((string)getenv('TYPO3_PATH_ROOT')), '/');
            $scriptPath = $rootPath . '/' . $scriptName;
        }
        return $scriptPath;
    }
 
    protected static function ‪calculateRootPath(int $entryPointLevel, int $requestType): string
    {
        // Check if the root path has been set in the environment (e.g. by the composer installer)
        if (getenv('TYPO3_PATH_ROOT')) {
            return rtrim(GeneralUtility::fixWindowsFilePath((string)getenv('TYPO3_PATH_ROOT')), '/');
        }
        $isCli = ‪self::isCliRequestType($requestType);
        // Absolute path of the entry script that was called
        $scriptPath = GeneralUtility::fixWindowsFilePath(self::getPathThisScript($isCli));
        return ‪self::getRootPathFromScriptPath($scriptPath, $entryPointLevel);
    }
 
    protected static function ‪initializeGlobalVariables()
    {
        // Unset variable(s) in global scope (security issue #13959)
        ‪$GLOBALS['T3_SERVICES'] = [];
    }
 
    protected static function ‪initializeGlobalTimeTrackingVariables()
    {
        // EXEC_TIME is set so that the rest of the script has a common value for the script execution time
        ‪$GLOBALS['EXEC_TIME'] = time();
        // $ACCESS_TIME is a common time in minutes for access control
        ‪$GLOBALS['ACCESS_TIME'] = ‪$GLOBALS['EXEC_TIME'] - ‪$GLOBALS['EXEC_TIME'] % 60;
        // $SIM_EXEC_TIME is set to $EXEC_TIME but can be altered later in the script if we want to
        // simulate another execution-time when selecting from eg. a database
        ‪$GLOBALS['SIM_EXEC_TIME'] = ‪$GLOBALS['EXEC_TIME'];
        // If $SIM_EXEC_TIME is changed this value must be set accordingly
        ‪$GLOBALS['SIM_ACCESS_TIME'] = ‪$GLOBALS['ACCESS_TIME'];
    }
 
    protected static function ‪initializeEnvironment(int $requestType, string $scriptPath, string $sitePath)
    {
        if (getenv('TYPO3_PATH_ROOT')) {
            $rootPathFromEnvironment = rtrim(GeneralUtility::fixWindowsFilePath((string)getenv('TYPO3_PATH_ROOT')), '/');
            if ($sitePath !== $rootPathFromEnvironment) {
                // This means, that we re-initialized the environment during a single request
                // This currently only happens in custom code or during functional testing
                // Once the constants are removed, we might be able to remove this code here as well and directly pass an environment to the application
                $scriptPath = $rootPathFromEnvironment . substr($scriptPath, strlen($sitePath));
                $sitePath = $rootPathFromEnvironment;
            }
        }
 
        $projectRootPath = GeneralUtility::fixWindowsFilePath((string)getenv('TYPO3_PATH_APP'));
        $isDifferentRootPath = ($projectRootPath && $projectRootPath !== $sitePath);
        ‪Environment::initialize(
            static::createApplicationContext(),
            self::isCliRequestType($requestType),
            self::usesComposerClassLoading(),
            $isDifferentRootPath ? $projectRootPath : $sitePath,
            $sitePath,
            $isDifferentRootPath ? $projectRootPath . '/var'    : $sitePath . '/typo3temp/var',
            $isDifferentRootPath ? $projectRootPath . '/config' : $sitePath . '/typo3conf',
            $scriptPath,
            self::isRunningOnWindows() ? 'WINDOWS' : 'UNIX'
        );
    }
 
    protected static function ‪isRunningOnWindows(): bool
    {
        return stripos(PHP_OS, 'darwin') === false
            && stripos(PHP_OS, 'cygwin') === false
            && stripos(PHP_OS, 'win') !== false;
    }
 
    protected static function ‪getPathThisScript(bool $isCli)
    {
        if ($isCli) {
            return ‪self::getPathThisScriptCli();
        }
        return ‪self::getPathThisScriptNonCli();
    }
 
    protected static function ‪getPathThisScriptNonCli()
    {
        if (‪Environment::isRunningOnCgiServer() && !‪Environment::usesCgiFixPathInfo()) {
            throw new \Exception('TYPO3 does only support being used with cgi.fix_pathinfo=1 on CGI server APIs.', 1675108421);
        }
 
        return $_SERVER['SCRIPT_FILENAME'];
    }
 
    protected static function ‪getPathThisScriptCli()
    {
        // Possible relative path of the called script
        $scriptPath = $_SERVER['argv'][0] ?? $_ENV['_'] ?? $_SERVER['_'];
        // Find out if path is relative or not
        $isRelativePath = false;
        if (self::isRunningOnWindows()) {
            if (!preg_match('/^([a-zA-Z]:)?\\\\/', $scriptPath)) {
                $isRelativePath = true;
            }
        } elseif ($scriptPath[0] !== '/') {
            $isRelativePath = true;
        }
        // Concatenate path to current working directory with relative path and remove "/./" constructs
        if ($isRelativePath) {
            $workingDirectory = $_SERVER['PWD'] ?? getcwd();
            $scriptPath = $workingDirectory . '/' . preg_replace('/\\.\\//', '', $scriptPath);
        }
        return $scriptPath;
    }
 
    protected static function ‪getRootPathFromScriptPath($scriptPath, $entryPointLevel)
    {
        $entryScriptDirectory = ‪PathUtility::dirnameDuringBootstrap($scriptPath);
        if ($entryPointLevel > 0) {
            [$rootPath] = ‪GeneralUtility::revExplode('/', $entryScriptDirectory, $entryPointLevel + 1);
        } else {
            $rootPath = $entryScriptDirectory;
        }
        return $rootPath;
    }
 
    protected static function ‪usesComposerClassLoading(): bool
    {
        return defined('TYPO3_COMPOSER_MODE') && TYPO3_COMPOSER_MODE;
    }
 
    protected static function ‪defineTypo3RequestTypes()
    {
        // Check one of the constants and return early if already defined,
        // needed if multiple requests are handled in one process, for instance in functional testing.
        if (defined('TYPO3_REQUESTTYPE_FE')) {
            return;
        }
        define('TYPO3_REQUESTTYPE_FE', self::REQUESTTYPE_FE);
        define('TYPO3_REQUESTTYPE_BE', self::REQUESTTYPE_BE);
        define('TYPO3_REQUESTTYPE_CLI', self::REQUESTTYPE_CLI);
        define('TYPO3_REQUESTTYPE_AJAX', self::REQUESTTYPE_AJAX);
        define('TYPO3_REQUESTTYPE_INSTALL', self::REQUESTTYPE_INSTALL);
    }
 
    protected static function ‪setRequestType(int $requestType)
    {
        // Return early if already defined,
        // needed if multiple requests are handled in one process, for instance in functional testing.
        if (defined('TYPO3_REQUESTTYPE')) {
            return;
        }
        define('TYPO3_REQUESTTYPE', $requestType);
    }
 
    protected static function ‪defineLegacyConstants(string $mode)
    {
        // Return early if already defined,
        // needed if multiple requests are handled in one process, for instance in functional testing.
        if (defined('TYPO3_MODE')) {
            return;
        }
        define('TYPO3_MODE', $mode);
    }
 
    protected static function ‪isCliRequestType(?int $requestType): bool
    {
        if ($requestType === null) {
            $requestType = PHP_SAPI === 'cli' ? ‪self::REQUESTTYPE_CLI : ‪self::REQUESTTYPE_FE;
        }
 
        return ($requestType & self::REQUESTTYPE_CLI) === ‪self::REQUESTTYPE_CLI;
    }
}