qtorrent: add option to include images

Author: Esgrove

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "cli-tools"
-version = "9.9.0"
+version = "9.10.0"
 edition = "2024"
 authors = ["Esgrove <esgrove@outlook.com>"]
 description = "A collection of CLI utilities"

Cargo.toml

@@ -432,13 +432,15 @@ Options:
   -t, --tags <TAGS>          Tags for the torrent (comma-separated)
   -a, --paused               Add torrent in paused state
   -p, --dryrun               Print what would be done without actually adding torrents
-  -o, --offline              Offline mode: skip qBittorrent connection entirely (implies --dryrun)
+  -o, --offline              Offline mode: skip qBittorrent connection entirely (implies dryrun)
   -y, --yes                  Skip confirmation prompts
-  -e, --skip-ext <EXT>       File extensions to skip (e.g., nfo, txt, jpg)
+  -e, --skip-ext <EXT>       File extensions to skip (e.g., nfo, txt)
   -k, --skip-dir <NAME>      Directory names to skip (case-insensitive full name match)
   -m, --min-size <MB>        Minimum file size in MB (files smaller than this will be skipped)
+  -i, --include-images       Include image files (.jpg, .jpeg, .png)
+  -M, --min-image-size <KB>  Minimum image file size in KB
   -r, --recurse              Recurse into subdirectories when searching for torrent files
-  -x, --skip-existing        Skip rename prompts for existing/duplicate torrents
+  -x, --skip-existing        Skip rename prompts for existing torrents
   -v, --verbose              Print verbose output
   -h, --help                 Print help (see more with '--help')
   -V, --version              Print version

README.md

@@ -307,15 +307,22 @@ replace = [
 # Skip rename prompts for existing/duplicate torrents
 # skip_existing = false
 
+# Include image files (.jpg, .jpeg, .png) in multi-file torrents
+# include_images = false
+
 # File extensions to skip when selecting files from multi-file torrents (without dot)
-# skip_extensions = ["nfo", "txt", "jpg", "png", "sfv", "md5", "url"]
+# When include_images is false, keeping jpg/jpeg/png here matches the default behavior.
+# skip_extensions = ["nfo", "txt", "jpg", "jpeg", "png", "sfv", "md5", "url"]
 
 # Directory names to skip in multi-file torrents (case-insensitive full name match)
 # skip_directories = ["sample", "proof", "screens"]
 
-# Minimum file size in MB (files smaller than this will be skipped)
+# Minimum file size in MB for non-image files (0 disables size filtering)
 # min_file_size_mb = 10
 
+# Minimum image file size in KB when include_images is true (0 disables image size filtering)
+# min_image_size_kb = 0
+
 # Substrings to remove from torrent filename when generating suggested name
 # remove_from_name = ["[Example]", "Dummy"]
 

cli-tools.toml

@@ -689,6 +689,15 @@ impl QTorrent {
 
         if !self.config.file_filter.is_empty() {
             println!("{}", "File filters:".bold());
+            println!(
+                "  {} {}",
+                "Include images:".dimmed(),
+                if self.config.file_filter.include_images {
+                    "yes".green()
+                } else {
+                    "no".yellow()
+                }
+            );
             if !self.config.file_filter.skip_extensions.is_empty() {
                 println!(
                     "  {} {}",
@@ -706,6 +715,11 @@ impl QTorrent {
             if let Some(min_size_mb) = self.config.file_filter.min_size_mb {
                 println!("  {} {} MB", "Min file size:".dimmed(), min_size_mb);
             }
+            if self.config.file_filter.include_images
+                && let Some(min_image_size_kb) = self.config.file_filter.min_image_size_kb
+            {
+                println!("  {} {} KB", "Min image size:".dimmed(), min_image_size_kb);
+            }
         }
     }
 

src/bin/qtorrent/add.rs

@@ -73,6 +73,12 @@ pub struct QtorrentConfig {
     /// Minimum file size in MB. Files smaller than this will be skipped.
     #[serde(default)]
     min_file_size_mb: Option<f64>,
+    /// Include image files (.jpg, .jpeg, .png) in multi-file torrents.
+    #[serde(default)]
+    include_images: bool,
+    /// Minimum image file size in KB. Files smaller than this will be skipped.
+    #[serde(default)]
+    min_image_size_kb: Option<f64>,
     /// Substrings to remove from torrent filename when generating suggested name.
     #[serde(default)]
     remove_from_name: Vec<String>,
@@ -190,6 +196,7 @@ impl Config {
     ///
     /// # Errors
     /// Returns an error if the config file cannot be read or parsed.
+    #[allow(clippy::too_many_lines)]
     pub fn from_args(args: QtorrentArgs) -> Result<Self> {
         let user_config = QtorrentConfig::get_user_config()?;
 
@@ -248,13 +255,26 @@ impl Config {
                 .collect()
         };
 
+        let include_images = args.include_images || user_config.include_images;
+
         // Convert MB to bytes for easier comparison
         let min_file_size_bytes = args
             .min_file_size_mb
             .or(user_config.min_file_size_mb)
-            .map(|mb| (mb * 1024.0 * 1024.0) as u64);
-
-        let file_filter = FileFilter::new(skip_extensions, skip_directories, min_file_size_bytes);
+            .and_then(mb_to_bytes);
+
+        let min_image_size_bytes = args
+            .min_image_size_kb
+            .or(user_config.min_image_size_kb)
+            .and_then(kb_to_bytes);
+
+        let file_filter = FileFilter::new(
+            skip_extensions,
+            skip_directories,
+            min_file_size_bytes,
+            include_images,
+            min_image_size_bytes,
+        );
 
         // Substrings to remove from suggested name
         let remove_from_name = user_config.remove_from_name;
@@ -413,6 +433,14 @@ impl Config {
     }
 }
 
+fn mb_to_bytes(mb: f64) -> Option<u64> {
+    (mb > 0.0).then_some((mb * 1024.0 * 1024.0) as u64)
+}
+
+fn kb_to_bytes(kb: f64) -> Option<u64> {
+    (kb > 0.0).then_some((kb * 1024.0) as u64)
+}
+
 #[cfg(test)]
 mod qtorrent_config_tests {
     use super::*;
@@ -476,11 +504,15 @@ tags = "hd,new"
 skip_extensions = ["nfo", "txt", "jpg"]
 skip_directories = ["sample", "subs"]
 min_file_size_mb = 50.0
+include_images = true
+min_image_size_kb = 2.5
 "#;
         let config = QtorrentConfig::from_toml_str(toml).expect("should parse config");
         assert_eq!(config.skip_extensions, vec!["nfo", "txt", "jpg"]);
         assert_eq!(config.skip_directories, vec!["sample", "subs"]);
         assert_eq!(config.min_file_size_mb, Some(50.0));
+        assert!(config.include_images);
+        assert_eq!(config.min_image_size_kb, Some(2.5));
     }
 
     #[test]

src/bin/qtorrent/config.rs

@@ -79,15 +79,15 @@ pub struct QtorrentArgs {
     #[arg(short = 'p', long)]
     pub dryrun: bool,
 
-    /// Offline mode: skip qBittorrent connection entirely (implies --dryrun)
+    /// Offline mode: skip qBittorrent connection entirely (implies dryrun)
     #[arg(short = 'o', long)]
     pub offline: bool,
 
     /// Skip confirmation prompts
     #[arg(short = 'y', long)]
     yes: bool,
 
-    /// File extensions to skip (e.g., nfo, txt, jpg)
+    /// File extensions to skip (e.g., nfo, txt)
     #[arg(short = 'e', long = "skip-ext", name = "EXT", value_delimiter = ',')]
     skip_extensions: Vec<String>,
 
@@ -99,11 +99,19 @@ pub struct QtorrentArgs {
     #[arg(short = 'm', long = "min-size", name = "MB")]
     min_file_size_mb: Option<f64>,
 
+    /// Include image files (.jpg, .jpeg, .png)
+    #[arg(short = 'i', long)]
+    include_images: bool,
+
+    /// Minimum image file size in KB
+    #[arg(short = 'M', long = "min-image-size", name = "KB")]
+    min_image_size_kb: Option<f64>,
+
     /// Recurse into subdirectories when searching for torrent files
     #[arg(short = 'r', long)]
     pub recurse: bool,
 
-    /// Skip rename prompts for existing/duplicate torrents
+    /// Skip rename prompts for existing torrents
     #[arg(short = 'x', long)]
     pub skip_existing: bool,
 
@@ -226,6 +234,30 @@ mod cli_args_tests {
         assert_eq!(args.min_file_size_mb, Some(50.5));
     }
 
+    #[test]
+    fn parses_include_images() {
+        let args = QtorrentArgs::try_parse_from(["test", "--include-images"]).expect("should parse");
+        assert!(args.include_images);
+    }
+
+    #[test]
+    fn parses_include_images_short_flag() {
+        let args = QtorrentArgs::try_parse_from(["test", "-i"]).expect("should parse");
+        assert!(args.include_images);
+    }
+
+    #[test]
+    fn parses_min_image_size() {
+        let args = QtorrentArgs::try_parse_from(["test", "--min-image-size", "3.5"]).expect("should parse");
+        assert_eq!(args.min_image_size_kb, Some(3.5));
+    }
+
+    #[test]
+    fn parses_min_image_size_short_flag() {
+        let args = QtorrentArgs::try_parse_from(["test", "-M", "3.5"]).expect("should parse");
+        assert_eq!(args.min_image_size_kb, Some(3.5));
+    }
+
     #[test]
     fn parses_combined_boolean_flags() {
         let args = QtorrentArgs::try_parse_from(["test", "-apyrxvo"]).expect("should parse");
@@ -289,6 +321,8 @@ mod cli_args_tests {
         assert!(args.skip_extensions.is_empty());
         assert!(args.skip_directories.is_empty());
         assert!(args.min_file_size_mb.is_none());
+        assert!(!args.include_images);
+        assert!(args.min_image_size_kb.is_none());
         assert!(!args.paused);
         assert!(!args.dryrun);
         assert!(!args.offline);
@@ -332,6 +366,9 @@ mod cli_args_tests {
             "sample",
             "-m",
             "50",
+            "--include-images",
+            "--min-image-size",
+            "2",
             "-a",
             "-r",
             "-v",
@@ -349,6 +386,8 @@ mod cli_args_tests {
         assert_eq!(args.skip_extensions, vec!["nfo", "txt"]);
         assert_eq!(args.skip_directories, vec!["sample"]);
         assert_eq!(args.min_file_size_mb, Some(50.0));
+        assert!(args.include_images);
+        assert_eq!(args.min_image_size_kb, Some(2.0));
         assert!(args.paused);
         assert!(args.recurse);
         assert!(args.verbose);
@@ -524,6 +563,32 @@ mod config_from_args_tests {
         assert_eq!(config.file_filter.min_size_bytes, Some(10 * 1024 * 1024));
     }
 
+    #[test]
+    fn config_cli_includes_images() {
+        let args = QtorrentArgs::try_parse_from(["test", "--include-images"]).expect("should parse");
+        let config = Config::from_args(args).expect("config should parse");
+        assert!(config.file_filter.include_images);
+    }
+
+    #[test]
+    fn config_cli_image_min_size_converts_to_bytes() {
+        let args =
+            QtorrentArgs::try_parse_from(["test", "--include-images", "--min-image-size", "2"]).expect("should parse");
+        let config = Config::from_args(args).expect("config should parse");
+        assert_eq!(config.file_filter.min_image_size_bytes, Some(2 * 1024));
+    }
+
+    #[test]
+    fn config_zero_sizes_disable_size_filters() {
+        let args =
+            QtorrentArgs::try_parse_from(["test", "--include-images", "--min-size", "0", "--min-image-size", "0"])
+                .expect("should parse");
+        let config = Config::from_args(args).expect("config should parse");
+        assert!(config.file_filter.include_images);
+        assert!(config.file_filter.min_size_bytes.is_none());
+        assert!(config.file_filter.min_image_size_bytes.is_none());
+    }
+
     #[test]
     fn config_has_credentials_when_cli_sets_them() {
         let args = QtorrentArgs::try_parse_from(["test", "-u", "user", "-w", "pass"]).expect("should parse");