Refactor message printing
[stgit] / stgit / commands / mail.py
index fe44bc9..1ca6ba2 100644 (file)
@@ -32,10 +32,13 @@ Send a patch or a range of patches 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
-'~/.stgit/templates/patchmail.tmpl' or 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.
+'~/.stgit/templates/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. They can be e-mail
+addresses or aliases which are automatically expanded to the values
+stored in the [mail "alias"] section of GIT configuration files.
 
 A preamble e-mail can be sent using the '--cover' and/or
 '--edit-cover' options. The first allows the user to specify a file to
@@ -117,6 +120,9 @@ options = [make_option('-a', '--all',
                        help = 'username for SMTP authentication'),
            make_option('-b', '--branch',
                        help = 'use BRANCH instead of the default one'),
+           make_option('--binary',
+                       help = 'output a diff even for binary files',
+                       action = 'store_true'),
            make_option('-m', '--mbox',
                        help = 'generate an mbox file instead of sending',
                        action = 'store_true')]
@@ -126,9 +132,8 @@ def __get_sender():
     """Return the 'authname <authemail>' string as read from the
     configuration file
     """
-    if config.has_option('stgit', 'sender'):
-        sender = config.get('stgit', 'sender')
-    else:
+    sender=config.get('stgit.sender')
+    if not sender:
         try:
             sender = str(git.user())
         except git.GitException:
@@ -137,27 +142,21 @@ def __get_sender():
     if not sender:
         raise CmdException, 'unknown sender details'
 
-    return sender
+    return address_or_alias(sender)
 
-def __parse_addresses(addresses):
+def __parse_addresses(msg):
     """Return a two elements tuple: (from, [to])
     """
-    def __addr_list(addrs):
-        m = re.search('[^@\s<,]+@[^>\s,]+', addrs);
-        if (m == None):
-            return []
-        return [ m.group() ] + __addr_list(addrs[m.end():])
-
-    from_addr_list = []
-    to_addr_list = []
-    for line in addresses.split('\n'):
-        if re.match('from:\s+', line, re.I):
-            from_addr_list += __addr_list(line)
-        elif re.match('(to|cc|bcc):\s+', line, re.I):
-            to_addr_list += __addr_list(line)
+    def __addr_list(msg, header):
+        return [name_addr[1] for name_addr in
+                email.Utils.getaddresses(msg.get_all(header, []))]
 
+    from_addr_list = __addr_list(msg, 'From')
     if len(from_addr_list) == 0:
         raise CmdException, 'No "From" address'
+
+    to_addr_list = __addr_list(msg, 'To') + __addr_list(msg, 'Cc') \
+                   + __addr_list(msg, 'Bcc')
     if len(to_addr_list) == 0:
         raise CmdException, 'No "To/Cc/Bcc" addresses'
 
@@ -196,18 +195,15 @@ def __build_address_headers(msg, options, extra_cc = []):
             del msg[header]
 
             if crt_addr:
-                msg[header] = ', '.join([crt_addr, addr])
+                msg[header] = address_or_alias(', '.join([crt_addr, addr]))
             else:
-                msg[header] = addr
+                msg[header] = address_or_alias(addr)
 
     to_addr = ''
     cc_addr = ''
     bcc_addr = ''
 
-    if config.has_option('stgit', 'autobcc'):
-        autobcc = config.get('stgit', 'autobcc')
-    else:
-        autobcc = ''
+    autobcc = config.get('stgit.autobcc') or ''
 
     if options.to:
         to_addr = ', '.join(options.to)
@@ -279,18 +275,7 @@ def __edit_message(msg):
     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)
+    call_editor(fname)
 
     # read the message back
     f = file(fname)
@@ -356,9 +341,7 @@ def __build_cover(tmpl, total_nr, msg_id, options):
     __build_extra_headers(msg, msg_id, options.refid)
     __encode_message(msg)
 
-    msg_string = msg.as_string(options.mbox)
-
-    return msg_string.strip('\n')
+    return msg
 
 def __build_message(tmpl, patch, patch_nr, total_nr, msg_id, ref_id, options):
     """Build the message to be sent via SMTP
@@ -410,7 +393,8 @@ def __build_message(tmpl, patch, patch_nr, total_nr, msg_id, ref_id, options):
                  # for backward template compatibility
                  'endofheaders': '',
                  'diff':         git.diff(rev1 = git_id('%s//bottom' % patch),
-                                          rev2 = git_id('%s//top' % patch)),
+                                          rev2 = git_id('%s//top' % patch),
+                                          binary = options.binary),
                  'diffstat':     git.diffstat(rev1 = git_id('%s//bottom'%patch),
                                               rev2 = git_id('%s//top' % patch)),
                  # for backward template compatibility
@@ -458,22 +442,13 @@ def __build_message(tmpl, patch, patch_nr, total_nr, msg_id, ref_id, options):
     __build_extra_headers(msg, msg_id, ref_id)
     __encode_message(msg)
 
-    msg_string = msg.as_string(options.mbox)
-
-    return msg_string.strip('\n')
+    return msg
 
 def func(parser, options, args):
     """Send the patches by e-mail using the patchmail.tmpl file as
     a template
     """
-    smtpserver = config.get('stgit', 'smtpserver')
-
-    smtpuser = None
-    smtppassword = None
-    if config.has_option('stgit', 'smtpuser'):
-        smtpuser = config.get('stgit', 'smtpuser')
-    if config.has_option('stgit', 'smtppassword'):
-        smtppassword = config.get('stgit', 'smtppassword')
+    smtpserver = config.get('stgit.smtpserver')
 
     applied = crt_series.get_applied()
 
@@ -485,11 +460,8 @@ def func(parser, options, args):
     else:
         raise CmdException, 'Incorrect options. Unknown patches to send'
 
-    if options.smtp_password:
-        smtppassword = options.smtp_password
-
-    if options.smtp_user:
-        smtpuser = options.smtp_user
+    smtppassword = options.smtp_password or config.get('stgit.smtppassword')
+    smtpuser = options.smtp_user or config.get('stgit.smtpuser')
 
     if (smtppassword and not smtpuser):
         raise CmdException, 'SMTP password supplied, username needed'
@@ -505,10 +477,7 @@ def func(parser, options, args):
     else:
         ref_id = options.refid
 
-    if options.sleep != None:
-        sleep = options.sleep
-    else:
-        sleep = config.getint('stgit', 'smtpdelay')
+    sleep = options.sleep or config.getint('stgit.smtpdelay')
 
     # send the cover message (if any)
     if options.cover or options.edit_cover:
@@ -524,19 +493,19 @@ def func(parser, options, args):
         msg = __build_cover(tmpl, total_nr, msg_id, options)
         from_addr, to_addr_list = __parse_addresses(msg)
 
+        msg_string = msg.as_string(options.mbox)
+
         # subsequent e-mails are seen as replies to the first one
         if not options.noreply:
             ref_id = msg_id
 
         if options.mbox:
-            print msg
-            print
+            out.stdout_raw(msg_string + '\n')
         else:
-            print 'Sending the cover message...',
-            sys.stdout.flush()
-            __send_message(smtpserver, from_addr, to_addr_list, msg, sleep,
-                           smtpuser, smtppassword)
-            print 'done'
+            out.start('Sending the cover message')
+            __send_message(smtpserver, from_addr, to_addr_list, msg_string,
+                           sleep, smtpuser, smtppassword)
+            out.done()
 
     # send the patches
     if options.template:
@@ -552,16 +521,16 @@ def func(parser, options, args):
                               options)
         from_addr, to_addr_list = __parse_addresses(msg)
 
+        msg_string = msg.as_string(options.mbox)
+
         # subsequent e-mails are seen as replies to the first one
         if not options.noreply and not ref_id:
             ref_id = msg_id
 
         if options.mbox:
-            print msg
-            print
+            out.stdout_raw(msg_string + '\n')
         else:
-            print 'Sending patch "%s"...' % p,
-            sys.stdout.flush()
-            __send_message(smtpserver, from_addr, to_addr_list, msg, sleep,
-                           smtpuser, smtppassword)
-            print 'done'
+            out.start('Sending patch "%s"' % p)
+            __send_message(smtpserver, from_addr, to_addr_list, msg_string,
+                           sleep, smtpuser, smtppassword)
+            out.done()