forked from pdfcpu/pdfcpu
-
Notifications
You must be signed in to change notification settings - Fork 0
/
nameTree.go
756 lines (566 loc) · 17.8 KB
/
nameTree.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
/*
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 validate
import (
"github.com/pkg/errors"
pdf "github.com/vharish836/pdfcpu/pkg/pdfcpu"
)
func validateDestsNameTreeValue(xRefTable *pdf.XRefTable, o pdf.Object, sinceVersion pdf.Version) error {
// Version check
err := xRefTable.ValidateVersion("DestsNameTreeValue", sinceVersion)
if err != nil {
return err
}
return validateDestination(xRefTable, o)
}
func validateAPNameTreeValue(xRefTable *pdf.XRefTable, o pdf.Object, sinceVersion pdf.Version) error {
// Version check
err := xRefTable.ValidateVersion("APNameTreeValue", sinceVersion)
if err != nil {
return err
}
return validateXObjectStreamDict(xRefTable, o)
}
func validateJavaScriptNameTreeValue(xRefTable *pdf.XRefTable, o pdf.Object, sinceVersion pdf.Version) error {
// Version check
err := xRefTable.ValidateVersion("JavaScriptNameTreeValue", sinceVersion)
if err != nil {
return err
}
d, err := xRefTable.DereferenceDict(o)
if err != nil {
return err
}
// Javascript Action:
return validateJavaScriptActionDict(xRefTable, d, "JavaScript")
}
func validatePagesNameTreeValue(xRefTable *pdf.XRefTable, o pdf.Object, sinceVersion pdf.Version) error {
// see 12.7.6
// Version check
err := xRefTable.ValidateVersion("PagesNameTreeValue", sinceVersion)
if err != nil {
return err
}
// Value is a page dict.
d, err := xRefTable.DereferenceDict(o)
if err != nil {
return err
}
if d == nil {
return errors.New("pdfcpu: validatePagesNameTreeValue: value is nil")
}
_, err = validateNameEntry(xRefTable, d, "pageDict", "Type", REQUIRED, pdf.V10, func(s string) bool { return s == "Page" })
return err
}
func validateTemplatesNameTreeValue(xRefTable *pdf.XRefTable, o pdf.Object, sinceVersion pdf.Version) error {
// see 12.7.6
// Version check
err := xRefTable.ValidateVersion("TemplatesNameTreeValue", sinceVersion)
if err != nil {
return err
}
// Value is a template dict.
d, err := xRefTable.DereferenceDict(o)
if err != nil {
return err
}
if d == nil {
return errors.New("pdfcpu: validatePagesNameTreeValue: value is nil")
}
_, err = validateNameEntry(xRefTable, d, "templateDict", "Type", REQUIRED, pdf.V10, func(s string) bool { return s == "Template" })
return err
}
func validateURLAliasDict(xRefTable *pdf.XRefTable, d pdf.Dict) error {
dictName := "urlAliasDict"
// U, required, ASCII string
_, err := validateStringEntry(xRefTable, d, dictName, "U", REQUIRED, pdf.V10, nil)
if err != nil {
return err
}
// C, optional, array of strings
_, err = validateStringArrayEntry(xRefTable, d, dictName, "C", OPTIONAL, pdf.V10, nil)
return err
}
func validateCommandSettingsDict(xRefTable *pdf.XRefTable, d pdf.Dict) error {
// see 14.10.5.4
dictName := "cmdSettingsDict"
// G, optional, dict
_, err := validateDictEntry(xRefTable, d, dictName, "G", OPTIONAL, pdf.V10, nil)
if err != nil {
return err
}
// C, optional, dict
_, err = validateDictEntry(xRefTable, d, dictName, "C", OPTIONAL, pdf.V10, nil)
return err
}
func validateCaptureCommandDict(xRefTable *pdf.XRefTable, d pdf.Dict) error {
dictName := "captureCommandDict"
// URL, required, string
_, err := validateStringEntry(xRefTable, d, dictName, "URL", REQUIRED, pdf.V10, nil)
if err != nil {
return err
}
// L, optional, integer
_, err = validateIntegerEntry(xRefTable, d, dictName, "L", OPTIONAL, pdf.V10, nil)
if err != nil {
return err
}
// F, optional, integer
_, err = validateIntegerEntry(xRefTable, d, dictName, "F", OPTIONAL, pdf.V10, nil)
if err != nil {
return err
}
// P, optional, string or stream
err = validateStringOrStreamEntry(xRefTable, d, dictName, "P", OPTIONAL, pdf.V10)
if err != nil {
return err
}
// CT, optional, ASCII string
_, err = validateStringEntry(xRefTable, d, dictName, "CT", OPTIONAL, pdf.V10, nil)
if err != nil {
return err
}
// H, optional, string
_, err = validateStringEntry(xRefTable, d, dictName, "H", OPTIONAL, pdf.V10, nil)
if err != nil {
return err
}
// S, optional, command settings dict
d1, err := validateDictEntry(xRefTable, d, dictName, "S", OPTIONAL, pdf.V10, nil)
if err != nil {
return err
}
if d1 != nil {
err = validateCommandSettingsDict(xRefTable, d1)
}
return err
}
func validateSourceInfoDictEntryAU(xRefTable *pdf.XRefTable, d pdf.Dict, dictName, entryName string, required bool, sinceVersion pdf.Version) error {
o, err := validateEntry(xRefTable, d, dictName, entryName, required, sinceVersion)
if err != nil || o == nil {
return err
}
switch o := o.(type) {
case pdf.StringLiteral, pdf.HexLiteral:
// no further processing
case pdf.Dict:
err = validateURLAliasDict(xRefTable, o)
if err != nil {
return err
}
default:
return errors.New("pdfcpu: validateSourceInfoDict: entry \"AU\" must be string or dict")
}
return nil
}
func validateSourceInfoDict(xRefTable *pdf.XRefTable, d pdf.Dict) error {
dictName := "sourceInfoDict"
// AU, required, ASCII string or dict
err := validateSourceInfoDictEntryAU(xRefTable, d, dictName, "AU", REQUIRED, pdf.V10)
if err != nil {
return err
}
// E, optional, date
_, err = validateDateEntry(xRefTable, d, dictName, "E", OPTIONAL, pdf.V10)
if err != nil {
return err
}
// S, optional, integer
_, err = validateIntegerEntry(xRefTable, d, dictName, "S", OPTIONAL, pdf.V10, func(i int) bool { return 0 <= i && i <= 2 })
if err != nil {
return err
}
// C, optional, indRef of command dict
ir, err := validateIndRefEntry(xRefTable, d, dictName, "C", OPTIONAL, pdf.V10)
if err != nil {
return err
}
if ir != nil {
d1, err := xRefTable.DereferenceDict(*ir)
if err != nil {
return err
}
return validateCaptureCommandDict(xRefTable, d1)
}
return nil
}
func validateEntrySI(xRefTable *pdf.XRefTable, d pdf.Dict, dictName, entryName string, required bool, sinceVersion pdf.Version) error {
// see 14.10.5, table 355, source information dictionary
o, err := validateEntry(xRefTable, d, dictName, entryName, required, sinceVersion)
if err != nil || o == nil {
return err
}
switch o := o.(type) {
case pdf.Dict:
err = validateSourceInfoDict(xRefTable, o)
if err != nil {
return err
}
case pdf.Array:
for _, v := range o {
if v == nil {
continue
}
d1, err := xRefTable.DereferenceDict(v)
if err != nil {
return err
}
err = validateSourceInfoDict(xRefTable, d1)
if err != nil {
return err
}
}
}
return nil
}
func validateWebCaptureContentSetDict(XRefTable *pdf.XRefTable, d pdf.Dict) error {
// see 14.10.4
dictName := "webCaptureContentSetDict"
// Type, optional, name
_, err := validateNameEntry(XRefTable, d, dictName, "Type", OPTIONAL, pdf.V10, func(s string) bool { return s == "SpiderContentSet" })
if err != nil {
return err
}
// S, required, name
s, err := validateNameEntry(XRefTable, d, dictName, "Type", REQUIRED, pdf.V10, func(s string) bool { return s == "SPS" || s == "SIS" })
if err != nil {
return err
}
// ID, required, byte string
_, err = validateStringEntry(XRefTable, d, dictName, "ID", REQUIRED, pdf.V10, nil)
if err != nil {
return err
}
// O, required, array of indirect references.
_, err = validateIndRefArrayEntry(XRefTable, d, dictName, "O", REQUIRED, pdf.V10, nil)
if err != nil {
return err
}
// SI, required, source info dict or array of source info dicts
err = validateEntrySI(XRefTable, d, dictName, "SI", REQUIRED, pdf.V10)
if err != nil {
return err
}
// CT, optional, string
_, err = validateStringEntry(XRefTable, d, dictName, "CT", OPTIONAL, pdf.V10, nil)
if err != nil {
return err
}
// TS, optional, date
_, err = validateDateEntry(XRefTable, d, dictName, "TS", OPTIONAL, pdf.V10)
if err != nil {
return err
}
// spider page set
if *s == "SPS" {
// T, optional, string
_, err = validateStringEntry(XRefTable, d, dictName, "T", OPTIONAL, pdf.V10, nil)
if err != nil {
return err
}
// TID, optional, byte string
_, err = validateStringEntry(XRefTable, d, dictName, "TID", OPTIONAL, pdf.V10, nil)
if err != nil {
return err
}
}
// spider image set
if *s == "SIS" {
// R, required, integer or array of integers
err = validateIntegerOrArrayOfIntegerEntry(XRefTable, d, dictName, "R", REQUIRED, pdf.V10)
}
return err
}
func validateIDSNameTreeValue(xRefTable *pdf.XRefTable, o pdf.Object, sinceVersion pdf.Version) error {
// see 14.10.4
// Version check
err := xRefTable.ValidateVersion("IDSNameTreeValue", sinceVersion)
if err != nil {
return err
}
// Value is a web capture content set.
d, err := xRefTable.DereferenceDict(o)
if err != nil || d == nil {
return err
}
return validateWebCaptureContentSetDict(xRefTable, d)
}
func validateURLSNameTreeValue(xRefTable *pdf.XRefTable, o pdf.Object, sinceVersion pdf.Version) error {
// see 14.10.4
// Version check
err := xRefTable.ValidateVersion("URLSNameTreeValue", sinceVersion)
if err != nil {
return err
}
// Value is a web capture content set.
d, err := xRefTable.DereferenceDict(o)
if err != nil || d == nil {
return err
}
return validateWebCaptureContentSetDict(xRefTable, d)
}
func validateEmbeddedFilesNameTreeValue(xRefTable *pdf.XRefTable, o pdf.Object, sinceVersion pdf.Version) error {
// see 7.11.4
// Value is a file specification for an embedded file stream.
// Version check
err := xRefTable.ValidateVersion("EmbeddedFilesNameTreeValue", sinceVersion)
if err != nil {
return err
}
if o == nil {
return nil
}
_, err = validateFileSpecification(xRefTable, o)
return err
}
func validateSlideShowDict(XRefTable *pdf.XRefTable, d pdf.Dict) error {
// see 13.5, table 297
dictName := "slideShowDict"
// Type, required, name, since V1.4
_, err := validateNameEntry(XRefTable, d, dictName, "Type", REQUIRED, pdf.V14, func(s string) bool { return s == "SlideShow" })
if err != nil {
return err
}
// Subtype, required, name, since V1.4
_, err = validateNameEntry(XRefTable, d, dictName, "Subtype", REQUIRED, pdf.V14, func(s string) bool { return s == "Embedded" })
if err != nil {
return err
}
// Resources, required, name tree, since V1.4
// Note: This is really an array of (string,indRef) pairs.
_, err = validateArrayEntry(XRefTable, d, dictName, "Resources", REQUIRED, pdf.V14, nil)
if err != nil {
return err
}
// StartResource, required, byte string, since V1.4
_, err = validateStringEntry(XRefTable, d, dictName, "StartResource", REQUIRED, pdf.V14, nil)
return err
}
func validateAlternatePresentationsNameTreeValue(xRefTable *pdf.XRefTable, o pdf.Object, sinceVersion pdf.Version) error {
// see 13.5
// Value is a slide show dict.
// Version check
err := xRefTable.ValidateVersion("AlternatePresentationsNameTreeValue", sinceVersion)
if err != nil {
return err
}
d, err := xRefTable.DereferenceDict(o)
if err != nil {
return err
}
if d != nil {
err = validateSlideShowDict(xRefTable, d)
}
return err
}
func validateRenditionsNameTreeValue(xRefTable *pdf.XRefTable, o pdf.Object, sinceVersion pdf.Version) error {
// see 13.2.3
// Value is a rendition object.
// Version check
err := xRefTable.ValidateVersion("RenditionsNameTreeValue", sinceVersion)
if err != nil {
return err
}
d, err := xRefTable.DereferenceDict(o)
if err != nil {
return err
}
if d != nil {
err = validateRenditionDict(xRefTable, d, sinceVersion)
}
return err
}
func validateIDTreeValue(xRefTable *pdf.XRefTable, o pdf.Object, sinceVersion pdf.Version) error {
// Version check
err := xRefTable.ValidateVersion("IDTreeValue", sinceVersion)
if err != nil {
return err
}
d, err := xRefTable.DereferenceDict(o)
if err != nil || d == nil {
return err
}
dictType := d.Type()
if dictType == nil || *dictType == "StructElem" {
err = validateStructElementDict(xRefTable, d)
if err != nil {
return err
}
} else {
return errors.Errorf("pdfcpu: validateIDTreeValue: invalid dictType %s (should be \"StructElem\")\n", *dictType)
}
return nil
}
func validateNameTreeValue(name string, xRefTable *pdf.XRefTable, o pdf.Object) (err error) {
// TODO
// The values associated with the keys may be objects of any type.
// Stream objects shall be specified by indirect object references.
// Dictionary, array, and string objects should be specified by indirect object references.
// Other PDF objects (nulls, numbers, booleans, and names) should be specified as direct objects.
for k, v := range map[string]struct {
validate func(xRefTable *pdf.XRefTable, o pdf.Object, sinceVersion pdf.Version) error
sinceVersion pdf.Version
}{
"Dests": {validateDestsNameTreeValue, pdf.V12},
"AP": {validateAPNameTreeValue, pdf.V13},
"JavaScript": {validateJavaScriptNameTreeValue, pdf.V13},
"Pages": {validatePagesNameTreeValue, pdf.V13},
"Templates": {validateTemplatesNameTreeValue, pdf.V13},
"IDS": {validateIDSNameTreeValue, pdf.V13},
"URLS": {validateURLSNameTreeValue, pdf.V13},
"EmbeddedFiles": {validateEmbeddedFilesNameTreeValue, pdf.V14},
"AlternatePresentations": {validateAlternatePresentationsNameTreeValue, pdf.V14},
"Renditions": {validateRenditionsNameTreeValue, pdf.V15},
"IDTree": {validateIDTreeValue, pdf.V13},
} {
if name == k {
return v.validate(xRefTable, o, v.sinceVersion)
}
}
return errors.Errorf("pdfcpu: validateNameTreeDictNamesEntry: unknown dict name: %s", name)
}
func validateNameTreeDictNamesEntry(xRefTable *pdf.XRefTable, d pdf.Dict, name string, node *pdf.Node) (firstKey, lastKey string, err error) {
// Names: array of the form [key1 value1 key2 value2 ... key n value n]
o, found := d.Find("Names")
if !found {
return "", "", errors.Errorf("pdfcpu: validateNameTreeDictNamesEntry: missing \"Kids\" or \"Names\" entry.")
}
a, err := xRefTable.DereferenceArray(o)
if err != nil {
return "", "", err
}
if a == nil {
return "", "", errors.Errorf("pdfcpu: validateNameTreeDictNamesEntry: missing \"Names\" array.")
}
// arr length needs to be even because of contained key value pairs.
if len(a)%2 == 1 {
return "", "", errors.Errorf("pdfcpu: validateNameTreeDictNamesEntry: Names array entry length needs to be even, length=%d\n", len(a))
}
var key string
for i, o := range a {
if i%2 == 0 {
o, err = xRefTable.Dereference(o)
if err != nil {
return "", "", err
}
s, ok := o.(pdf.StringLiteral)
if !ok {
s, ok := o.(pdf.HexLiteral)
if !ok {
return "", "", errors.Errorf("pdfcpu: validateNameTreeDictNamesEntry: corrupt key <%v>\n", o)
}
key = s.Value()
} else {
key = s.Value()
}
if firstKey == "" {
firstKey = key
}
lastKey = key
continue
}
err = validateNameTreeValue(name, xRefTable, o)
if err != nil {
return "", "", err
}
node.AddToLeaf(key, o)
}
return firstKey, lastKey, nil
}
func validateNameTreeDictLimitsEntry(xRefTable *pdf.XRefTable, d pdf.Dict, firstKey, lastKey string) error {
a, err := validateStringArrayEntry(xRefTable, d, "nameTreeDict", "Limits", REQUIRED, pdf.V10, func(a pdf.Array) bool { return len(a) == 2 })
if err != nil {
return err
}
//fmt.Printf("validateNameTreeDictLimitsEntry: firstKey=%s lastKey=%s limits:%v\n", firstKey, lastKey, a)
var fkv, lkv string
fk, ok := a[0].(pdf.StringLiteral)
if !ok {
fk, _ := a[0].(pdf.HexLiteral)
//bb, _ := fk.Bytes()
//fmt.Printf("fk: %v %s\n", bb, string(bb))
fkv = fk.Value()
} else {
fkv = fk.Value()
}
lk, ok := a[1].(pdf.StringLiteral)
if !ok {
lk, _ := a[1].(pdf.HexLiteral)
//bb, _ := lk.Bytes()
//fmt.Printf("lk: %v %s\n", bb, string(bb))
lkv = lk.Value()
} else {
lkv = lk.Value()
}
if firstKey < fkv || lastKey > lkv {
return errors.Errorf("pdfcpu: validateNameTreeDictLimitsEntry: leaf node corrupted (firstKey: %s vs %s) (lastKey: %s vs %s)\n", firstKey, fkv, lastKey, lkv)
}
return nil
}
func validateNameTree(xRefTable *pdf.XRefTable, name string, d pdf.Dict, root bool) (string, string, *pdf.Node, error) {
// see 7.7.4
// A node has "Kids" or "Names" entry.
//fmt.Printf("validateNameTree %s\n", name)
node := &pdf.Node{D: d}
var kmin, kmax string
var err error
// Kids: array of indirect references to the immediate children of this node.
// if Kids present then recurse
if o, found := d.Find("Kids"); found {
// Intermediate node
a, err := xRefTable.DereferenceArray(o)
if err != nil {
return "", "", nil, err
}
if a == nil {
return "", "", nil, errors.New("pdfcpu: validateNameTree: missing \"Kids\" array")
}
for _, o := range a {
kid, ok := o.(pdf.IndirectRef)
if !ok {
return "", "", nil, errors.New("pdfcpu: validateNameTree: corrupt kid, should be indirect reference")
}
d, err := xRefTable.DereferenceDict(kid)
if err != nil {
return "", "", nil, err
}
var kminKid string
var kidNode *pdf.Node
kminKid, kmax, kidNode, err = validateNameTree(xRefTable, name, d, false)
if err != nil {
return "", "", nil, err
}
if kmin == "" {
kmin = kminKid
}
node.Kids = append(node.Kids, kidNode)
}
} else {
// Leaf node
kmin, kmax, err = validateNameTreeDictNamesEntry(xRefTable, d, name, node)
if err != nil {
return "", "", nil, err
}
}
if !root {
// Verify calculated key range.
err = validateNameTreeDictLimitsEntry(xRefTable, d, kmin, kmax)
if err != nil {
return "", "", nil, err
}
}
// We track limits for all nodes internally.
node.Kmin = kmin
node.Kmax = kmax
return kmin, kmax, node, nil
}