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

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\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 = [];
  81. $pathinfo = '' === ($pathinfo = rawurldecode($pathinfo)) ? '/' : $pathinfo;
  83. if ($ret = $this->matchCollection($pathinfo, $this->routes)) {
  84. return $ret;
  85. }
  87. if ('/' === $pathinfo && !$this->allow && !$this->allowSchemes) {
  88. throw new NoConfigurationException();
  89. }
  91. throw 0 < \count($this->allow) ? new MethodNotAllowedException(array_unique($this->allow)) : new ResourceNotFoundException(\sprintf('No routes found for "%s".', $pathinfo));
  92. }
  94. public function matchRequest(Request $request): array
  95. {
  96. $this->request = $request;
  98. $ret = $this->match($request->getPathInfo());
  100. $this->request = null;
  102. return $ret;
  103. }
  105. /**
  106. * @return void
  107. */
  108. public function addExpressionLanguageProvider(ExpressionFunctionProviderInterface $provider)
  109. {
  110. $this->expressionLanguageProviders[] = $provider;
  111. }
  113. /**
  114. * Tries to match a URL with a set of routes.
  115. *
  116. * @param string $pathinfo The path info to be parsed
  117. *
  118. * @throws NoConfigurationException If no routing configuration could be found
  119. * @throws ResourceNotFoundException If the resource could not be found
  120. * @throws MethodNotAllowedException If the resource was found but the request method is not allowed
  121. */
  122. protected function matchCollection(string $pathinfo, RouteCollection $routes): array
  123. {
  124. // HEAD and GET are equivalent as per RFC
  125. if ('HEAD' === $method = $this->context->getMethod()) {
  126. $method = 'GET';
  127. }
  128. $supportsTrailingSlash = 'GET' === $method && $this instanceof RedirectableUrlMatcherInterface;
  129. $trimmedPathinfo = '' === ($trimmedPathinfo = rtrim($pathinfo, '/')) ? '/' : $trimmedPathinfo;
  131. foreach ($routes as $name => $route) {
  132. $compiledRoute = $route->compile();
  133. $staticPrefix = rtrim($compiledRoute->getStaticPrefix(), '/');
  134. $requiredMethods = $route->getMethods();
  136. // check the static prefix of the URL first. Only use the more expensive preg_match when it matches
  137. if ('' !== $staticPrefix && !str_starts_with($trimmedPathinfo, $staticPrefix)) {
  138. continue;
  139. }
  140. $regex = $compiledRoute->getRegex();
  142. $pos = strrpos($regex, '$');
  143. $hasTrailingSlash = '/' === $regex[$pos - 1];
  144. $regex = substr_replace($regex, '/?$', $pos - $hasTrailingSlash, 1 + $hasTrailingSlash);
  146. if (!preg_match($regex, $pathinfo, $matches)) {
  147. continue;
  148. }
  150. $hasTrailingVar = $trimmedPathinfo !== $pathinfo && preg_match('#\{[\w\x80-\xFF]+\}/?$#', $route->getPath());
  152. if ($hasTrailingVar && ($hasTrailingSlash || (null === $m = $matches[\count($compiledRoute->getPathVariables())] ?? null) || '/' !== ($m[-1] ?? '/')) && preg_match($regex, $trimmedPathinfo, $m)) {
  153. if ($hasTrailingSlash) {
  154. $matches = $m;
  155. } else {
  156. $hasTrailingVar = false;
  157. }
  158. }
  160. $hostMatches = [];
  161. if ($compiledRoute->getHostRegex() && !preg_match($compiledRoute->getHostRegex(), $this->context->getHost(), $hostMatches)) {
  162. continue;
  163. }
  165. $attributes = $this->getAttributes($route, $name, array_replace($matches, $hostMatches));
  167. $status = $this->handleRouteRequirements($pathinfo, $name, $route, $attributes);
  169. if (self::REQUIREMENT_MISMATCH === $status[0]) {
  170. continue;
  171. }
  173. if ('/' !== $pathinfo && !$hasTrailingVar && $hasTrailingSlash === ($trimmedPathinfo === $pathinfo)) {
  174. if ($supportsTrailingSlash && (!$requiredMethods || \in_array('GET', $requiredMethods))) {
  175. return $this->allow = $this->allowSchemes = [];
  176. }
  177. continue;
  178. }
  180. if ($route->getSchemes() && !$route->hasScheme($this->context->getScheme())) {
  181. $this->allowSchemes = array_merge($this->allowSchemes, $route->getSchemes());
  182. continue;
  183. }
  185. if ($requiredMethods && !\in_array($method, $requiredMethods)) {
  186. $this->allow = array_merge($this->allow, $requiredMethods);
  187. continue;
  188. }
  190. return array_replace($attributes, $status[1] ?? []);
  191. }
  193. return [];
  194. }
  196. /**
  197. * Returns an array of values to use as request attributes.
  198. *
  199. * As this method requires the Route object, it is not available
  200. * in matchers that do not have access to the matched Route instance
  201. * (like the PHP and Apache matcher dumpers).
  202. */
  203. protected function getAttributes(Route $route, string $name, array $attributes): array
  204. {
  205. $defaults = $route->getDefaults();
  206. if (isset($defaults['_canonical_route'])) {
  207. $name = $defaults['_canonical_route'];
  208. unset($defaults['_canonical_route']);
  209. }
  210. $attributes['_route'] = $name;
  212. return $this->mergeDefaults($attributes, $defaults);
  213. }
  215. /**
  216. * Handles specific route requirements.
  217. *
  218. * @return array The first element represents the status, the second contains additional information
  219. */
  220. protected function handleRouteRequirements(string $pathinfo, string $name, Route $route/* , array $routeParameters */): array
  221. {
  222. if (\func_num_args() < 4) {
  223. 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__);
  224. $routeParameters = [];
  225. } else {
  226. $routeParameters = func_get_arg(3);
  228. if (!\is_array($routeParameters)) {
  229. throw new \TypeError(\sprintf('"%s": Argument $routeParameters is expected to be an array, got "%s".', __METHOD__, get_debug_type($routeParameters)));
  230. }
  231. }
  233. // expression condition
  234. if ($route->getCondition() && !$this->getExpressionLanguage()->evaluate($route->getCondition(), [
  235. 'context' => $this->context,
  236. 'request' => $this->request ?: $this->createRequest($pathinfo),
  237. 'params' => $routeParameters,
  238. ])) {
  239. return [self::REQUIREMENT_MISMATCH, null];
  240. }
  242. return [self::REQUIREMENT_MATCH, null];
  243. }
  245. /**
  246. * Get merged default parameters.
  247. */
  248. protected function mergeDefaults(array $params, array $defaults): array
  249. {
  250. foreach ($params as $key => $value) {
  251. if (!\is_int($key) && null !== $value) {
  252. $defaults[$key] = $value;
  253. }
  254. }
  256. return $defaults;
  257. }
  259. /**
  260. * @return ExpressionLanguage
  261. */
  262. protected function getExpressionLanguage()
  263. {
  264. if (!isset($this->expressionLanguage)) {
  265. if (!class_exists(ExpressionLanguage::class)) {
  266. throw new \LogicException('Unable to use expressions as the Symfony ExpressionLanguage component is not installed. Try running "composer require symfony/expression-language".');
  267. }
  268. $this->expressionLanguage = new ExpressionLanguage(null, $this->expressionLanguageProviders);
  269. }
  271. return $this->expressionLanguage;
  272. }
  274. /**
  275. * @internal
  276. */
  277. protected function createRequest(string $pathinfo): ?Request
  278. {
  279. if (!class_exists(Request::class)) {
  280. return null;
  281. }
  283. return Request::create($this->context->getScheme().'://'.$this->context->getHost().$this->context->getBaseUrl().$pathinfo, $this->context->getMethod(), $this->context->getParameters(), [], [], [
  284. 'SCRIPT_FILENAME' => $this->context->getBaseUrl(),
  285. 'SCRIPT_NAME' => $this->context->getBaseUrl(),
  286. ]);
  287. }
  288. }