# subrepo.py - sub-repository handling for Mercurial

#

# Copyright 2009-2010 Matt Mackall <mpm@selenic.com>

#

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

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

from __future__ import absolute_import

import copy

import errno

import hashlib

import os

import posixpath

import re

import stat

import subprocess

import sys

import tarfile

import xml.dom.minidom

from .i18n import _

from . import (

    cmdutil,

    config,

    encoding,

    error,

    exchange,

    filemerge,

    match as matchmod,

    node,

    pathutil,

    phases,

    pycompat,

    scmutil,

    util,

    vfs as vfsmod,

)

hg = None

propertycache = util.propertycache

nullstate = ('', '', 'empty')

def _expandedabspath(path):

    '''

    get a path or url and if it is a path expand it and return an absolute path

    '''

    expandedpath = util.urllocalpath(util.expandpath(path))

    u = util.url(expandedpath)

    if not u.scheme:

        path = util.normpath(os.path.abspath(u.path))

    return path

def _getstorehashcachename(remotepath):

    '''get a unique filename for the store hash cache of a remote repository'''

    return node.hex(hashlib.sha1(_expandedabspath(remotepath)).digest())[0:12]

class SubrepoAbort(error.Abort):

    """Exception class used to avoid handling a subrepo error more than once"""

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

        self.subrepo = kw.pop(r'subrepo', None)

        self.cause = kw.pop(r'cause', None)

        error.Abort.__init__(self, *args, **kw)

def annotatesubrepoerror(func):

    def decoratedmethod(self, *args, **kargs):

        try:

            res = func(self, *args, **kargs)

        except SubrepoAbort as ex:

            # This exception has already been handled

            raise ex

        except error.Abort as ex:

            subrepo = subrelpath(self)

            errormsg = str(ex) + ' ' + _('(in subrepository "%s")') % subrepo

            # avoid handling this exception by raising a SubrepoAbort exception

            raise SubrepoAbort(errormsg, hint=ex.hint, subrepo=subrepo,

                               cause=sys.exc_info())

        return res

    return decoratedmethod

def state(ctx, ui):

    """return a state dict, mapping subrepo paths configured in .hgsub

    to tuple: (source from .hgsub, revision from .hgsubstate, kind

    (key in types dict))

    """

    p = config.config()

    repo = ctx.repo()

    def read(f, sections=None, remap=None):

        if f in ctx:

            try:

                data = ctx[f].data()

            except IOError as err:

                if err.errno != errno.ENOENT:

                    raise

                # handle missing subrepo spec files as removed

                ui.warn(_("warning: subrepo spec file \'%s\' not found\n") %

                        repo.pathto(f))

                return

            p.parse(f, data, sections, remap, read)

        else:

            raise error.Abort(_("subrepo spec file \'%s\' not found") %

                             repo.pathto(f))

    if '.hgsub' in ctx:

        read('.hgsub')

    for path, src in ui.configitems('subpaths'):

        p.set('subpaths', path, src, ui.configsource('subpaths', path))

    rev = {}

    if '.hgsubstate' in ctx:

        try:

            for i, l in enumerate(ctx['.hgsubstate'].data().splitlines()):

                l = l.lstrip()

                if not l:

                    continue

                try:

                    revision, path = l.split(" ", 1)

                except ValueError:

                    raise error.Abort(_("invalid subrepository revision "

                                       "specifier in \'%s\' line %d")

                                     % (repo.pathto('.hgsubstate'), (i + 1)))

                rev[path] = revision

        except IOError as err:

            if err.errno != errno.ENOENT:

                raise

    def remap(src):

        for pattern, repl in p.items('subpaths'):

            # Turn r'C:\foo\bar' into r'C:\\foo\\bar' since re.sub

            # does a string decode.

            repl = util.escapestr(repl)

            # However, we still want to allow back references to go

            # through unharmed, so we turn r'\\1' into r'\1'. Again,

            # extra escapes are needed because re.sub string decodes.

            repl = re.sub(br'\\\\([0-9]+)', br'\\\1', repl)

            try:

                src = re.sub(pattern, repl, src, 1)

            except re.error as e:

                raise error.Abort(_("bad subrepository pattern in %s: %s")

                                 % (p.source('subpaths', pattern), e))

        return src

    state = {}

    for path, src in p[''].items():

        kind = 'hg'

        if src.startswith('['):

            if ']' not in src:

                raise error.Abort(_('missing ] in subrepository source'))

            kind, src = src.split(']', 1)

            kind = kind[1:]

            src = src.lstrip() # strip any extra whitespace after ']'

        if not util.url(src).isabs():

            parent = _abssource(repo, abort=False)

            if parent:

                parent = util.url(parent)

                parent.path = posixpath.join(parent.path or '', src)

                parent.path = posixpath.normpath(parent.path)

                joined = str(parent)

                # Remap the full joined path and use it if it changes,

                # else remap the original source.

                remapped = remap(joined)

                if remapped == joined:

                    src = remap(src)

                else:

                    src = remapped

        src = remap(src)

        state[util.pconvert(path)] = (src.strip(), rev.get(path, ''), kind)

    return state

def writestate(repo, state):

    """rewrite .hgsubstate in (outer) repo with these subrepo states"""

    lines = ['%s %s\n' % (state[s][1], s) for s in sorted(state)

                                                if state[s][1] != nullstate[1]]

    repo.wwrite('.hgsubstate', ''.join(lines), '')

def submerge(repo, wctx, mctx, actx, overwrite, labels=None):

    """delegated from merge.applyupdates: merging of .hgsubstate file

    in working context, merging context and ancestor context"""

    if mctx == actx: # backwards?

        actx = wctx.p1()

    s1 = wctx.substate

    s2 = mctx.substate

    sa = actx.substate

    sm = {}

    repo.ui.debug("subrepo merge %s %s %s\n" % (wctx, mctx, actx))

    def debug(s, msg, r=""):

        if r:

            r = "%s:%s:%s" % r

        repo.ui.debug("  subrepo %s: %s %s\n" % (s, msg, r))

    promptssrc = filemerge.partextras(labels)

    for s, l in sorted(s1.iteritems()):

        prompts = None

        a = sa.get(s, nullstate)

        ld = l # local state with possible dirty flag for compares

        if wctx.sub(s).dirty():

            ld = (l[0], l[1] + "+")

        if wctx == actx: # overwrite

            a = ld

        prompts = promptssrc.copy()

        prompts['s'] = s

        if s in s2:

            r = s2[s]

            if ld == r or r == a: # no change or local is newer

                sm[s] = l

                continue

            elif ld == a: # other side changed

                debug(s, "other changed, get", r)

                wctx.sub(s).get(r, overwrite)

                sm[s] = r

            elif ld[0] != r[0]: # sources differ

                prompts['lo'] = l[0]

                prompts['ro'] = r[0]

                if repo.ui.promptchoice(

                    _(' subrepository sources for %(s)s differ\n'

                      'use (l)ocal%(l)s source (%(lo)s)'

                      ' or (r)emote%(o)s source (%(ro)s)?'

                      '$$ &Local $$ &Remote') % prompts, 0):

                    debug(s, "prompt changed, get", r)

                    wctx.sub(s).get(r, overwrite)

                    sm[s] = r

            elif ld[1] == a[1]: # local side is unchanged

                debug(s, "other side changed, get", r)

                wctx.sub(s).get(r, overwrite)

                sm[s] = r

            else:

                debug(s, "both sides changed")

                srepo = wctx.sub(s)

                prompts['sl'] = srepo.shortid(l[1])

                prompts['sr'] = srepo.shortid(r[1])

                option = repo.ui.promptchoice(

                    _(' subrepository %(s)s diverged (local revision: %(sl)s, '

                      'remote revision: %(sr)s)\n'

                      '(M)erge, keep (l)ocal%(l)s or keep (r)emote%(o)s?'

                      '$$ &Merge $$ &Local $$ &Remote')

                    % prompts, 0)

                if option == 0:

                    wctx.sub(s).merge(r)

                    sm[s] = l

                    debug(s, "merge with", r)

                elif option == 1:

                    sm[s] = l

                    debug(s, "keep local subrepo revision", l)

                else:

                    wctx.sub(s).get(r, overwrite)

                    sm[s] = r

                    debug(s, "get remote subrepo revision", r)

        elif ld == a: # remote removed, local unchanged

            debug(s, "remote removed, remove")

            wctx.sub(s).remove()

        elif a == nullstate: # not present in remote or ancestor

            debug(s, "local added, keep")

            sm[s] = l

            continue

        else:

            if repo.ui.promptchoice(

                _(' local%(l)s changed subrepository %(s)s'

                  ' which remote%(o)s removed\n'

                  'use (c)hanged version or (d)elete?'

                  '$$ &Changed $$ &Delete') % prompts, 0):

                debug(s, "prompt remove")

                wctx.sub(s).remove()

    for s, r in sorted(s2.items()):

        prompts = None

        if s in s1:

            continue

        elif s not in sa:

            debug(s, "remote added, get", r)

            mctx.sub(s).get(r)

            sm[s] = r

        elif r != sa[s]:

            prompts = promptssrc.copy()

            prompts['s'] = s

            if repo.ui.promptchoice(

                _(' remote%(o)s changed subrepository %(s)s'

                  ' which local%(l)s removed\n'

                  'use (c)hanged version or (d)elete?'

                  '$$ &Changed $$ &Delete') % prompts, 0) == 0:

                debug(s, "prompt recreate", r)

                mctx.sub(s).get(r)

                sm[s] = r

    # record merged .hgsubstate

    writestate(repo, sm)

    return sm

def precommit(ui, wctx, status, match, force=False):

    """Calculate .hgsubstate changes that should be applied before committing

    Returns (subs, commitsubs, newstate) where

    - subs: changed subrepos (including dirty ones)

    - commitsubs: dirty subrepos which the caller needs to commit recursively

    - newstate: new state dict which the caller must write to .hgsubstate

    This also updates the given status argument.

    """

    subs = []

    commitsubs = set()

    newstate = wctx.substate.copy()

    # only manage subrepos and .hgsubstate if .hgsub is present

    if '.hgsub' in wctx:

        # we'll decide whether to track this ourselves, thanks

        for c in status.modified, status.added, status.removed:

            if '.hgsubstate' in c:

                c.remove('.hgsubstate')

        # compare current state to last committed state

        # build new substate based on last committed state

        oldstate = wctx.p1().substate

        for s in sorted(newstate.keys()):

            if not match(s):

                # ignore working copy, use old state if present

                if s in oldstate:

                    newstate[s] = oldstate[s]

                    continue

                if not force:

                    raise error.Abort(

                        _("commit with new subrepo %s excluded") % s)

            dirtyreason = wctx.sub(s).dirtyreason(True)

            if dirtyreason:

                if not ui.configbool('ui', 'commitsubrepos'):

                    raise error.Abort(dirtyreason,

                        hint=_("use --subrepos for recursive commit"))

                subs.append(s)

                commitsubs.add(s)

            else:

                bs = wctx.sub(s).basestate()

                newstate[s] = (newstate[s][0], bs, newstate[s][2])

                if oldstate.get(s, (None, None, None))[1] != bs:

                    subs.append(s)

        # check for removed subrepos

        for p in wctx.parents():

            r = [s for s in p.substate if s not in newstate]

            subs += [s for s in r if match(s)]

        if subs:

            if (not match('.hgsub') and

                '.hgsub' in (wctx.modified() + wctx.added())):

                raise error.Abort(_("can't commit subrepos without .hgsub"))

            status.modified.insert(0, '.hgsubstate')

    elif '.hgsub' in status.removed:

        # clean up .hgsubstate when .hgsub is removed

        if ('.hgsubstate' in wctx and

            '.hgsubstate' not in (status.modified + status.added +

                                  status.removed)):

            status.removed.insert(0, '.hgsubstate')