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.
  34  *
  35  */
  36
  37 class Cache
  38 {
  39     var $_items = array();
  40     static $_inst = null;
  41
  42     static function instance()
  43     {
  44         if (is_null(self::$_inst)) {
  45             self::$_inst = new Cache();
  46         }
  47
  48         return self::$_inst;
  49     }
  50
  51     static function key($extra)
  52     {
  53         $base_key = common_config('memcached', 'base');
  54
  55         if (empty($base_key)) {
  56             $base_key = common_keyize(common_config('site', 'name'));
  57         }
  58
  59         return 'statusnet:' . $base_key . ':' . $extra;
  60     }
  61
  62     static function keyize($str)
  63     {
  64         $str = strtolower($str);
  65         $str = preg_replace('/\s/', '_', $str);
  66         return $str;
  67     }
  68
  69     function get($key)
  70     {
  71         $value = null;
  72
  73         if (!Event::handle('StartCacheGet', array(&$key, &$value))) {
  74             if (array_key_exists($_items, $key)) {
  75                 common_log(LOG_INFO, 'Cache HIT for key ' . $key);
  76                 $value = $_items[$key];
  77             } else {
  78                 common_log(LOG_INFO, 'Cache MISS for key ' . $key);
  79             }
  80             Event::handle('EndCacheGet', array($key, &$value));
  81         }
  82
  83         return $value;
  84     }
  85
  86     function set($key, $value, $flag=null, $expiry=null)
  87     {
  88         $success = false;
  89
  90         if (!Event::handle('StartCacheSet', array(&$key, &$value, &$flag, &$expiry, &$success))) {
  91             common_log(LOG_INFO, 'Setting cache value for key ' . $key);
  92             $_items[$key] = $value;
  93             $success = true;
  94             Event::handle('EndCacheSet', array($key, $value, $flag, $expiry));
  95         }
  96
  97         return $success;
  98     }
  99
 100     function delete($key)
 101     {
 102         $success = false;
 103
 104         if (!Event::handle('StartCacheDelete', array(&$key, &$success))) {
 105             common_log(LOG_INFO, 'Deleting cache value for key ' . $key);
 106             unset($_items[$key]);
 107             $success = true;
 108             Event::handle('EndCacheDelete', array($key));
 109         }
 110
 111         return $success;
 112     }
 113 }