fastxml 0.8.1

A fast, memory-efficient XML library with XPath and XSD validation support
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
//! Lazy schema validators that initialize from xsi:schemaLocation.

use std::sync::{Arc, Mutex};

use compact_str::CompactString;

use crate::error::{ErrorLevel, Result, StructuredError, ValidationErrorType};
use crate::event::{XmlEvent, XmlEventHandler};
use crate::schema::fetcher::SchemaFetcher;

use super::streaming::OnePassSchemaValidator;

/// A streaming validator that lazily initializes schema from xsi:schemaLocation.
///
/// On the first StartElement event, this validator extracts xsi:schemaLocation,
/// fetches and compiles the schema, then delegates to [`OnePassSchemaValidator`].
pub struct LazySchemaValidator<F: SchemaFetcher> {
    fetcher: F,
    validator: Option<OnePassSchemaValidator>,
    initialized: bool,
    errors: Vec<StructuredError>,
}

impl<F: SchemaFetcher> LazySchemaValidator<F> {
    /// Creates a new lazy schema validator.
    pub fn new(fetcher: F) -> Self {
        Self {
            fetcher,
            validator: None,
            initialized: false,
            errors: Vec::new(),
        }
    }

    /// Returns collected validation errors.
    pub fn errors(&self) -> &[StructuredError] {
        if let Some(v) = &self.validator {
            v.errors()
        } else {
            &self.errors
        }
    }

    fn initialize_from_attributes(&mut self, attributes: &[(CompactString, CompactString)]) {
        if self.initialized {
            return;
        }
        self.initialized = true;

        // Look for xsi:schemaLocation
        let schema_location = attributes
            .iter()
            .find(|(k, _)| k == "xsi:schemaLocation" || k == "schemaLocation")
            .map(|(_, v)| v.as_str());

        let schema = if let Some(loc_value) = schema_location {
            // Parse schemaLocation value (namespace/URL pairs)
            let parts: Vec<&str> = loc_value.split_whitespace().collect();
            let mut resolver = crate::schema::xsd::SchemaResolver::new(&self.fetcher);
            let mut loaded_any = false;

            // Fetch and resolve all schemaLocation entries with a single resolver
            for chunk in parts.chunks(2) {
                if chunk.len() == 2 {
                    let location = chunk[1];
                    match self.fetcher.fetch(location) {
                        Ok(result) => {
                            match resolver.resolve_entry(&result.content, &result.final_url) {
                                Ok(()) => {
                                    loaded_any = true;
                                }
                                Err(e) => {
                                    self.errors.push(
                                        StructuredError::new(
                                            format!(
                                                "Warning: Failed to parse schema {}: {}",
                                                location, e
                                            ),
                                            ValidationErrorType::SchemaNotFound,
                                        )
                                        .with_level(ErrorLevel::Warning),
                                    );
                                }
                            }
                        }
                        Err(_e) => {
                            // Skip schemas that can't be fetched (may be local paths)
                        }
                    }
                }
            }

            if !loaded_any {
                self.errors.push(
                    StructuredError::new(
                        "No schemas could be loaded from xsi:schemaLocation",
                        ValidationErrorType::SchemaNotFound,
                    )
                    .with_level(ErrorLevel::Warning),
                );
                crate::schema::xsd::create_builtin_schema()
            } else {
                let schemas = resolver.take_all_schemas();
                match crate::schema::xsd::compile_schemas(schemas) {
                    Ok(mut compiled) => {
                        crate::schema::xsd::register_builtin_types(&mut compiled);
                        compiled
                    }
                    Err(e) => {
                        self.errors.push(
                            StructuredError::new(
                                format!("Warning: Failed to compile schemas: {}", e),
                                ValidationErrorType::SchemaNotFound,
                            )
                            .with_level(ErrorLevel::Warning),
                        );
                        crate::schema::xsd::create_builtin_schema()
                    }
                }
            }
        } else {
            crate::schema::xsd::create_builtin_schema()
        };

        self.validator = Some(OnePassSchemaValidator::new(Arc::new(schema)));
    }
}

impl<F: SchemaFetcher + 'static> XmlEventHandler for LazySchemaValidator<F> {
    fn handle(&mut self, event: &XmlEvent) -> Result<()> {
        // Initialize on first StartElement
        if let XmlEvent::StartElement { attributes, .. } = event {
            if !self.initialized {
                self.initialize_from_attributes(attributes);
            }
        }

        // Delegate to inner validator
        if let Some(v) = &mut self.validator {
            v.handle(event)?;
        }

        Ok(())
    }

    fn as_any(self: Box<Self>) -> Box<dyn std::any::Any> {
        self
    }
}

/// Internal validator with shared error collection for streaming validation functions.
pub(crate) struct LazySchemaValidatorWithSharedErrors<F: SchemaFetcher> {
    fetcher: F,
    validator: Option<OnePassSchemaValidator>,
    initialized: bool,
    shared_errors: Arc<Mutex<Vec<StructuredError>>>,
}

impl<F: SchemaFetcher> LazySchemaValidatorWithSharedErrors<F> {
    pub fn new(fetcher: F, shared_errors: Arc<Mutex<Vec<StructuredError>>>) -> Self {
        Self {
            fetcher,
            validator: None,
            initialized: false,
            shared_errors,
        }
    }

    fn initialize_from_attributes(&mut self, attributes: &[(CompactString, CompactString)]) {
        if self.initialized {
            return;
        }
        self.initialized = true;

        // Look for xsi:schemaLocation
        let schema_location = attributes
            .iter()
            .find(|(k, _)| k == "xsi:schemaLocation" || k == "schemaLocation")
            .map(|(_, v)| v.as_str());

        let schema = if let Some(loc_value) = schema_location {
            // Parse schemaLocation value (namespace/URL pairs)
            let parts: Vec<&str> = loc_value.split_whitespace().collect();
            let mut resolver = crate::schema::xsd::SchemaResolver::new(&self.fetcher);
            let mut loaded_any = false;

            // Fetch and resolve all schemaLocation entries with a single resolver
            for chunk in parts.chunks(2) {
                if chunk.len() == 2 {
                    let location = chunk[1];
                    match self.fetcher.fetch(location) {
                        Ok(result) => {
                            match resolver.resolve_entry(&result.content, &result.final_url) {
                                Ok(()) => {
                                    loaded_any = true;
                                }
                                Err(e) => {
                                    self.shared_errors.lock().unwrap().push(
                                        StructuredError::new(
                                            format!(
                                                "Warning: Failed to parse schema {}: {}",
                                                location, e
                                            ),
                                            ValidationErrorType::SchemaNotFound,
                                        )
                                        .with_level(ErrorLevel::Warning),
                                    );
                                }
                            }
                        }
                        Err(_e) => {
                            // Skip schemas that can't be fetched (may be local paths)
                        }
                    }
                }
            }

            if !loaded_any {
                self.shared_errors.lock().unwrap().push(
                    StructuredError::new(
                        "No schemas could be loaded from xsi:schemaLocation",
                        ValidationErrorType::SchemaNotFound,
                    )
                    .with_level(ErrorLevel::Warning),
                );
                crate::schema::xsd::create_builtin_schema()
            } else {
                let schemas = resolver.take_all_schemas();
                match crate::schema::xsd::compile_schemas(schemas) {
                    Ok(mut compiled) => {
                        crate::schema::xsd::register_builtin_types(&mut compiled);
                        compiled
                    }
                    Err(e) => {
                        self.shared_errors.lock().unwrap().push(
                            StructuredError::new(
                                format!("Warning: Failed to compile schemas: {}", e),
                                ValidationErrorType::SchemaNotFound,
                            )
                            .with_level(ErrorLevel::Warning),
                        );
                        crate::schema::xsd::create_builtin_schema()
                    }
                }
            }
        } else {
            crate::schema::xsd::create_builtin_schema()
        };

        self.validator = Some(OnePassSchemaValidator::new(Arc::new(schema)));
    }
}

impl<F: SchemaFetcher + 'static> XmlEventHandler for LazySchemaValidatorWithSharedErrors<F> {
    fn handle(&mut self, event: &XmlEvent) -> Result<()> {
        // Initialize on first StartElement
        if let XmlEvent::StartElement { attributes, .. } = event {
            if !self.initialized {
                self.initialize_from_attributes(attributes);
            }
        }

        // Delegate to inner validator
        if let Some(v) = &mut self.validator {
            v.handle(event)?;
            // Collect validation errors to shared collection
            for err in v.errors() {
                let mut errors = self.shared_errors.lock().unwrap();
                if !errors.iter().any(|e| e.message == err.message) {
                    errors.push(err.clone());
                }
            }
        }

        Ok(())
    }

    fn as_any(self: Box<Self>) -> Box<dyn std::any::Any> {
        self
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::schema::fetcher::NoopFetcher;

    #[test]
    fn test_lazy_validator_new() {
        let fetcher = NoopFetcher;
        let validator = LazySchemaValidator::new(fetcher);
        assert!(validator.errors().is_empty());
    }

    #[test]
    fn test_lazy_validator_no_schema_location() {
        let fetcher = NoopFetcher;
        let mut validator = LazySchemaValidator::new(fetcher);

        // Handle element without schemaLocation
        let _ = validator.handle(&XmlEvent::StartElement {
            name: "root".into(),
            prefix: None,
            namespace: None,
            attributes: vec![],
            namespace_decls: vec![],
            line: None,
            column: Some(1),
        });

        // Should use builtin schema without errors
        assert!(validator.errors().is_empty());
    }

    #[test]
    fn test_lazy_validator_with_shared_errors() {
        let fetcher = NoopFetcher;
        let shared_errors = Arc::new(Mutex::new(Vec::new()));
        let mut validator =
            LazySchemaValidatorWithSharedErrors::new(fetcher, Arc::clone(&shared_errors));

        // Handle element without schemaLocation
        let _ = validator.handle(&XmlEvent::StartElement {
            name: "root".into(),
            prefix: None,
            namespace: None,
            attributes: vec![],
            namespace_decls: vec![],
            line: None,
            column: Some(1),
        });

        let errors = shared_errors.lock().unwrap();
        assert!(errors.is_empty());
    }

    #[test]
    fn test_lazy_schema_validator_errors_empty() {
        let fetcher = NoopFetcher;
        let validator = LazySchemaValidator::new(fetcher);
        assert!(validator.errors().is_empty());
    }

    #[test]
    fn test_lazy_schema_validator_handle_with_schema_location() {
        let fetcher = NoopFetcher;
        let mut validator = LazySchemaValidator::new(fetcher);

        // Handle a start element with xsi:schemaLocation
        // NoopFetcher returns an error, so schema won't be loaded
        let _ = validator.handle(&XmlEvent::StartElement {
            name: "root".into(),
            prefix: None,
            namespace: None,
            attributes: vec![
                (
                    "xmlns:xsi".into(),
                    "http://www.w3.org/2001/XMLSchema-instance".into(),
                ),
                (
                    "xsi:schemaLocation".into(),
                    "http://example.com http://example.com/schema.xsd".into(),
                ),
            ],
            namespace_decls: vec![],
            line: Some(1),
            column: Some(1),
        });

        let _ = validator.handle(&XmlEvent::EndElement {
            name: "root".into(),
            prefix: None,
        });

        let _ = validator.handle(&XmlEvent::Eof);
    }

    #[test]
    fn test_lazy_schema_validator_delegates_to_inner() {
        let fetcher = NoopFetcher;
        let mut validator = LazySchemaValidator::new(fetcher);

        // First element initializes
        let _ = validator.handle(&XmlEvent::StartElement {
            name: "root".into(),
            prefix: None,
            namespace: None,
            attributes: vec![],
            namespace_decls: vec![],
            line: Some(1),
            column: Some(1),
        });

        // Child element should be delegated to inner validator
        let _ = validator.handle(&XmlEvent::StartElement {
            name: "child".into(),
            prefix: None,
            namespace: None,
            attributes: vec![],
            namespace_decls: vec![],
            line: Some(2),
            column: Some(1),
        });

        let _ = validator.handle(&XmlEvent::Text("content".to_string()));

        let _ = validator.handle(&XmlEvent::EndElement {
            name: "child".into(),
            prefix: None,
        });

        let _ = validator.handle(&XmlEvent::EndElement {
            name: "root".into(),
            prefix: None,
        });

        let _ = validator.handle(&XmlEvent::Eof);
    }
}