GUACAMOLE-2232: On-Screen Keyboard: CapsLock gets out-of-sync on macOS.

Author: bbennett-ks

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

@@ -306,27 +306,53 @@ Guacamole.OnScreenKeyboard = function(layout) {
                 // Retrieve originally-pressed keysym, if modifier was already pressed
                 var originalKeysym = modifierKeysyms[key.modifier];
 
-                // Activate modifier if not pressed
-                if (originalKeysym === undefined) {
-                    
-                    addClass(keyboard, modifierClass);
-                    modifierKeysyms[key.modifier] = key.keysym;
-                    
-                    // Send key event only if keysym is meaningful
+                // Toggle modifiers send both keydown and keyup on each press
+                if (key.toggle) {
+
+                    // Toggle the modifier visual state
+                    if (originalKeysym === undefined) {
+                        addClass(keyboard, modifierClass);
+                        modifierKeysyms[key.modifier] = key.keysym;
+                    }
+                    else {
+                        removeClass(keyboard, modifierClass);
+                        delete modifierKeysyms[key.modifier];
+                    }
+
+                    // Send both keydown and keyup to perform the toggle
                     if (key.keysym && osk.onkeydown)
                         osk.onkeydown(key.keysym);
+                    if (key.keysym && osk.onkeyup)
+                        osk.onkeyup(key.keysym);
 
                 }
 
-                // Deactivate if not pressed
+                // Sticky modifiers: activate on first press, deactivate on second
                 else {
 
-                    removeClass(keyboard, modifierClass);
-                    delete modifierKeysyms[key.modifier];
-                    
-                    // Send key event only if original keysym is meaningful
-                    if (originalKeysym && osk.onkeyup)
-                        osk.onkeyup(originalKeysym);
+                    // Activate modifier if not pressed
+                    if (originalKeysym === undefined) {
+
+                        addClass(keyboard, modifierClass);
+                        modifierKeysyms[key.modifier] = key.keysym;
+
+                        // Send key event only if keysym is meaningful
+                        if (key.keysym && osk.onkeydown)
+                            osk.onkeydown(key.keysym);
+
+                    }
+
+                    // Deactivate if pressed
+                    else {
+
+                        removeClass(keyboard, modifierClass);
+                        delete modifierKeysyms[key.modifier];
+
+                        // Send key event only if original keysym is meaningful
+                        if (originalKeysym && osk.onkeyup)
+                            osk.onkeyup(originalKeysym);
+
+                    }
 
                 }
 
@@ -928,11 +954,22 @@ Guacamole.OnScreenKeyboard.Key = function(template, name) {
      * the names of keys; both the "RightShift" and "LeftShift" keys may set
      * the "shift" modifier, for example. By default, the key will affect no
      * modifiers.
-     * 
+     *
      * @type {string}
      */
     this.modifier = template.modifier;
 
+    /**
+     * Whether this key is a toggle modifier. Toggle modifiers send both
+     * keydown and keyup events when pressed, so each press performs one
+     * toggle of the modifier state (e.g., Caps Lock, Num Lock, Scroll Lock).
+     * Non-toggle modifiers remain sticky and are released by a subsequent
+     * press. By default, modifiers are not toggles.
+     *
+     * @type {boolean}
+     */
+    this.toggle = template.toggle || false;
+
     /**
      * An array containing the names of each modifier required for this key to
      * have an effect. For example, a lowercase letter may require nothing,

guacamole/src/main/frontend/src/layouts/de-de-qwertz.json

@@ -103,6 +103,7 @@
         "Caps" : [{
             "title"    : "Caps",
             "modifier" : "caps",
+            "toggle"   : true,
             "keysym"   : 65509
         }],
         "LAlt" : [{

guacamole/src/main/frontend/src/layouts/en-us-qwerty.json

@@ -75,6 +75,7 @@
         "Caps" : [{
             "title"    : "Caps",
             "modifier" : "caps",
+            "toggle"   : true,
             "keysym"   : 65509
         }],
         "LAlt" : [{

guacamole/src/main/frontend/src/layouts/es-es-qwerty.json

@@ -103,6 +103,7 @@
         "Caps" : [{
             "title"    : "Caps",
             "modifier" : "caps",
+            "toggle"   : true,
             "keysym"   : 65509
         }],
         "LAlt" : [{

guacamole/src/main/frontend/src/layouts/fr-fr-azerty.json

@@ -106,6 +106,7 @@
         "Caps" : [{
             "title"    : "Caps",
             "modifier" : "caps",
+            "toggle"   : true,
             "keysym"   : 65509
         }],
         "LAlt" : [{

guacamole/src/main/frontend/src/layouts/it-it-qwerty.json

@@ -103,6 +103,7 @@
         "Caps" : [{
             "title"    : "Caps",
             "modifier" : "caps",
+            "toggle"   : true,
             "keysym"   : 65509
         }],
         "LAlt" : [{

guacamole/src/main/frontend/src/layouts/nl-nl-qwerty.json

@@ -103,6 +103,7 @@
         "Caps" : [{
             "title"    : "Caps",
             "modifier" : "caps",
+            "toggle"   : true,
             "keysym"   : 65509
         }],
         "LAlt" : [{

guacamole/src/main/frontend/src/layouts/ru-ru-qwerty.json

@@ -75,6 +75,7 @@
         "Caps" : [{
             "title"    : "Caps",
             "modifier" : "caps",
+            "toggle"   : true,
             "keysym"   : 65509
         }],
         "LAlt" : [{

guacamole/src/main/frontend/src/layouts/tr-tr-qwerty.json

@@ -74,6 +74,7 @@
         "Caps" : [{
             "title"    : "Caps",
             "modifier" : "caps",
+            "toggle"   : true,
             "keysym"   : 65509
         }],
         "LAlt" : [{