lib/plugin/RecentChanges.php

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