bootstrap.inc 89.2 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.4.2';
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: load code for subsystems and modules.
143
 */
144
const DRUPAL_BOOTSTRAP_CODE = 3;
145 146

/**
147
 * Final bootstrap phase: initialize language, path, theme, and modules.
148
 */
149
const DRUPAL_BOOTSTRAP_FULL = 4;
150

151 152 153
/**
 * Role ID for anonymous users; should match what's in the "role" table.
 */
154
const DRUPAL_ANONYMOUS_RID = 'anonymous';
155 156 157 158

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

161
/**
162 163 164
 * The number of bytes in a kilobyte.
 *
 * For more information, visit http://en.wikipedia.org/wiki/Kilobyte.
165
 */
166
const DRUPAL_KILOBYTE = 1024;
167

168 169 170 171 172
/**
 * The maximum number of characters in a module or theme name.
 */
const DRUPAL_EXTENSION_NAME_MAX_LENGTH = 50;

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

185 186
/**
 * Flag for drupal_set_title(); text has already been sanitized.
187 188
 *
 * @todo Move to the Title class.
189
 */
190
const PASS_THROUGH = -1;
191

192 193 194
/**
 * Regular expression to match PHP function names.
 *
195
 * @see http://php.net/manual/language.functions.php
196
 */
197
const DRUPAL_PHP_FUNCTION_PATTERN = '[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*';
198

199 200 201
/**
 * $config_directories key for active directory.
 *
202
 * @see config_get_config_directory()
203 204 205 206 207 208
 */
const CONFIG_ACTIVE_DIRECTORY = 'active';

/**
 * $config_directories key for staging directory.
 *
209
 * @see config_get_config_directory()
210 211 212
 */
const CONFIG_STAGING_DIRECTORY = 'staging';

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

245
  if (isset($conf_path) && !$reset) {
246
    return $conf_path;
Dries's avatar
Dries committed
247
  }
Dries's avatar
 
Dries committed
248

249
  // Check for a simpletest override.
250 251
  if ($test_prefix = drupal_valid_test_ua()) {
    $conf_path = 'sites/simpletest/' . substr($test_prefix, 10);
252
    return $conf_path;
253 254 255
  }

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

/**
 * Finds the appropriate configuration directory for a given host and path.
 *
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288
 * 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
 *
289 290 291 292
 * @param $http_host
 *   The hostname and optional port number, e.g. "www.example.com" or
 *   "www.example.com:8080".
 * @param $script_name
293
 *   The part of the URL following the hostname, including the leading slash.
294 295 296
 * @param $require_settings
 *   Defaults to TRUE. If TRUE, then only match directories with a
 *   'settings.php' file. Otherwise match any directory.
297 298 299 300
 *
 * @return
 *   The path of the matching configuration directory.
 *
301 302
 * @see default.settings.php
 * @see example.sites.php
303 304 305
 * @see conf_path()
 */
function find_conf_path($http_host, $script_name, $require_settings = TRUE) {
306 307 308 309
  // Determine whether multi-site functionality is enabled.
  if (!file_exists(DRUPAL_ROOT . '/sites/sites.php')) {
    return 'sites/default';
  }
310 311

  $sites = array();
312
  include DRUPAL_ROOT . '/sites/sites.php';
313

314 315
  $uri = explode('/', $script_name);
  $server = explode('.', implode('.', array_reverse(explode(':', rtrim($http_host, '.')))));
Dries's avatar
Dries committed
316 317 318
  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));
319
      if (isset($sites[$dir]) && file_exists(DRUPAL_ROOT . '/sites/' . $sites[$dir])) {
320 321
        $dir = $sites[$dir];
      }
322 323
      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
324
      }
Dries's avatar
 
Dries committed
325 326
    }
  }
327
  return 'sites/default';
Dries's avatar
 
Dries committed
328 329
}

330
/**
331 332 333 334 335
 * 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.
336 337 338 339
 *
 * @return string
 *   The configuration directory path.
 */
340 341
function config_get_config_directory($type = CONFIG_ACTIVE_DIRECTORY) {
  global $config_directories;
342

343
  if (!empty($config_directories[$type])) {
344
    return $config_directories[$type];
345
  }
346
  throw new Exception(format_string('The configuration directory type %type does not exist.', array('%type' => $type)));
347 348
}

349
/**
350
 * Sets appropriate server variables needed for command line scripts to work.
351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367
 *
 * 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
368
 * some cases; for example, if \Drupal::request()->getClientIP()
369 370 371
 * 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.
372 373
 *
 * @param $variables
374 375 376 377 378 379
 *   (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).
380 381 382
 *
 * @see conf_path()
 * @see request_uri()
383
 * @see \Symfony\Component\HttpFoundation\Request::getClientIP()
384 385
 */
function drupal_override_server_variables($variables = array()) {
386 387
  $request = \Drupal::request();
  $server_vars = $request->server->all();
388
  // Allow the provided URL to override any existing values in $_SERVER.
389 390
  if (isset($variables['url'])) {
    $url = parse_url($variables['url']);
391
    if (isset($url['host'])) {
392
      $server_vars['HTTP_HOST'] = $url['host'];
393 394
    }
    if (isset($url['path'])) {
395
      $server_vars['SCRIPT_NAME'] = $url['path'];
396
    }
397 398
    unset($variables['url']);
  }
399 400 401
  // 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.
402
  $defaults = array(
403 404
    'HTTP_HOST' => 'localhost',
    'SCRIPT_NAME' => NULL,
405 406 407
    'REMOTE_ADDR' => '127.0.0.1',
    'REQUEST_METHOD' => 'GET',
    'SERVER_NAME' => NULL,
408
    'SERVER_SOFTWARE' => NULL,
409 410 411
    'HTTP_USER_AGENT' => NULL,
  );
  // Replace elements of the $_SERVER array, as appropriate.
412 413 414 415
  $request->server->replace($variables + $server_vars + $defaults);

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

418
/**
419
 * Initializes the PHP environment.
420
 */
421
function drupal_environment_initialize() {
422 423
  if (!isset($_SERVER['HTTP_REFERER'])) {
    $_SERVER['HTTP_REFERER'] = '';
424
  }
425 426 427
  if (!isset($_SERVER['SERVER_PROTOCOL']) || ($_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.0' && $_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.1')) {
    $_SERVER['SERVER_PROTOCOL'] = 'HTTP/1.0';
  }
428

429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
  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'] = '';
444 445
  }

446 447
  // @todo Refactor with the Symfony Request object.
  _current_path(request_path());
448

449 450
  // Enforce E_STRICT, but allow users to set levels not part of E_STRICT.
  error_reporting(E_STRICT | E_ALL | error_reporting());
451

452 453 454
  // 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.
455

456 457
  // Use session cookies, not transparent sessions that puts the session id in
  // the query string.
458
  ini_set('session.use_cookies', '1');
459
  ini_set('session.use_only_cookies', '1');
460
  ini_set('session.use_trans_sid', '0');
461
  // Don't send HTTP headers using PHP's session handler.
462 463
  // Send an empty string to disable the cache limiter.
  ini_set('session.cache_limiter', '');
464 465
  // Use httponly session cookies.
  ini_set('session.cookie_httponly', '1');
466 467 468 469

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

472
/**
473
 * Validates that a hostname (for example $_SERVER['HTTP_HOST']) is safe.
474 475 476 477
 *
 * @return
 *  TRUE if only containing valid characters, or FALSE otherwise.
 */
478 479
function drupal_valid_http_host($host) {
  return preg_match('/^\[?(?:[a-zA-Z0-9-:\]_]+\.?)+$/', $host);
480 481
}

482
/**
483
 * Sets the base URL, cookie domain, and session name from configuration.
484
 */
485
function drupal_settings_initialize() {
486
  // Export these settings.php variables to the global namespace.
487
  global $base_url, $databases, $cookie_domain, $config_directories, $config;
488 489
  $settings = array();
  $config = array();
Dries's avatar
Dries committed
490

491 492
  // Make conf_path() available as local variable in settings.php.
  $conf_path = conf_path();
493
  if (is_readable(DRUPAL_ROOT . '/' . $conf_path . '/settings.php')) {
494
    require DRUPAL_ROOT . '/' . $conf_path . '/settings.php';
495
  }
496 497
  // Initialize Settings.
  new Settings($settings);
498 499 500 501 502 503 504 505 506 507 508 509 510 511
}

/**
 * Initializes global request variables.
 *
 * @todo D8: Eliminate this entirely in favor of Request object.
 */
function _drupal_request_initialize() {
  // Provided by settings.php.
  // @see drupal_settings_initialize()
  global $base_url, $cookie_domain;
  // Set and derived from $base_url by this function.
  global $base_path, $base_root, $script_path;
  global $base_secure_url, $base_insecure_url;
512

513
  $is_https = isset($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) == 'on';
514 515 516 517

  if (isset($base_url)) {
    // Parse fixed base URL from settings.php.
    $parts = parse_url($base_url);
518 519 520
    if (!isset($parts['path'])) {
      $parts['path'] = '';
    }
521
    $base_path = $parts['path'] . '/';
522 523 524 525 526
    // 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
527
    $http_protocol = $is_https ? 'https' : 'http';
528
    $base_root = $http_protocol . '://' . $_SERVER['HTTP_HOST'];
529

530
    $base_url = $base_root;
531

532 533
    // For a request URI of '/index.php/foo', $_SERVER['SCRIPT_NAME'] is
    // '/index.php', whereas $_SERVER['PHP_SELF'] is '/index.php/foo'.
534
    if ($dir = rtrim(dirname($_SERVER['SCRIPT_NAME']), '\/')) {
535
      // Remove "core" directory if present, allowing install.php, update.php,
536
      // and others to auto-detect a base path.
537 538 539 540 541 542 543
      $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;
      }
544 545 546 547 548 549 550
      $base_url .= $base_path;
      $base_path .= '/';
    }
    else {
      $base_path = '/';
    }
  }
551 552
  $base_secure_url = str_replace('http://', 'https://', $base_url);
  $base_insecure_url = str_replace('https://', 'http://', $base_url);
553

554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579
  // 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 = '';
      }
    }
  }

580 581 582 583 584
  if ($cookie_domain) {
    // If the user specifies the cookie domain, also use it for session name.
    $session_name = $cookie_domain;
  }
  else {
585
    // Otherwise use $base_url as session name, without the protocol
586
    // to use the same session identifiers across HTTP and HTTPS.
587
    list( , $session_name) = explode('://', $base_url, 2);
588 589
    // HTTP_HOST can be modified by a visitor, but we already sanitized it
    // in drupal_settings_initialize().
590
    if (!empty($_SERVER['HTTP_HOST'])) {
591
      $cookie_domain = $_SERVER['HTTP_HOST'];
592 593 594 595 596 597 598
      // 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];
599 600 601 602 603 604 605
    }
  }
  // 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);
  }
606 607 608 609 610 611 612 613 614 615
  // 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';
616
  session_name($prefix . substr(hash('sha256', $session_name), 0, 32));
617 618
}

Dries's avatar
Dries committed
619
/**
620 621 622 623
 * 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
624
 *
Dries's avatar
Dries committed
625 626
 * 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
627
 * configuration. For example, a module 'foo' may legally be located
Dries's avatar
Dries committed
628 629
 * in any of these three places:
 *
630
 * core/modules/foo/foo.module
Dries's avatar
Dries committed
631 632 633 634 635 636
 * 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
637
 * @param $type
638
 *   The type of the item (theme, theme_engine, module, profile).
Dries's avatar
Dries committed
639 640 641 642 643 644 645
 * @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
646
 *   The filename of the requested item or NULL if the item is not found.
Dries's avatar
Dries committed
647
 */
Dries's avatar
Dries committed
648
function drupal_get_filename($type, $name, $filename = NULL) {
649 650
  // The location of files will not change during the request, so do not use
  // drupal_static().
651
  static $files = array(), $dirs = array();
Dries's avatar
Dries committed
652

653 654 655
  // Profiles are converted into modules in system_rebuild_module_data().
  // @todo Remove false-exposure of profiles as modules.
  $original_type = $type;
656
  if ($type == 'profile') {
657
    $type = 'module';
658
  }
659
  if (!isset($files[$type])) {
Dries's avatar
Dries committed
660 661 662
    $files[$type] = array();
  }

663
  if (!empty($filename)) {
Dries's avatar
Dries committed
664 665
    $files[$type][$name] = $filename;
  }
666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692
  elseif (isset($files[$type][$name])) {
    // nothing
  }
  else {
    // 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.
    if (\Drupal::hasService('keyvalue') && function_exists('db_query')) {
      if ($type == 'module') {
        if (empty($files[$type])) {
          $files[$type] = \Drupal::moduleHandler()->getModuleList();
        }
        if (isset($files[$type][$name])) {
          return $files[$type][$name];
        }
      }
      try {
        $file_list = \Drupal::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];
        }
      }
      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.
      }
693
    }
694 695
    // Fallback to searching the filesystem if the database could not find the
    // file or the file returned by the database is not found.
696
    if (!isset($files[$type][$name])) {
697 698 699 700 701
      // We have consistent directory naming: modules, themes...
      $dir = $type . 's';
      if ($type == 'theme_engine') {
        $dir = 'themes/engines';
        $extension = 'engine';
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
      elseif ($type == 'theme') {
        $extension = 'info.yml';
      }
      // 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';
      }
      else {
        $extension = $type;
      }

      if (!isset($dirs[$dir][$extension])) {
        $dirs[$dir][$extension] = TRUE;
        if (!function_exists('drupal_system_listing')) {
          require_once __DIR__ . '/common.inc';
        }
        // 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.
        $matches = drupal_system_listing("/^" . DRUPAL_PHP_FUNCTION_PATTERN . "\.$extension$/", $dir);
        foreach ($matches as $matched_name => $file) {
          $files[$type][$matched_name] = $file->uri;
        }
Dries's avatar
Dries committed
729 730 731 732
      }
    }
  }

733 734 735
  if (isset($files[$type][$name])) {
    return $files[$type][$name];
  }
Dries's avatar
Dries committed
736 737
}

738 739 740 741 742 743 744 745 746 747 748
/**
 * 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() {
749
  return Settings::getSingleton();
750 751
}

752 753 754 755 756 757 758 759 760 761 762 763
/**
 * 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(),
764
    \Drupal::service('content_negotiation')->getContentType($request),
765 766 767 768
  );
  return sha1(implode(':', $cid_parts));
}

Dries's avatar
 
Dries committed
769
/**
770
 * Retrieves the current page from the cache.
Dries's avatar
 
Dries committed
771
 *
772 773 774 775 776
 * 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.
 *
777 778
 * @param \Symfony\Component\HttpFoundation\Request $request
 *   The request for this page.
779
 *
780
 * @return
781
 *   The cache object, if the page was found in the cache, NULL otherwise.
Dries's avatar
 
Dries committed
782
 */
783
function drupal_page_get_cache(Request $request) {
784
  if (drupal_page_is_cacheable()) {
785
    return \Drupal::cache('page')->get(drupal_page_cache_get_cid($request));
786
  }
787 788 789
}

/**
790
 * Determines the cacheability of the current page.
791 792
 *
 * @param $allow_caching
793 794
 *   Set to FALSE if you want to prevent this page to get cached.
 *
795
 * @return
796
 *   TRUE if the current page can be cached, FALSE otherwise.
797 798 799 800 801
 */
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
802
  }
803 804

  return $allow_caching_static && ($_SERVER['REQUEST_METHOD'] == 'GET' || $_SERVER['REQUEST_METHOD'] == 'HEAD')
805
    && !drupal_is_cli();
Dries's avatar
 
Dries committed
806 807
}

808
/**
809
 * Sets an HTTP response header for the current page.
810 811 812 813 814
 *
 * Note: When sending a Content-Type header, always include a 'charset' type,
 * too. This is necessary to avoid security bugs (e.g. UTF-7 XSS).
 *
 * @param $name
815
 *   The HTTP header name, or the special 'Status' header name.
816
 * @param $value
817 818 819
 *   The HTTP header value; if equal to FALSE, the specified header is unset.
 *   If $name is 'Status', this is expected to be a status code followed by a
 *   reason phrase, e.g. "404 Not Found".
820 821
 * @param $append
 *   Whether to append the value to an existing header or to replace it.
822
 *
823 824 825
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Use \Symfony\Component\HttpFoundation\Response->headers->set().
 *   See https://drupal.org/node/2181523.
826
 */
827
function drupal_add_http_header($name, $value, $append = FALSE) {
828
  // The headers as name/value pairs.
829
  $headers = &drupal_static('drupal_http_headers', array());
830

831
  $name_lower = strtolower($name);
832
  _drupal_set_preferred_header_name($name);
833

834
  if ($value === FALSE) {
835
    $headers[$name_lower] = FALSE;
836
  }
837
  elseif (isset($headers[$name_lower]) && $append) {
838 839
    // Multiple headers with identical names may be combined using comma (RFC
    // 2616, section 4.2).
840
    $headers[$name_lower] .= ',' . $value;
841 842
  }
  else {
843
    $headers[$name_lower] = $value;
844 845 846 847
  }
}

/**
848
 * Gets the HTTP response headers for the current page.
849 850 851 852
 *
 * @param $name
 *   An HTTP header name. If omitted, all headers are returned as name/value
 *   pairs. If an array value is FALSE, the header has been unset.
853
 *
854 855 856
 * @return
 *   A string containing the header value, or FALSE if the header has been set,
 *   or NULL if the header has not been set.
857
 *
858 859 860
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Use \Symfony\Component\HttpFoundation\Response->headers->get().
 *   See https://drupal.org/node/2181523.
861
 */
862
function drupal_get_http_header($name = NULL) {
863
  $headers = &drupal_static('drupal_http_headers', array());
864 865 866 867 868 869 870 871 872 873
  if (isset($name)) {
    $name = strtolower($name);
    return isset($headers[$name]) ? $headers[$name] : NULL;
  }
  else {
    return $headers;
  }
}

/**
874 875
 * Sets the preferred name for the HTTP header.
 *
876
 * Header names are case-insensitive, but for maximum compatibility they should
877 878
 * follow "common form" (see RFC 2616, section 4.2).
 *
879 880
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   See https://drupal.org/node/2181523.
881 882 883 884 885 886 887 888 889 890 891
 */
function _drupal_set_preferred_header_name($name = NULL) {
  static $header_names = array();

  if (!isset($name)) {
    return $header_names;
  }
  $header_names[strtolower($name)] = $name;
}

/**
892 893 894 895
 * Sends the HTTP response headers that were previously set, adding defaults.
 *
 * Headers are set in drupal_add_http_header(). Default headers are not set
 * if they have been replaced or unset using drupal_add_http_header().
896
 *
897 898 899 900 901
 * @param array $default_headers
 *   (optional) An array of headers as name/value pairs.
 * @param bool $only_default
 *   (optional) If TRUE and headers have already been sent, send only the
 *   specified headers.
902
 *