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\String;
6
use Drupal\Component\Utility\Timer;
7
use Drupal\Core\DrupalKernel;
8
use Drupal\Core\Database\Database;
9
use Drupal\Core\DependencyInjection\ContainerBuilder;
10
11
use Symfony\Component\ClassLoader\ClassLoader;
use Symfony\Component\ClassLoader\ApcClassLoader;
12
use Symfony\Component\DependencyInjection\ContainerInterface;
13
use Symfony\Component\DependencyInjection\Container;
katbailey's avatar
katbailey committed
14
use Symfony\Component\DependencyInjection\Reference;
15
use Symfony\Component\DependencyInjection\Exception\RuntimeException as DependencyInjectionRuntimeException;
16
use Symfony\Component\HttpFoundation\Request;
17
use Drupal\Core\Language\Language;
18
19
use Drupal\Core\Lock\DatabaseLockBackend;
use Drupal\Core\Lock\LockBackendInterface;
20
use Drupal\user\Plugin\Core\Entity\User;
21

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

188
/**
189
 * Special system language code (only applicable to UI language).
190
 *
191
192
193
194
 * 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.
195
 */
196
const LANGUAGE_SYSTEM = 'system';
197

198
/**
199
 * The language code used when no language is explicitly assigned (yet).
200
 *
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 * 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';

219
220
221
222
223
224
225
226
/**
 * 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';

227
/**
228
 * The language state when referring to configurable languages.
229
 */
230
231
232
233
234
235
236
237
238
239
240
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;
241

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

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

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

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

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

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

Dave Reid's avatar
Dave Reid committed
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
/**
 * 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;

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

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

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

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

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

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

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

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

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

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

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

391
392
  // Check for a simpletest override.
  if ($simpletest_conf_path = _drupal_simpletest_conf_path()) {
393
394
    $conf_path = $simpletest_conf_path;
    return $conf_path;
395
396
397
  }

  // Otherwise, use the normal $conf_path.
398
399
400
401
402
  $script_name = $_SERVER['SCRIPT_NAME'];
  if (!$script_name) {
    $script_name = $_SERVER['SCRIPT_FILENAME'];
  }
  $http_host = $_SERVER['HTTP_HOST'];
403
404
  $conf_path = find_conf_path($http_host, $script_name, $require_settings);
  return $conf_path;
405
406
}

407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
/**
 * 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;
}

451
452
453
/**
 * Finds the appropriate configuration directory for a given host and path.
 *
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
 * 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
 *
475
476
477
478
 * @param $http_host
 *   The hostname and optional port number, e.g. "www.example.com" or
 *   "www.example.com:8080".
 * @param $script_name
479
 *   The part of the URL following the hostname, including the leading slash.
480
481
482
 * @param $require_settings
 *   Defaults to TRUE. If TRUE, then only match directories with a
 *   'settings.php' file. Otherwise match any directory.
483
484
485
486
 *
 * @return
 *   The path of the matching configuration directory.
 *
487
488
 * @see default.settings.php
 * @see example.sites.php
489
490
491
 * @see conf_path()
 */
function find_conf_path($http_host, $script_name, $require_settings = TRUE) {
492
493
494
495
  // Determine whether multi-site functionality is enabled.
  if (!file_exists(DRUPAL_ROOT . '/sites/sites.php')) {
    return 'sites/default';
  }
496
497

  $sites = array();
498
  include DRUPAL_ROOT . '/sites/sites.php';
499

500
501
  $uri = explode('/', $script_name);
  $server = explode('.', implode('.', array_reverse(explode(':', rtrim($http_host, '.')))));
Dries's avatar
Dries committed
502
503
504
  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));
505
      if (isset($sites[$dir]) && file_exists(DRUPAL_ROOT . '/sites/' . $sites[$dir])) {
506
507
        $dir = $sites[$dir];
      }
508
509
      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
510
      }
Dries's avatar
   
Dries committed
511
512
    }
  }
513
  return 'sites/default';
Dries's avatar
   
Dries committed
514
515
}

516
/**
517
518
519
520
521
 * 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.
522
523
524
525
 *
 * @return string
 *   The configuration directory path.
 */
526
527
function config_get_config_directory($type = CONFIG_ACTIVE_DIRECTORY) {
  global $config_directories;
528

529
  if (!empty($config_directories[$type])) {
530
531
532
533
534
535
536
    // 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'];
    }
537
538
  }
  else {
539
    throw new Exception(format_string('The configuration directory type %type does not exist.', array('%type' => $type)));
540
541
542
543
  }
  return $path;
}

544
/**
545
 * Sets appropriate server variables needed for command line scripts to work.
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
 *
 * 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
563
564
565
566
 * 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.
567
568
569
570
571
572
573
574
575
576
 *
 * @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()
577
 * @see \Symfony\Component\HttpFoundation\Request::getClientIP()
578
579
 */
function drupal_override_server_variables($variables = array()) {
580
  // Allow the provided URL to override any existing values in $_SERVER.
581
582
  if (isset($variables['url'])) {
    $url = parse_url($variables['url']);
583
584
585
586
587
588
    if (isset($url['host'])) {
      $_SERVER['HTTP_HOST'] = $url['host'];
    }
    if (isset($url['path'])) {
      $_SERVER['SCRIPT_NAME'] = $url['path'];
    }
589
590
    unset($variables['url']);
  }
591
592
593
  // 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.
594
  $defaults = array(
595
596
    'HTTP_HOST' => 'localhost',
    'SCRIPT_NAME' => NULL,
597
598
599
    'REMOTE_ADDR' => '127.0.0.1',
    'REQUEST_METHOD' => 'GET',
    'SERVER_NAME' => NULL,
600
    'SERVER_SOFTWARE' => NULL,
601
602
603
604
605
606
    'HTTP_USER_AGENT' => NULL,
  );
  // Replace elements of the $_SERVER array, as appropriate.
  $_SERVER = $variables + $_SERVER + $defaults;
}

607
/**
608
 * Initializes the PHP environment.
609
 */
610
function drupal_environment_initialize() {
611
612
613
  // Make sure the \Drupal class is available.
  require_once DRUPAL_ROOT . '/core/lib/Drupal.php';

614
615
  if (!isset($_SERVER['HTTP_REFERER'])) {
    $_SERVER['HTTP_REFERER'] = '';
616
  }
617
618
619
  if (!isset($_SERVER['SERVER_PROTOCOL']) || ($_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.0' && $_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.1')) {
    $_SERVER['SERVER_PROTOCOL'] = 'HTTP/1.0';
  }
620

621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
  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'] = '';
636
637
  }

638
639
  // @todo Refactor with the Symfony Request object.
  _current_path(request_path());
640

641
642
  // Enforce E_STRICT, but allow users to set levels not part of E_STRICT.
  error_reporting(E_STRICT | E_ALL | error_reporting());
643

644
645
646
  // 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.
647

Dave Reid's avatar
Dave Reid committed
648
649
650
651
652
653
654
  // 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;
  }

655
656
  // Use session cookies, not transparent sessions that puts the session id in
  // the query string.
657
  ini_set('session.use_cookies', '1');
658
  ini_set('session.use_only_cookies', '1');
659
  ini_set('session.use_trans_sid', '0');
660
  // Don't send HTTP headers using PHP's session handler.
661
662
  // Send an empty string to disable the cache limiter.
  ini_set('session.cache_limiter', '');
663
664
  // Use httponly session cookies.
  ini_set('session.cookie_httponly', '1');
665
666
667
668

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

  // Detect string handling method.
  unicode_check();
672
673
}

674
/**
675
 * Validates that a hostname (for example $_SERVER['HTTP_HOST']) is safe.
676
677
678
679
 *
 * @return
 *  TRUE if only containing valid characters, or FALSE otherwise.
 */
680
681
function drupal_valid_http_host($host) {
  return preg_match('/^\[?(?:[a-zA-Z0-9-:\]_]+\.?)+$/', $host);
682
683
}

Dave Reid's avatar
Dave Reid committed
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
/**
 * 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 '';
}

729
/**
730
 * Sets the base URL, cookie domain, and session name from configuration.
731
 */
732
function drupal_settings_initialize() {
733
  global $base_url, $base_path, $base_root, $script_path;
734

735
  // Export these settings.php variables to the global namespace.
736
  global $databases, $cookie_domain, $conf, $db_prefix, $drupal_hash_salt, $is_https, $base_secure_url, $base_insecure_url, $config_directories;
Dries's avatar
Dries committed
737
738
  $conf = array();

739
740
  // Make conf_path() available as local variable in settings.php.
  $conf_path = conf_path();
741
  if (is_readable(DRUPAL_ROOT . '/' . $conf_path . '/settings.php')) {
742
    include_once DRUPAL_ROOT . '/' . $conf_path . '/settings.php';
743
  }
744
745
  require_once DRUPAL_ROOT . '/core/lib/Drupal/Component/Utility/Settings.php';
  new Settings(isset($settings) ? $settings : array());
746
  $is_https = isset($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) == 'on';
747
748
749
750

  if (isset($base_url)) {
    // Parse fixed base URL from settings.php.
    $parts = parse_url($base_url);
751
752
753
    if (!isset($parts['path'])) {
      $parts['path'] = '';
    }
754
    $base_path = $parts['path'] . '/';
755
756
757
758
759
    // 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
760
    $http_protocol = $is_https ? 'https' : 'http';
761
    $base_root = $http_protocol . '://' . $_SERVER['HTTP_HOST'];
762

763
    $base_url = $base_root;
764

765
766
    // For a request URI of '/index.php/foo', $_SERVER['SCRIPT_NAME'] is
    // '/index.php', whereas $_SERVER['PHP_SELF'] is '/index.php/foo'.
767
    if ($dir = rtrim(dirname($_SERVER['SCRIPT_NAME']), '\/')) {
768
      // Remove "core" directory if present, allowing install.php, update.php,
769
      // and others to auto-detect a base path.
770
771
772
773
774
775
776
      $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;
      }
777
778
779
780
781
782
783
      $base_url .= $base_path;
      $base_path .= '/';
    }
    else {
      $base_path = '/';
    }
  }
784
785
  $base_secure_url = str_replace('http://', 'https://', $base_url);
  $base_insecure_url = str_replace('https://', 'http://', $base_url);
786

787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
  // 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 = '';
      }
    }
  }

813
814
815
816
817
  if ($cookie_domain) {
    // If the user specifies the cookie domain, also use it for session name.
    $session_name = $cookie_domain;
  }
  else {
818
    // Otherwise use $base_url as session name, without the protocol
819
    // to use the same session identifiers across HTTP and HTTPS.
820
    list( , $session_name) = explode('://', $base_url, 2);
821
822
    // HTTP_HOST can be modified by a visitor, but we already sanitized it
    // in drupal_settings_initialize().
823
    if (!empty($_SERVER['HTTP_HOST'])) {
824
      $cookie_domain = $_SERVER['HTTP_HOST'];
825
826
827
828
829
830
831
      // 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];
832
833
834
835
836
837
838
    }
  }
  // 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);
  }
839
840
841
842
843
844
845
846
847
848
  // 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';
849
  session_name($prefix . substr(hash('sha256', $session_name), 0, 32));
850
851
}

Dries's avatar
Dries committed
852
/**
853
854
855
856
 * 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
857
 *
Dries's avatar
Dries committed
858
859
860
861
862
 * 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:
 *
863
 * core/modules/foo/foo.module
Dries's avatar
Dries committed
864
865
866
867
868
869
 * 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
870
 * @param $type
871
 *   The type of the item (i.e. theme, theme_engine, module, profile).
Dries's avatar
Dries committed
872
873
874
875
876
877
878
 * @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
879
 *   The filename of the requested item or NULL if the item is not found.
Dries's avatar
Dries committed
880
 */
Dries's avatar
Dries committed
881
function drupal_get_filename($type, $name, $filename = NULL) {
882
883
  // The location of files will not change during the request, so do not use
  // drupal_static().
884
  static $files = array(), $dirs = array();
Dries's avatar
Dries committed
885

886
887
888
  // Profiles are converted into modules in system_rebuild_module_data().
  // @todo Remove false-exposure of profiles as modules.
  $original_type = $type;
889
  if ($type == 'profile') {
890
    $type = 'module';
891
  }
892
  if (!isset($files[$type])) {
Dries's avatar
Dries committed
893
894
895
    $files[$type] = array();
  }

896
  if (!empty($filename) && file_exists($filename)) {
Dries's avatar
Dries committed
897
898
    $files[$type][$name] = $filename;
  }
899
  elseif (isset($files[$type][$name])) {
Dries's avatar
Dries committed
900
901
902
    // nothing
  }
  else {
903
904
905
    // 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.
906
    if (($container = drupal_container()) && $container->has('keyvalue') && function_exists('db_query')) {
907
908
909
910
911
912
913
914
      if ($type == 'module') {
        if (empty($files[$type])) {
          $files[$type] = drupal_container()->get('module_handler')->getModuleList();
        }
        if (isset($files[$type][$name])) {
          return $files[$type][$name];
        }
      }
915
916
917
918
      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];
919
        }
920
      }
921
922
923
924
925
      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.
      }
926
927
928
929
    }
    // 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])) {
930
      // We have consistent directory naming: modules, themes...
931
932
933
      $dir = $type . 's';
      if ($type == 'theme_engine') {
        $dir = 'themes/engines';
934
        $extension = 'engine';
935
936
      }
      elseif ($type == 'theme') {
937
        $extension = 'info.yml';
938
      }
939
940
941
942
943
944
      // 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';
      }
945
      else {
946
        $extension = $type;
947
948
      }

949
950
951
      if (!isset($dirs[$dir][$extension])) {
        $dirs[$dir][$extension] = TRUE;
        if (!function_exists('drupal_system_listing')) {
952
          require_once DRUPAL_ROOT . '/core/includes/common.inc';
953
954
955
956
957
        }
        // 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.
958
        $matches = drupal_system_listing("/^" . DRUPAL_PHP_FUNCTION_PATTERN . "\.$extension$/", $dir);
959
960
961
        foreach ($matches as $matched_name => $file) {
          $files[$type][$matched_name] = $file->uri;
        }
Dries's avatar
Dries committed
962
963
964
965
      }
    }
  }

966
967
968
  if (isset($files[$type][$name])) {
    return $files[$type][$name];
  }
Dries's avatar
Dries committed
969
970
}

971
972
973
974
975
976
977
978
979
980
981
/**
 * 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() {
982
  return Settings::getSingleton();
983
984
}

Dries's avatar
   
Dries committed
985
/**
986
 * Loads the persistent variable table.
Dries's avatar
   
Dries committed
987
988
 *
 * The variable table is composed of values that have been saved in the table
989
990
 * with variable_set() as well as those explicitly specified in the
 * configuration file.
Dries's avatar
   
Dries committed
991
 */
992
function variable_initialize($conf = array()) {
993
994
  // NOTE: caching the variables improves performance by 20% when serving
  // cached pages.
995
  if ($cached = cache('bootstrap')->get('variables')) {
996
    $variables = $cached->data;
Dries's avatar
   
Dries committed
997
998
  }
  else {
999
1000
    // Cache miss. Avoid a stampede.
    $name = 'variable_init';
1001
1002
    $lock = Drupal::lock();
    if (!$lock->acquire($name, 1)) {
1003
1004
      // Another request is building the variable cache.
      // Wait, then re-run this function.
1005
      $lock->wait($name);
1006
1007
1008
1009
1010
      return variable_initialize($conf);
    }
    else {
      // Proceed with variable rebuild.
      $variables = array_map('unserialize', db_query('SELECT name, value FROM {variable}')->fetchAllKeyed());
1011
      cache('bootstrap')->set('variables', $variables);
1012
      $lock->release($name);
1013
    }
Dries's avatar
   
Dries committed
1014
1015
1016
1017
  }

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

Dries's avatar
   
Dries committed
1020
  return $variables;
Dries's avatar
   
Dries committed
1021
1022
}

Dries's avatar
   
Dries committed
1023
/**
1024
1025
1026
1027
1028
 * 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
1029
1030
1031
1032
1033
 *
 * @param $name
 *   The name of the variable to return.
 * @param $default
 *   The default value to use if this variable has never been set.
1034
 *
Dries's avatar
   
Dries committed
1035
 * @return
1036
 *   The value of the variable. Unserialization is taken care of as necessary.
1037
 *
1038
1039
 * @see variable_del()
 * @see variable_set()
Dries's avatar
   
Dries committed
1040
 */
1041
function variable_get($name, $default = NULL) {
Dries's avatar
   
Dries committed
1042
1043
1044
1045
1046
  global $conf;

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

Dries's avatar
   
Dries committed
1047
/**
1048
1049
1050
1051
1052
 * 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
1053
1054
1055
1056
1057
1058
 *
 * @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.
1059
 *
1060
1061
 * @see variable_del()
 * @see variable_get()
Dries's avatar
   
Dries committed
1062
 */
Dries's avatar
   
Dries committed
1063
1064
1065
function variable_set($name, $value) {
  global $conf;

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

1068
  cache('bootstrap')->delete('variables');
Dries's avatar
   
Dries committed
1069
1070
1071
1072

  $conf[$name] = $value;
}

Dries's avatar
   
Dries committed
1073
/**
1074
1075
1076
1077
1078
 * 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
1079
1080
1081
 *
 * @param $name
 *   The name of the variable to undefine.
1082
 *
1083
1084
 * @see variable_get()
 * @see variable_set()
Dries's avatar
   
Dries committed
1085
 */
Dries's avatar
   
Dries committed
1086
function variable_del($name) {
Dries's avatar
Dries committed
1087
1088
  global $conf;

1089
1090
1091
  db_delete('variable')
    ->condition('name', $name)
    ->execute();
1092
  cache('bootstrap')->delete('variables');
Dries's avatar
   
Dries committed
1093

Dries's avatar
Dries committed
1094
  unset($conf[$name]);
Dries's avatar
   
Dries committed
1095
1096
}

Dries's avatar
   
Dries committed
1097
/**
1098
 * Retrieves the current page from the cache.
Dries's avatar
   
Dries committed
1099
 *
1100
1101
1102
1103
1104
 * 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.
 *
1105
1106
1107
1108
 * @param $check_only
 *   (optional) Set to TRUE to only return whether a previous call found a
 *   cache entry.
 *
1109
 * @return
1110
 *   The cache object, if the page was found in the cache, NULL otherwise.
Dries's avatar
   
Dries committed
1111
 */