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
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',
metavar = '[PATCH1][:[PATCH2]]',
help = 'e-mail patches between PATCH1 and PATCH2'),
make_option('--to',
- help = 'Add TO to the To: list'),
+ help = 'add TO to the To: list'),
make_option('--cc',
- help = 'Add CC to the Cc: list'),
+ help = 'add CC to the Cc: list'),
make_option('--bcc',
- help = 'Add BCC to the Bcc: list'),
+ help = 'add BCC to the Bcc: list'),
+ 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',
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])
"""
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'
def __build_first(tmpl, total_nr, msg_id, options):
"""Build the first message (series description) to be sent via SMTP
"""
+ maintainer = __get_maintainer()
+ if not maintainer:
+ maintainer = ''
+
headers_end = ''
if options.to:
headers_end += 'To: %s\n' % options.to
headers_end += 'Bcc: %s\n' % options.bcc
headers_end += 'Message-Id: %s\n' % msg_id
+ if options.version:
+ version_str = ' %s' % options.version
+
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
return msg
-
def __build_message(tmpl, patch, patch_nr, total_nr, msg_id, ref_id, options):
"""Build the message to be sent via SMTP
"""
long_descr = reduce(lambda x, y: x + '\n' + y,
descr_lines[1:], '').lstrip()
+ maintainer = __get_maintainer()
+ if not maintainer:
+ maintainer = '%s <%s>' % (p.get_commname(), p.get_commemail())
+
headers_end = ''
if options.to:
headers_end += 'To: %s\n' % options.to
headers_end += "In-Reply-To: %s\n" % ref_id
headers_end += "References: %s\n" % ref_id
+ if options.version:
+ version_str = ' %s' % options.version
+
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,
'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(),
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')
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]
+ if len(args) >= 1:
+ for patch in args:
+ if not patch in applied:
+ raise CmdException, 'Patch "%s" not applied' % patch
+ patches = args
elif options.all:
patches = applied
elif options.range:
~mdw / stgit / blobdiff