includes/FileDeleteForm.php

   1 <?php
   2 /**
   3  * File deletion user interface.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @author Rob Church <robchur@gmail.com>
  22  * @ingroup Media
  23  */
  24 use MediaWiki\MediaWikiServices;
  25
  26 /**
  27  * File deletion user interface
  28  *
  29  * @ingroup Media
  30  */
  31 class FileDeleteForm {
  32
  33         /**
  34          * @var Title
  35          */
  36         private $title = null;
  37
  38         /**
  39          * @var File
  40          */
  41         private $file = null;
  42
  43         /**
  44          * @var File
  45          */
  46         private $oldfile = null;
  47         private $oldimage = '';
  48
  49         /**
  50          * @param File $file File object we're deleting
  51          */
  52         public function __construct( $file ) {
  53                 $this->title = $file->getTitle();
  54                 $this->file = $file;
  55         }
  56
  57         /**
  58          * Fulfil the request; shows the form or deletes the file,
  59          * pending authentication, confirmation, etc.
  60          */
  61         public function execute() {
  62                 global $wgOut, $wgRequest, $wgUser, $wgUploadMaintenance;
  63
  64                 $permissionErrors = $this->title->getUserPermissionsErrors( 'delete', $wgUser );
  65                 if ( count( $permissionErrors ) ) {
  66                         throw new PermissionsError( 'delete', $permissionErrors );
  67                 }
  68
  69                 if ( wfReadOnly() ) {
  70                         throw new ReadOnlyError;
  71                 }
  72
  73                 if ( $wgUploadMaintenance ) {
  74                         throw new ErrorPageError( 'filedelete-maintenance-title', 'filedelete-maintenance' );
  75                 }
  76
  77                 $this->setHeaders();
  78
  79                 $this->oldimage = $wgRequest->getText( 'oldimage', false );
  80                 $token = $wgRequest->getText( 'wpEditToken' );
  81                 # Flag to hide all contents of the archived revisions
  82                 $suppress = $wgRequest->getCheck( 'wpSuppress' ) && $wgUser->isAllowed( 'suppressrevision' );
  83
  84                 if ( $this->oldimage ) {
  85                         $this->oldfile = RepoGroup::singleton()->getLocalRepo()->newFromArchiveName(
  86                                 $this->title,
  87                                 $this->oldimage
  88                         );
  89                 }
  90
  91                 if ( !self::haveDeletableFile( $this->file, $this->oldfile, $this->oldimage ) ) {
  92                         $wgOut->addHTML( $this->prepareMessage( 'filedelete-nofile' ) );
  93                         $wgOut->addReturnTo( $this->title );
  94                         return;
  95                 }
  96
  97                 // Perform the deletion if appropriate
  98                 if ( $wgRequest->wasPosted() && $wgUser->matchEditToken( $token, $this->oldimage ) ) {
  99                         $deleteReasonList = $wgRequest->getText( 'wpDeleteReasonList' );
 100                         $deleteReason = $wgRequest->getText( 'wpReason' );
 101
 102                         if ( $deleteReasonList == 'other' ) {
 103                                 $reason = $deleteReason;
 104                         } elseif ( $deleteReason != '' ) {
 105                                 // Entry from drop down menu + additional comment
 106                                 $reason = $deleteReasonList . wfMessage( 'colon-separator' )
 107                                         ->inContentLanguage()->text() . $deleteReason;
 108                         } else {
 109                                 $reason = $deleteReasonList;
 110                         }
 111
 112                         $status = self::doDelete(
 113                                 $this->title,
 114                                 $this->file,
 115                                 $this->oldimage,
 116                                 $reason,
 117                                 $suppress,
 118                                 $wgUser
 119                         );
 120
 121                         if ( !$status->isGood() ) {
 122                                 $wgOut->addHTML( '<h2>' . $this->prepareMessage( 'filedeleteerror-short' ) . "</h2>\n" );
 123                                 $wgOut->wrapWikiTextAsInterface(
 124                                         'error',
 125                                         $status->getWikiText( 'filedeleteerror-short', 'filedeleteerror-long' )
 126                                 );
 127                         }
 128                         if ( $status->isOK() ) {
 129                                 $wgOut->setPageTitle( wfMessage( 'actioncomplete' ) );
 130                                 $wgOut->addHTML( $this->prepareMessage( 'filedelete-success' ) );
 131                                 // Return to the main page if we just deleted all versions of the
 132                                 // file, otherwise go back to the description page
 133                                 $wgOut->addReturnTo( $this->oldimage ? $this->title : Title::newMainPage() );
 134
 135                                 WatchAction::doWatchOrUnwatch( $wgRequest->getCheck( 'wpWatch' ), $this->title, $wgUser );
 136                         }
 137                         return;
 138                 }
 139
 140                 $this->showForm();
 141                 $this->showLogEntries();
 142         }
 143
 144         /**
 145          * Really delete the file
 146          *
 147          * @param Title &$title
 148          * @param File &$file
 149          * @param string &$oldimage Archive name
 150          * @param string $reason Reason of the deletion
 151          * @param bool $suppress Whether to mark all deleted versions as restricted
 152          * @param User|null $user User object performing the request
 153          * @param array $tags Tags to apply to the deletion action
 154          * @throws MWException
 155          * @return Status
 156          */
 157         public static function doDelete( &$title, &$file, &$oldimage, $reason,
 158                 $suppress, User $user = null, $tags = []
 159         ) {
 160                 if ( $user === null ) {
 161                         global $wgUser;
 162                         $user = $wgUser;
 163                 }
 164
 165                 if ( $oldimage ) {
 166                         $page = null;
 167                         $status = $file->deleteOld( $oldimage, $reason, $suppress, $user );
 168                         if ( $status->ok ) {
 169                                 // Need to do a log item
 170                                 $logComment = wfMessage( 'deletedrevision', $oldimage )->inContentLanguage()->text();
 171                                 if ( trim( $reason ) != '' ) {
 172                                         $logComment .= wfMessage( 'colon-separator' )
 173                                                 ->inContentLanguage()->text() . $reason;
 174                                 }
 175
 176                                 $logtype = $suppress ? 'suppress' : 'delete';
 177
 178                                 $logEntry = new ManualLogEntry( $logtype, 'delete' );
 179                                 $logEntry->setPerformer( $user );
 180                                 $logEntry->setTarget( $title );
 181                                 $logEntry->setComment( $logComment );
 182                                 $logEntry->setTags( $tags );
 183                                 $logid = $logEntry->insert();
 184                                 $logEntry->publish( $logid );
 185
 186                                 $status->value = $logid;
 187                         }
 188                 } else {
 189                         $status = Status::newFatal( 'cannotdelete',
 190                                 wfEscapeWikiText( $title->getPrefixedText() )
 191                         );
 192                         $page = WikiPage::factory( $title );
 193                         $dbw = wfGetDB( DB_MASTER );
 194                         $dbw->startAtomic( __METHOD__ );
 195                         // delete the associated article first
 196                         $error = '';
 197                         $deleteStatus = $page->doDeleteArticleReal( $reason, $suppress, 0, false, $error,
 198                                 $user, $tags );
 199                         // doDeleteArticleReal() returns a non-fatal error status if the page
 200                         // or revision is missing, so check for isOK() rather than isGood()
 201                         if ( $deleteStatus->isOK() ) {
 202                                 $status = $file->delete( $reason, $suppress, $user );
 203                                 if ( $status->isOK() ) {
 204                                         if ( $deleteStatus->value === null ) {
 205                                                 // No log ID from doDeleteArticleReal(), probably
 206                                                 // because the page/revision didn't exist, so create
 207                                                 // one here.
 208                                                 $logtype = $suppress ? 'suppress' : 'delete';
 209                                                 $logEntry = new ManualLogEntry( $logtype, 'delete' );
 210                                                 $logEntry->setPerformer( $user );
 211                                                 $logEntry->setTarget( clone $title );
 212                                                 $logEntry->setComment( $reason );
 213                                                 $logEntry->setTags( $tags );
 214                                                 $logid = $logEntry->insert();
 215                                                 $dbw->onTransactionPreCommitOrIdle(
 216                                                         function () use ( $logEntry, $logid ) {
 217                                                                 $logEntry->publish( $logid );
 218                                                         },
 219                                                         __METHOD__
 220                                                 );
 221                                                 $status->value = $logid;
 222                                         } else {
 223                                                 $status->value = $deleteStatus->value; // log id
 224                                         }
 225                                         $dbw->endAtomic( __METHOD__ );
 226                                 } else {
 227                                         // Page deleted but file still there? rollback page delete
 228                                         $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
 229                                         $lbFactory->rollbackMasterChanges( __METHOD__ );
 230                                 }
 231                         } else {
 232                                 // Done; nothing changed
 233                                 $dbw->endAtomic( __METHOD__ );
 234                         }
 235                 }
 236
 237                 if ( $status->isOK() ) {
 238                         Hooks::run( 'FileDeleteComplete', [ &$file, &$oldimage, &$page, &$user, &$reason ] );
 239                 }
 240
 241                 return $status;
 242         }
 243
 244         /**
 245          * Show the confirmation form
 246          */
 247         private function showForm() {
 248                 global $wgOut, $wgUser, $wgRequest;
 249
 250                 $conf = RequestContext::getMain()->getConfig();
 251                 $oldCommentSchema = $conf->get( 'CommentTableSchemaMigrationStage' ) === MIGRATION_OLD;
 252
 253                 $wgOut->addModules( 'mediawiki.action.delete.file' );
 254
 255                 $checkWatch = $wgUser->getBoolOption( 'watchdeletion' ) || $wgUser->isWatched( $this->title );
 256
 257                 $wgOut->enableOOUI();
 258
 259                 $options = Xml::listDropDownOptions(
 260                         $wgOut->msg( 'filedelete-reason-dropdown' )->inContentLanguage()->text(),
 261                         [ 'other' => $wgOut->msg( 'filedelete-reason-otherlist' )->inContentLanguage()->text() ]
 262                 );
 263                 $options = Xml::listDropDownOptionsOoui( $options );
 264
 265                 $fields[] = new OOUI\LabelWidget( [ 'label' => new OOUI\HtmlSnippet(
 266                         $this->prepareMessage( 'filedelete-intro' ) ) ]
 267                 );
 268
 269                 $fields[] = new OOUI\FieldLayout(
 270                         new OOUI\DropdownInputWidget( [
 271                                 'name' => 'wpDeleteReasonList',
 272                                 'inputId' => 'wpDeleteReasonList',
 273                                 'tabIndex' => 1,
 274                                 'infusable' => true,
 275                                 'value' => '',
 276                                 'options' => $options,
 277                         ] ),
 278                         [
 279                                 'label' => $wgOut->msg( 'filedelete-comment' )->text(),
 280                                 'align' => 'top',
 281                         ]
 282                 );
 283
 284                 // HTML maxlength uses "UTF-16 code units", which means that characters outside BMP
 285                 // (e.g. emojis) count for two each. This limit is overridden in JS to instead count
 286                 // Unicode codepoints (or 255 UTF-8 bytes for old schema).
 287                 $fields[] = new OOUI\FieldLayout(
 288                         new OOUI\TextInputWidget( [
 289                                 'name' => 'wpReason',
 290                                 'inputId' => 'wpReason',
 291                                 'tabIndex' => 2,
 292                                 'maxLength' => $oldCommentSchema ? 255 : CommentStore::COMMENT_CHARACTER_LIMIT,
 293                                 'infusable' => true,
 294                                 'value' => $wgRequest->getText( 'wpReason' ),
 295                                 'autofocus' => true,
 296                         ] ),
 297                         [
 298                                 'label' => $wgOut->msg( 'filedelete-otherreason' )->text(),
 299                                 'align' => 'top',
 300                         ]
 301                 );
 302
 303                 if ( $wgUser->isAllowed( 'suppressrevision' ) ) {
 304                         $fields[] = new OOUI\FieldLayout(
 305                                 new OOUI\CheckboxInputWidget( [
 306                                         'name' => 'wpSuppress',
 307                                         'inputId' => 'wpSuppress',
 308                                         'tabIndex' => 3,
 309                                         'selected' => false,
 310                                 ] ),
 311                                 [
 312                                         'label' => $wgOut->msg( 'revdelete-suppress' )->text(),
 313                                         'align' => 'inline',
 314                                         'infusable' => true,
 315                                 ]
 316                         );
 317                 }
 318
 319                 if ( $wgUser->isLoggedIn() ) {
 320                         $fields[] = new OOUI\FieldLayout(
 321                                 new OOUI\CheckboxInputWidget( [
 322                                         'name' => 'wpWatch',
 323                                         'inputId' => 'wpWatch',
 324                                         'tabIndex' => 3,
 325                                         'selected' => $checkWatch,
 326                                 ] ),
 327                                 [
 328                                         'label' => $wgOut->msg( 'watchthis' )->text(),
 329                                         'align' => 'inline',
 330                                         'infusable' => true,
 331                                 ]
 332                         );
 333                 }
 334
 335                 $fields[] = new OOUI\FieldLayout(
 336                         new OOUI\ButtonInputWidget( [
 337                                 'name' => 'mw-filedelete-submit',
 338                                 'inputId' => 'mw-filedelete-submit',
 339                                 'tabIndex' => 4,
 340                                 'value' => $wgOut->msg( 'filedelete-submit' )->text(),
 341                                 'label' => $wgOut->msg( 'filedelete-submit' )->text(),
 342                                 'flags' => [ 'primary', 'destructive' ],
 343                                 'type' => 'submit',
 344                         ] ),
 345                         [
 346                                 'align' => 'top',
 347                         ]
 348                 );
 349
 350                 $fieldset = new OOUI\FieldsetLayout( [
 351                         'label' => $wgOut->msg( 'filedelete-legend' )->text(),
 352                         'items' => $fields,
 353                 ] );
 354
 355                 $form = new OOUI\FormLayout( [
 356                         'method' => 'post',
 357                         'action' => $this->getAction(),
 358                         'id' => 'mw-img-deleteconfirm',
 359                 ] );
 360                 $form->appendContent(
 361                         $fieldset,
 362                         new OOUI\HtmlSnippet(
 363                                 Html::hidden( 'wpEditToken', $wgUser->getEditToken( $this->oldimage ) )
 364                         )
 365                 );
 366
 367                 $wgOut->addHTML(
 368                         new OOUI\PanelLayout( [
 369                                 'classes' => [ 'deletepage-wrapper' ],
 370                                 'expanded' => false,
 371                                 'padded' => true,
 372                                 'framed' => true,
 373                                 'content' => $form,
 374                         ] )
 375                 );
 376
 377                 if ( $wgUser->isAllowed( 'editinterface' ) ) {
 378                         $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
 379                         $link = $linkRenderer->makeKnownLink(
 380                                 $wgOut->msg( 'filedelete-reason-dropdown' )->inContentLanguage()->getTitle(),
 381                                 wfMessage( 'filedelete-edit-reasonlist' )->text(),
 382                                 [],
 383                                 [ 'action' => 'edit' ]
 384                         );
 385                         $wgOut->addHTML( '<p class="mw-filedelete-editreasons">' . $link . '</p>' );
 386                 }
 387         }
 388
 389         /**
 390          * Show deletion log fragments pertaining to the current file
 391          */
 392         private function showLogEntries() {
 393                 global $wgOut;
 394                 $deleteLogPage = new LogPage( 'delete' );
 395                 $wgOut->addHTML( '<h2>' . $deleteLogPage->getName()->escaped() . "</h2>\n" );
 396                 LogEventsList::showLogExtract( $wgOut, 'delete', $this->title );
 397         }
 398
 399         /**
 400          * Prepare a message referring to the file being deleted,
 401          * showing an appropriate message depending upon whether
 402          * it's a current file or an old version
 403          *
 404          * @param string $message Message base
 405          * @return string
 406          */
 407         private function prepareMessage( $message ) {
 408                 global $wgLang;
 409                 if ( $this->oldimage ) {
 410                         # Message keys used:
 411                         # 'filedelete-intro-old', 'filedelete-nofile-old', 'filedelete-success-old'
 412                         return wfMessage(
 413                                 "{$message}-old",
 414                                 wfEscapeWikiText( $this->title->getText() ),
 415                                 $wgLang->date( $this->getTimestamp(), true ),
 416                                 $wgLang->time( $this->getTimestamp(), true ),
 417                                 wfExpandUrl( $this->file->getArchiveUrl( $this->oldimage ), PROTO_CURRENT ) )->parseAsBlock();
 418                 } else {
 419                         return wfMessage(
 420                                 $message,
 421                                 wfEscapeWikiText( $this->title->getText() )
 422                         )->parseAsBlock();
 423                 }
 424         }
 425
 426         /**
 427          * Set headers, titles and other bits
 428          */
 429         private function setHeaders() {
 430                 global $wgOut;
 431                 $wgOut->setPageTitle( wfMessage( 'filedelete', $this->title->getText() ) );
 432                 $wgOut->setRobotPolicy( 'noindex,nofollow' );
 433                 $wgOut->addBacklinkSubtitle( $this->title );
 434         }
 435
 436         /**
 437          * Is the provided `oldimage` value valid?
 438          *
 439          * @param string $oldimage
 440          * @return bool
 441          */
 442         public static function isValidOldSpec( $oldimage ) {
 443                 return strlen( $oldimage ) >= 16
 444                         && strpos( $oldimage, '/' ) === false
 445                         && strpos( $oldimage, '\\' ) === false;
 446         }
 447
 448         /**
 449          * Could we delete the file specified? If an `oldimage`
 450          * value was provided, does it correspond to an
 451          * existing, local, old version of this file?
 452          *
 453          * @param File &$file
 454          * @param File &$oldfile
 455          * @param File $oldimage
 456          * @return bool
 457          */
 458         public static function haveDeletableFile( &$file, &$oldfile, $oldimage ) {
 459                 return $oldimage
 460                         ? $oldfile && $oldfile->exists() && $oldfile->isLocal()
 461                         : $file && $file->exists() && $file->isLocal();
 462         }
 463
 464         /**
 465          * Prepare the form action
 466          *
 467          * @return string
 468          */
 469         private function getAction() {
 470                 $q = [];
 471                 $q['action'] = 'delete';
 472
 473                 if ( $this->oldimage ) {
 474                         $q['oldimage'] = $this->oldimage;
 475                 }
 476
 477                 return $this->title->getLocalURL( $q );
 478         }
 479
 480         /**
 481          * Extract the timestamp of the old version
 482          *
 483          * @return string
 484          */
 485         private function getTimestamp() {
 486                 return $this->oldfile->getTimestamp();
 487         }
 488 }