1
/*
2
 * Hurl (https://hurl.dev)
3
 * Copyright (C) 2025 Orange
4
 *
5
 * Licensed under the Apache License, Version 2.0 (the "License");
6
 * you may not use this file except in compliance with the License.
7
 * You may obtain a copy of the License at
8
 *
9
 *          http://www.apache.org/licenses/LICENSE-2.0
10
 *
11
 * Unless required by applicable law or agreed to in writing, software
12
 * distributed under the License is distributed on an "AS IS" BASIS,
13
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
 * See the License for the specific language governing permissions and
15
 * limitations under the License.
16
 *
17
 */
18
use super::placeholder;
19
use crate::ast::{SourceInfo, Template, TemplateElement};
20
use crate::parser::primitives::try_literal;
21
use crate::parser::{string, ParseError, ParseErrorKind, ParseResult};
22
use crate::reader::Reader;
23
use crate::typing::ToSource;
24

            
25
/// Parse a filename with an optional password
26
///
27
/// This is very similar to the filename parser.
28
/// There is still a small different due to the password delimiter ":"
29
/// If the ':' character is part of the filename, it must be escaped.
30
/// While in the standard filename parser, you can not escape this character at all.
31
///
32
65
pub fn parse(reader: &mut Reader) -> ParseResult<Template> {
33
65
    let start = reader.cursor();
34
65

            
35
65
    let mut elements = vec![];
36
    loop {
37
140
        let start = reader.cursor();
38
140
        match placeholder::parse(reader) {
39
30
            Ok(placeholder) => {
40
30
                let element = TemplateElement::Placeholder(placeholder);
41
30
                elements.push(element);
42
            }
43
110
            Err(e) => {
44
110
                if e.recoverable {
45
110
                    let value = filename_password_content(reader)?;
46
110
                    if value.is_empty() {
47
65
                        break;
48
                    }
49
45
                    let source = reader.read_from(start.index).to_source();
50
45
                    let element = TemplateElement::String { value, source };
51
45
                    elements.push(element);
52
                } else {
53
                    return Err(e);
54
                }
55
            }
56
        }
57
    }
58
65
    if elements.is_empty() {
59
        let kind = ParseErrorKind::Filename;
60
        return Err(ParseError::new(start.pos, false, kind));
61
    }
62
65
    if let Some(TemplateElement::String { source, .. }) = elements.first() {
63
40
        if source.starts_with('[') {
64
            let kind = ParseErrorKind::Expecting {
65
                value: "filename".to_string(),
66
            };
67
            return Err(ParseError::new(start.pos, false, kind));
68
        }
69
    }
70

            
71
65
    let end = reader.cursor();
72
65
    let template = Template::new(None, elements, SourceInfo::new(start.pos, end.pos));
73
65
    Ok(template)
74
}
75

            
76
110
fn filename_password_content(reader: &mut Reader) -> ParseResult<String> {
77
110
    let mut s = String::new();
78
    loop {
79
155
        match filename_password_escaped_char(reader) {
80
            Ok(c) => {
81
                // ':' is escaped so that is it not recognized as the password delimiter
82
                // This is not due to Hurl format
83
                if c == ':' {
84
                    s.push('\\');
85
                }
86
                s.push(c);
87
            }
88
155
            Err(e) => {
89
155
                if e.recoverable {
90
155
                    let s2 = filename_password_text(reader);
91
155
                    if s2.is_empty() {
92
110
                        break;
93
45
                    } else {
94
45
                        s.push_str(&s2);
95
                    }
96
                } else {
97
                    return Err(e);
98
                }
99
            }
100
        }
101
    }
102
110
    Ok(s)
103
}
104

            
105
155
fn filename_password_text(reader: &mut Reader) -> String {
106
155
    let mut s = String::new();
107
    loop {
108
985
        let save = reader.cursor();
109
985
        match reader.read() {
110
            None => break,
111
985
            Some(c) => {
112
985
                if ['#', ';', '{', '}', ' ', '\n', '\\'].contains(&c) {
113
155
                    reader.seek(save);
114
155
                    break;
115
830
                } else {
116
830
                    s.push(c);
117
                }
118
            }
119
        }
120
    }
121
155
    s
122
}
123

            
124
155
fn filename_password_escaped_char(reader: &mut Reader) -> ParseResult<char> {
125
155
    try_literal("\\", reader)?;
126
    let start = reader.cursor();
127
    match reader.read() {
128
        Some('\\') => Ok('\\'),
129
        Some('b') => Ok('\x08'),
130
        Some('f') => Ok('\x0c'),
131
        Some('n') => Ok('\n'),
132
        Some('r') => Ok('\r'),
133
        Some('t') => Ok('\t'),
134
        Some('#') => Ok('#'),
135
        Some(';') => Ok(';'),
136
        Some(' ') => Ok(' '),
137
        Some('{') => Ok('{'),
138
        Some('}') => Ok('}'),
139
        Some(':') => Ok(':'),
140
        Some('u') => string::unicode(reader),
141
        _ => Err(ParseError::new(
142
            start.pos,
143
            false,
144
            ParseErrorKind::EscapeChar,
145
        )),
146
    }
147
}
148

            
149
#[cfg(test)]
150
mod tests {
151
    use super::*;
152
    use crate::reader::Pos;
153

            
154
    #[test]
155
    fn test_filename_with_password() {
156
        let mut reader = Reader::new("file\\:123:pwd\\:\\#:");
157
        assert_eq!(
158
            parse(&mut reader).unwrap(),
159
            Template::new(
160
                None,
161
                vec![TemplateElement::String {
162
                    value: "file\\:123:pwd\\:#:".to_string(),
163
                    source: "file\\:123:pwd\\:\\#:".to_source()
164
                }],
165
                SourceInfo::new(Pos::new(1, 1), Pos::new(1, 19)),
166
            )
167
        );
168
        assert_eq!(reader.cursor().index, 18);
169
    }
170

            
171
    #[test]
172
    fn test_parse() {
173
        let mut reader = Reader::new("/etc/client-cert.pem #foo");
174
        assert_eq!(
175
            parse(&mut reader).unwrap(),
176
            Template::new(
177
                None,
178
                vec![TemplateElement::String {
179
                    value: "/etc/client-cert.pem".to_string(),
180
                    source: "/etc/client-cert.pem".to_source()
181
                }],
182
                SourceInfo::new(Pos::new(1, 1), Pos::new(1, 21)),
183
            )
184
        );
185
        assert_eq!(reader.cursor().index, 20);
186
    }
187
}