$this->dieUsage( 'No upload module set', 'nomodule' );
}
} catch ( UploadStashException $e ) { // XXX: don't spam exception log
- $this->handleStashException( $e );
+ list( $msg, $code ) = $this->handleStashException( get_class( $e ), $e->getMessage() );
+ $this->dieUsage( $msg, $code );
}
// First check permission to upload
// Get the result based on the current upload context:
try {
$result = $this->getContextResult();
- if ( $result['result'] === 'Success' ) {
- $result['imageinfo'] = $this->mUpload->getImageInfo( $this->getResult() );
- }
} catch ( UploadStashException $e ) { // XXX: don't spam exception log
- $this->handleStashException( $e );
+ list( $msg, $code ) = $this->handleStashException( get_class( $e ), $e->getMessage() );
+ $this->dieUsage( $msg, $code );
}
-
$this->getResult()->addValue( null, $this->getModuleName(), $result );
+ // Add 'imageinfo' in a separate addValue() call. File metadata can be unreasonably large,
+ // so otherwise when it exceeded $wgAPIMaxResultSize, no result would be returned (T143993).
+ if ( $result['result'] === 'Success' ) {
+ $imageinfo = $this->mUpload->getImageInfo( $this->getResult() );
+ $this->getResult()->addValue( $this->getModuleName(), 'imageinfo', $imageinfo );
+ }
+
// Cleanup any temporary mess
$this->mUpload->cleanupTempFile();
}
*/
private function getStashResult( $warnings ) {
$result = [];
+ $result['result'] = 'Success';
+ if ( $warnings && count( $warnings ) > 0 ) {
+ $result['warnings'] = $warnings;
+ }
// Some uploads can request they be stashed, so as not to publish them immediately.
// In this case, a failure to stash ought to be fatal
- try {
- $result['result'] = 'Success';
- $result['filekey'] = $this->performStash();
- $result['sessionkey'] = $result['filekey']; // backwards compatibility
- if ( $warnings && count( $warnings ) > 0 ) {
- $result['warnings'] = $warnings;
- }
- } catch ( UploadStashException $e ) {
- $this->handleStashException( $e );
- } catch ( Exception $e ) {
- $this->dieUsage( $e->getMessage(), 'stashfailed' );
- }
+ $this->performStash( 'critical', $result );
return $result;
}
$result['warnings'] = $warnings;
// in case the warnings can be fixed with some further user action, let's stash this upload
// and return a key they can use to restart it
- try {
- $result['filekey'] = $this->performStash();
- $result['sessionkey'] = $result['filekey']; // backwards compatibility
- } catch ( Exception $e ) {
- $result['warnings']['stashfailed'] = $e->getMessage();
- }
+ $this->performStash( 'optional', $result );
return $result;
}
}
if ( $this->mParams['offset'] == 0 ) {
- try {
- $filekey = $this->performStash();
- } catch ( UploadStashException $e ) {
- $this->handleStashException( $e );
- } catch ( Exception $e ) {
- // FIXME: Error handling here is wrong/different from rest of this
- $this->dieUsage( $e->getMessage(), 'stashfailed' );
- }
+ $filekey = $this->performStash( 'critical' );
} else {
$filekey = $this->mParams['filekey'];
'offset' => $this->mUpload->getOffset(),
];
- $this->dieUsage( $status->getWikiText( false, false, 'en' ), 'stashfailed', 0, $extradata );
+ $this->dieStatusWithCode( $status, 'stashfailed', $extradata );
}
}
$filekey,
[ 'result' => 'Failure', 'stage' => 'assembling', 'status' => $status ]
);
- $this->dieUsage( $status->getWikiText( false, false, 'en' ), 'stashfailed' );
+ $this->dieStatusWithCode( $status, 'stashfailed' );
+ }
+
+ // We can only get warnings like 'duplicate' after concatenating the chunks
+ $warnings = $this->getApiWarnings();
+ if ( $warnings ) {
+ $result['warnings'] = $warnings;
}
// The fully concatenated file has a new filekey. So remove
// the old filekey and fetch the new one.
UploadBase::setSessionStatus( $this->getUser(), $filekey, false );
$this->mUpload->stash->removeFile( $filekey );
- $filekey = $this->mUpload->getLocalFile()->getFileKey();
+ $filekey = $this->mUpload->getStashFile()->getFileKey();
$result['result'] = 'Success';
}
}
/**
- * Stash the file and return the file key
- * Also re-raises exceptions with slightly more informative message strings (useful for API)
- * @throws MWException
- * @return string File key
+ * Stash the file and add the file key, or error information if it fails, to the data.
+ *
+ * @param string $failureMode What to do on failure to stash:
+ * - When 'critical', use dieStatus() to produce an error response and throw an exception.
+ * Use this when stashing the file was the primary purpose of the API request.
+ * - When 'optional', only add a 'stashfailed' key to the data and return null.
+ * Use this when some error happened for a non-stash upload and we're stashing the file
+ * only to save the client the trouble of re-uploading it.
+ * @param array &$data API result to which to add the information
+ * @return string|null File key
*/
- private function performStash() {
+ private function performStash( $failureMode, &$data = null ) {
+ $isPartial = (bool)$this->mParams['chunk'];
try {
- $stashFile = $this->mUpload->stashFile( $this->getUser() );
+ $status = $this->mUpload->tryStashFile( $this->getUser(), $isPartial );
- if ( !$stashFile ) {
- throw new MWException( 'Invalid stashed file' );
+ if ( $status->isGood() && !$status->getValue() ) {
+ // Not actually a 'good' status...
+ $status->fatal( new ApiRawMessage( 'Invalid stashed file', 'stashfailed' ) );
}
- $fileKey = $stashFile->getFileKey();
} catch ( Exception $e ) {
- $message = 'Stashing temporary file failed: ' . get_class( $e ) . ' ' . $e->getMessage();
- wfDebug( __METHOD__ . ' ' . $message . "\n" );
- $className = get_class( $e );
- throw new $className( $message );
+ $debugMessage = 'Stashing temporary file failed: ' . get_class( $e ) . ' ' . $e->getMessage();
+ wfDebug( __METHOD__ . ' ' . $debugMessage . "\n" );
+ $status = Status::newFatal( new ApiRawMessage( $e->getMessage(), 'stashfailed' ) );
+ }
+
+ if ( $status->isGood() ) {
+ $stashFile = $status->getValue();
+ $data['filekey'] = $stashFile->getFileKey();
+ // Backwards compatibility
+ $data['sessionkey'] = $data['filekey'];
+ return $data['filekey'];
+ }
+
+ if ( $status->getMessage()->getKey() === 'uploadstash-exception' ) {
+ // The exceptions thrown by upload stash code and pretty silly and UploadBase returns poor
+ // Statuses for it. Just extract the exception details and parse them ourselves.
+ list( $exceptionType, $message ) = $status->getMessage()->getParams();
+ $debugMessage = 'Stashing temporary file failed: ' . $exceptionType . ' ' . $message;
+ wfDebug( __METHOD__ . ' ' . $debugMessage . "\n" );
+ list( $msg, $code ) = $this->handleStashException( $exceptionType, $message );
+ $status = Status::newFatal( new ApiRawMessage( $msg, $code ) );
}
- return $fileKey;
+ // Bad status
+ if ( $failureMode !== 'optional' ) {
+ $this->dieStatus( $status );
+ } else {
+ list( $code, $msg ) = $this->getErrorFromStatus( $status );
+ $data['stashfailed'] = $msg;
+ return null;
+ }
}
/**
* @throws UsageException
*/
private function dieRecoverableError( $error, $parameter, $data = [], $code = 'unknownerror' ) {
- try {
- $data['filekey'] = $this->performStash();
- $data['sessionkey'] = $data['filekey'];
- } catch ( Exception $e ) {
- $data['stashfailed'] = $e->getMessage();
- }
+ $this->performStash( 'optional', $data );
$data['invalidparameter'] = $parameter;
$parsed = $this->parseMsg( $error );
$this->dieUsage( $parsed['info'], $parsed['code'], 0, $data );
}
+ /**
+ * Like dieStatus(), but always uses $overrideCode for the error code, unless the code comes from
+ * IApiMessage.
+ *
+ * @param Status $status
+ * @param string $overrideCode Error code to use if there isn't one from IApiMessage
+ * @param array|null $moreExtraData
+ * @throws UsageException
+ */
+ public function dieStatusWithCode( $status, $overrideCode, $moreExtraData = null ) {
+ $extraData = null;
+ list( $code, $msg ) = $this->getErrorFromStatus( $status, $extraData );
+ $errors = $status->getErrorsByType( 'error' ) ?: $status->getErrorsByType( 'warning' );
+ if ( !( $errors[0]['message'] instanceof IApiMessage ) ) {
+ $code = $overrideCode;
+ }
+ if ( $moreExtraData ) {
+ $extraData = $extraData ?: [];
+ $extraData += $moreExtraData;
+ }
+ $this->dieUsage( $msg, $code, 0, $extraData );
+ }
+
/**
* Select an upload module and set it to mUpload. Dies on failure. If the
* request was a status request and not a true upload, returns false;
if ( !$progress ) {
$this->dieUsage( 'No result in status data', 'missingresult' );
} elseif ( !$progress['status']->isGood() ) {
- $this->dieUsage( $progress['status']->getWikiText( false, false, 'en' ), 'stashfailed' );
+ $this->dieStatusWithCode( $progress['status'], 'stashfailed' );
}
if ( isset( $progress['status']->value['verification'] ) ) {
$this->checkVerification( $progress['status']->value['verification'] );
}
+ if ( isset( $progress['status']->value['warnings'] ) ) {
+ $warnings = $this->transformWarnings( $progress['status']->value['warnings'] );
+ if ( $warnings ) {
+ $progress['warnings'] = $warnings;
+ }
+ }
unset( $progress['status'] ); // remove Status object
+ $imageinfo = null;
+ if ( isset( $progress['imageinfo'] ) ) {
+ $imageinfo = $progress['imageinfo'];
+ unset( $progress['imageinfo'] );
+ }
+
$this->getResult()->addValue( null, $this->getModuleName(), $progress );
+ // Add 'imageinfo' in a separate addValue() call. File metadata can be unreasonably large,
+ // so otherwise when it exceeded $wgAPIMaxResultSize, no result would be returned (T143993).
+ if ( $imageinfo ) {
+ $this->getResult()->addValue( $this->getModuleName(), 'imageinfo', $imageinfo );
+ }
return false;
}
if ( $this->mParams['chunk'] ) {
// Chunk upload
- $this->mUpload = new UploadFromChunks();
+ $this->mUpload = new UploadFromChunks( $this->getUser() );
if ( isset( $this->mParams['filekey'] ) ) {
if ( $this->mParams['offset'] === 0 ) {
$this->dieUsage( 'Cannot supply a filekey when offset is 0', 'badparams' );
/**
* Handles a stash exception, giving a useful error to the user.
- * @param Exception $e The exception we encountered.
+ * @param string $exceptionType Class name of the exception we encountered.
+ * @param string $message Message of the exception we encountered.
+ * @return array Array of message and code, suitable for passing to dieUsage()
*/
- protected function handleStashException( $e ) {
- $exceptionType = get_class( $e );
-
+ protected function handleStashException( $exceptionType, $message ) {
switch ( $exceptionType ) {
case 'UploadStashFileNotFoundException':
- $this->dieUsage(
- 'Could not find the file in the stash: ' . $e->getMessage(),
+ return [
+ 'Could not find the file in the stash: ' . $message,
'stashedfilenotfound'
- );
- break;
+ ];
case 'UploadStashBadPathException':
- $this->dieUsage(
- 'File key of improper format or otherwise invalid: ' . $e->getMessage(),
+ return [
+ 'File key of improper format or otherwise invalid: ' . $message,
'stashpathinvalid'
- );
- break;
+ ];
case 'UploadStashFileException':
- $this->dieUsage(
- 'Could not store upload in the stash: ' . $e->getMessage(),
+ return [
+ 'Could not store upload in the stash: ' . $message,
'stashfilestorage'
- );
- break;
+ ];
case 'UploadStashZeroLengthFileException':
- $this->dieUsage(
+ return [
'File is of zero length, and could not be stored in the stash: ' .
- $e->getMessage(),
+ $message,
'stashzerolength'
- );
- break;
+ ];
case 'UploadStashNotLoggedInException':
- $this->dieUsage( 'Not logged in: ' . $e->getMessage(), 'stashnotloggedin' );
- break;
+ return [ 'Not logged in: ' . $message, 'stashnotloggedin' ];
case 'UploadStashWrongOwnerException':
- $this->dieUsage( 'Wrong owner: ' . $e->getMessage(), 'stashwrongowner' );
- break;
+ return [ 'Wrong owner: ' . $message, 'stashwrongowner' ];
case 'UploadStashNoSuchKeyException':
- $this->dieUsage( 'No such filekey: ' . $e->getMessage(), 'stashnosuchfilekey' );
- break;
+ return [ 'No such filekey: ' . $message, 'stashnosuchfilekey' ];
default:
- $this->dieUsage( $exceptionType . ': ' . $e->getMessage(), 'stasherror' );
- break;
+ return [ $exceptionType . ': ' . $message, 'stasherror' ];
}
}
$this->mParams['text'] = $this->mParams['comment'];
}
- /** @var $file File */
+ /** @var $file LocalFile */
$file = $this->mUpload->getLocalFile();
// For preferences mode, we want to watch if 'watchdefault' is set,
dépôts / lhc / web / wiklou.git / blobdiff