uv_toml/

lib.rs

use std::collections::BTreeMap;

use serde::{Deserialize, Deserializer};
use toml_datetime::Datetime;
use toml_parser::decoder::Encoding;
use toml_parser::lexer::Token;
use toml_parser::parser::{EventReceiver, parse_document};
use toml_parser::{ErrorSink, Source, Span};

/// Deserialize a map while ensuring all keys are unique.
pub fn deserialize_unique_map<'de, D, K, V, F>(
    deserializer: D,
    error_msg: F,
) -> Result<BTreeMap<K, V>, D::Error>
where
    D: Deserializer<'de>,
    K: Deserialize<'de> + Ord,
    V: Deserialize<'de>,
    F: FnOnce(&K) -> String,
{
    struct Visitor<K, V, F>(F, std::marker::PhantomData<(K, V)>);

    impl<'de, K, V, F> serde::de::Visitor<'de> for Visitor<K, V, F>
    where
        K: Deserialize<'de> + Ord,
        V: Deserialize<'de>,
        F: FnOnce(&K) -> String,
    {
        type Value = BTreeMap<K, V>;

        fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
            formatter.write_str("a map with unique keys")
        }

        fn visit_map<M>(self, mut access: M) -> Result<Self::Value, M::Error>
        where
            M: serde::de::MapAccess<'de>,
        {
            use std::collections::btree_map::Entry;

            let mut map = BTreeMap::new();
            while let Some((key, value)) = access.next_entry::<K, V>()? {
                match map.entry(key) {
                    Entry::Occupied(entry) => {
                        return Err(serde::de::Error::custom((self.0)(entry.key())));
                    }
                    Entry::Vacant(entry) => {
                        entry.insert(value);
                    }
                }
            }
            Ok(map)
        }
    }

    deserializer.deserialize_map(Visitor(error_msg, std::marker::PhantomData))
}

/// Detect TOML 1.1 specific features in a TOML document.
///
/// Note: This function does _not_ perform any validation.
pub fn has_toml11_features(source: &str) -> bool {
    let tokens: Box<[Token]> = Source::new(source).lex().collect();
    let mut checker = DetectToml11::new(source);
    let mut errors = None;
    parse_document(&tokens, &mut checker, &mut errors);
    checker.is_11()
}

/// Structure state in a TOML document
#[derive(Debug, Copy, Clone)]
enum State {
    /// Regular table (e.g. `[foo]`)
    StdTable,
    /// Array table (e.g. `[[foo]]`)
    ArrayTable,
    /// Inline table (e.g. `{ k = "v" }`
    InlineTable { trailing_sep: bool },
    /// Array (e.g. `[1, 2, 3]`)
    Array,
}

/// Detect TOML 1.1 specific features.
pub struct DetectToml11<'s> {
    /// The underlying TOML source
    source: &'s str,
    /// Current nesting state
    state: Vec<State>,
    /// Set to true when a TOML 1.1 specific feature is seen
    toml11: bool,
}

impl<'s> DetectToml11<'s> {
    fn new(source: &'s str) -> Self {
        Self {
            source,
            state: Vec::new(),
            toml11: false,
        }
    }

    fn raw_at(&self, span: Span) -> &'s str {
        &self.source[span.start()..span.end()]
    }

    fn flag_11(&mut self) {
        self.toml11 = true;
    }

    fn set_sep(&mut self, sep: bool) {
        if let Some(State::InlineTable { trailing_sep }) = self.state.last_mut() {
            *trailing_sep = sep;
        }
    }

    fn is_11(&self) -> bool {
        self.toml11
    }
}

impl EventReceiver for DetectToml11<'_> {
    fn std_table_open(&mut self, _span: Span, _error: &mut dyn ErrorSink) {
        self.state.push(State::StdTable);
    }

    fn std_table_close(&mut self, _span: Span, _error: &mut dyn ErrorSink) {
        self.state.pop();
    }

    fn array_table_open(&mut self, _span: Span, _error: &mut dyn ErrorSink) {
        self.state.push(State::ArrayTable);
    }

    fn array_table_close(&mut self, _span: Span, _error: &mut dyn ErrorSink) {
        self.state.pop();
    }

    fn inline_table_open(&mut self, _span: Span, _error: &mut dyn ErrorSink) -> bool {
        self.state.push(State::InlineTable {
            trailing_sep: false,
        });
        true
    }

    fn inline_table_close(&mut self, _span: Span, _error: &mut dyn ErrorSink) {
        if matches!(
            self.state.last(),
            Some(State::InlineTable { trailing_sep: true })
        ) {
            // TOML 1.1 introduces trailing commas in inline tables
            self.flag_11();
        }
        self.state.pop();
    }

    fn array_open(&mut self, _span: Span, _error: &mut dyn ErrorSink) -> bool {
        self.state.push(State::Array);
        true
    }

    fn array_close(&mut self, _span: Span, _error: &mut dyn ErrorSink) {
        self.state.pop();
    }

    fn simple_key(&mut self, span: Span, kind: Option<Encoding>, _error: &mut dyn ErrorSink) {
        self.set_sep(false);

        if matches!(kind, Some(Encoding::BasicString | Encoding::MlBasicString))
            && has_toml11_escapes(self.raw_at(span))
        {
            // TOML 1.1 introduces new escape sequences
            self.flag_11();
        }
    }

    fn scalar(&mut self, span: Span, kind: Option<Encoding>, _error: &mut dyn ErrorSink) {
        self.set_sep(false);

        if matches!(kind, Some(Encoding::BasicString | Encoding::MlBasicString)) {
            if has_toml11_escapes(self.raw_at(span)) {
                // TOML 1.1 introduces new escape sequences
                self.flag_11();
            }
        } else if has_toml11_optional_second_time(self.raw_at(span)) {
            // TOML 1.1 makes seconds optional in times and datetimes.
            self.flag_11();
        }
    }

    fn value_sep(&mut self, _span: Span, _error: &mut dyn ErrorSink) {
        self.set_sep(true);
    }

    fn newline(&mut self, _span: Span, _error: &mut dyn ErrorSink) {
        if matches!(self.state.last(), Some(State::InlineTable { .. })) {
            // TOML 1.1 introduces newlines in inline tables
            self.flag_11();
        }
    }
}

/// Scan the characters of a snippet of TOML representing a basic string for the TOML 1.1 exclusive
/// escape sequences: `\xHH` and `\e`
fn has_toml11_escapes(raw: &str) -> bool {
    let mut chars = raw.chars();
    while let Some(c) = chars.next() {
        if c == '\\'
            && let Some(c) = chars.next()
            && matches!(c, 'x' | 'e')
        {
            return true;
        }
    }
    false
}

/// Scan for the TOML 1.1 optional-second time syntax, such as `12:34` and `1969-06-20T20:17Z`.
fn has_toml11_optional_second_time(raw: &str) -> bool {
    // Non-datetime scalars, such as booleans and integers, fail to parse as date and/or time.
    let Ok(datetime) = raw.parse::<Datetime>() else {
        return false;
    };

    datetime
        .time
        .as_ref()
        .is_some_and(|time| time.second.is_none())
}

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

    #[test]
    fn escapes_plain_string() {
        assert!(!has_toml11_escapes(r#""hello world""#));
    }

    #[test]
    fn escapes_toml10_escape_n() {
        assert!(!has_toml11_escapes(r#""hello\nworld""#));
    }

    #[test]
    fn escapes_toml10_escape_u() {
        assert!(!has_toml11_escapes(r#""r\u00E9sum\u00E9""#));
    }

    #[test]
    fn escapes_toml11_hex() {
        assert!(has_toml11_escapes(r#""val \x41""#));
    }

    #[test]
    fn escapes_toml11_esc() {
        assert!(has_toml11_escapes(r#""val \e""#));
    }

    #[test]
    fn escapes_double_backslash_e() {
        assert!(!has_toml11_escapes(r#""\\e""#));
    }

    #[test]
    fn escapes_double_backslash_x() {
        assert!(!has_toml11_escapes(r#""\\x41""#));
    }

    #[test]
    fn features_plain_toml10() {
        assert!(!has_toml11_features("x = 1\ny = \"hello\"\nz = true\n"));
    }

    #[test]
    fn features_std_table() {
        assert!(!has_toml11_features(
            "[server]\nhost = \"localhost\"\nport = 8080\n"
        ));
    }

    #[test]
    fn features_array_of_tables() {
        assert!(!has_toml11_features(
            "[[items]]\nname = \"a\"\n[[items]]\nname = \"b\"\n"
        ));
    }

    #[test]
    fn features_inline_table_no_trailing_comma() {
        assert!(!has_toml11_features("x = {a = 1, b = 2}\n"));
    }

    #[test]
    fn features_trailing_comma_in_inline_table() {
        assert!(has_toml11_features("x = {a = 1, b = 2,}\n"));
    }

    #[test]
    fn features_multiline_inline_table() {
        assert!(has_toml11_features("x = {\n  a = 1\n}\n"));
    }

    #[test]
    fn features_multiline_inline_table_with_trailing_comma() {
        assert!(has_toml11_features("x = {\n  a = 1,\n}\n"));
    }

    #[test]
    fn features_hex_escape() {
        assert!(has_toml11_features("x = \"val \\x41\"\n"));
    }

    #[test]
    fn features_hex_escape_in_quoted_key() {
        assert!(has_toml11_features("\"\\x62ar\" = \"baz\"\n"));
    }

    #[test]
    fn features_hex_escape_in_dotted_quoted_key() {
        assert!(has_toml11_features("foo.\"\\x62ar\" = \"baz\"\n"));
    }

    #[test]
    fn features_esc_escape() {
        assert!(has_toml11_features("x = \"val \\e\"\n"));
    }

    #[test]
    fn features_double_backslash_not_escape() {
        assert!(!has_toml11_features("x = \"\\\\e\"\n"));
    }

    #[test]
    fn features_toml10_escape_in_value() {
        assert!(!has_toml11_features("x = \"tab\\there\"\n"));
    }

    #[test]
    fn features_escape_in_nested_structure() {
        assert!(has_toml11_features("[t]\na = {b = \"\\x20\",}\n"));
    }

    #[test]
    fn features_trailing_comma_in_array_is_not_11() {
        assert!(!has_toml11_features("x = [1, 2, 3,]\n"));
    }

    #[test]
    fn features_optional_second_time_values() {
        assert!(has_toml11_features("x = 20:17\n"));
        assert!(has_toml11_features("x = 1969-06-20T20:17\n"));
        assert!(has_toml11_features("x = 1969-06-20 20:17\n"));
        assert!(has_toml11_features("x = 1969-06-20T20:17Z\n"));
        assert!(has_toml11_features("x = 1969-06-20T20:17z\n"));
        assert!(has_toml11_features("x = 1969-06-20T20:17-07:00\n"));
    }

    #[test]
    fn features_toml10_time_values_are_not_11() {
        assert!(!has_toml11_features("x = 20:17:00\n"));
        assert!(!has_toml11_features("x = 1969-06-20T20:17:00Z\n"));
        assert!(!has_toml11_features("x = 1969-06-20\n"));
    }
}