dmemcache.inc 18.4 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11
<?php

/*
 * Core dmemcache functions required by:
 *   memcache.inc
 *   memcache.db.inc
 *   session-memcache.inc
 *   session-memcache.db.inc
 */

global $_memcache_statistics;
12
$_memcache_statistics = array();
13 14 15 16 17 18 19 20

/*
 * A memcache API for Drupal.
 */

/**
 *  Place an item into memcache
 *
21
 * @param $key The string with which you will retrieve this item later.
22
 * @param $value The item to be stored.
23 24 25 26 27 28 29 30 31
 * @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.
 * @param $mc Optionally pass in the memcache object.  Normally this value is
 *   determined automatically based on the bin the object is being stored to.
32 33 34
 *
 * @return bool
 */
35
function dmemcache_set($key, $value, $exp = 0, $bin = 'cache', $mc = NULL) {
36
  global $_memcache_statistics;
37
  $full_key = dmemcache_key($key, $bin);
38 39 40
  if (dmemcache_collect_stats()) {
    $_memcache_statistics[] = array('set', $bin, $full_key, '');
  }
41
  if ($mc || ($mc = dmemcache_object($bin))) {
42
    if ($mc instanceof Memcached) {
43
      return $mc->set($full_key, $value, $exp);
44 45
    }
    else {
46
      return $mc->set($full_key, $value, MEMCACHE_COMPRESSED, $exp);
47 48 49 50 51
    }
  }
  return FALSE;
}

52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
/**
 *  Add an item into memcache
 *
 * @param $key The string with which 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.
 * @param $mc Optionally pass in the memcache object.  Normally this value is
 *   determined automatically based on the bin the object is being stored to.
 * @param $flag If using the older memcache PECL extension as opposed to the
 *   newer memcached PECL extension, the MEMCACHE_COMPRESSED flag can be set
 *   to use zlib to store a compressed copy of the item.  This flag option is
 *   completely ignored when using the newer memcached PECL extension.
 *
 * @return bool
 */
73 74
function dmemcache_add($key, $value, $exp = 0, $bin = 'cache', $mc = NULL, $flag = FALSE) {
  global $_memcache_statistics;
75
  $full_key = dmemcache_key($key, $bin);
76 77 78
  if (dmemcache_collect_stats()) {
    $_memcache_statistics[] = array('add', $bin, $full_key, '');
  }
79
  if ($mc || ($mc = dmemcache_object($bin))) {
80
    if ($mc instanceof Memcached) {
Jeremy's avatar
Jeremy committed
81
      return $mc->add($full_key, $value, $exp);
82 83
    }
    else {
Jeremy's avatar
Jeremy committed
84
      return $mc->add($full_key, $value, $flag, $exp);
85 86
    }
  }
87
  return FALSE;
88 89
}

90 91 92 93 94 95 96 97
/**
 * 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
 */
98
function dmemcache_get($key, $bin = 'cache', $mc = NULL) {
99
  global $_memcache_statistics;
100
  $result = FALSE;
101 102 103
  $full_key = dmemcache_key($key, $bin);
  $statistics = array('get', $bin, $full_key);
  $success = '0';
104 105 106 107 108
  if ($mc || $mc = dmemcache_object($bin)) {
    $track_errors = ini_set('track_errors', '1');
    $php_errormsg = '';

    $result = @$mc->get($full_key);
109 110 111 112
    if (dmemcache_collect_stats()) {
      $statistics[] = (bool) $result;
      $_memcache_statistics[] = $statistics;
    }
113 114 115 116

    if (!empty($php_errormsg)) {
      register_shutdown_function('watchdog', 'memcache', 'Exception caught in dmemcache_get: !msg', array('!msg' => $php_errormsg), WATCHDOG_WARNING);
      $php_errormsg = '';
117
    }
118
    ini_set('track_errors', $track_errors);
119
  }
120

121
  return $result;
122 123 124 125 126 127 128 129 130 131 132 133
}

/**
 * Retrieve multiple values from the cache.
 *
 * @param $keys The keys with which the items were stored.
 * @param $bin The bin in which the item was stored.
 *
 * @return The item which was originally saved or FALSE
 */
function dmemcache_get_multi($keys, $bin = 'cache', $mc = NULL) {
  global $_memcache_statistics;
134 135 136 137
  $full_keys = array();
  $statistics = array();
  foreach ($keys as $key => $cid) {
    $full_key = dmemcache_key($cid, $bin);
138 139 140
    if (dmemcache_collect_stats()) {
      $statistics[$full_key] = array('getMulti', $bin, $full_key);
    }
141
    $full_keys[$cid] = $full_key;
142
  }
143 144
  $results = array();
  if ($mc || ($mc = dmemcache_object($bin))) {
145
    if ($mc instanceof Memcached) {
146 147
      $results = $mc->getMulti($full_keys);
    }
148
    elseif ($mc instanceof Memcache) {
149 150 151 152 153 154 155 156 157 158
      $track_errors = ini_set('track_errors', '1');
      $php_errormsg = '';

      $results = @$mc->get($full_keys);

      if (!empty($php_errormsg)) {
        register_shutdown_function('watchdog', 'memcache', 'Exception caught in dmemcache_get_multi: !msg', array('!msg' => $php_errormsg), WATCHDOG_WARNING);
        $php_errormsg = '';
      }
      ini_set('track_errors', $track_errors);
159 160
    }
  }
161 162 163 164 165
  if (dmemcache_collect_stats()) {
    foreach ($statistics as $key => $values) {
      $values[] = isset($results[$key]) ? '1': '0';
      $_memcache_statistics[] = $values;
    }
166
  }
167 168 169 170 171

  // If $results is FALSE, convert it to an empty array.
  if (!$results) {
    $results = array();
  }
172 173 174

  // Convert the full keys back to the cid.
  $cid_results = array();
175 176 177
  $cid_lookup = array_flip($full_keys);
  foreach ($results as $key => $value) {
    $cid_results[$cid_lookup[$key]] = $value;
178 179
  }
  return $cid_results;
180 181 182 183 184 185 186 187 188 189
}

/**
 * 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.
 */
190
function dmemcache_delete($key, $bin = 'cache', $mc = NULL) {
191 192
  global $_memcache_statistics;
  $full_key = dmemcache_key($key, $bin);
193 194 195
  if (dmemcache_collect_stats()) {
    $_memcache_statistics[] = array('delete', $bin, $full_key, '');
  }
196
  if ($mc || ($mc = dmemcache_object($bin))) {
197
    return $mc->delete($full_key, 0);
198 199 200 201 202 203 204 205 206 207 208 209 210 211
  }
  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.
 */
212
function dmemcache_flush($bin = 'cache', $mc = NULL) {
213
  global $_memcache_statistics;
214 215 216
  if (dmemcache_collect_stats()) {
    $_memcache_statistics[] = array('flush', $bin, '', '');
  }
217
  if ($mc || ($mc = dmemcache_object($bin))) {
218
    return memcache_flush($mc);
219 220 221
  }
}

222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
function dmemcache_stats($stats_bin = 'cache', $stats_type = 'default', $aggregate = FALSE) {
  $memcache_bins = variable_get('memcache_bins', array('cache' => 'default'));
  // The stats_type can be over-loaded with an integer slab id, if doing a
  // cachedump.  We know we're doing a cachedump if $slab is non-zero.
  $slab = (int)$stats_type;

  foreach ($memcache_bins as $bin => $target) {
    if ($stats_bin == $bin) {
      if ($mc = dmemcache_object($bin)) {
        if ($mc instanceof Memcached) {
          $stats[$bin] = $mc->getStats();
        }
        // The PHP Memcache extension 3.x version throws an error if the stats
        // type is NULL or not in {reset, malloc, slabs, cachedump, items,
        // sizes}. If $stats_type is 'default', then no parameter should be
        // passed to the Memcache memcache_get_extended_stats() function.
        else if ($mc instanceof Memcache) {
          if ($stats_type == 'default' || $stats_type == '') {
            $stats[$bin] = $mc->getExtendedStats();
          }
          // If $slab isn't zero, then we are dumping the contents of a
          // specific cache slab.
          else if (!empty($slab))  {
            $stats[$bin] = $mc->getStats('cachedump', $slab);
          }
          else {
            $stats[$bin] = $mc->getExtendedStats($stats_type);
          }
        }
      }
252
    }
253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274
  }
  // Optionally calculate a sum-total for all servers in the current bin.
  if ($aggregate) {
    // Some variables don't logically aggregate.
    $no_aggregate = array('pid', 'time', 'version', 'pointer_size', 'accepting_conns', 'listen_disabled_num');
    foreach($stats as $bin => $servers) {
      if (is_array($servers)) {
        foreach ($servers as $server) {
          if (is_array($server)) {
            foreach ($server as $key => $value) {
              if (!in_array($key, $no_aggregate)) {
                if (isset($stats[$bin]['total'][$key])) {
                  $stats[$bin]['total'][$key] += $value;
                }
                else {
                  $stats[$bin]['total'][$key] = $value;
                }
              }
            }
          }
        }
      }
275
    }
276
  }
277
  return $stats;
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
}

/**
 * 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
 * or if you need to use legacy code. Otherwise, use the dmemcache (get, set,
 * delete, flush) API functions provided here.
 *
 * @param $bin The bin which is to be used.
 *
 * @param $flush Rebuild the bin/server/cache mapping.
 *
 * @return an Memcache object or FALSE.
 */
function dmemcache_object($bin = NULL, $flush = FALSE) {
294
  static $extension, $memcacheCache = array(), $memcache_servers, $memcache_bins, $memcache_persistent, $failed_connection_cache;
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311

  if (!isset($extension)) {
    // If an extension is specified in settings.php, use that when available.
    $preferred = variable_get('memcache_extension', NULL);
    if (isset($preferred) && class_exists($preferred)) {
      $extension = $preferred;
    }
    // If no extension is set, default to Memcache.
    // The Memcached extension has some features that the older extension lacks
    // but also an unfixed bug that affects cache clears.
    // @see http://pecl.php.net/bugs/bug.php?id=16829
    elseif (class_exists('Memcache')) {
      $extension = 'Memcache';
    }
    elseif (class_exists('Memcached')) {
      $extension = 'Memcached';
    }
312 313 314 315 316 317 318 319

    // Indicate whether to connect to memcache using a persistent connection.
    // Note: this only affects the Memcache PECL extension, and does not
    // affect the Memcached PECL extension.  For a detailed explanation see:
    //  http://drupal.org/node/822316#comment-4427676
    if (!isset($memcache_persistent)) {
      $memcache_persistent = variable_get('memcache_persistent', FALSE);
    }
320
  }
321 322 323

  if ($flush) {
    foreach ($memcacheCache as $cluster) {
324
      memcache_close($cluster);
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
    }
    $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'));
    }

    // 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.
351
      if ($extension == 'Memcached') {
352
        $memcache = new Memcached;
353 354
        $default_opts = array(
          Memcached::OPT_COMPRESSION => FALSE,
355 356
          Memcached::OPT_DISTRIBUTION => Memcached::DISTRIBUTION_CONSISTENT,
        );
357 358 359
        foreach ($default_opts as $key => $value) {
          $memcache->setOption($key, $value);
        }
360 361
        // See README.txt for setting custom Memcache options when using the
        // memcached PECL extension.
362
        $memconf = variable_get('memcache_options', array());
363 364 365
        foreach ($memconf as $key => $value) {
          $memcache->setOption($key, $value);
        }
366
      }
367
      elseif ($extension == 'Memcache') {
368 369 370 371 372 373
        $memcache = new Memcache;
      }
      else {
        drupal_set_message(t('You must enable the PECL memcached or memcache extension to use memcache.inc.'), 'error');
        return;
      }
374 375 376 377 378
      // A variable to track whether we've connected to the first server.
      $init = FALSE;

      // Link all the servers to this cluster.
      foreach ($memcache_servers as $s => $c) {
379
        if ($c == $cluster && !isset($failed_connection_cache[$s])) {
380 381
          list($host, $port) = explode(':', $s);

382 383
          // Using the Memcache PECL extension.
          if ($memcache instanceof Memcache) {
384 385 386 387 388 389 390
            // Support unix sockets in the format 'unix:///path/to/socket'.
            if ($host == 'unix') {
              // When using unix sockets with Memcache use the full path for $host.
              $host = $s;
              // Port is always 0 for unix sockets.
              $port = 0;
            }
391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
            // When using the PECL memcache extension, we must use ->(p)connect
            // for the first connection.
            if (!$init) {
              $track_errors = ini_set('track_errors', '1');
              $php_errormsg = '';

              if ($memcache_persistent && @$memcache->pconnect($host, $port)) {
                $init = TRUE;
              }
              elseif (!$memcache_persistent && @$memcache->connect($host, $port)) {
                $init = TRUE;
              }

              if (!empty($php_errormsg)) {
                register_shutdown_function('watchdog', 'memcache', 'Exception caught in dmemcache_object: !msg', array('!msg' => $php_errormsg), WATCHDOG_WARNING);
                $php_errormsg = '';
              }
              ini_set('track_errors', $track_errors);
            }
            else {
              $memcache->addServer($host, $port, $memcache_persistent);
412 413
            }
          }
414 415 416 417 418 419 420 421 422 423 424
          else {
            // Support unix sockets in the format 'unix:///path/to/socket'.
            if ($host == 'unix') {
              // Memcached expects just the path to the socket without the protocol
              $host = substr($s, 7);
              // Port is always 0 for unix sockets.
              $port = 0;
            }
            if ($memcache->addServer($host, $port) && !$init) {
              $init = TRUE;
            }
425
          }
426 427 428

          if (!$init) {
            // We can't use watchdog because this happens in a bootstrap phase
429 430 431
            // where watchdog is non-functional. Register a shutdown handler
            // instead so it gets recorded at the end of page load.
            register_shutdown_function('watchdog', 'memcache', 'Failed to connect to memcache server: !server', array('!server' => $s), WATCHDOG_ERROR);
432 433
            $failed_connection_cache[$s] = FALSE;
          }
434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456
        }
      }

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

        // 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];
          }
        }
      }
    }
  }

  return empty($memcacheCache[$bin]) ? FALSE : $memcacheCache[$bin];
}

function dmemcache_key($key, $bin = 'cache') {
457 458 459 460 461 462 463 464
  $prefix = '';
  if ($prefix = variable_get('memcache_key_prefix', '')) {
    $prefix .= '-';
  }
  // When simpletest is running, emulate the simpletest database prefix here
  // to avoid the child site setting cache entries in the parent site.
  if (isset($GLOBALS['drupal_test_info']['test_run_id'])) {
    $prefix .= $GLOBALS['drupal_test_info']['test_run_id'];
465 466 467 468
  }
  $full_key = urlencode($prefix . $bin . '-' . $key);

  // Memcache only supports key lengths up to 250 bytes.  If we have generated
469 470 471
  // a longer key, we shrink it to an acceptible length with a configurable
  // hashing algorithm. Sha1 was selected as the default as it performs
  // quickly with minimal collisions.
472
  if (strlen($full_key) > 250) {
473
    $full_key = urlencode(hash(variable_get('memcache_key_hash_algorithm', 'sha1'), $prefix . $bin . '-' . $key));
474
  }
475

476
  return $full_key;
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 507


/**
 * Checks whether memcache stats need to be collected.
 */
function dmemcache_collect_stats() {
  global $user;
  static $drupal_static_fast;
  if (!isset($drupal_static_fast)) {
    $drupal_static_fast = &drupal_static(__FUNCTION__, array('variable_checked' => NULL, 'user_access_checked' => NULL));
  }
  $variable_checked = &$drupal_static_fast['variable_checked'];
  $user_access_checked  = &$drupal_static_fast['user_access_checked'];

  // Confirm DRUPAL_BOOTSTRAP_VARIABLES has been reached. We don't use
  // drupal_get_bootstrap_phase() as it's buggy. We can use variable_get()
  // here because _drupal_bootstrap_variables() includes module.inc
  // immediately after it calls variable_initialize().
  if (!isset($variable_checked) && function_exists('module_list')) {
    $variable_checked = variable_get('show_memcache_statistics', FALSE);
  }
  // If statistics are enabled we need to check user access.
  if (!empty($variable_checked) && !isset($user_access_checked) && !empty($user) && function_exists('user_access')) {
    // Statistics are enabled and the $user object has been populated, so check
    // that the user has access to view them.
    $user_access_checked = user_access('access memcache statistics');
  }
  // Return whether or not statistics are enabled and the user can access them.
  return (!isset($variable_checked) || $variable_checked) && (!isset($user_access_checked) || $user_access_checked);
}