237 lines
13 KiB
HTML
237 lines
13 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>JSDoc: Source: utils/loggerUtils.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: utils/loggerUtils.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/>.*/
|
|
|
|
//Node
|
|
const fs = require('node:fs/promises');
|
|
|
|
//Config
|
|
const config = require('../../config.json');
|
|
|
|
/**
|
|
* Creates and returns a custom exception, tagged as a 'custom' exception, using the 'custom' boolean property.
|
|
* This is used to denote that this error was generated on purpose, with a human readable message, that can be securely sent to the client.
|
|
* Unexpected exceptions should only be logged internally, however, as they may contain sensitive data.
|
|
*
|
|
* @param {String} msg - Error message to send the client
|
|
* @param {String} type - Error type to send back to the client
|
|
* @returns {Error} The exception to smith
|
|
*/
|
|
module.exports.exceptionSmith = function(msg, type){
|
|
//Create the new error with the given message
|
|
const exception = new Error(msg);
|
|
|
|
//Set the error type
|
|
exception.type = type;
|
|
|
|
//Mark the error as a custom error
|
|
exception.custom = true;
|
|
|
|
//Return the error
|
|
return exception;
|
|
}
|
|
|
|
/**
|
|
* Main error handling function
|
|
* @param {Express.Response} res - Response being sent out to the client who caused the issue
|
|
* @param {String} msg - Error message to send the client
|
|
* @param {String} type - Error type to send back to the client
|
|
* @param {Number} status - HTTP(s) Status Code to send back to the client
|
|
* @returns {Express.Response} If we have a usable Express Response object, return it back after it's been cashed
|
|
*/
|
|
module.exports.errorHandler = function(res, msg, type = "Generic", status = 400){
|
|
//Some controllers do things after sending headers, for those, we should remain silent
|
|
if(!res.headersSent){
|
|
res.status(status);
|
|
return res.send({errors: [{type, msg, date: new Date()}]});
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Handles local exceptions which where not directly created by user interaction
|
|
* @param {Error} err - Exception to handle
|
|
*/
|
|
module.exports.localExceptionHandler = function(err){
|
|
//If we're being verbose
|
|
if(config.verbose){
|
|
//Log the error
|
|
module.exports.dumpError(err);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Handles exceptions which where directly the fault of user action >:(
|
|
* @param {Express.Response} res - Express Response object to bitch at
|
|
* @param {Error} err - Error created by the jerk in question
|
|
*/
|
|
module.exports.exceptionHandler = function(res, err){
|
|
//If this is a self-made problem
|
|
if(err.custom){
|
|
module.exports.errorHandler(res, err.message, err.type);
|
|
}else{
|
|
//Locally handle the exception
|
|
module.exports.localExceptionHandler(err);
|
|
|
|
//if not yell at the browser for fucking up, and tell it what it did wrong.
|
|
module.exports.errorHandler(res, "An unexpected server crash was just prevented. You should probably report this to an admin.", "Caught Exception");
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Basic error-handling for socket.io so we don't just silently swallow errors.
|
|
* @param {Socket} socket - Socket error originated from
|
|
* @param {String} msg - Error message to send the client
|
|
* @param {String} type - Error type to send back to the client
|
|
* @returns {Boolean} - Passthrough from socket.emit
|
|
*/
|
|
module.exports.socketErrorHandler = function(socket, msg, type = "Generic"){
|
|
return socket.emit("error", {errors: [{type, msg, date: new Date()}]});
|
|
}
|
|
|
|
/**
|
|
* Generates error messages for simple errors generated by socket.io interaction
|
|
* @param {Socket} socket - Socket error originated from
|
|
* @param {Error} err - Error created by the jerk in question
|
|
* @returns {Boolean} - Passthrough from socket.emit
|
|
*/
|
|
module.exports.socketExceptionHandler = function(socket, err){
|
|
//If this is a self made problem
|
|
if(err.custom){
|
|
//yell at the browser for fucking up, and tell it what it did wrong.
|
|
return module.exports.socketErrorHandler(socket, err.message, err.type);
|
|
}else{
|
|
//Locally handle the exception
|
|
module.exports.localExceptionHandler(err);
|
|
|
|
//if not yell at the browser for fucking up
|
|
return module.exports.socketErrorHandler(socket, "An unexpected server crash was just prevented. You should probably report this to an admin.", "Server");
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Generates error messages and drops connection for critical errors caused by socket.io interaction
|
|
* @param {Socket} socket - Socket error originated from
|
|
* @param {Error} err - Error created by the jerk in question
|
|
* @returns {Boolean} - Passthrough from socket.disconnect
|
|
*/
|
|
module.exports.socketCriticalExceptionHandler = function(socket, err){
|
|
//If this is a self made problem
|
|
if(err.custom){
|
|
//yell at the browser for fucking up, and tell it what it did wrong.
|
|
socket.emit("kick", {type: "Disconnected", reason: `Server Error: ${err.message}`});
|
|
}else{
|
|
//Locally handle the exception
|
|
module.exports.localExceptionHandler(err);
|
|
|
|
//yell at the browser for fucking up
|
|
socket.emit("kick", {type: "Disconnected", reason: "An unexpected server crash was just prevented. You should probably report this to an admin."});
|
|
}
|
|
return socket.disconnect();
|
|
}
|
|
|
|
/**
|
|
* Prints warning text to server console
|
|
* @param {String} string - String to print to console
|
|
*/
|
|
module.exports.consoleWarn = function(string){
|
|
console.warn('\x1b[31m\x1b[4m%s\x1b[0m',string);
|
|
}
|
|
|
|
/**
|
|
* Basic error-handling middleware to ensure we're not dumping stack traces to the client, as that would be insecure
|
|
* @param {Error} err - Error to handle
|
|
* @param {Express.Request} req - Express Request
|
|
* @param {Express.Response} res - Express Response
|
|
* @param {Function} next - Next function in the Express middleware chain (Not that it's getting called XP)
|
|
*/
|
|
module.exports.errorMiddleware = function(err, req, res, next){
|
|
//Set generic error
|
|
var reason = "Server Error";
|
|
|
|
//If it's un-authorized
|
|
if(err.status == 403){
|
|
reason = "Unauthorized"
|
|
}
|
|
|
|
module.exports.errorHandler(res, err.message, reason, err.status);
|
|
}
|
|
|
|
/**
|
|
* Dumps unexpected server crashes to dedicated log files
|
|
* @param {Error} err - error to dump to file
|
|
* @param {Date} date - Date of error, defaults to now
|
|
*/
|
|
module.exports.dumpError = function(err, date = new Date()){
|
|
try{
|
|
const content = `Error Date: ${date.toLocaleString()} (UTC-${date.getTimezoneOffset()/60})\nError Type: ${err.name}\nError Msg:${err.message}\nStack Trace:\n\n${err.stack}`;
|
|
|
|
fs.writeFile(`log/crash/${date.getTime()}.log`, content);
|
|
}catch(doubleErr){
|
|
module.exports.consoleWarn("Yo Dawg, I herd you like errors, so I put an error in your error dump, so you can dump while you dump:");
|
|
module.exports.consoleWarn(err);
|
|
module.exports.consoleWarn(doubleErr);
|
|
}
|
|
}</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 10:33:47 GMT-0400 (Eastern Daylight Time)
|
|
</footer>
|
|
|
|
<script> prettyPrint(); </script>
|
|
<script src="scripts/linenumber.js"> </script>
|
|
</body>
|
|
</html>
|