456facef1216e7cd3d364f747445b5d775597991
[lhc/web/wiklou.git] / includes / specials / SpecialUndelete.php
1 <?php
2 /**
3 * Implements Special:Undelete
4 *
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.
9 *
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.
14 *
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
19 *
20 * @file
21 * @ingroup SpecialPage
22 */
23
24 use MediaWiki\MediaWikiServices;
25 use MediaWiki\Revision\RevisionRecord;
26 use MediaWiki\Storage\NameTableAccessException;
27 use Wikimedia\Rdbms\IResultWrapper;
28
29 /**
30 * Special page allowing users with the appropriate permissions to view
31 * and restore deleted content.
32 *
33 * @ingroup SpecialPage
34 */
35 class SpecialUndelete extends SpecialPage {
36 private $mAction;
37 private $mTarget;
38 private $mTimestamp;
39 private $mRestore;
40 private $mRevdel;
41 private $mInvert;
42 private $mFilename;
43 private $mTargetTimestamp;
44 private $mAllowed;
45 private $mCanView;
46 private $mComment;
47 private $mToken;
48
49 /** @var Title */
50 private $mTargetObj;
51 /**
52 * @var string Search prefix
53 */
54 private $mSearchPrefix;
55
56 function __construct() {
57 parent::__construct( 'Undelete', 'deletedhistory' );
58 }
59
60 public function doesWrites() {
61 return true;
62 }
63
64 function loadRequest( $par ) {
65 $request = $this->getRequest();
66 $user = $this->getUser();
67
68 $this->mAction = $request->getVal( 'action' );
69 if ( $par !== null && $par !== '' ) {
70 $this->mTarget = $par;
71 } else {
72 $this->mTarget = $request->getVal( 'target' );
73 }
74
75 $this->mTargetObj = null;
76
77 if ( $this->mTarget !== null && $this->mTarget !== '' ) {
78 $this->mTargetObj = Title::newFromText( $this->mTarget );
79 }
80
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' );
85
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' );
97
98 $block = $user->getBlock();
99 if ( $this->isAllowed( 'undelete' ) && !( $block && $block->isSitewide() ) ) {
100 $this->mAllowed = true; // user can restore
101 $this->mCanView = true; // user can view content
102 } elseif ( $this->isAllowed( 'deletedtext' ) ) {
103 $this->mAllowed = false; // user cannot restore
104 $this->mCanView = true; // user can view content
105 $this->mRestore = false;
106 } else { // user can only view the list of revisions
107 $this->mAllowed = false;
108 $this->mCanView = false;
109 $this->mTimestamp = '';
110 $this->mRestore = false;
111 }
112
113 if ( $this->mRestore || $this->mInvert ) {
114 $timestamps = [];
115 $this->mFileVersions = [];
116 foreach ( $request->getValues() as $key => $val ) {
117 $matches = [];
118 if ( preg_match( '/^ts(\d{14})$/', $key, $matches ) ) {
119 array_push( $timestamps, $matches[1] );
120 }
121
122 if ( preg_match( '/^fileid(\d+)$/', $key, $matches ) ) {
123 $this->mFileVersions[] = intval( $matches[1] );
124 }
125 }
126 rsort( $timestamps );
127 $this->mTargetTimestamp = $timestamps;
128 }
129 }
130
131 /**
132 * Checks whether a user is allowed the permission for the
133 * specific title if one is set.
134 *
135 * @param string $permission
136 * @param User|null $user
137 * @return bool
138 */
139 protected function isAllowed( $permission, User $user = null ) {
140 $user = $user ?: $this->getUser();
141 if ( $this->mTargetObj !== null ) {
142 return $this->mTargetObj->userCan( $permission, $user );
143 } else {
144 return $user->isAllowed( $permission );
145 }
146 }
147
148 function userCanExecute( User $user ) {
149 return $this->isAllowed( $this->mRestriction, $user );
150 }
151
152 function execute( $par ) {
153 $this->useTransactionalTimeLimit();
154
155 $user = $this->getUser();
156
157 $this->setHeaders();
158 $this->outputHeader();
159
160 $this->loadRequest( $par );
161 $this->checkPermissions(); // Needs to be after mTargetObj is set
162
163 $out = $this->getOutput();
164
165 if ( is_null( $this->mTargetObj ) ) {
166 $out->addWikiMsg( 'undelete-header' );
167
168 # Not all users can just browse every deleted page from the list
169 if ( $user->isAllowed( 'browsearchive' ) ) {
170 $this->showSearchForm();
171 }
172
173 return;
174 }
175
176 $this->addHelpLink( 'Help:Undelete' );
177 if ( $this->mAllowed ) {
178 $out->setPageTitle( $this->msg( 'undeletepage' ) );
179 } else {
180 $out->setPageTitle( $this->msg( 'viewdeletedpage' ) );
181 }
182
183 $this->getSkin()->setRelevantTitle( $this->mTargetObj );
184
185 if ( $this->mTimestamp !== '' ) {
186 $this->showRevision( $this->mTimestamp );
187 } elseif ( $this->mFilename !== null && $this->mTargetObj->inNamespace( NS_FILE ) ) {
188 $file = new ArchivedFile( $this->mTargetObj, '', $this->mFilename );
189 // Check if user is allowed to see this file
190 if ( !$file->exists() ) {
191 $out->addWikiMsg( 'filedelete-nofile', $this->mFilename );
192 } elseif ( !$file->userCan( File::DELETED_FILE, $user ) ) {
193 if ( $file->isDeleted( File::DELETED_RESTRICTED ) ) {
194 throw new PermissionsError( 'suppressrevision' );
195 } else {
196 throw new PermissionsError( 'deletedtext' );
197 }
198 } elseif ( !$user->matchEditToken( $this->mToken, $this->mFilename ) ) {
199 $this->showFileConfirmationForm( $this->mFilename );
200 } else {
201 $this->showFile( $this->mFilename );
202 }
203 } elseif ( $this->mAction === 'submit' ) {
204 if ( $this->mRestore ) {
205 $this->undelete();
206 } elseif ( $this->mRevdel ) {
207 $this->redirectToRevDel();
208 }
209
210 } else {
211 $this->showHistory();
212 }
213 }
214
215 /**
216 * Convert submitted form data to format expected by RevisionDelete and
217 * redirect the request
218 */
219 private function redirectToRevDel() {
220 $archive = new PageArchive( $this->mTargetObj );
221
222 $revisions = [];
223
224 foreach ( $this->getRequest()->getValues() as $key => $val ) {
225 $matches = [];
226 if ( preg_match( "/^ts(\d{14})$/", $key, $matches ) ) {
227 $revisions[$archive->getRevision( $matches[1] )->getId()] = 1;
228 }
229 }
230
231 $query = [
232 'type' => 'revision',
233 'ids' => $revisions,
234 'target' => $this->mTargetObj->getPrefixedText()
235 ];
236 $url = SpecialPage::getTitleFor( 'Revisiondelete' )->getFullURL( $query );
237 $this->getOutput()->redirect( $url );
238 }
239
240 function showSearchForm() {
241 $out = $this->getOutput();
242 $out->setPageTitle( $this->msg( 'undelete-search-title' ) );
243 $fuzzySearch = $this->getRequest()->getVal( 'fuzzy', true );
244
245 $out->enableOOUI();
246
247 $fields[] = new OOUI\ActionFieldLayout(
248 new OOUI\TextInputWidget( [
249 'name' => 'prefix',
250 'inputId' => 'prefix',
251 'infusable' => true,
252 'value' => $this->mSearchPrefix,
253 'autofocus' => true,
254 ] ),
255 new OOUI\ButtonInputWidget( [
256 'label' => $this->msg( 'undelete-search-submit' )->text(),
257 'flags' => [ 'primary', 'progressive' ],
258 'inputId' => 'searchUndelete',
259 'type' => 'submit',
260 ] ),
261 [
262 'label' => new OOUI\HtmlSnippet(
263 $this->msg(
264 $fuzzySearch ? 'undelete-search-full' : 'undelete-search-prefix'
265 )->parse()
266 ),
267 'align' => 'left',
268 ]
269 );
270
271 $fieldset = new OOUI\FieldsetLayout( [
272 'label' => $this->msg( 'undelete-search-box' )->text(),
273 'items' => $fields,
274 ] );
275
276 $form = new OOUI\FormLayout( [
277 'method' => 'get',
278 'action' => wfScript(),
279 ] );
280
281 $form->appendContent(
282 $fieldset,
283 new OOUI\HtmlSnippet(
284 Html::hidden( 'title', $this->getPageTitle()->getPrefixedDBkey() ) .
285 Html::hidden( 'fuzzy', $fuzzySearch )
286 )
287 );
288
289 $out->addHTML(
290 new OOUI\PanelLayout( [
291 'expanded' => false,
292 'padded' => true,
293 'framed' => true,
294 'content' => $form,
295 ] )
296 );
297
298 # List undeletable articles
299 if ( $this->mSearchPrefix ) {
300 // For now, we enable search engine match only when specifically asked to
301 // by using fuzzy=1 parameter.
302 if ( $fuzzySearch ) {
303 $result = PageArchive::listPagesBySearch( $this->mSearchPrefix );
304 } else {
305 $result = PageArchive::listPagesByPrefix( $this->mSearchPrefix );
306 }
307 $this->showList( $result );
308 }
309 }
310
311 /**
312 * Generic list of deleted pages
313 *
314 * @param IResultWrapper $result
315 * @return bool
316 */
317 private function showList( $result ) {
318 $out = $this->getOutput();
319
320 if ( $result->numRows() == 0 ) {
321 $out->addWikiMsg( 'undelete-no-results' );
322
323 return false;
324 }
325
326 $out->addWikiMsg( 'undeletepagetext', $this->getLanguage()->formatNum( $result->numRows() ) );
327
328 $linkRenderer = $this->getLinkRenderer();
329 $undelete = $this->getPageTitle();
330 $out->addHTML( "<ul id='undeleteResultsList'>\n" );
331 foreach ( $result as $row ) {
332 $title = Title::makeTitleSafe( $row->ar_namespace, $row->ar_title );
333 if ( $title !== null ) {
334 $item = $linkRenderer->makeKnownLink(
335 $undelete,
336 $title->getPrefixedText(),
337 [],
338 [ 'target' => $title->getPrefixedText() ]
339 );
340 } else {
341 // The title is no longer valid, show as text
342 $item = Html::element(
343 'span',
344 [ 'class' => 'mw-invalidtitle' ],
345 Linker::getInvalidTitleDescription(
346 $this->getContext(),
347 $row->ar_namespace,
348 $row->ar_title
349 )
350 );
351 }
352 $revs = $this->msg( 'undeleterevisions' )->numParams( $row->count )->parse();
353 $out->addHTML(
354 Html::rawElement(
355 'li',
356 [ 'class' => 'undeleteResult' ],
357 "{$item} ({$revs})"
358 )
359 );
360 }
361 $result->free();
362 $out->addHTML( "</ul>\n" );
363
364 return true;
365 }
366
367 private function showRevision( $timestamp ) {
368 if ( !preg_match( '/[0-9]{14}/', $timestamp ) ) {
369 return;
370 }
371
372 $archive = new PageArchive( $this->mTargetObj, $this->getConfig() );
373 if ( !Hooks::run( 'UndeleteForm::showRevision', [ &$archive, $this->mTargetObj ] ) ) {
374 return;
375 }
376 $rev = $archive->getRevision( $timestamp );
377
378 $out = $this->getOutput();
379 $user = $this->getUser();
380
381 if ( !$rev ) {
382 $out->addWikiMsg( 'undeleterevision-missing' );
383
384 return;
385 }
386
387 if ( $rev->isDeleted( Revision::DELETED_TEXT ) ) {
388 if ( !$rev->userCan( Revision::DELETED_TEXT, $user ) ) {
389 $out->wrapWikiMsg(
390 "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
391 $rev->isDeleted( Revision::DELETED_RESTRICTED ) ?
392 'rev-suppressed-text-permission' : 'rev-deleted-text-permission'
393 );
394
395 return;
396 }
397
398 $out->wrapWikiMsg(
399 "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
400 $rev->isDeleted( Revision::DELETED_RESTRICTED ) ?
401 'rev-suppressed-text-view' : 'rev-deleted-text-view'
402 );
403 $out->addHTML( '<br />' );
404 // and we are allowed to see...
405 }
406
407 if ( $this->mDiff ) {
408 $previousRev = $archive->getPreviousRevision( $timestamp );
409 if ( $previousRev ) {
410 $this->showDiff( $previousRev, $rev );
411 if ( $this->mDiffOnly ) {
412 return;
413 }
414
415 $out->addHTML( '<hr />' );
416 } else {
417 $out->addWikiMsg( 'undelete-nodiff' );
418 }
419 }
420
421 $link = $this->getLinkRenderer()->makeKnownLink(
422 $this->getPageTitle( $this->mTargetObj->getPrefixedDBkey() ),
423 $this->mTargetObj->getPrefixedText()
424 );
425
426 $lang = $this->getLanguage();
427
428 // date and time are separate parameters to facilitate localisation.
429 // $time is kept for backward compat reasons.
430 $time = $lang->userTimeAndDate( $timestamp, $user );
431 $d = $lang->userDate( $timestamp, $user );
432 $t = $lang->userTime( $timestamp, $user );
433 $userLink = Linker::revUserTools( $rev );
434
435 $content = $rev->getContent( RevisionRecord::FOR_THIS_USER, $user );
436
437 // TODO: MCR: this will have to become something like $hasTextSlots and $hasNonTextSlots
438 $isText = ( $content instanceof TextContent );
439
440 if ( $this->mPreview || $isText ) {
441 $openDiv = '<div id="mw-undelete-revision" class="mw-warning">';
442 } else {
443 $openDiv = '<div id="mw-undelete-revision">';
444 }
445 $out->addHTML( $openDiv );
446
447 // Revision delete links
448 if ( !$this->mDiff ) {
449 $revdel = Linker::getRevDeleteLink( $user, $rev, $this->mTargetObj );
450 if ( $revdel ) {
451 $out->addHTML( "$revdel " );
452 }
453 }
454
455 $out->addWikiMsg(
456 'undelete-revision',
457 Message::rawParam( $link ), $time,
458 Message::rawParam( $userLink ), $d, $t
459 );
460 $out->addHTML( '</div>' );
461
462 if ( !Hooks::run( 'UndeleteShowRevision', [ $this->mTargetObj, $rev ] ) ) {
463 return;
464 }
465
466 if ( $this->mPreview || !$isText ) {
467 // NOTE: non-text content has no source view, so always use rendered preview
468
469 $popts = $out->parserOptions();
470 $renderer = MediaWikiServices::getInstance()->getRevisionRenderer();
471
472 $rendered = $renderer->getRenderedRevision(
473 $rev->getRevisionRecord(),
474 $popts,
475 $user,
476 [ 'audience' => RevisionRecord::FOR_THIS_USER ]
477 );
478
479 // Fail hard if the audience check fails, since we already checked
480 // at the beginning of this method.
481 $pout = $rendered->getRevisionParserOutput();
482
483 $out->addParserOutput( $pout, [
484 'enableSectionEditLinks' => false,
485 ] );
486 }
487
488 $out->enableOOUI();
489 $buttonFields = [];
490
491 if ( $isText ) {
492 // TODO: MCR: make this work for multiple slots
493 // source view for textual content
494 $sourceView = Xml::element( 'textarea', [
495 'readonly' => 'readonly',
496 'cols' => 80,
497 'rows' => 25
498 ], $content->getText() . "\n" );
499
500 $buttonFields[] = new OOUI\ButtonInputWidget( [
501 'type' => 'submit',
502 'name' => 'preview',
503 'label' => $this->msg( 'showpreview' )->text()
504 ] );
505 } else {
506 $sourceView = '';
507 }
508
509 $buttonFields[] = new OOUI\ButtonInputWidget( [
510 'name' => 'diff',
511 'type' => 'submit',
512 'label' => $this->msg( 'showdiff' )->text()
513 ] );
514
515 $out->addHTML(
516 $sourceView .
517 Xml::openElement( 'div', [
518 'style' => 'clear: both' ] ) .
519 Xml::openElement( 'form', [
520 'method' => 'post',
521 'action' => $this->getPageTitle()->getLocalURL( [ 'action' => 'submit' ] ) ] ) .
522 Xml::element( 'input', [
523 'type' => 'hidden',
524 'name' => 'target',
525 'value' => $this->mTargetObj->getPrefixedDBkey() ] ) .
526 Xml::element( 'input', [
527 'type' => 'hidden',
528 'name' => 'timestamp',
529 'value' => $timestamp ] ) .
530 Xml::element( 'input', [
531 'type' => 'hidden',
532 'name' => 'wpEditToken',
533 'value' => $user->getEditToken() ] ) .
534 new OOUI\FieldLayout(
535 new OOUI\Widget( [
536 'content' => new OOUI\HorizontalLayout( [
537 'items' => $buttonFields
538 ] )
539 ] )
540 ) .
541 Xml::closeElement( 'form' ) .
542 Xml::closeElement( 'div' )
543 );
544 }
545
546 /**
547 * Build a diff display between this and the previous either deleted
548 * or non-deleted edit.
549 *
550 * @param Revision $previousRev
551 * @param Revision $currentRev
552 */
553 function showDiff( $previousRev, $currentRev ) {
554 $diffContext = clone $this->getContext();
555 $diffContext->setTitle( $currentRev->getTitle() );
556 $diffContext->setWikiPage( WikiPage::factory( $currentRev->getTitle() ) );
557
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' )
564 );
565
566 $this->getOutput()->addHTML( "<div>$formattedDiff</div>\n" );
567 }
568
569 /**
570 * @param Revision $rev
571 * @param string $prefix
572 * @return string
573 */
574 private function diffHeader( $rev, $prefix ) {
575 $isDeleted = !( $rev->getId() && $rev->getTitle() );
576 if ( $isDeleted ) {
577 /// @todo FIXME: $rev->getTitle() is null for deleted revs...?
578 $targetPage = $this->getPageTitle();
579 $targetQuery = [
580 'target' => $this->mTargetObj->getPrefixedText(),
581 'timestamp' => wfTimestamp( TS_MW, $rev->getTimestamp() )
582 ];
583 } else {
584 /// @todo FIXME: getId() may return non-zero for deleted revs...
585 $targetPage = $rev->getTitle();
586 $targetQuery = [ 'oldid' => $rev->getId() ];
587 }
588
589 // Add show/hide deletion links if available
590 $user = $this->getUser();
591 $lang = $this->getLanguage();
592 $rdel = Linker::getRevDeleteLink( $user, $rev, $this->mTargetObj );
593
594 if ( $rdel ) {
595 $rdel = " $rdel";
596 }
597
598 $minor = $rev->isMinor() ? ChangesList::flag( 'minor' ) : '';
599
600 $tagIds = wfGetDB( DB_REPLICA )->selectFieldValues(
601 'change_tag',
602 'ct_tag_id',
603 [ 'ct_rev_id' => $rev->getId() ],
604 __METHOD__
605 );
606 $tags = [];
607 $changeTagDefStore = MediaWikiServices::getInstance()->getChangeTagDefStore();
608 foreach ( $tagIds as $tagId ) {
609 try {
610 $tags[] = $changeTagDefStore->getName( (int)$tagId );
611 } catch ( NameTableAccessException $exception ) {
612 continue;
613 }
614 }
615 $tags = implode( ',', $tags );
616 $tagSummary = ChangeTags::formatSummaryRow( $tags, 'deleteddiff', $this->getContext() );
617
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(
622 $targetPage,
623 $this->msg(
624 'revisionasof',
625 $lang->userTimeAndDate( $rev->getTimestamp(), $user ),
626 $lang->userDate( $rev->getTimestamp(), $user ),
627 $lang->userTime( $rev->getTimestamp(), $user )
628 )->text(),
629 [],
630 $targetQuery
631 ) .
632 '</strong></div>' .
633 '<div id="mw-diff-' . $prefix . 'title2">' .
634 Linker::revUserTools( $rev ) . '<br />' .
635 '</div>' .
636 '<div id="mw-diff-' . $prefix . 'title3">' .
637 $minor . Linker::revComment( $rev ) . $rdel . '<br />' .
638 '</div>' .
639 '<div id="mw-diff-' . $prefix . 'title5">' .
640 $tagSummary[0] . '<br />' .
641 '</div>';
642 }
643
644 /**
645 * Show a form confirming whether a tokenless user really wants to see a file
646 * @param string $key
647 */
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 ) );
657 $out->addHTML(
658 Xml::openElement( 'form', [
659 'method' => 'POST',
660 'action' => $this->getPageTitle()->getLocalURL( [
661 'target' => $this->mTarget,
662 'file' => $key,
663 'token' => $user->getEditToken( $key ),
664 ] ),
665 ]
666 ) .
667 Xml::submitButton( $this->msg( 'undelete-show-file-submit' )->text() ) .
668 '</form>'
669 );
670 }
671
672 /**
673 * Show a deleted file version requested by the visitor.
674 * @param string $key
675 */
676 private function showFile( $key ) {
677 $this->getOutput()->disable();
678
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' );
687
688 $repo = RepoGroup::singleton()->getLocalRepo();
689 $path = $repo->getZonePath( 'deleted' ) . '/' . $repo->getDeletedHashPath( $key ) . $key;
690 $repo->streamFileWithStatus( $path );
691 }
692
693 protected function showHistory() {
694 $this->checkReadOnly();
695
696 $out = $this->getOutput();
697 if ( $this->mAllowed ) {
698 $out->addModules( 'mediawiki.special.undelete' );
699 }
700 $out->wrapWikiMsg(
701 "<div class='mw-undelete-pagetitle'>\n$1\n</div>\n",
702 [ 'undeletepagetitle', wfEscapeWikiText( $this->mTargetObj->getPrefixedText() ) ]
703 );
704
705 $archive = new PageArchive( $this->mTargetObj, $this->getConfig() );
706 Hooks::run( 'UndeleteForm::showHistory', [ &$archive, $this->mTargetObj ] );
707
708 $out->addHTML( '<div class="mw-undelete-history">' );
709 if ( $this->mAllowed ) {
710 $out->addWikiMsg( 'undeletehistory' );
711 $out->addWikiMsg( 'undeleterevdel' );
712 } else {
713 $out->addWikiMsg( 'undeletehistorynoadmin' );
714 }
715 $out->addHTML( '</div>' );
716
717 # List all stored revisions
718 $revisions = $archive->listRevisions();
719 $files = $archive->listFiles();
720
721 $haveRevisions = $revisions && $revisions->numRows() > 0;
722 $haveFiles = $files && $files->numRows() > 0;
723
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 ) );
730 }
731 $batch->execute();
732 $revisions->seek( 0 );
733 }
734 if ( $haveFiles ) {
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 ) );
739 }
740 $batch->execute();
741 $files->seek( 0 );
742 }
743
744 if ( $this->mAllowed ) {
745 $out->enableOOUI();
746
747 $action = $this->getPageTitle()->getLocalURL( [ 'action' => 'submit' ] );
748 # Start the form here
749 $form = new OOUI\FormLayout( [
750 'method' => 'post',
751 'action' => $action,
752 'id' => 'undelete',
753 ] );
754 }
755
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 );
765 }
766
767 if ( $this->mAllowed && ( $haveRevisions || $haveFiles ) ) {
768 $fields[] = new OOUI\Layout( [
769 'content' => new OOUI\HtmlSnippet( $this->msg( 'undeleteextrahelp' )->parseAsBlock() )
770 ] );
771
772 $fields[] = new OOUI\FieldLayout(
773 new OOUI\TextInputWidget( [
774 'name' => 'wpComment',
775 'inputId' => 'wpComment',
776 'infusable' => true,
777 'value' => $this->mComment,
778 'autofocus' => true,
779 // HTML maxlength uses "UTF-16 code units", which means that characters outside BMP
780 // (e.g. emojis) count for two each. This limit is overridden in JS to instead count
781 // Unicode codepoints.
782 'maxLength' => CommentStore::COMMENT_CHARACTER_LIMIT,
783 ] ),
784 [
785 'label' => $this->msg( 'undeletecomment' )->text(),
786 'align' => 'top',
787 ]
788 );
789
790 $fields[] = new OOUI\FieldLayout(
791 new OOUI\Widget( [
792 'content' => new OOUI\HorizontalLayout( [
793 'items' => [
794 new OOUI\ButtonInputWidget( [
795 'name' => 'restore',
796 'inputId' => 'mw-undelete-submit',
797 'value' => '1',
798 'label' => $this->msg( 'undeletebtn' )->text(),
799 'flags' => [ 'primary', 'progressive' ],
800 'type' => 'submit',
801 ] ),
802 new OOUI\ButtonInputWidget( [
803 'name' => 'invert',
804 'inputId' => 'mw-undelete-invert',
805 'value' => '1',
806 'label' => $this->msg( 'undeleteinvert' )->text()
807 ] ),
808 ]
809 ] )
810 ] )
811 );
812
813 if ( $this->getUser()->isAllowed( 'suppressrevision' ) ) {
814 $fields[] = new OOUI\FieldLayout(
815 new OOUI\CheckboxInputWidget( [
816 'name' => 'wpUnsuppress',
817 'inputId' => 'mw-undelete-unsuppress',
818 'value' => '1',
819 ] ),
820 [
821 'label' => $this->msg( 'revdelete-unsuppress' )->text(),
822 'align' => 'inline',
823 ]
824 );
825 }
826
827 $fieldset = new OOUI\FieldsetLayout( [
828 'label' => $this->msg( 'undelete-fieldset-title' )->text(),
829 'id' => 'mw-undelete-table',
830 'items' => $fields,
831 ] );
832
833 $form->appendContent(
834 new OOUI\PanelLayout( [
835 'expanded' => false,
836 'padded' => true,
837 'framed' => true,
838 'content' => $fieldset,
839 ] ),
840 new OOUI\HtmlSnippet(
841 Html::hidden( 'target', $this->mTarget ) .
842 Html::hidden( 'wpEditToken', $this->getUser()->getEditToken() )
843 )
844 );
845 }
846
847 $history = '';
848 $history .= Xml::element( 'h2', null, $this->msg( 'history' )->text() ) . "\n";
849
850 if ( $haveRevisions ) {
851 # Show the page's stored (deleted) history
852
853 if ( $this->getUser()->isAllowed( 'deleterevision' ) ) {
854 $history .= Html::element(
855 'button',
856 [
857 'name' => 'revdel',
858 'type' => 'submit',
859 'class' => 'deleterevision-log-submit mw-log-deleterevision-button'
860 ],
861 $this->msg( 'showhideselectedversions' )->text()
862 ) . "\n";
863 }
864
865 $history .= '<ul class="mw-undelete-revlist">';
866 $remaining = $revisions->numRows();
867 $earliestLiveTime = $this->mTargetObj->getEarliestRevTime();
868
869 foreach ( $revisions as $row ) {
870 $remaining--;
871 $history .= $this->formatRevisionRow( $row, $earliestLiveTime, $remaining );
872 }
873 $revisions->free();
874 $history .= '</ul>';
875 } else {
876 $out->addWikiMsg( 'nohistory' );
877 }
878
879 if ( $haveFiles ) {
880 $history .= Xml::element( 'h2', null, $this->msg( 'filehist' )->text() ) . "\n";
881 $history .= '<ul class="mw-undelete-revlist">';
882 foreach ( $files as $row ) {
883 $history .= $this->formatFileRow( $row );
884 }
885 $files->free();
886 $history .= '</ul>';
887 }
888
889 if ( $this->mAllowed ) {
890 # Slip in the hidden controls here
891 $misc = Html::hidden( 'target', $this->mTarget );
892 $misc .= Html::hidden( 'wpEditToken', $this->getUser()->getEditToken() );
893 $history .= $misc;
894
895 $form->appendContent( new OOUI\HtmlSnippet( $history ) );
896 $out->addHTML( $form );
897 } else {
898 $out->addHTML( $history );
899 }
900
901 return true;
902 }
903
904 protected function formatRevisionRow( $row, $earliestLiveTime, $remaining ) {
905 $rev = Revision::newFromArchiveRow( $row,
906 [
907 'title' => $this->mTargetObj
908 ] );
909
910 $revTextSize = '';
911 $ts = wfTimestamp( TS_MW, $row->ar_timestamp );
912 // Build checkboxen...
913 if ( $this->mAllowed ) {
914 if ( $this->mInvert ) {
915 if ( in_array( $ts, $this->mTargetTimestamp ) ) {
916 $checkBox = Xml::check( "ts$ts" );
917 } else {
918 $checkBox = Xml::check( "ts$ts", true );
919 }
920 } else {
921 $checkBox = Xml::check( "ts$ts" );
922 }
923 } else {
924 $checkBox = '';
925 }
926
927 // Build page & diff links...
928 $user = $this->getUser();
929 if ( $this->mCanView ) {
930 $titleObj = $this->getPageTitle();
931 # Last link
932 if ( !$rev->userCan( Revision::DELETED_TEXT, $this->getUser() ) ) {
933 $pageLink = htmlspecialchars( $this->getLanguage()->userTimeAndDate( $ts, $user ) );
934 $last = $this->msg( 'diff' )->escaped();
935 } elseif ( $remaining > 0 || ( $earliestLiveTime && $ts > $earliestLiveTime ) ) {
936 $pageLink = $this->getPageLink( $rev, $titleObj, $ts );
937 $last = $this->getLinkRenderer()->makeKnownLink(
938 $titleObj,
939 $this->msg( 'diff' )->text(),
940 [],
941 [
942 'target' => $this->mTargetObj->getPrefixedText(),
943 'timestamp' => $ts,
944 'diff' => 'prev'
945 ]
946 );
947 } else {
948 $pageLink = $this->getPageLink( $rev, $titleObj, $ts );
949 $last = $this->msg( 'diff' )->escaped();
950 }
951 } else {
952 $pageLink = htmlspecialchars( $this->getLanguage()->userTimeAndDate( $ts, $user ) );
953 $last = $this->msg( 'diff' )->escaped();
954 }
955
956 // User links
957 $userLink = Linker::revUserTools( $rev );
958
959 // Minor edit
960 $minor = $rev->isMinor() ? ChangesList::flag( 'minor' ) : '';
961
962 // Revision text size
963 $size = $row->ar_len;
964 if ( !is_null( $size ) ) {
965 $revTextSize = Linker::formatRevisionSize( $size );
966 }
967
968 // Edit summary
969 $comment = Linker::revComment( $rev );
970
971 // Tags
972 $attribs = [];
973 list( $tagSummary, $classes ) = ChangeTags::formatSummaryRow(
974 $row->ts_tags,
975 'deletedhistory',
976 $this->getContext()
977 );
978 if ( $classes ) {
979 $attribs['class'] = implode( ' ', $classes );
980 }
981
982 $revisionRow = $this->msg( 'undelete-revision-row2' )
983 ->rawParams(
984 $checkBox,
985 $last,
986 $pageLink,
987 $userLink,
988 $minor,
989 $revTextSize,
990 $comment,
991 $tagSummary
992 )
993 ->escaped();
994
995 return Xml::tags( 'li', $attribs, $revisionRow ) . "\n";
996 }
997
998 private function formatFileRow( $row ) {
999 $file = ArchivedFile::newFromRow( $row );
1000 $ts = wfTimestamp( TS_MW, $row->fa_timestamp );
1001 $user = $this->getUser();
1002
1003 $checkBox = '';
1004 if ( $this->mCanView && $row->fa_storage_key ) {
1005 if ( $this->mAllowed ) {
1006 $checkBox = Xml::check( 'fileid' . $row->fa_id );
1007 }
1008 $key = urlencode( $row->fa_storage_key );
1009 $pageLink = $this->getFileLink( $file, $this->getPageTitle(), $ts, $key );
1010 } else {
1011 $pageLink = htmlspecialchars( $this->getLanguage()->userTimeAndDate( $ts, $user ) );
1012 }
1013 $userLink = $this->getFileUser( $file );
1014 $data = $this->msg( 'widthheight' )->numParams( $row->fa_width, $row->fa_height )->text();
1015 $bytes = $this->msg( 'parentheses' )
1016 ->plaintextParams( $this->msg( 'nbytes' )->numParams( $row->fa_size )->text() )
1017 ->plain();
1018 $data = htmlspecialchars( $data . ' ' . $bytes );
1019 $comment = $this->getFileComment( $file );
1020
1021 // Add show/hide deletion links if available
1022 $canHide = $this->isAllowed( 'deleterevision' );
1023 if ( $canHide || ( $file->getVisibility() && $this->isAllowed( 'deletedhistory' ) ) ) {
1024 if ( !$file->userCan( File::DELETED_RESTRICTED, $user ) ) {
1025 // Revision was hidden from sysops
1026 $revdlink = Linker::revDeleteLinkDisabled( $canHide );
1027 } else {
1028 $query = [
1029 'type' => 'filearchive',
1030 'target' => $this->mTargetObj->getPrefixedDBkey(),
1031 'ids' => $row->fa_id
1032 ];
1033 $revdlink = Linker::revDeleteLink( $query,
1034 $file->isDeleted( File::DELETED_RESTRICTED ), $canHide );
1035 }
1036 } else {
1037 $revdlink = '';
1038 }
1039
1040 return "<li>$checkBox $revdlink $pageLink . . $userLink $data $comment</li>\n";
1041 }
1042
1043 /**
1044 * Fetch revision text link if it's available to all users
1045 *
1046 * @param Revision $rev
1047 * @param Title $titleObj
1048 * @param string $ts Timestamp
1049 * @return string
1050 */
1051 function getPageLink( $rev, $titleObj, $ts ) {
1052 $user = $this->getUser();
1053 $time = $this->getLanguage()->userTimeAndDate( $ts, $user );
1054
1055 if ( !$rev->userCan( Revision::DELETED_TEXT, $user ) ) {
1056 return '<span class="history-deleted">' . $time . '</span>';
1057 }
1058
1059 $link = $this->getLinkRenderer()->makeKnownLink(
1060 $titleObj,
1061 $time,
1062 [],
1063 [
1064 'target' => $this->mTargetObj->getPrefixedText(),
1065 'timestamp' => $ts
1066 ]
1067 );
1068
1069 if ( $rev->isDeleted( Revision::DELETED_TEXT ) ) {
1070 $link = '<span class="history-deleted">' . $link . '</span>';
1071 }
1072
1073 return $link;
1074 }
1075
1076 /**
1077 * Fetch image view link if it's available to all users
1078 *
1079 * @param File|ArchivedFile $file
1080 * @param Title $titleObj
1081 * @param string $ts A timestamp
1082 * @param string $key A storage key
1083 *
1084 * @return string HTML fragment
1085 */
1086 function getFileLink( $file, $titleObj, $ts, $key ) {
1087 $user = $this->getUser();
1088 $time = $this->getLanguage()->userTimeAndDate( $ts, $user );
1089
1090 if ( !$file->userCan( File::DELETED_FILE, $user ) ) {
1091 return '<span class="history-deleted">' . htmlspecialchars( $time ) . '</span>';
1092 }
1093
1094 $link = $this->getLinkRenderer()->makeKnownLink(
1095 $titleObj,
1096 $time,
1097 [],
1098 [
1099 'target' => $this->mTargetObj->getPrefixedText(),
1100 'file' => $key,
1101 'token' => $user->getEditToken( $key )
1102 ]
1103 );
1104
1105 if ( $file->isDeleted( File::DELETED_FILE ) ) {
1106 $link = '<span class="history-deleted">' . $link . '</span>';
1107 }
1108
1109 return $link;
1110 }
1111
1112 /**
1113 * Fetch file's user id if it's available to this user
1114 *
1115 * @param File|ArchivedFile $file
1116 * @return string HTML fragment
1117 */
1118 function getFileUser( $file ) {
1119 if ( !$file->userCan( File::DELETED_USER, $this->getUser() ) ) {
1120 return '<span class="history-deleted">' .
1121 $this->msg( 'rev-deleted-user' )->escaped() .
1122 '</span>';
1123 }
1124
1125 $link = Linker::userLink( $file->getRawUser(), $file->getRawUserText() ) .
1126 Linker::userToolLinks( $file->getRawUser(), $file->getRawUserText() );
1127
1128 if ( $file->isDeleted( File::DELETED_USER ) ) {
1129 $link = '<span class="history-deleted">' . $link . '</span>';
1130 }
1131
1132 return $link;
1133 }
1134
1135 /**
1136 * Fetch file upload comment if it's available to this user
1137 *
1138 * @param File|ArchivedFile $file
1139 * @return string HTML fragment
1140 */
1141 function getFileComment( $file ) {
1142 if ( !$file->userCan( File::DELETED_COMMENT, $this->getUser() ) ) {
1143 return '<span class="history-deleted"><span class="comment">' .
1144 $this->msg( 'rev-deleted-comment' )->escaped() . '</span></span>';
1145 }
1146
1147 $link = Linker::commentBlock( $file->getRawDescription() );
1148
1149 if ( $file->isDeleted( File::DELETED_COMMENT ) ) {
1150 $link = '<span class="history-deleted">' . $link . '</span>';
1151 }
1152
1153 return $link;
1154 }
1155
1156 function undelete() {
1157 if ( $this->getConfig()->get( 'UploadMaintenance' )
1158 && $this->mTargetObj->getNamespace() == NS_FILE
1159 ) {
1160 throw new ErrorPageError( 'undelete-error', 'filedelete-maintenance' );
1161 }
1162
1163 $this->checkReadOnly();
1164
1165 $out = $this->getOutput();
1166 $archive = new PageArchive( $this->mTargetObj, $this->getConfig() );
1167 Hooks::run( 'UndeleteForm::undelete', [ &$archive, $this->mTargetObj ] );
1168 $ok = $archive->undelete(
1169 $this->mTargetTimestamp,
1170 $this->mComment,
1171 $this->mFileVersions,
1172 $this->mUnsuppress,
1173 $this->getUser()
1174 );
1175
1176 if ( is_array( $ok ) ) {
1177 if ( $ok[1] ) { // Undeleted file count
1178 Hooks::run( 'FileUndeleteComplete', [
1179 $this->mTargetObj, $this->mFileVersions,
1180 $this->getUser(), $this->mComment ] );
1181 }
1182
1183 $link = $this->getLinkRenderer()->makeKnownLink( $this->mTargetObj );
1184 $out->addWikiMsg( 'undeletedpage', Message::rawParam( $link ) );
1185 } else {
1186 $out->setPageTitle( $this->msg( 'undelete-error' ) );
1187 }
1188
1189 // Show revision undeletion warnings and errors
1190 $status = $archive->getRevisionStatus();
1191 if ( $status && !$status->isGood() ) {
1192 $out->wrapWikiTextAsInterface(
1193 'error',
1194 '<div id="mw-error-cannotundelete">' .
1195 $status->getWikiText(
1196 'cannotundelete',
1197 'cannotundelete'
1198 ) . '</div>'
1199 );
1200 }
1201
1202 // Show file undeletion warnings and errors
1203 $status = $archive->getFileStatus();
1204 if ( $status && !$status->isGood() ) {
1205 $out->wrapWikiTextAsInterface(
1206 'error',
1207 $status->getWikiText(
1208 'undelete-error-short',
1209 'undelete-error-long'
1210 )
1211 );
1212 }
1213 }
1214
1215 /**
1216 * Return an array of subpages beginning with $search that this special page will accept.
1217 *
1218 * @param string $search Prefix to search for
1219 * @param int $limit Maximum number of results to return (usually 10)
1220 * @param int $offset Number of results to skip (usually 0)
1221 * @return string[] Matching subpages
1222 */
1223 public function prefixSearchSubpages( $search, $limit, $offset ) {
1224 return $this->prefixSearchString( $search, $limit, $offset );
1225 }
1226
1227 protected function getGroupName() {
1228 return 'pagetools';
1229 }
1230 }