DrupalKernel.php 48.3 KB
Newer Older
1 2 3 4
<?php

/**
 * @file
5
 * Contains \Drupal\Core\DrupalKernel.
6 7 8 9
 */

namespace Drupal\Core;

10
use Drupal\Component\FileCache\FileCacheFactory;
11 12 13
use Drupal\Component\Utility\Crypt;
use Drupal\Component\Utility\Unicode;
use Drupal\Component\Utility\UrlHelper;
14
use Drupal\Core\Config\BootstrapConfigStorageFactory;
15
use Drupal\Core\Config\NullStorage;
16
use Drupal\Core\Database\Database;
17
use Drupal\Core\DependencyInjection\ContainerBuilder;
18
use Drupal\Core\DependencyInjection\ServiceModifierInterface;
19
use Drupal\Core\DependencyInjection\ServiceProviderInterface;
20
use Drupal\Core\DependencyInjection\YamlFileLoader;
21
use Drupal\Core\Extension\ExtensionDiscovery;
22
use Drupal\Core\File\MimeType\MimeTypeGuesser;
23
use Drupal\Core\Http\TrustedHostsRequestFactory;
24
use Drupal\Core\Language\Language;
25
use Drupal\Core\Site\Settings;
26
use Symfony\Cmf\Component\Routing\RouteObjectInterface;
27
use Symfony\Component\DependencyInjection\ContainerInterface;
28
use Symfony\Component\DependencyInjection\ParameterBag\ParameterBag;
29
use Symfony\Component\HttpFoundation\RedirectResponse;
30 31
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
32
use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
33
use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
34
use Symfony\Component\HttpKernel\TerminableInterface;
35
use Symfony\Component\Routing\Route;
36 37 38

/**
 * The DrupalKernel class is the core of Drupal itself.
39 40
 *
 * This class is responsible for building the Dependency Injection Container and
41 42 43 44 45 46 47 48
 * 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.
49
 */
50 51
class DrupalKernel implements DrupalKernelInterface, TerminableInterface {

52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
  /**
   * Holds the class used for dumping the container to a PHP array.
   *
   * In combination with swapping the container class this is useful to e.g.
   * dump to the human-readable PHP array format to debug the container
   * definition in an easier way.
   *
   * @var string
   */
  protected $phpArrayDumperClass = '\Drupal\Component\DependencyInjection\Dumper\OptimizedPhpArrayDumper';

  /**
   * Holds the default bootstrap container definition.
   *
   * @var array
   */
  protected $defaultBootstrapContainerDefinition = [
    'parameters' => [],
    'services' => [
      'database' => [
        'class' => 'Drupal\Core\Database\Connection',
        'factory' => 'Drupal\Core\Database\Database::getConnection',
        'arguments' => ['default'],
      ],
      'cache.container' => [
        'class' => 'Drupal\Core\Cache\DatabaseBackend',
        'arguments' => ['@database', '@cache_tags_provider.container', 'container'],
      ],
      'cache_tags_provider.container' => [
        'class' => 'Drupal\Core\Cache\DatabaseCacheTagsChecksum',
        'arguments' => ['@database'],
      ],
    ],
  ];

  /**
   * Holds the class used for instantiating the bootstrap container.
   *
   * @var string
   */
  protected $bootstrapContainerClass = '\Drupal\Component\DependencyInjection\PhpArrayContainer';

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

101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
  /**
   * 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
   */
120
  protected $booted = FALSE;
121

122 123 124 125 126 127 128
  /**
   * Whether essential services have been set up properly by preHandle().
   *
   * @var bool
   */
  protected $prepared = FALSE;

129 130 131 132
  /**
   * Holds the list of enabled modules.
   *
   * @var array
133 134
   *   An associative array whose keys are module names and whose values are
   *   ignored.
135 136 137
   */
  protected $moduleList;

138
  /**
139
   * List of available modules and installation profiles.
140
   *
141
   * @var \Drupal\Core\Extension\Extension[]
142
   */
143
  protected $moduleData = array();
144

145
  /**
146
   * The class loader object.
147
   *
148
   * @var \Composer\Autoload\ClassLoader
149 150 151
   */
  protected $classLoader;

152 153 154 155 156 157 158 159 160 161 162 163 164 165
  /**
   * Config storage object used for reading enabled modules configuration.
   *
   * @var \Drupal\Core\Config\StorageInterface
   */
  protected $configStorage;

  /**
   * Whether the container can be dumped.
   *
   * @var bool
   */
  protected $allowDumping;

166 167 168 169 170 171 172
  /**
   * Whether the container needs to be rebuilt the next time it is initialized.
   *
   * @var bool
   */
  protected $containerNeedsRebuild = FALSE;

173 174 175 176 177 178 179
  /**
   * Whether the container needs to be dumped once booting is complete.
   *
   * @var bool
   */
  protected $containerNeedsDumping;

180
  /**
181 182 183 184 185 186
   * List of discovered services.yml pathnames.
   *
   * This is a nested array whose top-level keys are 'app' and 'site', denoting
   * the origin of a service provider. Site-specific providers have to be
   * collected separately, because they need to be processed last, so as to be
   * able to override services from application service providers.
187 188 189 190 191
   *
   * @var array
   */
  protected $serviceYamls;

192
  /**
193
   * List of discovered service provider class names or objects.
194 195 196 197 198 199
   *
   * This is a nested array whose top-level keys are 'app' and 'site', denoting
   * the origin of a service provider. Site-specific providers have to be
   * collected separately, because they need to be processed last, so as to be
   * able to override services from application service providers.
   *
200 201 202
   * Allowing objects is for example used to allow
   * \Drupal\KernelTests\KernelTestBase to register itself as service provider.
   *
203 204 205 206 207 208 209 210
   * @var array
   */
  protected $serviceProviderClasses;

  /**
   * List of instantiated service provider classes.
   *
   * @see \Drupal\Core\DrupalKernel::$serviceProviderClasses
211 212 213 214 215
   *
   * @var array
   */
  protected $serviceProviders;

216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233
  /**
   * Whether the PHP environment has been initialized.
   *
   * This legacy phase can only be booted once because it sets session INI
   * settings. If a session has already been started, re-generating these
   * settings would break the session.
   *
   * @var bool
   */
  protected static $isEnvironmentInitialized = FALSE;

  /**
   * The site directory.
   *
   * @var string
   */
  protected $sitePath;

234 235 236 237 238 239 240
  /**
   * The app root.
   *
   * @var string
   */
  protected $root;

241 242 243 244
  /**
   * Create a DrupalKernel object from a request.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
245 246 247 248 249
   *   The request.
   * @param $class_loader
   *   The class loader. Normally Composer's ClassLoader, as included by the
   *   front controller, but may also be decorated; e.g.,
   *   \Symfony\Component\ClassLoader\ApcClassLoader.
250 251 252 253 254
   * @param string $environment
   *   String indicating the environment, e.g. 'prod' or 'dev'.
   * @param bool $allow_dumping
   *   (optional) FALSE to stop the container from being written to or read
   *   from disk. Defaults to TRUE.
255
   *
256
   * @return static
257 258 259
   *
   * @throws \Symfony\Component\HttpKernel\Exception\BadRequestHttpException
   *   In case the host name in the request is not trusted.
260
   */
261
  public static function createFromRequest(Request $request, $class_loader, $environment, $allow_dumping = TRUE) {
262 263
    $kernel = new static($environment, $class_loader, $allow_dumping);
    static::bootEnvironment();
264
    $kernel->initializeSettings($request);
265 266 267
    return $kernel;
  }

268 269 270 271
  /**
   * Constructs a DrupalKernel object.
   *
   * @param string $environment
272
   *   String indicating the environment, e.g. 'prod' or 'dev'.
273 274 275 276
   * @param $class_loader
   *   The class loader. Normally \Composer\Autoload\ClassLoader, as included by
   *   the front controller, but may also be decorated; e.g.,
   *   \Symfony\Component\ClassLoader\ApcClassLoader.
277 278 279
   * @param bool $allow_dumping
   *   (optional) FALSE to stop the container from being written to or read
   *   from disk. Defaults to TRUE.
280
   */
281
  public function __construct($environment, $class_loader, $allow_dumping = TRUE) {
282
    $this->environment = $environment;
283
    $this->classLoader = $class_loader;
284
    $this->allowDumping = $allow_dumping;
285
    $this->root = dirname(dirname(substr(__DIR__, 0, -strlen(__NAMESPACE__))));
286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311
  }

  /**
   * Returns the appropriate site directory for a request.
   *
   * Once the kernel has been created DrupalKernelInterface::getSitePath() is
   * preferred since it gets the statically cached result of this method.
   *
   * Site directories contain all site specific code. This includes settings.php
   * for bootstrap level configuration, file configuration stores, public file
   * storage and site specific modules and themes.
   *
   * Finds a matching site directory file by stripping the website's hostname
   * from left to right and pathname from right to left. By default, the
   * directory must contain a 'settings.php' file for it to match. If the
   * parameter $require_settings is set to FALSE, then a directory without a
   * 'settings.php' file will match as well. The first configuration file found
   * will be used and the remaining ones will be ignored. If no configuration
   * file is found, returns a default value 'sites/default'. See
   * default.settings.php for examples on how the URL is converted to a
   * directory.
   *
   * If a file named sites.php is present in the sites directory, it will be
   * loaded prior to scanning for directories. That file can define aliases in
   * an associative array named $sites. The array is written in the format
   * '<port>.<domain>.<path>' => 'directory'. As an example, to create a
312
   * directory alias for https://www.drupal.org:8080/mysite/test whose
313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330
   * configuration file is in sites/example.com, the array should be defined as:
   * @code
   * $sites = array(
   *   '8080.www.drupal.org.mysite.test' => 'example.com',
   * );
   * @endcode
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The current request.
   * @param bool $require_settings
   *   Only directories with an existing settings.php file will be recognized.
   *   Defaults to TRUE. During initial installation, this is set to FALSE so
   *   that Drupal can detect a matching directory, then create a new
   *   settings.php file in it.
   *
   * @return string
   *   The path of the matching directory.
   *
331 332 333
   * @throws \Symfony\Component\HttpKernel\Exception\BadRequestHttpException
   *   In case the host name in the request is invalid.
   *
334 335 336 337 338 339
   * @see \Drupal\Core\DrupalKernelInterface::getSitePath()
   * @see \Drupal\Core\DrupalKernelInterface::setSitePath()
   * @see default.settings.php
   * @see example.sites.php
   */
  public static function findSitePath(Request $request, $require_settings = TRUE) {
340 341 342 343
    if (static::validateHostname($request) === FALSE) {
      throw new BadRequestHttpException();
    }

344 345 346 347 348 349 350 351 352 353 354 355 356 357 358
    // Check for a simpletest override.
    if ($test_prefix = drupal_valid_test_ua()) {
      return 'sites/simpletest/' . substr($test_prefix, 10);
    }

    // Determine whether multi-site functionality is enabled.
    if (!file_exists(DRUPAL_ROOT . '/sites/sites.php')) {
      return 'sites/default';
    }

    // Otherwise, use find the site path using the request.
    $script_name = $request->server->get('SCRIPT_NAME');
    if (!$script_name) {
      $script_name = $request->server->get('SCRIPT_FILENAME');
    }
359
    $http_host = $request->getHttpHost();
360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383

    $sites = array();
    include DRUPAL_ROOT . '/sites/sites.php';

    $uri = explode('/', $script_name);
    $server = explode('.', implode('.', array_reverse(explode(':', rtrim($http_host, '.')))));
    for ($i = count($uri) - 1; $i > 0; $i--) {
      for ($j = count($server); $j > 0; $j--) {
        $dir = implode('.', array_slice($server, -$j)) . implode('.', array_slice($uri, 0, $i));
        if (isset($sites[$dir]) && file_exists(DRUPAL_ROOT . '/sites/' . $sites[$dir])) {
          $dir = $sites[$dir];
        }
        if (file_exists(DRUPAL_ROOT . '/sites/' . $dir . '/settings.php') || (!$require_settings && file_exists(DRUPAL_ROOT . '/sites/' . $dir))) {
          return "sites/$dir";
        }
      }
    }
    return 'sites/default';
  }

  /**
   * {@inheritdoc}
   */
  public function setSitePath($path) {
384 385 386
    if ($this->booted) {
      throw new \LogicException('Site path cannot be changed after calling boot()');
    }
387 388 389 390 391 392 393 394
    $this->sitePath = $path;
  }

  /**
   * {@inheritdoc}
   */
  public function getSitePath() {
    return $this->sitePath;
395 396
  }

397 398 399 400 401 402 403
  /**
   * {@inheritdoc}
   */
  public function getAppRoot() {
    return $this->root;
  }

404
  /**
405
   * {@inheritdoc}
406 407 408
   */
  public function boot() {
    if ($this->booted) {
409 410 411 412 413 414
      return $this;
    }

    // Ensure that findSitePath is set.
    if (!$this->sitePath) {
      throw new \Exception('Kernel does not have site path set before calling boot()');
415
    }
416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437

    // Initialize the FileCacheFactory component. We have to do it here instead
    // of in \Drupal\Component\FileCache\FileCacheFactory because we can not use
    // the Settings object in a component.
    $configuration = Settings::get('file_cache');

    // Provide a default configuration, if not set.
    if (!isset($configuration['default'])) {
      $configuration['default'] = [
        'class' => '\Drupal\Component\FileCache\FileCache',
        'cache_backend_class' => NULL,
        'cache_backend_configuration' => [],
      ];
      // @todo Use extension_loaded('apcu') for non-testbot
      //  https://www.drupal.org/node/2447753.
      if (function_exists('apc_fetch')) {
        $configuration['default']['cache_backend_class'] = '\Drupal\Component\FileCache\ApcuFileCacheBackend';
      }
    }
    FileCacheFactory::setConfiguration($configuration);
    FileCacheFactory::setPrefix(Settings::getApcuPrefix('file_cache', $this->root));

438 439
    $this->bootstrapContainer = new $this->bootstrapContainerClass(Settings::get('bootstrap_container_definition', $this->defaultBootstrapContainerDefinition));

440
    // Initialize the container.
441
    $this->initializeContainer();
442 443 444 445 446 447

    // Ensure mt_rand() is reseeded to prevent random values from one page load
    // being exploited to predict random values in subsequent page loads.
    $seed = unpack("L", Crypt::randomBytes(4));
    mt_srand($seed[1]);

448
    $this->booted = TRUE;
449 450

    return $this;
451 452
  }

453
  /**
454
   * {@inheritdoc}
455
   */
456 457 458 459
  public function shutdown() {
    if (FALSE === $this->booted) {
      return;
    }
460
    $this->container->get('stream_wrapper_manager')->unregister();
461
    $this->booted = FALSE;
462
    $this->container = NULL;
463 464
    $this->moduleList = NULL;
    $this->moduleData = array();
465 466 467 468 469 470 471 472 473
  }

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

474 475 476 477 478 479 480 481 482 483 484 485 486 487 488
  /**
   * {@inheritdoc}
   */
  public function setContainer(ContainerInterface $container = NULL) {
    if (isset($this->container)) {
      throw new \Exception('The container should not override an existing container.');
    }
    if ($this->booted) {
      throw new \Exception('The container cannot be set after a booted kernel.');
    }

    $this->container = $container;
    return $this;
  }

489 490 491 492 493 494 495 496 497 498 499 500 501
  /**
   * {@inheritdoc}
   */
  public function getCachedContainerDefinition() {
    $cache = $this->bootstrapContainer->get('cache.container')->get($this->getContainerCacheKey());

    if ($cache) {
      return $cache->data;
    }

    return NULL;
  }

502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520
  /**
   * {@inheritdoc}
   */
  public function loadLegacyIncludes() {
    require_once $this->root . '/core/includes/common.inc';
    require_once $this->root . '/core/includes/database.inc';
    require_once $this->root . '/core/includes/module.inc';
    require_once $this->root . '/core/includes/theme.inc';
    require_once $this->root . '/core/includes/pager.inc';
    require_once $this->root . '/core/includes/menu.inc';
    require_once $this->root . '/core/includes/tablesort.inc';
    require_once $this->root . '/core/includes/file.inc';
    require_once $this->root . '/core/includes/unicode.inc';
    require_once $this->root . '/core/includes/form.inc';
    require_once $this->root . '/core/includes/errors.inc';
    require_once $this->root . '/core/includes/schema.inc';
    require_once $this->root . '/core/includes/entity.inc';
  }

521
  /**
522
   * {@inheritdoc}
523
   */
524
  public function preHandle(Request $request) {
525 526 527

    $this->loadLegacyIncludes();

528 529 530
    // Load all enabled modules.
    $this->container->get('module_handler')->loadAll();

531 532 533
    // Register stream wrappers.
    $this->container->get('stream_wrapper_manager')->register();

534 535 536
    // Initialize legacy request globals.
    $this->initializeRequestGlobals($request);

537 538
    // Put the request on the stack.
    $this->container->get('request_stack')->push($request);
539

540 541
    // Set the allowed protocols.
    UrlHelper::setAllowedProtocols($this->container->getParameter('filter_protocols'));
542 543 544

    // Override of Symfony's mime type guesser singleton.
    MimeTypeGuesser::registerWithSymfonyGuesser($this->container);
545

546
    $this->prepared = TRUE;
547 548
  }

549 550 551 552
  /**
   * {@inheritdoc}
   */
  public function discoverServiceProviders() {
553
    $this->serviceYamls = array(
554 555
      'app' => array(),
      'site' => array(),
556
    );
557 558 559 560 561 562
    $this->serviceProviderClasses = array(
      'app' => array(),
      'site' => array(),
    );
    $this->serviceYamls['app']['core'] = 'core/core.services.yml';
    $this->serviceProviderClasses['app']['core'] = 'Drupal\Core\CoreServiceProvider';
563

564
    // Retrieve enabled modules and register their namespaces.
565
    if (!isset($this->moduleList)) {
566 567
      $extensions = $this->getConfigStorage()->read('core.extension');
      $this->moduleList = isset($extensions['module']) ? $extensions['module'] : array();
568
    }
569
    $module_filenames = $this->getModuleFileNames();
570
    $this->classLoaderAddMultiplePsr4($this->getModuleNamespacesPsr4($module_filenames));
571

572
    // Load each module's serviceProvider class.
573
    foreach ($module_filenames as $module => $filename) {
katbailey's avatar
katbailey committed
574
      $camelized = ContainerBuilder::camelize($module);
575 576
      $name = "{$camelized}ServiceProvider";
      $class = "Drupal\\{$module}\\{$name}";
577
      if (class_exists($class)) {
578
        $this->serviceProviderClasses['app'][$module] = $class;
579
      }
580
      $filename = dirname($filename) . "/$module.services.yml";
581
      if (file_exists($filename)) {
582
        $this->serviceYamls['app'][$module] = $filename;
583
      }
584
    }
585

586
    // Add site-specific service providers.
587
    if (!empty($GLOBALS['conf']['container_service_providers'])) {
588
      foreach ($GLOBALS['conf']['container_service_providers'] as $class) {
589
        if ((is_string($class) && class_exists($class)) || (is_object($class) && ($class instanceof ServiceProviderInterface || $class instanceof ServiceModifierInterface))) {
590 591
          $this->serviceProviderClasses['site'][] = $class;
        }
592 593
      }
    }
594
    $this->addServiceFiles(Settings::get('container_yamls', []));
595 596 597 598 599
  }

  /**
   * {@inheritdoc}
   */
600 601
  public function getServiceProviders($origin) {
    return $this->serviceProviders[$origin];
602 603 604 605 606 607
  }

  /**
   * {@inheritdoc}
   */
  public function terminate(Request $request, Response $response) {
608 609 610
    // Only run terminate() when essential services have been set up properly
    // by preHandle() before.
    if (FALSE === $this->prepared) {
611 612 613 614 615 616 617 618 619 620 621
      return;
    }

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

  /**
   * {@inheritdoc}
   */
622
  public function handle(Request $request, $type = self::MASTER_REQUEST, $catch = TRUE) {
623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666
    // Ensure sane PHP environment variables.
    static::bootEnvironment();

    try {
      $this->initializeSettings($request);

      // Redirect the user to the installation script if Drupal has not been
      // installed yet (i.e., if no $databases array has been defined in the
      // settings.php file) and we are not already installing.
      if (!Database::getConnectionInfo() && !drupal_installation_attempted() && PHP_SAPI !== 'cli') {
        $response = new RedirectResponse($request->getBasePath() . '/core/install.php');
      }
      else {
        $this->boot();
        $response = $this->getHttpKernel()->handle($request, $type, $catch);
      }
    }
    catch (\Exception $e) {
      if ($catch === FALSE) {
        throw $e;
      }

      $response = $this->handleException($e, $request, $type);
    }

    // Adapt response headers to the current request.
    $response->prepare($request);

    return $response;
  }

  /**
   * Converts an exception into a response.
   *
   * @param \Exception $e
   *   An exception
   * @param Request $request
   *   A Request instance
   * @param int $type
   *   The type of the request (one of HttpKernelInterface::MASTER_REQUEST or
   *   HttpKernelInterface::SUB_REQUEST)
   *
   * @return Response
   *   A Response instance
667 668 669
   *
   * @throws \Exception
   *   If the passed in exception cannot be turned into a response.
670 671 672 673 674 675 676 677
   */
  protected function handleException(\Exception $e, $request, $type) {
    if ($e instanceof HttpExceptionInterface) {
      $response = new Response($e->getMessage(), $e->getStatusCode());
      $response->headers->add($e->getHeaders());
      return $response;
    }
    else {
678
      throw $e;
679
    }
680 681
  }

682 683 684 685 686 687
  /**
   * {@inheritdoc}
   */
  public function prepareLegacyRequest(Request $request) {
    $this->boot();
    $this->preHandle($request);
688 689 690 691 692
    // Setup services which are normally initialized from within stack
    // middleware or during the request kernel event.
    if (PHP_SAPI !== 'cli') {
      $request->setSession($this->container->get('session'));
    }
693 694
    $request->attributes->set(RouteObjectInterface::ROUTE_OBJECT, new Route('<none>'));
    $request->attributes->set(RouteObjectInterface::ROUTE_NAME, '<none>');
695 696 697 698 699
    $this->container->get('request_stack')->push($request);
    $this->container->get('router.request_context')->fromRequest($request);
    return $this;
  }

700 701 702 703 704 705
  /**
   * Returns module data on the filesystem.
   *
   * @param $module
   *   The name of the module.
   *
706 707
   * @return \Drupal\Core\Extension\Extension|bool
   *   Returns an Extension object if the module is found, FALSE otherwise.
708 709 710
   */
  protected function moduleData($module) {
    if (!$this->moduleData) {
711
      // First, find profiles.
712
      $listing = new ExtensionDiscovery($this->root);
713 714 715 716
      $listing->setProfileDirectories(array());
      $all_profiles = $listing->scan('profile');
      $profiles = array_intersect_key($all_profiles, $this->moduleList);

717 718
      // If a module is within a profile directory but specifies another
      // profile for testing, it needs to be found in the parent profile.
719
      $settings = $this->getConfigStorage()->read('simpletest.settings');
720 721
      $parent_profile = !empty($settings['parent_profile']) ? $settings['parent_profile'] : NULL;
      if ($parent_profile && !isset($profiles[$parent_profile])) {
722 723
        // In case both profile directories contain the same extension, the
        // actual profile always has precedence.
724
        $profiles = array($parent_profile => $all_profiles[$parent_profile]) + $profiles;
725
      }
726 727 728 729 730 731

      $profile_directories = array_map(function ($profile) {
        return $profile->getPath();
      }, $profiles);
      $listing->setProfileDirectories($profile_directories);

732
      // Now find modules.
733
      $this->moduleData = $profiles + $listing->scan('module');
734 735 736 737
    }
    return isset($this->moduleData[$module]) ? $this->moduleData[$module] : FALSE;
  }

738 739
  /**
   * Implements Drupal\Core\DrupalKernelInterface::updateModules().
740 741 742
   *
   * @todo Remove obsolete $module_list parameter. Only $module_filenames is
   *   needed.
743
   */
744
  public function updateModules(array $module_list, array $module_filenames = array()) {
745
    $this->moduleList = $module_list;
746 747
    foreach ($module_filenames as $name => $extension) {
      $this->moduleData[$name] = $extension;
748
    }
749

750
    // If we haven't yet booted, we don't need to do anything: the new module
751 752 753 754 755
    // list will take effect when boot() is called. However we set a
    // flag that the container needs a rebuild, so that a potentially cached
    // container is not used. If we have already booted, then rebuild the
    // container in order to refresh the serviceProvider list and container.
    $this->containerNeedsRebuild = TRUE;
756
    if ($this->booted) {
757
      $this->initializeContainer();
758 759
    }
  }
760

761
  /**
762
   * Returns the container cache key based on the environment.
763 764
   *
   * @return string
765
   *   The cache key used for the service container.
766
   */
767 768 769
  protected function getContainerCacheKey() {
    $parts = array('service_container', $this->environment, \Drupal::VERSION, Settings::get('deployment_identifier'));
    return implode(':', $parts);
770
  }
771 772 773 774 775 776 777 778 779 780 781 782

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

783 784
  /**
   * Initializes the service container.
785 786
   *
   * @return \Symfony\Component\DependencyInjection\ContainerInterface
787
   */
788
  protected function initializeContainer() {
789
    $this->containerNeedsDumping = FALSE;
790
    $session_started = FALSE;
791
    if (isset($this->container)) {
792 793 794 795 796
      // Save the id of the currently logged in user.
      if ($this->container->initialized('current_user')) {
        $current_user_id = $this->container->get('current_user')->id();
      }

797 798 799 800 801 802
      // If there is a session, close and save it.
      if ($this->container->initialized('session')) {
        $session = $this->container->get('session');
        if ($session->isStarted()) {
          $session_started = TRUE;
          $session->save();
803
        }
804
        unset($session);
805
      }
806
    }
807

808 809 810 811
    // If we haven't booted yet but there is a container, then we're asked to
    // boot the container injected via setContainer().
    // @see \Drupal\KernelTests\KernelTestBase::setUp()
    if (isset($this->container) && !$this->booted) {
812
      $container = $this->container;
813 814
    }

815
    // If the module list hasn't already been set in updateModules and we are
816
    // not forcing a rebuild, then try and load the container from the cache.
817
    if (empty($this->moduleList) && !$this->containerNeedsRebuild) {
818
      $container_definition = $this->getCachedContainerDefinition();
819
    }
820

821 822 823
    // If there is no container and no cached container definition, build a new
    // one from scratch.
    if (!isset($container) && !isset($container_definition)) {
824
      $container = $this->compileContainer();
825 826 827 828 829 830 831 832

      // Only dump the container if dumping is allowed. This is useful for
      // KernelTestBase, which never wants to use the real container, but always
      // the container builder.
      if ($this->allowDumping) {
        $dumper = new $this->phpArrayDumperClass($container);
        $container_definition = $dumper->getArray();
      }
833 834
    }

835 836 837
    // The container was rebuilt successfully.
    $this->containerNeedsRebuild = FALSE;

838 839 840 841 842 843
    // Only create a new class if we have a container definition.
    if (isset($container_definition)) {
      $class = Settings::get('container_base_class', '\Drupal\Core\DependencyInjection\Container');
      $container = new $class($container_definition);
    }

844
    $this->attachSynthetic($container);
845 846

    $this->container = $container;
847 848
    if ($session_started) {
      $this->container->get('session')->start();
849
    }
850 851 852 853 854 855 856 857 858 859

    // The request stack is preserved across container rebuilds. Reinject the
    // new session into the master request if one was present before.
    if (($request_stack = $this->container->get('request_stack', ContainerInterface::NULL_ON_INVALID_REFERENCE))) {
      if ($request = $request_stack->getMasterRequest()) {
        if ($request->hasSession()) {
          $request->setSession($this->container->get('session'));
        }
      }
    }
860 861 862 863 864

    if (!empty($current_user_id)) {
      $this->container->get('current_user')->setInitialAccountId($current_user_id);
    }

865
    \Drupal::setContainer($this->container);
866 867

    // If needs dumping flag was set, dump the container.
868 869
    if ($this->containerNeedsDumping && !$this->cacheDrupalContainer($container_definition)) {
      $this->container->get('logger.factory')->get('DrupalKernel')->notice('Container cannot be saved to cache.');
870 871
    }

872 873 874 875 876 877 878 879 880 881 882 883 884 885
    return $this->container;
  }

  /**
   * Setup a consistent PHP environment.
   *
   * This method sets PHP environment options we want to be sure are set
   * correctly for security or just saneness.
   */
  public static function bootEnvironment() {
    if (static::$isEnvironmentInitialized) {
      return;
    }

886 887 888 889
    // Include our bootstrap file.
    $core_root = dirname(dirname(dirname(__DIR__)));
    require_once $core_root . '/includes/bootstrap.inc';

890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923
    // Enforce E_STRICT, but allow users to set levels not part of E_STRICT.
    error_reporting(E_STRICT | E_ALL);

    // Override PHP settings required for Drupal to work properly.
    // sites/default/default.settings.php contains more runtime settings.
    // The .htaccess file contains settings that cannot be changed at runtime.

    // Use session cookies, not transparent sessions that puts the session id in
    // the query string.
    ini_set('session.use_cookies', '1');
    ini_set('session.use_only_cookies', '1');
    ini_set('session.use_trans_sid', '0');
    // Don't send HTTP headers using PHP's session handler.
    // Send an empty string to disable the cache limiter.
    ini_set('session.cache_limiter', '');
    // Use httponly session cookies.
    ini_set('session.cookie_httponly', '1');

    // Set sane locale settings, to ensure consistent string, dates, times and
    // numbers handling.
    setlocale(LC_ALL, 'C');

    // Detect string handling method.
    Unicode::check();

    // Indicate that code is operating in a test child site.
    if (!defined('DRUPAL_TEST_IN_CHILD_SITE')) {
      if ($test_prefix = drupal_valid_test_ua()) {
        // Only code that interfaces directly with tests should rely on this
        // constant; e.g., the error/exception handler conditionally adds further
        // error information into HTTP response headers that are consumed by
        // Simpletest's internal browser.
        define('DRUPAL_TEST_IN_CHILD_SITE', TRUE);

924 925 926 927 928 929
        // Web tests are to be conducted with runtime assertions active.
        assert_options(ASSERT_ACTIVE, TRUE);
        // Now synchronize PHP 5 and 7's handling of assertions as much as
        // possible.
        \Drupal\Component\Assertion\Handle::register();

930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946
        // Log fatal errors to the test site directory.
        ini_set('log_errors', 1);
        ini_set('error_log', DRUPAL_ROOT . '/sites/simpletest/' . substr($test_prefix, 10) . '/error.log');
      }
      else {
        // Ensure that no other code defines this.
        define('DRUPAL_TEST_IN_CHILD_SITE', FALSE);
      }
    }

    // Set the Drupal custom error handler.
    set_error_handler('_drupal_error_handler');
    set_exception_handler('_drupal_exception_handler');

    static::$isEnvironmentInitialized = TRUE;
  }

947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983
  /**
   * Locate site path and initialize settings singleton.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The current request.
   *
   * @throws \Symfony\Component\HttpKernel\Exception\BadRequestHttpException
   *   In case the host name in the request is not trusted.
   */
  protected function initializeSettings(Request $request) {
    $site_path = static::findSitePath($request);
    $this->setSitePath($site_path);
    $class_loader_class = get_class($this->classLoader);
    Settings::initialize($this->root, $site_path, $this->classLoader);

    // Initialize our list of trusted HTTP Host headers to protect against
    // header attacks.
    $host_patterns = Settings::get('trusted_host_patterns', array());
    if (PHP_SAPI !== 'cli' && !empty($host_patterns)) {
      if (static::setupTrustedHosts($request, $host_patterns) === FALSE) {
        throw new BadRequestHttpException('The provided host name is not valid for this server.');
      }
    }

    // If the class loader is still the same, possibly upgrade to the APC class
    // loader.
    if ($class_loader_class == get_class($this->classLoader)
        && Settings::get('class_loader_auto_detect', TRUE)
        && function_exists('apc_fetch')) {
      $prefix = Settings::getApcuPrefix('class_loader', $this->root);
      $apc_loader = new \Symfony\Component\ClassLoader\ApcClassLoader($prefix, $this->classLoader);
      $this->classLoader->unregister();
      $apc_loader->register();
      $this->classLoader = $apc_loader;
    }
  }

984 985 986 987 988 989 990 991 992 993 994
  /**
   * Bootstraps the legacy global request variables.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The current request.
   *
   * @todo D8: Eliminate this entirely in favor of Request object.
   */
  protected function initializeRequestGlobals(Request $request) {
    global $base_url;
    // Set and derived from $base_url by this function.
995
    global $base_path, $base_root;
996 997
    global $base_secure_url, $base_insecure_url;

998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009
    // Create base URL.
    $base_root = $request->getSchemeAndHttpHost();
    $base_url = $base_root;

    // For a request URI of '/index.php/foo', $_SERVER['SCRIPT_NAME'] is
    // '/index.php', whereas $_SERVER['PHP_SELF'] is '/index.php/foo'.
    if ($dir = rtrim(dirname($request->server->get('SCRIPT_NAME')), '\/')) {
      // Remove "core" directory if present, allowing install.php,
      // authorize.php, and others to auto-detect a base path.
      $core_position = strrpos($dir, '/core');
      if ($core_position !== FALSE && strlen($dir) - 5 == $core_position) {
        $base_path = substr($dir, 0, $core_position);
1010 1011
      }
      else {
1012
        $base_path = $dir;
1013
      }
1014 1015 1016 1017 1018
      $base_url .= $base_path;
      $base_path .= '/';
    }
    else {
      $base_path = '/';
1019 1020 1021 1022
    }
    $base_secure_url = str_replace('http://', 'https://', $base_url);
    $base_insecure_url = str_replace('https://', 'http://', $base_url);
  }
1023

1024 1025 1026
  /**
   * Returns service instances to persist from an old container to a new one.
   */
1027
  protected function getServicesToPersist(ContainerInterface $container) {
1028
    $persist = array();
1029
    foreach ($container->getParameter('persist_ids') as $id) {
1030 1031 1032
      // It's pointless to persist services not yet initialized.
      if ($container->initialized($id)) {
        $persist[$id] = $container->get($id);
1033 1034 1035 1036 1037 1038 1039 1040
      }
    }
    return $persist;
  }

  /**
   * Moves persistent service instances into a new container.
   */
1041
  protected function persistServices(ContainerInterface $container, array $persist) {
1042 1043 1044
    foreach ($persist as $id => $object) {
      // Do not override services already set() on the new container, for
      // example 'service_container'.
1045 1046
      if (!$container->initialized($id)) {
        $container->set($id, $object);
1047 1048 1049 1050
      }
    }
  }

1051
  /**
1052
   * {@inheritdoc}
1053 1054 1055 1056 1057
   */
  public function rebuildContainer() {
    // Empty module properties and for them to be reloaded from scratch.
    $this->moduleList = NULL;
    $this->moduleData = array();
1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075
    $this->containerNeedsRebuild = TRUE;
    return $this->initializeContainer();
  }

  /**
   * {@inheritdoc}
   */
  public function invalidateContainer() {
    // An invalidated container needs a rebuild.
    $this->containerNeedsRebuild = TRUE;

    // If we have not yet booted, settings or bootstrap services might not yet
    // be available. In that case the container will not be loaded from cache
    // due to the above setting when the Kernel is booted.
    if (!$this->booted) {
      return;
    }

1076 1077
    // Also remove the container definition from the cache backend.
    $this->bootstrapContainer->get('cache.container')->deleteAll();
1078 1079 1080 1081 1082 1083 1084
  }

  /**
   * Attach synthetic values on to kernel.
   *
   * @param ContainerInterface $container
   *   Container object
1085
   *
1086 1087
   * @return ContainerInterface
   */
1088
  protected function attachSynthetic(ContainerInterface $container) {
1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107
    $persist = array();
    if (isset($this->container)) {
      $persist = $this->getServicesToPersist($this->container);
    }
    $this->persistServices($container, $persist);

    // All namespaces must be registered before we attempt to use any service
    // from the container.
    $this->classLoaderAddMultiplePsr4($container->getParameter('container.namespaces'));

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

    // Set the class loader which was registered as a synthetic service.
    $container->set('class_loader', $this->classLoader);
    return $container;
  }

  /**
   * Compiles a new service container.
1108 1109 1110
   *
   * @return ContainerBuilder The compiled service container
   */
1111 1112 1113 1114 1115 1116 1117 1118
  protected function compileContainer() {
    // We are forcing a container build so it is reasonable to assume that the
    // calling method knows something about the system has changed requiring the
    // container to be dumped to the filesystem.
    if ($this->allowDumping) {
      $this->containerNeedsDumping = TRUE;
    }

1119
    $this->initializeServiceProviders();
1120
    $container = $this->getContainerBuilder();
1121
    $container->set('kernel', $this);
1122
    $container->setParameter('container.modules', $this->getModulesParameter());
1123 1124

    // Get a list of namespaces and put it onto the container.
1125
    $namespaces = $this->getModuleNamespacesPsr4($this->getModuleFileNames());
1126 1127 1128 1129 1130
    // Add all components in \Drupal\Core and \Drupal\Component that have one of
    // the following directories:
    // - Element
    // - Entity
    // - Plugin
1131
    foreach (array('Core', 'Component') as $parent_directory) {
1132
      $path = 'core/lib/Drupal/' . $parent_directory;