diff --git a/core/core.services.yml b/core/core.services.yml index 76088786cd..90374ddb1a 100644 --- a/core/core.services.yml +++ b/core/core.services.yml @@ -823,16 +823,6 @@ services: tags: - { name: service_collector, tag: non_lazy_route_filter, call: addRouteFilter } deprecated: The "%service_id%" service is deprecated. You should use the 'router.no_access_checks' service instead. - route_filter.lazy_collector: - class: Drupal\Core\Routing\LazyRouteFilter - tags: - - { name: non_lazy_route_filter } - parent: container.trait - route_filter_subscriber: - class: Drupal\Core\EventSubscriber\RouteFilterSubscriber - arguments: ['@route_filter.lazy_collector'] - tags: - - { name: event_subscriber } url_generator.non_bubbling: class: Drupal\Core\Routing\UrlGenerator arguments: ['@router.route_provider', '@path_processor_manager', '@route_processor_manager', '@request_stack', '%filter_protocols%'] @@ -864,10 +854,12 @@ services: deprecated: The "%service_id%" service is deprecated. You should use the 'router.no_access_checks' service instead. router.no_access_checks: class: \Drupal\Core\Routing\Router - arguments: ['@router.route_provider', '@path.current', '@url_generator'] + arguments: ['@router.route_provider', '@path.current', '@url_generator', '@class_resolver'] tags: - { name: service_collector, tag: non_lazy_route_enhancer, call: addRouteEnhancer } + - { name: service_collector, tag: route_enhancer, call: addRouteEnhancer } - { name: service_collector, tag: non_lazy_route_filter, call: addRouteFilter } + - { name: service_collector, tag: route_filter, call: addRouteFilter } calls: - [setContext, ['@router.request_context']] router.path_roots_subscriber: @@ -997,21 +989,11 @@ services: arguments: ['@form_ajax_response_builder', '@string_translation'] tags: - { name: event_subscriber } - route_enhancer.lazy_collector: - class: Drupal\Core\Routing\LazyRouteEnhancer - tags: - - { name: non_lazy_route_enhancer, priority: 5000 } - parent: container.trait - route_enhancer_subscriber: - class: Drupal\Core\EventSubscriber\RouteEnhancerSubscriber - arguments: ['@route_enhancer.lazy_collector'] - tags: - - { name: event_subscriber } route_enhancer.param_conversion: class: Drupal\Core\Routing\Enhancer\ParamConversionEnhancer arguments: ['@paramconverter_manager'] tags: - - { name: route_enhancer } + - { name: route_enhancer, priority: 5000 } - { name: event_subscriber } route_enhancer.form: class: Drupal\Core\Routing\Enhancer\FormRouteEnhancer diff --git a/core/lib/Drupal/Core/CoreServiceProvider.php b/core/lib/Drupal/Core/CoreServiceProvider.php index 8a22bc50d4..e07046ae0a 100644 --- a/core/lib/Drupal/Core/CoreServiceProvider.php +++ b/core/lib/Drupal/Core/CoreServiceProvider.php @@ -10,8 +10,6 @@ use Drupal\Core\DependencyInjection\Compiler\GuzzleMiddlewarePass; use Drupal\Core\DependencyInjection\Compiler\ContextProvidersPass; use Drupal\Core\DependencyInjection\Compiler\ProxyServicesPass; -use Drupal\Core\DependencyInjection\Compiler\RegisterLazyRouteEnhancers; -use Drupal\Core\DependencyInjection\Compiler\RegisterLazyRouteFilters; use Drupal\Core\DependencyInjection\Compiler\DependencySerializationTraitPass; use Drupal\Core\DependencyInjection\Compiler\StackedKernelPass; use Drupal\Core\DependencyInjection\Compiler\StackedSessionHandlerPass; @@ -84,8 +82,6 @@ public function register(ContainerBuilder $container) { $container->addCompilerPass(new RegisterEventSubscribersPass(), PassConfig::TYPE_AFTER_REMOVING); $container->addCompilerPass(new RegisterAccessChecksPass()); - $container->addCompilerPass(new RegisterLazyRouteEnhancers()); - $container->addCompilerPass(new RegisterLazyRouteFilters()); // Add a compiler pass for registering services needing destruction. $container->addCompilerPass(new RegisterServicesForDestructionPass()); diff --git a/core/lib/Drupal/Core/DependencyInjection/Compiler/RegisterLazyRouteEnhancers.php b/core/lib/Drupal/Core/DependencyInjection/Compiler/RegisterLazyRouteEnhancers.php deleted file mode 100644 index 8e2929b860..0000000000 --- a/core/lib/Drupal/Core/DependencyInjection/Compiler/RegisterLazyRouteEnhancers.php +++ /dev/null @@ -1,32 +0,0 @@ -hasDefinition('route_enhancer.lazy_collector')) { - return; - } - - $service_ids = []; - - foreach ($container->findTaggedServiceIds('route_enhancer') as $id => $attributes) { - $service_ids[$id] = $id; - } - - $container - ->getDefinition('route_enhancer.lazy_collector') - ->addArgument($service_ids); - } - -} diff --git a/core/lib/Drupal/Core/DependencyInjection/Compiler/RegisterLazyRouteFilters.php b/core/lib/Drupal/Core/DependencyInjection/Compiler/RegisterLazyRouteFilters.php deleted file mode 100644 index d77477921b..0000000000 --- a/core/lib/Drupal/Core/DependencyInjection/Compiler/RegisterLazyRouteFilters.php +++ /dev/null @@ -1,32 +0,0 @@ -hasDefinition('route_filter.lazy_collector')) { - return; - } - - $service_ids = []; - - foreach ($container->findTaggedServiceIds('route_filter') as $id => $attributes) { - $service_ids[$id] = $id; - } - - $container - ->getDefinition('route_filter.lazy_collector') - ->addArgument($service_ids); - } - -} diff --git a/core/lib/Drupal/Core/Entity/Enhancer/EntityRouteEnhancer.php b/core/lib/Drupal/Core/Entity/Enhancer/EntityRouteEnhancer.php index 287464985b..af640ec3f7 100644 --- a/core/lib/Drupal/Core/Entity/Enhancer/EntityRouteEnhancer.php +++ b/core/lib/Drupal/Core/Entity/Enhancer/EntityRouteEnhancer.php @@ -2,9 +2,8 @@ namespace Drupal\Core\Entity\Enhancer; -use Drupal\Core\Routing\Enhancer\RouteEnhancerInterface; +use Symfony\Cmf\Component\Routing\Enhancer\RouteEnhancerInterface; use Symfony\Component\HttpFoundation\Request; -use Symfony\Component\Routing\Route; use Symfony\Cmf\Component\Routing\RouteObjectInterface; /** @@ -16,6 +15,15 @@ class EntityRouteEnhancer implements RouteEnhancerInterface { * {@inheritdoc} */ public function enhance(array $defaults, Request $request) { + $route = $defaults[RouteObjectInterface::ROUTE_OBJECT]; + if ($route->hasDefault('_controller') || + !($route->hasDefault('_entity_form') + || $route->hasDefault('_entity_list') + || $route->hasDefault('_entity_view') + )) { + return $defaults; + } + if (empty($defaults['_controller'])) { if (!empty($defaults['_entity_form'])) { $defaults = $this->enhanceEntityForm($defaults, $request); @@ -31,17 +39,6 @@ public function enhance(array $defaults, Request $request) { } /** - * {@inheritdoc} - */ - public function applies(Route $route) { - return !$route->hasDefault('_controller') && - ($route->hasDefault('_entity_form') - || $route->hasDefault('_entity_list') - || $route->hasDefault('_entity_view') - ); - } - - /** * Update defaults for entity forms. * * @param array $defaults diff --git a/core/lib/Drupal/Core/EventSubscriber/RouteEnhancerSubscriber.php b/core/lib/Drupal/Core/EventSubscriber/RouteEnhancerSubscriber.php deleted file mode 100644 index 8763842b58..0000000000 --- a/core/lib/Drupal/Core/EventSubscriber/RouteEnhancerSubscriber.php +++ /dev/null @@ -1,48 +0,0 @@ -routeEnhancer = $route_enhancer; - } - - /** - * Adds the route_enhancer object to the route collection. - * - * @param \Drupal\Core\Routing\RouteBuildEvent $event - * The route build event. - */ - public function onRouteAlter(RouteBuildEvent $event) { - $this->routeEnhancer->setEnhancers($event->getRouteCollection()); - } - - /** - * {@inheritdoc} - */ - public static function getSubscribedEvents() { - $events[RoutingEvents::ALTER][] = ['onRouteAlter', -300]; - return $events; - } - -} diff --git a/core/lib/Drupal/Core/EventSubscriber/RouteFilterSubscriber.php b/core/lib/Drupal/Core/EventSubscriber/RouteFilterSubscriber.php deleted file mode 100644 index f64b8db514..0000000000 --- a/core/lib/Drupal/Core/EventSubscriber/RouteFilterSubscriber.php +++ /dev/null @@ -1,50 +0,0 @@ -routeFilter = $route_filter; - } - - /** - * Get the Response object from filtered route collection. - * - * @param \Drupal\Core\Routing\RouteBuildEvent $event - * The route build event. - */ - public function onRouteAlter(RouteBuildEvent $event) { - $this->routeFilter->setFilters($event->getRouteCollection()); - } - - /** - * {@inheritdoc} - */ - public static function getSubscribedEvents() { - $events[RoutingEvents::ALTER][] = ['onRouteAlter', -300]; - return $events; - } - -} diff --git a/core/lib/Drupal/Core/Routing/ContentTypeHeaderMatcher.php b/core/lib/Drupal/Core/Routing/ContentTypeHeaderMatcher.php index 13e18f35a9..6bed3b42e9 100644 --- a/core/lib/Drupal/Core/Routing/ContentTypeHeaderMatcher.php +++ b/core/lib/Drupal/Core/Routing/ContentTypeHeaderMatcher.php @@ -4,13 +4,13 @@ use Symfony\Component\HttpFoundation\Request; use Symfony\Component\HttpKernel\Exception\UnsupportedMediaTypeHttpException; -use Symfony\Component\Routing\Route; use Symfony\Component\Routing\RouteCollection; +use Symfony\Cmf\Component\Routing\NestedMatcher\RouteFilterInterface as BaseRouteFilterInterface; /** * Filters routes based on the HTTP Content-type header. */ -class ContentTypeHeaderMatcher implements RouteFilterInterface { +class ContentTypeHeaderMatcher implements BaseRouteFilterInterface { /** * {@inheritdoc} @@ -50,11 +50,4 @@ public function filter(RouteCollection $collection, Request $request) { } } - /** - * {@inheritdoc} - */ - public function applies(Route $route) { - return TRUE; - } - } diff --git a/core/lib/Drupal/Core/Routing/Enhancer/EntityRevisionRouteEnhancer.php b/core/lib/Drupal/Core/Routing/Enhancer/EntityRevisionRouteEnhancer.php index 9880edd523..7cca560147 100644 --- a/core/lib/Drupal/Core/Routing/Enhancer/EntityRevisionRouteEnhancer.php +++ b/core/lib/Drupal/Core/Routing/Enhancer/EntityRevisionRouteEnhancer.php @@ -5,16 +5,19 @@ use Symfony\Cmf\Component\Routing\RouteObjectInterface; use Symfony\Component\HttpFoundation\Request; use Symfony\Component\Routing\Route; +use Symfony\Cmf\Component\Routing\Enhancer\RouteEnhancerInterface as BaseRouteEnhancerInterface; /** * Adds _entity_revision to the request attributes, if possible. */ -class EntityRevisionRouteEnhancer implements RouteEnhancerInterface { +class EntityRevisionRouteEnhancer implements BaseRouteEnhancerInterface { /** - * {@inheritdoc} + * Returns whether the enhancer runs on the current route. + * + * @return bool */ - public function applies(Route $route) { + protected function applies(Route $route) { // Check whether there is any entity revision parameter. $parameters = $route->getOption('parameters') ?: []; foreach ($parameters as $info) { @@ -31,6 +34,10 @@ public function applies(Route $route) { public function enhance(array $defaults, Request $request) { /** @var \Symfony\Component\Routing\Route $route */ $route = $defaults[RouteObjectInterface::ROUTE_OBJECT]; + if (!$this->applies($route)) { + return $defaults; + } + $options = $route->getOptions(); if (isset($options['parameters'])) { foreach ($options['parameters'] as $name => $details) { diff --git a/core/lib/Drupal/Core/Routing/Enhancer/FormRouteEnhancer.php b/core/lib/Drupal/Core/Routing/Enhancer/FormRouteEnhancer.php index d2bdb1209e..cdda4173c8 100644 --- a/core/lib/Drupal/Core/Routing/Enhancer/FormRouteEnhancer.php +++ b/core/lib/Drupal/Core/Routing/Enhancer/FormRouteEnhancer.php @@ -2,25 +2,24 @@ namespace Drupal\Core\Routing\Enhancer; +use Symfony\Cmf\Component\Routing\RouteObjectInterface; use Symfony\Component\HttpFoundation\Request; -use Symfony\Component\Routing\Route; +use Symfony\Cmf\Component\Routing\Enhancer\RouteEnhancerInterface as BaseRouteEnhancerInterface; /** * Enhancer to add a wrapping controller for _form routes. */ -class FormRouteEnhancer implements RouteEnhancerInterface { - - /** - * {@inheritdoc} - */ - public function applies(Route $route) { - return $route->hasDefault('_form') && !$route->hasDefault('_controller'); - } +class FormRouteEnhancer implements BaseRouteEnhancerInterface { /** * {@inheritdoc} */ public function enhance(array $defaults, Request $request) { + $route = $defaults[RouteObjectInterface::ROUTE_OBJECT]; + if (!$route->hasDefault('_form') || $route->hasDefault('_controller')) { + return; + } + $defaults['_controller'] = 'controller.form:getContentResult'; return $defaults; } diff --git a/core/lib/Drupal/Core/Routing/Enhancer/ParamConversionEnhancer.php b/core/lib/Drupal/Core/Routing/Enhancer/ParamConversionEnhancer.php index 09d6148118..70bfc8cfea 100644 --- a/core/lib/Drupal/Core/Routing/Enhancer/ParamConversionEnhancer.php +++ b/core/lib/Drupal/Core/Routing/Enhancer/ParamConversionEnhancer.php @@ -11,12 +11,12 @@ use Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent; use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; use Symfony\Component\HttpKernel\KernelEvents; -use Symfony\Component\Routing\Route; +use Symfony\Cmf\Component\Routing\Enhancer\RouteEnhancerInterface as BaseRouteEnhancerInterface; /** * Provides a route enhancer that handles parameter conversion. */ -class ParamConversionEnhancer implements RouteEnhancerInterface, EventSubscriberInterface { +class ParamConversionEnhancer implements BaseRouteEnhancerInterface, EventSubscriberInterface { /** * The parameter conversion manager. @@ -89,11 +89,4 @@ public static function getSubscribedEvents() { return $events; } - /** - * {@inheritdoc} - */ - public function applies(Route $route) { - return TRUE; - } - } diff --git a/core/lib/Drupal/Core/Routing/Enhancer/RouteEnhancerInterface.php b/core/lib/Drupal/Core/Routing/Enhancer/RouteEnhancerInterface.php index d6be823b5e..369aba9c9d 100644 --- a/core/lib/Drupal/Core/Routing/Enhancer/RouteEnhancerInterface.php +++ b/core/lib/Drupal/Core/Routing/Enhancer/RouteEnhancerInterface.php @@ -5,8 +5,14 @@ use Symfony\Cmf\Component\Routing\Enhancer\RouteEnhancerInterface as BaseRouteEnhancerInterface; use Symfony\Component\Routing\Route; +@trigger_error('\Drupal\Core\Routing\Enhancer\RouteEnhancerInterface is deprecated in Drupal 8.4.0 and will be removed before Drupal 9.0.0. Instead, you should use \Symfony\Cmf\Component\Routing\Enhancer\RouteEnhancerInterface. See https://www.drupal.org/node/2894934', E_USER_DEPRECATED); + /** * A route enhance service to determine route enhance rules. + * + * @deprecated in Drupal 8.4.0 and will be removed before Drupal 9.0.0. Instead, + * you should use Symfony\Cmf\Component\Routing\Enhancer\RouteEnhancerInterface. + * See https://www.drupal.org/node/2894934 */ interface RouteEnhancerInterface extends BaseRouteEnhancerInterface { diff --git a/core/lib/Drupal/Core/Routing/LazyRouteEnhancer.php b/core/lib/Drupal/Core/Routing/LazyRouteEnhancer.php deleted file mode 100644 index 356fe3e6fa..0000000000 --- a/core/lib/Drupal/Core/Routing/LazyRouteEnhancer.php +++ /dev/null @@ -1,101 +0,0 @@ -serviceIds = $service_ids; - } - - /** - * For each route, saves a list of applicable enhancers to the route. - * - * @param \Symfony\Component\Routing\RouteCollection $route_collection - * A collection of routes to apply enhancer checks to. - */ - public function setEnhancers(RouteCollection $route_collection) { - /** @var \Symfony\Component\Routing\Route $route **/ - foreach ($route_collection as $route_name => $route) { - $service_ids = []; - foreach ($this->getEnhancers() as $service_id => $enhancer) { - if ((!$enhancer instanceof RouteEnhancerInterface) || $enhancer->applies($route)) { - $service_ids[] = $service_id; - } - } - if ($service_ids) { - $route->setOption('_route_enhancers', array_unique($service_ids)); - } - } - } - - /** - * For each route, gets a list of applicable enhancer to the route. - * - * @return \Symfony\Cmf\Component\Routing\Enhancer\RouteEnhancerInterface[]|\Drupal\Core\Routing\Enhancer\RouteEnhancerInterface[] - */ - protected function getEnhancers() { - if (!isset($this->enhancers)) { - foreach ($this->serviceIds as $service_id) { - $this->enhancers[$service_id] = $this->container->get($service_id); - } - } - return $this->enhancers; - } - - /** - * {@inheritdoc} - */ - public function enhance(array $defaults, Request $request) { - /** @var \Symfony\Component\Routing\Route $route */ - $route = $defaults[RouteObjectInterface::ROUTE_OBJECT]; - - $enhancer_ids = $route->getOption('_route_enhancers'); - - if (isset($enhancer_ids)) { - foreach ($enhancer_ids as $enhancer_id) { - $defaults = $this->container->get($enhancer_id)->enhance($defaults, $request); - } - } - - return $defaults; - } - -} diff --git a/core/lib/Drupal/Core/Routing/LazyRouteFilter.php b/core/lib/Drupal/Core/Routing/LazyRouteFilter.php deleted file mode 100644 index 10f3d517be..0000000000 --- a/core/lib/Drupal/Core/Routing/LazyRouteFilter.php +++ /dev/null @@ -1,102 +0,0 @@ -serviceIds = $service_ids; - } - - /** - * For each route, filter down the route collection. - * - * @param \Symfony\Component\Routing\RouteCollection $route_collection - * A collection of routes to apply filter checks to. - */ - public function setFilters(RouteCollection $route_collection) { - /** @var \Symfony\Component\Routing\Route $route **/ - foreach ($route_collection as $route) { - $service_ids = []; - foreach ($this->getFilters() as $service_id => $filter) { - if ($filter instanceof RouteFilterInterface && $filter->applies($route)) { - $service_ids[] = $service_id; - } - } - if ($service_ids) { - $route->setOption('_route_filters', array_unique($service_ids)); - } - } - } - - /** - * For each route, gets a list of applicable enhancers to the route. - * - * @return \Symfony\Cmf\Component\Routing\Enhancer\RouteEnhancerInterface[]|\Drupal\Core\Routing\Enhancer\RouteEnhancerInterface[] - */ - protected function getFilters() { - if (!isset($this->filters)) { - foreach ($this->serviceIds as $service_id) { - $this->filters[$service_id] = $this->container->get($service_id); - } - } - return $this->filters; - } - - /** - * {@inheritdoc} - */ - public function filter(RouteCollection $collection, Request $request) { - $filter_ids = []; - foreach ($collection->all() as $route) { - $filter_ids = array_merge($filter_ids, $route->getOption('_route_filters') ?: []); - } - $filter_ids = array_unique($filter_ids); - - if (isset($filter_ids)) { - foreach ($filter_ids as $filter_id) { - if ($filter = $this->container->get($filter_id, ContainerInterface::NULL_ON_INVALID_REFERENCE)) { - $collection = $filter->filter($collection, $request); - } - } - } - return $collection; - } - -} diff --git a/core/lib/Drupal/Core/Routing/MethodFilter.php b/core/lib/Drupal/Core/Routing/MethodFilter.php index e565a3e0cf..afcfc17213 100644 --- a/core/lib/Drupal/Core/Routing/MethodFilter.php +++ b/core/lib/Drupal/Core/Routing/MethodFilter.php @@ -4,13 +4,13 @@ use Symfony\Component\HttpFoundation\Request; use Symfony\Component\Routing\Exception\MethodNotAllowedException; -use Symfony\Component\Routing\Route; use Symfony\Component\Routing\RouteCollection; +use Symfony\Cmf\Component\Routing\NestedMatcher\RouteFilterInterface as BaseRouteFilterInterface; /** * Filters routes based on the HTTP method. */ -class MethodFilter implements RouteFilterInterface { +class MethodFilter implements BaseRouteFilterInterface { /** * {@inheritdoc} @@ -21,6 +21,10 @@ public function filter(RouteCollection $collection, Request $request) { $all_supported_methods = []; foreach ($collection->all() as $name => $route) { + if (empty($route->getMethods())) { + continue; + } + $supported_methods = $route->getMethods(); // A route not restricted to specific methods allows any method. If this @@ -47,11 +51,4 @@ public function filter(RouteCollection $collection, Request $request) { throw new MethodNotAllowedException(array_unique($all_supported_methods)); } - /** - * {@inheritdoc} - */ - public function applies(Route $route) { - return !empty($route->getMethods()); - } - } diff --git a/core/lib/Drupal/Core/Routing/RequestFormatRouteFilter.php b/core/lib/Drupal/Core/Routing/RequestFormatRouteFilter.php index 547e6117e7..dad8cda88a 100644 --- a/core/lib/Drupal/Core/Routing/RequestFormatRouteFilter.php +++ b/core/lib/Drupal/Core/Routing/RequestFormatRouteFilter.php @@ -4,20 +4,13 @@ use Symfony\Component\HttpFoundation\Request; use Symfony\Component\HttpKernel\Exception\NotAcceptableHttpException; -use Symfony\Component\Routing\Route; use Symfony\Component\Routing\RouteCollection; +use Symfony\Cmf\Component\Routing\NestedMatcher\RouteFilterInterface as BaseRouteFilterInterface; /** * Provides a route filter, which filters by the request format. */ -class RequestFormatRouteFilter implements RouteFilterInterface { - - /** - * {@inheritdoc} - */ - public function applies(Route $route) { - return $route->hasRequirement('_format'); - } +class RequestFormatRouteFilter implements BaseRouteFilterInterface { /** * {@inheritdoc} @@ -29,6 +22,9 @@ public function filter(RouteCollection $collection, Request $request) { /** @var \Symfony\Component\Routing\Route $route */ foreach ($collection as $name => $route) { + if (!$route->hasRequirement('_format')) { + continue; + } // If the route has no _format specification, we move it to the end. If it // does, then no match means the route is removed entirely. if ($supported_formats = array_filter(explode('|', $route->getRequirement('_format')))) { diff --git a/core/lib/Drupal/Core/Routing/RouteFilterInterface.php b/core/lib/Drupal/Core/Routing/RouteFilterInterface.php index a3ccb4486f..7473f36dde 100644 --- a/core/lib/Drupal/Core/Routing/RouteFilterInterface.php +++ b/core/lib/Drupal/Core/Routing/RouteFilterInterface.php @@ -5,8 +5,14 @@ use Symfony\Cmf\Component\Routing\NestedMatcher\RouteFilterInterface as BaseRouteFilterInterface; use Symfony\Component\Routing\Route; +@trigger_error('\Drupal\Core\Routing\Enhancer\RouteFilterInterface is deprecated in Drupal 8.4.0 and will be removed before Drupal 9.0.0. Instead, you should use \Symfony\Cmf\Component\Routing\Filter\RouteFilterInterface. See https://www.drupal.org/node/2894934', E_USER_DEPRECATED); + /** * A route filter service to filter down the collection of route instances. + * + * @deprecated in Drupal 8.4.0 and will be removed before Drupal 9.0.0. Instead, + * you should use \Symfony\Cmf\Component\Routing\Filter\RouteFilterInterface. + * See https://www.drupal.org/node/2894934' */ interface RouteFilterInterface extends BaseRouteFilterInterface { diff --git a/core/lib/Drupal/Core/Routing/Router.php b/core/lib/Drupal/Core/Routing/Router.php index e949c5efb8..2a570583ae 100644 --- a/core/lib/Drupal/Core/Routing/Router.php +++ b/core/lib/Drupal/Core/Routing/Router.php @@ -3,9 +3,9 @@ namespace Drupal\Core\Routing; use Drupal\Core\Path\CurrentPathStack; -use Symfony\Cmf\Component\Routing\Enhancer\RouteEnhancerInterface as BaseRouteEnhancerInterface; +use Symfony\Cmf\Component\Routing\Enhancer\RouteEnhancerInterface; use Symfony\Cmf\Component\Routing\LazyRouteCollection; -use Symfony\Cmf\Component\Routing\NestedMatcher\RouteFilterInterface as BaseRouteFilterInterface; +use Symfony\Cmf\Component\Routing\RouteObjectInterface; use Symfony\Cmf\Component\Routing\RouteProviderInterface as BaseRouteProviderInterface; use Symfony\Component\HttpFoundation\Request; use Symfony\Component\Routing\Exception\MethodNotAllowedException; @@ -14,6 +14,7 @@ use Symfony\Component\Routing\Matcher\RequestMatcherInterface; use Symfony\Component\Routing\RouteCollection; use Symfony\Component\Routing\RouterInterface; +use Symfony\Cmf\Component\Routing\NestedMatcher\RouteFilterInterface as BaseRouteFilterInterface; /** * Router implementation in Drupal. @@ -58,13 +59,6 @@ class Router extends UrlMatcher implements RequestMatcherInterface, RouterInterf protected $enhancers = []; /** - * Cached sorted list of enhancers. - * - * @var \Symfony\Cmf\Component\Routing\Enhancer\RouteEnhancerInterface[] - */ - protected $sortedEnhancers; - - /** * The list of available route filters. * * @var \Symfony\Cmf\Component\Routing\NestedMatcher\RouteFilterInterface[] @@ -72,13 +66,6 @@ class Router extends UrlMatcher implements RequestMatcherInterface, RouterInterf protected $filters = []; /** - * Cached sorted list route filters. - * - * @var \Symfony\Cmf\Component\Routing\NestedMatcher\RouteFilterInterface[] - */ - protected $sortedFilters; - - /** * The URL generator. * * @var \Symfony\Component\Routing\Generator\UrlGeneratorInterface @@ -102,36 +89,23 @@ public function __construct(BaseRouteProviderInterface $route_provider, CurrentP } /** - * Adds a route enhancer to the list of used route enhancers. - * - * @param \Symfony\Cmf\Component\Routing\Enhancer\RouteEnhancerInterface $route_enhancer - * A route enhancer. - * @param int $priority - * (optional) The priority of the enhancer. Higher number enhancers will be - * used first. + * Adds a route filter. * - * @return $this + * @param \Symfony\Cmf\Component\Routing\NestedMatcher\RouteFilterInterface $route_filter + * The route filter. */ - public function addRouteEnhancer(BaseRouteEnhancerInterface $route_enhancer, $priority = 0) { - $this->enhancers[$priority][] = $route_enhancer; - return $this; + public function addRouteFilter(BaseRouteFilterInterface $route_filter) { + $this->filters[] = $route_filter; } /** - * Adds a route filter to the list of used route filters. - * - * @param \Symfony\Cmf\Component\Routing\NestedMatcher\RouteFilterInterface $route_filter - * A route filter. - * @param int $priority - * (optional) The priority of the filter. Higher number filters will be used - * first. + * Adds a route enhancer. * - * @return $this + * @param \Symfony\Cmf\Component\Routing\Enhancer\RouteEnhancerInterface $route_enhancer + * The route enhancer. */ - public function addRouteFilter(BaseRouteFilterInterface $route_filter, $priority = 0) { - $this->filters[$priority][] = $route_filter; - - return $this; + public function addRouteEnhancer(RouteEnhancerInterface $route_enhancer) { + $this->enhancers[] = $route_enhancer; } /** @@ -276,47 +250,16 @@ protected function getInitialRouteCollection(Request $request) { * from route enhancers. */ protected function applyRouteEnhancers($defaults, Request $request) { - foreach ($this->getRouteEnhancers() as $enhancer) { - $defaults = $enhancer->enhance($defaults, $request); + foreach ($this->enhancers as $enhancer) { + if (!$enhancer instanceof RouteEnhancerInterface || $enhancer->applies($defaults[RouteObjectInterface::ROUTE_OBJECT])) { + $defaults = $enhancer->enhance($defaults, $request); + } } return $defaults; } /** - * Sorts the enhancers and flattens them. - * - * @return \Symfony\Cmf\Component\Routing\Enhancer\RouteEnhancerInterface[] - * The enhancers ordered by priority. - */ - public function getRouteEnhancers() { - if (!isset($this->sortedEnhancers)) { - $this->sortedEnhancers = $this->sortRouteEnhancers(); - } - - return $this->sortedEnhancers; - } - - /** - * Sort enhancers by priority. - * - * The highest priority number is the highest priority (reverse sorting). - * - * @return \Symfony\Cmf\Component\Routing\Enhancer\RouteEnhancerInterface[] - * The sorted enhancers. - */ - protected function sortRouteEnhancers() { - $sortedEnhancers = []; - krsort($this->enhancers); - - foreach ($this->enhancers as $enhancers) { - $sortedEnhancers = array_merge($sortedEnhancers, $enhancers); - } - - return $sortedEnhancers; - } - - /** * Applies all route filters to a given route collection. * * This method reduces the sets of routes further down, for example by @@ -333,7 +276,8 @@ protected function sortRouteEnhancers() { protected function applyRouteFilters(RouteCollection $collection, Request $request) { // Route filters are expected to throw an exception themselves if they // end up filtering the list down to 0. - foreach ($this->getRouteFilters() as $filter) { + foreach ($this->filters as $filter) { + // @todo should we respect ::applies()? The problem is that we can't, because no route has been matched yet. So we should probably remove \Drupal\Core\Routing\RouteFilterInterface? $collection = $filter->filter($collection, $request); } @@ -341,39 +285,6 @@ protected function applyRouteFilters(RouteCollection $collection, Request $reque } /** - * Sorts the filters and flattens them. - * - * @return \Symfony\Cmf\Component\Routing\NestedMatcher\RouteFilterInterface[] - * The filters ordered by priority - */ - public function getRouteFilters() { - if (!isset($this->sortedFilters)) { - $this->sortedFilters = $this->sortFilters(); - } - - return $this->sortedFilters; - } - - /** - * Sort filters by priority. - * - * The highest priority number is the highest priority (reverse sorting). - * - * @return \Symfony\Cmf\Component\Routing\NestedMatcher\RouteFilterInterface[] - * The sorted filters. - */ - protected function sortFilters() { - $sortedFilters = []; - krsort($this->filters); - - foreach ($this->filters as $filters) { - $sortedFilters = array_merge($sortedFilters, $filters); - } - - return $sortedFilters; - } - - /** * {@inheritdoc} */ public function getRouteCollection() { diff --git a/core/modules/field_ui/src/Routing/FieldUiRouteEnhancer.php b/core/modules/field_ui/src/Routing/FieldUiRouteEnhancer.php index b8307e5c98..eef2caf9c2 100644 --- a/core/modules/field_ui/src/Routing/FieldUiRouteEnhancer.php +++ b/core/modules/field_ui/src/Routing/FieldUiRouteEnhancer.php @@ -3,9 +3,9 @@ namespace Drupal\field_ui\Routing; use Drupal\Core\Entity\EntityManagerInterface; -use Drupal\Core\Routing\Enhancer\RouteEnhancerInterface; +use Symfony\Cmf\Component\Routing\Enhancer\RouteEnhancerInterface; +use Symfony\Cmf\Component\Routing\RouteObjectInterface; use Symfony\Component\HttpFoundation\Request; -use Symfony\Component\Routing\Route; /** * Enhances Field UI routes by adding proper information about the bundle name. @@ -33,6 +33,10 @@ public function __construct(EntityManagerInterface $entity_manager) { * {@inheritdoc} */ public function enhance(array $defaults, Request $request) { + if (!$defaults[RouteObjectInterface::ROUTE_OBJECT]->hasOption('_field_ui')) { + return $defaults; + } + if (($bundle = $this->entityManager->getDefinition($defaults['entity_type_id'])->getBundleEntityType()) && isset($defaults[$bundle])) { // Field UI forms only need the actual name of the bundle they're dealing // with, not an upcasted entity object, so provide a simple way for them @@ -43,11 +47,4 @@ public function enhance(array $defaults, Request $request) { return $defaults; } - /** - * {@inheritdoc} - */ - public function applies(Route $route) { - return ($route->hasOption('_field_ui')); - } - } diff --git a/core/modules/system/tests/modules/accept_header_routing_test/src/Routing/AcceptHeaderMatcher.php b/core/modules/system/tests/modules/accept_header_routing_test/src/Routing/AcceptHeaderMatcher.php index 1a3c61eafb..9ab0b93bd4 100644 --- a/core/modules/system/tests/modules/accept_header_routing_test/src/Routing/AcceptHeaderMatcher.php +++ b/core/modules/system/tests/modules/accept_header_routing_test/src/Routing/AcceptHeaderMatcher.php @@ -2,10 +2,9 @@ namespace Drupal\accept_header_routing_test\Routing; -use Drupal\Core\Routing\RouteFilterInterface; +use Symfony\Cmf\Component\Routing\NestedMatcher\RouteFilterInterface; use Symfony\Component\HttpFoundation\Request; use Symfony\Component\HttpKernel\Exception\NotAcceptableHttpException; -use Symfony\Component\Routing\Route; use Symfony\Component\Routing\RouteCollection; /** @@ -59,11 +58,4 @@ public function filter(RouteCollection $collection, Request $request) { throw new NotAcceptableHttpException('No route found for the specified formats ' . implode(' ', $acceptable_mime_types)); } - /** - * {@inheritdoc} - */ - public function applies(Route $route) { - return TRUE; - } - }