Move \OC\Memcache to PSR-4

1 files changed, 208 insertions, 0 deletions

diff --git a/lib/private/Memcache/Redis.php b/lib/private/Memcache/Redis.php
new file mode 100644
index 00000000000..b3444a2b4e9
--- /dev/null
+++ b/lib/private/Memcache/Redis.php
@@ -0,0 +1,208 @@
+<?php
+/**
+ * @author Joas Schilling <nickvergessen@owncloud.com>
+ * @author Jörn Friedrich Dreyer <jfd@butonic.de>
+ * @author Lukas Reschke <lukas@owncloud.com>
+ * @author Michael Telatynski <7t3chguy@gmail.com>
+ * @author Morris Jobke <hey@morrisjobke.de>
+ * @author Robin Appelman <icewind@owncloud.com>
+ *
+ * @copyright Copyright (c) 2016, ownCloud, Inc.
+ * @license AGPL-3.0
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License, version 3,
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+namespace OC\Memcache;
+
+use OCP\IMemcacheTTL;
+
+class Redis extends Cache implements IMemcacheTTL {
+	/**
+	 * @var \Redis $cache
+	 */
+	private static $cache = null;
+
+	public function __construct($prefix = '') {
+		parent::__construct($prefix);
+		if (is_null(self::$cache)) {
+			// TODO allow configuring a RedisArray, see https://github.com/nicolasff/phpredis/blob/master/arrays.markdown#redis-arrays
+			self::$cache = new \Redis();
+			$config = \OC::$server->getSystemConfig()->getValue('redis', array());
+			if (isset($config['host'])) {
+				$host = $config['host'];
+			} else {
+				$host = '127.0.0.1';
+			}
+			if (isset($config['port'])) {
+				$port = $config['port'];
+			} else {
+				$port = 6379;
+			}
+			if (isset($config['timeout'])) {
+				$timeout = $config['timeout'];
+			} else {
+				$timeout = 0.0; // unlimited
+			}
+
+			self::$cache->connect($host, $port, $timeout);
+			if(isset($config['password']) && $config['password'] !== '') {
+				self::$cache->auth($config['password']);
+			}
+
+			if (isset($config['dbindex'])) {
+				self::$cache->select($config['dbindex']);
+			}
+		}
+	}
+
+	/**
+	 * entries in redis get namespaced to prevent collisions between ownCloud instances and users
+	 */
+	protected function getNameSpace() {
+		return $this->prefix;
+	}
+
+	public function get($key) {
+		$result = self::$cache->get($this->getNamespace() . $key);
+		if ($result === false && !self::$cache->exists($this->getNamespace() . $key)) {
+			return null;
+		} else {
+			return json_decode($result, true);
+		}
+	}
+
+	public function set($key, $value, $ttl = 0) {
+		if ($ttl > 0) {
+			return self::$cache->setex($this->getNamespace() . $key, $ttl, json_encode($value));
+		} else {
+			return self::$cache->set($this->getNamespace() . $key, json_encode($value));
+		}
+	}
+
+	public function hasKey($key) {
+		return self::$cache->exists($this->getNamespace() . $key);
+	}
+
+	public function remove($key) {
+		if (self::$cache->delete($this->getNamespace() . $key)) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+	public function clear($prefix = '') {
+		$prefix = $this->getNamespace() . $prefix . '*';
+		$it = null;
+		self::$cache->setOption(\Redis::OPT_SCAN, \Redis::SCAN_RETRY);
+		while ($keys = self::$cache->scan($it, $prefix)) {
+			self::$cache->delete($keys);
+		}
+		return true;
+	}
+
+	/**
+	 * Set a value in the cache if it's not already stored
+	 *
+	 * @param string $key
+	 * @param mixed $value
+	 * @param int $ttl Time To Live in seconds. Defaults to 60*60*24
+	 * @return bool
+	 */
+	public function add($key, $value, $ttl = 0) {
+		// don't encode ints for inc/dec
+		if (!is_int($value)) {
+			$value = json_encode($value);
+		}
+		return self::$cache->setnx($this->getPrefix() . $key, $value);
+	}
+
+	/**
+	 * Increase a stored number
+	 *
+	 * @param string $key
+	 * @param int $step
+	 * @return int | bool
+	 */
+	public function inc($key, $step = 1) {
+		return self::$cache->incrBy($this->getNamespace() . $key, $step);
+	}
+
+	/**
+	 * Decrease a stored number
+	 *
+	 * @param string $key
+	 * @param int $step
+	 * @return int | bool
+	 */
+	public function dec($key, $step = 1) {
+		if (!$this->hasKey($key)) {
+			return false;
+		}
+		return self::$cache->decrBy($this->getNamespace() . $key, $step);
+	}
+
+	/**
+	 * Compare and set
+	 *
+	 * @param string $key
+	 * @param mixed $old
+	 * @param mixed $new
+	 * @return bool
+	 */
+	public function cas($key, $old, $new) {
+		if (!is_int($new)) {
+			$new = json_encode($new);
+		}
+		self::$cache->watch($this->getNamespace() . $key);
+		if ($this->get($key) === $old) {
+			$result = self::$cache->multi()
+				->set($this->getNamespace() . $key, $new)
+				->exec();
+			return ($result === false) ? false : true;
+		}
+		self::$cache->unwatch();
+		return false;
+	}
+
+	/**
+	 * Compare and delete
+	 *
+	 * @param string $key
+	 * @param mixed $old
+	 * @return bool
+	 */
+	public function cad($key, $old) {
+		self::$cache->watch($this->getNamespace() . $key);
+		if ($this->get($key) === $old) {
+			$result = self::$cache->multi()
+				->del($this->getNamespace() . $key)
+				->exec();
+			return ($result === false) ? false : true;
+		}
+		self::$cache->unwatch();
+		return false;
+	}
+
+	public function setTTL($key, $ttl) {
+		self::$cache->expire($this->getNamespace() . $key, $ttl);
+	}
+
+	static public function isAvailable() {
+		return extension_loaded('redis')
+		&& version_compare(phpversion('redis'), '2.2.5', '>=');
+	}
+}
+