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 optparse
import OptionParser
, make_option
22 from stgit
.commands
.common
import *
23 from stgit
.utils
import *
24 from stgit
.out
import *
25 from stgit
import stack
, git
, version
, templates
26 from stgit
.config
import config
29 help = 'send a patch or series of patches by e-mail'
30 usage
= r
"""%prog [options] [<patch1>] [<patch2>] [<patch3>..<patch4>]
32 Send a patch or a range of patches by e-mail using the SMTP server
33 specified by the 'stgit.smtpserver' configuration option, or the
34 '--smtp-server' command line option. The From address and the e-mail
35 format are generated from the template file passed as argument to
36 '--template' (defaulting to '.git/patchmail.tmpl' or
37 '~/.stgit/templates/patchmail.tmpl' or
38 '/usr/share/stgit/templates/patchmail.tmpl'). A patch can be sent as
39 attachment using the --attach option in which case the 'mailattch.tmpl'
40 template will be used instead of 'patchmail.tmpl'.
42 The To/Cc/Bcc addresses can either be added to the template file or
43 passed via the corresponding command line options. They can be e-mail
44 addresses or aliases which are automatically expanded to the values
45 stored in the [mail "alias"] section of GIT configuration files.
47 A preamble e-mail can be sent using the '--cover' and/or
48 '--edit-cover' options. The first allows the user to specify a file to
49 be used as a template. The latter option will invoke the editor on the
50 specified file (defaulting to '.git/covermail.tmpl' or
51 '~/.stgit/templates/covermail.tmpl' or
52 '/usr/share/stgit/templates/covermail.tmpl').
54 All the subsequent e-mails appear as replies to the first e-mail sent
55 (either the preamble or the first patch). E-mails can be seen as
56 replies to a different e-mail by using the '--refid' option.
58 SMTP authentication is also possible with '--smtp-user' and
59 '--smtp-password' options, also available as configuration settings:
60 'smtpuser' and 'smtppassword'. TLS encryption can be enabled by
61 '--smtp-tls' option and 'smtptls' setting.
63 The following variables are accepted by both the preamble and the
64 patch e-mail templates:
66 %(diffstat)s - diff statistics
67 %(number)s - empty if only one patch is sent or ' patchnr/totalnr'
68 %(patchnr)s - patch number
69 %(sender)s - 'sender' or 'authname <authemail>' as per the config file
70 %(totalnr)s - total number of patches to be sent
71 %(version)s - ' version' string passed on the command line (or empty)
73 In addition to the common variables, the preamble e-mail template
74 accepts the following:
76 %(shortlog)s - first line of each patch description, listed by author
78 In addition to the common variables, the patch e-mail template accepts
81 %(authdate)s - patch creation date
82 %(authemail)s - author's email
83 %(authname)s - author's name
84 %(commemail)s - committer's e-mail
85 %(commname)s - committer's name
86 %(diff)s - unified diff of the patch
87 %(fromauth)s - 'From: author\n\n' if different from sender
88 %(longdescr)s - the rest of the patch description, after the first line
89 %(patch)s - patch name
90 %(prefix)s - 'prefix ' string passed on the command line
91 %(shortdescr)s - the first line of the patch description"""
93 directory
= DirectoryHasRepository()
94 options
= [make_option('-a', '--all',
95 help = 'e-mail all the applied patches',
96 action
= 'store_true'),
98 help = 'add TO to the To: list',
101 help = 'add CC to the Cc: list',
104 help = 'add BCC to the Bcc: list',
106 make_option('--auto',
107 help = 'automatically cc the patch signers',
108 action
= 'store_true'),
109 make_option('--noreply',
110 help = 'do not send subsequent messages as replies',
111 action
= 'store_true'),
112 make_option('--unrelated',
113 help = 'send patches without sequence numbering',
114 action
= 'store_true'),
115 make_option('--attach',
116 help = 'send a patch as attachment',
117 action
= 'store_true'),
118 make_option('-v', '--version', metavar
= 'VERSION',
119 help = 'add VERSION to the [PATCH ...] prefix'),
120 make_option('--prefix', metavar
= 'PREFIX',
121 help = 'add PREFIX to the [... PATCH ...] prefix'),
122 make_option('-t', '--template', metavar
= 'FILE',
123 help = 'use FILE as the message template'),
124 make_option('-c', '--cover', metavar
= 'FILE',
125 help = 'send FILE as the cover message'),
126 make_option('-e', '--edit-cover',
127 help = 'edit the cover message before sending',
128 action
= 'store_true'),
129 make_option('-E', '--edit-patches',
130 help = 'edit each patch before sending',
131 action
= 'store_true'),
132 make_option('-s', '--sleep', type = 'int', metavar
= 'SECONDS',
133 help = 'sleep for SECONDS between e-mails sending'),
134 make_option('--refid',
135 help = 'use REFID as the reference id'),
136 make_option('--smtp-server', metavar
= 'HOST[:PORT]',
137 help = 'SMTP server to use for sending mail'),
138 make_option('-u', '--smtp-user', metavar
= 'USER',
139 help = 'username for SMTP authentication'),
140 make_option('-p', '--smtp-password', metavar
= 'PASSWORD',
141 help = 'username for SMTP authentication'),
142 make_option('-T', '--smtp-tls',
143 help = 'use SMTP with TLS encryption',
144 action
= 'store_true'),
145 make_option('-b', '--branch',
146 help = 'use BRANCH instead of the default one'),
147 make_option('-m', '--mbox',
148 help = 'generate an mbox file instead of sending',
149 action
= 'store_true')
150 ] + make_diff_opts_option()
154 """Return the 'authname <authemail>' string as read from the
157 sender
=config
.get('stgit.sender')
160 sender
= str(git
.user())
161 except git
.GitException
:
162 sender
= str(git
.author())
165 raise CmdException
, 'unknown sender details'
167 return address_or_alias(sender
)
169 def __parse_addresses(msg
):
170 """Return a two elements tuple: (from, [to])
172 def __addr_list(msg
, header
):
173 return [name_addr
[1] for name_addr
in
174 email
.Utils
.getaddresses(msg
.get_all(header
, []))]
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], to_addr_list
)
187 def __send_message(smtpserver
, from_addr
, to_addr_list
, msg
, sleep
,
188 smtpuser
, smtppassword
, use_tls
):
189 """Send the message using the given SMTP server
192 s
= smtplib
.SMTP(smtpserver
)
193 except Exception, err
:
194 raise CmdException
, str(err
)
198 if smtpuser
and smtppassword
:
201 if not hasattr(socket
, 'ssl'):
202 raise CmdException
, "cannot use TLS - no SSL support in Python"
205 s
.login(smtpuser
, smtppassword
)
207 result
= s
.sendmail(from_addr
, to_addr_list
, msg
)
209 print "mail server refused delivery for the following recipients: %s" % result
210 # give recipients a chance of receiving patches in the correct order
212 except Exception, err
:
213 raise CmdException
, str(err
)
217 def __build_address_headers(msg
, options
, extra_cc
= []):
218 """Build the address headers and check existing headers in the
221 def __replace_header(header
, addr
):
223 crt_addr
= msg
[header
]
227 msg
[header
] = address_or_alias(', '.join([crt_addr
, addr
]))
229 msg
[header
] = address_or_alias(addr
)
235 autobcc
= config
.get('stgit.autobcc') or ''
238 to_addr
= ', '.join(options
.to
)
240 cc_addr
= ', '.join(options
.cc
+ extra_cc
)
241 cc_addr
= ', '.join(options
.cc
+ extra_cc
)
243 cc_addr
= ', '.join(extra_cc
)
245 bcc_addr
= ', '.join(options
.bcc
+ [autobcc
])
249 __replace_header('To', to_addr
)
250 __replace_header('Cc', cc_addr
)
251 __replace_header('Bcc', bcc_addr
)
253 def __get_signers_list(msg
):
254 """Return the address list generated from signed-off-by and
255 acked-by lines in the message.
259 r
= re
.compile('^(signed-off-by|acked-by|cc):\s+(.+)$', re
.I
)
260 for line
in msg
.split('\n'):
263 addr_list
.append(m
.expand('\g<2>'))
267 def __build_extra_headers(msg
, msg_id
, ref_id
= None):
268 """Build extra email headers and encoding
271 msg
['Date'] = email
.Utils
.formatdate(localtime
= True)
272 msg
['Message-ID'] = msg_id
274 # make sure the ref id has the angle brackets
275 ref_id
= '<%s>' % ref_id
.strip(' \t\n<>')
276 msg
['In-Reply-To'] = ref_id
277 msg
['References'] = ref_id
278 msg
['User-Agent'] = 'StGIT/%s' % version
.version
280 def __encode_message(msg
):
281 # 7 or 8 bit encoding
282 charset
= email
.Charset
.Charset('utf-8')
283 charset
.body_encoding
= None
286 for header
, value
in msg
.items():
288 for word
in value
.split(' '):
290 uword
= unicode(word
, 'utf-8')
291 except UnicodeDecodeError:
292 # maybe we should try a different encoding or report
293 # the error. At the moment, we just ignore it
295 words
.append(email
.Header
.Header(uword
).encode())
296 new_val
= ' '.join(words
)
297 msg
.replace_header(header
, new_val
)
299 # encode the body and set the MIME and encoding headers
300 if msg
.is_multipart():
301 for p
in msg
.get_payload():
302 p
.set_charset(charset
)
304 msg
.set_charset(charset
)
306 def __edit_message(msg
):
307 fname
= '.stgitmail.txt'
309 # create the initial file
316 # read the message back
323 def __build_cover(tmpl
, patches
, msg_id
, options
):
324 """Build the cover message (series description) to be sent via SMTP
326 sender
= __get_sender()
329 version_str
= ' %s' % options
.version
334 prefix_str
= options
.prefix
+ ' '
336 confprefix
= config
.get('stgit.mail.prefix')
338 prefix_str
= confprefix
+ ' '
342 total_nr_str
= str(len(patches
))
343 patch_nr_str
= '0'.zfill(len(total_nr_str
))
345 number_str
= ' %s/%s' %
(patch_nr_str
, total_nr_str
)
349 tmpl_dict
= {'sender': sender
,
350 # for backward template compatibility
351 'maintainer': sender
,
352 # for backward template compatibility
354 # for backward template compatibility
356 'version': version_str
,
357 'prefix': prefix_str
,
358 'patchnr': patch_nr_str
,
359 'totalnr': total_nr_str
,
360 'number': number_str
,
361 'shortlog': stack
.shortlog(crt_series
.get_patch(p
)
363 'diffstat': git
.diffstat(git
.diff(
364 rev1
= git_id(crt_series
, '%s//bottom' % patches
[0]),
365 rev2
= git_id(crt_series
, '%s//top' % patches
[-1])))}
368 msg_string
= tmpl % tmpl_dict
369 except KeyError, err
:
370 raise CmdException
, 'Unknown patch template variable: %s' \
373 raise CmdException
, 'Only "%(name)s" variables are ' \
374 'supported in the patch template'
376 if options
.edit_cover
:
377 msg_string
= __edit_message(msg_string
)
379 # The Python email message
381 msg
= email
.message_from_string(msg_string
)
382 except Exception, ex
:
383 raise CmdException
, 'template parsing error: %s' % str
(ex
)
385 __build_address_headers(msg
, options
)
386 __build_extra_headers(msg
, msg_id
, options
.refid
)
387 __encode_message(msg
)
391 def __build_message(tmpl
, patch
, patch_nr
, total_nr
, msg_id
, ref_id
, options
):
392 """Build the message to be sent via SMTP
394 p
= crt_series
.get_patch(patch
)
396 if p
.get_description():
397 descr
= p
.get_description().strip()
399 # provide a place holder and force the edit message option on
400 descr
= '<empty message>'
401 options
.edit_patches
= True
403 descr_lines
= descr
.split('\n')
404 short_descr
= descr_lines
[0].rstrip()
405 long_descr
= '\n'.join(descr_lines
[1:]).lstrip()
407 authname
= p
.get_authname();
408 authemail
= p
.get_authemail();
409 commname
= p
.get_commname();
410 commemail
= p
.get_commemail();
412 sender
= __get_sender()
414 fromauth
= '%s <%s>' %
(authname
, authemail
)
415 if fromauth
!= sender
:
416 fromauth
= 'From: %s\n\n' % fromauth
421 version_str
= ' %s' % options
.version
426 prefix_str
= options
.prefix
+ ' '
428 confprefix
= config
.get('stgit.mail.prefix')
430 prefix_str
= confprefix
+ ' '
434 total_nr_str
= str(total_nr
)
435 patch_nr_str
= str(patch_nr
).zfill(len(total_nr_str
))
436 if not options
.unrelated
and total_nr
> 1:
437 number_str
= ' %s/%s' %
(patch_nr_str
, total_nr_str
)
441 diff
= git
.diff(rev1
= git_id(crt_series
, '%s//bottom' % patch
),
442 rev2
= git_id(crt_series
, '%s//top' % patch
),
443 diff_flags
= options
.diff_flags
)
444 tmpl_dict
= {'patch': patch
,
446 # for backward template compatibility
447 'maintainer': sender
,
448 'shortdescr': short_descr
,
449 'longdescr': long_descr
,
450 # for backward template compatibility
453 'diffstat': git
.diffstat(diff
),
454 # for backward template compatibility
456 'version': version_str
,
457 'prefix': prefix_str
,
458 'patchnr': patch_nr_str
,
459 'totalnr': total_nr_str
,
460 'number': number_str
,
461 'fromauth': fromauth
,
462 'authname': authname
,
463 'authemail': authemail
,
464 'authdate': p
.get_authdate(),
465 'commname': commname
,
466 'commemail': commemail
}
468 for key
in tmpl_dict
:
469 if not tmpl_dict
[key
]:
473 msg_string
= tmpl % tmpl_dict
474 except KeyError, err
:
475 raise CmdException
, 'Unknown patch template variable: %s' \
478 raise CmdException
, 'Only "%(name)s" variables are ' \
479 'supported in the patch template'
481 if options
.edit_patches
:
482 msg_string
= __edit_message(msg_string
)
484 # The Python email message
486 msg
= email
.message_from_string(msg_string
)
487 except Exception, ex
:
488 raise CmdException
, 'template parsing error: %s' % str
(ex
)
491 extra_cc
= __get_signers_list(descr
)
495 __build_address_headers(msg
, options
, extra_cc
)
496 __build_extra_headers(msg
, msg_id
, ref_id
)
497 __encode_message(msg
)
501 def func(parser
, options
, args
):
502 """Send the patches by e-mail using the patchmail.tmpl file as
505 smtpserver
= options
.smtp_server
or config
.get('stgit.smtpserver')
507 applied
= crt_series
.get_applied()
512 unapplied
= crt_series
.get_unapplied()
513 patches
= parse_patches(args
, applied
+ unapplied
, len(applied
))
515 raise CmdException
, 'Incorrect options. Unknown patches to send'
517 out
.start('Checking the validity of the patches')
519 if crt_series
.empty_patch(p
):
520 raise CmdException
, 'Cannot send empty patch "%s"' % p
523 smtppassword
= options
.smtp_password
or config
.get('stgit.smtppassword')
524 smtpuser
= options
.smtp_user
or config
.get('stgit.smtpuser')
525 smtpusetls
= options
.smtp_tls
or config
.get('stgit.smtptls') == 'yes'
527 if (smtppassword
and not smtpuser
):
528 raise CmdException
, 'SMTP password supplied, username needed'
529 if (smtpusetls
and not smtpuser
):
530 raise CmdException
, 'SMTP over TLS requested, username needed'
531 if (smtpuser
and not smtppassword
):
532 smtppassword
= getpass
.getpass("Please enter SMTP password: ")
534 total_nr
= len(patches
)
536 raise CmdException
, 'No patches to send'
539 if options
.noreply
or options
.unrelated
:
540 raise CmdException
, \
541 '--refid option not allowed with --noreply or --unrelated'
542 ref_id
= options
.refid
546 sleep
= options
.sleep
or config
.getint('stgit.smtpdelay')
548 # send the cover message (if any)
549 if options
.cover
or options
.edit_cover
:
550 if options
.unrelated
:
551 raise CmdException
, 'cover sending not allowed with --unrelated'
553 # find the template file
555 tmpl
= file(options
.cover
).read()
557 tmpl
= templates
.get_template('covermail.tmpl')
559 raise CmdException
, 'No cover message template file found'
561 msg_id
= email
.Utils
.make_msgid('stgit')
562 msg
= __build_cover(tmpl
, patches
, msg_id
, options
)
563 from_addr
, to_addr_list
= __parse_addresses(msg
)
565 msg_string
= msg
.as_string(options
.mbox
)
567 # subsequent e-mails are seen as replies to the first one
568 if not options
.noreply
:
572 out
.stdout_raw(msg_string
+ '\n')
574 out
.start('Sending the cover message')
575 __send_message(smtpserver
, from_addr
, to_addr_list
, msg_string
,
576 sleep
, smtpuser
, smtppassword
, smtpusetls
)
581 tmpl
= file(options
.template
).read()
584 tmpl
= templates
.get_template('mailattch.tmpl')
586 tmpl
= templates
.get_template('patchmail.tmpl')
588 raise CmdException
, 'No e-mail template file found'
590 for (p
, patch_nr
) in zip(patches
, range(1, len(patches
) + 1)):
591 msg_id
= email
.Utils
.make_msgid('stgit')
592 msg
= __build_message(tmpl
, p
, patch_nr
, total_nr
, msg_id
, ref_id
,
594 from_addr
, to_addr_list
= __parse_addresses(msg
)
596 msg_string
= msg
.as_string(options
.mbox
)
598 # subsequent e-mails are seen as replies to the first one
599 if not options
.noreply
and not options
.unrelated
and not ref_id
:
603 out
.stdout_raw(msg_string
+ '\n')
605 out
.start('Sending patch "%s"' % p
)
606 __send_message(smtpserver
, from_addr
, to_addr_list
, msg_string
,
607 sleep
, smtpuser
, smtppassword
, smtpusetls
)