Startup routine support

Author: nikitaeverywhere

package.json

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

src/client/js/localization/dictionary.js

@@ -330,5 +330,9 @@ export default {
     "jsErr": {
         en: "JavaScript error occurred: %s",
         ru: "Произошла ошибка JavaScript: %s"
+    },
+    "wsNormalClose": {
+        en: "Session ended.",
+        ru: "Сессия закончена."
     }
 };

src/client/js/server/index.js

@@ -78,7 +78,7 @@ function reconnect () {
 
 function onClose (e) {
     CONNECTED = false;
-    if (e.code !== 1000) {
+    if (e.code !== 1000 && e.code !== 1005) {
         printLine(`\r\n${ localize(`wsConnLost`, e.code, e.reason ? " " + e.reason : "") }`);
         printLine(localize(`reConn`, RECONNECT_IN / 1000));
         reconnectTimeout = setTimeout(reconnect, RECONNECT_IN);

src/cls/WebTerminal/Core.cls

@@ -69,23 +69,35 @@ ClassMethod WaitCommand() As %String [ ProcedureBlock = 1 ]
 }
 
 /// Starts new terminal loop. Must be called with JOB command.
-ClassMethod Loop() As %Status
+ClassMethod Loop(StartupRoutine As %String = "") As %Status
 {
 	if ($ZPARENT = 0) {
-		write "This method is for JOB use only."
-		return 0
-	}
-	open "terminal"::"^%X364"
-	use $io::"^" _ $ZName
-	kill // kill any temporary variables ProcedureBlock may have
-	for {
-	    do ##class(%Device).ReDirectIO($$$YES)
-	    set $ZERROR = ""
-    	try { xecute ..WaitCommand() } catch {}
-    	do ##class(%Device).ReDirectIO($$$NO)
-	    do ..SendChunk($ZPARENT, "e", $LISTBUILD($NAMESPACE, $ZERROR))
-	}
-	quit $$$OK
+        write "This method is for JOB use only."
+        return 0
+    }
+    open "terminal"::"^%X364"
+    use $io::"^" _ $ZName
+    if (StartupRoutine '= "") {
+        do ##class(%Device).ReDirectIO($$$YES)
+        try {
+            do @StartupRoutine
+            do ##class(%Device).ReDirectIO($$$NO)
+        } catch {
+            do ##class(%Device).ReDirectIO($$$NO)
+            do ..SendChunk($ZPARENT, "e", $LISTBUILD($NAMESPACE, $ZERROR))
+        }
+        do ..SendChunk($ZPARENT, "e", $LISTBUILD($NAMESPACE, ""))
+        return $$$OK
+    }
+    kill // kill any temporary variables ProcedureBlock may have
+    for {
+        do ##class(%Device).ReDirectIO($$$YES)
+        set $ZERROR = ""
+        try { xecute ..WaitCommand() } catch {}
+        do ##class(%Device).ReDirectIO($$$NO)
+        do ..SendChunk($ZPARENT, "e", $LISTBUILD($NAMESPACE, $ZERROR))
+    }
+    return $$$OK
 }
 
 }

src/cls/WebTerminal/Engine.cls

@@ -18,6 +18,8 @@ Property corePID As %Numeric [ InitialExpression = 0 ];
 /// The last known namespace in child process.
 Property childNamespace As %String;
 
+Property StartupRoutine As %String;
+
 /// Output flag
 Property echo As %Boolean [ InitialExpression = 1 ];
 
@@ -117,6 +119,10 @@ Method RequireAuthorization() As %List
     do ##class(Security.Users).Get(username, .userProps)
     znspace ns
 
+    if ($get(userProps("Routine")) '= "") {
+        set ..StartupRoutine = userProps("Routine")
+    }
+
     if $get(userProps("Enabled")) '= 1 {
         return $LB("User " _ username _ " is not enabled in the system")
     }
@@ -145,14 +151,20 @@ Method ProcessRequest(handler As %String, data) As %Status [ Private ]
 /// Main method for every new client.
 Method ClientLoop() As %Status [ Private ]
 {
-    job ##class(WebTerminal.Core).Loop():($NAMESPACE)
+    job ##class(WebTerminal.Core).Loop(..StartupRoutine):($NAMESPACE)
     if ($TEST '= 1) {
         do ..Send("error", "%noJob")
         return $$$NOTOK
     }
     set ..corePID = $ZCHILD
     set ..childNamespace = $NAMESPACE
-    do ..Send("prompt", ..childNamespace)
+    if (..StartupRoutine = "") {
+        do ..Send("prompt", ..childNamespace)
+    } else {
+        set message = ##class(%ZEN.proxyObject).%New()
+        set status = $CLASSMETHOD("WebTerminal.Handlers", "Execute", $this, "", 1)
+        goto loopEnd
+    }
     //try { // temp
     for {
         set message = ..GetMessage()
@@ -171,7 +183,9 @@ Method ClientLoop() As %Status [ Private ]
             continue
         }
     }
+loopEnd
     //} catch (e) {  do ..Send("o", $System.Status.GetErrorText(e)) } // temp
+    return $$$OK
 }
 
 /// This method sends basic login info to the user. Use this method to set client variables
@@ -203,12 +217,11 @@ Method Server() As %Status
         set ..CurrentNamespace = $Namespace
         do ..SendLoginInfo()
         do ..ClientLoop()
-        do ..Send("oLocalized", "%wsAbnormal")
+        do ..Send("oLocalized", "%wsNormalClose"_$C(13,10))
     } else {
         do ..Send("oLocalized", "%wsRefuse(" _ authMessage _ ")")
-        do ..EndServer()
     }
-
+    do ..EndServer()
     quit $$$OK
 }
 

src/cls/WebTerminal/Handlers.cls

@@ -11,8 +11,9 @@ Class WebTerminal.Handlers
 
 /// data can be either string or %ZEN.proxyObject. In case of proxyObject, the command is hold in
 /// data.command property, and it may have some other control properties.
-ClassMethod Execute (client As WebTerminal.Engine, data) As %Status
+ClassMethod Execute (client As WebTerminal.Engine, data, bareStart As %Boolean = 0) As %Status
 {
+    if (bareStart) goto loop
     if $IsObject(data) {
         set command = data.command
         if (data.echo = 0) {
@@ -23,6 +24,7 @@ ClassMethod Execute (client As WebTerminal.Engine, data) As %Status
     }
     do client.Send("o", $CHAR(13, 10))
     do client.SendChunk(client.corePID, "m", command)
+loop
     for {
         set message = client.ReceiveChunk()
         set flag = $LISTGET(message, 1)
@@ -57,7 +59,7 @@ ClassMethod Execute (client As WebTerminal.Engine, data) As %Status
             set client.echo = 1
         }
     }
-    do:('($IsObject(data) && (data.prompt = 0))) client.Send("prompt", client.childNamespace)
+    do:('($IsObject(data) && (data.prompt = 0)) && '(bareStart = 1)) client.Send("prompt", client.childNamespace)
     return $$$OK
 }