maclean 1.0.0

Find and reclaim disk space on macOS
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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174

use std::path::PathBuf;

use serde::{Deserialize, Serialize};

/// What kind of access an operation needs. Scan never uses sudo.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, Default)]
#[serde(rename_all = "snake_case")]
pub enum Privilege {
    #[default]
    None,
    /// macOS TCC Full Disk Access. sudo does not grant this.
    FullDiskAccess,
    /// A one-shot `sudo` for a specific command (never the whole app).
    Admin,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum IssueKind {
    Permission,
    NeedsAdmin,
    NeedsFullDiskAccess,
    Unavailable,
    Warning,
}

/// A structured finding from a module. UIs render these; they do not print
/// raw stderr.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ScanIssue {
    pub kind: IssueKind,
    pub message: String,
    pub path: Option<PathBuf>,
    pub hint: Option<String>,
}

impl ScanIssue {
    pub fn permission(path: impl Into<PathBuf>, message: impl Into<String>) -> Self {
        Self {
            kind: IssueKind::Permission,
            message: message.into(),
            path: Some(path.into()),
            hint: Some(
                "If this is under ~/Library, grant Full Disk Access to your terminal in System Settings → Privacy & Security."
                    .into(),
            ),
        }
    }

    pub fn full_disk_access(message: impl Into<String>) -> Self {
        Self {
            kind: IssueKind::NeedsFullDiskAccess,
            message: message.into(),
            path: None,
            hint: Some(
                "System Settings → Privacy & Security → Full Disk Access → enable this terminal (or the maclean binary). sudo will not help."
                    .into(),
            ),
        }
    }

    pub fn needs_admin(message: impl Into<String>) -> Self {
        Self {
            kind: IssueKind::NeedsAdmin,
            message: message.into(),
            path: None,
            hint: Some(
                "This one action needs a macOS administrator password. maclean will not run itself as root; it only elevates that command."
                    .into(),
            ),
        }
    }

    pub fn warning(message: impl Into<String>) -> Self {
        Self {
            kind: IssueKind::Warning,
            message: message.into(),
            path: None,
            hint: None,
        }
    }

    pub fn unavailable(message: impl Into<String>) -> Self {
        Self {
            kind: IssueKind::Unavailable,
            message: message.into(),
            path: None,
            hint: None,
        }
    }

    pub fn with_hint(mut self, hint: impl Into<String>) -> Self {
        self.hint = Some(hint.into());
        self
    }

    pub fn title(&self) -> &'static str {
        match self.kind {
            IssueKind::Permission => "Permission denied",
            IssueKind::NeedsAdmin => "Administrator required",
            IssueKind::NeedsFullDiskAccess => "Full Disk Access required",
            IssueKind::Unavailable => "Unavailable",
            IssueKind::Warning => "Warning",
        }
    }
}

/// Cheap leftover-data check, with a human-readable reason either way.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Relevance {
    pub relevant: bool,
    pub reason: String,
}

impl Relevance {
    pub fn yes(reason: impl Into<String>) -> Self {
        Self {
            relevant: true,
            reason: reason.into(),
        }
    }

    pub fn no(reason: impl Into<String>) -> Self {
        Self {
            relevant: false,
            reason: reason.into(),
        }
    }
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ReclaimError {
    pub item_id: String,
    pub kind: IssueKind,
    pub message: String,
    pub hint: Option<String>,
}

impl ReclaimError {
    pub fn new(item_id: impl Into<String>, kind: IssueKind, message: impl Into<String>) -> Self {
        Self {
            item_id: item_id.into(),
            kind,
            message: message.into(),
            hint: None,
        }
    }

    pub fn with_hint(mut self, hint: impl Into<String>) -> Self {
        self.hint = Some(hint.into());
        self
    }

    pub fn from_issue(item_id: impl Into<String>, issue: ScanIssue) -> Self {
        Self {
            item_id: item_id.into(),
            kind: issue.kind,
            message: issue.message,
            hint: issue.hint,
        }
    }
}

impl std::fmt::Display for ReclaimError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.message)?;
        if let Some(hint) = &self.hint {
            write!(f, " ({hint})")?;
        }
        Ok(())
    }
}

impl std::error::Error for ReclaimError {}