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