3 * Implements Special:Undelete
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @ingroup SpecialPage
25 * Used to show archived pages and eventually restore them.
27 * @ingroup SpecialPage
38 protected $fileStatus;
43 protected $revisionStatus;
45 function __construct( $title ) {
46 if ( is_null( $title ) ) {
47 throw new MWException( __METHOD__
. ' given a null title.' );
49 $this->title
= $title;
53 * List all deleted pages recorded in the archive table. Returns result
54 * wrapper with (ar_namespace, ar_title, count) fields, ordered by page
57 * @return ResultWrapper
59 public static function listAllPages() {
60 $dbr = wfGetDB( DB_SLAVE
);
61 return self
::listPages( $dbr, '' );
65 * List deleted pages recorded in the archive table matching the
67 * Returns result wrapper with (ar_namespace, ar_title, count) fields.
69 * @param string $prefix Title prefix
70 * @return ResultWrapper
72 public static function listPagesByPrefix( $prefix ) {
73 $dbr = wfGetDB( DB_SLAVE
);
75 $title = Title
::newFromText( $prefix );
77 $ns = $title->getNamespace();
78 $prefix = $title->getDBkey();
80 // Prolly won't work too good
81 // @todo handle bare namespace names cleanly?
86 'ar_namespace' => $ns,
87 'ar_title' . $dbr->buildLike( $prefix, $dbr->anyString() ),
90 return self
::listPages( $dbr, $conds );
94 * @param DatabaseBase $dbr
95 * @param string|array $condition
96 * @return bool|ResultWrapper
98 protected static function listPages( $dbr, $condition ) {
99 return $dbr->resultObject( $dbr->select(
104 'count' => 'COUNT(*)'
109 'GROUP BY' => array( 'ar_namespace', 'ar_title' ),
110 'ORDER BY' => array( 'ar_namespace', 'ar_title' ),
117 * List the revisions of the given page. Returns result wrapper with
118 * (ar_minor_edit, ar_timestamp, ar_user, ar_user_text, ar_comment) fields.
120 * @return ResultWrapper
122 function listRevisions() {
123 global $wgContentHandlerUseDB;
125 $dbr = wfGetDB( DB_SLAVE
);
128 'ar_minor_edit', 'ar_timestamp', 'ar_user', 'ar_user_text',
129 'ar_comment', 'ar_len', 'ar_deleted', 'ar_rev_id', 'ar_sha1',
132 if ( $wgContentHandlerUseDB ) {
133 $fields[] = 'ar_content_format';
134 $fields[] = 'ar_content_model';
137 $res = $dbr->select( 'archive',
139 array( 'ar_namespace' => $this->title
->getNamespace(),
140 'ar_title' => $this->title
->getDBkey() ),
142 array( 'ORDER BY' => 'ar_timestamp DESC' ) );
144 return $dbr->resultObject( $res );
148 * List the deleted file revisions for this page, if it's a file page.
149 * Returns a result wrapper with various filearchive fields, or null
150 * if not a file page.
152 * @return ResultWrapper
153 * @todo Does this belong in Image for fuller encapsulation?
155 function listFiles() {
156 if ( $this->title
->getNamespace() != NS_FILE
) {
160 $dbr = wfGetDB( DB_SLAVE
);
163 ArchivedFile
::selectFields(),
164 array( 'fa_name' => $this->title
->getDBkey() ),
166 array( 'ORDER BY' => 'fa_timestamp DESC' )
169 return $dbr->resultObject( $res );
173 * Return a Revision object containing data for the deleted revision.
174 * Note that the result *may* or *may not* have a null page ID.
176 * @param string $timestamp
177 * @return Revision|null
179 function getRevision( $timestamp ) {
180 global $wgContentHandlerUseDB;
182 $dbr = wfGetDB( DB_SLAVE
);
199 if ( $wgContentHandlerUseDB ) {
200 $fields[] = 'ar_content_format';
201 $fields[] = 'ar_content_model';
204 $row = $dbr->selectRow( 'archive',
206 array( 'ar_namespace' => $this->title
->getNamespace(),
207 'ar_title' => $this->title
->getDBkey(),
208 'ar_timestamp' => $dbr->timestamp( $timestamp ) ),
212 return Revision
::newFromArchiveRow( $row, array( 'title' => $this->title
) );
219 * Return the most-previous revision, either live or deleted, against
220 * the deleted revision given by timestamp.
222 * May produce unexpected results in case of history merges or other
223 * unusual time issues.
225 * @param string $timestamp
226 * @return Revision|null Null when there is no previous revision
228 function getPreviousRevision( $timestamp ) {
229 $dbr = wfGetDB( DB_SLAVE
);
231 // Check the previous deleted revision...
232 $row = $dbr->selectRow( 'archive',
234 array( 'ar_namespace' => $this->title
->getNamespace(),
235 'ar_title' => $this->title
->getDBkey(),
237 $dbr->addQuotes( $dbr->timestamp( $timestamp ) ) ),
240 'ORDER BY' => 'ar_timestamp DESC',
242 $prevDeleted = $row ?
wfTimestamp( TS_MW
, $row->ar_timestamp
) : false;
244 $row = $dbr->selectRow( array( 'page', 'revision' ),
245 array( 'rev_id', 'rev_timestamp' ),
247 'page_namespace' => $this->title
->getNamespace(),
248 'page_title' => $this->title
->getDBkey(),
249 'page_id = rev_page',
251 $dbr->addQuotes( $dbr->timestamp( $timestamp ) ) ),
254 'ORDER BY' => 'rev_timestamp DESC',
256 $prevLive = $row ?
wfTimestamp( TS_MW
, $row->rev_timestamp
) : false;
257 $prevLiveId = $row ?
intval( $row->rev_id
) : null;
259 if ( $prevLive && $prevLive > $prevDeleted ) {
260 // Most prior revision was live
261 return Revision
::newFromId( $prevLiveId );
262 } elseif ( $prevDeleted ) {
263 // Most prior revision was deleted
264 return $this->getRevision( $prevDeleted );
267 // No prior revision on this page.
272 * Get the text from an archive row containing ar_text, ar_flags and ar_text_id
274 * @param object $row Database row
277 function getTextFromRow( $row ) {
278 if ( is_null( $row->ar_text_id
) ) {
279 // An old row from MediaWiki 1.4 or previous.
280 // Text is embedded in this row in classic compression format.
281 return Revision
::getRevisionText( $row, 'ar_' );
284 // New-style: keyed to the text storage backend.
285 $dbr = wfGetDB( DB_SLAVE
);
286 $text = $dbr->selectRow( 'text',
287 array( 'old_text', 'old_flags' ),
288 array( 'old_id' => $row->ar_text_id
),
291 return Revision
::getRevisionText( $text );
295 * Fetch (and decompress if necessary) the stored text of the most
296 * recently edited deleted revision of the page.
298 * If there are no archived revisions for the page, returns NULL.
300 * @return string|null
302 function getLastRevisionText() {
303 $dbr = wfGetDB( DB_SLAVE
);
304 $row = $dbr->selectRow( 'archive',
305 array( 'ar_text', 'ar_flags', 'ar_text_id' ),
306 array( 'ar_namespace' => $this->title
->getNamespace(),
307 'ar_title' => $this->title
->getDBkey() ),
309 array( 'ORDER BY' => 'ar_timestamp DESC' ) );
312 return $this->getTextFromRow( $row );
319 * Quick check if any archived revisions are present for the page.
323 function isDeleted() {
324 $dbr = wfGetDB( DB_SLAVE
);
325 $n = $dbr->selectField( 'archive', 'COUNT(ar_title)',
326 array( 'ar_namespace' => $this->title
->getNamespace(),
327 'ar_title' => $this->title
->getDBkey() ),
335 * Restore the given (or all) text and file revisions for the page.
336 * Once restored, the items will be removed from the archive tables.
337 * The deletion log will be updated with an undeletion notice.
339 * @param array $timestamps Pass an empty array to restore all revisions, otherwise list the ones to undelete.
340 * @param string $comment
341 * @param array $fileVersions
342 * @param bool $unsuppress
343 * @param User $user User performing the action, or null to use $wgUser
345 * @return array(number of file revisions restored, number of image revisions restored, log message)
346 * on success, false on failure
348 function undelete( $timestamps, $comment = '', $fileVersions = array(), $unsuppress = false, User
$user = null ) {
349 // If both the set of text revisions and file revisions are empty,
350 // restore everything. Otherwise, just restore the requested items.
351 $restoreAll = empty( $timestamps ) && empty( $fileVersions );
353 $restoreText = $restoreAll ||
!empty( $timestamps );
354 $restoreFiles = $restoreAll ||
!empty( $fileVersions );
356 if ( $restoreFiles && $this->title
->getNamespace() == NS_FILE
) {
357 $img = wfLocalFile( $this->title
);
358 $this->fileStatus
= $img->restore( $fileVersions, $unsuppress );
359 if ( !$this->fileStatus
->isOK() ) {
362 $filesRestored = $this->fileStatus
->successCount
;
367 if ( $restoreText ) {
368 $this->revisionStatus
= $this->undeleteRevisions( $timestamps, $unsuppress, $comment );
369 if ( !$this->revisionStatus
->isOK() ) {
373 $textRestored = $this->revisionStatus
->getValue();
380 if ( $textRestored && $filesRestored ) {
381 $reason = wfMessage( 'undeletedrevisions-files' )
382 ->numParams( $textRestored, $filesRestored )->inContentLanguage()->text();
383 } elseif ( $textRestored ) {
384 $reason = wfMessage( 'undeletedrevisions' )->numParams( $textRestored )
385 ->inContentLanguage()->text();
386 } elseif ( $filesRestored ) {
387 $reason = wfMessage( 'undeletedfiles' )->numParams( $filesRestored )
388 ->inContentLanguage()->text();
390 wfDebug( "Undelete: nothing undeleted...\n" );
394 if ( trim( $comment ) != '' ) {
395 $reason .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $comment;
398 if ( $user === null ) {
403 $logEntry = new ManualLogEntry( 'delete', 'restore' );
404 $logEntry->setPerformer( $user );
405 $logEntry->setTarget( $this->title
);
406 $logEntry->setComment( $reason );
408 wfRunHooks( 'ArticleUndeleteLogEntry', array( $this, &$logEntry, $user ) );
410 $logid = $logEntry->insert();
411 $logEntry->publish( $logid );
413 return array( $textRestored, $filesRestored, $reason );
417 * This is the meaty bit -- restores archived revisions of the given page
418 * to the cur/old tables. If the page currently exists, all revisions will
419 * be stuffed into old, otherwise the most recent will go into cur.
421 * @param array $timestamps Pass an empty array to restore all revisions, otherwise list the ones to undelete.
422 * @param bool $unsuppress Remove all ar_deleted/fa_deleted restrictions of seletected revs
423 * @param string $comment
424 * @throws ReadOnlyError
425 * @return Status Object containing the number of revisions restored on success
427 private function undeleteRevisions( $timestamps, $unsuppress = false, $comment = '' ) {
428 global $wgContentHandlerUseDB;
430 if ( wfReadOnly() ) {
431 throw new ReadOnlyError();
434 $restoreAll = empty( $timestamps );
435 $dbw = wfGetDB( DB_MASTER
);
437 # Does this page already exist? We'll have to update it...
438 $article = WikiPage
::factory( $this->title
);
439 # Load latest data for the current page (bug 31179)
440 $article->loadPageData( 'fromdbmaster' );
441 $oldcountable = $article->isCountable();
443 $page = $dbw->selectRow( 'page',
444 array( 'page_id', 'page_latest' ),
445 array( 'page_namespace' => $this->title
->getNamespace(),
446 'page_title' => $this->title
->getDBkey() ),
448 array( 'FOR UPDATE' ) // lock page
453 # Page already exists. Import the history, and if necessary
454 # we'll update the latest revision field in the record.
456 $previousRevId = $page->page_latest
;
458 # Get the time span of this page
459 $previousTimestamp = $dbw->selectField( 'revision', 'rev_timestamp',
460 array( 'rev_id' => $previousRevId ),
463 if ( $previousTimestamp === false ) {
464 wfDebug( __METHOD__
. ": existing page refers to a page_latest that does not exist\n" );
466 $status = Status
::newGood( 0 );
467 $status->warning( 'undeleterevision-missing' );
472 # Have to create a new article...
475 $previousTimestamp = 0;
479 $oldones = '1 = 1'; # All revisions...
481 $oldts = implode( ',',
482 array_map( array( &$dbw, 'addQuotes' ),
483 array_map( array( &$dbw, 'timestamp' ),
486 $oldones = "ar_timestamp IN ( {$oldts} )";
505 if ( $wgContentHandlerUseDB ) {
506 $fields[] = 'ar_content_format';
507 $fields[] = 'ar_content_model';
511 * Select each archived revision...
513 $result = $dbw->select( 'archive',
516 'ar_namespace' => $this->title
->getNamespace(),
517 'ar_title' => $this->title
->getDBkey(),
520 /* options */ array( 'ORDER BY' => 'ar_timestamp' )
522 $ret = $dbw->resultObject( $result );
523 $rev_count = $dbw->numRows( $result );
526 wfDebug( __METHOD__
. ": no revisions to restore\n" );
528 $status = Status
::newGood( 0 );
529 $status->warning( "undelete-no-results" );
533 $ret->seek( $rev_count - 1 ); // move to last
534 $row = $ret->fetchObject(); // get newest archived rev
535 $ret->seek( 0 ); // move back
537 // grab the content to check consistency with global state before restoring the page.
538 $revision = Revision
::newFromArchiveRow( $row,
540 'title' => $article->getTitle(), // used to derive default content model
543 $user = User
::newFromName( $revision->getRawUserText(), false );
544 $content = $revision->getContent( Revision
::RAW
);
546 //NOTE: article ID may not be known yet. prepareSave() should not modify the database.
547 $status = $content->prepareSave( $article, 0, -1, $user );
549 if ( !$status->isOK() ) {
554 // Check the state of the newest to-be version...
555 if ( !$unsuppress && ( $row->ar_deleted
& Revision
::DELETED_TEXT
) ) {
556 return Status
::newFatal( "undeleterevdel" );
558 // Safe to insert now...
559 $newid = $article->insertOn( $dbw );
562 // Check if a deleted revision will become the current revision...
563 if ( $row->ar_timestamp
> $previousTimestamp ) {
564 // Check the state of the newest to-be version...
565 if ( !$unsuppress && ( $row->ar_deleted
& Revision
::DELETED_TEXT
) ) {
566 return Status
::newFatal( "undeleterevdel" );
571 $pageId = $article->getId();
577 foreach ( $ret as $row ) {
578 // Check for key dupes due to shitty archive integrity.
579 if ( $row->ar_rev_id
) {
580 $exists = $dbw->selectField( 'revision', '1',
581 array( 'rev_id' => $row->ar_rev_id
), __METHOD__
);
583 continue; // don't throw DB errors
586 // Insert one revision at a time...maintaining deletion status
587 // unless we are specifically removing all restrictions...
588 $revision = Revision
::newFromArchiveRow( $row,
591 'title' => $this->title
,
592 'deleted' => $unsuppress ?
0 : $row->ar_deleted
595 $revision->insertOn( $dbw );
598 wfRunHooks( 'ArticleRevisionUndeleted', array( &$this->title
, $revision, $row->ar_page_id
) );
600 # Now that it's safely stored, take it out of the archive
601 $dbw->delete( 'archive',
603 'ar_namespace' => $this->title
->getNamespace(),
604 'ar_title' => $this->title
->getDBkey(),
608 // Was anything restored at all?
609 if ( $restored == 0 ) {
610 return Status
::newGood( 0 );
613 $created = (bool)$newid;
615 // Attach the latest revision to the page...
616 $wasnew = $article->updateIfNewerOn( $dbw, $revision, $previousRevId );
617 if ( $created ||
$wasnew ) {
618 // Update site stats, link tables, etc
619 $user = User
::newFromName( $revision->getRawUserText(), false );
620 $article->doEditUpdates( $revision, $user, array( 'created' => $created, 'oldcountable' => $oldcountable ) );
623 wfRunHooks( 'ArticleUndelete', array( &$this->title
, $created, $comment ) );
625 if ( $this->title
->getNamespace() == NS_FILE
) {
626 $update = new HTMLCacheUpdate( $this->title
, 'imagelinks' );
630 return Status
::newGood( $restored );
636 function getFileStatus() {
637 return $this->fileStatus
;
643 function getRevisionStatus() {
644 return $this->revisionStatus
;
649 * Special page allowing users with the appropriate permissions to view
650 * and restore deleted content.
652 * @ingroup SpecialPage
654 class SpecialUndelete
extends SpecialPage
{
655 var $mAction, $mTarget, $mTimestamp, $mRestore, $mInvert, $mFilename;
656 var $mTargetTimestamp, $mAllowed, $mCanView, $mComment, $mToken;
663 function __construct() {
664 parent
::__construct( 'Undelete', 'deletedhistory' );
667 function loadRequest( $par ) {
668 $request = $this->getRequest();
669 $user = $this->getUser();
671 $this->mAction
= $request->getVal( 'action' );
672 if ( $par !== null && $par !== '' ) {
673 $this->mTarget
= $par;
675 $this->mTarget
= $request->getVal( 'target' );
678 $this->mTargetObj
= null;
680 if ( $this->mTarget
!== null && $this->mTarget
!== '' ) {
681 $this->mTargetObj
= Title
::newFromURL( $this->mTarget
);
684 $this->mSearchPrefix
= $request->getText( 'prefix' );
685 $time = $request->getVal( 'timestamp' );
686 $this->mTimestamp
= $time ?
wfTimestamp( TS_MW
, $time ) : '';
687 $this->mFilename
= $request->getVal( 'file' );
689 $posted = $request->wasPosted() &&
690 $user->matchEditToken( $request->getVal( 'wpEditToken' ) );
691 $this->mRestore
= $request->getCheck( 'restore' ) && $posted;
692 $this->mInvert
= $request->getCheck( 'invert' ) && $posted;
693 $this->mPreview
= $request->getCheck( 'preview' ) && $posted;
694 $this->mDiff
= $request->getCheck( 'diff' );
695 $this->mDiffOnly
= $request->getBool( 'diffonly', $this->getUser()->getOption( 'diffonly' ) );
696 $this->mComment
= $request->getText( 'wpComment' );
697 $this->mUnsuppress
= $request->getVal( 'wpUnsuppress' ) && $user->isAllowed( 'suppressrevision' );
698 $this->mToken
= $request->getVal( 'token' );
700 if ( $user->isAllowed( 'undelete' ) && !$user->isBlocked() ) {
701 $this->mAllowed
= true; // user can restore
702 $this->mCanView
= true; // user can view content
703 } elseif ( $user->isAllowed( 'deletedtext' ) ) {
704 $this->mAllowed
= false; // user cannot restore
705 $this->mCanView
= true; // user can view content
706 $this->mRestore
= false;
707 } else { // user can only view the list of revisions
708 $this->mAllowed
= false;
709 $this->mCanView
= false;
710 $this->mTimestamp
= '';
711 $this->mRestore
= false;
714 if ( $this->mRestore ||
$this->mInvert
) {
715 $timestamps = array();
716 $this->mFileVersions
= array();
717 foreach ( $request->getValues() as $key => $val ) {
719 if ( preg_match( '/^ts(\d{14})$/', $key, $matches ) ) {
720 array_push( $timestamps, $matches[1] );
723 if ( preg_match( '/^fileid(\d+)$/', $key, $matches ) ) {
724 $this->mFileVersions
[] = intval( $matches[1] );
727 rsort( $timestamps );
728 $this->mTargetTimestamp
= $timestamps;
732 function execute( $par ) {
733 $this->checkPermissions();
734 $user = $this->getUser();
737 $this->outputHeader();
739 $this->loadRequest( $par );
741 $out = $this->getOutput();
743 if ( is_null( $this->mTargetObj
) ) {
744 $out->addWikiMsg( 'undelete-header' );
746 # Not all users can just browse every deleted page from the list
747 if ( $user->isAllowed( 'browsearchive' ) ) {
748 $this->showSearchForm();
753 if ( $this->mAllowed
) {
754 $out->setPageTitle( $this->msg( 'undeletepage' ) );
756 $out->setPageTitle( $this->msg( 'viewdeletedpage' ) );
759 $this->getSkin()->setRelevantTitle( $this->mTargetObj
);
761 if ( $this->mTimestamp
!== '' ) {
762 $this->showRevision( $this->mTimestamp
);
763 } elseif ( $this->mFilename
!== null ) {
764 $file = new ArchivedFile( $this->mTargetObj
, '', $this->mFilename
);
765 // Check if user is allowed to see this file
766 if ( !$file->exists() ) {
767 $out->addWikiMsg( 'filedelete-nofile', $this->mFilename
);
768 } elseif ( !$file->userCan( File
::DELETED_FILE
, $user ) ) {
769 if ( $file->isDeleted( File
::DELETED_RESTRICTED
) ) {
770 throw new PermissionsError( 'suppressrevision' );
772 throw new PermissionsError( 'deletedtext' );
774 } elseif ( !$user->matchEditToken( $this->mToken
, $this->mFilename
) ) {
775 $this->showFileConfirmationForm( $this->mFilename
);
777 $this->showFile( $this->mFilename
);
779 } elseif ( $this->mRestore
&& $this->mAction
== 'submit' ) {
782 $this->showHistory();
786 function showSearchForm() {
789 $out = $this->getOutput();
790 $out->setPageTitle( $this->msg( 'undelete-search-title' ) );
792 Xml
::openElement( 'form', array( 'method' => 'get', 'action' => $wgScript ) ) .
793 Xml
::fieldset( $this->msg( 'undelete-search-box' )->text() ) .
794 Html
::hidden( 'title', $this->getTitle()->getPrefixedDBkey() ) .
796 $this->msg( 'undelete-search-prefix' )->text(),
802 Xml
::submitButton( $this->msg( 'undelete-search-submit' )->text() ) .
803 Xml
::closeElement( 'fieldset' ) .
804 Xml
::closeElement( 'form' )
807 # List undeletable articles
808 if ( $this->mSearchPrefix
) {
809 $result = PageArchive
::listPagesByPrefix( $this->mSearchPrefix
);
810 $this->showList( $result );
815 * Generic list of deleted pages
817 * @param ResultWrapper $result
820 private function showList( $result ) {
821 $out = $this->getOutput();
823 if ( $result->numRows() == 0 ) {
824 $out->addWikiMsg( 'undelete-no-results' );
828 $out->addWikiMsg( 'undeletepagetext', $this->getLanguage()->formatNum( $result->numRows() ) );
830 $undelete = $this->getTitle();
831 $out->addHTML( "<ul>\n" );
832 foreach ( $result as $row ) {
833 $title = Title
::makeTitleSafe( $row->ar_namespace
, $row->ar_title
);
834 if ( $title !== null ) {
835 $item = Linker
::linkKnown(
837 htmlspecialchars( $title->getPrefixedText() ),
839 array( 'target' => $title->getPrefixedText() )
842 // The title is no longer valid, show as text
843 $item = Html
::element(
845 array( 'class' => 'mw-invalidtitle' ),
846 Linker
::getInvalidTitleDescription(
853 $revs = $this->msg( 'undeleterevisions' )->numParams( $row->count
)->parse();
854 $out->addHTML( "<li>{$item} ({$revs})</li>\n" );
857 $out->addHTML( "</ul>\n" );
862 private function showRevision( $timestamp ) {
863 if ( !preg_match( '/[0-9]{14}/', $timestamp ) ) {
867 $archive = new PageArchive( $this->mTargetObj
);
868 if ( !wfRunHooks( 'UndeleteForm::showRevision', array( &$archive, $this->mTargetObj
) ) ) {
871 $rev = $archive->getRevision( $timestamp );
873 $out = $this->getOutput();
874 $user = $this->getUser();
877 $out->addWikiMsg( 'undeleterevision-missing' );
881 if ( $rev->isDeleted( Revision
::DELETED_TEXT
) ) {
882 if ( !$rev->userCan( Revision
::DELETED_TEXT
, $user ) ) {
884 "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
885 'rev-deleted-text-permission'
891 "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
892 'rev-deleted-text-view'
894 $out->addHTML( '<br />' );
895 // and we are allowed to see...
898 if ( $this->mDiff
) {
899 $previousRev = $archive->getPreviousRevision( $timestamp );
900 if ( $previousRev ) {
901 $this->showDiff( $previousRev, $rev );
902 if ( $this->mDiffOnly
) {
906 $out->addHTML( '<hr />' );
908 $out->addWikiMsg( 'undelete-nodiff' );
912 $link = Linker
::linkKnown(
913 $this->getTitle( $this->mTargetObj
->getPrefixedDBkey() ),
914 htmlspecialchars( $this->mTargetObj
->getPrefixedText() )
917 $lang = $this->getLanguage();
919 // date and time are separate parameters to facilitate localisation.
920 // $time is kept for backward compat reasons.
921 $time = $lang->userTimeAndDate( $timestamp, $user );
922 $d = $lang->userDate( $timestamp, $user );
923 $t = $lang->userTime( $timestamp, $user );
924 $userLink = Linker
::revUserTools( $rev );
926 $content = $rev->getContent( Revision
::FOR_THIS_USER
, $user );
928 $isText = ( $content instanceof TextContent
);
930 if ( $this->mPreview ||
$isText ) {
931 $openDiv = '<div id="mw-undelete-revision" class="mw-warning">';
933 $openDiv = '<div id="mw-undelete-revision">';
935 $out->addHTML( $openDiv );
937 // Revision delete links
938 if ( !$this->mDiff
) {
939 $revdel = Linker
::getRevDeleteLink( $user, $rev, $this->mTargetObj
);
941 $out->addHTML( "$revdel " );
945 $out->addHTML( $this->msg( 'undelete-revision' )->rawParams( $link )->params(
946 $time )->rawParams( $userLink )->params( $d, $t )->parse() . '</div>' );
948 if ( !wfRunHooks( 'UndeleteShowRevision', array( $this->mTargetObj
, $rev ) ) ) {
952 if ( $this->mPreview ||
!$isText ) {
953 // NOTE: non-text content has no source view, so always use rendered preview
956 $popts = $out->parserOptions();
957 $popts->setEditSection( false );
959 $pout = $content->getParserOutput( $this->mTargetObj
, $rev->getId(), $popts, true );
960 $out->addParserOutput( $pout );
964 // source view for textual content
965 $sourceView = Xml
::element(
968 'readonly' => 'readonly',
969 'cols' => $user->getIntOption( 'cols' ),
970 'rows' => $user->getIntOption( 'rows' )
972 $content->getNativeData() . "\n"
975 $previewButton = Xml
::element( 'input', array(
978 'value' => $this->msg( 'showpreview' )->text()
985 $diffButton = Xml
::element( 'input', array(
988 'value' => $this->msg( 'showdiff' )->text() ) );
992 Xml
::openElement( 'div', array(
993 'style' => 'clear: both' ) ) .
994 Xml
::openElement( 'form', array(
996 'action' => $this->getTitle()->getLocalURL( array( 'action' => 'submit' ) ) ) ) .
997 Xml
::element( 'input', array(
1000 'value' => $this->mTargetObj
->getPrefixedDBkey() ) ) .
1001 Xml
::element( 'input', array(
1003 'name' => 'timestamp',
1004 'value' => $timestamp ) ) .
1005 Xml
::element( 'input', array(
1007 'name' => 'wpEditToken',
1008 'value' => $user->getEditToken() ) ) .
1011 Xml
::closeElement( 'form' ) .
1012 Xml
::closeElement( 'div' )
1017 * Build a diff display between this and the previous either deleted
1018 * or non-deleted edit.
1020 * @param Revision $previousRev
1021 * @param Revision $currentRev
1022 * @return string HTML
1024 function showDiff( $previousRev, $currentRev ) {
1025 $diffContext = clone $this->getContext();
1026 $diffContext->setTitle( $currentRev->getTitle() );
1027 $diffContext->setWikiPage( WikiPage
::factory( $currentRev->getTitle() ) );
1029 $diffEngine = $currentRev->getContentHandler()->createDifferenceEngine( $diffContext );
1030 $diffEngine->showDiffStyle();
1031 $this->getOutput()->addHTML( "<div>" .
1032 "<table style='width: 98%;' cellpadding='0' cellspacing='4' class='diff'>" .
1033 "<col class='diff-marker' />" .
1034 "<col class='diff-content' />" .
1035 "<col class='diff-marker' />" .
1036 "<col class='diff-content' />" .
1038 "<td colspan='2' style='width: 50%; text-align: center' class='diff-otitle'>" .
1039 $this->diffHeader( $previousRev, 'o' ) .
1041 "<td colspan='2' style='width: 50%; text-align: center' class='diff-ntitle'>" .
1042 $this->diffHeader( $currentRev, 'n' ) .
1045 $diffEngine->generateContentDiffBody(
1046 $previousRev->getContent( Revision
::FOR_THIS_USER
, $this->getUser() ),
1047 $currentRev->getContent( Revision
::FOR_THIS_USER
, $this->getUser() ) ) .
1054 * @param Revision $rev
1055 * @param string $prefix
1058 private function diffHeader( $rev, $prefix ) {
1059 $isDeleted = !( $rev->getId() && $rev->getTitle() );
1061 /// @todo FIXME: $rev->getTitle() is null for deleted revs...?
1062 $targetPage = $this->getTitle();
1063 $targetQuery = array(
1064 'target' => $this->mTargetObj
->getPrefixedText(),
1065 'timestamp' => wfTimestamp( TS_MW
, $rev->getTimestamp() )
1068 /// @todo FIXME: getId() may return non-zero for deleted revs...
1069 $targetPage = $rev->getTitle();
1070 $targetQuery = array( 'oldid' => $rev->getId() );
1073 // Add show/hide deletion links if available
1074 $user = $this->getUser();
1075 $lang = $this->getLanguage();
1076 $rdel = Linker
::getRevDeleteLink( $user, $rev, $this->mTargetObj
);
1082 return '<div id="mw-diff-' . $prefix . 'title1"><strong>' .
1087 $lang->userTimeAndDate( $rev->getTimestamp(), $user ),
1088 $lang->userDate( $rev->getTimestamp(), $user ),
1089 $lang->userTime( $rev->getTimestamp(), $user )
1095 '<div id="mw-diff-' . $prefix . 'title2">' .
1096 Linker
::revUserTools( $rev ) . '<br />' .
1098 '<div id="mw-diff-' . $prefix . 'title3">' .
1099 Linker
::revComment( $rev ) . $rdel . '<br />' .
1104 * Show a form confirming whether a tokenless user really wants to see a file
1106 private function showFileConfirmationForm( $key ) {
1107 $out = $this->getOutput();
1108 $lang = $this->getLanguage();
1109 $user = $this->getUser();
1110 $file = new ArchivedFile( $this->mTargetObj
, '', $this->mFilename
);
1111 $out->addWikiMsg( 'undelete-show-file-confirm',
1112 $this->mTargetObj
->getText(),
1113 $lang->userDate( $file->getTimestamp(), $user ),
1114 $lang->userTime( $file->getTimestamp(), $user ) );
1116 Xml
::openElement( 'form', array(
1118 'action' => $this->getTitle()->getLocalURL(
1119 'target=' . urlencode( $this->mTarget
) .
1120 '&file=' . urlencode( $key ) .
1121 '&token=' . urlencode( $user->getEditToken( $key ) ) )
1124 Xml
::submitButton( $this->msg( 'undelete-show-file-submit' )->text() ) .
1130 * Show a deleted file version requested by the visitor.
1132 private function showFile( $key ) {
1133 $this->getOutput()->disable();
1135 # We mustn't allow the output to be Squid cached, otherwise
1136 # if an admin previews a deleted image, and it's cached, then
1137 # a user without appropriate permissions can toddle off and
1138 # nab the image, and Squid will serve it
1139 $response = $this->getRequest()->response();
1140 $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
1141 $response->header( 'Cache-Control: no-cache, no-store, max-age=0, must-revalidate' );
1142 $response->header( 'Pragma: no-cache' );
1144 $repo = RepoGroup
::singleton()->getLocalRepo();
1145 $path = $repo->getZonePath( 'deleted' ) . '/' . $repo->getDeletedHashPath( $key ) . $key;
1146 $repo->streamFile( $path );
1149 private function showHistory() {
1150 $out = $this->getOutput();
1151 if ( $this->mAllowed
) {
1152 $out->addModules( 'mediawiki.special.undelete' );
1155 "<div class='mw-undelete-pagetitle'>\n$1\n</div>\n",
1156 array( 'undeletepagetitle', wfEscapeWikiText( $this->mTargetObj
->getPrefixedText() ) )
1159 $archive = new PageArchive( $this->mTargetObj
);
1160 wfRunHooks( 'UndeleteForm::showHistory', array( &$archive, $this->mTargetObj
) );
1162 $text = $archive->getLastRevisionText();
1163 if( is_null( $text ) ) {
1164 $out->addWikiMsg( 'nohistory' );
1168 $out->addHTML( '<div class="mw-undelete-history">' );
1169 if ( $this->mAllowed
) {
1170 $out->addWikiMsg( 'undeletehistory' );
1171 $out->addWikiMsg( 'undeleterevdel' );
1173 $out->addWikiMsg( 'undeletehistorynoadmin' );
1175 $out->addHTML( '</div>' );
1177 # List all stored revisions
1178 $revisions = $archive->listRevisions();
1179 $files = $archive->listFiles();
1181 $haveRevisions = $revisions && $revisions->numRows() > 0;
1182 $haveFiles = $files && $files->numRows() > 0;
1184 # Batch existence check on user and talk pages
1185 if ( $haveRevisions ) {
1186 $batch = new LinkBatch();
1187 foreach ( $revisions as $row ) {
1188 $batch->addObj( Title
::makeTitleSafe( NS_USER
, $row->ar_user_text
) );
1189 $batch->addObj( Title
::makeTitleSafe( NS_USER_TALK
, $row->ar_user_text
) );
1192 $revisions->seek( 0 );
1195 $batch = new LinkBatch();
1196 foreach ( $files as $row ) {
1197 $batch->addObj( Title
::makeTitleSafe( NS_USER
, $row->fa_user_text
) );
1198 $batch->addObj( Title
::makeTitleSafe( NS_USER_TALK
, $row->fa_user_text
) );
1204 if ( $this->mAllowed
) {
1205 $action = $this->getTitle()->getLocalURL( array( 'action' => 'submit' ) );
1206 # Start the form here
1207 $top = Xml
::openElement(
1209 array( 'method' => 'post', 'action' => $action, 'id' => 'undelete' )
1211 $out->addHTML( $top );
1214 # Show relevant lines from the deletion log:
1215 $deleteLogPage = new LogPage( 'delete' );
1216 $out->addHTML( Xml
::element( 'h2', null, $deleteLogPage->getName()->text() ) . "\n" );
1217 LogEventsList
::showLogExtract( $out, 'delete', $this->mTargetObj
);
1218 # Show relevant lines from the suppression log:
1219 $suppressLogPage = new LogPage( 'suppress' );
1220 if ( $this->getUser()->isAllowed( 'suppressionlog' ) ) {
1221 $out->addHTML( Xml
::element( 'h2', null, $suppressLogPage->getName()->text() ) . "\n" );
1222 LogEventsList
::showLogExtract( $out, 'suppress', $this->mTargetObj
);
1225 if ( $this->mAllowed
&& ( $haveRevisions ||
$haveFiles ) ) {
1226 # Format the user-visible controls (comment field, submission button)
1227 # in a nice little table
1228 if ( $this->getUser()->isAllowed( 'suppressrevision' ) ) {
1232 <td class='mw-input'>" .
1233 Xml
::checkLabel( $this->msg( 'revdelete-unsuppress' )->text(),
1234 'wpUnsuppress', 'mw-undelete-unsuppress', $this->mUnsuppress
) .
1238 $unsuppressBox = '';
1242 Xml
::fieldset( $this->msg( 'undelete-fieldset-title' )->text() ) .
1243 Xml
::openElement( 'table', array( 'id' => 'mw-undelete-table' ) ) .
1245 <td colspan='2' class='mw-undelete-extrahelp'>" .
1246 $this->msg( 'undeleteextrahelp' )->parseAsBlock() .
1250 <td class='mw-label'>" .
1251 Xml
::label( $this->msg( 'undeletecomment' )->text(), 'wpComment' ) .
1253 <td class='mw-input'>" .
1254 Xml
::input( 'wpComment', 50, $this->mComment
, array( 'id' => 'wpComment' ) ) .
1259 <td class='mw-submit'>" .
1260 Xml
::submitButton( $this->msg( 'undeletebtn' )->text(), array( 'name' => 'restore', 'id' => 'mw-undelete-submit' ) ) . ' ' .
1261 Xml
::submitButton( $this->msg( 'undeleteinvert' )->text(), array( 'name' => 'invert', 'id' => 'mw-undelete-invert' ) ) .
1265 Xml
::closeElement( 'table' ) .
1266 Xml
::closeElement( 'fieldset' );
1268 $out->addHTML( $table );
1271 $out->addHTML( Xml
::element( 'h2', null, $this->msg( 'history' )->text() ) . "\n" );
1273 if ( $haveRevisions ) {
1274 # The page's stored (deleted) history:
1275 $out->addHTML( '<ul>' );
1276 $remaining = $revisions->numRows();
1277 $earliestLiveTime = $this->mTargetObj
->getEarliestRevTime();
1279 foreach ( $revisions as $row ) {
1281 $out->addHTML( $this->formatRevisionRow( $row, $earliestLiveTime, $remaining ) );
1284 $out->addHTML( '</ul>' );
1286 $out->addWikiMsg( 'nohistory' );
1290 $out->addHTML( Xml
::element( 'h2', null, $this->msg( 'filehist' )->text() ) . "\n" );
1291 $out->addHTML( '<ul>' );
1292 foreach ( $files as $row ) {
1293 $out->addHTML( $this->formatFileRow( $row ) );
1296 $out->addHTML( '</ul>' );
1299 if ( $this->mAllowed
) {
1300 # Slip in the hidden controls here
1301 $misc = Html
::hidden( 'target', $this->mTarget
);
1302 $misc .= Html
::hidden( 'wpEditToken', $this->getUser()->getEditToken() );
1303 $misc .= Xml
::closeElement( 'form' );
1304 $out->addHTML( $misc );
1310 private function formatRevisionRow( $row, $earliestLiveTime, $remaining ) {
1311 $rev = Revision
::newFromArchiveRow( $row,
1313 'title' => $this->mTargetObj
1317 $ts = wfTimestamp( TS_MW
, $row->ar_timestamp
);
1318 // Build checkboxen...
1319 if ( $this->mAllowed
) {
1320 if ( $this->mInvert
) {
1321 if ( in_array( $ts, $this->mTargetTimestamp
) ) {
1322 $checkBox = Xml
::check( "ts$ts" );
1324 $checkBox = Xml
::check( "ts$ts", true );
1327 $checkBox = Xml
::check( "ts$ts" );
1333 // Build page & diff links...
1334 $user = $this->getUser();
1335 if ( $this->mCanView
) {
1336 $titleObj = $this->getTitle();
1338 if ( !$rev->userCan( Revision
::DELETED_TEXT
, $this->getUser() ) ) {
1339 $pageLink = htmlspecialchars( $this->getLanguage()->userTimeAndDate( $ts, $user ) );
1340 $last = $this->msg( 'diff' )->escaped();
1341 } elseif ( $remaining > 0 ||
( $earliestLiveTime && $ts > $earliestLiveTime ) ) {
1342 $pageLink = $this->getPageLink( $rev, $titleObj, $ts );
1343 $last = Linker
::linkKnown(
1345 $this->msg( 'diff' )->escaped(),
1348 'target' => $this->mTargetObj
->getPrefixedText(),
1354 $pageLink = $this->getPageLink( $rev, $titleObj, $ts );
1355 $last = $this->msg( 'diff' )->escaped();
1358 $pageLink = htmlspecialchars( $this->getLanguage()->userTimeAndDate( $ts, $user ) );
1359 $last = $this->msg( 'diff' )->escaped();
1363 $userLink = Linker
::revUserTools( $rev );
1365 // Revision text size
1366 $size = $row->ar_len
;
1367 if ( !is_null( $size ) ) {
1368 $revTextSize = Linker
::formatRevisionSize( $size );
1372 $comment = Linker
::revComment( $rev );
1374 // Revision delete links
1375 $revdlink = Linker
::getRevDeleteLink( $user, $rev, $this->mTargetObj
);
1377 $revisionRow = $this->msg( 'undelete-revisionrow' )
1378 ->rawParams( $checkBox, $revdlink, $last, $pageLink, $userLink, $revTextSize, $comment )
1381 return "<li>$revisionRow</li>";
1384 private function formatFileRow( $row ) {
1385 $file = ArchivedFile
::newFromRow( $row );
1386 $ts = wfTimestamp( TS_MW
, $row->fa_timestamp
);
1387 $user = $this->getUser();
1389 if ( $this->mAllowed
&& $row->fa_storage_key
) {
1390 $checkBox = Xml
::check( 'fileid' . $row->fa_id
);
1391 $key = urlencode( $row->fa_storage_key
);
1392 $pageLink = $this->getFileLink( $file, $this->getTitle(), $ts, $key );
1395 $pageLink = $this->getLanguage()->userTimeAndDate( $ts, $user );
1397 $userLink = $this->getFileUser( $file );
1398 $data = $this->msg( 'widthheight' )->numParams( $row->fa_width
, $row->fa_height
)->text();
1399 $bytes = $this->msg( 'parentheses' )
1400 ->rawParams( $this->msg( 'nbytes' )->numParams( $row->fa_size
)->text() )
1402 $data = htmlspecialchars( $data . ' ' . $bytes );
1403 $comment = $this->getFileComment( $file );
1405 // Add show/hide deletion links if available
1406 $canHide = $user->isAllowed( 'deleterevision' );
1407 if ( $canHide ||
( $file->getVisibility() && $user->isAllowed( 'deletedhistory' ) ) ) {
1408 if ( !$file->userCan( File
::DELETED_RESTRICTED
, $user ) ) {
1409 // Revision was hidden from sysops
1410 $revdlink = Linker
::revDeleteLinkDisabled( $canHide );
1413 'type' => 'filearchive',
1414 'target' => $this->mTargetObj
->getPrefixedDBkey(),
1415 'ids' => $row->fa_id
1417 $revdlink = Linker
::revDeleteLink( $query,
1418 $file->isDeleted( File
::DELETED_RESTRICTED
), $canHide );
1424 return "<li>$checkBox $revdlink $pageLink . . $userLink $data $comment</li>\n";
1428 * Fetch revision text link if it's available to all users
1430 * @param Revision $rev
1431 * @param Title $titleObj
1432 * @param string $ts Timestamp
1435 function getPageLink( $rev, $titleObj, $ts ) {
1436 $user = $this->getUser();
1437 $time = $this->getLanguage()->userTimeAndDate( $ts, $user );
1439 if ( !$rev->userCan( Revision
::DELETED_TEXT
, $user ) ) {
1440 return '<span class="history-deleted">' . $time . '</span>';
1443 $link = Linker
::linkKnown(
1445 htmlspecialchars( $time ),
1448 'target' => $this->mTargetObj
->getPrefixedText(),
1453 if ( $rev->isDeleted( Revision
::DELETED_TEXT
) ) {
1454 $link = '<span class="history-deleted">' . $link . '</span>';
1461 * Fetch image view link if it's available to all users
1463 * @param File|ArchivedFile $file
1464 * @param Title $titleObj
1465 * @param string $ts A timestamp
1466 * @param string $key a storage key
1468 * @return string HTML fragment
1470 function getFileLink( $file, $titleObj, $ts, $key ) {
1471 $user = $this->getUser();
1472 $time = $this->getLanguage()->userTimeAndDate( $ts, $user );
1474 if ( !$file->userCan( File
::DELETED_FILE
, $user ) ) {
1475 return '<span class="history-deleted">' . $time . '</span>';
1478 $link = Linker
::linkKnown(
1480 htmlspecialchars( $time ),
1483 'target' => $this->mTargetObj
->getPrefixedText(),
1485 'token' => $user->getEditToken( $key )
1489 if ( $file->isDeleted( File
::DELETED_FILE
) ) {
1490 $link = '<span class="history-deleted">' . $link . '</span>';
1497 * Fetch file's user id if it's available to this user
1499 * @param File|ArchivedFile $file
1500 * @return string HTML fragment
1502 function getFileUser( $file ) {
1503 if ( !$file->userCan( File
::DELETED_USER
, $this->getUser() ) ) {
1504 return '<span class="history-deleted">' .
1505 $this->msg( 'rev-deleted-user' )->escaped() .
1509 $link = Linker
::userLink( $file->getRawUser(), $file->getRawUserText() ) .
1510 Linker
::userToolLinks( $file->getRawUser(), $file->getRawUserText() );
1512 if ( $file->isDeleted( File
::DELETED_USER
) ) {
1513 $link = '<span class="history-deleted">' . $link . '</span>';
1520 * Fetch file upload comment if it's available to this user
1522 * @param File|ArchivedFile $file
1523 * @return string HTML fragment
1525 function getFileComment( $file ) {
1526 if ( !$file->userCan( File
::DELETED_COMMENT
, $this->getUser() ) ) {
1527 return '<span class="history-deleted"><span class="comment">' .
1528 $this->msg( 'rev-deleted-comment' )->escaped() . '</span></span>';
1531 $link = Linker
::commentBlock( $file->getRawDescription() );
1533 if ( $file->isDeleted( File
::DELETED_COMMENT
) ) {
1534 $link = '<span class="history-deleted">' . $link . '</span>';
1540 function undelete() {
1541 global $wgUploadMaintenance;
1543 if ( $wgUploadMaintenance && $this->mTargetObj
->getNamespace() == NS_FILE
) {
1544 throw new ErrorPageError( 'undelete-error', 'filedelete-maintenance' );
1547 if ( wfReadOnly() ) {
1548 throw new ReadOnlyError
;
1551 $out = $this->getOutput();
1552 $archive = new PageArchive( $this->mTargetObj
);
1553 wfRunHooks( 'UndeleteForm::undelete', array( &$archive, $this->mTargetObj
) );
1554 $ok = $archive->undelete(
1555 $this->mTargetTimestamp
,
1557 $this->mFileVersions
,
1562 if ( is_array( $ok ) ) {
1563 if ( $ok[1] ) { // Undeleted file count
1564 wfRunHooks( 'FileUndeleteComplete', array(
1565 $this->mTargetObj
, $this->mFileVersions
,
1566 $this->getUser(), $this->mComment
) );
1569 $link = Linker
::linkKnown( $this->mTargetObj
);
1570 $out->addHTML( $this->msg( 'undeletedpage' )->rawParams( $link )->parse() );
1572 $out->setPageTitle( $this->msg( 'undelete-error' ) );
1575 // Show revision undeletion warnings and errors
1576 $status = $archive->getRevisionStatus();
1577 if ( $status && !$status->isGood() ) {
1578 $out->addWikiText( '<div class="error">' . $status->getWikiText( 'cannotundelete', 'cannotundelete' ) . '</div>' );
1581 // Show file undeletion warnings and errors
1582 $status = $archive->getFileStatus();
1583 if ( $status && !$status->isGood() ) {
1584 $out->addWikiText( '<div class="error">' . $status->getWikiText( 'undelete-error-short', 'undelete-error-long' ) . '</div>' );
1588 protected function getGroupName() {