]> scripts.mit.edu Git - autoinstallsdev/mediawiki.git/blobdiff - includes/FileDeleteForm.php
MediaWiki 1.30.2
[autoinstallsdev/mediawiki.git] / includes / FileDeleteForm.php
index 030330bbeb10c285ba8beb038879b90d2d79a94c..8c843c4438d5afee9ef329cfbf2ab4dc91440ffd 100644 (file)
@@ -1,23 +1,53 @@
 <?php
+/**
+ * File deletion user interface.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ * @author Rob Church <robchur@gmail.com>
+ * @ingroup Media
+ */
+use MediaWiki\MediaWikiServices;
 
 /**
  * File deletion user interface
  *
  * @ingroup Media
- * @author Rob Church <robchur@gmail.com>
  */
 class FileDeleteForm {
 
+       /**
+        * @var Title
+        */
        private $title = null;
+
+       /**
+        * @var File
+        */
        private $file = null;
 
+       /**
+        * @var File
+        */
        private $oldfile = null;
        private $oldimage = '';
 
        /**
-        * Constructor
-        *
-        * @param $file File object we're deleting
+        * @param File $file File object we're deleting
         */
        public function __construct( $file ) {
                $this->title = $file->getTitle();
@@ -29,59 +59,79 @@ class FileDeleteForm {
         * pending authentication, confirmation, etc.
         */
        public function execute() {
-               global $wgOut, $wgRequest, $wgUser;
-               $this->setHeaders();
+               global $wgOut, $wgRequest, $wgUser, $wgUploadMaintenance;
 
-               if( wfReadOnly() ) {
-                       $wgOut->readOnlyPage();
-                       return;
+               $permissionErrors = $this->title->getUserPermissionsErrors( 'delete', $wgUser );
+               if ( count( $permissionErrors ) ) {
+                       throw new PermissionsError( 'delete', $permissionErrors );
                }
-               $permission_errors = $this->title->getUserPermissionsErrors('delete', $wgUser);
-               if (count($permission_errors)>0) {
-                       $wgOut->showPermissionsErrorPage( $permission_errors );
-                       return;
+
+               if ( wfReadOnly() ) {
+                       throw new ReadOnlyError;
                }
 
+               if ( $wgUploadMaintenance ) {
+                       throw new ErrorPageError( 'filedelete-maintenance-title', 'filedelete-maintenance' );
+               }
+
+               $this->setHeaders();
+
                $this->oldimage = $wgRequest->getText( 'oldimage', false );
                $token = $wgRequest->getText( 'wpEditToken' );
                # Flag to hide all contents of the archived revisions
-               $suppress = $wgRequest->getVal( 'wpSuppress' ) && $wgUser->isAllowed('suppressrevision');
+               $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->oldimage )
-                       $this->oldfile = RepoGroup::singleton()->getLocalRepo()->newFromArchiveName( $this->title, $this->oldimage );
 
-               if( !self::haveDeletableFile($this->file, $this->oldfile, $this->oldimage) ) {
+               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' );
-                       $this->DeleteReason = $wgRequest->getText( 'wpReason' );
-                       $reason = $this->DeleteReasonList;
-                       if ( $reason != 'other' && $this->DeleteReason != '') {
+               if ( $wgRequest->wasPosted() && $wgUser->matchEditToken( $token, $this->oldimage ) ) {
+                       $deleteReasonList = $wgRequest->getText( 'wpDeleteReasonList' );
+                       $deleteReason = $wgRequest->getText( 'wpReason' );
+
+                       if ( $deleteReasonList == 'other' ) {
+                               $reason = $deleteReason;
+                       } elseif ( $deleteReason != '' ) {
                                // Entry from drop down menu + additional comment
-                               $reason .= wfMsgForContent( 'colon-separator' ) . $this->DeleteReason;
-                       } elseif ( $reason == 'other' ) {
-                               $reason = $this->DeleteReason;
+                               $reason = $deleteReasonList . wfMessage( 'colon-separator' )
+                                       ->inContentLanguage()->text() . $deleteReason;
+                       } else {
+                               $reason = $deleteReasonList;
                        }
 
-                       $status = self::doDelete( $this->title, $this->file, $this->oldimage, $reason, $suppress );
+                       $status = self::doDelete(
+                               $this->title,
+                               $this->file,
+                               $this->oldimage,
+                               $reason,
+                               $suppress,
+                               $wgUser
+                       );
 
-                       if( !$status->isGood() )
-                               $wgOut->addWikiText( $status->getWikiText( 'filedeleteerror-short', 'filedeleteerror-long' ) );
-                       if( $status->ok ) {
-                               $wgOut->setPagetitle( wfMsg( 'actioncomplete' ) );
+                       if ( !$status->isGood() ) {
+                               $wgOut->addHTML( '<h2>' . $this->prepareMessage( 'filedeleteerror-short' ) . "</h2>\n" );
+                               $wgOut->addWikiText( '<div class="error">' .
+                                       $status->getWikiText( 'filedeleteerror-short', 'filedeleteerror-long' )
+                                       . '</div>' );
+                       }
+                       if ( $status->isOK() ) {
+                               $wgOut->setPageTitle( wfMessage( 'actioncomplete' ) );
                                $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() );
+
+                               WatchAction::doWatchOrUnwatch( $wgRequest->getCheck( 'wpWatch' ), $this->title, $wgUser );
                        }
                        return;
                }
@@ -93,60 +143,99 @@ class FileDeleteForm {
        /**
         * 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
+        * @param Title &$title
+        * @param File &$file
+        * @param string &$oldimage Archive name
+        * @param string $reason Reason of the deletion
+        * @param bool $suppress Whether to mark all deleted versions as restricted
+        * @param User $user User object performing the request
+        * @param array $tags Tags to apply to the deletion action
+        * @throws MWException
+        * @return Status
         */
-       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 ) {
+       public static function doDelete( &$title, &$file, &$oldimage, $reason,
+               $suppress, User $user = null, $tags = []
+       ) {
+               if ( $user === null ) {
+                       global $wgUser;
+                       $user = $wgUser;
+               }
+
+               if ( $oldimage ) {
+                       $page = null;
+                       $status = $file->deleteOld( $oldimage, $reason, $suppress, $user );
+                       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;
+                               $logComment = wfMessage( 'deletedrevision', $oldimage )->inContentLanguage()->text();
+                               if ( trim( $reason ) != '' ) {
+                                       $logComment .= wfMessage( 'colon-separator' )
+                                               ->inContentLanguage()->text() . $reason;
                                }
-                               $log->addEntry( 'delete', $title, $logComment );
+
+                               $logtype = $suppress ? 'suppress' : 'delete';
+
+                               $logEntry = new ManualLogEntry( $logtype, 'delete' );
+                               $logEntry->setPerformer( $user );
+                               $logEntry->setTarget( $title );
+                               $logEntry->setComment( $logComment );
+                               $logEntry->setTags( $tags );
+                               $logid = $logEntry->insert();
+                               $logEntry->publish( $logid );
+
+                               $status->value = $logid;
                        }
                } else {
-                       $id = $title->getArticleID( Title::GAID_FOR_UPDATE );
-                       $article = new Article( $title );
-                       $error = '';
+                       $status = Status::newFatal( 'cannotdelete',
+                               wfEscapeWikiText( $title->getPrefixedText() )
+                       );
+                       $page = WikiPage::factory( $title );
                        $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();
-                                               }
+                       $dbw->startAtomic( __METHOD__ );
+                       // delete the associated article first
+                       $error = '';
+                       $deleteStatus = $page->doDeleteArticleReal( $reason, $suppress, 0, false, $error,
+                               $user, $tags );
+                       // doDeleteArticleReal() returns a non-fatal error status if the page
+                       // or revision is missing, so check for isOK() rather than isGood()
+                       if ( $deleteStatus->isOK() ) {
+                               $status = $file->delete( $reason, $suppress, $user );
+                               if ( $status->isOK() ) {
+                                       if ( $deleteStatus->value === null ) {
+                                               // No log ID from doDeleteArticleReal(), probably
+                                               // because the page/revision didn't exist, so create
+                                               // one here.
+                                               $logtype = $suppress ? 'suppress' : 'delete';
+                                               $logEntry = new ManualLogEntry( $logtype, 'delete' );
+                                               $logEntry->setPerformer( $user );
+                                               $logEntry->setTarget( clone $title );
+                                               $logEntry->setComment( $reason );
+                                               $logEntry->setTags( $tags );
+                                               $logid = $logEntry->insert();
+                                               $dbw->onTransactionPreCommitOrIdle(
+                                                       function () use ( $dbw, $logEntry, $logid ) {
+                                                               $logEntry->publish( $logid );
+                                                       },
+                                                       __METHOD__
+                                               );
+                                               $status->value = $logid;
+                                       } else {
+                                               $status->value = $deleteStatus->value; // log id
                                        }
+                                       $dbw->endAtomic( __METHOD__ );
+                               } else {
+                                       // Page deleted but file still there? rollback page delete
+                                       $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
+                                       $lbFactory->rollbackMasterChanges( __METHOD__ );
                                }
-                       } catch ( MWException $e ) {
-                               // rollback before returning to prevent UI from displaying incorrect "View or restore N deleted edits?"
-                               $dbw->rollback();
-                               throw $e;
+                       } else {
+                               // Done; nothing changed
+                               $dbw->endAtomic( __METHOD__ );
                        }
                }
-               if( $status->isGood() ) 
-                       wfRunHooks('FileDeleteComplete', array( &$file, &$oldimage, &$article, &$wgUser, &$reason));
+
+               if ( $status->isOK() ) {
+                       Hooks::run( 'FileDeleteComplete', [ &$file, &$oldimage, &$page, &$user, &$reason ] );
+               }
 
                return $status;
        }
@@ -157,53 +246,58 @@ class FileDeleteForm {
        private function showForm() {
                global $wgOut, $wgUser, $wgRequest;
 
-               if( $wgUser->isAllowed( 'suppressrevision' ) ) {
+               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' ) ) .
+                                               Xml::checkLabel( wfMessage( 'revdelete-suppress' )->text(),
+                                                       'wpSuppress', 'wpSuppress', false, [ 'tabindex' => '3' ] ) .
                                        "</strong></td>
                                </tr>";
                } else {
                        $suppress = '';
                }
 
-               $checkWatch = $wgUser->getBoolOption( 'watchdeletion' ) || $this->title->userIsWatching();
-               $form = Xml::openElement( 'form', array( 'method' => 'post', 'action' => $this->getAction(),
-                       'id' => 'mw-img-deleteconfirm' ) ) .
+               $checkWatch = $wgUser->getBoolOption( 'watchdeletion' ) || $wgUser->isWatched( $this->title );
+               $form = Xml::openElement( 'form', [ '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 ) ) .
+                       Xml::element( 'legend', null, wfMessage( 'filedelete-legend' )->text() ) .
+                       Html::hidden( 'wpEditToken', $wgUser->getEditToken( $this->oldimage ) ) .
                        $this->prepareMessage( 'filedelete-intro' ) .
-                       Xml::openElement( 'table', array( 'id' => 'mw-img-deleteconfirm-table' ) ) .
+                       Xml::openElement( 'table', [ 'id' => 'mw-img-deleteconfirm-table' ] ) .
                        "<tr>
                                <td class='mw-label'>" .
-                                       Xml::label( wfMsg( 'filedelete-comment' ), 'wpDeleteReasonList' ) .
+                                       Xml::label( wfMessage( 'filedelete-comment' )->text(), 'wpDeleteReasonList' ) .
                                "</td>
                                <td class='mw-input'>" .
-                                       Xml::listDropDown( 'wpDeleteReasonList',
-                                               wfMsgForContent( 'filedelete-reason-dropdown' ),
-                                               wfMsgForContent( 'filedelete-reason-otherlist' ), '', 'wpReasonDropDown', 1 ) .
+                                       Xml::listDropDown(
+                                               'wpDeleteReasonList',
+                                               wfMessage( 'filedelete-reason-dropdown' )->inContentLanguage()->text(),
+                                               wfMessage( 'filedelete-reason-otherlist' )->inContentLanguage()->text(),
+                                               '',
+                                               'wpReasonDropDown',
+                                               1
+                                       ) .
                                "</td>
                        </tr>
                        <tr>
                                <td class='mw-label'>" .
-                                       Xml::label( wfMsg( 'filedelete-otherreason' ), 'wpReason' ) .
+                                       Xml::label( wfMessage( 'filedelete-otherreason' )->text(), 'wpReason' ) .
                                "</td>
                                <td class='mw-input'>" .
                                        Xml::input( 'wpReason', 60, $wgRequest->getText( 'wpReason' ),
-                                               array( 'type' => 'text', 'maxlength' => '255', 'tabindex' => '2', 'id' => 'wpReason' ) ) .
+                                               [ 'type' => 'text', 'maxlength' => '255', 'tabindex' => '2', 'id' => 'wpReason' ] ) .
                                "</td>
                        </tr>
                        {$suppress}";
-               if( $wgUser->isLoggedIn() ) {   
+               if ( $wgUser->isLoggedIn() ) {
                        $form .= "
                        <tr>
                                <td></td>
                                <td class='mw-input'>" .
-                                       Xml::checkLabel( wfMsg( 'watchthis' ),
-                                               'wpWatch', 'wpWatch', $checkWatch, array( 'tabindex' => '3' ) ) .
+                                       Xml::checkLabel( wfMessage( 'watchthis' )->text(),
+                                               'wpWatch', 'wpWatch', $checkWatch, [ 'tabindex' => '3' ] ) .
                                "</td>
                        </tr>";
                }
@@ -211,8 +305,14 @@ class FileDeleteForm {
                        <tr>
                                <td></td>
                                <td class='mw-submit'>" .
-                                       Xml::submitButton( wfMsg( 'filedelete-submit' ),
-                                               array( 'name' => 'mw-filedelete-submit', 'id' => 'mw-filedelete-submit', 'tabindex' => '4' ) ) .
+                                       Xml::submitButton(
+                                               wfMessage( 'filedelete-submit' )->text(),
+                                               [
+                                                       'name' => 'mw-filedelete-submit',
+                                                       'id' => 'mw-filedelete-submit',
+                                                       'tabindex' => '4'
+                                               ]
+                                       ) .
                                "</td>
                        </tr>" .
                        Xml::closeElement( 'table' ) .
@@ -220,13 +320,13 @@ class FileDeleteForm {
                        Xml::closeElement( 'form' );
 
                        if ( $wgUser->isAllowed( 'editinterface' ) ) {
-                               $skin = $wgUser->getSkin();
-                               $title = Title::makeTitle( NS_MEDIAWIKI, 'Filedelete-reason-dropdown' );
-                               $link = $skin->link(
+                               $title = wfMessage( 'filedelete-reason-dropdown' )->inContentLanguage()->getTitle();
+                               $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
+                               $link = $linkRenderer->makeKnownLink(
                                        $title,
-                                       wfMsgHtml( 'filedelete-edit-reasonlist' ),
-                                       array(),
-                                       array( 'action' => 'edit' )
+                                       wfMessage( 'filedelete-edit-reasonlist' )->text(),
+                                       [],
+                                       [ 'action' => 'edit' ]
                                );
                                $form .= '<p class="mw-filedelete-editreasons">' . $link . '</p>';
                        }
@@ -239,8 +339,9 @@ class FileDeleteForm {
         */
        private function showLogEntries() {
                global $wgOut;
-               $wgOut->addHTML( '<h2>' . htmlspecialchars( LogPage::logName( 'delete' ) ) . "</h2>\n" );
-               LogEventsList::showLogExtract( $wgOut, 'delete', $this->title->getPrefixedText() );
+               $deleteLogPage = new LogPage( 'delete' );
+               $wgOut->addHTML( '<h2>' . $deleteLogPage->getName()->escaped() . "</h2>\n" );
+               LogEventsList::showLogExtract( $wgOut, 'delete', $this->title );
        }
 
        /**
@@ -248,25 +349,25 @@ class FileDeleteForm {
         * showing an appropriate message depending upon whether
         * it's a current file or an old version
         *
-        * @param $message String: message base
-        * @return String
+        * @param string $message Message base
+        * @return string
         */
        private function prepareMessage( $message ) {
                global $wgLang;
-               if( $this->oldimage ) {
-                       return wfMsgExt(
-                               "{$message}-old", # To ensure grep will find them: 'filedelete-intro-old', 'filedelete-nofile-old', 'filedelete-success-old'
-                               'parse',
-                               $this->title->getText(),
+               if ( $this->oldimage ) {
+                       # Message keys used:
+                       # 'filedelete-intro-old', 'filedelete-nofile-old', 'filedelete-success-old'
+                       return wfMessage(
+                               "{$message}-old",
+                               wfEscapeWikiText( $this->title->getText() ),
                                $wgLang->date( $this->getTimestamp(), true ),
                                $wgLang->time( $this->getTimestamp(), true ),
-                               wfExpandUrl( $this->file->getArchiveUrl( $this->oldimage ) ) );
+                               wfExpandUrl( $this->file->getArchiveUrl( $this->oldimage ), PROTO_CURRENT ) )->parseAsBlock();
                } else {
-                       return wfMsgExt(
+                       return wfMessage(
                                $message,
-                               'parse',
-                               $this->title->getText()
-                       );
+                               wfEscapeWikiText( $this->title->getText() )
+                       )->parseAsBlock();
                }
        }
 
@@ -274,27 +375,19 @@ class FileDeleteForm {
         * Set headers, titles and other bits
         */
        private function setHeaders() {
-               global $wgOut, $wgUser;
-               $wgOut->setPageTitle( wfMsg( 'filedelete', $this->title->getText() ) );
+               global $wgOut;
+               $wgOut->setPageTitle( wfMessage( 'filedelete', $this->title->getText() ) );
                $wgOut->setRobotPolicy( 'noindex,nofollow' );
-               $wgOut->setSubtitle( wfMsg(
-                       'filedelete-backlink',
-                       $wgUser->getSkin()->link(
-                               $this->title,
-                               null,
-                               array(),
-                               array(),
-                               array( 'known', 'noclasses' )
-                       )
-               ) );
+               $wgOut->addBacklinkSubtitle( $this->title );
        }
 
        /**
         * Is the provided `oldimage` value valid?
         *
+        * @param string $oldimage
         * @return bool
         */
-       public static function isValidOldSpec($oldimage) {
+       public static function isValidOldSpec( $oldimage ) {
                return strlen( $oldimage ) >= 16
                        && strpos( $oldimage, '/' ) === false
                        && strpos( $oldimage, '\\' ) === false;
@@ -305,9 +398,12 @@ class FileDeleteForm {
         * value was provided, does it correspond to an
         * existing, local, old version of this file?
         *
+        * @param File &$file
+        * @param File &$oldfile
+        * @param File $oldimage
         * @return bool
         */
-       public static function haveDeletableFile(&$file, &$oldfile, $oldimage) {
+       public static function haveDeletableFile( &$file, &$oldfile, $oldimage ) {
                return $oldimage
                        ? $oldfile && $oldfile->exists() && $oldfile->isLocal()
                        : $file && $file->exists() && $file->isLocal();
@@ -319,13 +415,14 @@ class FileDeleteForm {
         * @return string
         */
        private function getAction() {
-               $q = array();
+               $q = [];
                $q['action'] = 'delete';
 
-               if( $this->oldimage )
+               if ( $this->oldimage ) {
                        $q['oldimage'] = $this->oldimage;
+               }
 
-               return $this->title->getLocalUrl( $q );
+               return $this->title->getLocalURL( $q );
        }
 
        /**