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

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

namespace Drupal\Core;

10
use Drupal\Component\ProxyBuilder\ProxyDumper;
11 12 13 14
use Drupal\Component\Utility\Crypt;
use Drupal\Component\Utility\Timer;
use Drupal\Component\Utility\Unicode;
use Drupal\Component\Utility\UrlHelper;
15
use Drupal\Core\Config\BootstrapConfigStorageFactory;
16
use Drupal\Core\Config\NullStorage;
17
use Drupal\Core\Database\Database;
18
use Drupal\Core\DependencyInjection\ContainerBuilder;
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\Language\Language;
24
use Drupal\Core\PageCache\RequestPolicyInterface;
25
use Drupal\Core\PhpStorage\PhpStorageFactory;
26
use Drupal\Core\ProxyBuilder\ProxyBuilder;
27
use Drupal\Core\Site\Settings;
28
use Symfony\Cmf\Component\Routing\RouteObjectInterface;
29
use Symfony\Component\DependencyInjection\ContainerInterface;
30
use Symfony\Component\DependencyInjection\ParameterBag\ParameterBag;
31
use Symfony\Component\DependencyInjection\Dumper\PhpDumper;
32
use Symfony\Component\HttpFoundation\RedirectResponse;
33
use Symfony\Component\HttpFoundation\Request;
34
use Symfony\Component\HttpFoundation\RequestStack;
35
use Symfony\Component\HttpFoundation\Response;
36
use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
37
use Symfony\Component\HttpKernel\TerminableInterface;
38
use Composer\Autoload\ClassLoader;
39
use Symfony\Component\Routing\Route;
40 41 42

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

56
  const CONTAINER_BASE_CLASS = '\Drupal\Core\DependencyInjection\Container';
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76

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

79 80 81 82
  /**
   * Holds the list of enabled modules.
   *
   * @var array
83 84
   *   An associative array whose keys are module names and whose values are
   *   ignored.
85 86 87
   */
  protected $moduleList;

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

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

102 103 104
  /**
   * The classloader object.
   *
105
   * @var \Composer\Autoload\ClassLoader
106 107 108
   */
  protected $classLoader;

109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
  /**
   * 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;

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

130
  /**
131 132 133 134 135 136
   * 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.
137 138 139 140 141
   *
   * @var array
   */
  protected $serviceYamls;

142
  /**
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
   * 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
158 159 160 161 162
   *
   * @var array
   */
  protected $serviceProviders;

163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
  /**
   * 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;

181 182 183 184 185 186 187
  /**
   * The app root.
   *
   * @var string
   */
  protected $root;

188 189 190 191
  /**
   * Create a DrupalKernel object from a request.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
192 193 194 195 196
   *   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.
197 198 199 200 201
   * @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.
202
   *
203 204
   * @return static
   */
205
  public static function createFromRequest(Request $request, $class_loader, $environment, $allow_dumping = TRUE) {
206
    // Include our bootstrap file.
207 208
    $core_root = dirname(dirname(dirname(__DIR__)));
    require_once $core_root . '/includes/bootstrap.inc';
209 210 211 212 213 214 215

    $kernel = new static($environment, $class_loader, $allow_dumping);

    // Ensure sane php environment variables..
    static::bootEnvironment();

    // Get our most basic settings setup.
216 217 218
    $site_path = static::findSitePath($request);
    $kernel->setSitePath($site_path);
    Settings::initialize(dirname($core_root), $site_path, $class_loader);
219 220 221 222

    // 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.
223
    if (!Database::getConnectionInfo() && !drupal_installation_attempted() && PHP_SAPI !== 'cli') {
224 225 226 227 228 229 230
      $response = new RedirectResponse($request->getBasePath() . '/core/install.php');
      $response->prepare($request)->send();
    }

    return $kernel;
  }

231 232 233 234
  /**
   * Constructs a DrupalKernel object.
   *
   * @param string $environment
235
   *   String indicating the environment, e.g. 'prod' or 'dev'.
236 237 238 239
   * @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.
240 241 242
   * @param bool $allow_dumping
   *   (optional) FALSE to stop the container from being written to or read
   *   from disk. Defaults to TRUE.
243
   */
244
  public function __construct($environment, $class_loader, $allow_dumping = TRUE) {
245
    $this->environment = $environment;
246
    $this->classLoader = $class_loader;
247
    $this->allowDumping = $allow_dumping;
248
    $this->root = dirname(dirname(substr(__DIR__, 0, -strlen(__NAMESPACE__))));
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
  }

  /**
   * 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
   * directory alias for http://www.drupal.org:8080/mysite/test whose
   * 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.
   *
294 295 296
   * @throws \Symfony\Component\HttpKernel\Exception\BadRequestHttpException
   *   In case the host name in the request is invalid.
   *
297 298 299 300 301 302
   * @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) {
303 304 305 306
    if (static::validateHostname($request) === FALSE) {
      throw new BadRequestHttpException();
    }

307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
    // 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');
    }
322
    $http_host = $request->getHost();
323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354

    $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) {
    $this->sitePath = $path;
  }

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

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

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

    // Start a page timer:
    Timer::start('page');

    // Ensure that findSitePath is set.
    if (!$this->sitePath) {
      throw new \Exception('Kernel does not have site path set before calling boot()');
378
    }
379
    // Initialize the container.
380
    $this->initializeContainer();
381 382 383 384 385 386

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

387
    $this->booted = TRUE;
388 389

    return $this;
390 391
  }

392
  /**
393
   * {@inheritdoc}
394
   */
395 396 397 398
  public function shutdown() {
    if (FALSE === $this->booted) {
      return;
    }
399
    $this->container->get('stream_wrapper_manager')->unregister();
400
    $this->booted = FALSE;
401
    $this->container = NULL;
402 403
    $this->moduleList = NULL;
    $this->moduleData = array();
404 405 406 407 408 409 410 411 412
  }

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

413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
  /**
   * {@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/path.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';
  }

433
  /**
434
   * {@inheritdoc}
435
   */
436
  public function preHandle(Request $request) {
437 438 439

    $this->loadLegacyIncludes();

440 441 442
    // Load all enabled modules.
    $this->container->get('module_handler')->loadAll();

443 444 445
    // Register stream wrappers.
    $this->container->get('stream_wrapper_manager')->register();

446 447 448
    // Initialize legacy request globals.
    $this->initializeRequestGlobals($request);

449 450
    // Put the request on the stack.
    $this->container->get('request_stack')->push($request);
451 452 453 454 455 456 457 458 459 460 461

    // Set the allowed protocols once we have the config available.
    $allowed_protocols = $this->container->get('config.factory')->get('system.filter')->get('protocols');
    if (!isset($allowed_protocols)) {
      // \Drupal\Component\Utility\UrlHelper::filterBadProtocol() is called by
      // the installer and update.php, in which case the configuration may not
      // exist (yet). Provide a minimal default set of allowed protocols for
      // these cases.
      $allowed_protocols = array('http', 'https');
    }
    UrlHelper::setAllowedProtocols($allowed_protocols);
462 463 464

    // Override of Symfony's mime type guesser singleton.
    MimeTypeGuesser::registerWithSymfonyGuesser($this->container);
465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483
  }

  /**
   * {@inheritdoc}
   *
   * @todo Invoke proper request/response/terminate events.
   */
  public function handlePageCache(Request $request) {
    $this->boot();

    // Check for a cache mode force from settings.php.
    if (Settings::get('page_cache_without_database')) {
      $cache_enabled = TRUE;
    }
    else {
      $config = $this->getContainer()->get('config.factory')->get('system.performance');
      $cache_enabled = $config->get('cache.page.use_internal');
    }

484 485
    $request_policy = \Drupal::service('page_cache_request_policy');
    if ($cache_enabled && $request_policy->check($request) === RequestPolicyInterface::ALLOW) {
486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502
      // Get the page from the cache.
      $response = drupal_page_get_cache($request);
      // If there is a cached page, display it.
      if ($response) {
        $response->headers->set('X-Drupal-Cache', 'HIT');

        drupal_serve_page_from_cache($response, $request);

        // We are done.
        $response->prepare($request);
        $response->send();
        exit;
      }
    }
    return $this;
  }

503 504 505 506
  /**
   * {@inheritdoc}
   */
  public function discoverServiceProviders() {
507
    $this->serviceYamls = array(
508 509
      'app' => array(),
      'site' => array(),
510
    );
511 512 513 514 515 516
    $this->serviceProviderClasses = array(
      'app' => array(),
      'site' => array(),
    );
    $this->serviceYamls['app']['core'] = 'core/core.services.yml';
    $this->serviceProviderClasses['app']['core'] = 'Drupal\Core\CoreServiceProvider';
517

518
    // Retrieve enabled modules and register their namespaces.
519
    if (!isset($this->moduleList)) {
520 521
      $extensions = $this->getConfigStorage()->read('core.extension');
      $this->moduleList = isset($extensions['module']) ? $extensions['module'] : array();
522
    }
523
    $module_filenames = $this->getModuleFileNames();
524
    $this->classLoaderAddMultiplePsr4($this->getModuleNamespacesPsr4($module_filenames));
525

526
    // Load each module's serviceProvider class.
527
    foreach ($module_filenames as $module => $filename) {
katbailey's avatar
katbailey committed
528
      $camelized = ContainerBuilder::camelize($module);
529 530
      $name = "{$camelized}ServiceProvider";
      $class = "Drupal\\{$module}\\{$name}";
531
      if (class_exists($class)) {
532
        $this->serviceProviderClasses['app'][$module] = $class;
533
      }
534
      $filename = dirname($filename) . "/$module.services.yml";
535
      if (file_exists($filename)) {
536
        $this->serviceYamls['app'][$module] = $filename;
537
      }
538
    }
539

540
    // Add site-specific service providers.
541
    if (!empty($GLOBALS['conf']['container_service_providers'])) {
542 543 544 545
      foreach ($GLOBALS['conf']['container_service_providers'] as $class) {
        if (class_exists($class)) {
          $this->serviceProviderClasses['site'][] = $class;
        }
546 547
      }
    }
548 549
    if ($container_yamls = Settings::get('container_yamls')) {
      $this->serviceYamls['site'] = $container_yamls;
550
    }
551 552
    $site_services_yml = $this->getSitePath() . '/services.yml';
    if (file_exists($site_services_yml) && is_readable($site_services_yml)) {
553
      $this->serviceYamls['site'][] = $site_services_yml;
554
    }
555 556 557 558 559
  }

  /**
   * {@inheritdoc}
   */
560 561
  public function getServiceProviders($origin) {
    return $this->serviceProviders[$origin];
562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579
  }

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

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

  /**
   * {@inheritdoc}
   */
580 581
  public function handle(Request $request, $type = self::MASTER_REQUEST, $catch = TRUE) {
    $this->boot();
582
    return $this->getHttpKernel()->handle($request, $type, $catch);
583 584
  }

585 586 587 588 589 590 591 592
  /**
   * {@inheritdoc}
   */
  public function prepareLegacyRequest(Request $request) {
    $this->boot();
    $this->preHandle($request);
    // Enter the request scope so that current_user service is available for
    // locale/translation sake.
593 594
    $request->attributes->set(RouteObjectInterface::ROUTE_OBJECT, new Route('<none>'));
    $request->attributes->set(RouteObjectInterface::ROUTE_NAME, '<none>');
595 596 597 598 599
    $this->container->get('request_stack')->push($request);
    $this->container->get('router.request_context')->fromRequest($request);
    return $this;
  }

600 601 602 603 604 605
  /**
   * Returns module data on the filesystem.
   *
   * @param $module
   *   The name of the module.
   *
606 607
   * @return \Drupal\Core\Extension\Extension|bool
   *   Returns an Extension object if the module is found, FALSE otherwise.
608 609 610
   */
  protected function moduleData($module) {
    if (!$this->moduleData) {
611
      // First, find profiles.
612
      $listing = new ExtensionDiscovery($this->root);
613 614 615 616
      $listing->setProfileDirectories(array());
      $all_profiles = $listing->scan('profile');
      $profiles = array_intersect_key($all_profiles, $this->moduleList);

617 618
      // If a module is within a profile directory but specifies another
      // profile for testing, it needs to be found in the parent profile.
619
      $settings = $this->getConfigStorage()->read('simpletest.settings');
620 621
      $parent_profile = !empty($settings['parent_profile']) ? $settings['parent_profile'] : NULL;
      if ($parent_profile && !isset($profiles[$parent_profile])) {
622 623
        // In case both profile directories contain the same extension, the
        // actual profile always has precedence.
624
        $profiles = array($parent_profile => $all_profiles[$parent_profile]) + $profiles;
625
      }
626 627 628 629 630 631

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

632
      // Now find modules.
633
      $this->moduleData = $profiles + $listing->scan('module');
634 635 636 637
    }
    return isset($this->moduleData[$module]) ? $this->moduleData[$module] : FALSE;
  }

638 639
  /**
   * Implements Drupal\Core\DrupalKernelInterface::updateModules().
640 641 642
   *
   * @todo Remove obsolete $module_list parameter. Only $module_filenames is
   *   needed.
643
   */
644
  public function updateModules(array $module_list, array $module_filenames = array()) {
645
    $this->moduleList = $module_list;
646 647
    foreach ($module_filenames as $name => $extension) {
      $this->moduleData[$name] = $extension;
648
    }
649

650 651
    // If we haven't yet booted, we don't need to do anything: the new module
    // list will take effect when boot() is called. If we have already booted,
652 653
    // then rebuild the container in order to refresh the serviceProvider list
    // and container.
654
    if ($this->booted) {
655
      $this->initializeContainer(TRUE);
656 657
    }
  }
658

659
  /**
660
   * Returns the classname based on environment.
661 662 663 664 665
   *
   * @return string
   *   The class name.
   */
  protected function getClassName() {
666
    $parts = array('service_container', $this->environment);
667 668 669
    return implode('_', $parts);
  }

670 671 672 673 674 675 676 677 678 679 680 681

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

682 683
  /**
   * Initializes the service container.
684 685 686 687
   *
   * @param bool $rebuild
   *   Force a container rebuild.
   * @return \Symfony\Component\DependencyInjection\ContainerInterface
688
   */
689
  protected function initializeContainer($rebuild = FALSE) {
690
    $this->containerNeedsDumping = FALSE;
691
    $session_manager_started = FALSE;
692
    if (isset($this->container)) {
693 694 695 696
      // If there is a session manager, close and save the session.
      if ($this->container->initialized('session_manager')) {
        $session_manager = $this->container->get('session_manager');
        if ($session_manager->isStarted()) {
697
          $session_manager_started = TRUE;
698
          $session_manager->save();
699 700 701
        }
        unset($session_manager);
      }
702
    }
703

704 705 706 707 708 709 710
    // 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.
    if (empty($this->moduleList) && !$rebuild) {
      $class = $this->getClassName();
      $cache_file = $class . '.php';

      // First, try to load from storage.
711
      if (!class_exists($class, FALSE)) {
712
        $this->storage()->load($cache_file);
713 714 715 716
      }
      // If the load succeeded or the class already existed, use it.
      if (class_exists($class, FALSE)) {
        $fully_qualified_class_name = '\\' . $class;
717
        $container = new $fully_qualified_class_name;
718 719
      }
    }
720 721 722 723 724

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

725
    $this->attachSynthetic($container);
726 727

    $this->container = $container;
728
    if ($session_manager_started) {
729 730
      $this->container->get('session_manager')->start();
    }
731
    \Drupal::setContainer($this->container);
732 733 734 735 736 737

    // If needs dumping flag was set, dump the container.
    if ($this->containerNeedsDumping && !$this->dumpDrupalContainer($this->container, static::CONTAINER_BASE_CLASS)) {
      $this->container->get('logger.factory')->get('DrupalKernel')->notice('Container cannot be written to disk');
    }

738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827
    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;
    }

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

  /**
   * 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.
    global $base_path, $base_root, $script_path;
    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']));
828
    }
829
    else {
830
      // Create base URL.
831
      $base_root = $request->getSchemeAndHttpHost();
832 833 834 835 836 837

      $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')), '\/')) {
838 839
        // Remove "core" directory if present, allowing install.php,
        // authorize.php, and others to auto-detect a base path.
840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855
        $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);
856

857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874
    // Determine the path of the script relative to the base path, and add a
    // trailing slash. This is needed for creating URLs to Drupal pages.
    if (!isset($script_path)) {
      $script_path = '';
      // We don't expect scripts outside of the base path, but sanity check
      // anyway.
      if (strpos($request->server->get('SCRIPT_NAME'), $base_path) === 0) {
        $script_path = substr($request->server->get('SCRIPT_NAME'), strlen($base_path)) . '/';
        // If the request URI does not contain the script name, then clean URLs
        // are in effect and the script path can be similarly dropped from URL
        // generation. For servers that don't provide $_SERVER['REQUEST_URI'],
        // we do not know the actual URI requested by the client, and
        // request_uri() returns a URI with the script name, resulting in
        // non-clean URLs unless
        // there's other code that intervenes.
        if (strpos(request_uri(TRUE) . '/', $base_path . $script_path) !== 0) {
          $script_path = '';
        }
875
        // @todo Temporary BC for install.php, authorize.php, and other scripts.
876 877 878 879 880
        //   - http://drupal.org/node/1547184
        //   - http://drupal.org/node/1546082
        if ($script_path !== 'index.php/') {
          $script_path = '';
        }
881 882 883
      }
    }

884
  }
885

886 887 888
  /**
   * Returns service instances to persist from an old container to a new one.
   */
889
  protected function getServicesToPersist(ContainerInterface $container) {
890
    $persist = array();
891 892 893 894
    foreach ($container->getParameter('persistIds') as $id) {
      // It's pointless to persist services not yet initialized.
      if ($container->initialized($id)) {
        $persist[$id] = $container->get($id);
895 896 897 898 899 900 901 902
      }
    }
    return $persist;
  }

  /**
   * Moves persistent service instances into a new container.
   */
903
  protected function persistServices(ContainerInterface $container, array $persist) {
904 905 906
    foreach ($persist as $id => $object) {
      // Do not override services already set() on the new container, for
      // example 'service_container'.
907 908
      if (!$container->initialized($id)) {
        $container->set($id, $object);
909 910 911 912
      }
    }
  }

913
  /**
914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929
   * Force a container rebuild.
   *
   * @return \Symfony\Component\DependencyInjection\ContainerInterface
   */
  public function rebuildContainer() {
    // Empty module properties and for them to be reloaded from scratch.
    $this->moduleList = NULL;
    $this->moduleData = array();
    return $this->initializeContainer(TRUE);
  }

  /**
   * Attach synthetic values on to kernel.
   *
   * @param ContainerInterface $container
   *   Container object
930
   *
931 932
   * @return ContainerInterface
   */
933
  protected function attachSynthetic(ContainerInterface $container) {
934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952
    $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.
953 954 955
   *
   * @return ContainerBuilder The compiled service container
   */
956 957 958 959 960 961 962 963
  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;
    }

964
    $this->initializeServiceProviders();
965
    $container = $this->getContainerBuilder();
966
    $container->set('kernel', $this);
967
    $container->setParameter('container.modules', $this->getModulesParameter());
968 969

    // Get a list of namespaces and put it onto the container.
970
    $namespaces = $this->getModuleNamespacesPsr4($this->getModuleFileNames());
971 972 973 974 975
    // Add all components in \Drupal\Core and \Drupal\Component that have one of
    // the following directories:
    // - Element
    // - Entity
    // - Plugin
976
    foreach (array('Core', 'Component') as $parent_directory) {
977
      $path = $this->root . '/core/lib/Drupal/' . $parent_directory;
978
      $parent_namespace = 'Drupal\\' . $parent_directory;
979
      foreach (new \DirectoryIterator($path) as $component) {
980 981 982 983 984 985 986
        /** @var $component \DirectoryIterator */
        $pathname = $component->getPathname();
        if (!$component->isDot() && $component->isDir() && (
          is_dir($pathname . '/Plugin') ||
          is_dir($pathname . '/Entity') ||
          is_dir($pathname . '/Element')
        )) {
987
          $namespaces[$parent_namespace . '\\' . $component->getFilename()] = $path . '/' . $component->getFilename();
988 989 990
        }
      }
    }
991 992
    $container->setParameter('container.namespaces', $namespaces);

993 994 995 996 997 998
    // 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;
999 1000
    if ($system = $this->getConfigStorage()->read('system.site')) {
      if ($default_language_values['id'] != $system['langcode']) {
1001
        $default_language_values = array('id' => $system['langcode']);
1002
      }
1003 1004 1005
    }
    $container->setParameter('language.default_values', $default_language_values);

1006
    // Register synthetic services.
1007
    $container->register('class_loader')->setSynthetic(TRUE);
1008 1009
    $container->register('kernel', 'Symfony\Component\HttpKernel\KernelInterface')->setSynthetic(TRUE);
    $container->register('service_container', 'Symfony\Component\DependencyInjection\ContainerInterface')->setSynthetic(TRUE);
1010 1011

    // Register application services.
1012
    $yaml_loader = new YamlFileLoader($container);
1013 1014 1015 1016 1017 1018 1019 1020 1021 1022
    foreach ($this->serviceYamls['app'] as $filename) {
      $yaml_loader->load($filename);
    }
    foreach ($this->serviceProviders['app'] as $provider) {
      if ($provider instanceof ServiceProviderInterface) {
        $provider->register($container);
      }
    }
    // Register site-specific service overrides.
    foreach ($this->serviceYamls['site'] as $filename) {
1023 1024
      $yaml_loader->load($filename);
    }
1025
    foreach ($this->serviceProviders['site'] as $provider) {
1026 1027 1028
      if ($provider instanceof ServiceProviderInterface) {
        $provider->register($container);
      }
1029
    }
1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042

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

1043
    $container->compile();
1044 1045
    return $container;
  }
1046

1047 1048 1049 1050 1051 1052
  /**
   * Registers all service providers to the kernel.
   *
   * @throws \LogicException
   */
  protected function initializeServiceProviders() {
1053 1054 1055 1056 1057 1058 1059 1060
    $this->discoverServiceProviders();
    $this->serviceProviders = array(
      'app' => array(),
      'site' => array(),
    );
    foreach ($this->serviceProviderClasses as $origin => $classes) {
      foreach ($classes as $name => $class) {
        $this->serviceProviders[$origin][$name] = new $class;
1061 1062 1063 1064
      }
    }
  }

1065 1066 1067 1068 1069
  /**
   * Gets a new ContainerBuilder instance used to build the service container.
   *
   * @return ContainerBuilder
   */
1070
  protected function getContainerBuilder() {
1071 1072 1073
    return new ContainerBuilder(new ParameterBag($this->getKernelParameters()));
  }

1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088
  /**
   * Dumps the service container to PHP code in the config directory.
   *
   * This method is based on the dumpContainer method in the parent class, but
   * that method is reliant on the Config component which we do not use here.
   *
   * @param ContainerBuilder $container
   *   The service container.
   * @param string $baseClass
   *   The name of the container's base class
   *
   * @return bool
   *   TRUE if the container was successfully dumped to disk.
   */
  protected function dumpDrupalContainer(ContainerBuilder $container, $baseClass) {
1089
    if (!$this->storage()->writeable()) {
1090 1091 1092 1093
      return FALSE;
    }
    // Cache the container.
    $dumper = new PhpDumper($container);
1094
    $dumper->setProxyDumper(new ProxyDumper(new ProxyBuilder()));
1095 1096
    $class = $this->getClassName();
    $content = $dumper->dump(array('class' => $class, 'base_class' => $baseClass));
1097
    return $this->storage()->save($class . '.php', $content);
1098 1099
  }

1100 1101 1102 1103

  /**
   * Gets a http kernel from the container
   *
1104
   * @return \Symfony\Component\HttpKernel\HttpKernelInterface
1105 1106 1107 1108 1109
   */
  protected function getHttpKernel() {
    return $this->container->get('http_kernel');
  }

1110 1111