[!!!][TASK] Remove last usages of $GLOBALS[T3_VAR]
[Packages/TYPO3.CMS.git] / typo3 / sysext / core / Classes / Core / SystemEnvironmentBuilder.php
index 7042946..90cbeea 100644 (file)
@@ -15,7 +15,7 @@ namespace TYPO3\CMS\Core\Core;
  */
 
 use TYPO3\CMS\Core\Utility\GeneralUtility;
-use TYPO3\CMS\Core\Utility\StringUtility;
+use TYPO3\CMS\Core\Utility\PathUtility;
 
 /**
  * Class to encapsulate base setup of bootstrap.
@@ -38,6 +38,17 @@ use TYPO3\CMS\Core\Utility\StringUtility;
  */
 class SystemEnvironmentBuilder
 {
+    /** @internal */
+    const REQUESTTYPE_FE = 1;
+    /** @internal */
+    const REQUESTTYPE_BE = 2;
+    /** @internal */
+    const REQUESTTYPE_CLI = 4;
+    /** @internal */
+    const REQUESTTYPE_AJAX = 8;
+    /** @internal */
+    const REQUESTTYPE_INSTALL = 16;
+
     /**
      * A list of supported CGI server APIs
      * NOTICE: This is a duplicate of the SAME array in GeneralUtility!
@@ -58,7 +69,7 @@ class SystemEnvironmentBuilder
      *
      * @var string[]
      */
-    protected static $disabledFunctions = null;
+    protected static $disabledFunctions;
 
     /**
      * Run base setup.
@@ -66,15 +77,31 @@ class SystemEnvironmentBuilder
      *
      * @internal This method should not be used by 3rd party code. It will change without further notice.
      * @param int $entryPointLevel Number of subdirectories where the entry script is located under the document root
+     * @param int $requestType
      */
-    public static function run($entryPointLevel = 0)
+    public static function run(int $entryPointLevel = 0, int $requestType = self::REQUESTTYPE_FE)
     {
         self::defineBaseConstants();
-        self::definePaths($entryPointLevel);
-        self::checkMainPathsExist();
+        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::initializeBasicErrorReporting();
+
+        $applicationContext = static::createApplicationContext();
+        self::initializeEnvironment($applicationContext, $requestType, $scriptPath, $rootPath);
+        GeneralUtility::presetApplicationContext($applicationContext);
+    }
+
+    protected static function createApplicationContext(): ApplicationContext
+    {
+        $applicationContext = getenv('TYPO3_CONTEXT') ?: (getenv('REDIRECT_TYPO3_CONTEXT') ?: 'Production');
+
+        return new ApplicationContext($applicationContext);
     }
 
     /**
@@ -82,122 +109,96 @@ class SystemEnvironmentBuilder
      */
     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.
+        if (defined('TYPO3_version')) {
+            return;
+        }
+
         // This version, branch and copyright
-        define('TYPO3_version', '9.0.0');
-        define('TYPO3_branch', '9.0');
-        define('TYPO3_copyright_year', '1998-2017');
+        define('TYPO3_version', '10.0.0-dev');
+        define('TYPO3_branch', '10.0');
+        define('TYPO3_copyright_year', '1998-' . date('Y'));
 
         // TYPO3 external links
         define('TYPO3_URL_GENERAL', 'https://typo3.org/');
         define('TYPO3_URL_LICENSE', 'https://typo3.org/typo3-cms/overview/licenses/');
         define('TYPO3_URL_EXCEPTION', 'https://typo3.org/go/exception/CMS/');
-        define('TYPO3_URL_MAILINGLISTS', 'http://lists.typo3.org/cgi-bin/mailman/listinfo');
-        define('TYPO3_URL_DOCUMENTATION', 'https://typo3.org/documentation/');
-        define('TYPO3_URL_DOCUMENTATION_TSREF', 'https://docs.typo3.org/typo3cms/TyposcriptReference/');
-        define('TYPO3_URL_DOCUMENTATION_TSCONFIG', 'https://docs.typo3.org/typo3cms/TSconfigReference/');
-        define('TYPO3_URL_CONSULTANCY', 'https://typo3.org/support/professional-services/');
-        define('TYPO3_URL_CONTRIBUTE', 'https://typo3.org/contribute/');
-        define('TYPO3_URL_SECURITY', 'https://typo3.org/teams/security/');
-        define('TYPO3_URL_DOWNLOAD', 'https://typo3.org/download/');
-        define('TYPO3_URL_SYSTEMREQUIREMENTS', 'https://typo3.org/typo3-cms/overview/requirements/');
-        define('TYPO3_URL_DONATE', 'https://typo3.org/donate/online-donation/');
+        define('TYPO3_URL_DONATE', 'https://typo3.org/community/contribute/donate/');
         define('TYPO3_URL_WIKI_OPCODECACHE', 'https://wiki.typo3.org/Opcode_Cache');
 
-        // A null, a tabulator, a linefeed, a carriage return, a substitution, a CR-LF combination
-        defined('NUL') ?: define('NUL', chr(0));
-        defined('TAB') ?: define('TAB', chr(9));
+        // A linefeed, a carriage return, a CR-LF combination
         defined('LF') ?: define('LF', chr(10));
         defined('CR') ?: define('CR', chr(13));
-        defined('SUB') ?: define('SUB', chr(26));
         defined('CRLF') ?: define('CRLF', CR . LF);
 
         // Security related constant: Default value of fileDenyPattern
-        define('FILE_DENY_PATTERN_DEFAULT', '\\.(php[3-7]?|phpsh|phtml|pht)(\\..*)?$|^\\.htaccess$');
+        define('FILE_DENY_PATTERN_DEFAULT', '\\.(php[3-7]?|phpsh|phtml|pht|phar|shtml|cgi)(\\..*)?$|\\.pl$|^\\.htaccess$');
         // Security related constant: List of file extensions that should be registered as php script file extensions
-        define('PHP_EXTENSIONS_DEFAULT', 'php,php3,php4,php5,php6,php7,phpsh,inc,phtml,pht');
-
-        // Operating system identifier
-        // Either "WIN" or empty string
-        defined('TYPO3_OS') ?: define('TYPO3_OS', self::getTypo3Os());
-
-        // Service error constants
-        // General error - something went wrong
-        define('T3_ERR_SV_GENERAL', -1);
-        // During execution it showed that the service is not available and should be ignored. The service itself should call $this->setNonAvailable()
-        define('T3_ERR_SV_NOT_AVAIL', -2);
-        // Passed subtype is not possible with this service
-        define('T3_ERR_SV_WRONG_SUBTYPE', -3);
-        // Passed subtype is not possible with this service
-        define('T3_ERR_SV_NO_INPUT', -4);
-        // File not found which the service should process
-        define('T3_ERR_SV_FILE_NOT_FOUND', -20);
-        // File not readable
-        define('T3_ERR_SV_FILE_READ', -21);
-        // File not writable
-        define('T3_ERR_SV_FILE_WRITE', -22);
-        // Passed subtype is not possible with this service
-        define('T3_ERR_SV_PROG_NOT_FOUND', -40);
-        // Passed subtype is not possible with this service
-        define('T3_ERR_SV_PROG_FAILED', -41);
+        define('PHP_EXTENSIONS_DEFAULT', 'php,php3,php4,php5,php6,php7,phpsh,inc,phtml,pht,phar');
+
+        // Relative path from document root to typo3/ directory, hardcoded to "typo3/"
+        if (!defined('TYPO3_mainDir')) {
+            define('TYPO3_mainDir', 'typo3/');
+        }
     }
 
     /**
-     * Calculate all required base paths and set as constants.
+     * Calculate script path. This is the absolute path to the entry script.
+     * Can be something like '.../public/index.php' or '.../public/typo3/index.php' for
+     * web calls, or '.../bin/typo3' or similar for cli calls.
      *
      * @param int $entryPointLevel Number of subdirectories where the entry script is located under the document root
+     * @param int $requestType
+     * @return string Absolute path to entry script
      */
-    protected static function definePaths($entryPointLevel = 0)
+    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());
+        $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 ((TYPO3_REQUESTTYPE & TYPO3_REQUESTTYPE_CLI)
-                && Bootstrap::usesComposerClassLoading()
-                && StringUtility::endsWith($scriptPath, 'typo3')
-            ) {
-                // PATH_thisScript is used for various path calculations based on the document 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';
+                $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 =  substr($scriptPath, strlen($rootPath));
+                $scriptName = ltrim(substr($scriptPath, strlen($rootPath)), '/');
             }
-            $rootPath = GeneralUtility::fixWindowsFilePath(getenv('TYPO3_PATH_ROOT'));
-            $scriptPath = $rootPath . $scriptName;
-        }
-
-        if (!defined('PATH_thisScript')) {
-            define('PATH_thisScript', $scriptPath);
-        }
-        // Absolute path of the document root of the instance with trailing slash
-        if (!defined('PATH_site')) {
-            define('PATH_site', $rootPath . '/');
+            $rootPath = rtrim(GeneralUtility::fixWindowsFilePath(getenv('TYPO3_PATH_ROOT')), '/');
+            $scriptPath = $rootPath . '/' . $scriptName;
         }
-        // Relative path from document root to typo3/ directory
-        // Hardcoded to "typo3/"
-        define('TYPO3_mainDir', 'typo3/');
-        // Absolute path of the typo3 directory of the instance with trailing slash
-        // Example "/var/www/instance-name/htdocs/typo3/"
-        define('PATH_typo3', PATH_site . TYPO3_mainDir);
-        // Absolute path to the typo3conf directory with trailing slash
-        // Example "/var/www/instance-name/htdocs/typo3conf/"
-        define('PATH_typo3conf', PATH_site . 'typo3conf/');
+        return $scriptPath;
     }
 
     /**
-     * Check if path and script file name calculation was successful, exit if not.
+     * Absolute path to the root of the typo3 instance. This is often identical to the web document root path (eg. .../public),
+     * but may be different. For instance helhum/typo3-secure-web uses this: Then, rootPath TYPO3_PATH_ROOT is the absolute path to
+     * the private directory where code and runtime files are located (currently typo3/ext, typo3/sysext, fileadmin, typo3temp),
+     * while TYPO3_PATH_WEB is the public/ web document folder that gets assets like filedamin and Resources/Public folders
+     * from extensions linked in.
+     *
+     * @param int $entryPointLevel Number of subdirectories where the entry script is located under the document root
+     * @param int $requestType
+     * @return string Absolute path without trailing slash
      */
-    protected static function checkMainPathsExist()
+    protected static function calculateRootPath(int $entryPointLevel, int $requestType): string
     {
-        if (!is_file(PATH_thisScript)) {
-            static::exitWithMessage('Unable to determine path to entry script.');
+        // 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(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);
     }
 
     /**
@@ -206,8 +207,6 @@ class SystemEnvironmentBuilder
     protected static function initializeGlobalVariables()
     {
         // Unset variable(s) in global scope (security issue #13959)
-        $GLOBALS['TYPO3_MISC'] = [];
-        $GLOBALS['T3_VAR'] = [];
         $GLOBALS['T3_SERVICES'] = [];
     }
 
@@ -217,8 +216,6 @@ class SystemEnvironmentBuilder
      */
     protected static function initializeGlobalTimeTrackingVariables()
     {
-        // Microtime of (nearly) script start
-        $GLOBALS['TYPO3_MISC']['microtime_start'] = microtime(true);
         // 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
@@ -231,6 +228,42 @@ class SystemEnvironmentBuilder
     }
 
     /**
+     * Initialize the Environment class
+     *
+     * @param ApplicationContext $context
+     * @param int $requestType
+     * @param string $scriptPath
+     * @param string $sitePath
+     */
+    protected static function initializeEnvironment(ApplicationContext $context, int $requestType, string $scriptPath, string $sitePath)
+    {
+        if (getenv('TYPO3_PATH_ROOT')) {
+            $rootPathFromEnvironment = rtrim(GeneralUtility::fixWindowsFilePath(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(getenv('TYPO3_PATH_APP'));
+        $isDifferentRootPath = ($projectRootPath && $projectRootPath !== $sitePath);
+        Environment::initialize(
+            $context,
+            self::isCliRequestType($requestType),
+            self::usesComposerClassLoading(),
+            $isDifferentRootPath ? $projectRootPath : $sitePath,
+            $sitePath,
+            $isDifferentRootPath ? $projectRootPath . '/var'    : $sitePath . '/typo3temp/var',
+            $isDifferentRootPath ? $projectRootPath . '/config' : $sitePath . '/typo3conf',
+            $scriptPath,
+            self::getTypo3Os() === 'WIN' ? 'WINDOWS' : 'UNIX'
+        );
+    }
+
+    /**
      * Initialize basic error reporting.
      *
      * There are a lot of extensions that have no strict / notice / deprecated free
@@ -259,22 +292,23 @@ class SystemEnvironmentBuilder
     }
 
     /**
-     * Calculate PATH_thisScript
+     * Calculate script path.
      *
      * First step in path calculation: Goal is to find the absolute path of the entry script
      * that was called without resolving any links. This is important since the TYPO3 entry
      * points are often linked to a central core location, so we can not use the php magic
      * __FILE__ here, but resolve the called script path from given server environments.
      *
-     * This path is important to calculate the document root (PATH_site). The strategy is to
+     * This path is important to calculate the document root. The strategy is to
      * find out the script name that was called in the first place and to subtract the local
      * part from it to find the document root.
      *
+     * @param bool $isCli
      * @return string Absolute path to entry script
      */
-    protected static function getPathThisScript()
+    protected static function getPathThisScript(bool $isCli)
     {
-        if (TYPO3_REQUESTTYPE & TYPO3_REQUESTTYPE_CLI) {
+        if ($isCli) {
             return self::getPathThisScriptCli();
         }
         return self::getPathThisScriptNonCli();
@@ -327,7 +361,7 @@ class SystemEnvironmentBuilder
         }
         // Find out if path is relative or not
         $isRelativePath = false;
-        if (TYPO3_OS === 'WIN') {
+        if (self::getTypo3Os() === 'WIN') {
             if (!preg_match('/^([a-zA-Z]:)?\\\\/', $scriptPath)) {
                 $isRelativePath = true;
             }
@@ -349,8 +383,8 @@ class SystemEnvironmentBuilder
     }
 
     /**
-     * Calculate the document root part to the instance from PATH_thisScript.
-     * This is based on the amount of subdirectories "under" PATH_site where PATH_thisScript is located.
+     * Calculate the document root part to the instance from $scriptPath.
+     * This is based on the amount of subdirectories "under" root path where $scriptPath is located.
      *
      * The following main scenarios for entry points exist by default in the TYPO3 core:
      * - Directly called documentRoot/index.php (-> FE call or eiD include): index.php is located in the same directory
@@ -361,11 +395,11 @@ class SystemEnvironmentBuilder
      *
      * @param string $scriptPath Calculated path to the entry script
      * @param int $entryPointLevel Number of subdirectories where the entry script is located under the document root
-     * @return string Absolute path to document root of installation
+     * @return string Absolute path to document root of installation without trailing slash
      */
     protected static function getRootPathFromScriptPath($scriptPath, $entryPointLevel)
     {
-        $entryScriptDirectory = dirname($scriptPath);
+        $entryScriptDirectory = PathUtility::dirnameDuringBootstrap($scriptPath);
         if ($entryPointLevel > 0) {
             list($rootPath) = GeneralUtility::revExplode('/', $entryScriptDirectory, $entryPointLevel + 1);
         } else {
@@ -411,4 +445,76 @@ class SystemEnvironmentBuilder
 
         return false;
     }
+
+    /**
+     * @return bool
+     */
+    protected static function usesComposerClassLoading(): bool
+    {
+        return defined('TYPO3_COMPOSER_MODE') && TYPO3_COMPOSER_MODE;
+    }
+
+    /**
+     * Define TYPO3_REQUESTTYPE* constants that can be used for developers to see if any context has been hit
+     * also see setRequestType(). Is done at the very beginning so these parameters are always available.
+     */
+    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);
+    }
+
+    /**
+     * Defines the TYPO3_REQUESTTYPE constant so the environment knows which context the request is running.
+     *
+     * @param int $requestType
+     */
+    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);
+    }
+
+    /**
+     * Define constants and variables
+     *
+     * @param string
+     */
+    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);
+    }
+
+    /**
+     * Checks if request type is cli.
+     * Falls back to check PHP_SAPI in case request type is not provided
+     *
+     * @param int|null $requestType
+     * @return bool
+     */
+    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;
+    }
 }