bootstrap.inc 42.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);

Dries's avatar
   
Dries committed
183
/**
184
 * Start the timer with the specified name. If you start and stop
Dries's avatar
   
Dries committed
185
186
187
188
189
190
191
192
193
194
195
 * 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;
196
  $timers[$name]['count'] = isset($timers[$name]['count']) ? ++$timers[$name]['count'] : 1;
Dries's avatar
   
Dries committed
197
198
199
200
201
202
203
204
205
206
207
208
209
}

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

210
211
212
213
  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
214

215
216
217
218
    if (isset($timers[$name]['time'])) {
      $diff += $timers[$name]['time'];
    }
    return $diff;
219
  }
Dries's avatar
   
Dries committed
220
221
222
223
224
225
226
227
}

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

235
  $timers[$name]['time'] = timer_read($name);
Dries's avatar
   
Dries committed
236
237
238
239
  unset($timers[$name]['start']);

  return $timers[$name];
}
240

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

284
  if ($conf && !$reset) {
Dries's avatar
Dries committed
285
286
    return $conf;
  }
Dries's avatar
 
Dries committed
287

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

304
305
306
307
308
/**
 * Unsets all disallowed global variables. See $allowed for what's allowed.
 */
function drupal_unset_globals() {
  if (ini_get('register_globals')) {
309
    $allowed = array('_ENV' => 1, '_GET' => 1, '_POST' => 1, '_COOKIE' => 1, '_FILES' => 1, '_SERVER' => 1, '_REQUEST' => 1, 'GLOBALS' => 1);
310
    foreach ($GLOBALS as $key => $value) {
311
312
313
314
315
316
317
      if (!isset($allowed[$key])) {
        unset($GLOBALS[$key]);
      }
    }
  }
}

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

Dries's avatar
Dries committed
325
  // Export the following settings.php variables to the global namespace
326
  global $db_url, $db_prefix, $cookie_domain, $conf, $installed_profile, $update_free_access;
Dries's avatar
Dries committed
327
328
  $conf = array();

329
330
  if (file_exists('./' . conf_path() . '/settings.php')) {
    include_once './' . conf_path() . '/settings.php';
331
  }
332
333
334
335

  if (isset($base_url)) {
    // Parse fixed base URL from settings.php.
    $parts = parse_url($base_url);
336
337
338
    if (!isset($parts['path'])) {
      $parts['path'] = '';
    }
339
    $base_path = $parts['path'] . '/';
340
341
342
343
344
345
    // 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';
346
347
348

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

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

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

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

431
  if (!isset($files[$type])) {
Dries's avatar
Dries committed
432
433
434
    $files[$type] = array();
  }

435
  if (!empty($filename) && file_exists($filename)) {
Dries's avatar
Dries committed
436
437
    $files[$type][$name] = $filename;
  }
438
  elseif (isset($files[$type][$name])) {
Dries's avatar
Dries committed
439
440
    // nothing
  }
Dries's avatar
Dries committed
441
442
443
444
  // 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.
445
  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
446
447
448
    $files[$type][$name] = $file;
  }
  else {
Dries's avatar
Dries committed
449
450
    // 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
451
    $config = conf_path();
Dries's avatar
Dries committed
452
    $dir = (($type == 'theme_engine') ? 'themes/engines' : "${type}s");
Dries's avatar
   
Dries committed
453
    $file = (($type == 'theme_engine') ? "$name.engine" : "$name.$type");
Dries's avatar
Dries committed
454
455
456
457
458
459
460
461
462

    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;
      }
    }
  }

463
464
465
  if (isset($files[$type][$name])) {
    return $files[$type][$name];
  }
Dries's avatar
Dries committed
466
467
}

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

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

Dries's avatar
   
Dries committed
492
  return $variables;
Dries's avatar
 
Dries committed
493
494
}

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

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

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

523
524
525
526
527
  $serialized_value = serialize($value);
  db_query("UPDATE {variable} SET value = '%s' WHERE name = '%s'", $serialized_value, $name);
  if (!db_affected_rows()) {
    @db_query("INSERT INTO {variable} (name, value) VALUES ('%s', '%s')", $name, $serialized_value);
  }
Dries's avatar
   
Dries committed
528

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

  $conf[$name] = $value;
}

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

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

  unset($conf[$name]);
}

549

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

  $cache = NULL;
560

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

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

  return $cache;
}

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

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

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

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

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

    return TRUE;
  }

  return FALSE;
}

Dries's avatar
   
Dries committed
615
616
/**
 * Set HTTP headers in preparation for a page response.
617
 *
618
619
620
621
 * 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.
 *
622
 * @see page_set_cache()
Dries's avatar
   
Dries committed
623
 */
Dries's avatar
 
Dries committed
624
function drupal_page_header() {
625
  header("Expires: Sun, 19 Nov 1978 05:00:00 GMT");
626
  header("Last-Modified: " . gmdate("D, d M Y H:i:s") . " GMT");
627
  header("Cache-Control: store, no-cache, must-revalidate");
628
629
  header("Cache-Control: post-check=0, pre-check=0", FALSE);
}
Dries's avatar
   
Dries committed
630

631
632
633
634
635
636
637
638
639
640
641
/**
 * 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:
642
643
  $last_modified = gmdate('D, d M Y H:i:s', $cache->created) . ' GMT';
  $etag = '"' . md5($last_modified) . '"';
644
645
646
647
648
649
650
651
652
653
654
655
656

  // 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
    header('HTTP/1.1 304 Not Modified');
    // All 304 responses must send an etag if the 200 response for the same object contained an etag
    header("Etag: $etag");
    exit();
  }
657

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

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

666
667
668
669
670
671
672
673
674
  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
675
  }
676
677
678
679
680
681
682
683
684
685

  // 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
686
687
}

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

Dries's avatar
   
Dries committed
695
696
697
698
699
700
701
702
/**
 * 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
703
704
705
706
707
708
709
710
711
712
713
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
714
715
716
/**
 * Return the URI of the referring page.
 */
Dries's avatar
 
Dries committed
717
function referer_uri() {
718
  if (isset($_SERVER['HTTP_REFERER'])) {
719
    return $_SERVER['HTTP_REFERER'];
Dries's avatar
 
Dries committed
720
721
722
  }
}

Dries's avatar
Dries committed
723
724
/**
 * Encode special characters in a plain-text string for display as HTML.
Gábor Hojtsy's avatar
Gábor Hojtsy committed
725
726
727
 *
 * Uses drupal_validate_utf8 to prevent cross site scripting attacks on
 * Internet Explorer 6.
Dries's avatar
Dries committed
728
729
 */
function check_plain($text) {
Gábor Hojtsy's avatar
Gábor Hojtsy committed
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
757
758
759
760
761
762
763
764
765
766
  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
767
768
}

Dries's avatar
   
Dries committed
769
/**
770
771
 * Since $_SERVER['REQUEST_URI'] is only available on Apache, we
 * generate an equivalent using other environment variables.
Dries's avatar
   
Dries committed
772
 */
Dries's avatar
 
Dries committed
773
function request_uri() {
774
775
776
777
778
779

  if (isset($_SERVER['REQUEST_URI'])) {
    $uri = $_SERVER['REQUEST_URI'];
  }
  else {
    if (isset($_SERVER['argv'])) {
780
      $uri = $_SERVER['SCRIPT_NAME'] . '?' . $_SERVER['argv'][0];
781
    }
782
    elseif (isset($_SERVER['QUERY_STRING'])) {
783
      $uri = $_SERVER['SCRIPT_NAME'] . '?' . $_SERVER['QUERY_STRING'];
784
    }
785
786
787
    else {
      $uri = $_SERVER['SCRIPT_NAME'];
    }
Dries's avatar
 
Dries committed
788
  }
789

790
  return $uri;
Dries's avatar
 
Dries committed
791
}
Dries's avatar
Dries committed
792

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

816
817
818
819
  // Prepare the fields to be logged
  $log_message = array(
    'type'        => $type,
    'message'     => $message,
820
    'variables'   => $variables,
821
822
823
824
825
    'severity'    => $severity,
    'link'        => $link,
    'user'        => $user,
    'request_uri' => $base_root . request_uri(),
    'referer'     => referer_uri(),
826
    'ip'          => ip_address(),
827
828
829
830
831
832
    'timestamp'   => time(),
    );

  // Call the logging hooks to log/process the message
  foreach (module_implements('watchdog', TRUE) as $module) {
    module_invoke($module, 'watchdog', $log_message);
833
  }
Dries's avatar
   
Dries committed
834
835
}

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

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

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

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

Dries's avatar
   
Dries committed
873
874
875
/**
 * Return all messages that have been set.
 *
876
877
 * @param $type
 *   (optional) Only return messages of this type.
878
879
 * @param $clear_queue
 *   (optional) Set to FALSE if you do not want to clear the messages queue
880
881
882
883
884
 * @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
885
 */
886
function drupal_get_messages($type = NULL, $clear_queue = TRUE) {
887
  if ($messages = drupal_set_message()) {
888
    if ($type) {
889
      if ($clear_queue) {
890
        unset($_SESSION['messages'][$type]);
891
      }
892
893
894
      if (isset($messages[$type])) {
        return array($type => $messages[$type]);
      }
895
896
    }
    else {
897
      if ($clear_queue) {
898
        unset($_SESSION['messages']);
899
      }
900
901
      return $messages;
    }
902
  }
903
  return array();
904
905
}

Dries's avatar
   
Dries committed
906
/**
907
908
909
910
911
912
913
914
915
 * 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.
916
917
 * @return bool
 *   TRUE if access is denied, FALSE if access is allowed.
Dries's avatar
   
Dries committed
918
 */
919
920
921
922
923
924
925
926
927
928
929
930
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
931
932
}

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

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

972
  while ($phase >= $phase_index && isset($phases[$phase_index])) {
973
    $current_phase = $phases[$phase_index];
974
    unset($phases[$phase_index++]);
975
976
977
    _drupal_bootstrap($current_phase);
  }
}
Dries's avatar
   
Dries committed
978

979
980
function _drupal_bootstrap($phase) {
  global $conf;
Dries's avatar
 
Dries committed
981

982
  switch ($phase) {
983

984
    case DRUPAL_BOOTSTRAP_CONFIGURATION:
985
      drupal_unset_globals();
986
987
      // Start a page timer:
      timer_start('page');
988
989
      // Initialize the configuration
      conf_init();
990
      break;
991

992
    case DRUPAL_BOOTSTRAP_EARLY_PAGE_CACHE:
993
994
995
996
997
998
999
1000
      // Allow specifying special cache handlers in settings.php, like
      // using memcached or files for storing cache information.
      require_once variable_get('cache_inc', './includes/cache.inc');
      // If the page_cache_fastpath is set to TRUE in settings.php and
      // page_cache_fastpath (implemented in the special implementation of
      // cache.inc) printed the page and indicated this with a returned TRUE
      // then we are done.
      if (variable_get('page_cache_fastpath', FALSE) && page_cache_fastpath()) {
For faster browsing, not all history is shown. View entire blame