2 Copyright (C) 2005, Catalin Marinas <catalin.marinas@gmail.com>
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License version 2 as
6 published by the Free Software Foundation.
8 This program is distributed in the hope that it will be useful,
9 but WITHOUT ANY WARRANTY; without even the implied warranty of
10 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 GNU General Public License for more details.
13 You should have received a copy of the GNU General Public License
14 along with this program; if not, write to the Free Software
15 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 import sys, os, re, time, datetime, socket, smtplib, getpass
19 import email, email.Utils, email.Header
20 from optparse import OptionParser, make_option
22 from stgit.commands.common import *
23 from stgit.utils import *
24 from stgit.out import *
25 from stgit import stack, git, version, templates
26 from stgit.config import config
29 help = 'send a patch or series of patches by e-mail'
30 usage = """%prog [options] [<patch1>] [<patch2>] [<patch3>..<patch4>]
32 Send a patch or a range of patches by e-mail using the SMTP server
33 specified by the 'stgit.smtpserver' configuration option, or the
34 '--smtp-server' command line option. The From address and the e-mail
35 format are generated from the template file passed as argument to
36 '--template' (defaulting to '.git/patchmail.tmpl' or
37 '~/.stgit/templates/patchmail.tmpl' or
38 '/usr/share/stgit/templates/patchmail.tmpl'). A patch can be sent as
39 attachment using the --attach option in which case the 'mailattch.tmpl'
40 template will be used instead of 'patchmail.tmpl'.
42 The To/Cc/Bcc addresses can either be added to the template file or
43 passed via the corresponding command line options. They can be e-mail
44 addresses or aliases which are automatically expanded to the values
45 stored in the [mail "alias"] section of GIT configuration files.
47 A preamble e-mail can be sent using the '--cover' and/or
48 '--edit-cover' options. The first allows the user to specify a file to
49 be used as a template. The latter option will invoke the editor on the
50 specified file (defaulting to '.git/covermail.tmpl' or
51 '~/.stgit/templates/covermail.tmpl' or
52 '/usr/share/stgit/templates/covermail.tmpl').
54 All the subsequent e-mails appear as replies to the first e-mail sent
55 (either the preamble or the first patch). E-mails can be seen as
56 replies to a different e-mail by using the '--refid' option.
58 SMTP authentication is also possible with '--smtp-user' and
59 '--smtp-password' options, also available as configuration settings:
60 'smtpuser' and 'smtppassword'. TLS encryption can be enabled by
61 '--smtp-tls' option and 'smtptls' setting.
63 The following variables are accepted by both the preamble and the
64 patch e-mail templates:
66 %(diffstat)s - diff statistics
67 %(number)s - empty if only one patch is sent or ' patchnr/totalnr'
68 %(patchnr)s - patch number
69 %(sender)s - 'sender' or 'authname <authemail>' as per the config file
70 %(totalnr)s - total number of patches to be sent
71 %(version)s - ' version' string passed on the command line (or empty)
73 In addition to the common variables, the preamble e-mail template
74 accepts the following:
76 %(shortlog)s - first line of each patch description, listed by author
78 In addition to the common variables, the patch e-mail template accepts
81 %(authdate)s - patch creation date
82 %(authemail)s - author's email
83 %(authname)s - author's name
84 %(commemail)s - committer's e-mail
85 %(commname)s - committer's name
86 %(diff)s - unified diff of the patch
87 %(fromauth)s - 'From: author\\n\\n' if different from sender
88 %(longdescr)s - the rest of the patch description, after the first line
89 %(patch)s - patch name
90 %(prefix)s - 'prefix ' string passed on the command line
91 %(shortdescr)s - the first line of the patch description"""
93 directory = DirectoryHasRepository()
94 options = [make_option('-a', '--all',
95 help = 'e-mail all the applied patches',
96 action = 'store_true'),
98 help = 'add TO to the To: list',
101 help = 'add CC to the Cc: list',
104 help = 'add BCC to the Bcc: list',
106 make_option('--auto',
107 help = 'automatically cc the patch signers',
108 action = 'store_true'),
109 make_option('--noreply',
110 help = 'do not send subsequent messages as replies',
111 action = 'store_true'),
112 make_option('--unrelated',
113 help = 'send patches without sequence numbering',
114 action = 'store_true'),
115 make_option('--attach',
116 help = 'send a patch as attachment',
117 action = 'store_true'),
118 make_option('-v', '--version', metavar = 'VERSION',
119 help = 'add VERSION to the [PATCH ...] prefix'),
120 make_option('--prefix', metavar = 'PREFIX',
121 help = 'add PREFIX to the [... PATCH ...] prefix'),
122 make_option('-t', '--template', metavar = 'FILE',
123 help = 'use FILE as the message template'),
124 make_option('-c', '--cover', metavar = 'FILE',
125 help = 'send FILE as the cover message'),
126 make_option('-e', '--edit-cover',
127 help = 'edit the cover message before sending',
128 action = 'store_true'),
129 make_option('-E', '--edit-patches',
130 help = 'edit each patch before sending',
131 action = 'store_true'),
132 make_option('-s', '--sleep', type = 'int', metavar = 'SECONDS',
133 help = 'sleep for SECONDS between e-mails sending'),
134 make_option('--refid',
135 help = 'use REFID as the reference id'),
136 make_option('--smtp-server', metavar = 'HOST[:PORT]',
137 help = 'SMTP server to use for sending mail'),
138 make_option('-u', '--smtp-user', metavar = 'USER',
139 help = 'username for SMTP authentication'),
140 make_option('-p', '--smtp-password', metavar = 'PASSWORD',
141 help = 'username for SMTP authentication'),
142 make_option('-T', '--smtp-tls',
143 help = 'use SMTP with TLS encryption',
144 action = 'store_true'),
145 make_option('-b', '--branch',
146 help = 'use BRANCH instead of the default one'),
147 make_option('-O', '--diff-opts',
148 help = 'options to pass to git-diff'),
149 make_option('-m', '--mbox',
150 help = 'generate an mbox file instead of sending',
151 action = 'store_true')]
155 """Return the 'authname <authemail>' string as read from the
158 sender=config.get('stgit.sender')
161 sender = str(git.user())
162 except git.GitException:
163 sender = str(git.author())
166 raise CmdException, 'unknown sender details'
168 return address_or_alias(sender)
170 def __parse_addresses(msg):
171 """Return a two elements tuple: (from, [to])
173 def __addr_list(msg, header):
174 return [name_addr[1] for name_addr in
175 email.Utils.getaddresses(msg.get_all(header, []))]
177 from_addr_list = __addr_list(msg, 'From')
178 if len(from_addr_list) == 0:
179 raise CmdException, 'No "From" address'
181 to_addr_list = __addr_list(msg, 'To') + __addr_list(msg, 'Cc') \
182 + __addr_list(msg, 'Bcc')
183 if len(to_addr_list) == 0:
184 raise CmdException, 'No "To/Cc/Bcc" addresses'
186 return (from_addr_list[0], to_addr_list)
188 def __send_message(smtpserver, from_addr, to_addr_list, msg, sleep,
189 smtpuser, smtppassword, use_tls):
190 """Send the message using the given SMTP server
193 s = smtplib.SMTP(smtpserver)
194 except Exception, err:
195 raise CmdException, str(err)
199 if smtpuser and smtppassword:
202 if not hasattr(socket, 'ssl'):
203 raise CmdException, "cannot use TLS - no SSL support in Python"
206 s.login(smtpuser, smtppassword)
208 result = s.sendmail(from_addr, to_addr_list, msg)
210 print "mail server refused delivery for the following recipients: %s" % result
211 # give recipients a chance of receiving patches in the correct order
213 except Exception, err:
214 raise CmdException, str(err)
218 def __build_address_headers(msg, options, extra_cc = []):
219 """Build the address headers and check existing headers in the
222 def __replace_header(header, addr):
224 crt_addr = msg[header]
228 msg[header] = address_or_alias(', '.join([crt_addr, addr]))
230 msg[header] = address_or_alias(addr)
236 autobcc = config.get('stgit.autobcc') or ''
239 to_addr = ', '.join(options.to)
241 cc_addr = ', '.join(options.cc + extra_cc)
242 cc_addr = ', '.join(options.cc + extra_cc)
244 cc_addr = ', '.join(extra_cc)
246 bcc_addr = ', '.join(options.bcc + [autobcc])
250 __replace_header('To', to_addr)
251 __replace_header('Cc', cc_addr)
252 __replace_header('Bcc', bcc_addr)
254 def __get_signers_list(msg):
255 """Return the address list generated from signed-off-by and
256 acked-by lines in the message.
260 r = re.compile('^(signed-off-by|acked-by|cc):\s+(.+)$', re.I)
261 for line in msg.split('\n'):
264 addr_list.append(m.expand('\g<2>'))
268 def __build_extra_headers(msg, msg_id, ref_id = None):
269 """Build extra email headers and encoding
272 msg['Date'] = email.Utils.formatdate(localtime = True)
273 msg['Message-ID'] = msg_id
275 # make sure the ref id has the angle brackets
276 ref_id = '<%s>' % ref_id.strip(' \t\n<>')
277 msg['In-Reply-To'] = ref_id
278 msg['References'] = ref_id
279 msg['User-Agent'] = 'StGIT/%s' % version.version
281 def __encode_message(msg):
282 # 7 or 8 bit encoding
283 charset = email.Charset.Charset('utf-8')
284 charset.body_encoding = None
287 for header, value in msg.items():
289 for word in value.split(' '):
291 uword = unicode(word, 'utf-8')
292 except UnicodeDecodeError:
293 # maybe we should try a different encoding or report
294 # the error. At the moment, we just ignore it
296 words.append(email.Header.Header(uword).encode())
297 new_val = ' '.join(words)
298 msg.replace_header(header, new_val)
300 # encode the body and set the MIME and encoding headers
301 if msg.is_multipart():
302 for p in msg.get_payload():
303 p.set_charset(charset)
305 msg.set_charset(charset)
307 def __edit_message(msg):
308 fname = '.stgitmail.txt'
310 # create the initial file
317 # read the message back
324 def __build_cover(tmpl, patches, msg_id, options):
325 """Build the cover message (series description) to be sent via SMTP
327 sender = __get_sender()
330 version_str = ' %s' % options.version
335 prefix_str = options.prefix + ' '
337 confprefix = config.get('stgit.mail.prefix')
339 prefix_str = confprefix + ' '
343 total_nr_str = str(len(patches))
344 patch_nr_str = '0'.zfill(len(total_nr_str))
346 number_str = ' %s/%s' % (patch_nr_str, total_nr_str)
350 tmpl_dict = {'sender': sender,
351 # for backward template compatibility
352 'maintainer': sender,
353 # for backward template compatibility
355 # for backward template compatibility
357 'version': version_str,
358 'prefix': prefix_str,
359 'patchnr': patch_nr_str,
360 'totalnr': total_nr_str,
361 'number': number_str,
362 'shortlog': stack.shortlog(crt_series.get_patch(p)
364 'diffstat': git.diffstat(
365 rev1 = git_id(crt_series, '%s//bottom' % patches[0]),
366 rev2 = git_id(crt_series, '%s//top' % patches[-1]))}
369 msg_string = tmpl % tmpl_dict
370 except KeyError, err:
371 raise CmdException, 'Unknown patch template variable: %s' \
374 raise CmdException, 'Only "%(name)s" variables are ' \
375 'supported in the patch template'
377 if options.edit_cover:
378 msg_string = __edit_message(msg_string)
380 # The Python email message
382 msg = email.message_from_string(msg_string)
383 except Exception, ex:
384 raise CmdException, 'template parsing error: %s' % str(ex)
386 __build_address_headers(msg, options)
387 __build_extra_headers(msg, msg_id, options.refid)
388 __encode_message(msg)
392 def __build_message(tmpl, patch, patch_nr, total_nr, msg_id, ref_id, options):
393 """Build the message to be sent via SMTP
395 p = crt_series.get_patch(patch)
397 descr = p.get_description().strip()
398 descr_lines = descr.split('\n')
400 short_descr = descr_lines[0].rstrip()
401 long_descr = '\n'.join(descr_lines[1:]).lstrip()
403 authname = p.get_authname();
404 authemail = p.get_authemail();
405 commname = p.get_commname();
406 commemail = p.get_commemail();
408 sender = __get_sender()
410 fromauth = '%s <%s>' % (authname, authemail)
411 if fromauth != sender:
412 fromauth = 'From: %s\n\n' % fromauth
417 version_str = ' %s' % options.version
422 prefix_str = options.prefix + ' '
424 confprefix = config.get('stgit.mail.prefix')
426 prefix_str = confprefix + ' '
430 if options.diff_opts:
431 diff_flags = options.diff_opts.split()
435 total_nr_str = str(total_nr)
436 patch_nr_str = str(patch_nr).zfill(len(total_nr_str))
437 if not options.unrelated and total_nr > 1:
438 number_str = ' %s/%s' % (patch_nr_str, total_nr_str)
442 tmpl_dict = {'patch': patch,
444 # for backward template compatibility
445 'maintainer': sender,
446 'shortdescr': short_descr,
447 'longdescr': long_descr,
448 # for backward template compatibility
451 rev1 = git_id(crt_series, '%s//bottom' % patch),
452 rev2 = git_id(crt_series, '%s//top' % patch),
453 diff_flags = diff_flags),
454 'diffstat': git.diffstat(
455 rev1 = git_id(crt_series, '%s//bottom'%patch),
456 rev2 = git_id(crt_series, '%s//top' % patch)),
457 # for backward template compatibility
459 'version': version_str,
460 'prefix': prefix_str,
461 'patchnr': patch_nr_str,
462 'totalnr': total_nr_str,
463 'number': number_str,
464 'fromauth': fromauth,
465 'authname': authname,
466 'authemail': authemail,
467 'authdate': p.get_authdate(),
468 'commname': commname,
469 'commemail': commemail}
471 for key in tmpl_dict:
472 if not tmpl_dict[key]:
476 msg_string = tmpl % tmpl_dict
477 except KeyError, err:
478 raise CmdException, 'Unknown patch template variable: %s' \
481 raise CmdException, 'Only "%(name)s" variables are ' \
482 'supported in the patch template'
484 if options.edit_patches:
485 msg_string = __edit_message(msg_string)
487 # The Python email message
489 msg = email.message_from_string(msg_string)
490 except Exception, ex:
491 raise CmdException, 'template parsing error: %s' % str(ex)
494 extra_cc = __get_signers_list(descr)
498 __build_address_headers(msg, options, extra_cc)
499 __build_extra_headers(msg, msg_id, ref_id)
500 __encode_message(msg)
504 def func(parser, options, args):
505 """Send the patches by e-mail using the patchmail.tmpl file as
508 smtpserver = options.smtp_server or config.get('stgit.smtpserver')
510 applied = crt_series.get_applied()
515 unapplied = crt_series.get_unapplied()
516 patches = parse_patches(args, applied + unapplied, len(applied))
518 raise CmdException, 'Incorrect options. Unknown patches to send'
520 smtppassword = options.smtp_password or config.get('stgit.smtppassword')
521 smtpuser = options.smtp_user or config.get('stgit.smtpuser')
522 smtpusetls = options.smtp_tls or config.get('stgit.smtptls') == 'yes'
524 if (smtppassword and not smtpuser):
525 raise CmdException, 'SMTP password supplied, username needed'
526 if (smtpusetls and not smtpuser):
527 raise CmdException, 'SMTP over TLS requested, username needed'
528 if (smtpuser and not smtppassword):
529 smtppassword = getpass.getpass("Please enter SMTP password: ")
531 total_nr = len(patches)
533 raise CmdException, 'No patches to send'
536 if options.noreply or options.unrelated:
537 raise CmdException, \
538 '--refid option not allowed with --noreply or --unrelated'
539 ref_id = options.refid
543 sleep = options.sleep or config.getint('stgit.smtpdelay')
545 # send the cover message (if any)
546 if options.cover or options.edit_cover:
547 if options.unrelated:
548 raise CmdException, 'cover sending not allowed with --unrelated'
550 # find the template file
552 tmpl = file(options.cover).read()
554 tmpl = templates.get_template('covermail.tmpl')
556 raise CmdException, 'No cover message template file found'
558 msg_id = email.Utils.make_msgid('stgit')
559 msg = __build_cover(tmpl, patches, msg_id, options)
560 from_addr, to_addr_list = __parse_addresses(msg)
562 msg_string = msg.as_string(options.mbox)
564 # subsequent e-mails are seen as replies to the first one
565 if not options.noreply:
569 out.stdout_raw(msg_string + '\n')
571 out.start('Sending the cover message')
572 __send_message(smtpserver, from_addr, to_addr_list, msg_string,
573 sleep, smtpuser, smtppassword, smtpusetls)
578 tmpl = file(options.template).read()
581 tmpl = templates.get_template('mailattch.tmpl')
583 tmpl = templates.get_template('patchmail.tmpl')
585 raise CmdException, 'No e-mail template file found'
587 for (p, patch_nr) in zip(patches, range(1, len(patches) + 1)):
588 msg_id = email.Utils.make_msgid('stgit')
589 msg = __build_message(tmpl, p, patch_nr, total_nr, msg_id, ref_id,
591 from_addr, to_addr_list = __parse_addresses(msg)
593 msg_string = msg.as_string(options.mbox)
595 # subsequent e-mails are seen as replies to the first one
596 if not options.noreply and not options.unrelated and not ref_id:
600 out.stdout_raw(msg_string + '\n')
602 out.start('Sending patch "%s"' % p)
603 __send_message(smtpserver, from_addr, to_addr_list, msg_string,
604 sleep, smtpuser, smtppassword, smtpusetls)