/brz/remove-bazaar

# Copyright (C) 2007-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

"""Remote dirs, repositories and branches."""

from __future__ import absolute_import

import re

from ... import (

    config,

    debug,

    errors,

    trace,

    ui,

    urlutils,

    )

from ...push import (

    PushResult,

    )

from ...errors import (

    AlreadyBranchError,

    BzrError,

    DivergedBranches,

    InProcessTransport,

    InvalidRevisionId,

    NoSuchFile,

    NoSuchRevision,

    NoSuchTag,

    NotBranchError,

    NotLocalUrl,

    NoWorkingTree,

    UninitializableFormat,

    )

from ...transport import (

    Transport,

    )

from . import (

    lazy_check_versions,

    user_agent_for_github,

    )

lazy_check_versions()

from .branch import (

    GitBranch,

    GitBranchFormat,

    GitBranchPushResult,

    GitTags,

    _quick_lookup_revno,

    )

from .dir import (

    GitControlDirFormat,

    GitDir,

    BareLocalGitControlDirFormat,

    )

from .errors import (

    GitSmartRemoteNotSupported,

    NoSuchRef,

    )

from .mapping import (

    mapping_registry,

    )

from .object_store import (

    get_object_store,

    )

from .push import (

    remote_divergence,

    )

from .repository import (

    GitRepository,

    )

from .refs import (

    branch_name_to_ref,

    is_peeled,

    ref_to_tag_name,

    tag_name_to_ref,

    )

import dulwich

import dulwich.client

from dulwich.errors import (

    GitProtocolError,

    )

from dulwich.pack import (

    Pack,

    pack_objects_to_data,

    )

from dulwich.protocol import ZERO_SHA

from dulwich.refs import (

    DictRefsContainer,

    SYMREF,

    )

from dulwich.repo import (

    NotGitRepository,

    )

import os

import select

import tempfile

import urllib

import urlparse

# urlparse only supports a limited number of schemes by default

urlparse.uses_netloc.extend(['git', 'git+ssh'])

from dulwich.pack import load_pack_index

class GitPushResult(PushResult):

    def _lookup_revno(self, revid):

        try:

            return _quick_lookup_revno(self.source_branch, self.target_branch,

                revid)

        except GitSmartRemoteNotSupported:

            return None

    @property

    def old_revno(self):

        return self._lookup_revno(self.old_revid)

    @property

    def new_revno(self):

        return self._lookup_revno(self.new_revid)

# Don't run any tests on GitSmartTransport as it is not intended to be

# a full implementation of Transport

def get_test_permutations():

    return []

def split_git_url(url):

    """Split a Git URL.

    :param url: Git URL

    :return: Tuple with host, port, username, path.

    """

    (scheme, netloc, loc, _, _) = urlparse.urlsplit(url)

    path = urllib.unquote(loc)

    if path.startswith("/~"):

        path = path[1:]

    (username, hostport) = urllib.splituser(netloc)

    (host, port) = urllib.splitnport(hostport, None)

    return (host, port, username, path)

class RemoteGitError(BzrError):

    _fmt = "Remote server error: %(msg)s"

def parse_git_error(url, message):

    """Parse a remote git server error and return a bzr exception.

    :param url: URL of the remote repository

    :param message: Message sent by the remote git server

    """

    message = str(message).strip()

    if message.startswith("Could not find Repository "):

        return NotBranchError(url, message)

    if message == "HEAD failed to update":

        base_url, _ = urlutils.split_segment_parameters(url)

        raise BzrError(

            ("Unable to update remote HEAD branch. To update the master "

             "branch, specify the URL %s,branch=master.") % base_url)

    # Don't know, just return it to the user as-is

    return RemoteGitError(message)

class GitSmartTransport(Transport):

    def __init__(self, url, _client=None):

        Transport.__init__(self, url)

        (self._host, self._port, self._username, self._path) = \

            split_git_url(url)

        if 'transport' in debug.debug_flags:

            trace.mutter('host: %r, user: %r, port: %r, path: %r',

                         self._host, self._username, self._port, self._path)

        self._client = _client

        self._stripped_path = self._path.rsplit(",", 1)[0]

    def external_url(self):

        return self.base

    def has(self, relpath):

        return False

    def _get_client(self):

        raise NotImplementedError(self._get_client)

    def _get_path(self):

        return self._stripped_path

    def get(self, path):

        raise NoSuchFile(path)

    def abspath(self, relpath):

        return urlutils.join(self.base, relpath)

    def clone(self, offset=None):

        """See Transport.clone()."""

        if offset is None:

            newurl = self.base

        else:

            newurl = urlutils.join(self.base, offset)

        return self.__class__(newurl, self._client)

class TCPGitSmartTransport(GitSmartTransport):

    _scheme = 'git'

    def _get_client(self):

        if self._client is not None:

            ret = self._client

            self._client = None

            return ret

        if self._host == '':

            # return dulwich.client.LocalGitClient()

            return dulwich.client.SubprocessGitClient()

        return dulwich.client.TCPGitClient(self._host, self._port,

            report_activity=self._report_activity)

class SSHSocketWrapper(object):

    def __init__(self, sock):

        self.sock = sock

    def read(self, len=None):

        return self.sock.recv(len)

    def write(self, data):

        return self.sock.write(data)

    def can_read(self):

        return len(select.select([self.sock.fileno()], [], [], 0)[0]) > 0

class DulwichSSHVendor(dulwich.client.SSHVendor):

    def __init__(self):

        from ...transport import ssh

        self.bzr_ssh_vendor = ssh._get_ssh_vendor()

    def run_command(self, host, command, username=None, port=None):

        connection = self.bzr_ssh_vendor.connect_ssh(username=username,

            password=None, port=port, host=host, command=command)

        (kind, io_object) = connection.get_sock_or_pipes()

        if kind == 'socket':

            return SSHSocketWrapper(io_object)

        else:

            raise AssertionError("Unknown io object kind %r'" % kind)

#dulwich.client.get_ssh_vendor = DulwichSSHVendor

class SSHGitSmartTransport(GitSmartTransport):

    _scheme = 'git+ssh'

    def _get_path(self):

        path = self._stripped_path

        if path.startswith("/~/"):

            return path[3:]

        return path

    def _get_client(self):

        if self._client is not None:

            ret = self._client

            self._client = None

            return ret

        location_config = config.LocationConfig(self.base)

        client = dulwich.client.SSHGitClient(self._host, self._port, self._username,

            report_activity=self._report_activity)

        # Set up alternate pack program paths

        upload_pack = location_config.get_user_option('git_upload_pack')

        if upload_pack:

            client.alternative_paths["upload-pack"] = upload_pack

        receive_pack = location_config.get_user_option('git_receive_pack')

        if receive_pack:

            client.alternative_paths["receive-pack"] = receive_pack

        return client

class RemoteGitBranchFormat(GitBranchFormat):

    def get_format_description(self):

        return 'Remote Git Branch'

    @property

    def _matchingcontroldir(self):

        return RemoteGitControlDirFormat()

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

                   append_revisions_only=None):

        raise UninitializableFormat(self)

class DefaultProgressReporter(object):

    _GIT_PROGRESS_PARTIAL_RE = re.compile(r"(.*?): +(\d+)% \((\d+)/(\d+)\)")

    _GIT_PROGRESS_TOTAL_RE = re.compile(r"(.*?): (\d+)")

    def __init__(self, pb):

        self.pb = pb

    def progress(self, text):

        text = text.rstrip("\r\n")

        if text.startswith('error: '):

            trace.show_error('git: %s', text[len('error: '):])

        else:

            trace.mutter("git: %s", text)

            g = self._GIT_PROGRESS_PARTIAL_RE.match(text)

            if g is not None:

                (text, pct, current, total) = g.groups()

                self.pb.update(text, int(current), int(total))

            else:

                g = self._GIT_PROGRESS_TOTAL_RE.match(text)

                if g is not None:

                    (text, total) = g.groups()

                    self.pb.update(text, None, int(total))

                else:

                    trace.note("%s", text)

class RemoteGitDir(GitDir):

    def __init__(self, transport, format, client, client_path):

        self._format = format

        self.root_transport = transport

        self.transport = transport

        self._mode_check_done = None

        self._client = client

        self._client_path = client_path

        self.base = self.root_transport.base

        self._refs = None

    @property

    def _gitrepository_class(self):

        return RemoteGitRepository

    def fetch_pack(self, determine_wants, graph_walker, pack_data, progress=None):

        if progress is None:

            pb = ui.ui_factory.nested_progress_bar()

            progress = DefaultProgressReporter(pb).progress

        else:

            pb = None

        try:

            result = self._client.fetch_pack(self._client_path, determine_wants,

                graph_walker, pack_data, progress)

            if result.refs is None:

                result.refs = {}

            self._refs = remote_refs_dict_to_container(result.refs, result.symrefs)

            return result

        except GitProtocolError, e:

            raise parse_git_error(self.transport.external_url(), e)

        finally:

            if pb is not None:

                pb.finished()

    def send_pack(self, get_changed_refs, generate_pack_data, progress=None):

        if progress is None:

            pb = ui.ui_factory.nested_progress_bar()

            progress = DefaultProgressReporter(pb).progress

        else:

            pb = None

        def get_changed_refs_wrapper(refs):

            # TODO(jelmer): This drops symref information

            self._refs = remote_refs_dict_to_container(refs)

            return get_changed_refs(refs)

        try:

            return self._client.send_pack(self._client_path,

                    get_changed_refs_wrapper, generate_pack_data, progress)

        except GitProtocolError, e:

            raise parse_git_error(self.transport.external_url(), e)

        finally:

            if pb is not None:

                pb.finished()

    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.get_refs_container():

            raise AlreadyBranchError(self.user_url)

        if refname in self.get_refs_container():

            ref_chain, unused_sha = self.get_refs_container().follow(self._get_selected_ref(None))

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

                refname = ref_chain[1]

        repo = self.open_repository()

        return RemoteGitBranch(self, repo, refname)

    def destroy_branch(self, name=None):

        refname = self._get_selected_ref(name)

        def get_changed_refs(old_refs):

            ret = dict(old_refs)

            if not refname in ret:

                raise NotBranchError(self.user_url)

            ret[refname] = dulwich.client.ZERO_SHA

            return ret

        def generate_pack_data(have, want, ofs_delta=False):

            return pack_objects_to_data([])

        self.send_pack(get_changed_refs, generate_pack_data)

    @property

    def user_url(self):

        return self.control_url

    @property

    def user_transport(self):

        return self.root_transport

    @property

    def control_url(self):

        return self.control_transport.base

    @property

    def control_transport(self):

        return self.root_transport

    def open_repository(self):

        return RemoteGitRepository(self)

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

            ignore_fallbacks=False, ref=None, possible_transports=None,

            nascent_ok=False):

        repo = self.open_repository()

        ref = self._get_selected_ref(name, ref)

        if not nascent_ok and ref not in self.get_refs_container():

            raise NotBranchError(self.root_transport.base,

                    controldir=self)

        ref_chain, unused_sha = self.get_refs_container().follow(ref)

        return RemoteGitBranch(self, repo, ref_chain[-1])

    def open_workingtree(self, recommend_upgrade=False):

        raise NotLocalUrl(self.transport.base)

    def has_workingtree(self):

        return False

    def get_peeled(self, name):

        return self.get_refs_container().get_peeled(name)

    def get_refs_container(self):

        if self._refs is not None:

            return self._refs

        result = self.fetch_pack(lambda x: None, None,

            lambda x: None, lambda x: trace.mutter("git: %s" % x))

        self._refs = remote_refs_dict_to_container(

                result.refs, result.symrefs)

        return self._refs

    def push_branch(self, source, revision_id=None, overwrite=False,

                    remember=False, create_prefix=False, lossy=False,

                    name=None):

        """Push the source branch into this ControlDir."""

        if revision_id is None:

            # No revision supplied by the user, default to the branch

            # revision

            revision_id = source.last_revision()

        push_result = GitPushResult()

        push_result.workingtree_updated = None

        push_result.master_branch = None

        push_result.source_branch = source

        push_result.stacked_on = None

        push_result.branch_push_result = None

        repo = self.find_repository()

        refname = self._get_selected_ref(name)

        if isinstance(source, GitBranch) and lossy:

            raise errors.LossyPushToSameVCS(source.controldir, self)

        source_store = get_object_store(source.repository)

        with source_store.lock_read():

            def get_changed_refs(refs):

                self._refs = remote_refs_dict_to_container(refs)

                ret = dict(refs)

                # TODO(jelmer): Unpeel if necessary

                push_result.new_original_revid = revision_id

                if lossy:

                    new_sha = source_store._lookup_revision_sha1(revision_id)

                else:

                    new_sha = repo.lookup_bzr_revision_id(revision_id)[0]

                if not overwrite:

                    if remote_divergence(ret.get(refname), new_sha, source_store):

                        raise DivergedBranches(

                                source, self.open_branch(name, nascent_ok=True))

                ret[refname] = new_sha

                return ret

            if lossy:

                generate_pack_data = source_store.generate_lossy_pack_data

            else:

                generate_pack_data = source_store.generate_pack_data

            new_refs = self.send_pack(get_changed_refs, generate_pack_data)

        push_result.new_revid = repo.lookup_foreign_revision_id(

                new_refs[refname])

        try:

            old_remote = self._refs[refname]

        except KeyError:

            old_remote = ZERO_SHA

        push_result.old_revid = repo.lookup_foreign_revision_id(old_remote)

        self._refs = remote_refs_dict_to_container(new_refs)

        push_result.target_branch = self.open_branch(name)

        if old_remote != ZERO_SHA:

            push_result.branch_push_result = GitBranchPushResult()

            push_result.branch_push_result.source_branch = source

            push_result.branch_push_result.target_branch = push_result.target_branch

            push_result.branch_push_result.local_branch = None

            push_result.branch_push_result.master_branch = push_result.target_branch

            push_result.branch_push_result.old_revid = push_result.old_revid

            push_result.branch_push_result.new_revid = push_result.new_revid

            push_result.branch_push_result.new_original_revid = push_result.new_original_revid

        if source.get_push_location() is None or remember:

            source.set_push_location(push_result.target_branch.base)

        return push_result

    def _find_commondir(self):

        # There is no way to find the commondir, if there is any.

        return self

class EmptyObjectStoreIterator(dict):

    def iterobjects(self):

        return []

class TemporaryPackIterator(Pack):

    def __init__(self, path, resolve_ext_ref):

        super(TemporaryPackIterator, self).__init__(

            path, resolve_ext_ref=resolve_ext_ref)

        self._idx_load = lambda: self._idx_load_or_generate(self._idx_path)

    def _idx_load_or_generate(self, path):

        if not os.path.exists(path):

            pb = ui.ui_factory.nested_progress_bar()

            try:

                def report_progress(cur, total):

                    pb.update("generating index", cur, total)

                self.data.create_index(path,

                    progress=report_progress)

            finally:

                pb.finished()

        return load_pack_index(path)

    def __del__(self):

        if self._idx is not None:

            self._idx.close()

            os.remove(self._idx_path)

        if self._data is not None:

            self._data.close()

            os.remove(self._data_path)

class BzrGitHttpClient(dulwich.client.HttpGitClient):

    def __init__(self, transport, *args, **kwargs):

        self.transport = transport

        super(BzrGitHttpClient, self).__init__(transport.external_url(), *args, **kwargs)

    def _http_request(self, url, headers=None, data=None,

                      allow_compression=False):

        """Perform HTTP request.

        :param url: Request URL.

        :param headers: Optional custom headers to override defaults.

        :param data: Request data.

        :param allow_compression: Allow GZipped communication.

        :return: Tuple (`response`, `read`), where response is an `urllib3`

            response object with additional `content_type` and

            `redirect_location` properties, and `read` is a consumable read

            method for the response data.

        """

        from breezy.transport.http._urllib2_wrappers import Request

        headers['User-agent'] = user_agent_for_github()

        headers["Pragma"] = "no-cache"

        if allow_compression:

            headers["Accept-Encoding"] = "gzip"

        else:

            headers["Accept-Encoding"] = "identity"

        request = Request(

            ('GET' if data is None else 'POST'),

            url, data, headers,

            accepted_errors=[200, 404])

        response = self.transport._perform(request)

        if response.code == 404:

            raise NotGitRepository()

        elif response.code != 200:

            raise GitProtocolError("unexpected http resp %d for %s" %

                                   (response.code, url))

        # TODO: Optimization available by adding `preload_content=False` to the

        # request and just passing the `read` method on instead of going via

        # `BytesIO`, if we can guarantee that the entire response is consumed

        # before issuing the next to still allow for connection reuse from the

        # pool.

        if response.getheader("Content-Encoding") == "gzip":

            read = gzip.GzipFile(fileobj=response).read

        else:

            read = response.read

        class WrapResponse(object):

            def __init__(self, response):

                self._response = response

                self.status = response.code

                self.content_type = response.getheader("Content-Type")

                self.redirect_location = response.geturl()

            def close(self):

                self._response.close()

        return WrapResponse(response), read