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
, smtplib
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
import stack
, git
, version
, templates
25 from stgit
.config
import config
28 help = 'send a patch or series of patches by e-mail'
29 usage
= """%prog [options] [<patch1>] [<patch2>] [<patch3>..<patch4>]
31 Send a patch or a range of patches by e-mail using the 'smtpserver'
32 configuration option. The From address and the e-mail format are
33 generated from the template file passed as argument to '--template'
34 (defaulting to '.git/patchmail.tmpl' or
35 '~/.stgit/templates/patchmail.tmpl' or
36 '/usr/share/stgit/templates/patchmail.tmpl').
38 The To/Cc/Bcc addresses can either be added to the template file or
39 passed via the corresponding command line options. They can be e-mail
40 addresses or aliases which are automatically expanded to the values
41 stored in the [mail "alias"] section of GIT configuration files.
43 A preamble e-mail can be sent using the '--cover' and/or
44 '--edit-cover' options. The first allows the user to specify a file to
45 be used as a template. The latter option will invoke the editor on the
46 specified file (defaulting to '.git/covermail.tmpl' or
47 '~/.stgit/templates/covermail.tmpl' or
48 '/usr/share/stgit/templates/covermail.tmpl').
50 All the subsequent e-mails appear as replies to the first e-mail sent
51 (either the preamble or the first patch). E-mails can be seen as
52 replies to a different e-mail by using the '--refid' option.
54 SMTP authentication is also possible with '--smtp-user' and
55 '--smtp-password' options, also available as configuration settings:
56 'smtpuser' and 'smtppassword'.
58 The patch e-mail template accepts the following variables:
60 %(patch)s - patch name
61 %(sender)s - 'sender' or 'authname <authemail>' as per the config file
62 %(shortdescr)s - the first line of the patch description
63 %(longdescr)s - the rest of the patch description, after the first line
64 %(diff)s - unified diff of the patch
65 %(diffstat)s - diff statistics
66 %(version)s - ' version' string passed on the command line (or empty)
67 %(prefix)s - 'prefix ' string passed on the command line
68 %(patchnr)s - patch number
69 %(totalnr)s - total number of patches to be sent
70 %(number)s - empty if only one patch is sent or ' patchnr/totalnr'
71 %(fromauth)s - 'From: author\\n\\n' if different from sender
72 %(authname)s - author's name
73 %(authemail)s - author's email
74 %(authdate)s - patch creation date
75 %(commname)s - committer's name
76 %(commemail)s - committer's e-mail
78 For the preamble e-mail template, only the %(sender)s, %(version)s,
79 %(patchnr)s, %(totalnr)s and %(number)s variables are supported."""
81 options
= [make_option('-a', '--all',
82 help = 'e-mail all the applied patches',
83 action
= 'store_true'),
85 help = 'add TO to the To: list',
88 help = 'add CC to the Cc: list',
91 help = 'add BCC to the Bcc: list',
94 help = 'automatically cc the patch signers',
95 action
= 'store_true'),
96 make_option('--noreply',
97 help = 'do not send subsequent messages as replies',
98 action
= 'store_true'),
99 make_option('-v', '--version', metavar
= 'VERSION',
100 help = 'add VERSION to the [PATCH ...] prefix'),
101 make_option('--prefix', metavar
= 'PREFIX',
102 help = 'add PREFIX to the [... PATCH ...] prefix'),
103 make_option('-t', '--template', metavar
= 'FILE',
104 help = 'use FILE as the message template'),
105 make_option('-c', '--cover', metavar
= 'FILE',
106 help = 'send FILE as the cover message'),
107 make_option('-e', '--edit-cover',
108 help = 'edit the cover message before sending',
109 action
= 'store_true'),
110 make_option('-E', '--edit-patches',
111 help = 'edit each patch before sending',
112 action
= 'store_true'),
113 make_option('-s', '--sleep', type = 'int', metavar
= 'SECONDS',
114 help = 'sleep for SECONDS between e-mails sending'),
115 make_option('--refid',
116 help = 'use REFID as the reference id'),
117 make_option('-u', '--smtp-user', metavar
= 'USER',
118 help = 'username for SMTP authentication'),
119 make_option('-p', '--smtp-password', metavar
= 'PASSWORD',
120 help = 'username for SMTP authentication'),
121 make_option('-b', '--branch',
122 help = 'use BRANCH instead of the default one'),
123 make_option('-m', '--mbox',
124 help = 'generate an mbox file instead of sending',
125 action
= 'store_true')]
129 """Return the 'authname <authemail>' string as read from the
132 sender
=config
.get('stgit.sender')
135 sender
= str(git
.user())
136 except git
.GitException
:
137 sender
= str(git
.author())
140 raise CmdException
, 'unknown sender details'
142 return address_or_alias(sender
)
144 def __parse_addresses(msg
):
145 """Return a two elements tuple: (from, [to])
147 def __addr_list(msg
, header
):
148 return [name_addr
[1] for name_addr
in
149 email
.Utils
.getaddresses(msg
.get_all(header
, []))]
151 from_addr_list
= __addr_list(msg
, 'From')
152 if len(from_addr_list
) == 0:
153 raise CmdException
, 'No "From" address'
155 to_addr_list
= __addr_list(msg
, 'To') + __addr_list(msg
, 'Cc') \
156 + __addr_list(msg
, 'Bcc')
157 if len(to_addr_list
) == 0:
158 raise CmdException
, 'No "To/Cc/Bcc" addresses'
160 return (from_addr_list
[0], to_addr_list
)
162 def __send_message(smtpserver
, from_addr
, to_addr_list
, msg
, sleep
,
163 smtpuser
, smtppassword
):
164 """Send the message using the given SMTP server
167 s
= smtplib
.SMTP(smtpserver
)
168 except Exception, err
:
169 raise CmdException
, str(err
)
173 if smtpuser
and smtppassword
:
175 s
.login(smtpuser
, smtppassword
)
177 s
.sendmail(from_addr
, to_addr_list
, msg
)
178 # give recipients a chance of receiving patches in the correct order
180 except Exception, err
:
181 raise CmdException
, str(err
)
185 def __build_address_headers(msg
, options
, extra_cc
= []):
186 """Build the address headers and check existing headers in the
189 def __replace_header(header
, addr
):
191 crt_addr
= msg
[header
]
195 msg
[header
] = address_or_alias(', '.join([crt_addr
, addr
]))
197 msg
[header
] = address_or_alias(addr
)
203 autobcc
= config
.get('stgit.autobcc') or ''
206 to_addr
= ', '.join(options
.to
)
208 cc_addr
= ', '.join(options
.cc
+ extra_cc
)
210 cc_addr
= ', '.join(extra_cc
)
212 bcc_addr
= ', '.join(options
.bcc
+ [autobcc
])
216 __replace_header('To', to_addr
)
217 __replace_header('Cc', cc_addr
)
218 __replace_header('Bcc', bcc_addr
)
220 def __get_signers_list(msg
):
221 """Return the address list generated from signed-off-by and
222 acked-by lines in the message.
226 r
= re
.compile('^(signed-off-by|acked-by):\s+(.+)$', re
.I
)
227 for line
in msg
.split('\n'):
230 addr_list
.append(m
.expand('\g<2>'))
234 def __build_extra_headers(msg
, msg_id
, ref_id
= None):
235 """Build extra email headers and encoding
238 msg
['Date'] = email
.Utils
.formatdate(localtime
= True)
239 msg
['Message-ID'] = msg_id
241 msg
['In-Reply-To'] = ref_id
242 msg
['References'] = ref_id
243 msg
['User-Agent'] = 'StGIT/%s' % version
.version
245 def __encode_message(msg
):
246 # 7 or 8 bit encoding
247 charset
= email
.Charset
.Charset('utf-8')
248 charset
.body_encoding
= None
251 for header
, value
in msg
.items():
253 for word
in value
.split(' '):
255 uword
= unicode(word
, 'utf-8')
256 except UnicodeDecodeError:
257 # maybe we should try a different encoding or report
258 # the error. At the moment, we just ignore it
260 words
.append(email
.Header
.Header(uword
).encode())
261 new_val
= ' '.join(words
)
262 msg
.replace_header(header
, new_val
)
264 # encode the body and set the MIME and encoding headers
265 msg
.set_charset(charset
)
267 def __edit_message(msg
):
268 fname
= '.stgitmail.txt'
270 # create the initial file
276 editor
= config
.get('stgit.editor')
279 elif 'EDITOR' in os
.environ
:
280 editor
= os
.environ
['EDITOR']
283 editor
+= ' %s' % fname
285 print 'Invoking the editor: "%s"...' % editor
,
287 err
= os
.system(editor
)
289 raise CmdException
, 'editor failed, exit code: %d' % err
292 # read the message back
299 def __build_cover(tmpl
, total_nr
, msg_id
, options
):
300 """Build the cover message (series description) to be sent via SMTP
302 sender
= __get_sender()
305 version_str
= ' %s' % options
.version
310 prefix_str
= options
.prefix
+ ' '
314 total_nr_str
= str(total_nr
)
315 patch_nr_str
= '0'.zfill(len(total_nr_str
))
317 number_str
= ' %s/%s' %
(patch_nr_str
, total_nr_str
)
321 tmpl_dict
= {'sender': sender
,
322 # for backward template compatibility
323 'maintainer': sender
,
324 # for backward template compatibility
326 # for backward template compatibility
328 'version': version_str
,
329 'prefix': prefix_str
,
330 'patchnr': patch_nr_str
,
331 'totalnr': total_nr_str
,
332 'number': number_str
}
335 msg_string
= tmpl % tmpl_dict
336 except KeyError, err
:
337 raise CmdException
, 'Unknown patch template variable: %s' \
340 raise CmdException
, 'Only "%(name)s" variables are ' \
341 'supported in the patch template'
343 if options
.edit_cover
:
344 msg_string
= __edit_message(msg_string
)
346 # The Python email message
348 msg
= email
.message_from_string(msg_string
)
349 except Exception, ex
:
350 raise CmdException
, 'template parsing error: %s' % str
(ex
)
352 __build_address_headers(msg
, options
)
353 __build_extra_headers(msg
, msg_id
, options
.refid
)
354 __encode_message(msg
)
358 def __build_message(tmpl
, patch
, patch_nr
, total_nr
, msg_id
, ref_id
, options
):
359 """Build the message to be sent via SMTP
361 p
= crt_series
.get_patch(patch
)
363 descr
= p
.get_description().strip()
364 descr_lines
= descr
.split('\n')
366 short_descr
= descr_lines
[0].rstrip()
367 long_descr
= '\n'.join(descr_lines
[1:]).lstrip()
369 authname
= p
.get_authname();
370 authemail
= p
.get_authemail();
371 commname
= p
.get_commname();
372 commemail
= p
.get_commemail();
374 sender
= __get_sender()
376 fromauth
= '%s <%s>' %
(authname
, authemail
)
377 if fromauth
!= sender
:
378 fromauth
= 'From: %s\n\n' % fromauth
383 version_str
= ' %s' % options
.version
388 prefix_str
= options
.prefix
+ ' '
392 total_nr_str
= str(total_nr
)
393 patch_nr_str
= str(patch_nr
).zfill(len(total_nr_str
))
395 number_str
= ' %s/%s' %
(patch_nr_str
, total_nr_str
)
399 tmpl_dict
= {'patch': patch
,
401 # for backward template compatibility
402 'maintainer': sender
,
403 'shortdescr': short_descr
,
404 'longdescr': long_descr
,
405 # for backward template compatibility
407 'diff': git
.diff(rev1
= git_id('%s//bottom' % patch
),
408 rev2
= git_id('%s//top' % patch
)),
409 'diffstat': git
.diffstat(rev1
= git_id('%s//bottom'%patch
),
410 rev2
= git_id('%s//top' % patch
)),
411 # for backward template compatibility
413 'version': version_str
,
414 'prefix': prefix_str
,
415 'patchnr': patch_nr_str
,
416 'totalnr': total_nr_str
,
417 'number': number_str
,
418 'fromauth': fromauth
,
419 'authname': authname
,
420 'authemail': authemail
,
421 'authdate': p
.get_authdate(),
422 'commname': commname
,
423 'commemail': commemail
}
425 for key
in tmpl_dict
:
426 if not tmpl_dict
[key
]:
430 msg_string
= tmpl % tmpl_dict
431 except KeyError, err
:
432 raise CmdException
, 'Unknown patch template variable: %s' \
435 raise CmdException
, 'Only "%(name)s" variables are ' \
436 'supported in the patch template'
438 if options
.edit_patches
:
439 msg_string
= __edit_message(msg_string
)
441 # The Python email message
443 msg
= email
.message_from_string(msg_string
)
444 except Exception, ex
:
445 raise CmdException
, 'template parsing error: %s' % str
(ex
)
448 extra_cc
= __get_signers_list(descr
)
452 __build_address_headers(msg
, options
, extra_cc
)
453 __build_extra_headers(msg
, msg_id
, ref_id
)
454 __encode_message(msg
)
458 def func(parser
, options
, args
):
459 """Send the patches by e-mail using the patchmail.tmpl file as
462 smtpserver
= config
.get('stgit.smtpserver')
464 applied
= crt_series
.get_applied()
469 unapplied
= crt_series
.get_unapplied()
470 patches
= parse_patches(args
, applied
+ unapplied
, len(applied
))
472 raise CmdException
, 'Incorrect options. Unknown patches to send'
474 smtppassword
= options
.smtp_password
or config
.get('stgit.smtppassword')
475 smtpuser
= options
.smtp_user
or config
.get('stgit.smtpuser')
477 if (smtppassword
and not smtpuser
):
478 raise CmdException
, 'SMTP password supplied, username needed'
479 if (smtpuser
and not smtppassword
):
480 raise CmdException
, 'SMTP username supplied, password needed'
482 total_nr
= len(patches
)
484 raise CmdException
, 'No patches to send'
489 ref_id
= options
.refid
491 sleep
= options
.sleep
or config
.getint('stgit.smtpdelay')
493 # send the cover message (if any)
494 if options
.cover
or options
.edit_cover
:
495 # find the template file
497 tmpl
= file(options
.cover
).read()
499 tmpl
= templates
.get_template('covermail.tmpl')
501 raise CmdException
, 'No cover message template file found'
503 msg_id
= email
.Utils
.make_msgid('stgit')
504 msg
= __build_cover(tmpl
, total_nr
, msg_id
, options
)
505 from_addr
, to_addr_list
= __parse_addresses(msg
)
507 msg_string
= msg
.as_string(options
.mbox
)
509 # subsequent e-mails are seen as replies to the first one
510 if not options
.noreply
:
516 print 'Sending the cover message...',
518 __send_message(smtpserver
, from_addr
, to_addr_list
, msg_string
,
519 sleep
, smtpuser
, smtppassword
)
524 tmpl
= file(options
.template
).read()
526 tmpl
= templates
.get_template('patchmail.tmpl')
528 raise CmdException
, 'No e-mail template file found'
530 for (p
, patch_nr
) in zip(patches
, range(1, len(patches
) + 1)):
531 msg_id
= email
.Utils
.make_msgid('stgit')
532 msg
= __build_message(tmpl
, p
, patch_nr
, total_nr
, msg_id
, ref_id
,
534 from_addr
, to_addr_list
= __parse_addresses(msg
)
536 msg_string
= msg
.as_string(options
.mbox
)
538 # subsequent e-mails are seen as replies to the first one
539 if not options
.noreply
and not ref_id
:
545 print 'Sending patch "%s"...' % p
,
547 __send_message(smtpserver
, from_addr
, to_addr_list
, msg_string
,
548 sleep
, smtpuser
, smtppassword
)