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
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
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
//! Two-pass fallback processor for non-streamable XPath expressions.
//!
//! When an XPath expression cannot be processed in a single streaming pass
//! (e.g., uses `last()`, backward axes, or complex predicates), this module
//! provides a two-pass approach:
//!
//! 1. **Pass 1**: Parse the document and evaluate XPath to find matching nodes
//! 2. **Pass 2**: Stream through the input, transforming matched nodes

use std::collections::HashSet;
use std::io::Write;

use quick_xml::Reader;
use quick_xml::events::Event;

use crate::document::XmlDocument;
use crate::namespace::Namespace;
use crate::parser::parse;
use crate::serialize::{SerializeOptions, node_to_xml_string_with_options};
use crate::xpath::XPathResult;
use crate::xpath::evaluator::evaluate;

use super::editable::{EditableNode, EditableNodeBuilder};
use super::error::{TransformError, TransformResult};

/// Processes XML using two-pass fallback for non-streamable XPath.
pub fn process_fallback<W, F>(
    input: &str,
    xpath_expr: &str,
    mut transform_fn: F,
    writer: &mut W,
) -> TransformResult<usize>
where
    W: Write,
    F: FnMut(&mut EditableNode),
{
    // Pass 1: Parse document and evaluate XPath
    let doc = parse(input).map_err(|e| TransformError::XmlParse(e.to_string()))?;

    let result =
        evaluate(&doc, xpath_expr).map_err(|e| TransformError::InvalidXPath(e.to_string()))?;

    let matching_node_ids: HashSet<usize> = match result {
        XPathResult::Nodes(nodes) => nodes.iter().map(|n| n.id()).collect(),
        _ => {
            return Err(TransformError::InvalidXPath(
                "XPath must return nodes for transformation".to_string(),
            ));
        }
    };

    if matching_node_ids.is_empty() {
        // No matches, write input unchanged
        writer.write_all(input.as_bytes())?;
        return Ok(0);
    }

    // Pass 2: Stream through and transform matches
    process_with_matches(input, &doc, &matching_node_ids, &mut transform_fn, writer)
}

/// Second pass: stream through input, transforming matched nodes.
fn process_with_matches<W, F>(
    input: &str,
    doc: &XmlDocument,
    matching_ids: &HashSet<usize>,
    transform_fn: &mut F,
    writer: &mut W,
) -> TransformResult<usize>
where
    W: Write,
    F: FnMut(&mut EditableNode),
{
    let mut reader = Reader::from_str(input);
    reader.config_mut().trim_text(false);

    // Track current position in document node IDs
    // This is approximate - we match by structure
    let mut node_stack: Vec<usize> = vec![0]; // Start with document node
    let mut current_child_index: Vec<usize> = vec![0];

    let mut prev_written: usize = 0;
    let mut transform_count: usize = 0;
    let mut buf = Vec::new();

    // Track when we're inside a matched subtree
    let mut in_matched_subtree: Option<(usize, EditableNodeBuilder)> = None;

    loop {
        let before_pos = reader.buffer_position() as usize;

        match reader.read_event_into(&mut buf) {
            Ok(Event::Start(e)) => {
                // Calculate expected node ID based on structure
                let parent_id = *node_stack.last().unwrap_or(&0);
                let child_idx = current_child_index.last().copied().unwrap_or(0);

                // Try to find matching node in document
                let expected_id = find_child_element_id(doc, parent_id, child_idx);

                if let Some((_, ref mut builder)) = in_matched_subtree {
                    // Already in matched subtree, add to builder
                    add_event_to_builder(builder, &Event::Start(e.clone()), input)?;
                } else if let Some(id) = expected_id {
                    if matching_ids.contains(&id) {
                        // Start of a matched node
                        writer.write_all(&input.as_bytes()[prev_written..before_pos])?;

                        let mut builder = EditableNodeBuilder::new();
                        add_event_to_builder(&mut builder, &Event::Start(e.clone()), input)?;
                        in_matched_subtree = Some((id, builder));
                    }
                }

                // Update stack
                if let Some(id) = expected_id {
                    node_stack.push(id);
                }
                if let Some(idx) = current_child_index.last_mut() {
                    *idx += 1;
                }
                current_child_index.push(0);
            }

            Ok(Event::Empty(e)) => {
                let after_pos = reader.buffer_position() as usize;

                let parent_id = *node_stack.last().unwrap_or(&0);
                let child_idx = current_child_index.last().copied().unwrap_or(0);
                let expected_id = find_child_element_id(doc, parent_id, child_idx);

                if let Some((_, ref mut builder)) = in_matched_subtree {
                    add_event_to_builder(builder, &Event::Empty(e.clone()), input)?;
                } else if let Some(id) = expected_id {
                    if matching_ids.contains(&id) {
                        // Matched empty element
                        writer.write_all(&input.as_bytes()[prev_written..before_pos])?;

                        let mut builder = EditableNodeBuilder::new();
                        add_event_to_builder(&mut builder, &Event::Empty(e.clone()), input)?;

                        let mut editable = builder.build()?;
                        transform_fn(&mut editable);
                        transform_count += 1;

                        if !editable.is_removed() {
                            serialize_editable(&editable, writer)?;
                        }

                        prev_written = after_pos;
                    }
                }

                if let Some(idx) = current_child_index.last_mut() {
                    *idx += 1;
                }
            }

            Ok(Event::End(e)) => {
                let after_pos = reader.buffer_position() as usize;

                if let Some((id, mut builder)) = in_matched_subtree.take() {
                    add_event_to_builder(&mut builder, &Event::End(e.clone()), input)?;

                    if builder.is_complete() {
                        // Matched subtree complete
                        let mut editable = builder.build()?;
                        transform_fn(&mut editable);
                        transform_count += 1;

                        if !editable.is_removed() {
                            serialize_editable(&editable, writer)?;
                        }

                        prev_written = after_pos;
                    } else {
                        // Not complete yet, put back
                        in_matched_subtree = Some((id, builder));
                    }
                }

                node_stack.pop();
                current_child_index.pop();
            }

            Ok(Event::Text(e)) => {
                if let Some((_, ref mut builder)) = in_matched_subtree {
                    let text = e
                        .unescape()
                        .map_err(|err| TransformError::XmlParse(err.to_string()))?;
                    builder.text(&text);
                }
            }

            Ok(Event::CData(e)) => {
                if let Some((_, ref mut builder)) = in_matched_subtree {
                    let text = std::str::from_utf8(&e).map_err(TransformError::Utf8)?;
                    builder.cdata(text);
                }
            }

            Ok(Event::Comment(e)) => {
                if let Some((_, ref mut builder)) = in_matched_subtree {
                    let text = std::str::from_utf8(&e).map_err(TransformError::Utf8)?;
                    builder.comment(text);
                }
            }

            Ok(Event::Eof) => {
                writer.write_all(&input.as_bytes()[prev_written..])?;
                break;
            }

            Ok(_) => {}

            Err(e) => {
                return Err(TransformError::XmlParse(format!(
                    "Error at position {}: {:?}",
                    reader.buffer_position(),
                    e
                )));
            }
        }

        buf.clear();
    }

    Ok(transform_count)
}

/// Find the nth child element ID of a parent node.
fn find_child_element_id(doc: &XmlDocument, parent_id: usize, child_index: usize) -> Option<usize> {
    let parent = doc.get_node(parent_id)?;
    let children = parent.get_child_elements();
    children.get(child_index).map(|n| n.id())
}

fn add_event_to_builder(
    builder: &mut EditableNodeBuilder,
    event: &Event,
    _input: &str,
) -> TransformResult<()> {
    match event {
        Event::Start(e) => {
            let name_bytes = e.name();
            let full_name =
                std::str::from_utf8(name_bytes.as_ref()).map_err(TransformError::Utf8)?;

            let (prefix, name) = match full_name.split_once(':') {
                Some((p, n)) => (Some(p), n),
                None => (None, full_name),
            };

            let mut attributes = Vec::new();
            let mut ns_decls = Vec::new();

            for attr in e.attributes().filter_map(|a| a.ok()) {
                let key = std::str::from_utf8(attr.key.as_ref()).map_err(TransformError::Utf8)?;
                let value = attr
                    .unescape_value()
                    .map_err(|err| TransformError::XmlParse(err.to_string()))?;

                if let Some(ns_prefix) = key.strip_prefix("xmlns:") {
                    ns_decls.push(Namespace::new(ns_prefix, value.as_ref()));
                } else if key == "xmlns" {
                    ns_decls.push(Namespace::new("", value.as_ref()));
                } else {
                    attributes.push((key.to_string(), value.to_string()));
                }
            }

            let attr_refs: Vec<(&str, &str)> = attributes
                .iter()
                .map(|(k, v)| (k.as_str(), v.as_str()))
                .collect();

            builder.start_element(name, prefix, None, attr_refs, vec![], ns_decls);
        }

        Event::Empty(e) => {
            // Treat as start + end
            add_event_to_builder(builder, &Event::Start(e.to_owned()), _input)?;
            builder.end_element();
        }

        Event::End(_) => {
            builder.end_element();
        }

        _ => {}
    }

    Ok(())
}

fn serialize_editable<W: Write>(editable: &EditableNode, writer: &mut W) -> TransformResult<()> {
    let root = editable
        .document()
        .get_root_element()
        .map_err(|e| TransformError::Serialization(e.to_string()))?;

    let xml =
        node_to_xml_string_with_options(editable.document(), &root, &SerializeOptions::default())
            .map_err(|e| TransformError::Serialization(e.to_string()))?;

    writer.write_all(xml.as_bytes())?;
    Ok(())
}

/// Processes XML for iteration without transformation (two-pass fallback).
pub fn process_for_each<F>(input: &str, xpath_expr: &str, mut callback: F) -> TransformResult<usize>
where
    F: FnMut(&mut EditableNode),
{
    // Pass 1: Parse document and evaluate XPath
    let doc = parse(input).map_err(|e| TransformError::XmlParse(e.to_string()))?;

    let result =
        evaluate(&doc, xpath_expr).map_err(|e| TransformError::InvalidXPath(e.to_string()))?;

    let matching_node_ids: HashSet<usize> = match result {
        XPathResult::Nodes(nodes) => nodes.iter().map(|n| n.id()).collect(),
        _ => {
            return Err(TransformError::InvalidXPath(
                "XPath must return nodes for iteration".to_string(),
            ));
        }
    };

    if matching_node_ids.is_empty() {
        return Ok(0);
    }

    // Pass 2: Stream through and call callback for matches
    iterate_with_matches(input, &doc, &matching_node_ids, &mut callback)
}

/// Second pass: stream through input, calling callback for matched nodes.
fn iterate_with_matches<F>(
    input: &str,
    doc: &XmlDocument,
    matching_ids: &HashSet<usize>,
    callback: &mut F,
) -> TransformResult<usize>
where
    F: FnMut(&mut EditableNode),
{
    let mut reader = Reader::from_str(input);
    reader.config_mut().trim_text(false);

    let mut node_stack: Vec<usize> = vec![0];
    let mut current_child_index: Vec<usize> = vec![0];
    let mut match_count: usize = 0;
    let mut buf = Vec::new();

    let mut in_matched_subtree: Option<(usize, EditableNodeBuilder)> = None;

    loop {
        match reader.read_event_into(&mut buf) {
            Ok(Event::Start(e)) => {
                let parent_id = *node_stack.last().unwrap_or(&0);
                let child_idx = current_child_index.last().copied().unwrap_or(0);
                let expected_id = find_child_element_id(doc, parent_id, child_idx);

                if let Some((_, ref mut builder)) = in_matched_subtree {
                    add_event_to_builder(builder, &Event::Start(e.clone()), input)?;
                } else if let Some(id) = expected_id {
                    if matching_ids.contains(&id) {
                        let mut builder = EditableNodeBuilder::new();
                        add_event_to_builder(&mut builder, &Event::Start(e.clone()), input)?;
                        in_matched_subtree = Some((id, builder));
                    }
                }

                if let Some(id) = expected_id {
                    node_stack.push(id);
                }
                if let Some(idx) = current_child_index.last_mut() {
                    *idx += 1;
                }
                current_child_index.push(0);
            }

            Ok(Event::Empty(e)) => {
                let parent_id = *node_stack.last().unwrap_or(&0);
                let child_idx = current_child_index.last().copied().unwrap_or(0);
                let expected_id = find_child_element_id(doc, parent_id, child_idx);

                if let Some((_, ref mut builder)) = in_matched_subtree {
                    add_event_to_builder(builder, &Event::Empty(e.clone()), input)?;
                } else if let Some(id) = expected_id {
                    if matching_ids.contains(&id) {
                        let mut builder = EditableNodeBuilder::new();
                        add_event_to_builder(&mut builder, &Event::Empty(e.clone()), input)?;

                        let mut editable = builder.build()?;
                        callback(&mut editable);
                        match_count += 1;
                    }
                }

                if let Some(idx) = current_child_index.last_mut() {
                    *idx += 1;
                }
            }

            Ok(Event::End(e)) => {
                if let Some((id, mut builder)) = in_matched_subtree.take() {
                    add_event_to_builder(&mut builder, &Event::End(e.clone()), input)?;

                    if builder.is_complete() {
                        let mut editable = builder.build()?;
                        callback(&mut editable);
                        match_count += 1;
                    } else {
                        in_matched_subtree = Some((id, builder));
                    }
                }

                node_stack.pop();
                current_child_index.pop();
            }

            Ok(Event::Text(e)) => {
                if let Some((_, ref mut builder)) = in_matched_subtree {
                    let text = e
                        .unescape()
                        .map_err(|err| TransformError::XmlParse(err.to_string()))?;
                    builder.text(&text);
                }
            }

            Ok(Event::CData(e)) => {
                if let Some((_, ref mut builder)) = in_matched_subtree {
                    let text = std::str::from_utf8(&e).map_err(TransformError::Utf8)?;
                    builder.cdata(text);
                }
            }

            Ok(Event::Comment(e)) => {
                if let Some((_, ref mut builder)) = in_matched_subtree {
                    let text = std::str::from_utf8(&e).map_err(TransformError::Utf8)?;
                    builder.comment(text);
                }
            }

            Ok(Event::Eof) => {
                break;
            }

            Ok(_) => {}

            Err(e) => {
                return Err(TransformError::XmlParse(format!(
                    "Error at position {}: {:?}",
                    reader.buffer_position(),
                    e
                )));
            }
        }

        buf.clear();
    }

    Ok(match_count)
}

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

    #[test]
    fn test_fallback_with_last() {
        let input = r#"<root><item>A</item><item>B</item><item>C</item></root>"#;

        let mut output = Vec::new();
        let count = process_fallback(
            input,
            "//item[last()]",
            |node| {
                node.set_attribute("last", "true");
            },
            &mut output,
        )
        .unwrap();

        let result = String::from_utf8(output).unwrap();
        assert_eq!(count, 1);
        // The last item should have the attribute
        assert!(result.contains(r#"last="true""#));
    }

    #[test]
    fn test_fallback_no_match() {
        let input = r#"<root><item>A</item></root>"#;

        let mut output = Vec::new();
        let count = process_fallback(input, "//nonexistent", |_node| {}, &mut output).unwrap();

        let result = String::from_utf8(output).unwrap();
        assert_eq!(count, 0);
        assert_eq!(result, input);
    }
}