[TASK] Set TYPO3 version to 7.6.8-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 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 protected static $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 protected static $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 public static function run($relativePathPart = '')
71 {
72 self::defineBaseConstants();
73 self::definePaths($relativePathPart);
74 self::checkMainPathsExist();
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 protected static function defineBaseConstants()
86 {
87 // This version, branch and copyright
88 define('TYPO3_version', '7.6.8-dev');
89 define('TYPO3_branch', '7.6');
90 define('TYPO3_copyright_year', '1998-2016');
91
92 // TYPO3 external links
93 define('TYPO3_URL_GENERAL', 'https://typo3.org/');
94 define('TYPO3_URL_LICENSE', 'https://typo3.org/typo3-cms/overview/licenses/');
95 define('TYPO3_URL_EXCEPTION', 'https://typo3.org/go/exception/CMS/');
96 define('TYPO3_URL_MAILINGLISTS', 'http://lists.typo3.org/cgi-bin/mailman/listinfo');
97 define('TYPO3_URL_DOCUMENTATION', 'https://typo3.org/documentation/');
98 define('TYPO3_URL_DOCUMENTATION_TSREF', 'https://docs.typo3.org/typo3cms/TyposcriptReference/');
99 define('TYPO3_URL_DOCUMENTATION_TSCONFIG', 'https://docs.typo3.org/typo3cms/TSconfigReference/');
100 define('TYPO3_URL_CONSULTANCY', 'https://typo3.org/support/professional-services/');
101 define('TYPO3_URL_CONTRIBUTE', 'https://typo3.org/contribute/');
102 define('TYPO3_URL_SECURITY', 'https://typo3.org/teams/security/');
103 define('TYPO3_URL_DOWNLOAD', 'https://typo3.org/download/');
104 define('TYPO3_URL_SYSTEMREQUIREMENTS', 'https://typo3.org/typo3-cms/overview/requirements/');
105 define('TYPO3_URL_DONATE', 'https://typo3.org/donate/online-donation/');
106 define('TYPO3_URL_WIKI_OPCODECACHE', 'https://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-7]?|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,php7,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 protected static function definePaths($relativePathPart = '')
153 {
154 // Relative path from document root to typo3/ directory
155 // Hardcoded to "typo3/"
156 define('TYPO3_mainDir', 'typo3/');
157 // Absolute path of the entry script that was called
158 // All paths are unified between Windows and Unix, so the \ of Windows is substituted to a /
159 // Example "/var/www/instance-name/htdocs/typo3conf/ext/wec_map/mod1/index.php"
160 // Example "c:/var/www/instance-name/htdocs/typo3/index.php?M=main" for a path in Windows
161 if (!defined('PATH_thisScript')) {
162 define('PATH_thisScript', self::getPathThisScript());
163 }
164 // Absolute path of the document root of the instance with trailing slash
165 // Example "/var/www/instance-name/htdocs/"
166 if (!defined('PATH_site')) {
167 define('PATH_site', self::getPathSite($relativePathPart));
168 }
169 // Absolute path of the typo3 directory of the instance with trailing slash
170 // Example "/var/www/instance-name/htdocs/typo3/"
171 define('PATH_typo3', PATH_site . TYPO3_mainDir);
172 // Absolute path to the typo3conf directory with trailing slash
173 // Example "/var/www/instance-name/htdocs/typo3conf/"
174 define('PATH_typo3conf', PATH_site . 'typo3conf/');
175 }
176
177 /**
178 * Check if path and script file name calculation was successful, exit if not.
179 *
180 * @return void
181 */
182 protected static function checkMainPathsExist()
183 {
184 if (!is_file(PATH_thisScript)) {
185 static::exitWithMessage('Unable to determine path to entry script.');
186 }
187 if (!is_dir(PATH_typo3 . 'sysext')) {
188 static::exitWithMessage('Calculated absolute path to typo3/sysext directory does not exist.' . LF . LF
189 . '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
190 . '* A symlink "typo3_src" pointing to the TYPO3 CMS core.' . LF
191 . '* A symlink "typo3" - the backend entry point - pointing to "typo3_src/typo3"' . LF
192 . '* A symlink "index.php" - the frontend entry point - points to "typo3_src/index.php"');
193 }
194 }
195
196 /**
197 * Set up / initialize several globals variables
198 *
199 * @return void
200 */
201 protected static function initializeGlobalVariables()
202 {
203 // Unset variable(s) in global scope (security issue #13959)
204 unset($GLOBALS['error']);
205 $GLOBALS['TYPO3_MISC'] = array();
206 $GLOBALS['T3_VAR'] = array();
207 $GLOBALS['T3_SERVICES'] = array();
208 }
209
210 /**
211 * Initialize global time tracking variables.
212 * These are helpers to for example output script parsetime at the end of a script.
213 *
214 * @return void
215 */
216 protected static function initializeGlobalTimeTrackingVariables()
217 {
218 // Set PARSETIME_START to the system time in milliseconds.
219 $GLOBALS['PARSETIME_START'] = GeneralUtility::milliseconds();
220 // Microtime of (nearly) script start
221 $GLOBALS['TYPO3_MISC']['microtime_start'] = microtime(true);
222 // EXEC_TIME is set so that the rest of the script has a common value for the script execution time
223 $GLOBALS['EXEC_TIME'] = time();
224 // $ACCESS_TIME is a common time in minutes for access control
225 $GLOBALS['ACCESS_TIME'] = $GLOBALS['EXEC_TIME'] - $GLOBALS['EXEC_TIME'] % 60;
226 // $SIM_EXEC_TIME is set to $EXEC_TIME but can be altered later in the script if we want to
227 // simulate another execution-time when selecting from eg. a database
228 $GLOBALS['SIM_EXEC_TIME'] = $GLOBALS['EXEC_TIME'];
229 // If $SIM_EXEC_TIME is changed this value must be set accordingly
230 $GLOBALS['SIM_ACCESS_TIME'] = $GLOBALS['ACCESS_TIME'];
231 }
232
233 /**
234 * Initialize basic error reporting.
235 *
236 * There are a lot of extensions that have no strict / notice / deprecated free
237 * ext_localconf or ext_tables. Since the final error reporting must be set up
238 * after those extension files are read, a default configuration is needed to
239 * suppress error reporting meanwhile during further bootstrap.
240 *
241 * @return void
242 */
243 protected static function initializeBasicErrorReporting()
244 {
245 // Core should be notice free at least until this point ...
246 error_reporting(E_ALL & ~(E_STRICT | E_NOTICE | E_DEPRECATED));
247 }
248
249 /**
250 * Determine the operating system TYPO3 is running on.
251 *
252 * @return string Either 'WIN' if running on Windows, else empty string
253 */
254 protected static function getTypo3Os()
255 {
256 $typoOs = '';
257 if (!stristr(PHP_OS, 'darwin') && !stristr(PHP_OS, 'cygwin') && stristr(PHP_OS, 'win')) {
258 $typoOs = 'WIN';
259 }
260 return $typoOs;
261 }
262
263 /**
264 * Calculate PATH_thisScript
265 *
266 * First step in path calculation: Goal is to find the absolute path of the entry script
267 * that was called without resolving any links. This is important since the TYPO3 entry
268 * points are often linked to a central core location, so we can not use the php magic
269 * __FILE__ here, but resolve the called script path from given server environments.
270 *
271 * This path is important to calculate the document root (PATH_site). The strategy is to
272 * find out the script name that was called in the first place and to subtract the local
273 * part from it to find the document root.
274 *
275 * @return string Absolute path to entry script
276 */
277 protected static function getPathThisScript()
278 {
279 if (defined('TYPO3_cliMode') && TYPO3_cliMode === true) {
280 return self::getPathThisScriptCli();
281 } else {
282 return self::getPathThisScriptNonCli();
283 }
284 }
285
286 /**
287 * Calculate path to entry script if not in cli mode.
288 *
289 * Depending on the environment, the script path is found in different $_SERVER variables.
290 *
291 * @return string Absolute path to entry script
292 */
293 protected static function getPathThisScriptNonCli()
294 {
295 $cgiPath = '';
296 if (isset($_SERVER['ORIG_PATH_TRANSLATED'])) {
297 $cgiPath = $_SERVER['ORIG_PATH_TRANSLATED'];
298 } elseif (isset($_SERVER['PATH_TRANSLATED'])) {
299 $cgiPath = $_SERVER['PATH_TRANSLATED'];
300 }
301 if ($cgiPath && in_array(PHP_SAPI, self::$supportedCgiServerApis, true)) {
302 $scriptPath = $cgiPath;
303 } else {
304 if (isset($_SERVER['ORIG_SCRIPT_FILENAME'])) {
305 $scriptPath = $_SERVER['ORIG_SCRIPT_FILENAME'];
306 } else {
307 $scriptPath = $_SERVER['SCRIPT_FILENAME'];
308 }
309 }
310 // Replace \ to / for Windows
311 $scriptPath = str_replace('\\', '/', $scriptPath);
312 // Replace double // to /
313 $scriptPath = str_replace('//', '/', $scriptPath);
314 return $scriptPath;
315 }
316
317 /**
318 * Calculate path to entry script if in cli mode.
319 *
320 * First argument of a cli script is the path to the script that was called. If the script does not start
321 * with / (or A:\ for Windows), the path is not absolute yet, and the current working directory is added.
322 *
323 * @return string Absolute path to entry script
324 */
325 protected static function getPathThisScriptCli()
326 {
327 // Possible relative path of the called script
328 if (isset($_SERVER['argv'][0])) {
329 $scriptPath = $_SERVER['argv'][0];
330 } elseif (isset($_ENV['_'])) {
331 $scriptPath = $_ENV['_'];
332 } else {
333 $scriptPath = $_SERVER['_'];
334 }
335 // Find out if path is relative or not
336 $isRelativePath = false;
337 if (TYPO3_OS === 'WIN') {
338 if (!preg_match('/^([a-zA-Z]:)?\\\\/', $scriptPath)) {
339 $isRelativePath = true;
340 }
341 } else {
342 if ($scriptPath[0] !== '/') {
343 $isRelativePath = true;
344 }
345 }
346 // Concatenate path to current working directory with relative path and remove "/./" constructs
347 if ($isRelativePath) {
348 if (isset($_SERVER['PWD'])) {
349 $workingDirectory = $_SERVER['PWD'];
350 } else {
351 $workingDirectory = getcwd();
352 }
353 $scriptPath = $workingDirectory . '/' . preg_replace('/\\.\\//', '', $scriptPath);
354 }
355 return $scriptPath;
356 }
357
358 /**
359 * Calculate the document root part to the instance from PATH_thisScript
360 *
361 * We have two main scenarios for entry points:
362 * - Directly called documentRoot/index.php (-> FE call or eiD include): index.php sets $relativePathPart to
363 * empty string to hint this code that the document root is identical to the directory the script is located at.
364 * - An indirect include of any Backend related script (-> typo3/index.php or the install tool).
365 * - A Backend script: This is the case for the index.php dispatcher and other entry scripts like 'cli_dispatch.phpsh'
366 * or 'typo3/index.php' that are located inside typo3/ directly. In this case the Bootstrap->run() command sets
367 * 'typo3/' as $relativePathPart as base to calculate the document root.
368 *
369 * @param string $relativePathPart Relative directory part from document root to script path
370 * @return string Absolute path to document root of installation
371 */
372 protected static function getPathSite($relativePathPart)
373 {
374 $entryScriptDirectory = self::getUnifiedDirectoryNameWithTrailingSlash(PATH_thisScript);
375 if ($relativePathPart !== '') {
376 $pathSite = substr($entryScriptDirectory, 0, -strlen($relativePathPart));
377 } else {
378 $pathSite = $entryScriptDirectory;
379 }
380 return $pathSite;
381 }
382
383 /**
384 * Remove file name from script path and unify for Windows and Unix
385 *
386 * @param string $absolutePath Absolute path to script
387 * @return string Directory name of script file location, unified for Windows and Unix
388 */
389 protected static function getUnifiedDirectoryNameWithTrailingSlash($absolutePath)
390 {
391 $directory = dirname($absolutePath);
392 if (TYPO3_OS === 'WIN') {
393 $directory = str_replace('\\', '/', $directory);
394 }
395 return $directory . '/';
396 }
397
398 /**
399 * Send http headers, echo out a text message and exit with error code
400 *
401 * @param string $message
402 */
403 protected static function exitWithMessage($message)
404 {
405 $headers = [
406 \TYPO3\CMS\Core\Utility\HttpUtility::HTTP_STATUS_500,
407 'Content-type: text/plain'
408 ];
409 if (!headers_sent()) {
410 foreach ($headers as $header) {
411 header($header);
412 }
413 }
414 echo $message . LF;
415 exit(1);
416 }
417
418 /**
419 * Check if the given function is disabled in the system
420 *
421 * @param string $function
422 * @return bool
423 */
424 public static function isFunctionDisabled($function)
425 {
426 if (static::$disabledFunctions === null) {
427 static::$disabledFunctions = GeneralUtility::trimExplode(',', ini_get('disable_functions'));
428 }
429 if (!empty(static::$disabledFunctions)) {
430 return in_array($function, static::$disabledFunctions, true);
431 }
432
433 return false;
434 }
435 }