File: //home/arjun/projects/env/lib64/python3.10/site-packages/weasyprint/pdf/stream.py
"""PDF stream."""
import io
from functools import lru_cache
from hashlib import md5
import pydyf
from fontTools import subset
from fontTools.ttLib import TTFont, TTLibError, ttFont
from fontTools.varLib.mutator import instantiateVariableFont
from ..logger import LOGGER
from ..matrix import Matrix
from ..text.ffi import ffi, harfbuzz, pango, units_to_double
class Font:
def __init__(self, pango_font):
hb_font = pango.pango_font_get_hb_font(pango_font)
hb_face = harfbuzz.hb_font_get_face(hb_font)
hb_blob = ffi.gc(
harfbuzz.hb_face_reference_blob(hb_face),
harfbuzz.hb_blob_destroy)
with ffi.new('unsigned int *') as length:
hb_data = harfbuzz.hb_blob_get_data(hb_blob, length)
self.file_content = ffi.unpack(hb_data, int(length[0]))
self.index = harfbuzz.hb_face_get_index(hb_face)
pango_metrics = pango.pango_font_get_metrics(pango_font, ffi.NULL)
self.description = description = ffi.gc(
pango.pango_font_describe(pango_font),
pango.pango_font_description_free)
self.font_size = pango.pango_font_description_get_size(description)
self.style = pango.pango_font_description_get_style(description)
self.family = ffi.string(
pango.pango_font_description_get_family(description))
description_string = ffi.string(
pango.pango_font_description_to_string(description))
# Never use the built-in hash function here: it’s not stable
self.hash = ''.join(
chr(65 + letter % 26) for letter
in md5(description_string).digest()[:6])
# Name
fields = description_string.split(b' ')
if fields and b'=' in fields[-1]:
fields.pop() # Remove variations
if fields:
fields.pop() # Remove font size
else:
fields = [b'Unknown']
self.name = b'/' + self.hash.encode() + b'+' + b'-'.join(fields)
# Ascent & descent
if self.font_size:
self.ascent = int(
pango.pango_font_metrics_get_ascent(pango_metrics) /
self.font_size * 1000)
self.descent = -int(
pango.pango_font_metrics_get_descent(pango_metrics) /
self.font_size * 1000)
else:
self.ascent = self.descent = 0
# Fonttools
full_font = io.BytesIO(self.file_content)
try:
self.ttfont = TTFont(full_font, fontNumber=self.index)
except Exception:
LOGGER.warning('Unable to read font')
self.ttfont = None
self.bitmap = False
else:
self.bitmap = (
'EBDT' in self.ttfont and
'EBLC' in self.ttfont and
not self.ttfont['glyf'].glyphs)
# Various properties
self.italic_angle = 0 # TODO: this should be different
self.upem = harfbuzz.hb_face_get_upem(hb_face)
self.png = harfbuzz.hb_ot_color_has_png(hb_face)
self.svg = harfbuzz.hb_ot_color_has_svg(hb_face)
self.stemv = 80
self.stemh = 80
self.widths = {}
self.cmap = {}
self.used_in_forms = False
# Font flags
self.flags = 2 ** (3 - 1) # Symbolic, custom character set
if self.style:
self.flags += 2 ** (7 - 1) # Italic
if b'Serif' in fields:
self.flags += 2 ** (2 - 1) # Serif
widths = self.widths.values()
if len(widths) > 1 and len(set(widths)) == 1:
self.flags += 2 ** (1 - 1) # FixedPitch
def clean(self, cmap, hinting):
if self.ttfont is None:
return
# Subset font
if cmap:
optimized_font = io.BytesIO()
options = subset.Options(
retain_gids=True, passthrough_tables=True,
ignore_missing_glyphs=True, hinting=hinting,
desubroutinize=True)
options.drop_tables += ['GSUB', 'GPOS', 'SVG']
subsetter = subset.Subsetter(options)
subsetter.populate(gids=cmap)
try:
subsetter.subset(self.ttfont)
except TTLibError:
LOGGER.warning('Unable to optimize font')
else:
self.ttfont.save(optimized_font)
self.file_content = optimized_font.getvalue()
# Transform variable into static font
if 'fvar' in self.ttfont:
variations = pango.pango_font_description_get_variations(
self.description)
if variations == ffi.NULL:
variations = {}
else:
variations = {
part.split('=')[0]: float(part.split('=')[1])
for part in ffi.string(variations).decode().split(',')}
if 'wght' not in variations:
variations['wght'] = pango.pango_font_description_get_weight(
self.description)
if 'opsz' not in variations:
variations['opsz'] = units_to_double(self.font_size)
if 'slnt' not in variations:
slnt = 0
if self.style == 1:
for axe in self.ttfont['fvar'].axes:
if axe.axisTag == 'slnt':
if axe.maxValue == 0:
slnt = axe.minValue
else:
slnt = axe.maxValue
break
variations['slnt'] = slnt
if 'ital' not in variations:
variations['ital'] = int(self.style == 2)
partial_font = io.BytesIO()
try:
ttfont = instantiateVariableFont(self.ttfont, variations)
for key, (advance, bearing) in ttfont['hmtx'].metrics.items():
if advance < 0:
ttfont['hmtx'].metrics[key] = (0, bearing)
ttfont.save(partial_font)
except Exception:
LOGGER.warning('Unable to mutate variable font')
else:
self.ttfont = ttfont
self.file_content = partial_font.getvalue()
if not (self.png or self.svg):
return
try:
# Add empty glyphs instead of PNG or SVG emojis
if 'loca' not in self.ttfont or 'glyf' not in self.ttfont:
self.ttfont['loca'] = ttFont.getTableClass('loca')()
self.ttfont['glyf'] = ttFont.getTableClass('glyf')()
self.ttfont['glyf'].glyphOrder = self.ttfont.getGlyphOrder()
self.ttfont['glyf'].glyphs = {
name: ttFont.getTableModule('glyf').Glyph()
for name in self.ttfont['glyf'].glyphOrder}
else:
for glyph in self.ttfont['glyf'].glyphs:
self.ttfont['glyf'][glyph] = (
ttFont.getTableModule('glyf').Glyph())
for table_name in ('CBDT', 'CBLC', 'SVG '):
if table_name in self.ttfont:
del self.ttfont[table_name]
output_font = io.BytesIO()
self.ttfont.save(output_font)
self.file_content = output_font.getvalue()
except TTLibError:
LOGGER.warning('Unable to save emoji font')
@property
def type(self):
return 'otf' if self.file_content[:4] == b'OTTO' else 'ttf'
class Stream(pydyf.Stream):
"""PDF stream object with extra features."""
def __init__(self, fonts, page_rectangle, states, x_objects, patterns,
shadings, images, mark, *args, **kwargs):
super().__init__(*args, **kwargs)
self.page_rectangle = page_rectangle
self.marked = []
self._fonts = fonts
self._states = states
self._x_objects = x_objects
self._patterns = patterns
self._shadings = shadings
self._images = images
self._mark = mark
self._current_color = self._current_color_stroke = None
self._current_alpha = self._current_alpha_stroke = None
self._current_font = self._current_font_size = None
self._old_font = self._old_font_size = None
self._ctm_stack = [Matrix()]
# These objects are used in text.show_first_line
self.length = ffi.new('unsigned int *')
self.ink_rect = ffi.new('PangoRectangle *')
self.logical_rect = ffi.new('PangoRectangle *')
@property
def ctm(self):
return self._ctm_stack[-1]
def push_state(self):
super().push_state()
self._ctm_stack.append(self.ctm)
def pop_state(self):
if self.stream and self.stream[-1] == b'q':
self.stream.pop()
else:
super().pop_state()
self._current_color = self._current_color_stroke = None
self._current_alpha = self._current_alpha_stroke = None
self._current_font = None
self._ctm_stack.pop()
assert self._ctm_stack
def transform(self, a=1, b=0, c=0, d=1, e=0, f=0):
super().transform(a, b, c, d, e, f)
self._ctm_stack[-1] = Matrix(a, b, c, d, e, f) @ self.ctm
def begin_text(self):
if self.stream and self.stream[-1] == b'ET':
self._current_font = self._old_font
self.stream.pop()
else:
super().begin_text()
def end_text(self):
self._old_font, self._current_font = self._current_font, None
super().end_text()
def set_color_rgb(self, r, g, b, stroke=False):
if stroke:
if (r, g, b) == self._current_color_stroke:
return
else:
self._current_color_stroke = (r, g, b)
else:
if (r, g, b) == self._current_color:
return
else:
self._current_color = (r, g, b)
super().set_color_rgb(r, g, b, stroke)
def set_font_size(self, font, size):
if (font, size) == self._current_font:
return
self._current_font = (font, size)
super().set_font_size(font, size)
def set_state(self, state):
key = f's{len(self._states)}'
self._states[key] = state
super().set_state(key)
def set_alpha(self, alpha, stroke=False, fill=None):
if fill is None:
fill = not stroke
if stroke:
key = f'A{alpha}'
if key != self._current_alpha_stroke:
self._current_alpha_stroke = key
if key not in self._states:
self._states[key] = pydyf.Dictionary({'CA': alpha})
super().set_state(key)
if fill:
key = f'a{alpha}'
if key != self._current_alpha:
self._current_alpha = key
if key not in self._states:
self._states[key] = pydyf.Dictionary({'ca': alpha})
super().set_state(key)
def set_alpha_state(self, x, y, width, height):
alpha_stream = self.add_group(x, y, width, height)
alpha_state = pydyf.Dictionary({
'Type': '/ExtGState',
'SMask': pydyf.Dictionary({
'Type': '/Mask',
'S': '/Luminosity',
'G': alpha_stream,
}),
'ca': 1,
'AIS': 'false',
})
self.set_state(alpha_state)
return alpha_stream
def set_blend_mode(self, mode):
self.set_state(pydyf.Dictionary({
'Type': '/ExtGState',
'BM': f'/{mode}',
}))
@lru_cache()
def add_font(self, pango_font):
description = pango.pango_font_describe(pango_font)
mask = (
pango.PANGO_FONT_MASK_SIZE +
pango.PANGO_FONT_MASK_GRAVITY +
pango.PANGO_FONT_MASK_VARIATIONS)
pango.pango_font_description_unset_fields(description, mask)
key = pango.pango_font_description_hash(description)
pango.pango_font_description_free(description)
if key not in self._fonts:
self._fonts[key] = Font(pango_font)
return self._fonts[key]
def add_group(self, x, y, width, height):
states = pydyf.Dictionary()
x_objects = pydyf.Dictionary()
patterns = pydyf.Dictionary()
shadings = pydyf.Dictionary()
resources = pydyf.Dictionary({
'ExtGState': states,
'XObject': x_objects,
'Pattern': patterns,
'Shading': shadings,
'Font': None, # Will be set by _use_references
})
extra = pydyf.Dictionary({
'Type': '/XObject',
'Subtype': '/Form',
'BBox': pydyf.Array((x, y, x + width, y + height)),
'Resources': resources,
'Group': pydyf.Dictionary({
'Type': '/Group',
'S': '/Transparency',
'I': 'true',
'CS': '/DeviceRGB',
}),
})
group = Stream(
self._fonts, self.page_rectangle, states, x_objects, patterns,
shadings, self._images, self._mark, extra=extra,
compress=self.compress)
group.id = f'x{len(self._x_objects)}'
self._x_objects[group.id] = group
return group
def add_image(self, image, interpolate, ratio):
image_name = f'i{image.id}{int(interpolate)}'
self._x_objects[image_name] = None # Set by write_pdf
if image_name in self._images:
# Reuse image already stored in document
self._images[image_name]['dpi_ratios'].add(ratio)
return image_name
self._images[image_name] = {
'image': image,
'interpolate': interpolate,
'dpi_ratios': {ratio},
'x_object': None, # Set by write_pdf
}
return image_name
def add_pattern(self, x, y, width, height, repeat_width, repeat_height,
matrix):
states = pydyf.Dictionary()
x_objects = pydyf.Dictionary()
patterns = pydyf.Dictionary()
shadings = pydyf.Dictionary()
resources = pydyf.Dictionary({
'ExtGState': states,
'XObject': x_objects,
'Pattern': patterns,
'Shading': shadings,
'Font': None, # Will be set by _use_references
})
extra = pydyf.Dictionary({
'Type': '/Pattern',
'PatternType': 1,
'BBox': pydyf.Array([x, y, x + width, y + height]),
'XStep': repeat_width,
'YStep': repeat_height,
'TilingType': 1,
'PaintType': 1,
'Matrix': pydyf.Array(matrix.values),
'Resources': resources,
})
pattern = Stream(
self._fonts, self.page_rectangle, states, x_objects, patterns,
shadings, self._images, self._mark, extra=extra,
compress=self.compress)
pattern.id = f'p{len(self._patterns)}'
self._patterns[pattern.id] = pattern
return pattern
def add_shading(self, shading_type, color_space, domain, coords, extend,
function):
shading = pydyf.Dictionary({
'ShadingType': shading_type,
'ColorSpace': f'/Device{color_space}',
'Domain': pydyf.Array(domain),
'Coords': pydyf.Array(coords),
'Function': function,
})
if extend:
shading['Extend'] = pydyf.Array((b'true', b'true'))
shading.id = f's{len(self._shadings)}'
self._shadings[shading.id] = shading
return shading
def begin_marked_content(self, box, mcid=False, tag=None):
if not self._mark:
return
property_list = None
if tag is None:
tag = self.get_marked_content_tag(box.element_tag)
if mcid:
property_list = pydyf.Dictionary({'MCID': len(self.marked)})
self.marked.append((tag, box))
super().begin_marked_content(tag, property_list)
def end_marked_content(self):
if not self._mark:
return
super().end_marked_content()
@staticmethod
def create_interpolation_function(domain, c0, c1, n):
return pydyf.Dictionary({
'FunctionType': 2,
'Domain': pydyf.Array(domain),
'C0': pydyf.Array(c0),
'C1': pydyf.Array(c1),
'N': n,
})
@staticmethod
def create_stitching_function(domain, encode, bounds, sub_functions):
return pydyf.Dictionary({
'FunctionType': 3,
'Domain': pydyf.Array(domain),
'Encode': pydyf.Array(encode),
'Bounds': pydyf.Array(bounds),
'Functions': pydyf.Array(sub_functions),
})
def get_marked_content_tag(self, element_tag):
if element_tag == 'div':
return 'Div'
elif element_tag == 'span':
return 'Span'
elif element_tag == 'article':
return 'Art'
elif element_tag == 'section':
return 'Sect'
elif element_tag == 'blockquote':
return 'BlockQuote'
elif element_tag == 'p':
return 'P'
elif element_tag in ('h1', 'h2', 'h3', 'h4', 'h5', 'h6'):
return element_tag.upper()
elif element_tag in ('dl', 'ul', 'ol'):
return 'L'
elif element_tag in ('li', 'dt', 'dd'):
return 'LI'
elif element_tag == 'table':
return 'Table'
elif element_tag in ('tr', 'th', 'td'):
return element_tag.upper()
elif element_tag in ('thead', 'tbody', 'tfoot'):
return element_tag[:2].upper() + element_tag[2:]
else:
return 'NonStruct'