history() to print the * history. * * @ingroup Actions */ class HistoryAction extends FormlessAction { const DIR_PREV = 0; const DIR_NEXT = 1; /** @var array Array of message keys and strings */ public $message; 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() { $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(); $config = $this->context->getConfig(); # Fill in the file cache if not set already $useFileCache = $config->get( 'UseFileCache' ); if ( $useFileCache && HTMLFileCache::useFileCache( $this->getContext() ) ) { $cache = new HTMLFileCache( $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' ); if ( $config->get( 'UseMediaWikiUIEverywhere' ) ) { $out = $this->getOutput(); $out->addModuleStyles( array( 'mediawiki.ui.input', 'mediawiki.ui.checkbox', ) ); } // 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( wfScript() ); $out->addHTML( "
" . Xml::fieldset( $this->msg( 'history-fieldset-title' )->text(), false, array( 'id' => 'mw-history-search' ) ) . Html::hidden( 'title', $this->getTitle()->getPrefixedDBkey() ) . "\n" . Html::hidden( 'action', 'history' ) . "\n" . Xml::dateMenu( ( $year == null ? MWTimestamp::getLocalInstance()->format( 'Y' ) : $year ), $month ) . ' ' . ( $tagSelector ? ( implode( ' ', $tagSelector ) . ' ' ) : '' ) . $checkDeleted . Xml::submitButton( $this->msg( 'allpagessubmit' )->text() ) . "\n" . '
' ); 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 int $limit The limit number of revisions to get * @param int $offset * @param int $direction Either self::DIR_PREV or self::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 === self::DIR_PREV ) { list( $dirs, $oper ) = array( "ASC", ">=" ); } else { /* $direction === self::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 ) { if ( !FeedUtils::checkFeedOutput( $type ) ) { return; } $request = $this->getRequest(); $feedClasses = $this->context->getConfig()->get( 'FeedClasses' ); /** @var RSSFeed|AtomFeed $feed */ $feed = new $feedClasses[$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 ), $this->context->getConfig()->get( 'FeedLimit' ) ); $items = $this->fetchRevisions( $limit, 0, self::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 stdClass|array $row 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 { /** * @var bool|stdClass */ public $lastRow = false; public $counter, $historyPage, $buttons, $conds; protected $oldIdChecked; protected $preventClickjacking = false; /** * @var array */ protected $parentLens; /** * @param HistoryAction $historyPage * @param string $year * @param string $month * @param string $tagFilter * @param array $conds */ 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'; } /** * @param stdClass $row * @return string */ 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() { $this->lastRow = false; $this->counter = 1; $this->oldIdChecked = 0; $this->getOutput()->wrapWikiMsg( "
\n$1\n
", 'histlegend' ); $s = Html::openElement( 'form', array( 'action' => wfScript(), 'id' => 'mw-history-compare' ) ) . "\n"; $s .= Html::hidden( 'title', $this->getTitle()->getPrefixedDBkey() ) . "\n"; $s .= Html::hidden( 'action', 'historysubmit' ) . "\n"; // Button container stored in $this->buttons for re-use in getEndBody() $this->buttons = '
'; $className = 'historysubmit mw-history-compareselectedversions-button'; if ( $this->getConfig()->get( 'UseMediaWikiUIEverywhere' ) ) { $className .= ' mw-ui-button mw-ui-constructive'; } $this->buttons .= $this->submitButton( $this->msg( 'compareselectedversions' )->text(), array( 'class' => $className ) + Linker::tooltipAndAccesskeyAttribs( 'compareselectedversions' ) ) . "\n"; if ( $this->getUser()->isAllowed( 'deleterevision' ) ) { $this->buttons .= $this->getRevisionButton( 'revisiondelete', 'showhideselectedversions' ); } $this->buttons .= '
'; $s .= $this->buttons; $s .= '\n"; # Add second buttons only if there is more than one rev if ( $this->getNumRows() > 2 ) { $s .= $this->buttons; } $s .= ''; return $s; } /** * Creates a submit button * * @param string $message Text of the submit button, will be escaped * @param array $attributes Attributes * @return string HTML output for the submit button */ function submitButton( $message, $attributes = array() ) { # Disable submit button if history has 1 revision only if ( $this->getNumRows() > 1 ) { return Xml::submitButton( $message, $attributes ); } else { return ''; } } /** * Returns a row from the history printout. * * @todo document some more, and maybe clean up the code (some params redundant?) * * @param stdClass $row The database row corresponding to the previous line. * @param mixed $next The database row corresponding to the next line * (chronologically previous) * @param bool|string $notificationtimestamp * @param bool $latest Whether this row corresponds to the page's latest revision. * @param bool $firstInList Whether this row corresponds to the first * displayed on this history page. * @return string HTML output for the row */ function historyLine( $row, $next, $notificationtimestamp = false, $latest = false, $firstInList = false ) { $rev = new Revision( $row ); $rev->setTitle( $this->getTitle() ); if ( is_object( $next ) ) { $prevRev = new Revision( $next ); $prevRev->setTitle( $this->getTitle() ); } else { $prevRev = null; } $curlink = $this->curLink( $rev, $latest ); $lastlink = $this->lastLink( $rev, $next ); $curLastlinks = $curlink . $this->historyPage->message['pipe-separator'] . $lastlink; $histLinks = Html::rawElement( 'span', array( 'class' => 'mw-history-histlinks' ), $this->msg( 'parentheses' )->rawParams( $curLastlinks )->escaped() ); $diffButtons = $this->diffButtons( $rev, $firstInList ); $s = $histLinks . $diffButtons; $link = $this->revLink( $rev ); $classes = array(); $del = ''; $user = $this->getUser(); // Show checkboxes for each revision if ( $user->isAllowed( 'deleterevision' ) ) { $this->preventClickjacking(); // If revision was hidden from sysops, disable the checkbox if ( !$rev->userCan( Revision::DELETED_RESTRICTED, $user ) ) { $del = Xml::check( 'deleterevisions', false, array( 'disabled' => 'disabled' ) ); // Otherwise, enable the checkbox... } else { $del = Xml::check( 'showhiderevisions', false, array( 'name' => 'ids[' . $rev->getId() . ']' ) ); } // User can only view deleted revisions... } elseif ( $rev->getVisibility() && $user->isAllowed( 'deletedhistory' ) ) { // If revision was hidden from sysops, disable the link if ( !$rev->userCan( Revision::DELETED_RESTRICTED, $user ) ) { $del = Linker::revDeleteLinkDisabled( false ); // Otherwise, show the link... } else { $query = array( 'type' => 'revision', 'target' => $this->getTitle()->getPrefixedDBkey(), 'ids' => $rev->getId() ); $del .= Linker::revDeleteLink( $query, $rev->isDeleted( Revision::DELETED_RESTRICTED ), false ); } } if ( $del ) { $s .= " $del "; } $lang = $this->getLanguage(); $dirmark = $lang->getDirMark(); $s .= " $link"; $s .= $dirmark; $s .= " " . Linker::revUserTools( $rev, true ) . ""; $s .= $dirmark; if ( $rev->isMinor() ) { $s .= ' ' . ChangesList::flag( 'minor' ); } # Sometimes rev_len isn't populated if ( $rev->getSize() !== null ) { # Size is always public data $prevSize = isset( $this->parentLens[$row->rev_parent_id] ) ? $this->parentLens[$row->rev_parent_id] : 0; $sDiff = ChangesList::showCharacterDifference( $prevSize, $rev->getSize() ); $fSize = Linker::formatRevisionSize( $rev->getSize() ); $s .= ' . . ' . "$fSize $sDiff"; } # Text following the character difference is added just before running hooks $s2 = Linker::revComment( $rev, false, true ); if ( $notificationtimestamp && ( $row->rev_timestamp >= $notificationtimestamp ) ) { $s2 .= ' ' . $this->msg( 'updatedmarker' )->escaped() . ''; $classes[] = 'mw-history-line-updated'; } $tools = array(); # Rollback and undo links if ( $prevRev && $this->getTitle()->quickUserCan( 'edit', $user ) ) { if ( $latest && $this->getTitle()->quickUserCan( 'rollback', $user ) ) { // Get a rollback link without the brackets $rollbackLink = Linker::generateRollback( $rev, $this->getContext(), array( 'verify', 'noBrackets' ) ); if ( $rollbackLink ) { $this->preventClickjacking(); $tools[] = $rollbackLink; } } if ( !$rev->isDeleted( Revision::DELETED_TEXT ) && !$prevRev->isDeleted( Revision::DELETED_TEXT ) ) { # Create undo tooltip for the first (=latest) line only $undoTooltip = $latest ? array( 'title' => $this->msg( 'tooltip-undo' )->text() ) : array(); $undolink = Linker::linkKnown( $this->getTitle(), $this->msg( 'editundo' )->escaped(), $undoTooltip, array( 'action' => 'edit', 'undoafter' => $prevRev->getId(), 'undo' => $rev->getId() ) ); $tools[] = "{$undolink}"; } } // Allow extension to add their own links here wfRunHooks( 'HistoryRevisionTools', array( $rev, &$tools ) ); if ( $tools ) { $s2 .= ' ' . $this->msg( 'parentheses' )->rawParams( $lang->pipeList( $tools ) )->escaped(); } # Tags list( $tagSummary, $newClasses ) = ChangeTags::formatSummaryRow( $row->ts_tags, 'history' ); $classes = array_merge( $classes, $newClasses ); if ( $tagSummary !== '' ) { $s2 .= " $tagSummary"; } # Include separator between character difference and following text if ( $s2 !== '' ) { $s .= ' . . ' . $s2; } wfRunHooks( 'PageHistoryLineEnding', array( $this, &$row, &$s, &$classes ) ); $attribs = array(); if ( $classes ) { $attribs['class'] = implode( ' ', $classes ); } return Xml::tags( 'li', $attribs, $s ) . "\n"; } /** * Create a link to view this revision of the page * * @param Revision $rev * @return string */ function revLink( $rev ) { $date = $this->getLanguage()->userTimeAndDate( $rev->getTimestamp(), $this->getUser() ); $date = htmlspecialchars( $date ); if ( $rev->userCan( Revision::DELETED_TEXT, $this->getUser() ) ) { $link = Linker::linkKnown( $this->getTitle(), $date, array( 'class' => 'mw-changeslist-date' ), array( 'oldid' => $rev->getId() ) ); } else { $link = $date; } if ( $rev->isDeleted( Revision::DELETED_TEXT ) ) { $link = "$link"; } return $link; } /** * Create a diff-to-current link for this revision for this page * * @param Revision $rev * @param bool $latest This is the latest revision of the page? * @return string */ function curLink( $rev, $latest ) { $cur = $this->historyPage->message['cur']; if ( $latest || !$rev->userCan( Revision::DELETED_TEXT, $this->getUser() ) ) { return $cur; } else { return Linker::linkKnown( $this->getTitle(), $cur, array(), array( 'diff' => $this->getWikiPage()->getLatest(), 'oldid' => $rev->getId() ) ); } } /** * Create a diff-to-previous link for this revision for this page. * * @param Revision $prevRev The revision being displayed * @param stdClass|string|null $next The next revision in list (that is * the previous one in chronological order). * May either be a row, "unknown" or null. * @return string */ function lastLink( $prevRev, $next ) { $last = $this->historyPage->message['last']; if ( $next === null ) { # Probably no next row return $last; } if ( $next === 'unknown' ) { # Next row probably exists but is unknown, use an oldid=prev link return Linker::linkKnown( $this->getTitle(), $last, array(), array( 'diff' => $prevRev->getId(), 'oldid' => 'prev' ) ); } $nextRev = new Revision( $next ); if ( !$prevRev->userCan( Revision::DELETED_TEXT, $this->getUser() ) || !$nextRev->userCan( Revision::DELETED_TEXT, $this->getUser() ) ) { return $last; } return Linker::linkKnown( $this->getTitle(), $last, array(), array( 'diff' => $prevRev->getId(), 'oldid' => $next->rev_id ) ); } /** * Create radio buttons for page history * * @param Revision $rev * @param bool $firstInList Is this version the first one? * * @return string HTML output for the radio buttons */ 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 ) { $first = Xml::element( 'input', array_merge( $radio, array( 'style' => 'visibility:hidden', 'name' => 'oldid', 'id' => 'mw-oldid-null' ) ) ); $checkmark = array( 'checked' => 'checked' ); } else { # Check visibility of old revisions if ( !$rev->userCan( Revision::DELETED_TEXT, $this->getUser() ) ) { $radio['disabled'] = 'disabled'; $checkmark = array(); // We will check the next possible one } elseif ( !$this->oldIdChecked ) { $checkmark = array( 'checked' => 'checked' ); $this->oldIdChecked = $id; } else { $checkmark = array(); } $first = Xml::element( 'input', array_merge( $radio, $checkmark, array( 'name' => 'oldid', 'id' => "mw-oldid-$id" ) ) ); $checkmark = array(); } $second = Xml::element( 'input', array_merge( $radio, $checkmark, array( 'name' => 'diff', 'id' => "mw-diff-$id" ) ) ); return $first . $second; } else { return ''; } } /** * This is called if a write operation is possible from the generated HTML * @param bool $enable */ function preventClickjacking( $enable = true ) { $this->preventClickjacking = $enable; } /** * Get the "prevent clickjacking" flag * @return bool */ function getPreventClickjacking() { return $this->preventClickjacking; } }