includes/api/ApiUpload.php

   1 <?php
   2 /**
   3  * Created on Aug 21, 2008
   4  * API for MediaWiki 1.8+
   5  *
   6  * Copyright © 2008 - 2010 Bryan Tong Minh <Bryan.TongMinh@Gmail.com>
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License along
  19  * with this program; if not, write to the Free Software Foundation, Inc.,
  20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  21  * http://www.gnu.org/copyleft/gpl.html
  22  */
  23
  24 if ( !defined( 'MEDIAWIKI' ) ) {
  25         // Eclipse helper - will be ignored in production
  26         require_once( "ApiBase.php" );
  27 }
  28
  29 /**
  30  * @ingroup API
  31  */
  32 class ApiUpload extends ApiBase {
  33         protected $mUpload = null;
  34         protected $mParams;
  35
  36         public function __construct( $main, $action ) {
  37                 parent::__construct( $main, $action );
  38         }
  39
  40         public function execute() {
  41                 global $wgUser, $wgAllowCopyUploads;
  42
  43                 // Check whether upload is enabled
  44                 if ( !UploadBase::isEnabled() ) {
  45                         $this->dieUsageMsg( array( 'uploaddisabled' ) );
  46                 }
  47
  48                 $this->mParams = $this->extractRequestParams();
  49                 $request = $this->getMain()->getRequest();
  50
  51                 // Add the uploaded file to the params array
  52                 $this->mParams['file'] = $request->getFileName( 'file' );
  53
  54                 // One and only one of the following parameters is needed
  55                 $this->requireOnlyOneParameter( $this->mParams,
  56                         'sessionkey', 'file', 'url' );
  57
  58                 if ( $this->mParams['sessionkey'] ) {
  59                         /**
  60                          * Upload stashed in a previous request
  61                          */
  62                         // Check the session key
  63                         if ( !isset( $_SESSION[UploadBase::getSessionKey()][$this->mParams['sessionkey']] ) ) {
  64                                 $this->dieUsageMsg( array( 'invalid-session-key' ) );
  65                         }
  66
  67                         $this->mUpload = new UploadFromStash();
  68                         $this->mUpload->initialize( $this->mParams['filename'],
  69                                 $this->mParams['sessionkey'],
  70                                 $_SESSION[UploadBase::getSessionKey()][$this->mParams['sessionkey']] );
  71                 } elseif ( isset( $this->mParams['filename'] ) ) {
  72                         /**
  73                          * Upload from URL, etc.
  74                          * Parameter filename is required
  75                          */
  76                         if ( isset( $this->mParams['file'] ) ) {
  77                                 $this->mUpload = new UploadFromFile();
  78                                 $this->mUpload->initialize(
  79                                         $this->mParams['filename'],
  80                                         $request->getFileTempName( 'file' ),
  81                                         $request->getFileSize( 'file' )
  82                                 );
  83                         } elseif ( isset( $this->mParams['url'] ) ) {
  84                                 // make sure upload by URL is enabled:
  85                                 if ( !$wgAllowCopyUploads ) {
  86                                         $this->dieUsageMsg( array( 'copyuploaddisabled' ) );
  87                                 }
  88
  89                                 // make sure the current user can upload
  90                                 if ( !$wgUser->isAllowed( 'upload_by_url' ) ) {
  91                                         $this->dieUsageMsg( array( 'badaccess-groups' ) );
  92                                 }
  93
  94                                 $this->mUpload = new UploadFromUrl;
  95                                 $async = $this->mParams['asyncdownload'] ? 'async' : null;
  96
  97                                 $result = $this->mUpload->initialize( $this->mParams['filename'],
  98                                                 $this->mParams['url'],
  99                                                 $this->mParams['comment'],
 100                                                 $this->mParams['watchlist'],
 101                                                 $this->mParams['ignorewarnings'],
 102                                                 $async );
 103
 104                                 $this->checkPermissions( $wgUser );
 105                                 if ( $async ) {
 106                                         $this->getResult()->addValue( null,
 107                                                                                                   $this->getModuleName(),
 108                                                                                                   array( 'queued' => $result ) );
 109                                         return;
 110                                 }
 111
 112                                 $status = $this->mUpload->retrieveFileFromUrl();
 113                                 if ( !$status->isGood() ) {
 114                                         $this->getResult()->addValue( null,
 115                                                                                                   $this->getModuleName(),
 116                                                                                                   array( 'error' => $status ) );
 117                                         return;
 118                                 }
 119                         }
 120                 } else {
 121                         $this->dieUsageMsg( array( 'missingparam', 'filename' ) );
 122                 }
 123
 124                 $this->checkPermissions( $wgUser );
 125
 126                 if ( !isset( $this->mUpload ) ) {
 127                         $this->dieUsage( 'No upload module set', 'nomodule' );
 128                 }
 129
 130                 // Perform the upload
 131                 $result = $this->performUpload();
 132
 133                 // Cleanup any temporary mess
 134                 $this->mUpload->cleanupTempFile();
 135
 136                 $this->getResult()->addValue( null, $this->getModuleName(), $result );
 137         }
 138
 139         /**
 140          * Checks that the user has permissions to perform this upload.
 141          * Dies with usage message on inadequate permissions.
 142          * @param $user User The user to check.
 143          */
 144         protected function checkPermissions( $user ) {
 145                 // Check whether the user has the appropriate permissions to upload anyway
 146                 $permission = $this->mUpload->isAllowed( $user );
 147
 148                 if ( $permission !== true ) {
 149                         if ( !$user->isLoggedIn() ) {
 150                                 $this->dieUsageMsg( array( 'mustbeloggedin', 'upload' ) );
 151                         } else {
 152                                 $this->dieUsageMsg( array( 'badaccess-groups' ) );
 153                         }
 154                 }
 155         }
 156
 157         /**
 158          * Performs file verification, dies on error.
 159          */
 160         public function verifyUpload( ) {
 161                 $verification = $this->mUpload->verifyUpload( );
 162                 if ( $verification['status'] === UploadBase::OK ) {
 163                         return $verification;
 164                 }
 165
 166                 $this->getVerificationError( $verification );
 167         }
 168
 169         /**
 170          * Produce the usage error
 171          *
 172          * @param $verification array an associative array with the status
 173          * key
 174          */
 175         public function getVerificationError( $verification ) {
 176                 // TODO: Move them to ApiBase's message map
 177                 switch( $verification['status'] ) {
 178                         case UploadBase::EMPTY_FILE:
 179                                 $this->dieUsage( 'The file you submitted was empty', 'empty-file' );
 180                                 break;
 181                         case UploadBase::FILE_TOO_LARGE:
 182                                 $this->dieUsage( 'The file you submitted was too large', 'file-too-large' );
 183                                 break;
 184                         case UploadBase::FILETYPE_MISSING:
 185                                 $this->dieUsage( 'The file is missing an extension', 'filetype-missing' );
 186                                 break;
 187                         case UploadBase::FILETYPE_BADTYPE:
 188                                 global $wgFileExtensions;
 189                                 $this->dieUsage( 'This type of file is banned', 'filetype-banned',
 190                                                 0, array(
 191                                                         'filetype' => $verification['finalExt'],
 192                                                         'allowed' => $wgFileExtensions
 193                                                 ) );
 194                                 break;
 195                         case UploadBase::MIN_LENGTH_PARTNAME:
 196                                 $this->dieUsage( 'The filename is too short', 'filename-tooshort' );
 197                                 break;
 198                         case UploadBase::ILLEGAL_FILENAME:
 199                                 $this->dieUsage( 'The filename is not allowed', 'illegal-filename',
 200                                                 0, array( 'filename' => $verification['filtered'] ) );
 201                                 break;
 202                         case UploadBase::OVERWRITE_EXISTING_FILE:
 203                                 $this->dieUsage( 'Overwriting an existing file is not allowed', 'overwrite' );
 204                                 break;
 205                         case UploadBase::VERIFICATION_ERROR:
 206                                 $this->getResult()->setIndexedTagName( $verification['details'], 'detail' );
 207                                 $this->dieUsage( 'This file did not pass file verification', 'verification-error',
 208                                                 0, array( 'details' => $verification['details'] ) );
 209                                 break;
 210                         case UploadBase::HOOK_ABORTED:
 211                                 $this->dieUsage( "The modification you tried to make was aborted by an extension hook",
 212                                                 'hookaborted', 0, array( 'error' => $verification['error'] ) );
 213                                 break;
 214                         default:
 215                                 $this->dieUsage( 'An unknown error occurred', 'unknown-error',
 216                                                 0, array( 'code' =>  $verification['status'] ) );
 217                                 break;
 218                 }
 219         }
 220
 221         protected function checkForWarnings() {
 222                 $result = array();
 223
 224                 if ( !$this->mParams['ignorewarnings'] ) {
 225                         $warnings = $this->mUpload->checkWarnings();
 226                         if ( $warnings ) {
 227                                 // Add indices
 228                                 $this->getResult()->setIndexedTagName( $warnings, 'warning' );
 229
 230                                 if ( isset( $warnings['duplicate'] ) ) {
 231                                         $dupes = array();
 232                                         foreach ( $warnings['duplicate'] as $key => $dupe )
 233                                                 $dupes[] = $dupe->getName();
 234                                         $this->getResult()->setIndexedTagName( $dupes, 'duplicate' );
 235                                         $warnings['duplicate'] = $dupes;
 236                                 }
 237
 238                                 if ( isset( $warnings['exists'] ) ) {
 239                                         $warning = $warnings['exists'];
 240                                         unset( $warnings['exists'] );
 241                                         $warnings[$warning['warning']] = $warning['file']->getName();
 242                                 }
 243
 244                                 $result['result'] = 'Warning';
 245                                 $result['warnings'] = $warnings;
 246
 247                                 $sessionKey = $this->mUpload->stashSession();
 248                                 if ( !$sessionKey ) {
 249                                         $this->dieUsage( 'Stashing temporary file failed', 'stashfailed' );
 250                                 }
 251
 252                                 $result['sessionkey'] = $sessionKey;
 253
 254                                 return $result;
 255                         }
 256                 }
 257                 return;
 258         }
 259
 260         protected function performUpload() {
 261                 global $wgUser;
 262                 $permErrors = $this->mUpload->verifyPermissions( $wgUser );
 263                 if ( $permErrors !== true ) {
 264                         $this->dieUsageMsg( array( 'badaccess-groups' ) );
 265                 }
 266
 267                 $this->verifyUpload();
 268
 269                 $warnings = $this->checkForWarnings();
 270                 if ( isset( $warnings ) ) {
 271                         return $warnings;
 272                 }
 273
 274                 // Use comment as initial page text by default
 275                 if ( is_null( $this->mParams['text'] ) ) {
 276                         $this->mParams['text'] = $this->mParams['comment'];
 277                 }
 278
 279                 $file = $this->mUpload->getLocalFile();
 280                 $watch = $this->getWatchlistValue( $this->mParams['watchlist'], $file->getTitle() );
 281
 282                 // Deprecated parameters
 283                 if ( $this->mParams['watch'] ) {
 284                         $watch = true;
 285                 }
 286
 287                 // No errors, no warnings: do the upload
 288                 $status = $this->mUpload->performUpload( $this->mParams['comment'],
 289                         $this->mParams['text'], $watch, $wgUser );
 290
 291                 if ( !$status->isGood() ) {
 292                         $error = $status->getErrorsArray();
 293                         $this->getResult()->setIndexedTagName( $result['details'], 'error' );
 294
 295                         $this->dieUsage( 'An internal error occurred', 'internal-error', 0, $error );
 296                 }
 297
 298                 $file = $this->mUpload->getLocalFile();
 299
 300                 $result['result'] = 'Success';
 301                 $result['filename'] = $file->getName();
 302                 $result['imageinfo'] = $this->mUpload->getImageInfo( $this->getResult() );
 303
 304                 return $result;
 305         }
 306
 307         public function mustBePosted() {
 308                 return true;
 309         }
 310
 311         public function isWriteMode() {
 312                 return true;
 313         }
 314
 315         public function getAllowedParams() {
 316                 $params = array(
 317                         'filename' => null,
 318                         'comment' => array(
 319                                 ApiBase::PARAM_DFLT => ''
 320                         ),
 321                         'text' => null,
 322                         'token' => null,
 323                         'watch' => array(
 324                                 ApiBase::PARAM_DFLT => false,
 325                                 ApiBase::PARAM_DEPRECATED => true,
 326                         ),
 327                         'watchlist' => array(
 328                                 ApiBase::PARAM_DFLT => 'preferences',
 329                                 ApiBase::PARAM_TYPE => array(
 330                                         'watch',
 331                                         'preferences',
 332                                         'nochange'
 333                                 ),
 334                         ),
 335                         'ignorewarnings' => false,
 336                         'file' => null,
 337                         'url' => null,
 338                         'asyncdownload' => false,
 339                         'sessionkey' => null,
 340                 );
 341                 return $params;
 342         }
 343
 344         public function getParamDescription() {
 345                 return array(
 346                         'filename' => 'Target filename',
 347                         'token' => 'Edit token. You can get one of these through prop=info',
 348                         'comment' => 'Upload comment. Also used as the initial page text for new files if "text" is not specified',
 349                         'text' => 'Initial page text for new files',
 350                         'watch' => 'Watch the page',
 351                         'watchlist' => 'Unconditionally add or remove the page from your watchlist, use preferences or do not change watch',
 352                         'ignorewarnings' => 'Ignore any warnings',
 353                         'file' => 'File contents',
 354                         'url' => 'Url to fetch the file from',
 355                         'asyncdownload' => 'Make fetching a URL asyncronous',
 356                         'sessionkey' => array(
 357                                 'Session key returned by a previous upload that failed due to warnings',
 358                         ),
 359                 );
 360         }
 361
 362         public function getDescription() {
 363                 return array(
 364                         'Upload a file, or get the status of pending uploads. Several methods are available:',
 365                         ' * Upload file contents directly, using the "file" parameter',
 366                         ' * Have the MediaWiki server fetch a file from a URL, using the "url" parameter',
 367                         ' * Complete an earlier upload that failed due to warnings, using the "sessionkey" parameter',
 368                         'Note that the HTTP POST must be done as a file upload (i.e. using multipart/form-data) when',
 369                         'sending the "file". Note also that queries using session keys must be',
 370                         'done in the same login session as the query that originally returned the key (i.e. do not',
 371                         'log out and then log back in). Also you must get and send an edit token before doing any upload stuff'
 372                 );
 373         }
 374
 375         public function getPossibleErrors() {
 376                 return array_merge( parent::getPossibleErrors(), array(
 377                         array( 'uploaddisabled' ),
 378                         array( 'invalid-session-key' ),
 379                         array( 'uploaddisabled' ),
 380                         array( 'badaccess-groups' ),
 381                         array( 'missingparam', 'filename' ),
 382                         array( 'mustbeloggedin', 'upload' ),
 383                         array( 'badaccess-groups' ),
 384                         array( 'badaccess-groups' ),
 385                         array( 'code' => 'fetchfileerror', 'info' => '' ),
 386                         array( 'code' => 'nomodule', 'info' => 'No upload module set' ),
 387                         array( 'code' => 'empty-file', 'info' => 'The file you submitted was empty' ),
 388                         array( 'code' => 'filetype-missing', 'info' => 'The file is missing an extension' ),
 389                         array( 'code' => 'filename-tooshort', 'info' => 'The filename is too short' ),
 390                         array( 'code' => 'overwrite', 'info' => 'Overwriting an existing file is not allowed' ),
 391                         array( 'code' => 'stashfailed', 'info' => 'Stashing temporary file failed' ),
 392                         array( 'code' => 'internal-error', 'info' => 'An internal error occurred' ),
 393                 ) );
 394         }
 395
 396         public function getTokenSalt() {
 397                 return '';
 398         }
 399
 400         protected function getExamples() {
 401                 return array(
 402                         'Upload from a URL:',
 403                         '    api.php?action=upload&filename=Wiki.png&url=http%3A//upload.wikimedia.org/wikipedia/en/b/bc/Wiki.png',
 404                         'Complete an upload that failed due to warnings:',
 405                         '    api.php?action=upload&filename=Wiki.png&sessionkey=sessionkey&ignorewarnings=1',
 406                 );
 407         }
 408
 409         public function getVersion() {
 410                 return __CLASS__ . ': $Id: ApiUpload.php 51812 2009-06-12 23:45:20Z dale $';
 411         }
 412 }