bootstrap.inc 104 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 15
use Symfony\Component\ClassLoader\ClassLoader;
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
/**
 * The current system version.
 */
35
const VERSION = '8.0-dev';
36 37 38 39

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

161
/**
Dries's avatar
Dries committed
162
 * Sixth bootstrap phase: load code for subsystems and modules.
163
 */
164
const DRUPAL_BOOTSTRAP_CODE = 5;
165 166

/**
167
 * Final bootstrap phase: initialize language, path, theme, and modules.
168
 */
169
const DRUPAL_BOOTSTRAP_FULL = 6;
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 190 191 192
/**
 * The maximum number of characters in a module or theme name.
 */
const DRUPAL_EXTENSION_NAME_MAX_LENGTH = 50;

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

205 206
/**
 * Flag for drupal_set_title(); text has already been sanitized.
207 208
 *
 * @todo Move to the Title class.
209
 */
210
const PASS_THROUGH = -1;
211

212 213 214
/**
 * Regular expression to match PHP function names.
 *
215
 * @see http://php.net/manual/language.functions.php
216
 */
217
const DRUPAL_PHP_FUNCTION_PATTERN = '[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*';
218

219 220 221
/**
 * $config_directories key for active directory.
 *
222
 * @see config_get_config_directory()
223 224 225 226 227 228
 */
const CONFIG_ACTIVE_DIRECTORY = 'active';

/**
 * $config_directories key for staging directory.
 *
229
 * @see config_get_config_directory()
230 231 232
 */
const CONFIG_STAGING_DIRECTORY = 'staging';

233 234 235 236 237 238 239
/**
 * 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
240
/**
241 242
 * @deprecated as of Drupal 8.0.
 * @see \Drupal\Component\Utility\Timer::start
Dries's avatar
 
Dries committed
243 244
 */
function timer_start($name) {
245
  Timer::start($name);
Dries's avatar
 
Dries committed
246 247 248
}

/**
249 250
 * @deprecated as of Drupal 8.0.
 * @see \Drupal\Component\Utility\Timer::read
Dries's avatar
 
Dries committed
251 252
 */
function timer_read($name) {
253
  return Timer::read($name);
Dries's avatar
 
Dries committed
254 255 256
}

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

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

289 290
  if ($conf_path && !$reset) {
    return $conf_path;
Dries's avatar
Dries committed
291
  }
Dries's avatar
 
Dries committed
292

293 294
  // Check for a simpletest override.
  if ($simpletest_conf_path = _drupal_simpletest_conf_path()) {
295 296
    $conf_path = $simpletest_conf_path;
    return $conf_path;
297 298 299
  }

  // Otherwise, use the normal $conf_path.
300 301 302 303 304
  $script_name = $_SERVER['SCRIPT_NAME'];
  if (!$script_name) {
    $script_name = $_SERVER['SCRIPT_FILENAME'];
  }
  $http_host = $_SERVER['HTTP_HOST'];
305 306
  $conf_path = find_conf_path($http_host, $script_name, $require_settings);
  return $conf_path;
307 308
}

309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352
/**
 * 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;
}

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

  $sites = array();
400
  include DRUPAL_ROOT . '/sites/sites.php';
401

402 403
  $uri = explode('/', $script_name);
  $server = explode('.', implode('.', array_reverse(explode(':', rtrim($http_host, '.')))));
Dries's avatar
Dries committed
404 405 406
  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));
407
      if (isset($sites[$dir]) && file_exists(DRUPAL_ROOT . '/sites/' . $sites[$dir])) {
408 409
        $dir = $sites[$dir];
      }
410 411
      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
412
      }
Dries's avatar
 
Dries committed
413 414
    }
  }
415
  return 'sites/default';
Dries's avatar
 
Dries committed
416 417
}

418
/**
419 420 421 422 423
 * 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.
424 425 426 427
 *
 * @return string
 *   The configuration directory path.
 */
428 429
function config_get_config_directory($type = CONFIG_ACTIVE_DIRECTORY) {
  global $config_directories;
430

431
  if (!empty($config_directories[$type])) {
432 433 434 435 436 437 438
    // 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'];
    }
439 440
  }
  else {
441
    throw new Exception(format_string('The configuration directory type %type does not exist.', array('%type' => $type)));
442 443 444 445
  }
  return $path;
}

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

509
/**
510
 * Initializes the PHP environment.
511
 */
512
function drupal_environment_initialize() {
513 514 515
  // Make sure the \Drupal class is available.
  require_once DRUPAL_ROOT . '/core/lib/Drupal.php';

516 517
  if (!isset($_SERVER['HTTP_REFERER'])) {
    $_SERVER['HTTP_REFERER'] = '';
518
  }
519 520 521
  if (!isset($_SERVER['SERVER_PROTOCOL']) || ($_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.0' && $_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.1')) {
    $_SERVER['SERVER_PROTOCOL'] = 'HTTP/1.0';
  }
522

523 524 525 526 527 528 529 530 531 532 533 534 535 536 537
  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'] = '';
538 539
  }

540 541
  // @todo Refactor with the Symfony Request object.
  _current_path(request_path());
542

543 544
  // Enforce E_STRICT, but allow users to set levels not part of E_STRICT.
  error_reporting(E_STRICT | E_ALL | error_reporting());
545

546 547 548
  // 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.
549

Dave Reid's avatar
Dave Reid committed
550 551 552 553 554 555 556
  // 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;
  }

557 558
  // Use session cookies, not transparent sessions that puts the session id in
  // the query string.
559
  ini_set('session.use_cookies', '1');
560
  ini_set('session.use_only_cookies', '1');
561
  ini_set('session.use_trans_sid', '0');
562
  // Don't send HTTP headers using PHP's session handler.
563 564
  // Send an empty string to disable the cache limiter.
  ini_set('session.cache_limiter', '');
565 566
  // Use httponly session cookies.
  ini_set('session.cookie_httponly', '1');
567 568 569 570

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

573
/**
574
 * Validates that a hostname (for example $_SERVER['HTTP_HOST']) is safe.
575 576 577 578
 *
 * @return
 *  TRUE if only containing valid characters, or FALSE otherwise.
 */
579 580
function drupal_valid_http_host($host) {
  return preg_match('/^\[?(?:[a-zA-Z0-9-:\]_]+\.?)+$/', $host);
581 582
}

583
/**
584
 * Sets the base URL, cookie domain, and session name from configuration.
585
 */
586
function drupal_settings_initialize() {
587
  global $base_url, $base_path, $base_root, $script_path;
588

589
  // Export these settings.php variables to the global namespace.
590
  global $databases, $cookie_domain, $conf, $db_prefix, $drupal_hash_salt, $base_secure_url, $base_insecure_url, $config_directories;
Dries's avatar
Dries committed
591 592
  $conf = array();

593 594
  // Make conf_path() available as local variable in settings.php.
  $conf_path = conf_path();
595
  if (is_readable(DRUPAL_ROOT . '/' . $conf_path . '/settings.php')) {
596
    include_once DRUPAL_ROOT . '/' . $conf_path . '/settings.php';
597
  }
598 599
  require_once DRUPAL_ROOT . '/core/lib/Drupal/Component/Utility/Settings.php';
  new Settings(isset($settings) ? $settings : array());
600
  $is_https = isset($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) == 'on';
601 602 603 604

  if (isset($base_url)) {
    // Parse fixed base URL from settings.php.
    $parts = parse_url($base_url);
605 606 607
    if (!isset($parts['path'])) {
      $parts['path'] = '';
    }
608
    $base_path = $parts['path'] . '/';
609 610 611 612 613
    // 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
614
    $http_protocol = $is_https ? 'https' : 'http';
615
    $base_root = $http_protocol . '://' . $_SERVER['HTTP_HOST'];
616

617
    $base_url = $base_root;
618

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

641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666
  // 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 = '';
      }
    }
  }

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

Dries's avatar
Dries committed
706
/**
707 708 709 710
 * 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
711
 *
Dries's avatar
Dries committed
712 713
 * 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
714
 * configuration. For example, a module 'foo' may legally be located
Dries's avatar
Dries committed
715 716
 * in any of these three places:
 *
717
 * core/modules/foo/foo.module
Dries's avatar
Dries committed
718 719 720 721 722 723
 * 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
724
 * @param $type
725
 *   The type of the item (theme, theme_engine, module, profile).
Dries's avatar
Dries committed
726 727 728 729 730 731 732
 * @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
733
 *   The filename of the requested item or NULL if the item is not found.
Dries's avatar
Dries committed
734
 */
Dries's avatar
Dries committed
735
function drupal_get_filename($type, $name, $filename = NULL) {
736 737
  // The location of files will not change during the request, so do not use
  // drupal_static().
738
  static $files = array(), $dirs = array();
Dries's avatar
Dries committed
739

740 741 742
  // Profiles are converted into modules in system_rebuild_module_data().
  // @todo Remove false-exposure of profiles as modules.
  $original_type = $type;
743
  if ($type == 'profile') {
744
    $type = 'module';
745
  }
746
  if (!isset($files[$type])) {
Dries's avatar
Dries committed
747 748 749
    $files[$type] = array();
  }

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

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

820 821 822
  if (isset($files[$type][$name])) {
    return $files[$type][$name];
  }
Dries's avatar
Dries committed
823 824
}

825 826 827 828 829 830 831 832 833 834 835
/**
 * 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() {
836
  return Settings::getSingleton();
837 838
}

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

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

Dries's avatar
 
Dries committed
874
  return $variables;
Dries's avatar
 
Dries committed
875 876
}

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

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

Dries's avatar
 
Dries committed
901
/**
902 903 904 905 906
 * 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