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

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