clonehunter 0.4.2

A simple command line utility that identifies groups of identical files and displays them to the console
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124

// Copyright (c) 2024 Venkatesh Omkaram

use std::fmt;

use clap::Parser;

#[derive(clap::Args, Debug, Clone)]
#[command(disable_version_flag = true)]
pub struct Delete {}

#[derive(clap::Args, Debug, Clone)]
#[command(disable_version_flag = true)]
pub struct HunterOptions {
    /// Pass the Source Directory (This is the directory under which will be looking for the identical files (aka 'Clones')
    pub source_dir: String,
    /// Pass the Maximum Depth of directories to scan
    #[clap(short, long, default_value_t = 10)]
    pub max_depth: usize,
    /// Use this option if you don't wish to specify a max_depth.
    #[clap(long, default_value_t = false)]
    pub no_max_depth: bool,
    /// Hunt for clones by performing partial file checksums.
    #[clap(short, long, default_value_t = false)]
    pub checksum: bool,
    /// Find clones for a specific file type. Example -e pdf or -e pdf,txt,mp4
    #[clap(short, long)]
    pub extension: Option<String>,
    /// Sorts the output.
    #[clap(short, long, value_enum, default_value_t = SortBy::FileType)]
    pub sort_by: SortBy,
    /// Prints the sorted output either in the Ascending or the Descending order
    #[clap(short, long)]
    pub order_by: Option<OrderBy>,
    /// Targets maximum file sizes in bytes
    /// 
    /// (Additionally you can also use "KiB", "MiB", "GiB", "KB", "MB", "GB". For example: "150 KiB" with quotes)
    #[clap(short = 'j', long)]
    pub max: Option<String>,
    /// Targets minimum file sizes in bytes (not to be used with --max)
    /// 
    /// (Additionally you can also use "KiB", "MiB", "GiB", "KB", "MB", "GB". For example: "13 MiB" with quotes)
    #[clap(short = 'l', long)]
    pub min: Option<String>,
    /// Write the output to a file using various styles (requires `-f`)
    #[clap(short = 'u', long, requires = "output_file")]
    pub output_style: Option<OutputStyle>,
    /// Write the output to a file (requires `-u`)
    #[clap(short = 'f', long, requires = "output_style")]
    pub output_file: Option<String>,
}

#[derive(clap::Args, Debug, Clone)]
#[command(disable_version_flag = true)]
pub struct DeleteOptions {
    /// Provide the JSON input file path which you generated using the `hunt -u json -f report_file.json` command
    #[clap(short, long)]
    pub input_file: String,
    /// Dry run (test to see if the deletion works without deleting anything)
    #[clap(long, default_value_t = false)]
    pub dry_run: bool,
}

/// SortBy User Option
#[derive(clap::ValueEnum, Clone, Copy, Debug)]
pub enum SortBy {
    FileType,
    FileSize,
    Both,
}

/// OrderBy User Option
#[derive(clap::ValueEnum, Clone, Copy, Debug)]
pub enum OrderBy {
    Asc,
    Desc,
}

#[derive(clap::ValueEnum, Clone, Copy, Debug)]
pub enum OutputStyle {
    /// Use the default style of printing the output to a file
    Default,
    /// Use the JSON style of printing the output to a file
    JSON,
}

#[derive(clap::Subcommand, Debug, Clone)]
//#[command(disable_version_flag = true)]
pub enum Command {
    /// Search for clones (duplicates)
    Hunt(HunterOptions),
    /// Delete the extracted clones
    Delete(DeleteOptions),
}

#[derive(Parser, Clone)]
#[command(author="@github.com/omkarium", version, about, long_about = None)]
pub struct Args {
    #[command(subcommand)]
    pub command: Command,
    /// Threads to speed up the execution
    #[clap(short, long, default_value_t = 8)]
    pub threads: u8,
    /// Print verbose output
    #[clap(short, long, default_value_t = false)]
    pub verbose: bool,
}

impl fmt::Display for OrderBy {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            OrderBy::Asc => write!(f, "{}", "Asc"),
            OrderBy::Desc => write!(f, "{}", "Desc"),
        }
    }
}

impl fmt::Display for OutputStyle {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            OutputStyle::Default => write!(f, "{}", "Default"),
            OutputStyle::JSON => write!(f, "{}", "JSON"),
        }
    }
}