^WebTerminal global mapping

Author: nikitaeverywhere

export/WebTerminal/Autocomplete.xml

@@ -8,7 +8,7 @@
 <Method name="AutocompleteExists">
 <FormalSpec>namespace:%String</FormalSpec>
 <ReturnType>%Boolean</ReturnType>
-<Implementation><![CDATA[    quit $get(^%WebTerminal.Autocomplete(namespace)) '= ""
+<Implementation><![CDATA[    quit $get(^WebTerminal("Autocomplete", namespace)) '= ""
 ]]></Implementation>
 </Method>
 
@@ -114,7 +114,7 @@ system classes generates one time and forever.
     if ('genSystem) set ac = ac _ ",""global"":" _ ..getGlobalsJSON()
     set ac = ac _ "}"
 
-    set ^%WebTerminal.Autocomplete(trueNs) = ac
+    set ^WebTerminal("Autocomplete", trueNs) = ac
 
     do ..SendData($C(13, 10))
     do ..SendData("33", ..#ClientOutputLocalized)
@@ -132,7 +132,7 @@ Returns terminal to default state</Description>
 <ReturnType>%Status</ReturnType>
 <Implementation><![CDATA[
     // delete autocompletion files
-    kill ^%WebTerminal.Autocomplete
+    kill ^WebTerminal("Autocomplete")
     quit $$$OK
 ]]></Implementation>
 </Method>

export/WebTerminal/Engine.xml

@@ -477,9 +477,9 @@ the client - it includes authorization key.</Description>
     /*
      * Find given CSPSessionCookie in WebTerminal auth global. If found, grant access.
      */
-    SET key = $ORDER(^%WebTerminal.AuthUser(""))
+    SET key = $ORDER(^WebTerminal("AuthUser", ""))
     WHILE (key '= "") {
-        set lb = $GET(^%WebTerminal.AuthUser(key))
+        set lb = $GET(^WebTerminal("AuthUser", key))
         if ((lb '= "") && (key = authKey)) {
 
             // setup privileges
@@ -493,7 +493,7 @@ the client - it includes authorization key.</Description>
             set namespace = $case(namespace, "":userProps("NameSpace"), :namespace)
             set loginStatus = $System.Security.Login(username) // login user
 
-            kill ^%WebTerminal.AuthUser(key)
+            kill ^WebTerminal("AuthUser", key)
 
             set ok = loginStatus
 
@@ -502,10 +502,10 @@ the client - it includes authorization key.</Description>
         // kill "old" auth tickets
         set time = $LISTGET(lb, 2)
         if (time '= "") && ($System.SQL.DATEDIFF("s", time, $h) > 100) { // if older than 100 sec
-            kill ^%WebTerminal.AuthUser(key)
+            kill ^WebTerminal("AuthUser", key)
         }
 
-        SET key = $ORDER(^%WebTerminal.AuthUser(key))
+        SET key = $ORDER(^WebTerminal("AuthUser", key))
     }
 
     if (namespace '= "") {

export/WebTerminal/Installer.xml

@@ -23,7 +23,7 @@ This method is invoked when a class is compiled.</Description>
 <FormalSpec><![CDATA[cls:%String,&params]]></FormalSpec>
 <ReturnType>%Status</ReturnType>
 <Implementation><![CDATA[
-    set ns = $NAMESPACE
+    set ns = $NAMESPACE // has to be package home namespace!
     zn:ns'="%SYS" "%SYS"
     do ##class(Security.System).GetInstallationSecuritySetting(.security)
     set cspProperties("AutheEnabled") = 32 // password by default, 64 for no password
@@ -73,9 +73,9 @@ This method is invoked when a class is compiled.</Description>
         continue:(ns = value)
         w " ", value
         set status = ##Class(Config.MapPackages).Create(value, "WebTerminal", .Properties)
-        if ($$$ISERR(status)) {
-            do $SYSTEM.Status.DisplayError(status)
-        }
+        if ($$$ISERR(status)) { do $SYSTEM.Status.DisplayError(status) }
+        set status = ##Class(Config.MapGlobals).Create(value, "WebTerminal", .Properties)
+        if ($$$ISERR(status)) { do $SYSTEM.Status.DisplayError(status) }
     }
     w ".", !, "Mapping complete."
     w !, "WebTerminal package successfully mapped into all namespaces."
@@ -91,7 +91,7 @@ This method is invoked when a class is 'uncompiled'.</Description>
 <FormalSpec><![CDATA[cls:%String,&params,recompile:%Boolean]]></FormalSpec>
 <ReturnType>%Status</ReturnType>
 <Implementation><![CDATA[
-    set ns = $NAMESPACE
+    set ns = $NAMESPACE // has to be package home namespace!
     zn:ns'="%SYS" "%SYS"
     if (##class(Security.Applications).Exists("/terminal")) {
         do ##class(Security.Applications).Get("/terminal", .props)
@@ -112,13 +112,14 @@ This method is invoked when a class is 'uncompiled'.</Description>
         continue:(ns = value)
         w " ", value
         set status = ##Class(Config.MapPackages).Delete(value, "WebTerminal")
-        if ($$$ISERR(status)) {
-            do $SYSTEM.Status.DisplayError(status)
-        }
+        if ($$$ISERR(status)) { do $SYSTEM.Status.DisplayError(status) }
+        set status = ##Class(Config.MapGlobals).Delete(value, "WebTerminal")
+        if ($$$ISERR(status)) { do $SYSTEM.Status.DisplayError(status) }
     }
     w ".", !, "Unmapping complete."
-    kill ^%WebTerminal.Autocomplete
     zn:ns'="%SYS" ns
+    kill ^WebTerminal
+    w !, "Global ^WebTerminal removed."
     QUIT $$$OK
 ]]></Implementation>
 </Method>

export/WebTerminal/Router.xml

@@ -30,7 +30,7 @@ Method returns autocomplete data in JSON format</Description>
     set namespace = %request.Get("NS", $znspace)
     set %response.CharSet = "utf-8"
     set %response.ContentType = "application/json"
-    write $get(^%WebTerminal.Autocomplete(namespace), "{}")
+    write $get(^WebTerminal("Autocomplete", namespace), "{}")
     return $$$OK
 ]]></Implementation>
 </Method>
@@ -102,7 +102,7 @@ Method writes application HTML.</Description>
 <Implementation><![CDATA[
     set cookie = %session.CSPSessionCookie
     // Put the name of authorized user in a global to authorize WebSocket WebTerminal connection
-    set ^%WebTerminal.AuthUser(cookie) = $LB(
+    set ^WebTerminal("AuthUser", cookie) = $LB(
         $LISTGET(%session.SecurityContext, 1), // username
         $horolog // granting ticket date
     )

package.json

@@ -3,7 +3,7 @@
   "title": "Cache WEB Terminal",
   "description": "Web-based terminal emulator for Caché administering.",
   "author": "ZitRo",
-  "version": "3.1.7",
+  "version": "3.1.8",
   "releaseNumber": 18,
   "repository": {
     "type": "git",

readme.md

@@ -9,7 +9,7 @@ and import XML file into %SYS namespace. Later you can update application only b
 
 ### Usage
 After installation, you will be able to access application at `http://[host]:[port]/terminal/` (slash at the end is required).
-Type "/help" there to get more information.
+Type `/help` there to get more information.
 
 ### Features
 <table>