From 4059054d31fddc8b7c7f7632eb5b991966ff74aa Mon Sep 17 00:00:00 2001 From: Michael Jumper Date: Wed, 6 Apr 2016 22:37:15 -0700 Subject: [PATCH 1/3] GUACAMOLE-44: Replace use of ManagedFileDownload with calls to the tunnel REST service. --- .../client/controllers/clientController.js | 2 +- .../directives/guacFileTransferManager.js | 5 - .../webapp/app/client/types/ManagedClient.js | 15 +- .../app/client/types/ManagedFileDownload.js | 153 ------------------ .../app/client/types/ManagedFilesystem.js | 11 +- 5 files changed, 8 insertions(+), 178 deletions(-) delete mode 100644 guacamole/src/main/webapp/app/client/types/ManagedFileDownload.js diff --git a/guacamole/src/main/webapp/app/client/controllers/clientController.js b/guacamole/src/main/webapp/app/client/controllers/clientController.js index 0c7145a88..daa782229 100644 --- a/guacamole/src/main/webapp/app/client/controllers/clientController.js +++ b/guacamole/src/main/webapp/app/client/controllers/clientController.js @@ -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; }; diff --git a/guacamole/src/main/webapp/app/client/directives/guacFileTransferManager.js b/guacamole/src/main/webapp/app/client/directives/guacFileTransferManager.js index ac810d04c..002494865 100644 --- a/guacamole/src/main/webapp/app/client/directives/guacFileTransferManager.js +++ b/guacamole/src/main/webapp/app/client/directives/guacFileTransferManager.js @@ -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); - }); - }; }] diff --git a/guacamole/src/main/webapp/app/client/types/ManagedClient.js b/guacamole/src/main/webapp/app/client/types/ManagedClient.js index 9a3ffb1c4..128cf904d 100644 --- a/guacamole/src/main/webapp/app/client/types/ManagedClient.js +++ b/guacamole/src/main/webapp/app/client/types/ManagedClient.js @@ -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 diff --git a/guacamole/src/main/webapp/app/client/types/ManagedFileDownload.js b/guacamole/src/main/webapp/app/client/types/ManagedFileDownload.js deleted file mode 100644 index 35f683b1f..000000000 --- a/guacamole/src/main/webapp/app/client/types/ManagedFileDownload.js +++ /dev/null @@ -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; - -}]); \ No newline at end of file diff --git a/guacamole/src/main/webapp/app/client/types/ManagedFilesystem.js b/guacamole/src/main/webapp/app/client/types/ManagedFilesystem.js index 4b49aeb9e..7bd45096d 100644 --- a/guacamole/src/main/webapp/app/client/types/ManagedFilesystem.js +++ b/guacamole/src/main/webapp/app/client/types/ManagedFilesystem.js @@ -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); }); From f207b29cc6480c8d2aeaa3be39f5c1594858dbbb Mon Sep 17 00:00:00 2001 From: Michael Jumper Date: Sun, 5 Jun 2016 16:16:53 -0700 Subject: [PATCH 2/3] GUACAMOLE-44: Use tunnel REST service for file uploads. --- .../webapp/app/client/types/ManagedClient.js | 2 +- .../app/client/types/ManagedFileUpload.js | 85 ++++++++++--------- 2 files changed, 44 insertions(+), 43 deletions(-) diff --git a/guacamole/src/main/webapp/app/client/types/ManagedClient.js b/guacamole/src/main/webapp/app/client/types/ManagedClient.js index 128cf904d..9a2870687 100644 --- a/guacamole/src/main/webapp/app/client/types/ManagedClient.js +++ b/guacamole/src/main/webapp/app/client/types/ManagedClient.js @@ -519,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)); }; diff --git a/guacamole/src/main/webapp/app/client/types/ManagedFileUpload.js b/guacamole/src/main/webapp/app/client/types/ManagedFileUpload.js index 7fe4f3579..06fabbb14 100644 --- a/guacamole/src/main/webapp/app/client/types/ManagedFileUpload.js +++ b/guacamole/src/main/webapp/app/client/types/ManagedFileUpload.js @@ -24,10 +24,12 @@ 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 $window = $injector.get('$window'); + var tunnelService = $injector.get('tunnelService'); /** * Object which serves as a surrogate interface, encapsulating a Guacamole @@ -105,8 +107,8 @@ angular.module('client').factory('ManagedFileUpload', ['$rootScope', '$injector' * 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 +125,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 +158,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,50 +168,48 @@ 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; - } + // Begin upload + tunnelService.uploadToStream(tunnel.uuid, stream, file, function uploadContinuing(length) { + $rootScope.$apply(function uploadStreamProgress() { + managedFileUpload.progress = length; + }); + }) - }; + // Notify if upload succeeds + .then(function uploadSuccessful() { - // Abort and notify if the file cannot be read - writer.onerror = function fileReadError(file, offset, error) { + // Upload complete + managedFileUpload.progress = file.size; + ManagedFileTransferState.setStreamState(managedFileUpload.transferState, + ManagedFileTransferState.StreamState.CLOSED); - // Abort transfer - writer.sendEnd(); + // Notify of upload completion + $rootScope.$broadcast('guacUploadComplete', file.name); - // Upload failed - ManagedFileTransferState.setStreamState(managedFileUpload.transferState, - ManagedFileTransferState.StreamState.ERROR); + }, - }; + // Notify if upload fails + function uploadFailed(error) { - // Notify of upload progress - writer.onprogress = function uploadProgressing(file, length) { + // 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); - $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; - - // Upload complete - ManagedFileTransferState.setStreamState(managedFileUpload.transferState, - ManagedFileTransferState.StreamState.CLOSED); - - // Notify of upload completion - $rootScope.$broadcast('guacUploadComplete', file.name); + // Ignore all further acks + stream.onack = null; }; From 0b6faba25882b50ba5d0ed1a67a34f2f54e09fba Mon Sep 17 00:00:00 2001 From: Michael Jumper Date: Sun, 5 Jun 2016 17:00:46 -0700 Subject: [PATCH 3/3] GUACAMOLE-44: Remove now-unnecessary getBase64() implementation within ManagedFileUpload (base64 conversion is handled by REST service). --- .../app/client/types/ManagedFileUpload.js | 21 ------------------- 1 file changed, 21 deletions(-) diff --git a/guacamole/src/main/webapp/app/client/types/ManagedFileUpload.js b/guacamole/src/main/webapp/app/client/types/ManagedFileUpload.js index 06fabbb14..82bface4d 100644 --- a/guacamole/src/main/webapp/app/client/types/ManagedFileUpload.js +++ b/guacamole/src/main/webapp/app/client/types/ManagedFileUpload.js @@ -28,7 +28,6 @@ angular.module('client').factory('ManagedFileUpload', ['$rootScope', '$injector' var ManagedFileTransferState = $injector.get('ManagedFileTransferState'); // Required services - var $window = $injector.get('$window'); var tunnelService = $injector.get('tunnelService'); /** @@ -83,26 +82,6 @@ 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