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
24 use MediaWiki\MediaWikiServices
;
25 use MediaWiki\Revision\RevisionRecord
;
26 use MediaWiki\Storage\NameTableAccessException
;
27 use Wikimedia\Rdbms\IResultWrapper
;
30 * Special page allowing users with the appropriate permissions to view
31 * and restore deleted content.
33 * @ingroup SpecialPage
35 class SpecialUndelete
extends SpecialPage
{
43 private $mTargetTimestamp;
52 * @var string Search prefix
54 private $mSearchPrefix;
56 function __construct() {
57 parent
::__construct( 'Undelete', 'deletedhistory' );
60 public function doesWrites() {
64 function loadRequest( $par ) {
65 $request = $this->getRequest();
66 $user = $this->getUser();
68 $this->mAction
= $request->getVal( 'action' );
69 if ( $par !== null && $par !== '' ) {
70 $this->mTarget
= $par;
72 $this->mTarget
= $request->getVal( 'target' );
75 $this->mTargetObj
= null;
77 if ( $this->mTarget
!== null && $this->mTarget
!== '' ) {
78 $this->mTargetObj
= Title
::newFromText( $this->mTarget
);
81 $this->mSearchPrefix
= $request->getText( 'prefix' );
82 $time = $request->getVal( 'timestamp' );
83 $this->mTimestamp
= $time ?
wfTimestamp( TS_MW
, $time ) : '';
84 $this->mFilename
= $request->getVal( 'file' );
86 $posted = $request->wasPosted() &&
87 $user->matchEditToken( $request->getVal( 'wpEditToken' ) );
88 $this->mRestore
= $request->getCheck( 'restore' ) && $posted;
89 $this->mRevdel
= $request->getCheck( 'revdel' ) && $posted;
90 $this->mInvert
= $request->getCheck( 'invert' ) && $posted;
91 $this->mPreview
= $request->getCheck( 'preview' ) && $posted;
92 $this->mDiff
= $request->getCheck( 'diff' );
93 $this->mDiffOnly
= $request->getBool( 'diffonly', $this->getUser()->getOption( 'diffonly' ) );
94 $this->mComment
= $request->getText( 'wpComment' );
95 $this->mUnsuppress
= $request->getVal( 'wpUnsuppress' ) && $user->isAllowed( 'suppressrevision' );
96 $this->mToken
= $request->getVal( 'token' );
98 if ( $this->isAllowed( 'undelete' ) && !$user->isBlocked() ) {
99 $this->mAllowed
= true; // user can restore
100 $this->mCanView
= true; // user can view content
101 } elseif ( $this->isAllowed( 'deletedtext' ) ) {
102 $this->mAllowed
= false; // user cannot restore
103 $this->mCanView
= true; // user can view content
104 $this->mRestore
= false;
105 } else { // user can only view the list of revisions
106 $this->mAllowed
= false;
107 $this->mCanView
= false;
108 $this->mTimestamp
= '';
109 $this->mRestore
= false;
112 if ( $this->mRestore ||
$this->mInvert
) {
114 $this->mFileVersions
= [];
115 foreach ( $request->getValues() as $key => $val ) {
117 if ( preg_match( '/^ts(\d{14})$/', $key, $matches ) ) {
118 array_push( $timestamps, $matches[1] );
121 if ( preg_match( '/^fileid(\d+)$/', $key, $matches ) ) {
122 $this->mFileVersions
[] = intval( $matches[1] );
125 rsort( $timestamps );
126 $this->mTargetTimestamp
= $timestamps;
131 * Checks whether a user is allowed the permission for the
132 * specific title if one is set.
134 * @param string $permission
135 * @param User|null $user
138 protected function isAllowed( $permission, User
$user = null ) {
139 $user = $user ?
: $this->getUser();
140 if ( $this->mTargetObj
!== null ) {
141 return $this->mTargetObj
->userCan( $permission, $user );
143 return $user->isAllowed( $permission );
147 function userCanExecute( User
$user ) {
148 return $this->isAllowed( $this->mRestriction
, $user );
151 function execute( $par ) {
152 $this->useTransactionalTimeLimit();
154 $user = $this->getUser();
157 $this->outputHeader();
159 $this->loadRequest( $par );
160 $this->checkPermissions(); // Needs to be after mTargetObj is set
162 $out = $this->getOutput();
164 if ( is_null( $this->mTargetObj
) ) {
165 $out->addWikiMsg( 'undelete-header' );
167 # Not all users can just browse every deleted page from the list
168 if ( $user->isAllowed( 'browsearchive' ) ) {
169 $this->showSearchForm();
175 $this->addHelpLink( 'Help:Undelete' );
176 if ( $this->mAllowed
) {
177 $out->setPageTitle( $this->msg( 'undeletepage' ) );
179 $out->setPageTitle( $this->msg( 'viewdeletedpage' ) );
182 $this->getSkin()->setRelevantTitle( $this->mTargetObj
);
184 if ( $this->mTimestamp
!== '' ) {
185 $this->showRevision( $this->mTimestamp
);
186 } elseif ( $this->mFilename
!== null && $this->mTargetObj
->inNamespace( NS_FILE
) ) {
187 $file = new ArchivedFile( $this->mTargetObj
, '', $this->mFilename
);
188 // Check if user is allowed to see this file
189 if ( !$file->exists() ) {
190 $out->addWikiMsg( 'filedelete-nofile', $this->mFilename
);
191 } elseif ( !$file->userCan( File
::DELETED_FILE
, $user ) ) {
192 if ( $file->isDeleted( File
::DELETED_RESTRICTED
) ) {
193 throw new PermissionsError( 'suppressrevision' );
195 throw new PermissionsError( 'deletedtext' );
197 } elseif ( !$user->matchEditToken( $this->mToken
, $this->mFilename
) ) {
198 $this->showFileConfirmationForm( $this->mFilename
);
200 $this->showFile( $this->mFilename
);
202 } elseif ( $this->mAction
=== 'submit' ) {
203 if ( $this->mRestore
) {
205 } elseif ( $this->mRevdel
) {
206 $this->redirectToRevDel();
210 $this->showHistory();
215 * Convert submitted form data to format expected by RevisionDelete and
216 * redirect the request
218 private function redirectToRevDel() {
219 $archive = new PageArchive( $this->mTargetObj
);
223 foreach ( $this->getRequest()->getValues() as $key => $val ) {
225 if ( preg_match( "/^ts(\d{14})$/", $key, $matches ) ) {
226 $revisions[$archive->getRevision( $matches[1] )->getId()] = 1;
231 'type' => 'revision',
233 'target' => $this->mTargetObj
->getPrefixedText()
235 $url = SpecialPage
::getTitleFor( 'Revisiondelete' )->getFullURL( $query );
236 $this->getOutput()->redirect( $url );
239 function showSearchForm() {
240 $out = $this->getOutput();
241 $out->setPageTitle( $this->msg( 'undelete-search-title' ) );
242 $fuzzySearch = $this->getRequest()->getVal( 'fuzzy', true );
246 $fields[] = new OOUI\
ActionFieldLayout(
247 new OOUI\
TextInputWidget( [
249 'inputId' => 'prefix',
251 'value' => $this->mSearchPrefix
,
254 new OOUI\
ButtonInputWidget( [
255 'label' => $this->msg( 'undelete-search-submit' )->text(),
256 'flags' => [ 'primary', 'progressive' ],
257 'inputId' => 'searchUndelete',
261 'label' => new OOUI\
HtmlSnippet(
263 $fuzzySearch ?
'undelete-search-full' : 'undelete-search-prefix'
270 $fieldset = new OOUI\
FieldsetLayout( [
271 'label' => $this->msg( 'undelete-search-box' )->text(),
275 $form = new OOUI\
FormLayout( [
277 'action' => wfScript(),
280 $form->appendContent(
282 new OOUI\
HtmlSnippet(
283 Html
::hidden( 'title', $this->getPageTitle()->getPrefixedDBkey() ) .
284 Html
::hidden( 'fuzzy', $fuzzySearch )
289 new OOUI\
PanelLayout( [
297 # List undeletable articles
298 if ( $this->mSearchPrefix
) {
299 // For now, we enable search engine match only when specifically asked to
300 // by using fuzzy=1 parameter.
301 if ( $fuzzySearch ) {
302 $result = PageArchive
::listPagesBySearch( $this->mSearchPrefix
);
304 $result = PageArchive
::listPagesByPrefix( $this->mSearchPrefix
);
306 $this->showList( $result );
311 * Generic list of deleted pages
313 * @param IResultWrapper $result
316 private function showList( $result ) {
317 $out = $this->getOutput();
319 if ( $result->numRows() == 0 ) {
320 $out->addWikiMsg( 'undelete-no-results' );
325 $out->addWikiMsg( 'undeletepagetext', $this->getLanguage()->formatNum( $result->numRows() ) );
327 $linkRenderer = $this->getLinkRenderer();
328 $undelete = $this->getPageTitle();
329 $out->addHTML( "<ul id='undeleteResultsList'>\n" );
330 foreach ( $result as $row ) {
331 $title = Title
::makeTitleSafe( $row->ar_namespace
, $row->ar_title
);
332 if ( $title !== null ) {
333 $item = $linkRenderer->makeKnownLink(
335 $title->getPrefixedText(),
337 [ 'target' => $title->getPrefixedText() ]
340 // The title is no longer valid, show as text
341 $item = Html
::element(
343 [ 'class' => 'mw-invalidtitle' ],
344 Linker
::getInvalidTitleDescription(
351 $revs = $this->msg( 'undeleterevisions' )->numParams( $row->count
)->parse();
355 [ 'class' => 'undeleteResult' ],
361 $out->addHTML( "</ul>\n" );
366 private function showRevision( $timestamp ) {
367 if ( !preg_match( '/[0-9]{14}/', $timestamp ) ) {
371 $archive = new PageArchive( $this->mTargetObj
, $this->getConfig() );
372 if ( !Hooks
::run( 'UndeleteForm::showRevision', [ &$archive, $this->mTargetObj
] ) ) {
375 $rev = $archive->getRevision( $timestamp );
377 $out = $this->getOutput();
378 $user = $this->getUser();
381 $out->addWikiMsg( 'undeleterevision-missing' );
386 if ( $rev->isDeleted( Revision
::DELETED_TEXT
) ) {
387 if ( !$rev->userCan( Revision
::DELETED_TEXT
, $user ) ) {
389 "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
390 $rev->isDeleted( Revision
::DELETED_RESTRICTED
) ?
391 'rev-suppressed-text-permission' : 'rev-deleted-text-permission'
398 "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
399 $rev->isDeleted( Revision
::DELETED_RESTRICTED
) ?
400 'rev-suppressed-text-view' : 'rev-deleted-text-view'
402 $out->addHTML( '<br />' );
403 // and we are allowed to see...
406 if ( $this->mDiff
) {
407 $previousRev = $archive->getPreviousRevision( $timestamp );
408 if ( $previousRev ) {
409 $this->showDiff( $previousRev, $rev );
410 if ( $this->mDiffOnly
) {
414 $out->addHTML( '<hr />' );
416 $out->addWikiMsg( 'undelete-nodiff' );
420 $link = $this->getLinkRenderer()->makeKnownLink(
421 $this->getPageTitle( $this->mTargetObj
->getPrefixedDBkey() ),
422 $this->mTargetObj
->getPrefixedText()
425 $lang = $this->getLanguage();
427 // date and time are separate parameters to facilitate localisation.
428 // $time is kept for backward compat reasons.
429 $time = $lang->userTimeAndDate( $timestamp, $user );
430 $d = $lang->userDate( $timestamp, $user );
431 $t = $lang->userTime( $timestamp, $user );
432 $userLink = Linker
::revUserTools( $rev );
434 $content = $rev->getContent( RevisionRecord
::FOR_THIS_USER
, $user );
436 // TODO: MCR: this will have to become something like $hasTextSlots and $hasNonTextSlots
437 $isText = ( $content instanceof TextContent
);
439 if ( $this->mPreview ||
$isText ) {
440 $openDiv = '<div id="mw-undelete-revision" class="mw-warning">';
442 $openDiv = '<div id="mw-undelete-revision">';
444 $out->addHTML( $openDiv );
446 // Revision delete links
447 if ( !$this->mDiff
) {
448 $revdel = Linker
::getRevDeleteLink( $user, $rev, $this->mTargetObj
);
450 $out->addHTML( "$revdel " );
456 Message
::rawParam( $link ), $time,
457 Message
::rawParam( $userLink ), $d, $t
459 $out->addHtml( '</div>' );
461 if ( !Hooks
::run( 'UndeleteShowRevision', [ $this->mTargetObj
, $rev ] ) ) {
465 if ( $this->mPreview ||
!$isText ) {
466 // NOTE: non-text content has no source view, so always use rendered preview
468 $popts = $out->parserOptions();
469 $renderer = MediaWikiServices
::getInstance()->getRevisionRenderer();
471 $rendered = $renderer->getRenderedRevision(
472 $rev->getRevisionRecord(),
475 [ 'audience' => RevisionRecord
::FOR_THIS_USER
]
478 // Fail hard if the audience check fails, since we already checked
479 // at the beginning of this method.
480 $pout = $rendered->getRevisionParserOutput();
482 $out->addParserOutput( $pout, [
483 'enableSectionEditLinks' => false,
491 // TODO: MCR: make this work for multiple slots
492 // source view for textual content
493 $sourceView = Xml
::element( 'textarea', [
494 'readonly' => 'readonly',
497 ], $content->getText() . "\n" );
499 $buttonFields[] = new OOUI\
ButtonInputWidget( [
502 'label' => $this->msg( 'showpreview' )->text()
509 $buttonFields[] = new OOUI\
ButtonInputWidget( [
512 'label' => $this->msg( 'showdiff' )->text()
517 Xml
::openElement( 'div', [
518 'style' => 'clear: both' ] ) .
519 Xml
::openElement( 'form', [
521 'action' => $this->getPageTitle()->getLocalURL( [ 'action' => 'submit' ] ) ] ) .
522 Xml
::element( 'input', [
525 'value' => $this->mTargetObj
->getPrefixedDBkey() ] ) .
526 Xml
::element( 'input', [
528 'name' => 'timestamp',
529 'value' => $timestamp ] ) .
530 Xml
::element( 'input', [
532 'name' => 'wpEditToken',
533 'value' => $user->getEditToken() ] ) .
534 new OOUI\
FieldLayout(
536 'content' => new OOUI\
HorizontalLayout( [
537 'items' => $buttonFields
541 Xml
::closeElement( 'form' ) .
542 Xml
::closeElement( 'div' )
547 * Build a diff display between this and the previous either deleted
548 * or non-deleted edit.
550 * @param Revision $previousRev
551 * @param Revision $currentRev
552 * @return string HTML
554 function showDiff( $previousRev, $currentRev ) {
555 $diffContext = clone $this->getContext();
556 $diffContext->setTitle( $currentRev->getTitle() );
557 $diffContext->setWikiPage( WikiPage
::factory( $currentRev->getTitle() ) );
559 $diffEngine = $currentRev->getContentHandler()->createDifferenceEngine( $diffContext );
560 $diffEngine->setRevisions( $previousRev->getRevisionRecord(), $currentRev->getRevisionRecord() );
561 $diffEngine->showDiffStyle();
562 $formattedDiff = $diffEngine->getDiff(
563 $this->diffHeader( $previousRev, 'o' ),
564 $this->diffHeader( $currentRev, 'n' )
567 $this->getOutput()->addHTML( "<div>$formattedDiff</div>\n" );
571 * @param Revision $rev
572 * @param string $prefix
575 private function diffHeader( $rev, $prefix ) {
576 $isDeleted = !( $rev->getId() && $rev->getTitle() );
578 /// @todo FIXME: $rev->getTitle() is null for deleted revs...?
579 $targetPage = $this->getPageTitle();
581 'target' => $this->mTargetObj
->getPrefixedText(),
582 'timestamp' => wfTimestamp( TS_MW
, $rev->getTimestamp() )
585 /// @todo FIXME: getId() may return non-zero for deleted revs...
586 $targetPage = $rev->getTitle();
587 $targetQuery = [ 'oldid' => $rev->getId() ];
590 // Add show/hide deletion links if available
591 $user = $this->getUser();
592 $lang = $this->getLanguage();
593 $rdel = Linker
::getRevDeleteLink( $user, $rev, $this->mTargetObj
);
599 $minor = $rev->isMinor() ? ChangesList
::flag( 'minor' ) : '';
601 $tagIds = wfGetDB( DB_REPLICA
)->selectFieldValues(
604 [ 'ct_rev_id' => $rev->getId() ],
608 $changeTagDefStore = MediaWikiServices
::getInstance()->getChangeTagDefStore();
609 foreach ( $tagIds as $tagId ) {
611 $tags[] = $changeTagDefStore->getName( (int)$tagId );
612 } catch ( NameTableAccessException
$exception ) {
616 $tags = implode( ',', $tags );
617 $tagSummary = ChangeTags
::formatSummaryRow( $tags, 'deleteddiff', $this->getContext() );
619 // FIXME This is reimplementing DifferenceEngine#getRevisionHeader
620 // and partially #showDiffPage, but worse
621 return '<div id="mw-diff-' . $prefix . 'title1"><strong>' .
622 $this->getLinkRenderer()->makeLink(
626 $lang->userTimeAndDate( $rev->getTimestamp(), $user ),
627 $lang->userDate( $rev->getTimestamp(), $user ),
628 $lang->userTime( $rev->getTimestamp(), $user )
634 '<div id="mw-diff-' . $prefix . 'title2">' .
635 Linker
::revUserTools( $rev ) . '<br />' .
637 '<div id="mw-diff-' . $prefix . 'title3">' .
638 $minor . Linker
::revComment( $rev ) . $rdel . '<br />' .
640 '<div id="mw-diff-' . $prefix . 'title5">' .
641 $tagSummary[0] . '<br />' .
646 * Show a form confirming whether a tokenless user really wants to see a file
649 private function showFileConfirmationForm( $key ) {
650 $out = $this->getOutput();
651 $lang = $this->getLanguage();
652 $user = $this->getUser();
653 $file = new ArchivedFile( $this->mTargetObj
, '', $this->mFilename
);
654 $out->addWikiMsg( 'undelete-show-file-confirm',
655 $this->mTargetObj
->getText(),
656 $lang->userDate( $file->getTimestamp(), $user ),
657 $lang->userTime( $file->getTimestamp(), $user ) );
659 Xml
::openElement( 'form', [
661 'action' => $this->getPageTitle()->getLocalURL( [
662 'target' => $this->mTarget
,
664 'token' => $user->getEditToken( $key ),
668 Xml
::submitButton( $this->msg( 'undelete-show-file-submit' )->text() ) .
674 * Show a deleted file version requested by the visitor.
677 private function showFile( $key ) {
678 $this->getOutput()->disable();
680 # We mustn't allow the output to be CDN cached, otherwise
681 # if an admin previews a deleted image, and it's cached, then
682 # a user without appropriate permissions can toddle off and
683 # nab the image, and CDN will serve it
684 $response = $this->getRequest()->response();
685 $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
686 $response->header( 'Cache-Control: no-cache, no-store, max-age=0, must-revalidate' );
687 $response->header( 'Pragma: no-cache' );
689 $repo = RepoGroup
::singleton()->getLocalRepo();
690 $path = $repo->getZonePath( 'deleted' ) . '/' . $repo->getDeletedHashPath( $key ) . $key;
691 $repo->streamFile( $path );
694 protected function showHistory() {
695 $this->checkReadOnly();
697 $out = $this->getOutput();
698 if ( $this->mAllowed
) {
699 $out->addModules( 'mediawiki.special.undelete' );
702 "<div class='mw-undelete-pagetitle'>\n$1\n</div>\n",
703 [ 'undeletepagetitle', wfEscapeWikiText( $this->mTargetObj
->getPrefixedText() ) ]
706 $archive = new PageArchive( $this->mTargetObj
, $this->getConfig() );
707 Hooks
::run( 'UndeleteForm::showHistory', [ &$archive, $this->mTargetObj
] );
709 $out->addHTML( '<div class="mw-undelete-history">' );
710 if ( $this->mAllowed
) {
711 $out->addWikiMsg( 'undeletehistory' );
712 $out->addWikiMsg( 'undeleterevdel' );
714 $out->addWikiMsg( 'undeletehistorynoadmin' );
716 $out->addHTML( '</div>' );
718 # List all stored revisions
719 $revisions = $archive->listRevisions();
720 $files = $archive->listFiles();
722 $haveRevisions = $revisions && $revisions->numRows() > 0;
723 $haveFiles = $files && $files->numRows() > 0;
725 # Batch existence check on user and talk pages
726 if ( $haveRevisions ) {
727 $batch = new LinkBatch();
728 foreach ( $revisions as $row ) {
729 $batch->addObj( Title
::makeTitleSafe( NS_USER
, $row->ar_user_text
) );
730 $batch->addObj( Title
::makeTitleSafe( NS_USER_TALK
, $row->ar_user_text
) );
733 $revisions->seek( 0 );
736 $batch = new LinkBatch();
737 foreach ( $files as $row ) {
738 $batch->addObj( Title
::makeTitleSafe( NS_USER
, $row->fa_user_text
) );
739 $batch->addObj( Title
::makeTitleSafe( NS_USER_TALK
, $row->fa_user_text
) );
745 if ( $this->mAllowed
) {
748 $action = $this->getPageTitle()->getLocalURL( [ 'action' => 'submit' ] );
749 # Start the form here
750 $form = new OOUI\
FormLayout( [
757 # Show relevant lines from the deletion log:
758 $deleteLogPage = new LogPage( 'delete' );
759 $out->addHTML( Xml
::element( 'h2', null, $deleteLogPage->getName()->text() ) . "\n" );
760 LogEventsList
::showLogExtract( $out, 'delete', $this->mTargetObj
);
761 # Show relevant lines from the suppression log:
762 $suppressLogPage = new LogPage( 'suppress' );
763 if ( $this->getUser()->isAllowed( 'suppressionlog' ) ) {
764 $out->addHTML( Xml
::element( 'h2', null, $suppressLogPage->getName()->text() ) . "\n" );
765 LogEventsList
::showLogExtract( $out, 'suppress', $this->mTargetObj
);
768 if ( $this->mAllowed
&& ( $haveRevisions ||
$haveFiles ) ) {
769 $fields[] = new OOUI\
Layout( [
770 'content' => new OOUI\
HtmlSnippet( $this->msg( 'undeleteextrahelp' )->parseAsBlock() )
773 $fields[] = new OOUI\
FieldLayout(
774 new OOUI\
TextInputWidget( [
775 'name' => 'wpComment',
776 'inputId' => 'wpComment',
778 'value' => $this->mComment
,
780 // HTML maxlength uses "UTF-16 code units", which means that characters outside BMP
781 // (e.g. emojis) count for two each. This limit is overridden in JS to instead count
782 // Unicode codepoints.
783 'maxLength' => CommentStore
::COMMENT_CHARACTER_LIMIT
,
786 'label' => $this->msg( 'undeletecomment' )->text(),
791 $fields[] = new OOUI\
FieldLayout(
793 'content' => new OOUI\
HorizontalLayout( [
795 new OOUI\
ButtonInputWidget( [
797 'inputId' => 'mw-undelete-submit',
799 'label' => $this->msg( 'undeletebtn' )->text(),
800 'flags' => [ 'primary', 'progressive' ],
803 new OOUI\
ButtonInputWidget( [
805 'inputId' => 'mw-undelete-invert',
807 'label' => $this->msg( 'undeleteinvert' )->text()
814 if ( $this->getUser()->isAllowed( 'suppressrevision' ) ) {
815 $fields[] = new OOUI\
FieldLayout(
816 new OOUI\
CheckboxInputWidget( [
817 'name' => 'wpUnsuppress',
818 'inputId' => 'mw-undelete-unsuppress',
822 'label' => $this->msg( 'revdelete-unsuppress' )->text(),
828 $fieldset = new OOUI\
FieldsetLayout( [
829 'label' => $this->msg( 'undelete-fieldset-title' )->text(),
830 'id' => 'mw-undelete-table',
834 $form->appendContent(
835 new OOUI\
PanelLayout( [
839 'content' => $fieldset,
841 new OOUI\
HtmlSnippet(
842 Html
::hidden( 'target', $this->mTarget
) .
843 Html
::hidden( 'wpEditToken', $this->getUser()->getEditToken() )
849 $history .= Xml
::element( 'h2', null, $this->msg( 'history' )->text() ) . "\n";
851 if ( $haveRevisions ) {
852 # Show the page's stored (deleted) history
854 if ( $this->getUser()->isAllowed( 'deleterevision' ) ) {
855 $history .= Html
::element(
860 'class' => 'deleterevision-log-submit mw-log-deleterevision-button'
862 $this->msg( 'showhideselectedversions' )->text()
866 $history .= '<ul class="mw-undelete-revlist">';
867 $remaining = $revisions->numRows();
868 $earliestLiveTime = $this->mTargetObj
->getEarliestRevTime();
870 foreach ( $revisions as $row ) {
872 $history .= $this->formatRevisionRow( $row, $earliestLiveTime, $remaining );
877 $out->addWikiMsg( 'nohistory' );
881 $history .= Xml
::element( 'h2', null, $this->msg( 'filehist' )->text() ) . "\n";
882 $history .= '<ul class="mw-undelete-revlist">';
883 foreach ( $files as $row ) {
884 $history .= $this->formatFileRow( $row );
890 if ( $this->mAllowed
) {
891 # Slip in the hidden controls here
892 $misc = Html
::hidden( 'target', $this->mTarget
);
893 $misc .= Html
::hidden( 'wpEditToken', $this->getUser()->getEditToken() );
896 $form->appendContent( new OOUI\
HtmlSnippet( $history ) );
897 $out->addHTML( $form );
899 $out->addHTML( $history );
905 protected function formatRevisionRow( $row, $earliestLiveTime, $remaining ) {
906 $rev = Revision
::newFromArchiveRow( $row,
908 'title' => $this->mTargetObj
912 $ts = wfTimestamp( TS_MW
, $row->ar_timestamp
);
913 // Build checkboxen...
914 if ( $this->mAllowed
) {
915 if ( $this->mInvert
) {
916 if ( in_array( $ts, $this->mTargetTimestamp
) ) {
917 $checkBox = Xml
::check( "ts$ts" );
919 $checkBox = Xml
::check( "ts$ts", true );
922 $checkBox = Xml
::check( "ts$ts" );
928 // Build page & diff links...
929 $user = $this->getUser();
930 if ( $this->mCanView
) {
931 $titleObj = $this->getPageTitle();
933 if ( !$rev->userCan( Revision
::DELETED_TEXT
, $this->getUser() ) ) {
934 $pageLink = htmlspecialchars( $this->getLanguage()->userTimeAndDate( $ts, $user ) );
935 $last = $this->msg( 'diff' )->escaped();
936 } elseif ( $remaining > 0 ||
( $earliestLiveTime && $ts > $earliestLiveTime ) ) {
937 $pageLink = $this->getPageLink( $rev, $titleObj, $ts );
938 $last = $this->getLinkRenderer()->makeKnownLink(
940 $this->msg( 'diff' )->text(),
943 'target' => $this->mTargetObj
->getPrefixedText(),
949 $pageLink = $this->getPageLink( $rev, $titleObj, $ts );
950 $last = $this->msg( 'diff' )->escaped();
953 $pageLink = htmlspecialchars( $this->getLanguage()->userTimeAndDate( $ts, $user ) );
954 $last = $this->msg( 'diff' )->escaped();
958 $userLink = Linker
::revUserTools( $rev );
961 $minor = $rev->isMinor() ? ChangesList
::flag( 'minor' ) : '';
963 // Revision text size
964 $size = $row->ar_len
;
965 if ( !is_null( $size ) ) {
966 $revTextSize = Linker
::formatRevisionSize( $size );
970 $comment = Linker
::revComment( $rev );
974 list( $tagSummary, $classes ) = ChangeTags
::formatSummaryRow(
980 $attribs['class'] = implode( ' ', $classes );
983 $revisionRow = $this->msg( 'undelete-revision-row2' )
996 return Xml
::tags( 'li', $attribs, $revisionRow ) . "\n";
999 private function formatFileRow( $row ) {
1000 $file = ArchivedFile
::newFromRow( $row );
1001 $ts = wfTimestamp( TS_MW
, $row->fa_timestamp
);
1002 $user = $this->getUser();
1005 if ( $this->mCanView
&& $row->fa_storage_key
) {
1006 if ( $this->mAllowed
) {
1007 $checkBox = Xml
::check( 'fileid' . $row->fa_id
);
1009 $key = urlencode( $row->fa_storage_key
);
1010 $pageLink = $this->getFileLink( $file, $this->getPageTitle(), $ts, $key );
1012 $pageLink = htmlspecialchars( $this->getLanguage()->userTimeAndDate( $ts, $user ) );
1014 $userLink = $this->getFileUser( $file );
1015 $data = $this->msg( 'widthheight' )->numParams( $row->fa_width
, $row->fa_height
)->text();
1016 $bytes = $this->msg( 'parentheses' )
1017 ->plaintextParams( $this->msg( 'nbytes' )->numParams( $row->fa_size
)->text() )
1019 $data = htmlspecialchars( $data . ' ' . $bytes );
1020 $comment = $this->getFileComment( $file );
1022 // Add show/hide deletion links if available
1023 $canHide = $this->isAllowed( 'deleterevision' );
1024 if ( $canHide ||
( $file->getVisibility() && $this->isAllowed( 'deletedhistory' ) ) ) {
1025 if ( !$file->userCan( File
::DELETED_RESTRICTED
, $user ) ) {
1026 // Revision was hidden from sysops
1027 $revdlink = Linker
::revDeleteLinkDisabled( $canHide );
1030 'type' => 'filearchive',
1031 'target' => $this->mTargetObj
->getPrefixedDBkey(),
1032 'ids' => $row->fa_id
1034 $revdlink = Linker
::revDeleteLink( $query,
1035 $file->isDeleted( File
::DELETED_RESTRICTED
), $canHide );
1041 return "<li>$checkBox $revdlink $pageLink . . $userLink $data $comment</li>\n";
1045 * Fetch revision text link if it's available to all users
1047 * @param Revision $rev
1048 * @param Title $titleObj
1049 * @param string $ts Timestamp
1052 function getPageLink( $rev, $titleObj, $ts ) {
1053 $user = $this->getUser();
1054 $time = $this->getLanguage()->userTimeAndDate( $ts, $user );
1056 if ( !$rev->userCan( Revision
::DELETED_TEXT
, $user ) ) {
1057 return '<span class="history-deleted">' . $time . '</span>';
1060 $link = $this->getLinkRenderer()->makeKnownLink(
1065 'target' => $this->mTargetObj
->getPrefixedText(),
1070 if ( $rev->isDeleted( Revision
::DELETED_TEXT
) ) {
1071 $link = '<span class="history-deleted">' . $link . '</span>';
1078 * Fetch image view link if it's available to all users
1080 * @param File|ArchivedFile $file
1081 * @param Title $titleObj
1082 * @param string $ts A timestamp
1083 * @param string $key A storage key
1085 * @return string HTML fragment
1087 function getFileLink( $file, $titleObj, $ts, $key ) {
1088 $user = $this->getUser();
1089 $time = $this->getLanguage()->userTimeAndDate( $ts, $user );
1091 if ( !$file->userCan( File
::DELETED_FILE
, $user ) ) {
1092 return '<span class="history-deleted">' . htmlspecialchars( $time ) . '</span>';
1095 $link = $this->getLinkRenderer()->makeKnownLink(
1100 'target' => $this->mTargetObj
->getPrefixedText(),
1102 'token' => $user->getEditToken( $key )
1106 if ( $file->isDeleted( File
::DELETED_FILE
) ) {
1107 $link = '<span class="history-deleted">' . $link . '</span>';
1114 * Fetch file's user id if it's available to this user
1116 * @param File|ArchivedFile $file
1117 * @return string HTML fragment
1119 function getFileUser( $file ) {
1120 if ( !$file->userCan( File
::DELETED_USER
, $this->getUser() ) ) {
1121 return '<span class="history-deleted">' .
1122 $this->msg( 'rev-deleted-user' )->escaped() .
1126 $link = Linker
::userLink( $file->getRawUser(), $file->getRawUserText() ) .
1127 Linker
::userToolLinks( $file->getRawUser(), $file->getRawUserText() );
1129 if ( $file->isDeleted( File
::DELETED_USER
) ) {
1130 $link = '<span class="history-deleted">' . $link . '</span>';
1137 * Fetch file upload comment if it's available to this user
1139 * @param File|ArchivedFile $file
1140 * @return string HTML fragment
1142 function getFileComment( $file ) {
1143 if ( !$file->userCan( File
::DELETED_COMMENT
, $this->getUser() ) ) {
1144 return '<span class="history-deleted"><span class="comment">' .
1145 $this->msg( 'rev-deleted-comment' )->escaped() . '</span></span>';
1148 $link = Linker
::commentBlock( $file->getRawDescription() );
1150 if ( $file->isDeleted( File
::DELETED_COMMENT
) ) {
1151 $link = '<span class="history-deleted">' . $link . '</span>';
1157 function undelete() {
1158 if ( $this->getConfig()->get( 'UploadMaintenance' )
1159 && $this->mTargetObj
->getNamespace() == NS_FILE
1161 throw new ErrorPageError( 'undelete-error', 'filedelete-maintenance' );
1164 $this->checkReadOnly();
1166 $out = $this->getOutput();
1167 $archive = new PageArchive( $this->mTargetObj
, $this->getConfig() );
1168 Hooks
::run( 'UndeleteForm::undelete', [ &$archive, $this->mTargetObj
] );
1169 $ok = $archive->undelete(
1170 $this->mTargetTimestamp
,
1172 $this->mFileVersions
,
1177 if ( is_array( $ok ) ) {
1178 if ( $ok[1] ) { // Undeleted file count
1179 Hooks
::run( 'FileUndeleteComplete', [
1180 $this->mTargetObj
, $this->mFileVersions
,
1181 $this->getUser(), $this->mComment
] );
1184 $link = $this->getLinkRenderer()->makeKnownLink( $this->mTargetObj
);
1185 $out->addWikiMsg( 'undeletedpage', Message
::rawParam( $link ) );
1187 $out->setPageTitle( $this->msg( 'undelete-error' ) );
1190 // Show revision undeletion warnings and errors
1191 $status = $archive->getRevisionStatus();
1192 if ( $status && !$status->isGood() ) {
1193 $out->wrapWikiTextAsInterface(
1195 '<div id="mw-error-cannotundelete">' .
1196 $status->getWikiText(
1203 // Show file undeletion warnings and errors
1204 $status = $archive->getFileStatus();
1205 if ( $status && !$status->isGood() ) {
1206 $out->wrapWikiTextAsInterface(
1208 $status->getWikiText(
1209 'undelete-error-short',
1210 'undelete-error-long'
1217 * Return an array of subpages beginning with $search that this special page will accept.
1219 * @param string $search Prefix to search for
1220 * @param int $limit Maximum number of results to return (usually 10)
1221 * @param int $offset Number of results to skip (usually 0)
1222 * @return string[] Matching subpages
1224 public function prefixSearchSubpages( $search, $limit, $offset ) {
1225 return $this->prefixSearchString( $search, $limit, $offset );
1228 protected function getGroupName() {