GUAC-862: Only handle keydown directly if reliable. Stop waiting for keypress and handle unreliable keydown if a keyup has already occurred (keypress is impossible).

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

@@ -182,14 +182,16 @@ Guacamole.Keyboard = function(element) {
         if (this.keysym)
             this.reliable = true;
 
-        // We must use the (potentially buggy) keyIdentifier immediately if
+        // Use legacy keyIdentifier as a last resort
-        // keypress will likely not fire, as we need to make a best effort
+        this.keysym = this.keysym || keysym_from_key_identifier(keyIdentifier, location, guac_keyboard.modifiers.shift);
-        // to prevent default if requested
+
-        if (guac_keyboard.modifiers.ctrl
+        // We must rely on the (potentially buggy) keyIdentifier if preventing
-         || guac_keyboard.modifiers.alt
+        // the default action is important
+        if ((guac_keyboard.modifiers.ctrl && !guac_keyboard.modifiers.alt)
+         || (guac_keyboard.modifiers.alt  && !guac_keyboard.modifiers.ctrl)
          || guac_keyboard.modifiers.meta
          || guac_keyboard.modifiers.hyper)
-            this.keysym = this.keysym || keysym_from_key_identifier(keyIdentifier, location, guac_keyboard.modifiers.shift);
+            this.reliable = true;
 
         // Record most recently known keysym by associated key code
         recentKeysym[keyCode] = this.keysym;
@@ -802,6 +804,33 @@ Guacamole.Keyboard = function(element) {
 
     }
 
+    /**
+     * Searches the event log for a keyup event having a given keysym,
+     * returning its index within the log.
+     *
+     * @param {Number} keysym The keysym of the keyup event to search for.
+     * @returns {Number} The index of the first keyup event in the event log
+     *                   having the given keysym, or -1 if no such event exists.
+     */
+    function indexof_keyup(keysym) {
+
+        var i;
+
+        // Search event log for keyup events having the given keysym
+        for (i=0; i<eventLog.length; i++) {
+
+            // Return index of key event if found
+            var event = eventLog[i];
+            if (event instanceof KeyupEvent && event.keysym === keysym)
+                return i;
+
+        }
+
+        // No such keyup found
+        return -1;
+
+    }
+
     /**
      * Reads through the event log, interpreting the first event, if possible,
      * and returning that event. If no events can be interpreted, due to a
@@ -822,7 +851,7 @@ Guacamole.Keyboard = function(element) {
         if (first instanceof KeydownEvent) {
 
             var keysym = first.keysym;
-            if (keysym) {
+            if (first.reliable && keysym) {
                 recentKeysym[first.keyCode] = keysym;
                 first.defaultPrevented = !press_key(keysym);
                 return eventLog.shift();
@@ -832,6 +861,15 @@ Guacamole.Keyboard = function(element) {
             var next = eventLog[1];
             if (next && next instanceof KeypressEvent) {
 
+                // Release Ctrl+Alt under the assumption that it's actually AltGr
+                if (guac_keyboard.modifiers.ctrl && guac_keyboard.modifiers.alt) {
+                    release_key(0xFFE3); // Left ctrl 
+                    release_key(0xFFE4); // Right ctrl 
+                    release_key(0xFFE9); // Left alt
+                    release_key(0xFFEA); // Right alt
+                }
+
+                // Press key based on keypress event
                 keysym = next.keysym;
                 if (keysym) {
                     recentKeysym[first.keyCode] = keysym;
@@ -845,6 +883,13 @@ Guacamole.Keyboard = function(element) {
 
             }
 
+            // If there is a keyup already, stop waiting for a keypress
+            else if (keysym && indexof_keyup(keysym) !== -1) {
+                recentKeysym[first.keyCode] = keysym;
+                first.defaultPrevented = !press_key(keysym);
+                return eventLog.shift();
+            }
+
             // Drop event if completely old and uninterpretable
             else if (first.getAge() > 100) {
                 console.log("Warning: Key press was dropped as ambiguous.", first);