-
Notifications
You must be signed in to change notification settings - Fork 1.3k
/
_reader.py
1942 lines (1729 loc) · 73.9 KB
/
_reader.py
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 (c) 2006, Mathieu Fenniak
# Copyright (c) 2007, Ashish Kulkarni <kulkarni.ashish@gmail.com>
#
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
# * Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimer.
# * Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
# * The name of the author may not be used to endorse or promote products
# derived from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
import os
import re
import struct
import zlib
from datetime import datetime
from io import BytesIO
from pathlib import Path
from typing import (
Any,
Callable,
Dict,
Iterable,
List,
Optional,
Tuple,
Union,
cast,
)
from ._encryption import Encryption, PasswordType
from ._page import PageObject, _VirtualList
from ._utils import (
StrByteType,
StreamType,
b_,
deprecate_no_replacement,
deprecate_with_replacement,
logger_warning,
read_non_whitespace,
read_previous_line,
read_until_whitespace,
skip_over_comment,
skip_over_whitespace,
)
from .constants import CatalogAttributes as CA
from .constants import CatalogDictionary as CD
from .constants import CheckboxRadioButtonAttributes
from .constants import Core as CO
from .constants import DocumentInformationAttributes as DI
from .constants import FieldDictionaryAttributes, GoToActionArguments
from .constants import PageAttributes as PG
from .constants import PagesAttributes as PA
from .constants import TrailerKeys as TK
from .errors import (
EmptyFileError,
FileNotDecryptedError,
PdfReadError,
PdfStreamError,
WrongPasswordError,
)
from .generic import (
ArrayObject,
ContentStream,
DecodedStreamObject,
Destination,
DictionaryObject,
EncodedStreamObject,
Field,
Fit,
FloatObject,
IndirectObject,
NameObject,
NullObject,
NumberObject,
PdfObject,
TextStringObject,
TreeObject,
read_object,
)
from .types import OutlineType, PagemodeType
from .xmp import XmpInformation
def convert_to_int(d: bytes, size: int) -> Union[int, Tuple[Any, ...]]:
if size > 8:
raise PdfReadError("invalid size in convert_to_int")
d = b"\x00\x00\x00\x00\x00\x00\x00\x00" + d
d = d[-8:]
return struct.unpack(">q", d)[0]
def convertToInt(
d: bytes, size: int
) -> Union[int, Tuple[Any, ...]]: # pragma: no cover
deprecate_with_replacement("convertToInt", "convert_to_int")
return convert_to_int(d, size)
class DocumentInformation(DictionaryObject):
"""
A class representing the basic document metadata provided in a PDF File.
This class is accessible through :py:class:`PdfReader.metadata<PyPDF2.PdfReader.metadata>`.
All text properties of the document metadata have
*two* properties, eg. author and author_raw. The non-raw property will
always return a ``TextStringObject``, making it ideal for a case where
the metadata is being displayed. The raw property can sometimes return
a ``ByteStringObject``, if PyPDF2 was unable to decode the string's
text encoding; this requires additional safety in the caller and
therefore is not as commonly accessed.
"""
def __init__(self) -> None:
DictionaryObject.__init__(self)
def _get_text(self, key: str) -> Optional[str]:
retval = self.get(key, None)
if isinstance(retval, TextStringObject):
return retval
return None
def getText(self, key: str) -> Optional[str]: # pragma: no cover
"""
The text value of the specified key or None.
.. deprecated:: 1.28.0
Use the attributes (e.g. :py:attr:`title` / :py:attr:`author`).
"""
deprecate_no_replacement("getText")
return self._get_text(key)
@property
def title(self) -> Optional[str]:
"""
Read-only property accessing the document's **title**.
Returns a unicode string (``TextStringObject``) or ``None``
if the title is not specified.
"""
return (
self._get_text(DI.TITLE) or self.get(DI.TITLE).get_object() # type: ignore
if self.get(DI.TITLE)
else None
)
@property
def title_raw(self) -> Optional[str]:
"""The "raw" version of title; can return a ``ByteStringObject``."""
return self.get(DI.TITLE)
@property
def author(self) -> Optional[str]:
"""
Read-only property accessing the document's **author**.
Returns a unicode string (``TextStringObject``) or ``None``
if the author is not specified.
"""
return self._get_text(DI.AUTHOR)
@property
def author_raw(self) -> Optional[str]:
"""The "raw" version of author; can return a ``ByteStringObject``."""
return self.get(DI.AUTHOR)
@property
def subject(self) -> Optional[str]:
"""
Read-only property accessing the document's **subject**.
Returns a unicode string (``TextStringObject``) or ``None``
if the subject is not specified.
"""
return self._get_text(DI.SUBJECT)
@property
def subject_raw(self) -> Optional[str]:
"""The "raw" version of subject; can return a ``ByteStringObject``."""
return self.get(DI.SUBJECT)
@property
def creator(self) -> Optional[str]:
"""
Read-only property accessing the document's **creator**.
If the document was converted to PDF from another format, this is the
name of the application (e.g. OpenOffice) that created the original
document from which it was converted. Returns a unicode string
(``TextStringObject``) or ``None`` if the creator is not specified.
"""
return self._get_text(DI.CREATOR)
@property
def creator_raw(self) -> Optional[str]:
"""The "raw" version of creator; can return a ``ByteStringObject``."""
return self.get(DI.CREATOR)
@property
def producer(self) -> Optional[str]:
"""
Read-only property accessing the document's **producer**.
If the document was converted to PDF from another format, this is
the name of the application (for example, OSX Quartz) that converted
it to PDF. Returns a unicode string (``TextStringObject``)
or ``None`` if the producer is not specified.
"""
return self._get_text(DI.PRODUCER)
@property
def producer_raw(self) -> Optional[str]:
"""The "raw" version of producer; can return a ``ByteStringObject``."""
return self.get(DI.PRODUCER)
@property
def creation_date(self) -> Optional[datetime]:
"""
Read-only property accessing the document's **creation date**.
"""
text = self._get_text(DI.CREATION_DATE)
if text is None:
return None
return datetime.strptime(text.replace("'", ""), "D:%Y%m%d%H%M%S%z")
@property
def creation_date_raw(self) -> Optional[str]:
"""
The "raw" version of creation date; can return a ``ByteStringObject``.
Typically in the format D:YYYYMMDDhhmmss[+-]hh'mm where the suffix is the
offset from UTC.
"""
return self.get(DI.CREATION_DATE)
@property
def modification_date(self) -> Optional[datetime]:
"""
Read-only property accessing the document's **modification date**.
The date and time the document was most recently modified.
"""
text = self._get_text(DI.MOD_DATE)
if text is None:
return None
return datetime.strptime(text.replace("'", ""), "D:%Y%m%d%H%M%S%z")
@property
def modification_date_raw(self) -> Optional[str]:
"""
The "raw" version of modification date; can return a ``ByteStringObject``.
Typically in the format D:YYYYMMDDhhmmss[+-]hh'mm where the suffix is the
offset from UTC.
"""
return self.get(DI.MOD_DATE)
class PdfReader:
"""
Initialize a PdfReader object.
This operation can take some time, as the PDF stream's cross-reference
tables are read into memory.
:param stream: A File object or an object that supports the standard read
and seek methods similar to a File object. Could also be a
string representing a path to a PDF file.
:param bool strict: Determines whether user should be warned of all
problems and also causes some correctable problems to be fatal.
Defaults to ``False``.
:param None/str/bytes password: Decrypt PDF file at initialization. If the
password is None, the file will not be decrypted.
Defaults to ``None``
"""
def __init__(
self,
stream: Union[StrByteType, Path],
strict: bool = False,
password: Union[None, str, bytes] = None,
) -> None:
self.strict = strict
self.flattened_pages: Optional[List[PageObject]] = None
self.resolved_objects: Dict[Tuple[Any, Any], Optional[PdfObject]] = {}
self.xref_index = 0
self._page_id2num: Optional[
Dict[Any, Any]
] = None # map page indirect_ref number to Page Number
if hasattr(stream, "mode") and "b" not in stream.mode: # type: ignore
logger_warning(
"PdfReader stream/file object is not in binary mode. "
"It may not be read correctly.",
__name__,
)
if isinstance(stream, (str, Path)):
with open(stream, "rb") as fh:
stream = BytesIO(fh.read())
self.read(stream)
self.stream = stream
self._override_encryption = False
self._encryption: Optional[Encryption] = None
if self.is_encrypted:
self._override_encryption = True
# Some documents may not have a /ID, use two empty
# byte strings instead. Solves
# https://github.com/mstamy2/PyPDF2/issues/608
id_entry = self.trailer.get(TK.ID)
id1_entry = id_entry[0].get_object().original_bytes if id_entry else b""
encrypt_entry = cast(
DictionaryObject, self.trailer[TK.ENCRYPT].get_object()
)
self._encryption = Encryption.read(encrypt_entry, id1_entry)
# try empty password if no password provided
pwd = password if password is not None else b""
if (
self._encryption.verify(pwd) == PasswordType.NOT_DECRYPTED
and password is not None
):
# raise if password provided
raise WrongPasswordError("Wrong password")
self._override_encryption = False
else:
if password is not None:
raise PdfReadError("Not encrypted file")
@property
def pdf_header(self) -> str:
# TODO: Make this return a bytes object for consistency
# but that needs a deprecation
loc = self.stream.tell()
self.stream.seek(0, 0)
pdf_file_version = self.stream.read(8).decode("utf-8")
self.stream.seek(loc, 0) # return to where it was
return pdf_file_version
@property
def metadata(self) -> Optional[DocumentInformation]:
"""
Retrieve the PDF file's document information dictionary, if it exists.
Note that some PDF files use metadata streams instead of docinfo
dictionaries, and these metadata streams will not be accessed by this
function.
:return: the document information of this PDF file
"""
if TK.INFO not in self.trailer:
return None
obj = self.trailer[TK.INFO]
retval = DocumentInformation()
if isinstance(obj, type(None)):
raise PdfReadError(
"trailer not found or does not point to document information directory"
)
retval.update(obj) # type: ignore
return retval
def getDocumentInfo(self) -> Optional[DocumentInformation]: # pragma: no cover
"""
.. deprecated:: 1.28.0
Use the attribute :py:attr:`metadata` instead.
"""
deprecate_with_replacement("getDocumentInfo", "metadata")
return self.metadata
@property
def documentInfo(self) -> Optional[DocumentInformation]: # pragma: no cover
"""
.. deprecated:: 1.28.0
Use the attribute :py:attr:`metadata` instead.
"""
deprecate_with_replacement("documentInfo", "metadata")
return self.metadata
@property
def xmp_metadata(self) -> Optional[XmpInformation]:
"""
XMP (Extensible Metadata Platform) data
:return: a :class:`XmpInformation<xmp.XmpInformation>`
instance that can be used to access XMP metadata from the document.
or ``None`` if no metadata was found on the document root.
"""
try:
self._override_encryption = True
return self.trailer[TK.ROOT].xmp_metadata # type: ignore
finally:
self._override_encryption = False
def getXmpMetadata(self) -> Optional[XmpInformation]: # pragma: no cover
"""
.. deprecated:: 1.28.0
Use the attribute :py:attr:`xmp_metadata` instead.
"""
deprecate_with_replacement("getXmpMetadata", "xmp_metadata")
return self.xmp_metadata
@property
def xmpMetadata(self) -> Optional[XmpInformation]: # pragma: no cover
"""
.. deprecated:: 1.28.0
Use the attribute :py:attr:`xmp_metadata` instead.
"""
deprecate_with_replacement("xmpMetadata", "xmp_metadata")
return self.xmp_metadata
def _get_num_pages(self) -> int:
"""
Calculate the number of pages in this PDF file.
:return: number of pages
:raises PdfReadError: if file is encrypted and restrictions prevent
this action.
"""
# Flattened pages will not work on an Encrypted PDF;
# the PDF file's page count is used in this case. Otherwise,
# the original method (flattened page count) is used.
if self.is_encrypted:
return self.trailer[TK.ROOT]["/Pages"]["/Count"] # type: ignore
else:
if self.flattened_pages is None:
self._flatten()
return len(self.flattened_pages) # type: ignore
def getNumPages(self) -> int: # pragma: no cover
"""
.. deprecated:: 1.28.0
Use :code:`len(reader.pages)` instead.
"""
deprecate_with_replacement("reader.getNumPages", "len(reader.pages)")
return self._get_num_pages()
@property
def numPages(self) -> int: # pragma: no cover
"""
.. deprecated:: 1.28.0
Use :code:`len(reader.pages)` instead.
"""
deprecate_with_replacement("reader.numPages", "len(reader.pages)")
return self._get_num_pages()
def getPage(self, pageNumber: int) -> PageObject: # pragma: no cover
"""
.. deprecated:: 1.28.0
Use :code:`reader.pages[pageNumber]` instead.
"""
deprecate_with_replacement(
"reader.getPage(pageNumber)", "reader.pages[pageNumber]"
)
return self._get_page(pageNumber)
def _get_page(self, page_number: int) -> PageObject:
"""
Retrieve a page by number from this PDF file.
:param int page_number: The page number to retrieve
(pages begin at zero)
:return: a :class:`PageObject<PyPDF2._page.PageObject>` instance.
"""
# ensure that we're not trying to access an encrypted PDF
# assert not self.trailer.has_key(TK.ENCRYPT)
if self.flattened_pages is None:
self._flatten()
assert self.flattened_pages is not None, "hint for mypy"
return self.flattened_pages[page_number]
@property
def namedDestinations(self) -> Dict[str, Any]: # pragma: no cover
"""
.. deprecated:: 1.28.0
Use :py:attr:`named_destinations` instead.
"""
deprecate_with_replacement("namedDestinations", "named_destinations")
return self.named_destinations
@property
def named_destinations(self) -> Dict[str, Any]:
"""
A read-only dictionary which maps names to
:class:`Destinations<PyPDF2.generic.Destination>`
"""
return self._get_named_destinations()
# A select group of relevant field attributes. For the complete list,
# see section 8.6.2 of the PDF 1.7 reference.
def get_fields(
self,
tree: Optional[TreeObject] = None,
retval: Optional[Dict[Any, Any]] = None,
fileobj: Optional[Any] = None,
) -> Optional[Dict[str, Any]]:
"""
Extract field data if this PDF contains interactive form fields.
The *tree* and *retval* parameters are for recursive use.
:param fileobj: A file object (usually a text file) to write
a report to on all interactive form fields found.
:return: A dictionary where each key is a field name, and each
value is a :class:`Field<PyPDF2.generic.Field>` object. By
default, the mapping name is used for keys.
``None`` if form data could not be located.
"""
field_attributes = FieldDictionaryAttributes.attributes_dict()
field_attributes.update(CheckboxRadioButtonAttributes.attributes_dict())
if retval is None:
retval = {}
catalog = cast(DictionaryObject, self.trailer[TK.ROOT])
# get the AcroForm tree
if CD.ACRO_FORM in catalog:
tree = cast(Optional[TreeObject], catalog[CD.ACRO_FORM])
else:
return None
if tree is None:
return retval
self._check_kids(tree, retval, fileobj)
for attr in field_attributes:
if attr in tree:
# Tree is a field
self._build_field(tree, retval, fileobj, field_attributes)
break
if "/Fields" in tree:
fields = cast(ArrayObject, tree["/Fields"])
for f in fields:
field = f.get_object()
self._build_field(field, retval, fileobj, field_attributes)
return retval
def getFields(
self,
tree: Optional[TreeObject] = None,
retval: Optional[Dict[Any, Any]] = None,
fileobj: Optional[Any] = None,
) -> Optional[Dict[str, Any]]: # pragma: no cover
"""
.. deprecated:: 1.28.0
Use :meth:`get_fields` instead.
"""
deprecate_with_replacement("getFields", "get_fields")
return self.get_fields(tree, retval, fileobj)
def _build_field(
self,
field: Union[TreeObject, DictionaryObject],
retval: Dict[Any, Any],
fileobj: Any,
field_attributes: Any,
) -> None:
self._check_kids(field, retval, fileobj)
try:
key = field["/TM"]
except KeyError:
try:
key = field["/T"]
except KeyError:
# Ignore no-name field for now
return
if fileobj:
self._write_field(fileobj, field, field_attributes)
fileobj.write("\n")
retval[key] = Field(field)
def _check_kids(
self, tree: Union[TreeObject, DictionaryObject], retval: Any, fileobj: Any
) -> None:
if PA.KIDS in tree:
# recurse down the tree
for kid in tree[PA.KIDS]: # type: ignore
self.get_fields(kid.get_object(), retval, fileobj)
def _write_field(self, fileobj: Any, field: Any, field_attributes: Any) -> None:
field_attributes_tuple = FieldDictionaryAttributes.attributes()
field_attributes_tuple = (
field_attributes_tuple + CheckboxRadioButtonAttributes.attributes()
)
for attr in field_attributes_tuple:
if attr in (
FieldDictionaryAttributes.Kids,
FieldDictionaryAttributes.AA,
):
continue
attr_name = field_attributes[attr]
try:
if attr == FieldDictionaryAttributes.FT:
# Make the field type value more clear
types = {
"/Btn": "Button",
"/Tx": "Text",
"/Ch": "Choice",
"/Sig": "Signature",
}
if field[attr] in types:
fileobj.write(attr_name + ": " + types[field[attr]] + "\n")
elif attr == FieldDictionaryAttributes.Parent:
# Let's just write the name of the parent
try:
name = field[attr][FieldDictionaryAttributes.TM]
except KeyError:
name = field[attr][FieldDictionaryAttributes.T]
fileobj.write(attr_name + ": " + name + "\n")
else:
fileobj.write(attr_name + ": " + str(field[attr]) + "\n")
except KeyError:
# Field attribute is N/A or unknown, so don't write anything
pass
def get_form_text_fields(self) -> Dict[str, Any]:
"""
Retrieve form fields from the document with textual data.
The key is the name of the form field, the value is the content of the
field.
If the document contains multiple form fields with the same name, the
second and following will get the suffix _2, _3, ...
"""
# Retrieve document form fields
formfields = self.get_fields()
if formfields is None:
return {}
return {
formfields[field]["/T"]: formfields[field].get("/V")
for field in formfields
if formfields[field].get("/FT") == "/Tx"
}
def getFormTextFields(self) -> Dict[str, Any]: # pragma: no cover
"""
.. deprecated:: 1.28.0
Use :meth:`get_form_text_fields` instead.
"""
deprecate_with_replacement("getFormTextFields", "get_form_text_fields")
return self.get_form_text_fields()
def _get_named_destinations(
self,
tree: Union[TreeObject, None] = None,
retval: Optional[Any] = None,
) -> Dict[str, Any]:
"""
Retrieve the named destinations present in the document.
:return: a dictionary which maps names to
:class:`Destinations<PyPDF2.generic.Destination>`.
"""
if retval is None:
retval = {}
catalog = cast(DictionaryObject, self.trailer[TK.ROOT])
# get the name tree
if CA.DESTS in catalog:
tree = cast(TreeObject, catalog[CA.DESTS])
elif CA.NAMES in catalog:
names = cast(DictionaryObject, catalog[CA.NAMES])
if CA.DESTS in names:
tree = cast(TreeObject, names[CA.DESTS])
if tree is None:
return retval
if PA.KIDS in tree:
# recurse down the tree
for kid in cast(ArrayObject, tree[PA.KIDS]):
self._get_named_destinations(kid.get_object(), retval)
# TABLE 3.33 Entries in a name tree node dictionary (PDF 1.7 specs)
elif CA.NAMES in tree: # KIDS and NAMES are exclusives (PDF 1.7 specs p 162)
names = cast(DictionaryObject, tree[CA.NAMES])
for i in range(0, len(names), 2):
key = cast(str, names[i].get_object())
value = names[i + 1].get_object()
if isinstance(value, DictionaryObject) and "/D" in value:
value = value["/D"]
dest = self._build_destination(key, value) # type: ignore
if dest is not None:
retval[key] = dest
else: # case where Dests is in root catalog (PDF 1.7 specs, §2 about PDF1.1
for k__, v__ in tree.items():
val = v__.get_object()
dest = self._build_destination(k__, val)
if dest is not None:
retval[k__] = dest
return retval
def getNamedDestinations(
self,
tree: Union[TreeObject, None] = None,
retval: Optional[Any] = None,
) -> Dict[str, Any]: # pragma: no cover
"""
.. deprecated:: 1.28.0
Use :py:attr:`named_destinations` instead.
"""
deprecate_with_replacement("getNamedDestinations", "named_destinations")
return self._get_named_destinations(tree, retval)
@property
def outline(self) -> OutlineType:
"""
Read-only property for the outline (i.e., a collection of 'outline items'
which are also known as 'bookmarks') present in the document.
:return: a nested list of :class:`Destinations<PyPDF2.generic.Destination>`.
"""
return self._get_outline()
@property
def outlines(self) -> OutlineType: # pragma: no cover
"""
.. deprecated:: 2.9.0
Use :py:attr:`outline` instead.
"""
deprecate_with_replacement("outlines", "outline")
return self.outline
def _get_outline(
self, node: Optional[DictionaryObject] = None, outline: Optional[Any] = None
) -> OutlineType:
if outline is None:
outline = []
catalog = cast(DictionaryObject, self.trailer[TK.ROOT])
# get the outline dictionary and named destinations
if CO.OUTLINES in catalog:
lines = cast(DictionaryObject, catalog[CO.OUTLINES])
if isinstance(lines, NullObject):
return outline
# TABLE 8.3 Entries in the outline dictionary
if lines is not None and "/First" in lines:
node = cast(DictionaryObject, lines["/First"])
self._namedDests = self._get_named_destinations()
if node is None:
return outline
# see if there are any more outline items
while True:
outline_obj = self._build_outline_item(node)
if outline_obj:
outline.append(outline_obj)
# check for sub-outline
if "/First" in node:
sub_outline: List[Any] = []
self._get_outline(cast(DictionaryObject, node["/First"]), sub_outline)
if sub_outline:
outline.append(sub_outline)
if "/Next" not in node:
break
node = cast(DictionaryObject, node["/Next"])
return outline
def getOutlines(
self, node: Optional[DictionaryObject] = None, outline: Optional[Any] = None
) -> OutlineType: # pragma: no cover
"""
.. deprecated:: 1.28.0
Use :py:attr:`outline` instead.
"""
deprecate_with_replacement("getOutlines", "outline")
return self._get_outline(node, outline)
def _get_page_number_by_indirect(
self, indirect_ref: Union[None, int, NullObject, IndirectObject]
) -> int:
"""Generate _page_id2num"""
if self._page_id2num is None:
self._page_id2num = {
x.indirect_ref.idnum: i for i, x in enumerate(self.pages) # type: ignore
}
if indirect_ref is None or isinstance(indirect_ref, NullObject):
return -1
if isinstance(indirect_ref, int):
idnum = indirect_ref
else:
idnum = indirect_ref.idnum
assert self._page_id2num is not None, "hint for mypy"
ret = self._page_id2num.get(idnum, -1)
return ret
def get_page_number(self, page: PageObject) -> int:
"""
Retrieve page number of a given PageObject
:param PageObject page: The page to get page number. Should be
an instance of :class:`PageObject<PyPDF2._page.PageObject>`
:return: the page number or -1 if page not found
"""
return self._get_page_number_by_indirect(page.indirect_ref)
def getPageNumber(self, page: PageObject) -> int: # pragma: no cover
"""
.. deprecated:: 1.28.0
Use :meth:`get_page_number` instead.
"""
deprecate_with_replacement("getPageNumber", "get_page_number")
return self.get_page_number(page)
def get_destination_page_number(self, destination: Destination) -> int:
"""
Retrieve page number of a given Destination object.
:param Destination destination: The destination to get page number.
:return: the page number or -1 if page not found
"""
return self._get_page_number_by_indirect(destination.page)
def getDestinationPageNumber(
self, destination: Destination
) -> int: # pragma: no cover
"""
.. deprecated:: 1.28.0
Use :meth:`get_destination_page_number` instead.
"""
deprecate_with_replacement(
"getDestinationPageNumber", "get_destination_page_number"
)
return self.get_destination_page_number(destination)
def _build_destination(
self,
title: str,
array: List[Union[NumberObject, IndirectObject, NullObject, DictionaryObject]],
) -> Destination:
page, typ = None, None
# handle outline items with missing or invalid destination
if (
isinstance(array, (type(None), NullObject))
or (isinstance(array, ArrayObject) and len(array) == 0)
or (isinstance(array, str))
):
page = NullObject()
return Destination(title, page, Fit.fit())
else:
page, typ = array[0:2] # type: ignore
array = array[2:]
try:
return Destination(title, page, Fit(fit_type=typ, fit_args=array)) # type: ignore
except PdfReadError:
logger_warning(f"Unknown destination: {title} {array}", __name__)
if self.strict:
raise
# create a link to first Page
tmp = self.pages[0].indirect_ref
indirect_ref = NullObject() if tmp is None else tmp
return Destination(title, indirect_ref, Fit.fit()) # type: ignore
def _build_outline_item(self, node: DictionaryObject) -> Optional[Destination]:
dest, title, outline_item = None, None, None
# title required for valid outline
# PDF Reference 1.7: TABLE 8.4 Entries in an outline item dictionary
try:
title = node["/Title"]
except KeyError:
if self.strict:
raise PdfReadError(f"Outline Entry Missing /Title attribute: {node!r}")
title = "" # type: ignore
if "/A" in node:
# Action, PDFv1.7 Section 12.6 (only type GoTo supported)
action = cast(DictionaryObject, node["/A"])
action_type = cast(NameObject, action[GoToActionArguments.S])
if action_type == "/GoTo":
dest = action[GoToActionArguments.D]
elif "/Dest" in node:
# Destination, PDFv1.7 Section 12.3.2
dest = node["/Dest"]
# if array was referenced in another object, will be a dict w/ key "/D"
if isinstance(dest, DictionaryObject) and "/D" in dest:
dest = dest["/D"]
if isinstance(dest, ArrayObject):
outline_item = self._build_destination(title, dest) # type: ignore
elif isinstance(dest, str):
# named destination, addresses NameObject Issue #193
try:
outline_item = self._build_destination(
title, self._namedDests[dest].dest_array
)
except KeyError:
# named destination not found in Name Dict
outline_item = self._build_destination(title, None)
elif isinstance(dest, type(None)):
# outline item not required to have destination or action
# PDFv1.7 Table 153
outline_item = self._build_destination(title, dest) # type: ignore
else:
if self.strict:
raise PdfReadError(f"Unexpected destination {dest!r}")
outline_item = self._build_destination(title, None) # type: ignore
# if outline item created, add color, format, and child count if present
if outline_item:
if "/C" in node:
# Color of outline item font in (R, G, B) with values ranging 0.0-1.0
outline_item[NameObject("/C")] = ArrayObject(FloatObject(c) for c in node["/C"]) # type: ignore
if "/F" in node:
# specifies style characteristics bold and/or italic
# 1=italic, 2=bold, 3=both
outline_item[NameObject("/F")] = node["/F"]
if "/Count" in node:
# absolute value = num. visible children
# positive = open/unfolded, negative = closed/folded
outline_item[NameObject("/Count")] = node["/Count"]
return outline_item
@property
def pages(self) -> List[PageObject]:
"""Read-only property that emulates a list of :py:class:`Page<PyPDF2._page.Page>` objects."""
return _VirtualList(self._get_num_pages, self._get_page) # type: ignore
@property
def page_layout(self) -> Optional[str]:
"""
Get the page layout.
:return: Page layout currently being used.
.. list-table:: Valid ``layout`` values
:widths: 50 200
* - /NoLayout
- Layout explicitly not specified
* - /SinglePage
- Show one page at a time
* - /OneColumn
- Show one column at a time
* - /TwoColumnLeft
- Show pages in two columns, odd-numbered pages on the left
* - /TwoColumnRight
- Show pages in two columns, odd-numbered pages on the right
* - /TwoPageLeft
- Show two pages at a time, odd-numbered pages on the left
* - /TwoPageRight
- Show two pages at a time, odd-numbered pages on the right
"""
trailer = cast(DictionaryObject, self.trailer[TK.ROOT])
if CD.PAGE_LAYOUT in trailer:
return cast(NameObject, trailer[CD.PAGE_LAYOUT])
return None
def getPageLayout(self) -> Optional[str]: # pragma: no cover
"""
.. deprecated:: 1.28.0
Use :py:attr:`page_layout` instead.
"""
deprecate_with_replacement("getPageLayout", "page_layout")
return self.page_layout
@property
def pageLayout(self) -> Optional[str]: # pragma: no cover
"""