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 Wikimedia\Rdbms\ResultWrapper
;
27 * Special page allowing users with the appropriate permissions to view
28 * and restore deleted content.
30 * @ingroup SpecialPage
32 class SpecialUndelete
extends SpecialPage
{
40 private $mTargetTimestamp;
49 * @var string Search prefix
51 private $mSearchPrefix;
53 function __construct() {
54 parent
::__construct( 'Undelete', 'deletedhistory' );
57 public function doesWrites() {
61 function loadRequest( $par ) {
62 $request = $this->getRequest();
63 $user = $this->getUser();
65 $this->mAction
= $request->getVal( 'action' );
66 if ( $par !== null && $par !== '' ) {
67 $this->mTarget
= $par;
69 $this->mTarget
= $request->getVal( 'target' );
72 $this->mTargetObj
= null;
74 if ( $this->mTarget
!== null && $this->mTarget
!== '' ) {
75 $this->mTargetObj
= Title
::newFromText( $this->mTarget
);
78 $this->mSearchPrefix
= $request->getText( 'prefix' );
79 $time = $request->getVal( 'timestamp' );
80 $this->mTimestamp
= $time ?
wfTimestamp( TS_MW
, $time ) : '';
81 $this->mFilename
= $request->getVal( 'file' );
83 $posted = $request->wasPosted() &&
84 $user->matchEditToken( $request->getVal( 'wpEditToken' ) );
85 $this->mRestore
= $request->getCheck( 'restore' ) && $posted;
86 $this->mRevdel
= $request->getCheck( 'revdel' ) && $posted;
87 $this->mInvert
= $request->getCheck( 'invert' ) && $posted;
88 $this->mPreview
= $request->getCheck( 'preview' ) && $posted;
89 $this->mDiff
= $request->getCheck( 'diff' );
90 $this->mDiffOnly
= $request->getBool( 'diffonly', $this->getUser()->getOption( 'diffonly' ) );
91 $this->mComment
= $request->getText( 'wpComment' );
92 $this->mUnsuppress
= $request->getVal( 'wpUnsuppress' ) && $user->isAllowed( 'suppressrevision' );
93 $this->mToken
= $request->getVal( 'token' );
95 if ( $this->isAllowed( 'undelete' ) && !$user->isBlocked() ) {
96 $this->mAllowed
= true; // user can restore
97 $this->mCanView
= true; // user can view content
98 } elseif ( $this->isAllowed( 'deletedtext' ) ) {
99 $this->mAllowed
= false; // user cannot restore
100 $this->mCanView
= true; // user can view content
101 $this->mRestore
= false;
102 } else { // user can only view the list of revisions
103 $this->mAllowed
= false;
104 $this->mCanView
= false;
105 $this->mTimestamp
= '';
106 $this->mRestore
= false;
109 if ( $this->mRestore ||
$this->mInvert
) {
111 $this->mFileVersions
= [];
112 foreach ( $request->getValues() as $key => $val ) {
114 if ( preg_match( '/^ts(\d{14})$/', $key, $matches ) ) {
115 array_push( $timestamps, $matches[1] );
118 if ( preg_match( '/^fileid(\d+)$/', $key, $matches ) ) {
119 $this->mFileVersions
[] = intval( $matches[1] );
122 rsort( $timestamps );
123 $this->mTargetTimestamp
= $timestamps;
128 * Checks whether a user is allowed the permission for the
129 * specific title if one is set.
131 * @param string $permission
135 protected function isAllowed( $permission, User
$user = null ) {
136 $user = $user ?
: $this->getUser();
137 if ( $this->mTargetObj
!== null ) {
138 return $this->mTargetObj
->userCan( $permission, $user );
140 return $user->isAllowed( $permission );
144 function userCanExecute( User
$user ) {
145 return $this->isAllowed( $this->mRestriction
, $user );
148 function execute( $par ) {
149 $this->useTransactionalTimeLimit();
151 $user = $this->getUser();
154 $this->outputHeader();
156 $this->loadRequest( $par );
157 $this->checkPermissions(); // Needs to be after mTargetObj is set
159 $out = $this->getOutput();
161 if ( is_null( $this->mTargetObj
) ) {
162 $out->addWikiMsg( 'undelete-header' );
164 # Not all users can just browse every deleted page from the list
165 if ( $user->isAllowed( 'browsearchive' ) ) {
166 $this->showSearchForm();
172 $this->addHelpLink( 'Help:Undelete' );
173 if ( $this->mAllowed
) {
174 $out->setPageTitle( $this->msg( 'undeletepage' ) );
176 $out->setPageTitle( $this->msg( 'viewdeletedpage' ) );
179 $this->getSkin()->setRelevantTitle( $this->mTargetObj
);
181 if ( $this->mTimestamp
!== '' ) {
182 $this->showRevision( $this->mTimestamp
);
183 } elseif ( $this->mFilename
!== null && $this->mTargetObj
->inNamespace( NS_FILE
) ) {
184 $file = new ArchivedFile( $this->mTargetObj
, '', $this->mFilename
);
185 // Check if user is allowed to see this file
186 if ( !$file->exists() ) {
187 $out->addWikiMsg( 'filedelete-nofile', $this->mFilename
);
188 } elseif ( !$file->userCan( File
::DELETED_FILE
, $user ) ) {
189 if ( $file->isDeleted( File
::DELETED_RESTRICTED
) ) {
190 throw new PermissionsError( 'suppressrevision' );
192 throw new PermissionsError( 'deletedtext' );
194 } elseif ( !$user->matchEditToken( $this->mToken
, $this->mFilename
) ) {
195 $this->showFileConfirmationForm( $this->mFilename
);
197 $this->showFile( $this->mFilename
);
199 } elseif ( $this->mAction
=== "submit" ) {
200 if ( $this->mRestore
) {
202 } elseif ( $this->mRevdel
) {
203 $this->redirectToRevDel();
207 $this->showHistory();
212 * Convert submitted form data to format expected by RevisionDelete and
213 * redirect the request
215 private function redirectToRevDel() {
216 $archive = new PageArchive( $this->mTargetObj
);
220 foreach ( $this->getRequest()->getValues() as $key => $val ) {
222 if ( preg_match( "/^ts(\d{14})$/", $key, $matches ) ) {
223 $revisions[ $archive->getRevision( $matches[1] )->getId() ] = 1;
227 "type" => "revision",
229 "target" => $this->mTargetObj
->getPrefixedText()
231 $url = SpecialPage
::getTitleFor( 'Revisiondelete' )->getFullURL( $query );
232 $this->getOutput()->redirect( $url );
235 function showSearchForm() {
236 $out = $this->getOutput();
237 $out->setPageTitle( $this->msg( 'undelete-search-title' ) );
238 $fuzzySearch = $this->getRequest()->getVal( 'fuzzy', true );
242 $fields[] = new OOUI\
ActionFieldLayout(
243 new OOUI\
TextInputWidget( [
245 'inputId' => 'prefix',
247 'value' => $this->mSearchPrefix
,
250 new OOUI\
ButtonInputWidget( [
251 'label' => $this->msg( 'undelete-search-submit' )->text(),
252 'flags' => [ 'primary', 'progressive' ],
253 'inputId' => 'searchUndelete',
257 'label' => new OOUI\
HtmlSnippet(
259 $fuzzySearch ?
'undelete-search-full' : 'undelete-search-prefix'
266 $fieldset = new OOUI\
FieldsetLayout( [
267 'label' => $this->msg( 'undelete-search-box' )->text(),
271 $form = new OOUI\
FormLayout( [
273 'action' => wfScript(),
276 $form->appendContent(
278 new OOUI\
HtmlSnippet(
279 Html
::hidden( 'title', $this->getPageTitle()->getPrefixedDBkey() ) .
280 Html
::hidden( 'fuzzy', $fuzzySearch )
285 new OOUI\
PanelLayout( [
293 # List undeletable articles
294 if ( $this->mSearchPrefix
) {
295 // For now, we enable search engine match only when specifically asked to
296 // by using fuzzy=1 parameter.
297 if ( $fuzzySearch ) {
298 $result = PageArchive
::listPagesBySearch( $this->mSearchPrefix
);
300 $result = PageArchive
::listPagesByPrefix( $this->mSearchPrefix
);
302 $this->showList( $result );
307 * Generic list of deleted pages
309 * @param ResultWrapper $result
312 private function showList( $result ) {
313 $out = $this->getOutput();
315 if ( $result->numRows() == 0 ) {
316 $out->addWikiMsg( 'undelete-no-results' );
321 $out->addWikiMsg( 'undeletepagetext', $this->getLanguage()->formatNum( $result->numRows() ) );
323 $linkRenderer = $this->getLinkRenderer();
324 $undelete = $this->getPageTitle();
325 $out->addHTML( "<ul id='undeleteResultsList'>\n" );
326 foreach ( $result as $row ) {
327 $title = Title
::makeTitleSafe( $row->ar_namespace
, $row->ar_title
);
328 if ( $title !== null ) {
329 $item = $linkRenderer->makeKnownLink(
331 $title->getPrefixedText(),
333 [ 'target' => $title->getPrefixedText() ]
336 // The title is no longer valid, show as text
337 $item = Html
::element(
339 [ 'class' => 'mw-invalidtitle' ],
340 Linker
::getInvalidTitleDescription(
347 $revs = $this->msg( 'undeleterevisions' )->numParams( $row->count
)->parse();
348 $out->addHTML( "<li class='undeleteResult'>{$item} ({$revs})</li>\n" );
351 $out->addHTML( "</ul>\n" );
356 private function showRevision( $timestamp ) {
357 if ( !preg_match( '/[0-9]{14}/', $timestamp ) ) {
361 $archive = new PageArchive( $this->mTargetObj
, $this->getConfig() );
362 if ( !Hooks
::run( 'UndeleteForm::showRevision', [ &$archive, $this->mTargetObj
] ) ) {
365 $rev = $archive->getRevision( $timestamp );
367 $out = $this->getOutput();
368 $user = $this->getUser();
371 $out->addWikiMsg( 'undeleterevision-missing' );
376 if ( $rev->isDeleted( Revision
::DELETED_TEXT
) ) {
377 if ( !$rev->userCan( Revision
::DELETED_TEXT
, $user ) ) {
379 "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
380 $rev->isDeleted( Revision
::DELETED_RESTRICTED
) ?
381 'rev-suppressed-text-permission' : 'rev-deleted-text-permission'
388 "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
389 $rev->isDeleted( Revision
::DELETED_RESTRICTED
) ?
390 'rev-suppressed-text-view' : 'rev-deleted-text-view'
392 $out->addHTML( '<br />' );
393 // and we are allowed to see...
396 if ( $this->mDiff
) {
397 $previousRev = $archive->getPreviousRevision( $timestamp );
398 if ( $previousRev ) {
399 $this->showDiff( $previousRev, $rev );
400 if ( $this->mDiffOnly
) {
404 $out->addHTML( '<hr />' );
406 $out->addWikiMsg( 'undelete-nodiff' );
410 $link = $this->getLinkRenderer()->makeKnownLink(
411 $this->getPageTitle( $this->mTargetObj
->getPrefixedDBkey() ),
412 $this->mTargetObj
->getPrefixedText()
415 $lang = $this->getLanguage();
417 // date and time are separate parameters to facilitate localisation.
418 // $time is kept for backward compat reasons.
419 $time = $lang->userTimeAndDate( $timestamp, $user );
420 $d = $lang->userDate( $timestamp, $user );
421 $t = $lang->userTime( $timestamp, $user );
422 $userLink = Linker
::revUserTools( $rev );
424 $content = $rev->getContent( Revision
::FOR_THIS_USER
, $user );
426 $isText = ( $content instanceof TextContent
);
428 if ( $this->mPreview ||
$isText ) {
429 $openDiv = '<div id="mw-undelete-revision" class="mw-warning">';
431 $openDiv = '<div id="mw-undelete-revision">';
433 $out->addHTML( $openDiv );
435 // Revision delete links
436 if ( !$this->mDiff
) {
437 $revdel = Linker
::getRevDeleteLink( $user, $rev, $this->mTargetObj
);
439 $out->addHTML( "$revdel " );
443 $out->addHTML( $this->msg( 'undelete-revision' )->rawParams( $link )->params(
444 $time )->rawParams( $userLink )->params( $d, $t )->parse() . '</div>' );
446 if ( !Hooks
::run( 'UndeleteShowRevision', [ $this->mTargetObj
, $rev ] ) ) {
450 if ( ( $this->mPreview ||
!$isText ) && $content ) {
451 // NOTE: non-text content has no source view, so always use rendered preview
453 $popts = $out->parserOptions();
455 $pout = $content->getParserOutput( $this->mTargetObj
, $rev->getId(), $popts, true );
456 $out->addParserOutput( $pout, [
457 'enableSectionEditLinks' => false,
465 // source view for textual content
466 $sourceView = Xml
::element( 'textarea', [
467 'readonly' => 'readonly',
470 ], $content->getNativeData() . "\n" );
472 $buttonFields[] = new OOUI\
ButtonInputWidget( [
475 'label' => $this->msg( 'showpreview' )->text()
482 $buttonFields[] = new OOUI\
ButtonInputWidget( [
485 'label' => $this->msg( 'showdiff' )->text()
490 Xml
::openElement( 'div', [
491 'style' => 'clear: both' ] ) .
492 Xml
::openElement( 'form', [
494 'action' => $this->getPageTitle()->getLocalURL( [ 'action' => 'submit' ] ) ] ) .
495 Xml
::element( 'input', [
498 'value' => $this->mTargetObj
->getPrefixedDBkey() ] ) .
499 Xml
::element( 'input', [
501 'name' => 'timestamp',
502 'value' => $timestamp ] ) .
503 Xml
::element( 'input', [
505 'name' => 'wpEditToken',
506 'value' => $user->getEditToken() ] ) .
507 new OOUI\
FieldLayout(
509 'content' => new OOUI\
HorizontalLayout( [
510 'items' => $buttonFields
514 Xml
::closeElement( 'form' ) .
515 Xml
::closeElement( 'div' )
520 * Build a diff display between this and the previous either deleted
521 * or non-deleted edit.
523 * @param Revision $previousRev
524 * @param Revision $currentRev
525 * @return string HTML
527 function showDiff( $previousRev, $currentRev ) {
528 $diffContext = clone $this->getContext();
529 $diffContext->setTitle( $currentRev->getTitle() );
530 $diffContext->setWikiPage( WikiPage
::factory( $currentRev->getTitle() ) );
532 $diffEngine = $currentRev->getContentHandler()->createDifferenceEngine( $diffContext );
533 $diffEngine->showDiffStyle();
535 $formattedDiff = $diffEngine->generateContentDiffBody(
536 $previousRev->getContent( Revision
::FOR_THIS_USER
, $this->getUser() ),
537 $currentRev->getContent( Revision
::FOR_THIS_USER
, $this->getUser() )
540 $formattedDiff = $diffEngine->addHeader(
542 $this->diffHeader( $previousRev, 'o' ),
543 $this->diffHeader( $currentRev, 'n' )
546 $this->getOutput()->addHTML( "<div>$formattedDiff</div>\n" );
550 * @param Revision $rev
551 * @param string $prefix
554 private function diffHeader( $rev, $prefix ) {
555 $isDeleted = !( $rev->getId() && $rev->getTitle() );
557 /// @todo FIXME: $rev->getTitle() is null for deleted revs...?
558 $targetPage = $this->getPageTitle();
560 'target' => $this->mTargetObj
->getPrefixedText(),
561 'timestamp' => wfTimestamp( TS_MW
, $rev->getTimestamp() )
564 /// @todo FIXME: getId() may return non-zero for deleted revs...
565 $targetPage = $rev->getTitle();
566 $targetQuery = [ 'oldid' => $rev->getId() ];
569 // Add show/hide deletion links if available
570 $user = $this->getUser();
571 $lang = $this->getLanguage();
572 $rdel = Linker
::getRevDeleteLink( $user, $rev, $this->mTargetObj
);
578 $minor = $rev->isMinor() ? ChangesList
::flag( 'minor' ) : '';
580 $tags = wfGetDB( DB_REPLICA
)->selectField(
583 [ 'ts_rev_id' => $rev->getId() ],
586 $tagSummary = ChangeTags
::formatSummaryRow( $tags, 'deleteddiff', $this->getContext() );
588 // FIXME This is reimplementing DifferenceEngine#getRevisionHeader
589 // and partially #showDiffPage, but worse
590 return '<div id="mw-diff-' . $prefix . 'title1"><strong>' .
591 $this->getLinkRenderer()->makeLink(
595 $lang->userTimeAndDate( $rev->getTimestamp(), $user ),
596 $lang->userDate( $rev->getTimestamp(), $user ),
597 $lang->userTime( $rev->getTimestamp(), $user )
603 '<div id="mw-diff-' . $prefix . 'title2">' .
604 Linker
::revUserTools( $rev ) . '<br />' .
606 '<div id="mw-diff-' . $prefix . 'title3">' .
607 $minor . Linker
::revComment( $rev ) . $rdel . '<br />' .
609 '<div id="mw-diff-' . $prefix . 'title5">' .
610 $tagSummary[0] . '<br />' .
615 * Show a form confirming whether a tokenless user really wants to see a file
618 private function showFileConfirmationForm( $key ) {
619 $out = $this->getOutput();
620 $lang = $this->getLanguage();
621 $user = $this->getUser();
622 $file = new ArchivedFile( $this->mTargetObj
, '', $this->mFilename
);
623 $out->addWikiMsg( 'undelete-show-file-confirm',
624 $this->mTargetObj
->getText(),
625 $lang->userDate( $file->getTimestamp(), $user ),
626 $lang->userTime( $file->getTimestamp(), $user ) );
628 Xml
::openElement( 'form', [
630 'action' => $this->getPageTitle()->getLocalURL( [
631 'target' => $this->mTarget
,
633 'token' => $user->getEditToken( $key ),
637 Xml
::submitButton( $this->msg( 'undelete-show-file-submit' )->text() ) .
643 * Show a deleted file version requested by the visitor.
646 private function showFile( $key ) {
647 $this->getOutput()->disable();
649 # We mustn't allow the output to be CDN cached, otherwise
650 # if an admin previews a deleted image, and it's cached, then
651 # a user without appropriate permissions can toddle off and
652 # nab the image, and CDN will serve it
653 $response = $this->getRequest()->response();
654 $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
655 $response->header( 'Cache-Control: no-cache, no-store, max-age=0, must-revalidate' );
656 $response->header( 'Pragma: no-cache' );
658 $repo = RepoGroup
::singleton()->getLocalRepo();
659 $path = $repo->getZonePath( 'deleted' ) . '/' . $repo->getDeletedHashPath( $key ) . $key;
660 $repo->streamFile( $path );
663 protected function showHistory() {
664 $this->checkReadOnly();
666 $out = $this->getOutput();
667 if ( $this->mAllowed
) {
668 $out->addModules( 'mediawiki.special.undelete' );
671 "<div class='mw-undelete-pagetitle'>\n$1\n</div>\n",
672 [ 'undeletepagetitle', wfEscapeWikiText( $this->mTargetObj
->getPrefixedText() ) ]
675 $archive = new PageArchive( $this->mTargetObj
, $this->getConfig() );
676 Hooks
::run( 'UndeleteForm::showHistory', [ &$archive, $this->mTargetObj
] );
678 $out->addHTML( '<div class="mw-undelete-history">' );
679 if ( $this->mAllowed
) {
680 $out->addWikiMsg( 'undeletehistory' );
681 $out->addWikiMsg( 'undeleterevdel' );
683 $out->addWikiMsg( 'undeletehistorynoadmin' );
685 $out->addHTML( '</div>' );
687 # List all stored revisions
688 $revisions = $archive->listRevisions();
689 $files = $archive->listFiles();
691 $haveRevisions = $revisions && $revisions->numRows() > 0;
692 $haveFiles = $files && $files->numRows() > 0;
694 # Batch existence check on user and talk pages
695 if ( $haveRevisions ) {
696 $batch = new LinkBatch();
697 foreach ( $revisions as $row ) {
698 $batch->addObj( Title
::makeTitleSafe( NS_USER
, $row->ar_user_text
) );
699 $batch->addObj( Title
::makeTitleSafe( NS_USER_TALK
, $row->ar_user_text
) );
702 $revisions->seek( 0 );
705 $batch = new LinkBatch();
706 foreach ( $files as $row ) {
707 $batch->addObj( Title
::makeTitleSafe( NS_USER
, $row->fa_user_text
) );
708 $batch->addObj( Title
::makeTitleSafe( NS_USER_TALK
, $row->fa_user_text
) );
714 if ( $this->mAllowed
) {
717 $action = $this->getPageTitle()->getLocalURL( [ 'action' => 'submit' ] );
718 # Start the form here
719 $form = new OOUI\
FormLayout( [
726 # Show relevant lines from the deletion log:
727 $deleteLogPage = new LogPage( 'delete' );
728 $out->addHTML( Xml
::element( 'h2', null, $deleteLogPage->getName()->text() ) . "\n" );
729 LogEventsList
::showLogExtract( $out, 'delete', $this->mTargetObj
);
730 # Show relevant lines from the suppression log:
731 $suppressLogPage = new LogPage( 'suppress' );
732 if ( $this->getUser()->isAllowed( 'suppressionlog' ) ) {
733 $out->addHTML( Xml
::element( 'h2', null, $suppressLogPage->getName()->text() ) . "\n" );
734 LogEventsList
::showLogExtract( $out, 'suppress', $this->mTargetObj
);
737 if ( $this->mAllowed
&& ( $haveRevisions ||
$haveFiles ) ) {
738 $fields[] = new OOUI\
Layout( [
739 'content' => new OOUI\
HtmlSnippet( $this->msg( 'undeleteextrahelp' )->parseAsBlock() )
742 $conf = $this->getConfig();
743 $oldCommentSchema = $conf->get( 'CommentTableSchemaMigrationStage' ) === MIGRATION_OLD
;
745 $fields[] = new OOUI\
FieldLayout(
746 new OOUI\
TextInputWidget( [
747 'name' => 'wpComment',
748 'inputId' => 'wpComment',
750 'value' => $this->mComment
,
752 // HTML maxlength uses "UTF-16 code units", which means that characters outside BMP
753 // (e.g. emojis) count for two each. This limit is overridden in JS to instead count
754 // Unicode codepoints (or 255 UTF-8 bytes for old schema).
755 'maxLength' => $oldCommentSchema ?
255 : CommentStore
::COMMENT_CHARACTER_LIMIT
,
758 'label' => $this->msg( 'undeletecomment' )->text(),
763 $fields[] = new OOUI\
FieldLayout(
765 'content' => new OOUI\
HorizontalLayout( [
767 new OOUI\
ButtonInputWidget( [
769 'inputId' => 'mw-undelete-submit',
771 'label' => $this->msg( 'undeletebtn' )->text(),
772 'flags' => [ 'primary', 'progressive' ],
775 new OOUI\
ButtonInputWidget( [
777 'inputId' => 'mw-undelete-invert',
779 'label' => $this->msg( 'undeleteinvert' )->text()
786 if ( $this->getUser()->isAllowed( 'suppressrevision' ) ) {
787 $fields[] = new OOUI\
FieldLayout(
788 new OOUI\
CheckboxInputWidget( [
789 'name' => 'wpUnsuppress',
790 'inputId' => 'mw-undelete-unsuppress',
794 'label' => $this->msg( 'revdelete-unsuppress' )->text(),
800 $fieldset = new OOUI\
FieldsetLayout( [
801 'label' => $this->msg( 'undelete-fieldset-title' )->text(),
802 'id' => 'mw-undelete-table',
806 $form->appendContent(
807 new OOUI\
PanelLayout( [
811 'content' => $fieldset,
813 new OOUI\
HtmlSnippet(
814 Html
::hidden( 'target', $this->mTarget
) .
815 Html
::hidden( 'wpEditToken', $this->getUser()->getEditToken() )
821 $history .= Xml
::element( 'h2', null, $this->msg( 'history' )->text() ) . "\n";
823 if ( $haveRevisions ) {
824 # Show the page's stored (deleted) history
826 if ( $this->getUser()->isAllowed( 'deleterevision' ) ) {
827 $history .= Html
::element(
832 'class' => 'deleterevision-log-submit mw-log-deleterevision-button'
834 $this->msg( 'showhideselectedversions' )->text()
838 $history .= '<ul class="mw-undelete-revlist">';
839 $remaining = $revisions->numRows();
840 $earliestLiveTime = $this->mTargetObj
->getEarliestRevTime();
842 foreach ( $revisions as $row ) {
844 $history .= $this->formatRevisionRow( $row, $earliestLiveTime, $remaining );
849 $out->addWikiMsg( 'nohistory' );
853 $history .= Xml
::element( 'h2', null, $this->msg( 'filehist' )->text() ) . "\n";
854 $history .= '<ul class="mw-undelete-revlist">';
855 foreach ( $files as $row ) {
856 $history .= $this->formatFileRow( $row );
862 if ( $this->mAllowed
) {
863 # Slip in the hidden controls here
864 $misc = Html
::hidden( 'target', $this->mTarget
);
865 $misc .= Html
::hidden( 'wpEditToken', $this->getUser()->getEditToken() );
868 $form->appendContent( new OOUI\
HtmlSnippet( $history ) );
869 $out->addHTML( $form );
871 $out->addHTML( $history );
877 protected function formatRevisionRow( $row, $earliestLiveTime, $remaining ) {
878 $rev = Revision
::newFromArchiveRow( $row,
880 'title' => $this->mTargetObj
884 $ts = wfTimestamp( TS_MW
, $row->ar_timestamp
);
885 // Build checkboxen...
886 if ( $this->mAllowed
) {
887 if ( $this->mInvert
) {
888 if ( in_array( $ts, $this->mTargetTimestamp
) ) {
889 $checkBox = Xml
::check( "ts$ts" );
891 $checkBox = Xml
::check( "ts$ts", true );
894 $checkBox = Xml
::check( "ts$ts" );
900 // Build page & diff links...
901 $user = $this->getUser();
902 if ( $this->mCanView
) {
903 $titleObj = $this->getPageTitle();
905 if ( !$rev->userCan( Revision
::DELETED_TEXT
, $this->getUser() ) ) {
906 $pageLink = htmlspecialchars( $this->getLanguage()->userTimeAndDate( $ts, $user ) );
907 $last = $this->msg( 'diff' )->escaped();
908 } elseif ( $remaining > 0 ||
( $earliestLiveTime && $ts > $earliestLiveTime ) ) {
909 $pageLink = $this->getPageLink( $rev, $titleObj, $ts );
910 $last = $this->getLinkRenderer()->makeKnownLink(
912 $this->msg( 'diff' )->text(),
915 'target' => $this->mTargetObj
->getPrefixedText(),
921 $pageLink = $this->getPageLink( $rev, $titleObj, $ts );
922 $last = $this->msg( 'diff' )->escaped();
925 $pageLink = htmlspecialchars( $this->getLanguage()->userTimeAndDate( $ts, $user ) );
926 $last = $this->msg( 'diff' )->escaped();
930 $userLink = Linker
::revUserTools( $rev );
933 $minor = $rev->isMinor() ? ChangesList
::flag( 'minor' ) : '';
935 // Revision text size
936 $size = $row->ar_len
;
937 if ( !is_null( $size ) ) {
938 $revTextSize = Linker
::formatRevisionSize( $size );
942 $comment = Linker
::revComment( $rev );
946 list( $tagSummary, $classes ) = ChangeTags
::formatSummaryRow(
952 $attribs['class'] = implode( ' ', $classes );
955 $revisionRow = $this->msg( 'undelete-revision-row2' )
968 return Xml
::tags( 'li', $attribs, $revisionRow ) . "\n";
971 private function formatFileRow( $row ) {
972 $file = ArchivedFile
::newFromRow( $row );
973 $ts = wfTimestamp( TS_MW
, $row->fa_timestamp
);
974 $user = $this->getUser();
977 if ( $this->mCanView
&& $row->fa_storage_key
) {
978 if ( $this->mAllowed
) {
979 $checkBox = Xml
::check( 'fileid' . $row->fa_id
);
981 $key = urlencode( $row->fa_storage_key
);
982 $pageLink = $this->getFileLink( $file, $this->getPageTitle(), $ts, $key );
984 $pageLink = htmlspecialchars( $this->getLanguage()->userTimeAndDate( $ts, $user ) );
986 $userLink = $this->getFileUser( $file );
987 $data = $this->msg( 'widthheight' )->numParams( $row->fa_width
, $row->fa_height
)->text();
988 $bytes = $this->msg( 'parentheses' )
989 ->plaintextParams( $this->msg( 'nbytes' )->numParams( $row->fa_size
)->text() )
991 $data = htmlspecialchars( $data . ' ' . $bytes );
992 $comment = $this->getFileComment( $file );
994 // Add show/hide deletion links if available
995 $canHide = $this->isAllowed( 'deleterevision' );
996 if ( $canHide ||
( $file->getVisibility() && $this->isAllowed( 'deletedhistory' ) ) ) {
997 if ( !$file->userCan( File
::DELETED_RESTRICTED
, $user ) ) {
998 // Revision was hidden from sysops
999 $revdlink = Linker
::revDeleteLinkDisabled( $canHide );
1002 'type' => 'filearchive',
1003 'target' => $this->mTargetObj
->getPrefixedDBkey(),
1004 'ids' => $row->fa_id
1006 $revdlink = Linker
::revDeleteLink( $query,
1007 $file->isDeleted( File
::DELETED_RESTRICTED
), $canHide );
1013 return "<li>$checkBox $revdlink $pageLink . . $userLink $data $comment</li>\n";
1017 * Fetch revision text link if it's available to all users
1019 * @param Revision $rev
1020 * @param Title $titleObj
1021 * @param string $ts Timestamp
1024 function getPageLink( $rev, $titleObj, $ts ) {
1025 $user = $this->getUser();
1026 $time = $this->getLanguage()->userTimeAndDate( $ts, $user );
1028 if ( !$rev->userCan( Revision
::DELETED_TEXT
, $user ) ) {
1029 return '<span class="history-deleted">' . $time . '</span>';
1032 $link = $this->getLinkRenderer()->makeKnownLink(
1037 'target' => $this->mTargetObj
->getPrefixedText(),
1042 if ( $rev->isDeleted( Revision
::DELETED_TEXT
) ) {
1043 $link = '<span class="history-deleted">' . $link . '</span>';
1050 * Fetch image view link if it's available to all users
1052 * @param File|ArchivedFile $file
1053 * @param Title $titleObj
1054 * @param string $ts A timestamp
1055 * @param string $key A storage key
1057 * @return string HTML fragment
1059 function getFileLink( $file, $titleObj, $ts, $key ) {
1060 $user = $this->getUser();
1061 $time = $this->getLanguage()->userTimeAndDate( $ts, $user );
1063 if ( !$file->userCan( File
::DELETED_FILE
, $user ) ) {
1064 return '<span class="history-deleted">' . htmlspecialchars( $time ) . '</span>';
1067 $link = $this->getLinkRenderer()->makeKnownLink(
1072 'target' => $this->mTargetObj
->getPrefixedText(),
1074 'token' => $user->getEditToken( $key )
1078 if ( $file->isDeleted( File
::DELETED_FILE
) ) {
1079 $link = '<span class="history-deleted">' . $link . '</span>';
1086 * Fetch file's user id if it's available to this user
1088 * @param File|ArchivedFile $file
1089 * @return string HTML fragment
1091 function getFileUser( $file ) {
1092 if ( !$file->userCan( File
::DELETED_USER
, $this->getUser() ) ) {
1093 return '<span class="history-deleted">' .
1094 $this->msg( 'rev-deleted-user' )->escaped() .
1098 $link = Linker
::userLink( $file->getRawUser(), $file->getRawUserText() ) .
1099 Linker
::userToolLinks( $file->getRawUser(), $file->getRawUserText() );
1101 if ( $file->isDeleted( File
::DELETED_USER
) ) {
1102 $link = '<span class="history-deleted">' . $link . '</span>';
1109 * Fetch file upload comment if it's available to this user
1111 * @param File|ArchivedFile $file
1112 * @return string HTML fragment
1114 function getFileComment( $file ) {
1115 if ( !$file->userCan( File
::DELETED_COMMENT
, $this->getUser() ) ) {
1116 return '<span class="history-deleted"><span class="comment">' .
1117 $this->msg( 'rev-deleted-comment' )->escaped() . '</span></span>';
1120 $link = Linker
::commentBlock( $file->getRawDescription() );
1122 if ( $file->isDeleted( File
::DELETED_COMMENT
) ) {
1123 $link = '<span class="history-deleted">' . $link . '</span>';
1129 function undelete() {
1130 if ( $this->getConfig()->get( 'UploadMaintenance' )
1131 && $this->mTargetObj
->getNamespace() == NS_FILE
1133 throw new ErrorPageError( 'undelete-error', 'filedelete-maintenance' );
1136 $this->checkReadOnly();
1138 $out = $this->getOutput();
1139 $archive = new PageArchive( $this->mTargetObj
, $this->getConfig() );
1140 Hooks
::run( 'UndeleteForm::undelete', [ &$archive, $this->mTargetObj
] );
1141 $ok = $archive->undelete(
1142 $this->mTargetTimestamp
,
1144 $this->mFileVersions
,
1149 if ( is_array( $ok ) ) {
1150 if ( $ok[1] ) { // Undeleted file count
1151 Hooks
::run( 'FileUndeleteComplete', [
1152 $this->mTargetObj
, $this->mFileVersions
,
1153 $this->getUser(), $this->mComment
] );
1156 $link = $this->getLinkRenderer()->makeKnownLink( $this->mTargetObj
);
1157 $out->addHTML( $this->msg( 'undeletedpage' )->rawParams( $link )->parse() );
1159 $out->setPageTitle( $this->msg( 'undelete-error' ) );
1162 // Show revision undeletion warnings and errors
1163 $status = $archive->getRevisionStatus();
1164 if ( $status && !$status->isGood() ) {
1165 $out->addWikiText( '<div class="error" id="mw-error-cannotundelete">' .
1166 $status->getWikiText(
1173 // Show file undeletion warnings and errors
1174 $status = $archive->getFileStatus();
1175 if ( $status && !$status->isGood() ) {
1176 $out->addWikiText( '<div class="error">' .
1177 $status->getWikiText(
1178 'undelete-error-short',
1179 'undelete-error-long'
1186 * Return an array of subpages beginning with $search that this special page will accept.
1188 * @param string $search Prefix to search for
1189 * @param int $limit Maximum number of results to return (usually 10)
1190 * @param int $offset Number of results to skip (usually 0)
1191 * @return string[] Matching subpages
1193 public function prefixSearchSubpages( $search, $limit, $offset ) {
1194 return $this->prefixSearchString( $search, $limit, $offset );
1197 protected function getGroupName() {