File: specifier.rs

package info (click to toggle)
rust-systemd-unit-edit 0.1.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 204 kB
  • sloc: makefile: 4
file content (220 lines) | stat: -rw-r--r-- 6,828 bytes parent folder | download | duplicates (2)
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
//! Systemd specifier expansion support
//!
//! Systemd uses percent-escaped specifiers in unit files that are expanded
//! at runtime. This module provides functionality to expand these specifiers.

use std::collections::HashMap;

/// Context for expanding systemd specifiers
///
/// This contains the values that will be substituted when expanding
/// specifiers in unit file values.
#[derive(Debug, Clone, Default)]
pub struct SpecifierContext {
    values: HashMap<String, String>,
}

impl SpecifierContext {
    /// Create a new empty specifier context
    pub fn new() -> Self {
        Self {
            values: HashMap::new(),
        }
    }

    /// Set a specifier value
    ///
    /// # Example
    ///
    /// ```
    /// # use systemd_unit_edit::SpecifierContext;
    /// let mut ctx = SpecifierContext::new();
    /// ctx.set("i", "instance");
    /// ctx.set("u", "user");
    /// ```
    pub fn set(&mut self, specifier: &str, value: &str) {
        self.values.insert(specifier.to_string(), value.to_string());
    }

    /// Get a specifier value
    pub fn get(&self, specifier: &str) -> Option<&str> {
        self.values.get(specifier).map(|s| s.as_str())
    }

    /// Create a context with common system specifiers
    ///
    /// This sets up commonly used specifiers with their values:
    /// - `%n`: Unit name (without type suffix)
    /// - `%N`: Full unit name
    /// - `%p`: Prefix (for template units)
    /// - `%i`: Instance (for template units)
    ///
    /// # Example
    ///
    /// ```
    /// # use systemd_unit_edit::SpecifierContext;
    /// let ctx = SpecifierContext::with_unit_name("foo@bar.service");
    /// assert_eq!(ctx.get("N"), Some("foo@bar.service"));
    /// assert_eq!(ctx.get("n"), Some("foo@bar"));
    /// assert_eq!(ctx.get("p"), Some("foo"));
    /// assert_eq!(ctx.get("i"), Some("bar"));
    /// ```
    pub fn with_unit_name(unit_name: &str) -> Self {
        let mut ctx = Self::new();

        // Full unit name
        ctx.set("N", unit_name);

        // Unit name without suffix
        let name_without_suffix = unit_name
            .rsplit_once('.')
            .map(|(name, _)| name)
            .unwrap_or(unit_name);
        ctx.set("n", name_without_suffix);

        // For template units (foo@instance.service)
        if let Some((prefix, instance_with_suffix)) = name_without_suffix.split_once('@') {
            ctx.set("p", prefix);
            ctx.set("i", instance_with_suffix);
        }

        ctx
    }

    /// Expand specifiers in a string
    ///
    /// This replaces all `%X` patterns with their corresponding values from the context.
    /// `%%` is replaced with a single `%`.
    ///
    /// # Example
    ///
    /// ```
    /// # use systemd_unit_edit::SpecifierContext;
    /// let mut ctx = SpecifierContext::new();
    /// ctx.set("i", "myinstance");
    /// ctx.set("u", "myuser");
    ///
    /// let result = ctx.expand("/var/lib/%i/data/%u");
    /// assert_eq!(result, "/var/lib/myinstance/data/myuser");
    /// ```
    pub fn expand(&self, input: &str) -> String {
        let mut result = String::new();
        let mut chars = input.chars().peekable();

        while let Some(ch) = chars.next() {
            if ch == '%' {
                if let Some(&next) = chars.peek() {
                    chars.next(); // consume the peeked character
                    if next == '%' {
                        // %% -> %
                        result.push('%');
                    } else {
                        // %X -> lookup
                        let specifier = next.to_string();
                        if let Some(value) = self.get(&specifier) {
                            result.push_str(value);
                        } else {
                            // Unknown specifier, keep as-is
                            result.push('%');
                            result.push(next);
                        }
                    }
                } else {
                    // % at end of string
                    result.push('%');
                }
            } else {
                result.push(ch);
            }
        }

        result
    }
}

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

    #[test]
    fn test_basic_expansion() {
        let mut ctx = SpecifierContext::new();
        ctx.set("i", "instance");
        ctx.set("u", "user");

        assert_eq!(ctx.expand("Hello %i"), "Hello instance");
        assert_eq!(ctx.expand("%u@%i"), "user@instance");
        assert_eq!(ctx.expand("/home/%u/%i"), "/home/user/instance");
    }

    #[test]
    fn test_percent_escape() {
        let ctx = SpecifierContext::new();
        assert_eq!(ctx.expand("100%% complete"), "100% complete");
        assert_eq!(ctx.expand("%%u"), "%u");
    }

    #[test]
    fn test_unknown_specifier() {
        let ctx = SpecifierContext::new();
        // Unknown specifiers are kept as-is
        assert_eq!(ctx.expand("%x"), "%x");
        assert_eq!(ctx.expand("test %z end"), "test %z end");
    }

    #[test]
    fn test_percent_at_end() {
        let ctx = SpecifierContext::new();
        assert_eq!(ctx.expand("test%"), "test%");
    }

    #[test]
    fn test_with_unit_name_simple() {
        let ctx = SpecifierContext::with_unit_name("foo.service");
        assert_eq!(ctx.get("N"), Some("foo.service"));
        assert_eq!(ctx.get("n"), Some("foo"));
        assert_eq!(ctx.get("p"), None);
        assert_eq!(ctx.get("i"), None);
    }

    #[test]
    fn test_with_unit_name_template() {
        let ctx = SpecifierContext::with_unit_name("foo@bar.service");
        assert_eq!(ctx.get("N"), Some("foo@bar.service"));
        assert_eq!(ctx.get("n"), Some("foo@bar"));
        assert_eq!(ctx.get("p"), Some("foo"));
        assert_eq!(ctx.get("i"), Some("bar"));

        assert_eq!(ctx.expand("Unit %N"), "Unit foo@bar.service");
        assert_eq!(ctx.expand("Prefix %p"), "Prefix foo");
        assert_eq!(ctx.expand("Instance %i"), "Instance bar");
    }

    #[test]
    fn test_with_unit_name_complex_instance() {
        let ctx = SpecifierContext::with_unit_name("getty@tty1.service");
        assert_eq!(ctx.get("p"), Some("getty"));
        assert_eq!(ctx.get("i"), Some("tty1"));
        assert_eq!(ctx.expand("/dev/%i"), "/dev/tty1");
    }

    #[test]
    fn test_multiple_specifiers() {
        let mut ctx = SpecifierContext::new();
        ctx.set("i", "inst");
        ctx.set("u", "usr");
        ctx.set("h", "/home/usr");

        assert_eq!(
            ctx.expand("%h/.config/%i/data"),
            "/home/usr/.config/inst/data"
        );
    }

    #[test]
    fn test_no_specifiers() {
        let ctx = SpecifierContext::new();
        assert_eq!(ctx.expand("plain text"), "plain text");
        assert_eq!(ctx.expand("/etc/config"), "/etc/config");
    }
}