GUACAMOLE-1866: Add capability for users to configure recent connecti…

…ons.
apache · Nov 3, 2023 · 3d35cd6 · 3d35cd6
1 parent d1faaa9
commit 3d35cd6
Show file tree

Hide file tree

Showing 11 changed files with 85 additions and 23 deletions.
diff --git a/guacamole/src/main/frontend/src/app/history/services/guacHistory.js b/guacamole/src/main/frontend/src/app/history/services/guacHistory.js
@@ -28,17 +28,12 @@ angular.module('history').factory('guacHistory', ['$injector',
 
     // Required services
     var localStorageService = $injector.get('localStorageService');
+    var preferenceService   = $injector.get('preferenceService');
 
     var service = {};
 
     // The parameter name for getting the history from local storage
     var GUAC_HISTORY_STORAGE_KEY = "GUAC_HISTORY";
-
-    /**
-     * The number of entries to allow before removing old entries based on the
-     * cutoff.
-     */
-    var IDEAL_LENGTH = 6;
 
     /**
      * The top few recent connections, sorted in order of most recent access.
@@ -77,8 +72,8 @@ angular.module('history').factory('guacHistory', ['$injector',
         ));
 
         // Truncate history to ideal length
-        if (service.recentConnections.length > IDEAL_LENGTH)
-            service.recentConnections.length = IDEAL_LENGTH;
+        if (service.recentConnections.length > preferenceService.preferences.numberOfRecentConnections)
+            service.recentConnections.length = preferenceService.preferences.numberOfRecentConnections;
 
         // Save updated history
         localStorageService.setItem(GUAC_HISTORY_STORAGE_KEY, service.recentConnections);

diff --git a/guacamole/src/main/frontend/src/app/home/controllers/homeController.js b/guacamole/src/main/frontend/src/app/home/controllers/homeController.js
@@ -31,6 +31,7 @@ angular.module('home').controller('homeController', ['$scope', '$injector',
     var authenticationService  = $injector.get('authenticationService');
     var connectionGroupService = $injector.get('connectionGroupService');
     var dataSourceService      = $injector.get('dataSourceService');
+    var preferenceService      = $injector.get('preferenceService');
     var requestService         = $injector.get('requestService');
 
     /**
@@ -59,6 +60,16 @@ angular.module('home').controller('homeController', ['$scope', '$injector',
     $scope.filteredConnectionGroupProperties = [
         'name'
     ];
+
+    /**
+     * Returns true if recent connections should be displayed on the Guacamole
+     * home page, otherwise false.
+     * 
+     * @returns {!boolean}
+     */
+    $scope.willShowRecentConnections = function willShowRecentConnections() {
+        return preferenceService.preferences.showRecentConnections;
+    };
 
     /**
      * Returns whether critical data has completed being loaded.

diff --git a/guacamole/src/main/frontend/src/app/home/directives/guacRecentConnections.js b/guacamole/src/main/frontend/src/app/home/directives/guacRecentConnections.js
@@ -50,18 +50,29 @@ angular.module('home').directive('guacRecentConnections', [function guacRecentCo
 
             // Required services
             var guacHistory       = $injector.get('guacHistory');
+            var preferenceService = $injector.get('preferenceService');
 
             /**
              * Array of all known and visible recently-used connections.
              *
              * @type RecentConnection[]
              */
             $scope.recentConnections = [];
+
+            /**
+             * Returns whether or not recent connections should be displayed.
+             * 
+             * @returns {!boolean}
+             *     true if recent connections should be displayed, otherwise false.
+             */
+            $scope.willShowRecentConnections = function willShowRecentConnections() {
+                return preferenceService.preferences.showRecentConnections;
+            };
 
             /**
              * Returns whether recent connections are available for display.
              *
-             * @returns {Boolean}
+             * @returns {!boolean}
              *     true if recent connections are present, false otherwise.
              */
             $scope.hasRecentConnections = function hasRecentConnections() {

diff --git a/guacamole/src/main/frontend/src/app/home/styles/home.css b/guacamole/src/main/frontend/src/app/home/styles/home.css
@@ -75,3 +75,8 @@ a.home-connection, .empty.balancer a.home-connection-group {
 .all-connections .connection-group.empty.balancer > .caption .icon.expand {
     display: none;
 }
+
+.header-app-name {
+    font-size: 0.85em;
+    box-shadow: none;
+}
diff --git a/guacamole/src/main/frontend/src/app/home/templates/guacRecentConnections.html b/guacamole/src/main/frontend/src/app/home/templates/guacRecentConnections.html
@@ -1,4 +1,4 @@
-<div class="recent-connections">
+<div class="recent-connections" ng-show="showRecentConnections()">
 
     <!-- Text displayed if no recent connections exist -->
     <p class="placeholder" ng-hide="hasRecentConnections()">{{'HOME.INFO_NO_RECENT_CONNECTIONS' | translate}}</p>

diff --git a/guacamole/src/main/frontend/src/app/home/templates/home.html b/guacamole/src/main/frontend/src/app/home/templates/home.html
@@ -2,12 +2,16 @@
 
     <div class="connection-list-ui">
 
+        <div class="header header-app-name">
+            <h2 id="section-header-app-name">{{'APP.NAME' | translate}}</h2>
+            <guac-user-menu></guac-user-menu>
+        </div>
+
         <!-- The recent connections for this user -->
-        <div class="header">
+        <div class="header" ng-show="willShowRecentConnections()">
             <h2 id="section-header-recent-connections">{{'HOME.SECTION_HEADER_RECENT_CONNECTIONS' | translate}}</h2>
-            <guac-user-menu></guac-user-menu>
         </div>
-        <guac-recent-connections root-groups="rootConnectionGroups"></guac-recent-connections>
+        <guac-recent-connections root-groups="rootConnectionGroups" ng-show="willShowRecentConnections()"></guac-recent-connections>
 
         <!-- All connections for this user -->
         <div class="header">

diff --git a/guacamole/src/main/frontend/src/app/index/styles/headers.css b/guacamole/src/main/frontend/src/app/index/styles/headers.css
@@ -42,7 +42,7 @@ h2 {
     box-shadow: 0 1px 2px rgba(0, 0, 0, 0.125);
     background: rgba(0, 0, 0, 0.04);
 
-    margin-bottom: 1em;
+    margin-bottom: 0;
     margin-top: 0;
     border-top: none;
     width: 100%;
@@ -80,7 +80,7 @@ h2 {
 
 .header ~ * .header,
 .header ~ .header {
-    margin-top: 1em;
+    margin-top: 0;
     border-top: 1px solid rgba(0, 0, 0, 0.125);
 }
 

diff --git a/guacamole/src/main/frontend/src/app/settings/directives/guacSettingsPreferences.js b/guacamole/src/main/frontend/src/app/settings/directives/guacSettingsPreferences.js
@@ -258,7 +258,7 @@ angular.module('settings').directive('guacSettingsPreferences', [function guacSe
             // Fetch the user record
             userService.getUser(dataSource, username).then(function saveUserData(user) {
                 $scope.user = user;
-            })
+            });
 
             // Fetch all user preference attribute forms defined
             schemaService.getUserPreferenceAttributes(dataSource).then(function saveAttributes(attributes) {

diff --git a/guacamole/src/main/frontend/src/app/settings/services/preferenceService.js b/guacamole/src/main/frontend/src/app/settings/services/preferenceService.js
@@ -142,6 +142,20 @@ angular.module('settings').provider('preferenceService', ['$injector',
          */
         language : getDefaultLanguageKey(),
 
+        /**
+         * The number of recent connections to display.
+         * 
+         * @type {!number}
+         */
+        numberOfRecentConnections: 6,
+
+        /**
+         * Whether or not to show the "Recent Connections" section.
+         * 
+         * @type {!boolean}
+         */
+        showRecentConnections : true,
+
         /**
          * The timezone set by the user, in IANA zone key format (Olson time
          * zone database).

diff --git a/guacamole/src/main/frontend/src/app/settings/templates/settingsPreferences.html b/guacamole/src/main/frontend/src/app/settings/templates/settingsPreferences.html
@@ -88,6 +88,24 @@ <h2 class="header">{{'SETTINGS_PREFERENCES.SECTION_HEADER_DEFAULT_MOUSE_MODE' |
 
         </div>
     </div>
+
+    <!-- Recent connections -->
+    <h2 class="header">{{'SETTINGS_PREFERENCES.SECTION_HEADER_RECENT_CONNECTIONS' | translate}}</h2>
+    <div class="settings section recent">
+        <p>{{'SETTINGS_PREFERENCES.HELP_RECENT_CONNECTIONS' | translate}}</p>
+        <div class='form'>
+            <table class='fields'>
+                <tr>
+                    <th>{{'SETTINGS_PREFERENCES.FIELD_HEADER_SHOW_RECENT_CONNECTIONS' | translate}}</th>
+                    <td><input ng-model="preferences.showRecentConnections" type="checkbox"/></td>
+                </tr>
+                <tr>
+                    <th>{{'SETTINGS_PREFERENCES.FIELD_HEADER_NUMBER_RECENT_CONNECTIONS' | translate}}</th>
+                    <td><input ng-model="preferences.numberRecentConnections" type="number" min="1" max="20"/></td>
+                </tr>
+            </table>
+        </div>
+    </div>
 
     <!-- User attributes section -->
     <div class="attributes" ng-show="canUpdateSelf && attributes.length">

diff --git a/guacamole/src/main/frontend/src/translations/en.json b/guacamole/src/main/frontend/src/translations/en.json
@@ -1021,13 +1021,15 @@
         "ERROR_PASSWORD_BLANK"    : "@:APP.ERROR_PASSWORD_BLANK",
         "ERROR_PASSWORD_MISMATCH" : "@:APP.ERROR_PASSWORD_MISMATCH",
 
-        "FIELD_HEADER_LANGUAGE"           : "Display language:",
-        "FIELD_HEADER_PASSWORD"           : "Password:",
-        "FIELD_HEADER_PASSWORD_OLD"       : "Current Password:",
-        "FIELD_HEADER_PASSWORD_NEW"       : "New Password:",
-        "FIELD_HEADER_PASSWORD_NEW_AGAIN" : "Confirm New Password:",
-        "FIELD_HEADER_TIMEZONE"           : "Timezone:",
-        "FIELD_HEADER_USERNAME"           : "Username:",
+        "FIELD_HEADER_LANGUAGE"                  : "Display language:",
+        "FIELD_HEADER_NUMBER_RECENT_CONNECTIONS" : "Number of Recent Connections to show:",
+        "FIELD_HEADER_PASSWORD"                  : "Password:",
+        "FIELD_HEADER_PASSWORD_OLD"              : "Current Password:",
+        "FIELD_HEADER_PASSWORD_NEW"              : "New Password:",
+        "FIELD_HEADER_PASSWORD_NEW_AGAIN"        : "Confirm New Password:",
+        "FIELD_HEADER_SHOW_RECENT_CONNECTIONS"   : "Display Recent Connections:",
+        "FIELD_HEADER_TIMEZONE"                  : "Timezone:",
+        "FIELD_HEADER_USERNAME"                  : "Username:",
 
         "HELP_DEFAULT_INPUT_METHOD" : "The default input method determines how keyboard events are received by Guacamole. Changing this setting may be necessary when using a mobile device, or when typing through an IME. This setting can be overridden on a per-connection basis within the Guacamole menu.",
         "HELP_DEFAULT_MOUSE_MODE"   : "The default mouse emulation mode determines how the remote mouse will behave in new connections with respect to touches. This setting can be overridden on a per-connection basis within the Guacamole menu.",
@@ -1037,6 +1039,7 @@
         "HELP_LOCALE"               : "Options below are related to the locale of the user and will impact how various parts of the interface are displayed.",
         "HELP_MOUSE_MODE_ABSOLUTE"  : "@:CLIENT.HELP_MOUSE_MODE_ABSOLUTE",
         "HELP_MOUSE_MODE_RELATIVE"  : "@:CLIENT.HELP_MOUSE_MODE_RELATIVE",
+        "HELP_RECENT_CONNECTIONS"   : "Here you can enable or disable recent conections in the Guacamole Home Page, and adjust the number of recent connections that will be displayed.",
         "HELP_UPDATE_PASSWORD"      : "If you wish to change your password, enter your current password and the desired new password below, and click \"Update Password\". The change will take effect immediately.",
 
         "INFO_PASSWORD_CHANGED" : "Password changed.",
@@ -1048,6 +1051,7 @@
 
         "SECTION_HEADER_DEFAULT_INPUT_METHOD" : "Default Input Method",
         "SECTION_HEADER_DEFAULT_MOUSE_MODE"   : "Default Mouse Emulation Mode",
+        "SECTION_HEADER_RECENT_CONNECTIONS"   : "Recent Connections Preferences",
         "SECTION_HEADER_UPDATE_PASSWORD"      : "Change Password"
 
     },