# mq.py - patch queues for mercurial

#

# Copyright 2005, 2006 Chris Mason <mason@suse.com>

#

# This software may be used and distributed according to the terms of the

# GNU General Public License version 2 or any later version.

'''manage a stack of patches

This extension lets you work with a stack of patches in a Mercurial

repository. It manages two stacks of patches - all known patches, and

applied patches (subset of known patches).

Known patches are represented as patch files in the .hg/patches

directory. Applied patches are both patch files and changesets.

Common tasks (use :hg:`help COMMAND` for more details)::

  create new patch                          qnew

  import existing patch                     qimport

  print patch series                        qseries

  print applied patches                     qapplied

  add known patch to applied stack          qpush

  remove patch from applied stack           qpop

  refresh contents of top applied patch     qrefresh

By default, mq will automatically use git patches when required to

avoid losing file mode changes, copy records, binary files or empty

files creations or deletions. This behavior can be configured with::

  [mq]

  git = auto/keep/yes/no

If set to 'keep', mq will obey the [diff] section configuration while

preserving existing git patches upon qrefresh. If set to 'yes' or

'no', mq will override the [diff] section and always generate git or

regular patches, possibly losing data in the second case.

It may be desirable for mq changesets to be kept in the secret phase (see

:hg:`help phases`), which can be enabled with the following setting::

  [mq]

  secret = True

You will by default be managing a patch queue named "patches". You can

create other, independent patch queues with the :hg:`qqueue` command.

If the working directory contains uncommitted files, qpush, qpop and

qgoto abort immediately. If -f/--force is used, the changes are

discarded. Setting::

  [mq]

  keepchanges = True

make them behave as if --keep-changes were passed, and non-conflicting

local changes will be tolerated and preserved. If incompatible options

such as -f/--force or --exact are passed, this setting is ignored.

This extension used to provide a strip command. This command now lives

in the strip extension.

'''

from __future__ import absolute_import

import errno

import os

import re

import shutil

from mercurial.i18n import _

from mercurial.node import (

    bin,

    hex,

    nullid,

    nullrev,

    short,

)

from mercurial import (

    cmdutil,

    commands,

    dirstateguard,

    error,

    extensions,

    hg,

    localrepo,

    lock as lockmod,

    patch as patchmod,

    phases,

    pycompat,

    registrar,

    revsetlang,

    scmutil,

    smartset,

    subrepo,

    util,

    vfs as vfsmod,

)

release = lockmod.release

seriesopts = [('s', 'summary', None, _('print first line of patch header'))]

cmdtable = {}

command = registrar.command(cmdtable)

# 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 = 'ships-with-hg-core'

# force load strip extension formerly included in mq and import some utility

try:

    stripext = extensions.find('strip')

except KeyError:

    # note: load is lazy so we could avoid the try-except,

    # but I (marmoute) prefer this explicit code.

    class dummyui(object):

        def debug(self, msg):

            pass

    stripext = extensions.load(dummyui(), 'strip', '')

strip = stripext.strip

checksubstate = stripext.checksubstate

checklocalchanges = stripext.checklocalchanges

# Patch names looks like unix-file names.

# They must be joinable with queue directory and result in the patch path.

normname = util.normpath

class statusentry(object):

    def __init__(self, node, name):

        self.node, self.name = node, name

    def __repr__(self):

        return hex(self.node) + ':' + self.name

# The order of the headers in 'hg export' HG patches:

HGHEADERS = [

#   '# HG changeset patch',

    '# User ',

    '# Date ',

    '#      ',

    '# Branch ',

    '# Node ID ',

    '# Parent  ', # can occur twice for merges - but that is not relevant for mq

    ]

# The order of headers in plain 'mail style' patches:

PLAINHEADERS = {

    'from': 0,

    'date': 1,

    'subject': 2,

    }

def inserthgheader(lines, header, value):

    """Assuming lines contains a HG patch header, add a header line with value.

    >>> try: inserthgheader([], '# Date ', 'z')

    ... except ValueError, inst: print "oops"

    oops

    >>> inserthgheader(['# HG changeset patch'], '# Date ', 'z')

    ['# HG changeset patch', '# Date z']

    >>> inserthgheader(['# HG changeset patch', ''], '# Date ', 'z')

    ['# HG changeset patch', '# Date z', '']

    >>> inserthgheader(['# HG changeset patch', '# User y'], '# Date ', 'z')

    ['# HG changeset patch', '# User y', '# Date z']

    >>> inserthgheader(['# HG changeset patch', '# Date x', '# User y'],

    ...                '# User ', 'z')

    ['# HG changeset patch', '# Date x', '# User z']

    >>> inserthgheader(['# HG changeset patch', '# Date y'], '# Date ', 'z')

    ['# HG changeset patch', '# Date z']

    >>> inserthgheader(['# HG changeset patch', '', '# Date y'], '# Date ', 'z')

    ['# HG changeset patch', '# Date z', '', '# Date y']

    >>> inserthgheader(['# HG changeset patch', '# Parent  y'], '# Date ', 'z')

    ['# HG changeset patch', '# Date z', '# Parent  y']

    """

    start = lines.index('# HG changeset patch') + 1

    newindex = HGHEADERS.index(header)

    bestpos = len(lines)

    for i in range(start, len(lines)):

        line = lines[i]

        if not line.startswith('# '):

            bestpos = min(bestpos, i)

            break

        for lineindex, h in enumerate(HGHEADERS):

            if line.startswith(h):

                if lineindex == newindex:

                    lines[i] = header + value

                    return lines

                if lineindex > newindex:

                    bestpos = min(bestpos, i)

                break # next line

    lines.insert(bestpos, header + value)

    return lines

def insertplainheader(lines, header, value):

    """For lines containing a plain patch header, add a header line with value.

    >>> insertplainheader([], 'Date', 'z')

    ['Date: z']

    >>> insertplainheader([''], 'Date', 'z')

    ['Date: z', '']

    >>> insertplainheader(['x'], 'Date', 'z')

    ['Date: z', '', 'x']

    >>> insertplainheader(['From: y', 'x'], 'Date', 'z')

    ['From: y', 'Date: z', '', 'x']

    >>> insertplainheader([' date : x', ' from : y', ''], 'From', 'z')

    [' date : x', 'From: z', '']

    >>> insertplainheader(['', 'Date: y'], 'Date', 'z')

    ['Date: z', '', 'Date: y']

    >>> insertplainheader(['foo: bar', 'DATE: z', 'x'], 'From', 'y')

    ['From: y', 'foo: bar', 'DATE: z', '', 'x']

    """

    newprio = PLAINHEADERS[header.lower()]

    bestpos = len(lines)

    for i, line in enumerate(lines):

        if ':' in line:

            lheader = line.split(':', 1)[0].strip().lower()

            lprio = PLAINHEADERS.get(lheader, newprio + 1)

            if lprio == newprio:

                lines[i] = '%s: %s' % (header, value)

                return lines

            if lprio > newprio and i < bestpos:

                bestpos = i

        else:

            if line:

                lines.insert(i, '')

            if i < bestpos:

                bestpos = i

            break

    lines.insert(bestpos, '%s: %s' % (header, value))

    return lines

class patchheader(object):

    def __init__(self, pf, plainmode=False):

        def eatdiff(lines):

            while lines:

                l = lines[-1]

                if (l.startswith("diff -") or

                    l.startswith("Index:") or

                    l.startswith("===========")):

                    del lines[-1]

                else:

                    break

        def eatempty(lines):

            while lines:

                if not lines[-1].strip():

                    del lines[-1]

                else:

                    break

        message = []

        comments = []

        user = None

        date = None

        parent = None

        format = None

        subject = None

        branch = None

        nodeid = None

        diffstart = 0

        for line in file(pf):

            line = line.rstrip()

            if (line.startswith('diff --git')

                or (diffstart and line.startswith('+++ '))):

                diffstart = 2

                break

            diffstart = 0 # reset

            if line.startswith("--- "):

                diffstart = 1

                continue

            elif format == "hgpatch":

                # parse values when importing the result of an hg export

                if line.startswith("# User "):

                    user = line[7:]

                elif line.startswith("# Date "):

                    date = line[7:]

                elif line.startswith("# Parent "):

                    parent = line[9:].lstrip() # handle double trailing space

                elif line.startswith("# Branch "):

                    branch = line[9:]

                elif line.startswith("# Node ID "):

                    nodeid = line[10:]

                elif not line.startswith("# ") and line:

                    message.append(line)

                    format = None

            elif line == '# HG changeset patch':

                message = []

                format = "hgpatch"

            elif (format != "tagdone" and (line.startswith("Subject: ") or

                                           line.startswith("subject: "))):

                subject = line[9:]

                format = "tag"

            elif (format != "tagdone" and (line.startswith("From: ") or

                                           line.startswith("from: "))):

                user = line[6:]

                format = "tag"

            elif (format != "tagdone" and (line.startswith("Date: ") or

                                           line.startswith("date: "))):

                date = line[6:]

                format = "tag"

            elif format == "tag" and line == "":

                # when looking for tags (subject: from: etc) they

                # end once you find a blank line in the source

                format = "tagdone"

            elif message or line:

                message.append(line)

            comments.append(line)

        eatdiff(message)

        eatdiff(comments)

        # Remember the exact starting line of the patch diffs before consuming

        # empty lines, for external use by TortoiseHg and others

        self.diffstartline = len(comments)

        eatempty(message)

        eatempty(comments)

        # make sure message isn't empty

        if format and format.startswith("tag") and subject:

            message.insert(0, subject)

        self.message = message

        self.comments = comments

        self.user = user

        self.date = date

        self.parent = parent

        # nodeid and branch are for external use by TortoiseHg and others

        self.nodeid = nodeid

        self.branch = branch

        self.haspatch = diffstart > 1

        self.plainmode = (plainmode or

                          '# HG changeset patch' not in self.comments and

                          any(c.startswith('Date: ') or

                                   c.startswith('From: ')

                                   for c in self.comments))

    def setuser(self, user):

        try:

            inserthgheader(self.comments, '# User ', user)

        except ValueError:

            if self.plainmode:

                insertplainheader(self.comments, 'From', user)

            else:

                tmp = ['# HG changeset patch', '# User ' + user]

                self.comments = tmp + self.comments

        self.user = user

    def setdate(self, date):

        try:

            inserthgheader(self.comments, '# Date ', date)

        except ValueError:

            if self.plainmode:

                insertplainheader(self.comments, 'Date', date)

            else:

                tmp = ['# HG changeset patch', '# Date ' + date]

                self.comments = tmp + self.comments

        self.date = date

    def setparent(self, parent):

        try:

            inserthgheader(self.comments, '# Parent  ', parent)

        except ValueError:

            if not self.plainmode:

                tmp = ['# HG changeset patch', '# Parent  ' + parent]

                self.comments = tmp + self.comments

        self.parent = parent

    def setmessage(self, message):

        if self.comments:

            self._delmsg()

        self.message = [message]

        if message:

            if self.plainmode and self.comments and self.comments[-1]:

                self.comments.append('')

            self.comments.append(message)

    def __str__(self):

        s = '\n'.join(self.comments).rstrip()

        if not s:

            return ''

        return s + '\n\n'

    def _delmsg(self):

        '''Remove existing message, keeping the rest of the comments fields.

        If comments contains 'subject: ', message will prepend

        the field and a blank line.'''

        if self.message:

            subj = 'subject: ' + self.message[0].lower()

            for i in xrange(len(self.comments)):

                if subj == self.comments[i].lower():

                    del self.comments[i]

                    self.message = self.message[2:]

                    break

        ci = 0

        for mi in self.message:

            while mi != self.comments[ci]:

                ci += 1