210 lines
11 KiB
HTML
210 lines
11 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>JSDoc: Source: app/channel/chatBuffer.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/chatBuffer.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/>.*/
|
|
const config = require('../../../config.json');
|
|
const channelModel = require('../../schemas/channel/channelSchema');
|
|
|
|
/**
|
|
* Class representing a stored chat buffer
|
|
*/
|
|
class chatBuffer{
|
|
/**
|
|
* Instantiates a new chat buffer for a given channel
|
|
* @param {channelManager} server - Parent Server Object
|
|
* @param {Mongoose.Document} chanDB - chanDB to rehydrate buffer from
|
|
* @param {activeChannel} channel - Parent Channel Object
|
|
*/
|
|
constructor(server, chanDB, channel){
|
|
/**
|
|
* Parent Server Object
|
|
*/
|
|
this.server = server;
|
|
|
|
/**
|
|
* Parent CHannel Object
|
|
*/
|
|
this.channel = channel;
|
|
|
|
//If we have no chanDB.chatBuffer
|
|
if(chanDB == null || chanDB.chatBuffer == null){
|
|
/**
|
|
* RAM-Based buffer containing array of previous chats
|
|
*/
|
|
this.buffer = [];
|
|
//Otherwise
|
|
}else{
|
|
/**
|
|
* RAM-Based buffer containing array of previous chats
|
|
*/
|
|
this.buffer = chanDB.chatBuffer;
|
|
}
|
|
|
|
/**
|
|
* Inactivity Timer, goes off after x seconds of chat inactivity
|
|
*/
|
|
this.inactivityTimer = null;
|
|
|
|
/**
|
|
* Inactivity Timer Delay
|
|
*/
|
|
this.inactivityDelay = 10;
|
|
|
|
/**
|
|
* Goes off after x minutes of solid chatroom activity (no inactivityTimer call in x minutes)
|
|
*/
|
|
this.busyTimer = null;
|
|
|
|
/**
|
|
* Busy Timer Delay
|
|
*/
|
|
this.busyDelay = 5;
|
|
}
|
|
|
|
/**
|
|
* Adds a given chat to the chat buffer in RAM and sets any appropriate timers for DB transactions
|
|
* @param {chat} chat - Chat object to commit to buffer
|
|
*/
|
|
push(chat){
|
|
//push chat into RAM buffer
|
|
this.buffer.push(chat);
|
|
|
|
//clear existing inactivity timer
|
|
clearTimeout(this.inactivityTimer);
|
|
|
|
//reset inactivity timer
|
|
this.inactivityTimer = setTimeout(this.handleInactivity.bind(this), 1000 * this.inactivityDelay);
|
|
|
|
//If busy timer is unset
|
|
if(this.busyTimer == null){
|
|
this.busyTimer = setTimeout(this.handleBusyRoom.bind(this), 1000 * 60 * this.busyDelay);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Removes the oldest item from the chat buffer
|
|
*
|
|
* Was originally created in-case we needed to trigger timing functions
|
|
*
|
|
* Left here since it seems like good form anywho, since this would be a private, or at least protected member in another language
|
|
*/
|
|
shift(){
|
|
this.buffer.shift();
|
|
}
|
|
|
|
/**
|
|
* Called after 10 seconds of chat room inactivity
|
|
*/
|
|
handleInactivity(){
|
|
this.saveDB(`${this.inactivityDelay} seconds of inactivity.`);
|
|
}
|
|
|
|
/**
|
|
* Called after 5 minutes of solid activity
|
|
*/
|
|
handleBusyRoom(){
|
|
this.saveDB(`${this.busyDelay} minutes of activity.`);
|
|
}
|
|
|
|
/**
|
|
* Saves RAM-Based buffer to Channel Document in DB
|
|
* @param {String} reason - Reason for DB save, formatted as 'x minutes/seconds of in/activity', used for logging purposes
|
|
* @param {Mongoose.Document} chanDB - Channel Doc to work with, can be left empty for method to auto-find through channel name.
|
|
*/
|
|
async saveDB(reason, chanDB){
|
|
//clear existing timers
|
|
clearTimeout(this.inactivityTimer);
|
|
clearTimeout(this.busyTimer);
|
|
this.inactivityTimer = null;
|
|
this.busyTimer = null;
|
|
|
|
//if the server is in screamy boi mode
|
|
if(config.verbose){
|
|
//This should eventually be replaced by a per-channel logging feature that provides access to chan admins via web front-end
|
|
console.log(`Saving chat buffer to channel ${this.channel.name} after ${reason}.`);
|
|
}
|
|
|
|
|
|
//If we wheren't handed a channel
|
|
if(chanDB == null){
|
|
//Now that everything is clean, we can take our time with the DB :P
|
|
chanDB = await channelModel.findOne({name:this.channel.name});
|
|
}
|
|
|
|
//If we couldn't find the channel
|
|
if(chanDB == null){
|
|
//FUCK
|
|
throw loggerUtils.exceptionSmith(`Unable to find channel document ${this.channel.name} while saving chat buffer!`, "chat");
|
|
}
|
|
|
|
//Set chan doc buffer to RAM buffer
|
|
chanDB.chatBuffer = this.buffer;
|
|
|
|
//save chan doc to DB.
|
|
await chanDB.save();
|
|
}
|
|
}
|
|
|
|
module.exports = chatBuffer;</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#dumpError">dumpError</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 Sat Sep 06 2025 19:07:56 GMT-0400 (Eastern Daylight Time)
|
|
</footer>
|
|
|
|
<script> prettyPrint(); </script>
|
|
<script src="scripts/linenumber.js"> </script>
|
|
</body>
|
|
</html>
|