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 NoSuchRevision
38
from bzrlib.lockable_files import LockableFiles
39
from bzrlib.pack import ContainerPushParser
40
from bzrlib.smart import client, vfs
41
from bzrlib.symbol_versioning import (
46
from bzrlib.revision import ensure_null, NULL_REVISION
47
from bzrlib.trace import mutter, note, warning
49
# Note: RemoteBzrDirFormat is in bzrdir.py
51
class RemoteBzrDir(BzrDir):
52
"""Control directory on a remote server, accessed via bzr:// or similar."""
54
def __init__(self, transport, _client=None):
55
"""Construct a RemoteBzrDir.
57
:param _client: Private parameter for testing. Disables probing and the
60
BzrDir.__init__(self, transport, RemoteBzrDirFormat())
61
# this object holds a delegated bzrdir that uses file-level operations
62
# to talk to the other side
63
self._real_bzrdir = None
66
medium = transport.get_smart_medium()
67
self._client = client._SmartClient(medium, transport.base)
69
self._client = _client
72
path = self._path_for_remote_call(self._client)
73
response = self._client.call('BzrDir.open', path)
74
if response not in [('yes',), ('no',)]:
75
raise errors.UnexpectedSmartServerResponse(response)
76
if response == ('no',):
77
raise errors.NotBranchError(path=transport.base)
79
def _ensure_real(self):
80
"""Ensure that there is a _real_bzrdir set.
82
Used before calls to self._real_bzrdir.
84
if not self._real_bzrdir:
85
self._real_bzrdir = BzrDir.open_from_transport(
86
self.root_transport, _server_formats=False)
88
def create_repository(self, shared=False):
90
self._real_bzrdir.create_repository(shared=shared)
91
return self.open_repository()
93
def destroy_repository(self):
94
"""See BzrDir.destroy_repository"""
96
self._real_bzrdir.destroy_repository()
98
def create_branch(self):
100
real_branch = self._real_bzrdir.create_branch()
101
return RemoteBranch(self, self.find_repository(), real_branch)
103
def destroy_branch(self):
104
"""See BzrDir.destroy_branch"""
106
self._real_bzrdir.destroy_branch()
108
def create_workingtree(self, revision_id=None, from_branch=None):
109
raise errors.NotLocalUrl(self.transport.base)
111
def find_branch_format(self):
112
"""Find the branch 'format' for this bzrdir.
114
This might be a synthetic object for e.g. RemoteBranch and SVN.
116
b = self.open_branch()
119
def get_branch_reference(self):
120
"""See BzrDir.get_branch_reference()."""
121
path = self._path_for_remote_call(self._client)
122
response = self._client.call('BzrDir.open_branch', path)
123
if response[0] == 'ok':
124
if response[1] == '':
125
# branch at this location.
128
# a branch reference, use the existing BranchReference logic.
130
elif response == ('nobranch',):
131
raise errors.NotBranchError(path=self.root_transport.base)
133
raise errors.UnexpectedSmartServerResponse(response)
135
def _get_tree_branch(self):
136
"""See BzrDir._get_tree_branch()."""
137
return None, self.open_branch()
139
def open_branch(self, _unsupported=False):
140
assert _unsupported == False, 'unsupported flag support not implemented yet.'
141
reference_url = self.get_branch_reference()
142
if reference_url is None:
143
# branch at this location.
144
return RemoteBranch(self, self.find_repository())
146
# a branch reference, use the existing BranchReference logic.
147
format = BranchReferenceFormat()
148
return format.open(self, _found=True, location=reference_url)
150
def open_repository(self):
151
path = self._path_for_remote_call(self._client)
152
verb = 'BzrDir.find_repositoryV2'
154
response = self._client.call(verb, path)
155
except errors.UnknownSmartMethod:
156
verb = 'BzrDir.find_repository'
157
response = self._client.call(verb, path)
158
assert response[0] in ('ok', 'norepository'), \
159
'unexpected response code %s' % (response,)
160
if response[0] == 'norepository':
161
raise errors.NoRepositoryPresent(self)
162
if verb == 'BzrDir.find_repository':
163
# servers that don't support the V2 method don't support external
165
response = response + ('no', )
166
assert len(response) == 5, 'incorrect response length %s' % (response,)
167
if response[1] == '':
168
format = RemoteRepositoryFormat()
169
format.rich_root_data = (response[2] == 'yes')
170
format.supports_tree_reference = (response[3] == 'yes')
171
# No wire format to check this yet.
172
format.supports_external_lookups = (response[4] == 'yes')
173
return RemoteRepository(self, format)
175
raise errors.NoRepositoryPresent(self)
177
def open_workingtree(self, recommend_upgrade=True):
179
if self._real_bzrdir.has_workingtree():
180
raise errors.NotLocalUrl(self.root_transport)
182
raise errors.NoWorkingTree(self.root_transport.base)
184
def _path_for_remote_call(self, client):
185
"""Return the path to be used for this bzrdir in a remote call."""
186
return client.remote_path_from_transport(self.root_transport)
188
def get_branch_transport(self, branch_format):
190
return self._real_bzrdir.get_branch_transport(branch_format)
192
def get_repository_transport(self, repository_format):
194
return self._real_bzrdir.get_repository_transport(repository_format)
196
def get_workingtree_transport(self, workingtree_format):
198
return self._real_bzrdir.get_workingtree_transport(workingtree_format)
200
def can_convert_format(self):
201
"""Upgrading of remote bzrdirs is not supported yet."""
204
def needs_format_conversion(self, format=None):
205
"""Upgrading of remote bzrdirs is not supported yet."""
208
def clone(self, url, revision_id=None, force_new_repo=False):
210
return self._real_bzrdir.clone(url, revision_id=revision_id,
211
force_new_repo=force_new_repo)
214
class RemoteRepositoryFormat(repository.RepositoryFormat):
215
"""Format for repositories accessed over a _SmartClient.
217
Instances of this repository are represented by RemoteRepository
220
The RemoteRepositoryFormat is parameterized during construction
221
to reflect the capabilities of the real, remote format. Specifically
222
the attributes rich_root_data and supports_tree_reference are set
223
on a per instance basis, and are not set (and should not be) at
227
_matchingbzrdir = RemoteBzrDirFormat
229
def initialize(self, a_bzrdir, shared=False):
230
assert isinstance(a_bzrdir, RemoteBzrDir), \
231
'%r is not a RemoteBzrDir' % (a_bzrdir,)
232
return a_bzrdir.create_repository(shared=shared)
234
def open(self, a_bzrdir):
235
assert isinstance(a_bzrdir, RemoteBzrDir)
236
return a_bzrdir.open_repository()
238
def get_format_description(self):
239
return 'bzr remote repository'
241
def __eq__(self, other):
242
return self.__class__ == other.__class__
244
def check_conversion_target(self, target_format):
245
if self.rich_root_data and not target_format.rich_root_data:
246
raise errors.BadConversionTarget(
247
'Does not support rich root data.', target_format)
248
if (self.supports_tree_reference and
249
not getattr(target_format, 'supports_tree_reference', False)):
250
raise errors.BadConversionTarget(
251
'Does not support nested trees', target_format)
254
class RemoteRepository(object):
255
"""Repository accessed over rpc.
257
For the moment most operations are performed using local transport-backed
261
def __init__(self, remote_bzrdir, format, real_repository=None, _client=None):
262
"""Create a RemoteRepository instance.
264
:param remote_bzrdir: The bzrdir hosting this repository.
265
:param format: The RemoteFormat object to use.
266
:param real_repository: If not None, a local implementation of the
267
repository logic for the repository, usually accessing the data
269
:param _client: Private testing parameter - override the smart client
270
to be used by the repository.
273
self._real_repository = real_repository
275
self._real_repository = None
276
self.bzrdir = remote_bzrdir
278
self._client = remote_bzrdir._client
280
self._client = _client
281
self._format = format
282
self._lock_mode = None
283
self._lock_token = None
285
self._leave_lock = False
286
# A cache of looked up revision parent data; reset at unlock time.
287
self._parents_map = None
288
if 'hpss' in debug.debug_flags:
289
self._requested_parents = None
291
# These depend on the actual remote format, so force them off for
292
# maximum compatibility. XXX: In future these should depend on the
293
# remote repository instance, but this is irrelevant until we perform
294
# reconcile via an RPC call.
295
self._reconcile_does_inventory_gc = False
296
self._reconcile_fixes_text_parents = False
297
self._reconcile_backsup_inventory = False
298
self.base = self.bzrdir.transport.base
301
return "%s(%s)" % (self.__class__.__name__, self.base)
305
def abort_write_group(self):
306
"""Complete a write group on the decorated repository.
308
Smart methods peform operations in a single step so this api
309
is not really applicable except as a compatibility thunk
310
for older plugins that don't use e.g. the CommitBuilder
314
return self._real_repository.abort_write_group()
316
def commit_write_group(self):
317
"""Complete a write group on the decorated repository.
319
Smart methods peform operations in a single step so this api
320
is not really applicable except as a compatibility thunk
321
for older plugins that don't use e.g. the CommitBuilder
325
return self._real_repository.commit_write_group()
327
def _ensure_real(self):
328
"""Ensure that there is a _real_repository set.
330
Used before calls to self._real_repository.
332
if not self._real_repository:
333
self.bzrdir._ensure_real()
334
#self._real_repository = self.bzrdir._real_bzrdir.open_repository()
335
self._set_real_repository(self.bzrdir._real_bzrdir.open_repository())
337
def find_text_key_references(self):
338
"""Find the text key references within the repository.
340
:return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
341
revision_ids. Each altered file-ids has the exact revision_ids that
342
altered it listed explicitly.
343
:return: A dictionary mapping text keys ((fileid, revision_id) tuples)
344
to whether they were referred to by the inventory of the
345
revision_id that they contain. The inventory texts from all present
346
revision ids are assessed to generate this report.
349
return self._real_repository.find_text_key_references()
351
def _generate_text_key_index(self):
352
"""Generate a new text key index for the repository.
354
This is an expensive function that will take considerable time to run.
356
:return: A dict mapping (file_id, revision_id) tuples to a list of
357
parents, also (file_id, revision_id) tuples.
360
return self._real_repository._generate_text_key_index()
362
@symbol_versioning.deprecated_method(symbol_versioning.one_four)
363
def get_revision_graph(self, revision_id=None):
364
"""See Repository.get_revision_graph()."""
365
return self._get_revision_graph(revision_id)
367
def _get_revision_graph(self, revision_id):
368
"""Private method for using with old (< 1.2) servers to fallback."""
369
if revision_id is None:
371
elif revision.is_null(revision_id):
374
path = self.bzrdir._path_for_remote_call(self._client)
375
assert type(revision_id) is str
376
response = self._client.call_expecting_body(
377
'Repository.get_revision_graph', path, revision_id)
378
if response[0][0] not in ['ok', 'nosuchrevision']:
379
raise errors.UnexpectedSmartServerResponse(response[0])
380
if response[0][0] == 'ok':
381
coded = response[1].read_body_bytes()
383
# no revisions in this repository!
385
lines = coded.split('\n')
388
d = tuple(line.split())
389
revision_graph[d[0]] = d[1:]
391
return revision_graph
393
response_body = response[1].read_body_bytes()
394
assert response_body == ''
395
raise NoSuchRevision(self, revision_id)
397
def has_revision(self, revision_id):
398
"""See Repository.has_revision()."""
399
if revision_id == NULL_REVISION:
400
# The null revision is always present.
402
path = self.bzrdir._path_for_remote_call(self._client)
403
response = self._client.call('Repository.has_revision', path, revision_id)
404
assert response[0] in ('yes', 'no'), 'unexpected response code %s' % (response,)
405
return response[0] == 'yes'
407
def has_revisions(self, revision_ids):
408
"""See Repository.has_revisions()."""
410
for revision_id in revision_ids:
411
if self.has_revision(revision_id):
412
result.add(revision_id)
415
def has_same_location(self, other):
416
return (self.__class__ == other.__class__ and
417
self.bzrdir.transport.base == other.bzrdir.transport.base)
419
def get_graph(self, other_repository=None):
420
"""Return the graph for this repository format"""
421
parents_provider = self
422
if (other_repository is not None and
423
other_repository.bzrdir.transport.base !=
424
self.bzrdir.transport.base):
425
parents_provider = graph._StackedParentsProvider(
426
[parents_provider, other_repository._make_parents_provider()])
427
return graph.Graph(parents_provider)
429
def gather_stats(self, revid=None, committers=None):
430
"""See Repository.gather_stats()."""
431
path = self.bzrdir._path_for_remote_call(self._client)
432
# revid can be None to indicate no revisions, not just NULL_REVISION
433
if revid is None or revision.is_null(revid):
437
if committers is None or not committers:
438
fmt_committers = 'no'
440
fmt_committers = 'yes'
441
response = self._client.call_expecting_body(
442
'Repository.gather_stats', path, fmt_revid, fmt_committers)
443
assert response[0][0] == 'ok', \
444
'unexpected response code %s' % (response[0],)
446
body = response[1].read_body_bytes()
448
for line in body.split('\n'):
451
key, val_text = line.split(':')
452
if key in ('revisions', 'size', 'committers'):
453
result[key] = int(val_text)
454
elif key in ('firstrev', 'latestrev'):
455
values = val_text.split(' ')[1:]
456
result[key] = (float(values[0]), long(values[1]))
460
def find_branches(self, using=False):
461
"""See Repository.find_branches()."""
462
# should be an API call to the server.
464
return self._real_repository.find_branches(using=using)
466
def get_physical_lock_status(self):
467
"""See Repository.get_physical_lock_status()."""
468
# should be an API call to the server.
470
return self._real_repository.get_physical_lock_status()
472
def is_in_write_group(self):
473
"""Return True if there is an open write group.
475
write groups are only applicable locally for the smart server..
477
if self._real_repository:
478
return self._real_repository.is_in_write_group()
481
return self._lock_count >= 1
484
"""See Repository.is_shared()."""
485
path = self.bzrdir._path_for_remote_call(self._client)
486
response = self._client.call('Repository.is_shared', path)
487
assert response[0] in ('yes', 'no'), 'unexpected response code %s' % (response,)
488
return response[0] == 'yes'
490
def is_write_locked(self):
491
return self._lock_mode == 'w'
494
# wrong eventually - want a local lock cache context
495
if not self._lock_mode:
496
self._lock_mode = 'r'
498
self._parents_map = {}
499
if 'hpss' in debug.debug_flags:
500
self._requested_parents = set()
501
if self._real_repository is not None:
502
self._real_repository.lock_read()
504
self._lock_count += 1
506
def _remote_lock_write(self, token):
507
path = self.bzrdir._path_for_remote_call(self._client)
510
response = self._client.call('Repository.lock_write', path, token)
511
if response[0] == 'ok':
514
elif response[0] == 'LockContention':
515
raise errors.LockContention('(remote lock)')
516
elif response[0] == 'UnlockableTransport':
517
raise errors.UnlockableTransport(self.bzrdir.root_transport)
518
elif response[0] == 'LockFailed':
519
raise errors.LockFailed(response[1], response[2])
521
raise errors.UnexpectedSmartServerResponse(response)
523
def lock_write(self, token=None):
524
if not self._lock_mode:
525
self._lock_token = self._remote_lock_write(token)
526
# if self._lock_token is None, then this is something like packs or
527
# svn where we don't get to lock the repo, or a weave style repository
528
# where we cannot lock it over the wire and attempts to do so will
530
if self._real_repository is not None:
531
self._real_repository.lock_write(token=self._lock_token)
532
if token is not None:
533
self._leave_lock = True
535
self._leave_lock = False
536
self._lock_mode = 'w'
538
self._parents_map = {}
539
if 'hpss' in debug.debug_flags:
540
self._requested_parents = set()
541
elif self._lock_mode == 'r':
542
raise errors.ReadOnlyError(self)
544
self._lock_count += 1
545
return self._lock_token or None
547
def leave_lock_in_place(self):
548
if not self._lock_token:
549
raise NotImplementedError(self.leave_lock_in_place)
550
self._leave_lock = True
552
def dont_leave_lock_in_place(self):
553
if not self._lock_token:
554
raise NotImplementedError(self.dont_leave_lock_in_place)
555
self._leave_lock = False
557
def _set_real_repository(self, repository):
558
"""Set the _real_repository for this repository.
560
:param repository: The repository to fallback to for non-hpss
561
implemented operations.
563
assert not isinstance(repository, RemoteRepository)
564
self._real_repository = repository
565
if self._lock_mode == 'w':
566
# if we are already locked, the real repository must be able to
567
# acquire the lock with our token.
568
self._real_repository.lock_write(self._lock_token)
569
elif self._lock_mode == 'r':
570
self._real_repository.lock_read()
572
def start_write_group(self):
573
"""Start a write group on the decorated repository.
575
Smart methods peform operations in a single step so this api
576
is not really applicable except as a compatibility thunk
577
for older plugins that don't use e.g. the CommitBuilder
581
return self._real_repository.start_write_group()
583
def _unlock(self, token):
584
path = self.bzrdir._path_for_remote_call(self._client)
586
# with no token the remote repository is not persistently locked.
588
response = self._client.call('Repository.unlock', path, token)
589
if response == ('ok',):
591
elif response[0] == 'TokenMismatch':
592
raise errors.TokenMismatch(token, '(remote token)')
594
raise errors.UnexpectedSmartServerResponse(response)
597
self._lock_count -= 1
598
if self._lock_count > 0:
600
self._parents_map = None
601
if 'hpss' in debug.debug_flags:
602
self._requested_parents = None
603
old_mode = self._lock_mode
604
self._lock_mode = None
606
# The real repository is responsible at present for raising an
607
# exception if it's in an unfinished write group. However, it
608
# normally will *not* actually remove the lock from disk - that's
609
# done by the server on receiving the Repository.unlock call.
610
# This is just to let the _real_repository stay up to date.
611
if self._real_repository is not None:
612
self._real_repository.unlock()
614
# The rpc-level lock should be released even if there was a
615
# problem releasing the vfs-based lock.
617
# Only write-locked repositories need to make a remote method
618
# call to perfom the unlock.
619
old_token = self._lock_token
620
self._lock_token = None
621
if not self._leave_lock:
622
self._unlock(old_token)
624
def break_lock(self):
625
# should hand off to the network
627
return self._real_repository.break_lock()
629
def _get_tarball(self, compression):
630
"""Return a TemporaryFile containing a repository tarball.
632
Returns None if the server does not support sending tarballs.
635
path = self.bzrdir._path_for_remote_call(self._client)
637
response, protocol = self._client.call_expecting_body(
638
'Repository.tarball', path, compression)
639
except errors.UnknownSmartMethod:
640
protocol.cancel_read_body()
642
if response[0] == 'ok':
643
# Extract the tarball and return it
644
t = tempfile.NamedTemporaryFile()
645
# TODO: rpc layer should read directly into it...
646
t.write(protocol.read_body_bytes())
649
raise errors.UnexpectedSmartServerResponse(response)
651
def sprout(self, to_bzrdir, revision_id=None):
652
# TODO: Option to control what format is created?
654
dest_repo = self._real_repository._format.initialize(to_bzrdir,
656
dest_repo.fetch(self, revision_id=revision_id)
659
### These methods are just thin shims to the VFS object for now.
661
def revision_tree(self, revision_id):
663
return self._real_repository.revision_tree(revision_id)
665
def get_serializer_format(self):
667
return self._real_repository.get_serializer_format()
669
def get_commit_builder(self, branch, parents, config, timestamp=None,
670
timezone=None, committer=None, revprops=None,
672
# FIXME: It ought to be possible to call this without immediately
673
# triggering _ensure_real. For now it's the easiest thing to do.
675
builder = self._real_repository.get_commit_builder(branch, parents,
676
config, timestamp=timestamp, timezone=timezone,
677
committer=committer, revprops=revprops, revision_id=revision_id)
680
def add_inventory(self, revid, inv, parents):
682
return self._real_repository.add_inventory(revid, inv, parents)
684
def add_revision(self, rev_id, rev, inv=None, config=None):
686
return self._real_repository.add_revision(
687
rev_id, rev, inv=inv, config=config)
690
def get_inventory(self, revision_id):
692
return self._real_repository.get_inventory(revision_id)
694
def iter_inventories(self, revision_ids):
696
return self._real_repository.iter_inventories(revision_ids)
699
def get_revision(self, revision_id):
701
return self._real_repository.get_revision(revision_id)
704
def weave_store(self):
706
return self._real_repository.weave_store
708
def get_transaction(self):
710
return self._real_repository.get_transaction()
713
def clone(self, a_bzrdir, revision_id=None):
715
return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
717
def make_working_trees(self):
718
"""See Repository.make_working_trees"""
720
return self._real_repository.make_working_trees()
722
def revision_ids_to_search_result(self, result_set):
723
"""Convert a set of revision ids to a graph SearchResult."""
724
result_parents = set()
725
for parents in self.get_graph().get_parent_map(
726
result_set).itervalues():
727
result_parents.update(parents)
728
included_keys = result_set.intersection(result_parents)
729
start_keys = result_set.difference(included_keys)
730
exclude_keys = result_parents.difference(result_set)
731
result = graph.SearchResult(start_keys, exclude_keys,
732
len(result_set), result_set)
736
def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
737
"""Return the revision ids that other has that this does not.
739
These are returned in topological order.
741
revision_id: only return revision ids included by revision_id.
743
return repository.InterRepository.get(
744
other, self).search_missing_revision_ids(revision_id, find_ghosts)
746
def fetch(self, source, revision_id=None, pb=None):
747
if self.has_same_location(source):
748
# check that last_revision is in 'from' and then return a
750
if (revision_id is not None and
751
not revision.is_null(revision_id)):
752
self.get_revision(revision_id)
755
return self._real_repository.fetch(
756
source, revision_id=revision_id, pb=pb)
758
def create_bundle(self, target, base, fileobj, format=None):
760
self._real_repository.create_bundle(target, base, fileobj, format)
763
def control_weaves(self):
765
return self._real_repository.control_weaves
768
def get_ancestry(self, revision_id, topo_sorted=True):
770
return self._real_repository.get_ancestry(revision_id, topo_sorted)
773
def get_inventory_weave(self):
775
return self._real_repository.get_inventory_weave()
777
def fileids_altered_by_revision_ids(self, revision_ids):
779
return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
781
def _get_versioned_file_checker(self, revisions, revision_versions_cache):
783
return self._real_repository._get_versioned_file_checker(
784
revisions, revision_versions_cache)
786
def iter_files_bytes(self, desired_files):
787
"""See Repository.iter_file_bytes.
790
return self._real_repository.iter_files_bytes(desired_files)
792
def get_parent_map(self, keys):
793
"""See bzrlib.Graph.get_parent_map()."""
794
# Hack to build up the caching logic.
795
ancestry = self._parents_map
797
# Repository is not locked, so there's no cache.
798
missing_revisions = set(keys)
801
missing_revisions = set(key for key in keys if key not in ancestry)
802
if missing_revisions:
803
parent_map = self._get_parent_map(missing_revisions)
804
if 'hpss' in debug.debug_flags:
805
mutter('retransmitted revisions: %d of %d',
806
len(set(ancestry).intersection(parent_map)),
808
ancestry.update(parent_map)
809
present_keys = [k for k in keys if k in ancestry]
810
if 'hpss' in debug.debug_flags:
811
self._requested_parents.update(present_keys)
812
mutter('Current RemoteRepository graph hit rate: %d%%',
813
100.0 * len(self._requested_parents) / len(ancestry))
814
return dict((k, ancestry[k]) for k in present_keys)
816
def _get_parent_map(self, keys):
817
"""Helper for get_parent_map that performs the RPC."""
818
medium = self._client._medium
819
if not medium._remote_is_at_least_1_2:
820
# We already found out that the server can't understand
821
# Repository.get_parent_map requests, so just fetch the whole
823
# XXX: Note that this will issue a deprecation warning. This is ok
824
# :- its because we're working with a deprecated server anyway, and
825
# the user will almost certainly have seen a warning about the
826
# server version already.
827
rg = self.get_revision_graph()
828
# There is an api discrepency between get_parent_map and
829
# get_revision_graph. Specifically, a "key:()" pair in
830
# get_revision_graph just means a node has no parents. For
831
# "get_parent_map" it means the node is a ghost. So fix up the
832
# graph to correct this.
833
# https://bugs.launchpad.net/bzr/+bug/214894
834
# There is one other "bug" which is that ghosts in
835
# get_revision_graph() are not returned at all. But we won't worry
836
# about that for now.
837
for node_id, parent_ids in rg.iteritems():
839
rg[node_id] = (NULL_REVISION,)
840
rg[NULL_REVISION] = ()
844
if NULL_REVISION in keys:
845
keys.discard(NULL_REVISION)
846
found_parents = {NULL_REVISION:()}
851
# TODO(Needs analysis): We could assume that the keys being requested
852
# from get_parent_map are in a breadth first search, so typically they
853
# will all be depth N from some common parent, and we don't have to
854
# have the server iterate from the root parent, but rather from the
855
# keys we're searching; and just tell the server the keyspace we
856
# already have; but this may be more traffic again.
858
# Transform self._parents_map into a search request recipe.
859
# TODO: Manage this incrementally to avoid covering the same path
860
# repeatedly. (The server will have to on each request, but the less
861
# work done the better).
862
parents_map = self._parents_map
863
if parents_map is None:
864
# Repository is not locked, so there's no cache.
866
start_set = set(parents_map)
867
result_parents = set()
868
for parents in parents_map.itervalues():
869
result_parents.update(parents)
870
stop_keys = result_parents.difference(start_set)
871
included_keys = start_set.intersection(result_parents)
872
start_set.difference_update(included_keys)
873
recipe = (start_set, stop_keys, len(parents_map))
874
body = self._serialise_search_recipe(recipe)
875
path = self.bzrdir._path_for_remote_call(self._client)
877
if type(key) is not str:
879
"key %r not a plain string" % (key,))
880
verb = 'Repository.get_parent_map'
881
args = (path,) + tuple(keys)
883
response = self._client.call_with_body_bytes_expecting_body(
884
verb, args, self._serialise_search_recipe(recipe))
885
except errors.UnknownSmartMethod:
886
# Server does not support this method, so get the whole graph.
887
# Worse, we have to force a disconnection, because the server now
888
# doesn't realise it has a body on the wire to consume, so the
889
# only way to recover is to abandon the connection.
891
'Server is too old for fast get_parent_map, reconnecting. '
892
'(Upgrade the server to Bazaar 1.2 to avoid this)')
894
# To avoid having to disconnect repeatedly, we keep track of the
895
# fact the server doesn't understand remote methods added in 1.2.
896
medium._remote_is_at_least_1_2 = False
897
return self.get_revision_graph(None)
898
if response[0][0] not in ['ok']:
899
response[1].cancel_read_body()
900
raise errors.UnexpectedSmartServerResponse(response[0])
901
if response[0][0] == 'ok':
902
coded = bz2.decompress(response[1].read_body_bytes())
906
lines = coded.split('\n')
909
d = tuple(line.split())
911
revision_graph[d[0]] = d[1:]
913
# No parents - so give the Graph result (NULL_REVISION,).
914
revision_graph[d[0]] = (NULL_REVISION,)
915
return revision_graph
918
def get_signature_text(self, revision_id):
920
return self._real_repository.get_signature_text(revision_id)
923
@symbol_versioning.deprecated_method(symbol_versioning.one_three)
924
def get_revision_graph_with_ghosts(self, revision_ids=None):
926
return self._real_repository.get_revision_graph_with_ghosts(
927
revision_ids=revision_ids)
930
def get_inventory_xml(self, revision_id):
932
return self._real_repository.get_inventory_xml(revision_id)
934
def deserialise_inventory(self, revision_id, xml):
936
return self._real_repository.deserialise_inventory(revision_id, xml)
938
def reconcile(self, other=None, thorough=False):
940
return self._real_repository.reconcile(other=other, thorough=thorough)
942
def all_revision_ids(self):
944
return self._real_repository.all_revision_ids()
947
def get_deltas_for_revisions(self, revisions):
949
return self._real_repository.get_deltas_for_revisions(revisions)
952
def get_revision_delta(self, revision_id):
954
return self._real_repository.get_revision_delta(revision_id)
957
def revision_trees(self, revision_ids):
959
return self._real_repository.revision_trees(revision_ids)
962
def get_revision_reconcile(self, revision_id):
964
return self._real_repository.get_revision_reconcile(revision_id)
967
def check(self, revision_ids=None):
969
return self._real_repository.check(revision_ids=revision_ids)
971
def copy_content_into(self, destination, revision_id=None):
973
return self._real_repository.copy_content_into(
974
destination, revision_id=revision_id)
976
def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
977
# get a tarball of the remote repository, and copy from that into the
979
from bzrlib import osutils
982
# TODO: Maybe a progress bar while streaming the tarball?
983
note("Copying repository content as tarball...")
984
tar_file = self._get_tarball('bz2')
987
destination = to_bzrdir.create_repository()
989
tar = tarfile.open('repository', fileobj=tar_file,
991
tmpdir = tempfile.mkdtemp()
993
_extract_tar(tar, tmpdir)
994
tmp_bzrdir = BzrDir.open(tmpdir)
995
tmp_repo = tmp_bzrdir.open_repository()
996
tmp_repo.copy_content_into(destination, revision_id)
998
osutils.rmtree(tmpdir)
1002
# TODO: Suggestion from john: using external tar is much faster than
1003
# python's tarfile library, but it may not work on windows.
1007
"""Compress the data within the repository.
1009
This is not currently implemented within the smart server.
1012
return self._real_repository.pack()
1014
def set_make_working_trees(self, new_value):
1016
self._real_repository.set_make_working_trees(new_value)
1019
def sign_revision(self, revision_id, gpg_strategy):
1021
return self._real_repository.sign_revision(revision_id, gpg_strategy)
1024
def get_revisions(self, revision_ids):
1026
return self._real_repository.get_revisions(revision_ids)
1028
def supports_rich_root(self):
1030
return self._real_repository.supports_rich_root()
1032
def iter_reverse_revision_history(self, revision_id):
1034
return self._real_repository.iter_reverse_revision_history(revision_id)
1037
def _serializer(self):
1039
return self._real_repository._serializer
1041
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1043
return self._real_repository.store_revision_signature(
1044
gpg_strategy, plaintext, revision_id)
1046
def add_signature_text(self, revision_id, signature):
1048
return self._real_repository.add_signature_text(revision_id, signature)
1050
def has_signature_for_revision_id(self, revision_id):
1052
return self._real_repository.has_signature_for_revision_id(revision_id)
1054
def get_data_stream_for_search(self, search):
1055
medium = self._client._medium
1056
if not medium._remote_is_at_least_1_2:
1058
return self._real_repository.get_data_stream_for_search(search)
1059
REQUEST_NAME = 'Repository.stream_revisions_chunked'
1060
path = self.bzrdir._path_for_remote_call(self._client)
1061
body = self._serialise_search_recipe(search.get_recipe())
1063
result = self._client.call_with_body_bytes_expecting_body(
1064
REQUEST_NAME, (path,), body)
1065
response, protocol = result
1066
except errors.UnknownSmartMethod:
1067
# Server does not support this method, so fall back to VFS.
1068
# Worse, we have to force a disconnection, because the server now
1069
# doesn't realise it has a body on the wire to consume, so the
1070
# only way to recover is to abandon the connection.
1072
'Server is too old for streaming pull, reconnecting. '
1073
'(Upgrade the server to Bazaar 1.2 to avoid this)')
1075
# To avoid having to disconnect repeatedly, we keep track of the
1076
# fact the server doesn't understand this remote method.
1077
medium._remote_is_at_least_1_2 = False
1079
return self._real_repository.get_data_stream_for_search(search)
1081
if response == ('ok',):
1082
return self._deserialise_stream(protocol)
1083
if response == ('NoSuchRevision', ):
1084
# We cannot easily identify the revision that is missing in this
1085
# situation without doing much more network IO. For now, bail.
1086
raise NoSuchRevision(self, "unknown")
1088
raise errors.UnexpectedSmartServerResponse(response)
1090
def _deserialise_stream(self, protocol):
1091
stream = protocol.read_streamed_body()
1092
container_parser = ContainerPushParser()
1093
for bytes in stream:
1094
container_parser.accept_bytes(bytes)
1095
records = container_parser.read_pending_records()
1096
for record_names, record_bytes in records:
1097
if len(record_names) != 1:
1098
# These records should have only one name, and that name
1099
# should be a one-element tuple.
1100
raise errors.SmartProtocolError(
1101
'Repository data stream had invalid record name %r'
1103
name_tuple = record_names[0]
1104
yield name_tuple, record_bytes
1106
def insert_data_stream(self, stream):
1108
self._real_repository.insert_data_stream(stream)
1110
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
1112
return self._real_repository.item_keys_introduced_by(revision_ids,
1113
_files_pb=_files_pb)
1115
def revision_graph_can_have_wrong_parents(self):
1116
# The answer depends on the remote repo format.
1118
return self._real_repository.revision_graph_can_have_wrong_parents()
1120
def _find_inconsistent_revision_parents(self):
1122
return self._real_repository._find_inconsistent_revision_parents()
1124
def _check_for_inconsistent_revision_parents(self):
1126
return self._real_repository._check_for_inconsistent_revision_parents()
1128
def _make_parents_provider(self):
1131
def _serialise_search_recipe(self, recipe):
1132
"""Serialise a graph search recipe.
1134
:param recipe: A search recipe (start, stop, count).
1135
:return: Serialised bytes.
1137
start_keys = ' '.join(recipe[0])
1138
stop_keys = ' '.join(recipe[1])
1139
count = str(recipe[2])
1140
return '\n'.join((start_keys, stop_keys, count))
1143
class RemoteBranchLockableFiles(LockableFiles):
1144
"""A 'LockableFiles' implementation that talks to a smart server.
1146
This is not a public interface class.
1149
def __init__(self, bzrdir, _client):
1150
self.bzrdir = bzrdir
1151
self._client = _client
1152
self._need_find_modes = True
1153
LockableFiles.__init__(
1154
self, bzrdir.get_branch_transport(None),
1155
'lock', lockdir.LockDir)
1157
def _find_modes(self):
1158
# RemoteBranches don't let the client set the mode of control files.
1159
self._dir_mode = None
1160
self._file_mode = None
1163
class RemoteBranchFormat(branch.BranchFormat):
1165
def __eq__(self, other):
1166
return (isinstance(other, RemoteBranchFormat) and
1167
self.__dict__ == other.__dict__)
1169
def get_format_description(self):
1170
return 'Remote BZR Branch'
1172
def get_format_string(self):
1173
return 'Remote BZR Branch'
1175
def open(self, a_bzrdir):
1176
assert isinstance(a_bzrdir, RemoteBzrDir)
1177
return a_bzrdir.open_branch()
1179
def initialize(self, a_bzrdir):
1180
assert isinstance(a_bzrdir, RemoteBzrDir)
1181
return a_bzrdir.create_branch()
1183
def supports_tags(self):
1184
# Remote branches might support tags, but we won't know until we
1185
# access the real remote branch.
1189
class RemoteBranch(branch.Branch):
1190
"""Branch stored on a server accessed by HPSS RPC.
1192
At the moment most operations are mapped down to simple file operations.
1195
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
1197
"""Create a RemoteBranch instance.
1199
:param real_branch: An optional local implementation of the branch
1200
format, usually accessing the data via the VFS.
1201
:param _client: Private parameter for testing.
1203
# We intentionally don't call the parent class's __init__, because it
1204
# will try to assign to self.tags, which is a property in this subclass.
1205
# And the parent's __init__ doesn't do much anyway.
1206
self._revision_id_to_revno_cache = None
1207
self._revision_history_cache = None
1208
self.bzrdir = remote_bzrdir
1209
if _client is not None:
1210
self._client = _client
1212
self._client = remote_bzrdir._client
1213
self.repository = remote_repository
1214
if real_branch is not None:
1215
self._real_branch = real_branch
1216
# Give the remote repository the matching real repo.
1217
real_repo = self._real_branch.repository
1218
if isinstance(real_repo, RemoteRepository):
1219
real_repo._ensure_real()
1220
real_repo = real_repo._real_repository
1221
self.repository._set_real_repository(real_repo)
1222
# Give the branch the remote repository to let fast-pathing happen.
1223
self._real_branch.repository = self.repository
1225
self._real_branch = None
1226
# Fill out expected attributes of branch for bzrlib api users.
1227
self._format = RemoteBranchFormat()
1228
self.base = self.bzrdir.root_transport.base
1229
self._control_files = None
1230
self._lock_mode = None
1231
self._lock_token = None
1232
self._repo_lock_token = None
1233
self._lock_count = 0
1234
self._leave_lock = False
1237
return "%s(%s)" % (self.__class__.__name__, self.base)
1241
def _ensure_real(self):
1242
"""Ensure that there is a _real_branch set.
1244
Used before calls to self._real_branch.
1246
if not self._real_branch:
1247
assert vfs.vfs_enabled()
1248
self.bzrdir._ensure_real()
1249
self._real_branch = self.bzrdir._real_bzrdir.open_branch()
1250
# Give the remote repository the matching real repo.
1251
real_repo = self._real_branch.repository
1252
if isinstance(real_repo, RemoteRepository):
1253
real_repo._ensure_real()
1254
real_repo = real_repo._real_repository
1255
self.repository._set_real_repository(real_repo)
1256
# Give the branch the remote repository to let fast-pathing happen.
1257
self._real_branch.repository = self.repository
1258
# XXX: deal with _lock_mode == 'w'
1259
if self._lock_mode == 'r':
1260
self._real_branch.lock_read()
1263
def control_files(self):
1264
# Defer actually creating RemoteBranchLockableFiles until its needed,
1265
# because it triggers an _ensure_real that we otherwise might not need.
1266
if self._control_files is None:
1267
self._control_files = RemoteBranchLockableFiles(
1268
self.bzrdir, self._client)
1269
return self._control_files
1271
def _get_checkout_format(self):
1273
return self._real_branch._get_checkout_format()
1275
def get_physical_lock_status(self):
1276
"""See Branch.get_physical_lock_status()."""
1277
# should be an API call to the server, as branches must be lockable.
1279
return self._real_branch.get_physical_lock_status()
1281
def lock_read(self):
1282
if not self._lock_mode:
1283
self._lock_mode = 'r'
1284
self._lock_count = 1
1285
if self._real_branch is not None:
1286
self._real_branch.lock_read()
1288
self._lock_count += 1
1290
def _remote_lock_write(self, token):
1292
branch_token = repo_token = ''
1294
branch_token = token
1295
repo_token = self.repository.lock_write()
1296
self.repository.unlock()
1297
path = self.bzrdir._path_for_remote_call(self._client)
1298
response = self._client.call('Branch.lock_write', path, branch_token,
1300
if response[0] == 'ok':
1301
ok, branch_token, repo_token = response
1302
return branch_token, repo_token
1303
elif response[0] == 'LockContention':
1304
raise errors.LockContention('(remote lock)')
1305
elif response[0] == 'TokenMismatch':
1306
raise errors.TokenMismatch(token, '(remote token)')
1307
elif response[0] == 'UnlockableTransport':
1308
raise errors.UnlockableTransport(self.bzrdir.root_transport)
1309
elif response[0] == 'ReadOnlyError':
1310
raise errors.ReadOnlyError(self)
1311
elif response[0] == 'LockFailed':
1312
raise errors.LockFailed(response[1], response[2])
1314
raise errors.UnexpectedSmartServerResponse(response)
1316
def lock_write(self, token=None):
1317
if not self._lock_mode:
1318
remote_tokens = self._remote_lock_write(token)
1319
self._lock_token, self._repo_lock_token = remote_tokens
1320
assert self._lock_token, 'Remote server did not return a token!'
1321
# TODO: We really, really, really don't want to call _ensure_real
1322
# here, but it's the easiest way to ensure coherency between the
1323
# state of the RemoteBranch and RemoteRepository objects and the
1324
# physical locks. If we don't materialise the real objects here,
1325
# then getting everything in the right state later is complex, so
1326
# for now we just do it the lazy way.
1327
# -- Andrew Bennetts, 2007-02-22.
1329
if self._real_branch is not None:
1330
self._real_branch.repository.lock_write(
1331
token=self._repo_lock_token)
1333
self._real_branch.lock_write(token=self._lock_token)
1335
self._real_branch.repository.unlock()
1336
if token is not None:
1337
self._leave_lock = True
1339
# XXX: this case seems to be unreachable; token cannot be None.
1340
self._leave_lock = False
1341
self._lock_mode = 'w'
1342
self._lock_count = 1
1343
elif self._lock_mode == 'r':
1344
raise errors.ReadOnlyTransaction
1346
if token is not None:
1347
# A token was given to lock_write, and we're relocking, so check
1348
# that the given token actually matches the one we already have.
1349
if token != self._lock_token:
1350
raise errors.TokenMismatch(token, self._lock_token)
1351
self._lock_count += 1
1352
return self._lock_token or None
1354
def _unlock(self, branch_token, repo_token):
1355
path = self.bzrdir._path_for_remote_call(self._client)
1356
response = self._client.call('Branch.unlock', path, branch_token,
1358
if response == ('ok',):
1360
elif response[0] == 'TokenMismatch':
1361
raise errors.TokenMismatch(
1362
str((branch_token, repo_token)), '(remote tokens)')
1364
raise errors.UnexpectedSmartServerResponse(response)
1367
self._lock_count -= 1
1368
if not self._lock_count:
1369
self._clear_cached_state()
1370
mode = self._lock_mode
1371
self._lock_mode = None
1372
if self._real_branch is not None:
1373
if (not self._leave_lock and mode == 'w' and
1374
self._repo_lock_token):
1375
# If this RemoteBranch will remove the physical lock for the
1376
# repository, make sure the _real_branch doesn't do it
1377
# first. (Because the _real_branch's repository is set to
1378
# be the RemoteRepository.)
1379
self._real_branch.repository.leave_lock_in_place()
1380
self._real_branch.unlock()
1382
# Only write-locked branched need to make a remote method call
1383
# to perfom the unlock.
1385
assert self._lock_token, 'Locked, but no token!'
1386
branch_token = self._lock_token
1387
repo_token = self._repo_lock_token
1388
self._lock_token = None
1389
self._repo_lock_token = None
1390
if not self._leave_lock:
1391
self._unlock(branch_token, repo_token)
1393
def break_lock(self):
1395
return self._real_branch.break_lock()
1397
def leave_lock_in_place(self):
1398
if not self._lock_token:
1399
raise NotImplementedError(self.leave_lock_in_place)
1400
self._leave_lock = True
1402
def dont_leave_lock_in_place(self):
1403
if not self._lock_token:
1404
raise NotImplementedError(self.dont_leave_lock_in_place)
1405
self._leave_lock = False
1407
def last_revision_info(self):
1408
"""See Branch.last_revision_info()."""
1409
path = self.bzrdir._path_for_remote_call(self._client)
1410
response = self._client.call('Branch.last_revision_info', path)
1411
assert response[0] == 'ok', 'unexpected response code %s' % (response,)
1412
revno = int(response[1])
1413
last_revision = response[2]
1414
return (revno, last_revision)
1416
def _gen_revision_history(self):
1417
"""See Branch._gen_revision_history()."""
1418
path = self.bzrdir._path_for_remote_call(self._client)
1419
response = self._client.call_expecting_body(
1420
'Branch.revision_history', path)
1421
assert response[0][0] == 'ok', ('unexpected response code %s'
1423
result = response[1].read_body_bytes().split('\x00')
1429
def set_revision_history(self, rev_history):
1430
# Send just the tip revision of the history; the server will generate
1431
# the full history from that. If the revision doesn't exist in this
1432
# branch, NoSuchRevision will be raised.
1433
path = self.bzrdir._path_for_remote_call(self._client)
1434
if rev_history == []:
1437
rev_id = rev_history[-1]
1438
self._clear_cached_state()
1439
response = self._client.call('Branch.set_last_revision',
1440
path, self._lock_token, self._repo_lock_token, rev_id)
1441
if response[0] == 'NoSuchRevision':
1442
raise NoSuchRevision(self, rev_id)
1444
assert response == ('ok',), (
1445
'unexpected response code %r' % (response,))
1446
self._cache_revision_history(rev_history)
1448
def get_parent(self):
1450
return self._real_branch.get_parent()
1452
def set_parent(self, url):
1454
return self._real_branch.set_parent(url)
1456
def get_config(self):
1457
return RemoteBranchConfig(self)
1459
def sprout(self, to_bzrdir, revision_id=None):
1460
# Like Branch.sprout, except that it sprouts a branch in the default
1461
# format, because RemoteBranches can't be created at arbitrary URLs.
1462
# XXX: if to_bzrdir is a RemoteBranch, this should perhaps do
1463
# to_bzrdir.create_branch...
1465
result = self._real_branch._format.initialize(to_bzrdir)
1466
self.copy_content_into(result, revision_id=revision_id)
1467
result.set_parent(self.bzrdir.root_transport.base)
1471
def pull(self, source, overwrite=False, stop_revision=None,
1473
# FIXME: This asks the real branch to run the hooks, which means
1474
# they're called with the wrong target branch parameter.
1475
# The test suite specifically allows this at present but it should be
1476
# fixed. It should get a _override_hook_target branch,
1477
# as push does. -- mbp 20070405
1479
self._real_branch.pull(
1480
source, overwrite=overwrite, stop_revision=stop_revision,
1484
def push(self, target, overwrite=False, stop_revision=None):
1486
return self._real_branch.push(
1487
target, overwrite=overwrite, stop_revision=stop_revision,
1488
_override_hook_source_branch=self)
1490
def is_locked(self):
1491
return self._lock_count >= 1
1494
def set_last_revision_info(self, revno, revision_id):
1495
assert type(revno) is int
1496
revision_id = ensure_null(revision_id)
1497
path = self.bzrdir._path_for_remote_call(self._client)
1499
response = self._client.call('Branch.set_last_revision_info',
1500
path, self._lock_token, self._repo_lock_token, str(revno), revision_id)
1501
except errors.UnknownSmartMethod:
1503
self._clear_cached_state()
1504
return self._real_branch.set_last_revision_info(revno, revision_id)
1505
if response == ('ok',):
1506
self._clear_cached_state()
1507
elif response[0] == 'NoSuchRevision':
1508
raise NoSuchRevision(self, response[1])
1510
raise errors.UnexpectedSmartServerResponse(response)
1512
def generate_revision_history(self, revision_id, last_rev=None,
1515
return self._real_branch.generate_revision_history(
1516
revision_id, last_rev=last_rev, other_branch=other_branch)
1521
return self._real_branch.tags
1523
def set_push_location(self, location):
1525
return self._real_branch.set_push_location(location)
1527
def update_revisions(self, other, stop_revision=None, overwrite=False):
1529
return self._real_branch.update_revisions(
1530
other, stop_revision=stop_revision, overwrite=overwrite)
1533
class RemoteBranchConfig(BranchConfig):
1536
self.branch._ensure_real()
1537
return self.branch._real_branch.get_config().username()
1539
def _get_branch_data_config(self):
1540
self.branch._ensure_real()
1541
if self._branch_data_config is None:
1542
self._branch_data_config = TreeConfig(self.branch._real_branch)
1543
return self._branch_data_config
1546
def _extract_tar(tar, to_dir):
1547
"""Extract all the contents of a tarfile object.
1549
A replacement for extractall, which is not present in python2.4
1552
tar.extract(tarinfo, to_dir)
added
removed
bzrlib/remote.py
