stg mail: Refactor __send_message and friends
[stgit] / stgit / commands / mail.py
CommitLineData
b4bddc06
CM
1__copyright__ = """
2Copyright (C) 2005, Catalin Marinas <catalin.marinas@gmail.com>
3
4This program is free software; you can redistribute it and/or modify
5it under the terms of the GNU General Public License version 2 as
6published by the Free Software Foundation.
7
8This program is distributed in the hope that it will be useful,
9but WITHOUT ANY WARRANTY; without even the implied warranty of
10MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11GNU General Public License for more details.
12
13You should have received a copy of the GNU General Public License
14along with this program; if not, write to the Free Software
15Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16"""
17
6cf5ec9b 18import sys, os, re, time, datetime, socket, smtplib, getpass
61eed152 19import email, email.Utils, email.Header
575bbdae 20from stgit.argparse import opt
b4bddc06
CM
21from stgit.commands.common import *
22from stgit.utils import *
5e888f30 23from stgit.out import *
20a52e06 24from stgit import argparse, stack, git, version, templates
b4bddc06 25from stgit.config import config
a0fe60a2 26from stgit.run import Run
ef954fe6 27from stgit.lib import git as gitlib
b4bddc06 28
575bbdae 29help = 'Send a patch or series of patches by e-mail'
33ff9cdd 30kind = 'patch'
54239abf 31usage = [' [options] [--] [<patch1>] [<patch2>] [<patch3>..<patch4>]']
575bbdae 32description = r"""
cec913c4
KH
33Send a patch or a range of patches by e-mail using the SMTP server
34specified by the 'stgit.smtpserver' configuration option, or the
a0fe60a2
CM
35'--smtp-server' command line option. This option can also be an
36absolute path to 'sendmail' followed by command line arguments.
37
38The From address and the e-mail format are generated from the template
39file passed as argument to '--template' (defaulting to
40'.git/patchmail.tmpl' or '~/.stgit/templates/patchmail.tmpl' or
e5c32acf 41'/usr/share/stgit/templates/patchmail.tmpl'). A patch can be sent as
a0fe60a2
CM
42attachment using the --attach option in which case the
43'mailattch.tmpl' template will be used instead of 'patchmail.tmpl'.
79df2f0d
CM
44
45The To/Cc/Bcc addresses can either be added to the template file or
46passed via the corresponding command line options. They can be e-mail
47addresses or aliases which are automatically expanded to the values
48stored in the [mail "alias"] section of GIT configuration files.
2bb96902 49
0ba13ee9
KH
50A 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
52be used as a template. The latter option will invoke the editor on the
53specified file (defaulting to '.git/covermail.tmpl' or
94d18868
YD
54'~/.stgit/templates/covermail.tmpl' or
55'/usr/share/stgit/templates/covermail.tmpl').
e3e05587
CM
56
57All 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
59replies to a different e-mail by using the '--refid' option.
26aab5b0
CM
60
61SMTP authentication is also possible with '--smtp-user' and
62'--smtp-password' options, also available as configuration settings:
fc44c2ca
PR
63'smtpuser' and 'smtppassword'. TLS encryption can be enabled by
64'--smtp-tls' option and 'smtptls' setting.
26aab5b0 65
27827959
KH
66The following variables are accepted by both the preamble and the
67patch e-mail templates:
26aab5b0 68
26aab5b0 69 %(diffstat)s - diff statistics
27827959 70 %(number)s - empty if only one patch is sent or ' patchnr/totalnr'
26aab5b0 71 %(patchnr)s - patch number
27827959 72 %(sender)s - 'sender' or 'authname <authemail>' as per the config file
26aab5b0 73 %(totalnr)s - total number of patches to be sent
27827959
KH
74 %(version)s - ' version' string passed on the command line (or empty)
75
76In addition to the common variables, the preamble e-mail template
77accepts the following:
78
79 %(shortlog)s - first line of each patch description, listed by author
80
81In addition to the common variables, the patch e-mail template accepts
82the following:
83
26aab5b0 84 %(authdate)s - patch creation date
27827959
KH
85 %(authemail)s - author's email
86 %(authname)s - author's name
26aab5b0 87 %(commemail)s - committer's e-mail
27827959
KH
88 %(commname)s - committer's name
89 %(diff)s - unified diff of the patch
77eeb7f4 90 %(fromauth)s - 'From: author\n\n' if different from sender
27827959
KH
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"""
b4bddc06 95
6c8a90e1
KH
96args = [argparse.patch_range(argparse.applied_patches,
97 argparse.unapplied_patches,
98 argparse.hidden_patches)]
575bbdae
KH
99options = [
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('--noreply', 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('--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'),
6c8a90e1 140 opt('-b', '--branch', args = [argparse.stg_branches],
575bbdae
KH
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 ] + argparse.diff_opts_option()
145
117ed129 146directory = DirectoryHasRepository(log = False)
b4bddc06 147
901288c2 148def __get_sender():
dae0f0be
CM
149 """Return the 'authname <authemail>' string as read from the
150 configuration file
151 """
c73e63b7
YD
152 sender=config.get('stgit.sender')
153 if not sender:
9e3f506f
KH
154 try:
155 sender = str(git.user())
156 except git.GitException:
ea09f8ce
GH
157 try:
158 sender = str(git.author())
159 except git.GitException:
160 pass
9e3f506f 161 if not sender:
ea09f8ce
GH
162 raise CmdException, ('Unknown sender name and e-mail; you should'
163 ' for example set git config user.name and'
164 ' user.email')
cd74a041
CM
165 sender = email.Utils.parseaddr(sender)
166
167 return email.Utils.formataddr(address_or_alias(sender))
dae0f0be 168
cd74a041
CM
169def __addr_list(msg, header):
170 return [addr for name, addr in
171 email.Utils.getaddresses(msg.get_all(header, []))]
9e3f506f 172
d650d6ed 173def __parse_addresses(msg):
b4bddc06
CM
174 """Return a two elements tuple: (from, [to])
175 """
d650d6ed 176 from_addr_list = __addr_list(msg, 'From')
24aadb3f 177 if len(from_addr_list) == 0:
b4bddc06 178 raise CmdException, 'No "From" address'
d650d6ed
CM
179
180 to_addr_list = __addr_list(msg, 'To') + __addr_list(msg, 'Cc') \
181 + __addr_list(msg, 'Bcc')
b4bddc06
CM
182 if len(to_addr_list) == 0:
183 raise CmdException, 'No "To/Cc/Bcc" addresses'
184
cd74a041 185 return (from_addr_list[0], set(to_addr_list))
b4bddc06 186
a0fe60a2
CM
187def __send_message_sendmail(sendmail, msg):
188 """Send the message using the sendmail command.
189 """
190 cmd = sendmail.split()
191 Run(*cmd).raw_input(msg).discard_output()
192
89d7ec43 193def __send_message_smtp(smtpserver, from_addr, to_addr_list, msg, options):
b4bddc06
CM
194 """Send the message using the given SMTP server
195 """
89d7ec43
AC
196 smtppassword = options.smtp_password or config.get('stgit.smtppassword')
197 smtpuser = options.smtp_user or config.get('stgit.smtpuser')
198 smtpusetls = options.smtp_tls or config.get('stgit.smtptls') == 'yes'
199
200 if (smtppassword and not smtpuser):
201 raise CmdException('SMTP password supplied, username needed')
202 if (smtpusetls and not smtpuser):
203 raise CmdException('SMTP over TLS requested, username needed')
204 if (smtpuser and not smtppassword):
205 smtppassword = getpass.getpass("Please enter SMTP password: ")
206
b4bddc06
CM
207 try:
208 s = smtplib.SMTP(smtpserver)
209 except Exception, err:
210 raise CmdException, str(err)
211
212 s.set_debuglevel(0)
213 try:
eb026d93
B
214 if smtpuser and smtppassword:
215 s.ehlo()
89d7ec43 216 if smtpusetls:
fc44c2ca
PR
217 if not hasattr(socket, 'ssl'):
218 raise CmdException, "cannot use TLS - no SSL support in Python"
219 s.starttls()
220 s.ehlo()
eb026d93
B
221 s.login(smtpuser, smtppassword)
222
0bc1343c
YD
223 result = s.sendmail(from_addr, to_addr_list, msg)
224 if len(result):
225 print "mail server refused delivery for the following recipients: %s" % result
b4bddc06
CM
226 except Exception, err:
227 raise CmdException, str(err)
228
229 s.quit()
230
89d7ec43 231def __send_message(from_addr, to_addr_list, msg, options):
a0fe60a2
CM
232 """Message sending dispatcher.
233 """
89d7ec43
AC
234 smtpserver = options.smtp_server or config.get('stgit.smtpserver')
235
a0fe60a2
CM
236 if smtpserver.startswith('/'):
237 # Use the sendmail tool
238 __send_message_sendmail(smtpserver, msg)
239 else:
240 # Use the SMTP server (we have host and port information)
89d7ec43 241 __send_message_smtp(smtpserver, from_addr, to_addr_list, msg, options)
a0fe60a2 242
61eed152 243def __build_address_headers(msg, options, extra_cc = []):
f8d1cf65
CM
244 """Build the address headers and check existing headers in the
245 template.
246 """
cd74a041
CM
247 def __addr_pairs(msg, header, extra):
248 pairs = email.Utils.getaddresses(msg.get_all(header, []) + extra)
249 # remove pairs without an address and resolve the aliases
250 return [address_or_alias(p) for p in pairs if p[1]]
251
252 def __update_header(header, addr = '', ignore = ()):
253 addr_pairs = __addr_pairs(msg, header, [addr])
254 del msg[header]
255 # remove the duplicates and filter the addresses
256 addr_dict = dict((addr, email.Utils.formataddr((name, addr)))
257 for name, addr in addr_pairs if addr not in ignore)
258 if addr_dict:
259 msg[header] = ', '.join(addr_dict.itervalues())
260 return set(addr_dict.iterkeys())
f8d1cf65 261
f8d1cf65
CM
262 to_addr = ''
263 cc_addr = ''
cd74a041 264 extra_cc_addr = ''
f8d1cf65
CM
265 bcc_addr = ''
266
c73e63b7 267 autobcc = config.get('stgit.autobcc') or ''
d884c4d8 268
e83b3149 269 if options.to:
61eed152 270 to_addr = ', '.join(options.to)
e83b3149 271 if options.cc:
cd74a041
CM
272 cc_addr = ', '.join(options.cc)
273 if extra_cc:
274 extra_cc_addr = ', '.join(extra_cc)
e83b3149 275 if options.bcc:
61eed152 276 bcc_addr = ', '.join(options.bcc + [autobcc])
d884c4d8
CM
277 elif autobcc:
278 bcc_addr = autobcc
f8d1cf65 279
cd74a041
CM
280 # if an address is on a header, ignore it from the rest
281 to_set = __update_header('To', to_addr)
282 cc_set = __update_header('Cc', cc_addr, to_set)
283 bcc_set = __update_header('Bcc', bcc_addr, to_set.union(cc_set))
284
285 # --auto generated addresses, don't include the sender
286 from_set = __update_header('From')
287 __update_header('Cc', extra_cc_addr, to_set.union(bcc_set).union(from_set))
288
289 # update other address headers
290 __update_header('Reply-To')
291 __update_header('Mail-Reply-To')
292 __update_header('Mail-Followup-To')
f8d1cf65
CM
293
294def __get_signers_list(msg):
295 """Return the address list generated from signed-off-by and
296 acked-by lines in the message.
297 """
298 addr_list = []
de41ecc8
DW
299 tags = '%s|%s|%s|%s|%s|%s|%s' % (
300 'signed-off-by',
301 'acked-by',
302 'cc',
303 'reviewed-by',
304 'reported-by',
305 'tested-by',
306 'reported-and-tested-by')
307 regex = '^(%s):\s+(.+)$' % tags
308
309 r = re.compile(regex, re.I)
f8d1cf65
CM
310 for line in msg.split('\n'):
311 m = r.match(line)
312 if m:
313 addr_list.append(m.expand('\g<2>'))
314
315 return addr_list
e83b3149 316
61eed152
CM
317def __build_extra_headers(msg, msg_id, ref_id = None):
318 """Build extra email headers and encoding
19a56fa1 319 """
61eed152
CM
320 del msg['Date']
321 msg['Date'] = email.Utils.formatdate(localtime = True)
322 msg['Message-ID'] = msg_id
323 if ref_id:
00375337
CM
324 # make sure the ref id has the angle brackets
325 ref_id = '<%s>' % ref_id.strip(' \t\n<>')
61eed152
CM
326 msg['In-Reply-To'] = ref_id
327 msg['References'] = ref_id
d5214f56 328 msg['User-Agent'] = 'StGit/%s' % version.version
61eed152
CM
329
330def __encode_message(msg):
331 # 7 or 8 bit encoding
332 charset = email.Charset.Charset('utf-8')
333 charset.body_encoding = None
334
335 # encode headers
336 for header, value in msg.items():
337 words = []
338 for word in value.split(' '):
339 try:
340 uword = unicode(word, 'utf-8')
341 except UnicodeDecodeError:
342 # maybe we should try a different encoding or report
343 # the error. At the moment, we just ignore it
344 pass
345 words.append(email.Header.Header(uword).encode())
346 new_val = ' '.join(words)
347 msg.replace_header(header, new_val)
348
349 # encode the body and set the MIME and encoding headers
e5c32acf
CM
350 if msg.is_multipart():
351 for p in msg.get_payload():
352 p.set_charset(charset)
353 else:
354 msg.set_charset(charset)
19a56fa1 355
58c61f10 356def __edit_message(msg):
0ba13ee9
KH
357 fname = '.stgitmail.txt'
358
359 # create the initial file
360 f = file(fname, 'w')
361 f.write(msg)
362 f.close()
363
83bb4e4c 364 call_editor(fname)
0ba13ee9
KH
365
366 # read the message back
367 f = file(fname)
368 msg = f.read()
369 f.close()
370
371 return msg
372
99c4a4c5 373def __build_cover(tmpl, patches, msg_id, options):
e3e05587 374 """Build the cover message (series description) to be sent via SMTP
b4bddc06 375 """
901288c2 376 sender = __get_sender()
dae0f0be 377
d0d139a3
CM
378 if options.version:
379 version_str = ' %s' % options.version
ed5de0cc
CM
380 else:
381 version_str = ''
d0d139a3 382
d323b5da
RR
383 if options.prefix:
384 prefix_str = options.prefix + ' '
385 else:
a7e0d4ee
YD
386 confprefix = config.get('stgit.mail.prefix')
387 if confprefix:
388 prefix_str = confprefix + ' '
389 else:
390 prefix_str = ''
d323b5da 391
99c4a4c5 392 total_nr_str = str(len(patches))
b8d258e5 393 patch_nr_str = '0'.zfill(len(total_nr_str))
99c4a4c5 394 if len(patches) > 1:
b8d258e5
CM
395 number_str = ' %s/%s' % (patch_nr_str, total_nr_str)
396 else:
397 number_str = ''
b4bddc06 398
901288c2
CM
399 tmpl_dict = {'sender': sender,
400 # for backward template compatibility
401 'maintainer': sender,
61eed152
CM
402 # for backward template compatibility
403 'endofheaders': '',
404 # for backward template compatibility
405 'date': '',
d0d139a3 406 'version': version_str,
d323b5da 407 'prefix': prefix_str,
b8d258e5
CM
408 'patchnr': patch_nr_str,
409 'totalnr': total_nr_str,
99c4a4c5 410 'number': number_str,
27827959 411 'shortlog': stack.shortlog(crt_series.get_patch(p)
c9379a15 412 for p in reversed(patches)),
ef954fe6 413 'diffstat': gitlib.diffstat(git.diff(
e4560d7e 414 rev1 = git_id(crt_series, '%s^' % patches[0]),
baf8241d
CM
415 rev2 = git_id(crt_series, '%s' % patches[-1]),
416 diff_flags = options.diff_flags))}
b4bddc06
CM
417
418 try:
61eed152 419 msg_string = tmpl % tmpl_dict
b4bddc06
CM
420 except KeyError, err:
421 raise CmdException, 'Unknown patch template variable: %s' \
422 % err
423 except TypeError:
424 raise CmdException, 'Only "%(name)s" variables are ' \
425 'supported in the patch template'
426
58c61f10
CM
427 if options.edit_cover:
428 msg_string = __edit_message(msg_string)
429
61eed152
CM
430 # The Python email message
431 try:
432 msg = email.message_from_string(msg_string)
433 except Exception, ex:
434 raise CmdException, 'template parsing error: %s' % str(ex)
435
436 __build_address_headers(msg, options)
437 __build_extra_headers(msg, msg_id, options.refid)
438 __encode_message(msg)
439
d650d6ed 440 return msg
b4bddc06 441
2bb96902 442def __build_message(tmpl, patch, patch_nr, total_nr, msg_id, ref_id, options):
b4bddc06
CM
443 """Build the message to be sent via SMTP
444 """
445 p = crt_series.get_patch(patch)
446
c897c87c
AS
447 if p.get_description():
448 descr = p.get_description().strip()
449 else:
450 # provide a place holder and force the edit message option on
451 descr = '<empty message>'
452 options.edit_patches = True
b4bddc06 453
c897c87c 454 descr_lines = descr.split('\n')
42857cbe
ST
455 short_descr = descr_lines[0].strip()
456 long_descr = '\n'.join(l.rstrip() for l in descr_lines[1:]).lstrip('\n')
b4bddc06 457
1d1485c3
CM
458 authname = p.get_authname();
459 authemail = p.get_authemail();
460 commname = p.get_commname();
461 commemail = p.get_commemail();
462
901288c2 463 sender = __get_sender()
1d1485c3
CM
464
465 fromauth = '%s <%s>' % (authname, authemail)
901288c2 466 if fromauth != sender:
1d1485c3
CM
467 fromauth = 'From: %s\n\n' % fromauth
468 else:
469 fromauth = ''
dae0f0be 470
d0d139a3
CM
471 if options.version:
472 version_str = ' %s' % options.version
ed5de0cc
CM
473 else:
474 version_str = ''
d0d139a3 475
d323b5da
RR
476 if options.prefix:
477 prefix_str = options.prefix + ' '
478 else:
a7e0d4ee
YD
479 confprefix = config.get('stgit.mail.prefix')
480 if confprefix:
481 prefix_str = confprefix + ' '
482 else:
483 prefix_str = ''
0d219030 484
b4bddc06
CM
485 total_nr_str = str(total_nr)
486 patch_nr_str = str(patch_nr).zfill(len(total_nr_str))
c2a8af1d 487 if not options.unrelated and total_nr > 1:
b8d258e5
CM
488 number_str = ' %s/%s' % (patch_nr_str, total_nr_str)
489 else:
490 number_str = ''
b4bddc06 491
e4560d7e
CM
492 diff = git.diff(rev1 = git_id(crt_series, '%s^' % patch),
493 rev2 = git_id(crt_series, '%s' % patch),
a45cea15 494 diff_flags = options.diff_flags)
b4bddc06 495 tmpl_dict = {'patch': patch,
901288c2
CM
496 'sender': sender,
497 # for backward template compatibility
498 'maintainer': sender,
b4bddc06
CM
499 'shortdescr': short_descr,
500 'longdescr': long_descr,
61eed152
CM
501 # for backward template compatibility
502 'endofheaders': '',
a45cea15 503 'diff': diff,
ef954fe6 504 'diffstat': gitlib.diffstat(diff),
61eed152
CM
505 # for backward template compatibility
506 'date': '',
d0d139a3 507 'version': version_str,
d323b5da 508 'prefix': prefix_str,
b4bddc06
CM
509 'patchnr': patch_nr_str,
510 'totalnr': total_nr_str,
b8d258e5 511 'number': number_str,
1d1485c3
CM
512 'fromauth': fromauth,
513 'authname': authname,
514 'authemail': authemail,
b4bddc06 515 'authdate': p.get_authdate(),
1d1485c3
CM
516 'commname': commname,
517 'commemail': commemail}
61eed152 518 # change None to ''
b4bddc06
CM
519 for key in tmpl_dict:
520 if not tmpl_dict[key]:
521 tmpl_dict[key] = ''
522
523 try:
61eed152 524 msg_string = tmpl % tmpl_dict
b4bddc06
CM
525 except KeyError, err:
526 raise CmdException, 'Unknown patch template variable: %s' \
527 % err
528 except TypeError:
529 raise CmdException, 'Only "%(name)s" variables are ' \
530 'supported in the patch template'
531
58c61f10
CM
532 if options.edit_patches:
533 msg_string = __edit_message(msg_string)
534
61eed152
CM
535 # The Python email message
536 try:
537 msg = email.message_from_string(msg_string)
538 except Exception, ex:
539 raise CmdException, 'template parsing error: %s' % str(ex)
540
541 if options.auto:
542 extra_cc = __get_signers_list(descr)
543 else:
544 extra_cc = []
545
546 __build_address_headers(msg, options, extra_cc)
547 __build_extra_headers(msg, msg_id, ref_id)
548 __encode_message(msg)
549
d650d6ed 550 return msg
b4bddc06 551
b4bddc06
CM
552def func(parser, options, args):
553 """Send the patches by e-mail using the patchmail.tmpl file as
554 a template
555 """
b4bddc06 556 applied = crt_series.get_applied()
b4bddc06 557
6b1e0111
CM
558 if options.all:
559 patches = applied
560 elif len(args) >= 1:
b4f656f0
CM
561 unapplied = crt_series.get_unapplied()
562 patches = parse_patches(args, applied + unapplied, len(applied))
b4bddc06 563 else:
9a316368 564 raise CmdException, 'Incorrect options. Unknown patches to send'
b4bddc06 565
ea09f8ce
GH
566 # early test for sender identity
567 __get_sender()
568
3c04f430
CM
569 out.start('Checking the validity of the patches')
570 for p in patches:
571 if crt_series.empty_patch(p):
572 raise CmdException, 'Cannot send empty patch "%s"' % p
573 out.done()
574
b4bddc06 575 total_nr = len(patches)
9a316368
CM
576 if total_nr == 0:
577 raise CmdException, 'No patches to send'
b4bddc06 578
c2a8af1d
CM
579 if options.refid:
580 if options.noreply or options.unrelated:
581 raise CmdException, \
582 '--refid option not allowed with --noreply or --unrelated'
d1ed3a12 583 ref_id = options.refid
c2a8af1d
CM
584 else:
585 ref_id = None
b4bddc06 586
c73e63b7 587 sleep = options.sleep or config.getint('stgit.smtpdelay')
b4bddc06 588
e3e05587 589 # send the cover message (if any)
0ba13ee9 590 if options.cover or options.edit_cover:
c2a8af1d
CM
591 if options.unrelated:
592 raise CmdException, 'cover sending not allowed with --unrelated'
593
e3e05587
CM
594 # find the template file
595 if options.cover:
16fee874 596 tmpl = file(options.cover).read()
e3e05587 597 else:
1f3bb017
CM
598 tmpl = templates.get_template('covermail.tmpl')
599 if not tmpl:
600 raise CmdException, 'No cover message template file found'
b4bddc06
CM
601
602 msg_id = email.Utils.make_msgid('stgit')
99c4a4c5 603 msg = __build_cover(tmpl, patches, msg_id, options)
2bb96902 604 from_addr, to_addr_list = __parse_addresses(msg)
b4bddc06 605
d650d6ed
CM
606 msg_string = msg.as_string(options.mbox)
607
b4bddc06 608 # subsequent e-mails are seen as replies to the first one
d1ed3a12
CM
609 if not options.noreply:
610 ref_id = msg_id
b4bddc06 611
29f00589 612 if options.mbox:
27ac2b7e 613 out.stdout_raw(msg_string + '\n')
29f00589 614 else:
27ac2b7e 615 out.start('Sending the cover message')
89d7ec43 616 __send_message(from_addr, to_addr_list, msg_string, options)
4a545fa1 617 time.sleep(sleep)
27ac2b7e 618 out.done()
b4bddc06
CM
619
620 # send the patches
621 if options.template:
1f3bb017 622 tmpl = file(options.template).read()
b4bddc06 623 else:
e5c32acf
CM
624 if options.attach:
625 tmpl = templates.get_template('mailattch.tmpl')
626 else:
627 tmpl = templates.get_template('patchmail.tmpl')
1f3bb017
CM
628 if not tmpl:
629 raise CmdException, 'No e-mail template file found'
b4bddc06 630
4a545fa1 631 for (p, patch_nr) in zip(patches, range(1, total_nr + 1)):
b4bddc06 632 msg_id = email.Utils.make_msgid('stgit')
2bb96902
CM
633 msg = __build_message(tmpl, p, patch_nr, total_nr, msg_id, ref_id,
634 options)
635 from_addr, to_addr_list = __parse_addresses(msg)
636
d650d6ed
CM
637 msg_string = msg.as_string(options.mbox)
638
b4bddc06 639 # subsequent e-mails are seen as replies to the first one
c2a8af1d 640 if not options.noreply and not options.unrelated and not ref_id:
b4bddc06
CM
641 ref_id = msg_id
642
29f00589 643 if options.mbox:
27ac2b7e 644 out.stdout_raw(msg_string + '\n')
29f00589 645 else:
27ac2b7e 646 out.start('Sending patch "%s"' % p)
89d7ec43 647 __send_message(from_addr, to_addr_list, msg_string, options)
4a545fa1
CM
648 # give recipients a chance of receiving related patches in the
649 # correct order.
650 if patch_nr < total_nr:
651 time.sleep(sleep)
27ac2b7e 652 out.done()