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

namespace Drupal\Core;

5
use Composer\Autoload\ClassLoader;
6
use Drupal\Component\Assertion\Handle;
7
use Drupal\Component\FileCache\FileCacheFactory;
8
use Drupal\Component\Utility\UrlHelper;
9
use Drupal\Core\Cache\DatabaseBackend;
10
use Drupal\Core\Config\BootstrapConfigStorageFactory;
11
use Drupal\Core\Config\NullStorage;
12
use Drupal\Core\Database\Database;
13
use Drupal\Core\DependencyInjection\ContainerBuilder;
14
use Drupal\Core\DependencyInjection\ServiceModifierInterface;
15
use Drupal\Core\DependencyInjection\ServiceProviderInterface;
16
use Drupal\Core\DependencyInjection\YamlFileLoader;
17
use Drupal\Core\Extension\ExtensionDiscovery;
18
use Drupal\Core\File\MimeType\MimeTypeGuesser;
19
use Drupal\Core\Http\TrustedHostsRequestFactory;
20
use Drupal\Core\Installer\InstallerRedirectTrait;
21
use Drupal\Core\Language\Language;
22
use Drupal\Core\Security\RequestSanitizer;
23
use Drupal\Core\Site\Settings;
24
use Drupal\Core\Test\TestDatabase;
25
use Symfony\Cmf\Component\Routing\RouteObjectInterface;
26
use Symfony\Component\ClassLoader\ApcClassLoader;
27 28
use Symfony\Component\ClassLoader\WinCacheClassLoader;
use Symfony\Component\ClassLoader\XcacheClassLoader;
29
use Symfony\Component\DependencyInjection\ContainerInterface;
30
use Symfony\Component\DependencyInjection\ParameterBag\ParameterBag;
31
use Symfony\Component\HttpFoundation\RedirectResponse;
32 33
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
34
use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
35
use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
36
use Symfony\Component\HttpKernel\TerminableInterface;
37
use Symfony\Component\Routing\Route;
38 39 40

/**
 * The DrupalKernel class is the core of Drupal itself.
41 42
 *
 * This class is responsible for building the Dependency Injection Container and
43 44 45 46 47 48 49 50
 * 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.
51
 */
52
class DrupalKernel implements DrupalKernelInterface, TerminableInterface {
53
  use InstallerRedirectTrait;
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
  /**
   * 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',
81
        'arguments' => ['@database', '@cache_tags_provider.container', 'container', DatabaseBackend::MAXIMUM_NONE],
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
      ],
      '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;

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

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

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

141
  /**
142
   * List of available modules and installation profiles.
143
   *
144
   * @var \Drupal\Core\Extension\Extension[]
145
   */
146
  protected $moduleData = [];
147

148
  /**
149
   * The class loader object.
150
   *
151
   * @var \Composer\Autoload\ClassLoader
152 153 154
   */
  protected $classLoader;

155 156 157 158 159 160 161 162 163 164 165 166 167 168
  /**
   * 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;

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

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

183
  /**
184 185 186 187 188 189
   * 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.
190 191 192 193 194
   *
   * @var array
   */
  protected $serviceYamls;

195
  /**
196
   * List of discovered service provider class names or objects.
197 198 199 200 201 202
   *
   * 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.
   *
203 204 205
   * Allowing objects is for example used to allow
   * \Drupal\KernelTests\KernelTestBase to register itself as service provider.
   *
206 207 208 209 210 211 212 213
   * @var array
   */
  protected $serviceProviderClasses;

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

219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236
  /**
   * 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;

237 238 239 240 241 242 243
  /**
   * The app root.
   *
   * @var string
   */
  protected $root;

244 245 246 247
  /**
   * Create a DrupalKernel object from a request.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
248 249 250 251 252
   *   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.
253 254 255 256 257
   * @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.
258 259 260
   * @param string $app_root
   *   (optional) The path to the application root as a string. If not supplied,
   *   the application root will be computed.
261
   *
262
   * @return static
263 264 265
   *
   * @throws \Symfony\Component\HttpKernel\Exception\BadRequestHttpException
   *   In case the host name in the request is not trusted.
266
   */
267 268 269
  public static function createFromRequest(Request $request, $class_loader, $environment, $allow_dumping = TRUE, $app_root = NULL) {
    $kernel = new static($environment, $class_loader, $allow_dumping, $app_root);
    static::bootEnvironment($app_root);
270
    $kernel->initializeSettings($request);
271 272 273
    return $kernel;
  }

274 275 276 277
  /**
   * Constructs a DrupalKernel object.
   *
   * @param string $environment
278
   *   String indicating the environment, e.g. 'prod' or 'dev'.
279 280 281 282
   * @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.
283 284 285
   * @param bool $allow_dumping
   *   (optional) FALSE to stop the container from being written to or read
   *   from disk. Defaults to TRUE.
286 287 288
   * @param string $app_root
   *   (optional) The path to the application root as a string. If not supplied,
   *   the application root will be computed.
289
   */
290
  public function __construct($environment, $class_loader, $allow_dumping = TRUE, $app_root = NULL) {
291
    $this->environment = $environment;
292
    $this->classLoader = $class_loader;
293
    $this->allowDumping = $allow_dumping;
294 295 296 297 298 299 300 301 302 303 304 305 306 307
    if ($app_root === NULL) {
      $app_root = static::guessApplicationRoot();
    }
    $this->root = $app_root;
  }

  /**
   * Determine the application root directory based on assumptions.
   *
   * @return string
   *   The application root.
   */
  protected static function guessApplicationRoot() {
    return dirname(dirname(substr(__DIR__, 0, -strlen(__NAMESPACE__))));
308 309 310 311 312 313 314 315 316 317 318 319
  }

  /**
   * 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.
   *
320 321 322
   * A file named sites.php must be present in the sites directory for
   * multisite. If it doesn't exist, then 'sites/default' will be used.
   *
323 324 325 326 327 328 329 330 331 332
   * 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.
   *
333 334
   * The sites.php file in the sites directory can define aliases in an
   * associative array named $sites. The array is written in the format
335
   * '<port>.<domain>.<path>' => 'directory'. As an example, to create a
336
   * directory alias for https://www.drupal.org:8080/mysite/test whose
337 338 339 340 341 342 343 344 345 346 347 348 349 350
   * 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.
351 352 353
   * @param string $app_root
   *   (optional) The path to the application root as a string. If not supplied,
   *   the application root will be computed.
354 355 356 357
   *
   * @return string
   *   The path of the matching directory.
   *
358 359 360
   * @throws \Symfony\Component\HttpKernel\Exception\BadRequestHttpException
   *   In case the host name in the request is invalid.
   *
361 362 363 364 365
   * @see \Drupal\Core\DrupalKernelInterface::getSitePath()
   * @see \Drupal\Core\DrupalKernelInterface::setSitePath()
   * @see default.settings.php
   * @see example.sites.php
   */
366
  public static function findSitePath(Request $request, $require_settings = TRUE, $app_root = NULL) {
367 368 369 370
    if (static::validateHostname($request) === FALSE) {
      throw new BadRequestHttpException();
    }

371 372 373 374
    if ($app_root === NULL) {
      $app_root = static::guessApplicationRoot();
    }

375 376
    // Check for a simpletest override.
    if ($test_prefix = drupal_valid_test_ua()) {
377 378
      $test_db = new TestDatabase($test_prefix);
      return $test_db->getTestSitePath();
379 380 381
    }

    // Determine whether multi-site functionality is enabled.
382
    if (!file_exists($app_root . '/sites/sites.php')) {
383 384 385 386 387 388 389 390
      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');
    }
391
    $http_host = $request->getHttpHost();
392

393
    $sites = [];
394
    include $app_root . '/sites/sites.php';
395 396 397 398 399 400

    $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));
401
        if (isset($sites[$dir]) && file_exists($app_root . '/sites/' . $sites[$dir])) {
402 403
          $dir = $sites[$dir];
        }
404
        if (file_exists($app_root . '/sites/' . $dir . '/settings.php') || (!$require_settings && file_exists($app_root . '/sites/' . $dir))) {
405 406 407 408 409 410 411 412 413 414 415
          return "sites/$dir";
        }
      }
    }
    return 'sites/default';
  }

  /**
   * {@inheritdoc}
   */
  public function setSitePath($path) {
416
    if ($this->booted && $path !== $this->sitePath) {
417 418
      throw new \LogicException('Site path cannot be changed after calling boot()');
    }
419 420 421 422 423 424 425 426
    $this->sitePath = $path;
  }

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

429 430 431 432 433 434 435
  /**
   * {@inheritdoc}
   */
  public function getAppRoot() {
    return $this->root;
  }

436
  /**
437
   * {@inheritdoc}
438 439 440
   */
  public function boot() {
    if ($this->booted) {
441 442 443 444 445 446
      return $this;
    }

    // Ensure that findSitePath is set.
    if (!$this->sitePath) {
      throw new \Exception('Kernel does not have site path set before calling boot()');
447
    }
448 449 450 451 452 453 454 455 456 457

    // 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'])) {
      // @todo Use extension_loaded('apcu') for non-testbot
      //  https://www.drupal.org/node/2447753.
458
      if (function_exists('apcu_fetch')) {
459 460 461 462 463 464
        $configuration['default']['cache_backend_class'] = '\Drupal\Component\FileCache\ApcuFileCacheBackend';
      }
    }
    FileCacheFactory::setConfiguration($configuration);
    FileCacheFactory::setPrefix(Settings::getApcuPrefix('file_cache', $this->root));

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

467
    // Initialize the container.
468
    $this->initializeContainer();
469

470
    $this->booted = TRUE;
471 472

    return $this;
473 474
  }

475
  /**
476
   * {@inheritdoc}
477
   */
478 479 480 481
  public function shutdown() {
    if (FALSE === $this->booted) {
      return;
    }
482
    $this->container->get('stream_wrapper_manager')->unregister();
483
    $this->booted = FALSE;
484
    $this->container = NULL;
485
    $this->moduleList = NULL;
486
    $this->moduleData = [];
487 488 489 490 491 492 493 494 495
  }

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

496 497 498 499 500 501 502 503 504 505 506 507 508 509 510
  /**
   * {@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;
  }

511 512 513 514 515 516 517 518 519 520 521 522 523
  /**
   * {@inheritdoc}
   */
  public function getCachedContainerDefinition() {
    $cache = $this->bootstrapContainer->get('cache.container')->get($this->getContainerCacheKey());

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

    return NULL;
  }

524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542
  /**
   * {@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';
  }

543
  /**
544
   * {@inheritdoc}
545
   */
546
  public function preHandle(Request $request) {
547 548 549 550 551 552
    // Sanitize the request.
    $request = RequestSanitizer::sanitize(
      $request,
      (array) Settings::get(RequestSanitizer::SANITIZE_WHITELIST, []),
      (bool) Settings::get(RequestSanitizer::SANITIZE_LOG, FALSE)
    );
553 554 555

    $this->loadLegacyIncludes();

556 557 558
    // Load all enabled modules.
    $this->container->get('module_handler')->loadAll();

559 560 561
    // Register stream wrappers.
    $this->container->get('stream_wrapper_manager')->register();

562 563 564
    // Initialize legacy request globals.
    $this->initializeRequestGlobals($request);

565 566
    // Put the request on the stack.
    $this->container->get('request_stack')->push($request);
567

568 569
    // Set the allowed protocols.
    UrlHelper::setAllowedProtocols($this->container->getParameter('filter_protocols'));
570

571
    // Override of Symfony's MIME type guesser singleton.
572
    MimeTypeGuesser::registerWithSymfonyGuesser($this->container);
573

574
    $this->prepared = TRUE;
575 576
  }

577 578 579 580
  /**
   * {@inheritdoc}
   */
  public function discoverServiceProviders() {
581 582 583 584 585 586 587 588
    $this->serviceYamls = [
      'app' => [],
      'site' => [],
    ];
    $this->serviceProviderClasses = [
      'app' => [],
      'site' => [],
    ];
589 590
    $this->serviceYamls['app']['core'] = 'core/core.services.yml';
    $this->serviceProviderClasses['app']['core'] = 'Drupal\Core\CoreServiceProvider';
591

592
    // Retrieve enabled modules and register their namespaces.
593
    if (!isset($this->moduleList)) {
594
      $extensions = $this->getConfigStorage()->read('core.extension');
595
      $this->moduleList = isset($extensions['module']) ? $extensions['module'] : [];
596
    }
597
    $module_filenames = $this->getModuleFileNames();
598
    $this->classLoaderAddMultiplePsr4($this->getModuleNamespacesPsr4($module_filenames));
599

600
    // Load each module's serviceProvider class.
601
    foreach ($module_filenames as $module => $filename) {
katbailey's avatar
katbailey committed
602
      $camelized = ContainerBuilder::camelize($module);
603 604
      $name = "{$camelized}ServiceProvider";
      $class = "Drupal\\{$module}\\{$name}";
605
      if (class_exists($class)) {
606
        $this->serviceProviderClasses['app'][$module] = $class;
607
      }
608
      $filename = dirname($filename) . "/$module.services.yml";
609
      if (file_exists($filename)) {
610
        $this->serviceYamls['app'][$module] = $filename;
611
      }
612
    }
613

614
    // Add site-specific service providers.
615
    if (!empty($GLOBALS['conf']['container_service_providers'])) {
616
      foreach ($GLOBALS['conf']['container_service_providers'] as $class) {
617
        if ((is_string($class) && class_exists($class)) || (is_object($class) && ($class instanceof ServiceProviderInterface || $class instanceof ServiceModifierInterface))) {
618 619
          $this->serviceProviderClasses['site'][] = $class;
        }
620 621
      }
    }
622
    $this->addServiceFiles(Settings::get('container_yamls', []));
623 624 625 626 627
  }

  /**
   * {@inheritdoc}
   */
628 629
  public function getServiceProviders($origin) {
    return $this->serviceProviders[$origin];
630 631 632 633 634 635
  }

  /**
   * {@inheritdoc}
   */
  public function terminate(Request $request, Response $response) {
636 637 638
    // Only run terminate() when essential services have been set up properly
    // by preHandle() before.
    if (FALSE === $this->prepared) {
639 640 641 642 643 644 645 646 647 648 649
      return;
    }

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

  /**
   * {@inheritdoc}
   */
650
  public function handle(Request $request, $type = self::MASTER_REQUEST, $catch = TRUE) {
651 652 653 654 655 656 657 658 659 660
    // 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') {
661
        $response = new RedirectResponse($request->getBasePath() . '/core/install.php', 302, ['Cache-Control' => 'no-cache']);
662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686
      }
      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
687
   * @param \Symfony\Component\HttpFoundation\Request $request
688 689 690 691 692
   *   A Request instance
   * @param int $type
   *   The type of the request (one of HttpKernelInterface::MASTER_REQUEST or
   *   HttpKernelInterface::SUB_REQUEST)
   *
693
   * @return \Symfony\Component\HttpFoundation\Response
694
   *   A Response instance
695 696 697
   *
   * @throws \Exception
   *   If the passed in exception cannot be turned into a response.
698 699
   */
  protected function handleException(\Exception $e, $request, $type) {
700 701 702 703
    if ($this->shouldRedirectToInstaller($e, $this->container ? $this->container->get('database') : NULL)) {
      return new RedirectResponse($request->getBasePath() . '/core/install.php', 302, ['Cache-Control' => 'no-cache']);
    }

704 705 706 707 708
    if ($e instanceof HttpExceptionInterface) {
      $response = new Response($e->getMessage(), $e->getStatusCode());
      $response->headers->add($e->getHeaders());
      return $response;
    }
709 710

    throw $e;
711 712
  }

713 714 715 716 717 718
  /**
   * {@inheritdoc}
   */
  public function prepareLegacyRequest(Request $request) {
    $this->boot();
    $this->preHandle($request);
719 720 721 722 723
    // 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'));
    }
724 725
    $request->attributes->set(RouteObjectInterface::ROUTE_OBJECT, new Route('<none>'));
    $request->attributes->set(RouteObjectInterface::ROUTE_NAME, '<none>');
726 727 728 729 730
    $this->container->get('request_stack')->push($request);
    $this->container->get('router.request_context')->fromRequest($request);
    return $this;
  }

731 732 733 734 735 736
  /**
   * Returns module data on the filesystem.
   *
   * @param $module
   *   The name of the module.
   *
737 738
   * @return \Drupal\Core\Extension\Extension|bool
   *   Returns an Extension object if the module is found, FALSE otherwise.
739 740 741
   */
  protected function moduleData($module) {
    if (!$this->moduleData) {
742
      // First, find profiles.
743
      $listing = new ExtensionDiscovery($this->root);
744
      $listing->setProfileDirectories([]);
745 746 747
      $all_profiles = $listing->scan('profile');
      $profiles = array_intersect_key($all_profiles, $this->moduleList);

748 749
      // If a module is within a profile directory but specifies another
      // profile for testing, it needs to be found in the parent profile.
750
      $settings = $this->getConfigStorage()->read('simpletest.settings');
751 752
      $parent_profile = !empty($settings['parent_profile']) ? $settings['parent_profile'] : NULL;
      if ($parent_profile && !isset($profiles[$parent_profile])) {
753 754
        // In case both profile directories contain the same extension, the
        // actual profile always has precedence.
755
        $profiles = [$parent_profile => $all_profiles[$parent_profile]] + $profiles;
756
      }
757 758 759 760 761 762

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

763
      // Now find modules.
764
      $this->moduleData = $profiles + $listing->scan('module');
765 766 767 768
    }
    return isset($this->moduleData[$module]) ? $this->moduleData[$module] : FALSE;
  }

769 770
  /**
   * Implements Drupal\Core\DrupalKernelInterface::updateModules().
771 772 773
   *
   * @todo Remove obsolete $module_list parameter. Only $module_filenames is
   *   needed.
774
   */
775
  public function updateModules(array $module_list, array $module_filenames = []) {
776 777 778 779
    $pre_existing_module_namespaces = [];
    if ($this->booted && is_array($this->moduleList)) {
      $pre_existing_module_namespaces = $this->getModuleNamespacesPsr4($this->getModuleFileNames());
    }
780
    $this->moduleList = $module_list;
781 782
    foreach ($module_filenames as $name => $extension) {
      $this->moduleData[$name] = $extension;
783
    }
784

785
    // If we haven't yet booted, we don't need to do anything: the new module
786 787 788 789 790
    // 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;
791
    if ($this->booted) {
792 793 794 795 796 797 798 799 800 801 802 803 804 805
      // We need to register any new namespaces to a new class loader because
      // the current class loader might have stored a negative result for a
      // class that is now available.
      // @see \Composer\Autoload\ClassLoader::findFile()
      $new_namespaces = array_diff_key(
        $this->getModuleNamespacesPsr4($this->getModuleFileNames()),
        $pre_existing_module_namespaces
      );
      if (!empty($new_namespaces)) {
        $additional_class_loader = new ClassLoader();
        $this->classLoaderAddMultiplePsr4($new_namespaces, $additional_class_loader);
        $additional_class_loader->register();
      }

806
      $this->initializeContainer();
807 808
    }
  }
809

810
  /**
811
   * Returns the container cache key based on the environment.
812
   *
813 814 815 816 817 818 819 820 821
   * The 'environment' consists of:
   * - The kernel environment string.
   * - The Drupal version constant.
   * - The deployment identifier from settings.php. This allows custom
   *   deployments to force a container rebuild.
   * - The operating system running PHP. This allows compiler passes to optimize
   *   services for different operating systems.
   * - The paths to any additional container YAMLs from settings.php.
   *
822
   * @return string
823
   *   The cache key used for the service container.
824
   */
825
  protected function getContainerCacheKey() {
826
    $parts = ['service_container', $this->environment, \Drupal::VERSION, Settings::get('deployment_identifier'), PHP_OS, serialize(Settings::get('container_yamls'))];
827
    return implode(':', $parts);
828
  }
829 830 831 832 833 834 835

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

841 842
  /**
   * Initializes the service container.
843 844
   *
   * @return \Symfony\Component\DependencyInjection\ContainerInterface
845
   */
846
  protected function initializeContainer() {
847
    $this->containerNeedsDumping = FALSE;
848
    $session_started = FALSE;
849
    if (isset($this->container)) {
850 851 852 853 854
      // Save the id of the currently logged in user.
      if ($this->container->initialized('current_user')) {
        $current_user_id = $this->container->get('current_user')->id();
      }

855 856 857 858 859 860
      // 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();
861
        }
862
        unset($session);
863
      }
864
    }
865

866 867 868 869
    // 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) {
870
      $container = $this->container;
871 872
    }

873
    // If the module list hasn't already been set in updateModules and we are
874
    // not forcing a rebuild, then try and load the container from the cache.
875
    if (empty($this->moduleList) && !$this->containerNeedsRebuild) {
876
      $container_definition = $this->getCachedContainerDefinition();
877
    }
878

879 880 881
    // If there is no container and no cached container definition, build a new
    // one from scratch.
    if (!isset($container) && !isset($container_definition)) {
882 883 884 885 886 887 888 889 890 891
      // Building the container creates 1000s of objects. Garbage collection of
      // these objects is expensive. This appears to be causing random
      // segmentation faults in PHP 5.6 due to
      // https://bugs.php.net/bug.php?id=72286. Once the container is rebuilt,
      // garbage collection is re-enabled.
      $disable_gc = version_compare(PHP_VERSION, '7', '<') && gc_enabled();
      if ($disable_gc) {
        gc_collect_cycles();
        gc_disable();
      }
892
      $container = $this->compileContainer();
893 894 895 896 897 898 899 900

      // 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();
      }
901 902 903 904 905
      // If garbage collection was disabled prior to rebuilding container,
      // re-enable it.
      if ($disable_gc) {
        gc_enable();
      }
906 907
    }

908 909 910
    // The container was rebuilt successfully.
    $this->containerNeedsRebuild = FALSE;

911 912 913 914 915 916
    // 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);
    }

917
    $this->attachSynthetic($container);
918 919

    $this->container = $container;
920 921
    if ($session_started) {
      $this->container->get('session')->start();
922
    }
923 924 925 926 927

    // 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()) {
928
        $subrequest = TRUE;
929 930 931 932 933
        if ($request->hasSession()) {
          $request->setSession($this->container->get('session'));
        }
      }
    }
934 935 936 937 938

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

939
    \Drupal::setContainer($this->container);
940

941 942 943 944 945 946
    // Allow other parts of the codebase to react on container initialization in
    // subrequest.
    if (!empty($subrequest)) {
      $this->container->get('event_dispatcher')->dispatch(self::CONTAINER_INITIALIZE_SUBREQUEST_FINISHED);
    }

947
    // If needs dumping flag was set, dump the container.
948
    if ($this->containerNeedsDumping && !$this->cacheDrupalContainer($container_definition)) {
949
      $this->container->get('logger.factory')->get('DrupalKernel')->error('Container cannot be saved to cache.');
950 951
    }

952 953 954 955 956 957 958 959
    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.
960 961 962 963
   *
   * @param string $app_root
   *   (optional) The path to the application root as a string. If not supplied,
   *   the application root will be computed.
964
   */
965
  public static function bootEnvironment($app_root = NULL) {
966 967 968 969
    if (static::$isEnvironmentInitialized) {
      return;
    }

970 971 972 973 974
    // Determine the application root if it's not supplied.
    if ($app_root === NULL) {
      $app_root = static::guessApplicationRoot();
    }

975
    // Include our bootstrap file.
976
    require_once $app_root . '/core/includes/bootstrap.inc';
977

978 979 980 981 982 983 984
    // 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.

985 986 987 988 989 990 991 992 993 994 995 996
    if (PHP_SAPI !== 'cli') {
      // 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');
    }
997 998 999 1000 1001

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

1002 1003 1004
    // Set appropriate configuration for multi-byte strings.
    mb_internal_encoding('utf-8');
    mb_language('uni');
1005 1006 1007 1008

    // Indicate that code is operating in a test child site.
    if (!defined('DRUPAL_TEST_IN_CHILD_SITE')) {
      if ($test_prefix = drupal_valid_test_ua()) {
1009
        $test_db = new TestDatabase($test_prefix);
1010 1011 1012 1013 1014 1015
        // 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);

1016 1017 1018 1019
        // 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.
1020
        Handle::register();
1021

1022 1023
        // Log fatal errors to the test site directory.
        ini_set('log_errors', 1);
1024
        ini_set('error_log', $app_root . '/' . $test_db->getTestSitePath() . '/error.log');
1025 1026 1027 1028

        // Ensure that a rewritten settings.php is used if opcache is on.
        ini_set('opcache.validate_timestamps', 'on');
        ini_set('opcache.revalidate_freq', 0);
1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042
      }
      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;
  }

1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054
  /**
   * 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);
1055
    $class_loader_class = get_class($this->classLoader);
1056 1057 1058 1059
    Settings::initialize($this->root, $site_path, $this->classLoader);

    // Initialize our list of trusted HTTP Host headers to protect against
    // header attacks.
1060
    $host_patterns = Settings::get('trusted_host_patterns', []);
1061 1062 1063 1064 1065
    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.');
      }
    }
1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086

    // If the class loader is still the same, possibly
    // upgrade to an optimized class loader.
    if ($class_loader_class == get_class($this->classLoader)
        && Settings::get('class_loader_auto_detect', TRUE)) {
      $prefix = Settings::getApcuPrefix('class_loader', $this->root);
      $loader = NULL;

      // We autodetect one of the following three optimized classloaders, if
      // their underlying extension exists.
      if (function_exists('apcu_fetch')) {
        $loader = new ApcClassLoader($prefix, $this->classLoader);
      }
      elseif (extension_loaded('wincache')) {
        $loader = new WinCacheClassLoader($prefix, $this->classLoader);
      }
      elseif (extension_loaded('xcache')) {
        $loader = new XcacheClassLoader($prefix, $this->classLoader);
      }
      if (!empty($loader)) {
        $this->classLoader->unregister();
1087 1088 1089 1090 1091
        // The optimized classloader might be persistent and store cache misses.
        // For example, once a cache miss is stored in APCu clearing it on a
        // specific web-head will not clear any other web-heads. Therefore
        // fallback to the composer class loader that only statically caches
        // misses.
1092 1093 1094 1095 1096 1097
        $old_loader = $this->classLoader;
        $this->classLoader = $loader;
        // Our class loaders are preprended to ensure they come first like the
        // class loader they are replacing.
        $old_loader->register(TRUE);
        $loader->register(TRUE);
1098 1099
      }
    }
1100 1101
  }

1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112
  /**
   * 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.
1113
    global $base_path, $base_root;
1114 1115
    global $base_secure_url, $base_insecure_url;

1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127
    // 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);
1128 1129
      }
      else {
1130
        $base_path = $dir;
1131
      }
1132 1133 1134 1135 1136
      $base_url .= $base_path;
      $base_path .= '/';
    }
    else {
      $base_path = '/';
1137 1138 1139 1140
    }
    $base_secure_url = str_replace('http://', 'https://', $base_url);
    $base_insecure_url = str_replace('https://', 'http://', $base_url);
  }
1141

1142 1143 1144
  /**
   * Returns service instances to persist from an old container to a new one.
   */
1145
  protected function getServicesToPersist(ContainerInterface $container) {
1146
    $persist = [];
1147
    foreach ($container->getParameter('persist_ids') as $id) {
1148 1149 1150
      // It's pointless to persist services not yet initialized.
      if ($container->initialized($id)) {
        $persist[$id] = $container->get($id);
1151 1152 1153 1154 1155 1156 1157 1158
      }
    }
    return $persist;
  }

  /**
   * Moves persistent service instances into a new container.
   */
1159
  protected function persistServices(ContainerInterface $container, array $persist) {
1160 1161 1162
    foreach ($persist as $id => $object) {
      // Do not override services already set() on the new container, for
      // example 'service_container'.
1163 1164
      if (!$container->initialized($id)) {
        $container->set($id, $object);
1165 1166 1167 1168
      }
    }
  }

1169
  /**
1170
   * {@inheritdoc}
1171 1172 1173 1174
   */
  public function rebuildContainer() {
    // Empty module properties and for them to be reloaded from scratch.
    $this->moduleList = NULL;
1175
    $this->moduleData = [];
1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193
    $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;
    }

1194 1195
    // Also remove the container definition from the cache backend.
    $this->bootstrapContainer->get('cache.container')->deleteAll();
1196 1197 1198 1199 1200
  }

  /**
   * Attach synthetic values on to kernel.
   *
1201
   * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
1202
   *   Container object
1203
   *
1204
   * @return \Symfony\Component\DependencyInjection\ContainerInterface
1205
   */
1206
  protected function attachSynthetic(ContainerInterface $container) {
1207
    $persist = [];
1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225
    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.
1226
   *
1227
   * @return \Drupal\Core\DependencyInjection\ContainerBuilder The compiled service container
1228
   */