pis (#12)

Reviewed-on: #12

src/utils/auth.utils.js

@@ -0,0 +1,57 @@
+const log    = require('../utils/log.utils');
+const crypto = require('crypto');
+const db     = require('../services/dbAccess.services');
+const fs     = require('fs/promises');
+const minify = require('../utils/minify.utils');
+
+// Checks users registration key against issued keys
+async function isAuthed(uuid) {  // Needs testing
+  const q = {uuid: uuid};
+  const res = await db.query('users', q);
+  log.out(`authUtils.checkUser: DB Query answer: ${JSON.stringify(res[0])}`, 'dbug');
+  const authorized = res && res[0] && res[0].domain;
+  if (authorized) db.userAtime(uuid);
+  return authorized;
+}
+
+// Checks whether a registration request key is valid
+async function checkRequest(key) {
+  const collection = 'registrations';
+  const query = {uuid: key};
+  const res = await db.query(collection, query);
+  log.out(`authUtils.checkRequest: DB Query result: ${JSON.stringify(res)}`, 'dbug');
+  const result = res.length > 0 && res[0].time
+    ? { result: true, domain: res[0].domain }
+    : { result: false };
+  return result;
+}
+
+// Creates an API key for a user
+async function generateKey() {  // Needs testing & moving to 'register.utils'
+  return crypto.randomUUID();
+}
+
+async function generateConfirmationEmail(eml, uuid) {
+  try {
+    const htmlTpl = await fs.readFile('mail-templates/register.html', 'utf-8');
+    const htmlStr = htmlTpl.replace(/>>ACCESSCODE<</g, uuid);
+    const htmlMin = await minify(htmlStr);
+    const txtTpl = fs.readFile('mail-templates/register.txt', 'utf-8');
+    return {
+      to: eml,
+      subject: 'OwlBoard Registration',
+      text: (await txtTpl).replace(/>>ACCESSCODE<</g, uuid),
+      html: htmlMin
+    };
+  } catch(err) {
+    log.out('mailServices.generateConfirmationEmail: Error reading templates, $(err)', 'err');
+    return false;
+  }
+}
+
+module.exports = {
+  isAuthed,
+  generateKey,
+  generateConfirmationEmail,
+  checkRequest
+};

src/utils/ldb.utils.js

@@ -1,43 +1,49 @@
 const log  = require('../utils/log.utils');            // Log Helper
-const db   = require('../services/dbAccess.services') // DB Access
-const san  = require('../utils/sanitizer.utils')     // Sanitiser
+const db   = require('../services/dbAccess.services'); // DB Access
+const san  = require('../utils/sanitizer.utils');     // Sanitiser
 
 async function checkCrs(input){
-    var INPUT = input.toUpperCase()
-    log.out(`ldbUtils.checkCrs: Building database query to find: '${INPUT}'`, "info")
-    var query = {'$or':[{'3ALPHA':INPUT},{'TIPLOC':INPUT},{'STANOX':INPUT}]};
-    var result = await db.query("stations", query)
-    log.out(`ldbUtils.checkCrs: Query results: ${JSON.stringify(result)}`, "info")
-    return result
+  var INPUT = input.toUpperCase();
+  log.out(`ldbUtils.checkCrs: Building database query to find: '${INPUT}'`, 'info');
+  var query = {
+    '$or':[
+      {'3ALPHA':INPUT},
+      {'TIPLOC':INPUT},
+      {'STANOX':INPUT}
+    ]
+  };
+  var result = await db.query('stations', query);
+  log.out(`ldbUtils.checkCrs: Query results: ${JSON.stringify(result)}`, 'dbug');
+  return result;
 }
 
 async function cleanMessages(input){ // Needs to be moved to the frontend `ensureArray() func`
-    var out = []
-    if (typeof input.message == "string") {
-        out.push(await san.cleanNrcc(input.message))
-    } else if (typeof input.message == "object") {
-        for(var i = 0; i < input.message.length; i++) {
-            out.push(await san.cleanNrcc(input.message[i]))
-        }
+  var out = [];
+  if (typeof input.message == 'string') {
+    out.push(await san.cleanNrcc(input.message));
+  } else if (typeof input.message == 'object') {
+    for(var i = 0; i < input.message.length; i++) {
+      out.push(await san.cleanNrcc(input.message[i]));
     }
-    return out;
+  }
+  return out;
 }
 
 // Accepts an object but not an Array and returns it wrapped in an array.
 async function cleanServices(input){ // Need to triple check but I don't think this is used anymore.
-    var out = []
-    if (!Array.isArray(input)) {
-        log.out(`ldbUtils.cleanServices: Transforming input: ${input}`, "depr")
-        out.push(input)
-        log.out(`ldbUtils.cleanServices: Returning output: ${out}`, "depr")
-        return out;
-    } else {
-        return input;
-    }
+  var out = [];
+  if (!Array.isArray(input)) {
+    log.out(`ldbUtils.cleanServices: Transforming input: ${input}`, 'depr');
+    out.push(input);
+    log.out(`ldbUtils.cleanServices: Returning output: ${out}`, 'depr');
+    return out;
+  } else {
+    return input;
+  }
 }
 
 module.exports = {
-    checkCrs,
-    cleanMessages,
-    cleanServices
-}
+  checkCrs,
+  cleanMessages,
+  cleanServices
+};

src/utils/log.utils.js

@@ -1,14 +1,17 @@
+/* global process */
 const environment = process.env.NODE_ENV;
 
+const hideInProduction = ['info', 'dbug'];
+
 async function out(msg, level = 'othr') {
-    if (environment === "production" && level === "info") {
-        return;
-    } else {
-        const time = new Date().toISOString();
-        console.log(`${time} - ${level.toUpperCase()} - ${msg}`);
-    }
+  if (environment === 'production' && hideInProduction.includes(level.toLowerCase())) {
+    return;
+  } else {
+    const time = new Date().toISOString();
+    console.log(`${time} - ${level.toUpperCase()} - ${msg}`);
+  }
 }
 
 module.exports = {
-    out
-}
+  out
+};

src/utils/minify.utils.js

@@ -0,0 +1,10 @@
+const htmlShrink = require('html-minifier').minify;
+const juice = require('juice');
+
+module.exports = async function minifyMail(input) {
+  const inlined = juice(input);
+  return htmlShrink(inlined, {
+    removeComments: true,
+    collapseWhitespace: true
+  });
+};

src/utils/sanitizer.utils.js

@@ -1,45 +1,31 @@
-const clean = require('string-sanitizer-fix');
-const log   = require('../utils/log.utils');
+//const log   = require('../utils/log.utils');
 
-/*
-string.sanitize("a.bc@d efg#h"); // abcdefgh
-string.sanitize.keepSpace("a.bc@d efg#h"); // abcd efgh
-string.sanitize.keepUnicode("a.bc@d efg#hক"); // abcd efghক
-string.sanitize.addFullstop("a.bc@d efg#h"); // abcd.efgh
-string.sanitize.addUnderscore("a.bc@d efg#h"); // abcd_efgh
-string.sanitize.addDash("a.bc@d efg#h"); // abcd-efgh
-string.sanitize.removeNumber("@abcd efgh123"); // abcdefgh
-string.sanitize.keepNumber("@abcd efgh123"); // abcdefgh123
-string.addFullstop("abcd efgh"); // abcd.efgh
-string.addUnderscore("@abcd efgh"); // @abcd_efgh
-string.addDash("@abcd efgh"); // @abcd-efgh
-string.removeSpace("@abcd efgh"); // @abcdefgh
-*/
-
-function cleanApiEndpointTxt(input) {
-    var output = clean.sanitize.keepSpace(input)
-    if (output != input){
-        log.out(`sanitizerUtils.cleanApiEndpoint: WARN: Sanitizing changed string. Input = ${input}`, "warn");
-    }
-    return output
+function removeNonAlphanumeric(inputString) {  // Should be able to replace sanitizer module
+  return inputString.replace(/[^a-zA-Z0-9]/g, '');
 }
 
-function cleanApiEndpointNum(input) {
-    var output = clean.sanitize.keepNumber(input)
-    if (output != input){
-        log.out(`sanitizerUtils.cleanApiEndpointNum: WARN: Sanitizing changed string. Input = ${input}`, "warn");
-    }
-    return output
+function removeNonAlpha(inputString) {  // Should be able to replace sanitizer module
+  return inputString.replace(/[^a-zA-Z]/g, '');
 }
 
-function cleanNrcc(input) {
-    var rmNewline = input.replace(/[\n\r]/g, ""); // Remove newlines
-    var rmPara = rmNewline.replace(/<\/?p[^>]*>/g, ""); // Remove <p> & </p>
-    return rmPara;
+const cleanApiEndpointTxt = removeNonAlpha;
+const cleanApiEndpointNum = removeNonAlphanumeric;
+
+function cleanNrcc(input) { // Remove newlines and then <p> tags from input
+  const cleanInput = input.replace(/[\n\r]/g, '').replace(/<\/?p[^>]*>/g, '');
+  return cleanInput;
+}
+
+async function getDomainFromEmail(mail) { // Needs testing
+  let split = mail.split('@');
+  return split[1];
 }
 
 module.exports = {
-    cleanApiEndpointTxt,
-    cleanApiEndpointNum,
-    cleanNrcc
-}
+  cleanApiEndpointTxt,
+  cleanApiEndpointNum,
+  removeNonAlpha,
+  removeNonAlphanumeric,
+  cleanNrcc,
+  getDomainFromEmail,
+};

src/utils/timeConvert.utils.js

@@ -1,15 +1,15 @@
 function unixLocal(unix) {
-    var jsTime = unix*1000
-    var dt = new Date(jsTime)
-    return dt.toLocaleString()
+  var jsTime = unix*1000;
+  var dt = new Date(jsTime);
+  return dt.toLocaleString();
 }
 
 function jsUnix(js) {
-    var preRound = js / 1000
-    return Math.round(preRound)
+  var preRound = js / 1000;
+  return Math.round(preRound);
 }
 
 module.exports = {
-    unixLocal,
-    jsUnix,
-}
+  unixLocal,
+  jsUnix,
+};

src/utils/varTest.utils.js

@@ -1,27 +1,28 @@
+/* global process */
 // Checks that all required environment variables are present.
 // Returns True or False and offers an object detailing what is missing.
 
 async function varTest(){
-    var required = {
-        OWL_LDB_KEY: process.env.OWL_LDB_KEY,
-        OWL_LDB_CORPUSUSER: process.env.OWL_LDB_CORPUSUSER,
-        OWL_LDB_CORPUSPASS: process.env.OWL_LDB_CORPUSPASS,
-        OWL_NOT_USED: process.env.OWL_NOT_USED
-    }
-    var desired = {
-        OWL_DB_PASS: process.env.OWL_DB_PASS
-    }
-    // DO NOT LOG CREDENTIALS!!!
+  var required = {
+    OWL_LDB_KEY: process.env.OWL_LDB_KEY,
+    OWL_LDB_CORPUSUSER: process.env.OWL_LDB_CORPUSUSER,
+    OWL_LDB_CORPUSPASS: process.env.OWL_LDB_CORPUSPASS,
+    OWL_NOT_USED: process.env.OWL_NOT_USED
+  };
+  var desired = {
+    OWL_DB_PASS: process.env.OWL_DB_PASS
+  };
+  // DO NOT LOG CREDENTIALS!!!
 
-    // Test that each of required is NOT undefined.
-      // var pass = true if all okay, false if not.
-      // Append any missing values to missing_required = []
-    // Test that each of desired is NOT undefined.
-      // Append any missing values to missing_desired = []
+  // Test that each of required is NOT undefined.
+  // var pass = true if all okay, false if not.
+  // Append any missing values to missing_required = []
+  // Test that each of desired is NOT undefined.
+  // Append any missing values to missing_desired = []
 
-    // Return : {pass: $pass, missong_required = $missing_required, missing_desired = $missing_desired}
+  // Return : {pass: $pass, missong_required = $missing_required, missing_desired = $missing_desired}
 }
 
 module.exports = {
-    varTest
-}
+  varTest
+};