chiark - git - mdw - stgit/blob - stgit/commands/mail.py

   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'
  29 usage = """%prog [options] [<patch>]
  30
  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.
  38
  39 A preamble e-mail can be sent using the '--first' option. All the
  40 subsequent e-mails appear as replies to the first e-mail sent (either
  41 the preamble or the first patch). E-mails can be seen as replies to a
  42 different e-mail by using the '--refid' option.
  43
  44 SMTP authentication is also possible with '--smtp-user' and
  45 '--smtp-password' options, also available as configuration settings:
  46 'smtpuser' and 'smtppassword'.
  47
  48 The template e-mail headers and body must be separated by
  49 '%(endofheaders)s' variable, which is replaced by StGIT with
  50 additional headers and a blank line. The patch e-mail template accepts
  51 the following variables:
  52
  53   %(patch)s        - patch name
  54   %(maintainer)s   - 'authname <authemail>' as read from the config file
  55   %(shortdescr)s   - the first line of the patch description
  56   %(longdescr)s    - the rest of the patch description, after the first line
  57   %(endofheaders)s - delimiter between e-mail headers and body
  58   %(diff)s         - unified diff of the patch
  59   %(diffstat)s     - diff statistics
  60   %(date)s         - current date/time
  61   %(version)s      - ' version' string passed on the command line (or empty)
  62   %(patchnr)s      - patch number
  63   %(totalnr)s      - total number of patches to be sent
  64   %(number)s       - empty if only one patch is sent or ' patchnr/totalnr'
  65   %(authname)s     - author's name
  66   %(authemail)s    - author's email
  67   %(authdate)s     - patch creation date
  68   %(commname)s     - committer's name
  69   %(commemail)s    - committer's e-mail
  70
  71 For the preamble e-mail template, only the %(maintainer)s, %(date)s,
  72 %(endofheaders)s, %(version)s, %(patchnr)s, %(totalnr)s and %(number)s
  73 variables are supported."""
  74
  75 options = [make_option('-a', '--all',
  76                        help = 'e-mail all the applied patches',
  77                        action = 'store_true'),
  78            make_option('-r', '--range',
  79                        metavar = '[PATCH1][:[PATCH2]]',
  80                        help = 'e-mail patches between PATCH1 and PATCH2'),
  81            make_option('--to',
  82                        help = 'add TO to the To: list'),
  83            make_option('--cc',
  84                        help = 'add CC to the Cc: list'),
  85            make_option('--bcc',
  86                        help = 'add BCC to the Bcc: list'),
  87            make_option('-v', '--version', metavar = 'VERSION',
  88                        help = 'add VERSION to the [PATCH ...] prefix'),
  89            make_option('-t', '--template', metavar = 'FILE',
  90                        help = 'use FILE as the message template'),
  91            make_option('-f', '--first', metavar = 'FILE',
  92                        help = 'send FILE as the first message'),
  93            make_option('-s', '--sleep', type = 'int', metavar = 'SECONDS',
  94                        help = 'sleep for SECONDS between e-mails sending'),
  95            make_option('--refid',
  96                        help = 'use REFID as the reference id'),
  97            make_option('-u', '--smtp-user', metavar = 'USER',
  98                        help = 'username for SMTP authentication'),
  99            make_option('-p', '--smtp-password', metavar = 'PASSWORD',
 100                        help = 'username for SMTP authentication'),
 101            make_option('-b', '--branch',
 102                        help = 'use BRANCH instead of the default one')]
 103
 104
 105 def __get_maintainer():
 106     """Return the 'authname <authemail>' string as read from the
 107     configuration file
 108     """
 109     if config.has_option('stgit', 'authname') \
 110            and config.has_option('stgit', 'authemail'):
 111         return '%s <%s>' % (config.get('stgit', 'authname'),
 112                             config.get('stgit', 'authemail'))
 113     else:
 114         return None
 115
 116 def __parse_addresses(string):
 117     """Return a two elements tuple: (from, [to])
 118     """
 119     def __addr_list(string):
 120         return re.split('.*?([\w\.]+@[\w\.]+)', string)[1:-1:2]
 121
 122     from_addr_list = []
 123     to_addr_list = []
 124     for line in string.split('\n'):
 125         if re.match('from:\s+', line, re.I):
 126             from_addr_list += __addr_list(line)
 127         elif re.match('(to|cc|bcc):\s+', line, re.I):
 128             to_addr_list += __addr_list(line)
 129
 130     if len(from_addr_list) != 1:
 131         raise CmdException, 'No "From" address'
 132     if len(to_addr_list) == 0:
 133         raise CmdException, 'No "To/Cc/Bcc" addresses'
 134
 135     return (from_addr_list[0], to_addr_list)
 136
 137 def __send_message(smtpserver, from_addr, to_addr_list, msg, sleep,
 138                    smtpuser, smtppassword):
 139     """Send the message using the given SMTP server
 140     """
 141     try:
 142         s = smtplib.SMTP(smtpserver)
 143     except Exception, err:
 144         raise CmdException, str(err)
 145
 146     s.set_debuglevel(0)
 147     try:
 148         if smtpuser and smtppassword:
 149             s.ehlo()
 150             s.login(smtpuser, smtppassword)
 151
 152         s.sendmail(from_addr, to_addr_list, msg)
 153         # give recipients a chance of receiving patches in the correct order
 154         time.sleep(sleep)
 155     except Exception, err:
 156         raise CmdException, str(err)
 157
 158     s.quit()
 159
 160 def __build_first(tmpl, total_nr, msg_id, options):
 161     """Build the first message (series description) to be sent via SMTP
 162     """
 163     maintainer = __get_maintainer()
 164     if not maintainer:
 165         maintainer = ''
 166
 167     headers_end = ''
 168     if options.to:
 169         headers_end += 'To: %s\n' % options.to
 170     if options.cc:
 171         headers_end += 'Cc: %s\n' % options.cc
 172     if options.bcc:
 173         headers_end += 'Bcc: %s\n' % options.bcc
 174     headers_end += 'Message-Id: %s\n' % msg_id
 175
 176     if options.version:
 177         version_str = ' %s' % options.version
 178
 179     total_nr_str = str(total_nr)
 180     patch_nr_str = '0'.zfill(len(total_nr_str))
 181     if total_nr > 1:
 182         number_str = ' %s/%s' % (patch_nr_str, total_nr_str)
 183     else:
 184         number_str = ''
 185
 186     tmpl_dict = {'maintainer':   maintainer,
 187                  'endofheaders': headers_end,
 188                  'date':         email.Utils.formatdate(localtime = True),
 189                  'version':      version_str,
 190                  'patchnr':      patch_nr_str,
 191                  'totalnr':      total_nr_str,
 192                  'number':       number_str}
 193
 194     try:
 195         msg = tmpl % tmpl_dict
 196     except KeyError, err:
 197         raise CmdException, 'Unknown patch template variable: %s' \
 198               % err
 199     except TypeError:
 200         raise CmdException, 'Only "%(name)s" variables are ' \
 201               'supported in the patch template'
 202
 203     return msg
 204
 205 def __build_message(tmpl, patch, patch_nr, total_nr, msg_id, ref_id, options):
 206     """Build the message to be sent via SMTP
 207     """
 208     p = crt_series.get_patch(patch)
 209
 210     descr = p.get_description().strip()
 211     descr_lines = descr.split('\n')
 212
 213     short_descr = descr_lines[0].rstrip()
 214     long_descr = reduce(lambda x, y: x + '\n' + y,
 215                         descr_lines[1:], '').lstrip()
 216
 217     maintainer = __get_maintainer()
 218     if not maintainer:
 219         maintainer = '%s <%s>' % (p.get_commname(), p.get_commemail())
 220
 221     headers_end = ''
 222     if options.to:
 223         headers_end += 'To: %s\n' % options.to
 224     if options.cc:
 225         headers_end += 'Cc: %s\n' % options.cc
 226     if options.bcc:
 227         headers_end += 'Bcc: %s\n' % options.bcc
 228     headers_end += 'Message-Id: %s\n' % msg_id
 229     if ref_id:
 230         headers_end += "In-Reply-To: %s\n" % ref_id
 231         headers_end += "References: %s\n" % ref_id
 232
 233     if options.version:
 234         version_str = ' %s' % options.version
 235
 236     total_nr_str = str(total_nr)
 237     patch_nr_str = str(patch_nr).zfill(len(total_nr_str))
 238     if total_nr > 1:
 239         number_str = ' %s/%s' % (patch_nr_str, total_nr_str)
 240     else:
 241         number_str = ''
 242
 243     tmpl_dict = {'patch':        patch,
 244                  'maintainer':   maintainer,
 245                  'shortdescr':   short_descr,
 246                  'longdescr':    long_descr,
 247                  'endofheaders': headers_end,
 248                  'diff':         git.diff(rev1 = git_id('%s/bottom' % patch),
 249                                           rev2 = git_id('%s/top' % patch)),
 250                  'diffstat':     git.diffstat(rev1 = git_id('%s/bottom'%patch),
 251                                               rev2 = git_id('%s/top' % patch)),
 252                  'date':         email.Utils.formatdate(localtime = True),
 253                  'version':      version_str,
 254                  'patchnr':      patch_nr_str,
 255                  'totalnr':      total_nr_str,
 256                  'number':       number_str,
 257                  'authname':     p.get_authname(),
 258                  'authemail':    p.get_authemail(),
 259                  'authdate':     p.get_authdate(),
 260                  'commname':     p.get_commname(),
 261                  'commemail':    p.get_commemail()}
 262     for key in tmpl_dict:
 263         if not tmpl_dict[key]:
 264             tmpl_dict[key] = ''
 265
 266     try:
 267         msg = tmpl % tmpl_dict
 268     except KeyError, err:
 269         raise CmdException, 'Unknown patch template variable: %s' \
 270               % err
 271     except TypeError:
 272         raise CmdException, 'Only "%(name)s" variables are ' \
 273               'supported in the patch template'
 274
 275     return msg
 276
 277 def func(parser, options, args):
 278     """Send the patches by e-mail using the patchmail.tmpl file as
 279     a template
 280     """
 281     if len(args) > 1:
 282         parser.error('incorrect number of arguments')
 283
 284     if not config.has_option('stgit', 'smtpserver'):
 285         raise CmdException, 'smtpserver not defined'
 286     smtpserver = config.get('stgit', 'smtpserver')
 287
 288     smtpuser = None
 289     smtppassword = None
 290     if config.has_option('stgit', 'smtpuser'):
 291         smtpuser = config.get('stgit', 'smtpuser')
 292     if config.has_option('stgit', 'smtppassword'):
 293         smtppassword = config.get('stgit', 'smtppassword')
 294
 295     applied = crt_series.get_applied()
 296
 297     if len(args) == 1:
 298         if args[0] in applied:
 299             patches = [args[0]]
 300         else:
 301             raise CmdException, 'Patch "%s" not applied' % args[0]
 302     elif options.all:
 303         patches = applied
 304     elif options.range:
 305         boundaries = options.range.split(':')
 306         if len(boundaries) == 1:
 307             start = boundaries[0]
 308             stop = boundaries[0]
 309         elif len(boundaries) == 2:
 310             if boundaries[0] == '':
 311                 start = applied[0]
 312             else:
 313                 start = boundaries[0]
 314             if boundaries[1] == '':
 315                 stop = applied[-1]
 316             else:
 317                 stop = boundaries[1]
 318         else:
 319             raise CmdException, 'incorrect parameters to "--range"'
 320
 321         if start in applied:
 322             start_idx = applied.index(start)
 323         else:
 324             raise CmdException, 'Patch "%s" not applied' % start
 325         if stop in applied:
 326             stop_idx = applied.index(stop) + 1
 327         else:
 328             raise CmdException, 'Patch "%s" not applied' % stop
 329
 330         if start_idx >= stop_idx:
 331             raise CmdException, 'Incorrect patch range order'
 332
 333         patches = applied[start_idx:stop_idx]
 334     else:
 335         raise CmdException, 'Incorrect options. Unknown patches to send'
 336
 337     if options.smtp_password:
 338         smtppassword = options.smtp_password
 339
 340     if options.smtp_user:
 341         smtpuser = options.smtp_user
 342
 343     if (smtppassword and not smtpuser):
 344         raise CmdException, 'SMTP password supplied, username needed'
 345     if (smtpuser and not smtppassword):
 346         raise CmdException, 'SMTP username supplied, password needed'
 347
 348     total_nr = len(patches)
 349     if total_nr == 0:
 350         raise CmdException, 'No patches to send'
 351
 352     ref_id = options.refid
 353
 354     if options.sleep != None:
 355         sleep = options.sleep
 356     else:
 357         sleep = 2
 358
 359     # send the first message (if any)
 360     if options.first:
 361         tmpl = file(options.first).read()
 362
 363         msg_id = email.Utils.make_msgid('stgit')
 364         msg = __build_first(tmpl, total_nr, msg_id, options)
 365         from_addr, to_addr_list = __parse_addresses(msg)
 366
 367         # subsequent e-mails are seen as replies to the first one
 368         ref_id = msg_id
 369
 370         print 'Sending file "%s"...' % options.first,
 371         sys.stdout.flush()
 372
 373         __send_message(smtpserver, from_addr, to_addr_list, msg, sleep,
 374                        smtpuser, smtppassword)
 375
 376         print 'done'
 377
 378     # send the patches
 379     if options.template:
 380         tfile_list = [options.template]
 381     else:
 382         tfile_list = []
 383
 384     tfile_list += [os.path.join(git.base_dir, 'patchmail.tmpl'),
 385                    os.path.join(sys.prefix,
 386                                 'share/stgit/templates/patchmail.tmpl')]
 387     tmpl = None
 388     for tfile in tfile_list:
 389         if os.path.isfile(tfile):
 390             tmpl = file(tfile).read()
 391             break
 392     if not tmpl:
 393         raise CmdException, 'No e-mail template file: %s or %s' \
 394               % (tfile_list[-1], tfile_list[-2])
 395
 396     for (p, patch_nr) in zip(patches, range(1, len(patches) + 1)):
 397         msg_id = email.Utils.make_msgid('stgit')
 398         msg = __build_message(tmpl, p, patch_nr, total_nr, msg_id, ref_id,
 399                               options)
 400         from_addr, to_addr_list = __parse_addresses(msg)
 401
 402         # subsequent e-mails are seen as replies to the first one
 403         if not ref_id:
 404             ref_id = msg_id
 405
 406         print 'Sending patch "%s"...' % p,
 407         sys.stdout.flush()
 408
 409         __send_message(smtpserver, from_addr, to_addr_list, msg, sleep,
 410                        smtpuser, smtppassword)
 411
 412         print 'done'