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 $revisionStore = MediaWikiServices
::getInstance()->getRevisionStore();
180 $queryInfo = $revisionStore->getArchiveQueryInfo();
183 'ar_namespace' => $this->title
->getNamespace(),
184 'ar_title' => $this->title
->getDBkey(),
186 $options = [ 'ORDER BY' => 'ar_timestamp DESC' ];
188 ChangeTags
::modifyDisplayQuery(
189 $queryInfo['tables'],
190 $queryInfo['fields'],
197 $dbr = wfGetDB( DB_REPLICA
);
199 $queryInfo['tables'],
200 $queryInfo['fields'],
209 * List the deleted file revisions for this page, if it's a file page.
210 * Returns a result wrapper with various filearchive fields, or null
211 * if not a file page.
213 * @return ResultWrapper
214 * @todo Does this belong in Image for fuller encapsulation?
216 public function listFiles() {
217 if ( $this->title
->getNamespace() != NS_FILE
) {
221 $dbr = wfGetDB( DB_REPLICA
);
222 $fileQuery = ArchivedFile
::getQueryInfo();
224 $fileQuery['tables'],
225 $fileQuery['fields'],
226 [ 'fa_name' => $this->title
->getDBkey() ],
228 [ 'ORDER BY' => 'fa_timestamp DESC' ],
234 * Return a Revision object containing data for the deleted revision.
235 * Note that the result *may* or *may not* have a null page ID.
237 * @param string $timestamp
238 * @return Revision|null
240 public function getRevision( $timestamp ) {
241 $dbr = wfGetDB( DB_REPLICA
);
242 $arQuery = Revision
::getArchiveQueryInfo();
244 $row = $dbr->selectRow(
248 'ar_namespace' => $this->title
->getNamespace(),
249 'ar_title' => $this->title
->getDBkey(),
250 'ar_timestamp' => $dbr->timestamp( $timestamp )
258 return Revision
::newFromArchiveRow( $row, [ 'title' => $this->title
] );
265 * Return the most-previous revision, either live or deleted, against
266 * the deleted revision given by timestamp.
268 * May produce unexpected results in case of history merges or other
269 * unusual time issues.
271 * @param string $timestamp
272 * @return Revision|null Null when there is no previous revision
274 public function getPreviousRevision( $timestamp ) {
275 $dbr = wfGetDB( DB_REPLICA
);
277 // Check the previous deleted revision...
278 $row = $dbr->selectRow( 'archive',
280 [ 'ar_namespace' => $this->title
->getNamespace(),
281 'ar_title' => $this->title
->getDBkey(),
283 $dbr->addQuotes( $dbr->timestamp( $timestamp ) ) ],
286 'ORDER BY' => 'ar_timestamp DESC',
288 $prevDeleted = $row ?
wfTimestamp( TS_MW
, $row->ar_timestamp
) : false;
290 $row = $dbr->selectRow( [ 'page', 'revision' ],
291 [ 'rev_id', 'rev_timestamp' ],
293 'page_namespace' => $this->title
->getNamespace(),
294 'page_title' => $this->title
->getDBkey(),
295 'page_id = rev_page',
297 $dbr->addQuotes( $dbr->timestamp( $timestamp ) ) ],
300 'ORDER BY' => 'rev_timestamp DESC',
302 $prevLive = $row ?
wfTimestamp( TS_MW
, $row->rev_timestamp
) : false;
303 $prevLiveId = $row ?
intval( $row->rev_id
) : null;
305 if ( $prevLive && $prevLive > $prevDeleted ) {
306 // Most prior revision was live
307 return Revision
::newFromId( $prevLiveId );
308 } elseif ( $prevDeleted ) {
309 // Most prior revision was deleted
310 return $this->getRevision( $prevDeleted );
313 // No prior revision on this page.
318 * Get the text from an archive row containing ar_text, ar_flags and ar_text_id
320 * @param object $row Database row
323 public function getTextFromRow( $row ) {
324 if ( is_null( $row->ar_text_id
) ) {
325 // An old row from MediaWiki 1.4 or previous.
326 // Text is embedded in this row in classic compression format.
327 return Revision
::getRevisionText( $row, 'ar_' );
330 // New-style: keyed to the text storage backend.
331 $dbr = wfGetDB( DB_REPLICA
);
332 $text = $dbr->selectRow( 'text',
333 [ 'old_text', 'old_flags' ],
334 [ 'old_id' => $row->ar_text_id
],
337 return Revision
::getRevisionText( $text );
341 * Fetch (and decompress if necessary) the stored text of the most
342 * recently edited deleted revision of the page.
344 * If there are no archived revisions for the page, returns NULL.
346 * @return string|null
348 public function getLastRevisionText() {
349 $dbr = wfGetDB( DB_REPLICA
);
350 $row = $dbr->selectRow( 'archive',
351 [ 'ar_text', 'ar_flags', 'ar_text_id' ],
352 [ 'ar_namespace' => $this->title
->getNamespace(),
353 'ar_title' => $this->title
->getDBkey() ],
355 [ 'ORDER BY' => 'ar_timestamp DESC' ] );
358 return $this->getTextFromRow( $row );
365 * Quick check if any archived revisions are present for the page.
369 public function isDeleted() {
370 $dbr = wfGetDB( DB_REPLICA
);
371 $n = $dbr->selectField( 'archive', 'COUNT(ar_title)',
372 [ 'ar_namespace' => $this->title
->getNamespace(),
373 'ar_title' => $this->title
->getDBkey() ],
381 * Restore the given (or all) text and file revisions for the page.
382 * Once restored, the items will be removed from the archive tables.
383 * The deletion log will be updated with an undeletion notice.
385 * This also sets Status objects, $this->fileStatus and $this->revisionStatus
386 * (depending what operations are attempted).
388 * @param array $timestamps Pass an empty array to restore all revisions,
389 * otherwise list the ones to undelete.
390 * @param string $comment
391 * @param array $fileVersions
392 * @param bool $unsuppress
393 * @param User $user User performing the action, or null to use $wgUser
394 * @param string|string[] $tags Change tags to add to log entry
395 * ($user should be able to add the specified tags before this is called)
396 * @return array|bool array(number of file revisions restored, number of image revisions
397 * restored, log message) on success, false on failure.
399 public function undelete( $timestamps, $comment = '', $fileVersions = [],
400 $unsuppress = false, User
$user = null, $tags = null
402 // If both the set of text revisions and file revisions are empty,
403 // restore everything. Otherwise, just restore the requested items.
404 $restoreAll = empty( $timestamps ) && empty( $fileVersions );
406 $restoreText = $restoreAll ||
!empty( $timestamps );
407 $restoreFiles = $restoreAll ||
!empty( $fileVersions );
409 if ( $restoreFiles && $this->title
->getNamespace() == NS_FILE
) {
410 $img = wfLocalFile( $this->title
);
411 $img->load( File
::READ_LATEST
);
412 $this->fileStatus
= $img->restore( $fileVersions, $unsuppress );
413 if ( !$this->fileStatus
->isOK() ) {
416 $filesRestored = $this->fileStatus
->successCount
;
421 if ( $restoreText ) {
422 $this->revisionStatus
= $this->undeleteRevisions( $timestamps, $unsuppress, $comment );
423 if ( !$this->revisionStatus
->isOK() ) {
427 $textRestored = $this->revisionStatus
->getValue();
434 if ( !$textRestored && !$filesRestored ) {
435 wfDebug( "Undelete: nothing undeleted...\n" );
440 if ( $user === null ) {
445 $logEntry = new ManualLogEntry( 'delete', 'restore' );
446 $logEntry->setPerformer( $user );
447 $logEntry->setTarget( $this->title
);
448 $logEntry->setComment( $comment );
449 $logEntry->setTags( $tags );
450 $logEntry->setParameters( [
452 'revisions' => $textRestored,
453 'files' => $filesRestored,
457 Hooks
::run( 'ArticleUndeleteLogEntry', [ $this, &$logEntry, $user ] );
459 $logid = $logEntry->insert();
460 $logEntry->publish( $logid );
462 return [ $textRestored, $filesRestored, $comment ];
466 * This is the meaty bit -- It restores archived revisions of the given page
467 * to the revision table.
469 * @param array $timestamps Pass an empty array to restore all revisions,
470 * otherwise list the ones to undelete.
471 * @param bool $unsuppress Remove all ar_deleted/fa_deleted restrictions of seletected revs
472 * @param string $comment
473 * @throws ReadOnlyError
474 * @return Status Status object containing the number of revisions restored on success
476 private function undeleteRevisions( $timestamps, $unsuppress = false, $comment = '' ) {
477 if ( wfReadOnly() ) {
478 throw new ReadOnlyError();
481 $dbw = wfGetDB( DB_MASTER
);
482 $dbw->startAtomic( __METHOD__
);
484 $restoreAll = empty( $timestamps );
486 # Does this page already exist? We'll have to update it...
487 $article = WikiPage
::factory( $this->title
);
488 # Load latest data for the current page (T33179)
489 $article->loadPageData( 'fromdbmaster' );
490 $oldcountable = $article->isCountable();
492 $page = $dbw->selectRow( 'page',
493 [ 'page_id', 'page_latest' ],
494 [ 'page_namespace' => $this->title
->getNamespace(),
495 'page_title' => $this->title
->getDBkey() ],
497 [ 'FOR UPDATE' ] // lock page
502 # Page already exists. Import the history, and if necessary
503 # we'll update the latest revision field in the record.
505 # Get the time span of this page
506 $previousTimestamp = $dbw->selectField( 'revision', 'rev_timestamp',
507 [ 'rev_id' => $page->page_latest
],
510 if ( $previousTimestamp === false ) {
511 wfDebug( __METHOD__
. ": existing page refers to a page_latest that does not exist\n" );
513 $status = Status
::newGood( 0 );
514 $status->warning( 'undeleterevision-missing' );
515 $dbw->endAtomic( __METHOD__
);
520 # Have to create a new article...
522 $previousTimestamp = 0;
526 'ar_namespace' => $this->title
->getNamespace(),
527 'ar_title' => $this->title
->getDBkey(),
529 if ( !$restoreAll ) {
530 $oldWhere['ar_timestamp'] = array_map( [ &$dbw, 'timestamp' ], $timestamps );
533 $revisionStore = MediaWikiServices
::getInstance()->getRevisionStore();
534 $queryInfo = $revisionStore->getArchiveQueryInfo();
535 $queryInfo['tables'][] = 'revision';
536 $queryInfo['fields'][] = 'rev_id';
537 $queryInfo['joins']['revision'] = [ 'LEFT JOIN', 'ar_rev_id=rev_id' ];
540 * Select each archived revision...
542 $result = $dbw->select(
543 $queryInfo['tables'],
544 $queryInfo['fields'],
548 [ 'ORDER BY' => 'ar_timestamp' ],
552 $rev_count = $result->numRows();
554 wfDebug( __METHOD__
. ": no revisions to restore\n" );
556 $status = Status
::newGood( 0 );
557 $status->warning( "undelete-no-results" );
558 $dbw->endAtomic( __METHOD__
);
563 // We use ar_id because there can be duplicate ar_rev_id even for the same
564 // page. In this case, we may be able to restore the first one.
565 $restoreFailedArIds = [];
567 // Map rev_id to the ar_id that is allowed to use it. When checking later,
568 // if it doesn't match, the current ar_id can not be restored.
570 // Value can be an ar_id or -1 (-1 means no ar_id can use it, since the
571 // rev_id is taken before we even start the restore).
572 $allowedRevIdToArIdMap = [];
574 $latestRestorableRow = null;
576 foreach ( $result as $row ) {
577 if ( $row->ar_rev_id
) {
578 // rev_id is taken even before we start restoring.
579 if ( $row->ar_rev_id
=== $row->rev_id
) {
580 $restoreFailedArIds[] = $row->ar_id
;
581 $allowedRevIdToArIdMap[$row->ar_rev_id
] = -1;
583 // rev_id is not taken yet in the DB, but it might be taken
584 // by a prior revision in the same restore operation. If
585 // not, we need to reserve it.
586 if ( isset( $allowedRevIdToArIdMap[$row->ar_rev_id
] ) ) {
587 $restoreFailedArIds[] = $row->ar_id
;
589 $allowedRevIdToArIdMap[$row->ar_rev_id
] = $row->ar_id
;
590 $latestRestorableRow = $row;
594 // If ar_rev_id is null, there can't be a collision, and a
595 // rev_id will be chosen automatically.
596 $latestRestorableRow = $row;
600 $result->seek( 0 ); // move back
603 if ( $latestRestorableRow !== null ) {
604 $oldPageId = (int)$latestRestorableRow->ar_page_id
; // pass this to ArticleUndelete hook
606 // grab the content to check consistency with global state before restoring the page.
607 $revision = Revision
::newFromArchiveRow( $latestRestorableRow,
609 'title' => $article->getTitle(), // used to derive default content model
612 $user = User
::newFromName( $revision->getUserText( Revision
::RAW
), false );
613 $content = $revision->getContent( Revision
::RAW
);
615 // NOTE: article ID may not be known yet. prepareSave() should not modify the database.
616 $status = $content->prepareSave( $article, 0, -1, $user );
617 if ( !$status->isOK() ) {
618 $dbw->endAtomic( __METHOD__
);
624 $newid = false; // newly created page ID
625 $restored = 0; // number of revisions restored
626 /** @var Revision $revision */
629 // If there are no restorable revisions, we can skip most of the steps.
630 if ( $latestRestorableRow === null ) {
631 $failedRevisionCount = $rev_count;
634 // Check the state of the newest to-be version...
636 && ( $latestRestorableRow->ar_deleted
& Revision
::DELETED_TEXT
)
638 $dbw->endAtomic( __METHOD__
);
640 return Status
::newFatal( "undeleterevdel" );
642 // Safe to insert now...
643 $newid = $article->insertOn( $dbw, $latestRestorableRow->ar_page_id
);
644 if ( $newid === false ) {
645 // The old ID is reserved; let's pick another
646 $newid = $article->insertOn( $dbw );
650 // Check if a deleted revision will become the current revision...
651 if ( $latestRestorableRow->ar_timestamp
> $previousTimestamp ) {
652 // Check the state of the newest to-be version...
654 && ( $latestRestorableRow->ar_deleted
& Revision
::DELETED_TEXT
)
656 $dbw->endAtomic( __METHOD__
);
658 return Status
::newFatal( "undeleterevdel" );
663 $pageId = $article->getId();
666 foreach ( $result as $row ) {
667 // Check for key dupes due to needed archive integrity.
668 if ( $row->ar_rev_id
&& $allowedRevIdToArIdMap[$row->ar_rev_id
] !== $row->ar_id
) {
671 // Insert one revision at a time...maintaining deletion status
672 // unless we are specifically removing all restrictions...
673 $revision = Revision
::newFromArchiveRow( $row,
676 'title' => $this->title
,
677 'deleted' => $unsuppress ?
0 : $row->ar_deleted
680 // This will also copy the revision to ip_changes if it was an IP edit.
681 $revision->insertOn( $dbw );
685 Hooks
::run( 'ArticleRevisionUndeleted',
686 [ &$this->title
, $revision, $row->ar_page_id
] );
687 $restoredPages[$row->ar_page_id
] = true;
690 // Now that it's safely stored, take it out of the archive
691 // Don't delete rows that we failed to restore
692 $toDeleteConds = $oldWhere;
693 $failedRevisionCount = count( $restoreFailedArIds );
694 if ( $failedRevisionCount > 0 ) {
695 $toDeleteConds[] = 'ar_id NOT IN ( ' . $dbw->makeList( $restoreFailedArIds ) . ' )';
698 $dbw->delete( 'archive',
703 $status = Status
::newGood( $restored );
705 if ( $failedRevisionCount > 0 ) {
707 wfMessage( 'undeleterevision-duplicate-revid', $failedRevisionCount ) );
710 // Was anything restored at all?
712 $created = (bool)$newid;
713 // Attach the latest revision to the page...
714 $wasnew = $article->updateIfNewerOn( $dbw, $revision );
715 if ( $created ||
$wasnew ) {
716 // Update site stats, link tables, etc
717 $article->doEditUpdates(
719 User
::newFromName( $revision->getUserText( Revision
::RAW
), false ),
721 'created' => $created,
722 'oldcountable' => $oldcountable,
728 Hooks
::run( 'ArticleUndelete',
729 [ &$this->title
, $created, $comment, $oldPageId, $restoredPages ] );
730 if ( $this->title
->getNamespace() == NS_FILE
) {
731 DeferredUpdates
::addUpdate(
732 new HTMLCacheUpdate( $this->title
, 'imagelinks', 'file-restore' )
737 $dbw->endAtomic( __METHOD__
);
745 public function getFileStatus() {
746 return $this->fileStatus
;
752 public function getRevisionStatus() {
753 return $this->revisionStatus
;