PdfParser.py 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994
  1. import calendar
  2. import codecs
  3. import collections
  4. import mmap
  5. import os
  6. import re
  7. import time
  8. import zlib
  9. # see 7.9.2.2 Text String Type on page 86 and D.3 PDFDocEncoding Character Set
  10. # on page 656
  11. def encode_text(s):
  12. return codecs.BOM_UTF16_BE + s.encode("utf_16_be")
  13. PDFDocEncoding = {
  14. 0x16: "\u0017",
  15. 0x18: "\u02D8",
  16. 0x19: "\u02C7",
  17. 0x1A: "\u02C6",
  18. 0x1B: "\u02D9",
  19. 0x1C: "\u02DD",
  20. 0x1D: "\u02DB",
  21. 0x1E: "\u02DA",
  22. 0x1F: "\u02DC",
  23. 0x80: "\u2022",
  24. 0x81: "\u2020",
  25. 0x82: "\u2021",
  26. 0x83: "\u2026",
  27. 0x84: "\u2014",
  28. 0x85: "\u2013",
  29. 0x86: "\u0192",
  30. 0x87: "\u2044",
  31. 0x88: "\u2039",
  32. 0x89: "\u203A",
  33. 0x8A: "\u2212",
  34. 0x8B: "\u2030",
  35. 0x8C: "\u201E",
  36. 0x8D: "\u201C",
  37. 0x8E: "\u201D",
  38. 0x8F: "\u2018",
  39. 0x90: "\u2019",
  40. 0x91: "\u201A",
  41. 0x92: "\u2122",
  42. 0x93: "\uFB01",
  43. 0x94: "\uFB02",
  44. 0x95: "\u0141",
  45. 0x96: "\u0152",
  46. 0x97: "\u0160",
  47. 0x98: "\u0178",
  48. 0x99: "\u017D",
  49. 0x9A: "\u0131",
  50. 0x9B: "\u0142",
  51. 0x9C: "\u0153",
  52. 0x9D: "\u0161",
  53. 0x9E: "\u017E",
  54. 0xA0: "\u20AC",
  55. }
  56. def decode_text(b):
  57. if b[: len(codecs.BOM_UTF16_BE)] == codecs.BOM_UTF16_BE:
  58. return b[len(codecs.BOM_UTF16_BE) :].decode("utf_16_be")
  59. else:
  60. return "".join(PDFDocEncoding.get(byte, chr(byte)) for byte in b)
  61. class PdfFormatError(RuntimeError):
  62. """An error that probably indicates a syntactic or semantic error in the
  63. PDF file structure"""
  64. pass
  65. def check_format_condition(condition, error_message):
  66. if not condition:
  67. raise PdfFormatError(error_message)
  68. class IndirectReference(
  69. collections.namedtuple("IndirectReferenceTuple", ["object_id", "generation"])
  70. ):
  71. def __str__(self):
  72. return "%s %s R" % self
  73. def __bytes__(self):
  74. return self.__str__().encode("us-ascii")
  75. def __eq__(self, other):
  76. return (
  77. other.__class__ is self.__class__
  78. and other.object_id == self.object_id
  79. and other.generation == self.generation
  80. )
  81. def __ne__(self, other):
  82. return not (self == other)
  83. def __hash__(self):
  84. return hash((self.object_id, self.generation))
  85. class IndirectObjectDef(IndirectReference):
  86. def __str__(self):
  87. return "%s %s obj" % self
  88. class XrefTable:
  89. def __init__(self):
  90. self.existing_entries = {} # object ID => (offset, generation)
  91. self.new_entries = {} # object ID => (offset, generation)
  92. self.deleted_entries = {0: 65536} # object ID => generation
  93. self.reading_finished = False
  94. def __setitem__(self, key, value):
  95. if self.reading_finished:
  96. self.new_entries[key] = value
  97. else:
  98. self.existing_entries[key] = value
  99. if key in self.deleted_entries:
  100. del self.deleted_entries[key]
  101. def __getitem__(self, key):
  102. try:
  103. return self.new_entries[key]
  104. except KeyError:
  105. return self.existing_entries[key]
  106. def __delitem__(self, key):
  107. if key in self.new_entries:
  108. generation = self.new_entries[key][1] + 1
  109. del self.new_entries[key]
  110. self.deleted_entries[key] = generation
  111. elif key in self.existing_entries:
  112. generation = self.existing_entries[key][1] + 1
  113. self.deleted_entries[key] = generation
  114. elif key in self.deleted_entries:
  115. generation = self.deleted_entries[key]
  116. else:
  117. raise IndexError(
  118. "object ID " + str(key) + " cannot be deleted because it doesn't exist"
  119. )
  120. def __contains__(self, key):
  121. return key in self.existing_entries or key in self.new_entries
  122. def __len__(self):
  123. return len(
  124. set(self.existing_entries.keys())
  125. | set(self.new_entries.keys())
  126. | set(self.deleted_entries.keys())
  127. )
  128. def keys(self):
  129. return (
  130. set(self.existing_entries.keys()) - set(self.deleted_entries.keys())
  131. ) | set(self.new_entries.keys())
  132. def write(self, f):
  133. keys = sorted(set(self.new_entries.keys()) | set(self.deleted_entries.keys()))
  134. deleted_keys = sorted(set(self.deleted_entries.keys()))
  135. startxref = f.tell()
  136. f.write(b"xref\n")
  137. while keys:
  138. # find a contiguous sequence of object IDs
  139. prev = None
  140. for index, key in enumerate(keys):
  141. if prev is None or prev + 1 == key:
  142. prev = key
  143. else:
  144. contiguous_keys = keys[:index]
  145. keys = keys[index:]
  146. break
  147. else:
  148. contiguous_keys = keys
  149. keys = None
  150. f.write(b"%d %d\n" % (contiguous_keys[0], len(contiguous_keys)))
  151. for object_id in contiguous_keys:
  152. if object_id in self.new_entries:
  153. f.write(b"%010d %05d n \n" % self.new_entries[object_id])
  154. else:
  155. this_deleted_object_id = deleted_keys.pop(0)
  156. check_format_condition(
  157. object_id == this_deleted_object_id,
  158. f"expected the next deleted object ID to be {object_id}, "
  159. f"instead found {this_deleted_object_id}",
  160. )
  161. try:
  162. next_in_linked_list = deleted_keys[0]
  163. except IndexError:
  164. next_in_linked_list = 0
  165. f.write(
  166. b"%010d %05d f \n"
  167. % (next_in_linked_list, self.deleted_entries[object_id])
  168. )
  169. return startxref
  170. class PdfName:
  171. def __init__(self, name):
  172. if isinstance(name, PdfName):
  173. self.name = name.name
  174. elif isinstance(name, bytes):
  175. self.name = name
  176. else:
  177. self.name = name.encode("us-ascii")
  178. def name_as_str(self):
  179. return self.name.decode("us-ascii")
  180. def __eq__(self, other):
  181. return (
  182. isinstance(other, PdfName) and other.name == self.name
  183. ) or other == self.name
  184. def __hash__(self):
  185. return hash(self.name)
  186. def __repr__(self):
  187. return f"PdfName({repr(self.name)})"
  188. @classmethod
  189. def from_pdf_stream(cls, data):
  190. return cls(PdfParser.interpret_name(data))
  191. allowed_chars = set(range(33, 127)) - {ord(c) for c in "#%/()<>[]{}"}
  192. def __bytes__(self):
  193. result = bytearray(b"/")
  194. for b in self.name:
  195. if b in self.allowed_chars:
  196. result.append(b)
  197. else:
  198. result.extend(b"#%02X" % b)
  199. return bytes(result)
  200. class PdfArray(list):
  201. def __bytes__(self):
  202. return b"[ " + b" ".join(pdf_repr(x) for x in self) + b" ]"
  203. class PdfDict(collections.UserDict):
  204. def __setattr__(self, key, value):
  205. if key == "data":
  206. collections.UserDict.__setattr__(self, key, value)
  207. else:
  208. self[key.encode("us-ascii")] = value
  209. def __getattr__(self, key):
  210. try:
  211. value = self[key.encode("us-ascii")]
  212. except KeyError as e:
  213. raise AttributeError(key) from e
  214. if isinstance(value, bytes):
  215. value = decode_text(value)
  216. if key.endswith("Date"):
  217. if value.startswith("D:"):
  218. value = value[2:]
  219. relationship = "Z"
  220. if len(value) > 17:
  221. relationship = value[14]
  222. offset = int(value[15:17]) * 60
  223. if len(value) > 20:
  224. offset += int(value[18:20])
  225. format = "%Y%m%d%H%M%S"[: len(value) - 2]
  226. value = time.strptime(value[: len(format) + 2], format)
  227. if relationship in ["+", "-"]:
  228. offset *= 60
  229. if relationship == "+":
  230. offset *= -1
  231. value = time.gmtime(calendar.timegm(value) + offset)
  232. return value
  233. def __bytes__(self):
  234. out = bytearray(b"<<")
  235. for key, value in self.items():
  236. if value is None:
  237. continue
  238. value = pdf_repr(value)
  239. out.extend(b"\n")
  240. out.extend(bytes(PdfName(key)))
  241. out.extend(b" ")
  242. out.extend(value)
  243. out.extend(b"\n>>")
  244. return bytes(out)
  245. class PdfBinary:
  246. def __init__(self, data):
  247. self.data = data
  248. def __bytes__(self):
  249. return b"<%s>" % b"".join(b"%02X" % b for b in self.data)
  250. class PdfStream:
  251. def __init__(self, dictionary, buf):
  252. self.dictionary = dictionary
  253. self.buf = buf
  254. def decode(self):
  255. try:
  256. filter = self.dictionary.Filter
  257. except AttributeError:
  258. return self.buf
  259. if filter == b"FlateDecode":
  260. try:
  261. expected_length = self.dictionary.DL
  262. except AttributeError:
  263. expected_length = self.dictionary.Length
  264. return zlib.decompress(self.buf, bufsize=int(expected_length))
  265. else:
  266. raise NotImplementedError(
  267. f"stream filter {repr(self.dictionary.Filter)} unknown/unsupported"
  268. )
  269. def pdf_repr(x):
  270. if x is True:
  271. return b"true"
  272. elif x is False:
  273. return b"false"
  274. elif x is None:
  275. return b"null"
  276. elif isinstance(x, (PdfName, PdfDict, PdfArray, PdfBinary)):
  277. return bytes(x)
  278. elif isinstance(x, int):
  279. return str(x).encode("us-ascii")
  280. elif isinstance(x, time.struct_time):
  281. return b"(D:" + time.strftime("%Y%m%d%H%M%SZ", x).encode("us-ascii") + b")"
  282. elif isinstance(x, dict):
  283. return bytes(PdfDict(x))
  284. elif isinstance(x, list):
  285. return bytes(PdfArray(x))
  286. elif isinstance(x, str):
  287. return pdf_repr(encode_text(x))
  288. elif isinstance(x, bytes):
  289. # XXX escape more chars? handle binary garbage
  290. x = x.replace(b"\\", b"\\\\")
  291. x = x.replace(b"(", b"\\(")
  292. x = x.replace(b")", b"\\)")
  293. return b"(" + x + b")"
  294. else:
  295. return bytes(x)
  296. class PdfParser:
  297. """Based on
  298. https://www.adobe.com/content/dam/acom/en/devnet/acrobat/pdfs/PDF32000_2008.pdf
  299. Supports PDF up to 1.4
  300. """
  301. def __init__(self, filename=None, f=None, buf=None, start_offset=0, mode="rb"):
  302. if buf and f:
  303. raise RuntimeError("specify buf or f or filename, but not both buf and f")
  304. self.filename = filename
  305. self.buf = buf
  306. self.f = f
  307. self.start_offset = start_offset
  308. self.should_close_buf = False
  309. self.should_close_file = False
  310. if filename is not None and f is None:
  311. self.f = f = open(filename, mode)
  312. self.should_close_file = True
  313. if f is not None:
  314. self.buf = buf = self.get_buf_from_file(f)
  315. self.should_close_buf = True
  316. if not filename and hasattr(f, "name"):
  317. self.filename = f.name
  318. self.cached_objects = {}
  319. if buf:
  320. self.read_pdf_info()
  321. else:
  322. self.file_size_total = self.file_size_this = 0
  323. self.root = PdfDict()
  324. self.root_ref = None
  325. self.info = PdfDict()
  326. self.info_ref = None
  327. self.page_tree_root = {}
  328. self.pages = []
  329. self.orig_pages = []
  330. self.pages_ref = None
  331. self.last_xref_section_offset = None
  332. self.trailer_dict = {}
  333. self.xref_table = XrefTable()
  334. self.xref_table.reading_finished = True
  335. if f:
  336. self.seek_end()
  337. def __enter__(self):
  338. return self
  339. def __exit__(self, exc_type, exc_value, traceback):
  340. self.close()
  341. return False # do not suppress exceptions
  342. def start_writing(self):
  343. self.close_buf()
  344. self.seek_end()
  345. def close_buf(self):
  346. try:
  347. self.buf.close()
  348. except AttributeError:
  349. pass
  350. self.buf = None
  351. def close(self):
  352. if self.should_close_buf:
  353. self.close_buf()
  354. if self.f is not None and self.should_close_file:
  355. self.f.close()
  356. self.f = None
  357. def seek_end(self):
  358. self.f.seek(0, os.SEEK_END)
  359. def write_header(self):
  360. self.f.write(b"%PDF-1.4\n")
  361. def write_comment(self, s):
  362. self.f.write(f"% {s}\n".encode("utf-8"))
  363. def write_catalog(self):
  364. self.del_root()
  365. self.root_ref = self.next_object_id(self.f.tell())
  366. self.pages_ref = self.next_object_id(0)
  367. self.rewrite_pages()
  368. self.write_obj(self.root_ref, Type=PdfName(b"Catalog"), Pages=self.pages_ref)
  369. self.write_obj(
  370. self.pages_ref,
  371. Type=PdfName(b"Pages"),
  372. Count=len(self.pages),
  373. Kids=self.pages,
  374. )
  375. return self.root_ref
  376. def rewrite_pages(self):
  377. pages_tree_nodes_to_delete = []
  378. for i, page_ref in enumerate(self.orig_pages):
  379. page_info = self.cached_objects[page_ref]
  380. del self.xref_table[page_ref.object_id]
  381. pages_tree_nodes_to_delete.append(page_info[PdfName(b"Parent")])
  382. if page_ref not in self.pages:
  383. # the page has been deleted
  384. continue
  385. # make dict keys into strings for passing to write_page
  386. stringified_page_info = {}
  387. for key, value in page_info.items():
  388. # key should be a PdfName
  389. stringified_page_info[key.name_as_str()] = value
  390. stringified_page_info["Parent"] = self.pages_ref
  391. new_page_ref = self.write_page(None, **stringified_page_info)
  392. for j, cur_page_ref in enumerate(self.pages):
  393. if cur_page_ref == page_ref:
  394. # replace the page reference with the new one
  395. self.pages[j] = new_page_ref
  396. # delete redundant Pages tree nodes from xref table
  397. for pages_tree_node_ref in pages_tree_nodes_to_delete:
  398. while pages_tree_node_ref:
  399. pages_tree_node = self.cached_objects[pages_tree_node_ref]
  400. if pages_tree_node_ref.object_id in self.xref_table:
  401. del self.xref_table[pages_tree_node_ref.object_id]
  402. pages_tree_node_ref = pages_tree_node.get(b"Parent", None)
  403. self.orig_pages = []
  404. def write_xref_and_trailer(self, new_root_ref=None):
  405. if new_root_ref:
  406. self.del_root()
  407. self.root_ref = new_root_ref
  408. if self.info:
  409. self.info_ref = self.write_obj(None, self.info)
  410. start_xref = self.xref_table.write(self.f)
  411. num_entries = len(self.xref_table)
  412. trailer_dict = {b"Root": self.root_ref, b"Size": num_entries}
  413. if self.last_xref_section_offset is not None:
  414. trailer_dict[b"Prev"] = self.last_xref_section_offset
  415. if self.info:
  416. trailer_dict[b"Info"] = self.info_ref
  417. self.last_xref_section_offset = start_xref
  418. self.f.write(
  419. b"trailer\n"
  420. + bytes(PdfDict(trailer_dict))
  421. + b"\nstartxref\n%d\n%%%%EOF" % start_xref
  422. )
  423. def write_page(self, ref, *objs, **dict_obj):
  424. if isinstance(ref, int):
  425. ref = self.pages[ref]
  426. if "Type" not in dict_obj:
  427. dict_obj["Type"] = PdfName(b"Page")
  428. if "Parent" not in dict_obj:
  429. dict_obj["Parent"] = self.pages_ref
  430. return self.write_obj(ref, *objs, **dict_obj)
  431. def write_obj(self, ref, *objs, **dict_obj):
  432. f = self.f
  433. if ref is None:
  434. ref = self.next_object_id(f.tell())
  435. else:
  436. self.xref_table[ref.object_id] = (f.tell(), ref.generation)
  437. f.write(bytes(IndirectObjectDef(*ref)))
  438. stream = dict_obj.pop("stream", None)
  439. if stream is not None:
  440. dict_obj["Length"] = len(stream)
  441. if dict_obj:
  442. f.write(pdf_repr(dict_obj))
  443. for obj in objs:
  444. f.write(pdf_repr(obj))
  445. if stream is not None:
  446. f.write(b"stream\n")
  447. f.write(stream)
  448. f.write(b"\nendstream\n")
  449. f.write(b"endobj\n")
  450. return ref
  451. def del_root(self):
  452. if self.root_ref is None:
  453. return
  454. del self.xref_table[self.root_ref.object_id]
  455. del self.xref_table[self.root[b"Pages"].object_id]
  456. @staticmethod
  457. def get_buf_from_file(f):
  458. if hasattr(f, "getbuffer"):
  459. return f.getbuffer()
  460. elif hasattr(f, "getvalue"):
  461. return f.getvalue()
  462. else:
  463. try:
  464. return mmap.mmap(f.fileno(), 0, access=mmap.ACCESS_READ)
  465. except ValueError: # cannot mmap an empty file
  466. return b""
  467. def read_pdf_info(self):
  468. self.file_size_total = len(self.buf)
  469. self.file_size_this = self.file_size_total - self.start_offset
  470. self.read_trailer()
  471. self.root_ref = self.trailer_dict[b"Root"]
  472. self.info_ref = self.trailer_dict.get(b"Info", None)
  473. self.root = PdfDict(self.read_indirect(self.root_ref))
  474. if self.info_ref is None:
  475. self.info = PdfDict()
  476. else:
  477. self.info = PdfDict(self.read_indirect(self.info_ref))
  478. check_format_condition(b"Type" in self.root, "/Type missing in Root")
  479. check_format_condition(
  480. self.root[b"Type"] == b"Catalog", "/Type in Root is not /Catalog"
  481. )
  482. check_format_condition(b"Pages" in self.root, "/Pages missing in Root")
  483. check_format_condition(
  484. isinstance(self.root[b"Pages"], IndirectReference),
  485. "/Pages in Root is not an indirect reference",
  486. )
  487. self.pages_ref = self.root[b"Pages"]
  488. self.page_tree_root = self.read_indirect(self.pages_ref)
  489. self.pages = self.linearize_page_tree(self.page_tree_root)
  490. # save the original list of page references
  491. # in case the user modifies, adds or deletes some pages
  492. # and we need to rewrite the pages and their list
  493. self.orig_pages = self.pages[:]
  494. def next_object_id(self, offset=None):
  495. try:
  496. # TODO: support reuse of deleted objects
  497. reference = IndirectReference(max(self.xref_table.keys()) + 1, 0)
  498. except ValueError:
  499. reference = IndirectReference(1, 0)
  500. if offset is not None:
  501. self.xref_table[reference.object_id] = (offset, 0)
  502. return reference
  503. delimiter = br"[][()<>{}/%]"
  504. delimiter_or_ws = br"[][()<>{}/%\000\011\012\014\015\040]"
  505. whitespace = br"[\000\011\012\014\015\040]"
  506. whitespace_or_hex = br"[\000\011\012\014\015\0400-9a-fA-F]"
  507. whitespace_optional = whitespace + b"*"
  508. whitespace_mandatory = whitespace + b"+"
  509. newline_only = br"[\r\n]+"
  510. newline = whitespace_optional + newline_only + whitespace_optional
  511. re_trailer_end = re.compile(
  512. whitespace_mandatory
  513. + br"trailer"
  514. + whitespace_optional
  515. + br"\<\<(.*\>\>)"
  516. + newline
  517. + br"startxref"
  518. + newline
  519. + br"([0-9]+)"
  520. + newline
  521. + br"%%EOF"
  522. + whitespace_optional
  523. + br"$",
  524. re.DOTALL,
  525. )
  526. re_trailer_prev = re.compile(
  527. whitespace_optional
  528. + br"trailer"
  529. + whitespace_optional
  530. + br"\<\<(.*?\>\>)"
  531. + newline
  532. + br"startxref"
  533. + newline
  534. + br"([0-9]+)"
  535. + newline
  536. + br"%%EOF"
  537. + whitespace_optional,
  538. re.DOTALL,
  539. )
  540. def read_trailer(self):
  541. search_start_offset = len(self.buf) - 16384
  542. if search_start_offset < self.start_offset:
  543. search_start_offset = self.start_offset
  544. m = self.re_trailer_end.search(self.buf, search_start_offset)
  545. check_format_condition(m, "trailer end not found")
  546. # make sure we found the LAST trailer
  547. last_match = m
  548. while m:
  549. last_match = m
  550. m = self.re_trailer_end.search(self.buf, m.start() + 16)
  551. if not m:
  552. m = last_match
  553. trailer_data = m.group(1)
  554. self.last_xref_section_offset = int(m.group(2))
  555. self.trailer_dict = self.interpret_trailer(trailer_data)
  556. self.xref_table = XrefTable()
  557. self.read_xref_table(xref_section_offset=self.last_xref_section_offset)
  558. if b"Prev" in self.trailer_dict:
  559. self.read_prev_trailer(self.trailer_dict[b"Prev"])
  560. def read_prev_trailer(self, xref_section_offset):
  561. trailer_offset = self.read_xref_table(xref_section_offset=xref_section_offset)
  562. m = self.re_trailer_prev.search(
  563. self.buf[trailer_offset : trailer_offset + 16384]
  564. )
  565. check_format_condition(m, "previous trailer not found")
  566. trailer_data = m.group(1)
  567. check_format_condition(
  568. int(m.group(2)) == xref_section_offset,
  569. "xref section offset in previous trailer doesn't match what was expected",
  570. )
  571. trailer_dict = self.interpret_trailer(trailer_data)
  572. if b"Prev" in trailer_dict:
  573. self.read_prev_trailer(trailer_dict[b"Prev"])
  574. re_whitespace_optional = re.compile(whitespace_optional)
  575. re_name = re.compile(
  576. whitespace_optional
  577. + br"/([!-$&'*-.0-;=?-Z\\^-z|~]+)(?="
  578. + delimiter_or_ws
  579. + br")"
  580. )
  581. re_dict_start = re.compile(whitespace_optional + br"\<\<")
  582. re_dict_end = re.compile(whitespace_optional + br"\>\>" + whitespace_optional)
  583. @classmethod
  584. def interpret_trailer(cls, trailer_data):
  585. trailer = {}
  586. offset = 0
  587. while True:
  588. m = cls.re_name.match(trailer_data, offset)
  589. if not m:
  590. m = cls.re_dict_end.match(trailer_data, offset)
  591. check_format_condition(
  592. m and m.end() == len(trailer_data),
  593. "name not found in trailer, remaining data: "
  594. + repr(trailer_data[offset:]),
  595. )
  596. break
  597. key = cls.interpret_name(m.group(1))
  598. value, offset = cls.get_value(trailer_data, m.end())
  599. trailer[key] = value
  600. check_format_condition(
  601. b"Size" in trailer and isinstance(trailer[b"Size"], int),
  602. "/Size not in trailer or not an integer",
  603. )
  604. check_format_condition(
  605. b"Root" in trailer and isinstance(trailer[b"Root"], IndirectReference),
  606. "/Root not in trailer or not an indirect reference",
  607. )
  608. return trailer
  609. re_hashes_in_name = re.compile(br"([^#]*)(#([0-9a-fA-F]{2}))?")
  610. @classmethod
  611. def interpret_name(cls, raw, as_text=False):
  612. name = b""
  613. for m in cls.re_hashes_in_name.finditer(raw):
  614. if m.group(3):
  615. name += m.group(1) + bytearray.fromhex(m.group(3).decode("us-ascii"))
  616. else:
  617. name += m.group(1)
  618. if as_text:
  619. return name.decode("utf-8")
  620. else:
  621. return bytes(name)
  622. re_null = re.compile(whitespace_optional + br"null(?=" + delimiter_or_ws + br")")
  623. re_true = re.compile(whitespace_optional + br"true(?=" + delimiter_or_ws + br")")
  624. re_false = re.compile(whitespace_optional + br"false(?=" + delimiter_or_ws + br")")
  625. re_int = re.compile(
  626. whitespace_optional + br"([-+]?[0-9]+)(?=" + delimiter_or_ws + br")"
  627. )
  628. re_real = re.compile(
  629. whitespace_optional
  630. + br"([-+]?([0-9]+\.[0-9]*|[0-9]*\.[0-9]+))(?="
  631. + delimiter_or_ws
  632. + br")"
  633. )
  634. re_array_start = re.compile(whitespace_optional + br"\[")
  635. re_array_end = re.compile(whitespace_optional + br"]")
  636. re_string_hex = re.compile(
  637. whitespace_optional + br"\<(" + whitespace_or_hex + br"*)\>"
  638. )
  639. re_string_lit = re.compile(whitespace_optional + br"\(")
  640. re_indirect_reference = re.compile(
  641. whitespace_optional
  642. + br"([-+]?[0-9]+)"
  643. + whitespace_mandatory
  644. + br"([-+]?[0-9]+)"
  645. + whitespace_mandatory
  646. + br"R(?="
  647. + delimiter_or_ws
  648. + br")"
  649. )
  650. re_indirect_def_start = re.compile(
  651. whitespace_optional
  652. + br"([-+]?[0-9]+)"
  653. + whitespace_mandatory
  654. + br"([-+]?[0-9]+)"
  655. + whitespace_mandatory
  656. + br"obj(?="
  657. + delimiter_or_ws
  658. + br")"
  659. )
  660. re_indirect_def_end = re.compile(
  661. whitespace_optional + br"endobj(?=" + delimiter_or_ws + br")"
  662. )
  663. re_comment = re.compile(
  664. br"(" + whitespace_optional + br"%[^\r\n]*" + newline + br")*"
  665. )
  666. re_stream_start = re.compile(whitespace_optional + br"stream\r?\n")
  667. re_stream_end = re.compile(
  668. whitespace_optional + br"endstream(?=" + delimiter_or_ws + br")"
  669. )
  670. @classmethod
  671. def get_value(cls, data, offset, expect_indirect=None, max_nesting=-1):
  672. if max_nesting == 0:
  673. return None, None
  674. m = cls.re_comment.match(data, offset)
  675. if m:
  676. offset = m.end()
  677. m = cls.re_indirect_def_start.match(data, offset)
  678. if m:
  679. check_format_condition(
  680. int(m.group(1)) > 0,
  681. "indirect object definition: object ID must be greater than 0",
  682. )
  683. check_format_condition(
  684. int(m.group(2)) >= 0,
  685. "indirect object definition: generation must be non-negative",
  686. )
  687. check_format_condition(
  688. expect_indirect is None
  689. or expect_indirect
  690. == IndirectReference(int(m.group(1)), int(m.group(2))),
  691. "indirect object definition different than expected",
  692. )
  693. object, offset = cls.get_value(data, m.end(), max_nesting=max_nesting - 1)
  694. if offset is None:
  695. return object, None
  696. m = cls.re_indirect_def_end.match(data, offset)
  697. check_format_condition(m, "indirect object definition end not found")
  698. return object, m.end()
  699. check_format_condition(
  700. not expect_indirect, "indirect object definition not found"
  701. )
  702. m = cls.re_indirect_reference.match(data, offset)
  703. if m:
  704. check_format_condition(
  705. int(m.group(1)) > 0,
  706. "indirect object reference: object ID must be greater than 0",
  707. )
  708. check_format_condition(
  709. int(m.group(2)) >= 0,
  710. "indirect object reference: generation must be non-negative",
  711. )
  712. return IndirectReference(int(m.group(1)), int(m.group(2))), m.end()
  713. m = cls.re_dict_start.match(data, offset)
  714. if m:
  715. offset = m.end()
  716. result = {}
  717. m = cls.re_dict_end.match(data, offset)
  718. while not m:
  719. key, offset = cls.get_value(data, offset, max_nesting=max_nesting - 1)
  720. if offset is None:
  721. return result, None
  722. value, offset = cls.get_value(data, offset, max_nesting=max_nesting - 1)
  723. result[key] = value
  724. if offset is None:
  725. return result, None
  726. m = cls.re_dict_end.match(data, offset)
  727. offset = m.end()
  728. m = cls.re_stream_start.match(data, offset)
  729. if m:
  730. try:
  731. stream_len = int(result[b"Length"])
  732. except (TypeError, KeyError, ValueError) as e:
  733. raise PdfFormatError(
  734. "bad or missing Length in stream dict (%r)"
  735. % result.get(b"Length", None)
  736. ) from e
  737. stream_data = data[m.end() : m.end() + stream_len]
  738. m = cls.re_stream_end.match(data, m.end() + stream_len)
  739. check_format_condition(m, "stream end not found")
  740. offset = m.end()
  741. result = PdfStream(PdfDict(result), stream_data)
  742. else:
  743. result = PdfDict(result)
  744. return result, offset
  745. m = cls.re_array_start.match(data, offset)
  746. if m:
  747. offset = m.end()
  748. result = []
  749. m = cls.re_array_end.match(data, offset)
  750. while not m:
  751. value, offset = cls.get_value(data, offset, max_nesting=max_nesting - 1)
  752. result.append(value)
  753. if offset is None:
  754. return result, None
  755. m = cls.re_array_end.match(data, offset)
  756. return result, m.end()
  757. m = cls.re_null.match(data, offset)
  758. if m:
  759. return None, m.end()
  760. m = cls.re_true.match(data, offset)
  761. if m:
  762. return True, m.end()
  763. m = cls.re_false.match(data, offset)
  764. if m:
  765. return False, m.end()
  766. m = cls.re_name.match(data, offset)
  767. if m:
  768. return PdfName(cls.interpret_name(m.group(1))), m.end()
  769. m = cls.re_int.match(data, offset)
  770. if m:
  771. return int(m.group(1)), m.end()
  772. m = cls.re_real.match(data, offset)
  773. if m:
  774. # XXX Decimal instead of float???
  775. return float(m.group(1)), m.end()
  776. m = cls.re_string_hex.match(data, offset)
  777. if m:
  778. # filter out whitespace
  779. hex_string = bytearray(
  780. [b for b in m.group(1) if b in b"0123456789abcdefABCDEF"]
  781. )
  782. if len(hex_string) % 2 == 1:
  783. # append a 0 if the length is not even - yes, at the end
  784. hex_string.append(ord(b"0"))
  785. return bytearray.fromhex(hex_string.decode("us-ascii")), m.end()
  786. m = cls.re_string_lit.match(data, offset)
  787. if m:
  788. return cls.get_literal_string(data, m.end())
  789. # return None, offset # fallback (only for debugging)
  790. raise PdfFormatError("unrecognized object: " + repr(data[offset : offset + 32]))
  791. re_lit_str_token = re.compile(
  792. br"(\\[nrtbf()\\])|(\\[0-9]{1,3})|(\\(\r\n|\r|\n))|(\r\n|\r|\n)|(\()|(\))"
  793. )
  794. escaped_chars = {
  795. b"n": b"\n",
  796. b"r": b"\r",
  797. b"t": b"\t",
  798. b"b": b"\b",
  799. b"f": b"\f",
  800. b"(": b"(",
  801. b")": b")",
  802. b"\\": b"\\",
  803. ord(b"n"): b"\n",
  804. ord(b"r"): b"\r",
  805. ord(b"t"): b"\t",
  806. ord(b"b"): b"\b",
  807. ord(b"f"): b"\f",
  808. ord(b"("): b"(",
  809. ord(b")"): b")",
  810. ord(b"\\"): b"\\",
  811. }
  812. @classmethod
  813. def get_literal_string(cls, data, offset):
  814. nesting_depth = 0
  815. result = bytearray()
  816. for m in cls.re_lit_str_token.finditer(data, offset):
  817. result.extend(data[offset : m.start()])
  818. if m.group(1):
  819. result.extend(cls.escaped_chars[m.group(1)[1]])
  820. elif m.group(2):
  821. result.append(int(m.group(2)[1:], 8))
  822. elif m.group(3):
  823. pass
  824. elif m.group(5):
  825. result.extend(b"\n")
  826. elif m.group(6):
  827. result.extend(b"(")
  828. nesting_depth += 1
  829. elif m.group(7):
  830. if nesting_depth == 0:
  831. return bytes(result), m.end()
  832. result.extend(b")")
  833. nesting_depth -= 1
  834. offset = m.end()
  835. raise PdfFormatError("unfinished literal string")
  836. re_xref_section_start = re.compile(whitespace_optional + br"xref" + newline)
  837. re_xref_subsection_start = re.compile(
  838. whitespace_optional
  839. + br"([0-9]+)"
  840. + whitespace_mandatory
  841. + br"([0-9]+)"
  842. + whitespace_optional
  843. + newline_only
  844. )
  845. re_xref_entry = re.compile(br"([0-9]{10}) ([0-9]{5}) ([fn])( \r| \n|\r\n)")
  846. def read_xref_table(self, xref_section_offset):
  847. subsection_found = False
  848. m = self.re_xref_section_start.match(
  849. self.buf, xref_section_offset + self.start_offset
  850. )
  851. check_format_condition(m, "xref section start not found")
  852. offset = m.end()
  853. while True:
  854. m = self.re_xref_subsection_start.match(self.buf, offset)
  855. if not m:
  856. check_format_condition(
  857. subsection_found, "xref subsection start not found"
  858. )
  859. break
  860. subsection_found = True
  861. offset = m.end()
  862. first_object = int(m.group(1))
  863. num_objects = int(m.group(2))
  864. for i in range(first_object, first_object + num_objects):
  865. m = self.re_xref_entry.match(self.buf, offset)
  866. check_format_condition(m, "xref entry not found")
  867. offset = m.end()
  868. is_free = m.group(3) == b"f"
  869. generation = int(m.group(2))
  870. if not is_free:
  871. new_entry = (int(m.group(1)), generation)
  872. check_format_condition(
  873. i not in self.xref_table or self.xref_table[i] == new_entry,
  874. "xref entry duplicated (and not identical)",
  875. )
  876. self.xref_table[i] = new_entry
  877. return offset
  878. def read_indirect(self, ref, max_nesting=-1):
  879. offset, generation = self.xref_table[ref[0]]
  880. check_format_condition(
  881. generation == ref[1],
  882. f"expected to find generation {ref[1]} for object ID {ref[0]} in xref "
  883. f"table, instead found generation {generation} at offset {offset}",
  884. )
  885. value = self.get_value(
  886. self.buf,
  887. offset + self.start_offset,
  888. expect_indirect=IndirectReference(*ref),
  889. max_nesting=max_nesting,
  890. )[0]
  891. self.cached_objects[ref] = value
  892. return value
  893. def linearize_page_tree(self, node=None):
  894. if node is None:
  895. node = self.page_tree_root
  896. check_format_condition(
  897. node[b"Type"] == b"Pages", "/Type of page tree node is not /Pages"
  898. )
  899. pages = []
  900. for kid in node[b"Kids"]:
  901. kid_object = self.read_indirect(kid)
  902. if kid_object[b"Type"] == b"Page":
  903. pages.append(kid)
  904. else:
  905. pages.extend(self.linearize_page_tree(node=kid_object))
  906. return pages