X-Git-Url: https://git.distorted.org.uk/~mdw/stgit/blobdiff_plain/26aab5b04fa4ba13f48948de73e497cf0a315ad1..93aa248c1f7d093c77959a70942e1ae6208750c8:/stgit/commands/mail.py

diff --git a/stgit/commands/mail.py b/stgit/commands/mail.py
index 0b3159b..6a7d5d2 100644
--- a/stgit/commands/mail.py
+++ b/stgit/commands/mail.py
@@ -26,14 +26,21 @@ from stgit.config import config
 
 
 help = 'send a patch or series of patches by e-mail'
-usage = """%prog [options] [<patch>]
+usage = """%prog [options] [<patch> [<patch2...]]
 
 Send a patch or a range of patches (defaulting to the applied patches)
-by e-mail using the 'smtpserver' configuration option. The From/To/Cc
-addresses and the e-mail format are generated from the template file
-passed as argument to '--template' (defaulting to
-.git/patchmail.tmpl). A preamble e-mail can also be sent using the
-'--first' option (no default template).
+by e-mail using the 'smtpserver' configuration option. The From
+address and the e-mail format are generated from the template file
+passed as argument to '--template' (defaulting to .git/patchmail.tmpl
+or /usr/share/stgit/templates/patchmail.tmpl). The To/Cc/Bcc addresses
+can either be added to the template file or passed via the
+corresponding command line options.
+
+A preamble e-mail can be sent using the '--cover' and/or '--edit'
+options. The first allows the user to specify a file to be used as a
+template. The latter option will invoke the editor on the specified
+file (defaulting to .git/covermail.tmpl or
+/usr/share/stgit/templates/covermail.tmpl).
 
 All the subsequent e-mails appear as replies to the first e-mail sent
 (either the preamble or the first patch). E-mails can be seen as
@@ -49,22 +56,26 @@ additional headers and a blank line. The patch e-mail template accepts
 the following variables:
 
   %(patch)s        - patch name
+  %(maintainer)s   - 'authname <authemail>' as read from the config file
   %(shortdescr)s   - the first line of the patch description
   %(longdescr)s    - the rest of the patch description, after the first line
   %(endofheaders)s - delimiter between e-mail headers and body
   %(diff)s         - unified diff of the patch
   %(diffstat)s     - diff statistics
   %(date)s         - current date/time
+  %(version)s      - ' version' string passed on the command line (or empty)
   %(patchnr)s      - patch number
   %(totalnr)s      - total number of patches to be sent
+  %(number)s       - empty if only one patch is sent or ' patchnr/totalnr'
   %(authname)s     - author's name
   %(authemail)s    - author's email
   %(authdate)s     - patch creation date
   %(commname)s     - committer's name
   %(commemail)s    - committer's e-mail
 
-For the preamble e-mail template, only the %(date)s, %(endofheaders)s
-and %(totalnr)s variables are supported."""
+For the preamble e-mail template, only the %(maintainer)s, %(date)s,
+%(endofheaders)s, %(version)s, %(patchnr)s, %(totalnr)s and %(number)s
+variables are supported."""
 
 options = [make_option('-a', '--all',
                        help = 'e-mail all the applied patches',
@@ -72,25 +83,55 @@ options = [make_option('-a', '--all',
            make_option('-r', '--range',
                        metavar = '[PATCH1][:[PATCH2]]',
                        help = 'e-mail patches between PATCH1 and PATCH2'),
+           make_option('--to',
+                       help = 'add TO to the To: list',
+                       action = 'append'),
+           make_option('--cc',
+                       help = 'add CC to the Cc: list',
+                       action = 'append'),
+           make_option('--bcc',
+                       help = 'add BCC to the Bcc: list',
+                       action = 'append'),
+           make_option('-v', '--version', metavar = 'VERSION',
+                       help = 'add VERSION to the [PATCH ...] prefix'),
            make_option('-t', '--template', metavar = 'FILE',
                        help = 'use FILE as the message template'),
-           make_option('-f', '--first', metavar = 'FILE',
-                       help = 'send FILE as the first message'),
+           make_option('-c', '--cover', metavar = 'FILE',
+                       help = 'send FILE as the cover message'),
+           make_option('-e', '--edit',
+                       help = 'edit the cover message before sending',
+                       action = 'store_true'),
            make_option('-s', '--sleep', type = 'int', metavar = 'SECONDS',
                        help = 'sleep for SECONDS between e-mails sending'),
            make_option('--refid',
-                       help = 'Use REFID as the reference id'),
+                       help = 'use REFID as the reference id'),
            make_option('-u', '--smtp-user', metavar = 'USER',
                        help = 'username for SMTP authentication'),
            make_option('-p', '--smtp-password', metavar = 'PASSWORD',
-                       help = 'username for SMTP authentication')]
+                       help = 'username for SMTP authentication'),
+           make_option('-b', '--branch',
+                       help = 'use BRANCH instead of the default one')]
+
 
+def __get_maintainer():
+    """Return the 'authname <authemail>' string as read from the
+    configuration file
+    """
+    if config.has_option('stgit', 'authname') \
+           and config.has_option('stgit', 'authemail'):
+        return '%s <%s>' % (config.get('stgit', 'authname'),
+                            config.get('stgit', 'authemail'))
+    else:
+        return None
 
 def __parse_addresses(string):
     """Return a two elements tuple: (from, [to])
     """
     def __addr_list(string):
-        return re.split('.*?([\w\.]+@[\w\.]+)', string)[1:-1:2]
+        m = re.search('[^@\s<,]+@[^>\s,]+', string);
+        if (m == None):
+            return []
+        return [ m.group() ] + __addr_list(string[m.end():])
 
     from_addr_list = []
     to_addr_list = []
@@ -100,7 +141,7 @@ def __parse_addresses(string):
         elif re.match('(to|cc|bcc):\s+', line, re.I):
             to_addr_list += __addr_list(line)
 
-    if len(from_addr_list) != 1:
+    if len(from_addr_list) == 0:
         raise CmdException, 'No "From" address'
     if len(to_addr_list) == 0:
         raise CmdException, 'No "To/Cc/Bcc" addresses'
@@ -130,15 +171,54 @@ def __send_message(smtpserver, from_addr, to_addr_list, msg, sleep,
 
     s.quit()
 
-def __build_first(tmpl, total_nr, msg_id):
-    """Build the first message (series description) to be sent via SMTP
+def __build_address_headers(options):
+    headers_end = ''
+    if options.to:
+        headers_end += 'To: '
+        for to in options.to:
+            headers_end += '%s, ' % to
+        headers_end = headers_end[:-2] + '\n'
+    if options.cc:
+        headers_end += 'Cc: '
+        for cc in options.cc:
+            headers_end += '%s, ' % cc
+        headers_end = headers_end[:-2] + '\n'
+    if options.bcc:
+        headers_end += 'Bcc: '
+        for bcc in options.bcc:
+            headers_end += '%s, ' % bcc
+        headers_end = headers_end[:-2] + '\n'
+    return headers_end
+
+def __build_cover(tmpl, total_nr, msg_id, options):
+    """Build the cover message (series description) to be sent via SMTP
     """
-    headers_end = 'Message-Id: %s\n' % (msg_id)
+    maintainer = __get_maintainer()
+    if not maintainer:
+        maintainer = ''
+
+    headers_end = __build_address_headers(options)
+    headers_end += 'Message-Id: %s\n' % msg_id
+
+    if options.version:
+        version_str = ' %s' % options.version
+    else:
+        version_str = ''
+
     total_nr_str = str(total_nr)
+    patch_nr_str = '0'.zfill(len(total_nr_str))
+    if total_nr > 1:
+        number_str = ' %s/%s' % (patch_nr_str, total_nr_str)
+    else:
+        number_str = ''
 
-    tmpl_dict = {'endofheaders': headers_end,
+    tmpl_dict = {'maintainer':   maintainer,
+                 'endofheaders': headers_end,
                  'date':         email.Utils.formatdate(localtime = True),
-                 'totalnr':      total_nr_str}
+                 'version':      version_str,
+                 'patchnr':      patch_nr_str,
+                 'totalnr':      total_nr_str,
+                 'number':       number_str}
 
     try:
         msg = tmpl % tmpl_dict
@@ -149,10 +229,35 @@ def __build_first(tmpl, total_nr, msg_id):
         raise CmdException, 'Only "%(name)s" variables are ' \
               'supported in the patch template'
 
-    return msg
+    if options.edit:
+        fname = '.stgitmail.txt'
+
+        # create the initial file
+        f = file(fname, 'w+')
+        f.write(msg)
+        f.close()
+
+        # the editor
+        if config.has_option('stgit', 'editor'):
+            editor = config.get('stgit', 'editor')
+        elif 'EDITOR' in os.environ:
+            editor = os.environ['EDITOR']
+        else:
+            editor = 'vi'
+        editor += ' %s' % fname
 
+        print 'Invoking the editor: "%s"...' % editor,
+        sys.stdout.flush()
+        print 'done (exit code: %d)' % os.system(editor)
+
+        # read the message back
+        f = file(fname)
+        msg = f.read()
+        f.close()
 
-def __build_message(tmpl, patch, patch_nr, total_nr, msg_id, ref_id = None):
+    return msg
+
+def __build_message(tmpl, patch, patch_nr, total_nr, msg_id, ref_id, options):
     """Build the message to be sent via SMTP
     """
     p = crt_series.get_patch(patch)
@@ -164,15 +269,30 @@ def __build_message(tmpl, patch, patch_nr, total_nr, msg_id, ref_id = None):
     long_descr = reduce(lambda x, y: x + '\n' + y,
                         descr_lines[1:], '').lstrip()
 
-    headers_end = 'Message-Id: %s\n' % (msg_id)
+    maintainer = __get_maintainer()
+    if not maintainer:
+        maintainer = '%s <%s>' % (p.get_commname(), p.get_commemail())
+
+    headers_end = __build_address_headers(options)
+    headers_end += 'Message-Id: %s\n' % msg_id
     if ref_id:
-        headers_end += "In-Reply-To: %s\n" % (ref_id)
-        headers_end += "References: %s\n" % (ref_id)
+        headers_end += "In-Reply-To: %s\n" % ref_id
+        headers_end += "References: %s\n" % ref_id
+
+    if options.version:
+        version_str = ' %s' % options.version
+    else:
+        version_str = ''
 
     total_nr_str = str(total_nr)
     patch_nr_str = str(patch_nr).zfill(len(total_nr_str))
+    if total_nr > 1:
+        number_str = ' %s/%s' % (patch_nr_str, total_nr_str)
+    else:
+        number_str = ''
 
     tmpl_dict = {'patch':        patch,
+                 'maintainer':   maintainer,
                  'shortdescr':   short_descr,
                  'longdescr':    long_descr,
                  'endofheaders': headers_end,
@@ -181,8 +301,10 @@ def __build_message(tmpl, patch, patch_nr, total_nr, msg_id, ref_id = None):
                  'diffstat':     git.diffstat(rev1 = git_id('%s/bottom'%patch),
                                               rev2 = git_id('%s/top' % patch)),
                  'date':         email.Utils.formatdate(localtime = True),
+                 'version':      version_str,
                  'patchnr':      patch_nr_str,
                  'totalnr':      total_nr_str,
+                 'number':       number_str,
                  'authname':     p.get_authname(),
                  'authemail':    p.get_authemail(),
                  'authdate':     p.get_authdate(),
@@ -203,14 +325,10 @@ def __build_message(tmpl, patch, patch_nr, total_nr, msg_id, ref_id = None):
 
     return msg
 
-
 def func(parser, options, args):
     """Send the patches by e-mail using the patchmail.tmpl file as
     a template
     """
-    if len(args) > 1:
-        parser.error('incorrect number of arguments')
-
     if not config.has_option('stgit', 'smtpserver'):
         raise CmdException, 'smtpserver not defined'
     smtpserver = config.get('stgit', 'smtpserver')
@@ -223,12 +341,15 @@ def func(parser, options, args):
         smtppassword = config.get('stgit', 'smtppassword')
 
     applied = crt_series.get_applied()
-
-    if len(args) == 1:
-        if args[0] in applied:
-            patches = [args[0]]
-        else:
-            raise CmdException, 'Patch "%s" not applied' % args[0]
+    unapplied = crt_series.get_unapplied()
+
+    if len(args) >= 1:
+        for patch in args:
+            if patch in unapplied:
+                raise CmdException, 'Patch "%s" not applied' % patch
+            if not patch in applied:
+                raise CmdException, 'Patch "%s" does not exist' % patch
+        patches = args
     elif options.all:
         patches = applied
     elif options.range:
@@ -251,11 +372,17 @@ def func(parser, options, args):
         if start in applied:
             start_idx = applied.index(start)
         else:
-            raise CmdException, 'Patch "%s" not applied' % start
+            if start in unapplied:
+                raise CmdException, 'Patch "%s" not applied' % start
+            else:
+                raise CmdException, 'Patch "%s" does not exist' % start
         if stop in applied:
             stop_idx = applied.index(stop) + 1
         else:
-            raise CmdException, 'Patch "%s" not applied' % stop
+            if stop in unapplied:
+                raise CmdException, 'Patch "%s" not applied' % stop
+            else:
+                raise CmdException, 'Patch "%s" does not exist' % stop
 
         if start_idx >= stop_idx:
             raise CmdException, 'Incorrect patch range order'
@@ -286,18 +413,32 @@ def func(parser, options, args):
     else:
         sleep = 2
 
-    # send the first message (if any)
-    if options.first:
-        tmpl = file(options.first).read()
-        from_addr, to_addr_list = __parse_addresses(tmpl)
+    # send the cover message (if any)
+    if options.cover or options.edit:
+        # find the template file
+        if options.cover:
+            tfile_list = [options.cover]
+        else:
+            tfile_list = [os.path.join(git.base_dir, 'covermail.tmpl'),
+                          os.path.join(sys.prefix,
+                                       'share/stgit/templates/covermail.tmpl')]
+
+        tmpl = None
+        for tfile in tfile_list:
+            if os.path.isfile(tfile):
+                tmpl = file(tfile).read()
+                break
+        if not tmpl:
+            raise CmdException, 'No cover message template file found'
 
         msg_id = email.Utils.make_msgid('stgit')
-        msg = __build_first(tmpl, total_nr, msg_id)
+        msg = __build_cover(tmpl, total_nr, msg_id, options)
+        from_addr, to_addr_list = __parse_addresses(msg)
 
         # subsequent e-mails are seen as replies to the first one
         ref_id = msg_id
 
-        print 'Sending file "%s"...' % options.first,
+        print 'Sending the cover message...',
         sys.stdout.flush()
 
         __send_message(smtpserver, from_addr, to_addr_list, msg, sleep,
@@ -307,16 +448,25 @@ def func(parser, options, args):
 
     # send the patches
     if options.template:
-        tfile = options.template
+        tfile_list = [options.template]
     else:
-        tfile = os.path.join(git.base_dir, 'patchmail.tmpl')
-    tmpl = file(tfile).read()
-
-    from_addr, to_addr_list = __parse_addresses(tmpl)
+        tfile_list = [os.path.join(git.base_dir, 'patchmail.tmpl'),
+                      os.path.join(sys.prefix,
+                                   'share/stgit/templates/patchmail.tmpl')]
+    tmpl = None
+    for tfile in tfile_list:
+        if os.path.isfile(tfile):
+            tmpl = file(tfile).read()
+            break
+    if not tmpl:
+        raise CmdException, 'No e-mail template file found'
 
     for (p, patch_nr) in zip(patches, range(1, len(patches) + 1)):
         msg_id = email.Utils.make_msgid('stgit')
-        msg = __build_message(tmpl, p, patch_nr, total_nr, msg_id, ref_id)
+        msg = __build_message(tmpl, p, patch_nr, total_nr, msg_id, ref_id,
+                              options)
+        from_addr, to_addr_list = __parse_addresses(msg)
+
         # subsequent e-mails are seen as replies to the first one
         if not ref_id:
             ref_id = msg_id