bootstrap.inc 116 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
use Drupal\Core\DependencyInjection\ContainerBuilder;
8
use Symfony\Component\HttpFoundation\Request;
9
use Drupal\Core\Language\Language;
10

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

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

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

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

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

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

43
44
45
46
47
48
/**
 * @defgroup logging_severity_levels Logging severity levels
 * @{
 * Logging severity levels as defined in RFC 3164.
 *
 * The WATCHDOG_* constant definitions correspond to the logging severity levels
49
 * defined in RFC 3164, section 4.1.1. PHP supplies predefined LOG_* constants
50
 * for use in the syslog() function, but their values on Windows builds do not
51
 * correspond to RFC 3164. The associated PHP bug report was closed with the
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 * comment, "And it's also not a bug, as Windows just have less log levels,"
 * and "So the behavior you're seeing is perfectly normal."
 *
 * @see http://www.faqs.org/rfcs/rfc3164.html
 * @see http://bugs.php.net/bug.php?id=18090
 * @see http://php.net/manual/function.syslog.php
 * @see http://php.net/manual/network.constants.php
 * @see watchdog()
 * @see watchdog_severity_levels()
 */

/**
 * Log message severity -- Emergency: system is unusable.
 */
66
const WATCHDOG_EMERGENCY = 0;
67
68
69
70

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

/**
74
 * Log message severity -- Critical conditions.
75
 */
76
const WATCHDOG_CRITICAL = 2;
77
78

/**
79
 * Log message severity -- Error conditions.
80
 */
81
const WATCHDOG_ERROR = 3;
82
83

/**
84
 * Log message severity -- Warning conditions.
85
 */
86
const WATCHDOG_WARNING = 4;
87
88

/**
89
 * Log message severity -- Normal but significant conditions.
90
 */
91
const WATCHDOG_NOTICE = 5;
92
93

/**
94
 * Log message severity -- Informational messages.
95
 */
96
const WATCHDOG_INFO = 6;
97
98

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

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

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

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

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

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

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

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

/**
138
 * Seventh bootstrap phase: load code for subsystems and modules.
139
 */
140
const DRUPAL_BOOTSTRAP_CODE = 6;
141
142

/**
143
 * Final bootstrap phase: initialize language, path, theme, and modules.
144
 */
145
const DRUPAL_BOOTSTRAP_FULL = 7;
146

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

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

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

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

174
/**
175
 * The language code used when no language is explicitly assigned (yet).
176
 *
177
178
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
 * 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".
204
 */
205
const LANGUAGE_MULTIPLE = 'mul';
206

207
/**
208
 * The language state when referring to configurable languages.
209
 */
210
211
212
213
214
215
216
217
218
219
220
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;
221

222
/**
223
 * The type of language used to define the content language.
224
 */
225
const LANGUAGE_TYPE_CONTENT = 'language_content';
226
227

/**
228
 * The type of language used to select the user interface.
229
 */
230
const LANGUAGE_TYPE_INTERFACE = 'language_interface';
231
232

/**
233
 * The type of language used for URLs.
234
 */
235
const LANGUAGE_TYPE_URL = 'language_url';
236

237
238
239
/**
 * Language written left to right. Possible value of $language->direction.
 */
240
const LANGUAGE_LTR = 0;
241
242
243
244

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

Dave Reid's avatar
Dave Reid committed
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
/**
 * 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;

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

275
276
277
/**
 * Flag for drupal_set_title(); text is not sanitized, so run check_plain().
 */
278
const CHECK_PLAIN = 0;
279
280
281
282

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

285
/**
286
 * Signals that the registry lookup cache should be reset.
287
 */
288
const REGISTRY_RESET_LOOKUP_CACHE = 1;
289
290

/**
291
 * Signals that the registry lookup cache should be written to storage.
292
 */
293
const REGISTRY_WRITE_LOOKUP_CACHE = 2;
294

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

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

314
  $timers[$name]['start'] = microtime(TRUE);
315
  $timers[$name]['count'] = isset($timers[$name]['count']) ? ++$timers[$name]['count'] : 1;
Dries's avatar
   
Dries committed
316
317
318
}

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

330
  if (isset($timers[$name]['start'])) {
331
    $stop = microtime(TRUE);
332
    $diff = round(($stop - $timers[$name]['start']) * 1000, 2);
Dries's avatar
   
Dries committed
333

334
335
336
337
    if (isset($timers[$name]['time'])) {
      $diff += $timers[$name]['time'];
    }
    return $diff;
338
  }
339
  return $timers[$name]['time'];
Dries's avatar
   
Dries committed
340
341
342
}

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

355
356
357
358
359
360
361
362
363
364
  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']);
365
  }
Dries's avatar
   
Dries committed
366
367
368

  return $timers[$name];
}
369

Dries's avatar
   
Dries committed
370
/**
371
 * Finds the appropriate configuration directory.
Dries's avatar
   
Dries committed
372
 *
373
 * Finds a matching configuration directory by stripping the website's
374
 * hostname from left to right and pathname from right to left. The first
375
376
 * 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
377
 *
378
379
 * 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
380
 *
381
382
383
384
 * - $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
385
 *
386
387
388
389
 * - $confdir/8080.www.example.com.mysite
 * - $confdir/www.example.com.mysite
 * - $confdir/example.com.mysite
 * - $confdir/com.mysite
Dries's avatar
   
Dries committed
390
 *
391
392
393
394
 * - $confdir/8080.www.example.com
 * - $confdir/www.example.com
 * - $confdir/example.com
 * - $confdir/com
Dries's avatar
   
Dries committed
395
 *
396
 * - $confdir/default
397
 *
398
 * If a file named sites.php is present in the $confdir, it will be loaded
399
400
 * prior to scanning for directories. It should define an associative array
 * named $sites, which maps domains to directories. It should be in the form
401
 * of:
402
 * @code
403
404
405
 * $sites = array(
 *   'The url to alias' => 'A directory within the sites directory'
 * );
406
 * @endcode
407
 * For example:
408
 * @code
409
410
 * $sites = array(
 *   'devexample.com' => 'example.com',
411
 *   'localhost.example' => 'example.com',
412
 * );
413
 * @endcode
414
415
416
417
 * 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
418
 * domain of the live server. Since Drupal stores file paths into the database
419
420
421
 * (files, system table, etc.) this will ensure the paths are correct while
 * accessed on development servers.
 *
422
 * @param bool $require_settings
423
424
425
426
 *   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.
427
 * @param bool $reset
428
 *   Force a full search for matching directories even if one had been
429
430
 *   found previously. Defaults to FALSE.
 *
431
432
 * @return
 *   The path of the matching directory.
Dries's avatar
   
Dries committed
433
 */
434
function conf_path($require_settings = TRUE, $reset = FALSE) {
435
  $conf = &drupal_static(__FUNCTION__, '');
Dries's avatar
 
Dries committed
436

437
  if ($conf && !$reset) {
Dries's avatar
Dries committed
438
439
    return $conf;
  }
Dries's avatar
 
Dries committed
440

441
442
443
444
445
  $script_name = $_SERVER['SCRIPT_NAME'];
  if (!$script_name) {
    $script_name = $_SERVER['SCRIPT_FILENAME'];
  }
  $http_host = $_SERVER['HTTP_HOST'];
446
  $conf = find_conf_path($http_host, $script_name, $require_settings);
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
  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
465
  $confdir = 'sites';
466
467
468
469
470
471
472

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

473
474
  $uri = explode('/', $script_name);
  $server = explode('.', implode('.', array_reverse(explode(':', rtrim($http_host, '.')))));
Dries's avatar
Dries committed
475
476
477
  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));
478
479
480
481
      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
482
483
484
        $conf = "$confdir/$dir";
        return $conf;
      }
Dries's avatar
 
Dries committed
485
486
    }
  }
Dries's avatar
Dries committed
487
488
  $conf = "$confdir/default";
  return $conf;
Dries's avatar
 
Dries committed
489
490
}

491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
/**
 * 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;
}

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

572
/**
573
 * Initializes the PHP environment.
574
 */
575
function drupal_environment_initialize() {
576
577
  if (!isset($_SERVER['HTTP_REFERER'])) {
    $_SERVER['HTTP_REFERER'] = '';
578
  }
579
580
581
  if (!isset($_SERVER['SERVER_PROTOCOL']) || ($_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.0' && $_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.1')) {
    $_SERVER['SERVER_PROTOCOL'] = 'HTTP/1.0';
  }
582

583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
  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'] = '';
598
599
  }

600
601
  // @todo Refactor with the Symfony Request object.
  _current_path(request_path());
602

603
604
  // Enforce E_STRICT, but allow users to set levels not part of E_STRICT.
  error_reporting(E_STRICT | E_ALL | error_reporting());
605

606
607
608
  // 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.
609

Dave Reid's avatar
Dave Reid committed
610
611
612
613
614
615
616
  // 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;
  }

617
618
  // Use session cookies, not transparent sessions that puts the session id in
  // the query string.
619
  ini_set('session.use_cookies', '1');
620
  ini_set('session.use_only_cookies', '1');
621
  ini_set('session.use_trans_sid', '0');
622
  // Don't send HTTP headers using PHP's session handler.
623
624
  // Send an empty string to disable the cache limiter.
  ini_set('session.cache_limiter', '');
625
626
  // Use httponly session cookies.
  ini_set('session.cookie_httponly', '1');
627
628
629
630

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

  // Detect string handling method.
  unicode_check();
634
635
}

636
/**
637
 * Validates that a hostname (for example $_SERVER['HTTP_HOST']) is safe.
638
639
640
641
 *
 * @return
 *  TRUE if only containing valid characters, or FALSE otherwise.
 */
642
643
function drupal_valid_http_host($host) {
  return preg_match('/^\[?(?:[a-zA-Z0-9-:\]_]+\.?)+$/', $host);
644
645
}

Dave Reid's avatar
Dave Reid committed
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
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
/**
 * 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 '';
}

691
/**
692
 * Sets the base URL, cookie domain, and session name from configuration.
693
 */
694
function drupal_settings_initialize() {
695
  global $base_url, $base_path, $base_root, $script_path;
696

Dries's avatar
Dries committed
697
  // Export the following settings.php variables to the global namespace
698
  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
699
700
  $conf = array();

701
702
703
704
  // 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';
705
  }
706
  $is_https = isset($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) == 'on';
707
708
709
710

  if (isset($base_url)) {
    // Parse fixed base URL from settings.php.
    $parts = parse_url($base_url);
711
    $http_protocol = $parts['scheme'];
712
713
714
    if (!isset($parts['path'])) {
      $parts['path'] = '';
    }
715
    $base_path = $parts['path'] . '/';
716
717
718
719
720
    // 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
721
    $http_protocol = $is_https ? 'https' : 'http';
722
    $base_root = $http_protocol . '://' . $_SERVER['HTTP_HOST'];
723

724
    $base_url = $base_root;
725

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

748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
  // 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 = '';
      }
    }
  }

774
775
776
777
778
  if ($cookie_domain) {
    // If the user specifies the cookie domain, also use it for session name.
    $session_name = $cookie_domain;
  }
  else {
779
780
781
    // 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);
782
783
    // HTTP_HOST can be modified by a visitor, but we already sanitized it
    // in drupal_settings_initialize().
784
    if (!empty($_SERVER['HTTP_HOST'])) {
785
      $cookie_domain = $_SERVER['HTTP_HOST'];
786
787
788
789
790
791
792
      // 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];
793
794
795
796
797
798
799
    }
  }
  // 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);
  }
800
801
802
803
804
805
806
807
808
809
  // 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';
810
  session_name($prefix . substr(hash('sha256', $session_name), 0, 32));
811
812
}

Dries's avatar
Dries committed
813
/**
814
815
816
817
 * 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
818
 *
Dries's avatar
Dries committed
819
820
821
822
823
824
825
826
827
828
829
830
 * 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
831
 * @param $type
832
 *   The type of the item (i.e. theme, theme_engine, module, profile).
Dries's avatar
Dries committed
833
834
835
836
837
838
839
840
841
 * @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
842
function drupal_get_filename($type, $name, $filename = NULL) {
843
844
  // The location of files will not change during the request, so do not use
  // drupal_static().
845
  static $files = array(), $dirs = array();
Dries's avatar
Dries committed
846

847
848
849
850
851
  // 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;
  }
852
  if (!isset($files[$type])) {
Dries's avatar
Dries committed
853
854
855
    $files[$type] = array();
  }

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

896
897
898
      if (!isset($dirs[$dir][$extension])) {
        $dirs[$dir][$extension] = TRUE;
        if (!function_exists('drupal_system_listing')) {
899
          require_once DRUPAL_ROOT . '/core/includes/common.inc';
900
901
902
903
904
905
906
907
908
        }
        // 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
909
910
911
912
      }
    }
  }

913
914
915
  if (isset($files[$type][$name])) {
    return $files[$type][$name];
  }
Dries's avatar
Dries committed
916
917
}

Dries's avatar
   
Dries committed
918
/**
919
 * Loads the persistent variable table.
Dries's avatar
   
Dries committed
920
921
 *
 * The variable table is composed of values that have been saved in the table
922
923
 * with variable_set() as well as those explicitly specified in the
 * configuration file.
Dries's avatar
   
Dries committed
924
 */
925
function variable_initialize($conf = array()) {
926
927
  // NOTE: caching the variables improves performance by 20% when serving
  // cached pages.
928
  if ($cached = cache('bootstrap')->get('variables')) {
929
    $variables = $cached->data;
Dries's avatar
   
Dries committed
930
931
  }
  else {
932
933
934
935
936
937
938
939
940
941
942
    // 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());
943
      cache('bootstrap')->set('variables', $variables);
944
945
      lock_release($name);
    }
Dries's avatar
   
Dries committed
946
947
948
949
  }

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

Dries's avatar
   
Dries committed
952
  return $variables;
Dries's avatar
 
Dries committed
953
954
}

Dries's avatar
   
Dries committed
955
/**
956
957
958
959
960
 * 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
961
962
963
964
965
 *
 * @param $name
 *   The name of the variable to return.
 * @param $default
 *   The default value to use if this variable has never been set.
966
 *
Dries's avatar
   
Dries committed
967
 * @return
968
 *   The value of the variable. Unserialization is taken care of as necessary.
969
 *
970
971
 * @see variable_del()
 * @see variable_set()
Dries's avatar
   
Dries committed
972
 */
973
function variable_get($name, $default = NULL) {
Dries's avatar
 
Dries committed
974
975
976
977
978
  global $conf;

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

Dries's avatar
   
Dries committed
979
/**
980
981
982
983
984
 * 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
985
986
987
988
989
990
 *
 * @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.
991
 *
992
993
 * @see variable_del()
 * @see variable_get()
Dries's avatar
   
Dries committed
994
 */
Dries's avatar
 
Dries committed
995
996
997
function variable_set($name, $value) {
  global $conf;

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

1000
  cache('bootstrap')->delete('variables');