[TASK] Set TYPO3 version to 7.2.0-dev
[Packages/TYPO3.CMS.git] / typo3 / sysext / core / Classes / Core / SystemEnvironmentBuilder.php
1 <?php
2 namespace TYPO3\CMS\Core\Core;
3
4 /*
5 * This file is part of the TYPO3 CMS project.
6 *
7 * It is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU General Public License, either version 2
9 * of the License, or any later version.
10 *
11 * For the full copyright and license information, please read the
12 * LICENSE.txt file that was distributed with this source code.
13 *
14 * The TYPO3 project - inspiring people to share!
15 */
16
17 /**
18 * Class to encapsulate base setup of bootstrap.
19 *
20 * This class contains all code that must be executed by every entry script.
21 *
22 * It sets up all basic paths, constants, global variables and checks
23 * the basic environment TYPO3 runs in.
24 *
25 * This class does not use any TYPO3 instance specific configuration, it only
26 * sets up things based on the server environment and core code. Even with a
27 * missing typo3conf/localconf.php this script will be successful.
28 *
29 * The script aborts execution with an error message if
30 * some part fails or conditions are not met.
31 *
32 * This script is internal code and subject to change.
33 * DO NOT use it in own code, or be prepared your code might
34 * break in future versions of the core.
35 */
36 class SystemEnvironmentBuilder {
37
38 /**
39 * A list of supported CGI server APIs
40 * NOTICE: This is a duplicate of the SAME array in GeneralUtility!
41 * It is duplicated here as this information is needed early in bootstrap
42 * and GeneralUtility is not available yet.
43 * @var array
44 */
45 static protected $supportedCgiServerApis = array(
46 'fpm-fcgi',
47 'cgi',
48 'isapi',
49 'cgi-fcgi',
50 'srv', // HHVM with fastcgi
51 );
52
53 /**
54 * Run base setup.
55 * This entry method is used in all scopes (FE, BE, eid, ajax, ...)
56 *
57 * @internal This method should not be used by 3rd party code. It will change without further notice.
58 * @param string $relativePathPart Relative path of the entry script back to document root
59 * @return void
60 */
61 static public function run($relativePathPart = '') {
62 self::defineBaseConstants();
63 self::definePaths($relativePathPart);
64 self::checkMainPathsExist();
65 self::handleMagicQuotesGpc();
66 self::addCorePearPathToIncludePath();
67 self::initializeGlobalVariables();
68 self::initializeGlobalTimeTrackingVariables();
69 self::initializeBasicErrorReporting();
70 }
71
72 /**
73 * Define all simple constants that have no dependency to local configuration
74 *
75 * @return void
76 */
77 static protected function defineBaseConstants() {
78 // This version, branch and copyright
79 define('TYPO3_version', '7.2.0-dev');
80 define('TYPO3_branch', '7.2');
81 define('TYPO3_copyright_year', '1998-2015');
82
83 // TYPO3 external links
84 define('TYPO3_URL_GENERAL', 'http://typo3.org/');
85 define('TYPO3_URL_ORG', 'http://typo3.org/');
86 define('TYPO3_URL_LICENSE', 'http://typo3.org/licenses');
87 define('TYPO3_URL_EXCEPTION', 'http://typo3.org/go/exception/CMS/');
88 define('TYPO3_URL_MAILINGLISTS', 'http://lists.typo3.org/cgi-bin/mailman/listinfo');
89 define('TYPO3_URL_DOCUMENTATION', 'http://typo3.org/documentation/');
90 define('TYPO3_URL_DOCUMENTATION_TSREF', 'http://docs.typo3.org/typo3cms/TyposcriptReference/');
91 define('TYPO3_URL_DOCUMENTATION_TSCONFIG', 'http://docs.typo3.org/typo3cms/TSconfigReference/');
92 define('TYPO3_URL_CONSULTANCY', 'http://typo3.org/support/professional-services/');
93 define('TYPO3_URL_CONTRIBUTE', 'http://typo3.org/contribute/');
94 define('TYPO3_URL_SECURITY', 'http://typo3.org/teams/security/');
95 define('TYPO3_URL_DOWNLOAD', 'http://typo3.org/download/');
96 define('TYPO3_URL_SYSTEMREQUIREMENTS', 'http://typo3.org/typo3-cms/overview/requirements/');
97 define('TYPO3_URL_DONATE', 'http://typo3.org/donate/online-donation/');
98 define('TYPO3_URL_WIKI_OPCODECACHE', 'http://wiki.typo3.org/Opcode_Cache');
99
100 // A null, a tabulator, a linefeed, a carriage return, a substitution, a CR-LF combination
101 define('NUL', chr(0));
102 define('TAB', chr(9));
103 define('LF', chr(10));
104 define('CR', chr(13));
105 define('SUB', chr(26));
106 define('CRLF', CR . LF);
107
108 // Security related constant: Default value of fileDenyPattern
109 define('FILE_DENY_PATTERN_DEFAULT', '\\.(php[3-6]?|phpsh|phtml)(\\..*)?$|^\\.htaccess$');
110 // Security related constant: List of file extensions that should be registered as php script file extensions
111 define('PHP_EXTENSIONS_DEFAULT', 'php,php3,php4,php5,php6,phpsh,inc,phtml');
112
113 // Operating system identifier
114 // Either "WIN" or empty string
115 define('TYPO3_OS', self::getTypo3Os());
116
117 // Service error constants
118 // General error - something went wrong
119 define('T3_ERR_SV_GENERAL', -1);
120 // During execution it showed that the service is not available and should be ignored. The service itself should call $this->setNonAvailable()
121 define('T3_ERR_SV_NOT_AVAIL', -2);
122 // Passed subtype is not possible with this service
123 define('T3_ERR_SV_WRONG_SUBTYPE', -3);
124 // Passed subtype is not possible with this service
125 define('T3_ERR_SV_NO_INPUT', -4);
126 // File not found which the service should process
127 define('T3_ERR_SV_FILE_NOT_FOUND', -20);
128 // File not readable
129 define('T3_ERR_SV_FILE_READ', -21);
130 // File not writable
131 define('T3_ERR_SV_FILE_WRITE', -22);
132 // Passed subtype is not possible with this service
133 define('T3_ERR_SV_PROG_NOT_FOUND', -40);
134 // Passed subtype is not possible with this service
135 define('T3_ERR_SV_PROG_FAILED', -41);
136 }
137
138 /**
139 * Calculate all required base paths and set as constants.
140 *
141 * @param string $relativePathPart Relative path of the entry script back to document root
142 * @return void
143 */
144 static protected function definePaths($relativePathPart = '') {
145 // Relative path from document root to typo3/ directory
146 // Hardcoded to "typo3/"
147 define('TYPO3_mainDir', 'typo3/');
148 // Absolute path of the entry script that was called
149 // All paths are unified between Windows and Unix, so the \ of Windows is substituted to a /
150 // Example "/var/www/instance-name/htdocs/typo3conf/ext/wec_map/mod1/index.php"
151 // Example "c:/var/www/instance-name/htdocs/typo3/backend.php" for a path in Windows
152 if (!defined('PATH_thisScript')) {
153 define('PATH_thisScript', self::getPathThisScript());
154 }
155 // Absolute path of the document root of the instance with trailing slash
156 // Example "/var/www/instance-name/htdocs/"
157 if (!defined('PATH_site')) {
158 define('PATH_site', self::getPathSite($relativePathPart));
159 }
160 // Absolute path of the typo3 directory of the instance with trailing slash
161 // Example "/var/www/instance-name/htdocs/typo3/"
162 define('PATH_typo3', PATH_site . TYPO3_mainDir);
163 // Relative path (from the PATH_typo3) to a BE module NOT using mod.php dispatcher with trailing slash
164 // Example "sysext/perms/mod/" for an extension installed in typo3/sysext/
165 // Example "install/" for the install tool entry script
166 // Example "../typo3conf/ext/templavoila/mod2/ for an extension installed in typo3conf/ext/
167 define('PATH_typo3_mod', defined('TYPO3_MOD_PATH') ? TYPO3_MOD_PATH : '');
168 // Absolute path to the typo3conf directory with trailing slash
169 // Example "/var/www/instance-name/htdocs/typo3conf/"
170 define('PATH_typo3conf', PATH_site . 'typo3conf/');
171 }
172
173 /**
174 * Check if path and script file name calculation was successful, exit if not.
175 *
176 * @return void
177 */
178 static protected function checkMainPathsExist() {
179 if (!is_file(PATH_thisScript)) {
180 static::dieWithMessage('Unable to determine path to entry script.');
181 }
182 if (!is_dir(PATH_typo3 . 'sysext')) {
183 static::dieWithMessage('Calculated absolute path to typo3/sysext directory does not exist.' . LF . LF
184 . '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
185 . '* A symlink "typo3_src" pointing to the TYPO3 CMS core.' . LF
186 . '* A symlink "typo3" - the backend entry point - pointing to "typo3_src/typo3"' . LF
187 . '* A symlink "index.php" - the frontend entry point - points to "typo3_src/index.php"');
188 }
189 }
190
191 /**
192 * Compatibility layer for magic quotes
193 *
194 * @return void
195 */
196 static protected function handleMagicQuotesGpc() {
197 if (!get_magic_quotes_gpc()) {
198 \TYPO3\CMS\Core\Utility\GeneralUtility::addSlashesOnArray($_GET);
199 \TYPO3\CMS\Core\Utility\GeneralUtility::addSlashesOnArray($_POST);
200 $GLOBALS['HTTP_GET_VARS'] = $_GET;
201 $GLOBALS['HTTP_POST_VARS'] = $_POST;
202 }
203 }
204
205 /**
206 * Add typo3/contrib/pear/ as first include folder in
207 * include path, because the shipped PEAR packages use
208 * relative paths to include their files.
209 *
210 * This is required for \TYPO3\CMS\Core\Http\HttpRequest
211 * to work.
212 *
213 * Having the TYPO3 folder first will make sure that the
214 * shipped version is loaded before any local PEAR package,
215 * thus avoiding any incompatibilities with newer or older
216 * versions.
217 *
218 * @return void
219 */
220 static protected function addCorePearPathToIncludePath() {
221 set_include_path(PATH_typo3 . 'contrib/pear/' . PATH_SEPARATOR . get_include_path());
222 }
223
224 /**
225 * Set up / initialize several globals variables
226 *
227 * @return void
228 */
229 static protected function initializeGlobalVariables() {
230 // Unset variable(s) in global scope (security issue #13959)
231 unset($GLOBALS['error']);
232 // Set up base information about browser/user-agent
233 $GLOBALS['CLIENT'] = \TYPO3\CMS\Core\Utility\GeneralUtility::clientInfo();
234 $GLOBALS['TYPO3_MISC'] = array();
235 $GLOBALS['T3_VAR'] = array();
236 $GLOBALS['T3_SERVICES'] = array();
237 }
238
239 /**
240 * Initialize global time tracking variables.
241 * These are helpers to for example output script parsetime at the end of a script.
242 *
243 * @return void
244 */
245 static protected function initializeGlobalTimeTrackingVariables() {
246 // Set PARSETIME_START to the system time in milliseconds.
247 $GLOBALS['PARSETIME_START'] = \TYPO3\CMS\Core\Utility\GeneralUtility::milliseconds();
248 // Microtime of (nearly) script start
249 $GLOBALS['TYPO3_MISC']['microtime_start'] = microtime(TRUE);
250 // EXEC_TIME is set so that the rest of the script has a common value for the script execution time
251 $GLOBALS['EXEC_TIME'] = time();
252 // $ACCESS_TIME is a common time in minutes for access control
253 $GLOBALS['ACCESS_TIME'] = $GLOBALS['EXEC_TIME'] - $GLOBALS['EXEC_TIME'] % 60;
254 // $SIM_EXEC_TIME is set to $EXEC_TIME but can be altered later in the script if we want to
255 // simulate another execution-time when selecting from eg. a database
256 $GLOBALS['SIM_EXEC_TIME'] = $GLOBALS['EXEC_TIME'];
257 // If $SIM_EXEC_TIME is changed this value must be set accordingly
258 $GLOBALS['SIM_ACCESS_TIME'] = $GLOBALS['ACCESS_TIME'];
259 }
260
261 /**
262 * Initialize basic error reporting.
263 *
264 * There are a lot of extensions that have no strict / notice / deprecated free
265 * ext_localconf or ext_tables. Since the final error reporting must be set up
266 * after those extension files are read, a default configuration is needed to
267 * suppress error reporting meanwhile during further bootstrap.
268 *
269 * @return void
270 */
271 static protected function initializeBasicErrorReporting() {
272 // Core should be notice free at least until this point ...
273 error_reporting(E_ALL & ~(E_STRICT | E_NOTICE | E_DEPRECATED));
274 }
275
276 /**
277 * Determine the operating system TYPO3 is running on.
278 *
279 * @return string Either 'WIN' if running on Windows, else empty string
280 */
281 static protected function getTypo3Os() {
282 $typoOs = '';
283 if (!stristr(PHP_OS, 'darwin') && stristr(PHP_OS, 'win')) {
284 $typoOs = 'WIN';
285 }
286 return $typoOs;
287 }
288
289 /**
290 * Calculate PATH_thisScript
291 *
292 * First step in path calculation: Goal is to find the absolute path of the entry script
293 * that was called without resolving any links. This is important since the TYPO3 entry
294 * points are often linked to a central core location, so we can not use the php magic
295 * __FILE__ here, but resolve the called script path from given server environments.
296 *
297 * This path is important to calculate the document root (PATH_site). The strategy is to
298 * find out the script name that was called in the first place and to subtract the local
299 * part from it to find the document root.
300 *
301 * @return string Absolute path to entry script
302 */
303 static protected function getPathThisScript() {
304 if (defined('TYPO3_cliMode') && TYPO3_cliMode === TRUE) {
305 return self::getPathThisScriptCli();
306 } else {
307 return self::getPathThisScriptNonCli();
308 }
309 }
310
311 /**
312 * Calculate path to entry script if not in cli mode.
313 *
314 * Depending on the environment, the script path is found in different $_SERVER variables.
315 *
316 * @return string Absolute path to entry script
317 */
318 static protected function getPathThisScriptNonCli() {
319 $cgiPath = '';
320 if (isset($_SERVER['ORIG_PATH_TRANSLATED'])) {
321 $cgiPath = $_SERVER['ORIG_PATH_TRANSLATED'];
322 } elseif (isset($_SERVER['PATH_TRANSLATED'])) {
323 $cgiPath = $_SERVER['PATH_TRANSLATED'];
324 }
325 if ($cgiPath && in_array(PHP_SAPI, self::$supportedCgiServerApis, TRUE)) {
326 $scriptPath = $cgiPath;
327 } else {
328 if (isset($_SERVER['ORIG_SCRIPT_FILENAME'])) {
329 $scriptPath = $_SERVER['ORIG_SCRIPT_FILENAME'];
330 } else {
331 $scriptPath = $_SERVER['SCRIPT_FILENAME'];
332 }
333 }
334 // Replace \ to / for Windows
335 $scriptPath = str_replace('\\', '/', $scriptPath);
336 // Replace double // to /
337 $scriptPath = str_replace('//', '/', $scriptPath);
338 return $scriptPath;
339 }
340
341 /**
342 * Calculate path to entry script if in cli mode.
343 *
344 * First argument of a cli script is the path to the script that was called. If the script does not start
345 * with / (or A:\ for Windows), the path is not absolute yet, and the current working directory is added.
346 *
347 * @return string Absolute path to entry script
348 */
349 static protected function getPathThisScriptCli() {
350 // Possible relative path of the called script
351 if (isset($_SERVER['argv'][0])) {
352 $scriptPath = $_SERVER['argv'][0];
353 } elseif (isset($_ENV['_'])) {
354 $scriptPath = $_ENV['_'];
355 } else {
356 $scriptPath = $_SERVER['_'];
357 }
358 // Find out if path is relative or not
359 $isRelativePath = FALSE;
360 if (TYPO3_OS === 'WIN') {
361 if (!preg_match('/^([a-zA-Z]:)?\\\\/', $scriptPath)) {
362 $isRelativePath = TRUE;
363 }
364 } else {
365 if ($scriptPath[0] !== '/') {
366 $isRelativePath = TRUE;
367 }
368 }
369 // Concatenate path to current working directory with relative path and remove "/./" constructs
370 if ($isRelativePath) {
371 if (isset($_SERVER['PWD'])) {
372 $workingDirectory = $_SERVER['PWD'];
373 } else {
374 $workingDirectory = getcwd();
375 }
376 $scriptPath = $workingDirectory . '/' . preg_replace('/\\.\\//', '', $scriptPath);
377 }
378 return $scriptPath;
379 }
380
381 /**
382 * Calculate the document root part to the instance from PATH_thisScript
383 *
384 * There are two ways to hint correct calculation:
385 * Either an explicit specified sub path or the defined constant TYPO3_MOD_PATH. Which one is
386 * used depends on which entry script was called in the first place.
387 *
388 * We have two main scenarios for entry points:
389 * - Directly called documentRoot/index.php (-> FE call or eiD include): index.php sets $relativePathPart to
390 * empty string to hint this code that the document root is identical to the directory the script is located at.
391 * - An indirect include of typo3/init.php (-> a backend module, the install tool, or scripts like thumbs.php).
392 * If init.php is included we distinguish two cases:
393 * -- A backend module defines 'TYPO3_MOD_PATH': This is the case for "old" modules that are not called through
394 * "mod.php" dispatcher, and in the install tool. The TYPO3_MOD_PATH defines the relative path to the typo3/
395 * directory. This is taken as base to calculate the document root.
396 * -- A script includes init.php and does not define 'TYPO3_MOD_PATH': This is the case for the mod.php dispatcher
397 * and other entry scripts like 'cli_dispatch.phpsh' or 'thumbs.php' that are located parallel to init.php. In
398 * this case init.php sets 'typo3/' as $relativePathPart as base to calculate the document root.
399 *
400 * This basically boils down to the following code:
401 * If TYPO3_MOD_PATH is defined, subtract this 'local' part from the entry point directory, else use
402 * $relativePathPart to subtract this from the the script entry point to find out the document root.
403 *
404 * @param string $relativePathPart Relative directory part from document root to script path if TYPO3_MOD_PATH is not used
405 * @return string Absolute path to document root of installation
406 */
407 static protected function getPathSite($relativePathPart) {
408 // If end of path is not "typo3/" and TYPO3_MOD_PATH is given
409 if (defined('TYPO3_MOD_PATH')) {
410 return self::getPathSiteByTypo3ModulePath();
411 } else {
412 return self::getPathSiteByRelativePathPart($relativePathPart);
413 }
414 }
415
416 /**
417 * Calculate document root by TYPO3_MOD_PATH
418 *
419 * TYPO3_MOD_PATH can have the following values:
420 * - "sysext/extensionName/path/entryScript.php" -> extension is below 'docRoot'/typo3/sysext
421 * - "ext/extensionName/path/entryScript.php" -> extension is below 'docRoot'/typo3/ext
422 * - "../typo3conf/ext/extensionName/path/entryScript.php" -> extension is below 'docRoot'/typo3conf/ext
423 * - "install/index.php" -> install tool in 'docRoot'/typo3/install/
424 *
425 * The method unifies the above and subtracts the calculated path part from PATH_thisScript
426 *
427 * @return string Absolute path to document root of installation
428 */
429 static protected function getPathSiteByTypo3ModulePath() {
430 if (substr(TYPO3_MOD_PATH, 0, 7) === 'sysext/' || substr(TYPO3_MOD_PATH, 0, 4) === 'ext/' || substr(TYPO3_MOD_PATH, 0, 8) === 'install/') {
431 $pathPartRelativeToDocumentRoot = TYPO3_mainDir . TYPO3_MOD_PATH;
432 } elseif (substr(TYPO3_MOD_PATH, 0, strlen('../typo3conf/')) === '../typo3conf/') {
433 $pathPartRelativeToDocumentRoot = substr(TYPO3_MOD_PATH, 3);
434 } else {
435 static::dieWithMessage('Unable to determine TYPO3 document root.');
436 }
437 $entryScriptDirectory = self::getUnifiedDirectoryNameWithTrailingSlash(PATH_thisScript);
438 return substr($entryScriptDirectory, 0, -strlen($pathPartRelativeToDocumentRoot));
439 }
440
441 /**
442 * Find out document root by subtracting $relativePathPart from PATH_thisScript
443 *
444 * @param string $relativePathPart Relative part of script from document root
445 * @return string Absolute path to document root of installation
446 */
447 static protected function getPathSiteByRelativePathPart($relativePathPart) {
448 $entryScriptDirectory = self::getUnifiedDirectoryNameWithTrailingSlash(PATH_thisScript);
449 if ($relativePathPart !== '') {
450 $pathSite = substr($entryScriptDirectory, 0, -strlen($relativePathPart));
451 } else {
452 $pathSite = $entryScriptDirectory;
453 }
454 return $pathSite;
455 }
456
457 /**
458 * Remove file name from script path and unify for Windows and Unix
459 *
460 * @param string $absolutePath Absolute path to script
461 * @return string Directory name of script file location, unified for Windows and Unix
462 */
463 static protected function getUnifiedDirectoryNameWithTrailingSlash($absolutePath) {
464 $directory = dirname($absolutePath);
465 if (TYPO3_OS === 'WIN') {
466 $directory = str_replace('\\', '/', $directory);
467 }
468 return $directory . '/';
469 }
470
471 /**
472 * Echo out a text message and die
473 *
474 * @param string $message
475 */
476 static protected function dieWithMessage($message) {
477 header('Content-type: text/plain');
478 die($message);
479 }
480
481 }