bootstrap.inc 108 KB
Newer Older
1
<?php
Dries's avatar
 
Dries committed
2

3
use Drupal\Component\Utility\Crypt;
4
use Drupal\Component\Utility\NestedArray;
5
use Drupal\Component\Utility\Settings;
6
use Drupal\Component\Utility\String;
7
use Drupal\Component\Utility\Timer;
8
use Drupal\Component\Utility\Unicode;
9
use Drupal\Component\Utility\UrlValidator;
10
use Drupal\Core\DrupalKernel;
11
use Drupal\Core\Database\Database;
12
use Drupal\Core\DependencyInjection\ContainerBuilder;
13
14
use Symfony\Component\ClassLoader\ClassLoader;
use Symfony\Component\ClassLoader\ApcClassLoader;
15
use Symfony\Component\DependencyInjection\ContainerInterface;
16
use Symfony\Component\DependencyInjection\Container;
katbailey's avatar
katbailey committed
17
use Symfony\Component\DependencyInjection\Reference;
18
use Symfony\Component\DependencyInjection\Exception\RuntimeException as DependencyInjectionRuntimeException;
19
use Symfony\Component\HttpFoundation\Request;
20
use Symfony\Component\HttpFoundation\Response;
21
use Drupal\Core\Language\Language;
22
23
use Drupal\Core\Lock\DatabaseLockBackend;
use Drupal\Core\Lock\LockBackendInterface;
24
use Drupal\user\Plugin\Core\Entity\User;
25
use Drupal\Core\Entity\EntityBCDecorator;
26

Dries's avatar
   
Dries committed
27
28
29
30
/**
 * @file
 * Functions that need to be loaded on every Drupal request.
 */
Dries's avatar
   
Dries committed
31

32
33
34
/**
 * The current system version.
 */
35
const VERSION = '8.0-dev';
36
37
38
39

/**
 * Core API compatibility.
 */
40
const DRUPAL_CORE_COMPATIBILITY = '8.x';
41
42
43
44

/**
 * Minimum supported version of PHP.
 */
45
const DRUPAL_MINIMUM_PHP = '5.3.10';
46
47
48
49

/**
 * Minimum recommended value of PHP memory_limit.
 */
50
const DRUPAL_MINIMUM_PHP_MEMORY_LIMIT = '32M';
51

52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
/**
 * Error reporting level: display no errors.
 */
const ERROR_REPORTING_HIDE = 'hide';

/**
 * Error reporting level: display errors and warnings.
 */
const ERROR_REPORTING_DISPLAY_SOME = 'some';

/**
 * Error reporting level: display all messages.
 */
const ERROR_REPORTING_DISPLAY_ALL = 'all';

/**
 * Error reporting level: display all messages, plus backtrace information.
 */
const ERROR_REPORTING_DISPLAY_VERBOSE = 'verbose';

72
73
74
75
76
77
/**
 * @defgroup logging_severity_levels Logging severity levels
 * @{
 * Logging severity levels as defined in RFC 3164.
 *
 * The WATCHDOG_* constant definitions correspond to the logging severity levels
78
 * defined in RFC 3164, section 4.1.1. PHP supplies predefined LOG_* constants
79
 * for use in the syslog() function, but their values on Windows builds do not
80
 * correspond to RFC 3164. The associated PHP bug report was closed with the
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 * comment, "And it's also not a bug, as Windows just have less log levels,"
 * and "So the behavior you're seeing is perfectly normal."
 *
 * @see http://www.faqs.org/rfcs/rfc3164.html
 * @see http://bugs.php.net/bug.php?id=18090
 * @see http://php.net/manual/function.syslog.php
 * @see http://php.net/manual/network.constants.php
 * @see watchdog()
 * @see watchdog_severity_levels()
 */

/**
 * Log message severity -- Emergency: system is unusable.
 */
95
const WATCHDOG_EMERGENCY = 0;
96
97
98
99

/**
 * Log message severity -- Alert: action must be taken immediately.
 */
100
const WATCHDOG_ALERT = 1;
101
102

/**
103
 * Log message severity -- Critical conditions.
104
 */
105
const WATCHDOG_CRITICAL = 2;
106
107

/**
108
 * Log message severity -- Error conditions.
109
 */
110
const WATCHDOG_ERROR = 3;
111
112

/**
113
 * Log message severity -- Warning conditions.
114
 */
115
const WATCHDOG_WARNING = 4;
116
117

/**
118
 * Log message severity -- Normal but significant conditions.
119
 */
120
const WATCHDOG_NOTICE = 5;
121
122

/**
123
 * Log message severity -- Informational messages.
124
 */
125
const WATCHDOG_INFO = 6;
126
127

/**
128
 * Log message severity -- Debug-level messages.
129
 */
130
const WATCHDOG_DEBUG = 7;
131
132
133
134
135

/**
 * @} End of "defgroup logging_severity_levels".
 */

136
137
138
/**
 * First bootstrap phase: initialize configuration.
 */
139
const DRUPAL_BOOTSTRAP_CONFIGURATION = 0;
140
141

/**
142
 * Second bootstrap phase, initalize a kernel.
143
 */
144
const DRUPAL_BOOTSTRAP_KERNEL = 1;
145
146

/**
147
 * Third bootstrap phase: try to serve a cached page.
148
 */
149
const DRUPAL_BOOTSTRAP_PAGE_CACHE = 2;
150
151

/**
152
 * Fourth bootstrap phase: initialize database layer.
153
 */
154
const DRUPAL_BOOTSTRAP_DATABASE = 3;
155
156

/**
157
 * Fifth bootstrap phase: initialize the variable system.
158
 */
159
const DRUPAL_BOOTSTRAP_VARIABLES = 4;
160
161

/**
162
 * Sixth bootstrap phase: initialize session handling.
163
 */
164
const DRUPAL_BOOTSTRAP_SESSION = 5;
165

166
167
168
/**
 * Eighth bootstrap phase: load code for subsystems and modules.
 */
169
const DRUPAL_BOOTSTRAP_CODE = 6;
170
171

/**
172
 * Final bootstrap phase: initialize language, path, theme, and modules.
173
 */
174
const DRUPAL_BOOTSTRAP_FULL = 7;
175

176
177
178
/**
 * Role ID for anonymous users; should match what's in the "role" table.
 */
179
const DRUPAL_ANONYMOUS_RID = 'anonymous';
180
181
182
183

/**
 * Role ID for authenticated users; should match what's in the "role" table.
 */
184
const DRUPAL_AUTHENTICATED_RID = 'authenticated';
185

186
/**
187
188
189
 * The number of bytes in a kilobyte.
 *
 * For more information, visit http://en.wikipedia.org/wiki/Kilobyte.
190
 */
191
const DRUPAL_KILOBYTE = 1024;
192

193
/**
194
 * Time of the current request in seconds elapsed since the Unix Epoch.
195
 *
196
197
198
199
200
201
 * This differs from $_SERVER['REQUEST_TIME'], which is stored as a float
 * since PHP 5.4.0. Float timestamps confuse most PHP functions
 * (including date_create()).
 *
 * @see http://php.net/manual/reserved.variables.server.php
 * @see http://php.net/manual/function.time.php
202
 */
203
define('REQUEST_TIME', (int) $_SERVER['REQUEST_TIME']);
204

205
206
207
/**
 * Flag for drupal_set_title(); text is not sanitized, so run check_plain().
 */
208
const CHECK_PLAIN = 0;
209
210
211
212

/**
 * Flag for drupal_set_title(); text has already been sanitized.
 */
213
const PASS_THROUGH = -1;
214

215
216
217
/**
 * Regular expression to match PHP function names.
 *
218
 * @see http://php.net/manual/language.functions.php
219
 */
220
const DRUPAL_PHP_FUNCTION_PATTERN = '[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*';
221

222
223
224
/**
 * $config_directories key for active directory.
 *
225
 * @see config_get_config_directory()
226
227
228
229
230
231
 */
const CONFIG_ACTIVE_DIRECTORY = 'active';

/**
 * $config_directories key for staging directory.
 *
232
 * @see config_get_config_directory()
233
234
235
 */
const CONFIG_STAGING_DIRECTORY = 'staging';

236
237
238
239
240
241
242
/**
 * Defines the root directory of the Drupal installation.
 *
 * This strips two levels of directories off the current directory.
 */
define('DRUPAL_ROOT', dirname(dirname(__DIR__)));

Dries's avatar
   
Dries committed
243
/**
244
245
 * @deprecated as of Drupal 8.0.
 * @see \Drupal\Component\Utility\Timer::start
Dries's avatar
   
Dries committed
246
247
 */
function timer_start($name) {
248
  Timer::start($name);
Dries's avatar
   
Dries committed
249
250
251
}

/**
252
253
 * @deprecated as of Drupal 8.0.
 * @see \Drupal\Component\Utility\Timer::read
Dries's avatar
   
Dries committed
254
255
 */
function timer_read($name) {
256
  return Timer::read($name);
Dries's avatar
   
Dries committed
257
258
259
}

/**
260
261
 * @deprecated as of Drupal 8.0.
 * @see \Drupal\Component\Utility\Timer::stop
Dries's avatar
   
Dries committed
262
263
 */
function timer_stop($name) {
264
  return Timer::stop($name);
Dries's avatar
   
Dries committed
265
}
266

Dries's avatar
   
Dries committed
267
/**
268
 * Returns the appropriate configuration directory.
Dries's avatar
   
Dries committed
269
 *
270
271
272
273
 * Returns the configuration path based on the site's hostname, port, and
 * pathname. Uses find_conf_path() to find the current configuration directory.
 * See default.settings.php for examples on how the URL is converted to a
 * directory.
274
 *
275
 * @param bool $require_settings
276
277
278
279
 *   Only configuration 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.
280
 * @param bool $reset
281
 *   Force a full search for matching directories even if one had been
282
283
 *   found previously. Defaults to FALSE.
 *
284
285
 * @return
 *   The path of the matching directory.
286
287
 *
 * @see default.settings.php
Dries's avatar
   
Dries committed
288
 */
289
function conf_path($require_settings = TRUE, $reset = FALSE) {
290
  $conf_path = &drupal_static(__FUNCTION__, '');
Dries's avatar
 
Dries committed
291

292
293
  if ($conf_path && !$reset) {
    return $conf_path;
Dries's avatar
Dries committed
294
  }
Dries's avatar
 
Dries committed
295

296
297
  // Check for a simpletest override.
  if ($simpletest_conf_path = _drupal_simpletest_conf_path()) {
298
299
    $conf_path = $simpletest_conf_path;
    return $conf_path;
300
301
302
  }

  // Otherwise, use the normal $conf_path.
303
304
305
306
307
  $script_name = $_SERVER['SCRIPT_NAME'];
  if (!$script_name) {
    $script_name = $_SERVER['SCRIPT_FILENAME'];
  }
  $http_host = $_SERVER['HTTP_HOST'];
308
309
  $conf_path = find_conf_path($http_host, $script_name, $require_settings);
  return $conf_path;
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
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
/**
 * Determines whether to use an overridden value for conf_path().
 *
 * Simpletest may provide a secondary, test-specific settings.php file to load
 * after the primary one used by the parent site and override its variables.
 * - If the child settings.php does not override $conf_path, then this function
 * returns FALSE and conf_path() returns the directory of the primary
 * settings.php.
 * - If the child settings.php does override $conf_path, then
 * _drupal_load_test_overrides() sets the 'simpletest_conf_path' setting, and
 * this function returns that to conf_path(), causing installations and
 * upgrades to act on that one.
 *
 * @return string|false
 *   The overridden $conf_path, or FALSE if the $conf_path should not currently
 *   be overridden.
 *
 * @see conf_path()
 * @see _drupal_load_test_overrides()
 */
function _drupal_simpletest_conf_path() {
  // Ensure that the settings object is available. conf_path() is called once
  // before the Settings class is included, and at that point it should still
  // load the primary $conf_path. See drupal_settings_initialize().
  if (!class_exists('Drupal\Component\Utility\Settings', FALSE)) {
    return FALSE;
  }

  // If no $simpletest_conf_path is set, use the normal $conf_path.
  if (!($simpletest_conf_path = settings()->get('simpletest_conf_path'))) {
    return FALSE;
  }

  // Ensure that this is actually a simpletest request. We can't check this
  // before settings.php is loaded.
  if (!drupal_valid_test_ua()) {
    return FALSE;
  }

  // When the $simpletest_conf_path is set in a valid test request,
  // return that path.
  return $simpletest_conf_path;
}

356
357
358
/**
 * Finds the appropriate configuration directory for a given host and path.
 *
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 * Finds a matching configuration 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 '$confdir/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 $confdir, 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
 *
380
381
382
383
 * @param $http_host
 *   The hostname and optional port number, e.g. "www.example.com" or
 *   "www.example.com:8080".
 * @param $script_name
384
 *   The part of the URL following the hostname, including the leading slash.
385
386
387
 * @param $require_settings
 *   Defaults to TRUE. If TRUE, then only match directories with a
 *   'settings.php' file. Otherwise match any directory.
388
389
390
391
 *
 * @return
 *   The path of the matching configuration directory.
 *
392
393
 * @see default.settings.php
 * @see example.sites.php
394
395
396
 * @see conf_path()
 */
function find_conf_path($http_host, $script_name, $require_settings = TRUE) {
397
398
399
400
  // Determine whether multi-site functionality is enabled.
  if (!file_exists(DRUPAL_ROOT . '/sites/sites.php')) {
    return 'sites/default';
  }
401
402

  $sites = array();
403
  include DRUPAL_ROOT . '/sites/sites.php';
404

405
406
  $uri = explode('/', $script_name);
  $server = explode('.', implode('.', array_reverse(explode(':', rtrim($http_host, '.')))));
Dries's avatar
Dries committed
407
408
409
  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));
410
      if (isset($sites[$dir]) && file_exists(DRUPAL_ROOT . '/sites/' . $sites[$dir])) {
411
412
        $dir = $sites[$dir];
      }
413
414
      if (file_exists(DRUPAL_ROOT . '/sites/' . $dir . '/settings.php') || (!$require_settings && file_exists(DRUPAL_ROOT . '/sites/' . $dir))) {
        return "sites/$dir";
Dries's avatar
Dries committed
415
      }
Dries's avatar
 
Dries committed
416
417
    }
  }
418
  return 'sites/default';
Dries's avatar
 
Dries committed
419
420
}

421
/**
422
423
424
425
426
 * Returns the path of a configuration directory.
 *
 * @param string $type
 *   (optional) The type of config directory to return. Drupal core provides
 *   'active' and 'staging'. Defaults to CONFIG_ACTIVE_DIRECTORY.
427
428
429
430
 *
 * @return string
 *   The configuration directory path.
 */
431
432
function config_get_config_directory($type = CONFIG_ACTIVE_DIRECTORY) {
  global $config_directories;
433

434
  if (!empty($config_directories[$type])) {
435
436
437
438
439
440
441
    // Allow a configuration directory path to be outside of webroot.
    if (empty($config_directories[$type]['absolute'])) {
      $path = conf_path() . '/files/' . $config_directories[$type]['path'];
    }
    else {
      $path = $config_directories[$type]['path'];
    }
442
443
  }
  else {
444
    throw new Exception(format_string('The configuration directory type %type does not exist.', array('%type' => $type)));
445
446
447
448
  }
  return $path;
}

449
/**
450
 * Sets appropriate server variables needed for command line scripts to work.
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
 *
 * This function can be called by command line scripts before bootstrapping
 * Drupal, to ensure that the page loads with the desired server parameters.
 * This is because many parts of Drupal assume that they are running in a web
 * browser and therefore use information from the global PHP $_SERVER variable
 * that does not get set when Drupal is run from the command line.
 *
 * In many cases, the default way in which this function populates the $_SERVER
 * variable is sufficient, and it can therefore be called without passing in
 * any input. However, command line scripts running on a multisite installation
 * (or on any installation that has settings.php stored somewhere other than
 * the sites/default folder) need to pass in the URL of the site to allow
 * Drupal to detect the correct location of the settings.php file. Passing in
 * the 'url' parameter is also required for functions like request_uri() to
 * return the expected values.
 *
 * Most other parameters do not need to be passed in, but may be necessary in
468
469
470
471
 * some cases; for example, if Drupal::request()->getClientIP()
 * needs to return anything but the standard localhost value ('127.0.0.1'),
 * the command line script should pass in the desired value via the
 * 'REMOTE_ADDR' key.
472
473
474
475
476
477
478
479
480
481
 *
 * @param $variables
 *   (optional) An associative array of variables within $_SERVER that should
 *   be replaced. If the special element 'url' is provided in this array, it
 *   will be used to populate some of the server defaults; it should be set to
 *   the URL of the current page request, excluding any $_GET request but
 *   including the script name (e.g., http://www.example.com/mysite/index.php).
 *
 * @see conf_path()
 * @see request_uri()
482
 * @see \Symfony\Component\HttpFoundation\Request::getClientIP()
483
484
 */
function drupal_override_server_variables($variables = array()) {
485
  // Allow the provided URL to override any existing values in $_SERVER.
486
487
  if (isset($variables['url'])) {
    $url = parse_url($variables['url']);
488
489
490
491
492
493
    if (isset($url['host'])) {
      $_SERVER['HTTP_HOST'] = $url['host'];
    }
    if (isset($url['path'])) {
      $_SERVER['SCRIPT_NAME'] = $url['path'];
    }
494
495
    unset($variables['url']);
  }
496
497
498
  // Define default values for $_SERVER keys. These will be used if $_SERVER
  // does not already define them and no other values are passed in to this
  // function.
499
  $defaults = array(
500
501
    'HTTP_HOST' => 'localhost',
    'SCRIPT_NAME' => NULL,
502
503
504
    'REMOTE_ADDR' => '127.0.0.1',
    'REQUEST_METHOD' => 'GET',
    'SERVER_NAME' => NULL,
505
    'SERVER_SOFTWARE' => NULL,
506
507
508
509
510
511
    'HTTP_USER_AGENT' => NULL,
  );
  // Replace elements of the $_SERVER array, as appropriate.
  $_SERVER = $variables + $_SERVER + $defaults;
}

512
/**
513
 * Initializes the PHP environment.
514
 */
515
function drupal_environment_initialize() {
516
517
518
  // Make sure the \Drupal class is available.
  require_once DRUPAL_ROOT . '/core/lib/Drupal.php';

519
520
  if (!isset($_SERVER['HTTP_REFERER'])) {
    $_SERVER['HTTP_REFERER'] = '';
521
  }
522
523
524
  if (!isset($_SERVER['SERVER_PROTOCOL']) || ($_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.0' && $_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.1')) {
    $_SERVER['SERVER_PROTOCOL'] = 'HTTP/1.0';
  }
525

526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
  if (isset($_SERVER['HTTP_HOST'])) {
    // As HTTP_HOST is user input, ensure it only contains characters allowed
    // in hostnames. See RFC 952 (and RFC 2181).
    // $_SERVER['HTTP_HOST'] is lowercased here per specifications.
    $_SERVER['HTTP_HOST'] = strtolower($_SERVER['HTTP_HOST']);
    if (!drupal_valid_http_host($_SERVER['HTTP_HOST'])) {
      // HTTP_HOST is invalid, e.g. if containing slashes it may be an attack.
      header($_SERVER['SERVER_PROTOCOL'] . ' 400 Bad Request');
      exit;
    }
  }
  else {
    // Some pre-HTTP/1.1 clients will not send a Host header. Ensure the key is
    // defined for E_ALL compliance.
    $_SERVER['HTTP_HOST'] = '';
541
542
  }

543
544
  // @todo Refactor with the Symfony Request object.
  _current_path(request_path());
545

546
547
  // Enforce E_STRICT, but allow users to set levels not part of E_STRICT.
  error_reporting(E_STRICT | E_ALL | error_reporting());
548

549
550
551
  // 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.
552

Dave Reid's avatar
Dave Reid committed
553
554
555
556
557
558
559
  // Deny execution with enabled "magic quotes" (both GPC and runtime).
  if (get_magic_quotes_gpc() || get_magic_quotes_runtime()) {
    header($_SERVER['SERVER_PROTOCOL'] . ' 500 Internal Server Error');
    print "PHP's 'magic_quotes_gpc' and 'magic_quotes_runtime' settings are not supported and must be disabled.";
    exit;
  }

560
561
  // Use session cookies, not transparent sessions that puts the session id in
  // the query string.
562
  ini_set('session.use_cookies', '1');
563
  ini_set('session.use_only_cookies', '1');
564
  ini_set('session.use_trans_sid', '0');
565
  // Don't send HTTP headers using PHP's session handler.
566
567
  // Send an empty string to disable the cache limiter.
  ini_set('session.cache_limiter', '');
568
569
  // Use httponly session cookies.
  ini_set('session.cookie_httponly', '1');
570
571
572
573

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

576
/**
577
 * Validates that a hostname (for example $_SERVER['HTTP_HOST']) is safe.
578
579
580
581
 *
 * @return
 *  TRUE if only containing valid characters, or FALSE otherwise.
 */
582
583
function drupal_valid_http_host($host) {
  return preg_match('/^\[?(?:[a-zA-Z0-9-:\]_]+\.?)+$/', $host);
584
585
}

586
/**
587
 * Sets the base URL, cookie domain, and session name from configuration.
588
 */
589
function drupal_settings_initialize() {
590
  global $base_url, $base_path, $base_root, $script_path;
591

592
  // Export these settings.php variables to the global namespace.
593
  global $databases, $cookie_domain, $conf, $db_prefix, $drupal_hash_salt, $base_secure_url, $base_insecure_url, $config_directories;
Dries's avatar
Dries committed
594
595
  $conf = array();

596
597
  // Make conf_path() available as local variable in settings.php.
  $conf_path = conf_path();
598
  if (is_readable(DRUPAL_ROOT . '/' . $conf_path . '/settings.php')) {
599
    include_once DRUPAL_ROOT . '/' . $conf_path . '/settings.php';
600
  }
601
602
  require_once DRUPAL_ROOT . '/core/lib/Drupal/Component/Utility/Settings.php';
  new Settings(isset($settings) ? $settings : array());
603
  $is_https = isset($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) == 'on';
604
605
606
607

  if (isset($base_url)) {
    // Parse fixed base URL from settings.php.
    $parts = parse_url($base_url);
608
609
610
    if (!isset($parts['path'])) {
      $parts['path'] = '';
    }
611
    $base_path = $parts['path'] . '/';
612
613
614
615
616
    // Build $base_root (everything until first slash after "scheme://").
    $base_root = substr($base_url, 0, strlen($base_url) - strlen($parts['path']));
  }
  else {
    // Create base URL
617
    $http_protocol = $is_https ? 'https' : 'http';
618
    $base_root = $http_protocol . '://' . $_SERVER['HTTP_HOST'];
619

620
    $base_url = $base_root;
621

622
623
    // For a request URI of '/index.php/foo', $_SERVER['SCRIPT_NAME'] is
    // '/index.php', whereas $_SERVER['PHP_SELF'] is '/index.php/foo'.
624
    if ($dir = rtrim(dirname($_SERVER['SCRIPT_NAME']), '\/')) {
625
      // Remove "core" directory if present, allowing install.php, update.php,
626
      // and others to auto-detect a base path.
627
628
629
630
631
632
633
      $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;
      }
634
635
636
637
638
639
640
      $base_url .= $base_path;
      $base_path .= '/';
    }
    else {
      $base_path = '/';
    }
  }
641
642
  $base_secure_url = str_replace('http://', 'https://', $base_url);
  $base_insecure_url = str_replace('https://', 'http://', $base_url);
643

644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
  // 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($_SERVER['SCRIPT_NAME'], $base_path) === 0) {
      $script_path = substr($_SERVER['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 = '';
      }
    }
  }

670
671
672
673
674
  if ($cookie_domain) {
    // If the user specifies the cookie domain, also use it for session name.
    $session_name = $cookie_domain;
  }
  else {
675
    // Otherwise use $base_url as session name, without the protocol
676
    // to use the same session identifiers across HTTP and HTTPS.
677
    list( , $session_name) = explode('://', $base_url, 2);
678
679
    // HTTP_HOST can be modified by a visitor, but we already sanitized it
    // in drupal_settings_initialize().
680
    if (!empty($_SERVER['HTTP_HOST'])) {
681
      $cookie_domain = $_SERVER['HTTP_HOST'];
682
683
684
685
686
687
688
      // 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];
689
690
691
692
693
694
695
    }
  }
  // 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);
  }
696
697
698
699
700
701
702
703
704
705
  // 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 ($is_https) {
    ini_set('session.cookie_secure', TRUE);
  }
  $prefix = ini_get('session.cookie_secure') ? 'SSESS' : 'SESS';
706
  session_name($prefix . substr(hash('sha256', $session_name), 0, 32));
707
708
}

Dries's avatar
Dries committed
709
/**
710
711
712
713
 * Returns and optionally sets the filename for a system resource.
 *
 * The filename, whether provided, cached, or retrieved from the database, is
 * only returned if the file exists.
Dries's avatar
Dries committed
714
 *
Dries's avatar
Dries committed
715
716
717
718
719
 * This function plays a key role in allowing Drupal's resources (modules
 * and themes) to be located in different places depending on a site's
 * configuration. For example, a module 'foo' may legally be be located
 * in any of these three places:
 *
720
 * core/modules/foo/foo.module
Dries's avatar
Dries committed
721
722
723
724
725
726
 * modules/foo/foo.module
 * sites/example.com/modules/foo/foo.module
 *
 * Calling drupal_get_filename('module', 'foo') will give you one of
 * the above, depending on where the module is located.
 *
Dries's avatar
Dries committed
727
 * @param $type
728
 *   The type of the item (i.e. theme, theme_engine, module, profile).
Dries's avatar
Dries committed
729
730
731
732
733
734
735
 * @param $name
 *   The name of the item for which the filename is requested.
 * @param $filename
 *   The filename of the item if it is to be set explicitly rather
 *   than by consulting the database.
 *
 * @return
736
 *   The filename of the requested item or NULL if the item is not found.
Dries's avatar
Dries committed
737
 */
Dries's avatar
Dries committed
738
function drupal_get_filename($type, $name, $filename = NULL) {
739
740
  // The location of files will not change during the request, so do not use
  // drupal_static().
741
  static $files = array(), $dirs = array();
Dries's avatar
Dries committed
742

743
744
745
  // Profiles are converted into modules in system_rebuild_module_data().
  // @todo Remove false-exposure of profiles as modules.
  $original_type = $type;
746
  if ($type == 'profile') {
747
    $type = 'module';
748
  }
749
  if (!isset($files[$type])) {
Dries's avatar
Dries committed
750
751
752
    $files[$type] = array();
  }

753
  if (!empty($filename) && file_exists($filename)) {
Dries's avatar
Dries committed
754
755
    $files[$type][$name] = $filename;
  }
756
  elseif (isset($files[$type][$name])) {
Dries's avatar
Dries committed
757
758
759
    // nothing
  }
  else {
760
761
762
    // Verify that we have an keyvalue service before using it. This is required
    // because this function is called during installation.
    // @todo Inject database connection into KeyValueStore\DatabaseStorage.
763
    if (($container = drupal_container()) && $container->has('keyvalue') && function_exists('db_query')) {
764
765
      if ($type == 'module') {
        if (empty($files[$type])) {
766
          $files[$type] = Drupal::moduleHandler()->getModuleList();
767
768
769
770
771
        }
        if (isset($files[$type][$name])) {
          return $files[$type][$name];
        }
      }
772
      try {
773
        $file_list = Drupal::state()->get('system.' . $type . '.files');
774
775
        if ($file_list && isset($file_list[$name]) && file_exists(DRUPAL_ROOT . '/' . $file_list[$name])) {
          $files[$type][$name] = $file_list[$name];
776
        }
777
      }
778
779
780
781
782
      catch (Exception $e) {
        // The keyvalue service raised an exception because the backend might
        // be down. We have a fallback for this case so we hide the error
        // completely.
      }
783
784
785
786
    }
    // Fallback to searching the filesystem if the database could not find the
    // file or the file returned by the database is not found.
    if (!isset($files[$type][$name])) {
787
      // We have consistent directory naming: modules, themes...
788
789
790
      $dir = $type . 's';
      if ($type == 'theme_engine') {
        $dir = 'themes/engines';
791
        $extension = 'engine';
792
793
      }
      elseif ($type == 'theme') {
794
        $extension = 'info.yml';
795
      }
796
797
798
799
800
801
      // Profiles are converted into modules in system_rebuild_module_data().
      // @todo Remove false-exposure of profiles as modules.
      elseif ($original_type == 'profile') {
        $dir = 'profiles';
        $extension = 'profile';
      }
802
      else {
803
        $extension = $type;
804
805
      }

806
807
808
      if (!isset($dirs[$dir][$extension])) {
        $dirs[$dir][$extension] = TRUE;
        if (!function_exists('drupal_system_listing')) {
809
          require_once __DIR__ . '/common.inc';
810
811
812
813
814
        }
        // Scan the appropriate directories for all files with the requested
        // extension, not just the file we are currently looking for. This
        // prevents unnecessary scans from being repeated when this function is
        // called more than once in the same page request.
815
        $matches = drupal_system_listing("/^" . DRUPAL_PHP_FUNCTION_PATTERN . "\.$extension$/", $dir);
816
817
818
        foreach ($matches as $matched_name => $file) {
          $files[$type][$matched_name] = $file->uri;
        }
Dries's avatar
Dries committed
819
820
821
822
      }
    }
  }

823
824
825
  if (isset($files[$type][$name])) {
    return $files[$type][$name];
  }
Dries's avatar
Dries committed
826
827
}

828
829
830
831
832
833
834
835
836
837
838
/**
 * Returns a setting.
 *
 * Settings can be set in settings.php in the $settings array and requested
 * by this function. Settings should be used over configuration for read-only,
 * possibly low bootstrap configuration that is environment specific.
 *
 * @return \Drupal\Component\Utility\Settings
 *   The settings object.
 */
function settings() {
839
  return Settings::getSingleton();
840
841
}

Dries's avatar
   
Dries committed
842
/**
843
 * Loads the persistent variable table.
Dries's avatar
   
Dries committed
844
845
 *
 * The variable table is composed of values that have been saved in the table
846
847
 * with variable_set() as well as those explicitly specified in the
 * configuration file.
Dries's avatar
   
Dries committed
848
 */
849
function variable_initialize($conf = array()) {
850
851
  // NOTE: caching the variables improves performance by 20% when serving
  // cached pages.
852
  if ($cached = cache('bootstrap')->get('variables')) {
853
    $variables = $cached->data;
Dries's avatar
   
Dries committed
854
855
  }
  else {
856
857
    // Cache miss. Avoid a stampede.
    $name = 'variable_init';
858
859
    $lock = Drupal::lock();
    if (!$lock->acquire($name, 1)) {
860
861
      // Another request is building the variable cache.
      // Wait, then re-run this function.
862
      $lock->wait($name);
863
864
865
866
867
      return variable_initialize($conf);
    }
    else {
      // Proceed with variable rebuild.
      $variables = array_map('unserialize', db_query('SELECT name, value FROM {variable}')->fetchAllKeyed());
868
      cache('bootstrap')->set('variables', $variables);
869
      $lock->release($name);
870
    }
Dries's avatar
   
Dries committed
871
872
873
874
  }

  foreach ($conf as $name => $value) {
    $variables[$name] = $value;
Dries's avatar
 
Dries committed
875
876
  }

Dries's avatar
   
Dries committed
877
  return $variables;
Dries's avatar
 
Dries committed
878
879
}

Dries's avatar
   
Dries committed
880
/**
881
882
883
884
885
 * Returns a persistent variable.
 *
 * Case-sensitivity of the variable_* functions depends on the database
 * collation used. To avoid problems, always use lower case for persistent
 * variable names.
Dries's avatar
   
Dries committed
886
887
888
889
890
 *
 * @param $name
 *   The name of the variable to return.
 * @param $default
 *   The default value to use if this variable has never been set.
891
 *
Dries's avatar
   
Dries committed
892
 * @return
893
 *   The value of the variable. Unserialization is taken care of as necessary.
894
 *
895
896
 * @see variable_del()
 * @see variable_set()
Dries's avatar
   
Dries committed
897
 */
898
function variable_get($name, $default = NULL) {
Dries's avatar
 
Dries committed
899
900
901
902
903
  global $conf;

  return isset($conf[$name]) ? $conf[$name] : $default;
}

Dries's avatar
   
Dries committed
904
/**
905
906
907
908
909
 * Sets a persistent variable.
 *
 * Case-sensitivity of the variable_* functions depends on the database
 * collation used. To avoid problems, always use lower case for persistent
 * variable names.
Dries's avatar
   
Dries committed
910
911
912
913
914
915
 *
 * @param $name
 *   The name of the variable to set.
 * @param $value
 *   The value to set. This can be any PHP data type; these functions take care
 *   of serialization as necessary.
916
 *
917
918
 * @see variable_del()
 * @see variable_get()
Dries's avatar
   
Dries committed
919
 */
Dries's avatar
 
Dries committed
920
921
922
function variable_set($name, $value) {
  global $conf;

923
  db_merge('variable')->key(array('name' => $name))->fields(array('value' => serialize($value)))->execute();
Dries's avatar
   
Dries committed
924

925
  cache('bootstrap')->delete('variables');
Dries's avatar
 
Dries committed
926
927
928
929

  $conf[$name] = $value;
}

Dries's avatar
   
Dries committed
930
/**
931
932
933
934
935
 * Unsets a persistent variable.
 *
 * Case-sensitivity of the variable_* functions depends on the database
 * collation used. To avoid problems, always use lower case for persistent
 * variable names.
Dries's avatar
   
Dries committed
936
937
938
 *
 * @param $name
 *   The name of the variable to undefine.
939
 *
940
941
 * @see variable_get()
 * @see variable_set()
Dries's avatar
   
Dries committed
942
 */
Dries's avatar
 
Dries committed
943
function variable_del($name) {
Dries's avatar
Dries committed
944
945
  global $conf;

946
947
948
  db_delete('variable')
    ->condition('name', $name)
    ->execute();
949
  cache('bootstrap')->delete('variables');
Dries's avatar
 
Dries committed
950

Dries's avatar
Dries committed
951
  unset($conf[$name]);
Dries's avatar
 
Dries committed
952
953
}

Dries's avatar
   
Dries committed
954
/**
955
 * Retrieves the current page from the cache.
Dries's avatar
   
Dries committed
956
 *
957
958
959
960
961
 * Note: we do not serve cached pages to authenticated users, or to anonymous
 * users when $_SESSION is non-empty. $_SESSION may contain status messages
 * from a form submission, the contents of a shopping cart, or other user-
 * specific content that should not be cached and displayed to other users.
 *
962
963
964
965
 * @param $check_only
 *   (optional) Set to TRUE to only return whether a previous call found a
 *   cache entry.
 *
966
 * @return
967
 *   The cache object, if the page was found in the cache, NULL otherwise.
Dries's avatar
   
Dries committed
968
 */
969
function drupal_page_get_cache($check_only = FALSE) {
970
  global $base_root;
971
972
973
974
975
  static $cache_hit = FALSE;

  if ($check_only) {
    return $cache_hit;
  }
Dries's avatar
 
Dries committed
976

977
  if (drupal_page_is_cacheable()) {
978
    $cache = cache('page')->get($base_root . request_uri());
979
980
981
982
    if ($cache !== FALSE) {
      $cache_hit = TRUE;
    }
    return $cache;
983
  }
984
985
986
}

/**
987
 * Determines the cacheability of the current page.
988
989
 *
 * @param $allow_caching
990
991
 *   Set to FALSE if you want to prevent this page to get cached.
 *
992
 * @return
993
 *   TRUE if the current page can be cached, FALSE otherwise.
994
995
996
997
998
 */
function drupal_page_is_cacheable($allow_caching = NULL) {
  $allow_caching_static = &drupal_static(__FUNCTION__, TRUE);
  if (isset($allow_caching)) {
    $allow_caching_static = $allow_caching;
Dries's avatar
 
Dries committed
999
  }
1000
1001

  return $allow_caching_static && ($_SERVER['REQUEST_METHOD'] == 'GET' || $_SERVER['REQUEST_METHOD'] == 'HEAD')
1002
    && !drupal_is_cli();
Dries's avatar
 
Dries committed
1003
1004
}

1005
/**
1006
 * Invokes a bootstrap hook in all bootstrap modules that implement it.
1007
1008
 *
 * @param $hook
1009
 *   The name of the bootstrap hook to invoke.
1010
1011
 *
 * @see bootstrap_hooks()
1012
1013
 */
function bootstrap_invoke_all($hook) {
1014
  $module_handler = Drupal::moduleHandler();
1015
1016
  foreach ($module_handler->getBootstrapModules() as $module) {
    $module_handler->load($module);
1017
1018
1019
1020
    module_invoke($module, $hook);
  }
}

Dries's avatar
Dries committed
1021
/**