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
if revision_id is None:
369
elif revision.is_null(revision_id):
372
path = self.bzrdir._path_for_remote_call(self._client)
373
assert type(revision_id) is str
374
response = self._client.call_expecting_body(
375
'Repository.get_revision_graph', path, revision_id)
376
if response[0][0] not in ['ok', 'nosuchrevision']:
377
raise errors.UnexpectedSmartServerResponse(response[0])
378
if response[0][0] == 'ok':
379
coded = response[1].read_body_bytes()
381
# no revisions in this repository!
383
lines = coded.split('\n')
386
d = tuple(line.split())
387
revision_graph[d[0]] = d[1:]
389
return revision_graph
391
response_body = response[1].read_body_bytes()
392
assert response_body == ''
393
raise NoSuchRevision(self, revision_id)
395
def has_revision(self, revision_id):
396
"""See Repository.has_revision()."""
397
if revision_id == NULL_REVISION:
398
# The null revision is always present.
400
path = self.bzrdir._path_for_remote_call(self._client)
401
response = self._client.call('Repository.has_revision', path, revision_id)
402
assert response[0] in ('yes', 'no'), 'unexpected response code %s' % (response,)
403
return response[0] == 'yes'
405
def has_revisions(self, revision_ids):
406
"""See Repository.has_revisions()."""
408
for revision_id in revision_ids:
409
if self.has_revision(revision_id):
410
result.add(revision_id)
413
def has_same_location(self, other):
414
return (self.__class__ == other.__class__ and
415
self.bzrdir.transport.base == other.bzrdir.transport.base)
417
def get_graph(self, other_repository=None):
418
"""Return the graph for this repository format"""
419
parents_provider = self
420
if (other_repository is not None and
421
other_repository.bzrdir.transport.base !=
422
self.bzrdir.transport.base):
423
parents_provider = graph._StackedParentsProvider(
424
[parents_provider, other_repository._make_parents_provider()])
425
return graph.Graph(parents_provider)
427
def gather_stats(self, revid=None, committers=None):
428
"""See Repository.gather_stats()."""
429
path = self.bzrdir._path_for_remote_call(self._client)
430
# revid can be None to indicate no revisions, not just NULL_REVISION
431
if revid is None or revision.is_null(revid):
435
if committers is None or not committers:
436
fmt_committers = 'no'
438
fmt_committers = 'yes'
439
response = self._client.call_expecting_body(
440
'Repository.gather_stats', path, fmt_revid, fmt_committers)
441
assert response[0][0] == 'ok', \
442
'unexpected response code %s' % (response[0],)
444
body = response[1].read_body_bytes()
446
for line in body.split('\n'):
449
key, val_text = line.split(':')
450
if key in ('revisions', 'size', 'committers'):
451
result[key] = int(val_text)
452
elif key in ('firstrev', 'latestrev'):
453
values = val_text.split(' ')[1:]
454
result[key] = (float(values[0]), long(values[1]))
458
def find_branches(self, using=False):
459
"""See Repository.find_branches()."""
460
# should be an API call to the server.
462
return self._real_repository.find_branches(using=using)
464
def get_physical_lock_status(self):
465
"""See Repository.get_physical_lock_status()."""
466
# should be an API call to the server.
468
return self._real_repository.get_physical_lock_status()
470
def is_in_write_group(self):
471
"""Return True if there is an open write group.
473
write groups are only applicable locally for the smart server..
475
if self._real_repository:
476
return self._real_repository.is_in_write_group()
479
return self._lock_count >= 1
482
"""See Repository.is_shared()."""
483
path = self.bzrdir._path_for_remote_call(self._client)
484
response = self._client.call('Repository.is_shared', path)
485
assert response[0] in ('yes', 'no'), 'unexpected response code %s' % (response,)
486
return response[0] == 'yes'
488
def is_write_locked(self):
489
return self._lock_mode == 'w'
492
# wrong eventually - want a local lock cache context
493
if not self._lock_mode:
494
self._lock_mode = 'r'
496
self._parents_map = {}
497
if 'hpss' in debug.debug_flags:
498
self._requested_parents = set()
499
if self._real_repository is not None:
500
self._real_repository.lock_read()
502
self._lock_count += 1
504
def _remote_lock_write(self, token):
505
path = self.bzrdir._path_for_remote_call(self._client)
508
response = self._client.call('Repository.lock_write', path, token)
509
if response[0] == 'ok':
512
elif response[0] == 'LockContention':
513
raise errors.LockContention('(remote lock)')
514
elif response[0] == 'UnlockableTransport':
515
raise errors.UnlockableTransport(self.bzrdir.root_transport)
516
elif response[0] == 'LockFailed':
517
raise errors.LockFailed(response[1], response[2])
519
raise errors.UnexpectedSmartServerResponse(response)
521
def lock_write(self, token=None):
522
if not self._lock_mode:
523
self._lock_token = self._remote_lock_write(token)
524
# if self._lock_token is None, then this is something like packs or
525
# svn where we don't get to lock the repo, or a weave style repository
526
# where we cannot lock it over the wire and attempts to do so will
528
if self._real_repository is not None:
529
self._real_repository.lock_write(token=self._lock_token)
530
if token is not None:
531
self._leave_lock = True
533
self._leave_lock = False
534
self._lock_mode = 'w'
536
self._parents_map = {}
537
if 'hpss' in debug.debug_flags:
538
self._requested_parents = set()
539
elif self._lock_mode == 'r':
540
raise errors.ReadOnlyError(self)
542
self._lock_count += 1
543
return self._lock_token or None
545
def leave_lock_in_place(self):
546
if not self._lock_token:
547
raise NotImplementedError(self.leave_lock_in_place)
548
self._leave_lock = True
550
def dont_leave_lock_in_place(self):
551
if not self._lock_token:
552
raise NotImplementedError(self.dont_leave_lock_in_place)
553
self._leave_lock = False
555
def _set_real_repository(self, repository):
556
"""Set the _real_repository for this repository.
558
:param repository: The repository to fallback to for non-hpss
559
implemented operations.
561
assert not isinstance(repository, RemoteRepository)
562
self._real_repository = repository
563
if self._lock_mode == 'w':
564
# if we are already locked, the real repository must be able to
565
# acquire the lock with our token.
566
self._real_repository.lock_write(self._lock_token)
567
elif self._lock_mode == 'r':
568
self._real_repository.lock_read()
570
def start_write_group(self):
571
"""Start a write group on the decorated repository.
573
Smart methods peform operations in a single step so this api
574
is not really applicable except as a compatibility thunk
575
for older plugins that don't use e.g. the CommitBuilder
579
return self._real_repository.start_write_group()
581
def _unlock(self, token):
582
path = self.bzrdir._path_for_remote_call(self._client)
584
# with no token the remote repository is not persistently locked.
586
response = self._client.call('Repository.unlock', path, token)
587
if response == ('ok',):
589
elif response[0] == 'TokenMismatch':
590
raise errors.TokenMismatch(token, '(remote token)')
592
raise errors.UnexpectedSmartServerResponse(response)
595
self._lock_count -= 1
596
if self._lock_count > 0:
598
self._parents_map = None
599
if 'hpss' in debug.debug_flags:
600
self._requested_parents = None
601
old_mode = self._lock_mode
602
self._lock_mode = None
604
# The real repository is responsible at present for raising an
605
# exception if it's in an unfinished write group. However, it
606
# normally will *not* actually remove the lock from disk - that's
607
# done by the server on receiving the Repository.unlock call.
608
# This is just to let the _real_repository stay up to date.
609
if self._real_repository is not None:
610
self._real_repository.unlock()
612
# The rpc-level lock should be released even if there was a
613
# problem releasing the vfs-based lock.
615
# Only write-locked repositories need to make a remote method
616
# call to perfom the unlock.
617
old_token = self._lock_token
618
self._lock_token = None
619
if not self._leave_lock:
620
self._unlock(old_token)
622
def break_lock(self):
623
# should hand off to the network
625
return self._real_repository.break_lock()
627
def _get_tarball(self, compression):
628
"""Return a TemporaryFile containing a repository tarball.
630
Returns None if the server does not support sending tarballs.
633
path = self.bzrdir._path_for_remote_call(self._client)
634
response, protocol = self._client.call_expecting_body(
635
'Repository.tarball', path, compression)
636
if response[0] == 'ok':
637
# Extract the tarball and return it
638
t = tempfile.NamedTemporaryFile()
639
# TODO: rpc layer should read directly into it...
640
t.write(protocol.read_body_bytes())
643
if (response == ('error', "Generic bzr smart protocol error: "
644
"bad request 'Repository.tarball'") or
645
response == ('error', "Generic bzr smart protocol error: "
646
"bad request u'Repository.tarball'")):
647
protocol.cancel_read_body()
649
raise errors.UnexpectedSmartServerResponse(response)
651
def sprout(self, to_bzrdir, revision_id=None):
652
# TODO: Option to control what format is created?
654
dest_repo = self._real_repository._format.initialize(to_bzrdir,
656
dest_repo.fetch(self, revision_id=revision_id)
659
### These methods are just thin shims to the VFS object for now.
661
def revision_tree(self, revision_id):
663
return self._real_repository.revision_tree(revision_id)
665
def get_serializer_format(self):
667
return self._real_repository.get_serializer_format()
669
def get_commit_builder(self, branch, parents, config, timestamp=None,
670
timezone=None, committer=None, revprops=None,
672
# FIXME: It ought to be possible to call this without immediately
673
# triggering _ensure_real. For now it's the easiest thing to do.
675
builder = self._real_repository.get_commit_builder(branch, parents,
676
config, timestamp=timestamp, timezone=timezone,
677
committer=committer, revprops=revprops, revision_id=revision_id)
680
def add_inventory(self, revid, inv, parents):
682
return self._real_repository.add_inventory(revid, inv, parents)
684
def add_revision(self, rev_id, rev, inv=None, config=None):
686
return self._real_repository.add_revision(
687
rev_id, rev, inv=inv, config=config)
690
def get_inventory(self, revision_id):
692
return self._real_repository.get_inventory(revision_id)
694
def iter_inventories(self, revision_ids):
696
return self._real_repository.iter_inventories(revision_ids)
699
def get_revision(self, revision_id):
701
return self._real_repository.get_revision(revision_id)
704
def weave_store(self):
706
return self._real_repository.weave_store
708
def get_transaction(self):
710
return self._real_repository.get_transaction()
713
def clone(self, a_bzrdir, revision_id=None):
715
return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
717
def make_working_trees(self):
718
"""RemoteRepositories never create working trees by default."""
721
def revision_ids_to_search_result(self, result_set):
722
"""Convert a set of revision ids to a graph SearchResult."""
723
result_parents = set()
724
for parents in self.get_graph().get_parent_map(
725
result_set).itervalues():
726
result_parents.update(parents)
727
included_keys = result_set.intersection(result_parents)
728
start_keys = result_set.difference(included_keys)
729
exclude_keys = result_parents.difference(result_set)
730
result = graph.SearchResult(start_keys, exclude_keys,
731
len(result_set), result_set)
735
def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
736
"""Return the revision ids that other has that this does not.
738
These are returned in topological order.
740
revision_id: only return revision ids included by revision_id.
742
return repository.InterRepository.get(
743
other, self).search_missing_revision_ids(revision_id, find_ghosts)
745
def fetch(self, source, revision_id=None, pb=None):
746
if self.has_same_location(source):
747
# check that last_revision is in 'from' and then return a
749
if (revision_id is not None and
750
not revision.is_null(revision_id)):
751
self.get_revision(revision_id)
754
return self._real_repository.fetch(
755
source, revision_id=revision_id, pb=pb)
757
def create_bundle(self, target, base, fileobj, format=None):
759
self._real_repository.create_bundle(target, base, fileobj, format)
762
def control_weaves(self):
764
return self._real_repository.control_weaves
767
def get_ancestry(self, revision_id, topo_sorted=True):
769
return self._real_repository.get_ancestry(revision_id, topo_sorted)
772
def get_inventory_weave(self):
774
return self._real_repository.get_inventory_weave()
776
def fileids_altered_by_revision_ids(self, revision_ids):
778
return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
780
def _get_versioned_file_checker(self, revisions, revision_versions_cache):
782
return self._real_repository._get_versioned_file_checker(
783
revisions, revision_versions_cache)
785
def iter_files_bytes(self, desired_files):
786
"""See Repository.iter_file_bytes.
789
return self._real_repository.iter_files_bytes(desired_files)
791
def get_parent_map(self, keys):
792
"""See bzrlib.Graph.get_parent_map()."""
793
# Hack to build up the caching logic.
794
ancestry = self._parents_map
796
# Repository is not locked, so there's no cache.
797
missing_revisions = set(keys)
800
missing_revisions = set(key for key in keys if key not in ancestry)
801
if missing_revisions:
802
parent_map = self._get_parent_map(missing_revisions)
803
if 'hpss' in debug.debug_flags:
804
mutter('retransmitted revisions: %d of %d',
805
len(set(ancestry).intersection(parent_map)),
807
ancestry.update(parent_map)
808
present_keys = [k for k in keys if k in ancestry]
809
if 'hpss' in debug.debug_flags:
810
self._requested_parents.update(present_keys)
811
mutter('Current RemoteRepository graph hit rate: %d%%',
812
100.0 * len(self._requested_parents) / len(ancestry))
813
return dict((k, ancestry[k]) for k in present_keys)
815
def _response_is_unknown_method(self, response, verb):
816
"""Return True if response is an unknonwn method response to verb.
818
:param response: The response from a smart client call_expecting_body
820
:param verb: The verb used in that call.
821
:return: True if an unknown method was encountered.
823
# This might live better on
824
# bzrlib.smart.protocol.SmartClientRequestProtocolOne
825
if (response[0] == ('error', "Generic bzr smart protocol error: "
826
"bad request '%s'" % verb) or
827
response[0] == ('error', "Generic bzr smart protocol error: "
828
"bad request u'%s'" % verb)):
829
response[1].cancel_read_body()
833
def _get_parent_map(self, keys):
834
"""Helper for get_parent_map that performs the RPC."""
835
medium = self._client.get_smart_medium()
836
if not medium._remote_is_at_least_1_2:
837
# We already found out that the server can't understand
838
# Repository.get_parent_map requests, so just fetch the whole
840
# XXX: Note that this will issue a deprecation warning. This is ok
841
# :- its because we're working with a deprecated server anyway, and
842
# the user will almost certainly have seen a warning about the
843
# server version already.
844
return self.get_revision_graph()
847
if NULL_REVISION in keys:
848
keys.discard(NULL_REVISION)
849
found_parents = {NULL_REVISION:()}
854
# TODO(Needs analysis): We could assume that the keys being requested
855
# from get_parent_map are in a breadth first search, so typically they
856
# will all be depth N from some common parent, and we don't have to
857
# have the server iterate from the root parent, but rather from the
858
# keys we're searching; and just tell the server the keyspace we
859
# already have; but this may be more traffic again.
861
# Transform self._parents_map into a search request recipe.
862
# TODO: Manage this incrementally to avoid covering the same path
863
# repeatedly. (The server will have to on each request, but the less
864
# work done the better).
865
parents_map = self._parents_map
866
if parents_map is None:
867
# Repository is not locked, so there's no cache.
869
start_set = set(parents_map)
870
result_parents = set()
871
for parents in parents_map.itervalues():
872
result_parents.update(parents)
873
stop_keys = result_parents.difference(start_set)
874
included_keys = start_set.intersection(result_parents)
875
start_set.difference_update(included_keys)
876
recipe = (start_set, stop_keys, len(parents_map))
877
body = self._serialise_search_recipe(recipe)
878
path = self.bzrdir._path_for_remote_call(self._client)
880
assert type(key) is str
881
verb = 'Repository.get_parent_map'
882
args = (path,) + tuple(keys)
883
response = self._client.call_with_body_bytes_expecting_body(
884
verb, args, self._serialise_search_recipe(recipe))
885
if self._response_is_unknown_method(response, verb):
886
# Server does not support this method, so get the whole graph.
887
# Worse, we have to force a disconnection, because the server now
888
# doesn't realise it has a body on the wire to consume, so the
889
# only way to recover is to abandon the connection.
891
'Server is too old for fast get_parent_map, reconnecting. '
892
'(Upgrade the server to Bazaar 1.2 to avoid this)')
894
# To avoid having to disconnect repeatedly, we keep track of the
895
# fact the server doesn't understand remote methods added in 1.2.
896
medium._remote_is_at_least_1_2 = False
897
return self.get_revision_graph()
898
elif response[0][0] not in ['ok']:
899
reponse[1].cancel_read_body()
900
raise errors.UnexpectedSmartServerResponse(response[0])
901
if response[0][0] == 'ok':
902
coded = bz2.decompress(response[1].read_body_bytes())
906
lines = coded.split('\n')
909
d = tuple(line.split())
911
revision_graph[d[0]] = d[1:]
913
# No parents - so give the Graph result (NULL_REVISION,).
914
revision_graph[d[0]] = (NULL_REVISION,)
915
return revision_graph
918
def get_signature_text(self, revision_id):
920
return self._real_repository.get_signature_text(revision_id)
923
@symbol_versioning.deprecated_method(symbol_versioning.one_three)
924
def get_revision_graph_with_ghosts(self, revision_ids=None):
926
return self._real_repository.get_revision_graph_with_ghosts(
927
revision_ids=revision_ids)
930
def get_inventory_xml(self, revision_id):
932
return self._real_repository.get_inventory_xml(revision_id)
934
def deserialise_inventory(self, revision_id, xml):
936
return self._real_repository.deserialise_inventory(revision_id, xml)
938
def reconcile(self, other=None, thorough=False):
940
return self._real_repository.reconcile(other=other, thorough=thorough)
942
def all_revision_ids(self):
944
return self._real_repository.all_revision_ids()
947
def get_deltas_for_revisions(self, revisions):
949
return self._real_repository.get_deltas_for_revisions(revisions)
952
def get_revision_delta(self, revision_id):
954
return self._real_repository.get_revision_delta(revision_id)
957
def revision_trees(self, revision_ids):
959
return self._real_repository.revision_trees(revision_ids)
962
def get_revision_reconcile(self, revision_id):
964
return self._real_repository.get_revision_reconcile(revision_id)
967
def check(self, revision_ids=None):
969
return self._real_repository.check(revision_ids=revision_ids)
971
def copy_content_into(self, destination, revision_id=None):
973
return self._real_repository.copy_content_into(
974
destination, revision_id=revision_id)
976
def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
977
# get a tarball of the remote repository, and copy from that into the
979
from bzrlib import osutils
982
# TODO: Maybe a progress bar while streaming the tarball?
983
note("Copying repository content as tarball...")
984
tar_file = self._get_tarball('bz2')
987
destination = to_bzrdir.create_repository()
989
tar = tarfile.open('repository', fileobj=tar_file,
991
tmpdir = tempfile.mkdtemp()
993
_extract_tar(tar, tmpdir)
994
tmp_bzrdir = BzrDir.open(tmpdir)
995
tmp_repo = tmp_bzrdir.open_repository()
996
tmp_repo.copy_content_into(destination, revision_id)
998
osutils.rmtree(tmpdir)
1002
# TODO: Suggestion from john: using external tar is much faster than
1003
# python's tarfile library, but it may not work on windows.
1007
"""Compress the data within the repository.
1009
This is not currently implemented within the smart server.
1012
return self._real_repository.pack()
1014
def set_make_working_trees(self, new_value):
1015
raise NotImplementedError(self.set_make_working_trees)
1018
def sign_revision(self, revision_id, gpg_strategy):
1020
return self._real_repository.sign_revision(revision_id, gpg_strategy)
1023
def get_revisions(self, revision_ids):
1025
return self._real_repository.get_revisions(revision_ids)
1027
def supports_rich_root(self):
1029
return self._real_repository.supports_rich_root()
1031
def iter_reverse_revision_history(self, revision_id):
1033
return self._real_repository.iter_reverse_revision_history(revision_id)
1036
def _serializer(self):
1038
return self._real_repository._serializer
1040
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1042
return self._real_repository.store_revision_signature(
1043
gpg_strategy, plaintext, revision_id)
1045
def add_signature_text(self, revision_id, signature):
1047
return self._real_repository.add_signature_text(revision_id, signature)
1049
def has_signature_for_revision_id(self, revision_id):
1051
return self._real_repository.has_signature_for_revision_id(revision_id)
1053
def get_data_stream_for_search(self, search):
1054
medium = self._client.get_smart_medium()
1055
if not medium._remote_is_at_least_1_2:
1057
return self._real_repository.get_data_stream_for_search(search)
1058
REQUEST_NAME = 'Repository.stream_revisions_chunked'
1059
path = self.bzrdir._path_for_remote_call(self._client)
1060
body = self._serialise_search_recipe(search.get_recipe())
1061
response, protocol = self._client.call_with_body_bytes_expecting_body(
1062
REQUEST_NAME, (path,), body)
1064
if self._response_is_unknown_method((response, protocol), REQUEST_NAME):
1065
# Server does not support this method, so fall back to VFS.
1066
# Worse, we have to force a disconnection, because the server now
1067
# doesn't realise it has a body on the wire to consume, so the
1068
# only way to recover is to abandon the connection.
1070
'Server is too old for streaming pull, reconnecting. '
1071
'(Upgrade the server to Bazaar 1.2 to avoid this)')
1073
# To avoid having to disconnect repeatedly, we keep track of the
1074
# fact the server doesn't understand this remote method.
1075
medium._remote_is_at_least_1_2 = False
1077
return self._real_repository.get_data_stream_for_search(search)
1079
if response == ('ok',):
1080
return self._deserialise_stream(protocol)
1081
if response == ('NoSuchRevision', ):
1082
# We cannot easily identify the revision that is missing in this
1083
# situation without doing much more network IO. For now, bail.
1084
raise NoSuchRevision(self, "unknown")
1086
raise errors.UnexpectedSmartServerResponse(response)
1088
def _deserialise_stream(self, protocol):
1089
stream = protocol.read_streamed_body()
1090
container_parser = ContainerPushParser()
1091
for bytes in stream:
1092
container_parser.accept_bytes(bytes)
1093
records = container_parser.read_pending_records()
1094
for record_names, record_bytes in records:
1095
if len(record_names) != 1:
1096
# These records should have only one name, and that name
1097
# should be a one-element tuple.
1098
raise errors.SmartProtocolError(
1099
'Repository data stream had invalid record name %r'
1101
name_tuple = record_names[0]
1102
yield name_tuple, record_bytes
1104
def insert_data_stream(self, stream):
1106
self._real_repository.insert_data_stream(stream)
1108
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
1110
return self._real_repository.item_keys_introduced_by(revision_ids,
1111
_files_pb=_files_pb)
1113
def revision_graph_can_have_wrong_parents(self):
1114
# The answer depends on the remote repo format.
1116
return self._real_repository.revision_graph_can_have_wrong_parents()
1118
def _find_inconsistent_revision_parents(self):
1120
return self._real_repository._find_inconsistent_revision_parents()
1122
def _check_for_inconsistent_revision_parents(self):
1124
return self._real_repository._check_for_inconsistent_revision_parents()
1126
def _make_parents_provider(self):
1129
def _serialise_search_recipe(self, recipe):
1130
"""Serialise a graph search recipe.
1132
:param recipe: A search recipe (start, stop, count).
1133
:return: Serialised bytes.
1135
start_keys = ' '.join(recipe[0])
1136
stop_keys = ' '.join(recipe[1])
1137
count = str(recipe[2])
1138
return '\n'.join((start_keys, stop_keys, count))
1141
class RemoteBranchLockableFiles(LockableFiles):
1142
"""A 'LockableFiles' implementation that talks to a smart server.
1144
This is not a public interface class.
1147
def __init__(self, bzrdir, _client):
1148
self.bzrdir = bzrdir
1149
self._client = _client
1150
self._need_find_modes = True
1151
LockableFiles.__init__(
1152
self, bzrdir.get_branch_transport(None),
1153
'lock', lockdir.LockDir)
1155
def _find_modes(self):
1156
# RemoteBranches don't let the client set the mode of control files.
1157
self._dir_mode = None
1158
self._file_mode = None
1160
def get(self, path):
1161
"""'get' a remote path as per the LockableFiles interface.
1163
:param path: the file to 'get'. If this is 'branch.conf', we do not
1164
just retrieve a file, instead we ask the smart server to generate
1165
a configuration for us - which is retrieved as an INI file.
1167
if path == 'branch.conf':
1168
path = self.bzrdir._path_for_remote_call(self._client)
1169
response = self._client.call_expecting_body(
1170
'Branch.get_config_file', path)
1171
assert response[0][0] == 'ok', \
1172
'unexpected response code %s' % (response[0],)
1173
return StringIO(response[1].read_body_bytes())
1176
return LockableFiles.get(self, path)
1179
class RemoteBranchFormat(branch.BranchFormat):
1181
def __eq__(self, other):
1182
return (isinstance(other, RemoteBranchFormat) and
1183
self.__dict__ == other.__dict__)
1185
def get_format_description(self):
1186
return 'Remote BZR Branch'
1188
def get_format_string(self):
1189
return 'Remote BZR Branch'
1191
def open(self, a_bzrdir):
1192
assert isinstance(a_bzrdir, RemoteBzrDir)
1193
return a_bzrdir.open_branch()
1195
def initialize(self, a_bzrdir):
1196
assert isinstance(a_bzrdir, RemoteBzrDir)
1197
return a_bzrdir.create_branch()
1199
def supports_tags(self):
1200
# Remote branches might support tags, but we won't know until we
1201
# access the real remote branch.
1205
class RemoteBranch(branch.Branch):
1206
"""Branch stored on a server accessed by HPSS RPC.
1208
At the moment most operations are mapped down to simple file operations.
1211
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
1213
"""Create a RemoteBranch instance.
1215
:param real_branch: An optional local implementation of the branch
1216
format, usually accessing the data via the VFS.
1217
:param _client: Private parameter for testing.
1219
# We intentionally don't call the parent class's __init__, because it
1220
# will try to assign to self.tags, which is a property in this subclass.
1221
# And the parent's __init__ doesn't do much anyway.
1222
self._revision_id_to_revno_cache = None
1223
self._revision_history_cache = None
1224
self.bzrdir = remote_bzrdir
1225
if _client is not None:
1226
self._client = _client
1228
self._client = client._SmartClient(self.bzrdir._shared_medium)
1229
self.repository = remote_repository
1230
if real_branch is not None:
1231
self._real_branch = real_branch
1232
# Give the remote repository the matching real repo.
1233
real_repo = self._real_branch.repository
1234
if isinstance(real_repo, RemoteRepository):
1235
real_repo._ensure_real()
1236
real_repo = real_repo._real_repository
1237
self.repository._set_real_repository(real_repo)
1238
# Give the branch the remote repository to let fast-pathing happen.
1239
self._real_branch.repository = self.repository
1241
self._real_branch = None
1242
# Fill out expected attributes of branch for bzrlib api users.
1243
self._format = RemoteBranchFormat()
1244
self.base = self.bzrdir.root_transport.base
1245
self._control_files = None
1246
self._lock_mode = None
1247
self._lock_token = None
1248
self._lock_count = 0
1249
self._leave_lock = False
1252
return "%s(%s)" % (self.__class__.__name__, self.base)
1256
def _ensure_real(self):
1257
"""Ensure that there is a _real_branch set.
1259
Used before calls to self._real_branch.
1261
if not self._real_branch:
1262
assert vfs.vfs_enabled()
1263
self.bzrdir._ensure_real()
1264
self._real_branch = self.bzrdir._real_bzrdir.open_branch()
1265
# Give the remote repository the matching real repo.
1266
real_repo = self._real_branch.repository
1267
if isinstance(real_repo, RemoteRepository):
1268
real_repo._ensure_real()
1269
real_repo = real_repo._real_repository
1270
self.repository._set_real_repository(real_repo)
1271
# Give the branch the remote repository to let fast-pathing happen.
1272
self._real_branch.repository = self.repository
1273
# XXX: deal with _lock_mode == 'w'
1274
if self._lock_mode == 'r':
1275
self._real_branch.lock_read()
1278
def control_files(self):
1279
# Defer actually creating RemoteBranchLockableFiles until its needed,
1280
# because it triggers an _ensure_real that we otherwise might not need.
1281
if self._control_files is None:
1282
self._control_files = RemoteBranchLockableFiles(
1283
self.bzrdir, self._client)
1284
return self._control_files
1286
def _get_checkout_format(self):
1288
return self._real_branch._get_checkout_format()
1290
def get_physical_lock_status(self):
1291
"""See Branch.get_physical_lock_status()."""
1292
# should be an API call to the server, as branches must be lockable.
1294
return self._real_branch.get_physical_lock_status()
1296
def lock_read(self):
1297
if not self._lock_mode:
1298
self._lock_mode = 'r'
1299
self._lock_count = 1
1300
if self._real_branch is not None:
1301
self._real_branch.lock_read()
1303
self._lock_count += 1
1305
def _remote_lock_write(self, token):
1307
branch_token = repo_token = ''
1309
branch_token = token
1310
repo_token = self.repository.lock_write()
1311
self.repository.unlock()
1312
path = self.bzrdir._path_for_remote_call(self._client)
1313
response = self._client.call('Branch.lock_write', path, branch_token,
1315
if response[0] == 'ok':
1316
ok, branch_token, repo_token = response
1317
return branch_token, repo_token
1318
elif response[0] == 'LockContention':
1319
raise errors.LockContention('(remote lock)')
1320
elif response[0] == 'TokenMismatch':
1321
raise errors.TokenMismatch(token, '(remote token)')
1322
elif response[0] == 'UnlockableTransport':
1323
raise errors.UnlockableTransport(self.bzrdir.root_transport)
1324
elif response[0] == 'ReadOnlyError':
1325
raise errors.ReadOnlyError(self)
1326
elif response[0] == 'LockFailed':
1327
raise errors.LockFailed(response[1], response[2])
1329
raise errors.UnexpectedSmartServerResponse(response)
1331
def lock_write(self, token=None):
1332
if not self._lock_mode:
1333
remote_tokens = self._remote_lock_write(token)
1334
self._lock_token, self._repo_lock_token = remote_tokens
1335
assert self._lock_token, 'Remote server did not return a token!'
1336
# TODO: We really, really, really don't want to call _ensure_real
1337
# here, but it's the easiest way to ensure coherency between the
1338
# state of the RemoteBranch and RemoteRepository objects and the
1339
# physical locks. If we don't materialise the real objects here,
1340
# then getting everything in the right state later is complex, so
1341
# for now we just do it the lazy way.
1342
# -- Andrew Bennetts, 2007-02-22.
1344
if self._real_branch is not None:
1345
self._real_branch.repository.lock_write(
1346
token=self._repo_lock_token)
1348
self._real_branch.lock_write(token=self._lock_token)
1350
self._real_branch.repository.unlock()
1351
if token is not None:
1352
self._leave_lock = True
1354
# XXX: this case seems to be unreachable; token cannot be None.
1355
self._leave_lock = False
1356
self._lock_mode = 'w'
1357
self._lock_count = 1
1358
elif self._lock_mode == 'r':
1359
raise errors.ReadOnlyTransaction
1361
if token is not None:
1362
# A token was given to lock_write, and we're relocking, so check
1363
# that the given token actually matches the one we already have.
1364
if token != self._lock_token:
1365
raise errors.TokenMismatch(token, self._lock_token)
1366
self._lock_count += 1
1367
return self._lock_token or None
1369
def _unlock(self, branch_token, repo_token):
1370
path = self.bzrdir._path_for_remote_call(self._client)
1371
response = self._client.call('Branch.unlock', path, branch_token,
1373
if response == ('ok',):
1375
elif response[0] == 'TokenMismatch':
1376
raise errors.TokenMismatch(
1377
str((branch_token, repo_token)), '(remote tokens)')
1379
raise errors.UnexpectedSmartServerResponse(response)
1382
self._lock_count -= 1
1383
if not self._lock_count:
1384
self._clear_cached_state()
1385
mode = self._lock_mode
1386
self._lock_mode = None
1387
if self._real_branch is not None:
1388
if (not self._leave_lock and mode == 'w' and
1389
self._repo_lock_token):
1390
# If this RemoteBranch will remove the physical lock for the
1391
# repository, make sure the _real_branch doesn't do it
1392
# first. (Because the _real_branch's repository is set to
1393
# be the RemoteRepository.)
1394
self._real_branch.repository.leave_lock_in_place()
1395
self._real_branch.unlock()
1397
# Only write-locked branched need to make a remote method call
1398
# to perfom the unlock.
1400
assert self._lock_token, 'Locked, but no token!'
1401
branch_token = self._lock_token
1402
repo_token = self._repo_lock_token
1403
self._lock_token = None
1404
self._repo_lock_token = None
1405
if not self._leave_lock:
1406
self._unlock(branch_token, repo_token)
1408
def break_lock(self):
1410
return self._real_branch.break_lock()
1412
def leave_lock_in_place(self):
1413
if not self._lock_token:
1414
raise NotImplementedError(self.leave_lock_in_place)
1415
self._leave_lock = True
1417
def dont_leave_lock_in_place(self):
1418
if not self._lock_token:
1419
raise NotImplementedError(self.dont_leave_lock_in_place)
1420
self._leave_lock = False
1422
def last_revision_info(self):
1423
"""See Branch.last_revision_info()."""
1424
path = self.bzrdir._path_for_remote_call(self._client)
1425
response = self._client.call('Branch.last_revision_info', path)
1426
assert response[0] == 'ok', 'unexpected response code %s' % (response,)
1427
revno = int(response[1])
1428
last_revision = response[2]
1429
return (revno, last_revision)
1431
def _gen_revision_history(self):
1432
"""See Branch._gen_revision_history()."""
1433
path = self.bzrdir._path_for_remote_call(self._client)
1434
response = self._client.call_expecting_body(
1435
'Branch.revision_history', path)
1436
assert response[0][0] == 'ok', ('unexpected response code %s'
1438
result = response[1].read_body_bytes().split('\x00')
1444
def set_revision_history(self, rev_history):
1445
# Send just the tip revision of the history; the server will generate
1446
# the full history from that. If the revision doesn't exist in this
1447
# branch, NoSuchRevision will be raised.
1448
path = self.bzrdir._path_for_remote_call(self._client)
1449
if rev_history == []:
1452
rev_id = rev_history[-1]
1453
self._clear_cached_state()
1454
response = self._client.call('Branch.set_last_revision',
1455
path, self._lock_token, self._repo_lock_token, rev_id)
1456
if response[0] == 'NoSuchRevision':
1457
raise NoSuchRevision(self, rev_id)
1459
assert response == ('ok',), (
1460
'unexpected response code %r' % (response,))
1461
self._cache_revision_history(rev_history)
1463
def get_parent(self):
1465
return self._real_branch.get_parent()
1467
def set_parent(self, url):
1469
return self._real_branch.set_parent(url)
1471
def get_config(self):
1472
return RemoteBranchConfig(self)
1474
def sprout(self, to_bzrdir, revision_id=None):
1475
# Like Branch.sprout, except that it sprouts a branch in the default
1476
# format, because RemoteBranches can't be created at arbitrary URLs.
1477
# XXX: if to_bzrdir is a RemoteBranch, this should perhaps do
1478
# to_bzrdir.create_branch...
1480
result = self._real_branch._format.initialize(to_bzrdir)
1481
self.copy_content_into(result, revision_id=revision_id)
1482
result.set_parent(self.bzrdir.root_transport.base)
1486
def pull(self, source, overwrite=False, stop_revision=None,
1488
# FIXME: This asks the real branch to run the hooks, which means
1489
# they're called with the wrong target branch parameter.
1490
# The test suite specifically allows this at present but it should be
1491
# fixed. It should get a _override_hook_target branch,
1492
# as push does. -- mbp 20070405
1494
self._real_branch.pull(
1495
source, overwrite=overwrite, stop_revision=stop_revision,
1499
def push(self, target, overwrite=False, stop_revision=None):
1501
return self._real_branch.push(
1502
target, overwrite=overwrite, stop_revision=stop_revision,
1503
_override_hook_source_branch=self)
1505
def is_locked(self):
1506
return self._lock_count >= 1
1508
def set_last_revision_info(self, revno, revision_id):
1510
self._clear_cached_state()
1511
return self._real_branch.set_last_revision_info(revno, revision_id)
1513
def generate_revision_history(self, revision_id, last_rev=None,
1516
return self._real_branch.generate_revision_history(
1517
revision_id, last_rev=last_rev, other_branch=other_branch)
1522
return self._real_branch.tags
1524
def set_push_location(self, location):
1526
return self._real_branch.set_push_location(location)
1528
def update_revisions(self, other, stop_revision=None, overwrite=False):
1530
return self._real_branch.update_revisions(
1531
other, stop_revision=stop_revision, overwrite=overwrite)
1534
class RemoteBranchConfig(BranchConfig):
1537
self.branch._ensure_real()
1538
return self.branch._real_branch.get_config().username()
1540
def _get_branch_data_config(self):
1541
self.branch._ensure_real()
1542
if self._branch_data_config is None:
1543
self._branch_data_config = TreeConfig(self.branch._real_branch)
1544
return self._branch_data_config
1547
def _extract_tar(tar, to_dir):
1548
"""Extract all the contents of a tarfile object.
1550
A replacement for extractall, which is not present in python2.4
1553
tar.extract(tarinfo, to_dir)
added
removed
bzrlib/remote.py
