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