bootstrap.inc 23.3 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
define('CACHE_ENABLED', 1);
14

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

19
20
21
define('DRUPAL_BOOTSTRAP_DATABASE', 0);
define('DRUPAL_BOOTSTRAP_SESSION', 1);
define('DRUPAL_BOOTSTRAP_PAGE_CACHE', 2);
22
23
define('DRUPAL_BOOTSTRAP_PATH', 3);
define('DRUPAL_BOOTSTRAP_FULL', 4);
24

25
26
27
28
// these values should match the'role' table
define('DRUPAL_ANONYMOUS_RID', 1);
define('DRUPAL_AUTHENTICATED_RID', 2);

Dries's avatar
   
Dries committed
29
30
31
32
33
34
35
36
37
38
39
40
41
/**
 * Start the timer with the specified name.  If you start and stop
 * 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;
42
  $timers[$name]['count'] = isset($timers[$name]['count']) ? ++$timers[$name]['count'] : 1;
Dries's avatar
   
Dries committed
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
}

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

  list($usec, $sec) = explode(' ', microtime());
  $stop = (float)$usec + (float)$sec;
  $diff = round(($stop - $timers[$name]['start']) * 1000, 2);

  return $timers[$name]['time'] + $diff;
}

/**
 * Stop the timer with the specified name.
 *
 * @param name
 *   The name of the timer.
 * @return
 *   A timer array.  The array contains the number of times the
 *   timer has been started and stopped (count) and the accumulated
 *   timer value in ms (time).
 */
function timer_stop($name) {
  global $timers;

76
  $timers[$name]['time'] = timer_read($name);
Dries's avatar
   
Dries committed
77
78
79
80
  unset($timers[$name]['start']);

  return $timers[$name];
}
81

Dries's avatar
   
Dries committed
82
/**
83
 * Find the appropriate configuration directory.
Dries's avatar
   
Dries committed
84
 *
85
86
87
88
 * Try finding a matching configuration directory by stripping the website's
 * hostname from left to right and pathname from right to left. The first
 * configuration file found will be used, the remaining will ignored. If no
 * configuration file is found, return a default value '$confdir/default'.
Dries's avatar
Dries committed
89
 *
90
 * Example for a fictitious site installed at
91
92
 * http://www.drupal.org:8080/mysite/test/ the 'settings.php' is searched in
 * the following directories:
Dries's avatar
   
Dries committed
93
 *
94
95
96
97
 *  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
98
 *
99
100
101
102
 *  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
103
 *
104
105
106
107
 *  9. $confdir/8080.www.drupal.org
 * 10. $confdir/www.drupal.org
 * 11. $confdir/drupal.org
 * 12. $confdir/org
Dries's avatar
   
Dries committed
108
 *
109
 * 13. $confdir/default
Dries's avatar
   
Dries committed
110
 */
111
function conf_path() {
Dries's avatar
Dries committed
112
  static $conf = '';
Dries's avatar
 
Dries committed
113

Dries's avatar
Dries committed
114
115
116
  if ($conf) {
    return $conf;
  }
Dries's avatar
 
Dries committed
117

Dries's avatar
   
Dries committed
118
  $confdir = 'sites';
119
  $uri = explode('/', $_SERVER['PHP_SELF'] ? $_SERVER['PHP_SELF'] : $_SERVER['SCRIPT_FILENAME']);
120
  $server = explode('.', implode('.', array_reverse(explode(':', rtrim($_SERVER['HTTP_HOST'], '.')))));
Dries's avatar
Dries committed
121
122
123
124
125
126
127
  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
128
129
    }
  }
Dries's avatar
Dries committed
130
131
  $conf = "$confdir/default";
  return $conf;
Dries's avatar
 
Dries committed
132
133
}

134
135
136
137
138
139
140
141
142
143
144
145
146
147
/**
 * Unsets all disallowed global variables. See $allowed for what's allowed.
 */
function drupal_unset_globals() {
  if (ini_get('register_globals')) {
    $allowed = array('_ENV' => 1, '_GET' => 1, '_POST' => 1, '_COOKIE' => 1, '_FILES' => 1, '_SERVER' => 1, '_REQUEST' => 1, 'access_check' => 1);
    foreach ($GLOBALS as $key => $value) {
      if (!isset($allowed[$key])) {
        unset($GLOBALS[$key]);
      }
    }
  }
}

148
149
150
151
/**
 * Loads the configuration and sets the base URL correctly.
 */
function conf_init() {
152
  global $db_url, $db_prefix, $base_url, $base_path, $base_root, $conf;
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
  $conf = array();
  require_once './'. conf_path() .'/settings.php';

  if (isset($base_url)) {
    // Parse fixed base URL from settings.php.
    $parts = parse_url($base_url);
    $base_path = isset($parts['path']) ? $parts['path'] . '/' : '/';
    // 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'];
    if ($dir = trim(dirname($_SERVER['SCRIPT_NAME']), '\,/')) {
      $base_path = "/$dir";
      $base_url .= $base_path;
      $base_path .= '/';
    }
    else {
      $base_path = '/';
    }
  }
}

Dries's avatar
Dries committed
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
/**
 * Returns and optionally sets the filename for a system item (module,
 * theme, etc.).  The filename, whether provided, cached, or retrieved
 * from the database, is only returned if the file exists.
 *
 * @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.
 */
function drupal_get_filename($type, $name, $filename = NULL) {
  static $files = array();

197
  if (!isset($files[$type])) {
Dries's avatar
Dries committed
198
199
200
    $files[$type] = array();
  }

201
  if (!empty($filename) && file_exists($filename)) {
Dries's avatar
Dries committed
202
203
    $files[$type][$name] = $filename;
  }
204
  elseif (isset($files[$type][$name])) {
Dries's avatar
Dries committed
205
206
207
208
209
210
    // nothing
  }
  elseif (($file = db_result(db_query("SELECT filename FROM {system} WHERE name = '%s' AND type = '%s'", $name, $type))) && file_exists($file)) {
    $files[$type][$name] = $file;
  }
  else {
Steven Wittens's avatar
Steven Wittens committed
211
    $config = conf_path();
Dries's avatar
Dries committed
212
    $dir = (($type == 'theme_engine') ? 'themes/engines' : "${type}s");
Dries's avatar
   
Dries committed
213
    $file = (($type == 'theme_engine') ? "$name.engine" : "$name.$type");
Dries's avatar
Dries committed
214
215
216
217
218
219
220
221
222
223
224
225

    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
226
227
228
229
230
231
232
/**
 * 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
233
function variable_init($conf = array()) {
Dries's avatar
   
Dries committed
234
235
236
237
238
239
240
241
  // NOTE: caching the variables improves performance with 20% when serving cached pages.
  if ($cached = cache_get('variables')) {
    $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
242
    }
Dries's avatar
   
Dries committed
243
244
245
246
247
    cache_set('variables', serialize($variables));
  }

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

Dries's avatar
   
Dries committed
250
  return $variables;
Dries's avatar
 
Dries committed
251
252
}

Dries's avatar
   
Dries committed
253
254
255
256
257
258
259
260
261
262
/**
 * 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
263
264
265
266
267
268
function variable_get($name, $default) {
  global $conf;

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

Dries's avatar
   
Dries committed
269
270
271
272
273
274
275
276
277
/**
 * 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
278
279
280
function variable_set($name, $value) {
  global $conf;

281
  db_lock_table('variable');
Dries's avatar
 
Dries committed
282
283
  db_query("DELETE FROM {variable} WHERE name = '%s'", $name);
  db_query("INSERT INTO {variable} (name, value) VALUES ('%s', '%s')", $name, serialize($value));
284
  db_unlock_tables();
Dries's avatar
   
Dries committed
285

Dries's avatar
   
Dries committed
286
  cache_clear_all('variables');
Dries's avatar
 
Dries committed
287
288
289
290

  $conf[$name] = $value;
}

Dries's avatar
   
Dries committed
291
292
293
294
295
296
/**
 * Unset a persistent variable.
 *
 * @param $name
 *   The name of the variable to undefine.
 */
Dries's avatar
 
Dries committed
297
298
299
300
function variable_del($name) {
  global $conf;

  db_query("DELETE FROM {variable} WHERE name = '%s'", $name);
Dries's avatar
   
Dries committed
301
  cache_clear_all('variables');
Dries's avatar
 
Dries committed
302
303
304
305

  unset($conf[$name]);
}

Dries's avatar
   
Dries committed
306
307
308
309
310
311
/**
 * Return data from the persistent cache.
 *
 * @param $key
 *   The cache ID of the data to retrieve.
 */
Dries's avatar
 
Dries committed
312
function cache_get($key) {
313
314
  global $user;

315
  // Garbage collection necessary when enforcing a minimum cache lifetime
316
  $cache_flush = variable_get('cache_flush', 0);
317
  if ($cache_flush && ($cache_flush + variable_get('cache_lifetime', 0) <= time())) {
318
319
320
321
322
323
    // Time to flush old cache data
    db_query("DELETE FROM {cache} WHERE expire != %d AND expire <= %d", CACHE_PERMANENT, $cache_flush);
    variable_set('cache_flush', 0);
  }

  $cache = db_fetch_object(db_query("SELECT data, created, headers, expire FROM {cache} WHERE cid = '%s'", $key));
Dries's avatar
   
Dries committed
324
  if (isset($cache->data)) {
325
326
327
    // If the data is permanent or we're not enforcing a minimum cache lifetime
    // always return the cached data.
    if ($cache->expire == CACHE_PERMANENT || !variable_get('cache_lifetime', 0)) {
328
329
      $cache->data = db_decode_blob($cache->data);
    }
330
    // If enforcing a minimum cache lifetime, validate that the data is
331
    // currently valid for this user before we return it by making sure the
332
333
334
    // cache entry was created before the timestamp in the current session's
    // cache timer.  The cache variable is loaded into the $user object by
    // sess_read() in session.inc.
335
336
337
338
339
340
341
342
343
    else {
      if ($user->cache > $cache->created) {
        // This cache data is too old and thus not valid for us, ignore it.
        return 0;
      }
      else {
        $cache->data = db_decode_blob($cache->data);
      }
    }
Dries's avatar
   
Dries committed
344
345
346
    return $cache;
  }
  return 0;
Dries's avatar
 
Dries committed
347
348
}

Dries's avatar
   
Dries committed
349
350
351
352
353
354
355
356
/**
 * Store data in the persistent cache.
 *
 * @param $cid
 *   The cache ID of the data to store.
 * @param $data
 *   The data to store in the cache. Complex data types must be serialized first.
 * @param $expire
357
358
359
360
361
362
363
 *   One of the following values:
 *   - CACHE_PERMANENT: Indicates that the item should never be removed unless
 *     explicitly told to using cache_clear_all() with a cache ID.
 *   - CACHE_TEMPORARY: Indicates that the item should be removed at the next
 *     general cache wipe.
 *   - A Unix timestamp: Indicates that the item should be kept at least until
 *     the given time, after which it behaves like CACHE_TEMPORARY.
Dries's avatar
   
Dries committed
364
365
366
 * @param $headers
 *   A string containing HTTP header information for cached pages.
 */
367
function cache_set($cid, $data, $expire = CACHE_PERMANENT, $headers = NULL) {
368
  db_lock_table('cache');
369
  db_query("UPDATE {cache} SET data = %b, created = %d, expire = %d, headers = '%s' WHERE cid = '%s'", $data, time(), $expire, $headers, $cid);
Dries's avatar
 
Dries committed
370
  if (!db_affected_rows()) {
371
    @db_query("INSERT INTO {cache} (cid, data, created, expire, headers) VALUES ('%s', %b, %d, %d, '%s')", $cid, $data, time(), $expire, $headers);
372
  }
373
  db_unlock_tables();
Dries's avatar
 
Dries committed
374
375
}

Dries's avatar
   
Dries committed
376
377
378
379
/**
 * Expire data from the cache.
 *
 * @param $cid
380
381
 *   If set, the cache ID to delete. Otherwise, all cache entries that can
 *   expire are deleted.
382
383
384
385
 *
 * @param $wildcard
 *   If set to true, the $cid is treated as a substring to match rather than a
 *   complete ID.
Dries's avatar
   
Dries committed
386
 */
387
function cache_clear_all($cid = NULL, $wildcard = false) {
388
389
  global $user;

Dries's avatar
 
Dries committed
390
  if (empty($cid)) {
391
392
393
394
395
    if (variable_get('cache_lifetime', 0)) {
      // We store the time in the current user's $user->cache variable which
      // will be saved into the sessions table by sess_write().  We then
      // simulate that the cache was flushed for this user by not returning
      // cached data that was cached before the timestamp.
396
      $user->cache = time();
397
398
399
400

      $cache_flush = variable_get('cache_flush', 0);
      if ($cache_flush == 0) {
        // This is the first request to clear the cache, start a timer.
401
402
        variable_set('cache_flush', time());
      }
403
404
405
406
407
408
409
410
411
412
      else if (time() > ($cache_flush + variable_get('cache_lifetime', 0))) {
        // Clear the cache for everyone, cache_flush_delay seconds have
        // passed since the first request to clear the cache.
        db_query("DELETE FROM {cache} WHERE expire != %d AND expire < %d", CACHE_PERMANENT, time());
        variable_set('cache_flush', 0);
      }
    }
    else {
      // No minimum cache lifetime, flush all temporary cache entries now.
      db_query("DELETE FROM {cache} WHERE expire != %d AND expire < %d", CACHE_PERMANENT, time());
413
    }
Dries's avatar
 
Dries committed
414
415
  }
  else {
416
417
418
419
420
421
    if ($wildcard) {
      db_query("DELETE FROM {cache} WHERE cid LIKE '%%%s%%'", $cid);
    }
    else {
      db_query("DELETE FROM {cache} WHERE cid = '%s'", $cid);
    }
Dries's avatar
 
Dries committed
422
423
424
  }
}

Dries's avatar
   
Dries committed
425
426
427
428
429
430
431
432
/**
 * Retrieve the current page from the cache.
 *
 * Note, we do not serve cached pages when status messages are waiting (from
 * a redirected form submission which was completed).
 * Because the output handler is not activated, the resulting page will not
 * get cached either.
 */
Dries's avatar
 
Dries committed
433
function page_get_cache() {
434
  global $user, $base_root;
Dries's avatar
 
Dries committed
435
436

  $cache = NULL;
437

438
  if (!$user->uid && $_SERVER['REQUEST_METHOD'] == 'GET' && count(drupal_set_message()) == 0) {
439
    $cache = cache_get($base_root . request_uri());
Dries's avatar
 
Dries committed
440
441
442
443
444
445
446
447
448

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

  return $cache;
}

Dries's avatar
Dries committed
449
450
451
/**
 * Call all init or exit hooks without including all modules.
 *
452
 * @param $hook
Dries's avatar
Dries committed
453
454
 *   The name of the bootstrap hook we wish to invoke.
 */
455
function bootstrap_invoke_all($hook) {
Dries's avatar
Dries committed
456
457
  foreach (module_list(FALSE, TRUE) as $module) {
    drupal_load('module', $module);
458
    module_invoke($module, $hook);
Dries's avatar
Dries committed
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
 }
}

/**
 * Includes a file with the provided type and name.  This prevents
 * 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();

477
  if (isset($files[$type][$name])) {
Dries's avatar
Dries committed
478
479
480
481
482
483
    return TRUE;
  }

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

  if ($filename) {
484
    include_once "./$filename";
Dries's avatar
Dries committed
485
486
487
488
489
490
491
492
    $files[$type][$name] = TRUE;

    return TRUE;
  }

  return FALSE;
}

Dries's avatar
   
Dries committed
493
494
/**
 * Set HTTP headers in preparation for a page response.
495
496
 *
 * @see page_set_cache
Dries's avatar
   
Dries committed
497
 */
Dries's avatar
 
Dries committed
498
function drupal_page_header() {
499
  if (variable_get('cache', 0)) {
Dries's avatar
 
Dries committed
500
    if ($cache = page_get_cache()) {
501
      bootstrap_invoke_all('init');
Dries's avatar
 
Dries committed
502
      // Set default values:
503
      $date = gmdate('D, d M Y H:i:s', $cache->created) .' GMT';
Dries's avatar
 
Dries committed
504
505
506
      $etag = '"'. md5($date) .'"';

      // Check http headers:
507
      $modified_since = isset($_SERVER['HTTP_IF_MODIFIED_SINCE']) ? $_SERVER['HTTP_IF_MODIFIED_SINCE'] == $date : NULL;
508
      if (!empty($_SERVER['HTTP_IF_MODIFIED_SINCE']) && ($timestamp = strtotime($_SERVER['HTTP_IF_MODIFIED_SINCE'])) > 0) {
Dries's avatar
Dries committed
509
510
511
512
513
        $modified_since = $cache->created <= $timestamp;
      }
      else {
        $modified_since = NULL;
      }
514
      $none_match = !empty($_SERVER['HTTP_IF_NONE_MATCH']) ? $_SERVER['HTTP_IF_NONE_MATCH'] == $etag : NULL;
Dries's avatar
 
Dries committed
515
516
517

      // The type checking here is very important, be careful when changing entries.
      if (($modified_since !== NULL || $none_match !== NULL) && $modified_since !== false && $none_match !== false) {
518
        header('HTTP/1.0 304 Not Modified');
Dries's avatar
 
Dries committed
519
520
521
522
523
524
        exit();
      }

      // Send appropriate response:
      header("Last-Modified: $date");
      header("ETag: $etag");
Dries's avatar
   
Dries committed
525

Dries's avatar
   
Dries committed
526
      // Determine if the browser accepts gzipped data.
Dries's avatar
   
Dries committed
527
      if (@strpos($_SERVER['HTTP_ACCEPT_ENCODING'], 'gzip') === false && function_exists('gzencode')) {
Dries's avatar
   
Dries committed
528
        // Strip the gzip header and run uncompress.
Dries's avatar
   
Dries committed
529
530
531
532
533
534
        $cache->data = gzinflate(substr(substr($cache->data, 10), 0, -8));
      }
      elseif (function_exists('gzencode')) {
        header('Content-Encoding: gzip');
      }

Dries's avatar
   
Dries committed
535
536
537
      // Send the original request's headers.  We send them one after
      // another so PHP's header() function can deal with duplicate
      // headers.
538
      $headers = explode("\n", $cache->headers);
Dries's avatar
   
Dries committed
539
540
541
542
      foreach ($headers as $header) {
        header($header);
      }

Dries's avatar
   
Dries committed
543
      print $cache->data;
Dries's avatar
Dries committed
544
      bootstrap_invoke_all('exit');
Dries's avatar
 
Dries committed
545
546
      exit();
    }
547
548
549
550
551
552
553
    else {
      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
554
555
556
  }
}

Dries's avatar
   
Dries committed
557
558
559
/**
 * Define the critical hooks that force modules to always be loaded.
 */
Dries's avatar
 
Dries committed
560
561
562
563
function bootstrap_hooks() {
  return array('init', 'exit');
}

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

Dries's avatar
Dries committed
592
593
594
595
596
597
598
/**
 * 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
599
600
/**
 * Since request_uri() is only available on Apache, we generate an
601
 * equivalent using other environment variables.
Dries's avatar
   
Dries committed
602
 */
Dries's avatar
 
Dries committed
603
604
function request_uri() {

605
606
  if (isset($_SERVER['REQUEST_URI'])) {
    $uri = $_SERVER['REQUEST_URI'];
Dries's avatar
 
Dries committed
607
608
  }
  else {
609
610
611
612
613
614
    if (isset($_SERVER['argv'])) {
      $uri = $_SERVER['PHP_SELF'] .'?'. $_SERVER['argv'][0];
    }
    else {
      $uri = $_SERVER['PHP_SELF'] .'?'. $_SERVER['QUERY_STRING'];
    }
Dries's avatar
 
Dries committed
615
  }
616

617
  return $uri;
Dries's avatar
 
Dries committed
618
}
Dries's avatar
Dries committed
619

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

  $current_db = db_set_active();

640
641
642
643
  // 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());
644
645
646
647

  if ($current_db) {
    db_set_active($current_db);
  }
Dries's avatar
   
Dries committed
648
649
}

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

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

    $_SESSION['messages'][$type][] = $message;
675
676
  }

677
678
  // messages not set when DB connection fails
  return isset($_SESSION['messages']) ? $_SESSION['messages'] : NULL;
679
680
}

Dries's avatar
   
Dries committed
681
682
683
684
685
/**
 * Return all messages that have been set.
 *
 * As a side effect, this function clears the message queue.
 */
686
function drupal_get_messages() {
687
688
689
  if ($messages = drupal_set_message()) {
    unset($_SESSION['messages']);
  }
690
691
692
693

  return $messages;
}

Dries's avatar
   
Dries committed
694
695
696
/**
 * Perform an access check for a given mask and rule type. Rules are usually created via admin/access/rules page.
 */
697
function drupal_is_denied($type, $mask) {
Dries's avatar
   
Dries committed
698
699
700
701
702
703
  $allow = db_fetch_object(db_query("SELECT * FROM {access} WHERE status = 1 AND type = '%s' AND LOWER('%s') LIKE LOWER(mask)", $type, $mask));
  $deny = db_fetch_object(db_query("SELECT * FROM {access} WHERE status = 0 AND type = '%s' AND LOWER('%s') LIKE LOWER(mask)", $type, $mask));

  return $deny && !$allow;
}

704
705
706
707
708
/**
 * 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
 * phases too. The most important usage is that if you want to access
 * Drupal database from a script without loading anything else, you can
709
 * include bootstrap.inc, and call drupal_bootstrap(DRUPAL_BOOTSTRAP_DATABASE).
710
711
 *
 * @param $phase
712
713
714
715
716
717
718
 *   A constant. Allowed values are:
 *     DRUPAL_BOOTSTRAP_DATABASE: initialize database layer.
 *     DRUPAL_BOOTSTRAP_SESSION: initialize session handling.
 *     DRUPAL_BOOTSTRAP_PAGE_CACHE: load bootstrap.inc and module.inc, start
 *       the variable system and try to serve a page from the cache.
 *     DRUPAL_BOOTSTRAP_FULL: Drupal is fully loaded, validate and fix input
 *       data.
719
720
 */
function drupal_bootstrap($phase) {
721
  static $phases = array(DRUPAL_BOOTSTRAP_DATABASE, DRUPAL_BOOTSTRAP_SESSION, DRUPAL_BOOTSTRAP_PAGE_CACHE, DRUPAL_BOOTSTRAP_PATH, DRUPAL_BOOTSTRAP_FULL);
722

723
  while (!is_null($current_phase = array_shift($phases))) {
724
725
726
727
728
729
    _drupal_bootstrap($current_phase);
    if ($phase == $current_phase) {
      return;
    }
  }
}
Dries's avatar
   
Dries committed
730

731
732
function _drupal_bootstrap($phase) {
  global $conf;
Dries's avatar
 
Dries committed
733

734
  switch ($phase) {
735
    case DRUPAL_BOOTSTRAP_DATABASE:
736
      drupal_unset_globals();
737
738
      // Initialize the configuration
      conf_init();
739
      // Initialize the default database.
740
      require_once './includes/database.inc';
741
742
      db_set_active();
      break;
743
744

    case DRUPAL_BOOTSTRAP_SESSION:
745
746
747
748
      require_once './includes/session.inc';
      session_set_save_handler("sess_open", "sess_close", "sess_read", "sess_write", "sess_destroy", "sess_gc");
      session_start();
      break;
749
750

    case DRUPAL_BOOTSTRAP_PAGE_CACHE:
751
752
753
754
755
756
757
      require_once './includes/module.inc';
      // Start a page timer:
      timer_start('page');

      // 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');
758
        print 'Sorry, '. $_SERVER['REMOTE_ADDR']. ' has been banned.';
759
760
        exit();
      }
Dries's avatar
   
Dries committed
761

762
763
764
765
      // Initialize configuration variables, using values from conf.php if available.
      $conf = variable_init(isset($conf) ? $conf : array());
      drupal_page_header();
      break;
766

767
768
769
770
771
772
    case DRUPAL_BOOTSTRAP_PATH:
      require_once './includes/path.inc';
      // Initialize $_GET['q'] prior to loading modules and invoking hook_init().
      drupal_init_path();
      break;

773
    case DRUPAL_BOOTSTRAP_FULL:
774
775
776
777
      require_once './includes/common.inc';
      _drupal_bootstrap_full();
      break;
  }
Dries's avatar
   
Dries committed
778
779
}

780
781
782
/**
 * Enables use of the theme system without requiring database access. Since
 * there is not database access no theme will be enabled and the default
783
 * themeable functions will be called. Some themeable functions can not be used
784
785
786
787
788
 * 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;
789
  require_once './includes/path.inc';
790
791
792
793
794
795
  require_once './includes/theme.inc';
  require_once './includes/common.inc';
  require_once './includes/unicode.inc';
  unicode_check();
  $theme = '';
}