vendor/symfony/symfony/src/Symfony/Component/HttpKernel/Kernel.php line 200

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\DependencyInjection\Compiler\CompilerPassInterface;
  17. use Symfony\Component\DependencyInjection\Compiler\PassConfig;
  18. use Symfony\Component\DependencyInjection\ContainerInterface;
  19. use Symfony\Component\DependencyInjection\ContainerBuilder;
  20. use Symfony\Component\DependencyInjection\Dumper\PhpDumper;
  21. use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
  22. use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
  23. use Symfony\Component\DependencyInjection\Loader\IniFileLoader;
  24. use Symfony\Component\DependencyInjection\Loader\PhpFileLoader;
  25. use Symfony\Component\DependencyInjection\Loader\GlobFileLoader;
  26. use Symfony\Component\DependencyInjection\Loader\DirectoryLoader;
  27. use Symfony\Component\DependencyInjection\Loader\ClosureLoader;
  28. use Symfony\Component\Filesystem\Filesystem;
  29. use Symfony\Component\HttpFoundation\Request;
  30. use Symfony\Component\HttpFoundation\Response;
  31. use Symfony\Component\HttpKernel\Bundle\BundleInterface;
  32. use Symfony\Component\HttpKernel\Config\EnvParametersResource;
  33. use Symfony\Component\HttpKernel\Config\FileLocator;
  34. use Symfony\Component\HttpKernel\DependencyInjection\MergeExtensionConfigurationPass;
  35. use Symfony\Component\HttpKernel\DependencyInjection\AddAnnotatedClassesToCachePass;
  36. use Symfony\Component\Config\Loader\LoaderResolver;
  37. use Symfony\Component\Config\Loader\DelegatingLoader;
  38. use Symfony\Component\Config\ConfigCache;
  39. use Symfony\Component\ClassLoader\ClassCollectionLoader;
  41. /**
  42.  * The Kernel is the heart of the Symfony system.
  43.  *
  44.  * It manages an environment made of bundles.
  45.  *
  46.  * @author Fabien Potencier <fabien@symfony.com>
  47.  */
  48. abstract class Kernel implements KernelInterface, RebootableInterface, TerminableInterface
  49. {
  50.     /**
  51.      * @var BundleInterface[]
  52.      */
  53.     protected $bundles = array();
  55.     protected $bundleMap;
  56.     protected $container;
  57.     protected $rootDir;
  58.     protected $environment;
  59.     protected $debug;
  60.     protected $booted = false;
  61.     protected $name;
  62.     protected $startTime;
  63.     protected $loadClassCache;
  65.     private $projectDir;
  66.     private $warmupDir;
  67.     private $requestStackSize = 0;
  68.     private $resetServices = false;
  70.     const VERSION = '3.4.12';
  71.     const VERSION_ID = 30412;
  72.     const MAJOR_VERSION = 3;
  73.     const MINOR_VERSION = 4;
  74.     const RELEASE_VERSION = 12;
  75.     const EXTRA_VERSION = '';
  77.     const END_OF_MAINTENANCE = '11/2020';
  78.     const END_OF_LIFE = '11/2021';
  80.     /**
  81.      * @param string $environment The environment
  82.      * @param bool   $debug       Whether to enable debugging or not
  83.      */
  84.     public function __construct($environment, $debug)
  85.     {
  86.         $this->environment = $environment;
  87.         $this->debug = (bool) $debug;
  88.         $this->rootDir = $this->getRootDir();
  89.         $this->name = $this->getName();
  90.     }
  92.     public function __clone()
  93.     {
  94.         $this->booted = false;
  95.         $this->container = null;
  96.         $this->requestStackSize = 0;
  97.         $this->resetServices = false;
  98.     }
  100.     /**
  101.      * Boots the current kernel.
  102.      */
  103.     public function boot()
  104.     {
  105.         if (true === $this->booted) {
  106.             if (!$this->requestStackSize && $this->resetServices) {
  107.                 if ($this->container->has('services_resetter')) {
  108.                     $this->container->get('services_resetter')->reset();
  109.                 }
  110.                 $this->resetServices = false;
  111.                 if ($this->debug) {
  112.                     $this->startTime = microtime(true);
  113.                 }
  114.             }
  116.             return;
  117.         }
  118.         if ($this->debug) {
  119.             $this->startTime = microtime(true);
  120.         }
  121.         if ($this->debug && !isset($_ENV['SHELL_VERBOSITY']) && !isset($_SERVER['SHELL_VERBOSITY'])) {
  122.             putenv('SHELL_VERBOSITY=3');
  123.             $_ENV['SHELL_VERBOSITY'] = 3;
  124.             $_SERVER['SHELL_VERBOSITY'] = 3;
  125.         }
  127.         if ($this->loadClassCache) {
  128.             $this->doLoadClassCache($this->loadClassCache[0], $this->loadClassCache[1]);
  129.         }
  131.         // init bundles
  132.         $this->initializeBundles();
  134.         // init container
  135.         $this->initializeContainer();
  137.         foreach ($this->getBundles() as $bundle) {
  138.             $bundle->setContainer($this->container);
  139.             $bundle->boot();
  140.         }
  142.         $this->booted = true;
  143.     }
  145.     /**
  146.      * {@inheritdoc}
  147.      */
  148.     public function reboot($warmupDir)
  149.     {
  150.         $this->shutdown();
  151.         $this->warmupDir = $warmupDir;
  152.         $this->boot();
  153.     }
  155.     /**
  156.      * {@inheritdoc}
  157.      */
  158.     public function terminate(Request $request, Response $response)
  159.     {
  160.         if (false === $this->booted) {
  161.             return;
  162.         }
  164.         if ($this->getHttpKernel() instanceof TerminableInterface) {
  165.             $this->getHttpKernel()->terminate($request, $response);
  166.         }
  167.     }
  169.     /**
  170.      * {@inheritdoc}
  171.      */
  172.     public function shutdown()
  173.     {
  174.         if (false === $this->booted) {
  175.             return;
  176.         }
  178.         $this->booted = false;
  180.         foreach ($this->getBundles() as $bundle) {
  181.             $bundle->shutdown();
  182.             $bundle->setContainer(null);
  183.         }
  185.         $this->container = null;
  186.         $this->requestStackSize = 0;
  187.         $this->resetServices = false;
  188.     }
  190.     /**
  191.      * {@inheritdoc}
  192.      */
  193.     public function handle(Request $request, $type = HttpKernelInterface::MASTER_REQUEST, $catch = true)
  194.     {
  195.         $this->boot();
  196.         ++$this->requestStackSize;
  197.         $this->resetServices = true;
  199.         try {
  200.             return $this->getHttpKernel()->handle($request, $type, $catch);
  201.         } finally {
  202.             --$this->requestStackSize;
  203.         }
  204.     }
  206.     /**
  207.      * Gets a HTTP kernel from the container.
  208.      *
  209.      * @return HttpKernel
  210.      */
  211.     protected function getHttpKernel()
  212.     {
  213.         return $this->container->get('http_kernel');
  214.     }
  216.     /**
  217.      * {@inheritdoc}
  218.      */
  219.     public function getBundles()
  220.     {
  221.         return $this->bundles;
  222.     }
  224.     /**
  225.      * {@inheritdoc}
  226.      */
  227.     public function getBundle($name, $first = true/*, $noDeprecation = false */)
  228.     {
  229.         $noDeprecation = false;
  230.         if (func_num_args() >= 3) {
  231.             $noDeprecation = func_get_arg(2);
  232.         }
  234.         if (!$first && !$noDeprecation) {
  235.             @trigger_error(sprintf('Passing "false" as the second argument to %s() is deprecated as of 3.4 and will be removed in 4.0.', __METHOD__), E_USER_DEPRECATED);
  236.         }
  238.         if (!isset($this->bundleMap[$name])) {
  239.             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_class($this)));
  240.         }
  242.         if (true === $first) {
  243.             return $this->bundleMap[$name][0];
  244.         }
  246.         return $this->bundleMap[$name];
  247.     }
  249.     /**
  250.      * {@inheritdoc}
  251.      *
  252.      * @throws \RuntimeException if a custom resource is hidden by a resource in a derived bundle
  253.      */
  254.     public function locateResource($name, $dir = null, $first = true)
  255.     {
  256.         if ('@' !== $name[0]) {
  257.             throw new \InvalidArgumentException(sprintf('A resource name must start with @ ("%s" given).', $name));
  258.         }
  260.         if (false !== strpos($name, '..')) {
  261.             throw new \RuntimeException(sprintf('File name "%s" contains invalid characters (..).', $name));
  262.         }
  264.         $bundleName = substr($name, 1);
  265.         $path = '';
  266.         if (false !== strpos($bundleName, '/')) {
  267.             list($bundleName, $path) = explode('/', $bundleName, 2);
  268.         }
  270.         $isResource = 0 === strpos($path, 'Resources') && null !== $dir;
  271.         $overridePath = substr($path, 9);
  272.         $resourceBundle = null;
  273.         $bundles = $this->getBundle($bundleName, false, true);
  274.         $files = array();
  276.         foreach ($bundles as $bundle) {
  277.             if ($isResource && file_exists($file = $dir.'/'.$bundle->getName().$overridePath)) {
  278.                 if (null !== $resourceBundle) {
  279.                     throw new \RuntimeException(sprintf('"%s" resource is hidden by a resource from the "%s" derived bundle. Create a "%s" file to override the bundle resource.',
  280.                         $file,
  281.                         $resourceBundle,
  282.                         $dir.'/'.$bundles[0]->getName().$overridePath
  283.                     ));
  284.                 }
  286.                 if ($first) {
  287.                     return $file;
  288.                 }
  289.                 $files[] = $file;
  290.             }
  292.             if (file_exists($file = $bundle->getPath().'/'.$path)) {
  293.                 if ($first && !$isResource) {
  294.                     return $file;
  295.                 }
  296.                 $files[] = $file;
  297.                 $resourceBundle = $bundle->getName();
  298.             }
  299.         }
  301.         if (count($files) > 0) {
  302.             return $first && $isResource ? $files[0] : $files;
  303.         }
  305.         throw new \InvalidArgumentException(sprintf('Unable to find file "%s".', $name));
  306.     }
  308.     /**
  309.      * {@inheritdoc}
  310.      */
  311.     public function getName()
  312.     {
  313.         if (null === $this->name) {
  314.             $this->name = preg_replace('/[^a-zA-Z0-9_]+/', '', basename($this->rootDir));
  315.             if (ctype_digit($this->name[0])) {
  316.                 $this->name = '_'.$this->name;
  317.             }
  318.         }
  320.         return $this->name;
  321.     }
  323.     /**
  324.      * {@inheritdoc}
  325.      */
  326.     public function getEnvironment()
  327.     {
  328.         return $this->environment;
  329.     }
  331.     /**
  332.      * {@inheritdoc}
  333.      */
  334.     public function isDebug()
  335.     {
  336.         return $this->debug;
  337.     }
  339.     /**
  340.      * {@inheritdoc}
  341.      */
  342.     public function getRootDir()
  343.     {
  344.         if (null === $this->rootDir) {
  345.             $r = new \ReflectionObject($this);
  346.             $this->rootDir = dirname($r->getFileName());
  347.         }
  349.         return $this->rootDir;
  350.     }
  352.     /**
  353.      * Gets the application root dir (path of the project's composer file).
  354.      *
  355.      * @return string The project root dir
  356.      */
  357.     public function getProjectDir()
  358.     {
  359.         if (null === $this->projectDir) {
  360.             $r = new \ReflectionObject($this);
  361.             $dir = $rootDir = dirname($r->getFileName());
  362.             while (!file_exists($dir.'/composer.json')) {
  363.                 if ($dir === dirname($dir)) {
  364.                     return $this->projectDir = $rootDir;
  365.                 }
  366.                 $dir = dirname($dir);
  367.             }
  368.             $this->projectDir = $dir;
  369.         }
  371.         return $this->projectDir;
  372.     }
  374.     /**
  375.      * {@inheritdoc}
  376.      */
  377.     public function getContainer()
  378.     {
  379.         return $this->container;
  380.     }
  382.     /**
  383.      * Loads the PHP class cache.
  384.      *
  385.      * This methods only registers the fact that you want to load the cache classes.
  386.      * The cache will actually only be loaded when the Kernel is booted.
  387.      *
  388.      * That optimization is mainly useful when using the HttpCache class in which
  389.      * case the class cache is not loaded if the Response is in the cache.
  390.      *
  391.      * @param string $name      The cache name prefix
  392.      * @param string $extension File extension of the resulting file
  393.      *
  394.      * @deprecated since version 3.3, to be removed in 4.0. The class cache is not needed anymore when using PHP 7.0.
  395.      */
  396.     public function loadClassCache($name = 'classes', $extension = '.php')
  397.     {
  398.         if (\PHP_VERSION_ID >= 70000) {
  399.             @trigger_error(__METHOD__.'() is deprecated since Symfony 3.3, to be removed in 4.0.', E_USER_DEPRECATED);
  400.         }
  402.         $this->loadClassCache = array($name, $extension);
  403.     }
  405.     /**
  406.      * @internal
  407.      *
  408.      * @deprecated since version 3.3, to be removed in 4.0.
  409.      */
  410.     public function setClassCache(array $classes)
  411.     {
  412.         if (\PHP_VERSION_ID >= 70000) {
  413.             @trigger_error(__METHOD__.'() is deprecated since Symfony 3.3, to be removed in 4.0.', E_USER_DEPRECATED);
  414.         }
  416.         file_put_contents(($this->warmupDir ?: $this->getCacheDir()).'/classes.map', sprintf('<?php return %s;', var_export($classes, true)));
  417.     }
  419.     /**
  420.      * @internal
  421.      */
  422.     public function setAnnotatedClassCache(array $annotatedClasses)
  423.     {
  424.         file_put_contents(($this->warmupDir ?: $this->getCacheDir()).'/annotations.map', sprintf('<?php return %s;', var_export($annotatedClasses, true)));
  425.     }
  427.     /**
  428.      * {@inheritdoc}
  429.      */
  430.     public function getStartTime()
  431.     {
  432.         return $this->debug ? $this->startTime : -INF;
  433.     }
  435.     /**
  436.      * {@inheritdoc}
  437.      */
  438.     public function getCacheDir()
  439.     {
  440.         return $this->rootDir.'/cache/'.$this->environment;
  441.     }
  443.     /**
  444.      * {@inheritdoc}
  445.      */
  446.     public function getLogDir()
  447.     {
  448.         return $this->rootDir.'/logs';
  449.     }
  451.     /**
  452.      * {@inheritdoc}
  453.      */
  454.     public function getCharset()
  455.     {
  456.         return 'UTF-8';
  457.     }
  459.     /**
  460.      * @deprecated since version 3.3, to be removed in 4.0.
  461.      */
  462.     protected function doLoadClassCache($name, $extension)
  463.     {
  464.         if (\PHP_VERSION_ID >= 70000) {
  465.             @trigger_error(__METHOD__.'() is deprecated since Symfony 3.3, to be removed in 4.0.', E_USER_DEPRECATED);
  466.         }
  467.         $cacheDir = $this->warmupDir ?: $this->getCacheDir();
  469.         if (!$this->booted && is_file($cacheDir.'/classes.map')) {
  470.             ClassCollectionLoader::load(include($cacheDir.'/classes.map'), $cacheDir, $name, $this->debug, false, $extension);
  471.         }
  472.     }
  474.     /**
  475.      * Initializes the data structures related to the bundle management.
  476.      *
  477.      *  - the bundles property maps a bundle name to the bundle instance,
  478.      *  - the bundleMap property maps a bundle name to the bundle inheritance hierarchy (most derived bundle first).
  479.      *
  480.      * @throws \LogicException if two bundles share a common name
  481.      * @throws \LogicException if a bundle tries to extend a non-registered bundle
  482.      * @throws \LogicException if a bundle tries to extend itself
  483.      * @throws \LogicException if two bundles extend the same ancestor
  484.      */
  485.     protected function initializeBundles()
  486.     {
  487.         // init bundles
  488.         $this->bundles = array();
  489.         $topMostBundles = array();
  490.         $directChildren = array();
  492.         foreach ($this->registerBundles() as $bundle) {
  493.             $name = $bundle->getName();
  494.             if (isset($this->bundles[$name])) {
  495.                 throw new \LogicException(sprintf('Trying to register two bundles with the same name "%s"', $name));
  496.             }
  497.             $this->bundles[$name] = $bundle;
  499.             if ($parentName = $bundle->getParent()) {
  500.                 @trigger_error('Bundle inheritance is deprecated as of 3.4 and will be removed in 4.0.', E_USER_DEPRECATED);
  502.                 if (isset($directChildren[$parentName])) {
  503.                     throw new \LogicException(sprintf('Bundle "%s" is directly extended by two bundles "%s" and "%s".', $parentName, $name, $directChildren[$parentName]));
  504.                 }
  505.                 if ($parentName == $name) {
  506.                     throw new \LogicException(sprintf('Bundle "%s" can not extend itself.', $name));
  507.                 }
  508.                 $directChildren[$parentName] = $name;
  509.             } else {
  510.                 $topMostBundles[$name] = $bundle;
  511.             }
  512.         }
  514.         // look for orphans
  515.         if (!empty($directChildren) && count($diff = array_diff_key($directChildren, $this->bundles))) {
  516.             $diff = array_keys($diff);
  518.             throw new \LogicException(sprintf('Bundle "%s" extends bundle "%s", which is not registered.', $directChildren[$diff[0]], $diff[0]));
  519.         }
  521.         // inheritance
  522.         $this->bundleMap = array();
  523.         foreach ($topMostBundles as $name => $bundle) {
  524.             $bundleMap = array($bundle);
  525.             $hierarchy = array($name);
  527.             while (isset($directChildren[$name])) {
  528.                 $name = $directChildren[$name];
  529.                 array_unshift($bundleMap, $this->bundles[$name]);
  530.                 $hierarchy[] = $name;
  531.             }
  533.             foreach ($hierarchy as $hierarchyBundle) {
  534.                 $this->bundleMap[$hierarchyBundle] = $bundleMap;
  535.                 array_pop($bundleMap);
  536.             }
  537.         }
  538.     }
  540.     /**
  541.      * The extension point similar to the Bundle::build() method.
  542.      *
  543.      * Use this method to register compiler passes and manipulate the container during the building process.
  544.      */
  545.     protected function build(ContainerBuilder $container)
  546.     {
  547.     }
  549.     /**
  550.      * Gets the container class.
  551.      *
  552.      * @return string The container class
  553.      */
  554.     protected function getContainerClass()
  555.     {
  556.         return $this->name.ucfirst($this->environment).($this->debug ? 'Debug' : '').'ProjectContainer';
  557.     }
  559.     /**
  560.      * Gets the container's base class.
  561.      *
  562.      * All names except Container must be fully qualified.
  563.      *
  564.      * @return string
  565.      */
  566.     protected function getContainerBaseClass()
  567.     {
  568.         return 'Container';
  569.     }
  571.     /**
  572.      * Initializes the service container.
  573.      *
  574.      * The cached version of the service container is used when fresh, otherwise the
  575.      * container is built.
  576.      */
  577.     protected function initializeContainer()
  578.     {
  579.         $class = $this->getContainerClass();
  580.         $cacheDir = $this->warmupDir ?: $this->getCacheDir();
  581.         $cache = new ConfigCache($cacheDir.'/'.$class.'.php', $this->debug);
  582.         $oldContainer = null;
  583.         if ($fresh = $cache->isFresh()) {
  584.             // Silence E_WARNING to ignore "include" failures - don't use "@" to prevent silencing fatal errors
  585.             $errorLevel = error_reporting(\E_ALL ^ \E_WARNING);
  586.             $fresh = $oldContainer = false;
  587.             try {
  588.                 if (file_exists($cache->getPath()) && \is_object($this->container = include $cache->getPath())) {
  589.                     $this->container->set('kernel', $this);
  590.                     $oldContainer = $this->container;
  591.                     $fresh = true;
  592.                 }
  593.             } catch (\Throwable $e) {
  594.             } catch (\Exception $e) {
  595.             } finally {
  596.                 error_reporting($errorLevel);
  597.             }
  598.         }
  600.         if ($fresh) {
  601.             return;
  602.         }
  604.         if ($this->debug) {
  605.             $collectedLogs = array();
  606.             $previousHandler = defined('PHPUNIT_COMPOSER_INSTALL');
  607.             $previousHandler = $previousHandler ?: set_error_handler(function ($type, $message, $file, $line) use (&$collectedLogs, &$previousHandler) {
  608.                 if (E_USER_DEPRECATED !== $type && E_DEPRECATED !== $type) {
  609.                     return $previousHandler ? $previousHandler($type, $message, $file, $line) : false;
  610.                 }
  612.                 if (isset($collectedLogs[$message])) {
  613.                     ++$collectedLogs[$message]['count'];
  615.                     return;
  616.                 }
  618.                 $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 3);
  619.                 // Clean the trace by removing first frames added by the error handler itself.
  620.                 for ($i = 0; isset($backtrace[$i]); ++$i) {
  621.                     if (isset($backtrace[$i]['file'], $backtrace[$i]['line']) && $backtrace[$i]['line'] === $line && $backtrace[$i]['file'] === $file) {
  622.                         $backtrace = array_slice($backtrace, 1 + $i);
  623.                         break;
  624.                     }
  625.                 }
  627.                 $collectedLogs[$message] = array(
  628.                     'type' => $type,
  629.                     'message' => $message,
  630.                     'file' => $file,
  631.                     'line' => $line,
  632.                     'trace' => $backtrace,
  633.                     'count' => 1,
  634.                 );
  635.             });
  636.         }
  638.         try {
  639.             $container = null;
  640.             $container = $this->buildContainer();
  641.             $container->compile();
  642.         } finally {
  643.             if ($this->debug && true !== $previousHandler) {
  644.                 restore_error_handler();
  646.                 file_put_contents($cacheDir.'/'.$class.'Deprecations.log', serialize(array_values($collectedLogs)));
  647.                 file_put_contents($cacheDir.'/'.$class.'Compiler.log', null !== $container ? implode("\n", $container->getCompiler()->getLog()) : '');
  648.             }
  649.         }
  651.         if (null === $oldContainer && file_exists($cache->getPath())) {
  652.             $errorLevel = error_reporting(\E_ALL ^ \E_WARNING);
  653.             try {
  654.                 $oldContainer = include $cache->getPath();
  655.             } catch (\Throwable $e) {
  656.             } catch (\Exception $e) {
  657.             } finally {
  658.                 error_reporting($errorLevel);
  659.             }
  660.         }
  661.         $oldContainer = is_object($oldContainer) ? new \ReflectionClass($oldContainer) : false;
  663.         $this->dumpContainer($cache, $container, $class, $this->getContainerBaseClass());
  664.         $this->container = require $cache->getPath();
  665.         $this->container->set('kernel', $this);
  667.         if ($oldContainer && get_class($this->container) !== $oldContainer->name) {
  668.             // Because concurrent requests might still be using them,
  669.             // old container files are not removed immediately,
  670.             // but on a next dump of the container.
  671.             static $legacyContainers = array();
  672.             $oldContainerDir = dirname($oldContainer->getFileName());
  673.             $legacyContainers[$oldContainerDir.'.legacy'] = true;
  674.             foreach (glob(dirname($oldContainerDir).DIRECTORY_SEPARATOR.'*.legacy') as $legacyContainer) {
  675.                 if (!isset($legacyContainers[$legacyContainer]) && @unlink($legacyContainer)) {
  676.                     (new Filesystem())->remove(substr($legacyContainer, 0, -7));
  677.                 }
  678.             }
  680.             touch($oldContainerDir.'.legacy');
  681.         }
  683.         if ($this->container->has('cache_warmer')) {
  684.             $this->container->get('cache_warmer')->warmUp($this->container->getParameter('kernel.cache_dir'));
  685.         }
  686.     }
  688.     /**
  689.      * Returns the kernel parameters.
  690.      *
  691.      * @return array An array of kernel parameters
  692.      */
  693.     protected function getKernelParameters()
  694.     {
  695.         $bundles = array();
  696.         $bundlesMetadata = array();
  698.         foreach ($this->bundles as $name => $bundle) {
  699.             $bundles[$name] = get_class($bundle);
  700.             $bundlesMetadata[$name] = array(
  701.                 'parent' => $bundle->getParent(),
  702.                 'path' => $bundle->getPath(),
  703.                 'namespace' => $bundle->getNamespace(),
  704.             );
  705.         }
  707.         return array_merge(
  708.             array(
  709.                 'kernel.root_dir' => realpath($this->rootDir) ?: $this->rootDir,
  710.                 'kernel.project_dir' => realpath($this->getProjectDir()) ?: $this->getProjectDir(),
  711.                 'kernel.environment' => $this->environment,
  712.                 'kernel.debug' => $this->debug,
  713.                 'kernel.name' => $this->name,
  714.                 'kernel.cache_dir' => realpath($cacheDir = $this->warmupDir ?: $this->getCacheDir()) ?: $cacheDir,
  715.                 'kernel.logs_dir' => realpath($this->getLogDir()) ?: $this->getLogDir(),
  716.                 'kernel.bundles' => $bundles,
  717.                 'kernel.bundles_metadata' => $bundlesMetadata,
  718.                 'kernel.charset' => $this->getCharset(),
  719.                 'kernel.container_class' => $this->getContainerClass(),
  720.             ),
  721.             $this->getEnvParameters(false)
  722.         );
  723.     }
  725.     /**
  726.      * Gets the environment parameters.
  727.      *
  728.      * Only the parameters starting with "SYMFONY__" are considered.
  729.      *
  730.      * @return array An array of parameters
  731.      *
  732.      * @deprecated since version 3.3, to be removed in 4.0
  733.      */
  734.     protected function getEnvParameters()
  735.     {
  736.         if (0 === func_num_args() || func_get_arg(0)) {
  737.             @trigger_error(sprintf('The %s() method is deprecated as of 3.3 and will be removed in 4.0. Use the %%env()%% syntax to get the value of any environment variable from configuration files instead.', __METHOD__), E_USER_DEPRECATED);
  738.         }
  740.         $parameters = array();
  741.         foreach ($_SERVER as $key => $value) {
  742.             if (0 === strpos($key, 'SYMFONY__')) {
  743.                 @trigger_error(sprintf('The support of special environment variables that start with SYMFONY__ (such as "%s") is deprecated as of 3.3 and will be removed in 4.0. Use the %%env()%% syntax instead to get the value of environment variables in configuration files.', $key), E_USER_DEPRECATED);
  744.                 $parameters[strtolower(str_replace('__', '.', substr($key, 9)))] = $value;
  745.             }
  746.         }
  748.         return $parameters;
  749.     }
  751.     /**
  752.      * Builds the service container.
  753.      *
  754.      * @return ContainerBuilder The compiled service container
  755.      *
  756.      * @throws \RuntimeException
  757.      */
  758.     protected function buildContainer()
  759.     {
  760.         foreach (array('cache' => $this->warmupDir ?: $this->getCacheDir(), 'logs' => $this->getLogDir()) as $name => $dir) {
  761.             if (!is_dir($dir)) {
  762.                 if (false === @mkdir($dir, 0777, true) && !is_dir($dir)) {
  763.                     throw new \RuntimeException(sprintf("Unable to create the %s directory (%s)\n", $name, $dir));
  764.                 }
  765.             } elseif (!is_writable($dir)) {
  766.                 throw new \RuntimeException(sprintf("Unable to write in the %s directory (%s)\n", $name, $dir));
  767.             }
  768.         }
  770.         $container = $this->getContainerBuilder();
  771.         $container->addObjectResource($this);
  772.         $this->prepareContainer($container);
  774.         if (null !== $cont = $this->registerContainerConfiguration($this->getContainerLoader($container))) {
  775.             $container->merge($cont);
  776.         }
  778.         $container->addCompilerPass(new AddAnnotatedClassesToCachePass($this));
  779.         $container->addResource(new EnvParametersResource('SYMFONY__'));
  781.         return $container;
  782.     }
  784.     /**
  785.      * Prepares the ContainerBuilder before it is compiled.
  786.      */
  787.     protected function prepareContainer(ContainerBuilder $container)
  788.     {
  789.         $extensions = array();
  790.         foreach ($this->bundles as $bundle) {
  791.             if ($extension = $bundle->getContainerExtension()) {
  792.                 $container->registerExtension($extension);
  793.             }
  795.             if ($this->debug) {
  796.                 $container->addObjectResource($bundle);
  797.             }
  798.         }
  800.         foreach ($this->bundles as $bundle) {
  801.             $bundle->build($container);
  802.         }
  804.         $this->build($container);
  806.         foreach ($container->getExtensions() as $extension) {
  807.             $extensions[] = $extension->getAlias();
  808.         }
  810.         // ensure these extensions are implicitly loaded
  811.         $container->getCompilerPassConfig()->setMergePass(new MergeExtensionConfigurationPass($extensions));
  812.     }
  814.     /**
  815.      * Gets a new ContainerBuilder instance used to build the service container.
  816.      *
  817.      * @return ContainerBuilder
  818.      */
  819.     protected function getContainerBuilder()
  820.     {
  821.         $container = new ContainerBuilder();
  822.         $container->getParameterBag()->add($this->getKernelParameters());
  824.         if ($this instanceof CompilerPassInterface) {
  825.             $container->addCompilerPass($this, PassConfig::TYPE_BEFORE_OPTIMIZATION, -10000);
  826.         }
  827.         if (class_exists('ProxyManager\Configuration') && class_exists('Symfony\Bridge\ProxyManager\LazyProxy\Instantiator\RuntimeInstantiator')) {
  828.             $container->setProxyInstantiator(new RuntimeInstantiator());
  829.         }
  831.         return $container;
  832.     }
  834.     /**
  835.      * Dumps the service container to PHP code in the cache.
  836.      *
  837.      * @param ConfigCache      $cache     The config cache
  838.      * @param ContainerBuilder $container The service container
  839.      * @param string           $class     The name of the class to generate
  840.      * @param string           $baseClass The name of the container's base class
  841.      */
  842.     protected function dumpContainer(ConfigCache $cache, ContainerBuilder $container, $class, $baseClass)
  843.     {
  844.         // cache the container
  845.         $dumper = new PhpDumper($container);
  847.         if (class_exists('ProxyManager\Configuration') && class_exists('Symfony\Bridge\ProxyManager\LazyProxy\PhpDumper\ProxyDumper')) {
  848.             $dumper->setProxyDumper(new ProxyDumper());
  849.         }
  851.         $content = $dumper->dump(array(
  852.             'class' => $class,
  853.             'base_class' => $baseClass,
  854.             'file' => $cache->getPath(),
  855.             'as_files' => true,
  856.             'debug' => $this->debug,
  857.             'inline_class_loader_parameter' => \PHP_VERSION_ID >= 70000 && !$this->loadClassCache && !class_exists(ClassCollectionLoader::class, false) ? 'container.dumper.inline_class_loader' : null,
  858.             'build_time' => $container->hasParameter('kernel.container_build_time') ? $container->getParameter('kernel.container_build_time') : time(),
  859.         ));
  861.         $rootCode = array_pop($content);
  862.         $dir = dirname($cache->getPath()).'/';
  863.         $fs = new Filesystem();
  865.         foreach ($content as $file => $code) {
  866.             $fs->dumpFile($dir.$file, $code);
  867.             @chmod($dir.$file, 0666 & ~umask());
  868.         }
  869.         @unlink(dirname($dir.$file).'.legacy');
  871.         $cache->write($rootCode, $container->getResources());
  872.     }
  874.     /**
  875.      * Returns a loader for the container.
  876.      *
  877.      * @return DelegatingLoader The loader
  878.      */
  879.     protected function getContainerLoader(ContainerInterface $container)
  880.     {
  881.         $locator = new FileLocator($this);
  882.         $resolver = new LoaderResolver(array(
  883.             new XmlFileLoader($container, $locator),
  884.             new YamlFileLoader($container, $locator),
  885.             new IniFileLoader($container, $locator),
  886.             new PhpFileLoader($container, $locator),
  887.             new GlobFileLoader($container, $locator),
  888.             new DirectoryLoader($container, $locator),
  889.             new ClosureLoader($container),
  890.         ));
  892.         return new DelegatingLoader($resolver);
  893.     }
  895.     /**
  896.      * Removes comments from a PHP source string.
  897.      *
  898.      * We don't use the PHP php_strip_whitespace() function
  899.      * as we want the content to be readable and well-formatted.
  900.      *
  901.      * @param string $source A PHP string
  902.      *
  903.      * @return string The PHP string with the comments removed
  904.      */
  905.     public static function stripComments($source)
  906.     {
  907.         if (!function_exists('token_get_all')) {
  908.             return $source;
  909.         }
  911.         $rawChunk = '';
  912.         $output = '';
  913.         $tokens = token_get_all($source);
  914.         $ignoreSpace = false;
  915.         for ($i = 0; isset($tokens[$i]); ++$i) {
  916.             $token = $tokens[$i];
  917.             if (!isset($token[1]) || 'b"' === $token) {
  918.                 $rawChunk .= $token;
  919.             } elseif (T_START_HEREDOC === $token[0]) {
  920.                 $output .= $rawChunk.$token[1];
  921.                 do {
  922.                     $token = $tokens[++$i];
  923.                     $output .= isset($token[1]) && 'b"' !== $token ? $token[1] : $token;
  924.                 } while (T_END_HEREDOC !== $token[0]);
  925.                 $rawChunk = '';
  926.             } elseif (T_WHITESPACE === $token[0]) {
  927.                 if ($ignoreSpace) {
  928.                     $ignoreSpace = false;
  930.                     continue;
  931.                 }
  933.                 // replace multiple new lines with a single newline
  934.                 $rawChunk .= preg_replace(array('/\n{2,}/S'), "\n", $token[1]);
  935.             } elseif (in_array($token[0], array(T_COMMENT, T_DOC_COMMENT))) {
  936.                 $ignoreSpace = true;
  937.             } else {
  938.                 $rawChunk .= $token[1];
  940.                 // The PHP-open tag already has a new-line
  941.                 if (T_OPEN_TAG === $token[0]) {
  942.                     $ignoreSpace = true;
  943.                 }
  944.             }
  945.         }
  947.         $output .= $rawChunk;
  949.         if (\PHP_VERSION_ID >= 70000) {
  950.             // PHP 7 memory manager will not release after token_get_all(), see https://bugs.php.net/70098
  951.             unset($tokens, $rawChunk);
  952.             gc_mem_caches();
  953.         }
  955.         return $output;
  956.     }
  958.     public function serialize()
  959.     {
  960.         return serialize(array($this->environment, $this->debug));
  961.     }
  963.     public function unserialize($data)
  964.     {
  965.         if (\PHP_VERSION_ID >= 70000) {
  966.             list($environment, $debug) = unserialize($data, array('allowed_classes' => false));
  967.         } else {
  968.             list($environment, $debug) = unserialize($data);
  969.         }
  971.         $this->__construct($environment, $debug);
  972.     }
  973. }