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, version, templates
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():
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
"""
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
'shortdescr': short_descr,
'longdescr': long_descr,
'endofheaders': headers_end,
- 'diff': git.diff(rev1 = git_id('%s/bottom' % patch),
- rev2 = git_id('%s/top' % patch)),
- 'diffstat': git.diffstat(rev1 = git_id('%s/bottom'%patch),
- rev2 = git_id('%s/top' % patch)),
+ 'diff': git.diff(rev1 = git_id('%s//bottom' % patch),
+ rev2 = git_id('%s//top' % patch)),
+ '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,
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:
# find the template file
if options.cover:
- tfile_list = [options.cover]
+ tmpl = file(options.template).read()
else:
- tfile_list = [os.path.join(git.get_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'
+ tmpl = templates.get_template('covermail.tmpl')
+ if not tmpl:
+ raise CmdException, 'No cover message template file found'
msg_id = email.Utils.make_msgid('stgit')
msg = __build_cover(tmpl, total_nr, msg_id, options)
# 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]
+ tmpl = file(options.template).read()
else:
- tfile_list = [os.path.join(git.get_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'
+ tmpl = templates.get_template('patchmail.tmpl')
+ 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')
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