203 lines
12 KiB
HTML
203 lines
12 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>JSDoc: Source: utils/media/yanker.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/media/yanker.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 url = require("node:url");
|
|
const validator = require('validator');//No express here, so regular validator it is!
|
|
|
|
//local import
|
|
const iaUtil = require('./internetArchiveUtils');
|
|
const ytdlpUtil = require('./ytdlpUtils');
|
|
|
|
/**
|
|
* Checks a given URL and runs the proper metadata fetching function to create a media object from any supported URL
|
|
* @param {String} url - URL to yank media against
|
|
* @param {String} title - Title to apply to yanked media
|
|
* @returns {Array} Returns list of yanked media objects on success
|
|
*/
|
|
module.exports.yankMedia = async function(url, title){
|
|
//Get pull type
|
|
const pullType = await this.getMediaType(url);
|
|
|
|
//Check pull type
|
|
switch(pullType.type){
|
|
case "ia":
|
|
//return media object list from IA module
|
|
return await iaUtil.fetchMetadata(pullType.id, title);
|
|
case "yt":
|
|
//return media object list from the YT-DLP module's youtube function
|
|
return await ytdlpUtil.fetchYoutubeMetadata(pullType.id, title);
|
|
case "ytp":
|
|
//return media object list from YT-DLP module's youtube playlist function
|
|
//return await ytdlpUtil.fetchYoutubePlaylistMetadata(pullType.id, title);
|
|
//Holding off on this since YT-DLP takes 10 years to do a playlist as it needs to pull each and every video one-by-one
|
|
//Maybe in the future a piped alternative might be in order, however this would most likely require us to host our own local instance.
|
|
//Though it could give us added resistance against youtube/google's rolling IP bans
|
|
return null;
|
|
case "dm":
|
|
//return mediao object list from the YT-DLP module's dailymotion function
|
|
return await ytdlpUtil.fetchDailymotionMetadata(pullType.id, title);
|
|
default:
|
|
//return null to signify a bad url
|
|
return null;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Refreshes raw links on relevant media objects
|
|
*
|
|
* Useful for sources like youtube, who only provide expiring raw links
|
|
* @param {ScheduledMedia} mediaObj - Media Object to refresh
|
|
* @returns {ScheduledMedia} Refreshed media object
|
|
*/
|
|
module.exports.refreshRawLink = async function(mediaObj){
|
|
switch(mediaObj.type){
|
|
case 'yt':
|
|
//Scrape expiration from query strings
|
|
const expires = mediaObj.rawLink.match(/expire=([0-9]+)/);
|
|
//Went with regex for speed, but I figure I'd keep this around in case we want the accuracy of a battle-tested implementation
|
|
//const expires = new URL(mediaObj.rawLink).searchParams.get("expire");
|
|
|
|
//If we have a valid raw file link that will be good by the end of the video
|
|
if(expires != null && (expires * 1000) > mediaObj.getEndTime()){
|
|
//Return null to tell the calling function there is no refresh required for this video at this time
|
|
return null;
|
|
}
|
|
|
|
//Re-fetch media metadata
|
|
metadata = await ytdlpUtil.fetchYoutubeMetadata(mediaObj.id);
|
|
//Refresh media rawlink from metadata
|
|
mediaObj.rawLink = metadata[0].rawLink;
|
|
|
|
//return media object
|
|
return mediaObj;
|
|
}
|
|
|
|
//Return null to tell the calling function there is no refresh required for this media type
|
|
return null;
|
|
}
|
|
/**
|
|
* Detects media type by URL
|
|
*
|
|
* I'd be lying if this didn't take at least some inspiration/regex patterns from extractQueryParam() in cytube/forest's browser-side 'util.js'
|
|
* Still this has some improvements like url pre-checks and the fact that it's handled serverside, recuing possibility of bad requests.
|
|
* Some of the regex expressions for certain services have also been improved, such as youtube, and the fore.st-unique archive.org
|
|
*
|
|
* @param {String} url - URL to determine media type of
|
|
* @returns {Object} containing URL type and clipped ID string
|
|
*/
|
|
module.exports.getMediaType = async function(url){
|
|
//Check if we have a valid url, encode it on the fly in case it's too humie-friendly
|
|
if(!validator.isURL(encodeURI(url))){
|
|
//If not toss the fucker out
|
|
return {
|
|
type: null,
|
|
id: null
|
|
}
|
|
}
|
|
|
|
//If we have link to a resource from archive.org
|
|
if(match = url.match(/archive\.org\/(?:details|download)\/([a-zA-Z0-9\/._-\s\%]+)/)){
|
|
//return internet archive upload id and filepath
|
|
return {
|
|
type: "ia",
|
|
id: match[1]
|
|
}
|
|
}
|
|
|
|
//If we have a match to a youtube video
|
|
if((match = url.match(/youtube\.com\/watch\?v=([a-zA-Z0-9_-]{11})/)) || (match = url.match(/youtu\.be\/([a-zA-Z0-9_-]{11})/))){
|
|
//return youtube video id
|
|
return {
|
|
type: "yt",
|
|
id: match[1]
|
|
}
|
|
}
|
|
|
|
//If we have a match to a youtube playlist
|
|
if((match = url.match(/youtube\.com\/playlist\?list=([a-zA-Z0-9_-]{34})/)) || (match = url.match(/youtu\.be\/playlist\?list=([a-zA-Z0-9_-]{34})/))){
|
|
//return youtube playlist id
|
|
return {
|
|
type: "ytp",
|
|
id: match[1]
|
|
}
|
|
}
|
|
|
|
//If we have a match to a dailymotion video
|
|
if(match = url.match(/dailymotion\.com\/video\/([a-zA-Z0-9]+)/)){
|
|
return {
|
|
type: "dm",
|
|
id: match[1]
|
|
}
|
|
}
|
|
|
|
//If we fell through all of our media types without a match
|
|
return{
|
|
type: null,
|
|
id: null
|
|
}
|
|
}</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>
|