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
  45 class Cache
  46 {
  47     var $_items   = array();
  48     static $_inst = null;
  49
  50     /**
  51      * Singleton constructor
  52      *
  53      * Use this to get the singleton instance of Cache.
  54      *
  55      * @return Cache cache object
  56      */
  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
  79     static function key($extra)
  80     {
  81         $base_key = common_config('cache', 'base');
  82
  83         if (empty($base_key)) {
  84             $base_key = common_keyize(common_config('site', 'name'));
  85         }
  86
  87         return 'statusnet:' . $base_key . ':' . $extra;
  88     }
  89
  90     /**
  91      * Make a string suitable for use as a key
  92      *
  93      * Useful for turning primary keys of tables into cache keys.
  94      *
  95      * @param string $str string to turn into a key
  96      *
  97      * @return string keyized string
  98      */
  99
 100     static function keyize($str)
 101     {
 102         $str = strtolower($str);
 103         $str = preg_replace('/\s/', '_', $str);
 104         return $str;
 105     }
 106
 107     /**
 108      * Get a value associated with a key
 109      *
 110      * The value should have been set previously.
 111      *
 112      * @param string $key Lookup key
 113      *
 114      * @return string retrieved value or null if unfound
 115      */
 116
 117     function get($key)
 118     {
 119         $value = false;
 120
 121         if (Event::handle('StartCacheGet', array(&$key, &$value))) {
 122             if (array_key_exists($key, $this->_items)) {
 123                 $value = unserialize($this->_items[$key]);
 124             }
 125             Event::handle('EndCacheGet', array($key, &$value));
 126         }
 127
 128         return $value;
 129     }
 130
 131     /**
 132      * Set the value associated with a key
 133      *
 134      * @param string  $key    The key to use for lookups
 135      * @param string  $value  The value to store
 136      * @param integer $flag   Flags to use, mostly ignored
 137      * @param integer $expiry Expiry value, mostly ignored
 138      *
 139      * @return boolean success flag
 140      */
 141
 142     function set($key, $value, $flag=null, $expiry=null)
 143     {
 144         $success = false;
 145
 146         if (Event::handle('StartCacheSet', array(&$key, &$value, &$flag,
 147                                                  &$expiry, &$success))) {
 148
 149             $this->_items[$key] = serialize($value);
 150
 151             $success = true;
 152
 153             Event::handle('EndCacheSet', array($key, $value, $flag,
 154                                                $expiry));
 155         }
 156
 157         return $success;
 158     }
 159
 160     /**
 161      * Delete the value associated with a key
 162      *
 163      * @param string $key Key to delete
 164      *
 165      * @return boolean success flag
 166      */
 167
 168     function delete($key)
 169     {
 170         $success = false;
 171
 172         if (Event::handle('StartCacheDelete', array(&$key, &$success))) {
 173             if (array_key_exists($key, $this->_items)) {
 174                 unset($this->_items[$key]);
 175             }
 176             $success = true;
 177             Event::handle('EndCacheDelete', array($key));
 178         }
 179
 180         return $success;
 181     }
 182
 183     /**
 184      * Close or reconnect any remote connections, such as to give
 185      * daemon processes a chance to reconnect on a fresh socket.
 186      *
 187      * @return boolean success flag
 188      */
 189
 190     function reconnect()
 191     {
 192         $success = false;
 193
 194         if (Event::handle('StartCacheReconnect', array(&$success))) {
 195             $success = true;
 196             Event::handle('EndCacheReconnect', array());
 197         }
 198
 199         return $success;
 200     }
 201 }