GUACAMOLE-2207: Merge correction to keyboard handling allowing Cmd-click (Meta-click).

Author: mike-jumper

guacamole-common-js/src/main/webapp/modules/Keyboard.js

@@ -294,8 +294,10 @@ Guacamole.Keyboard = function Keyboard(element) {
             this.keysym = keysym_from_key_identifier(this.keyIdentifier, this.location, this.modifiers.shift);
 
         // If a key is pressed while meta is held down, the keyup will
-        // never be sent in Chrome (bug #108404)
-        if (this.modifiers.meta && this.keysym !== 0xFFE7 && this.keysym !== 0xFFE8)
+        // never be sent in Chrome (bug #108404). Modifier keys are excluded
+        // from this workaround as they have reliable keyup events and need
+        // to be held down simultaneously with Meta.
+        if (this.modifiers.meta && !isModifierKey(this.keysym))
             this.keyupReliable = false;
 
         // We cannot rely on receiving keyup for lock keys on certain platforms
@@ -593,6 +595,23 @@ Guacamole.Keyboard = function Keyboard(element) {
         hyper: [0xFFEB, 0xFFEC]            // Left super/hyper, Right super/hyper
     };
 
+    /**
+     * All modifier key keysyms for easy lookup.
+     *
+     * @private
+     * @type {!Object.<number, boolean>}
+     */
+    var modifierKeysyms = (function() {
+        var lookup = {};
+        for (var modifier in modifierKeysymsByType) {
+            var keysyms = modifierKeysymsByType[modifier];
+            for (var i = 0; i < keysyms.length; i++) {
+                lookup[keysyms[i]] = true;
+            }
+        }
+        return lookup;
+    })();
+
     /**
      * All keysyms that represent each supported toggle modifier
      * type.
@@ -801,6 +820,36 @@ Guacamole.Keyboard = function Keyboard(element) {
             || isScrollLockKey(keysym);
     };
 
+    /**
+     * Returns true if the given keysym corresponds to a Meta key (left or
+     * right Meta/Command/Windows key).
+     *
+     * @private
+     * @param {!number} keysym
+     *     The keysym to check.
+     *
+     * @returns {!boolean}
+     *     true if the given keysym corresponds to a Meta key, false otherwise.
+     */
+    var isMetaKey = function isMetaKey(keysym) {
+        return modifierKeysymsByType.meta.indexOf(keysym) !== -1;
+    };
+
+    /**
+     * Returns true if the given keysym corresponds to a modifier key
+     * (Shift, Ctrl, Alt, Meta, Hyper, AltGr).
+     *
+     * @private
+     * @param {!number} keysym
+     *     The keysym to check.
+     *
+     * @returns {!boolean}
+     *     true if the given keysym corresponds to a modifier key, false otherwise.
+     */
+    var isModifierKey = function isModifierKey(keysym) {
+        return modifierKeysyms[keysym] === true;
+    };
+
     function keysym_from_key_identifier(identifier, location, shifted) {
 
         if (!identifier)
@@ -1060,6 +1109,23 @@ Guacamole.Keyboard = function Keyboard(element) {
         // Keep lock modifiers synchronized using mouse event modifier flags
         syncToggleModifierStates(mouseEvent.modifiers);
 
+        // Check if there's a pending Meta key waiting for context
+        var hasPendingMeta = eventLog.length > 0 &&
+                             eventLog[0] instanceof KeydownEvent &&
+                             isMetaKey(eventLog[0].keysym);
+
+        // Only add mouse event if it has meta modifier and there's a pending Meta key
+        if (mouseEvent.modifiers.meta && hasPendingMeta) {
+            // Push mouse event onto the event log to provide context for the
+            // deferred Meta key. The mouse event will be silently dropped when
+            // processed as it's not a KeyEvent type.
+            eventLog.push(mouseEvent);
+
+            // Process the event log, which will now resolve the deferred Meta
+            // key using the mouse event's modifier state as context
+            interpret_events();
+        }
+
     };
 
     /**
@@ -1384,7 +1450,7 @@ Guacamole.Keyboard = function Keyboard(element) {
             // Defer handling of Meta until it is known to be functioning as a
             // modifier (it may otherwise actually be an alternative method for
             // pressing a single key, such as Meta+Left for Home on ChromeOS)
-            if (first.keysym === 0xFFE7 || first.keysym === 0xFFE8) {
+            if (isMetaKey(first.keysym)) {
 
                 // Defer handling until further events exist to provide context
                 if (eventLog.length === 1)

guacamole/src/main/frontend/src/app/client/directives/guacClient.js

@@ -243,6 +243,11 @@ angular.module('client').directive('guacClient', [function guacClient() {
             if (!client || !display)
                 return;
 
+            // Broadcast mousedown event before sending to allow keyboard to resolve
+            // deferred modifier keys (especially CMD+click)
+            if (event.type === 'mousedown')
+                $rootScope.$broadcast('guacBeforeClientMouseDown', event, client);
+
             event.stopPropagation();
             event.preventDefault();
 
@@ -303,6 +308,11 @@ angular.module('client').directive('guacClient', [function guacClient() {
             if (!client || !display)
                 return;
 
+            // Broadcast mousedown event before sending to allow keyboard to resolve
+            // deferred modifier keys (especially CMD+click)
+            if (event.type === 'mousedown')
+                $rootScope.$broadcast('guacBeforeClientMouseDown', event, client);
+
             event.stopPropagation();
             event.preventDefault();
 

guacamole/src/main/frontend/src/app/index/controllers/indexController.js

@@ -183,8 +183,9 @@ angular.module('index').controller('indexController', ['$scope', '$injector',
     var keyboard = new Guacamole.Keyboard($document[0]);
     keyboard.listenTo(sink.getElement());
 
-    // Update keyboard modifiers based mouse click events
-    $scope.$on('guacClientMouseDown', function mouseDownModifierSync(event, mouseEvent) {
+    // Update keyboard modifiers based mouse click events. Note we need to run
+    // before mousedown to resolve deferred Meta key events to enable Cmd+Click.
+    $scope.$on('guacBeforeClientMouseDown', function mouseDownModifierSync(event, mouseEvent) {
         keyboard.updateModifiersFromMouse(mouseEvent);
     });