diff options
Diffstat (limited to 'includes/HistoryPage.php')
-rw-r--r-- | includes/HistoryPage.php | 238 |
1 files changed, 127 insertions, 111 deletions
diff --git a/includes/HistoryPage.php b/includes/HistoryPage.php index 8f5c2dda..b2cf044a 100644 --- a/includes/HistoryPage.php +++ b/includes/HistoryPage.php @@ -19,7 +19,12 @@ class HistoryPage { const DIR_PREV = 0; const DIR_NEXT = 1; - var $article, $title, $skin; + /** Contains the Article object. Passed on construction. */ + private $article; + /** The $article title object. Found on construction. */ + private $title; + /** Shortcut to the user Skin object. */ + private $skin; /** * Construct a new HistoryPage. @@ -34,11 +39,13 @@ class HistoryPage { $this->preCacheMessages(); } - function getArticle() { + /** Get the Article object we are working on. */ + public function getArticle() { return $this->article; } - function getTitle() { + /** Get the Title object. */ + public function getTitle() { return $this->title; } @@ -46,12 +53,12 @@ class HistoryPage { * As we use the same small set of messages in various methods and that * they are called often, we call them once and save them in $this->message */ - function preCacheMessages() { + private function preCacheMessages() { // Precache various messages - if( !isset( $this->message ) ) { + if ( !isset( $this->message ) ) { $msgs = array( 'cur', 'last', 'pipe-separator' ); - foreach( $msgs as $msg ) { - $this->message[$msg] = wfMsgExt( $msg, array( 'escapenoentities') ); + foreach ( $msgs as $msg ) { + $this->message[$msg] = wfMsgExt( $msg, array( 'escapenoentities' ) ); } } } @@ -63,17 +70,15 @@ class HistoryPage { function history() { global $wgOut, $wgRequest, $wgScript; - /* + /** * Allow client caching. */ - if( $wgOut->checkLastModified( $this->article->getTouched() ) ) + if ( $wgOut->checkLastModified( $this->article->getTouched() ) ) return; // Client cache fresh and headers sent, nothing more to do. wfProfileIn( __METHOD__ ); - /* - * Setup page variables. - */ + // Setup page variables. $wgOut->setPageTitle( wfMsg( 'history-title', $this->title->getPrefixedText() ) ); $wgOut->setPageTitleActionText( wfMsg( 'history_short' ) ); $wgOut->setArticleFlag( false ); @@ -81,8 +86,9 @@ class HistoryPage { $wgOut->setRobotPolicy( 'noindex,nofollow' ); $wgOut->setSyndicated( true ); $wgOut->setFeedAppendQuery( 'action=history' ); - $wgOut->addScriptFile( 'history.js' ); + $wgOut->addModules( array( 'mediawiki.legacy.history', 'mediawiki.action.history' ) ); + // Creation of a subtitle link pointing to [[Special:Log]] $logPage = SpecialPage::getTitleFor( 'Log' ); $logLink = $this->skin->link( $logPage, @@ -93,16 +99,15 @@ class HistoryPage { ); $wgOut->setSubtitle( $logLink ); + // Handle atom/RSS feeds. $feedType = $wgRequest->getVal( 'feed' ); - if( $feedType ) { + if ( $feedType ) { wfProfileOut( __METHOD__ ); return $this->feed( $feedType ); } - /* - * Fail if article doesn't exist. - */ - if( !$this->title->exists() ) { + // Fail nicely if article doesn't exist. + if ( !$this->title->exists() ) { $wgOut->addWikiMsg( 'nohistory' ); # show deletion/move log if there is an entry LogEventsList::showLogExtract( @@ -123,21 +128,23 @@ class HistoryPage { /** * Add date selector to quickly get to a certain time */ - $year = $wgRequest->getInt( 'year' ); - $month = $wgRequest->getInt( 'month' ); - $tagFilter = $wgRequest->getVal( 'tagfilter' ); + $year = $wgRequest->getInt( 'year' ); + $month = $wgRequest->getInt( 'month' ); + $tagFilter = $wgRequest->getVal( 'tagfilter' ); $tagSelector = ChangeTags::buildTagFilterSelector( $tagFilter ); + /** * Option to show only revisions that have been (partially) hidden via RevisionDelete */ if ( $wgRequest->getBool( 'deleted' ) ) { - $conds = array("rev_deleted != '0'"); + $conds = array( "rev_deleted != '0'" ); } else { $conds = array(); } $checkDeleted = Xml::checkLabel( wfMsg( 'history-show-deleted' ), 'deleted', 'mw-show-deleted-only', $wgRequest->getBool( 'deleted' ) ) . "\n"; + // Add the general form $action = htmlspecialchars( $wgScript ); $wgOut->addHTML( "<form action=\"$action\" method=\"get\" id=\"mw-history-searchform\">" . @@ -146,10 +153,10 @@ class HistoryPage { false, array( 'id' => 'mw-history-search' ) ) . - Xml::hidden( 'title', $this->title->getPrefixedDBKey() ) . "\n" . - Xml::hidden( 'action', 'history' ) . "\n" . - Xml::dateMenu( $year, $month ) . ' ' . - ( $tagSelector ? ( implode( ' ', $tagSelector ) . ' ' ) : '' ) . + Html::hidden( 'title', $this->title->getPrefixedDBKey() ) . "\n" . + Html::hidden( 'action', 'history' ) . "\n" . + Xml::dateMenu( $year, $month ) . ' ' . + ( $tagSelector ? ( implode( ' ', $tagSelector ) . ' ' ) : '' ) . $checkDeleted . Xml::submitButton( wfMsg( 'allpagessubmit' ) ) . "\n" . '</fieldset></form>' @@ -157,9 +164,7 @@ class HistoryPage { wfRunHooks( 'PageHistoryBeforeList', array( &$this->article ) ); - /** - * Do the list - */ + // Create and output the list. $pager = new HistoryPager( $this, $year, $month, $tagFilter, $conds ); $wgOut->addHTML( $pager->getNavigationBar() . @@ -184,24 +189,26 @@ class HistoryPage { function fetchRevisions( $limit, $offset, $direction ) { $dbr = wfGetDB( DB_SLAVE ); - if( $direction == HistoryPage::DIR_PREV ) - list($dirs, $oper) = array("ASC", ">="); - else /* $direction == HistoryPage::DIR_NEXT */ - list($dirs, $oper) = array("DESC", "<="); + if ( $direction == HistoryPage::DIR_PREV ) { + list( $dirs, $oper ) = array( "ASC", ">=" ); + } else { /* $direction == HistoryPage::DIR_NEXT */ + list( $dirs, $oper ) = array( "DESC", "<=" ); + } - if( $offset ) - $offsets = array("rev_timestamp $oper '$offset'"); - else + if ( $offset ) { + $offsets = array( "rev_timestamp $oper '$offset'" ); + } else { $offsets = array(); + } $page_id = $this->title->getArticleID(); return $dbr->select( 'revision', Revision::selectFields(), - array_merge(array("rev_page=$page_id"), $offsets), + array_merge( array( "rev_page=$page_id" ), $offsets ), __METHOD__, array( 'ORDER BY' => "rev_timestamp $dirs", - 'USE INDEX' => 'page_timestamp', 'LIMIT' => $limit) + 'USE INDEX' => 'page_timestamp', 'LIMIT' => $limit ) ); } @@ -212,7 +219,7 @@ class HistoryPage { */ function feed( $type ) { global $wgFeedClasses, $wgRequest, $wgFeedLimit; - if( !FeedUtils::checkFeedOutput($type) ) { + if ( !FeedUtils::checkFeedOutput( $type ) ) { return; } @@ -226,14 +233,15 @@ class HistoryPage { // Get a limit on number of feed entries. Provide a sane default // of 10 if none is defined (but limit to $wgFeedLimit max) $limit = $wgRequest->getInt( 'limit', 10 ); - if( $limit > $wgFeedLimit || $limit < 1 ) { + if ( $limit > $wgFeedLimit || $limit < 1 ) { $limit = 10; } - $items = $this->fetchRevisions($limit, 0, HistoryPage::DIR_NEXT); + $items = $this->fetchRevisions( $limit, 0, HistoryPage::DIR_NEXT ); + // Generate feed elements enclosed between header and footer. $feed->outHeader(); - if( $items ) { - foreach( $items as $row ) { + if ( $items ) { + foreach ( $items as $row ) { $feed->outItem( $this->feedItem( $row ) ); } } else { @@ -272,7 +280,7 @@ class HistoryPage { $rev->getTimestamp(), $rev->getComment() ); - if( $rev->getComment() == '' ) { + if ( $rev->getComment() == '' ) { global $wgContLang; $title = wfMsgForContent( 'history-feed-item-nocomment', $rev->getUserText(), @@ -304,10 +312,10 @@ class HistoryPager extends ReverseChronologicalPager { protected $oldIdChecked; protected $preventClickjacking = false; - function __construct( $historyPage, $year='', $month='', $tagFilter = '', $conds = array() ) { + function __construct( $historyPage, $year = '', $month = '', $tagFilter = '', $conds = array() ) { parent::__construct(); $this->historyPage = $historyPage; - $this->title = $this->historyPage->title; + $this->title = $this->historyPage->getTitle(); $this->tagFilter = $tagFilter; $this->getDateCond( $year, $month ); $this->conds = $conds; @@ -328,12 +336,12 @@ class HistoryPager extends ReverseChronologicalPager { function getQueryInfo() { $queryInfo = array( - 'tables' => array('revision'), + 'tables' => array( 'revision' ), 'fields' => Revision::selectFields(), 'conds' => array_merge( - array( 'rev_page' => $this->historyPage->title->getArticleID() ), + array( 'rev_page' => $this->historyPage->getTitle()->getArticleID() ), $this->conds ), - 'options' => array( 'USE INDEX' => array('revision' => 'page_timestamp') ), + 'options' => array( 'USE INDEX' => array( 'revision' => 'page_timestamp' ) ), 'join_conds' => array( 'tag_summary' => array( 'LEFT JOIN', 'ts_rev_id=rev_id' ) ), ); ChangeTags::modifyDisplayQuery( @@ -353,10 +361,11 @@ class HistoryPager extends ReverseChronologicalPager { } function formatRow( $row ) { - if( $this->lastRow ) { - $latest = ($this->counter == 1 && $this->mIsFirst); + if ( $this->lastRow ) { + $latest = ( $this->counter == 1 && $this->mIsFirst ); $firstInList = $this->counter == 1; - $s = $this->historyLine( $this->lastRow, $row, $this->counter++, + $this->counter++; + $s = $this->historyLine( $this->lastRow, $row, $this->title->getNotificationTimestamp(), $latest, $firstInList ); } else { $s = ''; @@ -376,18 +385,26 @@ class HistoryPager extends ReverseChronologicalPager { $this->counter = 1; $this->oldIdChecked = 0; - $wgOut->wrapWikiMsg( "<div class='mw-history-legend'>\n$1</div>", 'histlegend' ); - $s = Xml::openElement( 'form', array( 'action' => $wgScript, + $wgOut->wrapWikiMsg( "<div class='mw-history-legend'>\n$1\n</div>", 'histlegend' ); + $s = Html::openElement( 'form', array( 'action' => $wgScript, 'id' => 'mw-history-compare' ) ) . "\n"; - $s .= Xml::hidden( 'title', $this->title->getPrefixedDbKey() ) . "\n"; - $s .= Xml::hidden( 'action', 'historysubmit' ) . "\n"; + $s .= Html::hidden( 'title', $this->title->getPrefixedDbKey() ) . "\n"; + $s .= Html::hidden( 'action', 'historysubmit' ) . "\n"; + + $s .= '<div>' . $this->submitButton( wfMsg( 'compareselectedversions' ), + array( 'class' => 'historysubmit' ) ) . "\n"; $this->buttons = '<div>'; - if( $wgUser->isAllowed('deleterevision') ) { + $this->buttons .= $this->submitButton( wfMsg( 'compareselectedversions' ), + array( 'class' => 'historysubmit' ) + + $wgUser->getSkin()->tooltipAndAccessKeyAttribs( 'compareselectedversions' ) + ) . "\n"; + + if ( $wgUser->isAllowed( 'deleterevision' ) ) { $this->preventClickjacking(); $float = $wgContLang->alignEnd(); # Note bug #20966, <button> is non-standard in IE<8 - $this->buttons .= Xml::element( 'button', + $element = Html::element( 'button', array( 'type' => 'submit', 'name' => 'revisiondelete', @@ -397,26 +414,21 @@ class HistoryPager extends ReverseChronologicalPager { ), wfMsg( 'showhideselectedversions' ) ) . "\n"; + $s .= $element; + $this->buttons .= $element; } - $this->buttons .= $this->submitButton( wfMsg( 'compareselectedversions'), - array( - 'class' => 'historysubmit', - 'accesskey' => wfMsg( 'accesskey-compareselectedversions' ), - 'title' => wfMsg( 'tooltip-compareselectedversions' ), - ) - ) . "\n"; $this->buttons .= '</div>'; - $s .= $this->buttons . '<ul id="pagehistory">' . "\n"; + $s .= '</div><ul id="pagehistory">' . "\n"; return $s; } function getEndBody() { - if( $this->lastRow ) { + if ( $this->lastRow ) { $latest = $this->counter == 1 && $this->mIsFirst; $firstInList = $this->counter == 1; - if( $this->mIsBackwards ) { + if ( $this->mIsBackwards ) { # Next row is unknown, but for UI reasons, probably exists if an offset has been specified - if( $this->mOffset == '' ) { + if ( $this->mOffset == '' ) { $next = null; } else { $next = 'unknown'; @@ -425,14 +437,15 @@ class HistoryPager extends ReverseChronologicalPager { # The next row is the past-the-end row $next = $this->mPastTheEndRow; } - $s = $this->historyLine( $this->lastRow, $next, $this->counter++, + $this->counter++; + $s = $this->historyLine( $this->lastRow, $next, $this->title->getNotificationTimestamp(), $latest, $firstInList ); } else { $s = ''; } $s .= "</ul>\n"; # Add second buttons only if there is more than one rev - if( $this->getNumRows() > 2 ) { + if ( $this->getNumRows() > 2 ) { $s .= $this->buttons; } $s .= '</form>'; @@ -448,7 +461,7 @@ class HistoryPager extends ReverseChronologicalPager { */ function submitButton( $message, $attributes = array() ) { # Disable submit button if history has 1 revision only - if( $this->getNumRows() > 1 ) { + if ( $this->getNumRows() > 1 ) { return Xml::submitButton( $message , $attributes ); } else { return ''; @@ -462,13 +475,12 @@ class HistoryPager extends ReverseChronologicalPager { * * @param $row Object: the database row corresponding to the previous line. * @param $next Mixed: the database row corresponding to the next line. - * @param $counter Integer: apparently a counter of what row number we're at, counted from the top row = 1. * @param $notificationtimestamp * @param $latest Boolean: whether this row corresponds to the page's latest revision. * @param $firstInList Boolean: whether this row corresponds to the first displayed on this history page. * @return String: HTML output for the row */ - function historyLine( $row, $next, $counter = '', $notificationtimestamp = false, + function historyLine( $row, $next, $notificationtimestamp = false, $latest = false, $firstInList = false ) { global $wgUser, $wgLang; @@ -476,8 +488,8 @@ class HistoryPager extends ReverseChronologicalPager { $rev->setTitle( $this->title ); $curlink = $this->curLink( $rev, $latest ); - $lastlink = $this->lastLink( $rev, $next, $counter ); - $diffButtons = $this->diffButtons( $rev, $firstInList, $counter ); + $lastlink = $this->lastLink( $rev, $next ); + $diffButtons = $this->diffButtons( $rev, $firstInList ); $histLinks = Html::rawElement( 'span', array( 'class' => 'mw-history-histlinks' ), @@ -489,61 +501,63 @@ class HistoryPager extends ReverseChronologicalPager { $classes = array(); $del = ''; - // User can delete revisions... - if( $wgUser->isAllowed( 'deleterevision' ) ) { + // Show checkboxes for each revision + if ( $wgUser->isAllowed( 'deleterevision' ) ) { $this->preventClickjacking(); // If revision was hidden from sysops, disable the checkbox - if( !$rev->userCan( Revision::DELETED_RESTRICTED ) ) { + if ( !$rev->userCan( Revision::DELETED_RESTRICTED ) ) { $del = Xml::check( 'deleterevisions', false, array( 'disabled' => 'disabled' ) ); // Otherwise, enable the checkbox... } else { $del = Xml::check( 'showhiderevisions', false, - array( 'name' => 'ids['.$rev->getId().']' ) ); + array( 'name' => 'ids[' . $rev->getId() . ']' ) ); } // User can only view deleted revisions... - } else if( $rev->getVisibility() && $wgUser->isAllowed( 'deletedhistory' ) ) { + } else if ( $rev->getVisibility() && $wgUser->isAllowed( 'deletedhistory' ) ) { // If revision was hidden from sysops, disable the link - if( !$rev->userCan( Revision::DELETED_RESTRICTED ) ) { + if ( !$rev->userCan( Revision::DELETED_RESTRICTED ) ) { $cdel = $this->getSkin()->revDeleteLinkDisabled( false ); // Otherwise, show the link... } else { $query = array( 'type' => 'revision', - 'target' => $this->title->getPrefixedDbkey(), 'ids' => $rev->getId() ); + 'target' => $this->title->getPrefixedDbkey(), 'ids' => $rev->getId() ); $del .= $this->getSkin()->revDeleteLink( $query, $rev->isDeleted( Revision::DELETED_RESTRICTED ), false ); } } - if( $del ) $s .= " $del "; + if ( $del ) { + $s .= " $del "; + } $s .= " $link"; $s .= " <span class='history-user'>" . $this->getSkin()->revUserTools( $rev, true ) . "</span>"; - if( $rev->isMinor() ) { + if ( $rev->isMinor() ) { $s .= ' ' . ChangesList::flag( 'minor' ); } - if( !is_null( $size = $rev->getSize() ) && !$rev->isDeleted( Revision::DELETED_TEXT ) ) { + if ( !is_null( $size = $rev->getSize() ) && !$rev->isDeleted( Revision::DELETED_TEXT ) ) { $s .= ' ' . $this->getSkin()->formatRevisionSize( $size ); } $s .= $this->getSkin()->revComment( $rev, false, true ); - if( $notificationtimestamp && ($row->rev_timestamp >= $notificationtimestamp) ) { + if ( $notificationtimestamp && ( $row->rev_timestamp >= $notificationtimestamp ) ) { $s .= ' <span class="updatedmarker">' . wfMsgHtml( 'updatedmarker' ) . '</span>'; } $tools = array(); # Rollback and undo links - if( !is_null( $next ) && is_object( $next ) ) { - if( $latest && $this->title->userCan( 'rollback' ) && $this->title->userCan( 'edit' ) ) { + if ( !is_null( $next ) && is_object( $next ) ) { + if ( $latest && $this->title->userCan( 'rollback' ) && $this->title->userCan( 'edit' ) ) { $this->preventClickjacking(); - $tools[] = '<span class="mw-rollback-link">'. - $this->getSkin()->buildRollbackLink( $rev ).'</span>'; + $tools[] = '<span class="mw-rollback-link">' . + $this->getSkin()->buildRollbackLink( $rev ) . '</span>'; } - if( $this->title->quickUserCan( 'edit' ) + if ( $this->title->quickUserCan( 'edit' ) && !$rev->isDeleted( Revision::DELETED_TEXT ) && !$next->rev_deleted & Revision::DELETED_TEXT ) { @@ -566,12 +580,12 @@ class HistoryPager extends ReverseChronologicalPager { } } - if( $tools ) { + if ( $tools ) { $s .= ' (' . $wgLang->pipeList( $tools ) . ')'; } # Tags - list($tagSummary, $newClasses) = ChangeTags::formatSummaryRow( $row->ts_tags, 'history' ); + list( $tagSummary, $newClasses ) = ChangeTags::formatSummaryRow( $row->ts_tags, 'history' ); $classes = array_merge( $classes, $newClasses ); $s .= " $tagSummary"; @@ -593,9 +607,9 @@ class HistoryPager extends ReverseChronologicalPager { */ function revLink( $rev ) { global $wgLang; - $date = $wgLang->timeanddate( wfTimestamp(TS_MW, $rev->getTimestamp()), true ); + $date = $wgLang->timeanddate( wfTimestamp( TS_MW, $rev->getTimestamp() ), true ); $date = htmlspecialchars( $date ); - if( !$rev->isDeleted( Revision::DELETED_TEXT ) ) { + if ( $rev->userCan( Revision::DELETED_TEXT ) ) { $link = $this->getSkin()->link( $this->title, $date, @@ -604,7 +618,10 @@ class HistoryPager extends ReverseChronologicalPager { array( 'known', 'noclasses' ) ); } else { - $link = "<span class=\"history-deleted\">$date</span>"; + $link = $date; + } + if ( $rev->isDeleted( Revision::DELETED_TEXT ) ) { + $link = "<span class=\"history-deleted\">$link</span>"; } return $link; } @@ -618,7 +635,7 @@ class HistoryPager extends ReverseChronologicalPager { */ function curLink( $rev, $latest ) { $cur = $this->historyPage->message['cur']; - if( $latest || !$rev->userCan( Revision::DELETED_TEXT ) ) { + if ( $latest || !$rev->userCan( Revision::DELETED_TEXT ) ) { return $cur; } else { return $this->getSkin()->link( @@ -639,17 +656,16 @@ class HistoryPager extends ReverseChronologicalPager { * * @param $prevRev Revision: the previous revision * @param $next Mixed: the newer revision - * @param $counter Integer: what row on the history list this is * @return String */ - function lastLink( $prevRev, $next, $counter ) { + function lastLink( $prevRev, $next ) { $last = $this->historyPage->message['last']; # $next may either be a Row, null, or "unkown" - $nextRev = is_object($next) ? new Revision( $next ) : $next; - if( is_null($next) ) { + $nextRev = is_object( $next ) ? new Revision( $next ) : $next; + if ( is_null( $next ) ) { # Probably no next row return $last; - } elseif( $next === 'unknown' ) { + } elseif ( $next === 'unknown' ) { # Next row probably exists but is unknown, use an oldid=prev link return $this->getSkin()->link( $this->title, @@ -661,8 +677,8 @@ class HistoryPager extends ReverseChronologicalPager { ), array( 'known', 'noclasses' ) ); - } elseif( !$prevRev->userCan(Revision::DELETED_TEXT) - || !$nextRev->userCan(Revision::DELETED_TEXT) ) + } elseif ( !$prevRev->userCan( Revision::DELETED_TEXT ) + || !$nextRev->userCan( Revision::DELETED_TEXT ) ) { return $last; } else { @@ -684,15 +700,15 @@ class HistoryPager extends ReverseChronologicalPager { * * @param $rev Revision object * @param $firstInList Boolean: is this version the first one? - * @param $counter Integer: a counter of what row number we're at, counted from the top row = 1. + * * @return String: HTML output for the radio buttons */ - function diffButtons( $rev, $firstInList, $counter ) { - if( $this->getNumRows() > 1 ) { + function diffButtons( $rev, $firstInList ) { + if ( $this->getNumRows() > 1 ) { $id = $rev->getId(); $radio = array( 'type' => 'radio', 'value' => $id ); /** @todo: move title texts to javascript */ - if( $firstInList ) { + if ( $firstInList ) { $first = Xml::element( 'input', array_merge( $radio, array( 'style' => 'visibility:hidden', @@ -702,10 +718,10 @@ class HistoryPager extends ReverseChronologicalPager { $checkmark = array( 'checked' => 'checked' ); } else { # Check visibility of old revisions - if( !$rev->userCan( Revision::DELETED_TEXT ) ) { + if ( !$rev->userCan( Revision::DELETED_TEXT ) ) { $radio['disabled'] = 'disabled'; $checkmark = array(); // We will check the next possible one - } else if( $counter == 2 || !$this->oldIdChecked ) { + } else if ( !$this->oldIdChecked ) { $checkmark = array( 'checked' => 'checked' ); $this->oldIdChecked = $id; } else { |