patchbomb.py
309 lines
| 11.0 KiB
| text/x-python
|
PythonLexer
/ hgext / patchbomb.py
|
r1669 | # Command for sending a collection of Mercurial changesets as a series | ||
# of patch emails. | ||||
# | ||||
# The series is started off with a "[PATCH 0 of N]" introduction, | ||||
# which describes the series as a whole. | ||||
# | ||||
# Each patch email has a Subject line of "[PATCH M of N] ...", using | ||||
# the first line of the changeset description as the subject text. | ||||
# The message contains two or three body parts: | ||||
# | ||||
# The remainder of the changeset description. | ||||
# | ||||
# [Optional] If the diffstat program is installed, the result of | ||||
# running diffstat on the patch. | ||||
# | ||||
# The patch itself, as generated by "hg export". | ||||
# | ||||
# Each message refers to all of its predecessors using the In-Reply-To | ||||
# and References headers, so they will show up as a sequence in | ||||
# threaded mail and news readers, and in mail archives. | ||||
# | ||||
# For each changeset, you will be prompted with a diffstat summary and | ||||
# the changeset summary, so you can be sure you are sending the right | ||||
# changes. | ||||
# | ||||
|
r2926 | # To enable this extension: | ||
|
r1669 | # | ||
|
r2926 | # [extensions] | ||
# hgext.patchbomb = | ||||
|
r1702 | # | ||
|
r1669 | # To configure other defaults, add a section like this to your hgrc | ||
# file: | ||||
# | ||||
|
r2926 | # [email] | ||
# from = My Name <my@email> | ||||
# to = recipient1, recipient2, ... | ||||
# cc = cc1, cc2, ... | ||||
# bcc = bcc1, bcc2, ... | ||||
# | ||||
# Then you can use the "hg email" command to mail a series of changesets | ||||
# as a patchbomb. | ||||
# | ||||
# To avoid sending patches prematurely, it is a good idea to first run | ||||
# the "email" command with the "-n" option (test only). You will be | ||||
# prompted for an email recipient address, a subject an an introductory | ||||
# message describing the patches of your patchbomb. Then when all is | ||||
# done, your pager will be fired up once for each patchbomb message, so | ||||
# you can verify everything is alright. | ||||
# | ||||
# The "-m" (mbox) option is also very useful. Instead of previewing | ||||
# each patchbomb message in a pager or sending the messages directly, | ||||
# it will create a UNIX mailbox file with the patch emails. This | ||||
# mailbox file can be previewed with any mail user agent which supports | ||||
# UNIX mbox files, i.e. with mutt: | ||||
# | ||||
# % mutt -R -f mbox | ||||
# | ||||
# When you are previewing the patchbomb messages, you can use `formail' | ||||
# (a utility that is commonly installed as part of the procmail package), | ||||
# to send each message out: | ||||
# | ||||
# % formail -s sendmail -bm -t < mbox | ||||
# | ||||
# That should be all. Now your patchbomb is on its way out. | ||||
|
r1669 | |||
|
r3877 | import os, errno, popen2, socket, sys, tempfile, time | ||
import email.MIMEMultipart, email.MIMEText, email.Utils | ||||
from mercurial import cmdutil, commands, hg, mail, ui, patch | ||||
|
r3891 | from mercurial.i18n import _ | ||
|
r2708 | from mercurial.node import * | ||
|
r1669 | |||
try: | ||||
# readline gives raw_input editing capabilities, but is not | ||||
# present on windows | ||||
import readline | ||||
except ImportError: pass | ||||
def patchbomb(ui, repo, *revs, **opts): | ||||
|
r1672 | '''send changesets as a series of patch emails | ||
The series starts with a "[PATCH 0 of N]" introduction, which | ||||
describes the series as a whole. | ||||
Each patch email has a Subject line of "[PATCH M of N] ...", using | ||||
the first line of the changeset description as the subject text. | ||||
The message contains two or three body parts. First, the rest of | ||||
the changeset description. Next, (optionally) if the diffstat | ||||
program is installed, the result of running diffstat on the patch. | ||||
Finally, the patch itself, as generated by "hg export".''' | ||||
|
r1669 | def prompt(prompt, default = None, rest = ': ', empty_ok = False): | ||
if default: prompt += ' [%s]' % default | ||||
prompt += rest | ||||
while True: | ||||
r = raw_input(prompt) | ||||
if r: return r | ||||
if default is not None: return default | ||||
if empty_ok: return r | ||||
|
r1670 | ui.warn(_('Please enter a valid value.\n')) | ||
|
r1669 | |||
def confirm(s): | ||||
if not prompt(s, default = 'y', rest = '? ').lower().startswith('y'): | ||||
raise ValueError | ||||
|
r3096 | def cdiffstat(summary, patchlines): | ||
s = patch.diffstat(patchlines) | ||||
|
r1669 | if s: | ||
if summary: | ||||
ui.write(summary, '\n') | ||||
ui.write(s, '\n') | ||||
|
r1670 | confirm(_('Does the diffstat above look okay')) | ||
|
r1669 | return s | ||
def makepatch(patch, idx, total): | ||||
desc = [] | ||||
node = None | ||||
body = '' | ||||
for line in patch: | ||||
if line.startswith('#'): | ||||
if line.startswith('# Node ID'): node = line.split()[-1] | ||||
continue | ||||
|
r3054 | if (line.startswith('diff -r') | ||
or line.startswith('diff --git')): | ||||
break | ||||
|
r1669 | desc.append(line) | ||
if not node: raise ValueError | ||||
#body = ('\n'.join(desc[1:]).strip() or | ||||
# 'Patch subject is complete summary.') | ||||
#body += '\n\n\n' | ||||
if opts['plain']: | ||||
while patch and patch[0].startswith('# '): patch.pop(0) | ||||
if patch: patch.pop(0) | ||||
while patch and not patch[0].strip(): patch.pop(0) | ||||
if opts['diffstat']: | ||||
body += cdiffstat('\n'.join(desc), patch) + '\n\n' | ||||
|
r2707 | if opts['attach']: | ||
msg = email.MIMEMultipart.MIMEMultipart() | ||||
if body: msg.attach(email.MIMEText.MIMEText(body, 'plain')) | ||||
|
r2708 | p = email.MIMEText.MIMEText('\n'.join(patch), 'x-patch') | ||
|
r2722 | binnode = bin(node) | ||
|
r2708 | # if node is mq patch, it will have patch file name as tag | ||
|
r2722 | patchname = [t for t in repo.nodetags(binnode) | ||
|
r2708 | if t.endswith('.patch') or t.endswith('.diff')] | ||
if patchname: | ||||
patchname = patchname[0] | ||||
elif total > 1: | ||||
|
r3253 | patchname = cmdutil.make_filename(repo, '%b-%n.patch', | ||
|
r2722 | binnode, idx, total) | ||
|
r2708 | else: | ||
|
r3253 | patchname = cmdutil.make_filename(repo, '%b.patch', binnode) | ||
|
r2708 | p['Content-Disposition'] = 'inline; filename=' + patchname | ||
msg.attach(p) | ||||
|
r2707 | else: | ||
body += '\n'.join(patch) | ||||
msg = email.MIMEText.MIMEText(body) | ||||
|
r1846 | if total == 1: | ||
subj = '[PATCH] ' + desc[0].strip() | ||||
else: | ||||
|
r3291 | tlen = len(str(total)) | ||
subj = '[PATCH %0*d of %d] %s' % (tlen, idx, total, desc[0].strip()) | ||||
|
r1669 | if subj.endswith('.'): subj = subj[:-1] | ||
msg['Subject'] = subj | ||||
msg['X-Mercurial-Node'] = node | ||||
return msg | ||||
start_time = int(time.time()) | ||||
def genmsgid(id): | ||||
return '<%s.%s@%s>' % (id[:20], start_time, socket.getfqdn()) | ||||
patches = [] | ||||
class exportee: | ||||
def __init__(self, container): | ||||
self.lines = [] | ||||
self.container = container | ||||
self.name = 'email' | ||||
def write(self, data): | ||||
self.lines.append(data) | ||||
def close(self): | ||||
self.container.append(''.join(self.lines).split('\n')) | ||||
self.lines = [] | ||||
commands.export(ui, repo, *revs, **{'output': exportee(patches), | ||||
'switch_parent': False, | ||||
|
r3030 | 'text': None, | ||
'git': opts.get('git')}) | ||||
|
r1669 | |||
jumbo = [] | ||||
msgs = [] | ||||
|
r1670 | ui.write(_('This patch series consists of %d patches.\n\n') % len(patches)) | ||
|
r1669 | |||
|
r3473 | for p, i in zip(patches, xrange(len(patches))): | ||
|
r1669 | jumbo.extend(p) | ||
msgs.append(makepatch(p, i + 1, len(patches))) | ||||
|
r2198 | sender = (opts['from'] or ui.config('email', 'from') or | ||
ui.config('patchbomb', 'from') or | ||||
|
r1669 | prompt('From', ui.username())) | ||
def getaddrs(opt, prpt, default = None): | ||||
|
r2198 | addrs = opts[opt] or (ui.config('email', opt) or | ||
ui.config('patchbomb', opt) or | ||||
|
r1669 | prompt(prpt, default = default)).split(',') | ||
return [a.strip() for a in addrs if a.strip()] | ||||
to = getaddrs('to', 'To') | ||||
cc = getaddrs('cc', 'Cc', '') | ||||
|
r2679 | bcc = opts['bcc'] or (ui.config('email', 'bcc') or | ||
ui.config('patchbomb', 'bcc') or '').split(',') | ||||
bcc = [a.strip() for a in bcc if a.strip()] | ||||
|
r1845 | if len(patches) > 1: | ||
|
r3291 | tlen = len(str(len(patches))) | ||
subj = '[PATCH %0*d of %d] %s' % ( | ||||
tlen, 0, | ||||
|
r1845 | len(patches), | ||
opts['subject'] or | ||||
|
r3291 | prompt('Subject:', rest = ' [PATCH %0*d of %d] ' % (tlen, 0, | ||
len(patches)))) | ||||
|
r1845 | |||
|
r3879 | body = '' | ||
|
r1845 | if opts['diffstat']: | ||
d = cdiffstat(_('Final summary:\n'), jumbo) | ||||
|
r3879 | if d: body = '\n' + d | ||
|
r2704 | |||
|
r3879 | ui.write(_('\nWrite the introductory message for the patch series.\n\n')) | ||
body = ui.edit(body, sender) | ||||
|
r2704 | |||
msg = email.MIMEText.MIMEText(body) | ||||
msg['Subject'] = subj | ||||
|
r1845 | |||
msgs.insert(0, msg) | ||||
|
r1669 | |||
ui.write('\n') | ||||
|
r1702 | if not opts['test'] and not opts['mbox']: | ||
|
r2889 | mailer = mail.connect(ui) | ||
|
r1669 | parent = None | ||
|
r2443 | |||
# Calculate UTC offset | ||||
if time.daylight: offset = time.altzone | ||||
else: offset = time.timezone | ||||
if offset <= 0: sign, offset = '+', -offset | ||||
else: sign = '-' | ||||
offset = '%s%02d%02d' % (sign, offset / 3600, (offset % 3600) / 60) | ||||
|
r1827 | sender_addr = email.Utils.parseaddr(sender)[1] | ||
|
r1669 | for m in msgs: | ||
try: | ||||
m['Message-Id'] = genmsgid(m['X-Mercurial-Node']) | ||||
except TypeError: | ||||
m['Message-Id'] = genmsgid('patchbomb') | ||||
if parent: | ||||
m['In-Reply-To'] = parent | ||||
else: | ||||
parent = m['Message-Id'] | ||||
|
r2443 | m['Date'] = time.strftime("%a, %d %b %Y %H:%M:%S", time.localtime(start_time)) + ' ' + offset | ||
|
r1669 | start_time += 1 | ||
m['From'] = sender | ||||
m['To'] = ', '.join(to) | ||||
|
r2679 | if cc: m['Cc'] = ', '.join(cc) | ||
if bcc: m['Bcc'] = ', '.join(bcc) | ||||
|
r1669 | if opts['test']: | ||
|
r1702 | ui.status('Displaying ', m['Subject'], ' ...\n') | ||
|
r1669 | fp = os.popen(os.getenv('PAGER', 'more'), 'w') | ||
|
r1871 | try: | ||
fp.write(m.as_string(0)) | ||||
fp.write('\n') | ||||
except IOError, inst: | ||||
if inst.errno != errno.EPIPE: | ||||
raise | ||||
|
r1669 | fp.close() | ||
|
r1702 | elif opts['mbox']: | ||
ui.status('Writing ', m['Subject'], ' ...\n') | ||||
fp = open(opts['mbox'], m.has_key('In-Reply-To') and 'ab+' or 'wb+') | ||||
date = time.asctime(time.localtime(start_time)) | ||||
fp.write('From %s %s\n' % (sender_addr, date)) | ||||
fp.write(m.as_string(0)) | ||||
fp.write('\n\n') | ||||
fp.close() | ||||
|
r1669 | else: | ||
|
r1702 | ui.status('Sending ', m['Subject'], ' ...\n') | ||
|
r2790 | # Exim does not remove the Bcc field | ||
del m['Bcc'] | ||||
|
r2889 | mailer.sendmail(sender, to + bcc + cc, m.as_string(0)) | ||
|
r1669 | |||
cmdtable = { | ||||
'email': | ||||
(patchbomb, | ||||
|
r2707 | [('a', 'attach', None, 'send patches as inline attachments'), | ||
('', 'bcc', [], 'email addresses of blind copy recipients'), | ||||
|
r2679 | ('c', 'cc', [], 'email addresses of copy recipients'), | ||
|
r1669 | ('d', 'diffstat', None, 'add diffstat output to messages'), | ||
|
r3030 | ('g', 'git', None, _('use git extended diff format')), | ||
|
r1669 | ('f', 'from', '', 'email address of sender'), | ||
('', 'plain', None, 'omit hg patch header'), | ||||
('n', 'test', None, 'print messages that would be sent'), | ||||
|
r1702 | ('m', 'mbox', '', 'write messages to mbox file instead of sending them'), | ||
|
r1669 | ('s', 'subject', '', 'subject of introductory message'), | ||
('t', 'to', [], 'email addresses of recipients')], | ||||
"hg email [OPTION]... [REV]...") | ||||
} | ||||