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