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