Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
"""
-import sys, os, re, time, smtplib, email.Utils
+import sys, os, re, time, datetime, smtplib, email.Utils
from optparse import OptionParser, make_option
-from time import gmtime, strftime
from stgit.commands.common import *
from stgit.utils import *
-from stgit import stack, git
+from stgit import stack, git, basedir, version
from stgit.config import config
Send a patch or a range of patches (defaulting to the applied 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 /usr/share/stgit/templates/patchmail.tmpl). The To/Cc/Bcc addresses
+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.
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).
+file (defaulting to '.git/covermail.tmpl' or
+'~/.stgit/templates/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
make_option('-p', '--smtp-password', metavar = 'PASSWORD',
help = 'username for SMTP authentication'),
make_option('-b', '--branch',
- help = 'use BRANCH instead of the default one')]
+ help = 'use BRANCH instead of the default one'),
+ make_option('-m', '--mbox',
+ help = 'generate an mbox file instead of sending',
+ action = 'store_true')]
def __get_maintainer():
else:
return None
-def __parse_addresses(string):
+def __parse_addresses(addresses):
"""Return a two elements tuple: (from, [to])
"""
- def __addr_list(string):
- m = re.search('[^@\s<,]+@[^>\s,]+', string);
+ def __addr_list(addrs):
+ m = re.search('[^@\s<,]+@[^>\s,]+', addrs);
if (m == None):
return []
- return [ m.group() ] + __addr_list(string[m.end():])
+ return [ m.group() ] + __addr_list(addrs[m.end():])
from_addr_list = []
to_addr_list = []
- for line in string.split('\n'):
+ 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):
s.quit()
+def __write_mbox(from_addr, msg):
+ """Write an mbox like file to the standard output
+ """
+ r = re.compile('^From ', re.M)
+ msg = r.sub('>\g<0>', msg)
+
+ print 'From %s %s' % (from_addr, datetime.datetime.today().ctime())
+ print msg
+ print
+
def __build_address_headers(options):
headers_end = ''
if options.to:
headers_end = headers_end[:-2] + '\n'
return headers_end
+def __build_extra_headers():
+ """Build extra headers like content-type etc.
+ """
+ headers = 'Content-Type: text/plain; charset=utf-8; format=fixed\n'
+ headers += 'Content-Transfer-Encoding: 8bit\n'
+ headers += 'User-Agent: StGIT/%s\n' % version.version
+
+ return headers
+
def __build_cover(tmpl, total_nr, msg_id, options):
"""Build the cover message (series description) to be sent via SMTP
"""
headers_end = __build_address_headers(options)
headers_end += 'Message-Id: %s\n' % msg_id
+ if options.refid:
+ headers_end += "In-Reply-To: %s\n" % options.refid
+ headers_end += "References: %s\n" % options.refid
+ headers_end += __build_extra_headers()
if options.version:
version_str = ' %s' % options.version
msg = f.read()
f.close()
- return msg
+ return msg.strip('\n')
def __build_message(tmpl, patch, patch_nr, total_nr, msg_id, ref_id, options):
"""Build the message to be sent via SMTP
if ref_id:
headers_end += "In-Reply-To: %s\n" % ref_id
headers_end += "References: %s\n" % ref_id
+ headers_end += __build_extra_headers()
if options.version:
version_str = ' %s' % options.version
raise CmdException, 'Only "%(name)s" variables are ' \
'supported in the patch template'
- return msg
+ return msg.strip('\n')
def func(parser, options, args):
"""Send the patches by e-mail using the patchmail.tmpl file as
a template
"""
- if not config.has_option('stgit', 'smtpserver'):
- raise CmdException, 'smtpserver not defined'
smtpserver = config.get('stgit', 'smtpserver')
smtpuser = None
if options.sleep != None:
sleep = options.sleep
else:
- sleep = 2
+ sleep = config.getint('stgit', 'smtpdelay')
# send the cover message (if any)
if options.cover or options.edit:
if options.cover:
tfile_list = [options.cover]
else:
- tfile_list = [os.path.join(git.base_dir, 'covermail.tmpl'),
+ tfile_list = [os.path.join(basedir.get(), 'covermail.tmpl'),
+ os.path.join(os.path.expanduser('~'), '.stgit', 'templates',
+ 'covermail.tmpl'),
os.path.join(sys.prefix,
- 'share/stgit/templates/covermail.tmpl')]
+ 'share', 'stgit', 'templates', 'covermail.tmpl')]
tmpl = None
for tfile in tfile_list:
# subsequent e-mails are seen as replies to the first one
ref_id = msg_id
- print 'Sending the cover message...',
- sys.stdout.flush()
-
- __send_message(smtpserver, from_addr, to_addr_list, msg, sleep,
- smtpuser, smtppassword)
-
- print 'done'
+ if options.mbox:
+ __write_mbox(from_addr, msg)
+ else:
+ print 'Sending the cover message...',
+ sys.stdout.flush()
+ __send_message(smtpserver, from_addr, to_addr_list, msg, sleep,
+ smtpuser, smtppassword)
+ print 'done'
# send the patches
if options.template:
tfile_list = [options.template]
else:
- tfile_list = [os.path.join(git.base_dir, 'patchmail.tmpl'),
+ tfile_list = [os.path.join(basedir.get(), 'patchmail.tmpl'),
+ os.path.join(os.path.expanduser('~'), '.stgit', 'templates',
+ 'patchmail.tmpl'),
os.path.join(sys.prefix,
- 'share/stgit/templates/patchmail.tmpl')]
+ 'share', 'stgit', 'templates', 'patchmail.tmpl')]
tmpl = None
for tfile in tfile_list:
if os.path.isfile(tfile):
if not ref_id:
ref_id = msg_id
- print 'Sending patch "%s"...' % p,
- sys.stdout.flush()
-
- __send_message(smtpserver, from_addr, to_addr_list, msg, sleep,
- smtpuser, smtppassword)
-
- print 'done'
+ if options.mbox:
+ __write_mbox(from_addr, msg)
+ else:
+ print 'Sending patch "%s"...' % p,
+ sys.stdout.flush()
+ __send_message(smtpserver, from_addr, to_addr_list, msg, sleep,
+ smtpuser, smtppassword)
+ print 'done'
~mdw / stgit / blobdiff