safebox/guacamole-client
4
0
Fork 0
mirror of https://github.com/gyurix1968/guacamole-client.git synced 2025-09-06 05:07:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

GUACAMOLE-44: Merge change to use REST endpoint for upload/download.

Browse Source
This commit is contained in:
James Muehlner
2016-06-09 21:31:43 -07:00
parent 248c47584e 0b6faba258
commit 6f1eaf10a6
6 changed files with 51 additions and 241 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
guacamole/src/main/webapp/app/client/controllers/clientController.js
View File

@@ -755,7 +755,7 @@ angular.module('client').controller('clientController', ['$scope', '$routeParams
if (!$scope.client)
return false;
return !!($scope.client.uploads.length || $scope.client.downloads.length);
return !!$scope.client.uploads.length;
};

5
guacamole/src/main/webapp/app/client/directives/guacFileTransferManager.js
View File

@@ -83,11 +83,6 @@ angular.module('client').directive('guacFileTransferManager', [function guacFile
return isInProgress(upload.transferState);
});
// Remove completed downloads
$scope.client.downloads = $scope.client.downloads.filter(function isDownloadInProgress(download) {
return isInProgress(download.transferState);
});
};
}]

17
guacamole/src/main/webapp/app/client/types/ManagedClient.js
View File

@@ -28,7 +28,6 @@ angular.module('client').factory('ManagedClient', ['$rootScope', '$injector',
var ClientIdentifier = $injector.get('ClientIdentifier');
var ManagedClientState = $injector.get('ManagedClientState');
var ManagedDisplay = $injector.get('ManagedDisplay');
var ManagedFileDownload = $injector.get('ManagedFileDownload');
var ManagedFilesystem = $injector.get('ManagedFilesystem');
var ManagedFileUpload = $injector.get('ManagedFileUpload');
@@ -41,6 +40,7 @@ angular.module('client').factory('ManagedClient', ['$rootScope', '$injector',
var clipboardService = $injector.get('clipboardService');
var connectionGroupService = $injector.get('connectionGroupService');
var connectionService = $injector.get('connectionService');
var tunnelService = $injector.get('tunnelService');
var guacAudio = $injector.get('guacAudio');
var guacHistory = $injector.get('guacHistory');
var guacImage = $injector.get('guacImage');
@@ -104,15 +104,6 @@ angular.module('client').factory('ManagedClient', ['$rootScope', '$injector',
*/
this.clipboardData = template.clipboardData || '';
/**
* All downloaded files. As files are downloaded, their progress can be
* observed through the elements of this array. It is intended that
* this array be manipulated externally as needed.
*
* @type ManagedFileDownload[]
*/
this.downloads = template.downloads || [];
/**
* All uploaded files. As files are uploaded, their progress can be
* observed through the elements of this array. It is intended that
@@ -453,9 +444,7 @@ angular.module('client').factory('ManagedClient', ['$rootScope', '$injector',
// Handle any received files
client.onfile = function clientFileReceived(stream, mimetype, filename) {
$rootScope.$apply(function startDownload() {
managedClient.downloads.push(ManagedFileDownload.getInstance(stream, mimetype, filename));
});
tunnelService.downloadStream(tunnel.uuid, stream, mimetype, filename);
};
// Handle any received filesystem objects
@@ -530,7 +519,7 @@ angular.module('client').factory('ManagedClient', ['$rootScope', '$injector',
}
// Start and manage file upload
managedClient.uploads.push(ManagedFileUpload.getInstance(managedClient.client, file, object, streamName));
managedClient.uploads.push(ManagedFileUpload.getInstance(managedClient, file, object, streamName));
};

153
guacamole/src/main/webapp/app/client/types/ManagedFileDownload.js
View File

@@ -1,153 +0,0 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/**
* Provides the ManagedFileDownload class used by the guacClientManager service.
*/
angular.module('client').factory('ManagedFileDownload', ['$rootScope', '$injector',
function defineManagedFileDownload($rootScope, $injector) {
// Required types
var ManagedFileTransferState = $injector.get('ManagedFileTransferState');
/**
* Object which serves as a surrogate interface, encapsulating a Guacamole
* file download while it is active, allowing it to be detached and
* reattached from different client views.
*
* @constructor
* @param {ManagedFileDownload|Object} [template={}]
* The object whose properties should be copied within the new
* ManagedFileDownload.
*/
var ManagedFileDownload = function ManagedFileDownload(template) {
// Use empty object by default
template = template || {};
/**
* The current state of the file transfer stream.
*
* @type ManagedFileTransferState
*/
this.transferState = template.transferState || new ManagedFileTransferState();
/**
* The mimetype of the file being transferred.
*
* @type String
*/
this.mimetype = template.mimetype;
/**
* The filename of the file being transferred.
*
* @type String
*/
this.filename = template.filename;
/**
* The number of bytes transferred so far.
*
* @type Number
*/
this.progress = template.progress;
/**
* A blob containing the complete downloaded file. This is available
* only after the download has finished.
*
* @type Blob
*/
this.blob = template.blob;
};
/**
* Creates a new ManagedFileDownload which downloads the contents of the
* given stream as a file having the given mimetype and filename.
*
* @param {Guacamole.InputStream} stream
* The stream whose contents should be downloaded as a file.
*
* @param {String} mimetype
* The mimetype of the stream contents.
*
* @param {String} filename
* The filename of the file being received over the steram.
*
* @return {ManagedFileDownload}
* A new ManagedFileDownload object which can be used to track the
* progress of the download.
*/
ManagedFileDownload.getInstance = function getInstance(stream, mimetype, filename) {
// Init new file download object
var managedFileDownload = new ManagedFileDownload({
mimetype : mimetype,
filename : filename,
progress : 0,
transferState : new ManagedFileTransferState({
streamState : ManagedFileTransferState.StreamState.OPEN
})
});
// Begin file download
var blob_reader = new Guacamole.BlobReader(stream, mimetype);
// Update progress as data is received
blob_reader.onprogress = function onprogress() {
// Update progress
$rootScope.$apply(function downloadStreamProgress() {
managedFileDownload.progress = blob_reader.getLength();
});
// Signal server that data was received
stream.sendAck("Received", Guacamole.Status.Code.SUCCESS);
};
// Save blob and close stream when complete
blob_reader.onend = function onend() {
$rootScope.$apply(function downloadStreamEnd() {
// Save blob
managedFileDownload.blob = blob_reader.getBlob();
// Mark stream as closed
ManagedFileTransferState.setStreamState(managedFileDownload.transferState,
ManagedFileTransferState.StreamState.CLOSED);
// Notify of upload completion
$rootScope.$broadcast('guacDownloadComplete', filename);
});
};
// Signal server that data is ready to be received
stream.sendAck("Ready", Guacamole.Status.Code.SUCCESS);
return managedFileDownload;
};
return ManagedFileDownload;
}]);

100
guacamole/src/main/webapp/app/client/types/ManagedFileUpload.js
View File

@@ -24,10 +24,11 @@ angular.module('client').factory('ManagedFileUpload', ['$rootScope', '$injector'
function defineManagedFileUpload($rootScope, $injector) {
// Required types
var Error = $injector.get('Error');
var ManagedFileTransferState = $injector.get('ManagedFileTransferState');
// Required services
var $window = $injector.get('$window');
var tunnelService = $injector.get('tunnelService');
/**
* Object which serves as a surrogate interface, encapsulating a Guacamole
@@ -81,32 +82,12 @@ angular.module('client').factory('ManagedFileUpload', ['$rootScope', '$injector'
};
/**
* Converts the given bytes to a base64-encoded string.
*
* @param {Uint8Array} bytes A Uint8Array which contains the data to be
* encoded as base64.
* @return {String} The base64-encoded string.
*/
var getBase64 = function getBase64(bytes) {
var data = "";
// Produce binary string from bytes in buffer
for (var i=0; i<bytes.byteLength; i++)
data += String.fromCharCode(bytes[i]);
// Convert to base64
return $window.btoa(data);
};
/**
* Creates a new ManagedFileUpload which uploads the given file to the
* server through the given Guacamole client.
*
* @param {Guacamole.Client} client
* The Guacamole client through which the file is to be uploaded.
* @param {ManagedClient} managedClient
* The ManagedClient through which the file is to be uploaded.
*
* @param {File} file
* The file to upload.
@@ -123,10 +104,13 @@ angular.module('client').factory('ManagedFileUpload', ['$rootScope', '$injector'
* A new ManagedFileUpload object which can be used to track the
* progress of the upload.
*/
ManagedFileUpload.getInstance = function getInstance(client, file, object, streamName) {
ManagedFileUpload.getInstance = function getInstance(managedClient, file, object, streamName) {
var managedFileUpload = new ManagedFileUpload();
var streamAcknowledged = false;
// Pull Guacamole.Tunnel and Guacamole.Client from given ManagedClient
var client = managedClient.client;
var tunnel = managedClient.tunnel;
// Open file for writing
var stream;
@@ -153,10 +137,8 @@ angular.module('client').factory('ManagedFileUpload', ['$rootScope', '$injector'
});
var writer = new Guacamole.FileWriter(stream);
// Begin upload when stream is acknowledged, notify of any errors
writer.onack = function ackReceived(status) {
// Upload file once stream is acknowledged
stream.onack = function beginUpload(status) {
// Notify of any errors from the Guacamole server
if (status.isError()) {
@@ -165,51 +147,49 @@ angular.module('client').factory('ManagedFileUpload', ['$rootScope', '$injector'
ManagedFileTransferState.StreamState.ERROR,
status.code);
});
return;
}
// Begin sending the requested file once stream is acknowledged
else if (!streamAcknowledged) {
writer.sendFile(file);
streamAcknowledged = true;
}
};
// Abort and notify if the file cannot be read
writer.onerror = function fileReadError(file, offset, error) {
// Abort transfer
writer.sendEnd();
// Upload failed
ManagedFileTransferState.setStreamState(managedFileUpload.transferState,
ManagedFileTransferState.StreamState.ERROR);
};
// Notify of upload progress
writer.onprogress = function uploadProgressing(file, length) {
// Begin upload
tunnelService.uploadToStream(tunnel.uuid, stream, file, function uploadContinuing(length) {
$rootScope.$apply(function uploadStreamProgress() {
managedFileUpload.progress = length;
});
})
};
// Clean up and notify when upload completes
writer.oncomplete = function uploadComplete(file) {
// If at end, stop upload
writer.sendEnd();
managedFileUpload.progress = file.size;
// Notify if upload succeeds
.then(function uploadSuccessful() {
// Upload complete
managedFileUpload.progress = file.size;
ManagedFileTransferState.setStreamState(managedFileUpload.transferState,
ManagedFileTransferState.StreamState.CLOSED);
// Notify of upload completion
$rootScope.$broadcast('guacUploadComplete', file.name);
},
// Notify if upload fails
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,
ManagedFileTransferState.StreamState.ERROR,
error.statusCode);
// Fail with internal error for all other causes
else
ManagedFileTransferState.setStreamState(managedFileUpload.transferState,
ManagedFileTransferState.StreamState.ERROR,
Guacamole.Status.Code.INTERNAL_ERROR);
});
// Ignore all further acks
stream.onack = null;
};
return managedFileUpload;

11
guacamole/src/main/webapp/app/client/types/ManagedFilesystem.js
View File

@@ -25,8 +25,7 @@ angular.module('client').factory('ManagedFilesystem', ['$rootScope', '$injector'
function defineManagedFilesystem($rootScope, $injector) {
// Required types
var ManagedFileDownload = $injector.get('ManagedFileDownload');
var ManagedFileUpload = $injector.get('ManagedFileUpload');
var tunnelService = $injector.get('tunnelService');
/**
* Object which serves as a surrogate interface, encapsulating a Guacamole
@@ -194,8 +193,8 @@ angular.module('client').factory('ManagedFilesystem', ['$rootScope', '$injector'
/**
* Downloads the given file from the server using the given Guacamole
* client and filesystem. The file transfer can be monitored through the
* corresponding entry in the downloads array of the given ManagedClient.
* client and filesystem. The browser will automatically start the
* download upon completion of this function.
*
* @param {ManagedClient} managedClient
* The ManagedClient from which the file is to be downloaded.
@@ -215,8 +214,8 @@ angular.module('client').factory('ManagedFilesystem', ['$rootScope', '$injector'
// Parse filename from string
var filename = path.match(/(.*[\\/])?(.*)/)[2];
// Start and track download
managedClient.downloads.push(ManagedFileDownload.getInstance(stream, mimetype, filename));
// Start download
tunnelService.downloadStream(managedClient.tunnel.uuid, stream, mimetype, filename);
});