Base64-encoded file serving for web app, finally 🎉

Author: nikitaeverywhere

gulpfile.babel.js

@@ -7,22 +7,45 @@ import to5ify from "6to5ify";
 import streamify from "gulp-streamify";
 import source from "vinyl-source-stream";
 import scss from "gulp-sass";
+import fs from "fs";
+import mime from "mime-types";
 import pkg from "./package.json";
 
 const
+    APP_NAME = `EntityBrowser`,
     SOURCE_DIR = `${ __dirname }/src`,
     BUILD_DIR = `${ __dirname }/build`,
+    STATIC_DATA_FILE = `${ SOURCE_DIR }/cls/${ APP_NAME }/REST/StaticData.cls`,
     context = {
         package: pkg
     };
 
+function getAllFiles (dir) {
+    let results = [];
+    let list = fs.readdirSync(dir);
+    list.forEach(function(file) {
+        file = dir + '/' + file;
+        let stat = fs.statSync(file);
+        if (stat && stat.isDirectory()) results = results.concat(getAllFiles(file));
+        else results.push(file)
+    });
+    return results;
+}
+
+function base64Encode (file) {
+    return (new Buffer(fs.readFileSync(file, 'binary'), 'binary')).toString(`base64`);
+}
+
 gulp.task("clean", () => {
     return gulp.src(BUILD_DIR, { read: false })
         .pipe(rimraf());
 });
 
 gulp.task("cls", ["clean"], () => {
-    return gulp.src(SOURCE_DIR + "/cls/**/*.cls")
+    return gulp.src([
+            `!${ STATIC_DATA_FILE }`,
+            `${ SOURCE_DIR }/cls/**/*.cls`
+        ])
         .pipe(preprocess({ context: context }))
         .pipe(gulp.dest(BUILD_DIR + "/cls"));
 });
@@ -60,4 +83,21 @@ gulp.task("css", ["clean"], () => {
         .pipe(gulp.dest(`${ BUILD_DIR }/static/css`));
 });
 
-gulp.task("default", ["cls", "html", "js", "css", "etc"]);
+/// doing file replacement manually because preprocess sucks.
+gulp.task("StaticData", ["html", "js", "css", "etc"], () => {
+    let files = getAllFiles(`${ BUILD_DIR }/static`),
+        staticData = files.map((fileName, i) =>
+`/// ${ fileName.replace(`${ BUILD_DIR }/static/`, "") }\r\n\
+XData File${ i } [ MimeType = ${ mime.lookup(fileName) || "text/plain" } ]\r\n\
+{\r\n\
+${ base64Encode(fileName).replace(/(.{32765})/g, "$1\r\n") }\r\n\
+}`
+        ).join(`\r\n\r\n`);
+    fs.writeFileSync(
+        STATIC_DATA_FILE.replace(SOURCE_DIR, BUILD_DIR),
+        new Buffer(fs.readFileSync(STATIC_DATA_FILE)).toString()
+            .replace("<!-- staticData -->", staticData)
+    );
+});
+
+gulp.task("default", ["cls", "StaticData"]);

import.cmd

@@ -10,18 +10,18 @@ set CACHE_DIR=C:\Program Files\InterSystems\Ensemble
 set NAMESPACE=SAMPLES
 :: Other variables
 set BUILD_DIR=build\cls
-set BUILD_STATIC_DIR=build\static
-set CSP_DIR=C:\Program Files\InterSystems\Ensemble\CSP\samples\EntityBrowser
+:: set BUILD_STATIC_DIR=build\static
+:: set CSP_DIR=C:\Program Files\InterSystems\Ensemble\CSP\samples\EntityBrowser
 :: User credentials. Remove if necessary.
 set USERNAME=_SYSTEM
 set PASSWORD=SYS
 
 :: Build and import application to Caché
 echo Importing project...
 call npm run gulp
-call xcopy /sy "%~dp0\%BUILD_STATIC_DIR%" "%CSP_DIR%"
+:: call xcopy /sy "%~dp0\%BUILD_STATIC_DIR%" "%CSP_DIR%"
 (
 echo %USERNAME%
 echo %PASSWORD%
-echo zn "SAMPLES" set st = $system.Status.GetErrorText($system.OBJ.ImportDir("%~dp0%BUILD_DIR%",,"ck /checkuptodate=all",,1^^^)^^^) w "IMPORT STATUS: "_$case(st="",1:"OK",:st^^^), ! halt
+echo zn "%NAMESPACE%" set st = $system.Status.GetErrorText($system.OBJ.ImportDir("%~dp0%BUILD_DIR%",,"ck",,1^^^)^^^) w "IMPORT STATUS: "_$case(st="",1:"OK",:st^^^), ! halt
 ) | "%CACHE_DIR%\bin\cache.exe" -s "%CACHE_DIR%\mgr" -U %NAMESPACE%

import.sh

@@ -25,6 +25,6 @@ cp -R "$DIR/$BUILD_STATIC_DIR"* "$CSP_DIR"
 cat <<EOT | "$CACHE_DIR/bin/cache" -s "$CACHE_DIR/mgr" -U $NAMESPACE
 $USERNAME
 $PASSWORD
-set st = \$system.Status.GetErrorText(\$system.OBJ.ImportDir("$DIR/$BUILD_DIR",,"ck /checkuptodate=all",,1))
+zn "$NAMESPACE" set st = \$system.Status.GetErrorText(\$system.OBJ.ImportDir("$DIR/$BUILD_DIR",,"ck /checkuptodate=all",,1))
 write "IMPORT STATUS: "_\$case(st="",1:"OK",:st), ! halt
 EOT

package.json

@@ -1,6 +1,6 @@
 {
   "name": "iknow-entity-browser",
-  "version": "0.8.7",
+  "version": "0.9.0",
   "description": "Visualizer for iKnow entities",
   "main": "gulpfile.babel.js",
   "scripts": {
@@ -25,6 +25,7 @@
     "gulp-rimraf": "^0.2.0",
     "gulp-sass": "^3.1.0",
     "gulp-streamify": "^1.0.2",
+    "mime-types": "^2.1.15",
     "vinyl-source-stream": "^1.1.0"
   }
 }

src/cls/EntityBrowser/Router.cls src/cls/EntityBrowser/REST/API.clssrc/cls/EntityBrowser/Router.cls renamed to src/cls/EntityBrowser/REST/API.cls

@@ -97,7 +97,7 @@
 ///         items:
 ///           type: string
 /// </example>
-Class EntityBrowser.Router Extends (%iKnow.REST.Base, %iKnow.REST.Utils)
+Class EntityBrowser.REST.API Extends (%iKnow.REST.Base, %iKnow.REST.Utils)
 {
 
 Parameter PAGESIZE = 0;

src/cls/EntityBrowser/REST/Router.cls

@@ -0,0 +1,13 @@
+/// Application entry point.
+Class EntityBrowser.REST.Router Extends (ServeXData, StaticData)
+{
+
+XData UrlMap
+{
+<Routes>
+    <Map Prefix="/api" Forward="EntityBrowser.REST.API"/>
+    <Route Url="/(.*)" Method="GET" Call="StaticDelivery"/>
+</Routes>
+}
+
+}

src/cls/EntityBrowser/REST/ServeXData.cls

@@ -0,0 +1,74 @@
+/// Class that serves the static data encoded in Base64 and stored in this class in XData blocks.
+Class EntityBrowser.REST.ServeXData Extends %CSP.REST
+{
+
+/// Index file name which will be served when requesting "/".
+Parameter IndexFile = "index.html";
+
+/// Identifies the compilation time, which is used to form "Last-Modified" HTTP header.
+Parameter CompileTime = {"""" _ $zd($h, 11) _ ", "_ $zdt($NOW(0), 2,1) _ " GMT"""};
+
+/// $LB of pairs $LB("fileName1", "XDataName1", "FileName2", ...)
+/// Generated in GenerateFiles generator.
+Parameter Files As CONFIGVALUE;
+
+/// Copy the <Route> definition to the URLMap XData of your class.
+XData UrlMap
+{
+<Routes>
+    <Route Url="/(.*)" Method="GET" Call="StaticDelivery"/>
+</Routes>
+}
+
+/// A generator for Files parameter.
+ClassMethod FillFiles() As %Status [ CodeMode = objectgenerator, ForceGenerate ]
+{
+	set list = $LB()
+	set (ind, j) = 0
+	for i=1:1:%compiledclass.XDatas.Count() {
+        set xd = %compiledclass.XDatas.GetAt(i)
+        set:(xd.Description = ..#IndexFile) ind = i
+        continue:($FIND(xd.Name,"File")=0)
+        set $LIST(list, j*2+1) = xd.Description
+        set $LIST(list, j*2+2) = xd.Name
+        set j = j + 1
+    }
+    if (ind '= 0) { // add index file
+	    set xd = %compiledclass.XDatas.GetAt(ind)
+	    set $LIST(list, j*2+1) = ""
+        set $LIST(list, j*2+2) = xd.Name
+    }
+	do $system.OBJ.UpdateConfigParam("EntityBrowser.REST.ServeXData", "Files", list)
+	return $$$OK
+}
+
+ClassMethod GetXData(fileName As %String) As %Dictionary.CompiledXData
+{
+	set xdn = ""
+	for i=1:2:$LISTLENGTH(..#Files) {
+		continue:($LISTGET(..#Files, i) '= fileName)
+		set xdn = $LISTGET(..#Files, i + 1)
+	}
+	return:(xdn="") ""
+	return ##class(%Dictionary.CompiledXData).%OpenId($ClassName()_"||"_xdn)
+}
+
+ClassMethod StaticDelivery(file As %String) As %Status
+{
+    set xdata = ..GetXData(file)
+    return:(xdata = "") ..Http404()
+
+    set cTime = $PARAMETER($ClassName(), "CompileTime")
+    set %response.ContentType = xdata.MimeType
+    do %response.SetHeader("Last-Modified", cTime)
+    if (%request.GetCgiEnv("HTTP_IF_MODIFIED_SINCE") = cTime) {
+        set %response.Status = "304 Not Modified"
+        return $$$OK
+    }
+
+    write $System.Encryption.Base64Decode(xdata.Data.Read(xdata.Data.Size))
+
+	return $$$OK
+}
+
+}

src/cls/EntityBrowser/REST/StaticData.cls

@@ -0,0 +1,7 @@
+/// A class containing static web application.
+Class EntityBrowser.REST.StaticData [ GeneratedBy = ExternalTools ]
+{
+
+<!-- staticData -->
+
+}