includes/api/ApiUpload.php

   1 <?php
   2 /**
   3  *
   4  *
   5  * Created on Aug 21, 2008
   6  *
   7  * Copyright © 2008 - 2010 Bryan Tong Minh <Bryan.TongMinh@Gmail.com>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; if not, write to the Free Software Foundation, Inc.,
  21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  22  * http://www.gnu.org/copyleft/gpl.html
  23  *
  24  * @file
  25  */
  26
  27 /**
  28  * @ingroup API
  29  */
  30 class ApiUpload extends ApiBase {
  31         /** @var UploadBase|UploadFromChunks */
  32         protected $mUpload = null;
  33
  34         protected $mParams;
  35
  36         public function execute() {
  37                 // Check whether upload is enabled
  38                 if ( !UploadBase::isEnabled() ) {
  39                         $this->dieUsageMsg( 'uploaddisabled' );
  40                 }
  41
  42                 $user = $this->getUser();
  43
  44                 // Parameter handling
  45                 $this->mParams = $this->extractRequestParams();
  46                 $request = $this->getMain()->getRequest();
  47                 // Check if async mode is actually supported (jobs done in cli mode)
  48                 $this->mParams['async'] = ( $this->mParams['async'] &&
  49                         $this->getConfig()->get( 'EnableAsyncUploads' ) );
  50                 // Add the uploaded file to the params array
  51                 $this->mParams['file'] = $request->getFileName( 'file' );
  52                 $this->mParams['chunk'] = $request->getFileName( 'chunk' );
  53
  54                 // Copy the session key to the file key, for backward compatibility.
  55                 if ( !$this->mParams['filekey'] && $this->mParams['sessionkey'] ) {
  56                         $this->mParams['filekey'] = $this->mParams['sessionkey'];
  57                 }
  58
  59                 // Select an upload module
  60                 try {
  61                         if ( !$this->selectUploadModule() ) {
  62                                 return; // not a true upload, but a status request or similar
  63                         } elseif ( !isset( $this->mUpload ) ) {
  64                                 $this->dieUsage( 'No upload module set', 'nomodule' );
  65                         }
  66                 } catch ( UploadStashException $e ) { // XXX: don't spam exception log
  67                         list( $msg, $code ) = $this->handleStashException( get_class( $e ), $e->getMessage() );
  68                         $this->dieUsage( $msg, $code );
  69                 }
  70
  71                 // First check permission to upload
  72                 $this->checkPermissions( $user );
  73
  74                 // Fetch the file (usually a no-op)
  75                 /** @var $status Status */
  76                 $status = $this->mUpload->fetchFile();
  77                 if ( !$status->isGood() ) {
  78                         $errors = $status->getErrorsArray();
  79                         $error = array_shift( $errors[0] );
  80                         $this->dieUsage( 'Error fetching file from remote source', $error, 0, $errors[0] );
  81                 }
  82
  83                 // Check if the uploaded file is sane
  84                 if ( $this->mParams['chunk'] ) {
  85                         $maxSize = UploadBase::getMaxUploadSize();
  86                         if ( $this->mParams['filesize'] > $maxSize ) {
  87                                 $this->dieUsage( 'The file you submitted was too large', 'file-too-large' );
  88                         }
  89                         if ( !$this->mUpload->getTitle() ) {
  90                                 $this->dieUsage( 'Invalid file title supplied', 'internal-error' );
  91                         }
  92                 } elseif ( $this->mParams['async'] && $this->mParams['filekey'] ) {
  93                         // defer verification to background process
  94                 } else {
  95                         wfDebug( __METHOD__ . " about to verify\n" );
  96                         $this->verifyUpload();
  97                 }
  98
  99                 // Check if the user has the rights to modify or overwrite the requested title
 100                 // (This check is irrelevant if stashing is already requested, since the errors
 101                 //  can always be fixed by changing the title)
 102                 if ( !$this->mParams['stash'] ) {
 103                         $permErrors = $this->mUpload->verifyTitlePermissions( $user );
 104                         if ( $permErrors !== true ) {
 105                                 $this->dieRecoverableError( $permErrors[0], 'filename' );
 106                         }
 107                 }
 108
 109                 // Get the result based on the current upload context:
 110                 try {
 111                         $result = $this->getContextResult();
 112                         if ( $result['result'] === 'Success' ) {
 113                                 $result['imageinfo'] = $this->mUpload->getImageInfo( $this->getResult() );
 114                         }
 115                 } catch ( UploadStashException $e ) { // XXX: don't spam exception log
 116                         list( $msg, $code ) = $this->handleStashException( get_class( $e ), $e->getMessage() );
 117                         $this->dieUsage( $msg, $code );
 118                 }
 119
 120                 $this->getResult()->addValue( null, $this->getModuleName(), $result );
 121
 122                 // Cleanup any temporary mess
 123                 $this->mUpload->cleanupTempFile();
 124         }
 125
 126         /**
 127          * Get an upload result based on upload context
 128          * @return array
 129          */
 130         private function getContextResult() {
 131                 $warnings = $this->getApiWarnings();
 132                 if ( $warnings && !$this->mParams['ignorewarnings'] ) {
 133                         // Get warnings formatted in result array format
 134                         return $this->getWarningsResult( $warnings );
 135                 } elseif ( $this->mParams['chunk'] ) {
 136                         // Add chunk, and get result
 137                         return $this->getChunkResult( $warnings );
 138                 } elseif ( $this->mParams['stash'] ) {
 139                         // Stash the file and get stash result
 140                         return $this->getStashResult( $warnings );
 141                 }
 142
 143                 // Check throttle after we've handled warnings
 144                 if ( UploadBase::isThrottled( $this->getUser() )
 145                 ) {
 146                         $this->dieUsageMsg( 'actionthrottledtext' );
 147                 }
 148
 149                 // This is the most common case -- a normal upload with no warnings
 150                 // performUpload will return a formatted properly for the API with status
 151                 return $this->performUpload( $warnings );
 152         }
 153
 154         /**
 155          * Get Stash Result, throws an exception if the file could not be stashed.
 156          * @param array $warnings Array of Api upload warnings
 157          * @return array
 158          */
 159         private function getStashResult( $warnings ) {
 160                 $result = [];
 161                 $result['result'] = 'Success';
 162                 if ( $warnings && count( $warnings ) > 0 ) {
 163                         $result['warnings'] = $warnings;
 164                 }
 165                 // Some uploads can request they be stashed, so as not to publish them immediately.
 166                 // In this case, a failure to stash ought to be fatal
 167                 $this->performStash( 'critical', $result );
 168
 169                 return $result;
 170         }
 171
 172         /**
 173          * Get Warnings Result
 174          * @param array $warnings Array of Api upload warnings
 175          * @return array
 176          */
 177         private function getWarningsResult( $warnings ) {
 178                 $result = [];
 179                 $result['result'] = 'Warning';
 180                 $result['warnings'] = $warnings;
 181                 // in case the warnings can be fixed with some further user action, let's stash this upload
 182                 // and return a key they can use to restart it
 183                 $this->performStash( 'optional', $result );
 184
 185                 return $result;
 186         }
 187
 188         /**
 189          * Get the result of a chunk upload.
 190          * @param array $warnings Array of Api upload warnings
 191          * @return array
 192          */
 193         private function getChunkResult( $warnings ) {
 194                 $result = [];
 195
 196                 if ( $warnings && count( $warnings ) > 0 ) {
 197                         $result['warnings'] = $warnings;
 198                 }
 199
 200                 $request = $this->getMain()->getRequest();
 201                 $chunkPath = $request->getFileTempname( 'chunk' );
 202                 $chunkSize = $request->getUpload( 'chunk' )->getSize();
 203                 $totalSoFar = $this->mParams['offset'] + $chunkSize;
 204                 $minChunkSize = $this->getConfig()->get( 'MinUploadChunkSize' );
 205
 206                 // Sanity check sizing
 207                 if ( $totalSoFar > $this->mParams['filesize'] ) {
 208                         $this->dieUsage(
 209                                 'Offset plus current chunk is greater than claimed file size', 'invalid-chunk'
 210                         );
 211                 }
 212
 213                 // Enforce minimum chunk size
 214                 if ( $totalSoFar != $this->mParams['filesize'] && $chunkSize < $minChunkSize ) {
 215                         $this->dieUsage(
 216                                 "Minimum chunk size is $minChunkSize bytes for non-final chunks", 'chunk-too-small'
 217                         );
 218                 }
 219
 220                 if ( $this->mParams['offset'] == 0 ) {
 221                         $filekey = $this->performStash( 'critical' );
 222                 } else {
 223                         $filekey = $this->mParams['filekey'];
 224
 225                         // Don't allow further uploads to an already-completed session
 226                         $progress = UploadBase::getSessionStatus( $this->getUser(), $filekey );
 227                         if ( !$progress ) {
 228                                 // Probably can't get here, but check anyway just in case
 229                                 $this->dieUsage( 'No chunked upload session with this key', 'stashfailed' );
 230                         } elseif ( $progress['result'] !== 'Continue' || $progress['stage'] !== 'uploading' ) {
 231                                 $this->dieUsage(
 232                                         'Chunked upload is already completed, check status for details', 'stashfailed'
 233                                 );
 234                         }
 235
 236                         $status = $this->mUpload->addChunk(
 237                                 $chunkPath, $chunkSize, $this->mParams['offset'] );
 238                         if ( !$status->isGood() ) {
 239                                 $extradata = [
 240                                         'offset' => $this->mUpload->getOffset(),
 241                                 ];
 242
 243                                 $this->dieStatusWithCode( $status, 'stashfailed', $extradata );
 244                         }
 245                 }
 246
 247                 // Check we added the last chunk:
 248                 if ( $totalSoFar == $this->mParams['filesize'] ) {
 249                         if ( $this->mParams['async'] ) {
 250                                 UploadBase::setSessionStatus(
 251                                         $this->getUser(),
 252                                         $filekey,
 253                                         [ 'result' => 'Poll',
 254                                                 'stage' => 'queued', 'status' => Status::newGood() ]
 255                                 );
 256                                 JobQueueGroup::singleton()->push( new AssembleUploadChunksJob(
 257                                         Title::makeTitle( NS_FILE, $filekey ),
 258                                         [
 259                                                 'filename' => $this->mParams['filename'],
 260                                                 'filekey' => $filekey,
 261                                                 'session' => $this->getContext()->exportSession()
 262                                         ]
 263                                 ) );
 264                                 $result['result'] = 'Poll';
 265                                 $result['stage'] = 'queued';
 266                         } else {
 267                                 $status = $this->mUpload->concatenateChunks();
 268                                 if ( !$status->isGood() ) {
 269                                         UploadBase::setSessionStatus(
 270                                                 $this->getUser(),
 271                                                 $filekey,
 272                                                 [ 'result' => 'Failure', 'stage' => 'assembling', 'status' => $status ]
 273                                         );
 274                                         $this->dieStatusWithCode( $status, 'stashfailed' );
 275                                 }
 276
 277                                 // We can only get warnings like 'duplicate' after concatenating the chunks
 278                                 $warnings = $this->getApiWarnings();
 279                                 if ( $warnings ) {
 280                                         $result['warnings'] = $warnings;
 281                                 }
 282
 283                                 // The fully concatenated file has a new filekey. So remove
 284                                 // the old filekey and fetch the new one.
 285                                 UploadBase::setSessionStatus( $this->getUser(), $filekey, false );
 286                                 $this->mUpload->stash->removeFile( $filekey );
 287                                 $filekey = $this->mUpload->getStashFile()->getFileKey();
 288
 289                                 $result['result'] = 'Success';
 290                         }
 291                 } else {
 292                         UploadBase::setSessionStatus(
 293                                 $this->getUser(),
 294                                 $filekey,
 295                                 [
 296                                         'result' => 'Continue',
 297                                         'stage' => 'uploading',
 298                                         'offset' => $totalSoFar,
 299                                         'status' => Status::newGood(),
 300                                 ]
 301                         );
 302                         $result['result'] = 'Continue';
 303                         $result['offset'] = $totalSoFar;
 304                 }
 305
 306                 $result['filekey'] = $filekey;
 307
 308                 return $result;
 309         }
 310
 311         /**
 312          * Stash the file and add the file key, or error information if it fails, to the data.
 313          *
 314          * @param string $failureMode What to do on failure to stash:
 315          *   - When 'critical', use dieStatus() to produce an error response and throw an exception.
 316          *     Use this when stashing the file was the primary purpose of the API request.
 317          *   - When 'optional', only add a 'stashfailed' key to the data and return null.
 318          *     Use this when some error happened for a non-stash upload and we're stashing the file
 319          *     only to save the client the trouble of re-uploading it.
 320          * @param array &$data API result to which to add the information
 321          * @return string|null File key
 322          */
 323         private function performStash( $failureMode, &$data = null ) {
 324                 $isPartial = (bool)$this->mParams['chunk'];
 325                 try {
 326                         $status = $this->mUpload->tryStashFile( $this->getUser(), $isPartial );
 327
 328                         if ( $status->isGood() && !$status->getValue() ) {
 329                                 // Not actually a 'good' status...
 330                                 $status->fatal( new ApiRawMessage( 'Invalid stashed file', 'stashfailed' ) );
 331                         }
 332                 } catch ( Exception $e ) {
 333                         $debugMessage = 'Stashing temporary file failed: ' . get_class( $e ) . ' ' . $e->getMessage();
 334                         wfDebug( __METHOD__ . ' ' . $debugMessage . "\n" );
 335                         $status = Status::newFatal( new ApiRawMessage( $e->getMessage(), 'stashfailed' ) );
 336                 }
 337
 338                 if ( $status->isGood() ) {
 339                         $stashFile = $status->getValue();
 340                         $data['filekey'] = $stashFile->getFileKey();
 341                         // Backwards compatibility
 342                         $data['sessionkey'] = $data['filekey'];
 343                         return $data['filekey'];
 344                 }
 345
 346                 if ( $status->getMessage()->getKey() === 'uploadstash-exception' ) {
 347                         // The exceptions thrown by upload stash code and pretty silly and UploadBase returns poor
 348                         // Statuses for it. Just extract the exception details and parse them ourselves.
 349                         list( $exceptionType, $message ) = $status->getMessage()->getParams();
 350                         $debugMessage = 'Stashing temporary file failed: ' . $exceptionType . ' ' . $message;
 351                         wfDebug( __METHOD__ . ' ' . $debugMessage . "\n" );
 352                         list( $msg, $code ) = $this->handleStashException( $exceptionType, $message );
 353                         $status = Status::newFatal( new ApiRawMessage( $msg, $code ) );
 354                 }
 355
 356                 // Bad status
 357                 if ( $failureMode !== 'optional' ) {
 358                         $this->dieStatus( $status );
 359                 } else {
 360                         list( $code, $msg ) = $this->getErrorFromStatus( $status );
 361                         $data['stashfailed'] = $msg;
 362                         return null;
 363                 }
 364         }
 365
 366         /**
 367          * Throw an error that the user can recover from by providing a better
 368          * value for $parameter
 369          *
 370          * @param array|string|MessageSpecifier $error Error suitable for passing to dieUsageMsg()
 371          * @param string $parameter Parameter that needs revising
 372          * @param array $data Optional extra data to pass to the user
 373          * @param string $code Error code to use if the error is unknown
 374          * @throws UsageException
 375          */
 376         private function dieRecoverableError( $error, $parameter, $data = [], $code = 'unknownerror' ) {
 377                 $this->performStash( 'optional', $data );
 378                 $data['invalidparameter'] = $parameter;
 379
 380                 $parsed = $this->parseMsg( $error );
 381                 if ( isset( $parsed['data'] ) ) {
 382                         $data = array_merge( $data, $parsed['data'] );
 383                 }
 384                 if ( $parsed['code'] === 'unknownerror' ) {
 385                         $parsed['code'] = $code;
 386                 }
 387
 388                 $this->dieUsage( $parsed['info'], $parsed['code'], 0, $data );
 389         }
 390
 391         /**
 392          * Like dieStatus(), but always uses $overrideCode for the error code, unless the code comes from
 393          * IApiMessage.
 394          *
 395          * @param Status $status
 396          * @param string $overrideCode Error code to use if there isn't one from IApiMessage
 397          * @param array|null $moreExtraData
 398          * @throws UsageException
 399          */
 400         public function dieStatusWithCode( $status, $overrideCode, $moreExtraData = null ) {
 401                 $extraData = null;
 402                 list( $code, $msg ) = $this->getErrorFromStatus( $status, $extraData );
 403                 $errors = $status->getErrorsByType( 'error' ) ?: $status->getErrorsByType( 'warning' );
 404                 if ( !( $errors[0]['message'] instanceof IApiMessage ) ) {
 405                         $code = $overrideCode;
 406                 }
 407                 if ( $moreExtraData ) {
 408                         $extraData += $moreExtraData;
 409                 }
 410                 $this->dieUsage( $msg, $code, 0, $extraData );
 411         }
 412
 413         /**
 414          * Select an upload module and set it to mUpload. Dies on failure. If the
 415          * request was a status request and not a true upload, returns false;
 416          * otherwise true
 417          *
 418          * @return bool
 419          */
 420         protected function selectUploadModule() {
 421                 $request = $this->getMain()->getRequest();
 422
 423                 // chunk or one and only one of the following parameters is needed
 424                 if ( !$this->mParams['chunk'] ) {
 425                         $this->requireOnlyOneParameter( $this->mParams,
 426                                 'filekey', 'file', 'url' );
 427                 }
 428
 429                 // Status report for "upload to stash"/"upload from stash"
 430                 if ( $this->mParams['filekey'] && $this->mParams['checkstatus'] ) {
 431                         $progress = UploadBase::getSessionStatus( $this->getUser(), $this->mParams['filekey'] );
 432                         if ( !$progress ) {
 433                                 $this->dieUsage( 'No result in status data', 'missingresult' );
 434                         } elseif ( !$progress['status']->isGood() ) {
 435                                 $this->dieStatusWithCode( $progress['status'], 'stashfailed' );
 436                         }
 437                         if ( isset( $progress['status']->value['verification'] ) ) {
 438                                 $this->checkVerification( $progress['status']->value['verification'] );
 439                         }
 440                         if ( isset( $progress['status']->value['warnings'] ) ) {
 441                                 $warnings = $this->transformWarnings( $progress['status']->value['warnings'] );
 442                                 if ( $warnings ) {
 443                                         $progress['warnings'] = $warnings;
 444                                 }
 445                         }
 446                         unset( $progress['status'] ); // remove Status object
 447                         $this->getResult()->addValue( null, $this->getModuleName(), $progress );
 448
 449                         return false;
 450                 }
 451
 452                 // The following modules all require the filename parameter to be set
 453                 if ( is_null( $this->mParams['filename'] ) ) {
 454                         $this->dieUsageMsg( [ 'missingparam', 'filename' ] );
 455                 }
 456
 457                 if ( $this->mParams['chunk'] ) {
 458                         // Chunk upload
 459                         $this->mUpload = new UploadFromChunks( $this->getUser() );
 460                         if ( isset( $this->mParams['filekey'] ) ) {
 461                                 if ( $this->mParams['offset'] === 0 ) {
 462                                         $this->dieUsage( 'Cannot supply a filekey when offset is 0', 'badparams' );
 463                                 }
 464
 465                                 // handle new chunk
 466                                 $this->mUpload->continueChunks(
 467                                         $this->mParams['filename'],
 468                                         $this->mParams['filekey'],
 469                                         $request->getUpload( 'chunk' )
 470                                 );
 471                         } else {
 472                                 if ( $this->mParams['offset'] !== 0 ) {
 473                                         $this->dieUsage( 'Must supply a filekey when offset is non-zero', 'badparams' );
 474                                 }
 475
 476                                 // handle first chunk
 477                                 $this->mUpload->initialize(
 478                                         $this->mParams['filename'],
 479                                         $request->getUpload( 'chunk' )
 480                                 );
 481                         }
 482                 } elseif ( isset( $this->mParams['filekey'] ) ) {
 483                         // Upload stashed in a previous request
 484                         if ( !UploadFromStash::isValidKey( $this->mParams['filekey'] ) ) {
 485                                 $this->dieUsageMsg( 'invalid-file-key' );
 486                         }
 487
 488                         $this->mUpload = new UploadFromStash( $this->getUser() );
 489                         // This will not download the temp file in initialize() in async mode.
 490                         // We still have enough information to call checkWarnings() and such.
 491                         $this->mUpload->initialize(
 492                                 $this->mParams['filekey'], $this->mParams['filename'], !$this->mParams['async']
 493                         );
 494                 } elseif ( isset( $this->mParams['file'] ) ) {
 495                         $this->mUpload = new UploadFromFile();
 496                         $this->mUpload->initialize(
 497                                 $this->mParams['filename'],
 498                                 $request->getUpload( 'file' )
 499                         );
 500                 } elseif ( isset( $this->mParams['url'] ) ) {
 501                         // Make sure upload by URL is enabled:
 502                         if ( !UploadFromUrl::isEnabled() ) {
 503                                 $this->dieUsageMsg( 'copyuploaddisabled' );
 504                         }
 505
 506                         if ( !UploadFromUrl::isAllowedHost( $this->mParams['url'] ) ) {
 507                                 $this->dieUsageMsg( 'copyuploadbaddomain' );
 508                         }
 509
 510                         if ( !UploadFromUrl::isAllowedUrl( $this->mParams['url'] ) ) {
 511                                 $this->dieUsageMsg( 'copyuploadbadurl' );
 512                         }
 513
 514                         $this->mUpload = new UploadFromUrl;
 515                         $this->mUpload->initialize( $this->mParams['filename'],
 516                                 $this->mParams['url'] );
 517                 }
 518
 519                 return true;
 520         }
 521
 522         /**
 523          * Checks that the user has permissions to perform this upload.
 524          * Dies with usage message on inadequate permissions.
 525          * @param User $user The user to check.
 526          */
 527         protected function checkPermissions( $user ) {
 528                 // Check whether the user has the appropriate permissions to upload anyway
 529                 $permission = $this->mUpload->isAllowed( $user );
 530
 531                 if ( $permission !== true ) {
 532                         if ( !$user->isLoggedIn() ) {
 533                                 $this->dieUsageMsg( [ 'mustbeloggedin', 'upload' ] );
 534                         }
 535
 536                         $this->dieUsageMsg( 'badaccess-groups' );
 537                 }
 538
 539                 // Check blocks
 540                 if ( $user->isBlocked() ) {
 541                         $this->dieBlocked( $user->getBlock() );
 542                 }
 543
 544                 // Global blocks
 545                 if ( $user->isBlockedGlobally() ) {
 546                         $this->dieBlocked( $user->getGlobalBlock() );
 547                 }
 548         }
 549
 550         /**
 551          * Performs file verification, dies on error.
 552          */
 553         protected function verifyUpload() {
 554                 $verification = $this->mUpload->verifyUpload();
 555                 if ( $verification['status'] === UploadBase::OK ) {
 556                         return;
 557                 }
 558
 559                 $this->checkVerification( $verification );
 560         }
 561
 562         /**
 563          * Performs file verification, dies on error.
 564          * @param array $verification
 565          */
 566         protected function checkVerification( array $verification ) {
 567                 // @todo Move them to ApiBase's message map
 568                 switch ( $verification['status'] ) {
 569                         // Recoverable errors
 570                         case UploadBase::MIN_LENGTH_PARTNAME:
 571                                 $this->dieRecoverableError( 'filename-tooshort', 'filename' );
 572                                 break;
 573                         case UploadBase::ILLEGAL_FILENAME:
 574                                 $this->dieRecoverableError( 'illegal-filename', 'filename',
 575                                         [ 'filename' => $verification['filtered'] ] );
 576                                 break;
 577                         case UploadBase::FILENAME_TOO_LONG:
 578                                 $this->dieRecoverableError( 'filename-toolong', 'filename' );
 579                                 break;
 580                         case UploadBase::FILETYPE_MISSING:
 581                                 $this->dieRecoverableError( 'filetype-missing', 'filename' );
 582                                 break;
 583                         case UploadBase::WINDOWS_NONASCII_FILENAME:
 584                                 $this->dieRecoverableError( 'windows-nonascii-filename', 'filename' );
 585                                 break;
 586
 587                         // Unrecoverable errors
 588                         case UploadBase::EMPTY_FILE:
 589                                 $this->dieUsage( 'The file you submitted was empty', 'empty-file' );
 590                                 break;
 591                         case UploadBase::FILE_TOO_LARGE:
 592                                 $this->dieUsage( 'The file you submitted was too large', 'file-too-large' );
 593                                 break;
 594
 595                         case UploadBase::FILETYPE_BADTYPE:
 596                                 $extradata = [
 597                                         'filetype' => $verification['finalExt'],
 598                                         'allowed' => array_values( array_unique( $this->getConfig()->get( 'FileExtensions' ) ) )
 599                                 ];
 600                                 ApiResult::setIndexedTagName( $extradata['allowed'], 'ext' );
 601
 602                                 $msg = 'Filetype not permitted: ';
 603                                 if ( isset( $verification['blacklistedExt'] ) ) {
 604                                         $msg .= implode( ', ', $verification['blacklistedExt'] );
 605                                         $extradata['blacklisted'] = array_values( $verification['blacklistedExt'] );
 606                                         ApiResult::setIndexedTagName( $extradata['blacklisted'], 'ext' );
 607                                 } else {
 608                                         $msg .= $verification['finalExt'];
 609                                 }
 610                                 $this->dieUsage( $msg, 'filetype-banned', 0, $extradata );
 611                                 break;
 612                         case UploadBase::VERIFICATION_ERROR:
 613                                 $parsed = $this->parseMsg( $verification['details'] );
 614                                 $info = "This file did not pass file verification: {$parsed['info']}";
 615                                 if ( $verification['details'][0] instanceof IApiMessage ) {
 616                                         $code = $parsed['code'];
 617                                 } else {
 618                                         // For backwards-compatibility, all of the errors from UploadBase::verifyFile() are
 619                                         // reported as 'verification-error', and the real error code is reported in 'details'.
 620                                         $code = 'verification-error';
 621                                 }
 622                                 if ( $verification['details'][0] instanceof IApiMessage ) {
 623                                         $msg = $verification['details'][0];
 624                                         $details = array_merge( [ $msg->getKey() ], $msg->getParams() );
 625                                 } else {
 626                                         $details = $verification['details'];
 627                                 }
 628                                 ApiResult::setIndexedTagName( $details, 'detail' );
 629                                 $data = [ 'details' => $details ];
 630                                 if ( isset( $parsed['data'] ) ) {
 631                                         $data = array_merge( $data, $parsed['data'] );
 632                                 }
 633
 634                                 $this->dieUsage( $info, $code, 0, $data );
 635                                 break;
 636                         case UploadBase::HOOK_ABORTED:
 637                                 if ( is_array( $verification['error'] ) ) {
 638                                         $params = $verification['error'];
 639                                 } elseif ( $verification['error'] !== '' ) {
 640                                         $params = [ $verification['error'] ];
 641                                 } else {
 642                                         $params = [ 'hookaborted' ];
 643                                 }
 644                                 $key = array_shift( $params );
 645                                 $msg = $this->msg( $key, $params )->inLanguage( 'en' )->useDatabase( false )->text();
 646                                 $this->dieUsage( $msg, 'hookaborted', 0, [ 'details' => $verification['error'] ] );
 647                                 break;
 648                         default:
 649                                 $this->dieUsage( 'An unknown error occurred', 'unknown-error',
 650                                         0, [ 'details' => [ 'code' => $verification['status'] ] ] );
 651                                 break;
 652                 }
 653         }
 654
 655         /**
 656          * Check warnings.
 657          * Returns a suitable array for inclusion into API results if there were warnings
 658          * Returns the empty array if there were no warnings
 659          *
 660          * @return array
 661          */
 662         protected function getApiWarnings() {
 663                 $warnings = $this->mUpload->checkWarnings();
 664
 665                 return $this->transformWarnings( $warnings );
 666         }
 667
 668         protected function transformWarnings( $warnings ) {
 669                 if ( $warnings ) {
 670                         // Add indices
 671                         ApiResult::setIndexedTagName( $warnings, 'warning' );
 672
 673                         if ( isset( $warnings['duplicate'] ) ) {
 674                                 $dupes = [];
 675                                 /** @var File $dupe */
 676                                 foreach ( $warnings['duplicate'] as $dupe ) {
 677                                         $dupes[] = $dupe->getName();
 678                                 }
 679                                 ApiResult::setIndexedTagName( $dupes, 'duplicate' );
 680                                 $warnings['duplicate'] = $dupes;
 681                         }
 682
 683                         if ( isset( $warnings['exists'] ) ) {
 684                                 $warning = $warnings['exists'];
 685                                 unset( $warnings['exists'] );
 686                                 /** @var LocalFile $localFile */
 687                                 $localFile = isset( $warning['normalizedFile'] )
 688                                         ? $warning['normalizedFile']
 689                                         : $warning['file'];
 690                                 $warnings[$warning['warning']] = $localFile->getName();
 691                         }
 692                 }
 693
 694                 return $warnings;
 695         }
 696
 697         /**
 698          * Handles a stash exception, giving a useful error to the user.
 699          * @param string $exceptionType Class name of the exception we encountered.
 700          * @param string $message Message of the exception we encountered.
 701          * @return array Array of message and code, suitable for passing to dieUsage()
 702          */
 703         protected function handleStashException( $exceptionType, $message ) {
 704                 switch ( $exceptionType ) {
 705                         case 'UploadStashFileNotFoundException':
 706                                 return [
 707                                         'Could not find the file in the stash: ' . $message,
 708                                         'stashedfilenotfound'
 709                                 ];
 710                         case 'UploadStashBadPathException':
 711                                 return [
 712                                         'File key of improper format or otherwise invalid: ' . $message,
 713                                         'stashpathinvalid'
 714                                 ];
 715                         case 'UploadStashFileException':
 716                                 return [
 717                                         'Could not store upload in the stash: ' . $message,
 718                                         'stashfilestorage'
 719                                 ];
 720                         case 'UploadStashZeroLengthFileException':
 721                                 return [
 722                                         'File is of zero length, and could not be stored in the stash: ' .
 723                                                 $message,
 724                                         'stashzerolength'
 725                                 ];
 726                         case 'UploadStashNotLoggedInException':
 727                                 return [ 'Not logged in: ' . $message, 'stashnotloggedin' ];
 728                         case 'UploadStashWrongOwnerException':
 729                                 return [ 'Wrong owner: ' . $message, 'stashwrongowner' ];
 730                         case 'UploadStashNoSuchKeyException':
 731                                 return [ 'No such filekey: ' . $message, 'stashnosuchfilekey' ];
 732                         default:
 733                                 return [ $exceptionType . ': ' . $message, 'stasherror' ];
 734                 }
 735         }
 736
 737         /**
 738          * Perform the actual upload. Returns a suitable result array on success;
 739          * dies on failure.
 740          *
 741          * @param array $warnings Array of Api upload warnings
 742          * @return array
 743          */
 744         protected function performUpload( $warnings ) {
 745                 // Use comment as initial page text by default
 746                 if ( is_null( $this->mParams['text'] ) ) {
 747                         $this->mParams['text'] = $this->mParams['comment'];
 748                 }
 749
 750                 /** @var $file LocalFile */
 751                 $file = $this->mUpload->getLocalFile();
 752
 753                 // For preferences mode, we want to watch if 'watchdefault' is set,
 754                 // or if the *file* doesn't exist, and either 'watchuploads' or
 755                 // 'watchcreations' is set. But getWatchlistValue()'s automatic
 756                 // handling checks if the *title* exists or not, so we need to check
 757                 // all three preferences manually.
 758                 $watch = $this->getWatchlistValue(
 759                         $this->mParams['watchlist'], $file->getTitle(), 'watchdefault'
 760                 );
 761
 762                 if ( !$watch && $this->mParams['watchlist'] == 'preferences' && !$file->exists() ) {
 763                         $watch = (
 764                                 $this->getWatchlistValue( 'preferences', $file->getTitle(), 'watchuploads' ) ||
 765                                 $this->getWatchlistValue( 'preferences', $file->getTitle(), 'watchcreations' )
 766                         );
 767                 }
 768
 769                 // Deprecated parameters
 770                 if ( $this->mParams['watch'] ) {
 771                         $watch = true;
 772                 }
 773
 774                 if ( $this->mParams['tags'] ) {
 775                         $status = ChangeTags::canAddTagsAccompanyingChange( $this->mParams['tags'], $this->getUser() );
 776                         if ( !$status->isOK() ) {
 777                                 $this->dieStatus( $status );
 778                         }
 779                 }
 780
 781                 // No errors, no warnings: do the upload
 782                 if ( $this->mParams['async'] ) {
 783                         $progress = UploadBase::getSessionStatus( $this->getUser(), $this->mParams['filekey'] );
 784                         if ( $progress && $progress['result'] === 'Poll' ) {
 785                                 $this->dieUsage( 'Upload from stash already in progress.', 'publishfailed' );
 786                         }
 787                         UploadBase::setSessionStatus(
 788                                 $this->getUser(),
 789                                 $this->mParams['filekey'],
 790                                 [ 'result' => 'Poll', 'stage' => 'queued', 'status' => Status::newGood() ]
 791                         );
 792                         JobQueueGroup::singleton()->push( new PublishStashedFileJob(
 793                                 Title::makeTitle( NS_FILE, $this->mParams['filename'] ),
 794                                 [
 795                                         'filename' => $this->mParams['filename'],
 796                                         'filekey' => $this->mParams['filekey'],
 797                                         'comment' => $this->mParams['comment'],
 798                                         'tags' => $this->mParams['tags'],
 799                                         'text' => $this->mParams['text'],
 800                                         'watch' => $watch,
 801                                         'session' => $this->getContext()->exportSession()
 802                                 ]
 803                         ) );
 804                         $result['result'] = 'Poll';
 805                         $result['stage'] = 'queued';
 806                 } else {
 807                         /** @var $status Status */
 808                         $status = $this->mUpload->performUpload( $this->mParams['comment'],
 809                                 $this->mParams['text'], $watch, $this->getUser(), $this->mParams['tags'] );
 810
 811                         if ( !$status->isGood() ) {
 812                                 // Is there really no better way to do this?
 813                                 $errors = $status->getErrorsByType( 'error' );
 814                                 $msg = array_merge( [ $errors[0]['message'] ], $errors[0]['params'] );
 815                                 $data = $status->getErrorsArray();
 816                                 ApiResult::setIndexedTagName( $data, 'error' );
 817                                 // For backwards-compatibility, we use the 'internal-error' fallback key and merge $data
 818                                 // into the root of the response (rather than something sane like [ 'details' => $data ]).
 819                                 $this->dieRecoverableError( $msg, null, $data, 'internal-error' );
 820                         }
 821                         $result['result'] = 'Success';
 822                 }
 823
 824                 $result['filename'] = $file->getName();
 825                 if ( $warnings && count( $warnings ) > 0 ) {
 826                         $result['warnings'] = $warnings;
 827                 }
 828
 829                 return $result;
 830         }
 831
 832         public function mustBePosted() {
 833                 return true;
 834         }
 835
 836         public function isWriteMode() {
 837                 return true;
 838         }
 839
 840         public function getAllowedParams() {
 841                 $params = [
 842                         'filename' => [
 843                                 ApiBase::PARAM_TYPE => 'string',
 844                         ],
 845                         'comment' => [
 846                                 ApiBase::PARAM_DFLT => ''
 847                         ],
 848                         'tags' => [
 849                                 ApiBase::PARAM_TYPE => 'tags',
 850                                 ApiBase::PARAM_ISMULTI => true,
 851                         ],
 852                         'text' => [
 853                                 ApiBase::PARAM_TYPE => 'text',
 854                         ],
 855                         'watch' => [
 856                                 ApiBase::PARAM_DFLT => false,
 857                                 ApiBase::PARAM_DEPRECATED => true,
 858                         ],
 859                         'watchlist' => [
 860                                 ApiBase::PARAM_DFLT => 'preferences',
 861                                 ApiBase::PARAM_TYPE => [
 862                                         'watch',
 863                                         'preferences',
 864                                         'nochange'
 865                                 ],
 866                         ],
 867                         'ignorewarnings' => false,
 868                         'file' => [
 869                                 ApiBase::PARAM_TYPE => 'upload',
 870                         ],
 871                         'url' => null,
 872                         'filekey' => null,
 873                         'sessionkey' => [
 874                                 ApiBase::PARAM_DEPRECATED => true,
 875                         ],
 876                         'stash' => false,
 877
 878                         'filesize' => [
 879                                 ApiBase::PARAM_TYPE => 'integer',
 880                                 ApiBase::PARAM_MIN => 0,
 881                                 ApiBase::PARAM_MAX => UploadBase::getMaxUploadSize(),
 882                         ],
 883                         'offset' => [
 884                                 ApiBase::PARAM_TYPE => 'integer',
 885                                 ApiBase::PARAM_MIN => 0,
 886                         ],
 887                         'chunk' => [
 888                                 ApiBase::PARAM_TYPE => 'upload',
 889                         ],
 890
 891                         'async' => false,
 892                         'checkstatus' => false,
 893                 ];
 894
 895                 return $params;
 896         }
 897
 898         public function needsToken() {
 899                 return 'csrf';
 900         }
 901
 902         protected function getExamplesMessages() {
 903                 return [
 904                         'action=upload&filename=Wiki.png' .
 905                                 '&url=http%3A//upload.wikimedia.org/wikipedia/en/b/bc/Wiki.png&token=123ABC'
 906                                 => 'apihelp-upload-example-url',
 907                         'action=upload&filename=Wiki.png&filekey=filekey&ignorewarnings=1&token=123ABC'
 908                                 => 'apihelp-upload-example-filekey',
 909                 ];
 910         }
 911
 912         public function getHelpUrls() {
 913                 return 'https://www.mediawiki.org/wiki/API:Upload';
 914         }
 915 }