Fixes for markdown

Merge branch 'master' into 3540-html-to-plaintext-notifications
Email should always be formatted nicely
2025-11-10 03:27:14 +00:00 · 2025-10-25 18:14:07 +02:00 · 2025-10-25 17:51:33 +02:00 · 2025-10-25 17:15:02 +02:00 · 2025-10-25 17:07:16 +02:00 · 2025-10-25 16:51:55 +02:00
3 changed files with 118 additions and 21 deletions
--- a/changedetectionio/notification/email_helpers.py
+++ b/changedetectionio/notification/email_helpers.py
@@ -0,0 +1,42 @@
+def as_monospaced_html_email(content: str, title: str) -> str:
+    """
+    Wraps `content` in a minimal, email-safe HTML template
+    that forces monospace rendering across Gmail, Hotmail, Apple Mail, etc.
+
+    Args:
+        content: The body text (plain text or HTML-like).
+        title: The title plaintext
+    Returns:
+        A complete HTML document string suitable for sending as an email body.
+    """
+
+    # All line feed types should be removed and then this function should only be fed <br>'s
+    # Then it works with our <pre> styling without double linefeeds
+    content = content.translate(str.maketrans('', '', '\r\n'))
+
+    if title:
+        import html
+        title = html.escape(title)
+    else:
+        title = ''
+    # 2. Full email-safe HTML
+    html_email = f"""<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <meta name="x-apple-disable-message-reformatting">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <!--[if mso]>
+    <style>
+      body, div, pre, td {{ font-family: "Courier New", Courier, monospace !important; }}
+    </style>
+  <![endif]-->
+  <title>{title}</title>
+</head>
+<body style="-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%;">
+  <pre role="article" aria-roledescription="email" lang="en"
+       style="font-family: monospace, 'Courier New', Courier; font-size: 0.8em;
+              white-space: pre-wrap; word-break: break-word;">{content}</pre>
+</body>
+</html>"""
+    return html_email
--- a/changedetectionio/notification/handler.py
+++ b/changedetectionio/notification/handler.py
@@ -6,6 +6,7 @@ from loguru import logger
 from urllib.parse import urlparse
 from .apprise_plugin.assets import apprise_asset, APPRISE_AVATAR_URL
 from .apprise_plugin.custom_handlers import SUPPORTED_HTTP_METHODS
+from .email_helpers import as_monospaced_html_email
 from ..diff import HTML_REMOVED_STYLE, REMOVED_PLACEMARKER_OPEN, REMOVED_PLACEMARKER_CLOSED, ADDED_PLACEMARKER_OPEN, HTML_ADDED_STYLE, \
    ADDED_PLACEMARKER_CLOSED, CHANGED_INTO_PLACEMARKER_OPEN, CHANGED_INTO_PLACEMARKER_CLOSED, CHANGED_PLACEMARKER_OPEN, \
    CHANGED_PLACEMARKER_CLOSED, HTML_CHANGED_STYLE, HTML_CHANGED_INTO_STYLE
@@ -76,6 +77,55 @@ def notification_format_align_with_apprise(n_format : str):

    return n_format

+def apply_discord_markdown_to_body(n_body):
+    """
+    Discord does not support <del> but it supports non-standard ~~strikethrough~~
+    :param n_body:
+    :return:
+    """
+    import re
+    # Define the mapping between your placeholders and markdown markers
+    replacements = [
+        (REMOVED_PLACEMARKER_OPEN, '~~', REMOVED_PLACEMARKER_CLOSED, '~~'),
+        (ADDED_PLACEMARKER_OPEN, '**', ADDED_PLACEMARKER_CLOSED, '**'),
+        (CHANGED_PLACEMARKER_OPEN, '~~', CHANGED_PLACEMARKER_CLOSED, '~~'),
+        (CHANGED_INTO_PLACEMARKER_OPEN, '**', CHANGED_INTO_PLACEMARKER_CLOSED, '**'),
+    ]
+    # So that the markdown gets added without any whitespace following it which would break it
+    for open_tag, open_md, close_tag, close_md in replacements:
+        # Regex: match opening tag, optional whitespace, capture the content, optional whitespace, then closing tag
+        pattern = re.compile(
+            re.escape(open_tag) + r'(\s*)(.*?)?(\s*)' + re.escape(close_tag),
+            flags=re.DOTALL
+        )
+        n_body = pattern.sub(lambda m: f"{m.group(1)}{open_md}{m.group(2)}{close_md}{m.group(3)}", n_body)
+    return n_body
+
+def apply_standard_markdown_to_body(n_body):
+    """
+    Apprise does not support ~~strikethrough~~ but it will convert <del> to HTML strikethrough.
+    :param n_body:
+    :return:
+    """
+    import re
+    # Define the mapping between your placeholders and markdown markers
+    replacements = [
+        (REMOVED_PLACEMARKER_OPEN, '<del>', REMOVED_PLACEMARKER_CLOSED, '</del>'),
+        (ADDED_PLACEMARKER_OPEN, '**', ADDED_PLACEMARKER_CLOSED, '**'),
+        (CHANGED_PLACEMARKER_OPEN, '<del>', CHANGED_PLACEMARKER_CLOSED, '</del>'),
+        (CHANGED_INTO_PLACEMARKER_OPEN, '**', CHANGED_INTO_PLACEMARKER_CLOSED, '**'),
+    ]
+
+    # So that the markdown gets added without any whitespace following it which would break it
+    for open_tag, open_md, close_tag, close_md in replacements:
+        # Regex: match opening tag, optional whitespace, capture the content, optional whitespace, then closing tag
+        pattern = re.compile(
+            re.escape(open_tag) + r'(\s*)(.*?)?(\s*)' + re.escape(close_tag),
+            flags=re.DOTALL
+        )
+        n_body = pattern.sub(lambda m: f"{m.group(1)}{open_md}{m.group(2)}{close_md}{m.group(3)}", n_body)
+    return n_body
+

 def apply_service_tweaks(url, n_body, n_title, requested_output_format):

@@ -106,7 +156,7 @@ def apply_service_tweaks(url, n_body, n_title, requested_output_format):
        n_body = n_body.replace('<br>', '\n')
        n_body = n_body.replace('</br>', '\n')
        n_body = n_body.replace(CUSTOM_LINEBREAK_PLACEHOLDER, '\n')
-        
+
        # Use strikethrough for removed content, bold for added content
        n_body = n_body.replace(REMOVED_PLACEMARKER_OPEN, '<s>')
        n_body = n_body.replace(REMOVED_PLACEMARKER_CLOSED, '</s>')
@@ -140,15 +190,7 @@ def apply_service_tweaks(url, n_body, n_title, requested_output_format):
        if requested_output_format == 'html':
            # No diff placeholders, use Discord markdown for any other formatting
            # Use Discord markdown: strikethrough for removed, bold for added
-            n_body = n_body.replace(REMOVED_PLACEMARKER_OPEN, '~~')
-            n_body = n_body.replace(REMOVED_PLACEMARKER_CLOSED, '~~')
-            n_body = n_body.replace(ADDED_PLACEMARKER_OPEN, '**')
-            n_body = n_body.replace(ADDED_PLACEMARKER_CLOSED, '**')
-            # Handle changed/replaced lines (old → new)
-            n_body = n_body.replace(CHANGED_PLACEMARKER_OPEN, '~~')
-            n_body = n_body.replace(CHANGED_PLACEMARKER_CLOSED, '~~')
-            n_body = n_body.replace(CHANGED_INTO_PLACEMARKER_OPEN, '**')
-            n_body = n_body.replace(CHANGED_INTO_PLACEMARKER_CLOSED, '**')
+            n_body = apply_discord_markdown_to_body(n_body=n_body)

            # Apply 2000 char limit for plain content
            payload_max_size = 1700
@@ -180,6 +222,9 @@ def apply_service_tweaks(url, n_body, n_title, requested_output_format):
        n_body = n_body.replace(CHANGED_INTO_PLACEMARKER_OPEN, f'(into) ')
        n_body = n_body.replace(CHANGED_INTO_PLACEMARKER_CLOSED, f'')
        n_body = n_body.replace('\n', f'{CUSTOM_LINEBREAK_PLACEHOLDER}\n')
+    elif requested_output_format == 'markdown':
+        # Markdown to HTML - Apprise will convert this to HTML
+        n_body = apply_standard_markdown_to_body(n_body=n_body)

    else: #plaintext etc default
        n_body = n_body.replace(REMOVED_PLACEMARKER_OPEN, '(removed) ')
@@ -300,17 +345,20 @@ def process_notification(n_object: NotificationContextData, datastore):
                    apprise_input_format = NotifyFormat.TEXT.value

                elif requested_output_format == NotifyFormat.MARKDOWN.value:
-                    # This actually means we request "Markdown to HTML", we want HTML output
+                    # Convert markdown to HTML ourselves since not all plugins do this
+                    from apprise.conversion import markdown_to_html
+                    # Make sure there are paragraph breaks around horizontal rules
+                    n_body = n_body.replace('---', '\n\n---\n\n')
+                    n_body = markdown_to_html(n_body)
                    url = f"{url}{prefix_add_to_url}format={NotifyFormat.HTML.value}"
                    requested_output_format = NotifyFormat.HTML.value
-                    apprise_input_format = NotifyFormat.MARKDOWN.value
-
+                    apprise_input_format = NotifyFormat.HTML.value  # Changed from MARKDOWN to HTML

                # Could have arrived at any stage, so we dont end up running .escape on it
                if 'html' in requested_output_format:
-                    n_body = n_body.replace(CUSTOM_LINEBREAK_PLACEHOLDER, '<br>\n')
+                    n_body = n_body.replace(CUSTOM_LINEBREAK_PLACEHOLDER, '<br>\r\n')
                else:
-                    # Markup, text types etc
+                    # texty types
                    n_body = n_body.replace(CUSTOM_LINEBREAK_PLACEHOLDER, '\r\n')

            sent_objs.append({'title': n_title,
@@ -318,6 +366,12 @@ def process_notification(n_object: NotificationContextData, datastore):
                              'url': url})
            apobj.add(url)

+            # Since the output is always based on the plaintext of the 'diff' engine, wrap it nicely.
+            # It should always be similar to the 'history' part of the UI.
+            if url.startswith('mail') and 'html' in requested_output_format:
+                if not '<pre' in n_body and not '<body' in n_body: # No custom HTML-ish body was setup already
+                    n_body = as_monospaced_html_email(content=n_body, title=n_title)
+
        apobj.notify(
            title=n_title,
            body=n_body,
--- a/changedetectionio/tests/smtp/test_notification_smtp.py
+++ b/changedetectionio/tests/smtp/test_notification_smtp.py
@@ -290,7 +290,8 @@ def test_check_notification_markdown_format(client, live_server, measure_memory_
    text_part = parts[0]
    assert text_part.get_content_type() == 'text/plain'
    text_content = text_part.get_content()
-    assert '(added) So let\'s see what happens.\r\n' in text_content  # The plaintext part
+    # We wont see anything in the "FALLBACK" text but that's OK (no added/strikethrough etc)
+    assert 'So let\'s see what happens.\r\n' in text_content  # The plaintext part


    # Second part should be text/html and roughly converted from markdown to HTML
@@ -298,7 +299,7 @@ def test_check_notification_markdown_format(client, live_server, measure_memory_
    assert html_part.get_content_type() == 'text/html'
    html_content = html_part.get_content()
    assert '<p><em>header</em></p>' in html_content
-    assert '(added) So let\'s see what happens.<br' in html_content
+    assert '<strong>So let\'s see what happens.</strong><br>' in html_content # Additions are <strong> in markdown
    delete_all_watches(client)

 # Custom notification body with HTML, that is either sent as HTML or rendered to plaintext and sent
@@ -470,7 +471,7 @@ def test_check_plaintext_document_plaintext_notification_smtp(client, live_serve
    assert '(added)' in body
    assert '<br' not in body
    assert '&lt;' not in body
-
+    assert '<pre' not in body
    delete_all_watches(client)

 def test_check_plaintext_document_html_notifications(client, live_server, measure_memory_usage):
@@ -541,13 +542,13 @@ def test_check_plaintext_document_html_notifications(client, live_server, measur
    assert 'talk about &lt;title&gt;' in html_content
    # Should be the HTML, but not HTML Color
    assert 'background-color' not in html_content
-    assert '<br>\r\n(added) And let&#39;s talk about &lt;title&gt; tags<br>' in html_content
+    assert '<br>(added) And let&#39;s talk about &lt;title&gt; tags<br>' in html_content
    assert '&lt;br' not in html_content
+    assert '<pre role="article"' in html_content # Should have got wrapped nicely in email_helpers.py

    # And now for the whitespace retention
    assert '&nbsp;&nbsp;&nbsp;&nbsp;Some nice plain text' in html_content
    assert '(added) And let' in html_content # just to show a single whitespace didnt get touched
-
    delete_all_watches(client)


@@ -620,7 +621,7 @@ def test_check_plaintext_document_html_color_notifications(client, live_server,
    assert '(added) And let' not in html_content
    assert '&lt;br' not in html_content
    assert '<br>' in html_content
-
+    assert '<pre role="article"' in html_content # Should have got wrapped nicely in email_helpers.py
    delete_all_watches(client)

 def test_check_html_document_plaintext_notification(client, live_server, measure_memory_usage):
Author	SHA1	Message	Date
dgtlmoon	e520083d15	Fixes for markdown	2025-10-25 18:14:07 +02:00
dgtlmoon	37a896f30d	Merge branch 'master' into 3540-html-to-plaintext-notifications	2025-10-25 17:51:33 +02:00
dgtlmoon	7e8d8d3c04	Email should always be formatted nicely	2025-10-25 17:15:02 +02:00
dgtlmoon	7168bad921	Merge branch 'master' into 3540-html-to-plaintext-notifications	2025-10-25 17:07:16 +02:00
dgtlmoon	b5630dc39b	Only for mailto	2025-10-25 16:51:55 +02:00
dgtlmoon	9b2d8281bf	Remove whitespace	2025-10-25 16:23:33 +02:00
dgtlmoon	798c778636	Fix comment	2025-10-25 16:23:12 +02:00
dgtlmoon	fad1b4163c	Adjust test	2025-10-25 16:17:46 +02:00
dgtlmoon	283151ad0c	Merge branch 'master' into 3540-html-to-plaintext-notifications	2025-10-25 16:04:24 +02:00
dgtlmoon	2ea6ca6cf6	PRE wrap plaintext watches in HTML output	2025-10-25 16:04:03 +02:00
dgtlmoon	d0c825786e	Fix to plaintext notifications and more tests #3540	2025-10-25 15:24:41 +02:00