notify.py
454 lines
| 15.1 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 | ||
|
r10263 | # GNU General Public License version 2 or any later version. | ||
|
r7127 | |||
|
r14940 | '''hooks for sending email push notifications | ||
|
r7127 | |||
|
r16950 | This extension implements hooks to send email notifications when | ||
changesets are sent from or received by the local repository. | ||||
|
r7127 | |||
|
r14940 | First, enable the extension as explained in :hg:`help extensions`, and | ||
|
r16500 | register the hook you want to run. ``incoming`` and ``changegroup`` hooks | ||
|
r16950 | are run when changesets are received, while ``outgoing`` hooks are for | ||
changesets sent to another repository:: | ||||
|
r7127 | |||
|
r9105 | [hooks] | ||
# one email for each incoming changeset | ||||
incoming.notify = python:hgext.notify.hook | ||||
|
r14940 | # one email for all incoming changesets | ||
|
r9105 | changegroup.notify = python:hgext.notify.hook | ||
|
r14940 | |||
# one email for all outgoing changesets | ||||
|
r14617 | outgoing.notify = python:hgext.notify.hook | ||
|
r7127 | |||
|
r16950 | This registers the hooks. To enable notification, subscribers must | ||
be assigned to repositories. The ``[usersubs]`` section maps multiple | ||||
repositories to a given recipient. The ``[reposubs]`` section maps | ||||
multiple recipients to a single repository:: | ||||
|
r9157 | |||
|
r9105 | [usersubs] | ||
|
r17754 | # key is subscriber email, value is a comma-separated list of repo patterns | ||
|
r9105 | user@host = pattern | ||
|
r7127 | |||
|
r9105 | [reposubs] | ||
|
r17754 | # key is repo pattern, value is a comma-separated list of subscriber emails | ||
|
r9105 | pattern = user@host | ||
|
r7127 | |||
|
r17754 | A ``pattern`` is a ``glob`` matching the absolute path to a repository, | ||
optionally combined with a revset expression. A revset expression, if | ||||
present, is separated from the glob by a hash. Example:: | ||||
[reposubs] | ||||
*/widgets#branch(release) = qa-team@example.com | ||||
This sends to ``qa-team@example.com`` whenever a changeset on the ``release`` | ||||
branch triggers a notification in any repository ending in ``widgets``. | ||||
|
r16950 | |||
In order to place them under direct user management, ``[usersubs]`` and | ||||
``[reposubs]`` sections may be placed in a separate ``hgrc`` file and | ||||
incorporated by reference:: | ||||
|
r14940 | |||
[notify] | ||||
config = /path/to/subscriptionsfile | ||||
|
r16950 | Notifications will not be sent until the ``notify.test`` value is set | ||
to ``False``; see below. | ||||
|
r14940 | |||
Notifications content can be tweaked with the following configuration entries: | ||||
notify.test | ||||
If ``True``, print messages to stdout instead of sending them. Default: True. | ||||
notify.sources | ||||
|
r16950 | Space-separated list of change sources. Notifications are activated only | ||
when a changeset's source is in this list. Sources may be: | ||||
:``serve``: changesets received via http or ssh | ||||
:``pull``: changesets received via ``hg pull`` | ||||
:``unbundle``: changesets received via ``hg unbundle`` | ||||
:``push``: changesets sent or received via ``hg push`` | ||||
:``bundle``: changesets sent via ``hg unbundle`` | ||||
Default: serve. | ||||
|
r14940 | |||
notify.strip | ||||
Number of leading slashes to strip from url paths. By default, notifications | ||||
|
r16950 | reference repositories with their absolute path. ``notify.strip`` lets you | ||
|
r14940 | turn them into relative paths. For example, ``notify.strip=3`` will change | ||
``/long/path/repository`` into ``repository``. Default: 0. | ||||
notify.domain | ||||
|
r16950 | Default email domain for sender or recipients with no explicit domain. | ||
|
r7127 | |||
|
r14940 | notify.style | ||
Style file to use when formatting emails. | ||||
notify.template | ||||
Template to use when formatting emails. | ||||
notify.incoming | ||||
|
r16950 | Template to use when run as an incoming hook, overriding ``notify.template``. | ||
|
r14940 | |||
notify.outgoing | ||||
|
r16950 | Template to use when run as an outgoing hook, overriding ``notify.template``. | ||
|
r14940 | |||
notify.changegroup | ||||
|
r16950 | Template to use when running as a changegroup hook, overriding | ||
|
r14940 | ``notify.template``. | ||
notify.maxdiff | ||||
Maximum number of diff lines to include in notification email. Set to 0 | ||||
|
r16950 | to disable the diff, or -1 to include all of it. Default: 300. | ||
|
r14940 | |||
notify.maxsubject | ||||
|
r16950 | Maximum number of characters in email's subject line. Default: 67. | ||
|
r14940 | |||
notify.diffstat | ||||
Set to True to include a diffstat before diff content. Default: True. | ||||
notify.merge | ||||
If True, send notifications for merge changesets. Default: True. | ||||
|
r15561 | notify.mbox | ||
If set, append mails to this mbox file instead of sending. Default: None. | ||||
|
r15654 | notify.fromauthor | ||
|
r16950 | If set, use the committer of the first changeset in a changegroup for | ||
the "From" field of the notification mail. If not set, take the user | ||||
from the pushing repo. Default: False. | ||||
|
r15654 | |||
|
r16950 | If set, the following entries will also be used to customize the | ||
notifications: | ||||
|
r14940 | |||
email.from | ||||
|
r16950 | Email ``From`` address to use if none can be found in the generated | ||
email content. | ||||
|
r14940 | |||
web.baseurl | ||||
|
r16950 | Root repository URL to combine with repository paths when making | ||
|
r14940 | references. See also ``notify.strip``. | ||
|
r9068 | ''' | ||
|
r28416 | from __future__ import absolute_import | ||
|
r2203 | |||
|
r28416 | import email | ||
import fnmatch | ||||
import socket | ||||
import time | ||||
|
r29205 | from mercurial.i18n import _ | ||
|
r28416 | from mercurial import ( | ||
cmdutil, | ||||
error, | ||||
mail, | ||||
patch, | ||||
|
r33738 | registrar, | ||
|
r28416 | util, | ||
) | ||||
|
r2203 | |||
|
r29841 | # Note for extension authors: ONLY specify testedwith = 'ships-with-hg-core' for | ||
|
r25186 | # extensions which SHIP WITH MERCURIAL. Non-mainline extensions should | ||
# be specifying the version(s) of Mercurial they are tested with, or | ||||
# leave the attribute unspecified. | ||||
|
r29841 | testedwith = 'ships-with-hg-core' | ||
|
r16743 | |||
|
r33738 | configtable = {} | ||
configitem = registrar.configitem(configtable) | ||||
configitem('notify', 'config', | ||||
default=None, | ||||
) | ||||
|
r33739 | configitem('notify', 'diffstat', | ||
default=True, | ||||
) | ||||
|
r33740 | configitem('notify', 'domain', | ||
default=None, | ||||
) | ||||
|
r33741 | configitem('notify', 'fromauthor', | ||
default=None, | ||||
) | ||||
|
r33742 | configitem('notify', 'maxdiff', | ||
default=300, | ||||
) | ||||
|
r33743 | configitem('notify', 'maxsubject', | ||
default=67, | ||||
) | ||||
|
r33738 | |||
|
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') | ||
|
r15561 | self.mbox = self.ui.config('notify', 'mbox') | ||
|
r7498 | self.test = self.ui.configbool('notify', 'test', True) | ||
|
r7116 | self.charsets = mail._charsets(self.ui) | ||
|
r2203 | self.subs = self.subscribers() | ||
|
r9516 | self.merge = self.ui.configbool('notify', 'merge', True) | ||
|
r2203 | |||
|
r28951 | mapfile = None | ||
|
r2203 | template = (self.ui.config('notify', hooktype) or | ||
self.ui.config('notify', 'template')) | ||||
|
r28951 | if not template: | ||
mapfile = self.ui.config('notify', 'style') | ||||
|
r2203 | if not mapfile and not template: | ||
template = deftemplates.get(hooktype) or single_template | ||||
|
r32839 | spec = cmdutil.logtemplatespec(template, mapfile) | ||
self.t = cmdutil.changeset_templater(self.ui, self.repo, spec, | ||||
False, None, False) | ||||
|
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 | ||||
|
r10282 | path = path[c + 1:] | ||
|
r2201 | 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(','): | ||||
|
r17754 | if '#' in pat: | ||
pat, revs = pat.split('#', 1) | ||||
else: | ||||
revs = None | ||||
|
r2203 | if fnmatch.fnmatch(self.repo.root, pat.strip()): | ||
|
r17754 | subs.add((self.fixmail(user), revs)) | ||
|
r2201 | for pat, users in self.ui.configitems('reposubs'): | ||
|
r17754 | if '#' in pat: | ||
pat, revs = pat.split('#', 1) | ||||
else: | ||||
revs = None | ||||
|
r2203 | if fnmatch.fnmatch(self.repo.root, pat): | ||
for user in users.split(','): | ||||
|
r17754 | subs.add((self.fixmail(user), revs)) | ||
return [(mail.addressencode(self.ui, s, self.charsets, self.test), r) | ||||
for s, r in sorted(subs)] | ||||
|
r2201 | |||
|
r9486 | def node(self, ctx, **props): | ||
|
r9516 | '''format one changeset, unless it is a suppressed merge.''' | ||
if not self.merge and len(ctx.parents()) > 1: | ||||
return False | ||||
|
r7726 | self.t.show(ctx, changes=ctx.changeset(), | ||
|
r2203 | baseurl=self.ui.config('web', 'baseurl'), | ||
|
r9486 | root=self.repo.root, webroot=self.root, **props) | ||
|
r9516 | return True | ||
|
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.''' | ||
|
r17754 | # Select subscribers by revset | ||
subs = set() | ||||
for sub, spec in self.subs: | ||||
if spec is None: | ||||
subs.add(sub) | ||||
continue | ||||
revs = self.repo.revs('%r and %d:', spec, ctx.rev()) | ||||
if len(revs): | ||||
subs.add(sub) | ||||
continue | ||||
if len(subs) == 0: | ||||
self.ui.debug('notify: no subscribers to selected repo ' | ||||
'and revset\n') | ||||
return | ||||
|
r2203 | p = email.Parser.Parser() | ||
|
r9313 | try: | ||
msg = p.parsestr(data) | ||||
|
r25660 | except email.Errors.MessageParseError as inst: | ||
|
r26587 | raise error.Abort(inst) | ||
|
r2203 | |||
|
r7116 | # store sender and subject | ||
sender, subject = msg['From'], msg['Subject'] | ||||
|
r7658 | del msg['From'], msg['Subject'] | ||
|
r9313 | |||
if not msg.is_multipart(): | ||||
# create fresh mime message from scratch | ||||
# (multipart templates must take care of this themselves) | ||||
headers = msg.items() | ||||
payload = msg.get_payload() | ||||
# for notification prefer readability over data precision | ||||
msg = mail.mimeencode(self.ui, payload, self.charsets, self.test) | ||||
# 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) | ||
|
r33743 | maxsubject = int(self.ui.config('notify', 'maxsubject')) | ||
|
r13202 | if maxsubject: | ||
subject = util.ellipsis(subject, maxsubject) | ||||
|
r7705 | 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())) | ||
|
r17754 | msg['To'] = ', '.join(sorted(subs)) | ||
|
r2203 | |||
|
r9136 | msgtext = msg.as_string() | ||
|
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') % | ||
|
r17754 | (len(subs), count)) | ||
|
r5975 | mail.sendmail(self.ui, util.email(msg['From']), | ||
|
r17754 | subs, msgtext, mbox=self.mbox) | ||
|
r2201 | |||
|
r7726 | def diff(self, ctx, ref=None): | ||
|
r33742 | maxdiff = int(self.ui.config('notify', 'maxdiff')) | ||
|
r13878 | prev = ctx.p1().node() | ||
|
r24306 | if ref: | ||
ref = ref.node() | ||||
else: | ||||
ref = ctx.node() | ||||
|
r23454 | chunks = patch.diff(self.repo, prev, ref, | ||
opts=patch.diffallopts(self.ui)) | ||||
|
r7308 | difflines = ''.join(chunks).splitlines() | ||
|
r6979 | |||
|
r33739 | if self.ui.configbool('notify', 'diffstat'): | ||
|
r3096 | s = patch.diffstat(difflines) | ||
|
r4077 | # s may be nil, don't include the header if it is | ||
if s: | ||||
|
r29240 | 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: | ||
|
r9467 | ui.debug('notify: no subscribers to repository %s\n' % n.root) | ||
|
r2329 | return | ||
if n.skipsource(source): | ||||
|
r9467 | ui.debug('notify: changes have source "%s" - skipping\n' % source) | ||
|
r2230 | return | ||
|
r7726 | |||
|
r3739 | ui.pushbuffer() | ||
|
r9516 | data = '' | ||
count = 0 | ||||
|
r15654 | author = '' | ||
|
r14617 | if hooktype == 'changegroup' or hooktype == 'outgoing': | ||
|
r7726 | start, end = ctx.rev(), len(repo) | ||
|
r2203 | for rev in xrange(start, end): | ||
|
r9516 | if n.node(repo[rev]): | ||
count += 1 | ||||
|
r15654 | if not author: | ||
author = repo[rev].user() | ||||
|
r9516 | else: | ||
data += ui.popbuffer() | ||||
|
r16683 | ui.note(_('notify: suppressing notification for merge %d:%s\n') | ||
% (rev, repo[rev].hex()[:12])) | ||||
|
r9516 | ui.pushbuffer() | ||
if count: | ||||
n.diff(ctx, repo['tip']) | ||||
|
r2203 | else: | ||
|
r9516 | if not n.node(ctx): | ||
ui.popbuffer() | ||||
ui.note(_('notify: suppressing notification for merge %d:%s\n') % | ||||
(ctx.rev(), ctx.hex()[:12])) | ||||
return | ||||
count += 1 | ||||
|
r7726 | n.diff(ctx) | ||
|
r26503 | if not author: | ||
author = ctx.user() | ||||
|
r7726 | |||
|
r9516 | data += ui.popbuffer() | ||
|
r15654 | fromauthor = ui.config('notify', 'fromauthor') | ||
if author and fromauthor: | ||||
data = '\n'.join(['From: %s' % author, data]) | ||||
|
r9516 | if count: | ||
n.send(ctx, count, data) | ||||