Renaming terminal instances feature add

Author: nikitaeverywhere

export/WebTerminal/Common.xml

@@ -61,6 +61,11 @@ How long to wait for authorization key when connection established</Description>
 <Default>U</Default>
 </Parameter>
 
+<Parameter name="ServerActionRename">
+<Type>%Char</Type>
+<Default>RENAME</Default>
+</Parameter>
+
 <Parameter name="ClientPrompt">
 <Type>%String</Type>
 <Default>PROMPT#</Default>

export/WebTerminal/Engine.xml

@@ -1,11 +1,11 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<Export generator="Cache" version="25" zv="Cache for Windows (x86-64) 2015.1.1 (Build 505U)" ts="2015-12-21 13:52:46">
+<Export generator="Cache" version="25" zv="Cache for Windows (x86-64) 2015.3 (Build 215U)" ts="2015-12-27 13:48:44">
 <Class name="WebTerminal.Engine">
 <Description>
 Cache WEB Terminal version X.X.X/*build.replace:pkg.version*/ core.
 This class is the server-side core of the terminal application.</Description>
 <Super>%CSP.WebSocket,Trace,Autocomplete</Super>
-<TimeChanged>63907,49887.419268</TimeChanged>
+<TimeChanged>63913,49707.26915</TimeChanged>
 <TimeCreated>63891,56786.028532</TimeCreated>
 <DependsOn>Common</DependsOn>
 
@@ -617,6 +617,12 @@ Main method for every new client.</Description>
                 do ..SendData($NAMESPACE, ..#ClientPrompt)
             }
 
+        } elseif (action = ..#ServerActionRename) {
+
+            set ^WebTerminal("Name") = data
+            do ..SendData("56", ..#ClientOutputLocalized)
+            do ..SendData($NAMESPACE, ..#ClientPrompt)
+
         } else { // something scary
 
             do ..SendData("38", ..#ClientOutputLocalized)
@@ -629,19 +635,41 @@ Main method for every new client.</Description>
 ]]></Implementation>
 </Method>
 
+<Method name="SendLoginInfo">
+<Description>
+This method sends basic login info to the user. Use this method to set client variables
+during the WebTerminal initialization.</Description>
+<Implementation><![CDATA[
+    set obj = ##class(%ZEN.proxyObject).%New()
+    set obj.username = $USERNAME
+    set obj.name = $get(^WebTerminal("Name"))
+    
+    // "pretty" json formatter
+    set data = "{""system"":""" _ $SYSTEM _ """"
+    set key = $order(obj.%data(""))
+    while (key '= "") {
+        set data = data _ ","""_key_""":"""_obj.%data(key)_""""
+        set key = $order(obj.%data(key))
+    }
+    set data = data _ "}"
+    
+    do ..SendData(data, ..#ClientLoginInfo)
+]]></Implementation>
+</Method>
+
 <Method name="Server">
 <Description>
 New connection established: require auth key, login and start client loop.</Description>
 <ReturnType>%Status</ReturnType>
 <Implementation><![CDATA[
 
-    /*UNCOMMENT ON RELEASE!*/
     if ($$$ISOK(..RequireAuthorization())) {
 
         set ..CurrentNamespace = $Znspace
 
         do ..SendData("1", ..#ClientAuthorizationStatus)
         do ..SendData(..CurrentNamespace, ..#ClientChangeNamespace)
+        do ..SendLoginInfo()
 
         use $io:(/NOXY:/BREAK):"^" _ ..InitialZName
         do ..ClientLoop()

package.json

@@ -3,8 +3,8 @@
   "title": "Cache WEB Terminal",
   "description": "Web-based terminal emulator for Caché administering.",
   "author": "ZitRo",
-  "version": "3.1.8",
-  "releaseNumber": 18,
+  "version": "3.2.0",
+  "releaseNumber": 19,
   "repository": {
     "type": "git",
     "url": "https://github.com/intersystems-ru/webterminal.git"

readme.md

@@ -50,8 +50,8 @@ Type `/help` there to get more information.
 		<td>Access to WebSocket is granted only if client will pass a session key given by csp page.</td>
 	</tr>
 	<tr>
-		<td class="info">Self-update</td>
-		<td>Terminal v3.1.4 can be automatically updated by `/update` command.</td>
+		<td class="info">Self-updating</td>
+		<td>Terminal version 3.1.4 and higher can be automatically updated by using `/update` command.</td>
 	</tr>
 	<tr>
 		<td class="info">Explore!</td>

webSource/js/Terminal.js

@@ -170,6 +170,27 @@ Terminal.prototype.initialize = function () {
 
 };
 
+/**
+ * This function is executed when server instance ready and basic server info is sent to the client.
+ */
+Terminal.prototype.serverInit = function (data) {
+
+    if (typeof data.system === "string") {
+        var nodeInfo = data.system.split(":"); // [PCName, Instance]
+        data.node = nodeInfo[0];
+        data.instance = nodeInfo[1];
+    }
+
+    if (data.node && data.instance) {
+        document.title = (data.name ? data.name + " " : "") + data.instance
+            + " (" + data.node + ")" + " - Caché WEB Terminal";
+        this.output.print(this.localization.get(
+            data.name ? 55 : 54, data.node, data.instance, data.name ? data.name : undefined
+        ) + "\r\n");
+    }
+
+};
+
 /**
  * Function to register execution of other functions when terminal in ready state. (when all
  * modules loaded)

webSource/js/TerminalController.js

@@ -77,7 +77,8 @@ TerminalController.prototype.SERVER_ACTION = {
     RESET: "R#",
     ECHO: "E#",
     CHECK_UPDATE: "CU#",
-    UPDATE: "U#"
+    UPDATE: "U#",
+    RENAME: "RENAME#"
 };
 
 /**
@@ -121,14 +122,6 @@ TerminalController.prototype.internalCommands = {
             return;
         }
 
-//        if (args[0] === "gen") {
-//            this.server.send(this.SERVER_ACTION.AUTOCOMPLETE);
-//        } else {
-//            this.mergeAutocompleteFile(this.NAMESPACE);
-//        }
-//
-//        return false;
-
         this.server.send(this.SERVER_ACTION.AUTOCOMPLETE
             + (!this.autocompleteController.SYSTEM_CLASSES_LOADED
                 || args[0] === "sys" ? "1" : "0"));
@@ -325,6 +318,13 @@ TerminalController.prototype.internalCommands = {
 
         return false;
 
+    },
+
+    "rename": function (args) {
+
+        this.server.send(this.SERVER_ACTION.RENAME + (args[0] || ""));
+        return false;
+
     }
 
 };
@@ -523,7 +523,11 @@ TerminalController.prototype.clientAction = {
     },
 
     I: function (data) {
-        this.TERMINAL.output.print(data + "\r\n");
+
+        var obj = {}; try { obj = JSON.parse(data) } catch (e) {  }
+
+        this.TERMINAL.serverInit(obj);
+
     },
 
     CLRSCR: function () {

webSource/js/TerminalLocalization.js

@@ -52,6 +52,8 @@ var TerminalLocalization = function (TERMINAL) {
                 "autocomplete again, use " +
                 "\x1B[1msys\x1B[0m parameter.\r\n" +
                 "\x1B[33m/echo\x1B[0m [param1] [param2] ...\x1B[32GEcho each argument of this command." +
+                "\r\n\x1B[33m/rename\x1B[0m [name]\x1B[32GSpecify a name for the terminal instance. This name " +
+                "will be shown after terminal startup and as a page title. Empty argument will remove specified name." +
                 "\r\n\x1B[33m/trace\x1B[0m [global/filePath]\x1B[32GStart tracing global or file. To stop " +
                 "tracing, enter command without arguments. To stop tracing particular file or " +
                 "global, enter trace command again.\r\n" +
@@ -77,6 +79,8 @@ var TerminalLocalization = function (TERMINAL) {
                 "в ваш код или хотите обновить автодополнение системных классов, воспользуйтесь параметром " +
                 "\x1B[1msys\x1B[0m.\r\n" +
                 "\x1B[33m/echo\x1B[0m [параметр1] [второй] ...\x1B[32GОтображает каждый аргумент команды." +
+                "\r\n\x1B[33m/rename\x1B[0m [name]\x1B[32GУстановить имя для экземпляра терминала. Это имя " +
+                "будет показано после загрузки терминала и как заголовок страницы. Пустой аргумент уберёт установленное имя." +
                 "\r\n\x1B[33m/trace\x1B[0m [глобал/путь]\x1B[32GНаблюдать за изменениями в файле или глобале. Чтобы " +
                 "перестать наблюдать за изменениями, введите команду ещё раз. Команда без аргументов" +
                 " остановит наблюдение за всеми файлами и глобалами.\r\n" +
@@ -336,6 +340,20 @@ var TerminalLocalization = function (TERMINAL) {
         53: {
             en: "Loaded.",
             ru: "Загружено."
+        },
+        54: {
+            en: "System %s, user %s.",
+            ru: "Система %s, пользователь %s."
+        },
+        55: {
+            en: "System %s, user %s, name: %s.",
+            ru: "Система %s, пользователь %s, имя: %s."
+        },
+        56: {
+            en: "Terminal instance name changed successfully. Please, reload the page to see" +
+                " the changes.",
+            ru: "Экземпляр терминала переименован успешно. Пожалуйста, обновите страницу чтобы" +
+                " увидеть изменения."
         }
     };