[ticket/15122] Add cache driver for memcached

PHPBB3-15122

phpBB/phpbb/cache/driver/memcached.php

@@ -0,0 +1,134 @@
+<?php
+/**
+*
+* This file is part of the phpBB Forum Software package.
+*
+* @copyright (c) phpBB Limited <https://www.phpbb.com>
+* @license GNU General Public License, version 2 (GPL-2.0)
+*
+* For full copyright and license information, please see
+* the docs/CREDITS.txt file.
+*
+*/
+
+namespace phpbb\cache\driver;
+
+if (!defined('PHPBB_ACM_MEMCACHED_PORT'))
+{
+	define('PHPBB_ACM_MEMCACHED_PORT', 11211);
+}
+
+if (!defined('PHPBB_ACM_MEMCACHED_COMPRESS'))
+{
+	define('PHPBB_ACM_MEMCACHED_COMPRESS', true);
+}
+
+if (!defined('PHPBB_ACM_MEMCACHED_HOST'))
+{
+	define('PHPBB_ACM_MEMCACHED_HOST', 'localhost');
+}
+
+if (!defined('PHPBB_ACM_MEMCACHED'))
+{
+	//can define multiple servers with host1/port1,host2/port2 format
+	define('PHPBB_ACM_MEMCACHED', PHPBB_ACM_MEMCACHED_HOST . '/' . PHPBB_ACM_MEMCACHED_PORT);
+}
+
+/**
+* ACM for Memcached
+*/
+class memcached extends \phpbb\cache\driver\memory
+{
+	/** @var string Extension to use */
+	protected $extension = 'memcached';
+
+	/** @var \Memcached Memcached class */
+	protected $memcached;
+
+	/** @var int Flags */
+	protected $flags = 0;
+
+	/**
+	 * Memcached constructor
+	 */
+	public function __construct()
+	{
+		// Call the parent constructor
+		parent::__construct();
+
+		$this->memcached = new \Memcached();
+		$this->memcached->setOption(\Memcached::OPT_BINARY_PROTOCOL, true);
+		// Memcached defaults to using compression, disable if we don't want
+		// to use it
+		if (!PHPBB_ACM_MEMCACHED_COMPRESS)
+		{
+			$this->memcached->setOption(\Memcached::OPT_COMPRESSION, false);
+		}
+
+		foreach (explode(',', PHPBB_ACM_MEMCACHE) as $u)
+		{
+			$parts = explode('/', $u);
+			$this->memcached->addServer(trim($parts[0]), trim($parts[1]));
+		}
+	}
+
+	/**
+	* {@inheritDoc}
+	*/
+	public function unload()
+	{
+		parent::unload();
+
+		unset($this->memcached);
+	}
+
+	/**
+	* {@inheritDoc}
+	*/
+	public function purge()
+	{
+		$this->memcached->flush();
+
+		parent::purge();
+	}
+
+	/**
+	* Fetch an item from the cache
+	*
+	* @param string $var Cache key
+	*
+	* @return mixed Cached data
+	*/
+	protected function _read($var)
+	{
+		return $this->memcached->get($this->key_prefix . $var);
+	}
+
+	/**
+	* Store data in the cache
+	*
+	* @param string $var Cache key
+	* @param mixed $data Data to store
+	* @param int $ttl Time-to-live of cached data
+	* @return bool True if the operation succeeded
+	*/
+	protected function _write($var, $data, $ttl = 2592000)
+	{
+		if (!$this->memcached->replace($this->key_prefix . $var, $data, $ttl))
+		{
+			return $this->memcached->set($this->key_prefix . $var, $data, $ttl);
+		}
+		return true;
+	}
+
+	/**
+	* Remove an item from the cache
+	*
+	* @param string $var Cache key
+	* @return bool True if the operation succeeded
+	*/
+	protected function _delete($var)
+	{
+		return $this->memcached->delete($this->key_prefix . $var);
+	}
+}