history() to print the
* history.
*
* @ingroup Actions
*/
class HistoryAction extends FormlessAction {
const DIR_PREV = 0;
const DIR_NEXT = 1;
public function getName() {
return 'history';
}
public function requiresWrite() {
return false;
}
public function requiresUnblock() {
return false;
}
protected function getPageTitle() {
return $this->msg( 'history-title', $this->getTitle()->getPrefixedText() )->text();
}
protected function getDescription() {
// Creation of a subtitle link pointing to [[Special:Log]]
return Linker::linkKnown(
SpecialPage::getTitleFor( 'Log' ),
$this->msg( 'viewpagelogs' )->escaped(),
array(),
array( 'page' => $this->getTitle()->getPrefixedText() )
);
}
/**
* Get the Article object we are working on.
* @return Page
*/
public function getArticle() {
return $this->page;
}
/**
* 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] = $this->msg( $msg )->escaped();
}
}
}
/**
* Print the history page for an article.
*/
function onView() {
global $wgScript, $wgUseFileCache;
$out = $this->getOutput();
$request = $this->getRequest();
/**
* Allow client caching.
*/
if ( $out->checkLastModified( $this->page->getTouched() ) ) {
return; // Client cache fresh and headers sent, nothing more to do.
}
wfProfileIn( __METHOD__ );
$this->preCacheMessages();
# Fill in the file cache if not set already
if ( $wgUseFileCache && HTMLFileCache::useFileCache( $this->getContext() ) ) {
$cache = HTMLFileCache::newFromTitle( $this->getTitle(), 'history' );
if ( !$cache->isCacheGood( /* Assume up to date */ ) ) {
ob_start( array( &$cache, 'saveToFileCache' ) );
}
}
// Setup page variables.
$out->setFeedAppendQuery( 'action=history' );
$out->addModules( 'mediawiki.action.history' );
// Handle atom/RSS feeds.
$feedType = $request->getVal( 'feed' );
if ( $feedType ) {
$this->feed( $feedType );
wfProfileOut( __METHOD__ );
return;
}
// Fail nicely if article doesn't exist.
if ( !$this->page->exists() ) {
$out->addWikiMsg( 'nohistory' );
# show deletion/move log if there is an entry
LogEventsList::showLogExtract(
$out,
array( 'delete', 'move' ),
$this->getTitle(),
'',
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 = $request->getInt( 'year' );
$month = $request->getInt( 'month' );
$tagFilter = $request->getVal( 'tagfilter' );
$tagSelector = ChangeTags::buildTagFilterSelector( $tagFilter );
/**
* Option to show only revisions that have been (partially) hidden via RevisionDelete
*/
if ( $request->getBool( 'deleted' ) ) {
$conds = array( 'rev_deleted != 0' );
} else {
$conds = array();
}
if ( $this->getUser()->isAllowed( 'deletedhistory' ) ) {
$checkDeleted = Xml::checkLabel( $this->msg( 'history-show-deleted' )->text(),
'deleted', 'mw-show-deleted-only', $request->getBool( 'deleted' ) ) . "\n";
} else {
$checkDeleted = '';
}
// Add the general form
$action = htmlspecialchars( $wgScript );
$out->addHTML(
"
'
);
wfRunHooks( 'PageHistoryBeforeList', array( &$this->page, $this->getContext() ) );
// Create and output the list.
$pager = new HistoryPager( $this, $year, $month, $tagFilter, $conds );
$out->addHTML(
$pager->getNavigationBar() .
$pager->getBody() .
$pager->getNavigationBar()
);
$out->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 ) {
// Fail if article doesn't exist.
if ( !$this->getTitle()->exists() ) {
return new FakeResultWrapper( array() );
}
$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 " . $dbr->addQuotes( $dbr->timestamp( $offset ) ) );
} else {
$offsets = array();
}
$page_id = $this->page->getId();
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 string $type feed type
*/
function feed( $type ) {
global $wgFeedClasses, $wgFeedLimit;
if ( !FeedUtils::checkFeedOutput( $type ) ) {
return;
}
$request = $this->getRequest();
$feed = new $wgFeedClasses[$type](
$this->getTitle()->getPrefixedText() . ' - ' .
$this->msg( 'history-feed-title' )->inContentLanguage()->text(),
$this->msg( 'history-feed-description' )->inContentLanguage()->text(),
$this->getTitle()->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 = $request->getInt( 'limit', 10 );
$limit = min( max( $limit, 1 ), $wgFeedLimit );
$items = $this->fetchRevisions( $limit, 0, HistoryPage::DIR_NEXT );
// Generate feed elements enclosed between header and footer.
$feed->outHeader();
if ( $items->numRows() ) {
foreach ( $items as $row ) {
$feed->outItem( $this->feedItem( $row ) );
}
} else {
$feed->outItem( $this->feedEmpty() );
}
$feed->outFooter();
}
function feedEmpty() {
return new FeedItem(
$this->msg( 'nohistory' )->inContentLanguage()->text(),
$this->msg( 'history-feed-empty' )->inContentLanguage()->parseAsBlock(),
$this->getTitle()->getFullURL(),
wfTimestamp( TS_MW ),
'',
$this->getTitle()->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->getTitle() );
$text = FeedUtils::formatDiffRow(
$this->getTitle(),
$this->getTitle()->getPreviousRevisionID( $rev->getId() ),
$rev->getId(),
$rev->getTimestamp(),
$rev->getComment()
);
if ( $rev->getComment() == '' ) {
global $wgContLang;
$title = $this->msg( 'history-feed-item-nocomment',
$rev->getUserText(),
$wgContLang->timeanddate( $rev->getTimestamp() ),
$wgContLang->date( $rev->getTimestamp() ),
$wgContLang->time( $rev->getTimestamp() ) )->inContentLanguage()->text();
} else {
$title = $rev->getUserText() .
$this->msg( 'colon-separator' )->inContentLanguage()->text() .
FeedItem::stripComment( $rev->getComment() );
}
return new FeedItem(
$title,
$text,
$this->getTitle()->getFullURL( 'diff=' . $rev->getId() . '&oldid=prev' ),
$rev->getTimestamp(),
$rev->getUserText(),
$this->getTitle()->getTalkPage()->getFullURL()
);
}
}
/**
* @ingroup Pager
* @ingroup Actions
*/
class HistoryPager extends ReverseChronologicalPager {
public $lastRow = false, $counter, $historyPage, $buttons, $conds;
protected $oldIdChecked;
protected $preventClickjacking = false;
/**
* @var array
*/
protected $parentLens;
function __construct( $historyPage, $year = '', $month = '', $tagFilter = '', $conds = array() ) {
parent::__construct( $historyPage->getContext() );
$this->historyPage = $historyPage;
$this->tagFilter = $tagFilter;
$this->getDateCond( $year, $month );
$this->conds = $conds;
}
// For hook compatibility...
function getArticle() {
return $this->historyPage->getArticle();
}
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', 'user' ),
'fields' => array_merge( Revision::selectFields(), Revision::selectUserFields() ),
'conds' => array_merge(
array( 'rev_page' => $this->getWikiPage()->getId() ),
$this->conds ),
'options' => array( 'USE INDEX' => array( 'revision' => 'page_timestamp' ) ),
'join_conds' => array( 'user' => Revision::userJoinCond() ),
);
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->getTitle()->getNotificationTimestamp( $this->getUser() ), $latest, $firstInList );
} else {
$s = '';
}
$this->lastRow = $row;
return $s;
}
function doBatchLookups() {
# Do a link batch query
$this->mResult->seek( 0 );
$batch = new LinkBatch();
$revIds = array();
foreach ( $this->mResult as $row ) {
if ( $row->rev_parent_id ) {
$revIds[] = $row->rev_parent_id;
}
if ( !is_null( $row->user_name ) ) {
$batch->add( NS_USER, $row->user_name );
$batch->add( NS_USER_TALK, $row->user_name );
} else { # for anons or usernames of imported revisions
$batch->add( NS_USER, $row->rev_user_text );
$batch->add( NS_USER_TALK, $row->rev_user_text );
}
}
$this->parentLens = Revision::getParentLengths( $this->mDb, $revIds );
$batch->execute();
$this->mResult->seek( 0 );
}
/**
* Creates begin of history list with a submit button
*
* @return string HTML output
*/
function getStartBody() {
global $wgScript;
$this->lastRow = false;
$this->counter = 1;
$this->oldIdChecked = 0;
$this->getOutput()->wrapWikiMsg( "