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 '--in-reply-to' 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('--no-thread', 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('--in-reply-to', metavar
= '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 opt('--git', action
= 'store_true',
145 short
= 'Use git send-email (EXPERIMENTAL)')
146 ] + argparse
.diff_opts_option()
148 directory
= DirectoryHasRepository(log
= False)
151 """Return the 'authname <authemail>' string as read from the
154 sender
=config
.get('stgit.sender')
157 sender
= str(git
.user())
158 except git
.GitException
:
160 sender
= str(git
.author())
161 except git
.GitException
:
164 raise CmdException
, ('Unknown sender name and e-mail; you should'
165 ' for example set git config user.name and'
167 sender
= email
.Utils
.parseaddr(sender
)
169 return email
.Utils
.formataddr(address_or_alias(sender
))
171 def __addr_list(msg
, header
):
172 return [addr
for name
, addr
in
173 email
.Utils
.getaddresses(msg
.get_all(header
, []))]
175 def __parse_addresses(msg
):
176 """Return a two elements tuple: (from, [to])
178 from_addr_list
= __addr_list(msg
, 'From')
179 if len(from_addr_list
) == 0:
180 raise CmdException
, 'No "From" address'
182 to_addr_list
= __addr_list(msg
, 'To') + __addr_list(msg
, 'Cc') \
183 + __addr_list(msg
, 'Bcc')
184 if len(to_addr_list
) == 0:
185 raise CmdException
, 'No "To/Cc/Bcc" addresses'
187 return (from_addr_list
[0], set(to_addr_list
))
189 def __send_message_sendmail(sendmail
, msg
):
190 """Send the message using the sendmail command.
192 cmd
= sendmail
.split()
193 Run(*cmd
).raw_input(msg
).discard_output()
195 __smtp_credentials
= None
197 def __set_smtp_credentials(options
):
198 """Set the (smtpuser, smtppassword, smtpusetls) credentials if the method
201 global __smtp_credentials
203 smtpserver
= options
.smtp_server
or config
.get('stgit.smtpserver')
204 if options
.mbox
or options
.git
or smtpserver
.startswith('/'):
207 smtppassword
= options
.smtp_password
or config
.get('stgit.smtppassword')
208 smtpuser
= options
.smtp_user
or config
.get('stgit.smtpuser')
209 smtpusetls
= options
.smtp_tls
or config
.get('stgit.smtptls') == 'yes'
211 if (smtppassword
and not smtpuser
):
212 raise CmdException('SMTP password supplied, username needed')
213 if (smtpusetls
and not smtpuser
):
214 raise CmdException('SMTP over TLS requested, username needed')
215 if (smtpuser
and not smtppassword
):
216 smtppassword
= getpass
.getpass("Please enter SMTP password: ")
218 __smtp_credentials
= (smtpuser
, smtppassword
, smtpusetls
)
220 def __send_message_smtp(smtpserver
, from_addr
, to_addr_list
, msg
, options
):
221 """Send the message using the given SMTP server
223 smtpuser
, smtppassword
, smtpusetls
= __smtp_credentials
226 s
= smtplib
.SMTP(smtpserver
)
227 except Exception, err
:
228 raise CmdException
, str(err
)
232 if smtpuser
and smtppassword
:
235 if not hasattr(socket
, 'ssl'):
236 raise CmdException
, "cannot use TLS - no SSL support in Python"
239 s
.login(smtpuser
, smtppassword
)
241 result
= s
.sendmail(from_addr
, to_addr_list
, msg
)
243 print "mail server refused delivery for the following recipients: %s" % result
244 except Exception, err
:
245 raise CmdException
, str(err
)
249 def __send_message_git(msg
, options
):
250 """Send the message using git send-email
252 from subprocess
import call
253 from tempfile
import mkstemp
255 cmd
= ["git", "send-email", "--from=%s" % msg
['From']]
256 cmd
.append("--quiet")
257 cmd
.append("--suppress-cc=self")
259 cmd
.append("--suppress-cc=body")
260 if options
.in_reply_to
:
261 cmd
.extend(["--in-reply-to", options
.in_reply_to
])
262 if options
.no_thread
:
263 cmd
.append("--no-thread")
265 # We only support To/Cc/Bcc in git send-email for now.
266 for x
in ['to', 'cc', 'bcc']:
267 if getattr(options
, x
):
268 cmd
.extend('--%s=%s' %
(x
, a
) for a
in getattr(options
, x
))
270 (fd
, path
) = mkstemp()
271 os
.write(fd
, msg
.as_string(options
.mbox
))
278 except Exception, err
:
279 raise CmdException
, str(err
)
283 def __send_message(type, tmpl
, options
, *args
):
284 """Message sending dispatcher.
286 (build
, outstr
) = {'cover': (__build_cover
, 'the cover message'),
287 'patch': (__build_message
, 'patch "%s"' % args
[0])}[type]
289 (patch_nr
, total_nr
) = (args
[1], args
[2])
291 msg_id
= email
.Utils
.make_msgid('stgit')
292 msg
= build(tmpl
, msg_id
, options
, *args
)
294 msg_str
= msg
.as_string(options
.mbox
)
296 out
.stdout_raw(msg_str
+ '\n')
300 from_addr
, to_addrs
= __parse_addresses(msg
)
301 out
.start('Sending ' + outstr
)
303 smtpserver
= options
.smtp_server
or config
.get('stgit.smtpserver')
305 __send_message_git(msg
, options
)
306 elif smtpserver
.startswith('/'):
307 # Use the sendmail tool
308 __send_message_sendmail(smtpserver
, msg_str
)
310 # Use the SMTP server (we have host and port information)
311 __send_message_smtp(smtpserver
, from_addr
, to_addrs
, msg_str
, options
)
313 # give recipients a chance of receiving related patches in correct order
314 if type == 'cover' or (type == 'patch' and patch_nr
< total_nr
):
315 sleep
= options
.sleep
or config
.getint('stgit.smtpdelay')
321 def __update_header(msg
, header
, addr
= '', ignore
= ()):
322 def __addr_pairs(msg
, header
, extra
):
323 pairs
= email
.Utils
.getaddresses(msg
.get_all(header
, []) + extra
)
324 # remove pairs without an address and resolve the aliases
325 return [address_or_alias(p
) for p
in pairs
if p
[1]]
327 addr_pairs
= __addr_pairs(msg
, header
, [addr
])
329 # remove the duplicates and filter the addresses
330 addr_dict
= dict((addr
, email
.Utils
.formataddr((name
, addr
)))
331 for name
, addr
in addr_pairs
if addr
not in ignore
)
333 msg
[header
] = ', '.join(addr_dict
.itervalues())
334 return set(addr_dict
.iterkeys())
336 def __build_address_headers(msg
, options
, extra_cc
= []):
337 """Build the address headers and check existing headers in the
345 autobcc
= config
.get('stgit.autobcc') or ''
348 to_addr
= ', '.join(options
.to
)
350 cc_addr
= ', '.join(options
.cc
)
352 extra_cc_addr
= ', '.join(extra_cc
)
354 bcc_addr
= ', '.join(options
.bcc
+ [autobcc
])
358 # if an address is on a header, ignore it from the rest
359 to_set
= __update_header(msg
, 'To', to_addr
)
360 cc_set
= __update_header(msg
, 'Cc', cc_addr
, to_set
)
361 bcc_set
= __update_header(msg
, 'Bcc', bcc_addr
, to_set
.union(cc_set
))
363 # --auto generated addresses, don't include the sender
364 from_set
= __update_header(msg
, 'From')
365 __update_header(msg
, 'Cc', extra_cc_addr
,
366 to_set
.union(bcc_set
).union(from_set
))
368 def __get_signers_list(msg
):
369 """Return the address list generated from signed-off-by and
370 acked-by lines in the message.
373 tags
= '%s|%s|%s|%s|%s|%s|%s' %
(
380 'reported-and-tested-by')
381 regex
= '^(%s):\s+(.+)$' % tags
383 r
= re
.compile(regex
, re
.I
)
384 for line
in msg
.split('\n'):
387 addr_list
.append(m
.expand('\g<2>'))
391 def __build_extra_headers(msg
, msg_id
, ref_id
= None):
392 """Build extra email headers and encoding
395 msg
['Date'] = email
.Utils
.formatdate(localtime
= True)
396 msg
['Message-ID'] = msg_id
398 # make sure the ref id has the angle brackets
399 ref_id
= '<%s>' % ref_id
.strip(' \t\n<>')
400 msg
['In-Reply-To'] = ref_id
401 msg
['References'] = ref_id
402 msg
['User-Agent'] = 'StGit/%s' % version
.version
404 # update other address headers
405 __update_header(msg
, 'Reply-To')
406 __update_header(msg
, 'Mail-Reply-To')
407 __update_header(msg
, 'Mail-Followup-To')
410 def __encode_message(msg
):
411 # 7 or 8 bit encoding
412 charset
= email
.Charset
.Charset('utf-8')
413 charset
.body_encoding
= None
416 for header
, value
in msg
.items():
418 for word
in value
.split(' '):
420 uword
= unicode(word
, 'utf-8')
421 except UnicodeDecodeError:
422 # maybe we should try a different encoding or report
423 # the error. At the moment, we just ignore it
425 words
.append(email
.Header
.Header(uword
).encode())
426 new_val
= ' '.join(words
)
427 msg
.replace_header(header
, new_val
)
429 # encode the body and set the MIME and encoding headers
430 if msg
.is_multipart():
431 for p
in msg
.get_payload():
432 p
.set_charset(charset
)
434 msg
.set_charset(charset
)
436 def __edit_message(msg
):
437 fname
= '.stgitmail.txt'
439 # create the initial file
446 # read the message back
453 def __build_cover(tmpl
, msg_id
, options
, patches
):
454 """Build the cover message (series description) to be sent via SMTP
456 sender
= __get_sender()
459 version_str
= ' %s' % options
.version
464 prefix_str
= options
.prefix
+ ' '
466 confprefix
= config
.get('stgit.mail.prefix')
468 prefix_str
= confprefix
+ ' '
472 total_nr_str
= str(len(patches
))
473 patch_nr_str
= '0'.zfill(len(total_nr_str
))
475 number_str
= ' %s/%s' %
(patch_nr_str
, total_nr_str
)
479 tmpl_dict
= {'sender': sender
,
480 # for backward template compatibility
481 'maintainer': sender
,
482 # for backward template compatibility
484 # for backward template compatibility
486 'version': version_str
,
487 'prefix': prefix_str
,
488 'patchnr': patch_nr_str
,
489 'totalnr': total_nr_str
,
490 'number': number_str
,
491 'shortlog': stack
.shortlog(crt_series
.get_patch(p
)
492 for p
in reversed(patches
)),
493 'diffstat': gitlib
.diffstat(git
.diff(
494 rev1
= git_id(crt_series
, '%s^' % patches
[0]),
495 rev2
= git_id(crt_series
, '%s' % patches
[-1]),
496 diff_flags
= options
.diff_flags
))}
499 msg_string
= tmpl % tmpl_dict
500 except KeyError, err
:
501 raise CmdException
, 'Unknown patch template variable: %s' \
504 raise CmdException
, 'Only "%(name)s" variables are ' \
505 'supported in the patch template'
507 if options
.edit_cover
:
508 msg_string
= __edit_message(msg_string
)
510 # The Python email message
512 msg
= email
.message_from_string(msg_string
)
513 except Exception, ex
:
514 raise CmdException
, 'template parsing error: %s' % str
(ex
)
517 __build_address_headers(msg
, options
)
518 __build_extra_headers(msg
, msg_id
, options
.in_reply_to
)
519 __encode_message(msg
)
523 def __build_message(tmpl
, msg_id
, options
, patch
, patch_nr
, total_nr
, ref_id
):
524 """Build the message to be sent via SMTP
526 p
= crt_series
.get_patch(patch
)
528 if p
.get_description():
529 descr
= p
.get_description().strip()
531 # provide a place holder and force the edit message option on
532 descr
= '<empty message>'
533 options
.edit_patches
= True
535 descr_lines
= descr
.split('\n')
536 short_descr
= descr_lines
[0].strip()
537 long_descr
= '\n'.join(l
.rstrip() for l
in descr_lines
[1:]).lstrip('\n')
539 authname
= p
.get_authname();
540 authemail
= p
.get_authemail();
541 commname
= p
.get_commname();
542 commemail
= p
.get_commemail();
544 sender
= __get_sender()
546 fromauth
= '%s <%s>' %
(authname
, authemail
)
547 if fromauth
!= sender
:
548 fromauth
= 'From: %s\n\n' % fromauth
553 version_str
= ' %s' % options
.version
558 prefix_str
= options
.prefix
+ ' '
560 confprefix
= config
.get('stgit.mail.prefix')
562 prefix_str
= confprefix
+ ' '
566 total_nr_str
= str(total_nr
)
567 patch_nr_str
= str(patch_nr
).zfill(len(total_nr_str
))
568 if not options
.unrelated
and total_nr
> 1:
569 number_str
= ' %s/%s' %
(patch_nr_str
, total_nr_str
)
573 diff
= git
.diff(rev1
= git_id(crt_series
, '%s^' % patch
),
574 rev2
= git_id(crt_series
, '%s' % patch
),
575 diff_flags
= options
.diff_flags
)
576 tmpl_dict
= {'patch': patch
,
578 # for backward template compatibility
579 'maintainer': sender
,
580 'shortdescr': short_descr
,
581 'longdescr': long_descr
,
582 # for backward template compatibility
585 'diffstat': gitlib
.diffstat(diff
),
586 # for backward template compatibility
588 'version': version_str
,
589 'prefix': prefix_str
,
590 'patchnr': patch_nr_str
,
591 'totalnr': total_nr_str
,
592 'number': number_str
,
593 'fromauth': fromauth
,
594 'authname': authname
,
595 'authemail': authemail
,
596 'authdate': p
.get_authdate(),
597 'commname': commname
,
598 'commemail': commemail
}
600 for key
in tmpl_dict
:
601 if not tmpl_dict
[key
]:
605 msg_string
= tmpl % tmpl_dict
606 except KeyError, err
:
607 raise CmdException
, 'Unknown patch template variable: %s' \
610 raise CmdException
, 'Only "%(name)s" variables are ' \
611 'supported in the patch template'
613 if options
.edit_patches
:
614 msg_string
= __edit_message(msg_string
)
616 # The Python email message
618 msg
= email
.message_from_string(msg_string
)
619 except Exception, ex
:
620 raise CmdException
, 'template parsing error: %s' % str
(ex
)
623 extra_cc
= __get_signers_list(descr
)
628 __build_address_headers(msg
, options
, extra_cc
)
629 __build_extra_headers(msg
, msg_id
, ref_id
)
630 __encode_message(msg
)
634 def func(parser
, options
, args
):
635 """Send the patches by e-mail using the patchmail.tmpl file as
638 applied
= crt_series
.get_applied()
643 unapplied
= crt_series
.get_unapplied()
644 patches
= parse_patches(args
, applied
+ unapplied
, len(applied
))
646 raise CmdException
, 'Incorrect options. Unknown patches to send'
648 # early test for sender identity
651 out
.start('Checking the validity of the patches')
653 if crt_series
.empty_patch(p
):
654 raise CmdException
, 'Cannot send empty patch "%s"' % p
657 total_nr
= len(patches
)
659 raise CmdException
, 'No patches to send'
661 if options
.in_reply_to
:
662 if options
.no_thread
or options
.unrelated
:
663 raise CmdException
, \
664 '--in-reply-to option not allowed with --no-thread or --unrelated'
665 ref_id
= options
.in_reply_to
669 # get username/password if sending by SMTP
670 __set_smtp_credentials(options
)
672 # send the cover message (if any)
673 if options
.cover
or options
.edit_cover
:
674 if options
.unrelated
:
675 raise CmdException
, 'cover sending not allowed with --unrelated'
677 # find the template file
679 tmpl
= file(options
.cover
).read()
681 tmpl
= templates
.get_template('covermail.tmpl')
683 raise CmdException
, 'No cover message template file found'
685 msg_id
= __send_message('cover', tmpl
, options
, patches
)
687 # subsequent e-mails are seen as replies to the first one
688 if not options
.no_thread
:
693 tmpl
= file(options
.template
).read()
696 tmpl
= templates
.get_template('mailattch.tmpl')
698 tmpl
= templates
.get_template('patchmail.tmpl')
700 raise CmdException
, 'No e-mail template file found'
702 for (p
, n
) in zip(patches
, range(1, total_nr
+ 1)):
703 msg_id
= __send_message('patch', tmpl
, options
, p
, n
, total_nr
, ref_id
)
705 # subsequent e-mails are seen as replies to the first one
706 if not options
.no_thread
and not options
.unrelated
and not ref_id
: