expire.module 16.7 KB
Newer Older
Mike Carper's avatar
Mike Carper committed
1 2 3 4 5 6 7
<?php

/**
 * @file
 * Provides logic for page cache expiration
 */

8
// Defaults used if variable_get is not set.
Mike Carper's avatar
Mike Carper committed
9 10 11
define('EXPIRE_FLUSH_NODE_TERMS', TRUE);
define('EXPIRE_FLUSH_MENU_ITEMS', 1);
define('EXPIRE_FLUSH_CCK_REFERENCES', TRUE);
12
define('EXPIRE_FLUSH_FRONT', TRUE);
13
define('EXPIRE_INCLUDE_BASE_URL', TRUE);
Mike Carper's avatar
Mike Carper committed
14

15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
/**
 * Implementation of hook_menu().
 */
function expire_menu() {
  $items = array();
  $items['admin/settings/performance/default'] = array(
    'title'             => 'Performance',
    'type'              => MENU_DEFAULT_LOCAL_TASK,
    'file path'         => drupal_get_path('module', 'system'),
  );
  $items['admin/settings/performance/expire'] = array(
    'type'              => MENU_LOCAL_TASK,
    'title'             => 'Cache Expiration',
    'page callback'     => 'drupal_get_form',
    'page arguments'    => array('expire_admin_settings_form'),
    'access arguments'  => array('administer site configuration'),
31
    'file path'         => drupal_get_path('module', 'expire'),
32 33 34 35 36 37
    'file'              => 'expire.admin.inc',
  );

  return $items;
}

Mike Carper's avatar
Mike Carper committed
38
/**
39 40 41
 * Implementation of hook_comment().
 *
 * Acts on comment modification.
Mike Carper's avatar
Mike Carper committed
42 43
 */
function expire_comment($comment, $op) {
44 45
  // Convert array to object
  if (is_array($comment)) {
46
    $comment = (object) $comment;
47 48
  }

49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
  // Return if no node id is attached to the comment.
  if (empty($comment->nid)) {
    return;
  }

  // Select which comment opperations require a cache flush.
  $cases = array(
    'insert',
    'update',
    'publish',
    'unpublish',
    'delete',
  );

  // Expire the relevant node page from the static page cache to prevent serving stale content.
  if (in_array($op, $cases)) {
    $node = node_load($comment->nid);
    if ($node) {
      expire_node($node);
    }
Mike Carper's avatar
Mike Carper committed
69 70 71 72
  }
}

/**
73 74 75
 * Implementation of hook_nodeapi().
 *
 * Acts on nodes defined by other modules.
Mike Carper's avatar
Mike Carper committed
76 77
 */
function expire_nodeapi(&$node, $op, $teaser = NULL, $page = NULL) {
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
  // Return if no node id is attached to the node object.
  if (empty($node->nid)) {
    return;
  }

  // Select which node opperations require a cache flush.
  $cases = array(
    'insert',
    'update',
    'delete',
    'delete revision',
  );

  // Expire the relevant node page from the static page cache to prevent serving stale content.
  if (in_array($op, $cases)) {
    expire_node($node);
  }
}

/**
 * Implementation of hook_user().
 *
 * Acts on user account actions: expire the relevant user page from the static
 * page cache to prevent serving stale content.
 */
function expire_user($op, &$edit, &$account, $category = NULL) {
  // Return if no user id is attached to the user object.
  if (empty($account->uid)) {
    return;
  }

  // Select which user opperations require a cache flush.
  $cases = array(
    'insert',
    'update',
    'after update',
  );

  // Expire the relevant user page from the static page cache to prevent serving stale content.
  if (in_array($op, $cases)) {
    $paths[] = 'user/' . $account->uid;
119
    $flushed = expire_cache_derivative($paths, $account);
120 121 122 123
    watchdog('expire', 'User !uid was deleted resulting in !flushed pages being expired from the cache',  array(
      '!uid' => $account->uid,
      '!flushed' => $flushed,
    ));
Mike Carper's avatar
Mike Carper committed
124 125 126 127 128 129 130 131 132 133
  }
}

/**
 * Implementation of hook_votingapi_insert().
 *
 * @param $votes
 *  array of votes
 */
function expire_votingapi_insert($votes) {
134
  _expire_votingapi($votes);
Mike Carper's avatar
Mike Carper committed
135 136 137 138 139 140 141 142 143
}

/**
 * Implementation of hook_votingapi_delete().
 *
 * @param $votes
 *  array of votes
 */
function expire_votingapi_delete($votes) {
144 145 146 147 148 149 150
  _expire_votingapi($votes);
}

/**
 * Common expiry logic for votingapi.
 */
function _expire_votingapi($votes) {
Mike Carper's avatar
Mike Carper committed
151
  foreach ($votes as $vote) {
152
    if ($vote['content_type'] == 'comment') {
153 154 155 156 157 158 159
      $nid = db_result(db_query("SELECT nid FROM {comments} WHERE cid = %d", $vote['content_id']));
      if (is_numeric($nid)) {
        $node = node_load($nid);
        if ($node) {
          expire_node($node);
        }
      }
160 161 162
    }
    if ($vote['content_type'] == 'node') {
      $node = node_load($vote['content_id']);
163 164
      if ($node) {
        expire_node($node);
Mike Carper's avatar
Mike Carper committed
165
      }
166
    }
Mike Carper's avatar
Mike Carper committed
167 168 169 170 171 172 173 174 175 176 177
  }
}

/**
 * Expires a node from the cache; including related pages.
 *
 * Expires front page if promoted, taxonomy terms,
 *
 * @param $node
 *  node object
 */
178
function expire_node(&$node) {
Mike Carper's avatar
Mike Carper committed
179 180 181 182 183 184 185 186 187 188 189
  $paths = array();

  // Check node object
  if (empty($node->nid)) {
    return FALSE;
  }

  // Expire this node
  $paths['node'] = 'node/' . $node->nid;

  // If promoted to front page, expire front page
190
  if (variable_get('expire_flush_front', EXPIRE_FLUSH_FRONT) && $node->promote == 1) {
Mike Carper's avatar
Mike Carper committed
191 192 193 194
    $paths['front'] = '<front>';
  }

  // Get taxonomy terms and flush
195 196
  if (module_exists('taxonomy') && variable_get('expire_flush_node_terms', EXPIRE_FLUSH_NODE_TERMS)) {
    // Get old terms from DB
Mike Carper's avatar
updated  
Mike Carper committed
197
    $tids = expire_taxonomy_node_get_tids($node->nid);
198 199 200 201 202 203 204
    // Get old terms from static variable
    $terms = taxonomy_node_get_terms($node);
    if (!empty($terms)) {
      foreach ($terms as $term) {
        $tids[$term->tid] = $term->tid;
      }
    }
205 206 207 208 209 210 211 212 213 214
    // Get new terms from node object
    if (!empty($node->taxonomy)) {
      foreach ($node->taxonomy as $vocab) {
        if (is_array($vocab)) {
          foreach ($vocab as $term) {
            $tids[$term] = $term;
          }
        }
      }
    }
Mike Carper's avatar
Mike Carper committed
215 216
    $filenames = array();
    foreach ($tids as $tid) {
217
      if (is_numeric($tid)) {
218 219
        $term = taxonomy_get_term($tid);
        $paths['term' . $tid] = taxonomy_term_path($term);
Mike Carper's avatar
Mike Carper committed
220 221 222 223 224
      }
    }
  }

  // Get menu and flush related items in the menu.
225
  if (variable_get('expire_flush_menu_items', EXPIRE_FLUSH_MENU_ITEMS) !=0) {
Mike Carper's avatar
Mike Carper committed
226 227 228 229
    if (!isset($node->menu['menu_name'])) {
      menu_nodeapi($node, 'prepare');
    }
    $menu = menu_tree_all_data($node->menu['menu_name']);
230 231 232 233
    $tempa = NULL;
    $tempb = NULL;
    if (variable_get('expire_flush_menu_items', EXPIRE_FLUSH_MENU_ITEMS) == 1) {
      $links = expire_get_menu_structure($menu, FALSE, 'node/' . $node->nid, NULL, $tempa, $tempb);
Mike Carper's avatar
Mike Carper committed
234
    }
235 236
    elseif (variable_get('expire_flush_menu_items', EXPIRE_FLUSH_MENU_ITEMS) == 2) {
      $links = expire_get_menu_structure($menu, NULL, NULL, NULL, $tempa, $tempb);
Mike Carper's avatar
Mike Carper committed
237
    }
238 239
    unset($tempa);
    unset($tempb);
Mike Carper's avatar
Mike Carper committed
240 241 242 243
    $paths = array_merge($links, $paths);
  }

  // Get CCK References and flush.
244
  if (variable_get('expire_flush_cck_references', EXPIRE_FLUSH_CCK_REFERENCES) && module_exists('nodereference')) {
Mike Carper's avatar
Mike Carper committed
245 246 247 248 249 250 251 252 253
    $nids = array();
    $type = content_types($node->type);
    if ($type) {
      foreach ($type['fields'] as $field) {
        // Add referenced nodes to nids. This will clean up nodereferrer fields
        // when the referencing node is updated.
        if ($field['type'] == 'nodereference') {
          $node_field = isset($node->$field['field_name']) ? $node->$field['field_name'] : array();
          foreach ($node_field as $delta => $item) {
254
            if (is_numeric($item['nid'])) {
255 256 257 258 259 260 261 262 263 264 265 266 267 268 269
              $paths['reference' . $item['nid']] = 'node/'. $item['nid'];
            }
          }

          // Look for node referers without using nodereferrer
          $info = content_database_info($field);
          $table = $info['table'];
          $column = $info['columns']['nid']['column'];
          $results = db_query("SELECT n.nid
            FROM {%s} nr
            INNER JOIN {node} n USING (vid)
            WHERE nr.%s = %d", $table, $column, $node->nid);
          while ($nid = db_result($results)) {
            if (is_numeric($nid)) {
              $paths['referenceparent' . $nid] = 'node/'. $nid;
270
            }
Mike Carper's avatar
Mike Carper committed
271 272 273 274 275 276 277 278 279
          }
        }
      }
    }

    // Get CCK references pointing to this node and flush.
    if (module_exists('nodereferrer')) {
      $nids = nodereferrer_referrers($node->nid);
      foreach ($nids as $nid) {
280
        if (is_numeric($nid['nid'])) {
Mike Carper's avatar
Mike Carper committed
281 282 283 284 285 286 287 288
          $paths['referrer' . $nid['nid']] = 'node/' . $nid['nid'];
        }
      }
    }
  }

  // Flush array of paths
  if (!empty($paths)) {
289
    $flushed = expire_cache_derivative($paths, $node);
290 291 292 293
    watchdog('expire', 'Node !nid was flushed resulting in !flushed pages being expired from the cache',  array(
      '!nid' => $node->nid,
      '!flushed' => $flushed,
    ));
Mike Carper's avatar
Mike Carper committed
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313
  }
}

/**
 * Finds parent, siblings and children of the menu item. UGLY CODE...
 *
 * @param array $menu
 *  Output from menu_tree_all_data()
 * @param bool $found
 *  Signal for when the needle was found in the menu array.
 *  Set TRUE to get entire menu
 * @param string $needle
 *  Name of menu link. Example 'node/21'
 * @param bool $first
 *  Keep track of the first call; this is a recursive function.
 * @param bool &$found_global
 *  Used to signal the parent item was found in one of it's children
 * @param bool &$menu_out
 *  Output array of parent, siblings and children menu links
 */
314 315 316 317 318
function expire_get_menu_structure($menu, $found, $needle, $first, &$found_global, &$menu_out) {
  // Set Defaults
  $found = !is_null($found) ? $found : TRUE;
  $needle = !is_null($needle) ? $needle : '';
  $first = !is_null($first) ? $first : TRUE;
Mike Carper's avatar
Mike Carper committed
319
  $found_global = FALSE;
320 321
  $menu_out = !is_null($menu_out) ? $menu_out : array();

Mike Carper's avatar
Mike Carper committed
322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358
  // Get Siblings
  foreach ($menu as $item) {
    if ($item['link']['hidden'] == 0 && $item['link']['page_callback'] != '' && ($item['link']['link_path'] == $needle || $found)) {
      $menu_out[] = $item['link']['link_path'];
      $found = TRUE;
    }
  }
  // Get Children
  foreach ($menu as $item) {
    if ($item['link']['hidden'] != 0) {
      continue;
    }
    if ($item['link']['page_callback'] != '' && ($item['link']['link_path'] == $needle || $found)) {
      $menu_out[] = $item['link']['link_path'];
      $found = TRUE;
    }
    // Get Grandkids
    if (!empty($item['below'])) {
      $sub_menu = array();
      foreach ($item['below'] as $below) {
        if ($below['link']['hidden'] == 0) {
          $sub_menu[] = $below;
        }
      }
      expire_get_menu_structure($sub_menu, $needle, $found, FALSE, $found_global, $menu_out);
      $structure[$item['link']['link_path']][] = $sub;
      if ($item['link']['page_callback'] != '' && $found_global) {
        // Get Parent of kid
        $menu_out[] = $item['link']['link_path'];
      }
    }
    else {
      $structure[$item['link']['link_path']] = '';
    }
  }

  // Clean up
359
  if (isset($structure) && is_array($structure)) {
Mike Carper's avatar
Mike Carper committed
360 361 362 363
    $structure = array_unique($structure);
  }
  $found_global = $found;
  if ($first) {
364 365 366 367 368 369 370 371
    if (isset($menu_out) && is_array($menu_out)) {
      $menu_out = array_unique($menu_out);
      sort($menu_out);
      return $menu_out;
    }
    else {
      return array();
    }
Mike Carper's avatar
Mike Carper committed
372 373 374 375 376 377 378 379 380 381 382 383 384
  }
  else {
    return $structure;
  }
}

/**
 * Return taxonomy terms given a nid.
 *
 * Needed because of a weird bug with CCK & node_load()
 *  http://drupal.org/node/545922
 */
function expire_taxonomy_node_get_tids($nid) {
385 386
  $vid = db_result(db_query("SELECT vid FROM {node} WHERE nid = %d", $nid));
  $result = db_query(db_rewrite_sql("SELECT t.tid FROM {term_node} r INNER JOIN {term_data} t ON r.tid = t.tid INNER JOIN {vocabulary} v ON t.vid = v.vid WHERE r.vid = %d ORDER BY v.weight, t.weight, t.name", 't', 'tid'), $vid);
Mike Carper's avatar
Mike Carper committed
387 388 389 390 391 392 393 394 395 396 397 398
  $tids = array();
  while ($term = db_result($result)) {
    $tids[] = $term;
  }
  return $tids;
}

/**
 * Finds all possible paths/redirects/aliases given the root path.
 *
 * @param $paths
 *   Array of current URLs
399 400
 * @param $node
 *   node object
Mike Carper's avatar
Mike Carper committed
401
 */
402
function expire_cache_derivative($paths, &$node = NULL) {
Mike Carper's avatar
Mike Carper committed
403 404 405 406 407 408
  global $base_path;
  $expire = array();

  if (empty($paths)) {
    return FALSE;
  }
409
  $site_frontpage = variable_get('site_frontpage', 'node');
Mike Carper's avatar
Mike Carper committed
410
  foreach ($paths as $path) {
411 412
    // Special front page handling
    if ($path == $site_frontpage || $path == '' || $path == '<front>') {
413 414
      $expire[] = '';
      $expire[] = 'rss.xml';
415
      $expire[] = $site_frontpage;
416 417
    }

418 419 420
    // Add given path
    if ($path != '<front>') {
      $expire[] = $path;
Mike Carper's avatar
Mike Carper committed
421 422 423 424
    }

    // Path alias
    $path_alias = url($path, array('absolute' => FALSE));
425 426
    // Remove the base path
    $expire[] = substr($path_alias, strlen($base_path));
Mike Carper's avatar
Mike Carper committed
427 428 429 430 431 432 433 434 435 436 437 438

    // Path redirects
    if (module_exists('path_redirect')) {
      $path_redirects = expire_path_redirect_load(array('redirect' => $path));
      if (isset($path_redirects)) {
        foreach ($path_redirects as $path_redirect) {
          $expire[] = $path_redirect['path'];
        }
      }
    }
  }

439 440 441
  // Allow other modules to modify the list prior to expiring
  drupal_alter('expire_cache', $expire, $node, $paths);

Mike Carper's avatar
Mike Carper committed
442 443 444 445 446 447 448 449
  // Expire cached files
  if (empty($expire)) {
    return FALSE;
  }
  $expire = array_unique($expire);
  // Add on the url to these paths
  $urls = array();
  global $base_url;
450 451 452 453 454 455
  if (variable_get('expire_include_base_url', EXPIRE_INCLUDE_BASE_URL)) {
    foreach (expire_get_base_urls($node) as $domain_id) {
      foreach ($domain_id as $base) {
        foreach ($expire as $path) {
          $urls[] = $base . $path;
        }
456 457
      }
    }
Mike Carper's avatar
Mike Carper committed
458
  }
459 460 461
  else {
    $urls = $expire;
  }
Mike Carper's avatar
Mike Carper committed
462
  // hook_expire_cache
463 464
  $modules = module_implements('expire_cache');
  foreach ($modules as $module) {
Mike Carper's avatar
Mike Carper committed
465 466
    module_invoke($module, 'expire_cache', $urls);
  }
467 468 469 470 471
  watchdog('expire', 'Input: !paths <br /> Output: !urls <br /> Modules Using hook_expire_cache(): !modules', array(
    '!paths' => expire_print_r($paths),
    '!urls' => expire_print_r($urls),
    '!modules' => expire_print_r($modules),
  ));
Mike Carper's avatar
Mike Carper committed
472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506
  return count($urls);
}

/**
 * Retrieve a specific URL redirect from the database.
 * http://drupal.org/node/451790
 *
 * @param $where
 *   Array containing 'redirect' => $path
 */
function expire_path_redirect_load($where = array(), $args = array(), $sort = array()) {
  $redirects = array();
  if (is_numeric($where)) {
    $where = array('rid' => $where);
  }

  foreach ($where as $key => $value) {
    if (is_string($key)) {
      $args[] = $value;
      $where[$key] = $key .' = '. (is_numeric($value) ? '%d' : "'%s'");
    }
  }

  if ($where && $args) {
    $sql = "SELECT * FROM {path_redirect} WHERE ". implode(' AND ', $where);
    if ($sort) {
      $sql .= ' ORDER BY '. implode(' ,', $sort);
    }
    $result = db_query($sql, $args);
    while ($redirect = db_fetch_array($result)) {
      $redirects[] = $redirect;
    }
    return $redirects;
  }
}
507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552

/**
 * Simple print_r to html function
 *
 * @param $data
 *
 * @return string
 *   print_r contents in nicely formatted html
 */
function expire_print_r($data) {
  return str_replace('    ', '&nbsp;&nbsp;&nbsp;&nbsp;', nl2br(htmlentities(print_r($data, TRUE))));
}

/**
 * Get all base url's where this node can appear. Domain access support.
 *
 * @param $node
 *   node object
 * @return array
 *   array(0 => array($base_url . '/'))
 */
function expire_get_base_urls(&$node) {
  global $base_url, $base_path;

  // Get list of URL's if using domain access
  $base_urls = array();
  $domains = array();
  if (module_exists('domain') && isset($node->domains)) {
    // Get domains from node/user object
    foreach ($node->domains as $key => $domain_id) {
      if ($key != $domain_id) {
        continue;
      }
      $domains[$domain_id] = $domain_id;
    }
    // Get domains from database
    foreach (expire_get_domains($node) as $domain_id) {
      $domains[$domain_id] = $domain_id;
    }
    // Get aliases and set base url
    foreach ($domains as $domain_id) {
      $domain = domain_lookup($domain_id);
      if ($domain['valid'] == 1) {
        if (isset($domain['path'])) {
          $base_urls[$domain_id][] = $domain['path'];
        }
553 554 555 556 557 558
        if (is_array($domain['aliases'])) {
          foreach ($domain['aliases'] as $alias) {
            if ($alias['redirect'] != 1) {
              $temp_domain = array('scheme' => $domain['scheme'], 'subdomain' => $alias['pattern']);
              $base_urls[$domain_id][] = domain_get_path($temp_domain);
            }
559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595
          }
        }
      }
    }
  }
  else {
    $base_urls[0][] = $base_url . '/';
  }
  return $base_urls;
}

/**
 * Get domains the node is currently published to
 *
 * @param $node
 *   node object
 * @return array
 *   array('$gid' => $gid)
 */
function expire_get_domains(&$node) {
  $domains = array();
  if ($node->nid) {
    $result = db_query("SELECT gid FROM {domain_access} WHERE nid = %d", $node->nid);
    while ($row = db_fetch_array($result)) {
      $gid = $row['gid'];
      $domains[$gid] = $gid;
    }
  }
  elseif ($node->mail && $node->name) {
    $result = db_query("SELECT domain_id FROM {domain_editor} WHERE uid = %d", $node->uid);
    while ($row = db_fetch_array($result)) {
      $gid = $row['domain_id'];
      $domains[$gid] = $gid;
    }
  }
  return $domains;
}
596

597 598 599 600 601 602 603 604
function expire_normal_path_check($path) {
  $original_map = arg(NULL, $path);
  $parts = array_slice($original_map, 0, MENU_MAX_PARTS);
  list($ancestors, $placeholders) = menu_get_ancestors($parts);

  $router_item = db_fetch_array(db_query_range('SELECT path FROM {menu_router} WHERE path IN (' . implode(',', $placeholders) . ') ORDER BY fit DESC', $ancestors, 0, 1));
  return $router_item;
}