memcache.inc 13.3 KB
Newer Older
1
2
3
<?php
// $ID$

4
5
6
global $memcache_statistics;
$memcache_statistics = array('get' => 0, 'set' => 0, 'hit' => 0);

7
8
9
10
11
12
/*
 * A memcache API for Drupal.
 */

/**
 *  Place an item into memcache
13
 *
14
15
16
17
18
19
20
21
22
23
24
 * @param $key The string with with you will retrieve this item later.
 * @param $value The item to be stored.
 * @param $exp Parameter expire is expiration time in seconds. If it's 0, the item never expires
 *   (but memcached server doesn't guarantee this item to be stored all the time, it could be
 *   deleted from the cache to make place for other items).
 * @param $bin The name of the Drupal subsystem that is making this call. Examples could be
 *   'cache', 'alias', 'taxonomy term' etc. It is possible to map different $bin values to
 *   different memcache servers.
 *
 * @return bool
 */
25
function dmemcache_set($key, $value, $exp = 0, $bin = 'cache') {
26
27
  global $memcache_statistics;
  $memcache_statistics['set']++;
28
29
  if ($mc = dmemcache_object($bin)) {
    $full_key = dmemcache_key($key, $bin);
30
    if (!$mc->set($full_key, $value, TRUE, $exp)) {
31
      watchdog('memcache', 'Failed to set key: ' . $full_key, WATCHDOG_ERROR);
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
    }
    else {
      return TRUE;
    }
  }
  return FALSE;
}

/**
 * Retrieve a value from the cache.
 *
 * @param $key The key with which the item was stored.
 * @param $bin The bin in which the item was stored.
 *
 * @return The item which was originally saved or FALSE
 */
48
function dmemcache_get($key, $bin = 'cache') {
49
50
  global $memcache_statistics;
  $memcache_statistics['get']++;
51
52
  if ($mc = dmemcache_object($bin)) {
    $full_key = dmemcache_key($key, $bin);
53
    $result = $mc->get($full_key);
54
55
56
    if ($result) {
      $memcache_statistics['hit']++;
    }
57
    return $result;
58
59
60
61
62
63
64
65
66
67
68
  }
}

/**
 * Deletes an item from the cache.
 *
 * @param $key The key with which the item was stored.
 * @param $bin The bin in which the item was stored.
 *
 * @return Returns TRUE on success or FALSE on failure.
 */
69
function dmemcache_delete($key, $bin = 'cache') {
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
  if ($mc = dmemcache_object($bin)) {
    $full_key = dmemcache_key($key, $bin);
    return $mc->delete($full_key);
  }
  return FALSE;
}

/**
 * Immediately invalidates all existing items. dmemcache_flush doesn't actually free any
 * resources, it only marks all the items as expired, so occupied memory will be overwritten by
 * new items.
 *
 * @param $bin The bin to flush. Note that this will flush all bins mapped to the same server
 *   as $bin. There is no way at this time to empty just one bin.
 *
 * @return Returns TRUE on success or FALSE on failure.
 */
87
function dmemcache_flush($bin = 'cache') {
88
89
90
91
92
  if ($mc = dmemcache_object($bin)) {
    return $mc->flush();
  }
}

93
function dmemcache_stats($bin = 'cache') {
94
95
96
97
98
99
  if ($mc = dmemcache_object($bin)) {
    return $mc->getStats();
  }
}

/**
100
101
102
 * Returns an Memcache object based on the bin requested. Note that there is
 * nothing preventing developers from calling this function directly to get the
 * Memcache object. Do this if you need functionality not provided by this API
103
 * or if you need to use legacy code. Otherwise, use the dmemcache (get, set,
104
 * delete, flush) API functions provided here.
105
 *
106
107
 * @param $bin The bin which is to be used.
 *
108
 * @param $flush Rebuild the bin/server/cache mapping.
109
110
111
 *
 * @return an Memcache object or FALSE.
 */
112
113
114
function dmemcache_object($bin = NULL, $flush = FALSE) {
  static $memcacheCache = array(), $memcache_servers, $memcache_bins;

robertDouglass's avatar
robertDouglass committed
115
  if ($flush) {
116
117
118
    foreach ($memcacheCache as $cluster) {
      $cluster->close();
    }
119
120
121
122
123
124
125
126
127
128
129
130
    $memcacheCache = array();
  }

  if (empty($memcacheCache) || empty($memcacheCache[$bin])) {
    // $memcache_servers and $memcache_bins originate from settings.php.
    // $memcache_servers_custom and $memcache_bins_custom get set by
    // memcache.module. They are then merged into $memcache_servers and
    // $memcache_bins, which are statically cached for performance.
    if (empty($memcache_servers)) {
      // Values from settings.php
      $memcache_servers = variable_get('memcache_servers', array('127.0.0.1:11211' => 'default'));
      $memcache_bins    = variable_get('memcache_bins', array('cache' => 'default'));
131

132
133
134
      // Merge overrides from memcache.module
      $memcache_servers = array_merge($memcache_servers, array_diff(variable_get('memcache_servers_custom', array()), $memcache_servers));
      $memcache_bins    = array_merge($memcache_bins, array_diff(variable_get('memcache_bins_custom', array()), $memcache_bins));
135
    }
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150

    // If there is no cluster for this bin in $memcache_bins, cluster is 'default'.
    $cluster = empty($memcache_bins[$bin]) ? 'default' : $memcache_bins[$bin];

    // If this bin isn't in our $memcache_bins configuration array, and the
    // 'default' cluster is already initialized, map the bin to 'cache' because
    // we always map the 'cache' bin to the 'default' cluster.
    if (empty($memcache_bins[$bin]) && !empty($memcacheCache['cache'])) {
      $memcacheCache[$bin] = &$memcacheCache['cache'];
    }
    else {
      // Create a new Memcache object. Each cluster gets its own Memcache object.
      $memcache = new Memcache;
      // A variable to track whether we've connected to the first server.
      $init = FALSE;
robertDouglass's avatar
robertDouglass committed
151
152

      // Link all the servers to this cluster.
153
154
155
156
      foreach ($memcache_servers as $s => $c) {
        if ($c == $cluster) {
          list($host, $port) = explode(':', $s);

robertDouglass's avatar
robertDouglass committed
157
          // This is a server that belongs to this cluster.
158
          if (!$init) {
robertDouglass's avatar
robertDouglass committed
159
            // First server gets the connect.
160
161
162
163
            if (@$memcache->connect($host, $port)) {
              // Only set init to true if a connection was made.
              $init = TRUE;
            }
164
          }
165
          else {
robertDouglass's avatar
robertDouglass committed
166
            // Subsequent servers gett addServer.
167
            @$memcache->addServer($host, $port);
168
169
          }
        }
170
171
      }

172
173
174
      if ($init) {
        // Map the current bin with the new Memcache object.
        $memcacheCache[$bin] = $memcache;
175

176
177
178
179
180
181
182
        // Now that all the servers have been mapped to this cluster, look for
        // other bins that belong to the cluster and map them too.
        foreach ($memcache_bins as $b => $c) {
          if ($c == $cluster && $b != $bin) {
            // Map this bin and cluster by reference.
            $memcacheCache[$b] = &$memcacheCache[$bin];
          }
183
184
185
        }
      }
    }
186
187
  }

188
  return empty($memcacheCache[$bin]) ? FALSE : $memcacheCache[$bin];
189
190
191
}

function dmemcache_key($key, $bin = 'cache') {
192
  static $prefix;
193
194
  // memcache_key_prefix can be set in settings.php to support site namespaces
  // in a multisite environment.
195
  if (empty($prefix)) {
196
197
    $prefix = variable_get('memcache_key_prefix', '');
  }
198
199
  $full_key = ($prefix ? $prefix. '-' : '') . $bin . '-' . $key;
  return urlencode($full_key);
200
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
228
229
230
231
232
233
234
235
236
237
238
239
}


/** 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') {
  global $user;

  // Garbage collection necessary when enforcing a minimum cache lifetime
  $cache_flush = variable_get('cache_flush', 0);
  if ($cache_flush && ($cache_flush + variable_get('cache_lifetime', 0) <= time())) {
    // Time to flush old cache data
    db_query("DELETE FROM {%s} WHERE expire != %d AND expire <= %d", $table, CACHE_PERMANENT, $cache_flush);
    variable_set('cache_flush', 0);
  }

  $cache = dmemcache_get($key, $table);
  if (empty($cache)) {
    $cache = db_fetch_object(db_query("SELECT data, created, headers, expire FROM {%s} WHERE cid = '%s'", $table, $key));
  }
  if (isset($cache->data)) {
    // If the data is permanent or we're not enforcing a minimum cache lifetime
    // always return the cached data.
    if ($cache->expire == CACHE_PERMANENT || !variable_get('cache_lifetime', 0)) {
      $cache->data = db_decode_blob($cache->data);
    }
    // If enforcing a minimum cache lifetime, validate that the data is
    // currently valid for this user before we return it by making sure the
    // cache entry was created before the timestamp in the current session's
    // cache timer. The cache variable is loaded into the $user object by
    // sess_read() in session.inc.
240
    else {
241
242
243
244
245
246
      if ($user->cache > $cache->created) {
        // This cache data is too old and thus not valid for us, ignore it.
        return 0;
      }
      else {
        $cache->data = db_decode_blob($cache->data);
247
248
      }
    }
249
    return $cache;
250
  }
251
252
  return 0;
}
253

254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
/**
 * Store data in the persistent cache.
 *
 * The persistent cache is split up into four database
 * tables. Contributed modules can add additional tables.
 *
 * 'cache_page': This table stores generated pages for anonymous
 * users. This is the only table affected by the page cache setting on
 * the administrator panel.
 *
 * 'cache_menu': Stores the cachable part of the users' menus.
 *
 * 'cache_filter': Stores filtered pieces of content. This table is
 * periodically cleared of stale entries by cron.
 *
 * 'cache': Generic cache storage table.
 *
 * The reasons for having several tables are as follows:
 *
 * - smaller tables allow for faster selects and inserts
 * - we try to put fast changing cache items and rather static
 *   ones into different tables. The effect is that only the fast
 *   changing tables will need a lot of writes to disk. The more
 *   static tables will also be better cachable with MySQL's query cache
 *
 * @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.
 */
function cache_set($cid, $table = 'cache', $data, $expire = CACHE_PERMANENT, $headers = NULL) {
  db_lock_table($table);
  db_query("UPDATE {%s} SET data = %b, created = %d, expire = %d, headers = '%s' WHERE cid = '%s'", $table, $data, time(), $expire, $headers, $cid);
  if (!db_affected_rows()) {
    @db_query("INSERT INTO {%s} (cid, data, created, expire, headers) VALUES ('%s', %b, %d, %d, '%s')", $table, $cid, $data, time(), $expire, $headers);
302
  }
303
304
  db_unlock_tables();
  if ($expire === CACHE_PERMANENT && $headers === NULL) {
305
    dmemcache_set($cid, $data, 0, $table);
306
307
308
309
310
  }
}

/**
 *
311
312
313
314
315
316
317
318
319
320
 * 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.
321
 *
322
323
324
325
 * @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.
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
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
function cache_clear_all($cid = NULL, $table = NULL, $wildcard = FALSE) {
  global $user;

  // 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;
  if (empty($cid)) {
    dmemcache_flush($table);
  }
  else {
    dmemcache_delete($cid, $table);
  }

  if (!isset($cid) && !isset($table)) {
    cache_clear_all(NULL, 'cache_page');
    return;
  }

  if (empty($cid)) {
    if (variable_get('cache_lifetime', 0)) {
      // We store the time in the current user's $user->cache variable which
      // will be saved into the sessions table by sess_write(). We then
      // simulate that the cache was flushed for this user by not returning
      // cached data that was cached before the timestamp.
      $user->cache = time();

      $cache_flush = variable_get('cache_flush', 0);
      if ($cache_flush == 0) {
        // This is the first request to clear the cache, start a timer.
        variable_set('cache_flush', time());
      }
      else if (time() > ($cache_flush + variable_get('cache_lifetime', 0))) {
        // Clear the cache for everyone, cache_flush_delay seconds have
        // passed since the first request to clear the cache.
        db_query("DELETE FROM {%s} WHERE expire != %d AND expire < %d", $table, CACHE_PERMANENT, time());
        variable_set('cache_flush', 0);
      }
    }
    else {
      // No minimum cache lifetime, flush all temporary cache entries now.
      db_query("DELETE FROM {%s} WHERE expire != %d AND expire < %d", $table, CACHE_PERMANENT, time());
    }
  }
  else {
    if ($wildcard) {
      if ($cid == '*') {
        db_query("DELETE FROM {%s}", $table);
      }
      else {
        db_query("DELETE FROM {%s} WHERE cid LIKE '%s%%'", $table, $cid);
      }
    }
    else {
      db_query("DELETE FROM {%s} WHERE cid = '%s'", $table, $cid);
    }
  }
}