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
:
158 sender
= str(git
.author())
159 except git
.GitException
:
162 raise CmdException
, ('Unknown sender name and e-mail; you should'
163 ' for example set git config user.name and'
165 sender
= email
.Utils
.parseaddr(sender
)
167 return email
.Utils
.formataddr(address_or_alias(sender
))
169 def __addr_list(msg
, header
):
170 return [addr
for name
, addr
in
171 email
.Utils
.getaddresses(msg
.get_all(header
, []))]
173 def __parse_addresses(msg
):
174 """Return a two elements tuple: (from, [to])
176 from_addr_list
= __addr_list(msg
, 'From')
177 if len(from_addr_list
) == 0:
178 raise CmdException
, 'No "From" address'
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'
185 return (from_addr_list
[0], set(to_addr_list
))
187 def __send_message_sendmail(sendmail
, msg
):
188 """Send the message using the sendmail command.
190 cmd
= sendmail
.split()
191 Run(*cmd
).raw_input(msg
).discard_output()
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
198 s
= smtplib
.SMTP(smtpserver
)
199 except Exception, err
:
200 raise CmdException
, str(err
)
204 if smtpuser
and smtppassword
:
207 if not hasattr(socket
, 'ssl'):
208 raise CmdException
, "cannot use TLS - no SSL support in Python"
211 s
.login(smtpuser
, smtppassword
)
213 result
= s
.sendmail(from_addr
, to_addr_list
, msg
)
215 print "mail server refused delivery for the following recipients: %s" % result
216 except Exception, err
:
217 raise CmdException
, str(err
)
221 def __send_message(smtpserver
, from_addr
, to_addr_list
, msg
,
222 sleep
, smtpuser
, smtppassword
, use_tls
):
223 """Message sending dispatcher.
225 if smtpserver
.startswith('/'):
226 # Use the sendmail tool
227 __send_message_sendmail(smtpserver
, msg
)
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 # give recipients a chance of receiving patches in the correct order
235 def __build_address_headers(msg
, options
, extra_cc
= []):
236 """Build the address headers and check existing headers in the
239 def __addr_pairs(msg
, header
, extra
):
240 pairs
= email
.Utils
.getaddresses(msg
.get_all(header
, []) + extra
)
241 # remove pairs without an address and resolve the aliases
242 return [address_or_alias(p
) for p
in pairs
if p
[1]]
244 def __update_header(header
, addr
= '', ignore
= ()):
245 addr_pairs
= __addr_pairs(msg
, header
, [addr
])
247 # remove the duplicates and filter the addresses
248 addr_dict
= dict((addr
, email
.Utils
.formataddr((name
, addr
)))
249 for name
, addr
in addr_pairs
if addr
not in ignore
)
251 msg
[header
] = ', '.join(addr_dict
.itervalues())
252 return set(addr_dict
.iterkeys())
259 autobcc
= config
.get('stgit.autobcc') or ''
262 to_addr
= ', '.join(options
.to
)
264 cc_addr
= ', '.join(options
.cc
)
266 extra_cc_addr
= ', '.join(extra_cc
)
268 bcc_addr
= ', '.join(options
.bcc
+ [autobcc
])
272 # if an address is on a header, ignore it from the rest
273 to_set
= __update_header('To', to_addr
)
274 cc_set
= __update_header('Cc', cc_addr
, to_set
)
275 bcc_set
= __update_header('Bcc', bcc_addr
, to_set
.union(cc_set
))
277 # --auto generated addresses, don't include the sender
278 from_set
= __update_header('From')
279 __update_header('Cc', extra_cc_addr
, to_set
.union(bcc_set
).union(from_set
))
281 # update other address headers
282 __update_header('Reply-To')
283 __update_header('Mail-Reply-To')
284 __update_header('Mail-Followup-To')
286 def __get_signers_list(msg
):
287 """Return the address list generated from signed-off-by and
288 acked-by lines in the message.
291 tags
= '%s|%s|%s|%s|%s|%s|%s' %
(
298 'reported-and-tested-by')
299 regex
= '^(%s):\s+(.+)$' % tags
301 r
= re
.compile(regex
, re
.I
)
302 for line
in msg
.split('\n'):
305 addr_list
.append(m
.expand('\g<2>'))
309 def __build_extra_headers(msg
, msg_id
, ref_id
= None):
310 """Build extra email headers and encoding
313 msg
['Date'] = email
.Utils
.formatdate(localtime
= True)
314 msg
['Message-ID'] = msg_id
316 # make sure the ref id has the angle brackets
317 ref_id
= '<%s>' % ref_id
.strip(' \t\n<>')
318 msg
['In-Reply-To'] = ref_id
319 msg
['References'] = ref_id
320 msg
['User-Agent'] = 'StGit/%s' % version
.version
322 def __encode_message(msg
):
323 # 7 or 8 bit encoding
324 charset
= email
.Charset
.Charset('utf-8')
325 charset
.body_encoding
= None
328 for header
, value
in msg
.items():
330 for word
in value
.split(' '):
332 uword
= unicode(word
, 'utf-8')
333 except UnicodeDecodeError:
334 # maybe we should try a different encoding or report
335 # the error. At the moment, we just ignore it
337 words
.append(email
.Header
.Header(uword
).encode())
338 new_val
= ' '.join(words
)
339 msg
.replace_header(header
, new_val
)
341 # encode the body and set the MIME and encoding headers
342 if msg
.is_multipart():
343 for p
in msg
.get_payload():
344 p
.set_charset(charset
)
346 msg
.set_charset(charset
)
348 def __edit_message(msg
):
349 fname
= '.stgitmail.txt'
351 # create the initial file
358 # read the message back
365 def __build_cover(tmpl
, patches
, msg_id
, options
):
366 """Build the cover message (series description) to be sent via SMTP
368 sender
= __get_sender()
371 version_str
= ' %s' % options
.version
376 prefix_str
= options
.prefix
+ ' '
378 confprefix
= config
.get('stgit.mail.prefix')
380 prefix_str
= confprefix
+ ' '
384 total_nr_str
= str(len(patches
))
385 patch_nr_str
= '0'.zfill(len(total_nr_str
))
387 number_str
= ' %s/%s' %
(patch_nr_str
, total_nr_str
)
391 tmpl_dict
= {'sender': sender
,
392 # for backward template compatibility
393 'maintainer': sender
,
394 # for backward template compatibility
396 # for backward template compatibility
398 'version': version_str
,
399 'prefix': prefix_str
,
400 'patchnr': patch_nr_str
,
401 'totalnr': total_nr_str
,
402 'number': number_str
,
403 'shortlog': stack
.shortlog(crt_series
.get_patch(p
)
405 'diffstat': gitlib
.diffstat(git
.diff(
406 rev1
= git_id(crt_series
, '%s^' % patches
[0]),
407 rev2
= git_id(crt_series
, '%s' % patches
[-1]),
408 diff_flags
= options
.diff_flags
))}
411 msg_string
= tmpl % tmpl_dict
412 except KeyError, err
:
413 raise CmdException
, 'Unknown patch template variable: %s' \
416 raise CmdException
, 'Only "%(name)s" variables are ' \
417 'supported in the patch template'
419 if options
.edit_cover
:
420 msg_string
= __edit_message(msg_string
)
422 # The Python email message
424 msg
= email
.message_from_string(msg_string
)
425 except Exception, ex
:
426 raise CmdException
, 'template parsing error: %s' % str
(ex
)
428 __build_address_headers(msg
, options
)
429 __build_extra_headers(msg
, msg_id
, options
.refid
)
430 __encode_message(msg
)
434 def __build_message(tmpl
, patch
, patch_nr
, total_nr
, msg_id
, ref_id
, options
):
435 """Build the message to be sent via SMTP
437 p
= crt_series
.get_patch(patch
)
439 if p
.get_description():
440 descr
= p
.get_description().strip()
442 # provide a place holder and force the edit message option on
443 descr
= '<empty message>'
444 options
.edit_patches
= True
446 descr_lines
= descr
.split('\n')
447 short_descr
= descr_lines
[0].strip()
448 long_descr
= '\n'.join(l
.rstrip() for l
in descr_lines
[1:]).lstrip('\n')
450 authname
= p
.get_authname();
451 authemail
= p
.get_authemail();
452 commname
= p
.get_commname();
453 commemail
= p
.get_commemail();
455 sender
= __get_sender()
457 fromauth
= '%s <%s>' %
(authname
, authemail
)
458 if fromauth
!= sender
:
459 fromauth
= 'From: %s\n\n' % fromauth
464 version_str
= ' %s' % options
.version
469 prefix_str
= options
.prefix
+ ' '
471 confprefix
= config
.get('stgit.mail.prefix')
473 prefix_str
= confprefix
+ ' '
477 total_nr_str
= str(total_nr
)
478 patch_nr_str
= str(patch_nr
).zfill(len(total_nr_str
))
479 if not options
.unrelated
and total_nr
> 1:
480 number_str
= ' %s/%s' %
(patch_nr_str
, total_nr_str
)
484 diff
= git
.diff(rev1
= git_id(crt_series
, '%s^' % patch
),
485 rev2
= git_id(crt_series
, '%s' % patch
),
486 diff_flags
= options
.diff_flags
)
487 tmpl_dict
= {'patch': patch
,
489 # for backward template compatibility
490 'maintainer': sender
,
491 'shortdescr': short_descr
,
492 'longdescr': long_descr
,
493 # for backward template compatibility
496 'diffstat': gitlib
.diffstat(diff
),
497 # for backward template compatibility
499 'version': version_str
,
500 'prefix': prefix_str
,
501 'patchnr': patch_nr_str
,
502 'totalnr': total_nr_str
,
503 'number': number_str
,
504 'fromauth': fromauth
,
505 'authname': authname
,
506 'authemail': authemail
,
507 'authdate': p
.get_authdate(),
508 'commname': commname
,
509 'commemail': commemail
}
511 for key
in tmpl_dict
:
512 if not tmpl_dict
[key
]:
516 msg_string
= tmpl % tmpl_dict
517 except KeyError, err
:
518 raise CmdException
, 'Unknown patch template variable: %s' \
521 raise CmdException
, 'Only "%(name)s" variables are ' \
522 'supported in the patch template'
524 if options
.edit_patches
:
525 msg_string
= __edit_message(msg_string
)
527 # The Python email message
529 msg
= email
.message_from_string(msg_string
)
530 except Exception, ex
:
531 raise CmdException
, 'template parsing error: %s' % str
(ex
)
534 extra_cc
= __get_signers_list(descr
)
538 __build_address_headers(msg
, options
, extra_cc
)
539 __build_extra_headers(msg
, msg_id
, ref_id
)
540 __encode_message(msg
)
544 def func(parser
, options
, args
):
545 """Send the patches by e-mail using the patchmail.tmpl file as
548 smtpserver
= options
.smtp_server
or config
.get('stgit.smtpserver')
550 applied
= crt_series
.get_applied()
555 unapplied
= crt_series
.get_unapplied()
556 patches
= parse_patches(args
, applied
+ unapplied
, len(applied
))
558 raise CmdException
, 'Incorrect options. Unknown patches to send'
560 # early test for sender identity
563 out
.start('Checking the validity of the patches')
565 if crt_series
.empty_patch(p
):
566 raise CmdException
, 'Cannot send empty patch "%s"' % p
569 smtppassword
= options
.smtp_password
or config
.get('stgit.smtppassword')
570 smtpuser
= options
.smtp_user
or config
.get('stgit.smtpuser')
571 smtpusetls
= options
.smtp_tls
or config
.get('stgit.smtptls') == 'yes'
573 if (smtppassword
and not smtpuser
):
574 raise CmdException
, 'SMTP password supplied, username needed'
575 if (smtpusetls
and not smtpuser
):
576 raise CmdException
, 'SMTP over TLS requested, username needed'
577 if (smtpuser
and not smtppassword
):
578 smtppassword
= getpass
.getpass("Please enter SMTP password: ")
580 total_nr
= len(patches
)
582 raise CmdException
, 'No patches to send'
585 if options
.noreply
or options
.unrelated
:
586 raise CmdException
, \
587 '--refid option not allowed with --noreply or --unrelated'
588 ref_id
= options
.refid
592 sleep
= options
.sleep
or config
.getint('stgit.smtpdelay')
594 # send the cover message (if any)
595 if options
.cover
or options
.edit_cover
:
596 if options
.unrelated
:
597 raise CmdException
, 'cover sending not allowed with --unrelated'
599 # find the template file
601 tmpl
= file(options
.cover
).read()
603 tmpl
= templates
.get_template('covermail.tmpl')
605 raise CmdException
, 'No cover message template file found'
607 msg_id
= email
.Utils
.make_msgid('stgit')
608 msg
= __build_cover(tmpl
, patches
, msg_id
, options
)
609 from_addr
, to_addr_list
= __parse_addresses(msg
)
611 msg_string
= msg
.as_string(options
.mbox
)
613 # subsequent e-mails are seen as replies to the first one
614 if not options
.noreply
:
618 out
.stdout_raw(msg_string
+ '\n')
620 out
.start('Sending the cover message')
621 __send_message(smtpserver
, from_addr
, to_addr_list
, msg_string
,
622 sleep
, smtpuser
, smtppassword
, smtpusetls
)
627 tmpl
= file(options
.template
).read()
630 tmpl
= templates
.get_template('mailattch.tmpl')
632 tmpl
= templates
.get_template('patchmail.tmpl')
634 raise CmdException
, 'No e-mail template file found'
636 for (p
, patch_nr
) in zip(patches
, range(1, len(patches
) + 1)):
637 msg_id
= email
.Utils
.make_msgid('stgit')
638 msg
= __build_message(tmpl
, p
, patch_nr
, total_nr
, msg_id
, ref_id
,
640 from_addr
, to_addr_list
= __parse_addresses(msg
)
642 msg_string
= msg
.as_string(options
.mbox
)
644 # subsequent e-mails are seen as replies to the first one
645 if not options
.noreply
and not options
.unrelated
and not ref_id
:
649 out
.stdout_raw(msg_string
+ '\n')
651 out
.start('Sending patch "%s"' % p
)
652 __send_message(smtpserver
, from_addr
, to_addr_list
, msg_string
,
653 sleep
, smtpuser
, smtppassword
, smtpusetls
)