206 lines
11 KiB
HTML
206 lines
11 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>JSDoc: Source: app/channel/activeChannel.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/activeChannel.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 connectedUser = require('./connectedUser');
|
|
const chatBuffer = require('./chatBuffer');
|
|
const queue = require('./media/queue');
|
|
const channelModel = require('../../schemas/channel/channelSchema');
|
|
const playlistHandler = require('./media/playlistHandler')
|
|
|
|
/**
|
|
* Class representing a single active channel
|
|
*/
|
|
class activeChannel{
|
|
|
|
/**
|
|
* Instantiates an activeChannel object
|
|
* @param {channelManager} server - Parent Server Object
|
|
* @param {Mongoose.Document} chanDB - chanDB to rehydrate buffer from
|
|
*/
|
|
constructor(server, chanDB){
|
|
this.server = server;
|
|
this.name = chanDB.name;
|
|
this.tokeCommands = chanDB.tokeCommands;
|
|
//Keeping these in a map was originally a vestige but it's more preformant than an array or object so :P
|
|
this.userList = new Map();
|
|
this.queue = new queue(server, chanDB, this);
|
|
this.playlistHandler = new playlistHandler(server, chanDB, this);
|
|
//Define the chat buffer
|
|
this.chatBuffer = new chatBuffer(server, chanDB, this);
|
|
}
|
|
|
|
|
|
/**
|
|
* Handles server-side initialization for new connections to the channel
|
|
* @param {Mongoose.Document} userDB - User Document Passthrough to save on DB Access
|
|
* @param {Mongoose.Document} chanDB - Channnel Document Passthrough to save on DB Access
|
|
* @param {Socket} socket - Requesting Socket
|
|
*/
|
|
async handleConnection(userDB, chanDB, socket){
|
|
//get current user object from the userlist
|
|
var userObj = this.userList.get(userDB.user);
|
|
//get channel rank for current user
|
|
const chanRank = await chanDB.getChannelRankByUserDoc(userDB);
|
|
|
|
//If user is already connected
|
|
if(userObj){
|
|
//Add this socket on to the userobject
|
|
userObj.sockets.push(socket.id);
|
|
//If the user is joining the channel
|
|
}else{
|
|
//Grab flair
|
|
await userDB.populate('flair');
|
|
//Set user object
|
|
userObj = new connectedUser(userDB, chanRank, this, socket);
|
|
}
|
|
|
|
//Set user entry in userlist
|
|
this.userList.set(userDB.user, userObj);
|
|
|
|
//if everything looks good, admit the connection to the channel
|
|
socket.join(socket.chan);
|
|
|
|
//Define per-channel event listeners
|
|
this.queue.defineListeners(socket);
|
|
this.playlistHandler.defineListeners(socket);
|
|
|
|
//Hand off the connection initiation to it's user object
|
|
await userObj.handleConnection(userDB, chanDB, socket)
|
|
|
|
//Send out the userlist
|
|
this.broadcastUserList(socket.chan);
|
|
}
|
|
|
|
/**
|
|
* Handles server-side initialization for disconnecting from the channel
|
|
* @param {Socket} socket - Requesting Socket
|
|
*/
|
|
handleDisconnect(socket){
|
|
//If we have more than one active connection
|
|
if(this.userList.get(socket.user.user).sockets.length > 1){
|
|
//temporarily store userObj
|
|
var userObj = this.userList.get(socket.user.user);
|
|
|
|
//Filter out disconnecting socket from socket list, and set as current socket list for user
|
|
userObj.sockets = userObj.sockets.filter((id) => {
|
|
return id != socket.id;
|
|
});
|
|
|
|
//Update the userlist
|
|
this.userList.set(socket.user.user, userObj);
|
|
}else{
|
|
//If this is the last connection for this user, remove them from the userlist
|
|
this.userList.delete(socket.user.user);
|
|
}
|
|
|
|
//and send out the filtered list
|
|
this.broadcastUserList(socket.chan);
|
|
}
|
|
|
|
/**
|
|
* Broadcasts user list to all users
|
|
*/
|
|
broadcastUserList(){
|
|
//Create a userlist object with the tokebot user pre-loaded
|
|
var userList = [{
|
|
user: "Tokebot",
|
|
flair: "classic",
|
|
highLevel: "∞",
|
|
}];
|
|
|
|
this.userList.forEach((userObj, user) => {
|
|
userList.push({
|
|
user: user,
|
|
flair: userObj.flair,
|
|
highLevel: userObj.highLevel
|
|
});
|
|
});
|
|
|
|
this.server.io.in(this.name).emit("userList", userList);
|
|
}
|
|
|
|
/**
|
|
* Broadcasts channel emote list to connected users
|
|
* @param {Mongoose.Document} chanDB - Channnel Document Passthrough to save on DB Access
|
|
*/
|
|
async broadcastChanEmotes(chanDB){
|
|
//if we wherent handed a channel document
|
|
if(chanDB == null){
|
|
//Pull it based on channel name
|
|
chanDB = await channelModel.findOne({name: this.name});
|
|
}
|
|
|
|
//Get emote list from channel document
|
|
const emoteList = chanDB.getEmotes();
|
|
|
|
//Broadcast that sumbitch
|
|
this.server.io.in(this.name).emit('chanEmotes', emoteList);
|
|
}
|
|
}
|
|
|
|
module.exports = activeChannel;</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>
|