diff --git a/core/lib/Drupal/Core/Access/AccessManager.php b/core/lib/Drupal/Core/Access/AccessManager.php index 54d13de..62644f8 100644 --- a/core/lib/Drupal/Core/Access/AccessManager.php +++ b/core/lib/Drupal/Core/Access/AccessManager.php @@ -185,6 +185,18 @@ protected function applies(Route $route) { public function checkNamedRoute($route_name, array $parameters = array(), AccountInterface $account, Request $route_request = NULL) { try { $route = $this->routeProvider->getRouteByName($route_name, $parameters); + return $this->checkRoute($route, $parameters, $account, $route_request); + } + catch (RouteNotFoundException $e) { + return FALSE; + } + } + + /** + * {@inheritdoc} + */ + public function checkRoute(Route $route, array $parameters, AccountInterface $account, Request $route_request) { + try { if (empty($route_request)) { // Create a cloned request with fresh attributes. $route_request = RequestHelper::duplicate($this->requestStack->getCurrentRequest(), $this->urlGenerator->generate($route_name, $parameters)); @@ -202,9 +214,6 @@ public function checkNamedRoute($route_name, array $parameters = array(), Accoun catch (RouteNotFoundException $e) { return FALSE; } - catch (ParamNotConvertedException $e) { - return FALSE; - } } /** diff --git a/core/lib/Drupal/Core/Access/AccessManagerInterface.php b/core/lib/Drupal/Core/Access/AccessManagerInterface.php index df88ba6..b7fac2a 100644 --- a/core/lib/Drupal/Core/Access/AccessManagerInterface.php +++ b/core/lib/Drupal/Core/Access/AccessManagerInterface.php @@ -56,6 +56,26 @@ public function checkNamedRoute($route_name, array $parameters = array(), AccountInterface $account, Request $route_request = NULL); /** + * Checks a route object with parameters against applicable access check services. + * + * Determines whether the route is accessible or not. + * + * @param \Drupal\Core\Routing\Route + * The route to check access to. + * @param array $parameters + * Optional array of values to substitute into the route path patern. + * @param \Drupal\Core\Session\AccountInterface $account + * The current user. + * @param \Symfony\Component\HttpFoundation\Request $route_request + * Optional incoming request object. If not provided, one will be built + * using the route information and the current request from the container. + * + * @return bool + * Returns TRUE if the user has access to the route, otherwise FALSE. + */ + public function checkRoute(Route $route, array $parameters, AccountInterface $account, Request $route_request); + + /** * For each route, saves a list of applicable access checks to the route. * * @param \Symfony\Component\Routing\RouteCollection $routes diff --git a/core/lib/Drupal/Core/Routing/CompiledRoute.php b/core/lib/Drupal/Core/Routing/CompiledRoute.php index 45aa22c..70a49a1 100644 --- a/core/lib/Drupal/Core/Routing/CompiledRoute.php +++ b/core/lib/Drupal/Core/Routing/CompiledRoute.php @@ -7,7 +7,6 @@ namespace Drupal\Core\Routing; -use Symfony\Component\Routing\Route; use Symfony\Component\Routing\CompiledRoute as SymfonyCompiledRoute; /** diff --git a/core/lib/Drupal/Core/Routing/CurrentRouteMatch.php b/core/lib/Drupal/Core/Routing/CurrentRouteMatch.php index b188930..573f47c 100644 --- a/core/lib/Drupal/Core/Routing/CurrentRouteMatch.php +++ b/core/lib/Drupal/Core/Routing/CurrentRouteMatch.php @@ -7,6 +7,7 @@ namespace Drupal\Core\Routing; +use Drupal\Core\Session\AccountInterface; use Symfony\Component\HttpFoundation\Request; use Symfony\Component\HttpFoundation\RequestStack; @@ -92,6 +93,21 @@ protected function getCurrentRouteMatch() { return $this->getRouteMatch($this->requestStack->getCurrentRequest()); } + + /** + * {@inheritdoc} + */ + public function access(AccountInterface $account) { + return $this->getCurrentRouteMatch()->access($account); + } + + /** + * {@inheritdoc} + */ + public function createUrlObject(array $options = array()) { + return $this->getCurrentRouteMatch()->createUrlObject($options); + } + /** * Returns the route match for a passed in request. * diff --git a/core/lib/Drupal/Core/Routing/MatcherDumper.php b/core/lib/Drupal/Core/Routing/MatcherDumper.php index 18e864f..157eff5 100644 --- a/core/lib/Drupal/Core/Routing/MatcherDumper.php +++ b/core/lib/Drupal/Core/Routing/MatcherDumper.php @@ -112,7 +112,7 @@ public function dump(array $options = array()) { )); $names = array(); foreach ($routes as $name => $route) { - /** @var \Symfony\Component\Routing\Route $route */ + /** @var \Drupal\Core\Routing\Route $route */ $route->setOption('compiler_class', '\Drupal\Core\Routing\RouteCompiler'); $compiled = $route->compile(); // The fit value is a binary number which has 1 at every fixed path diff --git a/core/lib/Drupal/Core/Routing/NullRouteMatch.php b/core/lib/Drupal/Core/Routing/NullRouteMatch.php index 0ef2c3b..6093ad8 100644 --- a/core/lib/Drupal/Core/Routing/NullRouteMatch.php +++ b/core/lib/Drupal/Core/Routing/NullRouteMatch.php @@ -7,6 +7,7 @@ namespace Drupal\Core\Routing; +use Drupal\Core\Session\AccountInterface; use Symfony\Component\HttpFoundation\ParameterBag; /** @@ -56,4 +57,17 @@ public function getRawParameters() { return new ParameterBag(); } + /** + * {@inheritdoc} + */ + public function access(AccountInterface $account) { + return FALSE; + } + + /** + * {@inheritdoc} + */ + public function createUrlObject(array $options = array()) { + return NULL; + } } diff --git a/core/lib/Drupal/Core/Routing/Route.php b/core/lib/Drupal/Core/Routing/Route.php new file mode 100644 index 0000000..c5a11b3 --- /dev/null +++ b/core/lib/Drupal/Core/Routing/Route.php @@ -0,0 +1,77 @@ +routeName = $route_name; + return $this; + } + + /** + * Returns the route name. + * + * @return string + */ + public function getRouteName() { + return $this->routeName; + } + + /** + * Creates a Url object from this route. + * + * @param array $route_parameters + * (optional) An associative array of parameter names and values. + * @param array $options + * (optional) An associative array of additional options, with the following + * elements: + * - 'query': An array of query key/value-pairs (without any URL-encoding) + * to append to the URL. Merged with the parameters array. + * - 'fragment': A fragment identifier (named anchor) to append to the URL. + * Do not include the leading '#' character. + * - 'absolute': Defaults to FALSE. Whether to force the output to be an + * absolute link (beginning with http:). Useful for links that will be + * displayed outside the site, such as in an RSS feed. + * - 'language': An optional language object used to look up the alias + * for the URL. If $options['language'] is omitted, it defaults to the + * current language for the language type LanguageInterface::TYPE_URL. + * - 'https': Whether this URL should point to a secure location. If not + * defined, the current scheme is used, so the user stays on HTTP or HTTPS + * respectively. if mixed mode sessions are permitted, TRUE enforces HTTPS + * and FALSE enforces HTTP. + * + * @return \Drupal\Core\Url + */ + public function createUrlObject($parameters = array(), $options = array()) { + return new Url($this->getRouteName(), $parameters, $options); + } + +} + diff --git a/core/lib/Drupal/Core/Routing/RouteBuilder.php b/core/lib/Drupal/Core/Routing/RouteBuilder.php index 6399f89..52ac7c1 100644 --- a/core/lib/Drupal/Core/Routing/RouteBuilder.php +++ b/core/lib/Drupal/Core/Routing/RouteBuilder.php @@ -13,7 +13,6 @@ use Symfony\Component\EventDispatcher\Event; use Symfony\Component\EventDispatcher\EventDispatcherInterface; use Symfony\Component\Routing\RouteCollection; -use Symfony\Component\Routing\Route; use Drupal\Core\Extension\ModuleHandlerInterface; use Drupal\Core\Lock\LockBackendInterface; @@ -131,6 +130,7 @@ public function rebuild() { else { foreach ($callback_routes as $name => $callback_route) { $collection->add($name, $callback_route); + $callback_route->setRouteName($name); } } } @@ -146,6 +146,7 @@ public function rebuild() { $route = new Route($route_info['path'], $route_info['defaults'], $route_info['requirements'], $route_info['options']); $collection->add($name, $route); + $route->setRouteName($name); } } diff --git a/core/lib/Drupal/Core/Routing/RouteCompiler.php b/core/lib/Drupal/Core/Routing/RouteCompiler.php index 6ae58e1..c9a0784 100644 --- a/core/lib/Drupal/Core/Routing/RouteCompiler.php +++ b/core/lib/Drupal/Core/Routing/RouteCompiler.php @@ -8,7 +8,7 @@ namespace Drupal\Core\Routing; use Symfony\Component\Routing\RouteCompilerInterface; -use Symfony\Component\Routing\Route; +use Symfony\Component\Routing\Route as SymfonyRoute; use Symfony\Component\Routing\RouteCompiler as SymfonyRouteCompiler; /** @@ -35,7 +35,7 @@ class RouteCompiler extends SymfonyRouteCompiler implements RouteCompilerInterfa * @return \Drupal\Core\Routing\CompiledRoute * A CompiledRoute instance. */ - public static function compile(Route $route) { + public static function compile(SymfonyRoute $route) { $symfony_compiled = parent::compile($route); diff --git a/core/lib/Drupal/Core/Routing/RouteMatch.php b/core/lib/Drupal/Core/Routing/RouteMatch.php index eafb184..9d29edb 100644 --- a/core/lib/Drupal/Core/Routing/RouteMatch.php +++ b/core/lib/Drupal/Core/Routing/RouteMatch.php @@ -7,10 +7,12 @@ namespace Drupal\Core\Routing; +use Drupal\Core\Access\AccessManagerInterface; +use Drupal\Core\Session\AccountInterface; +use Drupal\Core\Url; use Symfony\Cmf\Component\Routing\RouteObjectInterface; use Symfony\Component\HttpFoundation\ParameterBag; use Symfony\Component\HttpFoundation\Request; -use Symfony\Component\Routing\Route; /** * Default object representing the results of routing. @@ -27,7 +29,7 @@ class RouteMatch implements RouteMatchInterface { /** * The route. * - * @var \Symfony\Component\Routing\Route + * @var \Drupal\Core\Routing\Route */ protected $route; @@ -46,6 +48,13 @@ class RouteMatch implements RouteMatchInterface { protected $rawParameters; /** + * The access manager. + * + * @var \Drupal\Core\Access\AccessManagerInterface + */ + protected $accessManager; + + /** * Constructs a RouteMatch object. * * @param string $route_name @@ -56,10 +65,12 @@ class RouteMatch implements RouteMatchInterface { * The parameters array. * @param array $raw_parameters * The raw $parameters array. + * @param \Symfony\Component\HttpFoundation\Request $request */ - public function __construct($route_name, Route $route, array $parameters = array(), array $raw_parameters = array()) { + public function __construct($route_name, Route $route, array $parameters = array(), array $raw_parameters = array(), Request $request = NULL) { $this->routeName = $route_name; $this->route = $route; + $this->request = $request; // Pre-filter parameters. $route_params = $this->getParameterNames(); @@ -90,7 +101,8 @@ public static function createFromRequest(Request $request) { $request->attributes->get(RouteObjectInterface::ROUTE_NAME), $request->attributes->get(RouteObjectInterface::ROUTE_OBJECT), $request->attributes->all(), - $raw_variables); + $raw_variables, + $request); } else { return new NullRouteMatch(); @@ -140,6 +152,34 @@ public function getRawParameters() { } /** + * {@inheritdoc} + */ + public function createUrlObject(array $options = array()) { + return new Url($this->getRouteName(), $this->getRawParameters(), $options); + } + + /** + * {@inheritdoc} + */ + public function access(AccountInterface $account) { + $this->getAccessManager()->checkRoute($this->getRouteObject(), $this->getRawParameters(), $account, $this->request); + } + + /** + * @return \Drupal\Core\Access\AccessManagerInterface + */ + protected function getAccessManager() { + if (!isset($this->accessManager)) { + $this->accessManager = \Drupal::service('access.manager'); + } + return $this->accessManager; + } + + public function setAccessManager(AccessManagerInterface $access_manager) { + $this->accessManager = $access_manager; + } + + /** * Returns the names of all parameters for the currently matched route. * * @return array diff --git a/core/lib/Drupal/Core/Routing/RouteMatchInterface.php b/core/lib/Drupal/Core/Routing/RouteMatchInterface.php index f0d9aa8..ad51db1 100644 --- a/core/lib/Drupal/Core/Routing/RouteMatchInterface.php +++ b/core/lib/Drupal/Core/Routing/RouteMatchInterface.php @@ -7,6 +7,8 @@ namespace Drupal\Core\Routing; +use Drupal\Core\Session\AccountInterface; + /** * Provides an interface for classes representing the result of routing. * @@ -79,4 +81,43 @@ public function getRawParameter($parameter_name); */ public function getRawParameters(); + /** + * Checks a route match object with against applicable access check services. + * + * Determines whether the route is accessible or not. + * + * @param \Drupal\Core\Session\AccountInterface $account + * The current user. + * + * @return bool + * Returns TRUE if the user has access to the route, otherwise FALSE. + */ + public function access(AccountInterface $account); + + /** + * Creates a Url object from this route match. + * + * @param array $options + * (optional) An associative array of additional options, with the following + * elements: + * - 'query': An array of query key/value-pairs (without any URL-encoding) + * to append to the URL. Merged with the parameters array. + * - 'fragment': A fragment identifier (named anchor) to append to the URL. + * Do not include the leading '#' character. + * - 'absolute': Defaults to FALSE. Whether to force the output to be an + * absolute link (beginning with http:). Useful for links that will be + * displayed outside the site, such as in an RSS feed. + * - 'language': An optional language object used to look up the alias + * for the URL. If $options['language'] is omitted, it defaults to the + * current language for the language type LanguageInterface::TYPE_URL. + * - 'https': Whether this URL should point to a secure location. If not + * defined, the current scheme is used, so the user stays on HTTP or HTTPS + * respectively. if mixed mode sessions are permitted, TRUE enforces HTTPS + * and FALSE enforces HTTP. + * + * @return \Drupal\Core\Url|NULL + * The url object. NULL if no route is matched. + */ + public function createUrlObject(array $options = array()); + } diff --git a/core/lib/Drupal/Core/Url.php b/core/lib/Drupal/Core/Url.php index 874335e..97380dd 100644 --- a/core/lib/Drupal/Core/Url.php +++ b/core/lib/Drupal/Core/Url.php @@ -8,9 +8,11 @@ namespace Drupal\Core; use Drupal\Component\Utility\UrlHelper; +use Drupal\Core\Access\AccessManagerInterface; use Drupal\Core\DependencyInjection\DependencySerializationTrait; use Drupal\Core\Routing\MatchingRouteNotFoundException; use Drupal\Core\Routing\UrlGeneratorInterface; +use Drupal\Core\Session\AccountInterface; use Symfony\Cmf\Component\Routing\RouteObjectInterface; use Symfony\Component\HttpFoundation\Request; use Symfony\Component\Routing\Exception\ResourceNotFoundException; @@ -416,6 +418,35 @@ public function getInternalPath() { } /** + * Checks this Url object against applicable access check services. + * + * Determines whether the route is accessible or not. + * + * @param \Drupal\Core\Session\AccountInterface $account + * The current user. + * + * @return bool + * Returns TRUE if the user has access to the url, otherwise FALSE. + */ + public function access(AccountInterface $account) { + $this->getAccessManager()->checkNamedRoute($this->getRouteName(), $this->getRouteParameters(), $account); + } + + /** + * @return \Drupal\Core\Access\AccessManagerInterface + */ + protected function getAccessManager() { + if (!isset($this->accessManager)) { + $this->accessManager = \Drupal::service('access.manager'); + } + return $this->accessManager; + } + + public function setAccessManager(AccessManagerInterface $access_manager) { + $this->accessManager = $access_manager; + } + + /** * Gets the URL generator. * * @return \Drupal\Core\Routing\UrlGeneratorInterface diff --git a/core/modules/config_translation/src/ConfigEntityMapper.php b/core/modules/config_translation/src/ConfigEntityMapper.php index aa92fcd..46599e1 100644 --- a/core/modules/config_translation/src/ConfigEntityMapper.php +++ b/core/modules/config_translation/src/ConfigEntityMapper.php @@ -16,7 +16,7 @@ use Drupal\locale\LocaleConfigManager; use Symfony\Component\DependencyInjection\ContainerInterface; use Symfony\Component\HttpFoundation\Request; -use Symfony\Component\Routing\Route; +use Drupal\Core\Routing\Route; /** * Configuration mapper for configuration entities. diff --git a/core/modules/config_translation/src/ConfigNamesMapper.php b/core/modules/config_translation/src/ConfigNamesMapper.php index 57811d9..2f322da 100644 --- a/core/modules/config_translation/src/ConfigNamesMapper.php +++ b/core/modules/config_translation/src/ConfigNamesMapper.php @@ -18,7 +18,7 @@ use Drupal\locale\LocaleConfigManager; use Symfony\Component\DependencyInjection\ContainerInterface; use Symfony\Component\HttpFoundation\Request; -use Symfony\Component\Routing\Route; +use Drupal\Core\Routing\Route; use Symfony\Component\Routing\RouteCollection; /** diff --git a/core/modules/content_translation/src/Routing/ContentTranslationRouteSubscriber.php b/core/modules/content_translation/src/Routing/ContentTranslationRouteSubscriber.php index aa9f346..504fceb 100644 --- a/core/modules/content_translation/src/Routing/ContentTranslationRouteSubscriber.php +++ b/core/modules/content_translation/src/Routing/ContentTranslationRouteSubscriber.php @@ -11,7 +11,7 @@ use Drupal\Core\Access\AccessManagerInterface; use Drupal\Core\Routing\RouteSubscriberBase; use Drupal\Core\Routing\RoutingEvents; -use Symfony\Component\Routing\Route; +use Drupal\Core\Routing\Route; use Symfony\Component\Routing\RouteCollection; /** diff --git a/core/modules/field_ui/src/Routing/RouteSubscriber.php b/core/modules/field_ui/src/Routing/RouteSubscriber.php index 9820438..0687b29 100644 --- a/core/modules/field_ui/src/Routing/RouteSubscriber.php +++ b/core/modules/field_ui/src/Routing/RouteSubscriber.php @@ -10,7 +10,7 @@ use Drupal\Core\Entity\EntityManagerInterface; use Drupal\Core\Routing\RouteSubscriberBase; use Drupal\Core\Routing\RoutingEvents; -use Symfony\Component\Routing\Route; +use Drupal\Core\Routing\Route; use Symfony\Component\Routing\RouteCollection; /** diff --git a/core/modules/image/src/Routing/ImageStyleRoutes.php b/core/modules/image/src/Routing/ImageStyleRoutes.php index 39b2379..7790358 100644 --- a/core/modules/image/src/Routing/ImageStyleRoutes.php +++ b/core/modules/image/src/Routing/ImageStyleRoutes.php @@ -7,7 +7,7 @@ namespace Drupal\image\Routing; -use Symfony\Component\Routing\Route; +use Drupal\Core\Routing\Route; /** * Defines a route subscriber to register a url for serving image styles. diff --git a/core/modules/search/src/Routing/SearchPageRoutes.php b/core/modules/search/src/Routing/SearchPageRoutes.php index 0d30957..2c3ed6e 100644 --- a/core/modules/search/src/Routing/SearchPageRoutes.php +++ b/core/modules/search/src/Routing/SearchPageRoutes.php @@ -10,7 +10,7 @@ use Drupal\Core\DependencyInjection\ContainerInjectionInterface; use Drupal\search\SearchPageRepositoryInterface; use Symfony\Component\DependencyInjection\ContainerInterface; -use Symfony\Component\Routing\Route; +use Drupal\Core\Routing\Route; /** * Provides dynamic routes for search. diff --git a/core/modules/system/tests/modules/entity_test/src/Routing/EntityTestRoutes.php b/core/modules/system/tests/modules/entity_test/src/Routing/EntityTestRoutes.php index c235335..a1329afc 100644 --- a/core/modules/system/tests/modules/entity_test/src/Routing/EntityTestRoutes.php +++ b/core/modules/system/tests/modules/entity_test/src/Routing/EntityTestRoutes.php @@ -7,7 +7,7 @@ namespace Drupal\entity_test\Routing; -use Symfony\Component\Routing\Route; +use Drupal\Core\Routing\Route; /** * Subscriber for Entity Test routes. diff --git a/core/modules/views/src/Plugin/views/display/PathPluginBase.php b/core/modules/views/src/Plugin/views/display/PathPluginBase.php index 07a2816..2ec942a 100644 --- a/core/modules/views/src/Plugin/views/display/PathPluginBase.php +++ b/core/modules/views/src/Plugin/views/display/PathPluginBase.php @@ -17,7 +17,7 @@ use Symfony\Component\DependencyInjection\ContainerInterface; use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException; use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; -use Symfony\Component\Routing\Route; +use Drupal\Core\Routing\Route; use Symfony\Component\Routing\RouteCollection; /** diff --git a/core/tests/Drupal/Tests/Core/Routing/RouteBuilderTest.php b/core/tests/Drupal/Tests/Core/Routing/RouteBuilderTest.php index aff9896..3a0ca4f 100644 --- a/core/tests/Drupal/Tests/Core/Routing/RouteBuilderTest.php +++ b/core/tests/Drupal/Tests/Core/Routing/RouteBuilderTest.php @@ -13,7 +13,7 @@ use Drupal\Core\Routing\RouteBuildEvent; use Drupal\Core\Routing\RoutingEvents; use Drupal\Tests\UnitTestCase; -use Symfony\Component\Routing\Route; +use Drupal\Core\Routing\Route; use Symfony\Component\Routing\RouteCollection; /**