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;
230 "type" => "revision",
232 "target" => $this->mTargetObj
->getPrefixedText()
234 $url = SpecialPage
::getTitleFor( 'Revisiondelete' )->getFullURL( $query );
235 $this->getOutput()->redirect( $url );
238 function showSearchForm() {
239 $out = $this->getOutput();
240 $out->setPageTitle( $this->msg( 'undelete-search-title' ) );
241 $fuzzySearch = $this->getRequest()->getVal( 'fuzzy', true );
245 $fields[] = new OOUI\
ActionFieldLayout(
246 new OOUI\
TextInputWidget( [
248 'inputId' => 'prefix',
250 'value' => $this->mSearchPrefix
,
253 new OOUI\
ButtonInputWidget( [
254 'label' => $this->msg( 'undelete-search-submit' )->text(),
255 'flags' => [ 'primary', 'progressive' ],
256 'inputId' => 'searchUndelete',
260 'label' => new OOUI\
HtmlSnippet(
262 $fuzzySearch ?
'undelete-search-full' : 'undelete-search-prefix'
269 $fieldset = new OOUI\
FieldsetLayout( [
270 'label' => $this->msg( 'undelete-search-box' )->text(),
274 $form = new OOUI\
FormLayout( [
276 'action' => wfScript(),
279 $form->appendContent(
281 new OOUI\
HtmlSnippet(
282 Html
::hidden( 'title', $this->getPageTitle()->getPrefixedDBkey() ) .
283 Html
::hidden( 'fuzzy', $fuzzySearch )
288 new OOUI\
PanelLayout( [
296 # List undeletable articles
297 if ( $this->mSearchPrefix
) {
298 // For now, we enable search engine match only when specifically asked to
299 // by using fuzzy=1 parameter.
300 if ( $fuzzySearch ) {
301 $result = PageArchive
::listPagesBySearch( $this->mSearchPrefix
);
303 $result = PageArchive
::listPagesByPrefix( $this->mSearchPrefix
);
305 $this->showList( $result );
310 * Generic list of deleted pages
312 * @param IResultWrapper $result
315 private function showList( $result ) {
316 $out = $this->getOutput();
318 if ( $result->numRows() == 0 ) {
319 $out->addWikiMsg( 'undelete-no-results' );
324 $out->addWikiMsg( 'undeletepagetext', $this->getLanguage()->formatNum( $result->numRows() ) );
326 $linkRenderer = $this->getLinkRenderer();
327 $undelete = $this->getPageTitle();
328 $out->addHTML( "<ul id='undeleteResultsList'>\n" );
329 foreach ( $result as $row ) {
330 $title = Title
::makeTitleSafe( $row->ar_namespace
, $row->ar_title
);
331 if ( $title !== null ) {
332 $item = $linkRenderer->makeKnownLink(
334 $title->getPrefixedText(),
336 [ 'target' => $title->getPrefixedText() ]
339 // The title is no longer valid, show as text
340 $item = Html
::element(
342 [ 'class' => 'mw-invalidtitle' ],
343 Linker
::getInvalidTitleDescription(
350 $revs = $this->msg( 'undeleterevisions' )->numParams( $row->count
)->parse();
354 [ 'class' => 'undeleteResult' ],
360 $out->addHTML( "</ul>\n" );
365 private function showRevision( $timestamp ) {
366 if ( !preg_match( '/[0-9]{14}/', $timestamp ) ) {
370 $archive = new PageArchive( $this->mTargetObj
, $this->getConfig() );
371 if ( !Hooks
::run( 'UndeleteForm::showRevision', [ &$archive, $this->mTargetObj
] ) ) {
374 $rev = $archive->getRevision( $timestamp );
376 $out = $this->getOutput();
377 $user = $this->getUser();
380 $out->addWikiMsg( 'undeleterevision-missing' );
385 if ( $rev->isDeleted( Revision
::DELETED_TEXT
) ) {
386 if ( !$rev->userCan( Revision
::DELETED_TEXT
, $user ) ) {
388 "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
389 $rev->isDeleted( Revision
::DELETED_RESTRICTED
) ?
390 'rev-suppressed-text-permission' : 'rev-deleted-text-permission'
397 "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
398 $rev->isDeleted( Revision
::DELETED_RESTRICTED
) ?
399 'rev-suppressed-text-view' : 'rev-deleted-text-view'
401 $out->addHTML( '<br />' );
402 // and we are allowed to see...
405 if ( $this->mDiff
) {
406 $previousRev = $archive->getPreviousRevision( $timestamp );
407 if ( $previousRev ) {
408 $this->showDiff( $previousRev, $rev );
409 if ( $this->mDiffOnly
) {
413 $out->addHTML( '<hr />' );
415 $out->addWikiMsg( 'undelete-nodiff' );
419 $link = $this->getLinkRenderer()->makeKnownLink(
420 $this->getPageTitle( $this->mTargetObj
->getPrefixedDBkey() ),
421 $this->mTargetObj
->getPrefixedText()
424 $lang = $this->getLanguage();
426 // date and time are separate parameters to facilitate localisation.
427 // $time is kept for backward compat reasons.
428 $time = $lang->userTimeAndDate( $timestamp, $user );
429 $d = $lang->userDate( $timestamp, $user );
430 $t = $lang->userTime( $timestamp, $user );
431 $userLink = Linker
::revUserTools( $rev );
433 $content = $rev->getContent( RevisionRecord
::FOR_THIS_USER
, $user );
435 // TODO: MCR: this will have to become something like $hasTextSlots and $hasNonTextSlots
436 $isText = ( $content instanceof TextContent
);
438 if ( $this->mPreview ||
$isText ) {
439 $openDiv = '<div id="mw-undelete-revision" class="mw-warning">';
441 $openDiv = '<div id="mw-undelete-revision">';
443 $out->addHTML( $openDiv );
445 // Revision delete links
446 if ( !$this->mDiff
) {
447 $revdel = Linker
::getRevDeleteLink( $user, $rev, $this->mTargetObj
);
449 $out->addHTML( "$revdel " );
455 Message
::rawParam( $link ), $time,
456 Message
::rawParam( $userLink ), $d, $t
458 $out->addHtml( '</div>' );
460 if ( !Hooks
::run( 'UndeleteShowRevision', [ $this->mTargetObj
, $rev ] ) ) {
464 if ( $this->mPreview ||
!$isText ) {
465 // NOTE: non-text content has no source view, so always use rendered preview
467 $popts = $out->parserOptions();
468 $renderer = MediaWikiServices
::getInstance()->getRevisionRenderer();
470 $rendered = $renderer->getRenderedRevision(
471 $rev->getRevisionRecord(),
474 [ 'audience' => RevisionRecord
::FOR_THIS_USER
]
477 // Fail hard if the audience check fails, since we already checked
478 // at the beginning of this method.
479 $pout = $rendered->getRevisionParserOutput();
481 $out->addParserOutput( $pout, [
482 'enableSectionEditLinks' => false,
490 // TODO: MCR: make this work for multiple slots
491 // source view for textual content
492 $sourceView = Xml
::element( 'textarea', [
493 'readonly' => 'readonly',
496 ], $content->getNativeData() . "\n" );
498 $buttonFields[] = new OOUI\
ButtonInputWidget( [
501 'label' => $this->msg( 'showpreview' )->text()
508 $buttonFields[] = new OOUI\
ButtonInputWidget( [
511 'label' => $this->msg( 'showdiff' )->text()
516 Xml
::openElement( 'div', [
517 'style' => 'clear: both' ] ) .
518 Xml
::openElement( 'form', [
520 'action' => $this->getPageTitle()->getLocalURL( [ 'action' => 'submit' ] ) ] ) .
521 Xml
::element( 'input', [
524 'value' => $this->mTargetObj
->getPrefixedDBkey() ] ) .
525 Xml
::element( 'input', [
527 'name' => 'timestamp',
528 'value' => $timestamp ] ) .
529 Xml
::element( 'input', [
531 'name' => 'wpEditToken',
532 'value' => $user->getEditToken() ] ) .
533 new OOUI\
FieldLayout(
535 'content' => new OOUI\
HorizontalLayout( [
536 'items' => $buttonFields
540 Xml
::closeElement( 'form' ) .
541 Xml
::closeElement( 'div' )
546 * Build a diff display between this and the previous either deleted
547 * or non-deleted edit.
549 * @param Revision $previousRev
550 * @param Revision $currentRev
551 * @return string HTML
553 function showDiff( $previousRev, $currentRev ) {
554 $diffContext = clone $this->getContext();
555 $diffContext->setTitle( $currentRev->getTitle() );
556 $diffContext->setWikiPage( WikiPage
::factory( $currentRev->getTitle() ) );
558 $diffEngine = $currentRev->getContentHandler()->createDifferenceEngine( $diffContext );
559 $diffEngine->setRevisions( $previousRev->getRevisionRecord(), $currentRev->getRevisionRecord() );
560 $diffEngine->showDiffStyle();
561 $formattedDiff = $diffEngine->getDiff(
562 $this->diffHeader( $previousRev, 'o' ),
563 $this->diffHeader( $currentRev, 'n' )
566 $this->getOutput()->addHTML( "<div>$formattedDiff</div>\n" );
570 * @param Revision $rev
571 * @param string $prefix
574 private function diffHeader( $rev, $prefix ) {
575 $isDeleted = !( $rev->getId() && $rev->getTitle() );
577 /// @todo FIXME: $rev->getTitle() is null for deleted revs...?
578 $targetPage = $this->getPageTitle();
580 'target' => $this->mTargetObj
->getPrefixedText(),
581 'timestamp' => wfTimestamp( TS_MW
, $rev->getTimestamp() )
584 /// @todo FIXME: getId() may return non-zero for deleted revs...
585 $targetPage = $rev->getTitle();
586 $targetQuery = [ 'oldid' => $rev->getId() ];
589 // Add show/hide deletion links if available
590 $user = $this->getUser();
591 $lang = $this->getLanguage();
592 $rdel = Linker
::getRevDeleteLink( $user, $rev, $this->mTargetObj
);
598 $minor = $rev->isMinor() ? ChangesList
::flag( 'minor' ) : '';
600 $tagIds = wfGetDB( DB_REPLICA
)->selectFieldValues(
603 [ 'ct_rev_id' => $rev->getId() ],
607 $changeTagDefStore = MediaWikiServices
::getInstance()->getChangeTagDefStore();
608 foreach ( $tagIds as $tagId ) {
610 $tags[] = $changeTagDefStore->getName( (int)$tagId );
611 } catch ( NameTableAccessException
$exception ) {
615 $tags = implode( ',', $tags );
616 $tagSummary = ChangeTags
::formatSummaryRow( $tags, 'deleteddiff', $this->getContext() );
618 // FIXME This is reimplementing DifferenceEngine#getRevisionHeader
619 // and partially #showDiffPage, but worse
620 return '<div id="mw-diff-' . $prefix . 'title1"><strong>' .
621 $this->getLinkRenderer()->makeLink(
625 $lang->userTimeAndDate( $rev->getTimestamp(), $user ),
626 $lang->userDate( $rev->getTimestamp(), $user ),
627 $lang->userTime( $rev->getTimestamp(), $user )
633 '<div id="mw-diff-' . $prefix . 'title2">' .
634 Linker
::revUserTools( $rev ) . '<br />' .
636 '<div id="mw-diff-' . $prefix . 'title3">' .
637 $minor . Linker
::revComment( $rev ) . $rdel . '<br />' .
639 '<div id="mw-diff-' . $prefix . 'title5">' .
640 $tagSummary[0] . '<br />' .
645 * Show a form confirming whether a tokenless user really wants to see a file
648 private function showFileConfirmationForm( $key ) {
649 $out = $this->getOutput();
650 $lang = $this->getLanguage();
651 $user = $this->getUser();
652 $file = new ArchivedFile( $this->mTargetObj
, '', $this->mFilename
);
653 $out->addWikiMsg( 'undelete-show-file-confirm',
654 $this->mTargetObj
->getText(),
655 $lang->userDate( $file->getTimestamp(), $user ),
656 $lang->userTime( $file->getTimestamp(), $user ) );
658 Xml
::openElement( 'form', [
660 'action' => $this->getPageTitle()->getLocalURL( [
661 'target' => $this->mTarget
,
663 'token' => $user->getEditToken( $key ),
667 Xml
::submitButton( $this->msg( 'undelete-show-file-submit' )->text() ) .
673 * Show a deleted file version requested by the visitor.
676 private function showFile( $key ) {
677 $this->getOutput()->disable();
679 # We mustn't allow the output to be CDN cached, otherwise
680 # if an admin previews a deleted image, and it's cached, then
681 # a user without appropriate permissions can toddle off and
682 # nab the image, and CDN will serve it
683 $response = $this->getRequest()->response();
684 $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
685 $response->header( 'Cache-Control: no-cache, no-store, max-age=0, must-revalidate' );
686 $response->header( 'Pragma: no-cache' );
688 $repo = RepoGroup
::singleton()->getLocalRepo();
689 $path = $repo->getZonePath( 'deleted' ) . '/' . $repo->getDeletedHashPath( $key ) . $key;
690 $repo->streamFile( $path );
693 protected function showHistory() {
694 $this->checkReadOnly();
696 $out = $this->getOutput();
697 if ( $this->mAllowed
) {
698 $out->addModules( 'mediawiki.special.undelete' );
701 "<div class='mw-undelete-pagetitle'>\n$1\n</div>\n",
702 [ 'undeletepagetitle', wfEscapeWikiText( $this->mTargetObj
->getPrefixedText() ) ]
705 $archive = new PageArchive( $this->mTargetObj
, $this->getConfig() );
706 Hooks
::run( 'UndeleteForm::showHistory', [ &$archive, $this->mTargetObj
] );
708 $out->addHTML( '<div class="mw-undelete-history">' );
709 if ( $this->mAllowed
) {
710 $out->addWikiMsg( 'undeletehistory' );
711 $out->addWikiMsg( 'undeleterevdel' );
713 $out->addWikiMsg( 'undeletehistorynoadmin' );
715 $out->addHTML( '</div>' );
717 # List all stored revisions
718 $revisions = $archive->listRevisions();
719 $files = $archive->listFiles();
721 $haveRevisions = $revisions && $revisions->numRows() > 0;
722 $haveFiles = $files && $files->numRows() > 0;
724 # Batch existence check on user and talk pages
725 if ( $haveRevisions ) {
726 $batch = new LinkBatch();
727 foreach ( $revisions as $row ) {
728 $batch->addObj( Title
::makeTitleSafe( NS_USER
, $row->ar_user_text
) );
729 $batch->addObj( Title
::makeTitleSafe( NS_USER_TALK
, $row->ar_user_text
) );
732 $revisions->seek( 0 );
735 $batch = new LinkBatch();
736 foreach ( $files as $row ) {
737 $batch->addObj( Title
::makeTitleSafe( NS_USER
, $row->fa_user_text
) );
738 $batch->addObj( Title
::makeTitleSafe( NS_USER_TALK
, $row->fa_user_text
) );
744 if ( $this->mAllowed
) {
747 $action = $this->getPageTitle()->getLocalURL( [ 'action' => 'submit' ] );
748 # Start the form here
749 $form = new OOUI\
FormLayout( [
756 # Show relevant lines from the deletion log:
757 $deleteLogPage = new LogPage( 'delete' );
758 $out->addHTML( Xml
::element( 'h2', null, $deleteLogPage->getName()->text() ) . "\n" );
759 LogEventsList
::showLogExtract( $out, 'delete', $this->mTargetObj
);
760 # Show relevant lines from the suppression log:
761 $suppressLogPage = new LogPage( 'suppress' );
762 if ( $this->getUser()->isAllowed( 'suppressionlog' ) ) {
763 $out->addHTML( Xml
::element( 'h2', null, $suppressLogPage->getName()->text() ) . "\n" );
764 LogEventsList
::showLogExtract( $out, 'suppress', $this->mTargetObj
);
767 if ( $this->mAllowed
&& ( $haveRevisions ||
$haveFiles ) ) {
768 $fields[] = new OOUI\
Layout( [
769 'content' => new OOUI\
HtmlSnippet( $this->msg( 'undeleteextrahelp' )->parseAsBlock() )
772 $conf = $this->getConfig();
773 $oldCommentSchema = $conf->get( 'CommentTableSchemaMigrationStage' ) === MIGRATION_OLD
;
775 $fields[] = new OOUI\
FieldLayout(
776 new OOUI\
TextInputWidget( [
777 'name' => 'wpComment',
778 'inputId' => 'wpComment',
780 'value' => $this->mComment
,
782 // HTML maxlength uses "UTF-16 code units", which means that characters outside BMP
783 // (e.g. emojis) count for two each. This limit is overridden in JS to instead count
784 // Unicode codepoints (or 255 UTF-8 bytes for old schema).
785 'maxLength' => $oldCommentSchema ?
255 : CommentStore
::COMMENT_CHARACTER_LIMIT
,
788 'label' => $this->msg( 'undeletecomment' )->text(),
793 $fields[] = new OOUI\
FieldLayout(
795 'content' => new OOUI\
HorizontalLayout( [
797 new OOUI\
ButtonInputWidget( [
799 'inputId' => 'mw-undelete-submit',
801 'label' => $this->msg( 'undeletebtn' )->text(),
802 'flags' => [ 'primary', 'progressive' ],
805 new OOUI\
ButtonInputWidget( [
807 'inputId' => 'mw-undelete-invert',
809 'label' => $this->msg( 'undeleteinvert' )->text()
816 if ( $this->getUser()->isAllowed( 'suppressrevision' ) ) {
817 $fields[] = new OOUI\
FieldLayout(
818 new OOUI\
CheckboxInputWidget( [
819 'name' => 'wpUnsuppress',
820 'inputId' => 'mw-undelete-unsuppress',
824 'label' => $this->msg( 'revdelete-unsuppress' )->text(),
830 $fieldset = new OOUI\
FieldsetLayout( [
831 'label' => $this->msg( 'undelete-fieldset-title' )->text(),
832 'id' => 'mw-undelete-table',
836 $form->appendContent(
837 new OOUI\
PanelLayout( [
841 'content' => $fieldset,
843 new OOUI\
HtmlSnippet(
844 Html
::hidden( 'target', $this->mTarget
) .
845 Html
::hidden( 'wpEditToken', $this->getUser()->getEditToken() )
851 $history .= Xml
::element( 'h2', null, $this->msg( 'history' )->text() ) . "\n";
853 if ( $haveRevisions ) {
854 # Show the page's stored (deleted) history
856 if ( $this->getUser()->isAllowed( 'deleterevision' ) ) {
857 $history .= Html
::element(
862 'class' => 'deleterevision-log-submit mw-log-deleterevision-button'
864 $this->msg( 'showhideselectedversions' )->text()
868 $history .= '<ul class="mw-undelete-revlist">';
869 $remaining = $revisions->numRows();
870 $earliestLiveTime = $this->mTargetObj
->getEarliestRevTime();
872 foreach ( $revisions as $row ) {
874 $history .= $this->formatRevisionRow( $row, $earliestLiveTime, $remaining );
879 $out->addWikiMsg( 'nohistory' );
883 $history .= Xml
::element( 'h2', null, $this->msg( 'filehist' )->text() ) . "\n";
884 $history .= '<ul class="mw-undelete-revlist">';
885 foreach ( $files as $row ) {
886 $history .= $this->formatFileRow( $row );
892 if ( $this->mAllowed
) {
893 # Slip in the hidden controls here
894 $misc = Html
::hidden( 'target', $this->mTarget
);
895 $misc .= Html
::hidden( 'wpEditToken', $this->getUser()->getEditToken() );
898 $form->appendContent( new OOUI\
HtmlSnippet( $history ) );
899 $out->addHTML( $form );
901 $out->addHTML( $history );
907 protected function formatRevisionRow( $row, $earliestLiveTime, $remaining ) {
908 $rev = Revision
::newFromArchiveRow( $row,
910 'title' => $this->mTargetObj
914 $ts = wfTimestamp( TS_MW
, $row->ar_timestamp
);
915 // Build checkboxen...
916 if ( $this->mAllowed
) {
917 if ( $this->mInvert
) {
918 if ( in_array( $ts, $this->mTargetTimestamp
) ) {
919 $checkBox = Xml
::check( "ts$ts" );
921 $checkBox = Xml
::check( "ts$ts", true );
924 $checkBox = Xml
::check( "ts$ts" );
930 // Build page & diff links...
931 $user = $this->getUser();
932 if ( $this->mCanView
) {
933 $titleObj = $this->getPageTitle();
935 if ( !$rev->userCan( Revision
::DELETED_TEXT
, $this->getUser() ) ) {
936 $pageLink = htmlspecialchars( $this->getLanguage()->userTimeAndDate( $ts, $user ) );
937 $last = $this->msg( 'diff' )->escaped();
938 } elseif ( $remaining > 0 ||
( $earliestLiveTime && $ts > $earliestLiveTime ) ) {
939 $pageLink = $this->getPageLink( $rev, $titleObj, $ts );
940 $last = $this->getLinkRenderer()->makeKnownLink(
942 $this->msg( 'diff' )->text(),
945 'target' => $this->mTargetObj
->getPrefixedText(),
951 $pageLink = $this->getPageLink( $rev, $titleObj, $ts );
952 $last = $this->msg( 'diff' )->escaped();
955 $pageLink = htmlspecialchars( $this->getLanguage()->userTimeAndDate( $ts, $user ) );
956 $last = $this->msg( 'diff' )->escaped();
960 $userLink = Linker
::revUserTools( $rev );
963 $minor = $rev->isMinor() ? ChangesList
::flag( 'minor' ) : '';
965 // Revision text size
966 $size = $row->ar_len
;
967 if ( !is_null( $size ) ) {
968 $revTextSize = Linker
::formatRevisionSize( $size );
972 $comment = Linker
::revComment( $rev );
976 list( $tagSummary, $classes ) = ChangeTags
::formatSummaryRow(
982 $attribs['class'] = implode( ' ', $classes );
985 $revisionRow = $this->msg( 'undelete-revision-row2' )
998 return Xml
::tags( 'li', $attribs, $revisionRow ) . "\n";
1001 private function formatFileRow( $row ) {
1002 $file = ArchivedFile
::newFromRow( $row );
1003 $ts = wfTimestamp( TS_MW
, $row->fa_timestamp
);
1004 $user = $this->getUser();
1007 if ( $this->mCanView
&& $row->fa_storage_key
) {
1008 if ( $this->mAllowed
) {
1009 $checkBox = Xml
::check( 'fileid' . $row->fa_id
);
1011 $key = urlencode( $row->fa_storage_key
);
1012 $pageLink = $this->getFileLink( $file, $this->getPageTitle(), $ts, $key );
1014 $pageLink = htmlspecialchars( $this->getLanguage()->userTimeAndDate( $ts, $user ) );
1016 $userLink = $this->getFileUser( $file );
1017 $data = $this->msg( 'widthheight' )->numParams( $row->fa_width
, $row->fa_height
)->text();
1018 $bytes = $this->msg( 'parentheses' )
1019 ->plaintextParams( $this->msg( 'nbytes' )->numParams( $row->fa_size
)->text() )
1021 $data = htmlspecialchars( $data . ' ' . $bytes );
1022 $comment = $this->getFileComment( $file );
1024 // Add show/hide deletion links if available
1025 $canHide = $this->isAllowed( 'deleterevision' );
1026 if ( $canHide ||
( $file->getVisibility() && $this->isAllowed( 'deletedhistory' ) ) ) {
1027 if ( !$file->userCan( File
::DELETED_RESTRICTED
, $user ) ) {
1028 // Revision was hidden from sysops
1029 $revdlink = Linker
::revDeleteLinkDisabled( $canHide );
1032 'type' => 'filearchive',
1033 'target' => $this->mTargetObj
->getPrefixedDBkey(),
1034 'ids' => $row->fa_id
1036 $revdlink = Linker
::revDeleteLink( $query,
1037 $file->isDeleted( File
::DELETED_RESTRICTED
), $canHide );
1043 return "<li>$checkBox $revdlink $pageLink . . $userLink $data $comment</li>\n";
1047 * Fetch revision text link if it's available to all users
1049 * @param Revision $rev
1050 * @param Title $titleObj
1051 * @param string $ts Timestamp
1054 function getPageLink( $rev, $titleObj, $ts ) {
1055 $user = $this->getUser();
1056 $time = $this->getLanguage()->userTimeAndDate( $ts, $user );
1058 if ( !$rev->userCan( Revision
::DELETED_TEXT
, $user ) ) {
1059 return '<span class="history-deleted">' . $time . '</span>';
1062 $link = $this->getLinkRenderer()->makeKnownLink(
1067 'target' => $this->mTargetObj
->getPrefixedText(),
1072 if ( $rev->isDeleted( Revision
::DELETED_TEXT
) ) {
1073 $link = '<span class="history-deleted">' . $link . '</span>';
1080 * Fetch image view link if it's available to all users
1082 * @param File|ArchivedFile $file
1083 * @param Title $titleObj
1084 * @param string $ts A timestamp
1085 * @param string $key A storage key
1087 * @return string HTML fragment
1089 function getFileLink( $file, $titleObj, $ts, $key ) {
1090 $user = $this->getUser();
1091 $time = $this->getLanguage()->userTimeAndDate( $ts, $user );
1093 if ( !$file->userCan( File
::DELETED_FILE
, $user ) ) {
1094 return '<span class="history-deleted">' . htmlspecialchars( $time ) . '</span>';
1097 $link = $this->getLinkRenderer()->makeKnownLink(
1102 'target' => $this->mTargetObj
->getPrefixedText(),
1104 'token' => $user->getEditToken( $key )
1108 if ( $file->isDeleted( File
::DELETED_FILE
) ) {
1109 $link = '<span class="history-deleted">' . $link . '</span>';
1116 * Fetch file's user id if it's available to this user
1118 * @param File|ArchivedFile $file
1119 * @return string HTML fragment
1121 function getFileUser( $file ) {
1122 if ( !$file->userCan( File
::DELETED_USER
, $this->getUser() ) ) {
1123 return '<span class="history-deleted">' .
1124 $this->msg( 'rev-deleted-user' )->escaped() .
1128 $link = Linker
::userLink( $file->getRawUser(), $file->getRawUserText() ) .
1129 Linker
::userToolLinks( $file->getRawUser(), $file->getRawUserText() );
1131 if ( $file->isDeleted( File
::DELETED_USER
) ) {
1132 $link = '<span class="history-deleted">' . $link . '</span>';
1139 * Fetch file upload comment if it's available to this user
1141 * @param File|ArchivedFile $file
1142 * @return string HTML fragment
1144 function getFileComment( $file ) {
1145 if ( !$file->userCan( File
::DELETED_COMMENT
, $this->getUser() ) ) {
1146 return '<span class="history-deleted"><span class="comment">' .
1147 $this->msg( 'rev-deleted-comment' )->escaped() . '</span></span>';
1150 $link = Linker
::commentBlock( $file->getRawDescription() );
1152 if ( $file->isDeleted( File
::DELETED_COMMENT
) ) {
1153 $link = '<span class="history-deleted">' . $link . '</span>';
1159 function undelete() {
1160 if ( $this->getConfig()->get( 'UploadMaintenance' )
1161 && $this->mTargetObj
->getNamespace() == NS_FILE
1163 throw new ErrorPageError( 'undelete-error', 'filedelete-maintenance' );
1166 $this->checkReadOnly();
1168 $out = $this->getOutput();
1169 $archive = new PageArchive( $this->mTargetObj
, $this->getConfig() );
1170 Hooks
::run( 'UndeleteForm::undelete', [ &$archive, $this->mTargetObj
] );
1171 $ok = $archive->undelete(
1172 $this->mTargetTimestamp
,
1174 $this->mFileVersions
,
1179 if ( is_array( $ok ) ) {
1180 if ( $ok[1] ) { // Undeleted file count
1181 Hooks
::run( 'FileUndeleteComplete', [
1182 $this->mTargetObj
, $this->mFileVersions
,
1183 $this->getUser(), $this->mComment
] );
1186 $link = $this->getLinkRenderer()->makeKnownLink( $this->mTargetObj
);
1187 $out->addWikiMsg( 'undeletedpage', Message
::rawParam( $link ) );
1189 $out->setPageTitle( $this->msg( 'undelete-error' ) );
1192 // Show revision undeletion warnings and errors
1193 $status = $archive->getRevisionStatus();
1194 if ( $status && !$status->isGood() ) {
1195 $out->wrapWikiTextAsInterface(
1197 '<div id="mw-error-cannotundelete">' .
1198 $status->getWikiText(
1205 // Show file undeletion warnings and errors
1206 $status = $archive->getFileStatus();
1207 if ( $status && !$status->isGood() ) {
1208 $out->wrapWikiTextAsInterface(
1210 $status->getWikiText(
1211 'undelete-error-short',
1212 'undelete-error-long'
1219 * Return an array of subpages beginning with $search that this special page will accept.
1221 * @param string $search Prefix to search for
1222 * @param int $limit Maximum number of results to return (usually 10)
1223 * @param int $offset Number of results to skip (usually 0)
1224 * @return string[] Matching subpages
1226 public function prefixSearchSubpages( $search, $limit, $offset ) {
1227 return $this->prefixSearchString( $search, $limit, $offset );
1230 protected function getGroupName() {