3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2009, StatusNet, Inc.
6 * Plugin to implement cache interface for memcache
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.
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.
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/>.
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/
31 if (!defined('STATUSNET')) {
32 // This check helps protect against security problems;
33 // your code file can't be executed directly from the web.
38 * A plugin to use memcache for the cache interface
40 * This used to be encoded as config-variable options in the core code;
41 * it's now broken out to a separate plugin. The same interface can be
42 * implemented by other plugins.
46 * @author Evan Prodromou <evan@status.net>
47 * @copyright 2009 StatusNet, Inc.
48 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
49 * @link http://status.net/
52 class MemcachePlugin extends Plugin
54 private $_conn = null;
55 public $servers = array('127.0.0.1;11211');
57 public $compressThreshold = 20480;
58 public $compressMinSaving = 0.2;
60 public $persistent = null;
63 * Initialize the plugin
65 * Note that onStartCacheGet() may have been called before this!
67 * @return boolean flag value
70 function onInitializePlugin()
72 if (is_null($this->persistent)) {
73 $this->persistent = (php_sapi_name() == 'cli') ? false : true;
80 * Get a value associated with a key
82 * The value should have been set previously.
84 * @param string &$key in; Lookup key
85 * @param mixed &$value out; value associated with key
87 * @return boolean hook success
90 function onStartCacheGet(&$key, &$value)
93 $value = $this->_conn->get($key);
94 Event::handle('EndCacheGet', array($key, &$value));
99 * Associate a value with a key
101 * @param string &$key in; Key to use for lookups
102 * @param mixed &$value in; Value to associate
103 * @param integer &$flag in; Flag (passed through to Memcache)
104 * @param integer &$expiry in; Expiry (passed through to Memcache)
105 * @param boolean &$success out; Whether the set was successful
107 * @return boolean hook success
110 function onStartCacheSet(&$key, &$value, &$flag, &$expiry, &$success)
112 $this->_ensureConn();
113 $success = $this->_conn->set($key, $value, $flag, $expiry);
114 Event::handle('EndCacheSet', array($key, $value, $flag,
120 * Delete a value associated with a key
122 * @param string &$key in; Key to lookup
123 * @param boolean &$success out; whether it worked
125 * @return boolean hook success
128 function onStartCacheDelete(&$key, &$success)
130 $this->_ensureConn();
131 $success = $this->_conn->delete($key);
132 Event::handle('EndCacheDelete', array($key));
136 function onStartCacheReconnect(&$success)
138 if (empty($this->_conn)) {
142 if ($this->persistent) {
143 common_log(LOG_ERR, "Cannot close persistent memcached connection");
146 common_log(LOG_INFO, "Closing memcached connection");
147 $success = $this->_conn->close();
154 * Ensure that a connection exists
156 * Checks the instance $_conn variable and connects
162 private function _ensureConn()
164 if (empty($this->_conn)) {
165 $this->_conn = new Memcache();
167 if (is_array($this->servers)) {
168 $servers = $this->servers;
170 $servers = array($this->servers);
172 foreach ($servers as $server) {
173 if (strpos($server, ';') !== false) {
174 list($host, $port) = explode(';', $server);
180 $this->_conn->addServer($host, $port, $this->persistent);
183 // Compress items stored in the cache if they're over threshold in size
184 // (default 2KiB) and the compression would save more than min savings
185 // ratio (default 0.2).
187 // Allows the cache to store objects larger than 1MB (if they
188 // compress to less than 1MB), and improves cache memory efficiency.
190 $this->_conn->setCompressThreshold($this->compressThreshold,
191 $this->compressMinSaving);
195 function onPluginVersion(&$versions)
197 $versions[] = array('name' => 'Memcache',
198 'version' => STATUSNET_VERSION,
199 'author' => 'Evan Prodromou, Craig Andrews',
200 'homepage' => 'http://status.net/wiki/Plugin:Memcache',
202 _m('Use <a href="http://memcached.org/">Memcached</a> to cache query results.'));