Merge branch 'dev' into feature/questionnaire

.env.example

@@ -1,4 +1,4 @@
 mongoURI='mongodb://localhost:27017/'
 database='nameOfDatabase'
 PORT=8000
-
+secret='123456789'

README.md

@@ -54,9 +54,12 @@ Example:
 retirementCalculator/
 ├── src/
 │   ├── views/
-|   ├── css/
+│   │   └── partials/
-|   ├── images/
+│   ├── css/
-|   └── scripts/
+│   ├── images/
+│   ├── scripts/
+│   └── utils/
+│
 ├── app.js
 ├── .env.example
 ├── .gitignore

app.js

@@ -1,94 +1,104 @@
+const status = require("./src/util/statuses");
+const MongoStore = require("connect-mongo");
+const session = require("express-session");
 const express = require('express');
 const path = require('path');
-const dotenv = require('dotenv');
+require('dotenv').config();
-
-dotenv.config();
 
 const app = express();
-
 const port = process.env.PORT || 3000;
 
+const mongoURI = process.env.mongoURI || "mongodb://localhost:27017/";
+const database = process.env.database || "knoldus"; // Database name
+const secret   = process.env.secret   || "123-secret-xyz";
+
+/*** Sessions ***/
+app.use(session({
+    secret: secret,
+    store: MongoStore.create({ mongoUrl: `${mongoURI}${database}`, crypto: { secret: secret } }),
+    resave: true,
+    saveUninitialized: false,
+    cookie: { maxAge: 60000 },
+}));
+
 app.set('view engine', 'ejs');
 app.set('views',path.join(__dirname, 'src/views'));
-
-
 app.use(express.urlencoded({ extended: true }));
+app.use("/static", express.static("./src/public"));
+app.use("/images", express.static("./src/public/images"));
 
+/*** Database ***/
+const { connectMongo, getCollection } = require("./src/database/connection");
 
-/*
+let users;
-STATIC ROUTINGS
+async function initDatabase() {
-*/
+    const db = await connectMongo(mongoURI, database);
     
-app.use("/scripts", express.static("./src/scripts"));
+    // For any collection, init here
-app.use("/css", express.static("./src/css"));
+    users = await getCollection(db, "users");
-app.use("/images", express.static("./src/images"));
+}
-app.use("/views", express.static("./src/views"));
 
-
+/*** ROUTINGS ***/
-/*
-ROUTINGS
-*/
 
 app.get('/', (req, res) => {
-    res.render('index');
+    if (!req.session.errMessage) req.session.errMessage = "";
-});
-
-app.get('/landing', (req, res) => {
     res.render('landing');
+    return res.status(status.Ok);
 });
 
 app.get('/signup', (req, res) => {
-    res.render('signup');
+    res.render('signup', { errMessage: req.session.errMessage });
+    return res.status(status.Ok);
 });
 
 app.get('/login', (req, res) => {
-    res.render('login');
+    if (req.session.authenticated) {
+        res.redirect("/home");
+        return res.status(status.Ok);        
+    }
+    res.render('login', { errMessage: req.session.errMessage });
+    return res.status(status.Ok);
 });
 
 app.get('/home', (req, res) => {
-    res.render('home');
+    res.render('home', { session: req.session });
-});
+    return res.status(status.Ok);
-
-app.get('/assets', (req, res) => {
-    res.render('assets');
-});
-
-app.get('/plans', (req, res) => {
-    res.render('plans');
-});
-
-app.get('/more', (req, res) => {
-    res.render('more');
-});
-
-app.get('/profile', (req, res) => {
-    res.render('profiles');
-});
-
-app.get('/settings', (req, res) => {
-    res.render('settings');
 });
 
 app.get('/aboutUs', (req, res) => {
     res.render('aboutUs');
+    return res.status(status.Ok);
 });
 
-
+app.get('/logout', (req, res) => {
-app.post('/signup', (req, res) => {
+    req.session.destroy();
-    res.status(200);
+    return res.redirect('/login');
-    res.send('200 status code');
-});
-
-app.post('/login', (req, res) => {
-    res.status(200);
-    res.send('200 status code');
 });
 
 app.get('/*splat', (req, res) => {
-    res.status(404);
     res.send('404 Not Found');
+    return res.status(status.NotFound);
 });
 
+// Initialize database and start app
+initDatabase().then(() => {
+    console.log("Successfully connected to MongoDB");
+
+    // Import authentication handler
+    app.use(require("./src/auth/authentication")(users));
+
+    // Import middleware & apply to user routes
+    const middleware = require("./src/auth/middleware")(users);
+    app.use(require("./src/router/user")(middleware));
+
+    // 404 handler
+    app.get('/*splat', (req, res) => {
+        res.send('404 Not Found');
+        return res.status(status.NotFound);
+    });    
+
+    // Start app
     app.listen(port, () => {
         console.log(`Server listening on port ${port}`);
     });    
+});

package.json

@@ -18,9 +18,14 @@
   },
   "homepage": "https://github.com/JoaquinPar/2800-202510-BBY14#readme",
   "dependencies": {
+    "bcrypt": "^5.1.1",
+    "connect-mongo": "^5.1.0",
     "dotenv": "^16.5.0",
     "ejs": "^3.1.10",
-    "express": "^5.1.0"
+    "express": "^5.1.0",
+    "express-session": "^1.18.1",
+    "joi": "^17.13.3",
+    "mongodb": "^6.16.0"
   },
   "devDependencies": {
     "nodemon": "^3.1.10"

src/auth/authentication.js

@@ -0,0 +1,96 @@
+const status = require("../util/statuses");
+const bcrypt = require('bcrypt');
+const joi = require("joi");
+const salt = 12;
+
+module.exports = (users) => {
+    const router = require("express").Router();
+
+    router.get("/logout", (req, res) => {
+        req.session.destroy();
+        // res.status(status.Unauthorized);
+        return res.redirect('/login');
+    });
+    
+    router.post("/login", async (req, res) => {
+        const credentialSchema = joi.object({
+            email: joi.string().email().required(),
+            password: joi.string().max(20).required(),
+        });
+
+        const valid = credentialSchema.validate(req.body);
+
+        if (valid.err) {
+            req.session.errMessage = "Invalid input";
+            res.status(status.BadRequest);
+            return res.redirect("/login");
+        }
+
+        users.findOne({ "email": req.body.email }).then((user) => {
+            if (!user) {
+                req.session.errMessage = "User not found";
+                res.status(status.NotFound);
+                return res.redirect("/login");
+            }
+
+            if (!bcrypt.compareSync(req.body.password, user.password)) {
+                req.session.errMessage = "Incorrect password";
+                res.status(status.Unauthorized);
+                return res.redirect("/login");
+            }
+
+            req.session.authenticated = true;
+            req.session.email = req.body.email;
+
+            req.session.errMessage = "";
+            res.redirect("/home");
+            return res.status(status.Ok);
+        });
+    });
+
+    router.post("/signup", async (req, res) => {
+        const userSchema = joi.object({
+            email: joi.string().email().required(),
+            // name: joi.string().alphanum().max(20).required(),
+            password: joi.string().max(20).min(8).required(),
+            repassword: joi.string().max(20).min(8).required(),
+        });
+
+        const valid = userSchema.validate(req.body);
+
+        if (valid.err) {
+            req.session.errMessage = "Invalid input",
+            res.status(status.BadRequest);
+            return res.redirect("/signup");
+        }
+
+        if (req.body.password != req.body.repassword) {
+            req.session.errMessage = "Passwords must match";
+            res.status(status.BadRequest);
+            return res.redirect("/signup");
+        }
+
+        let hashedPassword = await bcrypt.hashSync(req.body.password, salt);
+
+        users.insertOne({
+            email: req.body.email,
+            // name: req.body.name,
+            password: hashedPassword,
+        }).then((results, err) => {
+            if (err) {
+                res.status(status.InternalServerError);
+                console.error(err);
+                return res.send("Internal server error");
+            }
+
+            req.session.authenticated = true;
+            req.session.email = req.body.email;
+
+            req.session.errMessage = "";
+            res.status(status.Ok);
+            return res.redirect("/home");
+        });
+    });
+
+    return router;
+}

src/auth/middleware.js

@@ -0,0 +1,29 @@
+const status = require("../util/statuses");
+
+/**
+ * createMiddleware returns a middleware function for express.
+ * @param {MongoClient.collection} users
+ * @return {async function} 
+ */
+const createMiddleware = (users) => {
+    return async (req, res, next) => {
+        if (!req.session.authenticated || !req.session.email) {
+            req.session.errMessage = "Please login to view that resource";
+            res.redirect("/login");
+            return res.status(status.Unauthorized);
+        }
+    
+        let user = await users.findOne({ "email": req.session.email }).then((user) => user);
+
+        if (!user) {
+            req.session.errMessage = "User not found";
+            res.redirect("/login");
+            return res.status(status.Unauthorized);
+        }
+    
+        req.user = user;
+        next();
+    };
+}
+
+module.exports = createMiddleware;

src/database/connection.js

@@ -0,0 +1,27 @@
+const MongoClient = require("mongodb").MongoClient;
+
+/**
+ * connectMongo returns a database connection to MongoDB
+ * @param {string} mongoURI 
+ * @param {string} databaseName
+ * @return {MongoClient}
+ */
+const connectMongo = async (mongoURI, databaseName) => {
+    const database = await MongoClient.connect(mongoURI, { connectTimeoutMS: 1000 });
+    const dbo = database.db(databaseName);
+    return dbo;
+}
+
+/**
+ * getCollection object to interact with MongoDB
+ * @param {MongoClient} dbo
+ * @param {string} collection 
+ */
+const getCollection = async (dbo, collection) => {
+    return await dbo.collection(collection);
+}
+
+module.exports = {
+    connectMongo: connectMongo,
+    getCollection: getCollection,
+}

src/router/user.js

@@ -0,0 +1,42 @@
+const status = require("../util/statuses");
+
+module.exports = (middleware) => {
+    const router = require("express").Router();
+
+    router.get('/home', middleware, async (req, res) => {
+        res.render('home', { user: req.user });
+        return res.status(status.Ok);
+    });
+
+    router.get('/assets', middleware, (req, res) => {
+        res.render('assets', { user: req.user });
+        return res.status(status.Ok);
+    });
+
+    router.get('/plans', middleware, (req, res) => {
+        res.render('plans', { user: req.user });
+        return res.status(status.Ok);
+    });
+
+    router.get('/more', middleware, (req, res) => {
+        res.render('more', { user: req.user });
+        return res.status(status.Ok);
+    });
+
+    router.get('/profile', middleware, (req, res) => {
+        res.render('profiles', { user: req.user });
+        return res.status(status.Ok);
+    });
+
+    router.get('/settings', middleware, (req, res) => {
+        res.render('settings', { user: req.user });
+        return res.status(status.Ok);
+    });
+
+    router.get('/logout', middleware, (req, res) => {
+        req.session.destroy();
+        return res.redirect('/login');
+    });
+
+    return router;
+};

src/util/statuses.js

@@ -0,0 +1,7 @@
+module.exports = {
+    Ok:                  200,
+    BadRequest:          400,
+    Unauthorized:        401,
+    NotFound:            404,
+    InternalServerError: 500,
+};

src/views/home.ejs

@@ -10,6 +10,7 @@
 
 <body>
     <%- include("./partials/header") %>
+    <% if (session.authenticated) { console.log(session.email); } else { console.log("No user"); } %>
     <main>
         The Dashboard Page
     </main>

src/views/login.ejs

@@ -6,8 +6,8 @@
     <meta http-equiv="X-UA-Compatible" content="IE=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <title>Login Page</title>
-    <link rel="stylesheet" href="/css/style.css" <link rel="stylesheet" href="/css/style.css">
+    <link rel="stylesheet" href="/static/css/style.css" <link rel="stylesheet" href="/static/css/style.css">
-    <link rel="stylesheet" href="../public/css/style.css">
+    <link rel="stylesheet" href="/static/css/style.css">
     <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.7.2/css/all.min.css">
     <link href="https://cdn.jsdelivr.net/npm/tailwindcss@3.3.2/dist/tailwind.min.css" rel="stylesheet">
 </head>
@@ -30,7 +30,7 @@
                         class="border focus:border-gray-600 w-full text-base px-2 py-1 focus:outline-none focus:ring-0 "
                         placeholder="Enter Password" />
                 </div>
-                <div class="text-red-800 font-bold hidden" id="forgor"> Your Password is incorrect...</div>
+                <div class="text-red-800 font-bold" id="forgor"> <%= errMessage %></div>
                 <div class="mt-3 flex justify-between items-center">
                     <div>
                         <input type="checkbox">
@@ -44,6 +44,10 @@
                     <button type="submit"
                         class="border-2 border-gray-600 bg-blue-600 text-white py-1 w-full rounded-md hover:bg-transparent hover:text-indigo-700 font-semibold">Login</button>
                 </div>
+                <div class="mt-5 block justify-between items-center">
+                    <label>Don't have an account?</label>
+                    <a href="/signup" class="text-indigo-600 font-semibold">Register</a>
+                </div>
             </div>
         </form>
     </div>

src/views/partials/header.ejs

@@ -1,7 +1,7 @@
 <header>
     <nav class="bg-gray-50 dark:bg-gray-800 border-b border-gray-200 dark:border-gray-700">
         <div class="max-w-screen-xl flex flex-wrap items-center justify-between mx-auto p-4">
-            <a href="#" class="flex items-center space-x-3 rtl:space-x-reverse">
+            <a href="/home" class="flex items-center space-x-3 rtl:space-x-reverse">
                 <img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/png/rekor.png" class="h-8" alt="Flowbite Logo" />
                 <span class="self-center text-2xl font-semibold whitespace-nowrap dark:text-white">RCalculator</span>
             </a>
@@ -19,6 +19,15 @@
                     <li>
                         <a href="/more" class="block py-2 px-3 lg:p-0 text-gray-900 rounded hover:bg-gray-100 lg:hover:bg-transparent lg:border-0 lg:hover:text-blue-700 dark:text-white lg:dark:hover:text-blue-500 dark:hover:bg-gray-700 dark:hover:text-white lg:dark:hover:bg-transparent">More</a>
                     </li>
+                    <% if (session.authenticated) { %>
+                    <li>
+                        <a href="/logout" class="block py-2 px-3 lg:p-0 text-gray-900 rounded hover:bg-gray-100 lg:hover:bg-transparent lg:border-0 lg:hover:text-blue-700 dark:text-white lg:dark:hover:text-blue-500 dark:hover:bg-gray-700 dark:hover:text-white lg:dark:hover:bg-transparent">Logout</a>
+                    </li>
+                    <% } else { %>
+                    <li>
+                        <a href="/login" class="block py-2 px-3 lg:p-0 text-gray-900 rounded hover:bg-gray-100 lg:hover:bg-transparent lg:border-0 lg:hover:text-blue-700 dark:text-white lg:dark:hover:text-blue-500 dark:hover:bg-gray-700 dark:hover:text-white lg:dark:hover:bg-transparent">Login</a>
+                    </li>
+                    <% } %>
                 </ul>
             </div>
         </div>

src/views/partials/headerStart.ejs

@@ -1,7 +1,7 @@
 <header>
     <nav class="bg-gray-50 dark:bg-gray-800 border-b border-gray-200 dark:border-gray-700">
         <div class="max-w-screen-xl flex flex-wrap items-center justify-between mx-auto p-4">
-            <a href="#" class="flex items-center space-x-3 rtl:space-x-reverse">
+            <a href="/" class="flex items-center space-x-3 rtl:space-x-reverse">
                 <img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/png/rekor.png" class="h-8" alt="Flowbite Logo" />
                 <span class="self-center text-2xl font-semibold whitespace-nowrap dark:text-white">RCalculator</span>
             </a>
@@ -17,7 +17,7 @@
             <div class="hidden w-full lg:block lg:w-auto" id="navbar-solid-bg">
                 <ul class="flex flex-col font-medium mt-4 rounded-lg bg-gray-50 lg:space-x-8 rtl:space-x-reverse lg:flex-row lg:mt-0 lg:border-0 lg:bg-transparent dark:bg-gray-800 lg:dark:bg-transparent dark:border-gray-700">
                     <li>
-                        <a href="/landing" class="block py-2 px-3 lg:p-0 text-gray-900 rounded hover:bg-gray-100 lg:hover:bg-transparent lg:border-0 lg:hover:text-blue-700 dark:text-white lg:dark:hover:text-blue-500 dark:hover:bg-gray-700 dark:hover:text-white lg:dark:hover:bg-transparent">Home</a>
+                        <a href="/" class="block py-2 px-3 lg:p-0 text-gray-900 rounded hover:bg-gray-100 lg:hover:bg-transparent lg:border-0 lg:hover:text-blue-700 dark:text-white lg:dark:hover:text-blue-500 dark:hover:bg-gray-700 dark:hover:text-white lg:dark:hover:bg-transparent">Home</a>
                     </li>
                     <li>
                         <a href="/aboutUs" class="block py-2 px-3 lg:p-0 text-gray-900 rounded hover:bg-gray-100 lg:hover:bg-transparent lg:border-0 lg:hover:text-blue-700 dark:text-white lg:dark:hover:text-blue-500 dark:hover:bg-gray-700 dark:hover:text-white lg:dark:hover:bg-transparent">About Us</a>

src/views/signup.ejs

@@ -6,8 +6,7 @@
     <meta http-equiv="X-UA-Compatible" content="IE=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <title>Signup</title>
-    <link rel="stylesheet" href="/css/style.css" <link rel="stylesheet" href="/css/style.css">
+    <link rel="stylesheet" href="/static/css/style.css">
-    <link rel="stylesheet" href="../public/css/style.css">
     <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.7.2/css/all.min.css"
         integrity="sha512-Evv84Mr4kqVGRNSgIGL/F/aIDqQb7xQ2vcrdIwxfjThSH8CSR7PBEakCr51Ck+w+/U6swU2Im1vVX0SVk9ABhg=="
         crossorigin="anonymous" referrerpolicy="no-referrer" />
@@ -15,7 +14,7 @@
 
 <body>
     <div class="flex justify-center items-center h-screen bg-gray-700">
-        <form action="/login" method="POST">
+        <form action="/signup" method="POST">
             <div class="w-96 p-6 shadow-1g bg-white rounded-md">
                 <h1 class="text-3xl block text-center font-semibold"> Signup </h1>
                 <hr class="mt-3">
@@ -31,23 +30,18 @@
                         class="border focus:border-gray-600 w-full text-base px-2 py-1 focus:outline-none focus:ring-0 "
                         placeholder="Enter Password" />
                     <label for="password" class="block text-base mb-2 mt-3">Re-type Password</label>
-                    <input type="password" id="repassword" name="password"
+                    <input type="password" id="repassword" name="repassword"
                         class="border focus:border-gray-600 w-full text-base px-2 py-1 focus:outline-none focus:ring-0 "
                         placeholder="Enter Password" />
                 </div>
-                <div class="text-red-800 font-bold hidden" id="forgor"> Your Password is incorrect...</div>
+                <div class="text-red-800 font-bold " id="forgor"> <%= errMessage %></div>
-                <div class="mt-3 flex justify-between items-center">
-                    <div>
-                        <input type="checkbox">
-                        <label>Remember me</label>
-                    </div>
-                    <div>
-                        <a href="#" class="text-indigo-600 font-semibold">Forgot Password? </a>
-                    </div>
-                </div>
                 <div class="mt-5">
                     <button type="submit"
-                        class="border-2 border-gray-600 bg-blue-600 text-white py-1 w-full rounded-md hover:bg-transparent hover:text-indigo-700 font-semibold">Login</button>
+                        class="border-2 border-gray-600 bg-blue-600 text-white py-1 w-full rounded-md hover:bg-transparent hover:text-indigo-700 font-semibold">Signup</button>
+                </div>
+                <div class="mt-5 block justify-between items-center">
+                    <label>Already have an account?</label>
+                    <a href="/login" class="text-indigo-600 font-semibold">Login</a>
                 </div>
             </div>
         </form>