1
# Copyright (C) 2007-2018 Jelmer Vernooij <jelmer@jelmer.uk>
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""Remote dirs, repositories and branches."""
19
from __future__ import absolute_import
35
from ..errors import (
47
UninitializableFormat,
49
from ..revisiontree import RevisionTree
50
from ..sixish import text_type
51
from ..transport import (
53
register_urlparse_netloc_protocol,
58
user_agent_for_github,
74
GitSmartRemoteNotSupported,
77
from .mapping import (
80
from .object_store import (
86
from .repository import (
98
from dulwich.errors import (
101
from dulwich.pack import (
103
pack_objects_to_data,
105
from dulwich.protocol import ZERO_SHA
106
from dulwich.refs import (
110
from dulwich.repo import (
118
import urllib.parse as urlparse
119
from urllib.parse import splituser, splitnport
122
from urllib import splituser, splitnport
124
# urlparse only supports a limited number of schemes by default
125
register_urlparse_netloc_protocol('git')
126
register_urlparse_netloc_protocol('git+ssh')
128
from dulwich.pack import load_pack_index
131
class GitPushResult(PushResult):
133
def _lookup_revno(self, revid):
135
return _quick_lookup_revno(self.source_branch, self.target_branch,
137
except GitSmartRemoteNotSupported:
142
return self._lookup_revno(self.old_revid)
146
return self._lookup_revno(self.new_revid)
149
# Don't run any tests on GitSmartTransport as it is not intended to be
150
# a full implementation of Transport
151
def get_test_permutations():
155
def split_git_url(url):
159
:return: Tuple with host, port, username, path.
161
(scheme, netloc, loc, _, _) = urlparse.urlsplit(url)
162
path = urlparse.unquote(loc)
163
if path.startswith("/~"):
165
(username, hostport) = splituser(netloc)
166
(host, port) = splitnport(hostport, None)
167
return (host, port, username, path)
170
class RemoteGitError(BzrError):
172
_fmt = "Remote server error: %(msg)s"
175
class HeadUpdateFailed(BzrError):
177
_fmt = ("Unable to update remote HEAD branch. To update the master "
178
"branch, specify the URL %(base_url)s,branch=master.")
180
def __init__(self, base_url):
181
super(HeadUpdateFailed, self).__init__()
182
self.base_url = base_url
185
def parse_git_error(url, message):
186
"""Parse a remote git server error and return a bzr exception.
188
:param url: URL of the remote repository
189
:param message: Message sent by the remote git server
191
message = str(message).strip()
192
if (message.startswith("Could not find Repository ")
193
or message == 'Repository not found.'
194
or (message.startswith('Repository ') and message.endswith(' not found.'))):
195
return NotBranchError(url, message)
196
if message == "HEAD failed to update":
197
base_url, _ = urlutils.split_segment_parameters(url)
198
return HeadUpdateFailed(base_url)
199
if message.startswith('access denied or repository not exported:'):
200
extra, path = message.split(': ', 1)
201
return PermissionDenied(path, extra)
202
if message.endswith('You are not allowed to push code to this project.'):
203
return PermissionDenied(url, message)
204
if message.endswith(' does not appear to be a git repository'):
205
return NotBranchError(url, message)
206
m = re.match(r'Permission to ([^ ]+) denied to ([^ ]+)\.', message)
208
return PermissionDenied(m.group(1), 'denied to %s' % m.group(2))
209
# Don't know, just return it to the user as-is
210
return RemoteGitError(message)
213
class GitSmartTransport(Transport):
215
def __init__(self, url, _client=None):
216
Transport.__init__(self, url)
217
(self._host, self._port, self._username, self._path) = \
219
if 'transport' in debug.debug_flags:
220
trace.mutter('host: %r, user: %r, port: %r, path: %r',
221
self._host, self._username, self._port, self._path)
222
self._client = _client
223
self._stripped_path = self._path.rsplit(",", 1)[0]
225
def external_url(self):
228
def has(self, relpath):
231
def _get_client(self):
232
raise NotImplementedError(self._get_client)
235
return self._stripped_path
238
raise NoSuchFile(path)
240
def abspath(self, relpath):
241
return urlutils.join(self.base, relpath)
243
def clone(self, offset=None):
244
"""See Transport.clone()."""
248
newurl = urlutils.join(self.base, offset)
250
return self.__class__(newurl, self._client)
253
class TCPGitSmartTransport(GitSmartTransport):
257
def _get_client(self):
258
if self._client is not None:
263
# return dulwich.client.LocalGitClient()
264
return dulwich.client.SubprocessGitClient()
265
return dulwich.client.TCPGitClient(self._host, self._port,
266
report_activity=self._report_activity)
269
class SSHSocketWrapper(object):
271
def __init__(self, sock):
274
def read(self, len=None):
275
return self.sock.recv(len)
277
def write(self, data):
278
return self.sock.write(data)
281
return len(select.select([self.sock.fileno()], [], [], 0)[0]) > 0
284
class DulwichSSHVendor(dulwich.client.SSHVendor):
287
from ..transport import ssh
288
self.bzr_ssh_vendor = ssh._get_ssh_vendor()
290
def run_command(self, host, command, username=None, port=None):
291
connection = self.bzr_ssh_vendor.connect_ssh(username=username,
292
password=None, port=port, host=host, command=command)
293
(kind, io_object) = connection.get_sock_or_pipes()
295
return SSHSocketWrapper(io_object)
297
raise AssertionError("Unknown io object kind %r'" % kind)
300
#dulwich.client.get_ssh_vendor = DulwichSSHVendor
303
class SSHGitSmartTransport(GitSmartTransport):
308
path = self._stripped_path
309
if path.startswith("/~/"):
313
def _get_client(self):
314
if self._client is not None:
318
location_config = config.LocationConfig(self.base)
319
client = dulwich.client.SSHGitClient(self._host, self._port, self._username,
320
report_activity=self._report_activity)
321
# Set up alternate pack program paths
322
upload_pack = location_config.get_user_option('git_upload_pack')
324
client.alternative_paths["upload-pack"] = upload_pack
325
receive_pack = location_config.get_user_option('git_receive_pack')
327
client.alternative_paths["receive-pack"] = receive_pack
331
class RemoteGitBranchFormat(GitBranchFormat):
333
def get_format_description(self):
334
return 'Remote Git Branch'
337
def _matchingcontroldir(self):
338
return RemoteGitControlDirFormat()
340
def initialize(self, a_controldir, name=None, repository=None,
341
append_revisions_only=None):
342
raise UninitializableFormat(self)
345
class DefaultProgressReporter(object):
347
_GIT_PROGRESS_PARTIAL_RE = re.compile(r"(.*?): +(\d+)% \((\d+)/(\d+)\)")
348
_GIT_PROGRESS_TOTAL_RE = re.compile(r"(.*?): (\d+)")
350
def __init__(self, pb):
353
def progress(self, text):
354
text = text.rstrip(b"\r\n")
355
text = text.decode('utf-8')
356
if text.lower().startswith('error: '):
357
trace.show_error('git: %s', text[len(b'error: '):])
359
trace.mutter("git: %s", text)
360
g = self._GIT_PROGRESS_PARTIAL_RE.match(text)
362
(text, pct, current, total) = g.groups()
363
self.pb.update(text, int(current), int(total))
365
g = self._GIT_PROGRESS_TOTAL_RE.match(text)
367
(text, total) = g.groups()
368
self.pb.update(text, None, int(total))
370
trace.note("%s", text)
373
class RemoteGitDir(GitDir):
375
def __init__(self, transport, format, client, client_path):
376
self._format = format
377
self.root_transport = transport
378
self.transport = transport
379
self._mode_check_done = None
380
self._client = client
381
self._client_path = client_path
382
self.base = self.root_transport.base
386
def _gitrepository_class(self):
387
return RemoteGitRepository
389
def archive(self, format, committish, write_data, progress=None, write_error=None,
390
subdirs=None, prefix=None):
391
if format not in ('tar', 'zip'):
392
raise errors.NoSuchExportFormat(format)
394
pb = ui.ui_factory.nested_progress_bar()
395
progress = DefaultProgressReporter(pb).progress
399
self._client.archive(self._client_path, committish,
400
write_data, progress, write_error, format=format,
401
subdirs=subdirs, prefix=prefix)
402
except GitProtocolError as e:
403
raise parse_git_error(self.transport.external_url(), e)
408
def fetch_pack(self, determine_wants, graph_walker, pack_data, progress=None):
410
pb = ui.ui_factory.nested_progress_bar()
411
progress = DefaultProgressReporter(pb).progress
415
result = self._client.fetch_pack(self._client_path, determine_wants,
416
graph_walker, pack_data, progress)
417
if result.refs is None:
419
self._refs = remote_refs_dict_to_container(
420
result.refs, result.symrefs)
422
except GitProtocolError as e:
423
raise parse_git_error(self.transport.external_url(), e)
428
def send_pack(self, get_changed_refs, generate_pack_data, progress=None):
430
pb = ui.ui_factory.nested_progress_bar()
431
progress = DefaultProgressReporter(pb).progress
435
def get_changed_refs_wrapper(refs):
436
# TODO(jelmer): This drops symref information
437
self._refs = remote_refs_dict_to_container(refs)
438
return get_changed_refs(refs)
440
return self._client.send_pack(self._client_path,
441
get_changed_refs_wrapper, generate_pack_data, progress)
442
except GitProtocolError as e:
443
raise parse_git_error(self.transport.external_url(), e)
448
def create_branch(self, name=None, repository=None,
449
append_revisions_only=None, ref=None):
450
refname = self._get_selected_ref(name, ref)
451
if refname != b'HEAD' and refname in self.get_refs_container():
452
raise AlreadyBranchError(self.user_url)
453
if refname in self.get_refs_container():
454
ref_chain, unused_sha = self.get_refs_container().follow(
455
self._get_selected_ref(None))
456
if ref_chain[0] == b'HEAD':
457
refname = ref_chain[1]
458
repo = self.open_repository()
459
return RemoteGitBranch(self, repo, refname)
461
def destroy_branch(self, name=None):
462
refname = self._get_selected_ref(name)
464
def get_changed_refs(old_refs):
466
if not refname in ret:
467
raise NotBranchError(self.user_url)
468
ret[refname] = dulwich.client.ZERO_SHA
471
def generate_pack_data(have, want, ofs_delta=False):
472
return pack_objects_to_data([])
473
self.send_pack(get_changed_refs, generate_pack_data)
477
return self.control_url
480
def user_transport(self):
481
return self.root_transport
484
def control_url(self):
485
return self.control_transport.base
488
def control_transport(self):
489
return self.root_transport
491
def open_repository(self):
492
return RemoteGitRepository(self)
494
def open_branch(self, name=None, unsupported=False,
495
ignore_fallbacks=False, ref=None, possible_transports=None,
497
repo = self.open_repository()
498
ref = self._get_selected_ref(name, ref)
499
if not nascent_ok and ref not in self.get_refs_container():
500
raise NotBranchError(self.root_transport.base,
502
ref_chain, unused_sha = self.get_refs_container().follow(ref)
503
return RemoteGitBranch(self, repo, ref_chain[-1])
505
def open_workingtree(self, recommend_upgrade=False):
506
raise NotLocalUrl(self.transport.base)
508
def has_workingtree(self):
511
def get_peeled(self, name):
512
return self.get_refs_container().get_peeled(name)
514
def get_refs_container(self):
515
if self._refs is not None:
517
result = self.fetch_pack(lambda x: None, None,
518
lambda x: None, lambda x: trace.mutter("git: %s" % x))
519
self._refs = remote_refs_dict_to_container(
520
result.refs, result.symrefs)
523
def push_branch(self, source, revision_id=None, overwrite=False,
524
remember=False, create_prefix=False, lossy=False,
526
"""Push the source branch into this ControlDir."""
527
if revision_id is None:
528
# No revision supplied by the user, default to the branch
530
revision_id = source.last_revision()
532
push_result = GitPushResult()
533
push_result.workingtree_updated = None
534
push_result.master_branch = None
535
push_result.source_branch = source
536
push_result.stacked_on = None
537
push_result.branch_push_result = None
538
repo = self.find_repository()
539
refname = self._get_selected_ref(name)
540
if isinstance(source, GitBranch) and lossy:
541
raise errors.LossyPushToSameVCS(source.controldir, self)
542
source_store = get_object_store(source.repository)
543
with source_store.lock_read():
544
def get_changed_refs(refs):
545
self._refs = remote_refs_dict_to_container(refs)
547
# TODO(jelmer): Unpeel if necessary
548
push_result.new_original_revid = revision_id
550
new_sha = source_store._lookup_revision_sha1(revision_id)
552
new_sha = repo.lookup_bzr_revision_id(revision_id)[0]
554
if remote_divergence(ret.get(refname), new_sha, source_store):
555
raise DivergedBranches(
556
source, self.open_branch(name, nascent_ok=True))
557
ret[refname] = new_sha
560
generate_pack_data = source_store.generate_lossy_pack_data
562
generate_pack_data = source_store.generate_pack_data
563
new_refs = self.send_pack(get_changed_refs, generate_pack_data)
564
push_result.new_revid = repo.lookup_foreign_revision_id(
567
old_remote = self._refs[refname]
569
old_remote = ZERO_SHA
570
push_result.old_revid = repo.lookup_foreign_revision_id(old_remote)
571
self._refs = remote_refs_dict_to_container(new_refs)
572
push_result.target_branch = self.open_branch(name)
573
if old_remote != ZERO_SHA:
574
push_result.branch_push_result = GitBranchPushResult()
575
push_result.branch_push_result.source_branch = source
576
push_result.branch_push_result.target_branch = push_result.target_branch
577
push_result.branch_push_result.local_branch = None
578
push_result.branch_push_result.master_branch = push_result.target_branch
579
push_result.branch_push_result.old_revid = push_result.old_revid
580
push_result.branch_push_result.new_revid = push_result.new_revid
581
push_result.branch_push_result.new_original_revid = push_result.new_original_revid
582
if source.get_push_location() is None or remember:
583
source.set_push_location(push_result.target_branch.base)
586
def _find_commondir(self):
587
# There is no way to find the commondir, if there is any.
591
class EmptyObjectStoreIterator(dict):
593
def iterobjects(self):
597
class TemporaryPackIterator(Pack):
599
def __init__(self, path, resolve_ext_ref):
600
super(TemporaryPackIterator, self).__init__(
601
path, resolve_ext_ref=resolve_ext_ref)
602
self._idx_load = lambda: self._idx_load_or_generate(self._idx_path)
604
def _idx_load_or_generate(self, path):
605
if not os.path.exists(path):
606
pb = ui.ui_factory.nested_progress_bar()
608
def report_progress(cur, total):
609
pb.update("generating index", cur, total)
610
self.data.create_index(path,
611
progress=report_progress)
614
return load_pack_index(path)
617
if self._idx is not None:
619
os.remove(self._idx_path)
620
if self._data is not None:
622
os.remove(self._data_path)
625
class BzrGitHttpClient(dulwich.client.HttpGitClient):
627
def __init__(self, transport, *args, **kwargs):
628
self.transport = transport
629
super(BzrGitHttpClient, self).__init__(
630
transport.external_url(), *args, **kwargs)
632
def _http_request(self, url, headers=None, data=None,
633
allow_compression=False):
634
"""Perform HTTP request.
636
:param url: Request URL.
637
:param headers: Optional custom headers to override defaults.
638
:param data: Request data.
639
:param allow_compression: Allow GZipped communication.
640
:return: Tuple (`response`, `read`), where response is an `urllib3`
641
response object with additional `content_type` and
642
`redirect_location` properties, and `read` is a consumable read
643
method for the response data.
645
from breezy.transport.http._urllib2_wrappers import Request
646
headers['User-agent'] = user_agent_for_github()
647
headers["Pragma"] = "no-cache"
648
if allow_compression:
649
headers["Accept-Encoding"] = "gzip"
651
headers["Accept-Encoding"] = "identity"
654
('GET' if data is None else 'POST'),
656
accepted_errors=[200, 404])
657
request.follow_redirections = True
659
response = self.transport._perform(request)
661
if response.code == 404:
662
raise NotGitRepository()
663
elif response.code != 200:
664
raise GitProtocolError("unexpected http resp %d for %s" %
665
(response.code, url))
667
# TODO: Optimization available by adding `preload_content=False` to the
668
# request and just passing the `read` method on instead of going via
669
# `BytesIO`, if we can guarantee that the entire response is consumed
670
# before issuing the next to still allow for connection reuse from the
672
if response.getheader("Content-Encoding") == "gzip":
673
read = gzip.GzipFile(fileobj=response).read
677
class WrapResponse(object):
679
def __init__(self, response):
680
self._response = response
681
self.status = response.code
682
self.content_type = response.getheader("Content-Type")
683
self.redirect_location = response.geturl()
686
self._response.close()
688
return WrapResponse(response), read
691
class RemoteGitControlDirFormat(GitControlDirFormat):
692
"""The .git directory control format."""
694
supports_workingtrees = False
697
def _known_formats(self):
698
return set([RemoteGitControlDirFormat()])
700
def get_branch_format(self):
701
return RemoteGitBranchFormat()
703
def is_initializable(self):
706
def is_supported(self):
709
def open(self, transport, _found=None):
710
"""Open this directory.
713
# we dont grok readonly - git isn't integrated with transport.
715
if url.startswith('readonly+'):
716
url = url[len('readonly+'):]
717
scheme = urlparse.urlsplit(transport.external_url())[0]
718
if isinstance(transport, GitSmartTransport):
719
client = transport._get_client()
720
client_path = transport._get_path()
721
elif scheme in ("http", "https"):
722
client = BzrGitHttpClient(transport)
723
client_path, _ = urlutils.split_segment_parameters(transport._path)
724
elif scheme == 'file':
725
client = dulwich.client.LocalGitClient()
726
client_path = transport.local_abspath('.')
728
raise NotBranchError(transport.base)
730
pass # TODO(jelmer): Actually probe for something
731
return RemoteGitDir(transport, self, client, client_path)
733
def get_format_description(self):
734
return "Remote Git Repository"
736
def initialize_on_transport(self, transport):
737
raise UninitializableFormat(self)
739
def supports_transport(self, transport):
741
external_url = transport.external_url()
742
except InProcessTransport:
743
raise NotBranchError(path=transport.base)
744
return (external_url.startswith("http:")
745
or external_url.startswith("https:")
746
or external_url.startswith("git+")
747
or external_url.startswith("git:"))
750
class GitRemoteRevisionTree(RevisionTree):
752
def archive(self, format, name, root=None, subdir=None, force_mtime=None):
753
"""Create an archive of this tree.
755
:param format: Format name (e.g. 'tar')
756
:param name: target file name
757
:param root: Root directory name (or None)
758
:param subdir: Subdirectory to export (or None)
759
:return: Iterator over archive chunks
761
commit = self._repository.lookup_bzr_revision_id(
762
self.get_revision_id())[0]
763
f = tempfile.SpooledTemporaryFile()
764
# git-upload-archive(1) generaly only supports refs. So let's see if we
768
self._repository.controldir.get_refs_container().as_dict().items()}
770
committish = reverse_refs[commit]
772
# No? Maybe the user has uploadArchive.allowUnreachable enabled.
773
# Let's hope for the best.
775
self._repository.archive(
776
format, committish, f.write,
777
subdirs=([subdir] if subdir else None),
778
prefix=(root + '/') if root else '')
780
return osutils.file_iterator(f)
783
class RemoteGitRepository(GitRepository):
787
return self.control_url
789
def get_parent_map(self, revids):
790
raise GitSmartRemoteNotSupported(self.get_parent_map, self)
792
def archive(self, *args, **kwargs):
793
return self.controldir.archive(*args, **kwargs)
795
def fetch_pack(self, determine_wants, graph_walker, pack_data,
797
return self.controldir.fetch_pack(determine_wants, graph_walker,
800
def send_pack(self, get_changed_refs, generate_pack_data):
801
return self.controldir.send_pack(get_changed_refs, generate_pack_data)
803
def fetch_objects(self, determine_wants, graph_walker, resolve_ext_ref,
805
fd, path = tempfile.mkstemp(suffix=".pack")
807
self.fetch_pack(determine_wants, graph_walker,
808
lambda x: os.write(fd, x), progress)
811
if os.path.getsize(path) == 0:
812
return EmptyObjectStoreIterator()
813
return TemporaryPackIterator(path[:-len(".pack")], resolve_ext_ref)
815
def lookup_bzr_revision_id(self, bzr_revid, mapping=None):
816
# This won't work for any round-tripped bzr revisions, but it's a start..
818
return mapping_registry.revision_id_bzr_to_foreign(bzr_revid)
819
except InvalidRevisionId:
820
raise NoSuchRevision(self, bzr_revid)
822
def lookup_foreign_revision_id(self, foreign_revid, mapping=None):
823
"""Lookup a revision id.
827
mapping = self.get_mapping()
828
# Not really an easy way to parse foreign revids here..
829
return mapping.revision_id_foreign_to_bzr(foreign_revid)
831
def revision_tree(self, revid):
832
return GitRemoteRevisionTree(self, revid)
834
def get_revisions(self, revids):
835
raise GitSmartRemoteNotSupported(self.get_revisions, self)
837
def has_revisions(self, revids):
838
raise GitSmartRemoteNotSupported(self.get_revisions, self)
841
class RemoteGitTagDict(GitTags):
843
def set_tag(self, name, revid):
844
sha = self.branch.lookup_bzr_revision_id(revid)[0]
845
self._set_ref(name, sha)
847
def delete_tag(self, name):
848
self._set_ref(name, dulwich.client.ZERO_SHA)
850
def _set_ref(self, name, sha):
851
ref = tag_name_to_ref(name)
853
def get_changed_refs(old_refs):
855
if sha == dulwich.client.ZERO_SHA and ref not in ret:
856
raise NoSuchTag(name)
860
def generate_pack_data(have, want, ofs_delta=False):
861
return pack_objects_to_data([])
862
self.repository.send_pack(get_changed_refs, generate_pack_data)
865
class RemoteGitBranch(GitBranch):
867
def __init__(self, controldir, repository, name):
869
super(RemoteGitBranch, self).__init__(controldir, repository, name,
870
RemoteGitBranchFormat())
872
def last_revision_info(self):
873
raise GitSmartRemoteNotSupported(self.last_revision_info, self)
877
return self.control_url
880
def control_url(self):
883
def revision_id_to_revno(self, revision_id):
884
raise GitSmartRemoteNotSupported(self.revision_id_to_revno, self)
886
def last_revision(self):
887
return self.lookup_foreign_revision_id(self.head)
891
if self._sha is not None:
893
refs = self.controldir.get_refs_container()
894
name = branch_name_to_ref(self.name)
896
self._sha = refs[name]
898
raise NoSuchRef(name, self.repository.user_url, refs)
901
def _synchronize_history(self, destination, revision_id):
902
"""See Branch._synchronize_history()."""
903
destination.generate_revision_history(self.last_revision())
905
def _get_parent_location(self):
908
def get_push_location(self):
911
def set_push_location(self, url):
914
def _iter_tag_refs(self):
915
"""Iterate over the tag refs.
917
:param refs: Refs dictionary (name -> git sha1)
918
:return: iterator over (ref_name, tag_name, peeled_sha1, unpeeled_sha1)
920
refs = self.controldir.get_refs_container()
921
for ref_name, unpeeled in refs.as_dict().items():
923
tag_name = ref_to_tag_name(ref_name)
924
except (ValueError, UnicodeDecodeError):
926
peeled = refs.get_peeled(ref_name)
928
# Let's just hope it's a commit
930
if not isinstance(tag_name, text_type):
931
raise TypeError(tag_name)
932
yield (ref_name, tag_name, peeled, unpeeled)
935
def remote_refs_dict_to_container(refs_dict, symrefs_dict={}):
938
for k, v in refs_dict.items():
943
for name, target in symrefs_dict.items():
944
base[name] = SYMREF + target
945
ret = DictRefsContainer(base)