# 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"
#
parser_setup = subp.add_parser("setup", help="Setup phase")
parser_massage = subp.add_parser("massage", help="Massaging phase")
- parser_setup.add_argument(
- "--debug-commands",
- action="store_true",
- help="Turn on debug logging of commands generated to stderr",
- )
-
parser_setup.add_argument(
"--extension",
"-x",
)
parser_setup.add_argument(
- "--send-message",
+ "--only-build",
action="store_true",
- help="Generate command(s) to send the message after processing",
+ help="Only build, don't send the message",
)
- parser_massage.add_argument(
+ parser_setup.add_argument(
+ "--tempdir",
+ default=None,
+ help="Specify temporary directory to use for attachments",
+ )
+
+ parser_setup.add_argument(
"--debug-commands",
action="store_true",
help="Turn on debug logging of commands generated to stderr",
)
parser_massage.add_argument(
- "--debug-walk",
- action="store_true",
- help="Turn on debugging to stderr of the MIME tree walk",
+ "--write-commands-to",
+ metavar="PATH",
+ dest="cmdpath",
+ help="Temporary file path to write commands to",
)
parser_massage.add_argument(
)
parser_massage.add_argument(
- "--write-commands-to",
- metavar="PATH",
- dest="cmdpath",
- help="Temporary file path to write commands to",
+ "--only-build",
+ action="store_true",
+ help="Only build, don't send the message",
+ )
+
+ parser_massage.add_argument(
+ "--tempdir",
+ default=None,
+ help="Specify temporary directory to use for attachments",
+ )
+
+ parser_massage.add_argument(
+ "--debug-commands",
+ action="store_true",
+ help="Turn on debug logging of commands generated to stderr",
+ )
+
+ parser_massage.add_argument(
+ "--debug-walk",
+ action="store_true",
+ help="Turn on debugging to stderr of the MIME tree walk",
)
parser_massage.add_argument(
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=f"Image: {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
"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"
def do_setup(
- extensions=None, *, out_f=sys.stdout, temppath=None, debug_commands=False
+ extensions=None,
+ *,
+ out_f=sys.stdout,
+ only_build=False,
+ 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 only_build:
+ editor = f'{editor} --only-build'
+ if tempdir:
+ editor = f"{editor} --tempdir {tempdir}"
if debug_commands:
editor = f"{editor} --debug-commands"
*,
extensions=None,
converter=convert_markdown_to_html,
+ only_build=False,
+ tempdir=None,
debug_commands=False,
debug_walk=False,
):
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)
depth-first, and responsible for telling NeoMutt how to assemble
the tree.
"""
+ KILL_LINE=r'\Ca\Ck'
+
if isinstance(item, Part):
# We've hit a leaf-node, i.e. an alternative or a related part
# with actual content.
# information, then we might just as well update the NeoMutt
# tree now:
if item.cid:
- cmds.push(f"<edit-content-id>\\Ca\\Ck{item.cid}<enter>")
+ cmds.push(f"<edit-content-id>{KILL_LINE}{item.cid}<enter>")
elif isinstance(item, Multipart):
# This node has children, but we already visited them (see
# 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>")
# If the item has a description, we might just as well add it
if item.desc:
- cmds.push(f"<edit-description>\\Ca\\Ck{item.desc}<enter>")
+ cmds.push(f"<edit-description>{KILL_LINE}{item.desc}<enter>")
# Finally, if we're at non-root level, tag the new container,
# as it might itself be part of a container, to be processed
# function
mimetree.walk(tree, visitor_fn=visitor_fn)
+ if not only_build:
+ cmds.push("<send-message>")
+
# Finally, cleanup. Since we're responsible for removing the temporary
# file, how's this for a little hack?
try:
args = parse_cli_args()
if args.mode == "setup":
- if args.send_message:
- raise NotImplementedError()
-
- do_setup(args.extensions, debug_commands=args.debug_commands)
+ do_setup(
+ args.extensions,
+ only_build=args.only_build,
+ tempdir=args.tempdir,
+ debug_commands=args.debug_commands,
+ )
elif args.mode == "massage":
with open(args.MAILDRAFT, "r") as draft_f, open(
pathlib.Path(args.MAILDRAFT),
cmd_f,
extensions=args.extensions,
+ only_build=args.only_build,
+ tempdir=args.tempdir,
debug_commands=args.debug_commands,
debug_walk=args.debug_walk,
)
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(
assert '="$my_edit_headers"' in lines.pop(0)
assert "unset my_editor" == lines.pop(0)
assert "unset my_edit_headers" == lines.pop(0)
+ assert "send-message" in lines.pop(0)
assert "update-encoding" in lines.pop(0)
assert "source 'rm -f " in lines.pop(0)
assert "unset my_mdwn_postprocess_cmd_file" == lines.pop(0)
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(
captured = capsys.readouterr()
lines = captured.out.splitlines()[4:]
+ assert "send-message" in lines.pop(0)
assert "Related" in lines.pop(0)
assert "group-related" in lines.pop(0)
assert "tag-entry" in lines.pop(0)
"AAAABCAAAAAA6fptVAAAACklEQVQI12P4DwABAQEAG7buVgAA"
)
-
def test_markdown_inline_image_processor_base64(self, test_png):
text = f""
text, html, images = markdown_with_inline_image_support(text)
assert tree.children[1].path == written[0]
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.endswith(const2)
+
except ImportError:
pass
projects / etc / neomutt.git / blobdiff