--- /dev/null
+<?php
+/**
+ * The Horde_Memcache:: class provides an API or Horde code to interact with
+ * a centrally configured memcache installation.
+ *
+ * memcached website: http://www.danga.com/memcached/
+ *
+ * Configuration parameters:
+ * <pre>
+ * 'compression' - Compress data inside memcache?
+ * DEFAULT: false
+ * 'c_threshold' - The minimum value length before attempting to compress.
+ * DEFAULT: none
+ * 'hostspec' - The memcached host(s) to connect to.
+ * DEFAULT: 'localhost'
+ * 'large_items' - Allow storing large data items (larger than
+ * Horde_Memcache::MEMCACHE_MAX_SIZE)?
+ * DEFAULT: true
+ * 'persistent' - Use persistent DB connections?
+ * DEFAULT: false
+ * 'prefix' - The prefix to use for the memcache keys.
+ * DEFAULT: 'horde'
+ * 'port' - The port(s) memcache is listening on. Leave empty or set
+ * to 0 if using UNIX sockets.
+ * DEFAULT: 11211
+ * 'weight' - The weight to use for each memcached host.
+ * DEFAULT: none (equal weight to all servers)
+ * </pre>
+ *
+ * Copyright 2007-2009 The Horde Project (http://www.horde.org/)
+ *
+ * See the enclosed file COPYING for license information (LGPL). If you
+ * did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.
+ *
+ * @category Horde
+ * @author Michael Slusarz <slusarz@horde.org>
+ * @author Didi Rieder <adrieder@sbox.tugraz.at>
+ * @package Horde_Memcache
+ */
+class Horde_Memcache
+{
+ /**
+ * The max storage size of the memcache server. This should be slightly
+ * smaller than the actual value due to overhead. By default, the max
+ * slab size of memcached (as of 1.1.2) is 1 MB.
+ */
+ const MEMCACHE_MAX_SIZE = 1000000;
+
+ /**
+ * The singleton instance.
+ *
+ * @var Horde_Memcache
+ */
+ static protected $_instance = null;
+
+ /**
+ * Memcache object.
+ *
+ * @var Memcache
+ */
+ protected $_memcache;
+
+ /**
+ * Memcache defaults.
+ *
+ * @var array
+ */
+ protected $_params = array(
+ 'compression' => 0,
+ 'hostspec' => 'localhost',
+ 'large_items' => true,
+ 'persistent' => false,
+ 'port' => 11211,
+ );
+
+ /**
+ * Allow large data items?
+ *
+ * @var boolean
+ */
+ protected $_large = true;
+
+ /**
+ * A list of items known not to exist.
+ *
+ * @var array
+ */
+ protected $_noexist = array();
+
+ /**
+ * Singleton.
+ */
+ public static function singleton()
+ {
+ if (!self::$_instance) {
+ self::$_instance = new Horde_Memcache();
+ }
+
+ return self::$_instance;
+ }
+
+ /**
+ * Constructor.
+ */
+ protected function __construct()
+ {
+ $this->_params = array_merge($this->_params, $GLOBALS['conf']['memcache']);
+ $this->_params['prefix'] = (empty($this->_params['prefix'])) ? 'horde' : $this->_params['prefix'];
+ $this->_large = !empty($this->_params['large_items']);
+
+ $servers = array();
+ $this->_memcache = new Memcache;
+ for ($i = 0, $n = count($this->_params['hostspec']); $i < $n; ++$i) {
+ if ($this->_memcache->addServer($this->_params['hostspec'][$i], empty($this->_params['port'][$i]) ? 0 : $this->_params['port'][$i], !empty($this->_params['persistent']), !empty($this->_params['weight'][$i]) ? $this->_params['weight'][$i] : 1)) {
+ $servers[] = $this->_params['hostspec'][$i] . (!empty($this->_params['port'][$i]) ? ':' . $this->_params['port'][$i] : '');
+ }
+ }
+
+ /* Check if any of the connections worked. */
+ if (empty($servers)) {
+ Horde::logMessage('Could not connect to any defined memcache servers.' , __FILE__, __LINE__, PEAR_LOG_ERR);
+ } else {
+ if (!empty($this->_params['c_threshold'])) {
+ $this->_memcache->setCompressThreshold($this->_params['c_threshold']);
+ }
+
+ // Force consistent hashing
+ ini_set('memcache.hash_strategy', 'consistent');
+
+ Horde::logMessage('Connected to the following memcache servers:' . implode($servers, ', '), __FILE__, __LINE__, PEAR_LOG_DEBUG);
+ }
+ }
+
+ /**
+ * Delete a key.
+ *
+ * @see Memcache::delete()
+ *
+ * @param string $key The key.
+ * @param integer $timeout Expiration time in seconds.
+ *
+ * @return boolean True on success.
+ */
+ public function delete($key, $timeout = 0)
+ {
+ if ($this->_large) {
+ /* No need to delete the oversized parts - memcache's LRU
+ * algorithm will eventually cause these pieces to be recycled. */
+ if (!isset($this->_noexist[$key . '_os'])) {
+ $this->_memcache->delete($this->_key($key . '_os'), $timeout);
+ }
+ }
+ if (isset($this->_noexist[$key])) {
+ return false;
+ }
+ return $this->_memcache->delete($this->_key($key), $timeout);
+ }
+
+ /**
+ * Get data associated with a key.
+ *
+ * @see Memcache::get()
+ *
+ * @param mixed $keys The key or an array of keys.
+ *
+ * @return mixed The string/array on success (return type is the type of
+ * $keys), false on failure.
+ */
+ public function get($keys)
+ {
+ $key_map = $os = $os_keys = $out_array = array();
+ $ret_array = true;
+
+ if (!is_array($keys)) {
+ $keys = array($keys);
+ $ret_array = false;
+ }
+ $search_keys = $keys;
+
+ if ($this->_large) {
+ foreach ($keys as $val) {
+ $os_keys[$val] = $search_keys[] = $val . '_os';
+ }
+ }
+
+ foreach ($search_keys as $v) {
+ $key_map[$v] = $this->_key($v);
+ }
+
+ $res = $this->_memcache->get(array_values($key_map));
+ if ($res === false) {
+ return false;
+ }
+
+ /* Check to see if we have any oversize items we need to get. */
+ if (!empty($os_keys)) {
+ foreach ($os_keys as $key => $val) {
+ if (!empty($res[$key_map[$val]])) {
+ /* This is an oversize key entry. */
+ $os[$key] = $this->_getOSKeyArray($key, $res[$key_map[$val]]);
+ }
+ }
+
+ if (!empty($os)) {
+ $search_keys = $search_keys2 = array();
+ foreach ($os as $val) {
+ $search_keys = array_merge($search_keys, $val);
+ }
+
+ foreach ($search_keys as $v) {
+ $search_keys2[] = $key_map[$v] = $this->_key($v);
+ }
+
+ $res2 = $this->_memcache->get($search_keys2);
+ if ($res2 === false) {
+ return false;
+ }
+
+ /* $res should now contain the same results as if we had
+ * run a single get request with all keys above. */
+ $res = array_merge($res, $res2);
+ }
+ }
+
+ foreach ($key_map as $k => $v) {
+ if (!isset($res[$v])) {
+ $this->_noexist[$k] = true;
+ }
+ }
+
+ $old_error = error_reporting(0);
+
+ foreach ($keys as $k) {
+ $out_array[$k] = false;
+ if (isset($res[$key_map[$k]])) {
+ $data = $res[$key_map[$k]];
+ if (isset($os[$k])) {
+ foreach ($os[$k] as $v) {
+ if (isset($res[$key_map[$v]])) {
+ $data .= $res[$key_map[$v]];
+ } else {
+ $this->delete($k);
+ continue 2;
+ }
+ }
+ }
+ $out_array[$k] = unserialize($data);
+ } elseif (isset($os[$k]) && !isset($res[$key_map[$k]])) {
+ $this->delete($k);
+ }
+ }
+
+ error_reporting($old_error);
+
+ return ($ret_array) ? $out_array : reset($out_array);
+ }
+
+ /**
+ * Set the value of a key.
+ *
+ * @see Memcache::set()
+ *
+ * @param string $key The key.
+ * @param string $var The data to store.
+ * @param integer $timeout Expiration time in seconds.
+ *
+ * @return boolean True on success.
+ */
+ public function set($key, $var, $expire = 0)
+ {
+ $old_error = error_reporting(0);
+ $var = serialize($var);
+ error_reporting($old_error);
+
+ return $this->_set($key, $var, $expire);
+ }
+
+ /**
+ * Set the value of a key.
+ *
+ * @param string $key The key.
+ * @param string $var The data to store (serialized).
+ * @param integer $timeout Expiration time in seconds.
+ * @param integer $lent String length of $len.
+ *
+ * @return boolean True on success.
+ */
+ protected function _set($key, $var, $expire = 0, $len = null)
+ {
+ if (is_null($len)) {
+ $len = strlen($var);
+ }
+
+ if (!$this->_large && ($len > self::MEMCACHE_MAX_SIZE)) {
+ return false;
+ }
+
+ for ($i = 0; ($i * self::MEMCACHE_MAX_SIZE) < $len; ++$i) {
+ $curr_key = ($i) ? ($key . '_s' . $i) : $key;
+ $res = $this->_memcache->set($this->_key($curr_key), substr($var, $i * self::MEMCACHE_MAX_SIZE, self::MEMCACHE_MAX_SIZE), empty($this->_params['compression']) ? 0 : MEMCACHE_COMPRESSED, $expire);
+ if ($res === false) {
+ $this->delete($key);
+ $i = 1;
+ break;
+ }
+ unset($this->_noexist[$curr_key]);
+ }
+
+ if (($res !== false) && $this->_large) {
+ $os_key = $this->_key($key . '_os');
+ if (--$i) {
+ $this->_memcache->set($os_key, $i, 0, $expire);
+ } elseif (!isset($this->_noexist[$key . '_os'])) {
+ $this->_memcache->delete($os_key);
+ }
+ }
+
+ return $res;
+ }
+
+ /**
+ * Replace the value of a key.
+ *
+ * @see Memcache::replace()
+ *
+ * @param string $key The key.
+ * @param string $var The data to store.
+ * @param integer $timeout Expiration time in seconds.
+ *
+ * @return boolean True on success, false if key doesn't exist.
+ */
+ public function replace($key, $var, $expire = 0)
+ {
+ $old_error = error_reporting(0);
+ $var = serialize($var);
+ error_reporting($old_error);
+ $len = strlen($var);
+
+ if ($len > self::MEMCACHE_MAX_SIZE) {
+ if ($this->_large) {
+ $res = $this->_memcache->get(array($this->_key($key), $this->_key($key . '_os')));
+ if (!empty($res)) {
+ return $this->_set($key, $var, $expire, $len);
+ }
+ }
+ return false;
+ }
+
+ if ($this->_memcache->replace($this->_key($key), $var, empty($this->_params['compression']) ? 0 : MEMCACHE_COMPRESSED, $expire)) {
+ if ($this->_large && !isset($this->_noexist[$key . '_os'])) {
+ $this->_memcache->delete($this->_key($key . '_os'));
+ }
+ return true;
+ }
+
+ return false;
+ }
+
+ /**
+ * Obtain lock on a key.
+ *
+ * @param string $key The key to lock.
+ */
+ public function lock($key)
+ {
+ /* Lock will automatically expire after 10 seconds. */
+ while ($this->_memcache->add($this->_key($key . '_l'), 1, 0, 10) === false) {
+ /* Wait 0.005 secs before attempting again. */
+ usleep(5000);
+ }
+ }
+
+ /**
+ * Release lock on a key.
+ *
+ * @param string $key The key to lock.
+ */
+ public function unlock($key)
+ {
+ $this->_memcache->delete($this->_key($key . '_l'));
+ }
+
+ /**
+ * Mark all entries on a memcache installation as expired.
+ */
+ public function flush()
+ {
+ $this->_memcache->flush();
+ }
+
+ /**
+ * Get the statistics output from the current memcache pool.
+ *
+ * @return array The output from Memcache::getExtendedStats() using the
+ * current Horde configuration values.
+ */
+ public function stats()
+ {
+ return $this->_memcache->getExtendedStats();
+ }
+
+ /**
+ * Obtains the md5 sum for a key.
+ *
+ * @param string $key The key.
+ *
+ * @return string The corresponding memcache key.
+ */
+ protected function _key($key)
+ {
+ return md5($this->_params['prefix'] . $key);
+ }
+
+ /**
+ * Returns the key listing of all key IDs for an oversized item.
+ *
+ * @return array The array of key IDs.
+ */
+ protected function _getOSKeyArray($key, $length)
+ {
+ $ret = array();
+ for ($i = 0; $i < $length; ++$i) {
+ $ret[] = $key . '_s' . ($i + 1);
+ }
+ return $ret;
+ }
+
+}
--- /dev/null
+#!@php_bin@
+<?php
+/**
+ * This script outputs statistics on the current memcache pool.
+ *
+ * Usage: memcache-stats.php [--all] [--raw] [--summary] [--lookup=key]
+ *
+ * By default, shows statistics for all servers.
+ *
+ * Copyright 2007-2009 The Horde Project (http://www.horde.org/)
+ *
+ * See the enclosed file COPYING for license information (LGPL). If you
+ * did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.
+ *
+ * @author Michael Slusarz <slusarz@horde.org>
+ * @package Horde_Memcache
+ */
+
+// No auth.
+@define('AUTH_HANDLER', true);
+
+// Find the base file path of Horde.
+@define('HORDE_BASE', dirname(__FILE__) . '/..');
+
+// Do CLI checks and environment setup first.
+require_once HORDE_BASE . '/lib/core.php';
+
+// Make sure no one runs this from the web.
+if (!Horde_CLI::runningFromCLI()) {
+ exit("Must be run from the command line\n");
+}
+
+// Load the CLI environment - make sure there's no time limit, init some
+// variables, etc.
+$cli = &Horde_CLI::singleton();
+$cli->init();
+
+require_once HORDE_BASE . '/lib/base.php';
+
+/* Make sure there's no compression. */
+@ob_end_clean();
+
+$c = new Console_Getopt();
+$argv = $c->readPHPArgv();
+array_shift($argv);
+$options = $c->getopt2($argv, '', array('all', 'flush', 'lookup=', 'raw', 'summary'));
+if (PEAR::isError($options)) {
+ $cli->writeln($cli->red("ERROR: Invalid arguments."));
+ exit;
+}
+
+$all = $raw = $summary = false;
+$memcache = &Horde_Memcache::singleton();
+
+foreach ($options[0] as $val) {
+ switch ($val[0]) {
+ case '--all':
+ $all = true;
+ break;
+
+ case '--flush':
+ if ($cli->prompt($cli->red('Are you sure you want to flush all data?'), array('y' => 'Yes', 'n' => 'No'), 'n') == 'y') {
+ $memcache->flush();
+ $cli->writeln($cli->green('Done.'));
+ }
+ exit;
+
+ case '--lookup':
+ $data = $memcache->get($val[1]);
+ if (!empty($data)) {
+ $cli->writeln(print_r($data, true));
+ } else {
+ $cli->writeln('[Key not found.]');
+ }
+ exit;
+
+ case '--raw':
+ $raw = true;
+ break;
+
+ case '--summary':
+ $summary = true;
+ break;
+ }
+}
+
+$stats = $memcache->stats();
+
+if ($raw) {
+ $cli->writeln(print_r($stats, true));
+} elseif (!$summary) {
+ $all = true;
+}
+
+if ($all || $summary) {
+ if ($summary) {
+ $total = array();
+ $total_keys = array('bytes', 'limit_maxbytes', 'curr_items', 'total_items', 'get_hits', 'get_misses', 'curr_connections', 'bytes_read', 'bytes_written');
+ foreach ($total_keys as $key) {
+ $total[$key] = 0;
+ }
+ }
+
+ $i = $s_count = count($stats);
+
+ foreach ($stats as $key => $val) {
+ if ($summary) {
+ foreach ($total_keys as $k) {
+ $total[$k] += $val[$k];
+ }
+ }
+
+ if ($all) {
+ $cli->writeln($cli->green('Server: ' . $key . ' (Version: ' . $val['version'] . ' - ' . $val['threads'] . ' thread(s))'));
+ _outputInfo($val);
+ if (--$i || $summary) {
+ $cli->writeln();
+ }
+ }
+ }
+
+ if ($summary) {
+ $cli->writeln($cli->green('Memcache pool (' . $s_count . ' server(s))'));
+ _outputInfo($total);
+ }
+}
+
+function _outputInfo($val)
+{
+ global $cli;
+
+ $cli->writeln($cli->indent('Size: ' . sprintf("%0.2f", $val['bytes'] / 1048576) . ' MB (Max: ' . sprintf("%0.2f", ($val['limit_maxbytes']) / 1048576) . ' MB - ' . ((!empty($val['limit_maxbytes']) ? round(($val['bytes'] / $val['limit_maxbytes']) * 100, 1) : 'N/A')) . '% used)'));
+ $cli->writeln($cli->indent('Items: ' . $val['curr_items'] . ' (Total: ' . $val['total_items'] . ')'));
+ $cli->writeln($cli->indent('Cache Ratio: ' . $val['get_hits'] . ' hits, ' . $val['get_misses'] . ' misses'));
+ $cli->writeln($cli->indent('Connections: ' . $val['curr_connections']));
+ $cli->writeln($cli->indent('Traffic: ' . sprintf("%0.2f", $val['bytes_read'] / 1048576) . ' MB in, ' . sprintf("%0.2f", $val['bytes_written'] / 1048576) . ' MB out'));
+}
projects / horde.git / commitdiff