boomack 0.10.0-dev → 0.11.0

package/LICENSE.md

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+=====================
+
+**Copyright (c) 2022 Tobias Kiertscher <dev@mastersign.de>**
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/client/public/js/client.js

@@ -120,7 +120,7 @@ window.boomack = window.boomack || {};
 
 	function ensureSlotResizeSensor(slotId) {
 		if (_.has(slotResizeSensors, slotId)) return;
-		var slotE = findSlot(slotId);
+		var slotE = getSlot(slotId);
 		if (!slotE.length) {
 			console.log("Could not find the slot '" + slotId + "' for registering a slot resize handler.");
 			return;
@@ -198,11 +198,25 @@ window.boomack = window.boomack || {};
 		});
 	}
 
+	ctx.findSlot = function(slotHint) {
+		var slotE = typeof slotHint === 'string' ? getSlot(slotHint) : {};
+		if (!slotE.length) {
+			// try to use slotHint as selector for slot content element
+			// and search parents for slot
+			slotE = $(slotHint).closest('.slot');
+		}
+		return slotE.length === 1 ? slotE[0] : null;
+	};
+
+	ctx.getSlotId = function(slot) {
+		return slot ? slot.getAttribute('data-slot-id') : null;
+	};
+
 	ctx.registerSlotResizeHandler = function (slotHint, handler, callImmediately) {
 		var slotId = null;
 		var slotE = null;
 		// try to use slotHint as slot ID
-		slotE = findSlot(slotHint);
+		slotE = getSlot(slotHint);
 		if (!slotE.length) {
 			// try to use slotHint as selector for slot content element
 			// and search parents for slot
@@ -228,7 +242,7 @@ window.boomack = window.boomack || {};
 	ctx.registerPersistentSlotResizeHandler = function(slotId, handler) {
 		ensureSlotResizeSensor(slotId);
 		persistentSlotResizeHandlers[slotId].push(handler);
-		var slotE = findSlot(slotId);
+		var slotE = getSlot(slotId);
 		var size = getSlotInnerSize(slotE);
 		var zoomedSize = getZoomedSlotInnerSize(slotE, size);
 		handler(size, zoomedSize);
@@ -250,15 +264,15 @@ window.boomack = window.boomack || {};
 		$('#panel').html(layoutHtml);
 	}
 
-	function findAllSlots() {
+	function getAllSlots() {
 		return $('.slot');
 	}
 
-	function findSlot(slotId) {
+	function getSlot(slotId) {
 		return $(`#slot-${slotId}`);
 	}
 
-	function findAllButSlot(slotId) {
+	function getAllButSlot(slotId) {
 		return $(`.slot:not(#slot-${slotId})`);
 	}
 
@@ -392,6 +406,14 @@ window.boomack = window.boomack || {};
 		classes.forEach(cls => { slotE.removeClass(cls); });
 		slotE.find('.cmd-zoom-in').removeClass('disabled');
 		slotE.find('.cmd-zoom-out').removeClass('disabled');
+		// make sure to reset styles of all content related elements,
+		// in case some JavaScript attached styles during display
+		slotE.find('.slot-content-box')
+			.each(function () { this.style = {}; })
+			.find('.slot-content-wrapper')
+			.each(function () { this.style = {}; })
+			.find('.slot-content')
+			.each(function () { this.style = {}; });
 	}
 
 	const imgPattern = /^\s*<img\s+src=\"([^\"]*)\"\s*\/?>/;
@@ -442,7 +464,6 @@ window.boomack = window.boomack || {};
 	}
 
 	let socket = null;
-	let actionCallback = null;
 	let scrollTimeout = null;
 
 	function scrollToSlot(slotId) {
@@ -451,7 +472,7 @@ window.boomack = window.boomack || {};
 		}
 		scrollTimeout = window.setTimeout(() => {
 			scrollTimeout = null;
-			const slotE = findSlot(slotId);
+			const slotE = getSlot(slotId);
 			if (slotE) {
 				window.scrollTo({
 					top: slotE.offset().top - 10,
@@ -493,7 +514,7 @@ window.boomack = window.boomack || {};
 		} else if (envelope.command) {
 			const cmd = envelope.command;
 			if (cmd.panel != ctx.panelId) return;
-			const slotE = findSlot(cmd.slot);
+			const slotE = getSlot(cmd.slot);
 			const contentE = slotE.find('.slot-content');
 			if (!contentE) return;
 			const empty = contentE.is(':empty');
@@ -550,6 +571,83 @@ window.boomack = window.boomack || {};
 		ctx.run(function () { eval(cmd.script); });
 	}
 
+	const pendingActionCalls = {};
+
+	function cleanUpPendingActionCalls() {
+		var now = new Date().getTime();
+		for (const callId in pendingActionCalls) {
+			const ar = pendingActionCalls[callId];
+			if (now > ar.ts + ar.timeout) {
+				delete pendingActionCalls[callId]
+			}
+		}
+	}
+
+	function padLeft(pad, x) {
+		return (pad + x).slice(-pad.length);
+	}
+
+	function newCallId(ts) {
+		const r = Math.floor(Math.random() * 1000);
+		return padLeft("00000000000000", ts) + "_" + padLeft("000", r);
+	}
+
+	function uniqueCallId(ts) {
+		let callId = newCallId(ts);
+		while (pendingActionCalls[callId]) {
+			callId = newCallId(ts);
+		}
+		return callId;
+	}
+
+	function beginActionCall(actionId, payload, cb, options = {
+		timeout: 10000,
+	}) {
+		cleanUpPendingActionCalls();
+		const ts = new Date().getTime();
+		const callId = uniqueCallId(ts);
+		const call = {
+			id: callId,
+			ts: ts,
+			timeout: options.timeout,
+			resolve: null,
+			reject: null,
+		};
+		const promise = new Promise((resolve, reject) => {
+			call.resolve = response => {
+				delete pendingActionCalls[callId];
+				resolve(response);
+				if (typeof cb === 'function') {
+					try {
+						cb(null, response);
+					} catch (err) {
+						console.error("Callback for action " + actionId + " has thrown an error:", err);
+					}
+				}
+			};
+			call.reject = reason => {
+				delete pendingActionCalls[callId];
+				reject(reason);
+				if (typeof cb === 'function') {
+					try {
+						cb(reason);
+					} catch (err) {
+						console.error("Callback for action " + actionId + " has thrown an error:", err);
+					}
+				}
+			};
+		});
+		pendingActionCalls[callId] = call;
+		socket.emit('action', {
+			action: actionId,
+			panel: ctx.panelId,
+			payload: payload,
+			token: callId,
+		});
+
+		return promise;
+	}
+
 	$(function () {
 		// run when page is ready
 
@@ -584,11 +682,11 @@ window.boomack = window.boomack || {};
 
 		socket.on('clear', cmd => {
 			if (cmd.slot) {
-				const slotE = findSlot(cmd.slot);
+				const slotE = getSlot(cmd.slot);
 				slotE.find('.slot-content').html('');
 				notifySlotEmpty(cmd.slot, slotE);
 			} else {
-				const slotEs = findAllSlots();
+				const slotEs = getAllSlots();
 				slotEs.each(function () {
 					const slotE = $(this);
 					slotE.find('.slot-content').html('');
@@ -609,24 +707,28 @@ window.boomack = window.boomack || {};
 			}, 'html');
 		});
 
-		socket.on('action-error', err => {
-			if (actionCallback) {
-				actionCallback(err);
-				actionCallback = null;
+		socket.on('action-error', response => {
+			const ar = pendingActionCalls[response.token];
+			if (ar) {
+				ar.reject(response.error);
+			} else {
+				console.warn("Response for action " + response.action + " without handler:", response.token);
 			}
 		});
-		socket.on('action-success', result => {
-			if (actionCallback) {
-				actionCallback(null, result);
-				actionCallback = null;
+		socket.on('action-success', response => {
+			const ar = pendingActionCalls[response.token];
+			if (ar) {
+				ar.resolve(response.payload);
+			} else {
+				console.warn("Response for action " + response.action + " without handler:", response.token);
 			}
 		});
 	});
 
 	ctx.cmdToggleMaximize = function (slotId) {
-		const slotE = findSlot(slotId);
+		const slotE = getSlot(slotId);
 		if (!slotE) return;
-		const otherSlotE = findAllButSlot(slotId);
+		const otherSlotE = getAllButSlot(slotId);
 		const cmdMaximize = slotE.find('.slot-toolbar .cmd-maximize i.icon');
 		if (slotE.hasClass('maximized')) {
 			slotE.removeClass('maximized');
@@ -646,7 +748,7 @@ window.boomack = window.boomack || {};
 
 	ctx.cmdHistoryBackward = function (slotId) {
 		if (ctx.offline) return;
-		const slotE = findSlot(slotId);
+		const slotE = getSlot(slotId);
 		if (!slotE) return;
 		const no = Number.parseInt(slotE.data('sequence-no')) - 1;
 		if (!isValidHistoryNo(slotE, no)) return;
@@ -665,7 +767,7 @@ window.boomack = window.boomack || {};
 
 	ctx.cmdHistoryForward = function (slotId) {
 		if (ctx.offline) return;
-		const slotE = findSlot(slotId);
+		const slotE = getSlot(slotId);
 		if (!slotE) return;
 		const no = Number.parseInt(slotE.data('sequence-no')) + 1;
 		if (!isValidHistoryNo(slotE, no)) return;
@@ -684,7 +786,7 @@ window.boomack = window.boomack || {};
 
 	ctx.cmdTogglePause = function (slotId) {
 		if (ctx.offline) return;
-		const slotE = findSlot(slotId);
+		const slotE = getSlot(slotId);
 		if (!slotE) return;
 		const cmdPause = slotE.find('.slot-toolbar .cmd-pause i.icon');
 		if (slotE.hasClass('paused')) {
@@ -741,7 +843,7 @@ window.boomack = window.boomack || {};
 	}
 
 	ctx.cmdSlotZoomOut = function (slotId) {
-		const slotE = findSlot(slotId);
+		const slotE = getSlot(slotId);
 		const zoom = getSlotZoom(slotE);
 		const newZoom = zoomFromBase(baseFromZoom(zoom) - 1);
 		setData(slotE, 'zoom', newZoom);
@@ -749,7 +851,7 @@ window.boomack = window.boomack || {};
 	};
 
 	ctx.cmdSlotZoomIn = function (slotId) {
-		const slotE = findSlot(slotId);
+		const slotE = getSlot(slotId);
 		const zoom = getSlotZoom(slotE);
 		const newZoom = zoomFromBase(baseFromZoom(zoom) + 1);
 		setData(slotE, 'zoom', newZoom);
@@ -774,31 +876,26 @@ window.boomack = window.boomack || {};
 		return replaceThemeProps(o);
 	};
 
-	ctx.arang = function (actionId, payload, cb) {
-		if (ctx.offline) {
-			console.warn('Can not trigger action, if in print or exported mode.', 'Action', actionId);
-			return;
+	ctx.action = function (
+		actionId,
+		payload = null,
+		cb = null,
+		options = {
+			timeout: 10000,
 		}
-		actionCallback = cb;
-		socket.emit('action', {
-			action: actionId,
-			panel: ctx.panelId,
-			payload: payload,
-		});
-	};
-
-	ctx.boom = function (displayRequest, cb) {
+	) {
 		if (ctx.offline) {
-			console.warn('Can not send display request, if in print or exported mode.');
+			console.warn('Can not call action, if in print or exported mode.', 'Action', actionId);
 			return;
 		}
-		// TODO implement boom for client code
-		// possibly in an extra web client library
-		alert('Not implemented');
+		return beginActionCall(actionId, payload, cb, options);
 	};
 
-	// export some functions to global scope
-	window.arang = ctx.arang;
-	window.boom = ctx.boom;
+	// deprecated
+	ctx.arang = function () {
+		console.warn('The arang function is deprecated. Please use boomack.action().');
+		return ctx.action.apply(ctx, arguments);
+	};
+	window.arang = ctx.arang; // deprecated
 
 })();

package/default-config.yaml

@@ -227,31 +227,45 @@ export:
     resourceSizeLimit: 1536 MB
 
 init:
-  # initial panels with their layout
+  # A map with initial panels
   panels:
-    # one panel must have the ID default
-    default:
-      layout:
-        # the initial default panel has a minimal grid layout
-        grid:
-          columns: 1
-          rows: 1
-        slots:
-          # one slot in each panel must have the ID default
-          default:
-            history: 10
-            border: true
-            toobar: true
-            showId: true
-            column: 0
-            row: 0
-            columnSpan: 1
-            rowSpan: 1
+    # one panel must have the ID "default"
+    "default":
       # show or hide the header above the slots
       header: true
+      # the size of the header, if visible: mini, tiny, small, medium, large, huge, massive
+      headerSize: medium
       # select a theme for this panel: default, dark
       theme: default
-  # initial actions, none by default
+      # CSS code to be included in the HTML head of the panel
+      style: null
+      # JavaScript code to be executed when the panel was loaded
+      script: null
+      # the ID of the default slot (optional)
+      defaultSlot: null
+      # the initial default panel has a minimal grid layout
+      grid:
+        columns: 1
+        rows: 1
+      slots:
+        # if not explicitly defined, first slot is the default slot
+        "default":
+          history: 10
+          extensions: 100
+          border: true
+          toobar: true
+          noZoom: false
+          noClear: false
+          noMaximize: false
+          noSingleOut: false
+          showId: true
+          colorFilter: null
+          column: 0
+          row: 0
+          columnSpan: 1
+          rowSpan: 1
+
+  # A map with initial actions
   actions: { }
   #  action-id:
   #    type: shell
@@ -270,32 +284,9 @@ init:
     #    background: #FFC080
 
   # A map with initial MIME types
-  types:
-    "text/markdown":
-      options:
-        transformation: markdown
-    "text/csv":
-      options:
-        transformation: csv-table
-    "text/xml":
-      options:
-        syntax: xml
-    "application/xml":
-      text: true  # indicate that this non-text MIME type can be treated as text
-      options:
-        syntax: xml
-    "text/yaml":
-      options:
-        syntax: yaml
-    "application/x-yaml":
-      text: true
-      options:
-        syntax: yaml
-    "application/javascript":
-      text: true
-      options:
-        syntax: js
-    "application/json":
-      text: true
-      options:
-        syntax: json
+  types: { }
+    # example type for a syntax highlighted text file
+    # "text/css":
+    #   presets: []
+    #   options:
+    #     syntax: css

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "boomack",
-  "version": "0.10.0-dev",
+  "version": "0.11.0",
   "description": "web app for displaying hyper-media items in concert with e.g. an IDE",
   "author": "Tobias Kiertscher <dev@mastersign.de>",
   "license": "MIT",
@@ -8,9 +8,10 @@
     "boomack": "./server-build/cli.js"
   },
   "files": [
+    "LICENSE.md",
     "server-build",
-    "client",
-    "default-config.yaml"
+    "default-config.yaml",
+    "client"
   ],
   "scripts": {
     "build": "tsc",
@@ -28,21 +29,21 @@
     "node": ">= 10.0.0"
   },
   "dependencies": {
-    "archiver": "^5.2.0",
+    "archiver": "^5.3.0",
     "async": "^3.2.0",
     "chalk": "^4.1.0",
-    "chardet": "^0.8.0",
+    "chardet": "^1.4.0",
     "commonmark": "^0.30.0",
     "cookie-parser": "^1.4.5",
     "cors": "^2.8.5",
     "csv-parse": "^4.15.1",
-    "ejs": "^2.7.4",
-    "express": "^4.17.1",
+    "ejs": "^3.1.8",
+    "express": "^4.18.0",
     "express-basic-auth": "^1.2.0",
-    "got": "^10.7.0",
-    "iconv-lite": "^0.5.2",
-    "lodash": "^4.17.20",
-    "markdown-it": "^12.3.2",
+    "got": "^11.8.5",
+    "iconv-lite": "^0.6.0",
+    "lodash": "^4.17.21",
+    "markdown-it": "^13.0.0",
     "markdown-it-container": "^3.0.0",
     "markdown-it-emoji": "^2.0.0",
     "markdown-it-ins": "^3.0.1",
@@ -51,21 +52,22 @@
     "markdown-it-sup": "^1.0.0",
     "moment": "^2.29.1",
     "ncp": "^2.0.0",
-    "nocache": "^2.1.0",
-    "open": "^7.4.2",
-    "prismjs": "^1.23.0",
-    "raw-body": "^2.4.1",
+    "nocache": "^3.0.4",
+    "on-finished": "^2.4.1",
+    "open": "^8.4.0",
+    "prismjs": "^1.28.0",
+    "raw-body": "^2.5.1",
     "rimraf": "^3.0.2",
     "secure-random-string": "^1.1.3",
-    "socket.io": "^4.4.1",
-    "uuid": "^3.4.0",
-    "winston": "^3.3.3",
+    "socket.io": "^4.5.1",
+    "uuid": "^8.3.2",
+    "winston": "^3.8.1",
     "yaml": "^1.10.0",
     "yargs": "^15.4.1"
   },
   "devDependencies": {
-    "@types/express": "^4.17.11",
-    "@types/lodash": "^4.14.168",
+    "@types/express": "^4.17.13",
+    "@types/lodash": "^4.14.182",
     "@types/rimraf": "^3.0.0",
     "boomack-theme-blue-night": "https://github.com/boomack/themes/tarball/blue-night/v3",
     "boomack-theme-dark": "https://github.com/boomack/themes/tarball/dark/v2",

package/server-build/cli.js

@@ -1,4 +1,3 @@
 #!/usr/bin/env node
 "use strict";
 require('./index');
-//# sourceMappingURL=cli.js.map

package/server-build/index.js

@@ -8,6 +8,7 @@ const cors = require('cors');
 const app = express();
 const http = require('http');
 const server = http.createServer(app);
+const onFinished = require('on-finished');
 const socketio = require('socket.io');
 const io = socketio();
 const utils = require('./utils');
@@ -23,6 +24,7 @@ const resources = require('./service/resources');
 const panels = require('./service/panels');
 const actions = require('./service/actions');
 const persistence = require('./service/persistence');
+const messages = require('./service/response-messages');
 const log = logging.log;
 function showPreamble(cb) {
     if (!cli.args.logo) {
@@ -304,7 +306,14 @@ function setupApp(cb) {
     app.use(require('nocache')());
     // Log all HTTP request URLs
     app.use((req, res, next) => {
-        log.http(`${req.method} ${req.url}`);
+        onFinished(res, function (err, res) {
+            if (err) {
+                log.error(err);
+            }
+            else {
+                log.http(`${req.method} ${req.url} ${res.statusCode}`);
+            }
+        });
         next();
     });
     app.use(cors());
@@ -317,6 +326,13 @@ function setupApp(cb) {
     require('./routes/display-requests').setup(app, io);
     require('./routes/eval-requests').setup(app, io);
     require('./routes/export').setup(app, io);
+    app.use((req, res) => {
+        messages.error(res, {
+            status: 404,
+            title: "Resource not found",
+            message: `The resource "${req.url}" was not found.`,
+        });
+    });
     cb(null);
 }
 function startServer(cb) {
@@ -382,13 +398,14 @@ async.waterfall([
     showPreamble,
     logging.initialize,
     cfg.parseArgsAndLoadConfig,
-    cfgCheck.run,
     logging.configure,
     initializeAuthentication,
     initializeResources,
-    showConfiguration,
     loadCorePlugIns,
     loadPlugIns,
+    cfg.plugInInitConfigApplicatorFactory(plugins),
+    showConfiguration,
+    cfgCheck.run,
     loadPresets,
     loadMimeTypes,
     loadActions,
@@ -404,4 +421,3 @@ async.waterfall([
         log.error(err.message);
     }
 });
-//# sourceMappingURL=index.js.map

package/server-build/middleware/basic-auth.js

@@ -12,4 +12,3 @@ exports.webAuthBasic = function (unauthorizedHtml) {
     };
     return basicAuth(options);
 };
-//# sourceMappingURL=basic-auth.js.map

package/server-build/middleware/data-parser.js

@@ -147,4 +147,3 @@ exports.dataBody = function (req, res, next) {
         });
     });
 };
-//# sourceMappingURL=data-parser.js.map

package/server-build/middleware/standard-auth.js

@@ -59,4 +59,3 @@ exports.webAuthStandard = function (loginRenderer) {
         }
     };
 };
-//# sourceMappingURL=standard-auth.js.map

package/server-build/middleware/token-auth.js

@@ -48,4 +48,3 @@ exports.apiAuth = function (accessPath) {
     };
 };
 exports.forbiddenMessage = forbiddenMessage;
-//# sourceMappingURL=token-auth.js.map

package/server-build/model/action.js

@@ -38,4 +38,3 @@ exports.sanitize = function (request, cb) {
     }
     cb(null, action);
 };
-//# sourceMappingURL=action.js.map

package/server-build/model/action.test.js

@@ -68,4 +68,3 @@ describe('mode/action', function () {
         });
     });
 });
-//# sourceMappingURL=action.test.js.map

package/server-build/model/display-request.js

@@ -122,4 +122,3 @@ exports.sanitize = function (request, cb) {
     }
     cb(null, item);
 };
-//# sourceMappingURL=display-request.js.map

package/server-build/model/display-request.test.js

@@ -161,4 +161,3 @@ describe('model/display-request', function () {
         });
     });
 });
-//# sourceMappingURL=display-request.test.js.map

package/server-build/model/layout.js

@@ -226,4 +226,3 @@ exports.sanitize = function (request, cb) {
     }
     cb(null, result);
 };
-//# sourceMappingURL=layout.js.map

package/server-build/model/layout.test.js

@@ -322,4 +322,3 @@ describe('model/layout', function () {
         });
     });
 });
-//# sourceMappingURL=layout.test.js.map

package/server-build/pipeline/format.js

@@ -134,4 +134,3 @@ const functions = {
         cb(null, t);
     },
 };
-//# sourceMappingURL=format.js.map