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\IResultWrapper;
  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|null $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 IResultWrapper $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                         $popts = $out->parserOptions();
 454
 455                         $pout = $content->getParserOutput( $this->mTargetObj, $rev->getId(), $popts, true );
 456                         $out->addParserOutput( $pout, [
 457                                 'enableSectionEditLinks' => false,
 458                         ] );
 459                 }
 460
 461                 $out->enableOOUI();
 462                 $buttonFields = [];
 463
 464                 if ( $isText ) {
 465                         // source view for textual content
 466                         $sourceView = Xml::element( 'textarea', [
 467                                 'readonly' => 'readonly',
 468                                 'cols' => 80,
 469                                 'rows' => 25
 470                         ], $content->getNativeData() . "\n" );
 471
 472                         $buttonFields[] = new OOUI\ButtonInputWidget( [
 473                                 'type' => 'submit',
 474                                 'name' => 'preview',
 475                                 'label' => $this->msg( 'showpreview' )->text()
 476                         ] );
 477                 } else {
 478                         $sourceView = '';
 479                         $previewButton = '';
 480                 }
 481
 482                 $buttonFields[] = new OOUI\ButtonInputWidget( [
 483                         'name' => 'diff',
 484                         'type' => 'submit',
 485                         'label' => $this->msg( 'showdiff' )->text()
 486                 ] );
 487
 488                 $out->addHTML(
 489                         $sourceView .
 490                                 Xml::openElement( 'div', [
 491                                         'style' => 'clear: both' ] ) .
 492                                 Xml::openElement( 'form', [
 493                                         'method' => 'post',
 494                                         'action' => $this->getPageTitle()->getLocalURL( [ 'action' => 'submit' ] ) ] ) .
 495                                 Xml::element( 'input', [
 496                                         'type' => 'hidden',
 497                                         'name' => 'target',
 498                                         'value' => $this->mTargetObj->getPrefixedDBkey() ] ) .
 499                                 Xml::element( 'input', [
 500                                         'type' => 'hidden',
 501                                         'name' => 'timestamp',
 502                                         'value' => $timestamp ] ) .
 503                                 Xml::element( 'input', [
 504                                         'type' => 'hidden',
 505                                         'name' => 'wpEditToken',
 506                                         'value' => $user->getEditToken() ] ) .
 507                                 new OOUI\FieldLayout(
 508                                         new OOUI\Widget( [
 509                                                 'content' => new OOUI\HorizontalLayout( [
 510                                                         'items' => $buttonFields
 511                                                 ] )
 512                                         ] )
 513                                 ) .
 514                                 Xml::closeElement( 'form' ) .
 515                                 Xml::closeElement( 'div' )
 516                 );
 517         }
 518
 519         /**
 520          * Build a diff display between this and the previous either deleted
 521          * or non-deleted edit.
 522          *
 523          * @param Revision $previousRev
 524          * @param Revision $currentRev
 525          * @return string HTML
 526          */
 527         function showDiff( $previousRev, $currentRev ) {
 528                 $diffContext = clone $this->getContext();
 529                 $diffContext->setTitle( $currentRev->getTitle() );
 530                 $diffContext->setWikiPage( WikiPage::factory( $currentRev->getTitle() ) );
 531
 532                 $diffEngine = $currentRev->getContentHandler()->createDifferenceEngine( $diffContext );
 533                 $diffEngine->showDiffStyle();
 534
 535                 $formattedDiff = $diffEngine->generateContentDiffBody(
 536                         $previousRev->getContent( Revision::FOR_THIS_USER, $this->getUser() ),
 537                         $currentRev->getContent( Revision::FOR_THIS_USER, $this->getUser() )
 538                 );
 539
 540                 $formattedDiff = $diffEngine->addHeader(
 541                         $formattedDiff,
 542                         $this->diffHeader( $previousRev, 'o' ),
 543                         $this->diffHeader( $currentRev, 'n' )
 544                 );
 545
 546                 $this->getOutput()->addHTML( "<div>$formattedDiff</div>\n" );
 547         }
 548
 549         /**
 550          * @param Revision $rev
 551          * @param string $prefix
 552          * @return string
 553          */
 554         private function diffHeader( $rev, $prefix ) {
 555                 $isDeleted = !( $rev->getId() && $rev->getTitle() );
 556                 if ( $isDeleted ) {
 557                         /// @todo FIXME: $rev->getTitle() is null for deleted revs...?
 558                         $targetPage = $this->getPageTitle();
 559                         $targetQuery = [
 560                                 'target' => $this->mTargetObj->getPrefixedText(),
 561                                 'timestamp' => wfTimestamp( TS_MW, $rev->getTimestamp() )
 562                         ];
 563                 } else {
 564                         /// @todo FIXME: getId() may return non-zero for deleted revs...
 565                         $targetPage = $rev->getTitle();
 566                         $targetQuery = [ 'oldid' => $rev->getId() ];
 567                 }
 568
 569                 // Add show/hide deletion links if available
 570                 $user = $this->getUser();
 571                 $lang = $this->getLanguage();
 572                 $rdel = Linker::getRevDeleteLink( $user, $rev, $this->mTargetObj );
 573
 574                 if ( $rdel ) {
 575                         $rdel = " $rdel";
 576                 }
 577
 578                 $minor = $rev->isMinor() ? ChangesList::flag( 'minor' ) : '';
 579
 580                 $tags = wfGetDB( DB_REPLICA )->selectField(
 581                         'tag_summary',
 582                         'ts_tags',
 583                         [ 'ts_rev_id' => $rev->getId() ],
 584                         __METHOD__
 585                 );
 586                 $tagSummary = ChangeTags::formatSummaryRow( $tags, 'deleteddiff', $this->getContext() );
 587
 588                 // FIXME This is reimplementing DifferenceEngine#getRevisionHeader
 589                 // and partially #showDiffPage, but worse
 590                 return '<div id="mw-diff-' . $prefix . 'title1"><strong>' .
 591                         $this->getLinkRenderer()->makeLink(
 592                                 $targetPage,
 593                                 $this->msg(
 594                                         'revisionasof',
 595                                         $lang->userTimeAndDate( $rev->getTimestamp(), $user ),
 596                                         $lang->userDate( $rev->getTimestamp(), $user ),
 597                                         $lang->userTime( $rev->getTimestamp(), $user )
 598                                 )->text(),
 599                                 [],
 600                                 $targetQuery
 601                         ) .
 602                         '</strong></div>' .
 603                         '<div id="mw-diff-' . $prefix . 'title2">' .
 604                         Linker::revUserTools( $rev ) . '<br />' .
 605                         '</div>' .
 606                         '<div id="mw-diff-' . $prefix . 'title3">' .
 607                         $minor . Linker::revComment( $rev ) . $rdel . '<br />' .
 608                         '</div>' .
 609                         '<div id="mw-diff-' . $prefix . 'title5">' .
 610                         $tagSummary[0] . '<br />' .
 611                         '</div>';
 612         }
 613
 614         /**
 615          * Show a form confirming whether a tokenless user really wants to see a file
 616          * @param string $key
 617          */
 618         private function showFileConfirmationForm( $key ) {
 619                 $out = $this->getOutput();
 620                 $lang = $this->getLanguage();
 621                 $user = $this->getUser();
 622                 $file = new ArchivedFile( $this->mTargetObj, '', $this->mFilename );
 623                 $out->addWikiMsg( 'undelete-show-file-confirm',
 624                         $this->mTargetObj->getText(),
 625                         $lang->userDate( $file->getTimestamp(), $user ),
 626                         $lang->userTime( $file->getTimestamp(), $user ) );
 627                 $out->addHTML(
 628                         Xml::openElement( 'form', [
 629                                         'method' => 'POST',
 630                                         'action' => $this->getPageTitle()->getLocalURL( [
 631                                                 'target' => $this->mTarget,
 632                                                 'file' => $key,
 633                                                 'token' => $user->getEditToken( $key ),
 634                                         ] ),
 635                                 ]
 636                         ) .
 637                                 Xml::submitButton( $this->msg( 'undelete-show-file-submit' )->text() ) .
 638                                 '</form>'
 639                 );
 640         }
 641
 642         /**
 643          * Show a deleted file version requested by the visitor.
 644          * @param string $key
 645          */
 646         private function showFile( $key ) {
 647                 $this->getOutput()->disable();
 648
 649                 # We mustn't allow the output to be CDN cached, otherwise
 650                 # if an admin previews a deleted image, and it's cached, then
 651                 # a user without appropriate permissions can toddle off and
 652                 # nab the image, and CDN will serve it
 653                 $response = $this->getRequest()->response();
 654                 $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
 655                 $response->header( 'Cache-Control: no-cache, no-store, max-age=0, must-revalidate' );
 656                 $response->header( 'Pragma: no-cache' );
 657
 658                 $repo = RepoGroup::singleton()->getLocalRepo();
 659                 $path = $repo->getZonePath( 'deleted' ) . '/' . $repo->getDeletedHashPath( $key ) . $key;
 660                 $repo->streamFile( $path );
 661         }
 662
 663         protected function showHistory() {
 664                 $this->checkReadOnly();
 665
 666                 $out = $this->getOutput();
 667                 if ( $this->mAllowed ) {
 668                         $out->addModules( 'mediawiki.special.undelete' );
 669                 }
 670                 $out->wrapWikiMsg(
 671                         "<div class='mw-undelete-pagetitle'>\n$1\n</div>\n",
 672                         [ 'undeletepagetitle', wfEscapeWikiText( $this->mTargetObj->getPrefixedText() ) ]
 673                 );
 674
 675                 $archive = new PageArchive( $this->mTargetObj, $this->getConfig() );
 676                 Hooks::run( 'UndeleteForm::showHistory', [ &$archive, $this->mTargetObj ] );
 677
 678                 $out->addHTML( '<div class="mw-undelete-history">' );
 679                 if ( $this->mAllowed ) {
 680                         $out->addWikiMsg( 'undeletehistory' );
 681                         $out->addWikiMsg( 'undeleterevdel' );
 682                 } else {
 683                         $out->addWikiMsg( 'undeletehistorynoadmin' );
 684                 }
 685                 $out->addHTML( '</div>' );
 686
 687                 # List all stored revisions
 688                 $revisions = $archive->listRevisions();
 689                 $files = $archive->listFiles();
 690
 691                 $haveRevisions = $revisions && $revisions->numRows() > 0;
 692                 $haveFiles = $files && $files->numRows() > 0;
 693
 694                 # Batch existence check on user and talk pages
 695                 if ( $haveRevisions ) {
 696                         $batch = new LinkBatch();
 697                         foreach ( $revisions as $row ) {
 698                                 $batch->addObj( Title::makeTitleSafe( NS_USER, $row->ar_user_text ) );
 699                                 $batch->addObj( Title::makeTitleSafe( NS_USER_TALK, $row->ar_user_text ) );
 700                         }
 701                         $batch->execute();
 702                         $revisions->seek( 0 );
 703                 }
 704                 if ( $haveFiles ) {
 705                         $batch = new LinkBatch();
 706                         foreach ( $files as $row ) {
 707                                 $batch->addObj( Title::makeTitleSafe( NS_USER, $row->fa_user_text ) );
 708                                 $batch->addObj( Title::makeTitleSafe( NS_USER_TALK, $row->fa_user_text ) );
 709                         }
 710                         $batch->execute();
 711                         $files->seek( 0 );
 712                 }
 713
 714                 if ( $this->mAllowed ) {
 715                         $out->enableOOUI();
 716
 717                         $action = $this->getPageTitle()->getLocalURL( [ 'action' => 'submit' ] );
 718                         # Start the form here
 719                         $form = new OOUI\FormLayout( [
 720                                 'method' => 'post',
 721                                 'action' => $action,
 722                                 'id' => 'undelete',
 723                         ] );
 724                 }
 725
 726                 # Show relevant lines from the deletion log:
 727                 $deleteLogPage = new LogPage( 'delete' );
 728                 $out->addHTML( Xml::element( 'h2', null, $deleteLogPage->getName()->text() ) . "\n" );
 729                 LogEventsList::showLogExtract( $out, 'delete', $this->mTargetObj );
 730                 # Show relevant lines from the suppression log:
 731                 $suppressLogPage = new LogPage( 'suppress' );
 732                 if ( $this->getUser()->isAllowed( 'suppressionlog' ) ) {
 733                         $out->addHTML( Xml::element( 'h2', null, $suppressLogPage->getName()->text() ) . "\n" );
 734                         LogEventsList::showLogExtract( $out, 'suppress', $this->mTargetObj );
 735                 }
 736
 737                 if ( $this->mAllowed && ( $haveRevisions || $haveFiles ) ) {
 738                         $fields[] = new OOUI\Layout( [
 739                                 'content' => new OOUI\HtmlSnippet( $this->msg( 'undeleteextrahelp' )->parseAsBlock() )
 740                         ] );
 741
 742                         $conf = $this->getConfig();
 743                         $oldCommentSchema = $conf->get( 'CommentTableSchemaMigrationStage' ) === MIGRATION_OLD;
 744
 745                         $fields[] = new OOUI\FieldLayout(
 746                                 new OOUI\TextInputWidget( [
 747                                         'name' => 'wpComment',
 748                                         'inputId' => 'wpComment',
 749                                         'infusable' => true,
 750                                         'value' => $this->mComment,
 751                                         'autofocus' => true,
 752                                         // HTML maxlength uses "UTF-16 code units", which means that characters outside BMP
 753                                         // (e.g. emojis) count for two each. This limit is overridden in JS to instead count
 754                                         // Unicode codepoints (or 255 UTF-8 bytes for old schema).
 755                                         'maxLength' => $oldCommentSchema ? 255 : CommentStore::COMMENT_CHARACTER_LIMIT,
 756                                 ] ),
 757                                 [
 758                                         'label' => $this->msg( 'undeletecomment' )->text(),
 759                                         'align' => 'top',
 760                                 ]
 761                         );
 762
 763                         $fields[] = new OOUI\FieldLayout(
 764                                 new OOUI\Widget( [
 765                                         'content' => new OOUI\HorizontalLayout( [
 766                                                 'items' => [
 767                                                         new OOUI\ButtonInputWidget( [
 768                                                                 'name' => 'restore',
 769                                                                 'inputId' => 'mw-undelete-submit',
 770                                                                 'value' => '1',
 771                                                                 'label' => $this->msg( 'undeletebtn' )->text(),
 772                                                                 'flags' => [ 'primary', 'progressive' ],
 773                                                                 'type' => 'submit',
 774                                                         ] ),
 775                                                         new OOUI\ButtonInputWidget( [
 776                                                                 'name' => 'invert',
 777                                                                 'inputId' => 'mw-undelete-invert',
 778                                                                 'value' => '1',
 779                                                                 'label' => $this->msg( 'undeleteinvert' )->text()
 780                                                         ] ),
 781                                                 ]
 782                                         ] )
 783                                 ] )
 784                         );
 785
 786                         if ( $this->getUser()->isAllowed( 'suppressrevision' ) ) {
 787                                 $fields[] = new OOUI\FieldLayout(
 788                                         new OOUI\CheckboxInputWidget( [
 789                                                 'name' => 'wpUnsuppress',
 790                                                 'inputId' => 'mw-undelete-unsuppress',
 791                                                 'value' => '1',
 792                                         ] ),
 793                                         [
 794                                                 'label' => $this->msg( 'revdelete-unsuppress' )->text(),
 795                                                 'align' => 'inline',
 796                                         ]
 797                                 );
 798                         }
 799
 800                         $fieldset = new OOUI\FieldsetLayout( [
 801                                 'label' => $this->msg( 'undelete-fieldset-title' )->text(),
 802                                 'id' => 'mw-undelete-table',
 803                                 'items' => $fields,
 804                         ] );
 805
 806                         $form->appendContent(
 807                                 new OOUI\PanelLayout( [
 808                                         'expanded' => false,
 809                                         'padded' => true,
 810                                         'framed' => true,
 811                                         'content' => $fieldset,
 812                                 ] ),
 813                                 new OOUI\HtmlSnippet(
 814                                         Html::hidden( 'target', $this->mTarget ) .
 815                                         Html::hidden( 'wpEditToken', $this->getUser()->getEditToken() )
 816                                 )
 817                         );
 818                 }
 819
 820                 $history = '';
 821                 $history .= Xml::element( 'h2', null, $this->msg( 'history' )->text() ) . "\n";
 822
 823                 if ( $haveRevisions ) {
 824                         # Show the page's stored (deleted) history
 825
 826                         if ( $this->getUser()->isAllowed( 'deleterevision' ) ) {
 827                                 $history .= Html::element(
 828                                         'button',
 829                                         [
 830                                                 'name' => 'revdel',
 831                                                 'type' => 'submit',
 832                                                 'class' => 'deleterevision-log-submit mw-log-deleterevision-button'
 833                                         ],
 834                                         $this->msg( 'showhideselectedversions' )->text()
 835                                 ) . "\n";
 836                         }
 837
 838                         $history .= '<ul class="mw-undelete-revlist">';
 839                         $remaining = $revisions->numRows();
 840                         $earliestLiveTime = $this->mTargetObj->getEarliestRevTime();
 841
 842                         foreach ( $revisions as $row ) {
 843                                 $remaining--;
 844                                 $history .= $this->formatRevisionRow( $row, $earliestLiveTime, $remaining );
 845                         }
 846                         $revisions->free();
 847                         $history .= '</ul>';
 848                 } else {
 849                         $out->addWikiMsg( 'nohistory' );
 850                 }
 851
 852                 if ( $haveFiles ) {
 853                         $history .= Xml::element( 'h2', null, $this->msg( 'filehist' )->text() ) . "\n";
 854                         $history .= '<ul class="mw-undelete-revlist">';
 855                         foreach ( $files as $row ) {
 856                                 $history .= $this->formatFileRow( $row );
 857                         }
 858                         $files->free();
 859                         $history .= '</ul>';
 860                 }
 861
 862                 if ( $this->mAllowed ) {
 863                         # Slip in the hidden controls here
 864                         $misc = Html::hidden( 'target', $this->mTarget );
 865                         $misc .= Html::hidden( 'wpEditToken', $this->getUser()->getEditToken() );
 866                         $history .= $misc;
 867
 868                         $form->appendContent( new OOUI\HtmlSnippet( $history ) );
 869                         $out->addHTML( $form );
 870                 } else {
 871                         $out->addHTML( $history );
 872                 }
 873
 874                 return true;
 875         }
 876
 877         protected function formatRevisionRow( $row, $earliestLiveTime, $remaining ) {
 878                 $rev = Revision::newFromArchiveRow( $row,
 879                         [
 880                                 'title' => $this->mTargetObj
 881                         ] );
 882
 883                 $revTextSize = '';
 884                 $ts = wfTimestamp( TS_MW, $row->ar_timestamp );
 885                 // Build checkboxen...
 886                 if ( $this->mAllowed ) {
 887                         if ( $this->mInvert ) {
 888                                 if ( in_array( $ts, $this->mTargetTimestamp ) ) {
 889                                         $checkBox = Xml::check( "ts$ts" );
 890                                 } else {
 891                                         $checkBox = Xml::check( "ts$ts", true );
 892                                 }
 893                         } else {
 894                                 $checkBox = Xml::check( "ts$ts" );
 895                         }
 896                 } else {
 897                         $checkBox = '';
 898                 }
 899
 900                 // Build page & diff links...
 901                 $user = $this->getUser();
 902                 if ( $this->mCanView ) {
 903                         $titleObj = $this->getPageTitle();
 904                         # Last link
 905                         if ( !$rev->userCan( Revision::DELETED_TEXT, $this->getUser() ) ) {
 906                                 $pageLink = htmlspecialchars( $this->getLanguage()->userTimeAndDate( $ts, $user ) );
 907                                 $last = $this->msg( 'diff' )->escaped();
 908                         } elseif ( $remaining > 0 || ( $earliestLiveTime && $ts > $earliestLiveTime ) ) {
 909                                 $pageLink = $this->getPageLink( $rev, $titleObj, $ts );
 910                                 $last = $this->getLinkRenderer()->makeKnownLink(
 911                                         $titleObj,
 912                                         $this->msg( 'diff' )->text(),
 913                                         [],
 914                                         [
 915                                                 'target' => $this->mTargetObj->getPrefixedText(),
 916                                                 'timestamp' => $ts,
 917                                                 'diff' => 'prev'
 918                                         ]
 919                                 );
 920                         } else {
 921                                 $pageLink = $this->getPageLink( $rev, $titleObj, $ts );
 922                                 $last = $this->msg( 'diff' )->escaped();
 923                         }
 924                 } else {
 925                         $pageLink = htmlspecialchars( $this->getLanguage()->userTimeAndDate( $ts, $user ) );
 926                         $last = $this->msg( 'diff' )->escaped();
 927                 }
 928
 929                 // User links
 930                 $userLink = Linker::revUserTools( $rev );
 931
 932                 // Minor edit
 933                 $minor = $rev->isMinor() ? ChangesList::flag( 'minor' ) : '';
 934
 935                 // Revision text size
 936                 $size = $row->ar_len;
 937                 if ( !is_null( $size ) ) {
 938                         $revTextSize = Linker::formatRevisionSize( $size );
 939                 }
 940
 941                 // Edit summary
 942                 $comment = Linker::revComment( $rev );
 943
 944                 // Tags
 945                 $attribs = [];
 946                 list( $tagSummary, $classes ) = ChangeTags::formatSummaryRow(
 947                         $row->ts_tags,
 948                         'deletedhistory',
 949                         $this->getContext()
 950                 );
 951                 if ( $classes ) {
 952                         $attribs['class'] = implode( ' ', $classes );
 953                 }
 954
 955                 $revisionRow = $this->msg( 'undelete-revision-row2' )
 956                         ->rawParams(
 957                                 $checkBox,
 958                                 $last,
 959                                 $pageLink,
 960                                 $userLink,
 961                                 $minor,
 962                                 $revTextSize,
 963                                 $comment,
 964                                 $tagSummary
 965                         )
 966                         ->escaped();
 967
 968                 return Xml::tags( 'li', $attribs, $revisionRow ) . "\n";
 969         }
 970
 971         private function formatFileRow( $row ) {
 972                 $file = ArchivedFile::newFromRow( $row );
 973                 $ts = wfTimestamp( TS_MW, $row->fa_timestamp );
 974                 $user = $this->getUser();
 975
 976                 $checkBox = '';
 977                 if ( $this->mCanView && $row->fa_storage_key ) {
 978                         if ( $this->mAllowed ) {
 979                                 $checkBox = Xml::check( 'fileid' . $row->fa_id );
 980                         }
 981                         $key = urlencode( $row->fa_storage_key );
 982                         $pageLink = $this->getFileLink( $file, $this->getPageTitle(), $ts, $key );
 983                 } else {
 984                         $pageLink = htmlspecialchars( $this->getLanguage()->userTimeAndDate( $ts, $user ) );
 985                 }
 986                 $userLink = $this->getFileUser( $file );
 987                 $data = $this->msg( 'widthheight' )->numParams( $row->fa_width, $row->fa_height )->text();
 988                 $bytes = $this->msg( 'parentheses' )
 989                         ->plaintextParams( $this->msg( 'nbytes' )->numParams( $row->fa_size )->text() )
 990                         ->plain();
 991                 $data = htmlspecialchars( $data . ' ' . $bytes );
 992                 $comment = $this->getFileComment( $file );
 993
 994                 // Add show/hide deletion links if available
 995                 $canHide = $this->isAllowed( 'deleterevision' );
 996                 if ( $canHide || ( $file->getVisibility() && $this->isAllowed( 'deletedhistory' ) ) ) {
 997                         if ( !$file->userCan( File::DELETED_RESTRICTED, $user ) ) {
 998                                 // Revision was hidden from sysops
 999                                 $revdlink = Linker::revDeleteLinkDisabled( $canHide );
1000                         } else {
1001                                 $query = [
1002                                         'type' => 'filearchive',
1003                                         'target' => $this->mTargetObj->getPrefixedDBkey(),
1004                                         'ids' => $row->fa_id
1005                                 ];
1006                                 $revdlink = Linker::revDeleteLink( $query,
1007                                         $file->isDeleted( File::DELETED_RESTRICTED ), $canHide );
1008                         }
1009                 } else {
1010                         $revdlink = '';
1011                 }
1012
1013                 return "<li>$checkBox $revdlink $pageLink . . $userLink $data $comment</li>\n";
1014         }
1015
1016         /**
1017          * Fetch revision text link if it's available to all users
1018          *
1019          * @param Revision $rev
1020          * @param Title $titleObj
1021          * @param string $ts Timestamp
1022          * @return string
1023          */
1024         function getPageLink( $rev, $titleObj, $ts ) {
1025                 $user = $this->getUser();
1026                 $time = $this->getLanguage()->userTimeAndDate( $ts, $user );
1027
1028                 if ( !$rev->userCan( Revision::DELETED_TEXT, $user ) ) {
1029                         return '<span class="history-deleted">' . $time . '</span>';
1030                 }
1031
1032                 $link = $this->getLinkRenderer()->makeKnownLink(
1033                         $titleObj,
1034                         $time,
1035                         [],
1036                         [
1037                                 'target' => $this->mTargetObj->getPrefixedText(),
1038                                 'timestamp' => $ts
1039                         ]
1040                 );
1041
1042                 if ( $rev->isDeleted( Revision::DELETED_TEXT ) ) {
1043                         $link = '<span class="history-deleted">' . $link . '</span>';
1044                 }
1045
1046                 return $link;
1047         }
1048
1049         /**
1050          * Fetch image view link if it's available to all users
1051          *
1052          * @param File|ArchivedFile $file
1053          * @param Title $titleObj
1054          * @param string $ts A timestamp
1055          * @param string $key A storage key
1056          *
1057          * @return string HTML fragment
1058          */
1059         function getFileLink( $file, $titleObj, $ts, $key ) {
1060                 $user = $this->getUser();
1061                 $time = $this->getLanguage()->userTimeAndDate( $ts, $user );
1062
1063                 if ( !$file->userCan( File::DELETED_FILE, $user ) ) {
1064                         return '<span class="history-deleted">' . htmlspecialchars( $time ) . '</span>';
1065                 }
1066
1067                 $link = $this->getLinkRenderer()->makeKnownLink(
1068                         $titleObj,
1069                         $time,
1070                         [],
1071                         [
1072                                 'target' => $this->mTargetObj->getPrefixedText(),
1073                                 'file' => $key,
1074                                 'token' => $user->getEditToken( $key )
1075                         ]
1076                 );
1077
1078                 if ( $file->isDeleted( File::DELETED_FILE ) ) {
1079                         $link = '<span class="history-deleted">' . $link . '</span>';
1080                 }
1081
1082                 return $link;
1083         }
1084
1085         /**
1086          * Fetch file's user id if it's available to this user
1087          *
1088          * @param File|ArchivedFile $file
1089          * @return string HTML fragment
1090          */
1091         function getFileUser( $file ) {
1092                 if ( !$file->userCan( File::DELETED_USER, $this->getUser() ) ) {
1093                         return '<span class="history-deleted">' .
1094                                 $this->msg( 'rev-deleted-user' )->escaped() .
1095                                 '</span>';
1096                 }
1097
1098                 $link = Linker::userLink( $file->getRawUser(), $file->getRawUserText() ) .
1099                         Linker::userToolLinks( $file->getRawUser(), $file->getRawUserText() );
1100
1101                 if ( $file->isDeleted( File::DELETED_USER ) ) {
1102                         $link = '<span class="history-deleted">' . $link . '</span>';
1103                 }
1104
1105                 return $link;
1106         }
1107
1108         /**
1109          * Fetch file upload comment if it's available to this user
1110          *
1111          * @param File|ArchivedFile $file
1112          * @return string HTML fragment
1113          */
1114         function getFileComment( $file ) {
1115                 if ( !$file->userCan( File::DELETED_COMMENT, $this->getUser() ) ) {
1116                         return '<span class="history-deleted"><span class="comment">' .
1117                                 $this->msg( 'rev-deleted-comment' )->escaped() . '</span></span>';
1118                 }
1119
1120                 $link = Linker::commentBlock( $file->getRawDescription() );
1121
1122                 if ( $file->isDeleted( File::DELETED_COMMENT ) ) {
1123                         $link = '<span class="history-deleted">' . $link . '</span>';
1124                 }
1125
1126                 return $link;
1127         }
1128
1129         function undelete() {
1130                 if ( $this->getConfig()->get( 'UploadMaintenance' )
1131                         && $this->mTargetObj->getNamespace() == NS_FILE
1132                 ) {
1133                         throw new ErrorPageError( 'undelete-error', 'filedelete-maintenance' );
1134                 }
1135
1136                 $this->checkReadOnly();
1137
1138                 $out = $this->getOutput();
1139                 $archive = new PageArchive( $this->mTargetObj, $this->getConfig() );
1140                 Hooks::run( 'UndeleteForm::undelete', [ &$archive, $this->mTargetObj ] );
1141                 $ok = $archive->undelete(
1142                         $this->mTargetTimestamp,
1143                         $this->mComment,
1144                         $this->mFileVersions,
1145                         $this->mUnsuppress,
1146                         $this->getUser()
1147                 );
1148
1149                 if ( is_array( $ok ) ) {
1150                         if ( $ok[1] ) { // Undeleted file count
1151                                 Hooks::run( 'FileUndeleteComplete', [
1152                                         $this->mTargetObj, $this->mFileVersions,
1153                                         $this->getUser(), $this->mComment ] );
1154                         }
1155
1156                         $link = $this->getLinkRenderer()->makeKnownLink( $this->mTargetObj );
1157                         $out->addHTML( $this->msg( 'undeletedpage' )->rawParams( $link )->parse() );
1158                 } else {
1159                         $out->setPageTitle( $this->msg( 'undelete-error' ) );
1160                 }
1161
1162                 // Show revision undeletion warnings and errors
1163                 $status = $archive->getRevisionStatus();
1164                 if ( $status && !$status->isGood() ) {
1165                         $out->addWikiText( '<div class="error" id="mw-error-cannotundelete">' .
1166                                 $status->getWikiText(
1167                                         'cannotundelete',
1168                                         'cannotundelete'
1169                                 ) . '</div>'
1170                         );
1171                 }
1172
1173                 // Show file undeletion warnings and errors
1174                 $status = $archive->getFileStatus();
1175                 if ( $status && !$status->isGood() ) {
1176                         $out->addWikiText( '<div class="error">' .
1177                                 $status->getWikiText(
1178                                         'undelete-error-short',
1179                                         'undelete-error-long'
1180                                 ) . '</div>'
1181                         );
1182                 }
1183         }
1184
1185         /**
1186          * Return an array of subpages beginning with $search that this special page will accept.
1187          *
1188          * @param string $search Prefix to search for
1189          * @param int $limit Maximum number of results to return (usually 10)
1190          * @param int $offset Number of results to skip (usually 0)
1191          * @return string[] Matching subpages
1192          */
1193         public function prefixSearchSubpages( $search, $limit, $offset ) {
1194                 return $this->prefixSearchString( $search, $limit, $offset );
1195         }
1196
1197         protected function getGroupName() {
1198                 return 'pagetools';
1199         }
1200 }