vendor/symfony/routing/Matcher/UrlMatcher.php line 106

  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\Routing\Matcher;
  14. use Symfony\Component\ExpressionLanguage\ExpressionFunctionProviderInterface;
  15. use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
  16. use Symfony\Component\HttpFoundation\Request;
  17. use Symfony\Component\Routing\Exception\MethodNotAllowedException;
  18. use Symfony\Component\Routing\Exception\NoConfigurationException;
  19. use Symfony\Component\Routing\Exception\ResourceNotFoundException;
  20. use Symfony\Component\Routing\RequestContext;
  21. use Symfony\Component\Routing\Route;
  22. use Symfony\Component\Routing\RouteCollection;
  24. /**
  25.  * UrlMatcher matches URL based on a set of routes.
  26.  *
  27.  * @author Fabien Potencier <fabien@symfony.com>
  28.  */
  29. class UrlMatcher implements UrlMatcherInterface, RequestMatcherInterface
  30. {
  31.     public const REQUIREMENT_MATCH = 0;
  32.     public const REQUIREMENT_MISMATCH = 1;
  33.     public const ROUTE_MATCH = 2;
  35.     /** @var RequestContext */
  36.     protected $context;
  38.     /**
  39.      * Collects HTTP methods that would be allowed for the request.
  40.      */
  41.     protected $allow = [];
  43.     /**
  44.      * Collects URI schemes that would be allowed for the request.
  45.      *
  46.      * @internal
  47.      */
  48.     protected array $allowSchemes = [];
  50.     protected $routes;
  51.     protected $request;
  52.     protected $expressionLanguage;
  54.     /**
  55.      * @var ExpressionFunctionProviderInterface[]
  56.      */
  57.     protected $expressionLanguageProviders = [];
  59.     public function __construct(RouteCollection $routes, RequestContext $context)
  60.     {
  61.         $this->routes = $routes;
  62.         $this->context = $context;
  63.     }
  65.     /**
  66.      * @return void
  67.      */
  68.     public function setContext(RequestContext $context)
  69.     {
  70.         $this->context = $context;
  71.     }
  73.     public function getContext(): RequestContext
  74.     {
  75.         return $this->context;
  76.     }
  78.     public function match(string $pathinfo): array
  79.     {
  80.         $this->allow = $this->allowSchemes = [];
  82.         if ($ret = $this->matchCollection(rawurldecode($pathinfo) ?: '/', $this->routes)) {
  83.             return $ret;
  84.         }
  86.         if ('/' === $pathinfo && !$this->allow && !$this->allowSchemes) {
  87.             throw new NoConfigurationException();
  88.         }
  90.         throw 0 < \count($this->allow) ? new MethodNotAllowedException(array_unique($this->allow)) : new ResourceNotFoundException(sprintf('No routes found for "%s".', $pathinfo));
  91.     }
  93.     public function matchRequest(Request $request): array
  94.     {
  95.         $this->request = $request;
  97.         $ret = $this->match($request->getPathInfo());
  99.         $this->request = null;
  101.         return $ret;
  102.     }
  104.     /**
  105.      * @return void
  106.      */
  107.     public function addExpressionLanguageProvider(ExpressionFunctionProviderInterface $provider)
  108.     {
  109.         $this->expressionLanguageProviders[] = $provider;
  110.     }
  112.     /**
  113.      * Tries to match a URL with a set of routes.
  114.      *
  115.      * @param string $pathinfo The path info to be parsed
  116.      *
  117.      * @throws NoConfigurationException  If no routing configuration could be found
  118.      * @throws ResourceNotFoundException If the resource could not be found
  119.      * @throws MethodNotAllowedException If the resource was found but the request method is not allowed
  120.      */
  121.     protected function matchCollection(string $pathinfo, RouteCollection $routes): array
  122.     {
  123.         // HEAD and GET are equivalent as per RFC
  124.         if ('HEAD' === $method = $this->context->getMethod()) {
  125.             $method = 'GET';
  126.         }
  127.         $supportsTrailingSlash = 'GET' === $method && $this instanceof RedirectableUrlMatcherInterface;
  128.         $trimmedPathinfo = rtrim($pathinfo, '/') ?: '/';
  130.         foreach ($routes as $name => $route) {
  131.             $compiledRoute = $route->compile();
  132.             $staticPrefix = rtrim($compiledRoute->getStaticPrefix(), '/');
  133.             $requiredMethods = $route->getMethods();
  135.             // check the static prefix of the URL first. Only use the more expensive preg_match when it matches
  136.             if ('' !== $staticPrefix && !str_starts_with($trimmedPathinfo, $staticPrefix)) {
  137.                 continue;
  138.             }
  139.             $regex = $compiledRoute->getRegex();
  141.             $pos = strrpos($regex, '$');
  142.             $hasTrailingSlash = '/' === $regex[$pos - 1];
  143.             $regex = substr_replace($regex, '/?$', $pos - $hasTrailingSlash, 1 + $hasTrailingSlash);
  145.             if (!preg_match($regex, $pathinfo, $matches)) {
  146.                 continue;
  147.             }
  149.             $hasTrailingVar = $trimmedPathinfo !== $pathinfo && preg_match('#\{[\w\x80-\xFF]+\}/?$#', $route->getPath());
  151.             if ($hasTrailingVar && ($hasTrailingSlash || (null === $m = $matches[\count($compiledRoute->getPathVariables())] ?? null) || '/' !== ($m[-1] ?? '/')) && preg_match($regex, $trimmedPathinfo, $m)) {
  152.                 if ($hasTrailingSlash) {
  153.                     $matches = $m;
  154.                 } else {
  155.                     $hasTrailingVar = false;
  156.                 }
  157.             }
  159.             $hostMatches = [];
  160.             if ($compiledRoute->getHostRegex() && !preg_match($compiledRoute->getHostRegex(), $this->context->getHost(), $hostMatches)) {
  161.                 continue;
  162.             }
  164.             $attributes = $this->getAttributes($route, $name, array_replace($matches, $hostMatches));
  166.             $status = $this->handleRouteRequirements($pathinfo, $name, $route, $attributes);
  168.             if (self::REQUIREMENT_MISMATCH === $status[0]) {
  169.                 continue;
  170.             }
  172.             if ('/' !== $pathinfo && !$hasTrailingVar && $hasTrailingSlash === ($trimmedPathinfo === $pathinfo)) {
  173.                 if ($supportsTrailingSlash && (!$requiredMethods || \in_array('GET', $requiredMethods))) {
  174.                     return $this->allow = $this->allowSchemes = [];
  175.                 }
  176.                 continue;
  177.             }
  179.             if ($route->getSchemes() && !$route->hasScheme($this->context->getScheme())) {
  180.                 $this->allowSchemes = array_merge($this->allowSchemes, $route->getSchemes());
  181.                 continue;
  182.             }
  184.             if ($requiredMethods && !\in_array($method, $requiredMethods)) {
  185.                 $this->allow = array_merge($this->allow, $requiredMethods);
  186.                 continue;
  187.             }
  189.             return array_replace($attributes, $status[1] ?? []);
  190.         }
  192.         return [];
  193.     }
  195.     /**
  196.      * Returns an array of values to use as request attributes.
  197.      *
  198.      * As this method requires the Route object, it is not available
  199.      * in matchers that do not have access to the matched Route instance
  200.      * (like the PHP and Apache matcher dumpers).
  201.      */
  202.     protected function getAttributes(Route $route, string $name, array $attributes): array
  203.     {
  204.         $defaults = $route->getDefaults();
  205.         if (isset($defaults['_canonical_route'])) {
  206.             $name = $defaults['_canonical_route'];
  207.             unset($defaults['_canonical_route']);
  208.         }
  209.         $attributes['_route'] = $name;
  211.         return $this->mergeDefaults($attributes, $defaults);
  212.     }
  214.     /**
  215.      * Handles specific route requirements.
  216.      *
  217.      * @return array The first element represents the status, the second contains additional information
  218.      */
  219.     protected function handleRouteRequirements(string $pathinfo, string $name, Route $route/* , array $routeParameters */): array
  220.     {
  221.         if (\func_num_args() < 4) {
  222.             trigger_deprecation('symfony/routing', '6.1', 'The "%s()" method will have a new "array $routeParameters" argument in version 7.0, not defining it is deprecated.', __METHOD__);
  223.             $routeParameters = [];
  224.         } else {
  225.             $routeParameters = func_get_arg(3);
  227.             if (!\is_array($routeParameters)) {
  228.                 throw new \TypeError(sprintf('"%s": Argument $routeParameters is expected to be an array, got "%s".', __METHOD__, get_debug_type($routeParameters)));
  229.             }
  230.         }
  232.         // expression condition
  233.         if ($route->getCondition() && !$this->getExpressionLanguage()->evaluate($route->getCondition(), [
  234.             'context' => $this->context,
  235.             'request' => $this->request ?: $this->createRequest($pathinfo),
  236.             'params' => $routeParameters,
  237.         ])) {
  238.             return [self::REQUIREMENT_MISMATCH, null];
  239.         }
  241.         return [self::REQUIREMENT_MATCH, null];
  242.     }
  244.     /**
  245.      * Get merged default parameters.
  246.      */
  247.     protected function mergeDefaults(array $params, array $defaults): array
  248.     {
  249.         foreach ($params as $key => $value) {
  250.             if (!\is_int($key) && null !== $value) {
  251.                 $defaults[$key] = $value;
  252.             }
  253.         }
  255.         return $defaults;
  256.     }
  258.     /**
  259.      * @return ExpressionLanguage
  260.      */
  261.     protected function getExpressionLanguage()
  262.     {
  263.         if (!isset($this->expressionLanguage)) {
  264.             if (!class_exists(ExpressionLanguage::class)) {
  265.                 throw new \LogicException('Unable to use expressions as the Symfony ExpressionLanguage component is not installed. Try running "composer require symfony/expression-language".');
  266.             }
  267.             $this->expressionLanguage = new ExpressionLanguage(null, $this->expressionLanguageProviders);
  268.         }
  270.         return $this->expressionLanguage;
  271.     }
  273.     /**
  274.      * @internal
  275.      */
  276.     protected function createRequest(string $pathinfo): ?Request
  277.     {
  278.         if (!class_exists(Request::class)) {
  279.             return null;
  280.         }
  282.         return Request::create($this->context->getScheme().'://'.$this->context->getHost().$this->context->getBaseUrl().$pathinfo, $this->context->getMethod(), $this->context->getParameters(), [], [], [
  283.             'SCRIPT_FILENAME' => $this->context->getBaseUrl(),
  284.             'SCRIPT_NAME' => $this->context->getBaseUrl(),
  285.         ]);
  286.     }
  287. }