1
def __str__(self):
return self.title
@@ -294,6 +298,14 @@ def __str__(self):
class Meta(BaseModel.Meta):
verbose_name_plural = "Entries"
+ @property
+ def rendered(self):
+ if self.use_markdown:
+ rendered = markdown(self.body or "")
+ else:
+ rendered = self.body or ""
+ return mark_safe(rendered)
+
class LiveUpdate(models.Model):
created = models.DateTimeField(auto_now_add=True)
diff --git a/blog/templatetags/entry_tags.py b/blog/templatetags/entry_tags.py
index a7b1c1b2..b560b59b 100644
--- a/blog/templatetags/entry_tags.py
+++ b/blog/templatetags/entry_tags.py
@@ -1,14 +1,11 @@
from django import template
from django.utils.html import conditional_escape
from django.utils.safestring import mark_safe
-from xml.etree import ElementTree
+from bs4 import BeautifulSoup, NavigableString, Comment
import re
import datetime
register = template.Library()
-entry_stripper = re.compile("^(.*?)$", re.DOTALL)
-
-
@register.filter
def xhtml(xhtml):
return XhtmlString(xhtml, contains_markup=True)
@@ -17,32 +14,38 @@ def xhtml(xhtml):
class XhtmlString(object):
def __init__(self, value, contains_markup=False):
if isinstance(value, XhtmlString):
- self.et = value.et
+ self.soup = value.soup
else:
+ if value is None:
+ value = ""
if not contains_markup:
# Handle strings like "this & that"
value = conditional_escape(value)
- self.et = ElementTree.fromstring("%s" % value)
+ self.soup = BeautifulSoup(f"{value}", "html.parser")
+ self.et = self.soup.find("entry")
def __str__(self):
- m = entry_stripper.match(ElementTree.tostring(self.et, "unicode"))
- if m:
- return mark_safe(m.group(1))
- else:
- return "" # If we end up with
+ if not self.et:
+ return ""
+ return mark_safe("".join(str(content) for content in self.et.contents))
@register.filter
def resize_images_to_fit_width(value, arg):
max_width = int(arg)
x = XhtmlString(value)
- for img in x.et.findall(".//img"):
- width = int(img.get("width", 0))
- height = int(img.get("height", 0))
- if width > max_width:
+ if not x.et:
+ return x
+ for img in x.et.find_all("img"):
+ try:
+ width = int(img.get("width", 0))
+ height = int(img.get("height", 0))
+ except (TypeError, ValueError):
+ continue
+ if width > max_width and height:
# Scale down
- img.set("width", str(max_width))
- img.set("height", str(int(float(max_width) / width * height)))
+ img["width"] = str(max_width)
+ img["height"] = str(int(float(max_width) / width * height))
return x
@@ -64,23 +67,27 @@ def split_cutoff(xhtml):
@register.filter
def remove_context_paragraph(xhtml):
x = XhtmlString(xhtml)
+ if not x.et:
+ return x
p = x.et.find("p")
if p is None:
return x
- xhtml = ElementTree.tostring(p, "unicode")
+ xhtml = str(p)
if xhtml.startswith("My answer to") or xhtml.startswith(
''
):
- x.et.remove(p)
+ p.decompose()
return x
@register.filter
def first_paragraph(xhtml):
x = XhtmlString(xhtml)
+ if not x.et:
+ return mark_safe("
%s
" % xhtml)
p = x.et.find("p")
if p is not None:
- return mark_safe(ElementTree.tostring(p, "unicode"))
+ return mark_safe(str(p))
else:
return mark_safe("%s
" % xhtml)
@@ -104,9 +111,11 @@ def ends_with_punctuation(value):
@register.filter
def strip_p_ids(xhtml):
x = XhtmlString(xhtml)
- for p in x.et.findall(".//p"):
- if "id" in p.attrib:
- del p.attrib["id"]
+ if not x.et:
+ return x
+ for p in x.et.find_all("p"):
+ if "id" in p.attrs:
+ del p.attrs["id"]
return x
@@ -120,18 +129,26 @@ def break_up_long_words(xhtml, length):
def do_break_long_words(et, length):
- """Pass an ElementTree instance; breaks up long words in it"""
- if et.text:
- et.text = do_break_long_words_string(et.text, length)
- for child in et:
- do_break_long_words(child, length)
- if et.tail:
- et.tail = do_break_long_words_string(et.tail, length)
+ """Pass a BeautifulSoup Tag instance; breaks up long words in it"""
+ if et is None:
+ return
+ for node in list(_iter_text_nodes(et)):
+ new_text = do_break_long_words_string(str(node), length)
+ if new_text != str(node):
+ node.replace_with(new_text)
whitespace_re = re.compile(r"(\s+)")
+def _iter_text_nodes(tag):
+ if tag is None:
+ return []
+ for node in tag.descendants:
+ if isinstance(node, NavigableString) and not isinstance(node, Comment):
+ yield node
+
+
def do_break_long_words_string(s, length):
bits = whitespace_re.split(s)
for i, bit in enumerate(bits):
@@ -167,15 +184,15 @@ def strip_wrapping_p(xhtml):
def do_typography(et):
- # Designed to be called recursively on ElementTree objects
- if et.tag not in ("pre", "code"):
- # Don't do et.text or children for those tags; just do et.tail
- if et.text:
- et.text = do_typography_string(et.text)
- for child in et:
- do_typography(child)
- if et.tail:
- et.tail = do_typography_string(et.tail)
+ if et is None:
+ return
+ for node in list(_iter_text_nodes(et)):
+ parent = node.parent
+ if parent and parent.name in ("pre", "code"):
+ continue
+ new_text = do_typography_string(str(node))
+ if new_text != str(node):
+ node.replace_with(new_text)
LEFT_DOUBLE_QUOTATION_MARK = "\u201c"
diff --git a/blog/tests.py b/blog/tests.py
index 8425ed78..7f85ff77 100644
--- a/blog/tests.py
+++ b/blog/tests.py
@@ -113,6 +113,49 @@ def test_markup(self):
""".strip(),
)
+ def test_markdown_entry_renders_everywhere(self):
+ tag = Tag.objects.create(tag="markdown-test")
+ entry = EntryFactory(
+ title="Markdown Entry",
+ body="This is **markdown** text.",
+ use_markdown=True,
+ )
+ entry.tags.add(tag)
+
+ year = entry.created.year
+ month = entry.created.strftime("%b")
+ day = entry.created.day
+
+ paths = {
+ "/": True,
+ f"/{year}/": False,
+ f"/{year}/{month}/": True,
+ f"/{year}/{month}/{day}/": True,
+ entry.get_absolute_url(): True,
+ f"/tags/{tag.tag}/": True,
+ f"/search/?tag={tag.tag}": True,
+ }
+
+ for path, should_have_markup in paths.items():
+ response = self.client.get(path)
+ self.assertEqual(response.status_code, 200, msg=path)
+ if should_have_markup and "markdown" not in response.content.decode():
+ self.fail(f"{path} missing rendered markdown")
+
+ entries_feed = self.client.get("/atom/entries/")
+ self.assertEqual(entries_feed.status_code, 200)
+ self.assertIn(
+ "<strong>markdown</strong>",
+ entries_feed.content.decode(),
+ )
+
+ everything_feed = self.client.get("/atom/everything/")
+ self.assertEqual(everything_feed.status_code, 200)
+ self.assertIn(
+ "<strong>markdown</strong>",
+ everything_feed.content.decode(),
+ )
+
def test_update_blogmark_runs_commit_hooks(self):
# This was throwing errors on upgrade Django 2.2 to 2.2.1
blogmark = BlogmarkFactory()
diff --git a/templates/entry.html b/templates/entry.html
index 99010d2a..b76622d9 100644
--- a/templates/entry.html
+++ b/templates/entry.html
@@ -9,7 +9,7 @@
{% endblock %}
{% block card_title %}{{ entry.title|typography }}{% endblock %}
-{% block card_description %}{{ entry.body|xhtml|remove_context_paragraph|typography|xhtml2html|striptags|truncatewords:30|force_escape }}{% endblock %}
+{% block card_description %}{{ entry.rendered|xhtml|remove_context_paragraph|typography|xhtml2html|striptags|truncatewords:30|force_escape }}{% endblock %}
{% block item_content %}
@@ -18,7 +18,7 @@
{{ entry.title|typography }}
{% include "_draft_warning.html" %}
-{{ entry.body|xhtml|resize_images_to_fit_width:"450"|typography|xhtml2html }}
+{{ entry.rendered|xhtml|resize_images_to_fit_width:"450"|typography|xhtml2html }}
{% if updates %}
diff --git a/templates/feeds/everything.html b/templates/feeds/everything.html
index d55465e8..918e5ff2 100644
--- a/templates/feeds/everything.html
+++ b/templates/feeds/everything.html
@@ -1,5 +1,5 @@
{% if obj.is_entry %}
- {{ obj.body|safe }}
+ {{ obj.rendered|safe }}
{% if obj.tags.count %}
Tags: {% for tag in obj.tags.all %}{{ tag.tag }}{% if not forloop.last %}, {% endif %}{% endfor %}
{% endif %}
diff --git a/templates/includes/blog_mixed_list.html b/templates/includes/blog_mixed_list.html
index 5563a8db..98a04b83 100644
--- a/templates/includes/blog_mixed_list.html
+++ b/templates/includes/blog_mixed_list.html
@@ -20,7 +20,7 @@
{% endif %}
- {{ item.obj.body|split_cutoff|xhtml|remove_context_paragraph|first_paragraph|typography|xhtml2html }}
+ {{ item.obj.rendered|split_cutoff|xhtml|remove_context_paragraph|first_paragraph|typography|xhtml2html }}
{% if item.obj.multi_paragraph %}[... {{ item.obj.body|wordcount|intcomma }} word{{ item.obj.body|wordcount|pluralize }}]{% endif %}