bootstrap.inc 115 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
283
/**
 * Regular expression to match PHP function names.
 *
284
 * @see http://php.net/manual/language.functions.php
285
 */
286
const DRUPAL_PHP_FUNCTION_PATTERN = '[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*';
287

288
289
290
291
292
293
294
295
296
297
298
299
300
301
/**
 * $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
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
 * Returns the appropriate configuration directory.
Dries's avatar
   
Dries committed
372
 *
373
374
375
376
 * 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.
377
 *
378
 * @param bool $require_settings
379
380
381
382
 *   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.
383
 * @param bool $reset
384
 *   Force a full search for matching directories even if one had been
385
386
 *   found previously. Defaults to FALSE.
 *
387
388
 * @return
 *   The path of the matching directory.
389
390
 *
 * @see default.settings.php
Dries's avatar
   
Dries committed
391
 */
392
function conf_path($require_settings = TRUE, $reset = FALSE) {
393
  $conf = &drupal_static(__FUNCTION__, '');
Dries's avatar
 
Dries committed
394

395
  if ($conf && !$reset) {
Dries's avatar
Dries committed
396
397
    return $conf;
  }
Dries's avatar
 
Dries committed
398

399
400
401
402
403
  $script_name = $_SERVER['SCRIPT_NAME'];
  if (!$script_name) {
    $script_name = $_SERVER['SCRIPT_FILENAME'];
  }
  $http_host = $_SERVER['HTTP_HOST'];
404
  $conf = find_conf_path($http_host, $script_name, $require_settings);
405
406
407
408
409
410
  return $conf;
}

/**
 * Finds the appropriate configuration directory for a given host and path.
 *
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
 * 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
 *
432
433
434
435
436
 * @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.
437
438
439
 * @param $require_settings
 *   Defaults to TRUE. If TRUE, then only match directories with a
 *   'settings.php' file. Otherwise match any directory.
440
441
442
443
 *
 * @return
 *   The path of the matching configuration directory.
 *
444
445
 * @see default.settings.php
 * @see example.sites.php
446
447
448
 * @see conf_path()
 */
function find_conf_path($http_host, $script_name, $require_settings = TRUE) {
Dries's avatar
   
Dries committed
449
  $confdir = 'sites';
450
451
452
453
454
455
456

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

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

475
/**
476
477
478
479
480
 * 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.
481
482
483
484
 *
 * @return string
 *   The configuration directory path.
 */
485
486
function config_get_config_directory($type = CONFIG_ACTIVE_DIRECTORY) {
  global $config_directories;
487
488
489

  if ($test_prefix = drupal_valid_test_ua()) {
    // @see Drupal\simpletest\WebTestBase::setUp()
490
491
492
493
    $path = conf_path() . '/files/simpletest/' . substr($test_prefix, 10) . '/config_' . $type;
  }
  elseif (!empty($config_directories[$type])) {
    $path = conf_path() . '/files/' . $config_directories[$type];
494
495
  }
  else {
496
    throw new Exception(format_string('The configuration directory type %type does not exist.', array('%type' => $type)));
497
498
499
500
  }
  return $path;
}

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

563
/**
564
 * Initializes the PHP environment.
565
 */
566
function drupal_environment_initialize() {
567
568
  if (!isset($_SERVER['HTTP_REFERER'])) {
    $_SERVER['HTTP_REFERER'] = '';
569
  }
570
571
572
  if (!isset($_SERVER['SERVER_PROTOCOL']) || ($_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.0' && $_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.1')) {
    $_SERVER['SERVER_PROTOCOL'] = 'HTTP/1.0';
  }
573

574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
  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'] = '';
589
590
  }

591
592
  // @todo Refactor with the Symfony Request object.
  _current_path(request_path());
593

594
595
  // Enforce E_STRICT, but allow users to set levels not part of E_STRICT.
  error_reporting(E_STRICT | E_ALL | error_reporting());
596

597
598
599
  // 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.
600

Dave Reid's avatar
Dave Reid committed
601
602
603
604
605
606
607
  // 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;
  }

608
609
  // Use session cookies, not transparent sessions that puts the session id in
  // the query string.
610
  ini_set('session.use_cookies', '1');
611
  ini_set('session.use_only_cookies', '1');
612
  ini_set('session.use_trans_sid', '0');
613
  // Don't send HTTP headers using PHP's session handler.
614
615
  // Send an empty string to disable the cache limiter.
  ini_set('session.cache_limiter', '');
616
617
  // Use httponly session cookies.
  ini_set('session.cookie_httponly', '1');
618
619
620
621

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

  // Detect string handling method.
  unicode_check();
625
626
}

627
/**
628
 * Validates that a hostname (for example $_SERVER['HTTP_HOST']) is safe.
629
630
631
632
 *
 * @return
 *  TRUE if only containing valid characters, or FALSE otherwise.
 */
633
634
function drupal_valid_http_host($host) {
  return preg_match('/^\[?(?:[a-zA-Z0-9-:\]_]+\.?)+$/', $host);
635
636
}

Dave Reid's avatar
Dave Reid committed
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
671
672
673
674
675
676
677
678
679
680
681
/**
 * 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 '';
}

682
/**
683
 * Sets the base URL, cookie domain, and session name from configuration.
684
 */
685
function drupal_settings_initialize() {
686
  global $base_url, $base_path, $base_root, $script_path;
687

688
  // Export these settings.php variables to the global namespace.
689
  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
690
691
  $conf = array();

692
693
694
695
  // 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';
696
  }
697
  $is_https = isset($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) == 'on';
698
699
700
701

  if (isset($base_url)) {
    // Parse fixed base URL from settings.php.
    $parts = parse_url($base_url);
702
    $http_protocol = $parts['scheme'];
703
704
705
    if (!isset($parts['path'])) {
      $parts['path'] = '';
    }
706
    $base_path = $parts['path'] . '/';
707
708
709
710
711
    // 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
712
    $http_protocol = $is_https ? 'https' : 'http';
713
    $base_root = $http_protocol . '://' . $_SERVER['HTTP_HOST'];
714

715
    $base_url = $base_root;
716

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

739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
  // 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 = '';
      }
    }
  }

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

Dries's avatar
Dries committed
804
/**
805
806
807
808
 * 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
809
 *
Dries's avatar
Dries committed
810
811
812
813
814
 * 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:
 *
815
 * core/modules/foo/foo.module
Dries's avatar
Dries committed
816
817
818
819
820
821
 * 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
822
 * @param $type
823
 *   The type of the item (i.e. theme, theme_engine, module, profile).
Dries's avatar
Dries committed
824
825
826
827
828
829
830
831
832
 * @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
833
function drupal_get_filename($type, $name, $filename = NULL) {
834
835
  // The location of files will not change during the request, so do not use
  // drupal_static().
836
  static $files = array(), $dirs = array();
Dries's avatar
Dries committed
837

838
839
840
  // Profiles are converted into modules in system_rebuild_module_data().
  // @todo Remove false-exposure of profiles as modules.
  $original_type = $type;
841
  if ($type == 'profile') {
842
    $type = 'module';
843
  }
844
  if (!isset($files[$type])) {
Dries's avatar
Dries committed
845
846
847
    $files[$type] = array();
  }

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

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

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

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

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

Dries's avatar
   
Dries committed
950
  return $variables;
Dries's avatar
 
Dries committed
951
952
}

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

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

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

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

998
  cache('bootstrap')->delete('variables');
Dries's avatar
 
Dries committed
999
1000

  $conf[$name] = $value;