Support PECL memcached extension as a session and cache storage driver (experimental)
Aleksander Machniak
5 years ago
parent
2a25f1778b
commit
fdac30e544
@ -0,0 +1,215 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
+-----------------------------------------------------------------------+
|
||||
| This file is part of the Roundcube Webmail client |
|
||||
| |
|
||||
| Copyright (C) The Roundcube Dev Team |
|
||||
| Copyright (C) Kolab Systems AG |
|
||||
| |
|
||||
| Licensed under the GNU General Public License version 3 or |
|
||||
| any later version with exceptions for skins & plugins. |
|
||||
| See the README file for a full license statement. |
|
||||
| |
|
||||
| PURPOSE: |
|
||||
| Caching engine - Memcache |
|
||||
+-----------------------------------------------------------------------+
|
||||
| Author: Thomas Bruederli <roundcube@gmail.com> |
|
||||
| Author: Aleksander Machniak <alec@alec.pl> |
|
||||
+-----------------------------------------------------------------------+
|
||||
*/
|
||||
|
||||
/**
|
||||
* Interface class for accessing Memcached cache
|
||||
*
|
||||
* @package Framework
|
||||
* @subpackage Cache
|
||||
* @author Thomas Bruederli <roundcube@gmail.com>
|
||||
* @author Aleksander Machniak <alec@alec.pl>
|
||||
*/
|
||||
class rcube_cache_memcached extends rcube_cache
|
||||
{
|
||||
/**
|
||||
* Instance of memcached handler
|
||||
*
|
||||
* @var Memcached
|
||||
*/
|
||||
protected static $memcache;
|
||||
|
||||
|
||||
/**
|
||||
* Object constructor.
|
||||
*
|
||||
* @param int $userid User identifier
|
||||
* @param string $prefix Key name prefix
|
||||
* @param string $ttl Expiration time of memcache/apc items
|
||||
* @param bool $packed Enables/disabled data serialization.
|
||||
* It's possible to disable data serialization if you're sure
|
||||
* stored data will be always a safe string
|
||||
*/
|
||||
public function __construct($userid, $prefix = '', $ttl = 0, $packed = true)
|
||||
{
|
||||
parent::__construct($userid, $prefix, $ttl, $packed);
|
||||
|
||||
$this->type = 'memcache';
|
||||
$this->debug = rcube::get_instance()->config->get('memcache_debug');
|
||||
|
||||
// Maximum TTL is 30 days, bigger values are treated by Memcached
|
||||
// as unix timestamp which is not what we want
|
||||
if ($this->ttl > 60*60*24*30) {
|
||||
$this->ttl = 60*60*24*30;
|
||||
}
|
||||
|
||||
self::engine();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get global handle for memcache access
|
||||
*
|
||||
* @return object Memcache
|
||||
*/
|
||||
public static function engine()
|
||||
{
|
||||
if (self::$memcache !== null) {
|
||||
return self::$memcache;
|
||||
}
|
||||
|
||||
// no memcache support in PHP
|
||||
if (!class_exists('Memcached')) {
|
||||
self::$memcache = false;
|
||||
|
||||
rcube::raise_error(array(
|
||||
'code' => 604, 'type' => 'memcache', 'line' => __LINE__, 'file' => __FILE__,
|
||||
'message' => "Failed to find Memcached. Make sure php-memcached is installed"
|
||||
),
|
||||
true, true);
|
||||
}
|
||||
|
||||
// add all configured hosts to pool
|
||||
$rcube = rcube::get_instance();
|
||||
$pconnect = $rcube->config->get('memcache_pconnect', true);
|
||||
$timeout = $rcube->config->get('memcache_timeout', 1);
|
||||
$retry_interval = $rcube->config->get('memcache_retry_interval', 15);
|
||||
|
||||
self::$memcache = new Memcached($pconnect ? 'roundcube' : null);
|
||||
|
||||
self::$memcache->setOptions(array(
|
||||
Memcached::OPT_CONNECT_TIMEOUT => $timeout * 1000,
|
||||
Memcached::OPT_RETRY_TIMEOUT => $timeout,
|
||||
Memcached::OPT_DISTRIBUTION => Memcached::DISTRIBUTION_CONSISTENT,
|
||||
Memcached::OPT_COMPRESSION => true,
|
||||
));
|
||||
|
||||
foreach ((array) $rcube->config->get('memcache_hosts') as $host) {
|
||||
if (substr($host, 0, 7) != 'unix://') {
|
||||
list($host, $port) = explode(':', $host);
|
||||
if (!$port) $port = 11211;
|
||||
}
|
||||
else {
|
||||
$host = substr($host, 8);
|
||||
$port = 0;
|
||||
}
|
||||
|
||||
self::$memcache->addServer($host, $port);
|
||||
}
|
||||
|
||||
// test connection
|
||||
$result = self::$memcache->increment('__CONNECTIONTEST__');
|
||||
|
||||
if ($result === false && ($res_code = self::$memcache->getResultCode()) !== Memcached::RES_NOTFOUND) {
|
||||
self::$memcache = false;
|
||||
|
||||
rcube::raise_error(array(
|
||||
'code' => 604, 'type' => 'memcache', 'line' => __LINE__, 'file' => __FILE__,
|
||||
'message' => "Memcache connection failure (code: $res_code)."
|
||||
),
|
||||
true, false);
|
||||
}
|
||||
|
||||
return self::$memcache;
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove cache records older than ttl
|
||||
*/
|
||||
public function expunge()
|
||||
{
|
||||
// No need for GC, entries are expunged automatically
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove expired records of all caches
|
||||
*/
|
||||
public static function gc()
|
||||
{
|
||||
// No need for GC, entries are expunged automatically
|
||||
}
|
||||
|
||||
/**
|
||||
* Reads cache entry.
|
||||
*
|
||||
* @param string $key Cache internal key name
|
||||
*
|
||||
* @return mixed Cached value
|
||||
*/
|
||||
protected function get_item($key)
|
||||
{
|
||||
if (!self::$memcache) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$data = self::$memcache->get($key);
|
||||
|
||||
if ($this->debug) {
|
||||
$this->debug('get', $key, $data);
|
||||
}
|
||||
|
||||
return $data;
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds entry into the cache.
|
||||
*
|
||||
* @param string $key Cache internal key name
|
||||
* @param mixed $data Serialized cache data
|
||||
*
|
||||
* @param boolean True on success, False on failure
|
||||
*/
|
||||
protected function add_item($key, $data)
|
||||
{
|
||||
if (!self::$memcache) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$result = self::$memcache->set($key, $data, $this->ttl);
|
||||
|
||||
if ($this->debug) {
|
||||
$this->debug('set', $key, $data, $result);
|
||||
}
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Deletes entry from the cache
|
||||
*
|
||||
* @param string $key Cache internal key name
|
||||
*
|
||||
* @param boolean True on success, False on failure
|
||||
*/
|
||||
protected function delete_item($key)
|
||||
{
|
||||
if (!self::$memcache) {
|
||||
return false;
|
||||
}
|
||||
|
||||
// #1488592: use 2nd argument
|
||||
$result = self::$memcache->delete($key, 0);
|
||||
|
||||
if ($this->debug) {
|
||||
$this->debug('delete', $key, null, $result);
|
||||
}
|
||||
|
||||
return $result;
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,197 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
+-----------------------------------------------------------------------+
|
||||
| This file is part of the Roundcube Webmail client |
|
||||
| |
|
||||
| Copyright (C) The Roundcube Dev Team |
|
||||
| Copyright (C) Kolab Systems AG |
|
||||
| |
|
||||
| Licensed under the GNU General Public License version 3 or |
|
||||
| any later version with exceptions for skins & plugins. |
|
||||
| See the README file for a full license statement. |
|
||||
| |
|
||||
| PURPOSE: |
|
||||
| Provide memcached supported session management |
|
||||
+-----------------------------------------------------------------------+
|
||||
| Author: Thomas Bruederli <roundcube@gmail.com> |
|
||||
| Author: Aleksander Machniak <alec@alec.pl> |
|
||||
| Author: Cor Bosman <cor@roundcu.bet> |
|
||||
+-----------------------------------------------------------------------+
|
||||
*/
|
||||
|
||||
/**
|
||||
* Class to provide memcached session storage
|
||||
*
|
||||
* @package Framework
|
||||
* @subpackage Core
|
||||
* @author Thomas Bruederli <roundcube@gmail.com>
|
||||
* @author Aleksander Machniak <alec@alec.pl>
|
||||
* @author Cor Bosman <cor@roundcu.be>
|
||||
*/
|
||||
class rcube_session_memcached extends rcube_session
|
||||
{
|
||||
private $memcache;
|
||||
private $debug;
|
||||
|
||||
/**
|
||||
* Object constructor
|
||||
*
|
||||
* @param rcube_config $config Configuration
|
||||
*/
|
||||
public function __construct($config)
|
||||
{
|
||||
parent::__construct($config);
|
||||
|
||||
$this->memcache = rcube::get_instance()->get_memcached();
|
||||
$this->debug = $config->get('memcache_debug');
|
||||
|
||||
if (!$this->memcache) {
|
||||
rcube::raise_error(array(
|
||||
'code' => 604, 'type' => 'db',
|
||||
'line' => __LINE__, 'file' => __FILE__,
|
||||
'message' => "Failed to connect to memcached. Please check configuration"),
|
||||
true, true);
|
||||
}
|
||||
|
||||
// register sessions handler
|
||||
$this->register_session_handler();
|
||||
}
|
||||
|
||||
/**
|
||||
* Opens the session
|
||||
*
|
||||
* @param string $save_path Session save path
|
||||
* @param string $session_name Session name
|
||||
*
|
||||
* @return bool True on success, False on failure
|
||||
*/
|
||||
public function open($save_path, $session_name)
|
||||
{
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Close the session
|
||||
*
|
||||
* @return bool True on success, False on failure
|
||||
*/
|
||||
public function close()
|
||||
{
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Destroy the session
|
||||
*
|
||||
* @param string $key Session identifier
|
||||
*
|
||||
* @return bool True on success, False on failure
|
||||
*/
|
||||
public function destroy($key)
|
||||
{
|
||||
if ($key) {
|
||||
// #1488592: use 2nd argument
|
||||
$result = $this->memcache->delete($key, 0);
|
||||
|
||||
if ($this->debug) {
|
||||
$this->debug('delete', $key, null, $result);
|
||||
}
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Read session data from memcache
|
||||
*
|
||||
* @param string $key Session identifier
|
||||
*
|
||||
* @return string Serialized data string
|
||||
*/
|
||||
public function read($key)
|
||||
{
|
||||
if ($arr = $this->memcache->get($key)) {
|
||||
$this->changed = $arr['changed'];
|
||||
$this->ip = $arr['ip'];
|
||||
$this->vars = $arr['vars'];
|
||||
$this->key = $key;
|
||||
}
|
||||
|
||||
if ($this->debug) {
|
||||
$this->debug('get', $key, $arr ? serialize($arr) : '');
|
||||
}
|
||||
|
||||
return $this->vars ?: '';
|
||||
}
|
||||
|
||||
/**
|
||||
* Write data to memcache storage
|
||||
*
|
||||
* @param string $key Session identifier
|
||||
* @param string $vars Session data string
|
||||
*
|
||||
* @return bool True on success, False on failure
|
||||
*/
|
||||
public function write($key, $vars)
|
||||
{
|
||||
if ($this->ignore_write) {
|
||||
return true;
|
||||
}
|
||||
|
||||
$data = array('changed' => time(), 'ip' => $this->ip, 'vars' => $vars);
|
||||
$result = $this->memcache->set($key, $data, $this->lifetime + 60);
|
||||
|
||||
if ($this->debug) {
|
||||
$this->debug('set', $key, serialize($data), $result);
|
||||
}
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Update memcache session data
|
||||
*
|
||||
* @param string $key Session identifier
|
||||
* @param string $newvars New session data string
|
||||
* @param string $oldvars Old session data string
|
||||
*
|
||||
* @return bool True on success, False on failure
|
||||
*/
|
||||
public function update($key, $newvars, $oldvars)
|
||||
{
|
||||
$ts = microtime(true);
|
||||
|
||||
if ($newvars !== $oldvars || $ts - $this->changed > $this->lifetime / 3) {
|
||||
$data = array('changed' => time(), 'ip' => $this->ip, 'vars' => $newvars);
|
||||
$result = $this->memcache->set($key, $data, $this->lifetime + 60);
|
||||
|
||||
if ($this->debug) {
|
||||
$this->debug('set', $key, serialize($data), $result);
|
||||
}
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Write memcache debug info to the log
|
||||
*
|
||||
* @param string $type Operation type
|
||||
* @param string $key Session identifier
|
||||
* @param string $data Data to log
|
||||
* @param bool $result Opearation result
|
||||
*/
|
||||
protected function debug($type, $key, $data = null, $result = null)
|
||||
{
|
||||
$line = strtoupper($type) . ' ' . $key;
|
||||
|
||||
if ($data !== null) {
|
||||
$line .= ' ' . $data;
|
||||
}
|
||||
|
||||
rcube::debug('memcache', $line, $result);
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue