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

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

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

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

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

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

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

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

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

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

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

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

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

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

/**
 * Log message severity -- Notice: normal but significant condition.
 */
93
const WATCHDOG_NOTICE = 5;
94
95
96
97

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

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

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

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

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

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

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

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

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

/**
140
 * Seventh bootstrap phase: find out language of the page.
141
 */
142
const DRUPAL_BOOTSTRAP_LANGUAGE = 6;
143
144

/**
145
 * Final bootstrap phase: Drupal is fully loaded; validate and fix input data.
146
 */
147
const DRUPAL_BOOTSTRAP_FULL = 7;
148

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  return $timers[$name];
}
342

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

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

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

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

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

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

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

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

554
555
  // Enforce E_STRICT, but allow users to set levels not part of E_STRICT.
  error_reporting(E_STRICT | E_ALL | error_reporting());
556

557
558
559
  // 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.
560

561
  // Don't escape quotes when reading files from the database, disk, etc.
562
  ini_set('magic_quotes_runtime', '0');
563
564
  // Use session cookies, not transparent sessions that puts the session id in
  // the query string.
565
  ini_set('session.use_cookies', '1');
566
  ini_set('session.use_only_cookies', '1');
567
  ini_set('session.use_trans_sid', '0');
568
569
  // Don't send HTTP headers using PHP's session handler.
  ini_set('session.cache_limiter', 'none');
570
571
  // Use httponly session cookies.
  ini_set('session.cookie_httponly', '1');
572
573
574
575

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

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

588
/**
589
 * Sets the base URL, cookie domain, and session name from configuration.
590
 */
591
function drupal_settings_initialize() {
592
593
  global $base_url, $base_path, $base_root;

Dries's avatar
Dries committed
594
  // Export the following settings.php variables to the global namespace
595
  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, $config_signature_key;
Dries's avatar
Dries committed
596
597
  $conf = array();

598
599
  if (file_exists(DRUPAL_ROOT . '/' . conf_path() . '/settings.php')) {
    include_once DRUPAL_ROOT . '/' . conf_path() . '/settings.php';
600
  }
601
  $is_https = isset($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) == 'on';
602
603
604
605

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

619
    $base_url = $base_root;
620
621
622

    // $_SERVER['SCRIPT_NAME'] can, in contrast to $_SERVER['PHP_SELF'], not
    // be modified by a visitor.
623
    if ($dir = rtrim(dirname($_SERVER['SCRIPT_NAME']), '\/')) {
624
625
626
627
628
629
630
631
632
      // Remove "core" directory if present, allowing install.php, update.php,
      // cron.php and others to auto-detect a base path.
      $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;
      }
633
634
635
636
637
638
639
      $base_url .= $base_path;
      $base_path .= '/';
    }
    else {
      $base_path = '/';
    }
  }
640
641
  $base_secure_url = str_replace('http://', 'https://', $base_url);
  $base_insecure_url = str_replace('https://', 'http://', $base_url);
642
643
644
645
646
647

  if ($cookie_domain) {
    // If the user specifies the cookie domain, also use it for session name.
    $session_name = $cookie_domain;
  }
  else {
648
649
650
    // 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);
651
652
    // HTTP_HOST can be modified by a visitor, but we already sanitized it
    // in drupal_settings_initialize().
653
    if (!empty($_SERVER['HTTP_HOST'])) {
654
      $cookie_domain = $_SERVER['HTTP_HOST'];
655
656
657
658
659
660
661
      // 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];
662
663
664
665
666
667
668
    }
  }
  // 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);
  }
669
670
671
672
673
674
675
676
677
678
  // 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';
679
  session_name($prefix . substr(hash('sha256', $session_name), 0, 32));
680
681
}

Dries's avatar
Dries committed
682
/**
683
684
685
686
 * 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
687
 *
Dries's avatar
Dries committed
688
689
690
691
692
693
694
695
696
697
698
699
 * 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
700
 * @param $type
701
 *   The type of the item (i.e. theme, theme_engine, module, profile).
Dries's avatar
Dries committed
702
703
704
705
706
707
708
709
710
 * @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
711
function drupal_get_filename($type, $name, $filename = NULL) {
712
713
  // The location of files will not change during the request, so do not use
  // drupal_static().
714
  static $files = array(), $dirs = array();
Dries's avatar
Dries committed
715

716
717
718
719
720
  // 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;
  }
721
  if (!isset($files[$type])) {
Dries's avatar
Dries committed
722
723
724
    $files[$type] = array();
  }

725
  if (!empty($filename) && file_exists($filename)) {
Dries's avatar
Dries committed
726
727
    $files[$type][$name] = $filename;
  }
728
  elseif (isset($files[$type][$name])) {
Dries's avatar
Dries committed
729
730
    // nothing
  }
Dries's avatar
Dries committed
731
  // Verify that we have an active database connection, before querying
732
  // the database. This is required because this function is called both
Dries's avatar
Dries committed
733
734
  // before we have a database connection (i.e. during installation) and
  // when a database connection fails.
Dries's avatar
Dries committed
735
  else {
736
    try {
737
738
      if (function_exists('db_query')) {
        $file = db_query("SELECT filename FROM {system} WHERE name = :name AND type = :type", array(':name' => $name, ':type' => $type))->fetchField();
739
        if (file_exists(DRUPAL_ROOT . '/' . $file)) {
740
741
          $files[$type][$name] = $file;
        }
742
743
      }
    }
744
    catch (Exception $e) {
745
746
747
748
749
750
751
752
753
754
755
      // 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';
756
        $extension = 'engine';
757
758
      }
      elseif ($type == 'theme') {
759
        $extension = 'info';
760
761
      }
      else {
762
        $extension = $type;
763
764
      }

765
766
767
      if (!isset($dirs[$dir][$extension])) {
        $dirs[$dir][$extension] = TRUE;
        if (!function_exists('drupal_system_listing')) {
768
          require_once DRUPAL_ROOT . '/core/includes/common.inc';
769
770
771
772
773
774
775
776
777
        }
        // 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
778
779
780
781
      }
    }
  }

782
783
784
  if (isset($files[$type][$name])) {
    return $files[$type][$name];
  }
Dries's avatar
Dries committed
785
786
}

Dries's avatar
   
Dries committed
787
/**
788
 * Loads the persistent variable table.
Dries's avatar
   
Dries committed
789
790
 *
 * The variable table is composed of values that have been saved in the table
791
792
 * with variable_set() as well as those explicitly specified in the
 * configuration file.
Dries's avatar
   
Dries committed
793
 */
794
function variable_initialize($conf = array()) {
795
796
  // NOTE: caching the variables improves performance by 20% when serving
  // cached pages.
797
  if ($cached = cache('bootstrap')->get('variables')) {
798
    $variables = $cached->data;
Dries's avatar
   
Dries committed
799
800
  }
  else {
801
802
803
804
805
806
807
808
809
810
811
    // 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());
812
      cache('bootstrap')->set('variables', $variables);
813
814
      lock_release($name);
    }
Dries's avatar
   
Dries committed
815
816
817
818
  }

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

Dries's avatar
   
Dries committed
821
  return $variables;
Dries's avatar
 
Dries committed
822
823
}

Dries's avatar
   
Dries committed
824
/**
825
826
827
828
829
 * 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
830
831
832
833
834
 *
 * @param $name
 *   The name of the variable to return.
 * @param $default
 *   The default value to use if this variable has never been set.
835
 *
Dries's avatar
   
Dries committed
836
837
 * @return
 *   The value of the variable.
838
 *
839
840
 * @see variable_del()
 * @see variable_set()
Dries's avatar
   
Dries committed
841
 */
842
function variable_get($name, $default = NULL) {
Dries's avatar
 
Dries committed
843
844
845
846
847
  global $conf;

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

Dries's avatar
   
Dries committed
848
/**
849
850
851
852
853
 * 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
854
855
856
857
858
859
 *
 * @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.
860
 *
861
862
 * @see variable_del()
 * @see variable_get()
Dries's avatar
   
Dries committed
863
 */
Dries's avatar
 
Dries committed
864
865
866
function variable_set($name, $value) {
  global $conf;

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

869
  cache('bootstrap')->delete('variables');
Dries's avatar
 
Dries committed
870
871
872
873

  $conf[$name] = $value;
}

Dries's avatar
   
Dries committed
874
/**
875
876
877
878
879
 * Unsets a persistent variable.
 *
 * Case-sensitivity of the variable_* functions depends on the database
 * collation used. To avoid problems, always use lower case for persistent
 * variable names.
Dries's avatar
   
Dries committed
880
881
882
 *
 * @param $name
 *   The name of the variable to undefine.
883
 *
884
885
 * @see variable_get()
 * @see variable_set()
Dries's avatar
   
Dries committed
886
 */
Dries's avatar
 
Dries committed
887
function variable_del($name) {
Dries's avatar
Dries committed
888
889
  global $conf;

890
891
892
  db_delete('variable')
    ->condition('name', $name)
    ->execute();
893
  cache('bootstrap')->delete('variables');
Dries's avatar
 
Dries committed
894

Dries's avatar
Dries committed
895
  unset($conf[$name]);
Dries's avatar
 
Dries committed
896
897
}

Dries's avatar
   
Dries committed
898
/**
899
 * Retrieves the current page from the cache.
Dries's avatar
   
Dries committed
900
 *
901
902
903
904
905
 * Note: we do not serve cached pages to authenticated users, or to anonymous
 * users when $_SESSION is non-empty. $_SESSION may contain status messages
 * from a form submission, the contents of a shopping cart, or other user-
 * specific content that should not be cached and displayed to other users.
 *
906
907
908
909
 * @param $check_only
 *   (optional) Set to TRUE to only return whether a previous call found a
 *   cache entry.
 *
910
 * @return
911
 *   The cache object, if the page was found in the cache, NULL otherwise.
Dries's avatar
   
Dries committed
912
 */
913
function drupal_page_get_cache($check_only = FALSE) {
914
  global $base_root;
915
916
917
918
919
  static $cache_hit = FALSE;

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

921
  if (drupal_page_is_cacheable()) {
922
    $cache = cache('page')->get($base_root . request_uri());
923
924
925
926
    if ($cache !== FALSE) {
      $cache_hit = TRUE;
    }
    return $cache;
927
  }
928
929
930
}

/**
931
 * Determines the cacheability of the current page.
932
933
 *
 * @param $allow_caching
934
935
 *   Set to FALSE if you want to prevent this page to get cached.
 *
936
 * @return
937
 *   TRUE if the current page can be cached, FALSE otherwise.
938
939
940
941
942
 */
function drupal_page_is_cacheable($allow_caching = NULL) {
  $allow_caching_static = &drupal_static(__FUNCTION__, TRUE);
  if (isset($allow_caching)) {
    $allow_caching_static = $allow_caching;
Dries's avatar
 
Dries committed
943
  }
944
945

  return $allow_caching_static && ($_SERVER['REQUEST_METHOD'] == 'GET' || $_SERVER['REQUEST_METHOD'] == 'HEAD')
946
    && !drupal_is_cli();
Dries's avatar
 
Dries committed
947
948
}

949
/**
950
 * Invokes a bootstrap hook in all bootstrap modules that implement it.
951
952
 *
 * @param $hook
953
 *   The name of the bootstrap hook to invoke.
954
955
 *
 * @see bootstrap_hooks()
956
957
 */
function bootstrap_invoke_all($hook) {
958
  // Bootstrap modules should have been loaded when this function is called, so
959
960
961
962
963
964
  // we don't need to tell module_list() to reset its internal list (and we
  // therefore leave the first parameter at its default value of FALSE). We
  // still pass in TRUE for the second parameter, though; in case this is the
  // first time during the bootstrap that module_list() is called, we want to
  // make sure that its internal cache is primed with the bootstrap modules
  // only.
965
  foreach (module_list(FALSE, TRUE) as $module) {
966
967
968
969
970
    drupal_load('module', $module);
    module_invoke($module, $hook);
  }
}

Dries's avatar
Dries committed
971
/**
972
973
974
 * Includes a file with the provided type and name.
 *
 * This prevents including a theme, engine, module, etc., more than once.
Dries's avatar
Dries committed
975
976
977
978
979
980
981
982
983
984
 *
 * @param $type
 *   The type of item to load (i.e. theme, theme_engine, module).
 * @param $name
 *   The name of the item to load.
 *
 * @return
 *   TRUE if the item is loaded or has already been loaded.
 */
function drupal_load($type, $name) {
985
986
987
  // Once a file is included this can't be reversed during a request so do not
  // use drupal_static() here.
  static $files = array();
Dries's avatar
Dries committed
988

989
  if (isset($files[$type][$name])) {
Dries's avatar
Dries committed
990
991
992
993
994
995
    return TRUE;
  }

  $filename = drupal_get_filename($type, $name);

  if ($filename) {
996
    include_once DRUPAL_ROOT . '/' . $filename;
Dries's avatar
Dries committed
997
998
999
1000
    $files[$type][$name] = TRUE;

    return TRUE;
  }