AccessAwareRouter.php 4.12 KB
Newer Older
1 2 3 4 5
<?php

namespace Drupal\Core\Routing;

use Drupal\Core\Access\AccessManagerInterface;
6
use Drupal\Core\Access\AccessResultReasonInterface;
7
use Drupal\Core\Session\AccountInterface;
8
use Symfony\Cmf\Component\Routing\ChainRouter;
9 10
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
11
use Symfony\Component\Routing\RequestContext as SymfonyRequestContext;
12 13 14 15 16 17 18

/**
 * A router class for Drupal with access check and upcasting.
 */
class AccessAwareRouter implements AccessAwareRouterInterface {

  /**
19
   * The chain router doing the actual routing.
20
   *
21
   * @var \Symfony\Cmf\Component\Routing\ChainRouter
22
   */
23
  protected $chainRouter;
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41

  /**
   * The access manager.
   *
   * @var \Drupal\Core\Access\AccessManagerInterface
   */
  protected $accessManager;

  /**
   * The account to use in access checks.
   *
   * @var \Drupal\Core\Session\AccountInterface;
   */
  protected $account;

  /**
   * Constructs a router for Drupal with access check and upcasting.
   *
42 43
   * @param \Symfony\Cmf\Component\Routing\ChainRouter $chain_router
   *   The chain router doing the actual routing.
44 45 46 47 48
   * @param \Drupal\Core\Access\AccessManagerInterface $access_manager
   *   The access manager.
   * @param \Drupal\Core\Session\AccountInterface $account
   *   The account to use in access checks.
   */
49 50
  public function __construct(ChainRouter $chain_router, AccessManagerInterface $access_manager, AccountInterface $account) {
    $this->chainRouter = $chain_router;
51 52 53 54 55 56 57 58
    $this->accessManager = $access_manager;
    $this->account = $account;
  }

  /**
   * {@inheritdoc}
   */
  public function __call($name, $arguments) {
59 60 61
    // Ensure to call every other function to the chained router.
    // @todo Sadly does the ChainRouter not implement an interface in CMF.
    return call_user_func_array([$this->chainRouter, $name], $arguments);
62 63 64 65 66
  }

  /**
   * {@inheritdoc}
   */
67
  public function setContext(SymfonyRequestContext $context) {
68
    $this->chainRouter->setContext($context);
69 70 71 72 73 74
  }

  /**
   * {@inheritdoc}
   */
  public function getContext() {
75
    return $this->chainRouter->getContext();
76 77 78 79 80 81 82 83 84
  }

  /**
   * {@inheritdoc}
   *
   * @throws \Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException
   *   Thrown when access checking failed.
   */
  public function matchRequest(Request $request) {
85
    $parameters = $this->chainRouter->matchRequest($request);
86 87 88 89 90 91 92 93 94 95 96 97 98 99
    $request->attributes->add($parameters);
    $this->checkAccess($request);
    // We can not return $parameters because the access check can change the
    // request attributes.
    return $request->attributes->all();
  }

  /**
   * Apply access check service to the route and parameters in the request.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request to access check.
   */
  protected function checkAccess(Request $request) {
100 101 102 103 104 105 106 107 108
    // The cacheability (if any) of this request's access check result must be
    // applied to the response.
    $access_result = $this->accessManager->checkRequest($request, $this->account, TRUE);
    // Allow a master request to set the access result for a subrequest: if an
    // access result attribute is already set, don't overwrite it.
    if (!$request->attributes->has(AccessAwareRouterInterface::ACCESS_RESULT)) {
      $request->attributes->set(AccessAwareRouterInterface::ACCESS_RESULT, $access_result);
    }
    if (!$access_result->isAllowed()) {
109
      throw new AccessDeniedHttpException($access_result instanceof AccessResultReasonInterface ? $access_result->getReason() : NULL);
110 111 112 113 114 115 116
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getRouteCollection() {
117
    return $this->chainRouter->getRouteCollection();
118 119 120 121 122 123
  }

  /**
   * {@inheritdoc}
   */
  public function generate($name, $parameters = array(), $referenceType = self::ABSOLUTE_PATH) {
124
    return $this->chainRouter->generate($name, $parameters, $referenceType);
125 126 127 128 129 130 131 132 133 134 135 136 137
  }

  /**
   * {@inheritdoc}
   *
   * @throws \Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException
   *   Thrown when access checking failed.
   */
  public function match($pathinfo) {
    return $this->matchRequest(Request::create($pathinfo));
  }

}