DrupalKernel.php 21.6 KB
Newer Older
1 2 3 4 5 6 7 8 9
<?php

/**
 * @file
 * Definition of Drupal\Core\DrupalKernel.
 */

namespace Drupal\Core;

10 11
use Drupal\Component\PhpStorage\PhpStorageFactory;
use Drupal\Core\Config\BootstrapConfigStorageFactory;
12
use Drupal\Core\CoreServiceProvider;
13
use Drupal\Core\DependencyInjection\ContainerBuilder;
14
use Drupal\Core\DependencyInjection\ServiceProviderInterface;
15
use Drupal\Core\DependencyInjection\YamlFileLoader;
16 17
use Symfony\Component\Config\Loader\LoaderInterface;
use Symfony\Component\DependencyInjection\ParameterBag\ParameterBag;
18
use Symfony\Component\DependencyInjection\Dumper\PhpDumper;
19 20 21 22
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\HttpKernelInterface;
use Symfony\Component\HttpKernel\TerminableInterface;
23
use Composer\Autoload\ClassLoader;
24 25 26

/**
 * The DrupalKernel class is the core of Drupal itself.
27 28
 *
 * This class is responsible for building the Dependency Injection Container and
29 30 31 32 33 34 35 36
 * also deals with the registration of service providers. It allows registered
 * service providers to add their services to the container. Core provides the
 * CoreServiceProvider, which, in addition to registering any core services that
 * cannot be registered in the core.services.yaml file, adds any compiler passes
 * needed by core, e.g. for processing tagged services. Each module can add its
 * own service provider, i.e. a class implementing
 * Drupal\Core\DependencyInjection\ServiceProvider, to register services to the
 * container, or modify existing services.
37
 */
38 39
class DrupalKernel implements DrupalKernelInterface, TerminableInterface {

40
  const CONTAINER_BASE_CLASS = '\Drupal\Core\DependencyInjection\Container';
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61

  /**
   * Holds the container instance.
   *
   * @var \Symfony\Component\DependencyInjection\ContainerInterface
   */
  protected $container;

  /**
   * The environment, e.g. 'testing', 'install'.
   *
   * @var string
   */
  protected $environment;

  /**
   * Whether the kernel has been booted.
   *
   * @var bool
   */
  protected $booted;
62

63 64 65 66
  /**
   * Holds the list of enabled modules.
   *
   * @var array
67 68
   *   An associative array whose keys are module names and whose values are
   *   ignored.
69 70 71 72
   */
  protected $moduleList;

  /**
73
   * Holds an updated list of enabled modules.
74
   *
75 76 77 78 79 80 81 82 83 84 85 86 87
   * @var array
   *   An associative array whose keys are module names and whose values are
   *   ignored.
   */
  protected $newModuleList;

  /**
   * An array of module data objects.
   *
   * The data objects have the same data structure as returned by
   * file_scan_directory() but only the uri property is used.
   *
   * @var array
88
   */
89
  protected $moduleData = array();
90 91 92 93 94 95 96 97

  /**
   * PHP code storage object to use for the compiled container.
   *
   * @var \Drupal\Component\PhpStorage\PhpStorageInterface
   */
  protected $storage;

98 99 100
  /**
   * The classloader object.
   *
101
   * @var \Composer\Autoload\ClassLoader
102 103 104
   */
  protected $classLoader;

105 106 107 108 109 110 111
  /**
   * Config storage object used for reading enabled modules configuration.
   *
   * @var \Drupal\Core\Config\StorageInterface
   */
  protected $configStorage;

112
  /**
113
   * The list of the classnames of the service providers in this kernel.
114 115 116
   *
   * @var array
   */
117
  protected $serviceProviderClasses;
118

119 120 121 122 123 124 125 126 127 128 129 130 131 132
  /**
   * Whether the container can be dumped.
   *
   * @var bool
   */
  protected $allowDumping;

  /**
   * Whether the container needs to be dumped once booting is complete.
   *
   * @var bool
   */
  protected $containerNeedsDumping;

133 134 135 136 137 138 139
  /**
   * Holds the list of YAML files containing service definitions.
   *
   * @var array
   */
  protected $serviceYamls;

140 141 142 143 144 145 146
  /**
   * The array of registered service providers.
   *
   * @var array
   */
  protected $serviceProviders;

147 148 149 150 151 152 153
  /**
   * Constructs a DrupalKernel object.
   *
   * @param string $environment
   *   String indicating the environment, e.g. 'prod' or 'dev'. Used by
   *   Symfony\Component\HttpKernel\Kernel::__construct(). Drupal does not use
   *   this value currently. Pass 'prod'.
154
   * @param \Composer\Autoload\ClassLoader $class_loader
155 156 157
   *   (optional) The classloader is only used if $storage is not given or
   *   the load from storage fails and a container rebuild is required. In
   *   this case, the loaded modules will be registered with this loader in
158
   *   order to be able to find the module serviceProviders.
159 160 161
   * @param bool $allow_dumping
   *   (optional) FALSE to stop the container from being written to or read
   *   from disk. Defaults to TRUE.
162
   */
163 164 165
  public function __construct($environment, ClassLoader $class_loader, $allow_dumping = TRUE) {
    $this->environment = $environment;
    $this->booted = false;
166
    $this->classLoader = $class_loader;
167
    $this->allowDumping = $allow_dumping;
168 169
  }

170
  /**
171
   * {@inheritdoc}
172 173 174 175 176 177 178
   */
  public function boot() {
    if ($this->booted) {
      return;
    }
    $this->initializeContainer();
    $this->booted = TRUE;
179
    if ($this->containerNeedsDumping && !$this->dumpDrupalContainer($this->container, static::CONTAINER_BASE_CLASS)) {
180 181
      watchdog('DrupalKernel', 'Container cannot be written to disk');
    }
182 183
  }

184
  /**
185
   * {@inheritdoc}
186
   */
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
  public function shutdown() {
    if (FALSE === $this->booted) {
      return;
    }
    $this->booted = FALSE;
    $this->container = null;
  }

  /**
   * {@inheritdoc}
   */
  public function getContainer() {
    return $this->container;
  }

  /**
   * {@inheritdoc}
   */
  public function discoverServiceProviders() {
206
    $this->configStorage = BootstrapConfigStorageFactory::get();
207 208
    $serviceProviders = array(
      'CoreServiceProvider' => new CoreServiceProvider(),
209
    );
210 211 212
    $this->serviceYamls = array(
      'core/core.services.yml'
    );
213
    $this->serviceProviderClasses = array('Drupal\Core\CoreServiceProvider');
214 215 216

    // Ensure we know what modules are enabled and that their namespaces are
    // registered.
217
    if (!isset($this->moduleList)) {
218
      $module_list = $this->configStorage->read('system.module');
219 220
      $this->moduleList = isset($module_list['enabled']) ? $module_list['enabled'] : array();
    }
221 222
    $module_filenames = $this->getModuleFileNames();
    $this->registerNamespaces($this->getModuleNamespaces($module_filenames));
223

224
    // Load each module's serviceProvider class.
225
    foreach ($this->moduleList as $module => $weight) {
katbailey's avatar
katbailey committed
226
      $camelized = ContainerBuilder::camelize($module);
227 228
      $name = "{$camelized}ServiceProvider";
      $class = "Drupal\\{$module}\\{$name}";
229
      if (class_exists($class)) {
230 231
        $serviceProviders[$name] = new $class();
        $this->serviceProviderClasses[] = $class;
232
      }
233 234 235 236
      $filename = dirname($module_filenames[$module]) . "/$module.services.yml";
      if (file_exists($filename)) {
        $this->serviceYamls[] = $filename;
      }
237
    }
238

239 240 241 242 243
    // Add site specific or test service providers.
    if (!empty($GLOBALS['conf']['container_service_providers'])) {
      foreach ($GLOBALS['conf']['container_service_providers'] as $name => $class) {
        $serviceProviders[$name] = new $class();
        $this->serviceProviderClasses[] = $class;
244 245
      }
    }
246 247 248 249
    // Add site specific or test YAMLs.
    if (!empty($GLOBALS['conf']['container_yamls'])) {
      $this->serviceYamls = array_merge($this->serviceYamls, $GLOBALS['conf']['container_yamls']);
    }
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
    return $serviceProviders;
  }


  /**
   * {@inheritdoc}
   */
  public function getServiceProviders() {
    return $this->serviceProviders;
  }

  /**
   * {@inheritdoc}
   */
  public function terminate(Request $request, Response $response) {
    if (FALSE === $this->booted) {
      return;
    }

    if ($this->getHttpKernel() instanceof TerminableInterface) {
      $this->getHttpKernel()->terminate($request, $response);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function handle(Request $request, $type = HttpKernelInterface::MASTER_REQUEST, $catch = true) {
    if (FALSE === $this->booted) {
      $this->boot();
    }

    return $this->getHttpKernel()->handle($request, $type, $catch);
283
  }
284

285 286 287 288 289 290 291 292 293 294 295 296 297
  /**
   * Returns module data on the filesystem.
   *
   * @param $module
   *   The name of the module.
   *
   * @return \stdClass|bool
   *   Returns a stdClass object if the module data is found containing at
   *   least an uri property with the module path, for example
   *   core/modules/user/user.module.
   */
  protected function moduleData($module) {
    if (!$this->moduleData) {
298
      // First, find profiles.
299 300 301 302 303
      $profiles_scanner = new SystemListing();
      $all_profiles = $profiles_scanner->scan('/^' . DRUPAL_PHP_FUNCTION_PATTERN . '\.profile$/', 'profiles');
      $profiles = array_keys(array_intersect_key($this->moduleList, $all_profiles));
      // If a module is within a profile directory but specifies another
      // profile for testing, it needs to be found in the parent profile.
304
      if (($parent_profile_config = $this->configStorage->read('simpletest.settings')) && isset($parent_profile_config['parent_profile']) && $parent_profile_config['parent_profile'] != $profiles[0]) {
305 306 307 308 309 310 311 312 313 314 315
        // In case both profile directories contain the same extension, the
        // actual profile always has precedence.
        array_unshift($profiles, $parent_profile_config['parent_profile']);
      }
      // Now find modules.
      $modules_scanner = new SystemListing($profiles);
      $this->moduleData = $all_profiles + $modules_scanner->scan('/^' . DRUPAL_PHP_FUNCTION_PATTERN . '\.module$/', 'modules');
    }
    return isset($this->moduleData[$module]) ? $this->moduleData[$module] : FALSE;
  }

316 317
  /**
   * Implements Drupal\Core\DrupalKernelInterface::updateModules().
318 319 320
   *
   * @todo Remove obsolete $module_list parameter. Only $module_filenames is
   *   needed.
321
   */
322
  public function updateModules(array $module_list, array $module_filenames = array()) {
323
    $this->newModuleList = $module_list;
324 325
    foreach ($module_filenames as $module => $filename) {
      $this->moduleData[$module] = (object) array('uri' => $filename);
326
    }
327 328
    // If we haven't yet booted, we don't need to do anything: the new module
    // list will take effect when boot() is called. If we have already booted,
329
    // then reboot in order to refresh the serviceProvider list and container.
330 331 332 333 334
    if ($this->booted) {
      $this->booted = FALSE;
      $this->boot();
    }
  }
335

336
  /**
337
   * Returns the classname based on environment and testing prefix.
338 339 340 341 342
   *
   * @return string
   *   The class name.
   */
  protected function getClassName() {
343
    $parts = array('service_container', $this->environment);
344 345 346 347 348 349 350 351 352 353
    // Make sure to use a testing-specific container even in the parent site.
    if (!empty($GLOBALS['drupal_test_info']['test_run_id'])) {
      $parts[] = $GLOBALS['drupal_test_info']['test_run_id'];
    }
    elseif ($prefix = drupal_valid_test_ua()) {
      $parts[] = $prefix;
    }
    return implode('_', $parts);
  }

354 355 356 357 358 359 360 361 362 363 364 365

  /**
   * Returns the kernel parameters.
   *
   * @return array An array of kernel parameters
   */
  protected function getKernelParameters() {
    return array(
      'kernel.environment' => $this->environment,
    );
  }

366 367 368
  /**
   * Initializes the service container.
   */
369
  protected function initializeContainer() {
370
    $this->containerNeedsDumping = FALSE;
371
    $persist = $this->getServicesToPersist();
372 373 374 375 376 377 378 379 380 381 382
    // The request service requires custom persisting logic, since it is also
    // potentially scoped. During Drupal installation, there is a request
    // service without a request scope.
    $request_scope = FALSE;
    if (isset($this->container)) {
      if ($this->container->isScopeActive('request')) {
        $request_scope = TRUE;
      }
      if ($this->container->initialized('request')) {
        $request = $this->container->get('request');
      }
383
    }
384
    $this->container = NULL;
385 386 387
    $class = $this->getClassName();
    $cache_file = $class . '.php';

388
    if ($this->allowDumping) {
389 390
      // First, try to load.
      if (!class_exists($class, FALSE)) {
391
        $this->storage()->load($cache_file);
392 393 394 395 396
      }
      // If the load succeeded or the class already existed, use it.
      if (class_exists($class, FALSE)) {
        $fully_qualified_class_name = '\\' . $class;
        $this->container = new $fully_qualified_class_name;
397
        $this->persistServices($persist);
398 399
      }
    }
400 401 402 403 404 405 406 407
    // First check whether the list of modules changed in this request.
    if (isset($this->newModuleList)) {
      if (isset($this->container) && isset($this->moduleList) && array_keys($this->moduleList) !== array_keys($this->newModuleList)) {
        unset($this->container);
      }
      $this->moduleList = $this->newModuleList;
      unset($this->newModuleList);
    }
408 409
    // Second, check if some other request -- for example on another web
    // frontend or during the installer -- changed the list of enabled modules.
410
    if (isset($this->container)) {
411 412
      // All namespaces must be registered before we attempt to use any service
      // from the container.
413
      $container_modules = $this->container->getParameter('container.modules');
414
      $namespaces_before = $this->classLoader->getPrefixes();
415
      $this->registerNamespaces($this->getModuleNamespaces($container_modules));
416 417 418 419

      // If 'container.modules' is wrong, the container must be rebuilt.
      if (!isset($this->moduleList)) {
        $this->moduleList = $this->container->get('config.factory')->get('system.module')->load()->get('enabled');
420
      }
421
      if (array_keys($this->moduleList) !== array_keys($container_modules)) {
422
        $persist = $this->getServicesToPersist();
423
        unset($this->container);
424 425 426 427
        // Revert the class loader to its prior state. However,
        // registerNamespaces() performs a merge rather than replace, so to
        // effectively remove erroneous registrations, we must replace them with
        // empty arrays.
428
        $namespaces_after = $this->classLoader->getPrefixes();
429
        $namespaces_before += array_fill_keys(array_diff(array_keys($namespaces_after), array_keys($namespaces_before)), array());
430
        $this->registerNamespaces($namespaces_before);
431 432 433
      }
    }

434 435
    if (!isset($this->container)) {
      $this->container = $this->buildContainer();
436
      $this->persistServices($persist);
437 438 439 440 441 442 443 444

      // The namespaces are marked as persistent, so objects like the annotated
      // class discovery still has the right object. We may have updated the
      // list of modules, so set it.
      if ($this->container->initialized('container.namespaces')) {
        $this->container->get('container.namespaces')->exchangeArray($this->container->getParameter('container.namespaces'));
      }

445 446
      if ($this->allowDumping) {
        $this->containerNeedsDumping = TRUE;
447 448 449
      }
    }

450
    $this->container->set('kernel', $this);
451

452 453
    // Set the class loader which was registered as a synthetic service.
    $this->container->set('class_loader', $this->classLoader);
454
    // If we have a request set it back to the new container.
455
    if ($request_scope) {
456
      $this->container->enterScope('request');
457 458
    }
    if (isset($request)) {
459 460
      $this->container->set('request', $request);
    }
461
    \Drupal::setContainer($this->container);
462
  }
463

464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492
  /**
   * Returns service instances to persist from an old container to a new one.
   */
  protected function getServicesToPersist() {
    $persist = array();
    if (isset($this->container)) {
      foreach ($this->container->getParameter('persistIds') as $id) {
        // It's pointless to persist services not yet initialized.
        if ($this->container->initialized($id)) {
          $persist[$id] = $this->container->get($id);
        }
      }
    }
    return $persist;
  }

  /**
   * Moves persistent service instances into a new container.
   */
  protected function persistServices(array $persist) {
    foreach ($persist as $id => $object) {
      // Do not override services already set() on the new container, for
      // example 'service_container'.
      if (!$this->container->initialized($id)) {
        $this->container->set($id, $object);
      }
    }
  }

493 494 495 496 497
  /**
   * Builds the service container.
   *
   * @return ContainerBuilder The compiled service container
   */
498
  protected function buildContainer() {
499
    $this->initializeServiceProviders();
500
    $container = $this->getContainerBuilder();
501 502
    $container->set('kernel', $this);
    $container->setParameter('container.service_providers', $this->serviceProviderClasses);
503
    $container->setParameter('container.modules', $this->getModuleFileNames());
504 505 506

    // Get a list of namespaces and put it onto the container.
    $namespaces = $this->getModuleNamespaces($this->getModuleFileNames());
507 508 509 510 511 512
    // Add all components in \Drupal\Core and \Drupal\Component that have a
    // Plugin directory.
    foreach (array('Core', 'Component') as $parent_directory) {
      $path = DRUPAL_ROOT . '/core/lib/Drupal/' . $parent_directory;
      foreach (new \DirectoryIterator($path) as $component) {
        if (!$component->isDot() && is_dir($component->getPathname() . '/Plugin')) {
513
          $namespaces['Drupal\\' . $parent_directory  .'\\' . $component->getFilename()] = DRUPAL_ROOT . '/core/lib';
514 515 516
        }
      }
    }
517 518
    $container->setParameter('container.namespaces', $namespaces);

519
    // Register synthetic services.
520
    $container->register('class_loader')->setSynthetic(TRUE);
521 522
    $container->register('kernel', 'Symfony\Component\HttpKernel\KernelInterface')->setSynthetic(TRUE);
    $container->register('service_container', 'Symfony\Component\DependencyInjection\ContainerInterface')->setSynthetic(TRUE);
523 524 525 526
    $yaml_loader = new YamlFileLoader($container);
    foreach ($this->serviceYamls as $filename) {
      $yaml_loader->load($filename);
    }
527
    foreach ($this->serviceProviders as $provider) {
528 529 530
      if ($provider instanceof ServiceProviderInterface) {
        $provider->register($container);
      }
531
    }
532 533 534 535 536 537 538 539 540 541 542 543 544

    // Identify all services whose instances should be persisted when rebuilding
    // the container during the lifetime of the kernel (e.g., during a kernel
    // reboot). Include synthetic services, because by definition, they cannot
    // be automatically reinstantiated. Also include services tagged to persist.
    $persist_ids = array();
    foreach ($container->getDefinitions() as $id => $definition) {
      if ($definition->isSynthetic() || $definition->getTag('persist')) {
        $persist_ids[] = $id;
      }
    }
    $container->setParameter('persistIds', $persist_ids);

545
    $container->compile();
546 547
    return $container;
  }
548

549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564
  /**
   * Registers all service providers to the kernel.
   *
   * @throws \LogicException
   */
  protected function initializeServiceProviders() {
    $this->serviceProviders = array();

    foreach ($this->discoverServiceProviders() as $name => $provider) {
      if (isset($this->serviceProviders[$name])) {
        throw new \LogicException(sprintf('Trying to register two service providers with the same name "%s"', $name));
      }
      $this->serviceProviders[$name] = $provider;
    }
  }

565 566 567 568 569
  /**
   * Gets a new ContainerBuilder instance used to build the service container.
   *
   * @return ContainerBuilder
   */
570
  protected function getContainerBuilder() {
571 572 573
    return new ContainerBuilder(new ParameterBag($this->getKernelParameters()));
  }

574 575 576 577 578 579 580 581 582 583 584 585 586 587 588
  /**
   * Dumps the service container to PHP code in the config directory.
   *
   * This method is based on the dumpContainer method in the parent class, but
   * that method is reliant on the Config component which we do not use here.
   *
   * @param ContainerBuilder $container
   *   The service container.
   * @param string $baseClass
   *   The name of the container's base class
   *
   * @return bool
   *   TRUE if the container was successfully dumped to disk.
   */
  protected function dumpDrupalContainer(ContainerBuilder $container, $baseClass) {
589
    if (!$this->storage()->writeable()) {
590 591 592 593
      return FALSE;
    }
    // Cache the container.
    $dumper = new PhpDumper($container);
594 595
    $class = $this->getClassName();
    $content = $dumper->dump(array('class' => $class, 'base_class' => $baseClass));
596
    return $this->storage()->save($class . '.php', $content);
597 598
  }

599 600 601 602 603 604 605 606 607 608

  /**
   * Gets a http kernel from the container
   *
   * @return HttpKernel
   */
  protected function getHttpKernel() {
    return $this->container->get('http_kernel');
  }

katbailey's avatar
katbailey committed
609
  /**
Crell's avatar
Crell committed
610 611
   * Overrides and eliminates this method from the parent class. Do not use.
   *
katbailey's avatar
katbailey committed
612 613 614 615 616 617 618
   * This method is part of the KernelInterface interface, but takes an object
   * implementing LoaderInterface as its only parameter. This is part of the
   * Config compoment from Symfony, which is not provided by Drupal core.
   *
   * Modules wishing to provide an extension to this class which uses this
   * method are responsible for ensuring the Config component exists.
   */
619
  public function registerContainerConfiguration(LoaderInterface $loader) {
620
  }
621

622 623 624 625 626 627 628 629 630 631 632 633
  /**
   * Gets the PHP code storage object to use for the compiled container.
   *
   * @return \Drupal\Component\PhpStorage\PhpStorageInterface
   */
  protected function storage() {
    if (!isset($this->storage)) {
      $this->storage = PhpStorageFactory::get('service_container');
    }
    return $this->storage;
  }

634 635 636 637 638 639 640 641 642 643 644 645 646 647
  /**
   * Returns the file name for each enabled module.
   */
  protected function getModuleFileNames() {
    $filenames = array();
    foreach ($this->moduleList as $module => $weight) {
      if ($data = $this->moduleData($module)) {
        $filenames[$module] = $data->uri;
      }
    }
    return $filenames;
  }

  /**
648
   * Gets the namespaces of each enabled module.
649
   */
650 651
  protected function getModuleNamespaces($moduleFileNames) {
    $namespaces = array();
652
    foreach ($moduleFileNames as $module => $filename) {
653 654 655 656 657 658 659 660 661
      $namespaces["Drupal\\$module"] = DRUPAL_ROOT . '/' . dirname($filename) . '/lib';
    }
    return $namespaces;
  }

  /**
   * Registers a list of namespaces.
   */
  protected function registerNamespaces(array $namespaces = array()) {
662 663 664
    foreach ($namespaces as $prefix => $path) {
      $this->classLoader->add($prefix, $path);
    }
665
  }
666
}