GUACAMOLE-1320: Merge support for chunked file uploads.

This commit is contained in:
Mike Jumper
2022-07-29 22:12:29 -07:00
committed by GitHub
3 changed files with 107 additions and 42 deletions

View File

@@ -163,17 +163,19 @@ angular.module('client').factory('ManagedFileUpload', ['$rootScope', '$injector'
// Upload complete
managedFileUpload.progress = file.size;
// Close the stream
stream.sendEnd();
ManagedFileTransferState.setStreamState(managedFileUpload.transferState,
ManagedFileTransferState.StreamState.CLOSED);
// Notify of upload completion
$rootScope.$broadcast('guacUploadComplete', file.name);
},
// Notify if upload fails
requestService.createErrorCallback(function uploadFailed(error) {
// Use provide status code if the error is coming from the stream
if (error.type === Error.Type.STREAM_ERROR)
ManagedFileTransferState.setStreamState(managedFileUpload.transferState,
@@ -185,11 +187,15 @@ angular.module('client').factory('ManagedFileUpload', ['$rootScope', '$injector'
ManagedFileTransferState.setStreamState(managedFileUpload.transferState,
ManagedFileTransferState.StreamState.ERROR,
Guacamole.Status.Code.INTERNAL_ERROR);
// Close the stream
stream.sendEnd();
}));
// Ignore all further acks
stream.onack = null;
};

View File

@@ -54,6 +54,15 @@ angular.module('rest').factory('tunnelService', ['$injector',
*/
var DOWNLOAD_CLEANUP_WAIT = 5000;
/**
* The maximum size a chunk may be during uploadToStream() in bytes.
*
* @private
* @constant
* @type Number
*/
const CHUNK_SIZE = 1024 * 1024 * 4;
/**
* Makes a request to the REST API to get the list of all tunnels
* associated with in-progress connections, returning a promise that
@@ -301,51 +310,103 @@ angular.module('rest').factory('tunnelService', ['$injector',
+ '/' + encodeURIComponent(sanitizeFilename(file.name))
+ '?token=' + encodeURIComponent(authenticationService.getCurrentToken());
var xhr = new XMLHttpRequest();
/**
* Creates a chunk of the inputted file to be uploaded.
*
* @param {Number} offset
* The byte at which to begin the chunk.
*
* @return {File}
* The file chunk created by this function.
*/
const createChunk = (offset) => {
var chunkEnd = Math.min(offset + CHUNK_SIZE, file.size);
const chunk = file.slice(offset, chunkEnd);
return chunk;
};
// Invoke provided callback if upload tracking is supported
if (progressCallback && xhr.upload) {
xhr.upload.addEventListener('progress', function updateProgress(e) {
progressCallback(e.loaded);
});
}
/**
* POSTs the inputted chunks and recursively calls uploadHandler()
* until the upload is complete.
*
* @param {File} chunk
* The chunk to be uploaded to the stream.
*
* @param {Number} offset
* The byte at which the inputted chunk begins.
*/
const uploadChunk = (chunk, offset) => {
var xhr = new XMLHttpRequest();
xhr.open('POST', url, true);
// Resolve/reject promise once upload has stopped
xhr.onreadystatechange = function uploadStatusChanged() {
// Invoke provided callback if upload tracking is supported.
if (progressCallback && xhr.upload) {
xhr.upload.addEventListener('progress', function updateProgress(e) {
progressCallback(e.loaded + offset);
});
};
// Ignore state changes prior to completion
if (xhr.readyState !== 4)
return;
// Continue to next chunk, resolve, or reject promise as appropriate
// once upload has stopped
xhr.onreadystatechange = function uploadStatusChanged() {
// Resolve if HTTP status code indicates success
if (xhr.status >= 200 && xhr.status < 300)
deferred.resolve();
// Ignore state changes prior to completion.
if (xhr.readyState !== 4)
return;
// Parse and reject with resulting JSON error
else if (xhr.getResponseHeader('Content-Type') === 'application/json')
deferred.reject(new Error(angular.fromJson(xhr.responseText)));
// Resolve if last chunk or begin next chunk if HTTP status
// code indicates success.
if (xhr.status >= 200 && xhr.status < 300) {
offset += CHUNK_SIZE;
// Warn of lack of permission of a proxy rejects the upload
else if (xhr.status >= 400 && xhr.status < 500)
deferred.reject(new Error({
'type' : Error.Type.STREAM_ERROR,
'statusCode' : Guacamole.Status.Code.CLIENT_FORBIDDEN,
'message' : 'HTTP ' + xhr.status
}));
if (offset < file.size)
uploadHandler(offset);
else
deferred.resolve();
}
// Assume internal error for all other cases
else
deferred.reject(new Error({
'type' : Error.Type.STREAM_ERROR,
'statusCode' : Guacamole.Status.Code.INTERNAL_ERROR,
'message' : 'HTTP ' + xhr.status
}));
// Parse and reject with resulting JSON error
else if (xhr.getResponseHeader('Content-Type') === 'application/json')
deferred.reject(new Error(angular.fromJson(xhr.responseText)));
// Warn of lack of permission of a proxy rejects the upload
else if (xhr.status >= 400 && xhr.status < 500)
deferred.reject(new Error({
'type': Error.Type.STREAM_ERROR,
'statusCode': Guacamole.Status.Code.CLIENT_FORBIDDEN,
'message': 'HTTP ' + xhr.status
}));
// Assume internal error for all other cases
else
deferred.reject(new Error({
'type': Error.Type.STREAM_ERROR,
'statusCode': Guacamole.Status.Code.INTERNAL_ERROR,
'message': 'HTTP ' + xhr.status
}));
};
// Perform upload
xhr.send(chunk);
};
// Perform upload
xhr.open('POST', url, true);
xhr.send(file);
/**
* Handles the recursive upload process. Each time it is called, a
* chunk is made with createChunk(), starting at the offset parameter.
* The chunk is then sent by uploadChunk(), which recursively calls
* this handler until the upload process is either completed and the
* promise is resolved, or fails and the promise is rejected.
*
* @param {Number} offset
* The byte at which to begin the chunk.
*/
const uploadHandler = (offset) => {
uploadChunk(createChunk(offset), offset);
};
uploadHandler(0);
return deferred.promise;

View File

@@ -94,8 +94,7 @@ public class InputStreamInterceptingFilter
/**
* Reads the next chunk of data from the InputStream associated with an
* intercepted stream, sending that data as a "blob" instruction over the
* GuacamoleTunnel associated with this filter. If the end of the
* InputStream is reached, an "end" instruction will automatically be sent.
* GuacamoleTunnel associated with this filter.
*
* @param stream
* The stream from which the next chunk of data should be read.
@@ -112,9 +111,8 @@ public class InputStreamInterceptingFilter
// End stream if no more data
if (length == -1) {
// Close stream, send end if the stream is still valid
if (closeInterceptedStream(stream))
sendEnd(stream.getIndex());
// Close stream
closeInterceptedStream(stream);
return;