Followup r78924: keep track of exception/warning comments separately, to prevent...
[lhc/web/wiklou.git] / includes / FileDeleteForm.php
index 229cba5..030330b 100644 (file)
@@ -3,7 +3,7 @@
 /**
  * File deletion user interface
  *
- * @addtogroup Media
+ * @ingroup Media
  * @author Rob Church <robchur@gmail.com>
  */
 class FileDeleteForm {
@@ -13,17 +13,17 @@ class FileDeleteForm {
 
        private $oldfile = null;
        private $oldimage = '';
-       
+
        /**
         * Constructor
         *
-        * @param File $file File we're deleting
+        * @param $file File object we're deleting
         */
        public function __construct( $file ) {
                $this->title = $file->getTitle();
                $this->file = $file;
        }
-       
+
        /**
         * Fulfil the request; shows the form or deletes the file,
         * pending authentication, confirmation, etc.
@@ -35,32 +35,31 @@ class FileDeleteForm {
                if( wfReadOnly() ) {
                        $wgOut->readOnlyPage();
                        return;
-               } elseif( !$wgUser->isLoggedIn() ) {
-                       $wgOut->showErrorPage( 'uploadnologin', 'uploadnologintext' );
-                       return;
-               } elseif( !$wgUser->isAllowed( 'delete' ) ) {
-                       $wgOut->permissionRequired( 'delete' );
-                       return;
-               } elseif( $wgUser->isBlocked() ) {
-                       $wgOut->blockedPage();
+               }
+               $permission_errors = $this->title->getUserPermissionsErrors('delete', $wgUser);
+               if (count($permission_errors)>0) {
+                       $wgOut->showPermissionsErrorPage( $permission_errors );
                        return;
                }
-               
+
                $this->oldimage = $wgRequest->getText( 'oldimage', false );
                $token = $wgRequest->getText( 'wpEditToken' );
-               if( $this->oldimage && !$this->isValidOldSpec() ) {
+               # Flag to hide all contents of the archived revisions
+               $suppress = $wgRequest->getVal( 'wpSuppress' ) && $wgUser->isAllowed('suppressrevision');
+
+               if( $this->oldimage && !self::isValidOldSpec($this->oldimage) ) {
                        $wgOut->showUnexpectedValueError( 'oldimage', htmlspecialchars( $this->oldimage ) );
                        return;
                }
                if( $this->oldimage )
                        $this->oldfile = RepoGroup::singleton()->getLocalRepo()->newFromArchiveName( $this->title, $this->oldimage );
-               
-               if( !$this->haveDeletableFile() ) {
-                       $wgOut->addHtml( $this->prepareMessage( 'filedelete-nofile' ) );
+
+               if( !self::haveDeletableFile($this->file, $this->oldfile, $this->oldimage) ) {
+                       $wgOut->addHTML( $this->prepareMessage( 'filedelete-nofile' ) );
                        $wgOut->addReturnTo( $this->title );
                        return;
                }
-               
+
                // Perform the deletion if appropriate
                if( $wgRequest->wasPosted() && $wgUser->matchEditToken( $token, $this->oldimage ) ) {
                        $this->DeleteReasonList = $wgRequest->getText( 'wpDeleteReasonList' );
@@ -68,105 +67,171 @@ class FileDeleteForm {
                        $reason = $this->DeleteReasonList;
                        if ( $reason != 'other' && $this->DeleteReason != '') {
                                // Entry from drop down menu + additional comment
-                               $reason .= ': ' . $this->DeleteReason;
+                               $reason .= wfMsgForContent( 'colon-separator' ) . $this->DeleteReason;
                        } elseif ( $reason == 'other' ) {
                                $reason = $this->DeleteReason;
                        }
-                       if( $this->oldimage ) {
-                               $status = $this->file->deleteOld( $this->oldimage, $reason );
-                               if( $status->ok ) {
-                                       // Need to do a log item
-                                       $log = new LogPage( 'delete' );
-                                       $logComment = wfMsg( 'deletedrevision', $this->oldimage );
-                                       if( trim( $reason ) != '' )
-                                               $logComment .= ": {$reason}";
-                                       $log->addEntry( 'delete', $this->title, $logComment );
-                               }
-                       } else {
-                               $status = $this->file->delete( $reason );
-                               if( $status->ok ) {
-                                       // Need to delete the associated article
-                                       $article = new Article( $this->title );
-                                       $article->doDeleteArticle( $reason );
-                               }
-                       }
+
+                       $status = self::doDelete( $this->title, $this->file, $this->oldimage, $reason, $suppress );
+
                        if( !$status->isGood() )
                                $wgOut->addWikiText( $status->getWikiText( 'filedeleteerror-short', 'filedeleteerror-long' ) );
                        if( $status->ok ) {
                                $wgOut->setPagetitle( wfMsg( 'actioncomplete' ) );
-                               $wgOut->addHtml( $this->prepareMessage( 'filedelete-success' ) );
+                               $wgOut->addHTML( $this->prepareMessage( 'filedelete-success' ) );
                                // Return to the main page if we just deleted all versions of the
                                // file, otherwise go back to the description page
                                $wgOut->addReturnTo( $this->oldimage ? $this->title : Title::newMainPage() );
                        }
                        return;
                }
-               
+
                $this->showForm();
                $this->showLogEntries();
        }
 
+       /**
+        * Really delete the file
+        *
+        * @param $title Title object
+        * @param $file File object
+        * @param $oldimage String: archive name
+        * @param $reason String: reason of the deletion
+        * @param $suppress Boolean: whether to mark all deleted versions as restricted
+        */
+       public static function doDelete( &$title, &$file, &$oldimage, $reason, $suppress ) {
+               global $wgUser;
+               $article = null;
+               $status = Status::newFatal( 'error' );
+
+               if( $oldimage ) {
+                       $status = $file->deleteOld( $oldimage, $reason, $suppress );
+                       if( $status->ok ) {
+                               // Need to do a log item
+                               $log = new LogPage( 'delete' );
+                               $logComment = wfMsgForContent( 'deletedrevision', $oldimage );
+                               if( trim( $reason ) != '' ) {
+                                       $logComment .= wfMsgForContent( 'colon-separator' ) . $reason;
+                               }
+                               $log->addEntry( 'delete', $title, $logComment );
+                       }
+               } else {
+                       $id = $title->getArticleID( Title::GAID_FOR_UPDATE );
+                       $article = new Article( $title );
+                       $error = '';
+                       $dbw = wfGetDB( DB_MASTER );
+                       try {
+                               if( wfRunHooks( 'ArticleDelete', array( &$article, &$wgUser, &$reason, &$error ) ) ) {
+                                       // delete the associated article first
+                                       if( $article->doDeleteArticle( $reason, $suppress, $id, false ) ) {
+                                               global $wgRequest;
+                                               if( $wgRequest->getCheck( 'wpWatch' ) && $wgUser->isLoggedIn() ) {
+                                                       $article->doWatch();
+                                               } elseif( $title->userIsWatching() ) {
+                                                       $article->doUnwatch();
+                                               }
+                                               $status = $file->delete( $reason, $suppress );
+                                               if( $status->ok ) {
+                                                       $dbw->commit();
+                                                       wfRunHooks( 'ArticleDeleteComplete', array( &$article, &$wgUser, $reason, $id ) );
+                                               } else {
+                                                       $dbw->rollback();
+                                               }
+                                       }
+                               }
+                       } catch ( MWException $e ) {
+                               // rollback before returning to prevent UI from displaying incorrect "View or restore N deleted edits?"
+                               $dbw->rollback();
+                               throw $e;
+                       }
+               }
+               if( $status->isGood() ) 
+                       wfRunHooks('FileDeleteComplete', array( &$file, &$oldimage, &$article, &$wgUser, &$reason));
+
+               return $status;
+       }
+
        /**
         * Show the confirmation form
         */
        private function showForm() {
                global $wgOut, $wgUser, $wgRequest;
-               
-               $mDeletereasonother = Xml::label( wfMsg( 'filedelete-otherreason' ), 'wpReason' );
-               $mDeletereasonotherlist = wfMsgHtml( 'filedelete-reason-otherlist' );
-               $scDeleteReasonList = wfMsgForContent( 'filedelete-reason-dropdown' );
-               $mDeleteReasonList = '';
-               $delcom = Xml::label( wfMsg( 'filedelete-comment' ), 'wpDeleteReasonList' );
-               if ( $scDeleteReasonList != '' && $scDeleteReasonList != '-' ) {
-                       $deleteReasonList = "<option value=\"other\">$mDeletereasonotherlist</option>";
-                       $optgroup = "";
-                       foreach ( explode( "\n", $scDeleteReasonList ) as $option) {
-                               $value = trim( htmlspecialchars($option) );
-                               if ( $value == '' ) {
-                                       continue;
-                               } elseif ( substr( $value, 0, 1) == '*' && substr( $value, 1, 1) != '*' ) {
-                                       // A new group is starting ...
-                                       $value = trim( substr( $value, 1 ) );
-                                       $deleteReasonList .= "$optgroup<optgroup label=\"$value\">";
-                                       $optgroup = "</optgroup>";
-                               } elseif ( substr( $value, 0, 2) == '**' ) {
-                                       // groupmember
-                                       $selected = "";
-                                       $value = trim( substr( $value, 2 ) );
-                                       if ( $mDeleteReasonList === $value)
-                                       $selected = ' selected="selected"';
-                                       $deleteReasonList .= "<option value=\"$value\"$selected>$value</option>";
-                               } else {
-                                       // groupless delete reason
-                                       $selected = "";
-                                       if ( $this->DeleteReasonList === $value)
-                                               $selected = ' selected="selected"';
-                                       $deleteReasonList .= "$optgroup<option value=\"$value\"$selected>$value</option>";
-                                       $optgroup = "";
-                               }
-                       }
-                       $deleteReasonList .= $optgroup;
+
+               if( $wgUser->isAllowed( 'suppressrevision' ) ) {
+                       $suppress = "<tr id=\"wpDeleteSuppressRow\">
+                                       <td></td>
+                                       <td class='mw-input'><strong>" .
+                                               Xml::checkLabel( wfMsg( 'revdelete-suppress' ),
+                                                       'wpSuppress', 'wpSuppress', false, array( 'tabindex' => '3' ) ) .
+                                       "</strong></td>
+                               </tr>";
+               } else {
+                       $suppress = '';
                }
 
-               $form  = Xml::openElement( 'form', array( 'method' => 'post', 'action' => $this->getAction() ) );
-               $form .= '<fieldset><legend>' . wfMsgHtml( 'filedelete-legend' ) . '</legend>';
-               $form .= Xml::hidden( 'wpEditToken', $wgUser->editToken( $this->oldimage ) );
-               $form .= '<table><tr><td colspan="2">';
-               $form .= $this->prepareMessage( 'filedelete-intro' );
-               $form .= "</td></tr><tr><td align=\"right\"> $delcom </td><td align=\"left\">";
-               $form .= "<select tabindex='2' id='wpDeleteReasonList' name=\"wpDeleteReasonList\">
-               $deleteReasonList
-</select>";
-               $form .= "</td></tr><tr><td align=\"right\"> $mDeletereasonother </td><td align=\"left\">";
-               $form .= "<input type='text' maxlength='255' size='60' name='wpReason' id='wpReason' ";
-               $form .= "value=\"". htmlspecialchars( $wgRequest->getText( 'wpReason' ) ) ."\" tabindex=\"1\" />";
-               $form .= '</td></tr><tr><td colspan="2">';
-               $form .= '<p>' . Xml::submitButton( wfMsg( 'filedelete-submit' ), array( 'name' => 'mw-filedelete-submit', 'id' => 'mw-filedelete-submit' ) ) . '</p>';
-               $form .= '</td></tr></table>';
-               $form .= '</fieldset>';
-               $form .= '</form>';
+               $checkWatch = $wgUser->getBoolOption( 'watchdeletion' ) || $this->title->userIsWatching();
+               $form = Xml::openElement( 'form', array( 'method' => 'post', 'action' => $this->getAction(),
+                       'id' => 'mw-img-deleteconfirm' ) ) .
+                       Xml::openElement( 'fieldset' ) .
+                       Xml::element( 'legend', null, wfMsg( 'filedelete-legend' ) ) .
+                       Html::hidden( 'wpEditToken', $wgUser->editToken( $this->oldimage ) ) .
+                       $this->prepareMessage( 'filedelete-intro' ) .
+                       Xml::openElement( 'table', array( 'id' => 'mw-img-deleteconfirm-table' ) ) .
+                       "<tr>
+                               <td class='mw-label'>" .
+                                       Xml::label( wfMsg( 'filedelete-comment' ), 'wpDeleteReasonList' ) .
+                               "</td>
+                               <td class='mw-input'>" .
+                                       Xml::listDropDown( 'wpDeleteReasonList',
+                                               wfMsgForContent( 'filedelete-reason-dropdown' ),
+                                               wfMsgForContent( 'filedelete-reason-otherlist' ), '', 'wpReasonDropDown', 1 ) .
+                               "</td>
+                       </tr>
+                       <tr>
+                               <td class='mw-label'>" .
+                                       Xml::label( wfMsg( 'filedelete-otherreason' ), 'wpReason' ) .
+                               "</td>
+                               <td class='mw-input'>" .
+                                       Xml::input( 'wpReason', 60, $wgRequest->getText( 'wpReason' ),
+                                               array( 'type' => 'text', 'maxlength' => '255', 'tabindex' => '2', 'id' => 'wpReason' ) ) .
+                               "</td>
+                       </tr>
+                       {$suppress}";
+               if( $wgUser->isLoggedIn() ) {   
+                       $form .= "
+                       <tr>
+                               <td></td>
+                               <td class='mw-input'>" .
+                                       Xml::checkLabel( wfMsg( 'watchthis' ),
+                                               'wpWatch', 'wpWatch', $checkWatch, array( 'tabindex' => '3' ) ) .
+                               "</td>
+                       </tr>";
+               }
+               $form .= "
+                       <tr>
+                               <td></td>
+                               <td class='mw-submit'>" .
+                                       Xml::submitButton( wfMsg( 'filedelete-submit' ),
+                                               array( 'name' => 'mw-filedelete-submit', 'id' => 'mw-filedelete-submit', 'tabindex' => '4' ) ) .
+                               "</td>
+                       </tr>" .
+                       Xml::closeElement( 'table' ) .
+                       Xml::closeElement( 'fieldset' ) .
+                       Xml::closeElement( 'form' );
+
+                       if ( $wgUser->isAllowed( 'editinterface' ) ) {
+                               $skin = $wgUser->getSkin();
+                               $title = Title::makeTitle( NS_MEDIAWIKI, 'Filedelete-reason-dropdown' );
+                               $link = $skin->link(
+                                       $title,
+                                       wfMsgHtml( 'filedelete-edit-reasonlist' ),
+                                       array(),
+                                       array( 'action' => 'edit' )
+                               );
+                               $form .= '<p class="mw-filedelete-editreasons">' . $link . '</p>';
+                       }
 
-               $wgOut->addHtml( $form );
+               $wgOut->addHTML( $form );
        }
 
        /**
@@ -174,39 +239,28 @@ class FileDeleteForm {
         */
        private function showLogEntries() {
                global $wgOut;
-               $wgOut->addHtml( '<h2>' . htmlspecialchars( LogPage::logName( 'delete' ) ) . "</h2>\n" );
-               $reader = new LogViewer(
-                       new LogReader(
-                               new FauxRequest(
-                                       array(
-                                               'type' => 'delete',
-                                               'page' => $this->title->getPrefixedText(),
-                                       )
-                               )
-                       )
-               );
-               $reader->showList( $wgOut );            
+               $wgOut->addHTML( '<h2>' . htmlspecialchars( LogPage::logName( 'delete' ) ) . "</h2>\n" );
+               LogEventsList::showLogExtract( $wgOut, 'delete', $this->title->getPrefixedText() );
        }
-       
+
        /**
         * Prepare a message referring to the file being deleted,
         * showing an appropriate message depending upon whether
         * it's a current file or an old version
         *
-        * @param string $message Message base
-        * @return string
+        * @param $message String: message base
+        * @return String
         */
        private function prepareMessage( $message ) {
-               global $wgLang, $wgServer;
+               global $wgLang;
                if( $this->oldimage ) {
                        return wfMsgExt(
-                               "{$message}-old",
+                               "{$message}-old", # To ensure grep will find them: 'filedelete-intro-old', 'filedelete-nofile-old', 'filedelete-success-old'
                                'parse',
                                $this->title->getText(),
                                $wgLang->date( $this->getTimestamp(), true ),
                                $wgLang->time( $this->getTimestamp(), true ),
-                               $wgServer . $this->file->getArchiveUrl( $this->oldimage )
-                       );
+                               wfExpandUrl( $this->file->getArchiveUrl( $this->oldimage ) ) );
                } else {
                        return wfMsgExt(
                                $message,
@@ -215,7 +269,7 @@ class FileDeleteForm {
                        );
                }
        }
-       
+
        /**
         * Set headers, titles and other bits
         */
@@ -223,20 +277,29 @@ class FileDeleteForm {
                global $wgOut, $wgUser;
                $wgOut->setPageTitle( wfMsg( 'filedelete', $this->title->getText() ) );
                $wgOut->setRobotPolicy( 'noindex,nofollow' );
-               $wgOut->setSubtitle( wfMsg( 'filedelete-backlink', $wgUser->getSkin()->makeKnownLinkObj( $this->title ) ) );
+               $wgOut->setSubtitle( wfMsg(
+                       'filedelete-backlink',
+                       $wgUser->getSkin()->link(
+                               $this->title,
+                               null,
+                               array(),
+                               array(),
+                               array( 'known', 'noclasses' )
+                       )
+               ) );
        }
-       
+
        /**
         * Is the provided `oldimage` value valid?
         *
         * @return bool
         */
-       private function isValidOldSpec() {
-               return strlen( $this->oldimage ) >= 16
-                       && strpos( $this->oldimage, '/' ) === false
-                       && strpos( $this->oldimage, '\\' ) === false;
+       public static function isValidOldSpec($oldimage) {
+               return strlen( $oldimage ) >= 16
+                       && strpos( $oldimage, '/' ) === false
+                       && strpos( $oldimage, '\\' ) === false;
        }
-       
+
        /**
         * Could we delete the file specified? If an `oldimage`
         * value was provided, does it correspond to an
@@ -244,12 +307,12 @@ class FileDeleteForm {
         *
         * @return bool
         */
-       private function haveDeletableFile() {
-               return $this->oldimage
-                       ? $this->oldfile && $this->oldfile->exists() && $this->oldfile->isLocal()
-                       : $this->file && $this->file->exists() && $this->file->isLocal();
+       public static function haveDeletableFile(&$file, &$oldfile, $oldimage) {
+               return $oldimage
+                       ? $oldfile && $oldfile->exists() && $oldfile->isLocal()
+                       : $file && $file->exists() && $file->isLocal();
        }
-       
+
        /**
         * Prepare the form action
         *
@@ -257,12 +320,14 @@ class FileDeleteForm {
         */
        private function getAction() {
                $q = array();
-               $q[] = 'action=delete';
+               $q['action'] = 'delete';
+
                if( $this->oldimage )
-                       $q[] = 'oldimage=' . urlencode( $this->oldimage );
-               return $this->title->getLocalUrl( implode( '&', $q ) );
+                       $q['oldimage'] = $this->oldimage;
+
+               return $this->title->getLocalUrl( $q );
        }
-       
+
        /**
         * Extract the timestamp of the old version
         *
@@ -271,5 +336,4 @@ class FileDeleteForm {
        private function getTimestamp() {
                return $this->oldfile->getTimestamp();
        }
-       
 }