repartee 0.9.1

A modern terminal IRC client built with Ratatui and Tokio
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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265

pub const APP_NAME: &str = "repartee";
pub const APP_VERSION: &str = env!("CARGO_PKG_VERSION");
pub const APP_URL: &str = "https://repart.ee/";

/// Base URL for the dictionary repository (raw GitHub content).
pub const DICTS_REPO_URL: &str =
    "https://raw.githubusercontent.com/outragedevs/repartee-dicts/main";

/// URL for the dictionary manifest file.
pub const DICTS_MANIFEST_URL: &str =
    "https://raw.githubusercontent.com/outragedevs/repartee-dicts/main/manifest.json";

/// Default quit/part message: "repartee 0.8.0 — <https://repart.ee/>"
pub fn default_quit_message() -> String {
    format!("{APP_NAME} {APP_VERSION} — {APP_URL}")
}

/// WHOX field selector string.
/// Fields requested: t=token, c=channel, u=user, i=ip, h=host,
/// n=nick, f=flags, a=account, r=realname.
/// Note: `s` (server), `d` (hopcount), `l` (idle) are omitted because
/// `IRCnet` ircd 2.12 silently drops unsupported fields, causing arg count
/// mismatches in the parser.
pub const WHOX_FIELDS: &str = "%tcuihnfar";

/// All themes shipped in the binary via `include_str!`.
///
/// `default.theme` gets special treatment in [`sync_bundled_themes_in`]:
/// if the user's copy differs from the bundled version, the user's copy
/// is backed up to `default.theme.bak` and then overwritten. Other
/// themes are copied **only if missing** so that user customizations
/// are never silently clobbered.
const BUNDLED_THEMES: &[(&str, &str)] = &[
    ("default.theme", include_str!("../themes/default.theme")),
    ("spring.theme", include_str!("../themes/spring.theme")),
];

/// Filename of the canonical default theme — the only entry in
/// [`BUNDLED_THEMES`] that is force-updated on version bumps.
const DEFAULT_THEME_FILE: &str = "default.theme";

use std::path::{Path, PathBuf};

pub fn home_dir() -> PathBuf {
    let base = dirs::home_dir().unwrap_or_else(|| PathBuf::from("."));
    base.join(format!(".{APP_NAME}"))
}

pub fn config_path() -> PathBuf {
    home_dir().join("config.toml")
}

pub fn theme_dir() -> PathBuf {
    home_dir().join("themes")
}

pub fn env_path() -> PathBuf {
    home_dir().join(".env")
}

pub fn log_dir() -> PathBuf {
    home_dir().join("logs")
}

pub fn scripts_dir() -> PathBuf {
    home_dir().join("scripts")
}

pub fn sessions_dir() -> PathBuf {
    home_dir().join("sessions")
}

pub fn dicts_dir() -> PathBuf {
    home_dir().join("dicts")
}

pub fn certs_dir() -> PathBuf {
    home_dir().join("certs")
}

/// Create config directory and write default files on first run.
pub fn ensure_config_dir() {
    if let Err(e) = crate::fs_secure::create_dir_all(&home_dir(), 0o700) {
        tracing::warn!("failed to create app dir: {e}");
    }
    if let Err(e) = crate::fs_secure::create_dir_all(&theme_dir(), 0o700) {
        tracing::warn!("failed to create theme dir: {e}");
    }
    if let Err(e) = crate::fs_secure::create_dir_all(&log_dir(), 0o700) {
        tracing::warn!("failed to create log dir: {e}");
    }
    if let Err(e) = crate::fs_secure::create_dir_all(&scripts_dir(), 0o700) {
        tracing::warn!("failed to create scripts dir: {e}");
    }
    if let Err(e) = crate::fs_secure::create_dir_all(&sessions_dir(), 0o700) {
        tracing::warn!("failed to create sessions dir: {e}");
    }
    if let Err(e) = crate::fs_secure::create_dir_all(&dicts_dir(), 0o700) {
        tracing::warn!("failed to create dicts dir: {e}");
    }
    if let Err(e) = crate::fs_secure::create_dir_all(&certs_dir(), 0o700) {
        tracing::warn!("failed to create certs dir: {e}");
    }

    // Write default config if missing
    let cfg = config_path();
    if !cfg.exists() {
        let default_cfg = crate::config::default_config();
        if let Err(e) = crate::config::save_config(&cfg, &default_cfg) {
            tracing::warn!("failed to write default config: {e}");
        } else {
            tracing::info!("Created default config at {}", cfg.display());
        }
    } else if let Err(e) = crate::fs_secure::restrict_path(&cfg, 0o600) {
        tracing::warn!("failed to secure config file: {e}");
    }

    let env = env_path();
    if env.exists()
        && let Err(e) = crate::fs_secure::restrict_path(&env, 0o600)
    {
        tracing::warn!("failed to secure env file: {e}");
    }

    // Sync bundled themes to the user's theme directory (creates missing
    // themes, force-updates `default.theme` with backup).
    sync_bundled_themes_in(&theme_dir());
}

/// Sync bundled themes into the user's theme directory.
///
/// Behavior per theme:
/// - If the user doesn't have it → write the bundled copy.
/// - If the theme is [`DEFAULT_THEME_FILE`] **and** the user's content
///   differs from the bundled content → back up the user's version to
///   `default.theme.bak` (overwriting any previous backup) and write
///   the new bundled version in its place.
/// - Otherwise (non-default theme that already exists) → leave it alone.
///   Users may have customized these files.
///
/// All failures are logged and skipped — theme sync is best-effort and
/// must never block startup.
fn sync_bundled_themes_in(dir: &Path) {
    for (name, content) in BUNDLED_THEMES {
        let path = dir.join(name);

        if !path.exists() {
            match std::fs::write(&path, content) {
                Ok(()) => tracing::info!("Installed bundled theme: {}", path.display()),
                Err(e) => tracing::warn!("failed to write bundled theme {name}: {e}"),
            }
            continue;
        }

        // Only the canonical default theme is force-updated.
        if *name != DEFAULT_THEME_FILE {
            continue;
        }

        let Ok(current) = std::fs::read_to_string(&path) else {
            tracing::warn!("failed to read existing {name} for diff check");
            continue;
        };

        if current == *content {
            continue;
        }

        // Content differs — back up user's copy, then overwrite.
        let backup = dir.join(format!("{name}.bak"));
        if let Err(e) = std::fs::copy(&path, &backup) {
            tracing::warn!(
                "failed to back up {name} to {}: {e} — skipping update",
                backup.display()
            );
            continue;
        }
        match std::fs::write(&path, content) {
            Ok(()) => tracing::info!(
                "Updated {} (previous version backed up to {})",
                path.display(),
                backup.display()
            ),
            Err(e) => tracing::warn!("failed to update {name}: {e}"),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    fn bundled_default() -> &'static str {
        BUNDLED_THEMES
            .iter()
            .find(|(name, _)| *name == DEFAULT_THEME_FILE)
            .map(|(_, c)| *c)
            .expect("default.theme must be in BUNDLED_THEMES")
    }

    #[test]
    fn sync_installs_all_themes_on_first_run() {
        let dir = tempfile::tempdir().unwrap();
        sync_bundled_themes_in(dir.path());

        for (name, content) in BUNDLED_THEMES {
            let path = dir.path().join(name);
            assert!(path.exists(), "{name} should have been created");
            assert_eq!(std::fs::read_to_string(&path).unwrap(), *content);
        }
    }

    #[test]
    fn sync_leaves_matching_default_theme_untouched() {
        let dir = tempfile::tempdir().unwrap();
        let path = dir.path().join(DEFAULT_THEME_FILE);
        std::fs::write(&path, bundled_default()).unwrap();

        sync_bundled_themes_in(dir.path());

        assert!(
            !dir.path().join("default.theme.bak").exists(),
            "no backup should be created when content matches"
        );
    }

    #[test]
    fn sync_backs_up_and_overwrites_changed_default_theme() {
        let dir = tempfile::tempdir().unwrap();
        let path = dir.path().join(DEFAULT_THEME_FILE);
        let user_content = "# user's old default theme\n";
        std::fs::write(&path, user_content).unwrap();

        sync_bundled_themes_in(dir.path());

        // Backup contains the user's old version.
        let backup = dir.path().join("default.theme.bak");
        assert!(backup.exists(), "backup should exist after overwrite");
        assert_eq!(std::fs::read_to_string(&backup).unwrap(), user_content);

        // Original now has the bundled content.
        assert_eq!(std::fs::read_to_string(&path).unwrap(), bundled_default());
    }

    #[test]
    fn sync_preserves_user_customized_non_default_theme() {
        let dir = tempfile::tempdir().unwrap();
        let path = dir.path().join("spring.theme");
        let user_customization = "# my customized spring theme\n";
        std::fs::write(&path, user_customization).unwrap();

        sync_bundled_themes_in(dir.path());

        // User's spring.theme is untouched — no backup, no overwrite.
        assert_eq!(
            std::fs::read_to_string(&path).unwrap(),
            user_customization,
            "non-default themes must never be overwritten"
        );
        assert!(
            !dir.path().join("spring.theme.bak").exists(),
            "non-default themes must not produce .bak files"
        );
    }
}