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 * (ar_minor_edit, ar_timestamp, ar_user, ar_user_text, ar_comment) fields.
176 * @return ResultWrapper
178 public function listRevisions() {
179 $dbr = wfGetDB( DB_REPLICA
);
181 $tables = [ 'archive' ];
184 'ar_minor_edit', 'ar_timestamp', 'ar_user', 'ar_user_text',
185 'ar_comment', 'ar_len', 'ar_deleted', 'ar_rev_id', 'ar_sha1',
189 if ( $this->config
->get( 'ContentHandlerUseDB' ) ) {
190 $fields[] = 'ar_content_format';
191 $fields[] = 'ar_content_model';
194 $conds = [ 'ar_namespace' => $this->title
->getNamespace(),
195 'ar_title' => $this->title
->getDBkey() ];
197 $options = [ 'ORDER BY' => 'ar_timestamp DESC' ];
201 ChangeTags
::modifyDisplayQuery(
210 return $dbr->select( $tables,
220 * List the deleted file revisions for this page, if it's a file page.
221 * Returns a result wrapper with various filearchive fields, or null
222 * if not a file page.
224 * @return ResultWrapper
225 * @todo Does this belong in Image for fuller encapsulation?
227 public function listFiles() {
228 if ( $this->title
->getNamespace() != NS_FILE
) {
232 $dbr = wfGetDB( DB_REPLICA
);
235 ArchivedFile
::selectFields(),
236 [ 'fa_name' => $this->title
->getDBkey() ],
238 [ 'ORDER BY' => 'fa_timestamp DESC' ]
243 * Return a Revision object containing data for the deleted revision.
244 * Note that the result *may* or *may not* have a null page ID.
246 * @param string $timestamp
247 * @return Revision|null
249 public function getRevision( $timestamp ) {
250 $dbr = wfGetDB( DB_REPLICA
);
267 if ( $this->config
->get( 'ContentHandlerUseDB' ) ) {
268 $fields[] = 'ar_content_format';
269 $fields[] = 'ar_content_model';
272 $row = $dbr->selectRow( 'archive',
274 [ 'ar_namespace' => $this->title
->getNamespace(),
275 'ar_title' => $this->title
->getDBkey(),
276 'ar_timestamp' => $dbr->timestamp( $timestamp ) ],
280 return Revision
::newFromArchiveRow( $row, [ 'title' => $this->title
] );
287 * Return the most-previous revision, either live or deleted, against
288 * the deleted revision given by timestamp.
290 * May produce unexpected results in case of history merges or other
291 * unusual time issues.
293 * @param string $timestamp
294 * @return Revision|null Null when there is no previous revision
296 public function getPreviousRevision( $timestamp ) {
297 $dbr = wfGetDB( DB_REPLICA
);
299 // Check the previous deleted revision...
300 $row = $dbr->selectRow( 'archive',
302 [ 'ar_namespace' => $this->title
->getNamespace(),
303 'ar_title' => $this->title
->getDBkey(),
305 $dbr->addQuotes( $dbr->timestamp( $timestamp ) ) ],
308 'ORDER BY' => 'ar_timestamp DESC',
310 $prevDeleted = $row ?
wfTimestamp( TS_MW
, $row->ar_timestamp
) : false;
312 $row = $dbr->selectRow( [ 'page', 'revision' ],
313 [ 'rev_id', 'rev_timestamp' ],
315 'page_namespace' => $this->title
->getNamespace(),
316 'page_title' => $this->title
->getDBkey(),
317 'page_id = rev_page',
319 $dbr->addQuotes( $dbr->timestamp( $timestamp ) ) ],
322 'ORDER BY' => 'rev_timestamp DESC',
324 $prevLive = $row ?
wfTimestamp( TS_MW
, $row->rev_timestamp
) : false;
325 $prevLiveId = $row ?
intval( $row->rev_id
) : null;
327 if ( $prevLive && $prevLive > $prevDeleted ) {
328 // Most prior revision was live
329 return Revision
::newFromId( $prevLiveId );
330 } elseif ( $prevDeleted ) {
331 // Most prior revision was deleted
332 return $this->getRevision( $prevDeleted );
335 // No prior revision on this page.
340 * Get the text from an archive row containing ar_text, ar_flags and ar_text_id
342 * @param object $row Database row
345 public function getTextFromRow( $row ) {
346 if ( is_null( $row->ar_text_id
) ) {
347 // An old row from MediaWiki 1.4 or previous.
348 // Text is embedded in this row in classic compression format.
349 return Revision
::getRevisionText( $row, 'ar_' );
352 // New-style: keyed to the text storage backend.
353 $dbr = wfGetDB( DB_REPLICA
);
354 $text = $dbr->selectRow( 'text',
355 [ 'old_text', 'old_flags' ],
356 [ 'old_id' => $row->ar_text_id
],
359 return Revision
::getRevisionText( $text );
363 * Fetch (and decompress if necessary) the stored text of the most
364 * recently edited deleted revision of the page.
366 * If there are no archived revisions for the page, returns NULL.
368 * @return string|null
370 public function getLastRevisionText() {
371 $dbr = wfGetDB( DB_REPLICA
);
372 $row = $dbr->selectRow( 'archive',
373 [ 'ar_text', 'ar_flags', 'ar_text_id' ],
374 [ 'ar_namespace' => $this->title
->getNamespace(),
375 'ar_title' => $this->title
->getDBkey() ],
377 [ 'ORDER BY' => 'ar_timestamp DESC' ] );
380 return $this->getTextFromRow( $row );
387 * Quick check if any archived revisions are present for the page.
391 public function isDeleted() {
392 $dbr = wfGetDB( DB_REPLICA
);
393 $n = $dbr->selectField( 'archive', 'COUNT(ar_title)',
394 [ 'ar_namespace' => $this->title
->getNamespace(),
395 'ar_title' => $this->title
->getDBkey() ],
403 * Restore the given (or all) text and file revisions for the page.
404 * Once restored, the items will be removed from the archive tables.
405 * The deletion log will be updated with an undeletion notice.
407 * This also sets Status objects, $this->fileStatus and $this->revisionStatus
408 * (depending what operations are attempted).
410 * @param array $timestamps Pass an empty array to restore all revisions,
411 * otherwise list the ones to undelete.
412 * @param string $comment
413 * @param array $fileVersions
414 * @param bool $unsuppress
415 * @param User $user User performing the action, or null to use $wgUser
416 * @param string|string[] $tags Change tags to add to log entry
417 * ($user should be able to add the specified tags before this is called)
418 * @return array|bool array(number of file revisions restored, number of image revisions
419 * restored, log message) on success, false on failure.
421 public function undelete( $timestamps, $comment = '', $fileVersions = [],
422 $unsuppress = false, User
$user = null, $tags = null
424 // If both the set of text revisions and file revisions are empty,
425 // restore everything. Otherwise, just restore the requested items.
426 $restoreAll = empty( $timestamps ) && empty( $fileVersions );
428 $restoreText = $restoreAll ||
!empty( $timestamps );
429 $restoreFiles = $restoreAll ||
!empty( $fileVersions );
431 if ( $restoreFiles && $this->title
->getNamespace() == NS_FILE
) {
432 $img = wfLocalFile( $this->title
);
433 $img->load( File
::READ_LATEST
);
434 $this->fileStatus
= $img->restore( $fileVersions, $unsuppress );
435 if ( !$this->fileStatus
->isOK() ) {
438 $filesRestored = $this->fileStatus
->successCount
;
443 if ( $restoreText ) {
444 $this->revisionStatus
= $this->undeleteRevisions( $timestamps, $unsuppress, $comment );
445 if ( !$this->revisionStatus
->isOK() ) {
449 $textRestored = $this->revisionStatus
->getValue();
456 if ( !$textRestored && !$filesRestored ) {
457 wfDebug( "Undelete: nothing undeleted...\n" );
462 if ( $user === null ) {
467 $logEntry = new ManualLogEntry( 'delete', 'restore' );
468 $logEntry->setPerformer( $user );
469 $logEntry->setTarget( $this->title
);
470 $logEntry->setComment( $comment );
471 $logEntry->setTags( $tags );
472 $logEntry->setParameters( [
474 'revisions' => $textRestored,
475 'files' => $filesRestored,
479 Hooks
::run( 'ArticleUndeleteLogEntry', [ $this, &$logEntry, $user ] );
481 $logid = $logEntry->insert();
482 $logEntry->publish( $logid );
484 return [ $textRestored, $filesRestored, $comment ];
488 * This is the meaty bit -- It restores archived revisions of the given page
489 * to the revision table.
491 * @param array $timestamps Pass an empty array to restore all revisions,
492 * otherwise list the ones to undelete.
493 * @param bool $unsuppress Remove all ar_deleted/fa_deleted restrictions of seletected revs
494 * @param string $comment
495 * @throws ReadOnlyError
496 * @return Status Status object containing the number of revisions restored on success
498 private function undeleteRevisions( $timestamps, $unsuppress = false, $comment = '' ) {
499 if ( wfReadOnly() ) {
500 throw new ReadOnlyError();
503 $dbw = wfGetDB( DB_MASTER
);
504 $dbw->startAtomic( __METHOD__
);
506 $restoreAll = empty( $timestamps );
508 # Does this page already exist? We'll have to update it...
509 $article = WikiPage
::factory( $this->title
);
510 # Load latest data for the current page (T33179)
511 $article->loadPageData( 'fromdbmaster' );
512 $oldcountable = $article->isCountable();
514 $page = $dbw->selectRow( 'page',
515 [ 'page_id', 'page_latest' ],
516 [ 'page_namespace' => $this->title
->getNamespace(),
517 'page_title' => $this->title
->getDBkey() ],
519 [ 'FOR UPDATE' ] // lock page
524 # Page already exists. Import the history, and if necessary
525 # we'll update the latest revision field in the record.
527 # Get the time span of this page
528 $previousTimestamp = $dbw->selectField( 'revision', 'rev_timestamp',
529 [ 'rev_id' => $page->page_latest
],
532 if ( $previousTimestamp === false ) {
533 wfDebug( __METHOD__
. ": existing page refers to a page_latest that does not exist\n" );
535 $status = Status
::newGood( 0 );
536 $status->warning( 'undeleterevision-missing' );
537 $dbw->endAtomic( __METHOD__
);
542 # Have to create a new article...
544 $previousTimestamp = 0;
548 'ar_namespace' => $this->title
->getNamespace(),
549 'ar_title' => $this->title
->getDBkey(),
551 if ( !$restoreAll ) {
552 $oldWhere['ar_timestamp'] = array_map( [ &$dbw, 'timestamp' ], $timestamps );
573 if ( $this->config
->get( 'ContentHandlerUseDB' ) ) {
574 $fields[] = 'ar_content_format';
575 $fields[] = 'ar_content_model';
579 * Select each archived revision...
581 $result = $dbw->select(
582 [ 'archive', 'revision' ],
587 [ 'ORDER BY' => 'ar_timestamp' ],
588 [ 'revision' => [ 'LEFT JOIN', 'ar_rev_id=rev_id' ] ]
591 $rev_count = $result->numRows();
593 wfDebug( __METHOD__
. ": no revisions to restore\n" );
595 $status = Status
::newGood( 0 );
596 $status->warning( "undelete-no-results" );
597 $dbw->endAtomic( __METHOD__
);
602 // We use ar_id because there can be duplicate ar_rev_id even for the same
603 // page. In this case, we may be able to restore the first one.
604 $restoreFailedArIds = [];
606 // Map rev_id to the ar_id that is allowed to use it. When checking later,
607 // if it doesn't match, the current ar_id can not be restored.
609 // Value can be an ar_id or -1 (-1 means no ar_id can use it, since the
610 // rev_id is taken before we even start the restore).
611 $allowedRevIdToArIdMap = [];
613 $latestRestorableRow = null;
615 foreach ( $result as $row ) {
616 if ( $row->ar_rev_id
) {
617 // rev_id is taken even before we start restoring.
618 if ( $row->ar_rev_id
=== $row->rev_id
) {
619 $restoreFailedArIds[] = $row->ar_id
;
620 $allowedRevIdToArIdMap[$row->ar_rev_id
] = -1;
622 // rev_id is not taken yet in the DB, but it might be taken
623 // by a prior revision in the same restore operation. If
624 // not, we need to reserve it.
625 if ( isset( $allowedRevIdToArIdMap[$row->ar_rev_id
] ) ) {
626 $restoreFailedArIds[] = $row->ar_id
;
628 $allowedRevIdToArIdMap[$row->ar_rev_id
] = $row->ar_id
;
629 $latestRestorableRow = $row;
633 // If ar_rev_id is null, there can't be a collision, and a
634 // rev_id will be chosen automatically.
635 $latestRestorableRow = $row;
639 $result->seek( 0 ); // move back
642 if ( $latestRestorableRow !== null ) {
643 $oldPageId = (int)$latestRestorableRow->ar_page_id
; // pass this to ArticleUndelete hook
645 // grab the content to check consistency with global state before restoring the page.
646 $revision = Revision
::newFromArchiveRow( $latestRestorableRow,
648 'title' => $article->getTitle(), // used to derive default content model
651 $user = User
::newFromName( $revision->getUserText( Revision
::RAW
), false );
652 $content = $revision->getContent( Revision
::RAW
);
654 // NOTE: article ID may not be known yet. prepareSave() should not modify the database.
655 $status = $content->prepareSave( $article, 0, -1, $user );
656 if ( !$status->isOK() ) {
657 $dbw->endAtomic( __METHOD__
);
663 $newid = false; // newly created page ID
664 $restored = 0; // number of revisions restored
665 /** @var Revision $revision */
668 // If there are no restorable revisions, we can skip most of the steps.
669 if ( $latestRestorableRow === null ) {
670 $failedRevisionCount = $rev_count;
673 // Check the state of the newest to-be version...
675 && ( $latestRestorableRow->ar_deleted
& Revision
::DELETED_TEXT
)
677 $dbw->endAtomic( __METHOD__
);
679 return Status
::newFatal( "undeleterevdel" );
681 // Safe to insert now...
682 $newid = $article->insertOn( $dbw, $latestRestorableRow->ar_page_id
);
683 if ( $newid === false ) {
684 // The old ID is reserved; let's pick another
685 $newid = $article->insertOn( $dbw );
689 // Check if a deleted revision will become the current revision...
690 if ( $latestRestorableRow->ar_timestamp
> $previousTimestamp ) {
691 // Check the state of the newest to-be version...
693 && ( $latestRestorableRow->ar_deleted
& Revision
::DELETED_TEXT
)
695 $dbw->endAtomic( __METHOD__
);
697 return Status
::newFatal( "undeleterevdel" );
702 $pageId = $article->getId();
705 foreach ( $result as $row ) {
706 // Check for key dupes due to needed archive integrity.
707 if ( $row->ar_rev_id
&& $allowedRevIdToArIdMap[$row->ar_rev_id
] !== $row->ar_id
) {
710 // Insert one revision at a time...maintaining deletion status
711 // unless we are specifically removing all restrictions...
712 $revision = Revision
::newFromArchiveRow( $row,
715 'title' => $this->title
,
716 'deleted' => $unsuppress ?
0 : $row->ar_deleted
719 $revision->insertOn( $dbw );
722 Hooks
::run( 'ArticleRevisionUndeleted',
723 [ &$this->title
, $revision, $row->ar_page_id
] );
724 $restoredPages[$row->ar_page_id
] = true;
727 // Now that it's safely stored, take it out of the archive
728 // Don't delete rows that we failed to restore
729 $toDeleteConds = $oldWhere;
730 $failedRevisionCount = count( $restoreFailedArIds );
731 if ( $failedRevisionCount > 0 ) {
732 $toDeleteConds[] = 'ar_id NOT IN ( ' . $dbw->makeList( $restoreFailedArIds ) . ' )';
735 $dbw->delete( 'archive',
740 $status = Status
::newGood( $restored );
742 if ( $failedRevisionCount > 0 ) {
744 wfMessage( 'undeleterevision-duplicate-revid', $failedRevisionCount ) );
747 // Was anything restored at all?
749 $created = (bool)$newid;
750 // Attach the latest revision to the page...
751 $wasnew = $article->updateIfNewerOn( $dbw, $revision );
752 if ( $created ||
$wasnew ) {
753 // Update site stats, link tables, etc
754 $article->doEditUpdates(
756 User
::newFromName( $revision->getUserText( Revision
::RAW
), false ),
758 'created' => $created,
759 'oldcountable' => $oldcountable,
765 Hooks
::run( 'ArticleUndelete',
766 [ &$this->title
, $created, $comment, $oldPageId, $restoredPages ] );
767 if ( $this->title
->getNamespace() == NS_FILE
) {
768 DeferredUpdates
::addUpdate( new HTMLCacheUpdate( $this->title
, 'imagelinks' ) );
772 $dbw->endAtomic( __METHOD__
);
780 public function getFileStatus() {
781 return $this->fileStatus
;
787 public function getRevisionStatus() {
788 return $this->revisionStatus
;