bootstrap.inc 97.9 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\Url;
10
use Drupal\Core\DrupalKernel;
11
use Drupal\Core\Database\Database;
12
use Drupal\Core\DependencyInjection\ContainerBuilder;
13
use Drupal\Core\Utility\Title;
14
use Drupal\Core\Utility\Error;
15
use Symfony\Component\ClassLoader\ApcClassLoader;
16
use Symfony\Component\DependencyInjection\ContainerInterface;
17
use Symfony\Component\DependencyInjection\Container;
katbailey's avatar
katbailey committed
18
use Symfony\Component\DependencyInjection\Reference;
19
use Symfony\Component\DependencyInjection\Exception\RuntimeException as DependencyInjectionRuntimeException;
20
use Symfony\Component\HttpFoundation\Request;
21
use Symfony\Component\HttpFoundation\Response;
22
use Drupal\Core\Language\Language;
23
24
use Drupal\Core\Lock\DatabaseLockBackend;
use Drupal\Core\Lock\LockBackendInterface;
25
use Drupal\Core\Session\UserSession;
26

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

32
33
34
/**
 * Minimum supported version of PHP.
 */
35
const DRUPAL_MINIMUM_PHP = '5.3.10';
36
37
38
39

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

42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
/**
 * 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';

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

/**
 * Log message severity -- Alert: action must be taken immediately.
 */
90
const WATCHDOG_ALERT = 1;
91
92

/**
93
 * Log message severity -- Critical conditions.
94
 */
95
const WATCHDOG_CRITICAL = 2;
96
97

/**
98
 * Log message severity -- Error conditions.
99
 */
100
const WATCHDOG_ERROR = 3;
101
102

/**
103
 * Log message severity -- Warning conditions.
104
 */
105
const WATCHDOG_WARNING = 4;
106
107

/**
108
 * Log message severity -- Normal but significant conditions.
109
 */
110
const WATCHDOG_NOTICE = 5;
111
112

/**
113
 * Log message severity -- Informational messages.
114
 */
115
const WATCHDOG_INFO = 6;
116
117

/**
118
 * Log message severity -- Debug-level messages.
119
 */
120
const WATCHDOG_DEBUG = 7;
121
122
123
124
125

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

126
127
128
/**
 * First bootstrap phase: initialize configuration.
 */
129
const DRUPAL_BOOTSTRAP_CONFIGURATION = 0;
130
131

/**
132
 * Second bootstrap phase, initalize a kernel.
133
 */
134
const DRUPAL_BOOTSTRAP_KERNEL = 1;
135
136

/**
137
 * Third bootstrap phase: try to serve a cached page.
138
 */
139
const DRUPAL_BOOTSTRAP_PAGE_CACHE = 2;
140
141

/**
142
 * Fourth bootstrap phase: initialize the variable system.
143
 */
144
const DRUPAL_BOOTSTRAP_VARIABLES = 3;
145
146

/**
147
 * Fifth bootstrap phase: load code for subsystems and modules.
148
 */
149
const DRUPAL_BOOTSTRAP_CODE = 4;
150
151

/**
152
 * Final bootstrap phase: initialize language, path, theme, and modules.
153
 */
154
const DRUPAL_BOOTSTRAP_FULL = 5;
155

156
157
158
/**
 * Role ID for anonymous users; should match what's in the "role" table.
 */
159
const DRUPAL_ANONYMOUS_RID = 'anonymous';
160
161
162
163

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

166
/**
167
168
169
 * The number of bytes in a kilobyte.
 *
 * For more information, visit http://en.wikipedia.org/wiki/Kilobyte.
170
 */
171
const DRUPAL_KILOBYTE = 1024;
172

173
174
175
176
177
/**
 * The maximum number of characters in a module or theme name.
 */
const DRUPAL_EXTENSION_NAME_MAX_LENGTH = 50;

178
/**
179
 * Time of the current request in seconds elapsed since the Unix Epoch.
180
 *
181
182
183
184
185
186
 * 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
187
 */
188
define('REQUEST_TIME', (int) $_SERVER['REQUEST_TIME']);
189

190
191
/**
 * Flag for drupal_set_title(); text has already been sanitized.
192
193
 *
 * @todo Move to the Title class.
194
 */
195
const PASS_THROUGH = -1;
196

197
198
199
/**
 * Regular expression to match PHP function names.
 *
200
 * @see http://php.net/manual/language.functions.php
201
 */
202
const DRUPAL_PHP_FUNCTION_PATTERN = '[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*';
203

204
205
206
/**
 * $config_directories key for active directory.
 *
207
 * @see config_get_config_directory()
208
209
210
211
212
213
 */
const CONFIG_ACTIVE_DIRECTORY = 'active';

/**
 * $config_directories key for staging directory.
 *
214
 * @see config_get_config_directory()
215
216
217
 */
const CONFIG_STAGING_DIRECTORY = 'staging';

218
219
220
221
222
223
224
/**
 * 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
225
/**
226
 * Returns the appropriate configuration directory.
Dries's avatar
   
Dries committed
227
 *
228
229
230
231
 * 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.
232
 *
233
 * @param bool $require_settings
234
235
236
237
 *   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.
238
 * @param bool $reset
239
 *   Force a full search for matching directories even if one had been
240
241
 *   found previously. Defaults to FALSE.
 *
242
243
 * @return
 *   The path of the matching directory.
244
245
 *
 * @see default.settings.php
Dries's avatar
   
Dries committed
246
 */
247
function conf_path($require_settings = TRUE, $reset = FALSE) {
248
  $conf_path = &drupal_static(__FUNCTION__, '');
Dries's avatar
 
Dries committed
249

250
251
  if ($conf_path && !$reset) {
    return $conf_path;
Dries's avatar
Dries committed
252
  }
Dries's avatar
 
Dries committed
253

254
255
  // Check for a simpletest override.
  if ($simpletest_conf_path = _drupal_simpletest_conf_path()) {
256
257
    $conf_path = $simpletest_conf_path;
    return $conf_path;
258
259
260
  }

  // Otherwise, use the normal $conf_path.
261
262
263
264
265
  $script_name = $_SERVER['SCRIPT_NAME'];
  if (!$script_name) {
    $script_name = $_SERVER['SCRIPT_FILENAME'];
  }
  $http_host = $_SERVER['HTTP_HOST'];
266
267
  $conf_path = find_conf_path($http_host, $script_name, $require_settings);
  return $conf_path;
268
269
}

270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
/**
 * 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;
}

314
315
316
/**
 * Finds the appropriate configuration directory for a given host and path.
 *
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 * 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
 *
338
339
340
341
 * @param $http_host
 *   The hostname and optional port number, e.g. "www.example.com" or
 *   "www.example.com:8080".
 * @param $script_name
342
 *   The part of the URL following the hostname, including the leading slash.
343
344
345
 * @param $require_settings
 *   Defaults to TRUE. If TRUE, then only match directories with a
 *   'settings.php' file. Otherwise match any directory.
346
347
348
349
 *
 * @return
 *   The path of the matching configuration directory.
 *
350
351
 * @see default.settings.php
 * @see example.sites.php
352
353
354
 * @see conf_path()
 */
function find_conf_path($http_host, $script_name, $require_settings = TRUE) {
355
356
357
358
  // Determine whether multi-site functionality is enabled.
  if (!file_exists(DRUPAL_ROOT . '/sites/sites.php')) {
    return 'sites/default';
  }
359
360

  $sites = array();
361
  include DRUPAL_ROOT . '/sites/sites.php';
362

363
364
  $uri = explode('/', $script_name);
  $server = explode('.', implode('.', array_reverse(explode(':', rtrim($http_host, '.')))));
Dries's avatar
Dries committed
365
366
367
  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));
368
      if (isset($sites[$dir]) && file_exists(DRUPAL_ROOT . '/sites/' . $sites[$dir])) {
369
370
        $dir = $sites[$dir];
      }
371
372
      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
373
      }
Dries's avatar
 
Dries committed
374
375
    }
  }
376
  return 'sites/default';
Dries's avatar
 
Dries committed
377
378
}

379
/**
380
381
382
383
384
 * 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.
385
386
387
388
 *
 * @return string
 *   The configuration directory path.
 */
389
390
function config_get_config_directory($type = CONFIG_ACTIVE_DIRECTORY) {
  global $config_directories;
391

392
  if (!empty($config_directories[$type])) {
393
    return $config_directories[$type];
394
  }
395
  throw new Exception(format_string('The configuration directory type %type does not exist.', array('%type' => $type)));
396
397
}

398
/**
399
 * Sets appropriate server variables needed for command line scripts to work.
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
 *
 * 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
417
 * some cases; for example, if \Drupal::request()->getClientIP()
418
419
420
 * 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.
421
422
 *
 * @param $variables
423
424
425
426
427
428
 *   (optional) An associative array of variables within
 *   \Drupal::request()->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).
429
430
431
 *
 * @see conf_path()
 * @see request_uri()
432
 * @see \Symfony\Component\HttpFoundation\Request::getClientIP()
433
434
 */
function drupal_override_server_variables($variables = array()) {
435
436
  $request = \Drupal::request();
  $server_vars = $request->server->all();
437
  // Allow the provided URL to override any existing values in $_SERVER.
438
439
  if (isset($variables['url'])) {
    $url = parse_url($variables['url']);
440
    if (isset($url['host'])) {
441
      $server_vars['HTTP_HOST'] = $url['host'];
442
443
    }
    if (isset($url['path'])) {
444
      $server_vars['SCRIPT_NAME'] = $url['path'];
445
    }
446
447
    unset($variables['url']);
  }
448
449
450
  // 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.
451
  $defaults = array(
452
453
    'HTTP_HOST' => 'localhost',
    'SCRIPT_NAME' => NULL,
454
455
456
    'REMOTE_ADDR' => '127.0.0.1',
    'REQUEST_METHOD' => 'GET',
    'SERVER_NAME' => NULL,
457
    'SERVER_SOFTWARE' => NULL,
458
459
460
    'HTTP_USER_AGENT' => NULL,
  );
  // Replace elements of the $_SERVER array, as appropriate.
461
462
463
464
  $request->server->replace($variables + $server_vars + $defaults);

  // @todo remove once conf_path() no longer uses $_SERVER.
  $_SERVER = $request->server->all();
465
466
}

467
/**
468
 * Initializes the PHP environment.
469
 */
470
function drupal_environment_initialize() {
471
472
  if (!isset($_SERVER['HTTP_REFERER'])) {
    $_SERVER['HTTP_REFERER'] = '';
473
  }
474
475
476
  if (!isset($_SERVER['SERVER_PROTOCOL']) || ($_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.0' && $_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.1')) {
    $_SERVER['SERVER_PROTOCOL'] = 'HTTP/1.0';
  }
477

478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
  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'] = '';
493
494
  }

495
496
  // @todo Refactor with the Symfony Request object.
  _current_path(request_path());
497

498
499
  // Enforce E_STRICT, but allow users to set levels not part of E_STRICT.
  error_reporting(E_STRICT | E_ALL | error_reporting());
500

501
502
503
  // 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.
504

Dave Reid's avatar
Dave Reid committed
505
506
507
508
509
510
511
  // 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;
  }

512
513
  // Use session cookies, not transparent sessions that puts the session id in
  // the query string.
514
  ini_set('session.use_cookies', '1');
515
  ini_set('session.use_only_cookies', '1');
516
  ini_set('session.use_trans_sid', '0');
517
  // Don't send HTTP headers using PHP's session handler.
518
519
  // Send an empty string to disable the cache limiter.
  ini_set('session.cache_limiter', '');
520
521
  // Use httponly session cookies.
  ini_set('session.cookie_httponly', '1');
522
523
524
525

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

528
/**
529
 * Validates that a hostname (for example $_SERVER['HTTP_HOST']) is safe.
530
531
532
533
 *
 * @return
 *  TRUE if only containing valid characters, or FALSE otherwise.
 */
534
535
function drupal_valid_http_host($host) {
  return preg_match('/^\[?(?:[a-zA-Z0-9-:\]_]+\.?)+$/', $host);
536
537
}

538
/**
539
 * Sets the base URL, cookie domain, and session name from configuration.
540
 */
541
function drupal_settings_initialize() {
542
  global $base_url, $base_path, $base_root, $script_path;
543

544
  // Export these settings.php variables to the global namespace.
545
  global $databases, $cookie_domain, $conf, $db_prefix, $drupal_hash_salt, $base_secure_url, $base_insecure_url, $config_directories;
Dries's avatar
Dries committed
546
547
  $conf = array();

548
549
  // Make conf_path() available as local variable in settings.php.
  $conf_path = conf_path();
550
  if (is_readable(DRUPAL_ROOT . '/' . $conf_path . '/settings.php')) {
551
    include_once DRUPAL_ROOT . '/' . $conf_path . '/settings.php';
552
  }
553

554
  new Settings(isset($settings) ? $settings : array());
555
  $is_https = isset($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) == 'on';
556
557
558
559

  if (isset($base_url)) {
    // Parse fixed base URL from settings.php.
    $parts = parse_url($base_url);
560
561
562
    if (!isset($parts['path'])) {
      $parts['path'] = '';
    }
563
    $base_path = $parts['path'] . '/';
564
565
566
567
568
    // 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
569
    $http_protocol = $is_https ? 'https' : 'http';
570
    $base_root = $http_protocol . '://' . $_SERVER['HTTP_HOST'];
571

572
    $base_url = $base_root;
573

574
575
    // For a request URI of '/index.php/foo', $_SERVER['SCRIPT_NAME'] is
    // '/index.php', whereas $_SERVER['PHP_SELF'] is '/index.php/foo'.
576
    if ($dir = rtrim(dirname($_SERVER['SCRIPT_NAME']), '\/')) {
577
      // Remove "core" directory if present, allowing install.php, update.php,
578
      // and others to auto-detect a base path.
579
580
581
582
583
584
585
      $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;
      }
586
587
588
589
590
591
592
      $base_url .= $base_path;
      $base_path .= '/';
    }
    else {
      $base_path = '/';
    }
  }
593
594
  $base_secure_url = str_replace('http://', 'https://', $base_url);
  $base_insecure_url = str_replace('https://', 'http://', $base_url);
595

596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
  // 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 = '';
      }
    }
  }

622
623
624
625
626
  if ($cookie_domain) {
    // If the user specifies the cookie domain, also use it for session name.
    $session_name = $cookie_domain;
  }
  else {
627
    // Otherwise use $base_url as session name, without the protocol
628
    // to use the same session identifiers across HTTP and HTTPS.
629
    list( , $session_name) = explode('://', $base_url, 2);
630
631
    // HTTP_HOST can be modified by a visitor, but we already sanitized it
    // in drupal_settings_initialize().
632
    if (!empty($_SERVER['HTTP_HOST'])) {
633
      $cookie_domain = $_SERVER['HTTP_HOST'];
634
635
636
637
638
639
640
      // 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];
641
642
643
644
645
646
647
    }
  }
  // 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);
  }
648
649
650
651
652
653
654
655
656
657
  // 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';
658
  session_name($prefix . substr(hash('sha256', $session_name), 0, 32));
659
660
}

Dries's avatar
Dries committed
661
/**
662
663
664
665
 * 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
666
 *
Dries's avatar
Dries committed
667
668
 * 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
669
 * configuration. For example, a module 'foo' may legally be located
Dries's avatar
Dries committed
670
671
 * in any of these three places:
 *
672
 * core/modules/foo/foo.module
Dries's avatar
Dries committed
673
674
675
676
677
678
 * 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
679
 * @param $type
680
 *   The type of the item (theme, theme_engine, module, profile).
Dries's avatar
Dries committed
681
682
683
684
685
686
687
 * @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
688
 *   The filename of the requested item or NULL if the item is not found.
Dries's avatar
Dries committed
689
 */
Dries's avatar
Dries committed
690
function drupal_get_filename($type, $name, $filename = NULL) {
691
692
  // The location of files will not change during the request, so do not use
  // drupal_static().
693
  static $files = array(), $dirs = array();
Dries's avatar
Dries committed
694

695
696
697
  // Profiles are converted into modules in system_rebuild_module_data().
  // @todo Remove false-exposure of profiles as modules.
  $original_type = $type;
698
  if ($type == 'profile') {
699
    $type = 'module';
700
  }
701
  if (!isset($files[$type])) {
Dries's avatar
Dries committed
702
703
704
    $files[$type] = array();
  }

705
  if (!empty($filename)) {
Dries's avatar
Dries committed
706
707
    $files[$type][$name] = $filename;
  }
708
  elseif (isset($files[$type][$name])) {
Dries's avatar
Dries committed
709
710
711
    // nothing
  }
  else {
712
713
714
    // 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.
715
    if (($container = \Drupal::getContainer()) && $container->has('keyvalue') && function_exists('db_query')) {
716
717
      if ($type == 'module') {
        if (empty($files[$type])) {
718
          $files[$type] = \Drupal::moduleHandler()->getModuleList();
719
720
721
722
723
        }
        if (isset($files[$type][$name])) {
          return $files[$type][$name];
        }
      }
724
      try {
725
        $file_list = \Drupal::state()->get('system.' . $type . '.files');
726
727
        if ($file_list && isset($file_list[$name]) && file_exists(DRUPAL_ROOT . '/' . $file_list[$name])) {
          $files[$type][$name] = $file_list[$name];
728
        }
729
      }
730
731
732
733
734
      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.
      }
735
736
737
738
    }
    // 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])) {
739
      // We have consistent directory naming: modules, themes...
740
741
742
      $dir = $type . 's';
      if ($type == 'theme_engine') {
        $dir = 'themes/engines';
743
        $extension = 'engine';
744
745
      }
      elseif ($type == 'theme') {
746
        $extension = 'info.yml';
747
      }
748
749
750
751
752
753
      // 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';
      }
754
      else {
755
        $extension = $type;
756
757
      }

758
759
760
      if (!isset($dirs[$dir][$extension])) {
        $dirs[$dir][$extension] = TRUE;
        if (!function_exists('drupal_system_listing')) {
761
          require_once __DIR__ . '/common.inc';
762
763
764
765
766
        }
        // 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.
767
        $matches = drupal_system_listing("/^" . DRUPAL_PHP_FUNCTION_PATTERN . "\.$extension$/", $dir);
768
769
770
        foreach ($matches as $matched_name => $file) {
          $files[$type][$matched_name] = $file->uri;
        }
Dries's avatar
Dries committed
771
772
773
774
      }
    }
  }

775
776
777
  if (isset($files[$type][$name])) {
    return $files[$type][$name];
  }
Dries's avatar
Dries committed
778
779
}

780
781
782
783
784
785
786
787
788
789
790
/**
 * 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() {
791
  return Settings::getSingleton();
792
793
}

Dries's avatar
   
Dries committed
794
/**
795
 * Loads the persistent variable table.
Dries's avatar
   
Dries committed
796
797
 *
 * The variable table is composed of values that have been saved in the table
798
799
 * with variable_set() as well as those explicitly specified in the
 * configuration file.
Dries's avatar
   
Dries committed
800
 */
801
function variable_initialize($conf = array()) {
802
803
  // NOTE: caching the variables improves performance by 20% when serving
  // cached pages.
804
  if ($cached = cache('bootstrap')->get('variables')) {
805
    $variables = $cached->data;
Dries's avatar
   
Dries committed
806
807
  }
  else {
808
809
    // Cache miss. Avoid a stampede.
    $name = 'variable_init';
810
    $lock = \Drupal::lock();
811
    if (!$lock->acquire($name, 1)) {
812
813
      // Another request is building the variable cache.
      // Wait, then re-run this function.
814
      $lock->wait($name);
815
816
817
818
819
      return variable_initialize($conf);
    }
    else {
      // Proceed with variable rebuild.
      $variables = array_map('unserialize', db_query('SELECT name, value FROM {variable}')->fetchAllKeyed());
820
      cache('bootstrap')->set('variables', $variables);
821
      $lock->release($name);
822
    }
Dries's avatar
   
Dries committed
823
824
825
826
  }

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

Dries's avatar
   
Dries committed
829
  return $variables;
Dries's avatar
 
Dries committed
830
831
}

Dries's avatar
   
Dries committed
832
/**
833
834
835
836
837
 * 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
838
839
840
841
842
 *
 * @param $name
 *   The name of the variable to return.
 * @param $default
 *   The default value to use if this variable has never been set.
843
 *
Dries's avatar
   
Dries committed
844
 * @return
845
 *   The value of the variable. Unserialization is taken care of as necessary.
846
 *
847
848
849
850
 * @deprecated This will be removed in Drupal 8.0. Instead, use the
 *   configuration API.
 *
 * @see \Drupal\Core\Config::get()
Dries's avatar
   
Dries committed
851
 */
852
function variable_get($name, $default = NULL) {
Dries's avatar
 
Dries committed
853
854
855
856
857
  global $conf;

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

Dries's avatar
   
Dries committed
858
/**
859
860
861
862
863
 * 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
864
865
866
867
868
869
 *
 * @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.
870
 *
871
872
873
874
 * @deprecated This will be removed in Drupal 8.0. Instead, use the
 *   configuration API.
 *
 * @see \Drupal\Core\Config::set()
Dries's avatar
   
Dries committed
875
 */
Dries's avatar
 
Dries committed
876
877
878
function variable_set($name, $value) {
  global $conf;

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

881
  cache('bootstrap')->delete('variables');
Dries's avatar
 
Dries committed
882
883
884
885

  $conf[$name] = $value;
}

Dries's avatar
   
Dries committed
886
/**
887
888
889
890
891
 * 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
892
893
894
 *
 * @param $name
 *   The name of the variable to undefine.
895
 *
896
897
898
899
 * @deprecated This will be removed in Drupal 8.0. Instead, use the
 *   configuration API.
 *
 * @see \Drupal\Core\Config::clear()
Dries's avatar
   
Dries committed
900
 */
Dries's avatar
 
Dries committed
901
function variable_del($name) {
Dries's avatar
Dries committed
902
903
  global $conf;

904
905
906
  db_delete('variable')
    ->condition('name', $name)
    ->execute();
907
  cache('bootstrap')->delete('variables');
Dries's avatar
 
Dries committed
908

Dries's avatar
Dries committed
909
  unset($conf[$name]);
Dries's avatar
 
Dries committed
910
911
}

912
913
914
915
916
917
918
919
920
921
922
923
/**
 * Gets the page cache cid for this request.
 *
 * @param \Symfony\Component\HttpFoundation\Request $request
 *   The request for this page.
 *
 * @return string
 *   The cid for this request.
 */
function drupal_page_cache_get_cid(Request $request) {
  $cid_parts = array(
    $request->getUri(),
924
    \Drupal::service('content_negotiation')->getContentType($request),
925
926
927
928
  );
  return sha1(implode(':', $cid_parts));
}

Dries's avatar
   
Dries committed
929
/**
930
 * Retrieves the current page from the cache.
Dries's avatar
   
Dries committed
931
 *
932
933
934
935
936
 * 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.
 *
937
938
 * @param \Symfony\Component\HttpFoundation\Request $request
 *   The request for this page.
939
 *
940
 * @return
941
 *   The cache object, if the page was found in the cache, NULL otherwise.
Dries's avatar
   
Dries committed
942
 */
943
function drupal_page_get_cache(Request $request) {
944
  if (drupal_page_is_cacheable()) {
945
    return \Drupal::cache('page')->get(drupal_page_cache_get_cid($request));
946
  }
947
948
949
}

/**
950
 * Determines the cacheability of the current page.
951
952
 *
 * @param $allow_caching
953
954
 *   Set to FALSE if you want to prevent this page to get cached.
 *
955
 * @return
956
 *   TRUE if the current page can be cached, FALSE otherwise.
957
958
959
960
961
 */
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
962
  }
963
964

  return $allow_caching_static && ($_SERVER['REQUEST_METHOD'] == 'GET' || $_SERVER['REQUEST_METHOD'] == 'HEAD')
965
    && !drupal_is_cli();
Dries's avatar
 
Dries committed
966
967
}

Dries's avatar
Dries committed
968
/**
969
970
971
 * 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
972
973
974
975
976
977
978
979
980
981
 *
 * @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) {
982
983
  if ($type == 'module' && \Drupal::moduleHandler()->moduleExists($name)) {
    return \Drupal::moduleHandler()->load($name);
984
985
  }

986
987
988
  // 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
989

990
  if (isset($files[$type][$name])) {
Dries's avatar
Dries committed
991
992
993
994
995
996
    return TRUE;
  }

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

  if ($filename) {
997
    include_once DRUPAL_ROOT . '/' . $filename;
Dries's avatar
Dries committed
998
999
1000
    $files[$type][$name] = TRUE;

    return TRUE;