2011-05-25 17:54:46 +04:00
|
|
|
|
# coding: utf8
|
|
|
|
|
|
|
|
|
|
# WeasyPrint converts web documents (HTML, CSS, ...) to PDF.
|
|
|
|
|
# Copyright (C) 2011 Simon Sapin
|
|
|
|
|
#
|
|
|
|
|
# This program is free software: you can redistribute it and/or modify
|
|
|
|
|
# it under the terms of the GNU Affero General Public License as
|
|
|
|
|
# published by the Free Software Foundation, either version 3 of the
|
|
|
|
|
# License, or (at your option) any later version.
|
|
|
|
|
#
|
|
|
|
|
# This program is distributed in the hope that it will be useful,
|
|
|
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
|
# GNU Affero General Public License for more details.
|
|
|
|
|
#
|
|
|
|
|
# You should have received a copy of the GNU Affero General Public License
|
|
|
|
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
|
|
|
|
|
|
"""
|
2011-08-25 14:48:00 +04:00
|
|
|
|
Specific handling for some HTML elements, especially replaced elements.
|
2011-08-19 18:52:46 +04:00
|
|
|
|
|
2011-05-25 17:54:46 +04:00
|
|
|
|
Replaced elements (eg. <img> elements) are rendered externally and behave
|
|
|
|
|
as an atomic opaque box in CSS. They may or may not have intrinsic dimensions.
|
2011-08-19 18:52:46 +04:00
|
|
|
|
|
2011-05-25 17:54:46 +04:00
|
|
|
|
"""
|
|
|
|
|
|
2012-02-17 21:49:58 +04:00
|
|
|
|
from __future__ import division, unicode_literals
|
2011-08-10 16:51:18 +04:00
|
|
|
|
|
2011-10-14 21:07:13 +04:00
|
|
|
|
from .formatting_structure import boxes
|
|
|
|
|
from .utils import get_url_attribute
|
2012-02-17 21:49:58 +04:00
|
|
|
|
from .compat import xrange
|
2011-08-10 16:51:18 +04:00
|
|
|
|
|
2011-05-25 17:54:46 +04:00
|
|
|
|
|
2011-08-25 14:48:00 +04:00
|
|
|
|
# Maps HTML tag names to function taking an HTML element and returning a Box.
|
|
|
|
|
HTML_HANDLERS = {}
|
2011-08-20 20:02:04 +04:00
|
|
|
|
|
2011-08-25 19:29:16 +04:00
|
|
|
|
|
2011-12-02 15:36:20 +04:00
|
|
|
|
def handle_element(document, element, box):
|
2011-08-25 19:29:16 +04:00
|
|
|
|
"""Handle HTML elements that need special care.
|
|
|
|
|
|
2011-11-17 18:39:30 +04:00
|
|
|
|
:returns: a (possibly empty) list of boxes.
|
2011-08-25 19:29:16 +04:00
|
|
|
|
"""
|
2011-12-02 15:36:20 +04:00
|
|
|
|
if box.element_tag in HTML_HANDLERS:
|
|
|
|
|
return HTML_HANDLERS[element.tag](document, element, box)
|
2011-08-25 19:29:16 +04:00
|
|
|
|
else:
|
2011-11-17 18:39:30 +04:00
|
|
|
|
return [box]
|
2011-08-20 20:02:04 +04:00
|
|
|
|
|
|
|
|
|
|
2011-08-25 14:48:00 +04:00
|
|
|
|
def handler(tag):
|
2011-09-09 01:02:17 +04:00
|
|
|
|
"""Return a decorator registering a function handling ``tag`` elements."""
|
2011-08-22 19:50:32 +04:00
|
|
|
|
def decorator(function):
|
2011-09-09 01:02:17 +04:00
|
|
|
|
"""Decorator registering a function handling ``tag`` elements."""
|
2011-08-25 14:48:00 +04:00
|
|
|
|
HTML_HANDLERS[tag] = function
|
2011-08-22 19:50:32 +04:00
|
|
|
|
return function
|
|
|
|
|
return decorator
|
2011-08-20 20:02:04 +04:00
|
|
|
|
|
|
|
|
|
|
2011-11-15 14:44:28 +04:00
|
|
|
|
def is_block_level(box):
|
|
|
|
|
"""Tell wether ``box`` is supposed to be block level.
|
2011-09-09 01:02:17 +04:00
|
|
|
|
|
|
|
|
|
Return ``True`` if the element is block-level, ``False`` if it is
|
|
|
|
|
inline-level, and raise ValueError if it is neither.
|
|
|
|
|
|
2011-08-25 19:29:16 +04:00
|
|
|
|
"""
|
2011-11-15 14:44:28 +04:00
|
|
|
|
display = box.style.display
|
2011-08-25 14:48:00 +04:00
|
|
|
|
|
|
|
|
|
if display in ('block', 'list-item', 'table'):
|
2011-08-25 19:29:16 +04:00
|
|
|
|
return True
|
2011-08-25 14:48:00 +04:00
|
|
|
|
elif display in ('inline', 'inline-table', 'inline-block'):
|
2011-08-25 19:29:16 +04:00
|
|
|
|
return False
|
|
|
|
|
else:
|
|
|
|
|
raise ValueError('Unsupported display: ' + display)
|
|
|
|
|
|
|
|
|
|
|
2011-12-08 21:11:32 +04:00
|
|
|
|
def make_replaced_box(element, box, image):
|
|
|
|
|
"""Wrap an image in a replaced box.
|
2011-09-09 01:02:17 +04:00
|
|
|
|
|
|
|
|
|
That box is either block-level or inline-level, depending on what the
|
|
|
|
|
element should be.
|
|
|
|
|
|
2011-08-25 19:29:16 +04:00
|
|
|
|
"""
|
2011-11-15 14:44:28 +04:00
|
|
|
|
if is_block_level(box):
|
2011-12-05 17:24:43 +04:00
|
|
|
|
type_ = boxes.BlockReplacedBox
|
2011-08-25 14:48:00 +04:00
|
|
|
|
else:
|
2011-12-05 17:24:43 +04:00
|
|
|
|
type_ = boxes.InlineReplacedBox
|
2011-12-08 21:11:32 +04:00
|
|
|
|
return type_(element.tag, element.sourceline, box.style, image)
|
2011-08-25 14:48:00 +04:00
|
|
|
|
|
|
|
|
|
|
2011-12-02 18:31:23 +04:00
|
|
|
|
def make_text_box(element, box, text):
|
2011-09-27 13:50:47 +04:00
|
|
|
|
"""Make a text box.
|
2011-09-09 01:02:17 +04:00
|
|
|
|
|
2011-09-27 13:50:47 +04:00
|
|
|
|
If the element should be block-level, wrap it in a block box.
|
2011-09-09 01:02:17 +04:00
|
|
|
|
|
2011-08-25 19:29:16 +04:00
|
|
|
|
"""
|
2011-12-02 18:31:23 +04:00
|
|
|
|
text_box = boxes.TextBox(element.tag, element.sourceline,
|
2011-12-02 15:36:20 +04:00
|
|
|
|
box.style.inherit_from(), text)
|
2011-11-15 14:44:28 +04:00
|
|
|
|
if is_block_level(box):
|
2011-12-02 15:36:20 +04:00
|
|
|
|
type_ = boxes.BlockBox
|
2011-08-25 19:29:16 +04:00
|
|
|
|
else:
|
2011-12-02 15:36:20 +04:00
|
|
|
|
type_ = boxes.InlineBox
|
2011-12-02 18:31:23 +04:00
|
|
|
|
return type_(element.tag, element.sourceline,
|
2011-12-02 15:36:20 +04:00
|
|
|
|
box.style, [text_box])
|
2011-08-25 19:29:16 +04:00
|
|
|
|
|
|
|
|
|
|
2011-08-25 14:48:00 +04:00
|
|
|
|
@handler('img')
|
2011-12-02 15:36:20 +04:00
|
|
|
|
def handle_img(document, element, box):
|
2012-02-29 20:38:30 +04:00
|
|
|
|
"""Handle ``<img>`` elements, return either an image or the alt-text.
|
2011-09-09 01:02:17 +04:00
|
|
|
|
|
|
|
|
|
See: http://www.w3.org/TR/html5/embedded-content-1.html#the-img-element
|
2011-08-25 19:29:16 +04:00
|
|
|
|
|
2011-08-22 19:55:30 +04:00
|
|
|
|
"""
|
2011-12-02 15:36:20 +04:00
|
|
|
|
src = get_url_attribute(element, 'src')
|
|
|
|
|
alt = element.get('alt')
|
2011-08-25 19:29:16 +04:00
|
|
|
|
if src:
|
2012-01-13 21:16:27 +04:00
|
|
|
|
image = document.get_image_from_uri(src)
|
2011-12-08 21:11:32 +04:00
|
|
|
|
if image is not None:
|
|
|
|
|
return [make_replaced_box(element, box, image)]
|
2011-08-26 00:16:04 +04:00
|
|
|
|
else:
|
2011-08-25 19:29:16 +04:00
|
|
|
|
# Invalid image, use the alt-text.
|
|
|
|
|
if alt:
|
2011-12-02 18:31:23 +04:00
|
|
|
|
return [make_text_box(element, box, alt)]
|
2011-08-25 19:29:16 +04:00
|
|
|
|
elif alt == '':
|
|
|
|
|
# The element represents nothing
|
2011-11-17 18:39:30 +04:00
|
|
|
|
return []
|
2011-08-25 19:29:16 +04:00
|
|
|
|
else:
|
|
|
|
|
assert alt is None
|
|
|
|
|
# TODO: find some indicator that an image is missing.
|
|
|
|
|
# For now, just remove the image.
|
2011-11-17 18:39:30 +04:00
|
|
|
|
return []
|
2011-08-25 19:29:16 +04:00
|
|
|
|
else:
|
|
|
|
|
if alt:
|
2011-12-02 18:31:23 +04:00
|
|
|
|
return [make_text_box(element, box, alt)]
|
2011-08-25 19:29:16 +04:00
|
|
|
|
else:
|
2011-11-17 18:39:30 +04:00
|
|
|
|
return []
|
2011-05-25 17:54:46 +04:00
|
|
|
|
|
|
|
|
|
|
2012-02-29 20:38:30 +04:00
|
|
|
|
@handler('embed')
|
|
|
|
|
def handle_embed(document, element, box):
|
|
|
|
|
"""Handle ``<embed>`` elements, return either an image or nothing.
|
|
|
|
|
|
|
|
|
|
See: http://www.w3.org/TR/html5/the-iframe-element.html#the-embed-element
|
|
|
|
|
|
|
|
|
|
"""
|
|
|
|
|
src = get_url_attribute(element, 'src')
|
|
|
|
|
type_ = element.get('type', '').strip()
|
|
|
|
|
if src:
|
|
|
|
|
image = document.get_image_from_uri(src, type_)
|
|
|
|
|
if image is not None:
|
|
|
|
|
return [make_replaced_box(element, box, image)]
|
|
|
|
|
# No fallback.
|
|
|
|
|
return []
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
@handler('object')
|
|
|
|
|
def handle_object(document, element, box):
|
|
|
|
|
"""Handle ``<object>`` elements, return either an image or the fallback
|
|
|
|
|
content.
|
|
|
|
|
|
|
|
|
|
See: http://www.w3.org/TR/html5/the-iframe-element.html#the-object-element
|
|
|
|
|
|
|
|
|
|
"""
|
|
|
|
|
data = get_url_attribute(element, 'data')
|
|
|
|
|
type_ = element.get('type', '').strip()
|
|
|
|
|
if data:
|
|
|
|
|
image = document.get_image_from_uri(data, type_)
|
|
|
|
|
if image is not None:
|
|
|
|
|
return [make_replaced_box(element, box, image)]
|
|
|
|
|
# The element’s children are the fallback.
|
|
|
|
|
return [box]
|
|
|
|
|
|
|
|
|
|
|
2011-12-02 15:36:20 +04:00
|
|
|
|
def integer_attribute(element, box, name, minimum=1):
|
2011-11-15 14:44:28 +04:00
|
|
|
|
"""Read an integer attribute from the HTML element and set it on the box.
|
|
|
|
|
|
|
|
|
|
"""
|
2011-12-02 15:36:20 +04:00
|
|
|
|
value = element.get(name, '').strip()
|
2012-02-29 20:38:30 +04:00
|
|
|
|
if value:
|
|
|
|
|
try:
|
|
|
|
|
value = int(value)
|
|
|
|
|
except ValueError:
|
|
|
|
|
pass
|
|
|
|
|
else:
|
|
|
|
|
if value >= minimum:
|
|
|
|
|
setattr(box, name, value)
|
2011-11-15 14:44:28 +04:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
@handler('colgroup')
|
2011-12-26 15:47:26 +04:00
|
|
|
|
def handle_colgroup(_document, element, box):
|
2011-11-15 14:44:28 +04:00
|
|
|
|
"""Handle the ``span`` attribute."""
|
|
|
|
|
if isinstance(box, boxes.TableColumnGroupBox):
|
2011-12-02 15:36:20 +04:00
|
|
|
|
if any(child.tag == 'col' for child in element):
|
2011-11-15 14:44:28 +04:00
|
|
|
|
box.span = None # sum of the children’s spans
|
|
|
|
|
else:
|
2011-12-02 15:36:20 +04:00
|
|
|
|
integer_attribute(element, box, 'span')
|
2012-02-29 20:38:30 +04:00
|
|
|
|
box.children = (
|
|
|
|
|
boxes.TableColumnBox.anonymous_from(box, [])
|
|
|
|
|
for _i in xrange(box.span))
|
2011-11-17 18:39:30 +04:00
|
|
|
|
return [box]
|
2011-11-15 14:44:28 +04:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
@handler('col')
|
2011-12-26 15:47:26 +04:00
|
|
|
|
def handle_col(_document, element, box):
|
2011-11-15 14:44:28 +04:00
|
|
|
|
"""Handle the ``span`` attribute."""
|
|
|
|
|
if isinstance(box, boxes.TableColumnBox):
|
2011-12-02 15:36:20 +04:00
|
|
|
|
integer_attribute(element, box, 'span')
|
2011-11-17 18:39:30 +04:00
|
|
|
|
if box.span > 1:
|
|
|
|
|
# Generate multiple boxes
|
|
|
|
|
# http://lists.w3.org/Archives/Public/www-style/2011Nov/0293.html
|
2011-12-26 15:47:26 +04:00
|
|
|
|
return [box.copy() for _i in xrange(box.span)]
|
2011-11-17 18:39:30 +04:00
|
|
|
|
return [box]
|
2011-11-15 14:44:28 +04:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
@handler('th')
|
|
|
|
|
@handler('td')
|
2011-12-26 15:47:26 +04:00
|
|
|
|
def handle_td(_document, element, box):
|
2011-11-15 14:44:28 +04:00
|
|
|
|
"""Handle the ``colspan``, ``rowspan`` attributes."""
|
|
|
|
|
if isinstance(box, boxes.TableCellBox):
|
|
|
|
|
# HTML 4.01 gives special meaning to colspan=0
|
|
|
|
|
# http://www.w3.org/TR/html401/struct/tables.html#adef-rowspan
|
|
|
|
|
# but HTML 5 removed it
|
|
|
|
|
# http://www.w3.org/TR/html5/tabular-data.html#attr-tdth-colspan
|
|
|
|
|
# rowspan=0 is still there though.
|
2011-12-02 15:36:20 +04:00
|
|
|
|
integer_attribute(element, box, 'colspan')
|
|
|
|
|
integer_attribute(element, box, 'rowspan', minimum=0)
|
2011-11-17 18:39:30 +04:00
|
|
|
|
return [box]
|