X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/stgit/blobdiff_plain/e5bdb1fecace36563715494a86261d32503b475e..79ef25ac491bb8c6aa4510cce00f09f06b8bfdd2:/stgit/commands/mail.py diff --git a/stgit/commands/mail.py b/stgit/commands/mail.py index 7875fac..f256725 100644 --- a/stgit/commands/mail.py +++ b/stgit/commands/mail.py @@ -15,12 +15,13 @@ 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.commands.common import * from stgit.utils import * +from stgit.out import * from stgit import stack, git, version, templates from stgit.config import config @@ -28,14 +29,20 @@ 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 or -'/usr/share/stgit/templates/patchmail.tmpl'). The To/Cc/Bcc addresses -can either be added to the template file or passed via the -corresponding command line options. +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. 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 +addresses or aliases which are automatically expanded to the values +stored in the [mail "alias"] section of GIT configuration files. A preamble e-mail can be sent using the '--cover' and/or '--edit-cover' options. The first allows the user to specify a file to @@ -50,31 +57,40 @@ 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 - %(maintainer)s - 'authname ' as read from 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' - %(authname)s - author's name - %(authemail)s - author's email + %(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: + + %(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 - %(commname)s - committer's name + %(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""" -For the preamble e-mail template, only the %(maintainer)s, -%(version)s, %(patchnr)s, %(totalnr)s and %(number)s variables are -supported.""" - +directory = DirectoryHasRepository() options = [make_option('-a', '--all', help = 'e-mail all the applied patches', action = 'store_true'), @@ -93,6 +109,12 @@ options = [make_option('-a', '--all', make_option('--noreply', help = 'do not send subsequent messages as replies', action = 'store_true'), + make_option('--unrelated', + help = 'send patches without sequence numbering', + action = 'store_true'), + make_option('--attach', + help = 'send a patch as attachment', + action = 'store_true'), make_option('-v', '--version', metavar = 'VERSION', help = 'add VERSION to the [PATCH ...] prefix'), make_option('--prefix', metavar = 'PREFIX', @@ -111,54 +133,60 @@ options = [make_option('-a', '--all', help = 'sleep for SECONDS between e-mails sending'), make_option('--refid', help = 'use REFID as the reference id'), + make_option('--smtp-server', metavar = 'HOST[:PORT]', + help = 'SMTP server to use for sending mail'), 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('-T', '--smtp-tls', + help = 'use SMTP with TLS encryption', + action = 'store_true'), make_option('-b', '--branch', help = 'use BRANCH instead of the default one'), + make_option('-O', '--diff-opts', + help = 'options to pass to git-diff'), make_option('-m', '--mbox', help = 'generate an mbox file instead of sending', action = 'store_true')] -def __get_maintainer(): +def __get_sender(): """Return the 'authname ' string as read from the configuration file """ - if config.has_option('stgit', 'authname') \ - and config.has_option('stgit', 'authemail'): - return '%s <%s>' % (config.get('stgit', 'authname'), - config.get('stgit', 'authemail')) - else: - return None + sender=config.get('stgit.sender') + if not sender: + try: + sender = str(git.user()) + except git.GitException: + sender = str(git.author()) + + if not sender: + raise CmdException, 'unknown sender details' -def __parse_addresses(addresses): + return address_or_alias(sender) + +def __parse_addresses(msg): """Return a two elements tuple: (from, [to]) """ - def __addr_list(addrs): - m = re.search('[^@\s<,]+@[^>\s,]+', addrs); - if (m == None): - return [] - return [ m.group() ] + __addr_list(addrs[m.end():]) - - from_addr_list = [] - to_addr_list = [] - for line in addresses.split('\n'): - if re.match('from:\s+', line, re.I): - from_addr_list += __addr_list(line) - elif re.match('(to|cc|bcc):\s+', line, re.I): - to_addr_list += __addr_list(line) + 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' + + to_addr_list = __addr_list(msg, 'To') + __addr_list(msg, 'Cc') \ + + __addr_list(msg, 'Bcc') if len(to_addr_list) == 0: raise CmdException, 'No "To/Cc/Bcc" addresses' return (from_addr_list[0], to_addr_list) def __send_message(smtpserver, from_addr, to_addr_list, msg, sleep, - smtpuser, smtppassword): + smtpuser, smtppassword, use_tls): """Send the message using the given SMTP server """ try: @@ -170,9 +198,16 @@ 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) + result = s.sendmail(from_addr, to_addr_list, msg) + if len(result): + print "mail server refused delivery for the following recipients: %s" % result # give recipients a chance of receiving patches in the correct order time.sleep(sleep) except Exception, err: @@ -190,23 +225,21 @@ def __build_address_headers(msg, options, extra_cc = []): del msg[header] if crt_addr: - msg[header] = ', '.join([crt_addr, addr]) + msg[header] = address_or_alias(', '.join([crt_addr, addr])) else: - msg[header] = addr + msg[header] = address_or_alias(addr) to_addr = '' cc_addr = '' bcc_addr = '' - if config.has_option('stgit', 'autobcc'): - autobcc = config.get('stgit', 'autobcc') - else: - autobcc = '' + autobcc = config.get('stgit.autobcc') or '' if options.to: to_addr = ', '.join(options.to) if options.cc: cc_addr = ', '.join(options.cc + extra_cc) + cc_addr = ', '.join(options.cc + extra_cc) elif extra_cc: cc_addr = ', '.join(extra_cc) if options.bcc: @@ -224,7 +257,7 @@ def __get_signers_list(msg): """ addr_list = [] - r = re.compile('^(signed-off-by|acked-by):\s+(.+)$', re.I) + r = re.compile('^(signed-off-by|acked-by|cc):\s+(.+)$', re.I) for line in msg.split('\n'): m = r.match(line) if m: @@ -239,6 +272,8 @@ 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 @@ -263,9 +298,13 @@ 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): +def __edit_message(msg): fname = '.stgitmail.txt' # create the initial file @@ -273,18 +312,7 @@ def edit_message(msg): f.write(msg) f.close() - # the editor - if config.has_option('stgit', 'editor'): - editor = config.get('stgit', 'editor') - elif 'EDITOR' in os.environ: - editor = os.environ['EDITOR'] - else: - editor = 'vi' - editor += ' %s' % fname - - print 'Invoking the editor: "%s"...' % editor, - sys.stdout.flush() - print 'done (exit code: %d)' % os.system(editor) + call_editor(fname) # read the message back f = file(fname) @@ -293,12 +321,10 @@ 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 """ - maintainer = __get_maintainer() - if not maintainer: - maintainer = '' + sender = __get_sender() if options.version: version_str = ' %s' % options.version @@ -308,16 +334,22 @@ 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 = '' - tmpl_dict = {'maintainer': maintainer, + tmpl_dict = {'sender': sender, + # for backward template compatibility + 'maintainer': sender, # for backward template compatibility 'endofheaders': '', # for backward template compatibility @@ -326,7 +358,12 @@ 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': git.diffstat( + rev1 = git_id(crt_series, '%s//bottom' % patches[0]), + rev2 = git_id(crt_series, '%s//top' % patches[-1]))} try: msg_string = tmpl % tmpl_dict @@ -337,6 +374,9 @@ def __build_cover(tmpl, total_nr, msg_id, options): raise CmdException, 'Only "%(name)s" variables are ' \ 'supported in the patch template' + if options.edit_cover: + msg_string = __edit_message(msg_string) + # The Python email message try: msg = email.message_from_string(msg_string) @@ -347,12 +387,7 @@ def __build_cover(tmpl, total_nr, msg_id, options): __build_extra_headers(msg, msg_id, options.refid) __encode_message(msg) - msg_string = msg.as_string(options.mbox) - - if options.edit_cover: - msg_string = edit_message(msg_string) - - return msg_string.strip('\n') + return msg def __build_message(tmpl, patch, patch_nr, total_nr, msg_id, ref_id, options): """Build the message to be sent via SMTP @@ -365,9 +400,18 @@ def __build_message(tmpl, patch, patch_nr, total_nr, msg_id, ref_id, options): short_descr = descr_lines[0].rstrip() long_descr = '\n'.join(descr_lines[1:]).lstrip() - maintainer = __get_maintainer() - if not maintainer: - maintainer = '%s <%s>' % (p.get_commname(), p.get_commemail()) + authname = p.get_authname(); + authemail = p.get_authemail(); + commname = p.get_commname(); + commemail = p.get_commemail(); + + sender = __get_sender() + + fromauth = '%s <%s>' % (authname, authemail) + if fromauth != sender: + fromauth = 'From: %s\n\n' % fromauth + else: + fromauth = '' if options.version: version_str = ' %s' % options.version @@ -377,25 +421,39 @@ 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 = '' + if options.diff_opts: + diff_flags = options.diff_opts.split() + else: + diff_flags = [] + 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 = '' tmpl_dict = {'patch': patch, - 'maintainer': maintainer, + 'sender': sender, + # for backward template compatibility + 'maintainer': sender, 'shortdescr': short_descr, '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': git.diff( + rev1 = git_id(crt_series, '%s//bottom' % patch), + rev2 = git_id(crt_series, '%s//top' % patch), + diff_flags = diff_flags), + 'diffstat': git.diffstat( + rev1 = git_id(crt_series, '%s//bottom'%patch), + rev2 = git_id(crt_series, '%s//top' % patch)), # for backward template compatibility 'date': '', 'version': version_str, @@ -403,11 +461,12 @@ def __build_message(tmpl, patch, patch_nr, total_nr, msg_id, ref_id, options): 'patchnr': patch_nr_str, 'totalnr': total_nr_str, 'number': number_str, - 'authname': p.get_authname(), - 'authemail': p.get_authemail(), + 'fromauth': fromauth, + 'authname': authname, + 'authemail': authemail, 'authdate': p.get_authdate(), - 'commname': p.get_commname(), - 'commemail': p.get_commemail()} + 'commname': commname, + 'commemail': commemail} # change None to '' for key in tmpl_dict: if not tmpl_dict[key]: @@ -422,6 +481,9 @@ def __build_message(tmpl, patch, patch_nr, total_nr, msg_id, ref_id, options): raise CmdException, 'Only "%(name)s" variables are ' \ 'supported in the patch template' + if options.edit_patches: + msg_string = __edit_message(msg_string) + # The Python email message try: msg = email.message_from_string(msg_string) @@ -437,62 +499,60 @@ def __build_message(tmpl, patch, patch_nr, total_nr, msg_id, ref_id, options): __build_extra_headers(msg, msg_id, ref_id) __encode_message(msg) - msg_string = msg.as_string(options.mbox) - - if options.edit_patches: - msg_string = edit_message(msg_string) - - return msg_string.strip('\n') + return msg def func(parser, options, args): """Send the patches by e-mail using the patchmail.tmpl file as a template """ - smtpserver = config.get('stgit', 'smtpserver') - - smtpuser = None - smtppassword = None - if config.has_option('stgit', 'smtpuser'): - smtpuser = config.get('stgit', 'smtpuser') - if config.has_option('stgit', 'smtppassword'): - smtppassword = config.get('stgit', 'smtppassword') + smtpserver = options.smtp_server or config.get('stgit.smtpserver') applied = crt_series.get_applied() if options.all: patches = applied elif len(args) >= 1: - patches = parse_patches(args, applied) + unapplied = crt_series.get_unapplied() + patches = parse_patches(args, applied + unapplied, len(applied)) else: raise CmdException, 'Incorrect options. Unknown patches to send' - if options.smtp_password: - smtppassword = options.smtp_password + 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() - if options.smtp_user: - smtpuser = options.smtp_user + 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 - - if options.sleep != None: - sleep = options.sleep else: - sleep = config.getint('stgit', 'smtpdelay') + 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() @@ -502,28 +562,31 @@ 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) + # subsequent e-mails are seen as replies to the first one if not options.noreply: ref_id = msg_id if options.mbox: - print msg - print + out.stdout_raw(msg_string + '\n') else: - print 'Sending the cover message...', - sys.stdout.flush() - __send_message(smtpserver, from_addr, to_addr_list, msg, sleep, - smtpuser, smtppassword) - print 'done' + 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() 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' @@ -533,16 +596,16 @@ def func(parser, options, args): options) from_addr, to_addr_list = __parse_addresses(msg) + 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 - print + out.stdout_raw(msg_string + '\n') else: - print 'Sending patch "%s"...' % p, - sys.stdout.flush() - __send_message(smtpserver, from_addr, to_addr_list, msg, sleep, - smtpuser, smtppassword) - print 'done' + out.start('Sending patch "%s"' % p) + __send_message(smtpserver, from_addr, to_addr_list, msg_string, + sleep, smtpuser, smtppassword, smtpusetls) + out.done()