caesura 0.31.0

An all-in-one command line tool to transcode FLAC audio files and upload to gazelle based indexers/trackers
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
125
126
127
128
129
130
131
132
133
134

use crate::prelude::*;
use std::fs::canonicalize;

const MAX_DEPTH: usize = 10;

/// Scan `.torrent` files for problematic file paths.
#[injectable]
pub(crate) struct AuditCommand {
    args: Ref<AuditArgs>,
    options: Ref<AuditOptions>,
    auditor: Ref<TorrentAuditor>,
    torrent_file_provider: Ref<TorrentFileProvider>,
    shared: Ref<SharedOptions>,
    cache: Ref<CacheOptions>,
}

impl AuditCommand {
    /// Execute [`AuditCommand`] from the CLI.
    ///
    /// - A numeric input is downloaded from the API and audited
    /// - Any other input is scanned as a file or directory path
    pub(crate) async fn execute_cli(&self) -> Result<bool, Failure<AuditAction>> {
        let mode = self.args.to_mode().expect("arg should be valid");
        let paths = match mode {
            AuditMode::Directory(path) => get_dir_paths(&path)?,
            AuditMode::File(path) => vec![path],
            AuditMode::Id(id) => vec![self.download_by_id(id).await?],
        };
        let summary = self.execute(&paths);
        debug!("{} {} torrent files", "Audited".bold(), summary.total);
        if summary.issues.is_empty() {
            info!("No issues found");
            return Ok(true);
        }
        warn!(
            "{} {} problematic torrents",
            "Found".bold(),
            summary.issues.len()
        );
        self.print_issues(&summary);
        Ok(false)
    }

    /// Scan `paths` for problematic torrents.
    pub(crate) fn execute(&self, paths: &[PathBuf]) -> AuditSummary {
        let mut items = Vec::new();
        for path in paths {
            let item = self.auditor.execute_path(path);
            if item.issues.is_some() {
                items.push(item);
            }
        }
        AuditSummary {
            total: paths.len(),
            issues: items,
        }
    }

    /// Download the torrent for `id` from the API.
    ///
    /// - Validates the API credentials and cache directory before downloading
    async fn download_by_id(&self, id: u32) -> Result<PathBuf, Failure<AuditAction>> {
        self.validate_id_inputs()?;
        self.torrent_file_provider
            .get(id)
            .await
            .map_err(Failure::wrap(AuditAction::Download))
    }

    /// Validate the credentials and cache directory the id flow uses.
    ///
    /// - Checks `api_key` is set, `indexer_url` is a valid URL, and the cache directory exists
    /// - Logs each issue via [`OptionsValidator::check`] before returning an error
    fn validate_id_inputs(&self) -> Result<(), Failure<AuditAction>> {
        let mut validator = OptionsValidator::new();
        if self.shared.api_key.is_empty() {
            validator.push(OptionIssue::required_non_empty("api_key"));
        }
        validator.check_url("indexer_url", &self.shared.indexer_url);
        self.cache.validate(&mut validator);
        if validator.check() {
            Ok(())
        } else {
            Err(Failure::from_action(AuditAction::ValidateOptions))
        }
    }

    fn print_issues(&self, summary: &AuditSummary) {
        for item in &summary.issues {
            let Some(issues) = &item.issues else {
                continue;
            };
            eprintln!(
                "{}",
                format!(
                    "{} issues with {}",
                    issues.len(),
                    item.render(self.options.print_bb_code)
                )
                .bold()
            );
            for issue in issues {
                eprintln!("{}", issue.render(self.options.print_bb_code));
            }
        }
        eprintln!("\n{}", summary.kind_table());
    }
}

fn get_dir_paths(path: &Path) -> Result<Vec<PathBuf>, Failure<AuditAction>> {
    let path =
        canonicalize(path).map_err(Failure::wrap_with_path(AuditAction::Canonicalize, path))?;
    if path.is_file() {
        return Ok(vec![path.clone()]);
    }
    DirectoryReader::new()
        .with_extension("torrent")
        .with_max_depth(MAX_DEPTH)
        .read(&path)
        .map_err(Failure::wrap_with_path(AuditAction::ReadDirectory, &path))
}

/// Error action for [`AuditCommand`].
#[derive(Clone, Copy, Debug, Eq, PartialEq, ThisError)]
pub(crate) enum AuditAction {
    #[error("canonicalize path")]
    Canonicalize,
    #[error("download torrent")]
    Download,
    #[error("read directory")]
    ReadDirectory,
    #[error("validate options")]
    ValidateOptions,
}