184 lines
9.4 KiB
HTML
184 lines
9.4 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>JSDoc: Source: schemas/channel/media/playlistSchema.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/channel/media/playlistSchema.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 playlistMediaSchema = require('./playlistMediaSchema');
|
|
|
|
/**
|
|
* DB Schema for Documents representing playlists full of media
|
|
*/
|
|
const playlistSchema = new mongoose.Schema({
|
|
name: {
|
|
type: mongoose.SchemaTypes.String,
|
|
required: true,
|
|
},
|
|
media: [playlistMediaSchema],
|
|
defaultTitles:[{
|
|
type: mongoose.SchemaTypes.String,
|
|
required: false,
|
|
default: []
|
|
}]
|
|
});
|
|
|
|
//methods
|
|
/**
|
|
* Dehydrate to minified flat network-friendly object
|
|
* @returns {Object} Network-Friendly Browser-Digestable object representing media from a playlist
|
|
*/
|
|
playlistSchema.methods.dehydrate = function(){
|
|
//Create empty array to hold media
|
|
const mediaArray = [];
|
|
|
|
//Fill media array
|
|
for(let media of this.media){
|
|
mediaArray.push(media.dehydrate());
|
|
}
|
|
|
|
//return dehydrated playlist
|
|
return {
|
|
name: this.name,
|
|
media: mediaArray,
|
|
defaultTitles: this.defaultTitles
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Add media to the given playlist Document
|
|
* @param {Array} mediaList - Array of media Objects to add to playlist
|
|
*/
|
|
playlistSchema.methods.addMedia = function(mediaList){
|
|
//For every piece of media in the list
|
|
for(let media of mediaList){
|
|
//Set media status schema discriminator
|
|
media.status = 'saved';
|
|
|
|
//Add the media to the playlist
|
|
this.media.push(media);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Gets Media from a playlist by UUID
|
|
* @param {String} uuid - UUID of media to pull
|
|
* @returns {media} media with matching UUID
|
|
*/
|
|
playlistSchema.methods.findMediaByUUID = function(uuid){
|
|
//For every piece of media in the current playlist
|
|
for(let media of this.media){
|
|
//If we found our match
|
|
if(media.uuid.toString() == uuid){
|
|
//return it
|
|
return media;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Deletes media from a given playlist
|
|
* @param {String} uuid - UUID of media to delete
|
|
*/
|
|
playlistSchema.methods.deleteMedia = function(uuid){
|
|
//Create new array to hold list of media to be kept
|
|
const keptMedia = [];
|
|
|
|
//For every piece of media in the current playlist
|
|
for(let media of this.media){
|
|
//It isn't the media to be deleted
|
|
if(media.uuid.toString() != uuid){
|
|
//Add it to the list to be kept
|
|
keptMedia.push(media);
|
|
}
|
|
}
|
|
|
|
//Set playlist media from keptMedia
|
|
this.media = keptMedia;
|
|
}
|
|
|
|
/**
|
|
* Pick title based on default title's list and media's given title
|
|
* @param {String} title - Title to use if there are no default titles.
|
|
* @returns {String} Chosen title based on result of function
|
|
*/
|
|
playlistSchema.methods.pickDefaultTitle = function(title){
|
|
//If we don't have default titles in this playlist
|
|
if(this.defaultTitles.length <= 0){
|
|
//If we wheren't handed an original title
|
|
if(title == null || title == ''){
|
|
return 'Unnamed Media'
|
|
}else{
|
|
return title;
|
|
}
|
|
}else{
|
|
//Grab a random default title and return it
|
|
return this.defaultTitles[Math.floor(Math.random() * this.defaultTitles.length)];
|
|
}
|
|
}
|
|
|
|
module.exports = playlistSchema;</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:55:07 GMT-0400 (Eastern Daylight Time)
|
|
</footer>
|
|
|
|
<script> prettyPrint(); </script>
|
|
<script src="scripts/linenumber.js"> </script>
|
|
</body>
|
|
</html>
|