diff options
| -rw-r--r-- | CHANGELOG | 3 | ||||
| -rw-r--r-- | config/main.inc.php.dist | 11 | ||||
| -rw-r--r-- | program/include/rcmail.php | 40 | ||||
| -rw-r--r-- | program/include/rcube_cache.php | 328 | ||||
| -rw-r--r-- | program/include/rcube_imap.php | 234 |
5 files changed, 431 insertions, 185 deletions
@@ -1,6 +1,9 @@ CHANGELOG Roundcube Webmail =========================== +- Added general rcube_cache class with memcache support +- Improved caching performance by skipping writes of unchanged data +- Option enable_caching replaced by imap_cache and messages_cache options - Add forward-as-attachment feature - jQuery-1.6.1 (#1487913, #1487144) - Improve display name composition when saving contacts (#1487143) diff --git a/config/main.inc.php.dist b/config/main.inc.php.dist index 3391d1608..169a3a044 100644 --- a/config/main.inc.php.dist +++ b/config/main.inc.php.dist @@ -109,6 +109,13 @@ $rcmail_config['imap_auth_cid'] = null; // Optional IMAP authentication password to be used for imap_auth_cid $rcmail_config['imap_auth_pw'] = null; +// Type of IMAP indexes cache. Supported values: 'db' and 'memcache'. +$rcmail_config['imap_cache'] = null; + +// Enables messages cache. Only 'db' cache is supported. +$rcmail_config['messages_cache'] = false; + + // ---------------------------------- // SMTP // ---------------------------------- @@ -169,10 +176,6 @@ $rcmail_config['log_dir'] = 'logs/'; // use this folder to store temp files (must be writeable for apache user) $rcmail_config['temp_dir'] = 'temp/'; -// enable caching of messages and mailbox data in the local database. -// this is recommended if the IMAP server does not run on the same machine -$rcmail_config['enable_caching'] = false; - // lifetime of message cache // possible units: s, m, h, d, w $rcmail_config['message_cache_lifetime'] = '10d'; diff --git a/program/include/rcmail.php b/program/include/rcmail.php index eb08c81dc..e2ce1bfbb 100644 --- a/program/include/rcmail.php +++ b/program/include/rcmail.php @@ -122,6 +122,7 @@ class rcmail private $texts; private $address_books = array(); + private $caches = array(); private $action_map = array(); @@ -352,6 +353,24 @@ class rcmail /** + * Initialize and get cache object + * + * @param string $name Cache identifier + * @param string $type Cache type ('db' or 'memcache') + * + * @return rcube_cache Cache object + */ + public function get_cache($name, $type) + { + if (!isset($this->caches[$name])) { + $this->caches[$name] = new rcube_cache($type, $_SESSION['user_id'], $name.'.'); + } + + return $this->caches[$name]; + } + + + /** * Return instance of the internal address book class * * @param string Address book identifier @@ -531,14 +550,22 @@ class rcmail if (is_object($this->imap)) return; - $this->imap = new rcube_imap($this->db); + $this->imap = new rcube_imap(); $this->imap->debug_level = $this->config->get('debug_level'); $this->imap->skip_deleted = $this->config->get('skip_deleted'); // enable caching of imap data - if ($this->config->get('enable_caching')) { - $this->imap->set_caching(true); - } + $imap_cache = $this->config->get('imap_cache'); + $messages_cache = $this->config->get('messages_cache'); + // for backward compatybility + if ($imap_cache === null && $messages_cache === null && $this->config->get('enable_caching')) { + $imap_cache = 'db'; + $messages_cache = true; + } + if ($imap_cache) + $this->imap->set_caching($imap_cache); + if ($messages_cache) + $this->imap->set_messages_caching(true); // set pagesize from config $this->imap->set_pagesize($this->config->get('pagesize', 50)); @@ -1116,6 +1143,11 @@ class rcmail $book->close(); } + foreach ($this->caches as $cache) { + if (is_object($cache)) + $cache->close(); + } + if (is_object($this->imap)) $this->imap->close(); diff --git a/program/include/rcube_cache.php b/program/include/rcube_cache.php new file mode 100644 index 000000000..d38c237c8 --- /dev/null +++ b/program/include/rcube_cache.php @@ -0,0 +1,328 @@ +<?php + +/* + +-----------------------------------------------------------------------+ + | program/include/rcube_cache.php | + | | + | 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 | + | | + | PURPOSE: | + | Caching engine | + | | + +-----------------------------------------------------------------------+ + | Author: Thomas Bruederli <roundcube@gmail.com> | + | Author: Aleksander Machniak <alec@alec.pl> | + +-----------------------------------------------------------------------+ + + $Id$ + +*/ + + +/** + * Interface class for accessing Roundcube cache + * + * @package Cache + * @author Thomas Bruederli <roundcube@gmail.com> + * @author Aleksander Machniak <alec@alec.pl> + * @version 1.0 + */ +class rcube_cache +{ + /** + * Instance of rcube_mdb2 or Memcache class + * + * @var rcube_mdb2/Memcache + */ + private $db; + private $type; + private $userid; + private $prefix; + private $cache = array(); + private $cache_keys = array(); + private $cache_changes = array(); + private $cache_sums = array(); + + + + /** + * Object constructor. + * + * @param string $type Engine type ('db' or 'memcache') + * @param int $userid User identifier + * @param string $prefix Key name prefix + */ + function __construct($type, $userid, $prefix='') + { + $rcmail = rcmail::get_instance(); + + if (strtolower($type) == 'memcache') { + $this->type = 'memcache'; + $this->db = $rcmail->get_memcache(); + } + else { + $this->type = 'db'; + $this->db = $rcmail->get_dbh(); + } + + $this->userid = (int) $userid; + $this->prefix = $prefix; + } + + + /** + * Returns cached value. + * + * @param string $key Cache key + * + * @return mixed Cached value + */ + function get($key) + { + $key = $this->prefix.$key; + + if ($this->type == 'memcache') { + return $this->read_cache_record($key); + } + + // read cache (if it was not read before) + if (!count($this->cache)) { + $do_read = true; + } + else if (isset($this->cache[$key])) { + $do_read = false; + } + // Find cache prefix, we'll load data for all keys + // with specified (class) prefix into internal cache (memory) + else if ($pos = strpos($key, '.')) { + $prefix = substr($key, 0, $pos); + $regexp = '/^' . preg_quote($prefix, '/') . '/'; + if (!count(preg_grep($regexp, array_keys($this->cache_keys)))) { + $do_read = true; + } + } + + if ($do_read) { + return $this->read_cache_record($key); + } + + return $this->cache[$key]; + } + + + /** + * Sets (add/update) value in cache. + * + * @param string $key Cache key + * @param mixed $data Data + */ + function set($key, $data) + { + $key = $this->prefix.$key; + + $this->cache[$key] = $data; + $this->cache_changed = true; + $this->cache_changes[$key] = true; + } + + + /** + * Clears the cache. + * + * @param string $key Cache key name or pattern + * @param boolean $pattern_mode Enable it to clear all keys with name + * matching PREG pattern in $key + */ + function remove($key=null, $pattern_mode=false) + { + if ($key === null) { + foreach (array_keys($this->cache) as $key) + $this->clear_cache_record($key); + + $this->cache = array(); + $this->cache_changed = false; + $this->cache_changes = array(); + } + else if ($pattern_mode) { + $key = $this->prefix.$key; + + foreach (array_keys($this->cache) as $k) { + if (preg_match($key, $k)) { + $this->clear_cache_record($k); + $this->cache_changes[$k] = false; + unset($this->cache[$key]); + } + } + if (!count($this->cache)) { + $this->cache_changed = false; + } + } + else { + $key = $this->prefix.$key; + + $this->clear_cache_record($key); + $this->cache_changes[$key] = false; + unset($this->cache[$key]); + } + } + + + /** + * Writes the cache back to the DB. + */ + 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 = serialize($data); + if (!$this->cache_sums[$key] || $this->cache_sums[$key] != md5($data)) { + $this->write_cache_record($key, $data); + } + } + } + } + + + /** + * Returns cached entry. + * + * @param string $key Cache key + * + * @return mixed Cached value + * @access private + */ + private function read_cache_record($key) + { + if (!$this->db) { + return null; + } + + if ($this->type == 'memcache') { + $data = $this->db->get($key); + + if ($data) { + $this->cache_sums[$key] = md5($data); + $data = unserialize($data); + } + return $this->cache[$key] = $data; + } + + // Find cache prefix, we'll load data for all keys + // with specified (class) prefix into internal cache (memory) + if ($pos = strpos($key, '.')) { + $prefix = substr($key, 0, $pos); + $where = " AND cache_key LIKE '$prefix%'"; + } + else { + $where = " AND cache_key = ".$this->db->quote($key); + } + + // get cached data from DB + $sql_result = $this->db->query( + "SELECT cache_id, data, cache_key". + " FROM ".get_table_name('cache'). + " WHERE user_id = ?".$where, + $this->userid); + + while ($sql_arr = $this->db->fetch_assoc($sql_result)) { + $sql_key = $sql_arr['cache_key']; + $this->cache_keys[$sql_key] = $sql_arr['cache_id']; + if (!isset($this->cache[$sql_key])) { + $md5sum = $sql_arr['data'] ? md5($sql_arr['data']) : null; + $data = $sql_arr['data'] ? unserialize($sql_arr['data']) : false; + $this->cache[$sql_key] = $data; + $this->cache_sums[$sql_key] = $md5sum; + } + } + + return $this->cache[$key]; + } + + + /** + * Writes single cache record. + * + * @param string $key Cache key + * @param mxied $data Cache value + * @access private + */ + private function write_cache_record($key, $data) + { + if (!$this->db) { + return false; + } + + if ($this->type == 'memcache') { + $result = $this->db->replace($key, $data, MEMCACHE_COMPRESSED); + if (!$result) + $result = $this->db->set($key, $data, MEMCACHE_COMPRESSED); + return $result; + } + + // update existing cache record + if ($this->cache_keys[$key]) { + $this->db->query( + "UPDATE ".get_table_name('cache'). + " SET created = ". $this->db->now().", data = ?". + " WHERE user_id = ?". + " AND cache_key = ?", + $data, $this->userid, $key); + } + // add new cache record + else { + $this->db->query( + "INSERT INTO ".get_table_name('cache'). + " (created, user_id, cache_key, data)". + " VALUES (".$this->db->now().", ?, ?, ?)", + $this->userid, $key, $data); + + // get cache entry ID for this key + $sql_result = $this->db->query( + "SELECT cache_id". + " FROM ".get_table_name('cache'). + " WHERE user_id = ?". + " AND cache_key = ?", + $this->userid, $key); + + if ($sql_arr = $this->db->fetch_assoc($sql_result)) + $this->cache_keys[$key] = $sql_arr['cache_id']; + } + } + + + /** + * Clears cache for single record. + * + * @param string $key Cache key + * @access private + */ + private function clear_cache_record($key) + { + if (!$this->db) { + return false; + } + + if ($this->type == 'memcache') { + return $this->db->delete($key); + } + + $this->db->query( + "DELETE FROM ".get_table_name('cache'). + " WHERE user_id = ?". + " AND cache_key = ?", + $this->userid, $key); + + unset($this->cache_keys[$key]); + } + +} diff --git a/program/include/rcube_imap.php b/program/include/rcube_imap.php index 2683fe210..413a67253 100644 --- a/program/include/rcube_imap.php +++ b/program/include/rcube_imap.php @@ -52,19 +52,23 @@ class rcube_imap * @var rcube_mdb2 */ private $db; + + /** + * Instance of rcube_cache + * + * @var rcube_cache + */ + private $cache; private $mailbox = 'INBOX'; private $delimiter = NULL; private $namespace = NULL; private $sort_field = ''; private $sort_order = 'DESC'; - private $caching_enabled = false; private $default_charset = 'ISO-8859-1'; private $struct_charset = NULL; private $default_folders = array('INBOX'); + private $messages_caching = false; private $icache = array(); - private $cache = array(); - private $cache_keys = array(); - private $cache_changes = array(); private $uid_id_map = array(); private $msg_headers = array(); public $search_set = NULL; @@ -112,13 +116,10 @@ class rcube_imap /** - * Object constructor - * - * @param object DB Database connection + * Object constructor. */ - function __construct($db_conn) + function __construct() { - $this->db = $db_conn; $this->conn = new rcube_imap_generic(); } @@ -207,7 +208,6 @@ class rcube_imap function close() { $this->conn->closeConnection(); - $this->write_cache(); } @@ -706,7 +706,7 @@ class rcube_imap $search_str .= " UNSEEN"; } else { - if ($this->caching_enabled) { + if ($this->messages_caching) { $keys[] = 'ALL'; } if ($status) { @@ -722,7 +722,7 @@ class rcube_imap $count = is_array($index) ? $index['COUNT'] : 0; if ($mode == 'ALL') { - if ($need_uid && $this->caching_enabled) { + if ($need_uid && $this->messages_caching) { // Save messages index for check_cache_status() $this->icache['all_undeleted_idx'] = $index['ALL']; } @@ -838,7 +838,7 @@ class rcube_imap $page = $page ? $page : $this->list_page; $cache_key = $mailbox.'.msg'; - if ($this->caching_enabled) { + if ($this->messages_caching) { // cache is OK, we can get messages from local cache // (assume cache is in sync when in recursive mode) if ($recursive || $this->check_cache_status($mailbox, $cache_key)>0) { @@ -1320,7 +1320,7 @@ class rcube_imap } // Update cache - if ($this->caching_enabled && $cache_key) { + if ($this->messages_caching && $cache_key) { // cache is incomplete? $cache_index = $this->get_message_cache_index($cache_key); @@ -2104,7 +2104,7 @@ class rcube_imap } // write structure to cache - if ($this->caching_enabled) + if ($this->messages_caching) $this->add_message_cache($cache_key, $this->_msg_id, $headers, $struct, $this->icache['message.id'][$uid], true); } @@ -2584,7 +2584,7 @@ class rcube_imap if ($result) { // reload message headers if cached - if ($this->caching_enabled && !$skip_cache) { + if ($this->messages_caching && !$skip_cache) { $cache_key = $mailbox.'.msg'; if ($all_mode) $this->clear_message_cache($cache_key); @@ -3498,7 +3498,7 @@ class rcube_imap $headers = explode(' ', $this->fetch_add_headers); $headers = array_map('strtoupper', $headers); - if ($this->caching_enabled || $this->get_all_headers) + if ($this->messages_caching || $this->get_all_headers) $headers = array_merge($headers, $this->all_headers); return implode(' ', array_unique($headers)); @@ -3736,17 +3736,22 @@ class rcube_imap * --------------------------------*/ /** - * Enable or disable caching + * Enable or disable indexes caching * - * @param boolean $set Flag + * @param boolean $type Cache type (memcache' or 'db') * @access public */ - function set_caching($set) + function set_caching($type) { - if ($set && is_object($this->db)) - $this->caching_enabled = true; - else - $this->caching_enabled = false; + if ($type) { + $rcmail = rcmail::get_instance(); + $this->cache = $rcmail->get_cache('IMAP', $type); + } + else { + if ($this->cache) + $this->cache->close(); + $this->cache = null; + } } @@ -3759,15 +3764,11 @@ class rcube_imap */ function get_cache($key) { - // read cache (if it was not read before) - if (!count($this->cache) && $this->caching_enabled) { - return $this->_read_cache_record($key); + if ($this->cache) { + return $this->cache->get($key); } - - return $this->cache[$key]; } - /** * Update cache * @@ -3777,28 +3778,11 @@ class rcube_imap */ function update_cache($key, $data) { - $this->cache[$key] = $data; - $this->cache_changed = true; - $this->cache_changes[$key] = true; - } - - - /** - * Writes the cache - * - * @access private - */ - private function write_cache() - { - if ($this->caching_enabled && $this->cache_changed) { - foreach ($this->cache as $key => $data) { - if ($this->cache_changes[$key]) - $this->_write_cache_record($key, serialize($data)); - } + if ($this->cache) { + $this->cache->set($key, $data); } } - /** * Clears the cache. * @@ -3809,139 +3793,35 @@ class rcube_imap */ function clear_cache($key=null, $pattern_mode=false) { - if (!$this->caching_enabled) - return; - - if ($key === null) { - foreach (array_keys($this->cache) as $key) - $this->_clear_cache_record($key); - - $this->cache = array(); - $this->cache_changed = false; - $this->cache_changes = array(); - } - else if ($pattern_mode) { - foreach (array_keys($this->cache) as $k) { - if (preg_match($key, $k)) { - $this->_clear_cache_record($k); - $this->cache_changes[$k] = false; - unset($this->cache[$key]); - } - } - if (!count($this->cache)) { - $this->cache_changed = false; - } - } - else { - $this->_clear_cache_record($key); - $this->cache_changes[$key] = false; - unset($this->cache[$key]); + if ($this->cache) { + $this->cache->remove($key, $pattern_mode); } } - /** - * Returns cached entry - * - * @param string $key Cache key - * @return mixed Cached value - * @access private - */ - private function _read_cache_record($key) - { - if ($this->db) { - // get cached data from DB - $sql_result = $this->db->query( - "SELECT cache_id, data, cache_key ". - "FROM ".get_table_name('cache'). - " WHERE user_id=? ". - "AND cache_key LIKE 'IMAP.%'", - $_SESSION['user_id']); - - while ($sql_arr = $this->db->fetch_assoc($sql_result)) { - $sql_key = preg_replace('/^IMAP\./', '', $sql_arr['cache_key']); - $this->cache_keys[$sql_key] = $sql_arr['cache_id']; - if (!isset($this->cache[$sql_key])) - $this->cache[$sql_key] = $sql_arr['data'] ? unserialize($sql_arr['data']) : false; - } - } - - return $this->cache[$key]; - } - + /* -------------------------------- + * message caching methods + * --------------------------------*/ /** - * Writes single cache record + * Enable or disable messages caching * - * @param string $key Cache key - * @param mxied $data Cache value - * @access private + * @param boolean $set Flag + * @access public */ - private function _write_cache_record($key, $data) + function set_messages_caching($set) { - if (!$this->db) - return false; + $rcmail = rcmail::get_instance(); - // update existing cache record - if ($this->cache_keys[$key]) { - $this->db->query( - "UPDATE ".get_table_name('cache'). - " SET created=". $this->db->now().", data=? ". - "WHERE user_id=? ". - "AND cache_key=?", - $data, - $_SESSION['user_id'], - 'IMAP.'.$key); + if ($set && ($dbh = $rcmail->get_dbh())) { + $this->db = $dbh; + $this->messages_caching = true; } - // add new cache record else { - $this->db->query( - "INSERT INTO ".get_table_name('cache'). - " (created, user_id, cache_key, data) ". - "VALUES (".$this->db->now().", ?, ?, ?)", - $_SESSION['user_id'], - 'IMAP.'.$key, - $data); - - // get cache entry ID for this key - $sql_result = $this->db->query( - "SELECT cache_id ". - "FROM ".get_table_name('cache'). - " WHERE user_id=? ". - "AND cache_key=?", - $_SESSION['user_id'], - 'IMAP.'.$key); - - if ($sql_arr = $this->db->fetch_assoc($sql_result)) - $this->cache_keys[$key] = $sql_arr['cache_id']; + $this->messages_caching = false; } } - - /** - * Clears cache for single record - * - * @param string $ket Cache key - * @access private - */ - private function _clear_cache_record($key) - { - $this->db->query( - "DELETE FROM ".get_table_name('cache'). - " WHERE user_id=? ". - "AND cache_key=?", - $_SESSION['user_id'], - 'IMAP.'.$key); - - unset($this->cache_keys[$key]); - } - - - - /* -------------------------------- - * message caching methods - * --------------------------------*/ - /** * Checks if the cache is up-to-date * @@ -3951,7 +3831,7 @@ class rcube_imap */ private function check_cache_status($mailbox, $cache_key) { - if (!$this->caching_enabled) + if (!$this->messages_caching) return -3; $cache_index = $this->get_message_cache_index($cache_key); @@ -4009,7 +3889,7 @@ class rcube_imap */ private function get_message_cache($key, $from, $to, $sort_field, $sort_order) { - if (!$this->caching_enabled) + if (!$this->messages_caching) return NULL; // use idx sort as default sorting @@ -4054,7 +3934,7 @@ class rcube_imap { $internal_key = 'message'; - if ($this->caching_enabled && !isset($this->icache[$internal_key][$uid])) { + if ($this->messages_caching && !isset($this->icache[$internal_key][$uid])) { $sql_result = $this->db->query( "SELECT idx, headers, structure, message_id". " FROM ".get_table_name('messages'). @@ -4088,7 +3968,7 @@ class rcube_imap */ private function get_message_cache_index($key, $sort_field='idx', $sort_order='ASC') { - if (!$this->caching_enabled || empty($key)) + if (!$this->messages_caching || empty($key)) return NULL; // use idx sort as default @@ -4143,7 +4023,7 @@ class rcube_imap } // no further caching - if (!$this->caching_enabled) + if (!$this->messages_caching) return; // known message id @@ -4210,7 +4090,7 @@ class rcube_imap */ private function remove_message_cache($key, $ids, $idx=false) { - if (!$this->caching_enabled) + if (!$this->messages_caching) return; $this->db->query( @@ -4232,7 +4112,7 @@ class rcube_imap */ private function clear_message_cache($key, $start_index=1) { - if (!$this->caching_enabled) + if (!$this->messages_caching) return; $this->db->query( @@ -4251,7 +4131,7 @@ class rcube_imap */ private function get_message_cache_index_min($key, $uids=NULL) { - if (!$this->caching_enabled) + if (!$this->messages_caching) return; if (!empty($uids) && !is_array($uids)) { @@ -4285,7 +4165,7 @@ class rcube_imap */ private function get_cache_id2uid($key, $id) { - if (!$this->caching_enabled) + if (!$this->messages_caching) return null; if (array_key_exists('index', $this->icache) @@ -4317,7 +4197,7 @@ class rcube_imap */ private function get_cache_uid2id($key, $uid) { - if (!$this->caching_enabled) + if (!$this->messages_caching) return null; if (array_key_exists('index', $this->icache) |