mail: let addressencode() / addrlistencode() return native strings

Avoids conversion to "str" on py3.

hgext/notify.py

@@ -1,573 +1,573
 # 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 version 2 or any later version.
 
 '''hooks for sending email push notifications
 
 This extension implements hooks to send email notifications when
 changesets are sent from or received by the local repository.
 
 First, enable the extension as explained in :hg:`help extensions`, and
 register the hook you want to run. ``incoming`` and ``changegroup`` hooks
 are run when changesets are received, while ``outgoing`` hooks are for
 changesets sent to another repository::
 
   [hooks]
   # one email for each incoming changeset
   incoming.notify = python:hgext.notify.hook
   # one email for all incoming changesets
   changegroup.notify = python:hgext.notify.hook
 
   # one email for all outgoing changesets
   outgoing.notify = python:hgext.notify.hook
 
 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::
 
   [usersubs]
   # key is subscriber email, value is a comma-separated list of repo patterns
   user@host = pattern
 
   [reposubs]
   # key is repo pattern, value is a comma-separated list of subscriber emails
   pattern = user@host
 
 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) = [e-mail]
 
 This sends to ``[e-mail]`` whenever a changeset on the ``release``
 branch triggers a notification in any repository ending in ``widgets``.
 
 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::
 
   [notify]
   config = /path/to/subscriptionsfile
 
 Notifications will not be sent until the ``notify.test`` value is set
 to ``False``; see below.
 
 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
   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.
 
 notify.strip
   Number of leading slashes to strip from url paths. By default, notifications
   reference repositories with their absolute path. ``notify.strip`` lets you
   turn them into relative paths. For example, ``notify.strip=3`` will change
   ``/long/path/repository`` into ``repository``. Default: 0.
 
 notify.domain
   Default email domain for sender or recipients with no explicit domain.
   It is also used for the domain part of the ``Message-Id`` when using
   ``notify.messageidseed``.
 
 notify.messageidseed
   Create deterministic ``Message-Id`` headers for the mails based on the seed
   and the revision identifier of the first commit in the changeset.
 
 notify.style
   Style file to use when formatting emails.
 
 notify.template
   Template to use when formatting emails.
 
 notify.incoming
   Template to use when run as an incoming hook, overriding ``notify.template``.
 
 notify.outgoing
   Template to use when run as an outgoing hook, overriding ``notify.template``.
 
 notify.changegroup
   Template to use when running as a changegroup hook, overriding
   ``notify.template``.
 
 notify.maxdiff
   Maximum number of diff lines to include in notification email. Set to 0
   to disable the diff, or -1 to include all of it. Default: 300.
 
 notify.maxdiffstat
   Maximum number of diffstat lines to include in notification email. Set to -1
   to include all of it. Default: -1.
 
 notify.maxsubject
   Maximum number of characters in email's subject line. Default: 67.
 
 notify.diffstat
   Set to True to include a diffstat before diff content. Default: True.
 
 notify.showfunc
   If set, override ``diff.showfunc`` for the diff content. Default: None.
 
 notify.merge
   If True, send notifications for merge changesets. Default: True.
 
 notify.mbox
   If set, append mails to this mbox file instead of sending. Default: None.
 
 notify.fromauthor
   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.
 
 If set, the following entries will also be used to customize the
 notifications:
 
 email.from
   Email ``From`` address to use if none can be found in the generated
   email content.
 
 web.baseurl
   Root repository URL to combine with repository paths when making
   references. See also ``notify.strip``.
 
 '''
 from __future__ import absolute_import
 
 import email.errors as emailerrors
 import email.utils as emailutils
 import fnmatch
 import hashlib
 import socket
 import time
 
 from mercurial.i18n import _
 from mercurial import (
     encoding,
     error,
     logcmdutil,
     mail,
     patch,
     pycompat,
     registrar,
     util,
 )
 from mercurial.utils import (
     dateutil,
     stringutil,
 )
 
 # Note for extension authors: ONLY specify testedwith = 'ships-with-hg-core' for
 # 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.
 testedwith = b'ships-with-hg-core'
 
 configtable = {}
 configitem = registrar.configitem(configtable)
 
 configitem(
     b'notify', b'changegroup', default=None,
 )
 configitem(
     b'notify', b'config', default=None,
 )
 configitem(
     b'notify', b'diffstat', default=True,
 )
 configitem(
     b'notify', b'domain', default=None,
 )
 configitem(
     b'notify', b'messageidseed', default=None,
 )
 configitem(
     b'notify', b'fromauthor', default=None,
 )
 configitem(
     b'notify', b'incoming', default=None,
 )
 configitem(
     b'notify', b'maxdiff', default=300,
 )
 configitem(
     b'notify', b'maxdiffstat', default=-1,
 )
 configitem(
     b'notify', b'maxsubject', default=67,
 )
 configitem(
     b'notify', b'mbox', default=None,
 )
 configitem(
     b'notify', b'merge', default=True,
 )
 configitem(
     b'notify', b'outgoing', default=None,
 )
 configitem(
     b'notify', b'sources', default=b'serve',
 )
 configitem(
     b'notify', b'showfunc', default=None,
 )
 configitem(
     b'notify', b'strip', default=0,
 )
 configitem(
     b'notify', b'style', default=None,
 )
 configitem(
     b'notify', b'template', default=None,
 )
 configitem(
     b'notify', b'test', default=True,
 )
 
 # template for single changeset can include email headers.
 single_template = b'''
 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 = b'''
 changeset {node|short} in {root}
 details: {baseurl}{webroot}?cmd=changeset;node={node|short}
 summary: {desc|firstline}
 '''
 
 deftemplates = {
     b'changegroup': multiple_template,
 }
 
 
 class notifier(object):
     '''email notification class.'''
 
     def __init__(self, ui, repo, hooktype):
         self.ui = ui
         cfg = self.ui.config(b'notify', b'config')
         if cfg:
             self.ui.readconfig(cfg, sections=[b'usersubs', b'reposubs'])
         self.repo = repo
         self.stripcount = int(self.ui.config(b'notify', b'strip'))
         self.root = self.strip(self.repo.root)
         self.domain = self.ui.config(b'notify', b'domain')
         self.mbox = self.ui.config(b'notify', b'mbox')
         self.test = self.ui.configbool(b'notify', b'test')
         self.charsets = mail._charsets(self.ui)
         self.subs = self.subscribers()
         self.merge = self.ui.configbool(b'notify', b'merge')
         self.showfunc = self.ui.configbool(b'notify', b'showfunc')
         self.messageidseed = self.ui.config(b'notify', b'messageidseed')
         if self.showfunc is None:
             self.showfunc = self.ui.configbool(b'diff', b'showfunc')
 
         mapfile = None
         template = self.ui.config(b'notify', hooktype) or self.ui.config(
             b'notify', b'template'
         )
         if not template:
             mapfile = self.ui.config(b'notify', b'style')
         if not mapfile and not template:
             template = deftemplates.get(hooktype) or single_template
         spec = logcmdutil.templatespec(template, mapfile)
         self.t = logcmdutil.changesettemplater(self.ui, self.repo, spec)
 
     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(b'/')
             if c == -1:
                 break
             path = path[c + 1 :]
             count -= 1
         return path
 
     def fixmail(self, addr):
         '''try to clean up email addresses.'''
 
         addr = stringutil.email(addr.strip())
         if self.domain:
             a = addr.find(b'@localhost')
             if a != -1:
                 addr = addr[:a]
             if b'@' not in addr:
                 return addr + b'@' + self.domain
         return addr
 
     def subscribers(self):
         '''return list of email addresses of subscribers to this repo.'''
         subs = set()
         for user, pats in self.ui.configitems(b'usersubs'):
             for pat in pats.split(b','):
                 if b'#' in pat:
                     pat, revs = pat.split(b'#', 1)
                 else:
                     revs = None
                 if fnmatch.fnmatch(self.repo.root, pat.strip()):
                     subs.add((self.fixmail(user), revs))
         for pat, users in self.ui.configitems(b'reposubs'):
             if b'#' in pat:
                 pat, revs = pat.split(b'#', 1)
             else:
                 revs = None
             if fnmatch.fnmatch(self.repo.root, pat):
                 for user in users.split(b','):
                     subs.add((self.fixmail(user), revs))
         return [
             (mail.addressencode(self.ui, s, self.charsets, self.test), r)
             for s, r in sorted(subs)
         ]
 
     def node(self, ctx, **props):
         '''format one changeset, unless it is a suppressed merge.'''
         if not self.merge and len(ctx.parents()) > 1:
             return False
         self.t.show(
             ctx,
             changes=ctx.changeset(),
             baseurl=self.ui.config(b'web', b'baseurl'),
             root=self.repo.root,
             webroot=self.root,
             **props
         )
         return True
 
     def skipsource(self, source):
         '''true if incoming changes from this source should be skipped.'''
         ok_sources = self.ui.config(b'notify', b'sources').split()
         return source not in ok_sources
 
     def send(self, ctx, count, data):
         '''send message.'''
 
         # Select subscribers by revset
         subs = set()
         for sub, spec in self.subs:
             if spec is None:
                 subs.add(sub)
                 continue
             revs = self.repo.revs(b'%r and %d:', spec, ctx.rev())
             if len(revs):
                 subs.add(sub)
                 continue
         if len(subs) == 0:
             self.ui.debug(
                 b'notify: no subscribers to selected repo and revset\n'
             )
             return
 
         try:
             msg = mail.parsebytes(data)
         except emailerrors.MessageParseError as inst:
             raise error.Abort(inst)
 
         # store sender and subject
         sender = msg['From']
         subject = msg['Subject']
         if sender is not None:
             sender = mail.headdecode(sender)
         if subject is not None:
             subject = mail.headdecode(subject)
         del msg['From'], msg['Subject']
 
         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(decode=pycompat.ispy3)
             # 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
 
         msg['Date'] = encoding.strfromlocal(
             dateutil.datestr(format=b"%a, %d %b %Y %H:%M:%S %1%2")
         )
 
         # try to make subject line exist and be useful
         if not subject:
             if count > 1:
                 subject = _(b'%s: %d new changesets') % (self.root, count)
             else:
                 s = ctx.description().lstrip().split(b'\n', 1)[0].rstrip()
                 subject = b'%s: %s' % (self.root, s)
         maxsubject = int(self.ui.config(b'notify', b'maxsubject'))
         if maxsubject:
             subject = stringutil.ellipsis(subject, maxsubject)
         msg['Subject'] = mail.headencode(
             self.ui, subject, self.charsets, self.test
         )
 
         # try to make message have proper sender
         if not sender:
             sender = self.ui.config(b'email', b'from') or self.ui.username()
         if b'@' not in sender or b'@localhost' in sender:
             sender = self.fixmail(sender)
-        msg['From'] = encoding.strfromlocal(
-            mail.addressencode(self.ui, sender, self.charsets, self.test)
+        msg['From'] = mail.addressencode(
+            self.ui, sender, self.charsets, self.test
         )
 
         msg['X-Hg-Notification'] = 'changeset %s' % ctx
         if not msg['Message-Id']:
             msg['Message-Id'] = messageid(ctx, self.domain, self.messageidseed)
-        msg['To'] = encoding.strfromlocal(b', '.join(sorted(subs)))
+        msg['To'] = ', '.join(sorted(subs))
 
         msgtext = msg.as_bytes() if pycompat.ispy3 else msg.as_string()
         if self.test:
             self.ui.write(msgtext)
             if not msgtext.endswith(b'\n'):
                 self.ui.write(b'\n')
         else:
             self.ui.status(
                 _(b'notify: sending %d subscribers %d changes\n')
                 % (len(subs), count)
             )
             mail.sendmail(
                 self.ui,
                 emailutils.parseaddr(msg['From'])[1],
                 subs,
                 msgtext,
                 mbox=self.mbox,
             )
 
     def diff(self, ctx, ref=None):
 
         maxdiff = int(self.ui.config(b'notify', b'maxdiff'))
         prev = ctx.p1().node()
         if ref:
             ref = ref.node()
         else:
             ref = ctx.node()
         diffopts = patch.diffallopts(self.ui)
         diffopts.showfunc = self.showfunc
         chunks = patch.diff(self.repo, prev, ref, opts=diffopts)
         difflines = b''.join(chunks).splitlines()
 
         if self.ui.configbool(b'notify', b'diffstat'):
             maxdiffstat = int(self.ui.config(b'notify', b'maxdiffstat'))
             s = patch.diffstat(difflines)
             # s may be nil, don't include the header if it is
             if s:
                 if maxdiffstat >= 0 and s.count(b"\n") > maxdiffstat + 1:
                     s = s.split(b"\n")
                     msg = _(b'\ndiffstat (truncated from %d to %d lines):\n\n')
                     self.ui.write(msg % (len(s) - 2, maxdiffstat))
                     self.ui.write(b"\n".join(s[:maxdiffstat] + s[-2:]))
                 else:
                     self.ui.write(_(b'\ndiffstat:\n\n%s') % s)
 
         if maxdiff == 0:
             return
         elif maxdiff > 0 and len(difflines) > maxdiff:
             msg = _(b'\ndiffs (truncated from %d to %d lines):\n\n')
             self.ui.write(msg % (len(difflines), maxdiff))
             difflines = difflines[:maxdiff]
         elif difflines:
             self.ui.write(_(b'\ndiffs (%d lines):\n\n') % len(difflines))
 
         self.ui.write(b"\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)
     ctx = repo.unfiltered()[node]
 
     if not n.subs:
         ui.debug(b'notify: no subscribers to repository %s\n' % n.root)
         return
     if n.skipsource(source):
         ui.debug(b'notify: changes have source "%s" - skipping\n' % source)
         return
 
     ui.pushbuffer()
     data = b''
     count = 0
     author = b''
     if hooktype == b'changegroup' or hooktype == b'outgoing':
         for rev in repo.changelog.revs(start=ctx.rev()):
             if n.node(repo[rev]):
                 count += 1
                 if not author:
                     author = repo[rev].user()
             else:
                 data += ui.popbuffer()
                 ui.note(
                     _(b'notify: suppressing notification for merge %d:%s\n')
                     % (rev, repo[rev].hex()[:12])
                 )
                 ui.pushbuffer()
         if count:
             n.diff(ctx, repo[b'tip'])
     elif ctx.rev() in repo:
         if not n.node(ctx):
             ui.popbuffer()
             ui.note(
                 _(b'notify: suppressing notification for merge %d:%s\n')
                 % (ctx.rev(), ctx.hex()[:12])
             )
             return
         count += 1
         n.diff(ctx)
         if not author:
             author = ctx.user()
 
     data += ui.popbuffer()
     fromauthor = ui.config(b'notify', b'fromauthor')
     if author and fromauthor:
         data = b'\n'.join([b'From: %s' % author, data])
 
     if count:
         n.send(ctx, count, data)
 
 
 def messageid(ctx, domain, messageidseed):
     if domain and messageidseed:
         host = domain
     else:
         host = encoding.strtolocal(socket.getfqdn())
     if messageidseed:
         messagehash = hashlib.sha512(ctx.hex() + messageidseed)
         messageid = b'<hg.%s@%s>' % (
             pycompat.sysbytes(messagehash.hexdigest()[:64]),
             host,
         )
     else:
         messageid = b'<hg.%s.%d.%d@%s>' % (
             ctx,
             int(time.time()),
             hash(ctx.repo().root),
             host,
         )
     return encoding.strfromlocal(messageid)

hgext/patchbomb.py

@@ -1,998 +1,997
 # patchbomb.py - sending Mercurial changesets as patch emails
 #
 #  Copyright 2005-2009 Matt Mackall <[e-mail]> and others
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 '''command to send 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 changeset description.
 - [Optional] The result of running diffstat on the patch.
 - The patch itself, as generated by :hg:`export`.
 
 Each message refers to the first in the series 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.
 
 To configure other defaults, add a section like this to your
 configuration file::
 
   [email]
   from = My Name <my@email>
   to = recipient1, recipient2, ...
   cc = cc1, cc2, ...
   bcc = bcc1, bcc2, ...
   reply-to = address1, address2, ...
 
 Use ``[patchbomb]`` as configuration section name if you need to
 override global ``[email]`` address settings.
 
 Then you can use the :hg:`email` command to mail a series of
 changesets as a patchbomb.
 
 You can also either configure the method option in the email section
 to be a sendmail compatible mailer or fill out the [smtp] section so
 that the patchbomb extension can automatically send patchbombs
 directly from the commandline. See the [email] and [smtp] sections in
 hgrc(5) for details.
 
 By default, :hg:`email` will prompt for a ``To`` or ``CC`` header if
 you do not supply one via configuration or the command line.  You can
 override this to never prompt by configuring an empty value::
 
   [email]
   cc =
 
 You can control the default inclusion of an introduction message with the
 ``patchbomb.intro`` configuration option. The configuration is always
 overwritten by command line flags like --intro and --desc::
 
   [patchbomb]
   intro=auto   # include introduction message if more than 1 patch (default)
   intro=never  # never include an introduction message
   intro=always # always include an introduction message
 
 You can specify a template for flags to be added in subject prefixes. Flags
 specified by --flag option are exported as ``{flags}`` keyword::
 
   [patchbomb]
   flagtemplate = "{separate(' ',
                             ifeq(branch, 'default', '', branch|upper),
                             flags)}"
 
 You can set patchbomb to always ask for confirmation by setting
 ``patchbomb.confirm`` to true.
 '''
 from __future__ import absolute_import
 
 import email.encoders as emailencoders
 import email.mime.base as emimebase
 import email.mime.multipart as emimemultipart
 import email.utils as eutil
 import errno
 import os
 import socket
 
 from mercurial.i18n import _
 from mercurial.pycompat import open
 from mercurial import (
     cmdutil,
     commands,
     encoding,
     error,
     formatter,
     hg,
     mail,
     node as nodemod,
     patch,
     pycompat,
     registrar,
     scmutil,
     templater,
     util,
 )
 from mercurial.utils import dateutil
 
 stringio = util.stringio
 
 cmdtable = {}
 command = registrar.command(cmdtable)
 
 configtable = {}
 configitem = registrar.configitem(configtable)
 
 configitem(
     b'patchbomb', b'bundletype', default=None,
 )
 configitem(
     b'patchbomb', b'bcc', default=None,
 )
 configitem(
     b'patchbomb', b'cc', default=None,
 )
 configitem(
     b'patchbomb', b'confirm', default=False,
 )
 configitem(
     b'patchbomb', b'flagtemplate', default=None,
 )
 configitem(
     b'patchbomb', b'from', default=None,
 )
 configitem(
     b'patchbomb', b'intro', default=b'auto',
 )
 configitem(
     b'patchbomb', b'publicurl', default=None,
 )
 configitem(
     b'patchbomb', b'reply-to', default=None,
 )
 configitem(
     b'patchbomb', b'to', default=None,
 )
 
 # Note for extension authors: ONLY specify testedwith = 'ships-with-hg-core' for
 # 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.
 testedwith = b'ships-with-hg-core'
 
 
 def _addpullheader(seq, ctx):
     """Add a header pointing to a public URL where the changeset is available
     """
     repo = ctx.repo()
     # experimental config: patchbomb.publicurl
     # waiting for some logic that check that the changeset are available on the
     # destination before patchbombing anything.
     publicurl = repo.ui.config(b'patchbomb', b'publicurl')
     if publicurl:
         return b'Available At %s\n#              hg pull %s -r %s' % (
             publicurl,
             publicurl,
             ctx,
         )
     return None
 
 
 def uisetup(ui):
     cmdutil.extraexport.append(b'pullurl')
     cmdutil.extraexportmap[b'pullurl'] = _addpullheader
 
 
 def reposetup(ui, repo):
     if not repo.local():
         return
     repo._wlockfreeprefix.add(b'last-email.txt')
 
 
 def prompt(ui, prompt, default=None, rest=b':'):
     if default:
         prompt += b' [%s]' % default
     return ui.prompt(prompt + rest, default)
 
 
 def introwanted(ui, opts, number):
     '''is an introductory message apparently wanted?'''
     introconfig = ui.config(b'patchbomb', b'intro')
     if opts.get(b'intro') or opts.get(b'desc'):
         intro = True
     elif introconfig == b'always':
         intro = True
     elif introconfig == b'never':
         intro = False
     elif introconfig == b'auto':
         intro = number > 1
     else:
         ui.write_err(
             _(b'warning: invalid patchbomb.intro value "%s"\n') % introconfig
         )
         ui.write_err(_(b'(should be one of always, never, auto)\n'))
         intro = number > 1
     return intro
 
 
 def _formatflags(ui, repo, rev, flags):
     """build flag string optionally by template"""
     tmpl = ui.config(b'patchbomb', b'flagtemplate')
     if not tmpl:
         return b' '.join(flags)
     out = util.stringio()
     spec = formatter.templatespec(b'', templater.unquotestring(tmpl), None)
     with formatter.templateformatter(ui, out, b'patchbombflag', {}, spec) as fm:
         fm.startitem()
         fm.context(ctx=repo[rev])
         fm.write(b'flags', b'%s', fm.formatlist(flags, name=b'flag'))
     return out.getvalue()
 
 
 def _formatprefix(ui, repo, rev, flags, idx, total, numbered):
     """build prefix to patch subject"""
     flag = _formatflags(ui, repo, rev, flags)
     if flag:
         flag = b' ' + flag
 
     if not numbered:
         return b'[PATCH%s]' % flag
     else:
         tlen = len(b"%d" % total)
         return b'[PATCH %0*d of %d%s]' % (tlen, idx, total, flag)
 
 
 def makepatch(
     ui,
     repo,
     rev,
     patchlines,
     opts,
     _charsets,
     idx,
     total,
     numbered,
     patchname=None,
 ):
 
     desc = []
     node = None
     body = b''
 
     for line in patchlines:
         if line.startswith(b'#'):
             if line.startswith(b'# Node ID'):
                 node = line.split()[-1]
             continue
         if line.startswith(b'diff -r') or line.startswith(b'diff --git'):
             break
         desc.append(line)
 
     if not patchname and not node:
         raise ValueError
 
     if opts.get(b'attach') and not opts.get(b'body'):
         body = (
             b'\n'.join(desc[1:]).strip()
             or b'Patch subject is complete summary.'
         )
         body += b'\n\n\n'
 
     if opts.get(b'plain'):
         while patchlines and patchlines[0].startswith(b'# '):
             patchlines.pop(0)
         if patchlines:
             patchlines.pop(0)
         while patchlines and not patchlines[0].strip():
             patchlines.pop(0)
 
     ds = patch.diffstat(patchlines)
     if opts.get(b'diffstat'):
         body += ds + b'\n\n'
 
     addattachment = opts.get(b'attach') or opts.get(b'inline')
     if not addattachment or opts.get(b'body'):
         body += b'\n'.join(patchlines)
 
     if addattachment:
         msg = emimemultipart.MIMEMultipart()
         if body:
             msg.attach(mail.mimeencode(ui, body, _charsets, opts.get(b'test')))
         p = mail.mimetextpatch(
             b'\n'.join(patchlines), b'x-patch', opts.get(b'test')
         )
         binnode = nodemod.bin(node)
         # if node is mq patch, it will have the patch file's name as a tag
         if not patchname:
             patchtags = [
                 t
                 for t in repo.nodetags(binnode)
                 if t.endswith(b'.patch') or t.endswith(b'.diff')
             ]
             if patchtags:
                 patchname = patchtags[0]
             elif total > 1:
                 patchname = cmdutil.makefilename(
                     repo[node], b'%b-%n.patch', seqno=idx, total=total
                 )
             else:
                 patchname = cmdutil.makefilename(repo[node], b'%b.patch')
         disposition = r'inline'
         if opts.get(b'attach'):
             disposition = r'attachment'
         p['Content-Disposition'] = (
             disposition + '; filename=' + encoding.strfromlocal(patchname)
         )
         msg.attach(p)
     else:
         msg = mail.mimetextpatch(body, display=opts.get(b'test'))
 
     prefix = _formatprefix(
         ui, repo, rev, opts.get(b'flag'), idx, total, numbered
     )
     subj = desc[0].strip().rstrip(b'. ')
     if not numbered:
         subj = b' '.join([prefix, opts.get(b'subject') or subj])
     else:
         subj = b' '.join([prefix, subj])
     msg[b'Subject'] = mail.headencode(ui, subj, _charsets, opts.get(b'test'))
     msg[b'X-Mercurial-Node'] = node
     msg[b'X-Mercurial-Series-Index'] = b'%i' % idx
     msg[b'X-Mercurial-Series-Total'] = b'%i' % total
     return msg, subj, ds
 
 
 def _getpatches(repo, revs, **opts):
     """return a list of patches for a list of revisions
 
     Each patch in the list is itself a list of lines.
     """
     ui = repo.ui
     prev = repo[b'.'].rev()
     for r in revs:
         if r == prev and (repo[None].files() or repo[None].deleted()):
             ui.warn(_(b'warning: working directory has uncommitted changes\n'))
         output = stringio()
         cmdutil.exportfile(
             repo, [r], output, opts=patch.difffeatureopts(ui, opts, git=True)
         )
         yield output.getvalue().split(b'\n')
 
 
 def _getbundle(repo, dest, **opts):
     """return a bundle containing changesets missing in "dest"
 
     The `opts` keyword-arguments are the same as the one accepted by the
     `bundle` command.
 
     The bundle is a returned as a single in-memory binary blob.
     """
     ui = repo.ui
     tmpdir = pycompat.mkdtemp(prefix=b'hg-email-bundle-')
     tmpfn = os.path.join(tmpdir, b'bundle')
     btype = ui.config(b'patchbomb', b'bundletype')
     if btype:
         opts['type'] = btype
     try:
         commands.bundle(ui, repo, tmpfn, dest, **opts)
         return util.readfile(tmpfn)
     finally:
         try:
             os.unlink(tmpfn)
         except OSError:
             pass
         os.rmdir(tmpdir)
 
 
 def _getdescription(repo, defaultbody, sender, **opts):
     """obtain the body of the introduction message and return it
 
     This is also used for the body of email with an attached bundle.
 
     The body can be obtained either from the command line option or entered by
     the user through the editor.
     """
     ui = repo.ui
     if opts.get('desc'):
         body = open(opts.get('desc')).read()
     else:
         ui.write(
             _(b'\nWrite the introductory message for the patch series.\n\n')
         )
         body = ui.edit(
             defaultbody, sender, repopath=repo.path, action=b'patchbombbody'
         )
         # Save series description in case sendmail fails
         msgfile = repo.vfs(b'last-email.txt', b'wb')
         msgfile.write(body)
         msgfile.close()
     return body
 
 
 def _getbundlemsgs(repo, sender, bundle, **opts):
     """Get the full email for sending a given bundle
 
     This function returns a list of "email" tuples (subject, content, None).
     The list is always one message long in that case.
     """
     ui = repo.ui
     _charsets = mail._charsets(ui)
     subj = opts.get('subject') or prompt(
         ui, b'Subject:', b'A bundle for your repository'
     )
 
     body = _getdescription(repo, b'', sender, **opts)
     msg = emimemultipart.MIMEMultipart()
     if body:
         msg.attach(mail.mimeencode(ui, body, _charsets, opts.get('test')))
     datapart = emimebase.MIMEBase('application', 'x-mercurial-bundle')
     datapart.set_payload(bundle)
     bundlename = b'%s.hg' % opts.get('bundlename', b'bundle')
     datapart.add_header(
         'Content-Disposition',
         'attachment',
         filename=encoding.strfromlocal(bundlename),
     )
     emailencoders.encode_base64(datapart)
     msg.attach(datapart)
     msg[b'Subject'] = mail.headencode(ui, subj, _charsets, opts.get('test'))
     return [(msg, subj, None)]
 
 
 def _makeintro(repo, sender, revs, patches, **opts):
     """make an introduction email, asking the user for content if needed
 
     email is returned as (subject, body, cumulative-diffstat)"""
     ui = repo.ui
     _charsets = mail._charsets(ui)
 
     # use the last revision which is likely to be a bookmarked head
     prefix = _formatprefix(
         ui, repo, revs.last(), opts.get('flag'), 0, len(patches), numbered=True
     )
     subj = opts.get('subject') or prompt(
         ui, b'(optional) Subject: ', rest=prefix, default=b''
     )
     if not subj:
         return None  # skip intro if the user doesn't bother
 
     subj = prefix + b' ' + subj
 
     body = b''
     if opts.get('diffstat'):
         # generate a cumulative diffstat of the whole patch series
         diffstat = patch.diffstat(sum(patches, []))
         body = b'\n' + diffstat
     else:
         diffstat = None
 
     body = _getdescription(repo, body, sender, **opts)
     msg = mail.mimeencode(ui, body, _charsets, opts.get('test'))
     msg[b'Subject'] = mail.headencode(ui, subj, _charsets, opts.get('test'))
     return (msg, subj, diffstat)
 
 
 def _getpatchmsgs(repo, sender, revs, patchnames=None, **opts):
     """return a list of emails from a list of patches
 
     This involves introduction message creation if necessary.
 
     This function returns a list of "email" tuples (subject, content, None).
     """
     bytesopts = pycompat.byteskwargs(opts)
     ui = repo.ui
     _charsets = mail._charsets(ui)
     patches = list(_getpatches(repo, revs, **opts))
     msgs = []
 
     ui.write(_(b'this patch series consists of %d patches.\n\n') % len(patches))
 
     # build the intro message, or skip it if the user declines
     if introwanted(ui, bytesopts, len(patches)):
         msg = _makeintro(repo, sender, revs, patches, **opts)
         if msg:
             msgs.append(msg)
 
     # are we going to send more than one message?
     numbered = len(msgs) + len(patches) > 1
 
     # now generate the actual patch messages
     name = None
     assert len(revs) == len(patches)
     for i, (r, p) in enumerate(zip(revs, patches)):
         if patchnames:
             name = patchnames[i]
         msg = makepatch(
             ui,
             repo,
             r,
             p,
             bytesopts,
             _charsets,
             i + 1,
             len(patches),
             numbered,
             name,
         )
         msgs.append(msg)
 
     return msgs
 
 
 def _getoutgoing(repo, dest, revs):
     '''Return the revisions present locally but not in dest'''
     ui = repo.ui
     url = ui.expandpath(dest or b'default-push', dest or b'default')
     url = hg.parseurl(url)[0]
     ui.status(_(b'comparing with %s\n') % util.hidepassword(url))
 
     revs = [r for r in revs if r >= 0]
     if not revs:
         revs = [repo.changelog.tiprev()]
     revs = repo.revs(b'outgoing(%s) and ::%ld', dest or b'', revs)
     if not revs:
         ui.status(_(b"no changes found\n"))
     return revs
 
 
 def _msgid(node, timestamp):
     hostname = encoding.strtolocal(socket.getfqdn())
     hostname = encoding.environ.get(b'HGHOSTNAME', hostname)
     return b'<%s.%d@%s>' % (node, timestamp, hostname)
 
 
 emailopts = [
     (b'', b'body', None, _(b'send patches as inline message text (default)')),
     (b'a', b'attach', None, _(b'send patches as attachments')),
     (b'i', b'inline', None, _(b'send patches as inline attachments')),
     (
         b'',
         b'bcc',
         [],
         _(b'email addresses of blind carbon copy recipients'),
         _(b'EMAIL'),
     ),
     (b'c', b'cc', [], _(b'email addresses of copy recipients'), _(b'EMAIL')),
     (b'', b'confirm', None, _(b'ask for confirmation before sending')),
     (b'd', b'diffstat', None, _(b'add diffstat output to messages')),
     (
         b'',
         b'date',
         b'',
         _(b'use the given date as the sending date'),
         _(b'DATE'),
     ),
     (
         b'',
         b'desc',
         b'',
         _(b'use the given file as the series description'),
         _(b'FILE'),
     ),
     (b'f', b'from', b'', _(b'email address of sender'), _(b'EMAIL')),
     (b'n', b'test', None, _(b'print messages that would be sent')),
     (
         b'm',
         b'mbox',
         b'',
         _(b'write messages to mbox file instead of sending them'),
         _(b'FILE'),
     ),
     (
         b'',
         b'reply-to',
         [],
         _(b'email addresses replies should be sent to'),
         _(b'EMAIL'),
     ),
     (
         b's',
         b'subject',
         b'',
         _(b'subject of first message (intro or single patch)'),
         _(b'TEXT'),
     ),
     (
         b'',
         b'in-reply-to',
         b'',
         _(b'message identifier to reply to'),
         _(b'MSGID'),
     ),
     (b'', b'flag', [], _(b'flags to add in subject prefixes'), _(b'FLAG')),
     (b't', b'to', [], _(b'email addresses of recipients'), _(b'EMAIL')),
 ]
 
 
 @command(
     b'email',
     [
         (b'g', b'git', None, _(b'use git extended diff format')),
         (b'', b'plain', None, _(b'omit hg patch header')),
         (
             b'o',
             b'outgoing',
             None,
             _(b'send changes not found in the target repository'),
         ),
         (
             b'b',
             b'bundle',
             None,
             _(b'send changes not in target as a binary bundle'),
         ),
         (
             b'B',
             b'bookmark',
             b'',
             _(b'send changes only reachable by given bookmark'),
             _(b'BOOKMARK'),
         ),
         (
             b'',
             b'bundlename',
             b'bundle',
             _(b'name of the bundle attachment file'),
             _(b'NAME'),
         ),
         (b'r', b'rev', [], _(b'a revision to send'), _(b'REV')),
         (
             b'',
             b'force',
             None,
             _(
                 b'run even when remote repository is unrelated '
                 b'(with -b/--bundle)'
             ),
         ),
         (
             b'',
             b'base',
             [],
             _(
                 b'a base changeset to specify instead of a destination '
                 b'(with -b/--bundle)'
             ),
             _(b'REV'),
         ),
         (
             b'',
             b'intro',
             None,
             _(b'send an introduction email for a single patch'),
         ),
     ]
     + emailopts
     + cmdutil.remoteopts,
     _(b'hg email [OPTION]... [DEST]...'),
     helpcategory=command.CATEGORY_IMPORT_EXPORT,
 )
 def email(ui, repo, *revs, **opts):
     '''send changesets by email
 
     By default, diffs are sent in the format generated by
     :hg:`export`, one per message. 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 parts. First, the changeset
     description.
 
     With the -d/--diffstat option, if the diffstat program is
     installed, the result of running diffstat on the patch is inserted.
 
     Finally, the patch itself, as generated by :hg:`export`.
 
     With the -d/--diffstat or --confirm options, you will be presented
     with a final summary of all messages and asked for confirmation before
     the messages are sent.
 
     By default the patch is included as text in the email body for
     easy reviewing. Using the -a/--attach option will instead create
     an attachment for the patch. With -i/--inline an inline attachment
     will be created. You can include a patch both as text in the email
     body and as a regular or an inline attachment by combining the
     -a/--attach or -i/--inline with the --body option.
 
     With -B/--bookmark changesets reachable by the given bookmark are
     selected.
 
     With -o/--outgoing, emails will be generated for patches not found
     in the destination repository (or only those which are ancestors
     of the specified revisions if any are provided)
 
     With -b/--bundle, changesets are selected as for --outgoing, but a
     single email containing a binary Mercurial bundle as an attachment
     will be sent. Use the ``patchbomb.bundletype`` config option to
     control the bundle type as with :hg:`bundle --type`.
 
     With -m/--mbox, 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.
 
     With -n/--test, all steps will run, but mail will not be sent.
     You will be prompted for an email recipient address, a subject and
     an introductory message describing the patches of your patchbomb.
     Then when all is done, patchbomb messages are displayed.
 
     In case email sending fails, you will find a backup of your series
     introductory message in ``.hg/last-email.txt``.
 
     The default behavior of this command can be customized through
     configuration. (See :hg:`help patchbomb` for details)
 
     Examples::
 
       hg email -r 3000          # send patch 3000 only
       hg email -r 3000 -r 3001  # send patches 3000 and 3001
       hg email -r 3000:3005     # send patches 3000 through 3005
       hg email 3000             # send patch 3000 (deprecated)
 
       hg email -o               # send all patches not in default
       hg email -o DEST          # send all patches not in DEST
       hg email -o -r 3000       # send all ancestors of 3000 not in default
       hg email -o -r 3000 DEST  # send all ancestors of 3000 not in DEST
 
       hg email -B feature       # send all ancestors of feature bookmark
 
       hg email -b               # send bundle of all patches not in default
       hg email -b DEST          # send bundle of all patches not in DEST
       hg email -b -r 3000       # bundle of all ancestors of 3000 not in default
       hg email -b -r 3000 DEST  # bundle of all ancestors of 3000 not in DEST
 
       hg email -o -m mbox &&    # generate an mbox file...
         mutt -R -f mbox         # ... and view it with mutt
       hg email -o -m mbox &&    # generate an mbox file ...
         formail -s sendmail \\   # ... and use formail to send from the mbox
           -bm -t < mbox         # ... using sendmail
 
     Before using this command, you will need to enable email in your
     hgrc. See the [email] section in hgrc(5) for details.
     '''
     opts = pycompat.byteskwargs(opts)
 
     _charsets = mail._charsets(ui)
 
     bundle = opts.get(b'bundle')
     date = opts.get(b'date')
     mbox = opts.get(b'mbox')
     outgoing = opts.get(b'outgoing')
     rev = opts.get(b'rev')
     bookmark = opts.get(b'bookmark')
 
     if not (opts.get(b'test') or mbox):
         # really sending
         mail.validateconfig(ui)
 
     if not (revs or rev or outgoing or bundle or bookmark):
         raise error.Abort(
             _(b'specify at least one changeset with -B, -r or -o')
         )
 
     if outgoing and bundle:
         raise error.Abort(
             _(
                 b"--outgoing mode always on with --bundle;"
                 b" do not re-specify --outgoing"
             )
         )
     if rev and bookmark:
         raise error.Abort(_(b"-r and -B are mutually exclusive"))
 
     if outgoing or bundle:
         if len(revs) > 1:
             raise error.Abort(_(b"too many destinations"))
         if revs:
             dest = revs[0]
         else:
             dest = None
         revs = []
 
     if rev:
         if revs:
             raise error.Abort(_(b'use only one form to specify the revision'))
         revs = rev
     elif bookmark:
         if bookmark not in repo._bookmarks:
             raise error.Abort(_(b"bookmark '%s' not found") % bookmark)
         revs = scmutil.bookmarkrevs(repo, bookmark)
 
     revs = scmutil.revrange(repo, revs)
     if outgoing:
         revs = _getoutgoing(repo, dest, revs)
     if bundle:
         opts[b'revs'] = [b"%d" % r for r in revs]
 
     # check if revision exist on the public destination
     publicurl = repo.ui.config(b'patchbomb', b'publicurl')
     if publicurl:
         repo.ui.debug(b'checking that revision exist in the public repo\n')
         try:
             publicpeer = hg.peer(repo, {}, publicurl)
         except error.RepoError:
             repo.ui.write_err(
                 _(b'unable to access public repo: %s\n') % publicurl
             )
             raise
         if not publicpeer.capable(b'known'):
             repo.ui.debug(b'skipping existence checks: public repo too old\n')
         else:
             out = [repo[r] for r in revs]
             known = publicpeer.known(h.node() for h in out)
             missing = []
             for idx, h in enumerate(out):
                 if not known[idx]:
                     missing.append(h)
             if missing:
                 if len(missing) > 1:
                     msg = _(b'public "%s" is missing %s and %i others')
                     msg %= (publicurl, missing[0], len(missing) - 1)
                 else:
                     msg = _(b'public url %s is missing %s')
                     msg %= (publicurl, missing[0])
                 missingrevs = [ctx.rev() for ctx in missing]
                 revhint = b' '.join(
                     b'-r %s' % h for h in repo.set(b'heads(%ld)', missingrevs)
                 )
                 hint = _(b"use 'hg push %s %s'") % (publicurl, revhint)
                 raise error.Abort(msg, hint=hint)
 
     # start
     if date:
         start_time = dateutil.parsedate(date)
     else:
         start_time = dateutil.makedate()
 
     def genmsgid(id):
         return _msgid(id[:20], int(start_time[0]))
 
     # deprecated config: patchbomb.from
     sender = (
         opts.get(b'from')
         or ui.config(b'email', b'from')
         or ui.config(b'patchbomb', b'from')
         or prompt(ui, b'From', ui.username())
     )
 
     if bundle:
         stropts = pycompat.strkwargs(opts)
         bundledata = _getbundle(repo, dest, **stropts)
         bundleopts = stropts.copy()
         bundleopts.pop('bundle', None)  # already processed
         msgs = _getbundlemsgs(repo, sender, bundledata, **bundleopts)
     else:
         msgs = _getpatchmsgs(repo, sender, revs, **pycompat.strkwargs(opts))
 
     showaddrs = []
 
     def getaddrs(header, ask=False, default=None):
         configkey = header.lower()
         opt = header.replace(b'-', b'_').lower()
         addrs = opts.get(opt)
         if addrs:
             showaddrs.append(b'%s: %s' % (header, b', '.join(addrs)))
             return mail.addrlistencode(ui, addrs, _charsets, opts.get(b'test'))
 
         # not on the command line: fallback to config and then maybe ask
         addr = ui.config(b'email', configkey) or ui.config(
             b'patchbomb', configkey
         )
         if not addr:
             specified = ui.hasconfig(b'email', configkey) or ui.hasconfig(
                 b'patchbomb', configkey
             )
             if not specified and ask:
                 addr = prompt(ui, header, default=default)
         if addr:
             showaddrs.append(b'%s: %s' % (header, addr))
             return mail.addrlistencode(ui, [addr], _charsets, opts.get(b'test'))
         elif default:
             return mail.addrlistencode(
                 ui, [default], _charsets, opts.get(b'test')
             )
         return []
 
     to = getaddrs(b'To', ask=True)
     if not to:
         # we can get here in non-interactive mode
         raise error.Abort(_(b'no recipient addresses provided'))
     cc = getaddrs(b'Cc', ask=True, default=b'')
     bcc = getaddrs(b'Bcc')
     replyto = getaddrs(b'Reply-To')
 
     confirm = ui.configbool(b'patchbomb', b'confirm')
     confirm |= bool(opts.get(b'diffstat') or opts.get(b'confirm'))
 
     if confirm:
         ui.write(_(b'\nFinal summary:\n\n'), label=b'patchbomb.finalsummary')
         ui.write((b'From: %s\n' % sender), label=b'patchbomb.from')
         for addr in showaddrs:
             ui.write(b'%s\n' % addr, label=b'patchbomb.to')
         for m, subj, ds in msgs:
             ui.write((b'Subject: %s\n' % subj), label=b'patchbomb.subject')
             if ds:
                 ui.write(ds, label=b'patchbomb.diffstats')
         ui.write(b'\n')
         if ui.promptchoice(
             _(b'are you sure you want to send (yn)?$$ &Yes $$ &No')
         ):
             raise error.Abort(_(b'patchbomb canceled'))
 
     ui.write(b'\n')
 
     parent = opts.get(b'in_reply_to') or None
     # angle brackets may be omitted, they're not semantically part of the msg-id
     if parent is not None:
         if not parent.startswith(b'<'):
             parent = b'<' + parent
         if not parent.endswith(b'>'):
             parent += b'>'
 
     sender_addr = eutil.parseaddr(encoding.strfromlocal(sender))[1]
     sender = mail.addressencode(ui, sender, _charsets, opts.get(b'test'))
     sendmail = None
     firstpatch = None
     progress = ui.makeprogress(
         _(b'sending'), unit=_(b'emails'), total=len(msgs)
     )
     for i, (m, subj, ds) in enumerate(msgs):
         try:
             m[b'Message-Id'] = genmsgid(m[b'X-Mercurial-Node'])
             if not firstpatch:
                 firstpatch = m[b'Message-Id']
             m[b'X-Mercurial-Series-Id'] = firstpatch
         except TypeError:
             m[b'Message-Id'] = genmsgid(b'patchbomb')
         if parent:
             m[b'In-Reply-To'] = parent
             m[b'References'] = parent
         if not parent or b'X-Mercurial-Node' not in m:
             parent = m[b'Message-Id']
 
         m[b'User-Agent'] = b'Mercurial-patchbomb/%s' % util.version()
         m[b'Date'] = eutil.formatdate(start_time[0], localtime=True)
 
         start_time = (start_time[0] + 1, start_time[1])
         m[b'From'] = sender
-        m[b'To'] = b', '.join(to)
+        m[b'To'] = ', '.join(to)
         if cc:
-            m[b'Cc'] = b', '.join(cc)
+            m[b'Cc'] = ', '.join(cc)
         if bcc:
-            m[b'Bcc'] = b', '.join(bcc)
+            m[b'Bcc'] = ', '.join(bcc)
         if replyto:
-            m[b'Reply-To'] = b', '.join(replyto)
+            m[b'Reply-To'] = ', '.join(replyto)
         # Fix up all headers to be native strings.
         # TODO(durin42): this should probably be cleaned up above in the future.
         if pycompat.ispy3:
             for hdr, val in list(m.items()):
                 change = False
                 if isinstance(hdr, bytes):
                     del m[hdr]
                     hdr = pycompat.strurl(hdr)
                     change = True
                 if isinstance(val, bytes):
                     # header value should be ASCII since it's encoded by
                     # mail.headencode(), but -n/--test disables it and raw
                     # value of platform encoding is stored.
                     val = encoding.strfromlocal(val)
                     if not change:
                         # prevent duplicate headers
                         del m[hdr]
                     change = True
                 if change:
                     m[hdr] = val
         if opts.get(b'test'):
             ui.status(_(b'displaying '), subj, b' ...\n')
             ui.pager(b'email')
             generator = mail.Generator(ui, mangle_from_=False)
             try:
                 generator.flatten(m, 0)
                 ui.write(b'\n')
             except IOError as inst:
                 if inst.errno != errno.EPIPE:
                     raise
         else:
             if not sendmail:
                 sendmail = mail.connect(ui, mbox=mbox)
             ui.status(_(b'sending '), subj, b' ...\n')
             progress.update(i, item=subj)
             if not mbox:
                 # Exim does not remove the Bcc field
                 del m[b'Bcc']
             fp = stringio()
             generator = mail.Generator(fp, mangle_from_=False)
             generator.flatten(m, 0)
             alldests = to + bcc + cc
-            alldests = [encoding.strfromlocal(d) for d in alldests]
             sendmail(sender_addr, alldests, fp.getvalue())
 
     progress.complete()

mercurial/mail.py

@@ -1,485 +1,483
 # mail.py - mail sending bits for mercurial
 #
 # Copyright 2006 Matt Mackall <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 from __future__ import absolute_import
 
 import email
 import email.charset
 import email.generator
 import email.header
 import email.message
 import email.parser
 import io
 import os
 import smtplib
 import socket
 import time
 
 from .i18n import _
 from .pycompat import (
     getattr,
     open,
 )
 from . import (
     encoding,
     error,
     pycompat,
     sslutil,
     util,
 )
 from .utils import (
     procutil,
     stringutil,
 )
 
 
 class STARTTLS(smtplib.SMTP):
     '''Derived class to verify the peer certificate for STARTTLS.
 
     This class allows to pass any keyword arguments to SSL socket creation.
     '''
 
     def __init__(self, ui, host=None, **kwargs):
         smtplib.SMTP.__init__(self, **kwargs)
         self._ui = ui
         self._host = host
 
     def starttls(self, keyfile=None, certfile=None):
         if not self.has_extn("starttls"):
             msg = b"STARTTLS extension not supported by server"
             raise smtplib.SMTPException(msg)
         (resp, reply) = self.docmd("STARTTLS")
         if resp == 220:
             self.sock = sslutil.wrapsocket(
                 self.sock,
                 keyfile,
                 certfile,
                 ui=self._ui,
                 serverhostname=self._host,
             )
             self.file = self.sock.makefile("rb")
             self.helo_resp = None
             self.ehlo_resp = None
             self.esmtp_features = {}
             self.does_esmtp = 0
         return (resp, reply)
 
 
 class SMTPS(smtplib.SMTP):
     '''Derived class to verify the peer certificate for SMTPS.
 
     This class allows to pass any keyword arguments to SSL socket creation.
     '''
 
     def __init__(self, ui, keyfile=None, certfile=None, host=None, **kwargs):
         self.keyfile = keyfile
         self.certfile = certfile
         smtplib.SMTP.__init__(self, **kwargs)
         self._host = host
         self.default_port = smtplib.SMTP_SSL_PORT
         self._ui = ui
 
     def _get_socket(self, host, port, timeout):
         if self.debuglevel > 0:
             self._ui.debug(b'connect: %r\n' % ((host, port),))
         new_socket = socket.create_connection((host, port), timeout)
         new_socket = sslutil.wrapsocket(
             new_socket,
             self.keyfile,
             self.certfile,
             ui=self._ui,
             serverhostname=self._host,
         )
         self.file = new_socket.makefile('rb')
         return new_socket
 
 
 def _pyhastls():
     """Returns true iff Python has TLS support, false otherwise."""
     try:
         import ssl
 
         getattr(ssl, 'HAS_TLS', False)
         return True
     except ImportError:
         return False
 
 
 def _smtp(ui):
     '''build an smtp connection and return a function to send mail'''
     local_hostname = ui.config(b'smtp', b'local_hostname')
     tls = ui.config(b'smtp', b'tls')
     # backward compatible: when tls = true, we use starttls.
     starttls = tls == b'starttls' or stringutil.parsebool(tls)
     smtps = tls == b'smtps'
     if (starttls or smtps) and not _pyhastls():
         raise error.Abort(_(b"can't use TLS: Python SSL support not installed"))
     mailhost = ui.config(b'smtp', b'host')
     if not mailhost:
         raise error.Abort(_(b'smtp.host not configured - cannot send mail'))
     if smtps:
         ui.note(_(b'(using smtps)\n'))
         s = SMTPS(ui, local_hostname=local_hostname, host=mailhost)
     elif starttls:
         s = STARTTLS(ui, local_hostname=local_hostname, host=mailhost)
     else:
         s = smtplib.SMTP(local_hostname=local_hostname)
     if smtps:
         defaultport = 465
     else:
         defaultport = 25
     mailport = util.getport(ui.config(b'smtp', b'port', defaultport))
     ui.note(_(b'sending mail: smtp host %s, port %d\n') % (mailhost, mailport))
     s.connect(host=mailhost, port=mailport)
     if starttls:
         ui.note(_(b'(using starttls)\n'))
         s.ehlo()
         s.starttls()
         s.ehlo()
     if starttls or smtps:
         ui.note(_(b'(verifying remote certificate)\n'))
         sslutil.validatesocket(s.sock)
     username = ui.config(b'smtp', b'username')
     password = ui.config(b'smtp', b'password')
     if username:
         if password:
             password = encoding.strfromlocal(password)
         else:
             password = ui.getpass()
     if username and password:
         ui.note(_(b'(authenticating to mail server as %s)\n') % username)
         username = encoding.strfromlocal(username)
         try:
             s.login(username, password)
         except smtplib.SMTPException as inst:
             raise error.Abort(inst)
 
     def send(sender, recipients, msg):
         try:
             return s.sendmail(sender, recipients, msg)
         except smtplib.SMTPRecipientsRefused as inst:
             recipients = [r[1] for r in inst.recipients.values()]
             raise error.Abort(b'\n' + b'\n'.join(recipients))
         except smtplib.SMTPException as inst:
             raise error.Abort(inst)
 
     return send
 
 
 def _sendmail(ui, sender, recipients, msg):
     '''send mail using sendmail.'''
     program = ui.config(b'email', b'method')
 
     def stremail(x):
         return procutil.shellquote(stringutil.email(encoding.strtolocal(x)))
 
     cmdline = b'%s -f %s %s' % (
         program,
         stremail(sender),
         b' '.join(map(stremail, recipients)),
     )
     ui.note(_(b'sending mail: %s\n') % cmdline)
     fp = procutil.popen(cmdline, b'wb')
     fp.write(util.tonativeeol(msg))
     ret = fp.close()
     if ret:
         raise error.Abort(
             b'%s %s'
             % (
                 os.path.basename(program.split(None, 1)[0]),
                 procutil.explainexit(ret),
             )
         )
 
 
 def _mbox(mbox, sender, recipients, msg):
     '''write mails to mbox'''
     fp = open(mbox, b'ab+')
     # Should be time.asctime(), but Windows prints 2-characters day
     # of month instead of one. Make them print the same thing.
     date = time.strftime('%a %b %d %H:%M:%S %Y', time.localtime())
     fp.write(
         b'From %s %s\n'
         % (encoding.strtolocal(sender), encoding.strtolocal(date))
     )
     fp.write(msg)
     fp.write(b'\n\n')
     fp.close()
 
 
 def connect(ui, mbox=None):
     '''make a mail connection. return a function to send mail.
     call as sendmail(sender, list-of-recipients, msg).'''
     if mbox:
         open(mbox, b'wb').close()
         return lambda s, r, m: _mbox(mbox, s, r, m)
     if ui.config(b'email', b'method') == b'smtp':
         return _smtp(ui)
     return lambda s, r, m: _sendmail(ui, s, r, m)
 
 
 def sendmail(ui, sender, recipients, msg, mbox=None):
     send = connect(ui, mbox=mbox)
     return send(sender, recipients, msg)
 
 
 def validateconfig(ui):
     '''determine if we have enough config data to try sending email.'''
     method = ui.config(b'email', b'method')
     if method == b'smtp':
         if not ui.config(b'smtp', b'host'):
             raise error.Abort(
                 _(
                     b'smtp specified as email transport, '
                     b'but no smtp host configured'
                 )
             )
     else:
         if not procutil.findexe(method):
             raise error.Abort(
                 _(b'%r specified as email transport, but not in PATH') % method
             )
 
 
 def codec2iana(cs):
     ''''''
     cs = pycompat.sysbytes(email.charset.Charset(cs).input_charset.lower())
 
     # "latin1" normalizes to "iso8859-1", standard calls for "iso-8859-1"
     if cs.startswith(b"iso") and not cs.startswith(b"iso-"):
         return b"iso-" + cs[3:]
     return cs
 
 
 def mimetextpatch(s, subtype=b'plain', display=False):
     '''Return MIME message suitable for a patch.
     Charset will be detected by first trying to decode as us-ascii, then utf-8,
     and finally the global encodings. If all those fail, fall back to
     ISO-8859-1, an encoding with that allows all byte sequences.
     Transfer encodings will be used if necessary.'''
 
     cs = [b'us-ascii', b'utf-8', encoding.encoding, encoding.fallbackencoding]
     if display:
         cs = [b'us-ascii']
     for charset in cs:
         try:
             s.decode(pycompat.sysstr(charset))
             return mimetextqp(s, subtype, codec2iana(charset))
         except UnicodeDecodeError:
             pass
 
     return mimetextqp(s, subtype, b"iso-8859-1")
 
 
 def mimetextqp(body, subtype, charset):
     '''Return MIME message.
     Quoted-printable transfer encoding will be used if necessary.
     '''
     # Experimentally charset is okay as a bytes even if the type
     # stubs disagree.
     cs = email.charset.Charset(charset)  # pytype: disable=wrong-arg-types
     msg = email.message.Message()
     msg.set_type(pycompat.sysstr(b'text/' + subtype))
 
     for line in body.splitlines():
         if len(line) > 950:
             cs.body_encoding = email.charset.QP
             break
 
     # On Python 2, this simply assigns a value. Python 3 inspects
     # body and does different things depending on whether it has
     # encode() or decode() attributes. We can get the old behavior
     # if we pass a str and charset is None and we call set_charset().
     # But we may get into  trouble later due to Python attempting to
     # encode/decode using the registered charset (or attempting to
     # use ascii in the absence of a charset).
     msg.set_payload(body, cs)
 
     return msg
 
 
 def _charsets(ui):
     '''Obtains charsets to send mail parts not containing patches.'''
     charsets = [cs.lower() for cs in ui.configlist(b'email', b'charsets')]
     fallbacks = [
         encoding.fallbackencoding.lower(),
         encoding.encoding.lower(),
         b'utf-8',
     ]
     for cs in fallbacks:  # find unique charsets while keeping order
         if cs not in charsets:
             charsets.append(cs)
     return [cs for cs in charsets if not cs.endswith(b'ascii')]
 
 
 def _encode(ui, s, charsets):
     '''Returns (converted) string, charset tuple.
     Finds out best charset by cycling through sendcharsets in descending
     order. Tries both encoding and fallbackencoding for input. Only as
     last resort send as is in fake ascii.
     Caveat: Do not use for mail parts containing patches!'''
     sendcharsets = charsets or _charsets(ui)
     if not isinstance(s, bytes):
         # We have unicode data, which we need to try and encode to
         # some reasonable-ish encoding. Try the encodings the user
         # wants, and fall back to garbage-in-ascii.
         for ocs in sendcharsets:
             try:
                 return s.encode(pycompat.sysstr(ocs)), ocs
             except UnicodeEncodeError:
                 pass
             except LookupError:
                 ui.warn(_(b'ignoring invalid sendcharset: %s\n') % ocs)
         else:
             # Everything failed, ascii-armor what we've got and send it.
             return s.encode('ascii', 'backslashreplace')
     # We have a bytes of unknown encoding. We'll try and guess a valid
     # encoding, falling back to pretending we had ascii even though we
     # know that's wrong.
     try:
         s.decode('ascii')
     except UnicodeDecodeError:
         for ics in (encoding.encoding, encoding.fallbackencoding):
             ics = pycompat.sysstr(ics)
             try:
                 u = s.decode(ics)
             except UnicodeDecodeError:
                 continue
             for ocs in sendcharsets:
                 try:
                     return u.encode(pycompat.sysstr(ocs)), ocs
                 except UnicodeEncodeError:
                     pass
                 except LookupError:
                     ui.warn(_(b'ignoring invalid sendcharset: %s\n') % ocs)
     # if ascii, or all conversion attempts fail, send (broken) ascii
     return s, b'us-ascii'
 
 
 def headencode(ui, s, charsets=None, display=False):
     '''Returns RFC-2047 compliant header from given string.'''
     if not display:
         # split into words?
         s, cs = _encode(ui, s, charsets)
         return email.header.Header(s, cs).encode()
     return encoding.strfromlocal(s)
 
 
 def _addressencode(ui, name, addr, charsets=None):
     assert isinstance(addr, bytes)
     name = headencode(ui, name, charsets)
     try:
         acc, dom = addr.split(b'@')
         acc.decode('ascii')
         dom = dom.decode(pycompat.sysstr(encoding.encoding)).encode('idna')
         addr = b'%s@%s' % (acc, dom)
     except UnicodeDecodeError:
         raise error.Abort(_(b'invalid email address: %s') % addr)
     except ValueError:
         try:
             # too strict?
             addr.decode('ascii')
         except UnicodeDecodeError:
             raise error.Abort(_(b'invalid local address: %s') % addr)
-    return pycompat.bytesurl(
-        email.utils.formataddr((name, encoding.strfromlocal(addr)))
-    )
+    return email.utils.formataddr((name, encoding.strfromlocal(addr)))
 
 
 def addressencode(ui, address, charsets=None, display=False):
     '''Turns address into RFC-2047 compliant header.'''
     if display or not address:
-        return address or b''
+        return encoding.strfromlocal(address or b'')
     name, addr = email.utils.parseaddr(encoding.strfromlocal(address))
     return _addressencode(ui, name, encoding.strtolocal(addr), charsets)
 
 
 def addrlistencode(ui, addrs, charsets=None, display=False):
     '''Turns a list of addresses into a list of RFC-2047 compliant headers.
     A single element of input list may contain multiple addresses, but output
     always has one address per item'''
     for a in addrs:
         assert isinstance(a, bytes), '%r unexpectedly not a bytestr' % a
     if display:
-        return [a.strip() for a in addrs if a.strip()]
+        return [encoding.strfromlocal(a.strip()) for a in addrs if a.strip()]
 
     result = []
     for name, addr in email.utils.getaddresses(
         [encoding.strfromlocal(a) for a in addrs]
     ):
         if name or addr:
             r = _addressencode(ui, name, encoding.strtolocal(addr), charsets)
             result.append(r)
     return result
 
 
 def mimeencode(ui, s, charsets=None, display=False):
     '''creates mime text object, encodes it if needed, and sets
     charset and transfer-encoding accordingly.'''
     cs = b'us-ascii'
     if not display:
         s, cs = _encode(ui, s, charsets)
     return mimetextqp(s, b'plain', cs)
 
 
 if pycompat.ispy3:
 
     Generator = email.generator.BytesGenerator
 
     def parse(fp):
         ep = email.parser.Parser()
         # disable the "universal newlines" mode, which isn't binary safe.
         # I have no idea if ascii/surrogateescape is correct, but that's
         # what the standard Python email parser does.
         fp = io.TextIOWrapper(
             fp, encoding='ascii', errors='surrogateescape', newline=chr(10)
         )
         try:
             return ep.parse(fp)
         finally:
             fp.detach()
 
     def parsebytes(data):
         ep = email.parser.BytesParser()
         return ep.parsebytes(data)
 
 
 else:
 
     Generator = email.generator.Generator
 
     def parse(fp):
         ep = email.parser.Parser()
         return ep.parse(fp)
 
     def parsebytes(data):
         ep = email.parser.Parser()
         return ep.parsestr(data)
 
 
 def headdecode(s):
     '''Decodes RFC-2047 header'''
     uparts = []
     for part, charset in email.header.decode_header(s):
         if charset is not None:
             try:
                 uparts.append(part.decode(charset))
                 continue
             except (UnicodeDecodeError, LookupError):
                 pass
         # On Python 3, decode_header() may return either bytes or unicode
         # depending on whether the header has =?<charset>? or not
         if isinstance(part, type(u'')):
             uparts.append(part)
             continue
         try:
             uparts.append(part.decode('UTF-8'))
             continue
         except UnicodeDecodeError:
             pass
         uparts.append(part.decode('ISO-8859-1'))
     return encoding.unitolocal(u' '.join(uparts))