Skip to main content

huddle_core/
config.rs

1use std::path::PathBuf;
2
3pub fn data_dir() -> PathBuf {
4    let base = dirs::data_dir().unwrap_or_else(|| PathBuf::from("."));
5    base.join("huddle")
6}
7
8/// Phase D: location of the user's optional config file. We use
9/// `dirs::config_dir()` rather than `data_dir()` so this lives in the
10/// platform-appropriate "preferences" directory (macOS
11/// `~/Library/Application Support`, Linux `~/.config`, Windows
12/// `%APPDATA%`). Doesn't have to exist — `load_relays` returns an
13/// empty list if absent.
14pub fn config_path() -> PathBuf {
15    let base = dirs::config_dir().unwrap_or_else(|| PathBuf::from("."));
16    base.join("huddle").join("config.toml")
17}
18
19/// Phase D: parse the relay multiaddr list from the config file. The
20/// documented form (README + MANUAL_TESTING §14) is a top-level array:
21///
22/// ```toml
23/// relays = [
24///   "/dns4/relay.example.com/tcp/4001/p2p/12D3Koo...",
25/// ]
26/// ```
27///
28/// huddle 0.7.12: the parser now honors exactly that. Pre-0.7.12 it
29/// required an undocumented `[network]` section header AND only parsed a
30/// single-line array, so the documented header-less, multi-line form
31/// silently produced zero relays — the `config.toml` path to cross-
32/// internet reach was a no-op. Now no header is required (a `relays`
33/// entry is accepted whether or not it sits under a section), the array
34/// may span multiple lines, a single-line `relays = ["a", "b"]` and a
35/// bare scalar `relays = "a"` both work, and trailing `# comments` are
36/// stripped. Returns an empty Vec if the file doesn't exist or has no
37/// relays entry.
38pub fn load_relays() -> Option<Vec<String>> {
39    let path = config_path();
40    let body = std::fs::read_to_string(&path).ok()?;
41    Some(parse_relays(&body))
42}
43
44/// Pure relay-list extraction, split out from `load_relays` so it can be
45/// unit-tested without touching the filesystem.
46fn parse_relays(body: &str) -> Vec<String> {
47    let mut out: Vec<String> = Vec::new();
48    let mut in_array = false;
49    for raw in body.lines() {
50        let line = strip_inline_comment(raw).trim();
51        if line.is_empty() {
52            continue;
53        }
54        if in_array {
55            // Inside a multi-line `relays = [ ... ]`. Collect quoted
56            // entries until the closing `]`.
57            let (segment, closed) = match line.find(']') {
58                Some(idx) => (&line[..idx], true),
59                None => (line, false),
60            };
61            collect_relay_items(segment, &mut out);
62            if closed {
63                in_array = false;
64            }
65            continue;
66        }
67        // Outside an array the only key we care about is `relays`.
68        // Section headers (`[network]`) and unrelated keys fall through
69        // — we accept a `relays` entry whether or not it sits under a
70        // section, matching the header-less documented form.
71        let rest = match line.strip_prefix("relays") {
72            Some(r) => r.trim_start(),
73            None => continue,
74        };
75        let rest = match rest.strip_prefix('=') {
76            Some(r) => r.trim(),
77            None => continue, // a key like `relays_enabled` — not ours
78        };
79        match rest.strip_prefix('[') {
80            // Array form, single- or multi-line.
81            Some(after_open) => match after_open.find(']') {
82                Some(idx) => collect_relay_items(&after_open[..idx], &mut out),
83                None => {
84                    collect_relay_items(after_open, &mut out);
85                    in_array = true;
86                }
87            },
88            // Bare scalar form: `relays = "addr"`.
89            None => {
90                let item = rest.trim_matches('"').trim_matches('\'');
91                if !item.is_empty() {
92                    out.push(item.to_string());
93                }
94            }
95        }
96    }
97    out
98}
99
100/// Strip a `#` comment from a config line. Multiaddrs never contain `#`,
101/// so cutting at the first one is safe for the relays value space and
102/// matches TOML comment semantics.
103fn strip_inline_comment(line: &str) -> &str {
104    match line.find('#') {
105        Some(idx) => &line[..idx],
106        None => line,
107    }
108}
109
110/// Split a comma-separated array segment into trimmed, unquoted relay
111/// entries, dropping empties.
112fn collect_relay_items(segment: &str, out: &mut Vec<String>) {
113    for item in segment.split(',') {
114        let item = item.trim().trim_matches('"').trim_matches('\'');
115        if !item.is_empty() {
116            out.push(item.to_string());
117        }
118    }
119}
120
121pub fn db_path() -> PathBuf {
122    data_dir().join("huddle.db")
123}
124
125pub fn identity_key_path() -> PathBuf {
126    data_dir().join("identity.key")
127}
128
129pub fn log_path() -> PathBuf {
130    data_dir().join("huddle.log")
131}
132
133pub fn ensure_data_dir() -> std::io::Result<()> {
134    std::fs::create_dir_all(data_dir())
135}
136
137#[cfg(test)]
138mod tests {
139    use super::*;
140
141    #[test]
142    fn data_dir_is_inside_huddle_directory() {
143        let dir = data_dir();
144        assert!(dir.ends_with("huddle") || dir.to_string_lossy().contains("huddle"));
145    }
146
147    #[test]
148    fn db_path_ends_with_huddle_db() {
149        let path = db_path();
150        assert_eq!(path.file_name().unwrap(), "huddle.db");
151    }
152
153    #[test]
154    fn identity_path_ends_with_identity_key() {
155        let path = identity_key_path();
156        assert_eq!(path.file_name().unwrap(), "identity.key");
157    }
158
159    // huddle 0.7.12 — relay-parsing regression tests. The form below is
160    // verbatim what README.md (line 283) and MANUAL_TESTING.md §14 tell
161    // users to put in config.toml; pre-0.7.12 it parsed to zero relays.
162    #[test]
163    fn parse_relays_documented_multiline_no_header() {
164        let body = "relays = [\n  \"/dns4/relay.example.com/tcp/4001/p2p/12D3Koo\",\n]\n";
165        assert_eq!(
166            parse_relays(body),
167            vec!["/dns4/relay.example.com/tcp/4001/p2p/12D3Koo".to_string()]
168        );
169    }
170
171    #[test]
172    fn parse_relays_multiline_with_network_header() {
173        let body = "[network]\nrelays = [\n  \"/ip4/1.2.3.4/tcp/4001/p2p/A\",\n  \"/ip4/5.6.7.8/tcp/4001/p2p/B\",\n]\n";
174        assert_eq!(
175            parse_relays(body),
176            vec![
177                "/ip4/1.2.3.4/tcp/4001/p2p/A".to_string(),
178                "/ip4/5.6.7.8/tcp/4001/p2p/B".to_string(),
179            ]
180        );
181    }
182
183    #[test]
184    fn parse_relays_single_line_array() {
185        let body = "relays = [\"/ip4/1.2.3.4/tcp/1/p2p/A\", \"/ip4/5.6.7.8/tcp/2/p2p/B\"]";
186        assert_eq!(parse_relays(body).len(), 2);
187    }
188
189    #[test]
190    fn parse_relays_scalar_form() {
191        let body = "relays = \"/ip4/1.2.3.4/tcp/1/p2p/A\"";
192        assert_eq!(
193            parse_relays(body),
194            vec!["/ip4/1.2.3.4/tcp/1/p2p/A".to_string()]
195        );
196    }
197
198    #[test]
199    fn parse_relays_strips_comments_and_blanks() {
200        let body = "# a comment\n\nrelays = [\n  \"/ip4/1.2.3.4/tcp/1/p2p/A\",  # inline note\n]\n";
201        assert_eq!(
202            parse_relays(body),
203            vec!["/ip4/1.2.3.4/tcp/1/p2p/A".to_string()]
204        );
205    }
206
207    #[test]
208    fn parse_relays_empty_when_absent() {
209        assert!(parse_relays("[network]\nfoo = 1\n").is_empty());
210        assert!(parse_relays("").is_empty());
211    }
212
213    #[test]
214    fn parse_relays_ignores_similar_key() {
215        // `relays_enabled` must not be mistaken for the `relays` array.
216        assert!(parse_relays("relays_enabled = true\n").is_empty());
217    }
218}