2008-05-30 11:40:08 +00:00
|
|
|
<?php
|
|
|
|
/**
|
|
|
|
* Memcache storage engine for cache
|
|
|
|
*
|
|
|
|
*
|
|
|
|
* PHP versions 4 and 5
|
|
|
|
*
|
2009-11-06 06:46:59 +00:00
|
|
|
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
|
2010-01-26 19:18:20 +00:00
|
|
|
* Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)
|
2008-05-30 11:40:08 +00:00
|
|
|
*
|
|
|
|
* Licensed under The MIT License
|
|
|
|
* Redistributions of files must retain the above copyright notice.
|
|
|
|
*
|
2010-01-26 19:18:20 +00:00
|
|
|
* @copyright Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)
|
2009-11-06 06:00:11 +00:00
|
|
|
* @link http://cakephp.org CakePHP(tm) Project
|
2008-10-30 17:30:26 +00:00
|
|
|
* @package cake
|
|
|
|
* @subpackage cake.cake.libs.cache
|
|
|
|
* @since CakePHP(tm) v 1.2.0.4933
|
2009-11-06 06:51:51 +00:00
|
|
|
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
|
2008-05-30 11:40:08 +00:00
|
|
|
*/
|
2009-07-24 19:18:37 +00:00
|
|
|
|
2008-05-30 11:40:08 +00:00
|
|
|
/**
|
|
|
|
* Memcache storage engine for cache
|
|
|
|
*
|
2008-10-30 17:30:26 +00:00
|
|
|
* @package cake
|
|
|
|
* @subpackage cake.cake.libs.cache
|
2008-05-30 11:40:08 +00:00
|
|
|
*/
|
|
|
|
class MemcacheEngine extends CacheEngine {
|
2009-07-24 19:18:37 +00:00
|
|
|
|
2008-05-30 11:40:08 +00:00
|
|
|
/**
|
|
|
|
* Memcache wrapper.
|
|
|
|
*
|
2009-03-19 21:10:13 +00:00
|
|
|
* @var Memcache
|
2008-05-30 11:40:08 +00:00
|
|
|
* @access private
|
|
|
|
*/
|
2010-04-04 06:33:39 +00:00
|
|
|
private $__Memcache = null;
|
2009-07-24 19:18:37 +00:00
|
|
|
|
2008-05-30 11:40:08 +00:00
|
|
|
/**
|
2009-11-15 00:40:30 +00:00
|
|
|
* Settings
|
|
|
|
*
|
|
|
|
* - servers = string or array of memcache servers, default => 127.0.0.1. If an
|
|
|
|
* array MemcacheEngine will use them as a pool.
|
|
|
|
* - compress = boolean, default => false
|
2008-05-30 11:40:08 +00:00
|
|
|
*
|
|
|
|
* @var array
|
|
|
|
* @access public
|
|
|
|
*/
|
2010-04-04 07:14:00 +00:00
|
|
|
public $settings = array();
|
2009-07-24 19:18:37 +00:00
|
|
|
|
2008-05-30 11:40:08 +00:00
|
|
|
/**
|
|
|
|
* Initialize the Cache Engine
|
|
|
|
*
|
|
|
|
* Called automatically by the cache frontend
|
|
|
|
* To reinitialize the settings call Cache::engine('EngineName', [optional] settings = array());
|
|
|
|
*
|
|
|
|
* @param array $setting array of setting for the engine
|
|
|
|
* @return boolean True if the engine has been successfully initialized, false if not
|
|
|
|
*/
|
2010-04-05 03:19:38 +00:00
|
|
|
public function init($settings = array()) {
|
2008-05-30 11:40:08 +00:00
|
|
|
if (!class_exists('Memcache')) {
|
|
|
|
return false;
|
|
|
|
}
|
2008-06-02 17:35:56 +00:00
|
|
|
parent::init(array_merge(array(
|
2009-11-14 23:50:23 +00:00
|
|
|
'engine'=> 'Memcache',
|
|
|
|
'prefix' => Inflector::slug(APP_DIR) . '_',
|
|
|
|
'servers' => array('127.0.0.1'),
|
|
|
|
'compress'=> false
|
2008-06-02 17:35:56 +00:00
|
|
|
), $settings)
|
|
|
|
);
|
2008-05-30 11:40:08 +00:00
|
|
|
|
|
|
|
if ($this->settings['compress']) {
|
|
|
|
$this->settings['compress'] = MEMCACHE_COMPRESSED;
|
|
|
|
}
|
|
|
|
if (!is_array($this->settings['servers'])) {
|
|
|
|
$this->settings['servers'] = array($this->settings['servers']);
|
|
|
|
}
|
2008-08-21 16:57:59 +00:00
|
|
|
if (!isset($this->__Memcache)) {
|
2008-11-19 21:19:23 +00:00
|
|
|
$return = false;
|
2008-08-21 16:57:59 +00:00
|
|
|
$this->__Memcache =& new Memcache();
|
|
|
|
foreach ($this->settings['servers'] as $server) {
|
|
|
|
$parts = explode(':', $server);
|
|
|
|
$host = $parts[0];
|
|
|
|
$port = 11211;
|
|
|
|
if (isset($parts[1])) {
|
|
|
|
$port = $parts[1];
|
|
|
|
}
|
|
|
|
if ($this->__Memcache->addServer($host, $port)) {
|
2008-11-19 21:19:23 +00:00
|
|
|
$return = true;
|
2008-05-30 11:40:08 +00:00
|
|
|
}
|
|
|
|
}
|
2008-11-19 21:19:23 +00:00
|
|
|
return $return;
|
2008-05-30 11:40:08 +00:00
|
|
|
}
|
2008-08-21 16:57:59 +00:00
|
|
|
return true;
|
2008-05-30 11:40:08 +00:00
|
|
|
}
|
2009-07-24 19:18:37 +00:00
|
|
|
|
2008-05-30 11:40:08 +00:00
|
|
|
/**
|
|
|
|
* Write data for key into cache
|
|
|
|
*
|
|
|
|
* @param string $key Identifier for the data
|
|
|
|
* @param mixed $value Data to be cached
|
|
|
|
* @param integer $duration How long to cache the data, in seconds
|
|
|
|
* @return boolean True if the data was succesfully cached, false on failure
|
|
|
|
*/
|
2010-04-05 03:19:38 +00:00
|
|
|
public function write($key, &$value, $duration) {
|
2008-07-26 20:00:20 +00:00
|
|
|
$expires = time() + $duration;
|
2009-11-14 23:50:23 +00:00
|
|
|
$this->__Memcache->set($key . '_expires', $expires, $this->settings['compress'], $expires);
|
2009-02-11 23:00:19 +00:00
|
|
|
return $this->__Memcache->set($key, $value, $this->settings['compress'], $expires);
|
2008-05-30 11:40:08 +00:00
|
|
|
}
|
2009-07-24 19:18:37 +00:00
|
|
|
|
2008-05-30 11:40:08 +00:00
|
|
|
/**
|
|
|
|
* Read a key from the cache
|
|
|
|
*
|
|
|
|
* @param string $key Identifier for the data
|
|
|
|
* @return mixed The cached data, or false if the data doesn't exist, has expired, or if there was an error fetching it
|
|
|
|
*/
|
2010-04-05 03:19:38 +00:00
|
|
|
public function read($key) {
|
2008-07-26 20:00:20 +00:00
|
|
|
$time = time();
|
2009-11-14 23:50:23 +00:00
|
|
|
$cachetime = intval($this->__Memcache->get($key . '_expires'));
|
2008-07-26 20:00:20 +00:00
|
|
|
if ($cachetime < $time || ($time + $this->settings['duration']) < $cachetime) {
|
|
|
|
return false;
|
|
|
|
}
|
2008-05-30 11:40:08 +00:00
|
|
|
return $this->__Memcache->get($key);
|
|
|
|
}
|
2009-07-24 19:18:37 +00:00
|
|
|
|
2010-01-21 16:41:44 +00:00
|
|
|
/**
|
|
|
|
* Increments the value of an integer cached key
|
|
|
|
*
|
|
|
|
* @param string $key Identifier for the data
|
|
|
|
* @param integer $offset How much to increment
|
|
|
|
* @param integer $duration How long to cache the data, in seconds
|
|
|
|
* @return New incremented value, false otherwise
|
|
|
|
*/
|
2010-04-05 03:19:38 +00:00
|
|
|
public function increment($key, $offset = 1) {
|
2010-01-21 16:41:44 +00:00
|
|
|
if ($this->settings['compress']) {
|
2010-04-15 15:45:34 +00:00
|
|
|
trigger_error(sprintf(__('Method increment() not implemented for compressed cache in %s'), get_class($this)), E_USER_ERROR);
|
2010-01-21 16:41:44 +00:00
|
|
|
}
|
|
|
|
return $this->__Memcache->increment($key, $offset);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Decrements the value of an integer cached key
|
|
|
|
*
|
|
|
|
* @param string $key Identifier for the data
|
|
|
|
* @param integer $offset How much to substract
|
|
|
|
* @param integer $duration How long to cache the data, in seconds
|
|
|
|
* @return New decremented value, false otherwise
|
|
|
|
*/
|
2010-04-05 03:19:38 +00:00
|
|
|
public function decrement($key, $offset = 1) {
|
2010-01-21 16:41:44 +00:00
|
|
|
if ($this->settings['compress']) {
|
2010-04-15 15:45:34 +00:00
|
|
|
trigger_error(sprintf(__('Method decrement() not implemented for compressed cache in %s'), get_class($this)), E_USER_ERROR);
|
2010-01-21 16:41:44 +00:00
|
|
|
}
|
|
|
|
return $this->__Memcache->decrement($key, $offset);
|
|
|
|
}
|
|
|
|
|
2008-05-30 11:40:08 +00:00
|
|
|
/**
|
|
|
|
* Delete a key from the cache
|
|
|
|
*
|
|
|
|
* @param string $key Identifier for the data
|
|
|
|
* @return boolean True if the value was succesfully deleted, false if it didn't exist or couldn't be removed
|
|
|
|
*/
|
2010-04-05 03:19:38 +00:00
|
|
|
public function delete($key) {
|
2008-05-30 11:40:08 +00:00
|
|
|
return $this->__Memcache->delete($key);
|
|
|
|
}
|
2009-07-24 19:18:37 +00:00
|
|
|
|
2008-05-30 11:40:08 +00:00
|
|
|
/**
|
|
|
|
* Delete all keys from the cache
|
|
|
|
*
|
|
|
|
* @return boolean True if the cache was succesfully cleared, false otherwise
|
|
|
|
*/
|
2010-04-05 03:19:38 +00:00
|
|
|
public function clear() {
|
2008-05-30 11:40:08 +00:00
|
|
|
return $this->__Memcache->flush();
|
|
|
|
}
|
2009-07-24 19:18:37 +00:00
|
|
|
|
2008-05-30 11:40:08 +00:00
|
|
|
/**
|
|
|
|
* Connects to a server in connection pool
|
|
|
|
*
|
|
|
|
* @param string $host host ip address or name
|
|
|
|
* @param integer $port Server port
|
|
|
|
* @return boolean True if memcache server was connected
|
|
|
|
*/
|
2010-04-05 03:19:38 +00:00
|
|
|
public function connect($host, $port = 11211) {
|
2008-05-30 11:40:08 +00:00
|
|
|
if ($this->__Memcache->getServerStatus($host, $port) === 0) {
|
|
|
|
if ($this->__Memcache->connect($host, $port)) {
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
}
|
2009-07-24 19:18:37 +00:00
|
|
|
?>
|