| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092 | 
							- "use strict";
 
- const async = require("async");
 
- const config = require("config");
 
- const request = require("request");
 
- const bcrypt = require("bcrypt");
 
- const sha256 = require("sha256");
 
- const hooks = require("./hooks");
 
- // const moduleManager = require("../../index");
 
- const db = require("../db");
 
- const mail = require("../mail");
 
- const cache = require("../cache");
 
- const punishments = require("../punishments");
 
- const utils = require("../utils");
 
- // const logger = require("../logger");
 
- const activities = require("../activities");
 
- cache.runJob("SUB", {
 
-     channel: "user.updateUsername",
 
-     cb: (user) => {
 
-         utils.runJob("SOCKETS_FROM_USER", {
 
-             userId: user._id,
 
-             cb: (response) => {
 
-                 response.sockets.forEach((socket) => {
 
-                     socket.emit("event:user.username.changed", user.username);
 
-                 });
 
-             },
 
-         });
 
-     },
 
- });
 
- cache.runJob("SUB", {
 
-     channel: "user.removeSessions",
 
-     cb: (userId) => {
 
-         utils.runJob("SOCKETS_FROM_USER_WITHOUT_CACHE", {
 
-             userId: userId,
 
-             cb: (response) => {
 
-                 response.sockets.forEach((socket) => {
 
-                     socket.emit("keep.event:user.session.removed");
 
-                 });
 
-             },
 
-         });
 
-     },
 
- });
 
- cache.runJob("SUB", {
 
-     channel: "user.linkPassword",
 
-     cb: (userId) => {
 
-         utils.runJob("SOCKETS_FROM_USER", {
 
-             userId: userId,
 
-             cb: (response) => {
 
-                 response.sockets.forEach((socket) => {
 
-                     socket.emit("event:user.linkPassword");
 
-                 });
 
-             },
 
-         });
 
-     },
 
- });
 
- cache.runJob("SUB", {
 
-     channel: "user.linkGitHub",
 
-     cb: (userId) => {
 
-         utils.runJob("SOCKETS_FROM_USER", {
 
-             userId: userId,
 
-             cb: (response) => {
 
-                 response.sockets.forEach((socket) => {
 
-                     socket.emit("event:user.linkGitHub");
 
-                 });
 
-             },
 
-         });
 
-     },
 
- });
 
- cache.runJob("SUB", {
 
-     channel: "user.unlinkPassword",
 
-     cb: (userId) => {
 
-         utils.runJob("SOCKETS_FROM_USER", {
 
-             userId: userId,
 
-             cb: (response) => {
 
-                 response.sockets.forEach((socket) => {
 
-                     socket.emit("event:user.unlinkPassword");
 
-                 });
 
-             },
 
-         });
 
-     },
 
- });
 
- cache.runJob("SUB", {
 
-     channel: "user.unlinkGitHub",
 
-     cb: (userId) => {
 
-         utils.runJob("SOCKETS_FROM_USER", {
 
-             userId: userId,
 
-             cb: (response) => {
 
-                 response.sockets.forEach((socket) => {
 
-                     socket.emit("event:user.unlinkGitHub");
 
-                 });
 
-             },
 
-         });
 
-     },
 
- });
 
- cache.runJob("SUB", {
 
-     channel: "user.ban",
 
-     cb: (data) => {
 
-         utils.runJob("SOCKETS_FROM_USER", {
 
-             userId: data.userId,
 
-             cb: (response) => {
 
-                 response.sockets.forEach((socket) => {
 
-                     socket.emit("keep.event:banned", data.punishment);
 
-                     socket.disconnect(true);
 
-                 });
 
-             },
 
-         });
 
-     },
 
- });
 
- cache.runJob("SUB", {
 
-     channel: "user.favoritedStation",
 
-     cb: (data) => {
 
-         utils.runJob("SOCKETS_FROM_USER", {
 
-             userId: data.userId,
 
-             cb: (response) => {
 
-                 response.sockets.forEach((socket) => {
 
-                     socket.emit("event:user.favoritedStation", data.stationId);
 
-                 });
 
-             },
 
-         });
 
-     },
 
- });
 
- cache.runJob("SUB", {
 
-     channel: "user.unfavoritedStation",
 
-     cb: (data) => {
 
-         utils.runJob("SOCKETS_FROM_USER", {
 
-             userId: data.userId,
 
-             cb: (response) => {
 
-                 response.sockets.forEach((socket) => {
 
-                     socket.emit(
 
-                         "event:user.unfavoritedStation",
 
-                         data.stationId
 
-                     );
 
-                 });
 
-             },
 
-         });
 
-     },
 
- });
 
- module.exports = {
 
-     /**
 
-      * Lists all Users
 
-      *
 
-      * @param {Object} session - the session object automatically added by socket.io
 
-      * @param {Function} cb - gets called with the result
 
-      */
 
-     index: hooks.adminRequired(async (session, cb) => {
 
-         const userModel = await db.runJob("GET_MODEL", { modelName: "user" });
 
-         async.waterfall(
 
-             [
 
-                 (next) => {
 
-                     userModel.find({}).exec(next);
 
-                 },
 
-             ],
 
-             async (err, users) => {
 
-                 if (err) {
 
-                     err = await utils.runJob("GET_ERROR", { error: err });
 
-                     console.log(
 
-                         "ERROR",
 
-                         "USER_INDEX",
 
-                         `Indexing users failed. "${err}"`
 
-                     );
 
-                     return cb({ status: "failure", message: err });
 
-                 } else {
 
-                     console.log(
 
-                         "SUCCESS",
 
-                         "USER_INDEX",
 
-                         `Indexing users successful.`
 
-                     );
 
-                     let filteredUsers = [];
 
-                     users.forEach((user) => {
 
-                         filteredUsers.push({
 
-                             _id: user._id,
 
-                             username: user.username,
 
-                             role: user.role,
 
-                             liked: user.liked,
 
-                             disliked: user.disliked,
 
-                             songsRequested: user.statistics.songsRequested,
 
-                             email: {
 
-                                 address: user.email.address,
 
-                                 verified: user.email.verified,
 
-                             },
 
-                             hasPassword: !!user.services.password,
 
-                             services: { github: user.services.github },
 
-                         });
 
-                     });
 
-                     return cb({ status: "success", data: filteredUsers });
 
-                 }
 
-             }
 
-         );
 
-     }),
 
-     /**
 
-      * Logs user in
 
-      *
 
-      * @param {Object} session - the session object automatically added by socket.io
 
-      * @param {String} identifier - the email of the user
 
-      * @param {String} password - the plaintext of the user
 
-      * @param {Function} cb - gets called with the result
 
-      */
 
-     login: async (session, identifier, password, cb) => {
 
-         identifier = identifier.toLowerCase();
 
-         const userModel = await db.runJob("GET_MODEL", { modelName: "user" });
 
-         const sessionSchema = await cache.runJob("GET_SCHEMA", {
 
-             schemaName: "session",
 
-         });
 
-         async.waterfall(
 
-             [
 
-                 // check if a user with the requested identifier exists
 
-                 (next) => {
 
-                     userModel.findOne(
 
-                         {
 
-                             $or: [{ "email.address": identifier }],
 
-                         },
 
-                         next
 
-                     );
 
-                 },
 
-                 // if the user doesn't exist, respond with a failure
 
-                 // otherwise compare the requested password and the actual users password
 
-                 (user, next) => {
 
-                     if (!user) return next("User not found");
 
-                     if (
 
-                         !user.services.password ||
 
-                         !user.services.password.password
 
-                     )
 
-                         return next(
 
-                             "The account you are trying to access uses GitHub to log in."
 
-                         );
 
-                     bcrypt.compare(
 
-                         sha256(password),
 
-                         user.services.password.password,
 
-                         (err, match) => {
 
-                             if (err) return next(err);
 
-                             if (!match) return next("Incorrect password");
 
-                             next(null, user);
 
-                         }
 
-                     );
 
-                 },
 
-                 (user, next) => {
 
-                     utils.runJob("GUID", {}).then((sessionId) => {
 
-                         next(null, user, sessionId);
 
-                     });
 
-                 },
 
-                 (user, sessionId, next) => {
 
-                     cache
 
-                         .runJob("HSET", {
 
-                             table: "sessions",
 
-                             key: sessionId,
 
-                             value: sessionSchema(sessionId, user._id),
 
-                         })
 
-                         .then(() => next(null, sessionId))
 
-                         .catch(next);
 
-                 },
 
-             ],
 
-             async (err, sessionId) => {
 
-                 if (err && err !== true) {
 
-                     err = await utils.runJob("GET_ERROR", { error: err });
 
-                     console.log(
 
-                         "ERROR",
 
-                         "USER_PASSWORD_LOGIN",
 
-                         `Login failed with password for user "${identifier}". "${err}"`
 
-                     );
 
-                     return cb({ status: "failure", message: err });
 
-                 }
 
-                 console.log(
 
-                     "SUCCESS",
 
-                     "USER_PASSWORD_LOGIN",
 
-                     `Login successful with password for user "${identifier}"`
 
-                 );
 
-                 cb({
 
-                     status: "success",
 
-                     message: "Login successful",
 
-                     user: {},
 
-                     SID: sessionId,
 
-                 });
 
-             }
 
-         );
 
-     },
 
-     /**
 
-      * Registers a new user
 
-      *
 
-      * @param {Object} session - the session object automatically added by socket.io
 
-      * @param {String} username - the username for the new user
 
-      * @param {String} email - the email for the new user
 
-      * @param {String} password - the plaintext password for the new user
 
-      * @param {Object} recaptcha - the recaptcha data
 
-      * @param {Function} cb - gets called with the result
 
-      */
 
-     register: async function(
 
-         session,
 
-         username,
 
-         email,
 
-         password,
 
-         recaptcha,
 
-         cb
 
-     ) {
 
-         email = email.toLowerCase();
 
-         let verificationToken = await utils.runJob("GENERATE_RANDOM_STRING", {
 
-             length: 64,
 
-         });
 
-         const userModel = await db.runJob("GET_MODEL", { modelName: "user" });
 
-         const verifyEmailSchema = await mail.runJob("GET_SCHEMA", {
 
-             schemaName: "verifyEmail",
 
-         });
 
-         async.waterfall(
 
-             [
 
-                 // verify the request with google recaptcha
 
-                 (next) => {
 
-                     if (!db.passwordValid(password))
 
-                         return next(
 
-                             "Invalid password. Check if it meets all the requirements."
 
-                         );
 
-                     return next();
 
-                 },
 
-                 (next) => {
 
-                     request(
 
-                         {
 
-                             url:
 
-                                 "https://www.google.com/recaptcha/api/siteverify",
 
-                             method: "POST",
 
-                             form: {
 
-                                 secret: config.get("apis").recaptcha.secret,
 
-                                 response: recaptcha,
 
-                             },
 
-                         },
 
-                         next
 
-                     );
 
-                 },
 
-                 // check if the response from Google recaptcha is successful
 
-                 // if it is, we check if a user with the requested username already exists
 
-                 (response, body, next) => {
 
-                     let json = JSON.parse(body);
 
-                     if (json.success !== true)
 
-                         return next(
 
-                             "Response from recaptcha was not successful."
 
-                         );
 
-                     userModel.findOne(
 
-                         { username: new RegExp(`^${username}$`, "i") },
 
-                         next
 
-                     );
 
-                 },
 
-                 // if the user already exists, respond with that
 
-                 // otherwise check if a user with the requested email already exists
 
-                 (user, next) => {
 
-                     if (user)
 
-                         return next(
 
-                             "A user with that username already exists."
 
-                         );
 
-                     userModel.findOne({ "email.address": email }, next);
 
-                 },
 
-                 // if the user already exists, respond with that
 
-                 // otherwise, generate a salt to use with hashing the new users password
 
-                 (user, next) => {
 
-                     if (user)
 
-                         return next("A user with that email already exists.");
 
-                     bcrypt.genSalt(10, next);
 
-                 },
 
-                 // hash the password
 
-                 (salt, next) => {
 
-                     bcrypt.hash(sha256(password), salt, next);
 
-                 },
 
-                 (hash, next) => {
 
-                     utils
 
-                         .runJob("GENERATE_RANDOM_STRING", { length: 12 })
 
-                         .then((_id) => {
 
-                             next(null, hash, _id);
 
-                         });
 
-                 },
 
-                 // create the user object
 
-                 (hash, _id, next) => {
 
-                     next(null, {
 
-                         _id,
 
-                         username,
 
-                         email: {
 
-                             address: email,
 
-                             verificationToken,
 
-                         },
 
-                         services: {
 
-                             password: {
 
-                                 password: hash,
 
-                             },
 
-                         },
 
-                     });
 
-                 },
 
-                 // generate the url for gravatar avatar
 
-                 (user, next) => {
 
-                     utils
 
-                         .runJob("CREATE_GRAVATAR", {
 
-                             email: user.email.address,
 
-                         })
 
-                         .then((url) => {
 
-                             user.avatar = url;
 
-                             next(null, user);
 
-                         });
 
-                 },
 
-                 // save the new user to the database
 
-                 (user, next) => {
 
-                     userModel.create(user, next);
 
-                 },
 
-                 // respond with the new user
 
-                 (newUser, next) => {
 
-                     verifyEmailSchema(
 
-                         email,
 
-                         username,
 
-                         verificationToken,
 
-                         () => {
 
-                             next(null, newUser);
 
-                         }
 
-                     );
 
-                 },
 
-             ],
 
-             async (err, user) => {
 
-                 if (err && err !== true) {
 
-                     err = await utils.runJob("GET_ERROR", { error: err });
 
-                     console.log(
 
-                         "ERROR",
 
-                         "USER_PASSWORD_REGISTER",
 
-                         `Register failed with password for user "${username}"."${err}"`
 
-                     );
 
-                     return cb({ status: "failure", message: err });
 
-                 } else {
 
-                     module.exports.login(session, email, password, (result) => {
 
-                         let obj = {
 
-                             status: "success",
 
-                             message: "Successfully registered.",
 
-                         };
 
-                         if (result.status === "success") {
 
-                             obj.SID = result.SID;
 
-                         }
 
-                         activities.runJob("ADD_ACTIVITY", {
 
-                             userId: user._id,
 
-                             activityType: "created_account",
 
-                         });
 
-                         console.log(
 
-                             "SUCCESS",
 
-                             "USER_PASSWORD_REGISTER",
 
-                             `Register successful with password for user "${username}".`
 
-                         );
 
-                         return cb(obj);
 
-                     });
 
-                 }
 
-             }
 
-         );
 
-     },
 
-     /**
 
-      * Logs out a user
 
-      *
 
-      * @param {Object} session - the session object automatically added by socket.io
 
-      * @param {Function} cb - gets called with the result
 
-      */
 
-     logout: (session, cb) => {
 
-         async.waterfall(
 
-             [
 
-                 (next) => {
 
-                     cache
 
-                         .runJob("HGET", {
 
-                             table: "sessions",
 
-                             key: session.sessionId,
 
-                         })
 
-                         .then((session) => next(null, session))
 
-                         .catch(next);
 
-                 },
 
-                 (session, next) => {
 
-                     if (!session) return next("Session not found");
 
-                     next(null, session);
 
-                 },
 
-                 (session, next) => {
 
-                     cache
 
-                         .runJob("HDEL", {
 
-                             table: "sessions",
 
-                             key: session.sessionId,
 
-                         })
 
-                         .then(() => next())
 
-                         .catch(next);
 
-                 },
 
-             ],
 
-             async (err) => {
 
-                 if (err && err !== true) {
 
-                     err = await utils.runJob("GET_ERROR", { error: err });
 
-                     console.log(
 
-                         "ERROR",
 
-                         "USER_LOGOUT",
 
-                         `Logout failed. "${err}" `
 
-                     );
 
-                     cb({ status: "failure", message: err });
 
-                 } else {
 
-                     console.log("SUCCESS", "USER_LOGOUT", `Logout successful.`);
 
-                     cb({
 
-                         status: "success",
 
-                         message: "Successfully logged out.",
 
-                     });
 
-                 }
 
-             }
 
-         );
 
-     },
 
-     /**
 
-      * Removes all sessions for a user
 
-      *
 
-      * @param {Object} session - the session object automatically added by socket.io
 
-      * @param {String} userId - the id of the user we are trying to delete the sessions of
 
-      * @param {Function} cb - gets called with the result
 
-      */
 
-     removeSessions: hooks.loginRequired(async (session, userId, cb) => {
 
-         const userModel = await db.runJob("GET_MODEL", { modelName: "user" });
 
-         async.waterfall(
 
-             [
 
-                 (next) => {
 
-                     userModel.findOne({ _id: session.userId }, (err, user) => {
 
-                         if (err) return next(err);
 
-                         if (user.role !== "admin" && session.userId !== userId)
 
-                             return next(
 
-                                 "Only admins and the owner of the account can remove their sessions."
 
-                             );
 
-                         else return next();
 
-                     });
 
-                 },
 
-                 (next) => {
 
-                     cache
 
-                         .runJob("HGETALL", { table: "sessions" })
 
-                         .then((sessions) => next(null, sessions))
 
-                         .catch(next);
 
-                 },
 
-                 (sessions, next) => {
 
-                     if (!sessions)
 
-                         return next(
 
-                             "There are no sessions for this user to remove."
 
-                         );
 
-                     else {
 
-                         let keys = Object.keys(sessions);
 
-                         next(null, keys, sessions);
 
-                     }
 
-                 },
 
-                 (keys, sessions, next) => {
 
-                     cache.runJob("PUB", {
 
-                         channel: "user.removeSessions",
 
-                         value: userId,
 
-                     });
 
-                     async.each(
 
-                         keys,
 
-                         (sessionId, callback) => {
 
-                             let session = sessions[sessionId];
 
-                             if (session.userId === userId) {
 
-                                 cache
 
-                                     .runJob("HDEL", {
 
-                                         channel: "sessions",
 
-                                         key: sessionId,
 
-                                     })
 
-                                     .then(() => callback(null))
 
-                                     .catch(next);
 
-                             }
 
-                         },
 
-                         (err) => {
 
-                             next(err);
 
-                         }
 
-                     );
 
-                 },
 
-             ],
 
-             async (err) => {
 
-                 if (err) {
 
-                     err = await utils.runJob("GET_ERROR", { error: err });
 
-                     console.log(
 
-                         "ERROR",
 
-                         "REMOVE_SESSIONS_FOR_USER",
 
-                         `Couldn't remove all sessions for user "${userId}". "${err}"`
 
-                     );
 
-                     return cb({ status: "failure", message: err });
 
-                 } else {
 
-                     console.log(
 
-                         "SUCCESS",
 
-                         "REMOVE_SESSIONS_FOR_USER",
 
-                         `Removed all sessions for user "${userId}".`
 
-                     );
 
-                     return cb({
 
-                         status: "success",
 
-                         message: "Successfully removed all sessions.",
 
-                     });
 
-                 }
 
-             }
 
-         );
 
-     }),
 
-     /**
 
-      * Gets user object from username (only a few properties)
 
-      *
 
-      * @param {Object} session - the session object automatically added by socket.io
 
-      * @param {String} username - the username of the user we are trying to find
 
-      * @param {Function} cb - gets called with the result
 
-      */
 
-     findByUsername: async (session, username, cb) => {
 
-         const userModel = await db.runJob("GET_MODEL", { modelName: "user" });
 
-         async.waterfall(
 
-             [
 
-                 (next) => {
 
-                     userModel.findOne(
 
-                         { username: new RegExp(`^${username}$`, "i") },
 
-                         next
 
-                     );
 
-                 },
 
-                 (account, next) => {
 
-                     if (!account) return next("User not found.");
 
-                     next(null, account);
 
-                 },
 
-             ],
 
-             async (err, account) => {
 
-                 if (err && err !== true) {
 
-                     err = await utils.runJob("GET_ERROR", { error: err });
 
-                     console.log(
 
-                         "ERROR",
 
-                         "FIND_BY_USERNAME",
 
-                         `User not found for username "${username}". "${err}"`
 
-                     );
 
-                     cb({ status: "failure", message: err });
 
-                 } else {
 
-                     console.log(
 
-                         "SUCCESS",
 
-                         "FIND_BY_USERNAME",
 
-                         `User found for username "${username}".`
 
-                     );
 
-                     return cb({
 
-                         status: "success",
 
-                         data: {
 
-                             _id: account._id,
 
-                             name: account.name,
 
-                             username: account.username,
 
-                             location: account.location,
 
-                             bio: account.bio,
 
-                             role: account.role,
 
-                             avatar: account.avatar,
 
-                             createdAt: account.createdAt,
 
-                         },
 
-                     });
 
-                 }
 
-             }
 
-         );
 
-     },
 
-     /**
 
-      * Gets a username from an userId
 
-      *
 
-      * @param {Object} session - the session object automatically added by socket.io
 
-      * @param {String} userId - the userId of the person we are trying to get the username from
 
-      * @param {Function} cb - gets called with the result
 
-      */
 
-     getUsernameFromId: async (session, userId, cb) => {
 
-         const userModel = await db.runJob("GET_MODEL", { modelName: "user" });
 
-         userModel
 
-             .findById(userId)
 
-             .then((user) => {
 
-                 if (user) {
 
-                     console.log(
 
-                         "SUCCESS",
 
-                         "GET_USERNAME_FROM_ID",
 
-                         `Found username for userId "${userId}".`
 
-                     );
 
-                     return cb({
 
-                         status: "success",
 
-                         data: user.username,
 
-                     });
 
-                 } else {
 
-                     console.log(
 
-                         "ERROR",
 
-                         "GET_USERNAME_FROM_ID",
 
-                         `Getting the username from userId "${userId}" failed. User not found.`
 
-                     );
 
-                     cb({
 
-                         status: "failure",
 
-                         message: "Couldn't find the user.",
 
-                     });
 
-                 }
 
-             })
 
-             .catch(async (err) => {
 
-                 if (err && err !== true) {
 
-                     err = await utils.runJob("GET_ERROR", { error: err });
 
-                     console.log(
 
-                         "ERROR",
 
-                         "GET_USERNAME_FROM_ID",
 
-                         `Getting the username from userId "${userId}" failed. "${err}"`
 
-                     );
 
-                     cb({ status: "failure", message: err });
 
-                 }
 
-             });
 
-     },
 
-     //TODO Fix security issues
 
-     /**
 
-      * Gets user info from session
 
-      *
 
-      * @param {Object} session - the session object automatically added by socket.io
 
-      * @param {Function} cb - gets called with the result
 
-      */
 
-     findBySession: async (session, cb) => {
 
-         const userModel = await db.runJob("GET_MODEL", { modelName: "user" });
 
-         async.waterfall(
 
-             [
 
-                 (next) => {
 
-                     cache
 
-                         .runJob("HGET", {
 
-                             table: "sessions",
 
-                             key: session.sessionId,
 
-                         })
 
-                         .then((session) => next(null, session))
 
-                         .catch(next);
 
-                 },
 
-                 (session, next) => {
 
-                     if (!session) return next("Session not found.");
 
-                     next(null, session);
 
-                 },
 
-                 (session, next) => {
 
-                     userModel.findOne({ _id: session.userId }, next);
 
-                 },
 
-                 (user, next) => {
 
-                     if (!user) return next("User not found.");
 
-                     next(null, user);
 
-                 },
 
-             ],
 
-             async (err, user) => {
 
-                 if (err && err !== true) {
 
-                     err = await utils.runJob("GET_ERROR", { error: err });
 
-                     console.log(
 
-                         "ERROR",
 
-                         "FIND_BY_SESSION",
 
-                         `User not found. "${err}"`
 
-                     );
 
-                     cb({ status: "failure", message: err });
 
-                 } else {
 
-                     let data = {
 
-                         email: {
 
-                             address: user.email.address,
 
-                         },
 
-                         avatar: user.avatar,
 
-                         username: user.username,
 
-                         name: user.name,
 
-                         location: user.location,
 
-                         bio: user.bio,
 
-                     };
 
-                     if (
 
-                         user.services.password &&
 
-                         user.services.password.password
 
-                     )
 
-                         data.password = true;
 
-                     if (user.services.github && user.services.github.id)
 
-                         data.github = true;
 
-                     console.log(
 
-                         "SUCCESS",
 
-                         "FIND_BY_SESSION",
 
-                         `User found. "${user.username}".`
 
-                     );
 
-                     return cb({
 
-                         status: "success",
 
-                         data,
 
-                     });
 
-                 }
 
-             }
 
-         );
 
-     },
 
-     /**
 
-      * Updates a user's username
 
-      *
 
-      * @param {Object} session - the session object automatically added by socket.io
 
-      * @param {String} updatingUserId - the updating user's id
 
-      * @param {String} newUsername - the new username
 
-      * @param {Function} cb - gets called with the result
 
-      */
 
-     updateUsername: hooks.loginRequired(
 
-         async (session, updatingUserId, newUsername, cb) => {
 
-             const userModel = await db.runJob("GET_MODEL", {
 
-                 modelName: "user",
 
-             });
 
-             async.waterfall(
 
-                 [
 
-                     (next) => {
 
-                         if (updatingUserId === session.userId)
 
-                             return next(null, true);
 
-                         userModel.findOne({ _id: session.userId }, next);
 
-                     },
 
-                     (user, next) => {
 
-                         if (user !== true && (!user || user.role !== "admin"))
 
-                             return next("Invalid permissions.");
 
-                         userModel.findOne({ _id: updatingUserId }, next);
 
-                     },
 
-                     (user, next) => {
 
-                         if (!user) return next("User not found.");
 
-                         if (user.username === newUsername)
 
-                             return next(
 
-                                 "New username can't be the same as the old username."
 
-                             );
 
-                         next(null);
 
-                     },
 
-                     (next) => {
 
-                         userModel.findOne(
 
-                             { username: new RegExp(`^${newUsername}$`, "i") },
 
-                             next
 
-                         );
 
-                     },
 
-                     (user, next) => {
 
-                         if (!user) return next();
 
-                         if (user._id === updatingUserId) return next();
 
-                         next("That username is already in use.");
 
-                     },
 
-                     (next) => {
 
-                         userModel.updateOne(
 
-                             { _id: updatingUserId },
 
-                             { $set: { username: newUsername } },
 
-                             { runValidators: true },
 
-                             next
 
-                         );
 
-                     },
 
-                 ],
 
-                 async (err) => {
 
-                     if (err && err !== true) {
 
-                         err = await utils.runJob("GET_ERROR", { error: err });
 
-                         console.log(
 
-                             "ERROR",
 
-                             "UPDATE_USERNAME",
 
-                             `Couldn't update username for user "${updatingUserId}" to username "${newUsername}". "${err}"`
 
-                         );
 
-                         cb({ status: "failure", message: err });
 
-                     } else {
 
-                         cache.runJob("PUB", {
 
-                             channel: "user.updateUsername",
 
-                             value: {
 
-                                 username: newUsername,
 
-                                 _id: updatingUserId,
 
-                             },
 
-                         });
 
-                         console.log(
 
-                             "SUCCESS",
 
-                             "UPDATE_USERNAME",
 
-                             `Updated username for user "${updatingUserId}" to username "${newUsername}".`
 
-                         );
 
-                         cb({
 
-                             status: "success",
 
-                             message: "Username updated successfully",
 
-                         });
 
-                     }
 
-                 }
 
-             );
 
-         }
 
-     ),
 
-     /**
 
-      * Updates a user's email
 
-      *
 
-      * @param {Object} session - the session object automatically added by socket.io
 
-      * @param {String} updatingUserId - the updating user's id
 
-      * @param {String} newEmail - the new email
 
-      * @param {Function} cb - gets called with the result
 
-      */
 
-     updateEmail: hooks.loginRequired(
 
-         async (session, updatingUserId, newEmail, cb) => {
 
-             newEmail = newEmail.toLowerCase();
 
-             let verificationToken = await utils.runJob(
 
-                 "GENERATE_RANDOM_STRING",
 
-                 { length: 64 }
 
-             );
 
-             const userModel = await db.runJob("GET_MODEL", {
 
-                 modelName: "user",
 
-             });
 
-             const verifyEmailSchema = await mail.runJob("GET_SCHEMA", {
 
-                 schemaName: "verifyEmail",
 
-             });
 
-             async.waterfall(
 
-                 [
 
-                     (next) => {
 
-                         if (updatingUserId === session.userId)
 
-                             return next(null, true);
 
-                         userModel.findOne({ _id: session.userId }, next);
 
-                     },
 
-                     (user, next) => {
 
-                         if (user !== true && (!user || user.role !== "admin"))
 
-                             return next("Invalid permissions.");
 
-                         userModel.findOne({ _id: updatingUserId }, next);
 
-                     },
 
-                     (user, next) => {
 
-                         if (!user) return next("User not found.");
 
-                         if (user.email.address === newEmail)
 
-                             return next(
 
-                                 "New email can't be the same as your the old email."
 
-                             );
 
-                         next();
 
-                     },
 
-                     (next) => {
 
-                         userModel.findOne({ "email.address": newEmail }, next);
 
-                     },
 
-                     (user, next) => {
 
-                         if (!user) return next();
 
-                         if (user._id === updatingUserId) return next();
 
-                         next("That email is already in use.");
 
-                     },
 
-                     // regenerate the url for gravatar avatar
 
-                     (next) => {
 
-                         utils
 
-                             .runJob("CREATE_GRAVATAR", { email: newEmail })
 
-                             .then((url) => next(null, url));
 
-                     },
 
-                     (avatar, next) => {
 
-                         userModel.updateOne(
 
-                             { _id: updatingUserId },
 
-                             {
 
-                                 $set: {
 
-                                     avatar: avatar,
 
-                                     "email.address": newEmail,
 
-                                     "email.verified": false,
 
-                                     "email.verificationToken": verificationToken,
 
-                                 },
 
-                             },
 
-                             { runValidators: true },
 
-                             next
 
-                         );
 
-                     },
 
-                     (res, next) => {
 
-                         userModel.findOne({ _id: updatingUserId }, next);
 
-                     },
 
-                     (user, next) => {
 
-                         verifyEmailSchema(
 
-                             newEmail,
 
-                             user.username,
 
-                             verificationToken,
 
-                             () => {
 
-                                 next();
 
-                             }
 
-                         );
 
-                     },
 
-                 ],
 
-                 async (err) => {
 
-                     if (err && err !== true) {
 
-                         err = await utils.runJob("GET_ERROR", { error: err });
 
-                         console.log(
 
-                             "ERROR",
 
-                             "UPDATE_EMAIL",
 
-                             `Couldn't update email for user "${updatingUserId}" to email "${newEmail}". '${err}'`
 
-                         );
 
-                         cb({ status: "failure", message: err });
 
-                     } else {
 
-                         console.log(
 
-                             "SUCCESS",
 
-                             "UPDATE_EMAIL",
 
-                             `Updated email for user "${updatingUserId}" to email "${newEmail}".`
 
-                         );
 
-                         cb({
 
-                             status: "success",
 
-                             message: "Email updated successfully.",
 
-                         });
 
-                     }
 
-                 }
 
-             );
 
-         }
 
-     ),
 
-     /**
 
-      * Updates a user's name
 
-      *
 
-      * @param {Object} session - the session object automatically added by socket.io
 
-      * @param {String} updatingUserId - the updating user's id
 
-      * @param {String} newBio - the new name
 
-      * @param {Function} cb - gets called with the result
 
-      */
 
-     updateName: hooks.loginRequired(
 
-         async (session, updatingUserId, newName, cb) => {
 
-             const userModel = await db.runJob("GET_MODEL", {
 
-                 modelName: "user",
 
-             });
 
-             async.waterfall(
 
-                 [
 
-                     (next) => {
 
-                         if (updatingUserId === session.userId)
 
-                             return next(null, true);
 
-                         userModel.findOne({ _id: session.userId }, next);
 
-                     },
 
-                     (user, next) => {
 
-                         if (user !== true && (!user || user.role !== "admin"))
 
-                             return next("Invalid permissions.");
 
-                         userModel.findOne({ _id: updatingUserId }, next);
 
-                     },
 
-                     (user, next) => {
 
-                         if (!user) return next("User not found.");
 
-                         userModel.updateOne(
 
-                             { _id: updatingUserId },
 
-                             { $set: { name: newName } },
 
-                             { runValidators: true },
 
-                             next
 
-                         );
 
-                     },
 
-                 ],
 
-                 async (err) => {
 
-                     if (err && err !== true) {
 
-                         err = await utils.runJob("GET_ERROR", { error: err });
 
-                         console.log(
 
-                             "ERROR",
 
-                             "UPDATE_NAME",
 
-                             `Couldn't update name for user "${updatingUserId}" to name "${newName}". "${err}"`
 
-                         );
 
-                         cb({ status: "failure", message: err });
 
-                     } else {
 
-                         console.log(
 
-                             "SUCCESS",
 
-                             "UPDATE_NAME",
 
-                             `Updated name for user "${updatingUserId}" to name "${newName}".`
 
-                         );
 
-                         cb({
 
-                             status: "success",
 
-                             message: "Name updated successfully",
 
-                         });
 
-                     }
 
-                 }
 
-             );
 
-         }
 
-     ),
 
-     /**
 
-      * Updates a user's location
 
-      *
 
-      * @param {Object} session - the session object automatically added by socket.io
 
-      * @param {String} updatingUserId - the updating user's id
 
-      * @param {String} newLocation - the new location
 
-      * @param {Function} cb - gets called with the result
 
-      */
 
-     updateLocation: hooks.loginRequired(
 
-         async (session, updatingUserId, newLocation, cb) => {
 
-             const userModel = await db.runJob("GET_MODEL", {
 
-                 modelName: "user",
 
-             });
 
-             async.waterfall(
 
-                 [
 
-                     (next) => {
 
-                         if (updatingUserId === session.userId)
 
-                             return next(null, true);
 
-                         userModel.findOne({ _id: session.userId }, next);
 
-                     },
 
-                     (user, next) => {
 
-                         if (user !== true && (!user || user.role !== "admin"))
 
-                             return next("Invalid permissions.");
 
-                         userModel.findOne({ _id: updatingUserId }, next);
 
-                     },
 
-                     (user, next) => {
 
-                         if (!user) return next("User not found.");
 
-                         userModel.updateOne(
 
-                             { _id: updatingUserId },
 
-                             { $set: { location: newLocation } },
 
-                             { runValidators: true },
 
-                             next
 
-                         );
 
-                     },
 
-                 ],
 
-                 async (err) => {
 
-                     if (err && err !== true) {
 
-                         err = await utils.runJob("GET_ERROR", { error: err });
 
-                         console.log(
 
-                             "ERROR",
 
-                             "UPDATE_LOCATION",
 
-                             `Couldn't update location for user "${updatingUserId}" to location "${newLocation}". "${err}"`
 
-                         );
 
-                         cb({ status: "failure", message: err });
 
-                     } else {
 
-                         console.log(
 
-                             "SUCCESS",
 
-                             "UPDATE_LOCATION",
 
-                             `Updated location for user "${updatingUserId}" to location "${newLocation}".`
 
-                         );
 
-                         cb({
 
-                             status: "success",
 
-                             message: "Location updated successfully",
 
-                         });
 
-                     }
 
-                 }
 
-             );
 
-         }
 
-     ),
 
-     /**
 
-      * Updates a user's bio
 
-      *
 
-      * @param {Object} session - the session object automatically added by socket.io
 
-      * @param {String} updatingUserId - the updating user's id
 
-      * @param {String} newBio - the new bio
 
-      * @param {Function} cb - gets called with the result
 
-      */
 
-     updateBio: hooks.loginRequired(
 
-         async (session, updatingUserId, newBio, cb) => {
 
-             const userModel = await db.runJob("GET_MODEL", {
 
-                 modelName: "user",
 
-             });
 
-             async.waterfall(
 
-                 [
 
-                     (next) => {
 
-                         if (updatingUserId === session.userId)
 
-                             return next(null, true);
 
-                         userModel.findOne({ _id: session.userId }, next);
 
-                     },
 
-                     (user, next) => {
 
-                         if (user !== true && (!user || user.role !== "admin"))
 
-                             return next("Invalid permissions.");
 
-                         userModel.findOne({ _id: updatingUserId }, next);
 
-                     },
 
-                     (user, next) => {
 
-                         if (!user) return next("User not found.");
 
-                         userModel.updateOne(
 
-                             { _id: updatingUserId },
 
-                             { $set: { bio: newBio } },
 
-                             { runValidators: true },
 
-                             next
 
-                         );
 
-                     },
 
-                 ],
 
-                 async (err) => {
 
-                     if (err && err !== true) {
 
-                         err = await utils.runJob("GET_ERROR", { error: err });
 
-                         console.log(
 
-                             "ERROR",
 
-                             "UPDATE_BIO",
 
-                             `Couldn't update bio for user "${updatingUserId}" to bio "${newBio}". "${err}"`
 
-                         );
 
-                         cb({ status: "failure", message: err });
 
-                     } else {
 
-                         console.log(
 
-                             "SUCCESS",
 
-                             "UPDATE_BIO",
 
-                             `Updated bio for user "${updatingUserId}" to bio "${newBio}".`
 
-                         );
 
-                         cb({
 
-                             status: "success",
 
-                             message: "Bio updated successfully",
 
-                         });
 
-                     }
 
-                 }
 
-             );
 
-         }
 
-     ),
 
-     /**
 
-      * Updates the type of a user's avatar
 
-      *
 
-      * @param {Object} session - the session object automatically added by socket.io
 
-      * @param {String} updatingUserId - the updating user's id
 
-      * @param {String} newType - the new type
 
-      * @param {Function} cb - gets called with the result
 
-      */
 
-     updateAvatarType: hooks.loginRequired(
 
-         async (session, updatingUserId, newType, cb) => {
 
-             const userModel = await db.runJob("GET_MODEL", {
 
-                 modelName: "user",
 
-             });
 
-             async.waterfall(
 
-                 [
 
-                     (next) => {
 
-                         if (updatingUserId === session.userId)
 
-                             return next(null, true);
 
-                         userModel.findOne({ _id: session.userId }, next);
 
-                     },
 
-                     (user, next) => {
 
-                         if (user !== true && (!user || user.role !== "admin"))
 
-                             return next("Invalid permissions.");
 
-                         userModel.findOne({ _id: updatingUserId }, next);
 
-                     },
 
-                     (user, next) => {
 
-                         if (!user) return next("User not found.");
 
-                         userModel.updateOne(
 
-                             { _id: updatingUserId },
 
-                             { $set: { "avatar.type": newType } },
 
-                             { runValidators: true },
 
-                             next
 
-                         );
 
-                     },
 
-                 ],
 
-                 async (err) => {
 
-                     if (err && err !== true) {
 
-                         err = await utils.runJob("GET_ERROR", { error: err });
 
-                         console.log(
 
-                             "ERROR",
 
-                             "UPDATE_AVATAR_TYPE",
 
-                             `Couldn't update avatar type for user "${updatingUserId}" to type "${newType}". "${err}"`
 
-                         );
 
-                         cb({ status: "failure", message: err });
 
-                     } else {
 
-                         console.log(
 
-                             "SUCCESS",
 
-                             "UPDATE_AVATAR_TYPE",
 
-                             `Updated avatar type for user "${updatingUserId}" to type "${newType}".`
 
-                         );
 
-                         cb({
 
-                             status: "success",
 
-                             message: "Avatar type updated successfully",
 
-                         });
 
-                     }
 
-                 }
 
-             );
 
-         }
 
-     ),
 
-     /**
 
-      * Updates a user's role
 
-      *
 
-      * @param {Object} session - the session object automatically added by socket.io
 
-      * @param {String} updatingUserId - the updating user's id
 
-      * @param {String} newRole - the new role
 
-      * @param {Function} cb - gets called with the result
 
-      */
 
-     updateRole: hooks.adminRequired(
 
-         async (session, updatingUserId, newRole, cb) => {
 
-             newRole = newRole.toLowerCase();
 
-             const userModel = await db.runJob("GET_MODEL", {
 
-                 modelName: "user",
 
-             });
 
-             async.waterfall(
 
-                 [
 
-                     (next) => {
 
-                         userModel.findOne({ _id: updatingUserId }, next);
 
-                     },
 
-                     (user, next) => {
 
-                         if (!user) return next("User not found.");
 
-                         else if (user.role === newRole)
 
-                             return next(
 
-                                 "New role can't be the same as the old role."
 
-                             );
 
-                         else return next();
 
-                     },
 
-                     (next) => {
 
-                         userModel.updateOne(
 
-                             { _id: updatingUserId },
 
-                             { $set: { role: newRole } },
 
-                             { runValidators: true },
 
-                             next
 
-                         );
 
-                     },
 
-                 ],
 
-                 async (err) => {
 
-                     if (err && err !== true) {
 
-                         err = await utils.runJob("GET_ERROR", { error: err });
 
-                         console.log(
 
-                             "ERROR",
 
-                             "UPDATE_ROLE",
 
-                             `User "${session.userId}" couldn't update role for user "${updatingUserId}" to role "${newRole}". "${err}"`
 
-                         );
 
-                         cb({ status: "failure", message: err });
 
-                     } else {
 
-                         console.log(
 
-                             "SUCCESS",
 
-                             "UPDATE_ROLE",
 
-                             `User "${session.userId}" updated the role of user "${updatingUserId}" to role "${newRole}".`
 
-                         );
 
-                         cb({
 
-                             status: "success",
 
-                             message: "Role successfully updated.",
 
-                         });
 
-                     }
 
-                 }
 
-             );
 
-         }
 
-     ),
 
-     /**
 
-      * Updates a user's password
 
-      *
 
-      * @param {Object} session - the session object automatically added by socket.io
 
-      * @param {String} newPassword - the new password
 
-      * @param {Function} cb - gets called with the result
 
-      */
 
-     updatePassword: hooks.loginRequired(async (session, newPassword, cb) => {
 
-         const userModel = await db.runJob("GET_MODEL", { modelName: "user" });
 
-         async.waterfall(
 
-             [
 
-                 (next) => {
 
-                     userModel.findOne({ _id: session.userId }, next);
 
-                 },
 
-                 (user, next) => {
 
-                     if (!user.services.password)
 
-                         return next(
 
-                             "This account does not have a password set."
 
-                         );
 
-                     next();
 
-                 },
 
-                 (next) => {
 
-                     if (!db.passwordValid(newPassword))
 
-                         return next(
 
-                             "Invalid password. Check if it meets all the requirements."
 
-                         );
 
-                     return next();
 
-                 },
 
-                 (next) => {
 
-                     bcrypt.genSalt(10, next);
 
-                 },
 
-                 // hash the password
 
-                 (salt, next) => {
 
-                     bcrypt.hash(sha256(newPassword), salt, next);
 
-                 },
 
-                 (hashedPassword, next) => {
 
-                     userModel.updateOne(
 
-                         { _id: session.userId },
 
-                         {
 
-                             $set: {
 
-                                 "services.password.password": hashedPassword,
 
-                             },
 
-                         },
 
-                         next
 
-                     );
 
-                 },
 
-             ],
 
-             async (err) => {
 
-                 if (err) {
 
-                     err = await utils.runJob("GET_ERROR", { error: err });
 
-                     console.log(
 
-                         "ERROR",
 
-                         "UPDATE_PASSWORD",
 
-                         `Failed updating user password of user '${session.userId}'. '${err}'.`
 
-                     );
 
-                     return cb({ status: "failure", message: err });
 
-                 }
 
-                 console.log(
 
-                     "SUCCESS",
 
-                     "UPDATE_PASSWORD",
 
-                     `User '${session.userId}' updated their password.`
 
-                 );
 
-                 cb({
 
-                     status: "success",
 
-                     message: "Password successfully updated.",
 
-                 });
 
-             }
 
-         );
 
-     }),
 
-     /**
 
-      * Requests a password for a session
 
-      *
 
-      * @param {Object} session - the session object automatically added by socket.io
 
-      * @param {String} email - the email of the user that requests a password reset
 
-      * @param {Function} cb - gets called with the result
 
-      */
 
-     requestPassword: hooks.loginRequired(async (session, cb) => {
 
-         let code = await utils.runJob("GENERATE_RANDOM_STRING", { length: 8 });
 
-         const passwordRequestSchema = await mail.runJob("GET_SCHEMA", {
 
-             schemaName: "passwordRequest",
 
-         });
 
-         const userModel = await db.runJob("GET_MODEL", { modelName: "user" });
 
-         async.waterfall(
 
-             [
 
-                 (next) => {
 
-                     userModel.findOne({ _id: session.userId }, next);
 
-                 },
 
-                 (user, next) => {
 
-                     if (!user) return next("User not found.");
 
-                     if (
 
-                         user.services.password &&
 
-                         user.services.password.password
 
-                     )
 
-                         return next("You already have a password set.");
 
-                     next(null, user);
 
-                 },
 
-                 (user, next) => {
 
-                     let expires = new Date();
 
-                     expires.setDate(expires.getDate() + 1);
 
-                     userModel.findOneAndUpdate(
 
-                         { "email.address": user.email.address },
 
-                         {
 
-                             $set: {
 
-                                 "services.password": {
 
-                                     set: { code: code, expires },
 
-                                 },
 
-                             },
 
-                         },
 
-                         { runValidators: true },
 
-                         next
 
-                     );
 
-                 },
 
-                 (user, next) => {
 
-                     passwordRequestSchema(
 
-                         user.email.address,
 
-                         user.username,
 
-                         code,
 
-                         next
 
-                     );
 
-                 },
 
-             ],
 
-             async (err) => {
 
-                 if (err && err !== true) {
 
-                     err = await utils.runJob("GET_ERROR", { error: err });
 
-                     console.log(
 
-                         "ERROR",
 
-                         "REQUEST_PASSWORD",
 
-                         `UserId '${session.userId}' failed to request password. '${err}'`
 
-                     );
 
-                     cb({ status: "failure", message: err });
 
-                 } else {
 
-                     console.log(
 
-                         "SUCCESS",
 
-                         "REQUEST_PASSWORD",
 
-                         `UserId '${session.userId}' successfully requested a password.`
 
-                     );
 
-                     cb({
 
-                         status: "success",
 
-                         message: "Successfully requested password.",
 
-                     });
 
-                 }
 
-             }
 
-         );
 
-     }),
 
-     /**
 
-      * Verifies a password code
 
-      *
 
-      * @param {Object} session - the session object automatically added by socket.io
 
-      * @param {String} code - the password code
 
-      * @param {Function} cb - gets called with the result
 
-      */
 
-     verifyPasswordCode: hooks.loginRequired(async (session, code, cb) => {
 
-         const userModel = await db.runJob("GET_MODEL", { modelName: "user" });
 
-         async.waterfall(
 
-             [
 
-                 (next) => {
 
-                     if (!code || typeof code !== "string")
 
-                         return next("Invalid code1.");
 
-                     userModel.findOne(
 
-                         {
 
-                             "services.password.set.code": code,
 
-                             _id: session.userId,
 
-                         },
 
-                         next
 
-                     );
 
-                 },
 
-                 (user, next) => {
 
-                     if (!user) return next("Invalid code2.");
 
-                     if (user.services.password.set.expires < new Date())
 
-                         return next("That code has expired.");
 
-                     next(null);
 
-                 },
 
-             ],
 
-             async (err) => {
 
-                 if (err && err !== true) {
 
-                     err = await utils.runJob("GET_ERROR", { error: err });
 
-                     console.log(
 
-                         "ERROR",
 
-                         "VERIFY_PASSWORD_CODE",
 
-                         `Code '${code}' failed to verify. '${err}'`
 
-                     );
 
-                     cb({ status: "failure", message: err });
 
-                 } else {
 
-                     console.log(
 
-                         "SUCCESS",
 
-                         "VERIFY_PASSWORD_CODE",
 
-                         `Code '${code}' successfully verified.`
 
-                     );
 
-                     cb({
 
-                         status: "success",
 
-                         message: "Successfully verified password code.",
 
-                     });
 
-                 }
 
-             }
 
-         );
 
-     }),
 
-     /**
 
-      * Adds a password to a user with a code
 
-      *
 
-      * @param {Object} session - the session object automatically added by socket.io
 
-      * @param {String} code - the password code
 
-      * @param {String} newPassword - the new password code
 
-      * @param {Function} cb - gets called with the result
 
-      */
 
-     changePasswordWithCode: hooks.loginRequired(
 
-         async (session, code, newPassword, cb) => {
 
-             const userModel = await db.runJob("GET_MODEL", {
 
-                 modelName: "user",
 
-             });
 
-             async.waterfall(
 
-                 [
 
-                     (next) => {
 
-                         if (!code || typeof code !== "string")
 
-                             return next("Invalid code1.");
 
-                         userModel.findOne(
 
-                             { "services.password.set.code": code },
 
-                             next
 
-                         );
 
-                     },
 
-                     (user, next) => {
 
-                         if (!user) return next("Invalid code2.");
 
-                         if (!user.services.password.set.expires > new Date())
 
-                             return next("That code has expired.");
 
-                         next();
 
-                     },
 
-                     (next) => {
 
-                         if (!db.passwordValid(newPassword))
 
-                             return next(
 
-                                 "Invalid password. Check if it meets all the requirements."
 
-                             );
 
-                         return next();
 
-                     },
 
-                     (next) => {
 
-                         bcrypt.genSalt(10, next);
 
-                     },
 
-                     // hash the password
 
-                     (salt, next) => {
 
-                         bcrypt.hash(sha256(newPassword), salt, next);
 
-                     },
 
-                     (hashedPassword, next) => {
 
-                         userModel.updateOne(
 
-                             { "services.password.set.code": code },
 
-                             {
 
-                                 $set: {
 
-                                     "services.password.password": hashedPassword,
 
-                                 },
 
-                                 $unset: { "services.password.set": "" },
 
-                             },
 
-                             { runValidators: true },
 
-                             next
 
-                         );
 
-                     },
 
-                 ],
 
-                 async (err) => {
 
-                     if (err && err !== true) {
 
-                         err = await utils.runJob("GET_ERROR", { error: err });
 
-                         console.log(
 
-                             "ERROR",
 
-                             "ADD_PASSWORD_WITH_CODE",
 
-                             `Code '${code}' failed to add password. '${err}'`
 
-                         );
 
-                         cb({ status: "failure", message: err });
 
-                     } else {
 
-                         console.log(
 
-                             "SUCCESS",
 
-                             "ADD_PASSWORD_WITH_CODE",
 
-                             `Code '${code}' successfully added password.`
 
-                         );
 
-                         cache.runJob("PUB", {
 
-                             channel: "user.linkPassword",
 
-                             value: session.userId,
 
-                         });
 
-                         cb({
 
-                             status: "success",
 
-                             message: "Successfully added password.",
 
-                         });
 
-                     }
 
-                 }
 
-             );
 
-         }
 
-     ),
 
-     /**
 
-      * Unlinks password from user
 
-      *
 
-      * @param {Object} session - the session object automatically added by socket.io
 
-      * @param {Function} cb - gets called with the result
 
-      */
 
-     unlinkPassword: hooks.loginRequired(async (session, cb) => {
 
-         const userModel = await db.runJob("GET_MODEL", { modelName: "user" });
 
-         async.waterfall(
 
-             [
 
-                 (next) => {
 
-                     userModel.findOne({ _id: session.userId }, next);
 
-                 },
 
-                 (user, next) => {
 
-                     if (!user) return next("Not logged in.");
 
-                     if (!user.services.github || !user.services.github.id)
 
-                         return next(
 
-                             "You can't remove password login without having GitHub login."
 
-                         );
 
-                     userModel.updateOne(
 
-                         { _id: session.userId },
 
-                         { $unset: { "services.password": "" } },
 
-                         next
 
-                     );
 
-                 },
 
-             ],
 
-             async (err) => {
 
-                 if (err && err !== true) {
 
-                     err = await utils.runJob("GET_ERROR", { error: err });
 
-                     console.log(
 
-                         "ERROR",
 
-                         "UNLINK_PASSWORD",
 
-                         `Unlinking password failed for userId '${session.userId}'. '${err}'`
 
-                     );
 
-                     cb({ status: "failure", message: err });
 
-                 } else {
 
-                     console.log(
 
-                         "SUCCESS",
 
-                         "UNLINK_PASSWORD",
 
-                         `Unlinking password successful for userId '${session.userId}'.`
 
-                     );
 
-                     cache.runJob("PUB", {
 
-                         channel: "user.unlinkPassword",
 
-                         value: session.userId,
 
-                     });
 
-                     cb({
 
-                         status: "success",
 
-                         message: "Successfully unlinked password.",
 
-                     });
 
-                 }
 
-             }
 
-         );
 
-     }),
 
-     /**
 
-      * Unlinks GitHub from user
 
-      *
 
-      * @param {Object} session - the session object automatically added by socket.io
 
-      * @param {Function} cb - gets called with the result
 
-      */
 
-     unlinkGitHub: hooks.loginRequired(async (session, cb) => {
 
-         const userModel = await db.runJob("GET_MODEL", { modelName: "user" });
 
-         async.waterfall(
 
-             [
 
-                 (next) => {
 
-                     userModel.findOne({ _id: session.userId }, next);
 
-                 },
 
-                 (user, next) => {
 
-                     if (!user) return next("Not logged in.");
 
-                     if (
 
-                         !user.services.password ||
 
-                         !user.services.password.password
 
-                     )
 
-                         return next(
 
-                             "You can't remove GitHub login without having password login."
 
-                         );
 
-                     userModel.updateOne(
 
-                         { _id: session.userId },
 
-                         { $unset: { "services.github": "" } },
 
-                         next
 
-                     );
 
-                 },
 
-             ],
 
-             async (err) => {
 
-                 if (err && err !== true) {
 
-                     err = await utils.runJob("GET_ERROR", { error: err });
 
-                     console.log(
 
-                         "ERROR",
 
-                         "UNLINK_GITHUB",
 
-                         `Unlinking GitHub failed for userId '${session.userId}'. '${err}'`
 
-                     );
 
-                     cb({ status: "failure", message: err });
 
-                 } else {
 
-                     console.log(
 
-                         "SUCCESS",
 
-                         "UNLINK_GITHUB",
 
-                         `Unlinking GitHub successful for userId '${session.userId}'.`
 
-                     );
 
-                     cache.runJob("PUB", {
 
-                         channel: "user.unlinkGithub",
 
-                         value: session.userId,
 
-                     });
 
-                     cb({
 
-                         status: "success",
 
-                         message: "Successfully unlinked GitHub.",
 
-                     });
 
-                 }
 
-             }
 
-         );
 
-     }),
 
-     /**
 
-      * Requests a password reset for an email
 
-      *
 
-      * @param {Object} session - the session object automatically added by socket.io
 
-      * @param {String} email - the email of the user that requests a password reset
 
-      * @param {Function} cb - gets called with the result
 
-      */
 
-     requestPasswordReset: async (session, email, cb) => {
 
-         let code = await utils.runJob("GENERATE_RANDOM_STRING", { length: 8 });
 
-         console.log(111, code);
 
-         const userModel = await db.runJob("GET_MODEL", { modelName: "user" });
 
-         const resetPasswordRequestSchema = await mail.runJob("GET_SCHEMA", {
 
-             schemaName: "resetPasswordRequest",
 
-         });
 
-         async.waterfall(
 
-             [
 
-                 (next) => {
 
-                     if (!email || typeof email !== "string")
 
-                         return next("Invalid email.");
 
-                     email = email.toLowerCase();
 
-                     userModel.findOne({ "email.address": email }, next);
 
-                 },
 
-                 (user, next) => {
 
-                     if (!user) return next("User not found.");
 
-                     if (
 
-                         !user.services.password ||
 
-                         !user.services.password.password
 
-                     )
 
-                         return next(
 
-                             "User does not have a password set, and probably uses GitHub to log in."
 
-                         );
 
-                     next(null, user);
 
-                 },
 
-                 (user, next) => {
 
-                     let expires = new Date();
 
-                     expires.setDate(expires.getDate() + 1);
 
-                     userModel.findOneAndUpdate(
 
-                         { "email.address": email },
 
-                         {
 
-                             $set: {
 
-                                 "services.password.reset": {
 
-                                     code: code,
 
-                                     expires,
 
-                                 },
 
-                             },
 
-                         },
 
-                         { runValidators: true },
 
-                         next
 
-                     );
 
-                 },
 
-                 (user, next) => {
 
-                     resetPasswordRequestSchema(
 
-                         user.email.address,
 
-                         user.username,
 
-                         code,
 
-                         next
 
-                     );
 
-                 },
 
-             ],
 
-             async (err) => {
 
-                 if (err && err !== true) {
 
-                     err = await utils.runJob("GET_ERROR", { error: err });
 
-                     console.log(
 
-                         "ERROR",
 
-                         "REQUEST_PASSWORD_RESET",
 
-                         `Email '${email}' failed to request password reset. '${err}'`
 
-                     );
 
-                     cb({ status: "failure", message: err });
 
-                 } else {
 
-                     console.log(
 
-                         "SUCCESS",
 
-                         "REQUEST_PASSWORD_RESET",
 
-                         `Email '${email}' successfully requested a password reset.`
 
-                     );
 
-                     cb({
 
-                         status: "success",
 
-                         message: "Successfully requested password reset.",
 
-                     });
 
-                 }
 
-             }
 
-         );
 
-     },
 
-     /**
 
-      * Verifies a reset code
 
-      *
 
-      * @param {Object} session - the session object automatically added by socket.io
 
-      * @param {String} code - the password reset code
 
-      * @param {Function} cb - gets called with the result
 
-      */
 
-     verifyPasswordResetCode: async (session, code, cb) => {
 
-         const userModel = await db.runJob("GET_MODEL", { modelName: "user" });
 
-         async.waterfall(
 
-             [
 
-                 (next) => {
 
-                     if (!code || typeof code !== "string")
 
-                         return next("Invalid code.");
 
-                     userModel.findOne(
 
-                         { "services.password.reset.code": code },
 
-                         next
 
-                     );
 
-                 },
 
-                 (user, next) => {
 
-                     if (!user) return next("Invalid code.");
 
-                     if (!user.services.password.reset.expires > new Date())
 
-                         return next("That code has expired.");
 
-                     next(null);
 
-                 },
 
-             ],
 
-             async (err) => {
 
-                 if (err && err !== true) {
 
-                     err = await utils.runJob("GET_ERROR", { error: err });
 
-                     console.log(
 
-                         "ERROR",
 
-                         "VERIFY_PASSWORD_RESET_CODE",
 
-                         `Code '${code}' failed to verify. '${err}'`
 
-                     );
 
-                     cb({ status: "failure", message: err });
 
-                 } else {
 
-                     console.log(
 
-                         "SUCCESS",
 
-                         "VERIFY_PASSWORD_RESET_CODE",
 
-                         `Code '${code}' successfully verified.`
 
-                     );
 
-                     cb({
 
-                         status: "success",
 
-                         message: "Successfully verified password reset code.",
 
-                     });
 
-                 }
 
-             }
 
-         );
 
-     },
 
-     /**
 
-      * Changes a user's password with a reset code
 
-      *
 
-      * @param {Object} session - the session object automatically added by socket.io
 
-      * @param {String} code - the password reset code
 
-      * @param {String} newPassword - the new password reset code
 
-      * @param {Function} cb - gets called with the result
 
-      */
 
-     changePasswordWithResetCode: async (session, code, newPassword, cb) => {
 
-         const userModel = await db.runJob("GET_MODEL", { modelName: "user" });
 
-         async.waterfall(
 
-             [
 
-                 (next) => {
 
-                     if (!code || typeof code !== "string")
 
-                         return next("Invalid code.");
 
-                     userModel.findOne(
 
-                         { "services.password.reset.code": code },
 
-                         next
 
-                     );
 
-                 },
 
-                 (user, next) => {
 
-                     if (!user) return next("Invalid code.");
 
-                     if (!user.services.password.reset.expires > new Date())
 
-                         return next("That code has expired.");
 
-                     next();
 
-                 },
 
-                 (next) => {
 
-                     if (!db.passwordValid(newPassword))
 
-                         return next(
 
-                             "Invalid password. Check if it meets all the requirements."
 
-                         );
 
-                     return next();
 
-                 },
 
-                 (next) => {
 
-                     bcrypt.genSalt(10, next);
 
-                 },
 
-                 // hash the password
 
-                 (salt, next) => {
 
-                     bcrypt.hash(sha256(newPassword), salt, next);
 
-                 },
 
-                 (hashedPassword, next) => {
 
-                     userModel.updateOne(
 
-                         { "services.password.reset.code": code },
 
-                         {
 
-                             $set: {
 
-                                 "services.password.password": hashedPassword,
 
-                             },
 
-                             $unset: { "services.password.reset": "" },
 
-                         },
 
-                         { runValidators: true },
 
-                         next
 
-                     );
 
-                 },
 
-             ],
 
-             async (err) => {
 
-                 if (err && err !== true) {
 
-                     err = await utils.runJob("GET_ERROR", { error: err });
 
-                     console.log(
 
-                         "ERROR",
 
-                         "CHANGE_PASSWORD_WITH_RESET_CODE",
 
-                         `Code '${code}' failed to change password. '${err}'`
 
-                     );
 
-                     cb({ status: "failure", message: err });
 
-                 } else {
 
-                     console.log(
 
-                         "SUCCESS",
 
-                         "CHANGE_PASSWORD_WITH_RESET_CODE",
 
-                         `Code '${code}' successfully changed password.`
 
-                     );
 
-                     cb({
 
-                         status: "success",
 
-                         message: "Successfully changed password.",
 
-                     });
 
-                 }
 
-             }
 
-         );
 
-     },
 
-     /**
 
-      * Bans a user by userId
 
-      *
 
-      * @param {Object} session - the session object automatically added by socket.io
 
-      * @param {String} value - the user id that is going to be banned
 
-      * @param {String} reason - the reason for the ban
 
-      * @param {String} expiresAt - the time the ban expires
 
-      * @param {Function} cb - gets called with the result
 
-      */
 
-     banUserById: hooks.adminRequired(
 
-         (session, userId, reason, expiresAt, cb) => {
 
-             async.waterfall(
 
-                 [
 
-                     (next) => {
 
-                         if (!userId)
 
-                             return next("You must provide a userId to ban.");
 
-                         else if (!reason)
 
-                             return next(
 
-                                 "You must provide a reason for the ban."
 
-                             );
 
-                         else return next();
 
-                     },
 
-                     (next) => {
 
-                         if (!expiresAt || typeof expiresAt !== "string")
 
-                             return next("Invalid expire date.");
 
-                         let date = new Date();
 
-                         switch (expiresAt) {
 
-                             case "1h":
 
-                                 expiresAt = date.setHours(date.getHours() + 1);
 
-                                 break;
 
-                             case "12h":
 
-                                 expiresAt = date.setHours(date.getHours() + 12);
 
-                                 break;
 
-                             case "1d":
 
-                                 expiresAt = date.setDate(date.getDate() + 1);
 
-                                 break;
 
-                             case "1w":
 
-                                 expiresAt = date.setDate(date.getDate() + 7);
 
-                                 break;
 
-                             case "1m":
 
-                                 expiresAt = date.setMonth(date.getMonth() + 1);
 
-                                 break;
 
-                             case "3m":
 
-                                 expiresAt = date.setMonth(date.getMonth() + 3);
 
-                                 break;
 
-                             case "6m":
 
-                                 expiresAt = date.setMonth(date.getMonth() + 6);
 
-                                 break;
 
-                             case "1y":
 
-                                 expiresAt = date.setFullYear(
 
-                                     date.getFullYear() + 1
 
-                                 );
 
-                                 break;
 
-                             case "never":
 
-                                 expiresAt = new Date(3093527980800000);
 
-                                 break;
 
-                             default:
 
-                                 return next("Invalid expire date.");
 
-                         }
 
-                         next();
 
-                     },
 
-                     (next) => {
 
-                         punishments
 
-                             .runJob("ADD_PUNISHMENT", {
 
-                                 type: "banUserId",
 
-                                 value: userId,
 
-                                 reason,
 
-                                 expiresAt,
 
-                                 punishedBy,
 
-                             })
 
-                             .then((punishment) => next(null, punishment))
 
-                             .catch(next);
 
-                     },
 
-                     (punishment, next) => {
 
-                         cache.runJob("PUB", {
 
-                             channel: "user.ban",
 
-                             value: { userId, punishment },
 
-                         });
 
-                         next();
 
-                     },
 
-                 ],
 
-                 async (err) => {
 
-                     if (err && err !== true) {
 
-                         err = await utils.runJob("GET_ERROR", { error: err });
 
-                         console.log(
 
-                             "ERROR",
 
-                             "BAN_USER_BY_ID",
 
-                             `User ${session.userId} failed to ban user ${userId} with the reason ${reason}. '${err}'`
 
-                         );
 
-                         cb({ status: "failure", message: err });
 
-                     } else {
 
-                         console.log(
 
-                             "SUCCESS",
 
-                             "BAN_USER_BY_ID",
 
-                             `User ${session.userId} has successfully banned user ${userId} with the reason ${reason}.`
 
-                         );
 
-                         cb({
 
-                             status: "success",
 
-                             message: "Successfully banned user.",
 
-                         });
 
-                     }
 
-                 }
 
-             );
 
-         }
 
-     ),
 
-     getFavoriteStations: hooks.loginRequired(async (session, cb) => {
 
-         const userModel = await db.runJob("GET_MODEL", { modelName: "user" });
 
-         async.waterfall(
 
-             [
 
-                 (next) => {
 
-                     userModel.findOne({ _id: session.userId }, next);
 
-                 },
 
-                 (user, next) => {
 
-                     if (!user) return next("User not found.");
 
-                     next(null, user);
 
-                 },
 
-             ],
 
-             async (err, user) => {
 
-                 if (err && err !== true) {
 
-                     err = await utils.runJob("GET_ERROR", { error: err });
 
-                     console.log(
 
-                         "ERROR",
 
-                         "GET_FAVORITE_STATIONS",
 
-                         `User ${session.userId} failed to get favorite stations. '${err}'`
 
-                     );
 
-                     cb({ status: "failure", message: err });
 
-                 } else {
 
-                     console.log(
 
-                         "SUCCESS",
 
-                         "GET_FAVORITE_STATIONS",
 
-                         `User ${session.userId} got favorite stations.`
 
-                     );
 
-                     cb({
 
-                         status: "success",
 
-                         favoriteStations: user.favoriteStations,
 
-                     });
 
-                 }
 
-             }
 
-         );
 
-     }),
 
- };
 
 
  |