Sanitizer: a newsletter's <title> showed as a line above the body
<title> is not an allowed tag, so nh3 unwrapped it and kept its text — "mailer", "Email template" or the subject rendered before the content. It is now dropped with its content, both in the sanitized HTML and in the text derived from HTML-only mail (snippet and search). SANITIZER_VERSION goes to 4 so stored bodies re-sanitize from the raw blob on next render. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
@@ -83,7 +83,14 @@ def _addresses(msg: EmailMessage, header: str) -> list[dict[str, str]]:
|
|||||||
|
|
||||||
def _html_to_text(html: str) -> str:
|
def _html_to_text(html: str) -> str:
|
||||||
"""Derive plain text from HTML by stripping all tags (SPEC §6.4 nh3 strip)."""
|
"""Derive plain text from HTML by stripping all tags (SPEC §6.4 nh3 strip)."""
|
||||||
return nh3.clean(html, tags=set(), attributes={}, strip_comments=True)
|
return nh3.clean(
|
||||||
|
html,
|
||||||
|
tags=set(),
|
||||||
|
attributes={},
|
||||||
|
strip_comments=True,
|
||||||
|
# The document <title> is not body text; unwrapped it would lead the snippet.
|
||||||
|
clean_content_tags={"script", "style", "title"},
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def _get_body_content(msg: EmailMessage, subtype: str) -> str | None:
|
def _get_body_content(msg: EmailMessage, subtype: str) -> str | None:
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ import nh3
|
|||||||
|
|
||||||
# Bump when the sanitization policy changes; body_parts.sanitizer_v records it so a
|
# Bump when the sanitization policy changes; body_parts.sanitizer_v records it so a
|
||||||
# render re-sanitizes stale content from the raw blob (SPEC §10.4).
|
# render re-sanitizes stale content from the raw blob (SPEC §10.4).
|
||||||
SANITIZER_VERSION = 3
|
SANITIZER_VERSION = 4
|
||||||
|
|
||||||
_ALLOWED_TAGS: set[str] = {
|
_ALLOWED_TAGS: set[str] = {
|
||||||
# structure
|
# structure
|
||||||
@@ -218,8 +218,10 @@ def sanitize_html(
|
|||||||
link_rel="noopener noreferrer nofollow",
|
link_rel="noopener noreferrer nofollow",
|
||||||
strip_comments=True,
|
strip_comments=True,
|
||||||
# nh3 strips <script>/<style> *content* by default; we allow <style> (above)
|
# nh3 strips <script>/<style> *content* by default; we allow <style> (above)
|
||||||
# and sanitize its CSS ourselves, so only script content is stripped here.
|
# and sanitize its CSS ourselves, so its content stays. <title> is dropped
|
||||||
clean_content_tags={"script"},
|
# with its text: as a disallowed tag nh3 would unwrap it, and the document
|
||||||
|
# title ("mailer", the subject) would render as a line above the body.
|
||||||
|
clean_content_tags={"script", "title"},
|
||||||
attribute_filter=attribute_filter,
|
attribute_filter=attribute_filter,
|
||||||
)
|
)
|
||||||
cleaned = _sanitize_style_elements(cleaned, allow_remote_images, state)
|
cleaned = _sanitize_style_elements(cleaned, allow_remote_images, state)
|
||||||
|
|||||||
@@ -75,6 +75,13 @@ def test_html_only_derives_text() -> None:
|
|||||||
assert "<b>" not in parsed.text_body # tags stripped for indexing text
|
assert "<b>" not in parsed.text_body # tags stripped for indexing text
|
||||||
|
|
||||||
|
|
||||||
|
def test_html_only_text_skips_document_title() -> None:
|
||||||
|
parsed = parse_message(
|
||||||
|
_build(text=None, html="<html><head><title>mailer</title></head><p>Hello</p></html>")
|
||||||
|
)
|
||||||
|
assert parsed.snippet == "Hello"
|
||||||
|
|
||||||
|
|
||||||
def test_multipart_alternative_prefers_html_for_display() -> None:
|
def test_multipart_alternative_prefers_html_for_display() -> None:
|
||||||
parsed = parse_message(_build(text="text version", html="<p>html version</p>"))
|
parsed = parse_message(_build(text="text version", html="<p>html version</p>"))
|
||||||
assert parsed.html_body is not None
|
assert parsed.html_body is not None
|
||||||
|
|||||||
@@ -17,6 +17,19 @@ def test_scripts_and_handlers_are_removed() -> None:
|
|||||||
assert "hi" in result.html
|
assert "hi" in result.html
|
||||||
|
|
||||||
|
|
||||||
|
def test_document_title_is_not_rendered() -> None:
|
||||||
|
# Newsletters put "mailer" or the subject in <title>; unwrapping the tag would
|
||||||
|
# show it as a stray line above the body. Hidden preheaders keep their style.
|
||||||
|
html = (
|
||||||
|
"<html><head><title>mailer</title></head><body>"
|
||||||
|
'<span style="display:none">preview</span><p>Hi</p></body></html>'
|
||||||
|
)
|
||||||
|
result = sanitize_html(html, MID)
|
||||||
|
assert "mailer" not in result.html
|
||||||
|
assert '<span style="display:none">preview</span>' in result.html
|
||||||
|
assert "<p>Hi</p>" in result.html
|
||||||
|
|
||||||
|
|
||||||
def test_remote_image_is_blocked_and_flagged() -> None:
|
def test_remote_image_is_blocked_and_flagged() -> None:
|
||||||
html = '<p>see <img src="http://tracker.example/pixel.gif"> this</p>'
|
html = '<p>see <img src="http://tracker.example/pixel.gif"> this</p>'
|
||||||
result = sanitize_html(html, MID)
|
result = sanitize_html(html, MID)
|
||||||
|
|||||||
Reference in New Issue
Block a user