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

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

namespace Drupal\Core;

10
11
12
13
use Drupal\Component\Utility\Crypt;
use Drupal\Component\Utility\Timer;
use Drupal\Component\Utility\Unicode;
use Drupal\Component\Utility\UrlHelper;
14
use Drupal\Core\Config\BootstrapConfigStorageFactory;
15
use Drupal\Core\Config\NullStorage;
16
use Drupal\Core\Database\Database;
17
use Drupal\Core\DependencyInjection\ContainerBuilder;
18
use Drupal\Core\DependencyInjection\ServiceProviderInterface;
19
use Drupal\Core\DependencyInjection\YamlFileLoader;
20
use Drupal\Core\Extension\ExtensionDiscovery;
21
use Drupal\Core\Language\Language;
22
23
24
use Drupal\Core\PhpStorage\PhpStorageFactory;
use Drupal\Core\Site\Settings;
use Symfony\Component\DependencyInjection\ContainerInterface;
25
use Symfony\Component\DependencyInjection\ParameterBag\ParameterBag;
26
use Symfony\Component\DependencyInjection\Dumper\PhpDumper;
27
use Symfony\Component\HttpFoundation\RedirectResponse;
28
use Symfony\Component\HttpFoundation\Request;
29
use Symfony\Component\HttpFoundation\RequestStack;
30
31
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\TerminableInterface;
32
use Composer\Autoload\ClassLoader;
33
34
35

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

49
  const CONTAINER_BASE_CLASS = '\Drupal\Core\DependencyInjection\Container';
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69

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

72
73
74
75
  /**
   * Holds the list of enabled modules.
   *
   * @var array
76
77
   *   An associative array whose keys are module names and whose values are
   *   ignored.
78
79
80
   */
  protected $moduleList;

81
  /**
82
   * List of available modules and installation profiles.
83
   *
84
   * @var \Drupal\Core\Extension\Extension[]
85
   */
86
  protected $moduleData = array();
87
88
89
90
91
92
93
94

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

95
96
97
  /**
   * The classloader object.
   *
98
   * @var \Composer\Autoload\ClassLoader
99
100
101
   */
  protected $classLoader;

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

123
  /**
124
125
126
127
128
129
   * 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.
130
131
132
133
134
   *
   * @var array
   */
  protected $serviceYamls;

135
  /**
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
   * 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
151
152
153
154
155
   *
   * @var array
   */
  protected $serviceProviders;

156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
  /**
   * Whether the request globals have been initialized.
   *
   * @var bool
   */
  protected static $isRequestInitialized = FALSE;

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

  /**
   * Create a DrupalKernel object from a request.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   * @param \Composer\Autoload\ClassLoader $class_loader
   *   (optional) The classloader is only used if $storage is not given or
   *   the load from storage fails and a container rebuild is required. In
   *   this case, the loaded modules will be registered with this loader in
   *   order to be able to find the module serviceProviders.
   * @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.
   * @return static
   */
  public static function createFromRequest(Request $request, ClassLoader $class_loader, $environment, $allow_dumping = TRUE) {
    // Include our bootstrap file.
    require_once dirname(dirname(dirname(__DIR__))) . '/includes/bootstrap.inc';

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

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

    // Get our most basic settings setup.
    $site_path = static::findSitePath($request);
    $kernel->setSitePath($site_path);
    Settings::initialize($site_path);

    // 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() && !drupal_is_cli()) {
      $response = new RedirectResponse($request->getBasePath() . '/core/install.php');
      $response->prepare($request)->send();
    }

    return $kernel;
  }

222
223
224
225
  /**
   * Constructs a DrupalKernel object.
   *
   * @param string $environment
226
   *   String indicating the environment, e.g. 'prod' or 'dev'.
227
   * @param \Composer\Autoload\ClassLoader $class_loader
228
   *   (optional) The class loader is only used if $storage is not given or
229
230
   *   the load from storage fails and a container rebuild is required. In
   *   this case, the loaded modules will be registered with this loader in
231
   *   order to be able to find the module serviceProviders.
232
233
234
   * @param bool $allow_dumping
   *   (optional) FALSE to stop the container from being written to or read
   *   from disk. Defaults to TRUE.
235
   */
236
  public function __construct($environment, ClassLoader $class_loader, $allow_dumping = TRUE) {
237
    $this->environment = $environment;
238
    $this->classLoader = $class_loader;
239
    $this->allowDumping = $allow_dumping;
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
  }

  /**
   * 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.
   *
   * @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) {
    // 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');
    }
    $http_host = $request->server->get('HTTP_HOST');

    $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;
339
340
  }

341
  /**
342
   * {@inheritdoc}
343
344
345
   */
  public function boot() {
    if ($this->booted) {
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
      return $this;
    }

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

    drupal_classloader();

    // Load legacy and other functional code.
    require_once DRUPAL_ROOT . '/core/includes/common.inc';
    require_once DRUPAL_ROOT . '/core/includes/database.inc';
    require_once DRUPAL_ROOT . '/' . Settings::get('path_inc', 'core/includes/path.inc');
    require_once DRUPAL_ROOT . '/core/includes/module.inc';
    require_once DRUPAL_ROOT . '/core/includes/theme.inc';
    require_once DRUPAL_ROOT . '/core/includes/pager.inc';
    require_once DRUPAL_ROOT . '/' . Settings::get('menu_inc', 'core/includes/menu.inc');
    require_once DRUPAL_ROOT . '/core/includes/tablesort.inc';
    require_once DRUPAL_ROOT . '/core/includes/file.inc';
    require_once DRUPAL_ROOT . '/core/includes/unicode.inc';
    require_once DRUPAL_ROOT . '/core/includes/form.inc';
    require_once DRUPAL_ROOT . '/core/includes/mail.inc';
    require_once DRUPAL_ROOT . '/core/includes/ajax.inc';
    require_once DRUPAL_ROOT . '/core/includes/errors.inc';
    require_once DRUPAL_ROOT . '/core/includes/schema.inc';
    require_once DRUPAL_ROOT . '/core/includes/entity.inc';

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

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

384
    $this->booted = TRUE;
385
386

    return $this;
387
388
  }

389
  /**
390
   * {@inheritdoc}
391
   */
392
393
394
395
396
  public function shutdown() {
    if (FALSE === $this->booted) {
      return;
    }
    $this->booted = FALSE;
397
    $this->container = NULL;
398
399
    $this->moduleList = NULL;
    $this->moduleData = array();
400
401
402
403
404
405
  }

  /**
   * {@inheritdoc}
   */
  public function getContainer() {
406
407
408
    if ($this->containerNeedsDumping && !$this->dumpDrupalContainer($this->container, static::CONTAINER_BASE_CLASS)) {
      watchdog('DrupalKernel', 'Container cannot be written to disk');
    }
409
410
411
    return $this->container;
  }

412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
  /**
   * Helper method that does request related initialization.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The current request.
   */
  protected function preHandle(Request $request) {
    // Load all enabled modules.
    $this->container->get('module_handler')->loadAll();

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

    // Initialize cookie globals.
    $this->initializeCookieGlobals($request);

    // Ensure container has a request scope so we can load file stream wrappers.
    if (!$this->container->isScopeActive('request')) {
      // Enter the request scope so that current_user service is available for
      // locale/translation sake.
      $this->container->enterScope('request');
      $this->container->set('request', $request, 'request');
      $this->container->get('request_stack')->push($request);
    }

    // Make sure all stream wrappers are registered.
    file_get_stream_wrappers();

    // Back out scope required to initialize the file stream wrappers.
    if ($this->container->isScopeActive('request')) {
      $this->container->leaveScope('request');
    }

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

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

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

    // If there is no session cookie and cache is enabled (or forced), try to
    // serve a cached page.
    if (!$request->cookies->has(session_name()) && $cache_enabled && drupal_page_is_cacheable()) {
      // 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;
  }

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

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

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

532
    // Add site-specific service providers.
533
    if (!empty($GLOBALS['conf']['container_service_providers'])) {
534
535
536
537
      foreach ($GLOBALS['conf']['container_service_providers'] as $class) {
        if (class_exists($class)) {
          $this->serviceProviderClasses['site'][] = $class;
        }
538
539
      }
    }
540
    if (!empty($GLOBALS['conf']['container_yamls'])) {
541
542
      $this->serviceYamls['site'] = $GLOBALS['conf']['container_yamls'];
    }
543
    if (file_exists($site_services_yml = $this->getSitePath() . '/services.yml')) {
544
      $this->serviceYamls['site'][] = $site_services_yml;
545
    }
546
547
548
549
550
  }

  /**
   * {@inheritdoc}
   */
551
552
  public function getServiceProviders($origin) {
    return $this->serviceProviders[$origin];
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
  }

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

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

  /**
   * {@inheritdoc}
   */
571
572
573
  public function handle(Request $request, $type = self::MASTER_REQUEST, $catch = TRUE) {
    $this->boot();
    $this->preHandle($request);
574
    return $this->getHttpKernel()->handle($request, $type, $catch);
575
576
  }

577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
  /**
   * {@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.
    $this->container->enterScope('request');
    $this->container->set('request', $request);
    $this->container->get('request_stack')->push($request);
    $this->container->get('router.request_context')->fromRequest($request);
    return $this;
  }

592
593
594
595
596
597
  /**
   * Returns module data on the filesystem.
   *
   * @param $module
   *   The name of the module.
   *
598
599
   * @return \Drupal\Core\Extension\Extension|bool
   *   Returns an Extension object if the module is found, FALSE otherwise.
600
601
602
   */
  protected function moduleData($module) {
    if (!$this->moduleData) {
603
      // First, find profiles.
604
605
606
607
608
      $listing = new ExtensionDiscovery();
      $listing->setProfileDirectories(array());
      $all_profiles = $listing->scan('profile');
      $profiles = array_intersect_key($all_profiles, $this->moduleList);

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

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

624
      // Now find modules.
625
      $this->moduleData = $profiles + $listing->scan('module');
626
627
628
629
    }
    return isset($this->moduleData[$module]) ? $this->moduleData[$module] : FALSE;
  }

630
631
  /**
   * Implements Drupal\Core\DrupalKernelInterface::updateModules().
632
633
634
   *
   * @todo Remove obsolete $module_list parameter. Only $module_filenames is
   *   needed.
635
   */
636
  public function updateModules(array $module_list, array $module_filenames = array()) {
637
    $this->moduleList = $module_list;
638
639
    foreach ($module_filenames as $name => $extension) {
      $this->moduleData[$name] = $extension;
640
    }
641

642
643
    // 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,
644
645
    // then rebuild the container in order to refresh the serviceProvider list
    // and container.
646
    if ($this->booted) {
647
      $this->initializeContainer(TRUE);
648
649
    }
  }
650

651
  /**
652
   * Returns the classname based on environment.
653
654
655
656
657
   *
   * @return string
   *   The class name.
   */
  protected function getClassName() {
658
    $parts = array('service_container', $this->environment);
659
660
661
    return implode('_', $parts);
  }

662
663
664
665
666
667
668
669
670
671
672
673

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

674
675
  /**
   * Initializes the service container.
676
677
678
679
   *
   * @param bool $rebuild
   *   Force a container rebuild.
   * @return \Symfony\Component\DependencyInjection\ContainerInterface
680
   */
681
  protected function initializeContainer($rebuild = FALSE) {
682
    $this->containerNeedsDumping = FALSE;
683
    // The request service requires custom persisting logic, since it is also
684
    // potentially scoped.
685
    $request_scope = FALSE;
686
    $request_stack = $request = NULL;
687
    $session_manager_state = 0;
688
689
690
691
692
693
694
    if (isset($this->container)) {
      if ($this->container->isScopeActive('request')) {
        $request_scope = TRUE;
      }
      if ($this->container->initialized('request')) {
        $request = $this->container->get('request');
      }
695
696
697
      if ($this->container->initialized('request_stack')) {
        $request_stack = $this->container->get('request_stack');
      }
698
699
700
701
702
703
704
705
706
707
708
709
      // 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->isStartedLazy()) {
          $session_manager_state |= 0x1;
        }
        if ($session_manager->isStarted()) {
          $session_manager_state |= 0x2;
        }
        $session_manager->save();
        unset($session_manager);
      }
710
    }
711

712
713
714
715
716
717
718
    // 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.
719
      if (!class_exists($class, FALSE)) {
720
        $this->storage()->load($cache_file);
721
722
723
724
      }
      // If the load succeeded or the class already existed, use it.
      if (class_exists($class, FALSE)) {
        $fully_qualified_class_name = '\\' . $class;
725
        $container = new $fully_qualified_class_name;
726
727
      }
    }
728
729
730
731
732
733
734
735

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

    $this->attachSynthetic($container, $request, $request_stack, $request_scope);

    $this->container = $container;
736
737
738
739
740
741
    if ($session_manager_state & 0x1) {
      $this->container->get('session_manager')->startLazy();
    }
    if ($session_manager_state & 0x2) {
      $this->container->get('session_manager')->start();
    }
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
828
829
830
831
832
833
834
    \Drupal::setContainer($this->container);
    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.
    _current_path(request_path());

    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']));
835
    }
836
    else {
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
      // Create base URL.
      $http_protocol = $request->isSecure() ? 'https' : 'http';
      $base_root = $http_protocol . '://' . $request->server->get('HTTP_HOST');

      $base_url = $base_root;

      // For a request URI of '/index.php/foo', $_SERVER['SCRIPT_NAME'] is
      // '/index.php', whereas $_SERVER['PHP_SELF'] is '/index.php/foo'.
      if ($dir = rtrim(dirname($request->server->get('SCRIPT_NAME')), '\/')) {
        // Remove "core" directory if present, allowing install.php, update.php,
        // and others to auto-detect a base path.
        $core_position = strrpos($dir, '/core');
        if ($core_position !== FALSE && strlen($dir) - 5 == $core_position) {
          $base_path = substr($dir, 0, $core_position);
        }
        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);
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
    // 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 = '';
        }
        // @todo Temporary BC for install.php, update.php, and other scripts.
        //   - http://drupal.org/node/1547184
        //   - http://drupal.org/node/1546082
        if ($script_path !== 'index.php/') {
          $script_path = '';
        }
889
890
891
      }
    }

892
  }
893

894
895
896
897
898
899
900
901
902
903
904
905
906
  /**
   * Initialize cookie settings.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The current request.
   *
   * @todo D8: Eliminate this entirely in favor of a session object.
   */
  protected function initializeCookieGlobals(Request $request) {
    // If we do this more then once per page request we are likely to cause
    // errors.
    if (static::$isRequestInitialized) {
      return;
907
    }
908
909
910
911
912
    global $cookie_domain;

    if ($cookie_domain) {
      // If the user specifies the cookie domain, also use it for session name.
      $session_name = $cookie_domain;
913
    }
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
    else {
      // Otherwise use $base_url as session name, without the protocol
      // to use the same session identifiers across HTTP and HTTPS.
      $session_name = $request->getHost() . $request->getBasePath();
      // Replace "core" out of session_name so core scripts redirect properly,
      // specifically install.php and update.php.
      $session_name = preg_replace('/\/core$/', '', $session_name);
      // HTTP_HOST can be modified by a visitor, but has been sanitized already
      // in DrupalKernel::bootEnvironment().
      if ($cookie_domain = $request->server->get('HTTP_HOST')) {
        // Strip leading periods, www., and port numbers from cookie domain.
        $cookie_domain = ltrim($cookie_domain, '.');
        if (strpos($cookie_domain, 'www.') === 0) {
          $cookie_domain = substr($cookie_domain, 4);
        }
        $cookie_domain = explode(':', $cookie_domain);
        $cookie_domain = '.' . $cookie_domain[0];
      }
    }
    // Per RFC 2109, cookie domains must contain at least one dot other than the
    // first. For hosts such as 'localhost' or IP Addresses we don't set a
    // cookie domain.
    if (count(explode('.', $cookie_domain)) > 2 && !is_numeric(str_replace('.', '', $cookie_domain))) {
      ini_set('session.cookie_domain', $cookie_domain);
    }
    // To prevent session cookies from being hijacked, a user can configure the
    // SSL version of their website to only transfer session cookies via SSL by
    // using PHP's session.cookie_secure setting. The browser will then use two
    // separate session cookies for the HTTPS and HTTP versions of the site. So
    // we must use different session identifiers for HTTPS and HTTP to prevent a
    // cookie collision.
    if ($request->isSecure()) {
      ini_set('session.cookie_secure', TRUE);
    }
    $prefix = ini_get('session.cookie_secure') ? 'SSESS' : 'SESS';

    session_name($prefix . substr(hash('sha256', $session_name), 0, 32));

    static::$isRequestInitialized = TRUE;
953
  }
954

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

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

982
  /**
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
   * 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
   * @param Request $request
   *   Request object.
   * @param RequestStack $request_stack
   *   Request stack.
   * @param null $request_scope
   * @return ContainerInterface
   */
  protected function attachSynthetic(ContainerInterface $container, Request $request = NULL, RequestStack $request_stack = NULL, $request_scope = NULL) {

    $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);
    // If we have a request set it back to the new container.
    if ($request_scope) {
      $container->enterScope('request');
    }
    if (isset($request)) {
      $container->set('request', $request);
    }
    if (isset($request_stack)) {
      $container->set('request_stack', $request_stack);
    }
    return $container;
  }

  /**
   * Compiles a new service container.
1037
1038
1039
   *
   * @return ContainerBuilder The compiled service container
   */
1040
1041
1042
1043
1044
1045
1046
1047
  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;
    }

1048
    $this->initializeServiceProviders();
1049
    $container = $this->getContainerBuilder();
1050
    $container->set('kernel', $this);
1051
    $container->setParameter('container.modules', $this->getModulesParameter());
1052
1053

    // Get a list of namespaces and put it onto the container.
1054
    $namespaces = $this->getModuleNamespacesPsr4($this->getModuleFileNames());
1055
1056
1057
1058
    // Add all components in \Drupal\Core and \Drupal\Component that have a
    // Plugin directory.
    foreach (array('Core', 'Component') as $parent_directory) {
      $path = DRUPAL_ROOT . '/core/lib/Drupal/' . $parent_directory;
1059
      $parent_namespace = 'Drupal\\' . $parent_directory;
1060
      foreach (new \DirectoryIterator($path) as $component) {
1061
        if (!$component->isDot() && $component->isDir() && is_dir($component->getPathname() . '/Plugin')) {
1062
          $namespaces[$parent_namespace . '\\' . $component->getFilename()] = $path . '/' . $component->getFilename();
1063
1064
1065
        }
      }
    }
1066
1067
    $container->setParameter('container.namespaces', $namespaces);

1068
1069
1070
1071
1072
1073
    // 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;
1074
1075
1076
1077
    if ($system = $this->getConfigStorage()->read('system.site')) {
      if ($default_language_values['id'] != $system['langcode']) {
        $default_language_values = array('id' => $system['langcode'], 'default' => TRUE);
      }
1078
1079
1080
    }
    $container->setParameter('language.default_values', $default_language_values);

1081
    // Register synthetic services.
1082
    $container->register('class_loader')->setSynthetic(TRUE);
1083
1084
    $container->register('kernel', 'Symfony\Component\HttpKernel\KernelInterface')->setSynthetic(TRUE);
    $container->register('service_container', 'Symfony\Component\DependencyInjection\ContainerInterface')->setSynthetic(TRUE);
1085
1086

    // Register application services.
1087
    $yaml_loader = new YamlFileLoader($container);
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
    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) {
1098
1099
      $yaml_loader->load($filename);
    }
1100
    foreach ($this->serviceProviders['site'] as $provider) {
1101
1102
1103
      if ($provider instanceof ServiceProviderInterface) {
        $provider->register($container);
      }
1104
    }
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117

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

1118
    $container->compile();
1119
1120
    return $container;
  }
1121

1122
1123
1124
1125
1126
1127
  /**
   * Registers all service providers to the kernel.
   *
   * @throws \LogicException
   */
  protected function initializeServiceProviders() {
1128
1129
1130
1131
1132
1133
1134
1135
    $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;
1136
1137
1138
1139
      }
    }
  }

1140
1141
1142
1143
1144
  /**
   * Gets a new ContainerBuilder instance used to build the service container.
   *
   * @return ContainerBuilder
   */
1145
  protected function getContainerBuilder() {
1146
1147
1148
    return new ContainerBuilder(new ParameterBag($this->getKernelParameters()));
  }

1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
  /**
   * 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) {
1164
    if (!$this->storage()->writeable()) {
1165
1166
1167
1168
      return FALSE;
    }
    // Cache the container.
    $dumper = new PhpDumper($container);
1169
1170
    $class = $this->getClassName();
    $content = $dumper->dump(array('class' => $class, 'base_class' => $baseClass));
1171
    return $this->storage()->save($class . '.php', $content);
1172
1173
  }

1174
1175
1176
1177

  /**
   * Gets a http kernel from the container
   *
1178
   * @return \Symfony\Component\HttpKernel\HttpKernelInterface
1179
1180
1181
1182
1183
   */
  protected function getHttpKernel() {
    return $this->container->get('http_kernel');
  }

1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
  /**
   * 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;
  }

1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
  /**
   * 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 {
        $this->configStorage = BootstrapConfigStorageFactory::get();
      }
      catch (\Exception $e) {
        $this->configStorage = new NullStorage();
      }
    }
    return $this->configStorage;
  }

1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
  /**
   * 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;
  }

1234
  /**
1235
1236
1237
1238
1239
   * 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.
1240
1241
1242
1243
1244
   */
  protected function getModuleFileNames() {
    $filenames = array();
    foreach ($this->moduleList as $module => $weight) {
      if ($data = $this->moduleData($module)) {
1245
        $filenames[$module] = $data->getPathname();
1246
1247
1248
1249
1250
      }
    }
    return $filenames;
  }

1251
1252
1253
  /**
   * Gets the PSR-4 base directories for module namespaces.
   *
1254
   * @param string[] $module_file_names
1255
1256
1257
   *   Array where each key is a module name, and each value is a path to the
   *   respective *.module or *.profile file.
   *
1258
   * @return string[]
1259
   *   Array where each key is a module namespace like 'Drupal\system', and each
1260
   *   value is the PSR-4 base directory associated with the module namespace.
1261
1262
1263
1264
   */
  protected function getModuleNamespacesPsr4($module_file_names) {
    $namespaces = array();
    foreach ($module_file_names as $module => $filename) {
1265
      $namespaces["Drupal\\$module"] = DRUPAL_ROOT . '/' . dirname($filename) . '/src';
1266
1267
1268
1269
    }
    return $namespaces;
  }

1270
1271
1272
1273
1274
1275
1276
1277
  /**
   * 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.
   */
1278
  protected function classLoaderAddMultiplePsr4(array $namespaces = array()) {
1279
1280
1281
1282
1283
    foreach ($namespaces as $prefix => $paths) {
      $this->classLoader->addPsr4($prefix . '\\', $paths);
    }
  }

1284
}