NS GET parameter can set default namespace, index.csp file extension in lowercase fix

Author: nikitaeverywhere

CONTRIBUTING.md renamed to DEVELOPMENT.md

@@ -16,4 +16,10 @@ Contributing
     2. If there is no errors, then run <code>grunt export</code> task;
     3. Find build/CWTWebSource.xml file and import it to the studio.
 3. By making changes in studio files (*.cls, *.mac) just copy source code into appropriate files in repository.
-4. If you commented line as the first step says, DO NOT FORGET to uncomment it.
+4. If you commented line as the first step says, DO NOT FORGET to uncomment it.
+
+## Applications Integration
+If you want to integrate WebTerminal with your application, follow the next tips & tricks:
+   * An <code>NS</code> parameter of GET request can set default namespace. For example, URL <code>../WebTerminal/index.csp?NS=USER</code> will open terminal in USER namespace.
+   * In order to use IFrame to insert terminal on page, you may need to add <code>sandbox="allow-same-origin allow-scripts"</code> attribute to IFrame tag to enable storage and scripts which are required.
+   * To get latest version of terminal, you can parse [latestVersion](http://intersystems-ru.github.io/webterminal/latestVersion) file which is always available on WEB and then request XML to import from <code>http://intersystems-ru.github.io/webterminal/files/WebTerminal-<b>{FILE PART}</b>.xml</code>.

Gruntfile.js

@@ -11,7 +11,8 @@ module.exports = function(grunt) {
             FAVICON_ICO: fs.readFileSync("build/webSource/favicon.ico").toString("base64"),
             INDEX_CSP: fs.readFileSync("build/webSource/index.html").toString("utf-8")
                 .replace("é", "é")
-                .replace("createTerminal(", "createTerminal('#(%session.CSPSessionCookie)#'"),
+                .replace("createTerminal(", "createTerminal('#(%session.CSPSessionCookie)#'," +
+                    "'#(%request.Get(\"NS\"))#'"),
             TERMINAL_JS: fs.readFileSync("build/webSource/js/terminal.js").toString("utf-8")
                 .replace(/[\x1B]/g, function(s) { return "\\x" + s.charCodeAt(0).toString(16) })
         };

classes/%WebTerminal.Engine.cls

@@ -796,6 +796,13 @@ Method RequireAuthorization() As %Status
     set authKey = ..Read(, .status, ..#authorizationTimeout) // wait for package
     set ok = $$$NOTOK
 
+    set namespace = ""
+    set pos = $FIND(authKey, "#")
+    if pos '= 0 {
+        set namespace = $EXTRACT(authKey, pos, *)
+        set authKey = $EXTRACT(authKey, 1, pos-2)
+    }
+    
     /*
      * Find given CSPSessionCookie in session list. If found, grant access.
      */
@@ -817,6 +824,12 @@ Method RequireAuthorization() As %Status
                     do ..SendData("!", ..ConstClientLoginInfo)
                 }
 
+                if (namespace '= "") {
+                    try {
+                        zn namespace
+                    } catch (e) { }
+                }
+                
                 set ok = loginStatus
                 QUIT
 

export/exportTemplate.xml

@@ -17,7 +17,7 @@
 </CSPBase64>
 
 
-<CSP name="index.CSP" application="/csp/sys/webterminal/"><![CDATA[
+<CSP name="index.csp" application="/csp/sys/webterminal/"><![CDATA[
 <!-- @echo INDEX_CSP -->]]></CSP>
 
 

webSource/js/CacheWebTerminalServer.js

@@ -135,11 +135,11 @@ CacheWebTerminalServer.prototype.send = function (string) {
  */
 CacheWebTerminalServer.prototype.onConnect = function () {
 
-    var key;
+    var key, ns;
 
     this.CONTROLLER.TERMINAL.output.print(this._lc.get(2) + "\r\n");
     if (key = this.CONTROLLER.TERMINAL.SETUP["authKey"]) {
-        this.send(key);
+        this.send(key + ((ns = this.CONTROLLER.TERMINAL.SETUP.defaultNamespace) ? "#" + ns : ""));
     }
 
 };

webSource/js/Globals.js

@@ -65,12 +65,16 @@ var AJAX = new function() {
  * Initialization function. Exported after build.
  *
  * @param {string} authKey
+ * @param {string} namespace
  */
-this.createTerminal = function (authKey) {
+this.createTerminal = function (authKey, namespace) {
+
+    console.log(namespace);
 
     return new Terminal({
         container: document.body,
-        authKey: authKey || null
+        authKey: authKey || null,
+        defaultNamespace: namespace
     });
 
 };

webSource/js/Terminal.js

@@ -39,7 +39,8 @@
  *
  * @param setting {{
  *     controller: TerminalController,
- *     [container]: HTMLElement
+ *     [container]: HTMLElement,
+ *     defaultNamespace: string
  * }}
  */
 var Terminal = function (setting) {
@@ -92,6 +93,7 @@ var Terminal = function (setting) {
     this.autocomplete = new TerminalAutocomplete();
 
     this.SETUP = {
+        defaultNamespace: setting["defaultNamespace"] || "",
         controller: setting["controller"] || new TerminalController(this),
         container: setting["container"] || document.body,
         authKey: setting["authKey"] || null