includes/api/ApiUpload.php

   1 <?php
   2 /*
   3  * Created on Aug 21, 2008
   4  * API for MediaWiki 1.8+
   5  *
   6  * Copyright (C) 2008 - 2009 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                 $this->getMain()->isWriteMode();
  44                 $this->mParams = $this->extractRequestParams();
  45                 $request = $this->getMain()->getRequest();
  46
  47                 // Do token checks:
  48                 if ( is_null( $this->mParams['token'] ) )
  49                         $this->dieUsageMsg( array( 'missingparam', 'token' ) );
  50                 if ( !$wgUser->matchEditToken( $this->mParams['token'] ) )
  51                         $this->dieUsageMsg( array( 'sessionfailure' ) );
  52
  53                 // Add the uploaded file to the params array
  54                 $this->mParams['file'] = $request->getFileName( 'file' );
  55
  56                 // Check whether upload is enabled
  57                 if ( !UploadBase::isEnabled() )
  58                         $this->dieUsageMsg( array( 'uploaddisabled' ) );
  59
  60                 // One and only one of the following parameters is needed
  61                 $this->requireOnlyOneParameter( $this->mParams,
  62                         'sessionkey', 'file', 'url', 'enablechunks' );
  63
  64                 if ( $this->mParams['sessionkey'] ) {
  65                         /**
  66                          * Upload stashed in a previous request
  67                          */
  68                         // Check the session key
  69                         if ( !isset( $_SESSION['wsUploadData'][$this->mParams['sessionkey']] ) )
  70                                 return $this->dieUsageMsg( array( 'invalid-session-key' ) );
  71
  72                         $this->mUpload = new UploadFromStash();
  73                         $this->mUpload->initialize( $this->mParams['filename'],
  74                                 $_SESSION['wsUploadData'][$this->mParams['sessionkey']] );
  75                 } else {
  76                         /**
  77                          * Upload from url, etc
  78                          * Parameter filename is required
  79                          */
  80                         if ( !isset( $this->mParams['filename'] ) )
  81                                 $this->dieUsageMsg( array( 'missingparam', 'filename' ) );
  82
  83                         // Initialize $this->mUpload
  84                         if ( $this->mParams['enablechunks'] ) {
  85                                 $this->mUpload = new UploadFromChunks();
  86                                 $this->mUpload->initialize(
  87                                         $request->getVal( 'done', null ),
  88                                         $request->getVal( 'filename', null ),
  89                                         $request->getVal( 'chunksessionkey', null ),
  90                                         $request->getFileTempName( 'chunk' ),
  91                                         $request->getFileSize( 'chunk' ),
  92                                         $request->getSessionData( 'wsUploadData' )
  93                                 );
  94
  95                                 if ( !$this->mUpload->status->isOK() ) {
  96                                         return $this->dieUsageMsg( $this->mUpload->status->getWikiText(),
  97                                                 'chunked-error' );
  98                                 }
  99                         } elseif ( isset( $this->mParams['file'] ) ) {
 100                                 $this->mUpload = new UploadFromFile();
 101                                 $this->mUpload->initialize(
 102                                         $this->mParams['filename'],
 103                                         $request->getFileTempName( 'file' ),
 104                                         $request->getFileSize( 'file' )
 105                                 );
 106                         } elseif ( isset( $this->mParams['url'] ) ) {
 107                                 // make sure upload by url is enabled:
 108                                 if ( !$wgAllowCopyUploads )
 109                                         $this->dieUsageMsg( array( 'uploaddisabled' ) );
 110
 111                                 // make sure the current user can upload
 112                                 if ( ! $wgUser->isAllowed( 'upload_by_url' ) )
 113                                         $this->dieUsageMsg( array( 'badaccess-groups' ) );
 114
 115                                 $this->mUpload = new UploadFromUrl();
 116                                 $this->mUpload->initialize( $this->mParams['filename'],
 117                                                 $this->mParams['url'] );
 118
 119                                 $status = $this->mUpload->fetchFile();
 120                                 if ( !$status->isOK() ) {
 121                                         return $this->dieUsage( $status->getWikiText(),  'fetchfileerror' );
 122                                 }
 123                         }
 124                 }
 125
 126                 if ( !isset( $this->mUpload ) )
 127                         $this->dieUsage( 'No upload module set', 'nomodule' );
 128
 129                 // Check whether the user has the appropriate permissions to upload anyway
 130                 $permission = $this->mUpload->isAllowed( $wgUser );
 131
 132                 if ( $permission !== true ) {
 133                         if ( !$wgUser->isLoggedIn() )
 134                                 $this->dieUsageMsg( array( 'mustbeloggedin', 'upload' ) );
 135                         else
 136                                 $this->dieUsageMsg( array( 'badaccess-groups' ) );
 137                 }
 138                 // Perform the upload
 139                 $result = $this->performUpload();
 140
 141                 // Cleanup any temporary mess
 142                 $this->mUpload->cleanupTempFile();
 143                 $this->getResult()->addValue( null, $this->getModuleName(), $result );
 144         }
 145
 146         protected function performUpload() {
 147                 global $wgUser;
 148                 $result = array();
 149                 $permErrors = $this->mUpload->verifyPermissions( $wgUser );
 150                 if ( $permErrors !== true ) {
 151                         $this->dieUsageMsg( array( 'badaccess-groups' ) );
 152                 }
 153
 154                 // TODO: Move them to ApiBase's message map
 155                 $verification = $this->mUpload->verifyUpload();
 156                 if ( $verification['status'] !== UploadBase::OK ) {
 157                         $result['result'] = 'Failure';
 158                         switch( $verification['status'] ) {
 159                                 case UploadBase::EMPTY_FILE:
 160                                         $this->dieUsage( 'The file you submitted was empty', 'empty-file' );
 161                                         break;
 162                                 case UploadBase::FILETYPE_MISSING:
 163                                         $this->dieUsage( 'The file is missing an extension', 'filetype-missing' );
 164                                         break;
 165                                 case UploadBase::FILETYPE_BADTYPE:
 166                                         global $wgFileExtensions;
 167                                         $this->dieUsage( 'This type of file is banned', 'filetype-banned',
 168                                                         0, array(
 169                                                                 'filetype' => $verification['finalExt'],
 170                                                                 'allowed' => $wgFileExtensions
 171                                                         ) );
 172                                         break;
 173                                 case UploadBase::MIN_LENGTH_PARTNAME:
 174                                         $this->dieUsage( 'The filename is too short', 'filename-tooshort' );
 175                                         break;
 176                                 case UploadBase::ILLEGAL_FILENAME:
 177                                         $this->dieUsage( 'The filename is not allowed', 'illegal-filename',
 178                                                         0, array( 'filename' => $verification['filtered'] ) );
 179                                         break;
 180                                 case UploadBase::OVERWRITE_EXISTING_FILE:
 181                                         $this->dieUsage( 'Overwriting an existing file is not allowed', 'overwrite' );
 182                                         break;
 183                                 case UploadBase::VERIFICATION_ERROR:
 184                                         $this->getResult()->setIndexedTagName( $verification['details'], 'detail' );
 185                                         $this->dieUsage( 'This file did not pass file verification', 'verification-error',
 186                                                         0, array( 'details' => $verification['details'] ) );
 187                                         break;
 188                                 case UploadBase::HOOK_ABORTED:
 189                                         $this->dieUsage( "The modification you tried to make was aborted by an extension hook",
 190                                                         'hookaborted', 0, array( 'error' => $verification['error'] ) );
 191                                         break;
 192                                 default:
 193                                         $this->dieUsage( 'An unknown error occurred', 'unknown-error',
 194                                                         0, array( 'code' =>  $verification['status'] ) );
 195                                         break;
 196                         }
 197                         return $result;
 198                 }
 199                 if ( !$this->mParams['ignorewarnings'] ) {
 200                         $warnings = $this->mUpload->checkWarnings();
 201                         if ( $warnings ) {
 202                                 // Add indices
 203                                 $this->getResult()->setIndexedTagName( $warnings, 'warning' );
 204
 205                                 if ( isset( $warnings['duplicate'] ) ) {
 206                                         $dupes = array();
 207                                         foreach ( $warnings['duplicate'] as $key => $dupe )
 208                                                 $dupes[] = $dupe->getName();
 209                                         $this->getResult()->setIndexedTagName( $dupes, 'duplicate' );
 210                                         $warnings['duplicate'] = $dupes;
 211                                 }
 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                                 $result['sessionkey'] = $sessionKey;
 228
 229                                 return $result;
 230                         }
 231                 }
 232
 233                 // Use comment as initial page text by default
 234                 if ( is_null( $this->mParams['text'] ) )
 235                         $this->mParams['text'] = $this->mParams['comment'];
 236
 237                 // No errors, no warnings: do the upload
 238                 $status = $this->mUpload->performUpload( $this->mParams['comment'],
 239                         $this->mParams['text'], $this->mParams['watch'], $wgUser );
 240
 241                 if ( !$status->isGood() ) {
 242                         $error = $status->getErrorsArray();
 243                         $this->getResult()->setIndexedTagName( $result['details'], 'error' );
 244
 245                         $this->dieUsage( 'An internal error occurred', 'internal-error', 0, $error );
 246                 }
 247
 248                 $file = $this->mUpload->getLocalFile();
 249                 $result['result'] = 'Success';
 250                 $result['filename'] = $file->getName();
 251                 $result['imageinfo'] = $this->mUpload->getImageInfo( $this->getResult() );
 252
 253                 return $result;
 254         }
 255
 256         public function mustBePosted() {
 257                 return true;
 258         }
 259
 260         public function isWriteMode() {
 261                 return true;
 262         }
 263
 264         public function getAllowedParams() {
 265                 $params = array(
 266                         'filename' => null,
 267                         'comment' => array(
 268                                 ApiBase::PARAM_DFLT => ''
 269                         ),
 270                         'text' => null,
 271                         'token' => null,
 272                         'watch' => false,
 273                         'ignorewarnings' => false,
 274                         'file' => null,
 275                         'enablechunks' => false,
 276                         'chunksessionkey' => null,
 277                         'chunk' => null,
 278                         'done' => false,
 279                         'url' => null,
 280                         'sessionkey' => null,
 281                 );
 282
 283                 if ( $this->getMain()->isInternalMode() )
 284                         $params['internalhttpsession'] = null;
 285                 return $params;
 286
 287         }
 288
 289         public function getParamDescription() {
 290                 return array(
 291                         'filename' => 'Target filename',
 292                         'token' => 'Edit token. You can get one of these through prop=info',
 293                         'comment' => 'Upload comment. Also used as the initial page text for new files if "text" is not specified',
 294                         'text' => 'Initial page text for new files',
 295                         'watch' => 'Watch the page',
 296                         'ignorewarnings' => 'Ignore any warnings',
 297                         'file' => 'File contents',
 298                         'enablechunks' => 'Set to use chunk mode; see http://firefogg.org/dev/chunk_post.html for protocol',
 299                         'chunksessionkey' => 'The session key, established on the first contact during the chunked upload',
 300                         'chunk' => 'The data in this chunk of a chunked upload',
 301                         'done' => 'Set to 1 on the last chunk of a chunked upload',
 302                         'url' => 'Url to fetch the file from',
 303                         'sessionkey' => array(
 304                                 'Session key returned by a previous upload that failed due to warnings',
 305                         ),
 306                 );
 307         }
 308
 309         public function getDescription() {
 310                 return array(
 311                         'Upload a file, or get the status of pending uploads. Several methods are available:',
 312                         ' * Upload file contents directly, using the "file" parameter',
 313                         ' * Upload a file in chunks, using the "enablechunks",',
 314                         ' * Have the MediaWiki server fetch a file from a URL, using the "url" parameter',
 315                         ' * Complete an earlier upload that failed due to warnings, using the "sessionkey" parameter',
 316                         'Note that the HTTP POST must be done as a file upload (i.e. using multipart/form-data) when',
 317                         'sending the "file" or "chunk" parameters. Note also that queries using session keys must be',
 318                         'done in the same login session as the query that originally returned the key (i.e. do not',
 319                         'log out and then log back in). Also you must get and send an edit token before doing any upload stuff.'
 320                 );
 321         }
 322
 323         protected function getExamples() {
 324                 return array(
 325                         'Upload from a URL:',
 326                         '    api.php?action=upload&filename=Wiki.png&url=http%3A//upload.wikimedia.org/wikipedia/en/b/bc/Wiki.png',
 327                         'Complete an upload that failed due to warnings:',
 328                         '    api.php?action=upload&filename=Wiki.png&sessionkey=sessionkey&ignorewarnings=1',
 329                         'Begin a chunked upload:',
 330                         '    api.php?action=upload&filename=Wiki.png&enablechunks=1'
 331                 );
 332         }
 333
 334         public function getVersion() {
 335                 return __CLASS__ . ': $Id: ApiUpload.php 51812 2009-06-12 23:45:20Z dale $';
 336         }
 337 }