394 lines
18 KiB
HTML
394 lines
18 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>JSDoc: Source: app/channel/chatHandler.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/chatHandler.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 validator = require('validator')
|
|
|
|
//local imports
|
|
const commandPreprocessor = require('./commandPreprocessor');
|
|
const loggerUtils = require('../../utils/loggerUtils');
|
|
const linkUtils = require('../../utils/linkUtils');
|
|
const emoteValidator = require('../../validators/emoteValidator');
|
|
const chat = require('./chat');
|
|
const {userModel} = require('../../schemas/user/userSchema');
|
|
|
|
/**
|
|
* Class containing global server-side chat relay logic
|
|
*/
|
|
class chatHandler{
|
|
/**
|
|
* Instantiates a chatHandler object
|
|
* @param {channelManager} server - Parent Server Object
|
|
*/
|
|
constructor(server){
|
|
/**
|
|
* Parent Server Object
|
|
*/
|
|
this.server = server;
|
|
|
|
/**
|
|
* Child Command Pre-Processor Object
|
|
*/
|
|
this.commandPreprocessor = new commandPreprocessor(server, this)
|
|
|
|
/**
|
|
* Max chat buffer message count
|
|
*/
|
|
this.chatBufferSize = 50;
|
|
}
|
|
|
|
/**
|
|
* Defines global server-side chat relay event listeners
|
|
* @param {Socket} socket - Requesting Socket
|
|
*/
|
|
defineListeners(socket){
|
|
socket.on("chatMessage", (data) => {this.handleChat(socket, data)});
|
|
socket.on("setFlair", (data) => {this.setFlair(socket, data)});
|
|
socket.on("setHighLevel", (data) => {this.setHighLevel(socket, data)});
|
|
socket.on("addPersonalEmote", (data) => {this.addPersonalEmote(socket, data)});
|
|
socket.on("deletePersonalEmote", (data) => {this.deletePersonalEmote(socket, data)});
|
|
}
|
|
|
|
/**
|
|
* Handles incoming chat messages from client connections
|
|
* @param {Socket} socket - Socket we're receiving the request from
|
|
* @param {Object} data - Event payload
|
|
*/
|
|
handleChat(socket, data){
|
|
this.commandPreprocessor.preprocess(socket, data);
|
|
}
|
|
|
|
/**
|
|
* Handles incoming client request to change flair
|
|
* @param {Socket} socket - Socket we're receiving the request from
|
|
* @param {Object} data - Event payload
|
|
*/
|
|
async setFlair(socket, data){
|
|
var userDB = await userModel.findOne({user: socket.user.user});
|
|
|
|
if(userDB){
|
|
try{
|
|
//We can take this data raw since our schema checks it against existing flairs, and mongoose sanatizes queries
|
|
const flairDB = await userDB.setFlair(data.flair);
|
|
|
|
//Crawl through users active connections
|
|
this.server.crawlConnections(socket.user.user, (conn)=>{
|
|
//Update flair
|
|
conn.updateFlair(flairDB.name);
|
|
});
|
|
}catch(err){
|
|
return loggerUtils.socketExceptionHandler(socket, err);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Handles incoming client request to change high level
|
|
* @param {Socket} socket - Socket we're receiving the request from
|
|
* @param {Object} data - Event payload
|
|
*/
|
|
async setHighLevel(socket, data){
|
|
var userDB = await userModel.findOne({user: socket.user.user});
|
|
|
|
if(userDB){
|
|
try{
|
|
//Floor input to an integer and set high level
|
|
userDB.highLevel = Math.floor(data.highLevel);
|
|
//Save user DB Document
|
|
await userDB.save();
|
|
|
|
//GetConnects across all channels
|
|
const connections = this.server.getConnections(socket.user.user);
|
|
|
|
//For each connection
|
|
connections.forEach((conn) => {
|
|
conn.updateHighLevel(userDB.highLevel);
|
|
});
|
|
}catch(err){
|
|
return loggerUtils.socketExceptionHandler(socket, err);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Handles incoming client request to add a personal emote
|
|
* @param {Socket} socket - Socket we're receiving the request from
|
|
* @param {Object} data - Event payload
|
|
*/
|
|
async addPersonalEmote(socket, data){
|
|
//Sanatize and Validate input
|
|
const name = emoteValidator.manualName(data.name);
|
|
const link = emoteValidator.manualLink(data.link);
|
|
|
|
//If we received good input
|
|
if(link && name){
|
|
//Generate marked link object
|
|
var emote = await linkUtils.markLink(link);
|
|
|
|
//If the link we have is an image or video
|
|
if(emote.type == 'image' || emote.type == 'video'){
|
|
//Get user document from DB
|
|
const userDB = await userModel.findOne({user: socket.user.user})
|
|
|
|
//if we have a user in the DB
|
|
if(userDB != null){
|
|
//Convert marked link into emote object with 1 ez step for only $19.95
|
|
emote.name = name;
|
|
|
|
//add emote to user document emotes list
|
|
userDB.emotes.push(emote);
|
|
|
|
//Save user doc
|
|
await userDB.save();
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Handles incoming client request to delete a personal emote
|
|
* @param {Socket} socket - Socket we're receiving the request from
|
|
* @param {Object} data - Event payload
|
|
*/
|
|
async deletePersonalEmote(socket, data){
|
|
//Get user doc from DB based on socket
|
|
const userDB = await userModel.findOne({user: socket.user.user});
|
|
|
|
//if we found a user
|
|
if(userDB != null){
|
|
await userDB.deleteEmote(data.name);
|
|
}
|
|
}
|
|
|
|
//Base chat functions
|
|
/**
|
|
* Creates a new chatObject and relays the resulting message to the given channel
|
|
* @param {String} user - Originating user
|
|
* @param {String} flair - Flair ID to mark chat with
|
|
* @param {Number} highLevel - High Level to mark chat with
|
|
* @param {String} msg - Message Text Content
|
|
* @param {String} type - Message Type, used for client-side chat post-processing.
|
|
* @param {String} chan - Channel to broadcast message within
|
|
* @param {Array} links - Array of URLs/Links to hand to the client-side chat post-processor to inject into the final message.
|
|
*/
|
|
relayChat(user, flair, highLevel, msg, type = 'chat', chan, links){
|
|
this.relayChatObject(chan, new chat(user, flair, highLevel, msg, type, links));
|
|
}
|
|
|
|
/**
|
|
* Relays an existing chat object to a channel
|
|
* @param {String} chan - Channel to broadcast message within
|
|
* @param {chat} chat - Chat Object representing the message to broadcast to the given channel
|
|
*/
|
|
relayChatObject(chan, chat){
|
|
//Send out chat
|
|
this.server.io.in(chan).emit("chatMessage", chat);
|
|
|
|
const channel = this.server.activeChannels.get(chan);
|
|
|
|
//If chat buffer length is over mandated size
|
|
if(channel.chatBuffer.buffer.length >= this.chatBufferSize){
|
|
//Take out oldest chat
|
|
channel.chatBuffer.shift();
|
|
}
|
|
|
|
//Add buffer to chat
|
|
channel.chatBuffer.push(chat);
|
|
}
|
|
|
|
/**
|
|
* Creates a new chatObject and relays the resulting message to the given socket
|
|
* @param {Socket} socket - Socket we're sending a message to (sounds menacing, huh?)
|
|
* @param {String} user - Originating user
|
|
* @param {String} flair - Flair ID to mark chat with
|
|
* @param {Number} highLevel - High Level to mark chat with
|
|
* @param {String} msg - Message Text Content
|
|
* @param {String} type - Message Type, used for client-side chat post-processing.
|
|
* @param {String} chan - Channel to broadcast message within
|
|
* @param {Array} links - Array of URLs/Links to hand to the client-side chat post-processor to inject into the final message.
|
|
*/
|
|
relayPrivateChat(socket, user, flair, highLevel, msg, type, links){
|
|
this.relayPrivateChatObject(socket , new chat(user, flair, highLevel, msg, type, links));
|
|
}
|
|
|
|
/**
|
|
* Handles incoming client request to delete a personal emote
|
|
* @param {Socket} socket - Socket we're receiving the request from
|
|
* @param {Object} data - Event payload
|
|
*/
|
|
relayPrivateChatObject(socket, chat){
|
|
socket.emit("chatMessage", chat);
|
|
}
|
|
|
|
/**
|
|
* Creates a new chatObject and relays the resulting message to the entire server
|
|
* @param {String} user - Originating user
|
|
* @param {String} flair - Flair ID to mark chat with
|
|
* @param {Number} highLevel - High Level to mark chat with
|
|
* @param {String} msg - Message Text Content
|
|
* @param {String} type - Message Type, used for client-side chat post-processing.
|
|
* @param {Array} links - Array of URLs/Links to hand to the client-side chat post-processor to inject into the final message.
|
|
*/
|
|
relayGlobalChat(user, flair, highLevel, msg, type = 'chat', links){
|
|
this.relayGlobalChatObject(new chat(user, flair, highLevel, msg, type, links));
|
|
}
|
|
|
|
/**
|
|
* Relays an existing chat object to the entire server
|
|
* @param {chat} chat - Chat Object representing the message to broadcast throughout the server
|
|
*/
|
|
relayGlobalChatObject(chat){
|
|
this.server.io.emit("chatMessage", chat);
|
|
}
|
|
|
|
//User Chat Functions
|
|
/**
|
|
* Relays a chat message from a user to the rest of the channel based on socket
|
|
* @param {Socket} socket - Socket we're receiving the request from
|
|
* @param {String} msg - Message Text Content
|
|
* @param {String} type - Message Type, used for client-side chat post-processing.
|
|
* @param {Array} links - Array of URLs/Links to hand to the client-side chat post-processor to inject into the final message.
|
|
*/
|
|
relayUserChat(socket, msg, type, links){
|
|
const user = this.server.getSocketInfo(socket);
|
|
this.relayChat(user.user, user.flair, user.highLevel, msg, type, socket.chan, links);
|
|
}
|
|
|
|
//Toke Chat Functions
|
|
/**
|
|
* Broadcasts toke callout to the server
|
|
* @param {String} msg - Message Text Content
|
|
* @param {Array} links - Array of URLs/Links to hand to the client-side chat post-processor to inject into the final message.
|
|
*/
|
|
relayTokeCallout(msg, links){
|
|
this.relayGlobalChat("Tokebot", "", '∞', msg, "toke", links);
|
|
}
|
|
/**
|
|
* Broadcasts toke callout to the server
|
|
* @param {Socket} socket - Socket we're sending the whisper to
|
|
* @param {String} msg - Message Text Content
|
|
* @param {Array} links - Array of URLs/Links to hand to the client-side chat post-processor to inject into the final message.
|
|
*/
|
|
relayTokeWhisper(socket, msg, links){
|
|
this.relayPrivateChat(socket, "Tokebot", "", '∞', msg, "tokewhisper", links);
|
|
}
|
|
|
|
/**
|
|
* Broadcasts toke whisper to the server
|
|
* @param {String} msg - Message Text Content
|
|
* @param {Array} links - Array of URLs/Links to hand to the client-side chat post-processor to inject into the final message.
|
|
*/
|
|
relayGlobalTokeWhisper(msg, links){
|
|
this.relayGlobalChat("Tokebot", "", '∞', msg, "tokewhisper", links);
|
|
}
|
|
|
|
//Announcement Functions
|
|
/**
|
|
* Broadcasts announcement to the server
|
|
* @param {String} msg - Message Text Content
|
|
* @param {Array} links - Array of URLs/Links to hand to the client-side chat post-processor to inject into the final message.
|
|
*/
|
|
relayServerAnnouncement(msg, links){
|
|
this.relayGlobalChat("Server", "", '∞', msg, "announcement", links);
|
|
}
|
|
|
|
/**
|
|
* Broadcasts announcement to a given channel
|
|
* @param {String} msg - Message Text Content
|
|
* @param {Array} links - Array of URLs/Links to hand to the client-side chat post-processor to inject into the final message.
|
|
*/
|
|
relayChannelAnnouncement(chan, msg, links){
|
|
const activeChan = this.server.activeChannels.get(chan);
|
|
|
|
//If channel isn't null
|
|
if(activeChan != null){
|
|
this.relayChat("Channel", "", '∞', msg, "announcement", chan, links);
|
|
}
|
|
}
|
|
|
|
//Misc Functions
|
|
/**
|
|
* Clears chat for a given channel, targets specified user or entire channel if none found/specified.
|
|
* @param {String} user - User chats to clear
|
|
* @param {String} chan - Channel to broadcast message within
|
|
*/
|
|
clearChat(chan, user){
|
|
const activeChan = this.server.activeChannels.get(chan);
|
|
|
|
//If channel isn't null
|
|
if(activeChan != null){
|
|
const target = activeChan.userList.get(user);
|
|
|
|
//If no user was entered OR the user was found
|
|
if(user == null || target != null){
|
|
this.server.io.in(chan).emit("clearChat", {user});
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
module.exports = chatHandler;</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 Sat Sep 06 2025 00:30:24 GMT-0400 (Eastern Daylight Time)
|
|
</footer>
|
|
|
|
<script> prettyPrint(); </script>
|
|
<script src="scripts/linenumber.js"> </script>
|
|
</body>
|
|
</html>
|