lib/plugin/RecentChangesCached.php

   1 <?php
   2
   3 /**
   4  * Copyright 1999, 2000, 2001, 2002 $ThePhpWikiProgrammingTeam
   5  * Copyright (C) 2002 Johannes Große                                   |
   6  *
   7  * This file is part of PhpWiki.
   8  *
   9  * PhpWiki is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * PhpWiki 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 General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with PhpWiki; if not, write to the Free Software Foundation, Inc.,
  21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  22  */
  23
  24 /* There is a bug in it:
  25    When the cache is empty and you safe the wikipages,
  26    an immediately created cached output of
  27    RecentChanges will at the rss-image-link include
  28    an action=edit
  29 */
  30
  31 require_once 'lib/WikiPluginCached.php';
  32 require_once 'lib/plugin/RecentChanges.php';
  33
  34 class WikiPlugin_RecentChangesCached
  35     extends WikiPluginCached
  36 {
  37     function getPluginType()
  38     {
  39         return PLUGIN_CACHED_HTML;
  40     }
  41
  42     function getDescription()
  43     {
  44         return 'Cache output of RecentChanges called with default arguments.';
  45     }
  46
  47     function getDefaultArguments()
  48     {
  49         return WikiPlugin_RecentChanges::getDefaultArguments();
  50     }
  51
  52     function getExpire($dbi, $argarray, $request)
  53     {
  54         return '+900'; // 15 minutes
  55     }
  56
  57     // We don't go through pi parsing, instead we go directly to the
  58     // better plugin methods.
  59     /**
  60      * @param WikiDB $dbi
  61      * @param string $argstr
  62      * @param WikiRequest $request
  63      * @param string $basepage
  64      * @return mixed
  65      */
  66     protected function getHtml($dbi, $args, $request, $basepage)
  67     {
  68         $plugin = new WikiPlugin_RecentChanges();
  69         $changes = $plugin->getChanges($dbi, $args);
  70         return $plugin->format($changes, $args);
  71         /*
  72         $loader = new WikiPluginLoader();
  73         return $loader->expandPI('<?plugin RecentChanges '
  74             . WikiPluginCached::glueArgs($argarray)
  75                                  . ' ?>', $request, $this, $basepage);
  76         */
  77     }
  78
  79     protected function getImage($dbi, $argarray, $request)
  80     {
  81         trigger_error('pure virtual', E_USER_ERROR);
  82     }
  83
  84     protected function getMap($dbi, $argarray, $request)
  85     {
  86         trigger_error('pure virtual', E_USER_ERROR);
  87     }
  88
  89     // ->box is used to display a fixed-width, narrow version with common header.
  90     // Just a limited list of pagenames, without date.
  91     // This does not use ->run, to avoid pi construction and deconstruction
  92     function box($args = '', $request = null, $basepage = '', $do_save = false)
  93     {
  94         if (!$request) $request =& $GLOBALS['request'];
  95         if (!isset($args['limit'])) $args['limit'] = 12;
  96         $args['format'] = 'box';
  97         $args['show_minor'] = false;
  98         $args['show_major'] = true;
  99         $args['show_deleted'] = 'sometimes';
 100         $args['show_all'] = false;
 101         $args['days'] = 90;
 102
 103         $cache = $this->newCache();
 104         if (is_array($args))
 105             ksort($args);
 106         $argscopy = $args;
 107         unset($argscopy['limit']);
 108         $this->_args =& $args;
 109         $this->_type = $this->getPluginType();
 110         $this->_static = false;
 111
 112         /* OLD: */
 113         //list($id, $url) = $this->genUrl($cache, $args);
 114
 115         /* NEW: This cache entry needs an update on major changes.
 116          * So we should rather use an unique ID, because there will only be
 117          * one global cached box.
 118          */
 119         $id = $cache->generateId(serialize(array("RecentChangesCachedBox", $argscopy)));
 120         $content = $cache->get($id, 'imagecache');
 121         if ($do_save || !$content || !$content['html']) {
 122             $this->resetError();
 123             $plugin = new WikiPlugin_RecentChanges();
 124             $title = WikiLink($this->getName(), '', SplitPagename($this->getName()));
 125             $changes = $plugin->getChanges($request->_dbi, $args);
 126             $content['html'] =
 127                 $this->makeBox($title,
 128                     $plugin->format($changes, $args));
 129             if ($errortext = $this->getError()) {
 130                 $this->printError($errortext, 'html');
 131                 return HTML();
 132             }
 133             $do_save = true;
 134         }
 135         if ($do_save) {
 136             $content['args'] = md5($this->_pi);
 137             $expire = $this->getExpire($request->_dbi, $content['args'], $request);
 138             $cache->save($id, $content, $expire, 'imagecache');
 139         }
 140         if ($content['html'])
 141             return $content['html'];
 142         return HTML();
 143     }
 144
 145     // force box cache update on major changes.
 146     function box_update($args = false, $request = false, $basepage = false)
 147     {
 148         $this->box($args, $request, $basepage, true);
 149     }
 150
 151 }
 152
 153 // Local Variables:
 154 // mode: php
 155 // tab-width: 8
 156 // c-basic-offset: 4
 157 // c-hanging-comment-ender-p: nil
 158 // indent-tabs-mode: nil
 159 // End: