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  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, 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( 'uploaddisabled' ) );
  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                                 $this->mUpload->initialize( $this->mParams['filename'],
  96                                                 $this->mParams['url'] );
  97
  98                                 $status = $this->mUpload->fetchFile();
  99                                 if ( !$status->isOK() ) {
 100                                         $this->dieUsage( $status->getWikiText(),  'fetchfileerror' );
 101                                 }
 102                         }
 103                 } else {
 104                         $this->dieUsageMsg( array( 'missingparam', 'filename' ) );
 105                 }
 106
 107                 if ( !isset( $this->mUpload ) ) {
 108                         $this->dieUsage( 'No upload module set', 'nomodule' );
 109                 }
 110
 111                 // Check whether the user has the appropriate permissions to upload anyway
 112                 $permission = $this->mUpload->isAllowed( $wgUser );
 113
 114                 if ( $permission !== true ) {
 115                         if ( !$wgUser->isLoggedIn() ) {
 116                                 $this->dieUsageMsg( array( 'mustbeloggedin', 'upload' ) );
 117                         } else {
 118                                 $this->dieUsageMsg( array( 'badaccess-groups' ) );
 119                         }
 120                 }
 121                 // Perform the upload
 122                 $result = $this->performUpload();
 123
 124                 // Cleanup any temporary mess
 125                 $this->mUpload->cleanupTempFile();
 126
 127                 $this->getResult()->addValue( null, $this->getModuleName(), $result );
 128         }
 129
 130         /**
 131          * Performs file verification, dies on error.
 132          *
 133          * @param $flag integer passed to UploadBase::verifyUpload, set to
 134          * UploadBase::EMPTY_FILE to skip the empty file check.
 135          */
 136         public function verifyUpload( $flag ) {
 137                 $verification = $this->mUpload->verifyUpload( $flag );
 138                 if ( $verification['status'] === UploadBase::OK ) {
 139                         return $verification;
 140                 }
 141
 142                 $this->getVerificationError( $verification );
 143         }
 144
 145         /**
 146          * Produce the usage error
 147          *
 148          * @param $verification array an associative array with the status
 149          * key
 150          */
 151         public function getVerificationError( $verification ) {
 152                 // TODO: Move them to ApiBase's message map
 153                 switch( $verification['status'] ) {
 154                         case UploadBase::EMPTY_FILE:
 155                                 $this->dieUsage( 'The file you submitted was empty', 'empty-file' );
 156                                 break;
 157                         case UploadBase::FILE_TOO_LARGE:
 158                                 $this->dieUsage( 'The file you submitted was too large', 'file-too-large' );
 159                                 break;
 160                         case UploadBase::FILETYPE_MISSING:
 161                                 $this->dieUsage( 'The file is missing an extension', 'filetype-missing' );
 162                                 break;
 163                         case UploadBase::FILETYPE_BADTYPE:
 164                                 global $wgFileExtensions;
 165                                 $this->dieUsage( 'This type of file is banned', 'filetype-banned',
 166                                                 0, array(
 167                                                         'filetype' => $verification['finalExt'],
 168                                                         'allowed' => $wgFileExtensions
 169                                                 ) );
 170                                 break;
 171                         case UploadBase::MIN_LENGTH_PARTNAME:
 172                                 $this->dieUsage( 'The filename is too short', 'filename-tooshort' );
 173                                 break;
 174                         case UploadBase::ILLEGAL_FILENAME:
 175                                 $this->dieUsage( 'The filename is not allowed', 'illegal-filename',
 176                                                 0, array( 'filename' => $verification['filtered'] ) );
 177                                 break;
 178                         case UploadBase::OVERWRITE_EXISTING_FILE:
 179                                 $this->dieUsage( 'Overwriting an existing file is not allowed', 'overwrite' );
 180                                 break;
 181                         case UploadBase::VERIFICATION_ERROR:
 182                                 $this->getResult()->setIndexedTagName( $verification['details'], 'detail' );
 183                                 $this->dieUsage( 'This file did not pass file verification', 'verification-error',
 184                                                 0, array( 'details' => $verification['details'] ) );
 185                                 break;
 186                         case UploadBase::HOOK_ABORTED:
 187                                 $this->dieUsage( "The modification you tried to make was aborted by an extension hook",
 188                                                 'hookaborted', 0, array( 'error' => $verification['error'] ) );
 189                                 break;
 190                         default:
 191                                 $this->dieUsage( 'An unknown error occurred', 'unknown-error',
 192                                                 0, array( 'code' =>  $verification['status'] ) );
 193                                 break;
 194                 }
 195         }
 196
 197         protected function checkForWarnings() {
 198                 $result = array();
 199
 200                 if ( !$this->mParams['ignorewarnings'] ) {
 201                         $warnings = $this->mUpload->checkWarnings();
 202                         if ( $warnings ) {
 203                                 // Add indices
 204                                 $this->getResult()->setIndexedTagName( $warnings, 'warning' );
 205
 206                                 if ( isset( $warnings['duplicate'] ) ) {
 207                                         $dupes = array();
 208                                         foreach ( $warnings['duplicate'] as $key => $dupe )
 209                                                 $dupes[] = $dupe->getName();
 210                                         $this->getResult()->setIndexedTagName( $dupes, 'duplicate' );
 211                                         $warnings['duplicate'] = $dupes;
 212                                 }
 213
 214                                 if ( isset( $warnings['exists'] ) ) {
 215                                         $warning = $warnings['exists'];
 216                                         unset( $warnings['exists'] );
 217                                         $warnings[$warning['warning']] = $warning['file']->getName();
 218                                 }
 219
 220                                 $result['result'] = 'Warning';
 221                                 $result['warnings'] = $warnings;
 222
 223                                 $sessionKey = $this->mUpload->stashSession();
 224                                 if ( !$sessionKey ) {
 225                                         $this->dieUsage( 'Stashing temporary file failed', 'stashfailed' );
 226                                 }
 227
 228                                 $result['sessionkey'] = $sessionKey;
 229
 230                                 return $result;
 231                         }
 232                 }
 233                 return;
 234         }
 235
 236         protected function performUpload() {
 237                 global $wgUser;
 238                 $permErrors = $this->mUpload->verifyPermissions( $wgUser );
 239                 if ( $permErrors !== true ) {
 240                         $this->dieUsageMsg( array( 'badaccess-groups' ) );
 241                 }
 242
 243                 $this->verifyUpload();
 244
 245                 $warnings = $this->checkForWarnings();
 246                 if( isset($warnings) ) return $warnings;
 247
 248                 // Use comment as initial page text by default
 249                 if ( is_null( $this->mParams['text'] ) ) {
 250                         $this->mParams['text'] = $this->mParams['comment'];
 251                 }
 252
 253                 $file = $this->mUpload->getLocalFile();
 254                 $watch = $this->getWatchlistValue( $this->mParams['watchlist'], $file->getTitle() );
 255
 256                 // Deprecated parameters
 257                 if ( $this->mParams['watch'] ) {
 258                         $watch = true;
 259                 }
 260
 261                 // No errors, no warnings: do the upload
 262                 $status = $this->mUpload->performUpload( $this->mParams['comment'],
 263                         $this->mParams['text'], $watch, $wgUser );
 264
 265                 if ( !$status->isGood() ) {
 266                         $error = $status->getErrorsArray();
 267                         $this->getResult()->setIndexedTagName( $result['details'], 'error' );
 268
 269                         $this->dieUsage( 'An internal error occurred', 'internal-error', 0, $error );
 270                 }
 271
 272                 $file = $this->mUpload->getLocalFile();
 273
 274                 $result['result'] = 'Success';
 275                 $result['filename'] = $file->getName();
 276                 $result['imageinfo'] = $this->mUpload->getImageInfo( $this->getResult() );
 277
 278                 return $result;
 279         }
 280
 281         public function mustBePosted() {
 282                 return true;
 283         }
 284
 285         public function isWriteMode() {
 286                 return true;
 287         }
 288
 289         public function getAllowedParams() {
 290                 $params = array(
 291                         'filename' => null,
 292                         'comment' => array(
 293                                 ApiBase::PARAM_DFLT => ''
 294                         ),
 295                         'text' => null,
 296                         'token' => null,
 297                         'watch' => array(
 298                                 ApiBase::PARAM_DFLT => false,
 299                                 ApiBase::PARAM_DEPRECATED => true,
 300                         ),
 301                         'watchlist' => array(
 302                                 ApiBase::PARAM_DFLT => 'preferences',
 303                                 ApiBase::PARAM_TYPE => array(
 304                                         'watch',
 305                                         'preferences',
 306                                         'nochange'
 307                                 ),
 308                         ),
 309                         'ignorewarnings' => false,
 310                         'file' => null,
 311                         'url' => null,
 312                         'sessionkey' => null,
 313                 );
 314                 return $params;
 315         }
 316
 317         public function getParamDescription() {
 318                 return array(
 319                         'filename' => 'Target filename',
 320                         'token' => 'Edit token. You can get one of these through prop=info',
 321                         'comment' => 'Upload comment. Also used as the initial page text for new files if "text" is not specified',
 322                         'text' => 'Initial page text for new files',
 323                         'watch' => 'Watch the page',
 324                         'watchlist' => 'Unconditionally add or remove the page from your watchlist, use preferences or do not change watch',
 325                         'ignorewarnings' => 'Ignore any warnings',
 326                         'file' => 'File contents',
 327                         'url' => 'Url to fetch the file from',
 328                         'sessionkey' => array(
 329                                 'Session key returned by a previous upload that failed due to warnings',
 330                         ),
 331                 );
 332         }
 333
 334         public function getDescription() {
 335                 return array(
 336                         'Upload a file, or get the status of pending uploads. Several methods are available:',
 337                         ' * Upload file contents directly, using the "file" parameter',
 338                         ' * Have the MediaWiki server fetch a file from a URL, using the "url" parameter',
 339                         ' * Complete an earlier upload that failed due to warnings, using the "sessionkey" parameter',
 340                         'Note that the HTTP POST must be done as a file upload (i.e. using multipart/form-data) when',
 341                         'sending the "file". Note also that queries using session keys must be',
 342                         'done in the same login session as the query that originally returned the key (i.e. do not',
 343                         'log out and then log back in). Also you must get and send an edit token before doing any upload stuff.'
 344                 );
 345         }
 346
 347         public function getPossibleErrors() {
 348                 return array_merge( parent::getPossibleErrors(), array(
 349                         array( 'uploaddisabled' ),
 350                         array( 'invalid-session-key' ),
 351                         array( 'uploaddisabled' ),
 352                         array( 'badaccess-groups' ),
 353                         array( 'missingparam', 'filename' ),
 354                         array( 'mustbeloggedin', 'upload' ),
 355                         array( 'badaccess-groups' ),
 356                         array( 'badaccess-groups' ),
 357                         array( 'code' => 'fetchfileerror', 'info' => '' ),
 358                         array( 'code' => 'nomodule', 'info' => 'No upload module set' ),
 359                         array( 'code' => 'empty-file', 'info' => 'The file you submitted was empty' ),
 360                         array( 'code' => 'filetype-missing', 'info' => 'The file is missing an extension' ),
 361                         array( 'code' => 'filename-tooshort', 'info' => 'The filename is too short' ),
 362                         array( 'code' => 'overwrite', 'info' => 'Overwriting an existing file is not allowed' ),
 363                         array( 'code' => 'stashfailed', 'info' => 'Stashing temporary file failed' ),
 364                         array( 'code' => 'internal-error', 'info' => 'An internal error occurred' ),
 365                 ) );
 366         }
 367
 368         public function getTokenSalt() {
 369                 return '';
 370         }
 371
 372         protected function getExamples() {
 373                 return array(
 374                         'Upload from a URL:',
 375                         '    api.php?action=upload&filename=Wiki.png&url=http%3A//upload.wikimedia.org/wikipedia/en/b/bc/Wiki.png',
 376                         'Complete an upload that failed due to warnings:',
 377                         '    api.php?action=upload&filename=Wiki.png&sessionkey=sessionkey&ignorewarnings=1',
 378                 );
 379         }
 380
 381         public function getVersion() {
 382                 return __CLASS__ . ': $Id: ApiUpload.php 51812 2009-06-12 23:45:20Z dale $';
 383         }
 384 }