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

3
use Drupal\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.2';
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 167 168 169
/**
 * System language (only applicable to UI).
 *
 * Refers to the language used in Drupal and module/theme source code.
 */
170
const LANGUAGE_SYSTEM = 'system';
171

172 173 174
/**
 * The language code used when no language is explicitly assigned.
 *
175
 * Defined by ISO639-2 for "Undetermined".
176
 */
177
const LANGUAGE_NONE = 'und';
178

179
/**
180
 * The type of language used to define the content language.
181
 */
182
const LANGUAGE_TYPE_CONTENT = 'language_content';
183 184

/**
185
 * The type of language used to select the user interface.
186
 */
187
const LANGUAGE_TYPE_INTERFACE = 'language';
188 189

/**
190
 * The type of language used for URLs.
191
 */
192
const LANGUAGE_TYPE_URL = 'language_url';
193

194 195 196
/**
 * Language written left to right. Possible value of $language->direction.
 */
197
const LANGUAGE_LTR = 0;
198 199 200 201

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

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

216 217 218
/**
 * Flag for drupal_set_title(); text is not sanitized, so run check_plain().
 */
219
const CHECK_PLAIN = 0;
220 221 222 223

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

226
/**
227
 * Signals that the registry lookup cache should be reset.
228
 */
229
const REGISTRY_RESET_LOOKUP_CACHE = 1;
230 231

/**
232
 * Signals that the registry lookup cache should be written to storage.
233
 */
234
const REGISTRY_WRITE_LOOKUP_CACHE = 2;
235

236 237 238 239 240
/**
 * Regular expression to match PHP function names.
 *
 * @see http://php.net/manual/en/language.functions.php
 */
241
const DRUPAL_PHP_FUNCTION_PATTERN = '[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*';
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 299 300
/**
 * 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 {

  /**
301
   * A cid to pass to cache()->set() and cache()->get().
302
   */
303
  protected $cid;
304 305

  /**
306
   * A bin to pass to cache()->set() and cache()->get().
307
   */
308
  protected $bin;
309 310 311 312 313 314 315 316 317 318 319 320

  /**
   * 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();

  /**
321
   * Constructs a DrupalCacheArray object.
322 323 324 325 326 327 328 329 330 331
   *
   * @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;

332
    if ($cached = cache($bin)->get($this->cid)) {
333 334 335 336
     $this->storage = $cached->data;
    }
  }

337 338 339
  /**
   * Implements ArrayAccess::offsetExists().
   */
340 341 342 343
  public function offsetExists($offset) {
    return $this->offsetGet($offset) !== NULL;
  }

344 345 346
  /**
   * Implements ArrayAccess::offsetGet().
   */
347 348 349 350 351 352 353 354 355
  public function offsetGet($offset) {
    if (isset($this->storage[$offset]) || array_key_exists($offset, $this->storage)) {
      return $this->storage[$offset];
    }
    else {
      return $this->resolveCacheMiss($offset);
    }
  }

356 357 358
  /**
   * Implements ArrayAccess::offsetSet().
   */
359 360 361 362
  public function offsetSet($offset, $value) {
    $this->storage[$offset] = $value;
  }

363 364 365
  /**
   * Implements ArrayAccess::offsetUnset().
   */
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
  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);

  /**
405
   * Writes a value to the persistent cache immediately.
406 407 408 409 410 411
   *
   * @param $data
   *   The data to write to the persistent cache.
   * @param $lock
   *   Whether to acquire a lock before writing to cache.
   */
412
  protected function set($data, $lock = TRUE) {
413 414
    // Lock cache writes to help avoid stampedes.
    // To implement locking for cache misses, override __construct().
415
    $lock_name = $this->cid . ':' . $this->bin;
416
    if (!$lock || lock_acquire($lock_name)) {
417
      if ($cached = cache($this->bin)->get($this->cid)) {
418 419
        $data = $cached->data + $data;
      }
420
      cache($this->bin)->set($this->cid, $data);
421 422 423 424 425 426
      if ($lock) {
        lock_release($lock_name);
      }
    }
  }

427 428 429
  /**
   * Destructs the DrupalCacheArray object.
   */
430 431 432 433 434 435 436 437
  public function __destruct() {
    $data = array();
    foreach ($this->keysToPersist as $offset => $persist) {
      if ($persist) {
        $data[$offset] = $this->storage[$offset];
      }
    }
    if (!empty($data)) {
438
      $this->set($data);
439 440 441 442
    }
  }
}

Dries's avatar
 
Dries committed
443
/**
444 445 446 447
 * 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
448
 *
449
 * @param $name
Dries's avatar
 
Dries committed
450 451 452 453 454
 *   The name of the timer.
 */
function timer_start($name) {
  global $timers;

455
  $timers[$name]['start'] = microtime(TRUE);
456
  $timers[$name]['count'] = isset($timers[$name]['count']) ? ++$timers[$name]['count'] : 1;
Dries's avatar
 
Dries committed
457 458 459
}

/**
460
 * Reads the current timer value without stopping the timer.
Dries's avatar
 
Dries committed
461
 *
462
 * @param $name
Dries's avatar
 
Dries committed
463
 *   The name of the timer.
464
 *
Dries's avatar
 
Dries committed
465 466 467 468 469 470
 * @return
 *   The current timer value in ms.
 */
function timer_read($name) {
  global $timers;

471
  if (isset($timers[$name]['start'])) {
472
    $stop = microtime(TRUE);
473
    $diff = round(($stop - $timers[$name]['start']) * 1000, 2);
Dries's avatar
 
Dries committed
474

475 476 477 478
    if (isset($timers[$name]['time'])) {
      $diff += $timers[$name]['time'];
    }
    return $diff;
479
  }
480
  return $timers[$name]['time'];
Dries's avatar
 
Dries committed
481 482 483
}

/**
484
 * Stops the timer with the specified name.
Dries's avatar
 
Dries committed
485
 *
486
 * @param $name
Dries's avatar
 
Dries committed
487
 *   The name of the timer.
488
 *
Dries's avatar
 
Dries committed
489
 * @return
490 491
 *   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
492 493 494 495
 */
function timer_stop($name) {
  global $timers;

496 497 498 499 500 501 502 503 504 505
  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']);
506
  }
Dries's avatar
 
Dries committed
507 508 509

  return $timers[$name];
}
510

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

578
  if ($conf && !$reset) {
Dries's avatar
Dries committed
579 580
    return $conf;
  }
Dries's avatar
 
Dries committed
581

582 583 584 585 586
  $script_name = $_SERVER['SCRIPT_NAME'];
  if (!$script_name) {
    $script_name = $_SERVER['SCRIPT_FILENAME'];
  }
  $http_host = $_SERVER['HTTP_HOST'];
587
  $conf = find_conf_path($http_host, $script_name, $require_settings);
588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605
  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
606
  $confdir = 'sites';
607 608 609 610 611 612 613

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

614 615
  $uri = explode('/', $script_name);
  $server = explode('.', implode('.', array_reverse(explode(':', rtrim($http_host, '.')))));
Dries's avatar
Dries committed
616 617 618
  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));
619 620 621 622
      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
623 624 625
        $conf = "$confdir/$dir";
        return $conf;
      }
Dries's avatar
 
Dries committed
626 627
    }
  }
Dries's avatar
Dries committed
628 629
  $conf = "$confdir/default";
  return $conf;
Dries's avatar
 
Dries committed
630 631
}

632
/**
633
 * Sets appropriate server variables needed for command line scripts to work.
634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666
 *
 * 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()) {
667
  // Allow the provided URL to override any existing values in $_SERVER.
668 669
  if (isset($variables['url'])) {
    $url = parse_url($variables['url']);
670 671 672 673 674 675
    if (isset($url['host'])) {
      $_SERVER['HTTP_HOST'] = $url['host'];
    }
    if (isset($url['path'])) {
      $_SERVER['SCRIPT_NAME'] = $url['path'];
    }
676 677
    unset($variables['url']);
  }
678 679 680
  // 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.
681
  $defaults = array(
682 683
    'HTTP_HOST' => 'localhost',
    'SCRIPT_NAME' => NULL,
684 685 686
    'REMOTE_ADDR' => '127.0.0.1',
    'REQUEST_METHOD' => 'GET',
    'SERVER_NAME' => NULL,
687
    'SERVER_SOFTWARE' => NULL,
688 689 690 691 692 693
    'HTTP_USER_AGENT' => NULL,
  );
  // Replace elements of the $_SERVER array, as appropriate.
  $_SERVER = $variables + $_SERVER + $defaults;
}

694
/**
695
 * Initializes the PHP environment.
696
 */
697
function drupal_environment_initialize() {
698 699
  if (!isset($_SERVER['HTTP_REFERER'])) {
    $_SERVER['HTTP_REFERER'] = '';
700
  }
701 702 703
  if (!isset($_SERVER['SERVER_PROTOCOL']) || ($_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.0' && $_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.1')) {
    $_SERVER['SERVER_PROTOCOL'] = 'HTTP/1.0';
  }
704

705 706 707 708 709 710 711 712 713 714 715 716 717 718 719
  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'] = '';
720 721
  }

722 723 724 725 726 727 728
  // 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();

729 730
  // Enforce E_STRICT, but allow users to set levels not part of E_STRICT.
  error_reporting(E_STRICT | E_ALL | error_reporting());
731

732 733 734
  // 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.
735

736
  // Don't escape quotes when reading files from the database, disk, etc.
737
  ini_set('magic_quotes_runtime', '0');
738 739
  // Use session cookies, not transparent sessions that puts the session id in
  // the query string.
740
  ini_set('session.use_cookies', '1');
741
  ini_set('session.use_only_cookies', '1');
742
  ini_set('session.use_trans_sid', '0');
743 744
  // Don't send HTTP headers using PHP's session handler.
  ini_set('session.cache_limiter', 'none');
745 746
  // Use httponly session cookies.
  ini_set('session.cookie_httponly', '1');
747 748 749 750

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

753
/**
754
 * Validates that a hostname (for example $_SERVER['HTTP_HOST']) is safe.
755 756 757 758
 *
 * @return
 *  TRUE if only containing valid characters, or FALSE otherwise.
 */
759 760
function drupal_valid_http_host($host) {
  return preg_match('/^\[?(?:[a-zA-Z0-9-:\]_]+\.?)+$/', $host);
761 762
}

763
/**
764
 * Sets the base URL, cookie domain, and session name from configuration.
765
 */
766
function drupal_settings_initialize() {
767 768
  global $base_url, $base_path, $base_root;

Dries's avatar
Dries committed
769
  // Export the following settings.php variables to the global namespace
770
  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
771 772
  $conf = array();

773 774
  if (file_exists(DRUPAL_ROOT . '/' . conf_path() . '/settings.php')) {
    include_once DRUPAL_ROOT . '/' . conf_path() . '/settings.php';
775
  }
776
  $is_https = isset($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) == 'on';
777 778 779 780

  if (isset($base_url)) {
    // Parse fixed base URL from settings.php.
    $parts = parse_url($base_url);
781
    $http_protocol = $parts['scheme'];
782 783 784
    if (!isset($parts['path'])) {
      $parts['path'] = '';
    }
785
    $base_path = $parts['path'] . '/';
786 787 788 789 790
    // 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
791
    $http_protocol = $is_https ? 'https' : 'http';
792
    $base_root = $http_protocol . '://' . $_SERVER['HTTP_HOST'];
793

794
    $base_url = $base_root;
795 796 797

    // $_SERVER['SCRIPT_NAME'] can, in contrast to $_SERVER['PHP_SELF'], not
    // be modified by a visitor.
798
    if ($dir = rtrim(dirname($_SERVER['SCRIPT_NAME']), '\/')) {
799 800 801 802 803 804 805 806 807
      // 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;
      }
808 809 810 811 812 813 814
      $base_url .= $base_path;
      $base_path .= '/';
    }
    else {
      $base_path = '/';
    }
  }
815 816
  $base_secure_url = str_replace('http://', 'https://', $base_url);
  $base_insecure_url = str_replace('https://', 'http://', $base_url);
817 818 819 820 821 822

  if ($cookie_domain) {
    // If the user specifies the cookie domain, also use it for session name.
    $session_name = $cookie_domain;
  }
  else {
823 824 825
    // 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);
826 827
    // HTTP_HOST can be modified by a visitor, but we already sanitized it
    // in drupal_settings_initialize().
828
    if (!empty($_SERVER['HTTP_HOST'])) {
829
      $cookie_domain = $_SERVER['HTTP_HOST'];
830 831 832 833 834 835 836
      // 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];
837 838 839 840 841 842 843
    }
  }
  // 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);
  }
844 845 846 847 848 849 850 851 852 853
  // 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';
854
  session_name($prefix . substr(hash('sha256', $session_name), 0, 32));
855 856
}

Dries's avatar
Dries committed
857
/**
858 859 860 861
 * 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
862
 *
Dries's avatar
Dries committed
863 864 865 866 867 868 869 870 871 872 873 874
 * 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
875
 * @param $type
876
 *   The type of the item (i.e. theme, theme_engine, module, profile).
Dries's avatar
Dries committed
877 878 879 880 881 882 883 884 885
 * @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
886
function drupal_get_filename($type, $name, $filename = NULL) {
887 888
  // The location of files will not change during the request, so do not use
  // drupal_static().
889
  static $files = array(), $dirs = array();
Dries's avatar
Dries committed
890

891 892 893 894 895
  // 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;
  }
896
  if (!isset($files[$type])) {
Dries's avatar
Dries committed
897 898 899
    $files[$type] = array();
  }

900
  if (!empty($filename) && file_exists($filename)) {
Dries's avatar
Dries committed
901 902
    $files[$type][$name] = $filename;
  }
903
  elseif (isset($files[$type][$name])) {
Dries's avatar
Dries committed
904 905
    // nothing
  }
Dries's avatar
Dries committed
906
  // Verify that we have an active database connection, before querying
907
  // the database. This is required because this function is called both
Dries's avatar
Dries committed
908 909
  // before we have a database connection (i.e. during installation) and
  // when a database connection fails.
Dries's avatar
Dries committed
910
  else {
911
    try {
912 913
      if (function_exists('db_query')) {
        $file = db_query("SELECT filename FROM {system} WHERE name = :name AND type = :type", array(':name' => $name, ':type' => $type))->fetchField();
914
        if (file_exists(DRUPAL_ROOT . '/' . $file)) {
915 916
          $files[$type][$name] = $file;
        }
917 918
      }
    }
919
    catch (Exception $e) {
920 921 922 923 924 925 926 927 928 929 930
      // 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';
931
        $extension = 'engine';
932 933
      }
      elseif ($type == 'theme') {
934
        $extension = 'info';
935 936
      }
      else {
937
        $extension = $type;
938 939
      }

940 941 942
      if (!isset($dirs[$dir][$extension])) {
        $dirs[$dir][$extension] = TRUE;
        if (!function_exists('drupal_system_listing')) {
943
          require_once DRUPAL_ROOT . '/core/includes/common.inc';
944 945 946 947 948 949 950 951 952
        }
        // 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
953 954 955 956
      }
    }
  }

957 958 959
  if (isset($files[$type][$name])) {
    return $files[$type][$name];
  }
Dries's avatar
Dries committed
960 961
}