GUACAMOLE-1820: Create UI for viewing, searching, and navigating to key events in session recording player.

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

@@ -104,6 +104,16 @@ Guacamole.SessionRecording = function SessionRecording(source, refreshInterval)
      */
     var KEYFRAME_TIME_INTERVAL = 5000;
 
+    /**
+     * The minimum number of milliseconds which must elapse between key events
+     * before text can be split across multiple frames.
+     *
+     * @private
+     * @constant
+     * @type {Number}
+     */
+    var TYPED_TEXT_INTERVAL = 5000;
+
     /**
      * All frames parsed from the provided blob.
      *
@@ -375,6 +385,26 @@ Guacamole.SessionRecording = function SessionRecording(source, refreshInterval)
     // Hide cursor unless mouse position is received
     playbackClient.getDisplay().showCursor(false);
 
+    /**
+     * A key event interpreter to split all key events in this recording into
+     * human-readable batches of text.
+     *
+     * @type {!Guacamole.KeyEventInterpreter}
+     */
+    var keyEventInterpreter = new Guacamole.KeyEventInterpreter();
+
+    // Pass through any received batches to the recording ontext handler
+    keyEventInterpreter.onBatch = function onBatch(text, timestamp) {
+
+        // Don't call the callback if it was never set
+        if (!recording.ontext)
+            return;
+
+        // Convert to a recording-relative timestamp and pass through
+        recording.ontext(text, toRelativeTimestamp(timestamp));
+
+    };
+
     /**
      * Handles a newly-received instruction, whether from the main Blob or a
      * tunnel, adding new frames and keyframes as necessary. Load progress is
@@ -421,6 +451,8 @@ Guacamole.SessionRecording = function SessionRecording(source, refreshInterval)
 
         }
 
+        else if (opcode === 'key')
+            keyEventInterpreter.handleKeyEvent(args);
     };
 
     /**
@@ -487,6 +519,13 @@ Guacamole.SessionRecording = function SessionRecording(source, refreshInterval)
                     instructionBuffer = '';
                 }
 
+                // If there's any typed text that's yet to be sent to the ontext
+                // handler, send it now
+                var text = keyEventInterpreter.getCurrentText();
+                var timestamp = keyEventInterpreter.getCurrentTimestamp();
+                if (text && recording.ontext)
+                    recording.ontext(text, toRelativeTimestamp(timestamp));
+
                 // Consider recording loaded if tunnel has closed without errors
                 if (!errorEncountered)
                     notifyLoaded();
@@ -872,6 +911,19 @@ Guacamole.SessionRecording = function SessionRecording(source, refreshInterval)
      */
     this.onpause = null;
 
+    /**
+     * Fired whenever a new batch of typed text extracted from key events
+     * is available.
+     *
+     * @event
+     * @param {!String} text
+     *     The typed text associated with the batch of text.
+     *
+     * @param {!number} timestamp
+     *     The relative timestamp associated with the batch of text.
+     */
+    this.ontext = null;
+
     /**
      * Fired whenever the playback position within the recording changes.
      *