notherbase-fs 4.0.23 → 4.1.1

package/controllers/creation.js

@@ -64,12 +64,31 @@ export default class Creation {
                     main: req.main,
                     query: req.query,
                     route: req.path,
-                    requireUser: req.lock
+                    requireUser: req.lock,
+                    preprocessed: {}
                 }
 
                 if (req.session.currentUser) {
                     context.user = await req.db.Spirit.recallOne("user",  null, { username: req.session.currentUser });
-                }                
+                }      
+
+                //preprocess
+                let preprocessScripts = fs.existsSync(req.preprocess) ? fs.readdirSync(req.preprocess) : [];
+                for (let preprocessScript of preprocessScripts) {
+                    try {
+                        let scriptPath = `${req.preprocess}/${preprocessScript}`;
+
+                        if (fs.existsSync(scriptPath)) {
+                            let script = await import(process.env.WINDOWS == "true" ? `file://${scriptPath}` : scriptPath);
+                            let result = await script.default(req, context.user, this.io);
+                            context.preprocessed[preprocessScript.split(".")[0]] = result;
+                        }
+                        else context.preprocessed[preprocessScript.split(".")[0]] = `Error: Script Not Found`;
+                    } catch (error) {
+                        console.log(error);
+                        context.preprocessed[preprocessScript.split(".")[0]] = `Error: Server Error`;
+                    }
+                }
 
                 res.render(req.toRender, context);
             }
@@ -89,6 +108,7 @@ export default class Creation {
      */
     front = async (req, res, next) => {
         req.main = req.contentPath + "/the-front/index";
+        req.preprocess = req.contentPath + "/the-front/_preprocess";
         req.siteTitle = this.bases[req.hosting].title;
         req.toRender = "explorer";
         next();
@@ -102,6 +122,7 @@ export default class Creation {
      */
     frontDetail = async (req, res, next) => {
         req.main = `${req.contentPath}/the-front/${req.params.frontDetail}/index`;
+        req.preprocess = `${req.contentPath}/the-front/${req.params.frontDetail}/_preprocess`;
         req.siteTitle = `${this.bases[req.hosting].title} - ${req.params.frontDetail}`;
         req.toRender = "explorer";
         next();
@@ -115,6 +136,7 @@ export default class Creation {
      */
     poi = async (req, res, next) => {
         req.main = `${req.contentPath}/${req.params.region}/${req.params.area}/${req.params.poi}/index`;
+        req.preprocess = `${req.contentPath}/${req.params.region}/${req.params.area}/${req.params.poi}/_preprocess`;
         req.siteTitle = `${this.bases[req.hosting].title} - ${req.params.poi}`;
         req.toRender = "explorer";
         next();
@@ -128,6 +150,7 @@ export default class Creation {
      */
     detail = async (req, res, next) => {
         req.main = `${req.contentPath}/${req.params.region}/${req.params.area}/${req.params.poi}/${req.params.detail}/index`;
+        req.preprocess = `${req.contentPath}/${req.params.region}/${req.params.area}/${req.params.poi}/${req.params.detail}/_preprocess`;
         req.siteTitle = `${this.bases[req.hosting].title} - ${req.params.detail}`;
         req.toRender = "explorer";
         next();
@@ -141,6 +164,7 @@ export default class Creation {
      */
     page = async (req, res, next) => {
         req.main = `${req.contentPath}/pages/${req.params.page}/index`;
+        req.preprocess = `${req.contentPath}/pages/${req.params.page}/_preprocess`;
         req.siteTitle = `${req.params.page}`;
         req.toRender = req.main;
         next();

package/controllers/spirit-world.js

@@ -19,10 +19,20 @@ export default class SpiritWorld {
 
         this.user = new User();
         this.router = express.Router();
-        this.router.post("/loadAll", this.loadAll);
-        this.router.post("/load", this.load);
-        this.router.post("/serve", this.serve);
-        this.router.use("/user", this.user.router);
+        this.router.post("/loadAll", this.catchErrors, this.loadAll);
+        this.router.post("/load", this.catchErrors, this.load);
+        this.router.post("/serve", this.catchErrors, this.serve);
+        this.router.use("/user", this.catchErrors, this.user.router);
+    }
+
+    // abstract out the try catch pattern
+    catchErrors = async (req, res, next) => {
+        try {
+            await next();
+        } catch (error) {
+            console.log(error);
+            fail(res, "Server error");
+        }
     }
 
     /**
@@ -91,29 +101,24 @@ export default class SpiritWorld {
      * @returns {Object} The requested spirits.
      */
     loadAll = async (req, res) => {
-        try {
-            let parent = null;
-            let data = req.body.data ? req.body.data : {};
-            let id = req.body.id ? req.body.id : null;
-
-            // if the scope is local, the parent is the user's id
-            if (req.body.scope === "local") {
-                let user = await req.db.Spirit.recallOne("user",  null, { username: req.session?.currentUser });
-                if (user?.memory?._id) parent = user.memory._id;
-                else {
-                    fail(res, "User had no id on load()");
-                    return;
-                }
-            } 
+        let parent = null;
+        let data = req.body.data ? req.body.data : {};
+        let id = req.body.id ? req.body.id : null;
+
+        // if the scope is local, the parent is the user's id
+        if (req.body.scope === "local") {
+            let user = await req.db.Spirit.recallOne("user",  null, { username: req.session?.currentUser });
+            if (user?.memory?._id) parent = user.memory._id;
+            else {
+                fail(res, "User had no id on load()");
+                return;
+            }
+        } 
 
-            // recall all spirits with the given service name and parent
-            let spirits = await req.db.Spirit.recallAll(req.body.service, parent, data, id);
+        // recall all spirits with the given service name and parent
+        let spirits = await req.db.Spirit.recallAll(req.body.service, parent, data, id);
 
-            res.send(spirits);
-        } catch (error) {
-            console.log(error);
-            fail(res, "Server error");
-        }
+        res.send(spirits);
     }
 
     /**
@@ -123,29 +128,24 @@ export default class SpiritWorld {
      * @returns {Object} The requested spirit.
      */
     load = async (req, res) => {
-        try {
-            let parent = null;
-            let data = req.body.data ? req.body.data : {};
-            let id = req.body.id ? req.body.id : null;
-
-            // if the scope is local, the parent is the user's id
-            if (req.body.scope === "local") {
-                let user = await req.db.Spirit.recallOne("user",  null, { username: req.session?.currentUser });
-                if (user?.memory?._id) parent = user.memory._id;
-                else {
-                    fail(res, "User had no id on load()");
-                    return;
-                }
-            } 
+        let parent = null;
+        let data = req.body.data ? req.body.data : {};
+        let id = req.body.id ? req.body.id : null;
+
+        // if the scope is local, the parent is the user's id
+        if (req.body.scope === "local") {
+            let user = await req.db.Spirit.recallOne("user",  null, { username: req.session?.currentUser });
+            if (user?.memory?._id) parent = user.memory._id;
+            else {
+                fail(res, "User had no id on load()");
+                return;
+            }
+        } 
 
-            // recall all spirits with the given service name and parent
-            let spirit = await req.db.Spirit.recallOne(req.body.service, parent, data, id);
+        // recall all spirits with the given service name and parent
+        let spirit = await req.db.Spirit.recallOne(req.body.service, parent, data, id);
 
-            res.send(spirit);
-        } catch (error) {
-            console.log(error);
-            fail(res, "Server error");
-        }
+        res.send(spirit);
     }
 
     /**
@@ -154,22 +154,17 @@ export default class SpiritWorld {
      * @param {Object} res 
      */
     serve = async (req, res) => {
-        try {
-            let scriptPath = `${req.contentPath}${req.body.route}/${req.body.script}.js`;
-            
-            let script, result = null;
+        let scriptPath = `${req.contentPath}${req.body.route}/${req.body.script}.js`;
+        
+        let script, result = null;
 
-            if (fs.existsSync(scriptPath)) {
-                let user = await req.db.Spirit.recallOne("user",  null, { username: req.session?.currentUser });
+        if (fs.existsSync(scriptPath)) {
+            let user = await req.db.Spirit.recallOne("user",  null, { username: req.session?.currentUser });
 
-                script = await import(process.env.WINDOWS == "true" ? `file://${scriptPath}` : scriptPath);
-                result = await script.default(req, user, this.io);
-                success(res, "Served.", result);
-            }
-            else fail(res, `Script not found: ${req.body.script} at ${scriptPath}`);
-        } catch (error) {
-            console.log(error);
-            fail(res, "Server error");
+            script = await import(process.env.WINDOWS == "true" ? `file://${scriptPath}` : scriptPath);
+            result = await script.default(req, user, this.io);
+            success(res, "Served.", result);
         }
+        else fail(res, `Script not found: ${req.body.script} at ${scriptPath}`);
     }
 }

package/controllers/user.js

@@ -221,19 +221,21 @@ export default class User {
             let user = await req.db.Spirit.recallOne("user",  null, { username: req.session.currentUser }); 
 
             if (check(res, user, "Account not found!")) {
-                let passResult = await bcrypt.compare(req.body.password, user.memory.data.password);
-
-                if (check(res, passResult, "Password doesn't match the username.")) {
-                    let data = JSON.parse(req.body.data);
-                    let imported = 0;
-                    for (let i = 0; i < data.length; i++) {
-                        if (data[i].parent != null) {
-                            let spirit = await req.db.Spirit.create(data[i].service, data[i].data, user.memory._id);
-                            if (spirit) imported++;
+                if (check(res, req.body.password, "Password error.")) {
+                    let passResult = await bcrypt.compare(req.body.password, user.memory.data.password);
+
+                    if (check(res, passResult, "Password doesn't match the username.")) {
+                        let data = JSON.parse(req.body.data);
+                        let imported = 0;
+                        for (let i = 0; i < data.length; i++) {
+                            if (data[i].parent != null) {
+                                let spirit = await req.db.Spirit.create(data[i].service, data[i].data, user.memory._id);
+                                if (spirit) imported++;
+                            }
                         }
-                    }
 
-                    success(res, "Data Imported", imported);
+                        success(res, "Data Imported", imported);
+                    }
                 }
             }
         }

package/notherbase-fs.js

@@ -26,8 +26,10 @@ class NotherBaseFS {
         this.spiritWorld = new SpiritWorld(this.io);
         this.creation = new Creation(bases);
 
-        //set views path
+        //set view engine
         this.app.set("view engine", "ejs");
+        
+        //set views path
         this.app.set("views", `${__dirname}/views`); 
     
         // allows us to use post body data

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "notherbase-fs",
-  "version": "4.0.23",
+  "version": "4.1.1",
   "description": "Functions to help make developing for NotherBase easier.",
   "exports": "./notherbase-fs.js",
   "scripts": {

package/test/the-front/check/_preprocess/saved.js

@@ -0,0 +1,9 @@
+export default async (req, user, io) => {
+    if (user) {
+        let spirit = await req.db.Spirit.recallOne("test-save3", user.memory._id);
+    
+        return spirit.memory.data.text;
+    }
+
+    return "Not Logged In";
+}

package/test/the-front/check/index.ejs

@@ -12,6 +12,7 @@
 <button class="switch" onclick="base.do('flip')">Flip Me</button>
 <input type="text" id="test" placeholder="Loading...">
 <button onclick="saveInput()">Save</button>
+<p>saved: <%= preprocessed.saved %></p>
 
 <hr>
 

package/test/the-front/check/save-input.js

@@ -1,5 +1,5 @@
 export default async (req, user, io) => {
-    let spirit = await req.db.Spirit.recallOne("test-save3", user.memory._id);
+    let spirit = await req.db.Spirit.recallOrCreateOne("test-save3", user.memory._id);
     // console.log(req.body.text, spirit.memory);
 
     await spirit.commit({