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