1
# Copyright (C) 2006, 2007, 2008 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
rg = self.get_revision_graph()
838
# There is an api discrepency between get_parent_map and
839
# get_revision_graph. Specifically, a "key:()" pair in
840
# get_revision_graph just means a node has no parents. For
841
# "get_parent_map" it means the node is a ghost. So fix up the
842
# graph to correct this.
843
# https://bugs.launchpad.net/bzr/+bug/214894
844
# There is one other "bug" which is that ghosts in
845
# get_revision_graph() are not returned at all. But we won't worry
846
# about that for now.
847
for node_id, parent_ids in rg.iteritems():
849
rg[node_id] = (NULL_REVISION,)
850
rg[NULL_REVISION] = ()
854
if NULL_REVISION in keys:
855
keys.discard(NULL_REVISION)
856
found_parents = {NULL_REVISION:()}
861
# TODO(Needs analysis): We could assume that the keys being requested
862
# from get_parent_map are in a breadth first search, so typically they
863
# will all be depth N from some common parent, and we don't have to
864
# have the server iterate from the root parent, but rather from the
865
# keys we're searching; and just tell the server the keyspace we
866
# already have; but this may be more traffic again.
868
# Transform self._parents_map into a search request recipe.
869
# TODO: Manage this incrementally to avoid covering the same path
870
# repeatedly. (The server will have to on each request, but the less
871
# work done the better).
872
parents_map = self._parents_map
873
if parents_map is None:
874
# Repository is not locked, so there's no cache.
876
start_set = set(parents_map)
877
result_parents = set()
878
for parents in parents_map.itervalues():
879
result_parents.update(parents)
880
stop_keys = result_parents.difference(start_set)
881
included_keys = start_set.intersection(result_parents)
882
start_set.difference_update(included_keys)
883
recipe = (start_set, stop_keys, len(parents_map))
884
body = self._serialise_search_recipe(recipe)
885
path = self.bzrdir._path_for_remote_call(self._client)
887
if type(key) is not str:
889
"key %r not a plain string" % (key,))
890
verb = 'Repository.get_parent_map'
891
args = (path,) + tuple(keys)
893
response = self._client.call_with_body_bytes_expecting_body(
894
verb, args, self._serialise_search_recipe(recipe))
895
except errors.UnknownSmartMethod:
896
# Server does not support this method, so get the whole graph.
897
# Worse, we have to force a disconnection, because the server now
898
# doesn't realise it has a body on the wire to consume, so the
899
# only way to recover is to abandon the connection.
901
'Server is too old for fast get_parent_map, reconnecting. '
902
'(Upgrade the server to Bazaar 1.2 to avoid this)')
904
# To avoid having to disconnect repeatedly, we keep track of the
905
# fact the server doesn't understand remote methods added in 1.2.
906
medium._remote_is_at_least_1_2 = False
907
return self.get_revision_graph(None)
908
if response[0][0] not in ['ok']:
909
response[1].cancel_read_body()
910
raise errors.UnexpectedSmartServerResponse(response[0])
911
if response[0][0] == 'ok':
912
coded = bz2.decompress(response[1].read_body_bytes())
916
lines = coded.split('\n')
919
d = tuple(line.split())
921
revision_graph[d[0]] = d[1:]
923
# No parents - so give the Graph result (NULL_REVISION,).
924
revision_graph[d[0]] = (NULL_REVISION,)
925
return revision_graph
928
def get_signature_text(self, revision_id):
930
return self._real_repository.get_signature_text(revision_id)
933
@symbol_versioning.deprecated_method(symbol_versioning.one_three)
934
def get_revision_graph_with_ghosts(self, revision_ids=None):
936
return self._real_repository.get_revision_graph_with_ghosts(
937
revision_ids=revision_ids)
940
def get_inventory_xml(self, revision_id):
942
return self._real_repository.get_inventory_xml(revision_id)
944
def deserialise_inventory(self, revision_id, xml):
946
return self._real_repository.deserialise_inventory(revision_id, xml)
948
def reconcile(self, other=None, thorough=False):
950
return self._real_repository.reconcile(other=other, thorough=thorough)
952
def all_revision_ids(self):
954
return self._real_repository.all_revision_ids()
957
def get_deltas_for_revisions(self, revisions):
959
return self._real_repository.get_deltas_for_revisions(revisions)
962
def get_revision_delta(self, revision_id):
964
return self._real_repository.get_revision_delta(revision_id)
967
def revision_trees(self, revision_ids):
969
return self._real_repository.revision_trees(revision_ids)
972
def get_revision_reconcile(self, revision_id):
974
return self._real_repository.get_revision_reconcile(revision_id)
977
def check(self, revision_ids=None):
979
return self._real_repository.check(revision_ids=revision_ids)
981
def copy_content_into(self, destination, revision_id=None):
983
return self._real_repository.copy_content_into(
984
destination, revision_id=revision_id)
986
def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
987
# get a tarball of the remote repository, and copy from that into the
989
from bzrlib import osutils
992
# TODO: Maybe a progress bar while streaming the tarball?
993
note("Copying repository content as tarball...")
994
tar_file = self._get_tarball('bz2')
997
destination = to_bzrdir.create_repository()
999
tar = tarfile.open('repository', fileobj=tar_file,
1001
tmpdir = tempfile.mkdtemp()
1003
_extract_tar(tar, tmpdir)
1004
tmp_bzrdir = BzrDir.open(tmpdir)
1005
tmp_repo = tmp_bzrdir.open_repository()
1006
tmp_repo.copy_content_into(destination, revision_id)
1008
osutils.rmtree(tmpdir)
1012
# TODO: Suggestion from john: using external tar is much faster than
1013
# python's tarfile library, but it may not work on windows.
1017
"""Compress the data within the repository.
1019
This is not currently implemented within the smart server.
1022
return self._real_repository.pack()
1024
def set_make_working_trees(self, new_value):
1026
self._real_repository.set_make_working_trees(new_value)
1029
def sign_revision(self, revision_id, gpg_strategy):
1031
return self._real_repository.sign_revision(revision_id, gpg_strategy)
1034
def get_revisions(self, revision_ids):
1036
return self._real_repository.get_revisions(revision_ids)
1038
def supports_rich_root(self):
1040
return self._real_repository.supports_rich_root()
1042
def iter_reverse_revision_history(self, revision_id):
1044
return self._real_repository.iter_reverse_revision_history(revision_id)
1047
def _serializer(self):
1049
return self._real_repository._serializer
1051
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1053
return self._real_repository.store_revision_signature(
1054
gpg_strategy, plaintext, revision_id)
1056
def add_signature_text(self, revision_id, signature):
1058
return self._real_repository.add_signature_text(revision_id, signature)
1060
def has_signature_for_revision_id(self, revision_id):
1062
return self._real_repository.has_signature_for_revision_id(revision_id)
1064
def get_data_stream_for_search(self, search):
1065
medium = self._client._medium
1066
if not medium._remote_is_at_least_1_2:
1068
return self._real_repository.get_data_stream_for_search(search)
1069
REQUEST_NAME = 'Repository.stream_revisions_chunked'
1070
path = self.bzrdir._path_for_remote_call(self._client)
1071
body = self._serialise_search_recipe(search.get_recipe())
1073
result = self._client.call_with_body_bytes_expecting_body(
1074
REQUEST_NAME, (path,), body)
1075
response, protocol = result
1076
except errors.UnknownSmartMethod:
1077
# Server does not support this method, so fall back to VFS.
1078
# Worse, we have to force a disconnection, because the server now
1079
# doesn't realise it has a body on the wire to consume, so the
1080
# only way to recover is to abandon the connection.
1082
'Server is too old for streaming pull, reconnecting. '
1083
'(Upgrade the server to Bazaar 1.2 to avoid this)')
1085
# To avoid having to disconnect repeatedly, we keep track of the
1086
# fact the server doesn't understand this remote method.
1087
medium._remote_is_at_least_1_2 = False
1089
return self._real_repository.get_data_stream_for_search(search)
1091
if response == ('ok',):
1092
return self._deserialise_stream(protocol)
1093
if response == ('NoSuchRevision', ):
1094
# We cannot easily identify the revision that is missing in this
1095
# situation without doing much more network IO. For now, bail.
1096
raise NoSuchRevision(self, "unknown")
1098
raise errors.UnexpectedSmartServerResponse(response)
1100
def _deserialise_stream(self, protocol):
1101
stream = protocol.read_streamed_body()
1102
container_parser = ContainerPushParser()
1103
for bytes in stream:
1104
container_parser.accept_bytes(bytes)
1105
records = container_parser.read_pending_records()
1106
for record_names, record_bytes in records:
1107
if len(record_names) != 1:
1108
# These records should have only one name, and that name
1109
# should be a one-element tuple.
1110
raise errors.SmartProtocolError(
1111
'Repository data stream had invalid record name %r'
1113
name_tuple = record_names[0]
1114
yield name_tuple, record_bytes
1116
def insert_data_stream(self, stream):
1118
self._real_repository.insert_data_stream(stream)
1120
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
1122
return self._real_repository.item_keys_introduced_by(revision_ids,
1123
_files_pb=_files_pb)
1125
def revision_graph_can_have_wrong_parents(self):
1126
# The answer depends on the remote repo format.
1128
return self._real_repository.revision_graph_can_have_wrong_parents()
1130
def _find_inconsistent_revision_parents(self):
1132
return self._real_repository._find_inconsistent_revision_parents()
1134
def _check_for_inconsistent_revision_parents(self):
1136
return self._real_repository._check_for_inconsistent_revision_parents()
1138
def _make_parents_provider(self):
1141
def _serialise_search_recipe(self, recipe):
1142
"""Serialise a graph search recipe.
1144
:param recipe: A search recipe (start, stop, count).
1145
:return: Serialised bytes.
1147
start_keys = ' '.join(recipe[0])
1148
stop_keys = ' '.join(recipe[1])
1149
count = str(recipe[2])
1150
return '\n'.join((start_keys, stop_keys, count))
1153
class RemoteBranchLockableFiles(LockableFiles):
1154
"""A 'LockableFiles' implementation that talks to a smart server.
1156
This is not a public interface class.
1159
def __init__(self, bzrdir, _client):
1160
self.bzrdir = bzrdir
1161
self._client = _client
1162
self._need_find_modes = True
1163
LockableFiles.__init__(
1164
self, bzrdir.get_branch_transport(None),
1165
'lock', lockdir.LockDir)
1167
def _find_modes(self):
1168
# RemoteBranches don't let the client set the mode of control files.
1169
self._dir_mode = None
1170
self._file_mode = None
1173
class RemoteBranchFormat(branch.BranchFormat):
1175
def __eq__(self, other):
1176
return (isinstance(other, RemoteBranchFormat) and
1177
self.__dict__ == other.__dict__)
1179
def get_format_description(self):
1180
return 'Remote BZR Branch'
1182
def get_format_string(self):
1183
return 'Remote BZR Branch'
1185
def open(self, a_bzrdir):
1186
return a_bzrdir.open_branch()
1188
def initialize(self, a_bzrdir):
1189
return a_bzrdir.create_branch()
1191
def supports_tags(self):
1192
# Remote branches might support tags, but we won't know until we
1193
# access the real remote branch.
1197
class RemoteBranch(branch.Branch):
1198
"""Branch stored on a server accessed by HPSS RPC.
1200
At the moment most operations are mapped down to simple file operations.
1203
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
1205
"""Create a RemoteBranch instance.
1207
:param real_branch: An optional local implementation of the branch
1208
format, usually accessing the data via the VFS.
1209
:param _client: Private parameter for testing.
1211
# We intentionally don't call the parent class's __init__, because it
1212
# will try to assign to self.tags, which is a property in this subclass.
1213
# And the parent's __init__ doesn't do much anyway.
1214
self._revision_id_to_revno_cache = None
1215
self._revision_history_cache = None
1216
self.bzrdir = remote_bzrdir
1217
if _client is not None:
1218
self._client = _client
1220
self._client = remote_bzrdir._client
1221
self.repository = remote_repository
1222
if real_branch is not None:
1223
self._real_branch = real_branch
1224
# Give the remote repository the matching real repo.
1225
real_repo = self._real_branch.repository
1226
if isinstance(real_repo, RemoteRepository):
1227
real_repo._ensure_real()
1228
real_repo = real_repo._real_repository
1229
self.repository._set_real_repository(real_repo)
1230
# Give the branch the remote repository to let fast-pathing happen.
1231
self._real_branch.repository = self.repository
1233
self._real_branch = None
1234
# Fill out expected attributes of branch for bzrlib api users.
1235
self._format = RemoteBranchFormat()
1236
self.base = self.bzrdir.root_transport.base
1237
self._control_files = None
1238
self._lock_mode = None
1239
self._lock_token = None
1240
self._repo_lock_token = None
1241
self._lock_count = 0
1242
self._leave_lock = False
1245
return "%s(%s)" % (self.__class__.__name__, self.base)
1249
def _ensure_real(self):
1250
"""Ensure that there is a _real_branch set.
1252
Used before calls to self._real_branch.
1254
if not self._real_branch:
1255
if not vfs.vfs_enabled():
1256
raise AssertionError('smart server vfs must be enabled '
1257
'to use vfs implementation')
1258
self.bzrdir._ensure_real()
1259
self._real_branch = self.bzrdir._real_bzrdir.open_branch()
1260
# Give the remote repository the matching real repo.
1261
real_repo = self._real_branch.repository
1262
if isinstance(real_repo, RemoteRepository):
1263
real_repo._ensure_real()
1264
real_repo = real_repo._real_repository
1265
self.repository._set_real_repository(real_repo)
1266
# Give the branch the remote repository to let fast-pathing happen.
1267
self._real_branch.repository = self.repository
1268
# XXX: deal with _lock_mode == 'w'
1269
if self._lock_mode == 'r':
1270
self._real_branch.lock_read()
1273
def control_files(self):
1274
# Defer actually creating RemoteBranchLockableFiles until its needed,
1275
# because it triggers an _ensure_real that we otherwise might not need.
1276
if self._control_files is None:
1277
self._control_files = RemoteBranchLockableFiles(
1278
self.bzrdir, self._client)
1279
return self._control_files
1281
def _get_checkout_format(self):
1283
return self._real_branch._get_checkout_format()
1285
def get_physical_lock_status(self):
1286
"""See Branch.get_physical_lock_status()."""
1287
# should be an API call to the server, as branches must be lockable.
1289
return self._real_branch.get_physical_lock_status()
1291
def lock_read(self):
1292
if not self._lock_mode:
1293
self._lock_mode = 'r'
1294
self._lock_count = 1
1295
if self._real_branch is not None:
1296
self._real_branch.lock_read()
1298
self._lock_count += 1
1300
def _remote_lock_write(self, token):
1302
branch_token = repo_token = ''
1304
branch_token = token
1305
repo_token = self.repository.lock_write()
1306
self.repository.unlock()
1307
path = self.bzrdir._path_for_remote_call(self._client)
1308
response = self._client.call('Branch.lock_write', path, branch_token,
1310
if response[0] == 'ok':
1311
ok, branch_token, repo_token = response
1312
return branch_token, repo_token
1313
elif response[0] == 'LockContention':
1314
raise errors.LockContention('(remote lock)')
1315
elif response[0] == 'TokenMismatch':
1316
raise errors.TokenMismatch(token, '(remote token)')
1317
elif response[0] == 'UnlockableTransport':
1318
raise errors.UnlockableTransport(self.bzrdir.root_transport)
1319
elif response[0] == 'ReadOnlyError':
1320
raise errors.ReadOnlyError(self)
1321
elif response[0] == 'LockFailed':
1322
raise errors.LockFailed(response[1], response[2])
1324
raise errors.UnexpectedSmartServerResponse(response)
1326
def lock_write(self, token=None):
1327
if not self._lock_mode:
1328
remote_tokens = self._remote_lock_write(token)
1329
self._lock_token, self._repo_lock_token = remote_tokens
1330
if not self._lock_token:
1331
raise SmartProtocolError('Remote server did not return a token!')
1332
# TODO: We really, really, really don't want to call _ensure_real
1333
# here, but it's the easiest way to ensure coherency between the
1334
# state of the RemoteBranch and RemoteRepository objects and the
1335
# physical locks. If we don't materialise the real objects here,
1336
# then getting everything in the right state later is complex, so
1337
# for now we just do it the lazy way.
1338
# -- Andrew Bennetts, 2007-02-22.
1340
if self._real_branch is not None:
1341
self._real_branch.repository.lock_write(
1342
token=self._repo_lock_token)
1344
self._real_branch.lock_write(token=self._lock_token)
1346
self._real_branch.repository.unlock()
1347
if token is not None:
1348
self._leave_lock = True
1350
# XXX: this case seems to be unreachable; token cannot be None.
1351
self._leave_lock = False
1352
self._lock_mode = 'w'
1353
self._lock_count = 1
1354
elif self._lock_mode == 'r':
1355
raise errors.ReadOnlyTransaction
1357
if token is not None:
1358
# A token was given to lock_write, and we're relocking, so check
1359
# that the given token actually matches the one we already have.
1360
if token != self._lock_token:
1361
raise errors.TokenMismatch(token, self._lock_token)
1362
self._lock_count += 1
1363
return self._lock_token or None
1365
def _unlock(self, branch_token, repo_token):
1366
path = self.bzrdir._path_for_remote_call(self._client)
1367
response = self._client.call('Branch.unlock', path, branch_token,
1369
if response == ('ok',):
1371
elif response[0] == 'TokenMismatch':
1372
raise errors.TokenMismatch(
1373
str((branch_token, repo_token)), '(remote tokens)')
1375
raise errors.UnexpectedSmartServerResponse(response)
1378
self._lock_count -= 1
1379
if not self._lock_count:
1380
self._clear_cached_state()
1381
mode = self._lock_mode
1382
self._lock_mode = None
1383
if self._real_branch is not None:
1384
if (not self._leave_lock and mode == 'w' and
1385
self._repo_lock_token):
1386
# If this RemoteBranch will remove the physical lock for the
1387
# repository, make sure the _real_branch doesn't do it
1388
# first. (Because the _real_branch's repository is set to
1389
# be the RemoteRepository.)
1390
self._real_branch.repository.leave_lock_in_place()
1391
self._real_branch.unlock()
1393
# Only write-locked branched need to make a remote method call
1394
# to perfom the unlock.
1396
if not self._lock_token:
1397
raise AssertionError('Locked, but no token!')
1398
branch_token = self._lock_token
1399
repo_token = self._repo_lock_token
1400
self._lock_token = None
1401
self._repo_lock_token = None
1402
if not self._leave_lock:
1403
self._unlock(branch_token, repo_token)
1405
def break_lock(self):
1407
return self._real_branch.break_lock()
1409
def leave_lock_in_place(self):
1410
if not self._lock_token:
1411
raise NotImplementedError(self.leave_lock_in_place)
1412
self._leave_lock = True
1414
def dont_leave_lock_in_place(self):
1415
if not self._lock_token:
1416
raise NotImplementedError(self.dont_leave_lock_in_place)
1417
self._leave_lock = False
1419
def last_revision_info(self):
1420
"""See Branch.last_revision_info()."""
1421
path = self.bzrdir._path_for_remote_call(self._client)
1422
response = self._client.call('Branch.last_revision_info', path)
1423
if response[0] != 'ok':
1424
raise SmartProtocolError('unexpected response code %s' % (response,))
1425
revno = int(response[1])
1426
last_revision = response[2]
1427
return (revno, last_revision)
1429
def _gen_revision_history(self):
1430
"""See Branch._gen_revision_history()."""
1431
path = self.bzrdir._path_for_remote_call(self._client)
1432
response = self._client.call_expecting_body(
1433
'Branch.revision_history', path)
1434
if response[0][0] != 'ok':
1435
raise SmartProtocolError('unexpected response code %s' % (response,))
1436
result = response[1].read_body_bytes().split('\x00')
1442
def set_revision_history(self, rev_history):
1443
# Send just the tip revision of the history; the server will generate
1444
# the full history from that. If the revision doesn't exist in this
1445
# branch, NoSuchRevision will be raised.
1446
path = self.bzrdir._path_for_remote_call(self._client)
1447
if rev_history == []:
1450
rev_id = rev_history[-1]
1451
self._clear_cached_state()
1452
response = self._client.call('Branch.set_last_revision',
1453
path, self._lock_token, self._repo_lock_token, rev_id)
1454
if response[0] == 'NoSuchRevision':
1455
raise NoSuchRevision(self, rev_id)
1456
elif response[0] != 'ok':
1457
raise SmartProtocolError('unexpected response code %s' % (response,))
1458
self._cache_revision_history(rev_history)
1460
def get_parent(self):
1462
return self._real_branch.get_parent()
1464
def set_parent(self, url):
1466
return self._real_branch.set_parent(url)
1468
def sprout(self, to_bzrdir, revision_id=None):
1469
# Like Branch.sprout, except that it sprouts a branch in the default
1470
# format, because RemoteBranches can't be created at arbitrary URLs.
1471
# XXX: if to_bzrdir is a RemoteBranch, this should perhaps do
1472
# to_bzrdir.create_branch...
1474
result = self._real_branch._format.initialize(to_bzrdir)
1475
self.copy_content_into(result, revision_id=revision_id)
1476
result.set_parent(self.bzrdir.root_transport.base)
1480
def pull(self, source, overwrite=False, stop_revision=None,
1482
# FIXME: This asks the real branch to run the hooks, which means
1483
# they're called with the wrong target branch parameter.
1484
# The test suite specifically allows this at present but it should be
1485
# fixed. It should get a _override_hook_target branch,
1486
# as push does. -- mbp 20070405
1488
self._real_branch.pull(
1489
source, overwrite=overwrite, stop_revision=stop_revision,
1493
def push(self, target, overwrite=False, stop_revision=None):
1495
return self._real_branch.push(
1496
target, overwrite=overwrite, stop_revision=stop_revision,
1497
_override_hook_source_branch=self)
1499
def is_locked(self):
1500
return self._lock_count >= 1
1503
def set_last_revision_info(self, revno, revision_id):
1504
revision_id = ensure_null(revision_id)
1505
path = self.bzrdir._path_for_remote_call(self._client)
1507
response = self._client.call('Branch.set_last_revision_info',
1508
path, self._lock_token, self._repo_lock_token, str(revno), revision_id)
1509
except errors.UnknownSmartMethod:
1511
self._clear_cached_state()
1512
return self._real_branch.set_last_revision_info(revno, revision_id)
1513
if response == ('ok',):
1514
self._clear_cached_state()
1515
elif response[0] == 'NoSuchRevision':
1516
raise NoSuchRevision(self, response[1])
1518
raise errors.UnexpectedSmartServerResponse(response)
1520
def generate_revision_history(self, revision_id, last_rev=None,
1523
return self._real_branch.generate_revision_history(
1524
revision_id, last_rev=last_rev, other_branch=other_branch)
1529
return self._real_branch.tags
1531
def set_push_location(self, location):
1533
return self._real_branch.set_push_location(location)
1535
def update_revisions(self, other, stop_revision=None, overwrite=False):
1537
return self._real_branch.update_revisions(
1538
other, stop_revision=stop_revision, overwrite=overwrite)
1541
def _extract_tar(tar, to_dir):
1542
"""Extract all the contents of a tarfile object.
1544
A replacement for extractall, which is not present in python2.4
1547
tar.extract(tarinfo, to_dir)
added
removed
bzrlib/remote.py
