vendor/symfony/framework-bundle/Routing/Router.php line 65

  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\Bundle\FrameworkBundle\Routing;
  14. use Psr\Container\ContainerInterface;
  15. use Psr\Log\LoggerInterface;
  16. use Symfony\Component\Config\Loader\LoaderInterface;
  17. use Symfony\Component\Config\Resource\FileExistenceResource;
  18. use Symfony\Component\Config\Resource\FileResource;
  19. use Symfony\Component\DependencyInjection\Config\ContainerParametersResource;
  20. use Symfony\Component\DependencyInjection\ContainerInterface as SymfonyContainerInterface;
  21. use Symfony\Component\DependencyInjection\Exception\ParameterNotFoundException;
  22. use Symfony\Component\DependencyInjection\Exception\RuntimeException;
  23. use Symfony\Component\HttpKernel\CacheWarmer\WarmableInterface;
  24. use Symfony\Component\Routing\RequestContext;
  25. use Symfony\Component\Routing\RouteCollection;
  26. use Symfony\Component\Routing\Router as BaseRouter;
  27. use Symfony\Contracts\Service\ServiceSubscriberInterface;
  29. /**
  30.  * This Router creates the Loader only when the cache is empty.
  31.  *
  32.  * @author Fabien Potencier <fabien@symfony.com>
  33.  */
  34. class Router extends BaseRouter implements WarmableInterface, ServiceSubscriberInterface
  35. {
  36.     private ContainerInterface $container;
  37.     private array $collectedParameters = [];
  38.     private \Closure $paramFetcher;
  40.     /**
  41.      * @param mixed $resource The main resource to load
  42.      */
  43.     public function __construct(ContainerInterface $container, mixed $resource, array $options = [], RequestContext $context = null, ContainerInterface $parameters = null, LoggerInterface $logger = null, string $defaultLocale = null)
  44.     {
  45.         $this->container = $container;
  46.         $this->resource = $resource;
  47.         $this->context = $context ?? new RequestContext();
  48.         $this->logger = $logger;
  49.         $this->setOptions($options);
  51.         if ($parameters) {
  52.             $this->paramFetcher = $parameters->get(...);
  53.         } elseif ($container instanceof SymfonyContainerInterface) {
  54.             $this->paramFetcher = $container->getParameter(...);
  55.         } else {
  56.             throw new \LogicException(sprintf('You should either pass a "%s" instance or provide the $parameters argument of the "%s" method.', SymfonyContainerInterface::class, __METHOD__));
  57.         }
  59.         $this->defaultLocale = $defaultLocale;
  60.     }
  62.     public function getRouteCollection(): RouteCollection
  63.     {
  64.         if (null === $this->collection) {
  65.             $this->collection = $this->container->get('routing.loader')->load($this->resource, $this->options['resource_type']);
  66.             $this->resolveParameters($this->collection);
  67.             $this->collection->addResource(new ContainerParametersResource($this->collectedParameters));
  69.             try {
  70.                 $containerFile = ($this->paramFetcher)('kernel.cache_dir').'/'.($this->paramFetcher)('kernel.container_class').'.php';
  71.                 if (file_exists($containerFile)) {
  72.                     $this->collection->addResource(new FileResource($containerFile));
  73.                 } else {
  74.                     $this->collection->addResource(new FileExistenceResource($containerFile));
  75.                 }
  76.             } catch (ParameterNotFoundException) {
  77.             }
  78.         }
  80.         return $this->collection;
  81.     }
  83.     /**
  84.      * @return string[] A list of classes to preload on PHP 7.4+
  85.      */
  86.     public function warmUp(string $cacheDir): array
  87.     {
  88.         $currentDir = $this->getOption('cache_dir');
  90.         // force cache generation
  91.         $this->setOption('cache_dir', $cacheDir);
  92.         $this->getMatcher();
  93.         $this->getGenerator();
  95.         $this->setOption('cache_dir', $currentDir);
  97.         return [
  98.             $this->getOption('generator_class'),
  99.             $this->getOption('matcher_class'),
  100.         ];
  101.     }
  103.     /**
  104.      * Replaces placeholders with service container parameter values in:
  105.      * - the route defaults,
  106.      * - the route requirements,
  107.      * - the route path,
  108.      * - the route host,
  109.      * - the route schemes,
  110.      * - the route methods.
  111.      */
  112.     private function resolveParameters(RouteCollection $collection)
  113.     {
  114.         foreach ($collection as $route) {
  115.             foreach ($route->getDefaults() as $name => $value) {
  116.                 $route->setDefault($name, $this->resolve($value));
  117.             }
  119.             foreach ($route->getRequirements() as $name => $value) {
  120.                 $route->setRequirement($name, $this->resolve($value));
  121.             }
  123.             $route->setPath($this->resolve($route->getPath()));
  124.             $route->setHost($this->resolve($route->getHost()));
  126.             $schemes = [];
  127.             foreach ($route->getSchemes() as $scheme) {
  128.                 $schemes[] = explode('|', $this->resolve($scheme));
  129.             }
  130.             $route->setSchemes(array_merge([], ...$schemes));
  132.             $methods = [];
  133.             foreach ($route->getMethods() as $method) {
  134.                 $methods[] = explode('|', $this->resolve($method));
  135.             }
  136.             $route->setMethods(array_merge([], ...$methods));
  137.             $route->setCondition($this->resolve($route->getCondition()));
  138.         }
  139.     }
  141.     /**
  142.      * Recursively replaces %placeholders% with the service container parameters.
  143.      *
  144.      * @throws ParameterNotFoundException When a placeholder does not exist as a container parameter
  145.      * @throws RuntimeException           When a container value is not a string or a numeric value
  146.      */
  147.     private function resolve(mixed $value): mixed
  148.     {
  149.         if (\is_array($value)) {
  150.             foreach ($value as $key => $val) {
  151.                 $value[$key] = $this->resolve($val);
  152.             }
  154.             return $value;
  155.         }
  157.         if (!\is_string($value)) {
  158.             return $value;
  159.         }
  161.         $escapedValue = preg_replace_callback('/%%|%([^%\s]++)%/', function ($match) use ($value) {
  162.             // skip %%
  163.             if (!isset($match[1])) {
  164.                 return '%%';
  165.             }
  167.             if (preg_match('/^env\((?:\w++:)*+\w++\)$/', $match[1])) {
  168.                 throw new RuntimeException(sprintf('Using "%%%s%%" is not allowed in routing configuration.', $match[1]));
  169.             }
  171.             $resolved = ($this->paramFetcher)($match[1]);
  173.             if (\is_scalar($resolved)) {
  174.                 $this->collectedParameters[$match[1]] = $resolved;
  176.                 if (\is_string($resolved)) {
  177.                     $resolved = $this->resolve($resolved);
  178.                 }
  180.                 if (\is_scalar($resolved)) {
  181.                     return false === $resolved ? '0' : (string) $resolved;
  182.                 }
  183.             }
  185.             throw new RuntimeException(sprintf('The container parameter "%s", used in the route configuration value "%s", must be a string or numeric, but it is of type "%s".', $match[1], $value, get_debug_type($resolved)));
  186.         }, $value);
  188.         return str_replace('%%', '%', $escapedValue);
  189.     }
  191.     public static function getSubscribedServices(): array
  192.     {
  193.         return [
  194.             'routing.loader' => LoaderInterface::class,
  195.         ];
  196.     }
  197. }