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;
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 function getQueryInfo() {
276 'tables' => array('revision'),
277 'fields' => array_merge( Revision
::selectFields(), array('ts_tags') ),
278 'conds' => array('rev_page' => $this->historyPage
->title
->getArticleID() ),
279 'options' => array( 'USE INDEX' => array('revision' => 'page_timestamp') ),
280 'join_conds' => array( 'tag_summary' => array( 'LEFT JOIN', 'ts_rev_id=rev_id' ) ),
282 ChangeTags
::modifyDisplayQuery( $queryInfo['tables'],
283 $queryInfo['fields'],
285 $queryInfo['join_conds'],
286 $queryInfo['options'],
288 wfRunHooks( 'PageHistoryPager::getQueryInfo', array( &$this, &$queryInfo ) );
292 function getIndexField() {
293 return 'rev_timestamp';
296 function formatRow( $row ) {
297 if( $this->lastRow
) {
298 $latest = $this->counter
== 1 && $this->mIsFirst
;
299 $firstInList = $this->counter
== 1;
300 $s = $this->historyLine( $this->lastRow
, $row, $this->counter++
,
301 $this->title
->getNotificationTimestamp(), $latest, $firstInList );
305 $this->lastRow
= $row;
310 * Creates begin of history list with a submit button
312 * @return string HTML output
314 function getStartBody() {
315 global $wgScript, $wgEnableHtmlDiff, $wgUser;
316 $this->lastRow
= false;
318 $this->oldIdChecked
= 0;
320 $s = wfMsgExt( 'histlegend', array( 'parse') );
321 if( $this->getNumRows() > 1 && $wgUser->isAllowed('deleterevision') ) {
322 $revdel = SpecialPage
::getTitleFor( 'Revisiondelete' );
323 $s .= Xml
::openElement( 'form',
325 'action' => $revdel->getLocalURL( array(
326 'type' => 'revision',
327 'target' => $this->title
->getPrefixedDbKey()
330 'id' => 'mw-history-revdeleteform',
331 'style' => 'visibility:hidden;float:right;'
334 $s .= Xml
::hidden( 'ids', '', array('id'=>'revdel-oldid') );
335 $s .= Xml
::submitButton( wfMsg( 'showhideselectedversions' ) );
336 $s .= Xml
::closeElement( 'form' );
338 $s .= Xml
::openElement( 'form', array( 'action' => $wgScript,
339 'id' => 'mw-history-compare' ) );
340 $s .= Xml
::hidden( 'title', $this->title
->getPrefixedDbKey() );
341 if( $wgEnableHtmlDiff ) {
342 $s .= $this->submitButton( wfMsg( 'visualcomparison'),
344 'name' => 'htmldiff',
345 'class' => 'historysubmit',
346 'accesskey' => wfMsg( 'accesskey-visualcomparison' ),
347 'title' => wfMsg( 'tooltip-compareselectedversions' ),
350 $s .= $this->submitButton( wfMsg( 'wikicodecomparison'),
352 'class' => 'historysubmit',
353 'accesskey' => wfMsg( 'accesskey-compareselectedversions' ),
354 'title' => wfMsg( 'tooltip-compareselectedversions' ),
358 $s .= $this->submitButton( wfMsg( 'compareselectedversions'),
360 'class' => 'historysubmit',
361 'accesskey' => wfMsg( 'accesskey-compareselectedversions' ),
362 'title' => wfMsg( 'tooltip-compareselectedversions' ),
366 $s .= '<ul id="pagehistory">' . "\n";
370 function getEndBody() {
372 if( $this->lastRow
) {
373 $latest = $this->counter
== 1 && $this->mIsFirst
;
374 $firstInList = $this->counter
== 1;
375 if( $this->mIsBackwards
) {
376 # Next row is unknown, but for UI reasons, probably exists if an offset has been specified
377 if( $this->mOffset
== '' ) {
383 # The next row is the past-the-end row
384 $next = $this->mPastTheEndRow
;
386 $s = $this->historyLine( $this->lastRow
, $next, $this->counter++
,
387 $this->title
->getNotificationTimestamp(), $latest, $firstInList );
392 global $wgEnableHtmlDiff;
394 if( $wgEnableHtmlDiff ) {
395 $s .= $this->submitButton( wfMsg( 'visualcomparison'),
397 'name' => 'htmldiff',
398 'class' => 'historysubmit',
399 'accesskey' => wfMsg( 'accesskey-visualcomparison' ),
400 'title' => wfMsg( 'tooltip-compareselectedversions' ),
403 $s .= $this->submitButton( wfMsg( 'wikicodecomparison'),
405 'class' => 'historysubmit',
406 'accesskey' => wfMsg( 'accesskey-compareselectedversions' ),
407 'title' => wfMsg( 'tooltip-compareselectedversions' ),
411 $s .= $this->submitButton( wfMsg( 'compareselectedversions'),
413 'class' => 'historysubmit',
414 'accesskey' => wfMsg( 'accesskey-compareselectedversions' ),
415 'title' => wfMsg( 'tooltip-compareselectedversions' ),
424 * Creates a submit button
426 * @param array $attributes attributes
427 * @return string HTML output for the submit button
429 function submitButton($message, $attributes = array() ) {
430 # Disable submit button if history has 1 revision only
431 if( $this->getNumRows() > 1 ) {
432 return Xml
::submitButton( $message , $attributes );
439 * Returns a row from the history printout.
441 * @todo document some more, and maybe clean up the code (some params redundant?)
443 * @param Row $row The database row corresponding to the previous line.
444 * @param mixed $next The database row corresponding to the next line.
445 * @param int $counter Apparently a counter of what row number we're at, counted from the top row = 1.
446 * @param $notificationtimestamp
447 * @param bool $latest Whether this row corresponds to the page's latest revision.
448 * @param bool $firstInList Whether this row corresponds to the first displayed on this history page.
449 * @return string HTML output for the row
451 function historyLine( $row, $next, $counter = '', $notificationtimestamp = false,
452 $latest = false, $firstInList = false )
454 global $wgUser, $wgLang;
455 $rev = new Revision( $row );
456 $rev->setTitle( $this->title
);
458 $curlink = $this->curLink( $rev, $latest );
459 $lastlink = $this->lastLink( $rev, $next, $counter );
460 $diffButtons = $this->diffButtons( $rev, $firstInList, $counter );
461 $link = $this->revLink( $rev );
464 $s = "($curlink) ($lastlink) $diffButtons";
466 if( $wgUser->isAllowed( 'deleterevision' ) ) {
467 // Hide JS by default for non-JS browsing
468 $hidden = array( 'style' => 'display:none' );
469 // If revision was hidden from sysops
470 if( !$rev->userCan( Revision
::DELETED_RESTRICTED
) ) {
471 $del = Xml
::check( 'deleterevisions', false,
472 $hidden +
array('disabled' => 'disabled') );
473 $del .= Xml
::tags( 'span', array( 'class'=>'mw-revdelundel-link' ),
474 '(' . $this->historyPage
->message
['rev-delundel'] . ')' );
475 // Otherwise, show the link...
478 $jsCall = "updateShowHideForm($id,this.checked)";
479 $del = Xml
::check( 'showhiderevisions', false,
481 'onchange' => $jsCall,
482 'id' => "mw-revdel-$id" ) );
484 'type' => 'revision',
485 'target' => $this->title
->getPrefixedDbkey(),
486 'ids' => $rev->getId() );
487 $del .= $this->getSkin()->revDeleteLink( $query,
488 $rev->isDeleted( Revision
::DELETED_RESTRICTED
) );
494 $s .= " <span class='history-user'>" . $this->getSkin()->revUserTools( $rev, true ) . "</span>";
496 if( $rev->isMinor() ) {
497 $s .= ' ' . ChangesList
::flag( 'minor' );
500 if( !is_null( $size = $rev->getSize() ) && !$rev->isDeleted( Revision
::DELETED_TEXT
) ) {
501 $s .= ' ' . $this->getSkin()->formatRevisionSize( $size );
504 $s .= $this->getSkin()->revComment( $rev, false, true );
506 if( $notificationtimestamp && ($row->rev_timestamp
>= $notificationtimestamp) ) {
507 $s .= ' <span class="updatedmarker">' . wfMsgHtml( 'updatedmarker' ) . '</span>';
512 if( !is_null( $next ) && is_object( $next ) ) {
513 if( $latest && $this->title
->userCan( 'rollback' ) && $this->title
->userCan( 'edit' ) ) {
514 $tools[] = '<span class="mw-rollback-link">'.
515 $this->getSkin()->buildRollbackLink( $rev ).'</span>';
518 if( $this->title
->quickUserCan( 'edit' )
519 && !$rev->isDeleted( Revision
::DELETED_TEXT
)
520 && !$next->rev_deleted
& Revision
::DELETED_TEXT
)
522 # Create undo tooltip for the first (=latest) line only
523 $undoTooltip = $latest
524 ?
array( 'title' => wfMsg( 'tooltip-undo' ) )
526 $undolink = $this->getSkin()->link(
528 wfMsgHtml( 'editundo' ),
530 array( 'action' => 'edit', 'undoafter' => $next->rev_id
, 'undo' => $rev->getId() ),
531 array( 'known', 'noclasses' )
533 $tools[] = "<span class=\"mw-history-undo\">{$undolink}</span>";
538 $s .= ' (' . $wgLang->pipeList( $tools ) . ')';
542 list($tagSummary, $newClasses) = ChangeTags
::formatSummaryRow( $row->ts_tags
, 'history' );
543 $classes = array_merge( $classes, $newClasses );
544 $s .= " $tagSummary";
546 wfRunHooks( 'PageHistoryLineEnding', array( $this, &$row , &$s ) );
550 $attribs['class'] = implode( ' ', $classes );
553 return Xml
::tags( 'li', $attribs, $s ) . "\n";
557 * Create a link to view this revision of the page
558 * @param Revision $rev
561 function revLink( $rev ) {
563 $date = $wgLang->timeanddate( wfTimestamp(TS_MW
, $rev->getTimestamp()), true );
564 $date = htmlspecialchars( $date );
565 if( !$rev->isDeleted( Revision
::DELETED_TEXT
) ) {
566 $link = $this->getSkin()->link(
570 array( 'oldid' => $rev->getId() ),
571 array( 'known', 'noclasses' )
574 $link = "<span class=\"history-deleted\">$date</span>";
580 * Create a diff-to-current link for this revision for this page
581 * @param Revision $rev
582 * @param Bool $latest, this is the latest revision of the page?
585 function curLink( $rev, $latest ) {
586 $cur = $this->historyPage
->message
['cur'];
587 if( $latest ||
!$rev->userCan( Revision
::DELETED_TEXT
) ) {
590 return $this->getSkin()->link(
595 'diff' => $this->title
->getLatestRevID(),
596 'oldid' => $rev->getId()
598 array( 'known', 'noclasses' )
604 * Create a diff-to-previous link for this revision for this page.
605 * @param Revision $prevRev, the previous revision
606 * @param mixed $next, the newer revision
607 * @param int $counter, what row on the history list this is
610 function lastLink( $prevRev, $next, $counter ) {
611 $last = $this->historyPage
->message
['last'];
612 # $next may either be a Row, null, or "unkown"
613 $nextRev = is_object($next) ?
new Revision( $next ) : $next;
614 if( is_null($next) ) {
615 # Probably no next row
617 } elseif( $next === 'unknown' ) {
618 # Next row probably exists but is unknown, use an oldid=prev link
619 return $this->getSkin()->link(
624 'diff' => $prevRev->getId(),
627 array( 'known', 'noclasses' )
629 } elseif( !$prevRev->userCan(Revision
::DELETED_TEXT
) ||
!$nextRev->userCan(Revision
::DELETED_TEXT
) ) {
632 return $this->getSkin()->link(
637 'diff' => $prevRev->getId(),
638 'oldid' => $next->rev_id
640 array( 'known', 'noclasses' )
646 * Create radio buttons for page history
648 * @param object $rev Revision
649 * @param bool $firstInList Is this version the first one?
650 * @param int $counter A counter of what row number we're at, counted from the top row = 1.
651 * @return string HTML output for the radio buttons
653 function diffButtons( $rev, $firstInList, $counter ) {
654 if( $this->getNumRows() > 1 ) {
656 $radio = array( 'type' => 'radio', 'value' => $id );
657 /** @todo: move title texts to javascript */
659 $first = Xml
::element( 'input',
660 array_merge( $radio, array(
661 'style' => 'visibility:hidden',
663 'id' => 'mw-oldid-null' ) )
665 $checkmark = array( 'checked' => 'checked' );
667 # Check visibility of old revisions
668 if( !$rev->userCan( Revision
::DELETED_TEXT
) ) {
669 $radio['disabled'] = 'disabled';
670 $checkmark = array(); // We will check the next possible one
671 } else if( $counter == 2 ||
!$this->oldIdChecked
) {
672 $checkmark = array( 'checked' => 'checked' );
673 $this->oldIdChecked
= $id;
675 $checkmark = array();
677 $first = Xml
::element( 'input',
678 array_merge( $radio, $checkmark, array(
680 'id' => "mw-oldid-$id" ) ) );
681 $checkmark = array();
683 $second = Xml
::element( 'input',
684 array_merge( $radio, $checkmark, array(
686 'id' => "mw-diff-$id" ) ) );
687 return $first . $second;
695 * Backwards-compatibility aliases
697 class PageHistory
extends HistoryPage
{}
698 class PageHistoryPager
extends HistoryPager
{}