Implemented memcache_debug and apc_debug options for cache operations tracking

Aleksander Machniak

2015-05-08 44708ec647ca45ff7f2ae01108ca3773100fe06a

 program/lib/Roundcube/rcube_cache_shared.php

@@ -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,12 +66,14 @@
        $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';
@@ -255,10 +261,20 @@

        if ($this->type != 'db') {
            if ($this->type == 'memcache') {
                $data = $this->db->get($this->ckey($key));
                $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) {
@@ -312,13 +328,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;
        }

@@ -432,12 +454,19 @@
            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);
            }
        }

        // Update index
@@ -461,11 +490,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) {
@@ -522,9 +561,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();
@@ -578,4 +625,55 @@

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