notify: mime-encode messages

- addresses will be properly encoded
- message bodies will also be encoded as we are not sending
  patches that are meant to be applied
- update test output
- adapt test-keyword to ignore the new headers

hgext/notify.py

@@ -1,283 +1,288
 # notify.py - email notifications for mercurial
 #
 # Copyright 2006 Vadim Gelfer <[e-mail]>
 #
 # This software may be used and distributed according to the terms
 # of the GNU General Public License, incorporated herein by reference.
 #
 # hook extension to email notifications to people when changesets are
 # committed to a repo they subscribe to.
 #
 # default mode is to print messages to stdout, for testing and
 # configuring.
 #
 # to use, configure notify extension and enable in hgrc like this:
 #
 #   [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]
 #   # config items go in here
 #
 # config items:
 #
 # REQUIRED:
 #   config = /path/to/file # file containing subscriptions
 #
 # OPTIONAL:
 #   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 = [e-mail]   # email address to send as if none given
 #   [web]
 #   baseurl = http://hgserver/... # root of hg web site for browsing commits
 #
 # notify config file has same format as regular hgrc. it has two
 # sections so you can express subscriptions in whatever way is handier
 # for you.
 #
 #   [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
 #
 # glob patterns are matched against path to repo root.
 #
 # if you like, you can put notify config file in repo that users can
 # push changes to, they can manage their own subscriptions.
 
 from mercurial.i18n import _
 from mercurial.node import bin, short
 from mercurial import patch, cmdutil, templater, util, mail
 import email.Parser, fnmatch, socket, time
 
 # 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,
 }
 
 class notifier(object):
     '''email notification class.'''
 
     def __init__(self, ui, repo, hooktype):
         self.ui = ui
         cfg = self.ui.config('notify', 'config')
         if cfg:
             self.ui.readsections(cfg, 'usersubs', 'reposubs')
         self.repo = repo
         self.stripcount = int(self.ui.config('notify', 'strip', 0))
         self.root = self.strip(self.repo.root)
         self.domain = self.ui.config('notify', 'domain')
+        self.charsets = mail._charsets(self.ui)
         self.subs = self.subscribers()
 
         mapfile = self.ui.config('notify', 'style')
         template = (self.ui.config('notify', hooktype) or
                     self.ui.config('notify', 'template'))
         self.t = cmdutil.changeset_templater(self.ui, self.repo,
                                              False, mapfile, False)
         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)
 
     def strip(self, path):
         '''strip leading slashes from local path, turn into web-safe path.'''
 
         path = util.pconvert(path)
         count = self.stripcount
         while count > 0:
             c = path.find('/')
             if c == -1:
                 break
             path = path[c+1:]
             count -= 1
         return path
 
     def fixmail(self, addr):
         '''try to clean up email addresses.'''
 
         addr = util.email(addr.strip())
         if self.domain:
             a = addr.find('@localhost')
             if a != -1:
                 addr = addr[:a]
             if '@' not in addr:
                 return addr + '@' + self.domain
         return addr
 
     def subscribers(self):
         '''return list of email addresses of subscribers to this repo.'''
 
         subs = {}
         for user, pats in self.ui.configitems('usersubs'):
             for pat in pats.split(','):
                 if fnmatch.fnmatch(self.repo.root, pat.strip()):
                     subs[self.fixmail(user)] = 1
         for pat, users in self.ui.configitems('reposubs'):
             if fnmatch.fnmatch(self.repo.root, pat):
                 for user in users.split(','):
                     subs[self.fixmail(user)] = 1
-        return util.sort(subs)
+        subs = util.sort(subs)
+        return [mail.addressencode(self.ui, s, self.charsets) for s in subs]
 
     def url(self, path=None):
         return self.ui.config('web', 'baseurl') + (path or self.root)
 
     def node(self, node):
         '''format one changeset.'''
 
         self.t.show(changenode=node, changes=self.repo.changelog.read(node),
                     baseurl=self.ui.config('web', 'baseurl'),
                     root=self.repo.root,
                     webroot=self.root)
 
     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
 
     def send(self, node, count, data):
         '''send message.'''
 
         p = email.Parser.Parser()
         msg = p.parsestr(data)
 
-        def fix_subject():
+        # store sender and subject
+        sender, subject = msg['From'], msg['Subject']
+        # create fresh mime message from msg body
+        text = msg.get_payload()
+        # for notification prefer readability over data precision
+        msg = mail.mimeencode(self.ui, text, self.charsets)
+
+        def fix_subject(subject):
             '''try to make subject line exist and be useful.'''
 
-            subject = msg['Subject']
             if not subject:
                 if count > 1:
                     subject = _('%s: %d new changesets') % (self.root, count)
                 else:
                     changes = self.repo.changelog.read(node)
                     s = changes[4].lstrip().split('\n', 1)[0].rstrip()
                     subject = '%s: %s' % (self.root, s)
             maxsubject = int(self.ui.config('notify', 'maxsubject', 67))
             if maxsubject and len(subject) > maxsubject:
                 subject = subject[:maxsubject-3] + '...'
-            del msg['Subject']
-            msg['Subject'] = subject
+            msg['Subject'] = mail.headencode(self.ui, subject, self.charsets)
 
-        def fix_sender():
+        def fix_sender(sender):
             '''try to make message have proper sender.'''
 
-            sender = msg['From']
             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)
-            del msg['From']
-            msg['From'] = sender
+            msg['From'] = mail.addressencode(self.ui, sender, self.charsets)
 
         msg['Date'] = util.datestr(format="%a, %d %b %Y %H:%M:%S %1%2")
-        fix_subject()
-        fix_sender()
+        fix_subject(subject)
+        fix_sender(sender)
 
         msg['X-Hg-Notification'] = 'changeset ' + short(node)
         if not msg['Message-Id']:
             msg['Message-Id'] = ('<hg.%s.%s.%s@%s>' %
                                  (short(node), int(time.time()),
                                   hash(self.repo.root), socket.getfqdn()))
         msg['To'] = ', '.join(self.subs)
 
         msgtext = msg.as_string(0)
         if self.ui.configbool('notify', 'test', True):
             self.ui.write(msgtext)
             if not msgtext.endswith('\n'):
                 self.ui.write('\n')
         else:
             self.ui.status(_('notify: sending %d subscribers %d changes\n') %
                            (len(self.subs), count))
             mail.sendmail(self.ui, util.email(msg['From']),
                           self.subs, msgtext)
 
     def diff(self, node, ref):
         maxdiff = int(self.ui.config('notify', 'maxdiff', 300))
         prev = self.repo.changelog.parents(node)[0]
 
         self.ui.pushbuffer()
         patch.diff(self.repo, prev, ref, opts=patch.diffopts(self.ui))
         difflines = self.ui.popbuffer().splitlines()
 
         if self.ui.configbool('notify', 'diffstat', True):
             s = patch.diffstat(difflines)
             # s may be nil, don't include the header if it is
             if s:
                 self.ui.write('\ndiffstat:\n\n%s' % s)
         if maxdiff == 0:
             return
         if maxdiff > 0 and len(difflines) > maxdiff:
             self.ui.write(_('\ndiffs (truncated from %d to %d lines):\n\n') %
                           (len(difflines), maxdiff))
             difflines = difflines[:maxdiff]
         elif difflines:
             self.ui.write(_('\ndiffs (%d lines):\n\n') % len(difflines))
         self.ui.write("\n".join(difflines))
 
 def hook(ui, repo, hooktype, node=None, source=None, **kwargs):
     '''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.'''
     n = notifier(ui, repo, hooktype)
     if not n.subs:
         ui.debug(_('notify: no subscribers to repo %s\n') % n.root)
         return
     if n.skipsource(source):
         ui.debug(_('notify: changes have source "%s" - skipping\n') %
                  source)
         return
     node = bin(node)
     ui.pushbuffer()
     if hooktype == 'changegroup':
         start = repo[node].rev()
         end = len(repo)
         count = end - start
         for rev in xrange(start, end):
             n.node(repo[rev].node())
         n.diff(node, repo.changelog.tip())
     else:
         count = 1
         n.node(node)
         n.diff(node, node)
     data = ui.popbuffer()
     n.send(node, count, data)

tests/test-keyword

@@ -1,343 +1,343
 #!/bin/sh
 
 cat <<EOF >> $HGRCPATH
 [extensions]
 hgext.keyword =
 hgext.mq =
 hgext.notify =
 [keyword]
 * =
 b = ignore
 [hooks]
 commit=
 commit.test=cp a hooktest
 EOF
 
 echo % help
 hg help keyword
 
 echo % hg kwdemo
 hg --quiet kwdemo --default \
 | sed -e 's![^ ][^ ]*demo.txt,v!/TMP/demo.txt,v!' \
  -e 's/,v [a-z0-9][a-z0-9]* /,v xxxxxxxxxxxx /' \
  -e '/[$]Revision/ s/: [a-z0-9][a-z0-9]* /: xxxxxxxxxxxx /' \
  -e 's! 20[0-9][0-9]/[01][0-9]/[0-3][0-9] [0-2][0-9]:[0-6][0-9]:[0-6][0-9]! 2000/00/00 00:00:00!'
 
 hg --quiet kwdemo "Branch = {branches}"
 
 hg init Test-bndl
 cd Test-bndl
 
 echo % kwshrink should exit silently in empty/invalid repo
 hg kwshrink
 
 # Symlinks cannot be created on Windows. The bundle was made with:
 #
 # hg init t
 # cd t
 # echo a > a
 # ln -s a sym
 # hg add sym
 # hg ci -m addsym -u mercurial
 # hg bundle --base null ../test-keyword.hg
 #
 hg pull -u "$TESTDIR/test-keyword.hg" \
     | sed 's/pulling from.*test-keyword.hg/pulling from test-keyword.hg/'
 
 echo 'expand $Id$' > a
 echo 'do not process $Id:' >> a
 echo 'xxx $' >> a
 echo 'ignore $Id$' > b
 echo % cat
 cat a b
 
 echo % addremove
 hg addremove
 echo % status
 hg status
 
 echo % default keyword expansion including commit hook
 echo % interrupted commit should not change state or run commit hook
 hg --debug commit
 echo % status
 hg status
 
 echo % commit
 hg --debug commit -mabsym -d '0 0' -u 'User Name <[e-mail]>'
 echo % status
 hg status
 echo % identify
 hg debugrebuildstate
 hg --quiet identify
 echo % cat
 cat a b
 echo % hg cat
 hg cat sym a b
 
 echo
 echo % diff a hooktest
 diff a hooktest
 
 echo % removing commit hook from config
 sed -e '/\[hooks\]/,$ d' $HGRCPATH > $HGRCPATH.nohook
 mv $HGRCPATH.nohook $HGRCPATH
 rm hooktest
 
 echo % bundle
 hg bundle --base null ../kw.hg
 
 cd ..
 hg init Test
 cd Test
 
 echo % notify on pull to check whether keywords stay as is in email
 echo % ie. if patch.diff wrapper acts as it should
 
 cat <<EOF >> $HGRCPATH
 [hooks]
 incoming.notify = python:hgext.notify.hook
 [notify]
 sources = pull
 diffstat = False
 [reposubs]
 * = Test
 EOF
 
 echo % pull from bundle
-hg pull -u ../kw.hg 2>&1 | sed -e '/^Date:/,/^diffs (/ d'
+hg pull -u ../kw.hg 2>&1 | sed -e '/^Content-Type:/,/^diffs (/ d'
 
 echo % remove notify config
 sed -e '/\[hooks\]/,$ d' $HGRCPATH > $HGRCPATH.nonotify
 mv $HGRCPATH.nonotify $HGRCPATH
 
 echo % touch
 touch a b
 echo % status
 hg status
 
 rm sym a b
 echo % update
 hg update
 echo % cat
 cat a b
 
 echo % check whether expansion is filewise
 echo '$Id$' > c
 echo 'tests for different changenodes' >> c
 echo % commit c
 hg commit -A -mcndiff -d '1 0' -u 'User Name <[e-mail]>'
 echo % force expansion
 hg -v kwexpand
 echo % compare changenodes in a c
 cat a c
 
 echo % qinit -c
 hg qinit -c
 echo % qimport
 hg qimport -r tip -n mqtest.diff
 echo % qcommit
 hg qcommit -mqtest
 echo % keywords should not be expanded in patch
 cat .hg/patches/mqtest.diff
 echo % qpop
 hg qpop
 echo % qgoto - should imply qpush
 hg qgoto mqtest.diff
 echo % cat
 cat c
 echo % qpop and move on
 hg qpop
 
 echo % copy
 hg cp a c
 
 echo % kwfiles added
 hg kwfiles
 
 echo % commit
 hg --debug commit -ma2c -d '1 0' -u 'User Name <[e-mail]>'
 echo % cat a c
 cat a c
 echo % touch copied c
 touch c
 echo % status
 hg status
 
 echo % kwfiles
 hg kwfiles
 
 echo % diff --rev
 hg diff --rev 1 | grep -v 'b/c'
 
 echo % rollback
 hg rollback
 echo % status
 hg status
 echo % update -C
 hg update --clean
 
 echo % custom keyword expansion
 echo % try with kwdemo
 hg --quiet kwdemo "Xinfo = {author}: {desc}"
 
 cat <<EOF >>$HGRCPATH
 [keywordmaps]
 Id = {file} {node|short} {date|rfc822date} {author|user}
 Xinfo = {author}: {desc}
 EOF
 
 echo % cat
 cat a b
 echo % hg cat
 hg cat sym a b
 
 echo
 echo '$Xinfo$' >> a
 cat <<EOF >> log
 firstline
 secondline
 EOF
 
 echo % interrupted commit should not change state
 hg commit
 echo % status
 hg status
 
 echo % commit
 hg --debug commit -l log -d '2 0' -u 'User Name <[e-mail]>'
 rm log
 echo % status
 hg status
 echo % verify
 hg verify
 
 echo % cat
 cat a b
 echo % hg cat
 hg cat sym a b
 echo
 echo % annotate
 hg annotate a
 
 echo % remove
 hg debugrebuildstate
 hg remove a
 hg --debug commit -m rma
 echo % status
 hg status
 echo % rollback
 hg rollback
 echo % status
 hg status
 echo % revert a
 hg revert --no-backup --rev tip a
 echo % cat a
 cat a
 
 echo % clone to test incoming
 cd ..
 hg clone -r1 Test Test-a
 cd Test-a
 cat <<EOF >> .hg/hgrc
 [paths]
 default = ../Test
 EOF
 echo % incoming
 # remove path to temp dir
 hg incoming | sed -e 's/^\(comparing with \).*\(test-keyword.*\)/\1\2/'
 
 sed -e 's/Id.*/& rejecttest/' a > a.new
 mv a.new a
 echo % commit rejecttest
 hg --debug commit -m'rejects?' -d '3 0' -u 'User Name <[e-mail]>'
 echo % export
 hg export -o ../rejecttest.diff tip
 
 cd ../Test
 echo % import
 hg import ../rejecttest.diff
 echo % cat
 cat a b
 echo
 echo % rollback
 hg rollback
 echo % clean update
 hg update --clean
 
 echo % kwexpand/kwshrink on selected files
 mkdir x
 echo % copy a x/a
 hg copy a x/a
 echo % kwexpand a
 hg --verbose kwexpand a
 echo % kwexpand x/a should abort
 hg --verbose kwexpand x/a
 cd x
 hg --debug commit -m xa -d '3 0' -u 'User Name <[e-mail]>'
 echo % cat a
 cat a
 echo % kwshrink a inside directory x
 hg --verbose kwshrink a
 echo % cat a
 cat a
 cd ..
 
 echo % kwexpand nonexistent
 hg kwexpand nonexistent 2>&1 | sed 's/nonexistent:.*/nonexistent:/'
 
 echo % hg serve
 hg serve -p $HGPORT -d --pid-file=hg.pid -A access.log -E errors.log
 cat hg.pid >> $DAEMON_PIDS
 echo % expansion
 echo % hgweb file
 ("$TESTDIR/get-with-headers.py" localhost:$HGPORT '/file/tip/a/?style=raw')
 echo % no expansion
 echo % hgweb annotate
 ("$TESTDIR/get-with-headers.py" localhost:$HGPORT '/annotate/tip/a/?style=raw')
 echo % hgweb changeset
 ("$TESTDIR/get-with-headers.py" localhost:$HGPORT '/rev/tip/?style=raw')
 echo % hgweb filediff
 ("$TESTDIR/get-with-headers.py" localhost:$HGPORT '/diff/bb948857c743/a?style=raw')
 echo % errors encountered
 cat errors.log
 
 echo % merge/resolve
 echo '$Id$' > m
 hg add m
 hg commit -m 4kw 
 echo foo >> m
 hg commit -m 5foo
 echo % simplemerge
 hg update 4
 echo foo >> m
 hg commit -m 6foo
 hg merge
 hg commit -m simplemerge
 cat m
 echo % conflict
 hg update 4
 echo bar >> m
 hg commit -m 8bar
 hg merge
 echo % keyword stays outside conflict zone
 cat m
 echo % resolve to local
 HGMERGE=internal:local hg resolve
 hg commit -m localresolve
 cat m
 
 echo % switch off expansion
 echo % kwshrink with unknown file u
 cp a u
 hg --verbose kwshrink
 echo % cat
 cat a b
 echo % hg cat
 hg cat sym a b
 echo
 rm $HGRCPATH
 echo % cat
 cat a b
 echo % hg cat
 hg cat sym a b
 echo

tests/test-notify-changegroup.out

@@ -1,36 +1,39
 % clone
 updating working directory
 0 files updated, 0 files merged, 0 files removed, 0 files unresolved
 % commit
 adding a
 % commit
 % push
 pushing to ../a
 searching for changes
 adding changesets
 adding manifests
 adding file changes
 added 2 changesets with 2 changes to 1 files
+Content-Type: text/plain; charset="us-ascii"
+MIME-Version: 1.0
+Content-Transfer-Encoding: 7bit
 Date:
 Subject: test-notify-changegroup/a: 2 new changesets
 From: test
 X-Hg-Notification: changeset cb9a9f314b8b
 Message-Id:
 To: baz, foo@bar
 
 changeset cb9a9f314b8b in test-notify-changegroup/a
 details: test-notify-changegroup/a?cmd=changeset;node=cb9a9f314b8b
 summary: a
 
 changeset ba677d0156c1 in test-notify-changegroup/a
 details: test-notify-changegroup/a?cmd=changeset;node=ba677d0156c1
 summary: b
 
 diffs (6 lines):
 
 diff -r 000000000000 -r ba677d0156c1 a
 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
 +++ b/a	Thu Jan 01 00:00:00 1970 +0000
 @@ -0,0 +1,2 @@
 +a
 +a

tests/test-notify.out

@@ -1,98 +1,107
 notify extension - No help text available
 
 no commands defined
 % commit
 adding a
 % clone
 updating working directory
 1 files updated, 0 files merged, 0 files removed, 0 files unresolved
 % commit
 % pull (minimal config)
 pulling from ../a
 searching for changes
 adding changesets
 adding manifests
 adding file changes
 added 1 changesets with 1 changes to 1 files
+Content-Type: text/plain; charset="us-ascii"
+MIME-Version: 1.0
+Content-Transfer-Encoding: 7bit
 Date:
 Subject: changeset in test-notify/b: b
 From: test
 X-Hg-Notification: changeset 0647d048b600
 Message-Id:
 To: baz, foo@bar
 
 changeset 0647d048b600 in test-notify/b
 details: test-notify/b?cmd=changeset;node=0647d048b600
 description: b
 
 diffs (6 lines):
 
 diff -r cb9a9f314b8b -r 0647d048b600 a
 --- a/a	Thu Jan 01 00:00:00 1970 +0000
 +++ b/a	Thu Jan 01 00:00:01 1970 +0000
 @@ -1,1 +1,2 @@
  a
 +a
 (run 'hg update' to get a working copy)
 % fail for config file is missing
 rolling back last transaction
 pull failed
 % pull
 rolling back last transaction
 pulling from ../a
 searching for changes
 adding changesets
 adding manifests
 adding file changes
 added 1 changesets with 1 changes to 1 files
+Content-Type: text/plain; charset="us-ascii"
+MIME-Version: 1.0
+Content-Transfer-Encoding: 7bit
 Date:
 Subject: b
 From: [e-mail]
 X-Hg-Notification: changeset 0647d048b600
 Message-Id:
 To: [e-mail], foo@bar
 
 changeset 0647d048b600
 description:
 	b
 diffs (6 lines):
 
 diff -r cb9a9f314b8b -r 0647d048b600 a
 --- a/a	Thu Jan 01 00:00:00 1970 +0000
 +++ b/a	Thu Jan 01 00:00:01 1970 +0000
 @@ -1,1 +1,2 @@
  a
 +a
 (run 'hg update' to get a working copy)
 % pull
 rolling back last transaction
 pulling from ../a
 searching for changes
 adding changesets
 adding manifests
 adding file changes
 added 1 changesets with 1 changes to 1 files
+Content-Type: text/plain; charset="us-ascii"
+MIME-Version: 1.0
+Content-Transfer-Encoding: 7bit
 Date:
 Subject: b
 From: [e-mail]
 X-Hg-Notification: changeset 0647d048b600
 Message-Id:
 To: [e-mail], foo@bar
 
 changeset 0647d048b600
 description:
 	b
 diffstat:
 
 1 file changed, 1 insertion(+)
 a |    1 +
 
 diffs (6 lines):
 
 diff -r cb9a9f314b8b -r 0647d048b600 a
 --- a/a	Thu Jan 01 00:00:00 1970 +0000
 +++ b/a	Thu Jan 01 00:00:01 1970 +0000
 @@ -1,1 +1,2 @@
  a
 +a
 (run 'hg update' to get a working copy)