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

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.     protected $environment;
  60.     protected $debug;
  61.     protected $booted = false;
  62.     protected $startTime;
  64.     private $projectDir;
  65.     private $warmupDir;
  66.     private $requestStackSize = 0;
  67.     private $resetServices = false;
  69.     private static $freshCache = [];
  71.     const VERSION = '5.0.2';
  72.     const VERSION_ID = 50002;
  73.     const MAJOR_VERSION = 5;
  74.     const MINOR_VERSION = 0;
  75.     const RELEASE_VERSION = 2;
  76.     const EXTRA_VERSION = '';
  78.     const END_OF_MAINTENANCE = '07/2020';
  79.     const END_OF_LIFE = '07/2020';
  81.     public function __construct(string $environment, bool $debug)
  82.     {
  83.         $this->environment = $environment;
  84.         $this->debug = $debug;
  85.     }
  87.     public function __clone()
  88.     {
  89.         $this->booted = false;
  90.         $this->container = null;
  91.         $this->requestStackSize = 0;
  92.         $this->resetServices = false;
  93.     }
  95.     /**
  96.      * {@inheritdoc}
  97.      */
  98.     public function boot()
  99.     {
  100.         if (true === $this->booted) {
  101.             if (!$this->requestStackSize && $this->resetServices) {
  102.                 if ($this->container->has('services_resetter')) {
  103.                     $this->container->get('services_resetter')->reset();
  104.                 }
  105.                 $this->resetServices = false;
  106.                 if ($this->debug) {
  107.                     $this->startTime = microtime(true);
  108.                 }
  109.             }
  111.             return;
  112.         }
  113.         if ($this->debug) {
  114.             $this->startTime = microtime(true);
  115.         }
  116.         if ($this->debug && !isset($_ENV['SHELL_VERBOSITY']) && !isset($_SERVER['SHELL_VERBOSITY'])) {
  117.             putenv('SHELL_VERBOSITY=3');
  118.             $_ENV['SHELL_VERBOSITY'] = 3;
  119.             $_SERVER['SHELL_VERBOSITY'] = 3;
  120.         }
  122.         // init bundles
  123.         $this->initializeBundles();
  125.         // init container
  126.         $this->initializeContainer();
  128.         foreach ($this->getBundles() as $bundle) {
  129.             $bundle->setContainer($this->container);
  130.             $bundle->boot();
  131.         }
  133.         $this->booted = true;
  134.     }
  136.     /**
  137.      * {@inheritdoc}
  138.      */
  139.     public function reboot(?string $warmupDir)
  140.     {
  141.         $this->shutdown();
  142.         $this->warmupDir = $warmupDir;
  143.         $this->boot();
  144.     }
  146.     /**
  147.      * {@inheritdoc}
  148.      */
  149.     public function terminate(Request $request, Response $response)
  150.     {
  151.         if (false === $this->booted) {
  152.             return;
  153.         }
  155.         if ($this->getHttpKernel() instanceof TerminableInterface) {
  156.             $this->getHttpKernel()->terminate($request, $response);
  157.         }
  158.     }
  160.     /**
  161.      * {@inheritdoc}
  162.      */
  163.     public function shutdown()
  164.     {
  165.         if (false === $this->booted) {
  166.             return;
  167.         }
  169.         $this->booted = false;
  171.         foreach ($this->getBundles() as $bundle) {
  172.             $bundle->shutdown();
  173.             $bundle->setContainer(null);
  174.         }
  176.         $this->container = null;
  177.         $this->requestStackSize = 0;
  178.         $this->resetServices = false;
  179.     }
  181.     /**
  182.      * {@inheritdoc}
  183.      */
  184.     public function handle(Request $request, int $type = HttpKernelInterface::MASTER_REQUEST, bool $catch = true)
  185.     {
  186.         $this->boot();
  187.         ++$this->requestStackSize;
  188.         $this->resetServices = true;
  190.         try {
  191.             return $this->getHttpKernel()->handle($request, $type, $catch);
  192.         } finally {
  193.             --$this->requestStackSize;
  194.         }
  195.     }
  197.     /**
  198.      * Gets a HTTP kernel from the container.
  199.      *
  200.      * @return HttpKernelInterface
  201.      */
  202.     protected function getHttpKernel()
  203.     {
  204.         return $this->container->get('http_kernel');
  205.     }
  207.     /**
  208.      * {@inheritdoc}
  209.      */
  210.     public function getBundles()
  211.     {
  212.         return $this->bundles;
  213.     }
  215.     /**
  216.      * {@inheritdoc}
  217.      */
  218.     public function getBundle(string $name)
  219.     {
  220.         if (!isset($this->bundles[$name])) {
  221.             $class = \get_class($this);
  222.             $class = 'c' === $class[0] && 0 === strpos($class, "class@anonymous\0") ? get_parent_class($class).'@anonymous' : $class;
  224.             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));
  225.         }
  227.         return $this->bundles[$name];
  228.     }
  230.     /**
  231.      * {@inheritdoc}
  232.      */
  233.     public function locateResource(string $name)
  234.     {
  235.         if ('@' !== $name[0]) {
  236.             throw new \InvalidArgumentException(sprintf('A resource name must start with @ ("%s" given).', $name));
  237.         }
  239.         if (false !== strpos($name, '..')) {
  240.             throw new \RuntimeException(sprintf('File name "%s" contains invalid characters (..).', $name));
  241.         }
  243.         $bundleName = substr($name, 1);
  244.         $path = '';
  245.         if (false !== strpos($bundleName, '/')) {
  246.             list($bundleName, $path) = explode('/', $bundleName, 2);
  247.         }
  249.         $bundle = $this->getBundle($bundleName);
  250.         if (file_exists($file = $bundle->getPath().'/'.$path)) {
  251.             return $file;
  252.         }
  254.         throw new \InvalidArgumentException(sprintf('Unable to find file "%s".', $name));
  255.     }
  257.     /**
  258.      * {@inheritdoc}
  259.      */
  260.     public function getEnvironment()
  261.     {
  262.         return $this->environment;
  263.     }
  265.     /**
  266.      * {@inheritdoc}
  267.      */
  268.     public function isDebug()
  269.     {
  270.         return $this->debug;
  271.     }
  273.     /**
  274.      * Gets the application root dir (path of the project's composer file).
  275.      *
  276.      * @return string The project root dir
  277.      */
  278.     public function getProjectDir()
  279.     {
  280.         if (null === $this->projectDir) {
  281.             $r = new \ReflectionObject($this);
  283.             if (!file_exists($dir = $r->getFileName())) {
  284.                 throw new \LogicException(sprintf('Cannot auto-detect project dir for kernel of class "%s".', $r->name));
  285.             }
  287.             $dir = $rootDir = \dirname($dir);
  288.             while (!file_exists($dir.'/composer.json')) {
  289.                 if ($dir === \dirname($dir)) {
  290.                     return $this->projectDir = $rootDir;
  291.                 }
  292.                 $dir = \dirname($dir);
  293.             }
  294.             $this->projectDir = $dir;
  295.         }
  297.         return $this->projectDir;
  298.     }
  300.     /**
  301.      * {@inheritdoc}
  302.      */
  303.     public function getContainer()
  304.     {
  305.         if (!$this->container) {
  306.             throw new \LogicException('Cannot retrieve the container from a non-booted kernel.');
  307.         }
  309.         return $this->container;
  310.     }
  312.     /**
  313.      * @internal
  314.      */
  315.     public function setAnnotatedClassCache(array $annotatedClasses)
  316.     {
  317.         file_put_contents(($this->warmupDir ?: $this->getCacheDir()).'/annotations.map', sprintf('<?php return %s;', var_export($annotatedClasses, true)));
  318.     }
  320.     /**
  321.      * {@inheritdoc}
  322.      */
  323.     public function getStartTime()
  324.     {
  325.         return $this->debug && null !== $this->startTime ? $this->startTime : -INF;
  326.     }
  328.     /**
  329.      * {@inheritdoc}
  330.      */
  331.     public function getCacheDir()
  332.     {
  333.         return $this->getProjectDir().'/var/cache/'.$this->environment;
  334.     }
  336.     /**
  337.      * {@inheritdoc}
  338.      */
  339.     public function getLogDir()
  340.     {
  341.         return $this->getProjectDir().'/var/log';
  342.     }
  344.     /**
  345.      * {@inheritdoc}
  346.      */
  347.     public function getCharset()
  348.     {
  349.         return 'UTF-8';
  350.     }
  352.     /**
  353.      * Gets the patterns defining the classes to parse and cache for annotations.
  354.      */
  355.     public function getAnnotatedClassesToCompile(): array
  356.     {
  357.         return [];
  358.     }
  360.     /**
  361.      * Initializes bundles.
  362.      *
  363.      * @throws \LogicException if two bundles share a common name
  364.      */
  365.     protected function initializeBundles()
  366.     {
  367.         // init bundles
  368.         $this->bundles = [];
  369.         foreach ($this->registerBundles() as $bundle) {
  370.             $name = $bundle->getName();
  371.             if (isset($this->bundles[$name])) {
  372.                 throw new \LogicException(sprintf('Trying to register two bundles with the same name "%s"', $name));
  373.             }
  374.             $this->bundles[$name] = $bundle;
  375.         }
  376.     }
  378.     /**
  379.      * The extension point similar to the Bundle::build() method.
  380.      *
  381.      * Use this method to register compiler passes and manipulate the container during the building process.
  382.      */
  383.     protected function build(ContainerBuilder $container)
  384.     {
  385.     }
  387.     /**
  388.      * Gets the container class.
  389.      *
  390.      * @throws \InvalidArgumentException If the generated classname is invalid
  391.      *
  392.      * @return string The container class
  393.      */
  394.     protected function getContainerClass()
  395.     {
  396.         $class = \get_class($this);
  397.         $class = 'c' === $class[0] && 0 === strpos($class, "class@anonymous\0") ? get_parent_class($class).str_replace('.', '_', ContainerBuilder::hash($class)) : $class;
  398.         $class = str_replace('\\', '_', $class).ucfirst($this->environment).($this->debug ? 'Debug' : '').'Container';
  399.         if (!preg_match('/^[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*$/', $class)) {
  400.             throw new \InvalidArgumentException(sprintf('The environment "%s" contains invalid characters, it can only contain characters allowed in PHP class names.', $this->environment));
  401.         }
  403.         return $class;
  404.     }
  406.     /**
  407.      * Gets the container's base class.
  408.      *
  409.      * All names except Container must be fully qualified.
  410.      *
  411.      * @return string
  412.      */
  413.     protected function getContainerBaseClass()
  414.     {
  415.         return 'Container';
  416.     }
  418.     /**
  419.      * Initializes the service container.
  420.      *
  421.      * The cached version of the service container is used when fresh, otherwise the
  422.      * container is built.
  423.      */
  424.     protected function initializeContainer()
  425.     {
  426.         $class = $this->getContainerClass();
  427.         $cacheDir = $this->warmupDir ?: $this->getCacheDir();
  428.         $cache = new ConfigCache($cacheDir.'/'.$class.'.php', $this->debug);
  429.         $cachePath = $cache->getPath();
  431.         // Silence E_WARNING to ignore "include" failures - don't use "@" to prevent silencing fatal errors
  432.         $errorLevel = error_reporting(\E_ALL ^ \E_WARNING);
  434.         try {
  435.             if (file_exists($cachePath) && \is_object($this->container = include $cachePath)
  436.                 && (!$this->debug || (self::$freshCache[$cachePath] ?? $cache->isFresh()))
  437.             ) {
  438.                 self::$freshCache[$cachePath] = true;
  439.                 $this->container->set('kernel', $this);
  440.                 error_reporting($errorLevel);
  442.                 return;
  443.             }
  444.         } catch (\Throwable $e) {
  445.         }
  447.         $oldContainer = \is_object($this->container) ? new \ReflectionClass($this->container) : $this->container = null;
  449.         try {
  450.             is_dir($cacheDir) ?: mkdir($cacheDir, 0777, true);
  452.             if ($lock = fopen($cachePath, 'w')) {
  453.                 chmod($cachePath, 0666 & ~umask());
  454.                 flock($lock, LOCK_EX | LOCK_NB, $wouldBlock);
  456.                 if (!flock($lock, $wouldBlock ? LOCK_SH : LOCK_EX)) {
  457.                     fclose($lock);
  458.                 } else {
  459.                     $cache = new class($cachePath, $this->debug) extends ConfigCache {
  460.                         public $lock;
  462.                         public function write(string $content, array $metadata = null)
  463.                         {
  464.                             rewind($this->lock);
  465.                             ftruncate($this->lock, 0);
  466.                             fwrite($this->lock, $content);
  468.                             if (null !== $metadata) {
  469.                                 file_put_contents($this->getPath().'.meta', serialize($metadata));
  470.                                 @chmod($this->getPath().'.meta', 0666 & ~umask());
  471.                             }
  473.                             if (\function_exists('opcache_invalidate') && filter_var(ini_get('opcache.enable'), FILTER_VALIDATE_BOOLEAN)) {
  474.                                 @opcache_invalidate($this->getPath(), true);
  475.                             }
  476.                         }
  478.                         public function __destruct()
  479.                         {
  480.                             flock($this->lock, LOCK_UN);
  481.                             fclose($this->lock);
  482.                         }
  483.                     };
  484.                     $cache->lock = $lock;
  486.                     if (!\is_object($this->container = include $cachePath)) {
  487.                         $this->container = null;
  488.                     } elseif (!$oldContainer || \get_class($this->container) !== $oldContainer->name) {
  489.                         $this->container->set('kernel', $this);
  491.                         return;
  492.                     }
  493.                 }
  494.             }
  495.         } catch (\Throwable $e) {
  496.         } finally {
  497.             error_reporting($errorLevel);
  498.         }
  500.         if ($collectDeprecations = $this->debug && !\defined('PHPUNIT_COMPOSER_INSTALL')) {
  501.             $collectedLogs = [];
  502.             $previousHandler = set_error_handler(function ($type, $message, $file, $line) use (&$collectedLogs, &$previousHandler) {
  503.                 if (E_USER_DEPRECATED !== $type && E_DEPRECATED !== $type) {
  504.                     return $previousHandler ? $previousHandler($type, $message, $file, $line) : false;
  505.                 }
  507.                 if (isset($collectedLogs[$message])) {
  508.                     ++$collectedLogs[$message]['count'];
  510.                     return null;
  511.                 }
  513.                 $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 5);
  514.                 // Clean the trace by removing first frames added by the error handler itself.
  515.                 for ($i = 0; isset($backtrace[$i]); ++$i) {
  516.                     if (isset($backtrace[$i]['file'], $backtrace[$i]['line']) && $backtrace[$i]['line'] === $line && $backtrace[$i]['file'] === $file) {
  517.                         $backtrace = \array_slice($backtrace, 1 + $i);
  518.                         break;
  519.                     }
  520.                 }
  521.                 // Remove frames added by DebugClassLoader.
  522.                 for ($i = \count($backtrace) - 2; 0 < $i; --$i) {
  523.                     if (\in_array($backtrace[$i]['class'] ?? null, [DebugClassLoader::class, LegacyDebugClassLoader::class], true)) {
  524.                         $backtrace = [$backtrace[$i + 1]];
  525.                         break;
  526.                     }
  527.                 }
  529.                 $collectedLogs[$message] = [
  530.                     'type' => $type,
  531.                     'message' => $message,
  532.                     'file' => $file,
  533.                     'line' => $line,
  534.                     'trace' => [$backtrace[0]],
  535.                     'count' => 1,
  536.                 ];
  538.                 return null;
  539.             });
  540.         }
  542.         try {
  543.             $container = null;
  544.             $container = $this->buildContainer();
  545.             $container->compile();
  546.         } finally {
  547.             if ($collectDeprecations) {
  548.                 restore_error_handler();
  550.                 file_put_contents($cacheDir.'/'.$class.'Deprecations.log', serialize(array_values($collectedLogs)));
  551.                 file_put_contents($cacheDir.'/'.$class.'Compiler.log', null !== $container ? implode("\n", $container->getCompiler()->getLog()) : '');
  552.             }
  553.         }
  555.         $this->dumpContainer($cache, $container, $class, $this->getContainerBaseClass());
  556.         unset($cache);
  557.         $this->container = require $cachePath;
  558.         $this->container->set('kernel', $this);
  560.         if ($oldContainer && \get_class($this->container) !== $oldContainer->name) {
  561.             // Because concurrent requests might still be using them,
  562.             // old container files are not removed immediately,
  563.             // but on a next dump of the container.
  564.             static $legacyContainers = [];
  565.             $oldContainerDir = \dirname($oldContainer->getFileName());
  566.             $legacyContainers[$oldContainerDir.'.legacy'] = true;
  567.             foreach (glob(\dirname($oldContainerDir).\DIRECTORY_SEPARATOR.'*.legacy', GLOB_NOSORT) as $legacyContainer) {
  568.                 if (!isset($legacyContainers[$legacyContainer]) && @unlink($legacyContainer)) {
  569.                     (new Filesystem())->remove(substr($legacyContainer, 0, -7));
  570.                 }
  571.             }
  573.             touch($oldContainerDir.'.legacy');
  574.         }
  576.         if ($this->container->has('cache_warmer')) {
  577.             $this->container->get('cache_warmer')->warmUp($this->container->getParameter('kernel.cache_dir'));
  578.         }
  579.     }
  581.     /**
  582.      * Returns the kernel parameters.
  583.      *
  584.      * @return array An array of kernel parameters
  585.      */
  586.     protected function getKernelParameters()
  587.     {
  588.         $bundles = [];
  589.         $bundlesMetadata = [];
  591.         foreach ($this->bundles as $name => $bundle) {
  592.             $bundles[$name] = \get_class($bundle);
  593.             $bundlesMetadata[$name] = [
  594.                 'path' => $bundle->getPath(),
  595.                 'namespace' => $bundle->getNamespace(),
  596.             ];
  597.         }
  599.         return [
  600.             'kernel.project_dir' => realpath($this->getProjectDir()) ?: $this->getProjectDir(),
  601.             'kernel.environment' => $this->environment,
  602.             'kernel.debug' => $this->debug,
  603.             'kernel.cache_dir' => realpath($cacheDir = $this->warmupDir ?: $this->getCacheDir()) ?: $cacheDir,
  604.             'kernel.logs_dir' => realpath($this->getLogDir()) ?: $this->getLogDir(),
  605.             'kernel.bundles' => $bundles,
  606.             'kernel.bundles_metadata' => $bundlesMetadata,
  607.             'kernel.charset' => $this->getCharset(),
  608.             'kernel.container_class' => $this->getContainerClass(),
  609.         ];
  610.     }
  612.     /**
  613.      * Builds the service container.
  614.      *
  615.      * @return ContainerBuilder The compiled service container
  616.      *
  617.      * @throws \RuntimeException
  618.      */
  619.     protected function buildContainer()
  620.     {
  621.         foreach (['cache' => $this->warmupDir ?: $this->getCacheDir(), 'logs' => $this->getLogDir()] as $name => $dir) {
  622.             if (!is_dir($dir)) {
  623.                 if (false === @mkdir($dir, 0777, true) && !is_dir($dir)) {
  624.                     throw new \RuntimeException(sprintf("Unable to create the %s directory (%s)\n", $name, $dir));
  625.                 }
  626.             } elseif (!is_writable($dir)) {
  627.                 throw new \RuntimeException(sprintf("Unable to write in the %s directory (%s)\n", $name, $dir));
  628.             }
  629.         }
  631.         $container = $this->getContainerBuilder();
  632.         $container->addObjectResource($this);
  633.         $this->prepareContainer($container);
  635.         if (null !== $cont = $this->registerContainerConfiguration($this->getContainerLoader($container))) {
  636.             $container->merge($cont);
  637.         }
  639.         $container->addCompilerPass(new AddAnnotatedClassesToCachePass($this));
  641.         return $container;
  642.     }
  644.     /**
  645.      * Prepares the ContainerBuilder before it is compiled.
  646.      */
  647.     protected function prepareContainer(ContainerBuilder $container)
  648.     {
  649.         $extensions = [];
  650.         foreach ($this->bundles as $bundle) {
  651.             if ($extension = $bundle->getContainerExtension()) {
  652.                 $container->registerExtension($extension);
  653.             }
  655.             if ($this->debug) {
  656.                 $container->addObjectResource($bundle);
  657.             }
  658.         }
  660.         foreach ($this->bundles as $bundle) {
  661.             $bundle->build($container);
  662.         }
  664.         $this->build($container);
  666.         foreach ($container->getExtensions() as $extension) {
  667.             $extensions[] = $extension->getAlias();
  668.         }
  670.         // ensure these extensions are implicitly loaded
  671.         $container->getCompilerPassConfig()->setMergePass(new MergeExtensionConfigurationPass($extensions));
  672.     }
  674.     /**
  675.      * Gets a new ContainerBuilder instance used to build the service container.
  676.      *
  677.      * @return ContainerBuilder
  678.      */
  679.     protected function getContainerBuilder()
  680.     {
  681.         $container = new ContainerBuilder();
  682.         $container->getParameterBag()->add($this->getKernelParameters());
  684.         if ($this instanceof CompilerPassInterface) {
  685.             $container->addCompilerPass($this, PassConfig::TYPE_BEFORE_OPTIMIZATION, -10000);
  686.         }
  687.         if (class_exists('ProxyManager\Configuration') && class_exists('Symfony\Bridge\ProxyManager\LazyProxy\Instantiator\RuntimeInstantiator')) {
  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_exists('Symfony\Bridge\ProxyManager\LazyProxy\PhpDumper\ProxyDumper')) {
  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.         ]);
  718.         $rootCode = array_pop($content);
  719.         $dir = \dirname($cache->getPath()).'/';
  720.         $fs = new Filesystem();
  722.         foreach ($content as $file => $code) {
  723.             $fs->dumpFile($dir.$file, $code);
  724.             @chmod($dir.$file, 0666 & ~umask());
  725.         }
  726.         $legacyFile = \dirname($dir.key($content)).'.legacy';
  727.         if (file_exists($legacyFile)) {
  728.             @unlink($legacyFile);
  729.         }
  731.         $cache->write($rootCode, $container->getResources());
  732.     }
  734.     /**
  735.      * Returns a loader for the container.
  736.      *
  737.      * @return DelegatingLoader The loader
  738.      */
  739.     protected function getContainerLoader(ContainerInterface $container)
  740.     {
  741.         $locator = new FileLocator($this);
  742.         $resolver = new LoaderResolver([
  743.             new XmlFileLoader($container, $locator),
  744.             new YamlFileLoader($container, $locator),
  745.             new IniFileLoader($container, $locator),
  746.             new PhpFileLoader($container, $locator),
  747.             new GlobFileLoader($container, $locator),
  748.             new DirectoryLoader($container, $locator),
  749.             new ClosureLoader($container),
  750.         ]);
  752.         return new DelegatingLoader($resolver);
  753.     }
  755.     /**
  756.      * Removes comments from a PHP source string.
  757.      *
  758.      * We don't use the PHP php_strip_whitespace() function
  759.      * as we want the content to be readable and well-formatted.
  760.      *
  761.      * @return string The PHP string with the comments removed
  762.      */
  763.     public static function stripComments(string $source)
  764.     {
  765.         if (!\function_exists('token_get_all')) {
  766.             return $source;
  767.         }
  769.         $rawChunk = '';
  770.         $output = '';
  771.         $tokens = token_get_all($source);
  772.         $ignoreSpace = false;
  773.         for ($i = 0; isset($tokens[$i]); ++$i) {
  774.             $token = $tokens[$i];
  775.             if (!isset($token[1]) || 'b"' === $token) {
  776.                 $rawChunk .= $token;
  777.             } elseif (T_START_HEREDOC === $token[0]) {
  778.                 $output .= $rawChunk.$token[1];
  779.                 do {
  780.                     $token = $tokens[++$i];
  781.                     $output .= isset($token[1]) && 'b"' !== $token ? $token[1] : $token;
  782.                 } while (T_END_HEREDOC !== $token[0]);
  783.                 $rawChunk = '';
  784.             } elseif (T_WHITESPACE === $token[0]) {
  785.                 if ($ignoreSpace) {
  786.                     $ignoreSpace = false;
  788.                     continue;
  789.                 }
  791.                 // replace multiple new lines with a single newline
  792.                 $rawChunk .= preg_replace(['/\n{2,}/S'], "\n", $token[1]);
  793.             } elseif (\in_array($token[0], [T_COMMENT, T_DOC_COMMENT])) {
  794.                 $ignoreSpace = true;
  795.             } else {
  796.                 $rawChunk .= $token[1];
  798.                 // The PHP-open tag already has a new-line
  799.                 if (T_OPEN_TAG === $token[0]) {
  800.                     $ignoreSpace = true;
  801.                 }
  802.             }
  803.         }
  805.         $output .= $rawChunk;
  807.         unset($tokens, $rawChunk);
  808.         gc_mem_caches();
  810.         return $output;
  811.     }
  813.     /**
  814.      * @return array
  815.      */
  816.     public function __sleep()
  817.     {
  818.         return ['environment', 'debug'];
  819.     }
  821.     public function __wakeup()
  822.     {
  823.         $this->__construct($this->environment, $this->debug);
  824.     }
  825. }