6f61b83d2e66bc428742c562db505c5c868b07c5
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 if config
.has_option('stgit', 'sender'):
133 sender
= config
.get('stgit', 'sender')
136 sender
= str(git
.user())
137 except git
.GitException
:
138 sender
= str(git
.author())
141 raise CmdException
, 'unknown sender details'
143 return address_or_alias(sender
)
145 def __parse_addresses(addresses
):
146 """Return a two elements tuple: (from, [to])
148 def __addr_list(addrs
):
149 m
= re
.search('[^@\s<,]+@[^>\s,]+', addrs
);
152 return [ m
.group() ] + __addr_list(addrs
[m
.end():])
156 for line
in addresses
.split('\n'):
157 if re
.match('from:\s+', line
, re
.I
):
158 from_addr_list
+= __addr_list(line
)
159 elif re
.match('(to|cc|bcc):\s+', line
, re
.I
):
160 to_addr_list
+= __addr_list(line
)
162 if len(from_addr_list
) == 0:
163 raise CmdException
, 'No "From" address'
164 if len(to_addr_list
) == 0:
165 raise CmdException
, 'No "To/Cc/Bcc" addresses'
167 return (from_addr_list
[0], to_addr_list
)
169 def __send_message(smtpserver
, from_addr
, to_addr_list
, msg
, sleep
,
170 smtpuser
, smtppassword
):
171 """Send the message using the given SMTP server
174 s
= smtplib
.SMTP(smtpserver
)
175 except Exception, err
:
176 raise CmdException
, str(err
)
180 if smtpuser
and smtppassword
:
182 s
.login(smtpuser
, smtppassword
)
184 s
.sendmail(from_addr
, to_addr_list
, msg
)
185 # give recipients a chance of receiving patches in the correct order
187 except Exception, err
:
188 raise CmdException
, str(err
)
192 def __build_address_headers(msg
, options
, extra_cc
= []):
193 """Build the address headers and check existing headers in the
196 def __replace_header(header
, addr
):
198 crt_addr
= msg
[header
]
202 msg
[header
] = address_or_alias(', '.join([crt_addr
, addr
]))
204 msg
[header
] = address_or_alias(addr
)
210 if config
.has_option('stgit', 'autobcc'):
211 autobcc
= config
.get('stgit', 'autobcc')
216 to_addr
= ', '.join(options
.to
)
218 cc_addr
= ', '.join(options
.cc
+ extra_cc
)
220 cc_addr
= ', '.join(extra_cc
)
222 bcc_addr
= ', '.join(options
.bcc
+ [autobcc
])
226 __replace_header('To', to_addr
)
227 __replace_header('Cc', cc_addr
)
228 __replace_header('Bcc', bcc_addr
)
230 def __get_signers_list(msg
):
231 """Return the address list generated from signed-off-by and
232 acked-by lines in the message.
236 r
= re
.compile('^(signed-off-by|acked-by):\s+(.+)$', re
.I
)
237 for line
in msg
.split('\n'):
240 addr_list
.append(m
.expand('\g<2>'))
244 def __build_extra_headers(msg
, msg_id
, ref_id
= None):
245 """Build extra email headers and encoding
248 msg
['Date'] = email
.Utils
.formatdate(localtime
= True)
249 msg
['Message-ID'] = msg_id
251 msg
['In-Reply-To'] = ref_id
252 msg
['References'] = ref_id
253 msg
['User-Agent'] = 'StGIT/%s' % version
.version
255 def __encode_message(msg
):
256 # 7 or 8 bit encoding
257 charset
= email
.Charset
.Charset('utf-8')
258 charset
.body_encoding
= None
261 for header
, value
in msg
.items():
263 for word
in value
.split(' '):
265 uword
= unicode(word
, 'utf-8')
266 except UnicodeDecodeError:
267 # maybe we should try a different encoding or report
268 # the error. At the moment, we just ignore it
270 words
.append(email
.Header
.Header(uword
).encode())
271 new_val
= ' '.join(words
)
272 msg
.replace_header(header
, new_val
)
274 # encode the body and set the MIME and encoding headers
275 msg
.set_charset(charset
)
277 def __edit_message(msg
):
278 fname
= '.stgitmail.txt'
280 # create the initial file
286 if config
.has_option('stgit', 'editor'):
287 editor
= config
.get('stgit', 'editor')
288 elif 'EDITOR' in os
.environ
:
289 editor
= os
.environ
['EDITOR']
292 editor
+= ' %s' % fname
294 print 'Invoking the editor: "%s"...' % editor
,
296 print 'done (exit code: %d)' % os
.system(editor
)
298 # read the message back
305 def __build_cover(tmpl
, total_nr
, msg_id
, options
):
306 """Build the cover message (series description) to be sent via SMTP
308 sender
= __get_sender()
311 version_str
= ' %s' % options
.version
316 prefix_str
= options
.prefix
+ ' '
320 total_nr_str
= str(total_nr
)
321 patch_nr_str
= '0'.zfill(len(total_nr_str
))
323 number_str
= ' %s/%s' %
(patch_nr_str
, total_nr_str
)
327 tmpl_dict
= {'sender': sender
,
328 # for backward template compatibility
329 'maintainer': sender
,
330 # for backward template compatibility
332 # for backward template compatibility
334 'version': version_str
,
335 'prefix': prefix_str
,
336 'patchnr': patch_nr_str
,
337 'totalnr': total_nr_str
,
338 'number': number_str
}
341 msg_string
= tmpl % tmpl_dict
342 except KeyError, err
:
343 raise CmdException
, 'Unknown patch template variable: %s' \
346 raise CmdException
, 'Only "%(name)s" variables are ' \
347 'supported in the patch template'
349 if options
.edit_cover
:
350 msg_string
= __edit_message(msg_string
)
352 # The Python email message
354 msg
= email
.message_from_string(msg_string
)
355 except Exception, ex
:
356 raise CmdException
, 'template parsing error: %s' % str
(ex
)
358 __build_address_headers(msg
, options
)
359 __build_extra_headers(msg
, msg_id
, options
.refid
)
360 __encode_message(msg
)
362 msg_string
= msg
.as_string(options
.mbox
)
364 return msg_string
.strip('\n')
366 def __build_message(tmpl
, patch
, patch_nr
, total_nr
, msg_id
, ref_id
, options
):
367 """Build the message to be sent via SMTP
369 p
= crt_series
.get_patch(patch
)
371 descr
= p
.get_description().strip()
372 descr_lines
= descr
.split('\n')
374 short_descr
= descr_lines
[0].rstrip()
375 long_descr
= '\n'.join(descr_lines
[1:]).lstrip()
377 authname
= p
.get_authname();
378 authemail
= p
.get_authemail();
379 commname
= p
.get_commname();
380 commemail
= p
.get_commemail();
382 sender
= __get_sender()
384 fromauth
= '%s <%s>' %
(authname
, authemail
)
385 if fromauth
!= sender
:
386 fromauth
= 'From: %s\n\n' % fromauth
391 version_str
= ' %s' % options
.version
396 prefix_str
= options
.prefix
+ ' '
400 total_nr_str
= str(total_nr
)
401 patch_nr_str
= str(patch_nr
).zfill(len(total_nr_str
))
403 number_str
= ' %s/%s' %
(patch_nr_str
, total_nr_str
)
407 tmpl_dict
= {'patch': patch
,
409 # for backward template compatibility
410 'maintainer': sender
,
411 'shortdescr': short_descr
,
412 'longdescr': long_descr
,
413 # for backward template compatibility
415 'diff': git
.diff(rev1
= git_id('%s//bottom' % patch
),
416 rev2
= git_id('%s//top' % patch
)),
417 'diffstat': git
.diffstat(rev1
= git_id('%s//bottom'%patch
),
418 rev2
= git_id('%s//top' % patch
)),
419 # for backward template compatibility
421 'version': version_str
,
422 'prefix': prefix_str
,
423 'patchnr': patch_nr_str
,
424 'totalnr': total_nr_str
,
425 'number': number_str
,
426 'fromauth': fromauth
,
427 'authname': authname
,
428 'authemail': authemail
,
429 'authdate': p
.get_authdate(),
430 'commname': commname
,
431 'commemail': commemail
}
433 for key
in tmpl_dict
:
434 if not tmpl_dict
[key
]:
438 msg_string
= tmpl % tmpl_dict
439 except KeyError, err
:
440 raise CmdException
, 'Unknown patch template variable: %s' \
443 raise CmdException
, 'Only "%(name)s" variables are ' \
444 'supported in the patch template'
446 if options
.edit_patches
:
447 msg_string
= __edit_message(msg_string
)
449 # The Python email message
451 msg
= email
.message_from_string(msg_string
)
452 except Exception, ex
:
453 raise CmdException
, 'template parsing error: %s' % str
(ex
)
456 extra_cc
= __get_signers_list(descr
)
460 __build_address_headers(msg
, options
, extra_cc
)
461 __build_extra_headers(msg
, msg_id
, ref_id
)
462 __encode_message(msg
)
464 msg_string
= msg
.as_string(options
.mbox
)
466 return msg_string
.strip('\n')
468 def func(parser
, options
, args
):
469 """Send the patches by e-mail using the patchmail.tmpl file as
472 smtpserver
= config
.get('stgit', 'smtpserver')
476 if config
.has_option('stgit', 'smtpuser'):
477 smtpuser
= config
.get('stgit', 'smtpuser')
478 if config
.has_option('stgit', 'smtppassword'):
479 smtppassword
= config
.get('stgit', 'smtppassword')
481 applied
= crt_series
.get_applied()
486 unapplied
= crt_series
.get_unapplied()
487 patches
= parse_patches(args
, applied
+ unapplied
, len(applied
))
489 raise CmdException
, 'Incorrect options. Unknown patches to send'
491 if options
.smtp_password
:
492 smtppassword
= options
.smtp_password
494 if options
.smtp_user
:
495 smtpuser
= options
.smtp_user
497 if (smtppassword
and not smtpuser
):
498 raise CmdException
, 'SMTP password supplied, username needed'
499 if (smtpuser
and not smtppassword
):
500 raise CmdException
, 'SMTP username supplied, password needed'
502 total_nr
= len(patches
)
504 raise CmdException
, 'No patches to send'
509 ref_id
= options
.refid
511 if options
.sleep
!= None:
512 sleep
= options
.sleep
514 sleep
= config
.getint('stgit', 'smtpdelay')
516 # send the cover message (if any)
517 if options
.cover
or options
.edit_cover
:
518 # find the template file
520 tmpl
= file(options
.cover
).read()
522 tmpl
= templates
.get_template('covermail.tmpl')
524 raise CmdException
, 'No cover message template file found'
526 msg_id
= email
.Utils
.make_msgid('stgit')
527 msg
= __build_cover(tmpl
, total_nr
, msg_id
, options
)
528 from_addr
, to_addr_list
= __parse_addresses(msg
)
530 # subsequent e-mails are seen as replies to the first one
531 if not options
.noreply
:
538 print 'Sending the cover message...',
540 __send_message(smtpserver
, from_addr
, to_addr_list
, msg
, sleep
,
541 smtpuser
, smtppassword
)
546 tmpl
= file(options
.template
).read()
548 tmpl
= templates
.get_template('patchmail.tmpl')
550 raise CmdException
, 'No e-mail template file found'
552 for (p
, patch_nr
) in zip(patches
, range(1, len(patches
) + 1)):
553 msg_id
= email
.Utils
.make_msgid('stgit')
554 msg
= __build_message(tmpl
, p
, patch_nr
, total_nr
, msg_id
, ref_id
,
556 from_addr
, to_addr_list
= __parse_addresses(msg
)
558 # subsequent e-mails are seen as replies to the first one
559 if not options
.noreply
and not ref_id
:
566 print 'Sending patch "%s"...' % p
,
568 __send_message(smtpserver
, from_addr
, to_addr_list
, msg
, sleep
,
569 smtpuser
, smtppassword
)