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 getName()
  43     {
  44         return "RecentChangesCached";
  45     }
  46
  47     function getDescription()
  48     {
  49         return 'Cache output of RecentChanges called with default arguments.';
  50     }
  51
  52     function getDefaultArguments()
  53     {
  54         return WikiPlugin_RecentChanges::getDefaultArguments();
  55     }
  56
  57     function getExpire($dbi, $argarray, $request)
  58     {
  59         return '+900'; // 15 minutes
  60     }
  61
  62     // We don't go through pi parsing, instead we go directly to the
  63     // better plugin methods.
  64     function getHtml($dbi, $args, $request, $basepage)
  65     {
  66         $plugin = new WikiPlugin_RecentChanges();
  67         $changes = $plugin->getChanges($dbi, $args);
  68         return $plugin->format($changes, $args);
  69         /*
  70         $loader = new WikiPluginLoader();
  71         return $loader->expandPI('<?plugin RecentChanges '
  72             . WikiPluginCached::glueArgs($argarray)
  73                                  . ' ?>', $request, $this, $basepage);
  74         */
  75     }
  76
  77     // ->box is used to display a fixed-width, narrow version with common header.
  78     // Just a limited list of pagenames, without date.
  79     // This does not use ->run, to avoid pi construction and deconstruction
  80     function box($args = false, $request = false, $basepage = false, $do_save = false)
  81     {
  82         if (!$request) $request =& $GLOBALS['request'];
  83         if (!isset($args['limit'])) $args['limit'] = 12;
  84         $args['format'] = 'box';
  85         $args['show_minor'] = false;
  86         $args['show_major'] = true;
  87         $args['show_deleted'] = 'sometimes';
  88         $args['show_all'] = false;
  89         $args['days'] = 90;
  90
  91         $cache = $this->newCache();
  92         if (is_array($args))
  93             ksort($args);
  94         $argscopy = $args;
  95         unset($argscopy['limit']);
  96         $this->_args =& $args;
  97         $this->_type = $this->getPluginType();
  98         $this->_static = false;
  99
 100         /* OLD: */
 101         //list($id, $url) = $this->genUrl($cache, $args);
 102
 103         /* NEW: This cache entry needs an update on major changes.
 104          * So we should rather use an unique ID, because there will only be
 105          * one global cached box.
 106          */
 107         $id = $cache->generateId(serialize(array("RecentChangesCachedBox", $argscopy)));
 108         $content = $cache->get($id, 'imagecache');
 109         if ($do_save || !$content || !$content['html']) {
 110             $this->resetError();
 111             $plugin = new WikiPlugin_RecentChanges();
 112             $title = WikiLink($this->getName(), '', SplitPagename($this->getName()));
 113             $changes = $plugin->getChanges($request->_dbi, $args);
 114             $content['html'] =
 115                 $this->makeBox($title,
 116                     $plugin->format($changes, $args));
 117             if ($errortext = $this->getError()) {
 118                 $this->printError($errortext, 'html');
 119                 return HTML();
 120             }
 121             $do_save = true;
 122         }
 123         if ($do_save) {
 124             $content['args'] = md5($this->_pi);
 125             $expire = $this->getExpire($request->_dbi, $content['args'], $request);
 126             $cache->save($id, $content, $expire, 'imagecache');
 127         }
 128         if ($content['html'])
 129             return $content['html'];
 130         return HTML();
 131     }
 132
 133     // force box cache update on major changes.
 134     function box_update($args = false, $request = false, $basepage = false)
 135     {
 136         $this->box($args, $request, $basepage, true);
 137     }
 138
 139 }
 140
 141 // Local Variables:
 142 // mode: php
 143 // tab-width: 8
 144 // c-basic-offset: 4
 145 // c-hanging-comment-ender-p: nil
 146 // indent-tabs-mode: nil
 147 // End: