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 (
41
from bzrlib.lockable_files import LockableFiles
42
from bzrlib.pack import ContainerPushParser
43
from bzrlib.smart import client, vfs
44
from bzrlib.symbol_versioning import (
48
from bzrlib.revision import ensure_null, NULL_REVISION
49
from bzrlib.trace import mutter, note, warning
51
# Note: RemoteBzrDirFormat is in bzrdir.py
53
class RemoteBzrDir(BzrDir):
54
"""Control directory on a remote server, accessed via bzr:// or similar."""
56
def __init__(self, transport, _client=None):
57
"""Construct a RemoteBzrDir.
59
:param _client: Private parameter for testing. Disables probing and the
62
BzrDir.__init__(self, transport, RemoteBzrDirFormat())
63
# this object holds a delegated bzrdir that uses file-level operations
64
# to talk to the other side
65
self._real_bzrdir = None
68
medium = transport.get_smart_medium()
69
self._client = client._SmartClient(medium, transport.base)
71
self._client = _client
74
path = self._path_for_remote_call(self._client)
75
response = self._client.call('BzrDir.open', path)
76
if response not in [('yes',), ('no',)]:
77
raise errors.UnexpectedSmartServerResponse(response)
78
if response == ('no',):
79
raise errors.NotBranchError(path=transport.base)
81
def _ensure_real(self):
82
"""Ensure that there is a _real_bzrdir set.
84
Used before calls to self._real_bzrdir.
86
if not self._real_bzrdir:
87
self._real_bzrdir = BzrDir.open_from_transport(
88
self.root_transport, _server_formats=False)
90
def create_repository(self, shared=False):
92
self._real_bzrdir.create_repository(shared=shared)
93
return self.open_repository()
95
def destroy_repository(self):
96
"""See BzrDir.destroy_repository"""
98
self._real_bzrdir.destroy_repository()
100
def create_branch(self):
102
real_branch = self._real_bzrdir.create_branch()
103
return RemoteBranch(self, self.find_repository(), real_branch)
105
def destroy_branch(self):
106
"""See BzrDir.destroy_branch"""
108
self._real_bzrdir.destroy_branch()
110
def create_workingtree(self, revision_id=None, from_branch=None):
111
raise errors.NotLocalUrl(self.transport.base)
113
def find_branch_format(self):
114
"""Find the branch 'format' for this bzrdir.
116
This might be a synthetic object for e.g. RemoteBranch and SVN.
118
b = self.open_branch()
121
def get_branch_reference(self):
122
"""See BzrDir.get_branch_reference()."""
123
path = self._path_for_remote_call(self._client)
124
response = self._client.call('BzrDir.open_branch', path)
125
if response[0] == 'ok':
126
if response[1] == '':
127
# branch at this location.
130
# a branch reference, use the existing BranchReference logic.
132
elif response == ('nobranch',):
133
raise errors.NotBranchError(path=self.root_transport.base)
135
raise errors.UnexpectedSmartServerResponse(response)
137
def _get_tree_branch(self):
138
"""See BzrDir._get_tree_branch()."""
139
return None, self.open_branch()
141
def open_branch(self, _unsupported=False):
143
raise NotImplementedError('unsupported flag support not implemented yet.')
144
reference_url = self.get_branch_reference()
145
if reference_url is None:
146
# branch at this location.
147
return RemoteBranch(self, self.find_repository())
149
# a branch reference, use the existing BranchReference logic.
150
format = BranchReferenceFormat()
151
return format.open(self, _found=True, location=reference_url)
153
def open_repository(self):
154
path = self._path_for_remote_call(self._client)
155
verb = 'BzrDir.find_repositoryV2'
157
response = self._client.call(verb, path)
158
except errors.UnknownSmartMethod:
159
verb = 'BzrDir.find_repository'
160
response = self._client.call(verb, path)
161
if response[0] == 'norepository':
162
raise errors.NoRepositoryPresent(self)
163
elif response[0] != 'ok':
164
raise SmartProtocolError('unexpected response %r'
166
if verb == 'BzrDir.find_repository':
167
# servers that don't support the V2 method don't support external
169
response = response + ('no', )
170
if not (len(response) == 5):
171
raise SmartProtocolError('incorrect response length %s' % (response,))
172
if response[1] == '':
173
format = RemoteRepositoryFormat()
174
format.rich_root_data = (response[2] == 'yes')
175
format.supports_tree_reference = (response[3] == 'yes')
176
# No wire format to check this yet.
177
format.supports_external_lookups = (response[4] == 'yes')
178
return RemoteRepository(self, format)
180
raise errors.NoRepositoryPresent(self)
182
def open_workingtree(self, recommend_upgrade=True):
184
if self._real_bzrdir.has_workingtree():
185
raise errors.NotLocalUrl(self.root_transport)
187
raise errors.NoWorkingTree(self.root_transport.base)
189
def _path_for_remote_call(self, client):
190
"""Return the path to be used for this bzrdir in a remote call."""
191
return client.remote_path_from_transport(self.root_transport)
193
def get_branch_transport(self, branch_format):
195
return self._real_bzrdir.get_branch_transport(branch_format)
197
def get_repository_transport(self, repository_format):
199
return self._real_bzrdir.get_repository_transport(repository_format)
201
def get_workingtree_transport(self, workingtree_format):
203
return self._real_bzrdir.get_workingtree_transport(workingtree_format)
205
def can_convert_format(self):
206
"""Upgrading of remote bzrdirs is not supported yet."""
209
def needs_format_conversion(self, format=None):
210
"""Upgrading of remote bzrdirs is not supported yet."""
213
def clone(self, url, revision_id=None, force_new_repo=False):
215
return self._real_bzrdir.clone(url, revision_id=revision_id,
216
force_new_repo=force_new_repo)
219
class RemoteRepositoryFormat(repository.RepositoryFormat):
220
"""Format for repositories accessed over a _SmartClient.
222
Instances of this repository are represented by RemoteRepository
225
The RemoteRepositoryFormat is parameterized during construction
226
to reflect the capabilities of the real, remote format. Specifically
227
the attributes rich_root_data and supports_tree_reference are set
228
on a per instance basis, and are not set (and should not be) at
232
_matchingbzrdir = RemoteBzrDirFormat
234
def initialize(self, a_bzrdir, shared=False):
235
if not isinstance(a_bzrdir, RemoteBzrDir):
236
raise AssertionError('%r is not a RemoteBzrDir' % (a_bzrdir,))
237
return a_bzrdir.create_repository(shared=shared)
239
def open(self, a_bzrdir):
240
if not isinstance(a_bzrdir, RemoteBzrDir):
241
raise AssertionError('%r is not a RemoteBzrDir' % (a_bzrdir,))
242
return a_bzrdir.open_repository()
244
def get_format_description(self):
245
return 'bzr remote repository'
247
def __eq__(self, other):
248
return self.__class__ == other.__class__
250
def check_conversion_target(self, target_format):
251
if self.rich_root_data and not target_format.rich_root_data:
252
raise errors.BadConversionTarget(
253
'Does not support rich root data.', target_format)
254
if (self.supports_tree_reference and
255
not getattr(target_format, 'supports_tree_reference', False)):
256
raise errors.BadConversionTarget(
257
'Does not support nested trees', target_format)
260
class RemoteRepository(object):
261
"""Repository accessed over rpc.
263
For the moment most operations are performed using local transport-backed
267
def __init__(self, remote_bzrdir, format, real_repository=None, _client=None):
268
"""Create a RemoteRepository instance.
270
:param remote_bzrdir: The bzrdir hosting this repository.
271
:param format: The RemoteFormat object to use.
272
:param real_repository: If not None, a local implementation of the
273
repository logic for the repository, usually accessing the data
275
:param _client: Private testing parameter - override the smart client
276
to be used by the repository.
279
self._real_repository = real_repository
281
self._real_repository = None
282
self.bzrdir = remote_bzrdir
284
self._client = remote_bzrdir._client
286
self._client = _client
287
self._format = format
288
self._lock_mode = None
289
self._lock_token = None
291
self._leave_lock = False
292
# A cache of looked up revision parent data; reset at unlock time.
293
self._parents_map = None
294
if 'hpss' in debug.debug_flags:
295
self._requested_parents = None
297
# These depend on the actual remote format, so force them off for
298
# maximum compatibility. XXX: In future these should depend on the
299
# remote repository instance, but this is irrelevant until we perform
300
# reconcile via an RPC call.
301
self._reconcile_does_inventory_gc = False
302
self._reconcile_fixes_text_parents = False
303
self._reconcile_backsup_inventory = False
304
self.base = self.bzrdir.transport.base
307
return "%s(%s)" % (self.__class__.__name__, self.base)
311
def abort_write_group(self):
312
"""Complete a write group on the decorated repository.
314
Smart methods peform operations in a single step so this api
315
is not really applicable except as a compatibility thunk
316
for older plugins that don't use e.g. the CommitBuilder
320
return self._real_repository.abort_write_group()
322
def commit_write_group(self):
323
"""Complete a write group on the decorated repository.
325
Smart methods peform operations in a single step so this api
326
is not really applicable except as a compatibility thunk
327
for older plugins that don't use e.g. the CommitBuilder
331
return self._real_repository.commit_write_group()
333
def _ensure_real(self):
334
"""Ensure that there is a _real_repository set.
336
Used before calls to self._real_repository.
338
if not self._real_repository:
339
self.bzrdir._ensure_real()
340
#self._real_repository = self.bzrdir._real_bzrdir.open_repository()
341
self._set_real_repository(self.bzrdir._real_bzrdir.open_repository())
343
def find_text_key_references(self):
344
"""Find the text key references within the repository.
346
:return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
347
revision_ids. Each altered file-ids has the exact revision_ids that
348
altered it listed explicitly.
349
:return: A dictionary mapping text keys ((fileid, revision_id) tuples)
350
to whether they were referred to by the inventory of the
351
revision_id that they contain. The inventory texts from all present
352
revision ids are assessed to generate this report.
355
return self._real_repository.find_text_key_references()
357
def _generate_text_key_index(self):
358
"""Generate a new text key index for the repository.
360
This is an expensive function that will take considerable time to run.
362
:return: A dict mapping (file_id, revision_id) tuples to a list of
363
parents, also (file_id, revision_id) tuples.
366
return self._real_repository._generate_text_key_index()
368
@symbol_versioning.deprecated_method(symbol_versioning.one_four)
369
def get_revision_graph(self, revision_id=None):
370
"""See Repository.get_revision_graph()."""
371
return self._get_revision_graph(revision_id)
373
def _get_revision_graph(self, revision_id):
374
"""Private method for using with old (< 1.2) servers to fallback."""
375
if revision_id is None:
377
elif revision.is_null(revision_id):
380
path = self.bzrdir._path_for_remote_call(self._client)
381
response = self._client.call_expecting_body(
382
'Repository.get_revision_graph', path, revision_id)
383
if response[0][0] not in ['ok', 'nosuchrevision']:
384
raise errors.UnexpectedSmartServerResponse(response[0])
385
if response[0][0] == 'ok':
386
coded = response[1].read_body_bytes()
388
# no revisions in this repository!
390
lines = coded.split('\n')
393
d = tuple(line.split())
394
revision_graph[d[0]] = d[1:]
396
return revision_graph
398
response_body = response[1].read_body_bytes()
400
raise SmartProtocolError('unexpected response body')
401
raise NoSuchRevision(self, revision_id)
403
def has_revision(self, revision_id):
404
"""See Repository.has_revision()."""
405
if revision_id == NULL_REVISION:
406
# The null revision is always present.
408
path = self.bzrdir._path_for_remote_call(self._client)
409
response = self._client.call('Repository.has_revision', path, revision_id)
410
if response[0] not in ('yes', 'no'):
411
raise SmartProtocolError('unexpected response code %s' % (response,))
412
return response[0] == 'yes'
414
def has_revisions(self, revision_ids):
415
"""See Repository.has_revisions()."""
417
for revision_id in revision_ids:
418
if self.has_revision(revision_id):
419
result.add(revision_id)
422
def has_same_location(self, other):
423
return (self.__class__ == other.__class__ and
424
self.bzrdir.transport.base == other.bzrdir.transport.base)
426
def get_graph(self, other_repository=None):
427
"""Return the graph for this repository format"""
428
parents_provider = self
429
if (other_repository is not None and
430
other_repository.bzrdir.transport.base !=
431
self.bzrdir.transport.base):
432
parents_provider = graph._StackedParentsProvider(
433
[parents_provider, other_repository._make_parents_provider()])
434
return graph.Graph(parents_provider)
436
def gather_stats(self, revid=None, committers=None):
437
"""See Repository.gather_stats()."""
438
path = self.bzrdir._path_for_remote_call(self._client)
439
# revid can be None to indicate no revisions, not just NULL_REVISION
440
if revid is None or revision.is_null(revid):
444
if committers is None or not committers:
445
fmt_committers = 'no'
447
fmt_committers = 'yes'
448
response = self._client.call_expecting_body(
449
'Repository.gather_stats', path, fmt_revid, fmt_committers)
450
if response[0][0] != 'ok':
451
raise SmartProtocolError('unexpected response code %s'
454
body = response[1].read_body_bytes()
456
for line in body.split('\n'):
459
key, val_text = line.split(':')
460
if key in ('revisions', 'size', 'committers'):
461
result[key] = int(val_text)
462
elif key in ('firstrev', 'latestrev'):
463
values = val_text.split(' ')[1:]
464
result[key] = (float(values[0]), long(values[1]))
468
def find_branches(self, using=False):
469
"""See Repository.find_branches()."""
470
# should be an API call to the server.
472
return self._real_repository.find_branches(using=using)
474
def get_physical_lock_status(self):
475
"""See Repository.get_physical_lock_status()."""
476
# should be an API call to the server.
478
return self._real_repository.get_physical_lock_status()
480
def is_in_write_group(self):
481
"""Return True if there is an open write group.
483
write groups are only applicable locally for the smart server..
485
if self._real_repository:
486
return self._real_repository.is_in_write_group()
489
return self._lock_count >= 1
492
"""See Repository.is_shared()."""
493
path = self.bzrdir._path_for_remote_call(self._client)
494
response = self._client.call('Repository.is_shared', path)
495
if response[0] not in ('yes', 'no'):
496
raise SmartProtocolError('unexpected response code %s' % (response,))
497
return response[0] == 'yes'
499
def is_write_locked(self):
500
return self._lock_mode == 'w'
503
# wrong eventually - want a local lock cache context
504
if not self._lock_mode:
505
self._lock_mode = 'r'
507
self._parents_map = {}
508
if 'hpss' in debug.debug_flags:
509
self._requested_parents = set()
510
if self._real_repository is not None:
511
self._real_repository.lock_read()
513
self._lock_count += 1
515
def _remote_lock_write(self, token):
516
path = self.bzrdir._path_for_remote_call(self._client)
519
response = self._client.call('Repository.lock_write', path, token)
520
if response[0] == 'ok':
523
elif response[0] == 'LockContention':
524
raise errors.LockContention('(remote lock)')
525
elif response[0] == 'UnlockableTransport':
526
raise errors.UnlockableTransport(self.bzrdir.root_transport)
527
elif response[0] == 'LockFailed':
528
raise errors.LockFailed(response[1], response[2])
530
raise errors.UnexpectedSmartServerResponse(response)
532
def lock_write(self, token=None):
533
if not self._lock_mode:
534
self._lock_token = self._remote_lock_write(token)
535
# if self._lock_token is None, then this is something like packs or
536
# svn where we don't get to lock the repo, or a weave style repository
537
# where we cannot lock it over the wire and attempts to do so will
539
if self._real_repository is not None:
540
self._real_repository.lock_write(token=self._lock_token)
541
if token is not None:
542
self._leave_lock = True
544
self._leave_lock = False
545
self._lock_mode = 'w'
547
self._parents_map = {}
548
if 'hpss' in debug.debug_flags:
549
self._requested_parents = set()
550
elif self._lock_mode == 'r':
551
raise errors.ReadOnlyError(self)
553
self._lock_count += 1
554
return self._lock_token or None
556
def leave_lock_in_place(self):
557
if not self._lock_token:
558
raise NotImplementedError(self.leave_lock_in_place)
559
self._leave_lock = True
561
def dont_leave_lock_in_place(self):
562
if not self._lock_token:
563
raise NotImplementedError(self.dont_leave_lock_in_place)
564
self._leave_lock = False
566
def _set_real_repository(self, repository):
567
"""Set the _real_repository for this repository.
569
:param repository: The repository to fallback to for non-hpss
570
implemented operations.
572
if isinstance(repository, RemoteRepository):
573
raise AssertionError()
574
self._real_repository = repository
575
if self._lock_mode == 'w':
576
# if we are already locked, the real repository must be able to
577
# acquire the lock with our token.
578
self._real_repository.lock_write(self._lock_token)
579
elif self._lock_mode == 'r':
580
self._real_repository.lock_read()
582
def start_write_group(self):
583
"""Start a write group on the decorated repository.
585
Smart methods peform operations in a single step so this api
586
is not really applicable except as a compatibility thunk
587
for older plugins that don't use e.g. the CommitBuilder
591
return self._real_repository.start_write_group()
593
def _unlock(self, token):
594
path = self.bzrdir._path_for_remote_call(self._client)
596
# with no token the remote repository is not persistently locked.
598
response = self._client.call('Repository.unlock', path, token)
599
if response == ('ok',):
601
elif response[0] == 'TokenMismatch':
602
raise errors.TokenMismatch(token, '(remote token)')
604
raise errors.UnexpectedSmartServerResponse(response)
607
self._lock_count -= 1
608
if self._lock_count > 0:
610
self._parents_map = None
611
if 'hpss' in debug.debug_flags:
612
self._requested_parents = None
613
old_mode = self._lock_mode
614
self._lock_mode = None
616
# The real repository is responsible at present for raising an
617
# exception if it's in an unfinished write group. However, it
618
# normally will *not* actually remove the lock from disk - that's
619
# done by the server on receiving the Repository.unlock call.
620
# This is just to let the _real_repository stay up to date.
621
if self._real_repository is not None:
622
self._real_repository.unlock()
624
# The rpc-level lock should be released even if there was a
625
# problem releasing the vfs-based lock.
627
# Only write-locked repositories need to make a remote method
628
# call to perfom the unlock.
629
old_token = self._lock_token
630
self._lock_token = None
631
if not self._leave_lock:
632
self._unlock(old_token)
634
def break_lock(self):
635
# should hand off to the network
637
return self._real_repository.break_lock()
639
def _get_tarball(self, compression):
640
"""Return a TemporaryFile containing a repository tarball.
642
Returns None if the server does not support sending tarballs.
645
path = self.bzrdir._path_for_remote_call(self._client)
647
response, protocol = self._client.call_expecting_body(
648
'Repository.tarball', path, compression)
649
except errors.UnknownSmartMethod:
650
protocol.cancel_read_body()
652
if response[0] == 'ok':
653
# Extract the tarball and return it
654
t = tempfile.NamedTemporaryFile()
655
# TODO: rpc layer should read directly into it...
656
t.write(protocol.read_body_bytes())
659
raise errors.UnexpectedSmartServerResponse(response)
661
def sprout(self, to_bzrdir, revision_id=None):
662
# TODO: Option to control what format is created?
664
dest_repo = self._real_repository._format.initialize(to_bzrdir,
666
dest_repo.fetch(self, revision_id=revision_id)
669
### These methods are just thin shims to the VFS object for now.
671
def revision_tree(self, revision_id):
673
return self._real_repository.revision_tree(revision_id)
675
def get_serializer_format(self):
677
return self._real_repository.get_serializer_format()
679
def get_commit_builder(self, branch, parents, config, timestamp=None,
680
timezone=None, committer=None, revprops=None,
682
# FIXME: It ought to be possible to call this without immediately
683
# triggering _ensure_real. For now it's the easiest thing to do.
685
builder = self._real_repository.get_commit_builder(branch, parents,
686
config, timestamp=timestamp, timezone=timezone,
687
committer=committer, revprops=revprops, revision_id=revision_id)
690
def add_inventory(self, revid, inv, parents):
692
return self._real_repository.add_inventory(revid, inv, parents)
694
def add_revision(self, rev_id, rev, inv=None, config=None):
696
return self._real_repository.add_revision(
697
rev_id, rev, inv=inv, config=config)
700
def get_inventory(self, revision_id):
702
return self._real_repository.get_inventory(revision_id)
704
def iter_inventories(self, revision_ids):
706
return self._real_repository.iter_inventories(revision_ids)
709
def get_revision(self, revision_id):
711
return self._real_repository.get_revision(revision_id)
714
def weave_store(self):
716
return self._real_repository.weave_store
718
def get_transaction(self):
720
return self._real_repository.get_transaction()
723
def clone(self, a_bzrdir, revision_id=None):
725
return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
727
def make_working_trees(self):
728
"""See Repository.make_working_trees"""
730
return self._real_repository.make_working_trees()
732
def revision_ids_to_search_result(self, result_set):
733
"""Convert a set of revision ids to a graph SearchResult."""
734
result_parents = set()
735
for parents in self.get_graph().get_parent_map(
736
result_set).itervalues():
737
result_parents.update(parents)
738
included_keys = result_set.intersection(result_parents)
739
start_keys = result_set.difference(included_keys)
740
exclude_keys = result_parents.difference(result_set)
741
result = graph.SearchResult(start_keys, exclude_keys,
742
len(result_set), result_set)
746
def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
747
"""Return the revision ids that other has that this does not.
749
These are returned in topological order.
751
revision_id: only return revision ids included by revision_id.
753
return repository.InterRepository.get(
754
other, self).search_missing_revision_ids(revision_id, find_ghosts)
756
def fetch(self, source, revision_id=None, pb=None):
757
if self.has_same_location(source):
758
# check that last_revision is in 'from' and then return a
760
if (revision_id is not None and
761
not revision.is_null(revision_id)):
762
self.get_revision(revision_id)
765
return self._real_repository.fetch(
766
source, revision_id=revision_id, pb=pb)
768
def create_bundle(self, target, base, fileobj, format=None):
770
self._real_repository.create_bundle(target, base, fileobj, format)
773
def control_weaves(self):
775
return self._real_repository.control_weaves
778
def get_ancestry(self, revision_id, topo_sorted=True):
780
return self._real_repository.get_ancestry(revision_id, topo_sorted)
783
def get_inventory_weave(self):
785
return self._real_repository.get_inventory_weave()
787
def fileids_altered_by_revision_ids(self, revision_ids):
789
return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
791
def _get_versioned_file_checker(self, revisions, revision_versions_cache):
793
return self._real_repository._get_versioned_file_checker(
794
revisions, revision_versions_cache)
796
def iter_files_bytes(self, desired_files):
797
"""See Repository.iter_file_bytes.
800
return self._real_repository.iter_files_bytes(desired_files)
802
def get_parent_map(self, keys):
803
"""See bzrlib.Graph.get_parent_map()."""
804
# Hack to build up the caching logic.
805
ancestry = self._parents_map
807
# Repository is not locked, so there's no cache.
808
missing_revisions = set(keys)
811
missing_revisions = set(key for key in keys if key not in ancestry)
812
if missing_revisions:
813
parent_map = self._get_parent_map(missing_revisions)
814
if 'hpss' in debug.debug_flags:
815
mutter('retransmitted revisions: %d of %d',
816
len(set(ancestry).intersection(parent_map)),
818
ancestry.update(parent_map)
819
present_keys = [k for k in keys if k in ancestry]
820
if 'hpss' in debug.debug_flags:
821
self._requested_parents.update(present_keys)
822
mutter('Current RemoteRepository graph hit rate: %d%%',
823
100.0 * len(self._requested_parents) / len(ancestry))
824
return dict((k, ancestry[k]) for k in present_keys)
826
def _get_parent_map(self, keys):
827
"""Helper for get_parent_map that performs the RPC."""
828
medium = self._client._medium
829
if not medium._remote_is_at_least_1_2:
830
# We already found out that the server can't understand
831
# Repository.get_parent_map requests, so just fetch the whole
833
# XXX: Note that this will issue a deprecation warning. This is ok
834
# :- its because we're working with a deprecated server anyway, and
835
# the user will almost certainly have seen a warning about the
836
# server version already.
837
return self.get_revision_graph()
840
if NULL_REVISION in keys:
841
keys.discard(NULL_REVISION)
842
found_parents = {NULL_REVISION:()}
847
# TODO(Needs analysis): We could assume that the keys being requested
848
# from get_parent_map are in a breadth first search, so typically they
849
# will all be depth N from some common parent, and we don't have to
850
# have the server iterate from the root parent, but rather from the
851
# keys we're searching; and just tell the server the keyspace we
852
# already have; but this may be more traffic again.
854
# Transform self._parents_map into a search request recipe.
855
# TODO: Manage this incrementally to avoid covering the same path
856
# repeatedly. (The server will have to on each request, but the less
857
# work done the better).
858
parents_map = self._parents_map
859
if parents_map is None:
860
# Repository is not locked, so there's no cache.
862
start_set = set(parents_map)
863
result_parents = set()
864
for parents in parents_map.itervalues():
865
result_parents.update(parents)
866
stop_keys = result_parents.difference(start_set)
867
included_keys = start_set.intersection(result_parents)
868
start_set.difference_update(included_keys)
869
recipe = (start_set, stop_keys, len(parents_map))
870
body = self._serialise_search_recipe(recipe)
871
path = self.bzrdir._path_for_remote_call(self._client)
873
if not isinstance(key, str):
874
raise ValueError(key)
875
verb = 'Repository.get_parent_map'
876
args = (path,) + tuple(keys)
878
response = self._client.call_with_body_bytes_expecting_body(
879
verb, args, self._serialise_search_recipe(recipe))
880
except errors.UnknownSmartMethod:
881
# Server does not support this method, so get the whole graph.
882
# Worse, we have to force a disconnection, because the server now
883
# doesn't realise it has a body on the wire to consume, so the
884
# only way to recover is to abandon the connection.
886
'Server is too old for fast get_parent_map, reconnecting. '
887
'(Upgrade the server to Bazaar 1.2 to avoid this)')
889
# To avoid having to disconnect repeatedly, we keep track of the
890
# fact the server doesn't understand remote methods added in 1.2.
891
medium._remote_is_at_least_1_2 = False
892
return self.get_revision_graph(None)
893
if response[0][0] not in ['ok']:
894
response[1].cancel_read_body()
895
raise errors.UnexpectedSmartServerResponse(response[0])
896
if response[0][0] == 'ok':
897
coded = bz2.decompress(response[1].read_body_bytes())
901
lines = coded.split('\n')
904
d = tuple(line.split())
906
revision_graph[d[0]] = d[1:]
908
# No parents - so give the Graph result (NULL_REVISION,).
909
revision_graph[d[0]] = (NULL_REVISION,)
910
return revision_graph
913
def get_signature_text(self, revision_id):
915
return self._real_repository.get_signature_text(revision_id)
918
@symbol_versioning.deprecated_method(symbol_versioning.one_three)
919
def get_revision_graph_with_ghosts(self, revision_ids=None):
921
return self._real_repository.get_revision_graph_with_ghosts(
922
revision_ids=revision_ids)
925
def get_inventory_xml(self, revision_id):
927
return self._real_repository.get_inventory_xml(revision_id)
929
def deserialise_inventory(self, revision_id, xml):
931
return self._real_repository.deserialise_inventory(revision_id, xml)
933
def reconcile(self, other=None, thorough=False):
935
return self._real_repository.reconcile(other=other, thorough=thorough)
937
def all_revision_ids(self):
939
return self._real_repository.all_revision_ids()
942
def get_deltas_for_revisions(self, revisions):
944
return self._real_repository.get_deltas_for_revisions(revisions)
947
def get_revision_delta(self, revision_id):
949
return self._real_repository.get_revision_delta(revision_id)
952
def revision_trees(self, revision_ids):
954
return self._real_repository.revision_trees(revision_ids)
957
def get_revision_reconcile(self, revision_id):
959
return self._real_repository.get_revision_reconcile(revision_id)
962
def check(self, revision_ids=None):
964
return self._real_repository.check(revision_ids=revision_ids)
966
def copy_content_into(self, destination, revision_id=None):
968
return self._real_repository.copy_content_into(
969
destination, revision_id=revision_id)
971
def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
972
# get a tarball of the remote repository, and copy from that into the
974
from bzrlib import osutils
977
# TODO: Maybe a progress bar while streaming the tarball?
978
note("Copying repository content as tarball...")
979
tar_file = self._get_tarball('bz2')
982
destination = to_bzrdir.create_repository()
984
tar = tarfile.open('repository', fileobj=tar_file,
986
tmpdir = tempfile.mkdtemp()
988
_extract_tar(tar, tmpdir)
989
tmp_bzrdir = BzrDir.open(tmpdir)
990
tmp_repo = tmp_bzrdir.open_repository()
991
tmp_repo.copy_content_into(destination, revision_id)
993
osutils.rmtree(tmpdir)
997
# TODO: Suggestion from john: using external tar is much faster than
998
# python's tarfile library, but it may not work on windows.
1002
"""Compress the data within the repository.
1004
This is not currently implemented within the smart server.
1007
return self._real_repository.pack()
1009
def set_make_working_trees(self, new_value):
1011
self._real_repository.set_make_working_trees(new_value)
1014
def sign_revision(self, revision_id, gpg_strategy):
1016
return self._real_repository.sign_revision(revision_id, gpg_strategy)
1019
def get_revisions(self, revision_ids):
1021
return self._real_repository.get_revisions(revision_ids)
1023
def supports_rich_root(self):
1025
return self._real_repository.supports_rich_root()
1027
def iter_reverse_revision_history(self, revision_id):
1029
return self._real_repository.iter_reverse_revision_history(revision_id)
1032
def _serializer(self):
1034
return self._real_repository._serializer
1036
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1038
return self._real_repository.store_revision_signature(
1039
gpg_strategy, plaintext, revision_id)
1041
def add_signature_text(self, revision_id, signature):
1043
return self._real_repository.add_signature_text(revision_id, signature)
1045
def has_signature_for_revision_id(self, revision_id):
1047
return self._real_repository.has_signature_for_revision_id(revision_id)
1049
def get_data_stream_for_search(self, search):
1050
medium = self._client._medium
1051
if not medium._remote_is_at_least_1_2:
1053
return self._real_repository.get_data_stream_for_search(search)
1054
REQUEST_NAME = 'Repository.stream_revisions_chunked'
1055
path = self.bzrdir._path_for_remote_call(self._client)
1056
body = self._serialise_search_recipe(search.get_recipe())
1058
result = self._client.call_with_body_bytes_expecting_body(
1059
REQUEST_NAME, (path,), body)
1060
response, protocol = result
1061
except errors.UnknownSmartMethod:
1062
# Server does not support this method, so fall back to VFS.
1063
# Worse, we have to force a disconnection, because the server now
1064
# doesn't realise it has a body on the wire to consume, so the
1065
# only way to recover is to abandon the connection.
1067
'Server is too old for streaming pull, reconnecting. '
1068
'(Upgrade the server to Bazaar 1.2 to avoid this)')
1070
# To avoid having to disconnect repeatedly, we keep track of the
1071
# fact the server doesn't understand this remote method.
1072
medium._remote_is_at_least_1_2 = False
1074
return self._real_repository.get_data_stream_for_search(search)
1076
if response == ('ok',):
1077
return self._deserialise_stream(protocol)
1078
if response == ('NoSuchRevision', ):
1079
# We cannot easily identify the revision that is missing in this
1080
# situation without doing much more network IO. For now, bail.
1081
raise NoSuchRevision(self, "unknown")
1083
raise errors.UnexpectedSmartServerResponse(response)
1085
def _deserialise_stream(self, protocol):
1086
stream = protocol.read_streamed_body()
1087
container_parser = ContainerPushParser()
1088
for bytes in stream:
1089
container_parser.accept_bytes(bytes)
1090
records = container_parser.read_pending_records()
1091
for record_names, record_bytes in records:
1092
if len(record_names) != 1:
1093
# These records should have only one name, and that name
1094
# should be a one-element tuple.
1095
raise errors.SmartProtocolError(
1096
'Repository data stream had invalid record name %r'
1098
name_tuple = record_names[0]
1099
yield name_tuple, record_bytes
1101
def insert_data_stream(self, stream):
1103
self._real_repository.insert_data_stream(stream)
1105
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
1107
return self._real_repository.item_keys_introduced_by(revision_ids,
1108
_files_pb=_files_pb)
1110
def revision_graph_can_have_wrong_parents(self):
1111
# The answer depends on the remote repo format.
1113
return self._real_repository.revision_graph_can_have_wrong_parents()
1115
def _find_inconsistent_revision_parents(self):
1117
return self._real_repository._find_inconsistent_revision_parents()
1119
def _check_for_inconsistent_revision_parents(self):
1121
return self._real_repository._check_for_inconsistent_revision_parents()
1123
def _make_parents_provider(self):
1126
def _serialise_search_recipe(self, recipe):
1127
"""Serialise a graph search recipe.
1129
:param recipe: A search recipe (start, stop, count).
1130
:return: Serialised bytes.
1132
start_keys = ' '.join(recipe[0])
1133
stop_keys = ' '.join(recipe[1])
1134
count = str(recipe[2])
1135
return '\n'.join((start_keys, stop_keys, count))
1138
class RemoteBranchLockableFiles(LockableFiles):
1139
"""A 'LockableFiles' implementation that talks to a smart server.
1141
This is not a public interface class.
1144
def __init__(self, bzrdir, _client):
1145
self.bzrdir = bzrdir
1146
self._client = _client
1147
self._need_find_modes = True
1148
LockableFiles.__init__(
1149
self, bzrdir.get_branch_transport(None),
1150
'lock', lockdir.LockDir)
1152
def _find_modes(self):
1153
# RemoteBranches don't let the client set the mode of control files.
1154
self._dir_mode = None
1155
self._file_mode = None
1157
def get(self, path):
1158
"""'get' a remote path as per the LockableFiles interface.
1160
:param path: the file to 'get'. If this is 'branch.conf', we do not
1161
just retrieve a file, instead we ask the smart server to generate
1162
a configuration for us - which is retrieved as an INI file.
1164
if path == 'branch.conf':
1165
path = self.bzrdir._path_for_remote_call(self._client)
1166
response = self._client.call_expecting_body(
1167
'Branch.get_config_file', path)
1168
if response[0][0] != 'ok':
1169
raise SmartProtocolError(
1170
'unexpected response code %s' % (response[0],))
1171
return StringIO(response[1].read_body_bytes())
1174
return LockableFiles.get(self, path)
1177
class RemoteBranchFormat(branch.BranchFormat):
1179
def __eq__(self, other):
1180
return (isinstance(other, RemoteBranchFormat) and
1181
self.__dict__ == other.__dict__)
1183
def get_format_description(self):
1184
return 'Remote BZR Branch'
1186
def get_format_string(self):
1187
return 'Remote BZR Branch'
1189
def open(self, a_bzrdir):
1190
return a_bzrdir.open_branch()
1192
def initialize(self, a_bzrdir):
1193
return a_bzrdir.create_branch()
1195
def supports_tags(self):
1196
# Remote branches might support tags, but we won't know until we
1197
# access the real remote branch.
1201
class RemoteBranch(branch.Branch):
1202
"""Branch stored on a server accessed by HPSS RPC.
1204
At the moment most operations are mapped down to simple file operations.
1207
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
1209
"""Create a RemoteBranch instance.
1211
:param real_branch: An optional local implementation of the branch
1212
format, usually accessing the data via the VFS.
1213
:param _client: Private parameter for testing.
1215
# We intentionally don't call the parent class's __init__, because it
1216
# will try to assign to self.tags, which is a property in this subclass.
1217
# And the parent's __init__ doesn't do much anyway.
1218
self._revision_id_to_revno_cache = None
1219
self._revision_history_cache = None
1220
self.bzrdir = remote_bzrdir
1221
if _client is not None:
1222
self._client = _client
1224
self._client = remote_bzrdir._client
1225
self.repository = remote_repository
1226
if real_branch is not None:
1227
self._real_branch = real_branch
1228
# Give the remote repository the matching real repo.
1229
real_repo = self._real_branch.repository
1230
if isinstance(real_repo, RemoteRepository):
1231
real_repo._ensure_real()
1232
real_repo = real_repo._real_repository
1233
self.repository._set_real_repository(real_repo)
1234
# Give the branch the remote repository to let fast-pathing happen.
1235
self._real_branch.repository = self.repository
1237
self._real_branch = None
1238
# Fill out expected attributes of branch for bzrlib api users.
1239
self._format = RemoteBranchFormat()
1240
self.base = self.bzrdir.root_transport.base
1241
self._control_files = None
1242
self._lock_mode = None
1243
self._lock_token = None
1244
self._repo_lock_token = None
1245
self._lock_count = 0
1246
self._leave_lock = False
1249
return "%s(%s)" % (self.__class__.__name__, self.base)
1253
def _ensure_real(self):
1254
"""Ensure that there is a _real_branch set.
1256
Used before calls to self._real_branch.
1258
if not self._real_branch:
1259
if not vfs.vfs_enabled():
1260
raise AssertionError('smart server vfs must be enabled '
1261
'to use vfs implementation')
1262
self.bzrdir._ensure_real()
1263
self._real_branch = self.bzrdir._real_bzrdir.open_branch()
1264
# Give the remote repository the matching real repo.
1265
real_repo = self._real_branch.repository
1266
if isinstance(real_repo, RemoteRepository):
1267
real_repo._ensure_real()
1268
real_repo = real_repo._real_repository
1269
self.repository._set_real_repository(real_repo)
1270
# Give the branch the remote repository to let fast-pathing happen.
1271
self._real_branch.repository = self.repository
1272
# XXX: deal with _lock_mode == 'w'
1273
if self._lock_mode == 'r':
1274
self._real_branch.lock_read()
1277
def control_files(self):
1278
# Defer actually creating RemoteBranchLockableFiles until its needed,
1279
# because it triggers an _ensure_real that we otherwise might not need.
1280
if self._control_files is None:
1281
self._control_files = RemoteBranchLockableFiles(
1282
self.bzrdir, self._client)
1283
return self._control_files
1285
def _get_checkout_format(self):
1287
return self._real_branch._get_checkout_format()
1289
def get_physical_lock_status(self):
1290
"""See Branch.get_physical_lock_status()."""
1291
# should be an API call to the server, as branches must be lockable.
1293
return self._real_branch.get_physical_lock_status()
1295
def lock_read(self):
1296
if not self._lock_mode:
1297
self._lock_mode = 'r'
1298
self._lock_count = 1
1299
if self._real_branch is not None:
1300
self._real_branch.lock_read()
1302
self._lock_count += 1
1304
def _remote_lock_write(self, token):
1306
branch_token = repo_token = ''
1308
branch_token = token
1309
repo_token = self.repository.lock_write()
1310
self.repository.unlock()
1311
path = self.bzrdir._path_for_remote_call(self._client)
1312
response = self._client.call('Branch.lock_write', path, branch_token,
1314
if response[0] == 'ok':
1315
ok, branch_token, repo_token = response
1316
return branch_token, repo_token
1317
elif response[0] == 'LockContention':
1318
raise errors.LockContention('(remote lock)')
1319
elif response[0] == 'TokenMismatch':
1320
raise errors.TokenMismatch(token, '(remote token)')
1321
elif response[0] == 'UnlockableTransport':
1322
raise errors.UnlockableTransport(self.bzrdir.root_transport)
1323
elif response[0] == 'ReadOnlyError':
1324
raise errors.ReadOnlyError(self)
1325
elif response[0] == 'LockFailed':
1326
raise errors.LockFailed(response[1], response[2])
1328
raise errors.UnexpectedSmartServerResponse(response)
1330
def lock_write(self, token=None):
1331
if not self._lock_mode:
1332
remote_tokens = self._remote_lock_write(token)
1333
self._lock_token, self._repo_lock_token = remote_tokens
1334
if not self._lock_token:
1335
raise SmartProtocolError('Remote server did not return a token!')
1336
# TODO: We really, really, really don't want to call _ensure_real
1337
# here, but it's the easiest way to ensure coherency between the
1338
# state of the RemoteBranch and RemoteRepository objects and the
1339
# physical locks. If we don't materialise the real objects here,
1340
# then getting everything in the right state later is complex, so
1341
# for now we just do it the lazy way.
1342
# -- Andrew Bennetts, 2007-02-22.
1344
if self._real_branch is not None:
1345
self._real_branch.repository.lock_write(
1346
token=self._repo_lock_token)
1348
self._real_branch.lock_write(token=self._lock_token)
1350
self._real_branch.repository.unlock()
1351
if token is not None:
1352
self._leave_lock = True
1354
# XXX: this case seems to be unreachable; token cannot be None.
1355
self._leave_lock = False
1356
self._lock_mode = 'w'
1357
self._lock_count = 1
1358
elif self._lock_mode == 'r':
1359
raise errors.ReadOnlyTransaction
1361
if token is not None:
1362
# A token was given to lock_write, and we're relocking, so check
1363
# that the given token actually matches the one we already have.
1364
if token != self._lock_token:
1365
raise errors.TokenMismatch(token, self._lock_token)
1366
self._lock_count += 1
1367
return self._lock_token or None
1369
def _unlock(self, branch_token, repo_token):
1370
path = self.bzrdir._path_for_remote_call(self._client)
1371
response = self._client.call('Branch.unlock', path, branch_token,
1373
if response == ('ok',):
1375
elif response[0] == 'TokenMismatch':
1376
raise errors.TokenMismatch(
1377
str((branch_token, repo_token)), '(remote tokens)')
1379
raise errors.UnexpectedSmartServerResponse(response)
1382
self._lock_count -= 1
1383
if not self._lock_count:
1384
self._clear_cached_state()
1385
mode = self._lock_mode
1386
self._lock_mode = None
1387
if self._real_branch is not None:
1388
if (not self._leave_lock and mode == 'w' and
1389
self._repo_lock_token):
1390
# If this RemoteBranch will remove the physical lock for the
1391
# repository, make sure the _real_branch doesn't do it
1392
# first. (Because the _real_branch's repository is set to
1393
# be the RemoteRepository.)
1394
self._real_branch.repository.leave_lock_in_place()
1395
self._real_branch.unlock()
1397
# Only write-locked branched need to make a remote method call
1398
# to perfom the unlock.
1400
if not self._lock_token:
1401
raise AssertionError('Locked, but no token!')
1402
branch_token = self._lock_token
1403
repo_token = self._repo_lock_token
1404
self._lock_token = None
1405
self._repo_lock_token = None
1406
if not self._leave_lock:
1407
self._unlock(branch_token, repo_token)
1409
def break_lock(self):
1411
return self._real_branch.break_lock()
1413
def leave_lock_in_place(self):
1414
if not self._lock_token:
1415
raise NotImplementedError(self.leave_lock_in_place)
1416
self._leave_lock = True
1418
def dont_leave_lock_in_place(self):
1419
if not self._lock_token:
1420
raise NotImplementedError(self.dont_leave_lock_in_place)
1421
self._leave_lock = False
1423
def last_revision_info(self):
1424
"""See Branch.last_revision_info()."""
1425
path = self.bzrdir._path_for_remote_call(self._client)
1426
response = self._client.call('Branch.last_revision_info', path)
1427
if response[0] != 'ok':
1428
raise SmartProtocolError('unexpected response code %s' % (response,))
1429
revno = int(response[1])
1430
last_revision = response[2]
1431
return (revno, last_revision)
1433
def _gen_revision_history(self):
1434
"""See Branch._gen_revision_history()."""
1435
path = self.bzrdir._path_for_remote_call(self._client)
1436
response = self._client.call_expecting_body(
1437
'Branch.revision_history', path)
1438
if response[0][0] != 'ok':
1439
raise SmartProtocolError('unexpected response code %s' % (response,))
1440
result = response[1].read_body_bytes().split('\x00')
1446
def set_revision_history(self, rev_history):
1447
# Send just the tip revision of the history; the server will generate
1448
# the full history from that. If the revision doesn't exist in this
1449
# branch, NoSuchRevision will be raised.
1450
path = self.bzrdir._path_for_remote_call(self._client)
1451
if rev_history == []:
1454
rev_id = rev_history[-1]
1455
self._clear_cached_state()
1456
response = self._client.call('Branch.set_last_revision',
1457
path, self._lock_token, self._repo_lock_token, rev_id)
1458
if response[0] == 'NoSuchRevision':
1459
raise NoSuchRevision(self, rev_id)
1460
elif response[0] != 'ok':
1461
raise SmartProtocolError('unexpected response code %s' % (response,))
1462
self._cache_revision_history(rev_history)
1464
def get_parent(self):
1466
return self._real_branch.get_parent()
1468
def set_parent(self, url):
1470
return self._real_branch.set_parent(url)
1472
def get_config(self):
1473
return RemoteBranchConfig(self)
1475
def sprout(self, to_bzrdir, revision_id=None):
1476
# Like Branch.sprout, except that it sprouts a branch in the default
1477
# format, because RemoteBranches can't be created at arbitrary URLs.
1478
# XXX: if to_bzrdir is a RemoteBranch, this should perhaps do
1479
# to_bzrdir.create_branch...
1481
result = self._real_branch._format.initialize(to_bzrdir)
1482
self.copy_content_into(result, revision_id=revision_id)
1483
result.set_parent(self.bzrdir.root_transport.base)
1487
def pull(self, source, overwrite=False, stop_revision=None,
1489
# FIXME: This asks the real branch to run the hooks, which means
1490
# they're called with the wrong target branch parameter.
1491
# The test suite specifically allows this at present but it should be
1492
# fixed. It should get a _override_hook_target branch,
1493
# as push does. -- mbp 20070405
1495
self._real_branch.pull(
1496
source, overwrite=overwrite, stop_revision=stop_revision,
1500
def push(self, target, overwrite=False, stop_revision=None):
1502
return self._real_branch.push(
1503
target, overwrite=overwrite, stop_revision=stop_revision,
1504
_override_hook_source_branch=self)
1506
def is_locked(self):
1507
return self._lock_count >= 1
1510
def set_last_revision_info(self, revno, revision_id):
1511
revision_id = ensure_null(revision_id)
1512
path = self.bzrdir._path_for_remote_call(self._client)
1514
response = self._client.call('Branch.set_last_revision_info',
1515
path, self._lock_token, self._repo_lock_token, str(revno), revision_id)
1516
except errors.UnknownSmartMethod:
1518
self._clear_cached_state()
1519
return self._real_branch.set_last_revision_info(revno, revision_id)
1520
if response == ('ok',):
1521
self._clear_cached_state()
1522
elif response[0] == 'NoSuchRevision':
1523
raise NoSuchRevision(self, response[1])
1525
raise errors.UnexpectedSmartServerResponse(response)
1527
def generate_revision_history(self, revision_id, last_rev=None,
1530
return self._real_branch.generate_revision_history(
1531
revision_id, last_rev=last_rev, other_branch=other_branch)
1536
return self._real_branch.tags
1538
def set_push_location(self, location):
1540
return self._real_branch.set_push_location(location)
1542
def update_revisions(self, other, stop_revision=None, overwrite=False):
1544
return self._real_branch.update_revisions(
1545
other, stop_revision=stop_revision, overwrite=overwrite)
1548
class RemoteBranchConfig(BranchConfig):
1551
self.branch._ensure_real()
1552
return self.branch._real_branch.get_config().username()
1554
def _get_branch_data_config(self):
1555
self.branch._ensure_real()
1556
if self._branch_data_config is None:
1557
self._branch_data_config = TreeConfig(self.branch._real_branch)
1558
return self._branch_data_config
1561
def _extract_tar(tar, to_dir):
1562
"""Extract all the contents of a tarfile object.
1564
A replacement for extractall, which is not present in python2.4
1567
tar.extract(tarinfo, to_dir)
added
removed
bzrlib/remote.py
