fix stg mail %(shortlog)s order
[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,
194 smtpuser, smtppassword, use_tls):
195 """Send the message using the given SMTP server
196 """
197 try:
198 s = smtplib.SMTP(smtpserver)
199 except Exception, err:
200 raise CmdException, str(err)
201
202 s.set_debuglevel(0)
203 try:
204 if smtpuser and smtppassword:
205 s.ehlo()
206 if use_tls:
207 if not hasattr(socket, 'ssl'):
208 raise CmdException, "cannot use TLS - no SSL support in Python"
209 s.starttls()
210 s.ehlo()
211 s.login(smtpuser, smtppassword)
212
213 result = s.sendmail(from_addr, to_addr_list, msg)
214 if len(result):
215 print "mail server refused delivery for the following recipients: %s" % result
216 except Exception, err:
217 raise CmdException, str(err)
218
219 s.quit()
220
221 def __send_message(smtpserver, from_addr, to_addr_list, msg,
222 smtpuser, smtppassword, use_tls):
223 """Message sending dispatcher.
224 """
225 if smtpserver.startswith('/'):
226 # Use the sendmail tool
227 __send_message_sendmail(smtpserver, msg)
228 else:
229 # Use the SMTP server (we have host and port information)
230 __send_message_smtp(smtpserver, from_addr, to_addr_list, msg,
231 smtpuser, smtppassword, use_tls)
232
233 def __build_address_headers(msg, options, extra_cc = []):
234 """Build the address headers and check existing headers in the
235 template.
236 """
237 def __addr_pairs(msg, header, extra):
238 pairs = email.Utils.getaddresses(msg.get_all(header, []) + extra)
239 # remove pairs without an address and resolve the aliases
240 return [address_or_alias(p) for p in pairs if p[1]]
241
242 def __update_header(header, addr = '', ignore = ()):
243 addr_pairs = __addr_pairs(msg, header, [addr])
244 del msg[header]
245 # remove the duplicates and filter the addresses
246 addr_dict = dict((addr, email.Utils.formataddr((name, addr)))
247 for name, addr in addr_pairs if addr not in ignore)
248 if addr_dict:
249 msg[header] = ', '.join(addr_dict.itervalues())
250 return set(addr_dict.iterkeys())
251
252 to_addr = ''
253 cc_addr = ''
254 extra_cc_addr = ''
255 bcc_addr = ''
256
257 autobcc = config.get('stgit.autobcc') or ''
258
259 if options.to:
260 to_addr = ', '.join(options.to)
261 if options.cc:
262 cc_addr = ', '.join(options.cc)
263 if extra_cc:
264 extra_cc_addr = ', '.join(extra_cc)
265 if options.bcc:
266 bcc_addr = ', '.join(options.bcc + [autobcc])
267 elif autobcc:
268 bcc_addr = autobcc
269
270 # if an address is on a header, ignore it from the rest
271 to_set = __update_header('To', to_addr)
272 cc_set = __update_header('Cc', cc_addr, to_set)
273 bcc_set = __update_header('Bcc', bcc_addr, to_set.union(cc_set))
274
275 # --auto generated addresses, don't include the sender
276 from_set = __update_header('From')
277 __update_header('Cc', extra_cc_addr, to_set.union(bcc_set).union(from_set))
278
279 # update other address headers
280 __update_header('Reply-To')
281 __update_header('Mail-Reply-To')
282 __update_header('Mail-Followup-To')
283
284 def __get_signers_list(msg):
285 """Return the address list generated from signed-off-by and
286 acked-by lines in the message.
287 """
288 addr_list = []
289 tags = '%s|%s|%s|%s|%s|%s|%s' % (
290 'signed-off-by',
291 'acked-by',
292 'cc',
293 'reviewed-by',
294 'reported-by',
295 'tested-by',
296 'reported-and-tested-by')
297 regex = '^(%s):\s+(.+)$' % tags
298
299 r = re.compile(regex, re.I)
300 for line in msg.split('\n'):
301 m = r.match(line)
302 if m:
303 addr_list.append(m.expand('\g<2>'))
304
305 return addr_list
306
307 def __build_extra_headers(msg, msg_id, ref_id = None):
308 """Build extra email headers and encoding
309 """
310 del msg['Date']
311 msg['Date'] = email.Utils.formatdate(localtime = True)
312 msg['Message-ID'] = msg_id
313 if ref_id:
314 # make sure the ref id has the angle brackets
315 ref_id = '<%s>' % ref_id.strip(' \t\n<>')
316 msg['In-Reply-To'] = ref_id
317 msg['References'] = ref_id
318 msg['User-Agent'] = 'StGit/%s' % version.version
319
320 def __encode_message(msg):
321 # 7 or 8 bit encoding
322 charset = email.Charset.Charset('utf-8')
323 charset.body_encoding = None
324
325 # encode headers
326 for header, value in msg.items():
327 words = []
328 for word in value.split(' '):
329 try:
330 uword = unicode(word, 'utf-8')
331 except UnicodeDecodeError:
332 # maybe we should try a different encoding or report
333 # the error. At the moment, we just ignore it
334 pass
335 words.append(email.Header.Header(uword).encode())
336 new_val = ' '.join(words)
337 msg.replace_header(header, new_val)
338
339 # encode the body and set the MIME and encoding headers
340 if msg.is_multipart():
341 for p in msg.get_payload():
342 p.set_charset(charset)
343 else:
344 msg.set_charset(charset)
345
346 def __edit_message(msg):
347 fname = '.stgitmail.txt'
348
349 # create the initial file
350 f = file(fname, 'w')
351 f.write(msg)
352 f.close()
353
354 call_editor(fname)
355
356 # read the message back
357 f = file(fname)
358 msg = f.read()
359 f.close()
360
361 return msg
362
363 def __build_cover(tmpl, patches, msg_id, options):
364 """Build the cover message (series description) to be sent via SMTP
365 """
366 sender = __get_sender()
367
368 if options.version:
369 version_str = ' %s' % options.version
370 else:
371 version_str = ''
372
373 if options.prefix:
374 prefix_str = options.prefix + ' '
375 else:
376 confprefix = config.get('stgit.mail.prefix')
377 if confprefix:
378 prefix_str = confprefix + ' '
379 else:
380 prefix_str = ''
381
382 total_nr_str = str(len(patches))
383 patch_nr_str = '0'.zfill(len(total_nr_str))
384 if len(patches) > 1:
385 number_str = ' %s/%s' % (patch_nr_str, total_nr_str)
386 else:
387 number_str = ''
388
389 tmpl_dict = {'sender': sender,
390 # for backward template compatibility
391 'maintainer': sender,
392 # for backward template compatibility
393 'endofheaders': '',
394 # for backward template compatibility
395 'date': '',
396 'version': version_str,
397 'prefix': prefix_str,
398 'patchnr': patch_nr_str,
399 'totalnr': total_nr_str,
400 'number': number_str,
401 'shortlog': stack.shortlog(crt_series.get_patch(p)
402 for p in reversed(patches)),
403 'diffstat': gitlib.diffstat(git.diff(
404 rev1 = git_id(crt_series, '%s^' % patches[0]),
405 rev2 = git_id(crt_series, '%s' % patches[-1]),
406 diff_flags = options.diff_flags))}
407
408 try:
409 msg_string = tmpl % tmpl_dict
410 except KeyError, err:
411 raise CmdException, 'Unknown patch template variable: %s' \
412 % err
413 except TypeError:
414 raise CmdException, 'Only "%(name)s" variables are ' \
415 'supported in the patch template'
416
417 if options.edit_cover:
418 msg_string = __edit_message(msg_string)
419
420 # The Python email message
421 try:
422 msg = email.message_from_string(msg_string)
423 except Exception, ex:
424 raise CmdException, 'template parsing error: %s' % str(ex)
425
426 __build_address_headers(msg, options)
427 __build_extra_headers(msg, msg_id, options.refid)
428 __encode_message(msg)
429
430 return msg
431
432 def __build_message(tmpl, patch, patch_nr, total_nr, msg_id, ref_id, options):
433 """Build the message to be sent via SMTP
434 """
435 p = crt_series.get_patch(patch)
436
437 if p.get_description():
438 descr = p.get_description().strip()
439 else:
440 # provide a place holder and force the edit message option on
441 descr = '<empty message>'
442 options.edit_patches = True
443
444 descr_lines = descr.split('\n')
445 short_descr = descr_lines[0].strip()
446 long_descr = '\n'.join(l.rstrip() for l in descr_lines[1:]).lstrip('\n')
447
448 authname = p.get_authname();
449 authemail = p.get_authemail();
450 commname = p.get_commname();
451 commemail = p.get_commemail();
452
453 sender = __get_sender()
454
455 fromauth = '%s <%s>' % (authname, authemail)
456 if fromauth != sender:
457 fromauth = 'From: %s\n\n' % fromauth
458 else:
459 fromauth = ''
460
461 if options.version:
462 version_str = ' %s' % options.version
463 else:
464 version_str = ''
465
466 if options.prefix:
467 prefix_str = options.prefix + ' '
468 else:
469 confprefix = config.get('stgit.mail.prefix')
470 if confprefix:
471 prefix_str = confprefix + ' '
472 else:
473 prefix_str = ''
474
475 total_nr_str = str(total_nr)
476 patch_nr_str = str(patch_nr).zfill(len(total_nr_str))
477 if not options.unrelated and total_nr > 1:
478 number_str = ' %s/%s' % (patch_nr_str, total_nr_str)
479 else:
480 number_str = ''
481
482 diff = git.diff(rev1 = git_id(crt_series, '%s^' % patch),
483 rev2 = git_id(crt_series, '%s' % patch),
484 diff_flags = options.diff_flags)
485 tmpl_dict = {'patch': patch,
486 'sender': sender,
487 # for backward template compatibility
488 'maintainer': sender,
489 'shortdescr': short_descr,
490 'longdescr': long_descr,
491 # for backward template compatibility
492 'endofheaders': '',
493 'diff': diff,
494 'diffstat': gitlib.diffstat(diff),
495 # for backward template compatibility
496 'date': '',
497 'version': version_str,
498 'prefix': prefix_str,
499 'patchnr': patch_nr_str,
500 'totalnr': total_nr_str,
501 'number': number_str,
502 'fromauth': fromauth,
503 'authname': authname,
504 'authemail': authemail,
505 'authdate': p.get_authdate(),
506 'commname': commname,
507 'commemail': commemail}
508 # change None to ''
509 for key in tmpl_dict:
510 if not tmpl_dict[key]:
511 tmpl_dict[key] = ''
512
513 try:
514 msg_string = tmpl % tmpl_dict
515 except KeyError, err:
516 raise CmdException, 'Unknown patch template variable: %s' \
517 % err
518 except TypeError:
519 raise CmdException, 'Only "%(name)s" variables are ' \
520 'supported in the patch template'
521
522 if options.edit_patches:
523 msg_string = __edit_message(msg_string)
524
525 # The Python email message
526 try:
527 msg = email.message_from_string(msg_string)
528 except Exception, ex:
529 raise CmdException, 'template parsing error: %s' % str(ex)
530
531 if options.auto:
532 extra_cc = __get_signers_list(descr)
533 else:
534 extra_cc = []
535
536 __build_address_headers(msg, options, extra_cc)
537 __build_extra_headers(msg, msg_id, ref_id)
538 __encode_message(msg)
539
540 return msg
541
542 def func(parser, options, args):
543 """Send the patches by e-mail using the patchmail.tmpl file as
544 a template
545 """
546 smtpserver = options.smtp_server or config.get('stgit.smtpserver')
547
548 applied = crt_series.get_applied()
549
550 if options.all:
551 patches = applied
552 elif len(args) >= 1:
553 unapplied = crt_series.get_unapplied()
554 patches = parse_patches(args, applied + unapplied, len(applied))
555 else:
556 raise CmdException, 'Incorrect options. Unknown patches to send'
557
558 # early test for sender identity
559 __get_sender()
560
561 out.start('Checking the validity of the patches')
562 for p in patches:
563 if crt_series.empty_patch(p):
564 raise CmdException, 'Cannot send empty patch "%s"' % p
565 out.done()
566
567 smtppassword = options.smtp_password or config.get('stgit.smtppassword')
568 smtpuser = options.smtp_user or config.get('stgit.smtpuser')
569 smtpusetls = options.smtp_tls or config.get('stgit.smtptls') == 'yes'
570
571 if (smtppassword and not smtpuser):
572 raise CmdException, 'SMTP password supplied, username needed'
573 if (smtpusetls and not smtpuser):
574 raise CmdException, 'SMTP over TLS requested, username needed'
575 if (smtpuser and not smtppassword):
576 smtppassword = getpass.getpass("Please enter SMTP password: ")
577
578 total_nr = len(patches)
579 if total_nr == 0:
580 raise CmdException, 'No patches to send'
581
582 if options.refid:
583 if options.noreply or options.unrelated:
584 raise CmdException, \
585 '--refid option not allowed with --noreply or --unrelated'
586 ref_id = options.refid
587 else:
588 ref_id = None
589
590 sleep = options.sleep or config.getint('stgit.smtpdelay')
591
592 # send the cover message (if any)
593 if options.cover or options.edit_cover:
594 if options.unrelated:
595 raise CmdException, 'cover sending not allowed with --unrelated'
596
597 # find the template file
598 if options.cover:
599 tmpl = file(options.cover).read()
600 else:
601 tmpl = templates.get_template('covermail.tmpl')
602 if not tmpl:
603 raise CmdException, 'No cover message template file found'
604
605 msg_id = email.Utils.make_msgid('stgit')
606 msg = __build_cover(tmpl, patches, msg_id, options)
607 from_addr, to_addr_list = __parse_addresses(msg)
608
609 msg_string = msg.as_string(options.mbox)
610
611 # subsequent e-mails are seen as replies to the first one
612 if not options.noreply:
613 ref_id = msg_id
614
615 if options.mbox:
616 out.stdout_raw(msg_string + '\n')
617 else:
618 out.start('Sending the cover message')
619 __send_message(smtpserver, from_addr, to_addr_list, msg_string,
620 smtpuser, smtppassword, smtpusetls)
621 time.sleep(sleep)
622 out.done()
623
624 # send the patches
625 if options.template:
626 tmpl = file(options.template).read()
627 else:
628 if options.attach:
629 tmpl = templates.get_template('mailattch.tmpl')
630 else:
631 tmpl = templates.get_template('patchmail.tmpl')
632 if not tmpl:
633 raise CmdException, 'No e-mail template file found'
634
635 for (p, patch_nr) in zip(patches, range(1, total_nr + 1)):
636 msg_id = email.Utils.make_msgid('stgit')
637 msg = __build_message(tmpl, p, patch_nr, total_nr, msg_id, ref_id,
638 options)
639 from_addr, to_addr_list = __parse_addresses(msg)
640
641 msg_string = msg.as_string(options.mbox)
642
643 # subsequent e-mails are seen as replies to the first one
644 if not options.noreply and not options.unrelated and not ref_id:
645 ref_id = msg_id
646
647 if options.mbox:
648 out.stdout_raw(msg_string + '\n')
649 else:
650 out.start('Sending patch "%s"' % p)
651 __send_message(smtpserver, from_addr, to_addr_list, msg_string,
652 smtpuser, smtppassword, smtpusetls)
653 # give recipients a chance of receiving related patches in the
654 # correct order.
655 if patch_nr < total_nr:
656 time.sleep(sleep)
657 out.done()