mdw@git.distorted.org.uk Git - 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, datetime, smtplib, email.Utils
  19 from optparse import OptionParser, make_option
  20
  21 from stgit.commands.common import *
  22 from stgit.utils import *
  23 from stgit import stack, git, version, templates
  24 from stgit.config import config
  25
  26
  27 help = 'send a patch or series of patches by e-mail'
  28 usage = """%prog [options] [<patch1>] [<patch2>] [<patch3>..<patch4>]
  29
  30 Send a patch or a range of patches by e-mail using the 'smtpserver'
  31 configuration option. The From address and the e-mail format are
  32 generated from the template file passed as argument to '--template'
  33 (defaulting to '.git/patchmail.tmpl' or
  34 '~/.stgit/templates/patchmail.tmpl' or or
  35 '/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 '--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 '~/.stgit/templates/covermail.tmpl' or
  44 '/usr/share/stgit/templates/covermail.tmpl').
  45
  46 All the subsequent e-mails appear as replies to the first e-mail sent
  47 (either the preamble or the first patch). E-mails can be seen as
  48 replies to a different e-mail by using the '--refid' option.
  49
  50 SMTP authentication is also possible with '--smtp-user' and
  51 '--smtp-password' options, also available as configuration settings:
  52 'smtpuser' and 'smtppassword'.
  53
  54 The template e-mail headers and body must be separated by
  55 '%(endofheaders)s' variable, which is replaced by StGIT with
  56 additional headers and a blank line. The patch e-mail template accepts
  57 the following variables:
  58
  59   %(patch)s        - patch name
  60   %(maintainer)s   - 'authname <authemail>' as read from the config file
  61   %(shortdescr)s   - the first line of the patch description
  62   %(longdescr)s    - the rest of the patch description, after the first line
  63   %(endofheaders)s - delimiter between e-mail headers and body
  64   %(diff)s         - unified diff of the patch
  65   %(diffstat)s     - diff statistics
  66   %(date)s         - current date/time
  67   %(version)s      - ' version' string passed on the command line (or empty)
  68   %(prefix)s       - 'prefix ' string passed on the command line
  69   %(patchnr)s      - patch number
  70   %(totalnr)s      - total number of patches to be sent
  71   %(number)s       - empty if only one patch is sent or ' patchnr/totalnr'
  72   %(authname)s     - author's name
  73   %(authemail)s    - author's email
  74   %(authdate)s     - patch creation date
  75   %(commname)s     - committer's name
  76   %(commemail)s    - committer's e-mail
  77
  78 For the preamble e-mail template, only the %(maintainer)s, %(date)s,
  79 %(endofheaders)s, %(version)s, %(patchnr)s, %(totalnr)s and %(number)s
  80 variables are supported."""
  81
  82 options = [make_option('-a', '--all',
  83                        help = 'e-mail all the applied patches',
  84                        action = 'store_true'),
  85            make_option('--to',
  86                        help = 'add TO to the To: list',
  87                        action = 'append'),
  88            make_option('--cc',
  89                        help = 'add CC to the Cc: list',
  90                        action = 'append'),
  91            make_option('--bcc',
  92                        help = 'add BCC to the Bcc: list',
  93                        action = 'append'),
  94            make_option('--auto',
  95                        help = 'automatically cc the patch signers',
  96                        action = 'store_true'),
  97            make_option('--noreply',
  98                        help = 'do not send subsequent messages as replies',
  99                        action = 'store_true'),
 100            make_option('-v', '--version', metavar = 'VERSION',
 101                        help = 'add VERSION to the [PATCH ...] prefix'),
 102            make_option('--prefix', metavar = 'PREFIX',
 103                        help = 'add PREFIX to the [... PATCH ...] prefix'),
 104            make_option('-t', '--template', metavar = 'FILE',
 105                        help = 'use FILE as the message template'),
 106            make_option('-c', '--cover', metavar = 'FILE',
 107                        help = 'send FILE as the cover message'),
 108            make_option('-e', '--edit',
 109                        help = 'edit the cover message before sending',
 110                        action = 'store_true'),
 111            make_option('-s', '--sleep', type = 'int', metavar = 'SECONDS',
 112                        help = 'sleep for SECONDS between e-mails sending'),
 113            make_option('--refid',
 114                        help = 'use REFID as the reference id'),
 115            make_option('-u', '--smtp-user', metavar = 'USER',
 116                        help = 'username for SMTP authentication'),
 117            make_option('-p', '--smtp-password', metavar = 'PASSWORD',
 118                        help = 'username for SMTP authentication'),
 119            make_option('-b', '--branch',
 120                        help = 'use BRANCH instead of the default one'),
 121            make_option('-m', '--mbox',
 122                        help = 'generate an mbox file instead of sending',
 123                        action = 'store_true')]
 124
 125
 126 def __get_maintainer():
 127     """Return the 'authname <authemail>' string as read from the
 128     configuration file
 129     """
 130     if config.has_option('stgit', 'authname') \
 131            and config.has_option('stgit', 'authemail'):
 132         return '%s <%s>' % (config.get('stgit', 'authname'),
 133                             config.get('stgit', 'authemail'))
 134     else:
 135         return None
 136
 137 def __parse_addresses(addresses):
 138     """Return a two elements tuple: (from, [to])
 139     """
 140     def __addr_list(addrs):
 141         m = re.search('[^@\s<,]+@[^>\s,]+', addrs);
 142         if (m == None):
 143             return []
 144         return [ m.group() ] + __addr_list(addrs[m.end():])
 145
 146     from_addr_list = []
 147     to_addr_list = []
 148     for line in addresses.split('\n'):
 149         if re.match('from:\s+', line, re.I):
 150             from_addr_list += __addr_list(line)
 151         elif re.match('(to|cc|bcc):\s+', line, re.I):
 152             to_addr_list += __addr_list(line)
 153
 154     if len(from_addr_list) == 0:
 155         raise CmdException, 'No "From" address'
 156     if len(to_addr_list) == 0:
 157         raise CmdException, 'No "To/Cc/Bcc" addresses'
 158
 159     return (from_addr_list[0], to_addr_list)
 160
 161 def __send_message(smtpserver, from_addr, to_addr_list, msg, sleep,
 162                    smtpuser, smtppassword):
 163     """Send the message using the given SMTP server
 164     """
 165     try:
 166         s = smtplib.SMTP(smtpserver)
 167     except Exception, err:
 168         raise CmdException, str(err)
 169
 170     s.set_debuglevel(0)
 171     try:
 172         if smtpuser and smtppassword:
 173             s.ehlo()
 174             s.login(smtpuser, smtppassword)
 175
 176         s.sendmail(from_addr, to_addr_list, msg)
 177         # give recipients a chance of receiving patches in the correct order
 178         time.sleep(sleep)
 179     except Exception, err:
 180         raise CmdException, str(err)
 181
 182     s.quit()
 183
 184 def __write_mbox(from_addr, msg):
 185     """Write an mbox like file to the standard output
 186     """
 187     r = re.compile('^From ', re.M)
 188     msg = r.sub('>\g<0>', msg)
 189
 190     print 'From %s %s' % (from_addr, datetime.datetime.today().ctime())
 191     print msg
 192     print
 193
 194 def __build_address_headers(tmpl, options, extra_cc = []):
 195     """Build the address headers and check existing headers in the
 196     template.
 197     """
 198     def csv(lst):
 199         return reduce(lambda x, y: x + ', ' + y, lst)
 200
 201     def replace_header(header, addr, tmpl):
 202         r = re.compile('^' + header + ':\s+.+$', re.I | re.M)
 203         if r.search(tmpl):
 204             tmpl = r.sub('\g<0>, ' + addr, tmpl, 1)
 205             h = ''
 206         else:
 207             h = header + ': ' + addr
 208
 209         return tmpl, h
 210
 211     headers = ''
 212     to_addr = ''
 213     cc_addr = ''
 214     bcc_addr = ''
 215
 216     if options.to:
 217         to_addr = csv(options.to)
 218     if options.cc:
 219         cc_addr = csv(options.cc + extra_cc)
 220     elif extra_cc:
 221         cc_addr = csv(extra_cc)
 222     if options.bcc:
 223         bcc_addr = csv(options.bcc)
 224
 225     # replace existing headers
 226     if to_addr:
 227         tmpl, h = replace_header('To', to_addr, tmpl)
 228         if h:
 229             headers += h + '\n'
 230     if cc_addr:
 231         tmpl, h = replace_header('Cc', cc_addr, tmpl)
 232         if h:
 233             headers += h + '\n'
 234     if bcc_addr:
 235         tmpl, h = replace_header('Bcc', bcc_addr, tmpl)
 236         if h:
 237             headers += h + '\n'
 238
 239     return tmpl, headers
 240
 241 def __get_signers_list(msg):
 242     """Return the address list generated from signed-off-by and
 243     acked-by lines in the message.
 244     """
 245     addr_list = []
 246
 247     r = re.compile('^(signed-off-by|acked-by):\s+(.+)$', re.I)
 248     for line in msg.split('\n'):
 249         m = r.match(line)
 250         if m:
 251             addr_list.append(m.expand('\g<2>'))
 252
 253     return addr_list
 254
 255 def __build_extra_headers():
 256     """Build extra headers like content-type etc.
 257     """
 258     headers  = 'Content-Type: text/plain; charset=utf-8; format=fixed\n'
 259     headers += 'Content-Transfer-Encoding: 8bit\n'
 260     headers += 'User-Agent: StGIT/%s\n' % version.version
 261
 262     return headers
 263
 264 def __build_cover(tmpl, total_nr, msg_id, options):
 265     """Build the cover message (series description) to be sent via SMTP
 266     """
 267     maintainer = __get_maintainer()
 268     if not maintainer:
 269         maintainer = ''
 270
 271     tmpl, headers_end = __build_address_headers(tmpl, options)
 272     headers_end += 'Message-Id: %s\n' % msg_id
 273     if options.refid:
 274         headers_end += "In-Reply-To: %s\n" % options.refid
 275         headers_end += "References: %s\n" % options.refid
 276     headers_end += __build_extra_headers()
 277
 278     if options.version:
 279         version_str = ' %s' % options.version
 280     else:
 281         version_str = ''
 282
 283     if options.prefix:
 284         prefix_str = options.prefix + ' '
 285     else:
 286         prefix_str = ''
 287
 288     total_nr_str = str(total_nr)
 289     patch_nr_str = '0'.zfill(len(total_nr_str))
 290     if total_nr > 1:
 291         number_str = ' %s/%s' % (patch_nr_str, total_nr_str)
 292     else:
 293         number_str = ''
 294
 295     tmpl_dict = {'maintainer':   maintainer,
 296                  'endofheaders': headers_end,
 297                  'date':         email.Utils.formatdate(localtime = True),
 298                  'version':      version_str,
 299                  'prefix':       prefix_str,
 300                  'patchnr':      patch_nr_str,
 301                  'totalnr':      total_nr_str,
 302                  'number':       number_str}
 303
 304     try:
 305         msg = tmpl % tmpl_dict
 306     except KeyError, err:
 307         raise CmdException, 'Unknown patch template variable: %s' \
 308               % err
 309     except TypeError:
 310         raise CmdException, 'Only "%(name)s" variables are ' \
 311               'supported in the patch template'
 312
 313     if options.edit:
 314         fname = '.stgitmail.txt'
 315
 316         # create the initial file
 317         f = file(fname, 'w+')
 318         f.write(msg)
 319         f.close()
 320
 321         # the editor
 322         if config.has_option('stgit', 'editor'):
 323             editor = config.get('stgit', 'editor')
 324         elif 'EDITOR' in os.environ:
 325             editor = os.environ['EDITOR']
 326         else:
 327             editor = 'vi'
 328         editor += ' %s' % fname
 329
 330         print 'Invoking the editor: "%s"...' % editor,
 331         sys.stdout.flush()
 332         print 'done (exit code: %d)' % os.system(editor)
 333
 334         # read the message back
 335         f = file(fname)
 336         msg = f.read()
 337         f.close()
 338
 339     return msg.strip('\n')
 340
 341 def __build_message(tmpl, patch, patch_nr, total_nr, msg_id, ref_id, options):
 342     """Build the message to be sent via SMTP
 343     """
 344     p = crt_series.get_patch(patch)
 345
 346     descr = p.get_description().strip()
 347     descr_lines = descr.split('\n')
 348
 349     short_descr = descr_lines[0].rstrip()
 350     long_descr = reduce(lambda x, y: x + '\n' + y,
 351                         descr_lines[1:], '').lstrip()
 352
 353     maintainer = __get_maintainer()
 354     if not maintainer:
 355         maintainer = '%s <%s>' % (p.get_commname(), p.get_commemail())
 356
 357     if options.auto:
 358         extra_cc = __get_signers_list(descr)
 359     else:
 360         extra_cc = []
 361
 362     tmpl, headers_end = __build_address_headers(tmpl, options, extra_cc)
 363     headers_end += 'Message-Id: %s\n' % msg_id
 364     if ref_id:
 365         headers_end += "In-Reply-To: %s\n" % ref_id
 366         headers_end += "References: %s\n" % ref_id
 367     headers_end += __build_extra_headers()
 368
 369     if options.version:
 370         version_str = ' %s' % options.version
 371     else:
 372         version_str = ''
 373
 374     if options.prefix:
 375         prefix_str = options.prefix + ' '
 376     else:
 377         prefix_str = ''
 378
 379     total_nr_str = str(total_nr)
 380     patch_nr_str = str(patch_nr).zfill(len(total_nr_str))
 381     if total_nr > 1:
 382         number_str = ' %s/%s' % (patch_nr_str, total_nr_str)
 383     else:
 384         number_str = ''
 385
 386     tmpl_dict = {'patch':        patch,
 387                  'maintainer':   maintainer,
 388                  'shortdescr':   short_descr,
 389                  'longdescr':    long_descr,
 390                  'endofheaders': headers_end,
 391                  'diff':         git.diff(rev1 = git_id('%s//bottom' % patch),
 392                                           rev2 = git_id('%s//top' % patch)),
 393                  'diffstat':     git.diffstat(rev1 = git_id('%s//bottom'%patch),
 394                                               rev2 = git_id('%s//top' % patch)),
 395                  'date':         email.Utils.formatdate(localtime = True),
 396                  'version':      version_str,
 397                  'prefix':       prefix_str,
 398                  'patchnr':      patch_nr_str,
 399                  'totalnr':      total_nr_str,
 400                  'number':       number_str,
 401                  'authname':     p.get_authname(),
 402                  'authemail':    p.get_authemail(),
 403                  'authdate':     p.get_authdate(),
 404                  'commname':     p.get_commname(),
 405                  'commemail':    p.get_commemail()}
 406     for key in tmpl_dict:
 407         if not tmpl_dict[key]:
 408             tmpl_dict[key] = ''
 409
 410     try:
 411         msg = tmpl % tmpl_dict
 412     except KeyError, err:
 413         raise CmdException, 'Unknown patch template variable: %s' \
 414               % err
 415     except TypeError:
 416         raise CmdException, 'Only "%(name)s" variables are ' \
 417               'supported in the patch template'
 418
 419     return msg.strip('\n')
 420
 421 def func(parser, options, args):
 422     """Send the patches by e-mail using the patchmail.tmpl file as
 423     a template
 424     """
 425     smtpserver = config.get('stgit', 'smtpserver')
 426
 427     smtpuser = None
 428     smtppassword = None
 429     if config.has_option('stgit', 'smtpuser'):
 430         smtpuser = config.get('stgit', 'smtpuser')
 431     if config.has_option('stgit', 'smtppassword'):
 432         smtppassword = config.get('stgit', 'smtppassword')
 433
 434     applied = crt_series.get_applied()
 435
 436     if options.all:
 437         patches = applied
 438     elif len(args) >= 1:
 439         patches = parse_patches(args, applied)
 440     else:
 441         raise CmdException, 'Incorrect options. Unknown patches to send'
 442
 443     if options.smtp_password:
 444         smtppassword = options.smtp_password
 445
 446     if options.smtp_user:
 447         smtpuser = options.smtp_user
 448
 449     if (smtppassword and not smtpuser):
 450         raise CmdException, 'SMTP password supplied, username needed'
 451     if (smtpuser and not smtppassword):
 452         raise CmdException, 'SMTP username supplied, password needed'
 453
 454     total_nr = len(patches)
 455     if total_nr == 0:
 456         raise CmdException, 'No patches to send'
 457
 458     if options.noreply:
 459         ref_id = None
 460     else:
 461         ref_id = options.refid
 462
 463     if options.sleep != None:
 464         sleep = options.sleep
 465     else:
 466         sleep = config.getint('stgit', 'smtpdelay')
 467
 468     # send the cover message (if any)
 469     if options.cover or options.edit:
 470         # find the template file
 471         if options.cover:
 472             tmpl = file(options.cover).read()
 473         else:
 474             tmpl = templates.get_template('covermail.tmpl')
 475             if not tmpl:
 476                 raise CmdException, 'No cover message template file found'
 477
 478         msg_id = email.Utils.make_msgid('stgit')
 479         msg = __build_cover(tmpl, total_nr, msg_id, options)
 480         from_addr, to_addr_list = __parse_addresses(msg)
 481
 482         # subsequent e-mails are seen as replies to the first one
 483         if not options.noreply:
 484             ref_id = msg_id
 485
 486         if options.mbox:
 487             __write_mbox(from_addr, msg)
 488         else:
 489             print 'Sending the cover message...',
 490             sys.stdout.flush()
 491             __send_message(smtpserver, from_addr, to_addr_list, msg, sleep,
 492                            smtpuser, smtppassword)
 493             print 'done'
 494
 495     # send the patches
 496     if options.template:
 497         tmpl = file(options.template).read()
 498     else:
 499         tmpl = templates.get_template('patchmail.tmpl')
 500         if not tmpl:
 501             raise CmdException, 'No e-mail template file found'
 502
 503     for (p, patch_nr) in zip(patches, range(1, len(patches) + 1)):
 504         msg_id = email.Utils.make_msgid('stgit')
 505         msg = __build_message(tmpl, p, patch_nr, total_nr, msg_id, ref_id,
 506                               options)
 507         from_addr, to_addr_list = __parse_addresses(msg)
 508
 509         # subsequent e-mails are seen as replies to the first one
 510         if not options.noreply and not ref_id:
 511             ref_id = msg_id
 512
 513         if options.mbox:
 514             __write_mbox(from_addr, msg)
 515         else:
 516             print 'Sending patch "%s"...' % p,
 517             sys.stdout.flush()
 518             __send_message(smtpserver, from_addr, to_addr_list, msg, sleep,
 519                            smtpuser, smtppassword)
 520             print 'done'