Callback add to terminal.execute function

Author: nikitaeverywhere

package.json

@@ -5,7 +5,7 @@
   "printableName": "Cache Web Terminal",
   "description": "Web-based terminal emulator for Caché administering.",
   "author": "ZitRo",
-  "version": "4.4.1",
+  "version": "4.5.0",
   "gaID": "UA-83005064-2",
   "releaseNumber": 26,
   "scripts": {

readme.md

@@ -100,19 +100,20 @@ The next table demonstrates available API. Left column are `terminal` object pro
 		<td>Description</td>
 	</tr>
 	<tr>
-        <td>execute(<b>command</b>, <b>options</b>)</td>
+        <td>execute(<b>command</b>, [<b>options</b>], [<b>callback</b>])</td>
         <td>
             Executes the COS <b>command</b> right as if it is entered
             to the terminal. However, <b>options</b> provide an
             additional flags setup.<br/>
             <b>options.echo</b> (<b>false</b> by default) - prints the
             <b>command</b> on the screen.<br/>
             <b>options.prompt</b> (<b>false</b> by default) - prompts
-            the user after execution (prints "NAMESPACE > " as well).
+            the user after execution (prints "NAMESPACE > " as well). If <b>callback</b> is passed, 
+            the output buffer will come as a first argument of the <b>callback</b> function.
         </td>
     </tr>
     <tr>
-            <td>onOutput([ <b>options</b> ], <b>callback</b>)</td>
+            <td>onOutput([<b>options</b>], <b>callback</b>)</td>
             <td>
                 By default, <b>callback</b>(<u>strings</u>) will be called before the user is
                 prompted for input, and <code>strings</code> array will always contain an array of 

src/client/js/index.js

@@ -140,16 +140,39 @@ Terminal.prototype.print = function (text) {
     input.reprompt();
 };
 
+let executeCallback = null;
+
 /**
  * Print the text on terminal.
  * @param {string} command
- * @param {boolean=false} echo
- * @param {boolean=false} prompt
+ * @param {{ [echo]: boolean=false, [prompt]: boolean=false }} [options]
+ * @param {function} [callback]
  */
-Terminal.prototype.execute = function (command, { echo = false, prompt = false } = {}) {
-    server.send("Execute", { command, echo: +echo, prompt: +prompt });
+Terminal.prototype.execute = function (command, options, callback) {
+    if (typeof options === "function") {
+        callback = options;
+    }
+    if (typeof options !== "object") {
+        options = {};
+    }
+    server.send("Execute", {
+        command,
+        echo: +(options.echo || 0),
+        prompt: +(options.prompt || 0),
+        bufferOutput: +(typeof callback === "function")
+    });
+    if (typeof callback === "function") {
+        executeCallback = callback;
+    }
 };
 
+export function promptCallback (data) {
+    if (typeof executeCallback === "function") {
+        executeCallback([ data ]);
+        executeCallback = null;
+    }
+}
+
 function initialize () {
     let text = locale.get(`beforeInit`),
         urlParams = getURLParams();

src/client/js/server/handlers.js

@@ -27,6 +27,10 @@ export function prompt (namespace) {
     });
 }
 
+export function promptCallback (data) {
+    terminal.promptCallback(data);
+}
+
 function cleanCWTLabel (string) {
     let s = string.replace(/(\w+(?:\+[0-9]+)?\^(?:\w\.?)+)/, "\x1b[(special)m$1\x1b[0m")
         .replace(/^(<.*>)/, `\x1b[31m$1\x1b[0m`),

src/cls/WebTerminal/Engine.cls

@@ -26,6 +26,12 @@ Property StartupRoutine As %String;
 /// Output flag
 Property echo As %Boolean [ InitialExpression = 1 ];
 
+/// flag which enables output buffering
+Property bufferOutput As %Boolean [ InitialExpression = 0 ];
+
+/// Used to buffer the output ("o" flag) when bufferOutput flag is set
+Property outputBuffer As %Stream.TmpCharacter [ InitialExpression = {##class(%Stream.TmpCharacter).%New()} ];
+
 /// Output flag
 Property handler As %Boolean [ InitialExpression = 0, Private ];
 
@@ -43,6 +49,10 @@ Method GetMessage(timeout As %Integer = 86400) As %ZEN.proxyObject
 /// Do not remove this method in future versions of WebTerminal, it is used by update.
 Method Send(handler As %String = "", data = "") As %Status
 {
+    if (handler = "o") && (..bufferOutput = 1) {
+        do ..outputBuffer.Write(data)
+        return $$$OK
+    }
     return:((handler = "o") && (..echo = 0)) $$$OK
     return:(handler = "o") ..Write("o"_data) // Enables 2013.2 support (no JSON)
     set obj = ##class(%ZEN.proxyObject).%New()

src/cls/WebTerminal/Handlers.cls

@@ -19,6 +19,9 @@ ClassMethod Execute (client As WebTerminal.Engine, data, bareStart As %Boolean =
         if (data.echo = 0) {
             set client.echo = 0
         }
+        if (data.bufferOutput = 1) {
+            set client.bufferOutput = 1
+        }
     } else {
         set command = data
     }
@@ -83,6 +86,15 @@ loop
         if (data.echo = 0) {
             set client.echo = 1
         }
+        if (data.bufferOutput = 1) {
+            set client.bufferOutput = 0
+            set str = ""
+            while ('client.outputBuffer.AtEnd) {
+                set str = str _ client.outputBuffer.Read()
+            }
+            do client.Send("promptCallback", str)
+            do client.outputBuffer.Clear()
+        }
     }
     do:('($IsObject(data) && (data.prompt = 0)) && '(bareStart = 1)) client.Send("prompt", client.childNamespace)
     return $$$OK