feat(option): add includeSeasonPackEpisodes

addresses the feature request for individual episodes in season packs being included/excluded in searches

cross-seed#488

fix(includeSeasonPackEpsiodes): added `--no-include-season-pack-episodes`

missed an option in cmd.ts, added for consistency

src/cmd.ts

@@ -137,11 +137,17 @@ function createCommandWithSharedOptions(name, description) {
 			"Include single-episode torrents in the search",
 			fallback(fileConfig.includeEpisodes, false)
 		)
+		.option(
+			"--include-season-pack-episodes",
+			"Include episodes from a season pack in the search",
+			fallback(fileConfig.includeSeasonPackEpisodes, false)
+		)
 		.option(
 			"--no-include-non-videos",
 			"Don't include torrents which contain non-videos"
 		)
 		.option("--no-include-episodes", "Don't include episode torrents")
+		.option("--no-include-season-pack-episodes", "Don't include episodes from a season pack")
 		.requiredOption(
 			"--fuzzy-size-threshold <decimal>",
 			"The size difference allowed to be considered a match.",

src/config.template.cjs

@@ -76,15 +76,25 @@ module.exports = {
 	outputDir: ".",
 
 	/**
+	 * 
+	 * To search for everything except individual episodes, use (includeEpisodes: false, includeSeasonPackEpisodes: false, includeNonVideos: true)
+	 * To search for all episodes, use (includeEpisodes: true, includeSeasonPackEpisodes: true, includeNonVideos: true)
+	 * To search for season pack episodes, but exclude single episode torrents, use (includeEpisodes: false, includeSeasonPackEpisodes: true, includeNonVideos: true)
+	 *
 	 * Whether to search for single episode torrents
 	 */
 	includeEpisodes: false,
 
+	/**
+	 * Whether to search for single episodes from a season pack during
+	 * data based searches.
+	 */
+	includeSeasonPackEpisodes: false,
+
 	/**
 	 * Include torrents which contain non-video files
-	 * This option does not override includeEpisodes.
-	 * To search for everything except episodes, use (includeEpisodes: false, includeNonVideos: true)
-	 * To search for everything including episodes, use (includeEpisodes: true, includeNonVideos: true)
+	 * This option does not override includeEpisodes or
+	 * includeSeasonPackEpisodes.
 	 */
 	includeNonVideos: false,
 

src/config.template.docker.cjs

@@ -80,15 +80,25 @@ module.exports = {
 	outputDir: "/cross-seeds",
 
 	/**
+	 * 
+	 * To search for everything except individual episodes, use (includeEpisodes: false, includeSeasonPackEpisodes: false, includeNonVideos: true)
+	 * To search for all episodes, use (includeEpisodes: true, includeSeasonPackEpisodes: true, includeNonVideos: true)
+	 * To search for season pack episodes, but exclude single episode torrents, use (includeEpisodes: false, includeSeasonPackEpisodes: true, includeNonVideos: true)
+	 *
 	 * Whether to search for single episode torrents
 	 */
 	includeEpisodes: false,
 
+	/**
+	 * Whether to search for single episodes from a season pack during
+	 * data based searches.
+	 */
+	includeSeasonPackEpisodes: false,
+
 	/**
 	 * Include torrents which contain non-video files
-	 * This option does not override includeEpisodes.
-	 * To search for everything except episodes, use (includeEpisodes: false, includeNonVideos: true)
-	 * To search for everything including episodes, use (includeEpisodes: true, includeNonVideos: true)
+	 * This option does not override includeEpisodes or
+	 * includeSeasonPackEpisodes.
 	 */
 	includeNonVideos: false,
 

src/configuration.ts

@@ -13,6 +13,7 @@ interface FileConfig {
 	configVersion?: number;
 	delay?: number;
 	includeEpisodes?: boolean;
+	includeSeasonPackEpisodes?: boolean;
 	outputDir?: string;
 	rtorrentRpcUrl?: string;
 	includeNonVideos?: boolean;

src/preFilter.ts

@@ -1,15 +1,16 @@
 import ms from "ms";
 import { extname } from "path";
-import { EP_REGEX, VIDEO_EXTENSIONS } from "./constants.js";
+import { EP_REGEX, SEASON_REGEX, VIDEO_EXTENSIONS } from "./constants.js";
 import { db } from "./db.js";
 import { getEnabledIndexers } from "./indexers.js";
 import { Label, logger } from "./logger.js";
 import { getRuntimeConfig } from "./runtimeConfig.js";
 import { Searchee } from "./searchee.js";
 import { humanReadable, nMsAgo } from "./utils.js";
+import path from "path";
 
 export function filterByContent(searchee: Searchee): boolean {
-	const { includeEpisodes, includeNonVideos } = getRuntimeConfig();
+	const { includeEpisodes, includeNonVideos, includeSeasonPackEpisodes } = getRuntimeConfig();
 
 	function logReason(reason): void {
 		logger.verbose({
@@ -18,14 +19,18 @@ export function filterByContent(searchee: Searchee): boolean {
 		});
 	}
 
-	const isSingleEpisodeTorrent =
-		searchee.files.length === 1 && EP_REGEX.test(searchee.files[0].name);
-
-	if (!includeEpisodes && isSingleEpisodeTorrent) {
+	const isSingleEpisodeTorrent = searchee.files.length === 1 && EP_REGEX.test(searchee.name); 
+	const isSeasonPack = typeof searchee.path !== 'undefined' ? SEASON_REGEX.test(path.dirname(searchee.path).split(path.sep).reverse()[0]): false;
+	
+	if (!includeEpisodes && isSingleEpisodeTorrent && !isSeasonPack) {
 		logReason("it is a single episode");
 		return false;
 	}
 
+	if (!includeSeasonPackEpisodes && (searchee.files.length === 1 && isSeasonPack)) {
+		logReason("it is a season pack episode");
+		return false;
+	}
 	const allFilesAreVideos = searchee.files.every((file) =>
 		VIDEO_EXTENSIONS.includes(extname(file.name))
 	);

src/runtimeConfig.ts

@@ -14,6 +14,7 @@ export interface RuntimeConfig {
 	torrentDir: string;
 	outputDir: string;
 	includeEpisodes: boolean;
+	includeSeasonPackEpisodes: boolean;
 	verbose: boolean;
 	includeNonVideos: boolean;
 	fuzzySizeThreshold: number;