precomp2 0.2.0

Reversible preprocessing for compressed and container data.
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
use std::io::{Read, Write};

use crate::{
  error::{Error, Result},
  varint::{read_varint, write_varint},
};

pub const PCF2_MAGIC: &[u8; 4] = b"PCF2";
/// Writers emit v2; sync and async readers accept v1 and v2. Framing and tags
/// through PdfFlate are unchanged; only the new PdfStream tag requires v2.
pub const PCF2_VERSION: u16 = 2;

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[repr(u8)]
pub enum SegmentKind {
  Lit = 0x00,
  Dflt = 0x01,
  Zlib = 0x02,
  Gzip = 0x03,
  PngIdat = 0x04,
  Jpg = 0x05,
  Nested = 0x06,
  Base64 = 0x07,
  Bzip2 = 0x08,
  /// Legacy Flate/predictor/BMP payloads; retained for decoding existing files.
  PdfFlate = 0x09,
  PdfStream = 0x0a,
}

impl SegmentKind {
  pub fn from_u8(value: u8) -> Option<Self> {
    match value {
      0x00 => Some(Self::Lit),
      0x01 => Some(Self::Dflt),
      0x02 => Some(Self::Zlib),
      0x03 => Some(Self::Gzip),
      0x04 => Some(Self::PngIdat),
      0x05 => Some(Self::Jpg),
      0x06 => Some(Self::Nested),
      0x07 => Some(Self::Base64),
      0x08 => Some(Self::Bzip2),
      0x09 => Some(Self::PdfFlate),
      0x0a => Some(Self::PdfStream),
      _ => None,
    }
  }
}

#[derive(Clone, Debug, PartialEq, Eq)]
pub struct Pcf2Header {
  pub version: u16,
  pub flags: u16,
  pub original_size: u64,
  pub header_ext: Vec<u8>,
}

impl Pcf2Header {
  pub fn new(original_size: u64) -> Self {
    Self {
      version: PCF2_VERSION,
      flags: 0,
      original_size,
      header_ext: Vec::new(),
    }
  }

  pub fn encode<W: Write>(&self, mut writer: W) -> Result<()> {
    writer.write_all(PCF2_MAGIC)?;
    writer.write_all(&self.version.to_le_bytes())?;
    writer.write_all(&self.flags.to_le_bytes())?;

    let ext_len: u16 = self.header_ext.len().try_into().map_err(|_| Error::LengthOverflow)?;
    writer.write_all(&ext_len.to_le_bytes())?;
    writer.write_all(&self.original_size.to_le_bytes())?;
    writer.write_all(&self.header_ext)?;
    Ok(())
  }

  pub fn decode<R: Read>(mut reader: R) -> Result<Self> {
    let mut magic = [0u8; 4];
    reader.read_exact(&mut magic)?;
    if &magic != PCF2_MAGIC {
      return Err(Error::InvalidHeader("invalid magic"));
    }

    let mut version = [0u8; 2];
    let mut flags = [0u8; 2];
    let mut ext_len = [0u8; 2];
    let mut original_size = [0u8; 8];

    reader.read_exact(&mut version)?;
    reader.read_exact(&mut flags)?;
    reader.read_exact(&mut ext_len)?;
    reader.read_exact(&mut original_size)?;

    let version = u16::from_le_bytes(version);
    let flags = u16::from_le_bytes(flags);
    let ext_len = u16::from_le_bytes(ext_len) as usize;
    let original_size = u64::from_le_bytes(original_size);

    if !(1..=PCF2_VERSION).contains(&version) {
      return Err(Error::InvalidHeader("unsupported version"));
    }
    if flags != 0 {
      return Err(Error::InvalidHeader("flags must be 0 for v1"));
    }
    if ext_len != 0 {
      return Err(Error::InvalidHeader("header_ext_len must be 0 for v1"));
    }

    let mut header_ext = vec![0u8; ext_len];
    reader.read_exact(&mut header_ext)?;

    Ok(Self {
      version,
      flags,
      original_size,
      header_ext,
    })
  }
}

#[derive(Clone, Debug, PartialEq, Eq)]
pub struct Pcf2Segment {
  pub kind: u8,
  pub flags: u8,
  pub orig_len: u64,
  pub meta: Vec<u8>,
  pub data: Vec<u8>,
}

impl Pcf2Segment {
  pub fn lit(data: Vec<u8>) -> Self {
    Self {
      kind: SegmentKind::Lit as u8,
      flags: 0,
      orig_len: data.len() as u64,
      meta: Vec::new(),
      data,
    }
  }

  pub fn validate(&self) -> Result<()> {
    if self.flags != 0 {
      return Err(Error::InvalidSegment("flags must be 0 for v1"));
    }

    if self.kind == SegmentKind::Lit as u8 {
      if !self.meta.is_empty() {
        return Err(Error::InvalidSegment("lit meta must be empty"));
      }
      if self.orig_len != self.data.len() as u64 {
        return Err(Error::InvalidSegment("lit orig_len must match data_len"));
      }
    }

    if self.kind == SegmentKind::Nested as u8 {
      if self.meta.len() != 1 || self.meta[0] != 0 {
        return Err(Error::InvalidSegment("nested meta_version must be 0"));
      }
      if self.data.len() < PCF2_MAGIC.len() {
        return Err(Error::InvalidSegment("nested data too small"));
      }
      if &self.data[..PCF2_MAGIC.len()] != PCF2_MAGIC {
        return Err(Error::InvalidSegment("nested data missing magic"));
      }
    }

    Ok(())
  }

  pub fn encode<W: Write>(&self, mut writer: W) -> Result<()> {
    self.validate()?;

    writer.write_all(&[self.kind])?;
    writer.write_all(&[self.flags])?;
    write_varint(self.orig_len, &mut writer)?;
    write_varint(self.meta.len() as u64, &mut writer)?;
    write_varint(self.data.len() as u64, &mut writer)?;
    writer.write_all(&self.meta)?;
    writer.write_all(&self.data)?;
    Ok(())
  }
}

#[derive(Clone, Debug, PartialEq, Eq)]
pub struct Pcf2File {
  pub header: Pcf2Header,
  pub segments: Vec<Pcf2Segment>,
}

impl Pcf2File {
  pub fn from_segments(segments: Vec<Pcf2Segment>) -> Self {
    let original_size = segments.iter().map(|segment| segment.orig_len).sum();
    Self {
      header: Pcf2Header::new(original_size),
      segments,
    }
  }

  pub fn encode<W: Write>(&self, mut writer: W) -> Result<()> {
    let total: u64 = self.segments.iter().map(|segment| segment.orig_len).sum();
    if total != self.header.original_size {
      return Err(Error::InvalidHeader("original_size mismatch"));
    }

    self.header.encode(&mut writer)?;
    for segment in &self.segments {
      if self.header.version == 1 && segment.kind == SegmentKind::PdfStream as u8 {
        return Err(Error::InvalidSegment("pdf stream requires v2"));
      }
      segment.encode(&mut writer)?;
    }
    Ok(())
  }

  pub fn decode<R: Read>(reader: R) -> Result<Self> {
    let mut decoder = Pcf2Decoder::new(reader)?;
    let header = decoder.header.clone();
    let mut segments = Vec::new();

    while let Some(segment) = decoder.next_segment()? {
      segments.push(segment.into_segment()?);
    }

    Ok(Self { header, segments })
  }
}

pub struct Pcf2Decoder<R: Read> {
  reader: R,
  header: Pcf2Header,
  remaining_orig: u64,
  finished: bool,
}

impl<R: Read> Pcf2Decoder<R> {
  pub fn new(mut reader: R) -> Result<Self> {
    let header = Pcf2Header::decode(&mut reader)?;
    let remaining_orig = header.original_size;
    Ok(Self {
      reader,
      header,
      remaining_orig,
      finished: false,
    })
  }

  pub fn header(&self) -> &Pcf2Header {
    &self.header
  }

  pub fn next_segment(&mut self) -> Result<Option<Pcf2SegmentReader<'_, R>>> {
    if self.finished {
      return Ok(None);
    }

    let mut kind_buf = [0u8; 1];
    match self.reader.read(&mut kind_buf)? {
      0 => {
        self.finished = true;
        if self.remaining_orig != 0 {
          let actual = self.header.original_size - self.remaining_orig;
          return Err(Error::SizeMismatch {
            expected: self.header.original_size,
            actual,
          });
        }
        return Ok(None);
      }
      1 => {}
      _ => unreachable!(),
    }

    let kind = kind_buf[0];
    if self.header.version == 1 && kind == SegmentKind::PdfStream as u8 {
      return Err(Error::InvalidSegment("pdf stream requires v2"));
    }
    let mut flags = [0u8; 1];
    self.reader.read_exact(&mut flags)?;
    let flags = flags[0];

    let orig_len = read_varint(&mut self.reader)?;
    let meta_len = read_varint(&mut self.reader)?;
    let data_len = read_varint(&mut self.reader)?;

    if flags != 0 {
      return Err(Error::InvalidSegment("flags must be 0 for v1"));
    }

    let meta_len_usize: usize = meta_len.try_into().map_err(|_| Error::LengthOverflow)?;
    let mut meta = Vec::new();
    self.reader.by_ref().take(meta_len).read_to_end(&mut meta)?;
    if meta.len() != meta_len_usize {
      return Err(Error::SizeMismatch {
        expected: meta_len,
        actual: meta.len() as u64,
      });
    }

    if orig_len > self.remaining_orig {
      return Err(Error::InvalidSegment("orig_len exceeds original_size"));
    }
    self.remaining_orig -= orig_len;

    if kind == SegmentKind::Lit as u8 {
      if meta_len != 0 {
        return Err(Error::InvalidSegment("lit meta must be empty"));
      }
      if orig_len != data_len {
        return Err(Error::InvalidSegment("lit orig_len must match data_len"));
      }
    }

    let mut prefix = Vec::new();
    if kind == SegmentKind::Nested as u8 {
      if meta_len != 1 || meta.first() != Some(&0) {
        return Err(Error::InvalidSegment("nested meta_version must be 0"));
      }
      if data_len < PCF2_MAGIC.len() as u64 {
        return Err(Error::InvalidSegment("nested data too small"));
      }
      let mut magic = [0u8; 4];
      self.reader.read_exact(&mut magic)?;
      if &magic != PCF2_MAGIC {
        return Err(Error::InvalidSegment("nested data missing magic"));
      }
      prefix.extend_from_slice(&magic);
    }

    let reader = LimitedReader::new(&mut self.reader, data_len, prefix);
    Ok(Some(Pcf2SegmentReader {
      kind,
      flags,
      orig_len,
      meta,
      data_len,
      data: reader,
    }))
  }
}

pub struct Pcf2SegmentReader<'a, R: Read> {
  pub kind: u8,
  pub flags: u8,
  pub orig_len: u64,
  pub meta: Vec<u8>,
  pub data_len: u64,
  data: LimitedReader<'a, R>,
}

impl<'a, R: Read> Pcf2SegmentReader<'a, R> {
  pub fn data_reader(&mut self) -> &mut LimitedReader<'a, R> {
    &mut self.data
  }

  pub fn read_data_to_vec(&mut self) -> Result<Vec<u8>> {
    let mut out = Vec::new();
    self.data.read_to_end(&mut out)?;
    if out.len() as u64 != self.data_len {
      return Err(Error::SizeMismatch {
        expected: self.data_len,
        actual: out.len() as u64,
      });
    }
    Ok(out)
  }

  pub fn into_segment(mut self) -> Result<Pcf2Segment> {
    let data = self.read_data_to_vec()?;
    let segment = Pcf2Segment {
      kind: self.kind,
      flags: self.flags,
      orig_len: self.orig_len,
      meta: self.meta,
      data,
    };
    segment.validate()?;
    Ok(segment)
  }
}

pub struct LimitedReader<'a, R: Read> {
  reader: &'a mut R,
  remaining: u64,
  prefix: Vec<u8>,
  prefix_pos: usize,
}

impl<'a, R: Read> LimitedReader<'a, R> {
  fn new(reader: &'a mut R, remaining: u64, prefix: Vec<u8>) -> Self {
    Self {
      reader,
      remaining,
      prefix,
      prefix_pos: 0,
    }
  }
}

impl<R: Read> Read for LimitedReader<'_, R> {
  fn read(&mut self, buf: &mut [u8]) -> std::io::Result<usize> {
    if self.remaining == 0 || buf.is_empty() {
      return Ok(0);
    }

    let mut written = 0;
    if self.prefix_pos < self.prefix.len() {
      let available = self.prefix.len() - self.prefix_pos;
      let to_copy = available.min(buf.len()).min(self.remaining as usize);
      buf[..to_copy].copy_from_slice(&self.prefix[self.prefix_pos..self.prefix_pos + to_copy]);
      self.prefix_pos += to_copy;
      self.remaining -= to_copy as u64;
      written += to_copy;
    }

    if written < buf.len() && self.remaining > 0 {
      let max_len = (buf.len() - written).min(self.remaining as usize);
      let read = self.reader.read(&mut buf[written..written + max_len])?;
      self.remaining -= read as u64;
      written += read;
    }

    Ok(written)
  }
}

impl<R: Read> Drop for LimitedReader<'_, R> {
  fn drop(&mut self) {
    let mut sink = [0u8; 4096];
    while self.remaining > 0 {
      let max_len = (self.remaining as usize).min(sink.len());
      match self.read(&mut sink[..max_len]) {
        Ok(0) => break,
        Ok(_) => {}
        Err(_) => break,
      }
    }
  }
}

#[cfg(test)]
mod tests {
  use std::io::Cursor;

  use super::*;

  fn build_nested_segment(payload: &[u8]) -> Pcf2Segment {
    let nested = Pcf2File::from_segments(vec![Pcf2Segment::lit(payload.to_vec())]);
    let mut buf = Vec::new();
    nested.encode(&mut buf).expect("encode nested");
    Pcf2Segment {
      kind: SegmentKind::Nested as u8,
      flags: 0,
      orig_len: nested.header.original_size,
      meta: vec![0],
      data: buf,
    }
  }

  #[test]
  fn header_roundtrip() {
    let header = Pcf2Header::new(123);
    let mut buf = Vec::new();
    header.encode(&mut buf).expect("encode header");
    let decoded = Pcf2Header::decode(buf.as_slice()).expect("decode header");
    assert_eq!(decoded, header);
  }

  #[test]
  fn file_roundtrip_with_nested() {
    let segments = vec![Pcf2Segment::lit(b"hello".to_vec()), build_nested_segment(b"nested")];
    let file = Pcf2File::from_segments(segments);
    let mut buf = Vec::new();
    file.encode(&mut buf).expect("encode file");

    let decoded = Pcf2File::decode(buf.as_slice()).expect("decode file");
    assert_eq!(decoded.header.original_size, file.header.original_size);
    assert_eq!(decoded.segments.len(), 2);
    assert_eq!(decoded.segments[0].data, b"hello");
    assert_eq!(decoded.segments[1].kind, SegmentKind::Nested as u8);
  }

  #[test]
  fn streaming_reader_drains_on_drop() {
    let segments = vec![Pcf2Segment::lit(b"first-segment".to_vec()), Pcf2Segment::lit(b"second".to_vec())];
    let file = Pcf2File::from_segments(segments);
    let mut buf = Vec::new();
    file.encode(&mut buf).expect("encode file");

    let mut decoder = Pcf2Decoder::new(Cursor::new(buf)).expect("decode header");
    let mut first = decoder.next_segment().expect("first segment").expect("first segment");

    let mut tmp = [0u8; 4];
    first.data_reader().read_exact(&mut tmp).expect("read partial");
    drop(first);

    let mut second = decoder.next_segment().expect("second segment").expect("second segment");
    let data = second.read_data_to_vec().expect("read data");
    assert_eq!(data, b"second");
  }

  #[test]
  fn invalid_lit_meta_is_rejected() {
    let header = Pcf2Header::new(1);
    let mut buf = Vec::new();
    header.encode(&mut buf).expect("encode header");

    buf.push(SegmentKind::Lit as u8);
    buf.push(0);
    write_varint(1, &mut buf).expect("orig_len");
    write_varint(1, &mut buf).expect("meta_len");
    write_varint(1, &mut buf).expect("data_len");
    buf.push(1);
    buf.push(2);

    let mut decoder = Pcf2Decoder::new(Cursor::new(buf)).expect("header ok");
    match decoder.next_segment() {
      Ok(_) => panic!("expected error"),
      Err(err) => assert!(matches!(err, Error::InvalidSegment(_))),
    }
  }

  #[test]
  fn oversized_segment_lengths_are_rejected_without_allocation() {
    let header = Pcf2Header::new(1);
    let mut buf = Vec::new();
    header.encode(&mut buf).expect("encode header");
    buf.push(SegmentKind::Dflt as u8);
    buf.push(0);
    write_varint(1, &mut buf).expect("orig_len");
    write_varint(1 << 40, &mut buf).expect("meta_len");
    write_varint(1 << 40, &mut buf).expect("data_len");

    let mut decoder = Pcf2Decoder::new(Cursor::new(buf)).expect("header ok");
    match decoder.next_segment() {
      Ok(_) => panic!("expected error"),
      Err(err) => assert!(matches!(err, Error::SizeMismatch { .. })),
    }
  }

  #[test]
  fn original_size_mismatch_is_rejected() {
    let header = Pcf2Header::new(10);
    let segment = Pcf2Segment::lit(b"abc".to_vec());
    let mut buf = Vec::new();
    header.encode(&mut buf).expect("encode header");
    segment.encode(&mut buf).expect("encode segment");

    let err = Pcf2File::decode(buf.as_slice()).expect_err("expected error");
    assert!(matches!(err, Error::SizeMismatch { .. }));
  }
}