* @category Horde
* @copyright 1999-2017 Horde LLC
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Cache
*/
class Horde_Cache_Storage_File extends Horde_Cache_Storage_Base
{
/* Location of the garbage collection data file. */
const GC_FILE = 'horde_cache_gc';
/**
* List of key to filename mappings.
*
* @var array
*/
protected $_file = array();
/**
* Constructor.
*
* @param array $params Optional parameters:
*
* - dir: (string) The base directory to store the cache files in.
* DEFAULT: System default
* - no_gc: (boolean) If true, don't perform garbage collection.
* DEFAULT: false
* - prefix: (string) The filename prefix to use for the cache files.
* DEFAULT: 'cache_'
* - sub: (integer) If non-zero, the number of subdirectories to create
* to store the file (i.e. PHP's session.save_path).
* DEFAULT: 0
*
*/
public function __construct(array $params = array())
{
$params = array_merge(array(
'prefix' => 'cache_',
'sub' => 0
), $params);
if (!isset($params['dir']) || !@is_dir($params['dir'])) {
$params['dir'] = sys_get_temp_dir();
}
parent::__construct($params);
}
/**
* Destructor.
*/
public function __destruct()
{
$c_time = time();
/* Only do garbage collection 0.1% of the time we create an object. */
if (!empty($this->_params['no_gc']) ||
(intval(substr($c_time, -3)) !== 0)) {
return;
}
$this->_gc();
}
/**
*/
public function get($key, $lifetime = 0)
{
if (!$this->exists($key, $lifetime)) {
/* Nothing cached, return failure. */
return false;
}
$filename = $this->_keyToFile($key);
$size = filesize($filename);
return $size
? @file_get_contents($filename)
: '';
}
/**
*/
public function set($key, $data, $lifetime = 0)
{
$filename = $this->_keyToFile($key, true);
$tmp_file = Horde_Util::getTempFile('HordeCache', true, $this->_params['dir']);
if (isset($this->_params['umask'])) {
chmod($tmp_file, 0666 & ~$this->_params['umask']);
}
if (file_put_contents($tmp_file, $data) === false) {
throw new Horde_Cache_Exception('Cannot write to cache directory ' . $this->_params['dir']);
}
@rename($tmp_file, $filename);
if ($lifetime &&
($fp = @fopen(dirname($filename) . '/' . self::GC_FILE, 'a'))) {
// This may result in duplicate entries in GC_FILE, but we
// will take care of these whenever we do GC and this is quicker
// than having to check every time we access the file.
fwrite($fp, $filename . "\t" . (time() + $lifetime) . "\n");
fclose($fp);
}
}
/**
*/
public function exists($key, $lifetime = 0)
{
$filename = $this->_keyToFile($key);
/* Key exists in the cache */
if (file_exists($filename)) {
/* 0 means no expire.
* Also, If the file was been created after the supplied value,
* the data is valid (fresh). */
if (($lifetime == 0) ||
(time() - $lifetime <= filemtime($filename))) {
return true;
}
@unlink($filename);
}
return false;
}
/**
*/
public function expire($key)
{
return @unlink($this->_keyToFile($key));
}
/**
*/
public function clear()
{
foreach ($this->_getCacheFiles() as $val) {
@unlink($val);
}
foreach ($this->_getGCFiles() as $val) {
@unlink($val);
}
}
/**
* Return a list of cache files.
*
* @param string $start The directory to start searching.
*
* @return array Pathnames to cache files.
*/
protected function _getCacheFiles($start = null)
{
$paths = array();
try {
$it = empty($this->_params['sub'])
? new DirectoryIterator($this->_params['dir'])
: new RecursiveIteratorIterator(new RecursiveDirectoryIterator($start ?: $this->_params['dir']), RecursiveIteratorIterator::CHILD_FIRST);
} catch (UnexpectedValueException $e) {
return $paths;
}
foreach ($it as $val) {
if (!$val->isDir() &&
($fname = $val->getFilename()) &&
(strpos($fname, $this->_params['prefix']) === 0)) {
$paths[$fname] = $val->getPathname();
}
}
return $paths;
}
/**
* Return a list of GC indexes.
*
* @return array Pathnames to GC indexes.
*/
protected function _getGCFiles()
{
$glob = $this->_params['dir'];
if (!empty($this->_params['sub'])) {
$glob .= '/'
. implode('/', array_fill(0, $this->_params['sub'], '*'));
}
$glob .= '/' . self::GC_FILE;
return glob($glob);
}
/**
* Map a cache key to a unique filename.
*
* @param string $key Cache key.
* @param string $create Create path if it doesn't exist?
*
* @return string Fully qualified filename.
*/
protected function _keyToFile($key, $create = false)
{
if ($create || !isset($this->_file[$key])) {
$dir = $this->_params['dir'] . '/';
$md5 = hash('md5', $key);
$sub = '';
if (!empty($this->_params['sub'])) {
$max = min($this->_params['sub'], strlen($md5));
for ($i = 0; $i < $max; $i++) {
$sub .= $md5[$i];
if ($create && !is_dir($dir . $sub)) {
if (!mkdir($dir . $sub)) {
$sub = '';
break;
}
}
$sub .= '/';
}
}
$this->_file[$key] = $dir . $sub . $this->_params['prefix'] . $md5;
}
return $this->_file[$key];
}
/**
* Garbage collector.
*/
protected function _gc()
{
$c_time = time();
if (!empty($this->_params['sub']) &&
file_exists($this->_params['dir'] . '/' . self::GC_FILE)) {
// If we cannot migrate, we cannot GC either, because we expect the
// new format.
try {
$this->_migrateGc();
} catch (Horde_Cache_Exception $e) {
return;
}
}
foreach ($this->_getGCFiles() as $filename) {
$excepts = array();
if (is_readable($filename)) {
$fp = fopen($filename, 'r');
while (!feof($fp) && ($data = fgets($fp))) {
$parts = explode("\t", trim($data), 2);
$excepts[$parts[0]] = $parts[1];
}
}
foreach ($this->_getCacheFiles(dirname($filename)) as $pname) {
if (!empty($excepts[$pname]) &&
($c_time > $excepts[$pname])) {
@unlink($pname);
unset($excepts[$pname]);
}
}
if ($fp = @fopen($filename, 'w')) {
foreach ($excepts as $key => $val) {
fwrite($fp, $key . "\t" . $val . "\n");
}
fclose($fp);
}
}
}
/**
* Migrates single GC indexes to per-directory indexes.
*/
protected function _migrateGc()
{
// Read the old GC index.
$filename = $this->_params['dir'] . '/' . self::GC_FILE;
if (!is_readable($filename)) {
return;
}
$fhs = array();
$fp = fopen($filename, 'r');
if (!flock($fp, LOCK_EX)) {
throw new Horde_Cache_Exception('Cannot acquire lock for old garbage collection index');
}
// Loops through all cached files from the old index and write their GC
// information to the new GC indexes.
while (!feof($fp) && ($data = fgets($fp))) {
list($path, $time) = explode("\t", trim($data), 2);
$dir = dirname($path);
if ($dir == $this->_params['dir']) {
continue;
}
if (!isset($fhs[$dir])) {
$fhs[$dir] = @fopen($dir . '/' . self::GC_FILE, 'a');
// Maybe too many open file handles?
if (!$fhs[$dir] && count($fhs)) {
unset($fhs[$dir]);
foreach ($fhs as $fh) {
fclose($fh);
}
$fhs = array();
$fhs[$dir] = @fopen($dir . '/' . self::GC_FILE, 'a');
}
if (!$fhs[$dir]) {
throw new Horde_Cache_Exception('Cannot migrate to new garbage collection index format');
}
}
fwrite($fhs[$dir], $path . "\t" . $time . "\n");
}
// Clean up.
foreach ($fhs as $fh) {
fclose($fh);
}
fclose($fp);
unlink($filename);
}
}
Horde_Cache-2.5.5/lib/Horde/Cache/Storage/Hashtable.php 0000664 0001750 0001750 00000005605 13054773062 020612 0 ustar jan jan
* @category Horde
* @copyright 2013-2017 Horde LLC
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Cache
* @since 2.2.0
*/
class Horde_Cache_Storage_Hashtable extends Horde_Cache_Storage_Base
{
/**
* HashTable object.
*
* @var Horde_HashTable
*/
protected $_hash;
/**
* @param array $params Additional parameters:
*
* - hashtable: (Horde_HashTable) [REQUIRED] A Horde_HashTable object.
* - prefix: (string) The prefix to use for the cache keys.
* DEFAULT: ''
*
*/
public function __construct(array $params = array())
{
if (!isset($params['hashtable'])) {
throw new InvalidArgumentException('Missing hashtable parameter.');
}
parent::__construct(array_merge(array(
'prefix' => ''
), $params));
}
/**
*/
protected function _initOb()
{
$this->_hash = $this->_params['hashtable'];
}
/**
*/
public function get($key, $lifetime = 0)
{
$dkey = $this->_getKey($key);
$query = array($dkey);
if ($lifetime) {
$query[] = $lkey = $this->_getKey($key, true);
}
$res = $this->_hash->get($query);
if ($lifetime &&
(!$res[$lkey] || (($lifetime + $res[$lkey]) < time()))) {
return false;
}
return $res[$dkey];
}
/**
*/
public function set($key, $data, $lifetime = 0)
{
$opts = array_filter(array(
'expire' => $lifetime
));
$this->_hash->set($this->_getKey($key), $data, $opts);
$this->_hash->set($this->_getKey($key, true), time(), $opts);
}
/**
*/
public function exists($key, $lifetime = 0)
{
return ($this->get($key, $lifetime) !== false);
}
/**
*/
public function expire($key)
{
$this->_hash->delete(array(
$this->_getKey($key),
$this->_getKey($key, true)
));
}
/**
*/
public function clear()
{
$this->_hash->clear();
}
/**
* Return the hashtable key.
*
* @param string $key Object ID.
* @param boolean $ts Return the timestamp key?
*
* @return string Hashtable key ID.
*/
protected function _getKey($key, $ts = false)
{
return $this->_params['prefix'] . $key . ($ts ? '_t' : '');
}
}
Horde_Cache-2.5.5/lib/Horde/Cache/Storage/Memcache.php 0000664 0001750 0001750 00000007127 13054773062 020422 0 ustar jan jan
* @author Michael Slusarz
* @category Horde
* @copyright 2006-2016 Horde LLC
* @deprecated Use HashTable driver instead.
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Cache
*/
class Horde_Cache_Storage_Memcache extends Horde_Cache_Storage_Base
{
/**
* Cache results of exists()/get() calls (since we will get the entire
* object on an exists() call anyway).
*
* @var array
*/
protected $_objectcache = array();
/**
* Memcache object.
*
* @var Horde_Memcache
*/
protected $_memcache;
/**
* Construct a new Horde_Cache_Memcache object.
*
* @param array $params Parameter array:
*
* - memcache: (Horde_Memcache) [REQUIRED] A Horde_Memcache object.
* - prefix: (string) The prefix to use for the cache keys.
* DEFAULT: ''
*
*/
public function __construct(array $params = array())
{
if (!isset($params['memcache'])) {
if (isset($params['hashtable'])) {
$params['memcache'] = $params['hashtable'];
} else {
throw new InvalidArgumentException('Missing memcache object');
}
}
parent::__construct(array_merge(array(
'prefix' => '',
), $params));
}
/**
*/
protected function _initOb()
{
$this->_memcache = $this->_params['memcache'];
}
/**
*/
public function get($key, $lifetime = 0)
{
$original_key = $key;
$key = $this->_params['prefix'] . $key;
if (isset($this->_objectcache[$key])) {
return $this->_objectcache[$key];
}
$key_list = array($key);
if (!empty($lifetime)) {
$key_list[] = $key . '_e';
}
$res = $this->_memcache->get($key_list);
if ($res === false) {
return $this->_objectcache[$key] = false;
}
// If we can't find the expire time, assume we have exceeded it.
if (empty($lifetime) ||
(($res[$key . '_e'] !== false) &&
($res[$key . '_e'] + $lifetime > time()))) {
$this->_objectcache[$key] = $res[$key];
} else {
$this->expire($original_key);
return false;
}
return $res[$key];
}
/**
*/
public function set($key, $data, $lifetime = 0)
{
$key = $this->_params['prefix'] . $key;
if ($this->_memcache->set($key . '_e', time(), $lifetime) !== false) {
$this->_memcache->set($key, $data, $lifetime);
unset($this->_objectcache[$key]);
}
}
/**
*/
public function exists($key, $lifetime = 0)
{
return ($this->get($key, $lifetime) !== false);
}
/**
*/
public function expire($key)
{
$key = $this->_params['prefix'] . $key;
$this->_objectcache[$key] = false;
$this->_memcache->delete($key . '_e');
return $this->_memcache->delete($key);
}
/**
*/
public function clear()
{
$this->_memcache->flush();
$this->_objectcache = array();
}
}
Horde_Cache-2.5.5/lib/Horde/Cache/Storage/Memory.php 0000664 0001750 0001750 00000003154 13054773062 020164 0 ustar jan jan
* @author Michael Slusarz
* @category Horde
* @copyright 2010-2016 Horde LLC
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @link http://pear.horde.org/index.php?package=Cache
* @package Cache
* @since 2.5.0
*/
class Horde_Cache_Storage_Memory extends Horde_Cache_Storage_Base
{
/**
* Storage for this cache.
*
* @var array
*/
private $_cache = array();
/**
*/
public function get($key, $lifetime = 0)
{
return isset($this->_cache[$key])
? $this->_cache[$key]
: false;
}
/**
*/
public function set($key, $data, $lifetime = 0)
{
$this->_cache[$key] = $data;
}
/**
*/
public function exists($key, $lifetime = 0)
{
return isset($this->_cache[$key]);
}
/**
*/
public function expire($key)
{
unset($this->_cache[$key]);
}
/**
*/
public function clear()
{
$this->_cache = array();
}
}
Horde_Cache-2.5.5/lib/Horde/Cache/Storage/Memoryoverlay.php 0000664 0001750 0001750 00000004621 13054773062 021566 0 ustar jan jan
* @category Horde
* @copyright 2013-2016 Horde LLC
* @deprecated Use Memory driver as first backend in stack driver instead.
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @link http://pear.horde.org/index.php?package=Cache
* @package Cache
*/
class Horde_Cache_Storage_Memoryoverlay extends Horde_Cache_Storage_Base
{
/**
* The memory cache.
*
* @var array
*/
private $_cache = array();
/**
* Constructor.
*
* @param array $params Parameters:
*
* - backend: (Horde_Cache_Storage_Base) [REQUIRED] The master storage
* backend.
*
*/
public function __construct(array $params = array())
{
if (!isset($params['backend'])) {
throw new InvalidArgumentException('Missing backend parameter.');
}
parent::__construct($params);
}
/**
*/
public function get($key, $lifetime = 0)
{
if (!isset($this->_cache[$key])) {
$this->_cache[$key] = $this->_params['backend']->get($key, $lifetime);
}
return $this->_cache[$key];
}
/**
*/
public function set($key, $data, $lifetime = 0)
{
$this->_cache[$key] = $data;
$this->_params['backend']->set($key, $data, $lifetime);
}
/**
*/
public function exists($key, $lifetime = 0)
{
return isset($this->_cache[$key])
? true
: $this->_params['backend']->exists($key, $lifetime);
}
/**
*/
public function expire($key)
{
unset($this->_cache[$key]);
$this->_params['backend']->expire($key);
}
/**
*/
public function clear()
{
$this->_cache = array();
$this->_params['backend']->clear();
}
}
Horde_Cache-2.5.5/lib/Horde/Cache/Storage/Mock.php 0000664 0001750 0001750 00000001613 13054773062 017603 0 ustar jan jan
* @category Horde
* @copyright 2010-2017 Horde LLC
* @deprecated Use Memory driver instead.
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @link http://pear.horde.org/index.php?package=Cache
* @package Cache
*/
class Horde_Cache_Storage_Mock extends Horde_Cache_Storage_Memory
{
}
Horde_Cache-2.5.5/lib/Horde/Cache/Storage/Mongo.php 0000664 0001750 0001750 00000014327 13054773062 017777 0 ustar jan jan
* @category Horde
* @copyright 2013-2017 Horde LLC
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Cache
*/
class Horde_Cache_Storage_Mongo extends Horde_Cache_Storage_Base
{
/* Field names. */
const CID = 'cid';
const DATA = 'data';
const EXPIRE = 'expire';
const TIMESTAMP = 'ts';
/**
* The MongoDB Collection object for the cache data.
*
* @var MongoCollection
*/
protected $_db;
/**
* Constructor.
*
* @param array $params Parameters:
*
* - collection: (string) The collection name.
* - mongo_db: [REQUIRED] (Horde_Mongo_Client) A MongoDB client object.
*
*/
public function __construct(array $params = array())
{
if (!isset($params['mongo_db'])) {
throw new InvalidArgumentException('Missing mongo_db parameter.');
}
parent::__construct(array_merge(array(
'collection' => 'horde_cache'
), $params));
}
/**
* Destructor.
*/
public function __destruct()
{
/* Only do garbage collection 0.1% of the time we create an object. */
if (substr(time(), -3) === '000') {
try {
$this->_db->remove(array(
self::EXPIRE => array(
'$exists' => true,
'$lt' => time()
)
));
} catch (MongoException $e) {
$this->_logger->log($e->getMessage(), 'DEBUG');
}
}
}
/**
*/
protected function _initOb()
{
$this->_db = $this->_params['mongo_db']->selectCollection(null, $this->_params['collection']);
}
/**
*/
public function get($key, $lifetime = 0)
{
$okey = $key;
$key = $this->_getCid($key);
/* Build SQL query. */
$query = array(
self::CID => $key
);
// 0 lifetime checks for objects which have no expiration
if ($lifetime != 0) {
$query[self::TIMESTAMP] = array('$gte' => time() - $lifetime);
}
try {
$result = $this->_db->findOne($query, array(self::DATA => true));
} catch (MongoException $e) {
$this->_logger->log($e->getMessage(), 'DEBUG');
return false;
}
if (empty($result)) {
/* No rows were found - cache miss */
if ($this->_logger) {
$this->_logger->log(sprintf('Cache miss: %s (cache ID %s)', $okey, $key), 'DEBUG');
}
return false;
}
if ($this->_logger) {
$this->_logger->log(sprintf('Cache hit: %s (cache ID %s)', $okey, $key), 'DEBUG');
}
return $result[self::DATA]->bin;
}
/**
*/
public function set($key, $data, $lifetime = 0)
{
$okey = $key;
$key = $this->_getCid($key);
$curr = time();
$data = array(
self::CID => $key,
self::DATA => new MongoBinData($data, MongoBinData::BYTE_ARRAY),
self::TIMESTAMP => $curr
);
// 0 lifetime indicates the object should not be GC'd.
if (!empty($lifetime)) {
$data[self::EXPIRE] = intval($lifetime) + $curr;
}
if ($this->_logger) {
$this->_logger->log(sprintf(
'Cache set: %s (id %s set at %s%s)',
$okey,
$key,
date('r', $curr),
(isset($data[self::EXPIRE]) ? ' expires at ' . date('r', $data[self::EXPIRE]) : '')
), 'DEBUG');
}
// Remove any old cache data and prevent duplicate keys
try {
$this->_db->update(array(
self::CID => $key
), array(
'$set' => $data
), array(
'upsert' => true,
'w' => 0
));
} catch (MongoException $e) {
$this->_logger->log($e->getMessage(), 'DEBUG');
return false;
}
}
/**
*/
public function exists($key, $lifetime = 0)
{
$okey = $key;
$key = $this->_getCid($key);
/* Build SQL query. */
$query = array(
self::CID => $key
);
// 0 lifetime checks for objects which have no expiration
if ($lifetime != 0) {
$query[self::TIMESTAMP] = array('$gte' => time() - $lifetime);
}
try {
$result = $this->_db->findOne($query);
} catch (MongoException $e) {
$this->_logger->log($e->getMessage(), 'DEBUG');
return false;
}
if (is_null($result)) {
if ($this->_logger) {
$this->_logger->log(sprintf('Cache exists() miss: %s (cache ID %s)', $okey, $key), 'DEBUG');
}
return false;
}
if ($this->_logger) {
$this->_logger->log(sprintf('Cache exists() hit: %s (cache ID %s)', $okey, $key), 'DEBUG');
}
return true;
}
/**
*/
public function expire($key)
{
$okey = $key;
$key = $this->_getCid($key);
try {
$this->_db->remove(array(
self::CID => $key
));
if ($this->_logger) {
$this->_logger->log(sprintf('Cache expire: %s (cache ID %s)', $okey, $key), 'DEBUG');
}
return true;
} catch (MongoException $e) {
return false;
}
}
/**
*/
public function clear()
{
$this->_db->drop();
}
/**
* Gets the cache ID for a key.
*
* @param string $key The key.
*
* @return string The cache ID.
*/
protected function _getCid($key)
{
return hash('md5', $key);
}
}
Horde_Cache-2.5.5/lib/Horde/Cache/Storage/Null.php 0000664 0001750 0001750 00000002034 13054773062 017622 0 ustar jan jan
* @category Horde
* @copyright 2006-2017 Horde LLC
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Cache
*/
class Horde_Cache_Storage_Null extends Horde_Cache_Storage_Base
{
/**
*/
public function get($key, $lifetime = 0)
{
return false;
}
/**
*/
public function set($key, $data, $lifetime = 0)
{
}
/**
*/
public function exists($key, $lifetime = 0)
{
return false;
}
/**
*/
public function expire($key)
{
return false;
}
/**
*/
public function clear()
{
}
}
Horde_Cache-2.5.5/lib/Horde/Cache/Storage/Session.php 0000664 0001750 0001750 00000004737 13054773062 020347 0 ustar jan jan
* @category Horde
* @copyright 2010-2017 Horde LLC
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Cache
*/
class Horde_Cache_Storage_Session extends Horde_Cache_Storage_Base
{
/**
* Pointer to the session entry.
*
* @var array
*/
protected $_sess;
/**
* Constructor.
*
* @param array $params Optional parameters:
*
* - session: (string) Store session data in this entry.
* DEFAULT: 'horde_cache_session'
*
*/
public function __construct(array $params = array())
{
$params = array_merge(array(
'sess_name' => 'horde_cache_session'
), $params);
parent::__construct($params);
}
/**
* Do initialization tasks.
*/
protected function _initOb()
{
if (!isset($_SESSION[$this->_params['sess_name']])) {
$_SESSION[$this->_params['sess_name']] = array();
}
$this->_sess = &$_SESSION[$this->_params['sess_name']];
}
/**
*/
public function get($key, $lifetime = 0)
{
return $this->exists($key, $lifetime)
? $this->_sess[$key]['d']
: false;
}
/**
*/
public function set($key, $data, $lifetime = 0)
{
$this->_sess[$key] = array(
'd' => $data,
'l' => $lifetime
);
}
/**
*/
public function exists($key, $lifetime = 0)
{
if (isset($this->_sess[$key])) {
/* 0 means no expire. */
if (($lifetime == 0) ||
((time() - $lifetime) <= $this->_sess[$key]['l'])) {
return true;
}
unset($this->_sess[$key]);
}
return false;
}
/**
*/
public function expire($key)
{
if (isset($this->_sess[$key])) {
unset($this->_sess[$key]);
return true;
}
return false;
}
/**
*/
public function clear()
{
$this->_sess = array();
}
}
Horde_Cache-2.5.5/lib/Horde/Cache/Storage/Sql.php 0000664 0001750 0001750 00000015044 13054773062 017454 0 ustar jan jan
* CREATE TABLE horde_cache (
* cache_id VARCHAR(32) NOT NULL,
* cache_timestamp BIGINT NOT NULL,
* cache_data LONGBLOB,
* (Or on PostgreSQL:)
* cache_data TEXT,
* (Or on some other DBMS systems:)
* cache_data IMAGE,
*
* PRIMARY KEY (cache_id)
* );
*
*
* @author Ben Klang
* @author Michael Slusarz
* @category Horde
* @copyright 2007-2017 Horde LLC
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Cache
*/
class Horde_Cache_Storage_Sql extends Horde_Cache_Storage_Base
{
/**
* Handle for the current database connection.
*
* @var Horde_Db_Adapter
*/
protected $_db;
/**
* Constructor.
*
* @param array $params Parameters:
*
* - db: (Horde_Db_Adapter) [REQUIRED] The DB instance.
* - table: (string) The name of the cache table.
* DEFAULT: 'horde_cache'
*
*/
public function __construct($params = array())
{
if (!isset($params['db'])) {
throw new InvalidArgumentException('Missing db parameter.');
}
parent::__construct(array_merge(array(
'table' => 'horde_cache',
), $params));
}
/**
*/
protected function _initOb()
{
$this->_db = $this->_params['db'];
}
/**
* Destructor.
*/
public function __destruct()
{
/* Only do garbage collection 0.1% of the time we create an object. */
if (substr(time(), -3) !== '000') {
return;
}
$query = 'DELETE FROM ' . $this->_params['table'] .
' WHERE cache_expiration < ? AND cache_expiration <> 0';
$values = array(time());
try {
$this->_db->delete($query, $values);
} catch (Horde_Db_Exception $e) {}
}
/**
*/
public function get($key, $lifetime = 0)
{
$okey = $key;
$key = hash('md5', $key);
$timestamp = time();
$maxage = $timestamp - $lifetime;
/* Build SQL query. */
$query = 'SELECT cache_data FROM ' . $this->_params['table'] .
' WHERE cache_id = ?';
$values = array($key);
// 0 lifetime checks for objects which have no expiration
if ($lifetime != 0) {
$query .= ' AND cache_timestamp >= ?';
$values[] = $maxage;
}
try {
$result = $this->_db->selectValue($query, $values);
$columns = $this->_db->columns($this->_params['table']);
} catch (Horde_Db_Exception $e) {
return false;
}
if (!$result) {
/* No rows were found - cache miss */
if ($this->_logger) {
$this->_logger->log(sprintf('Cache miss: %s (Id %s newer than %d)', $okey, $key, $maxage), 'DEBUG');
}
return false;
}
if ($this->_logger) {
$this->_logger->log(sprintf('Cache hit: %s (Id %s newer than %d)', $okey, $key, $maxage), 'DEBUG');
}
return $columns['cache_data']->binaryToString($result);
}
/**
*/
public function set($key, $data, $lifetime = 0)
{
$okey = $key;
$key = hash('md5', $key);
$timestamp = time();
// 0 lifetime indicates the object should not be GC'd.
$expiration = ($lifetime === 0)
? 0
: ($lifetime + $timestamp);
if ($this->_logger) {
$this->_logger->log(sprintf('Cache set: %s (Id %s set at %d expires at %d)', $okey, $key, $timestamp, $expiration), 'DEBUG');
}
// Remove any old cache data and prevent duplicate keys
$query = 'DELETE FROM ' . $this->_params['table'] . ' WHERE cache_id = ?';
$values = array($key);
try {
$this->_db->delete($query, $values);
} catch (Horde_Db_Exception $e) {}
/* Build SQL query. */
$values = array(
'cache_id' => $key,
'cache_timestamp' => $timestamp,
'cache_expiration' => $expiration,
'cache_data' => new Horde_Db_Value_Binary($data)
);
try {
$this->_db->insertBlob($this->_params['table'], $values);
} catch (Horde_Db_Exception $e) {
throw new Horde_Cache_Exception($e);
}
}
/**
*/
public function exists($key, $lifetime = 0)
{
$okey = $key;
$key = hash('md5', $key);
/* Build SQL query. */
$query = 'SELECT 1 FROM ' . $this->_params['table'] .
' WHERE cache_id = ?';
$values = array($key);
// 0 lifetime checks for objects which have no expiration
if ($lifetime != 0) {
$query .= ' AND cache_timestamp >= ?';
$values[] = time() - $lifetime;
}
try {
$result = $this->_db->selectValue($query, $values);
} catch (Horde_Db_Exception $e) {
return false;
}
$timestamp = time();
if (empty($result)) {
if ($this->_logger) {
$this->_logger->log(sprintf('Cache exists() miss: %s (Id %s newer than %d)', $okey, $key, $timestamp), 'DEBUG');
}
return false;
}
if ($this->_logger) {
$this->_logger->log(sprintf('Cache exists() hit: %s (Id %s newer than %d)', $okey, $key, $timestamp), 'DEBUG');
}
return true;
}
/**
*/
public function expire($key)
{
$key = hash('md5', $key);
$query = 'DELETE FROM ' . $this->_params['table'] .
' WHERE cache_id = ?';
$values = array($key);
try {
$this->_db->delete($query, $values);
} catch (Horde_Db_Exception $e) {
return false;
}
return true;
}
/**
*/
public function clear()
{
$query = 'DELETE FROM ' . $this->_params['table'];
try {
$this->_db->delete($query);
} catch (Horde_Db_Exception $e) {
throw new Horde_Cache_Exception($e);
}
}
}
Horde_Cache-2.5.5/lib/Horde/Cache/Storage/Stack.php 0000664 0001750 0001750 00000006224 13054773062 017762 0 ustar jan jan
* @category Horde
* @copyright 2010-2017 Horde LLC
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Cache
*/
class Horde_Cache_Storage_Stack extends Horde_Cache_Storage_Base
{
/**
* Stack of cache drivers.
*
* @var string
*/
protected $_stack = array();
/**
* Constructor.
*
* @param array $params Parameters:
*
* - stack: (array) [REQUIRED] An array of storage instances to loop
* through, in order of priority. The last entry is considered
* the 'master' driver, for purposes of writes.
*
*/
public function __construct(array $params = array())
{
if (!isset($params['stack'])) {
throw new InvalidArgumentException('Missing stack parameter.');
}
parent::__construct($params);
}
/**
*/
protected function _initOb()
{
$this->_stack = array_values($this->_params['stack']);
}
/**
*/
public function get($key, $lifetime = 0)
{
foreach ($this->_stack as $val) {
if (($result = $val->get($key, $lifetime)) !== false) {
return $result;
}
}
return false;
}
/**
*/
public function set($key, $data, $lifetime = 0)
{
/* Do writes in *reverse* order, since a failure on the master should
* not allow writes on the other backends. */
foreach (array_reverse($this->_stack) as $k => $v) {
if (($result = $v->set($key, $data, $lifetime)) === false) {
if ($k === 0) {
return;
}
/* Invalidate cache if write failed. */
$val->expire($k);
}
}
}
/**
*/
public function exists($key, $lifetime = 0)
{
foreach ($this->_stack as $val) {
if (($result = $val->exists($key, $lifetime)) === true) {
break;
}
}
return $result;
}
/**
*/
public function expire($key)
{
foreach ($this->_stack as $val) {
$success = $val->expire($key);
}
/* Success is reported from last (master) expire() call. */
return $success;
}
/**
*/
public function clear()
{
foreach ($this->_stack as $val) {
try {
$val->clear();
$ex = null;
} catch (Horde_Cache_Exception $e) {
$ex = $e;
}
}
if ($ex) {
throw $ex;
}
}
}
Horde_Cache-2.5.5/lib/Horde/Cache/Storage/Xcache.php 0000664 0001750 0001750 00000005244 13054773062 020111 0 ustar jan jan
* @category Horde
* @copyright 2006-2017 Horde LLC
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Cache
*/
class Horde_Cache_Storage_Xcache extends Horde_Cache_Storage_Base
{
/**
* Constructor.
*
* @param array $params Optional parameters:
*
* - prefix: (string) The prefix to use for the cache keys.
* DEFAULT: ''
*
*/
public function __construct(array $params = array())
{
parent::__construct(array_merge(array(
'prefix' => '',
), $params));
}
/**
*/
public function get($key, $lifetime = 0)
{
$key = $this->_params['prefix'] . $key;
$this->_setExpire($key, $lifetime);
$result = xcache_get($key);
return empty($result)
? false
: $result;
}
/**
*/
public function set($key, $data, $lifetime = 0)
{
$key = $this->_params['prefix'] . $key;
if (xcache_set($key . '_expire', time(), $lifetime)) {
xcache_set($key, $data, $lifetime);
}
}
/**
*/
public function exists($key, $lifetime = 0)
{
$key = $this->_params['prefix'] . $key;
$this->_setExpire($key, $lifetime);
return xcache_isset($key);
}
/**
*/
public function expire($key)
{
$key = $this->_params['prefix'] . $key;
xcache_unset($key . '_expire');
return xcache_unset($key);
}
/**
*/
public function clear()
{
// xcache_clear_cache() won't work because it requires HTTP Auth.
throw new Horde_Cache_Exception('Not supported');
}
/**
* Set expire time on each call since xcache sets it on cache creation.
*
* @param string $key Cache key to expire.
* @param integer $lifetime Lifetime of the data in seconds.
*/
protected function _setExpire($key, $lifetime)
{
if ($lifetime == 0) {
// don't expire
return;
}
$expire = xcache_get($key . '_expire');
// set prune period
if ($expire + $lifetime < time()) {
// Expired
xcache_unset($key . '_expire');
xcache_unset($key);
}
}
}
Horde_Cache-2.5.5/lib/Horde/Cache/Exception.php 0000664 0001750 0001750 00000000651 13054773062 017245 0 ustar jan jan
* @category Horde
* @package Cache
*/
class Horde_Cache_Exception extends Horde_Exception_Wrapped
{
}
Horde_Cache-2.5.5/lib/Horde/Cache.php 0000664 0001750 0001750 00000012474 13054773062 015315 0 ustar jan jan
* @author Chuck Hagenbuch
* @author Michael Slusarz
* @category Horde
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Cache
*/
/**
* This class provides the API interface to the cache storage drivers.
*
* @author Anil Madhavapeddy
* @author Chuck Hagenbuch
* @author Michael Slusarz
* @category Horde
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Cache
*/
class Horde_Cache
{
/**
* Cache parameters.
*
* @var array
*/
protected $_params = array(
'compress' => false,
'lifetime' => 86400
);
/**
* Logger.
*
* @var Horde_Log_Logger
*/
protected $_logger;
/**
* Storage object.
*
* @var Horde_Cache_Storage
*/
protected $_storage;
/**
* Constructor.
*
* @param Horde_Cache_Storage $storage The storage object.
* @param array $params Parameter array:
*
* - compress: (boolean) Compress data (if possible)?
* DEFAULT: false
* - lifetime: (integer) Lifetime of data, in seconds.
* DEFAULT: 86400 seconds
* - logger: (Horde_Log_Logger) Log object to use for log/debug messages.
*
*/
public function __construct(Horde_Cache_Storage_Base $storage,
array $params = array())
{
if (isset($params['logger'])) {
$this->_logger = $params['logger'];
unset($params['logger']);
$storage->setLogger($this->_logger);
}
$this->_params = array_merge($this->_params, $params);
$this->_storage = $storage;
}
/**
* Attempts to directly output a cached object.
*
* @todo Change default lifetime to 0
*
* @param string $key Object ID to query.
* @param integer $lifetime Lifetime of the object in seconds.
*
* @return boolean True if output or false if no object was found.
*/
public function output($key, $lifetime = 1)
{
$data = $this->get($key, $lifetime);
if ($data === false) {
return false;
}
echo $data;
return true;
}
/**
* Retrieve cached data.
*
* @todo Change default lifetime to 0
*
* @param string $key Object ID to query.
* @param integer $lifetime Lifetime of the object in seconds.
*
* @return mixed Cached data, or false if none was found.
*/
public function get($key, $lifetime = 1)
{
$res = $this->_storage->get($key, $lifetime);
if (empty($this->_params['compress']) || !is_string($res)) {
return $res;
}
$compress = new Horde_Compress_Fast();
return $compress->decompress($res);
}
/**
* Store an object in the cache.
*
* @param string $key Object ID used as the caching key.
* @param string $data Data to store in the cache.
* @param integer $lifetime Object lifetime - i.e. the time before the
* data becomes available for garbage
* collection, in seconds. If null use the
* default Horde GC time. If 0 will not be GC'd.
*/
public function set($key, $data, $lifetime = null)
{
if (!empty($this->_params['compress'])) {
$compress = new Horde_Compress_Fast();
$data = $compress->compress($data);
}
$lifetime = is_null($lifetime)
? $this->_params['lifetime']
: $lifetime;
$this->_storage->set($key, $data, $lifetime);
}
/**
* Checks if a given key exists in the cache, valid for the given
* lifetime.
*
* @todo Change default lifetime to 0
*
* @param string $key Cache key to check.
* @param integer $lifetime Lifetime of the key in seconds.
*
* @return boolean Existence.
*/
public function exists($key, $lifetime = 1)
{
return $this->_storage->exists($key, $lifetime);
}
/**
* Expire any existing data for the given key.
*
* @param string $key Cache key to expire.
*
* @return boolean Success or failure.
*/
public function expire($key)
{
return $this->_storage->expire($key);
}
/**
* Clears all data from the cache.
*
* @throws Horde_Cache_Exception
*/
public function clear()
{
return $this->_storage->clear();
}
/**
* Tests the driver for read/write access.
*
* @return boolean True if read/write is available.
*/
public function testReadWrite()
{
$key = '__horde_cache_testkey';
try {
$this->_storage->set($key, 1);
if ($this->_storage->exists($key)) {
$this->_storage->expire($key);
return true;
}
} catch (Exception $e) {}
return false;
}
}
Horde_Cache-2.5.5/migration/Horde/Cache/1_horde_cache_base_tables.php 0000664 0001750 0001750 00000001324 13054773062 023520 0 ustar jan jan tables())) {
$t = $this->createTable('horde_cache', array('autoincrementKey' => array('cache_id')));
$t->column('cache_id', 'string', array('limit' => 32, 'null' => false));
$t->column('cache_timestamp', 'bigint', array('null' => false));
$t->column('cache_expiration', 'bigint', array('null' => false));
$t->column('cache_data', 'binary');
$t->end();
}
}
public function down()
{
$this->dropTable('horde_cache');
}
}
Horde_Cache-2.5.5/migration/Horde/Cache/2_horde_cache_fix_blob_length.php 0000664 0001750 0001750 00000000331 13054773062 024377 0 ustar jan jan changeColumn('horde_cache', 'cache_data', 'binary');
}
public function down()
{
}
}
Horde_Cache-2.5.5/test/Horde/Cache/Sql/Pdo/MysqlTest.php 0000664 0001750 0001750 00000002415 13054773062 020746 0 ustar jan jan
* @category Horde
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Cache
*/
/**
* This class test a PDO MySQL backend.
*
* @author Jan Schneider
* @category Horde
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Cache
*/
class Horde_Cache_Sql_Pdo_MysqlTest extends Horde_Cache_Sql_Base
{
protected function _getCache($params = array())
{
if (!extension_loaded('pdo') ||
!in_array('mysql', PDO::getAvailableDrivers())) {
$this->reason = 'No pdo_mysql extension';
return;
}
$config = self::getConfig('CACHE_SQL_PDO_MYSQL_TEST_CONFIG',
__DIR__ . '/../..');
if ($config && !empty($config['cache']['sql']['pdo_mysql'])) {
$this->db = new Horde_Db_Adapter_Pdo_Mysql($config['cache']['sql']['pdo_mysql']);
return parent::_getCache($params);
} else {
$this->reason = 'No pdo_mysql configuration';
}
}
}
Horde_Cache-2.5.5/test/Horde/Cache/Sql/Pdo/PgsqlTest.php 0000664 0001750 0001750 00000002422 13054773062 020725 0 ustar jan jan
* @category Horde
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Cache
*/
/**
* This class test a PDO PostgreSQL backend.
*
* @author Jan Schneider
* @category Horde
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Cache
*/
class Horde_Cache_Sql_Pdo_PgsqlTest extends Horde_Cache_Sql_Base
{
protected function _getCache($params = array())
{
if (!extension_loaded('pdo') ||
!in_array('pgsql', PDO::getAvailableDrivers())) {
$this->reason = 'No pdo_pgsql extension';
return;
}
$config = self::getConfig('CACHE_SQL_PDO_PGSQL_TEST_CONFIG',
__DIR__ . '/../..');
if ($config && !empty($config['cache']['sql']['pdo_pgsql'])) {
$this->db = new Horde_Db_Adapter_Pdo_Pgsql($config['cache']['sql']['pdo_pgsql']);
return parent::_getCache($params);
} else {
$this->reason = 'No pdo_pgsql configuration';
}
}
}
Horde_Cache-2.5.5/test/Horde/Cache/Sql/Pdo/SqliteTest.php 0000664 0001750 0001750 00000001711 13054773062 021100 0 ustar jan jan
* @category Horde
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Cache
*/
/**
* This class test a PDO SQLite backend.
*
* @author Jan Schneider
* @category Horde
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Cache
*/
class Horde_Cache_Sql_Pdo_SqliteTest extends Horde_Cache_Sql_Base
{
protected function _getCache($params = array())
{
$factory_db = new Horde_Test_Factory_Db();
try {
$this->db = $factory_db->create();
} catch (Horde_Test_Exception $e) {
$this->reason = 'Sqlite not available';
return;
}
return parent::_getCache($params);
}
}
Horde_Cache-2.5.5/test/Horde/Cache/Sql/Base.php 0000664 0001750 0001750 00000003556 13054773062 017140 0 ustar jan jan
* @category Horde
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Cache
*/
/**
* This is the base test class for all SQL backends.
*
* @author Jan Schneider
* @category Horde
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Cache
*/
class Horde_Cache_Sql_Base extends Horde_Cache_TestBase
{
protected function _getCache($params = array())
{
$logger = new Horde_Log_Logger(new Horde_Log_Handler_Cli());
//$this->db->setLogger($logger);
$dir = __DIR__ . '/../../../../migration/Horde/Cache';
if (!is_dir($dir)) {
error_reporting(E_ALL & ~E_DEPRECATED);
$dir = PEAR_Config::singleton()
->get('data_dir', null, 'pear.horde.org')
. '/Horde_Cache/migration';
error_reporting(E_ALL | E_STRICT);
}
$this->migrator = new Horde_Db_Migration_Migrator(
$this->db,
null,//$logger,
array('migrationsPath' => $dir,
'schemaTableName' => 'horde_cache_schema_info'));
$this->migrator->up();
return new Horde_Cache(
new Horde_Cache_Storage_File(array_merge(
array('db' => $this->db),
$params
))
);
}
public function tearDown()
{
parent::tearDown();
$this->db->delete('DELETE FROM horde_cache');
if ($this->migrator) {
$this->migrator->down();
}
if ($this->db) {
$this->db->disconnect();
}
$this->db = $this->migrator = null;
}
}
Horde_Cache-2.5.5/test/Horde/Cache/Sql/MysqliTest.php 0000664 0001750 0001750 00000002270 13054773062 020374 0 ustar jan jan
* @category Horde
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Cache
*/
/**
* This class tests a MySQLi backend.
*
* @author Jan Schneider
* @category Horde
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Cache
*/
class Horde_Cache_Sql_MysqliTest extends Horde_Cache_Sql_Base
{
protected function _getCache($params = array())
{
if (!extension_loaded('mysqli')) {
$this->reason = 'No mysqli extension';
return;
}
$config = self::getConfig('CACHE_SQL_MYSQLI_TEST_CONFIG',
__DIR__ . '/..');
if ($config && !empty($config['cache']['sql']['mysqli'])) {
$this->db = new Horde_Db_Adapter_Mysqli($config['cache']['sql']['mysqli']);
return parent::_getCache($params);
} else {
$this->reason = 'No mysqli configuration';
}
}
}
Horde_Cache-2.5.5/test/Horde/Cache/Sql/MysqlTest.php 0000664 0001750 0001750 00000002257 13054773062 020230 0 ustar jan jan
* @category Horde
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Cache
*/
/**
* This class tests a MySQL backend.
*
* @author Jan Schneider
* @category Horde
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Cache
*/
class Horde_Cache_Sql_MysqlTest extends Horde_Cache_Sql_Base
{
protected function _getCache($params = array())
{
if (!extension_loaded('mysql')) {
$this->reason = 'No mysql extension';
return;
}
$config = self::getConfig('CACHE_SQL_MYSQL_TEST_CONFIG',
__DIR__ . '/..');
if ($config && !empty($config['cache']['sql']['mysql'])) {
$this->db = new Horde_Db_Adapter_Mysql($config['cache']['sql']['mysql']);
return parent::_getCache($params);
} else {
$this->reason = 'No mysql configuration';
}
}
}
Horde_Cache-2.5.5/test/Horde/Cache/Sql/Oci8Test.php 0000664 0001750 0001750 00000002251 13054773062 017717 0 ustar jan jan
* @category Horde
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Cache
*/
/**
* This class tests an Oracle backend.
*
* @author Jan Schneider
* @category Horde
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Cache
*/
class Horde_Cache_Sql_Oci8Test extends Horde_Cache_Sql_Base
{
protected function _getCache($params = array())
{
if (!extension_loaded('oci8')) {
$this->reason = 'No oci8 extension';
return;
}
$config = self::getConfig('CACHE_SQL_OCI8_TEST_CONFIG',
__DIR__ . '/..');
if ($config && !empty($config['cache']['sql']['oci8'])) {
$this->db = new Horde_Db_Adapter_Oci8($config['cache']['sql']['oci8']);
return parent::_getCache($params);
} else {
$this->reason = 'No oci8 configuration';
}
}
}
Horde_Cache-2.5.5/test/Horde/Cache/Stub/File.php 0000664 0001750 0001750 00000001402 13054773062 017307 0 ustar jan jan
* @category Horde
* @copyright 2016-2017 Horde LLC
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Cache
*/
class Horde_Cache_Stub_File extends Horde_Cache_Storage_File
{
/**
* Enforces garbage collection.
*/
public function gc()
{
$this->_gc();
}
}
Horde_Cache-2.5.5/test/Horde/Cache/AllTests.php 0000664 0001750 0001750 00000000132 13054773062 017245 0 ustar jan jan run();
Horde_Cache-2.5.5/test/Horde/Cache/ApcTest.php 0000664 0001750 0001750 00000001667 13054773062 017073 0 ustar jan jan
* @category Horde
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Cache
*/
/**
* This class tests the APC backend.
*
* @author Jan Schneider
* @category Horde
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Cache
*/
class Horde_Cache_ApcTest extends Horde_Cache_TestBase
{
protected function _getCache($params = array())
{
if (!extension_loaded('apc')) {
$this->reason = 'APC extension not loaded';
return;
}
return new Horde_Cache(
new Horde_Cache_Storage_Apc(array(
'prefix' => 'horde_cache_test'
))
);
}
}
Horde_Cache-2.5.5/test/Horde/Cache/bootstrap.php 0000664 0001750 0001750 00000000143 13054773062 017531 0 ustar jan jan
* @category Horde
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Cache
*/
/**
* This class tests the eAccelerator backend.
*
* @author Jan Schneider
* @category Horde
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Cache
*/
class Horde_Cache_EacceleratorTest extends Horde_Cache_TestBase
{
protected function _getCache($params = array())
{
if (!extension_loaded('eaccelerator')) {
$this->reason = 'eAccelerator extension not loaded';
return;
}
if (!function_exists('eaccelerator_gc')) {
$this->reason = 'eAccelerator must be compiled with support for shared memory to use as caching backend.';
return;
}
return new Horde_Cache(
new Horde_Cache_Storage_Eaccelerator(array(
'prefix' => 'horde_cache_test'
))
);
}
}
Horde_Cache-2.5.5/test/Horde/Cache/FileTest.php 0000664 0001750 0001750 00000013173 13054773062 017242 0 ustar jan jan
* @category Horde
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Cache
*/
/**
* This class tests the file backend.
*
* @author Jan Schneider
* @category Horde
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Cache
*/
class Horde_Cache_FileTest extends Horde_Cache_TestBase
{
protected function _getCache($params = array())
{
$this->dir = sys_get_temp_dir() . '/horde_cache_test';
if (!is_dir($this->dir)) {
mkdir($this->dir);
}
return new Horde_Cache(
new Horde_Cache_Storage_File(array_merge(
array(
'dir' => $this->dir,
'no_gc' => true,
'prefix' => 'horde_cache_test'
),
$params
))
);
}
public function testSubdirectories()
{
$this->cache = $this->_getCache(array('sub' => 2));
if (!$this->cache) {
$this->markTestSkipped($this->reason);
}
$this->assertNull($this->cache->set('key1', 'data1', 0));
$this->assertNull($this->cache->set('key2', 'data2', 0));
$this->assertEquals(
array($this->dir . '/7/', $this->dir . '/c/'),
glob($this->dir . '/*', GLOB_MARK)
);
$this->assertEquals(
array($this->dir . '/7/8/'),
glob($this->dir . '/7/*', GLOB_MARK)
);
$this->assertEquals(
array($this->dir . '/c/2/'),
glob($this->dir . '/c/*', GLOB_MARK)
);
$this->assertEquals(
array($this->dir . '/7/8/horde_cache_test78f825aaa0103319aaa1a30bf4fe3ada'),
glob($this->dir . '/7/8/*', GLOB_MARK)
);
$this->assertEquals(
array($this->dir . '/c/2/horde_cache_testc2add694bf942dc77b376592d9c862cd'),
glob($this->dir . '/c/2/*', GLOB_MARK)
);
}
public function testMigrateGarbageCollection()
{
mkdir($this->dir . '/c');
mkdir($this->dir . '/7');
mkdir($this->dir . '/3');
$fp = fopen($this->dir . '/horde_cache_gc', 'w');
$time = time();
fwrite(
$fp,
$this->dir . "/c/c2add694bf942dc77b376592d9c862cd\t"
. ($time - 100) . "\n"
);
fwrite(
$fp,
$this->dir . "/7/78f825aaa0103319aaa1a30bf4fe3ada \t"
. ($time + 100) . "\n"
);
fwrite(
$fp,
$this->dir . "/3/3631578538a2d6ba5879b31a9a42f290\t"
. ($time - 100) . "\n"
);
fwrite(
$fp,
$this->dir . "/3/3631578538a2d6ba5879b31a9a42f290\t"
. ($time + 100) . "\n"
);
fwrite(
$fp,
$this->dir . "/c/caf8e34be07426ae7127c1b4829983c1\t"
. ($time + 100) . "\n"
);
fwrite(
$fp,
$this->dir . "/c/caf8e34be07426ae7127c1b4829983c1\t"
. ($time - 100) . "\n"
);
fclose($fp);
$storage = new Horde_Cache_Stub_File(array(
'dir' => $this->dir,
'no_gc' => true,
'prefix' => 'horde_cache_test',
'sub' => 1
));
$this->cache = new Horde_Cache($storage);
$storage->gc();
$this->assertFileExists($this->dir . '/7/horde_cache_gc');
$this->assertStringEqualsFile(
$this->dir . '/7/horde_cache_gc',
$this->dir . "/7/78f825aaa0103319aaa1a30bf4fe3ada \t"
. ($time + 100) . "\n"
);
$this->assertFileExists($this->dir . '/3/horde_cache_gc');
$this->assertStringEqualsFile(
$this->dir . '/3/horde_cache_gc',
$this->dir . "/3/3631578538a2d6ba5879b31a9a42f290\t"
. ($time + 100) . "\n"
);
$this->assertFileExists($this->dir . '/c/horde_cache_gc');
$this->assertStringEqualsFile(
$this->dir . '/c/horde_cache_gc',
$this->dir . "/c/c2add694bf942dc77b376592d9c862cd\t"
. ($time - 100) . "\n"
. $this->dir . "/c/caf8e34be07426ae7127c1b4829983c1\t"
. ($time - 100) . "\n"
);
$this->assertFileNotExists($this->dir . '/horde_cache_gc');
}
public function testGarbageCollection()
{
$storage = new Horde_Cache_Stub_File(array(
'dir' => $this->dir,
'no_gc' => true,
'prefix' => 'horde_cache_test',
'sub' => 2,
));
$this->cache = new Horde_Cache($storage);
$this->cache->set('key1', 'data1', -100);
$this->cache->set('key2', 'data2', 100);
$this->cache->set('key3', 'data3', -100);
$this->cache->set('key3', 'data4', 100);
$this->cache->set('key4', 'data5', 100);
$this->cache->set('key4', 'data6', -100);
$storage->gc();
$this->assertFileExists($this->dir . '/7/8/horde_cache_test78f825aaa0103319aaa1a30bf4fe3ada');
$this->assertFileExists($this->dir . '/3/6/horde_cache_test3631578538a2d6ba5879b31a9a42f290');
$this->assertFileNotExists($this->dir . '/c/2/horde_cache_testc2add694bf942dc77b376592d9c862cd');
$this->assertFileNotExists($this->dir . '/c/a/horde_cache_testcaf8e34be07426ae7127c1b4829983c1');
}
public function tearDown()
{
parent::tearDown();
system('rm -r ' . $this->dir);
}
}
Horde_Cache-2.5.5/test/Horde/Cache/HashtableTest.php 0000664 0001750 0001750 00000002040 13054773062 020245 0 ustar jan jan
* @category Horde
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Cache
*/
/**
* This class tests the Horde_Hashtable backend.
*
* @author Jan Schneider
* @category Horde
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Cache
*/
class Horde_Cache_HashtableTest extends Horde_Cache_TestBase
{
protected function _getCache($params = array())
{
if (!class_exists('Horde_HashTable_Memory')) {
$this->reason = 'Horde_HashTable not installed';
return;
}
return new Horde_Cache(
new Horde_Cache_Storage_Hashtable(array(
'hashtable' => new Horde_HashTable_Memory(),
'prefix' => 'horde_cache_test'
))
);
}
}
Horde_Cache-2.5.5/test/Horde/Cache/MemcacheTest.php 0000664 0001750 0001750 00000002655 13054773062 020070 0 ustar jan jan
* @category Horde
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Cache
*/
/**
* This class tests the Memcache backend.
*
* @author Jan Schneider
* @category Horde
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Cache
*/
class Horde_Cache_MemcacheTest extends Horde_Cache_TestBase
{
protected function _getCache($params = array())
{
if (!class_exists('Horde_Memcache')) {
$this->reason = 'Horde_Memcache not installed';
return;
}
if (!(extension_loaded('memcache') || extension_loaded('memcached'))) {
$this->reason = 'Memcache extension not loaded';
return;
}
if (!($config = self::getConfig('CACHE_MEMCACHE_TEST_CONFIG')) ||
!isset($config['cache']['memcache'])) {
$this->reason = 'Memcache configuration not available.';
return;
}
return new Horde_Cache(
new Horde_Cache_Storage_Memcache(array(
'memcache' => new Horde_Memcache($config['cache']['memcache']),
'prefix' => 'horde_cache_test'
))
);
}
}
Horde_Cache-2.5.5/test/Horde/Cache/MemoryTest.php 0000664 0001750 0001750 00000002647 13054773062 017637 0 ustar jan jan
* @category Horde
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Cache
*/
/**
* This class tests the memory backend.
*
* @author Jan Schneider
* @category Horde
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Cache
*/
class Horde_Cache_MemoryTest extends Horde_Cache_TestBase
{
protected function _getCache($params = array())
{
return new Horde_Cache(
new Horde_Cache_Storage_Memory()
);
}
/**
* The Memory backend doesn't support lifetimes, so cannot test these like
* in the TestBase class.
*/
public function testExists()
{
$this->assertFalse($this->cache->exists('key1', 0));
$this->cache->set('key1', 'data1', 0);
$this->assertTrue($this->cache->exists('key1', 0));
}
/**
* The Memory backend doesn't support lifetimes, so cannot test these like
* in the TestBase class.
*/
public function testGet()
{
$this->assertFalse($this->cache->get('key1', 0));
$this->cache->set('key1', 'data1', 0);
$this->assertEquals('data1', $this->cache->get('key1', 0));
}
}
Horde_Cache-2.5.5/test/Horde/Cache/MongoTest.php 0000664 0001750 0001750 00000003720 13054773062 017437 0 ustar jan jan
* @category Horde
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Cache
*/
/**
* This class tests the MongoDB backend.
*
* @author Jan Schneider
* @category Horde
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Cache
*/
class Horde_Cache_MongoTest extends Horde_Cache_TestBase
{
protected function _getCache($params = array())
{
if (!extension_loaded('mongo') && !extension_loaded('mongodb')) {
$this->reason = 'Mongo/Mongodb extensions not loaded';
return;
}
if (!class_exists('Horde_Mongo_Client')) {
$this->reason = 'Horde_Mongo not installed';
return;
}
if (!($config = self::getConfig('CACHE_MONGO_TEST_CONFIG', __DIR__)) ||
!isset($config['cache']['mongo']['hostspec'])) {
$this->reason = 'Mongo configuration not available';
return;
}
$factory = new Horde_Test_Factory_Mongo();
$this->mongo = $factory->create(array(
'config' => $config['cache']['mongo']['hostspec'],
'dbname' => 'horde_cache_test'
));
if (!$this->mongo) {
$this->reason = 'MongoDB not available.';
return;
}
$storage = new Horde_Cache_Storage_Mongo(array(
'mongo_db' => $this->mongo,
'collection' => 'horde_cache_test'
));
//$storage->setLogger(new Horde_Log_Logger(new Horde_Log_Handler_Cli()));
return new Horde_Cache($storage);
}
public function tearDown()
{
parent::tearDown();
if (!empty($this->mongo)) {
$this->mongo->selectDB(null)->drop();
}
}
}
Horde_Cache-2.5.5/test/Horde/Cache/phpunit.xml 0000664 0001750 0001750 00000000056 13054773062 017217 0 ustar jan jan
Horde_Cache-2.5.5/test/Horde/Cache/SessionTest.php 0000664 0001750 0001750 00000001402 13054773062 017776 0 ustar jan jan
* @category Horde
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Cache
*/
/**
* This class tests the session backend.
*
* @author Jan Schneider
* @category Horde
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Cache
*/
class Horde_Cache_SessionTest extends Horde_Cache_TestBase
{
protected function _getCache($params = array())
{
return new Horde_Cache(
new Horde_Cache_Storage_Session()
);
}
}
Horde_Cache-2.5.5/test/Horde/Cache/TestBase.php 0000664 0001750 0001750 00000007044 13054773062 017235 0 ustar jan jan
* @category Horde
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Cache
*/
/**
* This is the base test class to run all tests that the backend implementation
* should support.
*
* @author Jan Schneider
* @category Horde
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Cache
*/
abstract class Horde_Cache_TestBase extends Horde_Test_Case
{
protected $reason = '';
protected $cache;
abstract protected function _getCache($params = array());
public function setUp()
{
$this->cache = $this->_getCache();
if (!$this->cache) {
$this->markTestSkipped($this->reason);
}
}
public function testReadWrite()
{
$this->assertTrue($this->cache->testReadWrite());
}
public function testSet()
{
$this->assertNull($this->cache->set('key1', 'data1'));
$this->assertNull($this->cache->set('key2', 'data2', 0));
$this->assertNull($this->cache->set('key3', 'data3', 1));
}
public function testExists()
{
$this->assertFalse($this->cache->exists('key1', 0));
$this->assertFalse($this->cache->exists('key2', 0));
$this->cache->set('key1', 'data1', 0);
$this->cache->set('key2', 'data2', 0);
$this->assertTrue($this->cache->exists('key1', 0));
$this->assertFalse($this->cache->exists('key2', -10));
}
public function testGet()
{
$this->assertFalse($this->cache->get('key1', 0));
$this->assertFalse($this->cache->get('key2', 0));
$this->cache->set('key1', 'data1', 0);
$this->cache->set('key2', 'data2', 0);
$this->assertEquals('data1', $this->cache->get('key1', 0));
$this->assertFalse($this->cache->get('key2', -10));
}
public function testOutput()
{
$this->markTestSkipped();
$this->assertFalse($this->cache->output('key1', 0));
$this->cache->set('key1', 'data1', 0);
ob_start();
$this->assertTrue($this->cache->output('key1', 0));
$this->assertEquals('data1', ob_get_contents());
ob_end_clean();
}
public function testExpire()
{
$this->cache->set('key1', 'data1', 0);
$this->assertEquals('data1', $this->cache->get('key1', 0));
$this->cache->expire('key1');
$this->assertFalse($this->cache->get('key1', 0));
}
public function testClear()
{
$this->cache->set('key1', 'data1', 0);
$this->assertEquals('data1', $this->cache->get('key1', 0));
$this->cache->clear();
$this->assertFalse($this->cache->get('key1', 0));
}
public function testCompress()
{
if (!class_exists('Horde_Compress_Fast')) {
$this->markTestSkipped('Horde_Compress_Fast not installed');
}
$this->tearDown();
$this->cache = $this->_getCache(array('compress' => true));
if (!$this->cache) {
$this->markTestSkipped($this->reason);
}
$this->assertFalse($this->cache->get('key1', 0));
$this->cache->set('key1', 'data1', 0);
$this->assertEquals('data1', $this->cache->get('key1', 0));
}
public function tearDown()
{
if ($this->cache) {
$this->cache->clear();
unset($this->cache);
}
}
}
Horde_Cache-2.5.5/test/Horde/Cache/XcacheTest.php 0000664 0001750 0001750 00000002353 13054773062 017554 0 ustar jan jan
* @category Horde
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Cache
*/
/**
* This class tests the XCache backend.
*
* @author Jan Schneider
* @category Horde
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Cache
*/
class Horde_Cache_XcacheTest extends Horde_Cache_TestBase
{
protected function _getCache($params = array())
{
if (!extension_loaded('xcache')) {
$this->reason = 'XCache extension not loaded';
return;
}
return new Horde_Cache(
new Horde_Cache_Storage_Xcache(array(
'prefix' => 'horde_cache_test'
))
);
}
public function testClear()
{
$this->markTestSkipped('Not supported');
}
public function tearDown()
{
if ($this->cache) {
$this->cache->expire('key1');
$this->cache->expire('key2');
unset($this->cache);
}
}
}