lib/cache.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Cache interface plus default in-memory cache implementation
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  Cache
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @copyright 2009 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 /**
  31  * Interface for caching
  32  *
  33  * An abstract interface for caching. Because we originally used the
  34  * Memcache plugin directly, the interface uses a small subset of the
  35  * Memcache interface.
  36  *
  37  * @category  Cache
  38  * @package   StatusNet
  39  * @author    Evan Prodromou <evan@status.net>
  40  * @copyright 2009 StatusNet, Inc.
  41  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  42  * @link      http://status.net/
  43  */
  44 class Cache
  45 {
  46     var $_items   = array();
  47     static $_inst = null;
  48
  49     const COMPRESSED = 1;
  50
  51     /**
  52      * Singleton constructor
  53      *
  54      * Use this to get the singleton instance of Cache.
  55      *
  56      * @return Cache cache object
  57      */
  58     static function instance()
  59     {
  60         if (is_null(self::$_inst)) {
  61             self::$_inst = new Cache();
  62         }
  63
  64         return self::$_inst;
  65     }
  66
  67     /**
  68      * Create a cache key from input text
  69      *
  70      * Builds a cache key from input text. Helps to namespace
  71      * the cache area (if shared with other applications or sites)
  72      * and prevent conflicts.
  73      *
  74      * @param string $extra the real part of the key
  75      *
  76      * @return string full key
  77      */
  78     static function key($extra)
  79     {
  80         $base_key = common_config('cache', 'base');
  81
  82         if (empty($base_key)) {
  83             $base_key = self::keyize(common_config('site', 'name'));
  84         }
  85
  86         return 'statusnet:' . $base_key . ':' . $extra;
  87     }
  88
  89     /**
  90      * Make a string suitable for use as a key
  91      *
  92      * Useful for turning primary keys of tables into cache keys.
  93      *
  94      * @param string $str string to turn into a key
  95      *
  96      * @return string keyized string
  97      */
  98     static function keyize($str)
  99     {
 100         $str = strtolower($str);
 101         $str = preg_replace('/\s/', '_', $str);
 102         return $str;
 103     }
 104
 105     /**
 106      * Get a value associated with a key
 107      *
 108      * The value should have been set previously.
 109      *
 110      * @param string $key Lookup key
 111      *
 112      * @return string retrieved value or null if unfound
 113      */
 114     function get($key)
 115     {
 116         $value = false;
 117
 118         if (Event::handle('StartCacheGet', array(&$key, &$value))) {
 119             if (array_key_exists($key, $this->_items)) {
 120                 $value = unserialize($this->_items[$key]);
 121             }
 122             Event::handle('EndCacheGet', array($key, &$value));
 123         }
 124
 125         return $value;
 126     }
 127
 128     /**
 129      * Set the value associated with a key
 130      *
 131      * @param string  $key    The key to use for lookups
 132      * @param string  $value  The value to store
 133      * @param integer $flag   Flags to use, may include Cache::COMPRESSED
 134      * @param integer $expiry Expiry value, mostly ignored
 135      *
 136      * @return boolean success flag
 137      */
 138     function set($key, $value, $flag=null, $expiry=null)
 139     {
 140         $success = false;
 141
 142         if (Event::handle('StartCacheSet', array(&$key, &$value, &$flag,
 143                                                  &$expiry, &$success))) {
 144
 145             $this->_items[$key] = serialize($value);
 146
 147             $success = true;
 148
 149             Event::handle('EndCacheSet', array($key, $value, $flag,
 150                                                $expiry));
 151         }
 152
 153         return $success;
 154     }
 155
 156     /**
 157      * Atomically increment an existing numeric value.
 158      * Existing expiration time should remain unchanged, if any.
 159      *
 160      * @param string  $key    The key to use for lookups
 161      * @param int     $step   Amount to increment (default 1)
 162      *
 163      * @return mixed incremented value, or false if not set.
 164      */
 165     function increment($key, $step=1)
 166     {
 167         $value = false;
 168         if (Event::handle('StartCacheIncrement', array(&$key, &$step, &$value))) {
 169             // Fallback is not guaranteed to be atomic,
 170             // and may original expiry value.
 171             $value = $this->get($key);
 172             if ($value !== false) {
 173                 $value += $step;
 174                 $ok = $this->set($key, $value);
 175                 $got = $this->get($key);
 176             }
 177             Event::handle('EndCacheIncrement', array($key, $step, $value));
 178         }
 179         return $value;
 180     }
 181
 182     /**
 183      * Delete the value associated with a key
 184      *
 185      * @param string $key Key to delete
 186      *
 187      * @return boolean success flag
 188      */
 189     function delete($key)
 190     {
 191         $success = false;
 192
 193         if (Event::handle('StartCacheDelete', array(&$key, &$success))) {
 194             if (array_key_exists($key, $this->_items)) {
 195                 unset($this->_items[$key]);
 196             }
 197             $success = true;
 198             Event::handle('EndCacheDelete', array($key));
 199         }
 200
 201         return $success;
 202     }
 203
 204     /**
 205      * Close or reconnect any remote connections, such as to give
 206      * daemon processes a chance to reconnect on a fresh socket.
 207      *
 208      * @return boolean success flag
 209      */
 210     function reconnect()
 211     {
 212         $success = false;
 213
 214         if (Event::handle('StartCacheReconnect', array(&$success))) {
 215             $success = true;
 216             Event::handle('EndCacheReconnect', array());
 217         }
 218
 219         return $success;
 220     }
 221 }