bootstrap.inc 12.5 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

Dries's avatar
 
Dries committed
12 13 14
/**
 * Locate the appropriate configuration file.
 *
Dries's avatar
Dries committed
15 16 17 18 19 20 21 22 23 24 25
 * Try finding a matching configuration directory by stripping the
 * website's hostname from left to right and pathname from right to
 * left.  If no configuration file is found, return a default value
 * '$confdir/default'.  Example for a ficticious site installed at
 * http://www.drupal.org/test:
 *
 * 1. www.drupal.org.test
 * 2. drupal.org.test
 * 3. www.drupal.org
 * 4. drupal.org
 * 5. default
Dries's avatar
 
Dries committed
26 27
 */
function conf_init() {
Dries's avatar
Dries committed
28
  static $conf = '';
Dries's avatar
 
Dries committed
29

Dries's avatar
Dries committed
30 31 32
  if ($conf) {
    return $conf;
  }
Dries's avatar
 
Dries committed
33

Dries's avatar
Dries committed
34 35 36 37 38 39 40 41 42 43
  $uri = explode('/', $_SERVER['PHP_SELF']);
  $server = explode('.', $_SERVER['HTTP_HOST']);
  $confdir = 'sites';
  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
44 45 46
    }
  }

Dries's avatar
Dries committed
47 48 49
print "$confdir/default/settings.php<br />";
  $conf = "$confdir/default";
  return $conf;
Dries's avatar
 
Dries committed
50 51
}

Dries's avatar
 
Dries committed
52 53 54 55 56 57 58
/**
 * 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
59
function variable_init($conf = array()) {
Dries's avatar
 
Dries committed
60 61 62 63 64 65 66 67
  // 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
68
    }
Dries's avatar
 
Dries committed
69 70 71 72 73
    cache_set('variables', serialize($variables));
  }

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

Dries's avatar
 
Dries committed
76
  return $variables;
Dries's avatar
 
Dries committed
77 78
}

Dries's avatar
 
Dries committed
79 80 81 82 83 84 85 86 87 88
/**
 * 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
89 90 91 92 93 94
function variable_get($name, $default) {
  global $conf;

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

Dries's avatar
 
Dries committed
95 96 97 98 99 100 101 102 103
/**
 * 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
104 105 106 107 108
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
109
  cache_clear_all('variables');
Dries's avatar
 
Dries committed
110 111 112 113

  $conf[$name] = $value;
}

Dries's avatar
 
Dries committed
114 115 116 117 118 119
/**
 * Unset a persistent variable.
 *
 * @param $name
 *   The name of the variable to undefine.
 */
Dries's avatar
 
Dries committed
120 121 122 123
function variable_del($name) {
  global $conf;

  db_query("DELETE FROM {variable} WHERE name = '%s'", $name);
Dries's avatar
 
Dries committed
124
  cache_clear_all('variables');
Dries's avatar
 
Dries committed
125 126 127 128

  unset($conf[$name]);
}

Dries's avatar
 
Dries committed
129 130 131 132 133 134
/**
 * Return data from the persistent cache.
 *
 * @param $key
 *   The cache ID of the data to retrieve.
 */
Dries's avatar
 
Dries committed
135
function cache_get($key) {
Dries's avatar
Dries committed
136
  $cache = db_fetch_object(db_query("SELECT data, created, headers FROM {cache} WHERE cid = '%s'", $key));
Dries's avatar
 
Dries committed
137 138 139 140 141
  if (isset($cache->data)) {
    $cache->data = db_decode_blob($cache->data);
    return $cache;
  }
  return 0;
Dries's avatar
 
Dries committed
142 143
}

Dries's avatar
 
Dries committed
144 145 146 147 148 149 150 151
/**
 * 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
152 153 154 155 156 157 158
 *   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
159 160 161
 * @param $headers
 *   A string containing HTTP header information for cached pages.
 */
162
function cache_set($cid, $data, $expire = CACHE_PERMANENT, $headers = NULL) {
Dries's avatar
 
Dries committed
163 164
  $data = db_encode_blob($data);

165
  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
166
  if (!db_affected_rows()) {
Dries's avatar
 
Dries committed
167
    @db_query("INSERT INTO {cache} (cid, data, created, expire, headers) VALUES ('%s', '%s', %d, %d, '%s')", $cid, $data, time(), $expire, $headers);
168
  }
Dries's avatar
 
Dries committed
169 170
}

Dries's avatar
 
Dries committed
171 172 173 174 175 176
/**
 * Expire data from the cache.
 *
 * @param $cid
 *   If set, the cache ID to delete. Otherwise, all cache entries that can expire
 *   are deleted.
177 178 179 180
 *
 * @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
181
 */
182
function cache_clear_all($cid = NULL, $wildcard = false) {
Dries's avatar
 
Dries committed
183
  if (empty($cid)) {
184
    db_query("DELETE FROM {cache} WHERE expire != %d AND expire < %d", CACHE_PERMANENT, time());
Dries's avatar
 
Dries committed
185 186
  }
  else {
187 188 189 190 191 192
    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
193 194 195
  }
}

Dries's avatar
 
Dries committed
196 197 198
/**
 * Store the current page in the cache.
 */
Dries's avatar
 
Dries committed
199
function page_set_cache() {
Dries's avatar
 
Dries committed
200
  global $user, $base_url;
Dries's avatar
 
Dries committed
201

202 203
  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
204
    if ($data = ob_get_contents()) {
Dries's avatar
 
Dries committed
205 206 207 208 209 210 211 212
      if (function_exists('gzencode')) {
        if (version_compare(phpversion(), '4.2', '>=')) {
          $data = gzencode($data, 9, FORCE_GZIP);
        }
        else {
          $data = gzencode($data, FORCE_GZIP);
        }
      }
213
      cache_set($base_url . request_uri(), $data, CACHE_TEMPORARY, drupal_get_headers());
Dries's avatar
 
Dries committed
214 215 216 217
    }
  }
}

Dries's avatar
 
Dries committed
218 219 220 221 222 223 224 225
/**
 * 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
226
function page_get_cache() {
Dries's avatar
 
Dries committed
227
  global $user, $base_url;
Dries's avatar
 
Dries committed
228 229

  $cache = NULL;
230

231
  if (!$user->uid && $_SERVER['REQUEST_METHOD'] == 'GET' && count(drupal_set_message()) == 0) {
Dries's avatar
 
Dries committed
232
    $cache = cache_get($base_url . request_uri());
Dries's avatar
 
Dries committed
233 234 235 236 237 238 239 240 241

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

  return $cache;
}

Dries's avatar
 
Dries committed
242 243 244
/**
 * Set HTTP headers in preparation for a page response.
 */
Dries's avatar
 
Dries committed
245
function drupal_page_header() {
246
  if (variable_get('dev_timer', 0)) {
Dries's avatar
 
Dries committed
247 248 249
    timer_start();
  }

250
  if (variable_get('cache', 0)) {
Dries's avatar
 
Dries committed
251 252 253
    if ($cache = page_get_cache()) {

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

      // Check http headers:
258 259
      $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
260 261 262 263 264
        $modified_since = $cache->created <= $timestamp;
      }
      else {
        $modified_since = NULL;
      }
265
      $none_match = !empty($_SERVER['HTTP_IF_NONE_MATCH']) ? $_SERVER['HTTP_IF_NONE_MATCH'] == $etag : NULL;
Dries's avatar
 
Dries committed
266 267 268

      // 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) {
269
        header('HTTP/1.0 304 Not Modified');
Dries's avatar
 
Dries committed
270 271 272 273 274 275
        exit();
      }

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

Dries's avatar
 
Dries committed
277
      // Determine if the browser accepts gzipped data.
Dries's avatar
 
Dries committed
278
      if (@strpos($_SERVER['HTTP_ACCEPT_ENCODING'], 'gzip') === false && function_exists('gzencode')) {
Dries's avatar
 
Dries committed
279
        // Strip the gzip header and run uncompress.
Dries's avatar
 
Dries committed
280 281 282 283 284 285
        $cache->data = gzinflate(substr(substr($cache->data, 10), 0, -8));
      }
      elseif (function_exists('gzencode')) {
        header('Content-Encoding: gzip');
      }

Dries's avatar
 
Dries committed
286 287 288
      // Send the original request's headers.  We send them one after
      // another so PHP's header() function can deal with duplicate
      // headers.
289
      $headers = explode("\n", $cache->headers);
Dries's avatar
 
Dries committed
290 291 292 293
      foreach ($headers as $header) {
        header($header);
      }

Dries's avatar
 
Dries committed
294
      print $cache->data;
Dries's avatar
 
Dries committed
295

Dries's avatar
 
Dries committed
296 297
      // Call all init() and exit() hooks without including all modules.
      // Only use those hooks for critical operations.
Dries's avatar
 
Dries committed
298 299
      foreach (bootstrap_hooks() as $hook) {
        module_invoke_all($hook);
Dries's avatar
 
Dries committed
300 301 302 303 304 305
      }
      exit();
    }
  }
}

Dries's avatar
 
Dries committed
306 307 308
/**
 * Define the critical hooks that force modules to always be loaded.
 */
Dries's avatar
 
Dries committed
309 310 311 312
function bootstrap_hooks() {
  return array('init', 'exit');
}

Dries's avatar
 
Dries committed
313 314 315 316 317 318 319 320
/**
 * 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
321 322 323 324 325 326 327 328 329 330 331
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
332 333 334
/**
 * Return the URI of the referring page.
 */
Dries's avatar
 
Dries committed
335
function referer_uri() {
336 337
  if (isset($_SERVER['HTTP_REFERER'])) {
    return check_url($_SERVER['HTTP_REFERER']);
Dries's avatar
 
Dries committed
338 339 340
  }
}

Dries's avatar
 
Dries committed
341 342 343 344 345 346 347 348 349 350 351
/**
 * 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
352
function arg($index) {
Dries's avatar
 
Dries committed
353
  static $arguments, $q;
Dries's avatar
 
Dries committed
354

355 356
  if (empty($arguments) || $q != $_GET['q']) {
    $arguments = explode('/', $_GET['q']);
Dries's avatar
 
Dries committed
357 358
  }

Dries's avatar
 
Dries committed
359 360 361
  if (array_key_exists($index, $arguments)) {
    return $arguments[$index];
  }
Dries's avatar
 
Dries committed
362 363
}

Dries's avatar
 
Dries committed
364 365 366 367 368
/**
 * Prepare user input for use in a URI.
 *
 * We replace ( and ) with their entity equivalents to prevent XSS attacks.
 */
Dries's avatar
 
Dries committed
369 370 371
function check_url($uri) {
  $uri = htmlspecialchars($uri, ENT_QUOTES);

372
  $uri = strtr($uri, array('(' => '&040;', ')' => '&041;'));
Dries's avatar
 
Dries committed
373 374 375 376

  return $uri;
}

Dries's avatar
 
Dries committed
377 378 379 380
/**
 * Since request_uri() is only available on Apache, we generate an
 * equivalent using other environment vars.
 */
Dries's avatar
 
Dries committed
381 382
function request_uri() {

383 384
  if (isset($_SERVER['REQUEST_URI'])) {
    $uri = $_SERVER['REQUEST_URI'];
Dries's avatar
 
Dries committed
385 386
  }
  else {
387 388 389 390 391 392
    if (isset($_SERVER['argv'])) {
      $uri = $_SERVER['PHP_SELF'] .'?'. $_SERVER['argv'][0];
    }
    else {
      $uri = $_SERVER['PHP_SELF'] .'?'. $_SERVER['QUERY_STRING'];
    }
Dries's avatar
 
Dries committed
393
  }
394

Dries's avatar
 
Dries committed
395 396
  return check_url($uri);
}
Dries's avatar
Dries committed
397

Dries's avatar
 
Dries committed
398 399 400
/**
 * Begin a global timer, for benchmarking of page execution time.
 */
Dries's avatar
 
Dries committed
401 402
function timer_start() {
  global $timer;
Dries's avatar
 
Dries committed
403
  list($usec, $sec) = explode(' ', microtime());
Dries's avatar
 
Dries committed
404 405 406
  $timer = (float)$usec + (float)$sec;
}

Dries's avatar
 
Dries committed
407 408 409 410 411 412 413 414 415 416
/**
 * 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
417 418
function watchdog($type, $message, $link = NULL) {
  global $user;
Kjartan's avatar
Kjartan committed
419
  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
420 421
}

Dries's avatar
 
Dries committed
422 423 424 425 426 427 428 429 430
/**
 * 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') {
431
  if (isset($message)) {
Dries's avatar
 
Dries committed
432 433 434 435 436 437 438 439 440
    if (!isset($_SESSION['messages'])) {
      $_SESSION['messages'] = array();
    }

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

    $_SESSION['messages'][$type][] = $message;
441 442 443 444 445
  }

  return $_SESSION['messages'];
}

Dries's avatar
 
Dries committed
446 447 448 449 450
/**
 * Return all messages that have been set.
 *
 * As a side effect, this function clears the message queue.
 */
451 452 453 454 455 456 457
function drupal_get_messages() {
  $messages = drupal_set_message();
  $_SESSION['messages'] = array();

  return $messages;
}

Dries's avatar
 
Dries committed
458 459 460
unset($conf);
$config = conf_init();

Dries's avatar
Dries committed
461
include_once "$config/settings.php";
462 463 464
include_once 'includes/database.inc';
include_once 'includes/session.inc';
include_once 'includes/module.inc';
Dries's avatar
 
Dries committed
465

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

Dries's avatar
 
Dries committed
469
?>