DrupalKernel.php 46.8 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\ServiceProviderInterface;
19
use Drupal\Core\DependencyInjection\YamlFileLoader;
20
use Drupal\Core\Extension\ExtensionDiscovery;
21
use Drupal\Core\File\MimeType\MimeTypeGuesser;
22
use Drupal\Core\Http\TrustedHostsRequestFactory;
23
use Drupal\Core\Language\Language;
24
use Drupal\Core\PageCache\RequestPolicyInterface;
25 26
use Drupal\Core\PhpStorage\PhpStorageFactory;
use Drupal\Core\Site\Settings;
27
use Symfony\Cmf\Component\Routing\RouteObjectInterface;
28
use Symfony\Component\DependencyInjection\ContainerInterface;
29
use Symfony\Component\DependencyInjection\ParameterBag\ParameterBag;
30
use Symfony\Component\DependencyInjection\Dumper\PhpDumper;
31
use Symfony\Component\HttpFoundation\RedirectResponse;
32
use Symfony\Component\HttpFoundation\Request;
33
use Symfony\Component\HttpFoundation\RequestStack;
34
use Symfony\Component\HttpFoundation\Response;
35
use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
36
use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
37
use Symfony\Component\HttpKernel\TerminableInterface;
38
use Symfony\Component\Routing\Route;
39 40 41

/**
 * The DrupalKernel class is the core of Drupal itself.
42 43
 *
 * This class is responsible for building the Dependency Injection Container and
44 45 46 47 48 49 50 51
 * 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.
52
 */
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
class DrupalKernel implements DrupalKernelInterface, TerminableInterface {

  /**
   * 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
   */
74
  protected $booted = FALSE;
75

76 77 78 79 80 81 82
  /**
   * Whether essential services have been set up properly by preHandle().
   *
   * @var bool
   */
  protected $prepared = FALSE;

83 84 85 86
  /**
   * Holds the list of enabled modules.
   *
   * @var array
87 88
   *   An associative array whose keys are module names and whose values are
   *   ignored.
89 90 91
   */
  protected $moduleList;

92
  /**
93
   * List of available modules and installation profiles.
94
   *
95
   * @var \Drupal\Core\Extension\Extension[]
96
   */
97
  protected $moduleData = array();
98 99 100 101 102 103 104 105

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

106
  /**
107
   * The class loader object.
108
   *
109
   * @var \Composer\Autoload\ClassLoader
110 111 112
   */
  protected $classLoader;

113 114 115 116 117 118 119 120 121 122 123 124 125 126
  /**
   * 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;

127 128 129 130 131 132 133
  /**
   * Whether the container needs to be rebuilt the next time it is initialized.
   *
   * @var bool
   */
  protected $containerNeedsRebuild = FALSE;

134 135 136 137 138 139 140
  /**
   * Whether the container needs to be dumped once booting is complete.
   *
   * @var bool
   */
  protected $containerNeedsDumping;

141
  /**
142 143 144 145 146 147
   * 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.
148 149 150 151 152
   *
   * @var array
   */
  protected $serviceYamls;

153
  /**
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
   * List of discovered service provider class names.
   *
   * 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.
   *
   * @var array
   */
  protected $serviceProviderClasses;

  /**
   * List of instantiated service provider classes.
   *
   * @see \Drupal\Core\DrupalKernel::$serviceProviderClasses
169 170 171 172 173
   *
   * @var array
   */
  protected $serviceProviders;

174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
  /**
   * 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;

192 193 194 195 196 197 198
  /**
   * The app root.
   *
   * @var string
   */
  protected $root;

199 200 201 202
  /**
   * Create a DrupalKernel object from a request.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
203 204 205 206 207
   *   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.
208 209 210 211 212
   * @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.
213
   *
214
   * @return static
215 216 217
   *
   * @throws \Symfony\Component\HttpKernel\Exception\BadRequestHttpException
   *   In case the host name in the request is not trusted.
218
   */
219
  public static function createFromRequest(Request $request, $class_loader, $environment, $allow_dumping = TRUE) {
220 221
    $kernel = new static($environment, $class_loader, $allow_dumping);
    static::bootEnvironment();
222
    $kernel->initializeSettings($request);
223 224 225
    return $kernel;
  }

226 227 228 229
  /**
   * Constructs a DrupalKernel object.
   *
   * @param string $environment
230
   *   String indicating the environment, e.g. 'prod' or 'dev'.
231 232 233 234
   * @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.
235 236 237
   * @param bool $allow_dumping
   *   (optional) FALSE to stop the container from being written to or read
   *   from disk. Defaults to TRUE.
238
   */
239
  public function __construct($environment, $class_loader, $allow_dumping = TRUE) {
240
    $this->environment = $environment;
241
    $this->classLoader = $class_loader;
242
    $this->allowDumping = $allow_dumping;
243
    $this->root = dirname(dirname(substr(__DIR__, 0, -strlen(__NAMESPACE__))));
244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269
  }

  /**
   * 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
270
   * directory alias for https://www.drupal.org:8080/mysite/test whose
271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288
   * 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.
   *
289 290 291
   * @throws \Symfony\Component\HttpKernel\Exception\BadRequestHttpException
   *   In case the host name in the request is invalid.
   *
292 293 294 295 296 297
   * @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) {
298 299 300 301
    if (static::validateHostname($request) === FALSE) {
      throw new BadRequestHttpException();
    }

302 303 304 305 306 307 308 309 310 311 312 313 314 315 316
    // 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');
    }
317
    $http_host = $request->getHttpHost();
318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341

    $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) {
342 343 344
    if ($this->booted) {
      throw new \LogicException('Site path cannot be changed after calling boot()');
    }
345 346 347 348 349 350 351 352
    $this->sitePath = $path;
  }

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

355 356 357 358 359 360 361
  /**
   * {@inheritdoc}
   */
  public function getAppRoot() {
    return $this->root;
  }

362
  /**
363
   * {@inheritdoc}
364 365 366
   */
  public function boot() {
    if ($this->booted) {
367 368 369 370 371 372
      return $this;
    }

    // Ensure that findSitePath is set.
    if (!$this->sitePath) {
      throw new \Exception('Kernel does not have site path set before calling boot()');
373
    }
374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395

    // 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));

396
    // Initialize the container.
397
    $this->initializeContainer();
398 399 400 401 402 403

    // 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]);

404
    $this->booted = TRUE;
405 406

    return $this;
407 408
  }

409
  /**
410
   * {@inheritdoc}
411
   */
412 413 414 415
  public function shutdown() {
    if (FALSE === $this->booted) {
      return;
    }
416
    $this->container->get('stream_wrapper_manager')->unregister();
417
    $this->booted = FALSE;
418
    $this->container = NULL;
419 420
    $this->moduleList = NULL;
    $this->moduleData = array();
421 422 423 424 425 426 427 428 429
  }

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

430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448
  /**
   * {@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';
  }

449
  /**
450
   * {@inheritdoc}
451
   */
452
  public function preHandle(Request $request) {
453 454 455

    $this->loadLegacyIncludes();

456 457 458
    // Load all enabled modules.
    $this->container->get('module_handler')->loadAll();

459 460 461
    // Register stream wrappers.
    $this->container->get('stream_wrapper_manager')->register();

462 463 464
    // Initialize legacy request globals.
    $this->initializeRequestGlobals($request);

465 466
    // Put the request on the stack.
    $this->container->get('request_stack')->push($request);
467

468 469
    // Set the allowed protocols.
    UrlHelper::setAllowedProtocols($this->container->getParameter('filter_protocols'));
470 471 472

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

474
    $this->prepared = TRUE;
475 476
  }

477 478 479 480
  /**
   * {@inheritdoc}
   */
  public function discoverServiceProviders() {
481
    $this->serviceYamls = array(
482 483
      'app' => array(),
      'site' => array(),
484
    );
485 486 487 488 489 490
    $this->serviceProviderClasses = array(
      'app' => array(),
      'site' => array(),
    );
    $this->serviceYamls['app']['core'] = 'core/core.services.yml';
    $this->serviceProviderClasses['app']['core'] = 'Drupal\Core\CoreServiceProvider';
491

492
    // Retrieve enabled modules and register their namespaces.
493
    if (!isset($this->moduleList)) {
494 495
      $extensions = $this->getConfigStorage()->read('core.extension');
      $this->moduleList = isset($extensions['module']) ? $extensions['module'] : array();
496
    }
497
    $module_filenames = $this->getModuleFileNames();
498
    $this->classLoaderAddMultiplePsr4($this->getModuleNamespacesPsr4($module_filenames));
499

500
    // Load each module's serviceProvider class.
501
    foreach ($module_filenames as $module => $filename) {
katbailey's avatar
katbailey committed
502
      $camelized = ContainerBuilder::camelize($module);
503 504
      $name = "{$camelized}ServiceProvider";
      $class = "Drupal\\{$module}\\{$name}";
505
      if (class_exists($class)) {
506
        $this->serviceProviderClasses['app'][$module] = $class;
507
      }
508
      $filename = dirname($filename) . "/$module.services.yml";
509
      if (file_exists($filename)) {
510
        $this->serviceYamls['app'][$module] = $filename;
511
      }
512
    }
513

514
    // Add site-specific service providers.
515
    if (!empty($GLOBALS['conf']['container_service_providers'])) {
516 517 518 519
      foreach ($GLOBALS['conf']['container_service_providers'] as $class) {
        if (class_exists($class)) {
          $this->serviceProviderClasses['site'][] = $class;
        }
520 521
      }
    }
522 523
    if (!$this->addServiceFiles(Settings::get('container_yamls'))) {
      throw new \Exception('The container_yamls setting is missing from settings.php');
524
    }
525 526 527 528 529
  }

  /**
   * {@inheritdoc}
   */
530 531
  public function getServiceProviders($origin) {
    return $this->serviceProviders[$origin];
532 533 534 535 536 537
  }

  /**
   * {@inheritdoc}
   */
  public function terminate(Request $request, Response $response) {
538 539 540
    // Only run terminate() when essential services have been set up properly
    // by preHandle() before.
    if (FALSE === $this->prepared) {
541 542 543 544 545 546 547 548 549 550 551
      return;
    }

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

  /**
   * {@inheritdoc}
   */
552
  public function handle(Request $request, $type = self::MASTER_REQUEST, $catch = TRUE) {
553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596
    // 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
597 598 599
   *
   * @throws \Exception
   *   If the passed in exception cannot be turned into a response.
600 601 602 603 604 605 606 607
   */
  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 {
608
      throw $e;
609
    }
610 611
  }

612 613 614 615 616 617
  /**
   * {@inheritdoc}
   */
  public function prepareLegacyRequest(Request $request) {
    $this->boot();
    $this->preHandle($request);
618 619 620 621 622
    // 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'));
    }
623 624
    $request->attributes->set(RouteObjectInterface::ROUTE_OBJECT, new Route('<none>'));
    $request->attributes->set(RouteObjectInterface::ROUTE_NAME, '<none>');
625 626 627 628 629
    $this->container->get('request_stack')->push($request);
    $this->container->get('router.request_context')->fromRequest($request);
    return $this;
  }

630 631 632 633 634 635
  /**
   * Returns module data on the filesystem.
   *
   * @param $module
   *   The name of the module.
   *
636 637
   * @return \Drupal\Core\Extension\Extension|bool
   *   Returns an Extension object if the module is found, FALSE otherwise.
638 639 640
   */
  protected function moduleData($module) {
    if (!$this->moduleData) {
641
      // First, find profiles.
642
      $listing = new ExtensionDiscovery($this->root);
643 644 645 646
      $listing->setProfileDirectories(array());
      $all_profiles = $listing->scan('profile');
      $profiles = array_intersect_key($all_profiles, $this->moduleList);

647 648
      // If a module is within a profile directory but specifies another
      // profile for testing, it needs to be found in the parent profile.
649
      $settings = $this->getConfigStorage()->read('simpletest.settings');
650 651
      $parent_profile = !empty($settings['parent_profile']) ? $settings['parent_profile'] : NULL;
      if ($parent_profile && !isset($profiles[$parent_profile])) {
652 653
        // In case both profile directories contain the same extension, the
        // actual profile always has precedence.
654
        $profiles = array($parent_profile => $all_profiles[$parent_profile]) + $profiles;
655
      }
656 657 658 659 660 661

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

662
      // Now find modules.
663
      $this->moduleData = $profiles + $listing->scan('module');
664 665 666 667
    }
    return isset($this->moduleData[$module]) ? $this->moduleData[$module] : FALSE;
  }

668 669
  /**
   * Implements Drupal\Core\DrupalKernelInterface::updateModules().
670 671 672
   *
   * @todo Remove obsolete $module_list parameter. Only $module_filenames is
   *   needed.
673
   */
674
  public function updateModules(array $module_list, array $module_filenames = array()) {
675
    $this->moduleList = $module_list;
676 677
    foreach ($module_filenames as $name => $extension) {
      $this->moduleData[$name] = $extension;
678
    }
679

680
    // If we haven't yet booted, we don't need to do anything: the new module
681 682 683 684 685
    // 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;
686
    if ($this->booted) {
687
      $this->initializeContainer();
688 689
    }
  }
690

691
  /**
692
   * Returns the classname based on environment.
693 694 695 696 697
   *
   * @return string
   *   The class name.
   */
  protected function getClassName() {
698
    $parts = array('service_container', $this->environment, hash('crc32b', \Drupal::VERSION . Settings::get('deployment_identifier')));
699 700 701
    return implode('_', $parts);
  }

702 703 704 705 706 707 708 709 710
  /**
   * Returns the container class namespace based on the environment.
   *
   * @return string
   *   The class name.
   */
  protected function getClassNamespace() {
    return 'Drupal\\Core\\DependencyInjection\\Container\\' . $this->environment;
  }
711 712 713 714 715 716 717 718 719 720 721 722

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

723 724
  /**
   * Initializes the service container.
725 726
   *
   * @return \Symfony\Component\DependencyInjection\ContainerInterface
727
   */
728
  protected function initializeContainer() {
729
    $this->containerNeedsDumping = FALSE;
730
    $session_started = FALSE;
731
    if (isset($this->container)) {
732 733 734 735 736
      // Save the id of the currently logged in user.
      if ($this->container->initialized('current_user')) {
        $current_user_id = $this->container->get('current_user')->id();
      }

737 738 739 740 741 742
      // 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();
743
        }
744
        unset($session);
745
      }
746
    }
747

748 749
    // If the module list hasn't already been set in updateModules and we are
    // not forcing a rebuild, then try and load the container from the disk.
750
    if (empty($this->moduleList) && !$this->containerNeedsRebuild) {
751
      $fully_qualified_class_name = '\\' . $this->getClassNamespace() . '\\' . $this->getClassName();
752 753

      // First, try to load from storage.
754 755
      if (!class_exists($fully_qualified_class_name, FALSE)) {
        $this->storage()->load($this->getClassName() . '.php');
756 757
      }
      // If the load succeeded or the class already existed, use it.
758
      if (class_exists($fully_qualified_class_name, FALSE)) {
759
        $container = new $fully_qualified_class_name;
760 761
      }
    }
762 763 764 765 766

    if (!isset($container)) {
      $container = $this->compileContainer();
    }

767 768 769
    // The container was rebuilt successfully.
    $this->containerNeedsRebuild = FALSE;

770
    $this->attachSynthetic($container);
771 772

    $this->container = $container;
773 774
    if ($session_started) {
      $this->container->get('session')->start();
775
    }
776 777 778 779 780 781 782 783 784 785

    // 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'));
        }
      }
    }
786 787 788 789 790

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

791
    \Drupal::setContainer($this->container);
792 793

    // If needs dumping flag was set, dump the container.
794 795
    $base_class = Settings::get('container_base_class', '\Drupal\Core\DependencyInjection\Container');
    if ($this->containerNeedsDumping && !$this->dumpDrupalContainer($this->container, $base_class)) {
796 797 798
      $this->container->get('logger.factory')->get('DrupalKernel')->notice('Container cannot be written to disk');
    }

799 800 801 802 803 804 805 806 807 808 809 810 811 812
    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;
    }

813 814 815 816
    // Include our bootstrap file.
    $core_root = dirname(dirname(dirname(__DIR__)));
    require_once $core_root . '/includes/bootstrap.inc';

817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867
    // 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);

        // 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;
  }

868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904
  /**
   * 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;
    }
  }

905 906 907 908 909 910 911 912 913 914 915 916
  /**
   * 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) {
    // Provided by settings.php.
    global $base_url;
    // Set and derived from $base_url by this function.
917
    global $base_path, $base_root;
918 919 920 921 922 923 924 925 926 927 928 929
    global $base_secure_url, $base_insecure_url;

    // @todo Refactor with the Symfony Request object.
    if (isset($base_url)) {
      // Parse fixed base URL from settings.php.
      $parts = parse_url($base_url);
      if (!isset($parts['path'])) {
        $parts['path'] = '';
      }
      $base_path = $parts['path'] . '/';
      // Build $base_root (everything until first slash after "scheme://").
      $base_root = substr($base_url, 0, strlen($base_url) - strlen($parts['path']));
930
    }
931
    else {
932
      // Create base URL.
933
      $base_root = $request->getSchemeAndHttpHost();
934 935 936 937 938 939

      $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')), '\/')) {
940 941
        // Remove "core" directory if present, allowing install.php,
        // authorize.php, and others to auto-detect a base path.
942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958
        $core_position = strrpos($dir, '/core');
        if ($core_position !== FALSE && strlen($dir) - 5 == $core_position) {
          $base_path = substr($dir, 0, $core_position);
        }
        else {
          $base_path = $dir;
        }
        $base_url .= $base_path;
        $base_path .= '/';
      }
      else {
        $base_path = '/';
      }
    }
    $base_secure_url = str_replace('http://', 'https://', $base_url);
    $base_insecure_url = str_replace('https://', 'http://', $base_url);
  }
959

960 961 962
  /**
   * Returns service instances to persist from an old container to a new one.
   */
963
  protected function getServicesToPersist(ContainerInterface $container) {
964
    $persist = array();
965
    foreach ($container->getParameter('persist_ids') as $id) {
966 967 968
      // It's pointless to persist services not yet initialized.
      if ($container->initialized($id)) {
        $persist[$id] = $container->get($id);
969 970 971 972 973 974 975 976
      }
    }
    return $persist;
  }

  /**
   * Moves persistent service instances into a new container.
   */
977
  protected function persistServices(ContainerInterface $container, array $persist) {
978 979 980
    foreach ($persist as $id => $object) {
      // Do not override services already set() on the new container, for
      // example 'service_container'.
981 982
      if (!$container->initialized($id)) {
        $container->set($id, $object);
983 984 985 986
      }
    }
  }

987
  /**
988
   * {@inheritdoc}
989 990 991 992 993
   */
  public function rebuildContainer() {
    // Empty module properties and for them to be reloaded from scratch.
    $this->moduleList = NULL;
    $this->moduleData = array();
994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014
    $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;
    }

    // Also wipe the PHP Storage caches, so that the container is rebuilt
    // for the next request.
    $this->storage()->deleteAll();
1015 1016 1017 1018 1019 1020 1021
  }

  /**
   * Attach synthetic values on to kernel.
   *
   * @param ContainerInterface $container
   *   Container object
1022
   *
1023 1024
   * @return ContainerInterface
   */
1025
  protected function attachSynthetic(ContainerInterface $container) {
1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044
    $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.
1045 1046 1047
   *
   * @return ContainerBuilder The compiled service container
   */
1048 1049 1050 1051 1052 1053 1054 1055
  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;
    }

1056
    $this->initializeServiceProviders();
1057
    $container = $this->getContainerBuilder();
1058
    $container->set('kernel', $this);
1059
    $container->setParameter('container.modules', $this->getModulesParameter());
1060 1061

    // Get a list of namespaces and put it onto the container.
1062
    $namespaces = $this->getModuleNamespacesPsr4($this->getModuleFileNames());
1063 1064 1065 1066 1067
    // Add all components in \Drupal\Core and \Drupal\Component that have one of
    // the following directories:
    // - Element
    // - Entity
    // - Plugin
1068
    foreach (array('Core', 'Component') as $parent_directory) {
1069
      $path = 'core/lib/Drupal/' . $parent_directory;
1070
      $parent_namespace = 'Drupal\\' . $parent_directory;
1071
      foreach (new \DirectoryIterator($this->root . '/' . $path) as $component) {
1072 1073 1074 1075 1076 1077 1078
        /** @var $component \DirectoryIterator */
        $pathname = $component->getPathname();
        if (!$component->isDot() && $component->isDir() && (
          is_dir($pathname . '/Plugin') ||
          is_dir($pathname . '/Entity') ||
          is_dir($pathname . '/Element')
        )) {
1079
          $namespaces[$parent_namespace . '\\' . $component->getFilename()] = $path . '/' . $component->getFilename();
1080 1081 1082
        }
      }
    }
1083 1084
    $container->setParameter('container.namespaces', $namespaces);

1085 1086 1087 1088 1089 1090
    // Store the default language values on the container. This is so that the
    // default language can be configured using the configuration factory. This
    // avoids the circular dependencies that would created by
    // \Drupal\language\LanguageServiceProvider::alter() and allows the default
    // language to not be English in the installer.
    $default_language_values = Language::$defaultValues;
1091 1092
    if ($system = $this->getConfigStorage()->read('system.site')) {
      if ($default_language_values['id'] != $system['langcode']) {
1093
        $default_language_values = array('id' => $system['langcode']);
1094
      }
1095 1096 1097
    }
    $container->setParameter('language.default_values', $default_language_values);

1098
    // Register synthetic services.
1099
    $container->register('class_loader')->setSynthetic(TRUE);
1100 1101
    $container->register('kernel', 'Symfony\Component\HttpKernel\KernelInterface')->setSynthetic(TRUE);
    $container->register('service_container', 'Symfony\Component\DependencyInjection\ContainerInterface')->setSynthetic(TRUE);
1102 1103

    // Register application services.
1104
    $yaml_loader = new YamlFileLoader($container);
1105 1106 1107 1108 1109 1110 1111 1112