3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 * http://www.gnu.org/copyleft/gpl.html
21 use MediaWiki\MediaWikiServices
;
22 use Wikimedia\Rdbms\ResultWrapper
;
23 use Wikimedia\Rdbms\IDatabase
;
26 * Used to show archived pages and eventually restore them.
33 protected $fileStatus;
36 protected $revisionStatus;
41 public function __construct( $title, Config
$config = null ) {
42 if ( is_null( $title ) ) {
43 throw new MWException( __METHOD__
. ' given a null title.' );
45 $this->title
= $title;
46 if ( $config === null ) {
47 wfDebug( __METHOD__
. ' did not have a Config object passed to it' );
48 $config = MediaWikiServices
::getInstance()->getMainConfig();
50 $this->config
= $config;
53 public function doesWrites() {
58 * List all deleted pages recorded in the archive table. Returns result
59 * wrapper with (ar_namespace, ar_title, count) fields, ordered by page
62 * @return ResultWrapper
64 public static function listAllPages() {
65 $dbr = wfGetDB( DB_REPLICA
);
67 return self
::listPages( $dbr, '' );
71 * List deleted pages recorded in the archive matching the
72 * given term, using search engine archive.
73 * Returns result wrapper with (ar_namespace, ar_title, count) fields.
75 * @param string $term Search term
76 * @return ResultWrapper
78 public static function listPagesBySearch( $term ) {
79 $title = Title
::newFromText( $term );
81 $ns = $title->getNamespace();
82 $termMain = $title->getText();
83 $termDb = $title->getDBkey();
85 // Prolly won't work too good
86 // @todo handle bare namespace names cleanly?
88 $termMain = $termDb = $term;
91 // Try search engine first
92 $engine = MediaWikiServices
::getInstance()->newSearchEngine();
93 $engine->setLimitOffset( 100 );
94 $engine->setNamespaces( [ $ns ] );
95 $results = $engine->searchArchiveTitle( $termMain );
96 if ( !$results->isOK() ) {
99 $results = $results->getValue();
103 // Fall back to regular prefix search
104 return self
::listPagesByPrefix( $term );
107 $dbr = wfGetDB( DB_REPLICA
);
108 $condTitles = array_unique( array_map( function ( Title
$t ) {
109 return $t->getDBkey();
112 'ar_namespace' => $ns,
113 $dbr->makeList( [ 'ar_title' => $condTitles ], LIST_OR
) . " OR ar_title " .
114 $dbr->buildLike( $termDb, $dbr->anyString() )
117 return self
::listPages( $dbr, $conds );
121 * List deleted pages recorded in the archive table matching the
122 * given title prefix.
123 * Returns result wrapper with (ar_namespace, ar_title, count) fields.
125 * @param string $prefix Title prefix
126 * @return ResultWrapper
128 public static function listPagesByPrefix( $prefix ) {
129 $dbr = wfGetDB( DB_REPLICA
);
131 $title = Title
::newFromText( $prefix );
133 $ns = $title->getNamespace();
134 $prefix = $title->getDBkey();
136 // Prolly won't work too good
137 // @todo handle bare namespace names cleanly?
142 'ar_namespace' => $ns,
143 'ar_title' . $dbr->buildLike( $prefix, $dbr->anyString() ),
146 return self
::listPages( $dbr, $conds );
150 * @param IDatabase $dbr
151 * @param string|array $condition
152 * @return bool|ResultWrapper
154 protected static function listPages( $dbr, $condition ) {
160 'count' => 'COUNT(*)'
165 'GROUP BY' => [ 'ar_namespace', 'ar_title' ],
166 'ORDER BY' => [ 'ar_namespace', 'ar_title' ],
173 * List the revisions of the given page. Returns result wrapper with
174 * various archive table fields.
176 * @return ResultWrapper
178 public function listRevisions() {
179 $dbr = wfGetDB( DB_REPLICA
);
180 $commentQuery = CommentStore
::newKey( 'ar_comment' )->getJoin();
182 $tables = [ 'archive' ] +
$commentQuery['tables'];
185 'ar_minor_edit', 'ar_timestamp', 'ar_user', 'ar_user_text',
186 'ar_len', 'ar_deleted', 'ar_rev_id', 'ar_sha1',
188 ] +
$commentQuery['fields'];
190 if ( $this->config
->get( 'ContentHandlerUseDB' ) ) {
191 $fields[] = 'ar_content_format';
192 $fields[] = 'ar_content_model';
195 $conds = [ 'ar_namespace' => $this->title
->getNamespace(),
196 'ar_title' => $this->title
->getDBkey() ];
198 $options = [ 'ORDER BY' => 'ar_timestamp DESC' ];
200 $join_conds = [] +
$commentQuery['joins'];
202 ChangeTags
::modifyDisplayQuery(
211 return $dbr->select( $tables,
221 * List the deleted file revisions for this page, if it's a file page.
222 * Returns a result wrapper with various filearchive fields, or null
223 * if not a file page.
225 * @return ResultWrapper
226 * @todo Does this belong in Image for fuller encapsulation?
228 public function listFiles() {
229 if ( $this->title
->getNamespace() != NS_FILE
) {
233 $dbr = wfGetDB( DB_REPLICA
);
234 $fileQuery = ArchivedFile
::getQueryInfo();
236 $fileQuery['tables'],
237 $fileQuery['fields'],
238 [ 'fa_name' => $this->title
->getDBkey() ],
240 [ 'ORDER BY' => 'fa_timestamp DESC' ],
246 * Return a Revision object containing data for the deleted revision.
247 * Note that the result *may* or *may not* have a null page ID.
249 * @param string $timestamp
250 * @return Revision|null
252 public function getRevision( $timestamp ) {
253 $dbr = wfGetDB( DB_REPLICA
);
254 $arQuery = Revision
::getArchiveQueryInfo();
256 $row = $dbr->selectRow(
260 'ar_namespace' => $this->title
->getNamespace(),
261 'ar_title' => $this->title
->getDBkey(),
262 'ar_timestamp' => $dbr->timestamp( $timestamp )
270 return Revision
::newFromArchiveRow( $row, [ 'title' => $this->title
] );
277 * Return the most-previous revision, either live or deleted, against
278 * the deleted revision given by timestamp.
280 * May produce unexpected results in case of history merges or other
281 * unusual time issues.
283 * @param string $timestamp
284 * @return Revision|null Null when there is no previous revision
286 public function getPreviousRevision( $timestamp ) {
287 $dbr = wfGetDB( DB_REPLICA
);
289 // Check the previous deleted revision...
290 $row = $dbr->selectRow( 'archive',
292 [ 'ar_namespace' => $this->title
->getNamespace(),
293 'ar_title' => $this->title
->getDBkey(),
295 $dbr->addQuotes( $dbr->timestamp( $timestamp ) ) ],
298 'ORDER BY' => 'ar_timestamp DESC',
300 $prevDeleted = $row ?
wfTimestamp( TS_MW
, $row->ar_timestamp
) : false;
302 $row = $dbr->selectRow( [ 'page', 'revision' ],
303 [ 'rev_id', 'rev_timestamp' ],
305 'page_namespace' => $this->title
->getNamespace(),
306 'page_title' => $this->title
->getDBkey(),
307 'page_id = rev_page',
309 $dbr->addQuotes( $dbr->timestamp( $timestamp ) ) ],
312 'ORDER BY' => 'rev_timestamp DESC',
314 $prevLive = $row ?
wfTimestamp( TS_MW
, $row->rev_timestamp
) : false;
315 $prevLiveId = $row ?
intval( $row->rev_id
) : null;
317 if ( $prevLive && $prevLive > $prevDeleted ) {
318 // Most prior revision was live
319 return Revision
::newFromId( $prevLiveId );
320 } elseif ( $prevDeleted ) {
321 // Most prior revision was deleted
322 return $this->getRevision( $prevDeleted );
325 // No prior revision on this page.
330 * Get the text from an archive row containing ar_text, ar_flags and ar_text_id
332 * @param object $row Database row
335 public function getTextFromRow( $row ) {
336 if ( is_null( $row->ar_text_id
) ) {
337 // An old row from MediaWiki 1.4 or previous.
338 // Text is embedded in this row in classic compression format.
339 return Revision
::getRevisionText( $row, 'ar_' );
342 // New-style: keyed to the text storage backend.
343 $dbr = wfGetDB( DB_REPLICA
);
344 $text = $dbr->selectRow( 'text',
345 [ 'old_text', 'old_flags' ],
346 [ 'old_id' => $row->ar_text_id
],
349 return Revision
::getRevisionText( $text );
353 * Fetch (and decompress if necessary) the stored text of the most
354 * recently edited deleted revision of the page.
356 * If there are no archived revisions for the page, returns NULL.
358 * @return string|null
360 public function getLastRevisionText() {
361 $dbr = wfGetDB( DB_REPLICA
);
362 $row = $dbr->selectRow( 'archive',
363 [ 'ar_text', 'ar_flags', 'ar_text_id' ],
364 [ 'ar_namespace' => $this->title
->getNamespace(),
365 'ar_title' => $this->title
->getDBkey() ],
367 [ 'ORDER BY' => 'ar_timestamp DESC' ] );
370 return $this->getTextFromRow( $row );
377 * Quick check if any archived revisions are present for the page.
381 public function isDeleted() {
382 $dbr = wfGetDB( DB_REPLICA
);
383 $n = $dbr->selectField( 'archive', 'COUNT(ar_title)',
384 [ 'ar_namespace' => $this->title
->getNamespace(),
385 'ar_title' => $this->title
->getDBkey() ],
393 * Restore the given (or all) text and file revisions for the page.
394 * Once restored, the items will be removed from the archive tables.
395 * The deletion log will be updated with an undeletion notice.
397 * This also sets Status objects, $this->fileStatus and $this->revisionStatus
398 * (depending what operations are attempted).
400 * @param array $timestamps Pass an empty array to restore all revisions,
401 * otherwise list the ones to undelete.
402 * @param string $comment
403 * @param array $fileVersions
404 * @param bool $unsuppress
405 * @param User $user User performing the action, or null to use $wgUser
406 * @param string|string[] $tags Change tags to add to log entry
407 * ($user should be able to add the specified tags before this is called)
408 * @return array|bool array(number of file revisions restored, number of image revisions
409 * restored, log message) on success, false on failure.
411 public function undelete( $timestamps, $comment = '', $fileVersions = [],
412 $unsuppress = false, User
$user = null, $tags = null
414 // If both the set of text revisions and file revisions are empty,
415 // restore everything. Otherwise, just restore the requested items.
416 $restoreAll = empty( $timestamps ) && empty( $fileVersions );
418 $restoreText = $restoreAll ||
!empty( $timestamps );
419 $restoreFiles = $restoreAll ||
!empty( $fileVersions );
421 if ( $restoreFiles && $this->title
->getNamespace() == NS_FILE
) {
422 $img = wfLocalFile( $this->title
);
423 $img->load( File
::READ_LATEST
);
424 $this->fileStatus
= $img->restore( $fileVersions, $unsuppress );
425 if ( !$this->fileStatus
->isOK() ) {
428 $filesRestored = $this->fileStatus
->successCount
;
433 if ( $restoreText ) {
434 $this->revisionStatus
= $this->undeleteRevisions( $timestamps, $unsuppress, $comment );
435 if ( !$this->revisionStatus
->isOK() ) {
439 $textRestored = $this->revisionStatus
->getValue();
446 if ( !$textRestored && !$filesRestored ) {
447 wfDebug( "Undelete: nothing undeleted...\n" );
452 if ( $user === null ) {
457 $logEntry = new ManualLogEntry( 'delete', 'restore' );
458 $logEntry->setPerformer( $user );
459 $logEntry->setTarget( $this->title
);
460 $logEntry->setComment( $comment );
461 $logEntry->setTags( $tags );
462 $logEntry->setParameters( [
464 'revisions' => $textRestored,
465 'files' => $filesRestored,
469 Hooks
::run( 'ArticleUndeleteLogEntry', [ $this, &$logEntry, $user ] );
471 $logid = $logEntry->insert();
472 $logEntry->publish( $logid );
474 return [ $textRestored, $filesRestored, $comment ];
478 * This is the meaty bit -- It restores archived revisions of the given page
479 * to the revision table.
481 * @param array $timestamps Pass an empty array to restore all revisions,
482 * otherwise list the ones to undelete.
483 * @param bool $unsuppress Remove all ar_deleted/fa_deleted restrictions of seletected revs
484 * @param string $comment
485 * @throws ReadOnlyError
486 * @return Status Status object containing the number of revisions restored on success
488 private function undeleteRevisions( $timestamps, $unsuppress = false, $comment = '' ) {
489 if ( wfReadOnly() ) {
490 throw new ReadOnlyError();
493 $dbw = wfGetDB( DB_MASTER
);
494 $dbw->startAtomic( __METHOD__
);
496 $restoreAll = empty( $timestamps );
498 # Does this page already exist? We'll have to update it...
499 $article = WikiPage
::factory( $this->title
);
500 # Load latest data for the current page (T33179)
501 $article->loadPageData( 'fromdbmaster' );
502 $oldcountable = $article->isCountable();
504 $page = $dbw->selectRow( 'page',
505 [ 'page_id', 'page_latest' ],
506 [ 'page_namespace' => $this->title
->getNamespace(),
507 'page_title' => $this->title
->getDBkey() ],
509 [ 'FOR UPDATE' ] // lock page
514 # Page already exists. Import the history, and if necessary
515 # we'll update the latest revision field in the record.
517 # Get the time span of this page
518 $previousTimestamp = $dbw->selectField( 'revision', 'rev_timestamp',
519 [ 'rev_id' => $page->page_latest
],
522 if ( $previousTimestamp === false ) {
523 wfDebug( __METHOD__
. ": existing page refers to a page_latest that does not exist\n" );
525 $status = Status
::newGood( 0 );
526 $status->warning( 'undeleterevision-missing' );
527 $dbw->endAtomic( __METHOD__
);
532 # Have to create a new article...
534 $previousTimestamp = 0;
538 'ar_namespace' => $this->title
->getNamespace(),
539 'ar_title' => $this->title
->getDBkey(),
541 if ( !$restoreAll ) {
542 $oldWhere['ar_timestamp'] = array_map( [ &$dbw, 'timestamp' ], $timestamps );
545 $commentQuery = CommentStore
::newKey( 'ar_comment' )->getJoin();
547 $tables = [ 'archive', 'revision' ] +
$commentQuery['tables'];
564 ] +
$commentQuery['fields'];
566 if ( $this->config
->get( 'ContentHandlerUseDB' ) ) {
567 $fields[] = 'ar_content_format';
568 $fields[] = 'ar_content_model';
572 'revision' => [ 'LEFT JOIN', 'ar_rev_id=rev_id' ],
573 ] +
$commentQuery['joins'];
576 * Select each archived revision...
578 $result = $dbw->select(
584 [ 'ORDER BY' => 'ar_timestamp' ],
588 $rev_count = $result->numRows();
590 wfDebug( __METHOD__
. ": no revisions to restore\n" );
592 $status = Status
::newGood( 0 );
593 $status->warning( "undelete-no-results" );
594 $dbw->endAtomic( __METHOD__
);
599 // We use ar_id because there can be duplicate ar_rev_id even for the same
600 // page. In this case, we may be able to restore the first one.
601 $restoreFailedArIds = [];
603 // Map rev_id to the ar_id that is allowed to use it. When checking later,
604 // if it doesn't match, the current ar_id can not be restored.
606 // Value can be an ar_id or -1 (-1 means no ar_id can use it, since the
607 // rev_id is taken before we even start the restore).
608 $allowedRevIdToArIdMap = [];
610 $latestRestorableRow = null;
612 foreach ( $result as $row ) {
613 if ( $row->ar_rev_id
) {
614 // rev_id is taken even before we start restoring.
615 if ( $row->ar_rev_id
=== $row->rev_id
) {
616 $restoreFailedArIds[] = $row->ar_id
;
617 $allowedRevIdToArIdMap[$row->ar_rev_id
] = -1;
619 // rev_id is not taken yet in the DB, but it might be taken
620 // by a prior revision in the same restore operation. If
621 // not, we need to reserve it.
622 if ( isset( $allowedRevIdToArIdMap[$row->ar_rev_id
] ) ) {
623 $restoreFailedArIds[] = $row->ar_id
;
625 $allowedRevIdToArIdMap[$row->ar_rev_id
] = $row->ar_id
;
626 $latestRestorableRow = $row;
630 // If ar_rev_id is null, there can't be a collision, and a
631 // rev_id will be chosen automatically.
632 $latestRestorableRow = $row;
636 $result->seek( 0 ); // move back
639 if ( $latestRestorableRow !== null ) {
640 $oldPageId = (int)$latestRestorableRow->ar_page_id
; // pass this to ArticleUndelete hook
642 // grab the content to check consistency with global state before restoring the page.
643 $revision = Revision
::newFromArchiveRow( $latestRestorableRow,
645 'title' => $article->getTitle(), // used to derive default content model
648 $user = User
::newFromName( $revision->getUserText( Revision
::RAW
), false );
649 $content = $revision->getContent( Revision
::RAW
);
651 // NOTE: article ID may not be known yet. prepareSave() should not modify the database.
652 $status = $content->prepareSave( $article, 0, -1, $user );
653 if ( !$status->isOK() ) {
654 $dbw->endAtomic( __METHOD__
);
660 $newid = false; // newly created page ID
661 $restored = 0; // number of revisions restored
662 /** @var Revision $revision */
665 // If there are no restorable revisions, we can skip most of the steps.
666 if ( $latestRestorableRow === null ) {
667 $failedRevisionCount = $rev_count;
670 // Check the state of the newest to-be version...
672 && ( $latestRestorableRow->ar_deleted
& Revision
::DELETED_TEXT
)
674 $dbw->endAtomic( __METHOD__
);
676 return Status
::newFatal( "undeleterevdel" );
678 // Safe to insert now...
679 $newid = $article->insertOn( $dbw, $latestRestorableRow->ar_page_id
);
680 if ( $newid === false ) {
681 // The old ID is reserved; let's pick another
682 $newid = $article->insertOn( $dbw );
686 // Check if a deleted revision will become the current revision...
687 if ( $latestRestorableRow->ar_timestamp
> $previousTimestamp ) {
688 // Check the state of the newest to-be version...
690 && ( $latestRestorableRow->ar_deleted
& Revision
::DELETED_TEXT
)
692 $dbw->endAtomic( __METHOD__
);
694 return Status
::newFatal( "undeleterevdel" );
699 $pageId = $article->getId();
702 foreach ( $result as $row ) {
703 // Check for key dupes due to needed archive integrity.
704 if ( $row->ar_rev_id
&& $allowedRevIdToArIdMap[$row->ar_rev_id
] !== $row->ar_id
) {
707 // Insert one revision at a time...maintaining deletion status
708 // unless we are specifically removing all restrictions...
709 $revision = Revision
::newFromArchiveRow( $row,
712 'title' => $this->title
,
713 'deleted' => $unsuppress ?
0 : $row->ar_deleted
716 // This will also copy the revision to ip_changes if it was an IP edit.
717 $revision->insertOn( $dbw );
721 Hooks
::run( 'ArticleRevisionUndeleted',
722 [ &$this->title
, $revision, $row->ar_page_id
] );
723 $restoredPages[$row->ar_page_id
] = true;
726 // Now that it's safely stored, take it out of the archive
727 // Don't delete rows that we failed to restore
728 $toDeleteConds = $oldWhere;
729 $failedRevisionCount = count( $restoreFailedArIds );
730 if ( $failedRevisionCount > 0 ) {
731 $toDeleteConds[] = 'ar_id NOT IN ( ' . $dbw->makeList( $restoreFailedArIds ) . ' )';
734 $dbw->delete( 'archive',
739 $status = Status
::newGood( $restored );
741 if ( $failedRevisionCount > 0 ) {
743 wfMessage( 'undeleterevision-duplicate-revid', $failedRevisionCount ) );
746 // Was anything restored at all?
748 $created = (bool)$newid;
749 // Attach the latest revision to the page...
750 $wasnew = $article->updateIfNewerOn( $dbw, $revision );
751 if ( $created ||
$wasnew ) {
752 // Update site stats, link tables, etc
753 $article->doEditUpdates(
755 User
::newFromName( $revision->getUserText( Revision
::RAW
), false ),
757 'created' => $created,
758 'oldcountable' => $oldcountable,
764 Hooks
::run( 'ArticleUndelete',
765 [ &$this->title
, $created, $comment, $oldPageId, $restoredPages ] );
766 if ( $this->title
->getNamespace() == NS_FILE
) {
767 DeferredUpdates
::addUpdate(
768 new HTMLCacheUpdate( $this->title
, 'imagelinks', 'file-restore' )
773 $dbw->endAtomic( __METHOD__
);
781 public function getFileStatus() {
782 return $this->fileStatus
;
788 public function getRevisionStatus() {
789 return $this->revisionStatus
;