X-Git-Url: https://git.distorted.org.uk/~mdw/stgit/blobdiff_plain/ea09f8ce7b1bcea38a7d9f0079a28c6109989342..35112e505fff1c37f9261313060c730c47ab47c8:/stgit/commands/mail.py diff --git a/stgit/commands/mail.py b/stgit/commands/mail.py index cab896b..e1de847 100644 --- a/stgit/commands/mail.py +++ b/stgit/commands/mail.py @@ -28,7 +28,7 @@ from stgit.lib import git as gitlib help = 'Send a patch or series of patches by e-mail' kind = 'patch' -usage = [' [options] [] [] [..]'] +usage = [' [options] [--] [] [] [..]'] description = r""" Send a patch or a range of patches by e-mail using the SMTP server specified by the 'stgit.smtpserver' configuration option, or the @@ -56,7 +56,7 @@ specified file (defaulting to '.git/covermail.tmpl' or All the subsequent e-mails appear as replies to the first e-mail sent (either the preamble or the first patch). E-mails can be seen as -replies to a different e-mail by using the '--refid' option. +replies to a different e-mail by using the '--in-reply-to' option. SMTP authentication is also possible with '--smtp-user' and '--smtp-password' options, also available as configuration settings: @@ -107,7 +107,7 @@ options = [ short = 'Add BCC to the Bcc: list'), opt('--auto', action = 'store_true', short = 'Automatically cc the patch signers'), - opt('--noreply', action = 'store_true', + opt('--no-thread', action = 'store_true', short = 'Do not send subsequent messages as replies'), opt('--unrelated', action = 'store_true', short = 'Send patches without sequence numbering'), @@ -127,7 +127,7 @@ options = [ short = 'Edit each patch before sending'), opt('-s', '--sleep', type = 'int', metavar = 'SECONDS', short = 'Sleep for SECONDS between e-mails sending'), - opt('--refid', + opt('--in-reply-to', metavar = 'REFID', short = 'Use REFID as the reference id'), opt('--smtp-server', metavar = 'HOST[:PORT] or "/path/to/sendmail -t -i"', short = 'SMTP server or command to use for sending mail'), @@ -140,7 +140,9 @@ options = [ opt('-b', '--branch', args = [argparse.stg_branches], short = 'Use BRANCH instead of the default branch'), opt('-m', '--mbox', action = 'store_true', - short = 'Generate an mbox file instead of sending') + short = 'Generate an mbox file instead of sending'), + opt('--git', action = 'store_true', + short = 'Use git send-email (EXPERIMENTAL)') ] + argparse.diff_opts_option() directory = DirectoryHasRepository(log = False) @@ -190,10 +192,20 @@ def __send_message_sendmail(sendmail, msg): cmd = sendmail.split() Run(*cmd).raw_input(msg).discard_output() -def __send_message_smtp(smtpserver, from_addr, to_addr_list, msg, - smtpuser, smtppassword, use_tls): +def __send_message_smtp(smtpserver, from_addr, to_addr_list, msg, options): """Send the message using the given SMTP server """ + smtppassword = options.smtp_password or config.get('stgit.smtppassword') + smtpuser = options.smtp_user or config.get('stgit.smtpuser') + smtpusetls = options.smtp_tls or config.get('stgit.smtptls') == 'yes' + + if (smtppassword and not smtpuser): + raise CmdException('SMTP password supplied, username needed') + if (smtpusetls and not smtpuser): + raise CmdException('SMTP over TLS requested, username needed') + if (smtpuser and not smtppassword): + smtppassword = getpass.getpass("Please enter SMTP password: ") + try: s = smtplib.SMTP(smtpserver) except Exception, err: @@ -203,7 +215,7 @@ def __send_message_smtp(smtpserver, from_addr, to_addr_list, msg, try: if smtpuser and smtppassword: s.ehlo() - if use_tls: + if smtpusetls: if not hasattr(socket, 'ssl'): raise CmdException, "cannot use TLS - no SSL support in Python" s.starttls() @@ -218,39 +230,97 @@ def __send_message_smtp(smtpserver, from_addr, to_addr_list, msg, s.quit() -def __send_message(smtpserver, from_addr, to_addr_list, msg, - sleep, smtpuser, smtppassword, use_tls): +def __send_message_git(msg, options): + """Send the message using git send-email + """ + from subprocess import call + from tempfile import mkstemp + + cmd = ["git", "send-email", "--from=%s" % msg['From']] + cmd.append("--quiet") + cmd.append("--suppress-cc=self") + if not options.auto: + cmd.append("--suppress-cc=body") + if options.in_reply_to: + cmd.extend(["--in-reply-to", options.in_reply_to]) + if options.no_thread: + cmd.append("--no-thread") + + # We only support To/Cc/Bcc in git send-email for now. + for x in ['to', 'cc', 'bcc']: + if getattr(options, x): + cmd.extend('--%s=%s' % (x, a) for a in getattr(options, x)) + + (fd, path) = mkstemp() + os.write(fd, msg.as_string(options.mbox)) + os.close(fd) + + try: + try: + cmd.append(path) + call(cmd) + except Exception, err: + raise CmdException, str(err) + finally: + os.unlink(path) + +def __send_message(type, tmpl, options, *args): """Message sending dispatcher. """ - if smtpserver.startswith('/'): + (build, outstr) = {'cover': (__build_cover, 'the cover message'), + 'patch': (__build_message, 'patch "%s"' % args[0])}[type] + if type == 'patch': + (patch_nr, total_nr) = (args[1], args[2]) + + msg_id = email.Utils.make_msgid('stgit') + msg = build(tmpl, msg_id, options, *args) + + msg_str = msg.as_string(options.mbox) + if options.mbox: + out.stdout_raw(msg_str + '\n') + return msg_id + + if not options.git: + from_addr, to_addrs = __parse_addresses(msg) + out.start('Sending ' + outstr) + + smtpserver = options.smtp_server or config.get('stgit.smtpserver') + if options.git: + __send_message_git(msg, options) + elif smtpserver.startswith('/'): # Use the sendmail tool - __send_message_sendmail(smtpserver, msg) + __send_message_sendmail(smtpserver, msg_str) else: # Use the SMTP server (we have host and port information) - __send_message_smtp(smtpserver, from_addr, to_addr_list, msg, - smtpuser, smtppassword, use_tls) - # give recipients a chance of receiving patches in the correct order - time.sleep(sleep) + __send_message_smtp(smtpserver, from_addr, to_addrs, msg_str, options) -def __build_address_headers(msg, options, extra_cc = []): - """Build the address headers and check existing headers in the - template. - """ + # give recipients a chance of receiving related patches in correct order + if type == 'cover' or (type == 'patch' and patch_nr < total_nr): + sleep = options.sleep or config.getint('stgit.smtpdelay') + time.sleep(sleep) + if not options.git: + out.done() + return msg_id + +def __update_header(msg, header, addr = '', ignore = ()): def __addr_pairs(msg, header, extra): pairs = email.Utils.getaddresses(msg.get_all(header, []) + extra) # remove pairs without an address and resolve the aliases return [address_or_alias(p) for p in pairs if p[1]] - def __update_header(header, addr = '', ignore = ()): - addr_pairs = __addr_pairs(msg, header, [addr]) - del msg[header] - # remove the duplicates and filter the addresses - addr_dict = dict((addr, email.Utils.formataddr((name, addr))) - for name, addr in addr_pairs if addr not in ignore) - if addr_dict: - msg[header] = ', '.join(addr_dict.itervalues()) - return set(addr_dict.iterkeys()) + addr_pairs = __addr_pairs(msg, header, [addr]) + del msg[header] + # remove the duplicates and filter the addresses + addr_dict = dict((addr, email.Utils.formataddr((name, addr))) + for name, addr in addr_pairs if addr not in ignore) + if addr_dict: + msg[header] = ', '.join(addr_dict.itervalues()) + return set(addr_dict.iterkeys()) +def __build_address_headers(msg, options, extra_cc = []): + """Build the address headers and check existing headers in the + template. + """ to_addr = '' cc_addr = '' extra_cc_addr = '' @@ -270,18 +340,14 @@ def __build_address_headers(msg, options, extra_cc = []): bcc_addr = autobcc # if an address is on a header, ignore it from the rest - to_set = __update_header('To', to_addr) - cc_set = __update_header('Cc', cc_addr, to_set) - bcc_set = __update_header('Bcc', bcc_addr, to_set.union(cc_set)) + to_set = __update_header(msg, 'To', to_addr) + cc_set = __update_header(msg, 'Cc', cc_addr, to_set) + bcc_set = __update_header(msg, 'Bcc', bcc_addr, to_set.union(cc_set)) # --auto generated addresses, don't include the sender - from_set = __update_header('From') - __update_header('Cc', extra_cc_addr, to_set.union(bcc_set).union(from_set)) - - # update other address headers - __update_header('Reply-To') - __update_header('Mail-Reply-To') - __update_header('Mail-Followup-To') + from_set = __update_header(msg, 'From') + __update_header(msg, 'Cc', extra_cc_addr, + to_set.union(bcc_set).union(from_set)) def __get_signers_list(msg): """Return the address list generated from signed-off-by and @@ -319,6 +385,12 @@ def __build_extra_headers(msg, msg_id, ref_id = None): msg['References'] = ref_id msg['User-Agent'] = 'StGit/%s' % version.version + # update other address headers + __update_header(msg, 'Reply-To') + __update_header(msg, 'Mail-Reply-To') + __update_header(msg, 'Mail-Followup-To') + + def __encode_message(msg): # 7 or 8 bit encoding charset = email.Charset.Charset('utf-8') @@ -362,7 +434,7 @@ def __edit_message(msg): return msg -def __build_cover(tmpl, patches, msg_id, options): +def __build_cover(tmpl, msg_id, options, patches): """Build the cover message (series description) to be sent via SMTP """ sender = __get_sender() @@ -401,10 +473,11 @@ def __build_cover(tmpl, patches, msg_id, options): 'totalnr': total_nr_str, 'number': number_str, 'shortlog': stack.shortlog(crt_series.get_patch(p) - for p in patches), + for p in reversed(patches)), 'diffstat': gitlib.diffstat(git.diff( rev1 = git_id(crt_series, '%s^' % patches[0]), - rev2 = git_id(crt_series, '%s' % patches[-1])))} + rev2 = git_id(crt_series, '%s' % patches[-1]), + diff_flags = options.diff_flags))} try: msg_string = tmpl % tmpl_dict @@ -424,13 +497,14 @@ def __build_cover(tmpl, patches, msg_id, options): except Exception, ex: raise CmdException, 'template parsing error: %s' % str(ex) - __build_address_headers(msg, options) - __build_extra_headers(msg, msg_id, options.refid) + if not options.git: + __build_address_headers(msg, options) + __build_extra_headers(msg, msg_id, options.in_reply_to) __encode_message(msg) return msg -def __build_message(tmpl, patch, patch_nr, total_nr, msg_id, ref_id, options): +def __build_message(tmpl, msg_id, options, patch, patch_nr, total_nr, ref_id): """Build the message to be sent via SMTP """ p = crt_series.get_patch(patch) @@ -534,7 +608,8 @@ def __build_message(tmpl, patch, patch_nr, total_nr, msg_id, ref_id, options): else: extra_cc = [] - __build_address_headers(msg, options, extra_cc) + if not options.git: + __build_address_headers(msg, options, extra_cc) __build_extra_headers(msg, msg_id, ref_id) __encode_message(msg) @@ -544,8 +619,6 @@ def func(parser, options, args): """Send the patches by e-mail using the patchmail.tmpl file as a template """ - smtpserver = options.smtp_server or config.get('stgit.smtpserver') - applied = crt_series.get_applied() if options.all: @@ -565,30 +638,18 @@ def func(parser, options, args): raise CmdException, 'Cannot send empty patch "%s"' % p out.done() - smtppassword = options.smtp_password or config.get('stgit.smtppassword') - smtpuser = options.smtp_user or config.get('stgit.smtpuser') - smtpusetls = options.smtp_tls or config.get('stgit.smtptls') == 'yes' - - if (smtppassword and not smtpuser): - raise CmdException, 'SMTP password supplied, username needed' - if (smtpusetls and not smtpuser): - raise CmdException, 'SMTP over TLS requested, username needed' - if (smtpuser and not smtppassword): - smtppassword = getpass.getpass("Please enter SMTP password: ") - total_nr = len(patches) if total_nr == 0: raise CmdException, 'No patches to send' - if options.refid: - if options.noreply or options.unrelated: + if options.in_reply_to: + if options.no_thread or options.unrelated: raise CmdException, \ - '--refid option not allowed with --noreply or --unrelated' - ref_id = options.refid + '--in-reply-to option not allowed with --no-thread or --unrelated' + ref_id = options.in_reply_to else: ref_id = None - sleep = options.sleep or config.getint('stgit.smtpdelay') # send the cover message (if any) if options.cover or options.edit_cover: @@ -603,24 +664,12 @@ def func(parser, options, args): if not tmpl: raise CmdException, 'No cover message template file found' - msg_id = email.Utils.make_msgid('stgit') - msg = __build_cover(tmpl, patches, msg_id, options) - from_addr, to_addr_list = __parse_addresses(msg) - - msg_string = msg.as_string(options.mbox) + msg_id = __send_message('cover', tmpl, options, patches) # subsequent e-mails are seen as replies to the first one - if not options.noreply: + if not options.no_thread: ref_id = msg_id - if options.mbox: - out.stdout_raw(msg_string + '\n') - else: - out.start('Sending the cover message') - __send_message(smtpserver, from_addr, to_addr_list, msg_string, - sleep, smtpuser, smtppassword, smtpusetls) - out.done() - # send the patches if options.template: tmpl = file(options.template).read() @@ -632,22 +681,9 @@ def func(parser, options, args): if not tmpl: raise CmdException, 'No e-mail template file found' - for (p, patch_nr) in zip(patches, range(1, len(patches) + 1)): - msg_id = email.Utils.make_msgid('stgit') - msg = __build_message(tmpl, p, patch_nr, total_nr, msg_id, ref_id, - options) - from_addr, to_addr_list = __parse_addresses(msg) - - msg_string = msg.as_string(options.mbox) + for (p, n) in zip(patches, range(1, total_nr + 1)): + msg_id = __send_message('patch', tmpl, options, p, n, total_nr, ref_id) # subsequent e-mails are seen as replies to the first one - if not options.noreply and not options.unrelated and not ref_id: + if not options.no_thread and not options.unrelated and not ref_id: ref_id = msg_id - - if options.mbox: - out.stdout_raw(msg_string + '\n') - else: - out.start('Sending patch "%s"' % p) - __send_message(smtpserver, from_addr, to_addr_list, msg_string, - sleep, smtpuser, smtppassword, smtpusetls) - out.done()