# hg.py - repository classes for mercurial

#

# Copyright 2005-2007 Matt Mackall <mpm@selenic.com>

# Copyright 2006 Vadim Gelfer <vadim.gelfer@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.

from __future__ import absolute_import

import errno

import os

import shutil

import stat

from .i18n import _

from .node import nullid

from .pycompat import getattr

from . import (

    bookmarks,

    bundlerepo,

    cacheutil,

    cmdutil,

    destutil,

    discovery,

    error,

    exchange,

    extensions,

    httppeer,

    localrepo,

    lock,

    logcmdutil,

    logexchange,

    merge as mergemod,

    narrowspec,

    node,

    phases,

    pycompat,

    scmutil,

    sshpeer,

    statichttprepo,

    ui as uimod,

    unionrepo,

    url,

    util,

    verify as verifymod,

    vfs as vfsmod,

)

from .utils import hashutil

from .interfaces import repository as repositorymod

release = lock.release

# shared features

sharedbookmarks = b'bookmarks'

def _local(path):

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

    try:

        isfile = os.path.isfile(path)

    # Python 2 raises TypeError, Python 3 ValueError.

    except (TypeError, ValueError) as e:

        raise error.Abort(

            _(b'invalid path %s: %s') % (path, pycompat.bytestr(e))

        )

    return isfile and bundlerepo or localrepo

def addbranchrevs(lrepo, other, branches, revs):

    peer = other.peer()  # a courtesy to callers using a localrepo for other

    hashbranch, branches = branches

    if not hashbranch and not branches:

        x = revs or None

        if revs:

            y = revs[0]

        else:

            y = None

        return x, y

    if revs:

        revs = list(revs)

    else:

        revs = []

    if not peer.capable(b'branchmap'):

        if branches:

            raise error.Abort(_(b"remote branch lookup not supported"))

        revs.append(hashbranch)

        return revs, revs[0]

    with peer.commandexecutor() as e:

        branchmap = e.callcommand(b'branchmap', {}).result()

    def primary(branch):

        if branch == b'.':

            if not lrepo:

                raise error.Abort(_(b"dirstate branch not accessible"))

            branch = lrepo.dirstate.branch()

        if branch in branchmap:

            revs.extend(node.hex(r) for r in reversed(branchmap[branch]))

            return True

        else:

            return False

    for branch in branches:

        if not primary(branch):

            raise error.RepoLookupError(_(b"unknown branch '%s'") % branch)

    if hashbranch:

        if not primary(hashbranch):

            revs.append(hashbranch)

    return revs, revs[0]

def parseurl(path, branches=None):

    '''parse url#branch, returning (url, (branch, branches))'''

    u = util.url(path)

    branch = None

    if u.fragment:

        branch = u.fragment

        u.fragment = None

    return bytes(u), (branch, branches or [])

schemes = {

    b'bundle': bundlerepo,

    b'union': unionrepo,

    b'file': _local,

    b'http': httppeer,

    b'https': httppeer,

    b'ssh': sshpeer,

    b'static-http': statichttprepo,

}

def _peerlookup(path):

    u = util.url(path)

    scheme = u.scheme or b'file'

    thing = schemes.get(scheme) or schemes[b'file']

    try:

        return thing(path)

    except TypeError:

        # we can't test callable(thing) because 'thing' can be an unloaded

        # module that implements __call__

        if not util.safehasattr(thing, b'instance'):

            raise

        return thing

def islocal(repo):

    '''return true if repo (or path pointing to repo) is local'''

    if isinstance(repo, bytes):

        try:

            return _peerlookup(repo).islocal(repo)

        except AttributeError:

            return False

    return repo.local()

def openpath(ui, path, sendaccept=True):

    '''open path with open if local, url.open if remote'''

    pathurl = util.url(path, parsequery=False, parsefragment=False)

    if pathurl.islocal():

        return util.posixfile(pathurl.localpath(), b'rb')

    else:

        return url.open(ui, path, sendaccept=sendaccept)

# a list of (ui, repo) functions called for wire peer initialization

wirepeersetupfuncs = []

def _peerorrepo(

    ui, path, create=False, presetupfuncs=None, intents=None, createopts=None

):

    """return a repository object for the specified path"""

    obj = _peerlookup(path).instance(

        ui, path, create, intents=intents, createopts=createopts

    )

    ui = getattr(obj, "ui", ui)

    for f in presetupfuncs or []:

        f(ui, obj)

    ui.log(b'extension', b'- executing reposetup hooks\n')

    with util.timedcm('all reposetup') as allreposetupstats:

        for name, module in extensions.extensions(ui):

            ui.log(b'extension', b'  - running reposetup for %s\n', name)

            hook = getattr(module, 'reposetup', None)

            if hook:

                with util.timedcm('reposetup %r', name) as stats:

                    hook(ui, obj)

                ui.log(

                    b'extension', b'  > reposetup for %s took %s\n', name, stats

                )

    ui.log(b'extension', b'> all reposetup took %s\n', allreposetupstats)

    if not obj.local():

        for f in wirepeersetupfuncs:

            f(ui, obj)

    return obj

def repository(

    ui,

    path=b'',

    create=False,

    presetupfuncs=None,

    intents=None,

    createopts=None,

):

    """return a repository object for the specified path"""

    peer = _peerorrepo(

        ui,

        path,

        create,

        presetupfuncs=presetupfuncs,

        intents=intents,

        createopts=createopts,

    )

    repo = peer.local()

    if not repo:

        raise error.Abort(

            _(b"repository '%s' is not local") % (path or peer.url())

        )

    return repo.filtered(b'visible')

def peer(uiorrepo, opts, path, create=False, intents=None, createopts=None):

    '''return a repository peer for the specified path'''

    rui = remoteui(uiorrepo, opts)

    return _peerorrepo(

        rui, path, create, intents=intents, createopts=createopts

    ).peer()

def defaultdest(source):

    '''return default destination of clone if none is given

    >>> defaultdest(b'foo')

    'foo'

    >>> defaultdest(b'/foo/bar')

    'bar'

    >>> defaultdest(b'/')

    ''

    >>> defaultdest(b'')

    ''

    >>> defaultdest(b'http://example.org/')

    ''

    >>> defaultdest(b'http://example.org/foo/')

    'foo'

    '''

    path = util.url(source).path

    if not path:

        return b''

    return os.path.basename(os.path.normpath(path))

def sharedreposource(repo):

    """Returns repository object for source repository of a shared repo.

    If repo is not a shared repository, returns None.

    """

    if repo.sharedpath == repo.path:

        return None

    if util.safehasattr(repo, b'srcrepo') and repo.srcrepo:

        return repo.srcrepo

    # the sharedpath always ends in the .hg; we want the path to the repo

    source = repo.vfs.split(repo.sharedpath)[0]

    srcurl, branches = parseurl(source)

    srcrepo = repository(repo.ui, srcurl)

    repo.srcrepo = srcrepo

    return srcrepo

def share(

    ui,

    source,

    dest=None,

    update=True,

    bookmarks=True,

    defaultpath=None,

    relative=False,

):

    '''create a shared repository'''

    if not islocal(source):

        raise error.Abort(_(b'can only share local repositories'))

    if not dest:

        dest = defaultdest(source)

    else:

        dest = ui.expandpath(dest)

    if isinstance(source, bytes):

        origsource = ui.expandpath(source)

        source, branches = parseurl(origsource)

        srcrepo = repository(ui, source)

        rev, checkout = addbranchrevs(srcrepo, srcrepo, branches, None)

    else:

        srcrepo = source.local()

        checkout = None

    shareditems = set()

    if bookmarks:

        shareditems.add(sharedbookmarks)

    r = repository(

        ui,

        dest,

        create=True,

        createopts={

            b'sharedrepo': srcrepo,

            b'sharedrelative': relative,

            b'shareditems': shareditems,

        },

    )

    postshare(srcrepo, r, defaultpath=defaultpath)

    r = repository(ui, dest)

    _postshareupdate(r, update, checkout=checkout)

    return r

def unshare(ui, repo):

    """convert a shared repository to a normal one

    Copy the store data to the repo and remove the sharedpath data.

    Returns a new repository object representing the unshared repository.

    The passed repository object is not usable after this function is

    called.

    """

    with repo.lock():

        # we use locks here because if we race with commit, we

        # can end up with extra data in the cloned revlogs that's

        # not pointed to by changesets, thus causing verify to

        # fail

        destlock = copystore(ui, repo, repo.path)

        with destlock or util.nullcontextmanager():

            sharefile = repo.vfs.join(b'sharedpath')

            util.rename(sharefile, sharefile + b'.old')

            repo.requirements.discard(b'shared')

            repo.requirements.discard(b'relshared')

            repo._writerequirements()

    # Removing share changes some fundamental properties of the repo instance.

    # So we instantiate a new repo object and operate on it rather than

    # try to keep the existing repo usable.

    newrepo = repository(repo.baseui, repo.root, create=False)

    # TODO: figure out how to access subrepos that exist, but were previously

    #       removed from .hgsub

    c = newrepo[b'.']

    subs = c.substate

    for s in sorted(subs):

        c.sub(s).unshare()

    localrepo.poisonrepository(repo)

    return newrepo

def postshare(sourcerepo, destrepo, defaultpath=None):

    """Called after a new shared repo is created.

    The new repo only has a requirements file and pointer to the source.

    This function configures additional shared data.

    Extensions can wrap this function and write additional entries to

    destrepo/.hg/shared to indicate additional pieces of data to be shared.

    """

    default = defaultpath or sourcerepo.ui.config(b'paths', b'default')

    if default:

        template = b'[paths]\ndefault = %s\n'

        destrepo.vfs.write(b'hgrc', util.tonativeeol(template % default))

    if repositorymod.NARROW_REQUIREMENT in sourcerepo.requirements:

        with destrepo.wlock():

            narrowspec.copytoworkingcopy(destrepo)

def _postshareupdate(repo, update, checkout=None):

    """Maybe perform a working directory update after a shared repo is created.

    ``update`` can be a boolean or a revision to update to.

    """

    if not update:

        return

    repo.ui.status(_(b"updating working directory\n"))

    if update is not True:

        checkout = update

    for test in (checkout, b'default', b'tip'):

        if test is None:

            continue

        try:

            uprev = repo.lookup(test)

            break

        except error.RepoLookupError:

            continue

    _update(repo, uprev)

def copystore(ui, srcrepo, destpath):

    '''copy files from store of srcrepo in destpath

    returns destlock

    '''

    destlock = None

    try:

        hardlink = None

        topic = _(b'linking') if hardlink else _(b'copying')

        with ui.makeprogress(topic, unit=_(b'files')) as progress:

            num = 0

            srcpublishing = srcrepo.publishing()

            srcvfs = vfsmod.vfs(srcrepo.sharedpath)

            dstvfs = vfsmod.vfs(destpath)

            for f in srcrepo.store.copylist():

                if srcpublishing and f.endswith(b'phaseroots'):

                    continue

                dstbase = os.path.dirname(f)

                if dstbase and not dstvfs.exists(dstbase):

                    dstvfs.mkdir(dstbase)

                if srcvfs.exists(f):

                    if f.endswith(b'data'):

                        # 'dstbase' may be empty (e.g. revlog format 0)

                        lockfile = os.path.join(dstbase, b"lock")

                        # lock to avoid premature writing to the target

                        destlock = lock.lock(dstvfs, lockfile)

                    hardlink, n = util.copyfiles(

                        srcvfs.join(f), dstvfs.join(f), hardlink, progress

                    )

                    num += n

            if hardlink:

                ui.debug(b"linked %d files\n" % num)

            else:

                ui.debug(b"copied %d files\n" % num)

        return destlock

    except:  # re-raises

        release(destlock)

        raise

def clonewithshare(

    ui,

    peeropts,

    sharepath,

    source,

    srcpeer,

    dest,

    pull=False,

    rev=None,

    update=True,

    stream=False,

):

    """Perform a clone using a shared repo.

    The store for the repository will be located at <sharepath>/.hg. The

    specified revisions will be cloned or pulled from "source". A shared repo

    will be created at "dest" and a working copy will be created if "update" is

    True.

    """

    revs = None

    if rev:

        if not srcpeer.capable(b'lookup'):

            raise error.Abort(

                _(

                    b"src repository does not support "

                    b"revision lookup and so doesn't "

                    b"support clone by revision"

                )

            )

        # TODO this is batchable.