# obsolete.py - introduce the obsolete concept in mercurial.

#

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

#                Logilab SA        <contact@logilab.fr>

#

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

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

"""Introduce the Obsolete concept to mercurial

General concept

===============

This extension introduces the *obsolete* concept. It adds a new *obsolete*

relation between two changesets. A relation ``<changeset B> obsolete <changeset

A>`` is set to denote that ``<changeset B>`` is new version of ``<changeset

A>``.

The *obsolete* relation act as a **perpendicular history** to the standard

changeset history. Standard changeset history versions files. The *obsolete*

relation versions changesets.

:obsolete:     a changeset that has been replaced by another one.

:unstable:     a changeset that is not obsolete but has an obsolete ancestor.

:suspended:    an obsolete changeset with unstable descendant.

:extinct:      an obsolete changeset without unstable descendant.

               (subject to garbage collection)

Another name for unstable could be out of sync.

Usage and Feature

=================

Display and Exchange

--------------------

obsolete changesets are hidden. (except if they have non obsolete changeset)

obsolete changesets are not exchanged. This will probably change later but it

was the simpler solution for now.

New commands

------------

Note that rebased changesets are not marked obsolete rather than being stripped

In this experimental extensions, this is done forcing the --keep option. Trying

to use the --keep option of rebase with this extensionn this experimental

extension will cause such a call to abort. Until better releasen please use

graft command to rebase and copy changesets.

Context object

--------------

Context gains a ``obsolete`` method that will return True if a changeset is

obsolete False otherwise.

revset

------

Add an ``obsolete()`` entry.

repo extension

--------------

To Do

~~~~~

- refuse to obsolete published changesets

- handle split

- handle conflict

- handle unstable // out of sync

"""

import os

try:

    from cStringIO import StringIO

except ImportError:

    from StringIO import StringIO

from mercurial.i18n import _

import base64

import json

from mercurial import util

from mercurial import context

from mercurial import revset

from mercurial import scmutil

from mercurial import extensions

from mercurial import pushkey

from mercurial import discovery

from mercurial import error

from mercurial import commands

from mercurial import changelog

from mercurial import phases

from mercurial.node import hex, bin, short, nullid

from mercurial.lock import release

from mercurial import localrepo

from mercurial import cmdutil

from mercurial import templatekw

try:

    from mercurial.localrepo import storecache

    storecache('babar') # to trigger import

except (TypeError, ImportError):

    def storecache(*args):

        return scmutil.filecache(*args, instore=True)

### Patch changectx

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

def obsolete(ctx):

    """is the changeset obsolete by other"""

    if ctx.node()is None:

        return False

    return bool(ctx._repo.obsoletedby(ctx.node())) and ctx.phase()

context.changectx.obsolete = obsolete

def unstable(ctx):

    """is the changeset unstable (have obsolete ancestor)"""

    if ctx.node() is None:

        return False

    return ctx.rev() in ctx._repo._unstableset

context.changectx.unstable = unstable

def extinct(ctx):

    """is the changeset extinct by other"""

    if ctx.node() is None:

        return False

    return ctx.rev() in ctx._repo._extinctset

context.changectx.extinct = extinct

### revset

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

def revsetobsolete(repo, subset, x):

    """obsolete changesets"""

    args = revset.getargs(x, 0, 0, 'obsolete takes no argument')

    return [r for r in subset if r in repo._obsoleteset and repo._phasecache.phase(repo, r) > 0]

# XXX Backward compatibility, to be removed once stabilized

if '_phasecache' not in vars(localrepo.localrepository): # new api

    def revsetobsolete(repo, subset, x):

        """obsolete changesets"""

        args = revset.getargs(x, 0, 0, 'obsolete takes no argument')

        return [r for r in subset if r in repo._obsoleteset and repo._phaserev[r] > 0]

def revsetunstable(repo, subset, x):

    """non obsolete changesets descendant of obsolete one"""

    args = revset.getargs(x, 0, 0, 'unstable takes no arguments')

    return [r for r in subset if r in repo._unstableset]

def revsetsuspended(repo, subset, x):

    """obsolete changesets with non obsolete descendants"""

    args = revset.getargs(x, 0, 0, 'unstable takes no arguments')

    return [r for r in subset if r in repo._suspendedset]

def revsetextinct(repo, subset, x):

    """obsolete changesets without obsolete descendants"""

    args = revset.getargs(x, 0, 0, 'unstable takes no arguments')

    return [r for r in subset if r in repo._extinctset]

def _obsparents(repo, s):

    """obsolete parents of a subset"""

    cs = set()

    nm = repo.changelog.nodemap

    markerbysubj = repo.obsoletestore.subjects

    for r in s:

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

            pr = nm.get(p['object'])

            if pr is not None:

                cs.add(pr)

    return cs

def revsetobsparents(repo, subset, x):

    """obsolete parents"""

    s = revset.getset(repo, range(len(repo)), x)

    cs = _obsparents(repo, s)

    return [r for r in subset if r in cs]

def _obsancestors(repo, s):

    """obsolete ancestors of a subset"""

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

    seen = set()

    allsubjects = repo.obsoletestore.subjects

    while toproceed:

        nc = toproceed.pop()

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

            np = mark['object']

            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)

    return cs

def revsetobsancestors(repo, subset, x):

    """obsolete parents"""

    s = revset.getset(repo, range(len(repo)), x)

    cs = _obsancestors(repo, s)

    return [r for r in subset if r in cs]

### template keywords

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

def obsoletekw(repo, ctx, templ, **args):

    """:obsolete: String. The obsolescence level of the node, could be

    ``stable``, ``unstable``, ``suspended`` or ``extinct``.

    """

    rev = ctx.rev()

    if rev in repo._extinctset:

        return 'extinct'

    if rev in repo._suspendedset:

        return 'suspended'

    if rev in repo._unstableset:

        return 'unstable'

    return 'stable'

### Other Extension compat

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

def buildstate(orig, repo, dest, rebaseset, *ags, **kws):

    """wrapper for rebase 's buildstate that exclude obsolete changeset"""

    rebaseset = repo.revs('%ld - extinct()', rebaseset)

    return orig(repo, dest, rebaseset, *ags, **kws)

def defineparents(orig, repo, rev, target, state, *args, **kwargs):

    rebasestate = getattr(repo, '_rebasestate', None)

    if rebasestate is not None:

        repo._rebasestate = dict(state)

        repo._rebasetarget = target

    return orig(repo, rev, target, state, *args, **kwargs)

def concludenode(orig, repo, rev, p1, *args, **kwargs):

    """wrapper for rebase 's concludenode that set obsolete relation"""

    newrev = orig(repo, rev, p1, *args, **kwargs)

    rebasestate = getattr(repo, '_rebasestate', None)

    if rebasestate is not None:

        if newrev is not None:

            nrev = repo[newrev].rev()

        else:

            nrev = p1

        repo._rebasestate[rev] = nrev

    return newrev

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

    if kwargs.get('keep', False):

        raise util.Abort(_('rebase --keep option is unsupported with obsolete '

                           'extension'), hint=_("see 'hg help obsolete'"))

    kwargs = dict(kwargs)

    kwargs['keep'] = True

    # We want to mark rebased revision as obsolete and set their

    # replacements if any. Doing it in concludenode() prevents

    # aborting the rebase, and is not called with all relevant

    # revisions in --collapse case. Instead, we try to track the

    # rebase state structure by sampling/updating it in

    # defineparents() and concludenode(). The obsolete markers are

    # added from this state after a successful call.

    repo._rebasestate = {}

    repo._rebasetarget = None

    maxrev = len(repo) - 1

    try:

        res = orig(ui, repo, *args, **kwargs)

        # Filter nullmerge or unrebased entries

        repo._rebasestate = dict(p for p in repo._rebasestate.iteritems()

                                 if p[1] >= 0)

        if not res and not kwargs.get('abort') and repo._rebasestate:

            # Rebased revisions are assumed to be descendants of

            # targetrev. If a source revision is mapped to targetrev

            # or to another rebased revision, it must have been

            # removed.

            targetrev = repo[repo._rebasetarget].rev()

            newrevs = set([targetrev])

            replacements = {}

            for rev, newrev in sorted(repo._rebasestate.items()):

                oldnode = repo[rev].node()

                if newrev not in newrevs:

                    newnode = repo[newrev].node()

                    newrevs.add(newrev)

                else:

                    newnode = nullid

                replacements[oldnode] = newnode

            if kwargs.get('collapse'):

                newnodes = set(n for n in replacements.values() if n != nullid)

                if newnodes:

                    # Collapsing into more than one revision?

                    assert len(newnodes) == 1, newnodes

                    newnode = newnodes.pop()

                else:

                    newnode = nullid

                repo.addcollapsedobsolete(replacements, newnode)

            else:

                for oldnode, newnode in replacements.iteritems():

                    repo.addobsolete(newnode, oldnode)

        return res

    finally:

        delattr(repo, '_rebasestate')

        delattr(repo, '_rebasetarget')

def extsetup(ui):

    revset.symbols["obsolete"] = revsetobsolete

    revset.symbols["unstable"] = revsetunstable

    revset.symbols["suspended"] = revsetsuspended

    revset.symbols["extinct"] = revsetextinct

    revset.symbols["obsparents"] = revsetobsparents

    revset.symbols["obsancestors"] = revsetobsancestors

    templatekw.keywords['obsolete'] = obsoletekw

    try:

        rebase = extensions.find('rebase')

        if rebase:

            extensions.wrapfunction(rebase, 'buildstate', buildstate)

            extensions.wrapfunction(rebase, 'defineparents', defineparents)

            extensions.wrapfunction(rebase, 'concludenode', concludenode)

            extensions.wrapcommand(rebase.cmdtable, "rebase", cmdrebase)

    except KeyError:

        pass # rebase not found

# Pushkey mechanism for mutable

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

def pushobsolete(repo, key, old, raw):

    """push obsolete relation through pushkey"""

    assert key == "markers"

    l = repo.lock()

    try:

        tmp = StringIO()

        tmp.write(raw)

        tmp.seek(0)

        repo.obsoletestore.load(tmp)

        repo.obsoletestore._dirty = True # XXX meh

        return 1

    finally:

        l.release()

def listobsolete(repo):

    """dump all obsolete relation in

    XXX this have be improved"""

    tmp = StringIO()

    repo.obsoletestore.save(tmp)

    return {'markers': base64.b64encode(tmp.getvalue())}

pushkey.register('obsolete', pushobsolete, listobsolete)

### Discovery wrapping

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

class blist(list, object):

    """silly class to have non False but empty list"""

    def __nonzero__(self):

        return bool(len(self.orig))

def wrapfindcommonoutgoing(orig, repo, *args, **kwargs):

    """wrap mercurial.discovery.findcommonoutgoing to remove extinct changeset

    Such excluded changeset are removed from excluded  and will *not* appear

    are excluded secret changeset.

    """

    outgoing = orig(repo, *args, **kwargs)

    orig = outgoing.excluded