Newer
Older
Robert Douglass
committed
<?php
Robert Douglass
committed
require_once 'dmemcache.inc';
Robert Douglass
committed
/**
* Defines the period after which wildcard clears are not considered valid.
*/
define('MEMCACHE_WILDCARD_INVALIDATE', 86400 * 28);
Robert Douglass
committed
/** Implementation of cache.inc with memcache logic included **/
class MemCacheDrupal implements DrupalCacheInterface {
function __construct($bin) {
$this->memcache = dmemcache_object($bin);
$this->bin = $bin;
Jeremy Andrews
committed
$this->wildcard_flushes = variable_get('memcache_wildcard_flushes', array());
$this->invalidate = variable_get('memcache_wildcard_invalidate', MEMCACHE_WILDCARD_INVALIDATE);
$this->cache_lifetime = variable_get('cache_lifetime', 0);
$this->cache_flush = variable_get('cache_flush_' . $this->bin);
$this->flushed = min($this->cache_flush, REQUEST_TIME - $this->cache_lifetime);
}
function get($cid) {
$cache = dmemcache_get($cid, $this->bin, $this->memcache);
return $this->valid($cid, $cache) ? $cache : FALSE;
}
function getMultiple(&$cids) {
Jeremy Andrews
committed
$results = dmemcache_get_multi($cids, $this->bin, $this->memcache);
foreach ($results as $cid => $result) {
Jeremy Andrews
committed
if (!$this->valid($result->cid, $result)) {
// This object has expired, so don't return it.
unset($results[$cid]);
}
else {
// Remove items from the referenced $cids array that we are returning,
// per the comment in cache_get_multiple() in includes/cache.inc.
Jeremy Andrews
committed
unset($cids[$result->cid]);
}
}
return $results;
}
protected function valid($cid, $cache) {
if (!isset($cache) || !is_object($cache)) {
Jeremy Andrews
committed
return FALSE;
// The wildcard_valid() function has overhead due to a call to
// dmemcache_get_multi() to fetch possible wildcard flushes. Since some
// bins never have wildcard clears with a cid, we can shortcut these checks.
Jeremy Andrews
committed
if (!empty($this->wildcard_flushes[$this->bin]) &&
max($this->wildcard_flushes[$this->bin]) >= (REQUEST_TIME - $this->invalidate) &&
!$this->wildcard_valid($cid, $cache)) {
return FALSE;
}
// Determine when the current bin was last flushed.
$item_flushed_globally = $cache->created && $this->cache_flush &&
$this->cache_lifetime &&
($cache->created <= $this->flushed);
// Look in the session to determine if this item was flushed for the
// current user (ie, if they posted a comment and are viewing a cached page)
$cache_bins = isset($_SESSION['cache_flush']) ? $_SESSION['cache_flush'] : NULL;
$item_flushed_for_user = !empty($cache_bins) &&
isset($cache_bins[$this->bin]) &&
($cache->created < $cache_bins[$this->bin]);
if ($item_flushed_for_user) {
return FALSE;
}
// The item can be expired if:
// - A liftetime is set and the item is older than both the lifetime and
// the global flush.
// - The item has been create before the bin was flushed for this user.
// - The item could simply expire.
//
// For the two global cases we try and grab a lock. If we get the lock, we
// return FALSE instead of the cached object which should cause it to be
// rebuilt. If we do not get the lock, we return the cached object despite
// it's expired The goal here is to avoid cache stampedes.
// By default the cache stampede semaphore is held for 15 seconds. This
// can be adjusted by setting the memcache_stampede_semaphore variable.
$item_expired = isset($cache->expire) &&
$cache->expire !== CACHE_PERMANENT &&
$cache->expire <= REQUEST_TIME;
if ($item_flushed_globally || $item_expired) {
// To avoid a stampede, return TRUE despite the item being expired if
// a previous process set the stampede semaphore already. However only
// do this if the data is less than 30 minutes stale.
if ((REQUEST_TIME - $cache->expire) >= variable_get('memcache_max_staleness', 1800) ||
dmemcache_add($cid . '_semaphore', '', variable_get('memcache_stampede_semaphore', 15), $this->bin)) {
return FALSE;
}
}
return TRUE;
}
function set($cid, $data, $expire = CACHE_PERMANENT, array $headers = NULL) {
$created = REQUEST_TIME;
Robert Douglass
committed
// Create new cache object.
$cache = new stdClass;
$cache->cid = $cid;
$cache->data = is_object($data) ? clone $data : $data;
$cache->created = $created;
$cache->headers = $headers;
Jeremy Andrews
committed
// Record the previous number of wildcard flushes affecting our cid.
$cache->flushes = $this->wildcard_flushes($cid);
if ($expire == CACHE_TEMPORARY) {
// Convert CACHE_TEMPORARY (-1) into something that will live in memcache
// until the next flush.
$cache->expire = REQUEST_TIME + 2591999;
}
// Expire time is in seconds if less than 30 days, otherwise is a timestamp.
else if ($expire != CACHE_PERMANENT && $expire < 2592000) {
// Expire is expressed in seconds, convert to the proper future timestamp
// as expected in dmemcache_get().
$cache->expire = REQUEST_TIME + $expire;
}
else {
$cache->expire = $expire;
}
Robert Douglass
committed
// We manually track the expire time in $cache->expire. When the object
// expires, we only allow one request to rebuild it to avoid cache
// stampedes. Other requests for the expired object while it is still being
// rebuilt get the expired object.
dmemcache_set($cid, $cache, 0, $this->bin, $this->memcache);
function clear($cid = NULL, $wildcard = FALSE) {
if (empty($cid) || $wildcard === TRUE) {
Jeremy Andrews
committed
if ($cid == '*') {
$cid = '';
}
if ($this->cache_lifetime && empty($cid)) {
// Update the timestamp of the last global flushing of this bin. When
// retrieving data from this bin, we will compare the cache creation
// time minus the cache_flush time to the cache_lifetime to determine
// whether or not the cached item is still valid.
variable_set("cache_flush_$this->bin", REQUEST_TIME);
$this->flushed = REQUEST_TIME;
// We store the time in the current user's session which is saved into
// the sessions table by sess_write(). We then simulate that the cache
// was flushed for this user by not returning cached data to this user
// that was cached before the timestamp.
if (isset($_SESSION['cache_flush']) && is_array($_SESSION['cache_flush'])) {
$cache_bins = $_SESSION['cache_flush'];
}
else {
$cache_bins = array();
}
$cache_bins[$this->bin] = REQUEST_TIME;
$_SESSION['cache_flush'] = $cache_bins;
}
else {
Jeremy Andrews
committed
// Register a wildcard flush for current cid
$this->wildcards($cid, TRUE);
}
}
else {
$cids = is_array($cid) ? $cid : array($cid);
foreach ($cids as $cid) {
dmemcache_delete($cid, $this->bin, $this->memcache);
}
}
}
Jeremy Andrews
committed
/**
* Sum of all matching wildcards. Checking any single cache item's flush
* value against this single-value sum tells us whether or not a new wildcard
* flush has affected the cached item.
Jeremy Andrews
committed
*/
private function wildcard_flushes($cid) {
return array_sum($this->wildcards($cid));
}
/**
* Utilize multiget to retrieve all possible wildcard matches, storing
* statically so multiple cache requests for the same item on the same page
* load doesn't add overhead.
Jeremy Andrews
committed
*/
private function wildcards($cid, $flush = FALSE) {
static $wildcards = array();
$matching = array();
Jeremy Andrews
committed
if (isset($this->wildcard_flushes[$this->bin]) &&
is_array($this->wildcard_flushes[$this->bin])) {
// Determine which lookups we need to perform to determine whether or not
// our cid was impacted by a wildcard flush.
$lookup = array();
// Find statically cached wildcards, and determine possibly matching
// wildcards for this cid based on a history of the lengths of past
// valid wildcard flushes in this bin.
Jeremy Andrews
committed
foreach ($this->wildcard_flushes[$this->bin] as $length => $timestamp) {
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
if ($timestamp >= (REQUEST_TIME - $this->invalidate)) {
$key = '.wildcard-' . substr($cid, 0, $length);
$wildcard = dmemcache_key($key, $this->bin);
if (isset($wildcards[$this->bin][$wildcard])) {
$matching[$wildcard] = $wildcards[$this->bin][$wildcard];
}
else {
$lookup[$wildcard] = $key;
}
}
}
// Do a multi-get to retrieve all possibly matching wildcard flushes.
if (!empty($lookup)) {
$values = dmemcache_get_multi($lookup, $this->bin, $this->memcache);
if (is_array($values)) {
// Prepare an array of matching wildcards.
$matching = array_merge($matching, $values);
// Store matches in the static cache.
if (isset($wildcards[$this->bin])) {
$wildcards[$this->bin] = array_merge($wildcards[$this->bin], $values);
}
else {
$wildcards[$this->bin] = $values;
}
$lookup = array_diff_key($lookup, $values);
}
// Also store failed lookups in our static cache, so we don't have to
// do repeat lookups on single page loads.
foreach ($lookup as $wildcard => $key) {
$wildcards[$this->bin][$wildcard] = 0;
}
Jeremy Andrews
committed
}
}
if ($flush) {
// Avoid too many calls to variable_set() by only recording a flush for
// a fraction of the wildcard invalidation variable, per cid length.
// Defaults to 28 / 4, or one week.
$length = strlen($cid);
Jeremy Andrews
committed
if (!isset($this->wildcard_flushes[$this->bin][$length]) ||
($_SERVER['REQUEST_TIME'] - $this->wildcard_flushes[$this->bin][$length] > $this->invalidate / 4)) {
$this->wildcard_flushes = variable_get('memcache_wildcard_flushes', array());
$this->wildcard_flushes[$this->bin][$length] = $_SERVER['REQUEST_TIME'];
variable_set('memcache_wildcard_flushes', $this->wildcard_flushes);
}
$wildcard = dmemcache_key('.wildcard-' . $cid, $this->bin);
if (isset($wildcards[$this->bin][$wildcard]) && $wildcards[$this->bin][$wildcard] != 0) {
$this->memcache->increment($wildcard);
$wildcards[$this->bin][$wildcard]++;
Jeremy Andrews
committed
}
else {
$wildcards[$this->bin][$wildcard] = 1;
dmemcache_set('.wildcard-' . $cid, '1', 0, $this->bin);
Jeremy Andrews
committed
}
}
return $matching;
Jeremy Andrews
committed
}
/**
* Check if a wildcard flush has invalidated the current cached copy.
*/
private function wildcard_valid($cid, $cache) {
// Previously cached content won't have ->flushes defined. We could
// force flush, but instead leave this up to the site admin.
$flushes = isset($cache->flushes) ? (int)$cache->flushes : 0;
if ($flushes < (int)$this->wildcard_flushes($cid)) {
Jeremy Andrews
committed
return FALSE;
}
return TRUE;
}
function isEmpty() {
// We do not know so err on the safe side?
return FALSE;
Robert Douglass
committed
}
}