forked from pdfcpu/pdfcpu
/
nameTree.go
616 lines (505 loc) · 14.1 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
/*
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 model
import (
"fmt"
"strings"
"github.com/angel-one/pdfcpu/pkg/log"
"github.com/angel-one/pdfcpu/pkg/pdfcpu/types"
"github.com/pkg/errors"
)
var errNameTreeDuplicateKey = errors.New("pdfcpu: name: duplicate key")
const maxEntries = 3
// Node is an opinionated implementation of the PDF name tree.
// pdfcpu caches all name trees found in the PDF catalog with this data structure.
// The PDF spec does not impose any rules regarding a strategy for the creation of nodes.
// A binary tree was chosen where each leaf node has a limited number of entries (maxEntries).
// Once maxEntries has been reached a leaf node turns into an intermediary node with two kids,
// which are leaf nodes each of them holding half of the sorted entries of the original leaf node.
type Node struct {
Kids []*Node // Mirror of the name tree's Kids array, an array of indirect references.
Names []entry // Mirror of the name tree's Names array.
Kmin, Kmax string // Mirror of the name tree's Limit array[Kmin,Kmax].
D types.Dict // The PDF dict representing this name tree node.
}
// entry is a key value pair.
type entry struct {
k string
v types.Object
}
func (n Node) leaf() bool {
return n.Kids == nil
}
func keyLess(k, s string) bool {
return k < s
}
func keyLessOrEqual(k, s string) bool {
return k == s || keyLess(k, s)
}
func (n Node) withinLimits(k string) bool {
return keyLessOrEqual(n.Kmin, k) && keyLessOrEqual(k, n.Kmax)
}
// Value returns the value for given key
func (n Node) Value(k string) (types.Object, bool) {
if !n.withinLimits(k) {
return nil, false
}
if n.leaf() {
// names are sorted by key.
for _, v := range n.Names {
if v.k < k {
continue
}
if v.k == k {
return v.v, true
}
return nil, false
}
return nil, false
}
// kids are sorted by key ranges.
for _, v := range n.Kids {
if v.withinLimits(k) {
return v.Value(k)
}
}
return nil, false
}
// AppendToNames adds an entry to a leaf node (for internalizing name trees).
func (n *Node) AppendToNames(k string, v types.Object) {
//fmt.Printf("AddToLeaf: %s %v (%v)\n\n", k, v, &v)
if n.Names == nil {
n.Names = make([]entry, 0, maxEntries)
}
arr, ok := v.(types.Array)
if ok {
arr1 := make(types.Array, len(arr))
for i, v := range arr {
if indRef, ok := v.(types.IndirectRef); ok {
arr1[i] = *types.NewIndirectRef(indRef.ObjectNumber.Value(), indRef.GenerationNumber.Value())
} else {
arr1[i] = v
}
}
n.Names = append(n.Names, entry{k, arr1})
} else {
n.Names = append(n.Names, entry{k, v})
}
}
type NameMap map[string][]types.Dict
func (m NameMap) Add(k string, d types.Dict) {
dd, ok := m[k]
if !ok {
m[k] = []types.Dict{d}
return
}
m[k] = append(dd, d)
}
func (n *Node) insertIntoLeaf(k string, v types.Object, m NameMap) error {
if log.DebugEnabled() {
log.Debug.Printf("Insert k:%s in the middle\n", k)
}
for i, e := range n.Names {
if keyLess(e.k, k) {
continue
}
if e.k == k {
return errNameTreeDuplicateKey
}
// Insert entry(k,v) at i
n.Names = append(n.Names, entry{})
copy(n.Names[i+1:], n.Names[i:])
n.Names[i] = entry{k, v}
return nil
}
if log.DebugEnabled() {
log.Debug.Printf("Insert k:%s at end\n", k)
}
n.Kmax = k
n.Names = append(n.Names, entry{k, v})
return nil
}
func updateNameRef(d types.Dict, keys []string, nameOld, nameNew string) error {
for _, k := range keys {
s, err := d.StringOrHexLiteralEntry(k)
if err != nil {
return err
}
if s != nil {
if *s != nameOld {
return errors.Errorf("invalid Name ref detected for: %s", nameOld)
}
d[k] = types.NewHexLiteral([]byte(nameNew))
}
}
return nil
}
func updateNameRefDicts(dd []types.Dict, nameRefDictKeys []string, nameOld, nameNew string) error {
// eg.
// "Dests": "D", "Dest" []string{"D", "Dest"}
// "EmbeddedFiles": F", "UF" []string{"F", "UF"}
for _, d := range dd {
if err := updateNameRef(d, nameRefDictKeys, nameOld, nameNew); err != nil {
return err
}
}
return nil
}
func (n *Node) insertUniqueIntoLeaf(k string, v types.Object, m NameMap, nameRefDictKeys []string) (bool, error) {
var err error
kOrig := k
for first := true; first || err == errNameTreeDuplicateKey; first = false {
err = n.insertIntoLeaf(k, v, m)
if err == nil {
break
}
if err != errNameTreeDuplicateKey {
return false, err
}
if len(m) == 0 {
return true, nil
}
kNew := k + "\x01"
dd, ok := m[kOrig]
if !ok {
return true, nil
}
if err := updateNameRefDicts(dd, nameRefDictKeys, k, kNew); err != nil {
return false, err
}
k = kNew
}
return false, nil
}
// HandleLeaf processes a leaf node.
func (n *Node) HandleLeaf(xRefTable *XRefTable, k string, v types.Object, m NameMap, nameRefDictKeys []string) error {
// A leaf node contains up to maxEntries names.
// Any number of entries greater than maxEntries will be delegated to kid nodes.
//fmt.Printf("HandleLeaf: %s %v\n\n", k, v)
if len(n.Names) == 0 {
n.Names = append(n.Names, entry{k, v})
n.Kmin, n.Kmax = k, k
if log.DebugEnabled() {
log.Debug.Printf("first key=%s\n", k)
}
return nil
}
if log.DebugEnabled() {
log.Debug.Printf("kmin=%s kmax=%s\n", n.Kmin, n.Kmax)
}
if keyLess(k, n.Kmin) {
// Prepend (k,v).
if log.DebugEnabled() {
log.Debug.Printf("Insert k:%s at beginning\n", k)
}
n.Kmin = k
n.Names = append(n.Names, entry{})
copy(n.Names[1:], n.Names[0:])
n.Names[0] = entry{k, v}
} else if keyLess(n.Kmax, k) {
// Append (k,v).
if log.DebugEnabled() {
log.Debug.Printf("Insert k:%s at end\n", k)
}
n.Kmax = k
n.Names = append(n.Names, entry{k, v})
} else {
// Insert (k,v) while ensuring unique k.
ok, err := n.insertUniqueIntoLeaf(k, v, m, nameRefDictKeys)
if err != nil {
return err
}
if ok {
return nil
}
}
// if len was already > maxEntries we know we are dealing with somebody elses name tree.
// In that case we do not know the branching strategy and therefore just add to Names and do not create kids.
// If len is within maxEntries we do not create kids either way.
if len(n.Names) != maxEntries+1 {
return nil
}
// turn leaf into intermediate node with 2 kids/leafs (binary tree)
c := maxEntries + 1
k1 := &Node{Names: make([]entry, c/2, maxEntries)}
copy(k1.Names, n.Names[:c/2])
k1.Kmin = n.Names[0].k
k1.Kmax = n.Names[c/2-1].k
k2 := &Node{Names: make([]entry, len(n.Names)-c/2, maxEntries)}
copy(k2.Names, n.Names[c/2:])
k2.Kmin = n.Names[c/2].k
k2.Kmax = n.Names[c-1].k
n.Kids = []*Node{k1, k2}
n.Names = nil
return nil
}
// Add adds an entry to a name tree.
func (n *Node) Add(xRefTable *XRefTable, k string, v types.Object, m NameMap, nameRefDictKeys []string) error {
//fmt.Printf("Add: %s %v\n", k, v)
// 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 (null, number, boolean and name) should be specified as direct objects.
if n.Names == nil {
n.Names = make([]entry, 0, maxEntries)
}
if n.leaf() {
return n.HandleLeaf(xRefTable, k, v, m, nameRefDictKeys)
}
if k == n.Kmin || k == n.Kmax {
return nil
}
if keyLess(k, n.Kmin) {
n.Kmin = k
} else if keyLess(n.Kmax, k) {
n.Kmax = k
}
// For intermediary nodes we delegate to the corresponding subtree.
for _, a := range n.Kids {
if keyLess(k, a.Kmin) || a.withinLimits(k) {
return a.Add(xRefTable, k, v, m, nameRefDictKeys)
}
}
// Insert k into last (right most) subtree.
last := n.Kids[len(n.Kids)-1]
return last.Add(xRefTable, k, v, m, nameRefDictKeys)
}
// AddTree adds a name tree to a name tree.
func (n *Node) AddTree(xRefTable *XRefTable, tree *Node, m NameMap, nameRefDictKeys []string) error {
if !tree.leaf() {
for _, v := range tree.Kids {
if err := n.AddTree(xRefTable, v, m, nameRefDictKeys); err != nil {
return err
}
}
return nil
}
for _, e := range tree.Names {
if err := n.Add(xRefTable, e.k, e.v, m, nameRefDictKeys); err != nil {
return err
}
}
return nil
}
func (n *Node) removeFromNames(xRefTable *XRefTable, k string) (ok bool, err error) {
for i, v := range n.Names {
if v.k < k {
continue
}
if v.k == k {
if xRefTable != nil {
// Remove object graph of value.
if log.DebugEnabled() {
log.Debug.Println("removeFromNames: deleting object graph of v")
}
if err := xRefTable.DeleteObjectGraph(v.v); err != nil {
return false, err
}
}
n.Names = append(n.Names[:i], n.Names[i+1:]...)
return true, nil
}
}
return false, nil
}
func (n *Node) removeSingleFromParent(xRefTable *XRefTable) error {
if xRefTable != nil {
// Remove object graph of value.
if log.DebugEnabled() {
log.Debug.Println("removeFromLeaf: deleting object graph of v")
}
if err := xRefTable.DeleteObjectGraph(n.Names[0].v); err != nil {
return err
}
}
n.Kmin, n.Kmax = "", ""
n.Names = nil
return nil
}
func (n *Node) removeFromLeaf(xRefTable *XRefTable, k string) (empty, ok bool, err error) {
if keyLess(k, n.Kmin) || keyLess(n.Kmax, k) {
return false, false, nil
}
// kmin < k < kmax
// If sole entry gets deleted, remove this node from parent.
if len(n.Names) == 1 {
if err := n.removeSingleFromParent(xRefTable); err != nil {
return false, false, err
}
return true, true, nil
}
if k == n.Kmin {
if xRefTable != nil {
// Remove object graph of value.
if log.DebugEnabled() {
log.Debug.Println("removeFromLeaf: deleting object graph of v")
}
if err := xRefTable.DeleteObjectGraph(n.Names[0].v); err != nil {
return false, false, err
}
}
n.Names = n.Names[1:]
n.Kmin = n.Names[0].k
return false, true, nil
}
if k == n.Kmax {
if xRefTable != nil {
// Remove object graph of value.
if log.DebugEnabled() {
log.Debug.Println("removeFromLeaf: deleting object graph of v")
}
if err := xRefTable.DeleteObjectGraph(n.Names[len(n.Names)-1].v); err != nil {
return false, false, err
}
}
n.Names = n.Names[:len(n.Names)-1]
n.Kmax = n.Names[len(n.Names)-1].k
return false, true, nil
}
if ok, err = n.removeFromNames(xRefTable, k); err != nil {
return false, false, err
}
return false, ok, nil
}
func (n *Node) removeKid(xRefTable *XRefTable, kid *Node, i int) (bool, error) {
if xRefTable != nil {
if err := xRefTable.DeleteObject(kid.D); err != nil {
return false, err
}
}
if i == 0 {
// Remove first kid.
if log.DebugEnabled() {
log.Debug.Println("removeFromKids: remove first kid.")
}
n.Kids = n.Kids[1:]
} else if i == len(n.Kids)-1 {
if log.DebugEnabled() {
log.Debug.Println("removeFromKids: remove last kid.")
}
// Remove last kid.
n.Kids = n.Kids[:len(n.Kids)-1]
} else {
// Remove kid from the middle.
if log.DebugEnabled() {
log.Debug.Println("removeFromKids: remove kid form the middle.")
}
n.Kids = append(n.Kids[:i], n.Kids[i+1:]...)
}
if len(n.Kids) == 1 {
// If a single kid remains we can merge it with its parent.
// By doing this we get rid of a redundant intermediary node.
if log.DebugEnabled() {
log.Debug.Println("removeFromKids: only 1 kid")
}
if xRefTable != nil {
if err := xRefTable.DeleteObject(n.D); err != nil {
return false, err
}
}
*n = *n.Kids[0]
if log.DebugEnabled() {
log.Debug.Printf("removeFromKids: new n = %s\n", n)
}
return true, nil
}
return false, nil
}
func (n *Node) removeFromKids(xRefTable *XRefTable, k string) (ok bool, err error) {
// Locate the kid to recurse into, then remove k from that subtree.
for i, kid := range n.Kids {
if !kid.withinLimits(k) {
continue
}
empty, ok, err := kid.Remove(xRefTable, k)
if err != nil {
return false, err
}
if !ok {
return false, nil
}
if empty {
// This kid is now empty and needs to be removed.
noKids, err := n.removeKid(xRefTable, kid, i)
if err != nil {
return false, err
}
if noKids {
return true, nil
}
}
// Update kMin, kMax for n.
n.Kmin = n.Kids[0].Kmin
n.Kmax = n.Kids[len(n.Kids)-1].Kmax
return true, nil
}
return false, nil
}
// Remove removes an entry from a name tree.
// empty returns true if this node is an empty leaf node after removal.
// ok returns true if removal was successful.
func (n *Node) Remove(xRefTable *XRefTable, k string) (empty, ok bool, err error) {
if n.leaf() {
return n.removeFromLeaf(xRefTable, k)
}
if ok, err = n.removeFromKids(xRefTable, k); err != nil {
return false, false, err
}
return false, ok, nil
}
// Process traverses the nametree applying a handler to each entry (key-value pair).
func (n *Node) Process(xRefTable *XRefTable, handler func(*XRefTable, string, *types.Object) error) error {
if !n.leaf() {
for _, v := range n.Kids {
if err := v.Process(xRefTable, handler); err != nil {
return err
}
}
return nil
}
for k, e := range n.Names {
if err := handler(xRefTable, e.k, &e.v); err != nil {
return err
}
n.Names[k] = e
}
return nil
}
// KeyList returns a sorted list of all keys.
func (n Node) KeyList() ([]string, error) {
list := []string{}
keys := func(xRefTable *XRefTable, k string, v *types.Object) error {
list = append(list, fmt.Sprintf("%s %v", k, *v))
return nil
}
if err := n.Process(nil, keys); err != nil {
return nil, err
}
return list, nil
}
func (n Node) String() string {
a := []string{}
if n.leaf() {
a = append(a, "[")
for _, n := range n.Names {
a = append(a, fmt.Sprintf("(%s,%s)", n.k, n.v))
}
a = append(a, fmt.Sprintf("{%s,%s}]", n.Kmin, n.Kmax))
return strings.Join(a, "")
}
a = append(a, fmt.Sprintf("{%s,%s}", n.Kmin, n.Kmax))
for _, v := range n.Kids {
a = append(a, v.String())
}
return strings.Join(a, ",")
}