531 lines
21 KiB
HTML
531 lines
21 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>JSDoc: Source: schemas/user/userBanSchema.js</title>
|
|
|
|
<script src="scripts/prettify/prettify.js"> </script>
|
|
<script src="scripts/prettify/lang-css.js"> </script>
|
|
<!--[if lt IE 9]>
|
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
<![endif]-->
|
|
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
|
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<div id="main">
|
|
|
|
<h1 class="page-title">Source: schemas/user/userBanSchema.js</h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<article>
|
|
<pre class="prettyprint source linenums"><code>/*Canopy - The next generation of stoner streaming software
|
|
Copyright (C) 2024-2025 Rainbownapkin and the TTN Community
|
|
|
|
This program is free software: you can redistribute it and/or modify
|
|
it under the terms of the GNU Affero General Public License as
|
|
published by the Free Software Foundation, either version 3 of the
|
|
License, or (at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU Affero General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Affero General Public License
|
|
along with this program. If not, see <https://www.gnu.org/licenses/>.*/
|
|
|
|
//NPM Imports
|
|
const {mongoose} = require('mongoose');
|
|
|
|
//Local Imports
|
|
const hashUtil = require('../../utils/hashUtils.js');
|
|
const {userModel} = require('./userSchema.js');
|
|
const loggerUtils = require('../../utils/loggerUtils.js');
|
|
|
|
/**
|
|
* DB Schema for Documents representing a single user's ban
|
|
*/
|
|
const userBanSchema = new mongoose.Schema({
|
|
user: {
|
|
type: mongoose.SchemaTypes.ObjectID,
|
|
ref: "user"
|
|
},
|
|
ips: {
|
|
plaintext: {
|
|
type: [mongoose.SchemaTypes.String],
|
|
required: false
|
|
},
|
|
hashed: {
|
|
type: [mongoose.SchemaTypes.String],
|
|
required: false
|
|
}
|
|
},
|
|
alts: [{
|
|
type: mongoose.SchemaTypes.ObjectID,
|
|
ref: "user"
|
|
}],
|
|
deletedNames: {
|
|
type: [mongoose.SchemaTypes.String],
|
|
required: false
|
|
},
|
|
banDate: {
|
|
|
|
type: mongoose.SchemaTypes.Date,
|
|
required: true,
|
|
default: new Date()
|
|
},
|
|
expirationDays: {
|
|
type: mongoose.SchemaTypes.Number,
|
|
required: true,
|
|
default: 30
|
|
},
|
|
//If true, then expiration date deletes associated accounts instead of deleting the ban record
|
|
permanent: {
|
|
type: mongoose.SchemaTypes.Boolean,
|
|
required: true,
|
|
default: false
|
|
}
|
|
});
|
|
|
|
/**
|
|
* Checks ban by IP
|
|
* @param {String} ip - IP Address check for bans
|
|
* @returns {Mongoose.Document} Found ban Document if one exists.
|
|
*/
|
|
userBanSchema.statics.checkBanByIP = async function(ip){
|
|
//Get hash of ip
|
|
const ipHash = hashUtil.hashIP(ip);
|
|
//Get all bans
|
|
const banDB = await this.find({});
|
|
//Create null variable to hold any found ban
|
|
let foundBan = null;
|
|
|
|
//For every ban
|
|
for(ban of banDB){
|
|
//Create empty list to hold unmatched hashes in the advent that we match one
|
|
let tempHashes = [];
|
|
//Create flag to throw to save tempHashes in the advent that we have matches we dont want to save as hashes
|
|
let saveBan = false;
|
|
|
|
|
|
//For every plaintext IP in the ban
|
|
for(ipIndex in ban.ips.plaintext){
|
|
//Get the current ip
|
|
const curIP = ban.ips.plaintext[ipIndex];
|
|
|
|
//Check the current IP against the given ip
|
|
if(ip == curIP){
|
|
//If it matches we found the ban
|
|
foundBan = ban;
|
|
}
|
|
}
|
|
|
|
//For every hashed IP in the ban
|
|
for(ipIndex in ban.ips.hashed){
|
|
//Get the current ip hash
|
|
const curHash = ban.ips.hashed[ipIndex];
|
|
|
|
//Check the current hash against the given hash
|
|
if(ipHash == curHash){
|
|
//If it matches we found the ban
|
|
foundBan = ban;
|
|
|
|
//Push the match to plaintext IPs so we know who the fucker is
|
|
ban.ips.plaintext.push(ip);
|
|
|
|
//Throw the save ban flag to save the ban
|
|
saveBan = true;
|
|
//Otherwise
|
|
}else{
|
|
//Keep the hash since it hasn't been matched yet
|
|
tempHashes.push(curHash);
|
|
}
|
|
}
|
|
|
|
//If we matched a hashed ip and we need to save it as plaintext
|
|
if(saveBan){
|
|
//Keep unmatched hashes
|
|
ban.ips.hashed = tempHashes;
|
|
|
|
//Save the current ban
|
|
await ban.save();
|
|
}
|
|
}
|
|
|
|
return foundBan;
|
|
}
|
|
|
|
/**
|
|
* Checks for bans by user DB doc
|
|
* @param {Mongoose.Document} userDB - User Doc to check
|
|
* @returns {Mongoose.Document} Found ban document for given user doc
|
|
*/
|
|
userBanSchema.statics.checkBanByUserDoc = async function(userDB){
|
|
const banDB = await this.find({});
|
|
var foundBan = null;
|
|
|
|
banDB.forEach((ban) => {
|
|
if(ban.user != null){
|
|
//if we found a match
|
|
if(ban.user.toString() == userDB._id.toString()){
|
|
//Set found ban
|
|
foundBan = ban;
|
|
}
|
|
|
|
//For each banned alt
|
|
for(altIndex in ban.alts){
|
|
//get current alt
|
|
const alt = ban.alts[altIndex];
|
|
|
|
//if the alt matches our user
|
|
if(alt._id.toString() == userDB._id.toString()){
|
|
//Set found ban
|
|
foundBan = ban;
|
|
}
|
|
}
|
|
}
|
|
});
|
|
|
|
return foundBan;
|
|
}
|
|
|
|
/**
|
|
* Checks for ban by username
|
|
* @param {String} user - User to check for bans
|
|
* @returns {Mongoose.Document} Found User Ban DB Document
|
|
*/
|
|
userBanSchema.statics.checkBan = async function(user){
|
|
const userDB = await userModel.findOne({user: user.user});
|
|
return this.checkBanByUserDoc(userDB);
|
|
}
|
|
|
|
/**
|
|
* Looks through processed bans by user
|
|
* @param {String} user - user to check against for bans
|
|
* @returns {Mongoose.Document} Spent User Ban Document
|
|
*/
|
|
userBanSchema.statics.checkProcessedBans = async function(user){
|
|
//Pull banlist and create empty variable to hold any found ban
|
|
const banDB = await this.find({});
|
|
var foundBan = null;
|
|
|
|
//For each ban in list
|
|
banDB.forEach((ban)=>{
|
|
//For each deleted account associated with the ban
|
|
ban.deletedNames.forEach((name)=>{
|
|
//If the banned name equals the name we're checking against
|
|
if(name == user){
|
|
//We've found our ban
|
|
foundBan = ban;
|
|
}
|
|
})
|
|
});
|
|
|
|
//Return any found associated ban
|
|
return foundBan;
|
|
}
|
|
|
|
/**
|
|
* Bans a given user by their user Document
|
|
* @param {Mongoose.Document} userDB - DB Doc of the user to ban
|
|
* @param {Boolean} permanent - Whether or not it's permanant
|
|
* @param {Number} expirationDays - Days to expire
|
|
* @param {Boolean} ipBan - Whether or not we're banning by IP
|
|
* @returns {Mongoose.Document} A freshly created User Ban DB Document :)
|
|
*/
|
|
userBanSchema.statics.banByUserDoc = async function(userDB, permanent, expirationDays, ipBan = false){
|
|
//Prevent missing users
|
|
if(userDB == null){
|
|
throw loggerUtils.exceptionSmith("User not found", "validation");
|
|
}
|
|
|
|
//Ensure the user isn't already banned
|
|
if(await this.checkBanByUserDoc(userDB) != null){
|
|
throw loggerUtils.exceptionSmith("User already banned", "validation");
|
|
}
|
|
|
|
//Verify time to expire/delete depending on action
|
|
if(expirationDays < 0){
|
|
throw loggerUtils.exceptionSmith("Expiration Days must be a positive integer!", "validation");
|
|
}else if(expirationDays < 30 && permanent){
|
|
throw loggerUtils.exceptionSmith("Permanent bans must be given at least 30 days before automatic account deletion!", "validation");
|
|
}else if(expirationDays > 185){
|
|
throw loggerUtils.exceptionSmith("Expiration/Deletion date cannot be longer than half a year out from the original ban date.", "validation");
|
|
}
|
|
|
|
await banSessions(userDB);
|
|
|
|
//Add the ban to the database
|
|
const banDB = await this.create({user: userDB._id, permanent, expirationDays});
|
|
|
|
//If we're banning the users IP
|
|
if(ipBan){
|
|
//Scrape IP's from current user into the ban record
|
|
await scrapeUserIPs(userDB);
|
|
|
|
//Populate the users alts
|
|
await userDB.populate('alts');
|
|
|
|
//For each of the users alts
|
|
for(altIndex in userDB.alts){
|
|
//Add the current alt to the ban record
|
|
banDB.alts.push(userDB.alts[altIndex]._id);
|
|
|
|
//Scrape out the IPs from the current alt into the ban record
|
|
await scrapeUserIPs(userDB.alts[altIndex]);
|
|
|
|
//Kill all of alts sessions
|
|
await banSessions(userDB.alts[altIndex]);
|
|
}
|
|
|
|
//Save commited IP information to the ban record
|
|
await banDB.save();
|
|
|
|
async function scrapeUserIPs(curRecord){
|
|
//For each hashed ip on record for this user
|
|
for(hashIndex in curRecord.recentIPs){
|
|
//Look for any occurance of the current hash
|
|
const foundHash = banDB.ips.hashed.indexOf(curRecord.recentIPs[hashIndex].ipHash);
|
|
|
|
//If its not listed in the ban record
|
|
if(foundHash == -1){
|
|
//Add it to the list of hashed IPs for this ban
|
|
banDB.ips.hashed.push(curRecord.recentIPs[hashIndex].ipHash);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
//return the ban record
|
|
return banDB;
|
|
|
|
async function banSessions(user){
|
|
//Log the user out
|
|
if(permanent){
|
|
await user.killAllSessions(`Your account has been permanently banned, and will be nuked from the database in ${expirationDays} day(s).`);
|
|
}else{
|
|
await user.killAllSessions(`Your account has been temporarily banned, and will be reinstated in: ${expirationDays} day(s).`);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Bans user by username
|
|
* @param {String} user - Username of user to ban
|
|
* @param {Boolean} permanent - Whether or not it's permanant
|
|
* @param {Number} expirationDays - Days to expire
|
|
* @param {Boolean} ipBan - Whether or not we're banning by IP
|
|
* @returns {Mongoose.Document} A freshly created User Ban DB Document :)
|
|
*/
|
|
userBanSchema.statics.ban = async function(user, permanent, expirationDays, ipBan){
|
|
const userDB = await userModel.findOne({user: user.user});
|
|
return this.banByUserDoc(userDB, permanent, expirationDays, ipBan);
|
|
}
|
|
|
|
/**
|
|
* Unbans users by user doc
|
|
* @param {Mongoose.Document} userDB - User DB Document to unban
|
|
* @returns {Mongoose.Document} Old, deleted ban document
|
|
*/
|
|
userBanSchema.statics.unbanByUserDoc = async function(userDB){
|
|
|
|
//Prevent missing users
|
|
if(userDB == null){
|
|
throw loggerUtils.exceptionSmith("User not found", "validation");
|
|
}
|
|
|
|
const banDB = await this.checkBanByUserDoc(userDB);
|
|
|
|
if(!banDB){
|
|
throw loggerUtils.exceptionSmith("User already un-banned", "validation");
|
|
}
|
|
|
|
//Use _id in-case mongoose wants to be a cunt
|
|
var oldBan = await this.deleteOne({_id: banDB._id});
|
|
return oldBan;
|
|
}
|
|
|
|
/**
|
|
* Unban deleted user
|
|
* Can't bring back accounts, but will re-allow re-use of old usernames, and new accounts/connections from banned IP's
|
|
* @param {String} user - Username of deleted account to unban
|
|
* @returns {Mongoose.Document} Old, deleted ban document
|
|
*/
|
|
userBanSchema.statics.unbanDeleted = async function(user){
|
|
const banDB = await this.checkProcessedBans(user);
|
|
|
|
if(!banDB){
|
|
throw loggerUtils.exceptionSmith("User already un-banned", "validation");
|
|
}
|
|
|
|
const oldBan = await this.deleteOne({_id: banDB._id});
|
|
return oldBan;
|
|
}
|
|
|
|
/**
|
|
* Unbans user by username
|
|
* @param {String} user - Username of user to unban
|
|
* @returns Old, deleted ban document
|
|
*/
|
|
userBanSchema.statics.unban = async function(user){
|
|
//Find user in DB
|
|
const userDB = await userModel.findOne({user: user.user});
|
|
|
|
//If user was deleted
|
|
if(userDB == null){
|
|
//unban deleted user
|
|
return await this.unbanDeleted(user.user);
|
|
}else{
|
|
//unban by user doc
|
|
return await this.unbanByUserDoc(userDB);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Generates Network-Friendly Browser-Digestable list of bans for the admin panel
|
|
* @returns {Object} Network-Friendly Browser-Digestable list of bans for the admin panel
|
|
*/
|
|
userBanSchema.statics.getBans = async function(){
|
|
//Get the ban, populating users and alts
|
|
const banDB = await this.find({}).populate('user').populate('alts');
|
|
//Create an empty array to hold ban records
|
|
var bans = [];
|
|
|
|
banDB.forEach((ban) => {
|
|
//Create array to hold alts
|
|
var alts = [];
|
|
//Calculate expiration date
|
|
var expirationDate = new Date(ban.banDate);
|
|
expirationDate.setDate(expirationDate.getDate() + ban.expirationDays);
|
|
|
|
//Make sure we're not about to read the properties of a null object
|
|
if(ban.user != null){
|
|
var userObj = ban.user.getProfile();
|
|
}
|
|
|
|
|
|
//For each alt in the ban
|
|
for(alt of ban.alts){
|
|
//Get the profile and push it to the alt list
|
|
alts.push(alt.getProfile());
|
|
}
|
|
|
|
//Create ban object
|
|
const banObj = {
|
|
banDate: ban.banDate,
|
|
expirationDays: ban.expirationDays,
|
|
expirationDate: expirationDate,
|
|
daysUntilExpiration: ban.getDaysUntilExpiration(),
|
|
user: userObj,
|
|
ips: ban.ips,
|
|
alts,
|
|
deletedNames: ban.deletedNames,
|
|
permanent: ban.permanent
|
|
}
|
|
|
|
//Add it to the array
|
|
bans.push(banObj);
|
|
});
|
|
|
|
//Return the array
|
|
return bans;
|
|
}
|
|
|
|
/**
|
|
* Scheduable function for processing expired user bans
|
|
*/
|
|
userBanSchema.statics.processExpiredBans = async function(){
|
|
//Channel ban expirations may vary so there's no way to search for expired bans
|
|
const banDB = await this.find({});
|
|
|
|
//Firem all off all at once seperately without waiting for one another
|
|
for(let banIndex in banDB){
|
|
//Pull ban from banlist by index
|
|
const ban = banDB[banIndex];
|
|
|
|
//This ban was already processed, and it's user has been deleted. There is no more to be done...
|
|
if(ban.user == null){
|
|
return;
|
|
}
|
|
|
|
//If the ban hasn't been processed and it's got 0 or less days to go
|
|
if(ban.getDaysUntilExpiration() <= 0){
|
|
//If the ban is permanent
|
|
if(ban.permanent){
|
|
//Populate the user and alt fields
|
|
await ban.populate('user');
|
|
await ban.populate('alts');
|
|
//Add the name to our deleted names list
|
|
ban.deletedNames.push(ban.user.user);
|
|
//Hey hey hey, goodbye!
|
|
await userModel.deleteOne({_id: ban.user._id});
|
|
//Empty out the reference
|
|
ban.user = null;
|
|
|
|
//For every alt
|
|
for(alt of ban.alts){
|
|
//Add the alts name to the deleted names list
|
|
ban.deletedNames.push(alt.user);
|
|
//Motherfuckin' Kablewie!
|
|
await userModel.deleteOne({_id: alt._id});
|
|
}
|
|
|
|
//Clear out the alts array
|
|
ban.alts = [];
|
|
|
|
//Save the ban
|
|
await ban.save();
|
|
}else{
|
|
//Otherwise, delete the ban and let our user back in :P
|
|
await this.deleteOne({_id: ban._id});
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
//methods
|
|
/**
|
|
* Calculates days until ban expiration
|
|
* @returns {Number} Days until ban expiration
|
|
*/
|
|
userBanSchema.methods.getDaysUntilExpiration = function(){
|
|
//Get ban date
|
|
const expirationDate = new Date(this.banDate);
|
|
//Get expiration days and calculate expiration date
|
|
expirationDate.setDate(expirationDate.getDate() + this.expirationDays);
|
|
//Calculate and return days until ban expiration
|
|
return ((expirationDate - new Date()) / (1000 * 60 * 60 * 24)).toFixed(1);
|
|
}
|
|
|
|
module.exports = mongoose.model("userBan", userBanSchema);</code></pre>
|
|
</article>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<nav>
|
|
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="activeChannel.html">activeChannel</a></li><li><a href="channelManager.html">channelManager</a></li><li><a href="chat.html">chat</a></li><li><a href="chatBuffer.html">chatBuffer</a></li><li><a href="chatHandler.html">chatHandler</a></li><li><a href="commandPreprocessor.html">commandPreprocessor</a></li><li><a href="commandProcessor.html">commandProcessor</a></li><li><a href="connectedUser.html">connectedUser</a></li><li><a href="media.html">media</a></li><li><a href="playlistHandler.html">playlistHandler</a></li><li><a href="queue.html">queue</a></li><li><a href="queuedMedia.html">queuedMedia</a></li><li><a href="tokebot.html">tokebot</a></li></ul><h3>Global</h3><ul><li><a href="global.html#authenticateSession">authenticateSession</a></li><li><a href="global.html#cache">cache</a></li><li><a href="global.html#channelBanSchema">channelBanSchema</a></li><li><a href="global.html#channelPermissionSchema">channelPermissionSchema</a></li><li><a href="global.html#channelSchema">channelSchema</a></li><li><a href="global.html#chatSchema">chatSchema</a></li><li><a href="global.html#comparePassword">comparePassword</a></li><li><a href="global.html#consoleWarn">consoleWarn</a></li><li><a href="global.html#daysToExpire">daysToExpire</a></li><li><a href="global.html#emailChangeSchema">emailChangeSchema</a></li><li><a href="global.html#emoteSchema">emoteSchema</a></li><li><a href="global.html#errorHandler">errorHandler</a></li><li><a href="global.html#errorMiddleware">errorMiddleware</a></li><li><a href="global.html#escapeRegex">escapeRegex</a></li><li><a href="global.html#exceptionHandler">exceptionHandler</a></li><li><a href="global.html#exceptionSmith">exceptionSmith</a></li><li><a href="global.html#failedAttempts">failedAttempts</a></li><li><a href="global.html#fetchMetadata">fetchMetadata</a></li><li><a href="global.html#fetchVideoMetadata">fetchVideoMetadata</a></li><li><a href="global.html#fetchYoutubeMetadata">fetchYoutubeMetadata</a></li><li><a href="global.html#fetchYoutubePlaylistMetadata">fetchYoutubePlaylistMetadata</a></li><li><a href="global.html#flairSchema">flairSchema</a></li><li><a href="global.html#genCaptcha">genCaptcha</a></li><li><a href="global.html#getLoginAttempts">getLoginAttempts</a></li><li><a href="global.html#getMediaType">getMediaType</a></li><li><a href="global.html#hashIP">hashIP</a></li><li><a href="global.html#hashPassword">hashPassword</a></li><li><a href="global.html#kickoff">kickoff</a></li><li><a href="global.html#killSession">killSession</a></li><li><a href="global.html#lifetime">lifetime</a></li><li><a href="global.html#localExceptionHandler">localExceptionHandler</a></li><li><a href="global.html#mailem">mailem</a></li><li><a href="global.html#markLink">markLink</a></li><li><a href="global.html#maxAttempts">maxAttempts</a></li><li><a href="global.html#mediaSchema">mediaSchema</a></li><li><a href="global.html#passwordResetSchema">passwordResetSchema</a></li><li><a href="global.html#permissionSchema">permissionSchema</a></li><li><a href="global.html#playlistMediaProperties">playlistMediaProperties</a></li><li><a href="global.html#playlistSchema">playlistSchema</a></li><li><a href="global.html#processExpiredAttempts">processExpiredAttempts</a></li><li><a href="global.html#queuedProperties">queuedProperties</a></li><li><a href="global.html#rankEnum">rankEnum</a></li><li><a href="global.html#refreshRawLink">refreshRawLink</a></li><li><a href="global.html#schedule">schedule</a></li><li><a href="global.html#securityCheck">securityCheck</a></li><li><a href="global.html#sendAddressVerification">sendAddressVerification</a></li><li><a href="global.html#socketCriticalExceptionHandler">socketCriticalExceptionHandler</a></li><li><a href="global.html#socketErrorHandler">socketErrorHandler</a></li><li><a href="global.html#socketExceptionHandler">socketExceptionHandler</a></li><li><a href="global.html#spent">spent</a></li><li><a href="global.html#statSchema">statSchema</a></li><li><a href="global.html#throttleAttempts">throttleAttempts</a></li><li><a href="global.html#tokeCommandSchema">tokeCommandSchema</a></li><li><a href="global.html#transporter">transporter</a></li><li><a href="global.html#typeEnum">typeEnum</a></li><li><a href="global.html#userBanSchema">userBanSchema</a></li><li><a href="global.html#userSchema">userSchema</a></li><li><a href="global.html#verify">verify</a></li><li><a href="global.html#yankMedia">yankMedia</a></li><li><a href="global.html#ytdlpFetch">ytdlpFetch</a></li></ul>
|
|
</nav>
|
|
|
|
<br class="clear">
|
|
|
|
<footer>
|
|
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.4</a> on Fri Sep 05 2025 05:52:24 GMT-0400 (Eastern Daylight Time)
|
|
</footer>
|
|
|
|
<script> prettyPrint(); </script>
|
|
<script src="scripts/linenumber.js"> </script>
|
|
</body>
|
|
</html>
|