2 rcs_id('$Id: RecentChanges.php,v 1.83 2004-02-15 21:34:37 rurban Exp $');
4 Copyright 1999, 2000, 2001, 2002 $ThePhpWikiProgrammingTeam
6 This file is part of PhpWiki.
8 PhpWiki is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 PhpWiki is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with PhpWiki; if not, write to the Free Software
20 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 class _RecentChanges_Formatter
27 var $_absurls = false;
29 function _RecentChanges_Formatter ($rc_args) {
30 $this->_args = $rc_args;
31 $this->_diffargs = array('action' => 'diff');
33 if ($rc_args['show_minor'] || !$rc_args['show_major'])
34 $this->_diffargs['previous'] = 'minor';
36 // PageHistoryPlugin doesn't have a 'daylist' arg.
37 if (!isset($this->_args['daylist']))
38 $this->_args['daylist'] = false;
41 function include_versions_in_URLs() {
42 return (bool) $this->_args['show_all'];
45 function date ($rev) {
47 return $Theme->getDay($rev->get('mtime'));
50 function time ($rev) {
52 return $Theme->formatTime($rev->get('mtime'));
55 function diffURL ($rev) {
56 $args = $this->_diffargs;
57 if ($this->include_versions_in_URLs())
58 $args['version'] = $rev->getVersion();
59 $page = $rev->getPage();
60 return WikiURL($page->getName(), $args, $this->_absurls);
63 function historyURL ($rev) {
64 $page = $rev->getPage();
65 return WikiURL($page, array('action' => _("PageHistory")),
69 function pageURL ($rev) {
70 return WikiURL($this->include_versions_in_URLs() ? $rev : $rev->getPage(),
74 function authorHasPage ($author) {
75 global $WikiNameRegexp, $request;
76 $dbi = $request->getDbh();
77 return isWikiWord($author) && $dbi->isWikiPage($author);
80 function authorURL ($author) {
81 return $this->authorHasPage() ? WikiURL($author) : false;
85 function status ($rev) {
86 if ($rev->hasDefaultContents())
88 $page = $rev->getPage();
89 $prev = $page->getRevisionBefore($rev->getVersion());
90 if ($prev->hasDefaultContents())
95 function importance ($rev) {
96 return $rev->get('is_minor_edit') ? 'minor' : 'major';
99 function summary($rev) {
100 if ( ($summary = $rev->get('summary')) )
103 switch ($this->status($rev)) {
105 return _("Deleted.");
107 return _("New page.");
113 function setValidators($most_recent_rev) {
114 $rev = $most_recent_rev;
115 $validators = array('RecentChanges-top' =>
116 array($rev->getPageName(), $rev->getVersion()),
117 '%mtime' => $rev->get('mtime'));
119 $request->appendValidators($validators);
123 class _RecentChanges_HtmlFormatter
124 extends _RecentChanges_Formatter
126 function diffLink ($rev) {
128 return $Theme->makeButton(_("(diff)"), $this->diffURL($rev), 'wiki-rc-action');
131 function historyLink ($rev) {
133 return $Theme->makeButton(_("(hist)"), $this->historyURL($rev), 'wiki-rc-action');
136 function pageLink ($rev, $link_text=false) {
137 $page = $rev->getPage();
139 if ($this->include_versions_in_URLs()) {
140 $version = $rev->getVersion();
141 $exists = !$rev->hasDefaultContents();
145 $cur = $page->getCurrentRevision();
146 $exists = !$cur->hasDefaultContents();
149 return $Theme->linkExistingWikiWord($page->getName(), $link_text, $version);
151 return $Theme->linkUnknownWikiWord($page->getName(), $link_text);
154 function authorLink ($rev) {
155 $author = $rev->get('author');
156 if ( $this->authorHasPage($author) ) {
157 return WikiLink($author);
162 function summaryAsHTML ($rev) {
163 if ( !($summary = $this->summary($rev)) )
165 return HTML::strong( array('class' => 'wiki-summary'),
167 TransformLinks($summary, $rev->get('markup'), $rev->getPageName()),
171 function rss_icon () {
172 global $request, $Theme;
174 $rss_url = $request->getURLtoSelf(array('format' => 'rss'));
175 return HTML::small(array('style' => 'font-weight:normal;vertical-align:middle;'), $Theme->makeButton("RSS", $rss_url, 'rssicon'));
178 function description () {
179 extract($this->_args);
180 // FIXME: say something about show_all.
181 if ($show_major && $show_minor)
184 $edits = _("major edits");
186 $edits = _("minor edits");
188 if ($timespan = $days > 0) {
189 if (intval($days) != $days)
190 $days = sprintf("%.1f", $days);
194 * Depending how this text is split up it can be tricky or
195 * impossible to translate with good grammar. So the seperate
196 * strings for 1 day and %s days are necessary in this case
197 * for translating to multiple languages, due to differing
198 * overlapping ideal word cutting points.
200 * en: day/days "The %d most recent %s [during (the past] day) are listed below."
201 * de: 1 Tag "Die %d jüngste %s [innerhalb (von des letzten] Tages) sind unten aufgelistet."
202 * de: %s days "Die %d jüngste %s [innerhalb (von] %s Tagen) sind unten aufgelistet."
204 * en: day/days "The %d most recent %s during [the past] (day) are listed below."
205 * fr: 1 jour "Les %d %s les plus récentes pendant [le dernier (d'une] jour) sont énumérées ci-dessous."
206 * fr: %s jours "Les %d %s les plus récentes pendant [les derniers (%s] jours) sont énumérées ci-dessous."
210 if (intval($days) == 1)
211 $desc = fmt("The %d most recent %s during the past day are listed below.",
214 $desc = fmt("The %d most recent %s during the past %s days are listed below.",
215 $limit, $edits, $days);
217 $desc = fmt("The %d most recent %s are listed below.",
220 elseif ($limit < 0) { //$limit < 0 means we want oldest pages
222 if (intval($days) == 1)
223 $desc = fmt("The %d oldest %s during the past day are listed below.",
226 $desc = fmt("The %d oldest %s during the past %s days are listed below.",
227 $lmt, $edits, $days);
229 $desc = fmt("The %d oldest %s are listed below.",
235 if (intval($days) == 1)
236 $desc = fmt("The most recent %s during the past day are listed below.",
239 $desc = fmt("The most recent %s during the past %s days are listed below.",
242 $desc = fmt("All %s are listed below.", $edits);
244 return HTML::p(false, $desc);
249 extract($this->_args);
250 return array($show_minor ? _("RecentEdits") : _("RecentChanges"),
253 $this->sidebar_link());
256 function empty_message () {
257 return _("No changes found");
261 function sidebar_link() {
262 extract($this->_args);
263 $pagetitle = $show_minor ? _("RecentEdits") : _("RecentChanges");
266 $sidebarurl = WikiURL($pagetitle, array('format' => 'sidebar'), 'absurl');
269 "function addPanel() {\n"
270 ." window.sidebar.addPanel (\"" . sprintf("%s - %s", WIKI_NAME, $pagetitle) . "\",\n"
271 ." \"$sidebarurl\",\"\");\n"
273 $jsf = JavaScript($addsidebarjsfunc);
276 $sidebar_button = $Theme->makeButton("sidebar", 'javascript:addPanel();', 'sidebaricon');
277 $addsidebarjsclick = asXML(HTML::small(array('style' => 'font-weight:normal;vertical-align:middle;'), $sidebar_button));
278 $jsc = JavaScript("if ((typeof window.sidebar == 'object') &&\n"
279 ." (typeof window.sidebar.addPanel == 'function'))\n"
281 ." document.write('$addsidebarjsclick');\n"
284 return HTML(new RawXML("\n"), $jsf, new RawXML("\n"), $jsc);
287 function format ($changes) {
288 include_once('lib/InlineParser.php');
290 $html = HTML(HTML::h2(false, $this->title()));
291 if (($desc = $this->description()))
292 $html->pushContent($desc);
294 if ($this->_args['daylist'])
295 $html->pushContent(new DayButtonBar($this->_args));
301 while ($rev = $changes->next()) {
302 if (($date = $this->date($rev)) != $last_date) {
304 $html->pushContent($lines);
305 $html->pushContent(HTML::h3($date));
310 $lines->pushContent($this->format_revision($rev));
313 $this->setValidators($rev);
317 $html->pushContent($lines);
319 $html->pushContent(HTML::p(array('class' => 'rc-empty'),
320 $this->empty_message()));
325 function format_revision ($rev) {
326 $args = &$this->_args;
328 $class = 'rc-' . $this->importance($rev);
330 $time = $this->time($rev);
331 if (! $rev->get('is_minor_edit'))
332 $time = HTML::strong(array('class' => 'pageinfo-majoredit'), $time);
334 $line = HTML::li(array('class' => $class));
337 if ($args['difflinks'])
338 $line->pushContent($this->diffLink($rev), ' ');
340 if ($args['historylinks'])
341 $line->pushContent($this->historyLink($rev), ' ');
343 $line->pushContent($this->pageLink($rev), ' ',
345 $this->summaryAsHTML($rev),
347 $this->authorLink($rev));
353 class _RecentChanges_SideBarFormatter
354 extends _RecentChanges_HtmlFormatter
356 function rss_icon () {
360 //title click opens the normal RC or RE page in the main browser frame
361 extract($this->_args);
362 $titlelink = WikiLink($show_minor ? _("RecentEdits") : _("RecentChanges"));
363 $titlelink->setAttr('target', '_content');
364 return HTML($this->logo(), $titlelink);
367 //logo click opens the HomePage in the main browser frame
369 $img = HTML::img(array('src' => $Theme->getImageURL('logo'),
372 'style' => 'height:2.5ex'
374 $linkurl = WikiLink(HOME_PAGE, false, $img);
375 $linkurl->setAttr('target', '_content');
379 function authorLink ($rev) {
380 $author = $rev->get('author');
381 if ( $this->authorHasPage($author) ) {
382 $linkurl = WikiLink($author);
383 $linkurl->setAttr('target', '_content'); // way to do this using parent::authorLink ??
389 function diffLink ($rev) {
390 $linkurl = parent::diffLink($rev);
391 $linkurl->setAttr('target', '_content');
392 // FIXME: Smelly hack to get smaller diff buttons in sidebar
393 $linkurl = new RawXML(str_replace('<img ', '<img style="height:2ex" ', asXML($linkurl)));
396 function historyLink ($rev) {
397 $linkurl = parent::historyLink($rev);
398 $linkurl->setAttr('target', '_content');
399 // FIXME: Smelly hack to get smaller history buttons in sidebar
400 $linkurl = new RawXML(str_replace('<img ', '<img style="height:2ex" ', asXML($linkurl)));
403 function pageLink ($rev) {
404 $linkurl = parent::pageLink($rev);
405 $linkurl->setAttr('target', '_content');
408 // Overriding summaryAsHTML, because there is no way yet to
409 // return summary as transformed text with
410 // links setAttr('target', '_content') in Mozilla sidebar.
411 // So for now don't create clickable links inside summary
412 // in the sidebar, or else they target the sidebar and not the
413 // main content window.
414 function summaryAsHTML ($rev) {
415 if ( !($summary = $this->summary($rev)) )
417 return HTML::strong(array('class' => 'wiki-summary'),
419 /*TransformLinks(*/$summary,/* $rev->get('markup')),*/
424 function format ($changes) {
425 $this->_args['daylist'] = false; //don't show day buttons in Mozilla sidebar
426 $html = _RecentChanges_HtmlFormatter::format ($changes);
427 $html = HTML::div(array('class' => 'wikitext'), $html);
429 $request->discardOutput();
431 printf("<?xml version=\"1.0\" encoding=\"%s\"?>\n", CHARSET);
432 printf('<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"');
433 printf(' "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">');
434 printf('<html xmlns="http://www.w3.org/1999/xhtml">');
437 extract($this->_args);
438 $title = WIKI_NAME . $show_minor ? _("RecentEdits") : _("RecentChanges");
439 printf("<title>" . $title . "</title>\n");
441 $css = $Theme->getCSS();
445 printf("<body class=\"sidebar\">\n");
447 printf("\n</body>\n");
450 $request->finish(); // cut rest of page processing short
455 class _RecentChanges_RssFormatter
456 extends _RecentChanges_Formatter
458 var $_absurls = true;
460 function time ($rev) {
461 return Iso8601DateTime($rev->get('mtime'));
464 function pageURI ($rev) {
465 return WikiURL($rev, '', 'absurl');
468 function format ($changes) {
470 include_once('lib/RssWriter.php');
471 $rss = new RssWriter;
474 $rss->channel($this->channel_properties());
476 if (($props = $this->image_properties()))
478 if (($props = $this->textinput_properties()))
479 $rss->textinput($props);
482 while ($rev = $changes->next()) {
483 $rss->addItem($this->item_properties($rev),
484 $this->pageURI($rev));
486 $this->setValidators($rev);
491 $request->discardOutput();
493 printf("\n<!-- Generated by PhpWiki:\n%s-->\n", $GLOBALS['RCS_IDS']);
495 // Flush errors in comment, otherwise it's invalid XML.
496 global $ErrorManager;
497 if (($errors = $ErrorManager->getPostponedErrorsAsHTML()))
498 printf("\n<!-- PHP Warnings:\n%s-->\n", AsXML($errors));
500 $request->finish(); // NORETURN!!!!
503 function image_properties () {
506 $img_url = AbsoluteURL($Theme->getImageURL('logo'));
510 return array('title' => WIKI_NAME,
511 'link' => WikiURL(HOME_PAGE, false, 'absurl'),
515 function textinput_properties () {
516 return array('title' => _("Search"),
517 'description' => _("Title Search"),
519 'link' => WikiURL(_("TitleSearch"), false, 'absurl'));
522 function channel_properties () {
525 $rc_url = WikiURL($request->getArg('pagename'), false, 'absurl');
527 return array('title' => WIKI_NAME,
529 'description' => _("RecentChanges"),
530 'dc:date' => Iso8601DateTime(time()));
532 /* FIXME: other things one might like in <channel>:
541 * rss091:managingEditor
543 * rss091:lastBuildDate
551 function item_properties ($rev) {
552 $page = $rev->getPage();
553 $pagename = $page->getName();
555 return array( 'title' => split_pagename($pagename),
556 'description' => $this->summary($rev),
557 'link' => $this->pageURL($rev),
558 'dc:date' => $this->time($rev),
559 'dc:contributor' => $rev->get('author'),
560 'wiki:version' => $rev->getVersion(),
561 'wiki:importance' => $this->importance($rev),
562 'wiki:status' => $this->status($rev),
563 'wiki:diff' => $this->diffURL($rev),
564 'wiki:history' => $this->historyURL($rev)
569 class NonDeletedRevisionIterator extends WikiDB_PageRevisionIterator
573 * @param $revisions object a WikiDB_PageRevisionIterator.
575 function NonDeletedRevisionIterator ($revisions, $check_current_revision = true) {
576 $this->_revisions = $revisions;
577 $this->_check_current_revision = $check_current_revision;
581 while (($rev = $this->_revisions->next())) {
582 if ($this->_check_current_revision) {
583 $page = $rev->getPage();
584 $check_rev = $page->getCurrentRevision();
589 if (! $check_rev->hasDefaultContents())
597 $this->_revisions->free();
601 class WikiPlugin_RecentChanges
604 function getName () {
605 return _("RecentChanges");
608 function getVersion() {
609 return preg_replace("/[Revision: $]/", '',
610 "\$Revision: 1.83 $");
613 function managesValidators() {
614 // Note that this is a bit of a fig.
615 // We set validators based on the most recently changed page,
616 // but this fails when the most-recent page is deleted.
617 // (Consider that the Last-Modified time will decrease
618 // when this happens.)
620 // We might be better off, leaving this as false (and junking
621 // the validator logic above) and just falling back to the
622 // default behavior (handled by WikiPlugin) of just using
623 // the WikiDB global timestamp as the mtime.
625 // Nevertheless, for now, I leave this here, mostly as an
626 // example for how to use appendValidators() and managesValidators().
631 function getDefaultArguments() {
632 return array('days' => 2,
633 'show_minor' => false,
634 'show_major' => true,
636 'show_deleted' => 'sometimes',
641 'historylinks' => false,
646 function getArgs ($argstr, $request, $defaults = false) {
647 $args = WikiPlugin::getArgs($argstr, $request, $defaults);
649 $action = $request->getArg('action');
650 if ($action != 'browse' && ! $request->isActionPage($action))
651 $args['format'] = false; // default -> HTML
653 if ($args['format'] == 'rss' && empty($args['limit']))
654 $args['limit'] = 15; // Fix default value for RSS.
656 if ($args['format'] == 'sidebar' && empty($args['limit']))
657 $args['limit'] = 10; // Fix default value for sidebar.
662 function getMostRecentParams ($args) {
665 $params = array('include_minor_revisions' => $show_minor,
666 'exclude_major_revisions' => !$show_major,
667 'include_all_revisions' => !empty($show_all));
670 $params['limit'] = $limit;
673 $params['since'] = time() - 24 * 3600 * $days;
675 $params['since'] = 24 * 3600 * $days - time();
681 function getChanges ($dbi, $args) {
682 $show_deleted = $args['show_deleted'];
683 if ($show_deleted == 'sometimes')
684 $show_deleted = $args['show_minor'];
687 $changes = new NonDeletedRevisionIterator($changes, !$args['show_all']);
689 $changes = $dbi->mostRecent($this->getMostRecentParams($args));
694 function format ($changes, $args) {
696 $format = $args['format'];
698 $fmt_class = $Theme->getFormatter('RecentChanges', $format);
700 if ($format == 'rss')
701 $fmt_class = '_RecentChanges_RssFormatter';
702 elseif ($format == 'rss091') {
703 include_once "lib/RSSWriter091.php";
704 $fmt_class = '_RecentChanges_RssFormatter091';
706 elseif ($format == 'sidebar')
707 $fmt_class = '_RecentChanges_SideBarFormatter';
709 $fmt_class = '_RecentChanges_HtmlFormatter';
712 $fmt = new $fmt_class($args);
713 return $fmt->format($changes);
716 function run ($dbi, $argstr, $request) {
717 $args = $this->getArgs($argstr, $request);
719 // HACKish: fix for SF bug #622784 (1000 years of RecentChanges ought
720 // to be enough for anyone.)
721 $args['days'] = min($args['days'], 365000);
723 // Hack alert: format() is a NORETURN for rss formatters.
724 return $this->format($this->getChanges($dbi, $args), $args);
729 class DayButtonBar extends HtmlElement {
731 function DayButtonBar ($plugin_args) {
732 $this->HtmlElement('p', array('class' => 'wiki-rc-action'));
734 // Display days selection buttons
735 extract($plugin_args);
740 $caption = _("Show minor edits for:");
742 $caption = _("Show all changes for:");
744 $caption = _("Show changes for:");
747 $this->pushContent($caption, ' ');
750 $sep = $Theme->getButtonSeparator();
753 foreach (explode(",", $daylist) as $days) {
755 $this->pushContent($sep);
756 $this->pushContent($this->_makeDayButton($days));
760 function _makeDayButton ($days) {
761 global $Theme, $request;
766 $label = "..."; //alldays
768 $label = sprintf(_("%s days"), abs($days));
770 $url = $request->getURLtoSelf(array('action' => 'browse', 'days' => $days));
772 return $Theme->makeButton($label, $url, 'wiki-rc-action');
776 // $Log: not supported by cvs2svn $
777 // Revision 1.82 2004/01/25 03:58:43 rurban
778 // use stdlib:isWikiWord()
780 // Revision 1.81 2003/11/28 21:06:31 carstenklapp
781 // Enhancement: Mozilla RecentChanges sidebar now defaults to 10 changes
782 // instead of 1. Make diff buttons smaller with css. Added description
783 // line back in at the top.
785 // Revision 1.80 2003/11/27 15:17:01 carstenklapp
786 // Theme & appearance tweaks: Converted Mozilla sidebar link into a Theme
787 // button, to allow an image button for it to be added to Themes. Output
788 // RSS button in small text size when theme has no button image.
790 // Revision 1.79 2003/04/29 14:34:20 dairiki
791 // Bug fix: "add sidebar" link didn't work when USE_PATH_INFO was false.
793 // Revision 1.78 2003/03/04 01:55:05 dairiki
794 // Fix to ensure absolute URL for logo in RSS recent changes.
796 // Revision 1.77 2003/02/27 23:23:38 dairiki
797 // Fix my breakage of CSS and sidebar RecentChanges output.
799 // Revision 1.76 2003/02/27 22:48:44 dairiki
800 // Fixes invalid HTML generated by PageHistory plugin.
802 // (<noscript> is block-level and not allowed within <p>.)
804 // Revision 1.75 2003/02/22 21:39:05 dairiki
805 // Hackish fix for SF bug #622784.
807 // (The root of the problem is clearly a PHP bug.)
809 // Revision 1.74 2003/02/21 22:52:21 dairiki
810 // Make sure to interpret relative links (like [/Subpage]) in summary
811 // relative to correct basepage.
813 // Revision 1.73 2003/02/21 04:12:06 dairiki
814 // Minor fixes for new cached markup.
816 // Revision 1.72 2003/02/17 02:19:01 dairiki
817 // Fix so that PageHistory will work when the current revision
818 // of a page has been "deleted".
820 // Revision 1.71 2003/02/16 20:04:48 dairiki
821 // Refactor the HTTP validator generation/checking code.
823 // This also fixes a number of bugs with yesterdays validator mods.
825 // Revision 1.70 2003/02/16 05:09:43 dairiki
826 // Starting to fix handling of the HTTP validator headers, Last-Modified,
829 // Last-Modified was being set incorrectly (but only when DEBUG was not
830 // defined!) Setting a Last-Modified without setting an appropriate
831 // Expires: and/or Cache-Control: header results in browsers caching
832 // the page unconditionally (for a certain period of time).
833 // This is generally bad, since it means people don't see updated
834 // page contents right away --- this is particularly confusing to
835 // the people who are editing pages since their edits don't show up
836 // next time they browse the page.
838 // Now, we don't allow caching of pages without revalidation
839 // (via the If-Modified-Since and/or If-None-Match request headers.)
840 // (You can allow caching by defining CACHE_CONTROL_MAX_AGE to an
841 // appropriate value in index.php, but I advise against it.)
845 // o Even when request is aborted due to the content not being
846 // modified, we currently still do almost all the work involved
847 // in producing the page. So the only real savings from all
848 // this logic is in network bandwidth.
850 // o Plugins which produce "dynamic" output need to be inspected
851 // and made to call $request->addToETag() and
852 // $request->setModificationTime() appropriately, otherwise the
853 // page can change without the change being detected.
854 // This leads to stale pages in cache again...
856 // Revision 1.69 2003/01/18 22:01:43 carstenklapp
858 // Reformatting & tabs to spaces;
859 // Added copyleft, getVersion, getDescription, rcs_id.
862 // (c-file-style: "gnu")
867 // c-hanging-comment-ender-p: nil
868 // indent-tabs-mode: nil