vendor/contao/core-bundle/src/Framework/ContaoFramework.php line 298

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /*
  6.  * This file is part of Contao.
  7.  *
  8.  * (c) Leo Feyer
  9.  *
  10.  * @license LGPL-3.0-or-later
  11.  */
  13. namespace Contao\CoreBundle\Framework;
  15. use Contao\ClassLoader;
  16. use Contao\Config;
  17. use Contao\Controller;
  18. use Contao\CoreBundle\Exception\LegacyRoutingException;
  19. use Contao\CoreBundle\Exception\RedirectResponseException;
  20. use Contao\CoreBundle\Routing\ScopeMatcher;
  21. use Contao\CoreBundle\Security\Authentication\Token\TokenChecker;
  22. use Contao\CoreBundle\Session\LazySessionAccess;
  23. use Contao\CoreBundle\Util\LocaleUtil;
  24. use Contao\Environment;
  25. use Contao\Input;
  26. use Contao\InsertTags;
  27. use Contao\Model\Registry;
  28. use Contao\PageModel;
  29. use Contao\RequestToken;
  30. use Contao\System;
  31. use Contao\TemplateLoader;
  32. use Symfony\Component\DependencyInjection\ContainerAwareInterface;
  33. use Symfony\Component\DependencyInjection\ContainerAwareTrait;
  34. use Symfony\Component\Filesystem\Filesystem;
  35. use Symfony\Component\Filesystem\Path;
  36. use Symfony\Component\HttpFoundation\Request;
  37. use Symfony\Component\HttpFoundation\RequestStack;
  38. use Symfony\Component\HttpFoundation\Session\SessionInterface;
  39. use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  40. use Symfony\Contracts\Service\ResetInterface;
  42. /**
  43.  * @internal Do not use this class in your code; use the "contao.framework" service instead
  44.  */
  45. class ContaoFramework implements ContaoFrameworkInterface, ContainerAwareInterface, ResetInterface
  46. {
  47.     use ContainerAwareTrait;
  49.     private static bool $initialized = false;
  50.     private static string $nonce = '';
  52.     private RequestStack $requestStack;
  53.     private ScopeMatcher $scopeMatcher;
  54.     private TokenChecker $tokenChecker;
  55.     private Filesystem $filesystem;
  56.     private UrlGeneratorInterface $urlGenerator;
  57.     private string $projectDir;
  58.     private int $errorLevel;
  59.     private bool $legacyRouting;
  60.     private ?Request $request = null;
  61.     private bool $isFrontend = false;
  62.     private array $adapterCache = [];
  63.     private array $hookListeners = [];
  64.     private bool $setLoginConstantsOnInit = false;
  66.     public function __construct(RequestStack $requestStack, ScopeMatcher $scopeMatcher, TokenChecker $tokenChecker, Filesystem $filesystem, UrlGeneratorInterface $urlGenerator, string $projectDir, int $errorLevel, bool $legacyRouting)
  67.     {
  68.         $this->requestStack = $requestStack;
  69.         $this->scopeMatcher = $scopeMatcher;
  70.         $this->tokenChecker = $tokenChecker;
  71.         $this->filesystem = $filesystem;
  72.         $this->urlGenerator = $urlGenerator;
  73.         $this->projectDir = $projectDir;
  74.         $this->errorLevel = $errorLevel;
  75.         $this->legacyRouting = $legacyRouting;
  76.     }
  78.     public function reset(): void
  79.     {
  80.         $this->adapterCache = [];
  81.         $this->isFrontend = false;
  82.         self::$nonce = '';
  84.         if (!$this->isInitialized()) {
  85.             return;
  86.         }
  88.         Controller::resetControllerCache();
  89.         Environment::reset();
  90.         Input::resetCache();
  91.         Input::resetUnusedGet();
  92.         InsertTags::reset();
  93.         PageModel::reset();
  94.         Registry::getInstance()->reset();
  95.     }
  97.     public function isInitialized(): bool
  98.     {
  99.         return self::$initialized;
  100.     }
  102.     /**
  103.      * @throws \LogicException
  104.      */
  105.     public function initialize(bool $isFrontend = false): void
  106.     {
  107.         if ($this->isInitialized()) {
  108.             return;
  109.         }
  111.         // Set before calling any methods to prevent recursion
  112.         self::$initialized = true;
  114.         if (null === $this->container) {
  115.             throw new \LogicException('The service container has not been set.');
  116.         }
  118.         $this->isFrontend = $isFrontend;
  119.         $this->request = $this->requestStack->getMainRequest();
  121.         $this->setConstants();
  122.         $this->initializeFramework();
  124.         if (!$this->legacyRouting) {
  125.             $this->throwOnLegacyRoutingHooks();
  126.         }
  127.     }
  129.     public function setHookListeners(array $hookListeners): void
  130.     {
  131.         $this->hookListeners = $hookListeners;
  132.     }
  134.     /**
  135.      * @template T of object
  136.      *
  137.      * @param class-string<T> $class
  138.      *
  139.      * @return T
  140.      */
  141.     public function createInstance($class, $args = [])
  142.     {
  143.         if (\in_array('getInstance', get_class_methods($class), true)) {
  144.             return \call_user_func_array([$class, 'getInstance'], $args);
  145.         }
  147.         $reflection = new \ReflectionClass($class);
  149.         return $reflection->newInstanceArgs($args);
  150.     }
  152.     /**
  153.      * @template T
  154.      *
  155.      * @param class-string<T> $class
  156.      *
  157.      * @return Adapter<T>&T
  158.      *
  159.      * @phpstan-return Adapter<T>
  160.      */
  161.     public function getAdapter($class): Adapter
  162.     {
  163.         return $this->adapterCache[$class] ??= new Adapter($class);
  164.     }
  166.     public static function getNonce(): string
  167.     {
  168.         if ('' === self::$nonce) {
  169.             self::$nonce = bin2hex(random_bytes(16));
  170.         }
  172.         return self::$nonce;
  173.     }
  175.     /**
  176.      * @deprecated Deprecated since Contao 4.9, to be removed in Contao 5.0
  177.      */
  178.     public function setLoginConstants(): void
  179.     {
  180.         // Check if the constants have already been defined (see #5137)
  181.         if (\defined('BE_USER_LOGGED_IN') || \defined('FE_USER_LOGGED_IN')) {
  182.             return;
  183.         }
  185.         // If the framework has not been initialized yet, set the login constants on init (#4968)
  186.         if (!$this->isInitialized()) {
  187.             $this->setLoginConstantsOnInit = true;
  189.             return;
  190.         }
  192.         if ('FE' === $this->getMode()) {
  193.             \define('BE_USER_LOGGED_IN', $this->tokenChecker->isPreviewMode());
  194.             \define('FE_USER_LOGGED_IN', $this->tokenChecker->hasFrontendUser());
  195.         } else {
  196.             \define('BE_USER_LOGGED_IN', false);
  197.             \define('FE_USER_LOGGED_IN', false);
  198.         }
  199.     }
  201.     /**
  202.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0
  203.      */
  204.     private function setConstants(): void
  205.     {
  206.         if (!\defined('TL_MODE')) {
  207.             \define('TL_MODE', $this->getMode());
  208.         }
  210.         \define('TL_START', microtime(true));
  211.         \define('TL_ROOT', $this->projectDir);
  212.         \define('TL_REFERER_ID', $this->getRefererId());
  214.         if (!\defined('TL_SCRIPT')) {
  215.             \define('TL_SCRIPT', $this->getRoute());
  216.         }
  218.         // Define the login status constants (see #4099, #5279)
  219.         if ($this->setLoginConstantsOnInit || null === $this->requestStack->getCurrentRequest()) {
  220.             $this->setLoginConstants();
  221.         }
  223.         // Define the relative path to the installation (see #5339)
  224.         \define('TL_PATH', $this->getPath());
  225.     }
  227.     private function getMode(): ?string
  228.     {
  229.         if (true === $this->isFrontend) {
  230.             return 'FE';
  231.         }
  233.         if (null === $this->request) {
  234.             return null;
  235.         }
  237.         if ($this->scopeMatcher->isBackendRequest($this->request)) {
  238.             return 'BE';
  239.         }
  241.         if ($this->scopeMatcher->isFrontendRequest($this->request)) {
  242.             return 'FE';
  243.         }
  245.         return null;
  246.     }
  248.     private function getRefererId(): ?string
  249.     {
  250.         if (null === $this->request) {
  251.             return null;
  252.         }
  254.         return $this->request->attributes->get('_contao_referer_id', '');
  255.     }
  257.     private function getRoute(): ?string
  258.     {
  259.         if (null === $this->request) {
  260.             return null;
  261.         }
  263.         return substr($this->request->getBaseUrl().$this->request->getPathInfo(), \strlen($this->request->getBasePath().'/'));
  264.     }
  266.     private function getPath(): ?string
  267.     {
  268.         if (null === $this->request) {
  269.             return null;
  270.         }
  272.         return $this->request->getBasePath();
  273.     }
  275.     private function initializeFramework(): void
  276.     {
  277.         // Set the error_reporting level
  278.         error_reporting($this->errorLevel);
  280.         $this->includeHelpers();
  281.         $this->includeBasicClasses();
  283.         // Set the container
  284.         System::setContainer($this->container);
  286.         $config = $this->getAdapter(Config::class);
  288.         // Preload the configuration (see #5872)
  289.         $config->preload();
  291.         // Register the class loader
  292.         ClassLoader::scanAndRegister();
  294.         $this->initializeLegacySessionAccess();
  295.         $this->setDefaultLanguage();
  297.         // Fully load the configuration
  298.         $config->getInstance();
  300.         $this->registerHookListeners();
  301.         $this->validateInstallation();
  303.         Input::initialize();
  304.         TemplateLoader::initialize();
  306.         $this->setTimezone();
  307.         $this->triggerInitializeSystemHook();
  308.         $this->handleRequestToken();
  309.     }
  311.     private function includeHelpers(): void
  312.     {
  313.         require __DIR__.'/../Resources/contao/helper/functions.php';
  314.         require __DIR__.'/../Resources/contao/config/constants.php';
  315.     }
  317.     /**
  318.      * Includes the basic classes required for further processing.
  319.      */
  320.     private function includeBasicClasses(): void
  321.     {
  322.         static $basicClasses = [
  323.             'System',
  324.             'Config',
  325.             'ClassLoader',
  326.             'TemplateLoader',
  327.             'ModuleLoader',
  328.         ];
  330.         foreach ($basicClasses as $class) {
  331.             if (!class_exists($class, false)) {
  332.                 require_once __DIR__.'/../Resources/contao/library/Contao/'.$class.'.php';
  333.             }
  334.         }
  335.     }
  337.     /**
  338.      * Initializes session access for $_SESSION['FE_DATA'] and $_SESSION['BE_DATA'].
  339.      */
  340.     private function initializeLegacySessionAccess(): void
  341.     {
  342.         if (!$session = $this->getSession()) {
  343.             return;
  344.         }
  346.         if (!$session->isStarted()) {
  347.             $_SESSION = new LazySessionAccess($session, $this->request && $this->request->hasPreviousSession());
  348.         } else {
  349.             $_SESSION['BE_DATA'] = $session->getBag('contao_backend');
  350.             $_SESSION['FE_DATA'] = $session->getBag('contao_frontend');
  351.         }
  352.     }
  354.     private function setDefaultLanguage(): void
  355.     {
  356.         $language = 'en';
  358.         if (null !== $this->request) {
  359.             $language = LocaleUtil::formatAsLanguageTag($this->request->getLocale());
  360.         }
  362.         // Deprecated since Contao 4.0, to be removed in Contao 5.0
  363.         $GLOBALS['TL_LANGUAGE'] = $language;
  364.     }
  366.     /**
  367.      * Redirects to the install tool if the installation is incomplete.
  368.      */
  369.     private function validateInstallation(): void
  370.     {
  371.         if (null === $this->request) {
  372.             return;
  373.         }
  375.         static $installRoutes = [
  376.             'contao_install',
  377.             'contao_install_redirect',
  378.         ];
  380.         if (\in_array($this->request->attributes->get('_route'), $installRoutes, true)) {
  381.             return;
  382.         }
  384.         if (!$this->getAdapter(Config::class)->isComplete()) {
  385.             throw new RedirectResponseException($this->urlGenerator->generate('contao_install', [], UrlGeneratorInterface::ABSOLUTE_URL));
  386.         }
  387.     }
  389.     private function setTimezone(): void
  390.     {
  391.         $config = $this->getAdapter(Config::class);
  393.         $this->iniSet('date.timezone', (string) $config->get('timeZone'));
  394.         date_default_timezone_set((string) $config->get('timeZone'));
  395.     }
  397.     private function triggerInitializeSystemHook(): void
  398.     {
  399.         if (
  400.             !empty($GLOBALS['TL_HOOKS']['initializeSystem'])
  401.             && \is_array($GLOBALS['TL_HOOKS']['initializeSystem'])
  402.             && is_dir(Path::join($this->projectDir, 'system/tmp'))
  403.         ) {
  404.             foreach ($GLOBALS['TL_HOOKS']['initializeSystem'] as $callback) {
  405.                 System::importStatic($callback[0])->{$callback[1]}();
  406.             }
  407.         }
  409.         if ($this->filesystem->exists($filePath = Path::join($this->projectDir, 'system/config/initconfig.php'))) {
  410.             trigger_deprecation('contao/core-bundle', '4.0', 'Using the "initconfig.php" file has been deprecated and will no longer work in Contao 5.0.');
  411.             include $filePath;
  412.         }
  413.     }
  415.     private function handleRequestToken(): void
  416.     {
  417.         $requestToken = $this->getAdapter(RequestToken::class);
  419.         // Deprecated since Contao 4.0, to be removed in Contao 5.0
  420.         if (!\defined('REQUEST_TOKEN')) {
  421.             \define('REQUEST_TOKEN', 'cli' === \PHP_SAPI ? null : $requestToken->get());
  422.         }
  423.     }
  425.     private function iniSet(string $key, string $value): void
  426.     {
  427.         if (\function_exists('ini_set')) {
  428.             ini_set($key, $value);
  429.         }
  430.     }
  432.     private function getSession(): ?SessionInterface
  433.     {
  434.         if (null === $this->request || !$this->request->hasSession()) {
  435.             return null;
  436.         }
  438.         return $this->request->getSession();
  439.     }
  441.     private function registerHookListeners(): void
  442.     {
  443.         foreach ($this->hookListeners as $hookName => $priorities) {
  444.             if (isset($GLOBALS['TL_HOOKS'][$hookName]) && \is_array($GLOBALS['TL_HOOKS'][$hookName])) {
  445.                 if (isset($priorities[0])) {
  446.                     $priorities[0] = array_merge($GLOBALS['TL_HOOKS'][$hookName], $priorities[0]);
  447.                 } else {
  448.                     $priorities[0] = $GLOBALS['TL_HOOKS'][$hookName];
  449.                     krsort($priorities);
  450.                 }
  451.             }
  453.             $GLOBALS['TL_HOOKS'][$hookName] = array_merge(...$priorities);
  454.         }
  455.     }
  457.     private function throwOnLegacyRoutingHooks(): void
  458.     {
  459.         if (empty($GLOBALS['TL_HOOKS']['getPageIdFromUrl']) && empty($GLOBALS['TL_HOOKS']['getRootPageFromUrl'])) {
  460.             return;
  461.         }
  463.         throw new LegacyRoutingException('Legacy routing is required to support the "getPageIdFromUrl" and "getRootPageFromUrl" hooks. Check the Symfony inspector for more information.');
  464.     }
  465. }