ldn-inbox-server 1.4.4 → 1.4.6

package/README.md

@@ -55,7 +55,35 @@ npx ldn-inbox-server handler @outbox -hn ./handler/send_notification_handler.js
 - `LDN_SERVER_JSON_SCHEMA` : notification JSON validation schema
 - `LDN_SERVER_BASEURL` : baseurl of the LDN inbox server
 - `LDN_SERVER_INBOX_GLOB` : glob of files to process in inbox directory
-- `LDN_SERVER_HAS_PUBLIC_INBOX` : if true, then public read access is allowed on inbox
+- `LDN_SERVER_HAS_PUBLIC_INBOX` : if true, then public read access is allowed on the inbox
+- `LDN_SERVER_HAS_WRITABLE_INBOX` : if true, then public write access is allowed on the inbox
+  
+## Multiple inboxes
+
+Instead of a single inbox, multiple inboxes can be configured by adding a JSON configuration file to the installation. The JSON file should contain a `registry` entry with contains an array of inbox configuration. An example:
+
+```
+{
+  "registry": [
+        { "path": "inbox/.*" , 
+          "with": {
+            "url": "inbox/",
+            "inbox": "./inbox",
+            "inboxPublic": 1,
+            "inboxWritable": 1,
+            "schema": "./config/schema1.json"
+        }},
+        { "path": "inbox2/.*" , 
+          "with": {
+            "url": "inbox2/",
+            "inbox": "./inbox2",
+            "inboxPublic": 1,
+            "inboxWritable": 0,
+            "schema": "./config/schema2.json"
+        }}
+    ]
+}
+```
 
 ## Extend
 
@@ -115,7 +143,7 @@ A handler can be started on any directory. E.g. a workflow might be:
 
 A handler that creates for an incoming notification an `Accept` notification in the `@outbox`.
 
-### Evenlog handler
+### Eventlog handler
 
 A handler that updates an event log with the incoming notification. 
 

package/bin/ldn-inbox-server.js

@@ -2,7 +2,8 @@
 
 const fs = require('fs');
 const { program } = require('commander');
-const { inbox_server } = require('../lib/index');
+const { start_server } = require('mellon-server');
+const { doInbox }      = require('../lib/index');
 const { handle_inbox } = require('../lib/handler');
 require('dotenv').config();
 
@@ -20,6 +21,8 @@ const JSON_SCHEMA_PATH = process.env.LDN_SERVER_JSON_SCHEMA ?? './config/notific
 const INBOX_CONFIG = process.env.LDN_SERVER_INBOX_CONFIG;
 const OUTBOX_CONFIG = process.env.LDN_SERVER_OUTBOX_CONFIG;
 const HAS_PUBLIC = process.env.LDN_SERVER_HAS_PUBLIC_INBOX ?? 0;
+const HAS_WRITE = process.env.LDN_SERVER_HAS_WRITABLE_INBOX ?? 1;
+const OTHER_CONFIG = process.env.LDN_SERVER_OTHER_CONFIG;
 
 program
   .name('lnd-inbox-server')
@@ -29,6 +32,7 @@ program
   .command('start-server')
   .option('--host <host>','host',HOST)
   .option('--port <port>','port',PORT)
+  .option('--config <config>','config',OTHER_CONFIG)
   .option('--url <path>','path',INBOX_URL)
   .option('--base <url>','base url',INBOX_BASE_URL)
   .option('--inbox <inbox>','inbox',INBOX_PATH)
@@ -36,8 +40,45 @@ program
   .option('--schema <schema>','json schema',JSON_SCHEMA_PATH)
   .option('--registry <registry>','registry',null)
   .option('--inbox-public','public readable inbox',HAS_PUBLIC)
+  .option('--inbox-writeable','public writable inbox',HAS_WRITE)
   .action( (options) => {
-    inbox_server(options);
+      let registry = [];
+
+      // Add other (external defined) registry parts
+      if (options['registry']) {
+        const path = options['registry'];
+        let registry2;
+        if (typeof path === 'string' || path instanceof String) {
+            registry2 = JSON.parse(fs.readFileSync(path,{ encoding: 'utf-8'}));
+        }
+        else {
+            registry2 = path;
+        }
+        registry = registry.concat(registry2);
+      }
+
+      if (options['config'] && fs.existsSync(options['config'])) {
+          const config = JSON.parse(fs.readFileSync(options['config'], { encoding: 'utf-8'}));
+          if (config.registry) {
+             for (let i = 0 ; i < config.registry.length ; i++) {
+                const registry_item = config.registry[i];
+                registry_item['do'] = doInbox;
+                registry_item['with'] = {...options,...registry_item['with']};
+                registry = registry.concat(registry_item);
+             }
+          }
+      }
+      else {
+        registry = registry.concat({ path : `${options['url']}.*` , do: doInbox , with: options}); 
+      }
+   
+      start_server({
+        host: options['host'],
+        port: options['port'],
+        base: options['base'],
+        public: options['public'],
+        registry: registry
+      });
   });
 
 program

package/config/inbox_config.json

@@ -1,4 +1,12 @@
 {
+    "registry": [
+        { "path": "inbox2/.*" , "with": {
+            "url": "inbox2/",
+            "inbox": "./inbox2",
+            "inboxPublic": 1,
+            "inboxWritable": 0
+        }}
+    ],  
     "notification_handler": {
         "multi": {
             "handlers": [

package/handler/notification_handler/offer_memento.js

@@ -11,22 +11,22 @@ async function handle({path,options,config}) {
     logger.info(`parsing notification ${path}`);
 
     if (! config) {
-        logger.error('no configuration found for offer_memento_notification_handler');
+        logger.error('no configuration found for offer_memento');
         return { path, options, success: false };
     }
    
     if (!config['actor'] || !config['target']) {
-        logger.error('no actor/target entry for notification_handler.eventlog configuration'); 
+        logger.error('no actor/target entry'); 
         return { path, options, success: false };
     }
 
     if (!options['artifact']) {
-        logger.info(`no artifact found (ignonring this request)`);
+        logger.info(`no artifact found (ignoring this request)`);
         return { path, options, success: true };
     }
 
     if (!options['eventlog']) {
-        logger.info(`no artifact found (ignonring this request)`);
+        logger.info(`no artifact found (ignoring this request)`);
         return { path, options, success: true };
     }
 

package/lib/index.js

@@ -1,4 +1,4 @@
-const { start_server } = require('mellon-server');
+
 const Validator = require('jsonschema').Validator;
 const fs = require('fs');
 const md5 = require('md5');
@@ -7,56 +7,21 @@ const {
     fetchOriginal, 
     backOff_fetch, 
     sendNotification,
-    moveTo
+    moveTo,
+    parseAsJSON
 } = require('../lib/util');
 const { handle_inbox } = require('../lib/handler');
 const logger = getLogger();
 
-let INBOX_URL = 'inbox/';
-let INBOX_PATH = './inbox';
-let INBOX_BASE_URL = 'http://localhost:8000';
-let INBOX_PUBLIC_READABLE = 0;
-let JSON_SCHEMA = '';
-
-function inbox_server(options) {
-    INBOX_URL = options['url'];
-    INBOX_PATH = options['inbox'];
-    INBOX_BASE_URL = options['base'];
-    INBOX_PUBLIC_READABLE = options['inboxPublic'];
-    JSON_SCHEMA = JSON.parse(fs.readFileSync(options['schema'], { encoding: 'utf-8'}));
-    let registry = [{ path : `${INBOX_URL}.*` , do: doInbox }];
-
-    // Add other (external defined) registry parts
-    if (options['registry']) {
-        const path = options['registry'];
-        let registry2;
-        if (typeof path === 'string' || path instanceof String) {
-            registry2 = JSON.parse(fs.readFileSync(path,{ encoding: 'utf-8'}));
-        }
-        else {
-            registry2 = path;
-        }
-        registry = registry.concat(registry2);
-    }
-
-    start_server({
-        host: options['host'],
-        port: options['port'],
-        base: options['base'],
-        public: options['public'],
-        registry: registry
-    });
-}
-
-function doInbox(req,res) {
-    if (req.method === 'GET' && INBOX_PUBLIC_READABLE == 1) {
-        doInboxGET(req,res);
+function doInbox(req,res,opts) {
+    if (req.method === 'GET' && opts['inboxPublic'] == 1) {
+        doInboxGET(req,res,opts);
     }
-    else if (req.method == 'HEAD' && INBOX_PUBLIC_READABLE == 1) {
-        doInboxHEAD(req,res);
+    else if (req.method == 'HEAD' && opts['inboxPublic'] == 1) {
+        doInboxHEAD(req,res,opts);
     }
-    else if (req.method === 'POST') {
-        doInboxPOST(req,res);
+    else if (req.method === 'POST' && opts['inboxWriteable'] == 1) {
+        doInboxPOST(req,res,opts);
     }
     else { 
         logger.error(`tried method ${req.method} on inbox : forbidden`);
@@ -65,16 +30,16 @@ function doInbox(req,res) {
     }
 }
 
-function doInboxGET(req,res) {
-    const pathItem = req.url.substring(INBOX_URL.length);
+function doInboxGET(req,res,opts) {
+    const pathItem = req.url.substring(opts['url'].length);
 
     logger.debug(`doInboxGET (for ${pathItem})`);
 
     if (pathItem === '/')  {
-        doInboxGET_Index(req,res);
+        doInboxGET_Index(req,res,opts);
     }
     else if (pathItem.match(/^\/[A-Za-z0-9_-]+\.jsonld$/)) {
-        doInboxGET_Read(req,res);
+        doInboxGET_Read(req,res,opts);
     }
     else {
         res.writeHead(403);
@@ -82,14 +47,14 @@ function doInboxGET(req,res) {
     }
 }
 
-function doInboxHEAD(req,res) {
-    const pathItem = req.url.substring(INBOX_URL.length);
+function doInboxHEAD(req,res,opts) {
+    const pathItem = req.url.substring(opts['url'].length);
     const id = pathItem.substring(1);
 
     logger.debug(`doInboxHEAD (for ${pathItem})`);
 
     if (pathItem === '/')  {
-        const meta = getBody(`${id}.meta`);
+        const meta = getBody(`${id}.meta`,opts);
     
         if (meta) {
             const metadata = JSON.parse(meta);
@@ -106,7 +71,7 @@ function doInboxHEAD(req,res) {
     }
 
     if (pathItem.match(/^\/[A-Za-z0-9_-]+\.jsonld$/)) {
-        const result = getBody(id);
+        const result = getBody(id,opts);
 
         if (! result) {
             res.writeHead(403);
@@ -114,7 +79,7 @@ function doInboxHEAD(req,res) {
             return;
         }
 
-        const meta = getBody(`${id}.meta`);
+        const meta = getBody(`${id}.meta`,opts);
         
         if (meta) {
             const metadata = JSON.parse(meta);
@@ -137,18 +102,18 @@ function doInboxHEAD(req,res) {
     }
 }
 
-function doInboxGET_Index(req,res) {
-    const notifications = listInbox().map( (e) => {
-        return INBOX_BASE_URL + '/' + INBOX_URL + e;
+function doInboxGET_Index(req,res,opts) {
+    const notifications = listInbox(opts).map( (e) => {
+        return opts['base'] + '/' + opts['url'] + e;
     });
 
     const result = {
         "@context": "http://www.w3.org/ns/ldp",
-        "@id": INBOX_BASE_URL + '/' + INBOX_URL,
+        "@id": opts['base'] + '/' + opts['url'],
         "contains": notifications
     };
 
-    const meta = getBody(`.meta`);
+    const meta = getBody(`.meta`,opts);
         
     if (meta) {
         const metadata = JSON.parse(meta);
@@ -164,13 +129,13 @@ function doInboxGET_Index(req,res) {
     res.end(JSON.stringify(result,null,2));
 }
 
-function doInboxGET_Read(req,res) {
-    const pathItem = req.url.substring(INBOX_URL.length);
+function doInboxGET_Read(req,res,opts) {
+    const pathItem = req.url.substring(opts['url'].length);
     const id = pathItem.substring(1);
-    const result = getBody(id);
+    const result = getBody(id,opts);
 
     if (result) {
-        const meta = getBody(`${id}.meta`);
+        const meta = getBody(`${id}.meta`,opts);
         
         if (meta) {
             const metadata = JSON.parse(meta);
@@ -191,8 +156,8 @@ function doInboxGET_Read(req,res) {
     }
 }
 
-function doInboxPOST(req,res) {
-    const pathItem = req.url.substring(INBOX_URL.length);
+function doInboxPOST(req,res,opts) {
+    const pathItem = req.url.substring(opts['url'].length);
 
     if (pathItem !== '/') {
         req.writeHead(403);
@@ -222,8 +187,8 @@ function doInboxPOST(req,res) {
     });
     req.on('end',() => {
         logger.debug(postData);
-        if (checkBody(postData)) {
-            const id = storeBody(postData);
+        if (checkBody(postData,opts)) {
+            const id = storeBody(postData,opts);
             logger.debug(`accepted ${req.url}${id}`);
             res.setHeader('Location',`${req.url}${id}`);
             res.writeHead(201);
@@ -237,13 +202,13 @@ function doInboxPOST(req,res) {
     });
 }
 
-function listInbox() {
+function listInbox(opts) {
     const glob = new RegExp("^.*\\.jsonld$");
 
     logger.debug(`listInbox()`);
 
     try {
-        const entries = fs.readdirSync(INBOX_PATH).filter( (file) => {
+        const entries = fs.readdirSync(opts['inbox']).filter( (file) => {
             return file.match(glob);
         });
         return entries;
@@ -254,21 +219,21 @@ function listInbox() {
     }
 }
 
-function getBody(id) {
+function getBody(id,opts) {
     logger.debug(`getBody(${id})`);
 
     try {
-        return fs.readFileSync(INBOX_PATH + '/' + id, {encoding : 'utf-8'});
+        return fs.readFileSync(opts['inbox'] + '/' + id, {encoding : 'utf-8'});
     }
     catch(e) {
         return null;
     }
 }
 
-function storeBody(data) {
+function storeBody(data,opts) {
     try {
         const id = md5(data);
-        const newpath = `${INBOX_PATH}/${id}.jsonld`;
+        const newpath = `${opts['inbox']}/${id}.jsonld`;
 
         if (! fs.existsSync(newpath)) {
             logger.debug(`storing ${newpath}`);
@@ -285,12 +250,13 @@ function storeBody(data) {
     }
 }
 
-function checkBody(data) {
-    if (! JSON_SCHEMA && ! fs.existsSync(JSON_SCHEMA)) {
+function checkBody(data,opts) {
+    if (! (opts['schema'] && fs.existsSync(opts['schema']))) {
         logger.debug(`no JSON_SCHEMA found`);
         return true;
     }
     try {
+        const JSON_SCHEMA = JSON.parse(fs.readFileSync(opts['schema'], { encoding: 'utf-8'}));
         const json = JSON.parse(data);
         const v = new Validator();
         const res = v.validate(json,JSON_SCHEMA);
@@ -310,8 +276,9 @@ function checkBody(data) {
 }
 
 module.exports = { 
-    inbox_server , 
+    doInbox,
     getLogger , 
+    parseAsJSON ,
     backOff_fetch , 
     fetchOriginal ,
     moveTo ,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ldn-inbox-server",
-  "version": "1.4.4",
+  "version": "1.4.6",
   "description": "A demonstration Event Notifications Inbox server",
   "main": "lib/index.js",
   "author": "Patrick Hochstenbach <Patrick.Hochstenbach@UGent.be>",
@@ -28,7 +28,7 @@
     "jsonpath": "^1.1.1",
     "jsonschema": "^1.4.1",
     "md5": "^2.3.0",
-    "mellon-server": "^1.0.8",
+    "mellon-server": "^1.0.9",
     "node-fetch": "1.7.3",
     "piscina": "^4.4.0",
     "proper-lockfile": "^4.1.2",