5 * Created on Aug 21, 2008
7 * Copyright © 2008 - 2010 Bryan Tong Minh <Bryan.TongMinh@Gmail.com>
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.
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.
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
30 class ApiUpload
extends ApiBase
{
35 protected $mUpload = null;
39 public function __construct( $main, $action ) {
40 parent
::__construct( $main, $action );
43 public function execute() {
44 // Check whether upload is enabled
45 if ( !UploadBase
::isEnabled() ) {
46 $this->dieUsageMsg( 'uploaddisabled' );
49 $user = $this->getUser();
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' );
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'];
63 // Select an upload module
64 if ( !$this->selectUploadModule() ) {
65 // This is not a true upload, but a status request or similar
68 if ( !isset( $this->mUpload
) ) {
69 $this->dieUsage( 'No upload module set', 'nomodule' );
72 // First check permission to upload
73 $this->checkPermissions( $user );
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] );
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' );
90 $this->verifyUpload();
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' );
102 // Get the result based on the current upload context:
103 $result = $this->getContextResult();
105 if ( $result['result'] === 'Success' ) {
106 $result['imageinfo'] = $this->mUpload
->getImageInfo( $this->getResult() );
109 $this->getResult()->addValue( null, $this->getModuleName(), $result );
111 // Cleanup any temporary mess
112 $this->mUpload
->cleanupTempFile();
115 * Get an uplaod result based on upload context
117 private function getContextResult(){
118 $warnings = $this->getApiWarnings();
120 // Get warnings formated in result array format
121 return $this->getWarningsResult( $warnings );
122 } elseif ( $this->mParams
['chunk'] ) {
123 // Add chunk, and get result
124 return $this->getChunkResult();
125 } elseif ( $this->mParams
['stash'] ) {
126 // Stash the file and get stash result
127 return $this->getStashResult();
129 // This is the most common case -- a normal upload with no warnings
130 // performUpload will return a formatted properly for the API with status
131 return $this->performUpload();
134 * Get Stash Result, throws an expetion if the file could not be stashed.
136 private function getStashResult(){
138 // Some uploads can request they be stashed, so as not to publish them immediately.
139 // In this case, a failure to stash ought to be fatal
141 $result['result'] = 'Success';
142 $result['filekey'] = $this->performStash();
143 $result['sessionkey'] = $result['filekey']; // backwards compatibility
144 } catch ( MWException
$e ) {
145 $this->dieUsage( $e->getMessage(), 'stashfailed' );
150 * Get Warnings Result
151 * @param $warnings Array of Api upload warnings
153 private function getWarningsResult( $warnings ){
155 $result['result'] = 'Warning';
156 $result['warnings'] = $warnings;
157 // in case the warnings can be fixed with some further user action, let's stash this upload
158 // and return a key they can use to restart it
160 $result['filekey'] = $this->performStash();
161 $result['sessionkey'] = $result['filekey']; // backwards compatibility
162 } catch ( MWException
$e ) {
163 $result['warnings']['stashfailed'] = $e->getMessage();
168 * Get the result of a chunk upload.
170 private function getChunkResult(){
173 $result['result'] = 'Continue';
174 $request = $this->getMain()->getRequest();
175 $chunkPath = $request->getFileTempname( 'chunk' );
176 $chunkSize = $request->getUpload( 'chunk' )->getSize();
177 if ($this->mParams
['offset'] == 0) {
178 $result['filekey'] = $this->performStash();
180 $status = $this->mUpload
->addChunk($chunkPath, $chunkSize,
181 $this->mParams
['offset']);
182 if ( !$status->isGood() ) {
183 $this->dieUsage( $status->getWikiText(), 'stashfailed' );
186 $result['filekey'] = $this->mParams
['filekey'];
187 // Check we added the last chunk:
188 if( $this->mParams
['offset'] +
$chunkSize == $this->mParams
['filesize'] ) {
189 $status = $this->mUpload
->concatenateChunks();
190 if ( !$status->isGood() ) {
191 $this->dieUsage( $status->getWikiText(), 'stashfailed' );
194 $result['result'] = 'Success';
197 $result['offset'] = $this->mParams
['offset'] +
$chunkSize;
202 * Stash the file and return the file key
203 * Also re-raises exceptions with slightly more informative message strings (useful for API)
204 * @throws MWException
205 * @return String file key
207 function performStash() {
209 $stashFile = $this->mUpload
->stashFile();
212 throw new MWException( 'Invalid stashed file' );
214 $fileKey = $stashFile->getFileKey();
215 } catch ( MWException
$e ) {
216 $message = 'Stashing temporary file failed: ' . get_class( $e ) . ' ' . $e->getMessage();
217 wfDebug( __METHOD__
. ' ' . $message . "\n");
218 throw new MWException( $message );
224 * Throw an error that the user can recover from by providing a better
225 * value for $parameter
227 * @param $error array Error array suitable for passing to dieUsageMsg()
228 * @param $parameter string Parameter that needs revising
229 * @param $data array Optional extra data to pass to the user
230 * @throws UsageException
232 function dieRecoverableError( $error, $parameter, $data = array() ) {
234 $data['filekey'] = $this->performStash();
235 $data['sessionkey'] = $data['filekey'];
236 } catch ( MWException
$e ) {
237 $data['stashfailed'] = $e->getMessage();
239 $data['invalidparameter'] = $parameter;
241 $parsed = $this->parseMsg( $error );
242 $this->dieUsage( $parsed['info'], $parsed['code'], 0, $data );
246 * Select an upload module and set it to mUpload. Dies on failure. If the
247 * request was a status request and not a true upload, returns false;
252 protected function selectUploadModule() {
253 $request = $this->getMain()->getRequest();
255 // chunk or one and only one of the following parameters is needed
256 if( !$this->mParams
['chunk'] ) {
257 $this->requireOnlyOneParameter( $this->mParams
,
258 'filekey', 'file', 'url', 'statuskey' );
261 if ( $this->mParams
['statuskey'] ) {
262 $this->checkAsyncDownloadEnabled();
264 // Status request for an async upload
265 $sessionData = UploadFromUrlJob
::getSessionData( $this->mParams
['statuskey'] );
266 if ( !isset( $sessionData['result'] ) ) {
267 $this->dieUsage( 'No result in session data', 'missingresult' );
269 if ( $sessionData['result'] == 'Warning' ) {
270 $sessionData['warnings'] = $this->transformWarnings( $sessionData['warnings'] );
271 $sessionData['sessionkey'] = $this->mParams
['statuskey'];
273 $this->getResult()->addValue( null, $this->getModuleName(), $sessionData );
278 // The following modules all require the filename parameter to be set
279 if ( is_null( $this->mParams
['filename'] ) ) {
280 $this->dieUsageMsg( array( 'missingparam', 'filename' ) );
283 if ( $this->mParams
['chunk'] ) {
285 $this->mUpload
= new UploadFromChunks();
286 if( isset( $this->mParams
['filekey'] ) ){
288 $this->mUpload
->continueChunks(
289 $this->mParams
['filename'],
290 $this->mParams
['filekey'],
291 $request->getUpload( 'chunk' )
294 // handle first chunk
295 $this->mUpload
->initialize(
296 $this->mParams
['filename'],
297 $request->getUpload( 'chunk' )
300 } elseif ( isset( $this->mParams
['filekey'] ) ) {
301 // Upload stashed in a previous request
302 if ( !UploadFromStash
::isValidKey( $this->mParams
['filekey'] ) ) {
303 $this->dieUsageMsg( 'invalid-file-key' );
306 $this->mUpload
= new UploadFromStash( $this->getUser() );
308 $this->mUpload
->initialize( $this->mParams
['filekey'], $this->mParams
['filename'] );
309 } elseif ( isset( $this->mParams
['file'] ) ) {
310 $this->mUpload
= new UploadFromFile();
311 $this->mUpload
->initialize(
312 $this->mParams
['filename'],
313 $request->getUpload( 'file' )
315 } elseif ( isset( $this->mParams
['url'] ) ) {
316 // Make sure upload by URL is enabled:
317 if ( !UploadFromUrl
::isEnabled() ) {
318 $this->dieUsageMsg( 'copyuploaddisabled' );
322 if ( $this->mParams
['asyncdownload'] ) {
323 $this->checkAsyncDownloadEnabled();
325 if ( $this->mParams
['leavemessage'] && !$this->mParams
['ignorewarnings'] ) {
326 $this->dieUsage( 'Using leavemessage without ignorewarnings is not supported',
327 'missing-ignorewarnings' );
330 if ( $this->mParams
['leavemessage'] ) {
331 $async = 'async-leavemessage';
336 $this->mUpload
= new UploadFromUrl
;
337 $this->mUpload
->initialize( $this->mParams
['filename'],
338 $this->mParams
['url'], $async );
345 * Checks that the user has permissions to perform this upload.
346 * Dies with usage message on inadequate permissions.
347 * @param $user User The user to check.
349 protected function checkPermissions( $user ) {
350 // Check whether the user has the appropriate permissions to upload anyway
351 $permission = $this->mUpload
->isAllowed( $user );
353 if ( $permission !== true ) {
354 if ( !$user->isLoggedIn() ) {
355 $this->dieUsageMsg( array( 'mustbeloggedin', 'upload' ) );
357 $this->dieUsageMsg( 'badaccess-groups' );
363 * Performs file verification, dies on error.
365 protected function verifyUpload( ) {
366 global $wgFileExtensions;
368 $verification = $this->mUpload
->verifyUpload( );
369 if ( $verification['status'] === UploadBase
::OK
) {
373 // TODO: Move them to ApiBase's message map
374 switch( $verification['status'] ) {
375 // Recoverable errors
376 case UploadBase
::MIN_LENGTH_PARTNAME
:
377 $this->dieRecoverableError( 'filename-tooshort', 'filename' );
379 case UploadBase
::ILLEGAL_FILENAME
:
380 $this->dieRecoverableError( 'illegal-filename', 'filename',
381 array( 'filename' => $verification['filtered'] ) );
383 case UploadBase
::FILENAME_TOO_LONG
:
384 $this->dieRecoverableError( 'filename-toolong', 'filename' );
386 case UploadBase
::FILETYPE_MISSING
:
387 $this->dieRecoverableError( 'filetype-missing', 'filename' );
389 case UploadBase
::WINDOWS_NONASCII_FILENAME
:
390 $this->dieRecoverableError( 'windows-nonascii-filename', 'filename' );
393 // Unrecoverable errors
394 case UploadBase
::EMPTY_FILE
:
395 $this->dieUsage( 'The file you submitted was empty', 'empty-file' );
397 case UploadBase
::FILE_TOO_LARGE
:
398 $this->dieUsage( 'The file you submitted was too large', 'file-too-large' );
401 case UploadBase
::FILETYPE_BADTYPE
:
402 $this->dieUsage( 'This type of file is banned', 'filetype-banned',
404 'filetype' => $verification['finalExt'],
405 'allowed' => $wgFileExtensions
408 case UploadBase
::VERIFICATION_ERROR
:
409 $this->getResult()->setIndexedTagName( $verification['details'], 'detail' );
410 $this->dieUsage( 'This file did not pass file verification', 'verification-error',
411 0, array( 'details' => $verification['details'] ) );
413 case UploadBase
::HOOK_ABORTED
:
414 $this->dieUsage( "The modification you tried to make was aborted by an extension hook",
415 'hookaborted', 0, array( 'error' => $verification['error'] ) );
418 $this->dieUsage( 'An unknown error occurred', 'unknown-error',
419 0, array( 'code' => $verification['status'] ) );
426 * Check warnings if ignorewarnings is not set.
427 * Returns a suitable array for inclusion into API results if there were warnings
428 * Returns the empty array if there were no warnings
432 protected function getApiWarnings() {
435 if ( !$this->mParams
['ignorewarnings'] ) {
436 $warnings = $this->mUpload
->checkWarnings();
438 return $this->transformWarnings( $warnings );
441 protected function transformWarnings( $warnings ) {
444 $result = $this->getResult();
445 $result->setIndexedTagName( $warnings, 'warning' );
447 if ( isset( $warnings['duplicate'] ) ) {
449 foreach ( $warnings['duplicate'] as $dupe ) {
450 $dupes[] = $dupe->getName();
452 $result->setIndexedTagName( $dupes, 'duplicate' );
453 $warnings['duplicate'] = $dupes;
456 if ( isset( $warnings['exists'] ) ) {
457 $warning = $warnings['exists'];
458 unset( $warnings['exists'] );
459 $warnings[$warning['warning']] = $warning['file']->getName();
467 * Perform the actual upload. Returns a suitable result array on success;
472 protected function performUpload() {
473 // Use comment as initial page text by default
474 if ( is_null( $this->mParams
['text'] ) ) {
475 $this->mParams
['text'] = $this->mParams
['comment'];
478 $file = $this->mUpload
->getLocalFile();
479 $watch = $this->getWatchlistValue( $this->mParams
['watchlist'], $file->getTitle() );
481 // Deprecated parameters
482 if ( $this->mParams
['watch'] ) {
486 // No errors, no warnings: do the upload
487 $status = $this->mUpload
->performUpload( $this->mParams
['comment'],
488 $this->mParams
['text'], $watch, $this->getUser() );
490 if ( !$status->isGood() ) {
491 $error = $status->getErrorsArray();
493 if ( count( $error ) == 1 && $error[0][0] == 'async' ) {
494 // The upload can not be performed right now, because the user
497 'result' => 'Queued',
498 'statuskey' => $error[0][1],
501 $this->getResult()->setIndexedTagName( $error, 'error' );
503 $this->dieUsage( 'An internal error occurred', 'internal-error', 0, $error );
507 $file = $this->mUpload
->getLocalFile();
509 $result['result'] = 'Success';
510 $result['filename'] = $file->getName();
516 * Checks if asynchronous copy uploads are enabled and throws an error if they are not.
518 protected function checkAsyncDownloadEnabled() {
519 global $wgAllowAsyncCopyUploads;
520 if ( !$wgAllowAsyncCopyUploads ) {
521 $this->dieUsage( 'Asynchronous copy uploads disabled', 'asynccopyuploaddisabled');
525 public function mustBePosted() {
529 public function isWriteMode() {
533 public function getAllowedParams() {
536 ApiBase
::PARAM_TYPE
=> 'string',
539 ApiBase
::PARAM_DFLT
=> ''
544 ApiBase
::PARAM_DFLT
=> false,
545 ApiBase
::PARAM_DEPRECATED
=> true,
547 'watchlist' => array(
548 ApiBase
::PARAM_DFLT
=> 'preferences',
549 ApiBase
::PARAM_TYPE
=> array(
555 'ignorewarnings' => false,
559 'sessionkey' => array(
560 ApiBase
::PARAM_DFLT
=> null,
561 ApiBase
::PARAM_DEPRECATED
=> true,
569 'asyncdownload' => false,
570 'leavemessage' => false,
577 public function getParamDescription() {
579 'filename' => 'Target filename',
580 'token' => 'Edit token. You can get one of these through prop=info',
581 'comment' => 'Upload comment. Also used as the initial page text for new files if "text" is not specified',
582 'text' => 'Initial page text for new files',
583 'watch' => 'Watch the page',
584 'watchlist' => 'Unconditionally add or remove the page from your watchlist, use preferences or do not change watch',
585 'ignorewarnings' => 'Ignore any warnings',
586 'file' => 'File contents',
587 'url' => 'URL to fetch the file from',
588 'filekey' => 'Key that identifies a previous upload that was stashed temporarily.',
589 'sessionkey' => 'Same as filekey, maintained for backward compatibility.',
590 'stash' => 'If set, the server will not add the file to the repository and stash it temporarily.',
592 'chunk' => 'Chunk contents',
593 'offset' => 'Offset of chunk in bytes',
594 'filesize' => 'Filesize of entire upload',
596 'asyncdownload' => 'Make fetching a URL asynchronous',
597 'leavemessage' => 'If asyncdownload is used, leave a message on the user talk page if finished',
598 'statuskey' => 'Fetch the upload status for this file key',
605 public function getDescription() {
607 'Upload a file, or get the status of pending uploads. Several methods are available:',
608 ' * Upload file contents directly, using the "file" parameter',
609 ' * Have the MediaWiki server fetch a file from a URL, using the "url" parameter',
610 ' * Complete an earlier upload that failed due to warnings, using the "filekey" parameter',
611 'Note that the HTTP POST must be done as a file upload (i.e. using multipart/form-data) when',
612 'sending the "file". Also you must get and send an edit token before doing any upload stuff'
616 public function getPossibleErrors() {
617 return array_merge( parent
::getPossibleErrors(),
618 $this->getRequireOnlyOneParameterErrorMessages( array( 'filekey', 'file', 'url', 'statuskey' ) ),
620 array( 'uploaddisabled' ),
621 array( 'invalid-file-key' ),
622 array( 'uploaddisabled' ),
623 array( 'mustbeloggedin', 'upload' ),
624 array( 'badaccess-groups' ),
625 array( 'code' => 'fetchfileerror', 'info' => '' ),
626 array( 'code' => 'nomodule', 'info' => 'No upload module set' ),
627 array( 'code' => 'empty-file', 'info' => 'The file you submitted was empty' ),
628 array( 'code' => 'filetype-missing', 'info' => 'The file is missing an extension' ),
629 array( 'code' => 'filename-tooshort', 'info' => 'The filename is too short' ),
630 array( 'code' => 'overwrite', 'info' => 'Overwriting an existing file is not allowed' ),
631 array( 'code' => 'stashfailed', 'info' => 'Stashing temporary file failed' ),
632 array( 'code' => 'internal-error', 'info' => 'An internal error occurred' ),
633 array( 'code' => 'asynccopyuploaddisabled', 'info' => 'Asynchronous copy uploads disabled' ),
638 public function needsToken() {
642 public function getTokenSalt() {
646 public function getExamples() {
648 'api.php?action=upload&filename=Wiki.png&url=http%3A//upload.wikimedia.org/wikipedia/en/b/bc/Wiki.png'
649 => 'Upload from a URL',
650 'api.php?action=upload&filename=Wiki.png&filekey=filekey&ignorewarnings=1'
651 => 'Complete an upload that failed due to warnings',
655 public function getHelpUrls() {
656 return 'https://www.mediawiki.org/wiki/API:Upload';
659 public function getVersion() {
660 return __CLASS__
. ': $Id$';