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

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

8 9 10
/**
 * The current system version.
 */
11
const VERSION = '8.0-dev';
12 13 14 15

/**
 * Core API compatibility.
 */
16
const DRUPAL_CORE_COMPATIBILITY = '8.x';
17 18 19 20

/**
 * Minimum supported version of PHP.
 */
21
const DRUPAL_MINIMUM_PHP = '5.3.2';
22 23 24 25

/**
 * Minimum recommended value of PHP memory_limit.
 */
26
const 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
const CACHE_PERMANENT = 0;
34 35 36 37

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

40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
/**
 * @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.
 */
63
const WATCHDOG_EMERGENCY = 0;
64 65 66 67

/**
 * Log message severity -- Alert: action must be taken immediately.
 */
68
const WATCHDOG_ALERT = 1;
69 70 71 72

/**
 * Log message severity -- Critical: critical conditions.
 */
73
const WATCHDOG_CRITICAL = 2;
74 75 76 77

/**
 * Log message severity -- Error: error conditions.
 */
78
const WATCHDOG_ERROR = 3;
79 80 81 82

/**
 * Log message severity -- Warning: warning conditions.
 */
83
const WATCHDOG_WARNING = 4;
84 85 86 87

/**
 * Log message severity -- Notice: normal but significant condition.
 */
88
const WATCHDOG_NOTICE = 5;
89 90 91 92

/**
 * Log message severity -- Informational: informational messages.
 */
93
const WATCHDOG_INFO = 6;
94 95 96 97

/**
 * Log message severity -- Debug: debug-level messages.
 */
98
const WATCHDOG_DEBUG = 7;
99 100 101 102 103

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

104 105 106
/**
 * First bootstrap phase: initialize configuration.
 */
107
const DRUPAL_BOOTSTRAP_CONFIGURATION = 0;
108 109

/**
110
 * Second bootstrap phase: try to serve a cached page.
111
 */
112
const DRUPAL_BOOTSTRAP_PAGE_CACHE = 1;
113 114 115 116

/**
 * Third bootstrap phase: initialize database layer.
 */
117
const DRUPAL_BOOTSTRAP_DATABASE = 2;
118 119

/**
120
 * Fourth bootstrap phase: initialize the variable system.
121
 */
122
const DRUPAL_BOOTSTRAP_VARIABLES = 3;
123 124

/**
125
 * Fifth bootstrap phase: initialize session handling.
126
 */
127
const DRUPAL_BOOTSTRAP_SESSION = 4;
128 129

/**
130
 * Sixth bootstrap phase: set up the page header.
131
 */
132
const DRUPAL_BOOTSTRAP_PAGE_HEADER = 5;
133 134

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

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

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

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

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

161 162 163 164 165
/**
 * System language (only applicable to UI).
 *
 * Refers to the language used in Drupal and module/theme source code.
 */
166
const LANGUAGE_SYSTEM = 'system';
167

168 169 170
/**
 * The language code used when no language is explicitly assigned.
 *
171
 * Defined by ISO639-2 for "Undetermined".
172
 */
173
const LANGUAGE_NONE = 'und';
174

175
/**
176
 * The type of language used to define the content language.
177
 */
178
const LANGUAGE_TYPE_CONTENT = 'language_content';
179 180

/**
181
 * The type of language used to select the user interface.
182
 */
183
const LANGUAGE_TYPE_INTERFACE = 'language';
184 185

/**
186
 * The type of language used for URLs.
187
 */
188
const LANGUAGE_TYPE_URL = 'language_url';
189

190 191 192
/**
 * Language written left to right. Possible value of $language->direction.
 */
193
const LANGUAGE_LTR = 0;
194 195 196 197

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

200
/**
201
 * Time of the current request in seconds elapsed since the Unix Epoch.
202
 *
203 204 205 206 207 208
 * 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
209
 */
210
define('REQUEST_TIME', (int) $_SERVER['REQUEST_TIME']);
211

212 213 214
/**
 * Flag for drupal_set_title(); text is not sanitized, so run check_plain().
 */
215
const CHECK_PLAIN = 0;
216 217 218 219

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

222
/**
223
 * Signals that the registry lookup cache should be reset.
224
 */
225
const REGISTRY_RESET_LOOKUP_CACHE = 1;
226 227

/**
228
 * Signals that the registry lookup cache should be written to storage.
229
 */
230
const REGISTRY_WRITE_LOOKUP_CACHE = 2;
231

232 233 234 235 236
/**
 * Regular expression to match PHP function names.
 *
 * @see http://php.net/manual/en/language.functions.php
 */
237
const DRUPAL_PHP_FUNCTION_PATTERN = '[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*';
238

239 240
require_once DRUPAL_ROOT . '/includes/config.inc';

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 286 287 288 289 290 291 292 293 294 295 296 297 298
/**
 * 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 {

  /**
299
   * A cid to pass to cache()->set() and cache()->get().
300 301 302 303
   */
  private $cid;

  /**
304
   * A bin to pass to cache()->set() and cache()->get().
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
   */
  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;

330
    if ($cached = cache($bin)->get($this->cid)) {
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 394 395 396 397 398 399 400 401 402 403 404 405 406
     $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)) {
407
      if ($cached = cache($bin)->get($cid)) {
408 409
        $data = $cached->data + $data;
      }
410
      cache($bin)->set($cid, $data);
411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
      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);
    }
  }
}

Dries's avatar
 
Dries committed
430
/**
431 432
 * Start 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
433
 *
434
 * @param $name
Dries's avatar
 
Dries committed
435 436 437 438 439
 *   The name of the timer.
 */
function timer_start($name) {
  global $timers;

440
  $timers[$name]['start'] = microtime(TRUE);
441
  $timers[$name]['count'] = isset($timers[$name]['count']) ? ++$timers[$name]['count'] : 1;
Dries's avatar
 
Dries committed
442 443 444 445 446
}

/**
 * Read the current timer value without stopping the timer.
 *
447
 * @param $name
Dries's avatar
 
Dries committed
448
 *   The name of the timer.
449
 *
Dries's avatar
 
Dries committed
450 451 452 453 454 455
 * @return
 *   The current timer value in ms.
 */
function timer_read($name) {
  global $timers;

456
  if (isset($timers[$name]['start'])) {
457
    $stop = microtime(TRUE);
458
    $diff = round(($stop - $timers[$name]['start']) * 1000, 2);
Dries's avatar
 
Dries committed
459

460 461 462 463
    if (isset($timers[$name]['time'])) {
      $diff += $timers[$name]['time'];
    }
    return $diff;
464
  }
465
  return $timers[$name]['time'];
Dries's avatar
 
Dries committed
466 467 468 469 470
}

/**
 * Stop the timer with the specified name.
 *
471
 * @param $name
Dries's avatar
 
Dries committed
472
 *   The name of the timer.
473
 *
Dries's avatar
 
Dries committed
474
 * @return
475 476
 *   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
477 478 479 480
 */
function timer_stop($name) {
  global $timers;

481 482 483 484 485 486 487 488 489 490
  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']);
491
  }
Dries's avatar
 
Dries committed
492 493 494

  return $timers[$name];
}
495

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

563
  if ($conf && !$reset) {
Dries's avatar
Dries committed
564 565
    return $conf;
  }
Dries's avatar
 
Dries committed
566

567 568 569 570 571
  $script_name = $_SERVER['SCRIPT_NAME'];
  if (!$script_name) {
    $script_name = $_SERVER['SCRIPT_FILENAME'];
  }
  $http_host = $_SERVER['HTTP_HOST'];
572
  $conf = find_conf_path($http_host, $script_name, $require_settings);
573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590
  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
591
  $confdir = 'sites';
592 593 594 595 596 597 598

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

599 600
  $uri = explode('/', $script_name);
  $server = explode('.', implode('.', array_reverse(explode(':', rtrim($http_host, '.')))));
Dries's avatar
Dries committed
601 602 603
  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));
604 605 606 607
      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
608 609 610
        $conf = "$confdir/$dir";
        return $conf;
      }
Dries's avatar
 
Dries committed
611 612
    }
  }
Dries's avatar
Dries committed
613 614
  $conf = "$confdir/default";
  return $conf;
Dries's avatar
 
Dries committed
615 616
}

617 618 619 620 621 622 623 624 625 626 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
/**
 * 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()) {
652
  // Allow the provided URL to override any existing values in $_SERVER.
653 654
  if (isset($variables['url'])) {
    $url = parse_url($variables['url']);
655 656 657 658 659 660
    if (isset($url['host'])) {
      $_SERVER['HTTP_HOST'] = $url['host'];
    }
    if (isset($url['path'])) {
      $_SERVER['SCRIPT_NAME'] = $url['path'];
    }
661 662
    unset($variables['url']);
  }
663 664 665
  // 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.
666
  $defaults = array(
667 668
    'HTTP_HOST' => 'localhost',
    'SCRIPT_NAME' => NULL,
669 670 671
    'REMOTE_ADDR' => '127.0.0.1',
    'REQUEST_METHOD' => 'GET',
    'SERVER_NAME' => NULL,
672
    'SERVER_SOFTWARE' => NULL,
673 674 675 676 677 678
    'HTTP_USER_AGENT' => NULL,
  );
  // Replace elements of the $_SERVER array, as appropriate.
  $_SERVER = $variables + $_SERVER + $defaults;
}

679
/**
680
 * Initialize PHP environment.
681
 */
682
function drupal_environment_initialize() {
683 684
  if (!isset($_SERVER['HTTP_REFERER'])) {
    $_SERVER['HTTP_REFERER'] = '';
685
  }
686 687 688
  if (!isset($_SERVER['SERVER_PROTOCOL']) || ($_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.0' && $_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.1')) {
    $_SERVER['SERVER_PROTOCOL'] = 'HTTP/1.0';
  }
689

690 691 692 693 694 695 696 697 698 699 700 701 702 703 704
  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'] = '';
705 706
  }

707 708 709 710 711 712 713
  // 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();

714 715
  // Enforce E_STRICT, but allow users to set levels not part of E_STRICT.
  error_reporting(E_STRICT | E_ALL | error_reporting());
716

717 718 719
  // 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.
720

721
  // Don't escape quotes when reading files from the database, disk, etc.
722
  ini_set('magic_quotes_runtime', '0');
723 724
  // Use session cookies, not transparent sessions that puts the session id in
  // the query string.
725
  ini_set('session.use_cookies', '1');
726
  ini_set('session.use_only_cookies', '1');
727
  ini_set('session.use_trans_sid', '0');
728 729
  // Don't send HTTP headers using PHP's session handler.
  ini_set('session.cache_limiter', 'none');
730 731
  // Use httponly session cookies.
  ini_set('session.cookie_httponly', '1');
732 733 734 735

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

738
/**
739
 * Validate that a hostname (for example $_SERVER['HTTP_HOST']) is safe.
740 741 742 743
 *
 * @return
 *  TRUE if only containing valid characters, or FALSE otherwise.
 */
744 745
function drupal_valid_http_host($host) {
  return preg_match('/^\[?(?:[a-zA-Z0-9-:\]_]+\.?)+$/', $host);
746 747
}

748
/**
749 750
 * Loads the configuration and sets the base URL, cookie domain, and
 * session name correctly.
751
 */
752
function drupal_settings_initialize() {
753 754
  global $base_url, $base_path, $base_root;

Dries's avatar
Dries committed
755
  // Export the following settings.php variables to the global namespace
756
  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, $drupal_config_directory_name, $drupal_config_key;
Dries's avatar
Dries committed
757 758
  $conf = array();

759 760
  if (file_exists(DRUPAL_ROOT . '/' . conf_path() . '/settings.php')) {
    include_once DRUPAL_ROOT . '/' . conf_path() . '/settings.php';
761
  }
762
  $is_https = isset($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) == 'on';
763 764 765 766

  if (isset($base_url)) {
    // Parse fixed base URL from settings.php.
    $parts = parse_url($base_url);
767
    $http_protocol = $parts['scheme'];
768 769 770
    if (!isset($parts['path'])) {
      $parts['path'] = '';
    }
771
    $base_path = $parts['path'] . '/';
772 773 774 775 776
    // 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
777
    $http_protocol = $is_https ? 'https' : 'http';
778
    $base_root = $http_protocol . '://' . $_SERVER['HTTP_HOST'];
779

780
    $base_url = $base_root;
781 782 783

    // $_SERVER['SCRIPT_NAME'] can, in contrast to $_SERVER['PHP_SELF'], not
    // be modified by a visitor.
784
    if ($dir = rtrim(dirname($_SERVER['SCRIPT_NAME']), '\/')) {
785 786 787 788 789 790 791 792 793
      // 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;
      }
794 795 796 797 798 799 800
      $base_url .= $base_path;
      $base_path .= '/';
    }
    else {
      $base_path = '/';
    }
  }
801 802
  $base_secure_url = str_replace('http://', 'https://', $base_url);
  $base_insecure_url = str_replace('https://', 'http://', $base_url);
803 804 805 806 807 808

  if ($cookie_domain) {
    // If the user specifies the cookie domain, also use it for session name.
    $session_name = $cookie_domain;
  }
  else {
809 810 811
    // 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);
812 813
    // HTTP_HOST can be modified by a visitor, but we already sanitized it
    // in drupal_settings_initialize().
814
    if (!empty($_SERVER['HTTP_HOST'])) {
815
      $cookie_domain = $_SERVER['HTTP_HOST'];
816 817 818 819 820 821 822
      // 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];
823 824 825 826 827 828 829
    }
  }
  // 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);
  }
830 831 832 833 834 835 836 837 838 839
  // 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';
840
  session_name($prefix . substr(hash('sha256', $session_name), 0, 32));
841 842
}

Dries's avatar
Dries committed
843 844
/**
 * Returns and optionally sets the filename for a system item (module,
845
 * theme, etc.). The filename, whether provided, cached, or retrieved
Dries's avatar
Dries committed
846 847
 * from the database, is only returned if the file exists.
 *
Dries's avatar
Dries committed
848 849 850 851 852 853 854 855 856 857 858 859
 * 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
860
 * @param $type
861
 *   The type of the item (i.e. theme, theme_engine, module, profile).
Dries's avatar
Dries committed
862 863 864 865 866 867 868 869 870
 * @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
871
function drupal_get_filename($type, $name, $filename = NULL) {
872 873
  // The location of files will not change during the request, so do not use
  // drupal_static().
874
  static $files = array(), $dirs = array();
Dries's avatar
Dries committed
875

876 877 878 879 880
  // 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;
  }
881
  if (!isset($files[$type])) {
Dries's avatar
Dries committed
882 883 884
    $files[$type] = array();
  }

885
  if (!empty($filename) && file_exists($filename)) {
Dries's avatar
Dries committed
886 887
    $files[$type][$name] = $filename;
  }
888
  elseif (isset($files[$type][$name])) {
Dries's avatar
Dries committed
889 890
    // nothing
  }
Dries's avatar
Dries committed
891
  // Verify that we have an active database connection, before querying
892
  // the database. This is required because this function is called both
Dries's avatar
Dries committed
893 894
  // before we have a database connection (i.e. during installation) and
  // when a database connection fails.
Dries's avatar
Dries committed
895
  else {
896
    try {
897 898
      if (function_exists('db_query')) {
        $file = db_query("SELECT filename FROM {system} WHERE name = :name AND type = :type", array(':name' => $name, ':type' => $type))->fetchField();
899
        if (file_exists(DRUPAL_ROOT . '/' . $file)) {
900 901
          $files[$type][$name] = $file;
        }
902 903
      }
    }
904
    catch (Exception $e) {
905 906 907 908 909 910 911 912 913 914 915
      // 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';
916
        $extension = 'engine';
917 918
      }
      elseif ($type == 'theme') {
919
        $extension = 'info';
920 921
      }
      else {
922
        $extension = $type;
923 924
      }

925 926 927
      if (!isset($dirs[$dir][$extension])) {
        $dirs[$dir][$extension] = TRUE;
        if (!function_exists('drupal_system_listing')) {
928
          require_once DRUPAL_ROOT . '/core/includes/common.inc';
929 930 931 932 933 934 935 936 937
        }
        // 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
938 939 940 941
      }
    }
  }

942 943 944
  if (isset($files[$type][$name])) {
    return $files[$type][$name];
  }
Dries's avatar
Dries committed
945 946
}

Dries's avatar
 
Dries committed
947 948 949 950 951 952 953
/**
 * 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.
 */
954
function variable_initialize($conf = array()) {
955 956
  // NOTE: caching the variables improves performance by 20% when serving
  // cached pages.
957
  if ($cached = cache('bootstrap')->get('variables')) {
958
    $variables = $cached->data;
Dries's avatar
 
Dries committed
959 960
  }
  else {
961 962 963 964 965 966 967 968 969 970 971
    // 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());
972
      cache('bootstrap')->set('variables', $variables);
973 974
      lock_release($name);
    }
Dries's avatar
 
Dries committed
975 976 977 978
  }

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

Dries's avatar
 
Dries committed
981
  return $variables;
Dries's avatar
 
Dries committed
982 983
}

Dries's avatar
 
Dries committed
984
/**
985 986 987 988 989
 * 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
990 991 992 993 994
 *
 * @param $name
 *   The name of the variable to return.
 * @param $default
 *   The default value to use if this variable has never been set.
995
 *
Dries's avatar
 
Dries committed
996 997
 * @return
 *   The value of the variable.
998
 *
999 1000
 * @see variable_del()
 * @see variable_set()
Dries's avatar
 
Dries committed
1001
 */
1002
function variable_get($name, $default = NULL) {
Dries's avatar
 
Dries committed
1003 1004 1005 1006 1007
  global $conf;

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

Dries's avatar
 
Dries committed
1008
/**