283 lines
15 KiB
HTML
283 lines
15 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>JSDoc: Source: app/channel/tokebot.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: app/channel/tokebot.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/>.*/
|
|
|
|
//Local Imports
|
|
const tokeCommandModel = require('../../schemas/tokebot/tokeCommandSchema');
|
|
const {userModel} = require('../../schemas/user/userSchema');
|
|
const statSchema = require('../../schemas/statSchema');
|
|
|
|
|
|
/**
|
|
* Class containing global server-side tokebot logic
|
|
*/
|
|
class tokebot{
|
|
/**
|
|
* Instantiates a tokebot object
|
|
* @param {channelManager} server - Parent Server Object
|
|
* @param {chatHandler} chatHandler - Parent Chat Handler Object
|
|
*/
|
|
constructor(server, chatHandler){
|
|
//Set parents
|
|
this.server = server;
|
|
this.chatHandler = chatHandler;
|
|
|
|
//Set timeouts to null
|
|
this.tokeTimer = null;
|
|
this.cooldownTimer = null;
|
|
|
|
//Set start times
|
|
this.tokeTime = 60;
|
|
this.cooldownTime = 120;
|
|
|
|
//Create counter variable
|
|
this.tokeCounter = 0;
|
|
this.cooldownCounter = 0;
|
|
|
|
//Create tokers list
|
|
this.tokers = new Map();
|
|
|
|
//Load in toke commands from the DB
|
|
this.refreshCommands();
|
|
}
|
|
|
|
/**
|
|
* Reloads toke commands from DB into RAM-based toke command store
|
|
*/
|
|
async refreshCommands(){
|
|
//Pull Command Strings from DB
|
|
this.tokeCommands = await tokeCommandModel.getCommandStrings();
|
|
}
|
|
|
|
/**
|
|
* Processes toke commands from Command Pre-Processor
|
|
* @param {Object} commandObj - Object representing a single given command/chat request, passed down from the Command Pre-Processor
|
|
* @returns {Boolean} True if the toke is an invalid toke command (tells Command Pre-Processor to send command as chat)
|
|
*/
|
|
tokeProcessor(commandObj){
|
|
//Check for site-wide toke commands
|
|
if(this.tokeCommands.indexOf(commandObj.argumentArray[0].toLowerCase()) != -1){
|
|
//Seems lame to set a bool in an if statement but this would've made a really ugly turinary
|
|
var foundToke = true;
|
|
}else if(commandObj.argumentArray[0].toLowerCase() == 'r'){
|
|
//Find the users active channel
|
|
const activeChan = this.server.activeChannels.get(commandObj.socket.chan);
|
|
|
|
//Combile site-wide and channel tokes into one list
|
|
const tokeList = this.tokeCommands.concat(activeChan.tokeCommands);
|
|
|
|
//Pick a random number between 0 and one less than the number of tokes
|
|
const foundIndex = Math.round(Math.random() * (tokeList.length - 1));
|
|
|
|
//Set override command argument 0 w/ the found toke
|
|
commandObj.argumentArray[0] = tokeList[foundIndex];
|
|
|
|
//throw toke flag
|
|
var foundToke = true;
|
|
}else{
|
|
//Find the users active channel
|
|
const activeChan = this.server.activeChannels.get(commandObj.socket.chan);
|
|
|
|
//Check if they're using a channel-only toke
|
|
//This should be safe to do without a null check but someone prove me wrong lmao
|
|
var foundToke = (activeChan.tokeCommands.indexOf(commandObj.argumentArray[0].toLowerCase()) != -1);
|
|
}
|
|
|
|
|
|
//If we found a toke
|
|
if(foundToke){
|
|
//If there is no active toke or cooldown (new toke)
|
|
if(this.tokeTimer == null && this.cooldownTimer == null){
|
|
//Call-out toke start
|
|
this.chatHandler.relayTokeCallout(`A group toke has been started by ${commandObj.socket.user.user} from #${commandObj.socket.chan}! We'll be taking a toke in 60 seconds - join in by posting !${commandObj.argumentArray[0]}`);
|
|
//Set a full minute on our toke timer
|
|
this.tokeCounter = this.tokeTime;
|
|
|
|
//Add the toking user to the tokers map
|
|
this.tokers.set(commandObj.socket.user.user, commandObj.argumentArray[0].toLowerCase());
|
|
|
|
//kick-off the count-down
|
|
this.tokeTimer = setTimeout(this.countdown.bind(this), 1000)
|
|
//If the tokeTimer is popping but the cooldownTimer has fucked off (a toke is in progress)
|
|
}else if(this.cooldownTimer == null){
|
|
//look for user in tokers map
|
|
const foundToker = this.tokers.get(commandObj.socket.user.user);
|
|
|
|
//if the user has not yet joined the toke
|
|
if(foundToker == null){
|
|
//Call-out toke join
|
|
this.chatHandler.relayTokeCallout(`${commandObj.socket.user.user} has joined the toke from #${commandObj.socket.chan}! Post !${commandObj.argumentArray[0]} to take part!`);
|
|
|
|
//Add the toking user to the tokers map
|
|
this.tokers.set(commandObj.socket.user.user, commandObj.argumentArray[0].toLowerCase());
|
|
//If the user is already in the toke
|
|
}else{
|
|
//Tell them to fuck off
|
|
this.chatHandler.relayTokeWhisper(commandObj.socket, "You're already taking part in this toke!");
|
|
}
|
|
|
|
//Otherwise (there isn't a toke timer, but there is a cooldown timer. AKA: we're in cooldown)
|
|
}else{
|
|
//if the cooldownTimer exists (we're cooling down the toke)
|
|
this.chatHandler.relayTokeWhisper(commandObj.socket, `Please wait ${this.cooldownCounter} seconds before starting a new group toke.`);
|
|
}
|
|
|
|
//Toke command found, and there isn't any extra text, don't send as chat (re-create fore.st tokebot behaviour)
|
|
return (commandObj.command != `!${commandObj.argumentArray[0]}` && commandObj.command != '!r');
|
|
}else{
|
|
//No toke found, send it down the line, because shaming the user is funny
|
|
return true;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Called each second during the toke. Handles decrementing the timer variable, and countdown end logic.
|
|
*/
|
|
countdown(){
|
|
//If we're in the last three seconds
|
|
if(this.tokeCounter <= 3 && this.tokeCounter > 0){
|
|
//Callout the last three seconds
|
|
this.chatHandler.relayTokeCallout(`${this.tokeCounter}...`);
|
|
//if the toke is over
|
|
}else if(this.tokeCounter < 0){
|
|
//if we had multiple tokers
|
|
if(this.tokers.size > 1){
|
|
//call out the toke
|
|
this.chatHandler.relayTokeCallout(`Take a toke ${Array.from(this.tokers.keys()).join(', ')}! ${this.tokers.size} tokers!`);
|
|
//if we only had one toker
|
|
}else{
|
|
//call out the solo toke
|
|
this.chatHandler.relayTokeCallout(`Take a toke ${Array.from(this.tokers.keys())[0]}.`);
|
|
}
|
|
|
|
//Asynchronously tattoo the toke into the users documents within the database so that tokebot doesn't have to wait or worry about DB transactions
|
|
userModel.tattooToke(this.tokers);
|
|
//Do the same for the global stat schema
|
|
statSchema.tattooToke(this.tokers);
|
|
|
|
//Set the toke cooldown
|
|
this.cooldownCounter = this.cooldownTime;
|
|
this.cooldownTimer = setTimeout(this.cooldown.bind(this), 1000);
|
|
|
|
//Empty out the tokers array
|
|
this.tokers = new Map;
|
|
|
|
//Null out our timer
|
|
this.tokeTimer = null;
|
|
|
|
//return the function before it can continue
|
|
return;
|
|
}
|
|
|
|
//Decrement toke time
|
|
this.tokeCounter--;
|
|
//try again in another second
|
|
this.tokeTimer = setTimeout(this.countdown.bind(this), 1000)
|
|
}
|
|
|
|
/**
|
|
* This method seems to be a vestage from a bygone era. We should remove it after documenting shit.
|
|
* I would now, but I don't want to break shit in a comment-only commit.
|
|
*/
|
|
async asyncFinisher(){
|
|
//Grab a copy of the tokers map before it gets cleared out
|
|
const tokers = this.tokers;
|
|
|
|
//we need to wait for this so we don't send used tokes pre-maturely
|
|
await userModel.tattooToke(tokers);
|
|
}
|
|
|
|
/**
|
|
* Runs every second for 60 seconds after a toke
|
|
*/
|
|
cooldown(){
|
|
//If the cooldown timer isn't over
|
|
if(this.cooldownCounter > 0){
|
|
//Decrement toke time
|
|
this.cooldownCounter--;
|
|
//try again in another second
|
|
this.cooldownTimer = setTimeout(this.cooldown.bind(this), 1000);
|
|
//If the cooldown is over
|
|
}else{
|
|
//Null out the cooldown timer
|
|
this.cooldownTimer = null;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Resets toke cooldowns early upon authorized request
|
|
*/
|
|
resetToke(){
|
|
//Set cooldown to 0
|
|
this.cooldownCounter = 0;
|
|
|
|
//Null out the timer
|
|
this.cooldownTimer = null;
|
|
}
|
|
|
|
}
|
|
|
|
module.exports = tokebot;</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:55:07 GMT-0400 (Eastern Daylight Time)
|
|
</footer>
|
|
|
|
<script> prettyPrint(); </script>
|
|
<script src="scripts/linenumber.js"> </script>
|
|
</body>
|
|
</html>
|