# patchbomb.py - sending Mercurial changesets as patch emails

#

#  Copyright 2005-2009 Olivia Mackall <olivia@selenic.com> 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.

'''

import email.encoders as emailencoders

import email.mime.base as emimebase

import email.mime.multipart as emimemultipart

import email.utils as eutil

import os

import socket

from mercurial.i18n import _

from mercurial.pycompat import open

from mercurial.node import bin

from mercurial import (

    cmdutil,

    commands,

    encoding,

    error,

    formatter,

    hg,

    logcmdutil,

    mail,

    patch,

    pycompat,

    registrar,

    scmutil,

    templater,

    util,

)

from mercurial.utils import (

    dateutil,

    urlutil,

)

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.literal_templatespec(templater.unquotestring(tmpl))

    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), 'x-patch', opts.get(b'test')

        )

        binnode = 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['Subject'] = mail.headencode(ui, subj, _charsets, opts.get(b'test'))

    msg['X-Mercurial-Node'] = pycompat.sysstr(node)

    msg['X-Mercurial-Series-Index'] = '%i' % idx

    msg['X-Mercurial-Series-Total'] = '%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, pycompat.byteskwargs(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