UrlMatcher.php 9.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266
  1. <?php
  2. /*
  3. * This file is part of the Symfony package.
  4. *
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Symfony\Component\Routing\Matcher;
  11. use Symfony\Component\ExpressionLanguage\ExpressionFunctionProviderInterface;
  12. use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
  13. use Symfony\Component\HttpFoundation\Request;
  14. use Symfony\Component\Routing\Exception\MethodNotAllowedException;
  15. use Symfony\Component\Routing\Exception\NoConfigurationException;
  16. use Symfony\Component\Routing\Exception\ResourceNotFoundException;
  17. use Symfony\Component\Routing\RequestContext;
  18. use Symfony\Component\Routing\Route;
  19. use Symfony\Component\Routing\RouteCollection;
  20. /**
  21. * UrlMatcher matches URL based on a set of routes.
  22. *
  23. * @author Fabien Potencier <fabien@symfony.com>
  24. */
  25. class UrlMatcher implements UrlMatcherInterface, RequestMatcherInterface
  26. {
  27. public const REQUIREMENT_MATCH = 0;
  28. public const REQUIREMENT_MISMATCH = 1;
  29. public const ROUTE_MATCH = 2;
  30. /**
  31. * Collects HTTP methods that would be allowed for the request.
  32. */
  33. protected array $allow = [];
  34. /**
  35. * Collects URI schemes that would be allowed for the request.
  36. *
  37. * @internal
  38. */
  39. protected array $allowSchemes = [];
  40. protected ?Request $request = null;
  41. protected ExpressionLanguage $expressionLanguage;
  42. /**
  43. * @var ExpressionFunctionProviderInterface[]
  44. */
  45. protected array $expressionLanguageProviders = [];
  46. public function __construct(
  47. protected RouteCollection $routes,
  48. protected RequestContext $context,
  49. ) {
  50. }
  51. public function setContext(RequestContext $context): void
  52. {
  53. $this->context = $context;
  54. }
  55. public function getContext(): RequestContext
  56. {
  57. return $this->context;
  58. }
  59. public function match(string $pathinfo): array
  60. {
  61. $this->allow = $this->allowSchemes = [];
  62. if ($ret = $this->matchCollection(rawurldecode($pathinfo) ?: '/', $this->routes)) {
  63. return $ret;
  64. }
  65. if ('/' === $pathinfo && !$this->allow && !$this->allowSchemes) {
  66. throw new NoConfigurationException();
  67. }
  68. throw 0 < \count($this->allow) ? new MethodNotAllowedException(array_unique($this->allow)) : new ResourceNotFoundException(sprintf('No routes found for "%s".', $pathinfo));
  69. }
  70. public function matchRequest(Request $request): array
  71. {
  72. $this->request = $request;
  73. $ret = $this->match($request->getPathInfo());
  74. $this->request = null;
  75. return $ret;
  76. }
  77. public function addExpressionLanguageProvider(ExpressionFunctionProviderInterface $provider): void
  78. {
  79. $this->expressionLanguageProviders[] = $provider;
  80. }
  81. /**
  82. * Tries to match a URL with a set of routes.
  83. *
  84. * @param string $pathinfo The path info to be parsed
  85. *
  86. * @throws NoConfigurationException If no routing configuration could be found
  87. * @throws ResourceNotFoundException If the resource could not be found
  88. * @throws MethodNotAllowedException If the resource was found but the request method is not allowed
  89. */
  90. protected function matchCollection(string $pathinfo, RouteCollection $routes): array
  91. {
  92. // HEAD and GET are equivalent as per RFC
  93. if ('HEAD' === $method = $this->context->getMethod()) {
  94. $method = 'GET';
  95. }
  96. $supportsTrailingSlash = 'GET' === $method && $this instanceof RedirectableUrlMatcherInterface;
  97. $trimmedPathinfo = rtrim($pathinfo, '/') ?: '/';
  98. foreach ($routes as $name => $route) {
  99. $compiledRoute = $route->compile();
  100. $staticPrefix = rtrim($compiledRoute->getStaticPrefix(), '/');
  101. $requiredMethods = $route->getMethods();
  102. // check the static prefix of the URL first. Only use the more expensive preg_match when it matches
  103. if ('' !== $staticPrefix && !str_starts_with($trimmedPathinfo, $staticPrefix)) {
  104. continue;
  105. }
  106. $regex = $compiledRoute->getRegex();
  107. $pos = strrpos($regex, '$');
  108. $hasTrailingSlash = '/' === $regex[$pos - 1];
  109. $regex = substr_replace($regex, '/?$', $pos - $hasTrailingSlash, 1 + $hasTrailingSlash);
  110. if (!preg_match($regex, $pathinfo, $matches)) {
  111. continue;
  112. }
  113. $hasTrailingVar = $trimmedPathinfo !== $pathinfo && preg_match('#\{[\w\x80-\xFF]+\}/?$#', $route->getPath());
  114. if ($hasTrailingVar && ($hasTrailingSlash || (null === $m = $matches[\count($compiledRoute->getPathVariables())] ?? null) || '/' !== ($m[-1] ?? '/')) && preg_match($regex, $trimmedPathinfo, $m)) {
  115. if ($hasTrailingSlash) {
  116. $matches = $m;
  117. } else {
  118. $hasTrailingVar = false;
  119. }
  120. }
  121. $hostMatches = [];
  122. if ($compiledRoute->getHostRegex() && !preg_match($compiledRoute->getHostRegex(), $this->context->getHost(), $hostMatches)) {
  123. continue;
  124. }
  125. $attributes = $this->getAttributes($route, $name, array_replace($matches, $hostMatches));
  126. $status = $this->handleRouteRequirements($pathinfo, $name, $route, $attributes);
  127. if (self::REQUIREMENT_MISMATCH === $status[0]) {
  128. continue;
  129. }
  130. if ('/' !== $pathinfo && !$hasTrailingVar && $hasTrailingSlash === ($trimmedPathinfo === $pathinfo)) {
  131. if ($supportsTrailingSlash && (!$requiredMethods || \in_array('GET', $requiredMethods, true))) {
  132. return $this->allow = $this->allowSchemes = [];
  133. }
  134. continue;
  135. }
  136. if ($route->getSchemes() && !$route->hasScheme($this->context->getScheme())) {
  137. $this->allowSchemes = array_merge($this->allowSchemes, $route->getSchemes());
  138. continue;
  139. }
  140. if ($requiredMethods && !\in_array($method, $requiredMethods, true)) {
  141. $this->allow = array_merge($this->allow, $requiredMethods);
  142. continue;
  143. }
  144. return array_replace($attributes, $status[1] ?? []);
  145. }
  146. return [];
  147. }
  148. /**
  149. * Returns an array of values to use as request attributes.
  150. *
  151. * As this method requires the Route object, it is not available
  152. * in matchers that do not have access to the matched Route instance
  153. * (like the PHP and Apache matcher dumpers).
  154. */
  155. protected function getAttributes(Route $route, string $name, array $attributes): array
  156. {
  157. $defaults = $route->getDefaults();
  158. if (isset($defaults['_canonical_route'])) {
  159. $name = $defaults['_canonical_route'];
  160. unset($defaults['_canonical_route']);
  161. }
  162. $attributes['_route'] = $name;
  163. if ($mapping = $route->getOption('mapping')) {
  164. $attributes['_route_mapping'] = $mapping;
  165. }
  166. return $this->mergeDefaults($attributes, $defaults);
  167. }
  168. /**
  169. * Handles specific route requirements.
  170. *
  171. * @return array The first element represents the status, the second contains additional information
  172. */
  173. protected function handleRouteRequirements(string $pathinfo, string $name, Route $route, array $routeParameters): array
  174. {
  175. // expression condition
  176. if ($route->getCondition() && !$this->getExpressionLanguage()->evaluate($route->getCondition(), [
  177. 'context' => $this->context,
  178. 'request' => $this->request ?: $this->createRequest($pathinfo),
  179. 'params' => $routeParameters,
  180. ])) {
  181. return [self::REQUIREMENT_MISMATCH, null];
  182. }
  183. return [self::REQUIREMENT_MATCH, null];
  184. }
  185. /**
  186. * Get merged default parameters.
  187. */
  188. protected function mergeDefaults(array $params, array $defaults): array
  189. {
  190. foreach ($params as $key => $value) {
  191. if (!\is_int($key) && null !== $value) {
  192. $defaults[$key] = $value;
  193. }
  194. }
  195. return $defaults;
  196. }
  197. protected function getExpressionLanguage(): ExpressionLanguage
  198. {
  199. if (!isset($this->expressionLanguage)) {
  200. if (!class_exists(ExpressionLanguage::class)) {
  201. throw new \LogicException('Unable to use expressions as the Symfony ExpressionLanguage component is not installed. Try running "composer require symfony/expression-language".');
  202. }
  203. $this->expressionLanguage = new ExpressionLanguage(null, $this->expressionLanguageProviders);
  204. }
  205. return $this->expressionLanguage;
  206. }
  207. /**
  208. * @internal
  209. */
  210. protected function createRequest(string $pathinfo): ?Request
  211. {
  212. if (!class_exists(Request::class)) {
  213. return null;
  214. }
  215. return Request::create($this->context->getScheme().'://'.$this->context->getHost().$this->context->getBaseUrl().$pathinfo, $this->context->getMethod(), $this->context->getParameters(), [], [], [
  216. 'SCRIPT_FILENAME' => $this->context->getBaseUrl(),
  217. 'SCRIPT_NAME' => $this->context->getBaseUrl(),
  218. ]);
  219. }
  220. }