Initial YakPanel commit

YakPanel/static/build/addons/zmodem/zmodem.js

@@ -0,0 +1,108 @@
+/**
+ *
+ * Allow xterm.js to handle ZMODEM uploads and downloads.
+ *
+ * This addon is a wrapper around zmodem.js. It adds the following to the
+ *  Terminal class:
+ *
+ * - function `zmodemAttach(<WebSocket>, <Object>)` - creates a Zmodem.Sentry
+ *      on the passed WebSocket object. The Object passed is optional and
+ *      can contain:
+ *          - noTerminalWriteOutsideSession: Suppress writes from the Sentry
+ *            object to the Terminal while there is no active Session. This
+ *            is necessary for compatibility with, for example, the
+ *            `attach.js` addon.
+ *
+ * - event `zmodemDetect` - fired on Zmodem.Sentry’s `on_detect` callback.
+ *      Passes the zmodem.js Detection object.
+ *
+ * - event `zmodemRetract` - fired on Zmodem.Sentry’s `on_retract` callback.
+ *
+ * You’ll need to provide logic to handle uploads and downloads.
+ * See zmodem.js’s documentation for more details.
+ *
+ * **IMPORTANT:** After you confirm() a zmodem.js Detection, if you have
+ *  used the `attach` or `terminado` addons, you’ll need to suspend their
+ *  operation for the duration of the ZMODEM session. (The demo does this
+ *  via `detach()` and a re-`attach()`.)
+ */
+(function (addon) {
+  if (typeof exports === 'object' && typeof module === 'object') {
+    /*
+     * CommonJS environment
+     */
+    module.exports = addon(require('../../Terminal').Terminal);
+  } else if (typeof define == 'function') {
+    /*
+     * Require.js is available
+     */
+    define(['../../xterm'], addon);
+  } else {
+    /*
+     * Plain browser environment
+     */
+    addon(window.Terminal);
+  }
+})(function _zmodemAddon(Terminal) {
+    Object.assign(
+        Terminal.prototype,
+        {
+            zmodemAttach: function zmodemAttach(ws, opts) {
+                var term = this;
+
+                if (!opts) opts = {};
+
+                var senderFunc = function _ws_sender_func(octets) {
+                    ws.send( new Uint8Array(octets) );
+                };
+
+                var zsentry;
+
+                function _shouldWrite() {
+                    return !!zsentry.get_confirmed_session() || !opts.noTerminalWriteOutsideSession;
+                }
+
+                zsentry = new Zmodem.Sentry( {
+                    to_terminal: function _to_terminal(octets) {
+                        if (_shouldWrite()) {
+                            term.write(
+                                String.fromCharCode.apply(String, octets)
+                            );
+                        }
+                    },
+
+                    sender: senderFunc,
+
+                    on_retract: function _on_retract() {
+                        term.emit("zmodemRetract");
+                    },
+
+                    on_detect: function _on_detect(detection) {
+                        term.emit("zmodemDetect", detection);
+                    },
+                } );
+
+                function handleWSMessage(evt) {
+
+                    //In testing with xterm.js’s demo the first message was
+                    //always text even if the rest were binary. While that
+                    //may be specific to xterm.js’s demo, ultimately we
+                    //should reject anything that isn’t binary.
+                    if (typeof evt.data === "string") {
+                        if (_shouldWrite()) {
+                            term.write(evt.data);
+                        }
+                    }
+                    else {
+                        zsentry.consume(evt.data);
+                    }
+                }
+
+                ws.binaryType = "arraybuffer";
+                ws.addEventListener("message", handleWSMessage);
+            },
+
+            zmodemBrowser: Zmodem.Browser,
+        }
+    );
+});