]> git.madduck.net Git - etc/neomutt.git/blobdiff - .config/neomutt/buildmimetree.py

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

buildmimetree.py: allow multipart/related instead of relative
[etc/neomutt.git] / .config / neomutt / buildmimetree.py
index c16e519db3ab3e137e04a915c16be9e0ac96df61..a570a3b58c573c2ee1369c6af1dc4a0062833ae6 100755 (executable)
@@ -7,7 +7,7 @@
 # Configuration:
 #   neomuttrc (needs to be a single line):
 #     macro compose B "\
-#       <enter-command> source '$my_confdir/buildmimetree.py setup|'<enter>\
+#       <enter-command> source '$my_confdir/buildmimetree.py setup --tempdir $tempdir|'<enter>\
 #       <enter-command> sourc e \$my_mdwn_postprocess_cmd_file<enter>\
 #     " "Convert message into a modern MIME tree with inline images"
 #
@@ -67,6 +67,12 @@ def parse_cli_args(*args, **kwargs):
         help="Turn on debug logging of commands generated to stderr",
     )
 
+    parser_setup.add_argument(
+        "--tempdir",
+        default=None,
+        help="Specify temporary directory to use for attachments",
+    )
+
     parser_setup.add_argument(
         "--extension",
         "-x",
@@ -96,6 +102,12 @@ def parse_cli_args(*args, **kwargs):
         help="Turn on debugging to stderr of the MIME tree walk",
     )
 
+    parser_massage.add_argument(
+        "--tempdir",
+        default=None,
+        help="Specify temporary directory to use for attachments",
+    )
+
     parser_massage.add_argument(
         "--extensions",
         metavar="EXTENSIONS",
@@ -228,24 +240,25 @@ def collect_inline_images(
 
         mimetype = data.headers["Content-Type"]
         ext = mimetypes.guess_extension(mimetype)
-        tempfilename = tempfile.mkstemp(prefix="img", suffix=ext, dir=tempdir)[
-            1
-        ]
-        path = pathlib.Path(tempfilename)
+        tempfilename = tempfile.mkstemp(prefix="img", suffix=ext, dir=tempdir)
+        path = pathlib.Path(tempfilename[1])
 
         filewriter_fn(path, data.read(), "w+b")
 
         relparts.append(
-            Part(
-                *mimetype.split("/"), path, cid=info.cid, desc=info.desc
-            )
+            Part(*mimetype.split("/"), path, cid=info.cid, desc=info.desc)
         )
 
     return relparts
 
 
 def convert_markdown_to_html(
-    origtext, draftpath, *, filewriter_fn=filewriter_fn, extensions=None
+    origtext,
+    draftpath,
+    *,
+    filewriter_fn=filewriter_fn,
+    tempdir=None,
+    extensions=None,
 ):
     origtext, htmltext, images = markdown_with_inline_image_support(
         origtext, extensions=extensions
@@ -266,7 +279,9 @@ def convert_markdown_to_html(
         "alternative", [textpart, htmlpart], "Group of alternative content"
     )
 
-    imgparts = collect_inline_images(images, filewriter_fn=filewriter_fn)
+    imgparts = collect_inline_images(
+        images, tempdir=tempdir, filewriter_fn=filewriter_fn
+    )
     if imgparts:
         return Multipart(
             "relative", [altpart] + imgparts, "Group of related content"
@@ -381,19 +396,26 @@ class MuttCommands:
 
 
 def do_setup(
-    extensions=None, *, out_f=sys.stdout, temppath=None, debug_commands=False
+    extensions=None,
+    *,
+    out_f=sys.stdout,
+    temppath=None,
+    tempdir=None,
+    debug_commands=False,
 ):
     extensions = extensions or []
     temppath = temppath or pathlib.Path(
-        tempfile.mkstemp(prefix="muttmdwn-")[1]
+        tempfile.mkstemp(prefix="muttmdwn-", dir=tempdir)[1]
     )
     cmds = MuttCommands(out_f, debug=debug_commands)
 
     editor = f"{sys.argv[0]} massage --write-commands-to {temppath}"
     if extensions:
         editor = f'{editor} --extensions {",".join(extensions)}'
+    if tempdir:
+        editor = f"{editor} --tempdir {tempdir}"
     if debug_commands:
-        editor = f'{editor} --debug-commands'
+        editor = f"{editor} --debug-commands"
 
     cmds.cmd('set my_editor="$editor"')
     cmds.cmd('set my_edit_headers="$edit_headers"')
@@ -411,6 +433,7 @@ def do_massage(
     *,
     extensions=None,
     converter=convert_markdown_to_html,
+    tempdir=None,
     debug_commands=False,
     debug_walk=False,
 ):
@@ -433,7 +456,7 @@ def do_massage(
     cmds.flush()
 
     extensions = extensions.split(",") if extensions else []
-    tree = converter(draft_f.read(), draftpath, extensions=extensions)
+    tree = converter(draft_f.read(), draftpath, tempdir=tempdir, extensions=extensions)
 
     mimetree = MIMETreeDFWalker(debug=debug_walk)
 
@@ -472,7 +495,7 @@ def do_massage(
             # appropriate grouping:
             if item.subtype == "alternative":
                 cmds.push("<group-alternatives>")
-            elif item.subtype == "relative":
+            elif item.subtype in ("relative", "related"):
                 cmds.push("<group-related>")
             elif item.subtype == "multilingual":
                 cmds.push("<group-multilingual>")
@@ -518,7 +541,11 @@ if __name__ == "__main__":
         if args.send_message:
             raise NotImplementedError()
 
-        do_setup(args.extensions, debug_commands=args.debug_commands)
+        do_setup(
+            args.extensions,
+            tempdir=args.tempdir,
+            debug_commands=args.debug_commands,
+        )
 
     elif args.mode == "massage":
         with open(args.MAILDRAFT, "r") as draft_f, open(
@@ -529,6 +556,7 @@ if __name__ == "__main__":
                 pathlib.Path(args.MAILDRAFT),
                 cmd_f,
                 extensions=args.extensions,
+                tempdir=args.tempdir,
                 debug_commands=args.debug_commands,
                 debug_walk=args.debug_walk,
             )
@@ -690,7 +718,7 @@ try:
             return StringIO(text or const1)
 
         def test_do_massage_basic(self, const1, string_io, capsys):
-            def converter(drafttext, draftpath, extensions):
+            def converter(drafttext, draftpath, extensions, tempdir):
                 return Part("text", "plain", draftpath, orig=True)
 
             do_massage(
@@ -713,7 +741,7 @@ try:
         def test_do_massage_fulltree(
             self, string_io, const1, basic_mime_tree, capsys
         ):
-            def converter(drafttext, draftpath, extensions):
+            def converter(drafttext, draftpath, extensions, tempdir):
                 return basic_mime_tree
 
             do_massage(
@@ -861,27 +889,26 @@ try:
                 assert k == f"file://{imgpath}"
                 break
 
-        def test_markdown_inline_image_processor_base64(self):
-            img = (
+        @pytest.fixture
+        def test_png(self):
+            return (
                 "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAE"
                 "AAAABCAAAAAA6fptVAAAACklEQVQI12P4DwABAQEAG7buVgAA"
             )
-            text = f"![1px white inlined]({img})"
+
+        def test_markdown_inline_image_processor_base64(self, test_png):
+            text = f"![1px white inlined]({test_png})"
             text, html, images = markdown_with_inline_image_support(text)
 
             assert 'src="cid:' in html
             assert "](cid:" in text
             assert len(images) == 1
-            assert img in images
+            assert test_png in images
 
         def test_converter_tree_inline_image_base64(
-            self, const1, fake_filewriter
+            self, test_png, const1, fake_filewriter
         ):
-            img = (
-                "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAE"
-                "AAAABCAAAAAA6fptVAAAACklEQVQI12P4DwABAQEAG7buVgAA"
-            )
-            text = f"![inline base64 image]({img})"
+            text = f"![inline base64 image]({test_png})"
             path = pathlib.Path(const1)
             tree = convert_markdown_to_html(
                 text, path, filewriter_fn=fake_filewriter
@@ -891,7 +918,23 @@ try:
             assert tree.children[1].subtype == "png"
             written = fake_filewriter.pop()
             assert tree.children[1].path == written[0]
-            assert written[1] == request.urlopen(img).read()
+            assert written[1] == request.urlopen(test_png).read()
+
+        def test_inline_image_collection(
+            self, test_png, const1, const2, fake_filewriter
+        ):
+            test_images = {test_png: InlineImageInfo(cid=const1, desc=const2)}
+            relparts = collect_inline_images(
+                test_images, filewriter_fn=fake_filewriter
+            )
+
+            written = fake_filewriter.pop()
+            assert b"PNG" in written[1]
+
+            assert relparts[0].subtype == "png"
+            assert relparts[0].path == written[0]
+            assert relparts[0].cid == const1
+            assert relparts[0].desc == const2
 
 except ImportError:
     pass