memcache.inc 3.75 KB
Newer Older
1
<?php
robertDouglass's avatar
robertDouglass committed
2
// $Id$
3

4
require_once 'dmemcache.inc';
5 6 7 8 9 10 11 12 13 14 15 16 17

/** Implementation of cache.inc with memcache logic included **/

/**
 * Return data from the persistent cache.
 *
 * @param $key
 *   The cache ID of the data to retrieve.
 * @param $table
 *   The table $table to store the data in. Valid core values are 'cache_filter',
 *   'cache_menu', 'cache_page', or 'cache' for the default cache.
 */
function cache_get($key, $table = 'cache') {
18
  return dmemcache_get($key, $table);
19
}
20

21
/**
22
 * Store data in memcache.
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
 *
 * @param $cid
 *   The cache ID of the data to store.
 * @param $table
 *   The table $table to store the data in. Valid core values are 'cache_filter',
 *   'cache_menu', 'cache_page', or 'cache'.
 * @param $data
 *   The data to store in the cache. Complex data types must be serialized first.
 * @param $expire
 *   One of the following values:
 *   - CACHE_PERMANENT: Indicates that the item should never be removed unless
 *     explicitly told to using cache_clear_all() with a cache ID.
 *   - CACHE_TEMPORARY: Indicates that the item should be removed at the next
 *     general cache wipe.
 *   - A Unix timestamp: Indicates that the item should be kept at least until
 *     the given time, after which it behaves like CACHE_TEMPORARY.
 * @param $headers
 *   A string containing HTTP header information for cached pages.
41 42 43 44
 * @param $db_storage
 *   This boolean is unique to the memcache.inc implementation of cache set.
 *   It allows us to do a cache_set and not write to the database, but only
 *   to memcache.
45
 */
46
function cache_set($cid, $table = 'cache', $data, $expire = CACHE_PERMANENT, $headers = NULL) {
Steve Rude's avatar
Steve Rude committed
47 48
  $time = time();

49 50 51
  // Create new cache object.
  $cache = new stdClass;
  $cache->cid = $cid;
52
  $cache->data = is_object($data) ? memcache_clone($data) : $data;
Steve Rude's avatar
Steve Rude committed
53
  $cache->created = $time;
54 55 56 57
  $cache->expire = $expire;
  $cache->headers = $headers;

  // Save to memcache
Steve Rude's avatar
Steve Rude committed
58 59
  if ($expire == CACHE_TEMPORARY) {
    $expire = variable_get('cache_lifetime', 2591999);
60
  }
Steve Rude's avatar
Steve Rude committed
61
  dmemcache_set($cid, $cache, $expire, $table);
62 63 64 65
}

/**
 *
66 67 68 69 70 71 72 73 74 75
 * Expire data from the cache. If called without arguments, expirable
 * entries will be cleared from the cache_page table.
 *
 * @param $cid
 *   If set, the cache ID to delete. Otherwise, all cache entries that can
 *   expire are deleted.
 *
 * @param $table
 *   If set, the table $table to delete from. Mandatory
 *   argument if $cid is set.
76
 *
77 78 79 80
 * @param $wildcard
 *   If set to TRUE, the $cid is treated as a substring
 *   to match rather than a complete ID. The match is a right hand
 *   match. If '*' is given as $cid, the table $table will be emptied.
81
 */
82 83 84 85 86
function cache_clear_all($cid = NULL, $table = NULL, $wildcard = FALSE) {
  // Memcache logic is simpler because memcache doesn't have a minimum cache
  // lifetime consideration (it handles it internally), and doesn't support
  // wildcards.
  $bin = empty($table) ? 'cache' : $table;
87
  if (empty($cid) || ($cid == '*' && $wildcard !== TRUE)) {
Steve Rude's avatar
Steve Rude committed
88
    // don't do anything if cid is unset. this matches the default drupal behavior...
89 90 91 92 93 94 95 96
    if ($wildcard && $cid != '*') {
      if (variable_get('memcache_debug', FALSE)) {
        // call watchdog, since you probably didn't want to flush the entire bin.
        watchdog('memcache', "illegal wildcard in cache_clear_all - not flushing entire bin. table: $table. cid: $cid", WATCHDOG_WARNING);
      }
    }
  }
  else if ($cid == '*' || $wildcard === TRUE) {
97 98 99 100 101 102
    dmemcache_flush($table);
  }
  else {
    dmemcache_delete($cid, $table);
  }
}
103 104 105 106 107 108 109 110 111

/**
 * Provide a substitute clone() function for PHP4. This is a copy of drupal_clone
 * because common.inc isn't included early enough in the bootstrap process to
 * be able to depend on drupal_clone.
 */
function memcache_clone($object) {
  return version_compare(phpversion(), '5.0') < 0 ? $object : clone($object);
}