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

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\ConfigCache;
  17. use Symfony\Component\Config\Loader\DelegatingLoader;
  18. use Symfony\Component\Config\Loader\LoaderResolver;
  19. use Symfony\Component\Debug\DebugClassLoader as LegacyDebugClassLoader;
  20. use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
  21. use Symfony\Component\DependencyInjection\Compiler\PassConfig;
  22. use Symfony\Component\DependencyInjection\ContainerBuilder;
  23. use Symfony\Component\DependencyInjection\ContainerInterface;
  24. use Symfony\Component\DependencyInjection\Dumper\PhpDumper;
  25. use Symfony\Component\DependencyInjection\Loader\ClosureLoader;
  26. use Symfony\Component\DependencyInjection\Loader\DirectoryLoader;
  27. use Symfony\Component\DependencyInjection\Loader\GlobFileLoader;
  28. use Symfony\Component\DependencyInjection\Loader\IniFileLoader;
  29. use Symfony\Component\DependencyInjection\Loader\PhpFileLoader;
  30. use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
  31. use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
  32. use Symfony\Component\ErrorHandler\DebugClassLoader;
  33. use Symfony\Component\Filesystem\Filesystem;
  34. use Symfony\Component\HttpFoundation\Request;
  35. use Symfony\Component\HttpFoundation\Response;
  36. use Symfony\Component\HttpKernel\Bundle\BundleInterface;
  37. use Symfony\Component\HttpKernel\Config\FileLocator;
  38. use Symfony\Component\HttpKernel\DependencyInjection\AddAnnotatedClassesToCachePass;
  39. use Symfony\Component\HttpKernel\DependencyInjection\MergeExtensionConfigurationPass;
  41. /**
  42.  * The Kernel is the heart of the Symfony system.
  43.  *
  44.  * It manages an environment made of bundles.
  45.  *
  46.  * Environment names must always start with a letter and
  47.  * they must only contain letters and numbers.
  48.  *
  49.  * @author Fabien Potencier <fabien@symfony.com>
  50.  */
  51. abstract class Kernel implements KernelInterface, RebootableInterface, TerminableInterface
  52. {
  53.     /**
  54.      * @var BundleInterface[]
  55.      */
  56.     protected $bundles = [];
  58.     protected $container;
  59.     /**
  60.      * @deprecated since Symfony 4.2
  61.      */
  62.     protected $rootDir;
  63.     protected $environment;
  64.     protected $debug;
  65.     protected $booted = false;
  66.     /**
  67.      * @deprecated since Symfony 4.2
  68.      */
  69.     protected $name;
  70.     protected $startTime;
  72.     private $projectDir;
  73.     private $warmupDir;
  74.     private $requestStackSize = 0;
  75.     private $resetServices = false;
  77.     private static $freshCache = [];
  79.     public const VERSION = '4.4.43';
  80.     public const VERSION_ID = 40443;
  81.     public const MAJOR_VERSION = 4;
  82.     public const MINOR_VERSION = 4;
  83.     public const RELEASE_VERSION = 43;
  84.     public const EXTRA_VERSION = '';
  86.     public const END_OF_MAINTENANCE = '11/2022';
  87.     public const END_OF_LIFE = '11/2023';
  89.     public function __construct(string $environment, bool $debug)
  90.     {
  91.         $this->environment = $environment;
  92.         $this->debug = $debug;
  93.         $this->rootDir = $this->getRootDir(false);
  94.         $this->name = $this->getName(false);
  95.     }
  97.     public function __clone()
  98.     {
  99.         $this->booted = false;
  100.         $this->container = null;
  101.         $this->requestStackSize = 0;
  102.         $this->resetServices = false;
  103.     }
  105.     /**
  106.      * {@inheritdoc}
  107.      */
  108.     public function boot()
  109.     {
  110.         if (true === $this->booted) {
  111.             if (!$this->requestStackSize && $this->resetServices) {
  112.                 if ($this->container->has('services_resetter')) {
  113.                     $this->container->get('services_resetter')->reset();
  114.                 }
  115.                 $this->resetServices = false;
  116.                 if ($this->debug) {
  117.                     $this->startTime = microtime(true);
  118.                 }
  119.             }
  121.             return;
  122.         }
  123.         if ($this->debug) {
  124.             $this->startTime = microtime(true);
  125.         }
  126.         if ($this->debug && !isset($_ENV['SHELL_VERBOSITY']) && !isset($_SERVER['SHELL_VERBOSITY'])) {
  127.             putenv('SHELL_VERBOSITY=3');
  128.             $_ENV['SHELL_VERBOSITY'] = 3;
  129.             $_SERVER['SHELL_VERBOSITY'] = 3;
  130.         }
  132.         // init bundles
  133.         $this->initializeBundles();
  135.         // init container
  136.         $this->initializeContainer();
  138.         foreach ($this->getBundles() as $bundle) {
  139.             $bundle->setContainer($this->container);
  140.             $bundle->boot();
  141.         }
  143.         $this->booted = true;
  144.     }
  146.     /**
  147.      * {@inheritdoc}
  148.      */
  149.     public function reboot($warmupDir)
  150.     {
  151.         $this->shutdown();
  152.         $this->warmupDir = $warmupDir;
  153.         $this->boot();
  154.     }
  156.     /**
  157.      * {@inheritdoc}
  158.      */
  159.     public function terminate(Request $request, Response $response)
  160.     {
  161.         if (false === $this->booted) {
  162.             return;
  163.         }
  165.         if ($this->getHttpKernel() instanceof TerminableInterface) {
  166.             $this->getHttpKernel()->terminate($request, $response);
  167.         }
  168.     }
  170.     /**
  171.      * {@inheritdoc}
  172.      */
  173.     public function shutdown()
  174.     {
  175.         if (false === $this->booted) {
  176.             return;
  177.         }
  179.         $this->booted = false;
  181.         foreach ($this->getBundles() as $bundle) {
  182.             $bundle->shutdown();
  183.             $bundle->setContainer(null);
  184.         }
  186.         $this->container = null;
  187.         $this->requestStackSize = 0;
  188.         $this->resetServices = false;
  189.     }
  191.     /**
  192.      * {@inheritdoc}
  193.      */
  194.     public function handle(Request $request, $type = HttpKernelInterface::MASTER_REQUEST, $catch = true)
  195.     {
  196.         $this->boot();
  197.         ++$this->requestStackSize;
  198.         $this->resetServices = true;
  200.         try {
  201.             return $this->getHttpKernel()->handle($request, $type, $catch);
  202.         } finally {
  203.             --$this->requestStackSize;
  204.         }
  205.     }
  207.     /**
  208.      * Gets an HTTP kernel from the container.
  209.      *
  210.      * @return HttpKernelInterface
  211.      */
  212.     protected function getHttpKernel()
  213.     {
  214.         return $this->container->get('http_kernel');
  215.     }
  217.     /**
  218.      * {@inheritdoc}
  219.      */
  220.     public function getBundles()
  221.     {
  222.         return $this->bundles;
  223.     }
  225.     /**
  226.      * {@inheritdoc}
  227.      */
  228.     public function getBundle($name)
  229.     {
  230.         if (!isset($this->bundles[$name])) {
  231.             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)));
  232.         }
  234.         return $this->bundles[$name];
  235.     }
  237.     /**
  238.      * {@inheritdoc}
  239.      */
  240.     public function locateResource($name/*, $dir = null, $first = true, $triggerDeprecation = true*/)
  241.     {
  242.         if (2 <= \func_num_args()) {
  243.             $dir = func_get_arg(1);
  244.             $first = 3 <= \func_num_args() ? func_get_arg(2) : true;
  246.             if (4 !== \func_num_args() || func_get_arg(3)) {
  247.                 @trigger_error(sprintf('Passing more than one argument to %s is deprecated since Symfony 4.4 and will be removed in 5.0.', __METHOD__), \E_USER_DEPRECATED);
  248.             }
  249.         } else {
  250.             $dir = null;
  251.             $first = true;
  252.         }
  254.         if ('@' !== $name[0]) {
  255.             throw new \InvalidArgumentException(sprintf('A resource name must start with @ ("%s" given).', $name));
  256.         }
  258.         if (str_contains($name, '..')) {
  259.             throw new \RuntimeException(sprintf('File name "%s" contains invalid characters (..).', $name));
  260.         }
  262.         $bundleName = substr($name, 1);
  263.         $path = '';
  264.         if (str_contains($bundleName, '/')) {
  265.             [$bundleName, $path] = explode('/', $bundleName, 2);
  266.         }
  268.         $isResource = str_starts_with($path, 'Resources') && null !== $dir;
  269.         $overridePath = substr($path, 9);
  270.         $bundle = $this->getBundle($bundleName);
  271.         $files = [];
  273.         if ($isResource && file_exists($file = $dir.'/'.$bundle->getName().$overridePath)) {
  274.             $files[] = $file;
  276.             // see https://symfony.com/doc/current/bundles/override.html on how to overwrite parts of a bundle
  277.             @trigger_error(sprintf('Overwriting the resource "%s" with "%s" is deprecated since Symfony 4.4 and will be removed in 5.0.', $name, $file), \E_USER_DEPRECATED);
  278.         }
  280.         if (file_exists($file = $bundle->getPath().'/'.$path)) {
  281.             if ($first && !$isResource) {
  282.                 return $file;
  283.             }
  284.             $files[] = $file;
  285.         }
  287.         if (\count($files) > 0) {
  288.             return $first && $isResource ? $files[0] : $files;
  289.         }
  291.         throw new \InvalidArgumentException(sprintf('Unable to find file "%s".', $name));
  292.     }
  294.     /**
  295.      * {@inheritdoc}
  296.      *
  297.      * @deprecated since Symfony 4.2
  298.      */
  299.     public function getName(/* $triggerDeprecation = true */)
  300.     {
  301.         if (0 === \func_num_args() || func_get_arg(0)) {
  302.             @trigger_error(sprintf('The "%s()" method is deprecated since Symfony 4.2.', __METHOD__), \E_USER_DEPRECATED);
  303.         }
  305.         if (null === $this->name) {
  306.             $this->name = preg_replace('/[^a-zA-Z0-9_]+/', '', basename($this->rootDir));
  307.             if (ctype_digit($this->name[0])) {
  308.                 $this->name = '_'.$this->name;
  309.             }
  310.         }
  312.         return $this->name;
  313.     }
  315.     /**
  316.      * {@inheritdoc}
  317.      */
  318.     public function getEnvironment()
  319.     {
  320.         return $this->environment;
  321.     }
  323.     /**
  324.      * {@inheritdoc}
  325.      */
  326.     public function isDebug()
  327.     {
  328.         return $this->debug;
  329.     }
  331.     /**
  332.      * {@inheritdoc}
  333.      *
  334.      * @deprecated since Symfony 4.2, use getProjectDir() instead
  335.      */
  336.     public function getRootDir(/* $triggerDeprecation = true */)
  337.     {
  338.         if (0 === \func_num_args() || func_get_arg(0)) {
  339.             @trigger_error(sprintf('The "%s()" method is deprecated since Symfony 4.2, use getProjectDir() instead.', __METHOD__), \E_USER_DEPRECATED);
  340.         }
  342.         if (null === $this->rootDir) {
  343.             $r = new \ReflectionObject($this);
  344.             $this->rootDir = \dirname($r->getFileName());
  345.         }
  347.         return $this->rootDir;
  348.     }
  350.     /**
  351.      * Gets the application root dir (path of the project's composer file).
  352.      *
  353.      * @return string The project root dir
  354.      */
  355.     public function getProjectDir()
  356.     {
  357.         if (null === $this->projectDir) {
  358.             $r = new \ReflectionObject($this);
  360.             if (!file_exists($dir = $r->getFileName())) {
  361.                 throw new \LogicException(sprintf('Cannot auto-detect project dir for kernel of class "%s".', $r->name));
  362.             }
  364.             $dir = $rootDir = \dirname($dir);
  365.             while (!file_exists($dir.'/composer.json')) {
  366.                 if ($dir === \dirname($dir)) {
  367.                     return $this->projectDir = $rootDir;
  368.                 }
  369.                 $dir = \dirname($dir);
  370.             }
  371.             $this->projectDir = $dir;
  372.         }
  374.         return $this->projectDir;
  375.     }
  377.     /**
  378.      * {@inheritdoc}
  379.      */
  380.     public function getContainer()
  381.     {
  382.         if (!$this->container) {
  383.             @trigger_error('Getting the container from a non-booted kernel is deprecated since Symfony 4.4.', \E_USER_DEPRECATED);
  384.         }
  386.         return $this->container;
  387.     }
  389.     /**
  390.      * @internal
  391.      */
  392.     public function setAnnotatedClassCache(array $annotatedClasses)
  393.     {
  394.         file_put_contents(($this->warmupDir ?: $this->getCacheDir()).'/annotations.map', sprintf('<?php return %s;', var_export($annotatedClasses, true)));
  395.     }
  397.     /**
  398.      * {@inheritdoc}
  399.      */
  400.     public function getStartTime()
  401.     {
  402.         return $this->debug && null !== $this->startTime ? $this->startTime : -\INF;
  403.     }
  405.     /**
  406.      * {@inheritdoc}
  407.      */
  408.     public function getCacheDir()
  409.     {
  410.         return $this->getProjectDir().'/var/cache/'.$this->environment;
  411.     }
  413.     /**
  414.      * {@inheritdoc}
  415.      */
  416.     public function getLogDir()
  417.     {
  418.         return $this->getProjectDir().'/var/log';
  419.     }
  421.     /**
  422.      * {@inheritdoc}
  423.      */
  424.     public function getCharset()
  425.     {
  426.         return 'UTF-8';
  427.     }
  429.     /**
  430.      * Gets the patterns defining the classes to parse and cache for annotations.
  431.      */
  432.     public function getAnnotatedClassesToCompile(): array
  433.     {
  434.         return [];
  435.     }
  437.     /**
  438.      * Initializes bundles.
  439.      *
  440.      * @throws \LogicException if two bundles share a common name
  441.      */
  442.     protected function initializeBundles()
  443.     {
  444.         // init bundles
  445.         $this->bundles = [];
  446.         foreach ($this->registerBundles() as $bundle) {
  447.             $name = $bundle->getName();
  448.             if (isset($this->bundles[$name])) {
  449.                 throw new \LogicException(sprintf('Trying to register two bundles with the same name "%s".', $name));
  450.             }
  451.             $this->bundles[$name] = $bundle;
  452.         }
  453.     }
  455.     /**
  456.      * The extension point similar to the Bundle::build() method.
  457.      *
  458.      * Use this method to register compiler passes and manipulate the container during the building process.
  459.      */
  460.     protected function build(ContainerBuilder $container)
  461.     {
  462.     }
  464.     /**
  465.      * Gets the container class.
  466.      *
  467.      * @throws \InvalidArgumentException If the generated classname is invalid
  468.      *
  469.      * @return string The container class
  470.      */
  471.     protected function getContainerClass()
  472.     {
  473.         $class = static::class;
  474.         $class = str_contains($class, "@anonymous\0") ? get_parent_class($class).str_replace('.', '_', ContainerBuilder::hash($class)) : $class;
  475.         $class = $this->name.str_replace('\\', '_', $class).ucfirst($this->environment).($this->debug ? 'Debug' : '').'Container';
  477.         if (!preg_match('/^[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*$/', $class)) {
  478.             throw new \InvalidArgumentException(sprintf('The environment "%s" contains invalid characters, it can only contain characters allowed in PHP class names.', $this->environment));
  479.         }
  481.         return $class;
  482.     }
  484.     /**
  485.      * Gets the container's base class.
  486.      *
  487.      * All names except Container must be fully qualified.
  488.      *
  489.      * @return string
  490.      */
  491.     protected function getContainerBaseClass()
  492.     {
  493.         return 'Container';
  494.     }
  496.     /**
  497.      * Initializes the service container.
  498.      *
  499.      * The cached version of the service container is used when fresh, otherwise the
  500.      * container is built.
  501.      */
  502.     protected function initializeContainer()
  503.     {
  504.         $class = $this->getContainerClass();
  505.         $cacheDir = $this->warmupDir ?: $this->getCacheDir();
  506.         $cache = new ConfigCache($cacheDir.'/'.$class.'.php', $this->debug);
  507.         $cachePath = $cache->getPath();
  509.         // Silence E_WARNING to ignore "include" failures - don't use "@" to prevent silencing fatal errors
  510.         $errorLevel = error_reporting(\E_ALL ^ \E_WARNING);
  512.         try {
  513.             if (file_exists($cachePath) && \is_object($this->container = include $cachePath)
  514.                 && (!$this->debug || (self::$freshCache[$cachePath] ?? $cache->isFresh()))
  515.             ) {
  516.                 self::$freshCache[$cachePath] = true;
  517.                 $this->container->set('kernel', $this);
  518.                 error_reporting($errorLevel);
  520.                 return;
  521.             }
  522.         } catch (\Throwable $e) {
  523.         }
  525.         $oldContainer = \is_object($this->container) ? new \ReflectionClass($this->container) : $this->container = null;
  527.         try {
  528.             is_dir($cacheDir) ?: mkdir($cacheDir, 0777, true);
  530.             if ($lock = fopen($cachePath.'.lock', 'w')) {
  531.                 if (!flock($lock, \LOCK_EX | \LOCK_NB, $wouldBlock) && !flock($lock, $wouldBlock ? \LOCK_SH : \LOCK_EX)) {
  532.                     fclose($lock);
  533.                     $lock = null;
  534.                 } elseif (!is_file($cachePath) || !\is_object($this->container = include $cachePath)) {
  535.                     $this->container = null;
  536.                 } elseif (!$oldContainer || \get_class($this->container) !== $oldContainer->name) {
  537.                     flock($lock, \LOCK_UN);
  538.                     fclose($lock);
  539.                     $this->container->set('kernel', $this);
  541.                     return;
  542.                 }
  543.             }
  544.         } catch (\Throwable $e) {
  545.         } finally {
  546.             error_reporting($errorLevel);
  547.         }
  549.         if ($collectDeprecations = $this->debug && !\defined('PHPUNIT_COMPOSER_INSTALL')) {
  550.             $collectedLogs = [];
  551.             $previousHandler = set_error_handler(function ($type, $message, $file, $line) use (&$collectedLogs, &$previousHandler) {
  552.                 if (\E_USER_DEPRECATED !== $type && \E_DEPRECATED !== $type) {
  553.                     return $previousHandler ? $previousHandler($type, $message, $file, $line) : false;
  554.                 }
  556.                 if (isset($collectedLogs[$message])) {
  557.                     ++$collectedLogs[$message]['count'];
  559.                     return null;
  560.                 }
  562.                 $backtrace = debug_backtrace(\DEBUG_BACKTRACE_IGNORE_ARGS, 5);
  563.                 // Clean the trace by removing first frames added by the error handler itself.
  564.                 for ($i = 0; isset($backtrace[$i]); ++$i) {
  565.                     if (isset($backtrace[$i]['file'], $backtrace[$i]['line']) && $backtrace[$i]['line'] === $line && $backtrace[$i]['file'] === $file) {
  566.                         $backtrace = \array_slice($backtrace, 1 + $i);
  567.                         break;
  568.                     }
  569.                 }
  570.                 // Remove frames added by DebugClassLoader.
  571.                 for ($i = \count($backtrace) - 2; 0 < $i; --$i) {
  572.                     if (\in_array($backtrace[$i]['class'] ?? null, [DebugClassLoader::class, LegacyDebugClassLoader::class], true)) {
  573.                         $backtrace = [$backtrace[$i + 1]];
  574.                         break;
  575.                     }
  576.                 }
  578.                 $collectedLogs[$message] = [
  579.                     'type' => $type,
  580.                     'message' => $message,
  581.                     'file' => $file,
  582.                     'line' => $line,
  583.                     'trace' => [$backtrace[0]],
  584.                     'count' => 1,
  585.                 ];
  587.                 return null;
  588.             });
  589.         }
  591.         try {
  592.             $container = null;
  593.             $container = $this->buildContainer();
  594.             $container->compile();
  595.         } finally {
  596.             if ($collectDeprecations) {
  597.                 restore_error_handler();
  599.                 @file_put_contents($cacheDir.'/'.$class.'Deprecations.log', serialize(array_values($collectedLogs)));
  600.                 @file_put_contents($cacheDir.'/'.$class.'Compiler.log', null !== $container ? implode("\n", $container->getCompiler()->getLog()) : '');
  601.             }
  602.         }
  604.         $this->dumpContainer($cache, $container, $class, $this->getContainerBaseClass());
  606.         if ($lock) {
  607.             flock($lock, \LOCK_UN);
  608.             fclose($lock);
  609.         }
  611.         $this->container = require $cachePath;
  612.         $this->container->set('kernel', $this);
  614.         if ($oldContainer && \get_class($this->container) !== $oldContainer->name) {
  615.             // Because concurrent requests might still be using them,
  616.             // old container files are not removed immediately,
  617.             // but on a next dump of the container.
  618.             static $legacyContainers = [];
  619.             $oldContainerDir = \dirname($oldContainer->getFileName());
  620.             $legacyContainers[$oldContainerDir.'.legacy'] = true;
  621.             foreach (glob(\dirname($oldContainerDir).\DIRECTORY_SEPARATOR.'*.legacy', \GLOB_NOSORT) as $legacyContainer) {
  622.                 if (!isset($legacyContainers[$legacyContainer]) && @unlink($legacyContainer)) {
  623.                     (new Filesystem())->remove(substr($legacyContainer, 0, -7));
  624.                 }
  625.             }
  627.             touch($oldContainerDir.'.legacy');
  628.         }
  630.         if ($this->container->has('cache_warmer')) {
  631.             $this->container->get('cache_warmer')->warmUp($this->container->getParameter('kernel.cache_dir'));
  632.         }
  633.     }
  635.     /**
  636.      * Returns the kernel parameters.
  637.      *
  638.      * @return array An array of kernel parameters
  639.      */
  640.     protected function getKernelParameters()
  641.     {
  642.         $bundles = [];
  643.         $bundlesMetadata = [];
  645.         foreach ($this->bundles as $name => $bundle) {
  646.             $bundles[$name] = \get_class($bundle);
  647.             $bundlesMetadata[$name] = [
  648.                 'path' => $bundle->getPath(),
  649.                 'namespace' => $bundle->getNamespace(),
  650.             ];
  651.         }
  653.         return [
  654.             /*
  655.              * @deprecated since Symfony 4.2, use kernel.project_dir instead
  656.              */
  657.             'kernel.root_dir' => realpath($this->rootDir) ?: $this->rootDir,
  658.             'kernel.project_dir' => realpath($this->getProjectDir()) ?: $this->getProjectDir(),
  659.             'kernel.environment' => $this->environment,
  660.             'kernel.debug' => $this->debug,
  661.             /*
  662.              * @deprecated since Symfony 4.2
  663.              */
  664.             'kernel.name' => $this->name,
  665.             'kernel.cache_dir' => realpath($cacheDir = $this->warmupDir ?: $this->getCacheDir()) ?: $cacheDir,
  666.             'kernel.logs_dir' => realpath($this->getLogDir()) ?: $this->getLogDir(),
  667.             'kernel.bundles' => $bundles,
  668.             'kernel.bundles_metadata' => $bundlesMetadata,
  669.             'kernel.charset' => $this->getCharset(),
  670.             'kernel.container_class' => $this->getContainerClass(),
  671.         ];
  672.     }
  674.     /**
  675.      * Builds the service container.
  676.      *
  677.      * @return ContainerBuilder The compiled service container
  678.      *
  679.      * @throws \RuntimeException
  680.      */
  681.     protected function buildContainer()
  682.     {
  683.         foreach (['cache' => $this->warmupDir ?: $this->getCacheDir(), 'logs' => $this->getLogDir()] as $name => $dir) {
  684.             if (!is_dir($dir)) {
  685.                 if (false === @mkdir($dir, 0777, true) && !is_dir($dir)) {
  686.                     throw new \RuntimeException(sprintf('Unable to create the "%s" directory (%s).', $name, $dir));
  687.                 }
  688.             } elseif (!is_writable($dir)) {
  689.                 throw new \RuntimeException(sprintf('Unable to write in the "%s" directory (%s).', $name, $dir));
  690.             }
  691.         }
  693.         $container = $this->getContainerBuilder();
  694.         $container->addObjectResource($this);
  695.         $this->prepareContainer($container);
  697.         if (null !== $cont = $this->registerContainerConfiguration($this->getContainerLoader($container))) {
  698.             $container->merge($cont);
  699.         }
  701.         $container->addCompilerPass(new AddAnnotatedClassesToCachePass($this));
  703.         return $container;
  704.     }
  706.     /**
  707.      * Prepares the ContainerBuilder before it is compiled.
  708.      */
  709.     protected function prepareContainer(ContainerBuilder $container)
  710.     {
  711.         $extensions = [];
  712.         foreach ($this->bundles as $bundle) {
  713.             if ($extension = $bundle->getContainerExtension()) {
  714.                 $container->registerExtension($extension);
  715.             }
  717.             if ($this->debug) {
  718.                 $container->addObjectResource($bundle);
  719.             }
  720.         }
  722.         foreach ($this->bundles as $bundle) {
  723.             $bundle->build($container);
  724.         }
  726.         $this->build($container);
  728.         foreach ($container->getExtensions() as $extension) {
  729.             $extensions[] = $extension->getAlias();
  730.         }
  732.         // ensure these extensions are implicitly loaded
  733.         $container->getCompilerPassConfig()->setMergePass(new MergeExtensionConfigurationPass($extensions));
  734.     }
  736.     /**
  737.      * Gets a new ContainerBuilder instance used to build the service container.
  738.      *
  739.      * @return ContainerBuilder
  740.      */
  741.     protected function getContainerBuilder()
  742.     {
  743.         $container = new ContainerBuilder();
  744.         $container->getParameterBag()->add($this->getKernelParameters());
  746.         if ($this instanceof CompilerPassInterface) {
  747.             $container->addCompilerPass($this, PassConfig::TYPE_BEFORE_OPTIMIZATION, -10000);
  748.         }
  749.         if (class_exists(\ProxyManager\Configuration::class) && class_exists(RuntimeInstantiator::class)) {
  750.             $container->setProxyInstantiator(new RuntimeInstantiator());
  751.         }
  753.         return $container;
  754.     }
  756.     /**
  757.      * Dumps the service container to PHP code in the cache.
  758.      *
  759.      * @param string $class     The name of the class to generate
  760.      * @param string $baseClass The name of the container's base class
  761.      */
  762.     protected function dumpContainer(ConfigCache $cache, ContainerBuilder $container, $class, $baseClass)
  763.     {
  764.         // cache the container
  765.         $dumper = new PhpDumper($container);
  767.         if (class_exists(\ProxyManager\Configuration::class) && class_exists(ProxyDumper::class)) {
  768.             $dumper->setProxyDumper(new ProxyDumper());
  769.         }
  771.         $content = $dumper->dump([
  772.             'class' => $class,
  773.             'base_class' => $baseClass,
  774.             'file' => $cache->getPath(),
  775.             'as_files' => true,
  776.             'debug' => $this->debug,
  777.             'build_time' => $container->hasParameter('kernel.container_build_time') ? $container->getParameter('kernel.container_build_time') : time(),
  778.             'preload_classes' => array_map('get_class', $this->bundles),
  779.         ]);
  781.         $rootCode = array_pop($content);
  782.         $dir = \dirname($cache->getPath()).'/';
  783.         $fs = new Filesystem();
  785.         foreach ($content as $file => $code) {
  786.             $fs->dumpFile($dir.$file, $code);
  787.             @chmod($dir.$file, 0666 & ~umask());
  788.         }
  789.         $legacyFile = \dirname($dir.key($content)).'.legacy';
  790.         if (file_exists($legacyFile)) {
  791.             @unlink($legacyFile);
  792.         }
  794.         $cache->write($rootCode, $container->getResources());
  795.     }
  797.     /**
  798.      * Returns a loader for the container.
  799.      *
  800.      * @return DelegatingLoader The loader
  801.      */
  802.     protected function getContainerLoader(ContainerInterface $container)
  803.     {
  804.         $locator = new FileLocator($this);
  805.         $resolver = new LoaderResolver([
  806.             new XmlFileLoader($container, $locator),
  807.             new YamlFileLoader($container, $locator),
  808.             new IniFileLoader($container, $locator),
  809.             new PhpFileLoader($container, $locator),
  810.             new GlobFileLoader($container, $locator),
  811.             new DirectoryLoader($container, $locator),
  812.             new ClosureLoader($container),
  813.         ]);
  815.         return new DelegatingLoader($resolver);
  816.     }
  818.     /**
  819.      * Removes comments from a PHP source string.
  820.      *
  821.      * We don't use the PHP php_strip_whitespace() function
  822.      * as we want the content to be readable and well-formatted.
  823.      *
  824.      * @param string $source A PHP string
  825.      *
  826.      * @return string The PHP string with the comments removed
  827.      */
  828.     public static function stripComments($source)
  829.     {
  830.         if (!\function_exists('token_get_all')) {
  831.             return $source;
  832.         }
  834.         $rawChunk = '';
  835.         $output = '';
  836.         $tokens = token_get_all($source);
  837.         $ignoreSpace = false;
  838.         for ($i = 0; isset($tokens[$i]); ++$i) {
  839.             $token = $tokens[$i];
  840.             if (!isset($token[1]) || 'b"' === $token) {
  841.                 $rawChunk .= $token;
  842.             } elseif (\T_START_HEREDOC === $token[0]) {
  843.                 $output .= $rawChunk.$token[1];
  844.                 do {
  845.                     $token = $tokens[++$i];
  846.                     $output .= isset($token[1]) && 'b"' !== $token ? $token[1] : $token;
  847.                 } while (\T_END_HEREDOC !== $token[0]);
  848.                 $rawChunk = '';
  849.             } elseif (\T_WHITESPACE === $token[0]) {
  850.                 if ($ignoreSpace) {
  851.                     $ignoreSpace = false;
  853.                     continue;
  854.                 }
  856.                 // replace multiple new lines with a single newline
  857.                 $rawChunk .= preg_replace(['/\n{2,}/S'], "\n", $token[1]);
  858.             } elseif (\in_array($token[0], [\T_COMMENT, \T_DOC_COMMENT])) {
  859.                 if (!\in_array($rawChunk[\strlen($rawChunk) - 1], [' ', "\n", "\r", "\t"], true)) {
  860.                     $rawChunk .= ' ';
  861.                 }
  862.                 $ignoreSpace = true;
  863.             } else {
  864.                 $rawChunk .= $token[1];
  866.                 // The PHP-open tag already has a new-line
  867.                 if (\T_OPEN_TAG === $token[0]) {
  868.                     $ignoreSpace = true;
  869.                 } else {
  870.                     $ignoreSpace = false;
  871.                 }
  872.             }
  873.         }
  875.         $output .= $rawChunk;
  877.         unset($tokens, $rawChunk);
  878.         gc_mem_caches();
  880.         return $output;
  881.     }
  883.     /**
  884.      * @deprecated since Symfony 4.3
  885.      */
  886.     public function serialize()
  887.     {
  888.         @trigger_error(sprintf('The "%s" method is deprecated since Symfony 4.3.', __METHOD__), \E_USER_DEPRECATED);
  890.         return serialize([$this->environment, $this->debug]);
  891.     }
  893.     /**
  894.      * @deprecated since Symfony 4.3
  895.      */
  896.     public function unserialize($data)
  897.     {
  898.         @trigger_error(sprintf('The "%s" method is deprecated since Symfony 4.3.', __METHOD__), \E_USER_DEPRECATED);
  899.         [$environment, $debug] = unserialize($data, ['allowed_classes' => false]);
  901.         $this->__construct($environment, $debug);
  902.     }
  904.     /**
  905.      * @return array
  906.      */
  907.     public function __sleep()
  908.     {
  909.         if (__CLASS__ !== $c = (new \ReflectionMethod($this, 'serialize'))->getDeclaringClass()->name) {
  910.             @trigger_error(sprintf('Implementing the "%s::serialize()" method is deprecated since Symfony 4.3.', $c), \E_USER_DEPRECATED);
  911.             $this->serialized = $this->serialize();
  913.             return ['serialized'];
  914.         }
  916.         return ['environment', 'debug'];
  917.     }
  919.     public function __wakeup()
  920.     {
  921.         if (\is_object($this->environment) || \is_object($this->debug)) {
  922.             throw new \BadMethodCallException('Cannot unserialize '.__CLASS__);
  923.         }
  925.         if (__CLASS__ !== $c = (new \ReflectionMethod($this, 'serialize'))->getDeclaringClass()->name) {
  926.             @trigger_error(sprintf('Implementing the "%s::serialize()" method is deprecated since Symfony 4.3.', $c), \E_USER_DEPRECATED);
  927.             $this->unserialize($this->serialized);
  928.             unset($this->serialized);
  930.             return;
  931.         }
  932.         $this->__construct($this->environment, $this->debug);
  933.     }
  934. }