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

3
use Drupal\Component\Utility\NestedArray;
4
use Drupal\Core\Database\Database;
5
6
use Symfony\Component\ClassLoader\UniversalClassLoader;
use Symfony\Component\ClassLoader\ApcUniversalClassLoader;
7
8
use Symfony\Component\DependencyInjection\Container;
use Symfony\Component\DependencyInjection\ContainerBuilder;
katbailey's avatar
katbailey committed
9
use Symfony\Component\DependencyInjection\Reference;
10
use Symfony\Component\DependencyInjection\Exception\RuntimeException as DependencyInjectionRuntimeException;
11
use Symfony\Component\HttpFoundation\Request;
12
use Drupal\Core\Language\Language;
13

Dries's avatar
   
Dries committed
14
15
16
17
/**
 * @file
 * Functions that need to be loaded on every Drupal request.
 */
Dries's avatar
   
Dries committed
18

19
20
21
/**
 * The current system version.
 */
22
const VERSION = '8.0-dev';
23
24
25
26

/**
 * Core API compatibility.
 */
27
const DRUPAL_CORE_COMPATIBILITY = '8.x';
28
29
30
31

/**
 * Minimum supported version of PHP.
 */
32
const DRUPAL_MINIMUM_PHP = '5.3.3';
33
34
35
36

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

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

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

/**
70
 * Log message severity -- Critical conditions.
71
 */
72
const WATCHDOG_CRITICAL = 2;
73
74

/**
75
 * Log message severity -- Error conditions.
76
 */
77
const WATCHDOG_ERROR = 3;
78
79

/**
80
 * Log message severity -- Warning conditions.
81
 */
82
const WATCHDOG_WARNING = 4;
83
84

/**
85
 * Log message severity -- Normal but significant conditions.
86
 */
87
const WATCHDOG_NOTICE = 5;
88
89

/**
90
 * Log message severity -- Informational messages.
91
 */
92
const WATCHDOG_INFO = 6;
93
94

/**
95
 * Log message severity -- Debug-level messages.
96
 */
97
const WATCHDOG_DEBUG = 7;
98
99
100
101
102

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

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

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

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

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

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

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

/**
134
 * Seventh bootstrap phase: load code for subsystems and modules.
135
 */
136
const DRUPAL_BOOTSTRAP_CODE = 6;
137
138

/**
139
 * Final bootstrap phase: initialize language, path, theme, and modules.
140
 */
141
const DRUPAL_BOOTSTRAP_FULL = 7;
142

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

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

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

160
/**
161
 * Special system language code (only applicable to UI language).
162
 *
163
164
165
166
 * 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.
167
 */
168
const LANGUAGE_SYSTEM = 'system';
169

170
/**
171
 * The language code used when no language is explicitly assigned (yet).
172
 *
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 * 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".
200
 */
201
const LANGUAGE_MULTIPLE = 'mul';
202

203
/**
204
 * The language state when referring to configurable languages.
205
 */
206
207
208
209
210
211
212
213
214
215
216
const LANGUAGE_CONFIGURABLE = 1;

/**
 * The language state when referring to locked languages.
 */
const LANGUAGE_LOCKED = 2;

/**
 * The language state used when referring to all languages.
 */
const LANGUAGE_ALL = 3;
217

218
/**
219
 * The type of language used to define the content language.
220
 */
221
const LANGUAGE_TYPE_CONTENT = 'language_content';
222
223

/**
224
 * The type of language used to select the user interface.
225
 */
226
const LANGUAGE_TYPE_INTERFACE = 'language_interface';
227
228

/**
229
 * The type of language used for URLs.
230
 */
231
const LANGUAGE_TYPE_URL = 'language_url';
232

233
234
235
/**
 * Language written left to right. Possible value of $language->direction.
 */
236
const LANGUAGE_LTR = 0;
237
238
239
240

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

Dave Reid's avatar
Dave Reid committed
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
/**
 * Indicates an error during check for PHP unicode support.
 */
const UNICODE_ERROR = -1;

/**
 * Indicates that standard PHP (emulated) unicode support is being used.
 */
const UNICODE_SINGLEBYTE = 0;

/**
 * Indicates that full unicode support with the PHP mbstring extension is being
 * used.
 */
const UNICODE_MULTIBYTE = 1;

259
/**
260
 * Time of the current request in seconds elapsed since the Unix Epoch.
261
 *
262
263
264
265
266
267
 * 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
268
 */
269
define('REQUEST_TIME', (int) $_SERVER['REQUEST_TIME']);
270

271
272
273
/**
 * Flag for drupal_set_title(); text is not sanitized, so run check_plain().
 */
274
const CHECK_PLAIN = 0;
275
276
277
278

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

281
/**
282
 * Signals that the registry lookup cache should be reset.
283
 */
284
const REGISTRY_RESET_LOOKUP_CACHE = 1;
285
286

/**
287
 * Signals that the registry lookup cache should be written to storage.
288
 */
289
const REGISTRY_WRITE_LOOKUP_CACHE = 2;
290

291
292
293
/**
 * Regular expression to match PHP function names.
 *
294
 * @see http://php.net/manual/language.functions.php
295
 */
296
const DRUPAL_PHP_FUNCTION_PATTERN = '[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*';
297

Dries's avatar
   
Dries committed
298
/**
299
300
301
302
 * 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
303
 *
304
 * @param $name
Dries's avatar
   
Dries committed
305
306
307
308
309
 *   The name of the timer.
 */
function timer_start($name) {
  global $timers;

310
  $timers[$name]['start'] = microtime(TRUE);
311
  $timers[$name]['count'] = isset($timers[$name]['count']) ? ++$timers[$name]['count'] : 1;
Dries's avatar
   
Dries committed
312
313
314
}

/**
315
 * Reads the current timer value without stopping the timer.
Dries's avatar
   
Dries committed
316
 *
317
 * @param $name
Dries's avatar
   
Dries committed
318
 *   The name of the timer.
319
 *
Dries's avatar
   
Dries committed
320
321
322
323
324
325
 * @return
 *   The current timer value in ms.
 */
function timer_read($name) {
  global $timers;

326
  if (isset($timers[$name]['start'])) {
327
    $stop = microtime(TRUE);
328
    $diff = round(($stop - $timers[$name]['start']) * 1000, 2);
Dries's avatar
   
Dries committed
329

330
331
332
333
    if (isset($timers[$name]['time'])) {
      $diff += $timers[$name]['time'];
    }
    return $diff;
334
  }
335
  return $timers[$name]['time'];
Dries's avatar
   
Dries committed
336
337
338
}

/**
339
 * Stops the timer with the specified name.
Dries's avatar
   
Dries committed
340
 *
341
 * @param $name
Dries's avatar
   
Dries committed
342
 *   The name of the timer.
343
 *
Dries's avatar
   
Dries committed
344
 * @return
345
346
 *   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
347
348
349
350
 */
function timer_stop($name) {
  global $timers;

351
352
353
354
355
356
357
358
359
360
  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']);
361
  }
Dries's avatar
   
Dries committed
362
363
364

  return $timers[$name];
}
365

Dries's avatar
   
Dries committed
366
/**
367
 * Returns the appropriate configuration directory.
Dries's avatar
   
Dries committed
368
 *
369
370
371
372
 * Returns the configuration path based on the site's hostname, port, and
 * pathname. Uses find_conf_path() to find the current configuration directory.
 * See default.settings.php for examples on how the URL is converted to a
 * directory.
373
 *
374
 * @param bool $require_settings
375
376
377
378
 *   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.
379
 * @param bool $reset
380
 *   Force a full search for matching directories even if one had been
381
382
 *   found previously. Defaults to FALSE.
 *
383
384
 * @return
 *   The path of the matching directory.
385
386
 *
 * @see default.settings.php
Dries's avatar
   
Dries committed
387
 */
388
function conf_path($require_settings = TRUE, $reset = FALSE) {
389
  $conf = &drupal_static(__FUNCTION__, '');
Dries's avatar
 
Dries committed
390

391
  if ($conf && !$reset) {
Dries's avatar
Dries committed
392
393
    return $conf;
  }
Dries's avatar
 
Dries committed
394

395
396
397
398
399
  $script_name = $_SERVER['SCRIPT_NAME'];
  if (!$script_name) {
    $script_name = $_SERVER['SCRIPT_FILENAME'];
  }
  $http_host = $_SERVER['HTTP_HOST'];
400
  $conf = find_conf_path($http_host, $script_name, $require_settings);
401
402
403
404
405
406
  return $conf;
}

/**
 * Finds the appropriate configuration directory for a given host and path.
 *
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
 * Finds a matching configuration directory file by stripping the website's
 * hostname from left to right and pathname from right to left. By default,
 * the directory must contain a 'settings.php' file for it to match. If the
 * parameter $require_settings is set to FALSE, then a directory without a
 * 'settings.php' file will match as well. The first configuration
 * file found will be used and the remaining ones will be ignored. If no
 * configuration file is found, returns a default value '$confdir/default'. See
 * default.settings.php for examples on how the URL is converted to a directory.
 *
 * If a file named sites.php is present in the $confdir, it will be loaded
 * prior to scanning for directories. That file can define aliases in an
 * associative array named $sites. The array is written in the format
 * '<port>.<domain>.<path>' => 'directory'. As an example, to create a
 * directory alias for http://www.drupal.org:8080/mysite/test whose configuration
 * file is in sites/example.com, the array should be defined as:
 * @code
 * $sites = array(
 *   '8080.www.drupal.org.mysite.test' => 'example.com',
 * );
 * @endcode
 *
428
429
430
431
432
 * @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.
433
434
435
 * @param $require_settings
 *   Defaults to TRUE. If TRUE, then only match directories with a
 *   'settings.php' file. Otherwise match any directory.
436
437
438
439
 *
 * @return
 *   The path of the matching configuration directory.
 *
440
441
 * @see default.settings.php
 * @see example.sites.php
442
443
444
 * @see conf_path()
 */
function find_conf_path($http_host, $script_name, $require_settings = TRUE) {
Dries's avatar
   
Dries committed
445
  $confdir = 'sites';
446
447
448
449
450
451
452

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

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

471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
/**
 * Returns the path of the configuration directory.
 *
 * @return string
 *   The configuration directory path.
 */
function config_get_config_directory() {
  global $config_directory_name;

  if ($test_prefix = drupal_valid_test_ua()) {
    // @see Drupal\simpletest\WebTestBase::setUp()
    $path = conf_path() . '/files/simpletest/' . substr($test_prefix, 10) . '/config';
  }
  else {
    $path = conf_path() . '/files/' . $config_directory_name;
  }
  return $path;
}

490
/**
491
 * Sets appropriate server variables needed for command line scripts to work.
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
 *
 * 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()) {
525
  // Allow the provided URL to override any existing values in $_SERVER.
526
527
  if (isset($variables['url'])) {
    $url = parse_url($variables['url']);
528
529
530
531
532
533
    if (isset($url['host'])) {
      $_SERVER['HTTP_HOST'] = $url['host'];
    }
    if (isset($url['path'])) {
      $_SERVER['SCRIPT_NAME'] = $url['path'];
    }
534
535
    unset($variables['url']);
  }
536
537
538
  // 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.
539
  $defaults = array(
540
541
    'HTTP_HOST' => 'localhost',
    'SCRIPT_NAME' => NULL,
542
543
544
    'REMOTE_ADDR' => '127.0.0.1',
    'REQUEST_METHOD' => 'GET',
    'SERVER_NAME' => NULL,
545
    'SERVER_SOFTWARE' => NULL,
546
547
548
549
550
551
    'HTTP_USER_AGENT' => NULL,
  );
  // Replace elements of the $_SERVER array, as appropriate.
  $_SERVER = $variables + $_SERVER + $defaults;
}

552
/**
553
 * Initializes the PHP environment.
554
 */
555
function drupal_environment_initialize() {
556
557
  if (!isset($_SERVER['HTTP_REFERER'])) {
    $_SERVER['HTTP_REFERER'] = '';
558
  }
559
560
561
  if (!isset($_SERVER['SERVER_PROTOCOL']) || ($_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.0' && $_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.1')) {
    $_SERVER['SERVER_PROTOCOL'] = 'HTTP/1.0';
  }
562

563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
  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'] = '';
578
579
  }

580
581
  // @todo Refactor with the Symfony Request object.
  _current_path(request_path());
582

583
584
  // Enforce E_STRICT, but allow users to set levels not part of E_STRICT.
  error_reporting(E_STRICT | E_ALL | error_reporting());
585

586
587
588
  // 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.
589

Dave Reid's avatar
Dave Reid committed
590
591
592
593
594
595
596
  // Deny execution with enabled "magic quotes" (both GPC and runtime).
  if (get_magic_quotes_gpc() || get_magic_quotes_runtime()) {
    header($_SERVER['SERVER_PROTOCOL'] . ' 500 Internal Server Error');
    print "PHP's 'magic_quotes_gpc' and 'magic_quotes_runtime' settings are not supported and must be disabled.";
    exit;
  }

597
598
  // Use session cookies, not transparent sessions that puts the session id in
  // the query string.
599
  ini_set('session.use_cookies', '1');
600
  ini_set('session.use_only_cookies', '1');
601
  ini_set('session.use_trans_sid', '0');
602
  // Don't send HTTP headers using PHP's session handler.
603
604
  // Send an empty string to disable the cache limiter.
  ini_set('session.cache_limiter', '');
605
606
  // Use httponly session cookies.
  ini_set('session.cookie_httponly', '1');
607
608
609
610

  // Set sane locale settings, to ensure consistent string, dates, times and
  // numbers handling.
  setlocale(LC_ALL, 'C');
Dave Reid's avatar
Dave Reid committed
611
612
613

  // Detect string handling method.
  unicode_check();
614
615
}

616
/**
617
 * Validates that a hostname (for example $_SERVER['HTTP_HOST']) is safe.
618
619
620
621
 *
 * @return
 *  TRUE if only containing valid characters, or FALSE otherwise.
 */
622
623
function drupal_valid_http_host($host) {
  return preg_match('/^\[?(?:[a-zA-Z0-9-:\]_]+\.?)+$/', $host);
624
625
}

Dave Reid's avatar
Dave Reid committed
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
/**
 * Checks for Unicode support in PHP and sets the proper settings if possible.
 *
 * Because Drupal needs to be able to handle text in various encodings, we do
 * not support mbstring function overloading. HTTP input/output conversion must
 * be disabled for similar reasons.
 *
 * @return string
 *   A string identifier of a failed multibyte extension check, if any.
 *   Otherwise, an empty string.
 */
function unicode_check() {
  global $multibyte;

  // Check for mbstring extension.
  if (!function_exists('mb_strlen')) {
    $multibyte = UNICODE_SINGLEBYTE;
    return 'mb_strlen';
  }

  // Check mbstring configuration.
  if (ini_get('mbstring.func_overload') != 0) {
    $multibyte = UNICODE_ERROR;
    return 'mbstring.func_overload';
  }
  if (ini_get('mbstring.encoding_translation') != 0) {
    $multibyte = UNICODE_ERROR;
    return 'mbstring.encoding_translation';
  }
  if (ini_get('mbstring.http_input') != 'pass') {
    $multibyte = UNICODE_ERROR;
    return 'mbstring.http_input';
  }
  if (ini_get('mbstring.http_output') != 'pass') {
    $multibyte = UNICODE_ERROR;
    return 'mbstring.http_output';
  }

  // Set appropriate configuration.
  mb_internal_encoding('utf-8');
  mb_language('uni');
  $multibyte = UNICODE_MULTIBYTE;
  return '';
}

671
/**
672
 * Sets the base URL, cookie domain, and session name from configuration.
673
 */
674
function drupal_settings_initialize() {
675
  global $base_url, $base_path, $base_root, $script_path;
676

677
  // Export these settings.php variables to the global namespace.
678
  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
679
680
  $conf = array();

681
682
683
684
  // Make conf_path() available as local variable in settings.php.
  $conf_path = conf_path();
  if (file_exists(DRUPAL_ROOT . '/' . $conf_path . '/settings.php')) {
    include_once DRUPAL_ROOT . '/' . $conf_path . '/settings.php';
685
  }
686
  $is_https = isset($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) == 'on';
687
688
689
690

  if (isset($base_url)) {
    // Parse fixed base URL from settings.php.
    $parts = parse_url($base_url);
691
    $http_protocol = $parts['scheme'];
692
693
694
    if (!isset($parts['path'])) {
      $parts['path'] = '';
    }
695
    $base_path = $parts['path'] . '/';
696
697
698
699
700
    // 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
701
    $http_protocol = $is_https ? 'https' : 'http';
702
    $base_root = $http_protocol . '://' . $_SERVER['HTTP_HOST'];
703

704
    $base_url = $base_root;
705

706
707
    // For a request URI of '/index.php/foo', $_SERVER['SCRIPT_NAME'] is
    // '/index.php', whereas $_SERVER['PHP_SELF'] is '/index.php/foo'.
708
    if ($dir = rtrim(dirname($_SERVER['SCRIPT_NAME']), '\/')) {
709
      // Remove "core" directory if present, allowing install.php, update.php,
710
      // and others to auto-detect a base path.
711
712
713
714
715
716
717
      $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;
      }
718
719
720
721
722
723
724
      $base_url .= $base_path;
      $base_path .= '/';
    }
    else {
      $base_path = '/';
    }
  }
725
726
  $base_secure_url = str_replace('http://', 'https://', $base_url);
  $base_insecure_url = str_replace('https://', 'http://', $base_url);
727

728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
  // 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 = '';
      }
    }
  }

754
755
756
757
758
  if ($cookie_domain) {
    // If the user specifies the cookie domain, also use it for session name.
    $session_name = $cookie_domain;
  }
  else {
759
760
761
    // 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);
762
763
    // HTTP_HOST can be modified by a visitor, but we already sanitized it
    // in drupal_settings_initialize().
764
    if (!empty($_SERVER['HTTP_HOST'])) {
765
      $cookie_domain = $_SERVER['HTTP_HOST'];
766
767
768
769
770
771
772
      // 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];
773
774
775
776
777
778
779
    }
  }
  // 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);
  }
780
781
782
783
784
785
786
787
788
789
  // 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';
790
  session_name($prefix . substr(hash('sha256', $session_name), 0, 32));
791
792
}

Dries's avatar
Dries committed
793
/**
794
795
796
797
 * 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
798
 *
Dries's avatar
Dries committed
799
800
801
802
803
804
805
806
807
808
809
810
 * 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
811
 * @param $type
812
 *   The type of the item (i.e. theme, theme_engine, module, profile).
Dries's avatar
Dries committed
813
814
815
816
817
818
819
820
821
 * @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
822
function drupal_get_filename($type, $name, $filename = NULL) {
823
824
  // The location of files will not change during the request, so do not use
  // drupal_static().
825
  static $files = array(), $dirs = array();
Dries's avatar
Dries committed
826

827
828
829
  // Profiles are converted into modules in system_rebuild_module_data().
  // @todo Remove false-exposure of profiles as modules.
  $original_type = $type;
830
  if ($type == 'profile') {
831
    $type = 'module';
832
  }
833
  if (!isset($files[$type])) {
Dries's avatar
Dries committed
834
835
836
    $files[$type] = array();
  }

837
  if (!empty($filename) && file_exists($filename)) {
Dries's avatar
Dries committed
838
839
    $files[$type][$name] = $filename;
  }
840
  elseif (isset($files[$type][$name])) {
Dries's avatar
Dries committed
841
842
    // nothing
  }
Dries's avatar
Dries committed
843
  // Verify that we have an active database connection, before querying
844
  // the database. This is required because this function is called both
Dries's avatar
Dries committed
845
846
  // before we have a database connection (i.e. during installation) and
  // when a database connection fails.
Dries's avatar
Dries committed
847
  else {
848
    try {
849
850
      if (function_exists('db_query')) {
        $file = db_query("SELECT filename FROM {system} WHERE name = :name AND type = :type", array(':name' => $name, ':type' => $type))->fetchField();
851
        if ($file && file_exists(DRUPAL_ROOT . '/' . $file)) {
852
853
          $files[$type][$name] = $file;
        }
854
855
      }
    }
856
    catch (Exception $e) {
857
858
859
860
861
862
863
864
865
866
867
      // 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';
868
        $extension = 'engine';
869
870
      }
      elseif ($type == 'theme') {
871
        $extension = 'info';
872
      }
873
874
875
876
877
878
      // Profiles are converted into modules in system_rebuild_module_data().
      // @todo Remove false-exposure of profiles as modules.
      elseif ($original_type == 'profile') {
        $dir = 'profiles';
        $extension = 'profile';
      }
879
      else {
880
        $extension = $type;
881
882
      }

883
884
885
      if (!isset($dirs[$dir][$extension])) {
        $dirs[$dir][$extension] = TRUE;
        if (!function_exists('drupal_system_listing')) {
886
          require_once DRUPAL_ROOT . '/core/includes/common.inc';
887
888
889
890
891
892
893
894
895
        }
        // 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
896
897
898
899
      }
    }
  }

900
901
902
  if (isset($files[$type][$name])) {
    return $files[$type][$name];
  }
Dries's avatar
Dries committed
903
904
}

Dries's avatar
   
Dries committed
905
/**
906
 * Loads the persistent variable table.
Dries's avatar
   
Dries committed
907
908
 *
 * The variable table is composed of values that have been saved in the table
909
910
 * with variable_set() as well as those explicitly specified in the
 * configuration file.
Dries's avatar
   
Dries committed
911
 */
912
function variable_initialize($conf = array()) {
913
914
  // NOTE: caching the variables improves performance by 20% when serving
  // cached pages.
915
  if ($cached = cache('bootstrap')->get('variables')) {
916
    $variables = $cached->data;
Dries's avatar
   
Dries committed
917
918
  }
  else {
919
920
921
922
923
924
925
926
927
928
929
    // 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());
930
      cache('bootstrap')->set('variables', $variables);
931
932
      lock_release($name);
    }
Dries's avatar
   
Dries committed
933
934
935
936
  }

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

Dries's avatar
   
Dries committed
939
  return $variables;
Dries's avatar
 
Dries committed
940
941
}

Dries's avatar
   
Dries committed
942
/**
943
944
945
946
947
 * 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
948
949
950
951
952
 *
 * @param $name
 *   The name of the variable to return.
 * @param $default
 *   The default value to use if this variable has never been set.
953
 *
Dries's avatar
   
Dries committed
954
 * @return
955
 *   The value of the variable. Unserialization is taken care of as necessary.
956
 *
957
958
 * @see variable_del()
 * @see variable_set()
Dries's avatar
   
Dries committed
959
 */
960
function variable_get($name, $default = NULL) {
Dries's avatar
 
Dries committed
961
962
963
964
965
  global $conf;

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

Dries's avatar
   
Dries committed
966
/**
967
968
969
970
971
 * 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
972
973
974
975
976
977
 *
 * @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.
978
 *
979
980
 * @see variable_del()
 * @see variable_get()
Dries's avatar
   
Dries committed
981
 */
Dries's avatar
 
Dries committed
982
983
984
function variable_set($name, $value) {
  global $conf;

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

987
  cache('bootstrap')->delete('variables');
Dries's avatar
 
Dries committed
988
989
990
991

  $conf[$name] = $value;
}

Dries's avatar
   
Dries committed
992
/**
993
994
995
996
997
 * 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
998
999
1000
 *
 * @param $name
 *   The name of the variable to undefine.
1001
 *
1002
1003
 * @see variable_get()
 * @see variable_set()
Dries's avatar
   
Dries committed
1004
 */
Dries's avatar
 
Dries committed
1005
function variable_del($name) {
Dries's avatar
Dries committed
1006
1007
  global $conf;

1008
1009
1010
  db_delete('variable')
    ->condition('name', $name)
    ->execute();
1011
  cache('bootstrap')->delete('variables');
Dries's avatar
 
Dries committed
1012

Dries's avatar
Dries committed
1013
  unset($conf[$name]);
Dries's avatar
 
Dries committed
1014
1015
}

Dries's avatar
   
Dries committed
1016
/**
1017
 * Retrieves the current page from the cache.
Dries's avatar
   
Dries committed
1018
 *
1019
1020
1021
1022
1023
 * 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.
 *
1024
1025
1026
1027
 * @param $check_only
 *   (optional) Set to TRUE to only return whether a previous call found a
 *   cache entry.
 *
1028
 * @return
1029
 *   The cache object, if the page was found in the cache, NULL otherwise.
Dries's avatar
   
Dries committed
1030
 */
1031
function drupal_page_get_cache($check_only = FALSE) {
1032
  global $base_root;
1033
1034
1035
1036
1037
  static $cache_hit = FALSE;

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

1039
  if (drupal_page_is_cacheable()) {
1040
    $cache = cache('page')->get($base_root . request_uri());
1041
1042
1043
1044
    if ($cache !== FALSE) {
      $cache_hit = TRUE;
    }
    return $cache;
1045
  }
1046
1047
1048
}

/**
1049
 * Determines the cacheability of the current page.
1050
1051
 *
 * @param $allow_caching
1052
1053
 *   Set to FALSE if you want to prevent this page to get cached.
 *
1054
 * @return
1055
 *   TRUE if the current page can be cached, FALSE otherwise.
1056
1057
1058
1059
1060
 */
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
1061
  }
1062
1063

  return $allow_caching_static && ($_SERVER['REQUEST_METHOD'] == 'GET' || $_SERVER['REQUEST_METHOD'] == 'HEAD')
1064
    && !drupal_is_cli();
Dries's avatar
 
Dries committed
1065
1066
}

1067
/**