164 lines
9.7 KiB
HTML
164 lines
9.7 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>JSDoc: Source: utils/media/internetArchiveUtils.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/internetArchiveUtils.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 Imports
|
|
const validator = require('validator');
|
|
|
|
//Local Imports
|
|
const media = require('../../app/channel/media/media.js');
|
|
const regexUtils = require('../regexUtils.js');
|
|
const loggerUtils = require('../loggerUtils.js')
|
|
|
|
/**
|
|
* Pulls metadate for a given archive.org item
|
|
* @param {String} fullID - Full path of the requested upload
|
|
* @param {String} title - Title to add to media object
|
|
* @returns {Array} Generated list of media objects from given upload path
|
|
*/
|
|
module.exports.fetchMetadata = async function(fullID, title){
|
|
//Split fullID by first slash
|
|
const [itemID, requestedPath] = decodeURIComponent(fullID).split(/\/(.*)/);
|
|
//Create empty list to hold media objects
|
|
const mediaList = [];
|
|
//Create empty variable to hold return data object
|
|
let data;
|
|
|
|
//Create metadata link from itemID
|
|
const metadataLink = `https://archive.org/metadata/${itemID}`;
|
|
|
|
//Fetch item metadata from the internet archive
|
|
const response = await fetch(metadataLink,
|
|
{
|
|
method: "GET"
|
|
}
|
|
);
|
|
|
|
//If we hit a snag
|
|
if(!response.ok){
|
|
//Scream and shout
|
|
const errorBody = await response.text();
|
|
throw loggerUtils.exceptionSmith(`Internet Archive Error '${response.status}': ${errorBody}`, "queue");
|
|
}
|
|
|
|
//Collect our metadata
|
|
const rawMetadata = await response.json();
|
|
|
|
//Filter out any in-compatible files
|
|
const compatibleFiles = rawMetadata.files.filter(compatibilityFilter);
|
|
|
|
|
|
//If we're requesting an empty path
|
|
if(requestedPath == '' || requestedPath == null){
|
|
//Return item metadata and compatible files
|
|
data = {
|
|
files: compatibleFiles,
|
|
metadata: rawMetadata.metadata
|
|
}
|
|
//Other wise
|
|
}else{
|
|
//Return item metadata and matching compatible files
|
|
data = {
|
|
//Filter files out that don't match requested path and return remaining list
|
|
files: compatibleFiles.filter(pathFilter),
|
|
metadata: rawMetadata.metadata
|
|
}
|
|
}
|
|
|
|
//for every compatible and relevant file returned from IA
|
|
for(let file of data.files){
|
|
//Split file path by directories
|
|
const path = file.name.split('/');
|
|
|
|
//pull filename from path and escape in-case someone put something nasty in there
|
|
const name = validator.escape(validator.trim(path[path.length - 1]));
|
|
|
|
//Construct link from pulled info
|
|
const link = `https://archive.org/download/${data.metadata.identifier}/${file.name}`;
|
|
|
|
//if we where handed a null title
|
|
if(title == null || title == ''){
|
|
//Create new media object from file info substituting filename for title
|
|
mediaList.push(new media(name, name, link, link, 'ia', Number(file.length)));
|
|
}else{
|
|
//Create new media object from file info
|
|
mediaList.push(new media(title, name, link, link, 'ia', Number(file.length)));
|
|
}
|
|
}
|
|
|
|
//return media object list
|
|
return mediaList;
|
|
|
|
function compatibilityFilter(file){
|
|
//return true for all files that match for web-safe formats
|
|
return file.format == "h.264 IA" || file.format == "h.264" || file.format == "Ogg Video" || file.format.match("MPEG4");
|
|
}
|
|
|
|
function pathFilter(file){
|
|
//return true for all file names which match the given requested file path
|
|
return file.name.match(`^${regexUtils.escapeRegex(requestedPath)}`);
|
|
}
|
|
}</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 Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
|
|
</footer>
|
|
|
|
<script> prettyPrint(); </script>
|
|
<script src="scripts/linenumber.js"> </script>
|
|
</body>
|
|
</html>
|