bootstrap.inc 98.5 KB
Newer Older
1
<?php
Dries's avatar
 
Dries committed
2
// $Id$
Dries's avatar
 
Dries committed
3

Dries's avatar
 
Dries committed
4 5 6 7
/**
 * @file
 * Functions that need to be loaded on every Drupal request.
 */
Dries's avatar
 
Dries committed
8

9 10 11
/**
 * The current system version.
 */
webchick's avatar
webchick committed
12
define('VERSION', '7.0-dev');
13 14 15 16 17 18 19 20 21

/**
 * Core API compatibility.
 */
define('DRUPAL_CORE_COMPATIBILITY', '7.x');

/**
 * Minimum supported version of PHP.
 */
22
define('DRUPAL_MINIMUM_PHP', '5.2.4');
23 24 25 26

/**
 * Minimum recommended value of PHP memory_limit.
 */
27
define('DRUPAL_MINIMUM_PHP_MEMORY_LIMIT', '32M');
28

29
/**
30 31 32
 * Indicates that the item should never be removed unless explicitly selected.
 *
 * The item may be removed using cache_clear_all() with a cache ID.
33
 */
34
define('CACHE_PERMANENT', 0);
35 36 37 38

/**
 * Indicates that the item should be removed at the next general cache wipe.
 */
39
define('CACHE_TEMPORARY', -1);
Dries's avatar
 
Dries committed
40

41
/**
42
 * Log message severity -- Emergency: system is unusable.
43
 *
44 45 46
 * The WATCHDOG_* constant definitions correspond to the logging severity levels
 * defined in RFC 3164, section 4.1.1: http://www.faqs.org/rfcs/rfc3164.html
 *
47 48
 * @see watchdog()
 * @see watchdog_severity_levels()
49
 */
50
define('WATCHDOG_EMERGENCY', 0);
51 52 53 54

/**
 * Log message severity -- Alert: action must be taken immediately.
 *
55 56 57
 * The WATCHDOG_* constant definitions correspond to the logging severity levels
 * defined in RFC 3164, section 4.1.1: http://www.faqs.org/rfcs/rfc3164.html
 *
58 59 60 61 62 63 64 65
 * @see watchdog()
 * @see watchdog_severity_levels()
 */
define('WATCHDOG_ALERT', 1);

/**
 * Log message severity -- Critical: critical conditions.
 *
66 67 68
 * The WATCHDOG_* constant definitions correspond to the logging severity levels
 * defined in RFC 3164, section 4.1.1: http://www.faqs.org/rfcs/rfc3164.html
 *
69 70 71 72 73 74 75 76
 * @see watchdog()
 * @see watchdog_severity_levels()
 */
define('WATCHDOG_CRITICAL', 2);

/**
 * Log message severity -- Error: error conditions.
 *
77 78 79
 * The WATCHDOG_* constant definitions correspond to the logging severity levels
 * defined in RFC 3164, section 4.1.1: http://www.faqs.org/rfcs/rfc3164.html
 *
80 81 82 83 84 85 86 87
 * @see watchdog()
 * @see watchdog_severity_levels()
 */
define('WATCHDOG_ERROR', 3);

/**
 * Log message severity -- Warning: warning conditions.
 *
88 89 90
 * The WATCHDOG_* constant definitions correspond to the logging severity levels
 * defined in RFC 3164, section 4.1.1: http://www.faqs.org/rfcs/rfc3164.html
 *
91 92 93 94 95 96 97 98
 * @see watchdog()
 * @see watchdog_severity_levels()
 */
define('WATCHDOG_WARNING', 4);

/**
 * Log message severity -- Notice: normal but significant condition.
 *
99 100 101
 * The WATCHDOG_* constant definitions correspond to the logging severity levels
 * defined in RFC 3164, section 4.1.1: http://www.faqs.org/rfcs/rfc3164.html
 *
102 103 104 105 106 107 108 109
 * @see watchdog()
 * @see watchdog_severity_levels()
 */
define('WATCHDOG_NOTICE', 5);

/**
 * Log message severity -- Informational: informational messages.
 *
110 111 112
 * The WATCHDOG_* constant definitions correspond to the logging severity levels
 * defined in RFC 3164, section 4.1.1: http://www.faqs.org/rfcs/rfc3164.html
 *
113 114 115 116 117 118 119 120
 * @see watchdog()
 * @see watchdog_severity_levels()
 */
define('WATCHDOG_INFO', 6);

/**
 * Log message severity -- Debug: debug-level messages.
 *
121 122 123
 * The WATCHDOG_* constant definitions correspond to the logging severity levels
 * defined in RFC 3164, section 4.1.1: http://www.faqs.org/rfcs/rfc3164.html
 *
124 125 126 127
 * @see watchdog()
 * @see watchdog_severity_levels()
 */
define('WATCHDOG_DEBUG', 7);
128

129 130 131
/**
 * First bootstrap phase: initialize configuration.
 */
132
define('DRUPAL_BOOTSTRAP_CONFIGURATION', 0);
133 134

/**
135
 * Second bootstrap phase: try to serve a cached page.
136
 */
137
define('DRUPAL_BOOTSTRAP_PAGE_CACHE', 1);
138 139 140 141

/**
 * Third bootstrap phase: initialize database layer.
 */
142
define('DRUPAL_BOOTSTRAP_DATABASE', 2);
143 144

/**
145
 * Fourth bootstrap phase: initialize the variable system.
146
 */
147
define('DRUPAL_BOOTSTRAP_VARIABLES', 3);
148 149

/**
150
 * Fifth bootstrap phase: initialize session handling.
151
 */
152
define('DRUPAL_BOOTSTRAP_SESSION', 4);
153 154

/**
155
 * Sixth bootstrap phase: set up the page header.
156
 */
157
define('DRUPAL_BOOTSTRAP_PAGE_HEADER', 5);
158 159

/**
160
 * Seventh bootstrap phase: find out language of the page.
161
 */
162
define('DRUPAL_BOOTSTRAP_LANGUAGE', 6);
163 164 165 166 167

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

170 171 172
/**
 * Role ID for anonymous users; should match what's in the "role" table.
 */
173
define('DRUPAL_ANONYMOUS_RID', 1);
174 175 176 177

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

180
/**
181
 * The number of bytes in a kilobyte. For more information, visit
182 183 184 185
 * http://en.wikipedia.org/wiki/Kilobyte.
 */
define('DRUPAL_KILOBYTE', 1024);

186 187 188
/**
 * The language code used when no language is explicitly assigned.
 *
189
 * Defined by ISO639-2 for "Undetermined".
190
 */
191
define('LANGUAGE_NONE', 'und');
192

193
/**
194
 * The type of language used to define the content language.
195
 */
196
define('LANGUAGE_TYPE_CONTENT', 'language_content');
197 198

/**
199
 * The type of language used to select the user interface.
200
 */
201
define('LANGUAGE_TYPE_INTERFACE', 'language');
202 203

/**
204
 * The type of language used for URLs.
205
 */
206
define('LANGUAGE_TYPE_URL', 'language_url');
207

208 209 210 211 212 213 214 215 216 217
/**
 * Language written left to right. Possible value of $language->direction.
 */
define('LANGUAGE_LTR', 0);

/**
 * Language written right to left. Possible value of $language->direction.
 */
define('LANGUAGE_RTL', 1);

218 219 220
/**
 * For convenience, define a short form of the request time global.
 */
221
define('REQUEST_TIME', $_SERVER['REQUEST_TIME']);
222

223 224 225 226 227 228 229 230 231 232
/**
 * Flag for drupal_set_title(); text is not sanitized, so run check_plain().
 */
define('CHECK_PLAIN', 0);

/**
 * Flag for drupal_set_title(); text has already been sanitized.
 */
define('PASS_THROUGH', -1);

233
/**
234
 * Signals that the registry lookup cache should be reset.
235 236 237 238
 */
define('REGISTRY_RESET_LOOKUP_CACHE', 1);

/**
239
 * Signals that the registry lookup cache should be written to storage.
240 241 242
 */
define('REGISTRY_WRITE_LOOKUP_CACHE', 2);

243 244 245 246 247 248 249
/**
 * Regular expression to match PHP function names.
 *
 * @see http://php.net/manual/en/language.functions.php
 */
define('DRUPAL_PHP_FUNCTION_PATTERN', '[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*');

Dries's avatar
 
Dries committed
250
/**
251 252
 * Start the timer with the specified name. If you start and stop the same
 * timer multiple times, the measured intervals will be accumulated.
Dries's avatar
 
Dries committed
253 254 255 256 257 258 259
 *
 * @param name
 *   The name of the timer.
 */
function timer_start($name) {
  global $timers;

260
  $timers[$name]['start'] = microtime(TRUE);
261
  $timers[$name]['count'] = isset($timers[$name]['count']) ? ++$timers[$name]['count'] : 1;
Dries's avatar
 
Dries committed
262 263 264 265 266 267 268 269 270 271 272 273 274
}

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

275
  if (isset($timers[$name]['start'])) {
276
    $stop = microtime(TRUE);
277
    $diff = round(($stop - $timers[$name]['start']) * 1000, 2);
Dries's avatar
 
Dries committed
278

279 280 281 282
    if (isset($timers[$name]['time'])) {
      $diff += $timers[$name]['time'];
    }
    return $diff;
283
  }
284
  return $timers[$name]['time'];
Dries's avatar
 
Dries committed
285 286 287 288 289 290 291 292
}

/**
 * Stop the timer with the specified name.
 *
 * @param name
 *   The name of the timer.
 * @return
293 294
 *   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).
Dries's avatar
 
Dries committed
295 296 297 298
 */
function timer_stop($name) {
  global $timers;

299 300 301 302 303 304 305 306 307 308
  if (isset($timers[$name]['start'])) {
    $stop = microtime(TRUE);
    $diff = round(($stop - $timers[$name]['start']) * 1000, 2);
    if (isset($timers[$name]['time'])) {
      $timers[$name]['time'] += $diff;
    }
    else {
      $timers[$name]['time'] = $diff;
    }
    unset($timers[$name]['start']);
309
  }
Dries's avatar
 
Dries committed
310 311 312

  return $timers[$name];
}
313

Dries's avatar
 
Dries committed
314
/**
315
 * Find the appropriate configuration directory.
Dries's avatar
 
Dries committed
316
 *
317 318
 * Try finding a matching configuration directory by stripping the website's
 * hostname from left to right and pathname from right to left. The first
319
 * configuration file found will be used; the remaining will ignored. If no
320
 * configuration file is found, return a default value '$confdir/default'.
Dries's avatar
Dries committed
321
 *
322
 * Example for a fictitious site installed at
323 324
 * http://www.drupal.org:8080/mysite/test/ the 'settings.php' is searched in
 * the following directories:
Dries's avatar
 
Dries committed
325
 *
326 327 328 329
 *  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
330
 *
331 332 333 334
 *  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
335
 *
336 337 338 339
 *  9. $confdir/8080.www.drupal.org
 * 10. $confdir/www.drupal.org
 * 11. $confdir/drupal.org
 * 12. $confdir/org
Dries's avatar
 
Dries committed
340
 *
341
 * 13. $confdir/default
342
 *
343
 * If a file named sites.php is present in the $confdir, it will be loaded
344 345
 * prior to scanning for directories. It should define an associative array
 * named $sites, which maps domains to directories. It should be in the form
346 347 348 349 350 351 352 353 354 355
 * of:
 *
 * $sites = array(
 *   'The url to alias' => 'A directory within the sites directory'
 * );
 *
 * For example:
 *
 * $sites = array(
 *   'devexample.com' => 'example.com',
356
 *   'localhost.example' => 'example.com',
357 358 359 360 361 362
 * );
 *
 * The above array will cause Drupal to look for a directory named
 * "example.com" in the sites directory whenever a request comes from
 * "example.com", "devexample.com", or "localhost/example". That is useful
 * on development servers, where the domain name may not be the same as the
363
 * domain of the live server. Since Drupal stores file paths into the database
364 365 366
 * (files, system table, etc.) this will ensure the paths are correct while
 * accessed on development servers.
 *
367 368 369 370 371 372 373 374 375 376
 * @param $require_settings
 *   Only configuration directories with an existing settings.php file
 *   will be recognized. Defaults to TRUE. During initial installation,
 *   this is set to FALSE so that Drupal can detect a matching directory,
 *   then create a new settings.php file in it.
 * @param reset
 *   Force a full search for matching directories even if one had been
 *   found previously.
 * @return
 *   The path of the matching directory.
Dries's avatar
 
Dries committed
377
 */
378
function conf_path($require_settings = TRUE, $reset = FALSE) {
379
  $conf = &drupal_static(__FUNCTION__, '');
Dries's avatar
 
Dries committed
380

381
  if ($conf && !$reset) {
Dries's avatar
Dries committed
382 383
    return $conf;
  }
Dries's avatar
 
Dries committed
384

Dries's avatar
 
Dries committed
385
  $confdir = 'sites';
386 387 388 389 390 391 392

  $sites = array();
  if (file_exists(DRUPAL_ROOT . '/' . $confdir . '/sites.php')) {
    // This will overwrite $sites with the desired mappings.
    include(DRUPAL_ROOT . '/' . $confdir . '/sites.php');
  }

393
  $uri = explode('/', $_SERVER['SCRIPT_NAME'] ? $_SERVER['SCRIPT_NAME'] : $_SERVER['SCRIPT_FILENAME']);
394
  $server = explode('.', implode('.', array_reverse(explode(':', rtrim($_SERVER['HTTP_HOST'], '.')))));
Dries's avatar
Dries committed
395 396 397
  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));
398 399 400 401
      if (isset($sites[$dir]) && file_exists(DRUPAL_ROOT . '/' . $confdir . '/' . $sites[$dir])) {
        $dir = $sites[$dir];
      }
      if (file_exists(DRUPAL_ROOT . '/' . $confdir . '/' . $dir . '/settings.php') || (!$require_settings && file_exists(DRUPAL_ROOT . '/' . $confdir . '/' . $dir))) {
Dries's avatar
Dries committed
402 403 404
        $conf = "$confdir/$dir";
        return $conf;
      }
Dries's avatar
 
Dries committed
405 406
    }
  }
Dries's avatar
Dries committed
407 408
  $conf = "$confdir/default";
  return $conf;
Dries's avatar
 
Dries committed
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
/**
 * Set appropriate server variables needed for command line scripts to work.
 *
 * This function can be called by command line scripts before bootstrapping
 * Drupal, to ensure that the page loads with the desired server parameters.
 * This is because many parts of Drupal assume that they are running in a web
 * browser and therefore use information from the global PHP $_SERVER variable
 * that does not get set when Drupal is run from the command line.
 *
 * In many cases, the default way in which this function populates the $_SERVER
 * variable is sufficient, and it can therefore be called without passing in
 * any input. However, command line scripts running on a multisite installation
 * (or on any installation that has settings.php stored somewhere other than
 * the sites/default folder) need to pass in the URL of the site to allow
 * Drupal to detect the correct location of the settings.php file. Passing in
 * the 'url' parameter is also required for functions like request_uri() to
 * return the expected values.
 *
 * Most other parameters do not need to be passed in, but may be necessary in
 * some cases; for example, if Drupal's ip_address() function needs to return
 * anything but the standard localhost value ('127.0.0.1'), the command line
 * script should pass in the desired value via the 'REMOTE_ADDR' key.
 *
 * @param $variables
 *   (optional) An associative array of variables within $_SERVER that should
 *   be replaced. If the special element 'url' is provided in this array, it
 *   will be used to populate some of the server defaults; it should be set to
 *   the URL of the current page request, excluding any $_GET request but
 *   including the script name (e.g., http://www.example.com/mysite/index.php).
 *
 * @see conf_path()
 * @see request_uri()
 * @see ip_address()
 */
function drupal_override_server_variables($variables = array()) {
446
  // Allow the provided URL to override any existing values in $_SERVER.
447 448
  if (isset($variables['url'])) {
    $url = parse_url($variables['url']);
449 450 451 452 453 454
    if (isset($url['host'])) {
      $_SERVER['HTTP_HOST'] = $url['host'];
    }
    if (isset($url['path'])) {
      $_SERVER['SCRIPT_NAME'] = $url['path'];
    }
455 456
    unset($variables['url']);
  }
457 458 459
  // Define default values for $_SERVER keys. These will be used if $_SERVER
  // does not already define them and no other values are passed in to this
  // function.
460
  $defaults = array(
461 462
    'HTTP_HOST' => 'localhost',
    'SCRIPT_NAME' => NULL,
463 464 465
    'REMOTE_ADDR' => '127.0.0.1',
    'REQUEST_METHOD' => 'GET',
    'SERVER_NAME' => NULL,
466
    'SERVER_SOFTWARE' => NULL,
467 468 469 470 471 472
    'HTTP_USER_AGENT' => NULL,
  );
  // Replace elements of the $_SERVER array, as appropriate.
  $_SERVER = $variables + $_SERVER + $defaults;
}

473
/**
474
 * Initialize PHP environment.
475
 */
476
function drupal_environment_initialize() {
477 478
  if (!isset($_SERVER['HTTP_REFERER'])) {
    $_SERVER['HTTP_REFERER'] = '';
479
  }
480 481 482
  if (!isset($_SERVER['SERVER_PROTOCOL']) || ($_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.0' && $_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.1')) {
    $_SERVER['SERVER_PROTOCOL'] = 'HTTP/1.0';
  }
483

484 485 486 487 488 489 490 491 492 493 494 495 496 497 498
  if (isset($_SERVER['HTTP_HOST'])) {
    // As HTTP_HOST is user input, ensure it only contains characters allowed
    // in hostnames. See RFC 952 (and RFC 2181).
    // $_SERVER['HTTP_HOST'] is lowercased here per specifications.
    $_SERVER['HTTP_HOST'] = strtolower($_SERVER['HTTP_HOST']);
    if (!drupal_valid_http_host($_SERVER['HTTP_HOST'])) {
      // HTTP_HOST is invalid, e.g. if containing slashes it may be an attack.
      header($_SERVER['SERVER_PROTOCOL'] . ' 400 Bad Request');
      exit;
    }
  }
  else {
    // Some pre-HTTP/1.1 clients will not send a Host header. Ensure the key is
    // defined for E_ALL compliance.
    $_SERVER['HTTP_HOST'] = '';
499 500
  }

501 502 503 504 505 506 507
  // When clean URLs are enabled, emulate ?q=foo/bar using REQUEST_URI. It is
  // not possible to append the query string using mod_rewrite without the B
  // flag (this was added in Apache 2.2.8), because mod_rewrite unescapes the
  // path before passing it on to PHP. This is a problem when the path contains
  // e.g. "&" or "%" that have special meanings in URLs and must be encoded.
  $_GET['q'] = request_path();

508 509
  // Enforce E_ALL, but allow users to set levels not part of E_ALL.
  error_reporting(E_ALL | error_reporting());
510

511 512 513
  // Override PHP settings required for Drupal to work properly.
  // sites/default/default.settings.php contains more runtime settings.
  // The .htaccess file contains settings that cannot be changed at runtime.
514

515
  // Don't escape quotes when reading files from the database, disk, etc.
516
  ini_set('magic_quotes_runtime', '0');
517 518
  // Use session cookies, not transparent sessions that puts the session id in
  // the query string.
519
  ini_set('session.use_cookies', '1');
520
  ini_set('session.use_only_cookies', '1');
521
  ini_set('session.use_trans_sid', '0');
522 523
  // Don't send HTTP headers using PHP's session handler.
  ini_set('session.cache_limiter', 'none');
524 525
  // Use httponly session cookies.
  ini_set('session.cookie_httponly', '1');
526 527 528 529

  // Set sane locale settings, to ensure consistent string, dates, times and
  // numbers handling.
  setlocale(LC_ALL, 'C');
530 531
}

532
/**
533
 * Validate that a hostname (for example $_SERVER['HTTP_HOST']) is safe.
534 535 536 537
 *
 * @return
 *  TRUE if only containing valid characters, or FALSE otherwise.
 */
538 539
function drupal_valid_http_host($host) {
  return preg_match('/^\[?(?:[a-zA-Z0-9-:\]_]+\.?)+$/', $host);
540 541
}

542
/**
543 544
 * Loads the configuration and sets the base URL, cookie domain, and
 * session name correctly.
545
 */
546
function drupal_settings_initialize() {
547 548
  global $base_url, $base_path, $base_root;

Dries's avatar
Dries committed
549
  // Export the following settings.php variables to the global namespace
550
  global $databases, $cookie_domain, $conf, $installed_profile, $update_free_access, $db_url, $db_prefix, $drupal_hash_salt, $is_https, $base_secure_url, $base_insecure_url;
Dries's avatar
Dries committed
551 552
  $conf = array();

553 554
  if (file_exists(DRUPAL_ROOT . '/' . conf_path() . '/settings.php')) {
    include_once DRUPAL_ROOT . '/' . conf_path() . '/settings.php';
555
  }
556
  $is_https = isset($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) == 'on';
557 558 559 560

  if (isset($base_url)) {
    // Parse fixed base URL from settings.php.
    $parts = parse_url($base_url);
561
    $http_protocol = $parts['scheme'];
562 563 564
    if (!isset($parts['path'])) {
      $parts['path'] = '';
    }
565
    $base_path = $parts['path'] . '/';
566 567 568 569 570
    // 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
571
    $http_protocol = $is_https ? 'https' : 'http';
572
    $base_root = $http_protocol . '://' . $_SERVER['HTTP_HOST'];
573

574
    $base_url = $base_root;
575 576 577

    // $_SERVER['SCRIPT_NAME'] can, in contrast to $_SERVER['PHP_SELF'], not
    // be modified by a visitor.
578 579
    if ($dir = rtrim(dirname($_SERVER['SCRIPT_NAME']), '\/')) {
      $base_path = $dir;
580 581 582 583 584 585 586
      $base_url .= $base_path;
      $base_path .= '/';
    }
    else {
      $base_path = '/';
    }
  }
587 588
  $base_secure_url = str_replace('http://', 'https://', $base_url);
  $base_insecure_url = str_replace('https://', 'http://', $base_url);
589 590 591 592 593 594

  if ($cookie_domain) {
    // If the user specifies the cookie domain, also use it for session name.
    $session_name = $cookie_domain;
  }
  else {
595 596 597
    // Otherwise use $base_url as session name, without the protocol
    // to use the same session identifiers across http and https.
    list( , $session_name) = explode('://', $base_url, 2);
598 599
    // HTTP_HOST can be modified by a visitor, but we already sanitized it
    // in drupal_settings_initialize().
600
    if (!empty($_SERVER['HTTP_HOST'])) {
601
      $cookie_domain = $_SERVER['HTTP_HOST'];
602 603 604 605 606 607 608
      // Strip leading periods, www., and port numbers from cookie domain.
      $cookie_domain = ltrim($cookie_domain, '.');
      if (strpos($cookie_domain, 'www.') === 0) {
        $cookie_domain = substr($cookie_domain, 4);
      }
      $cookie_domain = explode(':', $cookie_domain);
      $cookie_domain = '.' . $cookie_domain[0];
609 610 611 612 613 614 615
    }
  }
  // Per RFC 2109, cookie domains must contain at least one dot other than the
  // first. For hosts such as 'localhost' or IP Addresses we don't set a cookie domain.
  if (count(explode('.', $cookie_domain)) > 2 && !is_numeric(str_replace('.', '', $cookie_domain))) {
    ini_set('session.cookie_domain', $cookie_domain);
  }
616 617 618 619 620 621 622 623 624 625
  // To prevent session cookies from being hijacked, a user can configure the
  // SSL version of their website to only transfer session cookies via SSL by
  // using PHP's session.cookie_secure setting. The browser will then use two
  // separate session cookies for the HTTPS and HTTP versions of the site. So we
  // must use different session identifiers for HTTPS and HTTP to prevent a
  // cookie collision.
  if ($is_https) {
    ini_set('session.cookie_secure', TRUE);
  }
  $prefix = ini_get('session.cookie_secure') ? 'SSESS' : 'SESS';
626
  session_name($prefix . substr(hash('sha256', $session_name), 0, 32));
627 628
}

Dries's avatar
Dries committed
629 630
/**
 * Returns and optionally sets the filename for a system item (module,
631
 * theme, etc.). The filename, whether provided, cached, or retrieved
Dries's avatar
Dries committed
632 633
 * from the database, is only returned if the file exists.
 *
Dries's avatar
Dries committed
634 635 636 637 638 639 640 641 642 643 644 645
 * This function plays a key role in allowing Drupal's resources (modules
 * and themes) to be located in different places depending on a site's
 * configuration. For example, a module 'foo' may legally be be located
 * in any of these three places:
 *
 * modules/foo/foo.module
 * sites/all/modules/foo/foo.module
 * sites/example.com/modules/foo/foo.module
 *
 * Calling drupal_get_filename('module', 'foo') will give you one of
 * the above, depending on where the module is located.
 *
Dries's avatar
Dries committed
646
 * @param $type
647
 *   The type of the item (i.e. theme, theme_engine, module, profile).
Dries's avatar
Dries committed
648 649 650 651 652 653 654 655 656
 * @param $name
 *   The name of the item for which the filename is requested.
 * @param $filename
 *   The filename of the item if it is to be set explicitly rather
 *   than by consulting the database.
 *
 * @return
 *   The filename of the requested item.
 */
Dries's avatar
Dries committed
657
function drupal_get_filename($type, $name, $filename = NULL) {
658 659 660
  // The location of files will not change during the request, so do not use
  // drupal_static().
  static $files = array();
Dries's avatar
Dries committed
661

662
  if (!isset($files[$type])) {
Dries's avatar
Dries committed
663 664 665
    $files[$type] = array();
  }

666
  if (!empty($filename) && file_exists($filename)) {
Dries's avatar
Dries committed
667 668
    $files[$type][$name] = $filename;
  }
669
  elseif (isset($files[$type][$name])) {
Dries's avatar
Dries committed
670 671
    // nothing
  }
Dries's avatar
Dries committed
672
  // Verify that we have an active database connection, before querying
673
  // the database. This is required because this function is called both
Dries's avatar
Dries committed
674 675
  // before we have a database connection (i.e. during installation) and
  // when a database connection fails.
Dries's avatar
Dries committed
676
  else {
677
    try {
678 679
      if (function_exists('db_query')) {
        $file = db_query("SELECT filename FROM {system} WHERE name = :name AND type = :type", array(':name' => $name, ':type' => $type))->fetchField();
680
        if (file_exists(DRUPAL_ROOT . '/' . $file)) {
681 682
          $files[$type][$name] = $file;
        }
683 684
      }
    }
685
    catch (Exception $e) {
686 687 688 689 690 691 692 693 694 695 696
      // The database table may not exist because Drupal is not yet installed,
      // or the database might be down. We have a fallback for this case so we
      // hide the error completely.
    }
    // Fallback to searching the filesystem if the database could not find the
    // file or the file returned by the database is not found.
    if (!isset($files[$type][$name])) {
      // We have a consistent directory naming: modules, themes...
      $dir = $type . 's';
      if ($type == 'theme_engine') {
        $dir = 'themes/engines';
697
        $extension = 'engine';
698 699
      }
      elseif ($type == 'theme') {
700
        $extension = 'info';
701 702
      }
      else {
703
        $extension = $type;
704 705
      }

706 707 708
      if (!function_exists('drupal_system_listing')) {
        require_once DRUPAL_ROOT . '/includes/common.inc';
      }
709 710 711 712
      // Scan the appropriate directories for all files with the requested
      // extension, not just the file we are currently looking for. This
      // prevents unnecessary scans from being repeated when this function is
      // called more than once in the same page request.
713
      $matches = drupal_system_listing("/^" . DRUPAL_PHP_FUNCTION_PATTERN . "\.$extension$/", $dir, 'name', 0);
714 715
      foreach ($matches as $matched_name => $file) {
        $files[$type][$matched_name] = $file->uri;
Dries's avatar
Dries committed
716 717 718 719
      }
    }
  }

720 721 722
  if (isset($files[$type][$name])) {
    return $files[$type][$name];
  }
Dries's avatar
Dries committed
723 724
}

Dries's avatar
 
Dries committed
725 726 727 728 729 730 731
/**
 * 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.
 */
732
function variable_initialize($conf = array()) {
733 734
  // NOTE: caching the variables improves performance by 20% when serving
  // cached pages.
735
  if ($cached = cache_get('variables', 'cache_bootstrap')) {
736
    $variables = $cached->data;
Dries's avatar
 
Dries committed
737 738
  }
  else {
739 740 741 742 743 744 745 746 747 748 749 750 751 752
    // Cache miss. Avoid a stampede.
    $name = 'variable_init';
    if (!lock_acquire($name, 1)) {
      // Another request is building the variable cache.
      // Wait, then re-run this function.
      lock_wait($name);
      return variable_initialize($conf);
    }
    else {
      // Proceed with variable rebuild.
      $variables = array_map('unserialize', db_query('SELECT name, value FROM {variable}')->fetchAllKeyed());
      cache_set('variables', $variables, 'cache_bootstrap');
      lock_release($name);
    }
Dries's avatar
 
Dries committed
753 754 755 756
  }

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

Dries's avatar
 
Dries committed
759
  return $variables;
Dries's avatar
 
Dries committed
760 761
}

Dries's avatar
 
Dries committed
762
/**
763 764 765 766 767
 * Returns a persistent variable.
 *
 * Case-sensitivity of the variable_* functions depends on the database
 * collation used. To avoid problems, always use lower case for persistent
 * variable names.
Dries's avatar
 
Dries committed
768 769 770 771 772
 *
 * @param $name
 *   The name of the variable to return.
 * @param $default
 *   The default value to use if this variable has never been set.
773
 *
Dries's avatar
 
Dries committed
774 775
 * @return
 *   The value of the variable.
776
 *
777 778
 * @see variable_del()
 * @see variable_set()
Dries's avatar
 
Dries committed
779
 */
780
function variable_get($name, $default = NULL) {
Dries's avatar
 
Dries committed
781 782 783 784 785
  global $conf;

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

Dries's avatar
 
Dries committed
786
/**
787 788 789 790 791
 * Sets a persistent variable.
 *
 * Case-sensitivity of the variable_* functions depends on the database
 * collation used. To avoid problems, always use lower case for persistent
 * variable names.
Dries's avatar
 
Dries committed
792 793 794 795 796 797
 *
 * @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.
798
 *
799 800
 * @see variable_del()
 * @see variable_get()
Dries's avatar
 
Dries committed
801
 */
Dries's avatar
 
Dries committed
802 803 804
function variable_set($name, $value) {
  global $conf;

805
  db_merge('variable')->key(array('name' => $name))->fields(array('value' => serialize($value)))->execute();
Dries's avatar
 
Dries committed
806

807
  cache_clear_all('variables', 'cache_bootstrap');
Dries's avatar
 
Dries committed
808 809 810 811

  $conf[$name] = $value;
}

Dries's avatar
 
Dries committed
812
/**
813 814 815 816 817
 * Unsets a persistent variable.
 *
 * Case-sensitivity of the variable_* functions depends on the database
 * collation used. To avoid problems, always use lower case for persistent
 * variable names.
Dries's avatar
 
Dries committed
818 819 820
 *
 * @param $name
 *   The name of the variable to undefine.
821
 *
822 823
 * @see variable_get()
 * @see variable_set()
Dries's avatar
 
Dries committed
824
 */
Dries's avatar
 
Dries committed
825
function variable_del($name) {
Dries's avatar
Dries committed
826 827
  global $conf;

828 829 830
  db_delete('variable')
    ->condition('name', $name)
    ->execute();
831
  cache_clear_all('variables', 'cache_bootstrap');
Dries's avatar
 
Dries committed
832

Dries's avatar
Dries committed
833
  unset($conf[$name]);
Dries's avatar
 
Dries committed
834 835
}

Dries's avatar
 
Dries committed
836 837 838
/**
 * Retrieve the current page from the cache.
 *
839 840 841 842 843
 * Note: we do not serve cached pages to authenticated users, or to anonymous
 * users when $_SESSION is non-empty. $_SESSION may contain status messages
 * from a form submission, the contents of a shopping cart, or other user-
 * specific content that should not be cached and displayed to other users.
 *
844 845 846 847
 * @param $check_only
 *   (optional) Set to TRUE to only return whether a previous call found a
 *   cache entry.
 *
848
 * @return
849
 *   The cache object, if the page was found in the cache, NULL otherwise.
Dries's avatar
 
Dries committed
850
 */
851
function drupal_page_get_cache($check_only = FALSE) {
852
  global $base_root;
853 854 855 856 857
  static $cache_hit = FALSE;

  if ($check_only) {
    return $cache_hit;
  }
Dries's avatar
 
Dries committed
858

859
  if (drupal_page_is_cacheable()) {
860 861 862 863 864
    $cache = cache_get($base_root . request_uri(), 'cache_page');
    if ($cache !== FALSE) {
      $cache_hit = TRUE;
    }
    return $cache;
865
  }
866 867 868 869 870 871
}

/**
 * Determine the cacheability of the current page.
 *
 * @param $allow_caching
872 873
 *   Set to FALSE if you want to prevent this page to get cached.
 *
874
 * @return
875
 *   TRUE if the current page can be cached, FALSE otherwise.
876 877 878 879 880
 */
function drupal_page_is_cacheable($allow_caching = NULL) {
  $allow_caching_static = &drupal_static(__FUNCTION__, TRUE);
  if (isset($allow_caching)) {
    $allow_caching_static = $allow_caching;
Dries's avatar
 
Dries committed
881
  }
882 883

  return $allow_caching_static && ($_SERVER['REQUEST_METHOD'] == 'GET' || $_SERVER['REQUEST_METHOD'] == 'HEAD')
884
    && !drupal_is_cli();
Dries's avatar
 
Dries committed
885 886
}

887
/**
888
 * Invoke a bootstrap hook in all bootstrap modules that implement it.
889 890
 *
 * @param $hook
891
 *   The name of the bootstrap hook to invoke.
892 893
 *
 * @see bootstrap_hooks()
894 895
 */
function bootstrap_invoke_all($hook) {
896
  // Bootstrap modules should have been loaded when this function is called, so
897 898 899 900 901 902
  // we don't need to tell module_list() to reset its internal list (and we
  // therefore leave the first parameter at its default value of FALSE). We
  // still pass in TRUE for the second parameter, though; in case this is the
  // first time during the bootstrap that module_list() is called, we want to
  // make sure that its internal cache is primed with the bootstrap modules
  // only.
903
  foreach (module_list(FALSE, TRUE) as $module) {
904 905 906 907 908
    drupal_load('module', $module);
    module_invoke($module, $hook);
  }
}

Dries's avatar
Dries committed
909
/**
910
 * Includes a file with the provided type and name. This prevents
Dries's avatar
Dries committed
911 912 913 914 915 916 917 918 919 920 921
 * 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) {
922 923 924
  // Once a file is included this can't be reversed during a request so do not
  // use drupal_static() here.
  static $files = array();
Dries's avatar
Dries committed
925

926
  if (isset($files[$type][$name])) {
Dries's avatar
Dries committed
927 928 929 930 931 932
    return TRUE;
  }

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

  if ($filename) {
933
    include_once DRUPAL_ROOT . '/' . $filename;
Dries's avatar
Dries committed
934 935 936 937 938 939 940 941
    $files[$type][$name] = TRUE;

    return TRUE;
  }

  return FALSE;
}

942 943 944 945 946 947 948
/**
 * Set an HTTP response header for the current page.
 *
 * Note: When sending a Content-Type header, always include a 'charset' type,
 * too. This is necessary to avoid security bugs (e.g. UTF-7 XSS).
 *
 * @param $name
949
 *   The HTTP header name, or the special 'Status' header name.
950
 * @param $value
951 952 953
 *   The HTTP header value; if equal to FALSE, the specified header is unset.
 *   If $name is 'Status', this is expected to be a status code followed by a
 *   reason phrase, e.g. "404 Not Found".
954 955 956
 * @param $append
 *   Whether to append the value to an existing header or to replace it.
 */
957
function drupal_add_http_header($name, $value, $append = FALSE) {
958
  // The headers as name/value pairs.
959
  $headers = &drupal_static('drupal_http_headers', array());
960

961
  $name_lower = strtolower($name);
962
  _drupal_set_preferred_header_name($name);
963

964
  if ($value === FALSE) {
965
    $headers[$name_lower] = FALSE;
966
  }
967
  elseif (isset($headers[$name_lower]) && $append) {
968 969
    // Multiple headers with identical names may be combined using comma (RFC
    // 2616, section 4.2).
970
    $headers[$name_lower] .= ',' . $value;
971 972
  }
  else {
973
    $headers[$name_lower] = $value;
974
  }
975
  drupal_send_headers(array($name => $headers[$name_lower]), TRUE);
976 977 978 979 980 981 982 983 984 985 986 987
}

/**
 * Get the HTTP response headers for the current page.
 *
 * @param $name
 *   An HTTP header name. If omitted, all headers are returned as name/value
 *   pairs. If an array value is FALSE, the header has been unset.
 * @return
 *   A string containing the header value, or FALSE if the header has been set,
 *   or NULL if the header has not been set.
 */
988
function drupal_get_http_header($name = NULL) {
989
  $headers = &drupal_static('drupal_http_headers', array());
990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012
  if (isset($name)) {
    $name = strtolower($name);
    return isset($headers[$name]) ? $headers[$name] : NULL;
  }
  else {
    return $headers;
  }
}

/**
 * Header names are case-insensitive, but for maximum compatibility they should
 * follow "common form" (see RFC 2617, section 4.2).
 */
function _drupal_set_preferred_header_name($name = NULL) {
  static $header_names = array();

  if (!isset($name)) {
    return $header_names;
  }
  $header_names[strtolower($name)] = $name;
}

/**
1013
 * Send the HTTP response headers previously set using drupal_add_http_header().
1014
 * Add default headers, unless they have been replaced or unset using
1015
 * drupal_add_http_header().
1016 1017 1018 1019 1020 1021 1022 1023
 *
 * @param $default_headers
 *   An array of headers as name/value pairs.
 * @param $single
 *   If TRUE and headers have already be sent, send only the specified header.
 */
function drupal_send_headers($default_headers = array(), $only_default = FALSE) {
  $headers_sent = &drupal_static(__FUNCTION__, FALSE);
1024
  $headers = drupal_get_http_header();
1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038
  if ($only_default && $headers_sent) {
    $headers = array();
  }
  $headers_sent = TRUE;

  $header_names = _drupal_set_preferred_header_name();
  foreach ($default_headers as $name => $value) {
    $name_lower = strtolower($name);
    if (!isset($headers[$name_lower])) {
      $headers[$name_lower] = $value;
      $header_names[$name_lower] = $name;
    }
  }
  foreach ($headers as $name_lower => $value) {
1039
    if ($name_lower == 'status') {
1040 1041 1042 1043 1044 1045 1046 1047 1048
      header($_SERVER['SERVER_PROTOCOL'] . ' ' . $value);
    }
    // Skip headers that have been unset.
    elseif ($value) {
      header($header_names[$name_lower] . ': ' . $value);
    }
  }
}

Dries's avatar
 
Dries committed
1049 1050
/**
 * Set HTTP headers in preparation for a page response.
1051
 *
1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072
 * Authenticated users are always given a 'no-cache' header, and will fetch a
 * fresh page on every request. This prevents authenticated users from seeing
 * locally cached pages.
 *
 * Also give each page a unique ETag. This will force clients to include both
 * an If-Modified-Since header and an If-None-Match header when doing
 * conditional requests for the page (required by RFC 2616, section 13.3.4),
 * making the validation more robust. This is a workaround for a bug in Mozilla
 * Firefox that is triggered when Drupal's caching is enabled and the user
 * accesses Drupal via an HTTP proxy (see
 * https://bugzilla.mozilla.org/show_bug.cgi?id=269303): When an authenticated
 * user requests a page, and then logs out and requests the same page again,
 * Firefox may send a conditional request based on the page that was cached
 * locally when the user was logged in. If this page did not have an ETag
 * header, the request only contains an If-Modified-Since header. The date will
 * be recent, because with authenticated users the Last-Modified header always
 * refers to the time of the request. If the user accesses Drupal via a proxy
 * server, and the proxy already has a cached copy of the anonymous page with an
 * older Last-Modified date, the proxy may respond with 304 Not Modified, making
 * the client think that the anonymous and authenticated pageviews are
 * identical.
1073
 *
1074
 * @see drupal_page_set_cache()
Dries's avatar
 
Dries committed
1075
 */
Dries's avatar
 
Dries committed
1076
function drupal_page_header() {
1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089
  $headers_sent = &drupal_static(__FUNCTION__, FALSE);
  if ($headers_sent) {
    return TRUE;
  }
  $headers_sent = TRUE;

  $default_headers = array(
    'Expires' => 'Sun, 19 Nov 1978 05:00:00 GMT',
    'Last-Modified' => gmdate(DATE_RFC1123, REQUEST_TIME),
    'Cache-Control' => 'no-cache, must-revalidate, post-check=0, pre-check=0',
    'ETag' => '"' . REQUEST_TIME . '"',
  );
  drupal_send_headers($default_headers);
1090
}
Dries's avatar
 
Dries committed
1091

1092 1093 1094
/**
 * Set HTTP headers in preparation for a cached page response.
 *
1095 1096
 * The headers allow as much as possible in proxies and browsers without any
 * particular knowledge about the pages. Modules can override these headers
1097
 * using drupal_add_http_header().
1098
 *
1099 1100 1101 1102
 * If the request is conditional (using If-Modified-Since and If-None-Match),
 * and the conditions match those currently in the cache, a 304 Not Modified
 * response is sent.
 */
1103
function drupal_serve_page_from_cache(stdClass $cache) {
1104 1105 1106 1107 1108
  // Negotiate whether to use compression.
  $page_compression = variable_get('page_compression', TRUE) && extension_loaded('zlib');
  $return_compressed = $page_compression && isset($_SERVER['HTTP_ACCEPT_ENCODING']) && strpos($_SERVER['HTTP_ACCEPT_ENCODING'], 'gzip') !== FALSE;

  // Get headers set in hook_boot(). Keys are lower-case.
1109
  $hook_boot_headers = drupal_get_http_header();
1110 1111

  // Headers generated in this function, that may be replaced or unset using
1112
  // drupal_add_http_headers(). Keys are mixed-case.
1113 1114
  $default_headers = array();

1115
  foreach ($cache->data['headers'] as $name => $value) {
1116 1117 1118 1119 1120
    // In the case of a 304 response, certain headers must be sent, and the
    // remaining may not (see RFC 2616, section 10.3.5). Do not override
    // headers set in hook_boot().
    $name_lower = strtolower($name);
    if (in_array($name_lower, array('content-location', 'expires', 'cache-control', 'vary')) && !isset($hook_boot_headers[$name_lower])) {
1121
      drupal_add_http_header($name, $value);
1122
      unset($cache->data['headers'][$name]);
1123 1124 1125 1126 1127
    }
  }

  // If a cache is served from a HTTP proxy without hitting the web server,
  // the boot and exit hooks cannot be fired, so only allow caching in
1128 1129
  // proxies if boot hooks are disabled. If the client send a session cookie,
  // do not bother caching the page in a public proxy, because the cached copy
1130 1131
  // will only be served to that particular user due to Vary: Cookie, unless
  // the Vary header has been replaced or unset in hook_boot() (see below).
1132
  $max_age = !variable_get('page_cache_invoke_hooks', TRUE) && (!isset($_COOKIE[session_name()]) || isset($hook_boot_headers['vary'])) ? variable_get('page_cache_maximum_age', 0) : 0;
1133 1134 1135 1136 1137
  $default_headers['Cache-Control'] = 'public, max-age=' . $max_age;

  // Entity tag should change if the output changes.
  $etag = '"' . $cache->created . '-' . intval($return_compressed) . '"';
  header('Etag: ' . $etag);
1138

1139 1140
  // See if the client has provided the required HTTP headers.
  $if_modified_since = isset($_SERVER['HTTP_IF_MODIFIED_SINCE']) ? strtotime($_SERVER['HTTP_IF_MODIFIED_SINCE']) : FALSE;
1141 1142 1143 1144
  $if_none_match = isset($_SERVER['HTTP_IF_NONE_MATCH']) ? stripslashes($_SERVER['HTTP_IF_NONE_MATCH']) : FALSE;

  if ($if_modified_since && $if_none_match
      && $if_none_match == $etag // etag must match
1145
      && $if_modified_since == $cache->created) {  // if-modified-since must match
1146
    header($_SERVER['SERVER_PROTOCOL'] . ' 304 Not Modified');
1147
    drupal_send_headers($default_headers);
1148
    return;
1149
  }
1150

1151
  // Send the remaining headers.
1152
  foreach ($cache->data['headers'] as $name => $value) {
1153
    drupal_add_http_header($name, $value);
1154
  }
1155

1156
  $default_headers['Last-Modified'] = gmdate(DATE_RFC1123, $cache->created);
1157

1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173
  // HTTP/1.0 proxies does not support the Vary header, so prevent any caching
  // by sending an Expires date in the past. HTTP/1.1 clients ignores the
  // Expires header if a Cache-Control: max-age= directive is specified (see RFC
  // 2616, section 14.9.3).
  $default_headers['Expires'] = 'Sun, 19 Nov 1978 05:00:00 GMT';

  drupal_send_headers($default_headers);

  // Allow HTTP proxies to cache pages for anonymous users without a session
  // cookie. The Vary header is used to indicates the set of request-header
  // fields that fully determines whether a cache is permitted to use the
  // response to reply to a subsequent request for a given URL without
  // revalidation. If a Vary header has been set in hook_boot(), it is assumed
  // that the module knows how to cache the page.
  if (!isset($hook_boot_headers['vary']) && !variable_get('omit_vary_cookie')) {
    header('Vary: Cookie');
Dries's avatar
 
Dries committed
1174
  }
1175

1176 1177 1178 1179
  if ($page_compression) {
    header('Vary: Accept-Encoding', FALSE);
    // If page_compression is enabled, the cache contains gzipped data.
    if ($return_compressed) {
1180 1181
      // $cache->data['body'] is already gzip'ed, so make sure
      // zlib.output_compression does not compress it once more.
1182
      ini_set('zlib.output_compression', '0');
1183 1184 1185 1186 1187
      header('Content-Encoding: gzip');
    }
    else {
      // The client does not support compression, so unzip the data in the
      // cache. Strip the gzip header and run uncompress.
1188
      $cache->data['body'] = gzinflate(substr(substr($cache->data['body'], 10), 0, -8));
1189
    }
1190