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 /**
  25  * Used to show archived pages and eventually restore them.
  26  *
  27  * @ingroup SpecialPage
  28  */
  29 class PageArchive {
  30         /** @var Title */
  31         protected $title;
  32
  33         /** @var Status */
  34         protected $fileStatus;
  35
  36         /** @var Status */
  37         protected $revisionStatus;
  38
  39         /** @var Config */
  40         protected $config;
  41
  42         function __construct( $title, Config $config = null ) {
  43                 if ( is_null( $title ) ) {
  44                         throw new MWException( __METHOD__ . ' given a null title.' );
  45                 }
  46                 $this->title = $title;
  47                 if ( $config === null ) {
  48                         wfDebug( __METHOD__ . ' did not have a Config object passed to it' );
  49                         $config = ConfigFactory::getDefaultInstance()->makeConfig( 'main' );
  50                 }
  51                 $this->config = $config;
  52         }
  53
  54         /**
  55          * List all deleted pages recorded in the archive table. Returns result
  56          * wrapper with (ar_namespace, ar_title, count) fields, ordered by page
  57          * namespace/title.
  58          *
  59          * @return ResultWrapper
  60          */
  61         public static function listAllPages() {
  62                 $dbr = wfGetDB( DB_SLAVE );
  63
  64                 return self::listPages( $dbr, '' );
  65         }
  66
  67         /**
  68          * List deleted pages recorded in the archive table matching the
  69          * given title prefix.
  70          * Returns result wrapper with (ar_namespace, ar_title, count) fields.
  71          *
  72          * @param string $prefix Title prefix
  73          * @return ResultWrapper
  74          */
  75         public static function listPagesByPrefix( $prefix ) {
  76                 $dbr = wfGetDB( DB_SLAVE );
  77
  78                 $title = Title::newFromText( $prefix );
  79                 if ( $title ) {
  80                         $ns = $title->getNamespace();
  81                         $prefix = $title->getDBkey();
  82                 } else {
  83                         // Prolly won't work too good
  84                         // @todo handle bare namespace names cleanly?
  85                         $ns = 0;
  86                 }
  87
  88                 $conds = array(
  89                         'ar_namespace' => $ns,
  90                         'ar_title' . $dbr->buildLike( $prefix, $dbr->anyString() ),
  91                 );
  92
  93                 return self::listPages( $dbr, $conds );
  94         }
  95
  96         /**
  97          * @param IDatabase $dbr
  98          * @param string|array $condition
  99          * @return bool|ResultWrapper
 100          */
 101         protected static function listPages( $dbr, $condition ) {
 102                 return $dbr->select(
 103                         array( 'archive' ),
 104                         array(
 105                                 'ar_namespace',
 106                                 'ar_title',
 107                                 'count' => 'COUNT(*)'
 108                         ),
 109                         $condition,
 110                         __METHOD__,
 111                         array(
 112                                 'GROUP BY' => array( 'ar_namespace', 'ar_title' ),
 113                                 'ORDER BY' => array( 'ar_namespace', 'ar_title' ),
 114                                 'LIMIT' => 100,
 115                         )
 116                 );
 117         }
 118
 119         /**
 120          * List the revisions of the given page. Returns result wrapper with
 121          * (ar_minor_edit, ar_timestamp, ar_user, ar_user_text, ar_comment) fields.
 122          *
 123          * @return ResultWrapper
 124          */
 125         function listRevisions() {
 126                 $dbr = wfGetDB( DB_SLAVE );
 127
 128                 $tables = array( 'archive' );
 129
 130                 $fields = array(
 131                         'ar_minor_edit', 'ar_timestamp', 'ar_user', 'ar_user_text',
 132                         'ar_comment', 'ar_len', 'ar_deleted', 'ar_rev_id', 'ar_sha1',
 133                 );
 134
 135                 if ( $this->config->get( 'ContentHandlerUseDB' ) ) {
 136                         $fields[] = 'ar_content_format';
 137                         $fields[] = 'ar_content_model';
 138                 }
 139
 140                 $conds = array( 'ar_namespace' => $this->title->getNamespace(),
 141                         'ar_title' => $this->title->getDBkey() );
 142
 143                 $options = array( 'ORDER BY' => 'ar_timestamp DESC' );
 144
 145                 $join_conds = array();
 146
 147                 ChangeTags::modifyDisplayQuery(
 148                         $tables,
 149                         $fields,
 150                         $conds,
 151                         $join_conds,
 152                         $options,
 153                         ''
 154                 );
 155
 156                 return $dbr->select( $tables,
 157                         $fields,
 158                         $conds,
 159                         __METHOD__,
 160                         $options,
 161                         $join_conds
 162                 );
 163         }
 164
 165         /**
 166          * List the deleted file revisions for this page, if it's a file page.
 167          * Returns a result wrapper with various filearchive fields, or null
 168          * if not a file page.
 169          *
 170          * @return ResultWrapper
 171          * @todo Does this belong in Image for fuller encapsulation?
 172          */
 173         function listFiles() {
 174                 if ( $this->title->getNamespace() != NS_FILE ) {
 175                         return null;
 176                 }
 177
 178                 $dbr = wfGetDB( DB_SLAVE );
 179                 return $dbr->select(
 180                         'filearchive',
 181                         ArchivedFile::selectFields(),
 182                         array( 'fa_name' => $this->title->getDBkey() ),
 183                         __METHOD__,
 184                         array( 'ORDER BY' => 'fa_timestamp DESC' )
 185                 );
 186         }
 187
 188         /**
 189          * Return a Revision object containing data for the deleted revision.
 190          * Note that the result *may* or *may not* have a null page ID.
 191          *
 192          * @param string $timestamp
 193          * @return Revision|null
 194          */
 195         function getRevision( $timestamp ) {
 196                 $dbr = wfGetDB( DB_SLAVE );
 197
 198                 $fields = array(
 199                         'ar_rev_id',
 200                         'ar_text',
 201                         'ar_comment',
 202                         'ar_user',
 203                         'ar_user_text',
 204                         'ar_timestamp',
 205                         'ar_minor_edit',
 206                         'ar_flags',
 207                         'ar_text_id',
 208                         'ar_deleted',
 209                         'ar_len',
 210                         'ar_sha1',
 211                 );
 212
 213                 if ( $this->config->get( 'ContentHandlerUseDB' ) ) {
 214                         $fields[] = 'ar_content_format';
 215                         $fields[] = 'ar_content_model';
 216                 }
 217
 218                 $row = $dbr->selectRow( 'archive',
 219                         $fields,
 220                         array( 'ar_namespace' => $this->title->getNamespace(),
 221                                 'ar_title' => $this->title->getDBkey(),
 222                                 'ar_timestamp' => $dbr->timestamp( $timestamp ) ),
 223                         __METHOD__ );
 224
 225                 if ( $row ) {
 226                         return Revision::newFromArchiveRow( $row, array( 'title' => $this->title ) );
 227                 }
 228
 229                 return null;
 230         }
 231
 232         /**
 233          * Return the most-previous revision, either live or deleted, against
 234          * the deleted revision given by timestamp.
 235          *
 236          * May produce unexpected results in case of history merges or other
 237          * unusual time issues.
 238          *
 239          * @param string $timestamp
 240          * @return Revision|null Null when there is no previous revision
 241          */
 242         function getPreviousRevision( $timestamp ) {
 243                 $dbr = wfGetDB( DB_SLAVE );
 244
 245                 // Check the previous deleted revision...
 246                 $row = $dbr->selectRow( 'archive',
 247                         'ar_timestamp',
 248                         array( 'ar_namespace' => $this->title->getNamespace(),
 249                                 'ar_title' => $this->title->getDBkey(),
 250                                 'ar_timestamp < ' .
 251                                         $dbr->addQuotes( $dbr->timestamp( $timestamp ) ) ),
 252                         __METHOD__,
 253                         array(
 254                                 'ORDER BY' => 'ar_timestamp DESC',
 255                                 'LIMIT' => 1 ) );
 256                 $prevDeleted = $row ? wfTimestamp( TS_MW, $row->ar_timestamp ) : false;
 257
 258                 $row = $dbr->selectRow( array( 'page', 'revision' ),
 259                         array( 'rev_id', 'rev_timestamp' ),
 260                         array(
 261                                 'page_namespace' => $this->title->getNamespace(),
 262                                 'page_title' => $this->title->getDBkey(),
 263                                 'page_id = rev_page',
 264                                 'rev_timestamp < ' .
 265                                         $dbr->addQuotes( $dbr->timestamp( $timestamp ) ) ),
 266                         __METHOD__,
 267                         array(
 268                                 'ORDER BY' => 'rev_timestamp DESC',
 269                                 'LIMIT' => 1 ) );
 270                 $prevLive = $row ? wfTimestamp( TS_MW, $row->rev_timestamp ) : false;
 271                 $prevLiveId = $row ? intval( $row->rev_id ) : null;
 272
 273                 if ( $prevLive && $prevLive > $prevDeleted ) {
 274                         // Most prior revision was live
 275                         return Revision::newFromId( $prevLiveId );
 276                 } elseif ( $prevDeleted ) {
 277                         // Most prior revision was deleted
 278                         return $this->getRevision( $prevDeleted );
 279                 }
 280
 281                 // No prior revision on this page.
 282                 return null;
 283         }
 284
 285         /**
 286          * Get the text from an archive row containing ar_text, ar_flags and ar_text_id
 287          *
 288          * @param object $row Database row
 289          * @return string
 290          */
 291         function getTextFromRow( $row ) {
 292                 if ( is_null( $row->ar_text_id ) ) {
 293                         // An old row from MediaWiki 1.4 or previous.
 294                         // Text is embedded in this row in classic compression format.
 295                         return Revision::getRevisionText( $row, 'ar_' );
 296                 }
 297
 298                 // New-style: keyed to the text storage backend.
 299                 $dbr = wfGetDB( DB_SLAVE );
 300                 $text = $dbr->selectRow( 'text',
 301                         array( 'old_text', 'old_flags' ),
 302                         array( 'old_id' => $row->ar_text_id ),
 303                         __METHOD__ );
 304
 305                 return Revision::getRevisionText( $text );
 306         }
 307
 308         /**
 309          * Fetch (and decompress if necessary) the stored text of the most
 310          * recently edited deleted revision of the page.
 311          *
 312          * If there are no archived revisions for the page, returns NULL.
 313          *
 314          * @return string|null
 315          */
 316         function getLastRevisionText() {
 317                 $dbr = wfGetDB( DB_SLAVE );
 318                 $row = $dbr->selectRow( 'archive',
 319                         array( 'ar_text', 'ar_flags', 'ar_text_id' ),
 320                         array( 'ar_namespace' => $this->title->getNamespace(),
 321                                 'ar_title' => $this->title->getDBkey() ),
 322                         __METHOD__,
 323                         array( 'ORDER BY' => 'ar_timestamp DESC' ) );
 324
 325                 if ( $row ) {
 326                         return $this->getTextFromRow( $row );
 327                 }
 328
 329                 return null;
 330         }
 331
 332         /**
 333          * Quick check if any archived revisions are present for the page.
 334          *
 335          * @return bool
 336          */
 337         function isDeleted() {
 338                 $dbr = wfGetDB( DB_SLAVE );
 339                 $n = $dbr->selectField( 'archive', 'COUNT(ar_title)',
 340                         array( 'ar_namespace' => $this->title->getNamespace(),
 341                                 'ar_title' => $this->title->getDBkey() ),
 342                         __METHOD__
 343                 );
 344
 345                 return ( $n > 0 );
 346         }
 347
 348         /**
 349          * Restore the given (or all) text and file revisions for the page.
 350          * Once restored, the items will be removed from the archive tables.
 351          * The deletion log will be updated with an undeletion notice.
 352          *
 353          * @param array $timestamps Pass an empty array to restore all revisions,
 354          *   otherwise list the ones to undelete.
 355          * @param string $comment
 356          * @param array $fileVersions
 357          * @param bool $unsuppress
 358          * @param User $user User performing the action, or null to use $wgUser
 359          * @return array(number of file revisions restored, number of image revisions
 360          *   restored, log message) on success, false on failure.
 361          */
 362         function undelete( $timestamps, $comment = '', $fileVersions = array(),
 363                 $unsuppress = false, User $user = null
 364         ) {
 365                 // If both the set of text revisions and file revisions are empty,
 366                 // restore everything. Otherwise, just restore the requested items.
 367                 $restoreAll = empty( $timestamps ) && empty( $fileVersions );
 368
 369                 $restoreText = $restoreAll || !empty( $timestamps );
 370                 $restoreFiles = $restoreAll || !empty( $fileVersions );
 371
 372                 if ( $restoreFiles && $this->title->getNamespace() == NS_FILE ) {
 373                         $img = wfLocalFile( $this->title );
 374                         $img->load( File::READ_LATEST );
 375                         $this->fileStatus = $img->restore( $fileVersions, $unsuppress );
 376                         if ( !$this->fileStatus->isOK() ) {
 377                                 return false;
 378                         }
 379                         $filesRestored = $this->fileStatus->successCount;
 380                 } else {
 381                         $filesRestored = 0;
 382                 }
 383
 384                 if ( $restoreText ) {
 385                         $this->revisionStatus = $this->undeleteRevisions( $timestamps, $unsuppress, $comment );
 386                         if ( !$this->revisionStatus->isOK() ) {
 387                                 return false;
 388                         }
 389
 390                         $textRestored = $this->revisionStatus->getValue();
 391                 } else {
 392                         $textRestored = 0;
 393                 }
 394
 395                 // Touch the log!
 396
 397                 if ( $textRestored && $filesRestored ) {
 398                         $reason = wfMessage( 'undeletedrevisions-files' )
 399                                 ->numParams( $textRestored, $filesRestored )->inContentLanguage()->text();
 400                 } elseif ( $textRestored ) {
 401                         $reason = wfMessage( 'undeletedrevisions' )->numParams( $textRestored )
 402                                 ->inContentLanguage()->text();
 403                 } elseif ( $filesRestored ) {
 404                         $reason = wfMessage( 'undeletedfiles' )->numParams( $filesRestored )
 405                                 ->inContentLanguage()->text();
 406                 } else {
 407                         wfDebug( "Undelete: nothing undeleted...\n" );
 408
 409                         return false;
 410                 }
 411
 412                 if ( trim( $comment ) != '' ) {
 413                         $reason .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $comment;
 414                 }
 415
 416                 if ( $user === null ) {
 417                         global $wgUser;
 418                         $user = $wgUser;
 419                 }
 420
 421                 $logEntry = new ManualLogEntry( 'delete', 'restore' );
 422                 $logEntry->setPerformer( $user );
 423                 $logEntry->setTarget( $this->title );
 424                 $logEntry->setComment( $reason );
 425
 426                 Hooks::run( 'ArticleUndeleteLogEntry', array( $this, &$logEntry, $user ) );
 427
 428                 $logid = $logEntry->insert();
 429                 $logEntry->publish( $logid );
 430
 431                 return array( $textRestored, $filesRestored, $reason );
 432         }
 433
 434         /**
 435          * This is the meaty bit -- restores archived revisions of the given page
 436          * to the cur/old tables. If the page currently exists, all revisions will
 437          * be stuffed into old, otherwise the most recent will go into cur.
 438          *
 439          * @param array $timestamps Pass an empty array to restore all revisions,
 440          *   otherwise list the ones to undelete.
 441          * @param bool $unsuppress Remove all ar_deleted/fa_deleted restrictions of seletected revs
 442          * @param string $comment
 443          * @throws ReadOnlyError
 444          * @return Status Status object containing the number of revisions restored on success
 445          */
 446         private function undeleteRevisions( $timestamps, $unsuppress = false, $comment = '' ) {
 447                 if ( wfReadOnly() ) {
 448                         throw new ReadOnlyError();
 449                 }
 450
 451                 $restoreAll = empty( $timestamps );
 452                 $dbw = wfGetDB( DB_MASTER );
 453
 454                 # Does this page already exist? We'll have to update it...
 455                 $article = WikiPage::factory( $this->title );
 456                 # Load latest data for the current page (bug 31179)
 457                 $article->loadPageData( 'fromdbmaster' );
 458                 $oldcountable = $article->isCountable();
 459
 460                 $page = $dbw->selectRow( 'page',
 461                         array( 'page_id', 'page_latest' ),
 462                         array( 'page_namespace' => $this->title->getNamespace(),
 463                                 'page_title' => $this->title->getDBkey() ),
 464                         __METHOD__,
 465                         array( 'FOR UPDATE' ) // lock page
 466                 );
 467
 468                 if ( $page ) {
 469                         $makepage = false;
 470                         # Page already exists. Import the history, and if necessary
 471                         # we'll update the latest revision field in the record.
 472
 473                         $previousRevId = $page->page_latest;
 474
 475                         # Get the time span of this page
 476                         $previousTimestamp = $dbw->selectField( 'revision', 'rev_timestamp',
 477                                 array( 'rev_id' => $previousRevId ),
 478                                 __METHOD__ );
 479
 480                         if ( $previousTimestamp === false ) {
 481                                 wfDebug( __METHOD__ . ": existing page refers to a page_latest that does not exist\n" );
 482
 483                                 $status = Status::newGood( 0 );
 484                                 $status->warning( 'undeleterevision-missing' );
 485
 486                                 return $status;
 487                         }
 488                 } else {
 489                         # Have to create a new article...
 490                         $makepage = true;
 491                         $previousRevId = 0;
 492                         $previousTimestamp = 0;
 493                 }
 494
 495                 $oldWhere = array(
 496                         'ar_namespace' => $this->title->getNamespace(),
 497                         'ar_title' => $this->title->getDBkey(),
 498                 );
 499                 if ( !$restoreAll ) {
 500                         $oldWhere['ar_timestamp'] = array_map( array( &$dbw, 'timestamp' ), $timestamps );
 501                 }
 502
 503                 $fields = array(
 504                         'ar_rev_id',
 505                         'ar_text',
 506                         'ar_comment',
 507                         'ar_user',
 508                         'ar_user_text',
 509                         'ar_timestamp',
 510                         'ar_minor_edit',
 511                         'ar_flags',
 512                         'ar_text_id',
 513                         'ar_deleted',
 514                         'ar_page_id',
 515                         'ar_len',
 516                         'ar_sha1'
 517                 );
 518
 519                 if ( $this->config->get( 'ContentHandlerUseDB' ) ) {
 520                         $fields[] = 'ar_content_format';
 521                         $fields[] = 'ar_content_model';
 522                 }
 523
 524                 /**
 525                  * Select each archived revision...
 526                  */
 527                 $result = $dbw->select( 'archive',
 528                         $fields,
 529                         $oldWhere,
 530                         __METHOD__,
 531                         /* options */ array( 'ORDER BY' => 'ar_timestamp' )
 532                 );
 533
 534                 $rev_count = $result->numRows();
 535                 if ( !$rev_count ) {
 536                         wfDebug( __METHOD__ . ": no revisions to restore\n" );
 537
 538                         $status = Status::newGood( 0 );
 539                         $status->warning( "undelete-no-results" );
 540
 541                         return $status;
 542                 }
 543
 544                 $result->seek( $rev_count - 1 ); // move to last
 545                 $row = $result->fetchObject(); // get newest archived rev
 546                 $oldPageId = (int)$row->ar_page_id; // pass this to ArticleUndelete hook
 547                 $result->seek( 0 ); // move back
 548
 549                 // grab the content to check consistency with global state before restoring the page.
 550                 $revision = Revision::newFromArchiveRow( $row,
 551                         array(
 552                                 'title' => $article->getTitle(), // used to derive default content model
 553                         )
 554                 );
 555                 $user = User::newFromName( $revision->getUserText( Revision::RAW ), false );
 556                 $content = $revision->getContent( Revision::RAW );
 557
 558                 // NOTE: article ID may not be known yet. prepareSave() should not modify the database.
 559                 $status = $content->prepareSave( $article, 0, -1, $user );
 560
 561                 if ( !$status->isOK() ) {
 562                         return $status;
 563                 }
 564
 565                 if ( $makepage ) {
 566                         // Check the state of the newest to-be version...
 567                         if ( !$unsuppress && ( $row->ar_deleted & Revision::DELETED_TEXT ) ) {
 568                                 return Status::newFatal( "undeleterevdel" );
 569                         }
 570                         // Safe to insert now...
 571                         $newid = $article->insertOn( $dbw, $row->ar_page_id );
 572                         if ( $newid === false ) {
 573                                 // The old ID is reserved; let's pick another
 574                                 $newid = $article->insertOn( $dbw );
 575                         }
 576                         $pageId = $newid;
 577                 } else {
 578                         // Check if a deleted revision will become the current revision...
 579                         if ( $row->ar_timestamp > $previousTimestamp ) {
 580                                 // Check the state of the newest to-be version...
 581                                 if ( !$unsuppress && ( $row->ar_deleted & Revision::DELETED_TEXT ) ) {
 582                                         return Status::newFatal( "undeleterevdel" );
 583                                 }
 584                         }
 585
 586                         $newid = false;
 587                         $pageId = $article->getId();
 588                 }
 589
 590                 $revision = null;
 591                 $restored = 0;
 592
 593                 foreach ( $result as $row ) {
 594                         // Check for key dupes due to needed archive integrity.
 595                         if ( $row->ar_rev_id ) {
 596                                 $exists = $dbw->selectField( 'revision', '1',
 597                                         array( 'rev_id' => $row->ar_rev_id ), __METHOD__ );
 598                                 if ( $exists ) {
 599                                         continue; // don't throw DB errors
 600                                 }
 601                         }
 602                         // Insert one revision at a time...maintaining deletion status
 603                         // unless we are specifically removing all restrictions...
 604                         $revision = Revision::newFromArchiveRow( $row,
 605                                 array(
 606                                         'page' => $pageId,
 607                                         'title' => $this->title,
 608                                         'deleted' => $unsuppress ? 0 : $row->ar_deleted
 609                                 ) );
 610
 611                         $revision->insertOn( $dbw );
 612                         $restored++;
 613
 614                         Hooks::run( 'ArticleRevisionUndeleted', array( &$this->title, $revision, $row->ar_page_id ) );
 615                 }
 616                 # Now that it's safely stored, take it out of the archive
 617                 $dbw->delete( 'archive',
 618                         $oldWhere,
 619                         __METHOD__ );
 620
 621                 // Was anything restored at all?
 622                 if ( $restored == 0 ) {
 623                         return Status::newGood( 0 );
 624                 }
 625
 626                 $created = (bool)$newid;
 627
 628                 // Attach the latest revision to the page...
 629                 $wasnew = $article->updateIfNewerOn( $dbw, $revision, $previousRevId );
 630                 if ( $created || $wasnew ) {
 631                         // Update site stats, link tables, etc
 632                         $article->doEditUpdates(
 633                                 $revision,
 634                                 User::newFromName( $revision->getUserText( Revision::RAW ), false ),
 635                                 array(
 636                                         'created' => $created,
 637                                         'oldcountable' => $oldcountable,
 638                                         'restored' => true
 639                                 )
 640                         );
 641                 }
 642
 643                 Hooks::run( 'ArticleUndelete', array( &$this->title, $created, $comment, $oldPageId ) );
 644
 645                 if ( $this->title->getNamespace() == NS_FILE ) {
 646                         DeferredUpdates::addUpdate( new HTMLCacheUpdate( $this->title, 'imagelinks' ) );
 647                 }
 648
 649                 return Status::newGood( $restored );
 650         }
 651
 652         /**
 653          * @return Status
 654          */
 655         function getFileStatus() {
 656                 return $this->fileStatus;
 657         }
 658
 659         /**
 660          * @return Status
 661          */
 662         function getRevisionStatus() {
 663                 return $this->revisionStatus;
 664         }
 665 }
 666
 667 /**
 668  * Special page allowing users with the appropriate permissions to view
 669  * and restore deleted content.
 670  *
 671  * @ingroup SpecialPage
 672  */
 673 class SpecialUndelete extends SpecialPage {
 674         private $mAction;
 675         private $mTarget;
 676         private $mTimestamp;
 677         private $mRestore;
 678         private $mInvert;
 679         private $mFilename;
 680         private $mTargetTimestamp;
 681         private $mAllowed;
 682         private $mCanView;
 683         private $mComment;
 684         private $mToken;
 685
 686         /** @var Title */
 687         private $mTargetObj;
 688
 689         function __construct() {
 690                 parent::__construct( 'Undelete', 'deletedhistory' );
 691         }
 692
 693         function loadRequest( $par ) {
 694                 $request = $this->getRequest();
 695                 $user = $this->getUser();
 696
 697                 $this->mAction = $request->getVal( 'action' );
 698                 if ( $par !== null && $par !== '' ) {
 699                         $this->mTarget = $par;
 700                 } else {
 701                         $this->mTarget = $request->getVal( 'target' );
 702                 }
 703
 704                 $this->mTargetObj = null;
 705
 706                 if ( $this->mTarget !== null && $this->mTarget !== '' ) {
 707                         $this->mTargetObj = Title::newFromText( $this->mTarget );
 708                 }
 709
 710                 $this->mSearchPrefix = $request->getText( 'prefix' );
 711                 $time = $request->getVal( 'timestamp' );
 712                 $this->mTimestamp = $time ? wfTimestamp( TS_MW, $time ) : '';
 713                 $this->mFilename = $request->getVal( 'file' );
 714
 715                 $posted = $request->wasPosted() &&
 716                         $user->matchEditToken( $request->getVal( 'wpEditToken' ) );
 717                 $this->mRestore = $request->getCheck( 'restore' ) && $posted;
 718                 $this->mInvert = $request->getCheck( 'invert' ) && $posted;
 719                 $this->mPreview = $request->getCheck( 'preview' ) && $posted;
 720                 $this->mDiff = $request->getCheck( 'diff' );
 721                 $this->mDiffOnly = $request->getBool( 'diffonly', $this->getUser()->getOption( 'diffonly' ) );
 722                 $this->mComment = $request->getText( 'wpComment' );
 723                 $this->mUnsuppress = $request->getVal( 'wpUnsuppress' ) && $user->isAllowed( 'suppressrevision' );
 724                 $this->mToken = $request->getVal( 'token' );
 725
 726                 if ( $this->isAllowed( 'undelete' ) && !$user->isBlocked() ) {
 727                         $this->mAllowed = true; // user can restore
 728                         $this->mCanView = true; // user can view content
 729                 } elseif ( $this->isAllowed( 'deletedtext' ) ) {
 730                         $this->mAllowed = false; // user cannot restore
 731                         $this->mCanView = true; // user can view content
 732                         $this->mRestore = false;
 733                 } else { // user can only view the list of revisions
 734                         $this->mAllowed = false;
 735                         $this->mCanView = false;
 736                         $this->mTimestamp = '';
 737                         $this->mRestore = false;
 738                 }
 739
 740                 if ( $this->mRestore || $this->mInvert ) {
 741                         $timestamps = array();
 742                         $this->mFileVersions = array();
 743                         foreach ( $request->getValues() as $key => $val ) {
 744                                 $matches = array();
 745                                 if ( preg_match( '/^ts(\d{14})$/', $key, $matches ) ) {
 746                                         array_push( $timestamps, $matches[1] );
 747                                 }
 748
 749                                 if ( preg_match( '/^fileid(\d+)$/', $key, $matches ) ) {
 750                                         $this->mFileVersions[] = intval( $matches[1] );
 751                                 }
 752                         }
 753                         rsort( $timestamps );
 754                         $this->mTargetTimestamp = $timestamps;
 755                 }
 756         }
 757
 758         /**
 759          * Checks whether a user is allowed the permission for the
 760          * specific title if one is set.
 761          *
 762          * @param string $permission
 763          * @param User $user
 764          * @return bool
 765          */
 766         protected function isAllowed( $permission, User $user = null ) {
 767                 $user = $user ?: $this->getUser();
 768                 if ( $this->mTargetObj !== null ) {
 769                         return $this->mTargetObj->userCan( $permission, $user );
 770                 } else {
 771                         return $user->isAllowed( $permission );
 772                 }
 773         }
 774
 775         function userCanExecute( User $user ) {
 776                 return $this->isAllowed( $this->mRestriction, $user );
 777         }
 778
 779         function execute( $par ) {
 780                 $this->useTransactionalTimeLimit();
 781
 782                 $user = $this->getUser();
 783
 784                 $this->setHeaders();
 785                 $this->outputHeader();
 786
 787                 $this->loadRequest( $par );
 788                 $this->checkPermissions(); // Needs to be after mTargetObj is set
 789
 790                 $out = $this->getOutput();
 791
 792                 if ( is_null( $this->mTargetObj ) ) {
 793                         $out->addWikiMsg( 'undelete-header' );
 794
 795                         # Not all users can just browse every deleted page from the list
 796                         if ( $user->isAllowed( 'browsearchive' ) ) {
 797                                 $this->showSearchForm();
 798                         }
 799
 800                         return;
 801                 }
 802
 803                 $this->addHelpLink( 'Help:Undelete' );
 804                 if ( $this->mAllowed ) {
 805                         $out->setPageTitle( $this->msg( 'undeletepage' ) );
 806                 } else {
 807                         $out->setPageTitle( $this->msg( 'viewdeletedpage' ) );
 808                 }
 809
 810                 $this->getSkin()->setRelevantTitle( $this->mTargetObj );
 811
 812                 if ( $this->mTimestamp !== '' ) {
 813                         $this->showRevision( $this->mTimestamp );
 814                 } elseif ( $this->mFilename !== null && $this->mTargetObj->inNamespace( NS_FILE ) ) {
 815                         $file = new ArchivedFile( $this->mTargetObj, '', $this->mFilename );
 816                         // Check if user is allowed to see this file
 817                         if ( !$file->exists() ) {
 818                                 $out->addWikiMsg( 'filedelete-nofile', $this->mFilename );
 819                         } elseif ( !$file->userCan( File::DELETED_FILE, $user ) ) {
 820                                 if ( $file->isDeleted( File::DELETED_RESTRICTED ) ) {
 821                                         throw new PermissionsError( 'suppressrevision' );
 822                                 } else {
 823                                         throw new PermissionsError( 'deletedtext' );
 824                                 }
 825                         } elseif ( !$user->matchEditToken( $this->mToken, $this->mFilename ) ) {
 826                                 $this->showFileConfirmationForm( $this->mFilename );
 827                         } else {
 828                                 $this->showFile( $this->mFilename );
 829                         }
 830                 } elseif ( $this->mRestore && $this->mAction == 'submit' ) {
 831                         $this->undelete();
 832                 } else {
 833                         $this->showHistory();
 834                 }
 835         }
 836
 837         function showSearchForm() {
 838                 $out = $this->getOutput();
 839                 $out->setPageTitle( $this->msg( 'undelete-search-title' ) );
 840                 $out->addHTML(
 841                         Xml::openElement( 'form', array( 'method' => 'get', 'action' => wfScript() ) ) .
 842                                 Xml::fieldset( $this->msg( 'undelete-search-box' )->text() ) .
 843                                 Html::hidden( 'title', $this->getPageTitle()->getPrefixedDBkey() ) .
 844                                 Html::rawElement(
 845                                         'label',
 846                                         array( 'for' => 'prefix' ),
 847                                         $this->msg( 'undelete-search-prefix' )->parse()
 848                                 ) .
 849                                 Xml::input(
 850                                         'prefix',
 851                                         20,
 852                                         $this->mSearchPrefix,
 853                                         array( 'id' => 'prefix', 'autofocus' => '' )
 854                                 ) . ' ' .
 855                                 Xml::submitButton( $this->msg( 'undelete-search-submit' )->text() ) .
 856                                 Xml::closeElement( 'fieldset' ) .
 857                                 Xml::closeElement( 'form' )
 858                 );
 859
 860                 # List undeletable articles
 861                 if ( $this->mSearchPrefix ) {
 862                         $result = PageArchive::listPagesByPrefix( $this->mSearchPrefix );
 863                         $this->showList( $result );
 864                 }
 865         }
 866
 867         /**
 868          * Generic list of deleted pages
 869          *
 870          * @param ResultWrapper $result
 871          * @return bool
 872          */
 873         private function showList( $result ) {
 874                 $out = $this->getOutput();
 875
 876                 if ( $result->numRows() == 0 ) {
 877                         $out->addWikiMsg( 'undelete-no-results' );
 878
 879                         return false;
 880                 }
 881
 882                 $out->addWikiMsg( 'undeletepagetext', $this->getLanguage()->formatNum( $result->numRows() ) );
 883
 884                 $undelete = $this->getPageTitle();
 885                 $out->addHTML( "<ul>\n" );
 886                 foreach ( $result as $row ) {
 887                         $title = Title::makeTitleSafe( $row->ar_namespace, $row->ar_title );
 888                         if ( $title !== null ) {
 889                                 $item = Linker::linkKnown(
 890                                         $undelete,
 891                                         htmlspecialchars( $title->getPrefixedText() ),
 892                                         array(),
 893                                         array( 'target' => $title->getPrefixedText() )
 894                                 );
 895                         } else {
 896                                 // The title is no longer valid, show as text
 897                                 $item = Html::element(
 898                                         'span',
 899                                         array( 'class' => 'mw-invalidtitle' ),
 900                                         Linker::getInvalidTitleDescription(
 901                                                 $this->getContext(),
 902                                                 $row->ar_namespace,
 903                                                 $row->ar_title
 904                                         )
 905                                 );
 906                         }
 907                         $revs = $this->msg( 'undeleterevisions' )->numParams( $row->count )->parse();
 908                         $out->addHTML( "<li>{$item} ({$revs})</li>\n" );
 909                 }
 910                 $result->free();
 911                 $out->addHTML( "</ul>\n" );
 912
 913                 return true;
 914         }
 915
 916         private function showRevision( $timestamp ) {
 917                 if ( !preg_match( '/[0-9]{14}/', $timestamp ) ) {
 918                         return;
 919                 }
 920
 921                 $archive = new PageArchive( $this->mTargetObj, $this->getConfig() );
 922                 if ( !Hooks::run( 'UndeleteForm::showRevision', array( &$archive, $this->mTargetObj ) ) ) {
 923                         return;
 924                 }
 925                 $rev = $archive->getRevision( $timestamp );
 926
 927                 $out = $this->getOutput();
 928                 $user = $this->getUser();
 929
 930                 if ( !$rev ) {
 931                         $out->addWikiMsg( 'undeleterevision-missing' );
 932
 933                         return;
 934                 }
 935
 936                 if ( $rev->isDeleted( Revision::DELETED_TEXT ) ) {
 937                         if ( !$rev->userCan( Revision::DELETED_TEXT, $user ) ) {
 938                                 $out->wrapWikiMsg(
 939                                         "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
 940                                 $rev->isDeleted( Revision::DELETED_RESTRICTED ) ?
 941                                         'rev-suppressed-text-permission' : 'rev-deleted-text-permission'
 942                                 );
 943
 944                                 return;
 945                         }
 946
 947                         $out->wrapWikiMsg(
 948                                 "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
 949                                 $rev->isDeleted( Revision::DELETED_RESTRICTED ) ?
 950                                         'rev-suppressed-text-view' : 'rev-deleted-text-view'
 951                         );
 952                         $out->addHTML( '<br />' );
 953                         // and we are allowed to see...
 954                 }
 955
 956                 if ( $this->mDiff ) {
 957                         $previousRev = $archive->getPreviousRevision( $timestamp );
 958                         if ( $previousRev ) {
 959                                 $this->showDiff( $previousRev, $rev );
 960                                 if ( $this->mDiffOnly ) {
 961                                         return;
 962                                 }
 963
 964                                 $out->addHTML( '<hr />' );
 965                         } else {
 966                                 $out->addWikiMsg( 'undelete-nodiff' );
 967                         }
 968                 }
 969
 970                 $link = Linker::linkKnown(
 971                         $this->getPageTitle( $this->mTargetObj->getPrefixedDBkey() ),
 972                         htmlspecialchars( $this->mTargetObj->getPrefixedText() )
 973                 );
 974
 975                 $lang = $this->getLanguage();
 976
 977                 // date and time are separate parameters to facilitate localisation.
 978                 // $time is kept for backward compat reasons.
 979                 $time = $lang->userTimeAndDate( $timestamp, $user );
 980                 $d = $lang->userDate( $timestamp, $user );
 981                 $t = $lang->userTime( $timestamp, $user );
 982                 $userLink = Linker::revUserTools( $rev );
 983
 984                 $content = $rev->getContent( Revision::FOR_THIS_USER, $user );
 985
 986                 $isText = ( $content instanceof TextContent );
 987
 988                 if ( $this->mPreview || $isText ) {
 989                         $openDiv = '<div id="mw-undelete-revision" class="mw-warning">';
 990                 } else {
 991                         $openDiv = '<div id="mw-undelete-revision">';
 992                 }
 993                 $out->addHTML( $openDiv );
 994
 995                 // Revision delete links
 996                 if ( !$this->mDiff ) {
 997                         $revdel = Linker::getRevDeleteLink( $user, $rev, $this->mTargetObj );
 998                         if ( $revdel ) {
 999                                 $out->addHTML( "$revdel " );
1000                         }
1001                 }
1002
1003                 $out->addHTML( $this->msg( 'undelete-revision' )->rawParams( $link )->params(
1004                         $time )->rawParams( $userLink )->params( $d, $t )->parse() . '</div>' );
1005
1006                 if ( !Hooks::run( 'UndeleteShowRevision', array( $this->mTargetObj, $rev ) ) ) {
1007                         return;
1008                 }
1009
1010                 if ( ( $this->mPreview || !$isText ) && $content ) {
1011                         // NOTE: non-text content has no source view, so always use rendered preview
1012
1013                         // Hide [edit]s
1014                         $popts = $out->parserOptions();
1015                         $popts->setEditSection( false );
1016
1017                         $pout = $content->getParserOutput( $this->mTargetObj, $rev->getId(), $popts, true );
1018                         $out->addParserOutput( $pout );
1019                 }
1020
1021                 if ( $isText ) {
1022                         // source view for textual content
1023                         $sourceView = Xml::element(
1024                                 'textarea',
1025                                 array(
1026                                         'readonly' => 'readonly',
1027                                         'cols' => $user->getIntOption( 'cols' ),
1028                                         'rows' => $user->getIntOption( 'rows' )
1029                                 ),
1030                                 $content->getNativeData() . "\n"
1031                         );
1032
1033                         $previewButton = Xml::element( 'input', array(
1034                                 'type' => 'submit',
1035                                 'name' => 'preview',
1036                                 'value' => $this->msg( 'showpreview' )->text()
1037                         ) );
1038                 } else {
1039                         $sourceView = '';
1040                         $previewButton = '';
1041                 }
1042
1043                 $diffButton = Xml::element( 'input', array(
1044                         'name' => 'diff',
1045                         'type' => 'submit',
1046                         'value' => $this->msg( 'showdiff' )->text() ) );
1047
1048                 $out->addHTML(
1049                         $sourceView .
1050                                 Xml::openElement( 'div', array(
1051                                         'style' => 'clear: both' ) ) .
1052                                 Xml::openElement( 'form', array(
1053                                         'method' => 'post',
1054                                         'action' => $this->getPageTitle()->getLocalURL( array( 'action' => 'submit' ) ) ) ) .
1055                                 Xml::element( 'input', array(
1056                                         'type' => 'hidden',
1057                                         'name' => 'target',
1058                                         'value' => $this->mTargetObj->getPrefixedDBkey() ) ) .
1059                                 Xml::element( 'input', array(
1060                                         'type' => 'hidden',
1061                                         'name' => 'timestamp',
1062                                         'value' => $timestamp ) ) .
1063                                 Xml::element( 'input', array(
1064                                         'type' => 'hidden',
1065                                         'name' => 'wpEditToken',
1066                                         'value' => $user->getEditToken() ) ) .
1067                                 $previewButton .
1068                                 $diffButton .
1069                                 Xml::closeElement( 'form' ) .
1070                                 Xml::closeElement( 'div' )
1071                 );
1072         }
1073
1074         /**
1075          * Build a diff display between this and the previous either deleted
1076          * or non-deleted edit.
1077          *
1078          * @param Revision $previousRev
1079          * @param Revision $currentRev
1080          * @return string HTML
1081          */
1082         function showDiff( $previousRev, $currentRev ) {
1083                 $diffContext = clone $this->getContext();
1084                 $diffContext->setTitle( $currentRev->getTitle() );
1085                 $diffContext->setWikiPage( WikiPage::factory( $currentRev->getTitle() ) );
1086
1087                 $diffEngine = $currentRev->getContentHandler()->createDifferenceEngine( $diffContext );
1088                 $diffEngine->showDiffStyle();
1089
1090                 $formattedDiff = $diffEngine->generateContentDiffBody(
1091                         $previousRev->getContent( Revision::FOR_THIS_USER, $this->getUser() ),
1092                         $currentRev->getContent( Revision::FOR_THIS_USER, $this->getUser() )
1093                 );
1094
1095                 $formattedDiff = $diffEngine->addHeader(
1096                         $formattedDiff,
1097                         $this->diffHeader( $previousRev, 'o' ),
1098                         $this->diffHeader( $currentRev, 'n' )
1099                 );
1100
1101                 $this->getOutput()->addHTML( "<div>$formattedDiff</div>\n" );
1102         }
1103
1104         /**
1105          * @param Revision $rev
1106          * @param string $prefix
1107          * @return string
1108          */
1109         private function diffHeader( $rev, $prefix ) {
1110                 $isDeleted = !( $rev->getId() && $rev->getTitle() );
1111                 if ( $isDeleted ) {
1112                         /// @todo FIXME: $rev->getTitle() is null for deleted revs...?
1113                         $targetPage = $this->getPageTitle();
1114                         $targetQuery = array(
1115                                 'target' => $this->mTargetObj->getPrefixedText(),
1116                                 'timestamp' => wfTimestamp( TS_MW, $rev->getTimestamp() )
1117                         );
1118                 } else {
1119                         /// @todo FIXME: getId() may return non-zero for deleted revs...
1120                         $targetPage = $rev->getTitle();
1121                         $targetQuery = array( 'oldid' => $rev->getId() );
1122                 }
1123
1124                 // Add show/hide deletion links if available
1125                 $user = $this->getUser();
1126                 $lang = $this->getLanguage();
1127                 $rdel = Linker::getRevDeleteLink( $user, $rev, $this->mTargetObj );
1128
1129                 if ( $rdel ) {
1130                         $rdel = " $rdel";
1131                 }
1132
1133                 $minor = $rev->isMinor() ? ChangesList::flag( 'minor' ) : '';
1134
1135                 $tags = wfGetDB( DB_SLAVE )->selectField(
1136                         'tag_summary',
1137                         'ts_tags',
1138                         array( 'ts_rev_id' => $rev->getId() ),
1139                         __METHOD__
1140                 );
1141                 $tagSummary = ChangeTags::formatSummaryRow( $tags, 'deleteddiff' );
1142
1143                 // FIXME This is reimplementing DifferenceEngine#getRevisionHeader
1144                 // and partially #showDiffPage, but worse
1145                 return '<div id="mw-diff-' . $prefix . 'title1"><strong>' .
1146                         Linker::link(
1147                                 $targetPage,
1148                                 $this->msg(
1149                                         'revisionasof',
1150                                         $lang->userTimeAndDate( $rev->getTimestamp(), $user ),
1151                                         $lang->userDate( $rev->getTimestamp(), $user ),
1152                                         $lang->userTime( $rev->getTimestamp(), $user )
1153                                 )->escaped(),
1154                                 array(),
1155                                 $targetQuery
1156                         ) .
1157                         '</strong></div>' .
1158                         '<div id="mw-diff-' . $prefix . 'title2">' .
1159                         Linker::revUserTools( $rev ) . '<br />' .
1160                         '</div>' .
1161                         '<div id="mw-diff-' . $prefix . 'title3">' .
1162                         $minor . Linker::revComment( $rev ) . $rdel . '<br />' .
1163                         '</div>' .
1164                         '<div id="mw-diff-' . $prefix . 'title5">' .
1165                         $tagSummary[0] . '<br />' .
1166                         '</div>';
1167         }
1168
1169         /**
1170          * Show a form confirming whether a tokenless user really wants to see a file
1171          * @param string $key
1172          */
1173         private function showFileConfirmationForm( $key ) {
1174                 $out = $this->getOutput();
1175                 $lang = $this->getLanguage();
1176                 $user = $this->getUser();
1177                 $file = new ArchivedFile( $this->mTargetObj, '', $this->mFilename );
1178                 $out->addWikiMsg( 'undelete-show-file-confirm',
1179                         $this->mTargetObj->getText(),
1180                         $lang->userDate( $file->getTimestamp(), $user ),
1181                         $lang->userTime( $file->getTimestamp(), $user ) );
1182                 $out->addHTML(
1183                         Xml::openElement( 'form', array(
1184                                         'method' => 'POST',
1185                                         'action' => $this->getPageTitle()->getLocalURL( array(
1186                                                 'target' => $this->mTarget,
1187                                                 'file' => $key,
1188                                                 'token' => $user->getEditToken( $key ),
1189                                         ) ),
1190                                 )
1191                         ) .
1192                                 Xml::submitButton( $this->msg( 'undelete-show-file-submit' )->text() ) .
1193                                 '</form>'
1194                 );
1195         }
1196
1197         /**
1198          * Show a deleted file version requested by the visitor.
1199          * @param string $key
1200          */
1201         private function showFile( $key ) {
1202                 $this->getOutput()->disable();
1203
1204                 # We mustn't allow the output to be CDN cached, otherwise
1205                 # if an admin previews a deleted image, and it's cached, then
1206                 # a user without appropriate permissions can toddle off and
1207                 # nab the image, and CDN will serve it
1208                 $response = $this->getRequest()->response();
1209                 $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
1210                 $response->header( 'Cache-Control: no-cache, no-store, max-age=0, must-revalidate' );
1211                 $response->header( 'Pragma: no-cache' );
1212
1213                 $repo = RepoGroup::singleton()->getLocalRepo();
1214                 $path = $repo->getZonePath( 'deleted' ) . '/' . $repo->getDeletedHashPath( $key ) . $key;
1215                 $repo->streamFile( $path );
1216         }
1217
1218         protected function showHistory() {
1219                 $this->checkReadOnly();
1220
1221                 $out = $this->getOutput();
1222                 if ( $this->mAllowed ) {
1223                         $out->addModules( 'mediawiki.special.undelete' );
1224                 }
1225                 $out->wrapWikiMsg(
1226                         "<div class='mw-undelete-pagetitle'>\n$1\n</div>\n",
1227                         array( 'undeletepagetitle', wfEscapeWikiText( $this->mTargetObj->getPrefixedText() ) )
1228                 );
1229
1230                 $archive = new PageArchive( $this->mTargetObj, $this->getConfig() );
1231                 Hooks::run( 'UndeleteForm::showHistory', array( &$archive, $this->mTargetObj ) );
1232                 /*
1233                 $text = $archive->getLastRevisionText();
1234                 if( is_null( $text ) ) {
1235                         $out->addWikiMsg( 'nohistory' );
1236                         return;
1237                 }
1238                 */
1239                 $out->addHTML( '<div class="mw-undelete-history">' );
1240                 if ( $this->mAllowed ) {
1241                         $out->addWikiMsg( 'undeletehistory' );
1242                         $out->addWikiMsg( 'undeleterevdel' );
1243                 } else {
1244                         $out->addWikiMsg( 'undeletehistorynoadmin' );
1245                 }
1246                 $out->addHTML( '</div>' );
1247
1248                 # List all stored revisions
1249                 $revisions = $archive->listRevisions();
1250                 $files = $archive->listFiles();
1251
1252                 $haveRevisions = $revisions && $revisions->numRows() > 0;
1253                 $haveFiles = $files && $files->numRows() > 0;
1254
1255                 # Batch existence check on user and talk pages
1256                 if ( $haveRevisions ) {
1257                         $batch = new LinkBatch();
1258                         foreach ( $revisions as $row ) {
1259                                 $batch->addObj( Title::makeTitleSafe( NS_USER, $row->ar_user_text ) );
1260                                 $batch->addObj( Title::makeTitleSafe( NS_USER_TALK, $row->ar_user_text ) );
1261                         }
1262                         $batch->execute();
1263                         $revisions->seek( 0 );
1264                 }
1265                 if ( $haveFiles ) {
1266                         $batch = new LinkBatch();
1267                         foreach ( $files as $row ) {
1268                                 $batch->addObj( Title::makeTitleSafe( NS_USER, $row->fa_user_text ) );
1269                                 $batch->addObj( Title::makeTitleSafe( NS_USER_TALK, $row->fa_user_text ) );
1270                         }
1271                         $batch->execute();
1272                         $files->seek( 0 );
1273                 }
1274
1275                 if ( $this->mAllowed ) {
1276                         $action = $this->getPageTitle()->getLocalURL( array( 'action' => 'submit' ) );
1277                         # Start the form here
1278                         $top = Xml::openElement(
1279                                 'form',
1280                                 array( 'method' => 'post', 'action' => $action, 'id' => 'undelete' )
1281                         );
1282                         $out->addHTML( $top );
1283                 }
1284
1285                 # Show relevant lines from the deletion log:
1286                 $deleteLogPage = new LogPage( 'delete' );
1287                 $out->addHTML( Xml::element( 'h2', null, $deleteLogPage->getName()->text() ) . "\n" );
1288                 LogEventsList::showLogExtract( $out, 'delete', $this->mTargetObj );
1289                 # Show relevant lines from the suppression log:
1290                 $suppressLogPage = new LogPage( 'suppress' );
1291                 if ( $this->getUser()->isAllowed( 'suppressionlog' ) ) {
1292                         $out->addHTML( Xml::element( 'h2', null, $suppressLogPage->getName()->text() ) . "\n" );
1293                         LogEventsList::showLogExtract( $out, 'suppress', $this->mTargetObj );
1294                 }
1295
1296                 if ( $this->mAllowed && ( $haveRevisions || $haveFiles ) ) {
1297                         # Format the user-visible controls (comment field, submission button)
1298                         # in a nice little table
1299                         if ( $this->getUser()->isAllowed( 'suppressrevision' ) ) {
1300                                 $unsuppressBox =
1301                                         "<tr>
1302                                                 <td>&#160;</td>
1303                                                 <td class='mw-input'>" .
1304                                                 Xml::checkLabel( $this->msg( 'revdelete-unsuppress' )->text(),
1305                                                         'wpUnsuppress', 'mw-undelete-unsuppress', $this->mUnsuppress ) .
1306                                                 "</td>
1307                                         </tr>";
1308                         } else {
1309                                 $unsuppressBox = '';
1310                         }
1311
1312                         $table = Xml::fieldset( $this->msg( 'undelete-fieldset-title' )->text() ) .
1313                                 Xml::openElement( 'table', array( 'id' => 'mw-undelete-table' ) ) .
1314                                 "<tr>
1315                                         <td colspan='2' class='mw-undelete-extrahelp'>" .
1316                                 $this->msg( 'undeleteextrahelp' )->parseAsBlock() .
1317                                 "</td>
1318                         </tr>
1319                         <tr>
1320                                 <td class='mw-label'>" .
1321                                 Xml::label( $this->msg( 'undeletecomment' )->text(), 'wpComment' ) .
1322                                 "</td>
1323                                 <td class='mw-input'>" .
1324                                 Xml::input(
1325                                         'wpComment',
1326                                         50,
1327                                         $this->mComment,
1328                                         array( 'id' => 'wpComment', 'autofocus' => '' )
1329                                 ) .
1330                                 "</td>
1331                         </tr>
1332                         <tr>
1333                                 <td>&#160;</td>
1334                                 <td class='mw-submit'>" .
1335                                 Xml::submitButton(
1336                                         $this->msg( 'undeletebtn' )->text(),
1337                                         array( 'name' => 'restore', 'id' => 'mw-undelete-submit' )
1338                                 ) . ' ' .
1339                                 Xml::submitButton(
1340                                         $this->msg( 'undeleteinvert' )->text(),
1341                                         array( 'name' => 'invert', 'id' => 'mw-undelete-invert' )
1342                                 ) .
1343                                 "</td>
1344                         </tr>" .
1345                                 $unsuppressBox .
1346                                 Xml::closeElement( 'table' ) .
1347                                 Xml::closeElement( 'fieldset' );
1348
1349                         $out->addHTML( $table );
1350                 }
1351
1352                 $out->addHTML( Xml::element( 'h2', null, $this->msg( 'history' )->text() ) . "\n" );
1353
1354                 if ( $haveRevisions ) {
1355                         # The page's stored (deleted) history:
1356                         $out->addHTML( '<ul>' );
1357                         $remaining = $revisions->numRows();
1358                         $earliestLiveTime = $this->mTargetObj->getEarliestRevTime();
1359
1360                         foreach ( $revisions as $row ) {
1361                                 $remaining--;
1362                                 $out->addHTML( $this->formatRevisionRow( $row, $earliestLiveTime, $remaining ) );
1363                         }
1364                         $revisions->free();
1365                         $out->addHTML( '</ul>' );
1366                 } else {
1367                         $out->addWikiMsg( 'nohistory' );
1368                 }
1369
1370                 if ( $haveFiles ) {
1371                         $out->addHTML( Xml::element( 'h2', null, $this->msg( 'filehist' )->text() ) . "\n" );
1372                         $out->addHTML( '<ul>' );
1373                         foreach ( $files as $row ) {
1374                                 $out->addHTML( $this->formatFileRow( $row ) );
1375                         }
1376                         $files->free();
1377                         $out->addHTML( '</ul>' );
1378                 }
1379
1380                 if ( $this->mAllowed ) {
1381                         # Slip in the hidden controls here
1382                         $misc = Html::hidden( 'target', $this->mTarget );
1383                         $misc .= Html::hidden( 'wpEditToken', $this->getUser()->getEditToken() );
1384                         $misc .= Xml::closeElement( 'form' );
1385                         $out->addHTML( $misc );
1386                 }
1387
1388                 return true;
1389         }
1390
1391         protected function formatRevisionRow( $row, $earliestLiveTime, $remaining ) {
1392                 $rev = Revision::newFromArchiveRow( $row,
1393                         array(
1394                                 'title' => $this->mTargetObj
1395                         ) );
1396
1397                 $revTextSize = '';
1398                 $ts = wfTimestamp( TS_MW, $row->ar_timestamp );
1399                 // Build checkboxen...
1400                 if ( $this->mAllowed ) {
1401                         if ( $this->mInvert ) {
1402                                 if ( in_array( $ts, $this->mTargetTimestamp ) ) {
1403                                         $checkBox = Xml::check( "ts$ts" );
1404                                 } else {
1405                                         $checkBox = Xml::check( "ts$ts", true );
1406                                 }
1407                         } else {
1408                                 $checkBox = Xml::check( "ts$ts" );
1409                         }
1410                 } else {
1411                         $checkBox = '';
1412                 }
1413
1414                 // Build page & diff links...
1415                 $user = $this->getUser();
1416                 if ( $this->mCanView ) {
1417                         $titleObj = $this->getPageTitle();
1418                         # Last link
1419                         if ( !$rev->userCan( Revision::DELETED_TEXT, $this->getUser() ) ) {
1420                                 $pageLink = htmlspecialchars( $this->getLanguage()->userTimeAndDate( $ts, $user ) );
1421                                 $last = $this->msg( 'diff' )->escaped();
1422                         } elseif ( $remaining > 0 || ( $earliestLiveTime && $ts > $earliestLiveTime ) ) {
1423                                 $pageLink = $this->getPageLink( $rev, $titleObj, $ts );
1424                                 $last = Linker::linkKnown(
1425                                         $titleObj,
1426                                         $this->msg( 'diff' )->escaped(),
1427                                         array(),
1428                                         array(
1429                                                 'target' => $this->mTargetObj->getPrefixedText(),
1430                                                 'timestamp' => $ts,
1431                                                 'diff' => 'prev'
1432                                         )
1433                                 );
1434                         } else {
1435                                 $pageLink = $this->getPageLink( $rev, $titleObj, $ts );
1436                                 $last = $this->msg( 'diff' )->escaped();
1437                         }
1438                 } else {
1439                         $pageLink = htmlspecialchars( $this->getLanguage()->userTimeAndDate( $ts, $user ) );
1440                         $last = $this->msg( 'diff' )->escaped();
1441                 }
1442
1443                 // User links
1444                 $userLink = Linker::revUserTools( $rev );
1445
1446                 // Minor edit
1447                 $minor = $rev->isMinor() ? ChangesList::flag( 'minor' ) : '';
1448
1449                 // Revision text size
1450                 $size = $row->ar_len;
1451                 if ( !is_null( $size ) ) {
1452                         $revTextSize = Linker::formatRevisionSize( $size );
1453                 }
1454
1455                 // Edit summary
1456                 $comment = Linker::revComment( $rev );
1457
1458                 // Tags
1459                 $attribs = array();
1460                 list( $tagSummary, $classes ) = ChangeTags::formatSummaryRow( $row->ts_tags, 'deletedhistory' );
1461                 if ( $classes ) {
1462                         $attribs['class'] = implode( ' ', $classes );
1463                 }
1464
1465                 // Revision delete links
1466                 $revdlink = Linker::getRevDeleteLink( $user, $rev, $this->mTargetObj );
1467
1468                 $revisionRow = $this->msg( 'undelete-revision-row' )
1469                         ->rawParams(
1470                                 $checkBox,
1471                                 $revdlink,
1472                                 $last,
1473                                 $pageLink,
1474                                 $userLink,
1475                                 $minor,
1476                                 $revTextSize,
1477                                 $comment,
1478                                 $tagSummary
1479                         )
1480                         ->escaped();
1481
1482                 return Xml::tags( 'li', $attribs, $revisionRow ) . "\n";
1483         }
1484
1485         private function formatFileRow( $row ) {
1486                 $file = ArchivedFile::newFromRow( $row );
1487                 $ts = wfTimestamp( TS_MW, $row->fa_timestamp );
1488                 $user = $this->getUser();
1489
1490                 $checkBox = '';
1491                 if ( $this->mCanView && $row->fa_storage_key ) {
1492                         if ( $this->mAllowed ) {
1493                                 $checkBox = Xml::check( 'fileid' . $row->fa_id );
1494                         }
1495                         $key = urlencode( $row->fa_storage_key );
1496                         $pageLink = $this->getFileLink( $file, $this->getPageTitle(), $ts, $key );
1497                 } else {
1498                         $pageLink = $this->getLanguage()->userTimeAndDate( $ts, $user );
1499                 }
1500                 $userLink = $this->getFileUser( $file );
1501                 $data = $this->msg( 'widthheight' )->numParams( $row->fa_width, $row->fa_height )->text();
1502                 $bytes = $this->msg( 'parentheses' )
1503                         ->rawParams( $this->msg( 'nbytes' )->numParams( $row->fa_size )->text() )
1504                         ->plain();
1505                 $data = htmlspecialchars( $data . ' ' . $bytes );
1506                 $comment = $this->getFileComment( $file );
1507
1508                 // Add show/hide deletion links if available
1509                 $canHide = $this->isAllowed( 'deleterevision' );
1510                 if ( $canHide || ( $file->getVisibility() && $this->isAllowed( 'deletedhistory' ) ) ) {
1511                         if ( !$file->userCan( File::DELETED_RESTRICTED, $user ) ) {
1512                                 // Revision was hidden from sysops
1513                                 $revdlink = Linker::revDeleteLinkDisabled( $canHide );
1514                         } else {
1515                                 $query = array(
1516                                         'type' => 'filearchive',
1517                                         'target' => $this->mTargetObj->getPrefixedDBkey(),
1518                                         'ids' => $row->fa_id
1519                                 );
1520                                 $revdlink = Linker::revDeleteLink( $query,
1521                                         $file->isDeleted( File::DELETED_RESTRICTED ), $canHide );
1522                         }
1523                 } else {
1524                         $revdlink = '';
1525                 }
1526
1527                 return "<li>$checkBox $revdlink $pageLink . . $userLink $data $comment</li>\n";
1528         }
1529
1530         /**
1531          * Fetch revision text link if it's available to all users
1532          *
1533          * @param Revision $rev
1534          * @param Title $titleObj
1535          * @param string $ts Timestamp
1536          * @return string
1537          */
1538         function getPageLink( $rev, $titleObj, $ts ) {
1539                 $user = $this->getUser();
1540                 $time = $this->getLanguage()->userTimeAndDate( $ts, $user );
1541
1542                 if ( !$rev->userCan( Revision::DELETED_TEXT, $user ) ) {
1543                         return '<span class="history-deleted">' . $time . '</span>';
1544                 }
1545
1546                 $link = Linker::linkKnown(
1547                         $titleObj,
1548                         htmlspecialchars( $time ),
1549                         array(),
1550                         array(
1551                                 'target' => $this->mTargetObj->getPrefixedText(),
1552                                 'timestamp' => $ts
1553                         )
1554                 );
1555
1556                 if ( $rev->isDeleted( Revision::DELETED_TEXT ) ) {
1557                         $link = '<span class="history-deleted">' . $link . '</span>';
1558                 }
1559
1560                 return $link;
1561         }
1562
1563         /**
1564          * Fetch image view link if it's available to all users
1565          *
1566          * @param File|ArchivedFile $file
1567          * @param Title $titleObj
1568          * @param string $ts A timestamp
1569          * @param string $key A storage key
1570          *
1571          * @return string HTML fragment
1572          */
1573         function getFileLink( $file, $titleObj, $ts, $key ) {
1574                 $user = $this->getUser();
1575                 $time = $this->getLanguage()->userTimeAndDate( $ts, $user );
1576
1577                 if ( !$file->userCan( File::DELETED_FILE, $user ) ) {
1578                         return '<span class="history-deleted">' . $time . '</span>';
1579                 }
1580
1581                 $link = Linker::linkKnown(
1582                         $titleObj,
1583                         htmlspecialchars( $time ),
1584                         array(),
1585                         array(
1586                                 'target' => $this->mTargetObj->getPrefixedText(),
1587                                 'file' => $key,
1588                                 'token' => $user->getEditToken( $key )
1589                         )
1590                 );
1591
1592                 if ( $file->isDeleted( File::DELETED_FILE ) ) {
1593                         $link = '<span class="history-deleted">' . $link . '</span>';
1594                 }
1595
1596                 return $link;
1597         }
1598
1599         /**
1600          * Fetch file's user id if it's available to this user
1601          *
1602          * @param File|ArchivedFile $file
1603          * @return string HTML fragment
1604          */
1605         function getFileUser( $file ) {
1606                 if ( !$file->userCan( File::DELETED_USER, $this->getUser() ) ) {
1607                         return '<span class="history-deleted">' .
1608                                 $this->msg( 'rev-deleted-user' )->escaped() .
1609                                 '</span>';
1610                 }
1611
1612                 $link = Linker::userLink( $file->getRawUser(), $file->getRawUserText() ) .
1613                         Linker::userToolLinks( $file->getRawUser(), $file->getRawUserText() );
1614
1615                 if ( $file->isDeleted( File::DELETED_USER ) ) {
1616                         $link = '<span class="history-deleted">' . $link . '</span>';
1617                 }
1618
1619                 return $link;
1620         }
1621
1622         /**
1623          * Fetch file upload comment if it's available to this user
1624          *
1625          * @param File|ArchivedFile $file
1626          * @return string HTML fragment
1627          */
1628         function getFileComment( $file ) {
1629                 if ( !$file->userCan( File::DELETED_COMMENT, $this->getUser() ) ) {
1630                         return '<span class="history-deleted"><span class="comment">' .
1631                                 $this->msg( 'rev-deleted-comment' )->escaped() . '</span></span>';
1632                 }
1633
1634                 $link = Linker::commentBlock( $file->getRawDescription() );
1635
1636                 if ( $file->isDeleted( File::DELETED_COMMENT ) ) {
1637                         $link = '<span class="history-deleted">' . $link . '</span>';
1638                 }
1639
1640                 return $link;
1641         }
1642
1643         function undelete() {
1644                 if ( $this->getConfig()->get( 'UploadMaintenance' )
1645                         && $this->mTargetObj->getNamespace() == NS_FILE
1646                 ) {
1647                         throw new ErrorPageError( 'undelete-error', 'filedelete-maintenance' );
1648                 }
1649
1650                 $this->checkReadOnly();
1651
1652                 $out = $this->getOutput();
1653                 $archive = new PageArchive( $this->mTargetObj, $this->getConfig() );
1654                 Hooks::run( 'UndeleteForm::undelete', array( &$archive, $this->mTargetObj ) );
1655                 $ok = $archive->undelete(
1656                         $this->mTargetTimestamp,
1657                         $this->mComment,
1658                         $this->mFileVersions,
1659                         $this->mUnsuppress,
1660                         $this->getUser()
1661                 );
1662
1663                 if ( is_array( $ok ) ) {
1664                         if ( $ok[1] ) { // Undeleted file count
1665                                 Hooks::run( 'FileUndeleteComplete', array(
1666                                         $this->mTargetObj, $this->mFileVersions,
1667                                         $this->getUser(), $this->mComment ) );
1668                         }
1669
1670                         $link = Linker::linkKnown( $this->mTargetObj );
1671                         $out->addHTML( $this->msg( 'undeletedpage' )->rawParams( $link )->parse() );
1672                 } else {
1673                         $out->setPageTitle( $this->msg( 'undelete-error' ) );
1674                 }
1675
1676                 // Show revision undeletion warnings and errors
1677                 $status = $archive->getRevisionStatus();
1678                 if ( $status && !$status->isGood() ) {
1679                         $out->addWikiText( '<div class="error">' .
1680                                 $status->getWikiText(
1681                                         'cannotundelete',
1682                                         'cannotundelete'
1683                                 ) . '</div>'
1684                         );
1685                 }
1686
1687                 // Show file undeletion warnings and errors
1688                 $status = $archive->getFileStatus();
1689                 if ( $status && !$status->isGood() ) {
1690                         $out->addWikiText( '<div class="error">' .
1691                                 $status->getWikiText(
1692                                         'undelete-error-short',
1693                                         'undelete-error-long'
1694                                 ) . '</div>'
1695                         );
1696                 }
1697         }
1698
1699         /**
1700          * Return an array of subpages beginning with $search that this special page will accept.
1701          *
1702          * @param string $search Prefix to search for
1703          * @param int $limit Maximum number of results to return (usually 10)
1704          * @param int $offset Number of results to skip (usually 0)
1705          * @return string[] Matching subpages
1706          */
1707         public function prefixSearchSubpages( $search, $limit, $offset ) {
1708                 $title = Title::newFromText( $search );
1709                 if ( !$title || !$title->canExist() ) {
1710                         // No prefix suggestion in special and media namespace
1711                         return array();
1712                 }
1713                 // Autocomplete subpage the same as a normal search
1714                 $prefixSearcher = new StringPrefixSearch;
1715                 $result = $prefixSearcher->search( $search, $limit, array(), $offset );
1716                 return $result;
1717         }
1718
1719         protected function getGroupName() {
1720                 return 'pagetools';
1721         }
1722 }