notherbase-fs 4.0.21 → 4.0.23

package/README.md

@@ -1,6 +1,6 @@
-# notherbase-fs
-A package to help one develop a base. 
-
-A base is an Express.js server that will render EJS web pages with automatic route creation. It also has a spirit world, a MongoDB-connected API to provide those pages with dynamic data and multiplayer interaction. A little bit of socket.io is sprinkled for good measure.
-
-Visit www.notherbase.com/docs for documentation on notherbase-fs.
+# notherbase-fs
+A package to help one develop a base. 
+
+A base is an Express.js server that will render EJS web pages with automatic route creation. It also has a spirit world, a MongoDB-connected API to provide those pages with dynamic data and multiplayer interaction. A little bit of socket.io is sprinkled for good measure.
+
+Visit www.notherbase.com/docs for documentation on notherbase-fs.

package/controllers/creation.js

@@ -1,148 +1,148 @@
-import express from "express";
-import fs from 'fs';
-
-/**
- * Creation is all the renedered pages in a base.
- */
-export default class Creation {
-    constructor(bases = {}) {
-        this.bases = bases;
-        this.router = express.Router();
-
-        //home
-        this.router.get("/", this.front, this.explore);
-
-        //the-front
-        this.router.get(`/the-front`, this.front, this.explore);
-        this.router.get(`/the-front/:frontDetail`, this.frontDetail, this.explore);
-
-        //pages
-        this.router.get(`/:page`, this.page, this.explore);
-
-        //the-front optional shortcuts
-        this.router.get(`/:frontDetail`, this.frontDetail, this.explore);
-
-        //explorer
-        this.router.get(`/:region/:area/:poi`, this.lock, this.poi, this.explore);
-        this.router.get(`/:region/:area/:poi/:detail`, this.lock, this.detail, this.explore);
-
-        //void
-        this.router.use(function(req, res) {
-            res.redirect("/void");
-        });
-    }
-
-    /**
-     * This middleware requires a user to login to access affected routes.
-     * @param {Object} req An Express.js request.
-     * @param {Object} res An Express.js response.
-     * @param {Function} next next()
-     */
-    lock = (req, res, next) => {
-        req.lock = true;
-        next();
-    }
-
-    /**
-     * This route renders a page and sends it to the client.
-     * @param {Object} req An Express.js request.
-     * @param {Object} res An Express.js response.
-     * @param {Function} next next()
-     */
-    explore = async (req, res, next) => {
-        try {
-            if (fs.existsSync(req.main + ".ejs")) {
-                let stats = await req.db.Spirit.recallOrCreateOne("stats", null, { route: req.path });
-                if (stats.memory.data.visits) stats.memory.data.visits++;
-                else stats.memory.data.visits = 1;
-                await stats.commit();
-
-                let context = {
-                    userID: null,
-                    user: null,
-                    siteTitle: req.siteTitle,
-                    main: req.main,
-                    query: req.query,
-                    route: req.path,
-                    requireUser: req.lock
-                }
-
-                if (req.session.currentUser) {
-                    context.user = await req.db.Spirit.recallOne("user",  null, { username: req.session.currentUser });
-                }                
-
-                res.render(req.toRender, context);
-            }
-            else next();
-        }
-        catch(err) {
-            console.log(err);
-            res.status(500).send("Server Error");
-        }
-    }
-
-    /**
-     * This middleware directs exploration to the front.
-     * @param {Object} req An Express.js request.
-     * @param {Object} res An Express.js response.
-     * @param {Function} next next()
-     */
-    front = async (req, res, next) => {
-        req.main = req.contentPath + "/the-front/index";
-        req.siteTitle = this.bases[req.hosting].title;
-        req.toRender = "explorer";
-        next();
-    }
-
-    /**
-     * This middleware directs exploration to a detail in the front.
-     * @param {Object} req An Express.js request.
-     * @param {Object} res An Express.js response.
-     * @param {Function} next next()
-     */
-    frontDetail = async (req, res, next) => {
-        req.main = `${req.contentPath}/the-front/${req.params.frontDetail}/index`;
-        req.siteTitle = `${this.bases[req.hosting].title} - ${req.params.frontDetail}`;
-        req.toRender = "explorer";
-        next();
-    }
-
-    /**
-     * This middleware directs exploration to a point of interest.
-     * @param {Object} req An Express.js request.
-     * @param {Object} res An Express.js response.
-     * @param {Function} next next()
-     */
-    poi = async (req, res, next) => {
-        req.main = `${req.contentPath}/${req.params.region}/${req.params.area}/${req.params.poi}/index`;
-        req.siteTitle = `${this.bases[req.hosting].title} - ${req.params.poi}`;
-        req.toRender = "explorer";
-        next();
-    }
-
-    /**
-     * This middleware directs exploration to a detail.
-     * @param {Object} req An Express.js request.
-     * @param {Object} res An Express.js response.
-     * @param {Function} next next()
-     */
-    detail = async (req, res, next) => {
-        req.main = `${req.contentPath}/${req.params.region}/${req.params.area}/${req.params.poi}/${req.params.detail}/index`;
-        req.siteTitle = `${this.bases[req.hosting].title} - ${req.params.detail}`;
-        req.toRender = "explorer";
-        next();
-    }
-
-    /**
-     * This middleware directs exploration to a one-off page.
-     * @param {Object} req An Express.js request.
-     * @param {Object} res An Express.js response.
-     * @param {Function} next next()
-     */
-    page = async (req, res, next) => {
-        req.main = `${req.contentPath}/pages/${req.params.page}/index`;
-        req.siteTitle = `${req.params.page}`;
-        req.toRender = req.main;
-        next();
-    }
+import express from "express";
+import fs from 'fs';
+
+/**
+ * Creation is all the renedered pages in a base.
+ */
+export default class Creation {
+    constructor(bases = {}) {
+        this.bases = bases;
+        this.router = express.Router();
+
+        //home
+        this.router.get("/", this.front, this.explore);
+
+        //the-front
+        this.router.get(`/the-front`, this.front, this.explore);
+        this.router.get(`/the-front/:frontDetail`, this.frontDetail, this.explore);
+
+        //pages
+        this.router.get(`/:page`, this.page, this.explore);
+
+        //the-front optional shortcuts
+        this.router.get(`/:frontDetail`, this.frontDetail, this.explore);
+
+        //explorer
+        this.router.get(`/:region/:area/:poi`, this.lock, this.poi, this.explore);
+        this.router.get(`/:region/:area/:poi/:detail`, this.lock, this.detail, this.explore);
+
+        //void
+        this.router.use(function(req, res) {
+            res.redirect("/void");
+        });
+    }
+
+    /**
+     * This middleware requires a user to login to access affected routes.
+     * @param {Object} req An Express.js request.
+     * @param {Object} res An Express.js response.
+     * @param {Function} next next()
+     */
+    lock = (req, res, next) => {
+        req.lock = true;
+        next();
+    }
+
+    /**
+     * This route renders a page and sends it to the client.
+     * @param {Object} req An Express.js request.
+     * @param {Object} res An Express.js response.
+     * @param {Function} next next()
+     */
+    explore = async (req, res, next) => {
+        try {
+            if (fs.existsSync(req.main + ".ejs")) {
+                let stats = await req.db.Spirit.recallOrCreateOne("stats", null, { route: req.path });
+                if (stats.memory.data.visits) stats.memory.data.visits++;
+                else stats.memory.data.visits = 1;
+                await stats.commit();
+
+                let context = {
+                    userID: null,
+                    user: null,
+                    siteTitle: req.siteTitle,
+                    main: req.main,
+                    query: req.query,
+                    route: req.path,
+                    requireUser: req.lock
+                }
+
+                if (req.session.currentUser) {
+                    context.user = await req.db.Spirit.recallOne("user",  null, { username: req.session.currentUser });
+                }                
+
+                res.render(req.toRender, context);
+            }
+            else next();
+        }
+        catch(err) {
+            console.log(err);
+            res.status(500).send("Server Error");
+        }
+    }
+
+    /**
+     * This middleware directs exploration to the front.
+     * @param {Object} req An Express.js request.
+     * @param {Object} res An Express.js response.
+     * @param {Function} next next()
+     */
+    front = async (req, res, next) => {
+        req.main = req.contentPath + "/the-front/index";
+        req.siteTitle = this.bases[req.hosting].title;
+        req.toRender = "explorer";
+        next();
+    }
+
+    /**
+     * This middleware directs exploration to a detail in the front.
+     * @param {Object} req An Express.js request.
+     * @param {Object} res An Express.js response.
+     * @param {Function} next next()
+     */
+    frontDetail = async (req, res, next) => {
+        req.main = `${req.contentPath}/the-front/${req.params.frontDetail}/index`;
+        req.siteTitle = `${this.bases[req.hosting].title} - ${req.params.frontDetail}`;
+        req.toRender = "explorer";
+        next();
+    }
+
+    /**
+     * This middleware directs exploration to a point of interest.
+     * @param {Object} req An Express.js request.
+     * @param {Object} res An Express.js response.
+     * @param {Function} next next()
+     */
+    poi = async (req, res, next) => {
+        req.main = `${req.contentPath}/${req.params.region}/${req.params.area}/${req.params.poi}/index`;
+        req.siteTitle = `${this.bases[req.hosting].title} - ${req.params.poi}`;
+        req.toRender = "explorer";
+        next();
+    }
+
+    /**
+     * This middleware directs exploration to a detail.
+     * @param {Object} req An Express.js request.
+     * @param {Object} res An Express.js response.
+     * @param {Function} next next()
+     */
+    detail = async (req, res, next) => {
+        req.main = `${req.contentPath}/${req.params.region}/${req.params.area}/${req.params.poi}/${req.params.detail}/index`;
+        req.siteTitle = `${this.bases[req.hosting].title} - ${req.params.detail}`;
+        req.toRender = "explorer";
+        next();
+    }
+
+    /**
+     * This middleware directs exploration to a one-off page.
+     * @param {Object} req An Express.js request.
+     * @param {Object} res An Express.js response.
+     * @param {Function} next next()
+     */
+    page = async (req, res, next) => {
+        req.main = `${req.contentPath}/pages/${req.params.page}/index`;
+        req.siteTitle = `${req.params.page}`;
+        req.toRender = req.main;
+        next();
+    }
 }

package/controllers/spirit-world.js

@@ -1,175 +1,175 @@
-import express from "express";
-import { stripHtml } from "string-strip-html";
-import { success, fail } from "./util.js";
-import User from "./user.js";
-import fs from 'fs';
-
-/**
-* The spirit world is the API of a base.
-*/
-export default class SpiritWorld {
-    /**
-     * Sets up the spirit world.
-     * @param {Server} io 
-     */
-    constructor(io) {
-        this.io = io;
-        this.rooms = {};
-        this.io.on('connection', this.setupChat);
-
-        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);
-    }
-
-    /**
-     * Sets up socket.io for instant messaging and etc.
-     * @param {*} socket 
-     */
-    setupChat = (socket) => {
-        let roomName = socket.handshake.query.room;
-        socket.join(roomName);
-        let room = this.rooms[roomName];
-        if (room) room.users.push(socket.handshake.query.name);
-        else {
-            this.rooms[roomName] = {
-                users: [ socket.handshake.query.name ]
-            }
-            room = this.rooms[roomName];
-        }
-    
-        this.io.to(roomName).emit("chat message", {
-            name: "Server",
-            time: Date.now(),
-            text: `${socket.handshake.query.name} has joined the room.`
-        });
-
-        this.io.to(roomName).emit("chat info", {
-            name: socket.handshake.query.room,
-            time: Date.now(),
-            data: {
-                users: room.users
-            }
-        });
-    
-        socket.on("chat message", (msg) => {
-            this.io.to(roomName).emit("chat message", {
-                name: msg.name,
-                time: msg.time,
-                text: stripHtml(msg.text).result
-            });
-        });
-    
-        socket.on('disconnect', () => {
-            room.users.splice(room.users.indexOf(socket.handshake.query.name));
-
-            this.io.to(roomName).emit("chat message", {
-                name: "Server",
-                time: Date.now(),
-                text: `${socket.handshake.query.name} has left the room.`
-            });
-
-            this.io.to(roomName).emit("chat info", {
-                name: socket.handshake.query.room,
-                time: Date.now(),
-                data: {
-                    users: room.users
-                }
-            });
-
-            if (room.users.length < 1) delete this.rooms[roomName];
-        });
-    }
-
-    /**
-     * This API route requests all spirits of a kind from the database.
-     * @param {Object} req
-     * @param {Object} res
-     * @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;
-                }
-            } 
-
-            // 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");
-        }
-    }
-
-    /**
-     * This API route requests a spirit of a kind from the database.
-     * @param {Object} req
-     * @param {Object} res
-     * @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;
-                }
-            } 
-
-            // 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");
-        }
-    }
-
-    /**
-     * This API route runs a script on the server. Responds with the result.
-     * @param {Object} req 
-     * @param {Object} res 
-     */
-    serve = async (req, res) => {
-        try {
-            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 });
-
-                script = await import(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");
-        }
-    }
+import express from "express";
+import { stripHtml } from "string-strip-html";
+import { success, fail } from "./util.js";
+import User from "./user.js";
+import fs from 'fs';
+
+/**
+* The spirit world is the API of a base.
+*/
+export default class SpiritWorld {
+    /**
+     * Sets up the spirit world.
+     * @param {Server} io 
+     */
+    constructor(io) {
+        this.io = io;
+        this.rooms = {};
+        this.io.on('connection', this.setupChat);
+
+        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);
+    }
+
+    /**
+     * Sets up socket.io for instant messaging and etc.
+     * @param {*} socket 
+     */
+    setupChat = (socket) => {
+        let roomName = socket.handshake.query.room;
+        socket.join(roomName);
+        let room = this.rooms[roomName];
+        if (room) room.users.push(socket.handshake.query.name);
+        else {
+            this.rooms[roomName] = {
+                users: [ socket.handshake.query.name ]
+            }
+            room = this.rooms[roomName];
+        }
+    
+        this.io.to(roomName).emit("chat message", {
+            name: "Server",
+            time: Date.now(),
+            text: `${socket.handshake.query.name} has joined the room.`
+        });
+
+        this.io.to(roomName).emit("chat info", {
+            name: socket.handshake.query.room,
+            time: Date.now(),
+            data: {
+                users: room.users
+            }
+        });
+    
+        socket.on("chat message", (msg) => {
+            this.io.to(roomName).emit("chat message", {
+                name: msg.name,
+                time: msg.time,
+                text: stripHtml(msg.text).result
+            });
+        });
+    
+        socket.on('disconnect', () => {
+            room.users.splice(room.users.indexOf(socket.handshake.query.name));
+
+            this.io.to(roomName).emit("chat message", {
+                name: "Server",
+                time: Date.now(),
+                text: `${socket.handshake.query.name} has left the room.`
+            });
+
+            this.io.to(roomName).emit("chat info", {
+                name: socket.handshake.query.room,
+                time: Date.now(),
+                data: {
+                    users: room.users
+                }
+            });
+
+            if (room.users.length < 1) delete this.rooms[roomName];
+        });
+    }
+
+    /**
+     * This API route requests all spirits of a kind from the database.
+     * @param {Object} req
+     * @param {Object} res
+     * @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;
+                }
+            } 
+
+            // 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");
+        }
+    }
+
+    /**
+     * This API route requests a spirit of a kind from the database.
+     * @param {Object} req
+     * @param {Object} res
+     * @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;
+                }
+            } 
+
+            // 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");
+        }
+    }
+
+    /**
+     * This API route runs a script on the server. Responds with the result.
+     * @param {Object} req 
+     * @param {Object} res 
+     */
+    serve = async (req, res) => {
+        try {
+            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 });
+
+                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");
+        }
+    }
 }