bootstrap.inc 104 KB
Newer Older
1
<?php
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 Symfony\Component\ClassLoader\ApcClassLoader;
15
use Symfony\Component\DependencyInjection\ContainerInterface;
16
use Symfony\Component\DependencyInjection\Container;
katbailey's avatar
katbailey committed
17
use Symfony\Component\DependencyInjection\Reference;
18
use Symfony\Component\DependencyInjection\Exception\RuntimeException as DependencyInjectionRuntimeException;
19
use Symfony\Component\HttpFoundation\Request;
20
use Symfony\Component\HttpFoundation\Response;
21
use Drupal\Core\Language\Language;
22 23
use Drupal\Core\Lock\DatabaseLockBackend;
use Drupal\Core\Lock\LockBackendInterface;
24
use Drupal\Core\Session\UserSession;
25

26 27 28 29
/**
 * @file
 * Functions that need to be loaded on every Drupal request.
 */
30

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

/**
141
 * Fourth bootstrap phase: initialize database layer.
142
 */
143
const DRUPAL_BOOTSTRAP_DATABASE = 3;
144 145

/**
146
 * Fifth bootstrap phase: initialize the variable system.
147
 */
148
const DRUPAL_BOOTSTRAP_VARIABLES = 4;
149

150
/**
151
 * Sixth bootstrap phase: load code for subsystems and modules.
152
 */
153
const DRUPAL_BOOTSTRAP_CODE = 5;
154 155

/**
156
 * Final bootstrap phase: initialize language, path, theme, and modules.
157
 */
158
const DRUPAL_BOOTSTRAP_FULL = 6;
159

160 161 162
/**
 * Role ID for anonymous users; should match what's in the "role" table.
 */
163
const DRUPAL_ANONYMOUS_RID = 'anonymous';
164 165 166 167

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

170
/**
171 172 173
 * The number of bytes in a kilobyte.
 *
 * For more information, visit http://en.wikipedia.org/wiki/Kilobyte.
174
 */
175
const DRUPAL_KILOBYTE = 1024;
176

177 178 179 180 181
/**
 * The maximum number of characters in a module or theme name.
 */
const DRUPAL_EXTENSION_NAME_MAX_LENGTH = 50;

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

194 195
/**
 * Flag for drupal_set_title(); text has already been sanitized.
196 197
 *
 * @todo Move to the Title class.
198
 */
199
const PASS_THROUGH = -1;
200

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

208 209 210
/**
 * $config_directories key for active directory.
 *
211
 * @see config_get_config_directory()
212 213 214 215 216 217
 */
const CONFIG_ACTIVE_DIRECTORY = 'active';

/**
 * $config_directories key for staging directory.
 *
218
 * @see config_get_config_directory()
219 220 221
 */
const CONFIG_STAGING_DIRECTORY = 'staging';

222 223 224 225 226 227 228
/**
 * Defines the root directory of the Drupal installation.
 *
 * This strips two levels of directories off the current directory.
 */
define('DRUPAL_ROOT', dirname(dirname(__DIR__)));

229
/**
230 231
 * @deprecated as of Drupal 8.0.
 * @see \Drupal\Component\Utility\Timer::start
232 233
 */
function timer_start($name) {
234
  Timer::start($name);
235 236 237
}

/**
238 239
 * @deprecated as of Drupal 8.0.
 * @see \Drupal\Component\Utility\Timer::read
240 241
 */
function timer_read($name) {
242
  return Timer::read($name);
243 244 245
}

/**
246 247
 * @deprecated as of Drupal 8.0.
 * @see \Drupal\Component\Utility\Timer::stop
248 249
 */
function timer_stop($name) {
250
  return Timer::stop($name);
251
}
252

253
/**
254
 * Returns the appropriate configuration directory.
255
 *
256 257 258 259
 * 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.
260
 *
261
 * @param bool $require_settings
262 263 264 265
 *   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.
266
 * @param bool $reset
267
 *   Force a full search for matching directories even if one had been
268 269
 *   found previously. Defaults to FALSE.
 *
270 271
 * @return
 *   The path of the matching directory.
272 273
 *
 * @see default.settings.php
274
 */
275
function conf_path($require_settings = TRUE, $reset = FALSE) {
276
  $conf_path = &drupal_static(__FUNCTION__, '');
277

278 279
  if ($conf_path && !$reset) {
    return $conf_path;
280
  }
281

282 283
  // Check for a simpletest override.
  if ($simpletest_conf_path = _drupal_simpletest_conf_path()) {
284 285
    $conf_path = $simpletest_conf_path;
    return $conf_path;
286 287 288
  }

  // Otherwise, use the normal $conf_path.
289 290 291 292 293
  $script_name = $_SERVER['SCRIPT_NAME'];
  if (!$script_name) {
    $script_name = $_SERVER['SCRIPT_FILENAME'];
  }
  $http_host = $_SERVER['HTTP_HOST'];
294 295
  $conf_path = find_conf_path($http_host, $script_name, $require_settings);
  return $conf_path;
296 297
}

298 299 300 301 302 303 304 305 306 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
/**
 * 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;
}

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

  $sites = array();
389
  include DRUPAL_ROOT . '/sites/sites.php';
390

391 392
  $uri = explode('/', $script_name);
  $server = explode('.', implode('.', array_reverse(explode(':', rtrim($http_host, '.')))));
393 394 395
  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));
396
      if (isset($sites[$dir]) && file_exists(DRUPAL_ROOT . '/sites/' . $sites[$dir])) {
397 398
        $dir = $sites[$dir];
      }
399 400
      if (file_exists(DRUPAL_ROOT . '/sites/' . $dir . '/settings.php') || (!$require_settings && file_exists(DRUPAL_ROOT . '/sites/' . $dir))) {
        return "sites/$dir";
401
      }
402 403
    }
  }
404
  return 'sites/default';
405 406
}

407
/**
408 409 410 411 412
 * 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.
413 414 415 416
 *
 * @return string
 *   The configuration directory path.
 */
417 418
function config_get_config_directory($type = CONFIG_ACTIVE_DIRECTORY) {
  global $config_directories;
419

420
  if (!empty($config_directories[$type])) {
421 422 423 424 425 426 427
    // 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'];
    }
428 429
  }
  else {
430
    throw new Exception(format_string('The configuration directory type %type does not exist.', array('%type' => $type)));
431 432 433 434
  }
  return $path;
}

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

498
/**
499
 * Initializes the PHP environment.
500
 */
501
function drupal_environment_initialize() {
502 503
  if (!isset($_SERVER['HTTP_REFERER'])) {
    $_SERVER['HTTP_REFERER'] = '';
504
  }
505 506 507
  if (!isset($_SERVER['SERVER_PROTOCOL']) || ($_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.0' && $_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.1')) {
    $_SERVER['SERVER_PROTOCOL'] = 'HTTP/1.0';
  }
508

509 510 511 512 513 514 515 516 517 518 519 520 521 522 523
  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'] = '';
524 525
  }

526 527
  // @todo Refactor with the Symfony Request object.
  _current_path(request_path());
528

529 530
  // Enforce E_STRICT, but allow users to set levels not part of E_STRICT.
  error_reporting(E_STRICT | E_ALL | error_reporting());
531

532 533 534
  // 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.
535

536 537 538 539 540 541 542
  // 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;
  }

543 544
  // Use session cookies, not transparent sessions that puts the session id in
  // the query string.
545
  ini_set('session.use_cookies', '1');
546
  ini_set('session.use_only_cookies', '1');
547
  ini_set('session.use_trans_sid', '0');
548
  // Don't send HTTP headers using PHP's session handler.
549 550
  // Send an empty string to disable the cache limiter.
  ini_set('session.cache_limiter', '');
551 552
  // Use httponly session cookies.
  ini_set('session.cookie_httponly', '1');
553 554 555 556

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

559
/**
560
 * Validates that a hostname (for example $_SERVER['HTTP_HOST']) is safe.
561 562 563 564
 *
 * @return
 *  TRUE if only containing valid characters, or FALSE otherwise.
 */
565 566
function drupal_valid_http_host($host) {
  return preg_match('/^\[?(?:[a-zA-Z0-9-:\]_]+\.?)+$/', $host);
567 568
}

569
/**
570
 * Sets the base URL, cookie domain, and session name from configuration.
571
 */
572
function drupal_settings_initialize() {
573
  global $base_url, $base_path, $base_root, $script_path;
574

575
  // Export these settings.php variables to the global namespace.
576
  global $databases, $cookie_domain, $conf, $db_prefix, $drupal_hash_salt, $base_secure_url, $base_insecure_url, $config_directories;
Dries's avatar
Dries committed
577 578
  $conf = array();

579 580
  // Make conf_path() available as local variable in settings.php.
  $conf_path = conf_path();
581
  if (is_readable(DRUPAL_ROOT . '/' . $conf_path . '/settings.php')) {
582
    include_once DRUPAL_ROOT . '/' . $conf_path . '/settings.php';
583
  }
584 585
  require_once __DIR__ . '../../lib/Drupal/Component/Utility/Settings.php';

586
  new Settings(isset($settings) ? $settings : array());
587
  $is_https = isset($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) == 'on';
588 589 590 591

  if (isset($base_url)) {
    // Parse fixed base URL from settings.php.
    $parts = parse_url($base_url);
592 593 594
    if (!isset($parts['path'])) {
      $parts['path'] = '';
    }
595
    $base_path = $parts['path'] . '/';
596 597 598 599 600
    // 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
601
    $http_protocol = $is_https ? 'https' : 'http';
602
    $base_root = $http_protocol . '://' . $_SERVER['HTTP_HOST'];
603

604
    $base_url = $base_root;
605

606 607
    // For a request URI of '/index.php/foo', $_SERVER['SCRIPT_NAME'] is
    // '/index.php', whereas $_SERVER['PHP_SELF'] is '/index.php/foo'.
608
    if ($dir = rtrim(dirname($_SERVER['SCRIPT_NAME']), '\/')) {
609
      // Remove "core" directory if present, allowing install.php, update.php,
610
      // and others to auto-detect a base path.
611 612 613 614 615 616 617
      $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;
      }
618 619 620 621 622 623 624
      $base_url .= $base_path;
      $base_path .= '/';
    }
    else {
      $base_path = '/';
    }
  }
625 626
  $base_secure_url = str_replace('http://', 'https://', $base_url);
  $base_insecure_url = str_replace('https://', 'http://', $base_url);
627

628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653
  // 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 = '';
      }
    }
  }

654 655 656 657 658
  if ($cookie_domain) {
    // If the user specifies the cookie domain, also use it for session name.
    $session_name = $cookie_domain;
  }
  else {
659
    // Otherwise use $base_url as session name, without the protocol
660
    // to use the same session identifiers across HTTP and HTTPS.
661
    list( , $session_name) = explode('://', $base_url, 2);
662 663
    // HTTP_HOST can be modified by a visitor, but we already sanitized it
    // in drupal_settings_initialize().
664
    if (!empty($_SERVER['HTTP_HOST'])) {
665
      $cookie_domain = $_SERVER['HTTP_HOST'];
666 667 668 669 670 671 672
      // 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];
673 674 675 676 677 678 679
    }
  }
  // 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);
  }
680 681 682 683 684 685 686 687 688 689
  // 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';
690
  session_name($prefix . substr(hash('sha256', $session_name), 0, 32));
691 692
}

Dries's avatar
Dries committed
693
/**
694 695 696 697
 * 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
698
 *
Dries's avatar
Dries committed
699 700
 * 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
701
 * configuration. For example, a module 'foo' may legally be located
Dries's avatar
Dries committed
702 703
 * in any of these three places:
 *
704
 * core/modules/foo/foo.module
Dries's avatar
Dries committed
705 706 707 708 709 710
 * 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
711
 * @param $type
712
 *   The type of the item (theme, theme_engine, module, profile).
Dries's avatar
Dries committed
713 714 715 716 717 718 719
 * @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
720
 *   The filename of the requested item or NULL if the item is not found.
Dries's avatar
Dries committed
721
 */
Dries's avatar
Dries committed
722
function drupal_get_filename($type, $name, $filename = NULL) {
723 724
  // The location of files will not change during the request, so do not use
  // drupal_static().
725
  static $files = array(), $dirs = array();
Dries's avatar
Dries committed
726

727 728 729
  // Profiles are converted into modules in system_rebuild_module_data().
  // @todo Remove false-exposure of profiles as modules.
  $original_type = $type;
730
  if ($type == 'profile') {
731
    $type = 'module';
732
  }
733
  if (!isset($files[$type])) {
Dries's avatar
Dries committed
734 735 736
    $files[$type] = array();
  }

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

790 791 792
      if (!isset($dirs[$dir][$extension])) {
        $dirs[$dir][$extension] = TRUE;
        if (!function_exists('drupal_system_listing')) {
793
          require_once __DIR__ . '/common.inc';
794 795 796 797 798
        }
        // 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.
799
        $matches = drupal_system_listing("/^" . DRUPAL_PHP_FUNCTION_PATTERN . "\.$extension$/", $dir);
800 801 802
        foreach ($matches as $matched_name => $file) {
          $files[$type][$matched_name] = $file->uri;
        }
Dries's avatar
Dries committed
803 804 805 806
      }
    }
  }

807 808 809
  if (isset($files[$type][$name])) {
    return $files[$type][$name];
  }
Dries's avatar
Dries committed
810 811
}

812 813 814 815 816 817 818 819 820 821 822
/**
 * 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() {
823
  return Settings::getSingleton();
824 825
}

826
/**
827
 * Loads the persistent variable table.
828 829
 *
 * The variable table is composed of values that have been saved in the table
830 831
 * with variable_set() as well as those explicitly specified in the
 * configuration file.
832
 */
833
function variable_initialize($conf = array()) {
834 835
  // NOTE: caching the variables improves performance by 20% when serving
  // cached pages.
836
  if ($cached = cache('bootstrap')->get('variables')) {
837
    $variables = $cached->data;
838 839
  }
  else {
840 841
    // Cache miss. Avoid a stampede.
    $name = 'variable_init';
842
    $lock = \Drupal::lock();
843
    if (!$lock->acquire($name, 1)) {
844 845
      // Another request is building the variable cache.
      // Wait, then re-run this function.
846
      $lock->wait($name);
847 848 849 850 851
      return variable_initialize($conf);
    }
    else {
      // Proceed with variable rebuild.
      $variables = array_map('unserialize', db_query('SELECT name, value FROM {variable}')->fetchAllKeyed());
852
      cache('bootstrap')->set('variables', $variables);
853
      $lock->release($name);
854
    }
855 856 857 858
  }

  foreach ($conf as $name => $value) {
    $variables[$name] = $value;
859 860
  }

861
  return $variables;
862 863
}

864
/**
865 866 867 868 869
 * 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.
870 871 872 873 874
 *
 * @param $name
 *   The name of the variable to return.
 * @param $default
 *   The default value to use if this variable has never been set.
875
 *
876
 * @return
877
 *   The value of the variable. Unserialization is taken care of as necessary.
878
 *
879 880 881 882
 * @deprecated This will be removed in Drupal 8.0. Instead, use the
 *   configuration API.
 *
 * @see \Drupal\Core\Config::get()
883
 */
884
function variable_get($name, $default = NULL) {
885 886 887 888 889
  global $conf;

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

890
/**
891 892 893 894 895
 * 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.
896 897 898 899 900 901
 *
 * @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.
902
 *
903 904 905 906
 * @deprecated This will be removed in Drupal 8.0. Instead, use the
 *   configuration API.
 *
 * @see \Drupal\Core\Config::set()
907
 */
908 909 910
function variable_set($name, $value) {
  global $conf;

911
  db_merge('variable')->key(array('name' => $name))->fields(array('value' => serialize($value)))->execute();
912

913
  cache('bootstrap')->delete('variables');
914 915 916 917

  $conf[$name] = $value;
}

918
/**
919 920 921 922 923
 * 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.
924 925 926
 *
 * @param $name
 *   The name of the variable to undefine.
927
 *
928 929 930 931
 * @deprecated This will be removed in Drupal 8.0. Instead, use the
 *   configuration API.
 *
 * @see \Drupal\Core\Config::clear()
932
 */
933
function variable_del($name) {
Dries's avatar
Dries committed
934 935
  global $conf;

936 937 938
  db_delete('variable')
    ->condition('name', $name)
    ->execute();
939
  cache('bootstrap')->delete('variables');
940

Dries's avatar
Dries committed
941
  unset($conf[$name]);
942 943
}

944 945 946 947 948 949 950 951 952 953 954 955
/**
 * 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(),
956
    \Drupal::service('content_negotiation')->getContentType($request),
957 958 959 960
  );
  return sha1(implode(':', $cid_parts));
}

961
/**
962
 * Retrieves the current page from the cache.
963
 *
964 965 966 967 968
 * 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.
 *
969 970
 * @param \Symfony\Component\HttpFoundation\Request $request
 *   The request for this page.
971
 *
972
 * @return
973
 *   The cache object, if the page was found in the cache, NULL otherwise.
974
 */
975
function drupal_page_get_cache(Request $request) {
976
  if (drupal_page_is_cacheable()) {
977
    return \Drupal::cache('page')->get(drupal_page_cache_get_cid($request));
978
  }
979 980 981
}

/**
982
 * Determines the cacheability of the current page.
983 984
 *
 * @param $allow_caching
985 986
 *   Set to FALSE if you want to prevent this page to get cached.
 *
987
 * @return
988
 *   TRUE if the current page can be cached, FALSE otherwise.
989 990 991 992 993
 */
function drupal_page_is_cacheable($allow_caching = NULL) {
  $allow_caching_static = &drupal_static(__FUNCTION__, TRUE);
  if (isset($allow_caching)) {
    $allow_caching_static = $allow_caching;
994
  }
995 996

  return $allow_caching_static && ($_SERVER['REQUEST_METHOD'] == 'GET' || $_SERVER['REQUEST_METHOD'] == 'HEAD')
997
    && !drupal_is_cli();
998 999
}

Dries's avatar
Dries committed
1000
/**
1001 1002 1003
 * 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
1004 1005 1006 1007 1008 1009 1010 1011 1012 1013
 *
 * @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) {
1014 1015
  if ($type == 'module' && \Drupal::moduleHandler()->moduleExists($name)) {
    return \Drupal::moduleHandler()->load($name);
1016 1017
  }

1018 1019 1020
  // 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
1021

1022
  if (isset($files[$type][$name])) {
Dries's avatar
Dries committed
1023 1024 1025 1026 1027 1028
    return TRUE;
  }

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

  if ($filename) {
1029
    include_once DRUPAL_ROOT . '/' . $filename;
Dries's avatar
Dries committed
1030 1031 1032 1033 1034 1035 1036 1037
    $files[$type][$name] = TRUE;

    return TRUE;
  }

  return FALSE;
}

1038
/**
1039
 * Sets an HTTP response header for the current page.
1040 1041 1042 1043 1044
 *
 * 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
1045
 *   The HTTP header name, or the special 'Status' header name.
1046
 * @param $value
1047 1048 1049
 *   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".
1050 1051
 * @param $append
 *   Whether to append the value to an existing header or to replace it.
1052 1053
 *
 * @deprecated Header handling is being shifted to a Symfony response object.