# 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 Mercurial core

'''

__version__ = '5.1.4'

testedwith = '3.3.3 3.4.1'

buglink = 'http://bz.selenic.com/'

import sys, os

import random

from StringIO import StringIO

import struct

import re

import collections

import socket

import errno

sha1re = re.compile(r'\b[0-9a-f]{6,40}\b')

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

# Flags for enabling optional parts of evolve

commandopt = 'allnewcommands'

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, mergetoolopts

from mercurial.node import nullid

from mercurial import wireproto

from mercurial import localrepo

from mercurial.hgweb import hgweb_mod

cmdtable = {}

command = cmdutil.command(cmdtable)

_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 ImportError('evolve needs version %s or above' % min(testedwith.split()))

aliases, entry = cmdutil.findcmd('commit', commands.table)

hasinteractivemode = any(['interactive' in e for e in entry[1]])

if hasinteractivemode:

    interactiveopt = [['i', 'interactive', None, _('use interactive mode')]]

else:

    interactiveopt = []

# 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, opts in self._commandwrappers:

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

            if opts:

                for short, long, val, msg in opts:

                    entry[1].append((short, long, val, msg))

        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, opts in self._extcommandwrappers:

            if ext not in knownexts:

                try:

                    e = extensions.find(ext)

                except KeyError:

                    # Extension isn't enabled, so don't bother trying to wrap

                    # it.

                    continue

                knownexts[ext] = e.cmdtable

            entry = extensions.wrapcommand(knownexts[ext], command, wrapper)

            if opts:

                for short, long, val, msg in opts:

                    entry[1].append((short, long, val, msg))

        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 template 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, opts=[]):

        """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)

        The `opts` argument allows specifying additional arguments for the

        command.

        """

        def dec(wrapper):

            if extension is None:

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

            else:

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

                    opts))

            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

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

### Option configuration                                          ###

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

@eh.reposetup # must be the first of its kin.

def _configureoptions(ui, repo):

    # If no capabilities are specified, enable everything.

    # This is so existing evolve users don't need to change their config.

    evolveopts = ui.configlist('experimental', 'evolution')

    if not evolveopts:

        evolveopts = ['all']

        ui.setconfig('experimental', 'evolution', evolveopts)

@eh.uisetup

def _configurecmdoptions(ui):

    # Unregister evolve commands if the command capability is not specified.

    #

    # This must be in the same function as the option configuration above to

    # guarantee it happens after the above configuration, but before the

    # extsetup functions.

    evolveopts = ui.configlist('experimental', 'evolution')

    if evolveopts and (commandopt not in evolveopts and

                       'all' not in evolveopts):

        cmdtable.clear()

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

### experimental behavior                                         ###

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

commitopts3 = [

    ('D', 'current-date', None,

     _('record the current date as commit date')),

    ('U', 'current-user', None,

     _('record the current user as committer')),

]

def _resolveoptions(ui, opts):

    """modify commit options dict to handle related options

    For now, all it does is figure out the commit date: respect -D unless

    -d was supplied.

    """

    # N.B. this is extremely similar to setupheaderopts() in mq.py

    if not opts.get('date') and opts.get('current_date'):

        opts['date'] = '%d %d' % util.makedate()

    if not opts.get('user') and opts.get('current_user'):

        opts['user'] = ui.username()

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

### Useful alias

@eh.uisetup

def _installalias(ui):

    if ui.config('alias', 'pstatus', None) is None:

        ui.setconfig('alias', 'pstatus', 'status --rev .^')

    if ui.config('alias', 'pdiff', None) is None:

        ui.setconfig('alias', 'pdiff', 'diff --rev .^')

    if ui.config('alias', 'olog', None) is None:

        ui.setconfig('alias', 'olog', "log -r 'precursors(.)' --hidden")

    if ui.config('alias', 'odiff', None) is None:

        ui.setconfig('alias', 'odiff',

            "diff --hidden --rev 'limit(precursors(.),1)' --rev .")

    if ui.config('alias', 'grab', None) is None:

        if os.name == 'nt':

            ui.setconfig('alias', 'grab',

                "! " + util.hgexecutable() + " rebase --dest . --rev $@ && "

                 + util.hgexecutable() + " up tip")

        else:

            ui.setconfig('alias', 'grab',

                "! $HG rebase --dest . --rev $@ && $HG up tip")

### Troubled revset symbol

@eh.revset('troubled')

def revsettroubled(repo, subset, x):

    """``troubled()``

    Changesets with troubles.

    """

    revset.getargs(x, 0, 0, 'troubled takes no arguments')

    troubled = set()

    troubled.update(getrevs(repo, 'unstable'))

    troubled.update(getrevs(repo, 'bumped'))

    troubled.update(getrevs(repo, 'divergent'))

    troubled = revset.baseset(troubled)

    troubled.sort() # set is non-ordered, enforce order

    return subset & troubled

### Obsolescence graph

# XXX SOME MAJOR CLEAN UP TO DO HERE XXX

def _precursors(repo, s):

    """Precursor of a changeset"""

    cs = set()

    nm = repo.changelog.nodemap

    markerbysubj = repo.obsstore.precursors

    node = repo.changelog.node

    for r in s:

        for p in markerbysubj.get(node(r), ()):

            pr = nm.get(p[0])

            if pr is not None:

                cs.add(pr)

    cs -= repo.changelog.filteredrevs # nodemap has no filtering

    return cs

def _allprecursors(repo, s):  # XXX we need a better naming

    """transitive precursors of a subset"""

    node = repo.changelog.node

    toproceed = [node(r) for r in s]

    seen = set()

    allsubjects = repo.obsstore.precursors

    while toproceed:

        nc = toproceed.pop()

        for mark in allsubjects.get(nc, ()):

            np = mark[0]

            if np not in seen:

                seen.add(np)

                toproceed.append(np)

    nm = repo.changelog.nodemap

    cs = set()

    for p in seen:

        pr = nm.get(p)

        if pr is not None:

            cs.add(pr)

    cs -= repo.changelog.filteredrevs # nodemap has no filtering