notherbase-fs 3.5.2 → 4.0.1

package/controllers/creation.js

@@ -1,12 +1,13 @@
 import express from "express";
 import fs from 'fs';
+import { fileURLToPath } from 'node:url';
 
 /**
  * Creation is all the renedered pages in a base.
  */
 export default class Creation {
-    constructor(siteTitle = "Base") {
-        this.siteTitle = siteTitle;
+    constructor(bases = {}) {
+        this.bases = bases;
         this.router = express.Router();
 
         //home
@@ -68,7 +69,7 @@ export default class Creation {
                 }
 
                 if (req.session.currentUser) {
-                    context.user = await req.db.Spirit.recallOne("user",  null, { email: req.session.currentUser });
+                    context.user = await req.db.Spirit.recallOne("user",  null, { username: req.session.currentUser });
                 }
 
                 res.render(req.toRender, context);

package/controllers/spirit-world.js

@@ -3,6 +3,9 @@ import { stripHtml } from "string-strip-html";
 import { success, fail } from "./util.js";
 import User from "./user.js";
 import fs from 'fs';
+import session from 'express-session';
+import MongoStore from 'connect-mongo';
+import subdomain from 'express-subdomain';
 
 /**
 * The spirit world is the API of a base.
@@ -15,49 +18,49 @@ export default class SpiritWorld {
     constructor(io) {
         this.io = io;
         this.rooms = {};
+        this.io.on('connection', this.setupChat);
 
-        this.router = express.Router();
         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.io.on('connection', this.#setupChat);
     }
 
     /**
      * Sets up socket.io for instant messaging and etc.
      * @param {*} socket 
      */
-    #setupChat = (socket) => {
-        socket.join(socket.handshake.query.room);
-        if (this.rooms[socket.handshake.query.room]) this.rooms[socket.handshake.query.room].users.push(socket.handshake.query.name);
+    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[socket.handshake.query.room] = {
-                users: [
-                    socket.handshake.query.name
-                ]
+            this.rooms[roomName] = {
+                users: [ socket.handshake.query.name ]
             }
+            room = this.rooms[roomName];
         }
     
-        this.io.to(socket.handshake.query.room).emit("chat message", {
+        this.io.to(roomName).emit("chat message", {
             name: "Server",
             time: Date.now(),
             text: `${socket.handshake.query.name} has joined the room.`
         });
 
-        this.io.to(socket.handshake.query.room).emit("chat info", {
+        this.io.to(roomName).emit("chat info", {
             name: socket.handshake.query.room,
             time: Date.now(),
             data: {
-                users: this.rooms[socket.handshake.query.room].users
+                users: room.users
             }
         });
     
         socket.on("chat message", (msg) => {
-            this.io.to(socket.handshake.query.room).emit("chat message", {
+            this.io.to(roomName).emit("chat message", {
                 name: msg.name,
                 time: msg.time,
                 text: stripHtml(msg.text).result
@@ -65,23 +68,23 @@ export default class SpiritWorld {
         });
     
         socket.on('disconnect', () => {
-            this.rooms[socket.handshake.query.room].users.splice(this.rooms[socket.handshake.query.room].users.indexOf(socket.handshake.query.name));
+            room.users.splice(room.users.indexOf(socket.handshake.query.name));
 
-            this.io.to(socket.handshake.query.room).emit("chat message", {
+            this.io.to(roomName).emit("chat message", {
                 name: "Server",
                 time: Date.now(),
                 text: `${socket.handshake.query.name} has left the room.`
             });
 
-            this.io.to(socket.handshake.query.room).emit("chat info", {
+            this.io.to(roomName).emit("chat info", {
                 name: socket.handshake.query.room,
                 time: Date.now(),
                 data: {
-                    users: this.rooms[socket.handshake.query.room].users
+                    users: room.users
                 }
             });
 
-            if (this.rooms[socket.handshake.query.room].users.length < 1) delete this.rooms[socket.handshake.query.room];
+            if (room.users.length < 1) delete this.rooms[roomName];
         });
     }
 
@@ -99,7 +102,7 @@ export default class SpiritWorld {
 
             // 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, { email: req.session.currentUser });
+                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()");
@@ -131,7 +134,7 @@ export default class SpiritWorld {
 
             // 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, { email: req.session.currentUser });
+                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()");
@@ -161,7 +164,7 @@ export default class SpiritWorld {
             let script, result = null;
 
             if (fs.existsSync(scriptPath)) {
-                let user = await req.db.Spirit.recallOne("user",  null, { email: req.session.currentUser });
+                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);

package/controllers/user.js

@@ -1,6 +1,6 @@
 import express from "express";
 import bcrypt from "bcrypt";
-import { check, success, fail, loginCheck } from "./util.js";
+import { check, success, successJSON, fail, loginCheck } from "./util.js";
 
 /**
  * API routes for user functions.
@@ -10,16 +10,16 @@ export default class User {
         this.router = express.Router();
 
         this.router.post("/logout", this.logout);
-        this.router.post("/sendPasswordReset", this.sendPasswordReset);
         this.router.post("/changePassword", this.changePassword);
         this.router.post("/register", this.register);
         this.router.post("/login", this.login);
-        this.router.post("/changeEmail", this.changeEmail);
-        this.router.post("/changeUsername", this.changeUsername);
         this.router.post("/deletePermanently", this.deletePermanently);
         this.router.post("/getInfo", this.getInfo);
         this.router.post("/getView", this.getView);
         this.router.post("/setView", this.setView);
+        this.router.post("/downloadData", this.downloadData);
+        this.router.post("/deleteAlldata", this.deleteAlldata);
+        this.router.post("/importData", this.importData);
     }
 
     /**
@@ -33,57 +33,34 @@ export default class User {
         success(res, "Logged out.");
     }
 
-    /**
-     * Sends an email with a password reset code.
-     * @param {Object} req An Express.js request.
-     * @param {Object} res An Express.js response.
-     */
-    sendPasswordReset = async (req, res) => {
-        let spirit = await req.db.Spirit.recallOne("user",  null, { email: req.body.email });
-
-        if (spirit) {
-            let token = Math.floor(Math.random() * 9999);
-
-            spirit.memory.data.resetToken = token;
-            spirit.memory.data.resetExp = Date.now() + (1000 * 60 * 10);
-            await spirit.commit();
-    
-            if (req.body.test) console.log("token: " + token);
-            else req.db.SendMail.passwordReset(req.body.email, token);
-    
-            success(res, "Password reset token sent.");
-        }
-        else fail(res, "User not found.");
-    }
-
     /**
      * Change a user's password.
      * @param {Object} req An Express.js request.
      * @param {Object} res An Express.js response.
      */
     changePassword = async (req, res) => {
-        if (check(res, req.body.token, "No token provided!")){
-            let spirit = await req.db.Spirit.recallOne("user",  null, { email: req.body.email });
-    
+        if (loginCheck(req, res)) {
+            let spirit = await req.db.Spirit.recallOne("user",  null, { username: req.session.currentUser });  
+
             if (check(res, spirit, "User not found!") &&
-                check(res, spirit.memory.data.resetToken == req.body.token, "Reset token not valid!") &&
-                check(res, spirit.memory.data.resetExp > Date.now(), "Reset token expired!") &&
-                check(res, req.body.password === req.body.confirmation, "Passwords must match!")) 
+                check(res, req.body.newPassword === req.body.confirmation, "New password and confirmation must match!") &&
+                check(res, req.body.oldPassword != req.body.newPassword, "New password must be different from the old one."))
             {
-                spirit.memory.data.resetExp = -1;
-        
-                const salt = await bcrypt.genSalt(10);
-                const hash = await bcrypt.hash(req.body.password, salt);
-        
-                spirit.memory.data.password = hash;
-                spirit.addBackup({
-                    ...spirit.memory.data,
-                    password: hash
-                });
-                
-                await spirit.commit();
-        
-                success(res, "Password changed successfully!");
+                let passResult = await bcrypt.compare(req.body.oldPassword, spirit.memory.data.password);
+
+                if (check(res, passResult, "Old password incorrect.")) {
+                    const salt = await bcrypt.genSalt(10);
+                    const hash = await bcrypt.hash(req.body.newPassword, salt);
+    
+                    spirit.addBackup({
+                        ...spirit.memory.data,
+                        password: hash
+                    });
+                    
+                    await spirit.commit();
+            
+                    success(res, "Password changed successfully!");
+                }
             }
         }
     }
@@ -94,33 +71,20 @@ export default class User {
      * @param {Object} res An Express.js response.
      */
     register = async (req, res) => {
-        if (check(res, req.body.password.length > 7, "Password too short.") &&
-            check(res, req.body.email.length > 7, "Email too short.") &&
+        if (check(res, req.body.password.length > 10, "Password must be >10 characters long.") &&
             check(res, req.body.username.length > 2, "Username too short.")) 
         {
-            let spirit = await req.db.Spirit.recallOne("user",  null, { email: req.body.email });
+            let spirit = await req.db.Spirit.recallOne("user",  null, { username: req.body.username });
     
-            if (check(res, !spirit, "Email already in use!")) {
+            if (check(res, !spirit, "Username already in use!")) {
                 const salt = await bcrypt.genSalt(10);
                 const hash = await bcrypt.hash(req.body.password, salt);
 
                 spirit = await req.db.Spirit.create("user", { 
                     username: req.body.username, 
-                    email: req.body.email,
                     password: hash,
-                    resetToken: null,
-                    resetExp: null,
-                    coin: 0,
-                    home: "/",
                     authLevels: [ "Basic" ],
-                    location: "/the-front",
-                    attributes: {
-                        translation: 0,
-                        strength: 0,
-                        agility: 0,
-                        defense: 0
-                    },
-                    inventory: []
+                    view: "compact"
                 });
         
                 success(res, "Registration successful!");
@@ -134,61 +98,19 @@ export default class User {
      * @param {Object} res An Express.js response.
      */
     login = async (req, res) => {
-        let spirit = await req.db.Spirit.recallOne("user",  null, { email: req.body.email });
+        let spirit = await req.db.Spirit.recallOne("user",  null, { username: req.body.username });
 
         if (check(res, spirit, "User not found.")) {
             let passResult = await bcrypt.compare(req.body.password, spirit.memory.data.password);
             
-            if (check(res, passResult, "Password doesn't match the email.")) {
-                req.session.currentUser = req.body.email;
-        
+            if (check(res, passResult, "Password doesn't match the username.")) {
+                req.session.currentUser = req.body.username;
+                
                 success(res, "Logged in.", spirit.memory.data.username);
             }
         }
     }
 
-    /**
-     * Changes a user's email address on file.
-     * @param {Object} req An Express.js request.
-     * @param {Object} res An Express.js response.
-     */
-    changeEmail = async (req, res) => {
-        if (loginCheck(req, res)) {
-            let spirit = await req.db.Spirit.recallOne("user",  null, { email: req.body.email });
-    
-            if (check(res, !spirit, "Email already in use!")) {
-                spirit = await req.db.Spirit.recallOne("user",  null, { email: req.session.currentUser });
-        
-                spirit.memory.data.email = req.body.email;
-                await spirit.commit();
-        
-                req.session.currentUser = req.body.email;
-        
-                success(res, "Email changed.");
-            }
-        }
-    }
-
-    /**
-     * Changes a user's display name.
-     * @param {Object} req An Express.js request.
-     * @param {Object} res An Express.js response.
-     */
-    changeUsername = async (req, res) => {
-        if (loginCheck(req, res)) {
-            let spirit = await req.db.Spirit.recallOne("user",  null, { username: req.body.username });
-    
-            if (check(res, !spirit, "Username already in use!")) {
-                spirit = await req.db.Spirit.recallOne("user",  null, { email: req.session.currentUser });
-        
-                spirit.memory.data.username = req.body.username;
-                await spirit.commit();
-        
-                success(res, "Username changed");
-            }
-        }
-    }
-
     /**
      * Deletes a user account premanently.
      * @param {Object} req An Express.js request.
@@ -196,12 +118,20 @@ export default class User {
      */
     deletePermanently = async (req, res) => {
         if (loginCheck(req, res)) {
-            let deleted = await req.db.Spirit.delete("user",  null, { email: req.session.currentUser });
-    
-            if (check(res, deleted > 0, "No account deleted")) {
-                await req.session.destroy();
-        
-                success(res, "Account deleted.");
+            let spirit = await req.db.Spirit.recallOne("user",  null, { username: req.session.currentUser });
+
+            if (check(res, spirit, "User not found.")) {
+                let passResult = await bcrypt.compare(req.body.password, spirit.memory.data.password);
+
+                if (check(res, passResult, "Password doesn't match the username.")) {
+                    let deleted = await req.db.Spirit.delete("user",  null, { username: req.session.currentUser });
+            
+                    if (check(res, deleted > 0, "No account deleted")) {
+                        await req.session.destroy();
+                
+                        success(res, "Account deleted.");
+                    }
+                }
             }
         }
     }
@@ -213,15 +143,12 @@ export default class User {
      */
     getInfo = async (req, res) => {
         if (loginCheck(req, res)) {
-            let user = await req.db.Spirit.recallOne("user",  null, { email: req.session.currentUser });
+            let user = await req.db.Spirit.recallOne("user",  null, { username: req.session.currentUser });
     
             if (check(res, user, "Account not found!")) {
-                if (check(res, user.memory._lastUpdate > req.body._lastUpdate, "Info up to date.")) {
-                    success(res, "Info found", {
-                        email: user.memory.data.email,
-                        username: user.memory.data.username
-                    });
-                }
+                success(res, "Info found", {
+                    username: user.memory.data.username
+                });
             }
         }
     }
@@ -231,7 +158,7 @@ export default class User {
      */
     getView = async (req, res) => {
         if (loginCheck(req, res)) {
-            let user = await req.db.Spirit.recallOne("user",  null, { email: req.session.currentUser });
+            let user = await req.db.Spirit.recallOne("user",  null, { username: req.session.currentUser });
 
             if (check(res, user, "Account not found!")) {
                 success(res, "View found", user.memory.data.view);
@@ -244,14 +171,71 @@ export default class User {
      */
     setView = async (req, res) => {
         if (loginCheck(req, res)) {
-            let user = await req.db.Spirit.recallOne("user",  null, { email: req.session.currentUser });
+            let user = await req.db.Spirit.recallOne("user",  null, { username: req.session.currentUser });
 
             if (check(res, user, "Account not found!")) {
-                user.memory.data.view = req.body.view;
+                user.memory.data.view = req.body.view == "compact" ? "compact" : "full";
                 await user.commit();
 
                 success(res, "View set");
             }
         }
     }
+
+    //download all spirit data belonging to the user
+    downloadData = async (req, res) => {
+        if (loginCheck(req, res)) {
+            let user = await req.db.Spirit.recallOne("user",  null, { username: req.session.currentUser });
+
+            if (check(res, user, "Account not found!")) {
+                let data = await req.db.Spirit.recallAll(null, user.memory._id);
+                let dataToDownload = data.map(d => d.memory);
+                dataToDownload.unshift(user.memory.data);
+
+                successJSON(res, "Data Downloaded", dataToDownload);
+            }
+        }
+    }
+
+    //delete all spirit data belonging to the user
+    deleteAlldata = async (req, res) => {
+        if (loginCheck(req, res)) {
+            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 deleted = await req.db.Spirit.delete(null, user.memory._id);
+                    if (check(res, deleted > 0, "No data deleted")) {
+                        success(res, "Data Deleted", deleted);
+                    }
+                }
+            }
+        }
+    }
+
+    // import spirit data from a JSON file
+    importData = async (req, res) => {
+        if (loginCheck(req, res)) {
+            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 = 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);
+                }
+            }
+        }
+    }
 }

package/controllers/util.js

@@ -31,6 +31,15 @@ export const success = (res, msg = "Success!", data = null, lastUpdate = 0) => {
     });
 };
 
+export const successJSON = (res, msg = "Success!", data = null, lastUpdate = 0) => {
+    res.json({
+        status: "success",
+        message: msg,
+        lastUpdate: lastUpdate,
+        data: data
+    });
+}
+
 /**
  * Respond to the client with failure.
  * @param {Object} res An Express.js response.
@@ -52,5 +61,5 @@ export const fail = (res, msg = "Failed!") => {
  * @returns True if a user is logged in, else false.
  */
 export const loginCheck = (req, res) => {
-    return check(res, req.session.currentUser, "Please login first.");
+    return check(res, req.session?.currentUser, "Please login first.");
 }

package/models/spirit.js

@@ -27,10 +27,10 @@ export default class Spirit {
      */
     static buildQuery = (service, data = null, parent = null, id = null) => {
         let query = {
-            service: service,
             parent: parent
         };
         
+        if (service) query.service = service;
         if (id) query._id = id;
         else if (data){
             let keys = Object.keys(data);

package/notherbase-fs.js

@@ -3,74 +3,86 @@ dotenv.config();
 import Models from "./models/index.js";
 import { Server } from "socket.io";
 import express from "express";
-import session from 'express-session';
-import methodOverride from 'method-override';
-import MongoStore from 'connect-mongo';
-import favicon from 'serve-favicon';
 import http from 'http';
 import { fileURLToPath } from 'node:url';
 const __dirname = fileURLToPath(new URL('./', import.meta.url));
 import Creation from "./controllers/creation.js";
 import SpiritWorld from "./controllers/spirit-world.js";
+import favicon from 'serve-favicon';
+import session from 'express-session';
+import MongoStore from 'connect-mongo';
+
 
 /**
  * The engine that runs a nother base.
  */
 class NotherBaseFS {
-    constructor(contentPath, globals = null, settings = {}) {
-        this.settings = {
-            siteTitle: "NotherBase",
-            favicon: null,
-            ...settings
+    constructor(globals = {}, bases = {}) {
+        this.bases = bases;
+        let baseKeys = Object.keys(this.bases);
+        for (let i = 0; i < baseKeys.length; i++) {
+            this.bases[baseKeys[i]].directory = fileURLToPath(new URL(this.bases[baseKeys[i]].directory, import.meta.url));
+            this.bases[baseKeys[i]].static = express.static(this.bases[baseKeys[i]].directory + "/public");
+            this.bases[baseKeys[i]].favicon = favicon(this.bases[baseKeys[i]].directory + this.bases[baseKeys[i]].icon);
+            this.bases[baseKeys[i]].session = session({
+                store: MongoStore.create({ mongoUrl: process.env.MONGODB_URI }),
+                secret: process.env.SECRET,
+                name: baseKeys[i] + '-session-id',
+                resave: false,
+                saveUninitialized: false,
+                cookie: { 
+                    secure: process.env.PRODUCTION == "true",
+                    maxAge: 1000 * 60 * 60 * 24 * 28 // 28 days 
+                } 
+            });
         }
+
         this.app = express();
         this.server = http.createServer(this.app);
         this.io = new Server(this.server);
-        this.creation = new Creation(this.settings.siteTitle);
         this.spiritWorld = new SpiritWorld(this.io);
+        this.creation = new Creation(bases);
         
         //set views path
         this.app.set("view engine", "ejs");
         this.app.set("views", `${__dirname}/views`); 
     
-        // allows us to delete
-        this.app.use(methodOverride('_method'));
-    
         // allows us to use post body data
         this.app.use(express.json({
             extended: true,
             inflate: true,
             type: 'application/x-www-form-urlencoded'
-          }));
-        //this.app.use(express.urlencoded({ extended: true }));
-    
+        }));
+
+        //provide database access and etc to use in routes
+        this.app.use((req, res, next) => {
+            req.hosting = req.hostname.split(".")[0];
+            req.contentPath = this.bases[req.hosting].directory;
+            next();
+        });
+
+        this.app.use((req, res, next) => {
+            this.bases[req.hosting].favicon(req, res, next);
+        });
+
+        //enable cookies
+        this.app.use((req, res, next) => {
+            this.bases[req.hosting].session(req, res, next);
+        });       
+
         // allows us to get static files like css
         this.app.use(express.static('public'));
-        this.app.use(express.static(`${__dirname}/public`));
-    
-        // sets the favicon image
-        if (this.settings.favicon) this.app.use(favicon(this.settings.favicon));
-        else this.app.use(favicon(__dirname + '/public/img/logo.png'));
+        this.app.use((req, res, next) => {
+            this.bases[req.hosting].static(req, res, next);
+        });
     
-        //enable cookies
+        //be safe
         if (process.env.PRODUCTION == "true") this.app.set('trust proxy', 1);
-        this.app.use(session({
-            store: MongoStore.create({ mongoUrl: process.env.MONGODB_URI }),
-            secret: process.env.SECRET,
-            name: 'session-id',
-            resave: false,
-            saveUninitialized: false,
-            cookie: { 
-                secure: process.env.PRODUCTION == "true",
-                maxAge: 1000 * 60 * 60 * 24 * 28 // 28 days 
-            } 
-        }));
 
         //provide database access and etc to use in routes
         this.app.use((req, res, next) => {
             req.globals = globals;
             req.db = Models;
-            req.contentPath = contentPath;
             req.lock = false;
             next();
         });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "notherbase-fs",
-  "version": "3.5.2",
+  "version": "4.0.1",
   "description": "Functions to help make developing for NotherBase easier.",
   "exports": "./notherbase-fs.js",
   "scripts": {
@@ -25,8 +25,8 @@
     "ejs": "^3.1.6",
     "express": "^4.17.1",
     "express-session": "^1.17.2",
+    "express-subdomain": "^1.0.6",
     "googleapis": "^100.0.0",
-    "method-override": "^3.0.0",
     "mongoose": "^6.1.7",
     "nodemailer": "^6.9.14",
     "serve-favicon": "^2.5.0",