[!!!][TASK] Always include pageId in cHash calculation
[Packages/TYPO3.CMS.git] / typo3 / sysext / core / Classes / Core / Bootstrap.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\ExtensionManagementUtility;
18 use TYPO3\CMS\Core\Utility\GeneralUtility;
19 use TYPO3\CMS\Core\Utility\MathUtility;
20
21 /**
22 * This class encapsulates bootstrap related methods.
23 * It is required directly as the very first thing in entry scripts and
24 * used to define all base things like constants and paths and so on.
25 *
26 * Most methods in this class have dependencies to each other. They can
27 * not be called in arbitrary order. The methods are ordered top down, so
28 * a method at the beginning has lower dependencies than a method further
29 * down. Do not fiddle with the load order in own scripts except you know
30 * exactly what you are doing!
31 */
32 class Bootstrap
33 {
34 /**
35 * @var \TYPO3\CMS\Core\Core\Bootstrap
36 */
37 protected static $instance = null;
38
39 /**
40 * Unique Request ID
41 *
42 * @var string
43 */
44 protected $requestId;
45
46 /**
47 * The application context
48 *
49 * @var \TYPO3\CMS\Core\Core\ApplicationContext
50 */
51 protected $applicationContext;
52
53 /**
54 * @var array List of early instances
55 */
56 protected $earlyInstances = [];
57
58 /**
59 * @var string Path to install tool
60 */
61 protected $installToolPath;
62
63 /**
64 * A list of all registered request handlers, see the Application class / entry points for the registration
65 * @var \TYPO3\CMS\Core\Http\RequestHandlerInterface[]|\TYPO3\CMS\Core\Console\RequestHandlerInterface[]
66 */
67 protected $availableRequestHandlers = [];
68
69 /**
70 * The Response object when using Request/Response logic
71 * @var \Psr\Http\Message\ResponseInterface
72 * @see shutdown()
73 */
74 protected $response;
75
76 /**
77 * @var bool
78 */
79 protected static $usesComposerClassLoading = false;
80
81 /**
82 * Disable direct creation of this object.
83 * Set unique requestId and the application context
84 *
85 * @var string Application context
86 */
87 protected function __construct($applicationContext)
88 {
89 $this->requestId = substr(md5(uniqid('', true)), 0, 13);
90 $this->applicationContext = new ApplicationContext($applicationContext);
91 }
92
93 /**
94 * @return bool
95 */
96 public static function usesComposerClassLoading()
97 {
98 return self::$usesComposerClassLoading;
99 }
100
101 /**
102 * Disable direct cloning of this object.
103 */
104 protected function __clone()
105 {
106 }
107
108 /**
109 * Return 'this' as singleton
110 *
111 * @return Bootstrap
112 * @internal This is not a public API method, do not use in own extensions
113 */
114 public static function getInstance()
115 {
116 if (is_null(static::$instance)) {
117 $applicationContext = getenv('TYPO3_CONTEXT') ?: (getenv('REDIRECT_TYPO3_CONTEXT') ?: 'Production');
118 self::$instance = new static($applicationContext);
119 self::$instance->defineTypo3RequestTypes();
120 }
121 return static::$instance;
122 }
123
124 /**
125 * Gets the request's unique ID
126 *
127 * @return string Unique request ID
128 * @internal This is not a public API method, do not use in own extensions
129 */
130 public function getRequestId()
131 {
132 return $this->requestId;
133 }
134
135 /**
136 * Returns the application context this bootstrap was started in.
137 *
138 * @return \TYPO3\CMS\Core\Core\ApplicationContext The application context encapsulated in an object
139 * @internal This is not a public API method, do not use in own extensions.
140 * Use \TYPO3\CMS\Core\Utility\GeneralUtility::getApplicationContext() instead
141 */
142 public function getApplicationContext()
143 {
144 return $this->applicationContext;
145 }
146
147 /**
148 * Prevent any unwanted output that may corrupt AJAX/compression.
149 * This does not interfere with "die()" or "echo"+"exit()" messages!
150 *
151 * @return Bootstrap
152 * @internal This is not a public API method, do not use in own extensions
153 */
154 public function startOutputBuffering()
155 {
156 ob_start();
157 return $this;
158 }
159
160 /**
161 * Main entry point called at every request usually from Global scope. Checks if everything is correct,
162 * and loads the Configuration.
163 *
164 * Make sure that the baseSetup() is called before and the class loader is present
165 *
166 * @return Bootstrap
167 */
168 public function configure()
169 {
170 $this->startOutputBuffering()
171 ->loadConfigurationAndInitialize()
172 ->loadTypo3LoadedExtAndExtLocalconf(true)
173 ->setFinalCachingFrameworkCacheConfiguration()
174 ->defineLoggingAndExceptionConstants()
175 ->unsetReservedGlobalVariables()
176 ->initializeTypo3DbGlobal();
177
178 return $this;
179 }
180
181 /**
182 * Run the base setup that checks server environment, determines paths,
183 * populates base files and sets common configuration.
184 *
185 * Script execution will be aborted if something fails here.
186 *
187 * @param int $entryPointLevel Number of subdirectories where the entry script is located under the document root
188 * @return Bootstrap
189 * @throws \RuntimeException when TYPO3_REQUESTTYPE was not set before, setRequestType() needs to be called before
190 * @internal This is not a public API method, do not use in own extensions
191 */
192 public function baseSetup($entryPointLevel = 0)
193 {
194 if (!defined('TYPO3_REQUESTTYPE')) {
195 throw new \RuntimeException('No Request Type was set, TYPO3 does not know in which context it is run.', 1450561838);
196 }
197 SystemEnvironmentBuilder::run($entryPointLevel);
198 if (!self::$usesComposerClassLoading && ClassLoadingInformation::isClassLoadingInformationAvailable()) {
199 ClassLoadingInformation::registerClassLoadingInformation();
200 }
201 GeneralUtility::presetApplicationContext($this->applicationContext);
202 return $this;
203 }
204
205 /**
206 * Sets the class loader to the bootstrap
207 *
208 * @param \Composer\Autoload\ClassLoader $classLoader an instance of the class loader
209 * @return Bootstrap
210 * @internal This is not a public API method, do not use in own extensions
211 */
212 public function initializeClassLoader($classLoader)
213 {
214 $this->setEarlyInstance(\Composer\Autoload\ClassLoader::class, $classLoader);
215 if (defined('TYPO3_COMPOSER_MODE') && TYPO3_COMPOSER_MODE) {
216 self::$usesComposerClassLoading = true;
217 }
218 return $this;
219 }
220
221 /**
222 * checks if LocalConfiguration.php or PackageStates.php is missing,
223 * used to see if a redirect to the install tool is needed
224 *
225 * @return bool TRUE when the essential configuration is available, otherwise FALSE
226 * @internal This is not a public API method, do not use in own extensions
227 */
228 public function checkIfEssentialConfigurationExists()
229 {
230 $configurationManager = new \TYPO3\CMS\Core\Configuration\ConfigurationManager;
231 $this->setEarlyInstance(\TYPO3\CMS\Core\Configuration\ConfigurationManager::class, $configurationManager);
232 return file_exists($configurationManager->getLocalConfigurationFileLocation()) && file_exists(PATH_typo3conf . 'PackageStates.php');
233 }
234
235 /**
236 * Redirect to install tool if LocalConfiguration.php is missing.
237 *
238 * @param int $entryPointLevel Number of subdirectories where the entry script is located under the document root
239 * @internal This is not a public API method, do not use in own extensions
240 */
241 public function redirectToInstallTool($entryPointLevel = 0)
242 {
243 $path = TYPO3_mainDir . 'sysext/install/Start/Install.php';
244 if ($entryPointLevel > 0) {
245 $path = str_repeat('../', $entryPointLevel) . $path;
246 }
247 header('Location: ' . $path);
248 die;
249 }
250
251 /**
252 * Adds available request handlers usually done via an application from the outside.
253 *
254 * @param string $requestHandler class which implements the request handler interface
255 * @return Bootstrap
256 * @internal This is not a public API method, do not use in own extensions
257 */
258 public function registerRequestHandlerImplementation($requestHandler)
259 {
260 $this->availableRequestHandlers[] = $requestHandler;
261 return $this;
262 }
263
264 /**
265 * Fetches the request handler that suits the best based on the priority and the interface
266 * Be sure to always have the constants that are defined in $this->defineTypo3RequestTypes() are set,
267 * so most RequestHandlers can check if they can handle the request.
268 *
269 * @param \Psr\Http\Message\ServerRequestInterface|\Symfony\Component\Console\Input\InputInterface $request
270 * @return \TYPO3\CMS\Core\Http\RequestHandlerInterface|\TYPO3\CMS\Core\Console\RequestHandlerInterface
271 * @throws \TYPO3\CMS\Core\Exception
272 * @internal This is not a public API method, do not use in own extensions
273 */
274 protected function resolveRequestHandler($request)
275 {
276 $suitableRequestHandlers = [];
277 foreach ($this->availableRequestHandlers as $requestHandlerClassName) {
278 /** @var \TYPO3\CMS\Core\Http\RequestHandlerInterface|\TYPO3\CMS\Core\Console\RequestHandlerInterface $requestHandler */
279 $requestHandler = GeneralUtility::makeInstance($requestHandlerClassName, $this);
280 if ($requestHandler->canHandleRequest($request)) {
281 $priority = $requestHandler->getPriority();
282 if (isset($suitableRequestHandlers[$priority])) {
283 throw new \TYPO3\CMS\Core\Exception('More than one request handler with the same priority can handle the request, but only one handler may be active at a time!', 1176471352);
284 }
285 $suitableRequestHandlers[$priority] = $requestHandler;
286 }
287 }
288 if (empty($suitableRequestHandlers)) {
289 throw new \TYPO3\CMS\Core\Exception('No suitable request handler found.', 1225418233);
290 }
291 ksort($suitableRequestHandlers);
292 return array_pop($suitableRequestHandlers);
293 }
294
295 /**
296 * Builds a Request instance from the current process, and then resolves the request
297 * through the request handlers depending on Frontend, Backend, CLI etc.
298 *
299 * @param \Psr\Http\Message\RequestInterface|\Symfony\Component\Console\Input\InputInterface $request
300 * @return Bootstrap
301 * @throws \TYPO3\CMS\Core\Exception
302 * @internal This is not a public API method, do not use in own extensions
303 */
304 public function handleRequest($request)
305 {
306 // Resolve request handler that were registered based on the Application
307 $requestHandler = $this->resolveRequestHandler($request);
308
309 // Execute the command which returns a Response object or NULL
310 $this->response = $requestHandler->handleRequest($request);
311 return $this;
312 }
313
314 /**
315 * Outputs content if there is a proper Response object.
316 *
317 * @return Bootstrap
318 */
319 protected function sendResponse()
320 {
321 if ($this->response instanceof \Psr\Http\Message\ResponseInterface) {
322 if (!headers_sent()) {
323 // If the response code was not changed by legacy code (still is 200)
324 // then allow the PSR-7 response object to explicitly set it.
325 // Otherwise let legacy code take precedence.
326 // This code path can be deprecated once we expose the response object to third party code
327 if (http_response_code() === 200) {
328 header('HTTP/' . $this->response->getProtocolVersion() . ' ' . $this->response->getStatusCode() . ' ' . $this->response->getReasonPhrase());
329 }
330
331 foreach ($this->response->getHeaders() as $name => $values) {
332 header($name . ': ' . implode(', ', $values));
333 }
334 }
335 echo $this->response->getBody()->__toString();
336 }
337 return $this;
338 }
339
340 /**
341 * Registers the instance of the specified object for an early boot stage.
342 * On finalizing the Object Manager initialization, all those instances will
343 * be transferred to the Object Manager's registry.
344 *
345 * @param string $objectName Object name, as later used by the Object Manager
346 * @param object $instance The instance to register
347 * @return void
348 * @internal This is not a public API method, do not use in own extensions
349 */
350 public function setEarlyInstance($objectName, $instance)
351 {
352 $this->earlyInstances[$objectName] = $instance;
353 }
354
355 /**
356 * Returns an instance which was registered earlier through setEarlyInstance()
357 *
358 * @param string $objectName Object name of the registered instance
359 * @return object
360 * @throws \TYPO3\CMS\Core\Exception
361 * @internal This is not a public API method, do not use in own extensions
362 */
363 public function getEarlyInstance($objectName)
364 {
365 if (!isset($this->earlyInstances[$objectName])) {
366 throw new \TYPO3\CMS\Core\Exception('Unknown early instance "' . $objectName . '"', 1365167380);
367 }
368 return $this->earlyInstances[$objectName];
369 }
370
371 /**
372 * Returns all registered early instances indexed by object name
373 *
374 * @return array
375 * @internal This is not a public API method, do not use in own extensions
376 */
377 public function getEarlyInstances()
378 {
379 return $this->earlyInstances;
380 }
381
382 /**
383 * Includes LocalConfiguration.php and sets several
384 * global settings depending on configuration.
385 *
386 * @param bool $allowCaching Whether to allow caching - affects cache_core (autoloader)
387 * @param string $packageManagerClassName Define an alternative package manager implementation (usually for the installer)
388 * @return Bootstrap
389 * @internal This is not a public API method, do not use in own extensions
390 */
391 public function loadConfigurationAndInitialize($allowCaching = true, $packageManagerClassName = \TYPO3\CMS\Core\Package\PackageManager::class)
392 {
393 $this->populateLocalConfiguration()
394 ->initializeErrorHandling();
395 if (!$allowCaching) {
396 $this->disableCoreCache();
397 }
398 $this->initializeCachingFramework()
399 ->initializePackageManagement($packageManagerClassName)
400 ->initializeRuntimeActivatedPackagesFromConfiguration()
401 ->defineUserAgentConstant()
402 ->registerExtDirectComponents()
403 ->setCacheHashOptions()
404 ->setDefaultTimezone()
405 ->initializeL10nLocales()
406 ->setMemoryLimit();
407 if ($allowCaching) {
408 $this->ensureClassLoadingInformationExists();
409 }
410 return $this;
411 }
412
413 /**
414 * Initializes the package system and loads the package configuration and settings
415 * provided by the packages.
416 *
417 * @param string $packageManagerClassName Define an alternative package manager implementation (usually for the installer)
418 * @return Bootstrap
419 * @internal This is not a public API method, do not use in own extensions
420 */
421 public function initializePackageManagement($packageManagerClassName)
422 {
423 /** @var \TYPO3\CMS\Core\Package\PackageManager $packageManager */
424 $packageManager = new $packageManagerClassName();
425 $this->setEarlyInstance(\TYPO3\CMS\Core\Package\PackageManager::class, $packageManager);
426 ExtensionManagementUtility::setPackageManager($packageManager);
427 $packageManager->injectCoreCache($this->getEarlyInstance(\TYPO3\CMS\Core\Cache\CacheManager::class)->getCache('cache_core'));
428 $dependencyResolver = GeneralUtility::makeInstance(\TYPO3\CMS\Core\Package\DependencyResolver::class);
429 $dependencyResolver->injectDependencyOrderingService(GeneralUtility::makeInstance(\TYPO3\CMS\Core\Service\DependencyOrderingService::class));
430 $packageManager->injectDependencyResolver($dependencyResolver);
431 $packageManager->initialize();
432 GeneralUtility::setSingletonInstance(\TYPO3\CMS\Core\Package\PackageManager::class, $packageManager);
433 return $this;
434 }
435
436 /**
437 * Writes class loading information if not yet present
438 *
439 * @return Bootstrap
440 * @internal This is not a public API method, do not use in own extensions
441 * @deprecated since TYPO3 v8, will be removed in TYPO3 v9. Use the Install Tool to dump autoload information.
442 */
443 public function ensureClassLoadingInformationExists()
444 {
445 if (!self::$usesComposerClassLoading && !ClassLoadingInformation::isClassLoadingInformationAvailable()) {
446 GeneralUtility::logDeprecatedFunction();
447 ClassLoadingInformation::dumpClassLoadingInformation();
448 ClassLoadingInformation::registerClassLoadingInformation();
449 }
450 return $this;
451 }
452
453 /**
454 * Activates a package during runtime. This is used in AdditionalConfiguration.php
455 * to enable extensions under conditions.
456 *
457 * @return Bootstrap
458 */
459 protected function initializeRuntimeActivatedPackagesFromConfiguration()
460 {
461 if (!empty($GLOBALS['TYPO3_CONF_VARS']['EXT']['runtimeActivatedPackages']) && is_array($GLOBALS['TYPO3_CONF_VARS']['EXT']['runtimeActivatedPackages'])) {
462 /** @var \TYPO3\CMS\Core\Package\PackageManager $packageManager */
463 $packageManager = $this->getEarlyInstance(\TYPO3\CMS\Core\Package\PackageManager::class);
464 foreach ($GLOBALS['TYPO3_CONF_VARS']['EXT']['runtimeActivatedPackages'] as $runtimeAddedPackageKey) {
465 $packageManager->activatePackageDuringRuntime($runtimeAddedPackageKey);
466 }
467 }
468 return $this;
469 }
470
471 /**
472 * Load ext_localconf of extensions
473 *
474 * @param bool $allowCaching
475 * @return Bootstrap
476 * @internal This is not a public API method, do not use in own extensions
477 */
478 public function loadTypo3LoadedExtAndExtLocalconf($allowCaching = true)
479 {
480 ExtensionManagementUtility::loadExtLocalconf($allowCaching);
481 return $this;
482 }
483
484 /**
485 * We need an early instance of the configuration manager.
486 * Since makeInstance relies on the object configuration, we create it here with new instead.
487 *
488 * @return Bootstrap
489 * @internal This is not a public API method, do not use in own extensions
490 */
491 public function populateLocalConfiguration()
492 {
493 try {
494 $configurationManager = $this->getEarlyInstance(\TYPO3\CMS\Core\Configuration\ConfigurationManager::class);
495 } catch (\TYPO3\CMS\Core\Exception $exception) {
496 $configurationManager = new \TYPO3\CMS\Core\Configuration\ConfigurationManager();
497 $this->setEarlyInstance(\TYPO3\CMS\Core\Configuration\ConfigurationManager::class, $configurationManager);
498 }
499 $configurationManager->exportConfiguration();
500 return $this;
501 }
502
503 /**
504 * Set cache_core to null backend, effectively disabling eg. the cache for ext_localconf and PackageManager etc.
505 *
506 * @return \TYPO3\CMS\Core\Core\Bootstrap
507 * @internal This is not a public API method, do not use in own extensions
508 */
509 public function disableCoreCache()
510 {
511 $GLOBALS['TYPO3_CONF_VARS']['SYS']['caching']['cacheConfigurations']['cache_core']['backend']
512 = \TYPO3\CMS\Core\Cache\Backend\NullBackend::class;
513 unset($GLOBALS['TYPO3_CONF_VARS']['SYS']['caching']['cacheConfigurations']['cache_core']['options']);
514 return $this;
515 }
516
517 /**
518 * Define user agent constant
519 *
520 * @return \TYPO3\CMS\Core\Core\Bootstrap
521 */
522 protected function defineUserAgentConstant()
523 {
524 define('TYPO3_user_agent', 'User-Agent: ' . $GLOBALS['TYPO3_CONF_VARS']['HTTP']['headers']['User-Agent']);
525 return $this;
526 }
527
528 /**
529 * Register default ExtDirect components
530 *
531 * @return Bootstrap
532 */
533 protected function registerExtDirectComponents()
534 {
535 if (TYPO3_MODE === 'BE') {
536 ExtensionManagementUtility::registerExtDirectComponent(
537 'TYPO3.Components.PageTree.DataProvider',
538 \TYPO3\CMS\Backend\Tree\Pagetree\ExtdirectTreeDataProvider::class
539 );
540 ExtensionManagementUtility::registerExtDirectComponent(
541 'TYPO3.Components.PageTree.Commands',
542 \TYPO3\CMS\Backend\Tree\Pagetree\ExtdirectTreeCommands::class
543 );
544 }
545 return $this;
546 }
547
548 /**
549 * Initialize caching framework, and re-initializes it (e.g. in the install tool) by recreating the instances
550 * again despite the Singleton instance
551 *
552 * @return Bootstrap
553 * @internal This is not a public API method, do not use in own extensions
554 */
555 public function initializeCachingFramework()
556 {
557 $cacheManager = new \TYPO3\CMS\Core\Cache\CacheManager();
558 $cacheManager->setCacheConfigurations($GLOBALS['TYPO3_CONF_VARS']['SYS']['caching']['cacheConfigurations']);
559 GeneralUtility::setSingletonInstance(\TYPO3\CMS\Core\Cache\CacheManager::class, $cacheManager);
560 $this->setEarlyInstance(\TYPO3\CMS\Core\Cache\CacheManager::class, $cacheManager);
561 return $this;
562 }
563
564 /**
565 * Set cacheHash options
566 *
567 * @return Bootstrap
568 */
569 protected function setCacheHashOptions()
570 {
571 $GLOBALS['TYPO3_CONF_VARS']['FE']['cacheHash'] = [
572 'cachedParametersWhiteList' => GeneralUtility::trimExplode(',', $GLOBALS['TYPO3_CONF_VARS']['FE']['cHashOnlyForParameters'], true),
573 'excludedParameters' => GeneralUtility::trimExplode(',', $GLOBALS['TYPO3_CONF_VARS']['FE']['cHashExcludedParameters'], true),
574 'requireCacheHashPresenceParameters' => GeneralUtility::trimExplode(',', $GLOBALS['TYPO3_CONF_VARS']['FE']['cHashRequiredParameters'], true),
575 ];
576 if (trim($GLOBALS['TYPO3_CONF_VARS']['FE']['cHashExcludedParametersIfEmpty']) === '*') {
577 $GLOBALS['TYPO3_CONF_VARS']['FE']['cacheHash']['excludeAllEmptyParameters'] = true;
578 } else {
579 $GLOBALS['TYPO3_CONF_VARS']['FE']['cacheHash']['excludedParametersIfEmpty'] = GeneralUtility::trimExplode(',', $GLOBALS['TYPO3_CONF_VARS']['FE']['cHashExcludedParametersIfEmpty'], true);
580 }
581 return $this;
582 }
583
584 /**
585 * Set default timezone
586 *
587 * @return Bootstrap
588 */
589 protected function setDefaultTimezone()
590 {
591 $timeZone = $GLOBALS['TYPO3_CONF_VARS']['SYS']['phpTimeZone'];
592 if (empty($timeZone)) {
593 // Time zone from the server environment (TZ env or OS query)
594 $defaultTimeZone = @date_default_timezone_get();
595 if ($defaultTimeZone !== '') {
596 $timeZone = $defaultTimeZone;
597 } else {
598 $timeZone = 'UTC';
599 }
600 }
601 // Set default to avoid E_WARNINGs with PHP > 5.3
602 date_default_timezone_set($timeZone);
603 return $this;
604 }
605
606 /**
607 * Initialize the locales handled by TYPO3
608 *
609 * @return Bootstrap
610 */
611 protected function initializeL10nLocales()
612 {
613 \TYPO3\CMS\Core\Localization\Locales::initialize();
614 return $this;
615 }
616
617 /**
618 * Configure and set up exception and error handling
619 *
620 * @return Bootstrap
621 * @throws \RuntimeException
622 */
623 protected function initializeErrorHandling()
624 {
625 $productionExceptionHandlerClassName = $GLOBALS['TYPO3_CONF_VARS']['SYS']['productionExceptionHandler'];
626 $debugExceptionHandlerClassName = $GLOBALS['TYPO3_CONF_VARS']['SYS']['debugExceptionHandler'];
627
628 $errorHandlerClassName = $GLOBALS['TYPO3_CONF_VARS']['SYS']['errorHandler'];
629 $errorHandlerErrors = $GLOBALS['TYPO3_CONF_VARS']['SYS']['errorHandlerErrors'];
630 $exceptionalErrors = $GLOBALS['TYPO3_CONF_VARS']['SYS']['exceptionalErrors'];
631
632 $displayErrorsSetting = (int)$GLOBALS['TYPO3_CONF_VARS']['SYS']['displayErrors'];
633 switch ($displayErrorsSetting) {
634 case -1:
635 $ipMatchesDevelopmentSystem = GeneralUtility::cmpIP(GeneralUtility::getIndpEnv('REMOTE_ADDR'), $GLOBALS['TYPO3_CONF_VARS']['SYS']['devIPmask']);
636 $exceptionHandlerClassName = $ipMatchesDevelopmentSystem ? $debugExceptionHandlerClassName : $productionExceptionHandlerClassName;
637 $displayErrors = $ipMatchesDevelopmentSystem ? 1 : 0;
638 $exceptionalErrors = $ipMatchesDevelopmentSystem ? $exceptionalErrors : 0;
639 break;
640 case 0:
641 $exceptionHandlerClassName = $productionExceptionHandlerClassName;
642 $displayErrors = 0;
643 break;
644 case 1:
645 $exceptionHandlerClassName = $debugExceptionHandlerClassName;
646 $displayErrors = 1;
647 break;
648 default:
649 // Throw exception if an invalid option is set.
650 throw new \RuntimeException(
651 'The option $TYPO3_CONF_VARS[SYS][displayErrors] is not set to "-1", "0" or "1".',
652 1476046290
653 );
654 }
655 @ini_set('display_errors', $displayErrors);
656
657 if (!empty($errorHandlerClassName)) {
658 // Register an error handler for the given errorHandlerError
659 $errorHandler = GeneralUtility::makeInstance($errorHandlerClassName, $errorHandlerErrors);
660 $errorHandler->setExceptionalErrors($exceptionalErrors);
661 if (is_callable([$errorHandler, 'setDebugMode'])) {
662 $errorHandler->setDebugMode($displayErrors === 1);
663 }
664 }
665 if (!empty($exceptionHandlerClassName)) {
666 // Registering the exception handler is done in the constructor
667 GeneralUtility::makeInstance($exceptionHandlerClassName);
668 }
669 return $this;
670 }
671
672 /**
673 * Set PHP memory limit depending on value of
674 * $GLOBALS['TYPO3_CONF_VARS']['SYS']['setMemoryLimit']
675 *
676 * @return Bootstrap
677 */
678 protected function setMemoryLimit()
679 {
680 if ((int)$GLOBALS['TYPO3_CONF_VARS']['SYS']['setMemoryLimit'] > 16) {
681 @ini_set('memory_limit', ((int)$GLOBALS['TYPO3_CONF_VARS']['SYS']['setMemoryLimit'] . 'm'));
682 }
683 return $this;
684 }
685
686 /**
687 * Define TYPO3_REQUESTTYPE* constants that can be used for developers to see if any context has been hit
688 * also see setRequestType(). Is done at the very beginning so these parameters are always available.
689 *
690 * @return Bootstrap
691 */
692 protected function defineTypo3RequestTypes()
693 {
694 define('TYPO3_REQUESTTYPE_FE', 1);
695 define('TYPO3_REQUESTTYPE_BE', 2);
696 define('TYPO3_REQUESTTYPE_CLI', 4);
697 define('TYPO3_REQUESTTYPE_AJAX', 8);
698 define('TYPO3_REQUESTTYPE_INSTALL', 16);
699 }
700
701 /**
702 * Defines the TYPO3_REQUESTTYPE constant so the environment knows which context the request is running.
703 *
704 * @throws \RuntimeException if the method was already called during a request
705 * @return Bootstrap
706 */
707 public function setRequestType($requestType)
708 {
709 if (defined('TYPO3_REQUESTTYPE')) {
710 throw new \RuntimeException('TYPO3_REQUESTTYPE has already been set, cannot be called multiple times', 1450561878);
711 }
712 define('TYPO3_REQUESTTYPE', $requestType);
713 return $this;
714 }
715
716 /**
717 * Extensions may register new caches, so we set the
718 * global cache array to the manager again at this point
719 *
720 * @return Bootstrap
721 * @internal This is not a public API method, do not use in own extensions
722 */
723 public function setFinalCachingFrameworkCacheConfiguration()
724 {
725 $this->getEarlyInstance(\TYPO3\CMS\Core\Cache\CacheManager::class)->setCacheConfigurations($GLOBALS['TYPO3_CONF_VARS']['SYS']['caching']['cacheConfigurations']);
726 return $this;
727 }
728
729 /**
730 * Define logging and exception constants
731 *
732 * @return Bootstrap
733 * @internal This is not a public API method, do not use in own extensions
734 */
735 public function defineLoggingAndExceptionConstants()
736 {
737 define('TYPO3_DLOG', $GLOBALS['TYPO3_CONF_VARS']['SYS']['enable_DLOG']);
738 define('TYPO3_ERROR_DLOG', $GLOBALS['TYPO3_CONF_VARS']['SYS']['enable_errorDLOG']);
739 define('TYPO3_EXCEPTION_DLOG', $GLOBALS['TYPO3_CONF_VARS']['SYS']['enable_exceptionDLOG']);
740 return $this;
741 }
742
743 /**
744 * Unsetting reserved global variables:
745 * Those are set in "ext:core/ext_tables.php" file:
746 *
747 * @return Bootstrap
748 * @internal This is not a public API method, do not use in own extensions
749 */
750 public function unsetReservedGlobalVariables()
751 {
752 unset($GLOBALS['PAGES_TYPES']);
753 unset($GLOBALS['TCA']);
754 unset($GLOBALS['TBE_MODULES']);
755 unset($GLOBALS['TBE_STYLES']);
756 unset($GLOBALS['BE_USER']);
757 // Those set otherwise:
758 unset($GLOBALS['TBE_MODULES_EXT']);
759 unset($GLOBALS['TCA_DESCR']);
760 unset($GLOBALS['LOCAL_LANG']);
761 return $this;
762 }
763
764 /**
765 * Initialize database connection in $GLOBALS and connect if requested
766 *
767 * @return \TYPO3\CMS\Core\Core\Bootstrap
768 * @internal This is not a public API method, do not use in own extensions
769 */
770 public function initializeTypo3DbGlobal()
771 {
772 /** @var $databaseConnection \TYPO3\CMS\Core\Database\DatabaseConnection */
773 $databaseConnection = GeneralUtility::makeInstance(\TYPO3\CMS\Core\Database\DatabaseConnection::class);
774 $databaseConnection->setDatabaseName(
775 $GLOBALS['TYPO3_CONF_VARS']['DB']['Connections']['Default']['dbname'] ?? ''
776 );
777 $databaseConnection->setDatabaseUsername(
778 $GLOBALS['TYPO3_CONF_VARS']['DB']['Connections']['Default']['user'] ?? ''
779 );
780 $databaseConnection->setDatabasePassword(
781 $GLOBALS['TYPO3_CONF_VARS']['DB']['Connections']['Default']['password'] ?? ''
782 );
783
784 $databaseHost = $GLOBALS['TYPO3_CONF_VARS']['DB']['Connections']['Default']['host'] ?? '';
785 if (isset($GLOBALS['TYPO3_CONF_VARS']['DB']['Connections']['Default']['port'])) {
786 $databaseConnection->setDatabasePort($GLOBALS['TYPO3_CONF_VARS']['DB']['Connections']['Default']['port']);
787 } elseif (strpos($databaseHost, ':') > 0) {
788 // @TODO: Find a way to handle this case in the install tool and drop this
789 list($databaseHost, $databasePort) = explode(':', $databaseHost);
790 $databaseConnection->setDatabasePort($databasePort);
791 }
792 if (isset($GLOBALS['TYPO3_CONF_VARS']['DB']['Connections']['Default']['unix_socket'])) {
793 $databaseConnection->setDatabaseSocket(
794 $GLOBALS['TYPO3_CONF_VARS']['DB']['Connections']['Default']['unix_socket']
795 );
796 }
797 $databaseConnection->setDatabaseHost($databaseHost);
798
799 $databaseConnection->debugOutput = $GLOBALS['TYPO3_CONF_VARS']['SYS']['sqlDebug'];
800
801 if (isset($GLOBALS['TYPO3_CONF_VARS']['DB']['Connections']['Default']['persistentConnection'])
802 && $GLOBALS['TYPO3_CONF_VARS']['DB']['Connections']['Default']['persistentConnection']
803 ) {
804 $databaseConnection->setPersistentDatabaseConnection(true);
805 }
806
807 $isDatabaseHostLocalHost = in_array($databaseHost, ['localhost', '127.0.0.1', '::1'], true);
808 if (isset($GLOBALS['TYPO3_CONF_VARS']['DB']['Connections']['Default']['driverOptions'])
809 && $GLOBALS['TYPO3_CONF_VARS']['DB']['Connections']['Default']['driverOptions'] & MYSQLI_CLIENT_COMPRESS
810 && !$isDatabaseHostLocalHost
811 ) {
812 $databaseConnection->setConnectionCompression(true);
813 }
814
815 if (!empty($GLOBALS['TYPO3_CONF_VARS']['DB']['Connections']['Default']['initCommands'])) {
816 $commandsAfterConnect = GeneralUtility::trimExplode(
817 LF,
818 str_replace(
819 '\' . LF . \'',
820 LF,
821 $GLOBALS['TYPO3_CONF_VARS']['DB']['Connections']['Default']['initCommands']
822 ),
823 true
824 );
825 $databaseConnection->setInitializeCommandsAfterConnect($commandsAfterConnect);
826 }
827
828 $GLOBALS['TYPO3_DB'] = $databaseConnection;
829 // $GLOBALS['TYPO3_DB'] needs to be defined first in order to work for DBAL
830 $GLOBALS['TYPO3_DB']->initialize();
831
832 return $this;
833 }
834
835 /**
836 * Check adminOnly configuration variable and redirects
837 * to an URL in file typo3conf/LOCK_BACKEND or exit the script
838 *
839 * @throws \RuntimeException
840 * @param bool $forceProceeding if this option is set, the bootstrap will proceed even if the user is logged in (usually only needed for special AJAX cases, see AjaxRequestHandler)
841 * @return Bootstrap
842 * @internal This is not a public API method, do not use in own extensions
843 */
844 public function checkLockedBackendAndRedirectOrDie($forceProceeding = false)
845 {
846 if ($GLOBALS['TYPO3_CONF_VARS']['BE']['adminOnly'] < 0) {
847 throw new \RuntimeException('TYPO3 Backend locked: Backend and Install Tool are locked for maintenance. [BE][adminOnly] is set to "' . (int)$GLOBALS['TYPO3_CONF_VARS']['BE']['adminOnly'] . '".', 1294586847);
848 }
849 if (@is_file(PATH_typo3conf . 'LOCK_BACKEND') && $forceProceeding === false) {
850 $fileContent = file_get_contents(PATH_typo3conf . 'LOCK_BACKEND');
851 if ($fileContent) {
852 header('Location: ' . $fileContent);
853 } else {
854 throw new \RuntimeException('TYPO3 Backend locked: Browser backend is locked for maintenance. Remove lock by removing the file "typo3conf/LOCK_BACKEND" or use CLI-scripts.', 1294586848);
855 }
856 die;
857 }
858 return $this;
859 }
860
861 /**
862 * Compare client IP with IPmaskList and exit the script run
863 * if the client is not allowed to access the backend
864 *
865 * @return Bootstrap
866 * @internal This is not a public API method, do not use in own extensions
867 * @throws \RuntimeException
868 */
869 public function checkBackendIpOrDie()
870 {
871 if (trim($GLOBALS['TYPO3_CONF_VARS']['BE']['IPmaskList'])) {
872 if (!GeneralUtility::cmpIP(GeneralUtility::getIndpEnv('REMOTE_ADDR'), $GLOBALS['TYPO3_CONF_VARS']['BE']['IPmaskList'])) {
873 throw new \RuntimeException('TYPO3 Backend access denied: The IP address of your client does not match the list of allowed IP addresses.', 1389265900);
874 }
875 }
876 return $this;
877 }
878
879 /**
880 * Check lockSSL configuration variable and redirect
881 * to https version of the backend if needed
882 *
883 * @return Bootstrap
884 * @internal This is not a public API method, do not use in own extensions
885 * @throws \RuntimeException
886 */
887 public function checkSslBackendAndRedirectIfNeeded()
888 {
889 if ((bool)$GLOBALS['TYPO3_CONF_VARS']['BE']['lockSSL'] && !GeneralUtility::getIndpEnv('TYPO3_SSL')) {
890 if ((int)$GLOBALS['TYPO3_CONF_VARS']['BE']['lockSSLPort']) {
891 $sslPortSuffix = ':' . (int)$GLOBALS['TYPO3_CONF_VARS']['BE']['lockSSLPort'];
892 } else {
893 $sslPortSuffix = '';
894 }
895 list(, $url) = explode('://', GeneralUtility::getIndpEnv('TYPO3_SITE_URL') . TYPO3_mainDir, 2);
896 list($server, $address) = explode('/', $url, 2);
897 header('Location: https://' . $server . $sslPortSuffix . '/' . $address);
898 die;
899 }
900 return $this;
901 }
902
903 /**
904 * Load ext_tables and friends.
905 *
906 * This will mainly set up $TCA and several other global arrays
907 * through API's like extMgm.
908 * Executes ext_tables.php files of loaded extensions or the
909 * according cache file if exists.
910 *
911 * @param bool $allowCaching True, if reading compiled ext_tables file from cache is allowed
912 * @return Bootstrap
913 * @internal This is not a public API method, do not use in own extensions
914 */
915 public function loadExtensionTables($allowCaching = true)
916 {
917 $this->loadBaseTca($allowCaching)->loadExtTables($allowCaching);
918 return $this;
919 }
920
921 /**
922 * Load $TCA
923 *
924 * This will mainly set up $TCA through extMgm API.
925 *
926 * @param bool $allowCaching True, if loading TCA from cache is allowed
927 * @return Bootstrap
928 * @internal This is not a public API method, do not use in own extensions
929 */
930 public function loadBaseTca(bool $allowCaching = true): Bootstrap
931 {
932 ExtensionManagementUtility::loadBaseTca($allowCaching);
933 return $this;
934 }
935
936 /**
937 * Load ext_tables and friends.
938 *
939 * This will mainly load and execute ext_tables.php files of loaded extensions
940 * or the according cache file if exists.
941 *
942 * @param bool $allowCaching True, if reading compiled ext_tables file from cache is allowed
943 * @return Bootstrap
944 * @internal This is not a public API method, do not use in own extensions
945 */
946 public function loadExtTables(bool $allowCaching = true): Bootstrap
947 {
948 ExtensionManagementUtility::loadExtTables($allowCaching);
949 $this->runExtTablesPostProcessingHooks();
950 return $this;
951 }
952
953 /**
954 * Check for registered ext tables hooks and run them
955 *
956 * @throws \UnexpectedValueException
957 * @return void
958 */
959 protected function runExtTablesPostProcessingHooks()
960 {
961 if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['GLOBAL']['extTablesInclusion-PostProcessing'])) {
962 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['GLOBAL']['extTablesInclusion-PostProcessing'] as $classReference) {
963 /** @var $hookObject \TYPO3\CMS\Core\Database\TableConfigurationPostProcessingHookInterface */
964 $hookObject = GeneralUtility::getUserObj($classReference);
965 if (!$hookObject instanceof \TYPO3\CMS\Core\Database\TableConfigurationPostProcessingHookInterface) {
966 throw new \UnexpectedValueException(
967 '$hookObject "' . $classReference . '" must implement interface TYPO3\\CMS\\Core\\Database\\TableConfigurationPostProcessingHookInterface',
968 1320585902
969 );
970 }
971 $hookObject->processData();
972 }
973 }
974 }
975
976 /**
977 * Initialize the Routing for the TYPO3 Backend
978 * Loads all routes registered inside all packages and stores them inside the Router
979 *
980 * @return Bootstrap
981 * @internal This is not a public API method, do not use in own extensions
982 */
983 public function initializeBackendRouter()
984 {
985 // See if the Routes.php from all active packages have been built together already
986 $cacheIdentifier = 'BackendRoutesFromPackages_' . sha1((TYPO3_version . PATH_site . 'BackendRoutesFromPackages'));
987
988 /** @var $codeCache \TYPO3\CMS\Core\Cache\Frontend\PhpFrontend */
989 $codeCache = $this->getEarlyInstance(\TYPO3\CMS\Core\Cache\CacheManager::class)->getCache('cache_core');
990 $routesFromPackages = [];
991 if ($codeCache->has($cacheIdentifier)) {
992 // substr is necessary, because the php frontend wraps php code around the cache value
993 $routesFromPackages = unserialize(substr($codeCache->get($cacheIdentifier), 6, -2));
994 } else {
995 // Loop over all packages and check for a Configuration/Backend/Routes.php file
996 $packageManager = $this->getEarlyInstance(\TYPO3\CMS\Core\Package\PackageManager::class);
997 $packages = $packageManager->getActivePackages();
998 foreach ($packages as $package) {
999 $routesFileNameForPackage = $package->getPackagePath() . 'Configuration/Backend/Routes.php';
1000 if (file_exists($routesFileNameForPackage)) {
1001 $definedRoutesInPackage = require $routesFileNameForPackage;
1002 if (is_array($definedRoutesInPackage)) {
1003 $routesFromPackages = array_merge($routesFromPackages, $definedRoutesInPackage);
1004 }
1005 }
1006 $routesFileNameForPackage = $package->getPackagePath() . 'Configuration/Backend/AjaxRoutes.php';
1007 if (file_exists($routesFileNameForPackage)) {
1008 $definedRoutesInPackage = require $routesFileNameForPackage;
1009 if (is_array($definedRoutesInPackage)) {
1010 foreach ($definedRoutesInPackage as $routeIdentifier => $routeOptions) {
1011 // prefix the route with "ajax_" as "namespace"
1012 $routeOptions['path'] = '/ajax' . $routeOptions['path'];
1013 $routesFromPackages['ajax_' . $routeIdentifier] = $routeOptions;
1014 $routesFromPackages['ajax_' . $routeIdentifier]['ajax'] = true;
1015 }
1016 }
1017 }
1018 }
1019 // Store the data from all packages in the cache
1020 $codeCache->set($cacheIdentifier, serialize($routesFromPackages));
1021 }
1022
1023 // Build Route objects from the data
1024 $router = GeneralUtility::makeInstance(\TYPO3\CMS\Backend\Routing\Router::class);
1025 foreach ($routesFromPackages as $name => $options) {
1026 $path = $options['path'];
1027 unset($options['path']);
1028 $route = GeneralUtility::makeInstance(\TYPO3\CMS\Backend\Routing\Route::class, $path, $options);
1029 $router->addRoute($name, $route);
1030 }
1031 return $this;
1032 }
1033
1034 /**
1035 * Initialize backend user object in globals
1036 *
1037 * @param string $className usually \TYPO3\CMS\Core\Authentication\BackendUserAuthentication::class but can be used for CLI
1038 * @return Bootstrap
1039 * @internal This is not a public API method, do not use in own extensions
1040 */
1041 public function initializeBackendUser($className = \TYPO3\CMS\Core\Authentication\BackendUserAuthentication::class)
1042 {
1043 /** @var $backendUser \TYPO3\CMS\Core\Authentication\BackendUserAuthentication */
1044 $backendUser = GeneralUtility::makeInstance($className);
1045 // The global must be available very early, because methods below
1046 // might trigger code which relies on it. See: #45625
1047 $GLOBALS['BE_USER'] = $backendUser;
1048 $backendUser->start();
1049 return $this;
1050 }
1051
1052 /**
1053 * Initializes and ensures authenticated access
1054 *
1055 * @internal This is not a public API method, do not use in own extensions
1056 * @param bool $proceedIfNoUserIsLoggedIn if set to TRUE, no forced redirect to the login page will be done
1057 * @return \TYPO3\CMS\Core\Core\Bootstrap
1058 */
1059 public function initializeBackendAuthentication($proceedIfNoUserIsLoggedIn = false)
1060 {
1061 $GLOBALS['BE_USER']->backendCheckLogin($proceedIfNoUserIsLoggedIn);
1062 return $this;
1063 }
1064
1065 /**
1066 * Initialize language object
1067 *
1068 * @return Bootstrap
1069 * @internal This is not a public API method, do not use in own extensions
1070 */
1071 public function initializeLanguageObject()
1072 {
1073 /** @var $GLOBALS['LANG'] \TYPO3\CMS\Lang\LanguageService */
1074 $GLOBALS['LANG'] = GeneralUtility::makeInstance(\TYPO3\CMS\Lang\LanguageService::class);
1075 $GLOBALS['LANG']->init($GLOBALS['BE_USER']->uc['lang']);
1076 return $this;
1077 }
1078
1079 /**
1080 * Throw away all output that may have happened during bootstrapping by weird extensions
1081 *
1082 * @return Bootstrap
1083 * @internal This is not a public API method, do not use in own extensions
1084 */
1085 public function endOutputBufferingAndCleanPreviousOutput()
1086 {
1087 ob_clean();
1088 return $this;
1089 }
1090
1091 /**
1092 * Initialize output compression if configured
1093 *
1094 * @return Bootstrap
1095 * @internal This is not a public API method, do not use in own extensions
1096 */
1097 public function initializeOutputCompression()
1098 {
1099 if (extension_loaded('zlib') && $GLOBALS['TYPO3_CONF_VARS']['BE']['compressionLevel']) {
1100 if (MathUtility::canBeInterpretedAsInteger($GLOBALS['TYPO3_CONF_VARS']['BE']['compressionLevel'])) {
1101 @ini_set('zlib.output_compression_level', $GLOBALS['TYPO3_CONF_VARS']['BE']['compressionLevel']);
1102 }
1103 ob_start('ob_gzhandler');
1104 }
1105 return $this;
1106 }
1107
1108 /**
1109 * Send HTTP headers if configured
1110 *
1111 * @return Bootstrap
1112 * @internal This is not a public API method, do not use in own extensions
1113 */
1114 public function sendHttpHeaders()
1115 {
1116 if (!empty($GLOBALS['TYPO3_CONF_VARS']['BE']['HTTP']['Response']['Headers']) && is_array($GLOBALS['TYPO3_CONF_VARS']['BE']['HTTP']['Response']['Headers'])) {
1117 foreach ($GLOBALS['TYPO3_CONF_VARS']['BE']['HTTP']['Response']['Headers'] as $header) {
1118 header($header);
1119 }
1120 }
1121 return $this;
1122 }
1123
1124 /**
1125 * Things that should be performed to shut down the framework.
1126 * This method is called in all important scripts for a clean
1127 * shut down of the system.
1128 *
1129 * @return Bootstrap
1130 * @internal This is not a public API method, do not use in own extensions
1131 */
1132 public function shutdown()
1133 {
1134 $this->sendResponse();
1135 return $this;
1136 }
1137
1138 /**
1139 * Provides an instance of "template" for backend-modules to
1140 * work with.
1141 *
1142 * @return Bootstrap
1143 * @internal This is not a public API method, do not use in own extensions
1144 */
1145 public function initializeBackendTemplate()
1146 {
1147 $GLOBALS['TBE_TEMPLATE'] = GeneralUtility::makeInstance(\TYPO3\CMS\Backend\Template\DocumentTemplate::class);
1148 return $this;
1149 }
1150 }