Fix possible memcache/apc cache data consistency issues (#1490390)

Aleksander Machniak

2015-05-12 fff8e0f2aebab70b180127441fb86807099319f6

 program/lib/Roundcube/rcube_cache_shared.php

@@ -27,7 +27,7 @@
 * @author     Thomas Bruederli <roundcube@gmail.com>
 * @author     Aleksander Machniak <alec@alec.pl>
 */
class rcube_cache
class rcube_cache_shared
{
    /**
     * Instance of database handler
@@ -41,9 +41,13 @@
    private $packed;
    private $index;
    private $table;
    private $debug;
    private $cache         = array();
    private $cache_changes = array();
    private $cache_sums    = array();
    private $max_packet    = -1;

    const DEBUG_LINE_LENGTH = 4096;


    /**
@@ -62,17 +66,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->table = $this->db->table_name('cache_shared');
            $this->table = $this->db->table_name('cache_shared', true);
        }

        // convert ttl string to seconds
@@ -144,7 +150,7 @@
     */
    function write($key, $data)
    {
        return $this->write_record($key, $this->packed ? serialize($data) : $data);
        return $this->write_record($key, $this->serialize($data));
    }


@@ -193,12 +199,23 @@
    {
        if ($this->type == 'db' && $this->db && $this->ttl) {
            $this->db->query(
                "DELETE FROM " . $this->table
                . " WHERE cache_key LIKE ?"
                . " AND " . $this->db->unixtimestamp('created') . " < ?",
                $this->prefix . '.%',
                time() - $this->ttl);
                "DELETE FROM {$this->table}"
                . " WHERE `cache_key` LIKE ?"
                . " AND `expires` < " . $this->db->now(),
                $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_shared', true) . " WHERE `expires` < " . $db->now());
    }


@@ -216,7 +233,7 @@
            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);
@@ -243,16 +260,34 @@
        }

        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 == 'memcache') {
                $ckey = $this->ckey($key);
                $data = $this->db->get($ckey);

                if ($this->debug) {
                    $this->debug('get', $ckey, $data);
                }
            }
            else if ($this->type == 'apc') {
                $data = apc_fetch($this->ckey($key));
                $ckey = $this->ckey($key);
                $data = apc_fetch($ckey);

                if ($this->debug) {
                    $this->debug('fetch', $ckey, $data);
                }
            }

            if ($data) {
                $md5sum = md5($data);
                $data   = $this->packed ? unserialize($data) : $data;
                $data   = $this->unserialize($data);

                if ($nostore) {
                    return $data;
@@ -267,18 +302,18 @@
        }
        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)) {
                $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) {
@@ -301,13 +336,19 @@
     * 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
     */
    private function write_record($key, $data)
    {
        if (!$this->db) {
            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;
        }

@@ -320,16 +361,18 @@

        // 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() . ", 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
@@ -337,9 +380,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->table.
                " (created, cache_key, data)".
                " VALUES (".$this->db->now().", ?, ?)",
                "INSERT INTO {$this->table}".
                " (`created`, `expires`, `cache_key`, `data`)".
                " VALUES (".$this->db->now().", " . ($this->ttl ? $this->db->now($this->ttl) : 'NULL') . ", ?, ?)",
                $key, $data);
        }

@@ -388,15 +431,15 @@

        // 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);
@@ -406,18 +449,20 @@
    /**
     * 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);
            }
        }
        else if ($this->type == 'apc') {
@@ -425,16 +470,9 @@
                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('store', $key, $data, $result);
            }
        }

@@ -448,11 +486,21 @@
    private function delete_record($key, $index=true)
    {
        if ($this->type == 'memcache') {
            $ckey = $this->ckey($key);
            // #1488592: use 2nd argument
            $this->db->delete($this->ckey($key), 0);
            $result = $this->db->delete($ckey, 0);

            if ($this->debug) {
                $this->debug('delete', $ckey, null, $result);
            }
        }
        else {
            apc_delete($this->ckey($key));
            $ckey   = $this->ckey($key);
            $result = apc_delete($ckey);

            if ($this->debug) {
                $this->debug('delete', $ckey, null, $result);
            }
        }

        if ($index) {
@@ -509,9 +557,17 @@

        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);
            }
        }

        $this->index = $data ? unserialize($data) : array();
@@ -541,4 +597,79 @@
        // This way each cache will have its own index
        return $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));

            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);
    }
}