From 044c1a052381d73a75a998af604bfd84b949d702 Mon Sep 17 00:00:00 2001
From: Aleksander Machniak <alec@alec.pl>
Date: Thu, 14 May 2015 03:06:57 -0400
Subject: [PATCH] Simplified code + some CS fixes
---
program/lib/Roundcube/rcube_cache.php | 277 ++++++++++++++++++++++++++++++++++++++++---------------
1 files changed, 200 insertions(+), 77 deletions(-)
diff --git a/program/lib/Roundcube/rcube_cache.php b/program/lib/Roundcube/rcube_cache.php
index 92f12a8..649dd93 100644
--- a/program/lib/Roundcube/rcube_cache.php
+++ b/program/lib/Roundcube/rcube_cache.php
@@ -38,12 +38,16 @@
private $type;
private $userid;
private $prefix;
+ private $table;
private $ttl;
private $packed;
private $index;
+ private $debug;
+ private $index_changed = false;
private $cache = array();
private $cache_changes = array();
private $cache_sums = array();
+ private $max_packet = -1;
/**
@@ -63,16 +67,19 @@
$type = strtolower($type);
if ($type == 'memcache') {
- $this->type = 'memcache';
- $this->db = $rcube->get_memcache();
+ $this->type = 'memcache';
+ $this->db = $rcube->get_memcache();
+ $this->debug = $rcube->config->get('memcache_debug');
}
else if ($type == 'apc') {
- $this->type = 'apc';
- $this->db = function_exists('apc_exists'); // APC 3.1.4 required
+ $this->type = 'apc';
+ $this->db = function_exists('apc_exists'); // APC 3.1.4 required
+ $this->debug = $rcube->config->get('apc_debug');
}
else {
- $this->type = 'db';
- $this->db = $rcube->get_dbh();
+ $this->type = 'db';
+ $this->db = $rcube->get_dbh();
+ $this->table = $this->db->table_name('cache', true);
}
// convert ttl string to seconds
@@ -112,7 +119,6 @@
function set($key, $data)
{
$this->cache[$key] = $data;
- $this->cache_changed = true;
$this->cache_changes[$key] = true;
}
@@ -145,7 +151,7 @@
*/
function write($key, $data)
{
- return $this->write_record($key, $this->packed ? serialize($data) : $data);
+ return $this->write_record($key, $this->serialize($data));
}
@@ -161,7 +167,6 @@
// Remove all keys
if ($key === null) {
$this->cache = array();
- $this->cache_changed = false;
$this->cache_changes = array();
$this->cache_sums = array();
}
@@ -192,16 +197,27 @@
*/
function expunge()
{
- if ($this->type == 'db' && $this->db) {
+ if ($this->type == 'db' && $this->db && $this->ttl) {
$this->db->query(
- "DELETE FROM ".$this->db->table_name('cache').
- " WHERE user_id = ?".
- " AND cache_key LIKE ?".
- " AND " . $this->db->unixtimestamp('created')." < ?",
+ "DELETE FROM {$this->table}".
+ " WHERE `user_id` = ?".
+ " AND `cache_key` LIKE ?".
+ " AND `expires` < " . $this->db->now(),
$this->userid,
- $this->prefix.'.%',
- time() - $this->ttl);
+ $this->prefix.'.%');
}
+ }
+
+
+ /**
+ * Remove expired records of all caches
+ */
+ static function gc()
+ {
+ $rcube = rcube::get_instance();
+ $db = $rcube->get_dbh();
+
+ $db->query("DELETE FROM " . $db->table_name('cache', true) . " WHERE `expires` < " . $db->now());
}
@@ -210,16 +226,12 @@
*/
function close()
{
- if (!$this->cache_changed) {
- return;
- }
-
foreach ($this->cache as $key => $data) {
// The key has been used
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 = $this->packed ? serialize($data) : $data;
+ $data = $this->serialize($data);
if (!$this->cache_sums[$key] || $this->cache_sums[$key] != md5($data)) {
$this->write_record($key, $data);
@@ -227,7 +239,9 @@
}
}
- $this->write_index();
+ if ($this->index_changed) {
+ $this->write_index();
+ }
}
@@ -246,16 +260,32 @@
}
if ($this->type != 'db') {
- if ($this->type == 'memcache') {
- $data = $this->db->get($this->ckey($key));
+ $this->load_index();
+
+ // Consistency check (#1490390)
+ if (!in_array($key, $this->index)) {
+ // we always check if the key exist in the index
+ // to have data in consistent state. Keeping the index consistent
+ // is needed for keys delete operation when we delete all keys or by prefix.
}
- else if ($this->type == 'apc') {
- $data = apc_fetch($this->ckey($key));
+ else {
+ $ckey = $this->ckey($key);
+
+ if ($this->type == 'memcache') {
+ $data = $this->db->get($ckey);
+ }
+ else if ($this->type == 'apc') {
+ $data = apc_fetch($ckey);
+ }
+
+ if ($this->debug) {
+ $this->debug('get', $ckey, $data);
+ }
}
if ($data) {
$md5sum = md5($data);
- $data = $this->packed ? unserialize($data) : $data;
+ $data = $this->unserialize($data);
if ($nostore) {
return $data;
@@ -270,20 +300,19 @@
}
else {
$sql_result = $this->db->limitquery(
- "SELECT data, cache_key".
- " FROM ".$this->db->table_name('cache').
- " WHERE user_id = ?".
- " AND cache_key = ?".
+ "SELECT `data`, `cache_key`".
+ " FROM {$this->table}".
+ " WHERE `user_id` = ? AND `cache_key` = ?".
// for better performance we allow more records for one key
// get the newer one
- " ORDER BY created DESC",
+ " ORDER BY `created` DESC",
0, 1, $this->userid, $this->prefix.'.'.$key);
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;
if ($sql_arr['data']) {
- $data = $this->packed ? unserialize($sql_arr['data']) : $sql_arr['data'];
+ $data = $this->unserialize($sql_arr['data']);
}
if ($nostore) {
@@ -306,7 +335,7 @@
* Writes single cache record into DB.
*
* @param string $key Cache key name
- * @param mxied $data Serialized cache data
+ * @param mixed $data Serialized cache data
*
* @param boolean True on success, False on failure
*/
@@ -316,8 +345,21 @@
return false;
}
+ // don't attempt to write too big data sets
+ if (strlen($data) > $this->max_packet_size()) {
+ trigger_error("rcube_cache: max_packet_size ($this->max_packet) exceeded for key $key. Tried to write " . strlen($data) . " bytes", E_USER_WARNING);
+ return false;
+ }
+
if ($this->type == 'memcache' || $this->type == 'apc') {
- return $this->add_record($this->ckey($key), $data);
+ $result = $this->add_record($this->ckey($key), $data);
+
+ // make sure index will be updated
+ if ($result && !array_key_exists($key, $this->cache_sums)) {
+ $this->cache_sums[$key] = true;
+ }
+
+ return $result;
}
$key_exists = array_key_exists($key, $this->cache_sums);
@@ -326,9 +368,8 @@
// Remove NULL rows (here we don't need to check if the record exist)
if ($data == 'N;') {
$this->db->query(
- "DELETE FROM ".$this->db->table_name('cache').
- " WHERE user_id = ?".
- " AND cache_key = ?",
+ "DELETE FROM {$this->table}".
+ " WHERE `user_id` = ? AND `cache_key` = ?",
$this->userid, $key);
return true;
@@ -337,10 +378,12 @@
// update existing cache record
if ($key_exists) {
$result = $this->db->query(
- "UPDATE ".$this->db->table_name('cache').
- " SET created = ". $this->db->now().", data = ?".
- " WHERE user_id = ?".
- " AND cache_key = ?",
+ "UPDATE {$this->table}".
+ " SET `created` = " . $this->db->now().
+ ", `expires` = " . ($this->ttl ? $this->db->now($this->ttl) : 'NULL').
+ ", `data` = ?".
+ " WHERE `user_id` = ?".
+ " AND `cache_key` = ?",
$data, $this->userid, $key);
}
// add new cache record
@@ -348,9 +391,9 @@
// for better performance we allow more records for one key
// so, no need to check if record exist (see rcube_cache::read_record())
$result = $this->db->query(
- "INSERT INTO ".$this->db->table_name('cache').
- " (created, user_id, cache_key, data)".
- " VALUES (".$this->db->now().", ?, ?, ?)",
+ "INSERT INTO {$this->table}".
+ " (`created`, `expires`, `user_id`, `cache_key`, `data`)".
+ " VALUES (" . $this->db->now() . ", " . ($this->ttl ? $this->db->now($this->ttl) : 'NULL') . ", ?, ?, ?)",
$this->userid, $key, $data);
}
@@ -364,7 +407,6 @@
* @param string $key Cache key name or pattern
* @param boolean $prefix_mode Enable it to clear all keys starting
* with prefix specified in $key
- *
*/
private function remove_record($key=null, $prefix_mode=false)
{
@@ -400,20 +442,19 @@
// Remove all keys (in specified cache)
if ($key === null) {
- $where = " AND cache_key LIKE " . $this->db->quote($this->prefix.'.%');
+ $where = " AND `cache_key` LIKE " . $this->db->quote($this->prefix.'.%');
}
// Remove keys by name prefix
else if ($prefix_mode) {
- $where = " AND cache_key LIKE " . $this->db->quote($this->prefix.'.'.$key.'%');
+ $where = " AND `cache_key` LIKE " . $this->db->quote($this->prefix.'.'.$key.'%');
}
// Remove one key by name
else {
- $where = " AND cache_key = " . $this->db->quote($this->prefix.'.'.$key);
+ $where = " AND `cache_key` = " . $this->db->quote($this->prefix.'.'.$key);
}
$this->db->query(
- "DELETE FROM ".$this->db->table_name('cache').
- " WHERE user_id = ?" . $where,
+ "DELETE FROM {$this->table} WHERE `user_id` = ?" . $where,
$this->userid);
}
@@ -421,34 +462,34 @@
/**
* 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 string $key Cache key name
+ * @param mixed $data Serialized cache data
*
* @param boolean True on success, False on failure
*/
- private function add_record($key, $data, $index=false)
+ private function add_record($key, $data)
{
if ($this->type == 'memcache') {
$result = $this->db->replace($key, $data, MEMCACHE_COMPRESSED, $this->ttl);
- if (!$result)
+
+ if (!$result) {
$result = $this->db->set($key, $data, MEMCACHE_COMPRESSED, $this->ttl);
+ }
}
else if ($this->type == 'apc') {
- if (apc_exists($key))
+ if (apc_exists($key)) {
apc_delete($key);
+ }
+
$result = apc_store($key, $data, $this->ttl);
}
- // Update index
- if ($index && $result) {
- $this->load_index();
+ if ($this->debug) {
+ $this->debug('set', $key, $data, $result);
+ }
- if (array_search($key, $this->index) === false) {
- $this->index[] = $key;
- $data = serialize($this->index);
- $this->add_record($this->ikey(), $data);
- }
+ if ($result) {
+ $this->index_changed = true;
}
return $result;
@@ -460,12 +501,22 @@
*/
private function delete_record($key, $index=true)
{
+ $ckey = $this->ckey($key);
+
if ($this->type == 'memcache') {
// #1488592: use 2nd argument
- $this->db->delete($this->ckey($key), 0);
+ $result = $this->db->delete($ckey, 0);
}
else {
- apc_delete($this->ckey($key));
+ $result = apc_delete($ckey);
+ }
+
+ if ($this->debug) {
+ $this->debug('delete', $ckey, null, $result);
+ }
+
+ if ($result) {
+ $this->index_changed = true;
}
if ($index) {
@@ -481,11 +532,7 @@
*/
private function write_index()
{
- if (!$this->db) {
- return;
- }
-
- if ($this->type == 'db') {
+ if (!$this->db || $this->type == 'db') {
return;
}
@@ -493,10 +540,15 @@
// Make sure index contains new keys
foreach ($this->cache as $key => $value) {
- if ($value !== null) {
- if (array_search($key, $this->index) === false) {
- $this->index[] = $key;
- }
+ if ($value !== null && !in_array($key, $this->index)) {
+ $this->index[] = $key;
+ }
+ }
+
+ // new keys added using self::write()
+ foreach ($this->cache_sums as $key => $value) {
+ if ($value === true && !in_array($key, $this->index)) {
+ $this->index[] = $key;
}
}
@@ -510,7 +562,7 @@
*/
private function load_index()
{
- if (!$this->db) {
+ if (!$this->db || $this->type == 'db') {
return;
}
@@ -519,11 +571,16 @@
}
$index_key = $this->ikey();
+
if ($this->type == 'memcache') {
$data = $this->db->get($index_key);
}
else if ($this->type == 'apc') {
$data = apc_fetch($index_key);
+ }
+
+ if ($this->debug) {
+ $this->debug('get', $index_key, $data);
}
$this->index = $data ? unserialize($data) : array();
@@ -553,4 +610,70 @@
// This way each cache will have its own index
return sprintf('%d:%s%s', $this->userid, $this->prefix, 'INDEX');
}
+
+ /**
+ * Serializes data for storing
+ */
+ private function serialize($data)
+ {
+ if ($this->type == 'db') {
+ return $this->db->encode($data, $this->packed);
+ }
+
+ return $this->packed ? serialize($data) : $data;
+ }
+
+ /**
+ * Unserializes serialized data
+ */
+ private function unserialize($data)
+ {
+ if ($this->type == 'db') {
+ return $this->db->decode($data, $this->packed);
+ }
+
+ return $this->packed ? @unserialize($data) : $data;
+ }
+
+ /**
+ * Determine the maximum size for cache data to be written
+ */
+ private function max_packet_size()
+ {
+ if ($this->max_packet < 0) {
+ $this->max_packet = 2097152; // default/max is 2 MB
+
+ if ($this->type == 'db') {
+ if ($value = $this->db->get_variable('max_allowed_packet', $this->max_packet)) {
+ $this->max_packet = $value;
+ }
+ $this->max_packet -= 2000;
+ }
+ else if ($this->type == 'memcache') {
+ $stats = $this->db->getStats();
+ $remaining = $stats['limit_maxbytes'] - $stats['bytes'];
+ $this->max_packet = min($remaining / 5, $this->max_packet);
+ }
+ else if ($this->type == 'apc' && function_exists('apc_sma_info')) {
+ $stats = apc_sma_info();
+ $this->max_packet = min($stats['avail_mem'] / 5, $this->max_packet);
+ }
+ }
+
+ return $this->max_packet;
+ }
+
+ /**
+ * Write memcache/apc debug info to the log
+ */
+ private function debug($type, $key, $data = null, $result = null)
+ {
+ $line = strtoupper($type) . ' ' . $key;
+
+ if ($data !== null) {
+ $line .= ' ' . ($this->packed ? $data : serialize($data));
+ }
+
+ rcube::debug($this->type, $line, $result);
+ }
}
--
Gitblit v1.9.1