Commit | Line | Data |
---|---|---|
b4bddc06 CM |
1 | __copyright__ = """ |
2 | Copyright (C) 2005, Catalin Marinas <catalin.marinas@gmail.com> | |
3 | ||
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. | |
7 | ||
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. | |
12 | ||
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 | |
16 | """ | |
17 | ||
6cf5ec9b | 18 | import sys, os, re, time, datetime, socket, smtplib, getpass |
61eed152 | 19 | import email, email.Utils, email.Header |
b4bddc06 | 20 | from optparse import OptionParser, make_option |
b4bddc06 CM |
21 | |
22 | from stgit.commands.common import * | |
23 | from stgit.utils import * | |
5e888f30 | 24 | from stgit.out import * |
1f3bb017 | 25 | from stgit import stack, git, version, templates |
b4bddc06 CM |
26 | from stgit.config import config |
27 | ||
28 | ||
29 | help = 'send a patch or series of patches by e-mail' | |
77eeb7f4 | 30 | usage = r"""%prog [options] [<patch1>] [<patch2>] [<patch3>..<patch4>] |
26aab5b0 | 31 | |
cec913c4 KH |
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 | |
79df2f0d | 37 | '~/.stgit/templates/patchmail.tmpl' or |
e5c32acf CM |
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'. | |
79df2f0d CM |
41 | |
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. | |
2bb96902 | 46 | |
0ba13ee9 KH |
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 | |
94d18868 YD |
51 | '~/.stgit/templates/covermail.tmpl' or |
52 | '/usr/share/stgit/templates/covermail.tmpl'). | |
e3e05587 CM |
53 | |
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. | |
26aab5b0 CM |
57 | |
58 | SMTP authentication is also possible with '--smtp-user' and | |
59 | '--smtp-password' options, also available as configuration settings: | |
fc44c2ca PR |
60 | 'smtpuser' and 'smtppassword'. TLS encryption can be enabled by |
61 | '--smtp-tls' option and 'smtptls' setting. | |
26aab5b0 | 62 | |
27827959 KH |
63 | The following variables are accepted by both the preamble and the |
64 | patch e-mail templates: | |
26aab5b0 | 65 | |
26aab5b0 | 66 | %(diffstat)s - diff statistics |
27827959 | 67 | %(number)s - empty if only one patch is sent or ' patchnr/totalnr' |
26aab5b0 | 68 | %(patchnr)s - patch number |
27827959 | 69 | %(sender)s - 'sender' or 'authname <authemail>' as per the config file |
26aab5b0 | 70 | %(totalnr)s - total number of patches to be sent |
27827959 KH |
71 | %(version)s - ' version' string passed on the command line (or empty) |
72 | ||
73 | In addition to the common variables, the preamble e-mail template | |
74 | accepts the following: | |
75 | ||
76 | %(shortlog)s - first line of each patch description, listed by author | |
77 | ||
78 | In addition to the common variables, the patch e-mail template accepts | |
79 | the following: | |
80 | ||
26aab5b0 | 81 | %(authdate)s - patch creation date |
27827959 KH |
82 | %(authemail)s - author's email |
83 | %(authname)s - author's name | |
26aab5b0 | 84 | %(commemail)s - committer's e-mail |
27827959 KH |
85 | %(commname)s - committer's name |
86 | %(diff)s - unified diff of the patch | |
77eeb7f4 | 87 | %(fromauth)s - 'From: author\n\n' if different from sender |
27827959 KH |
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""" | |
b4bddc06 | 92 | |
6dd8fafa | 93 | directory = DirectoryHasRepository() |
9a316368 CM |
94 | options = [make_option('-a', '--all', |
95 | help = 'e-mail all the applied patches', | |
96 | action = 'store_true'), | |
2bb96902 | 97 | make_option('--to', |
e83b3149 PO |
98 | help = 'add TO to the To: list', |
99 | action = 'append'), | |
2bb96902 | 100 | make_option('--cc', |
e83b3149 PO |
101 | help = 'add CC to the Cc: list', |
102 | action = 'append'), | |
2bb96902 | 103 | make_option('--bcc', |
e83b3149 PO |
104 | help = 'add BCC to the Bcc: list', |
105 | action = 'append'), | |
f8d1cf65 CM |
106 | make_option('--auto', |
107 | help = 'automatically cc the patch signers', | |
108 | action = 'store_true'), | |
d1ed3a12 CM |
109 | make_option('--noreply', |
110 | help = 'do not send subsequent messages as replies', | |
111 | action = 'store_true'), | |
c2a8af1d CM |
112 | make_option('--unrelated', |
113 | help = 'send patches without sequence numbering', | |
114 | action = 'store_true'), | |
e5c32acf CM |
115 | make_option('--attach', |
116 | help = 'send a patch as attachment', | |
117 | action = 'store_true'), | |
d0d139a3 CM |
118 | make_option('-v', '--version', metavar = 'VERSION', |
119 | help = 'add VERSION to the [PATCH ...] prefix'), | |
d323b5da RR |
120 | make_option('--prefix', metavar = 'PREFIX', |
121 | help = 'add PREFIX to the [... PATCH ...] prefix'), | |
9a316368 CM |
122 | make_option('-t', '--template', metavar = 'FILE', |
123 | help = 'use FILE as the message template'), | |
e3e05587 CM |
124 | make_option('-c', '--cover', metavar = 'FILE', |
125 | help = 'send FILE as the cover message'), | |
0ba13ee9 | 126 | make_option('-e', '--edit-cover', |
e3e05587 CM |
127 | help = 'edit the cover message before sending', |
128 | action = 'store_true'), | |
0ba13ee9 KH |
129 | make_option('-E', '--edit-patches', |
130 | help = 'edit each patch before sending', | |
131 | action = 'store_true'), | |
b4bddc06 CM |
132 | make_option('-s', '--sleep', type = 'int', metavar = 'SECONDS', |
133 | help = 'sleep for SECONDS between e-mails sending'), | |
134 | make_option('--refid', | |
d0d139a3 | 135 | help = 'use REFID as the reference id'), |
cec913c4 KH |
136 | make_option('--smtp-server', metavar = 'HOST[:PORT]', |
137 | help = 'SMTP server to use for sending mail'), | |
eb026d93 B |
138 | make_option('-u', '--smtp-user', metavar = 'USER', |
139 | help = 'username for SMTP authentication'), | |
140 | make_option('-p', '--smtp-password', metavar = 'PASSWORD', | |
2f7c8b0b | 141 | help = 'username for SMTP authentication'), |
fc44c2ca PR |
142 | make_option('-T', '--smtp-tls', |
143 | help = 'use SMTP with TLS encryption', | |
144 | action = 'store_true'), | |
2f7c8b0b | 145 | make_option('-b', '--branch', |
29f00589 CM |
146 | help = 'use BRANCH instead of the default one'), |
147 | make_option('-m', '--mbox', | |
148 | help = 'generate an mbox file instead of sending', | |
0b635fe6 KH |
149 | action = 'store_true') |
150 | ] + make_diff_opts_option() | |
b4bddc06 CM |
151 | |
152 | ||
901288c2 | 153 | def __get_sender(): |
dae0f0be CM |
154 | """Return the 'authname <authemail>' string as read from the |
155 | configuration file | |
156 | """ | |
c73e63b7 YD |
157 | sender=config.get('stgit.sender') |
158 | if not sender: | |
9e3f506f KH |
159 | try: |
160 | sender = str(git.user()) | |
161 | except git.GitException: | |
162 | sender = str(git.author()) | |
163 | ||
164 | if not sender: | |
901288c2 | 165 | raise CmdException, 'unknown sender details' |
dae0f0be | 166 | |
79df2f0d | 167 | return address_or_alias(sender) |
9e3f506f | 168 | |
d650d6ed | 169 | def __parse_addresses(msg): |
b4bddc06 CM |
170 | """Return a two elements tuple: (from, [to]) |
171 | """ | |
d650d6ed CM |
172 | def __addr_list(msg, header): |
173 | return [name_addr[1] for name_addr in | |
174 | email.Utils.getaddresses(msg.get_all(header, []))] | |
b4bddc06 | 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 | ||
185 | return (from_addr_list[0], to_addr_list) | |
186 | ||
eb026d93 | 187 | def __send_message(smtpserver, from_addr, to_addr_list, msg, sleep, |
fc44c2ca | 188 | smtpuser, smtppassword, use_tls): |
b4bddc06 CM |
189 | """Send the message using the given SMTP server |
190 | """ | |
191 | try: | |
192 | s = smtplib.SMTP(smtpserver) | |
193 | except Exception, err: | |
194 | raise CmdException, str(err) | |
195 | ||
196 | s.set_debuglevel(0) | |
197 | try: | |
eb026d93 B |
198 | if smtpuser and smtppassword: |
199 | s.ehlo() | |
fc44c2ca PR |
200 | if use_tls: |
201 | if not hasattr(socket, 'ssl'): | |
202 | raise CmdException, "cannot use TLS - no SSL support in Python" | |
203 | s.starttls() | |
204 | s.ehlo() | |
eb026d93 B |
205 | s.login(smtpuser, smtppassword) |
206 | ||
0bc1343c YD |
207 | result = s.sendmail(from_addr, to_addr_list, msg) |
208 | if len(result): | |
209 | print "mail server refused delivery for the following recipients: %s" % result | |
b4bddc06 CM |
210 | # give recipients a chance of receiving patches in the correct order |
211 | time.sleep(sleep) | |
212 | except Exception, err: | |
213 | raise CmdException, str(err) | |
214 | ||
215 | s.quit() | |
216 | ||
61eed152 | 217 | def __build_address_headers(msg, options, extra_cc = []): |
f8d1cf65 CM |
218 | """Build the address headers and check existing headers in the |
219 | template. | |
220 | """ | |
61eed152 CM |
221 | def __replace_header(header, addr): |
222 | if addr: | |
223 | crt_addr = msg[header] | |
224 | del msg[header] | |
f8d1cf65 | 225 | |
61eed152 | 226 | if crt_addr: |
79df2f0d | 227 | msg[header] = address_or_alias(', '.join([crt_addr, addr])) |
61eed152 | 228 | else: |
79df2f0d | 229 | msg[header] = address_or_alias(addr) |
f8d1cf65 | 230 | |
f8d1cf65 CM |
231 | to_addr = '' |
232 | cc_addr = '' | |
233 | bcc_addr = '' | |
234 | ||
c73e63b7 | 235 | autobcc = config.get('stgit.autobcc') or '' |
d884c4d8 | 236 | |
e83b3149 | 237 | if options.to: |
61eed152 | 238 | to_addr = ', '.join(options.to) |
e83b3149 | 239 | if options.cc: |
61eed152 | 240 | cc_addr = ', '.join(options.cc + extra_cc) |
e5c32acf | 241 | cc_addr = ', '.join(options.cc + extra_cc) |
f8d1cf65 | 242 | elif extra_cc: |
61eed152 | 243 | cc_addr = ', '.join(extra_cc) |
e83b3149 | 244 | if options.bcc: |
61eed152 | 245 | bcc_addr = ', '.join(options.bcc + [autobcc]) |
d884c4d8 CM |
246 | elif autobcc: |
247 | bcc_addr = autobcc | |
f8d1cf65 | 248 | |
61eed152 CM |
249 | __replace_header('To', to_addr) |
250 | __replace_header('Cc', cc_addr) | |
251 | __replace_header('Bcc', bcc_addr) | |
f8d1cf65 CM |
252 | |
253 | def __get_signers_list(msg): | |
254 | """Return the address list generated from signed-off-by and | |
255 | acked-by lines in the message. | |
256 | """ | |
257 | addr_list = [] | |
258 | ||
769cd397 | 259 | r = re.compile('^(signed-off-by|acked-by|cc):\s+(.+)$', re.I) |
f8d1cf65 CM |
260 | for line in msg.split('\n'): |
261 | m = r.match(line) | |
262 | if m: | |
263 | addr_list.append(m.expand('\g<2>')) | |
264 | ||
265 | return addr_list | |
e83b3149 | 266 | |
61eed152 CM |
267 | def __build_extra_headers(msg, msg_id, ref_id = None): |
268 | """Build extra email headers and encoding | |
19a56fa1 | 269 | """ |
61eed152 CM |
270 | del msg['Date'] |
271 | msg['Date'] = email.Utils.formatdate(localtime = True) | |
272 | msg['Message-ID'] = msg_id | |
273 | if ref_id: | |
00375337 CM |
274 | # make sure the ref id has the angle brackets |
275 | ref_id = '<%s>' % ref_id.strip(' \t\n<>') | |
61eed152 CM |
276 | msg['In-Reply-To'] = ref_id |
277 | msg['References'] = ref_id | |
278 | msg['User-Agent'] = 'StGIT/%s' % version.version | |
279 | ||
280 | def __encode_message(msg): | |
281 | # 7 or 8 bit encoding | |
282 | charset = email.Charset.Charset('utf-8') | |
283 | charset.body_encoding = None | |
284 | ||
285 | # encode headers | |
286 | for header, value in msg.items(): | |
287 | words = [] | |
288 | for word in value.split(' '): | |
289 | try: | |
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 | |
294 | pass | |
295 | words.append(email.Header.Header(uword).encode()) | |
296 | new_val = ' '.join(words) | |
297 | msg.replace_header(header, new_val) | |
298 | ||
299 | # encode the body and set the MIME and encoding headers | |
e5c32acf CM |
300 | if msg.is_multipart(): |
301 | for p in msg.get_payload(): | |
302 | p.set_charset(charset) | |
303 | else: | |
304 | msg.set_charset(charset) | |
19a56fa1 | 305 | |
58c61f10 | 306 | def __edit_message(msg): |
0ba13ee9 KH |
307 | fname = '.stgitmail.txt' |
308 | ||
309 | # create the initial file | |
310 | f = file(fname, 'w') | |
311 | f.write(msg) | |
312 | f.close() | |
313 | ||
83bb4e4c | 314 | call_editor(fname) |
0ba13ee9 KH |
315 | |
316 | # read the message back | |
317 | f = file(fname) | |
318 | msg = f.read() | |
319 | f.close() | |
320 | ||
321 | return msg | |
322 | ||
99c4a4c5 | 323 | def __build_cover(tmpl, patches, msg_id, options): |
e3e05587 | 324 | """Build the cover message (series description) to be sent via SMTP |
b4bddc06 | 325 | """ |
901288c2 | 326 | sender = __get_sender() |
dae0f0be | 327 | |
d0d139a3 CM |
328 | if options.version: |
329 | version_str = ' %s' % options.version | |
ed5de0cc CM |
330 | else: |
331 | version_str = '' | |
d0d139a3 | 332 | |
d323b5da RR |
333 | if options.prefix: |
334 | prefix_str = options.prefix + ' ' | |
335 | else: | |
a7e0d4ee YD |
336 | confprefix = config.get('stgit.mail.prefix') |
337 | if confprefix: | |
338 | prefix_str = confprefix + ' ' | |
339 | else: | |
340 | prefix_str = '' | |
d323b5da | 341 | |
99c4a4c5 | 342 | total_nr_str = str(len(patches)) |
b8d258e5 | 343 | patch_nr_str = '0'.zfill(len(total_nr_str)) |
99c4a4c5 | 344 | if len(patches) > 1: |
b8d258e5 CM |
345 | number_str = ' %s/%s' % (patch_nr_str, total_nr_str) |
346 | else: | |
347 | number_str = '' | |
b4bddc06 | 348 | |
901288c2 CM |
349 | tmpl_dict = {'sender': sender, |
350 | # for backward template compatibility | |
351 | 'maintainer': sender, | |
61eed152 CM |
352 | # for backward template compatibility |
353 | 'endofheaders': '', | |
354 | # for backward template compatibility | |
355 | 'date': '', | |
d0d139a3 | 356 | 'version': version_str, |
d323b5da | 357 | 'prefix': prefix_str, |
b8d258e5 CM |
358 | 'patchnr': patch_nr_str, |
359 | 'totalnr': total_nr_str, | |
99c4a4c5 | 360 | 'number': number_str, |
27827959 KH |
361 | 'shortlog': stack.shortlog(crt_series.get_patch(p) |
362 | for p in patches), | |
a45cea15 | 363 | 'diffstat': git.diffstat(git.diff( |
6972fd6b | 364 | rev1 = git_id(crt_series, '%s//bottom' % patches[0]), |
a45cea15 | 365 | rev2 = git_id(crt_series, '%s//top' % patches[-1])))} |
b4bddc06 CM |
366 | |
367 | try: | |
61eed152 | 368 | msg_string = tmpl % tmpl_dict |
b4bddc06 CM |
369 | except KeyError, err: |
370 | raise CmdException, 'Unknown patch template variable: %s' \ | |
371 | % err | |
372 | except TypeError: | |
373 | raise CmdException, 'Only "%(name)s" variables are ' \ | |
374 | 'supported in the patch template' | |
375 | ||
58c61f10 CM |
376 | if options.edit_cover: |
377 | msg_string = __edit_message(msg_string) | |
378 | ||
61eed152 CM |
379 | # The Python email message |
380 | try: | |
381 | msg = email.message_from_string(msg_string) | |
382 | except Exception, ex: | |
383 | raise CmdException, 'template parsing error: %s' % str(ex) | |
384 | ||
385 | __build_address_headers(msg, options) | |
386 | __build_extra_headers(msg, msg_id, options.refid) | |
387 | __encode_message(msg) | |
388 | ||
d650d6ed | 389 | return msg |
b4bddc06 | 390 | |
2bb96902 | 391 | def __build_message(tmpl, patch, patch_nr, total_nr, msg_id, ref_id, options): |
b4bddc06 CM |
392 | """Build the message to be sent via SMTP |
393 | """ | |
394 | p = crt_series.get_patch(patch) | |
395 | ||
c897c87c AS |
396 | if p.get_description(): |
397 | descr = p.get_description().strip() | |
398 | else: | |
399 | # provide a place holder and force the edit message option on | |
400 | descr = '<empty message>' | |
401 | options.edit_patches = True | |
b4bddc06 | 402 | |
c897c87c | 403 | descr_lines = descr.split('\n') |
42857cbe ST |
404 | short_descr = descr_lines[0].strip() |
405 | long_descr = '\n'.join(l.rstrip() for l in descr_lines[1:]).lstrip('\n') | |
b4bddc06 | 406 | |
1d1485c3 CM |
407 | authname = p.get_authname(); |
408 | authemail = p.get_authemail(); | |
409 | commname = p.get_commname(); | |
410 | commemail = p.get_commemail(); | |
411 | ||
901288c2 | 412 | sender = __get_sender() |
1d1485c3 CM |
413 | |
414 | fromauth = '%s <%s>' % (authname, authemail) | |
901288c2 | 415 | if fromauth != sender: |
1d1485c3 CM |
416 | fromauth = 'From: %s\n\n' % fromauth |
417 | else: | |
418 | fromauth = '' | |
dae0f0be | 419 | |
d0d139a3 CM |
420 | if options.version: |
421 | version_str = ' %s' % options.version | |
ed5de0cc CM |
422 | else: |
423 | version_str = '' | |
d0d139a3 | 424 | |
d323b5da RR |
425 | if options.prefix: |
426 | prefix_str = options.prefix + ' ' | |
427 | else: | |
a7e0d4ee YD |
428 | confprefix = config.get('stgit.mail.prefix') |
429 | if confprefix: | |
430 | prefix_str = confprefix + ' ' | |
431 | else: | |
432 | prefix_str = '' | |
0d219030 | 433 | |
b4bddc06 CM |
434 | total_nr_str = str(total_nr) |
435 | patch_nr_str = str(patch_nr).zfill(len(total_nr_str)) | |
c2a8af1d | 436 | if not options.unrelated and total_nr > 1: |
b8d258e5 CM |
437 | number_str = ' %s/%s' % (patch_nr_str, total_nr_str) |
438 | else: | |
439 | number_str = '' | |
b4bddc06 | 440 | |
a45cea15 KH |
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) | |
b4bddc06 | 444 | tmpl_dict = {'patch': patch, |
901288c2 CM |
445 | 'sender': sender, |
446 | # for backward template compatibility | |
447 | 'maintainer': sender, | |
b4bddc06 CM |
448 | 'shortdescr': short_descr, |
449 | 'longdescr': long_descr, | |
61eed152 CM |
450 | # for backward template compatibility |
451 | 'endofheaders': '', | |
a45cea15 KH |
452 | 'diff': diff, |
453 | 'diffstat': git.diffstat(diff), | |
61eed152 CM |
454 | # for backward template compatibility |
455 | 'date': '', | |
d0d139a3 | 456 | 'version': version_str, |
d323b5da | 457 | 'prefix': prefix_str, |
b4bddc06 CM |
458 | 'patchnr': patch_nr_str, |
459 | 'totalnr': total_nr_str, | |
b8d258e5 | 460 | 'number': number_str, |
1d1485c3 CM |
461 | 'fromauth': fromauth, |
462 | 'authname': authname, | |
463 | 'authemail': authemail, | |
b4bddc06 | 464 | 'authdate': p.get_authdate(), |
1d1485c3 CM |
465 | 'commname': commname, |
466 | 'commemail': commemail} | |
61eed152 | 467 | # change None to '' |
b4bddc06 CM |
468 | for key in tmpl_dict: |
469 | if not tmpl_dict[key]: | |
470 | tmpl_dict[key] = '' | |
471 | ||
472 | try: | |
61eed152 | 473 | msg_string = tmpl % tmpl_dict |
b4bddc06 CM |
474 | except KeyError, err: |
475 | raise CmdException, 'Unknown patch template variable: %s' \ | |
476 | % err | |
477 | except TypeError: | |
478 | raise CmdException, 'Only "%(name)s" variables are ' \ | |
479 | 'supported in the patch template' | |
480 | ||
58c61f10 CM |
481 | if options.edit_patches: |
482 | msg_string = __edit_message(msg_string) | |
483 | ||
61eed152 CM |
484 | # The Python email message |
485 | try: | |
486 | msg = email.message_from_string(msg_string) | |
487 | except Exception, ex: | |
488 | raise CmdException, 'template parsing error: %s' % str(ex) | |
489 | ||
490 | if options.auto: | |
491 | extra_cc = __get_signers_list(descr) | |
492 | else: | |
493 | extra_cc = [] | |
494 | ||
495 | __build_address_headers(msg, options, extra_cc) | |
496 | __build_extra_headers(msg, msg_id, ref_id) | |
497 | __encode_message(msg) | |
498 | ||
d650d6ed | 499 | return msg |
b4bddc06 | 500 | |
b4bddc06 CM |
501 | def func(parser, options, args): |
502 | """Send the patches by e-mail using the patchmail.tmpl file as | |
503 | a template | |
504 | """ | |
cec913c4 | 505 | smtpserver = options.smtp_server or config.get('stgit.smtpserver') |
eb026d93 | 506 | |
b4bddc06 | 507 | applied = crt_series.get_applied() |
b4bddc06 | 508 | |
6b1e0111 CM |
509 | if options.all: |
510 | patches = applied | |
511 | elif len(args) >= 1: | |
b4f656f0 CM |
512 | unapplied = crt_series.get_unapplied() |
513 | patches = parse_patches(args, applied + unapplied, len(applied)) | |
b4bddc06 | 514 | else: |
9a316368 | 515 | raise CmdException, 'Incorrect options. Unknown patches to send' |
b4bddc06 | 516 | |
3c04f430 CM |
517 | out.start('Checking the validity of the patches') |
518 | for p in patches: | |
519 | if crt_series.empty_patch(p): | |
520 | raise CmdException, 'Cannot send empty patch "%s"' % p | |
521 | out.done() | |
522 | ||
c73e63b7 YD |
523 | smtppassword = options.smtp_password or config.get('stgit.smtppassword') |
524 | smtpuser = options.smtp_user or config.get('stgit.smtpuser') | |
fc44c2ca | 525 | smtpusetls = options.smtp_tls or config.get('stgit.smtptls') == 'yes' |
eb026d93 B |
526 | |
527 | if (smtppassword and not smtpuser): | |
528 | raise CmdException, 'SMTP password supplied, username needed' | |
fc44c2ca PR |
529 | if (smtpusetls and not smtpuser): |
530 | raise CmdException, 'SMTP over TLS requested, username needed' | |
6cf5ec9b PR |
531 | if (smtpuser and not smtppassword): |
532 | smtppassword = getpass.getpass("Please enter SMTP password: ") | |
eb026d93 | 533 | |
b4bddc06 | 534 | total_nr = len(patches) |
9a316368 CM |
535 | if total_nr == 0: |
536 | raise CmdException, 'No patches to send' | |
b4bddc06 | 537 | |
c2a8af1d CM |
538 | if options.refid: |
539 | if options.noreply or options.unrelated: | |
540 | raise CmdException, \ | |
541 | '--refid option not allowed with --noreply or --unrelated' | |
d1ed3a12 | 542 | ref_id = options.refid |
c2a8af1d CM |
543 | else: |
544 | ref_id = None | |
b4bddc06 | 545 | |
c73e63b7 | 546 | sleep = options.sleep or config.getint('stgit.smtpdelay') |
b4bddc06 | 547 | |
e3e05587 | 548 | # send the cover message (if any) |
0ba13ee9 | 549 | if options.cover or options.edit_cover: |
c2a8af1d CM |
550 | if options.unrelated: |
551 | raise CmdException, 'cover sending not allowed with --unrelated' | |
552 | ||
e3e05587 CM |
553 | # find the template file |
554 | if options.cover: | |
16fee874 | 555 | tmpl = file(options.cover).read() |
e3e05587 | 556 | else: |
1f3bb017 CM |
557 | tmpl = templates.get_template('covermail.tmpl') |
558 | if not tmpl: | |
559 | raise CmdException, 'No cover message template file found' | |
b4bddc06 CM |
560 | |
561 | msg_id = email.Utils.make_msgid('stgit') | |
99c4a4c5 | 562 | msg = __build_cover(tmpl, patches, msg_id, options) |
2bb96902 | 563 | from_addr, to_addr_list = __parse_addresses(msg) |
b4bddc06 | 564 | |
d650d6ed CM |
565 | msg_string = msg.as_string(options.mbox) |
566 | ||
b4bddc06 | 567 | # subsequent e-mails are seen as replies to the first one |
d1ed3a12 CM |
568 | if not options.noreply: |
569 | ref_id = msg_id | |
b4bddc06 | 570 | |
29f00589 | 571 | if options.mbox: |
27ac2b7e | 572 | out.stdout_raw(msg_string + '\n') |
29f00589 | 573 | else: |
27ac2b7e | 574 | out.start('Sending the cover message') |
d650d6ed | 575 | __send_message(smtpserver, from_addr, to_addr_list, msg_string, |
fc44c2ca | 576 | sleep, smtpuser, smtppassword, smtpusetls) |
27ac2b7e | 577 | out.done() |
b4bddc06 CM |
578 | |
579 | # send the patches | |
580 | if options.template: | |
1f3bb017 | 581 | tmpl = file(options.template).read() |
b4bddc06 | 582 | else: |
e5c32acf CM |
583 | if options.attach: |
584 | tmpl = templates.get_template('mailattch.tmpl') | |
585 | else: | |
586 | tmpl = templates.get_template('patchmail.tmpl') | |
1f3bb017 CM |
587 | if not tmpl: |
588 | raise CmdException, 'No e-mail template file found' | |
b4bddc06 CM |
589 | |
590 | for (p, patch_nr) in zip(patches, range(1, len(patches) + 1)): | |
591 | msg_id = email.Utils.make_msgid('stgit') | |
2bb96902 CM |
592 | msg = __build_message(tmpl, p, patch_nr, total_nr, msg_id, ref_id, |
593 | options) | |
594 | from_addr, to_addr_list = __parse_addresses(msg) | |
595 | ||
d650d6ed CM |
596 | msg_string = msg.as_string(options.mbox) |
597 | ||
b4bddc06 | 598 | # subsequent e-mails are seen as replies to the first one |
c2a8af1d | 599 | if not options.noreply and not options.unrelated and not ref_id: |
b4bddc06 CM |
600 | ref_id = msg_id |
601 | ||
29f00589 | 602 | if options.mbox: |
27ac2b7e | 603 | out.stdout_raw(msg_string + '\n') |
29f00589 | 604 | else: |
27ac2b7e | 605 | out.start('Sending patch "%s"' % p) |
d650d6ed | 606 | __send_message(smtpserver, from_addr, to_addr_list, msg_string, |
fc44c2ca | 607 | sleep, smtpuser, smtppassword, smtpusetls) |
27ac2b7e | 608 | out.done() |