X-Git-Url: https://git.distorted.org.uk/~mdw/stgit/blobdiff_plain/d650d6ed4c969d0d5127544e5236f83e21608ca5..baf8241d1b7835ba31125d2b75683601ee2b0403:/stgit/commands/mail.py diff --git a/stgit/commands/mail.py b/stgit/commands/mail.py index 762829c..46e4b55 100644 --- a/stgit/commands/mail.py +++ b/stgit/commands/mail.py @@ -15,25 +15,32 @@ along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA """ -import sys, os, re, time, datetime, smtplib +import sys, os, re, time, datetime, socket, smtplib, getpass import email, email.Utils, email.Header -from optparse import OptionParser, make_option - +from stgit.argparse import opt from stgit.commands.common import * from stgit.utils import * -from stgit import stack, git, version, templates +from stgit.out import * +from stgit import argparse, stack, git, version, templates from stgit.config import config - - -help = 'send a patch or series of patches by e-mail' -usage = """%prog [options] [] [] [..] - -Send a patch or a range of patches by e-mail using the 'smtpserver' -configuration option. The From address and the e-mail format are -generated from the template file passed as argument to '--template' -(defaulting to '.git/patchmail.tmpl' or -'~/.stgit/templates/patchmail.tmpl' or -'/usr/share/stgit/templates/patchmail.tmpl'). +from stgit.run import Run +from stgit.lib import git as gitlib + +help = 'Send a patch or series of patches by e-mail' +kind = 'patch' +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 +'--smtp-server' command line option. This option can also be an +absolute path to 'sendmail' followed by command line arguments. + +The From address and the e-mail format are generated from the template +file passed as argument to '--template' (defaulting to +'.git/patchmail.tmpl' or '~/.stgit/templates/patchmail.tmpl' or +'/usr/share/stgit/templates/patchmail.tmpl'). A patch can be sent as +attachment using the --attach option in which case the +'mailattch.tmpl' template will be used instead of 'patchmail.tmpl'. The To/Cc/Bcc addresses can either be added to the template file or passed via the corresponding command line options. They can be e-mail @@ -53,77 +60,90 @@ replies to a different e-mail by using the '--refid' option. SMTP authentication is also possible with '--smtp-user' and '--smtp-password' options, also available as configuration settings: -'smtpuser' and 'smtppassword'. +'smtpuser' and 'smtppassword'. TLS encryption can be enabled by +'--smtp-tls' option and 'smtptls' setting. -The patch e-mail template accepts the following variables: +The following variables are accepted by both the preamble and the +patch e-mail templates: - %(patch)s - patch name - %(sender)s - 'sender' or 'authname ' as per the config file - %(shortdescr)s - the first line of the patch description - %(longdescr)s - the rest of the patch description, after the first line - %(diff)s - unified diff of the patch %(diffstat)s - diff statistics - %(version)s - ' version' string passed on the command line (or empty) - %(prefix)s - 'prefix ' string passed on the command line + %(number)s - empty if only one patch is sent or ' patchnr/totalnr' %(patchnr)s - patch number + %(sender)s - 'sender' or 'authname ' as per the config file %(totalnr)s - total number of patches to be sent - %(number)s - empty if only one patch is sent or ' patchnr/totalnr' - %(fromauth)s - 'From: author\\n\\n' if different from sender - %(authname)s - author's name - %(authemail)s - author's email - %(authdate)s - patch creation date - %(commname)s - committer's name - %(commemail)s - committer's e-mail + %(version)s - ' version' string passed on the command line (or empty) + +In addition to the common variables, the preamble e-mail template +accepts the following: -For the preamble e-mail template, only the %(sender)s, %(version)s, -%(patchnr)s, %(totalnr)s and %(number)s variables are supported.""" - -options = [make_option('-a', '--all', - help = 'e-mail all the applied patches', - action = 'store_true'), - make_option('--to', - help = 'add TO to the To: list', - action = 'append'), - make_option('--cc', - help = 'add CC to the Cc: list', - action = 'append'), - make_option('--bcc', - help = 'add BCC to the Bcc: list', - action = 'append'), - make_option('--auto', - help = 'automatically cc the patch signers', - action = 'store_true'), - make_option('--noreply', - help = 'do not send subsequent messages as replies', - action = 'store_true'), - make_option('-v', '--version', metavar = 'VERSION', - help = 'add VERSION to the [PATCH ...] prefix'), - make_option('--prefix', metavar = 'PREFIX', - help = 'add PREFIX to the [... PATCH ...] prefix'), - make_option('-t', '--template', metavar = 'FILE', - help = 'use FILE as the message template'), - make_option('-c', '--cover', metavar = 'FILE', - help = 'send FILE as the cover message'), - make_option('-e', '--edit-cover', - help = 'edit the cover message before sending', - action = 'store_true'), - make_option('-E', '--edit-patches', - help = 'edit each patch before sending', - action = 'store_true'), - make_option('-s', '--sleep', type = 'int', metavar = 'SECONDS', - help = 'sleep for SECONDS between e-mails sending'), - make_option('--refid', - help = 'use REFID as the reference id'), - make_option('-u', '--smtp-user', metavar = 'USER', - help = 'username for SMTP authentication'), - make_option('-p', '--smtp-password', metavar = 'PASSWORD', - help = 'username for SMTP authentication'), - make_option('-b', '--branch', - help = 'use BRANCH instead of the default one'), - make_option('-m', '--mbox', - help = 'generate an mbox file instead of sending', - action = 'store_true')] + %(shortlog)s - first line of each patch description, listed by author +In addition to the common variables, the patch e-mail template accepts +the following: + + %(authdate)s - patch creation date + %(authemail)s - author's email + %(authname)s - author's name + %(commemail)s - committer's e-mail + %(commname)s - committer's name + %(diff)s - unified diff of the patch + %(fromauth)s - 'From: author\n\n' if different from sender + %(longdescr)s - the rest of the patch description, after the first line + %(patch)s - patch name + %(prefix)s - 'prefix ' string passed on the command line + %(shortdescr)s - the first line of the patch description""" + +args = [argparse.patch_range(argparse.applied_patches, + argparse.unapplied_patches, + argparse.hidden_patches)] +options = [ + opt('-a', '--all', action = 'store_true', + short = 'E-mail all the applied patches'), + opt('--to', action = 'append', + short = 'Add TO to the To: list'), + opt('--cc', action = 'append', + short = 'Add CC to the Cc: list'), + opt('--bcc', action = 'append', + short = 'Add BCC to the Bcc: list'), + opt('--auto', action = 'store_true', + short = 'Automatically cc the patch signers'), + opt('--noreply', action = 'store_true', + short = 'Do not send subsequent messages as replies'), + opt('--unrelated', action = 'store_true', + short = 'Send patches without sequence numbering'), + opt('--attach', action = 'store_true', + short = 'Send a patch as attachment'), + opt('-v', '--version', metavar = 'VERSION', + short = 'Add VERSION to the [PATCH ...] prefix'), + opt('--prefix', metavar = 'PREFIX', + short = 'Add PREFIX to the [... PATCH ...] prefix'), + opt('-t', '--template', metavar = 'FILE', + short = 'Use FILE as the message template'), + opt('-c', '--cover', metavar = 'FILE', + short = 'Send FILE as the cover message'), + opt('-e', '--edit-cover', action = 'store_true', + short = 'Edit the cover message before sending'), + opt('-E', '--edit-patches', action = 'store_true', + short = 'Edit each patch before sending'), + opt('-s', '--sleep', type = 'int', metavar = 'SECONDS', + short = 'Sleep for SECONDS between e-mails sending'), + opt('--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'), + opt('-u', '--smtp-user', metavar = 'USER', + short = 'Username for SMTP authentication'), + opt('-p', '--smtp-password', metavar = 'PASSWORD', + short = 'Password for SMTP authentication'), + opt('-T', '--smtp-tls', action = 'store_true', + short = 'Use SMTP with TLS encryption'), + 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') + ] + argparse.diff_opts_option() + +directory = DirectoryHasRepository(log = False) def __get_sender(): """Return the 'authname ' string as read from the @@ -134,20 +154,25 @@ def __get_sender(): try: sender = str(git.user()) except git.GitException: - sender = str(git.author()) - + try: + sender = str(git.author()) + except git.GitException: + pass if not sender: - raise CmdException, 'unknown sender details' + raise CmdException, ('Unknown sender name and e-mail; you should' + ' for example set git config user.name and' + ' user.email') + sender = email.Utils.parseaddr(sender) + + return email.Utils.formataddr(address_or_alias(sender)) - return address_or_alias(sender) +def __addr_list(msg, header): + return [addr for name, addr in + email.Utils.getaddresses(msg.get_all(header, []))] def __parse_addresses(msg): """Return a two elements tuple: (from, [to]) """ - def __addr_list(msg, header): - return [name_addr[1] for name_addr in - email.Utils.getaddresses(msg.get_all(header, []))] - from_addr_list = __addr_list(msg, 'From') if len(from_addr_list) == 0: raise CmdException, 'No "From" address' @@ -157,10 +182,16 @@ def __parse_addresses(msg): if len(to_addr_list) == 0: raise CmdException, 'No "To/Cc/Bcc" addresses' - return (from_addr_list[0], to_addr_list) + return (from_addr_list[0], set(to_addr_list)) + +def __send_message_sendmail(sendmail, msg): + """Send the message using the sendmail command. + """ + cmd = sendmail.split() + Run(*cmd).raw_input(msg).discard_output() -def __send_message(smtpserver, from_addr, to_addr_list, msg, sleep, - smtpuser, smtppassword): +def __send_message_smtp(smtpserver, from_addr, to_addr_list, msg, + smtpuser, smtppassword, use_tls): """Send the message using the given SMTP server """ try: @@ -172,32 +203,57 @@ def __send_message(smtpserver, from_addr, to_addr_list, msg, sleep, try: if smtpuser and smtppassword: s.ehlo() + if use_tls: + if not hasattr(socket, 'ssl'): + raise CmdException, "cannot use TLS - no SSL support in Python" + s.starttls() + s.ehlo() s.login(smtpuser, smtppassword) - s.sendmail(from_addr, to_addr_list, msg) - # give recipients a chance of receiving patches in the correct order - time.sleep(sleep) + result = s.sendmail(from_addr, to_addr_list, msg) + if len(result): + print "mail server refused delivery for the following recipients: %s" % result except Exception, err: raise CmdException, str(err) s.quit() +def __send_message(smtpserver, from_addr, to_addr_list, msg, + sleep, smtpuser, smtppassword, use_tls): + """Message sending dispatcher. + """ + if smtpserver.startswith('/'): + # Use the sendmail tool + __send_message_sendmail(smtpserver, msg) + 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) + def __build_address_headers(msg, options, extra_cc = []): """Build the address headers and check existing headers in the template. """ - def __replace_header(header, addr): - if addr: - crt_addr = msg[header] - del msg[header] - - if crt_addr: - msg[header] = address_or_alias(', '.join([crt_addr, addr])) - else: - msg[header] = address_or_alias(addr) + 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()) to_addr = '' cc_addr = '' + extra_cc_addr = '' bcc_addr = '' autobcc = config.get('stgit.autobcc') or '' @@ -205,25 +261,44 @@ def __build_address_headers(msg, options, extra_cc = []): if options.to: to_addr = ', '.join(options.to) if options.cc: - cc_addr = ', '.join(options.cc + extra_cc) - elif extra_cc: - cc_addr = ', '.join(extra_cc) + cc_addr = ', '.join(options.cc) + if extra_cc: + extra_cc_addr = ', '.join(extra_cc) if options.bcc: bcc_addr = ', '.join(options.bcc + [autobcc]) elif autobcc: bcc_addr = autobcc - __replace_header('To', to_addr) - __replace_header('Cc', cc_addr) - __replace_header('Bcc', bcc_addr) + # 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)) + + # --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') def __get_signers_list(msg): """Return the address list generated from signed-off-by and acked-by lines in the message. """ addr_list = [] - - r = re.compile('^(signed-off-by|acked-by):\s+(.+)$', re.I) + tags = '%s|%s|%s|%s|%s|%s|%s' % ( + 'signed-off-by', + 'acked-by', + 'cc', + 'reviewed-by', + 'reported-by', + 'tested-by', + 'reported-and-tested-by') + regex = '^(%s):\s+(.+)$' % tags + + r = re.compile(regex, re.I) for line in msg.split('\n'): m = r.match(line) if m: @@ -238,9 +313,11 @@ def __build_extra_headers(msg, msg_id, ref_id = None): msg['Date'] = email.Utils.formatdate(localtime = True) msg['Message-ID'] = msg_id if ref_id: + # make sure the ref id has the angle brackets + ref_id = '<%s>' % ref_id.strip(' \t\n<>') msg['In-Reply-To'] = ref_id msg['References'] = ref_id - msg['User-Agent'] = 'StGIT/%s' % version.version + msg['User-Agent'] = 'StGit/%s' % version.version def __encode_message(msg): # 7 or 8 bit encoding @@ -262,7 +339,11 @@ def __encode_message(msg): msg.replace_header(header, new_val) # encode the body and set the MIME and encoding headers - msg.set_charset(charset) + if msg.is_multipart(): + for p in msg.get_payload(): + p.set_charset(charset) + else: + msg.set_charset(charset) def __edit_message(msg): fname = '.stgitmail.txt' @@ -272,22 +353,7 @@ def __edit_message(msg): f.write(msg) f.close() - # the editor - editor = config.get('stgit.editor') - if editor: - pass - elif 'EDITOR' in os.environ: - editor = os.environ['EDITOR'] - else: - editor = 'vi' - editor += ' %s' % fname - - print 'Invoking the editor: "%s"...' % editor, - sys.stdout.flush() - err = os.system(editor) - if err: - raise CmdException, 'editor failed, exit code: %d' % err - print 'done' + call_editor(fname) # read the message back f = file(fname) @@ -296,7 +362,7 @@ def __edit_message(msg): return msg -def __build_cover(tmpl, total_nr, msg_id, options): +def __build_cover(tmpl, patches, msg_id, options): """Build the cover message (series description) to be sent via SMTP """ sender = __get_sender() @@ -309,11 +375,15 @@ def __build_cover(tmpl, total_nr, msg_id, options): if options.prefix: prefix_str = options.prefix + ' ' else: - prefix_str = '' + confprefix = config.get('stgit.mail.prefix') + if confprefix: + prefix_str = confprefix + ' ' + else: + prefix_str = '' - total_nr_str = str(total_nr) + total_nr_str = str(len(patches)) patch_nr_str = '0'.zfill(len(total_nr_str)) - if total_nr > 1: + if len(patches) > 1: number_str = ' %s/%s' % (patch_nr_str, total_nr_str) else: number_str = '' @@ -329,7 +399,13 @@ def __build_cover(tmpl, total_nr, msg_id, options): 'prefix': prefix_str, 'patchnr': patch_nr_str, 'totalnr': total_nr_str, - 'number': number_str} + 'number': number_str, + 'shortlog': stack.shortlog(crt_series.get_patch(p) + for p in patches), + 'diffstat': gitlib.diffstat(git.diff( + rev1 = git_id(crt_series, '%s^' % patches[0]), + rev2 = git_id(crt_series, '%s' % patches[-1]), + diff_flags = options.diff_flags))} try: msg_string = tmpl % tmpl_dict @@ -360,11 +436,16 @@ def __build_message(tmpl, patch, patch_nr, total_nr, msg_id, ref_id, options): """ p = crt_series.get_patch(patch) - descr = p.get_description().strip() - descr_lines = descr.split('\n') + if p.get_description(): + descr = p.get_description().strip() + else: + # provide a place holder and force the edit message option on + descr = '' + options.edit_patches = True - short_descr = descr_lines[0].rstrip() - long_descr = '\n'.join(descr_lines[1:]).lstrip() + descr_lines = descr.split('\n') + short_descr = descr_lines[0].strip() + long_descr = '\n'.join(l.rstrip() for l in descr_lines[1:]).lstrip('\n') authname = p.get_authname(); authemail = p.get_authemail(); @@ -387,15 +468,22 @@ def __build_message(tmpl, patch, patch_nr, total_nr, msg_id, ref_id, options): if options.prefix: prefix_str = options.prefix + ' ' else: - prefix_str = '' - + confprefix = config.get('stgit.mail.prefix') + if confprefix: + prefix_str = confprefix + ' ' + else: + prefix_str = '' + total_nr_str = str(total_nr) patch_nr_str = str(patch_nr).zfill(len(total_nr_str)) - if total_nr > 1: + if not options.unrelated and total_nr > 1: number_str = ' %s/%s' % (patch_nr_str, total_nr_str) else: number_str = '' + diff = git.diff(rev1 = git_id(crt_series, '%s^' % patch), + rev2 = git_id(crt_series, '%s' % patch), + diff_flags = options.diff_flags) tmpl_dict = {'patch': patch, 'sender': sender, # for backward template compatibility @@ -404,10 +492,8 @@ def __build_message(tmpl, patch, patch_nr, total_nr, msg_id, ref_id, options): 'longdescr': long_descr, # for backward template compatibility 'endofheaders': '', - 'diff': git.diff(rev1 = git_id('%s//bottom' % patch), - rev2 = git_id('%s//top' % patch)), - 'diffstat': git.diffstat(rev1 = git_id('%s//bottom'%patch), - rev2 = git_id('%s//top' % patch)), + 'diff': diff, + 'diffstat': gitlib.diffstat(diff), # for backward template compatibility 'date': '', 'version': version_str, @@ -459,7 +545,7 @@ def func(parser, options, args): """Send the patches by e-mail using the patchmail.tmpl file as a template """ - smtpserver = config.get('stgit.smtpserver') + smtpserver = options.smtp_server or config.get('stgit.smtpserver') applied = crt_series.get_applied() @@ -471,27 +557,45 @@ def func(parser, options, args): else: raise CmdException, 'Incorrect options. Unknown patches to send' + # early test for sender identity + __get_sender() + + out.start('Checking the validity of the patches') + for p in patches: + if crt_series.empty_patch(p): + 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): - raise CmdException, 'SMTP username supplied, password needed' + smtppassword = getpass.getpass("Please enter SMTP password: ") total_nr = len(patches) if total_nr == 0: raise CmdException, 'No patches to send' - if options.noreply: - ref_id = None - else: + if options.refid: + if options.noreply or options.unrelated: + raise CmdException, \ + '--refid option not allowed with --noreply or --unrelated' ref_id = options.refid + 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: + if options.unrelated: + raise CmdException, 'cover sending not allowed with --unrelated' + # find the template file if options.cover: tmpl = file(options.cover).read() @@ -501,7 +605,7 @@ def func(parser, options, args): raise CmdException, 'No cover message template file found' msg_id = email.Utils.make_msgid('stgit') - msg = __build_cover(tmpl, total_nr, msg_id, options) + msg = __build_cover(tmpl, patches, msg_id, options) from_addr, to_addr_list = __parse_addresses(msg) msg_string = msg.as_string(options.mbox) @@ -511,19 +615,21 @@ def func(parser, options, args): ref_id = msg_id if options.mbox: - print msg_string + out.stdout_raw(msg_string + '\n') else: - print 'Sending the cover message...', - sys.stdout.flush() + out.start('Sending the cover message') __send_message(smtpserver, from_addr, to_addr_list, msg_string, - sleep, smtpuser, smtppassword) - print 'done' + sleep, smtpuser, smtppassword, smtpusetls) + out.done() # send the patches if options.template: tmpl = file(options.template).read() else: - tmpl = templates.get_template('patchmail.tmpl') + if options.attach: + tmpl = templates.get_template('mailattch.tmpl') + else: + tmpl = templates.get_template('patchmail.tmpl') if not tmpl: raise CmdException, 'No e-mail template file found' @@ -536,14 +642,13 @@ def func(parser, options, args): msg_string = msg.as_string(options.mbox) # subsequent e-mails are seen as replies to the first one - if not options.noreply and not ref_id: + if not options.noreply and not options.unrelated and not ref_id: ref_id = msg_id if options.mbox: - print msg_string + out.stdout_raw(msg_string + '\n') else: - print 'Sending patch "%s"...' % p, - sys.stdout.flush() + out.start('Sending patch "%s"' % p) __send_message(smtpserver, from_addr, to_addr_list, msg_string, - sleep, smtpuser, smtppassword) - print 'done' + sleep, smtpuser, smtppassword, smtpusetls) + out.done()