GUACAMOLE-220: Migrate connection management screen to common buttons and permission logic.

guacamole/src/main/webapp/app/manage/controllers/manageConnectionController.js

@@ -27,14 +27,15 @@ angular.module('manage').controller('manageConnectionController', ['$scope', '$i
     var Connection            = $injector.get('Connection');
     var ConnectionGroup       = $injector.get('ConnectionGroup');
     var HistoryEntryWrapper   = $injector.get('HistoryEntryWrapper');
+    var ManagementPermissions = $injector.get('ManagementPermissions');
     var PermissionSet         = $injector.get('PermissionSet');
 
     // Required services
     var $location                = $injector.get('$location');
+    var $q                       = $injector.get('$q');
     var $routeParams             = $injector.get('$routeParams');
     var $translate               = $injector.get('$translate');
     var authenticationService    = $injector.get('authenticationService');
-    var guacNotification         = $injector.get('guacNotification');
     var connectionService        = $injector.get('connectionService');
     var connectionGroupService   = $injector.get('connectionGroupService');
     var permissionService        = $injector.get('permissionService');
@@ -110,34 +111,13 @@ angular.module('manage').controller('manageConnectionController', ['$scope', '$i
     $scope.historyEntryWrappers = null;
 
     /**
-     * Whether the user can save the connection being edited. This could be
+     * The managment-related actions that the current user may perform on the
-     * updating an existing connection, or creating a new connection.
+     * connection currently being created/modified, or null if the current
+     * user's permissions have not yet been loaded.
      *
-     * @type Boolean
+     * @type ManagementPermissions
      */
-    $scope.canSaveConnection = null;
+    $scope.managementPermissions = null;
-    
-    /**
-     * Whether the user can delete the connection being edited.
-     * 
-     * @type Boolean
-     */
-    $scope.canDeleteConnection = null;
-    
-    /**
-     * Whether the user can clone the connection being edited.
-     * 
-     * @type Boolean
-     */
-    $scope.canCloneConnection = null;
-
-    /**
-     * All permissions associated with the current user, or null if the user's
-     * permissions have not yet been loaded.
-     *
-     * @type PermissionSet
-     */
-    $scope.permissions = null;
 
     /**
      * All available connection attributes. This is only the set of attribute
@@ -163,148 +143,157 @@ angular.module('manage').controller('manageConnectionController', ['$scope', '$i
             && $scope.parameters            !== null
             && $scope.historyDateFormat     !== null
             && $scope.historyEntryWrappers  !== null
-            && $scope.permissions          !== null
+            && $scope.managementPermissions !== null
-            && $scope.attributes           !== null
+            && $scope.attributes            !== null;
-            && $scope.canSaveConnection    !== null
-            && $scope.canDeleteConnection  !== null
-            && $scope.canCloneConnection   !== null;
 
     };
 
-    // Pull connection attribute schema
+    /**
-    schemaService.getConnectionAttributes($scope.selectedDataSource)
+     * Loads the data associated with the connection having the given
-    .then(function attributesReceived(attributes) {
+     * identifier, preparing the interface for making modifications to that
-        $scope.attributes = attributes;
+     * existing connection.
-    }, requestService.WARN);
+     *
+     * @param {String} dataSource
+     *     The unique identifier of the data source containing the connection to
+     *     load.
+     *
+     * @param {String} identifier
+     *     The identifier of the connection to load.
+     *
+     * @returns {Promise}
+     *     A promise which is resolved when the interface has been prepared for
+     *     editing the given connection.
+     */
+    var loadExistingConnection = function loadExistingConnection(dataSource, identifier) {
+        return $q.all({
+            connection     : connectionService.getConnection(dataSource, identifier),
+            historyEntries : connectionService.getConnectionHistory(dataSource, identifier),
+            parameters     : connectionService.getConnectionParameters(dataSource, identifier)
+        })
+        .then(function connectionDataRetrieved(values) {
 
-    // Pull connection group hierarchy
+            $scope.connection = values.connection;
-    connectionGroupService.getConnectionGroupTree(
+            $scope.parameters = values.parameters;
-        $scope.selectedDataSource,
-        ConnectionGroup.ROOT_IDENTIFIER,
-        [PermissionSet.ObjectPermissionType.ADMINISTER]
-    )
-    .then(function connectionGroupReceived(rootGroup) {
-        $scope.rootGroup = rootGroup;
-    }, requestService.WARN);
-    
-    // Query the user's permissions for the current connection
-    permissionService.getEffectivePermissions($scope.selectedDataSource, authenticationService.getCurrentUsername())
-    .then(function permissionsReceived(permissions) {
-                
-        $scope.permissions = permissions;
-                        
-        // Check if the connection is new or if the user has UPDATE permission
-        $scope.canSaveConnection =
-               !identifier
-            || PermissionSet.hasSystemPermission(permissions, PermissionSet.SystemPermissionType.ADMINISTER)
-            || PermissionSet.hasConnectionPermission(permissions, PermissionSet.ObjectPermissionType.UPDATE, identifier);
-            
-        // Check if connection is not new and the user has DELETE permission
-        $scope.canDeleteConnection =
-            !!identifier && (
-                   PermissionSet.hasSystemPermission(permissions, PermissionSet.SystemPermissionType.ADMINISTER)
-               ||  PermissionSet.hasConnectionPermission(permissions, PermissionSet.ObjectPermissionType.DELETE, identifier)
-            );
-                
-        // Check if the connection is not new and the user has UPDATE and CREATE_CONNECTION permissions
-        $scope.canCloneConnection =
-            !!identifier && (
-               PermissionSet.hasSystemPermission(permissions, PermissionSet.SystemPermissionType.ADMINISTER) || (
-                       PermissionSet.hasConnectionPermission(permissions, PermissionSet.ObjectPermissionType.UPDATE, identifier)
-                   &&  PermissionSet.hasSystemPermission(permissions, PermissionSet.SystemPermissionType.CREATE_CONNECTION)
-               )
-            );
-    
-    }, requestService.WARN);
-   
-    // Get protocol metadata
-    schemaService.getProtocols($scope.selectedDataSource)
-    .then(function protocolsReceived(protocols) {
-        $scope.protocols = protocols;
-    }, requestService.WARN);
-
-    // Get history date format
-    $translate('MANAGE_CONNECTION.FORMAT_HISTORY_START').then(function historyDateFormatReceived(historyDateFormat) {
-        $scope.historyDateFormat = historyDateFormat;
-    }, angular.noop);
-
-    // If we are editing an existing connection, pull its data
-    if (identifier) {
-
-        // Pull data from existing connection
-        connectionService.getConnection($scope.selectedDataSource, identifier)
-        .then(function connectionRetrieved(connection) {
-            $scope.connection = connection;
-        }, requestService.WARN);
-
-        // Pull connection history
-        connectionService.getConnectionHistory($scope.selectedDataSource, identifier)
-        .then(function historyReceived(historyEntries) {
 
             // Wrap all history entries for sake of display
             $scope.historyEntryWrappers = [];
-            historyEntries.forEach(function wrapHistoryEntry(historyEntry) {
+            angular.forEach(values.historyEntries, function wrapHistoryEntry(historyEntry) {
                $scope.historyEntryWrappers.push(new HistoryEntryWrapper(historyEntry));
             });
 
-        }, requestService.WARN);
+        });
+    };
 
-        // Pull connection parameters
+    /**
-        connectionService.getConnectionParameters($scope.selectedDataSource, identifier)
+     * Loads the data associated with the connection having the given
-        .then(function parametersReceived(parameters) {
+     * identifier, preparing the interface for cloning that existing
-            $scope.parameters = parameters;
+     * connection.
-        }, requestService.WARN);
+     *
-    }
+     * @param {String} dataSource
+     *     The unique identifier of the data source containing the connection
+     *     to be cloned.
+     *
+     * @param {String} identifier
+     *     The identifier of the connection being cloned.
+     *
+     * @returns {Promise}
+     *     A promise which is resolved when the interface has been prepared for
+     *     cloning the given connection.
+     */
+    var loadClonedConnection = function loadClonedConnection(dataSource, identifier) {
+        return $q.all({
+            connection : connectionService.getConnection(dataSource, identifier),
+            parameters : connectionService.getConnectionParameters(dataSource, identifier)
+        })
+        .then(function connectionDataRetrieved(values) {
 
-    // If we are cloning an existing connection, pull its data instead
+            $scope.connection = values.connection;
-    else if (cloneSourceIdentifier) {
+            $scope.parameters = values.parameters;
-
-        // Pull data from cloned connection
-        connectionService.getConnection($scope.selectedDataSource, cloneSourceIdentifier)
-        .then(function connectionRetrieved(connection) {
-            $scope.connection = connection;
 
             // Clear the identifier field because this connection is new
             delete $scope.connection.identifier;
-        }, requestService.WARN);
 
-        // Do not pull connection history
+            // Cloned connections have no history
             $scope.historyEntryWrappers = [];
 
-        // Pull connection parameters from cloned connection
+        });
-        connectionService.getConnectionParameters($scope.selectedDataSource, cloneSourceIdentifier)
+    };
-        .then(function parametersReceived(parameters) {
-            $scope.parameters = parameters;
-        }, requestService.WARN);
-    }
 
-    // If we are creating a new connection, populate skeleton connection data
+    /**
-    else {
+     * Loads skeleton connection data, preparing the interface for creating a
+     * new connection.
+     *
+     * @returns {Promise}
+     *     A promise which is resolved when the interface has been prepared for
+     *     creating a new connection.
+     */
+    var loadSkeletonConnection = function loadSkeletonConnection() {
+
+        // Use skeleton connection object with no associated permissions,
+        // history, or parameters
         $scope.connection = new Connection({
             protocol         : 'vnc',
             parentIdentifier : $location.search().parent
         });
         $scope.historyEntryWrappers = [];
         $scope.parameters = {};
-    }
 
-    /**
+        return $q.resolve();
-     * Returns whether the current user can change/set all connection
-     * attributes for the connection being edited, regardless of whether those
-     * attributes are already explicitly associated with that connection.
-     *
-     * @returns {Boolean}
-     *     true if the current user can change all attributes for the
-     *     connection being edited, regardless of whether those attributes are
-     *     already explicitly associated with that connection, false otherwise.
-     */
-    $scope.canChangeAllAttributes = function canChangeAllAttributes() {
-
-        // All attributes can be set if we are creating the connection
-        return !identifier;
 
     };
 
+    /**
+     * Loads the data requred for performing the management task requested
+     * through the route parameters given at load time, automatically preparing
+     * the interface for editing an existing connection, cloning an existing
+     * connection, or creating an entirely new connection.
+     *
+     * @returns {Promise}
+     *     A promise which is resolved when the interface has been prepared
+     *     for performing the requested management task.
+     */
+    var loadRequestedConnection = function loadRequestedConnection() {
+
+        // If we are editing an existing connection, pull its data
+        if (identifier)
+            return loadExistingConnection($scope.selectedDataSource, identifier);
+
+        // If we are cloning an existing connection, pull its data instead
+        if (cloneSourceIdentifier)
+            return loadClonedConnection($scope.selectedDataSource, cloneSourceIdentifier);
+
+        // If we are creating a new connection, populate skeleton connection data
+        return loadSkeletonConnection();
+
+    };
+
+    // Populate interface with requested data
+    $q.all({
+        connectionData : loadRequestedConnection(),
+        attributes  : schemaService.getConnectionAttributes($scope.selectedDataSource),
+        permissions : permissionService.getEffectivePermissions($scope.selectedDataSource, authenticationService.getCurrentUsername()),
+        protocols   : schemaService.getProtocols($scope.selectedDataSource),
+        rootGroup   : connectionGroupService.getConnectionGroupTree($scope.selectedDataSource, ConnectionGroup.ROOT_IDENTIFIER, [PermissionSet.ObjectPermissionType.ADMINISTER])
+    })
+    .then(function dataRetrieved(values) {
+
+        $scope.attributes = values.attributes;
+        $scope.protocols = values.protocols;
+        $scope.rootGroup = values.rootGroup;
+
+        $scope.managementPermissions = ManagementPermissions.fromPermissionSet(
+                    values.permissions,
+                    PermissionSet.SystemPermissionType.CREATE_CONNECTION,
+                    PermissionSet.hasConnectionPermission,
+                    identifier);
+
+    }, requestService.WARN);
+    
+    // Get history date format
+    $translate('MANAGE_CONNECTION.FORMAT_HISTORY_START').then(function historyDateFormatReceived(historyDateFormat) {
+        $scope.historyDateFormat = historyDateFormat;
+    }, angular.noop);
+
     /**
      * Returns the translation string namespace for the protocol having the
      * given name. The namespace will be of the form:
@@ -353,9 +342,10 @@ angular.module('manage').controller('manageConnectionController', ['$scope', '$i
     };
 
     /**
-     * Cancels all pending edits, returning to the management page.
+     * Cancels all pending edits, returning to the main list of connections
+     * within the selected data source.
      */
-    $scope.cancel = function cancel() {
+    $scope.returnToConnectionList = function returnToConnectionList() {
         $location.url('/settings/' + encodeURIComponent($scope.selectedDataSource) + '/connections');
     };
     
@@ -368,76 +358,33 @@ angular.module('manage').controller('manageConnectionController', ['$scope', '$i
     };
             
     /**
-     * Saves the connection, creating a new connection or updating the existing
+     * Saves the current connection, creating a new connection or updating the
-     * connection.
+     * existing connection, returning a promise which is resolved if the save
+     * operation succeeds and rejected if the save operation fails.
+     *
+     * @returns {Promise}
+     *     A promise which is resolved if the save operation succeeds and is
+     *     rejected with an {@link Error} if the save operation fails.
      */
     $scope.saveConnection = function saveConnection() {
 
         $scope.connection.parameters = $scope.parameters;
 
         // Save the connection
-        connectionService.saveConnection($scope.selectedDataSource, $scope.connection)
+        return connectionService.saveConnection($scope.selectedDataSource, $scope.connection);
-        .then(function savedConnection() {
-            $location.url('/settings/' + encodeURIComponent($scope.selectedDataSource) + '/connections');
-        }, guacNotification.SHOW_REQUEST_ERROR);
 
     };
 
     /**
-     * An action to be provided along with the object sent to showStatus which
+     * Deletes the current connection, returning a promise which is resolved if
-     * immediately deletes the current connection.
+     * the delete operation succeeds and rejected if the delete operation fails.
-     */
+     *
-    var DELETE_ACTION = {
+     * @returns {Promise}
-        name        : "MANAGE_CONNECTION.ACTION_DELETE",
+     *     A promise which is resolved if the delete operation succeeds and is
-        className   : "danger",
+     *     rejected with an {@link Error} if the delete operation fails.
-        // Handle action
-        callback    : function deleteCallback() {
-            deleteConnectionImmediately();
-            guacNotification.showStatus(false);
-        }
-    };
-
-    /**
-     * An action to be provided along with the object sent to showStatus which
-     * closes the currently-shown status dialog.
-     */
-    var CANCEL_ACTION = {
-        name        : "MANAGE_CONNECTION.ACTION_CANCEL",
-        // Handle action
-        callback    : function cancelCallback() {
-            guacNotification.showStatus(false);
-        }
-    };
-
-    /**
-     * Immediately deletes the current connection, without prompting the user
-     * for confirmation.
-     */
-    var deleteConnectionImmediately = function deleteConnectionImmediately() {
-
-        // Delete the connection
-        connectionService.deleteConnection($scope.selectedDataSource, $scope.connection)
-        .then(function deletedConnection() {
-            $location.path('/settings/' + encodeURIComponent($scope.selectedDataSource) + '/connections');
-        }, guacNotification.SHOW_REQUEST_ERROR);
-
-    };
-
-    /**
-     * Deletes the connection, prompting the user first to confirm that
-     * deletion is desired.
      */
     $scope.deleteConnection = function deleteConnection() {
-
+        return connectionService.deleteConnection($scope.selectedDataSource, $scope.connection);
-        // Confirm deletion request
-        guacNotification.showStatus({
-            'title'      : 'MANAGE_CONNECTION.DIALOG_HEADER_CONFIRM_DELETE',
-            'text'       : {
-                key : 'MANAGE_CONNECTION.TEXT_CONFIRM_DELETE'
-            },
-            'actions'    : [ DELETE_ACTION, CANCEL_ACTION]
-        });
-
     };
 
 }]);

guacamole/src/main/webapp/app/manage/templates/manageConnection.html

@@ -41,7 +41,7 @@
     <!-- Connection attributes section -->
     <div class="attributes">
         <guac-form namespace="'CONNECTION_ATTRIBUTES'" content="attributes"
-                   model="connection.attributes" model-only="!canChangeAllAttributes()"></guac-form>
+                   model="connection.attributes" model-only="!managementPermissions.canChangeAllAttributes"></guac-form>
     </div>
 
     <!-- Connection parameters -->
@@ -53,12 +53,13 @@
     </div>
 
     <!-- Form action buttons -->
-    <div class="action-buttons">
+    <management-buttons namespace="'MANAGE_CONNECTION'"
-        <button ng-show="canSaveConnection" ng-click="saveConnection()">{{'MANAGE_CONNECTION.ACTION_SAVE' | translate}}</button>
+          permissions="managementPermissions"
-        <button ng-show="canCloneConnection" ng-click="cloneConnection()">{{'MANAGE_CONNECTION.ACTION_CLONE' | translate}}</button>
+          save="saveConnection()"
-        <button ng-click="cancel()">{{'MANAGE_CONNECTION.ACTION_CANCEL' | translate}}</button>
+          delete="deleteConnection()"
-        <button ng-show="canDeleteConnection" ng-click="deleteConnection()" class="danger">{{'MANAGE_CONNECTION.ACTION_DELETE' | translate}}</button>
+          clone="cloneConnection()"
-    </div>
+          return="returnToConnectionList()">
+    </management-buttons>
 
     <!-- Connection history -->
     <h2 class="header">{{'MANAGE_CONNECTION.SECTION_HEADER_HISTORY' | translate}}</h2>