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 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
29 help = 'Send a patch or series of patches by e-mail'
31 usage
= [' [options] [<patch1>] [<patch2>] [<patch3>..<patch4>]']
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.
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'.
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.
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').
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.
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.
66 The following variables are accepted by both the preamble and the
67 patch e-mail templates:
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)
76 In addition to the common variables, the preamble e-mail template
77 accepts the following:
79 %(shortlog)s - first line of each patch description, listed by author
81 In addition to the common variables, the patch e-mail template accepts
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"""
96 args
= [argparse
.patch_range(argparse
.applied_patches
,
97 argparse
.unapplied_patches
,
98 argparse
.hidden_patches
)]
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'),
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()
146 directory
= DirectoryHasRepository(log
= False)
149 """Return the 'authname <authemail>' string as read from the
152 sender
=config
.get('stgit.sender')
155 sender
= str(git
.user())
156 except git
.GitException
:
157 sender
= str(git
.author())
159 raise CmdException
, 'unknown sender details'
160 sender
= email
.Utils
.parseaddr(sender
)
162 return email
.Utils
.formataddr(address_or_alias(sender
))
164 def __addr_list(msg
, header
):
165 return [addr
for name
, addr
in
166 email
.Utils
.getaddresses(msg
.get_all(header
, []))]
168 def __parse_addresses(msg
):
169 """Return a two elements tuple: (from, [to])
171 from_addr_list
= __addr_list(msg
, 'From')
172 if len(from_addr_list
) == 0:
173 raise CmdException
, 'No "From" address'
175 to_addr_list
= __addr_list(msg
, 'To') + __addr_list(msg
, 'Cc') \
176 + __addr_list(msg
, 'Bcc')
177 if len(to_addr_list
) == 0:
178 raise CmdException
, 'No "To/Cc/Bcc" addresses'
180 return (from_addr_list
[0], set(to_addr_list
))
182 def __send_message_sendmail(sendmail
, msg
):
183 """Send the message using the sendmail command.
185 cmd
= sendmail
.split()
186 Run(*cmd
).raw_input(msg
).discard_output()
188 def __send_message_smtp(smtpserver
, from_addr
, to_addr_list
, msg
,
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 except Exception, err
:
212 raise CmdException
, str(err
)
216 def __send_message(smtpserver
, from_addr
, to_addr_list
, msg
,
217 sleep
, smtpuser
, smtppassword
, use_tls
):
218 """Message sending dispatcher.
220 if smtpserver
.startswith('/'):
221 # Use the sendmail tool
222 __send_message_sendmail(smtpserver
, msg
)
224 # Use the SMTP server (we have host and port information)
225 __send_message_smtp(smtpserver
, from_addr
, to_addr_list
, msg
,
226 smtpuser
, smtppassword
, use_tls
)
227 # give recipients a chance of receiving patches in the correct order
230 def __build_address_headers(msg
, options
, extra_cc
= []):
231 """Build the address headers and check existing headers in the
234 def __addr_pairs(msg
, header
, extra
):
235 pairs
= email
.Utils
.getaddresses(msg
.get_all(header
, []) + extra
)
236 # remove pairs without an address and resolve the aliases
237 return [address_or_alias(p
) for p
in pairs
if p
[1]]
239 def __update_header(header
, addr
= '', ignore
= ()):
240 addr_pairs
= __addr_pairs(msg
, header
, [addr
])
242 # remove the duplicates and filter the addresses
243 addr_dict
= dict((addr
, email
.Utils
.formataddr((name
, addr
)))
244 for name
, addr
in addr_pairs
if addr
not in ignore
)
246 msg
[header
] = ', '.join(addr_dict
.itervalues())
247 return set(addr_dict
.iterkeys())
254 autobcc
= config
.get('stgit.autobcc') or ''
257 to_addr
= ', '.join(options
.to
)
259 cc_addr
= ', '.join(options
.cc
)
261 extra_cc_addr
= ', '.join(extra_cc
)
263 bcc_addr
= ', '.join(options
.bcc
+ [autobcc
])
267 # if an address is on a header, ignore it from the rest
268 to_set
= __update_header('To', to_addr
)
269 cc_set
= __update_header('Cc', cc_addr
, to_set
)
270 bcc_set
= __update_header('Bcc', bcc_addr
, to_set
.union(cc_set
))
272 # --auto generated addresses, don't include the sender
273 from_set
= __update_header('From')
274 __update_header('Cc', extra_cc_addr
, to_set
.union(bcc_set
).union(from_set
))
276 # update other address headers
277 __update_header('Reply-To')
278 __update_header('Mail-Reply-To')
279 __update_header('Mail-Followup-To')
281 def __get_signers_list(msg
):
282 """Return the address list generated from signed-off-by and
283 acked-by lines in the message.
286 tags
= '%s|%s|%s|%s|%s|%s|%s' %
(
293 'reported-and-tested-by')
294 regex
= '^(%s):\s+(.+)$' % tags
296 r
= re
.compile(regex
, re
.I
)
297 for line
in msg
.split('\n'):
300 addr_list
.append(m
.expand('\g<2>'))
304 def __build_extra_headers(msg
, msg_id
, ref_id
= None):
305 """Build extra email headers and encoding
308 msg
['Date'] = email
.Utils
.formatdate(localtime
= True)
309 msg
['Message-ID'] = msg_id
311 # make sure the ref id has the angle brackets
312 ref_id
= '<%s>' % ref_id
.strip(' \t\n<>')
313 msg
['In-Reply-To'] = ref_id
314 msg
['References'] = ref_id
315 msg
['User-Agent'] = 'StGit/%s' % version
.version
317 def __encode_message(msg
):
318 # 7 or 8 bit encoding
319 charset
= email
.Charset
.Charset('utf-8')
320 charset
.body_encoding
= None
323 for header
, value
in msg
.items():
325 for word
in value
.split(' '):
327 uword
= unicode(word
, 'utf-8')
328 except UnicodeDecodeError:
329 # maybe we should try a different encoding or report
330 # the error. At the moment, we just ignore it
332 words
.append(email
.Header
.Header(uword
).encode())
333 new_val
= ' '.join(words
)
334 msg
.replace_header(header
, new_val
)
336 # encode the body and set the MIME and encoding headers
337 if msg
.is_multipart():
338 for p
in msg
.get_payload():
339 p
.set_charset(charset
)
341 msg
.set_charset(charset
)
343 def __edit_message(msg
):
344 fname
= '.stgitmail.txt'
346 # create the initial file
353 # read the message back
360 def __build_cover(tmpl
, patches
, msg_id
, options
):
361 """Build the cover message (series description) to be sent via SMTP
363 sender
= __get_sender()
366 version_str
= ' %s' % options
.version
371 prefix_str
= options
.prefix
+ ' '
373 confprefix
= config
.get('stgit.mail.prefix')
375 prefix_str
= confprefix
+ ' '
379 total_nr_str
= str(len(patches
))
380 patch_nr_str
= '0'.zfill(len(total_nr_str
))
382 number_str
= ' %s/%s' %
(patch_nr_str
, total_nr_str
)
386 tmpl_dict
= {'sender': sender
,
387 # for backward template compatibility
388 'maintainer': sender
,
389 # for backward template compatibility
391 # for backward template compatibility
393 'version': version_str
,
394 'prefix': prefix_str
,
395 'patchnr': patch_nr_str
,
396 'totalnr': total_nr_str
,
397 'number': number_str
,
398 'shortlog': stack
.shortlog(crt_series
.get_patch(p
)
400 'diffstat': gitlib
.diffstat(git
.diff(
401 rev1
= git_id(crt_series
, '%s^' % patches
[0]),
402 rev2
= git_id(crt_series
, '%s' % patches
[-1])))}
405 msg_string
= tmpl % tmpl_dict
406 except KeyError, err
:
407 raise CmdException
, 'Unknown patch template variable: %s' \
410 raise CmdException
, 'Only "%(name)s" variables are ' \
411 'supported in the patch template'
413 if options
.edit_cover
:
414 msg_string
= __edit_message(msg_string
)
416 # The Python email message
418 msg
= email
.message_from_string(msg_string
)
419 except Exception, ex
:
420 raise CmdException
, 'template parsing error: %s' % str
(ex
)
422 __build_address_headers(msg
, options
)
423 __build_extra_headers(msg
, msg_id
, options
.refid
)
424 __encode_message(msg
)
428 def __build_message(tmpl
, patch
, patch_nr
, total_nr
, msg_id
, ref_id
, options
):
429 """Build the message to be sent via SMTP
431 p
= crt_series
.get_patch(patch
)
433 if p
.get_description():
434 descr
= p
.get_description().strip()
436 # provide a place holder and force the edit message option on
437 descr
= '<empty message>'
438 options
.edit_patches
= True
440 descr_lines
= descr
.split('\n')
441 short_descr
= descr_lines
[0].strip()
442 long_descr
= '\n'.join(l
.rstrip() for l
in descr_lines
[1:]).lstrip('\n')
444 authname
= p
.get_authname();
445 authemail
= p
.get_authemail();
446 commname
= p
.get_commname();
447 commemail
= p
.get_commemail();
449 sender
= __get_sender()
451 fromauth
= '%s <%s>' %
(authname
, authemail
)
452 if fromauth
!= sender
:
453 fromauth
= 'From: %s\n\n' % fromauth
458 version_str
= ' %s' % options
.version
463 prefix_str
= options
.prefix
+ ' '
465 confprefix
= config
.get('stgit.mail.prefix')
467 prefix_str
= confprefix
+ ' '
471 total_nr_str
= str(total_nr
)
472 patch_nr_str
= str(patch_nr
).zfill(len(total_nr_str
))
473 if not options
.unrelated
and total_nr
> 1:
474 number_str
= ' %s/%s' %
(patch_nr_str
, total_nr_str
)
478 diff
= git
.diff(rev1
= git_id(crt_series
, '%s^' % patch
),
479 rev2
= git_id(crt_series
, '%s' % patch
),
480 diff_flags
= options
.diff_flags
)
481 tmpl_dict
= {'patch': patch
,
483 # for backward template compatibility
484 'maintainer': sender
,
485 'shortdescr': short_descr
,
486 'longdescr': long_descr
,
487 # for backward template compatibility
490 'diffstat': gitlib
.diffstat(diff
),
491 # for backward template compatibility
493 'version': version_str
,
494 'prefix': prefix_str
,
495 'patchnr': patch_nr_str
,
496 'totalnr': total_nr_str
,
497 'number': number_str
,
498 'fromauth': fromauth
,
499 'authname': authname
,
500 'authemail': authemail
,
501 'authdate': p
.get_authdate(),
502 'commname': commname
,
503 'commemail': commemail
}
505 for key
in tmpl_dict
:
506 if not tmpl_dict
[key
]:
510 msg_string
= tmpl % tmpl_dict
511 except KeyError, err
:
512 raise CmdException
, 'Unknown patch template variable: %s' \
515 raise CmdException
, 'Only "%(name)s" variables are ' \
516 'supported in the patch template'
518 if options
.edit_patches
:
519 msg_string
= __edit_message(msg_string
)
521 # The Python email message
523 msg
= email
.message_from_string(msg_string
)
524 except Exception, ex
:
525 raise CmdException
, 'template parsing error: %s' % str
(ex
)
528 extra_cc
= __get_signers_list(descr
)
532 __build_address_headers(msg
, options
, extra_cc
)
533 __build_extra_headers(msg
, msg_id
, ref_id
)
534 __encode_message(msg
)
538 def func(parser
, options
, args
):
539 """Send the patches by e-mail using the patchmail.tmpl file as
542 smtpserver
= options
.smtp_server
or config
.get('stgit.smtpserver')
544 applied
= crt_series
.get_applied()
549 unapplied
= crt_series
.get_unapplied()
550 patches
= parse_patches(args
, applied
+ unapplied
, len(applied
))
552 raise CmdException
, 'Incorrect options. Unknown patches to send'
554 out
.start('Checking the validity of the patches')
556 if crt_series
.empty_patch(p
):
557 raise CmdException
, 'Cannot send empty patch "%s"' % p
560 smtppassword
= options
.smtp_password
or config
.get('stgit.smtppassword')
561 smtpuser
= options
.smtp_user
or config
.get('stgit.smtpuser')
562 smtpusetls
= options
.smtp_tls
or config
.get('stgit.smtptls') == 'yes'
564 if (smtppassword
and not smtpuser
):
565 raise CmdException
, 'SMTP password supplied, username needed'
566 if (smtpusetls
and not smtpuser
):
567 raise CmdException
, 'SMTP over TLS requested, username needed'
568 if (smtpuser
and not smtppassword
):
569 smtppassword
= getpass
.getpass("Please enter SMTP password: ")
571 total_nr
= len(patches
)
573 raise CmdException
, 'No patches to send'
576 if options
.noreply
or options
.unrelated
:
577 raise CmdException
, \
578 '--refid option not allowed with --noreply or --unrelated'
579 ref_id
= options
.refid
583 sleep
= options
.sleep
or config
.getint('stgit.smtpdelay')
585 # send the cover message (if any)
586 if options
.cover
or options
.edit_cover
:
587 if options
.unrelated
:
588 raise CmdException
, 'cover sending not allowed with --unrelated'
590 # find the template file
592 tmpl
= file(options
.cover
).read()
594 tmpl
= templates
.get_template('covermail.tmpl')
596 raise CmdException
, 'No cover message template file found'
598 msg_id
= email
.Utils
.make_msgid('stgit')
599 msg
= __build_cover(tmpl
, patches
, msg_id
, options
)
600 from_addr
, to_addr_list
= __parse_addresses(msg
)
602 msg_string
= msg
.as_string(options
.mbox
)
604 # subsequent e-mails are seen as replies to the first one
605 if not options
.noreply
:
609 out
.stdout_raw(msg_string
+ '\n')
611 out
.start('Sending the cover message')
612 __send_message(smtpserver
, from_addr
, to_addr_list
, msg_string
,
613 sleep
, smtpuser
, smtppassword
, smtpusetls
)
618 tmpl
= file(options
.template
).read()
621 tmpl
= templates
.get_template('mailattch.tmpl')
623 tmpl
= templates
.get_template('patchmail.tmpl')
625 raise CmdException
, 'No e-mail template file found'
627 for (p
, patch_nr
) in zip(patches
, range(1, len(patches
) + 1)):
628 msg_id
= email
.Utils
.make_msgid('stgit')
629 msg
= __build_message(tmpl
, p
, patch_nr
, total_nr
, msg_id
, ref_id
,
631 from_addr
, to_addr_list
= __parse_addresses(msg
)
633 msg_string
= msg
.as_string(options
.mbox
)
635 # subsequent e-mails are seen as replies to the first one
636 if not options
.noreply
and not options
.unrelated
and not ref_id
:
640 out
.stdout_raw(msg_string
+ '\n')
642 out
.start('Sending patch "%s"' % p
)
643 __send_message(smtpserver
, from_addr
, to_addr_list
, msg_string
,
644 sleep
, smtpuser
, smtppassword
, smtpusetls
)