bootstrap.inc 12 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.
 */
8
9
10
 
define('CACHE_PERMANENT', 0);
define('CACHE_TEMPORARY', -1);
Dries's avatar
 
Dries committed
11

Dries's avatar
   
Dries committed
12
13
14
15
16
17
18
19
/**
 * Locate the appropriate configuration file.
 *
 * Try finding a matching configuration file by stripping the website's
 * URI from left to right.  If no configuration file is found, return the
 * default value, "conf".
 */
function conf_init() {
20
  $uri = $_SERVER['PHP_SELF'];
Dries's avatar
 
Dries committed
21

22
  $file = strtolower(strtr($_SERVER['HTTP_HOST'] . substr($uri, 0, strrpos($uri, '/')), '/:', '..'));
Dries's avatar
 
Dries committed
23
24

  while (strlen($file) > 4) {
Dries's avatar
   
Dries committed
25
    if (file_exists('includes/'. $file .'.php')) {
Dries's avatar
 
Dries committed
26
27
28
      return $file;
    }
    else {
29
      $file = substr($file, strpos($file, '.') + 1);
Dries's avatar
 
Dries committed
30
31
32
    }
  }

33
  return 'conf';
Dries's avatar
 
Dries committed
34
35
}

Dries's avatar
   
Dries committed
36
37
38
39
40
41
42
/**
 * 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
43
function variable_init($conf = array()) {
Dries's avatar
   
Dries committed
44
45
46
47
48
49
50
51
  // 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
52
    }
Dries's avatar
   
Dries committed
53
54
55
56
57
    cache_set('variables', serialize($variables));
  }

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

Dries's avatar
   
Dries committed
60
  return $variables;
Dries's avatar
 
Dries committed
61
62
}

Dries's avatar
   
Dries committed
63
64
65
66
67
68
69
70
71
72
/**
 * 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
73
74
75
76
77
78
function variable_get($name, $default) {
  global $conf;

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

Dries's avatar
   
Dries committed
79
80
81
82
83
84
85
86
87
/**
 * 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
88
89
90
91
92
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
93
  cache_clear_all('variables');
Dries's avatar
 
Dries committed
94
95
96
97

  $conf[$name] = $value;
}

Dries's avatar
   
Dries committed
98
99
100
101
102
103
/**
 * Unset a persistent variable.
 *
 * @param $name
 *   The name of the variable to undefine.
 */
Dries's avatar
 
Dries committed
104
105
106
107
function variable_del($name) {
  global $conf;

  db_query("DELETE FROM {variable} WHERE name = '%s'", $name);
Dries's avatar
   
Dries committed
108
  cache_clear_all('variables');
Dries's avatar
 
Dries committed
109
110
111
112

  unset($conf[$name]);
}

Dries's avatar
   
Dries committed
113
114
115
116
117
118
/**
 * Return data from the persistent cache.
 *
 * @param $key
 *   The cache ID of the data to retrieve.
 */
Dries's avatar
 
Dries committed
119
function cache_get($key) {
Dries's avatar
Dries committed
120
  $cache = db_fetch_object(db_query("SELECT data, created, headers FROM {cache} WHERE cid = '%s'", $key));
121
  return isset($cache->data) ? $cache : 0;
Dries's avatar
 
Dries committed
122
123
}

Dries's avatar
   
Dries committed
124
125
126
127
128
129
130
131
/**
 * 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
132
133
134
135
136
137
138
 *   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
139
140
141
 * @param $headers
 *   A string containing HTTP header information for cached pages.
 */
142
function cache_set($cid, $data, $expire = CACHE_PERMANENT, $headers = NULL) {
Dries's avatar
   
Dries committed
143
144
  $data = db_encode_blob($data);

145
  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
146
  if (!db_affected_rows()) {
147
148
    db_query("INSERT INTO {cache} (cid, data, created, expire, headers) VALUES ('%s', '%s', %d, %d, '%s')", $cid, $data, time(), $expire, $headers);
  }
Dries's avatar
 
Dries committed
149
150
}

Dries's avatar
   
Dries committed
151
152
153
154
155
156
/**
 * Expire data from the cache.
 *
 * @param $cid
 *   If set, the cache ID to delete. Otherwise, all cache entries that can expire
 *   are deleted.
157
158
159
160
 *
 * @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
161
 */
162
function cache_clear_all($cid = NULL, $wildcard = false) {
Dries's avatar
 
Dries committed
163
  if (empty($cid)) {
164
    db_query("DELETE FROM {cache} WHERE expire != %d AND expire < %d", CACHE_PERMANENT, time());
Dries's avatar
 
Dries committed
165
166
  }
  else {
167
168
169
170
171
172
    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
173
174
175
  }
}

Dries's avatar
   
Dries committed
176
177
178
/**
 * Store the current page in the cache.
 */
Dries's avatar
 
Dries committed
179
function page_set_cache() {
Dries's avatar
   
Dries committed
180
  global $user, $base_url;
Dries's avatar
 
Dries committed
181

182
183
  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
184
    if ($data = ob_get_contents()) {
Dries's avatar
   
Dries committed
185
186
187
188
189
190
191
192
      if (function_exists('gzencode')) {
        if (version_compare(phpversion(), '4.2', '>=')) {
          $data = gzencode($data, 9, FORCE_GZIP);
        }
        else {
          $data = gzencode($data, FORCE_GZIP);
        }
      }
193
      cache_set($base_url . request_uri(), $data, CACHE_TEMPORARY, drupal_get_headers());
Dries's avatar
 
Dries committed
194
195
196
197
    }
  }
}

Dries's avatar
   
Dries committed
198
199
200
201
202
203
204
205
/**
 * 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
206
function page_get_cache() {
Dries's avatar
   
Dries committed
207
  global $user, $base_url;
Dries's avatar
 
Dries committed
208
209

  $cache = NULL;
210

211
  if (!$user->uid && $_SERVER['REQUEST_METHOD'] == 'GET' && count(drupal_set_message()) == 0) {
Dries's avatar
   
Dries committed
212
    $cache = cache_get($base_url . request_uri());
Dries's avatar
 
Dries committed
213
214
215
216
217
218
219
220
221

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

  return $cache;
}

Dries's avatar
   
Dries committed
222
223
224
/**
 * Set HTTP headers in preparation for a page response.
 */
Dries's avatar
 
Dries committed
225
function drupal_page_header() {
226
  if (variable_get('dev_timer', 0)) {
Dries's avatar
 
Dries committed
227
228
229
    timer_start();
  }

230
  if (variable_get('cache', 0)) {
Dries's avatar
 
Dries committed
231
232
233
    if ($cache = page_get_cache()) {

      // Set default values:
234
      $date = gmdate('D, d M Y H:i:s', $cache->created) .' GMT';
Dries's avatar
 
Dries committed
235
236
237
      $etag = '"'. md5($date) .'"';

      // Check http headers:
238
239
      $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
240
241
242
243
244
        $modified_since = $cache->created <= $timestamp;
      }
      else {
        $modified_since = NULL;
      }
245
      $none_match = !empty($_SERVER['HTTP_IF_NONE_MATCH']) ? $_SERVER['HTTP_IF_NONE_MATCH'] == $etag : NULL;
Dries's avatar
 
Dries committed
246
247
248

      // 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) {
249
        header('HTTP/1.0 304 Not Modified');
Dries's avatar
 
Dries committed
250
251
252
253
254
255
        exit();
      }

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

Dries's avatar
   
Dries committed
257
      // Determine if the browser accepts gzipped data.
Dries's avatar
   
Dries committed
258
      if (@strpos($_SERVER['HTTP_ACCEPT_ENCODING'], 'gzip') === false && function_exists('gzencode')) {
Dries's avatar
   
Dries committed
259
        // Strip the gzip header and run uncompress.
Dries's avatar
   
Dries committed
260
261
262
263
264
265
        $cache->data = gzinflate(substr(substr($cache->data, 10), 0, -8));
      }
      elseif (function_exists('gzencode')) {
        header('Content-Encoding: gzip');
      }

Dries's avatar
   
Dries committed
266
267
268
      // Send the original request's headers.  We send them one after
      // another so PHP's header() function can deal with duplicate
      // headers.
269
      $headers = explode("\n", $cache->headers);
Dries's avatar
   
Dries committed
270
271
272
273
      foreach ($headers as $header) {
        header($header);
      }

Dries's avatar
   
Dries committed
274
      print db_decode_blob($cache->data);
Dries's avatar
 
Dries committed
275

Dries's avatar
   
Dries committed
276
277
      // Call all init() and exit() hooks without including all modules.
      // Only use those hooks for critical operations.
Dries's avatar
   
Dries committed
278
279
      foreach (bootstrap_hooks() as $hook) {
        module_invoke_all($hook);
Dries's avatar
 
Dries committed
280
281
282
283
284
285
      }
      exit();
    }
  }
}

Dries's avatar
   
Dries committed
286
287
288
/**
 * Define the critical hooks that force modules to always be loaded.
 */
Dries's avatar
 
Dries committed
289
290
291
292
function bootstrap_hooks() {
  return array('init', 'exit');
}

Dries's avatar
   
Dries committed
293
294
295
296
297
298
299
300
/**
 * 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
301
302
303
304
305
306
307
308
309
310
311
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
312
313
314
/**
 * Return the URI of the referring page.
 */
Dries's avatar
 
Dries committed
315
function referer_uri() {
316
317
  if (isset($_SERVER['HTTP_REFERER'])) {
    return check_url($_SERVER['HTTP_REFERER']);
Dries's avatar
 
Dries committed
318
319
320
  }
}

Dries's avatar
   
Dries committed
321
322
323
324
325
326
327
328
329
330
331
/**
 * 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
332
function arg($index) {
Dries's avatar
   
Dries committed
333
  static $arguments, $q;
Dries's avatar
 
Dries committed
334

335
336
  if (empty($arguments) || $q != $_GET['q']) {
    $arguments = explode('/', $_GET['q']);
Dries's avatar
 
Dries committed
337
338
  }

Dries's avatar
   
Dries committed
339
340
341
  if (array_key_exists($index, $arguments)) {
    return $arguments[$index];
  }
Dries's avatar
 
Dries committed
342
343
}

Dries's avatar
   
Dries committed
344
345
346
/**
 * Prepare user input for use in a database query, preventing SQL injection attacks.
 */
Dries's avatar
 
Dries committed
347
348
349
350
function check_query($text) {
  return addslashes($text);
}

Dries's avatar
   
Dries committed
351
352
353
354
355
/**
 * Prepare user input for use in a URI.
 *
 * We replace ( and ) with their entity equivalents to prevent XSS attacks.
 */
Dries's avatar
 
Dries committed
356
357
358
function check_url($uri) {
  $uri = htmlspecialchars($uri, ENT_QUOTES);

359
  $uri = strtr($uri, array('(' => '&040;', ')' => '&041;'));
Dries's avatar
 
Dries committed
360
361
362
363

  return $uri;
}

Dries's avatar
   
Dries committed
364
365
366
367
/**
 * Since request_uri() is only available on Apache, we generate an
 * equivalent using other environment vars.
 */
Dries's avatar
 
Dries committed
368
369
function request_uri() {

370
371
  if (isset($_SERVER['REQUEST_URI'])) {
    $uri = $_SERVER['REQUEST_URI'];
Dries's avatar
 
Dries committed
372
373
  }
  else {
374
    $uri = $_SERVER['PHP_SELF'] .'?'. $_SERVER['argv'][0];
Dries's avatar
 
Dries committed
375
376
377
378
  }

  return check_url($uri);
}
Dries's avatar
Dries committed
379

Dries's avatar
   
Dries committed
380
381
382
/**
 * Begin a global timer, for benchmarking of page execution time.
 */
Dries's avatar
 
Dries committed
383
384
function timer_start() {
  global $timer;
Dries's avatar
   
Dries committed
385
  list($usec, $sec) = explode(' ', microtime());
Dries's avatar
 
Dries committed
386
387
388
  $timer = (float)$usec + (float)$sec;
}

Dries's avatar
   
Dries committed
389
390
391
392
393
394
395
396
397
398
/**
 * Log a system message.
 *
 * @param $type
 *   The category to which this message belongs.
 * @param $message
 *   The message to store in the log.
 * @param $link
 *   A link to associate with the message.
 */
Dries's avatar
   
Dries committed
399
400
function watchdog($type, $message, $link = NULL) {
  global $user;
Kjartan's avatar
Kjartan committed
401
  db_query("INSERT INTO {watchdog} (uid, type, message, link, location, hostname, timestamp) VALUES (%d, '%s', '%s', '%s', '%s', '%s', %d)", $user->uid, $type, $message, $link, request_uri(), $_SERVER['REMOTE_ADDR'], time());
Dries's avatar
   
Dries committed
402
403
}

Dries's avatar
   
Dries committed
404
405
406
407
408
409
410
411
412
/**
 * 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') {
413
  if (isset($message)) {
Dries's avatar
   
Dries committed
414
415
416
417
418
419
420
421
422
    if (!isset($_SESSION['messages'])) {
      $_SESSION['messages'] = array();
    }

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

    $_SESSION['messages'][$type][] = $message;
423
424
425
426
427
  }

  return $_SESSION['messages'];
}

Dries's avatar
   
Dries committed
428
429
430
431
432
/**
 * Return all messages that have been set.
 *
 * As a side effect, this function clears the message queue.
 */
433
434
435
436
437
438
439
function drupal_get_messages() {
  $messages = drupal_set_message();
  $_SESSION['messages'] = array();

  return $messages;
}

Dries's avatar
 
Dries committed
440
441
442
443
unset($conf);
$config = conf_init();

include_once "includes/$config.php";
444
445
446
include_once 'includes/database.inc';
include_once 'includes/session.inc';
include_once 'includes/module.inc';
Dries's avatar
 
Dries committed
447

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

Dries's avatar
 
Dries committed
451
?>