stg mail: reorder __build_[message|cover] parameters
[stgit] / stgit / commands / mail.py
1 __copyright__ = """
2 Copyright (C) 2005, Catalin Marinas <catalin.marinas@gmail.com>
3
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.
7
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.
12
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
16 """
17
18 import sys, os, re, time, datetime, socket, smtplib, getpass
19 import email, email.Utils, email.Header
20 from stgit.argparse import opt
21 from stgit.commands.common import *
22 from stgit.utils import *
23 from stgit.out import *
24 from stgit import argparse, stack, git, version, templates
25 from stgit.config import config
26 from stgit.run import Run
27 from stgit.lib import git as gitlib
28
29 help = 'Send a patch or series of patches by e-mail'
30 kind = 'patch'
31 usage = [' [options] [--] [<patch1>] [<patch2>] [<patch3>..<patch4>]']
32 description = r"""
33 Send a patch or a range of patches by e-mail using the SMTP server
34 specified by the 'stgit.smtpserver' configuration option, or the
35 '--smtp-server' command line option. This option can also be an
36 absolute path to 'sendmail' followed by command line arguments.
37
38 The From address and the e-mail format are generated from the template
39 file passed as argument to '--template' (defaulting to
40 '.git/patchmail.tmpl' or '~/.stgit/templates/patchmail.tmpl' or
41 '/usr/share/stgit/templates/patchmail.tmpl'). A patch can be sent as
42 attachment using the --attach option in which case the
43 'mailattch.tmpl' template will be used instead of 'patchmail.tmpl'.
44
45 The To/Cc/Bcc addresses can either be added to the template file or
46 passed via the corresponding command line options. They can be e-mail
47 addresses or aliases which are automatically expanded to the values
48 stored in the [mail "alias"] section of GIT configuration files.
49
50 A preamble e-mail can be sent using the '--cover' and/or
51 '--edit-cover' options. The first allows the user to specify a file to
52 be used as a template. The latter option will invoke the editor on the
53 specified file (defaulting to '.git/covermail.tmpl' or
54 '~/.stgit/templates/covermail.tmpl' or
55 '/usr/share/stgit/templates/covermail.tmpl').
56
57 All the subsequent e-mails appear as replies to the first e-mail sent
58 (either the preamble or the first patch). E-mails can be seen as
59 replies to a different e-mail by using the '--refid' option.
60
61 SMTP authentication is also possible with '--smtp-user' and
62 '--smtp-password' options, also available as configuration settings:
63 'smtpuser' and 'smtppassword'. TLS encryption can be enabled by
64 '--smtp-tls' option and 'smtptls' setting.
65
66 The following variables are accepted by both the preamble and the
67 patch e-mail templates:
68
69 %(diffstat)s - diff statistics
70 %(number)s - empty if only one patch is sent or ' patchnr/totalnr'
71 %(patchnr)s - patch number
72 %(sender)s - 'sender' or 'authname <authemail>' as per the config file
73 %(totalnr)s - total number of patches to be sent
74 %(version)s - ' version' string passed on the command line (or empty)
75
76 In addition to the common variables, the preamble e-mail template
77 accepts the following:
78
79 %(shortlog)s - first line of each patch description, listed by author
80
81 In addition to the common variables, the patch e-mail template accepts
82 the following:
83
84 %(authdate)s - patch creation date
85 %(authemail)s - author's email
86 %(authname)s - author's name
87 %(commemail)s - committer's e-mail
88 %(commname)s - committer's name
89 %(diff)s - unified diff of the patch
90 %(fromauth)s - 'From: author\n\n' if different from sender
91 %(longdescr)s - the rest of the patch description, after the first line
92 %(patch)s - patch name
93 %(prefix)s - 'prefix ' string passed on the command line
94 %(shortdescr)s - the first line of the patch description"""
95
96 args = [argparse.patch_range(argparse.applied_patches,
97 argparse.unapplied_patches,
98 argparse.hidden_patches)]
99 options = [
100 opt('-a', '--all', action = 'store_true',
101 short = 'E-mail all the applied patches'),
102 opt('--to', action = 'append',
103 short = 'Add TO to the To: list'),
104 opt('--cc', action = 'append',
105 short = 'Add CC to the Cc: list'),
106 opt('--bcc', action = 'append',
107 short = 'Add BCC to the Bcc: list'),
108 opt('--auto', action = 'store_true',
109 short = 'Automatically cc the patch signers'),
110 opt('--noreply', action = 'store_true',
111 short = 'Do not send subsequent messages as replies'),
112 opt('--unrelated', action = 'store_true',
113 short = 'Send patches without sequence numbering'),
114 opt('--attach', action = 'store_true',
115 short = 'Send a patch as attachment'),
116 opt('-v', '--version', metavar = 'VERSION',
117 short = 'Add VERSION to the [PATCH ...] prefix'),
118 opt('--prefix', metavar = 'PREFIX',
119 short = 'Add PREFIX to the [... PATCH ...] prefix'),
120 opt('-t', '--template', metavar = 'FILE',
121 short = 'Use FILE as the message template'),
122 opt('-c', '--cover', metavar = 'FILE',
123 short = 'Send FILE as the cover message'),
124 opt('-e', '--edit-cover', action = 'store_true',
125 short = 'Edit the cover message before sending'),
126 opt('-E', '--edit-patches', action = 'store_true',
127 short = 'Edit each patch before sending'),
128 opt('-s', '--sleep', type = 'int', metavar = 'SECONDS',
129 short = 'Sleep for SECONDS between e-mails sending'),
130 opt('--refid',
131 short = 'Use REFID as the reference id'),
132 opt('--smtp-server', metavar = 'HOST[:PORT] or "/path/to/sendmail -t -i"',
133 short = 'SMTP server or command to use for sending mail'),
134 opt('-u', '--smtp-user', metavar = 'USER',
135 short = 'Username for SMTP authentication'),
136 opt('-p', '--smtp-password', metavar = 'PASSWORD',
137 short = 'Password for SMTP authentication'),
138 opt('-T', '--smtp-tls', action = 'store_true',
139 short = 'Use SMTP with TLS encryption'),
140 opt('-b', '--branch', args = [argparse.stg_branches],
141 short = 'Use BRANCH instead of the default branch'),
142 opt('-m', '--mbox', action = 'store_true',
143 short = 'Generate an mbox file instead of sending')
144 ] + argparse.diff_opts_option()
145
146 directory = DirectoryHasRepository(log = False)
147
148 def __get_sender():
149 """Return the 'authname <authemail>' string as read from the
150 configuration file
151 """
152 sender=config.get('stgit.sender')
153 if not sender:
154 try:
155 sender = str(git.user())
156 except git.GitException:
157 try:
158 sender = str(git.author())
159 except git.GitException:
160 pass
161 if not sender:
162 raise CmdException, ('Unknown sender name and e-mail; you should'
163 ' for example set git config user.name and'
164 ' user.email')
165 sender = email.Utils.parseaddr(sender)
166
167 return email.Utils.formataddr(address_or_alias(sender))
168
169 def __addr_list(msg, header):
170 return [addr for name, addr in
171 email.Utils.getaddresses(msg.get_all(header, []))]
172
173 def __parse_addresses(msg):
174 """Return a two elements tuple: (from, [to])
175 """
176 from_addr_list = __addr_list(msg, 'From')
177 if len(from_addr_list) == 0:
178 raise CmdException, 'No "From" address'
179
180 to_addr_list = __addr_list(msg, 'To') + __addr_list(msg, 'Cc') \
181 + __addr_list(msg, 'Bcc')
182 if len(to_addr_list) == 0:
183 raise CmdException, 'No "To/Cc/Bcc" addresses'
184
185 return (from_addr_list[0], set(to_addr_list))
186
187 def __send_message_sendmail(sendmail, msg):
188 """Send the message using the sendmail command.
189 """
190 cmd = sendmail.split()
191 Run(*cmd).raw_input(msg).discard_output()
192
193 def __send_message_smtp(smtpserver, from_addr, to_addr_list, msg, options):
194 """Send the message using the given SMTP server
195 """
196 smtppassword = options.smtp_password or config.get('stgit.smtppassword')
197 smtpuser = options.smtp_user or config.get('stgit.smtpuser')
198 smtpusetls = options.smtp_tls or config.get('stgit.smtptls') == 'yes'
199
200 if (smtppassword and not smtpuser):
201 raise CmdException('SMTP password supplied, username needed')
202 if (smtpusetls and not smtpuser):
203 raise CmdException('SMTP over TLS requested, username needed')
204 if (smtpuser and not smtppassword):
205 smtppassword = getpass.getpass("Please enter SMTP password: ")
206
207 try:
208 s = smtplib.SMTP(smtpserver)
209 except Exception, err:
210 raise CmdException, str(err)
211
212 s.set_debuglevel(0)
213 try:
214 if smtpuser and smtppassword:
215 s.ehlo()
216 if smtpusetls:
217 if not hasattr(socket, 'ssl'):
218 raise CmdException, "cannot use TLS - no SSL support in Python"
219 s.starttls()
220 s.ehlo()
221 s.login(smtpuser, smtppassword)
222
223 result = s.sendmail(from_addr, to_addr_list, msg)
224 if len(result):
225 print "mail server refused delivery for the following recipients: %s" % result
226 except Exception, err:
227 raise CmdException, str(err)
228
229 s.quit()
230
231 def __send_message(from_addr, to_addr_list, msg, options):
232 """Message sending dispatcher.
233 """
234 smtpserver = options.smtp_server or config.get('stgit.smtpserver')
235
236 if smtpserver.startswith('/'):
237 # Use the sendmail tool
238 __send_message_sendmail(smtpserver, msg)
239 else:
240 # Use the SMTP server (we have host and port information)
241 __send_message_smtp(smtpserver, from_addr, to_addr_list, msg, options)
242
243 def __build_address_headers(msg, options, extra_cc = []):
244 """Build the address headers and check existing headers in the
245 template.
246 """
247 def __addr_pairs(msg, header, extra):
248 pairs = email.Utils.getaddresses(msg.get_all(header, []) + extra)
249 # remove pairs without an address and resolve the aliases
250 return [address_or_alias(p) for p in pairs if p[1]]
251
252 def __update_header(header, addr = '', ignore = ()):
253 addr_pairs = __addr_pairs(msg, header, [addr])
254 del msg[header]
255 # remove the duplicates and filter the addresses
256 addr_dict = dict((addr, email.Utils.formataddr((name, addr)))
257 for name, addr in addr_pairs if addr not in ignore)
258 if addr_dict:
259 msg[header] = ', '.join(addr_dict.itervalues())
260 return set(addr_dict.iterkeys())
261
262 to_addr = ''
263 cc_addr = ''
264 extra_cc_addr = ''
265 bcc_addr = ''
266
267 autobcc = config.get('stgit.autobcc') or ''
268
269 if options.to:
270 to_addr = ', '.join(options.to)
271 if options.cc:
272 cc_addr = ', '.join(options.cc)
273 if extra_cc:
274 extra_cc_addr = ', '.join(extra_cc)
275 if options.bcc:
276 bcc_addr = ', '.join(options.bcc + [autobcc])
277 elif autobcc:
278 bcc_addr = autobcc
279
280 # if an address is on a header, ignore it from the rest
281 to_set = __update_header('To', to_addr)
282 cc_set = __update_header('Cc', cc_addr, to_set)
283 bcc_set = __update_header('Bcc', bcc_addr, to_set.union(cc_set))
284
285 # --auto generated addresses, don't include the sender
286 from_set = __update_header('From')
287 __update_header('Cc', extra_cc_addr, to_set.union(bcc_set).union(from_set))
288
289 # update other address headers
290 __update_header('Reply-To')
291 __update_header('Mail-Reply-To')
292 __update_header('Mail-Followup-To')
293
294 def __get_signers_list(msg):
295 """Return the address list generated from signed-off-by and
296 acked-by lines in the message.
297 """
298 addr_list = []
299 tags = '%s|%s|%s|%s|%s|%s|%s' % (
300 'signed-off-by',
301 'acked-by',
302 'cc',
303 'reviewed-by',
304 'reported-by',
305 'tested-by',
306 'reported-and-tested-by')
307 regex = '^(%s):\s+(.+)$' % tags
308
309 r = re.compile(regex, re.I)
310 for line in msg.split('\n'):
311 m = r.match(line)
312 if m:
313 addr_list.append(m.expand('\g<2>'))
314
315 return addr_list
316
317 def __build_extra_headers(msg, msg_id, ref_id = None):
318 """Build extra email headers and encoding
319 """
320 del msg['Date']
321 msg['Date'] = email.Utils.formatdate(localtime = True)
322 msg['Message-ID'] = msg_id
323 if ref_id:
324 # make sure the ref id has the angle brackets
325 ref_id = '<%s>' % ref_id.strip(' \t\n<>')
326 msg['In-Reply-To'] = ref_id
327 msg['References'] = ref_id
328 msg['User-Agent'] = 'StGit/%s' % version.version
329
330 def __encode_message(msg):
331 # 7 or 8 bit encoding
332 charset = email.Charset.Charset('utf-8')
333 charset.body_encoding = None
334
335 # encode headers
336 for header, value in msg.items():
337 words = []
338 for word in value.split(' '):
339 try:
340 uword = unicode(word, 'utf-8')
341 except UnicodeDecodeError:
342 # maybe we should try a different encoding or report
343 # the error. At the moment, we just ignore it
344 pass
345 words.append(email.Header.Header(uword).encode())
346 new_val = ' '.join(words)
347 msg.replace_header(header, new_val)
348
349 # encode the body and set the MIME and encoding headers
350 if msg.is_multipart():
351 for p in msg.get_payload():
352 p.set_charset(charset)
353 else:
354 msg.set_charset(charset)
355
356 def __edit_message(msg):
357 fname = '.stgitmail.txt'
358
359 # create the initial file
360 f = file(fname, 'w')
361 f.write(msg)
362 f.close()
363
364 call_editor(fname)
365
366 # read the message back
367 f = file(fname)
368 msg = f.read()
369 f.close()
370
371 return msg
372
373 def __build_cover(tmpl, msg_id, options, patches):
374 """Build the cover message (series description) to be sent via SMTP
375 """
376 sender = __get_sender()
377
378 if options.version:
379 version_str = ' %s' % options.version
380 else:
381 version_str = ''
382
383 if options.prefix:
384 prefix_str = options.prefix + ' '
385 else:
386 confprefix = config.get('stgit.mail.prefix')
387 if confprefix:
388 prefix_str = confprefix + ' '
389 else:
390 prefix_str = ''
391
392 total_nr_str = str(len(patches))
393 patch_nr_str = '0'.zfill(len(total_nr_str))
394 if len(patches) > 1:
395 number_str = ' %s/%s' % (patch_nr_str, total_nr_str)
396 else:
397 number_str = ''
398
399 tmpl_dict = {'sender': sender,
400 # for backward template compatibility
401 'maintainer': sender,
402 # for backward template compatibility
403 'endofheaders': '',
404 # for backward template compatibility
405 'date': '',
406 'version': version_str,
407 'prefix': prefix_str,
408 'patchnr': patch_nr_str,
409 'totalnr': total_nr_str,
410 'number': number_str,
411 'shortlog': stack.shortlog(crt_series.get_patch(p)
412 for p in reversed(patches)),
413 'diffstat': gitlib.diffstat(git.diff(
414 rev1 = git_id(crt_series, '%s^' % patches[0]),
415 rev2 = git_id(crt_series, '%s' % patches[-1]),
416 diff_flags = options.diff_flags))}
417
418 try:
419 msg_string = tmpl % tmpl_dict
420 except KeyError, err:
421 raise CmdException, 'Unknown patch template variable: %s' \
422 % err
423 except TypeError:
424 raise CmdException, 'Only "%(name)s" variables are ' \
425 'supported in the patch template'
426
427 if options.edit_cover:
428 msg_string = __edit_message(msg_string)
429
430 # The Python email message
431 try:
432 msg = email.message_from_string(msg_string)
433 except Exception, ex:
434 raise CmdException, 'template parsing error: %s' % str(ex)
435
436 __build_address_headers(msg, options)
437 __build_extra_headers(msg, msg_id, options.refid)
438 __encode_message(msg)
439
440 return msg
441
442 def __build_message(tmpl, msg_id, options, patch, patch_nr, total_nr, ref_id):
443 """Build the message to be sent via SMTP
444 """
445 p = crt_series.get_patch(patch)
446
447 if p.get_description():
448 descr = p.get_description().strip()
449 else:
450 # provide a place holder and force the edit message option on
451 descr = '<empty message>'
452 options.edit_patches = True
453
454 descr_lines = descr.split('\n')
455 short_descr = descr_lines[0].strip()
456 long_descr = '\n'.join(l.rstrip() for l in descr_lines[1:]).lstrip('\n')
457
458 authname = p.get_authname();
459 authemail = p.get_authemail();
460 commname = p.get_commname();
461 commemail = p.get_commemail();
462
463 sender = __get_sender()
464
465 fromauth = '%s <%s>' % (authname, authemail)
466 if fromauth != sender:
467 fromauth = 'From: %s\n\n' % fromauth
468 else:
469 fromauth = ''
470
471 if options.version:
472 version_str = ' %s' % options.version
473 else:
474 version_str = ''
475
476 if options.prefix:
477 prefix_str = options.prefix + ' '
478 else:
479 confprefix = config.get('stgit.mail.prefix')
480 if confprefix:
481 prefix_str = confprefix + ' '
482 else:
483 prefix_str = ''
484
485 total_nr_str = str(total_nr)
486 patch_nr_str = str(patch_nr).zfill(len(total_nr_str))
487 if not options.unrelated and total_nr > 1:
488 number_str = ' %s/%s' % (patch_nr_str, total_nr_str)
489 else:
490 number_str = ''
491
492 diff = git.diff(rev1 = git_id(crt_series, '%s^' % patch),
493 rev2 = git_id(crt_series, '%s' % patch),
494 diff_flags = options.diff_flags)
495 tmpl_dict = {'patch': patch,
496 'sender': sender,
497 # for backward template compatibility
498 'maintainer': sender,
499 'shortdescr': short_descr,
500 'longdescr': long_descr,
501 # for backward template compatibility
502 'endofheaders': '',
503 'diff': diff,
504 'diffstat': gitlib.diffstat(diff),
505 # for backward template compatibility
506 'date': '',
507 'version': version_str,
508 'prefix': prefix_str,
509 'patchnr': patch_nr_str,
510 'totalnr': total_nr_str,
511 'number': number_str,
512 'fromauth': fromauth,
513 'authname': authname,
514 'authemail': authemail,
515 'authdate': p.get_authdate(),
516 'commname': commname,
517 'commemail': commemail}
518 # change None to ''
519 for key in tmpl_dict:
520 if not tmpl_dict[key]:
521 tmpl_dict[key] = ''
522
523 try:
524 msg_string = tmpl % tmpl_dict
525 except KeyError, err:
526 raise CmdException, 'Unknown patch template variable: %s' \
527 % err
528 except TypeError:
529 raise CmdException, 'Only "%(name)s" variables are ' \
530 'supported in the patch template'
531
532 if options.edit_patches:
533 msg_string = __edit_message(msg_string)
534
535 # The Python email message
536 try:
537 msg = email.message_from_string(msg_string)
538 except Exception, ex:
539 raise CmdException, 'template parsing error: %s' % str(ex)
540
541 if options.auto:
542 extra_cc = __get_signers_list(descr)
543 else:
544 extra_cc = []
545
546 __build_address_headers(msg, options, extra_cc)
547 __build_extra_headers(msg, msg_id, ref_id)
548 __encode_message(msg)
549
550 return msg
551
552 def func(parser, options, args):
553 """Send the patches by e-mail using the patchmail.tmpl file as
554 a template
555 """
556 applied = crt_series.get_applied()
557
558 if options.all:
559 patches = applied
560 elif len(args) >= 1:
561 unapplied = crt_series.get_unapplied()
562 patches = parse_patches(args, applied + unapplied, len(applied))
563 else:
564 raise CmdException, 'Incorrect options. Unknown patches to send'
565
566 # early test for sender identity
567 __get_sender()
568
569 out.start('Checking the validity of the patches')
570 for p in patches:
571 if crt_series.empty_patch(p):
572 raise CmdException, 'Cannot send empty patch "%s"' % p
573 out.done()
574
575 total_nr = len(patches)
576 if total_nr == 0:
577 raise CmdException, 'No patches to send'
578
579 if options.refid:
580 if options.noreply or options.unrelated:
581 raise CmdException, \
582 '--refid option not allowed with --noreply or --unrelated'
583 ref_id = options.refid
584 else:
585 ref_id = None
586
587 sleep = options.sleep or config.getint('stgit.smtpdelay')
588
589 # send the cover message (if any)
590 if options.cover or options.edit_cover:
591 if options.unrelated:
592 raise CmdException, 'cover sending not allowed with --unrelated'
593
594 # find the template file
595 if options.cover:
596 tmpl = file(options.cover).read()
597 else:
598 tmpl = templates.get_template('covermail.tmpl')
599 if not tmpl:
600 raise CmdException, 'No cover message template file found'
601
602 msg_id = email.Utils.make_msgid('stgit')
603 msg = __build_cover(tmpl, msg_id, options, patches)
604 from_addr, to_addr_list = __parse_addresses(msg)
605
606 msg_string = msg.as_string(options.mbox)
607
608 # subsequent e-mails are seen as replies to the first one
609 if not options.noreply:
610 ref_id = msg_id
611
612 if options.mbox:
613 out.stdout_raw(msg_string + '\n')
614 else:
615 out.start('Sending the cover message')
616 __send_message(from_addr, to_addr_list, msg_string, options)
617 time.sleep(sleep)
618 out.done()
619
620 # send the patches
621 if options.template:
622 tmpl = file(options.template).read()
623 else:
624 if options.attach:
625 tmpl = templates.get_template('mailattch.tmpl')
626 else:
627 tmpl = templates.get_template('patchmail.tmpl')
628 if not tmpl:
629 raise CmdException, 'No e-mail template file found'
630
631 for (p, patch_nr) in zip(patches, range(1, total_nr + 1)):
632 msg_id = email.Utils.make_msgid('stgit')
633 msg = __build_message(tmpl, msg_id, options, p, patch_nr, total_nr,
634 ref_id)
635 from_addr, to_addr_list = __parse_addresses(msg)
636
637 msg_string = msg.as_string(options.mbox)
638
639 # subsequent e-mails are seen as replies to the first one
640 if not options.noreply and not options.unrelated and not ref_id:
641 ref_id = msg_id
642
643 if options.mbox:
644 out.stdout_raw(msg_string + '\n')
645 else:
646 out.start('Sending patch "%s"' % p)
647 __send_message(from_addr, to_addr_list, msg_string, options)
648 # give recipients a chance of receiving related patches in the
649 # correct order.
650 if patch_nr < total_nr:
651 time.sleep(sleep)
652 out.done()