/brz/remove-bazaar

# Copyright (C) 2007,2012 Canonical Ltd

# Copyright (C) 2009-2018 Jelmer Vernooij <jelmer@jelmer.uk>

#

# This program is free software; you can redistribute it and/or modify

# it under the terms of the GNU General Public License as published by

# the Free Software Foundation; either version 2 of the License, or

# (at your option) any later version.

#

# This program is distributed in the hope that it will be useful,

# but WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

# GNU General Public License for more details.

#

# You should have received a copy of the GNU General Public License

# along with this program; if not, write to the Free Software

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

"""An adapter between a Git Branch and a Bazaar Branch"""

from __future__ import absolute_import

from cStringIO import StringIO

from collections import defaultdict

from dulwich.objects import (

    NotCommitError,

    ZERO_SHA,

    )

from dulwich.repo import check_ref_format

from ... import (

    branch,

    config,

    controldir,

    errors,

    lock,

    repository as _mod_repository,

    revision,

    tag,

    trace,

    transport,

    urlutils,

    )

from ...revision import (

    NULL_REVISION,

    )

from ...trace import (

    is_quiet,

    mutter,

    warning,

    )

from .config import (

    GitBranchConfig,

    GitBranchStack,

    )

from .errors import (

    NoPushSupport,

    NoSuchRef,

    )

from .push import (

    remote_divergence,

    )

from .refs import (

    branch_name_to_ref,

    is_tag,

    ref_to_branch_name,

    ref_to_tag_name,

    remote_refs_dict_to_tag_refs,

    tag_name_to_ref,

    )

from .unpeel_map import (

    UnpeelMap,

    )

from .urls import git_url_to_bzr_url

from ...foreign import ForeignBranch

class GitPullResult(branch.PullResult):

    """Result of a pull from a Git branch."""

    def _lookup_revno(self, revid):

        if type(revid) is not str:

            raise TypeError(revid)

        # Try in source branch first, it'll be faster

        with self.target_branch.lock_read():

            return self.target_branch.revision_id_to_revno(revid)

    @property

    def old_revno(self):

        return self._lookup_revno(self.old_revid)

    @property

    def new_revno(self):

        return self._lookup_revno(self.new_revid)

class GitTags(tag.BasicTags):

    """Ref-based tag dictionary."""

    def __init__(self, branch):

        self.branch = branch

        self.repository = branch.repository

    def _merge_to_remote_git(self, target_repo, source_tag_refs, overwrite=False):

        updates = {}

        conflicts = []

        def get_changed_refs(old_refs):

            ret = dict(old_refs)

            for ref_name, tag_name, peeled, unpeeled in source_tag_refs.iteritems():

                if old_refs.get(ref_name) == unpeeled:

                    pass

                elif overwrite or not ref_name in old_refs:

                    ret[ref_name] = unpeeled

                    updates[tag_name] = target_repo.lookup_foreign_revision_id(peeled)

                else:

                    conflicts.append(

                        (tag_name,

                        self.repository.lookup_foreign_revision_id(peeled),

                        target_repo.lookup_foreign_revision_id(old_refs[ref_name])))

            return ret

        target_repo.controldir.send_pack(get_changed_refs, lambda have, want: [])

        return updates, conflicts

    def _merge_to_local_git(self, target_repo, source_tag_refs, overwrite=False):

        conflicts = []

        updates = {}

        for ref_name, tag_name, peeled, unpeeled in source_tag_refs:

            if target_repo._git.refs.get(ref_name) == unpeeled:

                pass

            elif overwrite or not ref_name in target_repo._git.refs:

                target_repo._git.refs[ref_name] = unpeeled or peeled

                updates[tag_name] = self.repository.lookup_foreign_revision_id(peeled)

            else:

                source_revid = self.repository.lookup_foreign_revision_id(peeled)

                try:

                    target_revid = target_repo.lookup_foreign_revision_id(

                            target_repo._git.refs[ref_name])

                except KeyError:

                    trace.warning('%s does not point to a valid object',

                                  ref_name)

                    continue

                conflicts.append((tag_name, source_revid, target_revid))

        return updates, conflicts

    def _merge_to_git(self, to_tags, source_tag_refs, overwrite=False):

        target_repo = to_tags.repository

        if self.repository.has_same_location(target_repo):

            return {}, []

        try:

            if getattr(target_repo, "_git", None):

                return self._merge_to_local_git(target_repo, source_tag_refs, overwrite)

            else:

                return self._merge_to_remote_git(target_repo, source_tag_refs, overwrite)

        finally:

            to_tags.branch._tag_refs = None

    def _merge_to_non_git(self, to_tags, source_tag_refs, overwrite=False):

        unpeeled_map = defaultdict(set)

        conflicts = []

        updates = {}

        result = dict(to_tags.get_tag_dict())

        for ref_name, tag_name, peeled, unpeeled in source_tag_refs:

            if unpeeled is not None:

                unpeeled_map[peeled].add(unpeeled)

            try:

                bzr_revid = self.branch.lookup_foreign_revision_id(peeled)

            except NotCommitError:

                continue

            if result.get(tag_name) == bzr_revid:

                pass

            elif tag_name not in result or overwrite:

                result[tag_name] = bzr_revid

                updates[tag_name] = bzr_revid

            else:

                conflicts.append((tag_name, bzr_revid, result[n]))

        to_tags._set_tag_dict(result)

        if len(unpeeled_map) > 0:

            map_file = UnpeelMap.from_repository(to_tags.branch.repository)

            map_file.update(unpeeled_map)

            map_file.save_in_repository(to_tags.branch.repository)

        return updates, conflicts

    def merge_to(self, to_tags, overwrite=False, ignore_master=False,

                 source_tag_refs=None):

        """See Tags.merge_to."""

        if source_tag_refs is None:

            source_tag_refs = self.branch.get_tag_refs()

        if self == to_tags:

            return {}, []

        if isinstance(to_tags, GitTags):

            return self._merge_to_git(to_tags, source_tag_refs,

                                      overwrite=overwrite)

        else:

            if ignore_master:

                master = None

            else:

                master = to_tags.branch.get_master_branch()

            if master is not None:

                master.lock_write()

            try:

                updates, conflicts = self._merge_to_non_git(to_tags, source_tag_refs,

                                                  overwrite=overwrite)

                if master is not None:

                    extra_updates, extra_conflicts = self.merge_to(

                        master.tags, overwrite=overwrite,

                                               source_tag_refs=source_tag_refs,

                                               ignore_master=ignore_master)

                    updates.update(extra_updates)

                    conflicts += extra_conflicts

                return updates, conflicts

            finally:

                if master is not None:

                    master.unlock()

    def get_tag_dict(self):

        ret = {}

        for (ref_name, tag_name, peeled, unpeeled) in self.branch.get_tag_refs():

            try:

                bzr_revid = self.branch.lookup_foreign_revision_id(peeled)

            except NotCommitError:

                continue

            else:

                ret[tag_name] = bzr_revid

        return ret

class LocalGitTagDict(GitTags):

    """Dictionary with tags in a local repository."""

    def __init__(self, branch):

        super(LocalGitTagDict, self).__init__(branch)

        self.refs = self.repository.controldir._git.refs

    def _set_tag_dict(self, to_dict):

        extra = set(self.refs.allkeys())

        for k, revid in to_dict.iteritems():

            name = tag_name_to_ref(k)

            if name in extra:

                extra.remove(name)

            self.set_tag(k, revid)

        for name in extra:

            if is_tag(name):

                del self.repository._git[name]

    def set_tag(self, name, revid):

        try:

            git_sha, mapping = self.branch.lookup_bzr_revision_id(revid)

        except errors.NoSuchRevision:

            raise errors.GhostTagsNotSupported(self)

        self.refs[tag_name_to_ref(name)] = git_sha

        self.branch._tag_refs = None

    def delete_tag(self, name):

        ref = tag_name_to_ref(name)

        if not ref in self.refs:

            raise errors.NoSuchTag(name)

        del self.refs[ref]

        self.branch._tag_refs = None

class GitBranchFormat(branch.BranchFormat):

    def network_name(self):

        return "git"

    def supports_tags(self):

        return True

    def supports_leaving_lock(self):

        return False

    def supports_tags_referencing_ghosts(self):

        return False

    def tags_are_versioned(self):

        return False

    def get_foreign_tests_branch_factory(self):

        from .tests.test_branch import ForeignTestsBranchFactory

        return ForeignTestsBranchFactory()

    def make_tags(self, branch):

        try:

            return branch.tags

        except AttributeError:

            pass

        if getattr(branch.repository, "_git", None) is None:

            from .remote import RemoteGitTagDict

            return RemoteGitTagDict(branch)

        else:

            return LocalGitTagDict(branch)

    def initialize(self, a_controldir, name=None, repository=None,

                   append_revisions_only=None):

        raise NotImplementedError(self.initialize)

    def get_reference(self, controldir, name=None):

        return controldir.get_branch_reference(name)

    def set_reference(self, controldir, name, target):

        return controldir.set_branch_reference(target, name)

class LocalGitBranchFormat(GitBranchFormat):

    def get_format_description(self):

        return 'Local Git Branch'

    @property

    def _matchingcontroldir(self):

        from .dir import LocalGitControlDirFormat

        return LocalGitControlDirFormat()

    def initialize(self, a_controldir, name=None, repository=None,

                   append_revisions_only=None):

        from .dir import LocalGitDir

        if not isinstance(a_controldir, LocalGitDir):

            raise errors.IncompatibleFormat(self, a_controldir._format)

        return a_controldir.create_branch(repository=repository, name=name,

            append_revisions_only=append_revisions_only)

class GitBranch(ForeignBranch):

    """An adapter to git repositories for bzr Branch objects."""

    @property

    def control_transport(self):

        return self._control_transport

    @property

    def user_transport(self):

        return self._user_transport

    def __init__(self, controldir, repository, ref, format):

        self.repository = repository

        self._format = format

        self.controldir = controldir

        self._lock_mode = None

        self._lock_count = 0

        super(GitBranch, self).__init__(repository.get_mapping())

        self.ref = ref

        self._head = None

        self._user_transport = controldir.user_transport.clone('.')

        self._control_transport = controldir.control_transport.clone('.')

        self._tag_refs = None

        params = {}

        try:

            self.name = ref_to_branch_name(ref)

        except ValueError:

            self.name = None

            if self.ref is not None:

                params = {"ref": urlutils.escape(self.ref)}

        else:

            if self.name != "":

                params = {"branch": urlutils.escape(self.name)}

        for k, v in params.items():

            self._user_transport.set_segment_parameter(k, v)

            self._control_transport.set_segment_parameter(k, v)

        self.base = controldir.user_transport.base

    def _get_checkout_format(self, lightweight=False):

        """Return the most suitable metadir for a checkout of this branch.

        Weaves are used if this branch's repository uses weaves.

        """

        if lightweight:

            return controldir.format_registry.make_controldir("git")

        else:

            return controldir.format_registry.make_controldir("default")

    def get_child_submit_format(self):

        """Return the preferred format of submissions to this branch."""

        ret = self.get_config_stack().get("child_submit_format")

        if ret is not None:

            return ret

        return "git"

    def get_config(self):

        return GitBranchConfig(self)

    def get_config_stack(self):

        return GitBranchStack(self)

    def _get_nick(self, local=False, possible_master_transports=None):

        """Find the nick name for this branch.

        :return: Branch nick

        """

        cs = self.repository._git.get_config_stack()

        try:

            return cs.get((b"branch", self.name.encode('utf-8')), b"nick").decode("utf-8")

        except KeyError:

            pass

        return self.name or u"HEAD"

    def _set_nick(self, nick):

        cf = self.repository._git.get_config()

        cf.set((b"branch", self.name.encode('utf-8')), b"nick", nick.encode("utf-8"))

        f = StringIO()

        cf.write_to_file(f)

        self.repository._git._put_named_file('config', f.getvalue())

    nick = property(_get_nick, _set_nick)

    def __repr__(self):

        return "<%s(%r, %r)>" % (self.__class__.__name__, self.repository.base,

            self.name)

    def generate_revision_history(self, revid, last_rev=None, other_branch=None):

        if last_rev is not None:

            graph = self.repository.get_graph()

            if not graph.is_ancestor(last_rev, revid):

                # our previous tip is not merged into stop_revision

                raise errors.DivergedBranches(self, other_branch)

        self.set_last_revision(revid)

    def lock_write(self, token=None):

        if token is not None:

            raise errors.TokenLockingNotSupported(self)

        if self._lock_mode:

            if self._lock_mode == 'r':

                raise errors.ReadOnlyError(self)

            self._lock_count += 1

        else:

            self._lock_ref()

            self._lock_mode = 'w'

            self._lock_count = 1

        self.repository.lock_write()

        return lock.LogicalLockResult(self.unlock)

    def leave_lock_in_place(self):

        raise NotImplementedError(self.leave_lock_in_place)

    def dont_leave_lock_in_place(self):

        raise NotImplementedError(self.dont_leave_lock_in_place)

    def get_stacked_on_url(self):

        # Git doesn't do stacking (yet...)

        raise branch.UnstackableBranchFormat(self._format, self.base)

    def _get_parent_location(self):

        """See Branch.get_parent()."""

        # FIXME: Set "origin" url from .git/config ?

        cs = self.repository._git.get_config_stack()

        try:

            location = cs.get((b"remote", b'origin'), b"url")

        except KeyError:

            return None

        params = {}

        try:

            ref = cs.get((b"remote", b"origin"), b"merge")

        except KeyError:

            pass

        else:

            if ref != 'HEAD':

                try:

                    params['branch'] = ref_to_branch_name(ref).encode('utf-8')

                except ValueError:

                    params['ref'] = ref.encode('utf-8')

        url = git_url_to_bzr_url(location)

        return urlutils.join_segment_parameters(url, params)

    def set_parent(self, location):

        # FIXME: Set "origin" url in .git/config ?

        cs = self.repository._git.get_config()

        this_url = urlutils.split_segment_parameters(self.user_url)[0]

        target_url, target_params = urlutils.split_segment_parameters(location)

        location = urlutils.relative_url(this_url, target_url)

        cs.set((b"remote", b"origin"), b"url", location)

        if 'branch' in target_params:

            cs.set((b"remote", b"origin"), b"merge",

                   branch_name_to_ref(target_params['branch']))

        elif 'ref' in target_params:

            cs.set((b"remote", b"origin"), b"merge",

                   target_params['ref'])

        else:

            # TODO(jelmer): Maybe unset rather than setting to HEAD?

            cs.set((b"remote", b"origin"), b"merge", 'HEAD')

        f = StringIO()

        cs.write_to_file(f)

        self.repository._git._put_named_file('config', f.getvalue())

    def break_lock(self):

        raise NotImplementedError(self.break_lock)

    def lock_read(self):

        if self._lock_mode:

            if self._lock_mode not in ('r', 'w'):

                raise ValueError(self._lock_mode)

            self._lock_count += 1

        else:

            self._lock_mode = 'r'

            self._lock_count = 1

        self.repository.lock_read()

        return lock.LogicalLockResult(self.unlock)

    def peek_lock_mode(self):

        return self._lock_mode

    def is_locked(self):

        return (self._lock_mode is not None)

    def _lock_ref(self):

        pass

    def _unlock_ref(self):

        pass

    def unlock(self):

        """See Branch.unlock()."""

        if self._lock_count == 0:

            raise errors.LockNotHeld(self)

        try:

            self._lock_count -= 1

            if self._lock_count == 0:

                if self._lock_mode == 'w':

                    self._unlock_ref()

                self._lock_mode = None

                self._clear_cached_state()

        finally:

            self.repository.unlock()

    def get_physical_lock_status(self):

        return False

    def last_revision(self):

        with self.lock_read():

            # perhaps should escape this ?

            if self.head is None:

                return revision.NULL_REVISION

            return self.lookup_foreign_revision_id(self.head)

    def _basic_push(self, target, overwrite=False, stop_revision=None):

        return branch.InterBranch.get(self, target)._basic_push(

            overwrite, stop_revision)

    def lookup_foreign_revision_id(self, foreign_revid):

        try:

            return self.repository.lookup_foreign_revision_id(foreign_revid,

                self.mapping)

        except KeyError:

            # Let's try..

            return self.mapping.revision_id_foreign_to_bzr(foreign_revid)

    def lookup_bzr_revision_id(self, revid):

        return self.repository.lookup_bzr_revision_id(

            revid, mapping=self.mapping)

    def get_unshelver(self, tree):

        raise errors.StoringUncommittedNotSupported(self)

    def _clear_cached_state(self):

        super(GitBranch, self)._clear_cached_state()

        self._tag_refs = None

    def _iter_tag_refs(self, refs):

        """Iterate over the tag refs.

        :param refs: Refs dictionary (name -> git sha1)

        :return: iterator over (ref_name, tag_name, peeled_sha1, unpeeled_sha1)

        """

        raise NotImplementedError(self._iter_tag_refs)

    def get_tag_refs(self):

        with self.lock_read():

            if self._tag_refs is None:

                self._tag_refs = list(self._iter_tag_refs())

            return self._tag_refs

class LocalGitBranch(GitBranch):

    """A local Git branch."""

    def __init__(self, controldir, repository, ref):

        super(LocalGitBranch, self).__init__(controldir, repository, ref,

                LocalGitBranchFormat())

    def create_checkout(self, to_location, revision_id=None, lightweight=False,

        accelerator_tree=None, hardlink=False):

        t = transport.get_transport(to_location)

        t.ensure_base()

        format = self._get_checkout_format(lightweight=lightweight)

        checkout = format.initialize_on_transport(t)

        if lightweight:

            from_branch = checkout.set_branch_reference(target_branch=self)

        else:

            policy = checkout.determine_repository_policy()

            repo = policy.acquire_repository()[0]

            checkout_branch = checkout.create_branch()

            checkout_branch.bind(self)

            checkout_branch.pull(self, stop_revision=revision_id)

            from_branch = None

        return checkout.create_workingtree(revision_id,

                from_branch=from_branch, hardlink=hardlink)

    def _lock_ref(self):

        self._ref_lock = self.repository._git.refs.lock_ref(self.ref)

    def _unlock_ref(self):

        self._ref_lock.unlock()