250 lines
12 KiB
HTML
250 lines
12 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>JSDoc: Source: schemas/statSchema.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: schemas/statSchema.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 {mongoose} = require('mongoose');
|
|
|
|
//Local Imports
|
|
const config = require('./../../config.json');
|
|
|
|
/**
|
|
* DB Schema for single document for keeping track of server stats
|
|
*/
|
|
const statSchema = new mongoose.Schema({
|
|
//This does NOT handle deleted accounts/channels. Use userModel.estimatedDocumentCount() for number of active users.
|
|
userCount: {
|
|
type: mongoose.SchemaTypes.Number,
|
|
required: true,
|
|
default: 0
|
|
},
|
|
channelCount: {
|
|
type: mongoose.SchemaTypes.Number,
|
|
required: true,
|
|
default: 0
|
|
},
|
|
launchCount: {
|
|
type: mongoose.SchemaTypes.Number,
|
|
required: true,
|
|
default: 0
|
|
},
|
|
firstLaunch: {
|
|
type: mongoose.SchemaTypes.Date,
|
|
required: true,
|
|
default: new Date()
|
|
},
|
|
tokes: [{
|
|
toke: {
|
|
type: mongoose.SchemaTypes.Map,
|
|
required: true,
|
|
default: new Map()
|
|
},
|
|
date: {
|
|
type: mongoose.SchemaTypes.Date,
|
|
required: true,
|
|
default: new Date()
|
|
}
|
|
}]
|
|
});
|
|
|
|
//statics
|
|
/**
|
|
* Get's servers sole stat document from the DB
|
|
* @returns {Mongoose.Document} Server's sole statistics document
|
|
*/
|
|
statSchema.statics.getStats = async function(){
|
|
//Get the first document we find
|
|
var stats = await this.findOne({});
|
|
|
|
if(stats){
|
|
//If we found something then the statistics document exist and this is it,
|
|
//So long as no one else has fucked with the database it should be the only one. (is this forshadowing for a future bug?)
|
|
return stats;
|
|
}else{
|
|
//Otherwise this is the first launch of the install, say hello
|
|
console.log("First launch detected! Initializing statistics document in Database!");
|
|
|
|
//create and save the statistics document
|
|
stats = await this.create({});
|
|
await stats.save();
|
|
|
|
//live up to the name of the function
|
|
return stats;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Increments Lunach count upon server launch and prints out amount of launches since server initialization
|
|
*/
|
|
statSchema.statics.incrementLaunchCount = async function(){
|
|
//get our statistics document
|
|
const stats = await this.getStats();
|
|
|
|
//increment counter and save
|
|
stats.launchCount++;
|
|
stats.save();
|
|
|
|
//print bootup message to console.
|
|
console.log(`${config.instanceName}(Powered by Canopy) initialized. This server has booted ${stats.launchCount} time${stats.launchCount == 1 ? '' : 's'}.`)
|
|
console.log(`First booted on ${stats.firstLaunch}.`);
|
|
}
|
|
|
|
/**
|
|
* Increments user count upon new user registration
|
|
* @returns {Number} Number of users before count was incremented
|
|
*/
|
|
statSchema.statics.incrementUserCount = async function(){
|
|
//get our statistics document
|
|
const stats = await this.getStats();
|
|
//temporarily keep old count so we can return it for the users ID
|
|
const oldCount = stats.userCount;
|
|
|
|
//increment counter and save
|
|
stats.userCount++;
|
|
stats.save();
|
|
|
|
//return the count from beggining of function for user ID
|
|
return oldCount;
|
|
}
|
|
|
|
/**
|
|
* Increments channel count upon new channel registration
|
|
* @returns {Number} Number of channels before count was incremented
|
|
*/
|
|
statSchema.statics.incrementChannelCount = async function(){
|
|
//get our statistics document
|
|
const stats = await this.getStats();
|
|
//temporarily keep old count so we can return it for the channel ID
|
|
const oldCount = stats.channelCount;
|
|
|
|
//increment counter and save
|
|
stats.channelCount++;
|
|
stats.save();
|
|
|
|
//return the count from beggining of function for channel ID
|
|
return oldCount;
|
|
}
|
|
|
|
/**
|
|
* Tattoo's toke to the server statistics document
|
|
* @param {Map} toke - Tokemap handed down from Tokebot
|
|
*/
|
|
statSchema.statics.tattooToke = async function(toke){
|
|
//Get the statistics document
|
|
const stats = await this.getStats();
|
|
|
|
//Add the toke to the stat document
|
|
stats.tokes.push({toke});
|
|
|
|
//Save the stat document
|
|
await stats.save();
|
|
}
|
|
|
|
/**
|
|
* Gets toke count from statistics document
|
|
* @returns {Number} Number of tokes across the entire site
|
|
*/
|
|
statSchema.statics.getTokeCount = async function(){
|
|
//get stats doc
|
|
const stats = await this.getStats();
|
|
|
|
//return toke count
|
|
return stats.tokes.length;
|
|
}
|
|
|
|
/**
|
|
* Gets toke counts for each individual callout in a map
|
|
* @returns {Map} Map of toke counts for each individual callout registered to the server
|
|
*/
|
|
statSchema.statics.getTokeCommandCounts = async function(){
|
|
//get stats doc
|
|
const stats = await this.getStats()
|
|
//Create empty map to hold toke command counts
|
|
const count = new Map();
|
|
|
|
//for each toke
|
|
stats.tokes.forEach((toke) => {
|
|
//For each toke command called in the current toke
|
|
toke.toke.forEach((command) => {
|
|
//Get the current count for the current command
|
|
var curCount = count.get(command);
|
|
|
|
//if the current count is null
|
|
if(curCount == null){
|
|
//Set it to one
|
|
count.set(command, 1);
|
|
}else{
|
|
//Set it to ++curCount
|
|
count.set(command, ++curCount);
|
|
}
|
|
});
|
|
});
|
|
|
|
//return the toke command count
|
|
return count;
|
|
}
|
|
|
|
module.exports = mongoose.model("statistics", statSchema);</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 Thu Sep 04 2025 20:09:42 GMT-0400 (Eastern Daylight Time)
|
|
</footer>
|
|
|
|
<script> prettyPrint(); </script>
|
|
<script src="scripts/linenumber.js"> </script>
|
|
</body>
|
|
</html>
|