/
xreftable.go
2377 lines (1914 loc) · 58.6 KB
/
xreftable.go
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
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
Copyright 2018 The pdfcpu Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package pdfcpu
import (
"encoding/hex"
"fmt"
"io"
"io/ioutil"
"os"
"path"
"sort"
"strings"
"time"
"github.com/pdfcpu/pdfcpu/pkg/filter"
"github.com/pdfcpu/pdfcpu/pkg/log"
"github.com/pkg/errors"
)
// XRefTableEntry represents an entry in the PDF cross reference table.
//
// This may wrap a free object, a compressed object or any in use PDF object:
//
// Dict, StreamDict, ObjectStreamDict, PDFXRefStreamDict,
// Array, Integer, Float, Name, StringLiteral, HexLiteral, Boolean
type XRefTableEntry struct {
Free bool
Offset *int64
Generation *int
RefCount int
Object Object
Compressed bool
ObjectStream *int
ObjectStreamInd *int
Valid bool
}
// NewXRefTableEntryGen0 returns a cross reference table entry for an object with generation 0.
func NewXRefTableEntryGen0(obj Object) *XRefTableEntry {
zero := 0
return &XRefTableEntry{Generation: &zero, Object: obj}
}
// NewFreeHeadXRefTableEntry returns the xref table entry for object 0
// which is per definition the head of the free list (list of free objects).
func NewFreeHeadXRefTableEntry() *XRefTableEntry {
freeHeadGeneration := FreeHeadGeneration
zero := int64(0)
return &XRefTableEntry{
Free: true,
Generation: &freeHeadGeneration,
Offset: &zero,
}
}
// Enc wraps around all defined encryption attributes.
type Enc struct {
O, U []byte
OE, UE []byte
Perms []byte
L, P, R, V int
Emd bool // encrypt meta data
ID []byte
}
// XRefTable represents a PDF cross reference table plus stats for a PDF file.
type XRefTable struct {
Table map[int]*XRefTableEntry
Size *int // Object count from PDF trailer dict.
PageCount int // Number of pages.
Root *IndirectRef // Pointer to catalog (reference to root object).
RootDict Dict // Catalog
Names map[string]*Node // Cache for name trees as found in catalog.
Encrypt *IndirectRef // Encrypt dict.
E *Enc
EncKey []byte // Encrypt key.
AES4Strings bool
AES4Streams bool
AES4EmbeddedStreams bool
// PDF Version
HeaderVersion *Version // The PDF version the source is claiming to us as per its header.
RootVersion *Version // Optional PDF version taking precedence over the header version.
// Document information section
ID Array // from trailer
Info *IndirectRef // Infodict (reference to info dict object)
Title string
Subject string
Keywords string
Author string
Creator string
Producer string
CreationDate string
ModDate string
Properties map[string]string
// Linearization section (not yet supported)
OffsetPrimaryHintTable *int64
OffsetOverflowHintTable *int64
LinearizationObjs IntSet
// Offspec section
AdditionalStreams *Array // array of IndirectRef - trailer :e.g., Oasis "Open Doc"
// Statistics
Stats PDFStats
Tagged bool // File is using tags. This is important for ???
// Validation
CurPage int // current page during validation
CurObj int // current object during validation, the last dereferenced object
ValidationMode int // see Configuration
ValidateLinks bool // check for broken links in LinkAnnotations/URIDicts.
Valid bool // true means successful validated against ISO 32000.
URIs map[int]map[string]string // URIs for link checking
Optimized bool
Watermarked bool
}
// NewXRefTable creates a new XRefTable.
func newXRefTable(validationMode int, validateLinks bool) (xRefTable *XRefTable) {
return &XRefTable{
Table: map[int]*XRefTableEntry{},
Names: map[string]*Node{},
Properties: map[string]string{},
LinearizationObjs: IntSet{},
Stats: NewPDFStats(),
ValidationMode: validationMode,
ValidateLinks: validateLinks,
URIs: map[int]map[string]string{},
}
}
// Version returns the PDF version of the PDF writer that created this file.
// Before V1.4 this is the header version.
// Since V1.4 the catalog may contain a Version entry which takes precedence over the header version.
func (xRefTable *XRefTable) Version() Version {
if xRefTable.RootVersion != nil {
return *xRefTable.RootVersion
}
return *xRefTable.HeaderVersion
}
// VersionString return a string representation for this PDF files PDF version.
func (xRefTable *XRefTable) VersionString() string {
return xRefTable.Version().String()
}
// ParseRootVersion returns a string representation for an optional Version entry in the root object.
func (xRefTable *XRefTable) ParseRootVersion() (v *string, err error) {
// Look in the catalog/root for a name entry "Version".
// This entry overrides the header version.
rootDict, err := xRefTable.Catalog()
if err != nil {
return nil, err
}
return rootDict.NameEntry("Version"), nil
}
// ValidateVersion validates against the xRefTable's version.
func (xRefTable *XRefTable) ValidateVersion(element string, sinceVersion Version) error {
if xRefTable.Version() < sinceVersion {
return errors.Errorf("%s: unsupported in version %s\nThis file could be PDF/A compliant but pdfcpu only supports versions <= PDF V1.7\n", element, xRefTable.VersionString())
}
return nil
}
// EnsureVersionForWriting sets the version to the highest supported PDF Version 1.7.
// This is necessary to allow validation after adding features not supported
// by the original version of a document as during watermarking.
func (xRefTable *XRefTable) EnsureVersionForWriting() {
v := V17
xRefTable.RootVersion = &v
}
// IsLinearizationObject returns true if object #i is a a linearization object.
func (xRefTable *XRefTable) IsLinearizationObject(i int) bool {
return xRefTable.LinearizationObjs[i]
}
// LinearizationObjsString returns a formatted string and the number of objs.
func (xRefTable *XRefTable) LinearizationObjsString() (int, string) {
var objs []int
for k := range xRefTable.LinearizationObjs {
if xRefTable.LinearizationObjs[k] {
objs = append(objs, k)
}
}
sort.Ints(objs)
var linObj []string
for _, i := range objs {
linObj = append(linObj, fmt.Sprintf("%d", i))
}
return len(linObj), strings.Join(linObj, ",")
}
// Exists returns true if xRefTable contains an entry for objNumber.
func (xRefTable *XRefTable) Exists(objNr int) bool {
_, found := xRefTable.Table[objNr]
return found
}
// Find returns the XRefTable entry for given object number.
func (xRefTable *XRefTable) Find(objNr int) (*XRefTableEntry, bool) {
e, found := xRefTable.Table[objNr]
if !found {
return nil, false
}
return e, true
}
// FindObject returns the object of the XRefTableEntry for a specific object number.
func (xRefTable *XRefTable) FindObject(objNr int) (Object, error) {
entry, ok := xRefTable.Find(objNr)
if !ok {
return nil, errors.Errorf("FindObject: obj#%d not registered in xRefTable", objNr)
}
return entry.Object, nil
}
// Free returns the cross ref table entry for given number of a free object.
func (xRefTable *XRefTable) Free(objNr int) (*XRefTableEntry, error) {
entry, found := xRefTable.Find(objNr)
if !found {
return nil, nil //errors.Errorf("Free: object #%d not found.", objNr)
}
if !entry.Free {
return nil, errors.Errorf("Free: object #%d found, but not free.", objNr)
}
return entry, nil
}
// NextForFree returns the number of the object the free object with objNumber links to.
// This is the successor of this free object in the free list.
func (xRefTable *XRefTable) NextForFree(objNr int) (int, error) {
entry, err := xRefTable.Free(objNr)
if err != nil {
return 0, err
}
return int(*entry.Offset), nil
}
// FindTableEntryLight returns the XRefTable entry for given object number.
func (xRefTable *XRefTable) FindTableEntryLight(objNr int) (*XRefTableEntry, bool) {
return xRefTable.Find(objNr)
}
// FindTableEntry returns the XRefTable entry for given object and generation numbers.
func (xRefTable *XRefTable) FindTableEntry(objNr int, genNr int) (*XRefTableEntry, bool) {
//fmt.Printf("FindTableEntry: obj#:%d gen:%d \n", objNr, genNr)
entry, found := xRefTable.Find(objNr)
if !found || *entry.Generation != genNr {
return nil, false
}
return entry, found
}
// FindTableEntryForIndRef returns the XRefTable entry for given indirect reference.
func (xRefTable *XRefTable) FindTableEntryForIndRef(ir *IndirectRef) (*XRefTableEntry, bool) {
if ir == nil {
return nil, false
}
return xRefTable.FindTableEntry(ir.ObjectNumber.Value(), ir.GenerationNumber.Value())
}
// InsertNew adds given xRefTableEntry at next new objNumber into the cross reference table.
// Only to be called once an xRefTable has been generated completely and all trailer dicts have been processed.
// xRefTable.Size is the size entry of the first trailer dict processed.
// Called on creation of new object streams.
// Called by InsertAndUseRecycled.
func (xRefTable *XRefTable) InsertNew(xRefTableEntry XRefTableEntry) (objNr int) {
objNr = *xRefTable.Size
xRefTable.Table[objNr] = &xRefTableEntry
*xRefTable.Size++
return
}
// InsertAndUseRecycled adds given xRefTableEntry into the cross reference table utilizing the freelist.
func (xRefTable *XRefTable) InsertAndUseRecycled(xRefTableEntry XRefTableEntry) (objNr int, err error) {
// see 7.5.4 Cross-Reference Table
// Hacky:
// Although we increment the obj generation when recycling objects,
// we always use generation 0 when reusing recycled objects.
// This is because pdfcpu does not reuse objects
// in an incremental fashion like laid out in the PDF spec.
log.Write.Println("InsertAndUseRecycled: begin")
// Get Next free object from freelist.
freeListHeadEntry, err := xRefTable.Free(0)
if err != nil {
return 0, err
}
// If none available, add new object & return.
if *freeListHeadEntry.Offset == 0 {
xRefTableEntry.RefCount = 1
objNr = xRefTable.InsertNew(xRefTableEntry)
log.Write.Printf("InsertAndUseRecycled: end, new objNr=%d\n", objNr)
return objNr, nil
}
// Recycle free object, update free list & return.
objNr = int(*freeListHeadEntry.Offset)
entry, found := xRefTable.FindTableEntryLight(objNr)
if !found {
return 0, errors.Errorf("InsertAndRecycle: no entry for obj #%d\n", objNr)
}
// The new free list head entry becomes the old head entry's successor.
freeListHeadEntry.Offset = entry.Offset
// The old head entry becomes garbage.
entry.Free = false
entry.Offset = nil
// Create a new entry for the recycled object.
// TODO use entrys generation.
xRefTableEntry.RefCount = 1
xRefTable.Table[objNr] = &xRefTableEntry
log.Write.Printf("InsertAndUseRecycled: end, recycled objNr=%d\n", objNr)
return objNr, nil
}
// InsertObject inserts an object into the xRefTable.
func (xRefTable *XRefTable) InsertObject(obj Object) (objNr int, err error) {
xRefTableEntry := NewXRefTableEntryGen0(obj)
xRefTableEntry.RefCount = 1
return xRefTable.InsertNew(*xRefTableEntry), nil
}
// IndRefForNewObject inserts an object into the xRefTable and returns an indirect reference to it.
func (xRefTable *XRefTable) IndRefForNewObject(obj Object) (*IndirectRef, error) {
xRefTableEntry := NewXRefTableEntryGen0(obj)
objNr, err := xRefTable.InsertAndUseRecycled(*xRefTableEntry)
if err != nil {
return nil, err
}
return NewIndirectRef(objNr, *xRefTableEntry.Generation), nil
}
// NewStreamDictForBuf creates a streamDict for buf.
func (xRefTable *XRefTable) NewStreamDictForBuf(buf []byte) (*StreamDict, error) {
sd := StreamDict{
Dict: NewDict(),
Content: buf,
FilterPipeline: []PDFFilter{{Name: filter.Flate, DecodeParms: nil}},
}
sd.InsertName("Filter", filter.Flate)
return &sd, nil
}
// NewStreamDictForFile creates a streamDict for filename.
func (xRefTable *XRefTable) NewStreamDictForFile(filename string) (*StreamDict, error) {
buf, err := ioutil.ReadFile(filename)
if err != nil {
return nil, err
}
return xRefTable.NewStreamDictForBuf(buf)
}
// NewEmbeddedStreamDict creates and returns an embeddedStreamDict containing the bytes represented by r.
func (xRefTable *XRefTable) NewEmbeddedStreamDict(r io.Reader, modDate time.Time) (*IndirectRef, error) {
buf, err := ioutil.ReadAll(r)
if err != nil {
return nil, err
}
sd, err := xRefTable.NewStreamDictForBuf(buf)
if err != nil {
return nil, err
}
sd.InsertName("Type", "EmbeddedFile")
d := NewDict()
d.InsertInt("Size", len(buf))
d.Insert("ModDate", StringLiteral(DateString(modDate)))
sd.Insert("Params", d)
if err = sd.Encode(); err != nil {
return nil, err
}
return xRefTable.IndRefForNewObject(*sd)
}
// NewFileSpectDictForAttachment returns a fileSpecDict for a.
func (xRefTable *XRefTable) NewFileSpectDictForAttachment(a Attachment) (*IndirectRef, error) {
modTime := time.Now()
if a.ModTime != nil {
modTime = *a.ModTime
}
sd, err := xRefTable.NewEmbeddedStreamDict(a, modTime)
if err != nil {
return nil, err
}
d, err := xRefTable.NewFileSpecDict(a.ID, encodeUTF16String(a.ID), a.Desc, *sd)
if err != nil {
return nil, err
}
return xRefTable.IndRefForNewObject(d)
}
// NewEmbeddedFileStreamDict returns an embeddedFileStreamDict containing the file "filename".
func (xRefTable *XRefTable) NewEmbeddedFileStreamDict(filename string) (*IndirectRef, error) {
f, err := os.Open(filename)
if err != nil {
return nil, err
}
defer f.Close()
fi, err := f.Stat()
if err != nil {
return nil, err
}
return xRefTable.NewEmbeddedStreamDict(f, fi.ModTime())
}
// NewSoundStreamDict returns a new sound stream dict.
func (xRefTable *XRefTable) NewSoundStreamDict(filename string, samplingRate int, fileSpecDict Dict) (*IndirectRef, error) {
sd, err := xRefTable.NewStreamDictForFile(filename)
if err != nil {
return nil, err
}
sd.InsertName("Type", "Sound")
sd.InsertInt("R", samplingRate)
sd.InsertInt("C", 2)
sd.InsertInt("B", 8)
sd.InsertName("E", "Signed")
if fileSpecDict != nil {
sd.Insert("F", fileSpecDict)
} else {
sd.Insert("F", StringLiteral(path.Base(filename)))
}
if err = sd.Encode(); err != nil {
return nil, err
}
return xRefTable.IndRefForNewObject(*sd)
}
// NewFileSpecDict creates and returns a new fileSpec dictionary.
func (xRefTable *XRefTable) NewFileSpecDict(f, uf, desc string, indRefStreamDict IndirectRef) (Dict, error) {
d := NewDict()
d.InsertName("Type", "Filespec")
d.InsertString("F", f)
d.InsertString("UF", uf)
efDict := NewDict()
efDict.Insert("F", indRefStreamDict)
efDict.Insert("UF", indRefStreamDict)
d.Insert("EF", efDict)
d.InsertString("Desc", desc)
// CI, optional, collection item dict, since V1.7
// a corresponding collection schema dict in a collection.
ciDict := NewDict()
//add contextual meta info here.
d.Insert("CI", ciDict)
return d, nil
}
func (xRefTable *XRefTable) freeObjects() IntSet {
m := IntSet{}
for k, v := range xRefTable.Table {
if v.Free && k > 0 {
m[k] = true
}
}
return m
}
// EnsureValidFreeList ensures the integrity of the free list associated with the recorded free objects.
// See 7.5.4 Cross-Reference Table
func (xRefTable *XRefTable) EnsureValidFreeList() error {
log.Trace.Println("EnsureValidFreeList begin")
m := xRefTable.freeObjects()
// Verify free object 0 as free list head.
head, err := xRefTable.Free(0)
if err != nil {
return err
}
if head == nil {
g0 := FreeHeadGeneration
z := int64(0)
head = &XRefTableEntry{Free: true, Offset: &z, Generation: &g0}
xRefTable.Table[0] = head
}
// verify generation of 56535
if *head.Generation != FreeHeadGeneration {
// Fix generation for obj 0.
*head.Generation = FreeHeadGeneration
}
if len(m) == 0 {
// no free object other than 0.
// repair if necessary
if *head.Offset != 0 {
*head.Offset = 0
}
log.Trace.Println("EnsureValidFreeList: empty free list.")
return nil
}
e := head
f := int(*e.Offset)
// until we have found the last free object which should point to obj 0.
for f != 0 {
log.Trace.Printf("EnsureValidFreeList: validating obj #%d %v\n", f, m)
// verify if obj f is one of the free objects recorded.
if !m[f] {
if len(m) > 0 {
return errors.New("pdfcpu: ensureValidFreeList: freelist corrupted")
}
// Repair last entry.
*e.Offset = 0
break
}
delete(m, f)
e, err = xRefTable.Free(f)
if err != nil {
return err
}
f = int(*e.Offset)
}
if len(m) == 0 {
log.Trace.Println("EnsureValidFreeList: end, regular linked list")
return nil
}
// insert remaining free objects into verified linked list
// unless they are forever deleted with generation 65535.
// In that case they have to point to obj 0.
for i := range m {
entry, found := xRefTable.FindTableEntryLight(i)
if !found {
return errors.Errorf("pdfcpu: ensureValidFreeList: no xref entry found for obj #%d\n", i)
}
if !entry.Free {
return errors.Errorf("pdfcpu: ensureValidFreeList: xref entry is not free for obj #%d\n", i)
}
if *entry.Generation == FreeHeadGeneration {
zero := int64(0)
entry.Offset = &zero
continue
}
entry.Offset = head.Offset
next := int64(i)
head.Offset = &next
}
log.Trace.Println("EnsureValidFreeList: end, linked list plus some dangling free objects.")
return nil
}
func (xRefTable *XRefTable) deleteDictEntry(d Dict, key string) error {
o, found := d.Find(key)
if !found {
return nil
}
if err := xRefTable.deleteObject(o); err != nil {
return err
}
d.Delete(key)
return nil
}
func (xRefTable *XRefTable) locateObjForIndRef(ir IndirectRef) (Object, error) {
var err error
objNr := int(ir.ObjectNumber)
entry, found := xRefTable.FindTableEntryLight(objNr)
if !found {
return nil, errors.Errorf("pdfcpu: locateObjForIndRef: no xref entry found for obj #%d\n", objNr)
}
if entry.RefCount > 1 {
entry.RefCount--
//fmt.Printf("locateObjForIndRef(%d): new refcount: %d\n", objNr, entry.RefCount)
return nil, nil
}
o, err := xRefTable.Dereference(ir)
if err != nil || o == nil {
return o, err
}
if err = xRefTable.DeleteObject(objNr); err != nil {
return nil, err
}
return o, nil
}
func (xRefTable *XRefTable) deleteObject(o Object) error {
var err error
ir, ok := o.(IndirectRef)
if ok {
o, err = xRefTable.locateObjForIndRef(ir)
if err != nil || o == nil {
return err
}
}
switch o := o.(type) {
case Dict:
for _, v := range o {
err := xRefTable.deleteObject(v)
if err != nil {
return err
}
}
case StreamDict:
for _, v := range o.Dict {
err := xRefTable.deleteObject(v)
if err != nil {
return err
}
}
case Array:
for _, v := range o {
err := xRefTable.deleteObject(v)
if err != nil {
return err
}
}
}
return nil
}
// DeleteObjectGraph deletes all objects reachable by indRef.
func (xRefTable *XRefTable) DeleteObjectGraph(o Object) error {
log.Debug.Println("DeleteObjectGraph: begin")
ir, ok := o.(IndirectRef)
if !ok {
return nil
}
// Delete ObjectGraph for object indRef.ObjectNumber.Value() via recursion.
if err := xRefTable.deleteObject(ir); err != nil {
return err
}
log.Debug.Println("DeleteObjectGraph: end")
return nil
}
// DeleteObject marks an object as free and inserts it into the free list right after the head.
func (xRefTable *XRefTable) DeleteObject(objNr int) error {
// see 7.5.4 Cross-Reference Table
log.Debug.Printf("DeleteObject: begin %d\n", objNr)
freeListHeadEntry, err := xRefTable.Free(0)
if err != nil {
return err
}
entry, found := xRefTable.FindTableEntryLight(objNr)
if !found {
return errors.Errorf("pdfcpu: deleteObject: no entry for obj #%d\n", objNr)
}
if entry.Free {
log.Debug.Printf("DeleteObject: end %d already free\n", objNr)
return nil
}
*entry.Generation++
entry.Free = true
entry.Compressed = false
entry.Offset = freeListHeadEntry.Offset
entry.Object = nil
entry.RefCount = 0
next := int64(objNr)
freeListHeadEntry.Offset = &next
log.Debug.Printf("DeleteObject: end %d\n", objNr)
return nil
}
// UndeleteObject ensures an object is not recorded in the free list.
// e.g. sometimes caused by indirect references to free objects in the original PDF file.
func (xRefTable *XRefTable) UndeleteObject(objectNumber int) error {
log.Debug.Printf("UndeleteObject: begin %d\n", objectNumber)
f, err := xRefTable.Free(0)
if err != nil {
return err
}
// until we have found the last free object which should point to obj 0.
for *f.Offset != 0 {
objNr := int(*f.Offset)
entry, err := xRefTable.Free(objNr)
if err != nil {
return err
}
if objNr == objectNumber {
log.Debug.Printf("UndeleteObject end: undeleting obj#%d\n", objectNumber)
*f.Offset = *entry.Offset
entry.Offset = nil
if *entry.Generation > 0 {
*entry.Generation--
}
entry.Free = false
return nil
}
f = entry
}
log.Debug.Printf("UndeleteObject: end: obj#%d not in free list.\n", objectNumber)
return nil
}
// indRefToObject dereferences an indirect object from the xRefTable and returns the result.
func (xRefTable *XRefTable) indRefToObject(ir *IndirectRef) (Object, error) {
if ir == nil {
return nil, errors.New("pdfcpu: indRefToObject: input argument is nil")
}
// 7.3.10
// An indirect reference to an undefined object shall not be considered an error by a conforming reader;
// it shall be treated as a reference to the null object.
entry, found := xRefTable.FindTableEntryForIndRef(ir)
if !found || entry.Free {
return nil, nil
}
xRefTable.CurObj = int(ir.ObjectNumber)
// return dereferenced object
return entry.Object, nil
}
// Dereference resolves an indirect object and returns the resulting PDF object.
func (xRefTable *XRefTable) Dereference(o Object) (Object, error) {
ir, ok := o.(IndirectRef)
if !ok {
// Nothing do dereference.
return o, nil
}
return xRefTable.indRefToObject(&ir)
}
// DereferenceBoolean resolves and validates a boolean object, which may be an indirect reference.
func (xRefTable *XRefTable) DereferenceBoolean(o Object, sinceVersion Version) (*Boolean, error) {
o, err := xRefTable.Dereference(o)
if err != nil || o == nil {
return nil, err
}
b, ok := o.(Boolean)
if !ok {
return nil, errors.Errorf("pdfcpu: dereferenceBoolean: wrong type <%v>", o)
}
// Version check
if err = xRefTable.ValidateVersion("DereferenceBoolean", sinceVersion); err != nil {
return nil, err
}
return &b, nil
}
// DereferenceInteger resolves and validates an integer object, which may be an indirect reference.
func (xRefTable *XRefTable) DereferenceInteger(o Object) (*Integer, error) {
o, err := xRefTable.Dereference(o)
if err != nil || o == nil {
return nil, err
}
i, ok := o.(Integer)
if !ok {
return nil, errors.Errorf("pdfcpu: dereferenceInteger: wrong type <%v>", o)
}
return &i, nil
}
// DereferenceNumber resolves a number object, which may be an indirect reference and returns a float64.
func (xRefTable *XRefTable) DereferenceNumber(o Object) (float64, error) {
var (
f float64
err error
)
o, _ = xRefTable.Dereference(o)
switch o := o.(type) {
case Integer:
f = float64(o.Value())
case Float:
f = o.Value()
default:
err = errors.Errorf("pdfcpu: dereferenceNumber: wrong type <%v>", o)
}
return f, err
}
// DereferenceName resolves and validates a name object, which may be an indirect reference.
func (xRefTable *XRefTable) DereferenceName(o Object, sinceVersion Version, validate func(string) bool) (n Name, err error) {
o, err = xRefTable.Dereference(o)
if err != nil || o == nil {
return n, err
}
n, ok := o.(Name)
if !ok {
return n, errors.Errorf("pdfcpu: dereferenceName: wrong type <%v>", o)
}
// Version check
if err = xRefTable.ValidateVersion("DereferenceName", sinceVersion); err != nil {
return n, err
}
// Validation
if validate != nil && !validate(n.Value()) {
return n, errors.Errorf("pdfcpu: dereferenceName: invalid <%s>", n.Value())
}
return n, nil
}
// DereferenceStringLiteral resolves and validates a string literal object, which may be an indirect reference.
func (xRefTable *XRefTable) DereferenceStringLiteral(o Object, sinceVersion Version, validate func(string) bool) (s StringLiteral, err error) {
o, err = xRefTable.Dereference(o)
if err != nil || o == nil {
return s, err
}
s, ok := o.(StringLiteral)
if !ok {
return s, errors.Errorf("pdfcpu: dereferenceStringLiteral: wrong type <%v>", o)
}
// Ensure UTF16 correctness.
s1, err := StringLiteralToString(s.Value())
if err != nil {
return s, err
}
// Version check
if err = xRefTable.ValidateVersion("DereferenceStringLiteral", sinceVersion); err != nil {
return s, err
}
// Validation
if validate != nil && !validate(s1) {
return s, errors.Errorf("pdfcpu: dereferenceStringLiteral: invalid <%s>", s1)
}
return s, nil
}
// DereferenceStringOrHexLiteral resolves and validates a string or hex literal object, which may be an indirect reference.
func (xRefTable *XRefTable) DereferenceStringOrHexLiteral(obj Object, sinceVersion Version, validate func(string) bool) (s string, err error) {
o, err := xRefTable.Dereference(obj)
if err != nil || o == nil {
return "", err
}
switch str := o.(type) {
case StringLiteral:
// Ensure UTF16 correctness.
if s, err = StringLiteralToString(str.Value()); err != nil {
return "", err
}
case HexLiteral:
// Ensure UTF16 correctness.
if s, err = HexLiteralToString(str.Value()); err != nil {
return "", err
}
default:
return "", errors.Errorf("pdfcpu: dereferenceStringOrHexLiteral: wrong type <%v>", obj)
}
// Version check
if err = xRefTable.ValidateVersion("DereferenceStringOrHexLiteral", sinceVersion); err != nil {
return "", err
}
// Validation
if validate != nil && !validate(s) {
return "", errors.Errorf("pdfcpu: dereferenceStringOrHexLiteral: invalid <%s>", s)
}
return s, nil
}
// Text returns a string based representation for String and Hexliterals.
func Text(o Object) (string, error) {
switch obj := o.(type) {
case StringLiteral:
return StringLiteralToString(obj.Value())
case HexLiteral:
return HexLiteralToString(obj.Value())
default: