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

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

Dries's avatar
   
Dries committed
21
22
23
24
/**
 * @file
 * Functions that need to be loaded on every Drupal request.
 */
Dries's avatar
   
Dries committed
25

26
27
28
/**
 * The current system version.
 */
29
const VERSION = '8.0-dev';
30
31
32
33

/**
 * Core API compatibility.
 */
34
const DRUPAL_CORE_COMPATIBILITY = '8.x';
35
36
37
38

/**
 * Minimum supported version of PHP.
 */
39
const DRUPAL_MINIMUM_PHP = '5.3.10';
40
41
42
43

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

46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
/**
 * 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';

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

/**
 * Log message severity -- Alert: action must be taken immediately.
 */
94
const WATCHDOG_ALERT = 1;
95
96

/**
97
 * Log message severity -- Critical conditions.
98
 */
99
const WATCHDOG_CRITICAL = 2;
100
101

/**
102
 * Log message severity -- Error conditions.
103
 */
104
const WATCHDOG_ERROR = 3;
105
106

/**
107
 * Log message severity -- Warning conditions.
108
 */
109
const WATCHDOG_WARNING = 4;
110
111

/**
112
 * Log message severity -- Normal but significant conditions.
113
 */
114
const WATCHDOG_NOTICE = 5;
115
116

/**
117
 * Log message severity -- Informational messages.
118
 */
119
const WATCHDOG_INFO = 6;
120
121

/**
122
 * Log message severity -- Debug-level messages.
123
 */
124
const WATCHDOG_DEBUG = 7;
125
126
127
128
129

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

130
131
132
/**
 * First bootstrap phase: initialize configuration.
 */
133
const DRUPAL_BOOTSTRAP_CONFIGURATION = 0;
134
135

/**
136
 * Second bootstrap phase, initalize a kernel.
137
 */
138
const DRUPAL_BOOTSTRAP_KERNEL = 1;
139
140

/**
141
 * Third bootstrap phase: try to serve a cached page.
142
 */
143
const DRUPAL_BOOTSTRAP_PAGE_CACHE = 2;
144
145

/**
146
 * Fourth bootstrap phase: initialize database layer.
147
 */
148
const DRUPAL_BOOTSTRAP_DATABASE = 3;
149
150

/**
151
 * Fifth bootstrap phase: initialize the variable system.
152
 */
153
const DRUPAL_BOOTSTRAP_VARIABLES = 4;
154
155

/**
156
 * Sixth bootstrap phase: initialize session handling.
157
 */
158
const DRUPAL_BOOTSTRAP_SESSION = 5;
159

160
161
162
/**
 * Eighth bootstrap phase: load code for subsystems and modules.
 */
163
const DRUPAL_BOOTSTRAP_CODE = 6;
164
165

/**
166
 * Final bootstrap phase: initialize language, path, theme, and modules.
167
 */
168
const DRUPAL_BOOTSTRAP_FULL = 7;
169

170
171
172
/**
 * Role ID for anonymous users; should match what's in the "role" table.
 */
173
const DRUPAL_ANONYMOUS_RID = 'anonymous';
174
175
176
177

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

180
/**
181
182
183
 * The number of bytes in a kilobyte.
 *
 * For more information, visit http://en.wikipedia.org/wiki/Kilobyte.
184
 */
185
const DRUPAL_KILOBYTE = 1024;
186

187
/**
188
 * Special system language code (only applicable to UI language).
189
 *
190
191
192
193
 * Refers to the language used in Drupal and module/theme source code. Drupal
 * uses the built-in text for English by default, but if configured to allow
 * translation/customization of English, we need to differentiate between the
 * built-in language and the English translation.
194
 */
195
const LANGUAGE_SYSTEM = 'system';
196

197
/**
198
 * The language code used when no language is explicitly assigned (yet).
199
 *
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 * Should be used when language information is not available or cannot be
 * determined. This special language code is useful when we know the data
 * might have linguistic information, but we don't know the language.
 *
 * See http://www.w3.org/International/questions/qa-no-language#undetermined.
 */
const LANGUAGE_NOT_SPECIFIED = 'und';

/**
 * The language code used when the marked object has no linguistic content.
 *
 * Should be used when we explicitly know that the data referred has no
 * linguistic content.
 *
 * See http://www.w3.org/International/questions/qa-no-language#nonlinguistic.
 */
const LANGUAGE_NOT_APPLICABLE = 'zxx';

218
219
220
221
222
223
224
225
/**
 * Language code referring to the default language of data, e.g. of an entity.
 *
 * @todo: Change value to differ from LANGUAGE_NOT_SPECIFIED once field API
 * leverages the property API.
 */
const LANGUAGE_DEFAULT = 'und';

226
/**
227
 * The language state when referring to configurable languages.
228
 */
229
230
231
232
233
234
235
236
237
238
239
const LANGUAGE_CONFIGURABLE = 1;

/**
 * The language state when referring to locked languages.
 */
const LANGUAGE_LOCKED = 2;

/**
 * The language state used when referring to all languages.
 */
const LANGUAGE_ALL = 3;
240

241
242
243
244
245
/**
 * The language state used when referring to the site's default language.
 */
const LANGUAGE_SITE_DEFAULT = 4;

246
/**
247
 * The type of language used to define the content language.
248
 */
249
const LANGUAGE_TYPE_CONTENT = 'language_content';
250
251

/**
252
 * The type of language used to select the user interface.
253
 */
254
const LANGUAGE_TYPE_INTERFACE = 'language_interface';
255
256

/**
257
 * The type of language used for URLs.
258
 */
259
const LANGUAGE_TYPE_URL = 'language_url';
260

261
262
263
/**
 * Language written left to right. Possible value of $language->direction.
 */
264
const LANGUAGE_LTR = 0;
265
266
267
268

/**
 * Language written right to left. Possible value of $language->direction.
 */
269
const LANGUAGE_RTL = 1;
270

Dave Reid's avatar
Dave Reid committed
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
/**
 * Indicates an error during check for PHP unicode support.
 */
const UNICODE_ERROR = -1;

/**
 * Indicates that standard PHP (emulated) unicode support is being used.
 */
const UNICODE_SINGLEBYTE = 0;

/**
 * Indicates that full unicode support with the PHP mbstring extension is being
 * used.
 */
const UNICODE_MULTIBYTE = 1;

287
/**
288
 * Time of the current request in seconds elapsed since the Unix Epoch.
289
 *
290
291
292
293
294
295
 * 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
296
 */
297
define('REQUEST_TIME', (int) $_SERVER['REQUEST_TIME']);
298

299
300
301
/**
 * Flag for drupal_set_title(); text is not sanitized, so run check_plain().
 */
302
const CHECK_PLAIN = 0;
303
304
305
306

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

309
310
311
/**
 * Regular expression to match PHP function names.
 *
312
 * @see http://php.net/manual/language.functions.php
313
 */
314
const DRUPAL_PHP_FUNCTION_PATTERN = '[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*';
315

316
317
318
/**
 * $config_directories key for active directory.
 *
319
 * @see config_get_config_directory()
320
321
322
323
324
325
 */
const CONFIG_ACTIVE_DIRECTORY = 'active';

/**
 * $config_directories key for staging directory.
 *
326
 * @see config_get_config_directory()
327
328
329
 */
const CONFIG_STAGING_DIRECTORY = 'staging';

330
331
332
333
334
335
336
/**
 * 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
337
/**
338
339
 * @deprecated as of Drupal 8.0.
 * @see \Drupal\Component\Utility\Timer::start
Dries's avatar
   
Dries committed
340
341
 */
function timer_start($name) {
342
  Timer::start($name);
Dries's avatar
   
Dries committed
343
344
345
}

/**
346
347
 * @deprecated as of Drupal 8.0.
 * @see \Drupal\Component\Utility\Timer::read
Dries's avatar
   
Dries committed
348
349
 */
function timer_read($name) {
350
  return Timer::read($name);
Dries's avatar
   
Dries committed
351
352
353
}

/**
354
355
 * @deprecated as of Drupal 8.0.
 * @see \Drupal\Component\Utility\Timer::stop
Dries's avatar
   
Dries committed
356
357
 */
function timer_stop($name) {
358
  return Timer::stop($name);
Dries's avatar
   
Dries committed
359
}
360

Dries's avatar
   
Dries committed
361
/**
362
 * Returns the appropriate configuration directory.
Dries's avatar
   
Dries committed
363
 *
364
365
366
367
 * 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.
368
 *
369
 * @param bool $require_settings
370
371
372
373
 *   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.
374
 * @param bool $reset
375
 *   Force a full search for matching directories even if one had been
376
377
 *   found previously. Defaults to FALSE.
 *
378
379
 * @return
 *   The path of the matching directory.
380
381
 *
 * @see default.settings.php
Dries's avatar
   
Dries committed
382
 */
383
function conf_path($require_settings = TRUE, $reset = FALSE) {
384
  $conf = &drupal_static(__FUNCTION__, '');
Dries's avatar
 
Dries committed
385

386
  if ($conf && !$reset) {
Dries's avatar
Dries committed
387
388
    return $conf;
  }
Dries's avatar
 
Dries committed
389

390
391
392
393
394
  $script_name = $_SERVER['SCRIPT_NAME'];
  if (!$script_name) {
    $script_name = $_SERVER['SCRIPT_FILENAME'];
  }
  $http_host = $_SERVER['HTTP_HOST'];
395
  $conf = find_conf_path($http_host, $script_name, $require_settings);
396
397
398
399
400
401
  return $conf;
}

/**
 * Finds the appropriate configuration directory for a given host and path.
 *
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 * 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
 *
423
424
425
426
 * @param $http_host
 *   The hostname and optional port number, e.g. "www.example.com" or
 *   "www.example.com:8080".
 * @param $script_name
427
 *   The part of the URL following the hostname, including the leading slash.
428
429
430
 * @param $require_settings
 *   Defaults to TRUE. If TRUE, then only match directories with a
 *   'settings.php' file. Otherwise match any directory.
431
432
433
434
 *
 * @return
 *   The path of the matching configuration directory.
 *
435
436
 * @see default.settings.php
 * @see example.sites.php
437
438
439
 * @see conf_path()
 */
function find_conf_path($http_host, $script_name, $require_settings = TRUE) {
440
441
442
443
  // Determine whether multi-site functionality is enabled.
  if (!file_exists(DRUPAL_ROOT . '/sites/sites.php')) {
    return 'sites/default';
  }
444
445

  $sites = array();
446
  include DRUPAL_ROOT . '/sites/sites.php';
447

448
449
  $uri = explode('/', $script_name);
  $server = explode('.', implode('.', array_reverse(explode(':', rtrim($http_host, '.')))));
Dries's avatar
Dries committed
450
451
452
  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));
453
      if (isset($sites[$dir]) && file_exists(DRUPAL_ROOT . '/sites/' . $sites[$dir])) {
454
455
        $dir = $sites[$dir];
      }
456
457
      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
458
      }
Dries's avatar
 
Dries committed
459
460
    }
  }
461
  return 'sites/default';
Dries's avatar
 
Dries committed
462
463
}

464
/**
465
466
467
468
469
 * 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.
470
471
472
473
 *
 * @return string
 *   The configuration directory path.
 */
474
475
function config_get_config_directory($type = CONFIG_ACTIVE_DIRECTORY) {
  global $config_directories;
476
477
478

  if ($test_prefix = drupal_valid_test_ua()) {
    // @see Drupal\simpletest\WebTestBase::setUp()
479
480
481
    $path = conf_path() . '/files/simpletest/' . substr($test_prefix, 10) . '/config_' . $type;
  }
  elseif (!empty($config_directories[$type])) {
482
483
484
485
486
487
488
    // 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'];
    }
489
490
  }
  else {
491
    throw new Exception(format_string('The configuration directory type %type does not exist.', array('%type' => $type)));
492
493
494
495
  }
  return $path;
}

496
/**
497
 * Sets appropriate server variables needed for command line scripts to work.
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
 *
 * 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
 * some cases; for example, if Drupal's ip_address() function 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.
 *
 * @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()
 * @see ip_address()
 */
function drupal_override_server_variables($variables = array()) {
531
  // Allow the provided URL to override any existing values in $_SERVER.
532
533
  if (isset($variables['url'])) {
    $url = parse_url($variables['url']);
534
535
536
537
538
539
    if (isset($url['host'])) {
      $_SERVER['HTTP_HOST'] = $url['host'];
    }
    if (isset($url['path'])) {
      $_SERVER['SCRIPT_NAME'] = $url['path'];
    }
540
541
    unset($variables['url']);
  }
542
543
544
  // 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.
545
  $defaults = array(
546
547
    'HTTP_HOST' => 'localhost',
    'SCRIPT_NAME' => NULL,
548
549
550
    'REMOTE_ADDR' => '127.0.0.1',
    'REQUEST_METHOD' => 'GET',
    'SERVER_NAME' => NULL,
551
    'SERVER_SOFTWARE' => NULL,
552
553
554
555
556
557
    'HTTP_USER_AGENT' => NULL,
  );
  // Replace elements of the $_SERVER array, as appropriate.
  $_SERVER = $variables + $_SERVER + $defaults;
}

558
/**
559
 * Initializes the PHP environment.
560
 */
561
function drupal_environment_initialize() {
562
563
564
  // Make sure the \Drupal class is available.
  require_once DRUPAL_ROOT . '/core/lib/Drupal.php';

565
566
  if (!isset($_SERVER['HTTP_REFERER'])) {
    $_SERVER['HTTP_REFERER'] = '';
567
  }
568
569
570
  if (!isset($_SERVER['SERVER_PROTOCOL']) || ($_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.0' && $_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.1')) {
    $_SERVER['SERVER_PROTOCOL'] = 'HTTP/1.0';
  }
571

572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
  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'] = '';
587
588
  }

589
590
  // @todo Refactor with the Symfony Request object.
  _current_path(request_path());
591

592
593
  // Enforce E_STRICT, but allow users to set levels not part of E_STRICT.
  error_reporting(E_STRICT | E_ALL | error_reporting());
594

595
596
597
  // 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.
598

Dave Reid's avatar
Dave Reid committed
599
600
601
602
603
604
605
  // 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;
  }

606
607
  // Use session cookies, not transparent sessions that puts the session id in
  // the query string.
608
  ini_set('session.use_cookies', '1');
609
  ini_set('session.use_only_cookies', '1');
610
  ini_set('session.use_trans_sid', '0');
611
  // Don't send HTTP headers using PHP's session handler.
612
613
  // Send an empty string to disable the cache limiter.
  ini_set('session.cache_limiter', '');
614
615
  // Use httponly session cookies.
  ini_set('session.cookie_httponly', '1');
616
617
618
619

  // Set sane locale settings, to ensure consistent string, dates, times and
  // numbers handling.
  setlocale(LC_ALL, 'C');
Dave Reid's avatar
Dave Reid committed
620
621
622

  // Detect string handling method.
  unicode_check();
623
624
}

625
/**
626
 * Validates that a hostname (for example $_SERVER['HTTP_HOST']) is safe.
627
628
629
630
 *
 * @return
 *  TRUE if only containing valid characters, or FALSE otherwise.
 */
631
632
function drupal_valid_http_host($host) {
  return preg_match('/^\[?(?:[a-zA-Z0-9-:\]_]+\.?)+$/', $host);
633
634
}

Dave Reid's avatar
Dave Reid committed
635
636
637
638
639
640
641
642
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
670
671
672
673
674
675
676
677
678
679
/**
 * Checks for Unicode support in PHP and sets the proper settings if possible.
 *
 * Because Drupal needs to be able to handle text in various encodings, we do
 * not support mbstring function overloading. HTTP input/output conversion must
 * be disabled for similar reasons.
 *
 * @return string
 *   A string identifier of a failed multibyte extension check, if any.
 *   Otherwise, an empty string.
 */
function unicode_check() {
  global $multibyte;

  // Check for mbstring extension.
  if (!function_exists('mb_strlen')) {
    $multibyte = UNICODE_SINGLEBYTE;
    return 'mb_strlen';
  }

  // Check mbstring configuration.
  if (ini_get('mbstring.func_overload') != 0) {
    $multibyte = UNICODE_ERROR;
    return 'mbstring.func_overload';
  }
  if (ini_get('mbstring.encoding_translation') != 0) {
    $multibyte = UNICODE_ERROR;
    return 'mbstring.encoding_translation';
  }
  if (ini_get('mbstring.http_input') != 'pass') {
    $multibyte = UNICODE_ERROR;
    return 'mbstring.http_input';
  }
  if (ini_get('mbstring.http_output') != 'pass') {
    $multibyte = UNICODE_ERROR;
    return 'mbstring.http_output';
  }

  // Set appropriate configuration.
  mb_internal_encoding('utf-8');
  mb_language('uni');
  $multibyte = UNICODE_MULTIBYTE;
  return '';
}

680
/**
681
 * Sets the base URL, cookie domain, and session name from configuration.
682
 */
683
function drupal_settings_initialize() {
684
  global $base_url, $base_path, $base_root, $script_path;
685

686
  // Export these settings.php variables to the global namespace.
687
  global $databases, $cookie_domain, $conf, $installed_profile, $db_prefix, $drupal_hash_salt, $is_https, $base_secure_url, $base_insecure_url, $config_directories;
Dries's avatar
Dries committed
688
689
  $conf = array();

690
691
  // Make conf_path() available as local variable in settings.php.
  $conf_path = conf_path();
692
  if (is_readable(DRUPAL_ROOT . '/' . $conf_path . '/settings.php')) {
693
    include_once DRUPAL_ROOT . '/' . $conf_path . '/settings.php';
694
  }
695
696
  require_once DRUPAL_ROOT . '/core/lib/Drupal/Component/Utility/Settings.php';
  new Settings(isset($settings) ? $settings : array());
697
  $is_https = isset($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) == 'on';
698
699
700
701

  if (isset($base_url)) {
    // Parse fixed base URL from settings.php.
    $parts = parse_url($base_url);
702
703
704
    if (!isset($parts['path'])) {
      $parts['path'] = '';
    }
705
    $base_path = $parts['path'] . '/';
706
707
708
709
710
    // 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
711
    $http_protocol = $is_https ? 'https' : 'http';
712
    $base_root = $http_protocol . '://' . $_SERVER['HTTP_HOST'];
713

714
    $base_url = $base_root;
715

716
717
    // For a request URI of '/index.php/foo', $_SERVER['SCRIPT_NAME'] is
    // '/index.php', whereas $_SERVER['PHP_SELF'] is '/index.php/foo'.
718
    if ($dir = rtrim(dirname($_SERVER['SCRIPT_NAME']), '\/')) {
719
      // Remove "core" directory if present, allowing install.php, update.php,
720
      // and others to auto-detect a base path.
721
722
723
724
725
726
727
      $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;
      }
728
729
730
731
732
733
734
      $base_url .= $base_path;
      $base_path .= '/';
    }
    else {
      $base_path = '/';
    }
  }
735
736
  $base_secure_url = str_replace('http://', 'https://', $base_url);
  $base_insecure_url = str_replace('https://', 'http://', $base_url);
737

738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
  // 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 = '';
      }
    }
  }

764
765
766
767
768
  if ($cookie_domain) {
    // If the user specifies the cookie domain, also use it for session name.
    $session_name = $cookie_domain;
  }
  else {
769
    // Otherwise use $base_url as session name, without the protocol
770
    // to use the same session identifiers across HTTP and HTTPS.
771
    list( , $session_name) = explode('://', $base_url, 2);
772
773
    // HTTP_HOST can be modified by a visitor, but we already sanitized it
    // in drupal_settings_initialize().
774
    if (!empty($_SERVER['HTTP_HOST'])) {
775
      $cookie_domain = $_SERVER['HTTP_HOST'];
776
777
778
779
780
781
782
      // 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];
783
784
785
786
787
788
789
    }
  }
  // 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);
  }
790
791
792
793
794
795
796
797
798
799
  // 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';
800
  session_name($prefix . substr(hash('sha256', $session_name), 0, 32));
801
802
}

Dries's avatar
Dries committed
803
/**
804
805
806
807
 * 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
808
 *
Dries's avatar
Dries committed
809
810
811
812
813
 * 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:
 *
814
 * core/modules/foo/foo.module
Dries's avatar
Dries committed
815
816
817
818
819
820
 * 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
821
 * @param $type
822
 *   The type of the item (i.e. theme, theme_engine, module, profile).
Dries's avatar
Dries committed
823
824
825
826
827
828
829
 * @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
830
 *   The filename of the requested item or NULL if the item is not found.
Dries's avatar
Dries committed
831
 */
Dries's avatar
Dries committed
832
function drupal_get_filename($type, $name, $filename = NULL) {
833
834
  // The location of files will not change during the request, so do not use
  // drupal_static().
835
  static $files = array(), $dirs = array();
Dries's avatar
Dries committed
836

837
838
839
  // Profiles are converted into modules in system_rebuild_module_data().
  // @todo Remove false-exposure of profiles as modules.
  $original_type = $type;
840
  if ($type == 'profile') {
841
    $type = 'module';
842
  }
843
  if (!isset($files[$type])) {
Dries's avatar
Dries committed
844
845
846
    $files[$type] = array();
  }

847
  if (!empty($filename) && file_exists($filename)) {
Dries's avatar
Dries committed
848
849
    $files[$type][$name] = $filename;
  }
850
  elseif (isset($files[$type][$name])) {
Dries's avatar
Dries committed
851
852
853
    // nothing
  }
  else {
854
855
856
    // 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.
857
    if (($container = drupal_container()) && $container->has('keyvalue') && function_exists('db_query')) {
858
859
860
861
862
863
864
865
      if ($type == 'module') {
        if (empty($files[$type])) {
          $files[$type] = drupal_container()->get('module_handler')->getModuleList();
        }
        if (isset($files[$type][$name])) {
          return $files[$type][$name];
        }
      }
866
867
868
869
      try {
        $file_list = state()->get('system.' . $type . '.files');
        if ($file_list && isset($file_list[$name]) && file_exists(DRUPAL_ROOT . '/' . $file_list[$name])) {
          $files[$type][$name] = $file_list[$name];
870
        }
871
      }
872
873
874
875
876
      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.
      }
877
878
879
880
    }
    // 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])) {
881
      // We have consistent directory naming: modules, themes...
882
883
884
      $dir = $type . 's';
      if ($type == 'theme_engine') {
        $dir = 'themes/engines';
885
        $extension = 'engine';
886
887
      }
      elseif ($type == 'theme') {
888
        $extension = 'info.yml';
889
      }
890
891
892
893
894
895
      // 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';
      }
896
      else {
897
        $extension = $type;
898
899
      }

900
901
902
      if (!isset($dirs[$dir][$extension])) {
        $dirs[$dir][$extension] = TRUE;
        if (!function_exists('drupal_system_listing')) {
903
          require_once DRUPAL_ROOT . '/core/includes/common.inc';
904
905
906
907
908
        }
        // 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.
909
        $matches = drupal_system_listing("/^" . DRUPAL_PHP_FUNCTION_PATTERN . "\.$extension$/", $dir);
910
911
912
        foreach ($matches as $matched_name => $file) {
          $files[$type][$matched_name] = $file->uri;
        }
Dries's avatar
Dries committed
913
914
915
916
      }
    }
  }

917
918
919
  if (isset($files[$type][$name])) {
    return $files[$type][$name];
  }
Dries's avatar
Dries committed
920
921
}

922
923
924
925
926
927
928
929
930
931
932
/**
 * 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() {
933
  return Settings::getSingleton();
934
935
}

Dries's avatar
   
Dries committed
936
/**
937
 * Loads the persistent variable table.
Dries's avatar
   
Dries committed
938
939
 *
 * The variable table is composed of values that have been saved in the table
940
941
 * with variable_set() as well as those explicitly specified in the
 * configuration file.
Dries's avatar
   
Dries committed
942
 */
943
function variable_initialize($conf = array()) {
944
945
  // NOTE: caching the variables improves performance by 20% when serving
  // cached pages.
946
  if ($cached = cache('bootstrap')->get('variables')) {
947
    $variables = $cached->data;
Dries's avatar
   
Dries committed
948
949
  }
  else {
950
951
    // Cache miss. Avoid a stampede.
    $name = 'variable_init';
952
953
    $lock = Drupal::lock();
    if (!$lock->acquire($name, 1)) {
954
955
      // Another request is building the variable cache.
      // Wait, then re-run this function.
956
      $lock->wait($name);
957
958
959
960
961
      return variable_initialize($conf);
    }
    else {
      // Proceed with variable rebuild.
      $variables = array_map('unserialize', db_query('SELECT name, value FROM {variable}')->fetchAllKeyed());
962
      cache('bootstrap')->set('variables', $variables);
963
      $lock->release($name);
964
    }
Dries's avatar
   
Dries committed
965
966
967
968
  }

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

Dries's avatar
   
Dries committed
971
  return $variables;
Dries's avatar
 
Dries committed
972
973
}

Dries's avatar
   
Dries committed
974
/**
975
976
977
978
979
 * 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
980
981
982
983
984
 *
 * @param $name
 *   The name of the variable to return.
 * @param $default
 *   The default value to use if this variable has never been set.
985
 *
Dries's avatar
   
Dries committed
986
 * @return
987
 *   The value of the variable. Unserialization is taken care of as necessary.
988
 *
989
990
 * @see variable_del()
 * @see variable_set()
Dries's avatar
   
Dries committed
991
 */
992
function variable_get($name, $default = NULL) {
Dries's avatar
 
Dries committed
993
994
995
996
997
  global $conf;

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

Dries's avatar
   
Dries committed
998
/**
999
1000
1001
1002
1003
 * 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
1004
1005
1006
1007
1008
1009
 *
 * @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.
1010
 *
1011
1012
 * @see variable_del()
 * @see variable_get()
Dries's avatar
   
Dries committed
1013
 */
Dries's avatar
 
Dries committed
1014
1015
1016
function variable_set($name, $value) {
  global $conf;

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

1019
  cache('bootstrap')->delete('variables');
Dries's avatar
 
Dries committed
1020
1021
1022
1023

  $conf[$name] = $value;
}

Dries's avatar
   
Dries committed
1024
/**
1025
1026
1027
1028
1029
 * 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
1030
1031
1032
 *
 * @param $name
 *   The name of the variable to undefine.
1033
 *
1034
1035
 * @see variable_get()
 * @see variable_set()
Dries's avatar
   
Dries committed
1036
 */
Dries's avatar
 
Dries committed
1037
function variable_del($name) {
Dries's avatar
Dries committed
1038
1039
  global $conf;

1040
1041
1042
  db_delete('variable')
    ->condition('name', $name)
    ->execute();
1043
  cache('bootstrap')->delete('variables');
Dries's avatar
 
Dries committed
1044

Dries's avatar
Dries committed
1045
  unset($conf[$name]);
Dries's avatar
 
Dries committed
1046
1047
}

Dries's avatar
   
Dries committed
1048
/**
1049
 * Retrieves the current page from the cache.
Dries's avatar
   
Dries committed
1050
 *
1051
1052
1053
1054
1055
 * 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.
 *
1056
1057
1058
1059
 * @param $check_only
 *   (optional) Set to TRUE to only return whether a previous call found a
 *   cache entry.
 *
1060
 * @return
1061
 *   The cache object, if the page was found in the cache, NULL otherwise.
Dries's avatar
   
Dries committed
1062
 */
1063
function drupal_page_get_cache($check_only = FALSE) {
1064
  global $base_root;