bootstrap.inc 110 KB
Newer Older
1
<?php
2

3 4 5 6
/**
 * @file
 * Functions that need to be loaded on every Drupal request.
 */
7

8 9 10
/**
 * The current system version.
 */
11
define('VERSION', '8.0-dev');
12 13 14 15

/**
 * Core API compatibility.
 */
16
define('DRUPAL_CORE_COMPATIBILITY', '8.x');
17 18 19 20

/**
 * Minimum supported version of PHP.
 */
21
define('DRUPAL_MINIMUM_PHP', '5.3.2');
22 23 24 25

/**
 * Minimum recommended value of PHP memory_limit.
 */
26
define('DRUPAL_MINIMUM_PHP_MEMORY_LIMIT', '32M');
27

28
/**
29 30
 * Indicates that the item should never be removed unless explicitly selected.
 *
31
 * The item may be removed using cache()->delete() with a cache ID.
32
 */
33
define('CACHE_PERMANENT', 0);
34 35 36 37

/**
 * Indicates that the item should be removed at the next general cache wipe.
 */
38
define('CACHE_TEMPORARY', -1);
39

40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
/**
 * @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
 * defined in RFC 3164, section 4.1.1.  PHP supplies predefined LOG_* constants
 * for use in the syslog() function, but their values on Windows builds do not
 * correspond to RFC 3164.  The associated PHP bug report was closed with the
 * 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.
 */
define('WATCHDOG_EMERGENCY', 0);

/**
 * Log message severity -- Alert: action must be taken immediately.
 */
define('WATCHDOG_ALERT', 1);

/**
 * Log message severity -- Critical: critical conditions.
 */
define('WATCHDOG_CRITICAL', 2);

/**
 * Log message severity -- Error: error conditions.
 */
define('WATCHDOG_ERROR', 3);

/**
 * Log message severity -- Warning: warning conditions.
 */
define('WATCHDOG_WARNING', 4);

/**
 * Log message severity -- Notice: normal but significant condition.
 */
define('WATCHDOG_NOTICE', 5);

/**
 * Log message severity -- Informational: informational messages.
 */
define('WATCHDOG_INFO', 6);

/**
 * Log message severity -- Debug: debug-level messages.
 */
define('WATCHDOG_DEBUG', 7);

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

104 105 106
/**
 * First bootstrap phase: initialize configuration.
 */
107
define('DRUPAL_BOOTSTRAP_CONFIGURATION', 0);
108 109

/**
110
 * Second bootstrap phase: try to serve a cached page.
111
 */
112
define('DRUPAL_BOOTSTRAP_PAGE_CACHE', 1);
113 114 115 116

/**
 * Third bootstrap phase: initialize database layer.
 */
117
define('DRUPAL_BOOTSTRAP_DATABASE', 2);
118 119

/**
120
 * Fourth bootstrap phase: initialize the variable system.
121
 */
122
define('DRUPAL_BOOTSTRAP_VARIABLES', 3);
123 124

/**
125
 * Fifth bootstrap phase: initialize session handling.
126
 */
127
define('DRUPAL_BOOTSTRAP_SESSION', 4);
128 129

/**
130
 * Sixth bootstrap phase: set up the page header.
131
 */
132
define('DRUPAL_BOOTSTRAP_PAGE_HEADER', 5);
133 134

/**
135
 * Seventh bootstrap phase: find out language of the page.
136
 */
137
define('DRUPAL_BOOTSTRAP_LANGUAGE', 6);
138 139 140 141 142

/**
 * Final bootstrap phase: Drupal is fully loaded; validate and fix
 * input data.
 */
143
define('DRUPAL_BOOTSTRAP_FULL', 7);
144

145 146 147
/**
 * Role ID for anonymous users; should match what's in the "role" table.
 */
148
define('DRUPAL_ANONYMOUS_RID', 1);
149 150 151 152

/**
 * Role ID for authenticated users; should match what's in the "role" table.
 */
153 154
define('DRUPAL_AUTHENTICATED_RID', 2);

155
/**
156
 * The number of bytes in a kilobyte. For more information, visit
157 158 159 160
 * http://en.wikipedia.org/wiki/Kilobyte.
 */
define('DRUPAL_KILOBYTE', 1024);

161 162 163
/**
 * The language code used when no language is explicitly assigned.
 *
164
 * Defined by ISO639-2 for "Undetermined".
165
 */
166
define('LANGUAGE_NONE', 'und');
167

168
/**
169
 * The type of language used to define the content language.
170
 */
171
define('LANGUAGE_TYPE_CONTENT', 'language_content');
172 173

/**
174
 * The type of language used to select the user interface.
175
 */
176
define('LANGUAGE_TYPE_INTERFACE', 'language');
177 178

/**
179
 * The type of language used for URLs.
180
 */
181
define('LANGUAGE_TYPE_URL', 'language_url');
182

183 184 185 186 187 188 189 190 191 192
/**
 * Language written left to right. Possible value of $language->direction.
 */
define('LANGUAGE_LTR', 0);

/**
 * Language written right to left. Possible value of $language->direction.
 */
define('LANGUAGE_RTL', 1);

193 194
/**
 * For convenience, define a short form of the request time global.
195 196 197
 *
 * REQUEST_TIME is a float with microseconds since PHP 5.4.0, but float
 * timestamps confuses most of the PHP functions (including date_create()).
198
 */
199
define('REQUEST_TIME', (int) $_SERVER['REQUEST_TIME']);
200

201 202 203 204 205 206 207 208 209 210
/**
 * Flag for drupal_set_title(); text is not sanitized, so run check_plain().
 */
define('CHECK_PLAIN', 0);

/**
 * Flag for drupal_set_title(); text has already been sanitized.
 */
define('PASS_THROUGH', -1);

211
/**
212
 * Signals that the registry lookup cache should be reset.
213 214 215 216
 */
define('REGISTRY_RESET_LOOKUP_CACHE', 1);

/**
217
 * Signals that the registry lookup cache should be written to storage.
218 219 220
 */
define('REGISTRY_WRITE_LOOKUP_CACHE', 2);

221 222 223 224 225 226 227
/**
 * Regular expression to match PHP function names.
 *
 * @see http://php.net/manual/en/language.functions.php
 */
define('DRUPAL_PHP_FUNCTION_PATTERN', '[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*');

228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
/**
 * Provides a caching wrapper to be used in place of large array structures.
 *
 * This class should be extended by systems that need to cache large amounts
 * of data and have it represented as an array to calling functions. These
 * arrays can become very large, so ArrayAccess is used to allow different
 * strategies to be used for caching internally (lazy loading, building caches
 * over time etc.). This can dramatically reduce the amount of data that needs
 * to be loaded from cache backends on each request, and memory usage from
 * static caches of that same data.
 *
 * Note that array_* functions do not work with ArrayAccess. Systems using
 * DrupalCacheArray should use this only internally. If providing API functions
 * that return the full array, this can be cached separately or returned
 * directly. However since DrupalCacheArray holds partial content by design, it
 * should be a normal PHP array or otherwise contain the full structure.
 *
 * Note also that due to limitations in PHP prior to 5.3.4, it is impossible to
 * write directly to the contents of nested arrays contained in this object.
 * Only writes to the top-level array elements are possible. So if you
 * previously had set $object['foo'] = array(1, 2, 'bar' => 'baz'), but later
 * want to change the value of 'bar' from 'baz' to 'foobar', you cannot do so
 * a targeted write like $object['foo']['bar'] = 'foobar'. Instead, you must
 * overwrite the entire top-level 'foo' array with the entire set of new
 * values: $object['foo'] = array(1, 2, 'bar' => 'foobar'). Due to this same
 * limitation, attempts to create references to any contained data, nested or
 * otherwise, will fail silently. So $var = &$object['foo'] will not throw an
 * error, and $var will be populated with the contents of $object['foo'], but
 * that data will be passed by value, not reference. For more information on
 * the PHP limitation, see the note in the official PHP documentation at·
 * http://php.net/manual/en/arrayaccess.offsetget.php on
 * ArrayAccess::offsetGet().
 *
 * By default, the class accounts for caches where calling functions might
 * request keys in the array that won't exist even after a cache rebuild. This
 * prevents situations where a cache rebuild would be triggered over and over
 * due to a 'missing' item. These cases are stored internally as a value of
 * NULL. This means that the offsetGet() and offsetExists() methods
 * must be overridden if caching an array where the top level values can
 * legitimately be NULL, and where $object->offsetExists() needs to correctly
 * return (equivalent to array_key_exists() vs. isset()). This should not
 * be necessary in the majority of cases.
 *
 * Classes extending this class must override at least the
 * resolveCacheMiss() method to have a working implementation.
 *
 * offsetSet() is not overridden by this class by default. In practice this
 * means that assigning an offset via arrayAccess will only apply while the
 * object is in scope and will not be written back to the persistent cache.
 * This follows a similar pattern to static vs. persistent caching in
 * procedural code. Extending classes may wish to alter this behaviour, for
 * example by overriding offsetSet() and adding an automatic call to persist().
 *
 * @see SchemaCache
 */
abstract class DrupalCacheArray implements ArrayAccess {

  /**
286
   * A cid to pass to cache()->set() and cache()->get().
287 288 289 290
   */
  private $cid;

  /**
291
   * A bin to pass to cache()->set() and cache()->get().
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316
   */
  private $bin;

  /**
   * An array of keys to add to the cache at the end of the request.
   */
  protected $keysToPersist = array();

  /**
   * Storage for the data itself.
   */
  protected $storage = array();

  /**
   * Constructor.
   *
   * @param $cid
   *   The cid for the array being cached.
   * @param $bin
   *   The bin to cache the array.
   */
  public function __construct($cid, $bin) {
    $this->cid = $cid;
    $this->bin = $bin;

317
    if ($cached = cache($bin)->get($this->cid)) {
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 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393
     $this->storage = $cached->data;
    }
  }

  public function offsetExists($offset) {
    return $this->offsetGet($offset) !== NULL;
  }

  public function offsetGet($offset) {
    if (isset($this->storage[$offset]) || array_key_exists($offset, $this->storage)) {
      return $this->storage[$offset];
    }
    else {
      return $this->resolveCacheMiss($offset);
    }
  }

  public function offsetSet($offset, $value) {
    $this->storage[$offset] = $value;
  }

  public function offsetUnset($offset) {
    unset($this->storage[$offset]);
  }

  /**
   * Flags an offset value to be written to the persistent cache.
   *
   * If a value is assigned to a cache object with offsetSet(), by default it
   * will not be written to the persistent cache unless it is flagged with this
   * method. This allows items to be cached for the duration of a request,
   * without necessarily writing back to the persistent cache at the end.
   *
   * @param $offset
   *   The array offset that was request.
   * @param $persist
   *   Optional boolean to specify whether the offset should be persisted or
   *   not, defaults to TRUE. When called with $persist = FALSE the offset will
   *   be unflagged so that it will not written at the end of the request.
   */
  protected function persist($offset, $persist = TRUE) {
    $this->keysToPersist[$offset] = $persist;
  }

  /**
   * Resolves a cache miss.
   *
   * When an offset is not found in the object, this is treated as a cache
   * miss. This method allows classes implementing the interface to look up
   * the actual value and allow it to be cached.
   *
   * @param $offset
   *   The offset that was requested.
   *
   * @return
   *   The value of the offset, or NULL if no value was found.
   */
  abstract protected function resolveCacheMiss($offset);

  /**
   * Immediately write a value to the persistent cache.
   *
   * @param $cid
   *   The cache ID.
   * @param $bin
   *   The cache bin.
   * @param $data
   *   The data to write to the persistent cache.
   * @param $lock
   *   Whether to acquire a lock before writing to cache.
   */
  protected function set($cid, $data, $bin, $lock = TRUE) {
    // Lock cache writes to help avoid stampedes.
    // To implement locking for cache misses, override __construct().
    $lock_name = $cid . ':' . $bin;
    if (!$lock || lock_acquire($lock_name)) {
394
      if ($cached = cache($bin)->get($cid)) {
395 396
        $data = $cached->data + $data;
      }
397
      cache($bin)->set($cid, $data);
398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416
      if ($lock) {
        lock_release($lock_name);
      }
    }
  }

  public function __destruct() {
    $data = array();
    foreach ($this->keysToPersist as $offset => $persist) {
      if ($persist) {
        $data[$offset] = $this->storage[$offset];
      }
    }
    if (!empty($data)) {
      $this->set($this->cid, $data, $this->bin);
    }
  }
}

417
/**
418 419
 * Start the timer with the specified name. If you start and stop the same
 * timer multiple times, the measured intervals will be accumulated.
420
 *
421
 * @param $name
422 423 424 425 426
 *   The name of the timer.
 */
function timer_start($name) {
  global $timers;

427
  $timers[$name]['start'] = microtime(TRUE);
428
  $timers[$name]['count'] = isset($timers[$name]['count']) ? ++$timers[$name]['count'] : 1;
429 430 431 432 433
}

/**
 * Read the current timer value without stopping the timer.
 *
434
 * @param $name
435
 *   The name of the timer.
436
 *
437 438 439 440 441 442
 * @return
 *   The current timer value in ms.
 */
function timer_read($name) {
  global $timers;

443
  if (isset($timers[$name]['start'])) {
444
    $stop = microtime(TRUE);
445
    $diff = round(($stop - $timers[$name]['start']) * 1000, 2);
446

447 448 449 450
    if (isset($timers[$name]['time'])) {
      $diff += $timers[$name]['time'];
    }
    return $diff;
451
  }
452
  return $timers[$name]['time'];
453 454 455 456 457
}

/**
 * Stop the timer with the specified name.
 *
458
 * @param $name
459
 *   The name of the timer.
460
 *
461
 * @return
462 463
 *   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).
464 465 466 467
 */
function timer_stop($name) {
  global $timers;

468 469 470 471 472 473 474 475 476 477
  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']);
478
  }
479 480 481

  return $timers[$name];
}
482

483
/**
484
 * Finds the appropriate configuration directory.
485
 *
486
 * Finds a matching configuration directory by stripping the website's
487
 * hostname from left to right and pathname from right to left. The first
488 489
 * 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'.
490
 *
491 492
 * With a site located at http://www.example.com:8080/mysite/test/, the file,
 * settings.php, is searched for in the following directories:
493
 *
494 495 496 497
 * - $confdir/8080.www.example.com.mysite.test
 * - $confdir/www.example.com.mysite.test
 * - $confdir/example.com.mysite.test
 * - $confdir/com.mysite.test
498
 *
499 500 501 502
 * - $confdir/8080.www.example.com.mysite
 * - $confdir/www.example.com.mysite
 * - $confdir/example.com.mysite
 * - $confdir/com.mysite
503
 *
504 505 506 507
 * - $confdir/8080.www.example.com
 * - $confdir/www.example.com
 * - $confdir/example.com
 * - $confdir/com
508
 *
509
 * - $confdir/default
510
 *
511
 * If a file named sites.php is present in the $confdir, it will be loaded
512 513
 * prior to scanning for directories. It should define an associative array
 * named $sites, which maps domains to directories. It should be in the form
514
 * of:
515
 * @code
516 517 518
 * $sites = array(
 *   'The url to alias' => 'A directory within the sites directory'
 * );
519
 * @endcode
520
 * For example:
521
 * @code
522 523
 * $sites = array(
 *   'devexample.com' => 'example.com',
524
 *   'localhost.example' => 'example.com',
525
 * );
526
 * @endcode
527 528 529 530
 * 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
531
 * domain of the live server. Since Drupal stores file paths into the database
532 533 534
 * (files, system table, etc.) this will ensure the paths are correct while
 * accessed on development servers.
 *
535
 * @param bool $require_settings
536 537 538 539
 *   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.
540
 * @param bool $reset
541
 *   Force a full search for matching directories even if one had been
542 543
 *   found previously. Defaults to FALSE.
 *
544 545
 * @return
 *   The path of the matching directory.
546
 */
547
function conf_path($require_settings = TRUE, $reset = FALSE) {
548
  $conf = &drupal_static(__FUNCTION__, '');
549

550
  if ($conf && !$reset) {
551 552
    return $conf;
  }
553

554 555 556 557 558
  $script_name = $_SERVER['SCRIPT_NAME'];
  if (!$script_name) {
    $script_name = $_SERVER['SCRIPT_FILENAME'];
  }
  $http_host = $_SERVER['HTTP_HOST'];
559
  $conf = find_conf_path($http_host, $script_name, $require_settings);
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577
  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) {
578
  $confdir = 'sites';
579 580 581 582 583 584 585

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

586 587
  $uri = explode('/', $script_name);
  $server = explode('.', implode('.', array_reverse(explode(':', rtrim($http_host, '.')))));
588 589 590
  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));
591 592 593 594
      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))) {
595 596 597
        $conf = "$confdir/$dir";
        return $conf;
      }
598 599
    }
  }
600 601
  $conf = "$confdir/default";
  return $conf;
602 603
}

604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638
/**
 * Set appropriate server variables needed for command line scripts to work.
 *
 * 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()) {
639
  // Allow the provided URL to override any existing values in $_SERVER.
640 641
  if (isset($variables['url'])) {
    $url = parse_url($variables['url']);
642 643 644 645 646 647
    if (isset($url['host'])) {
      $_SERVER['HTTP_HOST'] = $url['host'];
    }
    if (isset($url['path'])) {
      $_SERVER['SCRIPT_NAME'] = $url['path'];
    }
648 649
    unset($variables['url']);
  }
650 651 652
  // 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.
653
  $defaults = array(
654 655
    'HTTP_HOST' => 'localhost',
    'SCRIPT_NAME' => NULL,
656 657 658
    'REMOTE_ADDR' => '127.0.0.1',
    'REQUEST_METHOD' => 'GET',
    'SERVER_NAME' => NULL,
659
    'SERVER_SOFTWARE' => NULL,
660 661 662 663 664 665
    'HTTP_USER_AGENT' => NULL,
  );
  // Replace elements of the $_SERVER array, as appropriate.
  $_SERVER = $variables + $_SERVER + $defaults;
}

666
/**
667
 * Initialize PHP environment.
668
 */
669
function drupal_environment_initialize() {
670 671
  if (!isset($_SERVER['HTTP_REFERER'])) {
    $_SERVER['HTTP_REFERER'] = '';
672
  }
673 674 675
  if (!isset($_SERVER['SERVER_PROTOCOL']) || ($_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.0' && $_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.1')) {
    $_SERVER['SERVER_PROTOCOL'] = 'HTTP/1.0';
  }
676

677 678 679 680 681 682 683 684 685 686 687 688 689 690 691
  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'] = '';
692 693
  }

694 695 696 697 698 699 700
  // 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();

701 702
  // Enforce E_STRICT, but allow users to set levels not part of E_STRICT.
  error_reporting(E_STRICT | E_ALL | error_reporting());
703

704 705 706
  // 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.
707

708
  // Don't escape quotes when reading files from the database, disk, etc.
709
  ini_set('magic_quotes_runtime', '0');
710 711
  // Use session cookies, not transparent sessions that puts the session id in
  // the query string.
712
  ini_set('session.use_cookies', '1');
713
  ini_set('session.use_only_cookies', '1');
714
  ini_set('session.use_trans_sid', '0');
715 716
  // Don't send HTTP headers using PHP's session handler.
  ini_set('session.cache_limiter', 'none');
717 718
  // Use httponly session cookies.
  ini_set('session.cookie_httponly', '1');
719 720 721 722

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

725
/**
726
 * Validate that a hostname (for example $_SERVER['HTTP_HOST']) is safe.
727 728 729 730
 *
 * @return
 *  TRUE if only containing valid characters, or FALSE otherwise.
 */
731 732
function drupal_valid_http_host($host) {
  return preg_match('/^\[?(?:[a-zA-Z0-9-:\]_]+\.?)+$/', $host);
733 734
}

735
/**
736 737
 * Loads the configuration and sets the base URL, cookie domain, and
 * session name correctly.
738
 */
739
function drupal_settings_initialize() {
740 741
  global $base_url, $base_path, $base_root;

Dries's avatar
Dries committed
742
  // Export the following settings.php variables to the global namespace
743
  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;
Dries's avatar
Dries committed
744 745
  $conf = array();

746 747
  if (file_exists(DRUPAL_ROOT . '/' . conf_path() . '/settings.php')) {
    include_once DRUPAL_ROOT . '/' . conf_path() . '/settings.php';
748
  }
749
  $is_https = isset($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) == 'on';
750 751 752 753

  if (isset($base_url)) {
    // Parse fixed base URL from settings.php.
    $parts = parse_url($base_url);
754
    $http_protocol = $parts['scheme'];
755 756 757
    if (!isset($parts['path'])) {
      $parts['path'] = '';
    }
758
    $base_path = $parts['path'] . '/';
759 760 761 762 763
    // 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
764
    $http_protocol = $is_https ? 'https' : 'http';
765
    $base_root = $http_protocol . '://' . $_SERVER['HTTP_HOST'];
766

767
    $base_url = $base_root;
768 769 770

    // $_SERVER['SCRIPT_NAME'] can, in contrast to $_SERVER['PHP_SELF'], not
    // be modified by a visitor.
771 772
    if ($dir = rtrim(dirname($_SERVER['SCRIPT_NAME']), '\/')) {
      $base_path = $dir;
773 774 775 776 777 778 779
      $base_url .= $base_path;
      $base_path .= '/';
    }
    else {
      $base_path = '/';
    }
  }
780 781
  $base_secure_url = str_replace('http://', 'https://', $base_url);
  $base_insecure_url = str_replace('https://', 'http://', $base_url);
782 783 784 785 786 787

  if ($cookie_domain) {
    // If the user specifies the cookie domain, also use it for session name.
    $session_name = $cookie_domain;
  }
  else {
788 789 790
    // 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);
791 792
    // HTTP_HOST can be modified by a visitor, but we already sanitized it
    // in drupal_settings_initialize().
793
    if (!empty($_SERVER['HTTP_HOST'])) {
794
      $cookie_domain = $_SERVER['HTTP_HOST'];
795 796 797 798 799 800 801
      // 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];
802 803 804 805 806 807 808
    }
  }
  // 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);
  }
809 810 811 812 813 814 815 816 817 818
  // 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';
819
  session_name($prefix . substr(hash('sha256', $session_name), 0, 32));
820 821
}

Dries's avatar
Dries committed
822 823
/**
 * Returns and optionally sets the filename for a system item (module,
824
 * theme, etc.). The filename, whether provided, cached, or retrieved
Dries's avatar
Dries committed
825 826
 * from the database, is only returned if the file exists.
 *
Dries's avatar
Dries committed
827 828 829 830 831 832 833 834 835 836 837 838
 * 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
839
 * @param $type
840
 *   The type of the item (i.e. theme, theme_engine, module, profile).
Dries's avatar
Dries committed
841 842 843 844 845 846 847 848 849
 * @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
850
function drupal_get_filename($type, $name, $filename = NULL) {
851 852
  // The location of files will not change during the request, so do not use
  // drupal_static().
853
  static $files = array(), $dirs = array();
Dries's avatar
Dries committed
854

855
  if (!isset($files[$type])) {
Dries's avatar
Dries committed
856 857 858
    $files[$type] = array();
  }

859
  if (!empty($filename) && file_exists($filename)) {
Dries's avatar
Dries committed
860 861
    $files[$type][$name] = $filename;
  }
862
  elseif (isset($files[$type][$name])) {
Dries's avatar
Dries committed
863 864
    // nothing
  }
Dries's avatar
Dries committed
865
  // Verify that we have an active database connection, before querying
866
  // the database. This is required because this function is called both
Dries's avatar
Dries committed
867 868
  // before we have a database connection (i.e. during installation) and
  // when a database connection fails.
Dries's avatar
Dries committed
869
  else {
870
    try {
871 872
      if (function_exists('db_query')) {
        $file = db_query("SELECT filename FROM {system} WHERE name = :name AND type = :type", array(':name' => $name, ':type' => $type))->fetchField();
873
        if (file_exists(DRUPAL_ROOT . '/' . $file)) {
874 875
          $files[$type][$name] = $file;
        }
876 877
      }
    }
878
    catch (Exception $e) {
879 880 881 882 883 884 885 886 887 888 889
      // 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';
890
        $extension = 'engine';
891 892
      }
      elseif ($type == 'theme') {
893
        $extension = 'info';
894 895
      }
      else {
896
        $extension = $type;
897 898
      }

899 900 901 902 903 904 905 906 907 908 909 910 911
      if (!isset($dirs[$dir][$extension])) {
        $dirs[$dir][$extension] = TRUE;
        if (!function_exists('drupal_system_listing')) {
          require_once DRUPAL_ROOT . '/includes/common.inc';
        }
        // Scan the appropriate directories for all files with the requested
        // extension, not just the file we are currently looking for. This
        // prevents unnecessary scans from being repeated when this function is
        // called more than once in the same page request.
        $matches = drupal_system_listing("/^" . DRUPAL_PHP_FUNCTION_PATTERN . "\.$extension$/", $dir, 'name', 0);
        foreach ($matches as $matched_name => $file) {
          $files[$type][$matched_name] = $file->uri;
        }
Dries's avatar
Dries committed
912 913 914 915
      }
    }
  }

916 917 918
  if (isset($files[$type][$name])) {
    return $files[$type][$name];
  }
Dries's avatar
Dries committed
919 920
}

921 922 923 924 925 926 927
/**
 * Load the persistent variable table.
 *
 * The variable table is composed of values that have been saved in the table
 * with variable_set() as well as those explicitly specified in the configuration
 * file.
 */
928
function variable_initialize($conf = array()) {
929 930
  // NOTE: caching the variables improves performance by 20% when serving
  // cached pages.
931
  if ($cached = cache('bootstrap')->get('variables')) {
932
    $variables = $cached->data;
933 934
  }
  else {
935 936 937 938 939 940 941 942 943 944 945
    // 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());
946
      cache('bootstrap')->set('variables', $variables);
947 948
      lock_release($name);
    }
949 950 951 952
  }

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

955
  return $variables;
956 957
}

958
/**
959 960 961 962 963
 * 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.
964 965 966 967 968
 *
 * @param $name
 *   The name of the variable to return.
 * @param $default
 *   The default value to use if this variable has never been set.
969
 *
970 971
 * @return
 *   The value of the variable.
972
 *
973 974
 * @see variable_del()
 * @see variable_set()
975
 */
976
function variable_get($name, $default = NULL) {
977 978 979 980 981
  global $conf;

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

982
/**
983 984 985 986 987
 * 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.
988 989 990 991 992 993
 *
 * @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.
994
 *
995 996
 * @see variable_del()
 * @see variable_get()
997
 */
998 999 1000
function variable_set($name, $value) {
  global $conf;

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

1003
  cache('bootstrap')->delete('variables');
1004 1005 1006 1007

  $conf[$name] = $value;
}

1008
/**
1009 1010 1011 1012 1013
 * 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.
1014 1015 1016
 *
 * @param $name
 *   The name of the variable to undefine.
1017
 *
1018 1019
 * @see variable_get()
 * @see variable_set()
1020
 */
1021
function variable_del($name) {
Dries's avatar
Dries committed
1022 1023
  global $conf;

1024 1025 1026
  db_delete('variable')
    ->condition('name', $name)
    ->execute();
1027
  cache('bootstrap')->delete('variables');
1028

Dries's avatar
Dries committed
1029
  unset($conf[$name]);
1030 1031
}

1032 1033 1034
/**
 * Retrieve the current page from the cache.
 *
1035 1036 1037 1038 1039
 * 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.
 *
1040 1041 1042 1043
 * @param $check_only
 *   (optional) Set to TRUE to only return whether a previous call found a
 *   cache entry.
 *
1044
 * @return
1045
 *   The cache object, if the page was found in the cache, NULL otherwise.
1046
 */
1047
function drupal_page_get_cache($check_only = FALSE) {
1048
  global $base_root;
1049 1050 1051 1052 1053
  static $cache_hit = FALSE;

  if ($check_only) {
    return $cache_hit;
  }
1054

1055
  if (drupal_page_is_cacheable()) {
1056
    $cache = cache('page')->get($base_root . request_uri());
1057 1058 1059 1060
    if ($cache !== FALSE) {
      $cache_hit = TRUE;
    }
    return $cache;
1061
  }
1062 1063 1064 1065 1066 1067
}

/**
 * Determine the cacheability of the current page.
 *
 * @param $allow_caching
1068 1069
 *   Set to FALSE if you want to prevent this page to get cached.
 *
1070
 * @return
1071
 *   TRUE if the current page can be cached, FALSE otherwise.
1072 1073 1074 1075 1076
 */
function drupal_page_is_cacheable($allow_caching = NULL) {
  $allow_caching_static = &drupal_static(__FUNCTION__, TRUE);
  if (isset($allow_caching)) {
    $allow_caching_static = $allow_caching;
1077
  }
1078 1079

  return $allow_caching_static && ($_SERVER['REQUEST_METHOD'] == 'GET' || $_SERVER['REQUEST_METHOD'] == 'HEAD')
1080
    && !drupal_is_cli();
1081 1082
}

1083
/**
1084
 * Invoke a bootstrap hook in all bootstrap modules that implement it.
1085 1086
 *
 * @param $hook
1087
 *   The name of the bootstrap hook to invoke.
1088 1089
 *
 * @see bootstrap_hooks()
1090 1091
 */
function bootstrap_invoke_all($hook) {
1092
  // Bootstrap modules should have been loaded when this function is called, so
1093 1094 1095 1096 1097 1098
  // we don't need to tell module_list() to reset its internal list (and we
  // therefore leave the first parameter at its default value of FALSE). We
  // still pass in TRUE for the second parameter, though; in case this is the
  // first time during the bootstrap that module_list() is called, we want to
  // make sure that its internal cache is primed with the bootstrap modules
  // only.
1099
  foreach (module_list(FALSE, TRUE) as $module) {
1100 1101 1102 1103 1104
    drupal_load('module', $module);
    module_invoke($module, $hook);
  }
}

Dries's avatar
Dries committed
1105
/**
1106
 * Includes a file with the provided type and name. This prevents
Dries's avatar
Dries committed
1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117
 * including a theme, engine, module, etc., more than once.
 *
 * @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) {
1118 1119 1120
  // 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
1121

1122
  if (isset($files[$type][$name])) {
Dries's avatar
Dries committed
1123 1124 1125 1126 1127 1128
    return TRUE;
  }

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

  if ($filename) {
1129
    include_once DRUPAL_ROOT . '/' . $filename;
Dries's avatar
Dries committed
1130 1131 1132 1133 1134 1135 1136 1137
    $files[$type][$name] = TRUE;

    return TRUE;
  }

  return FALSE;
}

1138 1139 1140 1141 1142 1143 1144
/**
 * Set an HTTP response header for the current page.
 *
 * 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
1145
 *   The HTTP header name, or the special 'Status' header name.
1146
 * @param $value
1147 1148 1149
 *   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".
1150 1151 1152
 * @param $append
 *   Whether to append the value to an existing header or to replace it.
 */
1153
function drupal_add_http_header($name, $value, $append = FALSE) {
1154
  // The headers as name/value pairs.
1155
  $headers = &drupal_static('drupal_http_headers', array());
1156

1157
  $name_lower = strtolower($name);
1158
  _drupal_set_preferred_header_name($name);
1159

1160
  if ($value === FALSE) {
1161
    $headers[$name_lower] = FALSE;
1162
  }
1163
  elseif (isset($headers[$name_lower]) && $append) {
1164 1165
    // Multiple headers with identical names may be combined using comma (RFC
    // 2616, section 4.2).
1166
    $headers[$name_lower] .= ',' . $value;
1167 1168
  }
  else {
1169
    $headers[$name_lower] = $value;
1170
  }
1171
  drupal_send_headers(array($name => $headers[$name_lower]), TRUE);
1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183
}

/**
 * Get the HTTP response headers for the current page.
 *
 * @param $name
 *   An HTTP header name. If omitted, all headers are returned as name/value
 *   pairs. If an array value is FALSE, the header has been unset.
 * @return
 *   A string containing the header value, or FALSE if the header has been set,
 *   or NULL if the header has not been set.
 */
1184
function drupal_get_http_header($name = NULL) {
1185
  $headers = &drupal_static('drupal_http_headers', array());
1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208
  if (isset($name)) {
    $name = strtolower($name);
    return isset($headers[$name]) ? $headers[$name] : NULL;
  }
  else {
    return $headers;
  }
}

/**
 * Header names are case-insensitive, but for maximum compatibility they should
 * follow "common form" (see RFC 2617, section 4.2).
 */
function _drupal_set_preferred_header_name($name = NULL) {
  static $header_names = array();

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

/**
1209
 * Send the HTTP response headers previously set using drupal_add_http_header().
1210
 * Add default headers, unless they have been replaced or unset using
1211
 * drupal_add_http_header().
1212 1213 1214 1215 1216 1217 1218 1219
 *
 * @param $default_headers
 *   An array of headers as name/value pairs.
 * @param $single
 *   If TRUE and headers have already be sent, send only the specified header.
 */
function drupal_send_headers($default_headers = array(), $only_default = FALSE) {
  $headers_sent = &drupal_static(__FUNCTION__, FALSE);
1220
  $headers = drupal_get_http_header();
1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234
  if ($only_default && $headers_sent) {
    $headers = array();
  }
  $headers_sent = TRUE;

  $header_names = _drupal_set_preferred_header_name();
  foreach ($default_headers as $name => $value) {
    $name_lower = strtolower($name);
    if (!isset($headers[$name_lower])) {
      $headers[$name_lower] = $value;
      $header_names[$name_lower] = $name;
    }
  }
  foreach ($headers as $name_lower => $value) {
1235
    if ($name_lower == 'status') {
1236 1237 1238 1239 1240 1241 1242 1243 1244
      header($_SERVER['SERVER_PROTOCOL'] . ' ' . $value);
    }
    // Skip headers that have been unset.
    elseif ($value) {
      header($header_names[$name_lower] . ': ' . $value);
    }
  }
}

1245 1246
/**
 * Set HTTP headers in preparation for a page response.
1247
 *
1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268
 * Authenticated users are always given a 'no-cache' header, and will fetch a
 * fresh page on every request. This prevents authenticated users from seeing
 * locally cached pages.
 *
 * Also give each page a unique ETag. This will force clients to include both
 * an If-Modified-Since header and an If-None-Match header when doing
 * conditional requests for the page (required by RFC 2616, section 13.3.4),
 * making the validation more robust. This is a workaround for a bug in Mozilla
 * Firefox that is triggered when Drupal's caching is enabled and the user
 * accesses Drupal via an HTTP proxy (see
 * https://bugzilla.mozilla.org/show_bug.cgi?id=269303): When an authenticated
 * user requests a page, and then logs out and requests the same page again,
 * Firefox may send a conditional request based on the page that was cached
 * locally when the user was logged in. If this page did not have an ETag
 * header, the request only contains an If-Modified-Since header. The date will
 * be recent, because with authenticated users the Last-Modified header always
 * refers to the time of the request. If the user accesses Drupal via a proxy
 * server, and the proxy already has a cached copy of the anonymous page with an
 * older Last-Modified date, the proxy may respond with 304 Not Modified, making
 * the client think that the anonymous and authenticated pageviews are
 * identical.
Dries's avatar