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
21
from io import BytesIO
36
from ...errors import (
48
UninitializableFormat,
50
from ...revisiontree import RevisionTree
51
from ...sixish import text_type
52
from ...transport import (
54
register_urlparse_netloc_protocol,
59
user_agent_for_github,
73
BareLocalGitControlDirFormat,
76
GitSmartRemoteNotSupported,
79
from .mapping import (
82
from .object_store import (
88
from .repository import (
100
from dulwich.errors import (
103
from dulwich.pack import (
105
pack_objects_to_data,
107
from dulwich.protocol import ZERO_SHA
108
from dulwich.refs import (
112
from dulwich.repo import (
121
import urllib.parse as urlparse
122
from urllib.parse import splituser, splitnport
125
from urllib import splituser, splitnport
127
# urlparse only supports a limited number of schemes by default
128
register_urlparse_netloc_protocol('git')
129
register_urlparse_netloc_protocol('git+ssh')
131
from dulwich.pack import load_pack_index
134
class GitPushResult(PushResult):
136
def _lookup_revno(self, revid):
138
return _quick_lookup_revno(self.source_branch, self.target_branch,
140
except GitSmartRemoteNotSupported:
145
return self._lookup_revno(self.old_revid)
149
return self._lookup_revno(self.new_revid)
152
# Don't run any tests on GitSmartTransport as it is not intended to be
153
# a full implementation of Transport
154
def get_test_permutations():
158
def split_git_url(url):
162
:return: Tuple with host, port, username, path.
164
(scheme, netloc, loc, _, _) = urlparse.urlsplit(url)
165
path = urlparse.unquote(loc)
166
if path.startswith("/~"):
168
(username, hostport) = splituser(netloc)
169
(host, port) = splitnport(hostport, None)
170
return (host, port, username, path)
173
class RemoteGitError(BzrError):
175
_fmt = "Remote server error: %(msg)s"
178
def parse_git_error(url, message):
179
"""Parse a remote git server error and return a bzr exception.
181
:param url: URL of the remote repository
182
:param message: Message sent by the remote git server
184
message = str(message).strip()
185
if message.startswith("Could not find Repository "):
186
return NotBranchError(url, message)
187
if message == "HEAD failed to update":
188
base_url, _ = urlutils.split_segment_parameters(url)
190
("Unable to update remote HEAD branch. To update the master "
191
"branch, specify the URL %s,branch=master.") % base_url)
192
# Don't know, just return it to the user as-is
193
return RemoteGitError(message)
196
class GitSmartTransport(Transport):
198
def __init__(self, url, _client=None):
199
Transport.__init__(self, url)
200
(self._host, self._port, self._username, self._path) = \
202
if 'transport' in debug.debug_flags:
203
trace.mutter('host: %r, user: %r, port: %r, path: %r',
204
self._host, self._username, self._port, self._path)
205
self._client = _client
206
self._stripped_path = self._path.rsplit(",", 1)[0]
208
def external_url(self):
211
def has(self, relpath):
214
def _get_client(self):
215
raise NotImplementedError(self._get_client)
218
return self._stripped_path
221
raise NoSuchFile(path)
223
def abspath(self, relpath):
224
return urlutils.join(self.base, relpath)
226
def clone(self, offset=None):
227
"""See Transport.clone()."""
231
newurl = urlutils.join(self.base, offset)
233
return self.__class__(newurl, self._client)
236
class TCPGitSmartTransport(GitSmartTransport):
240
def _get_client(self):
241
if self._client is not None:
246
# return dulwich.client.LocalGitClient()
247
return dulwich.client.SubprocessGitClient()
248
return dulwich.client.TCPGitClient(self._host, self._port,
249
report_activity=self._report_activity)
252
class SSHSocketWrapper(object):
254
def __init__(self, sock):
257
def read(self, len=None):
258
return self.sock.recv(len)
260
def write(self, data):
261
return self.sock.write(data)
264
return len(select.select([self.sock.fileno()], [], [], 0)[0]) > 0
267
class DulwichSSHVendor(dulwich.client.SSHVendor):
270
from ...transport import ssh
271
self.bzr_ssh_vendor = ssh._get_ssh_vendor()
273
def run_command(self, host, command, username=None, port=None):
274
connection = self.bzr_ssh_vendor.connect_ssh(username=username,
275
password=None, port=port, host=host, command=command)
276
(kind, io_object) = connection.get_sock_or_pipes()
278
return SSHSocketWrapper(io_object)
280
raise AssertionError("Unknown io object kind %r'" % kind)
283
#dulwich.client.get_ssh_vendor = DulwichSSHVendor
286
class SSHGitSmartTransport(GitSmartTransport):
291
path = self._stripped_path
292
if path.startswith("/~/"):
296
def _get_client(self):
297
if self._client is not None:
301
location_config = config.LocationConfig(self.base)
302
client = dulwich.client.SSHGitClient(self._host, self._port, self._username,
303
report_activity=self._report_activity)
304
# Set up alternate pack program paths
305
upload_pack = location_config.get_user_option('git_upload_pack')
307
client.alternative_paths["upload-pack"] = upload_pack
308
receive_pack = location_config.get_user_option('git_receive_pack')
310
client.alternative_paths["receive-pack"] = receive_pack
314
class RemoteGitBranchFormat(GitBranchFormat):
316
def get_format_description(self):
317
return 'Remote Git Branch'
320
def _matchingcontroldir(self):
321
return RemoteGitControlDirFormat()
323
def initialize(self, a_controldir, name=None, repository=None,
324
append_revisions_only=None):
325
raise UninitializableFormat(self)
328
class DefaultProgressReporter(object):
330
_GIT_PROGRESS_PARTIAL_RE = re.compile(r"(.*?): +(\d+)% \((\d+)/(\d+)\)")
331
_GIT_PROGRESS_TOTAL_RE = re.compile(r"(.*?): (\d+)")
333
def __init__(self, pb):
336
def progress(self, text):
337
text = text.rstrip("\r\n")
338
if text.startswith('error: '):
339
trace.show_error('git: %s', text[len('error: '):])
341
trace.mutter("git: %s", text)
342
g = self._GIT_PROGRESS_PARTIAL_RE.match(text)
344
(text, pct, current, total) = g.groups()
345
self.pb.update(text, int(current), int(total))
347
g = self._GIT_PROGRESS_TOTAL_RE.match(text)
349
(text, total) = g.groups()
350
self.pb.update(text, None, int(total))
352
trace.note("%s", text)
355
class RemoteGitDir(GitDir):
357
def __init__(self, transport, format, client, client_path):
358
self._format = format
359
self.root_transport = transport
360
self.transport = transport
361
self._mode_check_done = None
362
self._client = client
363
self._client_path = client_path
364
self.base = self.root_transport.base
368
def _gitrepository_class(self):
369
return RemoteGitRepository
371
def archive(self, format, committish, write_data, progress=None, write_error=None,
372
subdirs=None, prefix=None):
373
if format not in ('tar', 'zip'):
374
raise errors.NoSuchExportFormat(format)
376
pb = ui.ui_factory.nested_progress_bar()
377
progress = DefaultProgressReporter(pb).progress
381
self._client.archive(self._client_path, committish,
382
write_data, progress, write_error, format=format,
383
subdirs=subdirs, prefix=prefix)
384
except GitProtocolError as e:
385
raise parse_git_error(self.transport.external_url(), e)
390
def fetch_pack(self, determine_wants, graph_walker, pack_data, progress=None):
392
pb = ui.ui_factory.nested_progress_bar()
393
progress = DefaultProgressReporter(pb).progress
397
result = self._client.fetch_pack(self._client_path, determine_wants,
398
graph_walker, pack_data, progress)
399
if result.refs is None:
401
self._refs = remote_refs_dict_to_container(result.refs, result.symrefs)
403
except GitProtocolError as e:
404
raise parse_git_error(self.transport.external_url(), e)
409
def send_pack(self, get_changed_refs, generate_pack_data, progress=None):
411
pb = ui.ui_factory.nested_progress_bar()
412
progress = DefaultProgressReporter(pb).progress
415
def get_changed_refs_wrapper(refs):
416
# TODO(jelmer): This drops symref information
417
self._refs = remote_refs_dict_to_container(refs)
418
return get_changed_refs(refs)
420
return self._client.send_pack(self._client_path,
421
get_changed_refs_wrapper, generate_pack_data, progress)
422
except GitProtocolError as e:
423
raise parse_git_error(self.transport.external_url(), e)
428
def create_branch(self, name=None, repository=None,
429
append_revisions_only=None, ref=None):
430
refname = self._get_selected_ref(name, ref)
431
if refname != b'HEAD' and refname in self.get_refs_container():
432
raise AlreadyBranchError(self.user_url)
433
if refname in self.get_refs_container():
434
ref_chain, unused_sha = self.get_refs_container().follow(self._get_selected_ref(None))
435
if ref_chain[0] == b'HEAD':
436
refname = ref_chain[1]
437
repo = self.open_repository()
438
return RemoteGitBranch(self, repo, refname)
440
def destroy_branch(self, name=None):
441
refname = self._get_selected_ref(name)
442
def get_changed_refs(old_refs):
444
if not refname in ret:
445
raise NotBranchError(self.user_url)
446
ret[refname] = dulwich.client.ZERO_SHA
448
def generate_pack_data(have, want, ofs_delta=False):
449
return pack_objects_to_data([])
450
self.send_pack(get_changed_refs, generate_pack_data)
454
return self.control_url
457
def user_transport(self):
458
return self.root_transport
461
def control_url(self):
462
return self.control_transport.base
465
def control_transport(self):
466
return self.root_transport
468
def open_repository(self):
469
return RemoteGitRepository(self)
471
def open_branch(self, name=None, unsupported=False,
472
ignore_fallbacks=False, ref=None, possible_transports=None,
474
repo = self.open_repository()
475
ref = self._get_selected_ref(name, ref)
476
if not nascent_ok and ref not in self.get_refs_container():
477
raise NotBranchError(self.root_transport.base,
479
ref_chain, unused_sha = self.get_refs_container().follow(ref)
480
return RemoteGitBranch(self, repo, ref_chain[-1])
482
def open_workingtree(self, recommend_upgrade=False):
483
raise NotLocalUrl(self.transport.base)
485
def has_workingtree(self):
488
def get_peeled(self, name):
489
return self.get_refs_container().get_peeled(name)
491
def get_refs_container(self):
492
if self._refs is not None:
494
result = self.fetch_pack(lambda x: None, None,
495
lambda x: None, lambda x: trace.mutter("git: %s" % x))
496
self._refs = remote_refs_dict_to_container(
497
result.refs, result.symrefs)
500
def push_branch(self, source, revision_id=None, overwrite=False,
501
remember=False, create_prefix=False, lossy=False,
503
"""Push the source branch into this ControlDir."""
504
if revision_id is None:
505
# No revision supplied by the user, default to the branch
507
revision_id = source.last_revision()
509
push_result = GitPushResult()
510
push_result.workingtree_updated = None
511
push_result.master_branch = None
512
push_result.source_branch = source
513
push_result.stacked_on = None
514
push_result.branch_push_result = None
515
repo = self.find_repository()
516
refname = self._get_selected_ref(name)
517
if isinstance(source, GitBranch) and lossy:
518
raise errors.LossyPushToSameVCS(source.controldir, self)
519
source_store = get_object_store(source.repository)
520
with source_store.lock_read():
521
def get_changed_refs(refs):
522
self._refs = remote_refs_dict_to_container(refs)
524
# TODO(jelmer): Unpeel if necessary
525
push_result.new_original_revid = revision_id
527
new_sha = source_store._lookup_revision_sha1(revision_id)
529
new_sha = repo.lookup_bzr_revision_id(revision_id)[0]
531
if remote_divergence(ret.get(refname), new_sha, source_store):
532
raise DivergedBranches(
533
source, self.open_branch(name, nascent_ok=True))
534
ret[refname] = new_sha
537
generate_pack_data = source_store.generate_lossy_pack_data
539
generate_pack_data = source_store.generate_pack_data
540
new_refs = self.send_pack(get_changed_refs, generate_pack_data)
541
push_result.new_revid = repo.lookup_foreign_revision_id(
544
old_remote = self._refs[refname]
546
old_remote = ZERO_SHA
547
push_result.old_revid = repo.lookup_foreign_revision_id(old_remote)
548
self._refs = remote_refs_dict_to_container(new_refs)
549
push_result.target_branch = self.open_branch(name)
550
if old_remote != ZERO_SHA:
551
push_result.branch_push_result = GitBranchPushResult()
552
push_result.branch_push_result.source_branch = source
553
push_result.branch_push_result.target_branch = push_result.target_branch
554
push_result.branch_push_result.local_branch = None
555
push_result.branch_push_result.master_branch = push_result.target_branch
556
push_result.branch_push_result.old_revid = push_result.old_revid
557
push_result.branch_push_result.new_revid = push_result.new_revid
558
push_result.branch_push_result.new_original_revid = push_result.new_original_revid
559
if source.get_push_location() is None or remember:
560
source.set_push_location(push_result.target_branch.base)
563
def _find_commondir(self):
564
# There is no way to find the commondir, if there is any.
568
class EmptyObjectStoreIterator(dict):
570
def iterobjects(self):
574
class TemporaryPackIterator(Pack):
576
def __init__(self, path, resolve_ext_ref):
577
super(TemporaryPackIterator, self).__init__(
578
path, resolve_ext_ref=resolve_ext_ref)
579
self._idx_load = lambda: self._idx_load_or_generate(self._idx_path)
581
def _idx_load_or_generate(self, path):
582
if not os.path.exists(path):
583
pb = ui.ui_factory.nested_progress_bar()
585
def report_progress(cur, total):
586
pb.update("generating index", cur, total)
587
self.data.create_index(path,
588
progress=report_progress)
591
return load_pack_index(path)
594
if self._idx is not None:
596
os.remove(self._idx_path)
597
if self._data is not None:
599
os.remove(self._data_path)
602
class BzrGitHttpClient(dulwich.client.HttpGitClient):
604
def __init__(self, transport, *args, **kwargs):
605
self.transport = transport
606
super(BzrGitHttpClient, self).__init__(transport.external_url(), *args, **kwargs)
608
def _http_request(self, url, headers=None, data=None,
609
allow_compression=False):
610
"""Perform HTTP request.
612
:param url: Request URL.
613
:param headers: Optional custom headers to override defaults.
614
:param data: Request data.
615
:param allow_compression: Allow GZipped communication.
616
:return: Tuple (`response`, `read`), where response is an `urllib3`
617
response object with additional `content_type` and
618
`redirect_location` properties, and `read` is a consumable read
619
method for the response data.
621
from breezy.transport.http._urllib2_wrappers import Request
622
headers['User-agent'] = user_agent_for_github()
623
headers["Pragma"] = "no-cache"
624
if allow_compression:
625
headers["Accept-Encoding"] = "gzip"
627
headers["Accept-Encoding"] = "identity"
630
('GET' if data is None else 'POST'),
632
accepted_errors=[200, 404])
634
response = self.transport._perform(request)
636
if response.code == 404:
637
raise NotGitRepository()
638
elif response.code != 200:
639
raise GitProtocolError("unexpected http resp %d for %s" %
640
(response.code, url))
642
# TODO: Optimization available by adding `preload_content=False` to the
643
# request and just passing the `read` method on instead of going via
644
# `BytesIO`, if we can guarantee that the entire response is consumed
645
# before issuing the next to still allow for connection reuse from the
647
if response.getheader("Content-Encoding") == "gzip":
648
read = gzip.GzipFile(fileobj=response).read
652
class WrapResponse(object):
654
def __init__(self, response):
655
self._response = response
656
self.status = response.code
657
self.content_type = response.getheader("Content-Type")
658
self.redirect_location = response.geturl()
661
self._response.close()
663
return WrapResponse(response), read
666
class RemoteGitControlDirFormat(GitControlDirFormat):
667
"""The .git directory control format."""
669
supports_workingtrees = False
672
def _known_formats(self):
673
return set([RemoteGitControlDirFormat()])
675
def get_branch_format(self):
676
return RemoteGitBranchFormat()
678
def is_initializable(self):
681
def is_supported(self):
684
def open(self, transport, _found=None):
685
"""Open this directory.
688
# we dont grok readonly - git isn't integrated with transport.
690
if url.startswith('readonly+'):
691
url = url[len('readonly+'):]
692
scheme = urlparse.urlsplit(transport.external_url())[0]
693
if isinstance(transport, GitSmartTransport):
694
client = transport._get_client()
695
client_path = transport._get_path()
696
elif scheme in ("http", "https"):
697
client = BzrGitHttpClient(transport)
698
client_path, _ = urlutils.split_segment_parameters(transport._path)
699
elif scheme == 'file':
700
client = dulwich.client.LocalGitClient()
701
client_path = transport.local_abspath('.')
703
raise NotBranchError(transport.base)
705
pass # TODO(jelmer): Actually probe for something
706
return RemoteGitDir(transport, self, client, client_path)
708
def get_format_description(self):
709
return "Remote Git Repository"
711
def initialize_on_transport(self, transport):
712
raise UninitializableFormat(self)
714
def supports_transport(self, transport):
716
external_url = transport.external_url()
717
except InProcessTransport:
718
raise NotBranchError(path=transport.base)
719
return (external_url.startswith("http:") or
720
external_url.startswith("https:") or
721
external_url.startswith("git+") or
722
external_url.startswith("git:"))
725
class GitRemoteRevisionTree(RevisionTree):
727
def archive(self, format, name, root=None, subdir=None, force_mtime=None):
728
"""Create an archive of this tree.
730
:param format: Format name (e.g. 'tar')
731
:param name: target file name
732
:param root: Root directory name (or None)
733
:param subdir: Subdirectory to export (or None)
734
:return: Iterator over archive chunks
736
commit = self._repository.lookup_bzr_revision_id(
737
self.get_revision_id())[0]
738
f = tempfile.SpooledTemporaryFile()
739
# git-upload-archive(1) generaly only supports refs. So let's see if we
743
self._repository.controldir.get_refs_container().as_dict().items()}
745
committish = reverse_refs[commit]
747
# No? Maybe the user has uploadArchive.allowUnreachable enabled.
748
# Let's hope for the best.
750
self._repository.archive(
751
format, committish, f.write,
752
subdirs=([subdir] if subdir else None),
753
prefix=(root+'/') if root else '')
755
return osutils.file_iterator(f)
758
class RemoteGitRepository(GitRepository):
762
return self.control_url
764
def get_parent_map(self, revids):
765
raise GitSmartRemoteNotSupported(self.get_parent_map, self)
767
def archive(self, *args, **kwargs):
768
return self.controldir.archive(*args, **kwargs)
770
def fetch_pack(self, determine_wants, graph_walker, pack_data,
772
return self.controldir.fetch_pack(determine_wants, graph_walker,
775
def send_pack(self, get_changed_refs, generate_pack_data):
776
return self.controldir.send_pack(get_changed_refs, generate_pack_data)
778
def fetch_objects(self, determine_wants, graph_walker, resolve_ext_ref,
780
fd, path = tempfile.mkstemp(suffix=".pack")
782
self.fetch_pack(determine_wants, graph_walker,
783
lambda x: os.write(fd, x), progress)
786
if os.path.getsize(path) == 0:
787
return EmptyObjectStoreIterator()
788
return TemporaryPackIterator(path[:-len(".pack")], resolve_ext_ref)
790
def lookup_bzr_revision_id(self, bzr_revid, mapping=None):
791
# This won't work for any round-tripped bzr revisions, but it's a start..
793
return mapping_registry.revision_id_bzr_to_foreign(bzr_revid)
794
except InvalidRevisionId:
795
raise NoSuchRevision(self, bzr_revid)
797
def lookup_foreign_revision_id(self, foreign_revid, mapping=None):
798
"""Lookup a revision id.
802
mapping = self.get_mapping()
803
# Not really an easy way to parse foreign revids here..
804
return mapping.revision_id_foreign_to_bzr(foreign_revid)
806
def revision_tree(self, revid):
807
return GitRemoteRevisionTree(self, revid)
809
def get_revisions(self, revids):
810
raise GitSmartRemoteNotSupported(self.get_revisions, self)
812
def has_revisions(self, revids):
813
raise GitSmartRemoteNotSupported(self.get_revisions, self)
816
class RemoteGitTagDict(GitTags):
818
def set_tag(self, name, revid):
819
sha = self.branch.lookup_bzr_revision_id(revid)[0]
820
self._set_ref(name, sha)
822
def delete_tag(self, name):
823
self._set_ref(name, dulwich.client.ZERO_SHA)
825
def _set_ref(self, name, sha):
826
ref = tag_name_to_ref(name)
827
def get_changed_refs(old_refs):
829
if sha == dulwich.client.ZERO_SHA and ref not in ret:
830
raise NoSuchTag(name)
833
def generate_pack_data(have, want, ofs_delta=False):
834
return pack_objects_to_data([])
835
self.repository.send_pack(get_changed_refs, generate_pack_data)
838
class RemoteGitBranch(GitBranch):
840
def __init__(self, controldir, repository, name):
842
super(RemoteGitBranch, self).__init__(controldir, repository, name,
843
RemoteGitBranchFormat())
845
def last_revision_info(self):
846
raise GitSmartRemoteNotSupported(self.last_revision_info, self)
850
return self.control_url
853
def control_url(self):
856
def revision_id_to_revno(self, revision_id):
857
raise GitSmartRemoteNotSupported(self.revision_id_to_revno, self)
859
def last_revision(self):
860
return self.lookup_foreign_revision_id(self.head)
864
if self._sha is not None:
866
refs = self.controldir.get_refs_container()
867
name = branch_name_to_ref(self.name)
869
self._sha = refs[name]
871
raise NoSuchRef(name, self.repository.user_url, refs)
874
def _synchronize_history(self, destination, revision_id):
875
"""See Branch._synchronize_history()."""
876
destination.generate_revision_history(self.last_revision())
878
def _get_parent_location(self):
881
def get_push_location(self):
884
def set_push_location(self, url):
887
def _iter_tag_refs(self):
888
"""Iterate over the tag refs.
890
:param refs: Refs dictionary (name -> git sha1)
891
:return: iterator over (ref_name, tag_name, peeled_sha1, unpeeled_sha1)
893
refs = self.controldir.get_refs_container()
894
for ref_name, unpeeled in refs.as_dict().items():
896
tag_name = ref_to_tag_name(ref_name)
897
except (ValueError, UnicodeDecodeError):
899
peeled = refs.get_peeled(ref_name)
902
peeled = refs.peel_sha(unpeeled).id
904
# Let's just hope it's a commit
906
if not isinstance(tag_name, text_type):
907
raise TypeError(tag_name)
908
yield (ref_name, tag_name, peeled, unpeeled)
911
def remote_refs_dict_to_container(refs_dict, symrefs_dict={}):
914
for k, v in refs_dict.items():
920
for name, target in symrefs_dict.items():
921
base[name] = SYMREF + target
922
ret = DictRefsContainer(base)