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

3
use Drupal\Core\Database\Database;
4
5
use Symfony\Component\ClassLoader\UniversalClassLoader;
use Symfony\Component\ClassLoader\ApcUniversalClassLoader;
6
use Drupal\Core\DependencyInjection\ContainerBuilder;
7
use Symfony\Component\HttpFoundation\Request;
8

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

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

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

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

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

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

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

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

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

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

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

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

/**
92
 * Log message severity -- Normal but significant conditions.
93
 */
94
const WATCHDOG_NOTICE = 5;
95
96

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

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

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

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

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

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

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

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

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

/**
141
 * Seventh bootstrap phase: load code for subsystems and modules.
142
 */
143
const DRUPAL_BOOTSTRAP_CODE = 6;
144
145

/**
146
 * Final bootstrap phase: initialize language, path, theme, and modules.
147
 */
148
const DRUPAL_BOOTSTRAP_FULL = 7;
149

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

gdd's avatar
gdd committed
274
require_once DRUPAL_ROOT . '/core/includes/config.inc';
275

Dries's avatar
   
Dries committed
276
/**
277
278
279
280
 * 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
281
 *
282
 * @param $name
Dries's avatar
   
Dries committed
283
284
285
286
287
 *   The name of the timer.
 */
function timer_start($name) {
  global $timers;

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

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

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

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

/**
317
 * Stops the timer with the specified name.
Dries's avatar
   
Dries committed
318
 *
319
 * @param $name
Dries's avatar
   
Dries committed
320
 *   The name of the timer.
321
 *
Dries's avatar
   
Dries committed
322
 * @return
323
324
 *   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
325
326
327
328
 */
function timer_stop($name) {
  global $timers;

329
330
331
332
333
334
335
336
337
338
  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']);
339
  }
Dries's avatar
   
Dries committed
340
341
342

  return $timers[$name];
}
343

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

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

415
416
417
418
419
  $script_name = $_SERVER['SCRIPT_NAME'];
  if (!$script_name) {
    $script_name = $_SERVER['SCRIPT_FILENAME'];
  }
  $http_host = $_SERVER['HTTP_HOST'];
420
  $conf = find_conf_path($http_host, $script_name, $require_settings);
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
  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
439
  $confdir = 'sites';
440
441
442
443
444
445
446

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

447
448
  $uri = explode('/', $script_name);
  $server = explode('.', implode('.', array_reverse(explode(':', rtrim($http_host, '.')))));
Dries's avatar
Dries committed
449
450
451
  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));
452
453
454
455
      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
456
457
458
        $conf = "$confdir/$dir";
        return $conf;
      }
Dries's avatar
 
Dries committed
459
460
    }
  }
Dries's avatar
Dries committed
461
462
  $conf = "$confdir/default";
  return $conf;
Dries's avatar
 
Dries committed
463
464
}

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

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

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

555
556
  // @todo Refactor with the Symfony Request object.
  _current_path(request_path());
557

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

561
562
563
  // 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.
564

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

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

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

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

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

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

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

624
    $base_url = $base_root;
625

626
627
    // For a request URI of '/index.php/foo', $_SERVER['SCRIPT_NAME'] is
    // '/index.php', whereas $_SERVER['PHP_SELF'] is '/index.php/foo'.
628
    if ($dir = rtrim(dirname($_SERVER['SCRIPT_NAME']), '\/')) {
629
      // Remove "core" directory if present, allowing install.php, update.php,
630
      // and others to auto-detect a base path.
631
632
633
634
635
636
637
      $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;
      }
638
639
640
641
642
643
644
      $base_url .= $base_path;
      $base_path .= '/';
    }
    else {
      $base_path = '/';
    }
  }
645
646
  $base_secure_url = str_replace('http://', 'https://', $base_url);
  $base_insecure_url = str_replace('https://', 'http://', $base_url);
647

648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
  // Determine the path of the script relative to the base path, and add a
  // trailing slash. This is needed for creating URLs to Drupal pages.
  if (!isset($script_path)) {
    $script_path = '';
    // We don't expect scripts outside of the base path, but sanity check
    // anyway.
    if (strpos($_SERVER['SCRIPT_NAME'], $base_path) === 0) {
      $script_path = substr($_SERVER['SCRIPT_NAME'], strlen($base_path)) . '/';
      // If the request URI does not contain the script name, then clean URLs
      // are in effect and the script path can be similarly dropped from URL
      // generation. For servers that don't provide $_SERVER['REQUEST_URI'], we
      // do not know the actual URI requested by the client, and request_uri()
      // returns a URI with the script name, resulting in non-clean URLs unless
      // there's other code that intervenes.
      if (strpos(request_uri(TRUE) . '/', $base_path . $script_path) !== 0) {
        $script_path = '';
      }
      // @todo Temporary BC for install.php, update.php, and other scripts.
      //   - http://drupal.org/node/1547184
      //   - http://drupal.org/node/1546082
      if ($script_path !== 'index.php/') {
        $script_path = '';
      }
    }
  }

674
675
676
677
678
  if ($cookie_domain) {
    // If the user specifies the cookie domain, also use it for session name.
    $session_name = $cookie_domain;
  }
  else {
679
680
681
    // 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);
682
683
    // HTTP_HOST can be modified by a visitor, but we already sanitized it
    // in drupal_settings_initialize().
684
    if (!empty($_SERVER['HTTP_HOST'])) {
685
      $cookie_domain = $_SERVER['HTTP_HOST'];
686
687
688
689
690
691
692
      // 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];
693
694
695
696
697
698
699
    }
  }
  // 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);
  }
700
701
702
703
704
705
706
707
708
709
  // 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';
710
  session_name($prefix . substr(hash('sha256', $session_name), 0, 32));
711
712
}

Dries's avatar
Dries committed
713
/**
714
715
716
717
 * 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
718
 *
Dries's avatar
Dries committed
719
720
721
722
723
724
725
726
727
728
729
730
 * 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
731
 * @param $type
732
 *   The type of the item (i.e. theme, theme_engine, module, profile).
Dries's avatar
Dries committed
733
734
735
736
737
738
739
740
741
 * @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
742
function drupal_get_filename($type, $name, $filename = NULL) {
743
744
  // The location of files will not change during the request, so do not use
  // drupal_static().
745
  static $files = array(), $dirs = array();
Dries's avatar
Dries committed
746

747
748
749
750
751
  // 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;
  }
752
  if (!isset($files[$type])) {
Dries's avatar
Dries committed
753
754
755
    $files[$type] = array();
  }

756
  if (!empty($filename) && file_exists($filename)) {
Dries's avatar
Dries committed
757
758
    $files[$type][$name] = $filename;
  }
759
  elseif (isset($files[$type][$name])) {
Dries's avatar
Dries committed
760
761
    // nothing
  }
Dries's avatar
Dries committed
762
  // Verify that we have an active database connection, before querying
763
  // the database. This is required because this function is called both
Dries's avatar
Dries committed
764
765
  // before we have a database connection (i.e. during installation) and
  // when a database connection fails.
Dries's avatar
Dries committed
766
  else {
767
    try {
768
769
      if (function_exists('db_query')) {
        $file = db_query("SELECT filename FROM {system} WHERE name = :name AND type = :type", array(':name' => $name, ':type' => $type))->fetchField();
770
        if (file_exists(DRUPAL_ROOT . '/' . $file)) {
771
772
          $files[$type][$name] = $file;
        }
773
774
      }
    }
775
    catch (Exception $e) {
776
777
778
779
780
781
782
783
784
785
786
      // 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';
787
        $extension = 'engine';
788
789
      }
      elseif ($type == 'theme') {
790
        $extension = 'info';
791
792
      }
      else {
793
        $extension = $type;
794
795
      }

796
797
798
      if (!isset($dirs[$dir][$extension])) {
        $dirs[$dir][$extension] = TRUE;
        if (!function_exists('drupal_system_listing')) {
799
          require_once DRUPAL_ROOT . '/core/includes/common.inc';
800
801
802
803
804
805
806
807
808
        }
        // 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
809
810
811
812
      }
    }
  }

813
814
815
  if (isset($files[$type][$name])) {
    return $files[$type][$name];
  }
Dries's avatar
Dries committed
816
817
}

Dries's avatar
   
Dries committed
818
/**
819
 * Loads the persistent variable table.
Dries's avatar
   
Dries committed
820
821
 *
 * The variable table is composed of values that have been saved in the table
822
823
 * with variable_set() as well as those explicitly specified in the
 * configuration file.
Dries's avatar
   
Dries committed
824
 */
825
function variable_initialize($conf = array()) {
826
827
  // NOTE: caching the variables improves performance by 20% when serving
  // cached pages.
828
  if ($cached = cache('bootstrap')->get('variables')) {
829
    $variables = $cached->data;
Dries's avatar
   
Dries committed
830
831
  }
  else {
832
833
834
835
836
837
838
839
840
841
842
    // 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());
843
      cache('bootstrap')->set('variables', $variables);
844
845
      lock_release($name);
    }
Dries's avatar
   
Dries committed
846
847
848
849
  }

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

Dries's avatar
   
Dries committed
852
  return $variables;
Dries's avatar
 
Dries committed
853
854
}

Dries's avatar
   
Dries committed
855
/**
856
857
858
859
860
 * 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
861
862
863
864
865
 *
 * @param $name
 *   The name of the variable to return.
 * @param $default
 *   The default value to use if this variable has never been set.
866
 *
Dries's avatar
   
Dries committed
867
 * @return
868
 *   The value of the variable. Unserialization is taken care of as necessary.
869
 *
870
871
 * @see variable_del()
 * @see variable_set()
Dries's avatar
   
Dries committed
872
 */
873
function variable_get($name, $default = NULL) {
Dries's avatar
 
Dries committed
874
875
876
877
878
  global $conf;

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

Dries's avatar
   
Dries committed
879
/**
880
881
882
883
884
 * 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
885
886
887
888
889
890
 *
 * @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.
891
 *
892
893
 * @see variable_del()
 * @see variable_get()
Dries's avatar
   
Dries committed
894
 */
Dries's avatar
 
Dries committed
895
896
897
function variable_set($name, $value) {
  global $conf;

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

900
  cache('bootstrap')->delete('variables');
Dries's avatar
 
Dries committed
901
902
903
904

  $conf[$name] = $value;
}

Dries's avatar
   
Dries committed
905
/**
906
907
908
909
910
 * 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
911
912
913
 *
 * @param $name
 *   The name of the variable to undefine.
914
 *
915
916
 * @see variable_get()
 * @see variable_set()
Dries's avatar
   
Dries committed
917
 */
Dries's avatar
 
Dries committed
918
function variable_del($name) {
Dries's avatar
Dries committed
919
920
  global $conf;

921
922
923
  db_delete('variable')
    ->condition('name', $name)
    ->execute();
924
  cache('bootstrap')->delete('variables');
Dries's avatar
 
Dries committed
925

Dries's avatar
Dries committed
926
  unset($conf[$name]);
Dries's avatar
 
Dries committed
927
928
}

Dries's avatar
   
Dries committed
929
/**
930
 * Retrieves the current page from the cache.
Dries's avatar
   
Dries committed
931
 *
932
933
934
935
936
 * 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.
 *
937
938
939
940
 * @param $check_only
 *   (optional) Set to TRUE to only return whether a previous call found a
 *   cache entry.
 *
941
 * @return
942
 *   The cache object, if the page was found in the cache, NULL otherwise.
Dries's avatar
   
Dries committed
943
 */
944
function drupal_page_get_cache($check_only = FALSE) {
945
  global $base_root;
946
947
948
949
950
  static $cache_hit = FALSE;

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

952
  if (drupal_page_is_cacheable()) {
953
    $cache = cache('page')->get($base_root . request_uri());
954
955
956
957
    if ($cache !== FALSE) {
      $cache_hit = TRUE;
    }
    return $cache;
958
  }
959
960
961
}

/**
962
 * Determines the cacheability of the current page.
963
964
 *
 * @param $allow_caching
965
966
 *   Set to FALSE if you want to prevent this page to get cached.
 *
967
 * @return
968
 *   TRUE if the current page can be cached, FALSE otherwise.
969
970
971
972
973
 */
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
974
  }
975
976

  return $allow_caching_static && ($_SERVER['REQUEST_METHOD'] == 'GET' || $_SERVER['REQUEST_METHOD'] == 'HEAD')
977
    && !drupal_is_cli();
Dries's avatar
 
Dries committed
978
979
}

980
/**
981
 * Invokes a bootstrap hook in all bootstrap modules that implement it.
982
983
 *
 * @param $hook
984
 *   The name of the bootstrap hook to invoke.