GUACAMOLE-2237: Multiline paste and text input client fixes.

Author: bbennett-ks

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

@@ -1737,10 +1737,55 @@ Guacamole.Keyboard = function Keyboard(element) {
 
         };
 
+        /**
+         * Handles the given "paste" event, normalizing clipboard text before
+         * typing it into the remote session.
+         *
+         * @private
+         * @param {!ClipboardEvent} e
+         *     The "paste" event to handle.
+         */
+        var handlePaste = function handlePaste(e) {
+
+            // Only intercept if handler set
+            if (!guac_keyboard.onkeydown && !guac_keyboard.onkeyup) return;
+
+            // Ignore events which have already been handled
+            if (!markEvent(e)) return;
+
+            if (!e.clipboardData)
+                return;
+
+            var content = e.clipboardData.getData('text/plain');
+            if (!content)
+                return;
+
+            // This paste path replays clipboard content as synthetic keyboard
+            // input. Normalize to CR here because the typing path treats CR as
+            // Enter.
+            content = Guacamole.Keyboard.normalizeToCR(content);
+
+            // Release held modifiers so pasted text isn't treated as modified
+            // input or shortcuts on the remote side.
+            Guacamole.Keyboard.pasteModifierKeysyms.forEach(function(keysym) {
+                guac_keyboard.release(keysym);
+            });
+
+            guac_keyboard.type(content);
+
+            e.preventDefault();
+
+            // Stop propagation defensively in case paste handling is added
+            // on parent elements.
+            e.stopPropagation();
+
+        };
+
         // Automatically type text entered into the wrapped field
         element.addEventListener("input", handleInput, false);
         element.addEventListener("compositionend", handleCompositionEnd, false);
         element.addEventListener("compositionstart", handleCompositionStart, false);
+        element.addEventListener("paste", handlePaste, false);
 
     };
 
@@ -1759,6 +1804,59 @@ Guacamole.Keyboard = function Keyboard(element) {
  */
 Guacamole.Keyboard._nextID = 0;
 
+/**
+ * Normalizes clipboard text line endings to "\n".
+ *
+ * Used when working with text content (e.g. clipboard buffering or text input),
+ * where LF is the preferred canonical newline.
+ *
+ * @param {!string} content
+ *     The clipboard text to normalize.
+ *
+ * @returns {!string}
+ *     The clipboard text with all CRLF and CR sequences converted to LF.
+ */
+Guacamole.Keyboard.normalizeToLF = function normalizeToLF(content) {
+    return content.replace(/\r\n|\r/g, '\n');
+};
+
+/**
+ * Normalizes clipboard text line endings to "\r".
+ *
+ * Used when replaying text as keyboard input. Terminals interpret CR as the
+ * Enter key, while LF is just a newline and is not reliably treated as Enter.
+ *
+ * @param {!string} content
+ *     The clipboard text to normalize.
+ *
+ * @returns {!string}
+ *     The clipboard text with all CRLF, CR, and LF sequences converted to CR.
+ */
+Guacamole.Keyboard.normalizeToCR = function normalizeToCR(content) {
+    return content.replace(/\r\n|\n/g, '\r');
+};
+
+/**
+ * Modifiers to release before pasting so shortcut keys do not affect input
+ * on the remote side. Lock keys are excluded because they toggle state rather
+ * than being held.
+ *
+ * @type {!number[]}
+ */
+Guacamole.Keyboard.pasteModifierKeysyms = [
+    0xFE03, // AltGr
+    0xFFE1, // Left shift
+    0xFFE2, // Right shift
+    0xFFE3, // Left ctrl
+    0xFFE4, // Right ctrl
+    0xFFE7, // Left meta
+    0xFFE8, // Right meta
+    0xFFE9, // Left alt
+    0xFFEA, // Right alt
+    0xFFEB, // Left super/hyper
+    0xFFEC  // Right super/hyper
+];
+
 /**
  * The state of all supported keyboard modifiers.
  * @constructor

guacamole/src/main/frontend/src/app/textInput/directives/guacTextInput.js

@@ -286,6 +286,48 @@ angular.module('textInput').directive('guacTextInput', [function guacTextInput()
 
             };
 
+            /**
+             * Handles the given "paste" event, normalizing clipboard text
+             * before sending it to the remote session.
+             *
+             * @private
+             * @param {!ClipboardEvent} e
+             *     The "paste" event to handle.
+             */
+            target.addEventListener("paste", function(e) {
+
+                if (!e.clipboardData)
+                    return;
+
+                var content = e.clipboardData.getData('text/plain');
+                if (!content)
+                    return;
+
+                // This paste path works with canonical text buffered by the
+                // text input control. Normalize to LF here and let
+                // sendString()/sendCodepoint() map LF to Enter where needed.
+                content = Guacamole.Keyboard.normalizeToLF(content);
+
+                // Release held modifiers so pasted text isn't treated as
+                // modified input or shortcuts on the remote side.
+                Guacamole.Keyboard.pasteModifierKeysyms.forEach(function(keysym) {
+                    $rootScope.$broadcast('guacSyntheticKeyup', keysym);
+                });
+
+                sendString(content);
+
+                releaseStickyKeys();
+
+                // Reset content
+                resetTextInputTarget(TEXT_INPUT_PADDING);
+                e.preventDefault();
+
+                // Stop propagation defensively in case paste handling is added
+                // on parent elements.
+                e.stopPropagation();
+
+            }, false);
+
             target.addEventListener("input", function(e) {
 
                 // Ignore input events during text composition