boost.module 38.4 KB
Newer Older
1 2 3 4
<?php

/**
 * @file
5 6
 * Caches generated output as a static file to be served directly from the
 * webserver.
7 8
 */

9 10 11
/**
 * Default cacheablily setting.
 */
mikeytown2's avatar
mikeytown2 committed
12
define('BOOST_CACHEABILITY_PAGES', '');
13 14 15 16

/**
 * Default cookie name.
 */
mikeytown2's avatar
mikeytown2 committed
17
define('BOOST_COOKIE', 'DRUPAL_UID');
18

19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
/**
 * Default value for sending out debugging info via a message.
 */
define('BOOST_MESSAGE_DEBUG', FALSE);

/**
 * Default value for the root cache dir.
 */
define('BOOST_ROOT_CACHE_DIR', 'cache');

/**
 * Default value for the normal cache dir.
 */
define('BOOST_NORMAL_DIR', 'normal');

/**
 * Default value for the character replacement of ? in the URL.
 */
define('BOOST_CHAR', '_');

/**
40
 * Default value for ignoring cron cache flush requests.
41
 */
42
define('BOOST_IGNORE_FLUSH', TRUE);
43 44

/**
45
 * Default value for ignoring cron cache flush requests.
46
 */
47
define('BOOST_EXPIRE_CRON', TRUE);
48

49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
/**
 * Default etag settings.
 */
define('BOOST_APACHE_ETAG', 3);

/**
 * Default header setttings.
 */
define('BOOST_APACHE_XHEADER', 1);

/**
 * Default setting for forcing all content to be the charset defined below.
 */
define('BOOST_ADD_DEFAULT_CHARSET', TRUE);

/**
 * Default for content charset.
 */
define('BOOST_CHARSET_TYPE', 'utf-8');


mikeytown2's avatar
mikeytown2 committed
70
/**
71
 * Implements hook_menu().
mikeytown2's avatar
mikeytown2 committed
72 73
 */
function boost_menu() {
74 75
  $items = array();
  $path = drupal_get_path('module', 'boost');
mikeytown2's avatar
mikeytown2 committed
76

77 78
  $items['admin/config/system/boost'] = array(
    'title' => 'Boost',
mikeytown2's avatar
mikeytown2 committed
79 80 81 82
    'description' => 'Configuration for Boost.',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('boost_admin_settings'),
    'access arguments' => array('administer site configuration'),
83
    'type' => MENU_NORMAL_ITEM,
mikeytown2's avatar
mikeytown2 committed
84
    'file' => 'boost.admin.inc',
85
    'file path' => $path,
86
  );
87 88 89 90 91 92
  $items['admin/config/system/boost/default'] = array(
    'title' => 'Boost Settings',
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
  $items['admin/config/system/boost/debug'] = array(
    'title' => 'Debug',
93 94 95 96 97 98
    'description' => 'Debug configuration for Boost.',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('boost_admin_debug_settings'),
    'access arguments' => array('administer site configuration'),
    'type' => MENU_LOCAL_TASK,
    'file' => 'boost.admin.debug.inc',
99
    'file path' => $path,
100
  );
101 102
  $items['admin/config/system/boost/filesystem'] = array(
    'title' => 'File System',
103 104 105 106 107 108
    'description' => 'File system configuration for Boost.',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('boost_admin_filesystem_settings'),
    'access arguments' => array('administer site configuration'),
    'type' => MENU_LOCAL_TASK,
    'file' => 'boost.admin.filesystem.inc',
109
    'file path' => $path,
110
  );
111 112
  $items['admin/config/system/boost/htaccess'] = array(
    'title' => '.htaccess',
113 114 115 116 117 118
    'description' => '.htaccess configuration for Boost.',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('boost_admin_htaccess_settings'),
    'access arguments' => array('administer site configuration'),
    'type' => MENU_LOCAL_TASK,
    'file' => 'boost.admin.htaccess.inc',
119
    'file path' => $path,
120
  );
121 122 123 124 125 126
  $items['admin/config/system/boost/htaccess/default'] = array(
    'title' => '.htaccess Settings',
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
  $items['admin/config/system/boost/htaccess/generator'] = array(
    'title' => '.htaccess Generation',
127 128 129 130 131 132
    'description' => '.htaccess generation for Boost.',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('boost_admin_htaccess_generation'),
    'access arguments' => array('administer site configuration'),
    'type' => MENU_LOCAL_TASK,
    'file' => 'boost.admin.htaccess.inc',
133 134 135 136 137 138 139 140 141 142 143
    'file path' => $path,
  );
  $items['admin/config/system/boost/expiration'] = array(
    'title' => 'Cache Expiration',
    'description' => 'Cache expiration configuration for Boost.',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('boost_admin_expiration_settings'),
    'access arguments' => array('administer site configuration'),
    'type' => MENU_LOCAL_TASK,
    'file' => 'boost.admin.expiration.inc',
    'file path' => $path,
mikeytown2's avatar
mikeytown2 committed
144
  );
145

mikeytown2's avatar
mikeytown2 committed
146 147
  return $items;
}
148

mikeytown2's avatar
mikeytown2 committed
149
/**
150 151 152
 * Implements hook_init().
 *
 * Performs page setup tasks.
mikeytown2's avatar
mikeytown2 committed
153 154
 */
function boost_init() {
155
  global $_boost;
156

mikeytown2's avatar
mikeytown2 committed
157
  $_boost = boost_transform_url();
158
  // Make sure the page is/should be cached according to our current configuration.
mikeytown2's avatar
mikeytown2 committed
159 160
  if (   strpos($_SERVER['SCRIPT_FILENAME'], 'index.php') === FALSE
      || $_SERVER['SERVER_SOFTWARE'] === 'PHP CLI'
161
      || ($_SERVER['REQUEST_METHOD'] != 'GET' && $_SERVER['REQUEST_METHOD'] != 'HEAD')
mikeytown2's avatar
mikeytown2 committed
162
      || isset($_GET['nocache'])
163
      || empty($_boost['menu_item']['status'])
164
      || $_boost['menu_item']['status'] != 200
165 166
      || variable_get('site_offline', 0)
  ) {
mikeytown2's avatar
mikeytown2 committed
167 168
    $_boost['cache_this'] = FALSE;
  }
169 170 171 172 173 174 175 176

  // Give modules a chance to alter the cookie handler callback used.
  // hook_boost_cookie_handler_callback_alter
  $cookie_handler_callback = 'boost_cookie_handler';
  drupal_alter('boost_cookie_handler_callback', $cookie_handler_callback);
  if (function_exists($cookie_handler_callback)) {
    $cookie_handler_callback();
  }
mikeytown2's avatar
mikeytown2 committed
177
}
178

mikeytown2's avatar
mikeytown2 committed
179
/**
180
 * Implements boost_exit().
mikeytown2's avatar
mikeytown2 committed
181
 */
182
function boost_exit($destination = NULL) {
mikeytown2's avatar
mikeytown2 committed
183
  global $_boost;
184
  // Bail out of caching.
mikeytown2's avatar
mikeytown2 committed
185 186 187 188 189 190 191 192 193 194 195 196 197 198
  if (!isset($_boost['cache_this'])) {
    if (!isset($_boost['is_cacheable'])) {
      return;
    }
    elseif (!$_boost['is_cacheable']) {
      return;
    }
  }
  elseif ($_boost['cache_this'] == FALSE) {
    return;
  }
  elseif (!$_boost['is_cacheable']) {
    return;
  }
199 200 201
  elseif ($_boost['menu_item']['status'] != 200) {
    return;
  }
202 203 204 205
  elseif (!drupal_page_is_cacheable()) {
    $_boost['is_cacheable'] = FALSE;
    return;
  }
206

207
  // Get the data to cache.
mikeytown2's avatar
mikeytown2 committed
208
  $data = ob_get_contents();
209

210 211 212 213
  // Get header info.
  $_boost['header_info'] = boost_get_header_info();
  $_boost['matched_header_info'] = boost_match_header_attributes($_boost['header_info']);
  if ($_boost['matched_header_info']['enabled'] === FALSE) {
mikeytown2's avatar
mikeytown2 committed
214 215
    return;
  }
216

217
  // Add note to bottom of content if possible.
218
  if ($_boost['matched_header_info']['comment_start'] && $_boost['matched_header_info']['comment_end']) {
219
    $expire = $_boost['matched_header_info']['lifetime_max'];
mikeytown2's avatar
mikeytown2 committed
220 221
    $cached_at = date('Y-m-d H:i:s', REQUEST_TIME);
    $expires_at = date('Y-m-d H:i:s', REQUEST_TIME + $expire);
222
    $note = "\n" . $_boost['matched_header_info']['comment_start'] . 'Page cached by Boost @ ' . $cached_at . ', expires @ ' . $expires_at . ', lifetime ' . format_interval($expire) . $_boost['matched_header_info']['comment_end'];
mikeytown2's avatar
mikeytown2 committed
223 224
    $data .= $note;
  }
225 226 227 228 229 230

  // Write data to a file.
  if ($_boost['filename']) {
    // Attach extension to filename.
    $_boost['filename'] .= '.' . $_boost['matched_header_info']['extension'];
    // Write to file.
231
    boost_write_file($_boost['filename'], $data);
mikeytown2's avatar
mikeytown2 committed
232 233
  }
}
234 235

/**
236
 * Implements hook_cron(). Performs periodic actions.
237
 */
mikeytown2's avatar
mikeytown2 committed
238
function boost_cron() {
239
  // Remove expired files from the cache.
mikeytown2's avatar
mikeytown2 committed
240
  global $_boost;
241 242 243 244 245 246
  $_boost['cron'] = TRUE;
  if (   isset($_boost['base_dir'])
      && variable_get('boost_expire_cron', BOOST_EXPIRE_CRON)
        ) {
    $count = _boost_rmdir($_boost['base_dir'], FALSE);
    watchdog('boost', 'Expired %count stale files from static page cache.', array('%count' => $count), WATCHDOG_NOTICE);
247 248 249
  }
}

250
/**
251
 * Implements hook_flush_caches(). Deletes all static files.
252
 */
mikeytown2's avatar
mikeytown2 committed
253 254 255
function boost_flush_caches() {
  // Remove all files from the cache
  global $_boost;
256 257 258 259 260
  if (   isset($_boost['base_dir'])
      && (empty($_boost['cron']) || variable_get('boost_ignore_flush', BOOST_IGNORE_FLUSH) == FALSE)
        ) {
    $count = _boost_rmdir($_boost['base_dir'], TRUE);
    watchdog('boost', 'Flushed all files (%count) from static page cache.', array('%count' => $count), WATCHDOG_NOTICE);
mikeytown2's avatar
mikeytown2 committed
261 262
  }
  return;
263 264
}

265
/**
266 267 268 269 270 271 272 273
 * Implements hook_page_delivery_callback_alter().
 */
function boost_page_delivery_callback_alter(&$callback, $set = FALSE) {
  if ($callback == 'drupal_deliver_html_page') {
    $callback = 'boost_deliver_html_page';
  }
}

274
/**
mikeytown2's avatar
mikeytown2 committed
275 276 277 278 279 280
 * Given a URL give back eveything we know
 *
 * @param $url
 *   Full URL
 * @param $b_path
 *   Base Path
281
 */
mikeytown2's avatar
mikeytown2 committed
282 283 284 285
function boost_transform_url($url = NULL, $b_path = NULL) {
  global $base_root, $base_path;
  $items = &drupal_static(__FUNCTION__);

286
  // Set defaults if none passed in.
mikeytown2's avatar
mikeytown2 committed
287 288
  if ($url === NULL) {
    $url = $base_root . request_uri();
289
  }
mikeytown2's avatar
mikeytown2 committed
290 291 292 293 294 295 296 297 298 299 300
  if ($b_path == NULL) {
    $b_path = $base_path;
  }
  $hash = $url . ' ' . $b_path;

  if (!isset($items[$hash])) {
    $parts = boost_parse_url($url, $b_path);
    if (!$parts) {
      $items[$hash] = array('cache_this' => FALSE);
      return $items[$hash];
    }
301 302
    $parts['base_dir'] = boost_get_normal_cache_dir() . '/' . $parts['host'] . $b_path;
    $parts['filename'] = $parts['base_dir'] . $parts['path'] . variable_get('boost_char', BOOST_CHAR) . $parts['query'];
mikeytown2's avatar
mikeytown2 committed
303 304
    $parts['directory'] = dirname($parts['filename']);

305
    // Get the internal path (node/8).
mikeytown2's avatar
mikeytown2 committed
306 307 308 309 310 311
    if (drupal_is_front_page()) {
      $parts['normal_path'] = variable_get('site_frontpage', 'node');
    }
    else {
      $parts['normal_path'] = drupal_get_normal_path($parts['path']);
    }
312
    // Get the alias (content/about-us).
mikeytown2's avatar
mikeytown2 committed
313
    $parts['path_alias'] = drupal_get_path_alias($parts['normal_path']);
314
    // Get all args.
mikeytown2's avatar
mikeytown2 committed
315
    $args = arg(NULL, $parts['normal_path']);
316
    // Prevent array warnings.
mikeytown2's avatar
mikeytown2 committed
317 318 319 320 321
    $args[0] = empty($args[0]) ? '' : $args[0];
    $args[1] = empty($args[1]) ? '' : $args[1];
    $args[2] = empty($args[2]) ? '' : $args[2];
    $parts['args'] = $args;

322
    // Get content type.
323 324 325
    if (!empty($parts['normal_path'])) {
      $parts = _boost_get_menu_router($parts);
    }
326
    // See if url is cacheable.
mikeytown2's avatar
mikeytown2 committed
327 328 329 330 331
    $parts = boost_is_cacheable($parts);
    $items[$hash] = $parts;
  }

  return $items[$hash];
332 333
}

334 335 336 337 338 339 340
/**
 * Returns the relative normal cache dir. cache/normal.
 */
function boost_get_normal_cache_dir() {
  return variable_get('boost_root_cache_dir', BOOST_ROOT_CACHE_DIR) . '/' . variable_get('boost_normal_dir', BOOST_NORMAL_DIR);
}

341
/**
mikeytown2's avatar
mikeytown2 committed
342 343 344 345 346 347
 * parse_url that takes into account the base_path
 *
 * @param $url
 *   Full URL
 * @param $b_path
 *   Base Path
348
 */
mikeytown2's avatar
mikeytown2 committed
349 350
function boost_parse_url($url = NULL, $b_path = NULL) {
  global $base_root, $base_path;
351
  // Set defaults.
mikeytown2's avatar
mikeytown2 committed
352 353 354 355 356 357
  if ($url === NULL) {
    $url = $base_root . request_uri();
  }
  if ($b_path == NULL) {
    $b_path = $base_path;
  }
358

359
  // Parse url.
mikeytown2's avatar
mikeytown2 committed
360 361 362 363 364 365 366
  $parts = parse_url($url);
  if (empty($parts['host']) || empty($parts['path'])) {
    return FALSE;
  }
  if (!isset($parts['query'])) {
    $parts['query'] = '';
  }
367
  $parts['path'] = preg_replace('/^' . preg_quote($b_path, '/') .'/i', '', $parts['path']);
mikeytown2's avatar
mikeytown2 committed
368 369 370 371
  $parts['base_path'] = $b_path;
  $parts['query_array'] = array();
  parse_str($parts['query'], $parts['query_array']);

372
  // Get page number and info from the query string.
mikeytown2's avatar
mikeytown2 committed
373 374 375 376 377 378 379 380 381
  if (!empty($parts['query_array'])) {
    $query = array();
    foreach ($parts['query_array'] as $key => $val) {
      if ($key != 'q' && $key != 'destination' && $key != 'page' && !empty($val)) {
        $query[$key] = $val;
      }
      if ($key == 'page' && is_numeric($val)) {
        $parts['page_number'] = $val;
      }
382
    }
mikeytown2's avatar
mikeytown2 committed
383
    ksort($query);
384
    $parts['query_extra'] = str_replace('&amp;', '&', urldecode(http_build_query($query)));
385 386
  }

387
  // Get fully decoded URL.
388
  $decoded1 = urldecode($parts['base_path'] . $parts['path'] . variable_get('boost_char', BOOST_CHAR) . $parts['query']);
mikeytown2's avatar
mikeytown2 committed
389 390 391 392 393 394 395 396 397
  $decoded2 = urldecode($decoded1);
  while ($decoded1 != $decoded2) {
    $decoded1 = urldecode($decoded2);
    $decoded2 = urldecode($decoded1);
  }
  $decoded = $decoded2;
  unset($decoded2);
  unset($decoded1);

398
  $parts['url_full'] = $parts['host'] . $parts['base_path'] . $parts['path'] . variable_get('boost_char', BOOST_CHAR) . $parts['query'];
mikeytown2's avatar
mikeytown2 committed
399 400 401 402
  $parts['url'] = $url;
  $parts['url_decoded'] = $decoded;
  return $parts;
}
403

mikeytown2's avatar
mikeytown2 committed
404 405 406 407 408 409 410 411 412 413 414
/**
 * Determines whether a given url can be cached or not by boost.
 *
 * TODO: Add in support for the menu_item
 *
 * @param $parts
 *   $parts
 *
 * @return $parts
 */
function boost_is_cacheable($parts) {
415
  // Set local variables.
mikeytown2's avatar
mikeytown2 committed
416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
  $path = $parts['path'];
  $query = $parts['query'];
  $full = $parts['url_full'];
  $normal_path = $parts['normal_path'];
  $alias = $parts['path_alias'];
  $decoded = $parts['url_decoded'];

  // Never cache
  //  the user autocomplete/login/registration/password/reset/logout pages
  //  any admin pages
  //  comment reply pages
  //  node add page
  //  openid login page
  //  URL variables that contain / or \
  //  if incoming URL contains '..' or null bytes
  //  if decoded URL contains :// outside of the host portion of the url
  //  Limit the maximum directory nesting depth of the path
433
  //  Do not cache if destination is set.
mikeytown2's avatar
mikeytown2 committed
434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451
  if (   $normal_path == 'user'
      || preg_match('!^user/(autocomplete|login|register|password|reset|logout)!', $normal_path)
      || preg_match('!^admin!', $normal_path)
      || preg_match('!^comment/reply!', $normal_path)
      || preg_match('!^node/add!', $normal_path)
      || preg_match('!^openid/authenticate!', $normal_path)
      || strpos($query, '/') !== FALSE
      || strpos($query, "\\") !== FALSE
      || strpos($full, '..') !== FALSE
      || strpos($full, "\0") !== FALSE
      || count(explode('/', $path)) > 10
      || strpos($decoded, "://") !== FALSE
      || !empty($query_array['destination'])
    ) {
    $parts['is_cacheable'] = FALSE;
    return $parts;
  }

452
  // Check for reserved characters if on windows.
mikeytown2's avatar
mikeytown2 committed
453 454 455 456 457 458 459
  // http://en.wikipedia.org/wiki/Filename#Reserved_characters_and_words
  // " * : < > |
  $chars = '"*:<>|';
  if (stristr(PHP_OS, 'WIN') && preg_match("/[" . $chars . "]/", $full)) {
    $parts['is_cacheable'] = FALSE;
    return $parts;
  }
460

461
  // Match the user's cacheability settings against the path.
mikeytown2's avatar
mikeytown2 committed
462 463 464 465 466 467 468 469
  // See http://api.drupal.org/api/function/block_block_list_alter/7
  $visibility = variable_get('boost_cacheability_option', BLOCK_VISIBILITY_NOTLISTED);
  $pages_setting = variable_get('boost_cacheability_pages', BOOST_CACHEABILITY_PAGES);
  if ($pages_setting) {
    // Convert path string to lowercase. This allows comparison of the same path
    // with different case. Ex: /Page, /page, /PAGE.
    $pages = drupal_strtolower($pages_setting);
    if ($visibility < BLOCK_VISIBILITY_PHP) {
470
      // Convert the alias to lowercase.
mikeytown2's avatar
mikeytown2 committed
471 472 473 474 475 476 477 478 479 480 481 482 483 484
      $path = drupal_strtolower($alias);
      // Compare the lowercase internal and lowercase path alias (if any).
      $page_match = drupal_match_path($path, $pages);
      if ($path != $normal_path) {
        $page_match = $page_match || drupal_match_path($normal_path, $pages);
      }
      // When 'boost_cacheability_option' has a value of 0 (BLOCK_VISIBILITY_NOTLISTED),
      // Boost will cache all pages except those listed in 'boost_cacheability_pages'.
      // When set to 1 (BLOCK_VISIBILITY_LISTED), Boost will only cache those
      // pages listed in 'boost_cacheability_pages'.
      $page_match = !($visibility xor $page_match);
    }
    elseif (module_exists('php')) {
      $page_match = php_eval($pages_setting);
485
    }
mikeytown2's avatar
mikeytown2 committed
486 487 488 489 490 491 492 493 494 495 496 497
    else {
      $page_match = FALSE;
    }
  }
  else {
    $page_match = TRUE;
  }
  $parts['is_cacheable'] = $page_match;
  if (!$parts['is_cacheable']) {
    return $parts;
  }

498
  // Invoke hook_boost_is_cacheable($path).
mikeytown2's avatar
mikeytown2 committed
499 500 501 502
  $modules = boost_module_implements('boost_is_cacheable', 'boost');
  foreach ($modules as $module) {
    if (($result = module_invoke($module, 'boost_is_cacheable', $parts)) !== NULL) {
      return $result;
503 504 505 506
    }
  }
}

507
/**
508
 * Implements hook_boost_is_cacheable().
509
 *
mikeytown2's avatar
mikeytown2 committed
510
 * TODO support for node types, etc.
511
 *
mikeytown2's avatar
mikeytown2 committed
512 513
 * @param $parts
 *   info about this request
514
 *
mikeytown2's avatar
mikeytown2 committed
515
 * @return $parts
516
 */
mikeytown2's avatar
mikeytown2 committed
517
function boost_boost_is_cacheable($parts) {
518 519 520 521 522 523 524
  global $user;
  if ($user->uid != 0) {
    $parts['is_cacheable'] = FALSE;
  }
  else {
    $parts['is_cacheable'] = TRUE;
  }
mikeytown2's avatar
mikeytown2 committed
525
  return $parts;
526 527
}

528
/**
mikeytown2's avatar
mikeytown2 committed
529 530 531 532 533 534 535
 * Sets a special cookie preventing authenticated users getting served pages
 * from the static page cache.
 *
 * @param $uid
 *   User ID Number
 * @param $expires
 *   Expiration time
536
 */
mikeytown2's avatar
mikeytown2 committed
537 538 539 540 541 542 543 544
function boost_set_cookie($uid, $expires = NULL) {
  if (!$expires) {
    $expires = ini_get('session.cookie_lifetime');
    $expires = (!empty($expires) && is_numeric($expires)) ? REQUEST_TIME + (int)$expires : 0;
    setcookie(BOOST_COOKIE, strval($uid), $expires, ini_get('session.cookie_path'), ini_get('session.cookie_domain'), ini_get('session.cookie_secure') == '1');
  }
  else {
    setcookie(BOOST_COOKIE, '0', $expires, ini_get('session.cookie_path'), ini_get('session.cookie_domain'), ini_get('session.cookie_secure') == '1');
545 546 547
  }
}

548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572
/**
 * Logic for the setting and removal of the boost cookie.
 */
function boost_cookie_handler() {
  global $user;

  // Check if Drupal is started from index.php - could cause problems with other
  // contrib modules like ad module.
  $uid = isset($user->uid) ? $user->uid : 0;
  if (strpos($_SERVER['SCRIPT_FILENAME'], 'index.php') !== FALSE) {
    // Remove Boost cookie at logout if it still exists.
    if (isset($_COOKIE[BOOST_COOKIE]) && $uid == 0) {
      boost_set_cookie($uid, REQUEST_TIME - 86400);
    }
    // Remove Boost cookie if set to -1.
    elseif (isset($_COOKIE[BOOST_COOKIE]) && $_COOKIE[BOOST_COOKIE] == '-1') {
      boost_set_cookie($uid, REQUEST_TIME - 86400);
    }
    // Set Boost cookie if it doesn't exists and user is logged in.
    elseif (!isset($_COOKIE[BOOST_COOKIE]) && $uid != 0) {
      boost_set_cookie($uid);
    }
  }
}

573
/**
574
 * Gets menu router contex.
mikeytown2's avatar
mikeytown2 committed
575
 *
576 577
 * Allows for any content type to have it's own cache expiration among
 * other things.
mikeytown2's avatar
mikeytown2 committed
578 579 580 581 582
 *
 * @param $parts
 *
 * @return $parts
 *
583
 */
mikeytown2's avatar
mikeytown2 committed
584
function _boost_get_menu_router($parts) {
585
  // Declare array keys.
mikeytown2's avatar
mikeytown2 committed
586 587 588
  $router_item = array();
  $router_item['page_type'] = '';
  $router_item['page_id'] = '';
589
  // Load the menu item.
mikeytown2's avatar
mikeytown2 committed
590 591 592
  $item = menu_get_item($parts['normal_path']);
  if (is_array($item)) {
    $router_item += $item;
593 594 595 596 597 598
    if ($router_item['access']) {
      $router_item['status'] = 200;
    }
    else {
      $router_item['status'] = 403;
    }
mikeytown2's avatar
mikeytown2 committed
599
  }
600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618
  else {
    $router_item['status'] = 404;
  }

  // Get any extra arguments.
  if (!empty($router_item['path'])) {
    $menu_args = arg(NULL, $router_item['path']);
    $diff = array();
    foreach ($parts['args'] as $key => $value) {
      if (!empty($value)) {
        if (isset($menu_args[$key])) {
          if ($value !== $menu_args[$key] && $menu_args[$key] !== '%') {
            $diff[] = $value;
          }
        }
        else {
          $diff[] = $value;
        }
      }
mikeytown2's avatar
mikeytown2 committed
619 620 621 622 623 624 625 626 627
    }
  }
  if (!empty($diff)) {
    $router_item['extra_arguments'] = implode('/', $diff);
  }
  else {
    $router_item['extra_arguments'] = '';
  }

628 629
  // Make sure function for menu callback is loaded.
  // See menu_execute_active_handler()
630
  if (!empty($router_item['include_file'])) {
631 632 633
    require_once DRUPAL_ROOT . '/' . $router_item['include_file'];
  }

mikeytown2's avatar
mikeytown2 committed
634
  $parts['menu_item'] = $router_item;
635
  // Invoke hook_boost_menu_router($router_item).
mikeytown2's avatar
mikeytown2 committed
636 637 638
  $modules = boost_module_implements('boost_menu_router', 'boost');
  foreach ($modules as $module) {
    if (($result = module_invoke($module, 'boost_menu_router', $parts)) !== NULL) {
639
      break;
mikeytown2's avatar
mikeytown2 committed
640
    }
641
  }
642 643 644 645 646 647

  // Remove extra data from the load function
  unset($result['menu_item']['map']);
  unset($result['menu_item']['page_arguments']);

  return $result;
648 649 650
}

/**
651
 * Implements hook_boost_menu_router().
mikeytown2's avatar
mikeytown2 committed
652 653 654 655 656 657 658
 *
 * TODO Better support for arguments.
 *
 * @param $parts
 *   info about this request
 *
 * @return $parts
659
 */
mikeytown2's avatar
mikeytown2 committed
660
function boost_boost_menu_router($parts) {
661
  // Handle nodes.
mikeytown2's avatar
mikeytown2 committed
662 663 664 665 666 667 668 669 670
  if ($parts['args'][0] == 'node' && is_numeric($parts['args'][1])) {
    $node = node_load($parts['args'][1]);
    $parts['menu_item']['page_callback'] = 'node';
    $parts['menu_item']['page_id'] = $parts['args'][1];
    if ($node) {
      $parts['menu_item']['page_type'] = $node->type;
    }
    return $parts;
  }
671 672

  // Handle taxonomy.
mikeytown2's avatar
mikeytown2 committed
673 674 675 676 677 678 679 680 681 682
  if ($parts['args'][0] == 'taxonomy' && is_numeric($parts['args'][2])) {
    $term = taxonomy_term_load($parts['args'][2]);
    $parts['menu_item']['page_callback'] = 'taxonomy';
    $parts['menu_item']['page_id'] = $parts['args'][2];
    if ($term) {
      $vocab = taxonomy_vocabulary_load($term->vid);
      $parts['menu_item']['page_type'] = $vocab->name;
    }
    return $parts;
  }
683 684

  // Handle users.
mikeytown2's avatar
mikeytown2 committed
685 686 687 688 689 690 691 692 693
  if ($parts['args'][0] == 'user' && is_numeric($parts['args'][1])) {
    $user = user_load($parts['args'][1]);
    $parts['menu_item']['page_callback'] = 'user';
    $parts['menu_item']['page_id'] = $parts['args'][1];
    if ($user !== FALSE) {
      $parts['menu_item']['page_type'] = implode(', ', $user->roles);
    }
    return $parts;
  }
694 695 696

  // Handle views.
  if (isset($parts['menu_item']['page_callback']) && $parts['menu_item']['page_callback'] == 'views_page') {
mikeytown2's avatar
mikeytown2 committed
697
    $parts['menu_item']['page_callback'] = 'view';
698 699
    $parts['menu_item']['page_type'] = array_shift($parts['menu_item']['page_arguments']);
    $parts['menu_item']['page_id'] = array_shift($parts['menu_item']['page_arguments']);
mikeytown2's avatar
mikeytown2 committed
700 701 702 703 704 705 706
    // See http://drupal.org/node/651798 for the reason why this if is needed
    if (is_array($parts['menu_item']['page_id'])) {
      $parts['menu_item']['page_id'] = array_shift($parts['menu_item']['page_id']);
    }
    return $parts;
  }

707 708
  // Handle panels.
  if (isset($parts['menu_item']['page_callback']) && $parts['menu_item']['page_callback'] == 'page_manager_page_execute') {
mikeytown2's avatar
mikeytown2 committed
709 710 711 712 713 714 715 716 717 718
    $subtask_id = array_shift($parts['menu_item']['page_arguments']);
    $page = page_manager_page_load($subtask_id);
    $task = page_manager_get_task($page->task);
    if ($function = ctools_plugin_get_function($task, 'page callback')) {
      $parts['menu_item']['page_callback'] = $function;
    }
    $parts['menu_item']['page_type'] = $page->task;
    $parts['menu_item']['page_id'] = $page->name;
    return $parts;
  }
719

720 721
  // Try to handle everything else.
  elseif (isset($parts['menu_item']['page_arguments']) && is_array($parts['menu_item']['page_arguments'])) {
mikeytown2's avatar
mikeytown2 committed
722 723 724 725 726 727 728 729
    foreach ($parts['menu_item']['page_arguments'] as $string) {
      if (is_string($string) && empty($parts['menu_item']['page_type'])) {
        $parts['menu_item']['page_type'] = $string;
      }
      elseif (is_string($string)) {
        $parts['menu_item']['page_id'] .= $string;
      }
    }
730
  }
731

mikeytown2's avatar
mikeytown2 committed
732 733 734 735 736 737 738 739
  // If router doesn't hold the the arguments, get them from the URL.
  if (empty($parts['menu_item']['page_type'])) {
    $parts['menu_item']['page_type'] = $parts['menu_item']['extra_arguments'];
  }
  elseif (empty($parts['menu_item']['page_id'])) {
    $parts['menu_item']['page_id'] = $parts['menu_item']['extra_arguments'];
  }

740 741 742
  // Try populating with the query string.
  if (empty($parts['menu_item']['page_type']) && !empty($parts['query_extra'])) {
    $parts['menu_item']['page_type'] = $parts['query_extra'];
mikeytown2's avatar
mikeytown2 committed
743
  }
744 745
  elseif (empty($parts['menu_item']['page_id']) && !empty($parts['query_extra'])) {
    $parts['menu_item']['page_id'] = $parts['query_extra'];
mikeytown2's avatar
mikeytown2 committed
746 747 748
  }

  return $parts;
749 750 751
}

/**
752
 * Alters module_implements to set a hook to fire at the end.
mikeytown2's avatar
mikeytown2 committed
753 754
 *
 * @param $hook
755
 *   Name of hook.
mikeytown2's avatar
mikeytown2 committed
756
 * @param $name
757
 *   Module name to shift to the end of the array.
mikeytown2's avatar
mikeytown2 committed
758 759
 *
 * @return array
760
 */
mikeytown2's avatar
mikeytown2 committed
761 762 763 764 765 766 767 768
function boost_module_implements($hook, $name) {
  $modules = module_implements($hook);
  // Make $names built in hook the last one.
  $pos = array_search($name, $modules);
  if ($pos !== FALSE) {
    $temp = $modules[$pos];
    unset($modules[$pos]);
    $modules[] = $temp;
769
  }
mikeytown2's avatar
mikeytown2 committed
770
  return $modules;
771 772 773
}

/**
mikeytown2's avatar
mikeytown2 committed
774 775 776 777 778
 * Gets and parses the header info.
 *
 * @see drupal_send_headers()
 *
 * @return array
779
 *   Contains info about the page that is about to be sent.
780
 */
mikeytown2's avatar
mikeytown2 committed
781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796
function boost_get_header_info() {
  $headers = drupal_get_http_header();
  $status = '200 OK';
  $status_number = '200';
  $content_type = 'text/html; charset=utf-8';
  $content_type_basic = 'text/html';
  $charset = 'utf-8';

  foreach ($headers as $name_lower => $value) {
    if ($name_lower == 'status') {
      $status = $value;
    }
    elseif ($name_lower == 'content-type') {
      $content_type = $value;
    }
  }
797

mikeytown2's avatar
mikeytown2 committed
798 799 800 801 802 803 804 805
  preg_match('!^(\d+)!', $status, $matches);
  if (isset($matches[1])) {
    $status_number = (int) $matches[1];
  }
  $content_type_info = explode('; charset=', $content_type);
  $content_type_basic = array_shift($content_type_info);
  if (!empty($content_type_info)) {
    $charset = array_shift($content_type_info);
806
  }
mikeytown2's avatar
mikeytown2 committed
807 808 809 810 811 812 813 814 815

  return array(
    'status' => $status,
    'status-number' => $status_number,
    'content-type' => $content_type,
    'content-type-basic' => $content_type_basic,
    'charset' => $charset,
    'headers_sent' => headers_sent(),
  );
816 817 818
}

/**
mikeytown2's avatar
mikeytown2 committed
819 820 821 822 823 824
 * Given header info, match it to a file extension
 *
 * @param $header_info
 *   array contains header info
 *
 * @return array
825
 */
mikeytown2's avatar
mikeytown2 committed
826 827 828 829 830 831 832 833 834 835 836 837 838
function boost_match_header_attributes($header_info) {
  $type = $header_info['content-type-basic'];
  $enabled = variable_get('boost_enabled_' . $type, -1);
  if ($enabled === -1) {
    boost_get_storage_types();
    $enabled = variable_get('boost_enabled_' . $type, -1);
    if ($enabled === -1) {
      variable_set('boost_enabled_' . $type, FALSE);
      $enabled = FALSE;
    }
  }
  if (!$enabled) {
    return array('enabled' => FALSE);
839
  }
mikeytown2's avatar
mikeytown2 committed
840 841 842 843 844 845

  $keys = array(
    'enabled',
    'extension',
    'lifetime_max',
    'lifetime_min',
846 847
    'comment_start',
    'comment_end',
mikeytown2's avatar
mikeytown2 committed
848 849 850 851 852 853 854 855 856
  );
  $info = array();
  foreach ($keys as $key) {
    $info[$key] = variable_get('boost_' . $key . '_' . $type, -1);
    if ($info[$key] === -1) {
      return array('enabled' => FALSE);
    }
  }
  return $info;
857 858 859
}

/**
860
 * Get the storage types for the boost cache.
861
 *
mikeytown2's avatar
mikeytown2 committed
862 863
 * @return $types
 *   array('title' => array('content-type' => $values));
864
 */
mikeytown2's avatar
mikeytown2 committed
865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889
function boost_get_storage_types() {
  $primary_types = array();
  $secondary_types = array();

  // Force boost to be last in the array
  $modules = boost_module_implements('boost_storage_types', 'boost');

  // Module with the lightest weight runs last. They will then be able to change
  // the defaults and modules that are heavier
  $modules = array_reverse($modules);
  foreach ($modules as $module) {
    // Invoke hook_boost_storage_types()
    if (($result = module_invoke($module, 'boost_storage_types')) !== NULL) {
      foreach ($result as $key => $values) {
        if (!empty($values['variants'])) {
          foreach ($values['variants'] as $type) {
            $secondary_types[$type] = $values;
            unset($secondary_types[$type]['variants']);
          }
        }
        unset($values['variants']);
        $primary_types[$key] = $values;
      }
    }
  }
890

mikeytown2's avatar
mikeytown2 committed
891
  // Merge it all back together
892
  $merged = array_merge($primary_types, $secondary_types);
mikeytown2's avatar
mikeytown2 committed
893 894 895 896 897 898 899 900 901 902 903 904 905
  $types = array();
  foreach ($merged as $type => $values) {
    if ($values['title']) {
      $title = $values['title'];
      unset($values['title']);
      $types[$title][$type] = $values;
    }
  }

  // Apply what's saved in the database
  $keys = array(
    'enabled',
    'extension',
906
    'gzip',
mikeytown2's avatar
mikeytown2 committed
907 908
    'lifetime_max',
    'lifetime_min',
909 910
    'comment_start',
    'comment_end',
911

mikeytown2's avatar
mikeytown2 committed
912 913 914 915 916 917 918 919 920 921 922 923 924 925 926
  );
  foreach ($types as $title => $content_types) {
    foreach ($content_types as $type => $values) {
      foreach ($keys as $key) {
        $types[$title][$type][$key] = variable_get('boost_' . $key . '_' . $type, $values[$key]);
        // Set variable in DB if it has never been set before
        if (variable_get('boost_' . $key . '_' . $type, -1) === -1) {
          variable_set('boost_' . $key . '_' . $type, $values[$key]);
        }
      }
    }
  }

  return $types;
}
927 928

/**
929
 * Implements hook_boost_storage_types().
930
 *
mikeytown2's avatar
mikeytown2 committed
931
 * @return $types
932
 */
mikeytown2's avatar
mikeytown2 committed
933 934 935 936 937 938 939 940
function boost_boost_storage_types() {
  $types = array();

  $types['text/html'] = array(
    'title'           => t('HTML'),
    'description'     => t('HTML output, usually a webpage'),
    'extension'       => 'html',
    'enabled'         => TRUE,
941
    'gzip'            => TRUE,
mikeytown2's avatar
mikeytown2 committed
942 943
    'lifetime_max'    => 3600,
    'lifetime_min'    => 0,
944 945
    'comment_start'  => '<!-- ',
    'comment_end'    => ' -->',
mikeytown2's avatar
mikeytown2 committed
946 947 948 949 950 951 952
    'variants'        => array(),
  );
  $types['text/xml'] = array(
    'title'           => t('XML'),
    'description'     => t('XML output, usually a feed'),
    'extension'       => 'xml',
    'enabled'         => FALSE,
953
    'gzip'            => TRUE,
mikeytown2's avatar
mikeytown2 committed
954 955
    'lifetime_max'    => 3600,
    'lifetime_min'    => 0,
956 957
    'comment_start'  => '<!-- ',
    'comment_end'    => ' -->',
mikeytown2's avatar
mikeytown2 committed
958 959 960 961 962 963 964 965 966 967 968
    'variants'        => array(
      'application/xml',
      'application/rss',
      'application/rss+xml',
    ),
  );
  $types['text/javascript'] = array(
    'title'           => t('AJAX/JSON'),
    'description'     => t('JSON output, usually a response to a AJAX request'),
    'extension'       => 'json',
    'enabled'         => FALSE,
969
    'gzip'            => TRUE,
mikeytown2's avatar
mikeytown2 committed
970 971
    'lifetime_max'    => 3600,
    'lifetime_min'    => 0,
972 973
    'comment_start'  => '/* ',
    'comment_end'    => ' */',
mikeytown2's avatar
mikeytown2 committed
974 975 976 977
    'variants'        => array(),
  );
  return $types;
}
978

mikeytown2's avatar
mikeytown2 committed
979 980 981
/**
 * Recursive version of rmdir(); use with extreme caution.
 *
982 983
 * Function also checks file age and only removes expired files.
 *
mikeytown2's avatar
mikeytown2 committed
984
 * @param $dir
985
 *   The top-level directory that will be recursively removed.
986 987
 * @param $flush
 *   Instead of removing expired cached files, remove all files.
mikeytown2's avatar
mikeytown2 committed
988 989 990
 */
function _boost_rmdir($dir, $flush = TRUE) {
  static $lifetimes = array();
991 992 993 994 995 996 997 998 999
  static $counter = 0;
  if (is_dir($dir) == FALSE) {
    return FALSE;
  }

  if (!boost_in_cache_dir($dir)) {
    return FALSE;
  }

mikeytown2's avatar
mikeytown2 committed
1000 1001 1002 1003 1004 1005 1006
  // Map extensions to cache lifetimes
  if (empty($lifetimes)) {
    $types = boost_get_storage_types();
    foreach ($types as $title => $content_types) {
      foreach ($content_types as $type => $values) {
        $lifetimes[$values['extension']] = $values['lifetime_max'];
      }
1007
    }
1008 1009 1010

    // Be sure to recreate the htaccess file just in case.
    boost_form_submit_handler();
1011 1012
  }

1013 1014 1015
  $objects = scandir($dir);
  $empty_dir = TRUE;
  foreach ($objects as $object) {
mikeytown2's avatar
mikeytown2 committed
1016 1017 1018 1019 1020
    if ($object == "." || $object == "..") {
      continue;
    }
    if ($object == ".htaccess") {
      $empty_dir = FALSE;
1021
      continue;
mikeytown2's avatar
mikeytown2 committed
1022
    }
1023 1024 1025 1026

    $file = $dir . "/" . $object;
    if (is_dir($file)) {
      _boost_rmdir($file, $flush);
mikeytown2's avatar
mikeytown2 committed
1027
    }
1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047
    elseif ($flush) {
      unlink($file);
      $counter++;
    }
    else {
      // Need to handle gzipped files.
      // Nice if  it supported multi level cache expiration per content type.
      $ext = substr(strrchr($file, '.'), 1);
      $age = boost_file_get_age($file);
      if (isset($lifetimes[$ext]) && $age > $lifetimes[$ext]) {
        unlink($file);
        $counter++;
      }
      else {
        $empty_dir = FALSE;
      }
    }
  }
  if ($empty_dir) {
    rmdir($dir);
mikeytown2's avatar
mikeytown2 committed
1048
  }
1049
  return $counter;
1050 1051 1052
}

/**
mikeytown2's avatar
mikeytown2 committed
1053 1054
 * Returns the age of a cached file, measured in seconds since it was last
 * updated.
1055
 *
mikeytown2's avatar
mikeytown2 committed
1056 1057 1058
 * @param $filename
 *   Name of cached file
 * @return int
1059
 */
mikeytown2's avatar
mikeytown2 committed
1060 1061
function boost_file_get_age($filename) {
  return REQUEST_TIME - filemtime($filename);
1062
}
1063

1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075
/**
 * Returns a nice html formatted version of print_r
 *
 * @param $data
 *
 * @return string
 */
function boost_print_r($data) {
  return str_replace('    ', '&nbsp;&nbsp;&nbsp;&nbsp;', nl2br(htmlentities(print_r($data, TRUE))));
}

/**
1076
 * Write to a file. Ensures write is atomic via rename operation.
1077 1078 1079 1080 1081 1082
 *
 * @param $filename
 *  relative filename.
 * @param $data
 *  data to write to the file.
 */
1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111
function boost_write_file($filename, &$data) {
  // Create directory if it doesn't exist.
  $directory = dirname($filename);
  if (!boost_mkdir($directory)) {
    return FALSE;
  }

  // Save data to a temp file.
  // file_unmanaged_save_data does not use rename.
  $tempname = drupal_tempnam($directory, 'boost');
  if (file_put_contents($tempname, $data) === FALSE) {
    watchdog('boost', 'Could not create the file %file on your system', array('%file' => $tempname), WATCHDOG_ERROR);
    @unlink($tempname);
    return FALSE;
  }

  // Move temp file to real filename; windows can not do a rename replace.
  if (@rename($tempname, $filename) === FALSE) {
    $oldname = $tempname. 'old';
    if (@rename($filename, $oldname) !== FALSE) {
      if (@rename($tempname, $filename) === FALSE) {
        watchdog('boost', 'Could not rename the file %file on your system', array('%file' => $filename), WATCHDOG_ERROR);
        @unlink($tempname);
        @rename($oldname, $filename);
        return FALSE;
      }
      else {
        @unlink($oldname);
      }
1112 1113
    }
  }
1114 1115 1116

  // chmod file so webserver can send it out.
  drupal_chmod($filename);
1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128
  return TRUE;
}

/**
 * Create a directory.
 *
 * @param $directory
 *  relative directory.
 */
function boost_mkdir($directory) {
  global $_boost;

1129
  // Only do something if it's not a dir.
1130
  if (!is_dir($directory)) {
1131
    if (!boost_in_cache_dir($directory)) {
1132 1133 1134 1135
      return FALSE;
    }

    // Try to create the directory.
1136 1137
    $mode = variable_get('file_chmod_directory', 0775);
    if (!mkdir($directory, $mode, TRUE)) {
1138 1139 1140
      watchdog('boost', 'Could not create the directory %dir on your system', array('%dir' => $directory), WATCHDOG_ERROR);
      return FALSE;
    }
1141
    drupal_chmod($directory);
1142 1143 1144 1145
  }
  return TRUE;
}

1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182
/**
 * Verify that the operation is going to operate in the cache dir.
 *
 * @param $file
 *  relative directory or file.
 */
function boost_in_cache_dir($file) {
  global $_boost;

  $good = TRUE;
  $real_file = realpath($file);
  $cache_dir = variable_get('boost_root_cache_dir', BOOST_ROOT_CACHE_DIR);
  $real_cache_dir = realpath($cache_dir);

  // Only operate in the cache dir.
  // Check the real path.
  if (   strpos($file, $cache_dir) !== 0
      || ($real_file && $real_cache_dir && strpos($real_file, $real_cache_dir) !== 0)
        ) {
    $good = FALSE;
  }

  // Send error to watchdog.
  if (!$good) {
    watchdog('boost', 'An operation outside of the cache directory was attempted on your system. %file or %real_file is outside the cache directory %cache or %real_cache. Debug info below <br> !debug', array(
      '%file'       => $file,
      '%real_file'  => $real_file,
      '%cache'      => $cache_dir,
      '%real_cache' => $real_cache_dir,
      '!debug'      => boost_print_r($_boost),
      ),
    WATCHDOG_CRITICAL);
  }

  return $good;
}

1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220
/**
 * Capture error conditions.
 *
 * @param $page_callback_result
 *   The result of a page callback. Can be one of:
 *   - NULL: to indicate no content.
 *   - An integer menu status constant: to indicate an error condition.
 *   - A string of HTML content.
 *   - A renderable array of content.
 *
 * @see drupal_deliver_html_page()
 */
function boost_deliver_html_page($page_callback_result) {
  global $_boost;

  // Menu status constants are integers; page content is a string or array.
  if (is_int($page_callback_result)) {
    // @todo: Break these up into separate functions?
    switch ($page_callback_result) {
      case MENU_NOT_FOUND:
        // 404 page.
        $_boost['menu_item']['status'] = 404;
        break;

      case MENU_ACCESS_DENIED:
        // 403 page.
        $_boost['menu_item']['status'] = 403;
        break;

      case MENU_SITE_OFFLINE:
        // 503 page.
        $_boost['menu_item']['status'] = 503;
        break;
    }
  }

  // Call original function
  drupal_deliver_html_page($page_callback_result);
1221 1222 1223 1224 1225

  // Last possible place to send a watchdog message without a shutdown function.
  if (variable_get('boost_message_debug', BOOST_MESSAGE_DEBUG) && $_boost['args'][0] != 'admin') {
    watchdog('boost', boost_print_r($_boost), array(), WATCHDOG_DEBUG);
  }
1226
}
1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238

/**
 * Always run these functions after a form submit from boost.
 */
function boost_form_submit_handler() {
  register_shutdown_function('boost_htaccess_cache_dir_put');
}

/**
 * Overwrite old htaccess rules with new ones.
 */
function boost_htaccess_cache_dir_put() {
1239
  global $_boost, $base_path, $base_root;
1240
  if (empty($_boost['base_dir'])) {
1241 1242 1243
    $url = $base_root . request_uri();
    $parts = parse_url($url);
    $_boost['base_dir'] = boost_get_normal_cache_dir() . '/' . $parts['host'] . $base_path;
1244
  }
1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306
  boost_write_file($_boost['base_dir'] . '.htaccess', boost_htaccess_cache_dir_generate());
}

/**
 * Generate htaccess rules for the cache directory.
 */
function boost_htaccess_cache_dir_generate() {
  $char_type = variable_get('boost_charset_type', BOOST_CHARSET_TYPE);
  $etag = variable_get('boost_apache_etag', BOOST_APACHE_ETAG);

  // Go through every storage type getting data needed to build htaccess file.
  $gzip = FALSE;
  $data = array();
  $files = array();
  $types = boost_get_storage_types();
  foreach ($types as $title => $content_types) {
    foreach ($content_types as $type => $values) {
      if ($values['enabled']) {
        $forcetype = '\.' . $values['extension'];
        if ($values['gzip']) {
          $forcetype .= '(?:\.gz)?$';
          $gzip = TRUE;
        }
        else {
          $forcetype .= '$';
        }
        $files[$values['extension']] = $values['extension'];
        $data[$values['extension']] = array(
          'type' => $type,
          'forcetype' => $forcetype,
        );
      }
    }
  }
  if (empty($data) || empty($files)) {
    return FALSE;
  }

  // Add in default charset
  $string = '';
  if (variable_get('boost_add_default_charset', BOOST_ADD_DEFAULT_CHARSET)) {
    $string .= "AddDefaultCharset " . $char_type . "\n";
  }

  // Set FileETag
  if ($etag == 1) {
    $string .= "FileETag None\n";
  }
  elseif ($etag == 2) {
    $string .= "FileETag All\n";
  }
  elseif ($etag == 3) {
    $string .= "FileETag MTime Size\n";
  }

  // Set html expiration time to the past and put in boost header if desired.
  $files = implode('|' , $files);
  if ($gzip) {
    $files .= '(?:\.gz)?';
  }
  $string .= "<FilesMatch \"\.($files)$\">\n";
  $string .= "  <IfModule mod_expires.c>\n";
1307
  $string .= "    ExpiresDefault A5\n";
1308 1309 1310
  $string .= "  </IfModule>\n";
  $string .= "  <IfModule mod_headers.c>\n";
  $string .= "    Header set Expires \"Sun, 19 Nov 1978 05:00:00 GMT\"\n";
1311 1312
  $string .= "    Header unset Last-Modified\n";
  $string .= "    Header append Vary Accept-Encoding\n";
1313 1314
  $string .= "    Header set Cache-Control \"no-store, no-cache, must-revalidate, post-check=0, pre-check=0\"\n";
  if (variable_get('boost_apache_xheader', BOOST_APACHE_XHEADER) > 0) {
1315
    $string .= "    Header set X-Cached-By \"Boost\"\n";
1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345
  }
  $string .= "  </IfModule>\n";
  $string .= "</FilesMatch>\n";

  // Set charset and content encoding.
  $string .= "<IfModule mod_mime.c>\n";
  foreach ($data as $extension => $values) {
    $string .= "  AddCharset " . $char_type . " ." . $extension . "\n";
  }
  $string .= $gzip ? "  AddEncoding gzip .gz\n" : '';
  $string .= "</IfModule>\n";

  // Fix for versions of apache that do not respect the T='' RewriteRule
  foreach ($data as $extension => $values) {
    $forcetype = $values['forcetype'];
    $type = $values['type'];
    $string .= "<FilesMatch \"$forcetype\">\n";
    $string .= "  ForceType " . $type . "\n";
    $string .= "</FilesMatch>\n";
  }

  // Make sure files can not execute in the cache dir.
  $string .= "\n";
  $string .= "SetHandler Drupal_Security_Do_Not_Remove_See_SA_2006_006\n";
  $string .= "Options None\n";
  $string .= "Options +FollowSymLinks\n";
  $string .= "\n";

  return $string;
}