history() to print the
* history.
*
*/
class HistoryPage {
const DIR_PREV = 0;
const DIR_NEXT = 1;
/** 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.
*
* @param $article Article
*/
function __construct( $article ) {
global $wgUser;
$this->article = $article;
$this->title = $article->getTitle();
$this->skin = $wgUser->getSkin();
$this->preCacheMessages();
}
/** Get the Article object we are working on. */
public function getArticle() {
return $this->article;
}
/** Get the Title object. */
public function getTitle() {
return $this->title;
}
/**
* 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
*/
private function preCacheMessages() {
// Precache various messages
if ( !isset( $this->message ) ) {
$msgs = array( 'cur', 'last', 'pipe-separator' );
foreach ( $msgs as $msg ) {
$this->message[$msg] = wfMsgExt( $msg, array( 'escapenoentities' ) );
}
}
}
/**
* Print the history page for an article.
* @return nothing
*/
function history() {
global $wgOut, $wgRequest, $wgScript;
/**
* Allow client caching.
*/
if ( $wgOut->checkLastModified( $this->article->getTouched() ) )
return; // Client cache fresh and headers sent, nothing more to do.
wfProfileIn( __METHOD__ );
// Setup page variables.
$wgOut->setPageTitle( wfMsg( 'history-title', $this->title->getPrefixedText() ) );
$wgOut->setPageTitleActionText( wfMsg( 'history_short' ) );
$wgOut->setArticleFlag( false );
$wgOut->setArticleRelated( true );
$wgOut->setRobotPolicy( 'noindex,nofollow' );
$wgOut->setSyndicated( true );
$wgOut->setFeedAppendQuery( 'action=history' );
$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,
wfMsgHtml( 'viewpagelogs' ),
array(),
array( 'page' => $this->title->getPrefixedText() ),
array( 'known', 'noclasses' )
);
$wgOut->setSubtitle( $logLink );
// Handle atom/RSS feeds.
$feedType = $wgRequest->getVal( 'feed' );
if ( $feedType ) {
wfProfileOut( __METHOD__ );
return $this->feed( $feedType );
}
// 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(
$wgOut,
array( 'delete', 'move' ),
$this->title->getPrefixedText(),
'',
array( 'lim' => 10,
'conds' => array( "log_action != 'revision'" ),
'showIfEmpty' => false,
'msgKey' => array( 'moveddeleted-notice' )
)
);
wfProfileOut( __METHOD__ );
return;
}
/**
* Add date selector to quickly get to a certain time
*/
$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'" );
} 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(
"
'
);
wfRunHooks( 'PageHistoryBeforeList', array( &$this->article ) );
// Create and output the list.
$pager = new HistoryPager( $this, $year, $month, $tagFilter, $conds );
$wgOut->addHTML(
$pager->getNavigationBar() .
$pager->getBody() .
$pager->getNavigationBar()
);
$wgOut->preventClickjacking( $pager->getPreventClickjacking() );
wfProfileOut( __METHOD__ );
}
/**
* Fetch an array of revisions, specified by a given limit, offset and
* direction. This is now only used by the feeds. It was previously
* used by the main UI but that's now handled by the pager.
*
* @param $limit Integer: the limit number of revisions to get
* @param $offset Integer
* @param $direction Integer: either HistoryPage::DIR_PREV or HistoryPage::DIR_NEXT
* @return ResultWrapper
*/
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 ( $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 ),
__METHOD__,
array( 'ORDER BY' => "rev_timestamp $dirs",
'USE INDEX' => 'page_timestamp', 'LIMIT' => $limit )
);
}
/**
* Output a subscription feed listing recent edits to this page.
*
* @param $type String: feed type
*/
function feed( $type ) {
global $wgFeedClasses, $wgRequest, $wgFeedLimit;
if ( !FeedUtils::checkFeedOutput( $type ) ) {
return;
}
$feed = new $wgFeedClasses[$type](
$this->title->getPrefixedText() . ' - ' .
wfMsgForContent( 'history-feed-title' ),
wfMsgForContent( 'history-feed-description' ),
$this->title->getFullUrl( 'action=history' )
);
// 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 ) {
$limit = 10;
}
$items = $this->fetchRevisions( $limit, 0, HistoryPage::DIR_NEXT );
// Generate feed elements enclosed between header and footer.
$feed->outHeader();
if ( $items ) {
foreach ( $items as $row ) {
$feed->outItem( $this->feedItem( $row ) );
}
} else {
$feed->outItem( $this->feedEmpty() );
}
$feed->outFooter();
}
function feedEmpty() {
global $wgOut;
return new FeedItem(
wfMsgForContent( 'nohistory' ),
$wgOut->parse( wfMsgForContent( 'history-feed-empty' ) ),
$this->title->getFullUrl(),
wfTimestamp( TS_MW ),
'',
$this->title->getTalkPage()->getFullUrl()
);
}
/**
* Generate a FeedItem object from a given revision table row
* Borrows Recent Changes' feed generation functions for formatting;
* includes a diff to the previous revision (if any).
*
* @param $row Object: database row
* @return FeedItem
*/
function feedItem( $row ) {
$rev = new Revision( $row );
$rev->setTitle( $this->title );
$text = FeedUtils::formatDiffRow(
$this->title,
$this->title->getPreviousRevisionID( $rev->getId() ),
$rev->getId(),
$rev->getTimestamp(),
$rev->getComment()
);
if ( $rev->getComment() == '' ) {
global $wgContLang;
$title = wfMsgForContent( 'history-feed-item-nocomment',
$rev->getUserText(),
$wgContLang->timeanddate( $rev->getTimestamp() ),
$wgContLang->date( $rev->getTimestamp() ),
$wgContLang->time( $rev->getTimestamp() )
);
} else {
$title = $rev->getUserText() .
wfMsgForContent( 'colon-separator' ) .
FeedItem::stripComment( $rev->getComment() );
}
return new FeedItem(
$title,
$text,
$this->title->getFullUrl( 'diff=' . $rev->getId() . '&oldid=prev' ),
$rev->getTimestamp(),
$rev->getUserText(),
$this->title->getTalkPage()->getFullUrl()
);
}
}
/**
* @ingroup Pager
*/
class HistoryPager extends ReverseChronologicalPager {
public $lastRow = false, $counter, $historyPage, $title, $buttons, $conds;
protected $oldIdChecked;
protected $preventClickjacking = false;
function __construct( $historyPage, $year = '', $month = '', $tagFilter = '', $conds = array() ) {
parent::__construct();
$this->historyPage = $historyPage;
$this->title = $this->historyPage->getTitle();
$this->tagFilter = $tagFilter;
$this->getDateCond( $year, $month );
$this->conds = $conds;
}
// For hook compatibility...
function getArticle() {
return $this->historyPage->getArticle();
}
function getTitle() {
return $this->title;
}
function getSqlComment() {
if ( $this->conds ) {
return 'history page filtered'; // potentially slow, see CR r58153
} else {
return 'history page unfiltered';
}
}
function getQueryInfo() {
$queryInfo = array(
'tables' => array( 'revision' ),
'fields' => Revision::selectFields(),
'conds' => array_merge(
array( 'rev_page' => $this->title->getArticleID() ),
$this->conds ),
'options' => array( 'USE INDEX' => array( 'revision' => 'page_timestamp' ) ),
'join_conds' => array( 'tag_summary' => array( 'LEFT JOIN', 'ts_rev_id=rev_id' ) ),
);
ChangeTags::modifyDisplayQuery(
$queryInfo['tables'],
$queryInfo['fields'],
$queryInfo['conds'],
$queryInfo['join_conds'],
$queryInfo['options'],
$this->tagFilter
);
wfRunHooks( 'PageHistoryPager::getQueryInfo', array( &$this, &$queryInfo ) );
return $queryInfo;
}
function getIndexField() {
return 'rev_timestamp';
}
function formatRow( $row ) {
if ( $this->lastRow ) {
$latest = ( $this->counter == 1 && $this->mIsFirst );
$firstInList = $this->counter == 1;
$this->counter++;
$s = $this->historyLine( $this->lastRow, $row,
$this->title->getNotificationTimestamp(), $latest, $firstInList );
} else {
$s = '';
}
$this->lastRow = $row;
return $s;
}
/**
* Creates begin of history list with a submit button
*
* @return string HTML output
*/
function getStartBody() {
global $wgScript, $wgUser, $wgOut;
$this->lastRow = false;
$this->counter = 1;
$this->oldIdChecked = 0;
$wgOut->wrapWikiMsg( "