5 * Split off from Article.php and Skin.php, 2003-12-22
10 * This class handles printing the history page for an article. In order to
11 * be efficient, it uses timestamps rather than offsets for paging, to avoid
12 * costly LIMIT,offset queries.
14 * Construct it by passing in an Article, and call $h->history() to print the
22 var $article, $title, $skin;
25 * Construct a new HistoryPage.
27 * @param Article $article
30 function __construct( $article ) {
32 $this->article
= $article;
33 $this->title
= $article->getTitle();
34 $this->skin
= $wgUser->getSkin();
35 $this->preCacheMessages();
38 function getArticle() {
39 return $this->article
;
47 * As we use the same small set of messages in various methods and that
48 * they are called often, we call them once and save them in $this->message
50 function preCacheMessages() {
51 // Precache various messages
52 if( !isset( $this->message
) ) {
53 foreach( explode(' ', 'cur last rev-delundel' ) as $msg ) {
54 $this->message
[$msg] = wfMsgExt( $msg, array( 'escape') );
60 * Print the history page for an article.
65 global $wgOut, $wgRequest, $wgScript;
68 * Allow client caching.
70 if( $wgOut->checkLastModified( $this->article
->getTouched() ) )
71 return; // Client cache fresh and headers sent, nothing more to do.
73 wfProfileIn( __METHOD__
);
76 * Setup page variables.
78 $wgOut->setPageTitle( wfMsg( 'history-title', $this->title
->getPrefixedText() ) );
79 $wgOut->setPageTitleActionText( wfMsg( 'history_short' ) );
80 $wgOut->setArticleFlag( false );
81 $wgOut->setArticleRelated( true );
82 $wgOut->setRobotPolicy( 'noindex,nofollow' );
83 $wgOut->setSyndicated( true );
84 $wgOut->setFeedAppendQuery( 'action=history' );
85 $wgOut->addScriptFile( 'history.js' );
87 $logPage = SpecialPage
::getTitleFor( 'Log' );
88 $logLink = $this->skin
->link(
90 wfMsgHtml( 'viewpagelogs' ),
92 array( 'page' => $this->title
->getPrefixedText() ),
93 array( 'known', 'noclasses' )
95 $wgOut->setSubtitle( $logLink );
97 $feedType = $wgRequest->getVal( 'feed' );
99 wfProfileOut( __METHOD__
);
100 return $this->feed( $feedType );
104 * Fail if article doesn't exist.
106 if( !$this->title
->exists() ) {
107 $wgOut->addWikiMsg( 'nohistory' );
108 wfProfileOut( __METHOD__
);
113 * Add date selector to quickly get to a certain time
115 $year = $wgRequest->getInt( 'year' );
116 $month = $wgRequest->getInt( 'month' );
117 $tagFilter = $wgRequest->getVal( 'tagfilter' );
118 $tagSelector = ChangeTags
::buildTagFilterSelector( $tagFilter );
120 $action = htmlspecialchars( $wgScript );
122 "<form action=\"$action\" method=\"get\" id=\"mw-history-searchform\">" .
123 Xml
::fieldset( wfMsg( 'history-fieldset-title' ), false, array( 'id' => 'mw-history-search' ) ) .
124 Xml
::hidden( 'title', $this->title
->getPrefixedDBKey() ) . "\n" .
125 Xml
::hidden( 'action', 'history' ) . "\n" .
126 xml
::dateMenu( $year, $month ) . ' ' .
127 ( $tagSelector ?
( implode( ' ', $tagSelector ) . ' ' ) : '' ) .
128 Xml
::submitButton( wfMsg( 'allpagessubmit' ) ) . "\n" .
132 wfRunHooks( 'PageHistoryBeforeList', array( &$this->article
) );
137 $pager = new HistoryPager( $this, $year, $month, $tagFilter );
139 $pager->getNavigationBar() .
141 $pager->getNavigationBar()
144 wfProfileOut( __METHOD__
);
148 * Fetch an array of revisions, specified by a given limit, offset and
149 * direction. This is now only used by the feeds. It was previously
150 * used by the main UI but that's now handled by the pager.
152 function fetchRevisions($limit, $offset, $direction) {
153 $dbr = wfGetDB( DB_SLAVE
);
155 if( $direction == HistoryPage
::DIR_PREV
)
156 list($dirs, $oper) = array("ASC", ">=");
157 else /* $direction == HistoryPage::DIR_NEXT */
158 list($dirs, $oper) = array("DESC", "<=");
161 $offsets = array("rev_timestamp $oper '$offset'");
165 $page_id = $this->title
->getArticleID();
167 return $dbr->select( 'revision',
168 Revision
::selectFields(),
169 array_merge(array("rev_page=$page_id"), $offsets),
171 array( 'ORDER BY' => "rev_timestamp $dirs",
172 'USE INDEX' => 'page_timestamp', 'LIMIT' => $limit)
177 * Output a subscription feed listing recent edits to this page.
178 * @param string $type
180 function feed( $type ) {
181 global $wgFeedClasses, $wgRequest, $wgFeedLimit;
182 if( !FeedUtils
::checkFeedOutput($type) ) {
186 $feed = new $wgFeedClasses[$type](
187 $this->title
->getPrefixedText() . ' - ' .
188 wfMsgForContent( 'history-feed-title' ),
189 wfMsgForContent( 'history-feed-description' ),
190 $this->title
->getFullUrl( 'action=history' ) );
192 // Get a limit on number of feed entries. Provide a sane default
193 // of 10 if none is defined (but limit to $wgFeedLimit max)
194 $limit = $wgRequest->getInt( 'limit', 10 );
195 if( $limit > $wgFeedLimit ||
$limit < 1 ) {
198 $items = $this->fetchRevisions($limit, 0, HistoryPage
::DIR_NEXT
);
202 foreach( $items as $row ) {
203 $feed->outItem( $this->feedItem( $row ) );
206 $feed->outItem( $this->feedEmpty() );
211 function feedEmpty() {
214 wfMsgForContent( 'nohistory' ),
215 $wgOut->parse( wfMsgForContent( 'history-feed-empty' ) ),
216 $this->title
->getFullUrl(),
217 wfTimestamp( TS_MW
),
219 $this->title
->getTalkPage()->getFullUrl() );
223 * Generate a FeedItem object from a given revision table row
224 * Borrows Recent Changes' feed generation functions for formatting;
225 * includes a diff to the previous revision (if any).
230 function feedItem( $row ) {
231 $rev = new Revision( $row );
232 $rev->setTitle( $this->title
);
233 $text = FeedUtils
::formatDiffRow( $this->title
,
234 $this->title
->getPreviousRevisionID( $rev->getId() ),
236 $rev->getTimestamp(),
237 $rev->getComment() );
239 if( $rev->getComment() == '' ) {
241 $title = wfMsgForContent( 'history-feed-item-nocomment',
243 $wgContLang->timeanddate( $rev->getTimestamp() ) );
245 $title = $rev->getUserText() . wfMsgForContent( 'colon-separator' ) . FeedItem
::stripComment( $rev->getComment() );
251 $this->title
->getFullUrl( 'diff=' . $rev->getId() . '&oldid=prev' ),
252 $rev->getTimestamp(),
254 $this->title
->getTalkPage()->getFullUrl() );
262 class HistoryPager
extends ReverseChronologicalPager
{
263 public $lastRow = false, $counter, $historyPage, $title, $buttons;
264 protected $oldIdChecked;
266 function __construct( $historyPage, $year='', $month='', $tagFilter = '' ) {
267 parent
::__construct();
268 $this->historyPage
= $historyPage;
269 $this->title
= $this->historyPage
->title
;
270 $this->tagFilter
= $tagFilter;
271 $this->getDateCond( $year, $month );
274 // For hook compatibility...
275 function getArticle() {
276 return $this->historyPage
->getArticle();
279 function getQueryInfo() {
281 'tables' => array('revision'),
282 'fields' => array_merge( Revision
::selectFields(), array('ts_tags') ),
283 'conds' => array('rev_page' => $this->historyPage
->title
->getArticleID() ),
284 'options' => array( 'USE INDEX' => array('revision' => 'page_timestamp') ),
285 'join_conds' => array( 'tag_summary' => array( 'LEFT JOIN', 'ts_rev_id=rev_id' ) ),
287 ChangeTags
::modifyDisplayQuery( $queryInfo['tables'],
288 $queryInfo['fields'],
290 $queryInfo['join_conds'],
291 $queryInfo['options'],
293 wfRunHooks( 'PageHistoryPager::getQueryInfo', array( &$this, &$queryInfo ) );
297 function getIndexField() {
298 return 'rev_timestamp';
301 function formatRow( $row ) {
302 if( $this->lastRow
) {
303 $latest = $this->counter
== 1 && $this->mIsFirst
;
304 $firstInList = $this->counter
== 1;
305 $s = $this->historyLine( $this->lastRow
, $row, $this->counter++
,
306 $this->title
->getNotificationTimestamp(), $latest, $firstInList );
310 $this->lastRow
= $row;
315 * Creates begin of history list with a submit button
317 * @return string HTML output
319 function getStartBody() {
320 global $wgScript, $wgEnableHtmlDiff, $wgUser, $wgOut;
321 $this->lastRow
= false;
323 $this->oldIdChecked
= 0;
325 $wgOut->wrapWikiMsg( "<div class='mw-history-legend'>\n$1</div>", 'histlegend' );
326 $s = Xml
::openElement( 'form', array( 'action' => $wgScript,
327 'id' => 'mw-history-compare' ) ) . "\n";
328 $s .= Xml
::hidden( 'title', $this->title
->getPrefixedDbKey() ) . "\n";
330 $this->buttons
= '<div>';
331 if( $wgUser->isAllowed('deleterevision') ) {
332 $this->buttons
.= Xml
::element( 'button',
336 'value' => 'revisiondelete',
337 'style' => 'float: right',
339 wfMsg( 'showhideselectedversions' )
342 if( $wgEnableHtmlDiff ) {
343 $this->buttons
.= Xml
::element( 'button',
346 'name' => 'htmldiff',
348 'class' => 'historysubmit',
349 'accesskey' => wfMsg( 'accesskey-visualcomparison' ),
350 'title' => wfMsg( 'tooltip-compareselectedversions' ),
352 wfMsg( 'visualcomparison')
354 $this->buttons
.= $this->submitButton( wfMsg( 'wikicodecomparison'),
356 'class' => 'historysubmit',
357 'accesskey' => wfMsg( 'accesskey-compareselectedversions' ),
358 'title' => wfMsg( 'tooltip-compareselectedversions' ),
362 $this->buttons
.= $this->submitButton( wfMsg( 'compareselectedversions'),
364 'class' => 'historysubmit',
365 'accesskey' => wfMsg( 'accesskey-compareselectedversions' ),
366 'title' => wfMsg( 'tooltip-compareselectedversions' ),
370 $this->buttons
.= '</div>';
371 $s .= $this->buttons
. '<ul id="pagehistory">' . "\n";
375 function getEndBody() {
376 if( $this->lastRow
) {
377 $latest = $this->counter
== 1 && $this->mIsFirst
;
378 $firstInList = $this->counter
== 1;
379 if( $this->mIsBackwards
) {
380 # Next row is unknown, but for UI reasons, probably exists if an offset has been specified
381 if( $this->mOffset
== '' ) {
387 # The next row is the past-the-end row
388 $next = $this->mPastTheEndRow
;
390 $s = $this->historyLine( $this->lastRow
, $next, $this->counter++
,
391 $this->title
->getNotificationTimestamp(), $latest, $firstInList );
396 $s .= $this->buttons
;
402 * Creates a submit button
404 * @param array $attributes attributes
405 * @return string HTML output for the submit button
407 function submitButton($message, $attributes = array() ) {
408 # Disable submit button if history has 1 revision only
409 if( $this->getNumRows() > 1 ) {
410 return Xml
::submitButton( $message , $attributes );
417 * Returns a row from the history printout.
419 * @todo document some more, and maybe clean up the code (some params redundant?)
421 * @param Row $row The database row corresponding to the previous line.
422 * @param mixed $next The database row corresponding to the next line.
423 * @param int $counter Apparently a counter of what row number we're at, counted from the top row = 1.
424 * @param $notificationtimestamp
425 * @param bool $latest Whether this row corresponds to the page's latest revision.
426 * @param bool $firstInList Whether this row corresponds to the first displayed on this history page.
427 * @return string HTML output for the row
429 function historyLine( $row, $next, $counter = '', $notificationtimestamp = false,
430 $latest = false, $firstInList = false )
432 global $wgUser, $wgLang;
433 $rev = new Revision( $row );
434 $rev->setTitle( $this->title
);
436 $curlink = $this->curLink( $rev, $latest );
437 $lastlink = $this->lastLink( $rev, $next, $counter );
438 $diffButtons = $this->diffButtons( $rev, $firstInList, $counter );
439 $link = $this->revLink( $rev );
442 $s = "($curlink) ($lastlink) $diffButtons";
444 if( $wgUser->isAllowed( 'deleterevision' ) ) {
445 // If revision was hidden from sysops
446 if( !$rev->userCan( Revision
::DELETED_RESTRICTED
) ) {
447 $del = Xml
::check( 'deleterevisions', false, array('disabled' => 'disabled') );
448 $del .= Xml
::tags( 'span', array( 'class'=>'mw-revdelundel-link' ),
449 '(' . $this->historyPage
->message
['rev-delundel'] . ')' );
450 // Otherwise, show the link...
453 $del = Xml
::check( 'showhiderevisions', false, array( 'name' => "ids[$id]" ) );
455 'type' => 'revision',
456 'target' => $this->title
->getPrefixedDbkey(),
458 $del .= $this->getSkin()->revDeleteLink( $query,
459 $rev->isDeleted( Revision
::DELETED_RESTRICTED
) );
465 $s .= " <span class='history-user'>" . $this->getSkin()->revUserTools( $rev, true ) . "</span>";
467 if( $rev->isMinor() ) {
468 $s .= ' ' . ChangesList
::flag( 'minor' );
471 if( !is_null( $size = $rev->getSize() ) && !$rev->isDeleted( Revision
::DELETED_TEXT
) ) {
472 $s .= ' ' . $this->getSkin()->formatRevisionSize( $size );
475 $s .= $this->getSkin()->revComment( $rev, false, true );
477 if( $notificationtimestamp && ($row->rev_timestamp
>= $notificationtimestamp) ) {
478 $s .= ' <span class="updatedmarker">' . wfMsgHtml( 'updatedmarker' ) . '</span>';
483 if( !is_null( $next ) && is_object( $next ) ) {
484 if( $latest && $this->title
->userCan( 'rollback' ) && $this->title
->userCan( 'edit' ) ) {
485 $tools[] = '<span class="mw-rollback-link">'.
486 $this->getSkin()->buildRollbackLink( $rev ).'</span>';
489 if( $this->title
->quickUserCan( 'edit' )
490 && !$rev->isDeleted( Revision
::DELETED_TEXT
)
491 && !$next->rev_deleted
& Revision
::DELETED_TEXT
)
493 # Create undo tooltip for the first (=latest) line only
494 $undoTooltip = $latest
495 ?
array( 'title' => wfMsg( 'tooltip-undo' ) )
497 $undolink = $this->getSkin()->link(
499 wfMsgHtml( 'editundo' ),
501 array( 'action' => 'edit', 'undoafter' => $next->rev_id
, 'undo' => $rev->getId() ),
502 array( 'known', 'noclasses' )
504 $tools[] = "<span class=\"mw-history-undo\">{$undolink}</span>";
509 $s .= ' (' . $wgLang->pipeList( $tools ) . ')';
513 list($tagSummary, $newClasses) = ChangeTags
::formatSummaryRow( $row->ts_tags
, 'history' );
514 $classes = array_merge( $classes, $newClasses );
515 $s .= " $tagSummary";
517 wfRunHooks( 'PageHistoryLineEnding', array( $this, &$row , &$s ) );
521 $attribs['class'] = implode( ' ', $classes );
524 return Xml
::tags( 'li', $attribs, $s ) . "\n";
528 * Create a link to view this revision of the page
529 * @param Revision $rev
532 function revLink( $rev ) {
534 $date = $wgLang->timeanddate( wfTimestamp(TS_MW
, $rev->getTimestamp()), true );
535 $date = htmlspecialchars( $date );
536 if( !$rev->isDeleted( Revision
::DELETED_TEXT
) ) {
537 $link = $this->getSkin()->link(
541 array( 'oldid' => $rev->getId() ),
542 array( 'known', 'noclasses' )
545 $link = "<span class=\"history-deleted\">$date</span>";
551 * Create a diff-to-current link for this revision for this page
552 * @param Revision $rev
553 * @param Bool $latest, this is the latest revision of the page?
556 function curLink( $rev, $latest ) {
557 $cur = $this->historyPage
->message
['cur'];
558 if( $latest ||
!$rev->userCan( Revision
::DELETED_TEXT
) ) {
561 return $this->getSkin()->link(
566 'diff' => $this->title
->getLatestRevID(),
567 'oldid' => $rev->getId()
569 array( 'known', 'noclasses' )
575 * Create a diff-to-previous link for this revision for this page.
576 * @param Revision $prevRev, the previous revision
577 * @param mixed $next, the newer revision
578 * @param int $counter, what row on the history list this is
581 function lastLink( $prevRev, $next, $counter ) {
582 $last = $this->historyPage
->message
['last'];
583 # $next may either be a Row, null, or "unkown"
584 $nextRev = is_object($next) ?
new Revision( $next ) : $next;
585 if( is_null($next) ) {
586 # Probably no next row
588 } elseif( $next === 'unknown' ) {
589 # Next row probably exists but is unknown, use an oldid=prev link
590 return $this->getSkin()->link(
595 'diff' => $prevRev->getId(),
598 array( 'known', 'noclasses' )
600 } elseif( !$prevRev->userCan(Revision
::DELETED_TEXT
) ||
!$nextRev->userCan(Revision
::DELETED_TEXT
) ) {
603 return $this->getSkin()->link(
608 'diff' => $prevRev->getId(),
609 'oldid' => $next->rev_id
611 array( 'known', 'noclasses' )
617 * Create radio buttons for page history
619 * @param object $rev Revision
620 * @param bool $firstInList Is this version the first one?
621 * @param int $counter A counter of what row number we're at, counted from the top row = 1.
622 * @return string HTML output for the radio buttons
624 function diffButtons( $rev, $firstInList, $counter ) {
625 if( $this->getNumRows() > 1 ) {
627 $radio = array( 'type' => 'radio', 'value' => $id );
628 /** @todo: move title texts to javascript */
630 $first = Xml
::element( 'input',
631 array_merge( $radio, array(
632 'style' => 'visibility:hidden',
634 'id' => 'mw-oldid-null' ) )
636 $checkmark = array( 'checked' => 'checked' );
638 # Check visibility of old revisions
639 if( !$rev->userCan( Revision
::DELETED_TEXT
) ) {
640 $radio['disabled'] = 'disabled';
641 $checkmark = array(); // We will check the next possible one
642 } else if( $counter == 2 ||
!$this->oldIdChecked
) {
643 $checkmark = array( 'checked' => 'checked' );
644 $this->oldIdChecked
= $id;
646 $checkmark = array();
648 $first = Xml
::element( 'input',
649 array_merge( $radio, $checkmark, array(
651 'id' => "mw-oldid-$id" ) ) );
652 $checkmark = array();
654 $second = Xml
::element( 'input',
655 array_merge( $radio, $checkmark, array(
657 'id' => "mw-diff-$id" ) ) );
658 return $first . $second;
666 * Backwards-compatibility aliases
668 class PageHistory
extends HistoryPage
{}
669 class PageHistoryPager
extends HistoryPager
{}