Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Core\Routing;
Chris@0: 
Chris@0: use Drupal\Core\Path\CurrentPathStack;
Chris@14: use Drupal\Core\Routing\Enhancer\RouteEnhancerInterface;
Chris@0: use Symfony\Cmf\Component\Routing\LazyRouteCollection;
Chris@14: use Symfony\Cmf\Component\Routing\RouteObjectInterface;
Chris@0: use Symfony\Cmf\Component\Routing\RouteProviderInterface as BaseRouteProviderInterface;
Chris@0: use Symfony\Component\HttpFoundation\Request;
Chris@0: use Symfony\Component\Routing\Exception\MethodNotAllowedException;
Chris@0: use Symfony\Component\Routing\Exception\ResourceNotFoundException;
Chris@0: use Symfony\Component\Routing\Generator\UrlGeneratorInterface as BaseUrlGeneratorInterface;
Chris@0: use Symfony\Component\Routing\Matcher\RequestMatcherInterface;
Chris@0: use Symfony\Component\Routing\RouteCollection;
Chris@0: use Symfony\Component\Routing\RouterInterface;
Chris@0: 
Chris@0: /**
Chris@0:  * Router implementation in Drupal.
Chris@0:  *
Chris@0:  * A router determines, for an incoming request, the active controller, which is
Chris@0:  * a callable that creates a response.
Chris@0:  *
Chris@0:  * It consists of several steps, of which each are explained in more details
Chris@0:  * below:
Chris@0:  * 1. Get a collection of routes which potentially match the current request.
Chris@0:  *    This is done by the route provider. See ::getInitialRouteCollection().
Chris@0:  * 2. Filter the collection down further more. For example this filters out
Chris@0:  *    routes applying to other formats: See ::applyRouteFilters()
Chris@0:  * 3. Find the best matching route out of the remaining ones, by applying a
Chris@0:  *    regex. See ::matchCollection().
Chris@0:  * 4. Enhance the list of route attributes, for example loading entity objects.
Chris@0:  *    See ::applyRouteEnhancers().
Chris@0:  *
Chris@0:  * This implementation uses ideas of the following routers:
Chris@0:  * - \Symfony\Cmf\Component\Routing\DynamicRouter
Chris@0:  * - \Drupal\Core\Routing\UrlMatcher
Chris@0:  * - \Symfony\Cmf\Component\Routing\NestedMatcher\NestedMatcher
Chris@0:  *
Chris@0:  * @see \Symfony\Cmf\Component\Routing\DynamicRouter
Chris@0:  * @see \Drupal\Core\Routing\UrlMatcher
Chris@0:  * @see \Symfony\Cmf\Component\Routing\NestedMatcher\NestedMatcher
Chris@0:  */
Chris@0: class Router extends UrlMatcher implements RequestMatcherInterface, RouterInterface {
Chris@0: 
Chris@0:   /**
Chris@0:    * The route provider responsible for the first-pass match.
Chris@0:    *
Chris@0:    * @var \Symfony\Cmf\Component\Routing\RouteProviderInterface
Chris@0:    */
Chris@0:   protected $routeProvider;
Chris@0: 
Chris@0:   /**
Chris@0:    * The list of available enhancers.
Chris@0:    *
Chris@14:    * @var \Drupal\Core\Routing\EnhancerInterface[]
Chris@0:    */
Chris@0:   protected $enhancers = [];
Chris@0: 
Chris@0:   /**
Chris@0:    * The list of available route filters.
Chris@0:    *
Chris@14:    * @var \Drupal\Core\Routing\FilterInterface[]
Chris@0:    */
Chris@0:   protected $filters = [];
Chris@0: 
Chris@0:   /**
Chris@0:    * The URL generator.
Chris@0:    *
Chris@0:    * @var \Symfony\Component\Routing\Generator\UrlGeneratorInterface
Chris@0:    */
Chris@0:   protected $urlGenerator;
Chris@0: 
Chris@0:   /**
Chris@0:    * Constructs a new Router.
Chris@0:    *
Chris@0:    * @param \Symfony\Cmf\Component\Routing\RouteProviderInterface $route_provider
Chris@0:    *   The route provider.
Chris@0:    * @param \Drupal\Core\Path\CurrentPathStack $current_path
Chris@0:    *   The current path stack.
Chris@0:    * @param \Symfony\Component\Routing\Generator\UrlGeneratorInterface $url_generator
Chris@0:    *   The URL generator.
Chris@0:    */
Chris@0:   public function __construct(BaseRouteProviderInterface $route_provider, CurrentPathStack $current_path, BaseUrlGeneratorInterface $url_generator) {
Chris@0:     parent::__construct($current_path);
Chris@0:     $this->routeProvider = $route_provider;
Chris@0:     $this->urlGenerator = $url_generator;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@14:    * Adds a route filter.
Chris@0:    *
Chris@14:    * @param \Drupal\Core\Routing\FilterInterface $route_filter
Chris@14:    *   The route filter.
Chris@0:    */
Chris@14:   public function addRouteFilter(FilterInterface $route_filter) {
Chris@14:     $this->filters[] = $route_filter;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@14:    * Adds a route enhancer.
Chris@0:    *
Chris@14:    * @param \Drupal\Core\Routing\EnhancerInterface $route_enhancer
Chris@14:    *   The route enhancer.
Chris@0:    */
Chris@14:   public function addRouteEnhancer(EnhancerInterface $route_enhancer) {
Chris@14:     $this->enhancers[] = $route_enhancer;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function match($pathinfo) {
Chris@0:     $request = Request::create($pathinfo);
Chris@0: 
Chris@0:     return $this->matchRequest($request);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function matchRequest(Request $request) {
Chris@0:     $collection = $this->getInitialRouteCollection($request);
Chris@14:     if ($collection->count() === 0) {
Chris@14:       throw new ResourceNotFoundException(sprintf('No routes found for "%s".', $this->currentPath->getPath()));
Chris@14:     }
Chris@0:     $collection = $this->applyRouteFilters($collection, $request);
Chris@17:     $collection = $this->applyFitOrder($collection);
Chris@0: 
Chris@0:     if ($ret = $this->matchCollection(rawurldecode($this->currentPath->getPath($request)), $collection)) {
Chris@0:       return $this->applyRouteEnhancers($ret, $request);
Chris@0:     }
Chris@0: 
Chris@0:     throw 0 < count($this->allow)
Chris@0:       ? new MethodNotAllowedException(array_unique($this->allow))
Chris@0:       : new ResourceNotFoundException(sprintf('No routes found for "%s".', $this->currentPath->getPath()));
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tries to match a URL with a set of routes.
Chris@0:    *
Chris@0:    * @param string $pathinfo
Chris@0:    *   The path info to be parsed
Chris@0:    * @param \Symfony\Component\Routing\RouteCollection $routes
Chris@0:    *   The set of routes.
Chris@0:    *
Chris@0:    * @return array|null
Chris@0:    *   An array of parameters. NULL when there is no match.
Chris@0:    */
Chris@0:   protected function matchCollection($pathinfo, RouteCollection $routes) {
Chris@0:     // Try a case-sensitive match.
Chris@0:     $match = $this->doMatchCollection($pathinfo, $routes, TRUE);
Chris@0:     // Try a case-insensitive match.
Chris@0:     if ($match === NULL && $routes->count() > 0) {
Chris@0:       $match = $this->doMatchCollection($pathinfo, $routes, FALSE);
Chris@0:     }
Chris@0:     return $match;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tries to match a URL with a set of routes.
Chris@0:    *
Chris@0:    * This code is very similar to Symfony's UrlMatcher::matchCollection() but it
Chris@0:    * supports case-insensitive matching. The static prefix optimization is
Chris@0:    * removed as this duplicates work done by the query in
Chris@0:    * RouteProvider::getRoutesByPath().
Chris@0:    *
Chris@0:    * @param string $pathinfo
Chris@0:    *   The path info to be parsed
Chris@0:    * @param \Symfony\Component\Routing\RouteCollection $routes
Chris@0:    *   The set of routes.
Chris@0:    * @param bool $case_sensitive
Chris@0:    *   Determines if the match should be case-sensitive of not.
Chris@0:    *
Chris@0:    * @return array|null
Chris@0:    *   An array of parameters. NULL when there is no match.
Chris@0:    *
Chris@0:    * @see \Symfony\Component\Routing\Matcher\UrlMatcher::matchCollection()
Chris@0:    * @see \Drupal\Core\Routing\RouteProvider::getRoutesByPath()
Chris@0:    */
Chris@0:   protected function doMatchCollection($pathinfo, RouteCollection $routes, $case_sensitive) {
Chris@0:     foreach ($routes as $name => $route) {
Chris@0:       $compiledRoute = $route->compile();
Chris@0: 
Chris@0:       // Set the regex to use UTF-8.
Chris@0:       $regex = $compiledRoute->getRegex() . 'u';
Chris@0:       if (!$case_sensitive) {
Chris@0:         $regex = $regex . 'i';
Chris@0:       }
Chris@0:       if (!preg_match($regex, $pathinfo, $matches)) {
Chris@0:         continue;
Chris@0:       }
Chris@0: 
Chris@0:       $hostMatches = [];
Chris@0:       if ($compiledRoute->getHostRegex() && !preg_match($compiledRoute->getHostRegex(), $this->context->getHost(), $hostMatches)) {
Chris@0:         $routes->remove($name);
Chris@0:         continue;
Chris@0:       }
Chris@0: 
Chris@0:       // Check HTTP method requirement.
Chris@0:       if ($requiredMethods = $route->getMethods()) {
Chris@0:         // HEAD and GET are equivalent as per RFC.
Chris@0:         if ('HEAD' === $method = $this->context->getMethod()) {
Chris@0:           $method = 'GET';
Chris@0:         }
Chris@0: 
Chris@0:         if (!in_array($method, $requiredMethods)) {
Chris@0:           $this->allow = array_merge($this->allow, $requiredMethods);
Chris@0:           $routes->remove($name);
Chris@0:           continue;
Chris@0:         }
Chris@0:       }
Chris@0: 
Chris@0:       $status = $this->handleRouteRequirements($pathinfo, $name, $route);
Chris@0: 
Chris@0:       if (self::ROUTE_MATCH === $status[0]) {
Chris@0:         return $status[1];
Chris@0:       }
Chris@0: 
Chris@0:       if (self::REQUIREMENT_MISMATCH === $status[0]) {
Chris@0:         $routes->remove($name);
Chris@0:         continue;
Chris@0:       }
Chris@0: 
Chris@0:       return $this->getAttributes($route, $name, array_replace($matches, $hostMatches));
Chris@0:     }
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Returns a collection of potential matching routes for a request.
Chris@0:    *
Chris@0:    * @param \Symfony\Component\HttpFoundation\Request $request
Chris@0:    *   The current request.
Chris@0:    *
Chris@0:    * @return \Symfony\Component\Routing\RouteCollection
Chris@0:    *   The initial fetched route collection.
Chris@0:    */
Chris@0:   protected function getInitialRouteCollection(Request $request) {
Chris@0:     return $this->routeProvider->getRouteCollectionForRequest($request);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Apply the route enhancers to the defaults, according to priorities.
Chris@0:    *
Chris@0:    * @param array $defaults
Chris@0:    *   The defaults coming from the final matched route.
Chris@0:    * @param \Symfony\Component\HttpFoundation\Request $request
Chris@0:    *   The request.
Chris@0:    *
Chris@0:    * @return array
Chris@0:    *   The request attributes after applying the enhancers. This might consist
Chris@0:    *   raw values from the URL but also upcasted values, like entity objects,
Chris@0:    *   from route enhancers.
Chris@0:    */
Chris@0:   protected function applyRouteEnhancers($defaults, Request $request) {
Chris@14:     foreach ($this->enhancers as $enhancer) {
Chris@14:       if ($enhancer instanceof RouteEnhancerInterface && !$enhancer->applies($defaults[RouteObjectInterface::ROUTE_OBJECT])) {
Chris@14:         continue;
Chris@14:       }
Chris@0:       $defaults = $enhancer->enhance($defaults, $request);
Chris@0:     }
Chris@0: 
Chris@0:     return $defaults;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Applies all route filters to a given route collection.
Chris@0:    *
Chris@0:    * This method reduces the sets of routes further down, for example by
Chris@0:    * checking the HTTP method.
Chris@0:    *
Chris@0:    * @param \Symfony\Component\Routing\RouteCollection $collection
Chris@0:    *   The route collection.
Chris@0:    * @param \Symfony\Component\HttpFoundation\Request $request
Chris@0:    *   The request.
Chris@0:    *
Chris@0:    * @return \Symfony\Component\Routing\RouteCollection
Chris@0:    *   The filtered/sorted route collection.
Chris@0:    */
Chris@0:   protected function applyRouteFilters(RouteCollection $collection, Request $request) {
Chris@0:     // Route filters are expected to throw an exception themselves if they
Chris@0:     // end up filtering the list down to 0.
Chris@14:     foreach ($this->filters as $filter) {
Chris@0:       $collection = $filter->filter($collection, $request);
Chris@0:     }
Chris@0: 
Chris@0:     return $collection;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@17:    * Reapplies the fit order to a RouteCollection object.
Chris@17:    *
Chris@17:    * Route filters can reorder route collections. For example, routes with an
Chris@17:    * explicit _format requirement will be preferred. This can result in a less
Chris@17:    * fit route being used. For example, as a result of filtering /user/% comes
Chris@17:    * before /user/login. In order to not break this fundamental property of
Chris@17:    * routes, we need to reapply the fit order. We also need to ensure that order
Chris@17:    * within each group of the same fit is preserved.
Chris@17:    *
Chris@17:    * @param \Symfony\Component\Routing\RouteCollection $collection
Chris@17:    *   The route collection.
Chris@17:    *
Chris@17:    * @return \Symfony\Component\Routing\RouteCollection
Chris@17:    *   The reordered route collection.
Chris@17:    */
Chris@17:   protected function applyFitOrder(RouteCollection $collection) {
Chris@17:     $buckets = [];
Chris@17:     // Sort all the routes by fit descending.
Chris@17:     foreach ($collection->all() as $name => $route) {
Chris@17:       $fit = $route->compile()->getFit();
Chris@17:       $buckets += [$fit => []];
Chris@17:       $buckets[$fit][] = [$name, $route];
Chris@17:     }
Chris@17:     krsort($buckets);
Chris@17: 
Chris@17:     $flattened = array_reduce($buckets, 'array_merge', []);
Chris@17: 
Chris@17:     // Add them back onto a new route collection.
Chris@17:     $collection = new RouteCollection();
Chris@17:     foreach ($flattened as $pair) {
Chris@17:       $name = $pair[0];
Chris@17:       $route = $pair[1];
Chris@17:       $collection->add($name, $route);
Chris@17:     }
Chris@17:     return $collection;
Chris@17:   }
Chris@17: 
Chris@17:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getRouteCollection() {
Chris@0:     return new LazyRouteCollection($this->routeProvider);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function generate($name, $parameters = [], $referenceType = self::ABSOLUTE_PATH) {
Chris@0:     @trigger_error('Use the \Drupal\Core\Url object instead', E_USER_DEPRECATED);
Chris@0:     return $this->urlGenerator->generate($name, $parameters, $referenceType);
Chris@0:   }
Chris@0: 
Chris@0: }