376 lines
16 KiB
HTML
376 lines
16 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>JSDoc: Source: app/channel/connectedUser.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/connectedUser.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 config = require('../../../config.json');
|
|
const channelModel = require('../../schemas/channel/channelSchema');
|
|
const permissionModel = require('../../schemas/permissionSchema');
|
|
const flairModel = require('../../schemas/flairSchema');
|
|
const emoteModel = require('../../schemas/emoteSchema');
|
|
const { userModel } = require('../../schemas/user/userSchema');
|
|
|
|
/**
|
|
* Class representing a single user connected to a channel
|
|
*/
|
|
class connectedUser{
|
|
/**
|
|
* Instantiates a connectedUser object
|
|
* @param {Mongoose.Document} userDB - User document to re-hydrate user from
|
|
* @param {PemissionModel.chanRank} chanRank - Enum representing user channel rank
|
|
* @param {String} - Channel the user is connecting to
|
|
* @param {Socket} socket - Socket associated with the users connection
|
|
*/
|
|
constructor(userDB, chanRank, channel, socket){
|
|
/**
|
|
* User ID Number
|
|
*/
|
|
this.id = userDB.id;
|
|
|
|
/**
|
|
* User Name
|
|
*/
|
|
this.user = userDB.user;
|
|
|
|
/**
|
|
* User Rank
|
|
*/
|
|
this.rank = userDB.rank;
|
|
|
|
/**
|
|
* User High-Level
|
|
*/
|
|
this.highLevel = userDB.highLevel;
|
|
|
|
//Check to make sure users flair entry from DB is good
|
|
if(userDB.flair != null){
|
|
//Set flair from DB
|
|
/**
|
|
* User Flair
|
|
*/
|
|
this.flair = userDB.flair.name;
|
|
//Otherwise
|
|
}else{
|
|
//Gracefully default to classic
|
|
/**
|
|
* User Flair
|
|
*/
|
|
this.flair = 'classic';
|
|
}
|
|
|
|
/**
|
|
* User Channel-Rank
|
|
*/
|
|
this.chanRank = chanRank;
|
|
|
|
/**
|
|
* Connected Channel
|
|
*/
|
|
this.channel = channel;
|
|
|
|
/**
|
|
* List of active sockets to current channel
|
|
*/
|
|
this.sockets = [socket.id];
|
|
}
|
|
|
|
/**
|
|
* Handles server-side initialization for new connections from a specific user
|
|
* @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){
|
|
//send metadata to client
|
|
this.sendClientMetadata();
|
|
|
|
//Send out emotes
|
|
this.sendSiteEmotes();
|
|
this.sendChanEmotes(chanDB);
|
|
this.sendPersonalEmotes(userDB);
|
|
|
|
//Send out used tokes
|
|
this.sendUsedTokes(userDB);
|
|
|
|
//Send out the currently playing item
|
|
this.channel.queue.sendMedia(socket);
|
|
|
|
//If we're proxied
|
|
if(config.proxied){
|
|
//Tattoo hashed IP address from reverse proxy to user account for seven days
|
|
await userDB.tattooIPRecord(socket.handshake.headers['x-forwarded-for']);
|
|
}else{
|
|
//Tattoo hashed IP address to user account for seven days
|
|
await userDB.tattooIPRecord(socket.handshake.address);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Iterates through all known connections for a given user, running them through a supplied callback function
|
|
* @param {Function} cb - Callback to call against found sockets for a given user
|
|
*/
|
|
socketCrawl(cb){
|
|
//Crawl through user's sockets (lol)
|
|
this.sockets.forEach((sockid) => {
|
|
//get socket based on ID
|
|
const socket = this.channel.server.io.sockets.sockets.get(sockid);
|
|
//Callback with socket
|
|
cb(socket);
|
|
});
|
|
}
|
|
|
|
|
|
/**
|
|
* Emits an event to all known sockets for a given user
|
|
*
|
|
* My brain keeps going back to using dynamic per-user namespaces for this
|
|
* but everytime i look into it I come to the conclusion that it's a bad idea, then I toy with making chans namespaces
|
|
* and using per-user channels for this, but what of gold or mod-only features? or games?
|
|
* No matter what it'd probably end up hacky, as namespaces where meant for splitting app logic not user comms (like rooms).
|
|
* at the end of the day there has to be some penance for decent multi-session handling on-top of a library that doesn't do it.
|
|
* Having to crawl through these sockets is that. Because the other ways seem more gross somehow.
|
|
* @param {String} eventName - Event name to emit to client sockets
|
|
* @param {Object} data - Data to emit to client sockets
|
|
*/
|
|
emit(eventName, data){
|
|
this.socketCrawl((socket)=>{
|
|
//Ensure our socket is initialized
|
|
if(socket != null){
|
|
socket.emit(eventName, data);
|
|
}
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Disconnects all sockets for a given user
|
|
* @param {String} reason - Reason for being disconnected
|
|
* @param {String} type - Disconnection Type
|
|
*/
|
|
disconnect(reason, type = "Disconnected"){
|
|
this.emit("kick",{type, reason});
|
|
this.socketCrawl((socket)=>{socket.disconnect()});
|
|
}
|
|
|
|
//This is the big first push upon connection
|
|
//It should only fire once, so things that only need to be sent once can be slapped into here
|
|
/**
|
|
* Sends glut of required initial metadata to the client upon a new connection
|
|
* @param {Mongoose.Document} userDB - User Document Passthrough to save on DB Access
|
|
* @param {Mongoose.Document} chanDB - Channnel Document Passthrough to save on DB Access
|
|
*/
|
|
async sendClientMetadata(userDB, chanDB){
|
|
//Get flairList from DB and setup flairList array
|
|
const flairListDB = await flairModel.find({});
|
|
var flairList = [];
|
|
|
|
//if we wherent handed a user document
|
|
if(userDB == null){
|
|
//Pull it based on user name
|
|
userDB = await userModel.findOne({user: this.user});
|
|
}
|
|
|
|
//if we wherent handed a channel document
|
|
if(chanDB == null){
|
|
//Pull it based on channel name
|
|
chanDB = await channelModel.findOne({name: this.channel.name});
|
|
}
|
|
|
|
//If our perm map is un-initiated
|
|
//can't set this in constructor easily since it's asyncornous
|
|
//need to wait for it to complete before sending this off, but shouldnt re-do the wait for later connections
|
|
if(this.permMap == null){
|
|
//Grab perm map
|
|
this.permMap = await chanDB.getPermMapByUserDoc(userDB);
|
|
}
|
|
|
|
//Setup our userObj
|
|
const userObj = {
|
|
id: this.id,
|
|
user: this.user,
|
|
rank: this.rank,
|
|
chanRank: this.chanRank,
|
|
highLevel: this.highLevel,
|
|
permMap: {
|
|
site: Array.from(this.permMap.site),
|
|
chan: Array.from(this.permMap.chan),
|
|
},
|
|
flair: this.flair,
|
|
}
|
|
|
|
//For each flair listed in the Database
|
|
flairListDB.forEach((flair)=>{
|
|
//Check if the user has permission to use the current flair
|
|
if(permissionModel.rankToNum(flair.rank) <= permissionModel.rankToNum(this.rank)){
|
|
//If so push a light version of the flair object into our final flair list
|
|
flairList.push({
|
|
name: flair.name,
|
|
displayName: flair.displayName
|
|
});
|
|
}
|
|
});
|
|
|
|
//Get schedule as a temporary array
|
|
const queue = await this.channel.queue.prepQueue(chanDB);
|
|
|
|
//Get schedule lock status
|
|
const queueLock = this.channel.queue.locked;
|
|
|
|
//Get chat buffer
|
|
const chatBuffer = this.channel.chatBuffer.buffer;
|
|
|
|
//Send off the metadata to our user's clients
|
|
this.emit("clientMetadata", {user: userObj, flairList, queue, queueLock, chatBuffer});
|
|
}
|
|
|
|
/**
|
|
* Send copy of site emotes to the user
|
|
*/
|
|
async sendSiteEmotes(){
|
|
//Get emote list from DB
|
|
const emoteList = await emoteModel.getEmotes();
|
|
|
|
//Send it off to the user
|
|
this.emit('siteEmotes', emoteList);
|
|
}
|
|
|
|
/**
|
|
* Send copy of channel emotes to the user
|
|
* @param {Mongoose.Document} chanDB - Channnel Document Passthrough to save on DB Access
|
|
*/
|
|
async sendChanEmotes(chanDB){
|
|
//if we wherent handed a channel document
|
|
if(chanDB == null){
|
|
//Pull it based on channel name
|
|
chanDB = await channelModel.findOne({name: this.channel.name});
|
|
}
|
|
|
|
//Pull emotes from channel
|
|
const emoteList = chanDB.getEmotes();
|
|
|
|
//Send it off to the user
|
|
this.emit('chanEmotes', emoteList);
|
|
}
|
|
|
|
/**
|
|
* Send copy of channel emotes to the user
|
|
* @param {Mongoose.Document} userDB - User Document Passthrough to save on DB Access
|
|
*/
|
|
async sendPersonalEmotes(userDB){
|
|
//if we wherent handed a user document
|
|
if(userDB == null){
|
|
//Pull it based on user name
|
|
userDB = await userModel.findOne({user: this.user});
|
|
}
|
|
|
|
//Pull emotes from channel
|
|
const emoteList = userDB.getEmotes();
|
|
|
|
//Send it off to the user
|
|
this.emit('personalEmotes', emoteList);
|
|
}
|
|
|
|
/**
|
|
* Send copy of channel emotes to the user
|
|
* @param {Mongoose.Document} userDB - User Document Passthrough to save on DB Access
|
|
*/
|
|
async sendUsedTokes(userDB){
|
|
//if we wherent handed a user document
|
|
if(userDB == null){
|
|
//Pull it based on user name
|
|
userDB = await userModel.findOne({user: this.user});
|
|
}
|
|
|
|
//Create array of used toks from toke map and send it out to the user
|
|
this.emit('usedTokes',{
|
|
tokes: Array.from(userDB.tokes.keys())
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Set flair for a given user and broadcast update to clients
|
|
* @param {String} flair - Flair string to update user's flair to
|
|
*/
|
|
updateFlair(flair){
|
|
this.flair = flair;
|
|
|
|
this.channel.broadcastUserList();
|
|
this.sendClientMetadata();
|
|
}
|
|
|
|
/**
|
|
* Set high level for a given user and broadcast update to clients
|
|
* @param {Number} highLevel - Number to update user's high-level to
|
|
*/
|
|
updateHighLevel(highLevel){
|
|
this.highLevel = highLevel;
|
|
|
|
//TODO: show high-level in userlist
|
|
this.channel.broadcastUserList();
|
|
this.sendClientMetadata();
|
|
}
|
|
}
|
|
|
|
module.exports = connectedUser;</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>
|