3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2009, StatusNet, Inc.
6 * Plugin to implement cache interface with disk files
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 cache data on local disk
42 * @author Evan Prodromou <evan@status.net>
43 * @copyright 2009 StatusNet, Inc.
44 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
45 * @link http://status.net/
48 class DiskCachePlugin extends Plugin
52 function keyToFilename($key)
54 return $this->root . '/' . str_replace(':', '/', $key);
58 * Get a value associated with a key
60 * The value should have been set previously.
62 * @param string &$key in; Lookup key
63 * @param mixed &$value out; value associated with key
65 * @return boolean hook success
68 function onStartCacheGet(&$key, &$value)
70 $filename = $this->keyToFilename($key);
71 if (file_exists($filename)) {
72 $this->log(LOG_INFO, "Cache hit on key '$key'");
73 $data = file_get_contents($filename);
74 $value = unserialize($data);
76 $this->log(LOG_INFO, "Cache miss on key '$key'");
79 Event::handle('EndCacheGet', array($key, &$value));
84 * Associate a value with a key
86 * @param string &$key in; Key to use for lookups
87 * @param mixed &$value in; Value to associate
88 * @param integer &$flag in; Flag (passed through to Memcache)
89 * @param integer &$expiry in; Expiry (passed through to Memcache)
90 * @param boolean &$success out; Whether the set was successful
92 * @return boolean hook success
95 function onStartCacheSet(&$key, &$value, &$flag, &$expiry, &$success)
97 $this->log(LOG_INFO, "Setting value for key '$key'");
99 $filename = $this->keyToFilename($key);
100 $parent = dirname($filename);
104 foreach (explode('/', $parent) as $part) {
108 $sofar .= '/' . $part;
109 if (!is_dir($sofar)) {
110 $this->debug("Creating new directory '$sofar'");
111 $success = mkdir($sofar, 0750);
113 $this->log(LOG_ERR, "Can't create directory '$sofar'");
119 if (is_dir($filename)) {
124 file_put_contents($filename, serialize($value));
126 Event::handle('EndCacheSet', array($key, $value, $flag,
133 * Delete a value associated with a key
135 * @param string &$key in; Key to lookup
136 * @param boolean &$success out; whether it worked
138 * @return boolean hook success
141 function onStartCacheDelete(&$key, &$success)
143 $this->log(LOG_INFO, "Deleting value for key '$key'");
145 $filename = $this->keyToFilename($key);
147 if (file_exists($filename) && !is_dir($filename)) {
151 Event::handle('EndCacheDelete', array($key));