bootstrap.inc 26.1 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
39
40
/**
 * Indicates a notice-level watchdog event; these are normally notifications
 * of normal system events that have occurred and can usually be safely ignored.
 */
41
define('WATCHDOG_NOTICE', 0);
42
43
44
45
46

/**
 * Indicates a warning-level watchdog event; this can be triggered by an error
 * in a module that does not impact the overall functionality of the site.
 */
47
define('WATCHDOG_WARNING', 1);
48
49
50
51
52

/**
 * Indicates an error-level watchdog event; could be indicative of an attempt
 * to compromise the security of the site, or a serious system error.
 */
53
54
define('WATCHDOG_ERROR', 2);

55
56
57
/**
 * First bootstrap phase: initialize configuration.
 */
58
define('DRUPAL_BOOTSTRAP_CONFIGURATION', 0);
59
60
61
62
63

/**
 * Second bootstrap phase: try to call a non-database cache
 * fetch routine.
 */
64
define('DRUPAL_BOOTSTRAP_EARLY_PAGE_CACHE', 1);
65
66
67
68

/**
 * Third bootstrap phase: initialize database layer.
 */
69
define('DRUPAL_BOOTSTRAP_DATABASE', 2);
70
71
72
73

/**
 * Fourth bootstrap phase: identify and reject banned hosts.
 */
74
define('DRUPAL_BOOTSTRAP_ACCESS', 3);
75
76
77
78

/**
 * Fifth bootstrap phase: initialize session handling.
 */
79
define('DRUPAL_BOOTSTRAP_SESSION', 4);
80
81
82
83
84

/**
 * Sixth bootstrap phase: load bootstrap.inc and module.inc, start
 * the variable system and try to serve a page from the cache.
 */
85
define('DRUPAL_BOOTSTRAP_LATE_PAGE_CACHE', 5);
86
87
88
89

/**
 * Seventh bootstrap phase: set $_GET['q'] to Drupal path of request.
 */
90
define('DRUPAL_BOOTSTRAP_PATH', 6);
91
92
93
94
95

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

98
99
100
/**
 * Role ID for anonymous users; should match what's in the "role" table.
 */
101
define('DRUPAL_ANONYMOUS_RID', 1);
102
103
104
105

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

Dries's avatar
   
Dries committed
108
/**
109
 * Start the timer with the specified name. If you start and stop
Dries's avatar
   
Dries committed
110
111
112
113
114
115
116
117
118
119
120
 * 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;
121
  $timers[$name]['count'] = isset($timers[$name]['count']) ? ++$timers[$name]['count'] : 1;
Dries's avatar
   
Dries committed
122
123
124
125
126
127
128
129
130
131
132
133
134
}

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

135
136
137
138
  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
139

140
141
142
143
    if (isset($timers[$name]['time'])) {
      $diff += $timers[$name]['time'];
    }
    return $diff;
144
  }
Dries's avatar
   
Dries committed
145
146
147
148
149
150
151
152
}

/**
 * Stop the timer with the specified name.
 *
 * @param name
 *   The name of the timer.
 * @return
153
 *   A timer array. The array contains the number of times the
Dries's avatar
   
Dries committed
154
155
156
157
158
159
 *   timer has been started and stopped (count) and the accumulated
 *   timer value in ms (time).
 */
function timer_stop($name) {
  global $timers;

160
  $timers[$name]['time'] = timer_read($name);
Dries's avatar
   
Dries committed
161
162
163
164
  unset($timers[$name]['start']);

  return $timers[$name];
}
165

Dries's avatar
   
Dries committed
166
/**
167
 * Find the appropriate configuration directory.
Dries's avatar
   
Dries committed
168
 *
169
170
 * Try finding a matching configuration directory by stripping the website's
 * hostname from left to right and pathname from right to left. The first
171
 * configuration file found will be used; the remaining will ignored. If no
172
 * configuration file is found, return a default value '$confdir/default'.
Dries's avatar
Dries committed
173
 *
174
 * Example for a fictitious site installed at
175
176
 * http://www.drupal.org:8080/mysite/test/ the 'settings.php' is searched in
 * the following directories:
Dries's avatar
   
Dries committed
177
 *
178
179
180
181
 *  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
182
 *
183
184
185
186
 *  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
187
 *
188
189
190
191
 *  9. $confdir/8080.www.drupal.org
 * 10. $confdir/www.drupal.org
 * 11. $confdir/drupal.org
 * 12. $confdir/org
Dries's avatar
   
Dries committed
192
 *
193
 * 13. $confdir/default
Dries's avatar
   
Dries committed
194
 */
195
function conf_path() {
Dries's avatar
Dries committed
196
  static $conf = '';
Dries's avatar
 
Dries committed
197

Dries's avatar
Dries committed
198
199
200
  if ($conf) {
    return $conf;
  }
Dries's avatar
 
Dries committed
201

Dries's avatar
   
Dries committed
202
  $confdir = 'sites';
203
  $uri = explode('/', $_SERVER['PHP_SELF'] ? $_SERVER['PHP_SELF'] : $_SERVER['SCRIPT_FILENAME']);
204
  $server = explode('.', implode('.', array_reverse(explode(':', rtrim($_SERVER['HTTP_HOST'], '.')))));
Dries's avatar
Dries committed
205
206
207
208
209
210
211
  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
212
213
    }
  }
Dries's avatar
Dries committed
214
215
  $conf = "$confdir/default";
  return $conf;
Dries's avatar
 
Dries committed
216
217
}

218
219
220
221
222
/**
 * Unsets all disallowed global variables. See $allowed for what's allowed.
 */
function drupal_unset_globals() {
  if (ini_get('register_globals')) {
223
    $allowed = array('_ENV' => 1, '_GET' => 1, '_POST' => 1, '_COOKIE' => 1, '_FILES' => 1, '_SERVER' => 1, '_REQUEST' => 1, 'access_check' => 1, 'GLOBALS' => 1);
224
    foreach ($GLOBALS as $key => $value) {
225
226
227
228
229
230
231
      if (!isset($allowed[$key])) {
        unset($GLOBALS[$key]);
      }
    }
  }
}

232
233
234
235
/**
 * Loads the configuration and sets the base URL correctly.
 */
function conf_init() {
236
  global $db_url, $db_prefix, $base_url, $base_path, $base_root, $conf, $installed_profile;
237
  $conf = array();
238
  include_once './'. conf_path() .'/settings.php';
239
240
241
242

  if (isset($base_url)) {
    // Parse fixed base URL from settings.php.
    $parts = parse_url($base_url);
243
244
245
246
    if (!isset($parts['path'])) {
      $parts['path'] = '';
    }
    $base_path = $parts['path'] . '/';
247
248
249
250
251
252
253
    // 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'];
254
    if ($dir = trim(dirname($_SERVER['PHP_SELF']), '\,/')) {
255
256
257
258
259
260
261
262
263
264
      $base_path = "/$dir";
      $base_url .= $base_path;
      $base_path .= '/';
    }
    else {
      $base_path = '/';
    }
  }
}

Dries's avatar
Dries committed
265
266
/**
 * Returns and optionally sets the filename for a system item (module,
267
 * theme, etc.). The filename, whether provided, cached, or retrieved
Dries's avatar
Dries committed
268
269
 * from the database, is only returned if the file exists.
 *
Dries's avatar
Dries committed
270
271
272
273
274
275
276
277
278
279
280
281
 * 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
282
283
284
285
286
287
288
289
290
291
292
 * @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
293
function drupal_get_filename($type, $name, $filename = NULL) {
Dries's avatar
Dries committed
294
  static $files = array();
Dries's avatar
Dries committed
295
  global $active_db;
Dries's avatar
Dries committed
296

297
  if (!isset($files[$type])) {
Dries's avatar
Dries committed
298
299
300
    $files[$type] = array();
  }

301
  if (!empty($filename) && file_exists($filename)) {
Dries's avatar
Dries committed
302
303
    $files[$type][$name] = $filename;
  }
304
  elseif (isset($files[$type][$name])) {
Dries's avatar
Dries committed
305
306
    // nothing
  }
Dries's avatar
Dries committed
307
308
309
310
311
  // 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
312
313
314
    $files[$type][$name] = $file;
  }
  else {
Dries's avatar
Dries committed
315
316
    // 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
317
    $config = conf_path();
Dries's avatar
Dries committed
318
    $dir = (($type == 'theme_engine') ? 'themes/engines' : "${type}s");
Dries's avatar
   
Dries committed
319
    $file = (($type == 'theme_engine') ? "$name.engine" : "$name.$type");
Dries's avatar
Dries committed
320
321
322
323
324
325
326
327
328
329
330
331

    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
332
333
334
335
336
337
338
/**
 * 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
339
function variable_init($conf = array()) {
340
  // NOTE: caching the variables improves performance by 20% when serving cached pages.
341
  if ($cached = cache_get('variables', 'cache')) {
Dries's avatar
   
Dries committed
342
343
344
345
346
347
    $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
348
    }
349
    cache_set('variables', 'cache', serialize($variables));
Dries's avatar
   
Dries committed
350
351
352
353
  }

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

Dries's avatar
   
Dries committed
356
  return $variables;
Dries's avatar
 
Dries committed
357
358
}

Dries's avatar
   
Dries committed
359
360
361
362
363
364
365
366
367
368
/**
 * 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
369
370
371
372
373
374
function variable_get($name, $default) {
  global $conf;

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

Dries's avatar
   
Dries committed
375
376
377
378
379
380
381
382
383
/**
 * 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
384
385
386
function variable_set($name, $value) {
  global $conf;

387
  db_lock_table('variable');
Dries's avatar
 
Dries committed
388
389
  db_query("DELETE FROM {variable} WHERE name = '%s'", $name);
  db_query("INSERT INTO {variable} (name, value) VALUES ('%s', '%s')", $name, serialize($value));
390
  db_unlock_tables();
Dries's avatar
   
Dries committed
391

392
  cache_clear_all('variables', 'cache');
Dries's avatar
 
Dries committed
393
394
395
396

  $conf[$name] = $value;
}

Dries's avatar
   
Dries committed
397
398
399
400
401
402
/**
 * Unset a persistent variable.
 *
 * @param $name
 *   The name of the variable to undefine.
 */
Dries's avatar
 
Dries committed
403
404
405
406
function variable_del($name) {
  global $conf;

  db_query("DELETE FROM {variable} WHERE name = '%s'", $name);
407
  cache_clear_all('variables', 'cache');
Dries's avatar
 
Dries committed
408
409
410
411

  unset($conf[$name]);
}

Dries's avatar
   
Dries committed
412
413
414
/**
 * Retrieve the current page from the cache.
 *
415
 * Note: we do not serve cached pages when status messages are waiting (from
Dries's avatar
   
Dries committed
416
417
 * a redirected form submission which was completed).
 */
Dries's avatar
 
Dries committed
418
function page_get_cache() {
419
  global $user, $base_root;
Dries's avatar
 
Dries committed
420
421

  $cache = NULL;
422

423
  if (!$user->uid && $_SERVER['REQUEST_METHOD'] == 'GET' && count(drupal_set_message()) == 0) {
424
    $cache = cache_get($base_root . request_uri(), 'cache_page');
Dries's avatar
 
Dries committed
425
426
427
428
429
430
431
432
433

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

  return $cache;
}

Dries's avatar
Dries committed
434
435
436
/**
 * Call all init or exit hooks without including all modules.
 *
437
 * @param $hook
Dries's avatar
Dries committed
438
439
 *   The name of the bootstrap hook we wish to invoke.
 */
440
function bootstrap_invoke_all($hook) {
441
  foreach (module_list(TRUE, TRUE) as $module) {
Dries's avatar
Dries committed
442
    drupal_load('module', $module);
443
    module_invoke($module, $hook);
Dries's avatar
Dries committed
444
445
446
447
 }
}

/**
448
 * Includes a file with the provided type and name. This prevents
Dries's avatar
Dries committed
449
450
451
452
453
454
455
456
457
458
459
460
461
 * 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();

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

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

  if ($filename) {
469
    include_once "./$filename";
Dries's avatar
Dries committed
470
471
472
473
474
475
476
477
    $files[$type][$name] = TRUE;

    return TRUE;
  }

  return FALSE;
}

Dries's avatar
   
Dries committed
478
479
/**
 * Set HTTP headers in preparation for a page response.
480
 *
481
482
483
484
 * 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.
 *
485
 * @see page_set_cache
Dries's avatar
   
Dries committed
486
 */
Dries's avatar
 
Dries committed
487
function drupal_page_header() {
488
489
490
491
492
493
  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
494

495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
/**
 * 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();
  }
521

522
523
524
  // Send appropriate response:
  header("Last-Modified: $last_modified");
  header("ETag: $etag");
525

526
527
528
  // The following headers force validation of cache:
  header("Expires: Sun, 19 Nov 1978 05:00:00 GMT");
  header("Cache-Control: must-revalidate");
529

530
531
532
533
  // 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));
534
  }
535
536
  elseif (function_exists('gzencode')) {
    header('Content-Encoding: gzip');
Dries's avatar
 
Dries committed
537
  }
538
539
540
541
542
543
544
545
546
547

  // 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
548
549
}

Dries's avatar
   
Dries committed
550
551
552
/**
 * Define the critical hooks that force modules to always be loaded.
 */
Dries's avatar
 
Dries committed
553
554
555
556
function bootstrap_hooks() {
  return array('init', 'exit');
}

Dries's avatar
   
Dries committed
557
558
559
560
561
562
563
564
/**
 * 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
565
566
567
568
569
570
571
572
573
574
575
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
576
577
578
/**
 * Return the URI of the referring page.
 */
Dries's avatar
 
Dries committed
579
function referer_uri() {
580
  if (isset($_SERVER['HTTP_REFERER'])) {
581
    return $_SERVER['HTTP_REFERER'];
Dries's avatar
 
Dries committed
582
583
584
  }
}

Dries's avatar
Dries committed
585
586
587
588
589
590
591
/**
 * 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
592
/**
593
594
 * Since $_SERVER['REQUEST_URI'] is only available on Apache, we
 * generate an equivalent using other environment variables.
Dries's avatar
   
Dries committed
595
 */
Dries's avatar
 
Dries committed
596
function request_uri() {
597
598
599
600
601
602
603

  if (isset($_SERVER['REQUEST_URI'])) {
    $uri = $_SERVER['REQUEST_URI'];
  }
  else {
    if (isset($_SERVER['argv'])) {
      $uri = $_SERVER['PHP_SELF'] .'?'. $_SERVER['argv'][0];
604
605
    }
    else {
606
      $uri = $_SERVER['PHP_SELF'] .'?'. $_SERVER['QUERY_STRING'];
607
    }
Dries's avatar
 
Dries committed
608
  }
609

610
  return $uri;
Dries's avatar
 
Dries committed
611
}
Dries's avatar
Dries committed
612

Dries's avatar
   
Dries committed
613
614
615
616
617
618
619
/**
 * Log a system message.
 *
 * @param $type
 *   The category to which this message belongs.
 * @param $message
 *   The message to store in the log.
620
621
622
623
624
 * @param $severity
 *   The severity of the message. One of the following values:
 *   - WATCHDOG_NOTICE
 *   - WATCHDOG_WARNING
 *   - WATCHDOG_ERROR
Dries's avatar
   
Dries committed
625
626
627
 * @param $link
 *   A link to associate with the message.
 */
628
function watchdog($type, $message, $severity = WATCHDOG_NOTICE, $link = NULL) {
629
  global $user, $base_root;
630
631
632

  $current_db = db_set_active();

633
634
635
636
  // 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());
637
638
639
640

  if ($current_db) {
    db_set_active($current_db);
  }
Dries's avatar
   
Dries committed
641
642
}

Dries's avatar
   
Dries committed
643
/**
644
 * Set a message which reflects the status of the performed operation.
Dries's avatar
   
Dries committed
645
 *
646
647
 * If the function is called with no arguments, this function returns all set
 * messages without clearing them.
Dries's avatar
   
Dries committed
648
 *
649
650
651
652
653
654
655
 * @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
656
657
 */
function drupal_set_message($message = NULL, $type = 'status') {
658
  if ($message) {
Dries's avatar
   
Dries committed
659
660
661
662
663
664
665
666
667
    if (!isset($_SESSION['messages'])) {
      $_SESSION['messages'] = array();
    }

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

    $_SESSION['messages'][$type][] = $message;
668
669
  }

670
671
  // messages not set when DB connection fails
  return isset($_SESSION['messages']) ? $_SESSION['messages'] : NULL;
672
673
}

Dries's avatar
   
Dries committed
674
675
676
/**
 * Return all messages that have been set.
 *
677
678
 * @param $type
 *   (optional) Only return messages of this type.
679
680
 * @param $clear_queue
 *   (optional) Set to FALSE if you do not want to clear the messages queue
Dries's avatar
   
Dries committed
681
 */
682
function drupal_get_messages($type = NULL, $clear_queue = TRUE) {
683
  if ($messages = drupal_set_message()) {
684
    if ($type) {
685
686
687
      if ($clear_queue) {
         unset($_SESSION['messages'][$type]);
      }
688
689
690
      return array($type => $messages[$type]);
    }
    else {
691
692
693
      if ($clear_queue) {
         unset($_SESSION['messages']);
      }
694
695
      return $messages;
    }
696
  }
697
  return array();
698
699
}

Dries's avatar
   
Dries committed
700
/**
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
 * 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
717
 */
718
function drupal_is_denied($type, $mask) {
719
720
721
722
723
724
725
726
727
728
729
730
  // 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.
731
  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
732
733
}

734
/**
735
 * Generates a default anonymous $user object.
736
737
738
 *
 * @return Object - the user object.
 */
739
function drupal_anonymous_user($session = '') {
740
741
742
743
744
  $user = new stdClass();
  $user->uid = 0;
  $user->hostname = $_SERVER['REMOTE_ADDR'];
  $user->roles = array();
  $user->roles[DRUPAL_ANONYMOUS_RID] = 'anonymous user';
745
  $user->session = $session;
746
747
748
  return $user;
}

749
750
751
/**
 * 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
752
 * phases too. The most important usage is that if you want to access the
753
 * Drupal database from a script without loading anything else, you can
754
 * include bootstrap.inc, and call drupal_bootstrap(DRUPAL_BOOTSTRAP_DATABASE).
755
756
 *
 * @param $phase
757
 *   A constant. Allowed values are:
758
759
 *     DRUPAL_BOOTSTRAP_CONFIGURATION: initialize configuration.
 *     DRUPAL_BOOTSTRAP_EARLY_PAGE_CACHE: try to call a non-database cache fetch routine.
760
 *     DRUPAL_BOOTSTRAP_DATABASE: initialize database layer.
761
 *     DRUPAL_BOOTSTRAP_ACCESS: identify and reject banned hosts.
762
 *     DRUPAL_BOOTSTRAP_SESSION: initialize session handling.
763
 *     DRUPAL_BOOTSTRAP_LATE_PAGE_CACHE: load bootstrap.inc and module.inc, start
764
 *       the variable system and try to serve a page from the cache.
765
 *     DRUPAL_BOOTSTRAP_PATH: set $_GET['q'] to Drupal path of request.
766
 *     DRUPAL_BOOTSTRAP_FULL: Drupal is fully loaded, validate and fix input data.
767
768
 */
function drupal_bootstrap($phase) {
769
  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);
770

771
  while (!is_null($current_phase = array_shift($phases))) {
772
773
774
775
776
777
    _drupal_bootstrap($current_phase);
    if ($phase == $current_phase) {
      return;
    }
  }
}
Dries's avatar
   
Dries committed
778

779
780
function _drupal_bootstrap($phase) {
  global $conf;
Dries's avatar
 
Dries committed
781

782
  switch ($phase) {
783

784
    case DRUPAL_BOOTSTRAP_CONFIGURATION:
785
      drupal_unset_globals();
786
787
      // Initialize the configuration
      conf_init();
788
      break;
789

790
    case DRUPAL_BOOTSTRAP_EARLY_PAGE_CACHE:
791
      _drupal_cache_init($phase);
792
      break;
793

794
    case DRUPAL_BOOTSTRAP_DATABASE:
795
      // Initialize the default database.
796
      require_once './includes/database.inc';
797
798
      db_set_active();
      break;
799

800
801
802
803
804
805
806
807
808
    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;

809
    case DRUPAL_BOOTSTRAP_SESSION:
810
      require_once './includes/session.inc';
811
      session_set_save_handler('sess_open', 'sess_close', 'sess_read', 'sess_write', 'sess_destroy_sid', 'sess_gc');
812
813
      session_start();
      break;
814

815
    case DRUPAL_BOOTSTRAP_LATE_PAGE_CACHE:
816
817
818
819
      // Initialize configuration variables, using values from settings.php if available.
      $conf = variable_init(isset($conf) ? $conf : array());

      _drupal_cache_init($phase);
820

821
822
823
      // Start a page timer:
      timer_start('page');

824
825
      drupal_page_header();
      break;
826

827
828
829
830
831
832
    case DRUPAL_BOOTSTRAP_PATH:
      require_once './includes/path.inc';
      // Initialize $_GET['q'] prior to loading modules and invoking hook_init().
      drupal_init_path();
      break;

833
    case DRUPAL_BOOTSTRAP_FULL:
834
835
836
837
      require_once './includes/common.inc';
      _drupal_bootstrap_full();
      break;
  }
Dries's avatar
   
Dries committed
838
839
}

840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
/**
 * 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';
  }
}

870
871
872
/**
 * Enables use of the theme system without requiring database access. Since
 * there is not database access no theme will be enabled and the default
873
 * themeable functions will be called. Some themeable functions can not be used
874
875
876
877
878
 * 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;
879
  require_once './includes/path.inc';
880
881
882
  require_once './includes/theme.inc';
  require_once './includes/common.inc';
  require_once './includes/unicode.inc';
883
  require_once './modules/filter/filter.module';
884
  unicode_check();
885
886
  drupal_add_css(drupal_get_path('module', 'system') .'/defaults.css', 'module');
  drupal_add_css(drupal_get_path('module', 'system') .'/system.css', 'module');
887
888
  $theme = '';
}
889
890
891
892
893
894
895
896
897
898
899
900

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