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
  32         /**
  33          * @var UploadBase
  34          */
  35         protected $mUpload = null;
  36
  37         protected $mParams;
  38
  39         public function __construct( $main, $action ) {
  40                 parent::__construct( $main, $action );
  41         }
  42
  43         public function execute() {
  44                 // Check whether upload is enabled
  45                 if ( !UploadBase::isEnabled() ) {
  46                         $this->dieUsageMsg( 'uploaddisabled' );
  47                 }
  48
  49                 $user = $this->getUser();
  50
  51                 // Parameter handling
  52                 $this->mParams = $this->extractRequestParams();
  53                 $request = $this->getMain()->getRequest();
  54                 // Add the uploaded file to the params array
  55                 $this->mParams['file'] = $request->getFileName( 'file' );
  56                 $this->mParams['chunk'] = $request->getFileName( 'chunk' );
  57
  58                 // Copy the session key to the file key, for backward compatibility.
  59                 if( !$this->mParams['filekey'] && $this->mParams['sessionkey'] ) {
  60                         $this->mParams['filekey'] = $this->mParams['sessionkey'];
  61                 }
  62
  63                 // Select an upload module
  64                 if ( !$this->selectUploadModule() ) {
  65                         // This is not a true upload, but a status request or similar
  66                         return;
  67                 }
  68                 if ( !isset( $this->mUpload ) ) {
  69                         $this->dieUsage( 'No upload module set', 'nomodule' );
  70                 }
  71
  72                 // First check permission to upload
  73                 $this->checkPermissions( $user );
  74
  75                 // Fetch the file
  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 = $this->mUpload->getMaxUploadSize( );
  86                         if( $this->mParams['filesize'] > $maxSize ) {
  87                                 $this->dieUsage( 'The file you submitted was too large', 'file-too-large' );
  88                         }
  89                 } else {
  90                         $this->verifyUpload();
  91                 }
  92
  93                 // Check if the user has the rights to modify or overwrite the requested title
  94                 // (This check is irrelevant if stashing is already requested, since the errors
  95                 //  can always be fixed by changing the title)
  96                 if ( ! $this->mParams['stash'] ) {
  97                         $permErrors = $this->mUpload->verifyTitlePermissions( $user );
  98                         if ( $permErrors !== true ) {
  99                                 $this->dieRecoverableError( $permErrors[0], 'filename' );
 100                         }
 101                 }
 102                 // Get the result based on the current upload context:
 103                 $result = $this->getContextResult();
 104
 105                 if ( $result['result'] === 'Success' ) {
 106                         $result['imageinfo'] = $this->mUpload->getImageInfo( $this->getResult() );
 107                 }
 108
 109                 $this->getResult()->addValue( null, $this->getModuleName(), $result );
 110
 111                 // Cleanup any temporary mess
 112                 $this->mUpload->cleanupTempFile();
 113         }
 114         /**
 115          * Get an uplaod result based on upload context
 116          * @return array
 117          */
 118         private function getContextResult(){
 119                 $warnings = $this->getApiWarnings();
 120                 if ( $warnings && !$this->mParams['ignorewarnings'] ) {
 121                         // Get warnings formated in result array format
 122                         return $this->getWarningsResult( $warnings );
 123                 } elseif ( $this->mParams['chunk'] ) {
 124                         // Add chunk, and get result
 125                         return $this->getChunkResult( $warnings );
 126                 } elseif ( $this->mParams['stash'] ) {
 127                         // Stash the file and get stash result
 128                         return $this->getStashResult( $warnings );
 129                 }
 130                 // This is the most common case -- a normal upload with no warnings
 131                 // performUpload will return a formatted properly for the API with status
 132                 return $this->performUpload( $warnings );
 133         }
 134         /**
 135          * Get Stash Result, throws an expetion if the file could not be stashed.
 136          * @param $warnings array Array of Api upload warnings
 137          * @return array
 138          */
 139         private function getStashResult( $warnings ){
 140                 $result = array ();
 141                 // Some uploads can request they be stashed, so as not to publish them immediately.
 142                 // In this case, a failure to stash ought to be fatal
 143                 try {
 144                         $result['result'] = 'Success';
 145                         $result['filekey'] = $this->performStash();
 146                         $result['sessionkey'] = $result['filekey']; // backwards compatibility
 147                         if ( $warnings && count( $warnings ) > 0 ) {
 148                                 $result['warnings'] = $warnings;
 149                         }
 150                 } catch ( MWException $e ) {
 151                         $this->dieUsage( $e->getMessage(), 'stashfailed' );
 152                 }
 153                 return $result;
 154         }
 155         /**
 156          * Get Warnings Result
 157          * @param $warnings array Array of Api upload warnings
 158          * @return array
 159          */
 160         private function getWarningsResult( $warnings ){
 161                 $result = array();
 162                 $result['result'] = 'Warning';
 163                 $result['warnings'] = $warnings;
 164                 // in case the warnings can be fixed with some further user action, let's stash this upload
 165                 // and return a key they can use to restart it
 166                 try {
 167                         $result['filekey'] = $this->performStash();
 168                         $result['sessionkey'] = $result['filekey']; // backwards compatibility
 169                 } catch ( MWException $e ) {
 170                         $result['warnings']['stashfailed'] = $e->getMessage();
 171                 }
 172                 return $result;
 173         }
 174         /**
 175          * Get the result of a chunk upload.
 176          * @param $warnings array Array of Api upload warnings
 177          * @return array
 178          */
 179         private function getChunkResult( $warnings ){
 180                 $result = array();
 181
 182                 $result['result'] = 'Continue';
 183                 if ( $warnings && count( $warnings ) > 0 ) {
 184                         $result['warnings'] = $warnings;
 185                 }
 186                 $request = $this->getMain()->getRequest();
 187                 $chunkPath = $request->getFileTempname( 'chunk' );
 188                 $chunkSize = $request->getUpload( 'chunk' )->getSize();
 189                 if ($this->mParams['offset'] == 0) {
 190                         $result['filekey'] = $this->performStash();
 191                 } else {
 192                         $status = $this->mUpload->addChunk($chunkPath, $chunkSize,
 193                                                                                 $this->mParams['offset']);
 194                         if ( !$status->isGood() ) {
 195                                 $this->dieUsage( $status->getWikiText(), 'stashfailed' );
 196                                 return array();
 197                         }
 198
 199                         // Check we added the last chunk:
 200                         if( $this->mParams['offset'] + $chunkSize == $this->mParams['filesize'] ) {
 201                                 $status = $this->mUpload->concatenateChunks();
 202
 203                                 if ( !$status->isGood() ) {
 204                                         $this->dieUsage( $status->getWikiText(), 'stashfailed' );
 205                                         return array();
 206                                 }
 207
 208                                 // We have a new filekey for the fully concatenated file.
 209                                 $result['filekey'] =  $this->mUpload->getLocalFile()->getFileKey();
 210
 211                                 // Remove chunk from stash. (Checks against user ownership of chunks.)
 212                                 $this->mUpload->stash->removeFile( $this->mParams['filekey'] );
 213
 214                                 $result['result'] = 'Success';
 215
 216                         } else {
 217
 218                                 // Continue passing through the filekey for adding further chunks.
 219                                 $result['filekey'] = $this->mParams['filekey'];
 220                         }
 221                 }
 222                 $result['offset'] = $this->mParams['offset'] + $chunkSize;
 223                 return $result;
 224         }
 225
 226         /**
 227          * Stash the file and return the file key
 228          * Also re-raises exceptions with slightly more informative message strings (useful for API)
 229          * @throws MWException
 230          * @return String file key
 231          */
 232         function performStash() {
 233                 try {
 234                         $stashFile = $this->mUpload->stashFile();
 235
 236                         if ( !$stashFile ) {
 237                                 throw new MWException( 'Invalid stashed file' );
 238                         }
 239                         $fileKey = $stashFile->getFileKey();
 240                 } catch ( MWException $e ) {
 241                         $message = 'Stashing temporary file failed: ' . get_class( $e ) . ' ' . $e->getMessage();
 242                         wfDebug( __METHOD__ . ' ' . $message . "\n");
 243                         throw new MWException( $message );
 244                 }
 245                 return $fileKey;
 246         }
 247
 248         /**
 249          * Throw an error that the user can recover from by providing a better
 250          * value for $parameter
 251          *
 252          * @param $error array Error array suitable for passing to dieUsageMsg()
 253          * @param $parameter string Parameter that needs revising
 254          * @param $data array Optional extra data to pass to the user
 255          * @throws UsageException
 256          */
 257         function dieRecoverableError( $error, $parameter, $data = array() ) {
 258                 try {
 259                         $data['filekey'] = $this->performStash();
 260                         $data['sessionkey'] = $data['filekey'];
 261                 } catch ( MWException $e ) {
 262                         $data['stashfailed'] = $e->getMessage();
 263                 }
 264                 $data['invalidparameter'] = $parameter;
 265
 266                 $parsed = $this->parseMsg( $error );
 267                 $this->dieUsage( $parsed['info'], $parsed['code'], 0, $data );
 268         }
 269
 270         /**
 271          * Select an upload module and set it to mUpload. Dies on failure. If the
 272          * request was a status request and not a true upload, returns false;
 273          * otherwise true
 274          *
 275          * @return bool
 276          */
 277         protected function selectUploadModule() {
 278                 $request = $this->getMain()->getRequest();
 279
 280                 // chunk or one and only one of the following parameters is needed
 281                 if( !$this->mParams['chunk'] ) {
 282                         $this->requireOnlyOneParameter( $this->mParams,
 283                                 'filekey', 'file', 'url', 'statuskey' );
 284                 }
 285
 286                 if ( $this->mParams['statuskey'] ) {
 287                         $this->checkAsyncDownloadEnabled();
 288
 289                         // Status request for an async upload
 290                         $sessionData = UploadFromUrlJob::getSessionData( $this->mParams['statuskey'] );
 291                         if ( !isset( $sessionData['result'] ) ) {
 292                                 $this->dieUsage( 'No result in session data', 'missingresult' );
 293                         }
 294                         if ( $sessionData['result'] == 'Warning' ) {
 295                                 $sessionData['warnings'] = $this->transformWarnings( $sessionData['warnings'] );
 296                                 $sessionData['sessionkey'] = $this->mParams['statuskey'];
 297                         }
 298                         $this->getResult()->addValue( null, $this->getModuleName(), $sessionData );
 299                         return false;
 300
 301                 }
 302
 303                 // The following modules all require the filename parameter to be set
 304                 if ( is_null( $this->mParams['filename'] ) ) {
 305                         $this->dieUsageMsg( array( 'missingparam', 'filename' ) );
 306                 }
 307
 308                 if ( $this->mParams['chunk'] ) {
 309                         // Chunk upload
 310                         $this->mUpload = new UploadFromChunks();
 311                         if( isset( $this->mParams['filekey'] ) ){
 312                                 // handle new chunk
 313                                 $this->mUpload->continueChunks(
 314                                         $this->mParams['filename'],
 315                                         $this->mParams['filekey'],
 316                                         $request->getUpload( 'chunk' )
 317                                 );
 318                         } else {
 319                                 // handle first chunk
 320                                 $this->mUpload->initialize(
 321                                         $this->mParams['filename'],
 322                                         $request->getUpload( 'chunk' )
 323                                 );
 324                         }
 325                 } elseif ( isset( $this->mParams['filekey'] ) ) {
 326                         // Upload stashed in a previous request
 327                         if ( !UploadFromStash::isValidKey( $this->mParams['filekey'] ) ) {
 328                                 $this->dieUsageMsg( 'invalid-file-key' );
 329                         }
 330
 331                         $this->mUpload = new UploadFromStash( $this->getUser() );
 332
 333                         $this->mUpload->initialize( $this->mParams['filekey'], $this->mParams['filename'] );
 334                 } elseif ( isset( $this->mParams['file'] ) ) {
 335                         $this->mUpload = new UploadFromFile();
 336                         $this->mUpload->initialize(
 337                                 $this->mParams['filename'],
 338                                 $request->getUpload( 'file' )
 339                         );
 340                 } elseif ( isset( $this->mParams['url'] ) ) {
 341                         // Make sure upload by URL is enabled:
 342                         if ( !UploadFromUrl::isEnabled() ) {
 343                                 $this->dieUsageMsg( 'copyuploaddisabled' );
 344                         }
 345
 346                         if ( !UploadFromUrl::isAllowedHost( $this->mParams['url'] ) ) {
 347                                 $this->dieUsageMsg( 'copyuploadbaddomain' );
 348                         }
 349
 350                         $async = false;
 351                         if ( $this->mParams['asyncdownload'] ) {
 352                                 $this->checkAsyncDownloadEnabled();
 353
 354                                 if ( $this->mParams['leavemessage'] && !$this->mParams['ignorewarnings'] ) {
 355                                         $this->dieUsage( 'Using leavemessage without ignorewarnings is not supported',
 356                                                 'missing-ignorewarnings' );
 357                                 }
 358
 359                                 if ( $this->mParams['leavemessage'] ) {
 360                                         $async = 'async-leavemessage';
 361                                 } else {
 362                                         $async = 'async';
 363                                 }
 364                         }
 365                         $this->mUpload = new UploadFromUrl;
 366                         $this->mUpload->initialize( $this->mParams['filename'],
 367                                 $this->mParams['url'], $async );
 368                 }
 369
 370                 return true;
 371         }
 372
 373         /**
 374          * Checks that the user has permissions to perform this upload.
 375          * Dies with usage message on inadequate permissions.
 376          * @param $user User The user to check.
 377          */
 378         protected function checkPermissions( $user ) {
 379                 // Check whether the user has the appropriate permissions to upload anyway
 380                 $permission = $this->mUpload->isAllowed( $user );
 381
 382                 if ( $permission !== true ) {
 383                         if ( !$user->isLoggedIn() ) {
 384                                 $this->dieUsageMsg( array( 'mustbeloggedin', 'upload' ) );
 385                         } else {
 386                                 $this->dieUsageMsg( 'badaccess-groups' );
 387                         }
 388                 }
 389         }
 390
 391         /**
 392          * Performs file verification, dies on error.
 393          */
 394         protected function verifyUpload( ) {
 395                 global $wgFileExtensions;
 396
 397                 $verification = $this->mUpload->verifyUpload( );
 398                 if ( $verification['status'] === UploadBase::OK ) {
 399                         return;
 400                 }
 401
 402                 // TODO: Move them to ApiBase's message map
 403                 switch( $verification['status'] ) {
 404                         // Recoverable errors
 405                         case UploadBase::MIN_LENGTH_PARTNAME:
 406                                 $this->dieRecoverableError( 'filename-tooshort', 'filename' );
 407                                 break;
 408                         case UploadBase::ILLEGAL_FILENAME:
 409                                 $this->dieRecoverableError( 'illegal-filename', 'filename',
 410                                                 array( 'filename' => $verification['filtered'] ) );
 411                                 break;
 412                         case UploadBase::FILENAME_TOO_LONG:
 413                                 $this->dieRecoverableError( 'filename-toolong', 'filename' );
 414                                 break;
 415                         case UploadBase::FILETYPE_MISSING:
 416                                 $this->dieRecoverableError( 'filetype-missing', 'filename' );
 417                                 break;
 418                         case UploadBase::WINDOWS_NONASCII_FILENAME:
 419                                 $this->dieRecoverableError( 'windows-nonascii-filename', 'filename' );
 420                                 break;
 421
 422                         // Unrecoverable errors
 423                         case UploadBase::EMPTY_FILE:
 424                                 $this->dieUsage( 'The file you submitted was empty', 'empty-file' );
 425                                 break;
 426                         case UploadBase::FILE_TOO_LARGE:
 427                                 $this->dieUsage( 'The file you submitted was too large', 'file-too-large' );
 428                                 break;
 429
 430                         case UploadBase::FILETYPE_BADTYPE:
 431                                 $this->dieUsage( 'This type of file is banned', 'filetype-banned',
 432                                                 0, array(
 433                                                         'filetype' => $verification['finalExt'],
 434                                                         'allowed' => $wgFileExtensions
 435                                                 ) );
 436                                 break;
 437                         case UploadBase::VERIFICATION_ERROR:
 438                                 $this->getResult()->setIndexedTagName( $verification['details'], 'detail' );
 439                                 $this->dieUsage( 'This file did not pass file verification', 'verification-error',
 440                                                 0, array( 'details' => $verification['details'] ) );
 441                                 break;
 442                         case UploadBase::HOOK_ABORTED:
 443                                 $this->dieUsage( "The modification you tried to make was aborted by an extension hook",
 444                                                 'hookaborted', 0, array( 'error' => $verification['error'] ) );
 445                                 break;
 446                         default:
 447                                 $this->dieUsage( 'An unknown error occurred', 'unknown-error',
 448                                                 0, array( 'code' =>  $verification['status'] ) );
 449                                 break;
 450                 }
 451         }
 452
 453
 454         /**
 455          * Check warnings.
 456          * Returns a suitable array for inclusion into API results if there were warnings
 457          * Returns the empty array if there were no warnings
 458          *
 459          * @return array
 460          */
 461         protected function getApiWarnings() {
 462                 $warnings = array();
 463
 464                 $warnings = $this->mUpload->checkWarnings();
 465
 466                 return $this->transformWarnings( $warnings );
 467         }
 468
 469         protected function transformWarnings( $warnings ) {
 470                 if ( $warnings ) {
 471                         // Add indices
 472                         $result = $this->getResult();
 473                         $result->setIndexedTagName( $warnings, 'warning' );
 474
 475                         if ( isset( $warnings['duplicate'] ) ) {
 476                                 $dupes = array();
 477                                 foreach ( $warnings['duplicate'] as $dupe ) {
 478                                         $dupes[] = $dupe->getName();
 479                                 }
 480                                 $result->setIndexedTagName( $dupes, 'duplicate' );
 481                                 $warnings['duplicate'] = $dupes;
 482                         }
 483
 484                         if ( isset( $warnings['exists'] ) ) {
 485                                 $warning = $warnings['exists'];
 486                                 unset( $warnings['exists'] );
 487                                 $warnings[$warning['warning']] = $warning['file']->getName();
 488                         }
 489                 }
 490                 return $warnings;
 491         }
 492
 493
 494         /**
 495          * Perform the actual upload. Returns a suitable result array on success;
 496          * dies on failure.
 497          *
 498          * @param $warnings array Array of Api upload warnings
 499          * @return array
 500          */
 501         protected function performUpload( $warnings ) {
 502                 // Use comment as initial page text by default
 503                 if ( is_null( $this->mParams['text'] ) ) {
 504                         $this->mParams['text'] = $this->mParams['comment'];
 505                 }
 506
 507                 $file = $this->mUpload->getLocalFile();
 508                 $watch = $this->getWatchlistValue( $this->mParams['watchlist'], $file->getTitle() );
 509
 510                 // Deprecated parameters
 511                 if ( $this->mParams['watch'] ) {
 512                         $watch = true;
 513                 }
 514
 515                 // No errors, no warnings: do the upload
 516                 $status = $this->mUpload->performUpload( $this->mParams['comment'],
 517                         $this->mParams['text'], $watch, $this->getUser() );
 518
 519                 if ( !$status->isGood() ) {
 520                         $error = $status->getErrorsArray();
 521
 522                         if ( count( $error ) == 1 && $error[0][0] == 'async' ) {
 523                                 // The upload can not be performed right now, because the user
 524                                 // requested so
 525                                 return array(
 526                                         'result' => 'Queued',
 527                                         'statuskey' => $error[0][1],
 528                                 );
 529                         } else {
 530                                 $this->getResult()->setIndexedTagName( $error, 'error' );
 531
 532                                 $this->dieUsage( 'An internal error occurred', 'internal-error', 0, $error );
 533                         }
 534                 }
 535
 536                 $file = $this->mUpload->getLocalFile();
 537
 538                 $result['result'] = 'Success';
 539                 $result['filename'] = $file->getName();
 540                 if ( $warnings && count( $warnings ) > 0 ) {
 541                         $result['warnings'] = $warnings;
 542                 }
 543
 544                 return $result;
 545         }
 546
 547         /**
 548          * Checks if asynchronous copy uploads are enabled and throws an error if they are not.
 549          */
 550         protected function checkAsyncDownloadEnabled() {
 551                 global $wgAllowAsyncCopyUploads;
 552                 if ( !$wgAllowAsyncCopyUploads ) {
 553                         $this->dieUsage( 'Asynchronous copy uploads disabled', 'asynccopyuploaddisabled');
 554                 }
 555         }
 556
 557         public function mustBePosted() {
 558                 return true;
 559         }
 560
 561         public function isWriteMode() {
 562                 return true;
 563         }
 564
 565         public function getAllowedParams() {
 566                 $params = array(
 567                         'filename' => array(
 568                                 ApiBase::PARAM_TYPE => 'string',
 569                         ),
 570                         'comment' => array(
 571                                 ApiBase::PARAM_DFLT => ''
 572                         ),
 573                         'text' => null,
 574                         'token' => array(
 575                                 ApiBase::PARAM_TYPE => 'string',
 576                                 ApiBase::PARAM_REQUIRED => true
 577                         ),
 578                         'watch' => array(
 579                                 ApiBase::PARAM_DFLT => false,
 580                                 ApiBase::PARAM_DEPRECATED => true,
 581                         ),
 582                         'watchlist' => array(
 583                                 ApiBase::PARAM_DFLT => 'preferences',
 584                                 ApiBase::PARAM_TYPE => array(
 585                                         'watch',
 586                                         'preferences',
 587                                         'nochange'
 588                                 ),
 589                         ),
 590                         'ignorewarnings' => false,
 591                         'file' => null,
 592                         'url' => null,
 593                         'filekey' => null,
 594                         'sessionkey' => array(
 595                                 ApiBase::PARAM_DFLT => null,
 596                                 ApiBase::PARAM_DEPRECATED => true,
 597                         ),
 598                         'stash' => false,
 599
 600                         'filesize' => null,
 601                         'offset' => null,
 602                         'chunk' => null,
 603
 604                         'asyncdownload' => false,
 605                         'leavemessage' => false,
 606                         'statuskey' => null,
 607                 );
 608
 609                 return $params;
 610         }
 611
 612         public function getParamDescription() {
 613                 $params = array(
 614                         'filename' => 'Target filename',
 615                         'token' => 'Edit token. You can get one of these through prop=info',
 616                         'comment' => 'Upload comment. Also used as the initial page text for new files if "text" is not specified',
 617                         'text' => 'Initial page text for new files',
 618                         'watch' => 'Watch the page',
 619                         'watchlist' => 'Unconditionally add or remove the page from your watchlist, use preferences or do not change watch',
 620                         'ignorewarnings' => 'Ignore any warnings',
 621                         'file' => 'File contents',
 622                         'url' => 'URL to fetch the file from',
 623                         'filekey' => 'Key that identifies a previous upload that was stashed temporarily.',
 624                         'sessionkey' => 'Same as filekey, maintained for backward compatibility.',
 625                         'stash' => 'If set, the server will not add the file to the repository and stash it temporarily.',
 626
 627                         'chunk' => 'Chunk contents',
 628                         'offset' => 'Offset of chunk in bytes',
 629                         'filesize' => 'Filesize of entire upload',
 630
 631                         'asyncdownload' => 'Make fetching a URL asynchronous',
 632                         'leavemessage' => 'If asyncdownload is used, leave a message on the user talk page if finished',
 633                         'statuskey' => 'Fetch the upload status for this file key',
 634                 );
 635
 636                 return $params;
 637
 638         }
 639
 640         public function getResultProperties() {
 641                 return array(
 642                         '' => array(
 643                                 'result' => array(
 644                                         ApiBase::PROP_TYPE => array(
 645                                                 'Success',
 646                                                 'Warning',
 647                                                 'Continue',
 648                                                 'Queued'
 649                                         ),
 650                                 ),
 651                                 'filekey' => array(
 652                                         ApiBase::PROP_TYPE => 'string',
 653                                         ApiBase::PROP_NULLABLE => true
 654                                 ),
 655                                 'sessionkey' => array(
 656                                         ApiBase::PROP_TYPE => 'string',
 657                                         ApiBase::PROP_NULLABLE => true
 658                                 ),
 659                                 'offset' => array(
 660                                         ApiBase::PROP_TYPE => 'integer',
 661                                         ApiBase::PROP_NULLABLE => true
 662                                 ),
 663                                 'statuskey' => array(
 664                                         ApiBase::PROP_TYPE => 'string',
 665                                         ApiBase::PROP_NULLABLE => true
 666                                 ),
 667                                 'filename' => array(
 668                                         ApiBase::PROP_TYPE => 'string',
 669                                         ApiBase::PROP_NULLABLE => true
 670                                 )
 671                         )
 672                 );
 673         }
 674
 675         public function getDescription() {
 676                 return array(
 677                         'Upload a file, or get the status of pending uploads. Several methods are available:',
 678                         ' * Upload file contents directly, using the "file" parameter',
 679                         ' * Have the MediaWiki server fetch a file from a URL, using the "url" parameter',
 680                         ' * Complete an earlier upload that failed due to warnings, using the "filekey" parameter',
 681                         'Note that the HTTP POST must be done as a file upload (i.e. using multipart/form-data) when',
 682                         'sending the "file".  Also you must get and send an edit token before doing any upload stuff'
 683                 );
 684         }
 685
 686         public function getPossibleErrors() {
 687                 return array_merge( parent::getPossibleErrors(),
 688                         $this->getRequireOnlyOneParameterErrorMessages( array( 'filekey', 'file', 'url', 'statuskey' ) ),
 689                         array(
 690                                 array( 'uploaddisabled' ),
 691                                 array( 'invalid-file-key' ),
 692                                 array( 'uploaddisabled' ),
 693                                 array( 'mustbeloggedin', 'upload' ),
 694                                 array( 'badaccess-groups' ),
 695                                 array( 'code' => 'fetchfileerror', 'info' => '' ),
 696                                 array( 'code' => 'nomodule', 'info' => 'No upload module set' ),
 697                                 array( 'code' => 'empty-file', 'info' => 'The file you submitted was empty' ),
 698                                 array( 'code' => 'filetype-missing', 'info' => 'The file is missing an extension' ),
 699                                 array( 'code' => 'filename-tooshort', 'info' => 'The filename is too short' ),
 700                                 array( 'code' => 'overwrite', 'info' => 'Overwriting an existing file is not allowed' ),
 701                                 array( 'code' => 'stashfailed', 'info' => 'Stashing temporary file failed' ),
 702                                 array( 'code' => 'internal-error', 'info' => 'An internal error occurred' ),
 703                                 array( 'code' => 'asynccopyuploaddisabled', 'info' => 'Asynchronous copy uploads disabled' ),
 704                                 array( 'fileexists-forbidden' ),
 705                                 array( 'fileexists-shared-forbidden' ),
 706                         )
 707                 );
 708         }
 709
 710         public function needsToken() {
 711                 return true;
 712         }
 713
 714         public function getTokenSalt() {
 715                 return '';
 716         }
 717
 718         public function getExamples() {
 719                 return array(
 720                         'api.php?action=upload&filename=Wiki.png&url=http%3A//upload.wikimedia.org/wikipedia/en/b/bc/Wiki.png'
 721                                 => 'Upload from a URL',
 722                         'api.php?action=upload&filename=Wiki.png&filekey=filekey&ignorewarnings=1'
 723                                 => 'Complete an upload that failed due to warnings',
 724                 );
 725         }
 726
 727         public function getHelpUrls() {
 728                 return 'https://www.mediawiki.org/wiki/API:Upload';
 729         }
 730
 731         public function getVersion() {
 732                 return __CLASS__ . ': $Id$';
 733         }
 734 }