Merge pull request #7255 from annando/issue-7223

[friendica.git] / src / Core / Cache / RedisCacheDriver.php

diff --git a/src/Core/Cache/RedisCacheDriver.php b/src/Core/Cache/RedisCacheDriver.php
index 67df8e8fee21904dee1583074c411a91fb8a0376..ea4eb4390a629c9c2a9b42fef9baeddcc659df2b 100644 (file)
--- a/src/Core/Cache/RedisCacheDriver.php
+++ b/src/Core/Cache/RedisCacheDriver.php
@@ -2,48 +2,81 @@
 
 namespace Friendica\Core\Cache;
 
+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 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($cachekey);
-
-               // @see http://php.net/manual/en/redis.get.php#84275
-               if (is_bool($cached) || is_double($cached) || is_long($cached)) {
-                       return $return;
+               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
@@ -55,48 +88,59 @@ class RedisCacheDriver extends AbstractCacheDriver implements IMemoryCacheDriver
                return $return;
        }
 
+       /**
+        * (@inheritdoc)
+        */
        public function set($key, $value, $ttl = Cache::FIVE_MINUTES)
        {
                $cachekey = $this->getCacheKey($key);
 
-               // We store with the hostname as key to avoid problems with other applications
+               $cached = serialize($value);
+
                if ($ttl > 0) {
                        return $this->redis->setex(
                                $cachekey,
-                               time() + $ttl,
-                               serialize($value)
+                               $ttl,
+                               $cached
                        );
                } else {
                        return $this->redis->set(
                                $cachekey,
-                               serialize($value)
+                               $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)
        {
                $cachekey = $this->getCacheKey($key);
+               $cached = serialize($value);
 
-               if (!is_int($value)) {
-                       $value = serialize($value);
-               }
-
-               return $this->redis->setnx($cachekey, $value);
+               return $this->redis->setnx($cachekey, $cached);
        }
 
        /**
@@ -106,20 +150,18 @@ class RedisCacheDriver extends AbstractCacheDriver implements IMemoryCacheDriver
        {
                $cachekey = $this->getCacheKey($key);
 
-               if (!is_int($newValue)) {
-                       $newValue = serialize($newValue);
-               }
+               $newCached = serialize($newValue);
 
                $this->redis->watch($cachekey);
                // If the old value isn't what we expected, somebody else changed the key meanwhile
-               if ($this->get($cachekey) === $oldValue) {
+               if ($this->get($key) === $oldValue) {
                        if ($ttl > 0) {
                                $result = $this->redis->multi()
-                                       ->setex($cachekey, $ttl, $newValue)
+                                       ->setex($cachekey, $ttl, $newCached)
                                        ->exec();
                        } else {
                                $result = $this->redis->multi()
-                                       ->set($cachekey, $newValue)
+                                       ->set($cachekey, $newCached)
                                        ->exec();
                        }
                        return $result !== false;
@@ -127,6 +169,7 @@ class RedisCacheDriver extends AbstractCacheDriver implements IMemoryCacheDriver
                $this->redis->unwatch();
                return false;
        }
+
        /**
         * (@inheritdoc)
         */