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
32
from bzrlib.branch import BranchReferenceFormat
33
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
34
from bzrlib.config import BranchConfig, TreeConfig
35
from bzrlib.decorators import needs_read_lock, needs_write_lock
36
from bzrlib.errors import NoSuchRevision
37
from bzrlib.lockable_files import LockableFiles
38
from bzrlib.pack import ContainerPushParser
39
from bzrlib.smart import client, vfs
40
from bzrlib.symbol_versioning import (
44
from bzrlib.revision import NULL_REVISION
45
from bzrlib.trace import mutter, note, warning
47
# Note: RemoteBzrDirFormat is in bzrdir.py
49
class RemoteBzrDir(BzrDir):
50
"""Control directory on a remote server, accessed via bzr:// or similar."""
52
def __init__(self, transport, _client=None):
53
"""Construct a RemoteBzrDir.
55
:param _client: Private parameter for testing. Disables probing and the
58
BzrDir.__init__(self, transport, RemoteBzrDirFormat())
59
# this object holds a delegated bzrdir that uses file-level operations
60
# to talk to the other side
61
self._real_bzrdir = None
64
self._shared_medium = transport.get_shared_medium()
65
self._client = client._SmartClient(self._shared_medium)
67
self._client = _client
68
self._shared_medium = None
71
path = self._path_for_remote_call(self._client)
72
response = self._client.call('BzrDir.open', path)
73
if response not in [('yes',), ('no',)]:
74
raise errors.UnexpectedSmartServerResponse(response)
75
if response == ('no',):
76
raise errors.NotBranchError(path=transport.base)
78
def _ensure_real(self):
79
"""Ensure that there is a _real_bzrdir set.
81
Used before calls to self._real_bzrdir.
83
if not self._real_bzrdir:
84
self._real_bzrdir = BzrDir.open_from_transport(
85
self.root_transport, _server_formats=False)
87
def create_repository(self, shared=False):
89
self._real_bzrdir.create_repository(shared=shared)
90
return self.open_repository()
92
def destroy_repository(self):
93
"""See BzrDir.destroy_repository"""
95
self._real_bzrdir.destroy_repository()
97
def create_branch(self):
99
real_branch = self._real_bzrdir.create_branch()
100
return RemoteBranch(self, self.find_repository(), real_branch)
102
def destroy_branch(self):
103
"""See BzrDir.destroy_branch"""
105
self._real_bzrdir.destroy_branch()
107
def create_workingtree(self, revision_id=None, from_branch=None):
108
raise errors.NotLocalUrl(self.transport.base)
110
def find_branch_format(self):
111
"""Find the branch 'format' for this bzrdir.
113
This might be a synthetic object for e.g. RemoteBranch and SVN.
115
b = self.open_branch()
118
def get_branch_reference(self):
119
"""See BzrDir.get_branch_reference()."""
120
path = self._path_for_remote_call(self._client)
121
response = self._client.call('BzrDir.open_branch', path)
122
if response[0] == 'ok':
123
if response[1] == '':
124
# branch at this location.
127
# a branch reference, use the existing BranchReference logic.
129
elif response == ('nobranch',):
130
raise errors.NotBranchError(path=self.root_transport.base)
132
raise errors.UnexpectedSmartServerResponse(response)
134
def _get_tree_branch(self):
135
"""See BzrDir._get_tree_branch()."""
136
return None, self.open_branch()
138
def open_branch(self, _unsupported=False):
139
assert _unsupported == False, 'unsupported flag support not implemented yet.'
140
reference_url = self.get_branch_reference()
141
if reference_url is None:
142
# branch at this location.
143
return RemoteBranch(self, self.find_repository())
145
# a branch reference, use the existing BranchReference logic.
146
format = BranchReferenceFormat()
147
return format.open(self, _found=True, location=reference_url)
149
def open_repository(self):
150
path = self._path_for_remote_call(self._client)
151
verb = 'BzrDir.find_repositoryV2'
152
response = self._client.call(verb, path)
153
if (response == ('error', "Generic bzr smart protocol error: "
154
"bad request '%s'" % verb) or
155
response == ('error', "Generic bzr smart protocol error: "
156
"bad request u'%s'" % verb)):
157
verb = 'BzrDir.find_repository'
158
response = self._client.call(verb, path)
159
assert response[0] in ('ok', 'norepository'), \
160
'unexpected response code %s' % (response,)
161
if response[0] == 'norepository':
162
raise errors.NoRepositoryPresent(self)
163
if verb == 'BzrDir.find_repository':
164
# servers that don't support the V2 method don't support external
166
response = response + ('no', )
167
assert len(response) == 5, 'incorrect response length %s' % (response,)
168
if response[1] == '':
169
format = RemoteRepositoryFormat()
170
format.rich_root_data = (response[2] == 'yes')
171
format.supports_tree_reference = (response[3] == 'yes')
172
# No wire format to check this yet.
173
format.supports_external_lookups = (response[4] == 'yes')
174
return RemoteRepository(self, format)
176
raise errors.NoRepositoryPresent(self)
178
def open_workingtree(self, recommend_upgrade=True):
180
if self._real_bzrdir.has_workingtree():
181
raise errors.NotLocalUrl(self.root_transport)
183
raise errors.NoWorkingTree(self.root_transport.base)
185
def _path_for_remote_call(self, client):
186
"""Return the path to be used for this bzrdir in a remote call."""
187
return client.remote_path_from_transport(self.root_transport)
189
def get_branch_transport(self, branch_format):
191
return self._real_bzrdir.get_branch_transport(branch_format)
193
def get_repository_transport(self, repository_format):
195
return self._real_bzrdir.get_repository_transport(repository_format)
197
def get_workingtree_transport(self, workingtree_format):
199
return self._real_bzrdir.get_workingtree_transport(workingtree_format)
201
def can_convert_format(self):
202
"""Upgrading of remote bzrdirs is not supported yet."""
205
def needs_format_conversion(self, format=None):
206
"""Upgrading of remote bzrdirs is not supported yet."""
209
def clone(self, url, revision_id=None, force_new_repo=False):
211
return self._real_bzrdir.clone(url, revision_id=revision_id,
212
force_new_repo=force_new_repo)
215
class RemoteRepositoryFormat(repository.RepositoryFormat):
216
"""Format for repositories accessed over a _SmartClient.
218
Instances of this repository are represented by RemoteRepository
221
The RemoteRepositoryFormat is parameterized during construction
222
to reflect the capabilities of the real, remote format. Specifically
223
the attributes rich_root_data and supports_tree_reference are set
224
on a per instance basis, and are not set (and should not be) at
228
_matchingbzrdir = RemoteBzrDirFormat
230
def initialize(self, a_bzrdir, shared=False):
231
assert isinstance(a_bzrdir, RemoteBzrDir), \
232
'%r is not a RemoteBzrDir' % (a_bzrdir,)
233
return a_bzrdir.create_repository(shared=shared)
235
def open(self, a_bzrdir):
236
assert isinstance(a_bzrdir, RemoteBzrDir)
237
return a_bzrdir.open_repository()
239
def get_format_description(self):
240
return 'bzr remote repository'
242
def __eq__(self, other):
243
return self.__class__ == other.__class__
245
def check_conversion_target(self, target_format):
246
if self.rich_root_data and not target_format.rich_root_data:
247
raise errors.BadConversionTarget(
248
'Does not support rich root data.', target_format)
249
if (self.supports_tree_reference and
250
not getattr(target_format, 'supports_tree_reference', False)):
251
raise errors.BadConversionTarget(
252
'Does not support nested trees', target_format)
255
class RemoteRepository(object):
256
"""Repository accessed over rpc.
258
For the moment most operations are performed using local transport-backed
262
def __init__(self, remote_bzrdir, format, real_repository=None, _client=None):
263
"""Create a RemoteRepository instance.
265
:param remote_bzrdir: The bzrdir hosting this repository.
266
:param format: The RemoteFormat object to use.
267
:param real_repository: If not None, a local implementation of the
268
repository logic for the repository, usually accessing the data
270
:param _client: Private testing parameter - override the smart client
271
to be used by the repository.
274
self._real_repository = real_repository
276
self._real_repository = None
277
self.bzrdir = remote_bzrdir
279
self._client = client._SmartClient(self.bzrdir._shared_medium)
281
self._client = _client
282
self._format = format
283
self._lock_mode = None
284
self._lock_token = None
286
self._leave_lock = False
287
# A cache of looked up revision parent data; reset at unlock time.
288
self._parents_map = None
289
if 'hpss' in debug.debug_flags:
290
self._requested_parents = None
292
# These depend on the actual remote format, so force them off for
293
# maximum compatibility. XXX: In future these should depend on the
294
# remote repository instance, but this is irrelevant until we perform
295
# reconcile via an RPC call.
296
self._reconcile_does_inventory_gc = False
297
self._reconcile_fixes_text_parents = False
298
self._reconcile_backsup_inventory = False
299
self.base = self.bzrdir.transport.base
300
# Can this repository be given external locations to lookup additional
302
self.supports_external_lookups = False
305
return "%s(%s)" % (self.__class__.__name__, self.base)
309
def abort_write_group(self):
310
"""Complete a write group on the decorated repository.
312
Smart methods peform operations in a single step so this api
313
is not really applicable except as a compatibility thunk
314
for older plugins that don't use e.g. the CommitBuilder
318
return self._real_repository.abort_write_group()
320
def commit_write_group(self):
321
"""Complete a write group on the decorated repository.
323
Smart methods peform operations in a single step so this api
324
is not really applicable except as a compatibility thunk
325
for older plugins that don't use e.g. the CommitBuilder
329
return self._real_repository.commit_write_group()
331
def _ensure_real(self):
332
"""Ensure that there is a _real_repository set.
334
Used before calls to self._real_repository.
336
if not self._real_repository:
337
self.bzrdir._ensure_real()
338
#self._real_repository = self.bzrdir._real_bzrdir.open_repository()
339
self._set_real_repository(self.bzrdir._real_bzrdir.open_repository())
341
def find_text_key_references(self):
342
"""Find the text key references within the repository.
344
:return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
345
revision_ids. Each altered file-ids has the exact revision_ids that
346
altered it listed explicitly.
347
:return: A dictionary mapping text keys ((fileid, revision_id) tuples)
348
to whether they were referred to by the inventory of the
349
revision_id that they contain. The inventory texts from all present
350
revision ids are assessed to generate this report.
353
return self._real_repository.find_text_key_references()
355
def _generate_text_key_index(self):
356
"""Generate a new text key index for the repository.
358
This is an expensive function that will take considerable time to run.
360
:return: A dict mapping (file_id, revision_id) tuples to a list of
361
parents, also (file_id, revision_id) tuples.
364
return self._real_repository._generate_text_key_index()
366
def get_revision_graph(self, revision_id=None):
367
"""See Repository.get_revision_graph()."""
368
if revision_id is None:
370
elif revision.is_null(revision_id):
373
path = self.bzrdir._path_for_remote_call(self._client)
374
assert type(revision_id) is str
375
response = self._client.call_expecting_body(
376
'Repository.get_revision_graph', path, revision_id)
377
if response[0][0] not in ['ok', 'nosuchrevision']:
378
raise errors.UnexpectedSmartServerResponse(response[0])
379
if response[0][0] == 'ok':
380
coded = response[1].read_body_bytes()
382
# no revisions in this repository!
384
lines = coded.split('\n')
387
d = tuple(line.split())
388
revision_graph[d[0]] = d[1:]
390
return revision_graph
392
response_body = response[1].read_body_bytes()
393
assert response_body == ''
394
raise NoSuchRevision(self, revision_id)
396
def has_revision(self, revision_id):
397
"""See Repository.has_revision()."""
398
if revision_id == NULL_REVISION:
399
# The null revision is always present.
401
path = self.bzrdir._path_for_remote_call(self._client)
402
response = self._client.call('Repository.has_revision', path, revision_id)
403
assert response[0] in ('yes', 'no'), 'unexpected response code %s' % (response,)
404
return response[0] == 'yes'
406
def has_revisions(self, revision_ids):
407
"""See Repository.has_revisions()."""
409
for revision_id in revision_ids:
410
if self.has_revision(revision_id):
411
result.add(revision_id)
414
def has_same_location(self, other):
415
return (self.__class__ == other.__class__ and
416
self.bzrdir.transport.base == other.bzrdir.transport.base)
418
def get_graph(self, other_repository=None):
419
"""Return the graph for this repository format"""
420
parents_provider = self
421
if (other_repository is not None and
422
other_repository.bzrdir.transport.base !=
423
self.bzrdir.transport.base):
424
parents_provider = graph._StackedParentsProvider(
425
[parents_provider, other_repository._make_parents_provider()])
426
return graph.Graph(parents_provider)
428
def gather_stats(self, revid=None, committers=None):
429
"""See Repository.gather_stats()."""
430
path = self.bzrdir._path_for_remote_call(self._client)
431
# revid can be None to indicate no revisions, not just NULL_REVISION
432
if revid is None or revision.is_null(revid):
436
if committers is None or not committers:
437
fmt_committers = 'no'
439
fmt_committers = 'yes'
440
response = self._client.call_expecting_body(
441
'Repository.gather_stats', path, fmt_revid, fmt_committers)
442
assert response[0][0] == 'ok', \
443
'unexpected response code %s' % (response[0],)
445
body = response[1].read_body_bytes()
447
for line in body.split('\n'):
450
key, val_text = line.split(':')
451
if key in ('revisions', 'size', 'committers'):
452
result[key] = int(val_text)
453
elif key in ('firstrev', 'latestrev'):
454
values = val_text.split(' ')[1:]
455
result[key] = (float(values[0]), long(values[1]))
459
def find_branches(self, using=False):
460
"""See Repository.find_branches()."""
461
# should be an API call to the server.
463
return self._real_repository.find_branches(using=using)
465
def get_physical_lock_status(self):
466
"""See Repository.get_physical_lock_status()."""
467
# should be an API call to the server.
469
return self._real_repository.get_physical_lock_status()
471
def is_in_write_group(self):
472
"""Return True if there is an open write group.
474
write groups are only applicable locally for the smart server..
476
if self._real_repository:
477
return self._real_repository.is_in_write_group()
480
return self._lock_count >= 1
483
"""See Repository.is_shared()."""
484
path = self.bzrdir._path_for_remote_call(self._client)
485
response = self._client.call('Repository.is_shared', path)
486
assert response[0] in ('yes', 'no'), 'unexpected response code %s' % (response,)
487
return response[0] == 'yes'
489
def is_write_locked(self):
490
return self._lock_mode == 'w'
493
# wrong eventually - want a local lock cache context
494
if not self._lock_mode:
495
self._lock_mode = 'r'
497
self._parents_map = {}
498
if 'hpss' in debug.debug_flags:
499
self._requested_parents = set()
500
if self._real_repository is not None:
501
self._real_repository.lock_read()
503
self._lock_count += 1
505
def _remote_lock_write(self, token):
506
path = self.bzrdir._path_for_remote_call(self._client)
509
response = self._client.call('Repository.lock_write', path, token)
510
if response[0] == 'ok':
513
elif response[0] == 'LockContention':
514
raise errors.LockContention('(remote lock)')
515
elif response[0] == 'UnlockableTransport':
516
raise errors.UnlockableTransport(self.bzrdir.root_transport)
517
elif response[0] == 'LockFailed':
518
raise errors.LockFailed(response[1], response[2])
520
raise errors.UnexpectedSmartServerResponse(response)
522
def lock_write(self, token=None):
523
if not self._lock_mode:
524
self._lock_token = self._remote_lock_write(token)
525
# if self._lock_token is None, then this is something like packs or
526
# svn where we don't get to lock the repo, or a weave style repository
527
# where we cannot lock it over the wire and attempts to do so will
529
if self._real_repository is not None:
530
self._real_repository.lock_write(token=self._lock_token)
531
if token is not None:
532
self._leave_lock = True
534
self._leave_lock = False
535
self._lock_mode = 'w'
537
self._parents_map = {}
538
if 'hpss' in debug.debug_flags:
539
self._requested_parents = set()
540
elif self._lock_mode == 'r':
541
raise errors.ReadOnlyError(self)
543
self._lock_count += 1
544
return self._lock_token or None
546
def leave_lock_in_place(self):
547
if not self._lock_token:
548
raise NotImplementedError(self.leave_lock_in_place)
549
self._leave_lock = True
551
def dont_leave_lock_in_place(self):
552
if not self._lock_token:
553
raise NotImplementedError(self.dont_leave_lock_in_place)
554
self._leave_lock = False
556
def _set_real_repository(self, repository):
557
"""Set the _real_repository for this repository.
559
:param repository: The repository to fallback to for non-hpss
560
implemented operations.
562
assert not isinstance(repository, RemoteRepository)
563
self._real_repository = repository
564
if self._lock_mode == 'w':
565
# if we are already locked, the real repository must be able to
566
# acquire the lock with our token.
567
self._real_repository.lock_write(self._lock_token)
568
elif self._lock_mode == 'r':
569
self._real_repository.lock_read()
571
def start_write_group(self):
572
"""Start a write group on the decorated repository.
574
Smart methods peform operations in a single step so this api
575
is not really applicable except as a compatibility thunk
576
for older plugins that don't use e.g. the CommitBuilder
580
return self._real_repository.start_write_group()
582
def _unlock(self, token):
583
path = self.bzrdir._path_for_remote_call(self._client)
585
# with no token the remote repository is not persistently locked.
587
response = self._client.call('Repository.unlock', path, token)
588
if response == ('ok',):
590
elif response[0] == 'TokenMismatch':
591
raise errors.TokenMismatch(token, '(remote token)')
593
raise errors.UnexpectedSmartServerResponse(response)
596
self._lock_count -= 1
597
if self._lock_count > 0:
599
self._parents_map = None
600
if 'hpss' in debug.debug_flags:
601
self._requested_parents = None
602
old_mode = self._lock_mode
603
self._lock_mode = None
605
# The real repository is responsible at present for raising an
606
# exception if it's in an unfinished write group. However, it
607
# normally will *not* actually remove the lock from disk - that's
608
# done by the server on receiving the Repository.unlock call.
609
# This is just to let the _real_repository stay up to date.
610
if self._real_repository is not None:
611
self._real_repository.unlock()
613
# The rpc-level lock should be released even if there was a
614
# problem releasing the vfs-based lock.
616
# Only write-locked repositories need to make a remote method
617
# call to perfom the unlock.
618
old_token = self._lock_token
619
self._lock_token = None
620
if not self._leave_lock:
621
self._unlock(old_token)
623
def break_lock(self):
624
# should hand off to the network
626
return self._real_repository.break_lock()
628
def _get_tarball(self, compression):
629
"""Return a TemporaryFile containing a repository tarball.
631
Returns None if the server does not support sending tarballs.
634
path = self.bzrdir._path_for_remote_call(self._client)
635
response, protocol = self._client.call_expecting_body(
636
'Repository.tarball', path, compression)
637
if response[0] == 'ok':
638
# Extract the tarball and return it
639
t = tempfile.NamedTemporaryFile()
640
# TODO: rpc layer should read directly into it...
641
t.write(protocol.read_body_bytes())
644
if (response == ('error', "Generic bzr smart protocol error: "
645
"bad request 'Repository.tarball'") or
646
response == ('error', "Generic bzr smart protocol error: "
647
"bad request u'Repository.tarball'")):
648
protocol.cancel_read_body()
650
raise errors.UnexpectedSmartServerResponse(response)
652
def sprout(self, to_bzrdir, revision_id=None):
653
# TODO: Option to control what format is created?
655
dest_repo = self._real_repository._format.initialize(to_bzrdir,
657
dest_repo.fetch(self, revision_id=revision_id)
660
### These methods are just thin shims to the VFS object for now.
662
def revision_tree(self, revision_id):
664
return self._real_repository.revision_tree(revision_id)
666
def get_serializer_format(self):
668
return self._real_repository.get_serializer_format()
670
def get_commit_builder(self, branch, parents, config, timestamp=None,
671
timezone=None, committer=None, revprops=None,
673
# FIXME: It ought to be possible to call this without immediately
674
# triggering _ensure_real. For now it's the easiest thing to do.
676
builder = self._real_repository.get_commit_builder(branch, parents,
677
config, timestamp=timestamp, timezone=timezone,
678
committer=committer, revprops=revprops, revision_id=revision_id)
681
def add_inventory(self, revid, inv, parents):
683
return self._real_repository.add_inventory(revid, inv, parents)
685
def add_revision(self, rev_id, rev, inv=None, config=None):
687
return self._real_repository.add_revision(
688
rev_id, rev, inv=inv, config=config)
691
def get_inventory(self, revision_id):
693
return self._real_repository.get_inventory(revision_id)
695
def iter_inventories(self, revision_ids):
697
return self._real_repository.iter_inventories(revision_ids)
700
def get_revision(self, revision_id):
702
return self._real_repository.get_revision(revision_id)
705
def weave_store(self):
707
return self._real_repository.weave_store
709
def get_transaction(self):
711
return self._real_repository.get_transaction()
714
def clone(self, a_bzrdir, revision_id=None):
716
return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
718
def make_working_trees(self):
719
"""RemoteRepositories never create working trees by default."""
722
def revision_ids_to_search_result(self, result_set):
723
"""Convert a set of revision ids to a graph SearchResult."""
724
result_parents = set()
725
for parents in self.get_graph().get_parent_map(
726
result_set).itervalues():
727
result_parents.update(parents)
728
included_keys = result_set.intersection(result_parents)
729
start_keys = result_set.difference(included_keys)
730
exclude_keys = result_parents.difference(result_set)
731
result = graph.SearchResult(start_keys, exclude_keys,
732
len(result_set), result_set)
736
def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
737
"""Return the revision ids that other has that this does not.
739
These are returned in topological order.
741
revision_id: only return revision ids included by revision_id.
743
return repository.InterRepository.get(
744
other, self).search_missing_revision_ids(revision_id, find_ghosts)
746
def fetch(self, source, revision_id=None, pb=None):
747
if self.has_same_location(source):
748
# check that last_revision is in 'from' and then return a
750
if (revision_id is not None and
751
not revision.is_null(revision_id)):
752
self.get_revision(revision_id)
755
return self._real_repository.fetch(
756
source, revision_id=revision_id, pb=pb)
758
def create_bundle(self, target, base, fileobj, format=None):
760
self._real_repository.create_bundle(target, base, fileobj, format)
763
def control_weaves(self):
765
return self._real_repository.control_weaves
768
def get_ancestry(self, revision_id, topo_sorted=True):
770
return self._real_repository.get_ancestry(revision_id, topo_sorted)
773
def get_inventory_weave(self):
775
return self._real_repository.get_inventory_weave()
777
def fileids_altered_by_revision_ids(self, revision_ids):
779
return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
781
def _get_versioned_file_checker(self, revisions, revision_versions_cache):
783
return self._real_repository._get_versioned_file_checker(
784
revisions, revision_versions_cache)
786
def iter_files_bytes(self, desired_files):
787
"""See Repository.iter_file_bytes.
790
return self._real_repository.iter_files_bytes(desired_files)
792
def get_parent_map(self, keys):
793
"""See bzrlib.Graph.get_parent_map()."""
794
# Hack to build up the caching logic.
795
ancestry = self._parents_map
797
# Repository is not locked, so there's no cache.
798
missing_revisions = set(keys)
801
missing_revisions = set(key for key in keys if key not in ancestry)
802
if missing_revisions:
803
parent_map = self._get_parent_map(missing_revisions)
804
if 'hpss' in debug.debug_flags:
805
mutter('retransmitted revisions: %d of %d',
806
len(set(ancestry).intersection(parent_map)),
808
ancestry.update(parent_map)
809
present_keys = [k for k in keys if k in ancestry]
810
if 'hpss' in debug.debug_flags:
811
self._requested_parents.update(present_keys)
812
mutter('Current RemoteRepository graph hit rate: %d%%',
813
100.0 * len(self._requested_parents) / len(ancestry))
814
return dict((k, ancestry[k]) for k in present_keys)
816
def _response_is_unknown_method(self, response, verb):
817
"""Return True if response is an unknonwn method response to verb.
819
:param response: The response from a smart client call_expecting_body
821
:param verb: The verb used in that call.
822
:return: True if an unknown method was encountered.
824
# This might live better on
825
# bzrlib.smart.protocol.SmartClientRequestProtocolOne
826
if (response[0] == ('error', "Generic bzr smart protocol error: "
827
"bad request '%s'" % verb) or
828
response[0] == ('error', "Generic bzr smart protocol error: "
829
"bad request u'%s'" % verb)):
830
response[1].cancel_read_body()
834
def _get_parent_map(self, keys):
835
"""Helper for get_parent_map that performs the RPC."""
836
medium = self._client.get_smart_medium()
837
if not medium._remote_is_at_least_1_2:
838
# We already found out that the server can't understand
839
# Repository.get_parent_map requests, so just fetch the whole
841
return self.get_revision_graph()
844
if NULL_REVISION in keys:
845
keys.discard(NULL_REVISION)
846
found_parents = {NULL_REVISION:()}
851
# TODO(Needs analysis): We could assume that the keys being requested
852
# from get_parent_map are in a breadth first search, so typically they
853
# will all be depth N from some common parent, and we don't have to
854
# have the server iterate from the root parent, but rather from the
855
# keys we're searching; and just tell the server the keyspace we
856
# already have; but this may be more traffic again.
858
# Transform self._parents_map into a search request recipe.
859
# TODO: Manage this incrementally to avoid covering the same path
860
# repeatedly. (The server will have to on each request, but the less
861
# work done the better).
862
parents_map = self._parents_map
863
if parents_map is None:
864
# Repository is not locked, so there's no cache.
866
start_set = set(parents_map)
867
result_parents = set()
868
for parents in parents_map.itervalues():
869
result_parents.update(parents)
870
stop_keys = result_parents.difference(start_set)
871
included_keys = start_set.intersection(result_parents)
872
start_set.difference_update(included_keys)
873
recipe = (start_set, stop_keys, len(parents_map))
874
body = self._serialise_search_recipe(recipe)
875
path = self.bzrdir._path_for_remote_call(self._client)
877
assert type(key) is str
878
verb = 'Repository.get_parent_map'
879
args = (path,) + tuple(keys)
880
response = self._client.call_with_body_bytes_expecting_body(
881
verb, args, self._serialise_search_recipe(recipe))
882
if self._response_is_unknown_method(response, verb):
883
# Server does not support this method, so get the whole graph.
884
# Worse, we have to force a disconnection, because the server now
885
# doesn't realise it has a body on the wire to consume, so the
886
# only way to recover is to abandon the connection.
888
'Server is too old for fast get_parent_map, reconnecting. '
889
'(Upgrade the server to Bazaar 1.2 to avoid this)')
891
# To avoid having to disconnect repeatedly, we keep track of the
892
# fact the server doesn't understand remote methods added in 1.2.
893
medium._remote_is_at_least_1_2 = False
894
return self.get_revision_graph()
895
elif response[0][0] not in ['ok']:
896
reponse[1].cancel_read_body()
897
raise errors.UnexpectedSmartServerResponse(response[0])
898
if response[0][0] == 'ok':
899
coded = bz2.decompress(response[1].read_body_bytes())
903
lines = coded.split('\n')
906
d = tuple(line.split())
908
revision_graph[d[0]] = d[1:]
910
# No parents - so give the Graph result (NULL_REVISION,).
911
revision_graph[d[0]] = (NULL_REVISION,)
912
return revision_graph
915
def get_signature_text(self, revision_id):
917
return self._real_repository.get_signature_text(revision_id)
920
def get_revision_graph_with_ghosts(self, revision_ids=None):
922
return self._real_repository.get_revision_graph_with_ghosts(
923
revision_ids=revision_ids)
926
def get_inventory_xml(self, revision_id):
928
return self._real_repository.get_inventory_xml(revision_id)
930
def deserialise_inventory(self, revision_id, xml):
932
return self._real_repository.deserialise_inventory(revision_id, xml)
934
def reconcile(self, other=None, thorough=False):
936
return self._real_repository.reconcile(other=other, thorough=thorough)
938
def all_revision_ids(self):
940
return self._real_repository.all_revision_ids()
943
def get_deltas_for_revisions(self, revisions):
945
return self._real_repository.get_deltas_for_revisions(revisions)
948
def get_revision_delta(self, revision_id):
950
return self._real_repository.get_revision_delta(revision_id)
953
def revision_trees(self, revision_ids):
955
return self._real_repository.revision_trees(revision_ids)
958
def get_revision_reconcile(self, revision_id):
960
return self._real_repository.get_revision_reconcile(revision_id)
963
def check(self, revision_ids=None):
965
return self._real_repository.check(revision_ids=revision_ids)
967
def copy_content_into(self, destination, revision_id=None):
969
return self._real_repository.copy_content_into(
970
destination, revision_id=revision_id)
972
def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
973
# get a tarball of the remote repository, and copy from that into the
975
from bzrlib import osutils
978
# TODO: Maybe a progress bar while streaming the tarball?
979
note("Copying repository content as tarball...")
980
tar_file = self._get_tarball('bz2')
983
destination = to_bzrdir.create_repository()
985
tar = tarfile.open('repository', fileobj=tar_file,
987
tmpdir = tempfile.mkdtemp()
989
_extract_tar(tar, tmpdir)
990
tmp_bzrdir = BzrDir.open(tmpdir)
991
tmp_repo = tmp_bzrdir.open_repository()
992
tmp_repo.copy_content_into(destination, revision_id)
994
osutils.rmtree(tmpdir)
998
# TODO: Suggestion from john: using external tar is much faster than
999
# python's tarfile library, but it may not work on windows.
1003
"""Compress the data within the repository.
1005
This is not currently implemented within the smart server.
1008
return self._real_repository.pack()
1010
def set_make_working_trees(self, new_value):
1011
raise NotImplementedError(self.set_make_working_trees)
1014
def sign_revision(self, revision_id, gpg_strategy):
1016
return self._real_repository.sign_revision(revision_id, gpg_strategy)
1019
def get_revisions(self, revision_ids):
1021
return self._real_repository.get_revisions(revision_ids)
1023
def supports_rich_root(self):
1025
return self._real_repository.supports_rich_root()
1027
def iter_reverse_revision_history(self, revision_id):
1029
return self._real_repository.iter_reverse_revision_history(revision_id)
1032
def _serializer(self):
1034
return self._real_repository._serializer
1036
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1038
return self._real_repository.store_revision_signature(
1039
gpg_strategy, plaintext, revision_id)
1041
def add_signature_text(self, revision_id, signature):
1043
return self._real_repository.add_signature_text(revision_id, signature)
1045
def has_signature_for_revision_id(self, revision_id):
1047
return self._real_repository.has_signature_for_revision_id(revision_id)
1049
def get_data_stream_for_search(self, search):
1050
medium = self._client.get_smart_medium()
1051
if not medium._remote_is_at_least_1_2:
1053
return self._real_repository.get_data_stream_for_search(search)
1054
REQUEST_NAME = 'Repository.stream_revisions_chunked'
1055
path = self.bzrdir._path_for_remote_call(self._client)
1056
body = self._serialise_search_recipe(search.get_recipe())
1057
response, protocol = self._client.call_with_body_bytes_expecting_body(
1058
REQUEST_NAME, (path,), body)
1060
if self._response_is_unknown_method((response, protocol), REQUEST_NAME):
1061
# Server does not support this method, so fall back to VFS.
1062
# Worse, we have to force a disconnection, because the server now
1063
# doesn't realise it has a body on the wire to consume, so the
1064
# only way to recover is to abandon the connection.
1066
'Server is too old for streaming pull, reconnecting. '
1067
'(Upgrade the server to Bazaar 1.2 to avoid this)')
1069
# To avoid having to disconnect repeatedly, we keep track of the
1070
# fact the server doesn't understand this remote method.
1071
medium._remote_is_at_least_1_2 = False
1073
return self._real_repository.get_data_stream_for_search(search)
1075
if response == ('ok',):
1076
return self._deserialise_stream(protocol)
1077
if response == ('NoSuchRevision', ):
1078
# We cannot easily identify the revision that is missing in this
1079
# situation without doing much more network IO. For now, bail.
1080
raise NoSuchRevision(self, "unknown")
1082
raise errors.UnexpectedSmartServerResponse(response)
1084
def _deserialise_stream(self, protocol):
1085
stream = protocol.read_streamed_body()
1086
container_parser = ContainerPushParser()
1087
for bytes in stream:
1088
container_parser.accept_bytes(bytes)
1089
records = container_parser.read_pending_records()
1090
for record_names, record_bytes in records:
1091
if len(record_names) != 1:
1092
# These records should have only one name, and that name
1093
# should be a one-element tuple.
1094
raise errors.SmartProtocolError(
1095
'Repository data stream had invalid record name %r'
1097
name_tuple = record_names[0]
1098
yield name_tuple, record_bytes
1100
def insert_data_stream(self, stream):
1102
self._real_repository.insert_data_stream(stream)
1104
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
1106
return self._real_repository.item_keys_introduced_by(revision_ids,
1107
_files_pb=_files_pb)
1109
def revision_graph_can_have_wrong_parents(self):
1110
# The answer depends on the remote repo format.
1112
return self._real_repository.revision_graph_can_have_wrong_parents()
1114
def _find_inconsistent_revision_parents(self):
1116
return self._real_repository._find_inconsistent_revision_parents()
1118
def _check_for_inconsistent_revision_parents(self):
1120
return self._real_repository._check_for_inconsistent_revision_parents()
1122
def _make_parents_provider(self):
1125
def _serialise_search_recipe(self, recipe):
1126
"""Serialise a graph search recipe.
1128
:param recipe: A search recipe (start, stop, count).
1129
:return: Serialised bytes.
1131
start_keys = ' '.join(recipe[0])
1132
stop_keys = ' '.join(recipe[1])
1133
count = str(recipe[2])
1134
return '\n'.join((start_keys, stop_keys, count))
1137
class RemoteBranchLockableFiles(LockableFiles):
1138
"""A 'LockableFiles' implementation that talks to a smart server.
1140
This is not a public interface class.
1143
def __init__(self, bzrdir, _client):
1144
self.bzrdir = bzrdir
1145
self._client = _client
1146
self._need_find_modes = True
1147
LockableFiles.__init__(
1148
self, bzrdir.get_branch_transport(None),
1149
'lock', lockdir.LockDir)
1151
def _find_modes(self):
1152
# RemoteBranches don't let the client set the mode of control files.
1153
self._dir_mode = None
1154
self._file_mode = None
1156
def get(self, path):
1157
"""'get' a remote path as per the LockableFiles interface.
1159
:param path: the file to 'get'. If this is 'branch.conf', we do not
1160
just retrieve a file, instead we ask the smart server to generate
1161
a configuration for us - which is retrieved as an INI file.
1163
if path == 'branch.conf':
1164
path = self.bzrdir._path_for_remote_call(self._client)
1165
response = self._client.call_expecting_body(
1166
'Branch.get_config_file', path)
1167
assert response[0][0] == 'ok', \
1168
'unexpected response code %s' % (response[0],)
1169
return StringIO(response[1].read_body_bytes())
1172
return LockableFiles.get(self, path)
1175
class RemoteBranchFormat(branch.BranchFormat):
1177
def __eq__(self, other):
1178
return (isinstance(other, RemoteBranchFormat) and
1179
self.__dict__ == other.__dict__)
1181
def get_format_description(self):
1182
return 'Remote BZR Branch'
1184
def get_format_string(self):
1185
return 'Remote BZR Branch'
1187
def open(self, a_bzrdir):
1188
assert isinstance(a_bzrdir, RemoteBzrDir)
1189
return a_bzrdir.open_branch()
1191
def initialize(self, a_bzrdir):
1192
assert isinstance(a_bzrdir, RemoteBzrDir)
1193
return a_bzrdir.create_branch()
1195
def supports_tags(self):
1196
# Remote branches might support tags, but we won't know until we
1197
# access the real remote branch.
1201
class RemoteBranch(branch.Branch):
1202
"""Branch stored on a server accessed by HPSS RPC.
1204
At the moment most operations are mapped down to simple file operations.
1207
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
1209
"""Create a RemoteBranch instance.
1211
:param real_branch: An optional local implementation of the branch
1212
format, usually accessing the data via the VFS.
1213
:param _client: Private parameter for testing.
1215
# We intentionally don't call the parent class's __init__, because it
1216
# will try to assign to self.tags, which is a property in this subclass.
1217
# And the parent's __init__ doesn't do much anyway.
1218
self._revision_id_to_revno_cache = None
1219
self._revision_history_cache = None
1220
self.bzrdir = remote_bzrdir
1221
if _client is not None:
1222
self._client = _client
1224
self._client = client._SmartClient(self.bzrdir._shared_medium)
1225
self.repository = remote_repository
1226
if real_branch is not None:
1227
self._real_branch = real_branch
1228
# Give the remote repository the matching real repo.
1229
real_repo = self._real_branch.repository
1230
if isinstance(real_repo, RemoteRepository):
1231
real_repo._ensure_real()
1232
real_repo = real_repo._real_repository
1233
self.repository._set_real_repository(real_repo)
1234
# Give the branch the remote repository to let fast-pathing happen.
1235
self._real_branch.repository = self.repository
1237
self._real_branch = None
1238
# Fill out expected attributes of branch for bzrlib api users.
1239
self._format = RemoteBranchFormat()
1240
self.base = self.bzrdir.root_transport.base
1241
self._control_files = None
1242
self._lock_mode = None
1243
self._lock_token = None
1244
self._lock_count = 0
1245
self._leave_lock = False
1248
return "%s(%s)" % (self.__class__.__name__, self.base)
1252
def _ensure_real(self):
1253
"""Ensure that there is a _real_branch set.
1255
Used before calls to self._real_branch.
1257
if not self._real_branch:
1258
assert vfs.vfs_enabled()
1259
self.bzrdir._ensure_real()
1260
self._real_branch = self.bzrdir._real_bzrdir.open_branch()
1261
# Give the remote repository the matching real repo.
1262
real_repo = self._real_branch.repository
1263
if isinstance(real_repo, RemoteRepository):
1264
real_repo._ensure_real()
1265
real_repo = real_repo._real_repository
1266
self.repository._set_real_repository(real_repo)
1267
# Give the branch the remote repository to let fast-pathing happen.
1268
self._real_branch.repository = self.repository
1269
# XXX: deal with _lock_mode == 'w'
1270
if self._lock_mode == 'r':
1271
self._real_branch.lock_read()
1274
def control_files(self):
1275
# Defer actually creating RemoteBranchLockableFiles until its needed,
1276
# because it triggers an _ensure_real that we otherwise might not need.
1277
if self._control_files is None:
1278
self._control_files = RemoteBranchLockableFiles(
1279
self.bzrdir, self._client)
1280
return self._control_files
1282
def _get_checkout_format(self):
1284
return self._real_branch._get_checkout_format()
1286
def get_physical_lock_status(self):
1287
"""See Branch.get_physical_lock_status()."""
1288
# should be an API call to the server, as branches must be lockable.
1290
return self._real_branch.get_physical_lock_status()
1292
def lock_read(self):
1293
if not self._lock_mode:
1294
self._lock_mode = 'r'
1295
self._lock_count = 1
1296
if self._real_branch is not None:
1297
self._real_branch.lock_read()
1299
self._lock_count += 1
1301
def _remote_lock_write(self, token):
1303
branch_token = repo_token = ''
1305
branch_token = token
1306
repo_token = self.repository.lock_write()
1307
self.repository.unlock()
1308
path = self.bzrdir._path_for_remote_call(self._client)
1309
response = self._client.call('Branch.lock_write', path, branch_token,
1311
if response[0] == 'ok':
1312
ok, branch_token, repo_token = response
1313
return branch_token, repo_token
1314
elif response[0] == 'LockContention':
1315
raise errors.LockContention('(remote lock)')
1316
elif response[0] == 'TokenMismatch':
1317
raise errors.TokenMismatch(token, '(remote token)')
1318
elif response[0] == 'UnlockableTransport':
1319
raise errors.UnlockableTransport(self.bzrdir.root_transport)
1320
elif response[0] == 'ReadOnlyError':
1321
raise errors.ReadOnlyError(self)
1322
elif response[0] == 'LockFailed':
1323
raise errors.LockFailed(response[1], response[2])
1325
raise errors.UnexpectedSmartServerResponse(response)
1327
def lock_write(self, token=None):
1328
if not self._lock_mode:
1329
remote_tokens = self._remote_lock_write(token)
1330
self._lock_token, self._repo_lock_token = remote_tokens
1331
assert self._lock_token, 'Remote server did not return a token!'
1332
# TODO: We really, really, really don't want to call _ensure_real
1333
# here, but it's the easiest way to ensure coherency between the
1334
# state of the RemoteBranch and RemoteRepository objects and the
1335
# physical locks. If we don't materialise the real objects here,
1336
# then getting everything in the right state later is complex, so
1337
# for now we just do it the lazy way.
1338
# -- Andrew Bennetts, 2007-02-22.
1340
if self._real_branch is not None:
1341
self._real_branch.repository.lock_write(
1342
token=self._repo_lock_token)
1344
self._real_branch.lock_write(token=self._lock_token)
1346
self._real_branch.repository.unlock()
1347
if token is not None:
1348
self._leave_lock = True
1350
# XXX: this case seems to be unreachable; token cannot be None.
1351
self._leave_lock = False
1352
self._lock_mode = 'w'
1353
self._lock_count = 1
1354
elif self._lock_mode == 'r':
1355
raise errors.ReadOnlyTransaction
1357
if token is not None:
1358
# A token was given to lock_write, and we're relocking, so check
1359
# that the given token actually matches the one we already have.
1360
if token != self._lock_token:
1361
raise errors.TokenMismatch(token, self._lock_token)
1362
self._lock_count += 1
1363
return self._lock_token or None
1365
def _unlock(self, branch_token, repo_token):
1366
path = self.bzrdir._path_for_remote_call(self._client)
1367
response = self._client.call('Branch.unlock', path, branch_token,
1369
if response == ('ok',):
1371
elif response[0] == 'TokenMismatch':
1372
raise errors.TokenMismatch(
1373
str((branch_token, repo_token)), '(remote tokens)')
1375
raise errors.UnexpectedSmartServerResponse(response)
1378
self._lock_count -= 1
1379
if not self._lock_count:
1380
self._clear_cached_state()
1381
mode = self._lock_mode
1382
self._lock_mode = None
1383
if self._real_branch is not None:
1384
if (not self._leave_lock and mode == 'w' and
1385
self._repo_lock_token):
1386
# If this RemoteBranch will remove the physical lock for the
1387
# repository, make sure the _real_branch doesn't do it
1388
# first. (Because the _real_branch's repository is set to
1389
# be the RemoteRepository.)
1390
self._real_branch.repository.leave_lock_in_place()
1391
self._real_branch.unlock()
1393
# Only write-locked branched need to make a remote method call
1394
# to perfom the unlock.
1396
assert self._lock_token, 'Locked, but no token!'
1397
branch_token = self._lock_token
1398
repo_token = self._repo_lock_token
1399
self._lock_token = None
1400
self._repo_lock_token = None
1401
if not self._leave_lock:
1402
self._unlock(branch_token, repo_token)
1404
def break_lock(self):
1406
return self._real_branch.break_lock()
1408
def leave_lock_in_place(self):
1409
if not self._lock_token:
1410
raise NotImplementedError(self.leave_lock_in_place)
1411
self._leave_lock = True
1413
def dont_leave_lock_in_place(self):
1414
if not self._lock_token:
1415
raise NotImplementedError(self.dont_leave_lock_in_place)
1416
self._leave_lock = False
1418
def last_revision_info(self):
1419
"""See Branch.last_revision_info()."""
1420
path = self.bzrdir._path_for_remote_call(self._client)
1421
response = self._client.call('Branch.last_revision_info', path)
1422
assert response[0] == 'ok', 'unexpected response code %s' % (response,)
1423
revno = int(response[1])
1424
last_revision = response[2]
1425
return (revno, last_revision)
1427
def _gen_revision_history(self):
1428
"""See Branch._gen_revision_history()."""
1429
path = self.bzrdir._path_for_remote_call(self._client)
1430
response = self._client.call_expecting_body(
1431
'Branch.revision_history', path)
1432
assert response[0][0] == 'ok', ('unexpected response code %s'
1434
result = response[1].read_body_bytes().split('\x00')
1440
def set_revision_history(self, rev_history):
1441
# Send just the tip revision of the history; the server will generate
1442
# the full history from that. If the revision doesn't exist in this
1443
# branch, NoSuchRevision will be raised.
1444
path = self.bzrdir._path_for_remote_call(self._client)
1445
if rev_history == []:
1448
rev_id = rev_history[-1]
1449
self._clear_cached_state()
1450
response = self._client.call('Branch.set_last_revision',
1451
path, self._lock_token, self._repo_lock_token, rev_id)
1452
if response[0] == 'NoSuchRevision':
1453
raise NoSuchRevision(self, rev_id)
1455
assert response == ('ok',), (
1456
'unexpected response code %r' % (response,))
1457
self._cache_revision_history(rev_history)
1459
def get_parent(self):
1461
return self._real_branch.get_parent()
1463
def set_parent(self, url):
1465
return self._real_branch.set_parent(url)
1467
def get_config(self):
1468
return RemoteBranchConfig(self)
1470
def sprout(self, to_bzrdir, revision_id=None):
1471
# Like Branch.sprout, except that it sprouts a branch in the default
1472
# format, because RemoteBranches can't be created at arbitrary URLs.
1473
# XXX: if to_bzrdir is a RemoteBranch, this should perhaps do
1474
# to_bzrdir.create_branch...
1476
result = self._real_branch._format.initialize(to_bzrdir)
1477
self.copy_content_into(result, revision_id=revision_id)
1478
result.set_parent(self.bzrdir.root_transport.base)
1482
def pull(self, source, overwrite=False, stop_revision=None,
1484
# FIXME: This asks the real branch to run the hooks, which means
1485
# they're called with the wrong target branch parameter.
1486
# The test suite specifically allows this at present but it should be
1487
# fixed. It should get a _override_hook_target branch,
1488
# as push does. -- mbp 20070405
1490
self._real_branch.pull(
1491
source, overwrite=overwrite, stop_revision=stop_revision,
1495
def push(self, target, overwrite=False, stop_revision=None):
1497
return self._real_branch.push(
1498
target, overwrite=overwrite, stop_revision=stop_revision,
1499
_override_hook_source_branch=self)
1501
def is_locked(self):
1502
return self._lock_count >= 1
1504
def set_last_revision_info(self, revno, revision_id):
1506
self._clear_cached_state()
1507
return self._real_branch.set_last_revision_info(revno, revision_id)
1509
def generate_revision_history(self, revision_id, last_rev=None,
1512
return self._real_branch.generate_revision_history(
1513
revision_id, last_rev=last_rev, other_branch=other_branch)
1518
return self._real_branch.tags
1520
def set_push_location(self, location):
1522
return self._real_branch.set_push_location(location)
1524
def update_revisions(self, other, stop_revision=None, overwrite=False):
1526
return self._real_branch.update_revisions(
1527
other, stop_revision=stop_revision, overwrite=overwrite)
1530
class RemoteBranchConfig(BranchConfig):
1533
self.branch._ensure_real()
1534
return self.branch._real_branch.get_config().username()
1536
def _get_branch_data_config(self):
1537
self.branch._ensure_real()
1538
if self._branch_data_config is None:
1539
self._branch_data_config = TreeConfig(self.branch._real_branch)
1540
return self._branch_data_config
1543
def _extract_tar(tar, to_dir):
1544
"""Extract all the contents of a tarfile object.
1546
A replacement for extractall, which is not present in python2.4
1549
tar.extract(tarinfo, to_dir)
added
removed
bzrlib/remote.py
