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

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <[email protected]>
  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 <[email protected]>
  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.     const VERSION = '4.4.1';
  80.     const VERSION_ID = 40401;
  81.     const MAJOR_VERSION = 4;
  82.     const MINOR_VERSION = 4;
  83.     const RELEASE_VERSION = 1;
  84.     const EXTRA_VERSION = '';
  86.     const END_OF_MAINTENANCE = '11/2022';
  87.     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 a 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.             $class = \get_class($this);
  232.             $class = 'c' === $class[0] && 0 === strpos($class, "class@anonymous\0") ? get_parent_class($class).'@anonymous' : $class;
  234.             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, $class));
  235.         }
  237.         return $this->bundles[$name];
  238.     }
  240.     /**
  241.      * {@inheritdoc}
  242.      */
  243.     public function locateResource($name/*, $dir = null, $first = true, $triggerDeprecation = true*/)
  244.     {
  245.         if (2 <= \func_num_args()) {
  246.             $dir = func_get_arg(1);
  247.             $first = 3 <= \func_num_args() ? func_get_arg(2) : true;
  249.             if (4 !== \func_num_args() || func_get_arg(3)) {
  250.                 @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);
  251.             }
  252.         } else {
  253.             $dir = null;
  254.             $first = true;
  255.         }
  257.         if ('@' !== $name[0]) {
  258.             throw new \InvalidArgumentException(sprintf('A resource name must start with @ ("%s" given).', $name));
  259.         }
  261.         if (false !== strpos($name, '..')) {
  262.             throw new \RuntimeException(sprintf('File name "%s" contains invalid characters (..).', $name));
  263.         }
  265.         $bundleName = substr($name, 1);
  266.         $path = '';
  267.         if (false !== strpos($bundleName, '/')) {
  268.             list($bundleName, $path) = explode('/', $bundleName, 2);
  269.         }
  271.         $isResource = 0 === strpos($path, 'Resources') && null !== $dir;
  272.         $overridePath = substr($path, 9);
  273.         $bundle = $this->getBundle($bundleName);
  274.         $files = [];
  276.         if ($isResource && file_exists($file = $dir.'/'.$bundle->getName().$overridePath)) {
  277.             $files[] = $file;
  279.             // see https://symfony.com/doc/current/bundles/override.html on how to overwrite parts of a bundle
  280.             @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);
  281.         }
  283.         if (file_exists($file = $bundle->getPath().'/'.$path)) {
  284.             if ($first && !$isResource) {
  285.                 return $file;
  286.             }
  287.             $files[] = $file;
  288.         }
  290.         if (\count($files) > 0) {
  291.             return $first && $isResource ? $files[0] : $files;
  292.         }
  294.         throw new \InvalidArgumentException(sprintf('Unable to find file "%s".', $name));
  295.     }
  297.     /**
  298.      * {@inheritdoc}
  299.      *
  300.      * @deprecated since Symfony 4.2
  301.      */
  302.     public function getName(/* $triggerDeprecation = true */)
  303.     {
  304.         if (0 === \func_num_args() || func_get_arg(0)) {
  305.             @trigger_error(sprintf('The "%s()" method is deprecated since Symfony 4.2.', __METHOD__), E_USER_DEPRECATED);
  306.         }
  308.         if (null === $this->name) {
  309.             $this->name = preg_replace('/[^a-zA-Z0-9_]+/', '', basename($this->rootDir));
  310.             if (ctype_digit($this->name[0])) {
  311.                 $this->name = '_'.$this->name;
  312.             }
  313.         }
  315.         return $this->name;
  316.     }
  318.     /**
  319.      * {@inheritdoc}
  320.      */
  321.     public function getEnvironment()
  322.     {
  323.         return $this->environment;
  324.     }
  326.     /**
  327.      * {@inheritdoc}
  328.      */
  329.     public function isDebug()
  330.     {
  331.         return $this->debug;
  332.     }
  334.     /**
  335.      * {@inheritdoc}
  336.      *
  337.      * @deprecated since Symfony 4.2, use getProjectDir() instead
  338.      */
  339.     public function getRootDir(/* $triggerDeprecation = true */)
  340.     {
  341.         if (0 === \func_num_args() || func_get_arg(0)) {
  342.             @trigger_error(sprintf('The "%s()" method is deprecated since Symfony 4.2, use getProjectDir() instead.', __METHOD__), E_USER_DEPRECATED);
  343.         }
  345.         if (null === $this->rootDir) {
  346.             $r = new \ReflectionObject($this);
  347.             $this->rootDir = \dirname($r->getFileName());
  348.         }
  350.         return $this->rootDir;
  351.     }
  353.     /**
  354.      * Gets the application root dir (path of the project's composer file).
  355.      *
  356.      * @return string The project root dir
  357.      */
  358.     public function getProjectDir()
  359.     {
  360.         if (null === $this->projectDir) {
  361.             $r = new \ReflectionObject($this);
  363.             if (!file_exists($dir = $r->getFileName())) {
  364.                 throw new \LogicException(sprintf('Cannot auto-detect project dir for kernel of class "%s".', $r->name));
  365.             }
  367.             $dir = $rootDir = \dirname($dir);
  368.             while (!file_exists($dir.'/composer.json')) {
  369.                 if ($dir === \dirname($dir)) {
  370.                     return $this->projectDir = $rootDir;
  371.                 }
  372.                 $dir = \dirname($dir);
  373.             }
  374.             $this->projectDir = $dir;
  375.         }
  377.         return $this->projectDir;
  378.     }
  380.     /**
  381.      * {@inheritdoc}
  382.      */
  383.     public function getContainer()
  384.     {
  385.         if (!$this->container) {
  386.             @trigger_error('Getting the container from a non-booted kernel is deprecated since Symfony 4.4.', E_USER_DEPRECATED);
  387.         }
  389.         return $this->container;
  390.     }
  392.     /**
  393.      * @internal
  394.      */
  395.     public function setAnnotatedClassCache(array $annotatedClasses)
  396.     {
  397.         file_put_contents(($this->warmupDir ?: $this->getCacheDir()).'/annotations.map', sprintf('<?php return %s;', var_export($annotatedClasses, true)));
  398.     }
  400.     /**
  401.      * {@inheritdoc}
  402.      */
  403.     public function getStartTime()
  404.     {
  405.         return $this->debug && null !== $this->startTime ? $this->startTime : -INF;
  406.     }
  408.     /**
  409.      * {@inheritdoc}
  410.      */
  411.     public function getCacheDir()
  412.     {
  413.         return $this->getProjectDir().'/var/cache/'.$this->environment;
  414.     }
  416.     /**
  417.      * {@inheritdoc}
  418.      */
  419.     public function getLogDir()
  420.     {
  421.         return $this->getProjectDir().'/var/log';
  422.     }
  424.     /**
  425.      * {@inheritdoc}
  426.      */
  427.     public function getCharset()
  428.     {
  429.         return 'UTF-8';
  430.     }
  432.     /**
  433.      * Gets the patterns defining the classes to parse and cache for annotations.
  434.      */
  435.     public function getAnnotatedClassesToCompile(): array
  436.     {
  437.         return [];
  438.     }
  440.     /**
  441.      * Initializes bundles.
  442.      *
  443.      * @throws \LogicException if two bundles share a common name
  444.      */
  445.     protected function initializeBundles()
  446.     {
  447.         // init bundles
  448.         $this->bundles = [];
  449.         foreach ($this->registerBundles() as $bundle) {
  450.             $name = $bundle->getName();
  451.             if (isset($this->bundles[$name])) {
  452.                 throw new \LogicException(sprintf('Trying to register two bundles with the same name "%s"', $name));
  453.             }
  454.             $this->bundles[$name] = $bundle;
  455.         }
  456.     }
  458.     /**
  459.      * The extension point similar to the Bundle::build() method.
  460.      *
  461.      * Use this method to register compiler passes and manipulate the container during the building process.
  462.      */
  463.     protected function build(ContainerBuilder $container)
  464.     {
  465.     }
  467.     /**
  468.      * Gets the container class.
  469.      *
  470.      * @throws \InvalidArgumentException If the generated classname is invalid
  471.      *
  472.      * @return string The container class
  473.      */
  474.     protected function getContainerClass()
  475.     {
  476.         $class = \get_class($this);
  477.         $class = 'c' === $class[0] && 0 === strpos($class, "class@anonymous\0") ? get_parent_class($class).str_replace('.', '_', ContainerBuilder::hash($class)) : $class;
  478.         $class = $this->name.str_replace('\\', '_', $class).ucfirst($this->environment).($this->debug ? 'Debug' : '').'Container';
  480.         if (!preg_match('/^[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*$/', $class)) {
  481.             throw new \InvalidArgumentException(sprintf('The environment "%s" contains invalid characters, it can only contain characters allowed in PHP class names.', $this->environment));
  482.         }
  484.         return $class;
  485.     }
  487.     /**
  488.      * Gets the container's base class.
  489.      *
  490.      * All names except Container must be fully qualified.
  491.      *
  492.      * @return string
  493.      */
  494.     protected function getContainerBaseClass()
  495.     {
  496.         return 'Container';
  497.     }
  499.     /**
  500.      * Initializes the service container.
  501.      *
  502.      * The cached version of the service container is used when fresh, otherwise the
  503.      * container is built.
  504.      */
  505.     protected function initializeContainer()
  506.     {
  507.         $class = $this->getContainerClass();
  508.         $cacheDir = $this->warmupDir ?: $this->getCacheDir();
  509.         $cache = new ConfigCache($cacheDir.'/'.$class.'.php', $this->debug);
  510.         $cachePath = $cache->getPath();
  512.         // Silence E_WARNING to ignore "include" failures - don't use "@" to prevent silencing fatal errors
  513.         $errorLevel = error_reporting(\E_ALL ^ \E_WARNING);
  515.         try {
  516.             if (file_exists($cachePath) && \is_object($this->container = include $cachePath)
  517.                 && (!$this->debug || (self::$freshCache[$cachePath] ?? $cache->isFresh()))
  518.             ) {
  519.                 self::$freshCache[$cachePath] = true;
  520.                 $this->container->set('kernel', $this);
  521.                 error_reporting($errorLevel);
  523.                 return;
  524.             }
  525.         } catch (\Throwable $e) {
  526.         }
  528.         $oldContainer = \is_object($this->container) ? new \ReflectionClass($this->container) : $this->container = null;
  530.         try {
  531.             is_dir($cacheDir) ?: mkdir($cacheDir, 0777, true);
  533.             if ($lock = fopen($cachePath, 'w')) {
  534.                 chmod($cachePath, 0666 & ~umask());
  535.                 flock($lock, LOCK_EX | LOCK_NB, $wouldBlock);
  537.                 if (!flock($lock, $wouldBlock ? LOCK_SH : LOCK_EX)) {
  538.                     fclose($lock);
  539.                 } else {
  540.                     $cache = new class($cachePath, $this->debug) extends ConfigCache {
  541.                         public $lock;
  543.                         public function write($content, array $metadata = null)
  544.                         {
  545.                             rewind($this->lock);
  546.                             ftruncate($this->lock, 0);
  547.                             fwrite($this->lock, $content);
  549.                             if (null !== $metadata) {
  550.                                 file_put_contents($this->getPath().'.meta', serialize($metadata));
  551.                                 @chmod($this->getPath().'.meta', 0666 & ~umask());
  552.                             }
  554.                             if (\function_exists('opcache_invalidate') && filter_var(ini_get('opcache.enable'), FILTER_VALIDATE_BOOLEAN)) {
  555.                                 opcache_invalidate($this->getPath(), true);
  556.                             }
  557.                         }
  559.                         public function __destruct()
  560.                         {
  561.                             flock($this->lock, LOCK_UN);
  562.                             fclose($this->lock);
  563.                         }
  564.                     };
  565.                     $cache->lock = $lock;
  567.                     if (!\is_object($this->container = include $cachePath)) {
  568.                         $this->container = null;
  569.                     } elseif (!$oldContainer || \get_class($this->container) !== $oldContainer->name) {
  570.                         $this->container->set('kernel', $this);
  572.                         return;
  573.                     }
  574.                 }
  575.             }
  576.         } catch (\Throwable $e) {
  577.         } finally {
  578.             error_reporting($errorLevel);
  579.         }
  581.         if ($collectDeprecations = $this->debug && !\defined('PHPUNIT_COMPOSER_INSTALL')) {
  582.             $collectedLogs = [];
  583.             $previousHandler = set_error_handler(function ($type, $message, $file, $line) use (&$collectedLogs, &$previousHandler) {
  584.                 if (E_USER_DEPRECATED !== $type && E_DEPRECATED !== $type) {
  585.                     return $previousHandler ? $previousHandler($type, $message, $file, $line) : false;
  586.                 }
  588.                 if (isset($collectedLogs[$message])) {
  589.                     ++$collectedLogs[$message]['count'];
  591.                     return null;
  592.                 }
  594.                 $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 5);
  595.                 // Clean the trace by removing first frames added by the error handler itself.
  596.                 for ($i = 0; isset($backtrace[$i]); ++$i) {
  597.                     if (isset($backtrace[$i]['file'], $backtrace[$i]['line']) && $backtrace[$i]['line'] === $line && $backtrace[$i]['file'] === $file) {
  598.                         $backtrace = \array_slice($backtrace, 1 + $i);
  599.                         break;
  600.                     }
  601.                 }
  602.                 // Remove frames added by DebugClassLoader.
  603.                 for ($i = \count($backtrace) - 2; 0 < $i; --$i) {
  604.                     if (\in_array($backtrace[$i]['class'] ?? null, [DebugClassLoader::class, LegacyDebugClassLoader::class], true)) {
  605.                         $backtrace = [$backtrace[$i + 1]];
  606.                         break;
  607.                     }
  608.                 }
  610.                 $collectedLogs[$message] = [
  611.                     'type' => $type,
  612.                     'message' => $message,
  613.                     'file' => $file,
  614.                     'line' => $line,
  615.                     'trace' => [$backtrace[0]],
  616.                     'count' => 1,
  617.                 ];
  619.                 return null;
  620.             });
  621.         }
  623.         try {
  624.             $container = null;
  625.             $container = $this->buildContainer();
  626.             $container->compile();
  627.         } finally {
  628.             if ($collectDeprecations) {
  629.                 restore_error_handler();
  631.                 file_put_contents($cacheDir.'/'.$class.'Deprecations.log', serialize(array_values($collectedLogs)));
  632.                 file_put_contents($cacheDir.'/'.$class.'Compiler.log', null !== $container ? implode("\n", $container->getCompiler()->getLog()) : '');
  633.             }
  634.         }
  636.         $this->dumpContainer($cache, $container, $class, $this->getContainerBaseClass());
  637.         unset($cache);
  638.         $this->container = require $cachePath;
  639.         $this->container->set('kernel', $this);
  641.         if ($oldContainer && \get_class($this->container) !== $oldContainer->name) {
  642.             // Because concurrent requests might still be using them,
  643.             // old container files are not removed immediately,
  644.             // but on a next dump of the container.
  645.             static $legacyContainers = [];
  646.             $oldContainerDir = \dirname($oldContainer->getFileName());
  647.             $legacyContainers[$oldContainerDir.'.legacy'] = true;
  648.             foreach (glob(\dirname($oldContainerDir).\DIRECTORY_SEPARATOR.'*.legacy', GLOB_NOSORT) as $legacyContainer) {
  649.                 if (!isset($legacyContainers[$legacyContainer]) && @unlink($legacyContainer)) {
  650.                     (new Filesystem())->remove(substr($legacyContainer, 0, -7));
  651.                 }
  652.             }
  654.             touch($oldContainerDir.'.legacy');
  655.         }
  657.         if ($this->container->has('cache_warmer')) {
  658.             $this->container->get('cache_warmer')->warmUp($this->container->getParameter('kernel.cache_dir'));
  659.         }
  660.     }
  662.     /**
  663.      * Returns the kernel parameters.
  664.      *
  665.      * @return array An array of kernel parameters
  666.      */
  667.     protected function getKernelParameters()
  668.     {
  669.         $bundles = [];
  670.         $bundlesMetadata = [];
  672.         foreach ($this->bundles as $name => $bundle) {
  673.             $bundles[$name] = \get_class($bundle);
  674.             $bundlesMetadata[$name] = [
  675.                 'path' => $bundle->getPath(),
  676.                 'namespace' => $bundle->getNamespace(),
  677.             ];
  678.         }
  680.         return [
  681.             /*
  682.              * @deprecated since Symfony 4.2, use kernel.project_dir instead
  683.              */
  684.             'kernel.root_dir' => realpath($this->rootDir) ?: $this->rootDir,
  685.             'kernel.project_dir' => realpath($this->getProjectDir()) ?: $this->getProjectDir(),
  686.             'kernel.environment' => $this->environment,
  687.             'kernel.debug' => $this->debug,
  688.             /*
  689.              * @deprecated since Symfony 4.2
  690.              */
  691.             'kernel.name' => $this->name,
  692.             'kernel.cache_dir' => realpath($cacheDir = $this->warmupDir ?: $this->getCacheDir()) ?: $cacheDir,
  693.             'kernel.logs_dir' => realpath($this->getLogDir()) ?: $this->getLogDir(),
  694.             'kernel.bundles' => $bundles,
  695.             'kernel.bundles_metadata' => $bundlesMetadata,
  696.             'kernel.charset' => $this->getCharset(),
  697.             'kernel.container_class' => $this->getContainerClass(),
  698.         ];
  699.     }
  701.     /**
  702.      * Builds the service container.
  703.      *
  704.      * @return ContainerBuilder The compiled service container
  705.      *
  706.      * @throws \RuntimeException
  707.      */
  708.     protected function buildContainer()
  709.     {
  710.         foreach (['cache' => $this->warmupDir ?: $this->getCacheDir(), 'logs' => $this->getLogDir()] as $name => $dir) {
  711.             if (!is_dir($dir)) {
  712.                 if (false === @mkdir($dir, 0777, true) && !is_dir($dir)) {
  713.                     throw new \RuntimeException(sprintf("Unable to create the %s directory (%s)\n", $name, $dir));
  714.                 }
  715.             } elseif (!is_writable($dir)) {
  716.                 throw new \RuntimeException(sprintf("Unable to write in the %s directory (%s)\n", $name, $dir));
  717.             }
  718.         }
  720.         $container = $this->getContainerBuilder();
  721.         $container->addObjectResource($this);
  722.         $this->prepareContainer($container);
  724.         if (null !== $cont = $this->registerContainerConfiguration($this->getContainerLoader($container))) {
  725.             $container->merge($cont);
  726.         }
  728.         $container->addCompilerPass(new AddAnnotatedClassesToCachePass($this));
  730.         return $container;
  731.     }
  733.     /**
  734.      * Prepares the ContainerBuilder before it is compiled.
  735.      */
  736.     protected function prepareContainer(ContainerBuilder $container)
  737.     {
  738.         $extensions = [];
  739.         foreach ($this->bundles as $bundle) {
  740.             if ($extension = $bundle->getContainerExtension()) {
  741.                 $container->registerExtension($extension);
  742.             }
  744.             if ($this->debug) {
  745.                 $container->addObjectResource($bundle);
  746.             }
  747.         }
  749.         foreach ($this->bundles as $bundle) {
  750.             $bundle->build($container);
  751.         }
  753.         $this->build($container);
  755.         foreach ($container->getExtensions() as $extension) {
  756.             $extensions[] = $extension->getAlias();
  757.         }
  759.         // ensure these extensions are implicitly loaded
  760.         $container->getCompilerPassConfig()->setMergePass(new MergeExtensionConfigurationPass($extensions));
  761.     }
  763.     /**
  764.      * Gets a new ContainerBuilder instance used to build the service container.
  765.      *
  766.      * @return ContainerBuilder
  767.      */
  768.     protected function getContainerBuilder()
  769.     {
  770.         $container = new ContainerBuilder();
  771.         $container->getParameterBag()->add($this->getKernelParameters());
  773.         if ($this instanceof CompilerPassInterface) {
  774.             $container->addCompilerPass($this, PassConfig::TYPE_BEFORE_OPTIMIZATION, -10000);
  775.         }
  776.         if (class_exists('ProxyManager\Configuration') && class_exists('Symfony\Bridge\ProxyManager\LazyProxy\Instantiator\RuntimeInstantiator')) {
  777.             $container->setProxyInstantiator(new RuntimeInstantiator());
  778.         }
  780.         return $container;
  781.     }
  783.     /**
  784.      * Dumps the service container to PHP code in the cache.
  785.      *
  786.      * @param string $class     The name of the class to generate
  787.      * @param string $baseClass The name of the container's base class
  788.      */
  789.     protected function dumpContainer(ConfigCache $cache, ContainerBuilder $container, $class, $baseClass)
  790.     {
  791.         // cache the container
  792.         $dumper = new PhpDumper($container);
  794.         if (class_exists('ProxyManager\Configuration') && class_exists('Symfony\Bridge\ProxyManager\LazyProxy\PhpDumper\ProxyDumper')) {
  795.             $dumper->setProxyDumper(new ProxyDumper());
  796.         }
  798.         $content = $dumper->dump([
  799.             'class' => $class,
  800.             'base_class' => $baseClass,
  801.             'file' => $cache->getPath(),
  802.             'as_files' => true,
  803.             'debug' => $this->debug,
  804.             'build_time' => $container->hasParameter('kernel.container_build_time') ? $container->getParameter('kernel.container_build_time') : time(),
  805.         ]);
  807.         $rootCode = array_pop($content);
  808.         $dir = \dirname($cache->getPath()).'/';
  809.         $fs = new Filesystem();
  811.         foreach ($content as $file => $code) {
  812.             $fs->dumpFile($dir.$file, $code);
  813.             @chmod($dir.$file, 0666 & ~umask());
  814.         }
  815.         $legacyFile = \dirname($dir.key($content)).'.legacy';
  816.         if (file_exists($legacyFile)) {
  817.             @unlink($legacyFile);
  818.         }
  820.         $cache->write($rootCode, $container->getResources());
  821.     }
  823.     /**
  824.      * Returns a loader for the container.
  825.      *
  826.      * @return DelegatingLoader The loader
  827.      */
  828.     protected function getContainerLoader(ContainerInterface $container)
  829.     {
  830.         $locator = new FileLocator($this);
  831.         $resolver = new LoaderResolver([
  832.             new XmlFileLoader($container, $locator),
  833.             new YamlFileLoader($container, $locator),
  834.             new IniFileLoader($container, $locator),
  835.             new PhpFileLoader($container, $locator),
  836.             new GlobFileLoader($container, $locator),
  837.             new DirectoryLoader($container, $locator),
  838.             new ClosureLoader($container),
  839.         ]);
  841.         return new DelegatingLoader($resolver);
  842.     }
  844.     /**
  845.      * Removes comments from a PHP source string.
  846.      *
  847.      * We don't use the PHP php_strip_whitespace() function
  848.      * as we want the content to be readable and well-formatted.
  849.      *
  850.      * @param string $source A PHP string
  851.      *
  852.      * @return string The PHP string with the comments removed
  853.      */
  854.     public static function stripComments($source)
  855.     {
  856.         if (!\function_exists('token_get_all')) {
  857.             return $source;
  858.         }
  860.         $rawChunk = '';
  861.         $output = '';
  862.         $tokens = token_get_all($source);
  863.         $ignoreSpace = false;
  864.         for ($i = 0; isset($tokens[$i]); ++$i) {
  865.             $token = $tokens[$i];
  866.             if (!isset($token[1]) || 'b"' === $token) {
  867.                 $rawChunk .= $token;
  868.             } elseif (T_START_HEREDOC === $token[0]) {
  869.                 $output .= $rawChunk.$token[1];
  870.                 do {
  871.                     $token = $tokens[++$i];
  872.                     $output .= isset($token[1]) && 'b"' !== $token ? $token[1] : $token;
  873.                 } while (T_END_HEREDOC !== $token[0]);
  874.                 $rawChunk = '';
  875.             } elseif (T_WHITESPACE === $token[0]) {
  876.                 if ($ignoreSpace) {
  877.                     $ignoreSpace = false;
  879.                     continue;
  880.                 }
  882.                 // replace multiple new lines with a single newline
  883.                 $rawChunk .= preg_replace(['/\n{2,}/S'], "\n", $token[1]);
  884.             } elseif (\in_array($token[0], [T_COMMENT, T_DOC_COMMENT])) {
  885.                 $ignoreSpace = true;
  886.             } else {
  887.                 $rawChunk .= $token[1];
  889.                 // The PHP-open tag already has a new-line
  890.                 if (T_OPEN_TAG === $token[0]) {
  891.                     $ignoreSpace = true;
  892.                 }
  893.             }
  894.         }
  896.         $output .= $rawChunk;
  898.         unset($tokens, $rawChunk);
  899.         gc_mem_caches();
  901.         return $output;
  902.     }
  904.     /**
  905.      * @deprecated since Symfony 4.3
  906.      */
  907.     public function serialize()
  908.     {
  909.         @trigger_error(sprintf('The "%s" method is deprecated since Symfony 4.3.', __METHOD__), E_USER_DEPRECATED);
  911.         return serialize([$this->environment, $this->debug]);
  912.     }
  914.     /**
  915.      * @deprecated since Symfony 4.3
  916.      */
  917.     public function unserialize($data)
  918.     {
  919.         @trigger_error(sprintf('The "%s" method is deprecated since Symfony 4.3.', __METHOD__), E_USER_DEPRECATED);
  920.         list($environment, $debug) = unserialize($data, ['allowed_classes' => false]);
  922.         $this->__construct($environment, $debug);
  923.     }
  925.     /**
  926.      * @return array
  927.      */
  928.     public function __sleep()
  929.     {
  930.         if (__CLASS__ !== $c = (new \ReflectionMethod($this, 'serialize'))->getDeclaringClass()->name) {
  931.             @trigger_error(sprintf('Implementing the "%s::serialize()" method is deprecated since Symfony 4.3.', $c), E_USER_DEPRECATED);
  932.             $this->serialized = $this->serialize();
  934.             return ['serialized'];
  935.         }
  937.         return ['environment', 'debug'];
  938.     }
  940.     public function __wakeup()
  941.     {
  942.         if (__CLASS__ !== $c = (new \ReflectionMethod($this, 'serialize'))->getDeclaringClass()->name) {
  943.             @trigger_error(sprintf('Implementing the "%s::serialize()" method is deprecated since Symfony 4.3.', $c), E_USER_DEPRECATED);
  944.             $this->unserialize($this->serialized);
  945.             unset($this->serialized);
  947.             return;
  948.         }
  949.         $this->__construct($this->environment, $this->debug);
  950.     }
  951. }