Clean start option add, hidden API remove (CleanStart), start namespace errors fix

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.13",
+  "version": "4.0.0-beta.14",
   "gaID": "UA-83005064-2",
   "releaseNumber": 26,
   "scripts": {

readme.md

@@ -93,11 +93,16 @@ To embed WebTerminal to any other web application, you can use `<iframe>` tag.
 Example:
 
 ```html
-<iframe id="terminal" src="http://127.0.0.1:57772/terminal/?NS=SAMPLES"></iframe>
+<iframe id="terminal" src="http://127.0.0.1:57772/terminal/?ns=SAMPLES&clean=1"></iframe>
 ```
 
-Note that terminal URL may include optional `NS` GET parameter, which specifies namespace
-where WebTerminal's session will start.
+Note that terminal URL may include optional GET parameters, which are the next:
+
++ `ns=USER` Namespace to open terminal in. If the logged user has no access to this namespace,
+the error message will appear and no namespace changes will occur.
++ `clean` Start the WebTerminal without any additional information printed. It is not recommended to
+use this option if you are using terminal as a stand-alone tool (for everyday use), as you can miss
+important updates.
 
 To use WebTerminal's API, you need to get WebTerminal instance first. Use iframe's
 `onTerminalInit` function to get it.

src/client/js/index.js

@@ -101,8 +101,17 @@ function initialize () {
     terminal = new Terminal();
 
     output.printLine(text);
-    let ns = urlParams["NS"] || urlParams["ns"] || config.get("defaultNamespace");
-    get("auth" + (ns ? `?NS=${ encodeURIComponent(ns) }` : ""), (obj) => {
+    let ns = urlParams["NS"] || urlParams["ns"] || config.get("defaultNamespace"),
+        urlPs = location.search.match(/ns=[^&]*/i) === null
+            ? location.search === ""
+                ? ns
+                    ? `?ns=${ encodeURIComponent(ns) }`
+                    : ""
+                : location.search + (ns ? `&ns=${ encodeURIComponent(ns) }` : "")
+            : ns
+                ? location.search.replace(/ns=[^&]*/i, `ns=${ encodeURIComponent(ns) }`)
+                : location.search;
+    get("auth" + urlPs, (obj) => {
         if (!obj.key) {
             output.printLine(locale.get(`unSerRes`), JSON.stringify(obj));
             return;

src/client/js/localization/dictionary.js

@@ -344,5 +344,9 @@ export default {
     "unLogOut": {
         en: "Your browser is too old or too weird to support log out functionality. Please, restart the browser manually.",
         ru: "Ваш браузер слишком странный или старый, и он не поддерживает функциональность выхода. Пожалуйста, перезапустите браузер вручную."
+    },
+    "unNS": {
+        en: "Unable to change namespace to %s.",
+        ru: "Не получается поменять область на %s."
     }
 };

src/cls/WebTerminal/Engine.cls

@@ -86,8 +86,9 @@ Method ExecuteSQL(query As %String = "") As %Status
     quit $$$OK
 }
 
-/// This method holds process and expects only one package from
-/// the client - it includes authorization key.
+/// This method performs the authorization and login to WebTerminal.
+/// It returns a list with data (see Router.Auth method), which is used then to set up the
+/// initial values for the client.
 Method RequireAuthorization() As %List
 {
     set data = ..GetMessage(..#AuthorizationTimeout)
@@ -115,10 +116,13 @@ Method RequireAuthorization() As %List
     set username = $LISTGET(list, 1)
     set namespace = $LISTGET(list, 3)
     set ns = $Namespace
+
     znspace "%SYS"
     do ##class(Security.Users).Get(username, .userProps)
     znspace ns
 
+    set namespace = $case(namespace, "":userProps("NameSpace"), :namespace)
+
     if ($get(userProps("Routine")) '= "") {
         set ..StartupRoutine = userProps("Routine")
     }
@@ -127,14 +131,14 @@ Method RequireAuthorization() As %List
         return $LB("User " _ username _ " is not enabled in the system")
     }
 
-    set namespace = $case(namespace, "":userProps("NameSpace"), :namespace)
+    set $LIST(list, 3) = namespace
     set loginStatus = $System.Security.Login(username)
 
     if (loginStatus '= 1) {
         return $LB($System.Status.GetErrorText(loginStatus))
     }
 
-    return $LB("", namespace)
+    return $LB("", list)
 }
 
 /// See WebTerminal.Handlers
@@ -190,12 +194,13 @@ loopEnd
 
 /// This method sends basic login info to the user. Use this method to set client variables
 /// during the WebTerminal initialization.
-Method SendLoginInfo()
+/// <parameter>authList</parameter> See Router.Auth method.
+Method SendLoginInfo(authList As %List)
 {
     set obj = ##class(%ZEN.proxyObject).%New()
     set obj.username = $USERNAME
     set obj.name = $get(^WebTerminal("Name"))
-    set obj.cleanStart = $data(^WebTerminal("CleanStart"))
+    set obj.cleanStart = $ListGet(authList, 4)
     set obj.system = $SYSTEM
     set obj.firstLaunch = ($get(^WebTerminal("FirstLaunch"), 1) '= 0)
     set obj.InstanceGUID = ##class(%SYS.System).InstanceGUID()
@@ -207,15 +212,22 @@ Method SendLoginInfo()
 /// Triggered when new connection established.
 Method Server() As %Status
 {
-    set authRes = ..RequireAuthorization() // $LB("", $Namespace)
+    set authRes = ..RequireAuthorization()
     set authMessage = $ListGet(authRes, 1)
     if (authMessage = "") {
-        set namespace = $ListGet(authRes, 2)
-        if (namespace '= "") {
-            try { znspace namespace } catch (e) { }
+        set authList = $ListGet(authRes, 2) // see Router.Auth method
+        set namespace = $ListGet(authList, 3)
+        if (namespace '= "") && (namespace '= $Namespace) {
+            try {
+                znspace namespace
+            } catch (e) {
+                do ..Send("oLocalized",
+                    $Char(27) _ "[31m%unNS(" _ namespace _ ")"_ $Char(27) _ "[0m" _ $Char(13,10)
+                )
+            }
         }
         set ..CurrentNamespace = $Namespace
-        do ..SendLoginInfo()
+        do ..SendLoginInfo(authList)
         do ..ClientLoop()
         do ..Send("oLocalized", "%wsNormalClose"_$C(13,10))
     } else {

src/cls/WebTerminal/Router.cls

@@ -37,10 +37,11 @@ ClassMethod WriteStatic(type As %String, ContentType As %String = "") [ Private
 ClassMethod Auth() As %Status
 {
     set cookie = $System.Encryption.Base64Encode(%session.Key)
-    set ^WebTerminal("AuthUser", cookie) = $LB(
+    set ^WebTerminal("AuthUser", cookie) = $LB( // authList
         $Username, // username
         $Horolog, // granting ticket date
-        $Get(%request.Data("NS", 1))
+        $Get(%request.Data("ns", 1), $Get(%request.Data("NS", 1))),
+        $Get(%request.Data("clean", 1), 0) '= 0
     )
     write "{""key"":""" _ cookie _ """}"
     return $$$OK