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