title = $title; if ( $config === null ) { wfDebug( __METHOD__ . ' did not have a Config object passed to it' ); $config = ConfigFactory::getDefaultInstance()->makeConfig( 'main' ); } $this->config = $config; } /** * List all deleted pages recorded in the archive table. Returns result * wrapper with (ar_namespace, ar_title, count) fields, ordered by page * namespace/title. * * @return ResultWrapper */ public static function listAllPages() { $dbr = wfGetDB( DB_SLAVE ); return self::listPages( $dbr, '' ); } /** * List deleted pages recorded in the archive table matching the * given title prefix. * Returns result wrapper with (ar_namespace, ar_title, count) fields. * * @param string $prefix Title prefix * @return ResultWrapper */ public static function listPagesByPrefix( $prefix ) { $dbr = wfGetDB( DB_SLAVE ); $title = Title::newFromText( $prefix ); if ( $title ) { $ns = $title->getNamespace(); $prefix = $title->getDBkey(); } else { // Prolly won't work too good // @todo handle bare namespace names cleanly? $ns = 0; } $conds = array( 'ar_namespace' => $ns, 'ar_title' . $dbr->buildLike( $prefix, $dbr->anyString() ), ); return self::listPages( $dbr, $conds ); } /** * @param IDatabase $dbr * @param string|array $condition * @return bool|ResultWrapper */ protected static function listPages( $dbr, $condition ) { return $dbr->select( array( 'archive' ), array( 'ar_namespace', 'ar_title', 'count' => 'COUNT(*)' ), $condition, __METHOD__, array( 'GROUP BY' => array( 'ar_namespace', 'ar_title' ), 'ORDER BY' => array( 'ar_namespace', 'ar_title' ), 'LIMIT' => 100, ) ); } /** * List the revisions of the given page. Returns result wrapper with * (ar_minor_edit, ar_timestamp, ar_user, ar_user_text, ar_comment) fields. * * @return ResultWrapper */ function listRevisions() { $dbr = wfGetDB( DB_SLAVE ); $tables = array( 'archive' ); $fields = array( 'ar_minor_edit', 'ar_timestamp', 'ar_user', 'ar_user_text', 'ar_comment', 'ar_len', 'ar_deleted', 'ar_rev_id', 'ar_sha1', ); if ( $this->config->get( 'ContentHandlerUseDB' ) ) { $fields[] = 'ar_content_format'; $fields[] = 'ar_content_model'; } $conds = array( 'ar_namespace' => $this->title->getNamespace(), 'ar_title' => $this->title->getDBkey() ); $options = array( 'ORDER BY' => 'ar_timestamp DESC' ); $join_conds = array(); ChangeTags::modifyDisplayQuery( $tables, $fields, $conds, $join_conds, $options, '' ); return $dbr->select( $tables, $fields, $conds, __METHOD__, $options, $join_conds ); } /** * List the deleted file revisions for this page, if it's a file page. * Returns a result wrapper with various filearchive fields, or null * if not a file page. * * @return ResultWrapper * @todo Does this belong in Image for fuller encapsulation? */ function listFiles() { if ( $this->title->getNamespace() != NS_FILE ) { return null; } $dbr = wfGetDB( DB_SLAVE ); return $dbr->select( 'filearchive', ArchivedFile::selectFields(), array( 'fa_name' => $this->title->getDBkey() ), __METHOD__, array( 'ORDER BY' => 'fa_timestamp DESC' ) ); } /** * Return a Revision object containing data for the deleted revision. * Note that the result *may* or *may not* have a null page ID. * * @param string $timestamp * @return Revision|null */ function getRevision( $timestamp ) { $dbr = wfGetDB( DB_SLAVE ); $fields = array( 'ar_rev_id', 'ar_text', 'ar_comment', 'ar_user', 'ar_user_text', 'ar_timestamp', 'ar_minor_edit', 'ar_flags', 'ar_text_id', 'ar_deleted', 'ar_len', 'ar_sha1', ); if ( $this->config->get( 'ContentHandlerUseDB' ) ) { $fields[] = 'ar_content_format'; $fields[] = 'ar_content_model'; } $row = $dbr->selectRow( 'archive', $fields, array( 'ar_namespace' => $this->title->getNamespace(), 'ar_title' => $this->title->getDBkey(), 'ar_timestamp' => $dbr->timestamp( $timestamp ) ), __METHOD__ ); if ( $row ) { return Revision::newFromArchiveRow( $row, array( 'title' => $this->title ) ); } return null; } /** * Return the most-previous revision, either live or deleted, against * the deleted revision given by timestamp. * * May produce unexpected results in case of history merges or other * unusual time issues. * * @param string $timestamp * @return Revision|null Null when there is no previous revision */ function getPreviousRevision( $timestamp ) { $dbr = wfGetDB( DB_SLAVE ); // Check the previous deleted revision... $row = $dbr->selectRow( 'archive', 'ar_timestamp', array( 'ar_namespace' => $this->title->getNamespace(), 'ar_title' => $this->title->getDBkey(), 'ar_timestamp < ' . $dbr->addQuotes( $dbr->timestamp( $timestamp ) ) ), __METHOD__, array( 'ORDER BY' => 'ar_timestamp DESC', 'LIMIT' => 1 ) ); $prevDeleted = $row ? wfTimestamp( TS_MW, $row->ar_timestamp ) : false; $row = $dbr->selectRow( array( 'page', 'revision' ), array( 'rev_id', 'rev_timestamp' ), array( 'page_namespace' => $this->title->getNamespace(), 'page_title' => $this->title->getDBkey(), 'page_id = rev_page', 'rev_timestamp < ' . $dbr->addQuotes( $dbr->timestamp( $timestamp ) ) ), __METHOD__, array( 'ORDER BY' => 'rev_timestamp DESC', 'LIMIT' => 1 ) ); $prevLive = $row ? wfTimestamp( TS_MW, $row->rev_timestamp ) : false; $prevLiveId = $row ? intval( $row->rev_id ) : null; if ( $prevLive && $prevLive > $prevDeleted ) { // Most prior revision was live return Revision::newFromId( $prevLiveId ); } elseif ( $prevDeleted ) { // Most prior revision was deleted return $this->getRevision( $prevDeleted ); } // No prior revision on this page. return null; } /** * Get the text from an archive row containing ar_text, ar_flags and ar_text_id * * @param object $row Database row * @return string */ function getTextFromRow( $row ) { if ( is_null( $row->ar_text_id ) ) { // An old row from MediaWiki 1.4 or previous. // Text is embedded in this row in classic compression format. return Revision::getRevisionText( $row, 'ar_' ); } // New-style: keyed to the text storage backend. $dbr = wfGetDB( DB_SLAVE ); $text = $dbr->selectRow( 'text', array( 'old_text', 'old_flags' ), array( 'old_id' => $row->ar_text_id ), __METHOD__ ); return Revision::getRevisionText( $text ); } /** * Fetch (and decompress if necessary) the stored text of the most * recently edited deleted revision of the page. * * If there are no archived revisions for the page, returns NULL. * * @return string|null */ function getLastRevisionText() { $dbr = wfGetDB( DB_SLAVE ); $row = $dbr->selectRow( 'archive', array( 'ar_text', 'ar_flags', 'ar_text_id' ), array( 'ar_namespace' => $this->title->getNamespace(), 'ar_title' => $this->title->getDBkey() ), __METHOD__, array( 'ORDER BY' => 'ar_timestamp DESC' ) ); if ( $row ) { return $this->getTextFromRow( $row ); } return null; } /** * Quick check if any archived revisions are present for the page. * * @return bool */ function isDeleted() { $dbr = wfGetDB( DB_SLAVE ); $n = $dbr->selectField( 'archive', 'COUNT(ar_title)', array( 'ar_namespace' => $this->title->getNamespace(), 'ar_title' => $this->title->getDBkey() ), __METHOD__ ); return ( $n > 0 ); } /** * Restore the given (or all) text and file revisions for the page. * Once restored, the items will be removed from the archive tables. * The deletion log will be updated with an undeletion notice. * * @param array $timestamps Pass an empty array to restore all revisions, * otherwise list the ones to undelete. * @param string $comment * @param array $fileVersions * @param bool $unsuppress * @param User $user User performing the action, or null to use $wgUser * @return array(number of file revisions restored, number of image revisions * restored, log message) on success, false on failure. */ function undelete( $timestamps, $comment = '', $fileVersions = array(), $unsuppress = false, User $user = null ) { // If both the set of text revisions and file revisions are empty, // restore everything. Otherwise, just restore the requested items. $restoreAll = empty( $timestamps ) && empty( $fileVersions ); $restoreText = $restoreAll || !empty( $timestamps ); $restoreFiles = $restoreAll || !empty( $fileVersions ); if ( $restoreFiles && $this->title->getNamespace() == NS_FILE ) { $img = wfLocalFile( $this->title ); $img->load( File::READ_LATEST ); $this->fileStatus = $img->restore( $fileVersions, $unsuppress ); if ( !$this->fileStatus->isOK() ) { return false; } $filesRestored = $this->fileStatus->successCount; } else { $filesRestored = 0; } if ( $restoreText ) { $this->revisionStatus = $this->undeleteRevisions( $timestamps, $unsuppress, $comment ); if ( !$this->revisionStatus->isOK() ) { return false; } $textRestored = $this->revisionStatus->getValue(); } else { $textRestored = 0; } // Touch the log! if ( $textRestored && $filesRestored ) { $reason = wfMessage( 'undeletedrevisions-files' ) ->numParams( $textRestored, $filesRestored )->inContentLanguage()->text(); } elseif ( $textRestored ) { $reason = wfMessage( 'undeletedrevisions' )->numParams( $textRestored ) ->inContentLanguage()->text(); } elseif ( $filesRestored ) { $reason = wfMessage( 'undeletedfiles' )->numParams( $filesRestored ) ->inContentLanguage()->text(); } else { wfDebug( "Undelete: nothing undeleted...\n" ); return false; } if ( trim( $comment ) != '' ) { $reason .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $comment; } if ( $user === null ) { global $wgUser; $user = $wgUser; } $logEntry = new ManualLogEntry( 'delete', 'restore' ); $logEntry->setPerformer( $user ); $logEntry->setTarget( $this->title ); $logEntry->setComment( $reason ); Hooks::run( 'ArticleUndeleteLogEntry', array( $this, &$logEntry, $user ) ); $logid = $logEntry->insert(); $logEntry->publish( $logid ); return array( $textRestored, $filesRestored, $reason ); } /** * This is the meaty bit -- restores archived revisions of the given page * to the cur/old tables. If the page currently exists, all revisions will * be stuffed into old, otherwise the most recent will go into cur. * * @param array $timestamps Pass an empty array to restore all revisions, * otherwise list the ones to undelete. * @param bool $unsuppress Remove all ar_deleted/fa_deleted restrictions of seletected revs * @param string $comment * @throws ReadOnlyError * @return Status Status object containing the number of revisions restored on success */ private function undeleteRevisions( $timestamps, $unsuppress = false, $comment = '' ) { if ( wfReadOnly() ) { throw new ReadOnlyError(); } $restoreAll = empty( $timestamps ); $dbw = wfGetDB( DB_MASTER ); # Does this page already exist? We'll have to update it... $article = WikiPage::factory( $this->title ); # Load latest data for the current page (bug 31179) $article->loadPageData( 'fromdbmaster' ); $oldcountable = $article->isCountable(); $page = $dbw->selectRow( 'page', array( 'page_id', 'page_latest' ), array( 'page_namespace' => $this->title->getNamespace(), 'page_title' => $this->title->getDBkey() ), __METHOD__, array( 'FOR UPDATE' ) // lock page ); if ( $page ) { $makepage = false; # Page already exists. Import the history, and if necessary # we'll update the latest revision field in the record. $previousRevId = $page->page_latest; # Get the time span of this page $previousTimestamp = $dbw->selectField( 'revision', 'rev_timestamp', array( 'rev_id' => $previousRevId ), __METHOD__ ); if ( $previousTimestamp === false ) { wfDebug( __METHOD__ . ": existing page refers to a page_latest that does not exist\n" ); $status = Status::newGood( 0 ); $status->warning( 'undeleterevision-missing' ); return $status; } } else { # Have to create a new article... $makepage = true; $previousRevId = 0; $previousTimestamp = 0; } $oldWhere = array( 'ar_namespace' => $this->title->getNamespace(), 'ar_title' => $this->title->getDBkey(), ); if ( !$restoreAll ) { $oldWhere['ar_timestamp'] = array_map( array( &$dbw, 'timestamp' ), $timestamps ); } $fields = array( 'ar_rev_id', 'ar_text', 'ar_comment', 'ar_user', 'ar_user_text', 'ar_timestamp', 'ar_minor_edit', 'ar_flags', 'ar_text_id', 'ar_deleted', 'ar_page_id', 'ar_len', 'ar_sha1' ); if ( $this->config->get( 'ContentHandlerUseDB' ) ) { $fields[] = 'ar_content_format'; $fields[] = 'ar_content_model'; } /** * Select each archived revision... */ $result = $dbw->select( 'archive', $fields, $oldWhere, __METHOD__, /* options */ array( 'ORDER BY' => 'ar_timestamp' ) ); $rev_count = $result->numRows(); if ( !$rev_count ) { wfDebug( __METHOD__ . ": no revisions to restore\n" ); $status = Status::newGood( 0 ); $status->warning( "undelete-no-results" ); return $status; } $result->seek( $rev_count - 1 ); // move to last $row = $result->fetchObject(); // get newest archived rev $oldPageId = (int)$row->ar_page_id; // pass this to ArticleUndelete hook $result->seek( 0 ); // move back // grab the content to check consistency with global state before restoring the page. $revision = Revision::newFromArchiveRow( $row, array( 'title' => $article->getTitle(), // used to derive default content model ) ); $user = User::newFromName( $revision->getUserText( Revision::RAW ), false ); $content = $revision->getContent( Revision::RAW ); //NOTE: article ID may not be known yet. prepareSave() should not modify the database. $status = $content->prepareSave( $article, 0, -1, $user ); if ( !$status->isOK() ) { return $status; } if ( $makepage ) { // Check the state of the newest to-be version... if ( !$unsuppress && ( $row->ar_deleted & Revision::DELETED_TEXT ) ) { return Status::newFatal( "undeleterevdel" ); } // Safe to insert now... $newid = $article->insertOn( $dbw ); $pageId = $newid; } else { // Check if a deleted revision will become the current revision... if ( $row->ar_timestamp > $previousTimestamp ) { // Check the state of the newest to-be version... if ( !$unsuppress && ( $row->ar_deleted & Revision::DELETED_TEXT ) ) { return Status::newFatal( "undeleterevdel" ); } } $newid = false; $pageId = $article->getId(); } $revision = null; $restored = 0; foreach ( $result as $row ) { // Check for key dupes due to shitty archive integrity. if ( $row->ar_rev_id ) { $exists = $dbw->selectField( 'revision', '1', array( 'rev_id' => $row->ar_rev_id ), __METHOD__ ); if ( $exists ) { continue; // don't throw DB errors } } // Insert one revision at a time...maintaining deletion status // unless we are specifically removing all restrictions... $revision = Revision::newFromArchiveRow( $row, array( 'page' => $pageId, 'title' => $this->title, 'deleted' => $unsuppress ? 0 : $row->ar_deleted ) ); $revision->insertOn( $dbw ); $restored++; Hooks::run( 'ArticleRevisionUndeleted', array( &$this->title, $revision, $row->ar_page_id ) ); } # Now that it's safely stored, take it out of the archive $dbw->delete( 'archive', $oldWhere, __METHOD__ ); // Was anything restored at all? if ( $restored == 0 ) { return Status::newGood( 0 ); } $created = (bool)$newid; // Attach the latest revision to the page... $wasnew = $article->updateIfNewerOn( $dbw, $revision, $previousRevId ); if ( $created || $wasnew ) { // Update site stats, link tables, etc $user = User::newFromName( $revision->getUserText( Revision::RAW ), false ); $article->doEditUpdates( $revision, $user, array( 'created' => $created, 'oldcountable' => $oldcountable ) ); } Hooks::run( 'ArticleUndelete', array( &$this->title, $created, $comment, $oldPageId ) ); if ( $this->title->getNamespace() == NS_FILE ) { $update = new HTMLCacheUpdate( $this->title, 'imagelinks' ); $update->doUpdate(); } return Status::newGood( $restored ); } /** * @return Status */ function getFileStatus() { return $this->fileStatus; } /** * @return Status */ function getRevisionStatus() { return $this->revisionStatus; } } /** * Special page allowing users with the appropriate permissions to view * and restore deleted content. * * @ingroup SpecialPage */ class SpecialUndelete extends SpecialPage { private $mAction; private $mTarget; private $mTimestamp; private $mRestore; private $mInvert; private $mFilename; private $mTargetTimestamp; private $mAllowed; private $mCanView; private $mComment; private $mToken; /** @var Title */ private $mTargetObj; function __construct() { parent::__construct( 'Undelete', 'deletedhistory' ); } function loadRequest( $par ) { $request = $this->getRequest(); $user = $this->getUser(); $this->mAction = $request->getVal( 'action' ); if ( $par !== null && $par !== '' ) { $this->mTarget = $par; } else { $this->mTarget = $request->getVal( 'target' ); } $this->mTargetObj = null; if ( $this->mTarget !== null && $this->mTarget !== '' ) { $this->mTargetObj = Title::newFromURL( $this->mTarget ); } $this->mSearchPrefix = $request->getText( 'prefix' ); $time = $request->getVal( 'timestamp' ); $this->mTimestamp = $time ? wfTimestamp( TS_MW, $time ) : ''; $this->mFilename = $request->getVal( 'file' ); $posted = $request->wasPosted() && $user->matchEditToken( $request->getVal( 'wpEditToken' ) ); $this->mRestore = $request->getCheck( 'restore' ) && $posted; $this->mInvert = $request->getCheck( 'invert' ) && $posted; $this->mPreview = $request->getCheck( 'preview' ) && $posted; $this->mDiff = $request->getCheck( 'diff' ); $this->mDiffOnly = $request->getBool( 'diffonly', $this->getUser()->getOption( 'diffonly' ) ); $this->mComment = $request->getText( 'wpComment' ); $this->mUnsuppress = $request->getVal( 'wpUnsuppress' ) && $user->isAllowed( 'suppressrevision' ); $this->mToken = $request->getVal( 'token' ); if ( $this->isAllowed( 'undelete' ) && !$user->isBlocked() ) { $this->mAllowed = true; // user can restore $this->mCanView = true; // user can view content } elseif ( $this->isAllowed( 'deletedtext' ) ) { $this->mAllowed = false; // user cannot restore $this->mCanView = true; // user can view content $this->mRestore = false; } else { // user can only view the list of revisions $this->mAllowed = false; $this->mCanView = false; $this->mTimestamp = ''; $this->mRestore = false; } if ( $this->mRestore || $this->mInvert ) { $timestamps = array(); $this->mFileVersions = array(); foreach ( $request->getValues() as $key => $val ) { $matches = array(); if ( preg_match( '/^ts(\d{14})$/', $key, $matches ) ) { array_push( $timestamps, $matches[1] ); } if ( preg_match( '/^fileid(\d+)$/', $key, $matches ) ) { $this->mFileVersions[] = intval( $matches[1] ); } } rsort( $timestamps ); $this->mTargetTimestamp = $timestamps; } } /** * Checks whether a user is allowed the permission for the * specific title if one is set. * * @param string $permission * @param User $user * @return bool */ protected function isAllowed( $permission, User $user = null ) { $user = $user ?: $this->getUser(); if ( $this->mTargetObj !== null ) { return $this->mTargetObj->userCan( $permission, $user ); } else { return $user->isAllowed( $permission ); } } function userCanExecute( User $user ) { return $this->isAllowed( $this->mRestriction, $user ); } function execute( $par ) { $this->useTransactionalTimeLimit(); $user = $this->getUser(); $this->setHeaders(); $this->outputHeader(); $this->loadRequest( $par ); $this->checkPermissions(); // Needs to be after mTargetObj is set $out = $this->getOutput(); if ( is_null( $this->mTargetObj ) ) { $out->addWikiMsg( 'undelete-header' ); # Not all users can just browse every deleted page from the list if ( $user->isAllowed( 'browsearchive' ) ) { $this->showSearchForm(); } return; } $this->addHelpLink( 'Help:Undelete' ); if ( $this->mAllowed ) { $out->setPageTitle( $this->msg( 'undeletepage' ) ); } else { $out->setPageTitle( $this->msg( 'viewdeletedpage' ) ); } $this->getSkin()->setRelevantTitle( $this->mTargetObj ); if ( $this->mTimestamp !== '' ) { $this->showRevision( $this->mTimestamp ); } elseif ( $this->mFilename !== null && $this->mTargetObj->inNamespace( NS_FILE ) ) { $file = new ArchivedFile( $this->mTargetObj, '', $this->mFilename ); // Check if user is allowed to see this file if ( !$file->exists() ) { $out->addWikiMsg( 'filedelete-nofile', $this->mFilename ); } elseif ( !$file->userCan( File::DELETED_FILE, $user ) ) { if ( $file->isDeleted( File::DELETED_RESTRICTED ) ) { throw new PermissionsError( 'suppressrevision' ); } else { throw new PermissionsError( 'deletedtext' ); } } elseif ( !$user->matchEditToken( $this->mToken, $this->mFilename ) ) { $this->showFileConfirmationForm( $this->mFilename ); } else { $this->showFile( $this->mFilename ); } } elseif ( $this->mRestore && $this->mAction == 'submit' ) { $this->undelete(); } else { $this->showHistory(); } } function showSearchForm() { $out = $this->getOutput(); $out->setPageTitle( $this->msg( 'undelete-search-title' ) ); $out->addHTML( Xml::openElement( 'form', array( 'method' => 'get', 'action' => wfScript() ) ) . Xml::fieldset( $this->msg( 'undelete-search-box' )->text() ) . Html::hidden( 'title', $this->getPageTitle()->getPrefixedDBkey() ) . Html::rawElement( 'label', array( 'for' => 'prefix' ), $this->msg( 'undelete-search-prefix' )->parse() ) . Xml::input( 'prefix', 20, $this->mSearchPrefix, array( 'id' => 'prefix', 'autofocus' => '' ) ) . ' ' . Xml::submitButton( $this->msg( 'undelete-search-submit' )->text() ) . Xml::closeElement( 'fieldset' ) . Xml::closeElement( 'form' ) ); # List undeletable articles if ( $this->mSearchPrefix ) { $result = PageArchive::listPagesByPrefix( $this->mSearchPrefix ); $this->showList( $result ); } } /** * Generic list of deleted pages * * @param ResultWrapper $result * @return bool */ private function showList( $result ) { $out = $this->getOutput(); if ( $result->numRows() == 0 ) { $out->addWikiMsg( 'undelete-no-results' ); return false; } $out->addWikiMsg( 'undeletepagetext', $this->getLanguage()->formatNum( $result->numRows() ) ); $undelete = $this->getPageTitle(); $out->addHTML( "