| | |
| | | <?php |
| | | |
| | | /* |
| | | /** |
| | | +-----------------------------------------------------------------------+ |
| | | | This file is part of the Roundcube Webmail client | |
| | | | Copyright (C) 2011-2013, The Roundcube Dev Team | |
| | |
| | | | Author: Aleksander Machniak <alec@alec.pl> | |
| | | +-----------------------------------------------------------------------+ |
| | | */ |
| | | |
| | | |
| | | /** |
| | | * Interface class for accessing Roundcube shared cache |
| | |
| | | private $packed; |
| | | private $index; |
| | | private $table; |
| | | private $debug; |
| | | private $index_changed = false; |
| | | private $cache = array(); |
| | | private $cache_changes = array(); |
| | | private $cache_sums = array(); |
| | | private $max_packet = -1; |
| | | |
| | | |
| | | /** |
| | |
| | | $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->table = $this->db->table_name('cache_shared'); |
| | | $this->table = $this->db->table_name('cache_shared', true); |
| | | } |
| | | |
| | | // convert ttl string to seconds |
| | |
| | | $this->packed = $packed; |
| | | $this->prefix = $prefix; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Returns cached value. |
| | |
| | | return $this->cache[$key]; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Sets (add/update) value in cache. |
| | | * |
| | |
| | | function set($key, $data) |
| | | { |
| | | $this->cache[$key] = $data; |
| | | $this->cache_changed = true; |
| | | $this->cache_changes[$key] = true; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Returns cached value without storing it in internal memory. |
| | |
| | | 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. |
| | |
| | | return $this->write_record($key, $this->serialize($data)); |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Clears the cache. |
| | | * |
| | |
| | | // Remove all keys |
| | | if ($key === null) { |
| | | $this->cache = array(); |
| | | $this->cache_changed = false; |
| | | $this->cache_changes = array(); |
| | | $this->cache_sums = array(); |
| | | } |
| | |
| | | $this->remove_record($key, $prefix_mode); |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Remove cache records older than ttl |
| | | */ |
| | |
| | | { |
| | | if ($this->type == 'db' && $this->db && $this->ttl) { |
| | | $this->db->query( |
| | | "DELETE FROM " . $this->table |
| | | . " WHERE cache_key LIKE ?" |
| | | . " AND expires < " . $this->db->now(), |
| | | "DELETE FROM {$this->table}" |
| | | . " WHERE `cache_key` LIKE ?" |
| | | . " AND `expires` < " . $this->db->now(), |
| | | $this->prefix . '.%'); |
| | | } |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Remove expired records of all caches |
| | |
| | | $rcube = rcube::get_instance(); |
| | | $db = $rcube->get_dbh(); |
| | | |
| | | $db->query("DELETE FROM " . $db->table_name('cache_shared') . " WHERE expires < " . $db->now()); |
| | | $db->query("DELETE FROM " . $db->table_name('cache_shared', true) . " WHERE `expires` < " . $db->now()); |
| | | } |
| | | |
| | | |
| | | /** |
| | | * 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]) { |
| | |
| | | } |
| | | } |
| | | |
| | | $this->write_index(); |
| | | } |
| | | if ($this->index_changed) { |
| | | $this->write_index(); |
| | | } |
| | | |
| | | // reset internal cache index, thanks to this we can force index reload |
| | | $this->index = null; |
| | | } |
| | | |
| | | /** |
| | | * Reads cache entry. |
| | |
| | | } |
| | | |
| | | 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) { |
| | |
| | | } |
| | | else { |
| | | $sql_result = $this->db->limitquery( |
| | | "SELECT data, cache_key". |
| | | " FROM " . $this->table . |
| | | " WHERE cache_key = ?". |
| | | "SELECT `data`, `cache_key`". |
| | | " FROM {$this->table}" . |
| | | " WHERE `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->prefix . '.' . $key); |
| | | |
| | | if ($sql_arr = $this->db->fetch_assoc($sql_result)) { |
| | |
| | | return $this->cache[$key]; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * 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 |
| | | */ |
| | |
| | | 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) { |
| | | if (!array_key_exists($key, $this->cache_sums)) { |
| | | $this->cache_sums[$key] = true; |
| | | } |
| | | |
| | | $this->load_index(); |
| | | |
| | | if (!$this->index_changed && !in_array($key, $this->index)) { |
| | | $this->index_changed = true; |
| | | } |
| | | } |
| | | |
| | | return $result; |
| | | } |
| | | |
| | | $key_exists = array_key_exists($key, $this->cache_sums); |
| | |
| | | |
| | | // Remove NULL rows (here we don't need to check if the record exist) |
| | | if ($data == 'N;') { |
| | | $this->db->query("DELETE FROM " . $this->table . " WHERE cache_key = ?", $key); |
| | | $this->db->query("DELETE FROM {$this->table} WHERE `cache_key` = ?", $key); |
| | | return true; |
| | | } |
| | | |
| | | // update existing cache record |
| | | if ($key_exists) { |
| | | $result = $this->db->query( |
| | | "UPDATE " . $this->table . |
| | | " SET created = " . $this->db->now() . |
| | | ", expires = " . ($this->ttl ? $this->db->now($this->ttl) : 'NULL') . |
| | | ", data = ?". |
| | | " WHERE cache_key = ?", |
| | | "UPDATE {$this->table}" . |
| | | " SET `created` = " . $this->db->now() . |
| | | ", `expires` = " . ($this->ttl ? $this->db->now($this->ttl) : 'NULL') . |
| | | ", `data` = ?". |
| | | " WHERE `cache_key` = ?", |
| | | $data, $key); |
| | | } |
| | | // add new cache record |
| | |
| | | // 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->table. |
| | | " (created, expires, cache_key, data)". |
| | | "INSERT INTO {$this->table}". |
| | | " (`created`, `expires`, `cache_key`, `data`)". |
| | | " VALUES (".$this->db->now().", " . ($this->ttl ? $this->db->now($this->ttl) : 'NULL') . ", ?, ?)", |
| | | $key, $data); |
| | | } |
| | | |
| | | return $this->db->affected_rows($result); |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Deletes the cache record(s). |
| | |
| | | // Remove all keys |
| | | if ($key === null) { |
| | | foreach ($this->index as $key) { |
| | | $this->delete_record($key, false); |
| | | $this->delete_record($this->ckey($key)); |
| | | } |
| | | |
| | | $this->index = array(); |
| | | } |
| | | // Remove keys by name prefix |
| | | else if ($prefix_mode) { |
| | | foreach ($this->index as $k) { |
| | | foreach ($this->index as $idx => $k) { |
| | | if (strpos($k, $key) === 0) { |
| | | $this->delete_record($k); |
| | | $this->delete_record($this->ckey($k)); |
| | | unset($this->index[$idx]); |
| | | } |
| | | } |
| | | } |
| | | // Remove one key by name |
| | | else { |
| | | $this->delete_record($key); |
| | | $this->delete_record($this->ckey($key)); |
| | | if (($idx = array_search($key, $this->index)) !== false) { |
| | | unset($this->index[$idx]); |
| | | } |
| | | } |
| | | |
| | | $this->index_changed = true; |
| | | |
| | | return; |
| | | } |
| | | |
| | | // Remove all keys (in specified cache) |
| | | if ($key === null) { |
| | | $where = " WHERE cache_key LIKE " . $this->db->quote($this->prefix.'.%'); |
| | | $where = " WHERE `cache_key` LIKE " . $this->db->quote($this->prefix.'.%'); |
| | | } |
| | | // Remove keys by name prefix |
| | | else if ($prefix_mode) { |
| | | $where = " WHERE cache_key LIKE " . $this->db->quote($this->prefix.'.'.$key.'%'); |
| | | $where = " WHERE `cache_key` LIKE " . $this->db->quote($this->prefix.'.'.$key.'%'); |
| | | } |
| | | // Remove one key by name |
| | | else { |
| | | $where = " WHERE cache_key = " . $this->db->quote($this->prefix.'.'.$key); |
| | | $where = " WHERE `cache_key` = " . $this->db->quote($this->prefix.'.'.$key); |
| | | } |
| | | |
| | | $this->db->query("DELETE FROM " . $this->table . $where); |
| | | } |
| | | |
| | | |
| | | /** |
| | | * 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 internal 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) { |
| | | $result = $this->db->set($key, $data, MEMCACHE_COMPRESSED, $this->ttl); |
| | | } |
| | |
| | | if (apc_exists($key)) { |
| | | apc_delete($key); |
| | | } |
| | | |
| | | $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); |
| | | } |
| | | if ($this->debug) { |
| | | $this->debug('set', $key, $data, $result); |
| | | } |
| | | |
| | | return $result; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Deletes entry from memcache/apc DB. |
| | | * |
| | | * @param string $key Cache internal key name |
| | | * |
| | | * @param boolean True on success, False on failure |
| | | */ |
| | | private function delete_record($key, $index=true) |
| | | private function delete_record($key) |
| | | { |
| | | if ($this->type == 'memcache') { |
| | | // #1488592: use 2nd argument |
| | | $this->db->delete($this->ckey($key), 0); |
| | | $result = $this->db->delete($key, 0); |
| | | } |
| | | else { |
| | | apc_delete($this->ckey($key)); |
| | | $result = apc_delete($key); |
| | | } |
| | | |
| | | if ($index) { |
| | | if (($idx = array_search($key, $this->index)) !== false) { |
| | | unset($this->index[$idx]); |
| | | } |
| | | if ($this->debug) { |
| | | $this->debug('delete', $key, null, $result); |
| | | } |
| | | |
| | | return $result; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Writes the index entry into memcache/apc DB. |
| | | */ |
| | | private function write_index() |
| | | { |
| | | if (!$this->db) { |
| | | return; |
| | | } |
| | | |
| | | if ($this->type == 'db') { |
| | | if (!$this->db || $this->type == 'db') { |
| | | return; |
| | | } |
| | | |
| | |
| | | |
| | | // 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; |
| | | } |
| | | } |
| | | |
| | |
| | | $this->add_record($this->ikey(), $data); |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Gets the index entry from memcache/apc DB. |
| | | */ |
| | | private function load_index() |
| | | { |
| | | if (!$this->db) { |
| | | if (!$this->db || $this->type == 'db') { |
| | | return; |
| | | } |
| | | |
| | |
| | | $data = apc_fetch($index_key); |
| | | } |
| | | |
| | | if ($this->debug) { |
| | | $this->debug('get', $index_key, $data); |
| | | } |
| | | |
| | | $this->index = $data ? unserialize($data) : array(); |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Creates cache key name (for memcache and apc) |
| | |
| | | { |
| | | return $this->prefix . ':' . $key; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Creates index cache key name (for memcache and apc) |
| | |
| | | |
| | | 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); |
| | | } |
| | | } |