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
39 protected $fileStatus;
44 protected $revisionStatus;
46 function __construct( $title ) {
47 if( is_null( $title ) ) {
48 throw new MWException( __METHOD__
. ' given a null title.' );
50 $this->title
= $title;
54 * List all deleted pages recorded in the archive table. Returns result
55 * wrapper with (ar_namespace, ar_title, count) fields, ordered by page
58 * @return ResultWrapper
60 public static function listAllPages() {
61 $dbr = wfGetDB( DB_SLAVE
);
62 return self
::listPages( $dbr, '' );
66 * List deleted pages recorded in the archive table matching the
68 * Returns result wrapper with (ar_namespace, ar_title, count) fields.
70 * @param $prefix String: title prefix
71 * @return ResultWrapper
73 public static function listPagesByPrefix( $prefix ) {
74 $dbr = wfGetDB( DB_SLAVE
);
76 $title = Title
::newFromText( $prefix );
78 $ns = $title->getNamespace();
79 $prefix = $title->getDBkey();
81 // Prolly won't work too good
82 // @todo handle bare namespace names cleanly?
86 'ar_namespace' => $ns,
87 'ar_title' . $dbr->buildLike( $prefix, $dbr->anyString() ),
89 return self
::listPages( $dbr, $conds );
93 * @param $dbr DatabaseBase
95 * @return bool|ResultWrapper
97 protected static function listPages( $dbr, $condition ) {
98 return $dbr->resultObject(
104 'count' => 'COUNT(*)'
109 'GROUP BY' => array( 'ar_namespace', 'ar_title' ),
110 'ORDER BY' => array( 'ar_namespace', 'ar_title' ),
118 * List the revisions of the given page. Returns result wrapper with
119 * (ar_minor_edit, ar_timestamp, ar_user, ar_user_text, ar_comment) fields.
121 * @return ResultWrapper
123 function listRevisions() {
124 global $wgContentHandlerUseDB;
126 $dbr = wfGetDB( DB_SLAVE
);
129 'ar_minor_edit', 'ar_timestamp', 'ar_user', 'ar_user_text',
130 'ar_comment', 'ar_len', 'ar_deleted', 'ar_rev_id', 'ar_sha1',
133 if ( $wgContentHandlerUseDB ) {
134 $fields[] = 'ar_content_format';
135 $fields[] = 'ar_content_model';
138 $res = $dbr->select( 'archive',
140 array( 'ar_namespace' => $this->title
->getNamespace(),
141 'ar_title' => $this->title
->getDBkey() ),
143 array( 'ORDER BY' => 'ar_timestamp DESC' ) );
144 $ret = $dbr->resultObject( $res );
149 * List the deleted file revisions for this page, if it's a file page.
150 * Returns a result wrapper with various filearchive fields, or null
151 * if not a file page.
153 * @return ResultWrapper
154 * @todo Does this belong in Image for fuller encapsulation?
156 function listFiles() {
157 if( $this->title
->getNamespace() == NS_FILE
) {
158 $dbr = wfGetDB( DB_SLAVE
);
159 $res = $dbr->select( 'filearchive',
180 array( 'fa_name' => $this->title
->getDBkey() ),
182 array( 'ORDER BY' => 'fa_timestamp DESC' ) );
183 $ret = $dbr->resultObject( $res );
190 * Return a Revision object containing data for the deleted revision.
191 * Note that the result *may* or *may not* have a null page ID.
193 * @param $timestamp String
196 function getRevision( $timestamp ) {
197 global $wgContentHandlerUseDB;
199 $dbr = wfGetDB( DB_SLAVE
);
216 if ( $wgContentHandlerUseDB ) {
217 $fields[] = 'ar_content_format';
218 $fields[] = 'ar_content_model';
221 $row = $dbr->selectRow( 'archive',
223 array( 'ar_namespace' => $this->title
->getNamespace(),
224 'ar_title' => $this->title
->getDBkey(),
225 'ar_timestamp' => $dbr->timestamp( $timestamp ) ),
228 return Revision
::newFromArchiveRow( $row, array( 'title' => $this->title
) );
235 * Return the most-previous revision, either live or deleted, against
236 * the deleted revision given by timestamp.
238 * May produce unexpected results in case of history merges or other
239 * unusual time issues.
241 * @param $timestamp String
242 * @return Revision or null
244 function getPreviousRevision( $timestamp ) {
245 $dbr = wfGetDB( DB_SLAVE
);
247 // Check the previous deleted revision...
248 $row = $dbr->selectRow( 'archive',
250 array( 'ar_namespace' => $this->title
->getNamespace(),
251 'ar_title' => $this->title
->getDBkey(),
253 $dbr->addQuotes( $dbr->timestamp( $timestamp ) ) ),
256 'ORDER BY' => 'ar_timestamp DESC',
258 $prevDeleted = $row ?
wfTimestamp( TS_MW
, $row->ar_timestamp
) : false;
260 $row = $dbr->selectRow( array( 'page', 'revision' ),
261 array( 'rev_id', 'rev_timestamp' ),
263 'page_namespace' => $this->title
->getNamespace(),
264 'page_title' => $this->title
->getDBkey(),
265 'page_id = rev_page',
267 $dbr->addQuotes( $dbr->timestamp( $timestamp ) ) ),
270 'ORDER BY' => 'rev_timestamp DESC',
272 $prevLive = $row ?
wfTimestamp( TS_MW
, $row->rev_timestamp
) : false;
273 $prevLiveId = $row ?
intval( $row->rev_id
) : null;
275 if( $prevLive && $prevLive > $prevDeleted ) {
276 // Most prior revision was live
277 return Revision
::newFromId( $prevLiveId );
278 } elseif( $prevDeleted ) {
279 // Most prior revision was deleted
280 return $this->getRevision( $prevDeleted );
282 // No prior revision on this page.
288 * Get the text from an archive row containing ar_text, ar_flags and ar_text_id
290 * @param $row Object: database row
293 function getTextFromRow( $row ) {
294 if( is_null( $row->ar_text_id
) ) {
295 // An old row from MediaWiki 1.4 or previous.
296 // Text is embedded in this row in classic compression format.
297 return Revision
::getRevisionText( $row, 'ar_' );
299 // New-style: keyed to the text storage backend.
300 $dbr = wfGetDB( DB_SLAVE
);
301 $text = $dbr->selectRow( 'text',
302 array( 'old_text', 'old_flags' ),
303 array( 'old_id' => $row->ar_text_id
),
305 return Revision
::getRevisionText( $text );
310 * Fetch (and decompress if necessary) the stored text of the most
311 * recently edited deleted revision of the page.
313 * If there are no archived revisions for the page, returns NULL.
317 function getLastRevisionText() {
318 $dbr = wfGetDB( DB_SLAVE
);
319 $row = $dbr->selectRow( 'archive',
320 array( 'ar_text', 'ar_flags', 'ar_text_id' ),
321 array( 'ar_namespace' => $this->title
->getNamespace(),
322 'ar_title' => $this->title
->getDBkey() ),
324 array( 'ORDER BY' => 'ar_timestamp DESC' ) );
326 return $this->getTextFromRow( $row );
333 * Quick check if any archived revisions are present for the page.
337 function isDeleted() {
338 $dbr = wfGetDB( DB_SLAVE
);
339 $n = $dbr->selectField( 'archive', 'COUNT(ar_title)',
340 array( 'ar_namespace' => $this->title
->getNamespace(),
341 'ar_title' => $this->title
->getDBkey() ),
348 * Restore the given (or all) text and file revisions for the page.
349 * Once restored, the items will be removed from the archive tables.
350 * The deletion log will be updated with an undeletion notice.
352 * @param $timestamps Array: pass an empty array to restore all revisions, otherwise list the ones to undelete.
353 * @param $comment String
354 * @param $fileVersions Array
355 * @param $unsuppress Boolean
356 * @param $user User doing the action, or null to use $wgUser
358 * @return array(number of file revisions restored, number of image revisions restored, log message)
359 * on success, false on failure
361 function undelete( $timestamps, $comment = '', $fileVersions = array(), $unsuppress = false, User
$user = null ) {
362 // If both the set of text revisions and file revisions are empty,
363 // restore everything. Otherwise, just restore the requested items.
364 $restoreAll = empty( $timestamps ) && empty( $fileVersions );
366 $restoreText = $restoreAll ||
!empty( $timestamps );
367 $restoreFiles = $restoreAll ||
!empty( $fileVersions );
369 if( $restoreFiles && $this->title
->getNamespace() == NS_FILE
) {
370 $img = wfLocalFile( $this->title
);
371 $this->fileStatus
= $img->restore( $fileVersions, $unsuppress );
372 if ( !$this->fileStatus
->isOK() ) {
375 $filesRestored = $this->fileStatus
->successCount
;
381 $this->revisionStatus
= $this->undeleteRevisions( $timestamps, $unsuppress, $comment );
382 if( !$this->revisionStatus
->isOK() ) {
386 $textRestored = $this->revisionStatus
->getValue();
393 if( $textRestored && $filesRestored ) {
394 $reason = wfMessage( 'undeletedrevisions-files' )
395 ->numParams( $textRestored, $filesRestored )->inContentLanguage()->text();
396 } elseif( $textRestored ) {
397 $reason = wfMessage( 'undeletedrevisions' )->numParams( $textRestored )
398 ->inContentLanguage()->text();
399 } elseif( $filesRestored ) {
400 $reason = wfMessage( 'undeletedfiles' )->numParams( $filesRestored )
401 ->inContentLanguage()->text();
403 wfDebug( "Undelete: nothing undeleted...\n" );
407 if( trim( $comment ) != '' ) {
408 $reason .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $comment;
411 if ( $user === null ) {
416 $logEntry = new ManualLogEntry( 'delete', 'restore' );
417 $logEntry->setPerformer( $user );
418 $logEntry->setTarget( $this->title
);
419 $logEntry->setComment( $reason );
420 $logid = $logEntry->insert();
421 $logEntry->publish( $logid );
423 return array( $textRestored, $filesRestored, $reason );
427 * This is the meaty bit -- restores archived revisions of the given page
428 * to the cur/old tables. If the page currently exists, all revisions will
429 * be stuffed into old, otherwise the most recent will go into cur.
431 * @param $timestamps Array: pass an empty array to restore all revisions, otherwise list the ones to undelete.
432 * @param $comment String
433 * @param $unsuppress Boolean: remove all ar_deleted/fa_deleted restrictions of seletected revs
435 * @return Status, containing the number of revisions restored on success
437 private function undeleteRevisions( $timestamps, $unsuppress = false, $comment = '' ) {
438 global $wgContentHandlerUseDB;
440 if ( wfReadOnly() ) {
441 throw new ReadOnlyError();
443 $restoreAll = empty( $timestamps );
445 $dbw = wfGetDB( DB_MASTER
);
447 # Does this page already exist? We'll have to update it...
448 $article = WikiPage
::factory( $this->title
);
449 # Load latest data for the current page (bug 31179)
450 $article->loadPageData( 'fromdbmaster' );
451 $oldcountable = $article->isCountable();
453 $page = $dbw->selectRow( 'page',
454 array( 'page_id', 'page_latest' ),
455 array( 'page_namespace' => $this->title
->getNamespace(),
456 'page_title' => $this->title
->getDBkey() ),
458 array( 'FOR UPDATE' ) // lock page
462 # Page already exists. Import the history, and if necessary
463 # we'll update the latest revision field in the record.
465 $pageId = $page->page_id
;
466 $previousRevId = $page->page_latest
;
467 # Get the time span of this page
468 $previousTimestamp = $dbw->selectField( 'revision', 'rev_timestamp',
469 array( 'rev_id' => $previousRevId ),
472 if( $previousTimestamp === false ) {
473 wfDebug( __METHOD__
.": existing page refers to a page_latest that does not exist\n" );
475 $status = Status
::newGood( 0 );
476 $status->warning( 'undeleterevision-missing' );
481 # Have to create a new article...
484 $previousTimestamp = 0;
488 $oldones = '1 = 1'; # All revisions...
490 $oldts = implode( ',',
491 array_map( array( &$dbw, 'addQuotes' ),
492 array_map( array( &$dbw, 'timestamp' ),
495 $oldones = "ar_timestamp IN ( {$oldts} )";
513 if ( $wgContentHandlerUseDB ) {
514 $fields[] = 'ar_content_format';
515 $fields[] = 'ar_content_model';
519 * Select each archived revision...
521 $result = $dbw->select( 'archive',
524 'ar_namespace' => $this->title
->getNamespace(),
525 'ar_title' => $this->title
->getDBkey(),
528 /* options */ array( 'ORDER BY' => 'ar_timestamp' )
530 $ret = $dbw->resultObject( $result );
531 $rev_count = $dbw->numRows( $result );
533 wfDebug( __METHOD__
. ": no revisions to restore\n" );
535 $status = Status
::newGood( 0 );
536 $status->warning( "undelete-no-results" );
540 $ret->seek( $rev_count - 1 ); // move to last
541 $row = $ret->fetchObject(); // get newest archived rev
542 $ret->seek( 0 ); // move back
544 // grab the content to check consistency with global state before restoring the page.
545 $revision = Revision
::newFromArchiveRow( $row,
547 'title' => $article->getTitle(), // used to derive default content model
550 $m = $revision->getContentModel();
552 $user = User
::newFromName( $revision->getRawUserText(), false );
553 $content = $revision->getContent( Revision
::RAW
);
555 //NOTE: article ID may not be known yet. prepareSave() should not modify the database.
556 $status = $content->prepareSave( $article, 0, -1, $user );
558 if ( !$status->isOK() ) {
563 // Check the state of the newest to-be version...
564 if( !$unsuppress && ( $row->ar_deleted
& Revision
::DELETED_TEXT
) ) {
565 return Status
::newFatal( "undeleterevdel" );
567 // Safe to insert now...
568 $newid = $article->insertOn( $dbw );
571 // Check if a deleted revision will become the current revision...
572 if( $row->ar_timestamp
> $previousTimestamp ) {
573 // Check the state of the newest to-be version...
574 if( !$unsuppress && ( $row->ar_deleted
& Revision
::DELETED_TEXT
) ) {
575 return Status
::newFatal( "undeleterevdel" );
583 foreach ( $ret as $row ) {
584 // Check for key dupes due to shitty archive integrity.
585 if( $row->ar_rev_id
) {
586 $exists = $dbw->selectField( 'revision', '1',
587 array( 'rev_id' => $row->ar_rev_id
), __METHOD__
);
589 continue; // don't throw DB errors
592 // Insert one revision at a time...maintaining deletion status
593 // unless we are specifically removing all restrictions...
594 $revision = Revision
::newFromArchiveRow( $row,
596 'title' => $this->title
,
597 'deleted' => $unsuppress ?
0 : $row->ar_deleted
600 $revision->insertOn( $dbw );
603 wfRunHooks( 'ArticleRevisionUndeleted', array( &$this->title
, $revision, $row->ar_page_id
) );
605 # Now that it's safely stored, take it out of the archive
606 $dbw->delete( 'archive',
608 'ar_namespace' => $this->title
->getNamespace(),
609 'ar_title' => $this->title
->getDBkey(),
613 // Was anything restored at all?
614 if ( $restored == 0 ) {
615 return Status
::newGood( 0 );
618 $created = (bool)$newid;
620 // Attach the latest revision to the page...
621 $wasnew = $article->updateIfNewerOn( $dbw, $revision, $previousRevId );
622 if ( $created ||
$wasnew ) {
623 // Update site stats, link tables, etc
624 $user = User
::newFromName( $revision->getRawUserText(), false );
625 $article->doEditUpdates( $revision, $user, array( 'created' => $created, 'oldcountable' => $oldcountable ) );
628 wfRunHooks( 'ArticleUndelete', array( &$this->title
, $created, $comment ) );
630 if( $this->title
->getNamespace() == NS_FILE
) {
631 $update = new HTMLCacheUpdate( $this->title
, 'imagelinks' );
635 return Status
::newGood( $restored );
641 function getFileStatus() { return $this->fileStatus
; }
646 function getRevisionStatus() { return $this->revisionStatus
; }
650 * Special page allowing users with the appropriate permissions to view
651 * and restore deleted content.
653 * @ingroup SpecialPage
655 class SpecialUndelete
extends SpecialPage
{
656 var $mAction, $mTarget, $mTimestamp, $mRestore, $mInvert, $mFilename;
657 var $mTargetTimestamp, $mAllowed, $mCanView, $mComment, $mToken;
664 function __construct() {
665 parent
::__construct( 'Undelete', 'deletedhistory' );
668 function loadRequest( $par ) {
669 $request = $this->getRequest();
670 $user = $this->getUser();
672 $this->mAction
= $request->getVal( 'action' );
673 if ( $par !== null && $par !== '' ) {
674 $this->mTarget
= $par;
676 $this->mTarget
= $request->getVal( 'target' );
678 $this->mTargetObj
= null;
679 if ( $this->mTarget
!== null && $this->mTarget
!== '' ) {
680 $this->mTargetObj
= Title
::newFromURL( $this->mTarget
);
682 $this->mSearchPrefix
= $request->getText( 'prefix' );
683 $time = $request->getVal( 'timestamp' );
684 $this->mTimestamp
= $time ?
wfTimestamp( TS_MW
, $time ) : '';
685 $this->mFilename
= $request->getVal( 'file' );
687 $posted = $request->wasPosted() &&
688 $user->matchEditToken( $request->getVal( 'wpEditToken' ) );
689 $this->mRestore
= $request->getCheck( 'restore' ) && $posted;
690 $this->mInvert
= $request->getCheck( 'invert' ) && $posted;
691 $this->mPreview
= $request->getCheck( 'preview' ) && $posted;
692 $this->mDiff
= $request->getCheck( 'diff' );
693 $this->mDiffOnly
= $request->getBool( 'diffonly', $this->getUser()->getOption( 'diffonly' ) );
694 $this->mComment
= $request->getText( 'wpComment' );
695 $this->mUnsuppress
= $request->getVal( 'wpUnsuppress' ) && $user->isAllowed( 'suppressrevision' );
696 $this->mToken
= $request->getVal( 'token' );
698 if ( $user->isAllowed( 'undelete' ) && !$user->isBlocked() ) {
699 $this->mAllowed
= true; // user can restore
700 $this->mCanView
= true; // user can view content
701 } elseif ( $user->isAllowed( 'deletedtext' ) ) {
702 $this->mAllowed
= false; // user cannot restore
703 $this->mCanView
= true; // user can view content
704 $this->mRestore
= false;
705 } else { // user can only view the list of revisions
706 $this->mAllowed
= false;
707 $this->mCanView
= false;
708 $this->mTimestamp
= '';
709 $this->mRestore
= false;
712 if( $this->mRestore ||
$this->mInvert
) {
713 $timestamps = array();
714 $this->mFileVersions
= array();
715 foreach( $request->getValues() as $key => $val ) {
717 if( preg_match( '/^ts(\d{14})$/', $key, $matches ) ) {
718 array_push( $timestamps, $matches[1] );
721 if( preg_match( '/^fileid(\d+)$/', $key, $matches ) ) {
722 $this->mFileVersions
[] = intval( $matches[1] );
725 rsort( $timestamps );
726 $this->mTargetTimestamp
= $timestamps;
730 function execute( $par ) {
731 $this->checkPermissions();
732 $user = $this->getUser();
735 $this->outputHeader();
737 $this->loadRequest( $par );
739 $out = $this->getOutput();
741 if ( is_null( $this->mTargetObj
) ) {
742 $out->addWikiMsg( 'undelete-header' );
744 # Not all users can just browse every deleted page from the list
745 if ( $user->isAllowed( 'browsearchive' ) ) {
746 $this->showSearchForm();
751 if ( $this->mAllowed
) {
752 $out->setPageTitle( $this->msg( 'undeletepage' ) );
754 $out->setPageTitle( $this->msg( 'viewdeletedpage' ) );
757 $this->getSkin()->setRelevantTitle( $this->mTargetObj
);
759 if ( $this->mTimestamp
!== '' ) {
760 $this->showRevision( $this->mTimestamp
);
761 } elseif ( $this->mFilename
!== null ) {
762 $file = new ArchivedFile( $this->mTargetObj
, '', $this->mFilename
);
763 // Check if user is allowed to see this file
764 if ( !$file->exists() ) {
765 $out->addWikiMsg( 'filedelete-nofile', $this->mFilename
);
766 } elseif ( !$file->userCan( File
::DELETED_FILE
, $user ) ) {
767 if( $file->isDeleted( File
::DELETED_RESTRICTED
) ) {
768 throw new PermissionsError( 'suppressrevision' );
770 throw new PermissionsError( 'deletedtext' );
772 } elseif ( !$user->matchEditToken( $this->mToken
, $this->mFilename
) ) {
773 $this->showFileConfirmationForm( $this->mFilename
);
775 $this->showFile( $this->mFilename
);
777 } elseif ( $this->mRestore
&& $this->mAction
== 'submit' ) {
780 $this->showHistory();
784 function showSearchForm() {
787 $out = $this->getOutput();
788 $out->setPageTitle( $this->msg( 'undelete-search-title' ) );
790 Xml
::openElement( 'form', array(
792 'action' => $wgScript ) ) .
793 Xml
::fieldset( $this->msg( 'undelete-search-box' )->text() ) .
794 Html
::hidden( 'title',
795 $this->getTitle()->getPrefixedDbKey() ) .
796 Xml
::inputLabel( $this->msg( 'undelete-search-prefix' )->text(),
797 'prefix', 'prefix', 20,
798 $this->mSearchPrefix
) . ' ' .
799 Xml
::submitButton( $this->msg( 'undelete-search-submit' )->text() ) .
800 Xml
::closeElement( 'fieldset' ) .
801 Xml
::closeElement( 'form' )
804 # List undeletable articles
805 if( $this->mSearchPrefix
) {
806 $result = PageArchive
::listPagesByPrefix( $this->mSearchPrefix
);
807 $this->showList( $result );
812 * Generic list of deleted pages
814 * @param $result ResultWrapper
817 private function showList( $result ) {
818 $out = $this->getOutput();
820 if( $result->numRows() == 0 ) {
821 $out->addWikiMsg( 'undelete-no-results' );
825 $out->addWikiMsg( 'undeletepagetext', $this->getLanguage()->formatNum( $result->numRows() ) );
827 $undelete = $this->getTitle();
828 $out->addHTML( "<ul>\n" );
829 foreach ( $result as $row ) {
830 $title = Title
::makeTitleSafe( $row->ar_namespace
, $row->ar_title
);
831 if ( $title !== null ) {
832 $item = Linker
::linkKnown(
834 htmlspecialchars( $title->getPrefixedText() ),
836 array( 'target' => $title->getPrefixedText() )
839 // The title is no longer valid, show as text
840 $item = Html
::element( 'span', array( 'class' => 'mw-invalidtitle' ),
841 Linker
::getInvalidTitleDescription( $this->getContext(), $row->ar_namespace
, $row->ar_title
) );
843 $revs = $this->msg( 'undeleterevisions' )->numParams( $row->count
)->parse();
844 $out->addHTML( "<li>{$item} ({$revs})</li>\n" );
847 $out->addHTML( "</ul>\n" );
852 private function showRevision( $timestamp ) {
853 if( !preg_match( '/[0-9]{14}/', $timestamp ) ) {
857 $archive = new PageArchive( $this->mTargetObj
);
858 if ( !wfRunHooks( 'UndeleteForm::showRevision', array( &$archive, $this->mTargetObj
) ) ) {
861 $rev = $archive->getRevision( $timestamp );
863 $out = $this->getOutput();
864 $user = $this->getUser();
867 $out->addWikiMsg( 'undeleterevision-missing' );
871 if( $rev->isDeleted( Revision
::DELETED_TEXT
) ) {
872 if( !$rev->userCan( Revision
::DELETED_TEXT
, $user ) ) {
873 $out->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n", 'rev-deleted-text-permission' );
876 $out->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n", 'rev-deleted-text-view' );
877 $out->addHTML( '<br />' );
878 // and we are allowed to see...
883 $previousRev = $archive->getPreviousRevision( $timestamp );
885 $this->showDiff( $previousRev, $rev );
886 if( $this->mDiffOnly
) {
889 $out->addHTML( '<hr />' );
892 $out->addWikiMsg( 'undelete-nodiff' );
896 $link = Linker
::linkKnown(
897 $this->getTitle( $this->mTargetObj
->getPrefixedDBkey() ),
898 htmlspecialchars( $this->mTargetObj
->getPrefixedText() )
901 $lang = $this->getLanguage();
903 // date and time are separate parameters to facilitate localisation.
904 // $time is kept for backward compat reasons.
905 $time = $lang->userTimeAndDate( $timestamp, $user );
906 $d = $lang->userDate( $timestamp, $user );
907 $t = $lang->userTime( $timestamp, $user );
908 $userLink = Linker
::revUserTools( $rev );
910 $content = $rev->getContent( Revision
::FOR_THIS_USER
, $user );
912 $isText = ( $content instanceof TextContent
);
914 if( $this->mPreview ||
$isText ) {
915 $openDiv = '<div id="mw-undelete-revision" class="mw-warning">';
917 $openDiv = '<div id="mw-undelete-revision">';
919 $out->addHTML( $openDiv );
921 // Revision delete links
922 if ( !$this->mDiff
) {
923 $revdel = Linker
::getRevDeleteLink( $user, $rev, $this->mTargetObj
);
925 $out->addHTML( "$revdel " );
929 $out->addHTML( $this->msg( 'undelete-revision' )->rawParams( $link )->params(
930 $time )->rawParams( $userLink )->params( $d, $t )->parse() . '</div>' );
932 if ( !wfRunHooks( 'UndeleteShowRevision', array( $this->mTargetObj
, $rev ) ) ) {
936 if( $this->mPreview ||
!$isText ) {
937 // NOTE: non-text content has no source view, so always use rendered preview
940 $popts = $out->parserOptions();
941 $popts->setEditSection( false );
943 $pout = $content->getParserOutput( $this->mTargetObj
, $rev->getId(), $popts, true );
944 $out->addParserOutput( $pout );
948 // source view for textual content
949 $sourceView = Xml
::element( 'textarea', array(
950 'readonly' => 'readonly',
951 'cols' => intval( $user->getOption( 'cols' ) ),
952 'rows' => intval( $user->getOption( 'rows' ) ) ),
953 $content->getNativeData() . "\n" );
955 $previewButton = Xml
::element( 'input', array(
958 'value' => $this->msg( 'showpreview' )->text() ) );
964 $diffButton = Xml
::element( 'input', array(
967 'value' => $this->msg( 'showdiff' )->text() ) );
971 Xml
::openElement( 'div', array(
972 'style' => 'clear: both' ) ) .
973 Xml
::openElement( 'form', array(
975 'action' => $this->getTitle()->getLocalURL( array( 'action' => 'submit' ) ) ) ) .
976 Xml
::element( 'input', array(
979 'value' => $this->mTargetObj
->getPrefixedDbKey() ) ) .
980 Xml
::element( 'input', array(
982 'name' => 'timestamp',
983 'value' => $timestamp ) ) .
984 Xml
::element( 'input', array(
986 'name' => 'wpEditToken',
987 'value' => $user->getEditToken() ) ) .
990 Xml
::closeElement( 'form' ) .
991 Xml
::closeElement( 'div' ) );
995 * Build a diff display between this and the previous either deleted
996 * or non-deleted edit.
998 * @param $previousRev Revision
999 * @param $currentRev Revision
1000 * @return String: HTML
1002 function showDiff( $previousRev, $currentRev ) {
1003 $diffContext = clone $this->getContext();
1004 $diffContext->setTitle( $currentRev->getTitle() );
1005 $diffContext->setWikiPage( WikiPage
::factory( $currentRev->getTitle() ) );
1007 $diffEngine = $currentRev->getContentHandler()->createDifferenceEngine( $diffContext );
1008 $diffEngine->showDiffStyle();
1009 $this->getOutput()->addHTML(
1011 "<table style='width: 98%;' cellpadding='0' cellspacing='4' class='diff'>" .
1012 "<col class='diff-marker' />" .
1013 "<col class='diff-content' />" .
1014 "<col class='diff-marker' />" .
1015 "<col class='diff-content' />" .
1017 "<td colspan='2' style='width: 50%; text-align: center' class='diff-otitle'>" .
1018 $this->diffHeader( $previousRev, 'o' ) .
1020 "<td colspan='2' style='width: 50%; text-align: center' class='diff-ntitle'>" .
1021 $this->diffHeader( $currentRev, 'n' ) .
1024 $diffEngine->generateContentDiffBody(
1025 $previousRev->getContent( Revision
::FOR_THIS_USER
, $this->getUser() ),
1026 $currentRev->getContent( Revision
::FOR_THIS_USER
, $this->getUser() ) ) .
1033 * @param $rev Revision
1037 private function diffHeader( $rev, $prefix ) {
1038 $isDeleted = !( $rev->getId() && $rev->getTitle() );
1040 /// @todo FIXME: $rev->getTitle() is null for deleted revs...?
1041 $targetPage = $this->getTitle();
1042 $targetQuery = array(
1043 'target' => $this->mTargetObj
->getPrefixedText(),
1044 'timestamp' => wfTimestamp( TS_MW
, $rev->getTimestamp() )
1047 /// @todo FIXME: getId() may return non-zero for deleted revs...
1048 $targetPage = $rev->getTitle();
1049 $targetQuery = array( 'oldid' => $rev->getId() );
1051 // Add show/hide deletion links if available
1052 $user = $this->getUser();
1053 $lang = $this->getLanguage();
1054 $rdel = Linker
::getRevDeleteLink( $user, $rev, $this->mTargetObj
);
1055 if ( $rdel ) $rdel = " $rdel";
1057 '<div id="mw-diff-' . $prefix . 'title1"><strong>' .
1062 $lang->userTimeAndDate( $rev->getTimestamp(), $user ),
1063 $lang->userDate( $rev->getTimestamp(), $user ),
1064 $lang->userTime( $rev->getTimestamp(), $user )
1070 '<div id="mw-diff-'.$prefix.'title2">' .
1071 Linker
::revUserTools( $rev ) . '<br />' .
1073 '<div id="mw-diff-'.$prefix.'title3">' .
1074 Linker
::revComment( $rev ) . $rdel . '<br />' .
1079 * Show a form confirming whether a tokenless user really wants to see a file
1081 private function showFileConfirmationForm( $key ) {
1082 $out = $this->getOutput();
1083 $lang = $this->getLanguage();
1084 $user = $this->getUser();
1085 $file = new ArchivedFile( $this->mTargetObj
, '', $this->mFilename
);
1086 $out->addWikiMsg( 'undelete-show-file-confirm',
1087 $this->mTargetObj
->getText(),
1088 $lang->userDate( $file->getTimestamp(), $user ),
1089 $lang->userTime( $file->getTimestamp(), $user ) );
1091 Xml
::openElement( 'form', array(
1093 'action' => $this->getTitle()->getLocalURL(
1094 'target=' . urlencode( $this->mTarget
) .
1095 '&file=' . urlencode( $key ) .
1096 '&token=' . urlencode( $user->getEditToken( $key ) ) )
1099 Xml
::submitButton( $this->msg( 'undelete-show-file-submit' )->text() ) .
1105 * Show a deleted file version requested by the visitor.
1107 private function showFile( $key ) {
1108 $this->getOutput()->disable();
1110 # We mustn't allow the output to be Squid cached, otherwise
1111 # if an admin previews a deleted image, and it's cached, then
1112 # a user without appropriate permissions can toddle off and
1113 # nab the image, and Squid will serve it
1114 $response = $this->getRequest()->response();
1115 $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
1116 $response->header( 'Cache-Control: no-cache, no-store, max-age=0, must-revalidate' );
1117 $response->header( 'Pragma: no-cache' );
1119 $repo = RepoGroup
::singleton()->getLocalRepo();
1120 $path = $repo->getZonePath( 'deleted' ) . '/' . $repo->getDeletedHashPath( $key ) . $key;
1121 $repo->streamFile( $path );
1124 private function showHistory() {
1125 $out = $this->getOutput();
1126 if( $this->mAllowed
) {
1127 $out->addModules( 'mediawiki.special.undelete' );
1130 "<div class='mw-undelete-pagetitle'>\n$1\n</div>\n",
1131 array( 'undeletepagetitle', wfEscapeWikiText( $this->mTargetObj
->getPrefixedText() ) )
1134 $archive = new PageArchive( $this->mTargetObj
);
1135 wfRunHooks( 'UndeleteForm::showHistory', array( &$archive, $this->mTargetObj
) );
1137 $text = $archive->getLastRevisionText();
1138 if( is_null( $text ) ) {
1139 $out->addWikiMsg( 'nohistory' );
1143 $out->addHTML( '<div class="mw-undelete-history">' );
1144 if ( $this->mAllowed
) {
1145 $out->addWikiMsg( 'undeletehistory' );
1146 $out->addWikiMsg( 'undeleterevdel' );
1148 $out->addWikiMsg( 'undeletehistorynoadmin' );
1150 $out->addHTML( '</div>' );
1152 # List all stored revisions
1153 $revisions = $archive->listRevisions();
1154 $files = $archive->listFiles();
1156 $haveRevisions = $revisions && $revisions->numRows() > 0;
1157 $haveFiles = $files && $files->numRows() > 0;
1159 # Batch existence check on user and talk pages
1160 if( $haveRevisions ) {
1161 $batch = new LinkBatch();
1162 foreach ( $revisions as $row ) {
1163 $batch->addObj( Title
::makeTitleSafe( NS_USER
, $row->ar_user_text
) );
1164 $batch->addObj( Title
::makeTitleSafe( NS_USER_TALK
, $row->ar_user_text
) );
1167 $revisions->seek( 0 );
1170 $batch = new LinkBatch();
1171 foreach ( $files as $row ) {
1172 $batch->addObj( Title
::makeTitleSafe( NS_USER
, $row->fa_user_text
) );
1173 $batch->addObj( Title
::makeTitleSafe( NS_USER_TALK
, $row->fa_user_text
) );
1179 if ( $this->mAllowed
) {
1180 $action = $this->getTitle()->getLocalURL( array( 'action' => 'submit' ) );
1181 # Start the form here
1182 $top = Xml
::openElement( 'form', array( 'method' => 'post', 'action' => $action, 'id' => 'undelete' ) );
1183 $out->addHTML( $top );
1186 # Show relevant lines from the deletion log:
1187 $deleteLogPage = new LogPage( 'delete' );
1188 $out->addHTML( Xml
::element( 'h2', null, $deleteLogPage->getName()->text() ) . "\n" );
1189 LogEventsList
::showLogExtract( $out, 'delete', $this->mTargetObj
);
1190 # Show relevant lines from the suppression log:
1191 $suppressLogPage = new LogPage( 'suppress' );
1192 if( $this->getUser()->isAllowed( 'suppressionlog' ) ) {
1193 $out->addHTML( Xml
::element( 'h2', null, $suppressLogPage->getName()->text() ) . "\n" );
1194 LogEventsList
::showLogExtract( $out, 'suppress', $this->mTargetObj
);
1197 if( $this->mAllowed
&& ( $haveRevisions ||
$haveFiles ) ) {
1198 # Format the user-visible controls (comment field, submission button)
1199 # in a nice little table
1200 if( $this->getUser()->isAllowed( 'suppressrevision' ) ) {
1204 <td class='mw-input'>" .
1205 Xml
::checkLabel( $this->msg( 'revdelete-unsuppress' )->text(),
1206 'wpUnsuppress', 'mw-undelete-unsuppress', $this->mUnsuppress
).
1210 $unsuppressBox = '';
1213 Xml
::fieldset( $this->msg( 'undelete-fieldset-title' )->text() ) .
1214 Xml
::openElement( 'table', array( 'id' => 'mw-undelete-table' ) ) .
1216 <td colspan='2' class='mw-undelete-extrahelp'>" .
1217 $this->msg( 'undeleteextrahelp' )->parseAsBlock() .
1221 <td class='mw-label'>" .
1222 Xml
::label( $this->msg( 'undeletecomment' )->text(), 'wpComment' ) .
1224 <td class='mw-input'>" .
1225 Xml
::input( 'wpComment', 50, $this->mComment
, array( 'id' => 'wpComment' ) ) .
1230 <td class='mw-submit'>" .
1231 Xml
::submitButton( $this->msg( 'undeletebtn' )->text(), array( 'name' => 'restore', 'id' => 'mw-undelete-submit' ) ) . ' ' .
1232 Xml
::submitButton( $this->msg( 'undeleteinvert' )->text(), array( 'name' => 'invert', 'id' => 'mw-undelete-invert' ) ) .
1236 Xml
::closeElement( 'table' ) .
1237 Xml
::closeElement( 'fieldset' );
1239 $out->addHTML( $table );
1242 $out->addHTML( Xml
::element( 'h2', null, $this->msg( 'history' )->text() ) . "\n" );
1244 if( $haveRevisions ) {
1245 # The page's stored (deleted) history:
1246 $out->addHTML( '<ul>' );
1247 $remaining = $revisions->numRows();
1248 $earliestLiveTime = $this->mTargetObj
->getEarliestRevTime();
1250 foreach ( $revisions as $row ) {
1252 $out->addHTML( $this->formatRevisionRow( $row, $earliestLiveTime, $remaining ) );
1255 $out->addHTML( '</ul>' );
1257 $out->addWikiMsg( 'nohistory' );
1261 $out->addHTML( Xml
::element( 'h2', null, $this->msg( 'filehist' )->text() ) . "\n" );
1262 $out->addHTML( '<ul>' );
1263 foreach ( $files as $row ) {
1264 $out->addHTML( $this->formatFileRow( $row ) );
1267 $out->addHTML( '</ul>' );
1270 if ( $this->mAllowed
) {
1271 # Slip in the hidden controls here
1272 $misc = Html
::hidden( 'target', $this->mTarget
);
1273 $misc .= Html
::hidden( 'wpEditToken', $this->getUser()->getEditToken() );
1274 $misc .= Xml
::closeElement( 'form' );
1275 $out->addHTML( $misc );
1281 private function formatRevisionRow( $row, $earliestLiveTime, $remaining ) {
1282 $rev = Revision
::newFromArchiveRow( $row,
1284 'title' => $this->mTargetObj
1288 $ts = wfTimestamp( TS_MW
, $row->ar_timestamp
);
1289 // Build checkboxen...
1290 if( $this->mAllowed
) {
1291 if( $this->mInvert
) {
1292 if( in_array( $ts, $this->mTargetTimestamp
) ) {
1293 $checkBox = Xml
::check( "ts$ts" );
1295 $checkBox = Xml
::check( "ts$ts", true );
1298 $checkBox = Xml
::check( "ts$ts" );
1303 $user = $this->getUser();
1304 // Build page & diff links...
1305 if( $this->mCanView
) {
1306 $titleObj = $this->getTitle();
1308 if( !$rev->userCan( Revision
::DELETED_TEXT
, $this->getUser() ) ) {
1309 $pageLink = htmlspecialchars( $this->getLanguage()->userTimeAndDate( $ts, $user ) );
1310 $last = $this->msg( 'diff' )->escaped();
1311 } elseif( $remaining > 0 ||
( $earliestLiveTime && $ts > $earliestLiveTime ) ) {
1312 $pageLink = $this->getPageLink( $rev, $titleObj, $ts );
1313 $last = Linker
::linkKnown(
1315 $this->msg( 'diff' )->escaped(),
1318 'target' => $this->mTargetObj
->getPrefixedText(),
1324 $pageLink = $this->getPageLink( $rev, $titleObj, $ts );
1325 $last = $this->msg( 'diff' )->escaped();
1328 $pageLink = htmlspecialchars( $this->getLanguage()->userTimeAndDate( $ts, $user ) );
1329 $last = $this->msg( 'diff' )->escaped();
1332 $userLink = Linker
::revUserTools( $rev );
1333 // Revision text size
1334 $size = $row->ar_len
;
1335 if( !is_null( $size ) ) {
1336 $revTextSize = Linker
::formatRevisionSize( $size );
1339 $comment = Linker
::revComment( $rev );
1340 // Revision delete links
1341 $revdlink = Linker
::getRevDeleteLink( $user, $rev, $this->mTargetObj
);
1343 $revisionRow = $this->msg( 'undelete-revisionrow' )->rawParams( $checkBox, $revdlink, $last, $pageLink , $userLink, $revTextSize, $comment )->escaped();
1344 return "<li>$revisionRow</li>";
1347 private function formatFileRow( $row ) {
1348 $file = ArchivedFile
::newFromRow( $row );
1350 $ts = wfTimestamp( TS_MW
, $row->fa_timestamp
);
1351 $user = $this->getUser();
1352 if( $this->mAllowed
&& $row->fa_storage_key
) {
1353 $checkBox = Xml
::check( 'fileid' . $row->fa_id
);
1354 $key = urlencode( $row->fa_storage_key
);
1355 $pageLink = $this->getFileLink( $file, $this->getTitle(), $ts, $key );
1358 $pageLink = $this->getLanguage()->userTimeAndDate( $ts, $user );
1360 $userLink = $this->getFileUser( $file );
1361 $data = $this->msg( 'widthheight' )->numParams( $row->fa_width
, $row->fa_height
)->text();
1362 $bytes = $this->msg( 'parentheses' )->rawParams( $this->msg( 'nbytes' )->numParams( $row->fa_size
)->text() )->plain();
1363 $data = htmlspecialchars( $data . ' ' . $bytes );
1364 $comment = $this->getFileComment( $file );
1366 // Add show/hide deletion links if available
1367 $canHide = $user->isAllowed( 'deleterevision' );
1368 if( $canHide ||
( $file->getVisibility() && $user->isAllowed( 'deletedhistory' ) ) ) {
1369 if( !$file->userCan( File
::DELETED_RESTRICTED
, $user ) ) {
1370 $revdlink = Linker
::revDeleteLinkDisabled( $canHide ); // revision was hidden from sysops
1373 'type' => 'filearchive',
1374 'target' => $this->mTargetObj
->getPrefixedDBkey(),
1375 'ids' => $row->fa_id
1377 $revdlink = Linker
::revDeleteLink( $query,
1378 $file->isDeleted( File
::DELETED_RESTRICTED
), $canHide );
1384 return "<li>$checkBox $revdlink $pageLink . . $userLink $data $comment</li>\n";
1388 * Fetch revision text link if it's available to all users
1390 * @param $rev Revision
1391 * @param $titleObj Title
1392 * @param $ts string Timestamp
1395 function getPageLink( $rev, $titleObj, $ts ) {
1396 $user = $this->getUser();
1397 $time = $this->getLanguage()->userTimeAndDate( $ts, $user );
1399 if( !$rev->userCan( Revision
::DELETED_TEXT
, $user ) ) {
1400 return '<span class="history-deleted">' . $time . '</span>';
1402 $link = Linker
::linkKnown(
1404 htmlspecialchars( $time ),
1407 'target' => $this->mTargetObj
->getPrefixedText(),
1411 if( $rev->isDeleted( Revision
::DELETED_TEXT
) ) {
1412 $link = '<span class="history-deleted">' . $link . '</span>';
1419 * Fetch image view link if it's available to all users
1422 * @param $titleObj Title
1423 * @param $ts string A timestamp
1424 * @param $key String: a storage key
1426 * @return String: HTML fragment
1428 function getFileLink( $file, $titleObj, $ts, $key ) {
1429 $user = $this->getUser();
1430 $time = $this->getLanguage()->userTimeAndDate( $ts, $user );
1432 if( !$file->userCan( File
::DELETED_FILE
, $user ) ) {
1433 return '<span class="history-deleted">' . $time . '</span>';
1435 $link = Linker
::linkKnown(
1437 htmlspecialchars( $time ),
1440 'target' => $this->mTargetObj
->getPrefixedText(),
1442 'token' => $user->getEditToken( $key )
1445 if( $file->isDeleted( File
::DELETED_FILE
) ) {
1446 $link = '<span class="history-deleted">' . $link . '</span>';
1453 * Fetch file's user id if it's available to this user
1456 * @return String: HTML fragment
1458 function getFileUser( $file ) {
1459 if( !$file->userCan( File
::DELETED_USER
, $this->getUser() ) ) {
1460 return '<span class="history-deleted">' . $this->msg( 'rev-deleted-user' )->escaped() . '</span>';
1462 $link = Linker
::userLink( $file->getRawUser(), $file->getRawUserText() ) .
1463 Linker
::userToolLinks( $file->getRawUser(), $file->getRawUserText() );
1464 if( $file->isDeleted( File
::DELETED_USER
) ) {
1465 $link = '<span class="history-deleted">' . $link . '</span>';
1472 * Fetch file upload comment if it's available to this user
1475 * @return String: HTML fragment
1477 function getFileComment( $file ) {
1478 if( !$file->userCan( File
::DELETED_COMMENT
, $this->getUser() ) ) {
1479 return '<span class="history-deleted"><span class="comment">' .
1480 $this->msg( 'rev-deleted-comment' )->escaped() . '</span></span>';
1482 $link = Linker
::commentBlock( $file->getRawDescription() );
1483 if( $file->isDeleted( File
::DELETED_COMMENT
) ) {
1484 $link = '<span class="history-deleted">' . $link . '</span>';
1490 function undelete() {
1491 global $wgUploadMaintenance;
1493 if ( $wgUploadMaintenance && $this->mTargetObj
->getNamespace() == NS_FILE
) {
1494 throw new ErrorPageError( 'undelete-error', 'filedelete-maintenance' );
1497 if ( wfReadOnly() ) {
1498 throw new ReadOnlyError
;
1501 $out = $this->getOutput();
1502 $archive = new PageArchive( $this->mTargetObj
);
1503 wfRunHooks( 'UndeleteForm::undelete', array( &$archive, $this->mTargetObj
) );
1504 $ok = $archive->undelete(
1505 $this->mTargetTimestamp
,
1507 $this->mFileVersions
,
1512 if( is_array( $ok ) ) {
1513 if ( $ok[1] ) { // Undeleted file count
1514 wfRunHooks( 'FileUndeleteComplete', array(
1515 $this->mTargetObj
, $this->mFileVersions
,
1516 $this->getUser(), $this->mComment
) );
1519 $link = Linker
::linkKnown( $this->mTargetObj
);
1520 $out->addHTML( $this->msg( 'undeletedpage' )->rawParams( $link )->parse() );
1522 $out->setPageTitle( $this->msg( 'undelete-error' ) );
1525 // Show revision undeletion warnings and errors
1526 $status = $archive->getRevisionStatus();
1527 if( $status && !$status->isGood() ) {
1528 $out->addWikiText( '<div class="error">' . $status->getWikiText( 'cannotundelete', 'cannotundelete' ) . '</div>' );
1531 // Show file undeletion warnings and errors
1532 $status = $archive->getFileStatus();
1533 if( $status && !$status->isGood() ) {
1534 $out->addWikiText( '<div class="error">' . $status->getWikiText( 'undelete-error-short', 'undelete-error-long' ) . '</div>' );