ddex-parser 0.4.5

High-performance DDEX XML parser with SIMD optimization (40+ MB/s)
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
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
// core/src/parser/stream.rs
//! Streaming parser for large DDEX files

use crate::error::ParseError;
use crate::parser::ParseOptions;
use crate::transform::flatten::Flattener;
use crate::utf8_utils;
use ddex_core::models::flat::ParsedERNMessage;
use ddex_core::models::graph::{Deal, ERNMessage, MessageHeader, Party, Release, Resource};
use ddex_core::models::versions::ERNVersion;
use quick_xml::events::Event;
use quick_xml::Reader;
use std::io::BufRead;
use std::time::{Duration, Instant};

/// Progress information for streaming parsing
#[derive(Debug, Clone)]
pub struct ParseProgress {
    pub bytes_processed: u64,
    pub releases_parsed: usize,
    pub resources_parsed: usize,
    pub elapsed: Duration,
    pub estimated_total_bytes: Option<u64>,
}

/// Streaming parser for memory-efficient processing
///
/// Part of the public streaming API for parsing large DDEX files efficiently.
#[allow(dead_code)]
pub struct StreamingParser<R: BufRead> {
    reader: Reader<R>,
    _version: ERNVersion,
    progress_callback: Option<Box<dyn FnMut(ParseProgress) + Send>>,
    start_time: Instant,
    bytes_processed: u64,
    releases_parsed: usize,
    resources_parsed: usize,
    chunk_size: usize,
    max_memory: usize,
    buffer: Vec<u8>,
    current_depth: usize,
    max_depth: usize,
}

impl<R: BufRead> StreamingParser<R> {
    pub fn new(reader: R, version: ERNVersion) -> Self {
        Self::new_with_security_config(
            reader,
            version,
            &crate::parser::security::SecurityConfig::default(),
        )
    }

    pub fn new_with_security_config(
        reader: R,
        version: ERNVersion,
        security_config: &crate::parser::security::SecurityConfig,
    ) -> Self {
        let mut xml_reader = Reader::from_reader(reader);
        xml_reader.config_mut().trim_text(true);
        xml_reader.config_mut().check_end_names = true;
        xml_reader.config_mut().expand_empty_elements = false;

        Self {
            reader: xml_reader,
            _version: version,
            progress_callback: None,
            start_time: Instant::now(),
            bytes_processed: 0,
            releases_parsed: 0,
            resources_parsed: 0,
            chunk_size: 100,
            max_memory: 100 * 1024 * 1024, // 100MB default
            buffer: Vec::with_capacity(8192),
            current_depth: 0,
            max_depth: security_config.max_element_depth,
        }
    }

    pub fn with_progress_callback<F>(mut self, callback: F) -> Self
    where
        F: FnMut(ParseProgress) + Send + 'static,
    {
        self.progress_callback = Some(Box::new(callback));
        self
    }

    pub fn with_chunk_size(mut self, size: usize) -> Self {
        self.chunk_size = size;
        self
    }

    pub fn with_max_memory(mut self, max: usize) -> Self {
        self.max_memory = max;
        self
    }

    fn update_progress(&mut self) {
        if let Some(ref mut callback) = self.progress_callback {
            let progress = ParseProgress {
                bytes_processed: self.bytes_processed,
                releases_parsed: self.releases_parsed,
                resources_parsed: self.resources_parsed,
                elapsed: self.start_time.elapsed(),
                estimated_total_bytes: None,
            };
            callback(progress);
        }
    }

    fn update_byte_position(&mut self) {
        self.bytes_processed = self.reader.buffer_position();
    }

    /// Parse the message header
    pub fn parse_header(&mut self) -> Result<MessageHeader, ParseError> {
        self.buffer.clear();

        // Skip to MessageHeader element
        loop {
            match self.reader.read_event_into(&mut self.buffer) {
                Ok(Event::Start(ref e)) => {
                    self.current_depth += 1;

                    // Check depth limit
                    if self.current_depth > self.max_depth {
                        return Err(ParseError::DepthLimitExceeded {
                            depth: self.current_depth,
                            limit: self.max_depth,
                        });
                    }

                    if e.name().as_ref() == b"MessageHeader" {
                        return self.parse_message_header_element();
                    } else {
                        self.skip_element()?;
                    }
                }
                Ok(Event::End(_)) => {
                    self.current_depth = self.current_depth.saturating_sub(1);
                }
                Ok(Event::Eof) => {
                    return Err(ParseError::XmlError("No MessageHeader found".to_string()));
                }
                Err(e) => {
                    return Err(ParseError::XmlError(e.to_string()));
                }
                _ => {}
            }
            self.buffer.clear();
        }
    }

    fn parse_message_header_element(&mut self) -> Result<MessageHeader, ParseError> {
        use ddex_core::models::graph::{MessageRecipient, MessageSender, MessageType};

        let mut message_id = String::new();
        let message_type = MessageType::NewReleaseMessage;
        let mut created_date_time = chrono::Utc::now();
        let mut sender = MessageSender {
            party_id: Vec::new(),
            party_name: Vec::new(),
            trading_name: None,
            extensions: None,
            attributes: None,
            comments: None,
        };
        let mut recipient = MessageRecipient {
            party_id: Vec::new(),
            party_name: Vec::new(),
            trading_name: None,
            extensions: None,
            attributes: None,
            comments: None,
        };

        self.buffer.clear();
        loop {
            match self.reader.read_event_into(&mut self.buffer) {
                Ok(Event::Start(ref e)) => match e.name().as_ref() {
                    b"MessageId" => {
                        message_id = self.read_text_element()?;
                    }
                    b"MessageCreatedDateTime" => {
                        let text = self.read_text_element()?;
                        created_date_time = chrono::DateTime::parse_from_rfc3339(&text)
                            .map(|dt| dt.with_timezone(&chrono::Utc))
                            .unwrap_or_else(|_| chrono::Utc::now());
                    }
                    b"MessageSender" => {
                        sender = self.parse_message_sender()?;
                    }
                    b"MessageRecipient" => {
                        recipient = self.parse_message_recipient()?;
                    }
                    _ => {
                        self.skip_element()?;
                    }
                },
                Ok(Event::End(ref e)) if e.name().as_ref() == b"MessageHeader" => {
                    break;
                }
                Ok(Event::Eof) => {
                    return Err(ParseError::XmlError("Unexpected EOF in MessageHeader".to_string()));
                }
                Err(e) => {
                    return Err(ParseError::XmlError(format!("XML error at {}: {}",
                        self.get_current_location(), e)));
                }
                _ => {}
            }
            self.buffer.clear();
        }

        Ok(MessageHeader {
            message_id,
            message_type,
            message_created_date_time: created_date_time,
            message_sender: sender,
            message_recipient: recipient,
            message_control_type: None,
            message_thread_id: None,
            extensions: None,
            attributes: None,
            comments: None,
        })
    }

    fn parse_message_sender(
        &mut self,
    ) -> Result<ddex_core::models::graph::MessageSender, ParseError> {
        use ddex_core::models::common::{Identifier, LocalizedString};

        let mut sender = ddex_core::models::graph::MessageSender {
            party_id: Vec::new(),
            party_name: Vec::new(),
            trading_name: None,
            extensions: None,
            attributes: None,
            comments: None,
        };

        self.buffer.clear();
        loop {
            match self.reader.read_event_into(&mut self.buffer) {
                Ok(Event::Start(ref e)) => match e.name().as_ref() {
                    b"PartyId" => {
                        let value = self.read_text_element()?;
                        sender.party_id.push(Identifier {
                            id_type: ddex_core::models::common::IdentifierType::Proprietary,
                            namespace: None,
                            value,
                        });
                    }
                    b"PartyName" => {
                        let text = self.read_text_element()?;
                        sender.party_name.push(LocalizedString::new(text));
                    }
                    _ => {
                        self.skip_element()?;
                    }
                },
                Ok(Event::End(ref e)) if e.name().as_ref() == b"MessageSender" => {
                    break;
                }
                _ => {}
            }
            self.buffer.clear();
        }

        Ok(sender)
    }

    fn parse_message_recipient(
        &mut self,
    ) -> Result<ddex_core::models::graph::MessageRecipient, ParseError> {
        // Similar to parse_message_sender
        use ddex_core::models::common::{Identifier, LocalizedString};

        let mut recipient = ddex_core::models::graph::MessageRecipient {
            party_id: Vec::new(),
            party_name: Vec::new(),
            trading_name: None,
            extensions: None,
            attributes: None,
            comments: None,
        };

        self.buffer.clear();
        loop {
            match self.reader.read_event_into(&mut self.buffer) {
                Ok(Event::Start(ref e)) => match e.name().as_ref() {
                    b"PartyId" => {
                        let value = self.read_text_element()?;
                        recipient.party_id.push(Identifier {
                            id_type: ddex_core::models::common::IdentifierType::Proprietary,
                            namespace: None,
                            value,
                        });
                    }
                    b"PartyName" => {
                        let text = self.read_text_element()?;
                        recipient.party_name.push(LocalizedString::new(text));
                    }
                    _ => {
                        self.skip_element()?;
                    }
                },
                Ok(Event::End(ref e)) if e.name().as_ref() == b"MessageRecipient" => {
                    break;
                }
                _ => {}
            }
            self.buffer.clear();
        }

        Ok(recipient)
    }

    /// Stream releases one at a time for memory efficiency
    pub fn stream_releases(&mut self) -> ReleaseIterator<'_, R> {
        ReleaseIterator::new(self)
    }

    /// Stream resources one at a time
    pub fn stream_resources(&mut self) -> ResourceIterator<'_, R> {
        ResourceIterator::new(self)
    }

    /// Stream parties
    pub fn stream_parties(&mut self) -> PartyIterator<'_, R> {
        PartyIterator::new(self)
    }

    /// Stream deals
    pub fn stream_deals(&mut self) -> DealIterator<'_, R> {
        DealIterator::new(self)
    }

    /// Helper to read text content of current element
    fn read_text_element(&mut self) -> Result<String, ParseError> {
        let mut text = String::new();
        self.buffer.clear();

        loop {
            let event = self.reader.read_event_into(&mut self.buffer);
            match event {
                Ok(Event::Text(e)) => {
                    // Use proper UTF-8 handling from utf8_utils
                    let current_pos = self.reader.buffer_position() as usize;
                    text = utf8_utils::handle_text_node(&e, current_pos)?;
                }
                Ok(Event::End(_)) => {
                    break;
                }
                Ok(Event::Eof) => {
                    let location = self.get_current_location();
                    return Err(ParseError::XmlError("Unexpected EOF".to_string()));
                }
                Err(e) => {
                    let location = self.get_current_location();
                    return Err(ParseError::XmlError(format!("XML error at {}: {}", location, e)));
                }
                _ => {}
            }
            self.buffer.clear();
        }

        Ok(text)
    }

    /// Skip an element and all its children
    fn skip_element(&mut self) -> Result<(), ParseError> {
        let mut local_depth = 1;
        self.buffer.clear();

        while local_depth > 0 {
            match self.reader.read_event_into(&mut self.buffer) {
                Ok(Event::Start(_)) => {
                    local_depth += 1;
                    self.current_depth += 1;

                    // Check depth limit
                    if self.current_depth > self.max_depth {
                        return Err(ParseError::DepthLimitExceeded {
                            depth: self.current_depth,
                            limit: self.max_depth,
                        });
                    }
                }
                Ok(Event::End(_)) => {
                    local_depth -= 1;
                    self.current_depth = self.current_depth.saturating_sub(1);
                }
                Ok(Event::Eof) => break,
                Err(e) => {
                    return Err(ParseError::XmlError( e.to_string()));
                }
                _ => {}
            }
            self.buffer.clear();
        }

        Ok(())
    }

    fn get_current_location(&self) -> String {
        format!("byte offset {} in /NewReleaseMessage", self.reader.buffer_position())
    }
}

/// Iterator for streaming releases
///
/// Part of the public streaming API.
#[allow(dead_code)]
pub struct ReleaseIterator<'a, R: BufRead> {
    parser: &'a mut StreamingParser<R>,
    done: bool,
    in_release_list: bool,
}

impl<'a, R: BufRead> ReleaseIterator<'a, R> {
    fn new(parser: &'a mut StreamingParser<R>) -> Self {
        Self {
            parser,
            done: false,
            in_release_list: false,
        }
    }

    fn find_next_release(&mut self) -> Result<Option<Release>, ParseError> {
        loop {
            self.parser.buffer.clear();
            match self.parser.reader.read_event_into(&mut self.parser.buffer) {
                Ok(Event::Start(ref e)) => match e.name().as_ref() {
                    b"ReleaseList" => {
                        self.in_release_list = true;
                    }
                    b"Release" if self.in_release_list => {
                        return self.parse_release_element();
                    }
                    _ => {
                        self.parser.skip_element()?;
                    }
                },
                Ok(Event::End(ref e)) if e.name().as_ref() == b"ReleaseList" => {
                    self.done = true;
                    return Ok(None);
                }
                Ok(Event::Eof) => {
                    self.done = true;
                    return Ok(None);
                }
                Err(e) => {
                    return Err(ParseError::XmlError( e.to_string()));
                }
                _ => {}
            }
        }
    }

    fn parse_release_element(&mut self) -> Result<Option<Release>, ParseError> {
        use ddex_core::models::common::LocalizedString;

        let mut release = Release {
            release_reference: String::new(),
            release_id: Vec::new(),
            release_title: Vec::new(),
            release_subtitle: None,
            release_type: None,
            genre: Vec::new(),
            release_resource_reference_list: Vec::new(),
            display_artist: Vec::new(),
            party_list: Vec::new(),
            release_date: Vec::new(),
            territory_code: Vec::new(),
            excluded_territory_code: Vec::new(),
            extensions: None,
            attributes: None,
            comments: None,
        };

        self.parser.buffer.clear();
        loop {
            match self.parser.reader.read_event_into(&mut self.parser.buffer) {
                Ok(Event::Start(ref e)) => match e.name().as_ref() {
                    b"ReleaseReference" => {
                        release.release_reference = self.parser.read_text_element()?;
                    }
                    b"ReferenceTitle" | b"Title" => {
                        let text = self.parser.read_text_element()?;
                        release.release_title.push(LocalizedString::new(text));
                    }
                    _ => {
                        self.parser.skip_element()?;
                    }
                },
                Ok(Event::End(ref e)) if e.name().as_ref() == b"Release" => {
                    break;
                }
                _ => {}
            }
            self.parser.buffer.clear();
        }

        self.parser.releases_parsed += 1;
        self.parser.update_byte_position();
        self.parser.update_progress();

        // Check memory limit
        let estimated_size = std::mem::size_of::<Release>() * self.parser.releases_parsed;
        if estimated_size > self.parser.max_memory {
            return Err(ParseError::SecurityViolation {
                message: format!(
                    "Memory limit exceeded: {} > {}",
                    estimated_size, self.parser.max_memory
                ),
            });
        }

        // Yield control periodically
        if self.parser.releases_parsed % self.parser.chunk_size == 0 {
            std::thread::yield_now();
        }

        Ok(Some(release))
    }
}

impl<'a, R: BufRead> Iterator for ReleaseIterator<'a, R> {
    type Item = Result<Release, ParseError>;

    fn next(&mut self) -> Option<Self::Item> {
        if self.done {
            return None;
        }

        match self.find_next_release() {
            Ok(Some(release)) => Some(Ok(release)),
            Ok(None) => None,
            Err(e) => Some(Err(e)),
        }
    }
}

// Similar iterators for other types
pub struct ResourceIterator<'a, R: BufRead> {
    _parser: &'a mut StreamingParser<R>,
    _done: bool,
    _in_resource_list: bool,
}

impl<'a, R: BufRead> ResourceIterator<'a, R> {
    fn new(parser: &'a mut StreamingParser<R>) -> Self {
        Self {
            _parser: parser,
            _done: false,
            _in_resource_list: false,
        }
    }
}

impl<'a, R: BufRead> Iterator for ResourceIterator<'a, R> {
    type Item = Result<Resource, ParseError>;

    fn next(&mut self) -> Option<Self::Item> {
        // Similar implementation to ReleaseIterator
        None // Placeholder
    }
}

pub struct PartyIterator<'a, R: BufRead> {
    _parser: &'a mut StreamingParser<R>,
    _done: bool,
}

impl<'a, R: BufRead> PartyIterator<'a, R> {
    fn new(parser: &'a mut StreamingParser<R>) -> Self {
        Self {
            _parser: parser,
            _done: false,
        }
    }
}

impl<'a, R: BufRead> Iterator for PartyIterator<'a, R> {
    type Item = Result<Party, ParseError>;

    fn next(&mut self) -> Option<Self::Item> {
        None // Placeholder
    }
}

pub struct DealIterator<'a, R: BufRead> {
    _parser: &'a mut StreamingParser<R>,
    _done: bool,
}

impl<'a, R: BufRead> DealIterator<'a, R> {
    fn new(parser: &'a mut StreamingParser<R>) -> Self {
        Self {
            _parser: parser,
            _done: false,
        }
    }
}

impl<'a, R: BufRead> Iterator for DealIterator<'a, R> {
    type Item = Result<Deal, ParseError>;

    fn next(&mut self) -> Option<Self::Item> {
        None // Placeholder
    }
}

/// Parse using streaming for large files
pub fn parse_streaming<R: BufRead>(
    reader: R,
    version: ERNVersion,
    options: ParseOptions,
    security_config: &crate::parser::security::SecurityConfig,
) -> Result<ParsedERNMessage, ParseError> {
    let mut parser = StreamingParser::new_with_security_config(reader, version, security_config)
        .with_chunk_size(options.chunk_size)
        .with_max_memory(options.max_memory);

    // Parse header first
    let message_header = parser.parse_header()?;

    // Collect releases in chunks to limit memory
    let mut releases = Vec::new();
    let mut resources = Vec::new();
    let mut parties = Vec::new();
    let mut deals = Vec::new();

    // Stream releases
    for release_result in parser.stream_releases() {
        let release = release_result?;
        releases.push(release);
    }

    // Stream resources
    for resource_result in parser.stream_resources() {
        let resource = resource_result?;
        resources.push(resource);
    }

    // Stream parties
    for party_result in parser.stream_parties() {
        let party = party_result?;
        parties.push(party);
    }

    // Stream deals
    for deal_result in parser.stream_deals() {
        let deal = deal_result?;
        deals.push(deal);
    }

    // Build ERNMessage
    let graph = ERNMessage {
        message_header,
        parties,
        resources,
        releases,
        deals,
        version,
        profile: None,
        message_audit_trail: None,
        extensions: None,
        legacy_extensions: None,
        comments: None,
        attributes: None,
    };

    // Flatten to developer-friendly model
    let flat = Flattener::flatten(graph.clone());

    Ok(ParsedERNMessage {
        graph,
        flat: flat?,
        extensions: None,
    })
}