bootstrap.inc 99.3 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
195
/**
 * For convenience, define a short form of the request time global.
 */
196
define('REQUEST_TIME', $_SERVER['REQUEST_TIME']);
197

198
199
200
201
202
203
204
205
206
207
/**
 * 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);

208
/**
209
 * Signals that the registry lookup cache should be reset.
210
211
212
213
 */
define('REGISTRY_RESET_LOOKUP_CACHE', 1);

/**
214
 * Signals that the registry lookup cache should be written to storage.
215
216
217
 */
define('REGISTRY_WRITE_LOOKUP_CACHE', 2);

218
219
220
221
222
223
224
/**
 * 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
225
/**
226
227
 * 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
228
229
230
231
232
233
234
 *
 * @param name
 *   The name of the timer.
 */
function timer_start($name) {
  global $timers;

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

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

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

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

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

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

  return $timers[$name];
}
288

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

356
  if ($conf && !$reset) {
Dries's avatar
Dries committed
357
358
    return $conf;
  }
Dries's avatar
 
Dries committed
359

Dries's avatar
   
Dries committed
360
  $confdir = 'sites';
361
362
363
364
365
366
367

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

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

386
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
/**
 * 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()) {
421
  // Allow the provided URL to override any existing values in $_SERVER.
422
423
  if (isset($variables['url'])) {
    $url = parse_url($variables['url']);
424
425
426
427
428
429
    if (isset($url['host'])) {
      $_SERVER['HTTP_HOST'] = $url['host'];
    }
    if (isset($url['path'])) {
      $_SERVER['SCRIPT_NAME'] = $url['path'];
    }
430
431
    unset($variables['url']);
  }
432
433
434
  // 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.
435
  $defaults = array(
436
437
    'HTTP_HOST' => 'localhost',
    'SCRIPT_NAME' => NULL,
438
439
440
    'REMOTE_ADDR' => '127.0.0.1',
    'REQUEST_METHOD' => 'GET',
    'SERVER_NAME' => NULL,
441
    'SERVER_SOFTWARE' => NULL,
442
443
444
445
446
447
    'HTTP_USER_AGENT' => NULL,
  );
  // Replace elements of the $_SERVER array, as appropriate.
  $_SERVER = $variables + $_SERVER + $defaults;
}

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

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

476
477
478
479
480
481
482
  // 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();

483
484
  // Enforce E_ALL, but allow users to set levels not part of E_ALL.
  error_reporting(E_ALL | error_reporting());
485

486
487
488
  // 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.
489

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

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

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

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

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

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

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

549
    $base_url = $base_root;
550
551
552

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

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

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

637
  if (!isset($files[$type])) {
Dries's avatar
Dries committed
638
639
640
    $files[$type] = array();
  }

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

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

695
696
697
  if (isset($files[$type][$name])) {
    return $files[$type][$name];
  }
Dries's avatar
Dries committed
698
699
}

Dries's avatar
   
Dries committed
700
701
702
703
704
705
706
/**
 * 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.
 */
707
function variable_initialize($conf = array()) {
708
709
  // NOTE: caching the variables improves performance by 20% when serving
  // cached pages.
710
  if ($cached = cache_get('variables', 'cache_bootstrap')) {
711
    $variables = $cached->data;
Dries's avatar
   
Dries committed
712
713
  }
  else {
714
715
716
717
718
719
720
721
722
723
724
725
726
727
    // 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
728
729
730
731
  }

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

Dries's avatar
   
Dries committed
734
  return $variables;
Dries's avatar
 
Dries committed
735
736
}

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

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

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

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

782
  cache_clear_all('variables', 'cache_bootstrap');
Dries's avatar
 
Dries committed
783
784
785
786

  $conf[$name] = $value;
}

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

803
804
805
  db_delete('variable')
    ->condition('name', $name)
    ->execute();
806
  cache_clear_all('variables', 'cache_bootstrap');
Dries's avatar
 
Dries committed
807

Dries's avatar
Dries committed
808
  unset($conf[$name]);
Dries's avatar
 
Dries committed
809
810
}

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

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

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

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

  return $allow_caching_static && ($_SERVER['REQUEST_METHOD'] == 'GET' || $_SERVER['REQUEST_METHOD'] == 'HEAD')
859
    && !drupal_is_cli();
Dries's avatar
 
Dries committed
860
861
}

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

Dries's avatar
Dries committed
884
/**
885
 * Includes a file with the provided type and name. This prevents
Dries's avatar
Dries committed
886
887
888
889
890
891
892
893
894
895
896
 * 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) {
897
898
899
  // 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
900

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

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

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

    return TRUE;
  }

  return FALSE;
}

917
918
919
920
921
922
923
/**
 * 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
924
 *   The HTTP header name, or the special 'Status' header name.
925
 * @param $value
926
927
928
 *   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".
929
930
931
 * @param $append
 *   Whether to append the value to an existing header or to replace it.
 */
932
function drupal_add_http_header($name, $value, $append = FALSE) {
933
  // The headers as name/value pairs.
934
  $headers = &drupal_static('drupal_http_headers', array());
935

936
  $name_lower = strtolower($name);
937
  _drupal_set_preferred_header_name($name);
938

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

/**
 * 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.
 */
963
function drupal_get_http_header($name = NULL) {
964
  $headers = &drupal_static('drupal_http_headers', array());
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
  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;
}

/**
988
 * Send the HTTP response headers previously set using drupal_add_http_header().
989
 * Add default headers, unless they have been replaced or unset using
990
 * drupal_add_http_header().
991
992
993
994
995
996
997
998
 *
 * @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);
999
  $headers = drupal_get_http_header();
1000
  if ($only_default && $headers_sent) {
For faster browsing, not all history is shown. View entire blame