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

Dries's avatar
   
Dries committed
3
4
5
6
/**
 * @file
 * Functions that need to be loaded on every Drupal request.
 */
Dries's avatar
   
Dries committed
7

8
9
10
/**
 * The current system version.
 */
11
define('VERSION', '8.0-dev');
12
13
14
15

/**
 * Core API compatibility.
 */
16
define('DRUPAL_CORE_COMPATIBILITY', '8.x');
17
18
19
20

/**
 * Minimum supported version of PHP.
 */
21
define('DRUPAL_MINIMUM_PHP', '5.3.2');
22
23
24
25

/**
 * Minimum recommended value of PHP memory_limit.
 */
26
define('DRUPAL_MINIMUM_PHP_MEMORY_LIMIT', '32M');
27

28
/**
29
30
31
 * Indicates that the item should never be removed unless explicitly selected.
 *
 * The item may be removed using cache_clear_all() with a cache ID.
32
 */
33
define('CACHE_PERMANENT', 0);
34
35
36
37

/**
 * Indicates that the item should be removed at the next general cache wipe.
 */
38
define('CACHE_TEMPORARY', -1);
Dries's avatar
 
Dries committed
39

40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
/**
 * @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
 * defined in RFC 3164, section 4.1.1.  PHP supplies predefined LOG_* constants
 * for use in the syslog() function, but their values on Windows builds do not
 * correspond to RFC 3164.  The associated PHP bug report was closed with the
 * 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.
 */
define('WATCHDOG_EMERGENCY', 0);

/**
 * Log message severity -- Alert: action must be taken immediately.
 */
define('WATCHDOG_ALERT', 1);

/**
 * Log message severity -- Critical: critical conditions.
 */
define('WATCHDOG_CRITICAL', 2);

/**
 * Log message severity -- Error: error conditions.
 */
define('WATCHDOG_ERROR', 3);

/**
 * Log message severity -- Warning: warning conditions.
 */
define('WATCHDOG_WARNING', 4);

/**
 * Log message severity -- Notice: normal but significant condition.
 */
define('WATCHDOG_NOTICE', 5);

/**
 * Log message severity -- Informational: informational messages.
 */
define('WATCHDOG_INFO', 6);

/**
 * Log message severity -- Debug: debug-level messages.
 */
define('WATCHDOG_DEBUG', 7);

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

104
105
106
/**
 * First bootstrap phase: initialize configuration.
 */
107
define('DRUPAL_BOOTSTRAP_CONFIGURATION', 0);
108
109

/**
110
 * Second bootstrap phase: try to serve a cached page.
111
 */
112
define('DRUPAL_BOOTSTRAP_PAGE_CACHE', 1);
113
114
115
116

/**
 * Third bootstrap phase: initialize database layer.
 */
117
define('DRUPAL_BOOTSTRAP_DATABASE', 2);
118
119

/**
120
 * Fourth bootstrap phase: initialize the variable system.
121
 */
122
define('DRUPAL_BOOTSTRAP_VARIABLES', 3);
123
124

/**
125
 * Fifth bootstrap phase: initialize session handling.
126
 */
127
define('DRUPAL_BOOTSTRAP_SESSION', 4);
128
129

/**
130
 * Sixth bootstrap phase: set up the page header.
131
 */
132
define('DRUPAL_BOOTSTRAP_PAGE_HEADER', 5);
133
134

/**
135
 * Seventh bootstrap phase: find out language of the page.
136
 */
137
define('DRUPAL_BOOTSTRAP_LANGUAGE', 6);
138
139
140
141
142

/**
 * Final bootstrap phase: Drupal is fully loaded; validate and fix
 * input data.
 */
143
define('DRUPAL_BOOTSTRAP_FULL', 7);
144

145
146
147
/**
 * Role ID for anonymous users; should match what's in the "role" table.
 */
148
define('DRUPAL_ANONYMOUS_RID', 1);
149
150
151
152

/**
 * Role ID for authenticated users; should match what's in the "role" table.
 */
153
154
define('DRUPAL_AUTHENTICATED_RID', 2);

155
/**
156
 * The number of bytes in a kilobyte. For more information, visit
157
158
159
160
 * http://en.wikipedia.org/wiki/Kilobyte.
 */
define('DRUPAL_KILOBYTE', 1024);

161
162
163
/**
 * The language code used when no language is explicitly assigned.
 *
164
 * Defined by ISO639-2 for "Undetermined".
165
 */
166
define('LANGUAGE_NONE', 'und');
167

168
/**
169
 * The type of language used to define the content language.
170
 */
171
define('LANGUAGE_TYPE_CONTENT', 'language_content');
172
173

/**
174
 * The type of language used to select the user interface.
175
 */
176
define('LANGUAGE_TYPE_INTERFACE', 'language');
177
178

/**
179
 * The type of language used for URLs.
180
 */
181
define('LANGUAGE_TYPE_URL', 'language_url');
182

183
184
185
186
187
188
189
190
191
192
/**
 * Language written left to right. Possible value of $language->direction.
 */
define('LANGUAGE_LTR', 0);

/**
 * Language written right to left. Possible value of $language->direction.
 */
define('LANGUAGE_RTL', 1);

193
194
/**
 * For convenience, define a short form of the request time global.
195
196
197
 *
 * REQUEST_TIME is a float with microseconds since PHP 5.4.0, but float
 * timestamps confuses most of the PHP functions (including date_create()).
198
 */
199
define('REQUEST_TIME', (int) $_SERVER['REQUEST_TIME']);
200

201
202
203
204
205
206
207
208
209
210
/**
 * Flag for drupal_set_title(); text is not sanitized, so run check_plain().
 */
define('CHECK_PLAIN', 0);

/**
 * Flag for drupal_set_title(); text has already been sanitized.
 */
define('PASS_THROUGH', -1);

211
/**
212
 * Signals that the registry lookup cache should be reset.
213
214
215
216
 */
define('REGISTRY_RESET_LOOKUP_CACHE', 1);

/**
217
 * Signals that the registry lookup cache should be written to storage.
218
219
220
 */
define('REGISTRY_WRITE_LOOKUP_CACHE', 2);

221
222
223
224
225
226
227
/**
 * Regular expression to match PHP function names.
 *
 * @see http://php.net/manual/en/language.functions.php
 */
define('DRUPAL_PHP_FUNCTION_PATTERN', '[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*');

Dries's avatar
   
Dries committed
228
/**
229
230
 * Start 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
231
232
233
234
235
236
237
 *
 * @param name
 *   The name of the timer.
 */
function timer_start($name) {
  global $timers;

238
  $timers[$name]['start'] = microtime(TRUE);
239
  $timers[$name]['count'] = isset($timers[$name]['count']) ? ++$timers[$name]['count'] : 1;
Dries's avatar
   
Dries committed
240
241
242
243
244
245
246
247
248
249
250
251
252
}

/**
 * Read the current timer value without stopping the timer.
 *
 * @param name
 *   The name of the timer.
 * @return
 *   The current timer value in ms.
 */
function timer_read($name) {
  global $timers;

253
  if (isset($timers[$name]['start'])) {
254
    $stop = microtime(TRUE);
255
    $diff = round(($stop - $timers[$name]['start']) * 1000, 2);
Dries's avatar
   
Dries committed
256

257
258
259
260
    if (isset($timers[$name]['time'])) {
      $diff += $timers[$name]['time'];
    }
    return $diff;
261
  }
262
  return $timers[$name]['time'];
Dries's avatar
   
Dries committed
263
264
265
266
267
268
269
270
}

/**
 * Stop the timer with the specified name.
 *
 * @param name
 *   The name of the timer.
 * @return
271
272
 *   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
273
274
275
276
 */
function timer_stop($name) {
  global $timers;

277
278
279
280
281
282
283
284
285
286
  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']);
287
  }
Dries's avatar
   
Dries committed
288
289
290

  return $timers[$name];
}
291

Dries's avatar
   
Dries committed
292
/**
293
 * Finds the appropriate configuration directory.
Dries's avatar
   
Dries committed
294
 *
295
 * Finds a matching configuration directory by stripping the website's
296
 * hostname from left to right and pathname from right to left. The first
297
298
 * 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
299
 *
300
301
 * 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
302
 *
303
304
305
306
 *  1. $confdir/8080.www.example.com.mysite.test
 *  2. $confdir/www.example.com.mysite.test
 *  3. $confdir/example.com.mysite.test
 *  4. $confdir/com.mysite.test
Dries's avatar
   
Dries committed
307
 *
308
309
310
311
 *  5. $confdir/8080.www.example.com.mysite
 *  6. $confdir/www.example.com.mysite
 *  7. $confdir/example.com.mysite
 *  8. $confdir/com.mysite
Dries's avatar
   
Dries committed
312
 *
313
314
315
316
 *  9. $confdir/8080.www.example.com
 * 10. $confdir/www.example.com
 * 11. $confdir/example.com
 * 12. $confdir/com
Dries's avatar
   
Dries committed
317
 *
318
 * 13. $confdir/default
319
 *
320
 * If a file named sites.php is present in the $confdir, it will be loaded
321
322
 * prior to scanning for directories. It should define an associative array
 * named $sites, which maps domains to directories. It should be in the form
323
 * of:
324
 * @code
325
326
327
 * $sites = array(
 *   'The url to alias' => 'A directory within the sites directory'
 * );
328
 * @endcode
329
 * For example:
330
 * @code
331
332
 * $sites = array(
 *   'devexample.com' => 'example.com',
333
 *   'localhost.example' => 'example.com',
334
 * );
335
 * @endcode
336
337
338
339
 * 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
340
 * domain of the live server. Since Drupal stores file paths into the database
341
342
343
 * (files, system table, etc.) this will ensure the paths are correct while
 * accessed on development servers.
 *
344
 * @param bool $require_settings
345
346
347
348
 *   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.
349
 * @param bool $reset
350
 *   Force a full search for matching directories even if one had been
351
352
 *   found previously. Defaults to FALSE.
 *
353
354
 * @return
 *   The path of the matching directory.
Dries's avatar
   
Dries committed
355
 */
356
function conf_path($require_settings = TRUE, $reset = FALSE) {
357
  $conf = &drupal_static(__FUNCTION__, '');
Dries's avatar
 
Dries committed
358

359
  if ($conf && !$reset) {
Dries's avatar
Dries committed
360
361
    return $conf;
  }
Dries's avatar
 
Dries committed
362

Dries's avatar
   
Dries committed
363
  $confdir = 'sites';
364
365
366
367
368
369
370

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

371
  $uri = explode('/', $_SERVER['SCRIPT_NAME'] ? $_SERVER['SCRIPT_NAME'] : $_SERVER['SCRIPT_FILENAME']);
372
  $server = explode('.', implode('.', array_reverse(explode(':', rtrim($_SERVER['HTTP_HOST'], '.')))));
Dries's avatar
Dries committed
373
374
375
  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));
376
377
378
379
      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
380
381
382
        $conf = "$confdir/$dir";
        return $conf;
      }
Dries's avatar
 
Dries committed
383
384
    }
  }
Dries's avatar
Dries committed
385
386
  $conf = "$confdir/default";
  return $conf;
Dries's avatar
 
Dries committed
387
388
}

389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
/**
 * Set appropriate server variables needed for command line scripts to work.
 *
 * 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()) {
424
  // Allow the provided URL to override any existing values in $_SERVER.
425
426
  if (isset($variables['url'])) {
    $url = parse_url($variables['url']);
427
428
429
430
431
432
    if (isset($url['host'])) {
      $_SERVER['HTTP_HOST'] = $url['host'];
    }
    if (isset($url['path'])) {
      $_SERVER['SCRIPT_NAME'] = $url['path'];
    }
433
434
    unset($variables['url']);
  }
435
436
437
  // 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.
438
  $defaults = array(
439
440
    'HTTP_HOST' => 'localhost',
    'SCRIPT_NAME' => NULL,
441
442
443
    'REMOTE_ADDR' => '127.0.0.1',
    'REQUEST_METHOD' => 'GET',
    'SERVER_NAME' => NULL,
444
    'SERVER_SOFTWARE' => NULL,
445
446
447
448
449
450
    'HTTP_USER_AGENT' => NULL,
  );
  // Replace elements of the $_SERVER array, as appropriate.
  $_SERVER = $variables + $_SERVER + $defaults;
}

451
/**
452
 * Initialize PHP environment.
453
 */
454
function drupal_environment_initialize() {
455
456
  if (!isset($_SERVER['HTTP_REFERER'])) {
    $_SERVER['HTTP_REFERER'] = '';
457
  }
458
459
460
  if (!isset($_SERVER['SERVER_PROTOCOL']) || ($_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.0' && $_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.1')) {
    $_SERVER['SERVER_PROTOCOL'] = 'HTTP/1.0';
  }
461

462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
  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'] = '';
477
478
  }

479
480
481
482
483
484
485
  // When clean URLs are enabled, emulate ?q=foo/bar using REQUEST_URI. It is
  // not possible to append the query string using mod_rewrite without the B
  // flag (this was added in Apache 2.2.8), because mod_rewrite unescapes the
  // path before passing it on to PHP. This is a problem when the path contains
  // e.g. "&" or "%" that have special meanings in URLs and must be encoded.
  $_GET['q'] = request_path();

486
487
  // Enforce E_ALL, but allow users to set levels not part of E_ALL.
  error_reporting(E_ALL | error_reporting());
488

489
490
491
  // 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.
492

493
  // Don't escape quotes when reading files from the database, disk, etc.
494
  ini_set('magic_quotes_runtime', '0');
495
496
  // Use session cookies, not transparent sessions that puts the session id in
  // the query string.
497
  ini_set('session.use_cookies', '1');
498
  ini_set('session.use_only_cookies', '1');
499
  ini_set('session.use_trans_sid', '0');
500
501
  // Don't send HTTP headers using PHP's session handler.
  ini_set('session.cache_limiter', 'none');
502
503
  // Use httponly session cookies.
  ini_set('session.cookie_httponly', '1');
504
505
506
507

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

510
/**
511
 * Validate that a hostname (for example $_SERVER['HTTP_HOST']) is safe.
512
513
514
515
 *
 * @return
 *  TRUE if only containing valid characters, or FALSE otherwise.
 */
516
517
function drupal_valid_http_host($host) {
  return preg_match('/^\[?(?:[a-zA-Z0-9-:\]_]+\.?)+$/', $host);
518
519
}

520
/**
521
522
 * Loads the configuration and sets the base URL, cookie domain, and
 * session name correctly.
523
 */
524
function drupal_settings_initialize() {
525
526
  global $base_url, $base_path, $base_root;

Dries's avatar
Dries committed
527
  // Export the following settings.php variables to the global namespace
528
  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;
Dries's avatar
Dries committed
529
530
  $conf = array();

531
532
  if (file_exists(DRUPAL_ROOT . '/' . conf_path() . '/settings.php')) {
    include_once DRUPAL_ROOT . '/' . conf_path() . '/settings.php';
533
  }
534
  $is_https = isset($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) == 'on';
535
536
537
538

  if (isset($base_url)) {
    // Parse fixed base URL from settings.php.
    $parts = parse_url($base_url);
539
    $http_protocol = $parts['scheme'];
540
541
542
    if (!isset($parts['path'])) {
      $parts['path'] = '';
    }
543
    $base_path = $parts['path'] . '/';
544
545
546
547
548
    // 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
549
    $http_protocol = $is_https ? 'https' : 'http';
550
    $base_root = $http_protocol . '://' . $_SERVER['HTTP_HOST'];
551

552
    $base_url = $base_root;
553
554
555

    // $_SERVER['SCRIPT_NAME'] can, in contrast to $_SERVER['PHP_SELF'], not
    // be modified by a visitor.
556
557
    if ($dir = rtrim(dirname($_SERVER['SCRIPT_NAME']), '\/')) {
      $base_path = $dir;
558
559
560
561
562
563
564
      $base_url .= $base_path;
      $base_path .= '/';
    }
    else {
      $base_path = '/';
    }
  }
565
566
  $base_secure_url = str_replace('http://', 'https://', $base_url);
  $base_insecure_url = str_replace('https://', 'http://', $base_url);
567
568
569
570
571
572

  if ($cookie_domain) {
    // If the user specifies the cookie domain, also use it for session name.
    $session_name = $cookie_domain;
  }
  else {
573
574
575
    // 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);
576
577
    // HTTP_HOST can be modified by a visitor, but we already sanitized it
    // in drupal_settings_initialize().
578
    if (!empty($_SERVER['HTTP_HOST'])) {
579
      $cookie_domain = $_SERVER['HTTP_HOST'];
580
581
582
583
584
585
586
      // 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];
587
588
589
590
591
592
593
    }
  }
  // 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);
  }
594
595
596
597
598
599
600
601
602
603
  // 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';
604
  session_name($prefix . substr(hash('sha256', $session_name), 0, 32));
605
606
}

Dries's avatar
Dries committed
607
608
/**
 * Returns and optionally sets the filename for a system item (module,
609
 * theme, etc.). The filename, whether provided, cached, or retrieved
Dries's avatar
Dries committed
610
611
 * from the database, is only returned if the file exists.
 *
Dries's avatar
Dries committed
612
613
614
615
616
617
618
619
620
621
622
623
 * 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
624
 * @param $type
625
 *   The type of the item (i.e. theme, theme_engine, module, profile).
Dries's avatar
Dries committed
626
627
628
629
630
631
632
633
634
 * @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
635
function drupal_get_filename($type, $name, $filename = NULL) {
636
637
638
  // The location of files will not change during the request, so do not use
  // drupal_static().
  static $files = array();
Dries's avatar
Dries committed
639

640
  if (!isset($files[$type])) {
Dries's avatar
Dries committed
641
642
643
    $files[$type] = array();
  }

644
  if (!empty($filename) && file_exists($filename)) {
Dries's avatar
Dries committed
645
646
    $files[$type][$name] = $filename;
  }
647
  elseif (isset($files[$type][$name])) {
Dries's avatar
Dries committed
648
649
    // nothing
  }
Dries's avatar
Dries committed
650
  // Verify that we have an active database connection, before querying
651
  // the database. This is required because this function is called both
Dries's avatar
Dries committed
652
653
  // before we have a database connection (i.e. during installation) and
  // when a database connection fails.
Dries's avatar
Dries committed
654
  else {
655
    try {
656
657
      if (function_exists('db_query')) {
        $file = db_query("SELECT filename FROM {system} WHERE name = :name AND type = :type", array(':name' => $name, ':type' => $type))->fetchField();
658
        if (file_exists(DRUPAL_ROOT . '/' . $file)) {
659
660
          $files[$type][$name] = $file;
        }
661
662
      }
    }
663
    catch (Exception $e) {
664
665
666
667
668
669
670
671
672
673
674
      // 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';
675
        $extension = 'engine';
676
677
      }
      elseif ($type == 'theme') {
678
        $extension = 'info';
679
680
      }
      else {
681
        $extension = $type;
682
683
      }

684
685
686
      if (!function_exists('drupal_system_listing')) {
        require_once DRUPAL_ROOT . '/includes/common.inc';
      }
687
688
689
690
      // 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.
691
      $matches = drupal_system_listing("/^" . DRUPAL_PHP_FUNCTION_PATTERN . "\.$extension$/", $dir, 'name', 0);
692
693
      foreach ($matches as $matched_name => $file) {
        $files[$type][$matched_name] = $file->uri;
Dries's avatar
Dries committed
694
695
696
697
      }
    }
  }

698
699
700
  if (isset($files[$type][$name])) {
    return $files[$type][$name];
  }
Dries's avatar
Dries committed
701
702
}

Dries's avatar
   
Dries committed
703
704
705
706
707
708
709
/**
 * Load the persistent variable table.
 *
 * The variable table is composed of values that have been saved in the table
 * with variable_set() as well as those explicitly specified in the configuration
 * file.
 */
710
function variable_initialize($conf = array()) {
711
712
  // NOTE: caching the variables improves performance by 20% when serving
  // cached pages.
713
  if ($cached = cache_get('variables', 'cache_bootstrap')) {
714
    $variables = $cached->data;
Dries's avatar
   
Dries committed
715
716
  }
  else {
717
718
719
720
721
722
723
724
725
726
727
728
729
730
    // 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());
      cache_set('variables', $variables, 'cache_bootstrap');
      lock_release($name);
    }
Dries's avatar
   
Dries committed
731
732
733
734
  }

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

Dries's avatar
   
Dries committed
737
  return $variables;
Dries's avatar
 
Dries committed
738
739
}

Dries's avatar
   
Dries committed
740
/**
741
742
743
744
745
 * 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
746
747
748
749
750
 *
 * @param $name
 *   The name of the variable to return.
 * @param $default
 *   The default value to use if this variable has never been set.
751
 *
Dries's avatar
   
Dries committed
752
753
 * @return
 *   The value of the variable.
754
 *
755
756
 * @see variable_del()
 * @see variable_set()
Dries's avatar
   
Dries committed
757
 */
758
function variable_get($name, $default = NULL) {
Dries's avatar
 
Dries committed
759
760
761
762
763
  global $conf;

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

Dries's avatar
   
Dries committed
764
/**
765
766
767
768
769
 * 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
770
771
772
773
774
775
 *
 * @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.
776
 *
777
778
 * @see variable_del()
 * @see variable_get()
Dries's avatar
   
Dries committed
779
 */
Dries's avatar
 
Dries committed
780
781
782
function variable_set($name, $value) {
  global $conf;

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

785
  cache_clear_all('variables', 'cache_bootstrap');
Dries's avatar
 
Dries committed
786
787
788
789

  $conf[$name] = $value;
}

Dries's avatar
   
Dries committed
790
/**
791
792
793
794
795
 * 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
796
797
798
 *
 * @param $name
 *   The name of the variable to undefine.
799
 *
800
801
 * @see variable_get()
 * @see variable_set()
Dries's avatar
   
Dries committed
802
 */
Dries's avatar
 
Dries committed
803
function variable_del($name) {
Dries's avatar
Dries committed
804
805
  global $conf;

806
807
808
  db_delete('variable')
    ->condition('name', $name)
    ->execute();
809
  cache_clear_all('variables', 'cache_bootstrap');
Dries's avatar
 
Dries committed
810

Dries's avatar
Dries committed
811
  unset($conf[$name]);
Dries's avatar
 
Dries committed
812
813
}

Dries's avatar
   
Dries committed
814
815
816
/**
 * Retrieve the current page from the cache.
 *
817
818
819
820
821
 * 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.
 *
822
823
824
825
 * @param $check_only
 *   (optional) Set to TRUE to only return whether a previous call found a
 *   cache entry.
 *
826
 * @return
827
 *   The cache object, if the page was found in the cache, NULL otherwise.
Dries's avatar
   
Dries committed
828
 */
829
function drupal_page_get_cache($check_only = FALSE) {
830
  global $base_root;
831
832
833
834
835
  static $cache_hit = FALSE;

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

837
  if (drupal_page_is_cacheable()) {
838
839
840
841
842
    $cache = cache_get($base_root . request_uri(), 'cache_page');
    if ($cache !== FALSE) {
      $cache_hit = TRUE;
    }
    return $cache;
843
  }
844
845
846
847
848
849
}

/**
 * Determine the cacheability of the current page.
 *
 * @param $allow_caching
850
851
 *   Set to FALSE if you want to prevent this page to get cached.
 *
852
 * @return
853
 *   TRUE if the current page can be cached, FALSE otherwise.
854
855
856
857
858
 */
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
859
  }
860
861

  return $allow_caching_static && ($_SERVER['REQUEST_METHOD'] == 'GET' || $_SERVER['REQUEST_METHOD'] == 'HEAD')
862
    && !drupal_is_cli();
Dries's avatar
 
Dries committed
863
864
}

865
/**
866
 * Invoke a bootstrap hook in all bootstrap modules that implement it.
867
868
 *
 * @param $hook
869
 *   The name of the bootstrap hook to invoke.
870
871
 *
 * @see bootstrap_hooks()
872
873
 */
function bootstrap_invoke_all($hook) {
874
  // Bootstrap modules should have been loaded when this function is called, so
875
876
877
878
879
880
  // 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.
881
  foreach (module_list(FALSE, TRUE) as $module) {
882
883
884
885
886
    drupal_load('module', $module);
    module_invoke($module, $hook);
  }
}

Dries's avatar
Dries committed
887
/**
888
 * Includes a file with the provided type and name. This prevents
Dries's avatar
Dries committed
889
890
891
892
893
894
895
896
897
898
899
 * including a theme, engine, module, etc., more than once.
 *
 * @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) {
900
901
902
  // 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
903

904
  if (isset($files[$type][$name])) {
Dries's avatar
Dries committed
905
906
907
908
909
910
    return TRUE;
  }

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

  if ($filename) {
911
    include_once DRUPAL_ROOT . '/' . $filename;
Dries's avatar
Dries committed
912
913
914
915
916
917
918
919
    $files[$type][$name] = TRUE;

    return TRUE;
  }

  return FALSE;
}

920
921
922
923
924
925
926
/**
 * Set an HTTP response header for the current page.
 *
 * Note: When sending a Content-Type header, always include a 'charset' type,
 * too. This is necessary to avoid security bugs (e.g. UTF-7 XSS).
 *
 * @param $name
927
 *   The HTTP header name, or the special 'Status' header name.
928
 * @param $value
929
930
931
 *   The HTTP header value; if equal to FALSE, the specified header is unset.
 *   If $name is 'Status', this is expected to be a status code followed by a
 *   reason phrase, e.g. "404 Not Found".
932
933
934
 * @param $append
 *   Whether to append the value to an existing header or to replace it.
 */
935
function drupal_add_http_header($name, $value, $append = FALSE) {
936
  // The headers as name/value pairs.
937
  $headers = &drupal_static('drupal_http_headers', array());
938

939
  $name_lower = strtolower($name);
940
  _drupal_set_preferred_header_name($name);
941

942
  if ($value === FALSE) {
943
    $headers[$name_lower] = FALSE;
944
  }
945
  elseif (isset($headers[$name_lower]) && $append) {
946
947
    // Multiple headers with identical names may be combined using comma (RFC
    // 2616, section 4.2).
948
    $headers[$name_lower] .= ',' . $value;
949
950
  }
  else {
951
    $headers[$name_lower] = $value;
952
  }
953
  drupal_send_headers(array($name => $headers[$name_lower]), TRUE);
954
955
956
957
958
959
960
961
962
963
964
965
}

/**
 * Get the HTTP response headers for the current page.
 *
 * @param $name
 *   An HTTP header name. If omitted, all headers are returned as name/value
 *   pairs. If an array value is FALSE, the header has been unset.
 * @return
 *   A string containing the header value, or FALSE if the header has been set,
 *   or NULL if the header has not been set.
 */
966
function drupal_get_http_header($name = NULL) {
967
  $headers = &drupal_static('drupal_http_headers', array());
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
  if (isset($name)) {
    $name = strtolower($name);
    return isset($headers[$name]) ? $headers[$name] : NULL;
  }
  else {
    return $headers;
  }
}

/**
 * Header names are case-insensitive, but for maximum compatibility they should
 * follow "common form" (see RFC 2617, section 4.2).
 */
function _drupal_set_preferred_header_name($name = NULL) {
  static $header_names = array();

  if (!isset($name)) {
    return $header_names;
  }
  $header_names[strtolower($name)] = $name;
}

/**
991
 * Send the HTTP response headers previously set using drupal_add_http_header().
992
 * Add default headers, unless they have been replaced or unset using
993
 * drupal_add_http_header().
994
995
996
997
998
999
1000
 *
 * @param $default_headers
 *   An array of headers as name/value pairs.
 * @param $single
 *   If TRUE and headers have already be sent, send only the specified header.
 */
function drupal_send_headers($default_headers = array(), $only_default = FALSE) {