plugins/DiskCachePlugin.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 with disk files
   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 cache data on local disk
  39  *
  40  * @category  Cache
  41  * @package   StatusNet
  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/
  46  */
  47
  48 class DiskCachePlugin extends Plugin
  49 {
  50     var $root = '/tmp';
  51
  52     function keyToFilename($key)
  53     {
  54         return $this->root . '/' . str_replace(':', '/', $key);
  55     }
  56
  57     /**
  58      * Get a value associated with a key
  59      *
  60      * The value should have been set previously.
  61      *
  62      * @param string &$key   in; Lookup key
  63      * @param mixed  &$value out; value associated with key
  64      *
  65      * @return boolean hook success
  66      */
  67
  68     function onStartCacheGet(&$key, &$value)
  69     {
  70         $filename = $this->keyToFilename($key);
  71
  72         if (file_exists($filename)) {
  73             $data = file_get_contents($filename);
  74             if ($data !== false) {
  75                 $value = unserialize($data);
  76             }
  77         }
  78
  79         Event::handle('EndCacheGet', array($key, &$value));
  80         return false;
  81     }
  82
  83     /**
  84      * Associate a value with a key
  85      *
  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
  91      *
  92      * @return boolean hook success
  93      */
  94
  95     function onStartCacheSet(&$key, &$value, &$flag, &$expiry, &$success)
  96     {
  97         $filename = $this->keyToFilename($key);
  98         $parent = dirname($filename);
  99
 100         $sofar = '';
 101
 102         foreach (explode('/', $parent) as $part) {
 103             if (empty($part)) {
 104                 continue;
 105             }
 106             $sofar .= '/' . $part;
 107             if (!is_dir($sofar)) {
 108                 $this->debug("Creating new directory '$sofar'");
 109                 $success = mkdir($sofar, 0750);
 110                 if (!$success) {
 111                     $this->log(LOG_ERR, "Can't create directory '$sofar'");
 112                     return false;
 113                 }
 114             }
 115         }
 116
 117         if (is_dir($filename)) {
 118             $success = false;
 119             return false;
 120         }
 121
 122         // Write to a temp file and move to destination
 123
 124         $tempname = tempnam(null, 'statusnetdiskcache');
 125
 126         $result = file_put_contents($tempname, serialize($value));
 127
 128         if ($result === false) {
 129             $this->log(LOG_ERR, "Couldn't write '$key' to temp file '$tempname'");
 130             return false;
 131         }
 132
 133         $result = rename($tempname, $filename);
 134
 135         if (!$result) {
 136             $this->log(LOG_ERR, "Couldn't move temp file '$tempname' to path '$filename' for key '$key'");
 137             @unlink($tempname);
 138             return false;
 139         }
 140
 141         Event::handle('EndCacheSet', array($key, $value, $flag,
 142                                            $expiry));
 143
 144         return false;
 145     }
 146
 147     /**
 148      * Delete a value associated with a key
 149      *
 150      * @param string  &$key     in; Key to lookup
 151      * @param boolean &$success out; whether it worked
 152      *
 153      * @return boolean hook success
 154      */
 155
 156     function onStartCacheDelete(&$key, &$success)
 157     {
 158         $filename = $this->keyToFilename($key);
 159
 160         if (file_exists($filename) && !is_dir($filename)) {
 161             unlink($filename);
 162         }
 163
 164         Event::handle('EndCacheDelete', array($key));
 165         return false;
 166     }
 167 }
 168