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