5 * Split off from Article.php and Skin.php, 2003-12-22
9 * This class handles printing the history page for an article. In order to
10 * be efficient, it uses timestamps rather than offsets for paging, to avoid
11 * costly LIMIT,offset queries.
13 * Construct it by passing in an Article, and call $h->history() to print the
21 var $mArticle, $mTitle, $mSkin;
24 var $mNotificationTimestamp;
25 var $mLatestId = null;
28 * Construct a new PageHistory.
30 * @param Article $article
33 function __construct($article) {
36 $this->mArticle
=& $article;
37 $this->mTitle
=& $article->mTitle
;
38 $this->mNotificationTimestamp
= NULL;
39 $this->mSkin
= $wgUser->getSkin();
43 * Print the history page for an article.
48 global $wgOut, $wgRequest, $wgTitle;
51 * Allow client caching.
54 if( $wgOut->checkLastModified( $this->mArticle
->getTimestamp() ) )
55 /* Client cache fresh and headers sent, nothing more to do. */
58 $fname = 'PageHistory::history';
59 wfProfileIn( $fname );
62 * Setup page variables.
64 $wgOut->setPageTitle( wfMsg( 'history-title', $this->mTitle
->getPrefixedText() ) );
65 $wgOut->setPageTitleActionText( wfMsg( 'history_short' ) );
66 $wgOut->setArticleFlag( false );
67 $wgOut->setArticleRelated( true );
68 $wgOut->setRobotpolicy( 'noindex,nofollow' );
69 $wgOut->setSyndicated( true );
70 $wgOut->setFeedAppendQuery( 'action=history' );
72 $logPage = SpecialPage
::getTitleFor( 'Log' );
73 $logLink = $this->mSkin
->makeKnownLinkObj( $logPage, wfMsgHtml( 'viewpagelogs' ), 'page=' . $this->mTitle
->getPrefixedUrl() );
74 $wgOut->setSubtitle( $logLink );
76 $feedType = $wgRequest->getVal( 'feed' );
78 wfProfileOut( $fname );
79 return $this->feed( $feedType );
83 * Fail if article doesn't exist.
85 if( !$this->mTitle
->exists() ) {
86 $wgOut->addWikiMsg( 'nohistory' );
87 wfProfileOut( $fname );
92 * "go=first" means to jump to the last (earliest) history page.
93 * This is deprecated, it no longer appears in the user interface
95 if ( $wgRequest->getText("go") == 'first' ) {
96 $limit = $wgRequest->getInt( 'limit', 50 );
97 $wgOut->redirect( $wgTitle->getLocalURL( "action=history&limit={$limit}&dir=prev" ) );
101 wfRunHooks( 'PageHistoryBeforeList', array( &$this->mArticle
) );
106 $pager = new PageHistoryPager( $this );
107 $this->linesonpage
= $pager->getNumRows();
109 $pager->getNavigationBar() .
110 $this->beginHistoryList() .
112 $this->endHistoryList() .
113 $pager->getNavigationBar()
115 wfProfileOut( $fname );
119 * Creates begin of history list with a submit button
121 * @return string HTML output
123 function beginHistoryList() {
125 $this->lastdate
= '';
126 $s = wfMsgExt( 'histlegend', array( 'parse') );
127 $s .= '<form action="' . $wgTitle->escapeLocalURL( '-' ) . '" method="get">';
128 $prefixedkey = htmlspecialchars($wgTitle->getPrefixedDbKey());
130 // The following line is SUPPOSED to have double-quotes around the
131 // $prefixedkey variable, because htmlspecialchars() doesn't escape
134 // On at least two occasions people have changed it to single-quotes,
135 // which creates invalid HTML and incorrect display of the resulting
138 // Please do not break this a third time. Thank you for your kind
139 // consideration and cooperation.
141 $s .= "<input type='hidden' name='title' value=\"{$prefixedkey}\" />\n";
143 $s .= $this->submitButton();
144 $s .= '<ul id="pagehistory">' . "\n";
149 * Creates end of history list with a submit button
151 * @return string HTML output
153 function endHistoryList() {
155 $s .= $this->submitButton( array( 'id' => 'historysubmit' ) );
161 * Creates a submit button
163 * @param array $bits optional CSS ID
164 * @return string HTML output for the submit button
166 function submitButton( $bits = array() ) {
167 # Disable submit button if history has 1 revision only
168 if ( $this->linesonpage
> 1 ) {
169 return Xml
::submitButton( wfMsg( 'compareselectedversions' ),
171 'class' => 'historysubmit',
172 'accesskey' => wfMsg( 'accesskey-compareselectedversions' ),
173 'title' => wfMsg( 'tooltip-compareselectedversions' ),
182 * Returns a row from the history printout.
184 * @todo document some more, and maybe clean up the code (some params redundant?)
186 * @param object $row The database row corresponding to the line (or is it the previous line?).
187 * @param object $next The database row corresponding to the next line (or is it this one?).
188 * @param int $counter Apparently a counter of what row number we're at, counted from the top row = 1.
189 * @param $notificationtimestamp
190 * @param bool $latest Whether this row corresponds to the page's latest revision.
191 * @param bool $firstInList Whether this row corresponds to the first displayed on this history page.
192 * @return string HTML output for the row
194 function historyLine( $row, $next, $counter = '', $notificationtimestamp = false, $latest = false, $firstInList = false ) {
195 global $wgUser, $wgLang;
196 $rev = new Revision( $row );
197 $rev->setTitle( $this->mTitle
);
200 $curlink = $this->curLink( $rev, $latest );
201 $lastlink = $this->lastLink( $rev, $next, $counter );
202 $arbitrary = $this->diffButtons( $rev, $firstInList, $counter );
203 $link = $this->revLink( $rev );
205 $user = $this->mSkin
->userLink( $rev->getUser(), $rev->getUserText() )
206 . $this->mSkin
->userToolLinks( $rev->getUser(), $rev->getUserText() );
208 $s .= "($curlink) ($lastlink) $arbitrary";
210 if( $wgUser->isAllowed( 'deleterevision' ) ) {
211 $revdel = SpecialPage
::getTitleFor( 'Revisiondelete' );
213 // We don't currently handle well changing the top revision's settings
214 $del = wfMsgHtml( 'rev-delundel' );
215 } else if( !$rev->userCan( Revision
::DELETED_RESTRICTED
) ) {
216 // If revision was hidden from sysops
217 $del = wfMsgHtml( 'rev-delundel' );
219 $del = $this->mSkin
->makeKnownLinkObj( $revdel,
220 wfMsg( 'rev-delundel' ),
221 'target=' . urlencode( $this->mTitle
->getPrefixedDbkey() ) .
222 '&oldid=' . urlencode( $rev->getId() ) );
224 $s .= " (<small>$del</small>) ";
228 #getUser is safe, but this avoids making the invalid untargeted contribs links
229 if( $row->rev_deleted
& Revision
::DELETED_USER
) {
230 $user = '<span class="history-deleted">' . wfMsg('rev-deleted-user') . '</span>';
232 $s .= " <span class='history-user'>$user</span>";
234 if( $row->rev_minor_edit
) {
235 $s .= ' ' . wfElement( 'span', array( 'class' => 'minor' ), wfMsg( 'minoreditletter') );
238 if ( !is_null( $size = $rev->getSize() ) ) {
240 $stxt = wfMsgHtml( 'historyempty' );
242 $stxt = wfMsgExt( 'historysize', array( 'parsemag' ), $wgLang->formatNum( $size ) );
243 $s .= " <span class=\"history-size\">$stxt</span>";
246 #getComment is safe, but this is better formatted
247 if( $rev->isDeleted( Revision
::DELETED_COMMENT
) ) {
248 $s .= " <span class=\"history-deleted\"><span class=\"comment\">" .
249 wfMsgHtml( 'rev-deleted-comment' ) . "</span></span>";
251 $s .= $this->mSkin
->revComment( $rev );
254 if ($notificationtimestamp && ($row->rev_timestamp
>= $notificationtimestamp)) {
255 $s .= ' <span class="updatedmarker">' . wfMsgHtml( 'updatedmarker' ) . '</span>';
257 #add blurb about text having been deleted
258 if( $row->rev_deleted
& Revision
::DELETED_TEXT
) {
259 $s .= ' ' . wfMsgHtml( 'deletedrev' );
264 if ( !is_null( $next ) && is_object( $next ) ) {
265 if( !$this->mTitle
->getUserPermissionsErrors( 'rollback', $wgUser )
266 && !$this->mTitle
->getUserPermissionsErrors( 'edit', $wgUser )
268 $tools[] = '<span class="mw-rollback-link">'
269 . $this->mSkin
->buildRollbackLink( $rev )
273 if( $this->mTitle
->quickUserCan( 'edit' ) ) {
274 $undolink = $this->mSkin
->makeKnownLinkObj(
276 wfMsgHtml( 'editundo' ),
277 'action=edit&undoafter=' . $next->rev_id
. '&undo=' . $rev->getId()
279 $tools[] = "<span class=\"mw-history-undo\">{$undolink}</span>";
284 $s .= ' (' . implode( ' | ', $tools ) . ')';
287 wfRunHooks( 'PageHistoryLineEnding', array( &$row , &$s ) );
294 /** @todo document */
295 function revLink( $rev ) {
297 $date = $wgLang->timeanddate( wfTimestamp(TS_MW
, $rev->getTimestamp()), true );
298 if( $rev->userCan( Revision
::DELETED_TEXT
) ) {
299 $link = $this->mSkin
->makeKnownLinkObj(
300 $this->mTitle
, $date, "oldid=" . $rev->getId() );
304 if( $rev->isDeleted( Revision
::DELETED_TEXT
) ) {
305 return '<span class="history-deleted">' . $link . '</span>';
310 /** @todo document */
311 function curLink( $rev, $latest ) {
312 $cur = wfMsgExt( 'cur', array( 'escape') );
313 if( $latest ||
!$rev->userCan( Revision
::DELETED_TEXT
) ) {
316 return $this->mSkin
->makeKnownLinkObj(
318 'diff=' . $this->getLatestID() .
319 "&oldid=" . $rev->getId() );
323 /** @todo document */
324 function lastLink( $rev, $next, $counter ) {
325 $last = wfMsgExt( 'last', array( 'escape' ) );
326 if ( is_null( $next ) ) {
327 # Probably no next row
329 } elseif ( $next === 'unknown' ) {
330 # Next row probably exists but is unknown, use an oldid=prev link
331 return $this->mSkin
->makeKnownLinkObj(
334 "diff=" . $rev->getId() . "&oldid=prev" );
335 } elseif( !$rev->userCan( Revision
::DELETED_TEXT
) ) {
338 return $this->mSkin
->makeKnownLinkObj(
341 "diff=" . $rev->getId() . "&oldid={$next->rev_id}"
345 "tabindex={$counter}"*/ );
350 * Create radio buttons for page history
352 * @param object $rev Revision
353 * @param bool $firstInList Is this version the first one?
354 * @param int $counter A counter of what row number we're at, counted from the top row = 1.
355 * @return string HTML output for the radio buttons
357 function diffButtons( $rev, $firstInList, $counter ) {
358 if( $this->linesonpage
> 1) {
361 'value' => $rev->getId(),
364 if( !$rev->userCan( Revision
::DELETED_TEXT
) ) {
365 $radio['disabled'] = 'disabled';
368 /** @todo: move title texts to javascript */
369 if ( $firstInList ) {
370 $first = Xml
::element( 'input', array_merge(
373 'style' => 'visibility:hidden',
374 'name' => 'oldid' ) ) );
375 $checkmark = array( 'checked' => 'checked' );
377 if( $counter == 2 ) {
378 $checkmark = array( 'checked' => 'checked' );
380 $checkmark = array();
382 $first = Xml
::element( 'input', array_merge(
385 array( 'name' => 'oldid' ) ) );
386 $checkmark = array();
388 $second = Xml
::element( 'input', array_merge(
391 array( 'name' => 'diff' ) ) );
392 return $first . $second;
398 /** @todo document */
399 function getLatestId() {
400 if( is_null( $this->mLatestId
) ) {
401 $id = $this->mTitle
->getArticleID();
402 $db = wfGetDB(DB_SLAVE
);
403 $this->mLatestId
= $db->selectField( 'page',
405 array( 'page_id' => $id ),
406 'PageHistory::getLatestID' );
408 return $this->mLatestId
;
412 * Fetch an array of revisions, specified by a given limit, offset and
413 * direction. This is now only used by the feeds. It was previously
414 * used by the main UI but that's now handled by the pager.
416 function fetchRevisions($limit, $offset, $direction) {
417 $fname = 'PageHistory::fetchRevisions';
419 $dbr = wfGetDB( DB_SLAVE
);
421 if ($direction == PageHistory
::DIR_PREV
)
422 list($dirs, $oper) = array("ASC", ">=");
423 else /* $direction == PageHistory::DIR_NEXT */
424 list($dirs, $oper) = array("DESC", "<=");
427 $offsets = array("rev_timestamp $oper '$offset'");
431 $page_id = $this->mTitle
->getArticleID();
435 Revision
::selectFields(),
436 array_merge(array("rev_page=$page_id"), $offsets),
438 array('ORDER BY' => "rev_timestamp $dirs",
439 'USE INDEX' => 'page_timestamp', 'LIMIT' => $limit)
443 while (($obj = $dbr->fetchObject($res)) != NULL)
449 /** @todo document */
450 function getNotificationTimestamp() {
451 global $wgUser, $wgShowUpdatedMarker;
452 $fname = 'PageHistory::getNotficationTimestamp';
454 if ($this->mNotificationTimestamp
!== NULL)
455 return $this->mNotificationTimestamp
;
457 if ($wgUser->isAnon() ||
!$wgShowUpdatedMarker)
458 return $this->mNotificationTimestamp
= false;
460 $dbr = wfGetDB(DB_SLAVE
);
462 $this->mNotificationTimestamp
= $dbr->selectField(
464 'wl_notificationtimestamp',
465 array( 'wl_namespace' => $this->mTitle
->getNamespace(),
466 'wl_title' => $this->mTitle
->getDBkey(),
467 'wl_user' => $wgUser->getID()
471 // Don't use the special value reserved for telling whether the field is filled
472 if ( is_null( $this->mNotificationTimestamp
) ) {
473 $this->mNotificationTimestamp
= false;
476 return $this->mNotificationTimestamp
;
480 * Output a subscription feed listing recent edits to this page.
481 * @param string $type
483 function feed( $type ) {
484 require_once 'SpecialRecentchanges.php';
486 global $wgFeed, $wgFeedClasses;
490 $wgOut->addWikiMsg( 'feed-unavailable' );
494 if( !isset( $wgFeedClasses[$type] ) ) {
496 $wgOut->addWikiMsg( 'feed-invalid' );
500 $feed = new $wgFeedClasses[$type](
501 $this->mTitle
->getPrefixedText() . ' - ' .
502 wfMsgForContent( 'history-feed-title' ),
503 wfMsgForContent( 'history-feed-description' ),
504 $this->mTitle
->getFullUrl( 'action=history' ) );
506 $items = $this->fetchRevisions(10, 0, PageHistory
::DIR_NEXT
);
509 foreach( $items as $row ) {
510 $feed->outItem( $this->feedItem( $row ) );
513 $feed->outItem( $this->feedEmpty() );
518 function feedEmpty() {
521 wfMsgForContent( 'nohistory' ),
522 $wgOut->parse( wfMsgForContent( 'history-feed-empty' ) ),
523 $this->mTitle
->getFullUrl(),
524 wfTimestamp( TS_MW
),
526 $this->mTitle
->getTalkPage()->getFullUrl() );
530 * Generate a FeedItem object from a given revision table row
531 * Borrows Recent Changes' feed generation functions for formatting;
532 * includes a diff to the previous revision (if any).
537 function feedItem( $row ) {
538 $rev = new Revision( $row );
539 $rev->setTitle( $this->mTitle
);
540 $text = rcFormatDiffRow( $this->mTitle
,
541 $this->mTitle
->getPreviousRevisionID( $rev->getId() ),
543 $rev->getTimestamp(),
544 $rev->getComment() );
546 if( $rev->getComment() == '' ) {
548 $title = wfMsgForContent( 'history-feed-item-nocomment',
550 $wgContLang->timeanddate( $rev->getTimestamp() ) );
552 $title = $rev->getUserText() . ": " . $this->stripComment( $rev->getComment() );
558 $this->mTitle
->getFullUrl( 'diff=' . $rev->getId() . '&oldid=prev' ),
559 $rev->getTimestamp(),
561 $this->mTitle
->getTalkPage()->getFullUrl() );
565 * Quickie hack... strip out wikilinks to more legible form from the comment.
567 function stripComment( $text ) {
568 return preg_replace( '/\[\[([^]]*\|)?([^]]+)\]\]/', '\2', $text );
576 class PageHistoryPager
extends ReverseChronologicalPager
{
577 public $mLastRow = false, $mPageHistory;
579 function __construct( $pageHistory ) {
580 parent
::__construct();
581 $this->mPageHistory
= $pageHistory;
584 function getQueryInfo() {
586 'tables' => 'revision',
587 'fields' => Revision
::selectFields(),
588 'conds' => array('rev_page' => $this->mPageHistory
->mTitle
->getArticleID() ),
589 'options' => array( 'USE INDEX' => 'page_timestamp' )
593 function getIndexField() {
594 return 'rev_timestamp';
597 function formatRow( $row ) {
598 if ( $this->mLastRow
) {
599 $latest = $this->mCounter
== 1 && $this->mOffset
== '';
600 $firstInList = $this->mCounter
== 1;
601 $s = $this->mPageHistory
->historyLine( $this->mLastRow
, $row, $this->mCounter++
,
602 $this->mPageHistory
->getNotificationTimestamp(), $latest, $firstInList );
606 $this->mLastRow
= $row;
610 function getStartBody() {
611 $this->mLastRow
= false;
616 function getEndBody() {
617 if ( $this->mLastRow
) {
618 $latest = $this->mCounter
== 1 && $this->mOffset
== 0;
619 $firstInList = $this->mCounter
== 1;
620 if ( $this->mIsBackwards
) {
621 # Next row is unknown, but for UI reasons, probably exists if an offset has been specified
622 if ( $this->mOffset
== '' ) {
628 # The next row is the past-the-end row
629 $next = $this->mPastTheEndRow
;
631 $s = $this->mPageHistory
->historyLine( $this->mLastRow
, $next, $this->mCounter++
,
632 $this->mPageHistory
->getNotificationTimestamp(), $latest, $firstInList );