1
# Copyright (C) 2006, 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
# TODO: At some point, handle upgrades by just passing the whole request
18
# across to run on the server.
21
from cStringIO import StringIO
33
from bzrlib.branch import BranchReferenceFormat
34
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
35
from bzrlib.config import BranchConfig, TreeConfig
36
from bzrlib.decorators import needs_read_lock, needs_write_lock
37
from bzrlib.errors import NoSuchRevision
38
from bzrlib.lockable_files import LockableFiles
39
from bzrlib.pack import ContainerPushParser
40
from bzrlib.smart import client, vfs
41
from bzrlib.symbol_versioning import (
45
from bzrlib.revision import NULL_REVISION
46
from bzrlib.trace import mutter, note, warning
48
# Note: RemoteBzrDirFormat is in bzrdir.py
50
class RemoteBzrDir(BzrDir):
51
"""Control directory on a remote server, accessed via bzr:// or similar."""
53
def __init__(self, transport, _client=None):
54
"""Construct a RemoteBzrDir.
56
:param _client: Private parameter for testing. Disables probing and the
59
BzrDir.__init__(self, transport, RemoteBzrDirFormat())
60
# this object holds a delegated bzrdir that uses file-level operations
61
# to talk to the other side
62
self._real_bzrdir = None
65
medium = transport.get_smart_medium()
66
self._client = client._SmartClient(medium, transport.base)
68
self._client = _client
71
path = self._path_for_remote_call(self._client)
72
response = self._client.call('BzrDir.open', path)
73
if response not in [('yes',), ('no',)]:
74
raise errors.UnexpectedSmartServerResponse(response)
75
if response == ('no',):
76
raise errors.NotBranchError(path=transport.base)
78
def _ensure_real(self):
79
"""Ensure that there is a _real_bzrdir set.
81
Used before calls to self._real_bzrdir.
83
if not self._real_bzrdir:
84
self._real_bzrdir = BzrDir.open_from_transport(
85
self.root_transport, _server_formats=False)
87
def create_repository(self, shared=False):
89
self._real_bzrdir.create_repository(shared=shared)
90
return self.open_repository()
92
def destroy_repository(self):
93
"""See BzrDir.destroy_repository"""
95
self._real_bzrdir.destroy_repository()
97
def create_branch(self):
99
real_branch = self._real_bzrdir.create_branch()
100
return RemoteBranch(self, self.find_repository(), real_branch)
102
def destroy_branch(self):
103
"""See BzrDir.destroy_branch"""
105
self._real_bzrdir.destroy_branch()
107
def create_workingtree(self, revision_id=None, from_branch=None):
108
raise errors.NotLocalUrl(self.transport.base)
110
def find_branch_format(self):
111
"""Find the branch 'format' for this bzrdir.
113
This might be a synthetic object for e.g. RemoteBranch and SVN.
115
b = self.open_branch()
118
def get_branch_reference(self):
119
"""See BzrDir.get_branch_reference()."""
120
path = self._path_for_remote_call(self._client)
121
response = self._client.call('BzrDir.open_branch', path)
122
if response[0] == 'ok':
123
if response[1] == '':
124
# branch at this location.
127
# a branch reference, use the existing BranchReference logic.
129
elif response == ('nobranch',):
130
raise errors.NotBranchError(path=self.root_transport.base)
132
raise errors.UnexpectedSmartServerResponse(response)
134
def _get_tree_branch(self):
135
"""See BzrDir._get_tree_branch()."""
136
return None, self.open_branch()
138
def open_branch(self, _unsupported=False):
139
assert _unsupported == False, 'unsupported flag support not implemented yet.'
140
reference_url = self.get_branch_reference()
141
if reference_url is None:
142
# branch at this location.
143
return RemoteBranch(self, self.find_repository())
145
# a branch reference, use the existing BranchReference logic.
146
format = BranchReferenceFormat()
147
return format.open(self, _found=True, location=reference_url)
149
def open_repository(self):
150
path = self._path_for_remote_call(self._client)
151
verb = 'BzrDir.find_repositoryV2'
152
response = self._client.call(verb, path)
153
if (response == ('error', "Generic bzr smart protocol error: "
154
"bad request '%s'" % verb) or
155
response == ('error', "Generic bzr smart protocol error: "
156
"bad request u'%s'" % verb)):
157
verb = 'BzrDir.find_repository'
158
response = self._client.call(verb, path)
159
assert response[0] in ('ok', 'norepository'), \
160
'unexpected response code %s' % (response,)
161
if response[0] == 'norepository':
162
raise errors.NoRepositoryPresent(self)
163
if verb == 'BzrDir.find_repository':
164
# servers that don't support the V2 method don't support external
166
response = response + ('no', )
167
assert len(response) == 5, 'incorrect response length %s' % (response,)
168
if response[1] == '':
169
format = RemoteRepositoryFormat()
170
format.rich_root_data = (response[2] == 'yes')
171
format.supports_tree_reference = (response[3] == 'yes')
172
# No wire format to check this yet.
173
format.supports_external_lookups = (response[4] == 'yes')
174
return RemoteRepository(self, format)
176
raise errors.NoRepositoryPresent(self)
178
def open_workingtree(self, recommend_upgrade=True):
180
if self._real_bzrdir.has_workingtree():
181
raise errors.NotLocalUrl(self.root_transport)
183
raise errors.NoWorkingTree(self.root_transport.base)
185
def _path_for_remote_call(self, client):
186
"""Return the path to be used for this bzrdir in a remote call."""
187
return client.remote_path_from_transport(self.root_transport)
189
def get_branch_transport(self, branch_format):
191
return self._real_bzrdir.get_branch_transport(branch_format)
193
def get_repository_transport(self, repository_format):
195
return self._real_bzrdir.get_repository_transport(repository_format)
197
def get_workingtree_transport(self, workingtree_format):
199
return self._real_bzrdir.get_workingtree_transport(workingtree_format)
201
def can_convert_format(self):
202
"""Upgrading of remote bzrdirs is not supported yet."""
205
def needs_format_conversion(self, format=None):
206
"""Upgrading of remote bzrdirs is not supported yet."""
209
def clone(self, url, revision_id=None, force_new_repo=False):
211
return self._real_bzrdir.clone(url, revision_id=revision_id,
212
force_new_repo=force_new_repo)
215
class RemoteRepositoryFormat(repository.RepositoryFormat):
216
"""Format for repositories accessed over a _SmartClient.
218
Instances of this repository are represented by RemoteRepository
221
The RemoteRepositoryFormat is parameterized during construction
222
to reflect the capabilities of the real, remote format. Specifically
223
the attributes rich_root_data and supports_tree_reference are set
224
on a per instance basis, and are not set (and should not be) at
228
_matchingbzrdir = RemoteBzrDirFormat
230
def initialize(self, a_bzrdir, shared=False):
231
assert isinstance(a_bzrdir, RemoteBzrDir), \
232
'%r is not a RemoteBzrDir' % (a_bzrdir,)
233
return a_bzrdir.create_repository(shared=shared)
235
def open(self, a_bzrdir):
236
assert isinstance(a_bzrdir, RemoteBzrDir)
237
return a_bzrdir.open_repository()
239
def get_format_description(self):
240
return 'bzr remote repository'
242
def __eq__(self, other):
243
return self.__class__ == other.__class__
245
def check_conversion_target(self, target_format):
246
if self.rich_root_data and not target_format.rich_root_data:
247
raise errors.BadConversionTarget(
248
'Does not support rich root data.', target_format)
249
if (self.supports_tree_reference and
250
not getattr(target_format, 'supports_tree_reference', False)):
251
raise errors.BadConversionTarget(
252
'Does not support nested trees', target_format)
255
class RemoteRepository(object):
256
"""Repository accessed over rpc.
258
For the moment most operations are performed using local transport-backed
262
def __init__(self, remote_bzrdir, format, real_repository=None, _client=None):
263
"""Create a RemoteRepository instance.
265
:param remote_bzrdir: The bzrdir hosting this repository.
266
:param format: The RemoteFormat object to use.
267
:param real_repository: If not None, a local implementation of the
268
repository logic for the repository, usually accessing the data
270
:param _client: Private testing parameter - override the smart client
271
to be used by the repository.
274
self._real_repository = real_repository
276
self._real_repository = None
277
self.bzrdir = remote_bzrdir
279
self._client = remote_bzrdir._client
281
self._client = _client
282
self._format = format
283
self._lock_mode = None
284
self._lock_token = None
286
self._leave_lock = False
287
# A cache of looked up revision parent data; reset at unlock time.
288
self._parents_map = None
289
if 'hpss' in debug.debug_flags:
290
self._requested_parents = None
292
# These depend on the actual remote format, so force them off for
293
# maximum compatibility. XXX: In future these should depend on the
294
# remote repository instance, but this is irrelevant until we perform
295
# reconcile via an RPC call.
296
self._reconcile_does_inventory_gc = False
297
self._reconcile_fixes_text_parents = False
298
self._reconcile_backsup_inventory = False
299
self.base = self.bzrdir.transport.base
302
return "%s(%s)" % (self.__class__.__name__, self.base)
306
def abort_write_group(self):
307
"""Complete a write group on the decorated repository.
309
Smart methods peform operations in a single step so this api
310
is not really applicable except as a compatibility thunk
311
for older plugins that don't use e.g. the CommitBuilder
315
return self._real_repository.abort_write_group()
317
def commit_write_group(self):
318
"""Complete a write group on the decorated repository.
320
Smart methods peform operations in a single step so this api
321
is not really applicable except as a compatibility thunk
322
for older plugins that don't use e.g. the CommitBuilder
326
return self._real_repository.commit_write_group()
328
def _ensure_real(self):
329
"""Ensure that there is a _real_repository set.
331
Used before calls to self._real_repository.
333
if not self._real_repository:
334
self.bzrdir._ensure_real()
335
#self._real_repository = self.bzrdir._real_bzrdir.open_repository()
336
self._set_real_repository(self.bzrdir._real_bzrdir.open_repository())
338
def find_text_key_references(self):
339
"""Find the text key references within the repository.
341
:return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
342
revision_ids. Each altered file-ids has the exact revision_ids that
343
altered it listed explicitly.
344
:return: A dictionary mapping text keys ((fileid, revision_id) tuples)
345
to whether they were referred to by the inventory of the
346
revision_id that they contain. The inventory texts from all present
347
revision ids are assessed to generate this report.
350
return self._real_repository.find_text_key_references()
352
def _generate_text_key_index(self):
353
"""Generate a new text key index for the repository.
355
This is an expensive function that will take considerable time to run.
357
:return: A dict mapping (file_id, revision_id) tuples to a list of
358
parents, also (file_id, revision_id) tuples.
361
return self._real_repository._generate_text_key_index()
363
@symbol_versioning.deprecated_method(symbol_versioning.one_four)
364
def get_revision_graph(self, revision_id=None):
365
"""See Repository.get_revision_graph()."""
366
return self._get_revision_graph(revision_id)
368
def _get_revision_graph(self, revision_id):
369
"""Private method for using with old (< 1.2) servers to fallback."""
370
if revision_id is None:
372
elif revision.is_null(revision_id):
375
path = self.bzrdir._path_for_remote_call(self._client)
376
assert type(revision_id) is str
377
response = self._client.call_expecting_body(
378
'Repository.get_revision_graph', path, revision_id)
379
if response[0][0] not in ['ok', 'nosuchrevision']:
380
raise errors.UnexpectedSmartServerResponse(response[0])
381
if response[0][0] == 'ok':
382
coded = response[1].read_body_bytes()
384
# no revisions in this repository!
386
lines = coded.split('\n')
389
d = tuple(line.split())
390
revision_graph[d[0]] = d[1:]
392
return revision_graph
394
response_body = response[1].read_body_bytes()
395
assert response_body == ''
396
raise NoSuchRevision(self, revision_id)
398
def has_revision(self, revision_id):
399
"""See Repository.has_revision()."""
400
if revision_id == NULL_REVISION:
401
# The null revision is always present.
403
path = self.bzrdir._path_for_remote_call(self._client)
404
response = self._client.call('Repository.has_revision', path, revision_id)
405
assert response[0] in ('yes', 'no'), 'unexpected response code %s' % (response,)
406
return response[0] == 'yes'
408
def has_revisions(self, revision_ids):
409
"""See Repository.has_revisions()."""
411
for revision_id in revision_ids:
412
if self.has_revision(revision_id):
413
result.add(revision_id)
416
def has_same_location(self, other):
417
return (self.__class__ == other.__class__ and
418
self.bzrdir.transport.base == other.bzrdir.transport.base)
420
def get_graph(self, other_repository=None):
421
"""Return the graph for this repository format"""
422
parents_provider = self
423
if (other_repository is not None and
424
other_repository.bzrdir.transport.base !=
425
self.bzrdir.transport.base):
426
parents_provider = graph._StackedParentsProvider(
427
[parents_provider, other_repository._make_parents_provider()])
428
return graph.Graph(parents_provider)
430
def gather_stats(self, revid=None, committers=None):
431
"""See Repository.gather_stats()."""
432
path = self.bzrdir._path_for_remote_call(self._client)
433
# revid can be None to indicate no revisions, not just NULL_REVISION
434
if revid is None or revision.is_null(revid):
438
if committers is None or not committers:
439
fmt_committers = 'no'
441
fmt_committers = 'yes'
442
response = self._client.call_expecting_body(
443
'Repository.gather_stats', path, fmt_revid, fmt_committers)
444
assert response[0][0] == 'ok', \
445
'unexpected response code %s' % (response[0],)
447
body = response[1].read_body_bytes()
449
for line in body.split('\n'):
452
key, val_text = line.split(':')
453
if key in ('revisions', 'size', 'committers'):
454
result[key] = int(val_text)
455
elif key in ('firstrev', 'latestrev'):
456
values = val_text.split(' ')[1:]
457
result[key] = (float(values[0]), long(values[1]))
461
def find_branches(self, using=False):
462
"""See Repository.find_branches()."""
463
# should be an API call to the server.
465
return self._real_repository.find_branches(using=using)
467
def get_physical_lock_status(self):
468
"""See Repository.get_physical_lock_status()."""
469
# should be an API call to the server.
471
return self._real_repository.get_physical_lock_status()
473
def is_in_write_group(self):
474
"""Return True if there is an open write group.
476
write groups are only applicable locally for the smart server..
478
if self._real_repository:
479
return self._real_repository.is_in_write_group()
482
return self._lock_count >= 1
485
"""See Repository.is_shared()."""
486
path = self.bzrdir._path_for_remote_call(self._client)
487
response = self._client.call('Repository.is_shared', path)
488
assert response[0] in ('yes', 'no'), 'unexpected response code %s' % (response,)
489
return response[0] == 'yes'
491
def is_write_locked(self):
492
return self._lock_mode == 'w'
495
# wrong eventually - want a local lock cache context
496
if not self._lock_mode:
497
self._lock_mode = 'r'
499
self._parents_map = {}
500
if 'hpss' in debug.debug_flags:
501
self._requested_parents = set()
502
if self._real_repository is not None:
503
self._real_repository.lock_read()
505
self._lock_count += 1
507
def _remote_lock_write(self, token):
508
path = self.bzrdir._path_for_remote_call(self._client)
511
response = self._client.call('Repository.lock_write', path, token)
512
if response[0] == 'ok':
515
elif response[0] == 'LockContention':
516
raise errors.LockContention('(remote lock)')
517
elif response[0] == 'UnlockableTransport':
518
raise errors.UnlockableTransport(self.bzrdir.root_transport)
519
elif response[0] == 'LockFailed':
520
raise errors.LockFailed(response[1], response[2])
522
raise errors.UnexpectedSmartServerResponse(response)
524
def lock_write(self, token=None):
525
if not self._lock_mode:
526
self._lock_token = self._remote_lock_write(token)
527
# if self._lock_token is None, then this is something like packs or
528
# svn where we don't get to lock the repo, or a weave style repository
529
# where we cannot lock it over the wire and attempts to do so will
531
if self._real_repository is not None:
532
self._real_repository.lock_write(token=self._lock_token)
533
if token is not None:
534
self._leave_lock = True
536
self._leave_lock = False
537
self._lock_mode = 'w'
539
self._parents_map = {}
540
if 'hpss' in debug.debug_flags:
541
self._requested_parents = set()
542
elif self._lock_mode == 'r':
543
raise errors.ReadOnlyError(self)
545
self._lock_count += 1
546
return self._lock_token or None
548
def leave_lock_in_place(self):
549
if not self._lock_token:
550
raise NotImplementedError(self.leave_lock_in_place)
551
self._leave_lock = True
553
def dont_leave_lock_in_place(self):
554
if not self._lock_token:
555
raise NotImplementedError(self.dont_leave_lock_in_place)
556
self._leave_lock = False
558
def _set_real_repository(self, repository):
559
"""Set the _real_repository for this repository.
561
:param repository: The repository to fallback to for non-hpss
562
implemented operations.
564
assert not isinstance(repository, RemoteRepository)
565
self._real_repository = repository
566
if self._lock_mode == 'w':
567
# if we are already locked, the real repository must be able to
568
# acquire the lock with our token.
569
self._real_repository.lock_write(self._lock_token)
570
elif self._lock_mode == 'r':
571
self._real_repository.lock_read()
573
def start_write_group(self):
574
"""Start a write group on the decorated repository.
576
Smart methods peform operations in a single step so this api
577
is not really applicable except as a compatibility thunk
578
for older plugins that don't use e.g. the CommitBuilder
582
return self._real_repository.start_write_group()
584
def _unlock(self, token):
585
path = self.bzrdir._path_for_remote_call(self._client)
587
# with no token the remote repository is not persistently locked.
589
response = self._client.call('Repository.unlock', path, token)
590
if response == ('ok',):
592
elif response[0] == 'TokenMismatch':
593
raise errors.TokenMismatch(token, '(remote token)')
595
raise errors.UnexpectedSmartServerResponse(response)
598
self._lock_count -= 1
599
if self._lock_count > 0:
601
self._parents_map = None
602
if 'hpss' in debug.debug_flags:
603
self._requested_parents = None
604
old_mode = self._lock_mode
605
self._lock_mode = None
607
# The real repository is responsible at present for raising an
608
# exception if it's in an unfinished write group. However, it
609
# normally will *not* actually remove the lock from disk - that's
610
# done by the server on receiving the Repository.unlock call.
611
# This is just to let the _real_repository stay up to date.
612
if self._real_repository is not None:
613
self._real_repository.unlock()
615
# The rpc-level lock should be released even if there was a
616
# problem releasing the vfs-based lock.
618
# Only write-locked repositories need to make a remote method
619
# call to perfom the unlock.
620
old_token = self._lock_token
621
self._lock_token = None
622
if not self._leave_lock:
623
self._unlock(old_token)
625
def break_lock(self):
626
# should hand off to the network
628
return self._real_repository.break_lock()
630
def _get_tarball(self, compression):
631
"""Return a TemporaryFile containing a repository tarball.
633
Returns None if the server does not support sending tarballs.
636
path = self.bzrdir._path_for_remote_call(self._client)
637
response, protocol = self._client.call_expecting_body(
638
'Repository.tarball', path, compression)
639
if response[0] == 'ok':
640
# Extract the tarball and return it
641
t = tempfile.NamedTemporaryFile()
642
# TODO: rpc layer should read directly into it...
643
t.write(protocol.read_body_bytes())
646
if (response == ('error', "Generic bzr smart protocol error: "
647
"bad request 'Repository.tarball'") or
648
response == ('error', "Generic bzr smart protocol error: "
649
"bad request u'Repository.tarball'")):
650
protocol.cancel_read_body()
652
raise errors.UnexpectedSmartServerResponse(response)
654
def sprout(self, to_bzrdir, revision_id=None):
655
# TODO: Option to control what format is created?
657
dest_repo = self._real_repository._format.initialize(to_bzrdir,
659
dest_repo.fetch(self, revision_id=revision_id)
662
### These methods are just thin shims to the VFS object for now.
664
def revision_tree(self, revision_id):
666
return self._real_repository.revision_tree(revision_id)
668
def get_serializer_format(self):
670
return self._real_repository.get_serializer_format()
672
def get_commit_builder(self, branch, parents, config, timestamp=None,
673
timezone=None, committer=None, revprops=None,
675
# FIXME: It ought to be possible to call this without immediately
676
# triggering _ensure_real. For now it's the easiest thing to do.
678
builder = self._real_repository.get_commit_builder(branch, parents,
679
config, timestamp=timestamp, timezone=timezone,
680
committer=committer, revprops=revprops, revision_id=revision_id)
683
def add_inventory(self, revid, inv, parents):
685
return self._real_repository.add_inventory(revid, inv, parents)
687
def add_revision(self, rev_id, rev, inv=None, config=None):
689
return self._real_repository.add_revision(
690
rev_id, rev, inv=inv, config=config)
693
def get_inventory(self, revision_id):
695
return self._real_repository.get_inventory(revision_id)
697
def iter_inventories(self, revision_ids):
699
return self._real_repository.iter_inventories(revision_ids)
702
def get_revision(self, revision_id):
704
return self._real_repository.get_revision(revision_id)
707
def weave_store(self):
709
return self._real_repository.weave_store
711
def get_transaction(self):
713
return self._real_repository.get_transaction()
716
def clone(self, a_bzrdir, revision_id=None):
718
return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
720
def make_working_trees(self):
721
"""RemoteRepositories never create working trees by default."""
724
def revision_ids_to_search_result(self, result_set):
725
"""Convert a set of revision ids to a graph SearchResult."""
726
result_parents = set()
727
for parents in self.get_graph().get_parent_map(
728
result_set).itervalues():
729
result_parents.update(parents)
730
included_keys = result_set.intersection(result_parents)
731
start_keys = result_set.difference(included_keys)
732
exclude_keys = result_parents.difference(result_set)
733
result = graph.SearchResult(start_keys, exclude_keys,
734
len(result_set), result_set)
738
def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
739
"""Return the revision ids that other has that this does not.
741
These are returned in topological order.
743
revision_id: only return revision ids included by revision_id.
745
return repository.InterRepository.get(
746
other, self).search_missing_revision_ids(revision_id, find_ghosts)
748
def fetch(self, source, revision_id=None, pb=None):
749
if self.has_same_location(source):
750
# check that last_revision is in 'from' and then return a
752
if (revision_id is not None and
753
not revision.is_null(revision_id)):
754
self.get_revision(revision_id)
757
return self._real_repository.fetch(
758
source, revision_id=revision_id, pb=pb)
760
def create_bundle(self, target, base, fileobj, format=None):
762
self._real_repository.create_bundle(target, base, fileobj, format)
765
def control_weaves(self):
767
return self._real_repository.control_weaves
770
def get_ancestry(self, revision_id, topo_sorted=True):
772
return self._real_repository.get_ancestry(revision_id, topo_sorted)
775
def get_inventory_weave(self):
777
return self._real_repository.get_inventory_weave()
779
def fileids_altered_by_revision_ids(self, revision_ids):
781
return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
783
def _get_versioned_file_checker(self, revisions, revision_versions_cache):
785
return self._real_repository._get_versioned_file_checker(
786
revisions, revision_versions_cache)
788
def iter_files_bytes(self, desired_files):
789
"""See Repository.iter_file_bytes.
792
return self._real_repository.iter_files_bytes(desired_files)
794
def get_parent_map(self, keys):
795
"""See bzrlib.Graph.get_parent_map()."""
796
# Hack to build up the caching logic.
797
ancestry = self._parents_map
799
# Repository is not locked, so there's no cache.
800
missing_revisions = set(keys)
803
missing_revisions = set(key for key in keys if key not in ancestry)
804
if missing_revisions:
805
parent_map = self._get_parent_map(missing_revisions)
806
if 'hpss' in debug.debug_flags:
807
mutter('retransmitted revisions: %d of %d',
808
len(set(ancestry).intersection(parent_map)),
810
ancestry.update(parent_map)
811
present_keys = [k for k in keys if k in ancestry]
812
if 'hpss' in debug.debug_flags:
813
self._requested_parents.update(present_keys)
814
mutter('Current RemoteRepository graph hit rate: %d%%',
815
100.0 * len(self._requested_parents) / len(ancestry))
816
return dict((k, ancestry[k]) for k in present_keys)
818
def _response_is_unknown_method(self, response, verb):
819
"""Return True if response is an unknonwn method response to verb.
821
:param response: The response from a smart client call_expecting_body
823
:param verb: The verb used in that call.
824
:return: True if an unknown method was encountered.
826
# This might live better on
827
# bzrlib.smart.protocol.SmartClientRequestProtocolOne
828
if (response[0] == ('error', "Generic bzr smart protocol error: "
829
"bad request '%s'" % verb) or
830
response[0] == ('error', "Generic bzr smart protocol error: "
831
"bad request u'%s'" % verb)):
832
response[1].cancel_read_body()
836
def _get_parent_map(self, keys):
837
"""Helper for get_parent_map that performs the RPC."""
838
medium = self._client._medium
839
if not medium._remote_is_at_least_1_2:
840
# We already found out that the server can't understand
841
# Repository.get_parent_map requests, so just fetch the whole
843
# XXX: Note that this will issue a deprecation warning. This is ok
844
# :- its because we're working with a deprecated server anyway, and
845
# the user will almost certainly have seen a warning about the
846
# server version already.
847
return self.get_revision_graph()
850
if NULL_REVISION in keys:
851
keys.discard(NULL_REVISION)
852
found_parents = {NULL_REVISION:()}
857
# TODO(Needs analysis): We could assume that the keys being requested
858
# from get_parent_map are in a breadth first search, so typically they
859
# will all be depth N from some common parent, and we don't have to
860
# have the server iterate from the root parent, but rather from the
861
# keys we're searching; and just tell the server the keyspace we
862
# already have; but this may be more traffic again.
864
# Transform self._parents_map into a search request recipe.
865
# TODO: Manage this incrementally to avoid covering the same path
866
# repeatedly. (The server will have to on each request, but the less
867
# work done the better).
868
parents_map = self._parents_map
869
if parents_map is None:
870
# Repository is not locked, so there's no cache.
872
start_set = set(parents_map)
873
result_parents = set()
874
for parents in parents_map.itervalues():
875
result_parents.update(parents)
876
stop_keys = result_parents.difference(start_set)
877
included_keys = start_set.intersection(result_parents)
878
start_set.difference_update(included_keys)
879
recipe = (start_set, stop_keys, len(parents_map))
880
body = self._serialise_search_recipe(recipe)
881
path = self.bzrdir._path_for_remote_call(self._client)
883
assert type(key) is str
884
verb = 'Repository.get_parent_map'
885
args = (path,) + tuple(keys)
886
response = self._client.call_with_body_bytes_expecting_body(
887
verb, args, self._serialise_search_recipe(recipe))
888
if self._response_is_unknown_method(response, verb):
889
# Server does not support this method, so get the whole graph.
890
# Worse, we have to force a disconnection, because the server now
891
# doesn't realise it has a body on the wire to consume, so the
892
# only way to recover is to abandon the connection.
894
'Server is too old for fast get_parent_map, reconnecting. '
895
'(Upgrade the server to Bazaar 1.2 to avoid this)')
897
# To avoid having to disconnect repeatedly, we keep track of the
898
# fact the server doesn't understand remote methods added in 1.2.
899
medium._remote_is_at_least_1_2 = False
900
return self._get_revision_graph(None)
901
elif response[0][0] not in ['ok']:
902
reponse[1].cancel_read_body()
903
raise errors.UnexpectedSmartServerResponse(response[0])
904
if response[0][0] == 'ok':
905
coded = bz2.decompress(response[1].read_body_bytes())
909
lines = coded.split('\n')
912
d = tuple(line.split())
914
revision_graph[d[0]] = d[1:]
916
# No parents - so give the Graph result (NULL_REVISION,).
917
revision_graph[d[0]] = (NULL_REVISION,)
918
return revision_graph
921
def get_signature_text(self, revision_id):
923
return self._real_repository.get_signature_text(revision_id)
926
@symbol_versioning.deprecated_method(symbol_versioning.one_three)
927
def get_revision_graph_with_ghosts(self, revision_ids=None):
929
return self._real_repository.get_revision_graph_with_ghosts(
930
revision_ids=revision_ids)
933
def get_inventory_xml(self, revision_id):
935
return self._real_repository.get_inventory_xml(revision_id)
937
def deserialise_inventory(self, revision_id, xml):
939
return self._real_repository.deserialise_inventory(revision_id, xml)
941
def reconcile(self, other=None, thorough=False):
943
return self._real_repository.reconcile(other=other, thorough=thorough)
945
def all_revision_ids(self):
947
return self._real_repository.all_revision_ids()
950
def get_deltas_for_revisions(self, revisions):
952
return self._real_repository.get_deltas_for_revisions(revisions)
955
def get_revision_delta(self, revision_id):
957
return self._real_repository.get_revision_delta(revision_id)
960
def revision_trees(self, revision_ids):
962
return self._real_repository.revision_trees(revision_ids)
965
def get_revision_reconcile(self, revision_id):
967
return self._real_repository.get_revision_reconcile(revision_id)
970
def check(self, revision_ids=None):
972
return self._real_repository.check(revision_ids=revision_ids)
974
def copy_content_into(self, destination, revision_id=None):
976
return self._real_repository.copy_content_into(
977
destination, revision_id=revision_id)
979
def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
980
# get a tarball of the remote repository, and copy from that into the
982
from bzrlib import osutils
985
# TODO: Maybe a progress bar while streaming the tarball?
986
note("Copying repository content as tarball...")
987
tar_file = self._get_tarball('bz2')
990
destination = to_bzrdir.create_repository()
992
tar = tarfile.open('repository', fileobj=tar_file,
994
tmpdir = tempfile.mkdtemp()
996
_extract_tar(tar, tmpdir)
997
tmp_bzrdir = BzrDir.open(tmpdir)
998
tmp_repo = tmp_bzrdir.open_repository()
999
tmp_repo.copy_content_into(destination, revision_id)
1001
osutils.rmtree(tmpdir)
1005
# TODO: Suggestion from john: using external tar is much faster than
1006
# python's tarfile library, but it may not work on windows.
1010
"""Compress the data within the repository.
1012
This is not currently implemented within the smart server.
1015
return self._real_repository.pack()
1017
def set_make_working_trees(self, new_value):
1018
raise NotImplementedError(self.set_make_working_trees)
1021
def sign_revision(self, revision_id, gpg_strategy):
1023
return self._real_repository.sign_revision(revision_id, gpg_strategy)
1026
def get_revisions(self, revision_ids):
1028
return self._real_repository.get_revisions(revision_ids)
1030
def supports_rich_root(self):
1032
return self._real_repository.supports_rich_root()
1034
def iter_reverse_revision_history(self, revision_id):
1036
return self._real_repository.iter_reverse_revision_history(revision_id)
1039
def _serializer(self):
1041
return self._real_repository._serializer
1043
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1045
return self._real_repository.store_revision_signature(
1046
gpg_strategy, plaintext, revision_id)
1048
def add_signature_text(self, revision_id, signature):
1050
return self._real_repository.add_signature_text(revision_id, signature)
1052
def has_signature_for_revision_id(self, revision_id):
1054
return self._real_repository.has_signature_for_revision_id(revision_id)
1056
def get_data_stream_for_search(self, search):
1057
medium = self._client._medium
1058
if not medium._remote_is_at_least_1_2:
1060
return self._real_repository.get_data_stream_for_search(search)
1061
REQUEST_NAME = 'Repository.stream_revisions_chunked'
1062
path = self.bzrdir._path_for_remote_call(self._client)
1063
body = self._serialise_search_recipe(search.get_recipe())
1064
response, protocol = self._client.call_with_body_bytes_expecting_body(
1065
REQUEST_NAME, (path,), body)
1067
if self._response_is_unknown_method((response, protocol), REQUEST_NAME):
1068
# Server does not support this method, so fall back to VFS.
1069
# Worse, we have to force a disconnection, because the server now
1070
# doesn't realise it has a body on the wire to consume, so the
1071
# only way to recover is to abandon the connection.
1073
'Server is too old for streaming pull, reconnecting. '
1074
'(Upgrade the server to Bazaar 1.2 to avoid this)')
1076
# To avoid having to disconnect repeatedly, we keep track of the
1077
# fact the server doesn't understand this remote method.
1078
medium._remote_is_at_least_1_2 = False
1080
return self._real_repository.get_data_stream_for_search(search)
1082
if response == ('ok',):
1083
return self._deserialise_stream(protocol)
1084
if response == ('NoSuchRevision', ):
1085
# We cannot easily identify the revision that is missing in this
1086
# situation without doing much more network IO. For now, bail.
1087
raise NoSuchRevision(self, "unknown")
1089
raise errors.UnexpectedSmartServerResponse(response)
1091
def _deserialise_stream(self, protocol):
1092
stream = protocol.read_streamed_body()
1093
container_parser = ContainerPushParser()
1094
for bytes in stream:
1095
container_parser.accept_bytes(bytes)
1096
records = container_parser.read_pending_records()
1097
for record_names, record_bytes in records:
1098
if len(record_names) != 1:
1099
# These records should have only one name, and that name
1100
# should be a one-element tuple.
1101
raise errors.SmartProtocolError(
1102
'Repository data stream had invalid record name %r'
1104
name_tuple = record_names[0]
1105
yield name_tuple, record_bytes
1107
def insert_data_stream(self, stream):
1109
self._real_repository.insert_data_stream(stream)
1111
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
1113
return self._real_repository.item_keys_introduced_by(revision_ids,
1114
_files_pb=_files_pb)
1116
def revision_graph_can_have_wrong_parents(self):
1117
# The answer depends on the remote repo format.
1119
return self._real_repository.revision_graph_can_have_wrong_parents()
1121
def _find_inconsistent_revision_parents(self):
1123
return self._real_repository._find_inconsistent_revision_parents()
1125
def _check_for_inconsistent_revision_parents(self):
1127
return self._real_repository._check_for_inconsistent_revision_parents()
1129
def _make_parents_provider(self):
1132
def _serialise_search_recipe(self, recipe):
1133
"""Serialise a graph search recipe.
1135
:param recipe: A search recipe (start, stop, count).
1136
:return: Serialised bytes.
1138
start_keys = ' '.join(recipe[0])
1139
stop_keys = ' '.join(recipe[1])
1140
count = str(recipe[2])
1141
return '\n'.join((start_keys, stop_keys, count))
1144
class RemoteBranchLockableFiles(LockableFiles):
1145
"""A 'LockableFiles' implementation that talks to a smart server.
1147
This is not a public interface class.
1150
def __init__(self, bzrdir, _client):
1151
self.bzrdir = bzrdir
1152
self._client = _client
1153
self._need_find_modes = True
1154
LockableFiles.__init__(
1155
self, bzrdir.get_branch_transport(None),
1156
'lock', lockdir.LockDir)
1158
def _find_modes(self):
1159
# RemoteBranches don't let the client set the mode of control files.
1160
self._dir_mode = None
1161
self._file_mode = None
1163
def get(self, path):
1164
"""'get' a remote path as per the LockableFiles interface.
1166
:param path: the file to 'get'. If this is 'branch.conf', we do not
1167
just retrieve a file, instead we ask the smart server to generate
1168
a configuration for us - which is retrieved as an INI file.
1170
if path == 'branch.conf':
1171
path = self.bzrdir._path_for_remote_call(self._client)
1172
response = self._client.call_expecting_body(
1173
'Branch.get_config_file', path)
1174
assert response[0][0] == 'ok', \
1175
'unexpected response code %s' % (response[0],)
1176
return StringIO(response[1].read_body_bytes())
1179
return LockableFiles.get(self, path)
1182
class RemoteBranchFormat(branch.BranchFormat):
1184
def __eq__(self, other):
1185
return (isinstance(other, RemoteBranchFormat) and
1186
self.__dict__ == other.__dict__)
1188
def get_format_description(self):
1189
return 'Remote BZR Branch'
1191
def get_format_string(self):
1192
return 'Remote BZR Branch'
1194
def open(self, a_bzrdir):
1195
assert isinstance(a_bzrdir, RemoteBzrDir)
1196
return a_bzrdir.open_branch()
1198
def initialize(self, a_bzrdir):
1199
assert isinstance(a_bzrdir, RemoteBzrDir)
1200
return a_bzrdir.create_branch()
1202
def supports_tags(self):
1203
# Remote branches might support tags, but we won't know until we
1204
# access the real remote branch.
1208
class RemoteBranch(branch.Branch):
1209
"""Branch stored on a server accessed by HPSS RPC.
1211
At the moment most operations are mapped down to simple file operations.
1214
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
1216
"""Create a RemoteBranch instance.
1218
:param real_branch: An optional local implementation of the branch
1219
format, usually accessing the data via the VFS.
1220
:param _client: Private parameter for testing.
1222
# We intentionally don't call the parent class's __init__, because it
1223
# will try to assign to self.tags, which is a property in this subclass.
1224
# And the parent's __init__ doesn't do much anyway.
1225
self._revision_id_to_revno_cache = None
1226
self._revision_history_cache = None
1227
self.bzrdir = remote_bzrdir
1228
if _client is not None:
1229
self._client = _client
1231
self._client = remote_bzrdir._client
1232
self.repository = remote_repository
1233
if real_branch is not None:
1234
self._real_branch = real_branch
1235
# Give the remote repository the matching real repo.
1236
real_repo = self._real_branch.repository
1237
if isinstance(real_repo, RemoteRepository):
1238
real_repo._ensure_real()
1239
real_repo = real_repo._real_repository
1240
self.repository._set_real_repository(real_repo)
1241
# Give the branch the remote repository to let fast-pathing happen.
1242
self._real_branch.repository = self.repository
1244
self._real_branch = None
1245
# Fill out expected attributes of branch for bzrlib api users.
1246
self._format = RemoteBranchFormat()
1247
self.base = self.bzrdir.root_transport.base
1248
self._control_files = None
1249
self._lock_mode = None
1250
self._lock_token = None
1251
self._lock_count = 0
1252
self._leave_lock = False
1255
return "%s(%s)" % (self.__class__.__name__, self.base)
1259
def _ensure_real(self):
1260
"""Ensure that there is a _real_branch set.
1262
Used before calls to self._real_branch.
1264
if not self._real_branch:
1265
assert vfs.vfs_enabled()
1266
self.bzrdir._ensure_real()
1267
self._real_branch = self.bzrdir._real_bzrdir.open_branch()
1268
# Give the remote repository the matching real repo.
1269
real_repo = self._real_branch.repository
1270
if isinstance(real_repo, RemoteRepository):
1271
real_repo._ensure_real()
1272
real_repo = real_repo._real_repository
1273
self.repository._set_real_repository(real_repo)
1274
# Give the branch the remote repository to let fast-pathing happen.
1275
self._real_branch.repository = self.repository
1276
# XXX: deal with _lock_mode == 'w'
1277
if self._lock_mode == 'r':
1278
self._real_branch.lock_read()
1281
def control_files(self):
1282
# Defer actually creating RemoteBranchLockableFiles until its needed,
1283
# because it triggers an _ensure_real that we otherwise might not need.
1284
if self._control_files is None:
1285
self._control_files = RemoteBranchLockableFiles(
1286
self.bzrdir, self._client)
1287
return self._control_files
1289
def _get_checkout_format(self):
1291
return self._real_branch._get_checkout_format()
1293
def get_physical_lock_status(self):
1294
"""See Branch.get_physical_lock_status()."""
1295
# should be an API call to the server, as branches must be lockable.
1297
return self._real_branch.get_physical_lock_status()
1299
def lock_read(self):
1300
if not self._lock_mode:
1301
self._lock_mode = 'r'
1302
self._lock_count = 1
1303
if self._real_branch is not None:
1304
self._real_branch.lock_read()
1306
self._lock_count += 1
1308
def _remote_lock_write(self, token):
1310
branch_token = repo_token = ''
1312
branch_token = token
1313
repo_token = self.repository.lock_write()
1314
self.repository.unlock()
1315
path = self.bzrdir._path_for_remote_call(self._client)
1316
response = self._client.call('Branch.lock_write', path, branch_token,
1318
if response[0] == 'ok':
1319
ok, branch_token, repo_token = response
1320
return branch_token, repo_token
1321
elif response[0] == 'LockContention':
1322
raise errors.LockContention('(remote lock)')
1323
elif response[0] == 'TokenMismatch':
1324
raise errors.TokenMismatch(token, '(remote token)')
1325
elif response[0] == 'UnlockableTransport':
1326
raise errors.UnlockableTransport(self.bzrdir.root_transport)
1327
elif response[0] == 'ReadOnlyError':
1328
raise errors.ReadOnlyError(self)
1329
elif response[0] == 'LockFailed':
1330
raise errors.LockFailed(response[1], response[2])
1332
raise errors.UnexpectedSmartServerResponse(response)
1334
def lock_write(self, token=None):
1335
if not self._lock_mode:
1336
remote_tokens = self._remote_lock_write(token)
1337
self._lock_token, self._repo_lock_token = remote_tokens
1338
assert self._lock_token, 'Remote server did not return a token!'
1339
# TODO: We really, really, really don't want to call _ensure_real
1340
# here, but it's the easiest way to ensure coherency between the
1341
# state of the RemoteBranch and RemoteRepository objects and the
1342
# physical locks. If we don't materialise the real objects here,
1343
# then getting everything in the right state later is complex, so
1344
# for now we just do it the lazy way.
1345
# -- Andrew Bennetts, 2007-02-22.
1347
if self._real_branch is not None:
1348
self._real_branch.repository.lock_write(
1349
token=self._repo_lock_token)
1351
self._real_branch.lock_write(token=self._lock_token)
1353
self._real_branch.repository.unlock()
1354
if token is not None:
1355
self._leave_lock = True
1357
# XXX: this case seems to be unreachable; token cannot be None.
1358
self._leave_lock = False
1359
self._lock_mode = 'w'
1360
self._lock_count = 1
1361
elif self._lock_mode == 'r':
1362
raise errors.ReadOnlyTransaction
1364
if token is not None:
1365
# A token was given to lock_write, and we're relocking, so check
1366
# that the given token actually matches the one we already have.
1367
if token != self._lock_token:
1368
raise errors.TokenMismatch(token, self._lock_token)
1369
self._lock_count += 1
1370
return self._lock_token or None
1372
def _unlock(self, branch_token, repo_token):
1373
path = self.bzrdir._path_for_remote_call(self._client)
1374
response = self._client.call('Branch.unlock', path, branch_token,
1376
if response == ('ok',):
1378
elif response[0] == 'TokenMismatch':
1379
raise errors.TokenMismatch(
1380
str((branch_token, repo_token)), '(remote tokens)')
1382
raise errors.UnexpectedSmartServerResponse(response)
1385
self._lock_count -= 1
1386
if not self._lock_count:
1387
self._clear_cached_state()
1388
mode = self._lock_mode
1389
self._lock_mode = None
1390
if self._real_branch is not None:
1391
if (not self._leave_lock and mode == 'w' and
1392
self._repo_lock_token):
1393
# If this RemoteBranch will remove the physical lock for the
1394
# repository, make sure the _real_branch doesn't do it
1395
# first. (Because the _real_branch's repository is set to
1396
# be the RemoteRepository.)
1397
self._real_branch.repository.leave_lock_in_place()
1398
self._real_branch.unlock()
1400
# Only write-locked branched need to make a remote method call
1401
# to perfom the unlock.
1403
assert self._lock_token, 'Locked, but no token!'
1404
branch_token = self._lock_token
1405
repo_token = self._repo_lock_token
1406
self._lock_token = None
1407
self._repo_lock_token = None
1408
if not self._leave_lock:
1409
self._unlock(branch_token, repo_token)
1411
def break_lock(self):
1413
return self._real_branch.break_lock()
1415
def leave_lock_in_place(self):
1416
if not self._lock_token:
1417
raise NotImplementedError(self.leave_lock_in_place)
1418
self._leave_lock = True
1420
def dont_leave_lock_in_place(self):
1421
if not self._lock_token:
1422
raise NotImplementedError(self.dont_leave_lock_in_place)
1423
self._leave_lock = False
1425
def last_revision_info(self):
1426
"""See Branch.last_revision_info()."""
1427
path = self.bzrdir._path_for_remote_call(self._client)
1428
response = self._client.call('Branch.last_revision_info', path)
1429
assert response[0] == 'ok', 'unexpected response code %s' % (response,)
1430
revno = int(response[1])
1431
last_revision = response[2]
1432
return (revno, last_revision)
1434
def _gen_revision_history(self):
1435
"""See Branch._gen_revision_history()."""
1436
path = self.bzrdir._path_for_remote_call(self._client)
1437
response = self._client.call_expecting_body(
1438
'Branch.revision_history', path)
1439
assert response[0][0] == 'ok', ('unexpected response code %s'
1441
result = response[1].read_body_bytes().split('\x00')
1447
def set_revision_history(self, rev_history):
1448
# Send just the tip revision of the history; the server will generate
1449
# the full history from that. If the revision doesn't exist in this
1450
# branch, NoSuchRevision will be raised.
1451
path = self.bzrdir._path_for_remote_call(self._client)
1452
if rev_history == []:
1455
rev_id = rev_history[-1]
1456
self._clear_cached_state()
1457
response = self._client.call('Branch.set_last_revision',
1458
path, self._lock_token, self._repo_lock_token, rev_id)
1459
if response[0] == 'NoSuchRevision':
1460
raise NoSuchRevision(self, rev_id)
1462
assert response == ('ok',), (
1463
'unexpected response code %r' % (response,))
1464
self._cache_revision_history(rev_history)
1466
def get_parent(self):
1468
return self._real_branch.get_parent()
1470
def set_parent(self, url):
1472
return self._real_branch.set_parent(url)
1474
def get_config(self):
1475
return RemoteBranchConfig(self)
1477
def sprout(self, to_bzrdir, revision_id=None):
1478
# Like Branch.sprout, except that it sprouts a branch in the default
1479
# format, because RemoteBranches can't be created at arbitrary URLs.
1480
# XXX: if to_bzrdir is a RemoteBranch, this should perhaps do
1481
# to_bzrdir.create_branch...
1483
result = self._real_branch._format.initialize(to_bzrdir)
1484
self.copy_content_into(result, revision_id=revision_id)
1485
result.set_parent(self.bzrdir.root_transport.base)
1489
def pull(self, source, overwrite=False, stop_revision=None,
1491
# FIXME: This asks the real branch to run the hooks, which means
1492
# they're called with the wrong target branch parameter.
1493
# The test suite specifically allows this at present but it should be
1494
# fixed. It should get a _override_hook_target branch,
1495
# as push does. -- mbp 20070405
1497
self._real_branch.pull(
1498
source, overwrite=overwrite, stop_revision=stop_revision,
1502
def push(self, target, overwrite=False, stop_revision=None):
1504
return self._real_branch.push(
1505
target, overwrite=overwrite, stop_revision=stop_revision,
1506
_override_hook_source_branch=self)
1508
def is_locked(self):
1509
return self._lock_count >= 1
1511
def set_last_revision_info(self, revno, revision_id):
1513
self._clear_cached_state()
1514
return self._real_branch.set_last_revision_info(revno, revision_id)
1516
def generate_revision_history(self, revision_id, last_rev=None,
1519
return self._real_branch.generate_revision_history(
1520
revision_id, last_rev=last_rev, other_branch=other_branch)
1525
return self._real_branch.tags
1527
def set_push_location(self, location):
1529
return self._real_branch.set_push_location(location)
1531
def update_revisions(self, other, stop_revision=None, overwrite=False):
1533
return self._real_branch.update_revisions(
1534
other, stop_revision=stop_revision, overwrite=overwrite)
1537
class RemoteBranchConfig(BranchConfig):
1540
self.branch._ensure_real()
1541
return self.branch._real_branch.get_config().username()
1543
def _get_branch_data_config(self):
1544
self.branch._ensure_real()
1545
if self._branch_data_config is None:
1546
self._branch_data_config = TreeConfig(self.branch._real_branch)
1547
return self._branch_data_config
1550
def _extract_tar(tar, to_dir):
1551
"""Extract all the contents of a tarfile object.
1553
A replacement for extractall, which is not present in python2.4
1556
tar.extract(tarinfo, to_dir)
added
removed
bzrlib/remote.py
