bootstrap.inc 105 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\Core\Session\UserSession;
25

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

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

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

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

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

51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
/**
 * 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';

71
72
73
74
75
76
/**
 * @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
77
 * defined in RFC 3164, section 4.1.1. PHP supplies predefined LOG_* constants
78
 * for use in the syslog() function, but their values on Windows builds do not
79
 * correspond to RFC 3164. The associated PHP bug report was closed with the
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 * 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.
 */
94
const WATCHDOG_EMERGENCY = 0;
95
96
97
98

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

192
193
194
195
196
/**
 * The maximum number of characters in a module or theme name.
 */
const DRUPAL_EXTENSION_NAME_MAX_LENGTH = 50;

197
/**
198
 * Time of the current request in seconds elapsed since the Unix Epoch.
199
 *
200
201
202
203
204
205
 * 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
206
 */
207
define('REQUEST_TIME', (int) $_SERVER['REQUEST_TIME']);
208

209
210
211
/**
 * Flag for drupal_set_title(); text is not sanitized, so run check_plain().
 */
212
const CHECK_PLAIN = 0;
213
214
215
216

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

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

226
227
228
/**
 * $config_directories key for active directory.
 *
229
 * @see config_get_config_directory()
230
231
232
233
234
235
 */
const CONFIG_ACTIVE_DIRECTORY = 'active';

/**
 * $config_directories key for staging directory.
 *
236
 * @see config_get_config_directory()
237
238
239
 */
const CONFIG_STAGING_DIRECTORY = 'staging';

240
241
242
243
244
245
246
/**
 * 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
247
/**
248
249
 * @deprecated as of Drupal 8.0.
 * @see \Drupal\Component\Utility\Timer::start
Dries's avatar
   
Dries committed
250
251
 */
function timer_start($name) {
252
  Timer::start($name);
Dries's avatar
   
Dries committed
253
254
255
}

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

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

Dries's avatar
   
Dries committed
271
/**
272
 * Returns the appropriate configuration directory.
Dries's avatar
   
Dries committed
273
 *
274
275
276
277
 * 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.
278
 *
279
 * @param bool $require_settings
280
281
282
283
 *   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.
284
 * @param bool $reset
285
 *   Force a full search for matching directories even if one had been
286
287
 *   found previously. Defaults to FALSE.
 *
288
289
 * @return
 *   The path of the matching directory.
290
291
 *
 * @see default.settings.php
Dries's avatar
   
Dries committed
292
 */
293
function conf_path($require_settings = TRUE, $reset = FALSE) {
294
  $conf_path = &drupal_static(__FUNCTION__, '');
Dries's avatar
   
Dries committed
295

296
297
  if ($conf_path && !$reset) {
    return $conf_path;
Dries's avatar
Dries committed
298
  }
Dries's avatar
   
Dries committed
299

300
301
  // Check for a simpletest override.
  if ($simpletest_conf_path = _drupal_simpletest_conf_path()) {
302
303
    $conf_path = $simpletest_conf_path;
    return $conf_path;
304
305
306
  }

  // Otherwise, use the normal $conf_path.
307
308
309
310
311
  $script_name = $_SERVER['SCRIPT_NAME'];
  if (!$script_name) {
    $script_name = $_SERVER['SCRIPT_FILENAME'];
  }
  $http_host = $_SERVER['HTTP_HOST'];
312
313
  $conf_path = find_conf_path($http_host, $script_name, $require_settings);
  return $conf_path;
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
356
357
358
359
/**
 * 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;
}

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

  $sites = array();
407
  include DRUPAL_ROOT . '/sites/sites.php';
408

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

425
/**
426
427
428
429
430
 * 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.
431
432
433
434
 *
 * @return string
 *   The configuration directory path.
 */
435
436
function config_get_config_directory($type = CONFIG_ACTIVE_DIRECTORY) {
  global $config_directories;
437

438
  if (!empty($config_directories[$type])) {
439
440
441
442
443
444
445
    // 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'];
    }
446
447
  }
  else {
448
    throw new Exception(format_string('The configuration directory type %type does not exist.', array('%type' => $type)));
449
450
451
452
  }
  return $path;
}

453
/**
454
 * Sets appropriate server variables needed for command line scripts to work.
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 *
 * 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
472
473
474
475
 * 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.
476
477
478
479
480
481
482
483
484
485
 *
 * @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()
486
 * @see \Symfony\Component\HttpFoundation\Request::getClientIP()
487
488
 */
function drupal_override_server_variables($variables = array()) {
489
  // Allow the provided URL to override any existing values in $_SERVER.
490
491
  if (isset($variables['url'])) {
    $url = parse_url($variables['url']);
492
493
494
495
496
497
    if (isset($url['host'])) {
      $_SERVER['HTTP_HOST'] = $url['host'];
    }
    if (isset($url['path'])) {
      $_SERVER['SCRIPT_NAME'] = $url['path'];
    }
498
499
    unset($variables['url']);
  }
500
501
502
  // 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.
503
  $defaults = array(
504
505
    'HTTP_HOST' => 'localhost',
    'SCRIPT_NAME' => NULL,
506
507
508
    'REMOTE_ADDR' => '127.0.0.1',
    'REQUEST_METHOD' => 'GET',
    'SERVER_NAME' => NULL,
509
    'SERVER_SOFTWARE' => NULL,
510
511
512
513
514
515
    'HTTP_USER_AGENT' => NULL,
  );
  // Replace elements of the $_SERVER array, as appropriate.
  $_SERVER = $variables + $_SERVER + $defaults;
}

516
/**
517
 * Initializes the PHP environment.
518
 */
519
function drupal_environment_initialize() {
520
521
522
  // Make sure the \Drupal class is available.
  require_once DRUPAL_ROOT . '/core/lib/Drupal.php';

523
524
  if (!isset($_SERVER['HTTP_REFERER'])) {
    $_SERVER['HTTP_REFERER'] = '';
525
  }
526
527
528
  if (!isset($_SERVER['SERVER_PROTOCOL']) || ($_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.0' && $_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.1')) {
    $_SERVER['SERVER_PROTOCOL'] = 'HTTP/1.0';
  }
529

530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
  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'] = '';
545
546
  }

547
548
  // @todo Refactor with the Symfony Request object.
  _current_path(request_path());
549

550
551
  // Enforce E_STRICT, but allow users to set levels not part of E_STRICT.
  error_reporting(E_STRICT | E_ALL | error_reporting());
552

553
554
555
  // 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.
556

Dave Reid's avatar
Dave Reid committed
557
558
559
560
561
562
563
  // 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;
  }

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

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

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

590
/**
591
 * Sets the base URL, cookie domain, and session name from configuration.
592
 */
593
function drupal_settings_initialize() {
594
  global $base_url, $base_path, $base_root, $script_path;
595

596
  // Export these settings.php variables to the global namespace.
597
  global $databases, $cookie_domain, $conf, $db_prefix, $drupal_hash_salt, $base_secure_url, $base_insecure_url, $config_directories;
Dries's avatar
Dries committed
598
599
  $conf = array();

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

  if (isset($base_url)) {
    // Parse fixed base URL from settings.php.
    $parts = parse_url($base_url);
612
613
614
    if (!isset($parts['path'])) {
      $parts['path'] = '';
    }
615
    $base_path = $parts['path'] . '/';
616
617
618
619
620
    // 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
621
    $http_protocol = $is_https ? 'https' : 'http';
622
    $base_root = $http_protocol . '://' . $_SERVER['HTTP_HOST'];
623

624
    $base_url = $base_root;
625

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

648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
  // 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 = '';
      }
    }
  }

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

Dries's avatar
Dries committed
713
/**
714
715
716
717
 * 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
718
 *
Dries's avatar
Dries committed
719
720
721
722
723
 * 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:
 *
724
 * core/modules/foo/foo.module
Dries's avatar
Dries committed
725
726
727
728
729
730
 * 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
731
 * @param $type
732
 *   The type of the item (i.e. theme, theme_engine, module, profile).
Dries's avatar
Dries committed
733
734
735
736
737
738
739
 * @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
740
 *   The filename of the requested item or NULL if the item is not found.
Dries's avatar
Dries committed
741
 */
Dries's avatar
Dries committed
742
function drupal_get_filename($type, $name, $filename = NULL) {
743
744
  // The location of files will not change during the request, so do not use
  // drupal_static().
745
  static $files = array(), $dirs = array();
Dries's avatar
Dries committed
746

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

757
  if (!empty($filename) && file_exists($filename)) {
Dries's avatar
Dries committed
758
759
    $files[$type][$name] = $filename;
  }
760
  elseif (isset($files[$type][$name])) {
Dries's avatar
Dries committed
761
762
763
    // nothing
  }
  else {
764
765
766
    // 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.
767
    if (($container = drupal_container()) && $container->has('keyvalue') && function_exists('db_query')) {
768
769
      if ($type == 'module') {
        if (empty($files[$type])) {
770
          $files[$type] = Drupal::moduleHandler()->getModuleList();
771
772
773
774
775
        }
        if (isset($files[$type][$name])) {
          return $files[$type][$name];
        }
      }
776
      try {
777
        $file_list = Drupal::state()->get('system.' . $type . '.files');
778
779
        if ($file_list && isset($file_list[$name]) && file_exists(DRUPAL_ROOT . '/' . $file_list[$name])) {
          $files[$type][$name] = $file_list[$name];
780
        }
781
      }
782
783
784
785
786
      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.
      }
787
788
789
790
    }
    // 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])) {
791
      // We have consistent directory naming: modules, themes...
792
793
794
      $dir = $type . 's';
      if ($type == 'theme_engine') {
        $dir = 'themes/engines';
795
        $extension = 'engine';
796
797
      }
      elseif ($type == 'theme') {
798
        $extension = 'info.yml';
799
      }
800
801
802
803
804
805
      // 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';
      }
806
      else {
807
        $extension = $type;
808
809
      }

810
811
812
      if (!isset($dirs[$dir][$extension])) {
        $dirs[$dir][$extension] = TRUE;
        if (!function_exists('drupal_system_listing')) {
813
          require_once __DIR__ . '/common.inc';
814
815
816
817
818
        }
        // 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.
819
        $matches = drupal_system_listing("/^" . DRUPAL_PHP_FUNCTION_PATTERN . "\.$extension$/", $dir);
820
821
822
        foreach ($matches as $matched_name => $file) {
          $files[$type][$matched_name] = $file->uri;
        }
Dries's avatar
Dries committed
823
824
825
826
      }
    }
  }

827
828
829
  if (isset($files[$type][$name])) {
    return $files[$type][$name];
  }
Dries's avatar
Dries committed
830
831
}

832
833
834
835
836
837
838
839
840
841
842
/**
 * 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() {
843
  return Settings::getSingleton();
844
845
}

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

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

Dries's avatar
   
Dries committed
881
  return $variables;
Dries's avatar
   
Dries committed
882
883
}

Dries's avatar
   
Dries committed
884
/**
885
886
887
888
889
 * 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
890
891
892
893
894
 *
 * @param $name
 *   The name of the variable to return.
 * @param $default
 *   The default value to use if this variable has never been set.
895
 *
Dries's avatar
   
Dries committed
896
 * @return
897
 *   The value of the variable. Unserialization is taken care of as necessary.
898
 *
899
900
 * @see variable_del()
 * @see variable_set()
Dries's avatar
   
Dries committed
901
 */
902
function variable_get($name, $default = NULL) {
Dries's avatar
   
Dries committed
903
904
905
906
907
  global $conf;

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

Dries's avatar
   
Dries committed
908
/**
909
910
911
912
913
 * 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
914
915
916
917
918
919
 *
 * @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.
920
 *
921
922
 * @see variable_del()
 * @see variable_get()
Dries's avatar
   
Dries committed
923
 */
Dries's avatar
   
Dries committed
924
925
926
function variable_set($name, $value) {
  global $conf;

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

929
  cache('bootstrap')->delete('variables');
Dries's avatar
   
Dries committed
930
931
932
933

  $conf[$name] = $value;
}

Dries's avatar
   
Dries committed
934
/**
935
936
937
938
939
 * 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
940
941
942
 *
 * @param $name
 *   The name of the variable to undefine.
943
 *
944
945
 * @see variable_get()
 * @see variable_set()
Dries's avatar
   
Dries committed
946
 */
Dries's avatar
   
Dries committed
947
function variable_del($name) {
Dries's avatar
Dries committed
948
949
  global $conf;

950
951
952
  db_delete('variable')
    ->condition('name', $name)
    ->execute();
953
  cache('bootstrap')->delete('variables');
Dries's avatar
   
Dries committed
954

Dries's avatar
Dries committed
955
  unset($conf[$name]);
Dries's avatar
   
Dries committed
956
957
}

Dries's avatar
   
Dries committed
958
/**
959
 * Retrieves the current page from the cache.
Dries's avatar
   
Dries committed
960
 *
961
962
963
964
965
 * 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.
 *
966
967
968
969
 * @param $check_only
 *   (optional) Set to TRUE to only return whether a previous call found a
 *   cache entry.
 *
970
 * @return
971
 *   The cache object, if the page was found in the cache, NULL otherwise.
Dries's avatar
   
Dries committed
972
 */
973
function drupal_page_get_cache($check_only = FALSE) {
974
  global $base_root;
975
976
977
978
979
  static $cache_hit = FALSE;

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

981
  if (drupal_page_is_cacheable()) {
982
    $cache = cache('page')->get($base_root . request_uri());
983
984
985
986
    if ($cache !== FALSE) {
      $cache_hit = TRUE;
    }
    return $cache;
987
  }
988
989
990
}

/**
991
 * Determines the cacheability of the current page.
992
993
 *
 * @param $allow_caching
994
995
 *   Set to FALSE if you want to prevent this page to get cached.
 *
996
 * @return
997
 *   TRUE if the current page can be cached, FALSE otherwise.
998
999
1000
1001
1002
 */
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
1003
  }
1004
1005

  return $allow_caching_static && ($_SERVER['REQUEST_METHOD'] == 'GET' || $_SERVER['REQUEST_METHOD'] == 'HEAD')
1006
    && !drupal_is_cli();
Dries's avatar
   
Dries committed
1007
1008
}

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

Dries's avatar
Dries committed
1025
/**
1026
1027
1028
 * Includes a file with the provided type and name.
 *
 * This prevents including a theme, engine, module, etc., more than once.
Dries's avatar
Dries committed
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
 *
 * @param $type
 *   The type of item to load (i.e. theme, theme_engine, module).
 * @param $name
 *   The name of the item to load.
 *
 * @return
 *   TRUE if the item is loaded or has already been loaded.
 */
function drupal_load($type, $name) {
1039
1040
  if ($type == 'module' && Drupal::moduleHandler()->moduleExists($name)) {
    return Drupal::moduleHandler()->load($name);
1041
1042
  }

1043
1044
1045
  // Once a file is included this can't be reversed during a request so do not
  // use drupal_static() here.
  static $files = array();
Dries's avatar
Dries committed
1046

1047
  if (isset($files[$type][$name])) {
Dries's avatar
Dries committed
1048
1049
1050
1051
1052
1053
    return TRUE;
  }

  $filename = drupal_get_filename($type, $name);

  if ($filename) {
1054
    include_once DRUPAL_ROOT . '/' . $filename;
Dries's avatar
Dries committed
1055
1056
1057
1058
1059
1060
1061
1062
    $files[$type][$name] = TRUE;