RouteBuilder.php 7.19 KB
Newer Older
1 2
<?php

3 4
/**
 * @file
5
 * Contains \Drupal\Core\Routing\RouteBuilder.
6 7
 */

8 9
namespace Drupal\Core\Routing;

10
use Drupal\Component\Discovery\YamlDiscovery;
11
use Drupal\Core\Access\CheckProviderInterface;
12
use Drupal\Core\Controller\ControllerResolverInterface;
13 14
use Drupal\Core\Extension\ModuleHandlerInterface;
use Drupal\Core\Lock\LockBackendInterface;
15
use Drupal\Core\DestructableInterface;
16
use Symfony\Component\EventDispatcher\Event;
17 18 19 20
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\Routing\RouteCollection;
use Symfony\Component\Routing\Route;

21 22 23
/**
 * Managing class for rebuilding the router table.
 */
24
class RouteBuilder implements RouteBuilderInterface, DestructableInterface {
25

26 27 28
  /**
   * The dumper to which we should send collected routes.
   *
29
   * @var \Drupal\Core\Routing\MatcherDumperInterface
30
   */
31 32
  protected $dumper;

33 34 35 36 37 38 39
  /**
   * The used lock backend instance.
   *
   * @var \Drupal\Core\Lock\LockBackendInterface $lock
   */
  protected $lock;

40 41 42 43 44 45 46
  /**
   * The event dispatcher to notify of routes.
   *
   * @var \Symfony\Component\EventDispatcher\EventDispatcherInterface
   */
  protected $dispatcher;

47
  /**
48 49 50 51 52 53 54 55
   * The yaml discovery used to find all the .routing.yml files.
   *
   * @var \Drupal\Component\Discovery\YamlDiscovery
   */
  protected $yamlDiscovery;

  /**
   * The module handler.
56 57 58 59 60
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

61 62 63 64 65 66 67
  /**
   * The controller resolver.
   *
   * @var \Drupal\Core\Controller\ControllerResolverInterface
   */
  protected $controllerResolver;

68 69 70 71 72 73 74
  /**
   * The route collection during the rebuild.
   *
   * @var \Symfony\Component\Routing\RouteCollection
   */
  protected $routeCollection;

75
  /**
76
   * Flag that indicates if we are currently rebuilding the routes.
77 78 79 80 81
   *
   * @var bool
   */
  protected $building = FALSE;

82 83 84 85 86 87 88
  /**
   * Flag that indicates if we should rebuild at the end of the request.
   *
   * @var bool
   */
  protected $rebuildNeeded = FALSE;

89 90 91 92 93 94 95
  /**
   * The check provider.
   *
   * @var \Drupal\Core\Access\CheckProviderInterface
   */
  protected $checkProvider;

96
  /**
97
   * Constructs the RouteBuilder using the passed MatcherDumperInterface.
98
   *
99
   * @param \Drupal\Core\Routing\MatcherDumperInterface $dumper
100
   *   The matcher dumper used to store the route information.
101 102
   * @param \Drupal\Core\Lock\LockBackendInterface $lock
   *   The lock backend.
103
   * @param \Symfony\Component\EventDispatcher\EventDispatcherInterface $dispatcher
104
   *   The event dispatcher to notify of routes.
105 106
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler.
107 108
   * @param \Drupal\Core\Controller\ControllerResolverInterface $controller_resolver
   *   The controller resolver.
109 110
   * @param \Drupal\Core\Access\CheckProviderInterface $check_provider
   *   The check provider.
111
   */
112
  public function __construct(MatcherDumperInterface $dumper, LockBackendInterface $lock, EventDispatcherInterface $dispatcher, ModuleHandlerInterface $module_handler, ControllerResolverInterface $controller_resolver, CheckProviderInterface $check_provider) {
113
    $this->dumper = $dumper;
114
    $this->lock = $lock;
115
    $this->dispatcher = $dispatcher;
116
    $this->moduleHandler = $module_handler;
117
    $this->controllerResolver = $controller_resolver;
118
    $this->checkProvider = $check_provider;
119 120
  }

121 122 123 124 125 126 127
  /**
   * {@inheritdoc}
   */
  public function setRebuildNeeded() {
    $this->rebuildNeeded = TRUE;
  }

128
  /**
129
   * {@inheritdoc}
130
   */
131
  public function rebuild() {
132 133 134 135
    if ($this->building) {
      throw new \RuntimeException('Recursive router rebuild detected.');
    }

136 137 138 139 140
    if (!$this->lock->acquire('router_rebuild')) {
      // Wait for another request that is already doing this work.
      // We choose to block here since otherwise the routes might not be
      // available, resulting in a 404.
      $this->lock->wait('router_rebuild');
141
      return FALSE;
142 143
    }

144 145
    $this->building = TRUE;

146 147
    $collection = new RouteCollection();
    foreach ($this->getRouteDefinitions() as $routes) {
148 149 150
      // The top-level 'routes_callback' is a list of methods in controller
      // syntax, see \Drupal\Core\Controller\ControllerResolver. These methods
      // should return a set of \Symfony\Component\Routing\Route objects, either
151 152 153 154
      // in an associative array keyed by the route name, which will be iterated
      // over and added to the collection for this provider, or as a new
      // \Symfony\Component\Routing\RouteCollection object, which will be added
      // to the collection.
155 156 157 158
      if (isset($routes['route_callbacks'])) {
        foreach ($routes['route_callbacks'] as $route_callback) {
          $callback = $this->controllerResolver->getControllerFromDefinition($route_callback);
          if ($callback_routes = call_user_func($callback)) {
159 160 161 162 163 164 165 166 167
            // If a RouteCollection is returned, add the whole collection.
            if ($callback_routes instanceof RouteCollection) {
              $collection->addCollection($callback_routes);
            }
            // Otherwise, add each Route object individually.
            else {
              foreach ($callback_routes as $name => $callback_route) {
                $collection->add($name, $callback_route);
              }
168 169 170 171 172
            }
          }
        }
        unset($routes['route_callbacks']);
      }
173 174 175 176 177 178 179
      foreach ($routes as $name => $route_info) {
        $route_info += array(
          'defaults' => array(),
          'requirements' => array(),
          'options' => array(),
        );

180
        $route = new Route($route_info['path'], $route_info['defaults'], $route_info['requirements'], $route_info['options']);
181
        $collection->add($name, $route);
182
      }
183
    }
184

185 186 187 188 189 190 191 192 193
    // DYNAMIC is supposed to be used to add new routes based upon all the
    // static defined ones.
    $this->dispatcher->dispatch(RoutingEvents::DYNAMIC, new RouteBuildEvent($collection));

    // ALTER is the final step to alter all the existing routes. We cannot stop
    // people from adding new routes here, but we define two separate steps to
    // make it clear.
    $this->dispatcher->dispatch(RoutingEvents::ALTER, new RouteBuildEvent($collection));

194 195
    $this->checkProvider->setChecks($collection);

196
    $this->dumper->addRoutes($collection);
197
    $this->dumper->dump();
198

199
    $this->lock->release('router_rebuild');
200
    $this->dispatcher->dispatch(RoutingEvents::FINISHED, new Event());
201
    $this->building = FALSE;
202

203
    $this->rebuildNeeded = FALSE;
204

205 206 207
    return TRUE;
  }

208 209 210 211
  /**
   * {@inheritdoc}
   */
  public function rebuildIfNeeded() {
212
    if ($this->rebuildNeeded) {
213 214 215 216 217 218 219 220
      return $this->rebuild();
    }
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
221 222 223 224 225
  public function destruct() {
    // Rebuild routes only once at the end of the request lifecycle to not
    // trigger multiple rebuilds and also make the page more responsive for the
    // user.
    $this->rebuildIfNeeded();
226 227
  }

228
  /**
229
   * Retrieves all defined routes from .routing.yml files.
230
   *
231 232
   * @return array
   *   The defined routes, keyed by provider.
233
   */
234
  protected function getRouteDefinitions() {
235 236 237
    if (!isset($this->yamlDiscovery)) {
      $this->yamlDiscovery = new YamlDiscovery('routing', $this->moduleHandler->getModuleDirectories());
    }
238
    return $this->yamlDiscovery->findAll();
239 240 241
  }

}