bootstrap.inc 106 KB
Newer Older
1
<?php
Dries's avatar
 
Dries committed
2

3
use Drupal\Core\Database\Database;
4 5 6
use Symfony\Component\ClassLoader\UniversalClassLoader;
use Symfony\Component\ClassLoader\ApcUniversalClassLoader;

Dries's avatar
 
Dries committed
7 8 9 10
/**
 * @file
 * Functions that need to be loaded on every Drupal request.
 */
Dries's avatar
 
Dries committed
11

12 13 14
/**
 * The current system version.
 */
15
const VERSION = '8.0-dev';
16 17 18 19

/**
 * Core API compatibility.
 */
20
const DRUPAL_CORE_COMPATIBILITY = '8.x';
21 22 23 24

/**
 * Minimum supported version of PHP.
 */
25
const DRUPAL_MINIMUM_PHP = '5.3.3';
26 27 28 29

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

32
/**
33 34
 * Indicates that the item should never be removed unless explicitly selected.
 *
35
 * The item may be removed using cache()->delete() with a cache ID.
36
 */
37
const CACHE_PERMANENT = 0;
38 39 40 41

/**
 * Indicates that the item should be removed at the next general cache wipe.
 */
42
const CACHE_TEMPORARY = -1;
Dries's avatar
 
Dries committed
43

44 45 46 47 48 49
/**
 * @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
50
 * defined in RFC 3164, section 4.1.1. PHP supplies predefined LOG_* constants
51
 * for use in the syslog() function, but their values on Windows builds do not
52
 * correspond to RFC 3164. The associated PHP bug report was closed with the
53 54 55 56 57 58 59 60 61 62 63 64 65 66
 * 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.
 */
67
const WATCHDOG_EMERGENCY = 0;
68 69 70 71

/**
 * Log message severity -- Alert: action must be taken immediately.
 */
72
const WATCHDOG_ALERT = 1;
73 74 75 76

/**
 * Log message severity -- Critical: critical conditions.
 */
77
const WATCHDOG_CRITICAL = 2;
78 79 80 81

/**
 * Log message severity -- Error: error conditions.
 */
82
const WATCHDOG_ERROR = 3;
83 84 85 86

/**
 * Log message severity -- Warning: warning conditions.
 */
87
const WATCHDOG_WARNING = 4;
88 89 90 91

/**
 * Log message severity -- Notice: normal but significant condition.
 */
92
const WATCHDOG_NOTICE = 5;
93 94 95 96

/**
 * Log message severity -- Informational: informational messages.
 */
97
const WATCHDOG_INFO = 6;
98 99 100 101

/**
 * Log message severity -- Debug: debug-level messages.
 */
102
const WATCHDOG_DEBUG = 7;
103 104 105 106 107

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

108 109 110
/**
 * First bootstrap phase: initialize configuration.
 */
111
const DRUPAL_BOOTSTRAP_CONFIGURATION = 0;
112 113

/**
114
 * Second bootstrap phase: try to serve a cached page.
115
 */
116
const DRUPAL_BOOTSTRAP_PAGE_CACHE = 1;
117 118 119 120

/**
 * Third bootstrap phase: initialize database layer.
 */
121
const DRUPAL_BOOTSTRAP_DATABASE = 2;
122 123

/**
124
 * Fourth bootstrap phase: initialize the variable system.
125
 */
126
const DRUPAL_BOOTSTRAP_VARIABLES = 3;
127 128

/**
129
 * Fifth bootstrap phase: initialize session handling.
130
 */
131
const DRUPAL_BOOTSTRAP_SESSION = 4;
132 133

/**
134
 * Sixth bootstrap phase: set up the page header.
135
 */
136
const DRUPAL_BOOTSTRAP_PAGE_HEADER = 5;
137 138

/**
139
 * Seventh bootstrap phase: find out language of the page.
140
 */
141
const DRUPAL_BOOTSTRAP_LANGUAGE = 6;
142 143

/**
144
 * Final bootstrap phase: Drupal is fully loaded; validate and fix input data.
145
 */
146
const DRUPAL_BOOTSTRAP_FULL = 7;
147

148 149 150
/**
 * Role ID for anonymous users; should match what's in the "role" table.
 */
151
const DRUPAL_ANONYMOUS_RID = 1;
152 153 154 155

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

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

165
/**
166
 * Special system language code (only applicable to UI language).
167
 *
168 169 170 171
 * Refers to the language used in Drupal and module/theme source code. Drupal
 * uses the built-in text for English by default, but if configured to allow
 * translation/customization of English, we need to differentiate between the
 * built-in language and the English translation.
172
 */
173
const LANGUAGE_SYSTEM = 'system';
174

175
/**
176
 * The language code used when no language is explicitly assigned (yet).
177
 *
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
 * Should be used when language information is not available or cannot be
 * determined. This special language code is useful when we know the data
 * might have linguistic information, but we don't know the language.
 *
 * See http://www.w3.org/International/questions/qa-no-language#undetermined.
 */
const LANGUAGE_NOT_SPECIFIED = 'und';

/**
 * The language code used when the marked object has no linguistic content.
 *
 * Should be used when we explicitly know that the data referred has no
 * linguistic content.
 *
 * See http://www.w3.org/International/questions/qa-no-language#nonlinguistic.
 */
const LANGUAGE_NOT_APPLICABLE = 'zxx';

/**
 * The language code used when multiple languages could be applied.
 *
 * Should be used when individual parts of the data cannot be marked with
 * language, but we know there are multiple languages involved. Such as a
 * PDF file for an electronic appliance, which has usage manuals in 8
 * languages but is uploaded as one file in Drupal.
 *
 * Defined by ISO639-2 for "Multiple languages".
205
 */
206
const LANGUAGE_MULTIPLE = 'mul';
207

208
/**
209
 * The type of language used to define the content language.
210
 */
211
const LANGUAGE_TYPE_CONTENT = 'language_content';
212 213

/**
214
 * The type of language used to select the user interface.
215
 */
216
const LANGUAGE_TYPE_INTERFACE = 'language_interface';
217 218

/**
219
 * The type of language used for URLs.
220
 */
221
const LANGUAGE_TYPE_URL = 'language_url';
222

223 224 225
/**
 * Language written left to right. Possible value of $language->direction.
 */
226
const LANGUAGE_LTR = 0;
227 228 229 230

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

233
/**
234
 * Time of the current request in seconds elapsed since the Unix Epoch.
235
 *
236 237 238 239 240 241
 * 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
242
 */
243
define('REQUEST_TIME', (int) $_SERVER['REQUEST_TIME']);
244

245 246 247
/**
 * Flag for drupal_set_title(); text is not sanitized, so run check_plain().
 */
248
const CHECK_PLAIN = 0;
249 250 251 252

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

255
/**
256
 * Signals that the registry lookup cache should be reset.
257
 */
258
const REGISTRY_RESET_LOOKUP_CACHE = 1;
259 260

/**
261
 * Signals that the registry lookup cache should be written to storage.
262
 */
263
const REGISTRY_WRITE_LOOKUP_CACHE = 2;
264

265 266 267
/**
 * Regular expression to match PHP function names.
 *
268
 * @see http://php.net/manual/language.functions.php
269
 */
270
const DRUPAL_PHP_FUNCTION_PATTERN = '[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*';
271

gdd's avatar
gdd committed
272
require_once DRUPAL_ROOT . '/core/includes/config.inc';
273

Dries's avatar
 
Dries committed
274
/**
275 276 277 278
 * Starts the timer with the specified name.
 *
 * If you start and stop the same timer multiple times, the measured intervals
 * will be accumulated.
Dries's avatar
 
Dries committed
279
 *
280
 * @param $name
Dries's avatar
 
Dries committed
281 282 283 284 285
 *   The name of the timer.
 */
function timer_start($name) {
  global $timers;

286
  $timers[$name]['start'] = microtime(TRUE);
287
  $timers[$name]['count'] = isset($timers[$name]['count']) ? ++$timers[$name]['count'] : 1;
Dries's avatar
 
Dries committed
288 289 290
}

/**
291
 * Reads the current timer value without stopping the timer.
Dries's avatar
 
Dries committed
292
 *
293
 * @param $name
Dries's avatar
 
Dries committed
294
 *   The name of the timer.
295
 *
Dries's avatar
 
Dries committed
296 297 298 299 300 301
 * @return
 *   The current timer value in ms.
 */
function timer_read($name) {
  global $timers;

302
  if (isset($timers[$name]['start'])) {
303
    $stop = microtime(TRUE);
304
    $diff = round(($stop - $timers[$name]['start']) * 1000, 2);
Dries's avatar
 
Dries committed
305

306 307 308 309
    if (isset($timers[$name]['time'])) {
      $diff += $timers[$name]['time'];
    }
    return $diff;
310
  }
311
  return $timers[$name]['time'];
Dries's avatar
 
Dries committed
312 313 314
}

/**
315
 * Stops the timer with the specified name.
Dries's avatar
 
Dries committed
316
 *
317
 * @param $name
Dries's avatar
 
Dries committed
318
 *   The name of the timer.
319
 *
Dries's avatar
 
Dries committed
320
 * @return
321 322
 *   A timer array. The array contains the number of times the timer has been
 *   started and stopped (count) and the accumulated timer value in ms (time).
Dries's avatar
 
Dries committed
323 324 325 326
 */
function timer_stop($name) {
  global $timers;

327 328 329 330 331 332 333 334 335 336
  if (isset($timers[$name]['start'])) {
    $stop = microtime(TRUE);
    $diff = round(($stop - $timers[$name]['start']) * 1000, 2);
    if (isset($timers[$name]['time'])) {
      $timers[$name]['time'] += $diff;
    }
    else {
      $timers[$name]['time'] = $diff;
    }
    unset($timers[$name]['start']);
337
  }
Dries's avatar
 
Dries committed
338 339 340

  return $timers[$name];
}
341

Dries's avatar
 
Dries committed
342
/**
343
 * Finds the appropriate configuration directory.
Dries's avatar
 
Dries committed
344
 *
345
 * Finds a matching configuration directory by stripping the website's
346
 * hostname from left to right and pathname from right to left. The first
347 348
 * configuration file found will be used and the remaining ones will be ignored.
 * If no configuration file is found, return a default value '$confdir/default'.
Dries's avatar
Dries committed
349
 *
350 351
 * With a site located at http://www.example.com:8080/mysite/test/, the file,
 * settings.php, is searched for in the following directories:
Dries's avatar
 
Dries committed
352
 *
353 354 355 356
 * - $confdir/8080.www.example.com.mysite.test
 * - $confdir/www.example.com.mysite.test
 * - $confdir/example.com.mysite.test
 * - $confdir/com.mysite.test
Dries's avatar
 
Dries committed
357
 *
358 359 360 361
 * - $confdir/8080.www.example.com.mysite
 * - $confdir/www.example.com.mysite
 * - $confdir/example.com.mysite
 * - $confdir/com.mysite
Dries's avatar
 
Dries committed
362
 *
363 364 365 366
 * - $confdir/8080.www.example.com
 * - $confdir/www.example.com
 * - $confdir/example.com
 * - $confdir/com
Dries's avatar
 
Dries committed
367
 *
368
 * - $confdir/default
369
 *
370
 * If a file named sites.php is present in the $confdir, it will be loaded
371 372
 * prior to scanning for directories. It should define an associative array
 * named $sites, which maps domains to directories. It should be in the form
373
 * of:
374
 * @code
375 376 377
 * $sites = array(
 *   'The url to alias' => 'A directory within the sites directory'
 * );
378
 * @endcode
379
 * For example:
380
 * @code
381 382
 * $sites = array(
 *   'devexample.com' => 'example.com',
383
 *   'localhost.example' => 'example.com',
384
 * );
385
 * @endcode
386 387 388 389
 * The above array will cause Drupal to look for a directory named
 * "example.com" in the sites directory whenever a request comes from
 * "example.com", "devexample.com", or "localhost/example". That is useful
 * on development servers, where the domain name may not be the same as the
390
 * domain of the live server. Since Drupal stores file paths into the database
391 392 393
 * (files, system table, etc.) this will ensure the paths are correct while
 * accessed on development servers.
 *
394
 * @param bool $require_settings
395 396 397 398
 *   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.
399
 * @param bool $reset
400
 *   Force a full search for matching directories even if one had been
401 402
 *   found previously. Defaults to FALSE.
 *
403 404
 * @return
 *   The path of the matching directory.
Dries's avatar
 
Dries committed
405
 */
406
function conf_path($require_settings = TRUE, $reset = FALSE) {
407
  $conf = &drupal_static(__FUNCTION__, '');
Dries's avatar
 
Dries committed
408

409
  if ($conf && !$reset) {
Dries's avatar
Dries committed
410 411
    return $conf;
  }
Dries's avatar
 
Dries committed
412

413 414 415 416 417
  $script_name = $_SERVER['SCRIPT_NAME'];
  if (!$script_name) {
    $script_name = $_SERVER['SCRIPT_FILENAME'];
  }
  $http_host = $_SERVER['HTTP_HOST'];
418
  $conf = find_conf_path($http_host, $script_name, $require_settings);
419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436
  return $conf;
}

/**
 * Finds the appropriate configuration directory for a given host and path.
 *
 * @param $http_host
 *   The hostname and optional port number, e.g. "www.example.com" or
 *   "www.example.com:8080".
 * @param $script_name
 *   The part of the url following the hostname, including the leading slash.
 *
 * @return
 *   The path of the matching configuration directory.
 *
 * @see conf_path()
 */
function find_conf_path($http_host, $script_name, $require_settings = TRUE) {
Dries's avatar
 
Dries committed
437
  $confdir = 'sites';
438 439 440 441 442 443 444

  $sites = array();
  if (file_exists(DRUPAL_ROOT . '/' . $confdir . '/sites.php')) {
    // This will overwrite $sites with the desired mappings.
    include(DRUPAL_ROOT . '/' . $confdir . '/sites.php');
  }

445 446
  $uri = explode('/', $script_name);
  $server = explode('.', implode('.', array_reverse(explode(':', rtrim($http_host, '.')))));
Dries's avatar
Dries committed
447 448 449
  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));
450 451 452 453
      if (isset($sites[$dir]) && file_exists(DRUPAL_ROOT . '/' . $confdir . '/' . $sites[$dir])) {
        $dir = $sites[$dir];
      }
      if (file_exists(DRUPAL_ROOT . '/' . $confdir . '/' . $dir . '/settings.php') || (!$require_settings && file_exists(DRUPAL_ROOT . '/' . $confdir . '/' . $dir))) {
Dries's avatar
Dries committed
454 455 456
        $conf = "$confdir/$dir";
        return $conf;
      }
Dries's avatar
 
Dries committed
457 458
    }
  }
Dries's avatar
Dries committed
459 460
  $conf = "$confdir/default";
  return $conf;
Dries's avatar
 
Dries committed
461 462
}

463
/**
464
 * Sets appropriate server variables needed for command line scripts to work.
465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497
 *
 * 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
 * some cases; for example, if Drupal's ip_address() function 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.
 *
 * @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()
 * @see ip_address()
 */
function drupal_override_server_variables($variables = array()) {
498
  // Allow the provided URL to override any existing values in $_SERVER.
499 500
  if (isset($variables['url'])) {
    $url = parse_url($variables['url']);
501 502 503 504 505 506
    if (isset($url['host'])) {
      $_SERVER['HTTP_HOST'] = $url['host'];
    }
    if (isset($url['path'])) {
      $_SERVER['SCRIPT_NAME'] = $url['path'];
    }
507 508
    unset($variables['url']);
  }
509 510 511
  // 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.
512
  $defaults = array(
513 514
    'HTTP_HOST' => 'localhost',
    'SCRIPT_NAME' => NULL,
515 516 517
    'REMOTE_ADDR' => '127.0.0.1',
    'REQUEST_METHOD' => 'GET',
    'SERVER_NAME' => NULL,
518
    'SERVER_SOFTWARE' => NULL,
519 520 521 522 523 524
    'HTTP_USER_AGENT' => NULL,
  );
  // Replace elements of the $_SERVER array, as appropriate.
  $_SERVER = $variables + $_SERVER + $defaults;
}

525
/**
526
 * Initializes the PHP environment.
527
 */
528
function drupal_environment_initialize() {
529 530
  if (!isset($_SERVER['HTTP_REFERER'])) {
    $_SERVER['HTTP_REFERER'] = '';
531
  }
532 533 534
  if (!isset($_SERVER['SERVER_PROTOCOL']) || ($_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.0' && $_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.1')) {
    $_SERVER['SERVER_PROTOCOL'] = 'HTTP/1.0';
  }
535

536 537 538 539 540 541 542 543 544 545 546 547 548 549 550
  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'] = '';
551 552
  }

553 554 555 556 557 558 559
  // When clean URLs are enabled, emulate ?q=foo/bar using REQUEST_URI. It is
  // not possible to append the query string using mod_rewrite without the B
  // flag (this was added in Apache 2.2.8), because mod_rewrite unescapes the
  // path before passing it on to PHP. This is a problem when the path contains
  // e.g. "&" or "%" that have special meanings in URLs and must be encoded.
  $_GET['q'] = request_path();

560 561
  // Enforce E_STRICT, but allow users to set levels not part of E_STRICT.
  error_reporting(E_STRICT | E_ALL | error_reporting());
562

563 564 565
  // 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.
566

567
  // Don't escape quotes when reading files from the database, disk, etc.
568
  ini_set('magic_quotes_runtime', '0');
569 570
  // Use session cookies, not transparent sessions that puts the session id in
  // the query string.
571
  ini_set('session.use_cookies', '1');
572
  ini_set('session.use_only_cookies', '1');
573
  ini_set('session.use_trans_sid', '0');
574 575
  // Don't send HTTP headers using PHP's session handler.
  ini_set('session.cache_limiter', 'none');
576 577
  // Use httponly session cookies.
  ini_set('session.cookie_httponly', '1');
578 579 580 581

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

584
/**
585
 * Validates that a hostname (for example $_SERVER['HTTP_HOST']) is safe.
586 587 588 589
 *
 * @return
 *  TRUE if only containing valid characters, or FALSE otherwise.
 */
590 591
function drupal_valid_http_host($host) {
  return preg_match('/^\[?(?:[a-zA-Z0-9-:\]_]+\.?)+$/', $host);
592 593
}

594
/**
595
 * Sets the base URL, cookie domain, and session name from configuration.
596
 */
597
function drupal_settings_initialize() {
598 599
  global $base_url, $base_path, $base_root;

Dries's avatar
Dries committed
600
  // Export the following settings.php variables to the global namespace
601
  global $databases, $cookie_domain, $conf, $installed_profile, $update_free_access, $db_url, $db_prefix, $drupal_hash_salt, $is_https, $base_secure_url, $base_insecure_url, $config_directory_name, $config_signature_key;
Dries's avatar
Dries committed
602 603
  $conf = array();

604 605
  if (file_exists(DRUPAL_ROOT . '/' . conf_path() . '/settings.php')) {
    include_once DRUPAL_ROOT . '/' . conf_path() . '/settings.php';
606
  }
607
  $is_https = isset($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) == 'on';
608 609 610 611

  if (isset($base_url)) {
    // Parse fixed base URL from settings.php.
    $parts = parse_url($base_url);
612
    $http_protocol = $parts['scheme'];
613 614 615
    if (!isset($parts['path'])) {
      $parts['path'] = '';
    }
616
    $base_path = $parts['path'] . '/';
617 618 619 620 621
    // 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
622
    $http_protocol = $is_https ? 'https' : 'http';
623
    $base_root = $http_protocol . '://' . $_SERVER['HTTP_HOST'];
624

625
    $base_url = $base_root;
626 627 628

    // $_SERVER['SCRIPT_NAME'] can, in contrast to $_SERVER['PHP_SELF'], not
    // be modified by a visitor.
629
    if ($dir = rtrim(dirname($_SERVER['SCRIPT_NAME']), '\/')) {
630 631 632 633 634 635 636 637 638
      // Remove "core" directory if present, allowing install.php, update.php,
      // cron.php and others to auto-detect a base path.
      $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;
      }
639 640 641 642 643 644 645
      $base_url .= $base_path;
      $base_path .= '/';
    }
    else {
      $base_path = '/';
    }
  }
646 647
  $base_secure_url = str_replace('http://', 'https://', $base_url);
  $base_insecure_url = str_replace('https://', 'http://', $base_url);
648 649 650 651 652 653

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

Dries's avatar
Dries committed
688
/**
689 690 691 692
 * 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
693
 *
Dries's avatar
Dries committed
694 695 696 697 698 699 700 701 702 703 704 705
 * This function plays a key role in allowing Drupal's resources (modules
 * and themes) to be located in different places depending on a site's
 * configuration. For example, a module 'foo' may legally be be located
 * in any of these three places:
 *
 * modules/foo/foo.module
 * sites/all/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
706
 * @param $type
707
 *   The type of the item (i.e. theme, theme_engine, module, profile).
Dries's avatar
Dries committed
708 709 710 711 712 713 714 715 716
 * @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
 *   The filename of the requested item.
 */
Dries's avatar
Dries committed
717
function drupal_get_filename($type, $name, $filename = NULL) {
718 719
  // The location of files will not change during the request, so do not use
  // drupal_static().
720
  static $files = array(), $dirs = array();
Dries's avatar
Dries committed
721

722 723 724 725 726
  // Profiles are a special case: they have a fixed location and naming.
  if ($type == 'profile') {
    $profile_filename = "profiles/$name/$name.profile";
    $files[$type][$name] = file_exists($profile_filename) ? $profile_filename : FALSE;
  }
727
  if (!isset($files[$type])) {
Dries's avatar
Dries committed
728 729 730
    $files[$type] = array();
  }

731
  if (!empty($filename) && file_exists($filename)) {
Dries's avatar
Dries committed
732 733
    $files[$type][$name] = $filename;
  }
734
  elseif (isset($files[$type][$name])) {
Dries's avatar
Dries committed
735 736
    // nothing
  }
Dries's avatar
Dries committed
737
  // Verify that we have an active database connection, before querying
738
  // the database. This is required because this function is called both
Dries's avatar
Dries committed
739 740
  // before we have a database connection (i.e. during installation) and
  // when a database connection fails.
Dries's avatar
Dries committed
741
  else {
742
    try {
743 744
      if (function_exists('db_query')) {
        $file = db_query("SELECT filename FROM {system} WHERE name = :name AND type = :type", array(':name' => $name, ':type' => $type))->fetchField();
745
        if (file_exists(DRUPAL_ROOT . '/' . $file)) {
746 747
          $files[$type][$name] = $file;
        }
748 749
      }
    }
750
    catch (Exception $e) {
751 752 753 754 755 756 757 758 759 760 761
      // The database table may not exist because Drupal is not yet installed,
      // or the database might be down. We have a fallback for this case so we
      // hide the error completely.
    }
    // 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])) {
      // We have a consistent directory naming: modules, themes...
      $dir = $type . 's';
      if ($type == 'theme_engine') {
        $dir = 'themes/engines';
762
        $extension = 'engine';
763 764
      }
      elseif ($type == 'theme') {
765
        $extension = 'info';
766 767
      }
      else {
768
        $extension = $type;
769 770
      }

771 772 773
      if (!isset($dirs[$dir][$extension])) {
        $dirs[$dir][$extension] = TRUE;
        if (!function_exists('drupal_system_listing')) {
774
          require_once DRUPAL_ROOT . '/core/includes/common.inc';
775 776 777 778 779 780 781 782 783
        }
        // 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, 'name', 0);
        foreach ($matches as $matched_name => $file) {
          $files[$type][$matched_name] = $file->uri;
        }
Dries's avatar
Dries committed
784 785 786 787
      }
    }
  }

788 789 790
  if (isset($files[$type][$name])) {
    return $files[$type][$name];
  }
Dries's avatar
Dries committed
791 792
}

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

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

Dries's avatar
 
Dries committed
827
  return $variables;
Dries's avatar
 
Dries committed
828 829
}

Dries's avatar
 
Dries committed
830
/**
831 832 833 834 835
 * 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
836 837 838 839 840
 *
 * @param $name
 *   The name of the variable to return.
 * @param $default
 *   The default value to use if this variable has never been set.
841
 *
Dries's avatar
 
Dries committed
842 843
 * @return
 *   The value of the variable.
844
 *
845 846
 * @see variable_del()
 * @see variable_set()
Dries's avatar
 
Dries committed
847
 */
848
function variable_get($name, $default = NULL) {
Dries's avatar
 
Dries committed
849 850 851 852 853
  global $conf;

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

Dries's avatar
 
Dries committed
854
/**
855 856 857 858 859
 * Sets a persistent variable.
 *
 * Case-sensitivity of the variable_* functions depends on the database
 * collation used. To avoid problems, always use lower case for persistent
 * variable names.
Dries's avatar
 
Dries committed
860 861 862 863 864 865
 *
 * @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.
866
 *
867 868
 * @see variable_del()
 * @see variable_get()
Dries's avatar
 
Dries committed
869
 */
Dries's avatar
 
Dries committed
870 871 872
function variable_set($name, $value) {
  global $conf;

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

875
  cache('bootstrap')->delete('variables');
Dries's avatar
 
Dries committed
876 877 878 879

  $conf[$name] = $value;
}

Dries's avatar
 
Dries committed
880
/**
881 882 883 884 885
 * Unsets a persistent variable.
 *
 * Case-sensitivity of the variable_* functions depends on the database
 * collation used. To avoid problems, always use lower case for persistent
 * variable names.
Dries's avatar
 
Dries committed
886 887 888
 *
 * @param $name
 *   The name of the variable to undefine.
889
 *
890 891
 * @see variable_get()
 * @see variable_set()
Dries's avatar
 
Dries committed
892
 */
Dries's avatar
 
Dries committed
893
function variable_del($name) {
Dries's avatar
Dries committed
894 895
  global $conf;