From fe2f0be4352ba0bc213a2c6d4dfcbbddea1a551c Mon Sep 17 00:00:00 2001
From: Aleksander Machniak <alec@alec.pl>
Date: Tue, 21 Aug 2012 04:50:14 -0400
Subject: [PATCH] Fix possible PHP warning, read default_folders using config->get() to support deprecated option name (default_imap_folders)
---
program/include/rcube_cache.php | 212 +++++++++++++++++++++++++++++++++++++++-------------
1 files changed, 157 insertions(+), 55 deletions(-)
diff --git a/program/include/rcube_cache.php b/program/include/rcube_cache.php
index 4c193db..4e60dea 100644
--- a/program/include/rcube_cache.php
+++ b/program/include/rcube_cache.php
@@ -7,7 +7,10 @@
| This file is part of the Roundcube Webmail client |
| Copyright (C) 2011, The Roundcube Dev Team |
| Copyright (C) 2011, Kolab Systems AG |
- | Licensed under the GNU GPL |
+ | |
+ | 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 |
@@ -16,9 +19,6 @@
| Author: Thomas Bruederli <roundcube@gmail.com> |
| Author: Aleksander Machniak <alec@alec.pl> |
+-----------------------------------------------------------------------+
-
- $Id$
-
*/
@@ -28,23 +28,23 @@
* @package Cache
* @author Thomas Bruederli <roundcube@gmail.com>
* @author Aleksander Machniak <alec@alec.pl>
- * @version 1.0
+ * @version 1.1
*/
class rcube_cache
{
/**
- * Instance of rcube_mdb2 or Memcache class
+ * Instance of database handler
*
- * @var rcube_mdb2/Memcache
+ * @var rcube_db|Memcache|bool
*/
private $db;
private $type;
private $userid;
private $prefix;
private $ttl;
+ private $packed;
private $index;
private $cache = array();
- private $cache_keys = array();
private $cache_changes = array();
private $cache_sums = array();
@@ -55,16 +55,19 @@
* @param string $type Engine type ('db' or 'memcache' or 'apc')
* @param int $userid User identifier
* @param string $prefix Key name prefix
- * @param int $ttl Expiration time of memcache/apc items in seconds (max.2592000)
+ * @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
*/
- function __construct($type, $userid, $prefix='', $ttl=0)
+ function __construct($type, $userid, $prefix='', $ttl=0, $packed=true)
{
- $rcmail = rcmail::get_instance();
- $type = strtolower($type);
+ $rcube = rcube::get_instance();
+ $type = strtolower($type);
if ($type == 'memcache') {
$this->type = 'memcache';
- $this->db = $rcmail->get_memcache();
+ $this->db = $rcube->get_memcache();
}
else if ($type == 'apc') {
$this->type = 'apc';
@@ -72,12 +75,17 @@
}
else {
$this->type = 'db';
- $this->db = $rcmail->get_dbh();
+ $this->db = $rcube->get_dbh();
}
- $this->userid = (int) $userid;
- $this->ttl = (int) $ttl;
- $this->prefix = $prefix;
+ // convert ttl string to seconds
+ $ttl = get_offset_sec($ttl);
+ if ($ttl > 2592000) $ttl = 2592000;
+
+ $this->userid = (int) $userid;
+ $this->ttl = $ttl;
+ $this->packed = $packed;
+ $this->prefix = $prefix;
}
@@ -113,6 +121,38 @@
/**
+ * Returns cached value without storing it in internal memory.
+ *
+ * @param string $key Cache key name
+ *
+ * @return mixed Cached value
+ */
+ function read($key)
+ {
+ if (array_key_exists($key, $this->cache)) {
+ return $this->cache[$key];
+ }
+
+ return $this->read_record($key, true);
+ }
+
+
+ /**
+ * Sets (add/update) value in cache and immediately saves
+ * it in the backend, no internal memory will be used.
+ *
+ * @param string $key Cache key name
+ * @param mixed $data Cache data
+ *
+ * @param boolean True on success, False on failure
+ */
+ function write($key, $data)
+ {
+ return $this->write_record($key, $this->packed ? serialize($data) : $data);
+ }
+
+
+ /**
* Clears the cache.
*
* @param string $key Cache key name or pattern
@@ -126,7 +166,7 @@
$this->cache = array();
$this->cache_changed = false;
$this->cache_changes = array();
- $this->cache_keys = array();
+ $this->cache_sums = array();
}
// Remove keys by name prefix
else if ($prefix_mode) {
@@ -134,7 +174,7 @@
if (strpos($k, $key) === 0) {
$this->cache[$k] = null;
$this->cache_changes[$k] = false;
- unset($this->cache_keys[$k]);
+ unset($this->cache_sums[$k]);
}
}
}
@@ -142,11 +182,29 @@
else {
$this->cache[$key] = null;
$this->cache_changes[$key] = false;
- unset($this->cache_keys[$key]);
+ unset($this->cache_sums[$key]);
}
// Remove record(s) from the backend
$this->remove_record($key, $prefix_mode);
+ }
+
+
+ /**
+ * Remove cache records older than ttl
+ */
+ function expunge()
+ {
+ if ($this->type == 'db' && $this->db) {
+ $this->db->query(
+ "DELETE FROM ".$this->db->table_name('cache').
+ " WHERE user_id = ?".
+ " AND cache_key LIKE ?".
+ " AND " . $this->db->unixtimestamp('created')." < ?",
+ $this->userid,
+ $this->prefix.'.%',
+ time() - $this->ttl);
+ }
}
@@ -164,7 +222,7 @@
if ($this->cache_changes[$key]) {
// Make sure we're not going to write unchanged data
// by comparing current md5 sum with the sum calculated on DB read
- $data = serialize($data);
+ $data = $this->packed ? serialize($data) : $data;
if (!$this->cache_sums[$key] || $this->cache_sums[$key] != md5($data)) {
$this->write_record($key, $data);
@@ -179,31 +237,44 @@
/**
* Reads cache entry.
*
- * @param string $key Cache key name
+ * @param string $key Cache key name
+ * @param boolean $nostore Enable to skip in-memory store
*
* @return mixed Cached value
*/
- private function read_record($key)
+ private function read_record($key, $nostore=false)
{
if (!$this->db) {
return null;
}
- if ($this->type == 'memcache') {
- $data = $this->db->get($this->ckey($key));
- }
- else if ($this->type == 'apc') {
- $data = apc_fetch($this->ckey($key));
- }
+ if ($this->type != 'db') {
+ if ($this->type == 'memcache') {
+ $data = $this->db->get($this->ckey($key));
+ }
+ else if ($this->type == 'apc') {
+ $data = apc_fetch($this->ckey($key));
+ }
- if ($data) {
- $this->cache_sums[$key] = md5($data);
- $this->cache[$key] = unserialize($data);
+ if ($data) {
+ $md5sum = md5($data);
+ $data = $this->packed ? unserialize($data) : $data;
+
+ if ($nostore) {
+ return $data;
+ }
+
+ $this->cache_sums[$key] = $md5sum;
+ $this->cache[$key] = $data;
+ }
+ else {
+ $this->cache[$key] = null;
+ }
}
- else if ($this->type == 'db') {
+ else {
$sql_result = $this->db->limitquery(
- "SELECT cache_id, data, cache_key".
- " FROM ".get_table_name('cache').
+ "SELECT data, cache_key".
+ " FROM ".$this->db->table_name('cache').
" WHERE user_id = ?".
" AND cache_key = ?".
// for better performance we allow more records for one key
@@ -214,10 +285,19 @@
if ($sql_arr = $this->db->fetch_assoc($sql_result)) {
$key = substr($sql_arr['cache_key'], strlen($this->prefix)+1);
$md5sum = $sql_arr['data'] ? md5($sql_arr['data']) : null;
- $data = $sql_arr['data'] ? unserialize($sql_arr['data']) : null;
+ if ($sql_arr['data']) {
+ $data = $this->packed ? unserialize($sql_arr['data']) : $sql_arr['data'];
+ }
+
+ if ($nostore) {
+ return $data;
+ }
+
$this->cache[$key] = $data;
- $this->cache_sums[$key] = $md5sum;
- $this->cache_keys[$key] = $sql_arr['cache_id'];
+ $this->cache_sums[$key] = $md5sum;
+ }
+ else {
+ $this->cache[$key] = null;
}
}
@@ -230,6 +310,8 @@
*
* @param string $key Cache key name
* @param mxied $data Serialized cache data
+ *
+ * @param boolean True on success, False on failure
*/
private function write_record($key, $data)
{
@@ -241,13 +323,13 @@
return $this->add_record($this->ckey($key), $data);
}
- $key_exists = $this->cache_keys[$key];
+ $key_exists = array_key_exists($key, $this->cache_sums);
$key = $this->prefix . '.' . $key;
// Remove NULL rows (here we don't need to check if the record exist)
if ($data == 'N;') {
$this->db->query(
- "DELETE FROM ".get_table_name('cache').
+ "DELETE FROM ".$this->db->table_name('cache').
" WHERE user_id = ?".
" AND cache_key = ?",
$this->userid, $key);
@@ -257,8 +339,8 @@
// update existing cache record
if ($key_exists) {
- $this->db->query(
- "UPDATE ".get_table_name('cache').
+ $result = $this->db->query(
+ "UPDATE ".$this->db->table_name('cache').
" SET created = ". $this->db->now().", data = ?".
" WHERE user_id = ?".
" AND cache_key = ?",
@@ -268,14 +350,14 @@
else {
// for better performance we allow more records for one key
// so, no need to check if record exist (see rcube_cache::read_record())
- $this->db->query(
- "INSERT INTO ".get_table_name('cache').
+ $result = $this->db->query(
+ "INSERT INTO ".$this->db->table_name('cache').
" (created, user_id, cache_key, data)".
" VALUES (".$this->db->now().", ?, ?, ?)",
$this->userid, $key, $data);
}
- return true;
+ return $this->db->affected_rows($result);
}
@@ -333,7 +415,7 @@
}
$this->db->query(
- "DELETE FROM ".get_table_name('cache').
+ "DELETE FROM ".$this->db->table_name('cache').
" WHERE user_id = ?" . $where,
$this->userid);
}
@@ -341,33 +423,53 @@
/**
* Adds entry into memcache/apc DB.
+ *
+ * @param string $key Cache key name
+ * @param mxied $data Serialized cache data
+ * @param bollean $index Enables immediate index update
+ *
+ * @param boolean True on success, False on failure
*/
- private function add_record($key, $data)
+ private function add_record($key, $data, $index=false)
{
if ($this->type == 'memcache') {
$result = $this->db->replace($key, $data, MEMCACHE_COMPRESSED, $this->ttl);
if (!$result)
$result = $this->db->set($key, $data, MEMCACHE_COMPRESSED, $this->ttl);
- return $result;
}
-
- if ($this->type == 'apc') {
+ else if ($this->type == 'apc') {
if (apc_exists($key))
apc_delete($key);
- return apc_store($key, $data, $this->ttl);
+ $result = apc_store($key, $data, $this->ttl);
}
+
+ // Update index
+ if ($index && $result) {
+ $this->load_index();
+
+ if (array_search($key, $this->index) === false) {
+ $this->index[] = $key;
+ $data = serialize($this->index);
+ $this->add_record($this->ikey(), $data);
+ }
+ }
+
+ return $result;
}
/**
* Deletes entry from memcache/apc DB.
*/
- private function delete_record($index=true)
+ private function delete_record($key, $index=true)
{
- if ($this->type == 'memcache')
- $this->db->delete($this->ckey($key));
- else
+ if ($this->type == 'memcache') {
+ // #1488592: use 2nd argument
+ $this->db->delete($this->ckey($key), 0);
+ }
+ else {
apc_delete($this->ckey($key));
+ }
if ($index) {
if (($idx = array_search($key, $this->index)) !== false) {
--
Gitblit v1.9.1