buildmimetree.py: provide a default visitor_fn (debug)

[etc/neomutt.git] / .config / neomutt / buildmimetree.py

diff --git a/.config/neomutt/buildmimetree.py b/.config/neomutt/buildmimetree.py
index f805884cf5048b5cc6234995b0b4d80713023677..4ab7a5488055c624baee9b91f8ba8fd63b664fa6 100755 (executable)
--- a/.config/neomutt/buildmimetree.py
+++ b/.config/neomutt/buildmimetree.py
@@ -23,8 +23,8 @@
 #   - python3-markdown
 # Optional:
 #   - pytest
 #   - python3-markdown
 # Optional:
 #   - pytest

-#   - Pynliner
-#   - Pygments, if installed, then syntax highlighting is enabled
+#   - Pynliner, provides --css-file and thus inline styling of HTML output
+#   - Pygments, then syntax highlighting for fenced code is enabled

 #
 # Latest version:
 #   https://git.madduck.net/etc/neomutt.git/blob_plain/HEAD:/.config/neomutt/buildmimetree.py
 #
 # Latest version:
 #   https://git.madduck.net/etc/neomutt.git/blob_plain/HEAD:/.config/neomutt/buildmimetree.py


@@ -55,7 +55,7 @@ def parse_cli_args(*args, **kwargs):
         )
     )
     parser.epilog = (
         )
     )
     parser.epilog = (

-        "Copyright © 2022 martin f. krafft <madduck@madduck.net>.\n"
+        "Copyright © 2023 martin f. krafft <madduck@madduck.net>.\n"

         "Released under the MIT licence"
     )
 
         "Released under the MIT licence"
     )
 


@@ -63,9 +63,19 @@ def parse_cli_args(*args, **kwargs):
         "--extensions",
         type=str,
         default="",
         "--extensions",
         type=str,
         default="",

-        help="Markdown extension to use (comma-separated list)"
+        help="Markdown extension to use (comma-separated list)",

     )
 
     )
 

+    if _PYNLINER:
+        parser.add_argument(
+            "--css-file",
+            type=str,
+            default="",
+            help="CSS file to merge with the final HTML",
+        )
+    else:
+        parser.set_defaults(css_file=None)
+

     parser.add_argument(
         "--only-build",
         action="store_true",
     parser.add_argument(
         "--only-build",
         action="store_true",


@@ -85,12 +95,16 @@ def parse_cli_args(*args, **kwargs):
     )
 
     subp = parser.add_subparsers(help="Sub-command parsers", dest="mode")
     )
 
     subp = parser.add_subparsers(help="Sub-command parsers", dest="mode")

-    massage_p = subp.add_parser("massage", help="Massaging phase (internal use)")
+    massage_p = subp.add_parser(
+        "massage", help="Massaging phase (internal use)"
+    )

 
     massage_p.add_argument(
         "--write-commands-to",
 
     massage_p.add_argument(
         "--write-commands-to",

+        "-o",

         metavar="PATH",
         dest="cmdpath",
         metavar="PATH",
         dest="cmdpath",

+        required=True,

         help="Temporary file path to write commands to",
     )
 
         help="Temporary file path to write commands to",
     )
 


@@ -158,11 +172,15 @@ class InlineImageExtension(Extension):
         return self._images
 
 
         return self._images
 
 

-def markdown_with_inline_image_support(text, *, extensions=None):
+def markdown_with_inline_image_support(
+    text, *, extensions=None, extension_configs=None
+):

     inline_image_handler = InlineImageExtension()
     extensions = extensions or []
     extensions.append(inline_image_handler)
     inline_image_handler = InlineImageExtension()
     extensions = extensions or []
     extensions.append(inline_image_handler)

-    mdwn = markdown.Markdown(extensions=extensions)
+    mdwn = markdown.Markdown(
+        extensions=extensions, extension_configs=extension_configs
+    )

     htmltext = mdwn.convert(text)
 
     images = inline_image_handler.get_images()
     htmltext = mdwn.convert(text)
 
     images = inline_image_handler.get_images()


@@ -177,6 +195,38 @@ def markdown_with_inline_image_support(text, *, extensions=None):
     return text, htmltext, images
 
 
     return text, htmltext, images
 
 

+# [ CSS STYLING ] #############################################################
+
+try:
+    import pynliner
+
+    _PYNLINER = True
+
+except ImportError:
+    _PYNLINER = False
+
+try:
+    from pygments.formatters import get_formatter_by_name
+
+    _CODEHILITE_CLASS = "codehilite"
+
+    _PYGMENTS_CSS = get_formatter_by_name(
+        "html", style="default"
+    ).get_style_defs(f".{_CODEHILITE_CLASS}")
+
+except ImportError:
+    _PYGMENTS_CSS = None
+
+
+def apply_styling(html, css):
+    return (
+        pynliner.Pynliner()
+        .from_string(html)
+        .with_cssString("\n".join(s for s in [_PYGMENTS_CSS, css] if s))
+        .run()
+    )
+
+

 # [ PARTS GENERATION ] ########################################################
 
 
 # [ PARTS GENERATION ] ########################################################
 
 


@@ -202,6 +252,9 @@ class Multipart(
     def __str__(self):
         return f"<multipart/{self.subtype}> children={len(self.children)}"
 
     def __str__(self):
         return f"<multipart/{self.subtype}> children={len(self.children)}"
 

+    def __hash__(self):
+        return hash(str(self.subtype) + "".join(str(self.children)))
+

 
 def filewriter_fn(path, content, mode="w", **kwargs):
     with open(path, mode, **kwargs) as out_f:
 
 def filewriter_fn(path, content, mode="w", **kwargs):
     with open(path, mode, **kwargs) as out_f:


@@ -213,6 +266,9 @@ def collect_inline_images(
 ):
     relparts = []
     for path, info in images.items():
 ):
     relparts = []
     for path, info in images.items():

+        if path.startswith("cid:"):
+            continue
+

         data = request.urlopen(path)
 
         mimetype = data.headers["Content-Type"]
         data = request.urlopen(path)
 
         mimetype = data.headers["Content-Type"]


@@ -223,7 +279,12 @@ def collect_inline_images(
         filewriter_fn(path, data.read(), "w+b")
 
         relparts.append(
         filewriter_fn(path, data.read(), "w+b")
 
         relparts.append(

-            Part(*mimetype.split("/"), path, cid=info.cid, desc=f"Image: {info.desc}")
+            Part(
+                *mimetype.split("/"),
+                path,
+                cid=info.cid,
+                desc=f"Image: {info.desc}",
+            )

         )
 
     return relparts
         )
 
     return relparts


@@ -233,12 +294,19 @@ def convert_markdown_to_html(
     origtext,
     draftpath,
     *,
     origtext,
     draftpath,
     *,

+    cssfile=None,

     filewriter_fn=filewriter_fn,
     tempdir=None,
     extensions=None,
     filewriter_fn=filewriter_fn,
     tempdir=None,
     extensions=None,

+    extension_configs=None,

 ):
 ):

+    # TODO extension_configs need to be handled differently
+    extension_configs = extension_configs or {}
+    extension_configs.setdefault("pymdownx.highlight", {})
+    extension_configs["pymdownx.highlight"]["css_class"] = _CODEHILITE_CLASS
+

     origtext, htmltext, images = markdown_with_inline_image_support(
     origtext, htmltext, images = markdown_with_inline_image_support(

-        origtext, extensions=extensions
+        origtext, extensions=extensions, extension_configs=extension_configs

     )
 
     filewriter_fn(draftpath, origtext, encoding="utf-8")
     )
 
     filewriter_fn(draftpath, origtext, encoding="utf-8")


@@ -246,6 +314,8 @@ def convert_markdown_to_html(
         "text", "plain", draftpath, "Plain-text version", orig=True
     )
 
         "text", "plain", draftpath, "Plain-text version", orig=True
     )
 

+    htmltext = apply_styling(htmltext, cssfile)
+

     htmlpath = draftpath.with_suffix(".html")
     filewriter_fn(
         htmlpath, htmltext, encoding="utf-8", errors="xmlcharrefreplace"
     htmlpath = draftpath.with_suffix(".html")
     filewriter_fn(
         htmlpath, htmltext, encoding="utf-8", errors="xmlcharrefreplace"


@@ -269,9 +339,12 @@ def convert_markdown_to_html(
 
 class MIMETreeDFWalker:
     def __init__(self, *, visitor_fn=None, debug=False):
 
 class MIMETreeDFWalker:
     def __init__(self, *, visitor_fn=None, debug=False):

-        self._visitor_fn = visitor_fn
+        self._visitor_fn = visitor_fn or self._echovisit

         self._debug = debug
 
         self._debug = debug
 

+    def _echovisit(self, node, ancestry, debugprint):
+        debugprint(f"node={node} ancestry={ancestry}")
+

     def walk(self, root, *, visitor_fn=None):
         """
         Recursive function to implement a depth-dirst walk of the MIME-tree
     def walk(self, root, *, visitor_fn=None):
         """
         Recursive function to implement a depth-dirst walk of the MIME-tree


@@ -401,6 +474,7 @@ def do_massage(
     cmd_f,
     *,
     extensions=None,
     cmd_f,
     *,
     extensions=None,

+    cssfile=None,

     converter=convert_markdown_to_html,
     only_build=False,
     tempdir=None,
     converter=convert_markdown_to_html,
     only_build=False,
     tempdir=None,


@@ -426,7 +500,13 @@ def do_massage(
     cmds.flush()
 
     extensions = extensions.split(",") if extensions else []
     cmds.flush()
 
     extensions = extensions.split(",") if extensions else []

-    tree = converter(draft_f.read(), draftpath, tempdir=tempdir, extensions=extensions)
+    tree = converter(
+        draft_f.read(),
+        draftpath,
+        cssfile=cssfile,
+        tempdir=tempdir,
+        extensions=extensions,
+    )

 
     mimetree = MIMETreeDFWalker(debug=debug_walk)
 
 
     mimetree = MIMETreeDFWalker(debug=debug_walk)
 


@@ -436,7 +516,7 @@ def do_massage(
         depth-first, and responsible for telling NeoMutt how to assemble
         the tree.
         """
         depth-first, and responsible for telling NeoMutt how to assemble
         the tree.
         """

-        KILL_LINE=r'\Ca\Ck'
+        KILL_LINE = r"\Ca\Ck"

 
         if isinstance(item, Part):
             # We've hit a leaf-node, i.e. an alternative or a related part
 
         if isinstance(item, Part):
             # We've hit a leaf-node, i.e. an alternative or a related part


@@ -527,6 +607,7 @@ if __name__ == "__main__":
                 pathlib.Path(args.MAILDRAFT),
                 cmd_f,
                 extensions=args.extensions,
                 pathlib.Path(args.MAILDRAFT),
                 cmd_f,
                 extensions=args.extensions,

+                cssfile=args.css_file,

                 only_build=args.only_build,
                 tempdir=args.tempdir,
                 debug_commands=args.debug_commands,
                 only_build=args.only_build,
                 tempdir=args.tempdir,
                 debug_commands=args.debug_commands,


@@ -669,7 +750,7 @@ try:
             return StringIO(text or const1)
 
         def test_do_massage_basic(self, const1, string_io, capsys):
             return StringIO(text or const1)
 
         def test_do_massage_basic(self, const1, string_io, capsys):

-            def converter(drafttext, draftpath, extensions, tempdir):
+            def converter(drafttext, draftpath, cssfile, extensions, tempdir):

                 return Part("text", "plain", draftpath, orig=True)
 
             do_massage(
                 return Part("text", "plain", draftpath, orig=True)
 
             do_massage(


@@ -693,7 +774,7 @@ try:
         def test_do_massage_fulltree(
             self, string_io, const1, basic_mime_tree, capsys
         ):
         def test_do_massage_fulltree(
             self, string_io, const1, basic_mime_tree, capsys
         ):

-            def converter(drafttext, draftpath, extensions, tempdir):
+            def converter(drafttext, draftpath, cssfile, extensions, tempdir):

                 return basic_mime_tree
 
             do_massage(
                 return basic_mime_tree
 
             do_massage(


@@ -873,6 +954,23 @@ try:
             assert tree.children[1].path == written[0]
             assert written[1] == request.urlopen(test_png).read()
 
             assert tree.children[1].path == written[0]
             assert written[1] == request.urlopen(test_png).read()
 

+        def test_converter_tree_inline_image_cid(
+            self, const1, fake_filewriter
+        ):
+            text = f"![inline base64 image](cid:{const1})"
+            path = pathlib.Path(const1)
+            tree = convert_markdown_to_html(
+                text,
+                path,
+                filewriter_fn=fake_filewriter,
+                related_to_html_only=False,
+            )
+            assert len(tree.children) == 2
+            assert tree.children[0].cid != const1
+            assert tree.children[0].type != "image"
+            assert tree.children[1].cid != const1
+            assert tree.children[1].type != "image"
+

         def test_inline_image_collection(
             self, test_png, const1, const2, fake_filewriter
         ):
         def test_inline_image_collection(
             self, test_png, const1, const2, fake_filewriter
         ):


@@ -889,5 +987,22 @@ try:
             assert relparts[0].cid == const1
             assert relparts[0].desc.endswith(const2)
 
             assert relparts[0].cid == const1
             assert relparts[0].desc.endswith(const2)
 

+        def test_apply_stylesheet(self):
+            if _PYNLINER:
+                html = "<p>Hello, world!</p>"
+                css = "p { color:red }"
+                out = apply_styling(html, css)
+                assert 'p style="color' in out
+
+        def test_apply_stylesheet_pygments(self):
+            if _PYGMENTS_CSS:
+                html = (
+                    f'<div class="{_CODEHILITE_CLASS}">'
+                    "<pre>def foo():\n    return</pre></div>"
+                )
+                out = apply_styling(html, _PYGMENTS_CSS)
+                assert f'{_CODEHILITE_CLASS}" style="' in out
+
+

 except ImportError:
     pass
 except ImportError:
     pass