""" Mercurial phases support code

    ---

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

                   Logilab SA        <contact@logilab.fr>

                   Augie Fackler     <durin42@gmail.com>

    This software may be used and distributed according to the terms

    of the GNU General Public License version 2 or any later version.

    ---

This module implements most phase logic in mercurial.

Basic Concept

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

A 'changeset phase' is an indicator that tells us how a changeset is

manipulated and communicated. The details of each phase is described

below, here we describe the properties they have in common.

Like bookmarks, phases are not stored in history and thus are not

permanent and leave no audit trail.

First, no changeset can be in two phases at once. Phases are ordered,

so they can be considered from lowest to highest. The default, lowest

phase is 'public' - this is the normal phase of existing changesets. A

child changeset can not be in a lower phase than its parents.

These phases share a hierarchy of traits:

            immutable shared

    public:     X        X

    draft:               X

    secret:

Local commits are draft by default.

Phase Movement and Exchange

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

Phase data is exchanged by pushkey on pull and push. Some servers have

a publish option set, we call such a server a "publishing server".

Pushing a draft changeset to a publishing server changes the phase to

public.

A small list of fact/rules define the exchange of phase:

* old client never changes server states

* pull never changes server states

* publish and old server changesets are seen as public by client

* any secret changeset seen in another repository is lowered to at

  least draft

Here is the final table summing up the 49 possible use cases of phase

exchange:

                           server

                  old     publish      non-publish

                 N   X    N   D   P    N   D   P

    old client

    pull

     N           -   X/X  -   X/D X/P  -   X/D X/P

     X           -   X/X  -   X/D X/P  -   X/D X/P

    push

     X           X/X X/X  X/P X/P X/P  X/D X/D X/P

    new client

    pull

     N           -   P/X  -   P/D P/P  -   D/D P/P

     D           -   P/X  -   P/D P/P  -   D/D P/P

     P           -   P/X  -   P/D P/P  -   P/D P/P

    push

     D           P/X P/X  P/P P/P P/P  D/D D/D P/P

     P           P/X P/X  P/P P/P P/P  P/P P/P P/P

Legend:

    A/B = final state on client / state on server

    * N = new/not present,

    * P = public,

    * D = draft,

    * X = not tracked (i.e., the old client or server has no internal

          way of recording the phase.)

    passive = only pushes

    A cell here can be read like this:

    "When a new client pushes a draft changeset (D) to a publishing

    server where it's not present (N), it's marked public on both

    sides (P/P)."

Note: old client behave as a publishing server with draft only content

- other people see it as public

- content is pushed as draft

"""

from __future__ import absolute_import

import errno

import struct

from .i18n import _

from .node import (

    bin,

    hex,

    nullid,

    nullrev,

    short,

)

from .pycompat import (

    getattr,

    setattr,

)

from . import (

    error,

    pycompat,

    smartset,

    txnutil,

    util,

)

_fphasesentry = struct.Struct(b'>i20s')

INTERNAL_FLAG = 64  # Phases for mercurial internal usage only

HIDEABLE_FLAG = 32  # Phases that are hideable

# record phase index

public, draft, secret = range(3)

internal = INTERNAL_FLAG | HIDEABLE_FLAG

archived = HIDEABLE_FLAG

allphases = range(internal + 1)

trackedphases = allphases[1:]

# record phase names

cmdphasenames = [b'public', b'draft', b'secret']  # known to `hg phase` command

phasenames = [None] * len(allphases)

phasenames[: len(cmdphasenames)] = cmdphasenames

phasenames[archived] = b'archived'

phasenames[internal] = b'internal'

# record phase property

mutablephases = tuple(allphases[1:])

remotehiddenphases = tuple(allphases[2:])

localhiddenphases = tuple(p for p in allphases if p & HIDEABLE_FLAG)

def supportinternal(repo):

    """True if the internal phase can be used on a repository"""

    return b'internal-phase' in repo.requirements

def _readroots(repo, phasedefaults=None):

    """Read phase roots from disk

    phasedefaults is a list of fn(repo, roots) callable, which are

    executed if the phase roots file does not exist. When phases are

    being initialized on an existing repository, this could be used to

    set selected changesets phase to something else than public.

    Return (roots, dirty) where dirty is true if roots differ from

    what is being stored.

    """

    repo = repo.unfiltered()

    dirty = False

    roots = [set() for i in allphases]

    try:

        f, pending = txnutil.trypending(repo.root, repo.svfs, b'phaseroots')

        try:

            for line in f:

                phase, nh = line.split()

                roots[int(phase)].add(bin(nh))

        finally:

            f.close()

    except IOError as inst:

        if inst.errno != errno.ENOENT:

            raise

        if phasedefaults:

            for f in phasedefaults:

                roots = f(repo, roots)

        dirty = True

    return roots, dirty

def binaryencode(phasemapping):

    """encode a 'phase -> nodes' mapping into a binary stream

    Since phases are integer the mapping is actually a python list:

    [[PUBLIC_HEADS], [DRAFTS_HEADS], [SECRET_HEADS]]

    """

    binarydata = []

    for phase, nodes in enumerate(phasemapping):

        for head in nodes:

            binarydata.append(_fphasesentry.pack(phase, head))

    return b''.join(binarydata)

def binarydecode(stream):

    """decode a binary stream into a 'phase -> nodes' mapping

    Since phases are integer the mapping is actually a python list."""

    headsbyphase = [[] for i in allphases]

    entrysize = _fphasesentry.size

    while True:

        entry = stream.read(entrysize)

        if len(entry) < entrysize:

            if entry:

                raise error.Abort(_(b'bad phase-heads stream'))

            break

        phase, node = _fphasesentry.unpack(entry)

        headsbyphase[phase].append(node)

    return headsbyphase

def _trackphasechange(data, rev, old, new):

    """add a phase move the <data> dictionnary

    If data is None, nothing happens.

    """

    if data is None:

        return

    existing = data.get(rev)

    if existing is not None:

        old = existing[0]

    data[rev] = (old, new)

class phasecache(object):

    def __init__(self, repo, phasedefaults, _load=True):

        if _load:

            # Cheap trick to allow shallow-copy without copy module

            self.phaseroots, self.dirty = _readroots(repo, phasedefaults)

            self._loadedrevslen = 0

            self._phasesets = None

            self.filterunknown(repo)

            self.opener = repo.svfs

    def getrevset(self, repo, phases, subset=None):

        """return a smartset for the given phases"""

        self.loadphaserevs(repo)  # ensure phase's sets are loaded

        phases = set(phases)

        if public not in phases:

            # fast path: _phasesets contains the interesting sets,

            # might only need a union and post-filtering.

            if len(phases) == 1:

                [p] = phases

                revs = self._phasesets[p]

            else:

                revs = set.union(*[self._phasesets[p] for p in phases])

            if repo.changelog.filteredrevs:

                revs = revs - repo.changelog.filteredrevs

            if subset is None:

                return smartset.baseset(revs)

            else:

                return subset & smartset.baseset(revs)

        else:

            phases = set(allphases).difference(phases)

            if not phases:

                return smartset.fullreposet(repo)

            if len(phases) == 1:

                [p] = phases

                revs = self._phasesets[p]

            else:

                revs = set.union(*[self._phasesets[p] for p in phases])

            if subset is None:

                subset = smartset.fullreposet(repo)

            if not revs:

                return subset

            return subset.filter(lambda r: r not in revs)

    def copy(self):

        # Shallow copy meant to ensure isolation in

        # advance/retractboundary(), nothing more.

        ph = self.__class__(None, None, _load=False)

        ph.phaseroots = self.phaseroots[:]

        ph.dirty = self.dirty

        ph.opener = self.opener

        ph._loadedrevslen = self._loadedrevslen

        ph._phasesets = self._phasesets

        return ph

    def replace(self, phcache):

        """replace all values in 'self' with content of phcache"""

        for a in (

            b'phaseroots',

            b'dirty',

            b'opener',

            b'_loadedrevslen',

            b'_phasesets',

        ):

            setattr(self, a, getattr(phcache, a))

    def _getphaserevsnative(self, repo):

        repo = repo.unfiltered()

        nativeroots = []

        for phase in trackedphases:

            nativeroots.append(

                pycompat.maplist(repo.changelog.rev, self.phaseroots[phase])

            )

        return repo.changelog.computephases(nativeroots)

    def _computephaserevspure(self, repo):

        repo = repo.unfiltered()

        cl = repo.changelog

        self._phasesets = [set() for phase in allphases]

        lowerroots = set()

        for phase in reversed(trackedphases):

            roots = pycompat.maplist(cl.rev, self.phaseroots[phase])

            if roots:

                ps = set(cl.descendants(roots))

                for root in roots:

                    ps.add(root)

                ps.difference_update(lowerroots)

                lowerroots.update(ps)

                self._phasesets[phase] = ps

        self._loadedrevslen = len(cl)

    def loadphaserevs(self, repo):

        """ensure phase information is loaded in the object"""

        if self._phasesets is None:

            try:

                res = self._getphaserevsnative(repo)

                self._loadedrevslen, self._phasesets = res

            except AttributeError:

                self._computephaserevspure(repo)

    def invalidate(self):

        self._loadedrevslen = 0

        self._phasesets = None

    def phase(self, repo, rev):

        # We need a repo argument here to be able to build _phasesets

        # if necessary. The repository instance is not stored in

        # phasecache to avoid reference cycles. The changelog instance

        # is not stored because it is a filecache() property and can

        # be replaced without us being notified.

        if rev == nullrev:

            return public

        if rev < nullrev:

            raise ValueError(_(b'cannot lookup negative revision'))

        if rev >= self._loadedrevslen:

            self.invalidate()

            self.loadphaserevs(repo)

        for phase in trackedphases:

            if rev in self._phasesets[phase]:

                return phase

        return public

    def write(self):

        if not self.dirty:

            return

        f = self.opener(b'phaseroots', b'w', atomictemp=True, checkambig=True)

        try:

            self._write(f)

        finally:

            f.close()

    def _write(self, fp):

        for phase, roots in enumerate(self.phaseroots):

            for h in sorted(roots):

                fp.write(b'%i %s\n' % (phase, hex(h)))

        self.dirty = False

    def _updateroots(self, phase, newroots, tr):

        self.phaseroots[phase] = newroots

        self.invalidate()

        self.dirty = True

        tr.addfilegenerator(b'phase', (b'phaseroots',), self._write)

        tr.hookargs[b'phases_moved'] = b'1'

    def registernew(self, repo, tr, targetphase, nodes):

        repo = repo.unfiltered()

        self._retractboundary(repo, tr, targetphase, nodes)

        if tr is not None and b'phases' in tr.changes:

            phasetracking = tr.changes[b'phases']

            torev = repo.changelog.rev

            phase = self.phase

            for n in nodes:

                rev = torev(n)

                revphase = phase(repo, rev)

                _trackphasechange(phasetracking, rev, None, revphase)

        repo.invalidatevolatilesets()

    def advanceboundary(self, repo, tr, targetphase, nodes, dryrun=None):

        """Set all 'nodes' to phase 'targetphase'

        Nodes with a phase lower than 'targetphase' are not affected.