bootstrap.inc 19.4 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
13
14
15
define('CACHE_DISABLED', 0);
define('CACHE_ENABLED_STRICT', 1);
define('CACHE_ENABLED_LOOSE', 2);

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


Dries's avatar
   
Dries committed
21
22
23
/**
 * Locate the appropriate configuration file.
 *
Dries's avatar
Dries committed
24
25
 * Try finding a matching configuration directory by stripping the
 * website's hostname from left to right and pathname from right to
Dries's avatar
   
Dries committed
26
27
28
 * 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
29
 *
30
 * Example for a fictitious site installed at
Dries's avatar
   
Dries committed
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 * http://www.drupal.org/mysite/test/ the 'settings.php' is
 * searched in the following directories:
 *
 *  1. $confdir/www.drupal.org.mysite.test
 *  2. $confdir/drupal.org.mysite.test
 *  3. $confdir/org.mysite.test
 *
 *  4. $confdir/www.drupal.org.mysite
 *  5. $confdir/drupal.org.mysite
 *  6. $confdir/org.mysite
 *
 *  7. $confdir/www.drupal.org
 *  8. $confdir/drupal.org
 *  9. $confdir/org
 *
 * 10. $confdir/default
Dries's avatar
   
Dries committed
47
48
 */
function conf_init() {
Dries's avatar
Dries committed
49
  static $conf = '';
Dries's avatar
 
Dries committed
50

Dries's avatar
Dries committed
51
52
53
  if ($conf) {
    return $conf;
  }
Dries's avatar
 
Dries committed
54

Dries's avatar
   
Dries committed
55
  $confdir = 'sites';
Dries's avatar
Dries committed
56
  $uri = explode('/', $_SERVER['PHP_SELF']);
57
  $server = explode('.', rtrim($_SERVER['HTTP_HOST'], '.'));
Dries's avatar
Dries committed
58
59
60
61
62
63
64
  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
65
66
    }
  }
Dries's avatar
Dries committed
67
68
  $conf = "$confdir/default";
  return $conf;
Dries's avatar
 
Dries committed
69
70
}

Dries's avatar
Dries committed
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
/**
 * 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();

  if (!$files[$type]) {
    $files[$type] = array();
  }

  if ($filename && file_exists($filename)) {
    $files[$type][$name] = $filename;
  }
  elseif ($files[$type][$name]) {
    // 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 {
    $config = conf_init();
    $dir = (($type == 'theme_engine') ? 'themes/engines' : "${type}s");
Dries's avatar
   
Dries committed
106
    $file = (($type == 'theme_engine') ? "$name.engine" : "$name.$type");
Dries's avatar
Dries committed
107
108
109
110
111
112
113
114
115
116
117
118

    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
119
120
121
122
123
124
125
/**
 * 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
126
function variable_init($conf = array()) {
Dries's avatar
   
Dries committed
127
128
129
130
131
132
133
134
  // 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
135
    }
Dries's avatar
   
Dries committed
136
137
138
139
140
    cache_set('variables', serialize($variables));
  }

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

Dries's avatar
   
Dries committed
143
  return $variables;
Dries's avatar
 
Dries committed
144
145
}

Dries's avatar
   
Dries committed
146
147
148
149
150
151
152
153
154
155
/**
 * 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
156
157
158
159
160
161
function variable_get($name, $default) {
  global $conf;

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

Dries's avatar
   
Dries committed
162
163
164
165
166
167
168
169
170
/**
 * 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
171
172
173
174
175
function variable_set($name, $value) {
  global $conf;

  db_query("DELETE FROM {variable} WHERE name = '%s'", $name);
  db_query("INSERT INTO {variable} (name, value) VALUES ('%s', '%s')", $name, serialize($value));
Dries's avatar
   
Dries committed
176
  cache_clear_all('variables');
Dries's avatar
 
Dries committed
177
178
179
180

  $conf[$name] = $value;
}

Dries's avatar
   
Dries committed
181
182
183
184
185
186
/**
 * Unset a persistent variable.
 *
 * @param $name
 *   The name of the variable to undefine.
 */
Dries's avatar
 
Dries committed
187
188
189
190
function variable_del($name) {
  global $conf;

  db_query("DELETE FROM {variable} WHERE name = '%s'", $name);
Dries's avatar
   
Dries committed
191
  cache_clear_all('variables');
Dries's avatar
 
Dries committed
192
193
194
195

  unset($conf[$name]);
}

Dries's avatar
   
Dries committed
196
197
198
199
200
201
/**
 * Return data from the persistent cache.
 *
 * @param $key
 *   The cache ID of the data to retrieve.
 */
Dries's avatar
 
Dries committed
202
function cache_get($key) {
203
204
205
206
207
208
209
210
211
212
213
  global $user;

  // CACHE_ENABLED_LOOSE garbage collection
  $cache_flush = variable_get('cache_flush', 0);
  if ($cache_flush && ($cache_flush + variable_get('cache_flush_delay', 300) <= time())) {
    // 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
214
  if (isset($cache->data)) {
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
    // If data is permanent or using strict caching, always return data.
    if ($cache->expire == CACHE_PERMANENT || variable_get('cache', CACHE_DISABLED) == CACHE_ENABLED_STRICT) {
      $cache->data = db_decode_blob($cache->data);
    }
    // If using loose caching, validate data is current before we return it by
    // making sure the cache entry was created before the timestamp in the
    // current session's cache timer.  The cache variable is already loaded
    // into the $user object by sess_read in session.inc.
    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
232
233
234
    return $cache;
  }
  return 0;
Dries's avatar
 
Dries committed
235
236
}

Dries's avatar
   
Dries committed
237
238
239
240
241
242
243
244
/**
 * 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
245
246
247
248
249
250
251
 *   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
252
253
254
 * @param $headers
 *   A string containing HTTP header information for cached pages.
 */
255
function cache_set($cid, $data, $expire = CACHE_PERMANENT, $headers = NULL) {
Dries's avatar
   
Dries committed
256
257
  $data = db_encode_blob($data);

258
  db_query("UPDATE {cache} SET data = '%s', created = %d, expire = %d, headers = '%s' WHERE cid = '%s'", $data, time(), $expire, $headers, $cid);
Dries's avatar
 
Dries committed
259
  if (!db_affected_rows()) {
Dries's avatar
   
Dries committed
260
    @db_query("INSERT INTO {cache} (cid, data, created, expire, headers) VALUES ('%s', '%s', %d, %d, '%s')", $cid, $data, time(), $expire, $headers);
261
  }
Dries's avatar
 
Dries committed
262
263
}

Dries's avatar
   
Dries committed
264
265
266
267
/**
 * Expire data from the cache.
 *
 * @param $cid
268
269
 *   If set, the cache ID to delete. Otherwise, all cache entries that can
 *   expire are deleted.
270
271
272
273
 *
 * @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
274
 */
275
function cache_clear_all($cid = NULL, $wildcard = false) {
276
277
  global $user;

Dries's avatar
 
Dries committed
278
  if (empty($cid)) {
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
    if (variable_get('cache', CACHE_DISABLED) == CACHE_ENABLED_STRICT) {
      // Strict caching, flush all temporary cache entries:
      db_query("DELETE FROM {cache} WHERE expire != %d AND expire < %d", CACHE_PERMANENT, time());
    }
    else {
      $cache_flush = variable_get('cache_flush', 0);
      // Loose caching, only flush temporary cache entries that have been
      // invalidated for more than maximum allowable time.
      if ($cache_flush && ($cache_flush + variable_get('cache_flush_delay', 300) <= time())) {
        // Only flush cache data older than $cache_flush, as newer data may
        // now be valid.
        db_query("DELETE FROM {cache} WHERE expire != %d AND expire <= %d", CACHE_PERMANENT, $cache_flush);
        variable_set('cache_flush', 0);
      }
      // Invalidate temporary cache data only for current user/session.  We
      // set $user->cache, which gets saved into the sessions table by
      // sess_write() in session.inc.
      $user->cache = time();
      if (variable_get('cache_flush', 0) == 0) {
        // Set timestamp to know which cache entries we eventually clear:
        variable_set('cache_flush', time());
      }
    }
Dries's avatar
 
Dries committed
302
303
  }
  else {
304
305
306
307
308
309
    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
310
311
312
  }
}

Dries's avatar
   
Dries committed
313
314
315
/**
 * Store the current page in the cache.
 */
Dries's avatar
 
Dries committed
316
function page_set_cache() {
Dries's avatar
   
Dries committed
317
  global $user, $base_url;
Dries's avatar
 
Dries committed
318

319
320
  if (!$user->uid && $_SERVER['REQUEST_METHOD'] == 'GET') {
    // This will fail in some cases, see page_get_cache() for the explanation.
Dries's avatar
 
Dries committed
321
    if ($data = ob_get_contents()) {
Dries's avatar
   
Dries committed
322
323
324
325
326
327
328
329
      if (function_exists('gzencode')) {
        if (version_compare(phpversion(), '4.2', '>=')) {
          $data = gzencode($data, 9, FORCE_GZIP);
        }
        else {
          $data = gzencode($data, FORCE_GZIP);
        }
      }
330
      ob_end_flush();
331
      cache_set($base_url . request_uri(), $data, CACHE_TEMPORARY, drupal_get_headers());
Dries's avatar
 
Dries committed
332
333
334
335
    }
  }
}

Dries's avatar
   
Dries committed
336
337
338
339
340
341
342
343
/**
 * 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
344
function page_get_cache() {
Dries's avatar
   
Dries committed
345
  global $user, $base_url;
Dries's avatar
 
Dries committed
346
347

  $cache = NULL;
348

349
  if (!$user->uid && $_SERVER['REQUEST_METHOD'] == 'GET' && count(drupal_set_message()) == 0) {
Dries's avatar
   
Dries committed
350
    $cache = cache_get($base_url . request_uri());
Dries's avatar
 
Dries committed
351
352
353
354
355
356
357
358
359

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

  return $cache;
}

Dries's avatar
Dries committed
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
/**
 * Call all init or exit hooks without including all modules.
 *
 * @param $op
 *   The name of the bootstrap hook we wish to invoke.
 */
function bootstrap_invoke_all($op) {
  foreach (module_list(FALSE, TRUE) as $module) {
    drupal_load('module', $module);
    module_invoke($module, $op);
 }
}

/**
 * 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) {
  // print $name. '<br />';
  static $files = array();

  if ($files[$type][$name]) {
    return TRUE;
  }

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

  if ($filename) {
    include_once($filename);
    $files[$type][$name] = TRUE;

    return TRUE;
  }

  return FALSE;
}

/**
 * Return an array mapping path aliases to their internal Drupal paths.
 */
function drupal_get_path_map($action = '') {
  static $map = NULL;

  if ($action == 'rebuild') {
    $map = NULL;
  }

  if (is_null($map)) {
    $map = array();  // Make $map non-null in case no aliases are defined.
    $result = db_query('SELECT * FROM {url_alias}');
    while ($data = db_fetch_object($result)) {
      $map[$data->dst] = $data->src;
    }
  }

  return $map;
}

/**
 * Given an internal Drupal path, return the alias set by the administrator.
 */
function drupal_get_path_alias($path) {
  if (($map = drupal_get_path_map()) && ($newpath = array_search($path, $map))) {
    return $newpath;
  }
  elseif (function_exists('conf_url_rewrite')) {
    return conf_url_rewrite($path, 'outgoing');
  }
  else {
    // No alias found. Return the normal path.
    return $path;
  }
}

/**
 * Get the title of the current page, for display on the page and in the title bar.
 */
function drupal_get_title() {
  $title = drupal_set_title();

  if (!isset($title)) {
    // during a bootstrap, menu.inc is not included and thus we cannot provide a title
    if (function_exists('menu_get_active_title')) {
451
      $title = check_plain(menu_get_active_title());
Dries's avatar
Dries committed
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
    }
  }

  return $title;
}

/**
 * Set the title of the current page, for display on the page and in the title bar.
 */
function drupal_set_title($title = NULL) {
  static $stored_title;

  if (isset($title)) {
    $stored_title = $title;
  }
  return $stored_title;
}

Dries's avatar
   
Dries committed
470
471
472
/**
 * Set HTTP headers in preparation for a page response.
 */
Dries's avatar
 
Dries committed
473
function drupal_page_header() {
474
  if (variable_get('dev_timer', 0)) {
Dries's avatar
 
Dries committed
475
476
477
    timer_start();
  }

478
  if (variable_get('cache', 0)) {
Dries's avatar
 
Dries committed
479
    if ($cache = page_get_cache()) {
480
      bootstrap_invoke_all('init');
Dries's avatar
 
Dries committed
481
      // Set default values:
482
      $date = gmdate('D, d M Y H:i:s', $cache->created) .' GMT';
Dries's avatar
 
Dries committed
483
484
485
      $etag = '"'. md5($date) .'"';

      // Check http headers:
486
487
      $modified_since = isset($_SERVER['HTTP_IF_MODIFIED_SINCE']) ? $_SERVER['HTTP_IF_MODIFIED_SINCE'] == $date : NULL;
      if (!empty($_SERVER['HTTP_IF_MODIFIED_SINCE']) && ($timestamp = strtotime($_SERVER['HTTP_IF_MODIFIED_SINCE'])) != -1) {
Dries's avatar
Dries committed
488
489
490
491
492
        $modified_since = $cache->created <= $timestamp;
      }
      else {
        $modified_since = NULL;
      }
493
      $none_match = !empty($_SERVER['HTTP_IF_NONE_MATCH']) ? $_SERVER['HTTP_IF_NONE_MATCH'] == $etag : NULL;
Dries's avatar
 
Dries committed
494
495
496

      // 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) {
497
        header('HTTP/1.0 304 Not Modified');
Dries's avatar
 
Dries committed
498
499
500
501
502
503
        exit();
      }

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

Dries's avatar
   
Dries committed
505
      // Determine if the browser accepts gzipped data.
Dries's avatar
   
Dries committed
506
      if (@strpos($_SERVER['HTTP_ACCEPT_ENCODING'], 'gzip') === false && function_exists('gzencode')) {
Dries's avatar
   
Dries committed
507
        // Strip the gzip header and run uncompress.
Dries's avatar
   
Dries committed
508
509
510
511
512
513
        $cache->data = gzinflate(substr(substr($cache->data, 10), 0, -8));
      }
      elseif (function_exists('gzencode')) {
        header('Content-Encoding: gzip');
      }

Dries's avatar
   
Dries committed
514
515
516
      // Send the original request's headers.  We send them one after
      // another so PHP's header() function can deal with duplicate
      // headers.
517
      $headers = explode("\n", $cache->headers);
Dries's avatar
   
Dries committed
518
519
520
521
      foreach ($headers as $header) {
        header($header);
      }

Dries's avatar
   
Dries committed
522
      print $cache->data;
Dries's avatar
Dries committed
523
      bootstrap_invoke_all('exit');
Dries's avatar
 
Dries committed
524
525
      exit();
    }
526
527
528
529
530
531
532
    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
533
534
535
  }
}

Dries's avatar
   
Dries committed
536
537
538
/**
 * Define the critical hooks that force modules to always be loaded.
 */
Dries's avatar
 
Dries committed
539
540
541
542
function bootstrap_hooks() {
  return array('init', 'exit');
}

Dries's avatar
   
Dries committed
543
544
545
546
547
548
549
550
/**
 * 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
551
552
553
554
555
556
557
558
559
560
561
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
562
563
564
/**
 * Return the URI of the referring page.
 */
Dries's avatar
 
Dries committed
565
function referer_uri() {
566
  if (isset($_SERVER['HTTP_REFERER'])) {
567
    return $_SERVER['HTTP_REFERER'];
Dries's avatar
 
Dries committed
568
569
570
  }
}

Dries's avatar
   
Dries committed
571
572
573
574
575
576
577
578
579
580
581
/**
 * Return a component of the current Drupal path.
 *
 * When viewing a page at the path "admin/node/configure", for example, arg(0)
 * would return "admin", arg(1) would return "node", and arg(2) would return
 * "configure".
 *
 * Avoid use of this function where possible, as resulting code is hard to read.
 * Instead, attempt to use named arguments in menu callback functions. See the
 * explanation in menu.inc for how to construct callbacks that take arguments.
 */
Dries's avatar
 
Dries committed
582
function arg($index) {
Dries's avatar
   
Dries committed
583
  static $arguments, $q;
Dries's avatar
 
Dries committed
584

585
586
  if (empty($arguments) || $q != $_GET['q']) {
    $arguments = explode('/', $_GET['q']);
Dries's avatar
 
Dries committed
587
588
  }

Dries's avatar
   
Dries committed
589
590
591
  if (array_key_exists($index, $arguments)) {
    return $arguments[$index];
  }
Dries's avatar
 
Dries committed
592
593
}

Dries's avatar
   
Dries committed
594
/**
595
 * Prepare a URL for use in an HTML attribute.
Dries's avatar
   
Dries committed
596
 *
597
 * We replace ( and ) with their url-encoded equivalents to prevent XSS attacks.
Dries's avatar
   
Dries committed
598
 */
Dries's avatar
 
Dries committed
599
600
601
function check_url($uri) {
  $uri = htmlspecialchars($uri, ENT_QUOTES);

602
  $uri = strtr($uri, array('(' => '%28', ')' => '%29'));
Dries's avatar
 
Dries committed
603
604
605
606

  return $uri;
}

Dries's avatar
   
Dries committed
607
608
609
610
/**
 * Since request_uri() is only available on Apache, we generate an
 * equivalent using other environment vars.
 */
Dries's avatar
 
Dries committed
611
612
function request_uri() {

613
614
  if (isset($_SERVER['REQUEST_URI'])) {
    $uri = $_SERVER['REQUEST_URI'];
Dries's avatar
 
Dries committed
615
616
  }
  else {
617
618
619
620
621
622
    if (isset($_SERVER['argv'])) {
      $uri = $_SERVER['PHP_SELF'] .'?'. $_SERVER['argv'][0];
    }
    else {
      $uri = $_SERVER['PHP_SELF'] .'?'. $_SERVER['QUERY_STRING'];
    }
Dries's avatar
 
Dries committed
623
  }
624

625
  return $uri;
Dries's avatar
 
Dries committed
626
}
Dries's avatar
Dries committed
627

Dries's avatar
   
Dries committed
628
629
630
/**
 * Begin a global timer, for benchmarking of page execution time.
 */
Dries's avatar
 
Dries committed
631
632
function timer_start() {
  global $timer;
Dries's avatar
   
Dries committed
633
  list($usec, $sec) = explode(' ', microtime());
Dries's avatar
 
Dries committed
634
635
636
  $timer = (float)$usec + (float)$sec;
}

Dries's avatar
   
Dries committed
637
638
639
640
641
642
643
/**
 * Log a system message.
 *
 * @param $type
 *   The category to which this message belongs.
 * @param $message
 *   The message to store in the log.
644
645
646
647
648
 * @param $severity
 *   The severity of the message. One of the following values:
 *   - WATCHDOG_NOTICE
 *   - WATCHDOG_WARNING
 *   - WATCHDOG_ERROR
Dries's avatar
   
Dries committed
649
650
651
 * @param $link
 *   A link to associate with the message.
 */
652
function watchdog($type, $message, $severity = WATCHDOG_NOTICE, $link = NULL) {
Dries's avatar
   
Dries committed
653
  global $user;
654
  db_query("INSERT INTO {watchdog} (uid, type, message, severity, link, location, hostname, timestamp) VALUES (%d, '%s', '%s', %d, '%s', '%s', '%s', %d)", $user->uid, $type, $message, $severity, $link, request_uri(), $_SERVER['REMOTE_ADDR'], time());
Dries's avatar
   
Dries committed
655
656
}

Dries's avatar
   
Dries committed
657
658
659
660
661
662
663
664
665
/**
 * Set a message for the user to see.
 *
 * The message is stored in the session so that it can persist through a redirect.
 *
 * If called with no arguments, this function returns all set messages without
 * clearing them.
 */
function drupal_set_message($message = NULL, $type = 'status') {
666
  if (isset($message)) {
Dries's avatar
   
Dries committed
667
668
669
670
671
672
673
674
675
    if (!isset($_SESSION['messages'])) {
      $_SESSION['messages'] = array();
    }

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

    $_SESSION['messages'][$type][] = $message;
676
677
678
679
680
  }

  return $_SESSION['messages'];
}

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
687
688
689
690
691
692
function drupal_get_messages() {
  $messages = drupal_set_message();
  $_SESSION['messages'] = array();

  return $messages;
}

Dries's avatar
 
Dries committed
693
694
695
unset($conf);
$config = conf_init();

Dries's avatar
Dries committed
696
include_once "$config/settings.php";
697
698
699
include_once 'includes/database.inc';
include_once 'includes/session.inc';
include_once 'includes/module.inc';
Dries's avatar
 
Dries committed
700

Dries's avatar
   
Dries committed
701
// Initialize configuration variables, using values from conf.php if available.
Dries's avatar
 
Dries committed
702
$conf = variable_init(isset($conf) ? $conf : array());
Dries's avatar
   
Dries committed
703

Dries's avatar
 
Dries committed
704
?>