lib/plugin/RecentChanges.php

   1 <?php // -*-php-*-
   2 rcs_id('$Id: RecentChanges.php,v 1.11 2001-12-16 18:33:25 dairiki Exp $');
   3 /**
   4  */
   5
   6
   7
   8 class _RecentChanges_Formatter
   9 {
  10     var $_absurls = false;
  11
  12     function _RecentChanges_Formatter ($rc_args) {
  13         $this->_args = $rc_args;
  14         $this->_diffargs = array('action' => 'diff');
  15
  16         if ($rc_args['show_major'] && !$rc_args['show_minor'])
  17             $this->_diffargs['previous'] = 'major';
  18     }
  19
  20     function include_versions_in_URLs() {
  21         return (bool) $this->_args['show_all'];
  22     }
  23
  24     function date ($rev) {
  25         return strftime($GLOBALS['dateformat'], $rev->get('mtime'));
  26     }
  27
  28     function time ($rev) {
  29         // FIXME: Make configurable.
  30         return strftime("%l:%M %p", $rev->get('mtime'));
  31     }
  32
  33     function diffURL ($rev) {
  34         $args = $this->_diffargs;
  35         if ($this->include_versions_in_URLs())
  36             $args['version'] = $rev->getVersion();
  37         $page = $rev->getPage();
  38         return WikiURL($page->getName(), $args, $this->_absurls);
  39     }
  40
  41     function historyURL ($rev) {
  42         $page = $rev->getPage();
  43         return WikiURL(_("PageHistory"),
  44                        array('page' => $page->getName()),
  45                        $this->_absurls);
  46     }
  47
  48     function pageURL ($rev) {
  49         $params = array();
  50         if ($this->include_versions_in_URLs())
  51             $params['version'] = $rev->getVersion();
  52         $page = $rev->getPage();
  53         return WikiURL($page->getName(), $params, $this->_absurls);
  54     }
  55
  56     function authorURL($author) {
  57         global $WikiNameRegexp, $dbi;
  58
  59         if (preg_match("/^$WikiNameRegexp\$/", $author) && $dbi->isWikiPage($author))
  60             return WikiURL($author);
  61         return false;
  62     }
  63
  64
  65     function status ($rev) {
  66         if ($rev->hasDefaultContents())
  67             return 'deleted';
  68         $page = $rev->getPage();
  69         $prev = $page->getRevisionBefore($rev->getVersion());
  70         if ($prev->hasDefaultContents())
  71             return 'new';
  72         return 'updated';
  73     }
  74
  75     function importance ($rev) {
  76         return $rev->get('is_minor_edit') ? 'minor' : 'major';
  77     }
  78
  79     function summary($rev) {
  80         if ( ($summary = $rev->get('summary')) )
  81             return $summary;
  82
  83         switch ($this->status($rev)) {
  84         case 'deleted':
  85             return _("Deleted.");
  86         case 'new':
  87             return _("New page.");
  88         default:
  89             return '';
  90         }
  91     }
  92 }
  93
  94 class _RecentChanges_HtmlFormatter
  95 extends _RecentChanges_Formatter
  96 {
  97     function diffLink ($rev) {
  98         return QElement('a', array('href' => $this->diffURL($rev)),
  99                         _("(diff)"));
 100     }
 101
 102     function pageLink ($rev) {
 103         $page = $rev->getPage();
 104         return QElement('a', array('href' => $this->pageURL($rev), 'class' => 'wiki'),
 105                         $page->getName());
 106     }
 107
 108     function authorLink ($rev) {
 109         $author = $rev->get('author');
 110         if ( ($url = $this->authorURL($author)) )
 111             return QElement('a', array('href' => $url, 'class' => 'wiki'), $author);
 112         else
 113             return htmlspecialchars($author);
 114     }
 115
 116
 117     function rss_icon () {
 118         global $request;
 119
 120         $rss_url = $request->getURLtoSelf(array('format' => 'rss'));
 121         return Element('a', array('href' => $rss_url),
 122                        Element('img', array('src' => DataURL('images/rss.png'),
 123                                             'alt' => _("RSS available"),
 124                                             'class' => 'rssicon')));
 125     }
 126
 127     function description () {
 128         extract($this->_args);
 129
 130         // FIXME: say something about show_all.
 131
 132         if ($show_major && $show_minor)
 133             $edits = _("edits");
 134         elseif ($show_major)
 135             $edits = _("major edits");
 136         else
 137             $edits = _("minor edits");
 138
 139         if ($limit > 0) {
 140             if ($days > 0)
 141                 $desc = sprintf(_("The %d most recent %s during the past %.1f days are listed below."),
 142                                $limit, $edits, $days);
 143             else
 144                 $desc = sprintf(_("The %d most recent %s are listed below."),
 145                                $limit, $edits);
 146         }
 147         else {
 148             if ($days > 0)
 149                 $desc = sprintf(_("The most recent %s during the past %.1f days are listed below."),
 150                                $edits, $days);
 151             else
 152                 $desc = sprintf(_("All %s are listed below."), $edits);
 153         }
 154         return htmlspecialchars($desc);
 155     }
 156
 157
 158     function title () {
 159         return htmlspecialchars(_("RecentChanges")) . "\n" . $this->rss_icon();
 160     }
 161
 162     function format ($changes) {
 163         $html[] = Element('h2', $this->title());
 164         if (($desc = $this->description()))
 165             $html[] = Element('p', $desc);
 166
 167         $last_date = '';
 168         $lines = array();
 169
 170         while ($rev = $changes->next()) {
 171             if (($date = $this->date($rev)) != $last_date) {
 172                 if ($lines) {
 173                     $html[] = Element('ul', join("\n", $lines));
 174                     $lines = array();
 175                 }
 176                 $html[] = QElement('h3', $date);
 177                 $last_date = $date;
 178             }
 179
 180             $lines[] = $this->format_revision($rev);
 181         }
 182         if ($lines)
 183             $html[] = Element('ul', join("\n", $lines));
 184         return join("\n", $html) . "\n";
 185     }
 186
 187     function format_revision ($rev) {
 188         if ( ($summary = $this->summary($rev)) )
 189             $summary = "[" . QElement('b', array('class' => 'wiki:summary'), $summary) . "]";
 190
 191         $class = 'rc-' . $this->importance($rev);
 192
 193         return Element('li', array('class' => $class),
 194                        implode(' ', array( $this->diffLink($rev),
 195                                            $this->pageLink($rev),
 196                                            $this->time($rev),
 197                                            $summary,
 198                                            '...',
 199                                            $this->authorLink($rev) )));
 200     }
 201 }
 202
 203
 204
 205 class _RecentChanges_RssFormatter
 206 extends _RecentChanges_Formatter
 207 {
 208     var $_absurls = true;
 209
 210     function time ($rev) {
 211         return Iso8601DateTime($rev->get('mtime'));
 212     }
 213
 214     function pageURI ($rev) {
 215         $page = $rev->getPage();
 216         return WikiURL($page->getName(),
 217                        array('version' => $rev->getVersion()),
 218                        'absurl');
 219     }
 220
 221     function format ($changes) {
 222         include_once('lib/RssWriter.php');
 223         $rss = new RssWriter;
 224
 225
 226         $rss->channel($this->channel_properties());
 227
 228         if (($props = $this->image_properties()))
 229             $rss->image($props);
 230         if (($props = $this->textinput_properties()))
 231             $rss->textinput($props);
 232
 233         while ($rev = $changes->next()) {
 234             $rss->addItem($this->item_properties($rev),
 235                           $this->pageURI($rev));
 236         }
 237
 238         $rss->finish();
 239         printf("\n<!-- Generated by PhpWiki:\n%s-->\n", $GLOBALS['RCS_IDS']);
 240         ExitWiki();             // NORETURN!!!!
 241     }
 242
 243     function image_properties () {
 244         return array('title' => WIKI_NAME,
 245                      'link' => WikiURL(_("HomePage"), false, 'absurl'),
 246                      'url' => DataURL($GLOBALS['logo']));
 247     }
 248
 249     function textinput_properties () {
 250         return array('title' => _("Search"),
 251                      'description' => _("Title Search"),
 252                      'name' => 's',
 253                      'link' => WikiURL(_("TitleSearch"), false, 'absurl'));
 254     }
 255
 256     function channel_properties () {
 257         global $request;
 258
 259         $rc_url = WikiURL($request->getArg('pagename'), false, 'absurl');
 260
 261         return array('title' => WIKI_NAME,
 262                      'dc:description' => _("RecentChanges"),
 263                      'link' => $rc_url,
 264                      'dc:date' => Iso8601DateTime(time()));
 265
 266         /* FIXME: other things one might like in <channel>:
 267          * sy:updateFrequency
 268          * sy:updatePeriod
 269          * sy:updateBase
 270          * dc:subject
 271          * dc:publisher
 272          * dc:language
 273          * dc:rights
 274          * rss091:language
 275          * rss091:managingEditor
 276          * rss091:webmaster
 277          * rss091:lastBuildDate
 278          * rss091:copyright
 279          */
 280     }
 281
 282
 283
 284
 285     function item_properties ($rev) {
 286         $page = $rev->getPage();
 287         $pagename = $page->getName();
 288
 289         return array( 'title'           => split_pagename($pagename),
 290                       'description'     => $this->summary($rev),
 291                       'link'            => $this->pageURL($rev),
 292                       'dc:date'         => $this->time($rev),
 293                       'dc:contributor'  => $rev->get('author'),
 294                       'wiki:version'    => $rev->getVersion(),
 295                       'wiki:importance' => $this->importance($rev),
 296                       'wiki:status'     => $this->status($rev),
 297                       'wiki:diff'       => $this->diffURL($rev),
 298                       'wiki:history'    => $this->historyURL($rev)
 299                       );
 300     }
 301 }
 302
 303 class WikiPlugin_RecentChanges
 304 extends WikiPlugin
 305 {
 306     function getName () {
 307         return _("RecentChanges");
 308     }
 309
 310     function getDefaultArguments() {
 311         return array('days'             => 2,
 312                      'show_minor'       => false,
 313                      'show_major'       => true,
 314                      'show_all'         => false,
 315                      'limit'            => false,
 316                      'format'           => false);
 317     }
 318
 319     function getArgs ($argstr, $request, $defaults = false) {
 320         $args = WikiPlugin::getArgs($argstr, $request, $defaults);
 321
 322         if ($request->getArg('action') != 'browse')
 323             $args['format'] = false; // default -> HTML
 324
 325         if ($args['format'] == 'rss' && empty($args['limit']))
 326             $args['limit'] = 15; // Fix default value for RSS.
 327
 328         return $args;
 329     }
 330
 331     function getMostRecentParams ($args) {
 332         extract($args);
 333
 334         $params = array('include_minor_revisions' => $show_minor,
 335                         'exclude_major_revisions' => !$show_major,
 336                         'include_all_revisions' => !empty($show_all));
 337
 338         if ($limit > 0)
 339             $params['limit'] = $limit;
 340
 341         if ($days > 0.0)
 342             $params['since'] = time() - 24 * 3600 * $days;
 343
 344         return $params;
 345     }
 346
 347     function getChanges ($dbi, $args) {
 348         return $dbi->mostRecent($this->getMostRecentParams($args));
 349     }
 350
 351     function format ($changes, $args) {
 352         if ($args['format'] == 'rss')
 353             $fmt = new _RecentChanges_RssFormatter($args);
 354         else
 355             $fmt = new _RecentChanges_HtmlFormatter($args);
 356         return $fmt->format($changes);
 357     }
 358
 359
 360     function run ($dbi, $argstr, $request) {
 361         $args = $this->getArgs($argstr, $request);
 362         // Hack alert: format() is a NORETURN for rss formatters.
 363         return $this->format($this->getChanges($dbi, $args), $args);
 364     }
 365 };
 366
 367
 368 // (c-file-style: "gnu")
 369 // Local Variables:
 370 // mode: php
 371 // tab-width: 8
 372 // c-basic-offset: 4
 373 // c-hanging-comment-ender-p: nil
 374 // indent-tabs-mode: nil
 375 // End:
 376 ?>