podcast-dl 9.0.0 → 9.0.2

package/README.md

@@ -85,7 +85,7 @@ Options that support templates allow users to specify a template for the generat
 
 - `episode_path`: The path to the downloaded episode.
 - `episode_path_base`: The path to the folder of the downloaded episode.
-- `episode_filname`: The filename of the episode.
+- `episode_filename`: The filename of the episode.
 - `episode_filename_base`: The filename of the episode without its extension.
 
 ## Log Levels

package/bin/async.js

@@ -12,7 +12,7 @@ import {
   getLogMessageWithMarker,
   getShouldOutputProgressIndicator,
 } from "./logger.js";
-import { getArchiveFilename, getFilename } from "./naming.js";
+import { getArchiveFilename, getItemFilename } from "./naming.js";
 import {
   getEpisodeAudioUrlAndExt,
   getArchiveKey,
@@ -68,12 +68,9 @@ const download = async (options) => {
     }
   };
 
-  const expectedSize =
-    headResponse &&
-    headResponse.headers &&
-    headResponse.headers["content-length"]
-      ? parseInt(headResponse.headers["content-length"])
-      : 0;
+  const expectedSize = headResponse?.headers?.["content-length"]
+    ? parseInt(headResponse.headers["content-length"])
+    : 0;
 
   logMessage(
     `Starting download${
@@ -156,6 +153,7 @@ let downloadItemsAsync = async ({
   bitrate,
   episodeTemplate,
   episodeDigits,
+  episodeSourceOrder,
   exec,
   feed,
   includeEpisodeMeta,
@@ -173,7 +171,7 @@ let downloadItemsAsync = async ({
     const marker = threads > 1 ? `[${threadIndex}] ${item.title}` : item.title;
     const logMessage = getLogMessageWithMarker(marker);
     const { url: episodeAudioUrl, ext: audioFileExt } =
-      getEpisodeAudioUrlAndExt(item);
+      getEpisodeAudioUrlAndExt(item, episodeSourceOrder);
 
     if (!episodeAudioUrl) {
       hasErrors = true;
@@ -181,7 +179,7 @@ let downloadItemsAsync = async ({
       return;
     }
 
-    const episodeFilename = getFilename({
+    const episodeFilename = getItemFilename({
       item,
       feed,
       url: episodeAudioUrl,
@@ -259,7 +257,7 @@ let downloadItemsAsync = async ({
 
     if (includeEpisodeMeta) {
       const episodeMetaExt = ".meta.json";
-      const episodeMetaName = getFilename({
+      const episodeMetaName = getItemFilename({
         item,
         feed,
         url: episodeAudioUrl,

package/bin/bin.js

@@ -25,7 +25,7 @@ import {
   logError,
   logErrorAndExit,
 } from "./logger.js";
-import { getFolderName, getSafeName } from "./naming.js";
+import { getFolderName, getSimpleFilename } from "./naming.js";
 import { downloadItemsAsync } from "./async.js";
 
 setupCommander(commander, process.argv);
@@ -82,7 +82,7 @@ const main = async () => {
   }
 
   if (list) {
-    if (feed.items && feed.items.length) {
+    if (feed?.items?.length) {
       const listFormat = typeof list === "boolean" ? "table" : list;
       logItemsList({
         type: listFormat,
@@ -123,12 +123,12 @@ const main = async () => {
 
     if (podcastImageUrl) {
       const podcastImageFileExt = getUrlExt(podcastImageUrl);
-      const podcastImageName = `${
-        feed.title ? `${feed.title}.image` : "image"
-      }${podcastImageFileExt}`;
       const outputImagePath = _path.resolve(
         basePath,
-        getSafeName(podcastImageName)
+        getSimpleFilename(
+          feed.title ? feed.title : "image",
+          feed.title ? `.image${podcastImageFileExt}` : podcastImageFileExt
+        )
       );
 
       try {
@@ -137,7 +137,12 @@ const main = async () => {
           archive,
           override,
           marker: podcastImageUrl,
-          key: getArchiveKey({ prefix: archiveUrl, name: podcastImageName }),
+          key: getArchiveKey({
+            prefix: archiveUrl,
+            name: `${
+              feed.title ? `${feed.title}.image` : "image"
+            }${podcastImageFileExt}`,
+          }),
           outputPath: outputImagePath,
           url: podcastImageUrl,
           maxAttempts: attempts,
@@ -147,8 +152,13 @@ const main = async () => {
       }
     }
 
-    const outputMetaName = `${feed.title ? `${feed.title}.meta` : "meta"}.json`;
-    const outputMetaPath = _path.resolve(basePath, getSafeName(outputMetaName));
+    const outputMetaPath = _path.resolve(
+      basePath,
+      getSimpleFilename(
+        feed.title ? feed.title : "meta",
+        feed.title ? ".meta.json" : ".json"
+      )
+    );
 
     try {
       logMessage("\nSaving podcast metadata...");
@@ -156,7 +166,10 @@ const main = async () => {
         archive,
         override,
         feed,
-        key: getArchiveKey({ prefix: archiveUrl, name: outputMetaName }),
+        key: getArchiveKey({
+          prefix: archiveUrl,
+          name: `${feed.title ? `${feed.title}.meta` : "meta"}.json`,
+        }),
         outputPath: outputMetaPath,
       });
     } catch (error) {
@@ -206,6 +219,7 @@ const main = async () => {
     bitrate,
     episodeTemplate,
     episodeDigits,
+    episodeSourceOrder,
     exec,
     feed,
     includeEpisodeMeta,

package/bin/commander.js

@@ -4,7 +4,7 @@ import { logErrorAndExit } from "./logger.js";
 
 export const setupCommander = (commander, argv) => {
   commander
-    .version("9.0.0")
+    .version("9.0.2")
     .option("--url <string>", "url to podcast rss feed")
     .option(
       "--out-dir <path>",
@@ -41,7 +41,7 @@ export const setupCommander = (commander, argv) => {
 
         return parsed;
       },
-      "enclosure,link"
+      [AUDIO_ORDER_TYPES.enclosure, AUDIO_ORDER_TYPES.link]
     )
     .option("--include-meta", "write out podcast metadata to json")
     .option(

package/bin/naming.js

@@ -2,16 +2,22 @@ import filenamify from "filenamify";
 import dayjs from "dayjs";
 
 const INVALID_CHAR_REPLACE = "_";
-const MAX_LENGTH_FILENAME = 255;
+const MAX_LENGTH_FILENAME = process.env.MAX_LENGTH_FILENAME
+  ? parseInt(process.env.MAX_LENGTH_FILENAME)
+  : 255;
 
-const getSafeName = (name) => {
+const getSafeName = (name, maxLength = MAX_LENGTH_FILENAME) => {
   return filenamify(name, {
     replacement: INVALID_CHAR_REPLACE,
-    maxLength: MAX_LENGTH_FILENAME,
+    maxLength,
   });
 };
 
-const getFilename = ({ item, ext, url, feed, template, width }) => {
+const getSimpleFilename = (name, ext = "") => {
+  return `${getSafeName(name, MAX_LENGTH_FILENAME - (ext?.length ?? 0))}${ext}`;
+};
+
+const getItemFilename = ({ item, ext, url, feed, template, width }) => {
   const episodeNum = feed.items.length - item._originalIndex;
   const formattedPubDate = item.pubDate
     ? dayjs(new Date(item.pubDate)).format("YYYYMMDD")
@@ -24,7 +30,7 @@ const getFilename = ({ item, ext, url, feed, template, width }) => {
     ["url", url],
     ["podcast_title", feed.title || ""],
     ["podcast_link", feed.link || ""],
-    ["duration", (item.itunes && item.itunes.duration) || ""],
+    ["duration", item.itunes?.duration || ""],
   ];
 
   let name = template;
@@ -37,8 +43,7 @@ const getFilename = ({ item, ext, url, feed, template, width }) => {
       : name.replace(replaceRegex, "");
   });
 
-  name = `${name}${ext}`;
-  return getSafeName(name);
+  return getSimpleFilename(name, ext);
 };
 
 const getFolderName = ({ feed, template }) => {
@@ -70,4 +75,10 @@ const getArchiveFilename = ({ pubDate, name, ext }) => {
   return `${baseName}${ext}`;
 };
 
-export { getArchiveFilename, getFilename, getFolderName, getSafeName };
+export {
+  getArchiveFilename,
+  getFolderName,
+  getItemFilename,
+  getSafeName,
+  getSimpleFilename,
+};

package/bin/util.js

@@ -6,7 +6,7 @@ import util from "util";
 import { exec } from "child_process";
 
 import { logErrorAndExit, logMessage } from "./logger.js";
-import { getArchiveFilename, getFilename } from "./naming.js";
+import { getArchiveFilename, getItemFilename } from "./naming.js";
 
 const execWithPromise = util.promisify(exec);
 
@@ -185,7 +185,7 @@ const getItemsToDownload = ({
             }),
           });
 
-          const episodeImageName = getFilename({
+          const episodeImageName = getItemFilename({
             item,
             feed,
             url: episodeAudioUrl,
@@ -377,7 +377,7 @@ const AUDIO_ORDER_TYPES = {
 
 const getEpisodeAudioUrlAndExt = (
   { enclosure, link },
-  order = [AUDIO_ORDER_TYPES.link, AUDIO_ORDER_TYPES.enclosure]
+  order = [AUDIO_ORDER_TYPES.enclosure, AUDIO_ORDER_TYPES.link]
 ) => {
   for (const source of order) {
     if (source === AUDIO_ORDER_TYPES.link && link && getIsAudioUrl(link)) {
@@ -399,15 +399,15 @@ const getEpisodeAudioUrlAndExt = (
 };
 
 const getImageUrl = ({ image, itunes }) => {
-  if (image && image.url) {
+  if (image?.url) {
     return image.url;
   }
 
-  if (image && image.link) {
+  if (image?.link) {
     return image.link;
   }
 
-  if (itunes && itunes.image) {
+  if (itunes?.image) {
     return itunes.image;
   }
 
@@ -469,14 +469,12 @@ const runFfmpeg = async ({
   if (addMp3Metadata) {
     const album = feed.title || "";
     const title = item.title || "";
-    const artist =
-      item.itunes && item.itunes.author
-        ? item.itunes.author
-        : item.author || "";
-    const track =
-      item.itunes && item.itunes.episode
-        ? item.itunes.episode
-        : `${feed.items.length - itemIndex}`;
+    const artist = item?.itunes?.author
+      ? item.itunes.author
+      : item.author || "";
+    const track = item?.itunes?.episode
+      ? item.itunes.episode
+      : `${feed.items.length - itemIndex}`;
     const date = item.pubDate
       ? dayjs(new Date(item.pubDate)).format("YYYY-MM-DD")
       : "";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "podcast-dl",
-  "version": "9.0.0",
+  "version": "9.0.2",
   "description": "A CLI for downloading podcasts.",
   "type": "module",
   "bin": "./bin/bin.js",
@@ -51,7 +51,7 @@
     "command-exists": "^1.2.9",
     "commander": "^5.1.0",
     "dayjs": "^1.8.25",
-    "filenamify": "^4.1.0",
+    "filenamify": "^6.0.0",
     "global-agent": "^3.0.0",
     "got": "^11.0.2",
     "p-limit": "^4.0.0",