vendor/symfony/http-kernel/Kernel.php line 202

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\HttpKernel;
  14. use Symfony\Bridge\ProxyManager\LazyProxy\Instantiator\RuntimeInstantiator;
  15. use Symfony\Bridge\ProxyManager\LazyProxy\PhpDumper\ProxyDumper;
  16. use Symfony\Component\Config\Builder\ConfigBuilderGenerator;
  17. use Symfony\Component\Config\ConfigCache;
  18. use Symfony\Component\Config\Loader\DelegatingLoader;
  19. use Symfony\Component\Config\Loader\LoaderResolver;
  20. use Symfony\Component\Debug\DebugClassLoader as LegacyDebugClassLoader;
  21. use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
  22. use Symfony\Component\DependencyInjection\Compiler\PassConfig;
  23. use Symfony\Component\DependencyInjection\ContainerBuilder;
  24. use Symfony\Component\DependencyInjection\ContainerInterface;
  25. use Symfony\Component\DependencyInjection\Dumper\PhpDumper;
  26. use Symfony\Component\DependencyInjection\Dumper\Preloader;
  27. use Symfony\Component\DependencyInjection\Extension\ExtensionInterface;
  28. use Symfony\Component\DependencyInjection\Loader\ClosureLoader;
  29. use Symfony\Component\DependencyInjection\Loader\DirectoryLoader;
  30. use Symfony\Component\DependencyInjection\Loader\GlobFileLoader;
  31. use Symfony\Component\DependencyInjection\Loader\IniFileLoader;
  32. use Symfony\Component\DependencyInjection\Loader\PhpFileLoader;
  33. use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
  34. use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
  35. use Symfony\Component\ErrorHandler\DebugClassLoader;
  36. use Symfony\Component\Filesystem\Filesystem;
  37. use Symfony\Component\HttpFoundation\Request;
  38. use Symfony\Component\HttpFoundation\Response;
  39. use Symfony\Component\HttpKernel\Bundle\BundleInterface;
  40. use Symfony\Component\HttpKernel\CacheWarmer\WarmableInterface;
  41. use Symfony\Component\HttpKernel\Config\FileLocator;
  42. use Symfony\Component\HttpKernel\DependencyInjection\AddAnnotatedClassesToCachePass;
  43. use Symfony\Component\HttpKernel\DependencyInjection\MergeExtensionConfigurationPass;
  45. // Help opcache.preload discover always-needed symbols
  46. class_exists(ConfigCache::class);
  48. /**
  49.  * The Kernel is the heart of the Symfony system.
  50.  *
  51.  * It manages an environment made of bundles.
  52.  *
  53.  * Environment names must always start with a letter and
  54.  * they must only contain letters and numbers.
  55.  *
  56.  * @author Fabien Potencier <fabien@symfony.com>
  57.  */
  58. abstract class Kernel implements KernelInterface, RebootableInterface, TerminableInterface
  59. {
  60.     /**
  61.      * @var array<string, BundleInterface>
  62.      */
  63.     protected $bundles = [];
  65.     protected $container;
  66.     protected $environment;
  67.     protected $debug;
  68.     protected $booted = false;
  69.     protected $startTime;
  71.     private string $projectDir;
  72.     private ?string $warmupDir = null;
  73.     private int $requestStackSize = 0;
  74.     private bool $resetServices = false;
  76.     /**
  77.      * @var array<string, bool>
  78.      */
  79.     private static array $freshCache = [];
  81.     public const VERSION = '6.1.12';
  82.     public const VERSION_ID = 60112;
  83.     public const MAJOR_VERSION = 6;
  84.     public const MINOR_VERSION = 1;
  85.     public const RELEASE_VERSION = 12;
  86.     public const EXTRA_VERSION = '';
  88.     public const END_OF_MAINTENANCE = '01/2023';
  89.     public const END_OF_LIFE = '01/2023';
  91.     public function __construct(string $environment, bool $debug)
  92.     {
  93.         if (!$this->environment = $environment) {
  94.             throw new \InvalidArgumentException(sprintf('Invalid environment provided to "%s": the environment cannot be empty.', get_debug_type($this)));
  95.         }
  97.         $this->debug = $debug;
  98.     }
  100.     public function __clone()
  101.     {
  102.         $this->booted = false;
  103.         $this->container = null;
  104.         $this->requestStackSize = 0;
  105.         $this->resetServices = false;
  106.     }
  108.     /**
  109.      * {@inheritdoc}
  110.      */
  111.     public function boot()
  112.     {
  113.         if (true === $this->booted) {
  114.             if (!$this->requestStackSize && $this->resetServices) {
  115.                 if ($this->container->has('services_resetter')) {
  116.                     $this->container->get('services_resetter')->reset();
  117.                 }
  118.                 $this->resetServices = false;
  119.                 if ($this->debug) {
  120.                     $this->startTime = microtime(true);
  121.                 }
  122.             }
  124.             return;
  125.         }
  127.         if (null === $this->container) {
  128.             $this->preBoot();
  129.         }
  131.         foreach ($this->getBundles() as $bundle) {
  132.             $bundle->setContainer($this->container);
  133.             $bundle->boot();
  134.         }
  136.         $this->booted = true;
  137.     }
  139.     /**
  140.      * {@inheritdoc}
  141.      */
  142.     public function reboot(?string $warmupDir)
  143.     {
  144.         $this->shutdown();
  145.         $this->warmupDir = $warmupDir;
  146.         $this->boot();
  147.     }
  149.     /**
  150.      * {@inheritdoc}
  151.      */
  152.     public function terminate(Request $request, Response $response)
  153.     {
  154.         if (false === $this->booted) {
  155.             return;
  156.         }
  158.         if ($this->getHttpKernel() instanceof TerminableInterface) {
  159.             $this->getHttpKernel()->terminate($request, $response);
  160.         }
  161.     }
  163.     /**
  164.      * {@inheritdoc}
  165.      */
  166.     public function shutdown()
  167.     {
  168.         if (false === $this->booted) {
  169.             return;
  170.         }
  172.         $this->booted = false;
  174.         foreach ($this->getBundles() as $bundle) {
  175.             $bundle->shutdown();
  176.             $bundle->setContainer(null);
  177.         }
  179.         $this->container = null;
  180.         $this->requestStackSize = 0;
  181.         $this->resetServices = false;
  182.     }
  184.     /**
  185.      * {@inheritdoc}
  186.      */
  187.     public function handle(Request $request, int $type = HttpKernelInterface::MAIN_REQUEST, bool $catch = true): Response
  188.     {
  189.         if (!$this->booted) {
  190.             $container = $this->container ?? $this->preBoot();
  192.             if ($container->has('http_cache')) {
  193.                 return $container->get('http_cache')->handle($request, $type, $catch);
  194.             }
  195.         }
  197.         $this->boot();
  198.         ++$this->requestStackSize;
  199.         $this->resetServices = true;
  201.         try {
  202.             return $this->getHttpKernel()->handle($request, $type, $catch);
  203.         } finally {
  204.             --$this->requestStackSize;
  205.         }
  206.     }
  208.     /**
  209.      * Gets an HTTP kernel from the container.
  210.      */
  211.     protected function getHttpKernel(): HttpKernelInterface
  212.     {
  213.         return $this->container->get('http_kernel');
  214.     }
  216.     /**
  217.      * {@inheritdoc}
  218.      */
  219.     public function getBundles(): array
  220.     {
  221.         return $this->bundles;
  222.     }
  224.     /**
  225.      * {@inheritdoc}
  226.      */
  227.     public function getBundle(string $name): BundleInterface
  228.     {
  229.         if (!isset($this->bundles[$name])) {
  230.             throw new \InvalidArgumentException(sprintf('Bundle "%s" does not exist or it is not enabled. Maybe you forgot to add it in the "registerBundles()" method of your "%s.php" file?', $name, get_debug_type($this)));
  231.         }
  233.         return $this->bundles[$name];
  234.     }
  236.     /**
  237.      * {@inheritdoc}
  238.      */
  239.     public function locateResource(string $name): string
  240.     {
  241.         if ('@' !== $name[0]) {
  242.             throw new \InvalidArgumentException(sprintf('A resource name must start with @ ("%s" given).', $name));
  243.         }
  245.         if (str_contains($name, '..')) {
  246.             throw new \RuntimeException(sprintf('File name "%s" contains invalid characters (..).', $name));
  247.         }
  249.         $bundleName = substr($name, 1);
  250.         $path = '';
  251.         if (str_contains($bundleName, '/')) {
  252.             [$bundleName, $path] = explode('/', $bundleName, 2);
  253.         }
  255.         $bundle = $this->getBundle($bundleName);
  256.         if (file_exists($file = $bundle->getPath().'/'.$path)) {
  257.             return $file;
  258.         }
  260.         throw new \InvalidArgumentException(sprintf('Unable to find file "%s".', $name));
  261.     }
  263.     /**
  264.      * {@inheritdoc}
  265.      */
  266.     public function getEnvironment(): string
  267.     {
  268.         return $this->environment;
  269.     }
  271.     /**
  272.      * {@inheritdoc}
  273.      */
  274.     public function isDebug(): bool
  275.     {
  276.         return $this->debug;
  277.     }
  279.     /**
  280.      * Gets the application root dir (path of the project's composer file).
  281.      */
  282.     public function getProjectDir(): string
  283.     {
  284.         if (!isset($this->projectDir)) {
  285.             $r = new \ReflectionObject($this);
  287.             if (!is_file($dir = $r->getFileName())) {
  288.                 throw new \LogicException(sprintf('Cannot auto-detect project dir for kernel of class "%s".', $r->name));
  289.             }
  291.             $dir = $rootDir = \dirname($dir);
  292.             while (!is_file($dir.'/composer.json')) {
  293.                 if ($dir === \dirname($dir)) {
  294.                     return $this->projectDir = $rootDir;
  295.                 }
  296.                 $dir = \dirname($dir);
  297.             }
  298.             $this->projectDir = $dir;
  299.         }
  301.         return $this->projectDir;
  302.     }
  304.     /**
  305.      * {@inheritdoc}
  306.      */
  307.     public function getContainer(): ContainerInterface
  308.     {
  309.         if (!$this->container) {
  310.             throw new \LogicException('Cannot retrieve the container from a non-booted kernel.');
  311.         }
  313.         return $this->container;
  314.     }
  316.     /**
  317.      * @internal
  318.      */
  319.     public function setAnnotatedClassCache(array $annotatedClasses)
  320.     {
  321.         file_put_contents(($this->warmupDir ?: $this->getBuildDir()).'/annotations.map', sprintf('<?php return %s;', var_export($annotatedClasses, true)));
  322.     }
  324.     /**
  325.      * {@inheritdoc}
  326.      */
  327.     public function getStartTime(): float
  328.     {
  329.         return $this->debug && null !== $this->startTime ? $this->startTime : -\INF;
  330.     }
  332.     /**
  333.      * {@inheritdoc}
  334.      */
  335.     public function getCacheDir(): string
  336.     {
  337.         return $this->getProjectDir().'/var/cache/'.$this->environment;
  338.     }
  340.     /**
  341.      * {@inheritdoc}
  342.      */
  343.     public function getBuildDir(): string
  344.     {
  345.         // Returns $this->getCacheDir() for backward compatibility
  346.         return $this->getCacheDir();
  347.     }
  349.     /**
  350.      * {@inheritdoc}
  351.      */
  352.     public function getLogDir(): string
  353.     {
  354.         return $this->getProjectDir().'/var/log';
  355.     }
  357.     /**
  358.      * {@inheritdoc}
  359.      */
  360.     public function getCharset(): string
  361.     {
  362.         return 'UTF-8';
  363.     }
  365.     /**
  366.      * Gets the patterns defining the classes to parse and cache for annotations.
  367.      */
  368.     public function getAnnotatedClassesToCompile(): array
  369.     {
  370.         return [];
  371.     }
  373.     /**
  374.      * Initializes bundles.
  375.      *
  376.      * @throws \LogicException if two bundles share a common name
  377.      */
  378.     protected function initializeBundles()
  379.     {
  380.         // init bundles
  381.         $this->bundles = [];
  382.         foreach ($this->registerBundles() as $bundle) {
  383.             $name = $bundle->getName();
  384.             if (isset($this->bundles[$name])) {
  385.                 throw new \LogicException(sprintf('Trying to register two bundles with the same name "%s".', $name));
  386.             }
  387.             $this->bundles[$name] = $bundle;
  388.         }
  389.     }
  391.     /**
  392.      * The extension point similar to the Bundle::build() method.
  393.      *
  394.      * Use this method to register compiler passes and manipulate the container during the building process.
  395.      */
  396.     protected function build(ContainerBuilder $container)
  397.     {
  398.     }
  400.     /**
  401.      * Gets the container class.
  402.      *
  403.      * @throws \InvalidArgumentException If the generated classname is invalid
  404.      */
  405.     protected function getContainerClass(): string
  406.     {
  407.         $class = static::class;
  408.         $class = str_contains($class, "@anonymous\0") ? get_parent_class($class).str_replace('.', '_', ContainerBuilder::hash($class)) : $class;
  409.         $class = str_replace('\\', '_', $class).ucfirst($this->environment).($this->debug ? 'Debug' : '').'Container';
  411.         if (!preg_match('/^[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*$/', $class)) {
  412.             throw new \InvalidArgumentException(sprintf('The environment "%s" contains invalid characters, it can only contain characters allowed in PHP class names.', $this->environment));
  413.         }
  415.         return $class;
  416.     }
  418.     /**
  419.      * Gets the container's base class.
  420.      *
  421.      * All names except Container must be fully qualified.
  422.      */
  423.     protected function getContainerBaseClass(): string
  424.     {
  425.         return 'Container';
  426.     }
  428.     /**
  429.      * Initializes the service container.
  430.      *
  431.      * The built version of the service container is used when fresh, otherwise the
  432.      * container is built.
  433.      */
  434.     protected function initializeContainer()
  435.     {
  436.         $class = $this->getContainerClass();
  437.         $buildDir = $this->warmupDir ?: $this->getBuildDir();
  438.         $cache = new ConfigCache($buildDir.'/'.$class.'.php', $this->debug);
  439.         $cachePath = $cache->getPath();
  441.         // Silence E_WARNING to ignore "include" failures - don't use "@" to prevent silencing fatal errors
  442.         $errorLevel = error_reporting(\E_ALL ^ \E_WARNING);
  444.         try {
  445.             if (is_file($cachePath) && \is_object($this->container = include $cachePath)
  446.                 && (!$this->debug || (self::$freshCache[$cachePath] ?? $cache->isFresh()))
  447.             ) {
  448.                 self::$freshCache[$cachePath] = true;
  449.                 $this->container->set('kernel', $this);
  450.                 error_reporting($errorLevel);
  452.                 return;
  453.             }
  454.         } catch (\Throwable $e) {
  455.         }
  457.         $oldContainer = \is_object($this->container) ? new \ReflectionClass($this->container) : $this->container = null;
  459.         try {
  460.             is_dir($buildDir) ?: mkdir($buildDir, 0777, true);
  462.             if ($lock = fopen($cachePath.'.lock', 'w')) {
  463.                 if (!flock($lock, \LOCK_EX | \LOCK_NB, $wouldBlock) && !flock($lock, $wouldBlock ? \LOCK_SH : \LOCK_EX)) {
  464.                     fclose($lock);
  465.                     $lock = null;
  466.                 } elseif (!is_file($cachePath) || !\is_object($this->container = include $cachePath)) {
  467.                     $this->container = null;
  468.                 } elseif (!$oldContainer || \get_class($this->container) !== $oldContainer->name) {
  469.                     flock($lock, \LOCK_UN);
  470.                     fclose($lock);
  471.                     $this->container->set('kernel', $this);
  473.                     return;
  474.                 }
  475.             }
  476.         } catch (\Throwable $e) {
  477.         } finally {
  478.             error_reporting($errorLevel);
  479.         }
  481.         if ($collectDeprecations = $this->debug && !\defined('PHPUNIT_COMPOSER_INSTALL')) {
  482.             $collectedLogs = [];
  483.             $previousHandler = set_error_handler(function ($type, $message, $file, $line) use (&$collectedLogs, &$previousHandler) {
  484.                 if (\E_USER_DEPRECATED !== $type && \E_DEPRECATED !== $type) {
  485.                     return $previousHandler ? $previousHandler($type, $message, $file, $line) : false;
  486.                 }
  488.                 if (isset($collectedLogs[$message])) {
  489.                     ++$collectedLogs[$message]['count'];
  491.                     return null;
  492.                 }
  494.                 $backtrace = debug_backtrace(\DEBUG_BACKTRACE_IGNORE_ARGS, 5);
  495.                 // Clean the trace by removing first frames added by the error handler itself.
  496.                 for ($i = 0; isset($backtrace[$i]); ++$i) {
  497.                     if (isset($backtrace[$i]['file'], $backtrace[$i]['line']) && $backtrace[$i]['line'] === $line && $backtrace[$i]['file'] === $file) {
  498.                         $backtrace = \array_slice($backtrace, 1 + $i);
  499.                         break;
  500.                     }
  501.                 }
  502.                 for ($i = 0; isset($backtrace[$i]); ++$i) {
  503.                     if (!isset($backtrace[$i]['file'], $backtrace[$i]['line'], $backtrace[$i]['function'])) {
  504.                         continue;
  505.                     }
  506.                     if (!isset($backtrace[$i]['class']) && 'trigger_deprecation' === $backtrace[$i]['function']) {
  507.                         $file = $backtrace[$i]['file'];
  508.                         $line = $backtrace[$i]['line'];
  509.                         $backtrace = \array_slice($backtrace, 1 + $i);
  510.                         break;
  511.                     }
  512.                 }
  514.                 // Remove frames added by DebugClassLoader.
  515.                 for ($i = \count($backtrace) - 2; 0 < $i; --$i) {
  516.                     if (\in_array($backtrace[$i]['class'] ?? null, [DebugClassLoader::class, LegacyDebugClassLoader::class], true)) {
  517.                         $backtrace = [$backtrace[$i + 1]];
  518.                         break;
  519.                     }
  520.                 }
  522.                 $collectedLogs[$message] = [
  523.                     'type' => $type,
  524.                     'message' => $message,
  525.                     'file' => $file,
  526.                     'line' => $line,
  527.                     'trace' => [$backtrace[0]],
  528.                     'count' => 1,
  529.                 ];
  531.                 return null;
  532.             });
  533.         }
  535.         try {
  536.             $container = null;
  537.             $container = $this->buildContainer();
  538.             $container->compile();
  539.         } finally {
  540.             if ($collectDeprecations) {
  541.                 restore_error_handler();
  543.                 @file_put_contents($buildDir.'/'.$class.'Deprecations.log', serialize(array_values($collectedLogs)));
  544.                 @file_put_contents($buildDir.'/'.$class.'Compiler.log', null !== $container ? implode("\n", $container->getCompiler()->getLog()) : '');
  545.             }
  546.         }
  548.         $this->dumpContainer($cache, $container, $class, $this->getContainerBaseClass());
  550.         if ($lock) {
  551.             flock($lock, \LOCK_UN);
  552.             fclose($lock);
  553.         }
  555.         $this->container = require $cachePath;
  556.         $this->container->set('kernel', $this);
  558.         if ($oldContainer && \get_class($this->container) !== $oldContainer->name) {
  559.             // Because concurrent requests might still be using them,
  560.             // old container files are not removed immediately,
  561.             // but on a next dump of the container.
  562.             static $legacyContainers = [];
  563.             $oldContainerDir = \dirname($oldContainer->getFileName());
  564.             $legacyContainers[$oldContainerDir.'.legacy'] = true;
  565.             foreach (glob(\dirname($oldContainerDir).\DIRECTORY_SEPARATOR.'*.legacy', \GLOB_NOSORT) as $legacyContainer) {
  566.                 if (!isset($legacyContainers[$legacyContainer]) && @unlink($legacyContainer)) {
  567.                     (new Filesystem())->remove(substr($legacyContainer, 0, -7));
  568.                 }
  569.             }
  571.             touch($oldContainerDir.'.legacy');
  572.         }
  574.         $preload = $this instanceof WarmableInterface ? (array) $this->warmUp($this->container->getParameter('kernel.cache_dir')) : [];
  576.         if ($this->container->has('cache_warmer')) {
  577.             $preload = array_merge($preload, (array) $this->container->get('cache_warmer')->warmUp($this->container->getParameter('kernel.cache_dir')));
  578.         }
  580.         if ($preload && method_exists(Preloader::class, 'append') && file_exists($preloadFile = $buildDir.'/'.$class.'.preload.php')) {
  581.             Preloader::append($preloadFile, $preload);
  582.         }
  583.     }
  585.     /**
  586.      * Returns the kernel parameters.
  587.      */
  588.     protected function getKernelParameters(): array
  589.     {
  590.         $bundles = [];
  591.         $bundlesMetadata = [];
  593.         foreach ($this->bundles as $name => $bundle) {
  594.             $bundles[$name] = \get_class($bundle);
  595.             $bundlesMetadata[$name] = [
  596.                 'path' => $bundle->getPath(),
  597.                 'namespace' => $bundle->getNamespace(),
  598.             ];
  599.         }
  601.         return [
  602.             'kernel.project_dir' => realpath($this->getProjectDir()) ?: $this->getProjectDir(),
  603.             'kernel.environment' => $this->environment,
  604.             'kernel.runtime_environment' => '%env(default:kernel.environment:APP_RUNTIME_ENV)%',
  605.             'kernel.debug' => $this->debug,
  606.             'kernel.build_dir' => realpath($buildDir = $this->warmupDir ?: $this->getBuildDir()) ?: $buildDir,
  607.             'kernel.cache_dir' => realpath($cacheDir = ($this->getCacheDir() === $this->getBuildDir() ? ($this->warmupDir ?: $this->getCacheDir()) : $this->getCacheDir())) ?: $cacheDir,
  608.             'kernel.logs_dir' => realpath($this->getLogDir()) ?: $this->getLogDir(),
  609.             'kernel.bundles' => $bundles,
  610.             'kernel.bundles_metadata' => $bundlesMetadata,
  611.             'kernel.charset' => $this->getCharset(),
  612.             'kernel.container_class' => $this->getContainerClass(),
  613.         ];
  614.     }
  616.     /**
  617.      * Builds the service container.
  618.      *
  619.      * @throws \RuntimeException
  620.      */
  621.     protected function buildContainer(): ContainerBuilder
  622.     {
  623.         foreach (['cache' => $this->getCacheDir(), 'build' => $this->warmupDir ?: $this->getBuildDir(), 'logs' => $this->getLogDir()] as $name => $dir) {
  624.             if (!is_dir($dir)) {
  625.                 if (false === @mkdir($dir, 0777, true) && !is_dir($dir)) {
  626.                     throw new \RuntimeException(sprintf('Unable to create the "%s" directory (%s).', $name, $dir));
  627.                 }
  628.             } elseif (!is_writable($dir)) {
  629.                 throw new \RuntimeException(sprintf('Unable to write in the "%s" directory (%s).', $name, $dir));
  630.             }
  631.         }
  633.         $container = $this->getContainerBuilder();
  634.         $container->addObjectResource($this);
  635.         $this->prepareContainer($container);
  636.         $this->registerContainerConfiguration($this->getContainerLoader($container));
  638.         $container->addCompilerPass(new AddAnnotatedClassesToCachePass($this));
  640.         return $container;
  641.     }
  643.     /**
  644.      * Prepares the ContainerBuilder before it is compiled.
  645.      */
  646.     protected function prepareContainer(ContainerBuilder $container)
  647.     {
  648.         $extensions = [];
  649.         foreach ($this->bundles as $bundle) {
  650.             if ($extension = $bundle->getContainerExtension()) {
  651.                 $container->registerExtension($extension);
  652.             }
  654.             if ($this->debug) {
  655.                 $container->addObjectResource($bundle);
  656.             }
  657.         }
  659.         foreach ($this->bundles as $bundle) {
  660.             $bundle->build($container);
  661.         }
  663.         $this->build($container);
  665.         foreach ($container->getExtensions() as $extension) {
  666.             $extensions[] = $extension->getAlias();
  667.         }
  669.         // ensure these extensions are implicitly loaded
  670.         $container->getCompilerPassConfig()->setMergePass(new MergeExtensionConfigurationPass($extensions));
  671.     }
  673.     /**
  674.      * Gets a new ContainerBuilder instance used to build the service container.
  675.      */
  676.     protected function getContainerBuilder(): ContainerBuilder
  677.     {
  678.         $container = new ContainerBuilder();
  679.         $container->getParameterBag()->add($this->getKernelParameters());
  681.         if ($this instanceof ExtensionInterface) {
  682.             $container->registerExtension($this);
  683.         }
  684.         if ($this instanceof CompilerPassInterface) {
  685.             $container->addCompilerPass($this, PassConfig::TYPE_BEFORE_OPTIMIZATION, -10000);
  686.         }
  687.         if (class_exists(\ProxyManager\Configuration::class) && class_exists(RuntimeInstantiator::class)) {
  688.             $container->setProxyInstantiator(new RuntimeInstantiator());
  689.         }
  691.         return $container;
  692.     }
  694.     /**
  695.      * Dumps the service container to PHP code in the cache.
  696.      *
  697.      * @param string $class     The name of the class to generate
  698.      * @param string $baseClass The name of the container's base class
  699.      */
  700.     protected function dumpContainer(ConfigCache $cache, ContainerBuilder $container, string $class, string $baseClass)
  701.     {
  702.         // cache the container
  703.         $dumper = new PhpDumper($container);
  705.         if (class_exists(\ProxyManager\Configuration::class) && class_exists(ProxyDumper::class)) {
  706.             $dumper->setProxyDumper(new ProxyDumper());
  707.         }
  709.         $content = $dumper->dump([
  710.             'class' => $class,
  711.             'base_class' => $baseClass,
  712.             'file' => $cache->getPath(),
  713.             'as_files' => true,
  714.             'debug' => $this->debug,
  715.             'build_time' => $container->hasParameter('kernel.container_build_time') ? $container->getParameter('kernel.container_build_time') : time(),
  716.             'preload_classes' => array_map('get_class', $this->bundles),
  717.         ]);
  719.         $rootCode = array_pop($content);
  720.         $dir = \dirname($cache->getPath()).'/';
  721.         $fs = new Filesystem();
  723.         foreach ($content as $file => $code) {
  724.             $fs->dumpFile($dir.$file, $code);
  725.             @chmod($dir.$file, 0666 & ~umask());
  726.         }
  727.         $legacyFile = \dirname($dir.key($content)).'.legacy';
  728.         if (is_file($legacyFile)) {
  729.             @unlink($legacyFile);
  730.         }
  732.         $cache->write($rootCode, $container->getResources());
  733.     }
  735.     /**
  736.      * Returns a loader for the container.
  737.      */
  738.     protected function getContainerLoader(ContainerInterface $container): DelegatingLoader
  739.     {
  740.         $env = $this->getEnvironment();
  741.         $locator = new FileLocator($this);
  742.         $resolver = new LoaderResolver([
  743.             new XmlFileLoader($container, $locator, $env),
  744.             new YamlFileLoader($container, $locator, $env),
  745.             new IniFileLoader($container, $locator, $env),
  746.             new PhpFileLoader($container, $locator, $env, class_exists(ConfigBuilderGenerator::class) ? new ConfigBuilderGenerator($this->getBuildDir()) : null),
  747.             new GlobFileLoader($container, $locator, $env),
  748.             new DirectoryLoader($container, $locator, $env),
  749.             new ClosureLoader($container, $env),
  750.         ]);
  752.         return new DelegatingLoader($resolver);
  753.     }
  755.     private function preBoot(): ContainerInterface
  756.     {
  757.         if ($this->debug) {
  758.             $this->startTime = microtime(true);
  759.         }
  760.         if ($this->debug && !isset($_ENV['SHELL_VERBOSITY']) && !isset($_SERVER['SHELL_VERBOSITY'])) {
  761.             putenv('SHELL_VERBOSITY=3');
  762.             $_ENV['SHELL_VERBOSITY'] = 3;
  763.             $_SERVER['SHELL_VERBOSITY'] = 3;
  764.         }
  766.         $this->initializeBundles();
  767.         $this->initializeContainer();
  769.         $container = $this->container;
  771.         if ($container->hasParameter('kernel.trusted_hosts') && $trustedHosts = $container->getParameter('kernel.trusted_hosts')) {
  772.             Request::setTrustedHosts($trustedHosts);
  773.         }
  775.         if ($container->hasParameter('kernel.trusted_proxies') && $container->hasParameter('kernel.trusted_headers') && $trustedProxies = $container->getParameter('kernel.trusted_proxies')) {
  776.             Request::setTrustedProxies(\is_array($trustedProxies) ? $trustedProxies : array_map('trim', explode(',', $trustedProxies)), $container->getParameter('kernel.trusted_headers'));
  777.         }
  779.         return $container;
  780.     }
  782.     /**
  783.      * Removes comments from a PHP source string.
  784.      *
  785.      * We don't use the PHP php_strip_whitespace() function
  786.      * as we want the content to be readable and well-formatted.
  787.      */
  788.     public static function stripComments(string $source): string
  789.     {
  790.         if (!\function_exists('token_get_all')) {
  791.             return $source;
  792.         }
  794.         $rawChunk = '';
  795.         $output = '';
  796.         $tokens = token_get_all($source);
  797.         $ignoreSpace = false;
  798.         for ($i = 0; isset($tokens[$i]); ++$i) {
  799.             $token = $tokens[$i];
  800.             if (!isset($token[1]) || 'b"' === $token) {
  801.                 $rawChunk .= $token;
  802.             } elseif (\T_START_HEREDOC === $token[0]) {
  803.                 $output .= $rawChunk.$token[1];
  804.                 do {
  805.                     $token = $tokens[++$i];
  806.                     $output .= isset($token[1]) && 'b"' !== $token ? $token[1] : $token;
  807.                 } while (\T_END_HEREDOC !== $token[0]);
  808.                 $rawChunk = '';
  809.             } elseif (\T_WHITESPACE === $token[0]) {
  810.                 if ($ignoreSpace) {
  811.                     $ignoreSpace = false;
  813.                     continue;
  814.                 }
  816.                 // replace multiple new lines with a single newline
  817.                 $rawChunk .= preg_replace(['/\n{2,}/S'], "\n", $token[1]);
  818.             } elseif (\in_array($token[0], [\T_COMMENT, \T_DOC_COMMENT])) {
  819.                 if (!\in_array($rawChunk[\strlen($rawChunk) - 1], [' ', "\n", "\r", "\t"], true)) {
  820.                     $rawChunk .= ' ';
  821.                 }
  822.                 $ignoreSpace = true;
  823.             } else {
  824.                 $rawChunk .= $token[1];
  826.                 // The PHP-open tag already has a new-line
  827.                 if (\T_OPEN_TAG === $token[0]) {
  828.                     $ignoreSpace = true;
  829.                 } else {
  830.                     $ignoreSpace = false;
  831.                 }
  832.             }
  833.         }
  835.         $output .= $rawChunk;
  837.         unset($tokens, $rawChunk);
  838.         gc_mem_caches();
  840.         return $output;
  841.     }
  843.     public function __sleep(): array
  844.     {
  845.         return ['environment', 'debug'];
  846.     }
  848.     public function __wakeup()
  849.     {
  850.         if (\is_object($this->environment) || \is_object($this->debug)) {
  851.             throw new \BadMethodCallException('Cannot unserialize '.__CLASS__);
  852.         }
  854.         $this->__construct($this->environment, $this->debug);
  855.     }
  856. }