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

GUACAMOLE-549: Merge migrate to localStorage for storage of auth token.

Browse Source
This commit is contained in:
Nick Couchman
2018-04-20 05:12:28 -04:00
parent aac9d8795c 884a9c0ee9
commit 456ad7f28e
9 changed files with 192 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
guacamole/pom.xml
View File

@@ -327,12 +327,6 @@
<version>1.3.16</version>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.webjars.bower</groupId>
<artifactId>angular-cookies</artifactId>
<version>1.3.16</version>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.webjars.bower</groupId>
<artifactId>angular-route</artifactId>

4
guacamole/src/main/webapp/app/auth/authModule.js
View File

@@ -20,4 +20,6 @@
/**
* The module for authentication and management of tokens.
*/
angular.module('auth', ['ngCookies']);
angular.module('auth', [
'storage'
]);

22
guacamole/src/main/webapp/app/auth/service/authenticationService.js
View File

@@ -46,10 +46,10 @@ angular.module('auth').factory('authenticationService', ['$injector',
var Error = $injector.get('Error');
// Required services
var $cookieStore = $injector.get('$cookieStore');
var $http = $injector.get('$http');
var $q = $injector.get('$q');
var $rootScope = $injector.get('$rootScope');
var $http = $injector.get('$http');
var $q = $injector.get('$q');
var $rootScope = $injector.get('$rootScope');
var localStorageService = $injector.get('localStorageService');
var service = {};
@@ -62,12 +62,12 @@ angular.module('auth').factory('authenticationService', ['$injector',
var cachedResult = null;
/**
* The unique identifier of the local cookie which stores the result of the
* last authentication attempt.
* The unique identifier of the local storage key which stores the result
* of the last authentication attempt.
*
* @type String
*/
var AUTH_COOKIE_ID = "GUAC_AUTH";
var AUTH_STORAGE_KEY = 'GUAC_AUTH';
/**
* Retrieves the last successful authentication result. If the user has not
@@ -85,7 +85,7 @@ angular.module('auth').factory('authenticationService', ['$injector',
return cachedResult;
// Return explicit null if no auth data is currently stored
var data = $cookieStore.get(AUTH_COOKIE_ID);
var data = localStorageService.getItem(AUTH_STORAGE_KEY);
if (!data)
return null;
@@ -107,7 +107,7 @@ angular.module('auth').factory('authenticationService', ['$injector',
// Clear the currently-stored result if the last attempt failed
if (!data) {
cachedResult = null;
$cookieStore.remove(AUTH_COOKIE_ID);
localStorageService.removeItem(AUTH_STORAGE_KEY);
}
// Otherwise store the authentication attempt directly
@@ -116,9 +116,9 @@ angular.module('auth').factory('authenticationService', ['$injector',
// Always store in cache
cachedResult = data;
// Store cookie ONLY if not anonymous
// Persist result past tab/window closure ONLY if not anonymous
if (data.username !== AuthenticationResult.ANONYMOUS_USERNAME)
$cookieStore.put(AUTH_COOKIE_ID, data);
localStorageService.setItem(AUTH_STORAGE_KEY, data);
}

4
guacamole/src/main/webapp/app/history/historyModule.js
View File

@@ -20,4 +20,6 @@
/**
* The module for code relating to connection history.
*/
angular.module('history', []);
angular.module('history', [
'storage'
]);

33
guacamole/src/main/webapp/app/history/services/guacHistory.js
View File

@@ -20,7 +20,14 @@
/**
* A service for reading and manipulating the Guacamole connection history.
*/
angular.module('history').factory('guacHistory', ['HistoryEntry', function guacHistory(HistoryEntry) {
angular.module('history').factory('guacHistory', ['$injector',
function guacHistory($injector) {
// Required types
var HistoryEntry = $injector.get('HistoryEntry');
// Required services
var localStorageService = $injector.get('localStorageService');
var service = {};
@@ -73,27 +80,15 @@ angular.module('history').factory('guacHistory', ['HistoryEntry', function guacH
if (service.recentConnections.length > IDEAL_LENGTH)
service.recentConnections.length = IDEAL_LENGTH;
// Save updated history, ignore inability to use localStorage
try {
if (localStorage)
localStorage.setItem(GUAC_HISTORY_STORAGE_KEY, JSON.stringify(service.recentConnections));
}
catch (ignore) {}
// Save updated history
localStorageService.setItem(GUAC_HISTORY_STORAGE_KEY, service.recentConnections);
};
// Get stored connection history, ignore inability to use localStorage
try {
if (localStorage) {
var storedHistory = JSON.parse(localStorage.getItem(GUAC_HISTORY_STORAGE_KEY) || "[]");
if (storedHistory instanceof Array)
service.recentConnections = storedHistory;
}
}
catch (ignore) {}
// Init stored connection history from localStorage
var storedHistory = localStorageService.getItem(GUAC_HISTORY_STORAGE_KEY) || [];
if (storedHistory instanceof Array)
service.recentConnections = storedHistory;
return service;

37
guacamole/src/main/webapp/app/settings/services/preferenceService.js
View File

@@ -21,7 +21,11 @@
* A service for setting and retrieving browser-local preferences. Preferences
* may be any JSON-serializable type.
*/
angular.module('settings').provider('preferenceService', function preferenceServiceProvider() {
angular.module('settings').provider('preferenceService', ['$injector',
function preferenceServiceProvider($injector) {
// Required providers
var localStorageServiceProvider = $injector.get('localStorageServiceProvider');
/**
* Reference to the provider itself.
@@ -128,24 +132,18 @@ angular.module('settings').provider('preferenceService', function preferenceServ
};
// Get stored preferences, ignore inability to use localStorage
try {
if (localStorage) {
var preferencesJSON = localStorage.getItem(GUAC_PREFERENCES_STORAGE_KEY);
if (preferencesJSON)
angular.extend(provider.preferences, JSON.parse(preferencesJSON));
}
}
catch (ignore) {}
// Get stored preferences from localStorage
var storedPreferences = localStorageServiceProvider.getItem(GUAC_PREFERENCES_STORAGE_KEY);
if (storedPreferences)
angular.extend(provider.preferences, storedPreferences);
// Factory method required by provider
this.$get = ['$injector', function preferenceServiceFactory($injector) {
// Required services
var $rootScope = $injector.get('$rootScope');
var $window = $injector.get('$window');
var $rootScope = $injector.get('$rootScope');
var $window = $injector.get('$window');
var localStorageService = $injector.get('localStorageService');
var service = {};
@@ -168,14 +166,7 @@ angular.module('settings').provider('preferenceService', function preferenceServ
* Persists the current values of all preferences, if possible.
*/
service.save = function save() {
// Save updated preferences, ignore inability to use localStorage
try {
if (localStorage)
localStorage.setItem(GUAC_PREFERENCES_STORAGE_KEY, JSON.stringify(service.preferences));
}
catch (ignore) {}
localStorageService.setItem(GUAC_PREFERENCES_STORAGE_KEY, service.preferences);
};
// Persist settings when window is unloaded
@@ -195,4 +186,4 @@ angular.module('settings').provider('preferenceService', function preferenceServ
}];
});
}]);

3
guacamole/src/main/webapp/app/settings/settingsModule.js
View File

@@ -26,5 +26,6 @@ angular.module('settings', [
'list',
'navigation',
'notification',
'rest'
'rest',
'storage'
]);

145
guacamole/src/main/webapp/app/storage/services/localStorageService.js Normal file
View File

@@ -0,0 +1,145 @@
/*
* 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.
*/
/**
* Service for setting, removing, and retrieving localStorage keys. If access
* to localStorage is disabled, or the browser does not support localStorage,
* key values are temporarily stored in memory instead. If necessary, the same
* functionality is also available at the localStorageServiceProvider level.
*/
angular.module('storage').provider('localStorageService', [function localStorageServiceProvider() {
/**
* Reference to this provider.
*
* @type localStorageServiceProvider
*/
var provider = this;
/**
* Internal cache of key/value pairs stored within localStorage, updated
* lazily as keys are retrieved, updated, or removed. If localStorage is
* not actually available, then this cache will be the sole storage
* location for these key/value pairs.
*
* @type Object.<String, String>
*/
var storedItems = {};
/**
* Stores the given value within localStorage under the given key. If access
* to localStorage is not provided/implemented by the browser, the key/value
* pair will be stored internally (in memory) only, with the stored value
* remaining retrievable via getItem() until the browser tab/window is
* closed.
*
* @param {String} key
* The arbitrary, unique key under which the value should be stored.
*
* @param {Object} value
* The object to store under the given key. This may be any object that
* can be serialized as JSON, and will automatically be serialized as
* JSON prior to storage.
*/
provider.setItem = function setItem(key, value) {
// Store given value internally
var data = JSON.stringify(value);
storedItems[key] = data;
// Additionally store value within localStorage if allowed
try {
if (window.localStorage)
localStorage.setItem(key, data);
}
catch (ignore) {}
};
/**
* Removes the item having the given key from localStorage. If access to
* localStorage is not provided/implemented by the browser, the item is
* removed solely from internal, in-memory storage. If no such item exists,
* this function has no effect.
*
* @param {String} key
* The arbitrary, unique key of the item to remove from localStorage.
*/
provider.removeItem = function removeItem(key) {
// Evict key from internal storage
delete storedItems[key];
// Remove key from localStorage if allowed
try {
if (window.localStorage)
localStorage.removeItem(key);
}
catch (ignore) {}
};
/**
* Retrieves the value currently stored within localStorage for the item
* having the given key. If access to localStorage is not
* provided/implemented by the browser, the item is retrieved from
* internal, in-memory storage. The retrieved value is automatically
* deserialized from JSON prior to being returned.
*
* @param {String} key
* The arbitrary, unique key of the item to retrieve from localStorage.
*
* @returns {Object}
* The value stored within localStorage under the given key,
* automatically deserialized from JSON, or null if no such item is
* present.
*/
provider.getItem = function getItem(key) {
// Attempt to refresh internal storage from localStorage
try {
if (window.localStorage)
storedItems[key] = localStorage.getItem(key);
}
catch (ignore) {}
// Pull and parse value from internal storage, if present
var data = storedItems[key];
if (data)
return JSON.parse(data);
// No value defined for given key
return null;
};
// Factory method required by provider
this.$get = ['$injector', function localStorageServiceFactory($injector) {
// Pass through all get/set/remove calls to the provider
// implementations of the same
return {
setItem : provider.setItem,
removeItem : provider.removeItem,
getItem : provider.getItem
};
}];
}]);

1
guacamole/src/main/webapp/index.html
View File

@@ -62,7 +62,6 @@
<!-- AngularJS -->
<script type="text/javascript" src="webjars/angular/1.3.16/angular.min.js"></script>
<script type="text/javascript" src="webjars/angular-cookies/1.3.16/angular-cookies.min.js"></script>
<script type="text/javascript" src="webjars/angular-route/1.3.16/angular-route.min.js"></script>
<script type="text/javascript" src="webjars/angular-touch/1.3.16/angular-touch.min.js"></script>