bootstrap.inc 97.6 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
/**
 * First bootstrap phase: initialize configuration.
 */
43
define('DRUPAL_BOOTSTRAP_CONFIGURATION', 0);
44
45

/**
46
 * Second bootstrap phase: try to serve a cached page.
47
 */
48
define('DRUPAL_BOOTSTRAP_PAGE_CACHE', 1);
49
50
51
52

/**
 * Third bootstrap phase: initialize database layer.
 */
53
define('DRUPAL_BOOTSTRAP_DATABASE', 2);
54
55

/**
56
 * Fourth bootstrap phase: initialize the variable system.
57
 */
58
define('DRUPAL_BOOTSTRAP_VARIABLES', 3);
59
60

/**
61
 * Fifth bootstrap phase: initialize session handling.
62
 */
63
define('DRUPAL_BOOTSTRAP_SESSION', 4);
64
65

/**
66
 * Sixth bootstrap phase: set up the page header.
67
 */
68
define('DRUPAL_BOOTSTRAP_PAGE_HEADER', 5);
69
70

/**
71
 * Seventh bootstrap phase: find out language of the page.
72
 */
73
define('DRUPAL_BOOTSTRAP_LANGUAGE', 6);
74
75
76
77
78

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

81
82
83
/**
 * Role ID for anonymous users; should match what's in the "role" table.
 */
84
define('DRUPAL_ANONYMOUS_RID', 1);
85
86
87
88

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

91
/**
92
 * The number of bytes in a kilobyte. For more information, visit
93
94
95
96
 * http://en.wikipedia.org/wiki/Kilobyte.
 */
define('DRUPAL_KILOBYTE', 1024);

97
98
99
/**
 * The language code used when no language is explicitly assigned.
 *
100
 * Defined by ISO639-2 for "Undetermined".
101
 */
102
define('LANGUAGE_NONE', 'und');
103

104
/**
105
 * The type of language used to define the content language.
106
 */
107
define('LANGUAGE_TYPE_CONTENT', 'language_content');
108
109

/**
110
 * The type of language used to select the user interface.
111
 */
112
define('LANGUAGE_TYPE_INTERFACE', 'language');
113
114

/**
115
 * The type of language used for URLs.
116
 */
117
define('LANGUAGE_TYPE_URL', 'language_url');
118

119
120
121
122
123
124
125
126
127
128
/**
 * 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);

129
130
131
/**
 * For convenience, define a short form of the request time global.
 */
132
define('REQUEST_TIME', $_SERVER['REQUEST_TIME']);
133

134
135
136
137
138
139
140
141
142
143
/**
 * 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);

144
/**
145
 * Signals that the registry lookup cache should be reset.
146
147
148
149
 */
define('REGISTRY_RESET_LOOKUP_CACHE', 1);

/**
150
 * Signals that the registry lookup cache should be written to storage.
151
152
153
 */
define('REGISTRY_WRITE_LOOKUP_CACHE', 2);

154
155
156
157
158
159
160
/**
 * 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
161
/**
162
163
 * 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
164
165
166
167
168
169
170
 *
 * @param name
 *   The name of the timer.
 */
function timer_start($name) {
  global $timers;

171
  $timers[$name]['start'] = microtime(TRUE);
172
  $timers[$name]['count'] = isset($timers[$name]['count']) ? ++$timers[$name]['count'] : 1;
Dries's avatar
   
Dries committed
173
174
175
176
177
178
179
180
181
182
183
184
185
}

/**
 * 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;

186
  if (isset($timers[$name]['start'])) {
187
    $stop = microtime(TRUE);
188
    $diff = round(($stop - $timers[$name]['start']) * 1000, 2);
Dries's avatar
   
Dries committed
189

190
191
192
193
    if (isset($timers[$name]['time'])) {
      $diff += $timers[$name]['time'];
    }
    return $diff;
194
  }
195
  return $timers[$name]['time'];
Dries's avatar
   
Dries committed
196
197
198
199
200
201
202
203
}

/**
 * Stop the timer with the specified name.
 *
 * @param name
 *   The name of the timer.
 * @return
204
205
 *   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
206
207
208
209
 */
function timer_stop($name) {
  global $timers;

210
211
212
213
214
215
216
217
218
219
  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']);
220
  }
Dries's avatar
   
Dries committed
221
222
223

  return $timers[$name];
}
224

Dries's avatar
   
Dries committed
225
/**
226
 * Finds the appropriate configuration directory.
Dries's avatar
   
Dries committed
227
 *
228
 * Finds a matching configuration directory by stripping the website's
229
 * hostname from left to right and pathname from right to left. The first
230
231
 * 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
232
 *
233
234
 * 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
235
 *
236
237
238
239
 *  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
240
 *
241
242
243
244
 *  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
245
 *
246
247
248
249
 *  9. $confdir/8080.www.example.com
 * 10. $confdir/www.example.com
 * 11. $confdir/example.com
 * 12. $confdir/com
Dries's avatar
   
Dries committed
250
 *
251
 * 13. $confdir/default
252
 *
253
 * If a file named sites.php is present in the $confdir, it will be loaded
254
255
 * prior to scanning for directories. It should define an associative array
 * named $sites, which maps domains to directories. It should be in the form
256
 * of:
257
 * @code
258
259
260
 * $sites = array(
 *   'The url to alias' => 'A directory within the sites directory'
 * );
261
 * @endcode
262
 * For example:
263
 * @code
264
265
 * $sites = array(
 *   'devexample.com' => 'example.com',
266
 *   'localhost.example' => 'example.com',
267
 * );
268
 * @endcode
269
270
271
272
 * 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
273
 * domain of the live server. Since Drupal stores file paths into the database
274
275
276
 * (files, system table, etc.) this will ensure the paths are correct while
 * accessed on development servers.
 *
277
 * @param bool $require_settings
278
279
280
281
 *   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.
282
 * @param bool $reset
283
 *   Force a full search for matching directories even if one had been
284
285
 *   found previously. Defaults to FALSE.
 *
286
287
 * @return
 *   The path of the matching directory.
Dries's avatar
   
Dries committed
288
 */
289
function conf_path($require_settings = TRUE, $reset = FALSE) {
290
  $conf = &drupal_static(__FUNCTION__, '');
Dries's avatar
 
Dries committed
291

292
  if ($conf && !$reset) {
Dries's avatar
Dries committed
293
294
    return $conf;
  }
Dries's avatar
 
Dries committed
295

Dries's avatar
   
Dries committed
296
  $confdir = 'sites';
297
298
299
300
301
302
303

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

304
  $uri = explode('/', $_SERVER['SCRIPT_NAME'] ? $_SERVER['SCRIPT_NAME'] : $_SERVER['SCRIPT_FILENAME']);
305
  $server = explode('.', implode('.', array_reverse(explode(':', rtrim($_SERVER['HTTP_HOST'], '.')))));
Dries's avatar
Dries committed
306
307
308
  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));
309
310
311
312
      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
313
314
315
        $conf = "$confdir/$dir";
        return $conf;
      }
Dries's avatar
 
Dries committed
316
317
    }
  }
Dries's avatar
Dries committed
318
319
  $conf = "$confdir/default";
  return $conf;
Dries's avatar
 
Dries committed
320
321
}

322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
/**
 * 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()) {
357
  // Allow the provided URL to override any existing values in $_SERVER.
358
359
  if (isset($variables['url'])) {
    $url = parse_url($variables['url']);
360
361
362
363
364
365
    if (isset($url['host'])) {
      $_SERVER['HTTP_HOST'] = $url['host'];
    }
    if (isset($url['path'])) {
      $_SERVER['SCRIPT_NAME'] = $url['path'];
    }
366
367
    unset($variables['url']);
  }
368
369
370
  // 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.
371
  $defaults = array(
372
373
    'HTTP_HOST' => 'localhost',
    'SCRIPT_NAME' => NULL,
374
375
376
    'REMOTE_ADDR' => '127.0.0.1',
    'REQUEST_METHOD' => 'GET',
    'SERVER_NAME' => NULL,
377
    'SERVER_SOFTWARE' => NULL,
378
379
380
381
382
383
    'HTTP_USER_AGENT' => NULL,
  );
  // Replace elements of the $_SERVER array, as appropriate.
  $_SERVER = $variables + $_SERVER + $defaults;
}

384
/**
385
 * Initialize PHP environment.
386
 */
387
function drupal_environment_initialize() {
388
389
  if (!isset($_SERVER['HTTP_REFERER'])) {
    $_SERVER['HTTP_REFERER'] = '';
390
  }
391
392
393
  if (!isset($_SERVER['SERVER_PROTOCOL']) || ($_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.0' && $_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.1')) {
    $_SERVER['SERVER_PROTOCOL'] = 'HTTP/1.0';
  }
394

395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
  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'] = '';
410
411
  }

412
413
414
415
416
417
418
  // 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();

419
420
  // Enforce E_ALL, but allow users to set levels not part of E_ALL.
  error_reporting(E_ALL | error_reporting());
421

422
423
424
  // 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.
425

426
  // Don't escape quotes when reading files from the database, disk, etc.
427
  ini_set('magic_quotes_runtime', '0');
428
429
  // Use session cookies, not transparent sessions that puts the session id in
  // the query string.
430
  ini_set('session.use_cookies', '1');
431
  ini_set('session.use_only_cookies', '1');
432
  ini_set('session.use_trans_sid', '0');
433
434
  // Don't send HTTP headers using PHP's session handler.
  ini_set('session.cache_limiter', 'none');
435
436
  // Use httponly session cookies.
  ini_set('session.cookie_httponly', '1');
437
438
439
440

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

443
/**
444
 * Validate that a hostname (for example $_SERVER['HTTP_HOST']) is safe.
445
446
447
448
 *
 * @return
 *  TRUE if only containing valid characters, or FALSE otherwise.
 */
449
450
function drupal_valid_http_host($host) {
  return preg_match('/^\[?(?:[a-zA-Z0-9-:\]_]+\.?)+$/', $host);
451
452
}

453
/**
454
455
 * Loads the configuration and sets the base URL, cookie domain, and
 * session name correctly.
456
 */
457
function drupal_settings_initialize() {
458
459
  global $base_url, $base_path, $base_root;

Dries's avatar
Dries committed
460
  // Export the following settings.php variables to the global namespace
461
  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
462
463
  $conf = array();

464
465
  if (file_exists(DRUPAL_ROOT . '/' . conf_path() . '/settings.php')) {
    include_once DRUPAL_ROOT . '/' . conf_path() . '/settings.php';
466
  }
467
  $is_https = isset($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) == 'on';
468
469
470
471

  if (isset($base_url)) {
    // Parse fixed base URL from settings.php.
    $parts = parse_url($base_url);
472
    $http_protocol = $parts['scheme'];
473
474
475
    if (!isset($parts['path'])) {
      $parts['path'] = '';
    }
476
    $base_path = $parts['path'] . '/';
477
478
479
480
481
    // 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
482
    $http_protocol = $is_https ? 'https' : 'http';
483
    $base_root = $http_protocol . '://' . $_SERVER['HTTP_HOST'];
484

485
    $base_url = $base_root;
486
487
488

    // $_SERVER['SCRIPT_NAME'] can, in contrast to $_SERVER['PHP_SELF'], not
    // be modified by a visitor.
489
490
    if ($dir = rtrim(dirname($_SERVER['SCRIPT_NAME']), '\/')) {
      $base_path = $dir;
491
492
493
494
495
496
497
      $base_url .= $base_path;
      $base_path .= '/';
    }
    else {
      $base_path = '/';
    }
  }
498
499
  $base_secure_url = str_replace('http://', 'https://', $base_url);
  $base_insecure_url = str_replace('https://', 'http://', $base_url);
500
501
502
503
504
505

  if ($cookie_domain) {
    // If the user specifies the cookie domain, also use it for session name.
    $session_name = $cookie_domain;
  }
  else {
506
507
508
    // 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);
509
510
    // HTTP_HOST can be modified by a visitor, but we already sanitized it
    // in drupal_settings_initialize().
511
    if (!empty($_SERVER['HTTP_HOST'])) {
512
      $cookie_domain = $_SERVER['HTTP_HOST'];
513
514
515
516
517
518
519
      // 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];
520
521
522
523
524
525
526
    }
  }
  // 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);
  }
527
528
529
530
531
532
533
534
535
536
  // 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';
537
  session_name($prefix . substr(hash('sha256', $session_name), 0, 32));
538
539
}

Dries's avatar
Dries committed
540
541
/**
 * Returns and optionally sets the filename for a system item (module,
542
 * theme, etc.). The filename, whether provided, cached, or retrieved
Dries's avatar
Dries committed
543
544
 * from the database, is only returned if the file exists.
 *
Dries's avatar
Dries committed
545
546
547
548
549
550
551
552
553
554
555
556
 * 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
557
 * @param $type
558
 *   The type of the item (i.e. theme, theme_engine, module, profile).
Dries's avatar
Dries committed
559
560
561
562
563
564
565
566
567
 * @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
568
function drupal_get_filename($type, $name, $filename = NULL) {
569
570
571
  // The location of files will not change during the request, so do not use
  // drupal_static().
  static $files = array();
Dries's avatar
Dries committed
572

573
  if (!isset($files[$type])) {
Dries's avatar
Dries committed
574
575
576
    $files[$type] = array();
  }

577
  if (!empty($filename) && file_exists($filename)) {
Dries's avatar
Dries committed
578
579
    $files[$type][$name] = $filename;
  }
580
  elseif (isset($files[$type][$name])) {
Dries's avatar
Dries committed
581
582
    // nothing
  }
Dries's avatar
Dries committed
583
  // Verify that we have an active database connection, before querying
584
  // the database. This is required because this function is called both
Dries's avatar
Dries committed
585
586
  // before we have a database connection (i.e. during installation) and
  // when a database connection fails.
Dries's avatar
Dries committed
587
  else {
588
    try {
589
590
      if (function_exists('db_query')) {
        $file = db_query("SELECT filename FROM {system} WHERE name = :name AND type = :type", array(':name' => $name, ':type' => $type))->fetchField();
591
        if (file_exists(DRUPAL_ROOT . '/' . $file)) {
592
593
          $files[$type][$name] = $file;
        }
594
595
      }
    }
596
    catch (Exception $e) {
597
598
599
600
601
602
603
604
605
606
607
      // 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';
608
        $extension = 'engine';
609
610
      }
      elseif ($type == 'theme') {
611
        $extension = 'info';
612
613
      }
      else {
614
        $extension = $type;
615
616
      }

617
618
619
      if (!function_exists('drupal_system_listing')) {
        require_once DRUPAL_ROOT . '/includes/common.inc';
      }
620
621
622
623
      // 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.
624
      $matches = drupal_system_listing("/^" . DRUPAL_PHP_FUNCTION_PATTERN . "\.$extension$/", $dir, 'name', 0);
625
626
      foreach ($matches as $matched_name => $file) {
        $files[$type][$matched_name] = $file->uri;
Dries's avatar
Dries committed
627
628
629
630
      }
    }
  }

631
632
633
  if (isset($files[$type][$name])) {
    return $files[$type][$name];
  }
Dries's avatar
Dries committed
634
635
}

Dries's avatar
   
Dries committed
636
637
638
639
640
641
642
/**
 * 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.
 */
643
function variable_initialize($conf = array()) {
644
645
  // NOTE: caching the variables improves performance by 20% when serving
  // cached pages.
646
  if ($cached = cache_get('variables', 'cache_bootstrap')) {
647
    $variables = $cached->data;
Dries's avatar
   
Dries committed
648
649
  }
  else {
650
651
652
653
654
655
656
657
658
659
660
661
662
663
    // 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
664
665
666
667
  }

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

Dries's avatar
   
Dries committed
670
  return $variables;
Dries's avatar
 
Dries committed
671
672
}

Dries's avatar
   
Dries committed
673
/**
674
675
676
677
678
 * 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
679
680
681
682
683
 *
 * @param $name
 *   The name of the variable to return.
 * @param $default
 *   The default value to use if this variable has never been set.
684
 *
Dries's avatar
   
Dries committed
685
686
 * @return
 *   The value of the variable.
687
 *
688
689
 * @see variable_del()
 * @see variable_set()
Dries's avatar
   
Dries committed
690
 */
691
function variable_get($name, $default = NULL) {
Dries's avatar
 
Dries committed
692
693
694
695
696
  global $conf;

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

Dries's avatar
   
Dries committed
697
/**
698
699
700
701
702
 * 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
703
704
705
706
707
708
 *
 * @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.
709
 *
710
711
 * @see variable_del()
 * @see variable_get()
Dries's avatar
   
Dries committed
712
 */
Dries's avatar
 
Dries committed
713
714
715
function variable_set($name, $value) {
  global $conf;

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

718
  cache_clear_all('variables', 'cache_bootstrap');
Dries's avatar
 
Dries committed
719
720
721
722

  $conf[$name] = $value;
}

Dries's avatar
   
Dries committed
723
/**
724
725
726
727
728
 * 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
729
730
731
 *
 * @param $name
 *   The name of the variable to undefine.
732
 *
733
734
 * @see variable_get()
 * @see variable_set()
Dries's avatar
   
Dries committed
735
 */
Dries's avatar
 
Dries committed
736
function variable_del($name) {
Dries's avatar
Dries committed
737
738
  global $conf;

739
740
741
  db_delete('variable')
    ->condition('name', $name)
    ->execute();
742
  cache_clear_all('variables', 'cache_bootstrap');
Dries's avatar
 
Dries committed
743

Dries's avatar
Dries committed
744
  unset($conf[$name]);
Dries's avatar
 
Dries committed
745
746
}

Dries's avatar
   
Dries committed
747
748
749
/**
 * Retrieve the current page from the cache.
 *
750
751
752
753
754
 * 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.
 *
755
756
757
758
 * @param $check_only
 *   (optional) Set to TRUE to only return whether a previous call found a
 *   cache entry.
 *
759
 * @return
760
 *   The cache object, if the page was found in the cache, NULL otherwise.
Dries's avatar
   
Dries committed
761
 */
762
function drupal_page_get_cache($check_only = FALSE) {
763
  global $base_root;
764
765
766
767
768
  static $cache_hit = FALSE;

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

770
  if (drupal_page_is_cacheable()) {
771
772
773
774
775
    $cache = cache_get($base_root . request_uri(), 'cache_page');
    if ($cache !== FALSE) {
      $cache_hit = TRUE;
    }
    return $cache;
776
  }
777
778
779
780
781
782
}

/**
 * Determine the cacheability of the current page.
 *
 * @param $allow_caching
783
784
 *   Set to FALSE if you want to prevent this page to get cached.
 *
785
 * @return
786
 *   TRUE if the current page can be cached, FALSE otherwise.
787
788
789
790
791
 */
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
792
  }
793
794

  return $allow_caching_static && ($_SERVER['REQUEST_METHOD'] == 'GET' || $_SERVER['REQUEST_METHOD'] == 'HEAD')
795
    && !drupal_is_cli();
Dries's avatar
 
Dries committed
796
797
}

798
/**
799
 * Invoke a bootstrap hook in all bootstrap modules that implement it.
800
801
 *
 * @param $hook
802
 *   The name of the bootstrap hook to invoke.
803
804
 *
 * @see bootstrap_hooks()
805
806
 */
function bootstrap_invoke_all($hook) {
807
  // Bootstrap modules should have been loaded when this function is called, so
808
809
810
811
812
813
  // 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.
814
  foreach (module_list(FALSE, TRUE) as $module) {
815
816
817
818
819
    drupal_load('module', $module);
    module_invoke($module, $hook);
  }
}

Dries's avatar
Dries committed
820
/**
821
 * Includes a file with the provided type and name. This prevents
Dries's avatar
Dries committed
822
823
824
825
826
827
828
829
830
831
832
 * 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) {
833
834
835
  // 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
836

837
  if (isset($files[$type][$name])) {
Dries's avatar
Dries committed
838
839
840
841
842
843
    return TRUE;
  }

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

  if ($filename) {
844
    include_once DRUPAL_ROOT . '/' . $filename;
Dries's avatar
Dries committed
845
846
847
848
849
850
851
852
    $files[$type][$name] = TRUE;

    return TRUE;
  }

  return FALSE;
}

853
854
855
856
857
858
859
/**
 * 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
860
 *   The HTTP header name, or the special 'Status' header name.
861
 * @param $value
862
863
864
 *   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".
865
866
867
 * @param $append
 *   Whether to append the value to an existing header or to replace it.
 */
868
function drupal_add_http_header($name, $value, $append = FALSE) {
869
  // The headers as name/value pairs.
870
  $headers = &drupal_static('drupal_http_headers', array());
871

872
  $name_lower = strtolower($name);
873
  _drupal_set_preferred_header_name($name);
874

875
  if ($value === FALSE) {
876
    $headers[$name_lower] = FALSE;
877
  }
878
  elseif (isset($headers[$name_lower]) && $append) {
879
880
    // Multiple headers with identical names may be combined using comma (RFC
    // 2616, section 4.2).
881
    $headers[$name_lower] .= ',' . $value;
882
883
  }
  else {
884
    $headers[$name_lower] = $value;
885
  }
886
  drupal_send_headers(array($name => $headers[$name_lower]), TRUE);
887
888
889
890
891
892
893
894
895
896
897
898
}

/**
 * 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.
 */
899
function drupal_get_http_header($name = NULL) {
900
  $headers = &drupal_static('drupal_http_headers', array());
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
  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;
}

/**
924
 * Send the HTTP response headers previously set using drupal_add_http_header().
925
 * Add default headers, unless they have been replaced or unset using
926
 * drupal_add_http_header().
927
928
929
930
931
932
933
934
 *
 * @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) {
  $headers_sent = &drupal_static(__FUNCTION__, FALSE);
935
  $headers = drupal_get_http_header();
936
937
938
939
940
941
942
943
944
945
946
947
948
949
  if ($only_default && $headers_sent) {
    $headers = array();
  }
  $headers_sent = TRUE;

  $header_names = _drupal_set_preferred_header_name();
  foreach ($default_headers as $name => $value) {
    $name_lower = strtolower($name);
    if (!isset($headers[$name_lower])) {
      $headers[$name_lower] = $value;
      $header_names[$name_lower] = $name;
    }
  }
  foreach ($headers as $name_lower => $value) {
950
    if ($name_lower == 'status') {
951
952
953
954
955
956
957
958
959
      header($_SERVER['SERVER_PROTOCOL'] . ' ' . $value);
    }
    // Skip headers that have been unset.
    elseif ($value) {
      header($header_names[$name_lower] . ': ' . $value);
    }
  }
}

Dries's avatar
   
Dries committed
960
961
/**
 * Set HTTP headers in preparation for a page response.
962
 *
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
 * Authenticated users are always given a 'no-cache' header, and will fetch a
 * fresh page on every request. This prevents authenticated users from seeing
 * locally cached pages.
 *
 * Also give each page a unique ETag. This will force clients to include both
 * an If-Modified-Since header and an If-None-Match header when doing
 * conditional requests for the page (required by RFC 2616, section 13.3.4),
 * making the validation more robust. This is a workaround for a bug in Mozilla
 * Firefox that is triggered when Drupal's caching is enabled and the user
 * accesses Drupal via an HTTP proxy (see
 * https://bugzilla.mozilla.org/show_bug.cgi?id=269303): When an authenticated
 * user requests a page, and then logs out and requests the same page again,
 * Firefox may send a conditional request based on the page that was cached
 * locally when the user was logged in. If this page did not have an ETag
 * header, the request only contains an If-Modified-Since header. The date will
 * be recent, because with authenticated users the Last-Modified header always
 * refers to the time of the request. If the user accesses Drupal via a proxy
 * server, and the proxy already has a cached copy of the anonymous page with an
 * older Last-Modified date, the proxy may respond with 304 Not Modified, making
 * the client think that the anonymous and authenticated pageviews are
 * identical.
984
 *
985
 * @see drupal_page_set_cache()
Dries's avatar
   
Dries committed
986
 */
Dries's avatar
 
Dries committed
987
function drupal_page_header() {
988
989
990
991
992
993
994
995
996
997
998
999
1000
  $headers_sent = &drupal_static(__FUNCTION__, FALSE);
  if ($headers_sent) {
    return TRUE;
  }
  $headers_sent = TRUE;

  $default_headers = array(
    'Expires' => 'Sun, 19 Nov 1978 05:00:00 GMT',
    'Last-Modified' => gmdate(DATE_RFC1123, REQUEST_TIME),
    'Cache-Control' => 'no-cache, must-revalidate, post-check=0, pre-check=0',
    'ETag' => '"' . REQUEST_TIME . '"',
  );
  drupal_send_headers($default_headers);
For faster browsing, not all history is shown. View entire blame