1
# Copyright (C) 2006, 2007 Canonical Ltd
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
# TODO: At some point, handle upgrades by just passing the whole request
18
# across to run on the server.
21
from cStringIO import StringIO
33
from bzrlib.branch import BranchReferenceFormat
34
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
35
from bzrlib.config import BranchConfig, TreeConfig
36
from bzrlib.decorators import needs_read_lock, needs_write_lock
37
from bzrlib.errors import NoSuchRevision
38
from bzrlib.lockable_files import LockableFiles
39
from bzrlib.pack import ContainerPushParser
40
from bzrlib.smart import client, vfs
41
from bzrlib.symbol_versioning import (
45
from bzrlib.revision import NULL_REVISION
46
from bzrlib.trace import mutter, note, warning
48
# Note: RemoteBzrDirFormat is in bzrdir.py
50
class RemoteBzrDir(BzrDir):
51
"""Control directory on a remote server, accessed via bzr:// or similar."""
53
def __init__(self, transport, _client=None):
54
"""Construct a RemoteBzrDir.
56
:param _client: Private parameter for testing. Disables probing and the
59
BzrDir.__init__(self, transport, RemoteBzrDirFormat())
60
# this object holds a delegated bzrdir that uses file-level operations
61
# to talk to the other side
62
self._real_bzrdir = None
65
self._shared_medium = transport.get_shared_medium()
66
self._client = client._SmartClient(self._shared_medium)
68
self._client = _client
69
self._shared_medium = None
72
path = self._path_for_remote_call(self._client)
73
response = self._client.call('BzrDir.open', path)
74
if response not in [('yes',), ('no',)]:
75
raise errors.UnexpectedSmartServerResponse(response)
76
if response == ('no',):
77
raise errors.NotBranchError(path=transport.base)
79
def _ensure_real(self):
80
"""Ensure that there is a _real_bzrdir set.
82
Used before calls to self._real_bzrdir.
84
if not self._real_bzrdir:
85
self._real_bzrdir = BzrDir.open_from_transport(
86
self.root_transport, _server_formats=False)
88
def create_repository(self, shared=False):
90
self._real_bzrdir.create_repository(shared=shared)
91
return self.open_repository()
93
def destroy_repository(self):
94
"""See BzrDir.destroy_repository"""
96
self._real_bzrdir.destroy_repository()
98
def create_branch(self):
100
real_branch = self._real_bzrdir.create_branch()
101
return RemoteBranch(self, self.find_repository(), real_branch)
103
def destroy_branch(self):
104
"""See BzrDir.destroy_branch"""
106
self._real_bzrdir.destroy_branch()
108
def create_workingtree(self, revision_id=None, from_branch=None):
109
raise errors.NotLocalUrl(self.transport.base)
111
def find_branch_format(self):
112
"""Find the branch 'format' for this bzrdir.
114
This might be a synthetic object for e.g. RemoteBranch and SVN.
116
b = self.open_branch()
119
def get_branch_reference(self):
120
"""See BzrDir.get_branch_reference()."""
121
path = self._path_for_remote_call(self._client)
122
response = self._client.call('BzrDir.open_branch', path)
123
if response[0] == 'ok':
124
if response[1] == '':
125
# branch at this location.
128
# a branch reference, use the existing BranchReference logic.
130
elif response == ('nobranch',):
131
raise errors.NotBranchError(path=self.root_transport.base)
133
raise errors.UnexpectedSmartServerResponse(response)
135
def _get_tree_branch(self):
136
"""See BzrDir._get_tree_branch()."""
137
return None, self.open_branch()
139
def open_branch(self, _unsupported=False):
140
assert _unsupported == False, 'unsupported flag support not implemented yet.'
141
reference_url = self.get_branch_reference()
142
if reference_url is None:
143
# branch at this location.
144
return RemoteBranch(self, self.find_repository())
146
# a branch reference, use the existing BranchReference logic.
147
format = BranchReferenceFormat()
148
return format.open(self, _found=True, location=reference_url)
150
def open_repository(self):
151
path = self._path_for_remote_call(self._client)
152
verb = 'BzrDir.find_repositoryV2'
153
response = self._client.call(verb, path)
154
if (response == ('error', "Generic bzr smart protocol error: "
155
"bad request '%s'" % verb) or
156
response == ('error', "Generic bzr smart protocol error: "
157
"bad request u'%s'" % verb)):
158
verb = 'BzrDir.find_repository'
159
response = self._client.call(verb, path)
160
assert response[0] in ('ok', 'norepository'), \
161
'unexpected response code %s' % (response,)
162
if response[0] == 'norepository':
163
raise errors.NoRepositoryPresent(self)
164
if verb == 'BzrDir.find_repository':
165
# servers that don't support the V2 method don't support external
167
response = response + ('no', )
168
assert len(response) == 5, 'incorrect response length %s' % (response,)
169
if response[1] == '':
170
format = RemoteRepositoryFormat()
171
format.rich_root_data = (response[2] == 'yes')
172
format.supports_tree_reference = (response[3] == 'yes')
173
# No wire format to check this yet.
174
format.supports_external_lookups = (response[4] == 'yes')
175
return RemoteRepository(self, format)
177
raise errors.NoRepositoryPresent(self)
179
def open_workingtree(self, recommend_upgrade=True):
181
if self._real_bzrdir.has_workingtree():
182
raise errors.NotLocalUrl(self.root_transport)
184
raise errors.NoWorkingTree(self.root_transport.base)
186
def _path_for_remote_call(self, client):
187
"""Return the path to be used for this bzrdir in a remote call."""
188
return client.remote_path_from_transport(self.root_transport)
190
def get_branch_transport(self, branch_format):
192
return self._real_bzrdir.get_branch_transport(branch_format)
194
def get_repository_transport(self, repository_format):
196
return self._real_bzrdir.get_repository_transport(repository_format)
198
def get_workingtree_transport(self, workingtree_format):
200
return self._real_bzrdir.get_workingtree_transport(workingtree_format)
202
def can_convert_format(self):
203
"""Upgrading of remote bzrdirs is not supported yet."""
206
def needs_format_conversion(self, format=None):
207
"""Upgrading of remote bzrdirs is not supported yet."""
210
def clone(self, url, revision_id=None, force_new_repo=False):
212
return self._real_bzrdir.clone(url, revision_id=revision_id,
213
force_new_repo=force_new_repo)
216
class RemoteRepositoryFormat(repository.RepositoryFormat):
217
"""Format for repositories accessed over a _SmartClient.
219
Instances of this repository are represented by RemoteRepository
222
The RemoteRepositoryFormat is parameterized during construction
223
to reflect the capabilities of the real, remote format. Specifically
224
the attributes rich_root_data and supports_tree_reference are set
225
on a per instance basis, and are not set (and should not be) at
229
_matchingbzrdir = RemoteBzrDirFormat
231
def initialize(self, a_bzrdir, shared=False):
232
assert isinstance(a_bzrdir, RemoteBzrDir), \
233
'%r is not a RemoteBzrDir' % (a_bzrdir,)
234
return a_bzrdir.create_repository(shared=shared)
236
def open(self, a_bzrdir):
237
assert isinstance(a_bzrdir, RemoteBzrDir)
238
return a_bzrdir.open_repository()
240
def get_format_description(self):
241
return 'bzr remote repository'
243
def __eq__(self, other):
244
return self.__class__ == other.__class__
246
def check_conversion_target(self, target_format):
247
if self.rich_root_data and not target_format.rich_root_data:
248
raise errors.BadConversionTarget(
249
'Does not support rich root data.', target_format)
250
if (self.supports_tree_reference and
251
not getattr(target_format, 'supports_tree_reference', False)):
252
raise errors.BadConversionTarget(
253
'Does not support nested trees', target_format)
256
class RemoteRepository(object):
257
"""Repository accessed over rpc.
259
For the moment most operations are performed using local transport-backed
263
def __init__(self, remote_bzrdir, format, real_repository=None, _client=None):
264
"""Create a RemoteRepository instance.
266
:param remote_bzrdir: The bzrdir hosting this repository.
267
:param format: The RemoteFormat object to use.
268
:param real_repository: If not None, a local implementation of the
269
repository logic for the repository, usually accessing the data
271
:param _client: Private testing parameter - override the smart client
272
to be used by the repository.
275
self._real_repository = real_repository
277
self._real_repository = None
278
self.bzrdir = remote_bzrdir
280
self._client = client._SmartClient(self.bzrdir._shared_medium)
282
self._client = _client
283
self._format = format
284
self._lock_mode = None
285
self._lock_token = None
287
self._leave_lock = False
288
# A cache of looked up revision parent data; reset at unlock time.
289
self._parents_map = None
290
if 'hpss' in debug.debug_flags:
291
self._requested_parents = None
293
# These depend on the actual remote format, so force them off for
294
# maximum compatibility. XXX: In future these should depend on the
295
# remote repository instance, but this is irrelevant until we perform
296
# reconcile via an RPC call.
297
self._reconcile_does_inventory_gc = False
298
self._reconcile_fixes_text_parents = False
299
self._reconcile_backsup_inventory = False
300
self.base = self.bzrdir.transport.base
303
return "%s(%s)" % (self.__class__.__name__, self.base)
307
def abort_write_group(self):
308
"""Complete a write group on the decorated repository.
310
Smart methods peform operations in a single step so this api
311
is not really applicable except as a compatibility thunk
312
for older plugins that don't use e.g. the CommitBuilder
316
return self._real_repository.abort_write_group()
318
def commit_write_group(self):
319
"""Complete a write group on the decorated repository.
321
Smart methods peform operations in a single step so this api
322
is not really applicable except as a compatibility thunk
323
for older plugins that don't use e.g. the CommitBuilder
327
return self._real_repository.commit_write_group()
329
def _ensure_real(self):
330
"""Ensure that there is a _real_repository set.
332
Used before calls to self._real_repository.
334
if not self._real_repository:
335
self.bzrdir._ensure_real()
336
#self._real_repository = self.bzrdir._real_bzrdir.open_repository()
337
self._set_real_repository(self.bzrdir._real_bzrdir.open_repository())
339
def find_text_key_references(self):
340
"""Find the text key references within the repository.
342
:return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
343
revision_ids. Each altered file-ids has the exact revision_ids that
344
altered it listed explicitly.
345
:return: A dictionary mapping text keys ((fileid, revision_id) tuples)
346
to whether they were referred to by the inventory of the
347
revision_id that they contain. The inventory texts from all present
348
revision ids are assessed to generate this report.
351
return self._real_repository.find_text_key_references()
353
def _generate_text_key_index(self):
354
"""Generate a new text key index for the repository.
356
This is an expensive function that will take considerable time to run.
358
:return: A dict mapping (file_id, revision_id) tuples to a list of
359
parents, also (file_id, revision_id) tuples.
362
return self._real_repository._generate_text_key_index()
364
def get_revision_graph(self, revision_id=None):
365
"""See Repository.get_revision_graph()."""
366
if revision_id is None:
368
elif revision.is_null(revision_id):
371
path = self.bzrdir._path_for_remote_call(self._client)
372
assert type(revision_id) is str
373
response = self._client.call_expecting_body(
374
'Repository.get_revision_graph', path, revision_id)
375
if response[0][0] not in ['ok', 'nosuchrevision']:
376
raise errors.UnexpectedSmartServerResponse(response[0])
377
if response[0][0] == 'ok':
378
coded = response[1].read_body_bytes()
380
# no revisions in this repository!
382
lines = coded.split('\n')
385
d = tuple(line.split())
386
revision_graph[d[0]] = d[1:]
388
return revision_graph
390
response_body = response[1].read_body_bytes()
391
assert response_body == ''
392
raise NoSuchRevision(self, revision_id)
394
def has_revision(self, revision_id):
395
"""See Repository.has_revision()."""
396
if revision_id == NULL_REVISION:
397
# The null revision is always present.
399
path = self.bzrdir._path_for_remote_call(self._client)
400
response = self._client.call('Repository.has_revision', path, revision_id)
401
assert response[0] in ('yes', 'no'), 'unexpected response code %s' % (response,)
402
return response[0] == 'yes'
404
def has_revisions(self, revision_ids):
405
"""See Repository.has_revisions()."""
407
for revision_id in revision_ids:
408
if self.has_revision(revision_id):
409
result.add(revision_id)
412
def has_same_location(self, other):
413
return (self.__class__ == other.__class__ and
414
self.bzrdir.transport.base == other.bzrdir.transport.base)
416
def get_graph(self, other_repository=None):
417
"""Return the graph for this repository format"""
418
parents_provider = self
419
if (other_repository is not None and
420
other_repository.bzrdir.transport.base !=
421
self.bzrdir.transport.base):
422
parents_provider = graph._StackedParentsProvider(
423
[parents_provider, other_repository._make_parents_provider()])
424
return graph.Graph(parents_provider)
426
def gather_stats(self, revid=None, committers=None):
427
"""See Repository.gather_stats()."""
428
path = self.bzrdir._path_for_remote_call(self._client)
429
# revid can be None to indicate no revisions, not just NULL_REVISION
430
if revid is None or revision.is_null(revid):
434
if committers is None or not committers:
435
fmt_committers = 'no'
437
fmt_committers = 'yes'
438
response = self._client.call_expecting_body(
439
'Repository.gather_stats', path, fmt_revid, fmt_committers)
440
assert response[0][0] == 'ok', \
441
'unexpected response code %s' % (response[0],)
443
body = response[1].read_body_bytes()
445
for line in body.split('\n'):
448
key, val_text = line.split(':')
449
if key in ('revisions', 'size', 'committers'):
450
result[key] = int(val_text)
451
elif key in ('firstrev', 'latestrev'):
452
values = val_text.split(' ')[1:]
453
result[key] = (float(values[0]), long(values[1]))
457
def find_branches(self, using=False):
458
"""See Repository.find_branches()."""
459
# should be an API call to the server.
461
return self._real_repository.find_branches(using=using)
463
def get_physical_lock_status(self):
464
"""See Repository.get_physical_lock_status()."""
465
# should be an API call to the server.
467
return self._real_repository.get_physical_lock_status()
469
def is_in_write_group(self):
470
"""Return True if there is an open write group.
472
write groups are only applicable locally for the smart server..
474
if self._real_repository:
475
return self._real_repository.is_in_write_group()
478
return self._lock_count >= 1
481
"""See Repository.is_shared()."""
482
path = self.bzrdir._path_for_remote_call(self._client)
483
response = self._client.call('Repository.is_shared', path)
484
assert response[0] in ('yes', 'no'), 'unexpected response code %s' % (response,)
485
return response[0] == 'yes'
487
def is_write_locked(self):
488
return self._lock_mode == 'w'
491
# wrong eventually - want a local lock cache context
492
if not self._lock_mode:
493
self._lock_mode = 'r'
495
self._parents_map = {}
496
if 'hpss' in debug.debug_flags:
497
self._requested_parents = set()
498
if self._real_repository is not None:
499
self._real_repository.lock_read()
501
self._lock_count += 1
503
def _remote_lock_write(self, token):
504
path = self.bzrdir._path_for_remote_call(self._client)
507
response = self._client.call('Repository.lock_write', path, token)
508
if response[0] == 'ok':
511
elif response[0] == 'LockContention':
512
raise errors.LockContention('(remote lock)')
513
elif response[0] == 'UnlockableTransport':
514
raise errors.UnlockableTransport(self.bzrdir.root_transport)
515
elif response[0] == 'LockFailed':
516
raise errors.LockFailed(response[1], response[2])
518
raise errors.UnexpectedSmartServerResponse(response)
520
def lock_write(self, token=None):
521
if not self._lock_mode:
522
self._lock_token = self._remote_lock_write(token)
523
# if self._lock_token is None, then this is something like packs or
524
# svn where we don't get to lock the repo, or a weave style repository
525
# where we cannot lock it over the wire and attempts to do so will
527
if self._real_repository is not None:
528
self._real_repository.lock_write(token=self._lock_token)
529
if token is not None:
530
self._leave_lock = True
532
self._leave_lock = False
533
self._lock_mode = 'w'
535
self._parents_map = {}
536
if 'hpss' in debug.debug_flags:
537
self._requested_parents = set()
538
elif self._lock_mode == 'r':
539
raise errors.ReadOnlyError(self)
541
self._lock_count += 1
542
return self._lock_token or None
544
def leave_lock_in_place(self):
545
if not self._lock_token:
546
raise NotImplementedError(self.leave_lock_in_place)
547
self._leave_lock = True
549
def dont_leave_lock_in_place(self):
550
if not self._lock_token:
551
raise NotImplementedError(self.dont_leave_lock_in_place)
552
self._leave_lock = False
554
def _set_real_repository(self, repository):
555
"""Set the _real_repository for this repository.
557
:param repository: The repository to fallback to for non-hpss
558
implemented operations.
560
assert not isinstance(repository, RemoteRepository)
561
self._real_repository = repository
562
if self._lock_mode == 'w':
563
# if we are already locked, the real repository must be able to
564
# acquire the lock with our token.
565
self._real_repository.lock_write(self._lock_token)
566
elif self._lock_mode == 'r':
567
self._real_repository.lock_read()
569
def start_write_group(self):
570
"""Start a write group on the decorated repository.
572
Smart methods peform operations in a single step so this api
573
is not really applicable except as a compatibility thunk
574
for older plugins that don't use e.g. the CommitBuilder
578
return self._real_repository.start_write_group()
580
def _unlock(self, token):
581
path = self.bzrdir._path_for_remote_call(self._client)
583
# with no token the remote repository is not persistently locked.
585
response = self._client.call('Repository.unlock', path, token)
586
if response == ('ok',):
588
elif response[0] == 'TokenMismatch':
589
raise errors.TokenMismatch(token, '(remote token)')
591
raise errors.UnexpectedSmartServerResponse(response)
594
self._lock_count -= 1
595
if self._lock_count > 0:
597
self._parents_map = None
598
if 'hpss' in debug.debug_flags:
599
self._requested_parents = None
600
old_mode = self._lock_mode
601
self._lock_mode = None
603
# The real repository is responsible at present for raising an
604
# exception if it's in an unfinished write group. However, it
605
# normally will *not* actually remove the lock from disk - that's
606
# done by the server on receiving the Repository.unlock call.
607
# This is just to let the _real_repository stay up to date.
608
if self._real_repository is not None:
609
self._real_repository.unlock()
611
# The rpc-level lock should be released even if there was a
612
# problem releasing the vfs-based lock.
614
# Only write-locked repositories need to make a remote method
615
# call to perfom the unlock.
616
old_token = self._lock_token
617
self._lock_token = None
618
if not self._leave_lock:
619
self._unlock(old_token)
621
def break_lock(self):
622
# should hand off to the network
624
return self._real_repository.break_lock()
626
def _get_tarball(self, compression):
627
"""Return a TemporaryFile containing a repository tarball.
629
Returns None if the server does not support sending tarballs.
632
path = self.bzrdir._path_for_remote_call(self._client)
633
response, protocol = self._client.call_expecting_body(
634
'Repository.tarball', path, compression)
635
if response[0] == 'ok':
636
# Extract the tarball and return it
637
t = tempfile.NamedTemporaryFile()
638
# TODO: rpc layer should read directly into it...
639
t.write(protocol.read_body_bytes())
642
if (response == ('error', "Generic bzr smart protocol error: "
643
"bad request 'Repository.tarball'") or
644
response == ('error', "Generic bzr smart protocol error: "
645
"bad request u'Repository.tarball'")):
646
protocol.cancel_read_body()
648
raise errors.UnexpectedSmartServerResponse(response)
650
def sprout(self, to_bzrdir, revision_id=None):
651
# TODO: Option to control what format is created?
653
dest_repo = self._real_repository._format.initialize(to_bzrdir,
655
dest_repo.fetch(self, revision_id=revision_id)
658
### These methods are just thin shims to the VFS object for now.
660
def revision_tree(self, revision_id):
662
return self._real_repository.revision_tree(revision_id)
664
def get_serializer_format(self):
666
return self._real_repository.get_serializer_format()
668
def get_commit_builder(self, branch, parents, config, timestamp=None,
669
timezone=None, committer=None, revprops=None,
671
# FIXME: It ought to be possible to call this without immediately
672
# triggering _ensure_real. For now it's the easiest thing to do.
674
builder = self._real_repository.get_commit_builder(branch, parents,
675
config, timestamp=timestamp, timezone=timezone,
676
committer=committer, revprops=revprops, revision_id=revision_id)
679
def add_inventory(self, revid, inv, parents):
681
return self._real_repository.add_inventory(revid, inv, parents)
683
def add_revision(self, rev_id, rev, inv=None, config=None):
685
return self._real_repository.add_revision(
686
rev_id, rev, inv=inv, config=config)
689
def get_inventory(self, revision_id):
691
return self._real_repository.get_inventory(revision_id)
693
def iter_inventories(self, revision_ids):
695
return self._real_repository.iter_inventories(revision_ids)
698
def get_revision(self, revision_id):
700
return self._real_repository.get_revision(revision_id)
703
def weave_store(self):
705
return self._real_repository.weave_store
707
def get_transaction(self):
709
return self._real_repository.get_transaction()
712
def clone(self, a_bzrdir, revision_id=None):
714
return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
716
def make_working_trees(self):
717
"""RemoteRepositories never create working trees by default."""
720
def revision_ids_to_search_result(self, result_set):
721
"""Convert a set of revision ids to a graph SearchResult."""
722
result_parents = set()
723
for parents in self.get_graph().get_parent_map(
724
result_set).itervalues():
725
result_parents.update(parents)
726
included_keys = result_set.intersection(result_parents)
727
start_keys = result_set.difference(included_keys)
728
exclude_keys = result_parents.difference(result_set)
729
result = graph.SearchResult(start_keys, exclude_keys,
730
len(result_set), result_set)
734
def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
735
"""Return the revision ids that other has that this does not.
737
These are returned in topological order.
739
revision_id: only return revision ids included by revision_id.
741
return repository.InterRepository.get(
742
other, self).search_missing_revision_ids(revision_id, find_ghosts)
744
def fetch(self, source, revision_id=None, pb=None):
745
if self.has_same_location(source):
746
# check that last_revision is in 'from' and then return a
748
if (revision_id is not None and
749
not revision.is_null(revision_id)):
750
self.get_revision(revision_id)
753
return self._real_repository.fetch(
754
source, revision_id=revision_id, pb=pb)
756
def create_bundle(self, target, base, fileobj, format=None):
758
self._real_repository.create_bundle(target, base, fileobj, format)
761
def control_weaves(self):
763
return self._real_repository.control_weaves
766
def get_ancestry(self, revision_id, topo_sorted=True):
768
return self._real_repository.get_ancestry(revision_id, topo_sorted)
771
def get_inventory_weave(self):
773
return self._real_repository.get_inventory_weave()
775
def fileids_altered_by_revision_ids(self, revision_ids):
777
return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
779
def _get_versioned_file_checker(self, revisions, revision_versions_cache):
781
return self._real_repository._get_versioned_file_checker(
782
revisions, revision_versions_cache)
784
def iter_files_bytes(self, desired_files):
785
"""See Repository.iter_file_bytes.
788
return self._real_repository.iter_files_bytes(desired_files)
790
def get_parent_map(self, keys):
791
"""See bzrlib.Graph.get_parent_map()."""
792
# Hack to build up the caching logic.
793
ancestry = self._parents_map
795
# Repository is not locked, so there's no cache.
796
missing_revisions = set(keys)
799
missing_revisions = set(key for key in keys if key not in ancestry)
800
if missing_revisions:
801
parent_map = self._get_parent_map(missing_revisions)
802
if 'hpss' in debug.debug_flags:
803
mutter('retransmitted revisions: %d of %d',
804
len(set(ancestry).intersection(parent_map)),
806
ancestry.update(parent_map)
807
present_keys = [k for k in keys if k in ancestry]
808
if 'hpss' in debug.debug_flags:
809
self._requested_parents.update(present_keys)
810
mutter('Current RemoteRepository graph hit rate: %d%%',
811
100.0 * len(self._requested_parents) / len(ancestry))
812
return dict((k, ancestry[k]) for k in present_keys)
814
def _response_is_unknown_method(self, response, verb):
815
"""Return True if response is an unknonwn method response to verb.
817
:param response: The response from a smart client call_expecting_body
819
:param verb: The verb used in that call.
820
:return: True if an unknown method was encountered.
822
# This might live better on
823
# bzrlib.smart.protocol.SmartClientRequestProtocolOne
824
if (response[0] == ('error', "Generic bzr smart protocol error: "
825
"bad request '%s'" % verb) or
826
response[0] == ('error', "Generic bzr smart protocol error: "
827
"bad request u'%s'" % verb)):
828
response[1].cancel_read_body()
832
def _get_parent_map(self, keys):
833
"""Helper for get_parent_map that performs the RPC."""
834
medium = self._client.get_smart_medium()
835
if not medium._remote_is_at_least_1_2:
836
# We already found out that the server can't understand
837
# Repository.get_parent_map requests, so just fetch the whole
839
return self.get_revision_graph()
842
if NULL_REVISION in keys:
843
keys.discard(NULL_REVISION)
844
found_parents = {NULL_REVISION:()}
849
# TODO(Needs analysis): We could assume that the keys being requested
850
# from get_parent_map are in a breadth first search, so typically they
851
# will all be depth N from some common parent, and we don't have to
852
# have the server iterate from the root parent, but rather from the
853
# keys we're searching; and just tell the server the keyspace we
854
# already have; but this may be more traffic again.
856
# Transform self._parents_map into a search request recipe.
857
# TODO: Manage this incrementally to avoid covering the same path
858
# repeatedly. (The server will have to on each request, but the less
859
# work done the better).
860
parents_map = self._parents_map
861
if parents_map is None:
862
# Repository is not locked, so there's no cache.
864
start_set = set(parents_map)
865
result_parents = set()
866
for parents in parents_map.itervalues():
867
result_parents.update(parents)
868
stop_keys = result_parents.difference(start_set)
869
included_keys = start_set.intersection(result_parents)
870
start_set.difference_update(included_keys)
871
recipe = (start_set, stop_keys, len(parents_map))
872
body = self._serialise_search_recipe(recipe)
873
path = self.bzrdir._path_for_remote_call(self._client)
875
assert type(key) is str
876
verb = 'Repository.get_parent_map'
877
args = (path,) + tuple(keys)
878
response = self._client.call_with_body_bytes_expecting_body(
879
verb, args, self._serialise_search_recipe(recipe))
880
if self._response_is_unknown_method(response, verb):
881
# Server does not support this method, so get the whole graph.
882
# Worse, we have to force a disconnection, because the server now
883
# doesn't realise it has a body on the wire to consume, so the
884
# only way to recover is to abandon the connection.
886
'Server is too old for fast get_parent_map, reconnecting. '
887
'(Upgrade the server to Bazaar 1.2 to avoid this)')
889
# To avoid having to disconnect repeatedly, we keep track of the
890
# fact the server doesn't understand remote methods added in 1.2.
891
medium._remote_is_at_least_1_2 = False
892
return self.get_revision_graph()
893
elif response[0][0] not in ['ok']:
894
reponse[1].cancel_read_body()
895
raise errors.UnexpectedSmartServerResponse(response[0])
896
if response[0][0] == 'ok':
897
coded = bz2.decompress(response[1].read_body_bytes())
901
lines = coded.split('\n')
904
d = tuple(line.split())
906
revision_graph[d[0]] = d[1:]
908
# No parents - so give the Graph result (NULL_REVISION,).
909
revision_graph[d[0]] = (NULL_REVISION,)
910
return revision_graph
913
def get_signature_text(self, revision_id):
915
return self._real_repository.get_signature_text(revision_id)
918
@symbol_versioning.deprecated_method(symbol_versioning.one_three)
919
def get_revision_graph_with_ghosts(self, revision_ids=None):
921
return self._real_repository.get_revision_graph_with_ghosts(
922
revision_ids=revision_ids)
925
def get_inventory_xml(self, revision_id):
927
return self._real_repository.get_inventory_xml(revision_id)
929
def deserialise_inventory(self, revision_id, xml):
931
return self._real_repository.deserialise_inventory(revision_id, xml)
933
def reconcile(self, other=None, thorough=False):
935
return self._real_repository.reconcile(other=other, thorough=thorough)
937
def all_revision_ids(self):
939
return self._real_repository.all_revision_ids()
942
def get_deltas_for_revisions(self, revisions):
944
return self._real_repository.get_deltas_for_revisions(revisions)
947
def get_revision_delta(self, revision_id):
949
return self._real_repository.get_revision_delta(revision_id)
952
def revision_trees(self, revision_ids):
954
return self._real_repository.revision_trees(revision_ids)
957
def get_revision_reconcile(self, revision_id):
959
return self._real_repository.get_revision_reconcile(revision_id)
962
def check(self, revision_ids=None):
964
return self._real_repository.check(revision_ids=revision_ids)
966
def copy_content_into(self, destination, revision_id=None):
968
return self._real_repository.copy_content_into(
969
destination, revision_id=revision_id)
971
def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
972
# get a tarball of the remote repository, and copy from that into the
974
from bzrlib import osutils
977
# TODO: Maybe a progress bar while streaming the tarball?
978
note("Copying repository content as tarball...")
979
tar_file = self._get_tarball('bz2')
982
destination = to_bzrdir.create_repository()
984
tar = tarfile.open('repository', fileobj=tar_file,
986
tmpdir = tempfile.mkdtemp()
988
_extract_tar(tar, tmpdir)
989
tmp_bzrdir = BzrDir.open(tmpdir)
990
tmp_repo = tmp_bzrdir.open_repository()
991
tmp_repo.copy_content_into(destination, revision_id)
993
osutils.rmtree(tmpdir)
997
# TODO: Suggestion from john: using external tar is much faster than
998
# python's tarfile library, but it may not work on windows.
1002
"""Compress the data within the repository.
1004
This is not currently implemented within the smart server.
1007
return self._real_repository.pack()
1009
def set_make_working_trees(self, new_value):
1010
raise NotImplementedError(self.set_make_working_trees)
1013
def sign_revision(self, revision_id, gpg_strategy):
1015
return self._real_repository.sign_revision(revision_id, gpg_strategy)
1018
def get_revisions(self, revision_ids):
1020
return self._real_repository.get_revisions(revision_ids)
1022
def supports_rich_root(self):
1024
return self._real_repository.supports_rich_root()
1026
def iter_reverse_revision_history(self, revision_id):
1028
return self._real_repository.iter_reverse_revision_history(revision_id)
1031
def _serializer(self):
1033
return self._real_repository._serializer
1035
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1037
return self._real_repository.store_revision_signature(
1038
gpg_strategy, plaintext, revision_id)
1040
def add_signature_text(self, revision_id, signature):
1042
return self._real_repository.add_signature_text(revision_id, signature)
1044
def has_signature_for_revision_id(self, revision_id):
1046
return self._real_repository.has_signature_for_revision_id(revision_id)
1048
def get_data_stream_for_search(self, search):
1049
medium = self._client.get_smart_medium()
1050
if not medium._remote_is_at_least_1_2:
1052
return self._real_repository.get_data_stream_for_search(search)
1053
REQUEST_NAME = 'Repository.stream_revisions_chunked'
1054
path = self.bzrdir._path_for_remote_call(self._client)
1055
body = self._serialise_search_recipe(search.get_recipe())
1056
response, protocol = self._client.call_with_body_bytes_expecting_body(
1057
REQUEST_NAME, (path,), body)
1059
if self._response_is_unknown_method((response, protocol), REQUEST_NAME):
1060
# Server does not support this method, so fall back to VFS.
1061
# Worse, we have to force a disconnection, because the server now
1062
# doesn't realise it has a body on the wire to consume, so the
1063
# only way to recover is to abandon the connection.
1065
'Server is too old for streaming pull, reconnecting. '
1066
'(Upgrade the server to Bazaar 1.2 to avoid this)')
1068
# To avoid having to disconnect repeatedly, we keep track of the
1069
# fact the server doesn't understand this remote method.
1070
medium._remote_is_at_least_1_2 = False
1072
return self._real_repository.get_data_stream_for_search(search)
1074
if response == ('ok',):
1075
return self._deserialise_stream(protocol)
1076
if response == ('NoSuchRevision', ):
1077
# We cannot easily identify the revision that is missing in this
1078
# situation without doing much more network IO. For now, bail.
1079
raise NoSuchRevision(self, "unknown")
1081
raise errors.UnexpectedSmartServerResponse(response)
1083
def _deserialise_stream(self, protocol):
1084
stream = protocol.read_streamed_body()
1085
container_parser = ContainerPushParser()
1086
for bytes in stream:
1087
container_parser.accept_bytes(bytes)
1088
records = container_parser.read_pending_records()
1089
for record_names, record_bytes in records:
1090
if len(record_names) != 1:
1091
# These records should have only one name, and that name
1092
# should be a one-element tuple.
1093
raise errors.SmartProtocolError(
1094
'Repository data stream had invalid record name %r'
1096
name_tuple = record_names[0]
1097
yield name_tuple, record_bytes
1099
def insert_data_stream(self, stream):
1101
self._real_repository.insert_data_stream(stream)
1103
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
1105
return self._real_repository.item_keys_introduced_by(revision_ids,
1106
_files_pb=_files_pb)
1108
def revision_graph_can_have_wrong_parents(self):
1109
# The answer depends on the remote repo format.
1111
return self._real_repository.revision_graph_can_have_wrong_parents()
1113
def _find_inconsistent_revision_parents(self):
1115
return self._real_repository._find_inconsistent_revision_parents()
1117
def _check_for_inconsistent_revision_parents(self):
1119
return self._real_repository._check_for_inconsistent_revision_parents()
1121
def _make_parents_provider(self):
1124
def _serialise_search_recipe(self, recipe):
1125
"""Serialise a graph search recipe.
1127
:param recipe: A search recipe (start, stop, count).
1128
:return: Serialised bytes.
1130
start_keys = ' '.join(recipe[0])
1131
stop_keys = ' '.join(recipe[1])
1132
count = str(recipe[2])
1133
return '\n'.join((start_keys, stop_keys, count))
1136
class RemoteBranchLockableFiles(LockableFiles):
1137
"""A 'LockableFiles' implementation that talks to a smart server.
1139
This is not a public interface class.
1142
def __init__(self, bzrdir, _client):
1143
self.bzrdir = bzrdir
1144
self._client = _client
1145
self._need_find_modes = True
1146
LockableFiles.__init__(
1147
self, bzrdir.get_branch_transport(None),
1148
'lock', lockdir.LockDir)
1150
def _find_modes(self):
1151
# RemoteBranches don't let the client set the mode of control files.
1152
self._dir_mode = None
1153
self._file_mode = None
1155
def get(self, path):
1156
"""'get' a remote path as per the LockableFiles interface.
1158
:param path: the file to 'get'. If this is 'branch.conf', we do not
1159
just retrieve a file, instead we ask the smart server to generate
1160
a configuration for us - which is retrieved as an INI file.
1162
if path == 'branch.conf':
1163
path = self.bzrdir._path_for_remote_call(self._client)
1164
response = self._client.call_expecting_body(
1165
'Branch.get_config_file', path)
1166
assert response[0][0] == 'ok', \
1167
'unexpected response code %s' % (response[0],)
1168
return StringIO(response[1].read_body_bytes())
1171
return LockableFiles.get(self, path)
1174
class RemoteBranchFormat(branch.BranchFormat):
1176
def __eq__(self, other):
1177
return (isinstance(other, RemoteBranchFormat) and
1178
self.__dict__ == other.__dict__)
1180
def get_format_description(self):
1181
return 'Remote BZR Branch'
1183
def get_format_string(self):
1184
return 'Remote BZR Branch'
1186
def open(self, a_bzrdir):
1187
assert isinstance(a_bzrdir, RemoteBzrDir)
1188
return a_bzrdir.open_branch()
1190
def initialize(self, a_bzrdir):
1191
assert isinstance(a_bzrdir, RemoteBzrDir)
1192
return a_bzrdir.create_branch()
1194
def supports_tags(self):
1195
# Remote branches might support tags, but we won't know until we
1196
# access the real remote branch.
1200
class RemoteBranch(branch.Branch):
1201
"""Branch stored on a server accessed by HPSS RPC.
1203
At the moment most operations are mapped down to simple file operations.
1206
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
1208
"""Create a RemoteBranch instance.
1210
:param real_branch: An optional local implementation of the branch
1211
format, usually accessing the data via the VFS.
1212
:param _client: Private parameter for testing.
1214
# We intentionally don't call the parent class's __init__, because it
1215
# will try to assign to self.tags, which is a property in this subclass.
1216
# And the parent's __init__ doesn't do much anyway.
1217
self._revision_id_to_revno_cache = None
1218
self._revision_history_cache = None
1219
self.bzrdir = remote_bzrdir
1220
if _client is not None:
1221
self._client = _client
1223
self._client = client._SmartClient(self.bzrdir._shared_medium)
1224
self.repository = remote_repository
1225
if real_branch is not None:
1226
self._real_branch = real_branch
1227
# Give the remote repository the matching real repo.
1228
real_repo = self._real_branch.repository
1229
if isinstance(real_repo, RemoteRepository):
1230
real_repo._ensure_real()
1231
real_repo = real_repo._real_repository
1232
self.repository._set_real_repository(real_repo)
1233
# Give the branch the remote repository to let fast-pathing happen.
1234
self._real_branch.repository = self.repository
1236
self._real_branch = None
1237
# Fill out expected attributes of branch for bzrlib api users.
1238
self._format = RemoteBranchFormat()
1239
self.base = self.bzrdir.root_transport.base
1240
self._control_files = None
1241
self._lock_mode = None
1242
self._lock_token = None
1243
self._lock_count = 0
1244
self._leave_lock = False
1247
return "%s(%s)" % (self.__class__.__name__, self.base)
1251
def _ensure_real(self):
1252
"""Ensure that there is a _real_branch set.
1254
Used before calls to self._real_branch.
1256
if not self._real_branch:
1257
assert vfs.vfs_enabled()
1258
self.bzrdir._ensure_real()
1259
self._real_branch = self.bzrdir._real_bzrdir.open_branch()
1260
# Give the remote repository the matching real repo.
1261
real_repo = self._real_branch.repository
1262
if isinstance(real_repo, RemoteRepository):
1263
real_repo._ensure_real()
1264
real_repo = real_repo._real_repository
1265
self.repository._set_real_repository(real_repo)
1266
# Give the branch the remote repository to let fast-pathing happen.
1267
self._real_branch.repository = self.repository
1268
# XXX: deal with _lock_mode == 'w'
1269
if self._lock_mode == 'r':
1270
self._real_branch.lock_read()
1273
def control_files(self):
1274
# Defer actually creating RemoteBranchLockableFiles until its needed,
1275
# because it triggers an _ensure_real that we otherwise might not need.
1276
if self._control_files is None:
1277
self._control_files = RemoteBranchLockableFiles(
1278
self.bzrdir, self._client)
1279
return self._control_files
1281
def _get_checkout_format(self):
1283
return self._real_branch._get_checkout_format()
1285
def get_physical_lock_status(self):
1286
"""See Branch.get_physical_lock_status()."""
1287
# should be an API call to the server, as branches must be lockable.
1289
return self._real_branch.get_physical_lock_status()
1291
def lock_read(self):
1292
if not self._lock_mode:
1293
self._lock_mode = 'r'
1294
self._lock_count = 1
1295
if self._real_branch is not None:
1296
self._real_branch.lock_read()
1298
self._lock_count += 1
1300
def _remote_lock_write(self, token):
1302
branch_token = repo_token = ''
1304
branch_token = token
1305
repo_token = self.repository.lock_write()
1306
self.repository.unlock()
1307
path = self.bzrdir._path_for_remote_call(self._client)
1308
response = self._client.call('Branch.lock_write', path, branch_token,
1310
if response[0] == 'ok':
1311
ok, branch_token, repo_token = response
1312
return branch_token, repo_token
1313
elif response[0] == 'LockContention':
1314
raise errors.LockContention('(remote lock)')
1315
elif response[0] == 'TokenMismatch':
1316
raise errors.TokenMismatch(token, '(remote token)')
1317
elif response[0] == 'UnlockableTransport':
1318
raise errors.UnlockableTransport(self.bzrdir.root_transport)
1319
elif response[0] == 'ReadOnlyError':
1320
raise errors.ReadOnlyError(self)
1321
elif response[0] == 'LockFailed':
1322
raise errors.LockFailed(response[1], response[2])
1324
raise errors.UnexpectedSmartServerResponse(response)
1326
def lock_write(self, token=None):
1327
if not self._lock_mode:
1328
remote_tokens = self._remote_lock_write(token)
1329
self._lock_token, self._repo_lock_token = remote_tokens
1330
assert self._lock_token, 'Remote server did not return a token!'
1331
# TODO: We really, really, really don't want to call _ensure_real
1332
# here, but it's the easiest way to ensure coherency between the
1333
# state of the RemoteBranch and RemoteRepository objects and the
1334
# physical locks. If we don't materialise the real objects here,
1335
# then getting everything in the right state later is complex, so
1336
# for now we just do it the lazy way.
1337
# -- Andrew Bennetts, 2007-02-22.
1339
if self._real_branch is not None:
1340
self._real_branch.repository.lock_write(
1341
token=self._repo_lock_token)
1343
self._real_branch.lock_write(token=self._lock_token)
1345
self._real_branch.repository.unlock()
1346
if token is not None:
1347
self._leave_lock = True
1349
# XXX: this case seems to be unreachable; token cannot be None.
1350
self._leave_lock = False
1351
self._lock_mode = 'w'
1352
self._lock_count = 1
1353
elif self._lock_mode == 'r':
1354
raise errors.ReadOnlyTransaction
1356
if token is not None:
1357
# A token was given to lock_write, and we're relocking, so check
1358
# that the given token actually matches the one we already have.
1359
if token != self._lock_token:
1360
raise errors.TokenMismatch(token, self._lock_token)
1361
self._lock_count += 1
1362
return self._lock_token or None
1364
def _unlock(self, branch_token, repo_token):
1365
path = self.bzrdir._path_for_remote_call(self._client)
1366
response = self._client.call('Branch.unlock', path, branch_token,
1368
if response == ('ok',):
1370
elif response[0] == 'TokenMismatch':
1371
raise errors.TokenMismatch(
1372
str((branch_token, repo_token)), '(remote tokens)')
1374
raise errors.UnexpectedSmartServerResponse(response)
1377
self._lock_count -= 1
1378
if not self._lock_count:
1379
self._clear_cached_state()
1380
mode = self._lock_mode
1381
self._lock_mode = None
1382
if self._real_branch is not None:
1383
if (not self._leave_lock and mode == 'w' and
1384
self._repo_lock_token):
1385
# If this RemoteBranch will remove the physical lock for the
1386
# repository, make sure the _real_branch doesn't do it
1387
# first. (Because the _real_branch's repository is set to
1388
# be the RemoteRepository.)
1389
self._real_branch.repository.leave_lock_in_place()
1390
self._real_branch.unlock()
1392
# Only write-locked branched need to make a remote method call
1393
# to perfom the unlock.
1395
assert self._lock_token, 'Locked, but no token!'
1396
branch_token = self._lock_token
1397
repo_token = self._repo_lock_token
1398
self._lock_token = None
1399
self._repo_lock_token = None
1400
if not self._leave_lock:
1401
self._unlock(branch_token, repo_token)
1403
def break_lock(self):
1405
return self._real_branch.break_lock()
1407
def leave_lock_in_place(self):
1408
if not self._lock_token:
1409
raise NotImplementedError(self.leave_lock_in_place)
1410
self._leave_lock = True
1412
def dont_leave_lock_in_place(self):
1413
if not self._lock_token:
1414
raise NotImplementedError(self.dont_leave_lock_in_place)
1415
self._leave_lock = False
1417
def last_revision_info(self):
1418
"""See Branch.last_revision_info()."""
1419
path = self.bzrdir._path_for_remote_call(self._client)
1420
response = self._client.call('Branch.last_revision_info', path)
1421
assert response[0] == 'ok', 'unexpected response code %s' % (response,)
1422
revno = int(response[1])
1423
last_revision = response[2]
1424
return (revno, last_revision)
1426
def _gen_revision_history(self):
1427
"""See Branch._gen_revision_history()."""
1428
path = self.bzrdir._path_for_remote_call(self._client)
1429
response = self._client.call_expecting_body(
1430
'Branch.revision_history', path)
1431
assert response[0][0] == 'ok', ('unexpected response code %s'
1433
result = response[1].read_body_bytes().split('\x00')
1439
def set_revision_history(self, rev_history):
1440
# Send just the tip revision of the history; the server will generate
1441
# the full history from that. If the revision doesn't exist in this
1442
# branch, NoSuchRevision will be raised.
1443
path = self.bzrdir._path_for_remote_call(self._client)
1444
if rev_history == []:
1447
rev_id = rev_history[-1]
1448
self._clear_cached_state()
1449
response = self._client.call('Branch.set_last_revision',
1450
path, self._lock_token, self._repo_lock_token, rev_id)
1451
if response[0] == 'NoSuchRevision':
1452
raise NoSuchRevision(self, rev_id)
1454
assert response == ('ok',), (
1455
'unexpected response code %r' % (response,))
1456
self._cache_revision_history(rev_history)
1458
def get_parent(self):
1460
return self._real_branch.get_parent()
1462
def set_parent(self, url):
1464
return self._real_branch.set_parent(url)
1466
def get_config(self):
1467
return RemoteBranchConfig(self)
1469
def sprout(self, to_bzrdir, revision_id=None):
1470
# Like Branch.sprout, except that it sprouts a branch in the default
1471
# format, because RemoteBranches can't be created at arbitrary URLs.
1472
# XXX: if to_bzrdir is a RemoteBranch, this should perhaps do
1473
# to_bzrdir.create_branch...
1475
result = self._real_branch._format.initialize(to_bzrdir)
1476
self.copy_content_into(result, revision_id=revision_id)
1477
result.set_parent(self.bzrdir.root_transport.base)
1481
def pull(self, source, overwrite=False, stop_revision=None,
1483
# FIXME: This asks the real branch to run the hooks, which means
1484
# they're called with the wrong target branch parameter.
1485
# The test suite specifically allows this at present but it should be
1486
# fixed. It should get a _override_hook_target branch,
1487
# as push does. -- mbp 20070405
1489
self._real_branch.pull(
1490
source, overwrite=overwrite, stop_revision=stop_revision,
1494
def push(self, target, overwrite=False, stop_revision=None):
1496
return self._real_branch.push(
1497
target, overwrite=overwrite, stop_revision=stop_revision,
1498
_override_hook_source_branch=self)
1500
def is_locked(self):
1501
return self._lock_count >= 1
1503
def set_last_revision_info(self, revno, revision_id):
1505
self._clear_cached_state()
1506
return self._real_branch.set_last_revision_info(revno, revision_id)
1508
def generate_revision_history(self, revision_id, last_rev=None,
1511
return self._real_branch.generate_revision_history(
1512
revision_id, last_rev=last_rev, other_branch=other_branch)
1517
return self._real_branch.tags
1519
def set_push_location(self, location):
1521
return self._real_branch.set_push_location(location)
1523
def update_revisions(self, other, stop_revision=None, overwrite=False):
1525
return self._real_branch.update_revisions(
1526
other, stop_revision=stop_revision, overwrite=overwrite)
1529
class RemoteBranchConfig(BranchConfig):
1532
self.branch._ensure_real()
1533
return self.branch._real_branch.get_config().username()
1535
def _get_branch_data_config(self):
1536
self.branch._ensure_real()
1537
if self._branch_data_config is None:
1538
self._branch_data_config = TreeConfig(self.branch._real_branch)
1539
return self._branch_data_config
1542
def _extract_tar(tar, to_dir):
1543
"""Extract all the contents of a tarfile object.
1545
A replacement for extractall, which is not present in python2.4
1548
tar.extract(tarinfo, to_dir)
added
removed
bzrlib/remote.py
