bootstrap.inc 117 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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
/**
 * Error reporting level: display no errors.
 */
const ERROR_REPORTING_HIDE = 'hide';

/**
 * Error reporting level: display errors and warnings.
 */
const ERROR_REPORTING_DISPLAY_SOME = 'some';

/**
 * Error reporting level: display all messages.
 */
const ERROR_REPORTING_DISPLAY_ALL = 'all';

/**
 * Error reporting level: display all messages, plus backtrace information.
 */
const ERROR_REPORTING_DISPLAY_VERBOSE = 'verbose';

59
60
61
62
63
64
/**
 * @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
65
 * defined in RFC 3164, section 4.1.1. PHP supplies predefined LOG_* constants
66
 * for use in the syslog() function, but their values on Windows builds do not
67
 * correspond to RFC 3164. The associated PHP bug report was closed with the
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 * 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.
 */
82
const WATCHDOG_EMERGENCY = 0;
83
84
85
86

/**
 * Log message severity -- Alert: action must be taken immediately.
 */
87
const WATCHDOG_ALERT = 1;
88
89

/**
90
 * Log message severity -- Critical conditions.
91
 */
92
const WATCHDOG_CRITICAL = 2;
93
94

/**
95
 * Log message severity -- Error conditions.
96
 */
97
const WATCHDOG_ERROR = 3;
98
99

/**
100
 * Log message severity -- Warning conditions.
101
 */
102
const WATCHDOG_WARNING = 4;
103
104

/**
105
 * Log message severity -- Normal but significant conditions.
106
 */
107
const WATCHDOG_NOTICE = 5;
108
109

/**
110
 * Log message severity -- Informational messages.
111
 */
112
const WATCHDOG_INFO = 6;
113
114

/**
115
 * Log message severity -- Debug-level messages.
116
 */
117
const WATCHDOG_DEBUG = 7;
118
119
120
121
122

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

123
124
125
/**
 * First bootstrap phase: initialize configuration.
 */
126
const DRUPAL_BOOTSTRAP_CONFIGURATION = 0;
127
128

/**
129
 * Second bootstrap phase: try to serve a cached page.
130
 */
131
const DRUPAL_BOOTSTRAP_PAGE_CACHE = 1;
132
133
134
135

/**
 * Third bootstrap phase: initialize database layer.
 */
136
const DRUPAL_BOOTSTRAP_DATABASE = 2;
137
138

/**
139
 * Fourth bootstrap phase: initialize the variable system.
140
 */
141
const DRUPAL_BOOTSTRAP_VARIABLES = 3;
142
143

/**
144
 * Fifth bootstrap phase: initialize session handling.
145
 */
146
const DRUPAL_BOOTSTRAP_SESSION = 4;
147
148

/**
149
 * Sixth bootstrap phase: set up the page header.
150
 */
151
const DRUPAL_BOOTSTRAP_PAGE_HEADER = 5;
152
153

/**
154
 * Seventh bootstrap phase: load code for subsystems and modules.
155
 */
156
const DRUPAL_BOOTSTRAP_CODE = 6;
157
158

/**
159
 * Final bootstrap phase: initialize language, path, theme, and modules.
160
 */
161
const DRUPAL_BOOTSTRAP_FULL = 7;
162

163
164
165
/**
 * Role ID for anonymous users; should match what's in the "role" table.
 */
166
const DRUPAL_ANONYMOUS_RID = 'anonymous';
167
168
169
170

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

173
/**
174
175
176
 * The number of bytes in a kilobyte.
 *
 * For more information, visit http://en.wikipedia.org/wiki/Kilobyte.
177
 */
178
const DRUPAL_KILOBYTE = 1024;
179

180
/**
181
 * Special system language code (only applicable to UI language).
182
 *
183
184
185
186
 * 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.
187
 */
188
const LANGUAGE_SYSTEM = 'system';
189

190
/**
191
 * The language code used when no language is explicitly assigned (yet).
192
 *
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 * 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".
220
 */
221
const LANGUAGE_MULTIPLE = 'mul';
222

223
/**
224
 * The language state when referring to configurable languages.
225
 */
226
227
228
229
230
231
232
233
234
235
236
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;
237

238
/**
239
 * The type of language used to define the content language.
240
 */
241
const LANGUAGE_TYPE_CONTENT = 'language_content';
242
243

/**
244
 * The type of language used to select the user interface.
245
 */
246
const LANGUAGE_TYPE_INTERFACE = 'language_interface';
247
248

/**
249
 * The type of language used for URLs.
250
 */
251
const LANGUAGE_TYPE_URL = 'language_url';
252

253
254
255
/**
 * Language written left to right. Possible value of $language->direction.
 */
256
const LANGUAGE_LTR = 0;
257
258
259
260

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

Dave Reid's avatar
Dave Reid committed
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
/**
 * 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;

279
/**
280
 * Time of the current request in seconds elapsed since the Unix Epoch.
281
 *
282
283
284
285
286
287
 * 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
288
 */
289
define('REQUEST_TIME', (int) $_SERVER['REQUEST_TIME']);
290

291
292
293
/**
 * Flag for drupal_set_title(); text is not sanitized, so run check_plain().
 */
294
const CHECK_PLAIN = 0;
295
296
297
298

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

301
302
303
/**
 * Regular expression to match PHP function names.
 *
304
 * @see http://php.net/manual/language.functions.php
305
 */
306
const DRUPAL_PHP_FUNCTION_PATTERN = '[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*';
307

308
309
310
311
312
313
314
315
316
317
318
319
320
321
/**
 * $config_directories key for active directory.
 *
 * @see config_get_config_directory
 */
const CONFIG_ACTIVE_DIRECTORY = 'active';

/**
 * $config_directories key for staging directory.
 *
 * @see config_get_config_directory
 */
const CONFIG_STAGING_DIRECTORY = 'staging';

Dries's avatar
   
Dries committed
322
/**
323
324
325
326
 * 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
327
 *
328
 * @param $name
Dries's avatar
   
Dries committed
329
330
331
332
333
 *   The name of the timer.
 */
function timer_start($name) {
  global $timers;

334
  $timers[$name]['start'] = microtime(TRUE);
335
  $timers[$name]['count'] = isset($timers[$name]['count']) ? ++$timers[$name]['count'] : 1;
Dries's avatar
   
Dries committed
336
337
338
}

/**
339
 * Reads the current timer value without stopping the timer.
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
345
346
347
348
349
 * @return
 *   The current timer value in ms.
 */
function timer_read($name) {
  global $timers;

350
  if (isset($timers[$name]['start'])) {
351
    $stop = microtime(TRUE);
352
    $diff = round(($stop - $timers[$name]['start']) * 1000, 2);
Dries's avatar
   
Dries committed
353

354
355
356
357
    if (isset($timers[$name]['time'])) {
      $diff += $timers[$name]['time'];
    }
    return $diff;
358
  }
359
  return $timers[$name]['time'];
Dries's avatar
   
Dries committed
360
361
362
}

/**
363
 * Stops the timer with the specified name.
Dries's avatar
   
Dries committed
364
 *
365
 * @param $name
Dries's avatar
   
Dries committed
366
 *   The name of the timer.
367
 *
Dries's avatar
   
Dries committed
368
 * @return
369
370
 *   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
371
372
373
374
 */
function timer_stop($name) {
  global $timers;

375
376
377
378
379
380
381
382
383
384
  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']);
385
  }
Dries's avatar
   
Dries committed
386
387
388

  return $timers[$name];
}
389

Dries's avatar
   
Dries committed
390
/**
391
 * Returns the appropriate configuration directory.
Dries's avatar
   
Dries committed
392
 *
393
394
395
396
 * 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.
397
 *
398
 * @param bool $require_settings
399
400
401
402
 *   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.
403
 * @param bool $reset
404
 *   Force a full search for matching directories even if one had been
405
406
 *   found previously. Defaults to FALSE.
 *
407
408
 * @return
 *   The path of the matching directory.
409
410
 *
 * @see default.settings.php
Dries's avatar
   
Dries committed
411
 */
412
function conf_path($require_settings = TRUE, $reset = FALSE) {
413
  $conf = &drupal_static(__FUNCTION__, '');
Dries's avatar
 
Dries committed
414

415
  if ($conf && !$reset) {
Dries's avatar
Dries committed
416
417
    return $conf;
  }
Dries's avatar
 
Dries committed
418

419
420
421
422
423
  $script_name = $_SERVER['SCRIPT_NAME'];
  if (!$script_name) {
    $script_name = $_SERVER['SCRIPT_FILENAME'];
  }
  $http_host = $_SERVER['HTTP_HOST'];
424
  $conf = find_conf_path($http_host, $script_name, $require_settings);
425
426
427
428
429
430
  return $conf;
}

/**
 * Finds the appropriate configuration directory for a given host and path.
 *
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
 * 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
 *
452
453
454
455
 * @param $http_host
 *   The hostname and optional port number, e.g. "www.example.com" or
 *   "www.example.com:8080".
 * @param $script_name
456
 *   The part of the URL following the hostname, including the leading slash.
457
458
459
 * @param $require_settings
 *   Defaults to TRUE. If TRUE, then only match directories with a
 *   'settings.php' file. Otherwise match any directory.
460
461
462
463
 *
 * @return
 *   The path of the matching configuration directory.
 *
464
465
 * @see default.settings.php
 * @see example.sites.php
466
467
468
 * @see conf_path()
 */
function find_conf_path($http_host, $script_name, $require_settings = TRUE) {
469
470
471
472
  // Determine whether multi-site functionality is enabled.
  if (!file_exists(DRUPAL_ROOT . '/sites/sites.php')) {
    return 'sites/default';
  }
473
474

  $sites = array();
475
  include DRUPAL_ROOT . '/sites/sites.php';
476

477
478
  $uri = explode('/', $script_name);
  $server = explode('.', implode('.', array_reverse(explode(':', rtrim($http_host, '.')))));
Dries's avatar
Dries committed
479
480
481
  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));
482
      if (isset($sites[$dir]) && file_exists(DRUPAL_ROOT . '/sites/' . $sites[$dir])) {
483
484
        $dir = $sites[$dir];
      }
485
486
      if (file_exists(DRUPAL_ROOT . '/sites/' . $dir . '/settings.php') || (!$require_settings && file_exists(DRUPAL_ROOT . '/sites/' . $dir))) {
        return "sites/$dir";
Dries's avatar
Dries committed
487
      }
Dries's avatar
 
Dries committed
488
489
    }
  }
490
  return 'sites/default';
Dries's avatar
 
Dries committed
491
492
}

493
/**
494
495
496
497
498
 * Returns the path of a configuration directory.
 *
 * @param string $type
 *   (optional) The type of config directory to return. Drupal core provides
 *   'active' and 'staging'. Defaults to CONFIG_ACTIVE_DIRECTORY.
499
500
501
502
 *
 * @return string
 *   The configuration directory path.
 */
503
504
function config_get_config_directory($type = CONFIG_ACTIVE_DIRECTORY) {
  global $config_directories;
505
506
507

  if ($test_prefix = drupal_valid_test_ua()) {
    // @see Drupal\simpletest\WebTestBase::setUp()
508
509
510
    $path = conf_path() . '/files/simpletest/' . substr($test_prefix, 10) . '/config_' . $type;
  }
  elseif (!empty($config_directories[$type])) {
511
    $path = conf_path() . '/files/' . $config_directories[$type];
512
513
  }
  else {
514
    throw new Exception(format_string('The configuration directory type %type does not exist.', array('%type' => $type)));
515
516
517
518
  }
  return $path;
}

519
/**
520
 * Sets appropriate server variables needed for command line scripts to work.
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
 *
 * 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()) {
554
  // Allow the provided URL to override any existing values in $_SERVER.
555
556
  if (isset($variables['url'])) {
    $url = parse_url($variables['url']);
557
558
559
560
561
562
    if (isset($url['host'])) {
      $_SERVER['HTTP_HOST'] = $url['host'];
    }
    if (isset($url['path'])) {
      $_SERVER['SCRIPT_NAME'] = $url['path'];
    }
563
564
    unset($variables['url']);
  }
565
566
567
  // 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.
568
  $defaults = array(
569
570
    'HTTP_HOST' => 'localhost',
    'SCRIPT_NAME' => NULL,
571
572
573
    'REMOTE_ADDR' => '127.0.0.1',
    'REQUEST_METHOD' => 'GET',
    'SERVER_NAME' => NULL,
574
    'SERVER_SOFTWARE' => NULL,
575
576
577
578
579
580
    'HTTP_USER_AGENT' => NULL,
  );
  // Replace elements of the $_SERVER array, as appropriate.
  $_SERVER = $variables + $_SERVER + $defaults;
}

581
/**
582
 * Initializes the PHP environment.
583
 */
584
function drupal_environment_initialize() {
585
586
  if (!isset($_SERVER['HTTP_REFERER'])) {
    $_SERVER['HTTP_REFERER'] = '';
587
  }
588
589
590
  if (!isset($_SERVER['SERVER_PROTOCOL']) || ($_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.0' && $_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.1')) {
    $_SERVER['SERVER_PROTOCOL'] = 'HTTP/1.0';
  }
591

592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
  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'] = '';
607
608
  }

609
610
  // @todo Refactor with the Symfony Request object.
  _current_path(request_path());
611

612
613
  // Enforce E_STRICT, but allow users to set levels not part of E_STRICT.
  error_reporting(E_STRICT | E_ALL | error_reporting());
614

615
616
617
  // 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.
618

Dave Reid's avatar
Dave Reid committed
619
620
621
622
623
624
625
  // 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;
  }

626
627
  // Use session cookies, not transparent sessions that puts the session id in
  // the query string.
628
  ini_set('session.use_cookies', '1');
629
  ini_set('session.use_only_cookies', '1');
630
  ini_set('session.use_trans_sid', '0');
631
  // Don't send HTTP headers using PHP's session handler.
632
633
  // Send an empty string to disable the cache limiter.
  ini_set('session.cache_limiter', '');
634
635
  // Use httponly session cookies.
  ini_set('session.cookie_httponly', '1');
636
637
638
639

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

  // Detect string handling method.
  unicode_check();
643
644
}

645
/**
646
 * Validates that a hostname (for example $_SERVER['HTTP_HOST']) is safe.
647
648
649
650
 *
 * @return
 *  TRUE if only containing valid characters, or FALSE otherwise.
 */
651
652
function drupal_valid_http_host($host) {
  return preg_match('/^\[?(?:[a-zA-Z0-9-:\]_]+\.?)+$/', $host);
653
654
}

Dave Reid's avatar
Dave Reid committed
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
/**
 * 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 '';
}

700
/**
701
 * Sets the base URL, cookie domain, and session name from configuration.
702
 */
703
function drupal_settings_initialize() {
704
  global $base_url, $base_path, $base_root, $script_path;
705

706
  // Export these settings.php variables to the global namespace.
707
  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_directories;
Dries's avatar
Dries committed
708
709
  $conf = array();

710
711
712
713
  // 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';
714
  }
715
  $is_https = isset($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) == 'on';
716
717
718
719

  if (isset($base_url)) {
    // Parse fixed base URL from settings.php.
    $parts = parse_url($base_url);
720
    $http_protocol = $parts['scheme'];
721
722
723
    if (!isset($parts['path'])) {
      $parts['path'] = '';
    }
724
    $base_path = $parts['path'] . '/';
725
726
727
728
729
    // 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
730
    $http_protocol = $is_https ? 'https' : 'http';
731
    $base_root = $http_protocol . '://' . $_SERVER['HTTP_HOST'];
732

733
    $base_url = $base_root;
734

735
736
    // For a request URI of '/index.php/foo', $_SERVER['SCRIPT_NAME'] is
    // '/index.php', whereas $_SERVER['PHP_SELF'] is '/index.php/foo'.
737
    if ($dir = rtrim(dirname($_SERVER['SCRIPT_NAME']), '\/')) {
738
      // Remove "core" directory if present, allowing install.php, update.php,
739
      // and others to auto-detect a base path.
740
741
742
743
744
745
746
      $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;
      }
747
748
749
750
751
752
753
      $base_url .= $base_path;
      $base_path .= '/';
    }
    else {
      $base_path = '/';
    }
  }
754
755
  $base_secure_url = str_replace('http://', 'https://', $base_url);
  $base_insecure_url = str_replace('https://', 'http://', $base_url);
756

757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
  // 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 = '';
      }
    }
  }

783
784
785
786
787
  if ($cookie_domain) {
    // If the user specifies the cookie domain, also use it for session name.
    $session_name = $cookie_domain;
  }
  else {
788
    // Otherwise use $base_url as session name, without the protocol
789
    // to use the same session identifiers across HTTP and HTTPS.
790
    list( , $session_name) = explode('://', $base_url, 2);
791
792
    // HTTP_HOST can be modified by a visitor, but we already sanitized it
    // in drupal_settings_initialize().
793
    if (!empty($_SERVER['HTTP_HOST'])) {
794
      $cookie_domain = $_SERVER['HTTP_HOST'];
795
796
797
798
799
800
801
      // 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];
802
803
804
805
806
807
808
    }
  }
  // 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);
  }
809
810
811
812
813
814
815
816
817
818
  // 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';
819
  session_name($prefix . substr(hash('sha256', $session_name), 0, 32));
820
821
}

Dries's avatar
Dries committed
822
/**
823
824
825
826
 * 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
827
 *
Dries's avatar
Dries committed
828
829
830
831
832
 * 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:
 *
833
 * core/modules/foo/foo.module
Dries's avatar
Dries committed
834
835
836
837
838
839
 * 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
840
 * @param $type
841
 *   The type of the item (i.e. theme, theme_engine, module, profile).
Dries's avatar
Dries committed
842
843
844
845
846
847
848
849
850
 * @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
851
function drupal_get_filename($type, $name, $filename = NULL) {
852
853
  // The location of files will not change during the request, so do not use
  // drupal_static().
854
  static $files = array(), $dirs = array();
Dries's avatar
Dries committed
855

856
857
858
  // Profiles are converted into modules in system_rebuild_module_data().
  // @todo Remove false-exposure of profiles as modules.
  $original_type = $type;
859
  if ($type == 'profile') {
860
    $type = 'module';
861
  }
862
  if (!isset($files[$type])) {
Dries's avatar
Dries committed
863
864
865
    $files[$type] = array();
  }

866
  if (!empty($filename) && file_exists($filename)) {
Dries's avatar
Dries committed
867
868
    $files[$type][$name] = $filename;
  }
869
  elseif (isset($files[$type][$name])) {
Dries's avatar
Dries committed
870
871
    // nothing
  }
Dries's avatar
Dries committed
872
  // Verify that we have an active database connection, before querying
873
  // the database. This is required because this function is called both
Dries's avatar
Dries committed
874
875
  // before we have a database connection (i.e. during installation) and
  // when a database connection fails.
Dries's avatar
Dries committed
876
  else {
877
    try {
878
879
      if (function_exists('db_query')) {
        $file = db_query("SELECT filename FROM {system} WHERE name = :name AND type = :type", array(':name' => $name, ':type' => $type))->fetchField();
880
        if ($file && file_exists(DRUPAL_ROOT . '/' . $file)) {
881
882
          $files[$type][$name] = $file;
        }
883
884
      }
    }
885
    catch (Exception $e) {
886
887
888
889
890
891
892
893
894
895
896
      // 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';
897
        $extension = 'engine';
898
899
      }
      elseif ($type == 'theme') {
900
        $extension = 'info';
901
      }
902
903
904
905
906
907
      // 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';
      }
908
      else {
909
        $extension = $type;
910
911
      }

912
913
914
      if (!isset($dirs[$dir][$extension])) {
        $dirs[$dir][$extension] = TRUE;
        if (!function_exists('drupal_system_listing')) {
915
          require_once DRUPAL_ROOT . '/core/includes/common.inc';
916
917
918
919
920
921
922
923
924
        }
        // 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
925
926
927
928
      }
    }
  }

929
930
931
  if (isset($files[$type][$name])) {
    return $files[$type][$name];
  }
Dries's avatar
Dries committed
932
933
}

Dries's avatar
   
Dries committed
934
/**
935
 * Loads the persistent variable table.
Dries's avatar
   
Dries committed
936
937
 *
 * The variable table is composed of values that have been saved in the table
938
939
 * with variable_set() as well as those explicitly specified in the
 * configuration file.
Dries's avatar
   
Dries committed
940
 */
941
function variable_initialize($conf = array()) {
942
943
  // NOTE: caching the variables improves performance by 20% when serving
  // cached pages.
944
  if ($cached = cache('bootstrap')->get('variables')) {
945
    $variables = $cached->data;
Dries's avatar
   
Dries committed
946
947
  }
  else {
948
949
950
951
952
953
954
955
956
957
958
    // 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());
959
      cache('bootstrap')->set('variables', $variables);
960
961
      lock_release($name);
    }
Dries's avatar
   
Dries committed
962
963
964
965
  }

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

Dries's avatar
   
Dries committed
968
  return $variables;
Dries's avatar
 
Dries committed
969
970
}

Dries's avatar
   
Dries committed
971
/**
972
973
974
975
976
 * 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
977
978
979
980
981
 *
 * @param $name
 *   The name of the variable to return.
 * @param $default
 *   The default value to use if this variable has never been set.
982
 *
Dries's avatar
   
Dries committed
983
 * @return
984
 *   The value of the variable. Unserialization is taken care of as necessary.
985
 *
986
987
 * @see variable_del()
 * @see variable_set()
Dries's avatar
   
Dries committed
988
 */
989
function variable_get($name, $default = NULL) {
Dries's avatar
 
Dries committed
990
991
992
993
994
  global $conf;

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

Dries's avatar
   
Dries committed
995
/**
996
997
998
999
1000
 * 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.
For faster browsing, not all history is shown. View entire blame