notify.py
289 lines
| 10.4 KiB
| text/x-python
|
PythonLexer
/ hgext / notify.py
|
r2203 | # notify.py - email notifications for mercurial | ||
# | ||||
# Copyright 2006 Vadim Gelfer <vadim.gelfer@gmail.com> | ||||
# | ||||
|
r8225 | # This software may be used and distributed according to the terms of the | ||
# GNU General Public License version 2, incorporated herein by reference. | ||||
|
r7127 | |||
|
r8935 | '''hooks for sending email notifications at commit/push time | ||
|
r7127 | |||
|
r9104 | Subscriptions can be managed through a hgrc file. Default mode is to print | ||
messages to stdout, for testing and configuring. | ||||
|
r7127 | |||
|
r9104 | To use, configure the notify extension and enable it in hgrc like this: | ||
|
r7127 | |||
[extensions] | ||||
hgext.notify = | ||||
[hooks] | ||||
# one email for each incoming changeset | ||||
incoming.notify = python:hgext.notify.hook | ||||
# batch emails when many changesets incoming at one time | ||||
changegroup.notify = python:hgext.notify.hook | ||||
[notify] | ||||
|
r9104 | # config items go here | ||
|
r7127 | |||
|
r9104 | Required configuration items: | ||
|
r7127 | |||
config = /path/to/file # file containing subscriptions | ||||
|
r9104 | Optional configuration items: | ||
|
r7127 | test = True # print messages to stdout for testing | ||
strip = 3 # number of slashes to strip for url paths | ||||
domain = example.com # domain to use if committer missing domain | ||||
style = ... # style file to use when formatting email | ||||
template = ... # template to use when formatting email | ||||
incoming = ... # template to use when run as incoming hook | ||||
changegroup = ... # template when run as changegroup hook | ||||
maxdiff = 300 # max lines of diffs to include (0=none, -1=all) | ||||
maxsubject = 67 # truncate subject line longer than this | ||||
diffstat = True # add a diffstat before the diff content | ||||
sources = serve # notify if source of incoming changes in this list | ||||
# (serve == ssh or http, push, pull, bundle) | ||||
[email] | ||||
from = user@host.com # email address to send as if none given | ||||
[web] | ||||
baseurl = http://hgserver/... # root of hg web site for browsing commits | ||||
|
r9104 | The notify config file has same format as a regular hgrc file. It has two | ||
sections so you can express subscriptions in whatever way is handier for you. | ||||
|
r7127 | |||
[usersubs] | ||||
# key is subscriber email, value is ","-separated list of glob patterns | ||||
user@host = pattern | ||||
[reposubs] | ||||
# key is glob pattern, value is ","-separated list of subscriber emails | ||||
pattern = user@host | ||||
|
r9104 | Glob patterns are matched against path to repository root. | ||
|
r7127 | |||
|
r9104 | If you like, you can put notify config file in repository that users can push | ||
|
r9068 | changes to, they can manage their own subscriptions. | ||
''' | ||||
|
r2203 | |||
|
r3891 | from mercurial.i18n import _ | ||
|
r3877 | from mercurial import patch, cmdutil, templater, util, mail | ||
import email.Parser, fnmatch, socket, time | ||||
|
r2203 | |||
# template for single changeset can include email headers. | ||||
single_template = ''' | ||||
Subject: changeset in {webroot}: {desc|firstline|strip} | ||||
From: {author} | ||||
changeset {node|short} in {root} | ||||
details: {baseurl}{webroot}?cmd=changeset;node={node|short} | ||||
description: | ||||
\t{desc|tabindent|strip} | ||||
'''.lstrip() | ||||
# template for multiple changesets should not contain email headers, | ||||
# because only first set of headers will be used and result will look | ||||
# strange. | ||||
multiple_template = ''' | ||||
changeset {node|short} in {root} | ||||
details: {baseurl}{webroot}?cmd=changeset;node={node|short} | ||||
summary: {desc|firstline} | ||||
''' | ||||
deftemplates = { | ||||
'changegroup': multiple_template, | ||||
|
r4498 | } | ||
|
r2201 | |||
class notifier(object): | ||||
|
r2203 | '''email notification class.''' | ||
def __init__(self, ui, repo, hooktype): | ||||
|
r2201 | self.ui = ui | ||
|
r2329 | cfg = self.ui.config('notify', 'config') | ||
if cfg: | ||||
|
r8142 | self.ui.readconfig(cfg, sections=['usersubs', 'reposubs']) | ||
|
r2201 | self.repo = repo | ||
|
r2203 | self.stripcount = int(self.ui.config('notify', 'strip', 0)) | ||
|
r2201 | self.root = self.strip(self.repo.root) | ||
|
r2203 | self.domain = self.ui.config('notify', 'domain') | ||
|
r7498 | self.test = self.ui.configbool('notify', 'test', True) | ||
|
r7116 | self.charsets = mail._charsets(self.ui) | ||
|
r2203 | self.subs = self.subscribers() | ||
mapfile = self.ui.config('notify', 'style') | ||||
template = (self.ui.config('notify', hooktype) or | ||||
self.ui.config('notify', 'template')) | ||||
|
r3739 | self.t = cmdutil.changeset_templater(self.ui, self.repo, | ||
|
r7762 | False, None, mapfile, False) | ||
|
r2203 | if not mapfile and not template: | ||
template = deftemplates.get(hooktype) or single_template | ||||
if template: | ||||
template = templater.parsestring(template, quoted=False) | ||||
self.t.use_template(template) | ||||
|
r2201 | |||
def strip(self, path): | ||||
|
r2203 | '''strip leading slashes from local path, turn into web-safe path.''' | ||
|
r2201 | path = util.pconvert(path) | ||
count = self.stripcount | ||||
|
r2326 | while count > 0: | ||
|
r2201 | c = path.find('/') | ||
if c == -1: | ||||
break | ||||
path = path[c+1:] | ||||
count -= 1 | ||||
return path | ||||
|
r2203 | def fixmail(self, addr): | ||
'''try to clean up email addresses.''' | ||||
|
r5975 | addr = util.email(addr.strip()) | ||
|
r4094 | if self.domain: | ||
a = addr.find('@localhost') | ||||
if a != -1: | ||||
addr = addr[:a] | ||||
if '@' not in addr: | ||||
return addr + '@' + self.domain | ||||
|
r2203 | return addr | ||
|
r2201 | def subscribers(self): | ||
|
r2203 | '''return list of email addresses of subscribers to this repo.''' | ||
|
r8154 | subs = set() | ||
|
r2203 | for user, pats in self.ui.configitems('usersubs'): | ||
for pat in pats.split(','): | ||||
if fnmatch.fnmatch(self.repo.root, pat.strip()): | ||||
|
r8154 | subs.add(self.fixmail(user)) | ||
|
r2201 | for pat, users in self.ui.configitems('reposubs'): | ||
|
r2203 | if fnmatch.fnmatch(self.repo.root, pat): | ||
for user in users.split(','): | ||||
|
r8154 | subs.add(self.fixmail(user)) | ||
|
r7498 | return [mail.addressencode(self.ui, s, self.charsets, self.test) | ||
|
r8154 | for s in sorted(subs)] | ||
|
r2201 | |||
def url(self, path=None): | ||||
return self.ui.config('web', 'baseurl') + (path or self.root) | ||||
|
r7726 | def node(self, ctx): | ||
|
r2203 | '''format one changeset.''' | ||
|
r7726 | self.t.show(ctx, changes=ctx.changeset(), | ||
|
r2203 | baseurl=self.ui.config('web', 'baseurl'), | ||
|
r7726 | root=self.repo.root, webroot=self.root) | ||
|
r2203 | |||
|
r2230 | def skipsource(self, source): | ||
'''true if incoming changes from this source should be skipped.''' | ||||
ok_sources = self.ui.config('notify', 'sources', 'serve').split() | ||||
return source not in ok_sources | ||||
|
r7726 | def send(self, ctx, count, data): | ||
|
r2203 | '''send message.''' | ||
p = email.Parser.Parser() | ||||
|
r3739 | msg = p.parsestr(data) | ||
|
r2203 | |||
|
r7116 | # store sender and subject | ||
sender, subject = msg['From'], msg['Subject'] | ||||
|
r7658 | del msg['From'], msg['Subject'] | ||
# store remaining headers | ||||
headers = msg.items() | ||||
|
r7116 | # create fresh mime message from msg body | ||
text = msg.get_payload() | ||||
# for notification prefer readability over data precision | ||||
|
r7498 | msg = mail.mimeencode(self.ui, text, self.charsets, self.test) | ||
|
r7658 | # reinstate custom headers | ||
for k, v in headers: | ||||
msg[k] = v | ||||
|
r7116 | |||
|
r7705 | msg['Date'] = util.datestr(format="%a, %d %b %Y %H:%M:%S %1%2") | ||
|
r2203 | |||
|
r7705 | # try to make subject line exist and be useful | ||
if not subject: | ||||
if count > 1: | ||||
subject = _('%s: %d new changesets') % (self.root, count) | ||||
else: | ||||
|
r7726 | s = ctx.description().lstrip().split('\n', 1)[0].rstrip() | ||
|
r7705 | subject = '%s: %s' % (self.root, s) | ||
maxsubject = int(self.ui.config('notify', 'maxsubject', 67)) | ||||
if maxsubject and len(subject) > maxsubject: | ||||
subject = subject[:maxsubject-3] + '...' | ||||
msg['Subject'] = mail.headencode(self.ui, subject, | ||||
self.charsets, self.test) | ||||
|
r2203 | |||
|
r7705 | # try to make message have proper sender | ||
if not sender: | ||||
sender = self.ui.config('email', 'from') or self.ui.username() | ||||
if '@' not in sender or '@localhost' in sender: | ||||
sender = self.fixmail(sender) | ||||
msg['From'] = mail.addressencode(self.ui, sender, | ||||
self.charsets, self.test) | ||||
|
r2203 | |||
|
r7726 | msg['X-Hg-Notification'] = 'changeset %s' % ctx | ||
|
r2203 | if not msg['Message-Id']: | ||
msg['Message-Id'] = ('<hg.%s.%s.%s@%s>' % | ||||
|
r7726 | (ctx, int(time.time()), | ||
|
r2203 | hash(self.repo.root), socket.getfqdn())) | ||
|
r2230 | msg['To'] = ', '.join(self.subs) | ||
|
r2203 | |||
msgtext = msg.as_string(0) | ||||
|
r7498 | if self.test: | ||
|
r2203 | self.ui.write(msgtext) | ||
if not msgtext.endswith('\n'): | ||||
self.ui.write('\n') | ||||
|
r2201 | else: | ||
|
r2329 | self.ui.status(_('notify: sending %d subscribers %d changes\n') % | ||
|
r4498 | (len(self.subs), count)) | ||
|
r5975 | mail.sendmail(self.ui, util.email(msg['From']), | ||
|
r2889 | self.subs, msgtext) | ||
|
r2201 | |||
|
r7726 | def diff(self, ctx, ref=None): | ||
|
r2203 | maxdiff = int(self.ui.config('notify', 'maxdiff', 300)) | ||
|
r7726 | prev = ctx.parents()[0].node() | ||
ref = ref and ref.node() or ctx.node() | ||||
|
r7308 | chunks = patch.diff(self.repo, prev, ref, opts=patch.diffopts(self.ui)) | ||
difflines = ''.join(chunks).splitlines() | ||||
|
r6979 | |||
|
r3096 | if self.ui.configbool('notify', 'diffstat', True): | ||
s = patch.diffstat(difflines) | ||||
|
r4077 | # s may be nil, don't include the header if it is | ||
if s: | ||||
self.ui.write('\ndiffstat:\n\n%s' % s) | ||||
|
r7726 | |||
|
r6305 | if maxdiff == 0: | ||
return | ||||
|
r7726 | elif maxdiff > 0 and len(difflines) > maxdiff: | ||
msg = _('\ndiffs (truncated from %d to %d lines):\n\n') | ||||
self.ui.write(msg % (len(difflines), maxdiff)) | ||||
|
r2203 | difflines = difflines[:maxdiff] | ||
elif difflines: | ||||
|
r3739 | self.ui.write(_('\ndiffs (%d lines):\n\n') % len(difflines)) | ||
|
r7726 | |||
|
r6979 | self.ui.write("\n".join(difflines)) | ||
|
r2201 | |||
|
r2230 | def hook(ui, repo, hooktype, node=None, source=None, **kwargs): | ||
|
r2203 | '''send email notifications to interested subscribers. | ||
if used as changegroup hook, send one email for all changesets in | ||||
changegroup. else send one email per changeset.''' | ||||
|
r7726 | |||
|
r2203 | n = notifier(ui, repo, hooktype) | ||
|
r7726 | ctx = repo[node] | ||
|
r2329 | if not n.subs: | ||
|
r8027 | ui.debug(_('notify: no subscribers to repository %s\n') % n.root) | ||
|
r2329 | return | ||
if n.skipsource(source): | ||||
|
r7726 | ui.debug(_('notify: changes have source "%s" - skipping\n') % source) | ||
|
r2230 | return | ||
|
r7726 | |||
|
r3739 | ui.pushbuffer() | ||
|
r2203 | if hooktype == 'changegroup': | ||
|
r7726 | start, end = ctx.rev(), len(repo) | ||
|
r2203 | count = end - start | ||
for rev in xrange(start, end): | ||||
|
r7726 | n.node(repo[rev]) | ||
n.diff(ctx, repo['tip']) | ||||
|
r2203 | else: | ||
count = 1 | ||||
|
r7726 | n.node(ctx) | ||
n.diff(ctx) | ||||
|
r3739 | data = ui.popbuffer() | ||
|
r7726 | n.send(ctx, count, data) | ||