namespace Friendica\Core\Cache;
-use Friendica\BaseObject;
+use Exception;
use Friendica\Core\Cache;
+use Redis;
/**
* Redis Cache Driver. This driver is based on Memcache driver
*
- * @author Hypolite Petovan <mrpetovan@gmail.com>
+ * @author Hypolite Petovan <hypolite@mrpetovan.com>
* @author Roland Haeder <roland@mxchange.org>
*/
-class RedisCacheDriver extends BaseObject implements IMemoryCacheDriver
+class RedisCacheDriver extends AbstractCacheDriver implements IMemoryCacheDriver
{
/**
- * @var \Redis
+ * @var Redis
*/
private $redis;
- public function __construct($redis_host, $redis_port)
+ /**
+ * @param string $redis_host
+ * @param int $redis_port
+ * @param int $redis_db (Default = 0, maximum is 15)
+ * @param string? $redis_pw
+ * @throws Exception
+ */
+ public function __construct($redis_host, $redis_port, $redis_db = 0, $redis_pw = null)
{
if (!class_exists('Redis', false)) {
- throw new \Exception('Redis class isn\'t available');
+ throw new Exception('Redis class isn\'t available');
}
- $this->redis = new \Redis();
+ $this->redis = new Redis();
if (!$this->redis->connect($redis_host, $redis_port)) {
- throw new \Exception('Expected Redis server at ' . $redis_host . ':' . $redis_port . ' isn\'t available');
+ throw new Exception('Expected Redis server at ' . $redis_host . ':' . $redis_port . ' isn\'t available');
+ }
+
+ if (isset($redis_pw) && !$this->redis->auth($redis_pw)) {
+ throw new Exception('Cannot authenticate redis server at ' . $redis_host . ':' . $redis_port);
+ }
+
+ if ($redis_db !== 0 && !$this->redis->select($redis_db)) {
+ throw new Exception('Cannot switch to redis db ' . $redis_db . ' at ' . $redis_host . ':' . $redis_port);
+ }
+ }
+
+ /**
+ * (@inheritdoc)
+ */
+ public function getAllKeys($prefix = null)
+ {
+ if (empty($prefix)) {
+ $search = '*';
+ } else {
+ $search = $prefix . '*';
}
+
+ $list = $this->redis->keys($this->getCacheKey($search));
+
+ return $this->getOriginalKeys($list);
}
+ /**
+ * (@inheritdoc)
+ */
public function get($key)
{
$return = null;
+ $cachekey = $this->getCacheKey($key);
- // We fetch with the hostname as key to avoid problems with other applications
- $cached = $this->redis->get(self::getApp()->get_hostname() . ':' . $key);
-
- // @see http://php.net/manual/en/redis.get.php#84275
- if (is_bool($cached) || is_double($cached) || is_long($cached)) {
- return $return;
+ $cached = $this->redis->get($cachekey);
+ if ($cached === false && !$this->redis->exists($cachekey)) {
+ return null;
}
- $value = @unserialize($cached);
+ $value = unserialize($cached);
// Only return a value if the serialized value is valid.
// We also check if the db entry is a serialized
return $return;
}
+ /**
+ * (@inheritdoc)
+ */
public function set($key, $value, $ttl = Cache::FIVE_MINUTES)
{
- // We store with the hostname as key to avoid problems with other applications
+ $cachekey = $this->getCacheKey($key);
+
+ $cached = serialize($value);
+
if ($ttl > 0) {
return $this->redis->setex(
- self::getApp()->get_hostname() . ":" . $key,
- time() + $ttl,
- serialize($value)
+ $cachekey,
+ $ttl,
+ $cached
);
} else {
return $this->redis->set(
- self::getApp()->get_hostname() . ":" . $key,
- serialize($value)
+ $cachekey,
+ $cached
);
}
}
+ /**
+ * (@inheritdoc)
+ */
public function delete($key)
{
- return $this->redis->delete($key);
+ $cachekey = $this->getCacheKey($key);
+ return ($this->redis->delete($cachekey) > 0);
}
- public function clear()
+ /**
+ * (@inheritdoc)
+ */
+ public function clear($outdated = true)
{
- return true;
+ if ($outdated) {
+ return true;
+ } else {
+ return $this->redis->flushAll();
+ }
}
-
/**
* (@inheritdoc)
*/
public function add($key, $value, $ttl = Cache::FIVE_MINUTES)
{
- if (!is_int($value)) {
- $value = serialize($value);
- }
+ $cachekey = $this->getCacheKey($key);
+ $cached = serialize($value);
- return $this->redis->setnx(self::getApp()->get_hostname() . ":" . $key, $value);
+ return $this->redis->setnx($cachekey, $cached);
}
/**
*/
public function compareSet($key, $oldValue, $newValue, $ttl = Cache::FIVE_MINUTES)
{
- if (!is_int($newValue)) {
- $newValue = serialize($newValue);
- }
+ $cachekey = $this->getCacheKey($key);
+
+ $newCached = serialize($newValue);
- $this->redis->watch(self::getApp()->get_hostname() . ":" . $key);
+ $this->redis->watch($cachekey);
// If the old value isn't what we expected, somebody else changed the key meanwhile
if ($this->get($key) === $oldValue) {
if ($ttl > 0) {
$result = $this->redis->multi()
- ->setex(self::getApp()->get_hostname() . ":" . $ttl, $key, $newValue)
+ ->setex($cachekey, $ttl, $newCached)
->exec();
} else {
$result = $this->redis->multi()
- ->set(self::getApp()->get_hostname() . ":" . $key, $newValue)
+ ->set($cachekey, $newCached)
->exec();
}
return $result !== false;
$this->redis->unwatch();
return false;
}
+
/**
* (@inheritdoc)
*/
public function compareDelete($key, $value)
{
- $this->redis->watch(self::getApp()->get_hostname() . ":" . $key);
+ $cachekey = $this->getCacheKey($key);
+
+ $this->redis->watch($cachekey);
// If the old value isn't what we expected, somebody else changed the key meanwhile
if ($this->get($key) === $value) {
$result = $this->redis->multi()
- ->del(self::getApp()->get_hostname() . ":" . $key)
+ ->del($cachekey)
->exec();
return $result !== false;
}