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
, smtplib
, email
.Utils
19 from optparse
import OptionParser
, make_option
20 from time
import gmtime
, strftime
22 from stgit
.commands
.common
import *
23 from stgit
.utils
import *
24 from stgit
import stack
, git
25 from stgit
.config
import config
28 help = 'send a patch or series of patches by e-mail'
29 usage
= """%prog [options] [<patch> [<patch2...]]
31 Send a patch or a range of patches (defaulting to the applied patches)
32 by e-mail using the 'smtpserver' configuration option. The From
33 address and the e-mail format are generated from the template file
34 passed as argument to '--template' (defaulting to .git/patchmail.tmpl
35 or /usr/share/stgit/templates/patchmail.tmpl). The To/Cc/Bcc addresses
36 can either be added to the template file or passed via the
37 corresponding command line options.
39 A preamble e-mail can be sent using the '--cover' and/or '--edit'
40 options. The first allows the user to specify a file to be used as a
41 template. The latter option will invoke the editor on the specified
42 file (defaulting to .git/covermail.tmpl or
43 /usr/share/stgit/templates/covermail.tmpl).
45 All the subsequent e-mails appear as replies to the first e-mail sent
46 (either the preamble or the first patch). E-mails can be seen as
47 replies to a different e-mail by using the '--refid' option.
49 SMTP authentication is also possible with '--smtp-user' and
50 '--smtp-password' options, also available as configuration settings:
51 'smtpuser' and 'smtppassword'.
53 The template e-mail headers and body must be separated by
54 '%(endofheaders)s' variable, which is replaced by StGIT with
55 additional headers and a blank line. The patch e-mail template accepts
56 the following variables:
58 %(patch)s - patch name
59 %(maintainer)s - 'authname <authemail>' as read from the config file
60 %(shortdescr)s - the first line of the patch description
61 %(longdescr)s - the rest of the patch description, after the first line
62 %(endofheaders)s - delimiter between e-mail headers and body
63 %(diff)s - unified diff of the patch
64 %(diffstat)s - diff statistics
65 %(date)s - current date/time
66 %(version)s - ' version' string passed on the command line (or empty)
67 %(patchnr)s - patch number
68 %(totalnr)s - total number of patches to be sent
69 %(number)s - empty if only one patch is sent or ' patchnr/totalnr'
70 %(authname)s - author's name
71 %(authemail)s - author's email
72 %(authdate)s - patch creation date
73 %(commname)s - committer's name
74 %(commemail)s - committer's e-mail
76 For the preamble e-mail template, only the %(maintainer)s, %(date)s,
77 %(endofheaders)s, %(version)s, %(patchnr)s, %(totalnr)s and %(number)s
78 variables are supported."""
80 options
= [make_option('-a', '--all',
81 help = 'e-mail all the applied patches',
82 action
= 'store_true'),
83 make_option('-r', '--range',
84 metavar
= '[PATCH1][:[PATCH2]]',
85 help = 'e-mail patches between PATCH1 and PATCH2'),
87 help = 'add TO to the To: list',
90 help = 'add CC to the Cc: list',
93 help = 'add BCC to the Bcc: list',
95 make_option('-v', '--version', metavar
= 'VERSION',
96 help = 'add VERSION to the [PATCH ...] prefix'),
97 make_option('-t', '--template', metavar
= 'FILE',
98 help = 'use FILE as the message template'),
99 make_option('-c', '--cover', metavar
= 'FILE',
100 help = 'send FILE as the cover message'),
101 make_option('-e', '--edit',
102 help = 'edit the cover message before sending',
103 action
= 'store_true'),
104 make_option('-s', '--sleep', type = 'int', metavar
= 'SECONDS',
105 help = 'sleep for SECONDS between e-mails sending'),
106 make_option('--refid',
107 help = 'use REFID as the reference id'),
108 make_option('-u', '--smtp-user', metavar
= 'USER',
109 help = 'username for SMTP authentication'),
110 make_option('-p', '--smtp-password', metavar
= 'PASSWORD',
111 help = 'username for SMTP authentication'),
112 make_option('-b', '--branch',
113 help = 'use BRANCH instead of the default one')]
116 def __get_maintainer():
117 """Return the 'authname <authemail>' string as read from the
120 if config
.has_option('stgit', 'authname') \
121 and config
.has_option('stgit', 'authemail'):
122 return '%s <%s>' %
(config
.get('stgit', 'authname'),
123 config
.get('stgit', 'authemail'))
127 def __parse_addresses(addresses
):
128 """Return a two elements tuple: (from, [to])
130 def __addr_list(addrs
):
131 m
= re
.search('[^@\s<,]+@[^>\s,]+', addrs
);
134 return [ m
.group() ] + __addr_list(addrs
[m
.end():])
138 for line
in addresses
.split('\n'):
139 if re
.match('from:\s+', line
, re
.I
):
140 from_addr_list
+= __addr_list(line
)
141 elif re
.match('(to|cc|bcc):\s+', line
, re
.I
):
142 to_addr_list
+= __addr_list(line
)
144 if len(from_addr_list
) == 0:
145 raise CmdException
, 'No "From" address'
146 if len(to_addr_list
) == 0:
147 raise CmdException
, 'No "To/Cc/Bcc" addresses'
149 return (from_addr_list
[0], to_addr_list
)
151 def __send_message(smtpserver
, from_addr
, to_addr_list
, msg
, sleep
,
152 smtpuser
, smtppassword
):
153 """Send the message using the given SMTP server
156 s
= smtplib
.SMTP(smtpserver
)
157 except Exception, err
:
158 raise CmdException
, str(err
)
162 if smtpuser
and smtppassword
:
164 s
.login(smtpuser
, smtppassword
)
166 s
.sendmail(from_addr
, to_addr_list
, msg
)
167 # give recipients a chance of receiving patches in the correct order
169 except Exception, err
:
170 raise CmdException
, str(err
)
174 def __build_address_headers(options
):
177 headers_end
+= 'To: '
178 for to
in options
.to
:
179 headers_end
+= '%s, ' % to
180 headers_end
= headers_end
[:-2] + '\n'
182 headers_end
+= 'Cc: '
183 for cc
in options
.cc
:
184 headers_end
+= '%s, ' % cc
185 headers_end
= headers_end
[:-2] + '\n'
187 headers_end
+= 'Bcc: '
188 for bcc
in options
.bcc
:
189 headers_end
+= '%s, ' % bcc
190 headers_end
= headers_end
[:-2] + '\n'
193 def __build_cover(tmpl
, total_nr
, msg_id
, options
):
194 """Build the cover message (series description) to be sent via SMTP
196 maintainer
= __get_maintainer()
200 headers_end
= __build_address_headers(options
)
201 headers_end
+= 'Message-Id: %s\n' % msg_id
204 version_str
= ' %s' % options
.version
208 total_nr_str
= str(total_nr
)
209 patch_nr_str
= '0'.zfill(len(total_nr_str
))
211 number_str
= ' %s/%s' %
(patch_nr_str
, total_nr_str
)
215 tmpl_dict
= {'maintainer': maintainer
,
216 'endofheaders': headers_end
,
217 'date': email
.Utils
.formatdate(localtime
= True),
218 'version': version_str
,
219 'patchnr': patch_nr_str
,
220 'totalnr': total_nr_str
,
221 'number': number_str
}
224 msg
= tmpl % tmpl_dict
225 except KeyError, err
:
226 raise CmdException
, 'Unknown patch template variable: %s' \
229 raise CmdException
, 'Only "%(name)s" variables are ' \
230 'supported in the patch template'
233 fname
= '.stgitmail.txt'
235 # create the initial file
236 f
= file(fname
, 'w+')
241 if config
.has_option('stgit', 'editor'):
242 editor
= config
.get('stgit', 'editor')
243 elif 'EDITOR' in os
.environ
:
244 editor
= os
.environ
['EDITOR']
247 editor
+= ' %s' % fname
249 print 'Invoking the editor: "%s"...' % editor
,
251 print 'done (exit code: %d)' % os
.system(editor
)
253 # read the message back
260 def __build_message(tmpl
, patch
, patch_nr
, total_nr
, msg_id
, ref_id
, options
):
261 """Build the message to be sent via SMTP
263 p
= crt_series
.get_patch(patch
)
265 descr
= p
.get_description().strip()
266 descr_lines
= descr
.split('\n')
268 short_descr
= descr_lines
[0].rstrip()
269 long_descr
= reduce(lambda x
, y
: x
+ '\n' + y
,
270 descr_lines
[1:], '').lstrip()
272 maintainer
= __get_maintainer()
274 maintainer
= '%s <%s>' %
(p
.get_commname(), p
.get_commemail())
276 headers_end
= __build_address_headers(options
)
277 headers_end
+= 'Message-Id: %s\n' % msg_id
279 headers_end
+= "In-Reply-To: %s\n" % ref_id
280 headers_end
+= "References: %s\n" % ref_id
283 version_str
= ' %s' % options
.version
287 total_nr_str
= str(total_nr
)
288 patch_nr_str
= str(patch_nr
).zfill(len(total_nr_str
))
290 number_str
= ' %s/%s' %
(patch_nr_str
, total_nr_str
)
294 tmpl_dict
= {'patch': patch
,
295 'maintainer': maintainer
,
296 'shortdescr': short_descr
,
297 'longdescr': long_descr
,
298 'endofheaders': headers_end
,
299 'diff': git
.diff(rev1
= git_id('%s/bottom' % patch
),
300 rev2
= git_id('%s/top' % patch
)),
301 'diffstat': git
.diffstat(rev1
= git_id('%s/bottom'%patch
),
302 rev2
= git_id('%s/top' % patch
)),
303 'date': email
.Utils
.formatdate(localtime
= True),
304 'version': version_str
,
305 'patchnr': patch_nr_str
,
306 'totalnr': total_nr_str
,
307 'number': number_str
,
308 'authname': p
.get_authname(),
309 'authemail': p
.get_authemail(),
310 'authdate': p
.get_authdate(),
311 'commname': p
.get_commname(),
312 'commemail': p
.get_commemail()}
313 for key
in tmpl_dict
:
314 if not tmpl_dict
[key
]:
318 msg
= tmpl % tmpl_dict
319 except KeyError, err
:
320 raise CmdException
, 'Unknown patch template variable: %s' \
323 raise CmdException
, 'Only "%(name)s" variables are ' \
324 'supported in the patch template'
328 def func(parser
, options
, args
):
329 """Send the patches by e-mail using the patchmail.tmpl file as
332 if not config
.has_option('stgit', 'smtpserver'):
333 raise CmdException
, 'smtpserver not defined'
334 smtpserver
= config
.get('stgit', 'smtpserver')
338 if config
.has_option('stgit', 'smtpuser'):
339 smtpuser
= config
.get('stgit', 'smtpuser')
340 if config
.has_option('stgit', 'smtppassword'):
341 smtppassword
= config
.get('stgit', 'smtppassword')
343 applied
= crt_series
.get_applied()
344 unapplied
= crt_series
.get_unapplied()
348 if patch
in unapplied
:
349 raise CmdException
, 'Patch "%s" not applied' % patch
350 if not patch
in applied
:
351 raise CmdException
, 'Patch "%s" does not exist' % patch
356 boundaries
= options
.range.split(':')
357 if len(boundaries
) == 1:
358 start
= boundaries
[0]
360 elif len(boundaries
) == 2:
361 if boundaries
[0] == '':
364 start
= boundaries
[0]
365 if boundaries
[1] == '':
370 raise CmdException
, 'incorrect parameters to "--range"'
373 start_idx
= applied
.index(start
)
375 if start
in unapplied
:
376 raise CmdException
, 'Patch "%s" not applied' % start
378 raise CmdException
, 'Patch "%s" does not exist' % start
380 stop_idx
= applied
.index(stop
) + 1
382 if stop
in unapplied
:
383 raise CmdException
, 'Patch "%s" not applied' % stop
385 raise CmdException
, 'Patch "%s" does not exist' % stop
387 if start_idx
>= stop_idx
:
388 raise CmdException
, 'Incorrect patch range order'
390 patches
= applied
[start_idx
:stop_idx
]
392 raise CmdException
, 'Incorrect options. Unknown patches to send'
394 if options
.smtp_password
:
395 smtppassword
= options
.smtp_password
397 if options
.smtp_user
:
398 smtpuser
= options
.smtp_user
400 if (smtppassword
and not smtpuser
):
401 raise CmdException
, 'SMTP password supplied, username needed'
402 if (smtpuser
and not smtppassword
):
403 raise CmdException
, 'SMTP username supplied, password needed'
405 total_nr
= len(patches
)
407 raise CmdException
, 'No patches to send'
409 ref_id
= options
.refid
411 if options
.sleep
!= None:
412 sleep
= options
.sleep
416 # send the cover message (if any)
417 if options
.cover
or options
.edit
:
418 # find the template file
420 tfile_list
= [options
.cover
]
422 tfile_list
= [os
.path
.join(git
.base_dir
, 'covermail.tmpl'),
423 os
.path
.join(sys
.prefix
,
424 'share/stgit/templates/covermail.tmpl')]
427 for tfile
in tfile_list
:
428 if os
.path
.isfile(tfile
):
429 tmpl
= file(tfile
).read()
432 raise CmdException
, 'No cover message template file found'
434 msg_id
= email
.Utils
.make_msgid('stgit')
435 msg
= __build_cover(tmpl
, total_nr
, msg_id
, options
)
436 from_addr
, to_addr_list
= __parse_addresses(msg
)
438 # subsequent e-mails are seen as replies to the first one
441 print 'Sending the cover message...',
444 __send_message(smtpserver
, from_addr
, to_addr_list
, msg
, sleep
,
445 smtpuser
, smtppassword
)
451 tfile_list
= [options
.template
]
453 tfile_list
= [os
.path
.join(git
.base_dir
, 'patchmail.tmpl'),
454 os
.path
.join(sys
.prefix
,
455 'share/stgit/templates/patchmail.tmpl')]
457 for tfile
in tfile_list
:
458 if os
.path
.isfile(tfile
):
459 tmpl
= file(tfile
).read()
462 raise CmdException
, 'No e-mail template file found'
464 for (p
, patch_nr
) in zip(patches
, range(1, len(patches
) + 1)):
465 msg_id
= email
.Utils
.make_msgid('stgit')
466 msg
= __build_message(tmpl
, p
, patch_nr
, total_nr
, msg_id
, ref_id
,
468 from_addr
, to_addr_list
= __parse_addresses(msg
)
470 # subsequent e-mails are seen as replies to the first one
474 print 'Sending patch "%s"...' % p
,
477 __send_message(smtpserver
, from_addr
, to_addr_list
, msg
, sleep
,
478 smtpuser
, smtppassword
)