Centralized navbar template rendering property definitions.

src/controllers/404Controller.js

@@ -14,11 +14,8 @@ GNU Affero General Public License for more details.
 You should have received a copy of the GNU Affero General Public License
 along with this program.  If not, see <https://www.gnu.org/licenses/>.*/
 
-//Config
-const config = require('../../config.json');
-
 //Local Imports
-const csrfUtils = require('../utils/csrfUtils');
+const navRender = require('./navRender');
 
 //register page functions
 module.exports = async function(req, res){
@@ -26,5 +23,5 @@ module.exports = async function(req, res){
     res.status(404);
 
     //Render page
-    return res.render('404', {instance: config.instanceName, links: config.links, user: req.session.user, csrfToken: csrfUtils.generateToken(req)});
+    return navRender.render(req, res, '404');
 }

src/controllers/aboutController.js

@@ -19,10 +19,10 @@ const config = require('../../config.json');
 const package = require('../../package.json');
 
 //Local Imports
-const csrfUtils = require('../utils/csrfUtils');
+const navRender = require('./navRender');
 
 //register page functions
 module.exports.get = async function(req, res){
     //Render page
-    return res.render('about', {aboutText: config.aboutText, instance: config.instanceName, links: config.links, user: req.session.user, version: package.canopyDisplayVersion, csrfToken: csrfUtils.generateToken(req)});
+    return navRender.render(req, res, 'about', {aboutText: config.aboutText, version: package.canopyDisplayVersion});
 }

src/controllers/adminPanelController.js

@@ -21,10 +21,10 @@ const config = require('../../config.json');
 const validator = require('validator');//No express here, so regular validator it is!
 
 //Local Imports
+const navRender = require('./navRender');
 const {userModel} = require('../schemas/user/userSchema');
 const permissionModel = require('../schemas/permissionSchema');
 const channelModel = require('../schemas/channel/channelSchema');
-const csrfUtils = require('../utils/csrfUtils');
 const {exceptionHandler, errorHandler} = require("../utils/loggerUtils");
 
 //register page functions
@@ -41,14 +41,11 @@ module.exports.get = async function(req, res){
         delete permList.__v;
 
         //Render out the page
-        return res.render('adminPanel', {
+        return navRender.render(req, res, 'adminPanel', {
-            instance: config.instanceName, links: config.links,
-            user: req.session.user,
             rankEnum: permissionModel.rankEnum,
             chanGuide: chanGuide,
             userList: userList,
             permList: permList,
-            csrfToken: csrfUtils.generateToken(req),
             unescape: validator.unescape
         });
 

src/controllers/channelController.js

@@ -14,13 +14,10 @@ GNU Affero General Public License for more details.
 You should have received a copy of the GNU Affero General Public License
 along with this program.  If not, see <https://www.gnu.org/licenses/>.*/
 
-//Config
-const config = require('../../config.json');
-
 //Local Imports
-const csrfUtils = require('../utils/csrfUtils');
+const navRender = require('./navRender');
 
 //channel functions
 module.exports.get = function(req, res){
-    res.render('channel', {instance: config.instanceName, links: config.links, user: req.session.user, csrfToken: csrfUtils.generateToken(req)});
+    return navRender.render(req, res, 'channel');
 }

src/controllers/channelSettingsController.js

@@ -14,35 +14,42 @@ GNU Affero General Public License for more details.
 You should have received a copy of the GNU Affero General Public License
 along with this program.  If not, see <https://www.gnu.org/licenses/>.*/
 
-//Config
-const config = require('../../config.json');
-
 //NPM Imports
 const validator = require('validator');//No express here, so regular validator it is!
 
 //local imports
+const navRender = require('./navRender');
 const channelModel = require('../schemas/channel/channelSchema');
 const permissionModel = require('../schemas/permissionSchema');
-const csrfUtils = require('../utils/csrfUtils');
 const {exceptionHandler, errorHandler} = require('../utils/loggerUtils');
 
 //root index functions
 module.exports.get = async function(req, res){
     try{
+        //Get chan name and pull from DB
         const chanName = (req.url.slice(1).replace('/settings',''));
         const chanDB = await channelModel.findOne({name: chanName});
         const reqRank = await chanDB.getChannelRank(req.session.user);
 
+        //gank user objects and stuffem into the rank list
         await chanDB.populate("rankList.user");
 
         //Take out the permissions doc id since we don't need it.
         delete chanDB.permissions._doc._id;
 
+        //If the channel doesnt exist
         if(chanDB == null){
+            //Pitch a fit
             throw loggerUtils.exceptionSmith("Channel not found.", "queue");
         }
         
-        return res.render('channelSettings', {instance: config.instanceName, links: config.links, user: req.session.user, channel: chanDB, reqRank, rankEnum: permissionModel.rankEnum, csrfToken: csrfUtils.generateToken(req), unescape: validator.unescape});
+        //REnder dat bitch out
+        return navRender.render(req, res, 'channelSettings', {
+            channel: chanDB,
+            reqRank,
+            rankEnum: permissionModel.rankEnum,
+            unescape: validator.unescape
+        });
     }catch(err){
         return exceptionHandler(res, err);
     }

src/controllers/emailChangeController.js

@@ -14,15 +14,12 @@ GNU Affero General Public License for more details.
 You should have received a copy of the GNU Affero General Public License
 along with this program.  If not, see <https://www.gnu.org/licenses/>.*/
 
-//Config
-const config = require('../../config.json');
-
 //NPM Imports
 const {validationResult, matchedData} = require('express-validator');
 
 //local imports
+const navRender = require('./navRender');
 const emailChangeModel = require('../schemas/user/emailChangeSchema');
-const csrfUtils = require('../utils/csrfUtils');
 
 //gateway for resetting password
 module.exports.get = async function(req, res){
@@ -40,18 +37,18 @@ module.exports.get = async function(req, res){
 
             //If we have an invalid request
             if(requestDB == null){
-                return res.render('emailChange', {instance: config.instanceName, links: config.links, user: req.session.user, csrfToken: csrfUtils.generateToken(req), valid: false});
+                return navRender.render(req, res, 'emailChange', {valid: false});
             }
 
             //Speak of our success (don't wait for the emails to be sent)
-            res.render('emailChange', {instance: config.instanceName, links: config.links, user: req.session.user, csrfToken: csrfUtils.generateToken(req), valid: true});
+            navRender.render(req, res, 'emailChange', {valid: true});
 
             //Consume the request
             await requestDB.consume();
         }else{
-            return res.render('emailChange', {instance: config.instanceName, links: config.links, user: req.session.user, csrfToken: csrfUtils.generateToken(req), valid: false});
+            return navRender.render(req, res, 'emailChange', {valid: false});
         }
     }catch(err){
-        return res.render('emailChange', {instance: config.instanceName, links: config.links, user: req.session.user, csrfToken: csrfUtils.generateToken(req), valid: false});
+        return navRender.render(req, res, 'emailChange', {valid: false});
     }
 }

src/controllers/hrtController.js

@@ -14,15 +14,11 @@ GNU Affero General Public License for more details.
 You should have received a copy of the GNU Affero General Public License
 along with this program.  If not, see <https://www.gnu.org/licenses/>.*/
 
-//Config
-const config = require('../../config.json');
-const package = require('../../package.json');
-
 //Local Imports
-const csrfUtils = require('../utils/csrfUtils');
+const navRender = require('./navRender');
 
 //register page functions
 module.exports.get = async function(req, res){
     //Render page
-    return res.render('hrt', {instance: config.instanceName, links: config.links, user: req.session.user, csrfToken: csrfUtils.generateToken(req)});
+    return navRender.render(req, res,'hrt');
 }

src/controllers/indexController.js

@@ -14,22 +14,19 @@ GNU Affero General Public License for more details.
 You should have received a copy of the GNU Affero General Public License
 along with this program.  If not, see <https://www.gnu.org/licenses/>.*/
 
-//Config
-const config = require('../../config.json');
-
 //NPM Imports
 const validator = require('validator');//No express here, so regular validator it is!
 
 //local imports
+const navRender = require('./navRender');
 const channelModel = require('../schemas/channel/channelSchema');
-const csrfUtils = require('../utils/csrfUtils');
 const {exceptionHandler, errorHandler} = require('../utils/loggerUtils');
 
 //root index functions
 module.exports.get = async function(req, res){
     try{
         const chanGuide = await channelModel.getChannelList();
-        return res.render('index', {instance: config.instanceName, links: config.links, user: req.session.user, chanGuide: chanGuide, csrfToken: csrfUtils.generateToken(req), unescape: validator.unescape});
+        return navRender.render(req, res, 'index', {chanGuide: chanGuide, unescape: validator.unescape})
     }catch(err){
         return exceptionHandler(res, err);
     }

src/controllers/loginController.js

@@ -14,16 +14,13 @@ GNU Affero General Public License for more details.
 You should have received a copy of the GNU Affero General Public License
 along with this program.  If not, see <https://www.gnu.org/licenses/>.*/
 
-//Config
-const config = require('../../config.json');
-
 //NPM Imports
 const {validationResult, matchedData} = require('express-validator');
 
 //Local Imports
+const navRender = require('./navRender');
 const sessionUtils = require('../utils/sessionUtils');
 const altchaUtils = require('../utils/altchaUtils');
-const csrfUtils = require('../utils/csrfUtils');
 
 //register page functions
 module.exports.get = async function(req, res){
@@ -45,7 +42,7 @@ module.exports.get = async function(req, res){
         //if we have previous attempts for this user
         if(attempts != null){
             if(attempts.count > sessionUtils.maxAttempts){
-                return res.render('lockedAccount', {instance: config.instanceName, links: config.links, user: req.session.user, csrfToken: csrfUtils.generateToken(req)});
+                return navRender.render(req, res, 'lockedAccount');
             }
 
             //If the users login's are being throttled
@@ -56,16 +53,16 @@ module.exports.get = async function(req, res){
                 const challenge = await altchaUtils.genCaptcha(difficulty, user);
 
                 //Render page
-                return res.render('login', {instance: config.instanceName, links: config.links, user: req.session.user, challenge, csrfToken: csrfUtils.generateToken(req)});
+                return navRender.render(req, res, 'login', {challenge});
             }
         //otherwise
         }else{
             //Render generic page
-            return res.render('login', {instance: config.instanceName, links: config.links, user: req.session.user, challenge: null, csrfToken: csrfUtils.generateToken(req)});
+            return navRender.render(req, res, 'login', {challenge: null});
         }
     //if we received invalid input
     }else{
         //Render pretend nothing happened, send out a generic page
-        return res.render('login', {instance: config.instanceName, links: config.links, user: req.session.user, challenge: null, csrfToken: csrfUtils.generateToken(req)});
+        return navRender.render(req, res, 'login', {challenge: null});
     }
 }

src/controllers/migrateController.js

@@ -14,12 +14,9 @@ GNU Affero General Public License for more details.
 You should have received a copy of the GNU Affero General Public License
 along with this program.  If not, see <https://www.gnu.org/licenses/>.*/
 
-//Config
-const config = require('../../config.json');
-
 //Local Imports
+const navRender = require('./navRender');
 const altchaUtils = require('../utils/altchaUtils');
-const csrfUtils = require('../utils/csrfUtils');
 
 //register page functions
 module.exports.get = async function(req, res){
@@ -27,5 +24,5 @@ module.exports.get = async function(req, res){
     const challenge = await altchaUtils.genCaptcha();
 
     //Render page
-    return res.render('migrate', {instance: config.instanceName, links: config.links, user: req.session.user, challenge, csrfToken: csrfUtils.generateToken(req)});
+    return navRender.render(req, res, 'migrate', {challenge});
 }

src/controllers/navRender.js

@@ -0,0 +1,36 @@
+/*Canopy - The next generation of stoner streaming software
+Copyright (C) 2024-2026 Rainbownapkin and the TTN Community
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.*/
+
+//Config
+const config = require('../../config.json');
+
+//Local Imports
+const csrfUtils = require('../utils/csrfUtils');
+
+/* You could make the argument this should be middleware that passes a properties object to user
+   But then I'd writing out all the other controllers properties as I am below, or worse. Not a great option.*/ 
+//Renders a given page with properties required for the navbar
+module.exports.render = async function(req, res, template, properties = {}){
+
+    //Set required properties on top of passed object
+    properties.instance = config.instanceName;
+    properties.links = config.links;
+    properties.user = req.session.user
+    properties.csrfToken = csrfUtils.generateToken(req)
+
+    //Render out template, passing given properties with navbar required properties added
+    return res.render(template, properties);
+}

src/controllers/newChannelController.js

@@ -15,11 +15,8 @@ You should have received a copy of the GNU Affero General Public License
 along with this program.  If not, see <https://www.gnu.org/licenses/>.*/
 
 //Local Imports
+const navRender = require('./navRender');
 const altchaUtils = require('../utils/altchaUtils');
-const csrfUtils = require('../utils/csrfUtils');
-
-//Config
-const config = require('../../config.json');
 
 //root index functions
 module.exports.get = async function(req, res){
@@ -27,5 +24,5 @@ module.exports.get = async function(req, res){
     const challenge = await altchaUtils.genCaptcha();
 
     //render the page
-    return res.render('newChannel', {instance: config.instanceName, links: config.links, user: req.session.user, challenge, csrfToken: csrfUtils.generateToken(req)});
+    return navRender.render(req, res, 'newChannel', {challenge});
 }

src/controllers/passwordResetController.js

@@ -14,15 +14,12 @@ GNU Affero General Public License for more details.
 You should have received a copy of the GNU Affero General Public License
 along with this program.  If not, see <https://www.gnu.org/licenses/>.*/
 
-//Config
-const config = require('../../config.json');
-
 //npm imports
 const {validationResult, matchedData} = require('express-validator');
 
 //Local Imports
+const navRender = require('./navRender');
 const altchaUtils = require('../utils/altchaUtils');
-const csrfUtils = require('../utils/csrfUtils');
 
 //register page functions
 module.exports.get = async function(req, res){
@@ -47,11 +44,11 @@ module.exports.get = async function(req, res){
             */
 
             //Render page
-            return res.render('passwordReset', {instance: config.instanceName, links: config.links, user: req.session.user, challenge, token, csrfToken: csrfUtils.generateToken(req)});
+            return navRender.render(req, res, 'passwordReset', {challenge, token});
         //If we didn't get a valid token
         }else{
             //otherwise render generic page
-            return res.render('passwordReset', {instance: config.instanceName, links: config.links, user: req.session.user, challenge, token: null, csrfToken: csrfUtils.generateToken(req)});
+            return navRender.render(req, res, 'passwordReset', {challenge, token: null});
         }
     }catch(err){
         return exceptionHandler(res, err);

src/controllers/profileController.js

@@ -15,17 +15,14 @@ You should have received a copy of the GNU Affero General Public License
 along with this program.  If not, see <https://www.gnu.org/licenses/>.*/
 
 //Local Imports
+const navRender = require('./navRender');
 const {userModel} = require('../schemas/user/userSchema');
-const csrfUtils = require('../utils/csrfUtils');
 const presenceUtils = require('../utils/presenceUtils');
 const {exceptionHandler, errorHandler} = require('../utils/loggerUtils');
 
 //NPM Imports
 const validator = require('validator');//No express here, so regular validator it is!
 
-//Config
-const config = require('../../config.json');
-
 
 //profile functions
 module.exports.get = async function(req, res){
@@ -41,23 +38,17 @@ module.exports.get = async function(req, res){
             //Pull presence (should be quick since everyone whos been on since last startup will be backed in RAM)
             const presence = await presenceUtils.getPresence(profile.user);
 
-            res.render('profile', {
+            navRender.render(req, res, 'profile', {
-                instance: config.instanceName, links: config.links,
-                user: req.session.user,
                 profile,
                 selfProfile,
                 presence,
-                csrfToken: csrfUtils.generateToken(req),
                 unescape: validator.unescape
             });
         }else{
-            res.render('profile', {
+            navRender.render(req, res, 'profile', {
-                instance: config.instanceName, links: config.links,
-                user: req.session.user,
                 profile: null,
                 selfProfile: false,
                 presence: null,
-                csrfToken: csrfUtils.generateToken(req),
                 unescape: validator.unescape
             });
         }

src/controllers/registerController.js

@@ -14,12 +14,9 @@ GNU Affero General Public License for more details.
 You should have received a copy of the GNU Affero General Public License
 along with this program.  If not, see <https://www.gnu.org/licenses/>.*/
 
-//Config
-const config = require('../../config.json');
-
 //Local Imports
+const navRender = require('./navRender');
 const altchaUtils = require('../utils/altchaUtils');
-const csrfUtils = require('../utils/csrfUtils');
 
 //register page functions
 module.exports.get = async function(req, res){
@@ -27,5 +24,5 @@ module.exports.get = async function(req, res){
     const challenge = await altchaUtils.genCaptcha();
 
     //Render page
-    return res.render('register', {instance: config.instanceName, links: config.links, user: req.session.user, challenge, csrfToken: csrfUtils.generateToken(req)});
+    return navRender.render(req, res, 'register', {challenge});
 }

src/controllers/streamInfoController.js

@@ -14,15 +14,11 @@ GNU Affero General Public License for more details.
 You should have received a copy of the GNU Affero General Public License
 along with this program.  If not, see <https://www.gnu.org/licenses/>.*/
 
-//Config
-const config = require('../../config.json');
-const package = require('../../package.json');
-
 //Local Imports
-const csrfUtils = require('../utils/csrfUtils');
+const navRender = require('./navRender');
 
 //register page functions
 module.exports.get = async function(req, res){
     //Render page
-    return res.render('streamInfo', {instance: config.instanceName, links: config.links, user: req.session.user, csrfToken: csrfUtils.generateToken(req)});
+    return navRender.render(req, res, 'streamInfo');
 }