Module fpdf.output
This module contains the serialization logic that produces a PDF document from a FPDF instance. Most of the code in this module is used when FPDF.output() is called.
The contents of this module are internal to fpdf2, and not part of the public API. They may change at any time without prior warning or any deprecation period, in non-backward-compatible ways.
Expand source code Browse git
"""
This module contains the serialization logic that produces a PDF document from a FPDF instance.
Most of the code in this module is used when FPDF.output() is called.
The contents of this module are internal to fpdf2, and not part of the public API.
They may change at any time without prior warning or any deprecation period,
in non-backward-compatible ways.
"""
# pylint: disable=protected-access
import logging
from collections import defaultdict, OrderedDict
from contextlib import contextmanager
from io import BytesIO
from .annotations import PDFAnnotation
from .enums import SignatureFlag
from .errors import FPDFException
from .image_datastructures import RasterImageInfo
from .outline import build_outline_objs
from .sign import Signature, sign_content
from .syntax import (
build_obj_dict,
Name,
PDFArray,
PDFContentStream,
PDFDate,
PDFObject,
PDFString,
)
from .syntax import create_dictionary_string as pdf_dict
from .syntax import create_list_string as pdf_list
from .syntax import iobj_ref as pdf_ref
from fontTools import subset as ftsubset
try:
from endesive import signer
except ImportError:
signer = None
LOGGER = logging.getLogger(__name__)
ZOOM_CONFIGS = { # cf. section 8.2.1 "Destinations" of the 2006 PDF spec 1.7:
"fullpage": ("/Fit",),
"fullwidth": ("/FitH", "null"),
"real": ("/XYZ", "null", "null", "1"),
}
class ContentWithoutID:
def serialize(self, _security_handler=None):
pass
class PDFHeader(ContentWithoutID):
def __init__(self, pdf_version):
self.pdf_version = pdf_version
# method override
def serialize(self, _security_handler=None):
return f"%PDF-{self.pdf_version}"
class PDFFont(PDFObject):
def __init__(self, subtype, base_font, encoding=None, d_w=None, w=None):
super().__init__()
self.type = Name("Font")
self.subtype = Name(subtype)
self.base_font = Name(base_font)
self.encoding = Name(encoding) if encoding else None
self.d_w = d_w
self.w = w
self.descendant_fonts = None
self.to_unicode = None
self.c_i_d_system_info = None
self.font_descriptor = None
self.c_i_d_to_g_i_d_map = None
class CIDSystemInfo(PDFObject):
def __init__(self):
super().__init__()
self.registry = PDFString("Adobe", encrypt=True)
self.ordering = PDFString("UCS", encrypt=True)
self.supplement = 0
class PDFInfo(PDFObject):
def __init__(
self,
title,
subject,
author,
keywords,
creator,
producer,
creation_date: PDFDate,
):
super().__init__()
self.title = PDFString(title, encrypt=True) if title else None
self.subject = PDFString(subject, encrypt=True) if subject else None
self.author = PDFString(author, encrypt=True) if author else None
self.keywords = PDFString(keywords, encrypt=True) if keywords else None
self.creator = PDFString(creator, encrypt=True) if creator else None
self.producer = PDFString(producer, encrypt=True) if producer else None
self.creation_date = creation_date
class AcroForm:
def __init__(self, fields, sig_flags):
self.fields = fields
self.sig_flags = sig_flags
def serialize(self, _security_handler=None, _obj_id=None):
obj_dict = build_obj_dict(
{key: getattr(self, key) for key in dir(self)},
_security_handler=_security_handler,
_obj_id=_obj_id,
)
return pdf_dict(obj_dict, field_join=" ")
class PDFCatalog(PDFObject):
def __init__(
self, lang=None, page_layout=None, page_mode=None, viewer_preferences=None
):
super().__init__()
self.type = Name("Catalog")
self.lang = PDFString(lang) if lang else None
self.page_layout = page_layout
self.page_mode = page_mode
self.viewer_preferences = viewer_preferences
self.pages = None # Required; shall be an indirect reference
self.acro_form = None
self.open_action = None
self.mark_info = None
self.metadata = None
self.names = None
self.outlines = None
self.struct_tree_root = None
class PDFResources(PDFObject):
def __init__(self, proc_set, font, x_object, ext_g_state):
super().__init__()
self.proc_set = proc_set
self.font = font
self.x_object = x_object
self.ext_g_state = ext_g_state
class PDFFontStream(PDFContentStream):
def __init__(self, contents):
super().__init__(contents=contents, compress=True)
self.length1 = len(contents)
class PDFXmpMetadata(PDFContentStream):
def __init__(self, contents):
super().__init__(contents=contents.encode("utf-8"))
self.type = Name("Metadata")
self.subtype = Name("XML")
class PDFXObject(PDFContentStream):
__slots__ = ( # RAM usage optimization
"_id",
"_contents",
"filter",
"length",
"type",
"subtype",
"width",
"height",
"color_space",
"bits_per_component",
"decode",
"decode_parms",
"s_mask",
)
def __init__(
self,
contents,
subtype,
width,
height,
color_space,
bits_per_component,
img_filter=None,
decode=None,
decode_parms=None,
):
super().__init__(contents=contents)
self.type = Name("XObject")
self.subtype = Name(subtype)
self.width = width
self.height = height
self.color_space = color_space
self.bits_per_component = bits_per_component
self.filter = Name(img_filter)
self.decode = decode
self.decode_parms = decode_parms
self.s_mask = None
class PDFICCPObject(PDFContentStream):
__slots__ = ( # RAM usage optimization
"_id",
"_contents",
"filter",
"length",
"n",
"alternate",
)
def __init__(
self,
contents,
n,
alternate,
):
super().__init__(contents=contents, compress=True)
self.n = n
self.alternate = Name(alternate)
class PDFPage(PDFObject):
__slots__ = ( # RAM usage optimization
"_id",
"type",
"contents",
"dur",
"trans",
"annots",
"group",
"media_box",
"struct_parents",
"resources",
"parent",
"_index",
"_width_pt",
"_height_pt",
)
def __init__(
self,
duration,
transition,
contents,
index,
):
super().__init__()
self.type = Name("Page")
self.contents = contents
self.dur = duration if duration else None
self.trans = transition
self.annots = PDFArray() # list of PDFAnnotation
self.group = None
self.media_box = None
self.struct_parents = None
self.resources = None # must always be set before calling .serialize()
self.parent = None # must always be set before calling .serialize()
self._index = index
self._width_pt, self._height_pt = None, None
def index(self):
return self._index
def dimensions(self):
"Return a pair (width, height) in the unit specified to FPDF constructor"
return self._width_pt, self._height_pt
def set_dimensions(self, width_pt, height_pt):
"Accepts a pair (width, height) in the unit specified to FPDF constructor"
self._width_pt, self._height_pt = width_pt, height_pt
class PDFPagesRoot(PDFObject):
def __init__(self, count, media_box):
super().__init__()
self.type = Name("Pages")
self.count = count
self.media_box = media_box
self.kids = None # must always be set before calling .serialize()
class PDFExtGState(PDFObject):
def __init__(self, dict_as_str):
super().__init__()
self._dict_as_str = dict_as_str
# method override
def serialize(self, obj_dict=None, _security_handler=None):
return f"{self.id} 0 obj\n{self._dict_as_str}\nendobj"
class PDFXrefAndTrailer(ContentWithoutID):
def __init__(self, output_builder):
self.output_builder = output_builder
self.count = output_builder.obj_id + 1
# Must be set before the call to serialize():
self.catalog_obj = None
self.info_obj = None
self.encryption_obj = None
def serialize(self, _security_handler=None):
builder = self.output_builder
startxref = str(len(builder.buffer))
out = []
out.append("xref")
out.append(f"0 {self.count}")
out.append("0000000000 65535 f ")
for obj_id in range(1, self.count):
out.append(f"{builder.offsets[obj_id]:010} 00000 n ")
out.append("trailer")
out.append("<<")
out.append(f"/Size {self.count}")
out.append(f"/Root {pdf_ref(self.catalog_obj.id)}")
out.append(f"/Info {pdf_ref(self.info_obj.id)}")
fpdf = builder.fpdf
if self.encryption_obj:
out.append(f"/Encrypt {pdf_ref(self.encryption_obj.id)}")
file_id = fpdf._security_handler.file_id
else:
file_id = fpdf.file_id()
if file_id == -1:
file_id = fpdf._default_file_id(builder.buffer)
if file_id:
out.append(f"/ID [{file_id}]")
out.append(">>")
out.append("startxref")
out.append(startxref)
out.append("%%EOF")
return "\n".join(out)
class OutputProducer:
"Generates the final bytearray representing the PDF document, based on a FPDF instance."
def __init__(self, fpdf):
self.fpdf = fpdf
self.pdf_objs = []
self.iccp_i_to_pdf_i = {}
self.obj_id = 0 # current PDF object number
# array of PDF object offsets in self.buffer, used to build the xref table:
self.offsets = {}
self.trace_labels_per_obj_id = {}
self.sections_size_per_trace_label = defaultdict(int)
self.buffer = bytearray() # resulting output buffer
def bufferize(self):
"""
This method alters the target FPDF instance
by assigning IDs to all PDF objects,
plus a few other properties on PDFPage instances
"""
fpdf = self.fpdf
# 1. Setup - Insert all PDF objects
# and assign unique consecutive numeric IDs to all of them
if fpdf._security_handler:
# get the file_id and generate passwords needed to encrypt streams and strings
file_id = fpdf.file_id()
if file_id == -1:
# no custom file id - use default file id so enryption passwords can be generated
file_id = fpdf._default_file_id(bytearray(0x00))
fpdf._security_handler.generate_passwords(file_id)
self.pdf_objs.append(PDFHeader(fpdf.pdf_version))
pages_root_obj = self._add_pages_root()
catalog_obj = self._add_catalog()
page_objs = self._add_pages()
sig_annotation_obj = self._add_annotations_as_objects()
for embedded_file in fpdf.embedded_files:
self._add_pdf_obj(embedded_file, "embedded_files")
font_objs_per_index = self._add_fonts()
img_objs_per_index = self._add_images()
gfxstate_objs_per_name = self._add_gfxstates()
resources_dict_obj = self._add_resources_dict(
font_objs_per_index, img_objs_per_index, gfxstate_objs_per_name
)
struct_tree_root_obj = self._add_structure_tree()
outline_dict_obj, outline_items = self._add_document_outline()
xmp_metadata_obj = self._add_xmp_metadata()
info_obj = self._add_info()
encryption_obj = self._add_encryption()
xref = PDFXrefAndTrailer(self)
self.pdf_objs.append(xref)
# 2. Plumbing - Inject all PDF object references required:
pages_root_obj.kids = PDFArray(page_objs)
self._finalize_catalog(
catalog_obj,
pages_root_obj=pages_root_obj,
first_page_obj=page_objs[0],
sig_annotation_obj=sig_annotation_obj,
xmp_metadata_obj=xmp_metadata_obj,
struct_tree_root_obj=struct_tree_root_obj,
outline_dict_obj=outline_dict_obj,
)
dests = []
for page_obj in page_objs:
page_obj.parent = pages_root_obj
page_obj.resources = resources_dict_obj
for annot in page_obj.annots:
page_dests = []
if annot.dest:
page_dests.append(annot.dest)
if annot.a and hasattr(annot.a, "dest"):
page_dests.append(annot.a.dest)
for dest in page_dests:
if dest.page_number > len(page_objs):
raise ValueError(
f"Invalid reference to non-existing page {dest.page_number} present on page {page_obj.index()}: "
)
dests.extend(page_dests)
if not page_obj.annots:
# Avoid serializing an empty PDFArray:
page_obj.annots = None
for outline_item in outline_items:
dests.append(outline_item.dest)
# Assigning the .page_ref property of all Destination objects:
for dest in dests:
dest.page_ref = pdf_ref(page_objs[dest.page_number - 1].id)
for struct_elem in fpdf.struct_builder.doc_struct_elem.k:
struct_elem.pg = page_objs[struct_elem.page_number() - 1]
xref.catalog_obj = catalog_obj
xref.info_obj = info_obj
xref.encryption_obj = encryption_obj
# 3. Serializing - Append all PDF objects to the buffer:
assert (
not self.buffer
), f"Nothing should have been appended to the .buffer at this stage: {self.buffer}"
assert (
not self.offsets
), f"No offset should have been set at this stage: {len(self.offsets)}"
for pdf_obj in self.pdf_objs:
if isinstance(pdf_obj, ContentWithoutID):
# top header, xref table & trailer:
trace_label = None
else:
self.offsets[pdf_obj.id] = len(self.buffer)
trace_label = self.trace_labels_per_obj_id.get(pdf_obj.id)
if trace_label:
with self._trace_size(trace_label):
self._out(
pdf_obj.serialize(_security_handler=fpdf._security_handler)
)
else:
self._out(pdf_obj.serialize(_security_handler=fpdf._security_handler))
self._log_final_sections_sizes()
if fpdf._sign_key:
self.buffer = sign_content(
signer,
self.buffer,
fpdf._sign_key,
fpdf._sign_cert,
fpdf._sign_extra_certs,
fpdf._sign_hashalgo,
fpdf._sign_time,
)
return self.buffer
def _out(self, data):
"Append data to the buffer"
if not isinstance(data, bytes):
if not isinstance(data, str):
data = str(data)
data = data.encode("latin1")
self.buffer += data + b"\n"
def _add_pdf_obj(self, pdf_obj, trace_label=None):
self.obj_id += 1
pdf_obj.id = self.obj_id
self.pdf_objs.append(pdf_obj)
if trace_label:
self.trace_labels_per_obj_id[self.obj_id] = trace_label
return self.obj_id
def _add_pages_root(self):
fpdf = self.fpdf
pages_root_obj = PDFPagesRoot(
count=fpdf.pages_count,
media_box=_dimensions_to_mediabox(fpdf.default_page_dimensions),
)
self._add_pdf_obj(pages_root_obj)
return pages_root_obj
def _add_pages(self, _slice=slice(0, None)):
fpdf = self.fpdf
page_objs = []
for page_obj in list(fpdf.pages.values())[_slice]:
if fpdf.pdf_version > "1.3":
page_obj.group = pdf_dict(
{"/Type": "/Group", "/S": "/Transparency", "/CS": "/DeviceRGB"},
field_join=" ",
)
if page_obj.dimensions() != fpdf.default_page_dimensions:
page_obj.media_box = _dimensions_to_mediabox(page_obj.dimensions())
self._add_pdf_obj(page_obj, "pages")
page_objs.append(page_obj)
# Extracting the page contents to insert it as a content stream:
cs_obj = PDFContentStream(
contents=page_obj.contents, compress=fpdf.compress
)
self._add_pdf_obj(cs_obj, "pages")
page_obj.contents = cs_obj
return page_objs
def _add_annotations_as_objects(self):
sig_annotation_obj = None
for page_obj in self.fpdf.pages.values():
for annot_obj in page_obj.annots:
if isinstance(annot_obj, PDFAnnotation): # distinct from AnnotationDict
self._add_pdf_obj(annot_obj)
if isinstance(annot_obj.v, Signature):
assert (
sig_annotation_obj is None
), "A /Sig annotation is present on more than 1 page"
sig_annotation_obj = annot_obj
return sig_annotation_obj
def _add_fonts(self):
font_objs_per_index = {}
for font in sorted(self.fpdf.fonts.values(), key=lambda font: font.i):
# Standard font
if font.type == "core":
encoding = (
"WinAnsiEncoding"
if font.name not in ("Symbol", "ZapfDingbats")
else None
)
core_font_obj = PDFFont(
subtype="Type1", base_font=font.name, encoding=encoding
)
self._add_pdf_obj(core_font_obj, "fonts")
font_objs_per_index[font.i] = core_font_obj
elif font.type == "TTF":
fontname = f"MPDFAA+{font.name}"
# 1. get all glyphs in PDF
glyph_names = font.subset.get_all_glyph_names()
if len(font.missing_glyphs) > 0:
LOGGER.warning(
"Font %s is missing the following glyphs: %s",
fontname,
", ".join(chr(x) for x in font.missing_glyphs),
)
# 2. make a subset
# notdef_outline=True means that keeps the white box for the .notdef glyph
# recommended_glyphs=True means that adds the .notdef, .null, CR, and space glyphs
options = ftsubset.Options(notdef_outline=True, recommended_glyphs=True)
# dropping some tables that currently not used:
options.drop_tables += [
"FFTM", # FontForge Timestamp table - cf. https://github.com/py-pdf/fpdf2/issues/600
"GDEF", # Glyph Definition table = various glyph properties used in OpenType layout processing
"GPOS", # Glyph Positioning table = precise control over glyph placement
# for sophisticated text layout and rendering in each script and language system
"GSUB", # Glyph Substitution table = data for substition of glyphs for appropriate rendering of scripts
"MATH", # Mathematical typesetting table = specific information necessary for math formula layout
"hdmx", # Horizontal Device Metrics table, stores integer advance widths scaled to particular pixel sizes
# for OpenType™ fonts with TrueType outlines
"meta", # metadata table
]
subsetter = ftsubset.Subsetter(options)
subsetter.populate(glyphs=glyph_names)
subsetter.subset(font.ttfont)
# 3. make codeToGlyph
# is a map Character_ID -> Glyph_ID
# it's used for associating glyphs to new codes
# this basically takes the old code of the character
# take the glyph associated with it
# and then associate to the new code the glyph associated with the old code
code_to_glyph = {
char_id: font.ttfont.getGlyphID(glyph.glyph_name)
for glyph, char_id in font.subset.items()
}
# 4. return the ttfile
output = BytesIO()
font.ttfont.save(output)
output.seek(0)
ttfontstream = output.read()
# A composite font - a font composed of other fonts,
# organized hierarchically
composite_font_obj = PDFFont(
subtype="Type0", base_font=fontname, encoding="Identity-H"
)
self._add_pdf_obj(composite_font_obj, "fonts")
font_objs_per_index[font.i] = composite_font_obj
# A CIDFont whose glyph descriptions are based on
# TrueType font technology
cid_font_obj = PDFFont(
subtype="CIDFontType2",
base_font=fontname,
d_w=font.desc.missing_width,
w=_tt_font_widths(font),
)
self._add_pdf_obj(cid_font_obj, "fonts")
composite_font_obj.descendant_fonts = PDFArray([cid_font_obj])
# bfChar
# This table informs the PDF reader about the unicode
# character that each used 16-bit code belongs to. It
# allows searching the file and copying text from it.
bfChar = []
def format_code(unicode):
if unicode > 0xFFFF:
# Calculate surrogate pair
code_high = 0xD800 | (unicode - 0x10000) >> 10
code_low = 0xDC00 | (unicode & 0x3FF)
return f"{code_high:04X}{code_low:04X}"
return f"{unicode:04X}"
for glyph, code_mapped in font.subset.items():
if len(glyph.unicode) == 0:
continue
bfChar.append(
f'<{code_mapped:04X}> <{"".join(format_code(code) for code in glyph.unicode)}>\n'
)
to_unicode_obj = PDFContentStream(
"/CIDInit /ProcSet findresource begin\n"
"12 dict begin\n"
"begincmap\n"
"/CIDSystemInfo\n"
"<</Registry (Adobe)\n"
"/Ordering (UCS)\n"
"/Supplement 0\n"
">> def\n"
"/CMapName /Adobe-Identity-UCS def\n"
"/CMapType 2 def\n"
"1 begincodespacerange\n"
"<0000> <FFFF>\n"
"endcodespacerange\n"
f"{len(bfChar)} beginbfchar\n"
f"{''.join(bfChar)}"
"endbfchar\n"
"endcmap\n"
"CMapName currentdict /CMap defineresource pop\n"
"end\n"
"end"
)
self._add_pdf_obj(to_unicode_obj, "fonts")
composite_font_obj.to_unicode = to_unicode_obj
cid_system_info_obj = CIDSystemInfo()
self._add_pdf_obj(cid_system_info_obj, "fonts")
cid_font_obj.c_i_d_system_info = cid_system_info_obj
font_descriptor_obj = font.desc
font_descriptor_obj.font_name = Name(fontname)
self._add_pdf_obj(font_descriptor_obj, "fonts")
cid_font_obj.font_descriptor = font_descriptor_obj
# Embed CIDToGIDMap
# A specification of the mapping from CIDs to glyph indices
cid_to_gid_map = ["\x00"] * 256 * 256 * 2
for cc, glyph in code_to_glyph.items():
cid_to_gid_map[cc * 2] = chr(glyph >> 8)
cid_to_gid_map[cc * 2 + 1] = chr(glyph & 0xFF)
cid_to_gid_map = "".join(cid_to_gid_map)
# manage binary data as latin1 until PEP461-like function is implemented
cid_to_gid_map_obj = PDFContentStream(
contents=cid_to_gid_map.encode("latin1"), compress=True
)
self._add_pdf_obj(cid_to_gid_map_obj, "fonts")
cid_font_obj.c_i_d_to_g_i_d_map = cid_to_gid_map_obj
font_file_cs_obj = PDFFontStream(contents=ttfontstream)
self._add_pdf_obj(font_file_cs_obj, "fonts")
font_descriptor_obj.font_file2 = font_file_cs_obj
font.close()
return font_objs_per_index
def _add_images(self):
img_objs_per_index = {}
for img in sorted(
self.fpdf.image_cache.images.values(), key=lambda img: img["i"]
):
if img["usages"] > 0:
img_objs_per_index[img["i"]] = self._add_image(img)
return img_objs_per_index
def _ensure_iccp(self, img_info):
"""
Returns the PDF object of the ICC profile indexed iccp_i in the FPDF object.
Adds it if not present.
"""
iccp_i = img_info["iccp_i"]
if iccp_i in self.iccp_i_to_pdf_i:
return self.iccp_i_to_pdf_i[iccp_i]
iccp_content = None
for iccp_c, i in self.fpdf.image_cache.icc_profiles.items():
if iccp_i == i:
iccp_content = iccp_c
break
assert iccp_content is not None
# Note: n should be 4 if the profile ColorSpace is CMYK
iccp_obj = PDFICCPObject(
contents=iccp_content, n=img_info["dpn"], alternate=img_info["cs"]
)
iccp_pdf_i = self._add_pdf_obj(iccp_obj, "iccp")
self.iccp_i_to_pdf_i[iccp_i] = iccp_pdf_i
return iccp_pdf_i
def _add_image(self, info):
color_space = Name(info["cs"])
decode = None
iccp_i = info.get("iccp_i")
if color_space == "Indexed":
color_space = PDFArray(
["/Indexed", "/DeviceRGB", f"{len(info['pal']) // 3 - 1}"]
)
elif iccp_i is not None:
iccp_pdf_i = self._ensure_iccp(info)
color_space = PDFArray(["/ICCBased", str(iccp_pdf_i), str("0"), "R"])
elif color_space == "DeviceCMYK":
if info["inverted"] is True:
decode = "[1 0 1 0 1 0 1 0]"
decode_parms = f"<<{info['dp']} /BitsPerComponent {info['bpc']}>>"
img_obj = PDFXObject(
subtype="Image",
contents=info["data"],
width=info["w"],
height=info["h"],
color_space=color_space,
bits_per_component=info["bpc"],
img_filter=info["f"],
decode=decode,
decode_parms=decode_parms,
)
self._add_pdf_obj(img_obj, "images")
# Soft mask
if self.fpdf.allow_images_transparency and "smask" in info:
dp = f"/Predictor 15 /Colors 1 /Columns {info['w']}"
img_obj.s_mask = self._add_image(
{
"w": info["w"],
"h": info["h"],
"cs": "DeviceGray",
"bpc": 8,
"f": info["f"],
"dp": dp,
"data": info["smask"],
}
)
# Palette
if "/Indexed" in color_space:
pal_cs_obj = PDFContentStream(
contents=info["pal"], compress=self.fpdf.compress
)
self._add_pdf_obj(pal_cs_obj, "images")
img_obj.color_space.append(pdf_ref(pal_cs_obj.id))
return img_obj
def _add_gfxstates(self):
gfxstate_objs_per_name = OrderedDict()
for state_dict, name in self.fpdf._drawing_graphics_state_registry.items():
gfxstate_obj = PDFExtGState(state_dict)
self._add_pdf_obj(gfxstate_obj, "gfxstate")
gfxstate_objs_per_name[name] = gfxstate_obj
return gfxstate_objs_per_name
def _add_resources_dict(
self, font_objs_per_index, img_objs_per_index, gfxstate_objs_per_name
):
# From section 10.1, "Procedure Sets", of PDF 1.7 spec:
# > Beginning with PDF 1.4, this feature is considered obsolete.
# > For compatibility with existing consumer applications,
# > PDF producer applications should continue to specify procedure sets
# > (preferably, all of those listed in Table 10.1).
proc_set = "[/PDF /Text /ImageB /ImageC /ImageI]"
font, x_object, ext_g_state = None, None, None
if font_objs_per_index:
font = pdf_dict(
{
f"/F{index}": pdf_ref(font_obj.id)
for index, font_obj in sorted(font_objs_per_index.items())
}
)
if img_objs_per_index:
x_object = pdf_dict(
{
f"/I{index}": pdf_ref(img_obj.id)
for index, img_obj in sorted(img_objs_per_index.items())
}
)
if gfxstate_objs_per_name:
ext_g_state = pdf_dict(
{
f"/{name}": pdf_ref(gfxstate_obj.id)
for name, gfxstate_obj in gfxstate_objs_per_name.items()
}
)
resources_obj = PDFResources(
proc_set=proc_set, font=font, x_object=x_object, ext_g_state=ext_g_state
)
self._add_pdf_obj(resources_obj)
return resources_obj
def _add_structure_tree(self):
"Builds a Structure Hierarchy, including image alternate descriptions"
if self.fpdf.struct_builder.empty():
return None
struct_tree_root_obj = None
for pdf_obj in self.fpdf.struct_builder:
if struct_tree_root_obj is None:
struct_tree_root_obj = pdf_obj
self._add_pdf_obj(pdf_obj, "structure_tree")
return struct_tree_root_obj
def _add_document_outline(self):
if not self.fpdf._outline:
return None, ()
outline_dict_obj, outline_items = None, []
for pdf_obj in build_outline_objs(self.fpdf._outline):
if outline_dict_obj is None:
outline_dict_obj = pdf_obj
else:
outline_items.append(pdf_obj)
self._add_pdf_obj(pdf_obj, "document_outline")
return outline_dict_obj, outline_items
def _add_xmp_metadata(self):
if not self.fpdf.xmp_metadata:
return None
xpacket = f'<?xpacket begin="" id="W5M0MpCehiHzreSzNTczkc9d"?>\n{self.fpdf.xmp_metadata}\n<?xpacket end="w"?>\n'
pdf_obj = PDFXmpMetadata(xpacket)
self._add_pdf_obj(pdf_obj)
return pdf_obj
def _add_info(self):
fpdf = self.fpdf
creation_date = None
if fpdf.creation_date:
try:
creation_date = PDFDate(fpdf.creation_date, with_tz=True, encrypt=True)
except Exception as error:
raise FPDFException(
f"Could not format date: {fpdf.creation_date}"
) from error
info_obj = PDFInfo(
title=getattr(fpdf, "title", None),
subject=getattr(fpdf, "subject", None),
author=getattr(fpdf, "author", None),
keywords=getattr(fpdf, "keywords", None),
creator=getattr(fpdf, "creator", None),
producer=getattr(fpdf, "producer", None),
creation_date=creation_date,
)
self._add_pdf_obj(info_obj)
return info_obj
def _add_encryption(self):
if self.fpdf._security_handler:
encryption_handler = self.fpdf._security_handler
pdf_obj = encryption_handler.get_encryption_obj()
self._add_pdf_obj(pdf_obj)
return pdf_obj
return None
def _add_catalog(self):
fpdf = self.fpdf
catalog_obj = PDFCatalog(
lang=getattr(fpdf, "lang", None),
page_layout=fpdf.page_layout,
page_mode=fpdf.page_mode,
viewer_preferences=fpdf.viewer_preferences,
)
self._add_pdf_obj(catalog_obj)
return catalog_obj
def _finalize_catalog(
self,
catalog_obj,
pages_root_obj,
first_page_obj,
sig_annotation_obj,
xmp_metadata_obj,
struct_tree_root_obj,
outline_dict_obj,
):
fpdf = self.fpdf
catalog_obj.pages = pages_root_obj
catalog_obj.struct_tree_root = struct_tree_root_obj
catalog_obj.outlines = outline_dict_obj
catalog_obj.metadata = xmp_metadata_obj
if sig_annotation_obj:
flags = SignatureFlag.SIGNATURES_EXIST + SignatureFlag.APPEND_ONLY
catalog_obj.acro_form = AcroForm(
fields=PDFArray([sig_annotation_obj]), sig_flags=flags
)
if fpdf.zoom_mode in ZOOM_CONFIGS:
zoom_config = [
pdf_ref(first_page_obj.id),
*ZOOM_CONFIGS[fpdf.zoom_mode],
]
else: # zoom_mode is a number, not one of the allowed strings:
zoom_config = [
pdf_ref(first_page_obj.id),
"/XYZ",
"null",
"null",
str(fpdf.zoom_mode / 100),
]
catalog_obj.open_action = pdf_list(zoom_config)
if struct_tree_root_obj:
catalog_obj.mark_info = pdf_dict({"/Marked": "true"})
if fpdf.embedded_files:
file_spec_names = [
f"{PDFString(embedded_file.basename()).serialize()} {embedded_file.file_spec().serialize()}"
for embedded_file in fpdf.embedded_files
if embedded_file.globally_enclosed
]
catalog_obj.names = pdf_dict(
{"/EmbeddedFiles": pdf_dict({"/Names": pdf_list(file_spec_names)})}
)
@contextmanager
def _trace_size(self, label):
prev_size = len(self.buffer)
yield
self.sections_size_per_trace_label[label] += len(self.buffer) - prev_size
def _log_final_sections_sizes(self):
LOGGER.debug("Final size summary of the biggest document sections:")
for label, section_size in self.sections_size_per_trace_label.items():
LOGGER.debug("- %s: %s", label, _sizeof_fmt(section_size))
def stream_content_for_raster_image(
info: RasterImageInfo,
x,
y,
w,
h,
keep_aspect_ratio=False,
scale=1,
pdf_height_to_flip=None,
):
if keep_aspect_ratio:
x, y, w, h = info.scale_inside_box(x, y, w, h)
if pdf_height_to_flip:
stream_h = h
stream_y = pdf_height_to_flip - h - y
else:
stream_h = -h
stream_y = y + h
return (
f"q {w * scale:.2f} 0 0 {stream_h * scale:.2f}"
f" {x * scale:.2f} {stream_y * scale:.2f} cm"
f" /I{info['i']} Do Q"
)
def _tt_font_widths(font):
rangeid = 0
range_ = {}
range_interval = {}
prevcid = -2
prevwidth = -1
interval = False
# Glyphs sorted by mapped character id
glyphs = dict(sorted(font.subset.items(), key=lambda item: item[1]))
for glyph in glyphs:
cid_mapped = glyphs[glyph]
if cid_mapped == (prevcid + 1):
if glyph.glyph_width == prevwidth:
if glyph.glyph_width == range_[rangeid][0]:
range_.setdefault(rangeid, []).append(glyph.glyph_width)
else:
range_[rangeid].pop()
# new range
rangeid = prevcid
range_[rangeid] = [prevwidth, glyph.glyph_width]
interval = True
range_interval[rangeid] = True
else:
if interval:
# new range
rangeid = cid_mapped
range_[rangeid] = [glyph.glyph_width]
else:
range_[rangeid].append(glyph.glyph_width)
interval = False
else:
rangeid = cid_mapped
range_[rangeid] = [glyph.glyph_width]
interval = False
prevcid = cid_mapped
prevwidth = glyph.glyph_width
prevk = -1
nextk = -1
prevint = False
ri = range_interval
for k, ws in sorted(range_.items()):
cws = len(ws)
if k == nextk and not prevint and (k not in ri or cws < 3):
if k in ri:
del ri[k]
range_[prevk] = range_[prevk] + range_[k]
del range_[k]
else:
prevk = k
nextk = k + cws
if k in ri:
prevint = cws > 3
del ri[k]
nextk -= 1
else:
prevint = False
w = []
for k, ws in sorted(range_.items()):
if len(set(ws)) == 1:
w.append(f" {k} {k + len(ws) - 1} {ws[0]}")
else:
w.append(f" {k} [ {' '.join(str(int(h)) for h in ws)} ]\n")
return f"[{''.join(w)}]"
def _dimensions_to_mediabox(dimensions):
width_pt, height_pt = dimensions
return f"[0 0 {width_pt:.2f} {height_pt:.2f}]"
def _sizeof_fmt(num, suffix="B"):
# Recipe from: https://stackoverflow.com/a/1094933/636849
for unit in ["", "Ki", "Mi", "Gi", "Ti", "Pi", "Ei", "Zi"]:
if abs(num) < 1024:
return f"{num:3.1f}{unit}{suffix}"
num /= 1024
return f"{num:.1f}Yi{suffix}"Functions
def stream_content_for_raster_image(info: RasterImageInfo, x, y, w, h, keep_aspect_ratio=False, scale=1, pdf_height_to_flip=None)-
Expand source code Browse git
def stream_content_for_raster_image( info: RasterImageInfo, x, y, w, h, keep_aspect_ratio=False, scale=1, pdf_height_to_flip=None, ): if keep_aspect_ratio: x, y, w, h = info.scale_inside_box(x, y, w, h) if pdf_height_to_flip: stream_h = h stream_y = pdf_height_to_flip - h - y else: stream_h = -h stream_y = y + h return ( f"q {w * scale:.2f} 0 0 {stream_h * scale:.2f}" f" {x * scale:.2f} {stream_y * scale:.2f} cm" f" /I{info['i']} Do Q" )
Classes
class AcroForm (fields, sig_flags)-
Expand source code Browse git
class AcroForm: def __init__(self, fields, sig_flags): self.fields = fields self.sig_flags = sig_flags def serialize(self, _security_handler=None, _obj_id=None): obj_dict = build_obj_dict( {key: getattr(self, key) for key in dir(self)}, _security_handler=_security_handler, _obj_id=_obj_id, ) return pdf_dict(obj_dict, field_join=" ")Methods
def serialize(self)-
Expand source code Browse git
def serialize(self, _security_handler=None, _obj_id=None): obj_dict = build_obj_dict( {key: getattr(self, key) for key in dir(self)}, _security_handler=_security_handler, _obj_id=_obj_id, ) return pdf_dict(obj_dict, field_join=" ")
class CIDSystemInfo-
Main features of this class: * delay ID assignement * implement serializing
Expand source code Browse git
class CIDSystemInfo(PDFObject): def __init__(self): super().__init__() self.registry = PDFString("Adobe", encrypt=True) self.ordering = PDFString("UCS", encrypt=True) self.supplement = 0Ancestors
Inherited members
class ContentWithoutID-
Expand source code Browse git
class ContentWithoutID: def serialize(self, _security_handler=None): passSubclasses
Methods
def serialize(self)-
Expand source code Browse git
def serialize(self, _security_handler=None): pass
class OutputProducer (fpdf)-
Generates the final bytearray representing the PDF document, based on a FPDF instance.
Expand source code Browse git
class OutputProducer: "Generates the final bytearray representing the PDF document, based on a FPDF instance." def __init__(self, fpdf): self.fpdf = fpdf self.pdf_objs = [] self.iccp_i_to_pdf_i = {} self.obj_id = 0 # current PDF object number # array of PDF object offsets in self.buffer, used to build the xref table: self.offsets = {} self.trace_labels_per_obj_id = {} self.sections_size_per_trace_label = defaultdict(int) self.buffer = bytearray() # resulting output buffer def bufferize(self): """ This method alters the target FPDF instance by assigning IDs to all PDF objects, plus a few other properties on PDFPage instances """ fpdf = self.fpdf # 1. Setup - Insert all PDF objects # and assign unique consecutive numeric IDs to all of them if fpdf._security_handler: # get the file_id and generate passwords needed to encrypt streams and strings file_id = fpdf.file_id() if file_id == -1: # no custom file id - use default file id so enryption passwords can be generated file_id = fpdf._default_file_id(bytearray(0x00)) fpdf._security_handler.generate_passwords(file_id) self.pdf_objs.append(PDFHeader(fpdf.pdf_version)) pages_root_obj = self._add_pages_root() catalog_obj = self._add_catalog() page_objs = self._add_pages() sig_annotation_obj = self._add_annotations_as_objects() for embedded_file in fpdf.embedded_files: self._add_pdf_obj(embedded_file, "embedded_files") font_objs_per_index = self._add_fonts() img_objs_per_index = self._add_images() gfxstate_objs_per_name = self._add_gfxstates() resources_dict_obj = self._add_resources_dict( font_objs_per_index, img_objs_per_index, gfxstate_objs_per_name ) struct_tree_root_obj = self._add_structure_tree() outline_dict_obj, outline_items = self._add_document_outline() xmp_metadata_obj = self._add_xmp_metadata() info_obj = self._add_info() encryption_obj = self._add_encryption() xref = PDFXrefAndTrailer(self) self.pdf_objs.append(xref) # 2. Plumbing - Inject all PDF object references required: pages_root_obj.kids = PDFArray(page_objs) self._finalize_catalog( catalog_obj, pages_root_obj=pages_root_obj, first_page_obj=page_objs[0], sig_annotation_obj=sig_annotation_obj, xmp_metadata_obj=xmp_metadata_obj, struct_tree_root_obj=struct_tree_root_obj, outline_dict_obj=outline_dict_obj, ) dests = [] for page_obj in page_objs: page_obj.parent = pages_root_obj page_obj.resources = resources_dict_obj for annot in page_obj.annots: page_dests = [] if annot.dest: page_dests.append(annot.dest) if annot.a and hasattr(annot.a, "dest"): page_dests.append(annot.a.dest) for dest in page_dests: if dest.page_number > len(page_objs): raise ValueError( f"Invalid reference to non-existing page {dest.page_number} present on page {page_obj.index()}: " ) dests.extend(page_dests) if not page_obj.annots: # Avoid serializing an empty PDFArray: page_obj.annots = None for outline_item in outline_items: dests.append(outline_item.dest) # Assigning the .page_ref property of all Destination objects: for dest in dests: dest.page_ref = pdf_ref(page_objs[dest.page_number - 1].id) for struct_elem in fpdf.struct_builder.doc_struct_elem.k: struct_elem.pg = page_objs[struct_elem.page_number() - 1] xref.catalog_obj = catalog_obj xref.info_obj = info_obj xref.encryption_obj = encryption_obj # 3. Serializing - Append all PDF objects to the buffer: assert ( not self.buffer ), f"Nothing should have been appended to the .buffer at this stage: {self.buffer}" assert ( not self.offsets ), f"No offset should have been set at this stage: {len(self.offsets)}" for pdf_obj in self.pdf_objs: if isinstance(pdf_obj, ContentWithoutID): # top header, xref table & trailer: trace_label = None else: self.offsets[pdf_obj.id] = len(self.buffer) trace_label = self.trace_labels_per_obj_id.get(pdf_obj.id) if trace_label: with self._trace_size(trace_label): self._out( pdf_obj.serialize(_security_handler=fpdf._security_handler) ) else: self._out(pdf_obj.serialize(_security_handler=fpdf._security_handler)) self._log_final_sections_sizes() if fpdf._sign_key: self.buffer = sign_content( signer, self.buffer, fpdf._sign_key, fpdf._sign_cert, fpdf._sign_extra_certs, fpdf._sign_hashalgo, fpdf._sign_time, ) return self.buffer def _out(self, data): "Append data to the buffer" if not isinstance(data, bytes): if not isinstance(data, str): data = str(data) data = data.encode("latin1") self.buffer += data + b"\n" def _add_pdf_obj(self, pdf_obj, trace_label=None): self.obj_id += 1 pdf_obj.id = self.obj_id self.pdf_objs.append(pdf_obj) if trace_label: self.trace_labels_per_obj_id[self.obj_id] = trace_label return self.obj_id def _add_pages_root(self): fpdf = self.fpdf pages_root_obj = PDFPagesRoot( count=fpdf.pages_count, media_box=_dimensions_to_mediabox(fpdf.default_page_dimensions), ) self._add_pdf_obj(pages_root_obj) return pages_root_obj def _add_pages(self, _slice=slice(0, None)): fpdf = self.fpdf page_objs = [] for page_obj in list(fpdf.pages.values())[_slice]: if fpdf.pdf_version > "1.3": page_obj.group = pdf_dict( {"/Type": "/Group", "/S": "/Transparency", "/CS": "/DeviceRGB"}, field_join=" ", ) if page_obj.dimensions() != fpdf.default_page_dimensions: page_obj.media_box = _dimensions_to_mediabox(page_obj.dimensions()) self._add_pdf_obj(page_obj, "pages") page_objs.append(page_obj) # Extracting the page contents to insert it as a content stream: cs_obj = PDFContentStream( contents=page_obj.contents, compress=fpdf.compress ) self._add_pdf_obj(cs_obj, "pages") page_obj.contents = cs_obj return page_objs def _add_annotations_as_objects(self): sig_annotation_obj = None for page_obj in self.fpdf.pages.values(): for annot_obj in page_obj.annots: if isinstance(annot_obj, PDFAnnotation): # distinct from AnnotationDict self._add_pdf_obj(annot_obj) if isinstance(annot_obj.v, Signature): assert ( sig_annotation_obj is None ), "A /Sig annotation is present on more than 1 page" sig_annotation_obj = annot_obj return sig_annotation_obj def _add_fonts(self): font_objs_per_index = {} for font in sorted(self.fpdf.fonts.values(), key=lambda font: font.i): # Standard font if font.type == "core": encoding = ( "WinAnsiEncoding" if font.name not in ("Symbol", "ZapfDingbats") else None ) core_font_obj = PDFFont( subtype="Type1", base_font=font.name, encoding=encoding ) self._add_pdf_obj(core_font_obj, "fonts") font_objs_per_index[font.i] = core_font_obj elif font.type == "TTF": fontname = f"MPDFAA+{font.name}" # 1. get all glyphs in PDF glyph_names = font.subset.get_all_glyph_names() if len(font.missing_glyphs) > 0: LOGGER.warning( "Font %s is missing the following glyphs: %s", fontname, ", ".join(chr(x) for x in font.missing_glyphs), ) # 2. make a subset # notdef_outline=True means that keeps the white box for the .notdef glyph # recommended_glyphs=True means that adds the .notdef, .null, CR, and space glyphs options = ftsubset.Options(notdef_outline=True, recommended_glyphs=True) # dropping some tables that currently not used: options.drop_tables += [ "FFTM", # FontForge Timestamp table - cf. https://github.com/py-pdf/fpdf2/issues/600 "GDEF", # Glyph Definition table = various glyph properties used in OpenType layout processing "GPOS", # Glyph Positioning table = precise control over glyph placement # for sophisticated text layout and rendering in each script and language system "GSUB", # Glyph Substitution table = data for substition of glyphs for appropriate rendering of scripts "MATH", # Mathematical typesetting table = specific information necessary for math formula layout "hdmx", # Horizontal Device Metrics table, stores integer advance widths scaled to particular pixel sizes # for OpenType™ fonts with TrueType outlines "meta", # metadata table ] subsetter = ftsubset.Subsetter(options) subsetter.populate(glyphs=glyph_names) subsetter.subset(font.ttfont) # 3. make codeToGlyph # is a map Character_ID -> Glyph_ID # it's used for associating glyphs to new codes # this basically takes the old code of the character # take the glyph associated with it # and then associate to the new code the glyph associated with the old code code_to_glyph = { char_id: font.ttfont.getGlyphID(glyph.glyph_name) for glyph, char_id in font.subset.items() } # 4. return the ttfile output = BytesIO() font.ttfont.save(output) output.seek(0) ttfontstream = output.read() # A composite font - a font composed of other fonts, # organized hierarchically composite_font_obj = PDFFont( subtype="Type0", base_font=fontname, encoding="Identity-H" ) self._add_pdf_obj(composite_font_obj, "fonts") font_objs_per_index[font.i] = composite_font_obj # A CIDFont whose glyph descriptions are based on # TrueType font technology cid_font_obj = PDFFont( subtype="CIDFontType2", base_font=fontname, d_w=font.desc.missing_width, w=_tt_font_widths(font), ) self._add_pdf_obj(cid_font_obj, "fonts") composite_font_obj.descendant_fonts = PDFArray([cid_font_obj]) # bfChar # This table informs the PDF reader about the unicode # character that each used 16-bit code belongs to. It # allows searching the file and copying text from it. bfChar = [] def format_code(unicode): if unicode > 0xFFFF: # Calculate surrogate pair code_high = 0xD800 | (unicode - 0x10000) >> 10 code_low = 0xDC00 | (unicode & 0x3FF) return f"{code_high:04X}{code_low:04X}" return f"{unicode:04X}" for glyph, code_mapped in font.subset.items(): if len(glyph.unicode) == 0: continue bfChar.append( f'<{code_mapped:04X}> <{"".join(format_code(code) for code in glyph.unicode)}>\n' ) to_unicode_obj = PDFContentStream( "/CIDInit /ProcSet findresource begin\n" "12 dict begin\n" "begincmap\n" "/CIDSystemInfo\n" "<</Registry (Adobe)\n" "/Ordering (UCS)\n" "/Supplement 0\n" ">> def\n" "/CMapName /Adobe-Identity-UCS def\n" "/CMapType 2 def\n" "1 begincodespacerange\n" "<0000> <FFFF>\n" "endcodespacerange\n" f"{len(bfChar)} beginbfchar\n" f"{''.join(bfChar)}" "endbfchar\n" "endcmap\n" "CMapName currentdict /CMap defineresource pop\n" "end\n" "end" ) self._add_pdf_obj(to_unicode_obj, "fonts") composite_font_obj.to_unicode = to_unicode_obj cid_system_info_obj = CIDSystemInfo() self._add_pdf_obj(cid_system_info_obj, "fonts") cid_font_obj.c_i_d_system_info = cid_system_info_obj font_descriptor_obj = font.desc font_descriptor_obj.font_name = Name(fontname) self._add_pdf_obj(font_descriptor_obj, "fonts") cid_font_obj.font_descriptor = font_descriptor_obj # Embed CIDToGIDMap # A specification of the mapping from CIDs to glyph indices cid_to_gid_map = ["\x00"] * 256 * 256 * 2 for cc, glyph in code_to_glyph.items(): cid_to_gid_map[cc * 2] = chr(glyph >> 8) cid_to_gid_map[cc * 2 + 1] = chr(glyph & 0xFF) cid_to_gid_map = "".join(cid_to_gid_map) # manage binary data as latin1 until PEP461-like function is implemented cid_to_gid_map_obj = PDFContentStream( contents=cid_to_gid_map.encode("latin1"), compress=True ) self._add_pdf_obj(cid_to_gid_map_obj, "fonts") cid_font_obj.c_i_d_to_g_i_d_map = cid_to_gid_map_obj font_file_cs_obj = PDFFontStream(contents=ttfontstream) self._add_pdf_obj(font_file_cs_obj, "fonts") font_descriptor_obj.font_file2 = font_file_cs_obj font.close() return font_objs_per_index def _add_images(self): img_objs_per_index = {} for img in sorted( self.fpdf.image_cache.images.values(), key=lambda img: img["i"] ): if img["usages"] > 0: img_objs_per_index[img["i"]] = self._add_image(img) return img_objs_per_index def _ensure_iccp(self, img_info): """ Returns the PDF object of the ICC profile indexed iccp_i in the FPDF object. Adds it if not present. """ iccp_i = img_info["iccp_i"] if iccp_i in self.iccp_i_to_pdf_i: return self.iccp_i_to_pdf_i[iccp_i] iccp_content = None for iccp_c, i in self.fpdf.image_cache.icc_profiles.items(): if iccp_i == i: iccp_content = iccp_c break assert iccp_content is not None # Note: n should be 4 if the profile ColorSpace is CMYK iccp_obj = PDFICCPObject( contents=iccp_content, n=img_info["dpn"], alternate=img_info["cs"] ) iccp_pdf_i = self._add_pdf_obj(iccp_obj, "iccp") self.iccp_i_to_pdf_i[iccp_i] = iccp_pdf_i return iccp_pdf_i def _add_image(self, info): color_space = Name(info["cs"]) decode = None iccp_i = info.get("iccp_i") if color_space == "Indexed": color_space = PDFArray( ["/Indexed", "/DeviceRGB", f"{len(info['pal']) // 3 - 1}"] ) elif iccp_i is not None: iccp_pdf_i = self._ensure_iccp(info) color_space = PDFArray(["/ICCBased", str(iccp_pdf_i), str("0"), "R"]) elif color_space == "DeviceCMYK": if info["inverted"] is True: decode = "[1 0 1 0 1 0 1 0]" decode_parms = f"<<{info['dp']} /BitsPerComponent {info['bpc']}>>" img_obj = PDFXObject( subtype="Image", contents=info["data"], width=info["w"], height=info["h"], color_space=color_space, bits_per_component=info["bpc"], img_filter=info["f"], decode=decode, decode_parms=decode_parms, ) self._add_pdf_obj(img_obj, "images") # Soft mask if self.fpdf.allow_images_transparency and "smask" in info: dp = f"/Predictor 15 /Colors 1 /Columns {info['w']}" img_obj.s_mask = self._add_image( { "w": info["w"], "h": info["h"], "cs": "DeviceGray", "bpc": 8, "f": info["f"], "dp": dp, "data": info["smask"], } ) # Palette if "/Indexed" in color_space: pal_cs_obj = PDFContentStream( contents=info["pal"], compress=self.fpdf.compress ) self._add_pdf_obj(pal_cs_obj, "images") img_obj.color_space.append(pdf_ref(pal_cs_obj.id)) return img_obj def _add_gfxstates(self): gfxstate_objs_per_name = OrderedDict() for state_dict, name in self.fpdf._drawing_graphics_state_registry.items(): gfxstate_obj = PDFExtGState(state_dict) self._add_pdf_obj(gfxstate_obj, "gfxstate") gfxstate_objs_per_name[name] = gfxstate_obj return gfxstate_objs_per_name def _add_resources_dict( self, font_objs_per_index, img_objs_per_index, gfxstate_objs_per_name ): # From section 10.1, "Procedure Sets", of PDF 1.7 spec: # > Beginning with PDF 1.4, this feature is considered obsolete. # > For compatibility with existing consumer applications, # > PDF producer applications should continue to specify procedure sets # > (preferably, all of those listed in Table 10.1). proc_set = "[/PDF /Text /ImageB /ImageC /ImageI]" font, x_object, ext_g_state = None, None, None if font_objs_per_index: font = pdf_dict( { f"/F{index}": pdf_ref(font_obj.id) for index, font_obj in sorted(font_objs_per_index.items()) } ) if img_objs_per_index: x_object = pdf_dict( { f"/I{index}": pdf_ref(img_obj.id) for index, img_obj in sorted(img_objs_per_index.items()) } ) if gfxstate_objs_per_name: ext_g_state = pdf_dict( { f"/{name}": pdf_ref(gfxstate_obj.id) for name, gfxstate_obj in gfxstate_objs_per_name.items() } ) resources_obj = PDFResources( proc_set=proc_set, font=font, x_object=x_object, ext_g_state=ext_g_state ) self._add_pdf_obj(resources_obj) return resources_obj def _add_structure_tree(self): "Builds a Structure Hierarchy, including image alternate descriptions" if self.fpdf.struct_builder.empty(): return None struct_tree_root_obj = None for pdf_obj in self.fpdf.struct_builder: if struct_tree_root_obj is None: struct_tree_root_obj = pdf_obj self._add_pdf_obj(pdf_obj, "structure_tree") return struct_tree_root_obj def _add_document_outline(self): if not self.fpdf._outline: return None, () outline_dict_obj, outline_items = None, [] for pdf_obj in build_outline_objs(self.fpdf._outline): if outline_dict_obj is None: outline_dict_obj = pdf_obj else: outline_items.append(pdf_obj) self._add_pdf_obj(pdf_obj, "document_outline") return outline_dict_obj, outline_items def _add_xmp_metadata(self): if not self.fpdf.xmp_metadata: return None xpacket = f'<?xpacket begin="" id="W5M0MpCehiHzreSzNTczkc9d"?>\n{self.fpdf.xmp_metadata}\n<?xpacket end="w"?>\n' pdf_obj = PDFXmpMetadata(xpacket) self._add_pdf_obj(pdf_obj) return pdf_obj def _add_info(self): fpdf = self.fpdf creation_date = None if fpdf.creation_date: try: creation_date = PDFDate(fpdf.creation_date, with_tz=True, encrypt=True) except Exception as error: raise FPDFException( f"Could not format date: {fpdf.creation_date}" ) from error info_obj = PDFInfo( title=getattr(fpdf, "title", None), subject=getattr(fpdf, "subject", None), author=getattr(fpdf, "author", None), keywords=getattr(fpdf, "keywords", None), creator=getattr(fpdf, "creator", None), producer=getattr(fpdf, "producer", None), creation_date=creation_date, ) self._add_pdf_obj(info_obj) return info_obj def _add_encryption(self): if self.fpdf._security_handler: encryption_handler = self.fpdf._security_handler pdf_obj = encryption_handler.get_encryption_obj() self._add_pdf_obj(pdf_obj) return pdf_obj return None def _add_catalog(self): fpdf = self.fpdf catalog_obj = PDFCatalog( lang=getattr(fpdf, "lang", None), page_layout=fpdf.page_layout, page_mode=fpdf.page_mode, viewer_preferences=fpdf.viewer_preferences, ) self._add_pdf_obj(catalog_obj) return catalog_obj def _finalize_catalog( self, catalog_obj, pages_root_obj, first_page_obj, sig_annotation_obj, xmp_metadata_obj, struct_tree_root_obj, outline_dict_obj, ): fpdf = self.fpdf catalog_obj.pages = pages_root_obj catalog_obj.struct_tree_root = struct_tree_root_obj catalog_obj.outlines = outline_dict_obj catalog_obj.metadata = xmp_metadata_obj if sig_annotation_obj: flags = SignatureFlag.SIGNATURES_EXIST + SignatureFlag.APPEND_ONLY catalog_obj.acro_form = AcroForm( fields=PDFArray([sig_annotation_obj]), sig_flags=flags ) if fpdf.zoom_mode in ZOOM_CONFIGS: zoom_config = [ pdf_ref(first_page_obj.id), *ZOOM_CONFIGS[fpdf.zoom_mode], ] else: # zoom_mode is a number, not one of the allowed strings: zoom_config = [ pdf_ref(first_page_obj.id), "/XYZ", "null", "null", str(fpdf.zoom_mode / 100), ] catalog_obj.open_action = pdf_list(zoom_config) if struct_tree_root_obj: catalog_obj.mark_info = pdf_dict({"/Marked": "true"}) if fpdf.embedded_files: file_spec_names = [ f"{PDFString(embedded_file.basename()).serialize()} {embedded_file.file_spec().serialize()}" for embedded_file in fpdf.embedded_files if embedded_file.globally_enclosed ] catalog_obj.names = pdf_dict( {"/EmbeddedFiles": pdf_dict({"/Names": pdf_list(file_spec_names)})} ) @contextmanager def _trace_size(self, label): prev_size = len(self.buffer) yield self.sections_size_per_trace_label[label] += len(self.buffer) - prev_size def _log_final_sections_sizes(self): LOGGER.debug("Final size summary of the biggest document sections:") for label, section_size in self.sections_size_per_trace_label.items(): LOGGER.debug("- %s: %s", label, _sizeof_fmt(section_size))Subclasses
Methods
def bufferize(self)-
This method alters the target FPDF instance by assigning IDs to all PDF objects, plus a few other properties on PDFPage instances
Expand source code Browse git
def bufferize(self): """ This method alters the target FPDF instance by assigning IDs to all PDF objects, plus a few other properties on PDFPage instances """ fpdf = self.fpdf # 1. Setup - Insert all PDF objects # and assign unique consecutive numeric IDs to all of them if fpdf._security_handler: # get the file_id and generate passwords needed to encrypt streams and strings file_id = fpdf.file_id() if file_id == -1: # no custom file id - use default file id so enryption passwords can be generated file_id = fpdf._default_file_id(bytearray(0x00)) fpdf._security_handler.generate_passwords(file_id) self.pdf_objs.append(PDFHeader(fpdf.pdf_version)) pages_root_obj = self._add_pages_root() catalog_obj = self._add_catalog() page_objs = self._add_pages() sig_annotation_obj = self._add_annotations_as_objects() for embedded_file in fpdf.embedded_files: self._add_pdf_obj(embedded_file, "embedded_files") font_objs_per_index = self._add_fonts() img_objs_per_index = self._add_images() gfxstate_objs_per_name = self._add_gfxstates() resources_dict_obj = self._add_resources_dict( font_objs_per_index, img_objs_per_index, gfxstate_objs_per_name ) struct_tree_root_obj = self._add_structure_tree() outline_dict_obj, outline_items = self._add_document_outline() xmp_metadata_obj = self._add_xmp_metadata() info_obj = self._add_info() encryption_obj = self._add_encryption() xref = PDFXrefAndTrailer(self) self.pdf_objs.append(xref) # 2. Plumbing - Inject all PDF object references required: pages_root_obj.kids = PDFArray(page_objs) self._finalize_catalog( catalog_obj, pages_root_obj=pages_root_obj, first_page_obj=page_objs[0], sig_annotation_obj=sig_annotation_obj, xmp_metadata_obj=xmp_metadata_obj, struct_tree_root_obj=struct_tree_root_obj, outline_dict_obj=outline_dict_obj, ) dests = [] for page_obj in page_objs: page_obj.parent = pages_root_obj page_obj.resources = resources_dict_obj for annot in page_obj.annots: page_dests = [] if annot.dest: page_dests.append(annot.dest) if annot.a and hasattr(annot.a, "dest"): page_dests.append(annot.a.dest) for dest in page_dests: if dest.page_number > len(page_objs): raise ValueError( f"Invalid reference to non-existing page {dest.page_number} present on page {page_obj.index()}: " ) dests.extend(page_dests) if not page_obj.annots: # Avoid serializing an empty PDFArray: page_obj.annots = None for outline_item in outline_items: dests.append(outline_item.dest) # Assigning the .page_ref property of all Destination objects: for dest in dests: dest.page_ref = pdf_ref(page_objs[dest.page_number - 1].id) for struct_elem in fpdf.struct_builder.doc_struct_elem.k: struct_elem.pg = page_objs[struct_elem.page_number() - 1] xref.catalog_obj = catalog_obj xref.info_obj = info_obj xref.encryption_obj = encryption_obj # 3. Serializing - Append all PDF objects to the buffer: assert ( not self.buffer ), f"Nothing should have been appended to the .buffer at this stage: {self.buffer}" assert ( not self.offsets ), f"No offset should have been set at this stage: {len(self.offsets)}" for pdf_obj in self.pdf_objs: if isinstance(pdf_obj, ContentWithoutID): # top header, xref table & trailer: trace_label = None else: self.offsets[pdf_obj.id] = len(self.buffer) trace_label = self.trace_labels_per_obj_id.get(pdf_obj.id) if trace_label: with self._trace_size(trace_label): self._out( pdf_obj.serialize(_security_handler=fpdf._security_handler) ) else: self._out(pdf_obj.serialize(_security_handler=fpdf._security_handler)) self._log_final_sections_sizes() if fpdf._sign_key: self.buffer = sign_content( signer, self.buffer, fpdf._sign_key, fpdf._sign_cert, fpdf._sign_extra_certs, fpdf._sign_hashalgo, fpdf._sign_time, ) return self.buffer
class PDFCatalog (lang=None, page_layout=None, page_mode=None, viewer_preferences=None)-
Main features of this class: * delay ID assignement * implement serializing
Expand source code Browse git
class PDFCatalog(PDFObject): def __init__( self, lang=None, page_layout=None, page_mode=None, viewer_preferences=None ): super().__init__() self.type = Name("Catalog") self.lang = PDFString(lang) if lang else None self.page_layout = page_layout self.page_mode = page_mode self.viewer_preferences = viewer_preferences self.pages = None # Required; shall be an indirect reference self.acro_form = None self.open_action = None self.mark_info = None self.metadata = None self.names = None self.outlines = None self.struct_tree_root = NoneAncestors
Inherited members
class PDFExtGState (dict_as_str)-
Main features of this class: * delay ID assignement * implement serializing
Expand source code Browse git
class PDFExtGState(PDFObject): def __init__(self, dict_as_str): super().__init__() self._dict_as_str = dict_as_str # method override def serialize(self, obj_dict=None, _security_handler=None): return f"{self.id} 0 obj\n{self._dict_as_str}\nendobj"Ancestors
Inherited members
class PDFFont (subtype, base_font, encoding=None, d_w=None, w=None)-
Main features of this class: * delay ID assignement * implement serializing
Expand source code Browse git
class PDFFont(PDFObject): def __init__(self, subtype, base_font, encoding=None, d_w=None, w=None): super().__init__() self.type = Name("Font") self.subtype = Name(subtype) self.base_font = Name(base_font) self.encoding = Name(encoding) if encoding else None self.d_w = d_w self.w = w self.descendant_fonts = None self.to_unicode = None self.c_i_d_system_info = None self.font_descriptor = None self.c_i_d_to_g_i_d_map = NoneAncestors
Inherited members
class PDFFontStream (contents)-
Main features of this class: * delay ID assignement * implement serializing
Expand source code Browse git
class PDFFontStream(PDFContentStream): def __init__(self, contents): super().__init__(contents=contents, compress=True) self.length1 = len(contents)Ancestors
Inherited members
class PDFHeader (pdf_version)-
Expand source code Browse git
class PDFHeader(ContentWithoutID): def __init__(self, pdf_version): self.pdf_version = pdf_version # method override def serialize(self, _security_handler=None): return f"%PDF-{self.pdf_version}"Ancestors
Methods
def serialize(self)-
Expand source code Browse git
def serialize(self, _security_handler=None): return f"%PDF-{self.pdf_version}"
class PDFICCPObject (contents, n, alternate)-
Main features of this class: * delay ID assignement * implement serializing
Expand source code Browse git
class PDFICCPObject(PDFContentStream): __slots__ = ( # RAM usage optimization "_id", "_contents", "filter", "length", "n", "alternate", ) def __init__( self, contents, n, alternate, ): super().__init__(contents=contents, compress=True) self.n = n self.alternate = Name(alternate)Ancestors
Instance variables
var alternate-
Return an attribute of instance, which is of type owner.
var filter-
Return an attribute of instance, which is of type owner.
var length-
Return an attribute of instance, which is of type owner.
var n-
Return an attribute of instance, which is of type owner.
Inherited members
class PDFInfo (title, subject, author, keywords, creator, producer, creation_date: PDFDate)-
Main features of this class: * delay ID assignement * implement serializing
Expand source code Browse git
class PDFInfo(PDFObject): def __init__( self, title, subject, author, keywords, creator, producer, creation_date: PDFDate, ): super().__init__() self.title = PDFString(title, encrypt=True) if title else None self.subject = PDFString(subject, encrypt=True) if subject else None self.author = PDFString(author, encrypt=True) if author else None self.keywords = PDFString(keywords, encrypt=True) if keywords else None self.creator = PDFString(creator, encrypt=True) if creator else None self.producer = PDFString(producer, encrypt=True) if producer else None self.creation_date = creation_dateAncestors
Inherited members
class PDFPage (duration, transition, contents, index)-
Main features of this class: * delay ID assignement * implement serializing
Expand source code Browse git
class PDFPage(PDFObject): __slots__ = ( # RAM usage optimization "_id", "type", "contents", "dur", "trans", "annots", "group", "media_box", "struct_parents", "resources", "parent", "_index", "_width_pt", "_height_pt", ) def __init__( self, duration, transition, contents, index, ): super().__init__() self.type = Name("Page") self.contents = contents self.dur = duration if duration else None self.trans = transition self.annots = PDFArray() # list of PDFAnnotation self.group = None self.media_box = None self.struct_parents = None self.resources = None # must always be set before calling .serialize() self.parent = None # must always be set before calling .serialize() self._index = index self._width_pt, self._height_pt = None, None def index(self): return self._index def dimensions(self): "Return a pair (width, height) in the unit specified to FPDF constructor" return self._width_pt, self._height_pt def set_dimensions(self, width_pt, height_pt): "Accepts a pair (width, height) in the unit specified to FPDF constructor" self._width_pt, self._height_pt = width_pt, height_ptAncestors
Instance variables
var annots-
Return an attribute of instance, which is of type owner.
var contents-
Return an attribute of instance, which is of type owner.
var dur-
Return an attribute of instance, which is of type owner.
var group-
Return an attribute of instance, which is of type owner.
var media_box-
Return an attribute of instance, which is of type owner.
var parent-
Return an attribute of instance, which is of type owner.
var resources-
Return an attribute of instance, which is of type owner.
var struct_parents-
Return an attribute of instance, which is of type owner.
var trans-
Return an attribute of instance, which is of type owner.
var type-
Return an attribute of instance, which is of type owner.
Methods
def dimensions(self)-
Return a pair (width, height) in the unit specified to FPDF constructor
Expand source code Browse git
def dimensions(self): "Return a pair (width, height) in the unit specified to FPDF constructor" return self._width_pt, self._height_pt def index(self)-
Expand source code Browse git
def index(self): return self._index def set_dimensions(self, width_pt, height_pt)-
Accepts a pair (width, height) in the unit specified to FPDF constructor
Expand source code Browse git
def set_dimensions(self, width_pt, height_pt): "Accepts a pair (width, height) in the unit specified to FPDF constructor" self._width_pt, self._height_pt = width_pt, height_pt
Inherited members
class PDFPagesRoot (count, media_box)-
Main features of this class: * delay ID assignement * implement serializing
Expand source code Browse git
class PDFPagesRoot(PDFObject): def __init__(self, count, media_box): super().__init__() self.type = Name("Pages") self.count = count self.media_box = media_box self.kids = None # must always be set before calling .serialize()Ancestors
Inherited members
class PDFResources (proc_set, font, x_object, ext_g_state)-
Main features of this class: * delay ID assignement * implement serializing
Expand source code Browse git
class PDFResources(PDFObject): def __init__(self, proc_set, font, x_object, ext_g_state): super().__init__() self.proc_set = proc_set self.font = font self.x_object = x_object self.ext_g_state = ext_g_stateAncestors
Inherited members
class PDFXObject (contents, subtype, width, height, color_space, bits_per_component, img_filter=None, decode=None, decode_parms=None)-
Main features of this class: * delay ID assignement * implement serializing
Expand source code Browse git
class PDFXObject(PDFContentStream): __slots__ = ( # RAM usage optimization "_id", "_contents", "filter", "length", "type", "subtype", "width", "height", "color_space", "bits_per_component", "decode", "decode_parms", "s_mask", ) def __init__( self, contents, subtype, width, height, color_space, bits_per_component, img_filter=None, decode=None, decode_parms=None, ): super().__init__(contents=contents) self.type = Name("XObject") self.subtype = Name(subtype) self.width = width self.height = height self.color_space = color_space self.bits_per_component = bits_per_component self.filter = Name(img_filter) self.decode = decode self.decode_parms = decode_parms self.s_mask = NoneAncestors
Instance variables
var bits_per_component-
Return an attribute of instance, which is of type owner.
var color_space-
Return an attribute of instance, which is of type owner.
var decode-
Return an attribute of instance, which is of type owner.
var decode_parms-
Return an attribute of instance, which is of type owner.
var filter-
Return an attribute of instance, which is of type owner.
var height-
Return an attribute of instance, which is of type owner.
var length-
Return an attribute of instance, which is of type owner.
var s_mask-
Return an attribute of instance, which is of type owner.
var subtype-
Return an attribute of instance, which is of type owner.
var type-
Return an attribute of instance, which is of type owner.
var width-
Return an attribute of instance, which is of type owner.
Inherited members
class PDFXmpMetadata (contents)-
Main features of this class: * delay ID assignement * implement serializing
Expand source code Browse git
class PDFXmpMetadata(PDFContentStream): def __init__(self, contents): super().__init__(contents=contents.encode("utf-8")) self.type = Name("Metadata") self.subtype = Name("XML")Ancestors
Inherited members
class PDFXrefAndTrailer (output_builder)-
Expand source code Browse git
class PDFXrefAndTrailer(ContentWithoutID): def __init__(self, output_builder): self.output_builder = output_builder self.count = output_builder.obj_id + 1 # Must be set before the call to serialize(): self.catalog_obj = None self.info_obj = None self.encryption_obj = None def serialize(self, _security_handler=None): builder = self.output_builder startxref = str(len(builder.buffer)) out = [] out.append("xref") out.append(f"0 {self.count}") out.append("0000000000 65535 f ") for obj_id in range(1, self.count): out.append(f"{builder.offsets[obj_id]:010} 00000 n ") out.append("trailer") out.append("<<") out.append(f"/Size {self.count}") out.append(f"/Root {pdf_ref(self.catalog_obj.id)}") out.append(f"/Info {pdf_ref(self.info_obj.id)}") fpdf = builder.fpdf if self.encryption_obj: out.append(f"/Encrypt {pdf_ref(self.encryption_obj.id)}") file_id = fpdf._security_handler.file_id else: file_id = fpdf.file_id() if file_id == -1: file_id = fpdf._default_file_id(builder.buffer) if file_id: out.append(f"/ID [{file_id}]") out.append(">>") out.append("startxref") out.append(startxref) out.append("%%EOF") return "\n".join(out)Ancestors
Methods
def serialize(self)-
Expand source code Browse git
def serialize(self, _security_handler=None): builder = self.output_builder startxref = str(len(builder.buffer)) out = [] out.append("xref") out.append(f"0 {self.count}") out.append("0000000000 65535 f ") for obj_id in range(1, self.count): out.append(f"{builder.offsets[obj_id]:010} 00000 n ") out.append("trailer") out.append("<<") out.append(f"/Size {self.count}") out.append(f"/Root {pdf_ref(self.catalog_obj.id)}") out.append(f"/Info {pdf_ref(self.info_obj.id)}") fpdf = builder.fpdf if self.encryption_obj: out.append(f"/Encrypt {pdf_ref(self.encryption_obj.id)}") file_id = fpdf._security_handler.file_id else: file_id = fpdf.file_id() if file_id == -1: file_id = fpdf._default_file_id(builder.buffer) if file_id: out.append(f"/ID [{file_id}]") out.append(">>") out.append("startxref") out.append(startxref) out.append("%%EOF") return "\n".join(out)