2018-05-13 01:38:53 -04:00
|
|
|
<?php
|
|
|
|
|
|
|
|
namespace Friendica\Core\Cache;
|
|
|
|
|
|
|
|
use Friendica\Core\Cache;
|
|
|
|
|
2018-07-10 18:55:01 -04:00
|
|
|
use Exception;
|
|
|
|
use Redis;
|
|
|
|
|
2018-05-13 01:38:53 -04:00
|
|
|
/**
|
|
|
|
* Redis Cache Driver. This driver is based on Memcache driver
|
|
|
|
*
|
|
|
|
* @author Hypolite Petovan <mrpetovan@gmail.com>
|
|
|
|
* @author Roland Haeder <roland@mxchange.org>
|
|
|
|
*/
|
2018-07-05 15:54:20 -04:00
|
|
|
class RedisCacheDriver extends AbstractCacheDriver implements IMemoryCacheDriver
|
2018-05-13 01:38:53 -04:00
|
|
|
{
|
|
|
|
/**
|
2018-07-10 18:55:01 -04:00
|
|
|
* @var Redis
|
2018-05-13 01:38:53 -04:00
|
|
|
*/
|
|
|
|
private $redis;
|
|
|
|
|
|
|
|
public function __construct($redis_host, $redis_port)
|
|
|
|
{
|
|
|
|
if (!class_exists('Redis', false)) {
|
2018-07-10 18:55:01 -04:00
|
|
|
throw new Exception('Redis class isn\'t available');
|
2018-05-13 01:38:53 -04:00
|
|
|
}
|
|
|
|
|
2018-07-10 18:55:01 -04:00
|
|
|
$this->redis = new Redis();
|
2018-05-13 01:38:53 -04:00
|
|
|
|
|
|
|
if (!$this->redis->connect($redis_host, $redis_port)) {
|
2018-07-10 18:55:01 -04:00
|
|
|
throw new Exception('Expected Redis server at ' . $redis_host . ':' . $redis_port . ' isn\'t available');
|
2018-05-13 01:38:53 -04:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
public function get($key)
|
|
|
|
{
|
|
|
|
$return = null;
|
2018-07-05 15:47:52 -04:00
|
|
|
$cachekey = $this->getCacheKey($key);
|
2018-05-13 01:38:53 -04:00
|
|
|
|
2018-07-05 15:47:52 -04:00
|
|
|
$cached = $this->redis->get($cachekey);
|
2018-07-07 10:15:03 -04:00
|
|
|
if ($cached === false && !$this->redis->exists($cachekey)) {
|
|
|
|
return null;
|
2018-05-13 01:38:53 -04:00
|
|
|
}
|
|
|
|
|
2018-07-08 07:35:28 -04:00
|
|
|
$value = unserialize($cached);
|
2018-05-13 01:38:53 -04:00
|
|
|
|
|
|
|
// Only return a value if the serialized value is valid.
|
|
|
|
// We also check if the db entry is a serialized
|
|
|
|
// boolean 'false' value (which we want to return).
|
|
|
|
if ($cached === serialize(false) || $value !== false) {
|
|
|
|
$return = $value;
|
|
|
|
}
|
|
|
|
|
|
|
|
return $return;
|
|
|
|
}
|
|
|
|
|
2018-07-04 17:37:22 -04:00
|
|
|
public function set($key, $value, $ttl = Cache::FIVE_MINUTES)
|
2018-05-13 01:38:53 -04:00
|
|
|
{
|
2018-07-05 15:47:52 -04:00
|
|
|
$cachekey = $this->getCacheKey($key);
|
|
|
|
|
2018-07-08 07:35:28 -04:00
|
|
|
$cached = serialize($value);
|
2018-07-07 10:15:03 -04:00
|
|
|
|
2018-07-04 17:37:22 -04:00
|
|
|
if ($ttl > 0) {
|
|
|
|
return $this->redis->setex(
|
2018-07-05 15:47:52 -04:00
|
|
|
$cachekey,
|
2018-07-07 13:46:16 -04:00
|
|
|
$ttl,
|
2018-07-07 10:15:03 -04:00
|
|
|
$cached
|
2018-07-04 17:37:22 -04:00
|
|
|
);
|
|
|
|
} else {
|
|
|
|
return $this->redis->set(
|
2018-07-05 15:47:52 -04:00
|
|
|
$cachekey,
|
2018-07-07 10:15:03 -04:00
|
|
|
$cached
|
2018-07-04 17:37:22 -04:00
|
|
|
);
|
|
|
|
}
|
2018-05-13 01:38:53 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
public function delete($key)
|
|
|
|
{
|
2018-07-07 12:39:33 -04:00
|
|
|
$cachekey = $this->getCacheKey($key);
|
|
|
|
return ($this->redis->delete($cachekey) > 0);
|
2018-05-13 01:38:53 -04:00
|
|
|
}
|
|
|
|
|
2018-07-07 13:46:16 -04:00
|
|
|
public function clear($outdated = true)
|
2018-05-13 01:38:53 -04:00
|
|
|
{
|
2018-07-07 13:46:16 -04:00
|
|
|
if ($outdated) {
|
|
|
|
return true;
|
|
|
|
} else {
|
|
|
|
return $this->redis->flushAll();
|
|
|
|
}
|
2018-05-13 01:38:53 -04:00
|
|
|
}
|
2018-07-04 17:37:22 -04:00
|
|
|
|
|
|
|
/**
|
2018-07-05 01:59:56 -04:00
|
|
|
* (@inheritdoc)
|
2018-07-04 17:37:22 -04:00
|
|
|
*/
|
|
|
|
public function add($key, $value, $ttl = Cache::FIVE_MINUTES)
|
|
|
|
{
|
2018-07-05 15:47:52 -04:00
|
|
|
$cachekey = $this->getCacheKey($key);
|
2018-07-08 07:35:28 -04:00
|
|
|
$cached = serialize($value);
|
2018-07-04 17:37:22 -04:00
|
|
|
|
2018-07-07 13:46:16 -04:00
|
|
|
return $this->redis->setnx($cachekey, $cached);
|
2018-07-04 17:37:22 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2018-07-05 01:59:56 -04:00
|
|
|
* (@inheritdoc)
|
2018-07-04 17:37:22 -04:00
|
|
|
*/
|
|
|
|
public function compareSet($key, $oldValue, $newValue, $ttl = Cache::FIVE_MINUTES)
|
|
|
|
{
|
2018-07-05 15:47:52 -04:00
|
|
|
$cachekey = $this->getCacheKey($key);
|
|
|
|
|
2018-07-08 07:35:28 -04:00
|
|
|
$newCached = serialize($newValue);
|
2018-07-04 17:37:22 -04:00
|
|
|
|
2018-07-05 15:47:52 -04:00
|
|
|
$this->redis->watch($cachekey);
|
2018-07-04 17:37:22 -04:00
|
|
|
// If the old value isn't what we expected, somebody else changed the key meanwhile
|
2018-07-07 10:15:03 -04:00
|
|
|
if ($this->get($key) === $oldValue) {
|
2018-07-04 17:37:22 -04:00
|
|
|
if ($ttl > 0) {
|
|
|
|
$result = $this->redis->multi()
|
2018-07-07 10:15:03 -04:00
|
|
|
->setex($cachekey, $ttl, $newCached)
|
2018-07-04 17:37:22 -04:00
|
|
|
->exec();
|
|
|
|
} else {
|
|
|
|
$result = $this->redis->multi()
|
2018-07-05 15:47:52 -04:00
|
|
|
->set($cachekey, $newValue)
|
2018-07-04 17:37:22 -04:00
|
|
|
->exec();
|
|
|
|
}
|
|
|
|
return $result !== false;
|
|
|
|
}
|
|
|
|
$this->redis->unwatch();
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
/**
|
2018-07-05 01:59:56 -04:00
|
|
|
* (@inheritdoc)
|
2018-07-04 17:37:22 -04:00
|
|
|
*/
|
|
|
|
public function compareDelete($key, $value)
|
|
|
|
{
|
2018-07-05 15:47:52 -04:00
|
|
|
$cachekey = $this->getCacheKey($key);
|
|
|
|
|
|
|
|
$this->redis->watch($cachekey);
|
2018-07-04 17:37:22 -04:00
|
|
|
// If the old value isn't what we expected, somebody else changed the key meanwhile
|
|
|
|
if ($this->get($key) === $value) {
|
|
|
|
$result = $this->redis->multi()
|
2018-07-05 15:47:52 -04:00
|
|
|
->del($cachekey)
|
2018-07-04 17:37:22 -04:00
|
|
|
->exec();
|
|
|
|
return $result !== false;
|
|
|
|
}
|
|
|
|
$this->redis->unwatch();
|
|
|
|
return false;
|
|
|
|
}
|
2018-05-13 01:38:53 -04:00
|
|
|
}
|