| | |
| | | <?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 |
| | |
| | | $this->prefix = $prefix; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Returns cached value. |
| | | * |
| | |
| | | return $this->cache[$key]; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Sets (add/update) value in cache. |
| | | * |
| | |
| | | $this->cache[$key] = $data; |
| | | $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. |
| | |
| | | $this->remove_record($key, $prefix_mode); |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Remove cache records older than ttl |
| | | */ |
| | |
| | | } |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Remove expired records of all caches |
| | | */ |
| | |
| | | |
| | | $db->query("DELETE FROM " . $db->table_name('cache_shared', true) . " WHERE `expires` < " . $db->now()); |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Writes the cache back to the DB. |
| | |
| | | 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. |
| | |
| | | // 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 == 'memcache') { |
| | | else { |
| | | $ckey = $this->ckey($key); |
| | | $data = $this->db->get($ckey); |
| | | |
| | | 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); |
| | | } |
| | | } |
| | | else if ($this->type == 'apc') { |
| | | $ckey = $this->ckey($key); |
| | | $data = apc_fetch($ckey); |
| | | |
| | | if ($this->debug) { |
| | | $this->debug('fetch', $ckey, $data); |
| | | } |
| | | } |
| | | |
| | |
| | | return $this->cache[$key]; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Writes single cache record into DB. |
| | | * |
| | |
| | | } |
| | | |
| | | 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); |
| | |
| | | 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; |
| | | } |
| | |
| | | $this->db->query("DELETE FROM " . $this->table . $where); |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Adds entry into memcache/apc DB. |
| | | * |
| | | * @param string $key Cache key name |
| | | * @param string $key Cache internal key name |
| | | * @param mixed $data Serialized cache data |
| | | * |
| | | * @param boolean True on success, False on failure |
| | |
| | | { |
| | | 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 ($this->debug) { |
| | | $this->debug('set', $key, $data, $result); |
| | | } |
| | | } |
| | | else if ($this->type == 'apc') { |
| | | if (apc_exists($key)) { |
| | | apc_delete($key); |
| | | } |
| | | $result = apc_store($key, $data, $this->ttl); |
| | | |
| | | if ($this->debug) { |
| | | $this->debug('store', $key, $data, $result); |
| | | } |
| | | $result = apc_store($key, $data, $this->ttl); |
| | | } |
| | | |
| | | if ($result) { |
| | | $this->index_changed = true; |
| | | 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') { |
| | | $ckey = $this->ckey($key); |
| | | // #1488592: use 2nd argument |
| | | $result = $this->db->delete($ckey, 0); |
| | | |
| | | if ($this->debug) { |
| | | $this->debug('delete', $ckey, null, $result); |
| | | } |
| | | $result = $this->db->delete($key, 0); |
| | | } |
| | | else { |
| | | $ckey = $this->ckey($key); |
| | | $result = apc_delete($ckey); |
| | | |
| | | if ($this->debug) { |
| | | $this->debug('delete', $ckey, null, $result); |
| | | } |
| | | $result = apc_delete($key); |
| | | } |
| | | |
| | | if ($result) { |
| | | $this->index_changed = true; |
| | | if ($this->debug) { |
| | | $this->debug('delete', $key, null, $result); |
| | | } |
| | | |
| | | if ($index) { |
| | | if (($idx = array_search($key, $this->index)) !== false) { |
| | | unset($this->index[$idx]); |
| | | } |
| | | } |
| | | 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; |
| | | } |
| | | |
| | |
| | | |
| | | if ($this->type == 'memcache') { |
| | | $data = $this->db->get($index_key); |
| | | |
| | | if ($this->debug) { |
| | | $this->debug('get', $index_key, $data); |
| | | } |
| | | } |
| | | else if ($this->type == 'apc') { |
| | | $data = apc_fetch($index_key); |
| | | } |
| | | |
| | | if ($this->debug) { |
| | | $this->debug('fetch', $index_key, $data); |
| | | } |
| | | 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) |