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 | ||
18 | import sys, os, re, time, smtplib, email.Utils | |
19 | from optparse import OptionParser, make_option | |
20 | from time import gmtime, strftime | |
21 | ||
22 | from stgit.commands.common import * | |
23 | from stgit.utils import * | |
24 | from stgit import stack, git | |
25 | from stgit.config import config | |
26 | ||
27 | ||
28 | help = 'send a patch or series of patches by e-mail' | |
ddab48a5 | 29 | usage = """%prog [options] [<patch> [<patch2...]] |
26aab5b0 CM |
30 | |
31 | Send a patch or a range of patches (defaulting to the applied patches) | |
2bb96902 CM |
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. | |
38 | ||
e3e05587 CM |
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). | |
44 | ||
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. | |
26aab5b0 CM |
48 | |
49 | SMTP authentication is also possible with '--smtp-user' and | |
50 | '--smtp-password' options, also available as configuration settings: | |
51 | 'smtpuser' and 'smtppassword'. | |
52 | ||
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: | |
57 | ||
58 | %(patch)s - patch name | |
dae0f0be | 59 | %(maintainer)s - 'authname <authemail>' as read from the config file |
26aab5b0 CM |
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 | |
d0d139a3 | 66 | %(version)s - ' version' string passed on the command line (or empty) |
26aab5b0 CM |
67 | %(patchnr)s - patch number |
68 | %(totalnr)s - total number of patches to be sent | |
b8d258e5 | 69 | %(number)s - empty if only one patch is sent or ' patchnr/totalnr' |
26aab5b0 CM |
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 | |
75 | ||
dae0f0be | 76 | For the preamble e-mail template, only the %(maintainer)s, %(date)s, |
d0d139a3 CM |
77 | %(endofheaders)s, %(version)s, %(patchnr)s, %(totalnr)s and %(number)s |
78 | variables are supported.""" | |
b4bddc06 | 79 | |
9a316368 CM |
80 | options = [make_option('-a', '--all', |
81 | help = 'e-mail all the applied patches', | |
82 | action = 'store_true'), | |
b4bddc06 CM |
83 | make_option('-r', '--range', |
84 | metavar = '[PATCH1][:[PATCH2]]', | |
85 | help = 'e-mail patches between PATCH1 and PATCH2'), | |
2bb96902 | 86 | make_option('--to', |
e83b3149 PO |
87 | help = 'add TO to the To: list', |
88 | action = 'append'), | |
2bb96902 | 89 | make_option('--cc', |
e83b3149 PO |
90 | help = 'add CC to the Cc: list', |
91 | action = 'append'), | |
2bb96902 | 92 | make_option('--bcc', |
e83b3149 PO |
93 | help = 'add BCC to the Bcc: list', |
94 | action = 'append'), | |
d0d139a3 CM |
95 | make_option('-v', '--version', metavar = 'VERSION', |
96 | help = 'add VERSION to the [PATCH ...] prefix'), | |
9a316368 CM |
97 | make_option('-t', '--template', metavar = 'FILE', |
98 | help = 'use FILE as the message template'), | |
e3e05587 CM |
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'), | |
b4bddc06 CM |
104 | make_option('-s', '--sleep', type = 'int', metavar = 'SECONDS', |
105 | help = 'sleep for SECONDS between e-mails sending'), | |
106 | make_option('--refid', | |
d0d139a3 | 107 | help = 'use REFID as the reference id'), |
eb026d93 B |
108 | make_option('-u', '--smtp-user', metavar = 'USER', |
109 | help = 'username for SMTP authentication'), | |
110 | make_option('-p', '--smtp-password', metavar = 'PASSWORD', | |
2f7c8b0b CM |
111 | help = 'username for SMTP authentication'), |
112 | make_option('-b', '--branch', | |
113 | help = 'use BRANCH instead of the default one')] | |
b4bddc06 CM |
114 | |
115 | ||
dae0f0be CM |
116 | def __get_maintainer(): |
117 | """Return the 'authname <authemail>' string as read from the | |
118 | configuration file | |
119 | """ | |
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')) | |
124 | else: | |
125 | return None | |
126 | ||
7cc615f3 | 127 | def __parse_addresses(addresses): |
b4bddc06 CM |
128 | """Return a two elements tuple: (from, [to]) |
129 | """ | |
7cc615f3 CL |
130 | def __addr_list(addrs): |
131 | m = re.search('[^@\s<,]+@[^>\s,]+', addrs); | |
d60cd083 CM |
132 | if (m == None): |
133 | return [] | |
7cc615f3 | 134 | return [ m.group() ] + __addr_list(addrs[m.end():]) |
b4bddc06 CM |
135 | |
136 | from_addr_list = [] | |
137 | to_addr_list = [] | |
7cc615f3 | 138 | for line in addresses.split('\n'): |
b4bddc06 CM |
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) | |
143 | ||
24aadb3f | 144 | if len(from_addr_list) == 0: |
b4bddc06 CM |
145 | raise CmdException, 'No "From" address' |
146 | if len(to_addr_list) == 0: | |
147 | raise CmdException, 'No "To/Cc/Bcc" addresses' | |
148 | ||
149 | return (from_addr_list[0], to_addr_list) | |
150 | ||
eb026d93 B |
151 | def __send_message(smtpserver, from_addr, to_addr_list, msg, sleep, |
152 | smtpuser, smtppassword): | |
b4bddc06 CM |
153 | """Send the message using the given SMTP server |
154 | """ | |
155 | try: | |
156 | s = smtplib.SMTP(smtpserver) | |
157 | except Exception, err: | |
158 | raise CmdException, str(err) | |
159 | ||
160 | s.set_debuglevel(0) | |
161 | try: | |
eb026d93 B |
162 | if smtpuser and smtppassword: |
163 | s.ehlo() | |
164 | s.login(smtpuser, smtppassword) | |
165 | ||
b4bddc06 CM |
166 | s.sendmail(from_addr, to_addr_list, msg) |
167 | # give recipients a chance of receiving patches in the correct order | |
168 | time.sleep(sleep) | |
169 | except Exception, err: | |
170 | raise CmdException, str(err) | |
171 | ||
172 | s.quit() | |
173 | ||
e83b3149 PO |
174 | def __build_address_headers(options): |
175 | headers_end = '' | |
176 | if options.to: | |
d60cd083 CM |
177 | headers_end += 'To: ' |
178 | for to in options.to: | |
179 | headers_end += '%s, ' % to | |
180 | headers_end = headers_end[:-2] + '\n' | |
e83b3149 | 181 | if options.cc: |
d60cd083 CM |
182 | headers_end += 'Cc: ' |
183 | for cc in options.cc: | |
184 | headers_end += '%s, ' % cc | |
185 | headers_end = headers_end[:-2] + '\n' | |
e83b3149 | 186 | if options.bcc: |
d60cd083 CM |
187 | headers_end += 'Bcc: ' |
188 | for bcc in options.bcc: | |
189 | headers_end += '%s, ' % bcc | |
190 | headers_end = headers_end[:-2] + '\n' | |
e83b3149 PO |
191 | return headers_end |
192 | ||
e3e05587 CM |
193 | def __build_cover(tmpl, total_nr, msg_id, options): |
194 | """Build the cover message (series description) to be sent via SMTP | |
b4bddc06 | 195 | """ |
dae0f0be CM |
196 | maintainer = __get_maintainer() |
197 | if not maintainer: | |
198 | maintainer = '' | |
199 | ||
e83b3149 | 200 | headers_end = __build_address_headers(options) |
2bb96902 | 201 | headers_end += 'Message-Id: %s\n' % msg_id |