We are no longer offering accounts on this server. Consider https://gitlab.freedesktop.org/ as a place to host projects.

InProcessCachePlugin.php 6.18 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41
<?php
/**
 * StatusNet - the distributed open-source microblogging tool
 * Copyright (C) 2010, StatusNet, Inc.
 *
 * Extra level of caching, in memory
 *
 * PHP version 5
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @category  Cache
 * @package   StatusNet
 * @author    Evan Prodromou <evan@status.net>
 * @copyright 2010 StatusNet, Inc.
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
 * @link      http://status.net/
 */

if (!defined('STATUSNET')) {
    // This check helps protect against security problems;
    // your code file can't be executed directly from the web.
    exit(1);
}

/**
 * Extra level of caching
 *
 * This plugin adds an extra level of in-process caching to any regular
 * cache system like APC, XCache, or Memcache.
42
 *
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
 * Note that since most caching plugins return false for StartCache*
 * methods, you should add this plugin before them, i.e.
 *
 *     addPlugin('InProcessCache');
 *     addPlugin('XCache');
 *
 * @category  Cache
 * @package   StatusNet
 * @author    Evan Prodromou <evan@status.net>
 * @copyright 2010 StatusNet, Inc.
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
 * @link      http://status.net/
 */
class InProcessCachePlugin extends Plugin
{
    private $_items = array();
    private $_hits  = array();
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
    private $active;

    /**
     * Constructor checks if it's safe to use the in-process cache.
     * On CLI scripts, we'll disable ourselves to avoid data corruption
     * due to keeping stale data around.
     *
     * On web requests we'll roll the dice; they're short-lived so have
     * less chance of stale data. Race conditions are still possible,
     * so beware!
     */
    function __construct()
    {
        parent::__construct();
        $this->active = (PHP_SAPI != 'cli');
    }
76 77 78

    /**
     * Get an item from the cache
79
     *
80 81 82 83 84 85 86 87 88 89 90 91
     * Called before other cache systems are called (iif this
     * plugin was loaded correctly, see class comment). If we
     * have the data, return it, and don't hit the other cache
     * systems.
     *
     * @param string &$key   Key to fetch
     * @param mixed  &$value Resulting value or false for miss
     *
     * @return boolean false if found, else true
     */
    function onStartCacheGet(&$key, &$value)
    {
92
        if ($this->active && array_key_exists($key, $this->_items)) {
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
            $value = $this->_items[$key];
            if (array_key_exists($key, $this->_hits)) {
                $this->_hits[$key]++;
            } else {
                $this->_hits[$key] = 1;
            }
            Event::handle('EndCacheGet', array($key, &$value));
            return false;
        }
        return true;
    }

    /**
     * Called at the end of a cache get
     *
     * If we don't already have the data, we cache it. This
     * keeps us from having to call the external cache if the
     * key is requested again.
     *
     * @param string $key    Key to fetch
     * @param mixed  &$value Resulting value or false for miss
     *
     * @return boolean hook value, true
     */
    function onEndCacheGet($key, &$value)
    {
119 120
        if ($this->active && (!array_key_exists($key, $this->_items) ||
            $this->_items[$key] != $value)) {
121 122 123 124 125 126 127
            $this->_items[$key] = $value;
        }
        return true;
    }

    /**
     * Called at the end of setting a cache element
128
     *
129 130 131 132 133 134 135 136 137 138 139 140
     * Always set the cache element; may overwrite existing
     * data.
     *
     * @param string  $key    Key to fetch
     * @param mixed   $value  Resulting value or false for miss
     * @param integer $flag   ignored
     * @param integer $expiry ignored
     *
     * @return boolean true
     */
    function onEndCacheSet($key, $value, $flag, $expiry)
    {
141 142 143
        if ($this->active) {
            $this->_items[$key] = $value;
        }
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
        return true;
    }

    /**
     * Called at the end of deleting a cache element
     *
     * If stuff's deleted from the other cache, we
     * delete it too.
     *
     * @param string  &$key     Key to delete
     * @param boolean &$success Success flag; ignored
     *
     * @return boolean true
     */
    function onStartCacheDelete(&$key, &$success)
    {
160
        if ($this->active && array_key_exists($key, $this->_items)) {
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
            unset($this->_items[$key]);
        }
        return true;
    }

    /**
     * Version info
     *
     * @param array &$versions Array of version blocks
     *
     * @return boolean true
     */
    function onPluginVersion(&$versions)
    {
        $url = 'http://status.net/wiki/Plugin:InProcessCache';

        $versions[] = array('name' => 'InProcessCache',
178
                            'version' => GNUSOCIAL_VERSION,
179 180 181
                            'author' => 'Evan Prodromou',
                            'homepage' => $url,
                            'description' =>
182
                            // TRANS: Plugin dscription.
183 184 185 186 187 188 189 190 191 192 193 194 195 196
                            _m('Additional in-process cache for plugins.'));
        return true;
    }

    /**
     * Cleanup function; called at end of process
     *
     * If the inprocess/stats config value is true, we dump
     * stats to the log file
     *
     * @return boolean true
     */
    function cleanup()
    {
197
        if ($this->active && common_config('inprocess', 'stats')) {
198
            $this->log(LOG_INFO, "cache size: " .
199 200 201 202 203
                       count($this->_items));
            $sum = 0;
            foreach ($this->_hits as $hitcount) {
                $sum += $hitcount;
            }
204
            $this->log(LOG_INFO, $sum . " hits on " .
205 206 207 208 209
                       count($this->_hits) . " keys");
        }
        return true;
    }
}