bootstrap.inc 45.2 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
/**
 * Indicates that the item should never be removed unless explicitly told to
 * using cache_clear_all() with a cache ID.
 */
13
define('CACHE_PERMANENT', 0);
14
15
16
17

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

20
21
22
/**
 * Indicates that page caching is disabled.
 */
23
define('CACHE_DISABLED', 0);
24
25
26
27

/**
 * Indicates that page caching is enabled, using "normal" mode.
 */
28
define('CACHE_NORMAL', 1);
29
30
31
32
33
34

/**
 * Indicates that page caching is using "aggressive" mode. This bypasses
 * loading any modules for additional speed, which may break functionality in
 * modules that expect to be run on each page load.
 */
35
define('CACHE_AGGRESSIVE', 2);
36

37
/**
38
 * Log message severity -- Emergency: system is unusable.
39
 *
40
41
 * @see watchdog()
 * @see watchdog_severity_levels()
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
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);
100

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

/**
 * Second bootstrap phase: try to call a non-database cache
 * fetch routine.
 */
110
define('DRUPAL_BOOTSTRAP_EARLY_PAGE_CACHE', 1);
111
112
113
114

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

/**
 * Fourth bootstrap phase: identify and reject banned hosts.
 */
120
define('DRUPAL_BOOTSTRAP_ACCESS', 3);
121
122
123
124

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

/**
 * Sixth bootstrap phase: load bootstrap.inc and module.inc, start
 * the variable system and try to serve a page from the cache.
 */
131
define('DRUPAL_BOOTSTRAP_LATE_PAGE_CACHE', 5);
132
133

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

/**
 * Eighth bootstrap phase: set $_GET['q'] to Drupal path of request.
 */
define('DRUPAL_BOOTSTRAP_PATH', 7);
142
143
144
145
146

/**
 * Final bootstrap phase: Drupal is fully loaded; validate and fix
 * input data.
 */
147
define('DRUPAL_BOOTSTRAP_FULL', 8);
148

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

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

159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
/**
 * No language negotiation. The default language is used.
 */
define('LANGUAGE_NEGOTIATION_NONE', 0);

/**
 * Path based negotiation with fallback to default language
 * if no defined path prefix identified.
 */
define('LANGUAGE_NEGOTIATION_PATH_DEFAULT', 1);

/**
 * Path based negotiation with fallback to user preferences
 * and browser language detection if no defined path prefix
 * identified.
 */
define('LANGUAGE_NEGOTIATION_PATH', 2);

/**
 * Domain based negotiation with fallback to default language
 * if no language identified by domain.
 */
define('LANGUAGE_NEGOTIATION_DOMAIN', 3);

183
184
185
186
187
/**
 * For convenience, define a short form of the request time global.
 */
define ('REQUEST_TIME', $_SERVER['REQUEST_TIME']);

Dries's avatar
   
Dries committed
188
/**
189
 * Start the timer with the specified name. If you start and stop
Dries's avatar
   
Dries committed
190
191
192
193
194
195
196
197
198
199
200
 * the same timer multiple times, the measured intervals will be
 * accumulated.
 *
 * @param name
 *   The name of the timer.
 */
function timer_start($name) {
  global $timers;

  list($usec, $sec) = explode(' ', microtime());
  $timers[$name]['start'] = (float)$usec + (float)$sec;
201
  $timers[$name]['count'] = isset($timers[$name]['count']) ? ++$timers[$name]['count'] : 1;
Dries's avatar
   
Dries committed
202
203
204
205
206
207
208
209
210
211
212
213
214
}

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

215
216
217
218
  if (isset($timers[$name]['start'])) {
    list($usec, $sec) = explode(' ', microtime());
    $stop = (float)$usec + (float)$sec;
    $diff = round(($stop - $timers[$name]['start']) * 1000, 2);
Dries's avatar
   
Dries committed
219

220
221
222
223
    if (isset($timers[$name]['time'])) {
      $diff += $timers[$name]['time'];
    }
    return $diff;
224
  }
Dries's avatar
   
Dries committed
225
226
227
228
229
230
231
232
}

/**
 * Stop the timer with the specified name.
 *
 * @param name
 *   The name of the timer.
 * @return
233
 *   A timer array. The array contains the number of times the
Dries's avatar
   
Dries committed
234
235
236
237
238
239
 *   timer has been started and stopped (count) and the accumulated
 *   timer value in ms (time).
 */
function timer_stop($name) {
  global $timers;

240
  $timers[$name]['time'] = timer_read($name);
Dries's avatar
   
Dries committed
241
242
243
244
  unset($timers[$name]['start']);

  return $timers[$name];
}
245

Dries's avatar
   
Dries committed
246
/**
247
 * Find the appropriate configuration directory.
Dries's avatar
   
Dries committed
248
 *
249
250
 * Try finding a matching configuration directory by stripping the website's
 * hostname from left to right and pathname from right to left. The first
251
 * configuration file found will be used; the remaining will ignored. If no
252
 * configuration file is found, return a default value '$confdir/default'.
Dries's avatar
Dries committed
253
 *
254
 * Example for a fictitious site installed at
255
256
 * http://www.drupal.org:8080/mysite/test/ the 'settings.php' is searched in
 * the following directories:
Dries's avatar
   
Dries committed
257
 *
258
259
260
261
 *  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
262
 *
263
264
265
266
 *  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
267
 *
268
269
270
271
 *  9. $confdir/8080.www.drupal.org
 * 10. $confdir/www.drupal.org
 * 11. $confdir/drupal.org
 * 12. $confdir/org
Dries's avatar
   
Dries committed
272
 *
273
 * 13. $confdir/default
274
275
276
277
278
279
280
281
282
283
284
 *
 * @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
285
 */
286
function conf_path($require_settings = TRUE, $reset = FALSE) {
Dries's avatar
Dries committed
287
  static $conf = '';
Dries's avatar
 
Dries committed
288

289
  if ($conf && !$reset) {
Dries's avatar
Dries committed
290
291
    return $conf;
  }
Dries's avatar
 
Dries committed
292

Dries's avatar
   
Dries committed
293
  $confdir = 'sites';
294
  $uri = explode('/', $_SERVER['SCRIPT_NAME'] ? $_SERVER['SCRIPT_NAME'] : $_SERVER['SCRIPT_FILENAME']);
295
  $server = explode('.', implode('.', array_reverse(explode(':', rtrim($_SERVER['HTTP_HOST'], '.')))));
Dries's avatar
Dries committed
296
297
298
  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));
299
      if (file_exists("$confdir/$dir/settings.php") || (!$require_settings && file_exists("$confdir/$dir"))) {
Dries's avatar
Dries committed
300
301
302
        $conf = "$confdir/$dir";
        return $conf;
      }
Dries's avatar
 
Dries committed
303
304
    }
  }
Dries's avatar
Dries committed
305
306
  $conf = "$confdir/default";
  return $conf;
Dries's avatar
 
Dries committed
307
308
}

309
/**
310
311
312
313
314
 * Initialize variables needed for the rest of the execution.
 */
function drupal_initialize_variables() {
  if (!isset($_SERVER['HTTP_REFERER'])) {
    $_SERVER['HTTP_REFERER'] = '';
315
  }
316
317
318
  if (!isset($_SERVER['SERVER_PROTOCOL']) || ($_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.0' && $_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.1')) {
    $_SERVER['SERVER_PROTOCOL'] = 'HTTP/1.0';
  }
319
320
}

321
/**
322
323
 * Loads the configuration and sets the base URL, cookie domain, and
 * session name correctly.
324
325
 */
function conf_init() {
326
327
  global $base_url, $base_path, $base_root;

Dries's avatar
Dries committed
328
  // Export the following settings.php variables to the global namespace
329
  global $databases, $db_prefix, $cookie_domain, $conf, $installed_profile, $update_free_access;
Dries's avatar
Dries committed
330
331
  $conf = array();

332
333
  if (file_exists(DRUPAL_ROOT . '/' . conf_path() . '/settings.php')) {
    include_once DRUPAL_ROOT . '/' . conf_path() . '/settings.php';
334
  }
335
336
337
338

  if (isset($base_url)) {
    // Parse fixed base URL from settings.php.
    $parts = parse_url($base_url);
339
340
341
    if (!isset($parts['path'])) {
      $parts['path'] = '';
    }
342
    $base_path = $parts['path'] . '/';
343
344
345
346
347
348
    // 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
    $base_root = (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on') ? 'https' : 'http';
349
350
351

    // As $_SERVER['HTTP_HOST'] is user input, ensure it only contains
    // characters allowed in hostnames.
352
    $base_url = $base_root .= '://' . preg_replace('/[^a-z0-9-:._]/i', '', $_SERVER['HTTP_HOST']);
353
354
355
356

    // $_SERVER['SCRIPT_NAME'] can, in contrast to $_SERVER['PHP_SELF'], not
    // be modified by a visitor.
    if ($dir = trim(dirname($_SERVER['SCRIPT_NAME']), '\,/')) {
357
358
359
360
361
362
363
364
      $base_path = "/$dir";
      $base_url .= $base_path;
      $base_path .= '/';
    }
    else {
      $base_path = '/';
    }
  }
365
366
367
368
369
370

  if ($cookie_domain) {
    // If the user specifies the cookie domain, also use it for session name.
    $session_name = $cookie_domain;
  }
  else {
371
372
373
    // 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);
374
    // We escape the hostname because it can be modified by a visitor.
375
    if (!empty($_SERVER['HTTP_HOST'])) {
376
      $cookie_domain = check_plain($_SERVER['HTTP_HOST']);
377
378
    }
  }
379
380
381
382
383
384
385
386
387
  // 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 (ini_get('session.cookie_secure')) {
    $session_name .= 'SSL';
  }
388
389
390
391
392
  // 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);
  }
393
  $cookie_domain = explode(':', $cookie_domain);
394
  $cookie_domain = '.' . $cookie_domain[0];
395
396
397
398
399
  // 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);
  }
400
  session_name('SESS' . md5($session_name));
401
402
}

Dries's avatar
Dries committed
403
404
/**
 * Returns and optionally sets the filename for a system item (module,
405
 * theme, etc.). The filename, whether provided, cached, or retrieved
Dries's avatar
Dries committed
406
407
 * from the database, is only returned if the file exists.
 *
Dries's avatar
Dries committed
408
409
410
411
412
413
414
415
416
417
418
419
 * 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
420
421
422
423
424
425
426
427
428
429
430
 * @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
431
function drupal_get_filename($type, $name, $filename = NULL) {
Dries's avatar
Dries committed
432
433
  static $files = array();

434
  if (!isset($files[$type])) {
Dries's avatar
Dries committed
435
436
437
    $files[$type] = array();
  }

438
  if (!empty($filename) && file_exists($filename)) {
Dries's avatar
Dries committed
439
440
    $files[$type][$name] = $filename;
  }
441
  elseif (isset($files[$type][$name])) {
Dries's avatar
Dries committed
442
443
    // nothing
  }
Dries's avatar
Dries committed
444
445
446
447
  // Verify that we have an active database connection, before querying
  // the database.  This is required because this function is called both
  // before we have a database connection (i.e. during installation) and
  // when a database connection fails.
448
  elseif (db_is_active() && (($file = db_result(db_query("SELECT filename FROM {system} WHERE name = '%s' AND type = '%s'", $name, $type))) && file_exists($file))) {
Dries's avatar
Dries committed
449
450
451
    $files[$type][$name] = $file;
  }
  else {
Dries's avatar
Dries committed
452
453
    // Fallback to searching the filesystem if the database connection is
    // not established or the requested file is not found.
Steven Wittens's avatar
Steven Wittens committed
454
    $config = conf_path();
Dries's avatar
Dries committed
455
    $dir = (($type == 'theme_engine') ? 'themes/engines' : "${type}s");
Dries's avatar
   
Dries committed
456
    $file = (($type == 'theme_engine') ? "$name.engine" : "$name.$type");
Dries's avatar
Dries committed
457
458
459
460
461
462
463
464
465

    foreach (array("$config/$dir/$file", "$config/$dir/$name/$file", "$dir/$file", "$dir/$name/$file") as $file) {
      if (file_exists($file)) {
        $files[$type][$name] = $file;
        break;
      }
    }
  }

466
467
468
  if (isset($files[$type][$name])) {
    return $files[$type][$name];
  }
Dries's avatar
Dries committed
469
470
}

Dries's avatar
   
Dries committed
471
472
473
474
475
476
477
/**
 * 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.
 */
Dries's avatar
 
Dries committed
478
function variable_init($conf = array()) {
479
  // NOTE: caching the variables improves performance by 20% when serving cached pages.
480
  if ($cached = cache_get('variables', 'cache')) {
481
    $variables = $cached->data;
Dries's avatar
   
Dries committed
482
483
484
485
486
  }
  else {
    $result = db_query('SELECT * FROM {variable}');
    while ($variable = db_fetch_object($result)) {
      $variables[$variable->name] = unserialize($variable->value);
Dries's avatar
 
Dries committed
487
    }
488
    cache_set('variables', $variables);
Dries's avatar
   
Dries committed
489
490
491
492
  }

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

Dries's avatar
   
Dries committed
495
  return $variables;
Dries's avatar
 
Dries committed
496
497
}

Dries's avatar
   
Dries committed
498
499
500
501
502
503
504
505
506
507
/**
 * 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.
 */
Dries's avatar
 
Dries committed
508
509
510
511
512
513
function variable_get($name, $default) {
  global $conf;

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

Dries's avatar
   
Dries committed
514
515
516
517
518
519
520
521
522
/**
 * 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.
 */
Dries's avatar
 
Dries committed
523
524
525
function variable_set($name, $value) {
  global $conf;

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

528
  cache_clear_all('variables', 'cache');
Dries's avatar
 
Dries committed
529
530
531
532

  $conf[$name] = $value;
}

Dries's avatar
   
Dries committed
533
534
535
536
537
538
/**
 * Unset a persistent variable.
 *
 * @param $name
 *   The name of the variable to undefine.
 */
Dries's avatar
 
Dries committed
539
540
541
542
function variable_del($name) {
  global $conf;

  db_query("DELETE FROM {variable} WHERE name = '%s'", $name);
543
  cache_clear_all('variables', 'cache');
Dries's avatar
 
Dries committed
544
545
546
547

  unset($conf[$name]);
}

548

Dries's avatar
   
Dries committed
549
550
551
/**
 * Retrieve the current page from the cache.
 *
552
 * Note: we do not serve cached pages when status messages are waiting (from
Dries's avatar
   
Dries committed
553
554
 * a redirected form submission which was completed).
 */
Dries's avatar
 
Dries committed
555
function page_get_cache() {
556
  global $user, $base_root;
Dries's avatar
 
Dries committed
557
558

  $cache = NULL;
559

560
  if (!$user->uid && ($_SERVER['REQUEST_METHOD'] == 'GET' || $_SERVER['REQUEST_METHOD'] == 'HEAD') && count(drupal_set_message()) == 0) {
561
    $cache = cache_get($base_root . request_uri(), 'cache_page');
Dries's avatar
 
Dries committed
562
563
564
565
566
567
568
569
570

    if (empty($cache)) {
      ob_start();
    }
  }

  return $cache;
}

Dries's avatar
Dries committed
571
572
573
/**
 * Call all init or exit hooks without including all modules.
 *
574
 * @param $hook
Dries's avatar
Dries committed
575
576
 *   The name of the bootstrap hook we wish to invoke.
 */
577
function bootstrap_invoke_all($hook) {
578
  foreach (module_list(TRUE, TRUE) as $module) {
579
    module_invoke($module, $hook);
580
  }
Dries's avatar
Dries committed
581
582
583
}

/**
584
 * Includes a file with the provided type and name. This prevents
Dries's avatar
Dries committed
585
586
587
588
589
590
591
592
593
594
595
596
597
 * 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) {
  static $files = array();

598
  if (isset($files[$type][$name])) {
Dries's avatar
Dries committed
599
600
601
602
603
604
    return TRUE;
  }

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

  if ($filename) {
605
    include_once DRUPAL_ROOT . '/' . $filename;
Dries's avatar
Dries committed
606
607
608
609
610
611
612
613
    $files[$type][$name] = TRUE;

    return TRUE;
  }

  return FALSE;
}

Dries's avatar
   
Dries committed
614
615
/**
 * Set HTTP headers in preparation for a page response.
616
 *
617
618
619
620
 * Authenticated users are always given a 'no-cache' header, and will
 * fetch a fresh page on every request.  This prevents authenticated
 * users seeing locally cached pages that show them as logged out.
 *
621
 * @see page_set_cache()
Dries's avatar
   
Dries committed
622
 */
Dries's avatar
 
Dries committed
623
function drupal_page_header() {
624
  header("Expires: Sun, 19 Nov 1978 05:00:00 GMT");
625
  header("Last-Modified: " . gmdate("D, d M Y H:i:s") . " GMT");
626
  header("Cache-Control: store, no-cache, must-revalidate");
627
628
  header("Cache-Control: post-check=0, pre-check=0", FALSE);
}
Dries's avatar
   
Dries committed
629

630
631
632
633
634
635
636
637
638
639
640
/**
 * Set HTTP headers in preparation for a cached page response.
 *
 * The general approach here is that anonymous users can keep a local
 * cache of the page, but must revalidate it on every request.  Then,
 * they are given a '304 Not Modified' response as long as they stay
 * logged out and the page has not been modified.
 *
 */
function drupal_page_cache_header($cache) {
  // Set default values:
641
642
  $last_modified = gmdate('D, d M Y H:i:s', $cache->created) . ' GMT';
  $etag = '"' . md5($last_modified) . '"';
643
644
645
646
647
648
649
650

  // See if the client has provided the required HTTP headers:
  $if_modified_since = isset($_SERVER['HTTP_IF_MODIFIED_SINCE']) ? stripslashes($_SERVER['HTTP_IF_MODIFIED_SINCE']) : FALSE;
  $if_none_match = isset($_SERVER['HTTP_IF_NONE_MATCH']) ? stripslashes($_SERVER['HTTP_IF_NONE_MATCH']) : FALSE;

  if ($if_modified_since && $if_none_match
      && $if_none_match == $etag // etag must match
      && $if_modified_since == $last_modified) {  // if-modified-since must match
651
    header($_SERVER['SERVER_PROTOCOL'] . ' 304 Not Modified');
652
653
654
655
    // All 304 responses must send an etag if the 200 response for the same object contained an etag
    header("Etag: $etag");
    exit();
  }
656

657
658
659
  // Send appropriate response:
  header("Last-Modified: $last_modified");
  header("ETag: $etag");
660

661
662
663
  // The following headers force validation of cache:
  header("Expires: Sun, 19 Nov 1978 05:00:00 GMT");
  header("Cache-Control: must-revalidate");
664

665
666
667
668
669
670
671
672
673
  if (variable_get('page_compression', TRUE)) {
    // Determine if the browser accepts gzipped data.
    if (@strpos($_SERVER['HTTP_ACCEPT_ENCODING'], 'gzip') === FALSE && function_exists('gzencode')) {
      // Strip the gzip header and run uncompress.
      $cache->data = gzinflate(substr(substr($cache->data, 10), 0, -8));
    }
    elseif (function_exists('gzencode')) {
      header('Content-Encoding: gzip');
    }
Dries's avatar
 
Dries committed
674
  }
675
676
677
678
679
680
681
682
683
684

  // Send the original request's headers. We send them one after
  // another so PHP's header() function can deal with duplicate
  // headers.
  $headers = explode("\n", $cache->headers);
  foreach ($headers as $header) {
    header($header);
  }

  print $cache->data;
Dries's avatar
 
Dries committed
685
686
}

Dries's avatar
   
Dries committed
687
688
689
/**
 * Define the critical hooks that force modules to always be loaded.
 */
Dries's avatar
 
Dries committed
690
function bootstrap_hooks() {
691
  return array('boot', 'exit');
Dries's avatar
 
Dries committed
692
693
}

Dries's avatar
   
Dries committed
694
695
696
697
698
699
700
701
/**
 * Unserializes and appends elements from a serialized string.
 *
 * @param $obj
 *   The object to which the elements are appended.
 * @param $field
 *   The attribute of $obj whose value should be unserialized.
 */
Dries's avatar
   
Dries committed
702
703
704
705
706
707
708
709
710
711
712
function drupal_unpack($obj, $field = 'data') {
  if ($obj->$field && $data = unserialize($obj->$field)) {
    foreach ($data as $key => $value) {
      if (!isset($obj->$key)) {
        $obj->$key = $value;
      }
    }
  }
  return $obj;
}

Dries's avatar
Dries committed
713
714
/**
 * Encode special characters in a plain-text string for display as HTML.
Gábor Hojtsy's avatar
Gábor Hojtsy committed
715
716
717
 *
 * Uses drupal_validate_utf8 to prevent cross site scripting attacks on
 * Internet Explorer 6.
Dries's avatar
Dries committed
718
719
 */
function check_plain($text) {
Gábor Hojtsy's avatar
Gábor Hojtsy committed
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
  return drupal_validate_utf8($text) ? htmlspecialchars($text, ENT_QUOTES) : '';
}

/**
 * Checks whether a string is valid UTF-8.
 *
 * All functions designed to filter input should use drupal_validate_utf8
 * to ensure they operate on valid UTF-8 strings to prevent bypass of the
 * filter.
 *
 * When text containing an invalid UTF-8 lead byte (0xC0 - 0xFF) is presented
 * as UTF-8 to Internet Explorer 6, the program may misinterpret subsequent
 * bytes. When these subsequent bytes are HTML control characters such as
 * quotes or angle brackets, parts of the text that were deemed safe by filters
 * end up in locations that are potentially unsafe; An onerror attribute that
 * is outside of a tag, and thus deemed safe by a filter, can be interpreted
 * by the browser as if it were inside the tag.
 *
 * This function exploits preg_match behaviour (since PHP 4.3.5) when used
 * with the u modifier, as a fast way to find invalid UTF-8. When the matched
 * string contains an invalid byte sequence, it will fail silently.
 *
 * preg_match may not fail on 4 and 5 octet sequences, even though they
 * are not supported by the specification.
 *
 * The specific preg_match behaviour is present since PHP 4.3.5.
 *
 * @param $text
 *   The text to check.
 * @return
 *   TRUE if the text is valid UTF-8, FALSE if not.
 */
function drupal_validate_utf8($text) {
  if (strlen($text) == 0) {
    return TRUE;
  }
  return (preg_match('/^./us', $text) == 1);
Dries's avatar
Dries committed
757
758
}

Dries's avatar
   
Dries committed
759
/**
760
761
 * Since $_SERVER['REQUEST_URI'] is only available on Apache, we
 * generate an equivalent using other environment variables.
Dries's avatar
   
Dries committed
762
 */
Dries's avatar
 
Dries committed
763
function request_uri() {
764
765
766
767
768
769

  if (isset($_SERVER['REQUEST_URI'])) {
    $uri = $_SERVER['REQUEST_URI'];
  }
  else {
    if (isset($_SERVER['argv'])) {
770
      $uri = $_SERVER['SCRIPT_NAME'] . '?' . $_SERVER['argv'][0];
771
    }
772
    elseif (isset($_SERVER['QUERY_STRING'])) {
773
      $uri = $_SERVER['SCRIPT_NAME'] . '?' . $_SERVER['QUERY_STRING'];
774
    }
775
776
777
    else {
      $uri = $_SERVER['SCRIPT_NAME'];
    }
Dries's avatar
 
Dries committed
778
  }
779

780
  return $uri;
Dries's avatar
 
Dries committed
781
}
Dries's avatar
Dries committed
782

Dries's avatar
   
Dries committed
783
784
785
786
787
788
/**
 * Log a system message.
 *
 * @param $type
 *   The category to which this message belongs.
 * @param $message
789
790
 *   The message to store in the log. See t() for documentation
 *   on how $message and $variables interact. Keep $message
791
 *   translatable by not concatenating dynamic values into it!
792
793
794
795
 * @param $variables
 *   Array of variables to replace in the message on display or
 *   NULL if message is already translated or not possible to
 *   translate.
796
 * @param $severity
797
 *   The severity of the message, as per RFC 3164
Dries's avatar
   
Dries committed
798
799
 * @param $link
 *   A link to associate with the message.
800
 *
801
 * @see watchdog_severity_levels()
Dries's avatar
   
Dries committed
802
 */
803
function watchdog($type, $message, $variables = array(), $severity = WATCHDOG_NOTICE, $link = NULL) {
804
  global $user, $base_root;
805

806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
  static $in_error_state = FALSE;

  // It is possible that the error handling will itself trigger an error.  In that case, we could
  // end up in an infinite loop.  To avoid that, we implement a simple static semaphore.
  if (!$in_error_state) {
    $in_error_state = TRUE;

    // Prepare the fields to be logged
    $log_message = array(
      'type'        => $type,
      'message'     => $message,
      'variables'   => $variables,
      'severity'    => $severity,
      'link'        => $link,
      'user'        => $user,
      'request_uri' => $base_root . request_uri(),
822
      'referer'     => $_SERVER['HTTP_REFERER'],
823
      'ip'          => ip_address(),
824
      'timestamp'   => REQUEST_TIME,
825
826
    );

827
828
829
830
    // Call the logging hooks to log/process the message
    foreach (module_implements('watchdog', TRUE) as $module) {
      module_invoke($module, 'watchdog', $log_message);
    }
831
  }
832
  $in_error_state = FALSE;
Dries's avatar
   
Dries committed
833
834
}

Dries's avatar
   
Dries committed
835
/**
836
 * Set a message which reflects the status of the performed operation.
Dries's avatar
   
Dries committed
837
 *
838
839
 * If the function is called with no arguments, this function returns all set
 * messages without clearing them.
Dries's avatar
   
Dries committed
840
 *
841
842
843
844
845
846
 * @param $message
 *   The message should begin with a capital letter and always ends with a
 *   period '.'.
 * @param $type
 *   The type of the message. One of the following values are possible:
 *   - 'status'
847
 *   - 'warning'
848
 *   - 'error'
849
850
851
 * @param $repeat
 *   If this is FALSE and the message is already set, then the message won't
 *   be repeated.
Dries's avatar
   
Dries committed
852
 */
853
function drupal_set_message($message = NULL, $type = 'status', $repeat = TRUE) {
854
  if ($message) {
Dries's avatar
   
Dries committed
855
856
857
858
859
860
861
862
    if (!isset($_SESSION['messages'])) {
      $_SESSION['messages'] = array();
    }

    if (!isset($_SESSION['messages'][$type])) {
      $_SESSION['messages'][$type] = array();
    }

863
864
865
    if ($repeat || !in_array($message, $_SESSION['messages'][$type])) {
      $_SESSION['messages'][$type][] = $message;
    }
866
867
  }

868
869
  // messages not set when DB connection fails
  return isset($_SESSION['messages']) ? $_SESSION['messages'] : NULL;
870
871
}

Dries's avatar
   
Dries committed
872
873
874
/**
 * Return all messages that have been set.
 *
875
876
 * @param $type
 *   (optional) Only return messages of this type.
877
878
 * @param $clear_queue
 *   (optional) Set to FALSE if you do not want to clear the messages queue
879
880
881
882
883
 * @return
 *   An associative array, the key is the message type, the value an array
 *   of messages. If the $type parameter is passed, you get only that type,
 *   or an empty array if there are no such messages. If $type is not passed,
 *   all message types are returned, or an empty array if none exist.
Dries's avatar
   
Dries committed
884
 */
885
function drupal_get_messages($type = NULL, $clear_queue = TRUE) {
886
  if ($messages = drupal_set_message()) {
887
    if ($type) {
888
      if ($clear_queue) {
889
        unset($_SESSION['messages'][$type]);
890
      }
891
892
893
      if (isset($messages[$type])) {
        return array($type => $messages[$type]);
      }
894
895
    }
    else {
896
      if ($clear_queue) {
897
        unset($_SESSION['messages']);
898
      }
899
900
      return $messages;
    }
901
  }
902
  return array();
903
904
}

Dries's avatar
   
Dries committed
905
/**
906
907
908
909
910
911
912
913
914
 * Check to see if an IP address has been blocked.
 *
 * Blocked IP addresses are stored in the database by default. However for
 * performance reasons we allow an override in settings.php. This allows us
 * to avoid querying the database at this critical stage of the bootstrap if
 * an administrative interface for IP address blocking is not required.
 *
 * @param $ip string
 *   IP address to check.
915
916
 * @return bool
 *   TRUE if access is denied, FALSE if access is allowed.
Dries's avatar
   
Dries committed
917
 */
918
919
920
921
922
923
924
925
926
927
928
929
function drupal_is_denied($ip) {
  // Because this function is called on every page request, we first check
  // for an array of IP addresses in settings.php before querying the
  // database.
  $blocked_ips = variable_get('blocked_ips', NULL);
  if (isset($blocked_ips) && is_array($blocked_ips)) {
    return in_array($ip, $blocked_ips);
  }
  else {
    $sql = "SELECT 1 FROM {blocked_ips} WHERE ip = '%s'";
    return (bool) db_result(db_query($sql, $ip));
  }
Dries's avatar
   
Dries committed
930
931
}

932
/**
933
 * Generates a default anonymous $user object.
934
935
936
 *
 * @return Object - the user object.
 */
937
function drupal_anonymous_user($session = '') {
938
939
  $user = new stdClass();
  $user->uid = 0;
940
  $user->hostname = ip_address();
941
942
  $user->roles = array();
  $user->roles[DRUPAL_ANONYMOUS_RID] = 'anonymous user';
943
  $user->session = $session;
944
  $user->cache = 0;
945
946
947
  return $user;
}

948
949
950
/**
 * A string describing a phase of Drupal to load. Each phase adds to the
 * previous one, so invoking a later phase automatically runs the earlier
951
 * phases too. The most important usage is that if you want to access the
952
 * Drupal database from a script without loading anything else, you can
953
 * include bootstrap.inc, and call drupal_bootstrap(DRUPAL_BOOTSTRAP_DATABASE).
954
955
 *
 * @param $phase
956
 *   A constant. Allowed values are:
957
958
 *     DRUPAL_BOOTSTRAP_CONFIGURATION: initialize configuration.
 *     DRUPAL_BOOTSTRAP_EARLY_PAGE_CACHE: try to call a non-database cache fetch routine.
959
 *     DRUPAL_BOOTSTRAP_DATABASE: initialize database layer.
960
 *     DRUPAL_BOOTSTRAP_ACCESS: identify and reject banned hosts.
961
 *     DRUPAL_BOOTSTRAP_SESSION: initialize session handling.
962
 *     DRUPAL_BOOTSTRAP_LATE_PAGE_CACHE: load bootstrap.inc and module.inc, start
963
 *       the variable system and try to serve a page from the cache.
964
 *     DRUPAL_BOOTSTRAP_LANGUAGE: identify the language used on the page.
965
 *     DRUPAL_BOOTSTRAP_PATH: set $_GET['q'] to Drupal path of request.
966
 *     DRUPAL_BOOTSTRAP_FULL: Drupal is fully loaded, validate and fix input data.
967
968
 */
function drupal_bootstrap($phase) {
969
  static $phases = array(DRUPAL_BOOTSTRAP_CONFIGURATION, DRUPAL_BOOTSTRAP_EARLY_PAGE_CACHE, DRUPAL_BOOTSTRAP_DATABASE, DRUPAL_BOOTSTRAP_ACCESS, DRUPAL_BOOTSTRAP_SESSION, DRUPAL_BOOTSTRAP_LATE_PAGE_CACHE, DRUPAL_BOOTSTRAP_LANGUAGE, DRUPAL_BOOTSTRAP_PATH, DRUPAL_BOOTSTRAP_FULL), $phase_index = 0;
970

971
  while ($phase >= $phase_index && isset($phases[$phase_index])) {
972
    $current_phase = $phases[$phase_index];
973
    unset($phases[$phase_index++]);
974
    _drupal_bootstrap($current_phase);
975
976
977

    global $_drupal_current_bootstrap_phase;
    $_drupal_current_bootstrap_phase = $current_phase;
978
979
  }
}
Dries's avatar
   
Dries committed
980

981
982
983
984
985
986
987
988
989
990
991
992
/**
 * Return the current bootstrap phase for this Drupal process.  The
 * current phase is the one most recently completed by
 * drupal_bootstrap().
 *
 * @see drupal_bootstrap
 */
function drupal_get_bootstrap_phase() {
  global $_drupal_current_bootstrap_phase;
  return $_drupal_current_bootstrap_phase;
}

993
994
function _drupal_bootstrap($phase) {
  global $conf;
Dries's avatar
 
Dries committed
995

996
  switch ($phase) {
997

998
    case DRUPAL_BOOTSTRAP_CONFIGURATION:
999
      drupal_initialize_variables();
1000
      // Start a page timer: