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
@symbol_versioning.deprecated_method(symbol_versioning.one_four)
365
def get_revision_graph(self, revision_id=None):
366
"""See Repository.get_revision_graph()."""
367
return self._get_revision_graph(revision_id)
369
def _get_revision_graph(self, revision_id):
370
"""Private method for using with old (< 1.2) servers to fallback."""
371
if revision_id is None:
373
elif revision.is_null(revision_id):
376
path = self.bzrdir._path_for_remote_call(self._client)
377
assert type(revision_id) is str
378
response = self._client.call_expecting_body(
379
'Repository.get_revision_graph', path, revision_id)
380
if response[0][0] not in ['ok', 'nosuchrevision']:
381
raise errors.UnexpectedSmartServerResponse(response[0])
382
if response[0][0] == 'ok':
383
coded = response[1].read_body_bytes()
385
# no revisions in this repository!
387
lines = coded.split('\n')
390
d = tuple(line.split())
391
revision_graph[d[0]] = d[1:]
393
return revision_graph
395
response_body = response[1].read_body_bytes()
396
assert response_body == ''
397
raise NoSuchRevision(self, revision_id)
399
def has_revision(self, revision_id):
400
"""See Repository.has_revision()."""
401
if revision_id == NULL_REVISION:
402
# The null revision is always present.
404
path = self.bzrdir._path_for_remote_call(self._client)
405
response = self._client.call('Repository.has_revision', path, revision_id)
406
assert response[0] in ('yes', 'no'), 'unexpected response code %s' % (response,)
407
return response[0] == 'yes'
409
def has_revisions(self, revision_ids):
410
"""See Repository.has_revisions()."""
412
for revision_id in revision_ids:
413
if self.has_revision(revision_id):
414
result.add(revision_id)
417
def has_same_location(self, other):
418
return (self.__class__ == other.__class__ and
419
self.bzrdir.transport.base == other.bzrdir.transport.base)
421
def get_graph(self, other_repository=None):
422
"""Return the graph for this repository format"""
423
parents_provider = self
424
if (other_repository is not None and
425
other_repository.bzrdir.transport.base !=
426
self.bzrdir.transport.base):
427
parents_provider = graph._StackedParentsProvider(
428
[parents_provider, other_repository._make_parents_provider()])
429
return graph.Graph(parents_provider)
431
def gather_stats(self, revid=None, committers=None):
432
"""See Repository.gather_stats()."""
433
path = self.bzrdir._path_for_remote_call(self._client)
434
# revid can be None to indicate no revisions, not just NULL_REVISION
435
if revid is None or revision.is_null(revid):
439
if committers is None or not committers:
440
fmt_committers = 'no'
442
fmt_committers = 'yes'
443
response = self._client.call_expecting_body(
444
'Repository.gather_stats', path, fmt_revid, fmt_committers)
445
assert response[0][0] == 'ok', \
446
'unexpected response code %s' % (response[0],)
448
body = response[1].read_body_bytes()
450
for line in body.split('\n'):
453
key, val_text = line.split(':')
454
if key in ('revisions', 'size', 'committers'):
455
result[key] = int(val_text)
456
elif key in ('firstrev', 'latestrev'):
457
values = val_text.split(' ')[1:]
458
result[key] = (float(values[0]), long(values[1]))
462
def find_branches(self, using=False):
463
"""See Repository.find_branches()."""
464
# should be an API call to the server.
466
return self._real_repository.find_branches(using=using)
468
def get_physical_lock_status(self):
469
"""See Repository.get_physical_lock_status()."""
470
# should be an API call to the server.
472
return self._real_repository.get_physical_lock_status()
474
def is_in_write_group(self):
475
"""Return True if there is an open write group.
477
write groups are only applicable locally for the smart server..
479
if self._real_repository:
480
return self._real_repository.is_in_write_group()
483
return self._lock_count >= 1
486
"""See Repository.is_shared()."""
487
path = self.bzrdir._path_for_remote_call(self._client)
488
response = self._client.call('Repository.is_shared', path)
489
assert response[0] in ('yes', 'no'), 'unexpected response code %s' % (response,)
490
return response[0] == 'yes'
492
def is_write_locked(self):
493
return self._lock_mode == 'w'
496
# wrong eventually - want a local lock cache context
497
if not self._lock_mode:
498
self._lock_mode = 'r'
500
self._parents_map = {}
501
if 'hpss' in debug.debug_flags:
502
self._requested_parents = set()
503
if self._real_repository is not None:
504
self._real_repository.lock_read()
506
self._lock_count += 1
508
def _remote_lock_write(self, token):
509
path = self.bzrdir._path_for_remote_call(self._client)
512
response = self._client.call('Repository.lock_write', path, token)
513
if response[0] == 'ok':
516
elif response[0] == 'LockContention':
517
raise errors.LockContention('(remote lock)')
518
elif response[0] == 'UnlockableTransport':
519
raise errors.UnlockableTransport(self.bzrdir.root_transport)
520
elif response[0] == 'LockFailed':
521
raise errors.LockFailed(response[1], response[2])
523
raise errors.UnexpectedSmartServerResponse(response)
525
def lock_write(self, token=None):
526
if not self._lock_mode:
527
self._lock_token = self._remote_lock_write(token)
528
# if self._lock_token is None, then this is something like packs or
529
# svn where we don't get to lock the repo, or a weave style repository
530
# where we cannot lock it over the wire and attempts to do so will
532
if self._real_repository is not None:
533
self._real_repository.lock_write(token=self._lock_token)
534
if token is not None:
535
self._leave_lock = True
537
self._leave_lock = False
538
self._lock_mode = 'w'
540
self._parents_map = {}
541
if 'hpss' in debug.debug_flags:
542
self._requested_parents = set()
543
elif self._lock_mode == 'r':
544
raise errors.ReadOnlyError(self)
546
self._lock_count += 1
547
return self._lock_token or None
549
def leave_lock_in_place(self):
550
if not self._lock_token:
551
raise NotImplementedError(self.leave_lock_in_place)
552
self._leave_lock = True
554
def dont_leave_lock_in_place(self):
555
if not self._lock_token:
556
raise NotImplementedError(self.dont_leave_lock_in_place)
557
self._leave_lock = False
559
def _set_real_repository(self, repository):
560
"""Set the _real_repository for this repository.
562
:param repository: The repository to fallback to for non-hpss
563
implemented operations.
565
assert not isinstance(repository, RemoteRepository)
566
self._real_repository = repository
567
if self._lock_mode == 'w':
568
# if we are already locked, the real repository must be able to
569
# acquire the lock with our token.
570
self._real_repository.lock_write(self._lock_token)
571
elif self._lock_mode == 'r':
572
self._real_repository.lock_read()
574
def start_write_group(self):
575
"""Start a write group on the decorated repository.
577
Smart methods peform operations in a single step so this api
578
is not really applicable except as a compatibility thunk
579
for older plugins that don't use e.g. the CommitBuilder
583
return self._real_repository.start_write_group()
585
def _unlock(self, token):
586
path = self.bzrdir._path_for_remote_call(self._client)
588
# with no token the remote repository is not persistently locked.
590
response = self._client.call('Repository.unlock', path, token)
591
if response == ('ok',):
593
elif response[0] == 'TokenMismatch':
594
raise errors.TokenMismatch(token, '(remote token)')
596
raise errors.UnexpectedSmartServerResponse(response)
599
self._lock_count -= 1
600
if self._lock_count > 0:
602
self._parents_map = None
603
if 'hpss' in debug.debug_flags:
604
self._requested_parents = None
605
old_mode = self._lock_mode
606
self._lock_mode = None
608
# The real repository is responsible at present for raising an
609
# exception if it's in an unfinished write group. However, it
610
# normally will *not* actually remove the lock from disk - that's
611
# done by the server on receiving the Repository.unlock call.
612
# This is just to let the _real_repository stay up to date.
613
if self._real_repository is not None:
614
self._real_repository.unlock()
616
# The rpc-level lock should be released even if there was a
617
# problem releasing the vfs-based lock.
619
# Only write-locked repositories need to make a remote method
620
# call to perfom the unlock.
621
old_token = self._lock_token
622
self._lock_token = None
623
if not self._leave_lock:
624
self._unlock(old_token)
626
def break_lock(self):
627
# should hand off to the network
629
return self._real_repository.break_lock()
631
def _get_tarball(self, compression):
632
"""Return a TemporaryFile containing a repository tarball.
634
Returns None if the server does not support sending tarballs.
637
path = self.bzrdir._path_for_remote_call(self._client)
638
response, protocol = self._client.call_expecting_body(
639
'Repository.tarball', path, compression)
640
if response[0] == 'ok':
641
# Extract the tarball and return it
642
t = tempfile.NamedTemporaryFile()
643
# TODO: rpc layer should read directly into it...
644
t.write(protocol.read_body_bytes())
647
if (response == ('error', "Generic bzr smart protocol error: "
648
"bad request 'Repository.tarball'") or
649
response == ('error', "Generic bzr smart protocol error: "
650
"bad request u'Repository.tarball'")):
651
protocol.cancel_read_body()
653
raise errors.UnexpectedSmartServerResponse(response)
655
def sprout(self, to_bzrdir, revision_id=None):
656
# TODO: Option to control what format is created?
658
dest_repo = self._real_repository._format.initialize(to_bzrdir,
660
dest_repo.fetch(self, revision_id=revision_id)
663
### These methods are just thin shims to the VFS object for now.
665
def revision_tree(self, revision_id):
667
return self._real_repository.revision_tree(revision_id)
669
def get_serializer_format(self):
671
return self._real_repository.get_serializer_format()
673
def get_commit_builder(self, branch, parents, config, timestamp=None,
674
timezone=None, committer=None, revprops=None,
676
# FIXME: It ought to be possible to call this without immediately
677
# triggering _ensure_real. For now it's the easiest thing to do.
679
builder = self._real_repository.get_commit_builder(branch, parents,
680
config, timestamp=timestamp, timezone=timezone,
681
committer=committer, revprops=revprops, revision_id=revision_id)
684
def add_inventory(self, revid, inv, parents):
686
return self._real_repository.add_inventory(revid, inv, parents)
688
def add_revision(self, rev_id, rev, inv=None, config=None):
690
return self._real_repository.add_revision(
691
rev_id, rev, inv=inv, config=config)
694
def get_inventory(self, revision_id):
696
return self._real_repository.get_inventory(revision_id)
698
def iter_inventories(self, revision_ids):
700
return self._real_repository.iter_inventories(revision_ids)
703
def get_revision(self, revision_id):
705
return self._real_repository.get_revision(revision_id)
708
def weave_store(self):
710
return self._real_repository.weave_store
712
def get_transaction(self):
714
return self._real_repository.get_transaction()
717
def clone(self, a_bzrdir, revision_id=None):
719
return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
721
def make_working_trees(self):
722
"""RemoteRepositories never create working trees by default."""
725
def revision_ids_to_search_result(self, result_set):
726
"""Convert a set of revision ids to a graph SearchResult."""
727
result_parents = set()
728
for parents in self.get_graph().get_parent_map(
729
result_set).itervalues():
730
result_parents.update(parents)
731
included_keys = result_set.intersection(result_parents)
732
start_keys = result_set.difference(included_keys)
733
exclude_keys = result_parents.difference(result_set)
734
result = graph.SearchResult(start_keys, exclude_keys,
735
len(result_set), result_set)
739
def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
740
"""Return the revision ids that other has that this does not.
742
These are returned in topological order.
744
revision_id: only return revision ids included by revision_id.
746
return repository.InterRepository.get(
747
other, self).search_missing_revision_ids(revision_id, find_ghosts)
749
def fetch(self, source, revision_id=None, pb=None):
750
if self.has_same_location(source):
751
# check that last_revision is in 'from' and then return a
753
if (revision_id is not None and
754
not revision.is_null(revision_id)):
755
self.get_revision(revision_id)
758
return self._real_repository.fetch(
759
source, revision_id=revision_id, pb=pb)
761
def create_bundle(self, target, base, fileobj, format=None):
763
self._real_repository.create_bundle(target, base, fileobj, format)
766
def control_weaves(self):
768
return self._real_repository.control_weaves
771
def get_ancestry(self, revision_id, topo_sorted=True):
773
return self._real_repository.get_ancestry(revision_id, topo_sorted)
776
def get_inventory_weave(self):
778
return self._real_repository.get_inventory_weave()
780
def fileids_altered_by_revision_ids(self, revision_ids):
782
return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
784
def _get_versioned_file_checker(self, revisions, revision_versions_cache):
786
return self._real_repository._get_versioned_file_checker(
787
revisions, revision_versions_cache)
789
def iter_files_bytes(self, desired_files):
790
"""See Repository.iter_file_bytes.
793
return self._real_repository.iter_files_bytes(desired_files)
795
def get_parent_map(self, keys):
796
"""See bzrlib.Graph.get_parent_map()."""
797
# Hack to build up the caching logic.
798
ancestry = self._parents_map
800
# Repository is not locked, so there's no cache.
801
missing_revisions = set(keys)
804
missing_revisions = set(key for key in keys if key not in ancestry)
805
if missing_revisions:
806
parent_map = self._get_parent_map(missing_revisions)
807
if 'hpss' in debug.debug_flags:
808
mutter('retransmitted revisions: %d of %d',
809
len(set(ancestry).intersection(parent_map)),
811
ancestry.update(parent_map)
812
present_keys = [k for k in keys if k in ancestry]
813
if 'hpss' in debug.debug_flags:
814
self._requested_parents.update(present_keys)
815
mutter('Current RemoteRepository graph hit rate: %d%%',
816
100.0 * len(self._requested_parents) / len(ancestry))
817
return dict((k, ancestry[k]) for k in present_keys)
819
def _response_is_unknown_method(self, response, verb):
820
"""Return True if response is an unknonwn method response to verb.
822
:param response: The response from a smart client call_expecting_body
824
:param verb: The verb used in that call.
825
:return: True if an unknown method was encountered.
827
# This might live better on
828
# bzrlib.smart.protocol.SmartClientRequestProtocolOne
829
if (response[0] == ('error', "Generic bzr smart protocol error: "
830
"bad request '%s'" % verb) or
831
response[0] == ('error', "Generic bzr smart protocol error: "
832
"bad request u'%s'" % verb)):
833
response[1].cancel_read_body()
837
def _get_parent_map(self, keys):
838
"""Helper for get_parent_map that performs the RPC."""
839
medium = self._client.get_smart_medium()
840
if not medium._remote_is_at_least_1_2:
841
# We already found out that the server can't understand
842
# Repository.get_parent_map requests, so just fetch the whole
844
# XXX: Note that this will issue a deprecation warning. This is ok
845
# :- its because we're working with a deprecated server anyway, and
846
# the user will almost certainly have seen a warning about the
847
# server version already.
848
return self.get_revision_graph()
851
if NULL_REVISION in keys:
852
keys.discard(NULL_REVISION)
853
found_parents = {NULL_REVISION:()}
858
# TODO(Needs analysis): We could assume that the keys being requested
859
# from get_parent_map are in a breadth first search, so typically they
860
# will all be depth N from some common parent, and we don't have to
861
# have the server iterate from the root parent, but rather from the
862
# keys we're searching; and just tell the server the keyspace we
863
# already have; but this may be more traffic again.
865
# Transform self._parents_map into a search request recipe.
866
# TODO: Manage this incrementally to avoid covering the same path
867
# repeatedly. (The server will have to on each request, but the less
868
# work done the better).
869
parents_map = self._parents_map
870
if parents_map is None:
871
# Repository is not locked, so there's no cache.
873
start_set = set(parents_map)
874
result_parents = set()
875
for parents in parents_map.itervalues():
876
result_parents.update(parents)
877
stop_keys = result_parents.difference(start_set)
878
included_keys = start_set.intersection(result_parents)
879
start_set.difference_update(included_keys)
880
recipe = (start_set, stop_keys, len(parents_map))
881
body = self._serialise_search_recipe(recipe)
882
path = self.bzrdir._path_for_remote_call(self._client)
884
assert type(key) is str
885
verb = 'Repository.get_parent_map'
886
args = (path,) + tuple(keys)
887
response = self._client.call_with_body_bytes_expecting_body(
888
verb, args, self._serialise_search_recipe(recipe))
889
if self._response_is_unknown_method(response, verb):
890
# Server does not support this method, so get the whole graph.
891
# Worse, we have to force a disconnection, because the server now
892
# doesn't realise it has a body on the wire to consume, so the
893
# only way to recover is to abandon the connection.
895
'Server is too old for fast get_parent_map, reconnecting. '
896
'(Upgrade the server to Bazaar 1.2 to avoid this)')
898
# To avoid having to disconnect repeatedly, we keep track of the
899
# fact the server doesn't understand remote methods added in 1.2.
900
medium._remote_is_at_least_1_2 = False
901
return self._get_revision_graph(None)
902
elif response[0][0] not in ['ok']:
903
reponse[1].cancel_read_body()
904
raise errors.UnexpectedSmartServerResponse(response[0])
905
if response[0][0] == 'ok':
906
coded = bz2.decompress(response[1].read_body_bytes())
910
lines = coded.split('\n')
913
d = tuple(line.split())
915
revision_graph[d[0]] = d[1:]
917
# No parents - so give the Graph result (NULL_REVISION,).
918
revision_graph[d[0]] = (NULL_REVISION,)
919
return revision_graph
922
def get_signature_text(self, revision_id):
924
return self._real_repository.get_signature_text(revision_id)
927
@symbol_versioning.deprecated_method(symbol_versioning.one_three)
928
def get_revision_graph_with_ghosts(self, revision_ids=None):
930
return self._real_repository.get_revision_graph_with_ghosts(
931
revision_ids=revision_ids)
934
def get_inventory_xml(self, revision_id):
936
return self._real_repository.get_inventory_xml(revision_id)
938
def deserialise_inventory(self, revision_id, xml):
940
return self._real_repository.deserialise_inventory(revision_id, xml)
942
def reconcile(self, other=None, thorough=False):
944
return self._real_repository.reconcile(other=other, thorough=thorough)
946
def all_revision_ids(self):
948
return self._real_repository.all_revision_ids()
951
def get_deltas_for_revisions(self, revisions):
953
return self._real_repository.get_deltas_for_revisions(revisions)
956
def get_revision_delta(self, revision_id):
958
return self._real_repository.get_revision_delta(revision_id)
961
def revision_trees(self, revision_ids):
963
return self._real_repository.revision_trees(revision_ids)
966
def get_revision_reconcile(self, revision_id):
968
return self._real_repository.get_revision_reconcile(revision_id)
971
def check(self, revision_ids=None):
973
return self._real_repository.check(revision_ids=revision_ids)
975
def copy_content_into(self, destination, revision_id=None):
977
return self._real_repository.copy_content_into(
978
destination, revision_id=revision_id)
980
def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
981
# get a tarball of the remote repository, and copy from that into the
983
from bzrlib import osutils
986
# TODO: Maybe a progress bar while streaming the tarball?
987
note("Copying repository content as tarball...")
988
tar_file = self._get_tarball('bz2')
991
destination = to_bzrdir.create_repository()
993
tar = tarfile.open('repository', fileobj=tar_file,
995
tmpdir = tempfile.mkdtemp()
997
_extract_tar(tar, tmpdir)
998
tmp_bzrdir = BzrDir.open(tmpdir)
999
tmp_repo = tmp_bzrdir.open_repository()
1000
tmp_repo.copy_content_into(destination, revision_id)
1002
osutils.rmtree(tmpdir)
1006
# TODO: Suggestion from john: using external tar is much faster than
1007
# python's tarfile library, but it may not work on windows.
1011
"""Compress the data within the repository.
1013
This is not currently implemented within the smart server.
1016
return self._real_repository.pack()
1018
def set_make_working_trees(self, new_value):
1019
raise NotImplementedError(self.set_make_working_trees)
1022
def sign_revision(self, revision_id, gpg_strategy):
1024
return self._real_repository.sign_revision(revision_id, gpg_strategy)
1027
def get_revisions(self, revision_ids):
1029
return self._real_repository.get_revisions(revision_ids)
1031
def supports_rich_root(self):
1033
return self._real_repository.supports_rich_root()
1035
def iter_reverse_revision_history(self, revision_id):
1037
return self._real_repository.iter_reverse_revision_history(revision_id)
1040
def _serializer(self):
1042
return self._real_repository._serializer
1044
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1046
return self._real_repository.store_revision_signature(
1047
gpg_strategy, plaintext, revision_id)
1049
def add_signature_text(self, revision_id, signature):
1051
return self._real_repository.add_signature_text(revision_id, signature)
1053
def has_signature_for_revision_id(self, revision_id):
1055
return self._real_repository.has_signature_for_revision_id(revision_id)
1057
def get_data_stream_for_search(self, search):
1058
medium = self._client.get_smart_medium()
1059
if not medium._remote_is_at_least_1_2:
1061
return self._real_repository.get_data_stream_for_search(search)
1062
REQUEST_NAME = 'Repository.stream_revisions_chunked'
1063
path = self.bzrdir._path_for_remote_call(self._client)
1064
body = self._serialise_search_recipe(search.get_recipe())
1065
response, protocol = self._client.call_with_body_bytes_expecting_body(
1066
REQUEST_NAME, (path,), body)
1068
if self._response_is_unknown_method((response, protocol), REQUEST_NAME):
1069
# Server does not support this method, so fall back to VFS.
1070
# Worse, we have to force a disconnection, because the server now
1071
# doesn't realise it has a body on the wire to consume, so the
1072
# only way to recover is to abandon the connection.
1074
'Server is too old for streaming pull, reconnecting. '
1075
'(Upgrade the server to Bazaar 1.2 to avoid this)')
1077
# To avoid having to disconnect repeatedly, we keep track of the
1078
# fact the server doesn't understand this remote method.
1079
medium._remote_is_at_least_1_2 = False
1081
return self._real_repository.get_data_stream_for_search(search)
1083
if response == ('ok',):
1084
return self._deserialise_stream(protocol)
1085
if response == ('NoSuchRevision', ):
1086
# We cannot easily identify the revision that is missing in this
1087
# situation without doing much more network IO. For now, bail.
1088
raise NoSuchRevision(self, "unknown")
1090
raise errors.UnexpectedSmartServerResponse(response)
1092
def _deserialise_stream(self, protocol):
1093
stream = protocol.read_streamed_body()
1094
container_parser = ContainerPushParser()
1095
for bytes in stream:
1096
container_parser.accept_bytes(bytes)
1097
records = container_parser.read_pending_records()
1098
for record_names, record_bytes in records:
1099
if len(record_names) != 1:
1100
# These records should have only one name, and that name
1101
# should be a one-element tuple.
1102
raise errors.SmartProtocolError(
1103
'Repository data stream had invalid record name %r'
1105
name_tuple = record_names[0]
1106
yield name_tuple, record_bytes
1108
def insert_data_stream(self, stream):
1110
self._real_repository.insert_data_stream(stream)
1112
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
1114
return self._real_repository.item_keys_introduced_by(revision_ids,
1115
_files_pb=_files_pb)
1117
def revision_graph_can_have_wrong_parents(self):
1118
# The answer depends on the remote repo format.
1120
return self._real_repository.revision_graph_can_have_wrong_parents()
1122
def _find_inconsistent_revision_parents(self):
1124
return self._real_repository._find_inconsistent_revision_parents()
1126
def _check_for_inconsistent_revision_parents(self):
1128
return self._real_repository._check_for_inconsistent_revision_parents()
1130
def _make_parents_provider(self):
1133
def _serialise_search_recipe(self, recipe):
1134
"""Serialise a graph search recipe.
1136
:param recipe: A search recipe (start, stop, count).
1137
:return: Serialised bytes.
1139
start_keys = ' '.join(recipe[0])
1140
stop_keys = ' '.join(recipe[1])
1141
count = str(recipe[2])
1142
return '\n'.join((start_keys, stop_keys, count))
1145
class RemoteBranchLockableFiles(LockableFiles):
1146
"""A 'LockableFiles' implementation that talks to a smart server.
1148
This is not a public interface class.
1151
def __init__(self, bzrdir, _client):
1152
self.bzrdir = bzrdir
1153
self._client = _client
1154
self._need_find_modes = True
1155
LockableFiles.__init__(
1156
self, bzrdir.get_branch_transport(None),
1157
'lock', lockdir.LockDir)
1159
def _find_modes(self):
1160
# RemoteBranches don't let the client set the mode of control files.
1161
self._dir_mode = None
1162
self._file_mode = None
1164
def get(self, path):
1165
"""'get' a remote path as per the LockableFiles interface.
1167
:param path: the file to 'get'. If this is 'branch.conf', we do not
1168
just retrieve a file, instead we ask the smart server to generate
1169
a configuration for us - which is retrieved as an INI file.
1171
if path == 'branch.conf':
1172
path = self.bzrdir._path_for_remote_call(self._client)
1173
response = self._client.call_expecting_body(
1174
'Branch.get_config_file', path)
1175
assert response[0][0] == 'ok', \
1176
'unexpected response code %s' % (response[0],)
1177
return StringIO(response[1].read_body_bytes())
1180
return LockableFiles.get(self, path)
1183
class RemoteBranchFormat(branch.BranchFormat):
1185
def __eq__(self, other):
1186
return (isinstance(other, RemoteBranchFormat) and
1187
self.__dict__ == other.__dict__)
1189
def get_format_description(self):
1190
return 'Remote BZR Branch'
1192
def get_format_string(self):
1193
return 'Remote BZR Branch'
1195
def open(self, a_bzrdir):
1196
assert isinstance(a_bzrdir, RemoteBzrDir)
1197
return a_bzrdir.open_branch()
1199
def initialize(self, a_bzrdir):
1200
assert isinstance(a_bzrdir, RemoteBzrDir)
1201
return a_bzrdir.create_branch()
1203
def supports_tags(self):
1204
# Remote branches might support tags, but we won't know until we
1205
# access the real remote branch.
1209
class RemoteBranch(branch.Branch):
1210
"""Branch stored on a server accessed by HPSS RPC.
1212
At the moment most operations are mapped down to simple file operations.
1215
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
1217
"""Create a RemoteBranch instance.
1219
:param real_branch: An optional local implementation of the branch
1220
format, usually accessing the data via the VFS.
1221
:param _client: Private parameter for testing.
1223
# We intentionally don't call the parent class's __init__, because it
1224
# will try to assign to self.tags, which is a property in this subclass.
1225
# And the parent's __init__ doesn't do much anyway.
1226
self._revision_id_to_revno_cache = None
1227
self._revision_history_cache = None
1228
self.bzrdir = remote_bzrdir
1229
if _client is not None:
1230
self._client = _client
1232
self._client = client._SmartClient(self.bzrdir._shared_medium)
1233
self.repository = remote_repository
1234
if real_branch is not None:
1235
self._real_branch = real_branch
1236
# Give the remote repository the matching real repo.
1237
real_repo = self._real_branch.repository
1238
if isinstance(real_repo, RemoteRepository):
1239
real_repo._ensure_real()
1240
real_repo = real_repo._real_repository
1241
self.repository._set_real_repository(real_repo)
1242
# Give the branch the remote repository to let fast-pathing happen.
1243
self._real_branch.repository = self.repository
1245
self._real_branch = None
1246
# Fill out expected attributes of branch for bzrlib api users.
1247
self._format = RemoteBranchFormat()
1248
self.base = self.bzrdir.root_transport.base
1249
self._control_files = None
1250
self._lock_mode = None
1251
self._lock_token = None
1252
self._lock_count = 0
1253
self._leave_lock = False
1256
return "%s(%s)" % (self.__class__.__name__, self.base)
1260
def _ensure_real(self):
1261
"""Ensure that there is a _real_branch set.
1263
Used before calls to self._real_branch.
1265
if not self._real_branch:
1266
assert vfs.vfs_enabled()
1267
self.bzrdir._ensure_real()
1268
self._real_branch = self.bzrdir._real_bzrdir.open_branch()
1269
# Give the remote repository the matching real repo.
1270
real_repo = self._real_branch.repository
1271
if isinstance(real_repo, RemoteRepository):
1272
real_repo._ensure_real()
1273
real_repo = real_repo._real_repository
1274
self.repository._set_real_repository(real_repo)
1275
# Give the branch the remote repository to let fast-pathing happen.
1276
self._real_branch.repository = self.repository
1277
# XXX: deal with _lock_mode == 'w'
1278
if self._lock_mode == 'r':
1279
self._real_branch.lock_read()
1282
def control_files(self):
1283
# Defer actually creating RemoteBranchLockableFiles until its needed,
1284
# because it triggers an _ensure_real that we otherwise might not need.
1285
if self._control_files is None:
1286
self._control_files = RemoteBranchLockableFiles(
1287
self.bzrdir, self._client)
1288
return self._control_files
1290
def _get_checkout_format(self):
1292
return self._real_branch._get_checkout_format()
1294
def get_physical_lock_status(self):
1295
"""See Branch.get_physical_lock_status()."""
1296
# should be an API call to the server, as branches must be lockable.
1298
return self._real_branch.get_physical_lock_status()
1300
def lock_read(self):
1301
if not self._lock_mode:
1302
self._lock_mode = 'r'
1303
self._lock_count = 1
1304
if self._real_branch is not None:
1305
self._real_branch.lock_read()
1307
self._lock_count += 1
1309
def _remote_lock_write(self, token):
1311
branch_token = repo_token = ''
1313
branch_token = token
1314
repo_token = self.repository.lock_write()
1315
self.repository.unlock()
1316
path = self.bzrdir._path_for_remote_call(self._client)
1317
response = self._client.call('Branch.lock_write', path, branch_token,
1319
if response[0] == 'ok':
1320
ok, branch_token, repo_token = response
1321
return branch_token, repo_token
1322
elif response[0] == 'LockContention':
1323
raise errors.LockContention('(remote lock)')
1324
elif response[0] == 'TokenMismatch':
1325
raise errors.TokenMismatch(token, '(remote token)')
1326
elif response[0] == 'UnlockableTransport':
1327
raise errors.UnlockableTransport(self.bzrdir.root_transport)
1328
elif response[0] == 'ReadOnlyError':
1329
raise errors.ReadOnlyError(self)
1330
elif response[0] == 'LockFailed':
1331
raise errors.LockFailed(response[1], response[2])
1333
raise errors.UnexpectedSmartServerResponse(response)
1335
def lock_write(self, token=None):
1336
if not self._lock_mode:
1337
remote_tokens = self._remote_lock_write(token)
1338
self._lock_token, self._repo_lock_token = remote_tokens
1339
assert self._lock_token, 'Remote server did not return a token!'
1340
# TODO: We really, really, really don't want to call _ensure_real
1341
# here, but it's the easiest way to ensure coherency between the
1342
# state of the RemoteBranch and RemoteRepository objects and the
1343
# physical locks. If we don't materialise the real objects here,
1344
# then getting everything in the right state later is complex, so
1345
# for now we just do it the lazy way.
1346
# -- Andrew Bennetts, 2007-02-22.
1348
if self._real_branch is not None:
1349
self._real_branch.repository.lock_write(
1350
token=self._repo_lock_token)
1352
self._real_branch.lock_write(token=self._lock_token)
1354
self._real_branch.repository.unlock()
1355
if token is not None:
1356
self._leave_lock = True
1358
# XXX: this case seems to be unreachable; token cannot be None.
1359
self._leave_lock = False
1360
self._lock_mode = 'w'
1361
self._lock_count = 1
1362
elif self._lock_mode == 'r':
1363
raise errors.ReadOnlyTransaction
1365
if token is not None:
1366
# A token was given to lock_write, and we're relocking, so check
1367
# that the given token actually matches the one we already have.
1368
if token != self._lock_token:
1369
raise errors.TokenMismatch(token, self._lock_token)
1370
self._lock_count += 1
1371
return self._lock_token or None
1373
def _unlock(self, branch_token, repo_token):
1374
path = self.bzrdir._path_for_remote_call(self._client)
1375
response = self._client.call('Branch.unlock', path, branch_token,
1377
if response == ('ok',):
1379
elif response[0] == 'TokenMismatch':
1380
raise errors.TokenMismatch(
1381
str((branch_token, repo_token)), '(remote tokens)')
1383
raise errors.UnexpectedSmartServerResponse(response)
1386
self._lock_count -= 1
1387
if not self._lock_count:
1388
self._clear_cached_state()
1389
mode = self._lock_mode
1390
self._lock_mode = None
1391
if self._real_branch is not None:
1392
if (not self._leave_lock and mode == 'w' and
1393
self._repo_lock_token):
1394
# If this RemoteBranch will remove the physical lock for the
1395
# repository, make sure the _real_branch doesn't do it
1396
# first. (Because the _real_branch's repository is set to
1397
# be the RemoteRepository.)
1398
self._real_branch.repository.leave_lock_in_place()
1399
self._real_branch.unlock()
1401
# Only write-locked branched need to make a remote method call
1402
# to perfom the unlock.
1404
assert self._lock_token, 'Locked, but no token!'
1405
branch_token = self._lock_token
1406
repo_token = self._repo_lock_token
1407
self._lock_token = None
1408
self._repo_lock_token = None
1409
if not self._leave_lock:
1410
self._unlock(branch_token, repo_token)
1412
def break_lock(self):
1414
return self._real_branch.break_lock()
1416
def leave_lock_in_place(self):
1417
if not self._lock_token:
1418
raise NotImplementedError(self.leave_lock_in_place)
1419
self._leave_lock = True
1421
def dont_leave_lock_in_place(self):
1422
if not self._lock_token:
1423
raise NotImplementedError(self.dont_leave_lock_in_place)
1424
self._leave_lock = False
1426
def last_revision_info(self):
1427
"""See Branch.last_revision_info()."""
1428
path = self.bzrdir._path_for_remote_call(self._client)
1429
response = self._client.call('Branch.last_revision_info', path)
1430
assert response[0] == 'ok', 'unexpected response code %s' % (response,)
1431
revno = int(response[1])
1432
last_revision = response[2]
1433
return (revno, last_revision)
1435
def _gen_revision_history(self):
1436
"""See Branch._gen_revision_history()."""
1437
path = self.bzrdir._path_for_remote_call(self._client)
1438
response = self._client.call_expecting_body(
1439
'Branch.revision_history', path)
1440
assert response[0][0] == 'ok', ('unexpected response code %s'
1442
result = response[1].read_body_bytes().split('\x00')
1448
def set_revision_history(self, rev_history):
1449
# Send just the tip revision of the history; the server will generate
1450
# the full history from that. If the revision doesn't exist in this
1451
# branch, NoSuchRevision will be raised.
1452
path = self.bzrdir._path_for_remote_call(self._client)
1453
if rev_history == []:
1456
rev_id = rev_history[-1]
1457
self._clear_cached_state()
1458
response = self._client.call('Branch.set_last_revision',
1459
path, self._lock_token, self._repo_lock_token, rev_id)
1460
if response[0] == 'NoSuchRevision':
1461
raise NoSuchRevision(self, rev_id)
1463
assert response == ('ok',), (
1464
'unexpected response code %r' % (response,))
1465
self._cache_revision_history(rev_history)
1467
def get_parent(self):
1469
return self._real_branch.get_parent()
1471
def set_parent(self, url):
1473
return self._real_branch.set_parent(url)
1475
def get_config(self):
1476
return RemoteBranchConfig(self)
1478
def sprout(self, to_bzrdir, revision_id=None):
1479
# Like Branch.sprout, except that it sprouts a branch in the default
1480
# format, because RemoteBranches can't be created at arbitrary URLs.
1481
# XXX: if to_bzrdir is a RemoteBranch, this should perhaps do
1482
# to_bzrdir.create_branch...
1484
result = self._real_branch._format.initialize(to_bzrdir)
1485
self.copy_content_into(result, revision_id=revision_id)
1486
result.set_parent(self.bzrdir.root_transport.base)
1490
def pull(self, source, overwrite=False, stop_revision=None,
1492
# FIXME: This asks the real branch to run the hooks, which means
1493
# they're called with the wrong target branch parameter.
1494
# The test suite specifically allows this at present but it should be
1495
# fixed. It should get a _override_hook_target branch,
1496
# as push does. -- mbp 20070405
1498
self._real_branch.pull(
1499
source, overwrite=overwrite, stop_revision=stop_revision,
1503
def push(self, target, overwrite=False, stop_revision=None):
1505
return self._real_branch.push(
1506
target, overwrite=overwrite, stop_revision=stop_revision,
1507
_override_hook_source_branch=self)
1509
def is_locked(self):
1510
return self._lock_count >= 1
1512
def set_last_revision_info(self, revno, revision_id):
1514
self._clear_cached_state()
1515
return self._real_branch.set_last_revision_info(revno, revision_id)
1517
def generate_revision_history(self, revision_id, last_rev=None,
1520
return self._real_branch.generate_revision_history(
1521
revision_id, last_rev=last_rev, other_branch=other_branch)
1526
return self._real_branch.tags
1528
def set_push_location(self, location):
1530
return self._real_branch.set_push_location(location)
1532
def update_revisions(self, other, stop_revision=None, overwrite=False):
1534
return self._real_branch.update_revisions(
1535
other, stop_revision=stop_revision, overwrite=overwrite)
1538
class RemoteBranchConfig(BranchConfig):
1541
self.branch._ensure_real()
1542
return self.branch._real_branch.get_config().username()
1544
def _get_branch_data_config(self):
1545
self.branch._ensure_real()
1546
if self._branch_data_config is None:
1547
self._branch_data_config = TreeConfig(self.branch._real_branch)
1548
return self._branch_data_config
1551
def _extract_tar(tar, to_dir):
1552
"""Extract all the contents of a tarfile object.
1554
A replacement for extractall, which is not present in python2.4
1557
tar.extract(tarinfo, to_dir)
added
removed
bzrlib/remote.py
