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 (
49
UninitializableFormat,
51
from ..revisiontree import RevisionTree
52
from ..sixish import text_type
53
from ..transport import (
55
register_urlparse_netloc_protocol,
60
user_agent_for_github,
74
BareLocalGitControlDirFormat,
77
GitSmartRemoteNotSupported,
80
from .mapping import (
83
from .object_store import (
89
from .repository import (
100
import dulwich.client
101
from dulwich.errors import (
104
from dulwich.pack import (
106
pack_objects_to_data,
108
from dulwich.protocol import ZERO_SHA
109
from dulwich.refs import (
113
from dulwich.repo import (
122
import urllib.parse as urlparse
123
from urllib.parse import splituser, splitnport
126
from urllib import splituser, splitnport
128
# urlparse only supports a limited number of schemes by default
129
register_urlparse_netloc_protocol('git')
130
register_urlparse_netloc_protocol('git+ssh')
132
from dulwich.pack import load_pack_index
135
class GitPushResult(PushResult):
137
def _lookup_revno(self, revid):
139
return _quick_lookup_revno(self.source_branch, self.target_branch,
141
except GitSmartRemoteNotSupported:
146
return self._lookup_revno(self.old_revid)
150
return self._lookup_revno(self.new_revid)
153
# Don't run any tests on GitSmartTransport as it is not intended to be
154
# a full implementation of Transport
155
def get_test_permutations():
159
def split_git_url(url):
163
:return: Tuple with host, port, username, path.
165
(scheme, netloc, loc, _, _) = urlparse.urlsplit(url)
166
path = urlparse.unquote(loc)
167
if path.startswith("/~"):
169
(username, hostport) = splituser(netloc)
170
(host, port) = splitnport(hostport, None)
171
return (host, port, username, path)
174
class RemoteGitError(BzrError):
176
_fmt = "Remote server error: %(msg)s"
179
class HeadUpdateFailed(BzrError):
181
_fmt = ("Unable to update remote HEAD branch. To update the master "
182
"branch, specify the URL %(base_url)s,branch=master.")
184
def __init__(self, base_url):
185
super(HeadUpdateFailed, self).__init__()
186
self.base_url = base_url
189
def parse_git_error(url, message):
190
"""Parse a remote git server error and return a bzr exception.
192
:param url: URL of the remote repository
193
:param message: Message sent by the remote git server
195
message = str(message).strip()
196
if (message.startswith("Could not find Repository ") or
197
message == 'Repository not found.' or
198
(message.startswith('Repository ') and message.endswith(' not found.'))):
199
return NotBranchError(url, message)
200
if message == "HEAD failed to update":
201
base_url, _ = urlutils.split_segment_parameters(url)
202
return HeadUpdateFailed(base_url)
203
if message.startswith('access denied or repository not exported:'):
204
extra, path = message.split(': ', 1)
205
return PermissionDenied(path, extra)
206
# Don't know, just return it to the user as-is
207
return RemoteGitError(message)
210
class GitSmartTransport(Transport):
212
def __init__(self, url, _client=None):
213
Transport.__init__(self, url)
214
(self._host, self._port, self._username, self._path) = \
216
if 'transport' in debug.debug_flags:
217
trace.mutter('host: %r, user: %r, port: %r, path: %r',
218
self._host, self._username, self._port, self._path)
219
self._client = _client
220
self._stripped_path = self._path.rsplit(",", 1)[0]
222
def external_url(self):
225
def has(self, relpath):
228
def _get_client(self):
229
raise NotImplementedError(self._get_client)
232
return self._stripped_path
235
raise NoSuchFile(path)
237
def abspath(self, relpath):
238
return urlutils.join(self.base, relpath)
240
def clone(self, offset=None):
241
"""See Transport.clone()."""
245
newurl = urlutils.join(self.base, offset)
247
return self.__class__(newurl, self._client)
250
class TCPGitSmartTransport(GitSmartTransport):
254
def _get_client(self):
255
if self._client is not None:
260
# return dulwich.client.LocalGitClient()
261
return dulwich.client.SubprocessGitClient()
262
return dulwich.client.TCPGitClient(self._host, self._port,
263
report_activity=self._report_activity)
266
class SSHSocketWrapper(object):
268
def __init__(self, sock):
271
def read(self, len=None):
272
return self.sock.recv(len)
274
def write(self, data):
275
return self.sock.write(data)
278
return len(select.select([self.sock.fileno()], [], [], 0)[0]) > 0
281
class DulwichSSHVendor(dulwich.client.SSHVendor):
284
from ..transport import ssh
285
self.bzr_ssh_vendor = ssh._get_ssh_vendor()
287
def run_command(self, host, command, username=None, port=None):
288
connection = self.bzr_ssh_vendor.connect_ssh(username=username,
289
password=None, port=port, host=host, command=command)
290
(kind, io_object) = connection.get_sock_or_pipes()
292
return SSHSocketWrapper(io_object)
294
raise AssertionError("Unknown io object kind %r'" % kind)
297
#dulwich.client.get_ssh_vendor = DulwichSSHVendor
300
class SSHGitSmartTransport(GitSmartTransport):
305
path = self._stripped_path
306
if path.startswith("/~/"):
310
def _get_client(self):
311
if self._client is not None:
315
location_config = config.LocationConfig(self.base)
316
client = dulwich.client.SSHGitClient(self._host, self._port, self._username,
317
report_activity=self._report_activity)
318
# Set up alternate pack program paths
319
upload_pack = location_config.get_user_option('git_upload_pack')
321
client.alternative_paths["upload-pack"] = upload_pack
322
receive_pack = location_config.get_user_option('git_receive_pack')
324
client.alternative_paths["receive-pack"] = receive_pack
328
class RemoteGitBranchFormat(GitBranchFormat):
330
def get_format_description(self):
331
return 'Remote Git Branch'
334
def _matchingcontroldir(self):
335
return RemoteGitControlDirFormat()
337
def initialize(self, a_controldir, name=None, repository=None,
338
append_revisions_only=None):
339
raise UninitializableFormat(self)
342
class DefaultProgressReporter(object):
344
_GIT_PROGRESS_PARTIAL_RE = re.compile(r"(.*?): +(\d+)% \((\d+)/(\d+)\)")
345
_GIT_PROGRESS_TOTAL_RE = re.compile(r"(.*?): (\d+)")
347
def __init__(self, pb):
350
def progress(self, text):
351
text = text.rstrip(b"\r\n")
352
text = text.decode('utf-8')
353
if text.startswith('error: '):
354
trace.show_error('git: %s', text[len(b'error: '):])
356
trace.mutter("git: %s", text)
357
g = self._GIT_PROGRESS_PARTIAL_RE.match(text)
359
(text, pct, current, total) = g.groups()
360
self.pb.update(text, int(current), int(total))
362
g = self._GIT_PROGRESS_TOTAL_RE.match(text)
364
(text, total) = g.groups()
365
self.pb.update(text, None, int(total))
367
trace.note("%s", text)
370
class RemoteGitDir(GitDir):
372
def __init__(self, transport, format, client, client_path):
373
self._format = format
374
self.root_transport = transport
375
self.transport = transport
376
self._mode_check_done = None
377
self._client = client
378
self._client_path = client_path
379
self.base = self.root_transport.base
383
def _gitrepository_class(self):
384
return RemoteGitRepository
386
def archive(self, format, committish, write_data, progress=None, write_error=None,
387
subdirs=None, prefix=None):
388
if format not in ('tar', 'zip'):
389
raise errors.NoSuchExportFormat(format)
391
pb = ui.ui_factory.nested_progress_bar()
392
progress = DefaultProgressReporter(pb).progress
396
self._client.archive(self._client_path, committish,
397
write_data, progress, write_error, format=format,
398
subdirs=subdirs, prefix=prefix)
399
except GitProtocolError as e:
400
raise parse_git_error(self.transport.external_url(), e)
405
def fetch_pack(self, determine_wants, graph_walker, pack_data, progress=None):
407
pb = ui.ui_factory.nested_progress_bar()
408
progress = DefaultProgressReporter(pb).progress
412
result = self._client.fetch_pack(self._client_path, determine_wants,
413
graph_walker, pack_data, progress)
414
if result.refs is None:
416
self._refs = remote_refs_dict_to_container(result.refs, result.symrefs)
418
except GitProtocolError as e:
419
raise parse_git_error(self.transport.external_url(), e)
424
def send_pack(self, get_changed_refs, generate_pack_data, progress=None):
426
pb = ui.ui_factory.nested_progress_bar()
427
progress = DefaultProgressReporter(pb).progress
430
def get_changed_refs_wrapper(refs):
431
# TODO(jelmer): This drops symref information
432
self._refs = remote_refs_dict_to_container(refs)
433
return get_changed_refs(refs)
435
return self._client.send_pack(self._client_path,
436
get_changed_refs_wrapper, generate_pack_data, progress)
437
except GitProtocolError as e:
438
raise parse_git_error(self.transport.external_url(), e)
443
def create_branch(self, name=None, repository=None,
444
append_revisions_only=None, ref=None):
445
refname = self._get_selected_ref(name, ref)
446
if refname != b'HEAD' and refname in self.get_refs_container():
447
raise AlreadyBranchError(self.user_url)
448
if refname in self.get_refs_container():
449
ref_chain, unused_sha = self.get_refs_container().follow(self._get_selected_ref(None))
450
if ref_chain[0] == b'HEAD':
451
refname = ref_chain[1]
452
repo = self.open_repository()
453
return RemoteGitBranch(self, repo, refname)
455
def destroy_branch(self, name=None):
456
refname = self._get_selected_ref(name)
457
def get_changed_refs(old_refs):
459
if not refname in ret:
460
raise NotBranchError(self.user_url)
461
ret[refname] = dulwich.client.ZERO_SHA
463
def generate_pack_data(have, want, ofs_delta=False):
464
return pack_objects_to_data([])
465
self.send_pack(get_changed_refs, generate_pack_data)
469
return self.control_url
472
def user_transport(self):
473
return self.root_transport
476
def control_url(self):
477
return self.control_transport.base
480
def control_transport(self):
481
return self.root_transport
483
def open_repository(self):
484
return RemoteGitRepository(self)
486
def open_branch(self, name=None, unsupported=False,
487
ignore_fallbacks=False, ref=None, possible_transports=None,
489
repo = self.open_repository()
490
ref = self._get_selected_ref(name, ref)
491
if not nascent_ok and ref not in self.get_refs_container():
492
raise NotBranchError(self.root_transport.base,
494
ref_chain, unused_sha = self.get_refs_container().follow(ref)
495
return RemoteGitBranch(self, repo, ref_chain[-1])
497
def open_workingtree(self, recommend_upgrade=False):
498
raise NotLocalUrl(self.transport.base)
500
def has_workingtree(self):
503
def get_peeled(self, name):
504
return self.get_refs_container().get_peeled(name)
506
def get_refs_container(self):
507
if self._refs is not None:
509
result = self.fetch_pack(lambda x: None, None,
510
lambda x: None, lambda x: trace.mutter("git: %s" % x))
511
self._refs = remote_refs_dict_to_container(
512
result.refs, result.symrefs)
515
def push_branch(self, source, revision_id=None, overwrite=False,
516
remember=False, create_prefix=False, lossy=False,
518
"""Push the source branch into this ControlDir."""
519
if revision_id is None:
520
# No revision supplied by the user, default to the branch
522
revision_id = source.last_revision()
524
push_result = GitPushResult()
525
push_result.workingtree_updated = None
526
push_result.master_branch = None
527
push_result.source_branch = source
528
push_result.stacked_on = None
529
push_result.branch_push_result = None
530
repo = self.find_repository()
531
refname = self._get_selected_ref(name)
532
if isinstance(source, GitBranch) and lossy:
533
raise errors.LossyPushToSameVCS(source.controldir, self)
534
source_store = get_object_store(source.repository)
535
with source_store.lock_read():
536
def get_changed_refs(refs):
537
self._refs = remote_refs_dict_to_container(refs)
539
# TODO(jelmer): Unpeel if necessary
540
push_result.new_original_revid = revision_id
542
new_sha = source_store._lookup_revision_sha1(revision_id)
544
new_sha = repo.lookup_bzr_revision_id(revision_id)[0]
546
if remote_divergence(ret.get(refname), new_sha, source_store):
547
raise DivergedBranches(
548
source, self.open_branch(name, nascent_ok=True))
549
ret[refname] = new_sha
552
generate_pack_data = source_store.generate_lossy_pack_data
554
generate_pack_data = source_store.generate_pack_data
555
new_refs = self.send_pack(get_changed_refs, generate_pack_data)
556
push_result.new_revid = repo.lookup_foreign_revision_id(
559
old_remote = self._refs[refname]
561
old_remote = ZERO_SHA
562
push_result.old_revid = repo.lookup_foreign_revision_id(old_remote)
563
self._refs = remote_refs_dict_to_container(new_refs)
564
push_result.target_branch = self.open_branch(name)
565
if old_remote != ZERO_SHA:
566
push_result.branch_push_result = GitBranchPushResult()
567
push_result.branch_push_result.source_branch = source
568
push_result.branch_push_result.target_branch = push_result.target_branch
569
push_result.branch_push_result.local_branch = None
570
push_result.branch_push_result.master_branch = push_result.target_branch
571
push_result.branch_push_result.old_revid = push_result.old_revid
572
push_result.branch_push_result.new_revid = push_result.new_revid
573
push_result.branch_push_result.new_original_revid = push_result.new_original_revid
574
if source.get_push_location() is None or remember:
575
source.set_push_location(push_result.target_branch.base)
578
def _find_commondir(self):
579
# There is no way to find the commondir, if there is any.
583
class EmptyObjectStoreIterator(dict):
585
def iterobjects(self):
589
class TemporaryPackIterator(Pack):
591
def __init__(self, path, resolve_ext_ref):
592
super(TemporaryPackIterator, self).__init__(
593
path, resolve_ext_ref=resolve_ext_ref)
594
self._idx_load = lambda: self._idx_load_or_generate(self._idx_path)
596
def _idx_load_or_generate(self, path):
597
if not os.path.exists(path):
598
pb = ui.ui_factory.nested_progress_bar()
600
def report_progress(cur, total):
601
pb.update("generating index", cur, total)
602
self.data.create_index(path,
603
progress=report_progress)
606
return load_pack_index(path)
609
if self._idx is not None:
611
os.remove(self._idx_path)
612
if self._data is not None:
614
os.remove(self._data_path)
617
class BzrGitHttpClient(dulwich.client.HttpGitClient):
619
def __init__(self, transport, *args, **kwargs):
620
self.transport = transport
621
super(BzrGitHttpClient, self).__init__(transport.external_url(), *args, **kwargs)
623
def _http_request(self, url, headers=None, data=None,
624
allow_compression=False):
625
"""Perform HTTP request.
627
:param url: Request URL.
628
:param headers: Optional custom headers to override defaults.
629
:param data: Request data.
630
:param allow_compression: Allow GZipped communication.
631
:return: Tuple (`response`, `read`), where response is an `urllib3`
632
response object with additional `content_type` and
633
`redirect_location` properties, and `read` is a consumable read
634
method for the response data.
636
from breezy.transport.http._urllib2_wrappers import Request
637
headers['User-agent'] = user_agent_for_github()
638
headers["Pragma"] = "no-cache"
639
if allow_compression:
640
headers["Accept-Encoding"] = "gzip"
642
headers["Accept-Encoding"] = "identity"
645
('GET' if data is None else 'POST'),
647
accepted_errors=[200, 404])
648
request.follow_redirections = True
650
response = self.transport._perform(request)
652
if response.code == 404:
653
raise NotGitRepository()
654
elif response.code != 200:
655
raise GitProtocolError("unexpected http resp %d for %s" %
656
(response.code, url))
658
# TODO: Optimization available by adding `preload_content=False` to the
659
# request and just passing the `read` method on instead of going via
660
# `BytesIO`, if we can guarantee that the entire response is consumed
661
# before issuing the next to still allow for connection reuse from the
663
if response.getheader("Content-Encoding") == "gzip":
664
read = gzip.GzipFile(fileobj=response).read
668
class WrapResponse(object):
670
def __init__(self, response):
671
self._response = response
672
self.status = response.code
673
self.content_type = response.getheader("Content-Type")
674
self.redirect_location = response.geturl()
677
self._response.close()
679
return WrapResponse(response), read
682
class RemoteGitControlDirFormat(GitControlDirFormat):
683
"""The .git directory control format."""
685
supports_workingtrees = False
688
def _known_formats(self):
689
return set([RemoteGitControlDirFormat()])
691
def get_branch_format(self):
692
return RemoteGitBranchFormat()
694
def is_initializable(self):
697
def is_supported(self):
700
def open(self, transport, _found=None):
701
"""Open this directory.
704
# we dont grok readonly - git isn't integrated with transport.
706
if url.startswith('readonly+'):
707
url = url[len('readonly+'):]
708
scheme = urlparse.urlsplit(transport.external_url())[0]
709
if isinstance(transport, GitSmartTransport):
710
client = transport._get_client()
711
client_path = transport._get_path()
712
elif scheme in ("http", "https"):
713
client = BzrGitHttpClient(transport)
714
client_path, _ = urlutils.split_segment_parameters(transport._path)
715
elif scheme == 'file':
716
client = dulwich.client.LocalGitClient()
717
client_path = transport.local_abspath('.')
719
raise NotBranchError(transport.base)
721
pass # TODO(jelmer): Actually probe for something
722
return RemoteGitDir(transport, self, client, client_path)
724
def get_format_description(self):
725
return "Remote Git Repository"
727
def initialize_on_transport(self, transport):
728
raise UninitializableFormat(self)
730
def supports_transport(self, transport):
732
external_url = transport.external_url()
733
except InProcessTransport:
734
raise NotBranchError(path=transport.base)
735
return (external_url.startswith("http:") or
736
external_url.startswith("https:") or
737
external_url.startswith("git+") or
738
external_url.startswith("git:"))
741
class GitRemoteRevisionTree(RevisionTree):
743
def archive(self, format, name, root=None, subdir=None, force_mtime=None):
744
"""Create an archive of this tree.
746
:param format: Format name (e.g. 'tar')
747
:param name: target file name
748
:param root: Root directory name (or None)
749
:param subdir: Subdirectory to export (or None)
750
:return: Iterator over archive chunks
752
commit = self._repository.lookup_bzr_revision_id(
753
self.get_revision_id())[0]
754
f = tempfile.SpooledTemporaryFile()
755
# git-upload-archive(1) generaly only supports refs. So let's see if we
759
self._repository.controldir.get_refs_container().as_dict().items()}
761
committish = reverse_refs[commit]
763
# No? Maybe the user has uploadArchive.allowUnreachable enabled.
764
# Let's hope for the best.
766
self._repository.archive(
767
format, committish, f.write,
768
subdirs=([subdir] if subdir else None),
769
prefix=(root+'/') if root else '')
771
return osutils.file_iterator(f)
774
class RemoteGitRepository(GitRepository):
778
return self.control_url
780
def get_parent_map(self, revids):
781
raise GitSmartRemoteNotSupported(self.get_parent_map, self)
783
def archive(self, *args, **kwargs):
784
return self.controldir.archive(*args, **kwargs)
786
def fetch_pack(self, determine_wants, graph_walker, pack_data,
788
return self.controldir.fetch_pack(determine_wants, graph_walker,
791
def send_pack(self, get_changed_refs, generate_pack_data):
792
return self.controldir.send_pack(get_changed_refs, generate_pack_data)
794
def fetch_objects(self, determine_wants, graph_walker, resolve_ext_ref,
796
fd, path = tempfile.mkstemp(suffix=".pack")
798
self.fetch_pack(determine_wants, graph_walker,
799
lambda x: os.write(fd, x), progress)
802
if os.path.getsize(path) == 0:
803
return EmptyObjectStoreIterator()
804
return TemporaryPackIterator(path[:-len(".pack")], resolve_ext_ref)
806
def lookup_bzr_revision_id(self, bzr_revid, mapping=None):
807
# This won't work for any round-tripped bzr revisions, but it's a start..
809
return mapping_registry.revision_id_bzr_to_foreign(bzr_revid)
810
except InvalidRevisionId:
811
raise NoSuchRevision(self, bzr_revid)
813
def lookup_foreign_revision_id(self, foreign_revid, mapping=None):
814
"""Lookup a revision id.
818
mapping = self.get_mapping()
819
# Not really an easy way to parse foreign revids here..
820
return mapping.revision_id_foreign_to_bzr(foreign_revid)
822
def revision_tree(self, revid):
823
return GitRemoteRevisionTree(self, revid)
825
def get_revisions(self, revids):
826
raise GitSmartRemoteNotSupported(self.get_revisions, self)
828
def has_revisions(self, revids):
829
raise GitSmartRemoteNotSupported(self.get_revisions, self)
832
class RemoteGitTagDict(GitTags):
834
def set_tag(self, name, revid):
835
sha = self.branch.lookup_bzr_revision_id(revid)[0]
836
self._set_ref(name, sha)
838
def delete_tag(self, name):
839
self._set_ref(name, dulwich.client.ZERO_SHA)
841
def _set_ref(self, name, sha):
842
ref = tag_name_to_ref(name)
843
def get_changed_refs(old_refs):
845
if sha == dulwich.client.ZERO_SHA and ref not in ret:
846
raise NoSuchTag(name)
849
def generate_pack_data(have, want, ofs_delta=False):
850
return pack_objects_to_data([])
851
self.repository.send_pack(get_changed_refs, generate_pack_data)
854
class RemoteGitBranch(GitBranch):
856
def __init__(self, controldir, repository, name):
858
super(RemoteGitBranch, self).__init__(controldir, repository, name,
859
RemoteGitBranchFormat())
861
def last_revision_info(self):
862
raise GitSmartRemoteNotSupported(self.last_revision_info, self)
866
return self.control_url
869
def control_url(self):
872
def revision_id_to_revno(self, revision_id):
873
raise GitSmartRemoteNotSupported(self.revision_id_to_revno, self)
875
def last_revision(self):
876
return self.lookup_foreign_revision_id(self.head)
880
if self._sha is not None:
882
refs = self.controldir.get_refs_container()
883
name = branch_name_to_ref(self.name)
885
self._sha = refs[name]
887
raise NoSuchRef(name, self.repository.user_url, refs)
890
def _synchronize_history(self, destination, revision_id):
891
"""See Branch._synchronize_history()."""
892
destination.generate_revision_history(self.last_revision())
894
def _get_parent_location(self):
897
def get_push_location(self):
900
def set_push_location(self, url):
903
def _iter_tag_refs(self):
904
"""Iterate over the tag refs.
906
:param refs: Refs dictionary (name -> git sha1)
907
:return: iterator over (ref_name, tag_name, peeled_sha1, unpeeled_sha1)
909
refs = self.controldir.get_refs_container()
910
for ref_name, unpeeled in refs.as_dict().items():
912
tag_name = ref_to_tag_name(ref_name)
913
except (ValueError, UnicodeDecodeError):
915
peeled = refs.get_peeled(ref_name)
917
# Let's just hope it's a commit
919
if not isinstance(tag_name, text_type):
920
raise TypeError(tag_name)
921
yield (ref_name, tag_name, peeled, unpeeled)
924
def remote_refs_dict_to_container(refs_dict, symrefs_dict={}):
927
for k, v in refs_dict.items():
932
for name, target in symrefs_dict.items():
933
base[name] = SYMREF + target
934
ret = DictRefsContainer(base)