includes/SpecialUndelete.php

   1 <?php
   2 /**
   3  * @todo document
   4  * @package MediaWiki
   5  * @subpackage SpecialPage
   6  */
   7
   8 /** */
   9 require_once( 'Revision.php' );
  10
  11 /**
  12  *
  13  */
  14 function wfSpecialUndelete( $par ) {
  15     global $wgRequest;
  16
  17         $form = new UndeleteForm( $wgRequest, $par );
  18         $form->execute();
  19 }
  20
  21 /**
  22  *
  23  * @package MediaWiki
  24  * @subpackage SpecialPage
  25  */
  26 class PageArchive {
  27         var $title;
  28
  29         function PageArchive( &$title ) {
  30                 if( is_null( $title ) ) {
  31                         wfDebugDieBacktrace( 'Archiver() given a null title.');
  32                 }
  33                 $this->title =& $title;
  34         }
  35
  36         /**
  37          * List all deleted pages recorded in the archive table. Returns result
  38          * wrapper with (ar_namespace, ar_title, count) fields, ordered by page
  39          * namespace/title. Can be called staticaly.
  40          *
  41          * @return ResultWrapper
  42          */
  43         /* static */ function &listAllPages() {
  44                 $dbr =& wfGetDB( DB_SLAVE );
  45                 $archive = $dbr->tableName( 'archive' );
  46
  47                 $sql = "SELECT ar_namespace,ar_title, COUNT(*) AS count FROM $archive " .
  48                   "GROUP BY ar_namespace,ar_title ORDER BY ar_namespace,ar_title";
  49
  50                 return $dbr->resultObject( $dbr->query( $sql, 'PageArchive::listAllPages' ) );
  51         }
  52
  53         /**
  54          * List the revisions of the given page. Returns result wrapper with
  55          * (ar_minor_edit, ar_timestamp, ar_user, ar_user_text, ar_comment) fields.
  56          *
  57          * @return ResultWrapper
  58          */
  59         function &listRevisions() {
  60                 $dbr =& wfGetDB( DB_SLAVE );
  61                 return $dbr->resultObject( $dbr->select( 'archive',
  62                         array( 'ar_minor_edit', 'ar_timestamp', 'ar_user', 'ar_user_text', 'ar_comment' ),
  63                         array( 'ar_namespace' => $this->title->getNamespace(),
  64                                'ar_title' => $this->title->getDBkey() ),
  65                         'PageArchive::listRevisions',
  66                         array( 'ORDER BY' => 'ar_timestamp DESC' ) ) );
  67         }
  68
  69         /**
  70          * Fetch (and decompress if necessary) the stored text for the deleted
  71          * revision of the page with the given timestamp.
  72          *
  73          * @return string
  74          */
  75         function getRevisionText( $timestamp ) {
  76                 $dbr =& wfGetDB( DB_SLAVE );
  77                 $row = $dbr->selectRow( 'archive',
  78                         array( 'ar_text', 'ar_flags' ),
  79                         array( 'ar_namespace' => $this->title->getNamespace(),
  80                                'ar_title' => $this->title->getDbkey(),
  81                                'ar_timestamp' => $dbr->timestamp( $timestamp ) ) );
  82                 return Revision::getRevisionText( $row, "ar_" );
  83         }
  84
  85         /**
  86          * Fetch (and decompress if necessary) the stored text of the most
  87          * recently edited deleted revision of the page.
  88          *
  89          * If there are no archived revisions for the page, returns NULL.
  90          *
  91          * @return string
  92          */
  93         function getLastRevisionText() {
  94                 $dbr =& wfGetDB( DB_SLAVE );
  95                 $row = $dbr->selectRow( 'archive',
  96                         array( 'ar_text', 'ar_flags' ),
  97                         array( 'ar_namespace' => $this->title->getNamespace(),
  98                                'ar_title' => $this->title->getDBkey() ),
  99                         'PageArchive::getLastRevisionText',
 100                         'ORDER BY ar_timestamp DESC LIMIT 1' );
 101                 if( $row ) {
 102                         return Revision::getRevisionText( $row, "ar_" );
 103                 } else {
 104                         return NULL;
 105                 }
 106         }
 107
 108         /**
 109          * Quick check if any archived revisions are present for the page.
 110          * @return bool
 111          */
 112         function isDeleted() {
 113                 $dbr =& wfGetDB( DB_SLAVE );
 114                 $n = $dbr->selectField( 'archive', 'COUNT(ar_title)',
 115                         array( 'ar_namespace' => $this->title->getNamespace(),
 116                                'ar_title' => $this->title->getDBkey() ) );
 117                 return ($n > 0);
 118         }
 119
 120         /**
 121          * This is the meaty bit -- restores archived revisions of the given page
 122          * to the cur/old tables. If the page currently exists, all revisions will
 123          * be stuffed into old, otherwise the most recent will go into cur.
 124          * The deletion log will be updated with an undeletion notice.
 125          *
 126          * Returns true on success.
 127          *
 128          * @param array $timestamps Pass an empty array to restore all revisions, otherwise list the ones to undelete.
 129          * @return bool
 130          */
 131         function undelete( $timestamps ) {
 132                 global $wgUser, $wgOut, $wgLang, $wgDeferredUpdateList;
 133                 global $wgUseSquid, $wgInternalServer, $wgLinkCache;
 134
 135                 $fname = "doUndeleteArticle";
 136                 $restoreAll = empty( $timestamps );
 137                 $restoreRevisions = count( $timestamps );
 138
 139                 $dbw =& wfGetDB( DB_MASTER );
 140                 extract( $dbw->tableNames( 'cur', 'archive', 'old' ) );
 141                 $namespace = $this->title->getNamespace();
 142                 $ttl = $this->title->getDBkey();
 143                 $t = $dbw->strencode( $ttl );
 144
 145                 # Move article and history from the "archive" table
 146                 $sql = "SELECT COUNT(*) AS count FROM $cur WHERE cur_namespace={$namespace} AND cur_title='{$t}'";
 147                 global $wgDBtype;
 148                 if( $wgDBtype != 'PostgreSQL' ) { # HACKHACKHACKHACK
 149                         $sql .= ' FOR UPDATE';
 150                 }
 151                 $res = $dbw->query( $sql, $fname );
 152                 $row = $dbw->fetchObject( $res );
 153                 $now = wfTimestampNow();
 154
 155                 if( $row->count == 0) {
 156                         # Have to create new article...
 157                         $sql = "SELECT ar_text,ar_comment,ar_user,ar_user_text,ar_timestamp,ar_minor_edit,ar_flags FROM $archive WHERE ar_namespace={$namespace} AND ar_title='{$t}' ";
 158                         if( !$restoreAll ) {
 159                                 $max = $dbw->addQuotes( $dbw->timestamp( array_shift( $timestamps ) ) );
 160                                 $sql .= "AND ar_timestamp={$max} ";
 161                         }
 162                         $sql .= "ORDER BY ar_timestamp DESC LIMIT 1 FOR UPDATE";
 163                         $res = $dbw->query( $sql, $fname );
 164                         $s = $dbw->fetchObject( $res );
 165                         if( $restoreAll ) {
 166                                 $max = $s->ar_timestamp;
 167                         }
 168                         $text = Revision::getRevisionText( $s, "ar_" );
 169
 170                         $redirect = MagicWord::get( MAG_REDIRECT );
 171                         $redir = $redirect->matchStart( $text ) ? 1 : 0;
 172
 173                         $rand = wfRandom();
 174                         $dbw->insert( 'cur', array(
 175                                 'cur_id' => $dbw->nextSequenceValue( 'cur_cur_id_seq' ),
 176                                 'cur_namespace' => $namespace,
 177                                 'cur_title' => $ttl,
 178                                 'cur_text' => $text,
 179                                 'cur_comment' => $s->ar_comment,
 180                                 'cur_user' => $s->ar_user,
 181                                 'cur_timestamp' => $s->ar_timestamp,
 182                                 'cur_minor_edit' => $s->ar_minor_edit,
 183                                 'cur_user_text' => $s->ar_user_text,
 184                                 'cur_is_redirect' => $redir,
 185                                 'cur_random' => $rand,
 186                                 'cur_touched' => $dbw->timestamp( $now ),
 187                                 'inverse_timestamp' => wfInvertTimestamp( wfTimestamp( TS_MW, $s->ar_timestamp ) ),
 188                         ), $fname );
 189
 190                         $newid = $dbw->insertId();
 191                         if( $restoreAll ) {
 192                                 $oldones = "AND ar_timestamp<" . $dbw->addQuotes( $dbw->timestamp( $max ) );
 193                         }
 194                 } else {
 195                         # If already exists, put history entirely into old table
 196                         $oldones = "";
 197                         $newid = 0;
 198
 199                         # But to make the history list show up right, we need to touch it.
 200                         $sql = "UPDATE $cur SET cur_touched='{$now}' WHERE cur_namespace={$namespace} AND cur_title='{$t}'";
 201                         $dbw->query( $sql, $fname );
 202
 203                         # FIXME: Sometimes restored entries will be _newer_ than the current version.
 204                         # We should merge.
 205                 }
 206
 207                 if( !$restoreAll ) {
 208                         $oldts = array();
 209                         foreach( $timestamps as $ts ) {
 210                                 array_push( $oldts, $dbw->addQuotes( $dbw->timestamp( $ts ) ) );
 211                         }
 212                         $oldts = join( ",", $oldts );
 213                         $oldones = "AND ar_timestamp IN ( {$oldts} )";
 214                 }
 215                 $sql = "INSERT INTO $old (old_namespace,old_title,old_text," .
 216                   "old_comment,old_user,old_user_text,old_timestamp,inverse_timestamp,old_minor_edit," .
 217                   "old_flags) SELECT ar_namespace,ar_title,ar_text,ar_comment," .
 218                   "ar_user,ar_user_text,ar_timestamp,99999999999999-ar_timestamp,ar_minor_edit,ar_flags " .
 219                   "FROM $archive WHERE ar_namespace={$namespace} AND ar_title='{$t}' {$oldones}";
 220                 if( $restoreAll || !empty( $oldts ) ) {
 221                         $dbw->query( $sql, $fname );
 222                 }
 223
 224                 # Finally, clean up the link tables
 225                 if( $newid ) {
 226                         $wgLinkCache = new LinkCache();
 227                         # Select for update
 228                         $wgLinkCache->forUpdate( true );
 229                         # Create a dummy OutputPage to update the outgoing links
 230                         $dummyOut = new OutputPage();
 231                         $dummyOut->addWikiText( $text );
 232
 233                         $u = new LinksUpdate( $newid, $this->title->getPrefixedDBkey() );
 234                         array_push( $wgDeferredUpdateList, $u );
 235
 236                         Article::onArticleCreate( $this->title );
 237
 238                         #TODO: SearchUpdate, etc.
 239                 }
 240
 241                 # Now that it's safely stored, take it out of the archive
 242                 $sql = "DELETE FROM $archive WHERE ar_namespace={$namespace} AND " .
 243                   "ar_title='{$t}'";
 244                 if( !$restoreAll ) {
 245                         $sql .= " AND ar_timestamp IN ( {$oldts}";
 246                         if( $newid ) {
 247                                 if( !empty( $oldts ) ) $sql .= ",";
 248                                 $sql .= $max;
 249                         }
 250                         $sql .= ")";
 251                 }
 252                 $dbw->query( $sql, $fname );
 253
 254
 255                 # Touch the log?
 256                 $log = new LogPage( 'delete' );
 257                 if( $restoreAll ) {
 258                         $reason = "";
 259                 } else {
 260                         $reason = wfMsg( 'undeletedrevisions', $restoreRevisions );
 261                 }
 262                 $log->addEntry( 'restore', $this->title, $reason );
 263
 264                 return true;
 265         }
 266 }
 267
 268 /**
 269  *
 270  * @package MediaWiki
 271  * @subpackage SpecialPage
 272  */
 273 class UndeleteForm {
 274         var $mAction, $mTarget, $mTimestamp, $mRestore, $mTargetObj;
 275         var $mTargetTimestamp;
 276
 277         function UndeleteForm( &$request, $par = "" ) {
 278                 $this->mAction = $request->getText( 'action' );
 279                 $this->mTarget = $request->getText( 'target' );
 280                 $this->mTimestamp = $request->getText( 'timestamp' );
 281                 $this->mRestore = $request->getCheck( 'restore' ) && $request->wasPosted();
 282                 if( $par != "" ) {
 283                         $this->mTarget = $par;
 284                 }
 285                 if ( $this->mTarget !== "" ) {
 286                         $this->mTargetObj = Title::newFromURL( $this->mTarget );
 287                 } else {
 288                         $this->mTargetObj = NULL;
 289                 }
 290                 if( $this->mRestore ) {
 291                         $timestamps = array();
 292                         foreach( $_REQUEST as $key => $val ) {
 293                                 if( preg_match( '/^ts(\d{14})$/', $key, $matches ) ) {
 294                                         array_push( $timestamps, $matches[1] );
 295                                 }
 296                         }
 297                         rsort( $timestamps );
 298                         $this->mTargetTimestamp = $timestamps;
 299                 }
 300         }
 301
 302         function execute() {
 303                 if( is_null( $this->mTargetObj ) ) {
 304                         return $this->showList();
 305                 }
 306                 if( $this->mTimestamp !== "" ) {
 307                         return $this->showRevision( $this->mTimestamp );
 308                 }
 309                 if( $this->mRestore && $this->mAction == "submit" ) {
 310                         return $this->undelete();
 311                 }
 312                 return $this->showHistory();
 313         }
 314
 315         /* private */ function showList() {
 316                 global $wgLang, $wgContLang, $wgUser, $wgOut;
 317                 $fname = "UndeleteForm::showList";
 318
 319                 # List undeletable articles
 320                 $result = PageArchive::listAllPages();
 321
 322                 $wgOut->setPagetitle( wfMsg( "undeletepage" ) );
 323                 $wgOut->addWikiText( wfMsg( "undeletepagetext" ) );
 324
 325                 $sk = $wgUser->getSkin();
 326                 $undelete =& Title::makeTitle( NS_SPECIAL, 'Undelete' );
 327                 $wgOut->addHTML( "<ul>\n" );
 328                 while( $row = $result->fetchObject() ) {
 329                         $n = ($row->ar_namespace ?
 330                                 ($wgContLang->getNsText( $row->ar_namespace ) . ":") : "").
 331                                 $row->ar_title;
 332                         $link = $sk->makeKnownLinkObj( $undelete,
 333                                 htmlspecialchars( $n ), "target=" . urlencode( $n ) );
 334                         $revisions = htmlspecialchars( wfMsg( "undeleterevisions",
 335                                 $wgLang->formatNum( $row->count ) ) );
 336                         $wgOut->addHTML( "<li>$link $revisions</li>\n" );
 337                 }
 338                 $result->free();
 339                 $wgOut->addHTML( "</ul>\n" );
 340
 341                 return true;
 342         }
 343
 344         /* private */ function showRevision( $timestamp ) {
 345                 global $wgLang, $wgUser, $wgOut;
 346                 $fname = "UndeleteForm::showRevision";
 347
 348                 if(!preg_match("/[0-9]{14}/",$timestamp)) return 0;
 349
 350                 $archive =& new PageArchive( $this->mTargetObj );
 351                 $text = $archive->getRevisionText( $timestamp );
 352
 353                 $wgOut->setPagetitle( wfMsg( "undeletepage" ) );
 354                 $wgOut->addWikiText( "(" . wfMsg( "undeleterevision",
 355                         $wgLang->date( $timestamp ) ) . ")\n<hr />\n" . $text );
 356         }
 357
 358         /* private */ function showHistory() {
 359                 global $wgLang, $wgUser, $wgOut;
 360
 361                 $sk = $wgUser->getSkin();
 362                 $wgOut->setPagetitle( wfMsg( "undeletepage" ) );
 363
 364                 $archive = new PageArchive( $this->mTargetObj );
 365                 $text = $archive->getLastRevisionText();
 366                 if( is_null( $text ) ) {
 367                         $wgOut->addWikiText( wfMsg( "nohistory" ) );
 368                         return;
 369                 }
 370                 $wgOut->addWikiText( wfMsg( "undeletehistory" ) . "\n----\n" . $text );
 371
 372                 # List all stored revisions
 373                 $revisions = $archive->listRevisions();
 374
 375                 $titleObj = Title::makeTitle( NS_SPECIAL, "Undelete" );
 376                 $action = $titleObj->escapeLocalURL( "action=submit" );
 377                 $encTarget = htmlspecialchars( $this->mTarget );
 378                 $button = htmlspecialchars( wfMsg("undeletebtn") );
 379
 380                 $wgOut->addHTML("
 381         <form id=\"undelete\" method=\"post\" action=\"{$action}\">
 382         <input type=\"hidden\" name=\"target\" value=\"{$encTarget}\" />
 383         <input type=\"submit\" name=\"restore\" value=\"{$button}\" />
 384         ");
 385
 386                 # Show relevant lines from the deletion log:
 387                 $wgOut->addHTML( "<h2>" . htmlspecialchars( LogPage::logName( 'delete' ) ) . "</h2>\n" );
 388                 require_once( 'SpecialLog.php' );
 389                 $logViewer =& new LogViewer(
 390                         new LogReader(
 391                                 new FauxRequest(
 392                                         array( 'page' => $this->mTargetObj->getPrefixedText(),
 393                                                'type' => 'delete' ) ) ) );
 394                 $logViewer->showList( $wgOut );
 395
 396                 # The page's stored (deleted) history:
 397                 $wgOut->addHTML( "<h2>" . htmlspecialchars( wfMsg( "history" ) ) . "</h2>\n" );
 398                 $wgOut->addHTML("<ul>");
 399                 $target = urlencode( $this->mTarget );
 400                 while( $row = $revisions->fetchObject() ) {
 401                         $ts = wfTimestamp( TS_MW, $row->ar_timestamp );
 402                         $checkBox = "<input type=\"checkbox\" name=\"ts$ts\" value=\"1\" />";
 403                         $pageLink = $sk->makeKnownLinkObj( $titleObj,
 404                                 $wgLang->timeanddate( $row->ar_timestamp, true ),
 405                                 "target=$target&timestamp=$ts" );
 406                         $userLink = htmlspecialchars( $row->ar_user_text );
 407                         if( $row->ar_user ) {
 408                                 $userLink = $sk->makeKnownLinkObj(
 409                                         Title::makeTitle( NS_USER, $row->ar_user_text ),
 410                                         $userLink );
 411                         }
 412                         $comment = $sk->formatComment( $row->ar_comment );
 413                         $wgOut->addHTML( "<li>$checkBox $pageLink . . $userLink (<i>$comment</i>)</li>\n" );
 414
 415                 }
 416                 $revisions->free();
 417                 $wgOut->addHTML("</ul>\n</form>");
 418
 419                 return true;
 420         }
 421
 422         function undelete() {
 423                 global $wgOut;
 424                 if( !is_null( $this->mTargetObj ) ) {
 425                         $archive = new PageArchive( $this->mTargetObj );
 426                         if( $archive->undelete( $this->mTargetTimestamp ) ) {
 427                                 $wgOut->addWikiText( wfMsg( "undeletedtext", $this->mTarget ) );
 428                                 return true;
 429                         }
 430                 }
 431                 $wgOut->fatalError( wfMsg( "cannotundelete" ) );
 432                 return false;
 433         }
 434 }
 435
 436 ?>