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
//! A variable handler that lets you pull values from the environment.
use crate::traits::{unpack_closure, VariableHandler};
use libucl_bind::ucl_variable_handler;
use std::ffi::c_void;
use std::os::raw::c_uchar;
use std::ptr::slice_from_raw_parts;

/// A handler that replaces variable with value of environmental variable if its present.
/// Handler optionally allows you to specify a prefix for all variables.
pub struct EnvVariableHandler {
    closure:
        Box<dyn FnMut(*const c_uchar, usize, *mut *mut c_uchar, *mut usize, *mut bool) -> bool>,
}

impl EnvVariableHandler {
    /// Create a handler with prefix.
    fn with_prefix(prefix: String) -> Self {
        let closure = move |data: *const ::std::os::raw::c_uchar,
                            len: usize,
                            replace: *mut *mut ::std::os::raw::c_uchar,
                            replace_len: *mut usize,
                            need_free: *mut bool| {
            let var = unsafe {
                let slice = slice_from_raw_parts(data, len).as_ref().unwrap();
                std::str::from_utf8(slice).unwrap()
            };

            if var.starts_with(&prefix) {
                if let Ok(mut value) = std::env::var(var) {
                    let bytes = unsafe { value.as_bytes_mut() };
                    unsafe {
                        *need_free = false;
                        *replace = bytes.as_mut_ptr();
                        *replace_len = bytes.len();
                    }
                    return true;
                }
            }
            false
        };
        EnvVariableHandler {
            closure: Box::new(closure),
        }
    }
}
impl Default for EnvVariableHandler {
    /// Create a handler with `ENV_` prefix.
    fn default() -> Self {
        Self::with_prefix(String::from(""))
    }
}

impl VariableHandler for EnvVariableHandler {
    fn handle(
        &mut self,
        ptr: *const u8,
        len: usize,
        dst: *mut *mut u8,
        dst_len: *mut usize,
        needs_free: *mut bool,
    ) -> bool {
        self.closure.handle(ptr, len, dst, dst_len, needs_free)
    }

    fn get_fn_ptr_and_data(&mut self) -> (*mut c_void, ucl_variable_handler) {
        unsafe { unpack_closure(&mut self.closure) }
    }
}

#[cfg(test)]
mod test {
    use super::*;
    use crate::traits::VariableHandler;
    use crate::{Parser, Priority, DEFAULT_DUPLICATE_STRATEGY};

    #[cfg(target_os = "freebsd")]
    #[test]
    fn basic_env_var_handler() {
        let mut handler = EnvVariableHandler::with_prefix("ENV_".to_string());
        let (state, callback) = handler.get_fn_ptr_and_data();

        let good_var = "ENV_RZZYIBBEBD";
        let bad_var = "ENV_AGBDMXLAAH";
        std::env::set_var(good_var, "yes");
        std::env::remove_var(bad_var);
        std::env::set_var("RZZYIBBEBD", "yes");

        let input = r#"
        good = "${ENV_RZZYIBBEBD}"
        bad = "${ENV_AGBDMXLAAH}"
        also_bad = "${RZZYIBBEBD}"
        "#;

        let mut parser = Parser::default();
        unsafe {
            parser.set_variables_handler_raw(callback, state);
        }
        parser
            .add_chunk_full(input, Priority::default(), DEFAULT_DUPLICATE_STRATEGY)
            .unwrap();

        let root = parser.get_object().unwrap();

        let good = root.lookup("good").unwrap().as_string().unwrap();
        assert_eq!("yes", &good);

        let bad = root.lookup("bad").unwrap().as_string().unwrap();
        assert_eq!("${ENV_AGBDMXLAAH}", bad);

        let also_bad = root.lookup("also_bad").unwrap().as_string().unwrap();
        assert_eq!("${RZZYIBBEBD}", also_bad);
    }
}