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

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

8 9
namespace Drupal\Core\Routing;

10
use Drupal\Component\Discovery\YamlDiscovery;
11
use Drupal\Core\Controller\ControllerResolverInterface;
12
use Drupal\Core\State\StateInterface;
13
use Symfony\Component\EventDispatcher\Event;
14 15 16 17
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\Routing\RouteCollection;
use Symfony\Component\Routing\Route;

18
use Drupal\Core\Extension\ModuleHandlerInterface;
19
use Drupal\Core\Lock\LockBackendInterface;
20 21 22 23

/**
 * Managing class for rebuilding the router table.
 */
24
class RouteBuilder implements RouteBuilderInterface {
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
   * Constructs the RouteBuilder using the passed MatcherDumperInterface.
77
   *
78
   * @param \Drupal\Core\Routing\MatcherDumperInterface $dumper
79
   *   The matcher dumper used to store the route information.
80 81
   * @param \Drupal\Core\Lock\LockBackendInterface $lock
   *   The lock backend.
82
   * @param \Symfony\Component\EventDispatcher\EventDispatcherInterface $dispatcher
83
   *   The event dispatcher to notify of routes.
84 85
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler.
86 87
   * @param \Drupal\Core\Controller\ControllerResolverInterface $controller_resolver
   *   The controller resolver.
88 89
   * @param \Drupal\Core\KeyValueStore\StateInterface $state
   *   The state.
90
   */
91
  public function __construct(MatcherDumperInterface $dumper, LockBackendInterface $lock, EventDispatcherInterface $dispatcher, ModuleHandlerInterface $module_handler, ControllerResolverInterface $controller_resolver, StateInterface $state = NULL) {
92
    $this->dumper = $dumper;
93
    $this->lock = $lock;
94
    $this->dispatcher = $dispatcher;
95
    $this->moduleHandler = $module_handler;
96
    $this->controllerResolver = $controller_resolver;
97
    $this->state = $state;
98 99
  }

100
  /**
101
   * {@inheritdoc}
102
   */
103
  public function rebuild() {
104 105 106 107 108
    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');
109
      return FALSE;
110 111
    }

112 113 114
    $collection = new RouteCollection();
    $this->routeCollection = $collection;
    foreach ($this->getRouteDefinitions() as $routes) {
115 116 117
      // 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
118 119 120 121
      // 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.
122 123 124 125
      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)) {
126 127 128 129 130 131 132 133 134
            // 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);
              }
135 136 137 138 139
            }
          }
        }
        unset($routes['route_callbacks']);
      }
140 141 142 143 144 145 146
      foreach ($routes as $name => $route_info) {
        $route_info += array(
          'defaults' => array(),
          'requirements' => array(),
          'options' => array(),
        );

147
        $route = new Route($route_info['path'], $route_info['defaults'], $route_info['requirements'], $route_info['options']);
148
        $collection->add($name, $route);
149
      }
150

151
    }
152

153 154 155 156 157 158 159 160 161
    // 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));

162
    $this->dumper->addRoutes($collection);
163
    $this->dumper->dump();
164

165
    $this->state->delete(static::REBUILD_NEEDED);
166
    $this->lock->release('router_rebuild');
167
    $this->dispatcher->dispatch(RoutingEvents::FINISHED, new Event());
168 169 170

    $this->routeCollection = NULL;

171 172 173
    return TRUE;
  }

174 175 176 177 178 179 180
  /**
   * {@inheritdoc}
   */
  public function getCollectionDuringRebuild() {
    return $this->routeCollection ?: FALSE;
  }

181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197
  /**
   * {@inheritdoc}
   */
  public function rebuildIfNeeded() {
    if ($this->state->get(static::REBUILD_NEEDED, FALSE)) {
      return $this->rebuild();
    }
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function setRebuildNeeded() {
    $this->state->set(static::REBUILD_NEEDED, TRUE);
  }

198
  /**
199
   * Retrieves all defined routes from .routing.yml files.
200
   *
201 202
   * @return array
   *   The defined routes, keyed by provider.
203
   */
204
  protected function getRouteDefinitions() {
205 206 207
    if (!isset($this->yamlDiscovery)) {
      $this->yamlDiscovery = new YamlDiscovery('routing', $this->moduleHandler->getModuleDirectories());
    }
208
    return $this->yamlDiscovery->findAll();
209 210 211
  }

}