Repository refactoring & cleanup, gathering XML classes into the one project

Author: nikitaeverywhere

DEVELOPMENT.md

@@ -7,16 +7,19 @@ Contributing
 * Feel free to create a discussion or a new issue for every new contribution.
 
 ## Building tips
-0. Ensure that you have NodeJS (npm as well) installed, and executed the following:
-    1. `npm install` (to install all required dependencies).
+0. Ensure that you have NodeJS (npm as well) installed, and executed the following in the project directory:
+    1. `npm install` to install all required dependencies;
+    2. `npm install -g gulp` to install gulp builder globally (may be optional if you know how to trigger gulp without global binding);
 1. Having changes made, export the project:
     1. Run `gulp` command to build the project;
     3. Find `build/CacheWebTerminal-v*.xml` file and import it to the studio.
-2. By making changes in studio files (*.cls, *.mac) just export the code into appropriate files in repository. (insert changes by copying them into `export/template.xml` file)
+2. By making changes in studio files (*.cls) just export the code into `export` repository directory.
+    1. NOTE: Some files as `WebTerminal/StaticContent.xml` contain special tags like `{{replace:*}}`, so that files cannot be directly imported from studio without modifying. Please, check file differences to ensure that you haven't rewritten any of those;
+    2. NOTE: When creating or changing classes, put their XML files into `export/WebTerminal` directory or any sub-directory which will be built as sub-packages. 
 
 ## Applications Integration
 If you want to integrate WebTerminal with your application, follow the next tips & tricks:
-   * A `NS` parameter of GET request can set default namespace. For example, URL `../terminal/?NS=USER` will open terminal in USER namespace.
-   * In order to use IFrame to insert terminal on page, you may need to add `sandbox="allow-same-origin allow-scripts"` 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 `http://intersystems-ru.github.io/webterminal/files/WebTerminal-<b>{FILE PART}</b>.xml`.
+   * A `NS` parameter of GET request can set default namespace. For example, URL `../terminal/?NS=USER` will open terminal in USER namespace;
+   * In order to use IFrame to insert terminal on page, you may need to add `sandbox="allow-same-origin allow-scripts"` 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 `http://intersystems-ru.github.io/webterminal/files/WebTerminal-<b>{FILE PART}</b>.xml`;
    * Web Terminal is able to auto-update itself, just execute `/update` command in the terminal.

export/template.xml export/WebTerminal/Engine.xmlexport/template.xml renamed to export/WebTerminal/Engine.xml

@@ -1,10 +1,11 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<Export generator="Cache" version="25">
+<Export generator="Cache" version="25" zv="Cache for Windows (x86-64) 2015.3 (Build 215U)" ts="2015-12-15 14:54:57">
 <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,%Library.Routine</Super>
+<TimeChanged>63899,77962</TimeChanged>
 <TimeCreated>63891,56786.028532</TimeCreated>
 
 <UDLText name="T">
@@ -1125,314 +1126,4 @@ New connection established: require auth key, login and start client loop.</Desc
 ]]></Implementation>
 </Method>
 </Class>
-
-
-<Class name="WebTerminal.Installer">
-<Description>
-Importing this class will install Cache WEB Terminal properly.</Description>
-<CompileAfter>Engine,Router,StaticContent</CompileAfter>
-<Super>%Projection.AbstractProjection</Super>
-<TimeChanged>63898,2021.685611</TimeChanged>
-<TimeCreated>63890,71053.144208</TimeCreated>
-
-<Parameter name="DispatchClass">
-<Default>WebTerminal.Router</Default>
-</Parameter>
-
-<Projection name="Reference">
-<Type>Installer</Type>
-</Projection>
-
-<Method name="CreateProjection">
-<Description>
-This method is invoked when a class is compiled.</Description>
-<ClassMethod>1</ClassMethod>
-<FormalSpec><![CDATA[cls:%String,&params]]></FormalSpec>
-<ReturnType>%Status</ReturnType>
-<Implementation><![CDATA[
-    set ns = $NAMESPACE
-    zn:ns'="%SYS" "%SYS"
-    do ##class(Security.System).GetInstallationSecuritySetting(.security)
-    set cspProperties("AutheEnabled") = 32 // password by default, 64 for no password
-    set cspProperties("NameSpace") = ns // terminal works only in %SYS namespace, only in % package
-    set cspProperties("Description") = "A WEB application for Cache WEB Terminal."
-    set cspProperties("IsNameSpaceDefault") = 0
-    set cspProperties("DispatchClass") = ..#DispatchClass
-    if ('##class(Security.Applications).Exists("/terminal")) {
-        w !, "Creating WEB application ""/terminal""..."
-        set tSC = ##class(Security.Applications).Create("/terminal", .cspProperties)
-        if $$$ISERR(tSC) throw ##class(%Installer.Exception).CreateFromStatus(tSC)
-        w !, "WEB application ""/terminal"" is created."
-        //set ^SYS("Security", "CSP", "AllowClass", "/terminal/", ..#DispatchClass) = 1
-    } else {
-        do ##class(Security.Applications).Get("/terminal", .props)
-        if (props("DispatchClass") '= ..#DispatchClass) {
-            w !, "WARNING! WEB application ""/terminal"" exists but does not refer to ",
-                DispatchClass, ".", !, "Please, set correct dispatch class for this application ",
-                "or create a terminal WEB-application manually."
-        } else {
-            w !, "WEB application ""/terminal"" already exists, so it is ready to use."
-        }
-    }
-    set status = ##Class(Config.Namespaces).Get("%All")
-    if ($$$ISERR(status)) { // no namespace %All
-        w !, "Creating %All namespace..."
-        set Properties("Globals") = "CACHETEMP"
-        set Properties("Library") = "CACHELIB"
-        set Properties("Routines") = "CACHETEMP"
-        set Properties("SysGlobals") = "CACHESYS"
-        set Properties("SysRoutines") = "CACHESYS"
-        set Properties("TempGlobals") = "CACHETEMP"
-        set status = ##Class(Config.Namespaces).Create("%All", .Properties)
-        if ($$$ISERR(status)) {
-            do $System.Status.DisplayError(status)
-            quit status
-        } else {
-            w !, "%All namespace is created."
-        }
-    }
-    w !, "Mapping %WebTerminal package into all namespaces:"
-    set mapTo = $LISTBUILD("%All", "SAMPLES", "DOCBOOK")
-    do ##Class(Config.Namespaces).Get("USER", .InstallNSProps)
-    set Properties("Database") = $get(InstallNSProps("Routines"))
-    set ptr = 0
-    while $LISTNEXT(mapTo, ptr, value) {
-        continue:(ns = value)
-        w " ", value
-        set status = ##Class(Config.MapPackages).Create(value, "WebTerminal", .Properties)
-        if ($$$ISERR(status)) {
-            do $SYSTEM.Status.DisplayError(status)
-        }
-    }
-    w ".", !, "Mapping complete."
-    w !, "WebTerminal package successfully mapped into all namespaces."
-    zn:ns'="%SYS" ns
-    quit $$$OK
-]]></Implementation>
-</Method>
-
-<Method name="RemoveProjection">
-<Description>
-This method is invoked when a class is 'uncompiled'.</Description>
-<ClassMethod>1</ClassMethod>
-<FormalSpec><![CDATA[cls:%String,&params,recompile:%Boolean]]></FormalSpec>
-<ReturnType>%Status</ReturnType>
-<Implementation><![CDATA[
-    set ns = $NAMESPACE
-    zn:ns'="%SYS" "%SYS"
-    if (##class(Security.Applications).Exists("/terminal")) {
-        do ##class(Security.Applications).Get("/terminal", .props)
-        if (props("DispatchClass") '= ..#DispatchClass) {
-            w !, "Won't remove WEB-application ""/terminal"" because it does not refer to ",
-                "dispatch class anymore."
-        } else {
-            w !, "Deleting WEB application ""/terminal""..."
-            do ##class(Security.Applications).Delete("/terminal")
-            kill ^SYS("Security", "CSP", "AllowClass", "/terminal/", ..#DispatchClass)
-            w !, "WEB application ""/terminal"" was successfully removed."
-        }
-    }
-    w !, "Unmapping %WebTerminal package from all namespaces:"
-    set mapTo = $LISTBUILD("%All", "SAMPLES", "DOCBOOK")
-    set ptr = 0
-    while $LISTNEXT(mapTo, ptr, value) {
-        continue:(ns = value)
-        w " ", value
-        set status = ##Class(Config.MapPackages).Delete(value, "WebTerminal")
-        if ($$$ISERR(status)) {
-            do $SYSTEM.Status.DisplayError(status)
-        }
-    }
-    w ".", !, "Unmapping complete."
-    kill ^%WebTerminal.Autocomplete
-    zn:ns'="%SYS" ns
-    QUIT $$$OK
-]]></Implementation>
-</Method>
-</Class>
-
-
-<Class name="WebTerminal.Router">
-<Description>
-The REST interface: class that routes HTTP requests</Description>
-<CompileAfter>StaticContent</CompileAfter>
-<Super>%CSP.REST</Super>
-<TimeCreated>63890,69646.001045</TimeCreated>
-
-<XData name="UrlMap">
-<Data><![CDATA[
-<Routes>
-   <Route Url="/" Method="GET" Call="Index"/>
-   <Route Url="/index" Method="GET" Call="Index"/>
-   <Route Url="/css/terminal.css" Method="GET" Call="GetCss"/>
-   <Route Url="/css/terminal-theme/:theme" Method="GET" Call="GetTheme"/>
-   <Route Url="/js/terminal.js" Method="GET" Call="GetJs"/>
-   <Route Url="/autocomplete" Method="GET" Call="WriteAutocomplete"/>
-</Routes>
-]]></Data>
-</XData>
-
-<Method name="WriteAutocomplete">
-<Description>
-Method returns autocomplete data in JSON format</Description>
-<ClassMethod>1</ClassMethod>
-<ReturnType>%Status</ReturnType>
-<Implementation><![CDATA[
-    set namespace = %request.Get("NS", $znspace)
-    set %response.CharSet = "utf-8"
-    set %response.ContentType = "application/json"
-    write $get(^%WebTerminal.Autocomplete(namespace), "{}")
-    return $$$OK
-]]></Implementation>
-</Method>
-
-<Method name="WriteStatic">
-<Description>
-Calls StaticContent.Write method or sends not modified header. Type have to be "css" or "js"</Description>
-<ClassMethod>1</ClassMethod>
-<FormalSpec>type:%String,Auth:%String="",ContentType:%String=""</FormalSpec>
-<Private>1</Private>
-<Implementation><![CDATA[
-    #define CompileTime ##Expression("""" _ $zd($h, 11) _ ", "_ $zdt($NOW(0), 2,1) _ " GMT""")
-    set %response.CharSet = "utf-8"
-    set %response.ContentType = $case(type,
-        "css": "text/css",
-        "js": "text/javascript",
-        "html": "text/html",
-        : $case(ContentType="", 1:"text/plain", :ContentType)
-    )
-    do %response.SetHeader("Last-Modified", $$$CompileTime)
-
-    if (%request.GetCgiEnv("HTTP_IF_MODIFIED_SINCE")=$$$CompileTime) && (Auth = "") {
-        set %response.Status = "304 Not Modified"
-    } else {
-        do ##class(StaticContent).Write(type, Auth)
-    }
-]]></Implementation>
-</Method>
-
-<Method name="GetCss">
-<Description>
-Method writes application CSS.</Description>
-<ClassMethod>1</ClassMethod>
-<ReturnType>%Status</ReturnType>
-<Implementation><![CDATA[
-    do ..WriteStatic("css")
-    return $$$OK
-]]></Implementation>
-</Method>
-
-<Method name="GetTheme">
-<Description>
-Method writes application theme.</Description>
-<ClassMethod>1</ClassMethod>
-<FormalSpec>Theme:%String</FormalSpec>
-<ReturnType>%Status</ReturnType>
-<Implementation><![CDATA[
-    do ..WriteStatic("Theme"_$REPLACE(Theme, ".css", ""),,"text/css")
-    return $$$OK
-]]></Implementation>
-</Method>
-
-<Method name="GetJs">
-<Description>
-Method writes application JavaScript.</Description>
-<ClassMethod>1</ClassMethod>
-<ReturnType>%Status</ReturnType>
-<Implementation><![CDATA[
-    do ..WriteStatic("js")
-    return $$$OK
-]]></Implementation>
-</Method>
-
-<Method name="Index">
-<Description>
-Method writes application HTML.</Description>
-<ClassMethod>1</ClassMethod>
-<ReturnType>%Status</ReturnType>
-<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(
-        $LISTGET(%session.SecurityContext, 1), // username
-        $horolog // granting ticket date
-    )
-    do ..WriteStatic("html", cookie)
-    return $$$OK
-]]></Implementation>
-</Method>
-</Class>
-
-
-<Class name="WebTerminal.StaticContent">
-<Description>
-This class holds whole application static content like scripts and styles.
-Do not edit this file - use external tool to generate it.</Description>
-<TimeCreated>63890,69938.115592</TimeCreated>
-
-<Method name="Write">
-<Description>
-Write the contents of xData tag</Description>
-<ClassMethod>1</ClassMethod>
-<FormalSpec>Const:%String,Auth:%String</FormalSpec>
-<ReturnType>%Status</ReturnType>
-<Implementation><![CDATA[
-    set Auth = $get(Auth, "")
-    set obj = ##class(%Dictionary.CompiledXData).%OpenId("WebTerminal.StaticContent||"_Const)
-    quit:(obj = "") $$$OK
-    set xdata = obj.Data
-    set status=##class(%XML.TextReader).ParseStream(xdata, .textreader)
-    while textreader.Read() { if (textreader.NodeType="chars") {
-        if (Auth '= "") {// authorization key injection
-            write $REPLACE(textreader.Value, "createTerminal()", "createTerminal('"_Auth_"','"_%request.Get("NS")_"')")
-        } else {
-            write textreader.Value
-        }
-    } }
-    quit $$$OK
-]]></Implementation>
-</Method>
-{{replace:themes}}
-<XData name="Theme{{replace:themeName}}">
-<Data><![CDATA[
-<data>
-<![CDATA[{{replace:themeData}}]]]]><![CDATA[>
-</data>
-]]></Data>
-</XData>
-{{replace:end}}
-<XData name="html">
-<Data><![CDATA[
-<data>
-<![CDATA[{{replace:html}}]]]]><![CDATA[>
-</data>
-]]></Data>
-</XData>
-
-<XData name="css">
-<Data><![CDATA[
-<data>
-<![CDATA[{{replace:css}}]]]]><![CDATA[>
-</data>
-]]></Data>
-</XData>
-
-<XData name="js">
-<Data><![CDATA[
-<data>
-<![CDATA[{{replace:js}}]]]]><![CDATA[>
-</data>
-]]></Data>
-</XData>
-</Class>
-
-
-<Project name="WEBTerminal" LastModified="2015-12-06 12:10:07.906721">
-  <Items>
-    <ProjectItem name="WebTerminal.Engine" type="CLS"></ProjectItem>
-    <ProjectItem name="WebTerminal.Installer" type="CLS"></ProjectItem>
-    <ProjectItem name="WebTerminal.Router" type="CLS"></ProjectItem>
-    <ProjectItem name="WebTerminal.StaticContent" type="CLS"></ProjectItem>
-  </Items>
-</Project>
 </Export>