podcast-dl 9.2.0 → 9.3.2

package/README.md

@@ -1,6 +1,6 @@
 # podcast-dl
 
-A CLI for downloading podcasts with a focus on archiving.
+A humble CLI for downloading and archiving podcasts.
 
 ## How to Use
 
@@ -20,11 +20,14 @@ A CLI for downloading podcasts with a focus on archiving.
 
 ## Options
 
+Either `--url` or `--file` must be provided.
+
 Type values surrounded in square brackets (`[]`) can be used as used as boolean options (no argument required).
 
 | Option                   | Type                | Required | Description                                                                                                                                                                                                                 |
 | ------------------------ | ------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| --url                    | String              | true     | URL to podcast RSS feed.                                                                                                                                                                                                    |
+| --url                    | String              | true\*   | URL to podcast RSS feed.                                                                                                                                                                                                    |
+| --file                   | String              | true\*   | Path to local RSS file.                                                                                                                                                                                                     |
 | --out-dir                | String              | false    | Specify output directory for episodes and metadata. Defaults to "./{{podcast_title}}". See "Template Options" for more details.                                                                                             |
 | --threads                | Number              | false    | Determines the number of downloads that will happen concurrently. Default is 1.                                                                                                                                             |
 | --attempts               | Number              | false    | Sets the number of download attempts per individual file. Default is 3.                                                                                                                                                     |
@@ -51,7 +54,6 @@ Type values surrounded in square brackets (`[]`) can be used as used as boolean
 | --exec                   | String              | false    | Execute a command after each episode is downloaded. See "Template Options" for more details.                                                                                                                                |
 | --parser-config          | String              | false    | Path to JSON file that will be parsed and used to override the default config passed to [rss-parser](https://github.com/rbren/rss-parser#xml-options).                                                                      |
 | --proxy                  |                     | false    | Enable proxy support. Specify environment variables listed by [global-agent](https://github.com/gajus/global-agent#environment-variables).                                                                                  |
-| --version                |                     | false    | Output the version number.                                                                                                                                                                                                  |
 | --help                   |                     | false    | Output usage information.                                                                                                                                                                                                   |
 
 ## Archive

package/bin/async.js

@@ -151,7 +151,7 @@ const download = async (options) => {
   }
 };
 
-let downloadItemsAsync = async ({
+const downloadItemsAsync = async ({
   addMp3MetadataFlag,
   archive,
   archiveUrl,

package/bin/bin.js

@@ -10,10 +10,11 @@ import { setupCommander } from "./commander.js";
 import { download } from "./async.js";
 import {
   getArchiveKey,
-  getFeed,
+  getFileFeed,
   getImageUrl,
   getItemsToDownload,
   getUrlExt,
+  getUrlFeed,
   logFeedInfo,
   logItemsList,
   writeFeedMeta,
@@ -31,6 +32,7 @@ import { downloadItemsAsync } from "./async.js";
 setupCommander(commander, process.argv);
 
 const {
+  file,
   url,
   outDir,
   episodeTemplate,
@@ -62,17 +64,24 @@ const {
 let { archive } = commander;
 
 const main = async () => {
-  if (!url) {
-    logErrorAndExit("No URL provided");
+  if (!url && !file) {
+    logErrorAndExit("No URL or file location provided");
+  }
+
+  if (url && file) {
+    logErrorAndExit("Must not use URL and file location");
   }
 
   if (proxy) {
     bootstrapProxy();
   }
 
-  const { hostname, pathname } = new URL(url);
+  const feed = url
+    ? await getUrlFeed(url, parserConfig)
+    : await getFileFeed(file, parserConfig);
+
+  const { hostname, pathname } = new URL(feed.feedUrl);
   const archiveUrl = `${hostname}${pathname}`;
-  const feed = await getFeed(url, parserConfig);
   const basePath = _path.resolve(
     process.cwd(),
     getFolderName({ feed, template: outDir })

package/bin/commander.js

@@ -4,8 +4,8 @@ import { logErrorAndExit } from "./logger.js";
 
 export const setupCommander = (commander, argv) => {
   commander
-    .version("9.2.0")
     .option("--url <string>", "url to podcast rss feed")
+    .option("--file <path>", "local path to podcast rss feed")
     .option(
       "--out-dir <path>",
       "specify output directory",

package/bin/logger.js

@@ -1,3 +1,5 @@
+/* eslint-disable no-console */
+
 const ERROR_STATUSES = {
   general: 1,
   nothingDownloaded: 2,

package/bin/util.js

@@ -9,6 +9,30 @@ import { logErrorAndExit, logMessage, LOG_LEVELS } from "./logger.js";
 import { getArchiveFilename, getItemFilename } from "./naming.js";
 
 const execWithPromise = util.promisify(exec);
+const isWin = process.platform === "win32";
+
+/*
+  Escape arguments for a shell command used with exec.
+  Borrowed from shell-escape: https://github.com/xxorax/node-shell-escape/
+  Additionally, @see https://www.robvanderwoude.com/escapechars.php for why
+    we avoid trying tp escape complex sequences in Windows.
+*/
+const escapeArgForShell = (arg) => {
+  let result = arg;
+
+  if (/[^A-Za-z0-9_/:=-]/.test(result)) {
+    if (isWin) {
+      return null;
+    } else {
+      result = "'" + result.replace(/'/g, "'\\''") + "'";
+      result = result
+        .replace(/^(?:'')+/g, "") // unduplicate single-quote at the beginning
+        .replace(/\\'''/g, "\\'"); // remove non-escaped single-quote if there are enclosed between 2 escaped
+    }
+  }
+
+  return result;
+};
 
 const getTempPath = (path) => {
   return `${path}.tmp`;
@@ -40,6 +64,22 @@ const getPublicObject = (object, exclude = []) => {
   return output;
 };
 
+const getFileString = (filePath) => {
+  const fullPath = path.resolve(process.cwd(), filePath);
+
+  if (!fs.existsSync(fullPath)) {
+    return null;
+  }
+
+  const data = fs.readFileSync(fullPath, "utf8");
+
+  if (!data) {
+    return null;
+  }
+
+  return data;
+};
+
 const getJsonFile = (filePath) => {
   const fullPath = path.resolve(process.cwd(), filePath);
 
@@ -268,10 +308,12 @@ const logItemsList = ({
   });
 
   if (isJson) {
+    // eslint-disable-next-line no-console
     console.log(JSON.stringify(output));
     return;
   }
 
+  // eslint-disable-next-line no-console
   console.table(output);
 };
 
@@ -353,16 +395,17 @@ const getUrlExt = (url) => {
 };
 
 const AUDIO_TYPES_TO_EXTS = {
-  "audio/mpeg": ".mp3",
-  "audio/mp3": ".mp3",
+  "audio/aac": ".aac",
   "audio/flac": ".flac",
+  "audio/mp3": ".mp3",
+  "audio/mp4": ".m4a",
+  "audio/mpeg": ".mp3",
   "audio/ogg": ".ogg",
+  "audio/opus": ".opus",
   "audio/vorbis": ".ogg",
-  "audio/mp4": ".m4a",
-  "audio/x-m4a": ".m4a",
   "audio/wav": ".wav",
+  "audio/x-m4a": ".m4a",
   "audio/x-wav": ".wav",
-  "audio/aac": ".aac",
   "video/mp4": ".mp4",
   "video/quicktime": ".mov",
   "video/x-m4v": ".m4v",
@@ -429,7 +472,31 @@ const getImageUrl = ({ image, itunes }) => {
   return null;
 };
 
-const getFeed = async (url, parserConfig) => {
+const getFileFeed = async (filePath, parserConfig) => {
+  const defaultConfig = {
+    defaultRSS: 2.0,
+  };
+
+  const config = parserConfig ? getJsonFile(parserConfig) : defaultConfig;
+  const rssString = getFileString(filePath);
+
+  if (parserConfig && !config) {
+    logErrorAndExit(`Unable to load parser config: ${parserConfig}`);
+  }
+
+  const parser = new rssParser(config);
+
+  let feed;
+  try {
+    feed = await parser.parseString(rssString);
+  } catch (err) {
+    logErrorAndExit("Unable to parse local RSS file", err);
+  }
+
+  return feed;
+};
+
+const getUrlFeed = async (url, parserConfig) => {
   const defaultConfig = {
     defaultRSS: 2.0,
   };
@@ -505,11 +572,15 @@ const runFfmpeg = async ({
     };
 
     const metadataString = Object.keys(metaKeysToValues)
-      .map((key) =>
-        metaKeysToValues[key]
-          ? `-metadata ${key}="${metaKeysToValues[key].replace(/"/g, '\\"')}"`
-          : null
-      )
+      .map((key) => {
+        if (!metaKeysToValues[key]) {
+          return null;
+        }
+
+        const argValue = escapeArgForShell(metaKeysToValues[key]);
+
+        return argValue ? `-metadata ${key}=${argValue}` : null;
+      })
       .filter((segment) => !!segment)
       .join(" ");
 
@@ -561,11 +632,12 @@ export {
   getArchiveKey,
   writeToArchive,
   getEpisodeAudioUrlAndExt,
-  getFeed,
+  getFileFeed,
   getImageUrl,
   getItemsToDownload,
   getTempPath,
   getUrlExt,
+  getUrlFeed,
   logFeedInfo,
   ITEM_LIST_FORMATS,
   logItemsList,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "podcast-dl",
-  "version": "9.2.0",
+  "version": "9.3.2",
   "description": "A CLI for downloading podcasts.",
   "type": "module",
   "bin": "./bin/bin.js",