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
34
from ...errors import (
46
UninitializableFormat,
48
from ...transport import (
67
BareLocalGitControlDirFormat,
70
GitSmartRemoteNotSupported,
73
from .mapping import (
76
from .object_store import (
82
from .repository import (
94
from dulwich.errors import (
97
from dulwich.pack import (
101
from dulwich.protocol import ZERO_SHA
102
from dulwich.refs import SYMREF
103
from dulwich.repo import DictRefsContainer
110
# urlparse only supports a limited number of schemes by default
112
urlparse.uses_netloc.extend(['git', 'git+ssh'])
114
from dulwich.pack import load_pack_index
117
class GitPushResult(PushResult):
119
def _lookup_revno(self, revid):
121
return _quick_lookup_revno(self.source_branch, self.target_branch,
123
except GitSmartRemoteNotSupported:
128
return self._lookup_revno(self.old_revid)
132
return self._lookup_revno(self.new_revid)
135
# Don't run any tests on GitSmartTransport as it is not intended to be
136
# a full implementation of Transport
137
def get_test_permutations():
141
def split_git_url(url):
145
:return: Tuple with host, port, username, path.
147
(scheme, netloc, loc, _, _) = urlparse.urlsplit(url)
148
path = urllib.unquote(loc)
149
if path.startswith("/~"):
151
(username, hostport) = urllib.splituser(netloc)
152
(host, port) = urllib.splitnport(hostport, None)
153
return (host, port, username, path)
156
class RemoteGitError(BzrError):
158
_fmt = "Remote server error: %(msg)s"
161
def parse_git_error(url, message):
162
"""Parse a remote git server error and return a bzr exception.
164
:param url: URL of the remote repository
165
:param message: Message sent by the remote git server
167
message = str(message).strip()
168
if message.startswith("Could not find Repository "):
169
return NotBranchError(url, message)
170
if message == "HEAD failed to update":
171
base_url, _ = urlutils.split_segment_parameters(url)
173
("Unable to update remote HEAD branch. To update the master "
174
"branch, specify the URL %s,branch=master.") % base_url)
175
# Don't know, just return it to the user as-is
176
return RemoteGitError(message)
179
class GitSmartTransport(Transport):
181
def __init__(self, url, _client=None):
182
Transport.__init__(self, url)
183
(self._host, self._port, self._username, self._path) = \
185
if 'transport' in debug.debug_flags:
186
trace.mutter('host: %r, user: %r, port: %r, path: %r',
187
self._host, self._username, self._port, self._path)
188
self._client = _client
189
self._stripped_path = self._path.rsplit(",", 1)[0]
191
def external_url(self):
194
def has(self, relpath):
197
def _get_client(self):
198
raise NotImplementedError(self._get_client)
201
return self._stripped_path
204
raise NoSuchFile(path)
206
def abspath(self, relpath):
207
return urlutils.join(self.base, relpath)
209
def clone(self, offset=None):
210
"""See Transport.clone()."""
214
newurl = urlutils.join(self.base, offset)
216
return self.__class__(newurl, self._client)
219
class TCPGitSmartTransport(GitSmartTransport):
223
def _get_client(self):
224
if self._client is not None:
229
# return dulwich.client.LocalGitClient()
230
return dulwich.client.SubprocessGitClient()
231
return dulwich.client.TCPGitClient(self._host, self._port,
232
report_activity=self._report_activity)
235
class SSHSocketWrapper(object):
237
def __init__(self, sock):
240
def read(self, len=None):
241
return self.sock.recv(len)
243
def write(self, data):
244
return self.sock.write(data)
247
return len(select.select([self.sock.fileno()], [], [], 0)[0]) > 0
250
class DulwichSSHVendor(dulwich.client.SSHVendor):
253
from ...transport import ssh
254
self.bzr_ssh_vendor = ssh._get_ssh_vendor()
256
def run_command(self, host, command, username=None, port=None):
257
connection = self.bzr_ssh_vendor.connect_ssh(username=username,
258
password=None, port=port, host=host, command=command)
259
(kind, io_object) = connection.get_sock_or_pipes()
261
return SSHSocketWrapper(io_object)
263
raise AssertionError("Unknown io object kind %r'" % kind)
266
#dulwich.client.get_ssh_vendor = DulwichSSHVendor
269
class SSHGitSmartTransport(GitSmartTransport):
274
path = self._stripped_path
275
if path.startswith("/~/"):
279
def _get_client(self):
280
if self._client is not None:
284
location_config = config.LocationConfig(self.base)
285
client = dulwich.client.SSHGitClient(self._host, self._port, self._username,
286
report_activity=self._report_activity)
287
# Set up alternate pack program paths
288
upload_pack = location_config.get_user_option('git_upload_pack')
290
client.alternative_paths["upload-pack"] = upload_pack
291
receive_pack = location_config.get_user_option('git_receive_pack')
293
client.alternative_paths["receive-pack"] = receive_pack
297
class RemoteGitBranchFormat(GitBranchFormat):
299
def get_format_description(self):
300
return 'Remote Git Branch'
303
def _matchingcontroldir(self):
304
return RemoteGitControlDirFormat()
306
def initialize(self, a_controldir, name=None, repository=None,
307
append_revisions_only=None):
308
raise UninitializableFormat(self)
311
class DefaultProgressReporter(object):
313
_GIT_PROGRESS_PARTIAL_RE = re.compile(r"(.*?): +(\d+)% \((\d+)/(\d+)\)")
314
_GIT_PROGRESS_TOTAL_RE = re.compile(r"(.*?): (\d+)")
316
def __init__(self, pb):
319
def progress(self, text):
320
text = text.rstrip("\r\n")
321
if text.startswith('error: '):
322
trace.show_error('git: %s', text[len('error: '):])
324
trace.mutter("git: %s", text)
325
g = self._GIT_PROGRESS_PARTIAL_RE.match(text)
327
(text, pct, current, total) = g.groups()
328
self.pb.update(text, int(current), int(total))
330
g = self._GIT_PROGRESS_TOTAL_RE.match(text)
332
(text, total) = g.groups()
333
self.pb.update(text, None, int(total))
335
trace.note("%s", text)
338
class RemoteGitDir(GitDir):
340
def __init__(self, transport, format, client, client_path):
341
self._format = format
342
self.root_transport = transport
343
self.transport = transport
344
self._mode_check_done = None
345
self._client = client
346
self._client_path = client_path
347
self.base = self.root_transport.base
351
def _gitrepository_class(self):
352
return RemoteGitRepository
354
def fetch_pack(self, determine_wants, graph_walker, pack_data, progress=None):
356
pb = ui.ui_factory.nested_progress_bar()
357
progress = DefaultProgressReporter(pb).progress
361
result = self._client.fetch_pack(self._client_path, determine_wants,
362
graph_walker, pack_data, progress)
363
if result.refs is None:
365
self._refs = remote_refs_dict_to_container(result.refs, result.symrefs)
367
except GitProtocolError, e:
368
raise parse_git_error(self.transport.external_url(), e)
373
def send_pack(self, get_changed_refs, generate_pack_data, progress=None):
375
pb = ui.ui_factory.nested_progress_bar()
376
progress = DefaultProgressReporter(pb).progress
380
return self._client.send_pack(self._client_path, get_changed_refs,
381
generate_pack_data, progress)
382
except GitProtocolError, e:
383
raise parse_git_error(self.transport.external_url(), e)
388
def create_branch(self, name=None, repository=None,
389
append_revisions_only=None, ref=None):
390
refname = self._get_selected_ref(name, ref)
391
if refname != b'HEAD' and refname in self.get_refs_container():
392
raise AlreadyBranchError(self.user_url)
393
if refname in self.get_refs_container():
394
ref_chain, unused_sha = self.get_refs_container().follow(self._get_selected_ref(None))
395
if ref_chain[0] == b'HEAD':
396
refname = ref_chain[1]
397
repo = self.open_repository()
398
return RemoteGitBranch(self, repo, refname)
400
def destroy_branch(self, name=None):
401
refname = self._get_selected_ref(name)
402
def get_changed_refs(old_refs):
404
if not refname in ret:
405
raise NotBranchError(self.user_url)
406
ret[refname] = dulwich.client.ZERO_SHA
408
def generate_pack_data(have, want, ofs_delta=False):
409
return pack_objects_to_data([])
410
self.send_pack(get_changed_refs, generate_pack_data)
414
return self.control_url
417
def user_transport(self):
418
return self.root_transport
421
def control_url(self):
422
return self.control_transport.base
425
def control_transport(self):
426
return self.root_transport
428
def open_repository(self):
429
return RemoteGitRepository(self)
431
def open_branch(self, name=None, unsupported=False,
432
ignore_fallbacks=False, ref=None, possible_transports=None,
434
repo = self.open_repository()
435
ref = self._get_selected_ref(name, ref)
436
if not nascent_ok and ref not in self.get_refs_container():
437
raise NotBranchError(self.root_transport.base,
439
ref_chain, unused_sha = self.get_refs_container().follow(ref)
440
return RemoteGitBranch(self, repo, ref_chain[-1])
442
def open_workingtree(self, recommend_upgrade=False):
443
raise NotLocalUrl(self.transport.base)
445
def has_workingtree(self):
448
def get_peeled(self, name):
449
return self.get_refs_container().get_peeled(name)
451
def get_refs_container(self):
452
if self._refs is not None:
454
result = self.fetch_pack(lambda x: None, None,
455
lambda x: None, lambda x: trace.mutter("git: %s" % x))
456
self._refs = remote_refs_dict_to_container(
457
result.refs, result.symrefs)
460
def push_branch(self, source, revision_id=None, overwrite=False,
461
remember=False, create_prefix=False, lossy=False,
463
"""Push the source branch into this ControlDir."""
464
if revision_id is None:
465
# No revision supplied by the user, default to the branch
467
revision_id = source.last_revision()
469
push_result = GitPushResult()
470
push_result.workingtree_updated = None
471
push_result.master_branch = None
472
push_result.source_branch = source
473
push_result.stacked_on = None
474
push_result.branch_push_result = None
475
repo = self.find_repository()
476
refname = self._get_selected_ref(name)
477
if isinstance(source, GitBranch) and lossy:
478
raise errors.LossyPushToSameVCS(source.controldir, self)
479
source_store = get_object_store(source.repository)
480
with source_store.lock_read():
481
def get_changed_refs(refs):
482
self._refs = remote_refs_dict_to_container(refs)
484
# TODO(jelmer): Unpeel if necessary
485
push_result.new_original_revid = revision_id
487
new_sha = source_store._lookup_revision_sha1(revision_id)
489
new_sha = repo.lookup_bzr_revision_id(revision_id)[0]
491
if remote_divergence(ret.get(refname), new_sha, source_store):
492
raise DivergedBranches(
493
source, self.open_branch(name, nascent_ok=True))
494
ret[refname] = new_sha
497
generate_pack_data = source_store.generate_lossy_pack_data
499
generate_pack_data = source_store.generate_pack_data
500
new_refs = self.send_pack(get_changed_refs, generate_pack_data)
501
push_result.new_revid = repo.lookup_foreign_revision_id(
504
old_remote = self._refs[refname]
506
old_remote = ZERO_SHA
507
push_result.old_revid = repo.lookup_foreign_revision_id(old_remote)
508
self._refs = remote_refs_dict_to_container(new_refs)
509
push_result.target_branch = self.open_branch(name)
510
if old_remote != ZERO_SHA:
511
push_result.branch_push_result = GitBranchPushResult()
512
push_result.branch_push_result.source_branch = source
513
push_result.branch_push_result.target_branch = push_result.target_branch
514
push_result.branch_push_result.local_branch = None
515
push_result.branch_push_result.master_branch = push_result.target_branch
516
push_result.branch_push_result.old_revid = push_result.old_revid
517
push_result.branch_push_result.new_revid = push_result.new_revid
518
push_result.branch_push_result.new_original_revid = push_result.new_original_revid
519
if source.get_push_location() is None or remember:
520
source.set_push_location(push_result.target_branch.base)
524
class EmptyObjectStoreIterator(dict):
526
def iterobjects(self):
530
class TemporaryPackIterator(Pack):
532
def __init__(self, path, resolve_ext_ref):
533
super(TemporaryPackIterator, self).__init__(
534
path, resolve_ext_ref=resolve_ext_ref)
535
self._idx_load = lambda: self._idx_load_or_generate(self._idx_path)
537
def _idx_load_or_generate(self, path):
538
if not os.path.exists(path):
539
pb = ui.ui_factory.nested_progress_bar()
541
def report_progress(cur, total):
542
pb.update("generating index", cur, total)
543
self.data.create_index(path,
544
progress=report_progress)
547
return load_pack_index(path)
550
if self._idx is not None:
552
os.remove(self._idx_path)
553
if self._data is not None:
555
os.remove(self._data_path)
558
class BzrGitHttpClient(dulwich.client.HttpGitClient):
560
def __init__(self, transport, *args, **kwargs):
561
self.transport = transport
562
super(BzrGitHttpClient, self).__init__(transport.external_url(), *args, **kwargs)
564
self._http_perform = getattr(self.transport, "_perform", urllib2.urlopen)
566
def _perform(self, req):
567
req.accepted_errors = (200, 404)
568
req.follow_redirections = True
569
req.redirected_to = None
570
return self._http_perform(req)
573
class RemoteGitControlDirFormat(GitControlDirFormat):
574
"""The .git directory control format."""
576
supports_workingtrees = False
579
def _known_formats(self):
580
return set([RemoteGitControlDirFormat()])
582
def get_branch_format(self):
583
return RemoteGitBranchFormat()
585
def is_initializable(self):
588
def is_supported(self):
591
def open(self, transport, _found=None):
592
"""Open this directory.
595
# we dont grok readonly - git isn't integrated with transport.
597
if url.startswith('readonly+'):
598
url = url[len('readonly+'):]
599
scheme = urlparse.urlsplit(transport.external_url())[0]
600
if isinstance(transport, GitSmartTransport):
601
client = transport._get_client()
602
client_path = transport._get_path()
603
elif scheme in ("http", "https"):
604
client = BzrGitHttpClient(transport)
605
client_path, _ = urlutils.split_segment_parameters(transport._path)
606
elif scheme == 'file':
607
client = dulwich.client.LocalGitClient()
608
client_path = transport.local_abspath('.')
610
raise NotBranchError(transport.base)
612
pass # TODO(jelmer): Actually probe for something
613
return RemoteGitDir(transport, self, client, client_path)
615
def get_format_description(self):
616
return "Remote Git Repository"
618
def initialize_on_transport(self, transport):
619
raise UninitializableFormat(self)
621
def supports_transport(self, transport):
623
external_url = transport.external_url()
624
except InProcessTransport:
625
raise NotBranchError(path=transport.base)
626
return (external_url.startswith("http:") or
627
external_url.startswith("https:") or
628
external_url.startswith("git+") or
629
external_url.startswith("git:"))
632
class RemoteGitRepository(GitRepository):
636
return self.control_url
638
def get_parent_map(self, revids):
639
raise GitSmartRemoteNotSupported(self.get_parent_map, self)
641
def fetch_pack(self, determine_wants, graph_walker, pack_data,
643
return self.controldir.fetch_pack(determine_wants, graph_walker,
646
def send_pack(self, get_changed_refs, generate_pack_data):
647
return self.controldir.send_pack(get_changed_refs, generate_pack_data)
649
def fetch_objects(self, determine_wants, graph_walker, resolve_ext_ref,
651
fd, path = tempfile.mkstemp(suffix=".pack")
653
self.fetch_pack(determine_wants, graph_walker,
654
lambda x: os.write(fd, x), progress)
657
if os.path.getsize(path) == 0:
658
return EmptyObjectStoreIterator()
659
return TemporaryPackIterator(path[:-len(".pack")], resolve_ext_ref)
661
def lookup_bzr_revision_id(self, bzr_revid, mapping=None):
662
# This won't work for any round-tripped bzr revisions, but it's a start..
664
return mapping_registry.revision_id_bzr_to_foreign(bzr_revid)
665
except InvalidRevisionId:
666
raise NoSuchRevision(self, bzr_revid)
668
def lookup_foreign_revision_id(self, foreign_revid, mapping=None):
669
"""Lookup a revision id.
673
mapping = self.get_mapping()
674
# Not really an easy way to parse foreign revids here..
675
return mapping.revision_id_foreign_to_bzr(foreign_revid)
677
def revision_tree(self, revid):
678
raise GitSmartRemoteNotSupported(self.revision_tree, self)
680
def get_revisions(self, revids):
681
raise GitSmartRemoteNotSupported(self.get_revisions, self)
683
def has_revisions(self, revids):
684
raise GitSmartRemoteNotSupported(self.get_revisions, self)
687
class RemoteGitTagDict(GitTags):
689
def set_tag(self, name, revid):
690
sha = self.branch.lookup_bzr_revision_id(revid)[0]
691
self._set_ref(name, sha)
693
def delete_tag(self, name):
694
self._set_ref(name, dulwich.client.ZERO_SHA)
696
def _set_ref(self, name, sha):
697
ref = tag_name_to_ref(name)
698
def get_changed_refs(old_refs):
700
if sha == dulwich.client.ZERO_SHA and ref not in ret:
701
raise NoSuchTag(name)
704
def generate_pack_data(have, want, ofs_delta=False):
705
return pack_objects_to_data([])
706
self.repository.send_pack(get_changed_refs, generate_pack_data)
709
class RemoteGitBranch(GitBranch):
711
def __init__(self, controldir, repository, name):
713
super(RemoteGitBranch, self).__init__(controldir, repository, name,
714
RemoteGitBranchFormat())
716
def last_revision_info(self):
717
raise GitSmartRemoteNotSupported(self.last_revision_info, self)
721
return self.control_url
724
def control_url(self):
727
def revision_id_to_revno(self, revision_id):
728
raise GitSmartRemoteNotSupported(self.revision_id_to_revno, self)
730
def last_revision(self):
731
return self.lookup_foreign_revision_id(self.head)
735
if self._sha is not None:
737
refs = self.controldir.get_refs_container()
738
name = branch_name_to_ref(self.name)
740
self._sha = refs[name]
742
raise NoSuchRef(name, self.repository.user_url, refs)
745
def _synchronize_history(self, destination, revision_id):
746
"""See Branch._synchronize_history()."""
747
destination.generate_revision_history(self.last_revision())
749
def _get_parent_location(self):
752
def get_push_location(self):
755
def set_push_location(self, url):
758
def _iter_tag_refs(self):
759
"""Iterate over the tag refs.
761
:param refs: Refs dictionary (name -> git sha1)
762
:return: iterator over (ref_name, tag_name, peeled_sha1, unpeeled_sha1)
764
refs = self.controldir.get_refs_container()
765
for ref_name, unpeeled in refs.as_dict().iteritems():
767
tag_name = ref_to_tag_name(ref_name)
768
except (ValueError, UnicodeDecodeError):
770
peeled = refs.get_peeled(ref_name)
773
peeled = refs.peel_sha(unpeeled).id
775
# Let's just hope it's a commit
777
if type(tag_name) is not unicode:
778
raise TypeError(tag_name)
779
yield (ref_name, tag_name, peeled, unpeeled)
782
def remote_refs_dict_to_container(refs_dict, symrefs_dict={}):
785
for k, v in refs_dict.iteritems():
791
for name, target in symrefs_dict.iteritems():
792
base[name] = SYMREF + target
793
ret = DictRefsContainer(base)