Aleksander Machniak
2016-03-28 46f7b7096450939fe03c95aa81ce06ae4bfca89d
program/lib/Roundcube/rcube_cache.php
@@ -1,6 +1,6 @@
<?php
/*
/**
 +-----------------------------------------------------------------------+
 | This file is part of the Roundcube Webmail client                     |
 | Copyright (C) 2011, The Roundcube Dev Team                            |
@@ -17,7 +17,6 @@
 | Author: Aleksander Machniak <alec@alec.pl>                            |
 +-----------------------------------------------------------------------+
*/
/**
 * Interface class for accessing Roundcube cache
@@ -43,12 +42,11 @@
    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;
    const DEBUG_LINE_LENGTH = 4096;
    /**
@@ -93,7 +91,6 @@
        $this->prefix    = $prefix;
    }
    /**
     * Returns cached value.
     *
@@ -110,7 +107,6 @@
        return $this->cache[$key];
    }
    /**
     * Sets (add/update) value in cache.
     *
@@ -120,10 +116,8 @@
    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.
@@ -141,7 +135,6 @@
        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.
@@ -156,7 +149,6 @@
        return $this->write_record($key, $this->serialize($data));
    }
    /**
     * Clears the cache.
     *
@@ -169,7 +161,6 @@
        // Remove all keys
        if ($key === null) {
            $this->cache         = array();
            $this->cache_changed = false;
            $this->cache_changes = array();
            $this->cache_sums    = array();
        }
@@ -194,7 +185,6 @@
        $this->remove_record($key, $prefix_mode);
    }
    /**
     * Remove cache records older than ttl
     */
@@ -211,7 +201,6 @@
        }
    }
    /**
     * Remove expired records of all caches
     */
@@ -223,16 +212,11 @@
        $db->query("DELETE FROM " . $db->table_name('cache', 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]) {
@@ -246,9 +230,13 @@
            }
        }
        $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.
@@ -265,20 +253,26 @@
        }
        if ($this->type != 'db') {
            if ($this->type == 'memcache') {
            $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 {
                $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);
                }
            }
@@ -329,7 +323,6 @@
        return $this->cache[$key];
    }
    /**
     * Writes single cache record into DB.
     *
@@ -351,7 +344,22 @@
        }
        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);
@@ -392,7 +400,6 @@
        return $this->db->affected_rows($result);
    }
    /**
     * Deletes the cache record(s).
     *
@@ -412,22 +419,29 @@
            // 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;
        }
@@ -450,93 +464,68 @@
            $this->userid);
    }
    /**
     * 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)
                $result = $this->db->set($key, $data, MEMCACHE_COMPRESSED, $this->ttl);
            if ($this->debug) {
                $this->debug('set', $key, $data, $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);
            if ($this->debug) {
                $this->debug('store', $key, $data, $result);
            }
            $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 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 ($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;
        }
@@ -544,10 +533,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;
            }
        }
@@ -555,13 +549,12 @@
        $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;
        }
@@ -570,24 +563,20 @@
        }
        $index_key = $this->ikey();
        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 per-user cache key name (for memcache and apc)
@@ -600,7 +589,6 @@
    {
        return sprintf('%d:%s:%s', $this->userid, $this->prefix, $key);
    }
    /**
     * Creates per-user index cache key name (for memcache and apc)
@@ -674,17 +662,8 @@
        if ($data !== null) {
            $line .= ' ' . ($this->packed ? $data : serialize($data));
            if (($len = strlen($line)) > self::DEBUG_LINE_LENGTH) {
                $diff = $len - self::DEBUG_LINE_LENGTH;
                $line = substr($line, 0, self::DEBUG_LINE_LENGTH) . "... [truncated $diff bytes]";
            }
        }
        if ($result !== null) {
            $line .= ' [' . ($result ? 'TRUE' : 'FALSE') . ']';
        }
        rcube::write_log($this->type, $line);
        rcube::debug($this->type, $line, $result);
    }
}