begin cleanup on magnus' url upload thingy
[lhc/web/wiklou.git] / includes / SpecialUndelete.php
index 7d55e0a..e01e36d 100644 (file)
@@ -1,13 +1,13 @@
 <?php
+
 /**
- * @todo document
+ * Special page allowing users with the appropriate permissions to view
+ * and restore deleted content
+ *
  * @package MediaWiki
- * @subpackage SpecialPage
+ * @subpackage Special pages
  */
 
-/** */
-require_once( 'Revision.php' );
-
 /**
  *
  */
@@ -28,7 +28,7 @@ class PageArchive {
 
        function PageArchive( &$title ) {
                if( is_null( $title ) ) {
-                       wfDebugDieBacktrace( 'Archiver() given a null title.');
+                       throw new MWException( 'Archiver() given a null title.');
                }
                $this->title =& $title;
        }
@@ -67,6 +67,39 @@ class PageArchive {
                $ret = $dbr->resultObject( $res );
                return $ret;
        }
+       
+       /**
+        * List the deleted file revisions for this page, if it's a file page.
+        * Returns a result wrapper with various filearchive fields, or null
+        * if not a file page.
+        *
+        * @return ResultWrapper
+        * @fixme Does this belong in Image for fuller encapsulation?
+        */
+       function listFiles() {
+               $fname = __CLASS__ . '::' . __FUNCTION__;
+               if( $this->title->getNamespace() == NS_IMAGE ) {
+                       $dbr =& wfGetDB( DB_SLAVE );
+                       $res = $dbr->select( 'filearchive',
+                               array(
+                                       'fa_id',
+                                       'fa_name',
+                                       'fa_storage_key',
+                                       'fa_size',
+                                       'fa_width',
+                                       'fa_height',
+                                       'fa_description',
+                                       'fa_user',
+                                       'fa_user_text',
+                                       'fa_timestamp' ),
+                               array( 'fa_name' => $this->title->getDbKey() ),
+                               $fname,
+                               array( 'ORDER BY' => 'fa_timestamp DESC' ) );
+                       $ret = $dbr->resultObject( $res );
+                       return $ret;
+               }
+               return null;
+       }
 
        /**
         * Fetch (and decompress if necessary) the stored text for the deleted
@@ -83,7 +116,11 @@ class PageArchive {
                               'ar_title' => $this->title->getDbkey(),
                               'ar_timestamp' => $dbr->timestamp( $timestamp ) ),
                        $fname );
-               return $this->getTextFromRow( $row );
+               if( $row ) {
+                       return $this->getTextFromRow( $row );
+               } else {
+                       return null;
+               }
        }
 
        /**
@@ -143,30 +180,87 @@ class PageArchive {
                return ($n > 0);
        }
 
+       /**
+        * Restore the given (or all) text and file revisions for the page.
+        * Once restored, the items will be removed from the archive tables.
+        * The deletion log will be updated with an undeletion notice.
+        *
+        * @param array $timestamps Pass an empty array to restore all revisions, otherwise list the ones to undelete.
+        * @param string $comment
+        * @param array $fileVersions
+        *
+        * @return true on success.
+        */
+       function undelete( $timestamps, $comment = '', $fileVersions = array() ) {
+               // If both the set of text revisions and file revisions are empty,
+               // restore everything. Otherwise, just restore the requested items.
+               $restoreAll = empty( $timestamps ) && empty( $fileVersions );
+               
+               $restoreText = $restoreAll || !empty( $timestamps );
+               $restoreFiles = $restoreAll || !empty( $fileVersions );
+               
+               if( $restoreFiles && $this->title->getNamespace() == NS_IMAGE ) {
+                       $img = new Image( $this->title );
+                       $filesRestored = $img->restore( $fileVersions );
+               } else {
+                       $filesRestored = 0;
+               }
+               
+               if( $restoreText ) {
+                       $textRestored = $this->undeleteRevisions( $timestamps );
+               } else {
+                       $textRestored = 0;
+               }
+               
+               // Touch the log!
+               global $wgContLang;
+               $log = new LogPage( 'delete' );
+               
+               if( $textRestored && $filesRestored ) {
+                       $reason = wfMsgForContent( 'undeletedrevisions-files',
+                               $wgContLang->formatNum( $textRestored ),
+                               $wgContLang->formatNum( $filesRestored ) );
+               } elseif( $textRestored ) {
+                       $reason = wfMsgForContent( 'undeletedrevisions',
+                               $wgContLang->formatNum( $textRestored ) );
+               } elseif( $filesRestored ) {
+                       $reason = wfMsgForContent( 'undeletedfiles',
+                               $wgContLang->formatNum( $filesRestored ) );
+               } else {
+                       wfDebug( "Undelete: nothing undeleted...\n" );
+                       return false;
+               }
+               
+               if( trim( $comment ) != '' )
+                       $reason .= ": {$comment}";
+               $log->addEntry( 'restore', $this->title, $reason );
+               
+               return true;
+       }
+       
        /**
         * This is the meaty bit -- restores archived revisions of the given page
         * to the cur/old tables. If the page currently exists, all revisions will
         * be stuffed into old, otherwise the most recent will go into cur.
-        * The deletion log will be updated with an undeletion notice.
-        *
-        * Returns true on success.
         *
         * @param array $timestamps Pass an empty array to restore all revisions, otherwise list the ones to undelete.
-        * @return bool
+        * @param string $comment
+        * @param array $fileVersions
+        *
+        * @return int number of revisions restored
         */
-       function undelete( $timestamps ) {
-               global $wgDeferredUpdateList, $wgParser, $wgDBtype;
+       private function undeleteRevisions( $timestamps ) {
+               global $wgParser, $wgDBtype;
 
-               $fname = "doUndeleteArticle";
+               $fname = __CLASS__ . '::' . __FUNCTION__;
                $restoreAll = empty( $timestamps );
-               $restoreRevisions = count( $timestamps );
-
+               
                $dbw =& wfGetDB( DB_MASTER );
                extract( $dbw->tableNames( 'page', 'archive' ) );
 
                # Does this page already exist? We'll have to update it...
                $article = new Article( $this->title );
-               $options = ( $wgDBtype == 'PostgreSQL' )
+               $options = ( $wgDBtype == 'postgres' )
                        ? '' // pg doesn't support this?
                        : 'FOR UPDATE';
                $page = $dbw->selectRow( 'page',
@@ -221,8 +315,14 @@ class PageArchive {
                        /* options */ array(
                                'ORDER BY' => 'ar_timestamp' )
                        );
+               if( $dbw->numRows( $result ) < count( $timestamps ) ) {
+                       wfDebug( "$fname: couldn't find all requested rows\n" );
+                       return false;
+               }
+               
                $revision = null;
                $newRevId = $previousRevId;
+               $restored = 0;
 
                while( $row = $dbw->fetchObject( $result ) ) {
                        if( $row->ar_text_id ) {
@@ -249,6 +349,7 @@ class PageArchive {
                                'text_id'    => $row->ar_text_id,
                                ) );
                        $newRevId = $revision->insertOn( $dbw );
+                       $restored++;
                }
 
                if( $revision ) {
@@ -284,17 +385,9 @@ class PageArchive {
                                $oldones ),
                        $fname );
 
-               # Touch the log!
-               $log = new LogPage( 'delete' );
-               if( $restoreAll ) {
-                       $reason = '';
-               } else {
-                       $reason = wfMsgForContent( 'undeletedrevisions', $restoreRevisions );
-               }
-               $log->addEntry( 'restore', $this->title, $reason );
-
-               return true;
+               return $restored;
        }
+
 }
 
 /**
@@ -304,18 +397,20 @@ class PageArchive {
  */
 class UndeleteForm {
        var $mAction, $mTarget, $mTimestamp, $mRestore, $mTargetObj;
-       var $mTargetTimestamp, $mAllowed;
+       var $mTargetTimestamp, $mAllowed, $mComment;
 
        function UndeleteForm( &$request, $par = "" ) {
                global $wgUser;
                $this->mAction = $request->getText( 'action' );
                $this->mTarget = $request->getText( 'target' );
                $this->mTimestamp = $request->getText( 'timestamp' );
+               $this->mFile = $request->getVal( 'file' );
                
                $posted = $request->wasPosted() &&
                        $wgUser->matchEditToken( $request->getVal( 'wpEditToken' ) );
                $this->mRestore = $request->getCheck( 'restore' ) && $posted;
                $this->mPreview = $request->getCheck( 'preview' ) && $posted;
+               $this->mComment = $request->getText( 'wpComment' );
                
                if( $par != "" ) {
                        $this->mTarget = $par;
@@ -334,10 +429,15 @@ class UndeleteForm {
                }
                if( $this->mRestore ) {
                        $timestamps = array();
+                       $this->mFileVersions = array();
                        foreach( $_REQUEST as $key => $val ) {
                                if( preg_match( '/^ts(\d{14})$/', $key, $matches ) ) {
                                        array_push( $timestamps, $matches[1] );
                                }
+                               
+                               if( preg_match( '/^fileid(\d+)$/', $key, $matches ) ) {
+                                       $this->mFileVersions[] = intval( $matches[1] );
+                               }
                        }
                        rsort( $timestamps );
                        $this->mTargetTimestamp = $timestamps;
@@ -352,6 +452,9 @@ class UndeleteForm {
                if( $this->mTimestamp !== '' ) {
                        return $this->showRevision( $this->mTimestamp );
                }
+               if( $this->mFile !== null ) {
+                       return $this->showFile( $this->mFile );
+               }
                if( $this->mRestore && $this->mAction == "submit" ) {
                        return $this->undelete();
                }
@@ -383,7 +486,7 @@ class UndeleteForm {
                                htmlspecialchars( $n ), "target=" . urlencode( $n ) );
                        $revisions = htmlspecialchars( wfMsg( "undeleterevisions",
                                $wgLang->formatNum( $row->count ) ) );
-                       $wgOut->addHTML( "<li>$link $revisions</li>\n" );
+                       $wgOut->addHTML( "<li>$link ($revisions)</li>\n" );
                }
                $result->free();
                $wgOut->addHTML( "</ul>\n" );
@@ -397,7 +500,7 @@ class UndeleteForm {
 
                if(!preg_match("/[0-9]{14}/",$timestamp)) return 0;
 
-               $archive =& new PageArchive( $this->mTargetObj );
+               $archive = new PageArchive( $this->mTargetObj );
                $text = $archive->getRevisionText( $timestamp );
 
                $wgOut->setPagetitle( wfMsg( "undeletepage" ) );
@@ -416,7 +519,7 @@ class UndeleteForm {
                                        'readonly' => true,
                                        'cols' => intval( $wgUser->getOption( 'cols' ) ),
                                        'rows' => intval( $wgUser->getOption( 'rows' ) ) ),
-                               $text ) .
+                               $text . "\n" ) .
                        wfOpenElement( 'div' ) .
                        wfOpenElement( 'form', array(
                                'method' => 'post',
@@ -424,7 +527,7 @@ class UndeleteForm {
                        wfElement( 'input', array(
                                'type' => 'hidden',
                                'name' => 'target',
-                               'value' => $this->mTargetObj->getPrefixedUrl() ) ) .
+                               'value' => $this->mTargetObj->getPrefixedDbKey() ) ) .
                        wfElement( 'input', array(
                                'type' => 'hidden',
                                'name' => 'timestamp',
@@ -439,10 +542,21 @@ class UndeleteForm {
                                'value' => '1' ) ) .
                        wfElement( 'input', array(
                                'type' => 'submit',
-                               'value' => wfMsg( 'preview' ) ) ) .
+                               'value' => wfMsg( 'showpreview' ) ) ) .
                        wfCloseElement( 'form' ) .
                        wfCloseElement( 'div' ) );
        }
+       
+       /**
+        * Show a deleted file version requested by the visitor.
+        */
+       function showFile( $key ) {
+               global $wgOut;
+               $wgOut->disable();
+               
+               $store = FileStore::get( 'deleted' );
+               $store->stream( $key );
+       }
 
        /* private */ function showHistory() {
                global $wgLang, $wgUser, $wgOut;
@@ -456,10 +570,12 @@ class UndeleteForm {
 
                $archive = new PageArchive( $this->mTargetObj );
                $text = $archive->getLastRevisionText();
+               /*
                if( is_null( $text ) ) {
                        $wgOut->addWikiText( wfMsg( "nohistory" ) );
                        return;
                }
+               */
                if ( $this->mAllowed ) {
                        $wgOut->addWikiText( wfMsg( "undeletehistory" ) );
                } else {
@@ -468,86 +584,152 @@ class UndeleteForm {
 
                # List all stored revisions
                $revisions = $archive->listRevisions();
+               $files = $archive->listFiles();
+               
+               $haveRevisions = $revisions && $revisions->numRows() > 0;
+               $haveFiles = $files && $files->numRows() > 0;
+               
+               # Batch existence check on user and talk pages
+               if( $haveRevisions ) {
+                       $batch = new LinkBatch();
+                       while( $row = $revisions->fetchObject() ) {
+                               $batch->addObj( Title::makeTitleSafe( NS_USER, $row->ar_user_text ) );
+                               $batch->addObj( Title::makeTitleSafe( NS_USER_TALK, $row->ar_user_text ) );
+                       }
+                       $batch->execute();
+                       $revisions->seek( 0 );
+               }
+               if( $haveFiles ) {
+                       $batch = new LinkBatch();
+                       while( $row = $files->fetchObject() ) {
+                               $batch->addObj( Title::makeTitleSafe( NS_USER, $row->fa_user_text ) );
+                               $batch->addObj( Title::makeTitleSafe( NS_USER_TALK, $row->fa_user_text ) );
+                       }
+                       $batch->execute();
+                       $files->seek( 0 );
+               }
 
                if ( $this->mAllowed ) {
                        $titleObj = Title::makeTitle( NS_SPECIAL, "Undelete" );
-                       $action = $titleObj->escapeLocalURL( "action=submit" );
-                       $encTarget = htmlspecialchars( $this->mTarget );
-                       $button = htmlspecialchars( wfMsg("undeletebtn") );
-                       $token = htmlspecialchars( $wgUser->editToken() );
-
-                       $wgOut->addHTML("
-                               <form id=\"undelete\" method=\"post\" action=\"{$action}\">
-                               <input type=\"hidden\" name=\"target\" value=\"{$encTarget}\" />
-                               <input type=\"submit\" name=\"restore\" value=\"{$button}\" />
-                               <input type='hidden' name='wpEditToken' value=\"{$token}\" />
-                               ");
+                       $action = $titleObj->getLocalURL( "action=submit" );
+                       # Start the form here
+                       $top = wfOpenElement( 'form', array( 'method' => 'post', 'action' => $action, 'id' => 'undelete' ) );
+                       $wgOut->addHtml( $top );
                }
 
                # Show relevant lines from the deletion log:
                $wgOut->addHTML( "<h2>" . htmlspecialchars( LogPage::logName( 'delete' ) ) . "</h2>\n" );
                require_once( 'SpecialLog.php' );
-               $logViewer =& new LogViewer(
+               $logViewer = new LogViewer(
                        new LogReader(
                                new FauxRequest(
                                        array( 'page' => $this->mTargetObj->getPrefixedText(),
-                                              'type' => 'delete' ) ) ) );
+                                                  'type' => 'delete' ) ) ) );
                $logViewer->showList( $wgOut );
-
-               # The page's stored (deleted) history:
+               
+               if( $this->mAllowed && ( $haveRevisions || $haveFiles ) ) {
+                       # Format the user-visible controls (comment field, submission button)
+                       # in a nice little table
+                       $table = '<fieldset><table><tr>';
+                       $table .= '<td colspan="2">' . wfMsgWikiHtml( 'undeleteextrahelp' ) . '</td></tr><tr>';
+                       $table .= '<td align="right"><strong>' . wfMsgHtml( 'undeletecomment' ) . '</strong></td>';
+                       $table .= '<td>' . wfInput( 'wpComment', 50, $this->mComment ) . '</td>';
+                       $table .= '</tr><tr><td>&nbsp;</td><td>';
+                       $table .= wfSubmitButton( wfMsg( 'undeletebtn' ), array( 'name' => 'restore' ) );
+                       $table .= wfElement( 'input', array( 'type' => 'reset', 'value' => wfMsg( 'undeletereset' ) ) );
+                       $table .= '</td></tr></table></fieldset>';
+                       $wgOut->addHtml( $table );
+               }
+       
                $wgOut->addHTML( "<h2>" . htmlspecialchars( wfMsg( "history" ) ) . "</h2>\n" );
-               $wgOut->addHTML("<ul>");
-               $target = urlencode( $this->mTarget );
-               while( $row = $revisions->fetchObject() ) {
-                       $ts = wfTimestamp( TS_MW, $row->ar_timestamp );
-                       if ( $this->mAllowed ) {
-                               $checkBox = "<input type=\"checkbox\" name=\"ts$ts\" value=\"1\" />";
-                               $pageLink = $sk->makeKnownLinkObj( $titleObj,
-                                       $wgLang->timeanddate( $ts, true ),
-                                       "target=$target&timestamp=$ts" );
-                       } else {
-                               $checkBox = '';
-                               $pageLink = $wgLang->timeanddate( $ts, true );
-                       }
-                       $userLink = htmlspecialchars( $row->ar_user_text );
-                       if( $row->ar_user ) {
-                               $userLink = $sk->makeKnownLinkObj(
-                                       Title::makeTitle( NS_USER, $row->ar_user_text ),
-                                       $userLink );
-                       } else {
-                               $userLink = $sk->makeKnownLinkObj(
-                                       Title::makeTitle( NS_SPECIAL, 'Contributions' ),
-                                       $userLink, 'target=' . $row->ar_user_text );
+               
+               if( $haveRevisions ) {
+                       # The page's stored (deleted) history:
+                       $wgOut->addHTML("<ul>");
+                       $target = urlencode( $this->mTarget );
+                       while( $row = $revisions->fetchObject() ) {
+                               $ts = wfTimestamp( TS_MW, $row->ar_timestamp );
+                               if ( $this->mAllowed ) {
+                                       $checkBox = wfCheck( "ts$ts" );
+                                       $pageLink = $sk->makeKnownLinkObj( $titleObj,
+                                               $wgLang->timeanddate( $ts, true ),
+                                               "target=$target&timestamp=$ts" );
+                               } else {
+                                       $checkBox = '';
+                                       $pageLink = $wgLang->timeanddate( $ts, true );
+                               }
+                               $userLink = $sk->userLink( $row->ar_user, $row->ar_user_text ) . $sk->userToolLinks( $row->ar_user, $row->ar_user_text );
+                               $comment = $sk->commentBlock( $row->ar_comment );
+                               $wgOut->addHTML( "<li>$checkBox $pageLink . . $userLink $comment</li>\n" );
+       
                        }
-                       $comment = $sk->commentBlock( $row->ar_comment );
-                       $wgOut->addHTML( "<li>$checkBox $pageLink . . $userLink $comment</li>\n" );
+                       $revisions->free();
+                       $wgOut->addHTML("</ul>");
+               } else {
+                       $wgOut->addWikiText( wfMsg( "nohistory" ) );
+               }
 
+               
+               if( $haveFiles ) {
+                       $wgOut->addHtml( "<h2>" . wfMsgHtml( 'imghistory' ) . "</h2>\n" );
+                       $wgOut->addHtml( "<ul>" );
+                       while( $row = $files->fetchObject() ) {
+                               $ts = wfTimestamp( TS_MW, $row->fa_timestamp );
+                               if ( $this->mAllowed && $row->fa_storage_key ) {
+                                       $checkBox = wfCheck( "fileid" . $row->fa_id );
+                                       $key = urlencode( $row->fa_storage_key );
+                                       $target = urlencode( $this->mTarget );
+                                       $pageLink = $sk->makeKnownLinkObj( $titleObj,
+                                               $wgLang->timeanddate( $ts, true ),
+                                               "target=$target&file=$key" );
+                               } else {
+                                       $checkBox = '';
+                                       $pageLink = $wgLang->timeanddate( $ts, true );
+                               }
+                               $userLink = $sk->userLink( $row->fa_user, $row->fa_user_text ) . $sk->userToolLinks( $row->fa_user, $row->fa_user_text );
+                               $data =
+                                       wfMsgHtml( 'widthheight',
+                                               $wgLang->formatNum( $row->fa_width ),
+                                               $wgLang->formatNum( $row->fa_height ) ) .
+                                       ' (' .
+                                       wfMsgHtml( 'nbytes', $wgLang->formatNum( $row->fa_size ) ) .
+                                       ')';
+                               $comment = $sk->commentBlock( $row->fa_description );
+                               $wgOut->addHTML( "<li>$checkBox $pageLink . . $userLink $data $comment</li>\n" );
+                       }
+                       $files->free();
+                       $wgOut->addHTML( "</ul>" );
                }
-               $revisions->free();
-               $wgOut->addHTML("</ul>");
+               
                if ( $this->mAllowed ) {
-                       $wgOut->addHTML( "\n</form>" );
+                       # Slip in the hidden controls here
+                       $misc  = wfHidden( 'target', $this->mTarget );
+                       $misc .= wfHidden( 'wpEditToken', $wgUser->editToken() );
+                       $wgOut->addHtml( $misc . '</form>' );
                }
 
                return true;
        }
 
        function undelete() {
-               global $wgOut;
+               global $wgOut, $wgUser;
                if( !is_null( $this->mTargetObj ) ) {
                        $archive = new PageArchive( $this->mTargetObj );
-                       if( $archive->undelete( $this->mTargetTimestamp ) ) {
-                               $wgOut->addWikiText( wfMsg( "undeletedtext", $this->mTarget ) );
-
-                               if (NS_IMAGE == $this->mTargetObj->getNamespace()) {
-                                       /* refresh image metadata cache */
-                                       new Image( $this->mTargetObj );
-                               }
-
+                       $ok = true;
+                       
+                       $ok = $archive->undelete(
+                               $this->mTargetTimestamp,
+                               $this->mComment,
+                               $this->mFileVersions );
+                       
+                       if( $ok ) {
+                               $skin =& $wgUser->getSkin();
+                               $link = $skin->makeKnownLinkObj( $this->mTargetObj );
+                               $wgOut->addHtml( wfMsgWikiHtml( 'undeletedpage', $link ) );
                                return true;
                        }
                }
-               $wgOut->fatalError( wfMsg( "cannotundelete" ) );
+               $wgOut->showFatalError( wfMsg( "cannotundelete" ) );
                return false;
        }
 }