lib/plugin/RecentChanges.php

   1 <?php // -*-php-*-
   2 rcs_id('$Id: RecentChanges.php,v 1.47 2002-01-30 23:41:54 dairiki Exp $');
   3 /**
   4  */
   5
   6
   7 class _RecentChanges_Formatter
   8 {
   9     var $_absurls = false;
  10
  11     function _RecentChanges_Formatter ($rc_args) {
  12         $this->_args = $rc_args;
  13         $this->_diffargs = array('action' => 'diff');
  14
  15         if ($rc_args['show_major'] && !$rc_args['show_minor'])
  16             $this->_diffargs['previous'] = 'major';
  17     }
  18
  19     function include_versions_in_URLs() {
  20         return (bool) $this->_args['show_all'];
  21     }
  22
  23     function date ($rev) {
  24         global $Theme;
  25         return $Theme->formatDate($rev->get('mtime'));
  26     }
  27
  28     function time ($rev) {
  29         global $Theme;
  30         return $Theme->formatTime($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($page, array('action' => _("PageHistory")),
  44                        $this->_absurls);
  45     }
  46
  47     function pageURL ($rev) {
  48         return WikiURL($this->include_versions_in_URLs() ? $rev : $page,
  49                        '', $this->_absurls);
  50     }
  51
  52     function authorHasPage ($author) {
  53         global $WikiNameRegexp, $request;
  54         $dbi = $request->getDbh();
  55         return preg_match("/^$WikiNameRegexp\$/", $author) && $dbi->isWikiPage($author);
  56     }
  57
  58     function authorURL ($author) {
  59         return $this->authorHasPage() ? WikiURL($author) : false;
  60     }
  61
  62
  63     function status ($rev) {
  64         if ($rev->hasDefaultContents())
  65             return 'deleted';
  66         $page = $rev->getPage();
  67         $prev = $page->getRevisionBefore($rev->getVersion());
  68         if ($prev->hasDefaultContents())
  69             return 'new';
  70         return 'updated';
  71     }
  72
  73     function importance ($rev) {
  74         return $rev->get('is_minor_edit') ? 'minor' : 'major';
  75     }
  76
  77     function summary($rev) {
  78         if ( ($summary = $rev->get('summary')) )
  79             return $summary;
  80
  81         switch ($this->status($rev)) {
  82         case 'deleted':
  83             return _("Deleted.");
  84         case 'new':
  85             return _("New page.");
  86         default:
  87             return '';
  88         }
  89     }
  90 }
  91
  92 class _RecentChanges_HtmlFormatter
  93 extends _RecentChanges_Formatter
  94 {
  95     function diffLink ($rev) {
  96         global $Theme;
  97         return $Theme->makeButton(_("(diff)"), $this->diffURL($rev), 'wiki-rc-action');
  98     }
  99
 100     function pageLink ($rev) {
 101         $page = $rev->getPage();
 102         global $Theme;
 103         if ($this->include_versions_in_URLs()) {
 104             $version = $rev->getVersion();
 105             $exists = !$rev->hasDefaultContents();
 106         }
 107         else {
 108             $version = false;
 109             $cur = $page->getCurrentRevision();
 110             $exists = !$cur->hasDefaultContents();
 111         }
 112         if ($exists)
 113             return $Theme->linkExistingWikiWord($page->getName(), false, $version);
 114         else
 115             return $Theme->linkUnknownWikiWord($page->getName(), false, $version);
 116     }
 117
 118     function authorLink ($rev) {
 119         $author = $rev->get('author');
 120         if ( $this->authorHasPage($author) ) {
 121             return WikiLink($author);
 122         } else
 123             return $author;
 124     }
 125
 126     function summaryAsHTML ($rev) {
 127         if ( !($summary = $this->summary($rev)) )
 128             return '';
 129         return  HTML::strong( array('class' => 'wiki-summary'),
 130                               "[",
 131                               do_transform($summary, 'LinkTransform'),
 132                               "]");
 133     }
 134
 135     function rss_icon () {
 136         global $request, $Theme;
 137
 138         $rss_url = $request->getURLtoSelf(array('format' => 'rss'));
 139         return $Theme->makeButton("RSS", $rss_url, 'rssicion');
 140     }
 141
 142     function description () {
 143         extract($this->_args);
 144
 145         // FIXME: say something about show_all.
 146
 147         if ($show_major && $show_minor)
 148             $edits = _("edits");
 149         elseif ($show_major)
 150             $edits = _("major edits");
 151         else
 152             $edits = _("minor edits");
 153
 154         if ($limit > 0) {
 155             if ($days > 0)
 156                 $desc = fmt("The %d most recent %s during the past %.1f days are listed below.",
 157                             $limit, $edits, $days);
 158             else
 159                 $desc = fmt("The %d most recent %s are listed below.",
 160                             $limit, $edits);
 161         }
 162         else {
 163             if ($days > 0)
 164                 $desc = fmt("The most recent %s during the past %.1f days are listed below.",
 165                             $edits, $days);
 166             else
 167                 $desc = fmt("All %s are listed below.", $edits);
 168         }
 169         return $desc;
 170     }
 171
 172
 173     function title () {
 174         extract($this->_args);
 175         return array($show_minor ? _("RecentEdits") : _("RecentChanges"),
 176                      ' ',
 177                      $this->rss_icon());
 178     }
 179
 180     function format ($changes) {
 181         $html = HTML(HTML::h2(false, $this->title()));
 182         if (($desc = $this->description()))
 183             $html->pushContent(HTML::p(false, $desc));
 184
 185         $last_date = '';
 186         $lines = false;
 187
 188         while ($rev = $changes->next()) {
 189             if (($date = $this->date($rev)) != $last_date) {
 190                 if ($lines)
 191                     $html->pushContent($lines);
 192                 $html->pushContent(HTML::h3($date));
 193                 $lines = HTML::ul();
 194                 $last_date = $date;
 195             }
 196             $lines->pushContent($this->format_revision($rev));
 197         }
 198         if ($lines)
 199             $html->pushContent($lines);
 200         return $html;
 201     }
 202
 203     function format_revision ($rev) {
 204         $class = 'rc-' . $this->importance($rev);
 205
 206         return HTML::li(array('class' => $class),
 207                         $this->diffLink($rev), ' ',
 208                         $this->pageLink($rev), ' ',
 209                         $rev->get('is_minor_edit') ? $this->time($rev) : HTML::strong($this->time($rev)), ' ',
 210                         $this->summaryAsHTML($rev),
 211                         ' ... ',
 212                         $this->authorLink($rev));
 213     }
 214 }
 215
 216
 217 class _RecentChanges_RssFormatter
 218 extends _RecentChanges_Formatter
 219 {
 220     var $_absurls = true;
 221
 222     function time ($rev) {
 223         return Iso8601DateTime($rev->get('mtime'));
 224     }
 225
 226     function pageURI ($rev) {
 227         return WikiURL($rev, '', 'absurl');
 228     }
 229
 230     function format ($changes) {
 231         include_once('lib/RssWriter.php');
 232         $rss = new RssWriter;
 233
 234
 235         $rss->channel($this->channel_properties());
 236
 237         if (($props = $this->image_properties()))
 238             $rss->image($props);
 239         if (($props = $this->textinput_properties()))
 240             $rss->textinput($props);
 241
 242         while ($rev = $changes->next()) {
 243             $rss->addItem($this->item_properties($rev),
 244                           $this->pageURI($rev));
 245         }
 246
 247         $rss->finish();
 248         printf("\n<!-- Generated by PhpWiki:\n%s-->\n", $GLOBALS['RCS_IDS']);
 249
 250         global $request;        // FIXME
 251         $request->finish();     // NORETURN!!!!
 252     }
 253
 254     function image_properties () {
 255         global $Theme;
 256
 257         $img_url = $Theme->getImageURL('logo');
 258         if (!$img_url)
 259             return false;
 260
 261         return array('title' => WIKI_NAME,
 262                      'link' => WikiURL(HomePage, false, 'absurl'),
 263                      'url' => $img_url);
 264     }
 265
 266     function textinput_properties () {
 267         return array('title' => _("Search"),
 268                      'description' => _("Title Search"),
 269                      'name' => 's',
 270                      'link' => WikiURL(_("TitleSearch"), false, 'absurl'));
 271     }
 272
 273     function channel_properties () {
 274         global $request;
 275
 276         $rc_url = WikiURL($request->getArg('pagename'), false, 'absurl');
 277
 278         return array('title' => WIKI_NAME,
 279                      'dc:description' => _("RecentChanges"),
 280                      'link' => $rc_url,
 281                      'dc:date' => Iso8601DateTime(time()));
 282
 283         /* FIXME: other things one might like in <channel>:
 284          * sy:updateFrequency
 285          * sy:updatePeriod
 286          * sy:updateBase
 287          * dc:subject
 288          * dc:publisher
 289          * dc:language
 290          * dc:rights
 291          * rss091:language
 292          * rss091:managingEditor
 293          * rss091:webmaster
 294          * rss091:lastBuildDate
 295          * rss091:copyright
 296          */
 297     }
 298
 299
 300
 301
 302     function item_properties ($rev) {
 303         $page = $rev->getPage();
 304         $pagename = $page->getName();
 305
 306         return array( 'title'           => split_pagename($pagename),
 307                       'description'     => $this->summary($rev),
 308                       'link'            => $this->pageURL($rev),
 309                       'dc:date'         => $this->time($rev),
 310                       'dc:contributor'  => $rev->get('author'),
 311                       'wiki:version'    => $rev->getVersion(),
 312                       'wiki:importance' => $this->importance($rev),
 313                       'wiki:status'     => $this->status($rev),
 314                       'wiki:diff'       => $this->diffURL($rev),
 315                       'wiki:history'    => $this->historyURL($rev)
 316                       );
 317     }
 318 }
 319
 320 class NonDeletedRevisionIterator extends WikiDB_PageRevisionIterator
 321 {
 322     /** Constructor
 323      *
 324      * @param $revisions object a WikiDB_PageRevisionIterator.
 325      */
 326     function NonDeletedRevisionIterator ($revisions, $check_current_revision = true) {
 327         $this->_revisions = $revisions;
 328         $this->_check_current_revision = $check_current_revision;
 329     }
 330
 331     function next () {
 332         while (($rev = $this->_revisions->next())) {
 333             if ($this->_check_current_revision) {
 334                 $page = $rev->getPage();
 335                 $check_rev = $page->getCurrentRevision();
 336             }
 337             else {
 338                 $check_rev = $rev;
 339             }
 340             if (! $check_rev->hasDefaultContents())
 341                 return $rev;
 342         }
 343         $this->free();
 344         return false;
 345     }
 346
 347     function free () {
 348         $this->_revisions->free();
 349     }
 350 }
 351
 352 class WikiPlugin_RecentChanges
 353 extends WikiPlugin
 354 {
 355     function getName () {
 356         return _("RecentChanges");
 357     }
 358
 359     function getDefaultArguments() {
 360         return array('days'             => 2,
 361                      'show_minor'       => false,
 362                      'show_major'       => true,
 363                      'show_all'         => false,
 364                      'show_deleted'     => 'sometimes',
 365                      'limit'            => false,
 366                      'format'           => false,
 367                      'daylist'          => false,
 368                      'caption'          => ''
 369                      );
 370     }
 371
 372     function getArgs ($argstr, $request, $defaults = false) {
 373         $args = WikiPlugin::getArgs($argstr, $request, $defaults);
 374
 375         $action = $request->getArg('action');
 376         if ($action != 'browse' && ! $request->isActionPage($action))
 377             $args['format'] = false; // default -> HTML
 378
 379         if ($args['format'] == 'rss' && empty($args['limit']))
 380             $args['limit'] = 15; // Fix default value for RSS.
 381
 382         return $args;
 383     }
 384
 385     function getMostRecentParams ($args) {
 386         extract($args);
 387
 388         $params = array('include_minor_revisions' => $show_minor,
 389                         'exclude_major_revisions' => !$show_major,
 390                         'include_all_revisions' => !empty($show_all));
 391
 392         if ($limit > 0)
 393             $params['limit'] = $limit;
 394
 395         if ($days > 0.0)
 396             $params['since'] = time() - 24 * 3600 * $days;
 397
 398         return $params;
 399     }
 400
 401     function getChanges ($dbi, $args) {
 402         $changes = $dbi->mostRecent($this->getMostRecentParams($args));
 403
 404         $show_deleted = $args['show_deleted'];
 405         if ($show_deleted == 'sometimes')
 406             $show_deleted = $args['show_minor'];
 407
 408         if (!$show_deleted)
 409             $changes = new NonDeletedRevisionIterator($changes, !$args['show_all']);
 410
 411         return $changes;
 412     }
 413
 414     function format ($changes, $args) {
 415         global $Theme;
 416         $format = $args['format'];
 417
 418         $fmt_class = $Theme->getFormatter('RecentChanges', $format);
 419         if (!$fmt_class) {
 420             if ($format == 'rss')
 421                 $fmt_class = '_RecentChanges_RssFormatter';
 422             elseif ($format == 'rss091') {
 423                 include_once "lib/RSSWriter091.php";
 424                 $fmt_class = '_RecentChanges_RssFormatter091';
 425             }
 426             else
 427                 $fmt_class = '_RecentChanges_HtmlFormatter';
 428         }
 429
 430         $fmt = new $fmt_class($args);
 431         return $fmt->format($changes);
 432     }
 433
 434     function run ($dbi, $argstr, $request) {
 435         $args = $this->getArgs($argstr, $request);
 436
 437         if (! $args['daylist']) {
 438             // Display RecentChanges
 439             //
 440             // Hack alert: format() is a NORETURN for rss formatters.
 441             return $this->format($this->getChanges($dbi, $args), $args);
 442         } else {
 443             // Display days selection buttons
 444             extract($args);
 445
 446             $daysarray = explode(",", $daylist);
 447
 448             // Defaults
 449             $url_show_minor = "";
 450             $url_show_all = "";
 451
 452             // RecentEdits args
 453             if (($show_minor == 1)||($show_minor == true))
 454                 $url_show_minor = "&show_minor=1";
 455             if (($show_all == 1)||($show_all == true))
 456                 $url_show_all = "&show_all=1";
 457             // Custom caption
 458             if (! $caption) {
 459                 if ($url_show_minor)
 460                     $caption = _("Show changes for:");
 461                 else {
 462                     if ($url_show_all)
 463                         $caption = _("Show all changes for:");
 464                     else
 465                         $caption = _("Show minor edits for:");
 466                 }
 467             }
 468
 469             $b = new buttonSet();
 470             $b->caption = $caption;
 471
 472             foreach ($daysarray as $daynum) {
 473
 474                 if ($daynum == 1)
 475                     $label = _("1 day");
 476                 elseif ($daynum < 1)
 477                     $label = "..."; //alldays
 478                 else
 479                     $label = sprintf(_("%s days"), $daynum);
 480
 481                 // Build the button's url
 482                 $b->addButton($label, "RecentChanges?days=" .$daynum
 483                                       .$url_show_minor .$url_show_all,
 484                               'wiki-rc-action');
 485             }
 486             return HTML::div(array('class'=>'wiki-rc-action'), $b->getContent());
 487         }
 488     }
 489 };
 490
 491
 492 class buttonSet {
 493     function buttonSet() {
 494         $this->caption = "";
 495         $this->content = "";
 496         $this->_b = array();
 497     }
 498
 499     function addButton($label, $url, $action) {
 500         global $Theme;
 501         $this->_b[] = $Theme->makeButton($label, $url, $action);
 502     }
 503
 504     function getContent() {
 505         if (empty($this->content))
 506             $this->_generateContent();
 507         return $this->content;
 508     }
 509
 510     function _generateContent() {
 511         $this->content = HTML::p($this->caption . " ");
 512         // Avoid an extraneous ButtonSeparator
 513         $this->content->pushContent(array_shift($this->_b));
 514
 515         global $Theme;
 516         foreach ($this->_b as $button) {
 517             $this->content->pushContent($Theme->getButtonSeparator());
 518             $this->content->pushContent($button);
 519         }
 520     }
 521
 522 };
 523
 524
 525 // (c-file-style: "gnu")
 526 // Local Variables:
 527 // mode: php
 528 // tab-width: 8
 529 // c-basic-offset: 4
 530 // c-hanging-comment-ender-p: nil
 531 // indent-tabs-mode: nil
 532 // End:
 533 ?>