Skip to content

Commit

Permalink
GUACAMOLE-1525: Support for true fullscreen mode
Browse files Browse the repository at this point in the history
and keyboard lock
  • Loading branch information
sirux88 committed Nov 4, 2023
1 parent d1faaa9 commit 79ba6bb
Show file tree
Hide file tree
Showing 5 changed files with 84 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ angular.module('client').controller('clientController', ['$scope', '$routeParams
const requestService = $injector.get('requestService');
const tunnelService = $injector.get('tunnelService');
const userPageService = $injector.get('userPageService');

const guacFullscreen = $injector.get('guacFullscreen');
/**
* The minimum number of pixels a drag gesture must move to result in the
* menu being shown or hidden.
Expand Down Expand Up @@ -683,8 +683,22 @@ angular.module('client').controller('clientController', ['$scope', '$routeParams
callback : $scope.disconnect
};

/**
* Action that toggles fullscreen mode within the
* current client, and then closes the menu.
*/
var FULLSCREEN_MENU_ACTION = {
name : 'CLIENT.ACTION_FULLSCREEN',
classname : 'fullscreen action',
callback : function fullscreen() {

guacFullscreen.toggleFullscreenMode();
$scope.menu.shown = false;
}
};

// Set client-specific menu actions
$scope.clientMenuActions = [ DISCONNECT_MENU_ACTION ];
$scope.clientMenuActions = [ DISCONNECT_MENU_ACTION,FULLSCREEN_MENU_ACTION ];

/**
* @borrows Protocol.getNamespace
Expand Down Expand Up @@ -833,6 +847,9 @@ angular.module('client').controller('clientController', ['$scope', '$routeParams
// Clean up when view destroyed
$scope.$on('$destroy', function clientViewDestroyed() {
setAttachedGroup(null);

// Unset fullscreen mode to not confuse user if view get destroyed
guacFullscreen.setFullscreenMode(false);
});

}]);
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
/*
* 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.
*/

/**
* A service for providing true fullscreen and keyboard lock support.
* Keyboard lock is currently only supported by Chromium based browsers
* (Edge >= V79, Chrome >= V68 and Opera >= V55)
*/
angular.module('client').factory('guacFullscreen', ['$injector',
function guacFullscreen($injector) {

var service = {};

// toggles current fullscreen mode (off if on, on if off)
service.toggleFullscreenMode = function toggleFullscreenMode() {
if (!service.isInFullscreenMode())
service.setFullscreenMode(true);
else
service.setFullscreenMode(false);
}

// check is browser in true fullscreen mode
service.isInFullscreenMode = function isInFullscreenMode() {
return document.fullscreenElement;
}

// set fullscreen mode
service.setFullscreenMode = function setFullscreenMode(state) {
if (document.fullscreenEnabled) {
if (state && !service.isInFullscreenMode())
document.documentElement.requestFullscreen().then(navigator.keyboard.lock());
else if (!state && service.isInFullscreenMode())
document.exitFullscreen().then(navigator.keyboard.unlock());
}
}

return service;

}]);
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ angular.module('client').factory('ManagedClient', ['$rootScope', '$injector',
const guacHistory = $injector.get('guacHistory');
const guacImage = $injector.get('guacImage');
const guacVideo = $injector.get('guacVideo');
const fullscreen = $injector.get('guacFullscreen');

/**
* The minimum amount of time to wait between updates to the client
Expand Down Expand Up @@ -432,6 +433,13 @@ angular.module('client').factory('ManagedClient', ['$rootScope', '$injector',

// Connection has closed
case Guacamole.Tunnel.State.CLOSED:

// force restore non fullscreen mode after any disconnect
// otherwise user may be confused what to do
if(fullscreen.isInFullscreenMode){
fullscreen.setFullscreenMode(false);
}

ManagedClientState.setConnectionState(managedClient.clientState,
ManagedClientState.ConnectionState.DISCONNECTED);
break;
Expand Down
1 change: 1 addition & 0 deletions guacamole/src/main/frontend/src/translations/de.json
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@
"ACTION_ACKNOWLEDGE" : "@:APP.ACTION_ACKNOWLEDGE",
"ACTION_CLEAR_COMPLETED_TRANSFERS" : "Entferne abgeschlossene Übertragungen",
"ACTION_DISCONNECT" : "Trennen",
"ACTION_FULLSCREEN" : "Vollbild",
"ACTION_LOGOUT" : "@:APP.ACTION_LOGOUT",
"ACTION_NAVIGATE_BACK" : "@:APP.ACTION_NAVIGATE_BACK",
"ACTION_NAVIGATE_HOME" : "@:APP.ACTION_NAVIGATE_HOME",
Expand Down
1 change: 1 addition & 0 deletions guacamole/src/main/frontend/src/translations/en.json
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@
"ACTION_CLEAR_COMPLETED_TRANSFERS" : "@:APP.ACTION_CLEAR",
"ACTION_CONTINUE" : "@:APP.ACTION_CONTINUE",
"ACTION_DISCONNECT" : "Disconnect",
"ACTION_FULLSCREEN" : "Fullscreen",
"ACTION_LOGOUT" : "@:APP.ACTION_LOGOUT",
"ACTION_NAVIGATE_BACK" : "@:APP.ACTION_NAVIGATE_BACK",
"ACTION_NAVIGATE_HOME" : "@:APP.ACTION_NAVIGATE_HOME",
Expand Down

0 comments on commit 79ba6bb

Please sign in to comment.