bootstrap.inc 24.9 KB
Newer Older
Dries's avatar
 
Dries committed
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
define('CACHE_PERMANENT', 0);
define('CACHE_TEMPORARY', -1);
Dries's avatar
 
Dries committed
11

12
define('CACHE_DISABLED', 0);
13
14
define('CACHE_NORMAL', 1);
define('CACHE_AGGRESSIVE', 2);
15

16
17
18
19
define('WATCHDOG_NOTICE', 0);
define('WATCHDOG_WARNING', 1);
define('WATCHDOG_ERROR', 2);

20
21
22
/**
 * First bootstrap phase: initialize configuration.
 */
23
define('DRUPAL_BOOTSTRAP_CONFIGURATION', 0);
24
25
26
27
28

/**
 * Second bootstrap phase: try to call a non-database cache
 * fetch routine.
 */
29
define('DRUPAL_BOOTSTRAP_EARLY_PAGE_CACHE', 1);
30
31
32
33

/**
 * Third bootstrap phase: initialize database layer.
 */
34
define('DRUPAL_BOOTSTRAP_DATABASE', 2);
35
36
37
38

/**
 * Fourth bootstrap phase: identify and reject banned hosts.
 */
39
define('DRUPAL_BOOTSTRAP_ACCESS', 3);
40
41
42
43

/**
 * Fifth bootstrap phase: initialize session handling.
 */
44
define('DRUPAL_BOOTSTRAP_SESSION', 4);
45
46
47
48
49

/**
 * Sixth bootstrap phase: load bootstrap.inc and module.inc, start
 * the variable system and try to serve a page from the cache.
 */
50
define('DRUPAL_BOOTSTRAP_LATE_PAGE_CACHE', 5);
51
52
53
54

/**
 * Seventh bootstrap phase: set $_GET['q'] to Drupal path of request.
 */
55
define('DRUPAL_BOOTSTRAP_PATH', 6);
56
57
58
59
60

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

63
// These values should match the 'role' table
64
65
66
define('DRUPAL_ANONYMOUS_RID', 1);
define('DRUPAL_AUTHENTICATED_RID', 2);

Dries's avatar
   
Dries committed
67
/**
68
 * Start the timer with the specified name. If you start and stop
Dries's avatar
   
Dries committed
69
70
71
72
73
74
75
76
77
78
79
 * 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;
80
  $timers[$name]['count'] = isset($timers[$name]['count']) ? ++$timers[$name]['count'] : 1;
Dries's avatar
   
Dries committed
81
82
83
84
85
86
87
88
89
90
91
92
93
}

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

94
95
96
97
  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
98

99
100
101
102
    if (isset($timers[$name]['time'])) {
      $diff += $timers[$name]['time'];
    }
    return $diff;
103
  }
Dries's avatar
   
Dries committed
104
105
106
107
108
109
110
111
}

/**
 * Stop the timer with the specified name.
 *
 * @param name
 *   The name of the timer.
 * @return
112
 *   A timer array. The array contains the number of times the
Dries's avatar
   
Dries committed
113
114
115
116
117
118
 *   timer has been started and stopped (count) and the accumulated
 *   timer value in ms (time).
 */
function timer_stop($name) {
  global $timers;

119
  $timers[$name]['time'] = timer_read($name);
Dries's avatar
   
Dries committed
120
121
122
123
  unset($timers[$name]['start']);

  return $timers[$name];
}
124

Dries's avatar
   
Dries committed
125
/**
126
 * Find the appropriate configuration directory.
Dries's avatar
   
Dries committed
127
 *
128
129
 * Try finding a matching configuration directory by stripping the website's
 * hostname from left to right and pathname from right to left. The first
130
 * configuration file found will be used; the remaining will ignored. If no
131
 * configuration file is found, return a default value '$confdir/default'.
Dries's avatar
Dries committed
132
 *
133
 * Example for a fictitious site installed at
134
135
 * http://www.drupal.org:8080/mysite/test/ the 'settings.php' is searched in
 * the following directories:
Dries's avatar
   
Dries committed
136
 *
137
138
139
140
 *  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
141
 *
142
143
144
145
 *  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
146
 *
147
148
149
150
 *  9. $confdir/8080.www.drupal.org
 * 10. $confdir/www.drupal.org
 * 11. $confdir/drupal.org
 * 12. $confdir/org
Dries's avatar
   
Dries committed
151
 *
152
 * 13. $confdir/default
Dries's avatar
   
Dries committed
153
 */
154
function conf_path() {
Dries's avatar
Dries committed
155
  static $conf = '';
Dries's avatar
 
Dries committed
156

Dries's avatar
Dries committed
157
158
159
  if ($conf) {
    return $conf;
  }
Dries's avatar
 
Dries committed
160

Dries's avatar
   
Dries committed
161
  $confdir = 'sites';
162
  $uri = explode('/', $_SERVER['PHP_SELF'] ? $_SERVER['PHP_SELF'] : $_SERVER['SCRIPT_FILENAME']);
163
  $server = explode('.', implode('.', array_reverse(explode(':', rtrim($_SERVER['HTTP_HOST'], '.')))));
Dries's avatar
Dries committed
164
165
166
167
168
169
170
  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));
      if (file_exists("$confdir/$dir/settings.php")) {
        $conf = "$confdir/$dir";
        return $conf;
      }
Dries's avatar
 
Dries committed
171
172
    }
  }
Dries's avatar
Dries committed
173
174
  $conf = "$confdir/default";
  return $conf;
Dries's avatar
 
Dries committed
175
176
}

177
178
179
180
181
/**
 * Unsets all disallowed global variables. See $allowed for what's allowed.
 */
function drupal_unset_globals() {
  if (ini_get('register_globals')) {
182
    $allowed = array('_ENV' => 1, '_GET' => 1, '_POST' => 1, '_COOKIE' => 1, '_FILES' => 1, '_SERVER' => 1, '_REQUEST' => 1, 'access_check' => 1, 'GLOBALS' => 1);
183
    foreach ($GLOBALS as $key => $value) {
184
185
186
187
188
189
190
      if (!isset($allowed[$key])) {
        unset($GLOBALS[$key]);
      }
    }
  }
}

191
192
193
194
/**
 * Loads the configuration and sets the base URL correctly.
 */
function conf_init() {
195
  global $db_url, $db_prefix, $base_url, $base_path, $base_root, $conf, $installed_profile;
196
  $conf = array();
197
  include_once './'. conf_path() .'/settings.php';
198
199
200
201

  if (isset($base_url)) {
    // Parse fixed base URL from settings.php.
    $parts = parse_url($base_url);
202
203
204
205
    if (!isset($parts['path'])) {
      $parts['path'] = '';
    }
    $base_path = $parts['path'] . '/';
206
207
208
209
210
211
212
    // 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';
    $base_url = $base_root .= '://'. $_SERVER['HTTP_HOST'];
213
    if ($dir = trim(dirname($_SERVER['PHP_SELF']), '\,/')) {
214
215
216
217
218
219
220
221
222
223
      $base_path = "/$dir";
      $base_url .= $base_path;
      $base_path .= '/';
    }
    else {
      $base_path = '/';
    }
  }
}

Dries's avatar
Dries committed
224
225
/**
 * Returns and optionally sets the filename for a system item (module,
226
 * theme, etc.). The filename, whether provided, cached, or retrieved
Dries's avatar
Dries committed
227
228
 * from the database, is only returned if the file exists.
 *
Dries's avatar
Dries committed
229
230
231
232
233
234
235
236
237
238
239
240
 * 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
241
242
243
244
245
246
247
248
249
250
251
 * @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
252
function drupal_get_filename($type, $name, $filename = NULL) {
Dries's avatar
Dries committed
253
  static $files = array();
Dries's avatar
Dries committed
254
  global $active_db;
Dries's avatar
Dries committed
255

256
  if (!isset($files[$type])) {
Dries's avatar
Dries committed
257
258
259
    $files[$type] = array();
  }

260
  if (!empty($filename) && file_exists($filename)) {
Dries's avatar
Dries committed
261
262
    $files[$type][$name] = $filename;
  }
263
  elseif (isset($files[$type][$name])) {
Dries's avatar
Dries committed
264
265
    // nothing
  }
Dries's avatar
Dries committed
266
267
268
269
270
  // 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.
  elseif ($active_db && (($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
271
272
273
    $files[$type][$name] = $file;
  }
  else {
Dries's avatar
Dries committed
274
275
    // 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
276
    $config = conf_path();
Dries's avatar
Dries committed
277
    $dir = (($type == 'theme_engine') ? 'themes/engines' : "${type}s");
Dries's avatar
   
Dries committed
278
    $file = (($type == 'theme_engine') ? "$name.engine" : "$name.$type");
Dries's avatar
Dries committed
279
280
281
282
283
284
285
286
287
288
289
290

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

  return $files[$type][$name];
}

Dries's avatar
   
Dries committed
291
292
293
294
295
296
297
/**
 * 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
298
function variable_init($conf = array()) {
299
  // NOTE: caching the variables improves performance by 20% when serving cached pages.
300
  if ($cached = cache_get('variables', 'cache')) {
Dries's avatar
   
Dries committed
301
302
303
304
305
306
    $variables = unserialize($cached->data);
  }
  else {
    $result = db_query('SELECT * FROM {variable}');
    while ($variable = db_fetch_object($result)) {
      $variables[$variable->name] = unserialize($variable->value);
Dries's avatar
 
Dries committed
307
    }
308
    cache_set('variables', 'cache', serialize($variables));
Dries's avatar
   
Dries committed
309
310
311
312
  }

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

Dries's avatar
   
Dries committed
315
  return $variables;
Dries's avatar
 
Dries committed
316
317
}

Dries's avatar
   
Dries committed
318
319
320
321
322
323
324
325
326
327
/**
 * 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
328
329
330
331
332
333
function variable_get($name, $default) {
  global $conf;

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

Dries's avatar
   
Dries committed
334
335
336
337
338
339
340
341
342
/**
 * 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
343
344
345
function variable_set($name, $value) {
  global $conf;

346
  db_lock_table('variable');
Dries's avatar
 
Dries committed
347
348
  db_query("DELETE FROM {variable} WHERE name = '%s'", $name);
  db_query("INSERT INTO {variable} (name, value) VALUES ('%s', '%s')", $name, serialize($value));
349
  db_unlock_tables();
Dries's avatar
   
Dries committed
350

351
  cache_clear_all('variables', 'cache');
Dries's avatar
 
Dries committed
352
353
354
355

  $conf[$name] = $value;
}

Dries's avatar
   
Dries committed
356
357
358
359
360
361
/**
 * Unset a persistent variable.
 *
 * @param $name
 *   The name of the variable to undefine.
 */
Dries's avatar
 
Dries committed
362
363
364
365
function variable_del($name) {
  global $conf;

  db_query("DELETE FROM {variable} WHERE name = '%s'", $name);
366
  cache_clear_all('variables', 'cache');
Dries's avatar
 
Dries committed
367
368
369
370

  unset($conf[$name]);
}

Dries's avatar
   
Dries committed
371
372
373
/**
 * Retrieve the current page from the cache.
 *
374
 * Note: we do not serve cached pages when status messages are waiting (from
Dries's avatar
   
Dries committed
375
376
 * a redirected form submission which was completed).
 */
Dries's avatar
 
Dries committed
377
function page_get_cache() {
378
  global $user, $base_root;
Dries's avatar
 
Dries committed
379
380

  $cache = NULL;
381

382
  if (!$user->uid && $_SERVER['REQUEST_METHOD'] == 'GET' && count(drupal_set_message()) == 0) {
383
    $cache = cache_get($base_root . request_uri(), 'cache_page');
Dries's avatar
 
Dries committed
384
385
386
387
388
389
390
391
392

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

  return $cache;
}

Dries's avatar
Dries committed
393
394
395
/**
 * Call all init or exit hooks without including all modules.
 *
396
 * @param $hook
Dries's avatar
Dries committed
397
398
 *   The name of the bootstrap hook we wish to invoke.
 */
399
function bootstrap_invoke_all($hook) {
400
  foreach (module_list(TRUE, TRUE) as $module) {
Dries's avatar
Dries committed
401
    drupal_load('module', $module);
402
    module_invoke($module, $hook);
Dries's avatar
Dries committed
403
404
405
406
 }
}

/**
407
 * Includes a file with the provided type and name. This prevents
Dries's avatar
Dries committed
408
409
410
411
412
413
414
415
416
417
418
419
420
 * 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();

421
  if (isset($files[$type][$name])) {
Dries's avatar
Dries committed
422
423
424
425
426
427
    return TRUE;
  }

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

  if ($filename) {
428
    include_once "./$filename";
Dries's avatar
Dries committed
429
430
431
432
433
434
435
436
    $files[$type][$name] = TRUE;

    return TRUE;
  }

  return FALSE;
}

Dries's avatar
   
Dries committed
437
438
/**
 * Set HTTP headers in preparation for a page response.
439
 *
440
441
442
443
 * 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.
 *
444
 * @see page_set_cache
Dries's avatar
   
Dries committed
445
 */
Dries's avatar
 
Dries committed
446
function drupal_page_header() {
447
448
449
450
451
452
  header("Expires: Sun, 19 Nov 1978 05:00:00 GMT");
  header("Last-Modified: " . gmdate("D, d M Y H:i:s") . " GMT");
  header("Cache-Control: no-store, no-cache, must-revalidate");
  header("Cache-Control: post-check=0, pre-check=0", FALSE);
  header("Pragma: no-cache");
}
Dries's avatar
   
Dries committed
453

454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
/**
 * 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:
  $last_modified = gmdate('D, d M Y H:i:s', $cache->created) .' GMT';
  $etag = '"'.md5($last_modified).'"';

  // 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();
  }
480

481
482
483
  // Send appropriate response:
  header("Last-Modified: $last_modified");
  header("ETag: $etag");
484

485
486
487
  // The following headers force validation of cache:
  header("Expires: Sun, 19 Nov 1978 05:00:00 GMT");
  header("Cache-Control: must-revalidate");
488

489
490
491
492
  // 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));
493
  }
494
495
  elseif (function_exists('gzencode')) {
    header('Content-Encoding: gzip');
Dries's avatar
 
Dries committed
496
  }
497
498
499
500
501
502
503
504
505
506

  // 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
507
508
}

Dries's avatar
   
Dries committed
509
510
511
/**
 * Define the critical hooks that force modules to always be loaded.
 */
Dries's avatar
 
Dries committed
512
513
514
515
function bootstrap_hooks() {
  return array('init', 'exit');
}

Dries's avatar
   
Dries committed
516
517
518
519
520
521
522
523
/**
 * 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
524
525
526
527
528
529
530
531
532
533
534
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
535
536
537
/**
 * Return the URI of the referring page.
 */
Dries's avatar
 
Dries committed
538
function referer_uri() {
539
  if (isset($_SERVER['HTTP_REFERER'])) {
540
    return $_SERVER['HTTP_REFERER'];
Dries's avatar
 
Dries committed
541
542
543
  }
}

Dries's avatar
Dries committed
544
545
546
547
548
549
550
/**
 * Encode special characters in a plain-text string for display as HTML.
 */
function check_plain($text) {
  return htmlspecialchars($text, ENT_QUOTES);
}

Dries's avatar
   
Dries committed
551
/**
552
553
 * Since $_SERVER['REQUEST_URI'] is only available on Apache, we
 * generate an equivalent using other environment variables.
Dries's avatar
   
Dries committed
554
 */
Dries's avatar
 
Dries committed
555
function request_uri() {
556
557
558
559
560
561
562

  if (isset($_SERVER['REQUEST_URI'])) {
    $uri = $_SERVER['REQUEST_URI'];
  }
  else {
    if (isset($_SERVER['argv'])) {
      $uri = $_SERVER['PHP_SELF'] .'?'. $_SERVER['argv'][0];
563
564
    }
    else {
565
      $uri = $_SERVER['PHP_SELF'] .'?'. $_SERVER['QUERY_STRING'];
566
    }
Dries's avatar
 
Dries committed
567
  }
568

569
  return $uri;
Dries's avatar
 
Dries committed
570
}
Dries's avatar
Dries committed
571

Dries's avatar
   
Dries committed
572
573
574
575
576
577
578
/**
 * Log a system message.
 *
 * @param $type
 *   The category to which this message belongs.
 * @param $message
 *   The message to store in the log.
579
580
581
582
583
 * @param $severity
 *   The severity of the message. One of the following values:
 *   - WATCHDOG_NOTICE
 *   - WATCHDOG_WARNING
 *   - WATCHDOG_ERROR
Dries's avatar
   
Dries committed
584
585
586
 * @param $link
 *   A link to associate with the message.
 */
587
function watchdog($type, $message, $severity = WATCHDOG_NOTICE, $link = NULL) {
588
  global $user, $base_root;
589
590
591

  $current_db = db_set_active();

592
593
594
595
  // Note: log the exact, entire absolute URL.
  $request_uri = $base_root . request_uri();

  db_query("INSERT INTO {watchdog} (uid, type, message, severity, link, location, referer, hostname, timestamp) VALUES (%d, '%s', '%s', %d, '%s', '%s', '%s', '%s', %d)", $user->uid, $type, $message, $severity, $link, $request_uri, referer_uri(), $_SERVER['REMOTE_ADDR'], time());
596
597
598
599

  if ($current_db) {
    db_set_active($current_db);
  }
Dries's avatar
   
Dries committed
600
601
}

Dries's avatar
   
Dries committed
602
/**
603
 * Set a message which reflects the status of the performed operation.
Dries's avatar
   
Dries committed
604
 *
605
606
 * If the function is called with no arguments, this function returns all set
 * messages without clearing them.
Dries's avatar
   
Dries committed
607
 *
608
609
610
611
612
613
614
 * @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'
 *   - 'error'
Dries's avatar
   
Dries committed
615
616
 */
function drupal_set_message($message = NULL, $type = 'status') {
617
  if ($message) {
Dries's avatar
   
Dries committed
618
619
620
621
622
623
624
625
626
    if (!isset($_SESSION['messages'])) {
      $_SESSION['messages'] = array();
    }

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

    $_SESSION['messages'][$type][] = $message;
627
628
  }

629
630
  // messages not set when DB connection fails
  return isset($_SESSION['messages']) ? $_SESSION['messages'] : NULL;
631
632
}

Dries's avatar
   
Dries committed
633
634
635
/**
 * Return all messages that have been set.
 *
636
637
 * @param $type
 *   (optional) Only return messages of this type.
638
639
 * @param $clear_queue
 *   (optional) Set to FALSE if you do not want to clear the messages queue
Dries's avatar
   
Dries committed
640
 */
641
function drupal_get_messages($type = NULL, $clear_queue = TRUE) {
642
  if ($messages = drupal_set_message()) {
643
    if ($type) {
644
645
646
      if ($clear_queue) {
         unset($_SESSION['messages'][$type]);
      }
647
648
649
      return array($type => $messages[$type]);
    }
    else {
650
651
652
      if ($clear_queue) {
         unset($_SESSION['messages']);
      }
653
654
      return $messages;
    }
655
  }
656
  return array();
657
658
}

Dries's avatar
   
Dries committed
659
/**
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
 * Perform an access check for a given mask and rule type. Rules are usually
 * created via admin/user/rules page.
 *
 * If any allow rule matches, access is allowed. Otherwise, if any deny rule
 * matches, access is denied.  If no rule matches, access is allowed.
 *
 * @param $type string
 *   Type of access to check: Allowed values are:
 *     - 'host': host name or IP address
 *     - 'mail': e-mail address
 *     - 'user': username
 * @param $mask string
 *   String or mask to test: '_' matches any character, '%' matches any
 *   number of characters.
 * @return bool
 *   TRUE if access is denied, FALSE if access is allowed.
Dries's avatar
   
Dries committed
676
 */
677
function drupal_is_denied($type, $mask) {
678
679
680
681
682
683
684
685
686
687
688
689
  // Because this function is called for every page request, both cached
  // and non-cached pages, we tried to optimize it as much as possible.
  // We deny access if the only matching records in the {access} table have
  // status 0. If any have status 1, or if there are no matching records,
  // we allow access. So, select matching records in decreasing order of
  // 'status', returning NOT(status) for the first. If any have status 1,
  // they come first, and we return NOT(status) = 0 (allowed). Otherwise,
  // if we have some with status 0, we return 1 (denied). If no matching
  // records, we get no return from db_result, so we return (bool)NULL = 0
  // (allowed).
  // The use of ORDER BY / LIMIT is more efficient than "MAX(status) = 0"
  // in PostgreSQL <= 8.0.
690
  return (bool) db_result(db_query_range("SELECT CASE WHEN status=1 THEN 0 ELSE 1 END FROM {access} WHERE type = '%s' AND LOWER('%s') LIKE LOWER(mask) ORDER BY status DESC", $type, $mask, 0, 1));
Dries's avatar
   
Dries committed
691
692
}

693
/**
694
 * Generates a default anonymous $user object.
695
696
697
 *
 * @return Object - the user object.
 */
698
function drupal_anonymous_user($session = '') {
699
700
701
702
703
  $user = new stdClass();
  $user->uid = 0;
  $user->hostname = $_SERVER['REMOTE_ADDR'];
  $user->roles = array();
  $user->roles[DRUPAL_ANONYMOUS_RID] = 'anonymous user';
704
  $user->session = $session;
705
706
707
  return $user;
}

708
709
710
/**
 * 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
711
 * phases too. The most important usage is that if you want to access the
712
 * Drupal database from a script without loading anything else, you can
713
 * include bootstrap.inc, and call drupal_bootstrap(DRUPAL_BOOTSTRAP_DATABASE).
714
715
 *
 * @param $phase
716
 *   A constant. Allowed values are:
717
718
 *     DRUPAL_BOOTSTRAP_CONFIGURATION: initialize configuration.
 *     DRUPAL_BOOTSTRAP_EARLY_PAGE_CACHE: try to call a non-database cache fetch routine.
719
 *     DRUPAL_BOOTSTRAP_DATABASE: initialize database layer.
720
 *     DRUPAL_BOOTSTRAP_ACCESS: identify and reject banned hosts.
721
 *     DRUPAL_BOOTSTRAP_SESSION: initialize session handling.
722
 *     DRUPAL_BOOTSTRAP_LATE_PAGE_CACHE: load bootstrap.inc and module.inc, start
723
 *       the variable system and try to serve a page from the cache.
724
 *     DRUPAL_BOOTSTRAP_PATH: set $_GET['q'] to Drupal path of request.
725
 *     DRUPAL_BOOTSTRAP_FULL: Drupal is fully loaded, validate and fix input data.
726
727
 */
function drupal_bootstrap($phase) {
728
  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_PATH, DRUPAL_BOOTSTRAP_FULL);
729

730
  while (!is_null($current_phase = array_shift($phases))) {
731
732
733
734
735
736
    _drupal_bootstrap($current_phase);
    if ($phase == $current_phase) {
      return;
    }
  }
}
Dries's avatar
   
Dries committed
737

738
739
function _drupal_bootstrap($phase) {
  global $conf;
Dries's avatar
 
Dries committed
740

741
  switch ($phase) {
742

743
    case DRUPAL_BOOTSTRAP_CONFIGURATION:
744
      drupal_unset_globals();
745
746
      // Initialize the configuration
      conf_init();
747
      break;
748

749
    case DRUPAL_BOOTSTRAP_EARLY_PAGE_CACHE:
750
      _drupal_cache_init($phase);
751
      break;
752

753
    case DRUPAL_BOOTSTRAP_DATABASE:
754
      // Initialize the default database.
755
      require_once './includes/database.inc';
756
757
      db_set_active();
      break;
758

759
760
761
762
763
764
765
766
767
    case DRUPAL_BOOTSTRAP_ACCESS:
      // Deny access to hosts which were banned - t() is not yet available.
      if (drupal_is_denied('host', $_SERVER['REMOTE_ADDR'])) {
        header('HTTP/1.0 403 Forbidden');
        print 'Sorry, '. $_SERVER['REMOTE_ADDR']. ' has been banned.';
        exit();
      }
      break;

768
    case DRUPAL_BOOTSTRAP_SESSION:
769
      require_once './includes/session.inc';
770
      session_set_save_handler('sess_open', 'sess_close', 'sess_read', 'sess_write', 'sess_destroy_sid', 'sess_gc');
771
772
      session_start();
      break;
773

774
    case DRUPAL_BOOTSTRAP_LATE_PAGE_CACHE:
775
776
777
778
      // Initialize configuration variables, using values from settings.php if available.
      $conf = variable_init(isset($conf) ? $conf : array());

      _drupal_cache_init($phase);
779

780
781
782
      // Start a page timer:
      timer_start('page');

783
784
      drupal_page_header();
      break;
785

786
787
788
789
790
791
    case DRUPAL_BOOTSTRAP_PATH:
      require_once './includes/path.inc';
      // Initialize $_GET['q'] prior to loading modules and invoking hook_init().
      drupal_init_path();
      break;

792
    case DRUPAL_BOOTSTRAP_FULL:
793
794
795
796
      require_once './includes/common.inc';
      _drupal_bootstrap_full();
      break;
  }
Dries's avatar
   
Dries committed
797
798
}

799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
/**
 * Initialize the caching strategy, which loads at different stages within
 * Drupal's bootstrap process.
 */
function _drupal_cache_init($phase) {
  require_once variable_get('cache_inc', './includes/cache.inc');

  if ($phase == DRUPAL_BOOTSTRAP_EARLY_PAGE_CACHE && variable_get('page_cache_fastpath', 0)) {
    if (page_cache_fastpath()) {
      exit();
    }
  }
  elseif ($phase == DRUPAL_BOOTSTRAP_LATE_PAGE_CACHE) {
    if ($cache = page_get_cache()) {
      if (variable_get('cache', CACHE_DISABLED) == CACHE_AGGRESSIVE) {
        drupal_page_cache_header($cache);
        exit();
      }
      elseif (variable_get('cache', CACHE_DISABLED) == CACHE_NORMAL) {
        require_once './includes/module.inc';
        bootstrap_invoke_all('init');
        drupal_page_cache_header($cache);
        bootstrap_invoke_all('exit');
        exit();
      }
    }
    require_once './includes/module.inc';
  }
}

829
830
831
/**
 * Enables use of the theme system without requiring database access. Since
 * there is not database access no theme will be enabled and the default
832
 * themeable functions will be called. Some themeable functions can not be used
833
834
835
836
837
 * without the full Drupal API loaded. For example, theme_page() is
 * unavailable and theme_maintenance_page() must be used in its place.
 */
function drupal_maintenance_theme() {
  global $theme;
838
  require_once './includes/path.inc';
839
840
841
  require_once './includes/theme.inc';
  require_once './includes/common.inc';
  require_once './includes/unicode.inc';
842
  require_once './modules/filter/filter.module';
843
  unicode_check();
844
845
  drupal_add_css(drupal_get_path('module', 'system') .'/defaults.css', 'module');
  drupal_add_css(drupal_get_path('module', 'system') .'/system.css', 'module');
846
847
  $theme = '';
}
848
849
850
851
852
853
854
855
856
857
858
859

/**
 * Return the name of the localisation function. Use in code that needs to
 * run both during installation and normal operation.
 */
function get_t() {
  static $t;
  if (is_null($t)) {
    $t = function_exists('install_main') ? 'st' : 't';
  }
  return $t;
}