/brz/remove-bazaar

# Copyright (C) 2007 Canonical Ltd

# Copyright (C) 2010-2018 Jelmer Vernooij

#

# 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 control dir and a Bazaar ControlDir."""

from __future__ import absolute_import

import urllib

from ... import (

    branch as _mod_branch,

    errors as bzr_errors,

    trace,

    osutils,

    revision as _mod_revision,

    urlutils,

    )

from ...controldir import RepositoryAcquisitionPolicy

from ...transport import (

    do_catching_redirections,

    get_transport_from_path,

    )

from ...controldir import (

    ControlDir,

    ControlDirFormat,

    format_registry,

    RepositoryAcquisitionPolicy,

    )

from .object_store import (

    get_object_store,

    )

from .transportgit import (

    OBJECTDIR,

    TransportObjectStore,

    )

class GitDirConfig(object):

    def get_default_stack_on(self):

        return None

    def set_default_stack_on(self, value):

        raise bzr_errors.BzrError("Cannot set configuration")

class GitControlDirFormat(ControlDirFormat):

    colocated_branches = True

    fixed_components = True

    def __eq__(self, other):

        return type(self) == type(other)

    def is_supported(self):

        return True

    def network_name(self):

        return "git"

class UseExistingRepository(RepositoryAcquisitionPolicy):

    """A policy of reusing an existing repository"""

    def __init__(self, repository, stack_on=None, stack_on_pwd=None,

                 require_stacking=False):

        """Constructor.

        :param repository: The repository to use.

        :param stack_on: A location to stack on

        :param stack_on_pwd: If stack_on is relative, the location it is

            relative to.

        """

        super(UseExistingRepository, self).__init__(

                stack_on, stack_on_pwd, require_stacking)

        self._repository = repository

    def acquire_repository(self, make_working_trees=None, shared=False,

            possible_transports=None):

        """Implementation of RepositoryAcquisitionPolicy.acquire_repository

        Returns an existing repository to use.

        """

        return self._repository, False

class GitDir(ControlDir):

    """An adapter to the '.git' dir used by git."""

    def is_supported(self):

        return True

    def can_convert_format(self):

        return False

    def break_lock(self):

        # There are no global locks, so nothing to break.

        raise NotImplementedError(self.break_lock)

    def cloning_metadir(self, stacked=False):

        return format_registry.make_controldir("git")

    def checkout_metadir(self, stacked=False):

        return format_registry.make_controldir("git")

    def _get_selected_ref(self, branch, ref=None):

        if ref is not None and branch is not None:

            raise bzr_errors.BzrError("can't specify both ref and branch")

        if ref is not None:

            return ref

        if branch is not None:

            from .refs import branch_name_to_ref

            return branch_name_to_ref(branch)

        segment_parameters = getattr(

            self.user_transport, "get_segment_parameters", lambda: {})()

        ref = segment_parameters.get("ref")

        if ref is not None:

            return urlutils.unescape(ref)

        if branch is None and getattr(self, "_get_selected_branch", False):

            branch = self._get_selected_branch()

            if branch is not None:

                from .refs import branch_name_to_ref

                return branch_name_to_ref(branch)

        return b"HEAD"

    def get_config(self):

        return GitDirConfig()

    def _available_backup_name(self, base):

        return osutils.available_backup_name(base, self.root_transport.has)

    def sprout(self, url, revision_id=None, force_new_repo=False,

               recurse='down', possible_transports=None,

               accelerator_tree=None, hardlink=False, stacked=False,

               source_branch=None, create_tree_if_local=True):

        from ...repository import InterRepository

        from ...transport.local import LocalTransport

        from ...transport import get_transport

        target_transport = get_transport(url, possible_transports)

        target_transport.ensure_base()

        cloning_format = self.cloning_metadir()

        # Create/update the result branch

        try:

            result = ControlDir.open_from_transport(target_transport)

        except bzr_errors.NotBranchError:

            result = cloning_format.initialize_on_transport(target_transport)

        source_branch = self.open_branch()

        source_repository = self.find_repository()

        try:

            result_repo = result.find_repository()

        except bzr_errors.NoRepositoryPresent:

            result_repo = result.create_repository()

            target_is_empty = True

        else:

            target_is_empty = None # Unknown

        if stacked:

            raise _mod_branch.UnstackableBranchFormat(self._format, self.user_url)

        interrepo = InterRepository.get(source_repository, result_repo)

        if revision_id is not None:

            determine_wants = interrepo.get_determine_wants_revids(

                [revision_id], include_tags=True)

        else:

            determine_wants = interrepo.determine_wants_all

        interrepo.fetch_objects(determine_wants=determine_wants,

            mapping=source_branch.mapping)

        result_branch = source_branch.sprout(result,

            revision_id=revision_id, repository=result_repo)

        if (create_tree_if_local

            and isinstance(target_transport, LocalTransport)

            and (result_repo is None or result_repo.make_working_trees())):

            wt = result.create_workingtree(accelerator_tree=accelerator_tree,

                hardlink=hardlink, from_branch=result_branch)

        return result

    def clone_on_transport(self, transport, revision_id=None,

        force_new_repo=False, preserve_stacking=False, stacked_on=None,

        create_prefix=False, use_existing_dir=True, no_tree=False):

        """See ControlDir.clone_on_transport."""

        from ...repository import InterRepository

        from .mapping import default_mapping

        if stacked_on is not None:

            raise _mod_branch.UnstackableBranchFormat(self._format, self.user_url)

        if no_tree:

            format = BareLocalGitControlDirFormat()

        else:

            format = LocalGitControlDirFormat()

        (target_repo, target_controldir, stacking,

                repo_policy) = format.initialize_on_transport_ex(

                        transport, use_existing_dir=use_existing_dir,

                        create_prefix=create_prefix,

                        force_new_repo=force_new_repo)

        target_repo = target_controldir.find_repository()

        target_git_repo = target_repo._git

        source_repo = self.find_repository()

        source_git_repo = source_repo._git

        interrepo = InterRepository.get(source_repo, target_repo)

        if revision_id is not None:

            determine_wants = interrepo.get_determine_wants_revids([revision_id], include_tags=True)

        else:

            determine_wants = interrepo.determine_wants_all

        (pack_hint, _, refs) = interrepo.fetch_objects(determine_wants,

            mapping=default_mapping)

        for name, val in refs.iteritems():

            target_git_repo.refs[name] = val

        result_dir = self.__class__(transport, target_git_repo, format)

        if revision_id is not None:

            result_dir.open_branch().set_last_revision(revision_id)

        return result_dir

    def _find_commondir(self):

        try:

            commondir = self.control_transport.get_bytes('commondir')

        except bzr_errors.NoSuchFile:

            return self

        else:

            commondir = commondir.rstrip('/.git/')

            return ControlDir.open_from_transport(get_transport_from_path(commondir))

    def find_repository(self):

        """Find the repository that should be used.

        This does not require a branch as we use it to find the repo for

        new branches as well as to hook existing branches up to their

        repository.

        """

        return self._gitrepository_class(self._find_commondir())

    def get_refs_container(self):

        """Retrieve the refs container.

        """

        raise NotImplementedError(self.get_refs_container)

    def determine_repository_policy(self, force_new_repo=False, stack_on=None,

                                    stack_on_pwd=None, require_stacking=False):

        """Return an object representing a policy to use.

        This controls whether a new repository is created, and the format of

        that repository, or some existing shared repository used instead.

        If stack_on is supplied, will not seek a containing shared repo.

        :param force_new_repo: If True, require a new repository to be created.

        :param stack_on: If supplied, the location to stack on.  If not

            supplied, a default_stack_on location may be used.

        :param stack_on_pwd: If stack_on is relative, the location it is

            relative to.

        """

        return UseExistingRepository(self.find_repository())

    def get_branches(self):

        from .refs import ref_to_branch_name

        ret = {}

        for ref in self.get_refs_container().keys():

            try:

                branch_name = ref_to_branch_name(ref)

            except ValueError:

                continue

            except UnicodeDecodeError:

                trace.warning("Ignoring branch %r with unicode error ref", ref)

                continue

            ret[branch_name] = self.open_branch(ref=ref)

        return ret

    def list_branches(self):

        return self.get_branches().values()

class LocalGitControlDirFormat(GitControlDirFormat):

    """The .git directory control format."""

    bare = False

    @classmethod

    def _known_formats(self):

        return set([LocalGitControlDirFormat()])

    @property

    def repository_format(self):

        from .repository import GitRepositoryFormat

        return GitRepositoryFormat()

    @property

    def workingtree_format(self):

        from .workingtree import GitWorkingTreeFormat

        return GitWorkingTreeFormat()

    def get_branch_format(self):

        from .branch import LocalGitBranchFormat

        return LocalGitBranchFormat()

    def open(self, transport, _found=None):

        """Open this directory.

        """

        from .transportgit import TransportRepo

        gitrepo = TransportRepo(transport, self.bare,

                refs_text=getattr(self, "_refs_text", None))

        if not gitrepo._controltransport.has('HEAD'):

            raise bzr_errors.NotBranchError(path=transport.base)

        return LocalGitDir(transport, gitrepo, self)

    def get_format_description(self):

        return "Local Git Repository"

    def initialize_on_transport(self, transport):

        from .transportgit import TransportRepo

        repo = TransportRepo.init(transport, bare=self.bare)

        return self.open(transport)

    def initialize_on_transport_ex(self, transport, use_existing_dir=False,

        create_prefix=False, force_new_repo=False, stacked_on=None,

        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,

        shared_repo=False, vfs_only=False):

        def make_directory(transport):

            transport.mkdir('.')

            return transport

        def redirected(transport, e, redirection_notice):

            trace.note(redirection_notice)

            return transport._redirected_to(e.source, e.target)

        try:

            transport = do_catching_redirections(make_directory, transport,

                redirected)

        except bzr_errors.FileExists:

            if not use_existing_dir:

                raise

        except bzr_errors.NoSuchFile:

            if not create_prefix:

                raise

            transport.create_prefix()

        controldir = self.initialize_on_transport(transport)

        if repo_format_name:

            result_repo = controldir.find_repository()

            repository_policy = UseExistingRepository(result_repo)

            result_repo.lock_write()

        else:

            result_repo = None

            repository_policy = None

        return (result_repo, controldir, False,

                repository_policy)

    def is_supported(self):

        return True

    def supports_transport(self, transport):

        try:

            external_url = transport.external_url()

        except bzr_errors.InProcessTransport:

            raise bzr_errors.NotBranchError(path=transport.base)

        return external_url.startswith("file:")

class BareLocalGitControlDirFormat(LocalGitControlDirFormat):

    bare = True

    supports_workingtrees = False

    def get_format_description(self):

        return "Local Git Repository (bare)"

class LocalGitDir(GitDir):

    """An adapter to the '.git' dir used by git."""

    def _get_gitrepository_class(self):

        from .repository import LocalGitRepository

        return LocalGitRepository

    def __repr__(self):

        return "<%s at %r>" % (

            self.__class__.__name__, self.root_transport.base)

    _gitrepository_class = property(_get_gitrepository_class)

    @property

    def user_transport(self):

        return self.root_transport

    @property

    def control_transport(self):

        return self._git._controltransport

    def __init__(self, transport, gitrepo, format):

        self._format = format

        self.root_transport = transport

        self._mode_check_done = False

        self._git = gitrepo

        if gitrepo.bare:

            self.transport = transport

        else:

            self.transport = transport.clone('.git')

        self._mode_check_done = None

    def is_control_filename(self, filename):

        return (filename == '.git' or

                filename.startswith('.git/') or

                filename.startswith('.git\\'))

    def _get_symref(self, ref):

        from dulwich.repo import SYMREF

        ref_chain, unused_sha = self._git.refs.follow(ref)

        if len(ref_chain) == 1:

            return None

        return ref_chain[1]

    def set_branch_reference(self, target_branch, name=None):

        ref = self._get_selected_ref(name)

        if self.control_transport.base == target_branch.controldir.control_transport.base:

            self._git.refs.set_symbolic_ref(ref, target_branch.ref)

        else:

            try:

                target_path = target_branch.controldir.control_transport.local_abspath('.')

            except bzr_errors.NotLocalUrl:

                raise bzr_errors.IncompatibleFormat(target_branch._format, self._format)

            # TODO(jelmer): Do some consistency checking across branches..

            self.control_transport.put_bytes('commondir', target_path.encode('utf-8'))

            # TODO(jelmer): Urgh, avoid mucking about with internals.

            self._git._commontransport = target_branch.repository._git._commontransport.clone()

            self._git.object_store = TransportObjectStore(self._git._commontransport.clone(OBJECTDIR))

            self._git.refs.transport = self._git._commontransport

            target_ref_chain, unused_sha = target_branch.controldir._git.refs.follow(target_branch.ref)

            for target_ref in target_ref_chain:

                if target_ref == b'HEAD':

                    continue

                break

            else:

                # Can't create a reference to something that is not a in a repository.

                raise bzr_errors.IncompatibleFormat(self.set_branch_reference, self)

            self._git.refs.set_symbolic_ref(ref, target_ref)

    def get_branch_reference(self, name=None):

        ref = self._get_selected_ref(name)

        target_ref = self._get_symref(ref)

        if target_ref is not None:

            from .refs import ref_to_branch_name

            try:

                branch_name = ref_to_branch_name(target_ref)

            except ValueError:

                params = {'ref': urllib.quote(target_ref, '')}

            else:

                if branch_name != b'':

                    params = {'branch': urllib.quote(branch_name.encode('utf-8'), '')}

                else:

                    params = {}

            try:

                base_url = urlutils.local_path_to_url(self.control_transport.get_bytes('commondir')).rstrip('/.git/')+'/'

            except bzr_errors.NoSuchFile:

                base_url = self.user_url.rstrip('/')

            return urlutils.join_segment_parameters(base_url, params)

        return None

    def find_branch_format(self, name=None):

        from .branch import (

            LocalGitBranchFormat,

            )

        ref = self._get_selected_ref(name)

        return LocalGitBranchFormat()

    def get_branch_transport(self, branch_format, name=None):

        if branch_format is None:

            return self.transport

        if isinstance(branch_format, LocalGitControlDirFormat):

            return self.transport

        raise bzr_errors.IncompatibleFormat(branch_format, self._format)

    def get_repository_transport(self, format):

        if format is None:

            return self.transport

        if isinstance(format, LocalGitControlDirFormat):

            return self.transport

        raise bzr_errors.IncompatibleFormat(format, self._format)

    def get_workingtree_transport(self, format):

        if format is None:

            return self.transport

        if isinstance(format, LocalGitControlDirFormat):

            return self.transport

        raise bzr_errors.IncompatibleFormat(format, self._format)

    def open_branch(self, name=None, unsupported=False, ignore_fallbacks=None,

            ref=None, possible_transports=None, nascent_ok=False):

        """'create' a branch for this dir."""

        repo = self.find_repository()

        from .branch import LocalGitBranch

        ref = self._get_selected_ref(name, ref)

        if not nascent_ok and ref not in self._git.refs:

            raise bzr_errors.NotBranchError(self.root_transport.base,

                    controldir=self)

        ref_chain, unused_sha = self._git.refs.follow(ref)

        if ref_chain[-1] == b'HEAD':

            controldir = self

        else:

            controldir = self._find_commondir()

        return LocalGitBranch(controldir, repo, ref_chain[-1])

    def destroy_branch(self, name=None):

        refname = self._get_selected_ref(name)

        if refname == b'HEAD':

            # HEAD can't be removed

            raise bzr_errors.UnsupportedOperation(

                self.destroy_branch, self)

        try:

            del self._git.refs[refname]

        except KeyError:

            raise bzr_errors.NotBranchError(self.root_transport.base,

                    controldir=self)

    def destroy_repository(self):

        raise bzr_errors.UnsupportedOperation(self.destroy_repository, self)

    def destroy_workingtree(self):

        raise bzr_errors.UnsupportedOperation(self.destroy_workingtree, self)

    def destroy_workingtree_metadata(self):

        raise bzr_errors.UnsupportedOperation(self.destroy_workingtree_metadata, self)

    def needs_format_conversion(self, format=None):

        return not isinstance(self._format, format.__class__)

    def open_repository(self):

        """'open' a repository for this dir."""

        if self.control_transport.has('commondir'):

            raise bzr_errors.NoRepositoryPresent(self)

        return self._gitrepository_class(self)

    def has_workingtree(self):

        return not self._git.bare

    def open_workingtree(self, recommend_upgrade=True, unsupported=False):

        if not self._git.bare:

            from dulwich.errors import NoIndexPresent

            repo = self.find_repository()

            try:

                index = repo._git.open_index()

            except NoIndexPresent:

                pass

            else:

                from .workingtree import GitWorkingTree

                branch = self.open_branch(ref=b'HEAD', nascent_ok=True)

                return GitWorkingTree(self, repo, branch, index)

        loc = urlutils.unescape_for_display(self.root_transport.base, 'ascii')

        raise bzr_errors.NoWorkingTree(loc)

    def create_repository(self, shared=False):

        from .repository import GitRepositoryFormat

        if shared:

            raise bzr_errors.IncompatibleFormat(GitRepositoryFormat(), self._format)

        return self.find_repository()

    def create_branch(self, name=None, repository=None,

                      append_revisions_only=None, ref=None):

        refname = self._get_selected_ref(name, ref)

        if refname != b'HEAD' and refname in self._git.refs:

            raise bzr_errors.AlreadyBranchError(self.user_url)

        repo = self.open_repository()

        if refname in self._git.refs:

            ref_chain, unused_sha = self._git.refs.follow(self._get_selected_ref(None))

            if ref_chain[0] == b'HEAD':

                refname = ref_chain[1]

        from .branch import LocalGitBranch

        branch = LocalGitBranch(self, repo, refname)

        if append_revisions_only:

            branch.set_append_revisions_only(append_revisions_only)

        return branch

    def backup_bzrdir(self):

        if not self._git.bare:

            self.root_transport.copy_tree(".git", ".git.backup")

            return (self.root_transport.abspath(".git"),

                    self.root_transport.abspath(".git.backup"))

        else:

            basename = urlutils.basename(self.root_transport.base)

            parent = self.root_transport.clone('..')

            parent.copy_tree(basename, basename + ".backup")

    def create_workingtree(self, revision_id=None, from_branch=None,

        accelerator_tree=None, hardlink=False):

        if self._git.bare:

            raise bzr_errors.UnsupportedOperation(self.create_workingtree, self)

        from dulwich.index import build_index_from_tree

        if from_branch is None:

            from_branch = self.open_branch(nascent_ok=True)

        if revision_id is None:

            revision_id = from_branch.last_revision()

        repo = self.find_repository()

        from .workingtree import GitWorkingTree

        index = self._git.open_index()

        wt = GitWorkingTree(self, repo, from_branch, index)

        wt.set_last_revision(revision_id)

        wt._build_checkout_with_index()

        return wt

    def _find_or_create_repository(self, force_new_repo=None):

        return self.create_repository(shared=False)

    def _find_creation_modes(self):

        """Determine the appropriate modes for files and directories.

        They're always set to be consistent with the base directory,

        assuming that this transport allows setting modes.

        """

        # TODO: Do we need or want an option (maybe a config setting) to turn

        # this off or override it for particular locations? -- mbp 20080512

        if self._mode_check_done:

            return

        self._mode_check_done = True