plugins/XCache/XCachePlugin.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2009, StatusNet, Inc.
   5  *
   6  * Plugin to implement cache interface for XCache variable cache
   7  *
   8  * PHP version 5
   9  *
  10  * This program is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU Affero General Public License as published by
  12  * the Free Software Foundation, either version 3 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Affero General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Affero General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  *
  23  * @category  Cache
  24  * @package   StatusNet
  25  * @author    Evan Prodromou <evan@status.net>
  26  * @copyright 2009 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET')) {
  32     // This check helps protect against security problems;
  33     // your code file can't be executed directly from the web.
  34     exit(1);
  35 }
  36
  37 /**
  38  * A plugin to use XCache's variable cache for the cache interface
  39  *
  40  * New plugin interface lets us use alternative cache systems
  41  * for caching. This one uses XCache's variable cache.
  42  *
  43  * @category  Cache
  44  * @package   StatusNet
  45  * @author    Evan Prodromou <evan@status.net>
  46  * @copyright 2009 StatusNet, Inc.
  47  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  48  * @link      http://status.net/
  49  */
  50 class XCachePlugin extends Plugin
  51 {
  52     /**
  53      * Get a value associated with a key
  54      *
  55      * The value should have been set previously.
  56      *
  57      * @param string &$key   in; Lookup key
  58      * @param mixed  &$value out; value associated with key
  59      *
  60      * @return boolean hook success
  61      */
  62     function onStartCacheGet(&$key, &$value)
  63     {
  64         if (!xcache_isset($key)) {
  65             $value = false;
  66         } else {
  67             $value = xcache_get($key);
  68             $value = unserialize($value);
  69         }
  70         Event::handle('EndCacheGet', array($key, &$value));
  71         return false;
  72     }
  73
  74     /**
  75      * Associate a value with a key
  76      *
  77      * @param string  &$key     in; Key to use for lookups
  78      * @param mixed   &$value   in; Value to associate
  79      * @param integer &$flag    in; Flag (passed through to Memcache)
  80      * @param integer &$expiry  in; Expiry (passed through to Memcache)
  81      * @param boolean &$success out; Whether the set was successful
  82      *
  83      * @return boolean hook success
  84      */
  85     function onStartCacheSet(&$key, &$value, &$flag, &$expiry, &$success)
  86     {
  87         $success = xcache_set($key, serialize($value));
  88
  89         Event::handle('EndCacheSet', array($key, $value, $flag,
  90                                            $expiry));
  91         return false;
  92     }
  93
  94     /**
  95      * Delete a value associated with a key
  96      *
  97      * @param string  &$key     in; Key to lookup
  98      * @param boolean &$success out; whether it worked
  99      *
 100      * @return boolean hook success
 101      */
 102     function onStartCacheDelete(&$key, &$success)
 103     {
 104         $success = xcache_unset($key);
 105         Event::handle('EndCacheDelete', array($key));
 106         return false;
 107     }
 108
 109     function onPluginVersion(array &$versions)
 110     {
 111         $versions[] = array('name' => 'XCache',
 112                             'version' => GNUSOCIAL_VERSION,
 113                             'author' => 'Craig Andrews',
 114                             'homepage' => 'http://status.net/wiki/Plugin:XCache',
 115                             'rawdescription' =>
 116                             // TRANS: Plugin description.
 117                             _m('Use the <a href="http://xcache.lighttpd.net/">XCache</a> variable cache to cache query results.'));
 118         return true;
 119     }
 120 }