SystemEnvironmentBuilder.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Core\Core;

class SystemEnvironmentBuilder {

    static protected $supportedCgiServerApis = array(
        'fpm-fcgi',
        'cgi',
        'isapi',
        'cgi-fcgi',
        'srv', // HHVM with fastcgi
    );

    static public function run($relativePathPart = '') {
        self::defineBaseConstants();
        self::definePaths($relativePathPart);
        self::checkMainPathsExist();
        self::handleMagicQuotesGpc();
        self::addCorePearPathToIncludePath();
        self::initializeGlobalVariables();
        self::initializeGlobalTimeTrackingVariables();
        self::initializeBasicErrorReporting();
    }

    static protected function defineBaseConstants() {
        // This version, branch and copyright
        define('TYPO3_version', '6.2.32-dev');
        define('TYPO3_branch', '6.2');
        define('TYPO3_copyright_year', '1998-2017');

        // TYPO3 external links
        define('TYPO3_URL_GENERAL', 'http://typo3.org/');
        define('TYPO3_URL_ORG', 'http://typo3.org/');
        define('TYPO3_URL_LICENSE', 'http://typo3.org/licenses');
        define('TYPO3_URL_EXCEPTION', 'http://typo3.org/go/exception/CMS/');
        define('TYPO3_URL_MAILINGLISTS', 'http://lists.typo3.org/cgi-bin/mailman/listinfo');
        define('TYPO3_URL_DOCUMENTATION', 'http://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', 'http://typo3.org/support/professional-services/');
        define('TYPO3_URL_CONTRIBUTE', 'http://typo3.org/contribute/');
        define('TYPO3_URL_SECURITY', 'http://typo3.org/teams/security/');
        define('TYPO3_URL_DOWNLOAD', 'http://typo3.org/download/');
        define('TYPO3_URL_SYSTEMREQUIREMENTS', 'http://typo3.org/typo3-cms/overview/requirements/');
        define('TYPO3_URL_DONATE', 'http://typo3.org/donate/online-donation/');
        define('TYPO3_URL_WIKI_OPCODECACHE', 'http://wiki.typo3.org/Opcode_Cache');

        // A tabulator, a linefeed, a carriage return, a CR-LF combination
        define('TAB', chr(9));
        define('LF', chr(10));
        define('CR', chr(13));
        define('CRLF', CR . LF);

        // Security related constant: Default value of fileDenyPattern
        define('FILE_DENY_PATTERN_DEFAULT', '\\.(php[3-6]?|phpsh|phtml)(\\..*)?$|^\\.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,phpsh,inc,phtml');

        // Operating system identifier
        // Either "WIN" or empty string
        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);
    }

    static protected function definePaths($relativePathPart = '') {
        // Relative path from document root to typo3/ directory
        // Hardcoded to "typo3/"
        define('TYPO3_mainDir', 'typo3/');
        // Absolute path of the entry script that was called
        // All paths are unified between Windows and Unix, so the \ of Windows is substituted to a /
        // Example "/var/www/instance-name/htdocs/typo3conf/ext/wec_map/mod1/index.php"
        // Example "c:/var/www/instance-name/htdocs/typo3/backend.php" for a path in Windows
        if (!defined('PATH_thisScript')) {
            define('PATH_thisScript', self::getPathThisScript());
        }
        // Absolute path of the document root of the instance with trailing slash
        // Example "/var/www/instance-name/htdocs/"
        if (!defined('PATH_site')) {
            define('PATH_site', self::getPathSite($relativePathPart));
        }
        // 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);
        // Relative path (from the PATH_typo3) to a BE module NOT using mod.php dispatcher with trailing slash
        // Example "sysext/perms/mod/" for an extension installed in typo3/sysext/
        // Example "install/" for the install tool entry script
        // Example "../typo3conf/ext/templavoila/mod2/ for an extension installed in typo3conf/ext/
        define('PATH_typo3_mod', defined('TYPO3_MOD_PATH') ? TYPO3_MOD_PATH : '');
        // Absolute path to the typo3conf directory with trailing slash
        // Example "/var/www/instance-name/htdocs/typo3conf/"
        define('PATH_typo3conf', PATH_site . 'typo3conf/');
        // Absolute path to the tslib directory with trailing slash
        // Example "/var/www/instance-name/htdocs/typo3/sysext/cms/tslib/"
        define('PATH_tslib', PATH_typo3 . 'sysext/cms/tslib/');
    }

    static protected function checkMainPathsExist() {
        if (!is_file(PATH_thisScript)) {
            static::dieWithMessage('Unable to determine path to entry script.');
        }
        if (!is_dir(PATH_tslib)) {
            static::dieWithMessage('Calculated absolute path to tslib directory does not exist.' . LF . LF
                . 'Something in the main file, folder and link structure is wrong and must be fixed! A typical document root contains a couple of symbolic links:' . LF
                . '* A symlink "typo3_src" pointing to the TYPO3 CMS core.' . LF
                . '* A symlink "typo3" - the backend entry point - pointing to "typo3_src/typo3"' . LF
                . '* A symlink "index.php" - the frontend entry point - points to "typo3_src/index.php"');
        }
    }

    static protected function handleMagicQuotesGpc() {
        if (!get_magic_quotes_gpc()) {
            \TYPO3\CMS\Core\Utility\GeneralUtility::addSlashesOnArray($_GET);
            \TYPO3\CMS\Core\Utility\GeneralUtility::addSlashesOnArray($_POST);
            $GLOBALS['HTTP_GET_VARS'] = $_GET;
            $GLOBALS['HTTP_POST_VARS'] = $_POST;
        }
    }

    static protected function addCorePearPathToIncludePath() {
        set_include_path(PATH_typo3 . 'contrib/pear/' . PATH_SEPARATOR . get_include_path());
    }

    static protected function initializeGlobalVariables() {
        // Unset variable(s) in global scope (security issue #13959)
        unset($GLOBALS['error']);
        // Set up base information about browser/user-agent
        $GLOBALS['CLIENT'] = \TYPO3\CMS\Core\Utility\GeneralUtility::clientInfo();
        $GLOBALS['TYPO3_MISC'] = array();
        $GLOBALS['T3_VAR'] = array();
        $GLOBALS['T3_SERVICES'] = array();
    }

    static protected function initializeGlobalTimeTrackingVariables() {
        // Set PARSETIME_START to the system time in milliseconds.
        $GLOBALS['PARSETIME_START'] = \TYPO3\CMS\Core\Utility\GeneralUtility::milliseconds();
        // 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
        $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'];
    }

    static protected function initializeBasicErrorReporting() {
        // Core should be notice free at least until this point ...
        error_reporting(E_ALL & ~(E_STRICT | E_NOTICE | E_DEPRECATED));
    }

    static protected function getTypo3Os() {
        $typoOs = '';
        if (!stristr(PHP_OS, 'darwin') && stristr(PHP_OS, 'win')) {
            $typoOs = 'WIN';
        }
        return $typoOs;
    }

    static protected function getPathThisScript() {
        if (defined('TYPO3_cliMode') && TYPO3_cliMode === TRUE) {
            return self::getPathThisScriptCli();
        } else {
            return self::getPathThisScriptNonCli();
        }
    }

    static protected function getPathThisScriptNonCli() {
        $cgiPath = '';
        if (isset($_SERVER['ORIG_PATH_TRANSLATED'])) {
            $cgiPath = $_SERVER['ORIG_PATH_TRANSLATED'];
        } elseif (isset($_SERVER['PATH_TRANSLATED'])) {
            $cgiPath = $_SERVER['PATH_TRANSLATED'];
        }
        if ($cgiPath && in_array(PHP_SAPI, self::$supportedCgiServerApis, TRUE)) {
            $scriptPath = $cgiPath;
        } else {
            if (isset($_SERVER['ORIG_SCRIPT_FILENAME'])) {
                $scriptPath = $_SERVER['ORIG_SCRIPT_FILENAME'];
            } else {
                $scriptPath = $_SERVER['SCRIPT_FILENAME'];
            }
        }
        // Replace \ to / for Windows
        $scriptPath = str_replace('\\', '/', $scriptPath);
        // Replace double // to /
        $scriptPath = str_replace('//', '/', $scriptPath);
        return $scriptPath;
    }

    static protected function getPathThisScriptCli() {
        // Possible relative path of the called script
        if (isset($_SERVER['argv'][0])) {
            $scriptPath = $_SERVER['argv'][0];
        } elseif (isset($_ENV['_'])) {
            $scriptPath = $_ENV['_'];
        } else {
            $scriptPath = $_SERVER['_'];
        }
        // Find out if path is relative or not
        $isRelativePath = FALSE;
        if (TYPO3_OS === 'WIN') {
            if (!preg_match('/^([a-zA-Z]:)?\\\\/', $scriptPath)) {
                $isRelativePath = TRUE;
            }
        } else {
            if ($scriptPath[0] !== '/') {
                $isRelativePath = TRUE;
            }
        }
        // Concatenate path to current working directory with relative path and remove "/./" constructs
        if ($isRelativePath) {
            if (isset($_SERVER['PWD'])) {
                $workingDirectory = $_SERVER['PWD'];
            } else {
                $workingDirectory = getcwd();
            }
            $scriptPath = $workingDirectory . '/' . preg_replace('/\\.\\//', '', $scriptPath);
        }
        return $scriptPath;
    }

    static protected function getPathSite($relativePathPart) {
        // If end of path is not "typo3/" and TYPO3_MOD_PATH is given
        if (defined('TYPO3_MOD_PATH')) {
            return self::getPathSiteByTypo3ModulePath();
        } else {
            return self::getPathSiteByRelativePathPart($relativePathPart);
        }
    }

    static protected function getPathSiteByTypo3ModulePath() {
        if (substr(TYPO3_MOD_PATH, 0, 7) === 'sysext/' || substr(TYPO3_MOD_PATH, 0, 4) === 'ext/' || substr(TYPO3_MOD_PATH, 0, 8) === 'install/') {
            $pathPartRelativeToDocumentRoot = TYPO3_mainDir . TYPO3_MOD_PATH;
        } elseif (substr(TYPO3_MOD_PATH, 0, strlen('../typo3conf/')) === '../typo3conf/') {
            $pathPartRelativeToDocumentRoot = substr(TYPO3_MOD_PATH, 3);
        } else {
            static::dieWithMessage('Unable to determine TYPO3 document root.');
        }
        $entryScriptDirectory = self::getUnifiedDirectoryNameWithTrailingSlash(PATH_thisScript);
        return substr($entryScriptDirectory, 0, -strlen($pathPartRelativeToDocumentRoot));
    }

    static protected function getPathSiteByRelativePathPart($relativePathPart) {
        $entryScriptDirectory = self::getUnifiedDirectoryNameWithTrailingSlash(PATH_thisScript);
        if (strlen($relativePathPart) > 0) {
            $pathSite = substr($entryScriptDirectory, 0, -strlen($relativePathPart));
        } else {
            $pathSite = $entryScriptDirectory;
        }
        return $pathSite;
    }

    static protected function getUnifiedDirectoryNameWithTrailingSlash($absolutePath) {
        $directory = dirname($absolutePath);
        if (TYPO3_OS === 'WIN') {
            $directory = str_replace('\\', '/', $directory);
        }
        return $directory . '/';
    }

    static protected function dieWithMessage($message) {
        header('Content-type: text/plain');
        die($message);
    }

}