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

3
4
5
use Symfony\Component\ClassLoader\UniversalClassLoader;
use Symfony\Component\ClassLoader\ApcUniversalClassLoader;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  return $timers[$name];
}
509

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

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

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

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

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

631
/**
632
 * Sets appropriate server variables needed for command line scripts to work.
633
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
 *
 * 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()) {
666
  // Allow the provided URL to override any existing values in $_SERVER.
667
668
  if (isset($variables['url'])) {
    $url = parse_url($variables['url']);
669
670
671
672
673
674
    if (isset($url['host'])) {
      $_SERVER['HTTP_HOST'] = $url['host'];
    }
    if (isset($url['path'])) {
      $_SERVER['SCRIPT_NAME'] = $url['path'];
    }
675
676
    unset($variables['url']);
  }
677
678
679
  // 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.
680
  $defaults = array(
681
682
    'HTTP_HOST' => 'localhost',
    'SCRIPT_NAME' => NULL,
683
684
685
    'REMOTE_ADDR' => '127.0.0.1',
    'REQUEST_METHOD' => 'GET',
    'SERVER_NAME' => NULL,
686
    'SERVER_SOFTWARE' => NULL,
687
688
689
690
691
692
    'HTTP_USER_AGENT' => NULL,
  );
  // Replace elements of the $_SERVER array, as appropriate.
  $_SERVER = $variables + $_SERVER + $defaults;
}

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

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

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

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

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

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

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

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

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

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

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

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

793
    $base_url = $base_root;
794
795
796

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

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

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

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

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

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

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

Dries's avatar
   
Dries committed
961
/**
962
 * Loads the persistent variable table.
Dries's avatar
   
Dries committed
963
964
 *
 * The variable table is composed of values that have been saved in the table
965
966
 * with variable_set() as well as those explicitly specified in the
 * configuration file.
Dries's avatar
   
Dries committed
967
 */
968
function variable_initialize($conf = array()) {
969
970
  // NOTE: caching the variables improves performance by 20% when serving
  // cached pages.
971
  if ($cached = cache('bootstrap')->get('variables')) {
972
    $variables = $cached->data;
Dries's avatar
   
Dries committed
973
974
  }
  else {
975
976
977
978
979
980
981
982
983
984
985
    // 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());
986
      cache('bootstrap')->set('variables', $variables);
987
988
      lock_release($name);
    }
Dries's avatar
   
Dries committed
989
990
991
992
  }

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

Dries's avatar
   
Dries committed
995
  return $variables;
Dries's avatar
   
Dries committed
996
997
}

Dries's avatar
   
Dries committed
998
/**
999
1000
1001
1002
1003
 * 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
1004
1005
1006
1007
1008
 *
 * @param $name
 *   The name of the variable to return.
 * @param $default
 *   The default value to use if this variable has never been set.
1009
 *
Dries's avatar
   
Dries committed
1010
1011
 * @return
 *   The value of the variable.
1012
 *
1013
1014
 * @see variable_del()
 * @see variable_set()
Dries's avatar
   
Dries committed
1015
 */
1016
function variable_get($name, $default = NULL) {
Dries's avatar
   
Dries committed
1017
1018
1019
1020
1021
  global $conf;

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

Dries's avatar
   
Dries committed
1022
/**
1023
1024
1025
1026
1027
 * Sets a persistent variable.
 *
 * Case-sensitivity of the variable_* functions depends on the database
 * collation used. To avoid problems, always use lower case for persistent
 * variable names.
Dries's avatar
   
Dries committed
1028
1029
1030
1031
1032
1033
 *
 * @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.
1034
 *
1035
1036
 * @see variable_del()
 * @see variable_get()
Dries's avatar
   
Dries committed
1037
 */
Dries's avatar
   
Dries committed
1038
1039
1040
function variable_set($name, $value) {
  global $conf;

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

1043
  cache('bootstrap')->delete('variables');
Dries's avatar
   
Dries committed
1044
1045
1046
1047

  $conf[$name] = $value;
}

Dries's avatar
   
Dries committed
1048
/**
1049
1050
1051
1052
1053
 * Unsets a persistent variable.
 *
 * Case-sensitivity of the variable_* functions depends on the database
 * collation used. To avoid problems, always use lower case for persistent
 * variable names.
Dries's avatar
   
Dries committed
1054
1055
1056
 *
 * @param $name
 *   The name of the variable to undefine.
1057
 *
1058
1059
 * @see variable_get()
 * @see variable_set()
Dries's avatar
   
Dries committed
1060
 */
Dries's avatar
   
Dries committed
1061
function variable_del($name) {
Dries's avatar
Dries committed
1062
1063
  global $conf;

1064
1065
1066
  db_delete('variable')
    ->condition('name', $name)
    ->execute();
1067
  cache('bootstrap')->delete('variables');
Dries's avatar
   
Dries committed
1068

Dries's avatar
Dries committed
1069
  unset($conf[$name]);
Dries's avatar
   
Dries committed
1070
1071
}

Dries's avatar
   
Dries committed
1072
/**
1073
 * Retrieves the current page from the cache.
Dries's avatar
   
Dries committed
1074
 *
1075
1076
1077
1078
1079
 * 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.
 *
1080
1081
1082
1083
 * @param $check_only
 *   (optional) Set to TRUE to only return whether a previous call found a
 *   cache entry.
 *
1084
 * @return
1085
 *   The cache object, if the page was found in the cache, NULL otherwise.
Dries's avatar
   
Dries committed
1086
 */
1087
function drupal_page_get_cache($check_only = FALSE) {
1088
  global $base_root;
1089
1090
1091
1092
1093
  static $cache_hit = FALSE;

  if ($check_only) {
    return $cache_hit;
  }
Dries's avatar
   
Dries committed
1094

1095
  if (drupal_page_is_cacheable()) {
1096
    $cache = cache('page')->get($base_root . request_uri());
1097
1098
1099
1100
    if ($cache !== FALSE) {
      $cache_hit = TRUE;
    }
    return $cache;
1101
  }
1102
1103
1104
}

/**
1105
 * Determines the cacheability of the current page.
1106
1107
 *
 * @param $allow_caching
1108
1109
 *   Set to FALSE if you want to prevent this page to get cached.
 *
1110
 * @return
1111
 *   TRUE if the current page can be cached, FALSE otherwise.
1112
1113
1114
1115
1116
 */
function drupal_page_is_cacheable($allow_caching = NULL) {
  $allow_caching_static = &drupal_static(__FUNCTION__, TRUE);
  if (isset($allow_caching)) {
    $allow_caching_static = $allow_caching;
Dries's avatar
   
Dries committed