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 or
36 '/usr/share/stgit/templates/patchmail.tmpl'). The To/Cc/Bcc addresses
37 can either be added to the template file or passed via the
38 corresponding command line options.
40 A preamble e-mail can be sent using the '--cover' and/or
41 '--edit-cover' options. The first allows the user to specify a file to
42 be used as a template. The latter option will invoke the editor on the
43 specified file (defaulting to '.git/covermail.tmpl' or
44 '~/.stgit/templates/covermail.tmpl' or
45 '/usr/share/stgit/templates/covermail.tmpl').
47 All the subsequent e-mails appear as replies to the first e-mail sent
48 (either the preamble or the first patch). E-mails can be seen as
49 replies to a different e-mail by using the '--refid' option.
51 SMTP authentication is also possible with '--smtp-user' and
52 '--smtp-password' options, also available as configuration settings:
53 'smtpuser' and 'smtppassword'.
55 The patch e-mail template accepts the following variables:
57 %(patch)s - patch name
58 %(sender)s - 'sender' or 'authname <authemail>' as per the config file
59 %(shortdescr)s - the first line of the patch description
60 %(longdescr)s - the rest of the patch description, after the first line
61 %(diff)s - unified diff of the patch
62 %(diffstat)s - diff statistics
63 %(version)s - ' version' string passed on the command line (or empty)
64 %(prefix)s - 'prefix ' string passed on the command line
65 %(patchnr)s - patch number
66 %(totalnr)s - total number of patches to be sent
67 %(number)s - empty if only one patch is sent or ' patchnr/totalnr'
68 %(fromauth)s - 'From: author\\n\\n' if different from sender
69 %(authname)s - author's name
70 %(authemail)s - author's email
71 %(authdate)s - patch creation date
72 %(commname)s - committer's name
73 %(commemail)s - committer's e-mail
75 For the preamble e-mail template, only the %(sender)s, %(version)s,
76 %(patchnr)s, %(totalnr)s and %(number)s variables are supported."""
78 options
= [make_option('-a', '--all',
79 help = 'e-mail all the applied patches',
80 action
= 'store_true'),
82 help = 'add TO to the To: list',
85 help = 'add CC to the Cc: list',
88 help = 'add BCC to the Bcc: list',
91 help = 'automatically cc the patch signers',
92 action
= 'store_true'),
93 make_option('--noreply',
94 help = 'do not send subsequent messages as replies',
95 action
= 'store_true'),
96 make_option('-v', '--version', metavar
= 'VERSION',
97 help = 'add VERSION to the [PATCH ...] prefix'),
98 make_option('--prefix', metavar
= 'PREFIX',
99 help = 'add PREFIX to the [... PATCH ...] prefix'),
100 make_option('-t', '--template', metavar
= 'FILE',
101 help = 'use FILE as the message template'),
102 make_option('-c', '--cover', metavar
= 'FILE',
103 help = 'send FILE as the cover message'),
104 make_option('-e', '--edit-cover',
105 help = 'edit the cover message before sending',
106 action
= 'store_true'),
107 make_option('-E', '--edit-patches',
108 help = 'edit each patch before sending',
109 action
= 'store_true'),
110 make_option('-s', '--sleep', type = 'int', metavar
= 'SECONDS',
111 help = 'sleep for SECONDS between e-mails sending'),
112 make_option('--refid',
113 help = 'use REFID as the reference id'),
114 make_option('-u', '--smtp-user', metavar
= 'USER',
115 help = 'username for SMTP authentication'),
116 make_option('-p', '--smtp-password', metavar
= 'PASSWORD',
117 help = 'username for SMTP authentication'),
118 make_option('-b', '--branch',
119 help = 'use BRANCH instead of the default one'),
120 make_option('-m', '--mbox',
121 help = 'generate an mbox file instead of sending',
122 action
= 'store_true')]
126 """Return the 'authname <authemail>' string as read from the
129 if config
.has_option('stgit', 'sender'):
130 sender
= config
.get('stgit', 'sender')
133 sender
= str(git
.user())
134 except git
.GitException
:
135 sender
= str(git
.author())
138 raise CmdException
, 'unknown sender details'
142 def __parse_addresses(addresses
):
143 """Return a two elements tuple: (from, [to])
145 def __addr_list(addrs
):
146 m
= re
.search('[^@\s<,]+@[^>\s,]+', addrs
);
149 return [ m
.group() ] + __addr_list(addrs
[m
.end():])
153 for line
in addresses
.split('\n'):
154 if re
.match('from:\s+', line
, re
.I
):
155 from_addr_list
+= __addr_list(line
)
156 elif re
.match('(to|cc|bcc):\s+', line
, re
.I
):
157 to_addr_list
+= __addr_list(line
)
159 if len(from_addr_list
) == 0:
160 raise CmdException
, 'No "From" address'
161 if len(to_addr_list
) == 0:
162 raise CmdException
, 'No "To/Cc/Bcc" addresses'
164 return (from_addr_list
[0], to_addr_list
)
166 def __send_message(smtpserver
, from_addr
, to_addr_list
, msg
, sleep
,
167 smtpuser
, smtppassword
):
168 """Send the message using the given SMTP server
171 s
= smtplib
.SMTP(smtpserver
)
172 except Exception, err
:
173 raise CmdException
, str(err
)
177 if smtpuser
and smtppassword
:
179 s
.login(smtpuser
, smtppassword
)
181 s
.sendmail(from_addr
, to_addr_list
, msg
)
182 # give recipients a chance of receiving patches in the correct order
184 except Exception, err
:
185 raise CmdException
, str(err
)
189 def __build_address_headers(msg
, options
, extra_cc
= []):
190 """Build the address headers and check existing headers in the
193 def __replace_header(header
, addr
):
195 crt_addr
= msg
[header
]
199 msg
[header
] = ', '.join([crt_addr
, addr
])
207 if config
.has_option('stgit', 'autobcc'):
208 autobcc
= config
.get('stgit', 'autobcc')
213 to_addr
= ', '.join(options
.to
)
215 cc_addr
= ', '.join(options
.cc
+ extra_cc
)
217 cc_addr
= ', '.join(extra_cc
)
219 bcc_addr
= ', '.join(options
.bcc
+ [autobcc
])
223 __replace_header('To', to_addr
)
224 __replace_header('Cc', cc_addr
)
225 __replace_header('Bcc', bcc_addr
)
227 def __get_signers_list(msg
):
228 """Return the address list generated from signed-off-by and
229 acked-by lines in the message.
233 r
= re
.compile('^(signed-off-by|acked-by):\s+(.+)$', re
.I
)
234 for line
in msg
.split('\n'):
237 addr_list
.append(m
.expand('\g<2>'))
241 def __build_extra_headers(msg
, msg_id
, ref_id
= None):
242 """Build extra email headers and encoding
245 msg
['Date'] = email
.Utils
.formatdate(localtime
= True)
246 msg
['Message-ID'] = msg_id
248 msg
['In-Reply-To'] = ref_id
249 msg
['References'] = ref_id
250 msg
['User-Agent'] = 'StGIT/%s' % version
.version
252 def __encode_message(msg
):
253 # 7 or 8 bit encoding
254 charset
= email
.Charset
.Charset('utf-8')
255 charset
.body_encoding
= None
258 for header
, value
in msg
.items():
260 for word
in value
.split(' '):
262 uword
= unicode(word
, 'utf-8')
263 except UnicodeDecodeError:
264 # maybe we should try a different encoding or report
265 # the error. At the moment, we just ignore it
267 words
.append(email
.Header
.Header(uword
).encode())
268 new_val
= ' '.join(words
)
269 msg
.replace_header(header
, new_val
)
271 # encode the body and set the MIME and encoding headers
272 msg
.set_charset(charset
)
274 def __edit_message(msg
):
275 fname
= '.stgitmail.txt'
277 # create the initial file
283 if config
.has_option('stgit', 'editor'):
284 editor
= config
.get('stgit', 'editor')
285 elif 'EDITOR' in os
.environ
:
286 editor
= os
.environ
['EDITOR']
289 editor
+= ' %s' % fname
291 print 'Invoking the editor: "%s"...' % editor
,
293 print 'done (exit code: %d)' % os
.system(editor
)
295 # read the message back
302 def __build_cover(tmpl
, total_nr
, msg_id
, options
):
303 """Build the cover message (series description) to be sent via SMTP
305 sender
= __get_sender()
308 version_str
= ' %s' % options
.version
313 prefix_str
= options
.prefix
+ ' '
317 total_nr_str
= str(total_nr
)
318 patch_nr_str
= '0'.zfill(len(total_nr_str
))
320 number_str
= ' %s/%s' %
(patch_nr_str
, total_nr_str
)
324 tmpl_dict
= {'sender': sender
,
325 # for backward template compatibility
326 'maintainer': sender
,
327 # for backward template compatibility
329 # for backward template compatibility
331 'version': version_str
,
332 'prefix': prefix_str
,
333 'patchnr': patch_nr_str
,
334 'totalnr': total_nr_str
,
335 'number': number_str
}
338 msg_string
= tmpl % tmpl_dict
339 except KeyError, err
:
340 raise CmdException
, 'Unknown patch template variable: %s' \
343 raise CmdException
, 'Only "%(name)s" variables are ' \
344 'supported in the patch template'
346 if options
.edit_cover
:
347 msg_string
= __edit_message(msg_string
)
349 # The Python email message
351 msg
= email
.message_from_string(msg_string
)
352 except Exception, ex
:
353 raise CmdException
, 'template parsing error: %s' % str
(ex
)
355 __build_address_headers(msg
, options
)
356 __build_extra_headers(msg
, msg_id
, options
.refid
)
357 __encode_message(msg
)
359 msg_string
= msg
.as_string(options
.mbox
)
361 return msg_string
.strip('\n')
363 def __build_message(tmpl
, patch
, patch_nr
, total_nr
, msg_id
, ref_id
, options
):
364 """Build the message to be sent via SMTP
366 p
= crt_series
.get_patch(patch
)
368 descr
= p
.get_description().strip()
369 descr_lines
= descr
.split('\n')
371 short_descr
= descr_lines
[0].rstrip()
372 long_descr
= '\n'.join(descr_lines
[1:]).lstrip()
374 authname
= p
.get_authname();
375 authemail
= p
.get_authemail();
376 commname
= p
.get_commname();
377 commemail
= p
.get_commemail();
379 sender
= __get_sender()
381 fromauth
= '%s <%s>' %
(authname
, authemail
)
382 if fromauth
!= sender
:
383 fromauth
= 'From: %s\n\n' % fromauth
388 version_str
= ' %s' % options
.version
393 prefix_str
= options
.prefix
+ ' '
397 total_nr_str
= str(total_nr
)
398 patch_nr_str
= str(patch_nr
).zfill(len(total_nr_str
))
400 number_str
= ' %s/%s' %
(patch_nr_str
, total_nr_str
)
404 tmpl_dict
= {'patch': patch
,
406 # for backward template compatibility
407 'maintainer': sender
,
408 'shortdescr': short_descr
,
409 'longdescr': long_descr
,
410 # for backward template compatibility
412 'diff': git
.diff(rev1
= git_id('%s//bottom' % patch
),
413 rev2
= git_id('%s//top' % patch
)),
414 'diffstat': git
.diffstat(rev1
= git_id('%s//bottom'%patch
),
415 rev2
= git_id('%s//top' % patch
)),
416 # for backward template compatibility
418 'version': version_str
,
419 'prefix': prefix_str
,
420 'patchnr': patch_nr_str
,
421 'totalnr': total_nr_str
,
422 'number': number_str
,
423 'fromauth': fromauth
,
424 'authname': authname
,
425 'authemail': authemail
,
426 'authdate': p
.get_authdate(),
427 'commname': commname
,
428 'commemail': commemail
}
430 for key
in tmpl_dict
:
431 if not tmpl_dict
[key
]:
435 msg_string
= tmpl % tmpl_dict
436 except KeyError, err
:
437 raise CmdException
, 'Unknown patch template variable: %s' \
440 raise CmdException
, 'Only "%(name)s" variables are ' \
441 'supported in the patch template'
443 if options
.edit_patches
:
444 msg_string
= __edit_message(msg_string
)
446 # The Python email message
448 msg
= email
.message_from_string(msg_string
)
449 except Exception, ex
:
450 raise CmdException
, 'template parsing error: %s' % str
(ex
)
453 extra_cc
= __get_signers_list(descr
)
457 __build_address_headers(msg
, options
, extra_cc
)
458 __build_extra_headers(msg
, msg_id
, ref_id
)
459 __encode_message(msg
)
461 msg_string
= msg
.as_string(options
.mbox
)
463 return msg_string
.strip('\n')
465 def func(parser
, options
, args
):
466 """Send the patches by e-mail using the patchmail.tmpl file as
469 smtpserver
= config
.get('stgit', 'smtpserver')
473 if config
.has_option('stgit', 'smtpuser'):
474 smtpuser
= config
.get('stgit', 'smtpuser')
475 if config
.has_option('stgit', 'smtppassword'):
476 smtppassword
= config
.get('stgit', 'smtppassword')
478 applied
= crt_series
.get_applied()
483 patches
= parse_patches(args
, applied
)
485 raise CmdException
, 'Incorrect options. Unknown patches to send'
487 if options
.smtp_password
:
488 smtppassword
= options
.smtp_password
490 if options
.smtp_user
:
491 smtpuser
= options
.smtp_user
493 if (smtppassword
and not smtpuser
):
494 raise CmdException
, 'SMTP password supplied, username needed'
495 if (smtpuser
and not smtppassword
):
496 raise CmdException
, 'SMTP username supplied, password needed'
498 total_nr
= len(patches
)
500 raise CmdException
, 'No patches to send'
505 ref_id
= options
.refid
507 if options
.sleep
!= None:
508 sleep
= options
.sleep
510 sleep
= config
.getint('stgit', 'smtpdelay')
512 # send the cover message (if any)
513 if options
.cover
or options
.edit_cover
:
514 # find the template file
516 tmpl
= file(options
.cover
).read()
518 tmpl
= templates
.get_template('covermail.tmpl')
520 raise CmdException
, 'No cover message template file found'
522 msg_id
= email
.Utils
.make_msgid('stgit')
523 msg
= __build_cover(tmpl
, total_nr
, msg_id
, options
)
524 from_addr
, to_addr_list
= __parse_addresses(msg
)
526 # subsequent e-mails are seen as replies to the first one
527 if not options
.noreply
:
534 print 'Sending the cover message...',
536 __send_message(smtpserver
, from_addr
, to_addr_list
, msg
, sleep
,
537 smtpuser
, smtppassword
)
542 tmpl
= file(options
.template
).read()
544 tmpl
= templates
.get_template('patchmail.tmpl')
546 raise CmdException
, 'No e-mail template file found'
548 for (p
, patch_nr
) in zip(patches
, range(1, len(patches
) + 1)):
549 msg_id
= email
.Utils
.make_msgid('stgit')
550 msg
= __build_message(tmpl
, p
, patch_nr
, total_nr
, msg_id
, ref_id
,
552 from_addr
, to_addr_list
= __parse_addresses(msg
)
554 # subsequent e-mails are seen as replies to the first one
555 if not options
.noreply
and not ref_id
:
562 print 'Sending patch "%s"...' % p
,
564 __send_message(smtpserver
, from_addr
, to_addr_list
, msg
, sleep
,
565 smtpuser
, smtppassword
)