# Copyright 2011 Peter Arrenbrecht <peter.arrenbrecht@gmail.com>

#                Logilab SA        <contact@logilab.fr>

#                Pierre-Yves David <pierre-yves.david@ens-lyon.org>

#                Patrick Mezard <patrick@mezard.eu>

#

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

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

'''extends Mercurial feature related to Changeset Evolution

This extension provides several commands to mutate history and deal with

issues it may raise.

It also:

    - enables the "Changeset Obsolescence" feature of mercurial,

    - alters core commands and extensions that rewrite history to use

      this feature,

    - improves some aspect of the early implementation in 2.3

'''

testedwith = '3.0.1'

buglink = 'https://bitbucket.org/marmoute/mutable-history/issues'

import sys

import random

from StringIO import StringIO

import struct

import mercurial

from mercurial import util

try:

    from mercurial import obsolete

    if not obsolete._enabled:

        obsolete._enabled = True

    from mercurial import wireproto

    gboptslist = getattr(wireproto, 'gboptslist', None)

    gboptsmap = getattr(wireproto, 'gboptsmap', None)

except (ImportError, AttributeError):

    gboptslist = gboptsmap = None

from mercurial import base85

from mercurial import bookmarks

from mercurial import cmdutil

from mercurial import commands

from mercurial import context

from mercurial import copies

from mercurial import error

from mercurial import exchange

from mercurial import extensions

from mercurial import httppeer

from mercurial import hg

from mercurial import lock as lockmod

from mercurial import merge

from mercurial import node

from mercurial import phases

from mercurial import patch

from mercurial import revset

from mercurial import scmutil

from mercurial import templatekw

from mercurial.i18n import _

from mercurial.commands import walkopts, commitopts, commitopts2

from mercurial.node import nullid

from mercurial import wireproto

from mercurial import localrepo

from mercurial.hgweb import hgweb_mod

_pack = struct.pack

if gboptsmap is not None:

    memfilectx = context.memfilectx

elif gboptslist is not None:

    oldmemfilectx = context.memfilectx

    def memfilectx(repo, *args, **kwargs):

        return oldmemfilectx(*args, **kwargs)

else:

    raise util.Abort('Your Mercurial is too old for this version of Evolve\n'

                     'requires version 3.0.1 or above')

# This extension contains the following code

#

# - Extension Helper code

# - Obsolescence cache

# - ...

# - Older format compat

#####################################################################

### Extension helper                                              ###

#####################################################################

class exthelper(object):

    """Helper for modular extension setup

    A single helper should be instanciated for each extension. Helper

    methods are then used as decorator for various purpose.

    All decorators return the original function and may be chained.

    """

    def __init__(self):

        self._uicallables = []

        self._extcallables = []

        self._repocallables = []

        self._revsetsymbols = []

        self._templatekws = []

        self._commandwrappers = []

        self._extcommandwrappers = []

        self._functionwrappers = []

        self._duckpunchers = []

    def final_uisetup(self, ui):

        """Method to be used as the extension uisetup

        The following operations belong here:

        - Changes to ui.__class__ . The ui object that will be used to run the

          command has not yet been created. Changes made here will affect ui

          objects created after this, and in particular the ui that will be

          passed to runcommand

        - Command wraps (extensions.wrapcommand)

        - Changes that need to be visible to other extensions: because

          initialization occurs in phases (all extensions run uisetup, then all

          run extsetup), a change made here will be visible to other extensions

          during extsetup

        - Monkeypatch or wrap function (extensions.wrapfunction) of dispatch

          module members

        - Setup of pre-* and post-* hooks

        - pushkey setup

        """

        for cont, funcname, func in self._duckpunchers:

            setattr(cont, funcname, func)

        for command, wrapper in self._commandwrappers:

            extensions.wrapcommand(commands.table, command, wrapper)

        for cont, funcname, wrapper in self._functionwrappers:

            extensions.wrapfunction(cont, funcname, wrapper)

        for c in self._uicallables:

            c(ui)

    def final_extsetup(self, ui):

        """Method to be used as a the extension extsetup

        The following operations belong here:

        - Changes depending on the status of other extensions. (if

          extensions.find('mq'))

        - Add a global option to all commands

        - Register revset functions

        """

        knownexts = {}

        for name, symbol in self._revsetsymbols:

            revset.symbols[name] = symbol

        for name, kw in self._templatekws:

            templatekw.keywords[name] = kw

        for ext, command, wrapper in self._extcommandwrappers:

            if ext not in knownexts:

                e = extensions.find(ext)

                if e is None:

                    raise util.Abort('extension %s not found' % ext)

                knownexts[ext] = e.cmdtable

            extensions.wrapcommand(knownexts[ext], commands, wrapper)

        for c in self._extcallables:

            c(ui)

    def final_reposetup(self, ui, repo):

        """Method to be used as a the extension reposetup

        The following operations belong here:

        - All hooks but pre-* and post-*

        - Modify configuration variables

        - Changes to repo.__class__, repo.dirstate.__class__

        """

        for c in self._repocallables:

            c(ui, repo)

    def uisetup(self, call):

        """Decorated function will be executed during uisetup

        example::

            @eh.uisetup

            def setupbabar(ui):

                print 'this is uisetup!'

        """

        self._uicallables.append(call)

        return call

    def extsetup(self, call):

        """Decorated function will be executed during extsetup

        example::

            @eh.extsetup

            def setupcelestine(ui):

                print 'this is extsetup!'

        """

        self._extcallables.append(call)

        return call

    def reposetup(self, call):

        """Decorated function will be executed during reposetup

        example::

            @eh.reposetup

            def setupzephir(ui, repo):

                print 'this is reposetup!'

        """

        self._repocallables.append(call)

        return call

    def revset(self, symbolname):

        """Decorated function is a revset symbol

        The name of the symbol must be given as the decorator argument.

        The symbol is added during `extsetup`.

        example::

            @eh.revset('hidden')

            def revsetbabar(repo, subset, x):

                args = revset.getargs(x, 0, 0, 'babar accept no argument')

                return [r for r in subset if 'babar' in repo[r].description()]

        """

        def dec(symbol):

            self._revsetsymbols.append((symbolname, symbol))

            return symbol

        return dec

    def templatekw(self, keywordname):

        """Decorated function is a revset keyword

        The name of the keyword must be given as the decorator argument.

        The symbol is added during `extsetup`.

        example::

            @eh.templatekw('babar')

            def kwbabar(ctx):

                return 'babar'

        """

        def dec(keyword):

            self._templatekws.append((keywordname, keyword))

            return keyword

        return dec

    def wrapcommand(self, command, extension=None):

        """Decorated function is a command wrapper

        The name of the command must be given as the decorator argument.

        The wrapping is installed during `uisetup`.

        If the second option `extension` argument is provided, the wrapping

        will be applied in the extension commandtable. This argument must be a

        string that will be searched using `extension.find` if not found and

        Abort error is raised. If the wrapping applies to an extension, it is

        installed during `extsetup`

        example::

            @eh.wrapcommand('summary')

            def wrapsummary(orig, ui, repo, *args, **kwargs):

                ui.note('Barry!')

                return orig(ui, repo, *args, **kwargs)

        """

        def dec(wrapper):

            if extension is None:

                self._commandwrappers.append((command, wrapper))

            else:

                self._extcommandwrappers.append((extension, command, wrapper))

            return wrapper

        return dec

    def wrapfunction(self, container, funcname):

        """Decorated function is a function wrapper

        This function takes two arguments, the container and the name of the

        function to wrap. The wrapping is performed during `uisetup`.

        (there is no extension support)

        example::

            @eh.function(discovery, 'checkheads')

            def wrapfunction(orig, *args, **kwargs):

                ui.note('His head smashed in and his heart cut out')

                return orig(*args, **kwargs)

        """

        def dec(wrapper):

            self._functionwrappers.append((container, funcname, wrapper))

            return wrapper

        return dec

    def addattr(self, container, funcname):

        """Decorated function is to be added to the container

        This function takes two arguments, the container and the name of the

        function to wrap. The wrapping is performed during `uisetup`.

        example::

            @eh.function(context.changectx, 'babar')

            def babar(ctx):

                return 'babar' in ctx.description

        """

        def dec(func):

            self._duckpunchers.append((container, funcname, func))

            return func

        return dec

eh = exthelper()

uisetup = eh.final_uisetup

extsetup = eh.final_extsetup

reposetup = eh.final_reposetup

#####################################################################

### experimental behavior                                         ###

#####################################################################

@eh.wrapfunction(mercurial.obsolete, 'createmarkers')

def _createmarkers(orig, repo, relations, *args, **kwargs):

    """register parent information at prune time"""

    # every time this test is run, a kitten is slain.

    # Change it as soon as possible

    if '[,{metadata}]' in orig.__doc__:

        for idx, rel in enumerate(relations):

            prec = rel[0]

            sucs = rel[1]

            if not sucs:

                meta = {}

                if 2 < len(rel):

                    meta.update(rel[2])

                for i, p in enumerate(prec.parents(), 1):

                    meta['p%i' % i] = p.hex()

                relations[idx] = (prec, sucs, meta)

    return orig(repo, relations, *args, **kwargs)

def createmarkers(*args, **kwargs):

    return obsolete.createmarkers(*args, **kwargs)

class pruneobsstore(obsolete.obsstore):

    def __init__(self, *args, **kwargs):

        self.prunedchildren = {}

        return super(pruneobsstore, self).__init__(*args, **kwargs)

    def _load(self, markers):

        markers = self._prunedetectingmarkers(markers)

        return super(pruneobsstore, self)._load(markers)

    def _prunedetectingmarkers(self, markers):

        for m in markers:

            if not m[1]: # no successors

                meta = obsolete.decodemeta(m[3])

                if 'p1' in meta:

                    p1 = node.bin(meta['p1'])

                    self.prunedchildren.setdefault(p1, set()).add(m)

                if 'p2' in meta:

                    p2 = node.bin(meta['p2'])

                    self.prunedchildren.setdefault(p2, set()).add(m)

            yield m

obsolete.obsstore = pruneobsstore

#####################################################################

### Critical fix                                                  ###

#####################################################################

@eh.wrapfunction(mercurial.obsolete, '_readmarkers')

def safereadmarkers(orig, data):

    """safe maker wrapper to remove nullid succesors

    Nullid successors was created by older version of evolve.

    """

    nb = 0

    for marker in orig(data):

        if nullid in marker[1]:

            marker = (marker[0],

                      tuple(s for s in marker[1] if s != nullid),

                      marker[2],

                      marker[3])

            nb += 1

        yield marker

    if nb:

        e = sys.stderr

        print >> e, 'repo contains %i invalid obsolescence markers' % nb

getrevs = obsolete.getrevs

#####################################################################

### Additional Utilities                                          ###

#####################################################################

# This section contains a lot of small utility function and method

# - Function to create markers

# - useful alias pstatus and pdiff (should probably go in evolve)

# - "troubles" method on changectx

# - function to travel throught the obsolescence graph

# - function to find useful changeset to stabilize