flpdf 0.10.0

A pure-Rust PDF toolkit modeled on qpdf — read, rewrite, linearize, and inspect PDFs.
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
//! Discover resource names through the live `ObjectHandle` content callback
//! route before the exact-byte token filter rewrites source names. A
//! document-owned scan preserves structural errors; only the detached
//! in-memory route converts a structural failure to the byte-preserving
//! `Ok(None)` fallback.
//!
//! qpdf correspondence: `QPDFAcroFormDocumentHelper.cc` `ResourceReplacer`.
//!

use std::collections::BTreeMap;

#[cfg(test)]
use crate::content_stream::{
    parse_content_stream_handles, parse_content_stream_handles_with_recoverable_warnings_and_status,
};
#[cfg(test)]
use crate::object_handle::DocumentResolver;
use crate::object_handle::ObjectHandle;
use crate::pipeline::buffer::Buffer;
#[cfg(test)]
use crate::pipeline::qpdf_tokenizer::QpdfTokenizer;
#[cfg(test)]
use crate::pipeline::Pipeline;
use crate::pipeline::{PipelineError, PipelineResult};
#[cfg(test)]
use crate::resource_finder::ResourceFinder;
use crate::resource_finder::ResourceNamesByType;
use crate::token_filter::{TokenFilter, TokenFilterOutput};
use crate::tokenizer::{Token, TokenType};
#[cfg(test)]
use std::rc::Rc;

pub(crate) type ResourceRenames = BTreeMap<Vec<u8>, BTreeMap<Vec<u8>, Vec<u8>>>;

pub(crate) struct ResourceReplacer {
    offset: usize,
    to_replace: BTreeMap<Vec<u8>, BTreeMap<usize, Vec<u8>>>,
}

fn name_value_from_decoded_body(body: &[u8]) -> Vec<u8> {
    let mut value = Vec::with_capacity(body.len() + 1);
    value.push(b'/');
    value.extend_from_slice(body);
    value
}

fn name_token_from_decoded_body(body: &[u8]) -> Token {
    Token::new(TokenType::Name, name_value_from_decoded_body(body))
}

impl ResourceReplacer {
    pub(crate) fn new(renames: &ResourceRenames, names: &ResourceNamesByType) -> Self {
        let mut to_replace = BTreeMap::new();

        for (resource_type, renamed_names) in renames {
            let Some(names_by_name) = names.get(resource_type) else {
                continue;
            };
            for (old_name, new_name) in renamed_names {
                let Some(offsets) = names_by_name.get(old_name) else {
                    continue;
                };
                let old_token_value = name_value_from_decoded_body(old_name);
                for offset in offsets {
                    to_replace
                        .entry(old_token_value.clone())
                        .or_insert_with(BTreeMap::new)
                        .insert(*offset, new_name.clone());
                }
            }
        }

        Self {
            offset: 0,
            to_replace,
        }
    }

    fn advance_offset(&mut self, length: usize) -> PipelineResult<()> {
        self.offset = self
            .offset
            .checked_add(length)
            .ok_or_else(|| PipelineError::runtime("ResourceReplacer offset overflow"))?;
        Ok(())
    }
}

impl TokenFilter for ResourceReplacer {
    fn handle_token(
        &mut self,
        token: &Token,
        output: &mut TokenFilterOutput<'_>,
    ) -> PipelineResult<()> {
        let replacement = (token.token_type == TokenType::Name)
            .then(|| self.to_replace.get(&token.value))
            .flatten()
            .and_then(|offsets| offsets.get(&self.offset));
        if let Some(new_name) = replacement {
            output.write_token(&name_token_from_decoded_body(new_name))?;
            self.advance_offset(token.raw.len())
        } else {
            self.advance_offset(token.raw.len())?;
            output.write_token(token)
        }
    }
}

#[cfg(test)]
pub(crate) fn replace_resource_names(
    input: &[u8],
    renames: &ResourceRenames,
) -> crate::Result<Option<Vec<u8>>> {
    replace_resource_names_with_context(input, renames, None)
}

#[cfg(test)]
pub(crate) fn replace_resource_names_with_context(
    input: &[u8],
    renames: &ResourceRenames,
    context: Option<Rc<dyn DocumentResolver>>,
) -> crate::Result<Option<Vec<u8>>> {
    if renames.is_empty() {
        return Ok(Some(input.to_vec()));
    }

    let has_document_context = context.is_some();
    let mut finder = ResourceFinder::default();
    let stopped_on_container_eof = match context {
        Some(context) => {
            parse_content_stream_handles(input, Some(context), "", &mut finder)?;
            false
        }
        None => match parse_content_stream_handles_with_recoverable_warnings_and_status(
            input,
            "",
            &mut finder,
        ) {
            Ok(stopped_on_container_eof) => stopped_on_container_eof,
            Err(_) => return Ok(None),
        },
    };
    if !has_document_context && stopped_on_container_eof {
        // The detached/recoverable in-memory route has no qpdf object to
        // retain the parser warning. Keep its historical byte-preserving
        // fallback even though document-owned content parsing now treats this
        // EOF as a warning followed by normal EOF completion.
        return Ok(None);
    }

    Ok(Some(filter_resource_names(
        input,
        renames,
        finder.names_by_resource_type(),
    )?)) // cov:ignore: finite in-memory filtering only fails on impossible token-offset or pipeline overflow
}

/// Run qpdf's `filterAsContents`-shaped ResourceReplacer over an owned stream.
/// The caller must have already parsed the same stream with ResourceFinder so
/// the name offsets come from qpdf's canonical content description.
pub(crate) fn filter_resource_names_from_stream(
    stream: &ObjectHandle,
    renames: &ResourceRenames,
    names: &ResourceNamesByType,
) -> crate::Result<Vec<u8>> {
    let mut buffer = Buffer::new("ResourceReplacer buffer", None);
    let mut replacer = ResourceReplacer::new(renames, names);
    stream.filter_as_contents(&mut replacer, Some(&mut buffer))?;
    Ok(buffer.take_buffer()?)
}

/// Run the exact-byte ResourceReplacer filter over already-decoded content.
/// Parsing and warning delivery are intentionally separate: callers that own
/// a qpdf stream parse it first, then use the decoded bytes here when their
/// surrounding filter pipeline needs a different decode level.
#[cfg(test)]
pub(crate) fn filter_resource_names(
    input: &[u8],
    renames: &ResourceRenames,
    names: &ResourceNamesByType,
) -> crate::Result<Vec<u8>> {
    let mut buffer = Buffer::new("ResourceReplacer buffer", None);
    let mut replacer = ResourceReplacer::new(renames, names);
    let mut tokenizer = QpdfTokenizer::new(
        "ResourceReplacer tokenizer",
        &mut replacer,
        Some(&mut buffer),
    );
    tokenizer.write(input)?;
    tokenizer.finish()?;
    drop(tokenizer);
    Ok(buffer.take_buffer()?)
}

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

    fn font_renames(old_name: &[u8], new_name: &[u8]) -> ResourceRenames {
        let mut renames = ResourceRenames::new();
        renames
            .entry(b"Font".to_vec())
            .or_default()
            .insert(old_name.to_vec(), new_name.to_vec());
        renames
    }

    fn font_names(name: &[u8], offset: usize) -> ResourceNamesByType {
        let mut names = ResourceNamesByType::new();
        names
            .entry(b"Font".to_vec())
            .or_default()
            .insert(name.to_vec(), BTreeSet::from([offset]));
        names
    }

    #[derive(Default)]
    struct FailOnceWriteSink {
        failed: bool,
        bytes: Vec<u8>,
    }

    impl Pipeline for FailOnceWriteSink {
        // cov:ignore-start: mandatory test-sink metadata has no behavioral role
        fn identifier(&self) -> &str {
            "fail-once write sink"
        }
        // cov:ignore-end

        fn write(&mut self, data: &[u8]) -> PipelineResult<()> {
            if !self.failed {
                self.failed = true;
                return Err(PipelineError::logic("sink write failed once"));
            }
            self.bytes.extend_from_slice(data);
            Ok(())
        }

        // cov:ignore-start: mandatory test-sink finish is intentionally a no-op
        fn finish(&mut self) -> PipelineResult<()> {
            Ok(())
        }
        // cov:ignore-end
    }

    #[test]
    fn rewrites_only_name_and_offset_pairs_selected_by_finder() {
        let input = b"/F1 9 Tf /F1 10 Tj /F1 11 Tf";
        let mut renames = ResourceRenames::new();
        renames
            .entry(b"Font".to_vec())
            .or_default()
            .insert(b"F1".to_vec(), b"F A_1".to_vec());
        assert_eq!(
            replace_resource_names(input, &renames).unwrap().unwrap(),
            b"/F#20A_1 9 Tf /F1 10 Tj /F#20A_1 11 Tf"
        );
    }

    #[test]
    fn replacement_length_does_not_shift_source_offset_matching() {
        let input = b"/A 1 Tf /A 2 Tf";
        let mut renames = ResourceRenames::new();
        renames
            .entry(b"Font".to_vec())
            .or_default()
            .insert(b"A".to_vec(), b"MuchLonger".to_vec());
        assert_eq!(
            replace_resource_names(input, &renames).unwrap().unwrap(),
            b"/MuchLonger 1 Tf /MuchLonger 2 Tf"
        );
    }

    #[test]
    fn replacement_preserves_leading_slash_in_decoded_name_body() {
        let renames = font_renames(b"/F", b"/F_1");
        assert_eq!(
            replace_resource_names(b"/#2fF 12 Tf", &renames)
                .unwrap()
                .unwrap(),
            b"/#2fF_1 12 Tf"
        );
    }

    #[test]
    fn non_replacement_write_failure_advances_source_offset_before_retry() {
        let renames = font_renames(b"F", b"G");
        let names = font_names(b"F", 1);
        let mut replacer = ResourceReplacer::new(&renames, &names);
        let mut sink = FailOnceWriteSink::default();
        {
            let mut output = TokenFilterOutput::new(Some(&mut sink));

            assert_eq!(
                replacer
                    .handle_token(&Token::new(TokenType::Word, b"q".to_vec()), &mut output)
                    .unwrap_err()
                    .message(),
                "sink write failed once"
            );
            replacer
                .handle_token(&Token::new(TokenType::Name, b"/F".to_vec()), &mut output)
                .unwrap();
        }

        assert_eq!(sink.bytes, b"/G");
    }

    #[test]
    fn replacement_write_failure_keeps_source_offset_for_retry() {
        let renames = font_renames(b"F", b"G");
        let names = font_names(b"F", 0);
        let mut replacer = ResourceReplacer::new(&renames, &names);
        let mut sink = FailOnceWriteSink::default();
        let token = Token::new(TokenType::Name, b"/F".to_vec());
        {
            let mut output = TokenFilterOutput::new(Some(&mut sink));

            assert_eq!(
                replacer
                    .handle_token(&token, &mut output)
                    .unwrap_err()
                    .message(),
                "sink write failed once"
            );
            replacer.handle_token(&token, &mut output).unwrap();
        }

        assert_eq!(sink.bytes, b"/G");
    }

    #[test]
    fn rewrites_every_supported_resource_operator() {
        let cases = [
            (
                b"ColorSpace".as_slice(),
                b"CS1".as_slice(),
                b"/CS1 CS".as_slice(),
                b"/Renamed CS".as_slice(),
            ),
            (b"ColorSpace", b"CS1", b"/CS1 cs", b"/Renamed cs"),
            (b"ExtGState", b"GS1", b"/GS1 gs", b"/Renamed gs"),
            (b"Font", b"F1", b"/F1 12 Tf", b"/Renamed 12 Tf"),
            (b"Pattern", b"P1", b"/P1 SCN", b"/Renamed SCN"),
            (b"Pattern", b"P1", b"/P1 scn", b"/Renamed scn"),
            (b"Shading", b"Sh1", b"/Sh1 sh", b"/Renamed sh"),
            (b"XObject", b"X1", b"/X1 Do", b"/Renamed Do"),
        ];

        for (resource_type, old_name, input, expected) in cases {
            let mut renames = ResourceRenames::new();
            renames
                .entry(resource_type.to_vec())
                .or_default()
                .insert(old_name.to_vec(), b"Renamed".to_vec());
            assert_eq!(
                replace_resource_names(input, &renames).unwrap().unwrap(),
                expected,
            );
        }
    }

    #[test]
    fn rewrites_properties_name_for_bdc_and_dp() {
        let mut renames = ResourceRenames::new();
        renames
            .entry(b"Properties".to_vec())
            .or_default()
            .insert(b"P1".to_vec(), b"P1_1".to_vec());
        for (input, expected) in [
            (b"/Span /P1 BDC".as_slice(), b"/Span /P1_1 BDC".as_slice()),
            (b"/Span /P1 DP", b"/Span /P1_1 DP"),
        ] {
            assert_eq!(
                replace_resource_names(input, &renames).unwrap().unwrap(),
                expected,
            );
        }
    }

    #[test]
    fn inline_image_payload_and_unselected_tokens_are_byte_identical() {
        let input = b"%c\r\nBI ID /F1 8 Tf EI /F1 9 Tf";
        let renames = font_renames(b"F1", b"F2");
        assert_eq!(
            replace_resource_names(input, &renames).unwrap().unwrap(),
            b"%c\r\nBI ID /F1 8 Tf EI /F2 9 Tf"
        );
    }

    #[test]
    fn recoverable_finder_diagnostic_keeps_later_replacements() {
        let renames = font_renames(b"F1", b"F2");
        assert_eq!(
            replace_resource_names(b"<0g> /F1 9 Tf", &renames)
                .unwrap()
                .unwrap(),
            b"<0g> /F2 9 Tf"
        );
    }

    #[test]
    fn incomplete_inline_image_keeps_prefix_replacement_and_qpdf_separator() {
        let renames = font_renames(b"F1", b"F2");
        assert_eq!(
            replace_resource_names(b"/F1 12 Tf BI ID", &renames)
                .unwrap()
                .unwrap(),
            b"/F2 12 Tf BI ID "
        );
    }

    #[test]
    fn incomplete_inline_image_payload_keeps_prefix_replacement_only() {
        let renames = font_renames(b"F1", b"F2");
        assert_eq!(
            replace_resource_names(b"/F1 12 Tf BI ID /F1 8 Tf", &renames)
                .unwrap()
                .unwrap(),
            b"/F2 12 Tf BI ID /F1 8 Tf"
        );
    }

    #[test]
    fn detached_container_eof_discards_collected_prefix_replacement() {
        let renames = font_renames(b"F1", b"F2");
        assert!(replace_resource_names(b"/F1 12 Tf [", &renames)
            .unwrap()
            .is_none());
    }

    #[test]
    fn detached_hard_parser_error_discards_collected_prefix_replacement() {
        let renames = font_renames(b"F1", b"F2");
        assert!(
            replace_resource_names(b"/F1 12 Tf 999999999999999999999999", &renames)
                .unwrap()
                .is_none()
        );
    }
}