boost.module 47.6 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 17 18
/**
 * Whether the host supports gzip
 */
define('BOOST_GZIP', function_exists('gzencode'));

19 20 21
/**
 * Default cookie name.
 */
mikeytown2's avatar
mikeytown2 committed
22
define('BOOST_COOKIE', 'DRUPAL_UID');
23

24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44
/**
 * 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', '_');

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

/**
50
 * Default value for ignoring cron cache flush requests.
51
 */
52
define('BOOST_EXPIRE_CRON', TRUE);
53

54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
/**
 * 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');

74 75
/**
 * Shows this block on every page except the listed pages.
76
 * (do not depend on block.module, see #1612448)
77 78 79 80 81 82 83 84 85 86 87 88
 */
define('BOOST_VISIBILITY_NOTLISTED', 0);

/**
 * Shows this block on only the listed pages.
 */
define('BOOST_VISIBILITY_LISTED', 1);

/**
 * Shows this block if the associated PHP code returns TRUE.
 */
define('BOOST_VISIBILITY_PHP', 2);
89

90 91 92 93 94 95
/**
 * Default Setting for .htaccess files +FollowSymLinks, some ISP's require
 * +SymlinksIfOwnerMatch to avoid http 500 error.
 */
define('BOOST_MATCH_SYMLINKS_OPTIONS', 1);

mikeytown2's avatar
mikeytown2 committed
96
/**
97
 * Implements hook_menu().
mikeytown2's avatar
mikeytown2 committed
98 99
 */
function boost_menu() {
100 101
  $items = array();
  $path = drupal_get_path('module', 'boost');
mikeytown2's avatar
mikeytown2 committed
102

103 104
  $items['admin/config/system/boost'] = array(
    'title' => 'Boost',
mikeytown2's avatar
mikeytown2 committed
105 106 107 108
    'description' => 'Configuration for Boost.',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('boost_admin_settings'),
    'access arguments' => array('administer site configuration'),
109
    'type' => MENU_NORMAL_ITEM,
mikeytown2's avatar
mikeytown2 committed
110
    'file' => 'boost.admin.inc',
111
    'file path' => $path,
112
  );
113 114 115 116 117 118
  $items['admin/config/system/boost/default'] = array(
    'title' => 'Boost Settings',
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
  $items['admin/config/system/boost/debug'] = array(
    'title' => 'Debug',
119 120 121 122 123 124
    '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',
125
    'file path' => $path,
126
  );
127 128
  $items['admin/config/system/boost/filesystem'] = array(
    'title' => 'File System',
129 130 131 132 133 134
    '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',
135
    'file path' => $path,
136
  );
137 138
  $items['admin/config/system/boost/htaccess'] = array(
    'title' => '.htaccess',
139 140 141 142 143 144
    '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',
145
    'file path' => $path,
146
  );
147 148 149 150 151 152
  $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',
153 154 155 156 157 158
    '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',
159 160 161 162 163 164 165 166 167 168 169
    '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
170
  );
171
  $items['admin/config/system/boost/listmodules'] = array(
172
    'title' => 'Related Modules',
173 174 175 176 177 178 179 180
    'description' => ' Compatible Modules that add features to Boost.',
    'page callback' => 'boost_admin_modules_theme',
    'page callback' => 'boost_compatible_output',
    'access arguments' => array('administer site configuration'),
    'type' => MENU_LOCAL_TASK,
    'file' => 'boost.admin.modules.inc',
    'weight' => 100,
  );
181

mikeytown2's avatar
mikeytown2 committed
182 183
  return $items;
}
184

185 186 187 188 189 190
/**
 * Implements hook_permissions().
 */
function boost_permission() {
  return array(
    'boost flush pages' => array(
bgm's avatar
bgm committed
191
      'title' => t('Flush pages from Boost cache'),
192 193 194 195 196 197 198 199 200 201
      'description' => t('Allow users to flush individual pages from the Boost cache using the Boost status block.'),
    ),
  );
}

/**
 * Implements hook_block_info().
 */
function boost_block_info() {
  $blocks['status'] = array(
bgm's avatar
bgm committed
202
    'info' => t('Boost: Pages cache status'),
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
    'cache' => DRUPAL_NO_CACHE,
  );

  return $blocks;
}

/**
 * Implements hook_block_view().
 */
function boost_block_view($delta = '') {
  $block = array();

  switch ($delta) {
    case 'status':
      module_load_include('inc', 'boost', 'boost.blocks');
      return boost_block_view_status();
  }

  return $block;
}

mikeytown2's avatar
mikeytown2 committed
224
/**
225 226 227
 * Implements hook_init().
 *
 * Performs page setup tasks.
mikeytown2's avatar
mikeytown2 committed
228 229
 */
function boost_init() {
230
  global $_boost;
231

232 233
  $_boost = array();

234
  // Make sure the page is/should be cached according to our current configuration.
235
  // Start with the quick checks
mikeytown2's avatar
mikeytown2 committed
236 237
  if (   strpos($_SERVER['SCRIPT_FILENAME'], 'index.php') === FALSE
      || $_SERVER['SERVER_SOFTWARE'] === 'PHP CLI'
238
      || ($_SERVER['REQUEST_METHOD'] != 'GET' && $_SERVER['REQUEST_METHOD'] != 'HEAD')
mikeytown2's avatar
mikeytown2 committed
239
      || isset($_GET['nocache'])
240 241
      || variable_get('maintenance_mode', 0)
      || defined('MAINTENANCE_MODE')
242
      || !empty($_SESSION['messages']) // do not cache pages with messages
243
  ) {
mikeytown2's avatar
mikeytown2 committed
244 245
    $_boost['cache_this'] = FALSE;
  }
246 247 248 249 250 251 252
  else {
    // More advanced checks
    $_boost = boost_transform_url();
    if (empty($_boost['menu_item']['status']) || $_boost['menu_item']['status'] != 200) {
      $_boost['cache_this'] = FALSE;
    }
  }
253 254 255 256 257 258 259 260

  // 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
261
}
262

263 264 265 266 267 268 269 270 271 272 273
/**
 * Implements hook_form_alter().
 */
function boost_form_alter(&$form, &$form_state, $form_id) {
  global $_boost;

  if (! empty($_boost['cache_this'])) {
    $form['#immutable'] = TRUE;
  }
}

274 275 276 277 278 279 280 281 282
/**
 * Implements hook_drupal_goto_alter().
 */
function boost_drupal_goto_alter(&$path, &$options, &$http_response_code) {
  global $_boost;
  // Bypass caching on redirects (issue #1176534).
  $_boost['is_cacheable'] = FALSE;
}

mikeytown2's avatar
mikeytown2 committed
283
/**
bgm's avatar
bgm committed
284
 * Implements hook_exit().
mikeytown2's avatar
mikeytown2 committed
285
 */
286
function boost_exit($destination = NULL) {
mikeytown2's avatar
mikeytown2 committed
287
  global $_boost;
288 289 290 291 292 293

  // Bypass caching on redirects (issues #1176534 and #1957532).
  if(!empty($destination)) {
    $_boost['is_cacheable'] = FALSE;
  }

294
  // Bail out of caching.
mikeytown2's avatar
mikeytown2 committed
295 296 297 298 299 300 301 302
  if (!isset($_boost['cache_this'])) {
    if (!isset($_boost['is_cacheable'])) {
      return;
    }
    elseif (!$_boost['is_cacheable']) {
      return;
    }
  }
303

304
  if (isset($_boost['cache_this']) && $_boost['cache_this'] == FALSE) {
mikeytown2's avatar
mikeytown2 committed
305 306
    return;
  }
307
  elseif (!isset($_boost['is_cacheable']) || !$_boost['is_cacheable']) {
mikeytown2's avatar
mikeytown2 committed
308 309
    return;
  }
310 311 312
  elseif ($_boost['menu_item']['status'] != 200) {
    return;
  }
313 314 315 316
  elseif (!drupal_page_is_cacheable()) {
    $_boost['is_cacheable'] = FALSE;
    return;
  }
317

318
  // Get the data to cache.
mikeytown2's avatar
mikeytown2 committed
319
  $data = ob_get_contents();
320

321 322 323 324
  // 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
325 326
    return;
  }
327

328
  // Add note to bottom of content if possible.
329
  if ($_boost['matched_header_info']['comment_start'] && $_boost['matched_header_info']['comment_end']) {
330
    $expire = $_boost['matched_header_info']['lifetime_max'];
mikeytown2's avatar
mikeytown2 committed
331 332
    $cached_at = date('Y-m-d H:i:s', REQUEST_TIME);
    $expires_at = date('Y-m-d H:i:s', REQUEST_TIME + $expire);
333
    $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
334 335
    $data .= $note;
  }
336 337 338 339 340 341

  // Write data to a file.
  if ($_boost['filename']) {
    // Attach extension to filename.
    $_boost['filename'] .= '.' . $_boost['matched_header_info']['extension'];
    // Write to file.
342
    boost_write_file($_boost['filename'], $data);
ruloweb's avatar
ruloweb committed
343 344

    // Gzip support.
345
    if (BOOST_GZIP && $_boost['matched_header_info']['gzip']) {
346
      // #1416214 https://drupal.org/node/1416214#comment-7225650
347
      // boost_write_file($_boost['filename'] . '.gz', gzencode($data, 9));
ruloweb's avatar
ruloweb committed
348
    }
mikeytown2's avatar
mikeytown2 committed
349 350
  }
}
351 352

/**
353
 * Implements hook_cron(). Performs periodic actions.
354
 */
mikeytown2's avatar
mikeytown2 committed
355
function boost_cron() {
356
  // Remove expired files from the cache.
mikeytown2's avatar
mikeytown2 committed
357
  global $_boost;
358 359 360 361 362

  // This was not invoked in hook_init because of the quick check to
  // avoid caching requests from the CLI
  $_boost = boost_transform_url();

363
  if (isset($_boost['base_dir']) && variable_get('boost_expire_cron', BOOST_EXPIRE_CRON)) {
364
    $count = _boost_rmdir($_boost['base_dir'], FALSE);
365 366 367
    if (variable_get('boost_message_debug', BOOST_MESSAGE_DEBUG)) {
      watchdog('boost', 'Expired %count stale files from static page cache.', array('%count' => $count), WATCHDOG_NOTICE);
    }
368 369 370
  }
}

371
/**
372
 * Implements hook_flush_caches(). Deletes all static files.
373
 */
mikeytown2's avatar
mikeytown2 committed
374 375 376
function boost_flush_caches() {
  // Remove all files from the cache
  global $_boost;
377 378 379 380 381

  // This may not have been invoked in hook_init because of the quick
  // check to avoid caching requests from the CLI
  $_boost = boost_transform_url();

382 383
  // The lock_may_be_available() checks to see if the flush was requested by
  // the core cron, since we may want to ignore it (boost_ignore_flush)
384
  if (isset($_boost['base_dir']) && (lock_may_be_available('cron') || variable_get('boost_ignore_flush', BOOST_IGNORE_FLUSH) == FALSE)) {
385 386
    $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
387 388
  }
  return;
389 390
}

391 392 393
/**
 * Implements hook_expire_cache (from the 'expire' module)
 */
394
function boost_expire_cache($urls, $wildcards, $object_type, $object) {
395 396
  global $base_root;

397
  foreach ($urls as $key => $url) {
398
    // Check if the URL to be flushed matches our base URL
399 400 401
    // base_root: http://www.example.org
    // url: http://www.example.org/node/123
    if (strpos($url, $base_root) === 0) {
402 403
      // Decode the url since it may have a query string that has been encoded
      $boost = boost_transform_url(urldecode($url));
404 405 406 407 408

      // We need the extention for the filename
      $boost['header_info'] = boost_get_header_info();
      $boost['matched_header_info'] = boost_match_header_attributes($boost['header_info']);

409 410 411 412 413
      // Issue #2135835 Cache may not be enabled for this type (html/xml/ajax)
      if (! $boost['matched_header_info']['enabled']) {
        continue;
      }

414
      // If wildcards are enabled, we'll need to create a wildcard pattern for globbing
415
      if ($wildcards[$key]) {
416
        $pattern = (isset($boost['filename']) ? $boost['filename'] . '*.' . $boost['matched_header_info']['extension'] : NULL);
417
      }
418 419
      else {
        $pattern = (isset($boost['filename']) ? $boost['filename'] . '.' . $boost['matched_header_info']['extension'] : NULL);
420
      }
421 422

      // Remove the files
423 424
      $files = glob($pattern, GLOB_NOSORT);

425 426
      if ($files) {
        foreach ($files as $filename) {
427
          if (unlink($filename)) {
428 429 430
            boost_log('Removed !file from the boost cache.', array('!file' => $filename), WATCHDOG_DEBUG);
          }
          else {
431
            boost_log('Could not delete the cache for !url, file !file does not exist.', array('!url' => $url, '!file' => $filename), WATCHDOG_DEBUG);
432 433
          }
        }
434 435 436 437 438
      }
    }
  }
}

439
/**
440 441 442 443 444 445 446 447
 * 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';
  }
}

448
/**
mikeytown2's avatar
mikeytown2 committed
449 450 451 452 453 454
 * Given a URL give back eveything we know
 *
 * @param $url
 *   Full URL
 * @param $b_path
 *   Base Path
455
 */
mikeytown2's avatar
mikeytown2 committed
456 457 458 459
function boost_transform_url($url = NULL, $b_path = NULL) {
  global $base_root, $base_path;
  $items = &drupal_static(__FUNCTION__);

460
  // Set defaults if none passed in.
mikeytown2's avatar
mikeytown2 committed
461 462
  if ($url === NULL) {
    $url = $base_root . request_uri();
463
  }
mikeytown2's avatar
mikeytown2 committed
464 465 466 467 468 469 470 471 472 473 474
  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];
    }
475
    $parts['base_dir'] = boost_get_normal_cache_dir() . '/' . $parts['host'] . $b_path;
476
    $parts['filename'] = $parts['base_dir'] . $parts['full_path'] . variable_get('boost_char', BOOST_CHAR) . $parts['query'];
mikeytown2's avatar
mikeytown2 committed
477 478
    $parts['directory'] = dirname($parts['filename']);

479
    // Get the internal path (node/8).
mikeytown2's avatar
mikeytown2 committed
480 481 482 483 484 485
    if (drupal_is_front_page()) {
      $parts['normal_path'] = variable_get('site_frontpage', 'node');
    }
    else {
      $parts['normal_path'] = drupal_get_normal_path($parts['path']);
    }
486
    // Get the alias (content/about-us).
mikeytown2's avatar
mikeytown2 committed
487
    $parts['path_alias'] = drupal_get_path_alias($parts['normal_path']);
488
    // Get all args.
mikeytown2's avatar
mikeytown2 committed
489
    $args = arg(NULL, $parts['normal_path']);
490
    // Prevent array warnings.
mikeytown2's avatar
mikeytown2 committed
491 492 493 494 495
    $args[0] = empty($args[0]) ? '' : $args[0];
    $args[1] = empty($args[1]) ? '' : $args[1];
    $args[2] = empty($args[2]) ? '' : $args[2];
    $parts['args'] = $args;

496
    // Get content type.
497 498 499
    if (!empty($parts['normal_path'])) {
      $parts = _boost_get_menu_router($parts);
    }
500
    // See if url is cacheable.
mikeytown2's avatar
mikeytown2 committed
501 502 503 504 505
    $parts = boost_is_cacheable($parts);
    $items[$hash] = $parts;
  }

  return $items[$hash];
506 507
}

508 509 510 511 512 513 514
/**
 * 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);
}

515
/**
mikeytown2's avatar
mikeytown2 committed
516 517 518 519 520 521
 * parse_url that takes into account the base_path
 *
 * @param $url
 *   Full URL
 * @param $b_path
 *   Base Path
522
 */
mikeytown2's avatar
mikeytown2 committed
523 524
function boost_parse_url($url = NULL, $b_path = NULL) {
  global $base_root, $base_path;
525
  // Set defaults.
mikeytown2's avatar
mikeytown2 committed
526 527 528 529 530 531
  if ($url === NULL) {
    $url = $base_root . request_uri();
  }
  if ($b_path == NULL) {
    $b_path = $base_path;
  }
532

533
  // Parse url.
mikeytown2's avatar
mikeytown2 committed
534 535 536 537 538 539 540
  $parts = parse_url($url);
  if (empty($parts['host']) || empty($parts['path'])) {
    return FALSE;
  }
  if (!isset($parts['query'])) {
    $parts['query'] = '';
  }
Philip_Clarke's avatar
Philip_Clarke committed
541
  $parts['path'] = $parts['full_path'] = urldecode(preg_replace('/^' . preg_quote($b_path, '/') . '/i', '', $parts['path']));
mikeytown2's avatar
mikeytown2 committed
542 543 544 545
  $parts['base_path'] = $b_path;
  $parts['query_array'] = array();
  parse_str($parts['query'], $parts['query_array']);

546
  // Check if language prefix for urls is enabled.
547
  if (drupal_multilingual() && variable_get('locale_language_negotiation_url_part') == LOCALE_LANGUAGE_NEGOTIATION_URL_PREFIX) {
548 549 550 551 552 553
    // Get languages grouped by status and select only the enabled ones.
    $languages = language_list('enabled');
    $languages = $languages[1];
    list($language, $parts['path']) = language_url_split_prefix($parts['path'], $languages);
  }

554
  // Get page number and info from the query string.
mikeytown2's avatar
mikeytown2 committed
555 556 557 558 559 560 561 562 563
  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;
      }
564
    }
mikeytown2's avatar
mikeytown2 committed
565
    ksort($query);
566
    $parts['query_extra'] = str_replace('&amp;', '&', urldecode(http_build_query($query)));
567 568
  }

569
  // Get fully decoded URL.
570
  $decoded1 = urldecode($parts['base_path'] . $parts['path'] . variable_get('boost_char', BOOST_CHAR) . $parts['query']);
mikeytown2's avatar
mikeytown2 committed
571 572 573 574 575 576 577 578 579
  $decoded2 = urldecode($decoded1);
  while ($decoded1 != $decoded2) {
    $decoded1 = urldecode($decoded2);
    $decoded2 = urldecode($decoded1);
  }
  $decoded = $decoded2;
  unset($decoded2);
  unset($decoded1);

580
  $parts['url_full'] = $parts['host'] . $parts['base_path'] . $parts['path'] . variable_get('boost_char', BOOST_CHAR) . $parts['query'];
mikeytown2's avatar
mikeytown2 committed
581 582 583 584
  $parts['url'] = $url;
  $parts['url_decoded'] = $decoded;
  return $parts;
}
585

mikeytown2's avatar
mikeytown2 committed
586 587 588 589 590 591 592
/**
 * Determines whether a given url can be cached or not by boost.
 *
 * TODO: Add in support for the menu_item
 *
 * @param $parts
 *   $parts
593 594 595 596 597 598
 * @param $request_type
 *   May be 'status' to skip some checks in order to show the status
 *   block on the admin interface (otherwise we will always mention
 *   that the page is non-cacheable, since user is logged in).
 *   Please don't rely on this parameter if you are extending boost,
 *   this is likely to change in the future. Contact us if you use it.
mikeytown2's avatar
mikeytown2 committed
599 600 601
 *
 * @return $parts
 */
602
function boost_is_cacheable($parts, $request_type = 'normal') {
603
  // Set local variables.
mikeytown2's avatar
mikeytown2 committed
604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620
  $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
621
  //  Do not cache if destination is set.
mikeytown2's avatar
mikeytown2 committed
622 623 624 625 626 627 628 629 630 631 632 633 634 635 636
  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;
637
    $parts['is_cacheable_reason'] = 'Core Drupal dynamic pages';
mikeytown2's avatar
mikeytown2 committed
638 639 640
    return $parts;
  }

641
  // Check for reserved characters if on windows.
mikeytown2's avatar
mikeytown2 committed
642 643 644 645 646
  // http://en.wikipedia.org/wiki/Filename#Reserved_characters_and_words
  // " * : < > |
  $chars = '"*:<>|';
  if (stristr(PHP_OS, 'WIN') && preg_match("/[" . $chars . "]/", $full)) {
    $parts['is_cacheable'] = FALSE;
647
    $parts['is_cacheable_reason'] = 'Reserved characters on MS Windows';
mikeytown2's avatar
mikeytown2 committed
648 649
    return $parts;
  }
650

651
  // Match the user's cacheability settings against the path.
mikeytown2's avatar
mikeytown2 committed
652
  // See http://api.drupal.org/api/function/block_block_list_alter/7
653
  $visibility = variable_get('boost_cacheability_option', BOOST_VISIBILITY_NOTLISTED);
mikeytown2's avatar
mikeytown2 committed
654 655 656 657 658
  $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);
659
    if ($visibility < BOOST_VISIBILITY_PHP) {
660
      // Convert the alias to lowercase.
mikeytown2's avatar
mikeytown2 committed
661 662 663 664 665 666
      $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);
      }
667
      // When 'boost_cacheability_option' has a value of 0 (BOOST_VISIBILITY_NOTLISTED),
mikeytown2's avatar
mikeytown2 committed
668
      // Boost will cache all pages except those listed in 'boost_cacheability_pages'.
669
      // When set to 1 (BOOST_VISIBILITY_LISTED), Boost will only cache those
mikeytown2's avatar
mikeytown2 committed
670 671 672 673 674
      // pages listed in 'boost_cacheability_pages'.
      $page_match = !($visibility xor $page_match);
    }
    elseif (module_exists('php')) {
      $page_match = php_eval($pages_setting);
675
    }
mikeytown2's avatar
mikeytown2 committed
676 677 678 679 680 681 682
    else {
      $page_match = FALSE;
    }
  }
  else {
    $page_match = TRUE;
  }
683

mikeytown2's avatar
mikeytown2 committed
684
  $parts['is_cacheable'] = $page_match;
685 686 687 688 689

  if (! $page_match) {
    $parts['is_cacheable_reason'] = 'Page excluded from cache by the include/exclude paths defined by site admin.';
  }

mikeytown2's avatar
mikeytown2 committed
690 691 692 693
  if (!$parts['is_cacheable']) {
    return $parts;
  }

694
  // Invoke hook_boost_is_cacheable($path).
mikeytown2's avatar
mikeytown2 committed
695 696
  $modules = boost_module_implements('boost_is_cacheable', 'boost');
  foreach ($modules as $module) {
697
    $result = module_invoke($module, 'boost_is_cacheable', $parts, $request_type);
698
    if ($result['is_cacheable'] === FALSE) {
699 700 701 702
      if (! isset($result['is_cacheable'])) {
        $result['is_cacheable_reason'] = 'Page excluded from cache by a third-party module.';
      }

mikeytown2's avatar
mikeytown2 committed
703
      return $result;
704 705
    }
  }
706 707

  return $result;
708 709
}

710
/**
711
 * Implements hook_boost_is_cacheable().
712
 *
mikeytown2's avatar
mikeytown2 committed
713
 * TODO support for node types, etc.
714
 *
mikeytown2's avatar
mikeytown2 committed
715 716
 * @param $parts
 *   info about this request
717 718 719 720
 * @param $request_type
 *   if the request_type is "status", we assume that this is being
 *   called from the admin status block. Since the user must be
 *   logged in to view this block, we do not return false.
721
 *
mikeytown2's avatar
mikeytown2 committed
722
 * @return $parts
723
 */
724
function boost_boost_is_cacheable($parts, $request_type = 'normal') {
725
  global $user;
726
  if ($user->uid != 0 && $request_type != 'status') {
727
    $parts['is_cacheable'] = FALSE;
728
    $parts['is_cacheable_reason'] = 'Boost only works for anonymous users.';
729 730 731 732
  }
  else {
    $parts['is_cacheable'] = TRUE;
  }
mikeytown2's avatar
mikeytown2 committed
733
  return $parts;
734 735
}

736
/**
mikeytown2's avatar
mikeytown2 committed
737 738 739 740 741 742 743
 * Sets a special cookie preventing authenticated users getting served pages
 * from the static page cache.
 *
 * @param $uid
 *   User ID Number
 * @param $expires
 *   Expiration time
744
 */
mikeytown2's avatar
mikeytown2 committed
745 746 747 748 749 750 751 752
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');
753 754 755
  }
}

756 757 758 759 760 761 762 763
/**
 * 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.
764 765 766 767
  if (strpos($_SERVER['SCRIPT_FILENAME'], 'index.php') === FALSE) {
    return;
  }

768
  $uid = isset($user->uid) ? $user->uid : 0;
769 770 771 772
  // Remove Boost cookie at logout if it still exists.
  if (isset($_COOKIE[BOOST_COOKIE]) && $uid == 0) {
    boost_set_cookie($uid, REQUEST_TIME - 86400);
  }
773 774 775 776 777
  // Set Boost cookie if it doesn't exists (or is -1 likely because of a login POST) and user is logged in.
  // c.f. Issue #1616356 comment #7
  elseif ((!isset($_COOKIE[BOOST_COOKIE]) || $_COOKIE[BOOST_COOKIE] == '-1') && $uid != 0) {
    boost_set_cookie($uid);
  }
778 779 780 781 782 783 784 785 786 787 788 789
  // Remove Boost cookie if set to -1 & Request Method is a GET/HEAD.
  elseif (isset($_COOKIE[BOOST_COOKIE]) && $_COOKIE[BOOST_COOKIE] == '-1' && ($_SERVER['REQUEST_METHOD'] == 'GET' || $_SERVER['REQUEST_METHOD'] == 'HEAD')) {
    boost_set_cookie($uid, REQUEST_TIME - 86400);
  }

  // Issue #1242416: Set a nocache cookie on a POST, remove it immediately after
  // (on GET) Only necessary for anon users, since we already do not cache for
  // logged in users. Also note that if we are processing a GET, it means that
  // we have already been through the htaccess rules, so the cookie has done
  // its job and can be removed.
  if ($uid == 0 && $_SERVER['REQUEST_METHOD'] != 'GET' && $_SERVER['REQUEST_METHOD'] != 'HEAD') {
    boost_set_cookie(-1);
790 791 792
  }
}

793
/**
794
 * Gets menu router contex.
mikeytown2's avatar
mikeytown2 committed
795
 *
796 797
 * Allows for any content type to have it's own cache expiration among
 * other things.
mikeytown2's avatar
mikeytown2 committed
798 799 800 801 802
 *
 * @param $parts
 *
 * @return $parts
 *
803
 */
mikeytown2's avatar
mikeytown2 committed
804
function _boost_get_menu_router($parts) {
805
  // Declare array keys.
mikeytown2's avatar
mikeytown2 committed
806 807 808
  $router_item = array();
  $router_item['page_type'] = '';
  $router_item['page_id'] = '';
809
  // Load the menu item.
mikeytown2's avatar
mikeytown2 committed
810 811 812
  $item = menu_get_item($parts['normal_path']);
  if (is_array($item)) {
    $router_item += $item;
813 814 815 816 817 818
    if ($router_item['access']) {
      $router_item['status'] = 200;
    }
    else {
      $router_item['status'] = 403;
    }
mikeytown2's avatar
mikeytown2 committed
819
  }
820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838
  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
839 840 841 842 843 844 845 846 847
    }
  }
  if (!empty($diff)) {
    $router_item['extra_arguments'] = implode('/', $diff);
  }
  else {
    $router_item['extra_arguments'] = '';
  }

848 849
  // Make sure function for menu callback is loaded.
  // See menu_execute_active_handler()
850
  if (!empty($router_item['include_file'])) {
851 852 853
    require_once DRUPAL_ROOT . '/' . $router_item['include_file'];
  }

mikeytown2's avatar
mikeytown2 committed
854
  $parts['menu_item'] = $router_item;
855
  // Invoke hook_boost_menu_router($router_item).
mikeytown2's avatar
mikeytown2 committed
856 857 858
  $modules = boost_module_implements('boost_menu_router', 'boost');
  foreach ($modules as $module) {
    if (($result = module_invoke($module, 'boost_menu_router', $parts)) !== NULL) {
859
      break;
mikeytown2's avatar
mikeytown2 committed
860
    }
861
  }
862 863 864 865 866 867

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

  return $result;
868 869 870
}

/**
871
 * Implements hook_boost_menu_router().
mikeytown2's avatar
mikeytown2 committed
872 873 874 875 876 877 878
 *
 * TODO Better support for arguments.
 *
 * @param $parts
 *   info about this request
 *
 * @return $parts
879
 */
mikeytown2's avatar
mikeytown2 committed
880
function boost_boost_menu_router($parts) {
881
  // Handle nodes.
mikeytown2's avatar
mikeytown2 committed
882 883 884 885 886 887 888 889 890
  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;
  }
891 892

  // Handle taxonomy.
mikeytown2's avatar
mikeytown2 committed
893 894 895 896 897 898 899 900 901 902
  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;
  }
903 904

  // Handle users.
mikeytown2's avatar
mikeytown2 committed
905 906 907 908 909 910 911 912 913
  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;
  }
914 915 916

  // Handle views.
  if (isset($parts['menu_item']['page_callback']) && $parts['menu_item']['page_callback'] == 'views_page') {
917 918 919 920 921 922 923
    $page_arguments = $parts['menu_item']['page_arguments'];

    // Issue #1364090 : views with access control have serialized page arguments
    if (! is_array($page_arguments)) {
      $page_arguments = unserialize($page_arguments);
    }

mikeytown2's avatar
mikeytown2 committed
924
    $parts['menu_item']['page_callback'] = 'view';
925 926
    $parts['menu_item']['page_type'] = array_shift($page_arguments);
    $parts['menu_item']['page_id'] = array_shift($page_arguments);
mikeytown2's avatar
mikeytown2 committed
927 928 929 930 931 932 933
    // 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;
  }

934 935
  // Handle panels.
  if (isset($parts['menu_item']['page_callback']) && $parts['menu_item']['page_callback'] == 'page_manager_page_execute') {
936 937 938 939 940 941 942 943
    $page_arguments = $parts['menu_item']['page_arguments'];

    // Issue #1653206 : panels with access control have serialized page arguments
    if (! is_array($page_arguments)) {
      $page_arguments = unserialize($page_arguments);
    }

    $subtask_id = array_shift($page_arguments);
mikeytown2's avatar
mikeytown2 committed
944 945 946 947 948 949 950 951 952
    $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;
  }
953

954 955
  // Try to handle everything else.
  elseif (isset($parts['menu_item']['page_arguments']) && is_array($parts['menu_item']['page_arguments'])) {
mikeytown2's avatar
mikeytown2 committed
956 957 958 959 960 961 962 963
    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;
      }
    }
964
  }
965

mikeytown2's avatar
mikeytown2 committed
966 967 968 969 970 971 972 973
  // 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'];
  }

974 975 976
  // 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
977
  }
978 979
  elseif (empty($parts['menu_item']['page_id']) && !empty($parts['query_extra'])) {
    $parts['menu_item']['page_id'] = $parts['query_extra'];
mikeytown2's avatar
mikeytown2 committed
980 981 982
  }

  return $parts;
983 984 985
}

/**
986
 * Alters module_implements to set a hook to fire at the end.
mikeytown2's avatar
mikeytown2 committed
987 988
 *
 * @param $hook
989
 *   Name of hook.
mikeytown2's avatar
mikeytown2 committed
990
 * @param $name
991
 *   Module name to shift to the end of the array.
mikeytown2's avatar
mikeytown2 committed
992 993
 *
 * @return array
994
 */
mikeytown2's avatar
mikeytown2 committed
995 996 997 998 999 1000 1001 1002
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;
1003
  }
mikeytown2's avatar
mikeytown2 committed
1004
  return $modules;
1005 1006 1007
}

/**
mikeytown2's avatar
mikeytown2 committed
1008 1009 1010 1011 1012
 * Gets and parses the header info.
 *
 * @see drupal_send_headers()
 *
 * @return array
1013
 *   Contains info about the page that is about to be sent.
1014
 */
mikeytown2's avatar
mikeytown2 committed
1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030
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;
    }
  }
1031

mikeytown2's avatar
mikeytown2 committed
1032 1033 1034 1035 1036 1037 1038 1039
  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);
1040
  }
mikeytown2's avatar
mikeytown2 committed
1041 1042 1043 1044 1045 1046 1047 1048 1049

  return array(
    'status' => $status,
    'status-number' => $status_number,
    'content-type' => $content_type,
    'content-type-basic' => $content_type_basic,
    'charset' => $charset,
    'headers_sent' => headers_sent(),
  );
1050 1051 1052
}

/**
mikeytown2's avatar
mikeytown2 committed
1053 1054 1055 1056 1057 1058
 * Given header info, match it to a file extension
 *
 * @param $header_info
 *   array contains header info
 *
 * @return array
1059
 */
mikeytown2's avatar
mikeytown2 committed
1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072
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);
1073
  }
mikeytown2's avatar
mikeytown2 committed
1074 1075 1076

  $keys = array(
    'enabled',
1077
    'gzip',
mikeytown2's avatar
mikeytown2 committed
1078 1079 1080
    'extension',
    'lifetime_max',
    'lifetime_min',
1081 1082
    'comment_start',
    'comment_end',
mikeytown2's avatar
mikeytown2 committed
1083 1084 1085 1086 1087 1088 1089 1090 1091
  );
  $info = array();
  foreach ($keys as $key) {
    $info[$key] = variable_get('boost_' . $key . '_' . $type, -1);
    if ($info[$key] === -1) {
      return array('enabled' => FALSE);
    }
  }
  return $info;
1092 1093 1094
}

/**
1095
 * Get the storage types for the boost cache.
1096
 *
mikeytown2's avatar
mikeytown2 committed
1097 1098
 * @return $types
 *   array('title' => array('content-type' => $values));
1099
 */
mikeytown2's avatar
mikeytown2 committed
1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124
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;
      }
    }
  }
1125

mikeytown2's avatar
mikeytown2 committed
1126
  // Merge it all back together
1127
  $merged = array_merge($primary_types, $secondary_types);
mikeytown2's avatar
mikeytown2 committed
1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140
  $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',
1141
    'gzip',
mikeytown2's avatar
mikeytown2 committed
1142 1143
    'lifetime_max',
    'lifetime_min',
1144 1145
    'comment_start',
    'comment_end',
1146

mikeytown2's avatar
mikeytown2 committed
1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161
  );
  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;
}
1162 1163

/**
1164
 * Implements hook_boost_storage_types().
1165
 *
mikeytown2's avatar
mikeytown2 committed
1166
 * @return $types
1167
 */
mikeytown2's avatar
mikeytown2 committed
1168 1169 1170 1171 1172 1173 1174 1175
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,
1176
    'gzip'            => TRUE,
mikeytown2's avatar
mikeytown2 committed
1177 1178
    'lifetime_max'    => 3600,
    'lifetime_min'    => 0,
1179 1180
    'comment_start'  => '<!-- ',
    'comment_end'    => ' -->',
mikeytown2's avatar
mikeytown2 committed
1181 1182 1183 1184 1185 1186 1187
    'variants'        => array(),
  );
  $types['text/xml'] = array(
    'title'           => t('XML'),
    'description'     => t('XML output, usually a feed'),
    'extension'       => 'xml',
    'enabled'         => FALSE,
1188
    'gzip'            => TRUE,
mikeytown2's avatar
mikeytown2 committed
1189 1190
    'lifetime_max'    => 3600,
    'lifetime_min'    => 0,
1191 1192
    'comment_start'  => '<!-- ',
    'comment_end'    => ' -->',
mikeytown2's avatar
mikeytown2 committed
1193 1194 1195 1196 1197 1198
    'variants'        => array(
      'application/xml',
      'application/rss',
      'application/rss+xml',
    ),
  );
1199
  // #1219484
mikeytown2's avatar
mikeytown2 committed
1200
  $types['text/javascript'] = array(
1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224
    'title'           => t('text/javascript'),
    'description'     => t('Javascript output, usually a response to a AJAX request'),
    'extension'       => 'js',
    'enabled'         => FALSE,
    'gzip'            => TRUE,
    'lifetime_max'    => 3600,
    'lifetime_min'    => 0,
    'comment_start'  => '/* ',
    'comment_end'    => ' */',
    'variants'        => array(),
  );
  $types['application/javascript'] = array(
    'title'           => t('AJAX/JavaScript'),
    'description'     => t('Javascript output, usually a response to a AJAX request'),
    'extension'       => 'json',
    'enabled'         => FALSE,
    'gzip'            => TRUE,
    'lifetime_max'    => 3600,
    'lifetime_min'    => 0,
    'comment_start'  => '',
    'comment_end'    => '',
    'variants'        => array(),
  );
  $types['application/json'] = array(
mikeytown2's avatar
mikeytown2 committed
1225 1226 1227 1228
    'title'           => t('AJAX/JSON'),
    'description'     => t('JSON output, usually a response to a AJAX request'),
    'extension'       => 'json',
    'enabled'         => FALSE,
1229
    'gzip'            => TRUE,
mikeytown2's avatar
mikeytown2 committed
1230 1231
    'lifetime_max'    => 3600,
    'lifetime_min'    => 0,
1232 1233
    'comment_start'  => '',
    'comment_end'    => '',
mikeytown2's avatar
mikeytown2 committed
1234 1235
    'variants'        => array(),
  );
1236

mikeytown2's avatar
mikeytown2 committed
1237 1238
  return $types;
}
1239

mikeytown2's avatar
mikeytown2 committed
1240 1241 1242
/**
 * Recursive version of rmdir(); use with extreme caution.
 *
1243 1244
 * Function also checks file age and only removes expired files.
 *
mikeytown2's avatar
mikeytown2 committed
1245
 * @param $dir
1246
 *   The top-level directory that will be recursively removed.
1247 1248
 * @param $flush
 *   Instead of removing expired cached files, remove all files.
mikeytown2's avatar
mikeytown2 committed
1249 1250 1251
 */
function _boost_rmdir($dir, $flush = TRUE) {
  static $lifetimes = array();
1252 1253 1254 1255 1256 1257 1258 1259 1260
  static $counter = 0;
  if (is_dir($dir) == FALSE) {
    return FALSE;
  }

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

mikeytown2's avatar
mikeytown2 committed
1261 1262 1263 1264 1265 1266 1267
  // 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'];
      }
1268
    }
1269 1270 1271

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

1274 1275 1276
  $objects = scandir($dir);
  $empty_dir = TRUE;
  foreach ($objects as $object) {
1277 1278 1279 1280 1281
    if ($object == "." || $object == "..") {
      continue;
    }
    if ($object == ".htaccess") {
      $empty_dir = FALSE;
1282
      continue;
mikeytown2's avatar
mikeytown2 committed
1283
    }
1284 1285 1286 1287

    $file = $dir . "/" . $object;
    if (is_dir($file)) {
      _boost_rmdir($file, $flush);
mikeytown2's avatar
mikeytown2 committed
1288
    }
1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306
    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;
      }
    }
  }
1307 1308 1309
  if ($empty_dir && is_dir($dir)) {
    // #1138630 @ error suppression used due to rmdir being a race condition.
    @rmdir($dir);
mikeytown2's avatar
mikeytown2 committed
1310
  }
1311
  return $counter;
1312 1313 1314
}

/**
mikeytown2's avatar
mikeytown2 committed
1315 1316
 * Returns the age of a cached file, measured in seconds since it was last
 * updated.
1317
 *
mikeytown2's avatar
mikeytown2 committed
1318 1319 1320
 * @param $filename
 *   Name of cached file
 * @return int
1321
 */
mikeytown2's avatar
mikeytown2 committed
1322 1323
function boost_file_get_age($filename) {
  return REQUEST_TIME - filemtime($filename);
1324
}
1325

1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337
/**
 * 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))));
}

/**
1338
 * Write to a file. Ensures write is atomic via rename operation.
1339 1340 1341 1342 1343 1344
 *
 * @param $filename
 *  relative filename.
 * @param $data
 *  data to write to the file.
 */
1345
function boost_write_file($filename, $data) {
1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362
  // 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);