babbel_xml 0.2.2

Full-featured XML parser, validator, stringifier, and XPath 1.0 engine in pure Rust
Documentation
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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
//! DTD entity declaration and registration implementation.

use crate::alloc_prelude::*;
use crate::error::{Result, XmlError};
use crate::io::is_valid_xml_char;

use super::XmlParser;

impl<'a> XmlParser<'a> {
    /// Helper registering entity declarations from a DTD text subset.
    pub(crate) fn register_entities_from_text(&mut self, text: &str) -> Result<()> {
        let mut external_entities: Vec<String> = Vec::new();

        for line in text.lines() {
            let trimmed = line.trim();
            if trimmed.starts_with("<!ENTITY") {
                let parts: Vec<&str> = trimmed.split_whitespace().collect();
                if parts.len() >= 3 {
                    let is_param = parts[1] == "%";
                    let (name_idx, val_idx) = if is_param && parts.len() >= 4 {
                        (2, 3)
                    } else {
                        (1, 2)
                    };
                    let ent_name = parts[name_idx];
                    if self.options.namespace_aware && ent_name.contains(':') {
                        return Err(XmlError::SyntaxError {
                            message: format!(
                                "Entity name '{ent_name}' cannot contain a colon in namespace-aware XML"
                            ),
                            line: self.source.line(),
                            col: self.source.col(),
                        });
                    }
                    let is_external = trimmed.contains("SYSTEM") || trimmed.contains("PUBLIC");
                    if is_external {
                        external_entities.push(ent_name.to_string());
                        self.external_entities.push(ent_name.to_string());
                    }
                    if trimmed.contains("NDATA") {
                        self.unparsed_entities.push(ent_name.to_string());
                    }
                    if is_external && !self.options.allow_external_entities {
                        return Err(XmlError::SecurityLimitExceeded(
                            "External entity references in DOCTYPE are forbidden by security policy".into(),
                        ));
                    }
                    if is_external
                        && self.options.allow_external_entities
                        && trimmed.contains("SYSTEM")
                        && !trimmed.contains("NDATA")
                    {
                        let raw_val = parts[val_idx..].join(" ");
                        let sys_val = raw_val
                            .trim_matches(|c| c == '"' || c == '\'' || c == '>' || c == ';')
                            .trim();
                        let file_name = sys_val
                            .strip_prefix("SYSTEM")
                            .unwrap_or(sys_val)
                            .trim()
                            .trim_matches(|c| c == '"' || c == '\'');
                        #[cfg(feature = "std")]
                        {
                            let file_path = if let Some(base) = &self.options.base_dir {
                                std::path::Path::new(base).join(file_name)
                            } else {
                                std::path::PathBuf::from(file_name)
                            };
                            if let Ok(bytes) = std::fs::read(&file_path) {
                                if let Ok((loaded_text, _)) =
                                    babbel_core::encoding::detect_encoding_and_strip_bom(&bytes)
                                {
                                    // XML 1.0 §4.3.4: An XML 1.0 document cannot include external entity with version 1.1
                                    if loaded_text.contains("<?xml")
                                        && (loaded_text.contains("version=\"1.1\"")
                                            || loaded_text.contains("version='1.1'"))
                                    {
                                        return Err(XmlError::SyntaxError {
                                            message: "XML 1.0 document cannot include external entity with version 1.1".into(),
                                            line: self.source.line(),
                                            col: self.source.col(),
                                        });
                                    }
                                    if is_param {
                                        let _ = self.register_entities_from_text(&loaded_text);
                                    }
                                    self.entity_mapper.register(ent_name, &*loaded_text);
                                    continue;
                                }
                            }
                        }
                    }
                    let raw_val = parts[val_idx..].join(" ");
                    let val = raw_val.trim_matches(|c| c == '"' || c == '\'' || c == '>');
                    self.entity_mapper.register(ent_name, val);
                }
            } else if trimmed.starts_with("<!NOTATION") {
                let parts: Vec<&str> = trimmed.split_whitespace().collect();
                if parts.len() >= 2 {
                    let not_name = parts[1];
                    if self.options.namespace_aware && not_name.contains(':') {
                        return Err(XmlError::SyntaxError {
                            message: format!(
                                "Notation name '{not_name}' cannot contain a colon in namespace-aware XML"
                            ),
                            line: self.source.line(),
                            col: self.source.col(),
                        });
                    }
                }
            } else if trimmed.starts_with("<!ATTLIST") {
                // W3C XML 1.0 §3.1: Attribute values must not contain references to external entities
                for ext in &external_entities {
                    let needle = format!("&{ext};");
                    if trimmed.contains(&needle) {
                        return Err(XmlError::SyntaxError {
                            message: format!(
                                "Attribute values must not contain references to external entity '&{ext};'"
                            ),
                            line: self.source.line(),
                            col: self.source.col(),
                        });
                    }
                }
            }
        }
        Ok(())
    }

    pub(crate) fn parse_entity_value(&mut self) -> Result<String> {
        let quote = self
            .source
            .next_char()
            .ok_or_else(|| XmlError::SyntaxError {
                message: "Expected quote for EntityValue".into(),
                line: self.source.line(),
                col: self.source.col(),
            })?;
        if quote != '"' && quote != '\'' {
            return Err(XmlError::SyntaxError {
                message: "EntityValue must be quoted".into(),
                line: self.source.line(),
                col: self.source.col(),
            });
        }
        let mut s = String::new();
        while let Some(ch) = self.source.peek() {
            if ch == quote {
                self.source.next_char();
                return Ok(s);
            }
            if ch == '%' {
                return Err(XmlError::SyntaxError {
                    message: "Parameter-entity references must not occur within markup declarations in the internal DTD subset (WFC: In Subset)".into(),
                    line: self.source.line(),
                    col: self.source.col(),
                });
            } else if ch == '&' {
                self.source.next_char();
                if self.source.consume("#") {
                    let hex = self.source.consume("x");
                    let mut num_str = String::new();
                    while let Some(nc) = self.source.peek() {
                        if (hex && nc.is_ascii_hexdigit()) || (!hex && nc.is_ascii_digit()) {
                            num_str.push(nc);
                            self.source.next_char();
                        } else {
                            break;
                        }
                    }
                    if num_str.is_empty() {
                        return Err(XmlError::SyntaxError {
                            message: "Expected digits in numeric character reference".into(),
                            line: self.source.line(),
                            col: self.source.col(),
                        });
                    }
                    if !self.source.consume(";") {
                        return Err(XmlError::SyntaxError {
                            message: "Expected ';' terminating numeric character reference".into(),
                            line: self.source.line(),
                            col: self.source.col(),
                        });
                    }
                    let codepoint = if hex {
                        u32::from_str_radix(&num_str, 16)
                    } else {
                        num_str.parse::<u32>()
                    };
                    match codepoint {
                        Ok(cp) => {
                            if let Some(c) = char::from_u32(cp) {
                                if !is_valid_xml_char(c) {
                                    return Err(XmlError::SyntaxError {
                                        message: format!(
                                            "Forbidden XML character '\\u{{{:x}}}' in character reference",
                                            cp
                                        ),
                                        line: self.source.line(),
                                        col: self.source.col(),
                                    });
                                }
                                s.push(c);
                            } else {
                                return Err(XmlError::SyntaxError {
                                    message: format!(
                                        "Invalid code point {cp} in character reference"
                                    ),
                                    line: self.source.line(),
                                    col: self.source.col(),
                                });
                            }
                        }
                        Err(_) => {
                            return Err(XmlError::SyntaxError {
                                message: "Malformed numeric character reference".into(),
                                line: self.source.line(),
                                col: self.source.col(),
                            });
                        }
                    }
                } else {
                    s.push('&');
                    let name = self.parse_name()?;
                    if name.is_empty() {
                        return Err(XmlError::SyntaxError {
                            message: "Expected Name in entity reference inside EntityValue".into(),
                            line: self.source.line(),
                            col: self.source.col(),
                        });
                    }
                    s.push_str(&name);
                    if !self.source.consume(";") {
                        return Err(XmlError::SyntaxError {
                            message: "Expected ';' terminating entity reference inside EntityValue"
                                .into(),
                            line: self.source.line(),
                            col: self.source.col(),
                        });
                    }
                    s.push(';');
                }
            } else {
                if !is_valid_xml_char(ch) {
                    return Err(XmlError::SyntaxError {
                        message: format!(
                            "Forbidden XML character '\\u{{{:x}}}' in EntityValue",
                            ch as u32
                        ),
                        line: self.source.line(),
                        col: self.source.col(),
                    });
                }
                self.source.next_char();
                s.push(ch);
            }
        }
        Err(XmlError::SyntaxError {
            message: "Unterminated EntityValue".into(),
            line: self.source.line(),
            col: self.source.col(),
        })
    }

    pub(crate) fn parse_entity_decl(&mut self, subset: &mut String) -> Result<()> {
        if self.source.skip_whitespace() == 0 {
            return Err(XmlError::SyntaxError {
                message: "Whitespace required after '<!ENTITY'".into(),
                line: self.source.line(),
                col: self.source.col(),
            });
        }
        let is_param = if self.source.consume("%") {
            if self.source.skip_whitespace() == 0 {
                return Err(XmlError::SyntaxError {
                    message: "Whitespace required after '%' in parameter entity decl".into(),
                    line: self.source.line(),
                    col: self.source.col(),
                });
            }
            true
        } else {
            false
        };
        let name = self.parse_name()?;
        if name.is_empty() {
            return Err(XmlError::SyntaxError {
                message: "Expected entity name in entity declaration".into(),
                line: self.source.line(),
                col: self.source.col(),
            });
        }
        if self.source.skip_whitespace() == 0 {
            return Err(XmlError::SyntaxError {
                message: "Whitespace required after entity name".into(),
                line: self.source.line(),
                col: self.source.col(),
            });
        }

        if self.source.consume("SYSTEM") {
            if self.source.skip_whitespace() == 0 {
                return Err(XmlError::SyntaxError {
                    message: "Whitespace required after 'SYSTEM'".into(),
                    line: self.source.line(),
                    col: self.source.col(),
                });
            }
            let _sys_lit = self.parse_quoted_string()?;
            self.external_entities.push(name.clone());
            if !is_param {
                let ws = self.source.skip_whitespace();
                if self.source.consume("NDATA") {
                    if ws == 0 {
                        return Err(XmlError::SyntaxError {
                            message: "Whitespace required before 'NDATA'".into(),
                            line: self.source.line(),
                            col: self.source.col(),
                        });
                    }
                    if self.source.skip_whitespace() == 0 {
                        return Err(XmlError::SyntaxError {
                            message: "Whitespace required after 'NDATA'".into(),
                            line: self.source.line(),
                            col: self.source.col(),
                        });
                    }
                    let ndata_name = self.parse_name()?;
                    if ndata_name.is_empty() {
                        return Err(XmlError::SyntaxError {
                            message: "Expected notation name after 'NDATA'".into(),
                            line: self.source.line(),
                            col: self.source.col(),
                        });
                    }
                    self.unparsed_entities.push(name.clone());
                } else if self.source.consume("ndata") {
                    return Err(XmlError::SyntaxError {
                        message: "'NDATA' must be uppercase".into(),
                        line: self.source.line(),
                        col: self.source.col(),
                    });
                }
            } else {
                self.source.skip_whitespace();
                if self.source.consume("NDATA") || self.source.consume("ndata") {
                    return Err(XmlError::SyntaxError {
                        message: "Parameter entities cannot have NDataDecl".into(),
                        line: self.source.line(),
                        col: self.source.col(),
                    });
                }
            }
        } else if self.source.consume("PUBLIC") {
            if self.source.skip_whitespace() == 0 {
                return Err(XmlError::SyntaxError {
                    message: "Whitespace required after 'PUBLIC'".into(),
                    line: self.source.line(),
                    col: self.source.col(),
                });
            }
            let _pub_lit = self.parse_pubid_literal()?;
            if self.source.skip_whitespace() == 0 {
                return Err(XmlError::SyntaxError {
                    message: "Whitespace required between Public ID and System ID".into(),
                    line: self.source.line(),
                    col: self.source.col(),
                });
            }
            let _sys_lit = self.parse_quoted_string()?;
            self.external_entities.push(name.clone());
            if !is_param {
                let ws = self.source.skip_whitespace();
                if self.source.consume("NDATA") {
                    if ws == 0 {
                        return Err(XmlError::SyntaxError {
                            message: "Whitespace required before 'NDATA'".into(),
                            line: self.source.line(),
                            col: self.source.col(),
                        });
                    }
                    if self.source.skip_whitespace() == 0 {
                        return Err(XmlError::SyntaxError {
                            message: "Whitespace required after 'NDATA'".into(),
                            line: self.source.line(),
                            col: self.source.col(),
                        });
                    }
                    let ndata_name = self.parse_name()?;
                    if ndata_name.is_empty() {
                        return Err(XmlError::SyntaxError {
                            message: "Expected notation name after 'NDATA'".into(),
                            line: self.source.line(),
                            col: self.source.col(),
                        });
                    }
                    self.unparsed_entities.push(name.clone());
                } else if self.source.consume("ndata") {
                    return Err(XmlError::SyntaxError {
                        message: "'NDATA' must be uppercase".into(),
                        line: self.source.line(),
                        col: self.source.col(),
                    });
                }
            } else {
                self.source.skip_whitespace();
                if self.source.consume("NDATA") || self.source.consume("ndata") {
                    return Err(XmlError::SyntaxError {
                        message: "Parameter entities cannot have NDataDecl".into(),
                        line: self.source.line(),
                        col: self.source.col(),
                    });
                }
            }
        } else if let Some(ch) = self.source.peek() {
            if ch == '"' || ch == '\'' {
                let val = self.parse_entity_value()?;
                if !is_param {
                    self.entity_mapper.register(&name, &val);
                    subset.push_str(&format!(
                        "<!ENTITY {} \"{}\">",
                        name,
                        val.replace('"', "&quot;")
                    ));
                } else {
                    subset.push_str(&format!(
                        "<!ENTITY % {} \"{}\">",
                        name,
                        val.replace('"', "&quot;")
                    ));
                }
            } else {
                return Err(XmlError::SyntaxError {
                    message: "Expected EntityValue, SYSTEM, or PUBLIC in entity declaration".into(),
                    line: self.source.line(),
                    col: self.source.col(),
                });
            }
        } else {
            return Err(XmlError::SyntaxError {
                message: "Unexpected end of input in entity declaration".into(),
                line: self.source.line(),
                col: self.source.col(),
            });
        }

        self.source.skip_whitespace();
        if !self.source.consume(">") {
            return Err(XmlError::SyntaxError {
                message: "Unclosed ENTITY declaration, expected '>'".into(),
                line: self.source.line(),
                col: self.source.col(),
            });
        }
        Ok(())
    }
}