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

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

namespace Drupal\Core;

10
use Drupal\Component\FileCache\FileCacheFactory;
11
12
13
use Drupal\Component\Utility\Crypt;
use Drupal\Component\Utility\Unicode;
use Drupal\Component\Utility\UrlHelper;
14
use Drupal\Core\Config\BootstrapConfigStorageFactory;
15
use Drupal\Core\Config\NullStorage;
16
use Drupal\Core\Database\Database;
17
use Drupal\Core\DependencyInjection\ContainerBuilder;
18
use Drupal\Core\DependencyInjection\ServiceModifierInterface;
19
use Drupal\Core\DependencyInjection\ServiceProviderInterface;
20
use Drupal\Core\DependencyInjection\YamlFileLoader;
21
use Drupal\Core\Extension\ExtensionDiscovery;
22
use Drupal\Core\File\MimeType\MimeTypeGuesser;
23
use Drupal\Core\Http\TrustedHostsRequestFactory;
24
use Drupal\Core\Language\Language;
25
use Drupal\Core\PageCache\RequestPolicyInterface;
26
27
use Drupal\Core\PhpStorage\PhpStorageFactory;
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\Exception\HttpExceptionInterface;
38
use Symfony\Component\HttpKernel\TerminableInterface;
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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
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
   */
75
  protected $booted = FALSE;
76

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

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

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

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

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

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

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

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

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

154
  /**
155
   * List of discovered service provider class names or objects.
156
157
158
159
160
161
   *
   * 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.
   *
162
163
164
   * Allowing objects is for example used to allow
   * \Drupal\KernelTests\KernelTestBase to register itself as service provider.
   *
165
166
167
168
169
170
171
172
   * @var array
   */
  protected $serviceProviderClasses;

  /**
   * List of instantiated service provider classes.
   *
   * @see \Drupal\Core\DrupalKernel::$serviceProviderClasses
173
174
175
176
177
   *
   * @var array
   */
  protected $serviceProviders;

178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
  /**
   * 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;

196
197
198
199
200
201
202
  /**
   * The app root.
   *
   * @var string
   */
  protected $root;

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

230
231
232
233
  /**
   * Constructs a DrupalKernel object.
   *
   * @param string $environment
234
   *   String indicating the environment, e.g. 'prod' or 'dev'.
235
236
237
238
   * @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.
239
240
241
   * @param bool $allow_dumping
   *   (optional) FALSE to stop the container from being written to or read
   *   from disk. Defaults to TRUE.
242
   */
243
  public function __construct($environment, $class_loader, $allow_dumping = TRUE) {
244
    $this->environment = $environment;
245
    $this->classLoader = $class_loader;
246
    $this->allowDumping = $allow_dumping;
247
    $this->root = dirname(dirname(substr(__DIR__, 0, -strlen(__NAMESPACE__))));
248
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
  }

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

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

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

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

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

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

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

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

400
    // Initialize the container.
401
    $this->initializeContainer();
402
403
404
405
406
407

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

408
    $this->booted = TRUE;
409
410

    return $this;
411
412
  }

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

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

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

449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
  /**
   * {@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';
  }

468
  /**
469
   * {@inheritdoc}
470
   */
471
  public function preHandle(Request $request) {
472
473
474

    $this->loadLegacyIncludes();

475
476
477
    // Load all enabled modules.
    $this->container->get('module_handler')->loadAll();

478
479
480
    // Register stream wrappers.
    $this->container->get('stream_wrapper_manager')->register();

481
482
483
    // Initialize legacy request globals.
    $this->initializeRequestGlobals($request);

484
485
    // Put the request on the stack.
    $this->container->get('request_stack')->push($request);
486

487
488
    // Set the allowed protocols.
    UrlHelper::setAllowedProtocols($this->container->getParameter('filter_protocols'));
489
490
491

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

493
    $this->prepared = TRUE;
494
495
  }

496
497
498
499
  /**
   * {@inheritdoc}
   */
  public function discoverServiceProviders() {
500
    $this->serviceYamls = array(
501
502
      'app' => array(),
      'site' => array(),
503
    );
504
505
506
507
508
509
    $this->serviceProviderClasses = array(
      'app' => array(),
      'site' => array(),
    );
    $this->serviceYamls['app']['core'] = 'core/core.services.yml';
    $this->serviceProviderClasses['app']['core'] = 'Drupal\Core\CoreServiceProvider';
510

511
    // Retrieve enabled modules and register their namespaces.
512
    if (!isset($this->moduleList)) {
513
514
      $extensions = $this->getConfigStorage()->read('core.extension');
      $this->moduleList = isset($extensions['module']) ? $extensions['module'] : array();
515
    }
516
    $module_filenames = $this->getModuleFileNames();
517
    $this->classLoaderAddMultiplePsr4($this->getModuleNamespacesPsr4($module_filenames));
518

519
    // Load each module's serviceProvider class.
520
    foreach ($module_filenames as $module => $filename) {
katbailey's avatar
katbailey committed
521
      $camelized = ContainerBuilder::camelize($module);
522
523
      $name = "{$camelized}ServiceProvider";
      $class = "Drupal\\{$module}\\{$name}";
524
      if (class_exists($class)) {
525
        $this->serviceProviderClasses['app'][$module] = $class;
526
      }
527
      $filename = dirname($filename) . "/$module.services.yml";
528
      if (file_exists($filename)) {
529
        $this->serviceYamls['app'][$module] = $filename;
530
      }
531
    }
532

533
    // Add site-specific service providers.
534
    if (!empty($GLOBALS['conf']['container_service_providers'])) {
535
      foreach ($GLOBALS['conf']['container_service_providers'] as $class) {
536
        if ((is_string($class) && class_exists($class)) || (is_object($class) && ($class instanceof ServiceProviderInterface || $class instanceof ServiceModifierInterface))) {
537
538
          $this->serviceProviderClasses['site'][] = $class;
        }
539
540
      }
    }
541
    $this->addServiceFiles(Settings::get('container_yamls', []));
542
543
544
545
546
  }

  /**
   * {@inheritdoc}
   */
547
548
  public function getServiceProviders($origin) {
    return $this->serviceProviders[$origin];
549
550
551
552
553
554
  }

  /**
   * {@inheritdoc}
   */
  public function terminate(Request $request, Response $response) {
555
556
557
    // Only run terminate() when essential services have been set up properly
    // by preHandle() before.
    if (FALSE === $this->prepared) {
558
559
560
561
562
563
564
565
566
567
568
      return;
    }

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

  /**
   * {@inheritdoc}
   */
569
  public function handle(Request $request, $type = self::MASTER_REQUEST, $catch = TRUE) {
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
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
    // 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
614
615
616
   *
   * @throws \Exception
   *   If the passed in exception cannot be turned into a response.
617
618
619
620
621
622
623
624
   */
  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 {
625
      throw $e;
626
    }
627
628
  }

629
630
631
632
633
634
  /**
   * {@inheritdoc}
   */
  public function prepareLegacyRequest(Request $request) {
    $this->boot();
    $this->preHandle($request);
635
636
637
638
639
    // 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'));
    }
640
641
    $request->attributes->set(RouteObjectInterface::ROUTE_OBJECT, new Route('<none>'));
    $request->attributes->set(RouteObjectInterface::ROUTE_NAME, '<none>');
642
643
644
645
646
    $this->container->get('request_stack')->push($request);
    $this->container->get('router.request_context')->fromRequest($request);
    return $this;
  }

647
648
649
650
651
652
  /**
   * Returns module data on the filesystem.
   *
   * @param $module
   *   The name of the module.
   *
653
654
   * @return \Drupal\Core\Extension\Extension|bool
   *   Returns an Extension object if the module is found, FALSE otherwise.
655
656
657
   */
  protected function moduleData($module) {
    if (!$this->moduleData) {
658
      // First, find profiles.
659
      $listing = new ExtensionDiscovery($this->root);
660
661
662
663
      $listing->setProfileDirectories(array());
      $all_profiles = $listing->scan('profile');
      $profiles = array_intersect_key($all_profiles, $this->moduleList);

664
665
      // If a module is within a profile directory but specifies another
      // profile for testing, it needs to be found in the parent profile.
666
      $settings = $this->getConfigStorage()->read('simpletest.settings');
667
668
      $parent_profile = !empty($settings['parent_profile']) ? $settings['parent_profile'] : NULL;
      if ($parent_profile && !isset($profiles[$parent_profile])) {
669
670
        // In case both profile directories contain the same extension, the
        // actual profile always has precedence.
671
        $profiles = array($parent_profile => $all_profiles[$parent_profile]) + $profiles;
672
      }
673
674
675
676
677
678

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

679
      // Now find modules.
680
      $this->moduleData = $profiles + $listing->scan('module');
681
682
683
684
    }
    return isset($this->moduleData[$module]) ? $this->moduleData[$module] : FALSE;
  }

685
686
  /**
   * Implements Drupal\Core\DrupalKernelInterface::updateModules().
687
688
689
   *
   * @todo Remove obsolete $module_list parameter. Only $module_filenames is
   *   needed.
690
   */
691
  public function updateModules(array $module_list, array $module_filenames = array()) {
692
    $this->moduleList = $module_list;
693
694
    foreach ($module_filenames as $name => $extension) {
      $this->moduleData[$name] = $extension;
695
    }
696

697
    // If we haven't yet booted, we don't need to do anything: the new module
698
699
700
701
702
    // 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;
703
    if ($this->booted) {
704
      $this->initializeContainer();
705
706
    }
  }
707

708
  /**
709
   * Returns the classname based on environment.
710
711
712
713
714
   *
   * @return string
   *   The class name.
   */
  protected function getClassName() {
715
    $parts = array('service_container', $this->environment, hash('crc32b', \Drupal::VERSION . Settings::get('deployment_identifier')));
716
717
718
    return implode('_', $parts);
  }

719
720
721
722
723
724
725
726
727
  /**
   * Returns the container class namespace based on the environment.
   *
   * @return string
   *   The class name.
   */
  protected function getClassNamespace() {
    return 'Drupal\\Core\\DependencyInjection\\Container\\' . $this->environment;
  }
728
729
730
731
732
733
734
735
736
737
738
739

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

740
741
  /**
   * Initializes the service container.
742
743
   *
   * @return \Symfony\Component\DependencyInjection\ContainerInterface
744
   */
745
  protected function initializeContainer() {
746
    $this->containerNeedsDumping = FALSE;
747
    $session_started = FALSE;
748
    if (isset($this->container)) {
749
750
751
752
753
      // Save the id of the currently logged in user.
      if ($this->container->initialized('current_user')) {
        $current_user_id = $this->container->get('current_user')->id();
      }

754
755
756
757
758
759
      // 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();
760
        }
761
        unset($session);
762
      }
763
    }
764

765
766
767
768
769
770
771
    // 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) {
     $container = $this->container;
    }

772
773
    // 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.
774
    if (empty($this->moduleList) && !$this->containerNeedsRebuild) {
775
      $fully_qualified_class_name = '\\' . $this->getClassNamespace() . '\\' . $this->getClassName();
776
777

      // First, try to load from storage.
778
779
      if (!class_exists($fully_qualified_class_name, FALSE)) {
        $this->storage()->load($this->getClassName() . '.php');
780
781
      }
      // If the load succeeded or the class already existed, use it.
782
      if (class_exists($fully_qualified_class_name, FALSE)) {
783
        $container = new $fully_qualified_class_name;
784
785
      }
    }
786

787
    // If there is still no container, build a new one from scratch.
788
789
790
791
    if (!isset($container)) {
      $container = $this->compileContainer();
    }

792
793
794
    // The container was rebuilt successfully.
    $this->containerNeedsRebuild = FALSE;

795
    $this->attachSynthetic($container);
796
797

    $this->container = $container;
798
799
    if ($session_started) {
      $this->container->get('session')->start();
800
    }
801
802
803
804
805
806
807
808
809
810

    // 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'));
        }
      }
    }
811
812
813
814
815

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

816
    \Drupal::setContainer($this->container);
817
818

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

824
825
826
827
828
829
830
831
832
833
834
835
836
837
    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;
    }

838
839
840
841
    // Include our bootstrap file.
    $core_root = dirname(dirname(dirname(__DIR__)));
    require_once $core_root . '/includes/bootstrap.inc';

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

893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
  /**
   * 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;
    }
  }

930
931
932
933
934
935
936
937
938
939
940
941
  /**
   * 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.
942
    global $base_path, $base_root;
943
944
945
946
947
948
949
950
951
952
953
954
    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']));
955
    }
956
    else {
957
      // Create base URL.
958
      $base_root = $request->getSchemeAndHttpHost();
959
960
961
962
963
964

      $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')), '\/')) {
965
966
        // Remove "core" directory if present, allowing install.php,
        // authorize.php, and others to auto-detect a base path.
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
        $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);
  }
984

985
986
987
  /**
   * Returns service instances to persist from an old container to a new one.
   */
988
  protected function getServicesToPersist(ContainerInterface $container) {
989
    $persist = array();
990
    foreach ($container->getParameter('persist_ids') as $id) {
991
992
993
      // It's pointless to persist services not yet initialized.
      if ($container->initialized($id)) {
        $persist[$id] = $container->get($id);
994
995
996
997
998
999
1000
1001
      }
    }
    return $persist;
  }

  /**
   * Moves persistent service instances into a new container.
   */
1002
  protected function persistServices(ContainerInterface $container, array $persist) {
1003
1004
1005
    foreach ($persist as $id => $object) {
      // Do not override services already set() on the new container, for
      // example 'service_container'.
1006
1007
      if (!$container->initialized($id)) {
        $container->set($id, $object);
1008
1009
1010
1011
      }
    }
  }

1012
  /**
1013
   * {@inheritdoc}
1014
1015
1016
1017
1018
   */
  public function rebuildContainer() {
    // Empty module properties and for them to be reloaded from scratch.
    $this->moduleList = NULL;
    $this->moduleData = array();
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
    $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();
1040
1041
1042
1043
1044
1045
1046
  }

  /**
   * Attach synthetic values on to kernel.
   *
   * @param ContainerInterface $container
   *   Container object
1047
   *
1048
1049
   * @return ContainerInterface
   */
1050
  protected function attachSynthetic(ContainerInterface $container) {
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
    $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.
1070
1071
1072
   *
   * @return ContainerBuilder The compiled service container
   */
1073
1074
1075
1076
1077
1078
1079
1080
  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;
    }

1081
    $this->initializeServiceProviders();
1082
    $container = $this->getContainerBuilder();
1083
    $container->set('kernel', $this);
1084
    $container->setParameter('container.modules', $this->getModulesParameter());
1085
1086

    // Get a list of namespaces and put it onto the container.
1087
    $namespaces = $this->getModuleNamespacesPsr4($this->getModuleFileNames());
1088
1089
1090
1091
1092
    // Add all components in \Drupal\Core and \Drupal\Component that have one of
    // the following directories:
    // - Element
    // - Entity
    // - Plugin
1093
    foreach (array('Core', 'Component') as $parent_directory) {
1094
      $path = 'core/lib/Drupal/' . $parent_directory;
1095
      $parent_namespace = 'Drupal\\' . $parent_directory;
1096
      foreach (new \DirectoryIterator($this->root . '/' . $path) as $component) {
1097
1098
1099
1100
1101
1102
1103
        /** @var $component \DirectoryIterator */
        $pathname = $component->getPathname();
        if (!$component->isDot() && $component->isDir() && (
          is_dir($pathname . '/Plugin') ||
          is_dir($pathname . '/Entity') ||
          is_dir($pathname . '/Element')
        )) {
1104
          $namespaces[$parent_namespace . '\\' . $component->getFilename()] = $path . '/' . $component->getFilename();
1105
1106
1107
        }
      }
    }
1108
1109
    $container->setParameter('container.namespaces', $namespaces);

1110
1111
1112
1113
1114
1115
    // 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;
1116
1117
    if ($system = $this->getConfigStorage()->read('system.site')) {
      if ($default_language_values['id'] != $system['langcode']) {
1118
        $default_language_values = array('id' => $system['langcode']);
1119
      }
1120
1121
1122
    }
    $container->setParameter('language.default_values', $default_language_values);

1123
    // Register synthetic services.
1124
    $container->register('class_loader')->setSynthetic(TRUE);
1125
1126
    $container->register('kernel', 'Symfony\Component\HttpKernel\KernelInterface')->setSynthetic(TRUE);
    $container->register('service_container', 'Symfony\Component\DependencyInjection\ContainerInterface')->setSynthetic(TRUE);
1127
1128

    // Register application services.
1129
    $yaml_loader = new YamlFileLoader($container);
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
    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) {
1140
1141
      $yaml_loader->load($filename);
    }
1142
    foreach ($this->serviceProviders['site'] as $provider) {
1143
1144
1145
      if ($provider instanceof ServiceProviderInterface) {
        $provider->register($container);
      }
1146
    }
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157

    // 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;
      }
    }
1158
    $container->setParameter('persist_ids', $persist_ids);
1159

1160
    $container->compile();
1161
1162
    return $container;
  }
1163

1164
1165
1166
1167
1168
1169
  /**
   * Registers all service providers to the kernel.
   *
   * @throws \LogicException
   */
  protected function initializeServiceProviders() {
1170
1171
1172
1173
1174
1175
1176
    $this->discoverServiceProviders();
    $this->serviceProviders = array(
      'app' => array(),
      'site' => array(),
    );
    foreach ($this->serviceProviderClasses as $origin => $classes) {
      foreach ($classes as $name => $class) {
1177
1178
1179
1180
1181
1182
        if (!is_object($class)) {
          $this->serviceProviders[$origin][$name] = new $class;
        }
        else {
          $this->serviceProviders[$origin][$name] = $class;
        }
1183
1184
1185
1186
      }
    }
  }

1187
1188
1189
1190
1191
  /**
   * Gets a new ContainerBuilder instance used to build the service container.
   *
   * @return ContainerBuilder
   */
1192
  protected function getContainerBuilder() {
1193
1194
1195
    return new ContainerBuilder(new ParameterBag($this->getKernelParameters()));
  }

1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
  /**
   * 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) {
1211
    if (!$this->storage()->writeable()) {
1212
1213
1214
1215
      return FALSE;
    }
    // Cache the container.
    $dumper = new PhpDumper($container);
1216
    $class = $this->getClassName();
1217
1218
1219
1220
1221
1222
    $namespace = $this->getClassNamespace();
    $content = $dumper->dump([
      'class' => $class,
      'base_class' => $baseClass,
      'namespace' => $namespace,
    ]);
1223
    return $this->storage()->save($class . '.php', $content);
1224
1225
  }

1226
1227
1228
1229

  /**
   * Gets a http kernel from the container
   *
1230
   * @return \Symfony\Component\HttpKernel\HttpKernelInterface
1231
1232
1233
1234
1235
   */
  protected function getHttpKernel() {
    return $this->container->get('http_kernel');
  }

1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
  /**
   * Gets the PHP code storage object to use for the compiled container.
   *
   * @return \Drupal\Component\PhpStorage\PhpStorageInterface
   */
  protected function storage() {
    if (!isset($this->storage)) {
      $this->storage = PhpStorageFactory::get('service_container');
    }
    return $this->storage;
  }

1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
  /**
   * Returns the active configuration storage to use during building the container.
   *
   * @return \Drupal\Core\Config\StorageInterface
   */
  protected function getConfigStorage() {
    if (!isset($this->configStorage)) {
      // The active configuration storage may not exist yet; e.g., in the early
      // installer. Catch the exception thrown by config_get_config_directory().
      try {
1258
        $this->configStorage = BootstrapConfigStorageFactory::get($this->classLoader);
1259
1260
1261
1262
1263
1264
1265
1266
      }
      catch (\Exception $e) {
        $this->configStorage = new NullStorage();
      }
    }
    return $this->configStorage;
  }

1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
  /**
   * Returns an array of Extension class parameters for all enabled modules.
   *
   * @return array
   */
  protected function getModulesParameter() {
    $extensions = array();
    foreach ($this->moduleList as $name => $weight) {
      if ($data = $this->moduleData($name)) {
        $extensions[$name] = array(
          'type' => $data->getType(),
          'pathname' => $data->getPathname(),
          'filename' => $data->getExtensionFilename(),
        );
      }
    }
    return $extensions;
  }

1286
  /**
1287
1288
1289
1290
1291
   * Gets the file name for each enabled module.
   *
   * @return array
   *   Array where each key is a module name, and each value is a path to the
   *   respective *.module or *.profile file.
1292
1293
1294
1295
1296
   */
  protected function getModuleFileNames() {
    $filenames = array();
    foreach ($this->moduleList as $module => $weight) {
      if ($data = $this->moduleData($module)) {
1297
        $filenames[$module] = $data->getPathname();
1298
1299
1300
1301
1302
      }
    }
    return $filenames;
  }

1303
1304
1305
  /**
   * Gets the PSR-4 base directories for module namespaces.
   *
1306
   * @param string[] $module_file_names
1307
1308
1309
   *   Array where each key is a module name, and each value is a path to the
   *   respective *.module or *.profile file.
   *
1310
   * @return string[]
1311
   *   Array where each key is a module namespace like 'Drupal\system', and each
1312
   *   value is the PSR-4 base directory associated with the module namespace.
1313
1314
1315
1316
   */
  protected function getModuleNamespacesPsr4($module_file_names) {
    $namespaces = array();
    foreach ($module_file_names as $module => $filename) {
1317
      $namespaces["Drupal\\$module"] = dirname($filename) . '/src';
1318
1319
1320
1321
    }
    return $namespaces;
  }

1322
1323
1324
1325
1326
1327
1328
1329
  /**
   * Registers a list of namespaces with PSR-4 directories for class loading.
   *
   * @param array $namespaces
   *   Array where each key is a namespace like 'Drupal\system', and each value
   *   is either a PSR-4 base directory, or an array of PSR-4 base directories
   *   associated with this namespace.
   */
1330
  protected function classLoaderAddMultiplePsr4(array $namespaces = array()) {
1331
    foreach ($namespaces as $prefix => $paths) {
1332
1333
1334
1335
1336
1337
1338
1339
      if (is_array($paths)) {
        foreach ($paths as $key => $value) {
          $paths[$key] = $this->root . '/' . $value;</