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
response = self._client.call('BzrDir.find_repository', path)
152
assert response[0] in ('ok', 'norepository'), \
153
'unexpected response code %s' % (response,)
154
if response[0] == 'norepository':
155
raise errors.NoRepositoryPresent(self)
156
assert len(response) == 4, 'incorrect response length %s' % (response,)
157
if response[1] == '':
158
format = RemoteRepositoryFormat()
159
format.rich_root_data = (response[2] == 'yes')
160
format.supports_tree_reference = (response[3] == 'yes')
161
# No wire format to check this yet.
162
format.supports_external_lookups = False
163
return RemoteRepository(self, format)
165
raise errors.NoRepositoryPresent(self)
167
def open_workingtree(self, recommend_upgrade=True):
169
if self._real_bzrdir.has_workingtree():
170
raise errors.NotLocalUrl(self.root_transport)
172
raise errors.NoWorkingTree(self.root_transport.base)
174
def _path_for_remote_call(self, client):
175
"""Return the path to be used for this bzrdir in a remote call."""
176
return client.remote_path_from_transport(self.root_transport)
178
def get_branch_transport(self, branch_format):
180
return self._real_bzrdir.get_branch_transport(branch_format)
182
def get_repository_transport(self, repository_format):
184
return self._real_bzrdir.get_repository_transport(repository_format)
186
def get_workingtree_transport(self, workingtree_format):
188
return self._real_bzrdir.get_workingtree_transport(workingtree_format)
190
def can_convert_format(self):
191
"""Upgrading of remote bzrdirs is not supported yet."""
194
def needs_format_conversion(self, format=None):
195
"""Upgrading of remote bzrdirs is not supported yet."""
198
def clone(self, url, revision_id=None, force_new_repo=False):
200
return self._real_bzrdir.clone(url, revision_id=revision_id,
201
force_new_repo=force_new_repo)
204
class RemoteRepositoryFormat(repository.RepositoryFormat):
205
"""Format for repositories accessed over a _SmartClient.
207
Instances of this repository are represented by RemoteRepository
210
The RemoteRepositoryFormat is parameterized during construction
211
to reflect the capabilities of the real, remote format. Specifically
212
the attributes rich_root_data and supports_tree_reference are set
213
on a per instance basis, and are not set (and should not be) at
217
_matchingbzrdir = RemoteBzrDirFormat
219
def initialize(self, a_bzrdir, shared=False):
220
assert isinstance(a_bzrdir, RemoteBzrDir), \
221
'%r is not a RemoteBzrDir' % (a_bzrdir,)
222
return a_bzrdir.create_repository(shared=shared)
224
def open(self, a_bzrdir):
225
assert isinstance(a_bzrdir, RemoteBzrDir)
226
return a_bzrdir.open_repository()
228
def get_format_description(self):
229
return 'bzr remote repository'
231
def __eq__(self, other):
232
return self.__class__ == other.__class__
234
def check_conversion_target(self, target_format):
235
if self.rich_root_data and not target_format.rich_root_data:
236
raise errors.BadConversionTarget(
237
'Does not support rich root data.', target_format)
238
if (self.supports_tree_reference and
239
not getattr(target_format, 'supports_tree_reference', False)):
240
raise errors.BadConversionTarget(
241
'Does not support nested trees', target_format)
244
class RemoteRepository(object):
245
"""Repository accessed over rpc.
247
For the moment most operations are performed using local transport-backed
251
def __init__(self, remote_bzrdir, format, real_repository=None, _client=None):
252
"""Create a RemoteRepository instance.
254
:param remote_bzrdir: The bzrdir hosting this repository.
255
:param format: The RemoteFormat object to use.
256
:param real_repository: If not None, a local implementation of the
257
repository logic for the repository, usually accessing the data
259
:param _client: Private testing parameter - override the smart client
260
to be used by the repository.
263
self._real_repository = real_repository
265
self._real_repository = None
266
self.bzrdir = remote_bzrdir
268
self._client = client._SmartClient(self.bzrdir._shared_medium)
270
self._client = _client
271
self._format = format
272
self._lock_mode = None
273
self._lock_token = None
275
self._leave_lock = False
276
# A cache of looked up revision parent data; reset at unlock time.
277
self._parents_map = None
278
if 'hpss' in debug.debug_flags:
279
self._requested_parents = None
281
# These depend on the actual remote format, so force them off for
282
# maximum compatibility. XXX: In future these should depend on the
283
# remote repository instance, but this is irrelevant until we perform
284
# reconcile via an RPC call.
285
self._reconcile_does_inventory_gc = False
286
self._reconcile_fixes_text_parents = False
287
self._reconcile_backsup_inventory = False
288
self.base = self.bzrdir.transport.base
289
# Can this repository be given external locations to lookup additional
291
self.supports_external_lookups = False
294
return "%s(%s)" % (self.__class__.__name__, self.base)
298
def abort_write_group(self):
299
"""Complete a write group on the decorated repository.
301
Smart methods peform operations in a single step so this api
302
is not really applicable except as a compatibility thunk
303
for older plugins that don't use e.g. the CommitBuilder
307
return self._real_repository.abort_write_group()
309
def commit_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.commit_write_group()
320
def _ensure_real(self):
321
"""Ensure that there is a _real_repository set.
323
Used before calls to self._real_repository.
325
if not self._real_repository:
326
self.bzrdir._ensure_real()
327
#self._real_repository = self.bzrdir._real_bzrdir.open_repository()
328
self._set_real_repository(self.bzrdir._real_bzrdir.open_repository())
330
def find_text_key_references(self):
331
"""Find the text key references within the repository.
333
:return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
334
revision_ids. Each altered file-ids has the exact revision_ids that
335
altered it listed explicitly.
336
:return: A dictionary mapping text keys ((fileid, revision_id) tuples)
337
to whether they were referred to by the inventory of the
338
revision_id that they contain. The inventory texts from all present
339
revision ids are assessed to generate this report.
342
return self._real_repository.find_text_key_references()
344
def _generate_text_key_index(self):
345
"""Generate a new text key index for the repository.
347
This is an expensive function that will take considerable time to run.
349
:return: A dict mapping (file_id, revision_id) tuples to a list of
350
parents, also (file_id, revision_id) tuples.
353
return self._real_repository._generate_text_key_index()
355
def get_revision_graph(self, revision_id=None):
356
"""See Repository.get_revision_graph()."""
357
if revision_id is None:
359
elif revision.is_null(revision_id):
362
path = self.bzrdir._path_for_remote_call(self._client)
363
assert type(revision_id) is str
364
response = self._client.call_expecting_body(
365
'Repository.get_revision_graph', path, revision_id)
366
if response[0][0] not in ['ok', 'nosuchrevision']:
367
raise errors.UnexpectedSmartServerResponse(response[0])
368
if response[0][0] == 'ok':
369
coded = response[1].read_body_bytes()
371
# no revisions in this repository!
373
lines = coded.split('\n')
376
d = tuple(line.split())
377
revision_graph[d[0]] = d[1:]
379
return revision_graph
381
response_body = response[1].read_body_bytes()
382
assert response_body == ''
383
raise NoSuchRevision(self, revision_id)
385
def has_revision(self, revision_id):
386
"""See Repository.has_revision()."""
387
if revision_id == NULL_REVISION:
388
# The null revision is always present.
390
path = self.bzrdir._path_for_remote_call(self._client)
391
response = self._client.call('Repository.has_revision', path, revision_id)
392
assert response[0] in ('yes', 'no'), 'unexpected response code %s' % (response,)
393
return response[0] == 'yes'
395
def has_revisions(self, revision_ids):
396
"""See Repository.has_revisions()."""
398
for revision_id in revision_ids:
399
if self.has_revision(revision_id):
400
result.add(revision_id)
403
def has_same_location(self, other):
404
return (self.__class__ == other.__class__ and
405
self.bzrdir.transport.base == other.bzrdir.transport.base)
407
def get_graph(self, other_repository=None):
408
"""Return the graph for this repository format"""
409
parents_provider = self
410
if (other_repository is not None and
411
other_repository.bzrdir.transport.base !=
412
self.bzrdir.transport.base):
413
parents_provider = graph._StackedParentsProvider(
414
[parents_provider, other_repository._make_parents_provider()])
415
return graph.Graph(parents_provider)
417
def gather_stats(self, revid=None, committers=None):
418
"""See Repository.gather_stats()."""
419
path = self.bzrdir._path_for_remote_call(self._client)
420
# revid can be None to indicate no revisions, not just NULL_REVISION
421
if revid is None or revision.is_null(revid):
425
if committers is None or not committers:
426
fmt_committers = 'no'
428
fmt_committers = 'yes'
429
response = self._client.call_expecting_body(
430
'Repository.gather_stats', path, fmt_revid, fmt_committers)
431
assert response[0][0] == 'ok', \
432
'unexpected response code %s' % (response[0],)
434
body = response[1].read_body_bytes()
436
for line in body.split('\n'):
439
key, val_text = line.split(':')
440
if key in ('revisions', 'size', 'committers'):
441
result[key] = int(val_text)
442
elif key in ('firstrev', 'latestrev'):
443
values = val_text.split(' ')[1:]
444
result[key] = (float(values[0]), long(values[1]))
448
def find_branches(self, using=False):
449
"""See Repository.find_branches()."""
450
# should be an API call to the server.
452
return self._real_repository.find_branches(using=using)
454
def get_physical_lock_status(self):
455
"""See Repository.get_physical_lock_status()."""
456
# should be an API call to the server.
458
return self._real_repository.get_physical_lock_status()
460
def is_in_write_group(self):
461
"""Return True if there is an open write group.
463
write groups are only applicable locally for the smart server..
465
if self._real_repository:
466
return self._real_repository.is_in_write_group()
469
return self._lock_count >= 1
472
"""See Repository.is_shared()."""
473
path = self.bzrdir._path_for_remote_call(self._client)
474
response = self._client.call('Repository.is_shared', path)
475
assert response[0] in ('yes', 'no'), 'unexpected response code %s' % (response,)
476
return response[0] == 'yes'
478
def is_write_locked(self):
479
return self._lock_mode == 'w'
482
# wrong eventually - want a local lock cache context
483
if not self._lock_mode:
484
self._lock_mode = 'r'
486
self._parents_map = {}
487
if 'hpss' in debug.debug_flags:
488
self._requested_parents = set()
489
if self._real_repository is not None:
490
self._real_repository.lock_read()
492
self._lock_count += 1
494
def _remote_lock_write(self, token):
495
path = self.bzrdir._path_for_remote_call(self._client)
498
response = self._client.call('Repository.lock_write', path, token)
499
if response[0] == 'ok':
502
elif response[0] == 'LockContention':
503
raise errors.LockContention('(remote lock)')
504
elif response[0] == 'UnlockableTransport':
505
raise errors.UnlockableTransport(self.bzrdir.root_transport)
506
elif response[0] == 'LockFailed':
507
raise errors.LockFailed(response[1], response[2])
509
raise errors.UnexpectedSmartServerResponse(response)
511
def lock_write(self, token=None):
512
if not self._lock_mode:
513
self._lock_token = self._remote_lock_write(token)
514
# if self._lock_token is None, then this is something like packs or
515
# svn where we don't get to lock the repo, or a weave style repository
516
# where we cannot lock it over the wire and attempts to do so will
518
if self._real_repository is not None:
519
self._real_repository.lock_write(token=self._lock_token)
520
if token is not None:
521
self._leave_lock = True
523
self._leave_lock = False
524
self._lock_mode = 'w'
526
self._parents_map = {}
527
if 'hpss' in debug.debug_flags:
528
self._requested_parents = set()
529
elif self._lock_mode == 'r':
530
raise errors.ReadOnlyError(self)
532
self._lock_count += 1
533
return self._lock_token or None
535
def leave_lock_in_place(self):
536
if not self._lock_token:
537
raise NotImplementedError(self.leave_lock_in_place)
538
self._leave_lock = True
540
def dont_leave_lock_in_place(self):
541
if not self._lock_token:
542
raise NotImplementedError(self.dont_leave_lock_in_place)
543
self._leave_lock = False
545
def _set_real_repository(self, repository):
546
"""Set the _real_repository for this repository.
548
:param repository: The repository to fallback to for non-hpss
549
implemented operations.
551
assert not isinstance(repository, RemoteRepository)
552
self._real_repository = repository
553
if self._lock_mode == 'w':
554
# if we are already locked, the real repository must be able to
555
# acquire the lock with our token.
556
self._real_repository.lock_write(self._lock_token)
557
elif self._lock_mode == 'r':
558
self._real_repository.lock_read()
560
def start_write_group(self):
561
"""Start a write group on the decorated repository.
563
Smart methods peform operations in a single step so this api
564
is not really applicable except as a compatibility thunk
565
for older plugins that don't use e.g. the CommitBuilder
569
return self._real_repository.start_write_group()
571
def _unlock(self, token):
572
path = self.bzrdir._path_for_remote_call(self._client)
574
# with no token the remote repository is not persistently locked.
576
response = self._client.call('Repository.unlock', path, token)
577
if response == ('ok',):
579
elif response[0] == 'TokenMismatch':
580
raise errors.TokenMismatch(token, '(remote token)')
582
raise errors.UnexpectedSmartServerResponse(response)
585
self._lock_count -= 1
586
if self._lock_count > 0:
588
self._parents_map = None
589
if 'hpss' in debug.debug_flags:
590
self._requested_parents = None
591
old_mode = self._lock_mode
592
self._lock_mode = None
594
# The real repository is responsible at present for raising an
595
# exception if it's in an unfinished write group. However, it
596
# normally will *not* actually remove the lock from disk - that's
597
# done by the server on receiving the Repository.unlock call.
598
# This is just to let the _real_repository stay up to date.
599
if self._real_repository is not None:
600
self._real_repository.unlock()
602
# The rpc-level lock should be released even if there was a
603
# problem releasing the vfs-based lock.
605
# Only write-locked repositories need to make a remote method
606
# call to perfom the unlock.
607
old_token = self._lock_token
608
self._lock_token = None
609
if not self._leave_lock:
610
self._unlock(old_token)
612
def break_lock(self):
613
# should hand off to the network
615
return self._real_repository.break_lock()
617
def _get_tarball(self, compression):
618
"""Return a TemporaryFile containing a repository tarball.
620
Returns None if the server does not support sending tarballs.
623
path = self.bzrdir._path_for_remote_call(self._client)
624
response, protocol = self._client.call_expecting_body(
625
'Repository.tarball', path, compression)
626
if response[0] == 'ok':
627
# Extract the tarball and return it
628
t = tempfile.NamedTemporaryFile()
629
# TODO: rpc layer should read directly into it...
630
t.write(protocol.read_body_bytes())
633
if (response == ('error', "Generic bzr smart protocol error: "
634
"bad request 'Repository.tarball'") or
635
response == ('error', "Generic bzr smart protocol error: "
636
"bad request u'Repository.tarball'")):
637
protocol.cancel_read_body()
639
raise errors.UnexpectedSmartServerResponse(response)
641
def sprout(self, to_bzrdir, revision_id=None):
642
# TODO: Option to control what format is created?
644
dest_repo = self._real_repository._format.initialize(to_bzrdir,
646
dest_repo.fetch(self, revision_id=revision_id)
649
### These methods are just thin shims to the VFS object for now.
651
def revision_tree(self, revision_id):
653
return self._real_repository.revision_tree(revision_id)
655
def get_serializer_format(self):
657
return self._real_repository.get_serializer_format()
659
def get_commit_builder(self, branch, parents, config, timestamp=None,
660
timezone=None, committer=None, revprops=None,
662
# FIXME: It ought to be possible to call this without immediately
663
# triggering _ensure_real. For now it's the easiest thing to do.
665
builder = self._real_repository.get_commit_builder(branch, parents,
666
config, timestamp=timestamp, timezone=timezone,
667
committer=committer, revprops=revprops, revision_id=revision_id)
670
def add_inventory(self, revid, inv, parents):
672
return self._real_repository.add_inventory(revid, inv, parents)
674
def add_revision(self, rev_id, rev, inv=None, config=None):
676
return self._real_repository.add_revision(
677
rev_id, rev, inv=inv, config=config)
680
def get_inventory(self, revision_id):
682
return self._real_repository.get_inventory(revision_id)
684
def iter_inventories(self, revision_ids):
686
return self._real_repository.iter_inventories(revision_ids)
689
def get_revision(self, revision_id):
691
return self._real_repository.get_revision(revision_id)
694
def weave_store(self):
696
return self._real_repository.weave_store
698
def get_transaction(self):
700
return self._real_repository.get_transaction()
703
def clone(self, a_bzrdir, revision_id=None):
705
return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
707
def make_working_trees(self):
708
"""RemoteRepositories never create working trees by default."""
711
def revision_ids_to_search_result(self, result_set):
712
"""Convert a set of revision ids to a graph SearchResult."""
713
result_parents = set()
714
for parents in self.get_graph().get_parent_map(
715
result_set).itervalues():
716
result_parents.update(parents)
717
included_keys = result_set.intersection(result_parents)
718
start_keys = result_set.difference(included_keys)
719
exclude_keys = result_parents.difference(result_set)
720
result = graph.SearchResult(start_keys, exclude_keys,
721
len(result_set), result_set)
725
def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
726
"""Return the revision ids that other has that this does not.
728
These are returned in topological order.
730
revision_id: only return revision ids included by revision_id.
732
return repository.InterRepository.get(
733
other, self).search_missing_revision_ids(revision_id, find_ghosts)
735
def fetch(self, source, revision_id=None, pb=None):
736
if self.has_same_location(source):
737
# check that last_revision is in 'from' and then return a
739
if (revision_id is not None and
740
not revision.is_null(revision_id)):
741
self.get_revision(revision_id)
744
return self._real_repository.fetch(
745
source, revision_id=revision_id, pb=pb)
747
def create_bundle(self, target, base, fileobj, format=None):
749
self._real_repository.create_bundle(target, base, fileobj, format)
752
def control_weaves(self):
754
return self._real_repository.control_weaves
757
def get_ancestry(self, revision_id, topo_sorted=True):
759
return self._real_repository.get_ancestry(revision_id, topo_sorted)
762
def get_inventory_weave(self):
764
return self._real_repository.get_inventory_weave()
766
def fileids_altered_by_revision_ids(self, revision_ids):
768
return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
770
def _get_versioned_file_checker(self, revisions, revision_versions_cache):
772
return self._real_repository._get_versioned_file_checker(
773
revisions, revision_versions_cache)
775
def iter_files_bytes(self, desired_files):
776
"""See Repository.iter_file_bytes.
779
return self._real_repository.iter_files_bytes(desired_files)
781
def get_parent_map(self, keys):
782
"""See bzrlib.Graph.get_parent_map()."""
783
# Hack to build up the caching logic.
784
ancestry = self._parents_map
786
# Repository is not locked, so there's no cache.
787
missing_revisions = set(keys)
790
missing_revisions = set(key for key in keys if key not in ancestry)
791
if missing_revisions:
792
parent_map = self._get_parent_map(missing_revisions)
793
if 'hpss' in debug.debug_flags:
794
mutter('retransmitted revisions: %d of %d',
795
len(set(ancestry).intersection(parent_map)),
797
ancestry.update(parent_map)
798
present_keys = [k for k in keys if k in ancestry]
799
if 'hpss' in debug.debug_flags:
800
self._requested_parents.update(present_keys)
801
mutter('Current RemoteRepository graph hit rate: %d%%',
802
100.0 * len(self._requested_parents) / len(ancestry))
803
return dict((k, ancestry[k]) for k in present_keys)
805
def _response_is_unknown_method(self, response, verb):
806
"""Return True if response is an unknonwn method response to verb.
808
:param response: The response from a smart client call_expecting_body
810
:param verb: The verb used in that call.
811
:return: True if an unknown method was encountered.
813
# This might live better on
814
# bzrlib.smart.protocol.SmartClientRequestProtocolOne
815
if (response[0] == ('error', "Generic bzr smart protocol error: "
816
"bad request '%s'" % verb) or
817
response[0] == ('error', "Generic bzr smart protocol error: "
818
"bad request u'%s'" % verb)):
819
response[1].cancel_read_body()
823
def _get_parent_map(self, keys):
824
"""Helper for get_parent_map that performs the RPC."""
825
medium = self._client.get_smart_medium()
826
if not medium._remote_is_at_least_1_2:
827
# We already found out that the server can't understand
828
# Repository.get_parent_map requests, so just fetch the whole
830
return self.get_revision_graph()
833
if NULL_REVISION in keys:
834
keys.discard(NULL_REVISION)
835
found_parents = {NULL_REVISION:()}
840
# TODO(Needs analysis): We could assume that the keys being requested
841
# from get_parent_map are in a breadth first search, so typically they
842
# will all be depth N from some common parent, and we don't have to
843
# have the server iterate from the root parent, but rather from the
844
# keys we're searching; and just tell the server the keyspace we
845
# already have; but this may be more traffic again.
847
# Transform self._parents_map into a search request recipe.
848
# TODO: Manage this incrementally to avoid covering the same path
849
# repeatedly. (The server will have to on each request, but the less
850
# work done the better).
851
parents_map = self._parents_map
852
if parents_map is None:
853
# Repository is not locked, so there's no cache.
855
start_set = set(parents_map)
856
result_parents = set()
857
for parents in parents_map.itervalues():
858
result_parents.update(parents)
859
stop_keys = result_parents.difference(start_set)
860
included_keys = start_set.intersection(result_parents)
861
start_set.difference_update(included_keys)
862
recipe = (start_set, stop_keys, len(parents_map))
863
body = self._serialise_search_recipe(recipe)
864
path = self.bzrdir._path_for_remote_call(self._client)
866
assert type(key) is str
867
verb = 'Repository.get_parent_map'
868
args = (path,) + tuple(keys)
869
response = self._client.call_with_body_bytes_expecting_body(
870
verb, args, self._serialise_search_recipe(recipe))
871
if self._response_is_unknown_method(response, verb):
872
# Server does not support this method, so get the whole graph.
873
# Worse, we have to force a disconnection, because the server now
874
# doesn't realise it has a body on the wire to consume, so the
875
# only way to recover is to abandon the connection.
877
'Server is too old for fast get_parent_map, reconnecting. '
878
'(Upgrade the server to Bazaar 1.2 to avoid this)')
880
# To avoid having to disconnect repeatedly, we keep track of the
881
# fact the server doesn't understand remote methods added in 1.2.
882
medium._remote_is_at_least_1_2 = False
883
return self.get_revision_graph()
884
elif response[0][0] not in ['ok']:
885
reponse[1].cancel_read_body()
886
raise errors.UnexpectedSmartServerResponse(response[0])
887
if response[0][0] == 'ok':
888
coded = bz2.decompress(response[1].read_body_bytes())
892
lines = coded.split('\n')
895
d = tuple(line.split())
897
revision_graph[d[0]] = d[1:]
899
# No parents - so give the Graph result (NULL_REVISION,).
900
revision_graph[d[0]] = (NULL_REVISION,)
901
return revision_graph
904
def get_signature_text(self, revision_id):
906
return self._real_repository.get_signature_text(revision_id)
909
def get_revision_graph_with_ghosts(self, revision_ids=None):
911
return self._real_repository.get_revision_graph_with_ghosts(
912
revision_ids=revision_ids)
915
def get_inventory_xml(self, revision_id):
917
return self._real_repository.get_inventory_xml(revision_id)
919
def deserialise_inventory(self, revision_id, xml):
921
return self._real_repository.deserialise_inventory(revision_id, xml)
923
def reconcile(self, other=None, thorough=False):
925
return self._real_repository.reconcile(other=other, thorough=thorough)
927
def all_revision_ids(self):
929
return self._real_repository.all_revision_ids()
932
def get_deltas_for_revisions(self, revisions):
934
return self._real_repository.get_deltas_for_revisions(revisions)
937
def get_revision_delta(self, revision_id):
939
return self._real_repository.get_revision_delta(revision_id)
942
def revision_trees(self, revision_ids):
944
return self._real_repository.revision_trees(revision_ids)
947
def get_revision_reconcile(self, revision_id):
949
return self._real_repository.get_revision_reconcile(revision_id)
952
def check(self, revision_ids=None):
954
return self._real_repository.check(revision_ids=revision_ids)
956
def copy_content_into(self, destination, revision_id=None):
958
return self._real_repository.copy_content_into(
959
destination, revision_id=revision_id)
961
def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
962
# get a tarball of the remote repository, and copy from that into the
964
from bzrlib import osutils
967
# TODO: Maybe a progress bar while streaming the tarball?
968
note("Copying repository content as tarball...")
969
tar_file = self._get_tarball('bz2')
972
destination = to_bzrdir.create_repository()
974
tar = tarfile.open('repository', fileobj=tar_file,
976
tmpdir = tempfile.mkdtemp()
978
_extract_tar(tar, tmpdir)
979
tmp_bzrdir = BzrDir.open(tmpdir)
980
tmp_repo = tmp_bzrdir.open_repository()
981
tmp_repo.copy_content_into(destination, revision_id)
983
osutils.rmtree(tmpdir)
987
# TODO: Suggestion from john: using external tar is much faster than
988
# python's tarfile library, but it may not work on windows.
992
"""Compress the data within the repository.
994
This is not currently implemented within the smart server.
997
return self._real_repository.pack()
999
def set_make_working_trees(self, new_value):
1000
raise NotImplementedError(self.set_make_working_trees)
1003
def sign_revision(self, revision_id, gpg_strategy):
1005
return self._real_repository.sign_revision(revision_id, gpg_strategy)
1008
def get_revisions(self, revision_ids):
1010
return self._real_repository.get_revisions(revision_ids)
1012
def supports_rich_root(self):
1014
return self._real_repository.supports_rich_root()
1016
def iter_reverse_revision_history(self, revision_id):
1018
return self._real_repository.iter_reverse_revision_history(revision_id)
1021
def _serializer(self):
1023
return self._real_repository._serializer
1025
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1027
return self._real_repository.store_revision_signature(
1028
gpg_strategy, plaintext, revision_id)
1030
def add_signature_text(self, revision_id, signature):
1032
return self._real_repository.add_signature_text(revision_id, signature)
1034
def has_signature_for_revision_id(self, revision_id):
1036
return self._real_repository.has_signature_for_revision_id(revision_id)
1038
def get_data_stream_for_search(self, search):
1039
medium = self._client.get_smart_medium()
1040
if not medium._remote_is_at_least_1_2:
1042
return self._real_repository.get_data_stream_for_search(search)
1043
REQUEST_NAME = 'Repository.stream_revisions_chunked'
1044
path = self.bzrdir._path_for_remote_call(self._client)
1045
body = self._serialise_search_recipe(search.get_recipe())
1046
response, protocol = self._client.call_with_body_bytes_expecting_body(
1047
REQUEST_NAME, (path,), body)
1049
if self._response_is_unknown_method((response, protocol), REQUEST_NAME):
1050
# Server does not support this method, so fall back to VFS.
1051
# Worse, we have to force a disconnection, because the server now
1052
# doesn't realise it has a body on the wire to consume, so the
1053
# only way to recover is to abandon the connection.
1055
'Server is too old for streaming pull, reconnecting. '
1056
'(Upgrade the server to Bazaar 1.2 to avoid this)')
1058
# To avoid having to disconnect repeatedly, we keep track of the
1059
# fact the server doesn't understand this remote method.
1060
medium._remote_is_at_least_1_2 = False
1062
return self._real_repository.get_data_stream_for_search(search)
1064
if response == ('ok',):
1065
return self._deserialise_stream(protocol)
1066
if response == ('NoSuchRevision', ):
1067
# We cannot easily identify the revision that is missing in this
1068
# situation without doing much more network IO. For now, bail.
1069
raise NoSuchRevision(self, "unknown")
1071
raise errors.UnexpectedSmartServerResponse(response)
1073
def _deserialise_stream(self, protocol):
1074
stream = protocol.read_streamed_body()
1075
container_parser = ContainerPushParser()
1076
for bytes in stream:
1077
container_parser.accept_bytes(bytes)
1078
records = container_parser.read_pending_records()
1079
for record_names, record_bytes in records:
1080
if len(record_names) != 1:
1081
# These records should have only one name, and that name
1082
# should be a one-element tuple.
1083
raise errors.SmartProtocolError(
1084
'Repository data stream had invalid record name %r'
1086
name_tuple = record_names[0]
1087
yield name_tuple, record_bytes
1089
def insert_data_stream(self, stream):
1091
self._real_repository.insert_data_stream(stream)
1093
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
1095
return self._real_repository.item_keys_introduced_by(revision_ids,
1096
_files_pb=_files_pb)
1098
def revision_graph_can_have_wrong_parents(self):
1099
# The answer depends on the remote repo format.
1101
return self._real_repository.revision_graph_can_have_wrong_parents()
1103
def _find_inconsistent_revision_parents(self):
1105
return self._real_repository._find_inconsistent_revision_parents()
1107
def _check_for_inconsistent_revision_parents(self):
1109
return self._real_repository._check_for_inconsistent_revision_parents()
1111
def _make_parents_provider(self):
1114
def _serialise_search_recipe(self, recipe):
1115
"""Serialise a graph search recipe.
1117
:param recipe: A search recipe (start, stop, count).
1118
:return: Serialised bytes.
1120
start_keys = ' '.join(recipe[0])
1121
stop_keys = ' '.join(recipe[1])
1122
count = str(recipe[2])
1123
return '\n'.join((start_keys, stop_keys, count))
1126
class RemoteBranchLockableFiles(LockableFiles):
1127
"""A 'LockableFiles' implementation that talks to a smart server.
1129
This is not a public interface class.
1132
def __init__(self, bzrdir, _client):
1133
self.bzrdir = bzrdir
1134
self._client = _client
1135
self._need_find_modes = True
1136
LockableFiles.__init__(
1137
self, bzrdir.get_branch_transport(None),
1138
'lock', lockdir.LockDir)
1140
def _find_modes(self):
1141
# RemoteBranches don't let the client set the mode of control files.
1142
self._dir_mode = None
1143
self._file_mode = None
1145
def get(self, path):
1146
"""'get' a remote path as per the LockableFiles interface.
1148
:param path: the file to 'get'. If this is 'branch.conf', we do not
1149
just retrieve a file, instead we ask the smart server to generate
1150
a configuration for us - which is retrieved as an INI file.
1152
if path == 'branch.conf':
1153
path = self.bzrdir._path_for_remote_call(self._client)
1154
response = self._client.call_expecting_body(
1155
'Branch.get_config_file', path)
1156
assert response[0][0] == 'ok', \
1157
'unexpected response code %s' % (response[0],)
1158
return StringIO(response[1].read_body_bytes())
1161
return LockableFiles.get(self, path)
1164
class RemoteBranchFormat(branch.BranchFormat):
1166
def __eq__(self, other):
1167
return (isinstance(other, RemoteBranchFormat) and
1168
self.__dict__ == other.__dict__)
1170
def get_format_description(self):
1171
return 'Remote BZR Branch'
1173
def get_format_string(self):
1174
return 'Remote BZR Branch'
1176
def open(self, a_bzrdir):
1177
assert isinstance(a_bzrdir, RemoteBzrDir)
1178
return a_bzrdir.open_branch()
1180
def initialize(self, a_bzrdir):
1181
assert isinstance(a_bzrdir, RemoteBzrDir)
1182
return a_bzrdir.create_branch()
1184
def supports_tags(self):
1185
# Remote branches might support tags, but we won't know until we
1186
# access the real remote branch.
1190
class RemoteBranch(branch.Branch):
1191
"""Branch stored on a server accessed by HPSS RPC.
1193
At the moment most operations are mapped down to simple file operations.
1196
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
1198
"""Create a RemoteBranch instance.
1200
:param real_branch: An optional local implementation of the branch
1201
format, usually accessing the data via the VFS.
1202
:param _client: Private parameter for testing.
1204
# We intentionally don't call the parent class's __init__, because it
1205
# will try to assign to self.tags, which is a property in this subclass.
1206
# And the parent's __init__ doesn't do much anyway.
1207
self._revision_id_to_revno_cache = None
1208
self._revision_history_cache = None
1209
self.bzrdir = remote_bzrdir
1210
if _client is not None:
1211
self._client = _client
1213
self._client = client._SmartClient(self.bzrdir._shared_medium)
1214
self.repository = remote_repository
1215
if real_branch is not None:
1216
self._real_branch = real_branch
1217
# Give the remote repository the matching real repo.
1218
real_repo = self._real_branch.repository
1219
if isinstance(real_repo, RemoteRepository):
1220
real_repo._ensure_real()
1221
real_repo = real_repo._real_repository
1222
self.repository._set_real_repository(real_repo)
1223
# Give the branch the remote repository to let fast-pathing happen.
1224
self._real_branch.repository = self.repository
1226
self._real_branch = None
1227
# Fill out expected attributes of branch for bzrlib api users.
1228
self._format = RemoteBranchFormat()
1229
self.base = self.bzrdir.root_transport.base
1230
self._control_files = None
1231
self._lock_mode = None
1232
self._lock_token = None
1233
self._lock_count = 0
1234
self._leave_lock = False
1237
return "%s(%s)" % (self.__class__.__name__, self.base)
1241
def _ensure_real(self):
1242
"""Ensure that there is a _real_branch set.
1244
Used before calls to self._real_branch.
1246
if not self._real_branch:
1247
assert vfs.vfs_enabled()
1248
self.bzrdir._ensure_real()
1249
self._real_branch = self.bzrdir._real_bzrdir.open_branch()
1250
# Give the remote repository the matching real repo.
1251
real_repo = self._real_branch.repository
1252
if isinstance(real_repo, RemoteRepository):
1253
real_repo._ensure_real()
1254
real_repo = real_repo._real_repository
1255
self.repository._set_real_repository(real_repo)
1256
# Give the branch the remote repository to let fast-pathing happen.
1257
self._real_branch.repository = self.repository
1258
# XXX: deal with _lock_mode == 'w'
1259
if self._lock_mode == 'r':
1260
self._real_branch.lock_read()
1263
def control_files(self):
1264
# Defer actually creating RemoteBranchLockableFiles until its needed,
1265
# because it triggers an _ensure_real that we otherwise might not need.
1266
if self._control_files is None:
1267
self._control_files = RemoteBranchLockableFiles(
1268
self.bzrdir, self._client)
1269
return self._control_files
1271
def _get_checkout_format(self):
1273
return self._real_branch._get_checkout_format()
1275
def get_physical_lock_status(self):
1276
"""See Branch.get_physical_lock_status()."""
1277
# should be an API call to the server, as branches must be lockable.
1279
return self._real_branch.get_physical_lock_status()
1281
def lock_read(self):
1282
if not self._lock_mode:
1283
self._lock_mode = 'r'
1284
self._lock_count = 1
1285
if self._real_branch is not None:
1286
self._real_branch.lock_read()
1288
self._lock_count += 1
1290
def _remote_lock_write(self, token):
1292
branch_token = repo_token = ''
1294
branch_token = token
1295
repo_token = self.repository.lock_write()
1296
self.repository.unlock()
1297
path = self.bzrdir._path_for_remote_call(self._client)
1298
response = self._client.call('Branch.lock_write', path, branch_token,
1300
if response[0] == 'ok':
1301
ok, branch_token, repo_token = response
1302
return branch_token, repo_token
1303
elif response[0] == 'LockContention':
1304
raise errors.LockContention('(remote lock)')
1305
elif response[0] == 'TokenMismatch':
1306
raise errors.TokenMismatch(token, '(remote token)')
1307
elif response[0] == 'UnlockableTransport':
1308
raise errors.UnlockableTransport(self.bzrdir.root_transport)
1309
elif response[0] == 'ReadOnlyError':
1310
raise errors.ReadOnlyError(self)
1311
elif response[0] == 'LockFailed':
1312
raise errors.LockFailed(response[1], response[2])
1314
raise errors.UnexpectedSmartServerResponse(response)
1316
def lock_write(self, token=None):
1317
if not self._lock_mode:
1318
remote_tokens = self._remote_lock_write(token)
1319
self._lock_token, self._repo_lock_token = remote_tokens
1320
assert self._lock_token, 'Remote server did not return a token!'
1321
# TODO: We really, really, really don't want to call _ensure_real
1322
# here, but it's the easiest way to ensure coherency between the
1323
# state of the RemoteBranch and RemoteRepository objects and the
1324
# physical locks. If we don't materialise the real objects here,
1325
# then getting everything in the right state later is complex, so
1326
# for now we just do it the lazy way.
1327
# -- Andrew Bennetts, 2007-02-22.
1329
if self._real_branch is not None:
1330
self._real_branch.repository.lock_write(
1331
token=self._repo_lock_token)
1333
self._real_branch.lock_write(token=self._lock_token)
1335
self._real_branch.repository.unlock()
1336
if token is not None:
1337
self._leave_lock = True
1339
# XXX: this case seems to be unreachable; token cannot be None.
1340
self._leave_lock = False
1341
self._lock_mode = 'w'
1342
self._lock_count = 1
1343
elif self._lock_mode == 'r':
1344
raise errors.ReadOnlyTransaction
1346
if token is not None:
1347
# A token was given to lock_write, and we're relocking, so check
1348
# that the given token actually matches the one we already have.
1349
if token != self._lock_token:
1350
raise errors.TokenMismatch(token, self._lock_token)
1351
self._lock_count += 1
1352
return self._lock_token or None
1354
def _unlock(self, branch_token, repo_token):
1355
path = self.bzrdir._path_for_remote_call(self._client)
1356
response = self._client.call('Branch.unlock', path, branch_token,
1358
if response == ('ok',):
1360
elif response[0] == 'TokenMismatch':
1361
raise errors.TokenMismatch(
1362
str((branch_token, repo_token)), '(remote tokens)')
1364
raise errors.UnexpectedSmartServerResponse(response)
1367
self._lock_count -= 1
1368
if not self._lock_count:
1369
self._clear_cached_state()
1370
mode = self._lock_mode
1371
self._lock_mode = None
1372
if self._real_branch is not None:
1373
if (not self._leave_lock and mode == 'w' and
1374
self._repo_lock_token):
1375
# If this RemoteBranch will remove the physical lock for the
1376
# repository, make sure the _real_branch doesn't do it
1377
# first. (Because the _real_branch's repository is set to
1378
# be the RemoteRepository.)
1379
self._real_branch.repository.leave_lock_in_place()
1380
self._real_branch.unlock()
1382
# Only write-locked branched need to make a remote method call
1383
# to perfom the unlock.
1385
assert self._lock_token, 'Locked, but no token!'
1386
branch_token = self._lock_token
1387
repo_token = self._repo_lock_token
1388
self._lock_token = None
1389
self._repo_lock_token = None
1390
if not self._leave_lock:
1391
self._unlock(branch_token, repo_token)
1393
def break_lock(self):
1395
return self._real_branch.break_lock()
1397
def leave_lock_in_place(self):
1398
if not self._lock_token:
1399
raise NotImplementedError(self.leave_lock_in_place)
1400
self._leave_lock = True
1402
def dont_leave_lock_in_place(self):
1403
if not self._lock_token:
1404
raise NotImplementedError(self.dont_leave_lock_in_place)
1405
self._leave_lock = False
1407
def last_revision_info(self):
1408
"""See Branch.last_revision_info()."""
1409
path = self.bzrdir._path_for_remote_call(self._client)
1410
response = self._client.call('Branch.last_revision_info', path)
1411
assert response[0] == 'ok', 'unexpected response code %s' % (response,)
1412
revno = int(response[1])
1413
last_revision = response[2]
1414
return (revno, last_revision)
1416
def _gen_revision_history(self):
1417
"""See Branch._gen_revision_history()."""
1418
path = self.bzrdir._path_for_remote_call(self._client)
1419
response = self._client.call_expecting_body(
1420
'Branch.revision_history', path)
1421
assert response[0][0] == 'ok', ('unexpected response code %s'
1423
result = response[1].read_body_bytes().split('\x00')
1429
def set_revision_history(self, rev_history):
1430
# Send just the tip revision of the history; the server will generate
1431
# the full history from that. If the revision doesn't exist in this
1432
# branch, NoSuchRevision will be raised.
1433
path = self.bzrdir._path_for_remote_call(self._client)
1434
if rev_history == []:
1437
rev_id = rev_history[-1]
1438
self._clear_cached_state()
1439
response = self._client.call('Branch.set_last_revision',
1440
path, self._lock_token, self._repo_lock_token, rev_id)
1441
if response[0] == 'NoSuchRevision':
1442
raise NoSuchRevision(self, rev_id)
1444
assert response == ('ok',), (
1445
'unexpected response code %r' % (response,))
1446
self._cache_revision_history(rev_history)
1448
def get_parent(self):
1450
return self._real_branch.get_parent()
1452
def set_parent(self, url):
1454
return self._real_branch.set_parent(url)
1456
def get_config(self):
1457
return RemoteBranchConfig(self)
1459
def sprout(self, to_bzrdir, revision_id=None):
1460
# Like Branch.sprout, except that it sprouts a branch in the default
1461
# format, because RemoteBranches can't be created at arbitrary URLs.
1462
# XXX: if to_bzrdir is a RemoteBranch, this should perhaps do
1463
# to_bzrdir.create_branch...
1465
result = self._real_branch._format.initialize(to_bzrdir)
1466
self.copy_content_into(result, revision_id=revision_id)
1467
result.set_parent(self.bzrdir.root_transport.base)
1471
def pull(self, source, overwrite=False, stop_revision=None,
1473
# FIXME: This asks the real branch to run the hooks, which means
1474
# they're called with the wrong target branch parameter.
1475
# The test suite specifically allows this at present but it should be
1476
# fixed. It should get a _override_hook_target branch,
1477
# as push does. -- mbp 20070405
1479
self._real_branch.pull(
1480
source, overwrite=overwrite, stop_revision=stop_revision,
1484
def push(self, target, overwrite=False, stop_revision=None):
1486
return self._real_branch.push(
1487
target, overwrite=overwrite, stop_revision=stop_revision,
1488
_override_hook_source_branch=self)
1490
def is_locked(self):
1491
return self._lock_count >= 1
1493
def set_last_revision_info(self, revno, revision_id):
1495
self._clear_cached_state()
1496
return self._real_branch.set_last_revision_info(revno, revision_id)
1498
def generate_revision_history(self, revision_id, last_rev=None,
1501
return self._real_branch.generate_revision_history(
1502
revision_id, last_rev=last_rev, other_branch=other_branch)
1507
return self._real_branch.tags
1509
def set_push_location(self, location):
1511
return self._real_branch.set_push_location(location)
1513
def update_revisions(self, other, stop_revision=None, overwrite=False):
1515
return self._real_branch.update_revisions(
1516
other, stop_revision=stop_revision, overwrite=overwrite)
1519
class RemoteBranchConfig(BranchConfig):
1522
self.branch._ensure_real()
1523
return self.branch._real_branch.get_config().username()
1525
def _get_branch_data_config(self):
1526
self.branch._ensure_real()
1527
if self._branch_data_config is None:
1528
self._branch_data_config = TreeConfig(self.branch._real_branch)
1529
return self._branch_data_config
1532
def _extract_tar(tar, to_dir):
1533
"""Extract all the contents of a tarfile object.
1535
A replacement for extractall, which is not present in python2.4
1538
tar.extract(tarinfo, to_dir)
added
removed
bzrlib/remote.py
