bootstrap.inc 72.8 KB
Newer Older
1
<?php
Dries's avatar
   
Dries committed
2
// $Id$
Dries's avatar
 
Dries committed
3

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

9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
/**
 * The current system version.
 */
define('VERSION', '7.0-dev');

/**
 * Core API compatibility.
 */
define('DRUPAL_CORE_COMPATIBILITY', '7.x');

/**
 * Minimum supported version of PHP.
 */
define('DRUPAL_MINIMUM_PHP',    '5.2.0');

/**
 * Minimum recommended value of PHP memory_limit.
 */
27
define('DRUPAL_MINIMUM_PHP_MEMORY_LIMIT',    '32M');
28
29
30
31
32
33
34
35
36
37
38

/**
 * Minimum supported version of MySQL, if it is used.
 */
define('DRUPAL_MINIMUM_MYSQL',  '5.0');

/**
 * Minimum supported version of PostgreSQL, if it is used.
 */
define('DRUPAL_MINIMUM_PGSQL',  '8.3');

39
40
41
42
/**
 * Indicates that the item should never be removed unless explicitly told to
 * using cache_clear_all() with a cache ID.
 */
43
define('CACHE_PERMANENT', 0);
44
45
46
47

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

50
51
52
/**
 * Indicates that page caching is disabled.
 */
53
define('CACHE_DISABLED', 0);
54
55
56
57

/**
 * Indicates that page caching is enabled, using "normal" mode.
 */
58
define('CACHE_NORMAL', 1);
59

60
/**
61
 * Log message severity -- Emergency: system is unusable.
62
 *
63
64
 * @see watchdog()
 * @see watchdog_severity_levels()
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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
define('WATCHDOG_EMERG', 0);

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

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

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

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

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

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

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

124
125
126
/**
 * First bootstrap phase: initialize configuration.
 */
127
define('DRUPAL_BOOTSTRAP_CONFIGURATION', 0);
128
129

/**
130
 * Second bootstrap phase: try to serve a cached page.
131
 */
132
define('DRUPAL_BOOTSTRAP_PAGE_CACHE', 1);
133
134
135
136

/**
 * Third bootstrap phase: initialize database layer.
 */
137
define('DRUPAL_BOOTSTRAP_DATABASE', 2);
138
139

/**
140
 * Fourth bootstrap phase: initialize the variable system.
141
 */
142
define('DRUPAL_BOOTSTRAP_VARIABLES', 3);
143
144

/**
145
 * Fifth bootstrap phase: initialize session handling.
146
 */
147
define('DRUPAL_BOOTSTRAP_SESSION', 4);
148
149

/**
150
 * Sixth bootstrap phase: set up the page header.
151
 */
152
define('DRUPAL_BOOTSTRAP_PAGE_HEADER', 5);
153
154

/**
155
 * Seventh bootstrap phase: find out language of the page.
156
 */
157
define('DRUPAL_BOOTSTRAP_LANGUAGE', 6);
158
159
160
161
162

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

165
166
167
/**
 * Role ID for anonymous users; should match what's in the "role" table.
 */
168
define('DRUPAL_ANONYMOUS_RID', 1);
169
170
171
172

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

175
/**
176
 * The number of bytes in a kilobyte. For more information, visit
177
178
179
180
 * http://en.wikipedia.org/wiki/Kilobyte.
 */
define('DRUPAL_KILOBYTE', 1024);

181
182
183
/**
 * The language code used when no language is explicitly assigned.
 *
184
 * Defined by ISO639-2 for "Undetermined".
185
 */
186
define('LANGUAGE_NONE', 'und');
187

188
/**
189
 * The type of language used to define the content language.
190
 */
191
define('LANGUAGE_TYPE_CONTENT', 'language');
192
193

/**
194
 * The type of language used to select the user interface.
195
 */
196
define('LANGUAGE_TYPE_INTERFACE', 'language_interface');
197
198

/**
199
 * The type of language used for URLs.
200
 */
201
define('LANGUAGE_TYPE_URL', 'language_url');
202

203
204
205
206
207
208
209
210
211
212
/**
 * 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);

213
214
215
/**
 * For convenience, define a short form of the request time global.
 */
216
define('REQUEST_TIME', $_SERVER['REQUEST_TIME']);
217

218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
/**
 * @name Title text filtering flags
 * @{
 * Flags for use in drupal_set_title().
 */

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

234
/**
235
 * Signals that the registry lookup cache should be reset.
236
237
238
239
 */
define('REGISTRY_RESET_LOOKUP_CACHE', 1);

/**
240
 * Signals that the registry lookup cache should be written to storage.
241
242
243
 */
define('REGISTRY_WRITE_LOOKUP_CACHE', 2);

244
245
246
247
248
/**
 * @} End of "Title text filtering flags".
 */


Dries's avatar
   
Dries committed
249
/**
250
251
 * 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
252
253
254
255
256
257
258
 *
 * @param name
 *   The name of the timer.
 */
function timer_start($name) {
  global $timers;

259
  $timers[$name]['start'] = microtime(TRUE);
260
  $timers[$name]['count'] = isset($timers[$name]['count']) ? ++$timers[$name]['count'] : 1;
Dries's avatar
   
Dries committed
261
262
263
264
265
266
267
268
269
270
271
272
273
}

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

274
  if (isset($timers[$name]['start'])) {
275
    $stop = microtime(TRUE);
276
    $diff = round(($stop - $timers[$name]['start']) * 1000, 2);
Dries's avatar
   
Dries committed
277

278
279
280
281
    if (isset($timers[$name]['time'])) {
      $diff += $timers[$name]['time'];
    }
    return $diff;
282
  }
283
  return $timers[$name]['time'];
Dries's avatar
   
Dries committed
284
285
286
287
288
289
290
291
}

/**
 * Stop the timer with the specified name.
 *
 * @param name
 *   The name of the timer.
 * @return
292
293
 *   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
294
295
296
297
 */
function timer_stop($name) {
  global $timers;

298
299
300
301
302
303
  if (isset($timers[$name]['time'])) {
    $timers[$name]['time'] += timer_read($name);
  }
  else {
    $timers[$name]['time'] = timer_read($name);
  }
Dries's avatar
   
Dries committed
304
305
306
307
  unset($timers[$name]['start']);

  return $timers[$name];
}
308

Dries's avatar
   
Dries committed
309
/**
310
 * Find the appropriate configuration directory.
Dries's avatar
   
Dries committed
311
 *
312
313
 * Try finding a matching configuration directory by stripping the website's
 * hostname from left to right and pathname from right to left. The first
314
 * configuration file found will be used; the remaining will ignored. If no
315
 * configuration file is found, return a default value '$confdir/default'.
Dries's avatar
Dries committed
316
 *
317
 * Example for a fictitious site installed at
318
319
 * http://www.drupal.org:8080/mysite/test/ the 'settings.php' is searched in
 * the following directories:
Dries's avatar
   
Dries committed
320
 *
321
322
323
324
 *  1. $confdir/8080.www.drupal.org.mysite.test
 *  2. $confdir/www.drupal.org.mysite.test
 *  3. $confdir/drupal.org.mysite.test
 *  4. $confdir/org.mysite.test
Dries's avatar
   
Dries committed
325
 *
326
327
328
329
 *  5. $confdir/8080.www.drupal.org.mysite
 *  6. $confdir/www.drupal.org.mysite
 *  7. $confdir/drupal.org.mysite
 *  8. $confdir/org.mysite
Dries's avatar
   
Dries committed
330
 *
331
332
333
334
 *  9. $confdir/8080.www.drupal.org
 * 10. $confdir/www.drupal.org
 * 11. $confdir/drupal.org
 * 12. $confdir/org
Dries's avatar
   
Dries committed
335
 *
336
 * 13. $confdir/default
337
 *
338
 * If a file named sites.php is present in the $confdir, it will be loaded
339
340
 * prior to scanning for directories. It should define an associative array
 * named $sites, which maps domains to directories. It should be in the form
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 * of:
 *
 * $sites = array(
 *   'The url to alias' => 'A directory within the sites directory'
 * );
 *
 * For example:
 *
 * $sites = array(
 *   'devexample.com' => 'example.com',
 *   'localhost/example' => 'example.com',
 * );
 *
 * 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
358
 * domain of the live server. Since Drupal stores file paths into the database
359
360
361
 * (files, system table, etc.) this will ensure the paths are correct while
 * accessed on development servers.
 *
362
363
364
365
366
367
368
369
370
371
 * @param $require_settings
 *   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.
 * @param reset
 *   Force a full search for matching directories even if one had been
 *   found previously.
 * @return
 *   The path of the matching directory.
Dries's avatar
   
Dries committed
372
 */
373
function conf_path($require_settings = TRUE, $reset = FALSE) {
374
  $conf = &drupal_static(__FUNCTION__, '');
Dries's avatar
 
Dries committed
375

376
  if ($conf && !$reset) {
Dries's avatar
Dries committed
377
378
    return $conf;
  }
Dries's avatar
 
Dries committed
379

Dries's avatar
   
Dries committed
380
  $confdir = 'sites';
381
382
383
384
385
386
387

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

388
  $uri = explode('/', $_SERVER['SCRIPT_NAME'] ? $_SERVER['SCRIPT_NAME'] : $_SERVER['SCRIPT_FILENAME']);
389
  $server = explode('.', implode('.', array_reverse(explode(':', rtrim($_SERVER['HTTP_HOST'], '.')))));
Dries's avatar
Dries committed
390
391
392
  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));
393
394
395
396
      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
397
398
399
        $conf = "$confdir/$dir";
        return $conf;
      }
Dries's avatar
 
Dries committed
400
401
    }
  }
Dries's avatar
Dries committed
402
403
  $conf = "$confdir/default";
  return $conf;
Dries's avatar
 
Dries committed
404
405
}

406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
/**
 * 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()) {
  // Set defaults based on the provided URL.
  if (isset($variables['url'])) {
    $url = parse_url($variables['url']);
    unset($variables['url']);
  }
  else {
    $url = array();
  }
  $url += array(
    'path' => '',
    'host' => 'localhost',
  );
  $defaults = array(
    'HTTP_HOST' => $url['host'],
    'SCRIPT_NAME' => $url['path'],
    'REMOTE_ADDR' => '127.0.0.1',
    'REQUEST_METHOD' => 'GET',
    'SERVER_NAME' => NULL,
459
    'SERVER_SOFTWARE' => NULL,
460
461
462
463
464
465
    'HTTP_USER_AGENT' => NULL,
  );
  // Replace elements of the $_SERVER array, as appropriate.
  $_SERVER = $variables + $_SERVER + $defaults;
}

466
/**
467
 * Initialize PHP environment.
468
 */
469
function drupal_environment_initialize() {
470
471
  if (!isset($_SERVER['HTTP_REFERER'])) {
    $_SERVER['HTTP_REFERER'] = '';
472
  }
473
474
475
  if (!isset($_SERVER['SERVER_PROTOCOL']) || ($_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.0' && $_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.1')) {
    $_SERVER['SERVER_PROTOCOL'] = 'HTTP/1.0';
  }
476

477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
  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'] = '';
492
493
  }

494
495
  // Enforce E_ALL, but allow users to set levels not part of E_ALL.
  error_reporting(E_ALL | error_reporting());
496

497
498
499
  // 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.
500

501
  // Prevent PHP from generating HTML error messages.
502
  ini_set('html_errors', 0);
503
  // Don't escape quotes when reading files from the database, disk, etc.
504
  ini_set('magic_quotes_runtime', '0');
505
506
  // Use session cookies, not transparent sessions that puts the session id in
  // the query string.
507
  ini_set('session.use_cookies', '1');
508
  ini_set('session.use_only_cookies', '1');
509
  ini_set('session.use_trans_sid', '0');
510
511
  // Don't send HTTP headers using PHP's session handler.
  ini_set('session.cache_limiter', 'none');
512
513
  // Use httponly session cookies.
  ini_set('session.cookie_httponly', '1');
514
515
}

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

526
/**
527
528
 * Loads the configuration and sets the base URL, cookie domain, and
 * session name correctly.
529
 */
530
function drupal_settings_initialize() {
531
532
  global $base_url, $base_path, $base_root;

Dries's avatar
Dries committed
533
  // Export the following settings.php variables to the global namespace
534
  global $databases, $db_prefix, $cookie_domain, $conf, $installed_profile, $update_free_access, $db_url, $is_https, $base_secure_url, $base_insecure_url;
Dries's avatar
Dries committed
535
536
  $conf = array();

537
538
  if (file_exists(DRUPAL_ROOT . '/' . conf_path() . '/settings.php')) {
    include_once DRUPAL_ROOT . '/' . conf_path() . '/settings.php';
539
  }
540
541
542
543

  if (isset($base_url)) {
    // Parse fixed base URL from settings.php.
    $parts = parse_url($base_url);
544
    $http_protocol = $parts['scheme'];
545
546
547
    if (!isset($parts['path'])) {
      $parts['path'] = '';
    }
548
    $base_path = $parts['path'] . '/';
549
550
551
552
553
    // 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
554
555
    $http_protocol = (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on') ? 'https' : 'http';
    $base_root = $http_protocol . '://' . $_SERVER['HTTP_HOST'];
556

557
    $base_url = $base_root;
558
559
560
561

    // $_SERVER['SCRIPT_NAME'] can, in contrast to $_SERVER['PHP_SELF'], not
    // be modified by a visitor.
    if ($dir = trim(dirname($_SERVER['SCRIPT_NAME']), '\,/')) {
562
563
564
565
566
567
568
569
      $base_path = "/$dir";
      $base_url .= $base_path;
      $base_path .= '/';
    }
    else {
      $base_path = '/';
    }
  }
570
571
572
  $is_https = $http_protocol == 'https';
  $base_secure_url = str_replace('http://', 'https://', $base_url);
  $base_insecure_url = str_replace('https://', 'http://', $base_url);
573
574
575
576
577
578

  if ($cookie_domain) {
    // If the user specifies the cookie domain, also use it for session name.
    $session_name = $cookie_domain;
  }
  else {
579
580
581
    // 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);
582
    // We escape the hostname because it can be modified by a visitor.
583
    if (!empty($_SERVER['HTTP_HOST'])) {
584
      $cookie_domain = check_plain($_SERVER['HTTP_HOST']);
585
586
587
588
589
590
591
    }
  }
  // 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);
  }
592
  $cookie_domain = explode(':', $cookie_domain);
593
  $cookie_domain = '.' . $cookie_domain[0];
594
595
596
597
598
  // 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);
  }
599
600
601
602
603
604
605
606
607
608
609
  // 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';
  session_name($prefix . md5($session_name));
610
611
}

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

645
  if (!isset($files[$type])) {
Dries's avatar
Dries committed
646
647
648
    $files[$type] = array();
  }

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

689
690
691
      if (!function_exists('drupal_system_listing')) {
        require_once DRUPAL_ROOT . '/includes/common.inc';
      }
692
693
694
695
696
697
698
      // Scan the appropriate directories for all files with the requested
      // extension, not just the file we are currently looking for. This
      // prevents unnecessary scans from being repeated when this function is
      // called more than once in the same page request.
      $matches = drupal_system_listing("/\.$extension$/", $dir, 'name', 0);
      foreach ($matches as $matched_name => $file) {
        $files[$type][$matched_name] = $file->uri;
Dries's avatar
Dries committed
699
700
701
702
      }
    }
  }

703
704
705
  if (isset($files[$type][$name])) {
    return $files[$type][$name];
  }
Dries's avatar
Dries committed
706
707
}

Dries's avatar
   
Dries committed
708
709
710
711
712
713
714
/**
 * 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.
 */
715
function variable_initialize($conf = array()) {
716
  // NOTE: caching the variables improves performance by 20% when serving cached pages.
717
  if ($cached = cache_get('variables', 'cache_bootstrap')) {
718
    $variables = $cached->data;
Dries's avatar
   
Dries committed
719
720
  }
  else {
721
    $variables = array_map('unserialize', db_query('SELECT name, value FROM {variable}')->fetchAllKeyed());
722
    cache_set('variables', $variables, 'cache_bootstrap');
Dries's avatar
   
Dries committed
723
724
725
726
  }

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

Dries's avatar
   
Dries committed
729
  return $variables;
Dries's avatar
 
Dries committed
730
731
}

Dries's avatar
   
Dries committed
732
733
734
735
736
737
738
739
740
/**
 * Return a persistent variable.
 *
 * @param $name
 *   The name of the variable to return.
 * @param $default
 *   The default value to use if this variable has never been set.
 * @return
 *   The value of the variable.
741
742
 *
 * @see variable_del(), variable_set()
Dries's avatar
   
Dries committed
743
 */
744
function variable_get($name, $default = NULL) {
Dries's avatar
 
Dries committed
745
746
747
748
749
  global $conf;

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

Dries's avatar
   
Dries committed
750
751
752
753
754
755
756
757
/**
 * Set a persistent variable.
 *
 * @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.
758
759
 *
 * @see variable_del(), variable_get()
Dries's avatar
   
Dries committed
760
 */
Dries's avatar
 
Dries committed
761
762
763
function variable_set($name, $value) {
  global $conf;

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

766
  cache_clear_all('variables', 'cache_bootstrap');
Dries's avatar
 
Dries committed
767
768
769
770

  $conf[$name] = $value;
}

Dries's avatar
   
Dries committed
771
772
773
774
775
/**
 * Unset a persistent variable.
 *
 * @param $name
 *   The name of the variable to undefine.
776
777
 *
 * @see variable_get(), variable_set()
Dries's avatar
   
Dries committed
778
 */
Dries's avatar
 
Dries committed
779
function variable_del($name) {
Dries's avatar
Dries committed
780
781
  global $conf;

782
783
784
  db_delete('variable')
    ->condition('name', $name)
    ->execute();
785
  cache_clear_all('variables', 'cache_bootstrap');
Dries's avatar
 
Dries committed
786

Dries's avatar
Dries committed
787
  unset($conf[$name]);
Dries's avatar
 
Dries committed
788
789
}

Dries's avatar
   
Dries committed
790
791
792
/**
 * Retrieve the current page from the cache.
 *
793
794
795
796
797
 * 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.
 *
798
799
800
801
 * @param $check_only
 *   (optional) Set to TRUE to only return whether a previous call found a
 *   cache entry.
 *
802
 * @return
803
 *   The cache object, if the page was found in the cache, NULL otherwise.
Dries's avatar
   
Dries committed
804
 */
805
function drupal_page_get_cache($check_only = FALSE) {
806
  global $base_root;
807
808
809
810
811
  static $cache_hit = FALSE;

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

813
  if (drupal_page_is_cacheable()) {
814
815
816
817
818
    $cache = cache_get($base_root . request_uri(), 'cache_page');
    if ($cache !== FALSE) {
      $cache_hit = TRUE;
    }
    return $cache;
819
  }
820
821
822
823
824
825
}

/**
 * Determine the cacheability of the current page.
 *
 * @param $allow_caching
826
827
 *   Set to FALSE if you want to prevent this page to get cached.
 *
828
 * @return
829
 *   TRUE if the current page can be cached, FALSE otherwise.
830
831
832
833
834
 */
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
835
  }
836
837

  return $allow_caching_static && ($_SERVER['REQUEST_METHOD'] == 'GET' || $_SERVER['REQUEST_METHOD'] == 'HEAD')
838
    && !drupal_is_cli();
Dries's avatar
 
Dries committed
839
840
}

841
842
843
844
845
846
847
/**
 * Call all init or exit hooks without including all modules.
 *
 * @param $hook
 *   The name of the bootstrap hook we wish to invoke.
 */
function bootstrap_invoke_all($hook) {
848
849
850
  // _drupal_bootstrap_page_cache() already loaded the bootstrap modules, so we
  // don't need to tell module_list() to reset its bootstrap list.
  foreach (module_list(FALSE, TRUE) as $module) {
851
852
853
854
855
    drupal_load('module', $module);
    module_invoke($module, $hook);
  }
}

Dries's avatar
Dries committed
856
/**
857
 * Includes a file with the provided type and name. This prevents
Dries's avatar
Dries committed
858
859
860
861
862
863
864
865
866
867
868
 * 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) {
869
870
871
  // 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
872

873
  if (isset($files[$type][$name])) {
Dries's avatar
Dries committed
874
875
876
877
878
879
    return TRUE;
  }

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

  if ($filename) {
880
    include_once DRUPAL_ROOT . '/' . $filename;
Dries's avatar
Dries committed
881
882
883
884
885
886
887
888
    $files[$type][$name] = TRUE;

    return TRUE;
  }

  return FALSE;
}

889
890
891
892
893
894
895
896
897
898
899
900
901
902
/**
 * 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
 *   The HTTP header name, or a status code followed by a reason phrase, e.g.
 *   "404 Not Found".
 * @param $value
 *   The HTTP header value; if omitted, the specified header is unset.
 * @param $append
 *   Whether to append the value to an existing header or to replace it.
 */
903
function drupal_add_http_header($name = NULL, $value = NULL, $append = FALSE) {
904
905
906
907
908
909
910
911
912
913
  // The headers as name/value pairs.
  $headers = &drupal_static(__FUNCTION__, array());

  if (!isset($name)) {
    return $headers;
  }

  // Save status codes using the special key ":status".
  if (preg_match('/^\d{3} /', $name)) {
    $value = $name;
914
    $name = $name_lower = ':status';
915
916
  }
  else {
917
    $name_lower = strtolower($name);
918
  }
919
  _drupal_set_preferred_header_name($name);
920
921

  if (!isset($value)) {
922
    $headers[$name_lower] = FALSE;
923
  }
924
  elseif (isset($headers[$name_lower]) && $append) {
925
926
    // Multiple headers with identical names may be combined using comma (RFC
    // 2616, section 4.2).
927
    $headers[$name_lower] .= ',' . $value;
928
929
  }
  else {
930
    $headers[$name_lower] = $value;
931
  }
932
  drupal_send_headers(array($name => $headers[$name_lower]), TRUE);
933
934
935
936
937
938
939
940
941
942
943
944
}

/**
 * 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.
 */
945
946
function drupal_get_http_header($name = NULL) {
  $headers = drupal_add_http_header();
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
  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;
}

/**
970
 * Send the HTTP response headers previously set using drupal_add_http_header().
971
 * Add default headers, unless they have been replaced or unset using
972
 * drupal_add_http_header().
973
974
975
976
977
978
979
980
 *
 * @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);
981
  $headers = drupal_get_http_header();
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
  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) {
    if ($name_lower == ':status') {
      header($_SERVER['SERVER_PROTOCOL'] . ' ' . $value);
    }
    // Skip headers that have been unset.
    elseif ($value) {
For faster browsing, not all history is shown. View entire blame