1
# Copyright (C) 2006, 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
# TODO: At some point, handle upgrades by just passing the whole request
18
# across to run on the server.
21
from cStringIO import StringIO
33
from bzrlib.branch import BranchReferenceFormat
34
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
35
from bzrlib.config import BranchConfig, TreeConfig
36
from bzrlib.decorators import needs_read_lock, needs_write_lock
37
from bzrlib.errors import NoSuchRevision
38
from bzrlib.lockable_files import LockableFiles
39
from bzrlib.pack import ContainerPushParser
40
from bzrlib.smart import client, vfs
41
from bzrlib.symbol_versioning import (
45
from bzrlib.revision import NULL_REVISION
46
from bzrlib.trace import mutter, note, warning
48
# Note: RemoteBzrDirFormat is in bzrdir.py
50
class RemoteBzrDir(BzrDir):
51
"""Control directory on a remote server, accessed via bzr:// or similar."""
53
def __init__(self, transport, _client=None):
54
"""Construct a RemoteBzrDir.
56
:param _client: Private parameter for testing. Disables probing and the
59
BzrDir.__init__(self, transport, RemoteBzrDirFormat())
60
# this object holds a delegated bzrdir that uses file-level operations
61
# to talk to the other side
62
self._real_bzrdir = None
65
medium = transport.get_smart_medium()
66
self._client = client._SmartClient(medium, transport.base)
68
self._client = _client
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'
153
response = self._client.call(verb, path)
154
except errors.UnknownSmartMethod:
155
verb = 'BzrDir.find_repository'
156
response = self._client.call(verb, path)
157
assert response[0] in ('ok', 'norepository'), \
158
'unexpected response code %s' % (response,)
159
if response[0] == 'norepository':
160
raise errors.NoRepositoryPresent(self)
161
if verb == 'BzrDir.find_repository':
162
# servers that don't support the V2 method don't support external
164
response = response + ('no', )
165
assert len(response) == 5, 'incorrect response length %s' % (response,)
166
if response[1] == '':
167
format = RemoteRepositoryFormat()
168
format.rich_root_data = (response[2] == 'yes')
169
format.supports_tree_reference = (response[3] == 'yes')
170
# No wire format to check this yet.
171
format.supports_external_lookups = (response[4] == 'yes')
172
return RemoteRepository(self, format)
174
raise errors.NoRepositoryPresent(self)
176
def open_workingtree(self, recommend_upgrade=True):
178
if self._real_bzrdir.has_workingtree():
179
raise errors.NotLocalUrl(self.root_transport)
181
raise errors.NoWorkingTree(self.root_transport.base)
183
def _path_for_remote_call(self, client):
184
"""Return the path to be used for this bzrdir in a remote call."""
185
return client.remote_path_from_transport(self.root_transport)
187
def get_branch_transport(self, branch_format):
189
return self._real_bzrdir.get_branch_transport(branch_format)
191
def get_repository_transport(self, repository_format):
193
return self._real_bzrdir.get_repository_transport(repository_format)
195
def get_workingtree_transport(self, workingtree_format):
197
return self._real_bzrdir.get_workingtree_transport(workingtree_format)
199
def can_convert_format(self):
200
"""Upgrading of remote bzrdirs is not supported yet."""
203
def needs_format_conversion(self, format=None):
204
"""Upgrading of remote bzrdirs is not supported yet."""
207
def clone(self, url, revision_id=None, force_new_repo=False):
209
return self._real_bzrdir.clone(url, revision_id=revision_id,
210
force_new_repo=force_new_repo)
213
class RemoteRepositoryFormat(repository.RepositoryFormat):
214
"""Format for repositories accessed over a _SmartClient.
216
Instances of this repository are represented by RemoteRepository
219
The RemoteRepositoryFormat is parameterized during construction
220
to reflect the capabilities of the real, remote format. Specifically
221
the attributes rich_root_data and supports_tree_reference are set
222
on a per instance basis, and are not set (and should not be) at
226
_matchingbzrdir = RemoteBzrDirFormat
228
def initialize(self, a_bzrdir, shared=False):
229
assert isinstance(a_bzrdir, RemoteBzrDir), \
230
'%r is not a RemoteBzrDir' % (a_bzrdir,)
231
return a_bzrdir.create_repository(shared=shared)
233
def open(self, a_bzrdir):
234
assert isinstance(a_bzrdir, RemoteBzrDir)
235
return a_bzrdir.open_repository()
237
def get_format_description(self):
238
return 'bzr remote repository'
240
def __eq__(self, other):
241
return self.__class__ == other.__class__
243
def check_conversion_target(self, target_format):
244
if self.rich_root_data and not target_format.rich_root_data:
245
raise errors.BadConversionTarget(
246
'Does not support rich root data.', target_format)
247
if (self.supports_tree_reference and
248
not getattr(target_format, 'supports_tree_reference', False)):
249
raise errors.BadConversionTarget(
250
'Does not support nested trees', target_format)
253
class RemoteRepository(object):
254
"""Repository accessed over rpc.
256
For the moment most operations are performed using local transport-backed
260
def __init__(self, remote_bzrdir, format, real_repository=None, _client=None):
261
"""Create a RemoteRepository instance.
263
:param remote_bzrdir: The bzrdir hosting this repository.
264
:param format: The RemoteFormat object to use.
265
:param real_repository: If not None, a local implementation of the
266
repository logic for the repository, usually accessing the data
268
:param _client: Private testing parameter - override the smart client
269
to be used by the repository.
272
self._real_repository = real_repository
274
self._real_repository = None
275
self.bzrdir = remote_bzrdir
277
self._client = remote_bzrdir._client
279
self._client = _client
280
self._format = format
281
self._lock_mode = None
282
self._lock_token = None
284
self._leave_lock = False
285
# A cache of looked up revision parent data; reset at unlock time.
286
self._parents_map = None
287
if 'hpss' in debug.debug_flags:
288
self._requested_parents = None
290
# These depend on the actual remote format, so force them off for
291
# maximum compatibility. XXX: In future these should depend on the
292
# remote repository instance, but this is irrelevant until we perform
293
# reconcile via an RPC call.
294
self._reconcile_does_inventory_gc = False
295
self._reconcile_fixes_text_parents = False
296
self._reconcile_backsup_inventory = False
297
self.base = self.bzrdir.transport.base
300
return "%s(%s)" % (self.__class__.__name__, self.base)
304
def abort_write_group(self):
305
"""Complete a write group on the decorated repository.
307
Smart methods peform operations in a single step so this api
308
is not really applicable except as a compatibility thunk
309
for older plugins that don't use e.g. the CommitBuilder
313
return self._real_repository.abort_write_group()
315
def commit_write_group(self):
316
"""Complete a write group on the decorated repository.
318
Smart methods peform operations in a single step so this api
319
is not really applicable except as a compatibility thunk
320
for older plugins that don't use e.g. the CommitBuilder
324
return self._real_repository.commit_write_group()
326
def _ensure_real(self):
327
"""Ensure that there is a _real_repository set.
329
Used before calls to self._real_repository.
331
if not self._real_repository:
332
self.bzrdir._ensure_real()
333
#self._real_repository = self.bzrdir._real_bzrdir.open_repository()
334
self._set_real_repository(self.bzrdir._real_bzrdir.open_repository())
336
def find_text_key_references(self):
337
"""Find the text key references within the repository.
339
:return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
340
revision_ids. Each altered file-ids has the exact revision_ids that
341
altered it listed explicitly.
342
:return: A dictionary mapping text keys ((fileid, revision_id) tuples)
343
to whether they were referred to by the inventory of the
344
revision_id that they contain. The inventory texts from all present
345
revision ids are assessed to generate this report.
348
return self._real_repository.find_text_key_references()
350
def _generate_text_key_index(self):
351
"""Generate a new text key index for the repository.
353
This is an expensive function that will take considerable time to run.
355
:return: A dict mapping (file_id, revision_id) tuples to a list of
356
parents, also (file_id, revision_id) tuples.
359
return self._real_repository._generate_text_key_index()
361
@symbol_versioning.deprecated_method(symbol_versioning.one_four)
362
def get_revision_graph(self, revision_id=None):
363
"""See Repository.get_revision_graph()."""
364
return self._get_revision_graph(revision_id)
366
def _get_revision_graph(self, revision_id):
367
"""Private method for using with old (< 1.2) servers to fallback."""
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)
636
response, protocol = self._client.call_expecting_body(
637
'Repository.tarball', path, compression)
638
except errors.UnknownSmartMethod:
639
protocol.cancel_read_body()
641
if response[0] == 'ok':
642
# Extract the tarball and return it
643
t = tempfile.NamedTemporaryFile()
644
# TODO: rpc layer should read directly into it...
645
t.write(protocol.read_body_bytes())
648
raise errors.UnexpectedSmartServerResponse(response)
650
def sprout(self, to_bzrdir, revision_id=None):
651
# TODO: Option to control what format is created?
653
dest_repo = self._real_repository._format.initialize(to_bzrdir,
655
dest_repo.fetch(self, revision_id=revision_id)
658
### These methods are just thin shims to the VFS object for now.
660
def revision_tree(self, revision_id):
662
return self._real_repository.revision_tree(revision_id)
664
def get_serializer_format(self):
666
return self._real_repository.get_serializer_format()
668
def get_commit_builder(self, branch, parents, config, timestamp=None,
669
timezone=None, committer=None, revprops=None,
671
# FIXME: It ought to be possible to call this without immediately
672
# triggering _ensure_real. For now it's the easiest thing to do.
674
builder = self._real_repository.get_commit_builder(branch, parents,
675
config, timestamp=timestamp, timezone=timezone,
676
committer=committer, revprops=revprops, revision_id=revision_id)
679
def add_inventory(self, revid, inv, parents):
681
return self._real_repository.add_inventory(revid, inv, parents)
683
def add_revision(self, rev_id, rev, inv=None, config=None):
685
return self._real_repository.add_revision(
686
rev_id, rev, inv=inv, config=config)
689
def get_inventory(self, revision_id):
691
return self._real_repository.get_inventory(revision_id)
693
def iter_inventories(self, revision_ids):
695
return self._real_repository.iter_inventories(revision_ids)
698
def get_revision(self, revision_id):
700
return self._real_repository.get_revision(revision_id)
703
def weave_store(self):
705
return self._real_repository.weave_store
707
def get_transaction(self):
709
return self._real_repository.get_transaction()
712
def clone(self, a_bzrdir, revision_id=None):
714
return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
716
def make_working_trees(self):
717
"""RemoteRepositories never create working trees by default."""
720
def revision_ids_to_search_result(self, result_set):
721
"""Convert a set of revision ids to a graph SearchResult."""
722
result_parents = set()
723
for parents in self.get_graph().get_parent_map(
724
result_set).itervalues():
725
result_parents.update(parents)
726
included_keys = result_set.intersection(result_parents)
727
start_keys = result_set.difference(included_keys)
728
exclude_keys = result_parents.difference(result_set)
729
result = graph.SearchResult(start_keys, exclude_keys,
730
len(result_set), result_set)
734
def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
735
"""Return the revision ids that other has that this does not.
737
These are returned in topological order.
739
revision_id: only return revision ids included by revision_id.
741
return repository.InterRepository.get(
742
other, self).search_missing_revision_ids(revision_id, find_ghosts)
744
def fetch(self, source, revision_id=None, pb=None):
745
if self.has_same_location(source):
746
# check that last_revision is in 'from' and then return a
748
if (revision_id is not None and
749
not revision.is_null(revision_id)):
750
self.get_revision(revision_id)
753
return self._real_repository.fetch(
754
source, revision_id=revision_id, pb=pb)
756
def create_bundle(self, target, base, fileobj, format=None):
758
self._real_repository.create_bundle(target, base, fileobj, format)
761
def control_weaves(self):
763
return self._real_repository.control_weaves
766
def get_ancestry(self, revision_id, topo_sorted=True):
768
return self._real_repository.get_ancestry(revision_id, topo_sorted)
771
def get_inventory_weave(self):
773
return self._real_repository.get_inventory_weave()
775
def fileids_altered_by_revision_ids(self, revision_ids):
777
return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
779
def _get_versioned_file_checker(self, revisions, revision_versions_cache):
781
return self._real_repository._get_versioned_file_checker(
782
revisions, revision_versions_cache)
784
def iter_files_bytes(self, desired_files):
785
"""See Repository.iter_file_bytes.
788
return self._real_repository.iter_files_bytes(desired_files)
790
def get_parent_map(self, keys):
791
"""See bzrlib.Graph.get_parent_map()."""
792
# Hack to build up the caching logic.
793
ancestry = self._parents_map
795
# Repository is not locked, so there's no cache.
796
missing_revisions = set(keys)
799
missing_revisions = set(key for key in keys if key not in ancestry)
800
if missing_revisions:
801
parent_map = self._get_parent_map(missing_revisions)
802
if 'hpss' in debug.debug_flags:
803
mutter('retransmitted revisions: %d of %d',
804
len(set(ancestry).intersection(parent_map)),
806
ancestry.update(parent_map)
807
present_keys = [k for k in keys if k in ancestry]
808
if 'hpss' in debug.debug_flags:
809
self._requested_parents.update(present_keys)
810
mutter('Current RemoteRepository graph hit rate: %d%%',
811
100.0 * len(self._requested_parents) / len(ancestry))
812
return dict((k, ancestry[k]) for k in present_keys)
814
def _get_parent_map(self, keys):
815
"""Helper for get_parent_map that performs the RPC."""
816
medium = self._client._medium
817
if not medium._remote_is_at_least_1_2:
818
# We already found out that the server can't understand
819
# Repository.get_parent_map requests, so just fetch the whole
821
# XXX: Note that this will issue a deprecation warning. This is ok
822
# :- its because we're working with a deprecated server anyway, and
823
# the user will almost certainly have seen a warning about the
824
# server version already.
825
return self.get_revision_graph()
828
if NULL_REVISION in keys:
829
keys.discard(NULL_REVISION)
830
found_parents = {NULL_REVISION:()}
835
# TODO(Needs analysis): We could assume that the keys being requested
836
# from get_parent_map are in a breadth first search, so typically they
837
# will all be depth N from some common parent, and we don't have to
838
# have the server iterate from the root parent, but rather from the
839
# keys we're searching; and just tell the server the keyspace we
840
# already have; but this may be more traffic again.
842
# Transform self._parents_map into a search request recipe.
843
# TODO: Manage this incrementally to avoid covering the same path
844
# repeatedly. (The server will have to on each request, but the less
845
# work done the better).
846
parents_map = self._parents_map
847
if parents_map is None:
848
# Repository is not locked, so there's no cache.
850
start_set = set(parents_map)
851
result_parents = set()
852
for parents in parents_map.itervalues():
853
result_parents.update(parents)
854
stop_keys = result_parents.difference(start_set)
855
included_keys = start_set.intersection(result_parents)
856
start_set.difference_update(included_keys)
857
recipe = (start_set, stop_keys, len(parents_map))
858
body = self._serialise_search_recipe(recipe)
859
path = self.bzrdir._path_for_remote_call(self._client)
861
assert type(key) is str
862
verb = 'Repository.get_parent_map'
863
args = (path,) + tuple(keys)
865
response = self._client.call_with_body_bytes_expecting_body(
866
verb, args, self._serialise_search_recipe(recipe))
867
except errors.UnknownSmartMethod:
868
# Server does not support this method, so get the whole graph.
869
# Worse, we have to force a disconnection, because the server now
870
# doesn't realise it has a body on the wire to consume, so the
871
# only way to recover is to abandon the connection.
873
'Server is too old for fast get_parent_map, reconnecting. '
874
'(Upgrade the server to Bazaar 1.2 to avoid this)')
876
# To avoid having to disconnect repeatedly, we keep track of the
877
# fact the server doesn't understand remote methods added in 1.2.
878
medium._remote_is_at_least_1_2 = False
879
return self.get_revision_graph(None)
880
if response[0][0] not in ['ok']:
881
response[1].cancel_read_body()
882
raise errors.UnexpectedSmartServerResponse(response[0])
883
if response[0][0] == 'ok':
884
coded = bz2.decompress(response[1].read_body_bytes())
888
lines = coded.split('\n')
891
d = tuple(line.split())
893
revision_graph[d[0]] = d[1:]
895
# No parents - so give the Graph result (NULL_REVISION,).
896
revision_graph[d[0]] = (NULL_REVISION,)
897
return revision_graph
900
def get_signature_text(self, revision_id):
902
return self._real_repository.get_signature_text(revision_id)
905
@symbol_versioning.deprecated_method(symbol_versioning.one_three)
906
def get_revision_graph_with_ghosts(self, revision_ids=None):
908
return self._real_repository.get_revision_graph_with_ghosts(
909
revision_ids=revision_ids)
912
def get_inventory_xml(self, revision_id):
914
return self._real_repository.get_inventory_xml(revision_id)
916
def deserialise_inventory(self, revision_id, xml):
918
return self._real_repository.deserialise_inventory(revision_id, xml)
920
def reconcile(self, other=None, thorough=False):
922
return self._real_repository.reconcile(other=other, thorough=thorough)
924
def all_revision_ids(self):
926
return self._real_repository.all_revision_ids()
929
def get_deltas_for_revisions(self, revisions):
931
return self._real_repository.get_deltas_for_revisions(revisions)
934
def get_revision_delta(self, revision_id):
936
return self._real_repository.get_revision_delta(revision_id)
939
def revision_trees(self, revision_ids):
941
return self._real_repository.revision_trees(revision_ids)
944
def get_revision_reconcile(self, revision_id):
946
return self._real_repository.get_revision_reconcile(revision_id)
949
def check(self, revision_ids=None):
951
return self._real_repository.check(revision_ids=revision_ids)
953
def copy_content_into(self, destination, revision_id=None):
955
return self._real_repository.copy_content_into(
956
destination, revision_id=revision_id)
958
def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
959
# get a tarball of the remote repository, and copy from that into the
961
from bzrlib import osutils
964
# TODO: Maybe a progress bar while streaming the tarball?
965
note("Copying repository content as tarball...")
966
tar_file = self._get_tarball('bz2')
969
destination = to_bzrdir.create_repository()
971
tar = tarfile.open('repository', fileobj=tar_file,
973
tmpdir = tempfile.mkdtemp()
975
_extract_tar(tar, tmpdir)
976
tmp_bzrdir = BzrDir.open(tmpdir)
977
tmp_repo = tmp_bzrdir.open_repository()
978
tmp_repo.copy_content_into(destination, revision_id)
980
osutils.rmtree(tmpdir)
984
# TODO: Suggestion from john: using external tar is much faster than
985
# python's tarfile library, but it may not work on windows.
989
"""Compress the data within the repository.
991
This is not currently implemented within the smart server.
994
return self._real_repository.pack()
996
def set_make_working_trees(self, new_value):
997
raise NotImplementedError(self.set_make_working_trees)
1000
def sign_revision(self, revision_id, gpg_strategy):
1002
return self._real_repository.sign_revision(revision_id, gpg_strategy)
1005
def get_revisions(self, revision_ids):
1007
return self._real_repository.get_revisions(revision_ids)
1009
def supports_rich_root(self):
1011
return self._real_repository.supports_rich_root()
1013
def iter_reverse_revision_history(self, revision_id):
1015
return self._real_repository.iter_reverse_revision_history(revision_id)
1018
def _serializer(self):
1020
return self._real_repository._serializer
1022
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1024
return self._real_repository.store_revision_signature(
1025
gpg_strategy, plaintext, revision_id)
1027
def add_signature_text(self, revision_id, signature):
1029
return self._real_repository.add_signature_text(revision_id, signature)
1031
def has_signature_for_revision_id(self, revision_id):
1033
return self._real_repository.has_signature_for_revision_id(revision_id)
1035
def get_data_stream_for_search(self, search):
1036
medium = self._client._medium
1037
if not medium._remote_is_at_least_1_2:
1039
return self._real_repository.get_data_stream_for_search(search)
1040
REQUEST_NAME = 'Repository.stream_revisions_chunked'
1041
path = self.bzrdir._path_for_remote_call(self._client)
1042
body = self._serialise_search_recipe(search.get_recipe())
1044
result = self._client.call_with_body_bytes_expecting_body(
1045
REQUEST_NAME, (path,), body)
1046
response, protocol = result
1047
except errors.UnknownSmartMethod:
1048
# Server does not support this method, so fall back to VFS.
1049
# Worse, we have to force a disconnection, because the server now
1050
# doesn't realise it has a body on the wire to consume, so the
1051
# only way to recover is to abandon the connection.
1053
'Server is too old for streaming pull, reconnecting. '
1054
'(Upgrade the server to Bazaar 1.2 to avoid this)')
1056
# To avoid having to disconnect repeatedly, we keep track of the
1057
# fact the server doesn't understand this remote method.
1058
medium._remote_is_at_least_1_2 = False
1060
return self._real_repository.get_data_stream_for_search(search)
1062
if response == ('ok',):
1063
return self._deserialise_stream(protocol)
1064
if response == ('NoSuchRevision', ):
1065
# We cannot easily identify the revision that is missing in this
1066
# situation without doing much more network IO. For now, bail.
1067
raise NoSuchRevision(self, "unknown")
1069
raise errors.UnexpectedSmartServerResponse(response)
1071
def _deserialise_stream(self, protocol):
1072
stream = protocol.read_streamed_body()
1073
container_parser = ContainerPushParser()
1074
for bytes in stream:
1075
container_parser.accept_bytes(bytes)
1076
records = container_parser.read_pending_records()
1077
for record_names, record_bytes in records:
1078
if len(record_names) != 1:
1079
# These records should have only one name, and that name
1080
# should be a one-element tuple.
1081
raise errors.SmartProtocolError(
1082
'Repository data stream had invalid record name %r'
1084
name_tuple = record_names[0]
1085
yield name_tuple, record_bytes
1087
def insert_data_stream(self, stream):
1089
self._real_repository.insert_data_stream(stream)
1091
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
1093
return self._real_repository.item_keys_introduced_by(revision_ids,
1094
_files_pb=_files_pb)
1096
def revision_graph_can_have_wrong_parents(self):
1097
# The answer depends on the remote repo format.
1099
return self._real_repository.revision_graph_can_have_wrong_parents()
1101
def _find_inconsistent_revision_parents(self):
1103
return self._real_repository._find_inconsistent_revision_parents()
1105
def _check_for_inconsistent_revision_parents(self):
1107
return self._real_repository._check_for_inconsistent_revision_parents()
1109
def _make_parents_provider(self):
1112
def _serialise_search_recipe(self, recipe):
1113
"""Serialise a graph search recipe.
1115
:param recipe: A search recipe (start, stop, count).
1116
:return: Serialised bytes.
1118
start_keys = ' '.join(recipe[0])
1119
stop_keys = ' '.join(recipe[1])
1120
count = str(recipe[2])
1121
return '\n'.join((start_keys, stop_keys, count))
1124
class RemoteBranchLockableFiles(LockableFiles):
1125
"""A 'LockableFiles' implementation that talks to a smart server.
1127
This is not a public interface class.
1130
def __init__(self, bzrdir, _client):
1131
self.bzrdir = bzrdir
1132
self._client = _client
1133
self._need_find_modes = True
1134
LockableFiles.__init__(
1135
self, bzrdir.get_branch_transport(None),
1136
'lock', lockdir.LockDir)
1138
def _find_modes(self):
1139
# RemoteBranches don't let the client set the mode of control files.
1140
self._dir_mode = None
1141
self._file_mode = None
1143
def get(self, path):
1144
"""'get' a remote path as per the LockableFiles interface.
1146
:param path: the file to 'get'. If this is 'branch.conf', we do not
1147
just retrieve a file, instead we ask the smart server to generate
1148
a configuration for us - which is retrieved as an INI file.
1150
if path == 'branch.conf':
1151
path = self.bzrdir._path_for_remote_call(self._client)
1152
response = self._client.call_expecting_body(
1153
'Branch.get_config_file', path)
1154
assert response[0][0] == 'ok', \
1155
'unexpected response code %s' % (response[0],)
1156
return StringIO(response[1].read_body_bytes())
1159
return LockableFiles.get(self, path)
1162
class RemoteBranchFormat(branch.BranchFormat):
1164
def __eq__(self, other):
1165
return (isinstance(other, RemoteBranchFormat) and
1166
self.__dict__ == other.__dict__)
1168
def get_format_description(self):
1169
return 'Remote BZR Branch'
1171
def get_format_string(self):
1172
return 'Remote BZR Branch'
1174
def open(self, a_bzrdir):
1175
assert isinstance(a_bzrdir, RemoteBzrDir)
1176
return a_bzrdir.open_branch()
1178
def initialize(self, a_bzrdir):
1179
assert isinstance(a_bzrdir, RemoteBzrDir)
1180
return a_bzrdir.create_branch()
1182
def supports_tags(self):
1183
# Remote branches might support tags, but we won't know until we
1184
# access the real remote branch.
1188
class RemoteBranch(branch.Branch):
1189
"""Branch stored on a server accessed by HPSS RPC.
1191
At the moment most operations are mapped down to simple file operations.
1194
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
1196
"""Create a RemoteBranch instance.
1198
:param real_branch: An optional local implementation of the branch
1199
format, usually accessing the data via the VFS.
1200
:param _client: Private parameter for testing.
1202
# We intentionally don't call the parent class's __init__, because it
1203
# will try to assign to self.tags, which is a property in this subclass.
1204
# And the parent's __init__ doesn't do much anyway.
1205
self._revision_id_to_revno_cache = None
1206
self._revision_history_cache = None
1207
self.bzrdir = remote_bzrdir
1208
if _client is not None:
1209
self._client = _client
1211
self._client = remote_bzrdir._client
1212
self.repository = remote_repository
1213
if real_branch is not None:
1214
self._real_branch = real_branch
1215
# Give the remote repository the matching real repo.
1216
real_repo = self._real_branch.repository
1217
if isinstance(real_repo, RemoteRepository):
1218
real_repo._ensure_real()
1219
real_repo = real_repo._real_repository
1220
self.repository._set_real_repository(real_repo)
1221
# Give the branch the remote repository to let fast-pathing happen.
1222
self._real_branch.repository = self.repository
1224
self._real_branch = None
1225
# Fill out expected attributes of branch for bzrlib api users.
1226
self._format = RemoteBranchFormat()
1227
self.base = self.bzrdir.root_transport.base
1228
self._control_files = None
1229
self._lock_mode = None
1230
self._lock_token = None
1231
self._lock_count = 0
1232
self._leave_lock = False
1235
return "%s(%s)" % (self.__class__.__name__, self.base)
1239
def _ensure_real(self):
1240
"""Ensure that there is a _real_branch set.
1242
Used before calls to self._real_branch.
1244
if not self._real_branch:
1245
assert vfs.vfs_enabled()
1246
self.bzrdir._ensure_real()
1247
self._real_branch = self.bzrdir._real_bzrdir.open_branch()
1248
# Give the remote repository the matching real repo.
1249
real_repo = self._real_branch.repository
1250
if isinstance(real_repo, RemoteRepository):
1251
real_repo._ensure_real()
1252
real_repo = real_repo._real_repository
1253
self.repository._set_real_repository(real_repo)
1254
# Give the branch the remote repository to let fast-pathing happen.
1255
self._real_branch.repository = self.repository
1256
# XXX: deal with _lock_mode == 'w'
1257
if self._lock_mode == 'r':
1258
self._real_branch.lock_read()
1261
def control_files(self):
1262
# Defer actually creating RemoteBranchLockableFiles until its needed,
1263
# because it triggers an _ensure_real that we otherwise might not need.
1264
if self._control_files is None:
1265
self._control_files = RemoteBranchLockableFiles(
1266
self.bzrdir, self._client)
1267
return self._control_files
1269
def _get_checkout_format(self):
1271
return self._real_branch._get_checkout_format()
1273
def get_physical_lock_status(self):
1274
"""See Branch.get_physical_lock_status()."""
1275
# should be an API call to the server, as branches must be lockable.
1277
return self._real_branch.get_physical_lock_status()
1279
def lock_read(self):
1280
if not self._lock_mode:
1281
self._lock_mode = 'r'
1282
self._lock_count = 1
1283
if self._real_branch is not None:
1284
self._real_branch.lock_read()
1286
self._lock_count += 1
1288
def _remote_lock_write(self, token):
1290
branch_token = repo_token = ''
1292
branch_token = token
1293
repo_token = self.repository.lock_write()
1294
self.repository.unlock()
1295
path = self.bzrdir._path_for_remote_call(self._client)
1296
response = self._client.call('Branch.lock_write', path, branch_token,
1298
if response[0] == 'ok':
1299
ok, branch_token, repo_token = response
1300
return branch_token, repo_token
1301
elif response[0] == 'LockContention':
1302
raise errors.LockContention('(remote lock)')
1303
elif response[0] == 'TokenMismatch':
1304
raise errors.TokenMismatch(token, '(remote token)')
1305
elif response[0] == 'UnlockableTransport':
1306
raise errors.UnlockableTransport(self.bzrdir.root_transport)
1307
elif response[0] == 'ReadOnlyError':
1308
raise errors.ReadOnlyError(self)
1309
elif response[0] == 'LockFailed':
1310
raise errors.LockFailed(response[1], response[2])
1312
raise errors.UnexpectedSmartServerResponse(response)
1314
def lock_write(self, token=None):
1315
if not self._lock_mode:
1316
remote_tokens = self._remote_lock_write(token)
1317
self._lock_token, self._repo_lock_token = remote_tokens
1318
assert self._lock_token, 'Remote server did not return a token!'
1319
# TODO: We really, really, really don't want to call _ensure_real
1320
# here, but it's the easiest way to ensure coherency between the
1321
# state of the RemoteBranch and RemoteRepository objects and the
1322
# physical locks. If we don't materialise the real objects here,
1323
# then getting everything in the right state later is complex, so
1324
# for now we just do it the lazy way.
1325
# -- Andrew Bennetts, 2007-02-22.
1327
if self._real_branch is not None:
1328
self._real_branch.repository.lock_write(
1329
token=self._repo_lock_token)
1331
self._real_branch.lock_write(token=self._lock_token)
1333
self._real_branch.repository.unlock()
1334
if token is not None:
1335
self._leave_lock = True
1337
# XXX: this case seems to be unreachable; token cannot be None.
1338
self._leave_lock = False
1339
self._lock_mode = 'w'
1340
self._lock_count = 1
1341
elif self._lock_mode == 'r':
1342
raise errors.ReadOnlyTransaction
1344
if token is not None:
1345
# A token was given to lock_write, and we're relocking, so check
1346
# that the given token actually matches the one we already have.
1347
if token != self._lock_token:
1348
raise errors.TokenMismatch(token, self._lock_token)
1349
self._lock_count += 1
1350
return self._lock_token or None
1352
def _unlock(self, branch_token, repo_token):
1353
path = self.bzrdir._path_for_remote_call(self._client)
1354
response = self._client.call('Branch.unlock', path, branch_token,
1356
if response == ('ok',):
1358
elif response[0] == 'TokenMismatch':
1359
raise errors.TokenMismatch(
1360
str((branch_token, repo_token)), '(remote tokens)')
1362
raise errors.UnexpectedSmartServerResponse(response)
1365
self._lock_count -= 1
1366
if not self._lock_count:
1367
self._clear_cached_state()
1368
mode = self._lock_mode
1369
self._lock_mode = None
1370
if self._real_branch is not None:
1371
if (not self._leave_lock and mode == 'w' and
1372
self._repo_lock_token):
1373
# If this RemoteBranch will remove the physical lock for the
1374
# repository, make sure the _real_branch doesn't do it
1375
# first. (Because the _real_branch's repository is set to
1376
# be the RemoteRepository.)
1377
self._real_branch.repository.leave_lock_in_place()
1378
self._real_branch.unlock()
1380
# Only write-locked branched need to make a remote method call
1381
# to perfom the unlock.
1383
assert self._lock_token, 'Locked, but no token!'
1384
branch_token = self._lock_token
1385
repo_token = self._repo_lock_token
1386
self._lock_token = None
1387
self._repo_lock_token = None
1388
if not self._leave_lock:
1389
self._unlock(branch_token, repo_token)
1391
def break_lock(self):
1393
return self._real_branch.break_lock()
1395
def leave_lock_in_place(self):
1396
if not self._lock_token:
1397
raise NotImplementedError(self.leave_lock_in_place)
1398
self._leave_lock = True
1400
def dont_leave_lock_in_place(self):
1401
if not self._lock_token:
1402
raise NotImplementedError(self.dont_leave_lock_in_place)
1403
self._leave_lock = False
1405
def last_revision_info(self):
1406
"""See Branch.last_revision_info()."""
1407
path = self.bzrdir._path_for_remote_call(self._client)
1408
response = self._client.call('Branch.last_revision_info', path)
1409
assert response[0] == 'ok', 'unexpected response code %s' % (response,)
1410
revno = int(response[1])
1411
last_revision = response[2]
1412
return (revno, last_revision)
1414
def _gen_revision_history(self):
1415
"""See Branch._gen_revision_history()."""
1416
path = self.bzrdir._path_for_remote_call(self._client)
1417
response = self._client.call_expecting_body(
1418
'Branch.revision_history', path)
1419
assert response[0][0] == 'ok', ('unexpected response code %s'
1421
result = response[1].read_body_bytes().split('\x00')
1427
def set_revision_history(self, rev_history):
1428
# Send just the tip revision of the history; the server will generate
1429
# the full history from that. If the revision doesn't exist in this
1430
# branch, NoSuchRevision will be raised.
1431
path = self.bzrdir._path_for_remote_call(self._client)
1432
if rev_history == []:
1435
rev_id = rev_history[-1]
1436
self._clear_cached_state()
1437
response = self._client.call('Branch.set_last_revision',
1438
path, self._lock_token, self._repo_lock_token, rev_id)
1439
if response[0] == 'NoSuchRevision':
1440
raise NoSuchRevision(self, rev_id)
1442
assert response == ('ok',), (
1443
'unexpected response code %r' % (response,))
1444
self._cache_revision_history(rev_history)
1446
def get_parent(self):
1448
return self._real_branch.get_parent()
1450
def set_parent(self, url):
1452
return self._real_branch.set_parent(url)
1454
def get_config(self):
1455
return RemoteBranchConfig(self)
1457
def sprout(self, to_bzrdir, revision_id=None):
1458
# Like Branch.sprout, except that it sprouts a branch in the default
1459
# format, because RemoteBranches can't be created at arbitrary URLs.
1460
# XXX: if to_bzrdir is a RemoteBranch, this should perhaps do
1461
# to_bzrdir.create_branch...
1463
result = self._real_branch._format.initialize(to_bzrdir)
1464
self.copy_content_into(result, revision_id=revision_id)
1465
result.set_parent(self.bzrdir.root_transport.base)
1469
def pull(self, source, overwrite=False, stop_revision=None,
1471
# FIXME: This asks the real branch to run the hooks, which means
1472
# they're called with the wrong target branch parameter.
1473
# The test suite specifically allows this at present but it should be
1474
# fixed. It should get a _override_hook_target branch,
1475
# as push does. -- mbp 20070405
1477
self._real_branch.pull(
1478
source, overwrite=overwrite, stop_revision=stop_revision,
1482
def push(self, target, overwrite=False, stop_revision=None):
1484
return self._real_branch.push(
1485
target, overwrite=overwrite, stop_revision=stop_revision,
1486
_override_hook_source_branch=self)
1488
def is_locked(self):
1489
return self._lock_count >= 1
1491
def set_last_revision_info(self, revno, revision_id):
1493
self._clear_cached_state()
1494
return self._real_branch.set_last_revision_info(revno, revision_id)
1496
def generate_revision_history(self, revision_id, last_rev=None,
1499
return self._real_branch.generate_revision_history(
1500
revision_id, last_rev=last_rev, other_branch=other_branch)
1505
return self._real_branch.tags
1507
def set_push_location(self, location):
1509
return self._real_branch.set_push_location(location)
1511
def update_revisions(self, other, stop_revision=None, overwrite=False):
1513
return self._real_branch.update_revisions(
1514
other, stop_revision=stop_revision, overwrite=overwrite)
1517
class RemoteBranchConfig(BranchConfig):
1520
self.branch._ensure_real()
1521
return self.branch._real_branch.get_config().username()
1523
def _get_branch_data_config(self):
1524
self.branch._ensure_real()
1525
if self._branch_data_config is None:
1526
self._branch_data_config = TreeConfig(self.branch._real_branch)
1527
return self._branch_data_config
1530
def _extract_tar(tar, to_dir):
1531
"""Extract all the contents of a tarfile object.
1533
A replacement for extractall, which is not present in python2.4
1536
tar.extract(tarinfo, to_dir)
added
removed
bzrlib/remote.py
