pdfcrate 0.1.1

A Rust library for creating and manipulating PDF documents
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
//! PDF Document Loader
//!
//! This module handles loading and parsing existing PDF documents.

use std::collections::HashMap;

use crate::error::{Error, Result};
use crate::objects::{PdfDict, PdfObject, PdfRef, PdfStream};
use crate::parser::{Lexer, Parser, XRefEntry, XRefParser, XRefTable};

const MAX_OBJECT_STREAM_OBJECTS: usize = 1_000_000;

/// A loaded PDF document
///
/// This struct represents a PDF document that has been loaded from bytes.
/// It provides lazy object resolution and modification capabilities.
pub struct LoadedDocument {
    /// Raw PDF data
    data: Vec<u8>,
    /// Cross-reference table
    xref: XRefTable,
    /// Cached resolved objects
    cache: HashMap<PdfRef, PdfObject>,
    /// PDF version
    version: String,
}

impl LoadedDocument {
    /// Loads a PDF document from bytes
    pub fn load(data: Vec<u8>) -> Result<Self> {
        // Verify PDF header
        let version = Self::parse_header(&data)?;

        // Parse xref table
        let xref_parser = XRefParser::new(&data);
        let xref = xref_parser.parse_all()?;

        Ok(LoadedDocument {
            data,
            xref,
            cache: HashMap::new(),
            version,
        })
    }

    /// Parses the PDF header and returns the version
    fn parse_header(data: &[u8]) -> Result<String> {
        // PDF header must be in the first 1024 bytes
        let header_data = &data[..std::cmp::min(data.len(), 1024)];

        // Look for %PDF-x.y
        let pdf_marker = b"%PDF-";
        let pos = header_data
            .windows(pdf_marker.len())
            .position(|w| w == pdf_marker)
            .ok_or_else(|| Error::InvalidStructure("Missing PDF header".to_string()))?;

        // Read version
        let version_start = pos + pdf_marker.len();
        let mut version_end = version_start;
        while version_end < header_data.len()
            && (header_data[version_end].is_ascii_digit() || header_data[version_end] == b'.')
        {
            version_end += 1;
        }

        let version = std::str::from_utf8(&header_data[version_start..version_end])
            .map_err(|_| Error::InvalidStructure("Invalid PDF version encoding".to_string()))?
            .to_string();

        Ok(version)
    }

    /// Gets the PDF version
    pub fn version(&self) -> &str {
        &self.version
    }

    /// Gets the number of objects in the xref table
    pub fn object_count(&self) -> usize {
        self.xref.len()
    }

    /// Gets the trailer dictionary
    pub fn trailer(&self) -> Option<&PdfDict> {
        self.xref.trailer()
    }

    /// Gets the catalog (root) object reference
    pub fn catalog_ref(&self) -> Option<PdfRef> {
        self.xref.catalog_ref()
    }

    /// Gets the info dictionary reference
    pub fn info_ref(&self) -> Option<PdfRef> {
        self.xref.info_ref()
    }

    /// Resolves an indirect reference to its object
    pub fn resolve(&mut self, reference: PdfRef) -> Result<&PdfObject> {
        // Check cache first
        if self.cache.contains_key(&reference) {
            return Ok(self.cache.get(&reference).unwrap());
        }

        // Get xref entry
        let entry = self.xref.get(reference.object_number()).ok_or_else(|| {
            Error::MissingObject(format!("Object {} not found", reference.object_number()))
        })?;

        let obj = match entry {
            XRefEntry::InUse { offset, generation } => {
                // Verify generation matches
                if *generation != reference.generation() {
                    return Err(Error::MissingObject(format!(
                        "Object {} generation mismatch: expected {}, got {}",
                        reference.object_number(),
                        generation,
                        reference.generation()
                    )));
                }
                let offset = usize::try_from(*offset).map_err(|_| Error::Parse {
                    message: "Object offset out of range".to_string(),
                    position: self.data.len(),
                })?;
                self.parse_object_at(offset)?
            }
            XRefEntry::Compressed { stream_obj, index } => {
                self.parse_compressed_object(*stream_obj, *index)?
            }
            XRefEntry::Free { .. } => {
                return Err(Error::MissingObject(format!(
                    "Object {} is free",
                    reference.object_number()
                )));
            }
        };

        self.cache.insert(reference, obj);
        Ok(self.cache.get(&reference).unwrap())
    }

    /// Parses an object at the given byte offset
    fn parse_object_at(&self, offset: usize) -> Result<PdfObject> {
        use crate::parser::lexer::Token;

        if offset >= self.data.len() {
            return Err(Error::Parse {
                message: "Object offset beyond end of file".to_string(),
                position: offset,
            });
        }

        let mut lexer = Lexer::new(&self.data[offset..]);

        // Read object number (integer)
        let obj_token = lexer.next_token()?;
        if !matches!(obj_token, Token::Integer(_)) {
            return Err(Error::Parse {
                message: format!("Expected object number, got {:?}", obj_token),
                position: offset,
            });
        }

        // Read generation (integer)
        let gen_token = lexer.next_token()?;
        if !matches!(gen_token, Token::Integer(_)) {
            return Err(Error::Parse {
                message: format!("Expected generation number, got {:?}", gen_token),
                position: offset,
            });
        }

        // Expect 'obj' keyword
        let obj_keyword = lexer.next_token()?;
        if obj_keyword != Token::Obj {
            return Err(Error::Parse {
                message: format!("Expected 'obj' keyword, got {:?}", obj_keyword),
                position: offset,
            });
        }

        // Parse the actual object
        let mut parser = Parser::new(&mut lexer);
        parser.parse_object()
    }

    /// Parses an object from an object stream
    fn parse_compressed_object(&mut self, stream_obj: u32, index: u32) -> Result<PdfObject> {
        // First, resolve the object stream
        let stream_ref = PdfRef::new(stream_obj);
        let stream = self.resolve(stream_ref)?.clone();

        let stream = match stream {
            PdfObject::Stream(s) => s,
            _ => {
                return Err(Error::InvalidStructure(format!(
                    "Object {} is not a stream",
                    stream_obj
                )))
            }
        };

        // Verify it's an object stream
        if stream.dict().get_type() != Some("ObjStm") {
            return Err(Error::InvalidStructure(format!(
                "Object {} is not an object stream",
                stream_obj
            )));
        }

        // Get stream parameters
        let n = stream
            .dict()
            .get_integer("N")
            .ok_or_else(|| Error::InvalidStructure("Object stream missing N".to_string()))?
            .try_into()
            .map_err(|_| Error::InvalidStructure("Object stream N out of range".to_string()))?;

        if n > MAX_OBJECT_STREAM_OBJECTS {
            return Err(Error::InvalidStructure(
                "Object stream too large".to_string(),
            ));
        }

        let first = stream
            .dict()
            .get_integer("First")
            .ok_or_else(|| Error::InvalidStructure("Object stream missing First".to_string()))?
            .try_into()
            .map_err(|_| Error::InvalidStructure("Object stream First out of range".to_string()))?;

        // Decode stream data
        let data = stream.decode()?;

        if first > data.len() {
            return Err(Error::InvalidStructure(
                "Object stream First beyond data length".to_string(),
            ));
        }

        // Parse the header (object numbers and offsets)
        let mut header_lexer = Lexer::new(&data[..first]);
        let mut header_parser = Parser::new(&mut header_lexer);

        let mut obj_offsets: Vec<(u32, usize)> = Vec::with_capacity(n);
        for _ in 0..n {
            let obj_num = header_parser.parse_object()?.as_integer().ok_or_else(|| {
                Error::InvalidStructure("Invalid object stream header".to_string())
            })?;
            let obj_num = u32::try_from(obj_num).map_err(|_| {
                Error::InvalidStructure("Object stream object number out of range".to_string())
            })?;

            let obj_offset = header_parser.parse_object()?.as_integer().ok_or_else(|| {
                Error::InvalidStructure("Invalid object stream header".to_string())
            })?;
            let obj_offset = usize::try_from(obj_offset).map_err(|_| {
                Error::InvalidStructure("Object stream offset out of range".to_string())
            })?;

            obj_offsets.push((obj_num, obj_offset));
        }

        // Find the requested object
        let index = usize::try_from(index)
            .map_err(|_| Error::MissingObject("Object index out of range".to_string()))?;
        if index >= obj_offsets.len() {
            return Err(Error::MissingObject(format!(
                "Object index {} out of range in object stream {}",
                index, stream_obj
            )));
        }

        let (_, obj_offset) = obj_offsets[index];
        let abs_offset = first
            .checked_add(obj_offset)
            .ok_or_else(|| Error::InvalidStructure("Object stream offset overflow".to_string()))?;

        if abs_offset > data.len() {
            return Err(Error::InvalidStructure(
                "Object stream offset beyond data length".to_string(),
            ));
        }

        // Parse the object
        let mut lexer = Lexer::new(&data[abs_offset..]);
        let mut parser = Parser::new(&mut lexer);
        parser.parse_object()
    }

    /// Resolves an object and returns a clone if it's the expected type
    pub fn resolve_dict(&mut self, reference: PdfRef) -> Result<PdfDict> {
        let obj = self.resolve(reference)?.clone();
        match obj {
            PdfObject::Dict(d) => Ok(d),
            _ => Err(Error::InvalidObjectType {
                expected: "dictionary".to_string(),
                actual: obj.type_name().to_string(),
            }),
        }
    }

    /// Resolves an object and returns a clone if it's a stream
    pub fn resolve_stream(&mut self, reference: PdfRef) -> Result<PdfStream> {
        let obj = self.resolve(reference)?.clone();
        match obj {
            PdfObject::Stream(s) => Ok(s),
            _ => Err(Error::InvalidObjectType {
                expected: "stream".to_string(),
                actual: obj.type_name().to_string(),
            }),
        }
    }

    /// Gets the catalog dictionary
    pub fn catalog(&mut self) -> Result<PdfDict> {
        let catalog_ref = self.catalog_ref().ok_or_else(|| {
            Error::InvalidStructure("Missing catalog reference in trailer".to_string())
        })?;
        self.resolve_dict(catalog_ref)
    }

    /// Gets the pages tree root reference
    pub fn pages_ref(&mut self) -> Result<PdfRef> {
        let catalog = self.catalog()?;
        catalog
            .get_ref("Pages")
            .ok_or_else(|| Error::InvalidStructure("Catalog missing Pages".to_string()))
    }

    /// Gets the page count
    pub fn page_count(&mut self) -> Result<usize> {
        let pages_ref = self.pages_ref()?;
        let pages = self.resolve_dict(pages_ref)?;
        let count = pages
            .get_integer("Count")
            .ok_or_else(|| Error::InvalidStructure("Pages missing Count".to_string()))?;
        usize_from_i64(count, "Pages Count")
    }

    /// Gets a specific page by index (0-based)
    pub fn page(&mut self, index: usize) -> Result<PdfDict> {
        let pages_ref = self.pages_ref()?;
        self.find_page(pages_ref, index, &mut 0)
    }

    /// Recursively finds a page in the page tree
    fn find_page(
        &mut self,
        node_ref: PdfRef,
        target_index: usize,
        current_index: &mut usize,
    ) -> Result<PdfDict> {
        let node = self.resolve_dict(node_ref)?;

        match node.get_type() {
            Some("Pages") => {
                // This is a page tree node
                let kids = node
                    .get_array("Kids")
                    .ok_or_else(|| Error::InvalidStructure("Pages missing Kids".to_string()))?
                    .clone();

                for i in 0..kids.len() {
                    let kid_ref = kids
                        .get_reference(i)
                        .ok_or_else(|| Error::InvalidStructure("Invalid Kids entry".to_string()))?;

                    // Check if this is a page or another Pages node
                    let kid = self.resolve_dict(kid_ref)?;

                    match kid.get_type() {
                        Some("Page") => {
                            if *current_index == target_index {
                                return Ok(kid);
                            }
                            *current_index += 1;
                        }
                        Some("Pages") => {
                            let count = match kid.get_integer("Count") {
                                Some(value) => usize_from_i64(value, "Pages Count")?,
                                None => 0,
                            };
                            let next_index = current_index.checked_add(count).ok_or_else(|| {
                                Error::InvalidStructure("Page count overflow".to_string())
                            })?;
                            if target_index < next_index {
                                return self.find_page(kid_ref, target_index, current_index);
                            }
                            *current_index = next_index;
                        }
                        _ => {
                            return Err(Error::InvalidStructure(
                                "Invalid page tree node".to_string(),
                            ))
                        }
                    }
                }

                Err(Error::MissingObject(format!(
                    "Page {} not found",
                    target_index
                )))
            }
            Some("Page") => {
                if *current_index == target_index {
                    Ok(node)
                } else {
                    *current_index += 1;
                    Err(Error::MissingObject(format!(
                        "Page {} not found",
                        target_index
                    )))
                }
            }
            _ => Err(Error::InvalidStructure(
                "Invalid page tree node".to_string(),
            )),
        }
    }

    /// Gets the info dictionary if present
    pub fn info(&mut self) -> Result<Option<PdfDict>> {
        if let Some(info_ref) = self.info_ref() {
            Ok(Some(self.resolve_dict(info_ref)?))
        } else {
            Ok(None)
        }
    }

    /// Gets the document title
    pub fn title(&mut self) -> Result<Option<String>> {
        if let Some(info) = self.info()? {
            if let Some(PdfObject::String(s)) = info.get("Title") {
                return Ok(Some(s.decode_text()));
            }
        }
        Ok(None)
    }

    /// Gets the document author
    pub fn author(&mut self) -> Result<Option<String>> {
        if let Some(info) = self.info()? {
            if let Some(PdfObject::String(s)) = info.get("Author") {
                return Ok(Some(s.decode_text()));
            }
        }
        Ok(None)
    }

    /// Gets the raw PDF data
    pub fn data(&self) -> &[u8] {
        &self.data
    }

    /// Gets the xref table
    pub fn xref(&self) -> &XRefTable {
        &self.xref
    }
}

fn usize_from_i64(value: i64, context: &str) -> Result<usize> {
    if value < 0 {
        return Err(Error::InvalidStructure(format!(
            "{} must be non-negative",
            context
        )));
    }
    usize::try_from(value).map_err(|_| Error::InvalidStructure(format!("{} out of range", context)))
}

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

    #[test]
    fn test_parse_header() {
        let data = b"%PDF-1.7\n%\xE2\xE3\xCF\xD3\n";
        let version = LoadedDocument::parse_header(data).unwrap();
        assert_eq!(version, "1.7");
    }

    #[test]
    fn test_parse_header_1_4() {
        let data = b"%PDF-1.4\n";
        let version = LoadedDocument::parse_header(data).unwrap();
        assert_eq!(version, "1.4");
    }

    #[test]
    fn test_parse_header_invalid() {
        let data = b"Not a PDF file";
        let result = LoadedDocument::parse_header(data);
        assert!(result.is_err());
    }

    #[test]
    fn test_load_generated_pdf() {
        use crate::api::Document;

        // Generate a simple PDF
        let mut doc = Document::new();
        doc.title("Test Document");
        doc.author("Test Author");
        doc.text_at("Hello, World!", [72.0, 700.0]);
        let pdf_data = doc.render().unwrap();

        // Load it back
        let mut loaded = LoadedDocument::load(pdf_data).unwrap();

        // Verify
        assert_eq!(loaded.version(), "1.7");
        assert!(loaded.object_count() > 0);

        // Get page count
        let count = loaded.page_count().unwrap();
        assert_eq!(count, 1);

        // Get page
        let page = loaded.page(0).unwrap();
        assert_eq!(page.get_type(), Some("Page"));
    }

    #[test]
    fn test_load_multi_page_pdf() {
        use crate::api::Document;

        // Generate a multi-page PDF
        let mut doc = Document::new();
        doc.text_at("Page 1", [72.0, 700.0]);
        doc.start_new_page();
        doc.text_at("Page 2", [72.0, 700.0]);
        doc.start_new_page();
        doc.text_at("Page 3", [72.0, 700.0]);
        let pdf_data = doc.render().unwrap();

        // Load it back
        let mut loaded = LoadedDocument::load(pdf_data).unwrap();

        // Verify page count
        let count = loaded.page_count().unwrap();
        assert_eq!(count, 3);

        // Access each page
        for i in 0..3 {
            let page = loaded.page(i).unwrap();
            assert_eq!(page.get_type(), Some("Page"));
        }
    }

    #[test]
    fn test_object_stream_first_out_of_bounds() {
        let mut dict = PdfDict::new();
        dict.set("Type", PdfObject::Name(PdfName::new("ObjStm")));
        dict.set("N", PdfObject::Integer(1));
        dict.set("First", PdfObject::Integer(10));
        let stream = PdfStream::new(dict, b"0 0".to_vec());

        let mut doc = LoadedDocument {
            data: Vec::new(),
            xref: XRefTable::new(),
            cache: HashMap::new(),
            version: "1.7".to_string(),
        };
        doc.cache.insert(PdfRef::new(1), PdfObject::Stream(stream));

        let result = doc.parse_compressed_object(1, 0);
        assert!(result.is_err());
    }
}