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.
20
from cStringIO import StringIO
30
from bzrlib.branch import BranchReferenceFormat
31
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
32
from bzrlib.config import BranchConfig, TreeConfig
33
from bzrlib.decorators import needs_read_lock, needs_write_lock
34
from bzrlib.errors import NoSuchRevision
35
from bzrlib.lockable_files import LockableFiles
36
from bzrlib.pack import ContainerPushParser
37
from bzrlib.smart import client, vfs
38
from bzrlib.symbol_versioning import (
42
from bzrlib.revision import NULL_REVISION
43
from bzrlib.trace import note
45
# Note: RemoteBzrDirFormat is in bzrdir.py
47
class RemoteBzrDir(BzrDir):
48
"""Control directory on a remote server, accessed via bzr:// or similar."""
50
def __init__(self, transport, _client=None):
51
"""Construct a RemoteBzrDir.
53
:param _client: Private parameter for testing. Disables probing and the
56
BzrDir.__init__(self, transport, RemoteBzrDirFormat())
57
# this object holds a delegated bzrdir that uses file-level operations
58
# to talk to the other side
59
self._real_bzrdir = None
62
self._shared_medium = transport.get_shared_medium()
63
self._client = client._SmartClient(self._shared_medium)
65
self._client = _client
66
self._shared_medium = None
69
path = self._path_for_remote_call(self._client)
70
response = self._client.call('BzrDir.open', path)
71
if response not in [('yes',), ('no',)]:
72
raise errors.UnexpectedSmartServerResponse(response)
73
if response == ('no',):
74
raise errors.NotBranchError(path=transport.base)
76
def _ensure_real(self):
77
"""Ensure that there is a _real_bzrdir set.
79
Used before calls to self._real_bzrdir.
81
if not self._real_bzrdir:
82
self._real_bzrdir = BzrDir.open_from_transport(
83
self.root_transport, _server_formats=False)
85
def create_repository(self, shared=False):
87
self._real_bzrdir.create_repository(shared=shared)
88
return self.open_repository()
90
def destroy_repository(self):
91
"""See BzrDir.destroy_repository"""
93
self._real_bzrdir.destroy_repository()
95
def create_branch(self):
97
real_branch = self._real_bzrdir.create_branch()
98
return RemoteBranch(self, self.find_repository(), real_branch)
100
def destroy_branch(self):
101
"""See BzrDir.destroy_branch"""
103
self._real_bzrdir.destroy_branch()
105
def create_workingtree(self, revision_id=None, from_branch=None):
106
raise errors.NotLocalUrl(self.transport.base)
108
def find_branch_format(self):
109
"""Find the branch 'format' for this bzrdir.
111
This might be a synthetic object for e.g. RemoteBranch and SVN.
113
b = self.open_branch()
116
def get_branch_reference(self):
117
"""See BzrDir.get_branch_reference()."""
118
path = self._path_for_remote_call(self._client)
119
response = self._client.call('BzrDir.open_branch', path)
120
if response[0] == 'ok':
121
if response[1] == '':
122
# branch at this location.
125
# a branch reference, use the existing BranchReference logic.
127
elif response == ('nobranch',):
128
raise errors.NotBranchError(path=self.root_transport.base)
130
raise errors.UnexpectedSmartServerResponse(response)
132
def open_branch(self, _unsupported=False):
133
assert _unsupported == False, 'unsupported flag support not implemented yet.'
134
reference_url = self.get_branch_reference()
135
if reference_url is None:
136
# branch at this location.
137
return RemoteBranch(self, self.find_repository())
139
# a branch reference, use the existing BranchReference logic.
140
format = BranchReferenceFormat()
141
return format.open(self, _found=True, location=reference_url)
143
def open_repository(self):
144
path = self._path_for_remote_call(self._client)
145
response = self._client.call('BzrDir.find_repository', path)
146
assert response[0] in ('ok', 'norepository'), \
147
'unexpected response code %s' % (response,)
148
if response[0] == 'norepository':
149
raise errors.NoRepositoryPresent(self)
150
assert len(response) == 4, 'incorrect response length %s' % (response,)
151
if response[1] == '':
152
format = RemoteRepositoryFormat()
153
format.rich_root_data = (response[2] == 'yes')
154
format.supports_tree_reference = (response[3] == 'yes')
155
return RemoteRepository(self, format)
157
raise errors.NoRepositoryPresent(self)
159
def open_workingtree(self, recommend_upgrade=True):
161
if self._real_bzrdir.has_workingtree():
162
raise errors.NotLocalUrl(self.root_transport)
164
raise errors.NoWorkingTree(self.root_transport.base)
166
def _path_for_remote_call(self, client):
167
"""Return the path to be used for this bzrdir in a remote call."""
168
return client.remote_path_from_transport(self.root_transport)
170
def get_branch_transport(self, branch_format):
172
return self._real_bzrdir.get_branch_transport(branch_format)
174
def get_repository_transport(self, repository_format):
176
return self._real_bzrdir.get_repository_transport(repository_format)
178
def get_workingtree_transport(self, workingtree_format):
180
return self._real_bzrdir.get_workingtree_transport(workingtree_format)
182
def can_convert_format(self):
183
"""Upgrading of remote bzrdirs is not supported yet."""
186
def needs_format_conversion(self, format=None):
187
"""Upgrading of remote bzrdirs is not supported yet."""
190
def clone(self, url, revision_id=None, force_new_repo=False):
192
return self._real_bzrdir.clone(url, revision_id=revision_id,
193
force_new_repo=force_new_repo)
196
class RemoteRepositoryFormat(repository.RepositoryFormat):
197
"""Format for repositories accessed over a _SmartClient.
199
Instances of this repository are represented by RemoteRepository
202
The RemoteRepositoryFormat is parameterized during construction
203
to reflect the capabilities of the real, remote format. Specifically
204
the attributes rich_root_data and supports_tree_reference are set
205
on a per instance basis, and are not set (and should not be) at
209
_matchingbzrdir = RemoteBzrDirFormat
211
def initialize(self, a_bzrdir, shared=False):
212
assert isinstance(a_bzrdir, RemoteBzrDir), \
213
'%r is not a RemoteBzrDir' % (a_bzrdir,)
214
return a_bzrdir.create_repository(shared=shared)
216
def open(self, a_bzrdir):
217
assert isinstance(a_bzrdir, RemoteBzrDir)
218
return a_bzrdir.open_repository()
220
def get_format_description(self):
221
return 'bzr remote repository'
223
def __eq__(self, other):
224
return self.__class__ == other.__class__
226
def check_conversion_target(self, target_format):
227
if self.rich_root_data and not target_format.rich_root_data:
228
raise errors.BadConversionTarget(
229
'Does not support rich root data.', target_format)
230
if (self.supports_tree_reference and
231
not getattr(target_format, 'supports_tree_reference', False)):
232
raise errors.BadConversionTarget(
233
'Does not support nested trees', target_format)
236
class RemoteRepository(object):
237
"""Repository accessed over rpc.
239
For the moment most operations are performed using local transport-backed
243
def __init__(self, remote_bzrdir, format, real_repository=None, _client=None):
244
"""Create a RemoteRepository instance.
246
:param remote_bzrdir: The bzrdir hosting this repository.
247
:param format: The RemoteFormat object to use.
248
:param real_repository: If not None, a local implementation of the
249
repository logic for the repository, usually accessing the data
251
:param _client: Private testing parameter - override the smart client
252
to be used by the repository.
255
self._real_repository = real_repository
257
self._real_repository = None
258
self.bzrdir = remote_bzrdir
260
self._client = client._SmartClient(self.bzrdir._shared_medium)
262
self._client = _client
263
self._format = format
264
self._lock_mode = None
265
self._lock_token = None
267
self._leave_lock = False
268
# A cache of looked up revision parent data; reset at unlock time.
269
self._parents_map = None
271
# These depend on the actual remote format, so force them off for
272
# maximum compatibility. XXX: In future these should depend on the
273
# remote repository instance, but this is irrelevant until we perform
274
# reconcile via an RPC call.
275
self._reconcile_does_inventory_gc = False
276
self._reconcile_fixes_text_parents = False
277
self._reconcile_backsup_inventory = False
278
self.base = self.bzrdir.transport.base
281
return "%s(%s)" % (self.__class__.__name__, self.base)
285
def abort_write_group(self):
286
"""Complete a write group on the decorated repository.
288
Smart methods peform operations in a single step so this api
289
is not really applicable except as a compatibility thunk
290
for older plugins that don't use e.g. the CommitBuilder
294
return self._real_repository.abort_write_group()
296
def commit_write_group(self):
297
"""Complete a write group on the decorated repository.
299
Smart methods peform operations in a single step so this api
300
is not really applicable except as a compatibility thunk
301
for older plugins that don't use e.g. the CommitBuilder
305
return self._real_repository.commit_write_group()
307
def _ensure_real(self):
308
"""Ensure that there is a _real_repository set.
310
Used before calls to self._real_repository.
312
if not self._real_repository:
313
self.bzrdir._ensure_real()
314
#self._real_repository = self.bzrdir._real_bzrdir.open_repository()
315
self._set_real_repository(self.bzrdir._real_bzrdir.open_repository())
317
def find_text_key_references(self):
318
"""Find the text key references within the repository.
320
:return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
321
revision_ids. Each altered file-ids has the exact revision_ids that
322
altered it listed explicitly.
323
:return: A dictionary mapping text keys ((fileid, revision_id) tuples)
324
to whether they were referred to by the inventory of the
325
revision_id that they contain. The inventory texts from all present
326
revision ids are assessed to generate this report.
329
return self._real_repository.find_text_key_references()
331
def _generate_text_key_index(self):
332
"""Generate a new text key index for the repository.
334
This is an expensive function that will take considerable time to run.
336
:return: A dict mapping (file_id, revision_id) tuples to a list of
337
parents, also (file_id, revision_id) tuples.
340
return self._real_repository._generate_text_key_index()
342
def get_revision_graph(self, revision_id=None):
343
"""See Repository.get_revision_graph()."""
344
if revision_id is None:
346
elif revision.is_null(revision_id):
349
path = self.bzrdir._path_for_remote_call(self._client)
350
assert type(revision_id) is str
351
response = self._client.call_expecting_body(
352
'Repository.get_revision_graph', path, revision_id)
353
if response[0][0] not in ['ok', 'nosuchrevision']:
354
raise errors.UnexpectedSmartServerResponse(response[0])
355
if response[0][0] == 'ok':
356
coded = response[1].read_body_bytes()
358
# no revisions in this repository!
360
lines = coded.split('\n')
363
d = tuple(line.split())
364
revision_graph[d[0]] = d[1:]
366
return revision_graph
368
response_body = response[1].read_body_bytes()
369
assert response_body == ''
370
raise NoSuchRevision(self, revision_id)
372
def has_revision(self, revision_id):
373
"""See Repository.has_revision()."""
374
if revision_id == NULL_REVISION:
375
# The null revision is always present.
377
path = self.bzrdir._path_for_remote_call(self._client)
378
response = self._client.call('Repository.has_revision', path, revision_id)
379
assert response[0] in ('yes', 'no'), 'unexpected response code %s' % (response,)
380
return response[0] == 'yes'
382
def has_revisions(self, revision_ids):
383
"""See Repository.has_revisions()."""
385
for revision_id in revision_ids:
386
if self.has_revision(revision_id):
387
result.add(revision_id)
390
def has_same_location(self, other):
391
return (self.__class__ == other.__class__ and
392
self.bzrdir.transport.base == other.bzrdir.transport.base)
394
def get_graph(self, other_repository=None):
395
"""Return the graph for this repository format"""
396
parents_provider = self
397
if (other_repository is not None and
398
other_repository.bzrdir.transport.base !=
399
self.bzrdir.transport.base):
400
parents_provider = graph._StackedParentsProvider(
401
[parents_provider, other_repository._make_parents_provider()])
402
return graph.Graph(parents_provider)
404
def gather_stats(self, revid=None, committers=None):
405
"""See Repository.gather_stats()."""
406
path = self.bzrdir._path_for_remote_call(self._client)
407
# revid can be None to indicate no revisions, not just NULL_REVISION
408
if revid is None or revision.is_null(revid):
412
if committers is None or not committers:
413
fmt_committers = 'no'
415
fmt_committers = 'yes'
416
response = self._client.call_expecting_body(
417
'Repository.gather_stats', path, fmt_revid, fmt_committers)
418
assert response[0][0] == 'ok', \
419
'unexpected response code %s' % (response[0],)
421
body = response[1].read_body_bytes()
423
for line in body.split('\n'):
426
key, val_text = line.split(':')
427
if key in ('revisions', 'size', 'committers'):
428
result[key] = int(val_text)
429
elif key in ('firstrev', 'latestrev'):
430
values = val_text.split(' ')[1:]
431
result[key] = (float(values[0]), long(values[1]))
435
def find_branches(self, using=False):
436
"""See Repository.find_branches()."""
437
# should be an API call to the server.
439
return self._real_repository.find_branches(using=using)
441
def get_physical_lock_status(self):
442
"""See Repository.get_physical_lock_status()."""
443
# should be an API call to the server.
445
return self._real_repository.get_physical_lock_status()
447
def is_in_write_group(self):
448
"""Return True if there is an open write group.
450
write groups are only applicable locally for the smart server..
452
if self._real_repository:
453
return self._real_repository.is_in_write_group()
456
return self._lock_count >= 1
459
"""See Repository.is_shared()."""
460
path = self.bzrdir._path_for_remote_call(self._client)
461
response = self._client.call('Repository.is_shared', path)
462
assert response[0] in ('yes', 'no'), 'unexpected response code %s' % (response,)
463
return response[0] == 'yes'
465
def is_write_locked(self):
466
return self._lock_mode == 'w'
469
# wrong eventually - want a local lock cache context
470
if not self._lock_mode:
471
self._lock_mode = 'r'
473
self._parents_map = {}
474
if self._real_repository is not None:
475
self._real_repository.lock_read()
477
self._lock_count += 1
479
def _remote_lock_write(self, token):
480
path = self.bzrdir._path_for_remote_call(self._client)
483
response = self._client.call('Repository.lock_write', path, token)
484
if response[0] == 'ok':
487
elif response[0] == 'LockContention':
488
raise errors.LockContention('(remote lock)')
489
elif response[0] == 'UnlockableTransport':
490
raise errors.UnlockableTransport(self.bzrdir.root_transport)
491
elif response[0] == 'LockFailed':
492
raise errors.LockFailed(response[1], response[2])
494
raise errors.UnexpectedSmartServerResponse(response)
496
def lock_write(self, token=None):
497
if not self._lock_mode:
498
self._lock_token = self._remote_lock_write(token)
499
# if self._lock_token is None, then this is something like packs or
500
# svn where we don't get to lock the repo, or a weave style repository
501
# where we cannot lock it over the wire and attempts to do so will
503
if self._real_repository is not None:
504
self._real_repository.lock_write(token=self._lock_token)
505
if token is not None:
506
self._leave_lock = True
508
self._leave_lock = False
509
self._lock_mode = 'w'
511
self._parents_map = {}
512
elif self._lock_mode == 'r':
513
raise errors.ReadOnlyError(self)
515
self._lock_count += 1
516
return self._lock_token or None
518
def leave_lock_in_place(self):
519
if not self._lock_token:
520
raise NotImplementedError(self.leave_lock_in_place)
521
self._leave_lock = True
523
def dont_leave_lock_in_place(self):
524
if not self._lock_token:
525
raise NotImplementedError(self.dont_leave_lock_in_place)
526
self._leave_lock = False
528
def _set_real_repository(self, repository):
529
"""Set the _real_repository for this repository.
531
:param repository: The repository to fallback to for non-hpss
532
implemented operations.
534
assert not isinstance(repository, RemoteRepository)
535
self._real_repository = repository
536
if self._lock_mode == 'w':
537
# if we are already locked, the real repository must be able to
538
# acquire the lock with our token.
539
self._real_repository.lock_write(self._lock_token)
540
elif self._lock_mode == 'r':
541
self._real_repository.lock_read()
543
def start_write_group(self):
544
"""Start a write group on the decorated repository.
546
Smart methods peform operations in a single step so this api
547
is not really applicable except as a compatibility thunk
548
for older plugins that don't use e.g. the CommitBuilder
552
return self._real_repository.start_write_group()
554
def _unlock(self, token):
555
path = self.bzrdir._path_for_remote_call(self._client)
557
# with no token the remote repository is not persistently locked.
559
response = self._client.call('Repository.unlock', path, token)
560
if response == ('ok',):
562
elif response[0] == 'TokenMismatch':
563
raise errors.TokenMismatch(token, '(remote token)')
565
raise errors.UnexpectedSmartServerResponse(response)
568
self._lock_count -= 1
569
if self._lock_count > 0:
571
self._parents_map = None
572
old_mode = self._lock_mode
573
self._lock_mode = None
575
# The real repository is responsible at present for raising an
576
# exception if it's in an unfinished write group. However, it
577
# normally will *not* actually remove the lock from disk - that's
578
# done by the server on receiving the Repository.unlock call.
579
# This is just to let the _real_repository stay up to date.
580
if self._real_repository is not None:
581
self._real_repository.unlock()
583
# The rpc-level lock should be released even if there was a
584
# problem releasing the vfs-based lock.
586
# Only write-locked repositories need to make a remote method
587
# call to perfom the unlock.
588
old_token = self._lock_token
589
self._lock_token = None
590
if not self._leave_lock:
591
self._unlock(old_token)
593
def break_lock(self):
594
# should hand off to the network
596
return self._real_repository.break_lock()
598
def _get_tarball(self, compression):
599
"""Return a TemporaryFile containing a repository tarball.
601
Returns None if the server does not support sending tarballs.
604
path = self.bzrdir._path_for_remote_call(self._client)
605
response, protocol = self._client.call_expecting_body(
606
'Repository.tarball', path, compression)
607
if response[0] == 'ok':
608
# Extract the tarball and return it
609
t = tempfile.NamedTemporaryFile()
610
# TODO: rpc layer should read directly into it...
611
t.write(protocol.read_body_bytes())
614
if (response == ('error', "Generic bzr smart protocol error: "
615
"bad request 'Repository.tarball'") or
616
response == ('error', "Generic bzr smart protocol error: "
617
"bad request u'Repository.tarball'")):
618
protocol.cancel_read_body()
620
raise errors.UnexpectedSmartServerResponse(response)
622
def sprout(self, to_bzrdir, revision_id=None):
623
# TODO: Option to control what format is created?
625
dest_repo = self._real_repository._format.initialize(to_bzrdir,
627
dest_repo.fetch(self, revision_id=revision_id)
630
### These methods are just thin shims to the VFS object for now.
632
def revision_tree(self, revision_id):
634
return self._real_repository.revision_tree(revision_id)
636
def get_serializer_format(self):
638
return self._real_repository.get_serializer_format()
640
def get_commit_builder(self, branch, parents, config, timestamp=None,
641
timezone=None, committer=None, revprops=None,
643
# FIXME: It ought to be possible to call this without immediately
644
# triggering _ensure_real. For now it's the easiest thing to do.
646
builder = self._real_repository.get_commit_builder(branch, parents,
647
config, timestamp=timestamp, timezone=timezone,
648
committer=committer, revprops=revprops, revision_id=revision_id)
652
def add_inventory(self, revid, inv, parents):
654
return self._real_repository.add_inventory(revid, inv, parents)
657
def add_revision(self, rev_id, rev, inv=None, config=None):
659
return self._real_repository.add_revision(
660
rev_id, rev, inv=inv, config=config)
663
def get_inventory(self, revision_id):
665
return self._real_repository.get_inventory(revision_id)
667
def iter_inventories(self, revision_ids):
669
return self._real_repository.iter_inventories(revision_ids)
672
def get_revision(self, revision_id):
674
return self._real_repository.get_revision(revision_id)
677
def weave_store(self):
679
return self._real_repository.weave_store
681
def get_transaction(self):
683
return self._real_repository.get_transaction()
686
def clone(self, a_bzrdir, revision_id=None):
688
return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
690
def make_working_trees(self):
691
"""RemoteRepositories never create working trees by default."""
694
def fetch(self, source, revision_id=None, pb=None):
695
if self.has_same_location(source):
696
# check that last_revision is in 'from' and then return a
698
if (revision_id is not None and
699
not revision.is_null(revision_id)):
700
self.get_revision(revision_id)
703
return self._real_repository.fetch(
704
source, revision_id=revision_id, pb=pb)
706
def create_bundle(self, target, base, fileobj, format=None):
708
self._real_repository.create_bundle(target, base, fileobj, format)
711
def control_weaves(self):
713
return self._real_repository.control_weaves
716
def get_ancestry(self, revision_id, topo_sorted=True):
718
return self._real_repository.get_ancestry(revision_id, topo_sorted)
721
def get_inventory_weave(self):
723
return self._real_repository.get_inventory_weave()
725
def fileids_altered_by_revision_ids(self, revision_ids):
727
return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
729
def _get_versioned_file_checker(self, revisions, revision_versions_cache):
731
return self._real_repository._get_versioned_file_checker(
732
revisions, revision_versions_cache)
734
def iter_files_bytes(self, desired_files):
735
"""See Repository.iter_file_bytes.
738
return self._real_repository.iter_files_bytes(desired_files)
740
def get_parent_map(self, keys):
741
"""See bzrlib.Graph.get_parent_map()."""
742
# Hack to build up the caching logic.
743
ancestry = self._parents_map
744
missing_revisions = set(key for key in keys if key not in ancestry)
745
if missing_revisions:
746
self._parents_map.update(self._get_parent_map(missing_revisions))
747
return dict((k, ancestry[k]) for k in keys if k in ancestry)
749
def _response_is_unknown_method(self, response, verb):
750
"""Return True if response is an unknonwn method response to verb.
752
:param response: The response from a smart client call_expecting_body
754
:param verb: The verb used in that call.
755
:return: True if an unknown method was encountered.
757
# This might live better on
758
# bzrlib.smart.protocol.SmartClientRequestProtocolOne
759
if (response[0] == ('error', "Generic bzr smart protocol error: "
760
"bad request '%s'" % verb) or
761
response[0] == ('error', "Generic bzr smart protocol error: "
762
"bad request u'%s'" % verb)):
763
response[1].cancel_read_body()
767
def _get_parent_map(self, keys):
768
"""Helper for get_parent_map that performs the RPC."""
770
if NULL_REVISION in keys:
771
keys.discard(NULL_REVISION)
772
found_parents = {NULL_REVISION:()}
777
path = self.bzrdir._path_for_remote_call(self._client)
779
assert type(key) is str
780
verb = 'Repository.get_parent_map'
781
response = self._client.call_expecting_body(
783
if self._response_is_unknown_method(response, verb):
784
# Server that does not support this method, get the whole graph.
785
response = self._client.call_expecting_body(
786
'Repository.get_revision_graph', path, '')
787
if response[0][0] not in ['ok', 'nosuchrevision']:
788
reponse[1].cancel_read_body()
789
raise errors.UnexpectedSmartServerResponse(response[0])
790
elif response[0][0] not in ['ok']:
791
reponse[1].cancel_read_body()
792
raise errors.UnexpectedSmartServerResponse(response[0])
793
if response[0][0] == 'ok':
794
coded = response[1].read_body_bytes()
798
lines = coded.split('\n')
801
d = tuple(line.split())
803
revision_graph[d[0]] = d[1:]
805
# No parents - so give the Graph result (NULL_REVISION,).
806
revision_graph[d[0]] = (NULL_REVISION,)
807
return revision_graph
810
def get_signature_text(self, revision_id):
812
return self._real_repository.get_signature_text(revision_id)
815
def get_revision_graph_with_ghosts(self, revision_ids=None):
817
return self._real_repository.get_revision_graph_with_ghosts(
818
revision_ids=revision_ids)
821
def get_inventory_xml(self, revision_id):
823
return self._real_repository.get_inventory_xml(revision_id)
825
def deserialise_inventory(self, revision_id, xml):
827
return self._real_repository.deserialise_inventory(revision_id, xml)
829
def reconcile(self, other=None, thorough=False):
831
return self._real_repository.reconcile(other=other, thorough=thorough)
833
def all_revision_ids(self):
835
return self._real_repository.all_revision_ids()
838
def get_deltas_for_revisions(self, revisions):
840
return self._real_repository.get_deltas_for_revisions(revisions)
843
def get_revision_delta(self, revision_id):
845
return self._real_repository.get_revision_delta(revision_id)
848
def revision_trees(self, revision_ids):
850
return self._real_repository.revision_trees(revision_ids)
853
def get_revision_reconcile(self, revision_id):
855
return self._real_repository.get_revision_reconcile(revision_id)
858
def check(self, revision_ids=None):
860
return self._real_repository.check(revision_ids=revision_ids)
862
def copy_content_into(self, destination, revision_id=None):
864
return self._real_repository.copy_content_into(
865
destination, revision_id=revision_id)
867
def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
868
# get a tarball of the remote repository, and copy from that into the
870
from bzrlib import osutils
873
# TODO: Maybe a progress bar while streaming the tarball?
874
note("Copying repository content as tarball...")
875
tar_file = self._get_tarball('bz2')
878
destination = to_bzrdir.create_repository()
880
tar = tarfile.open('repository', fileobj=tar_file,
882
tmpdir = tempfile.mkdtemp()
884
_extract_tar(tar, tmpdir)
885
tmp_bzrdir = BzrDir.open(tmpdir)
886
tmp_repo = tmp_bzrdir.open_repository()
887
tmp_repo.copy_content_into(destination, revision_id)
889
osutils.rmtree(tmpdir)
893
# TODO: Suggestion from john: using external tar is much faster than
894
# python's tarfile library, but it may not work on windows.
898
"""Compress the data within the repository.
900
This is not currently implemented within the smart server.
903
return self._real_repository.pack()
905
def set_make_working_trees(self, new_value):
906
raise NotImplementedError(self.set_make_working_trees)
909
def sign_revision(self, revision_id, gpg_strategy):
911
return self._real_repository.sign_revision(revision_id, gpg_strategy)
914
def get_revisions(self, revision_ids):
916
return self._real_repository.get_revisions(revision_ids)
918
def supports_rich_root(self):
920
return self._real_repository.supports_rich_root()
922
def iter_reverse_revision_history(self, revision_id):
924
return self._real_repository.iter_reverse_revision_history(revision_id)
927
def _serializer(self):
929
return self._real_repository._serializer
931
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
933
return self._real_repository.store_revision_signature(
934
gpg_strategy, plaintext, revision_id)
936
def add_signature_text(self, revision_id, signature):
938
return self._real_repository.add_signature_text(revision_id, signature)
940
def has_signature_for_revision_id(self, revision_id):
942
return self._real_repository.has_signature_for_revision_id(revision_id)
944
def get_data_stream(self, revision_ids):
945
REQUEST_NAME = 'Repository.stream_revisions_chunked'
946
path = self.bzrdir._path_for_remote_call(self._client)
947
response, protocol = self._client.call_expecting_body(
948
REQUEST_NAME, path, *revision_ids)
950
if response == ('ok',):
951
return self._deserialise_stream(protocol)
952
elif (response == ('error', "Generic bzr smart protocol error: "
953
"bad request '%s'" % REQUEST_NAME) or
954
response == ('error', "Generic bzr smart protocol error: "
955
"bad request u'%s'" % REQUEST_NAME)):
956
protocol.cancel_read_body()
958
return self._real_repository.get_data_stream(revision_ids)
960
raise errors.UnexpectedSmartServerResponse(response)
962
def _deserialise_stream(self, protocol):
963
stream = protocol.read_streamed_body()
964
container_parser = ContainerPushParser()
966
container_parser.accept_bytes(bytes)
967
records = container_parser.read_pending_records()
968
for record_names, record_bytes in records:
969
if len(record_names) != 1:
970
# These records should have only one name, and that name
971
# should be a one-element tuple.
972
raise errors.SmartProtocolError(
973
'Repository data stream had invalid record name %r'
975
name_tuple = record_names[0]
976
yield name_tuple, record_bytes
978
def insert_data_stream(self, stream):
980
self._real_repository.insert_data_stream(stream)
982
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
984
return self._real_repository.item_keys_introduced_by(revision_ids,
987
def revision_graph_can_have_wrong_parents(self):
988
# The answer depends on the remote repo format.
990
return self._real_repository.revision_graph_can_have_wrong_parents()
992
def _find_inconsistent_revision_parents(self):
994
return self._real_repository._find_inconsistent_revision_parents()
996
def _check_for_inconsistent_revision_parents(self):
998
return self._real_repository._check_for_inconsistent_revision_parents()
1000
def _make_parents_provider(self):
1004
class RemoteBranchLockableFiles(LockableFiles):
1005
"""A 'LockableFiles' implementation that talks to a smart server.
1007
This is not a public interface class.
1010
def __init__(self, bzrdir, _client):
1011
self.bzrdir = bzrdir
1012
self._client = _client
1013
self._need_find_modes = True
1014
LockableFiles.__init__(
1015
self, bzrdir.get_branch_transport(None),
1016
'lock', lockdir.LockDir)
1018
def _find_modes(self):
1019
# RemoteBranches don't let the client set the mode of control files.
1020
self._dir_mode = None
1021
self._file_mode = None
1023
def get(self, path):
1024
"""'get' a remote path as per the LockableFiles interface.
1026
:param path: the file to 'get'. If this is 'branch.conf', we do not
1027
just retrieve a file, instead we ask the smart server to generate
1028
a configuration for us - which is retrieved as an INI file.
1030
if path == 'branch.conf':
1031
path = self.bzrdir._path_for_remote_call(self._client)
1032
response = self._client.call_expecting_body(
1033
'Branch.get_config_file', path)
1034
assert response[0][0] == 'ok', \
1035
'unexpected response code %s' % (response[0],)
1036
return StringIO(response[1].read_body_bytes())
1039
return LockableFiles.get(self, path)
1042
class RemoteBranchFormat(branch.BranchFormat):
1044
def __eq__(self, other):
1045
return (isinstance(other, RemoteBranchFormat) and
1046
self.__dict__ == other.__dict__)
1048
def get_format_description(self):
1049
return 'Remote BZR Branch'
1051
def get_format_string(self):
1052
return 'Remote BZR Branch'
1054
def open(self, a_bzrdir):
1055
assert isinstance(a_bzrdir, RemoteBzrDir)
1056
return a_bzrdir.open_branch()
1058
def initialize(self, a_bzrdir):
1059
assert isinstance(a_bzrdir, RemoteBzrDir)
1060
return a_bzrdir.create_branch()
1062
def supports_tags(self):
1063
# Remote branches might support tags, but we won't know until we
1064
# access the real remote branch.
1068
class RemoteBranch(branch.Branch):
1069
"""Branch stored on a server accessed by HPSS RPC.
1071
At the moment most operations are mapped down to simple file operations.
1074
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
1076
"""Create a RemoteBranch instance.
1078
:param real_branch: An optional local implementation of the branch
1079
format, usually accessing the data via the VFS.
1080
:param _client: Private parameter for testing.
1082
# We intentionally don't call the parent class's __init__, because it
1083
# will try to assign to self.tags, which is a property in this subclass.
1084
# And the parent's __init__ doesn't do much anyway.
1085
self._revision_id_to_revno_cache = None
1086
self._revision_history_cache = None
1087
self.bzrdir = remote_bzrdir
1088
if _client is not None:
1089
self._client = _client
1091
self._client = client._SmartClient(self.bzrdir._shared_medium)
1092
self.repository = remote_repository
1093
if real_branch is not None:
1094
self._real_branch = real_branch
1095
# Give the remote repository the matching real repo.
1096
real_repo = self._real_branch.repository
1097
if isinstance(real_repo, RemoteRepository):
1098
real_repo._ensure_real()
1099
real_repo = real_repo._real_repository
1100
self.repository._set_real_repository(real_repo)
1101
# Give the branch the remote repository to let fast-pathing happen.
1102
self._real_branch.repository = self.repository
1104
self._real_branch = None
1105
# Fill out expected attributes of branch for bzrlib api users.
1106
self._format = RemoteBranchFormat()
1107
self.base = self.bzrdir.root_transport.base
1108
self._control_files = None
1109
self._lock_mode = None
1110
self._lock_token = None
1111
self._lock_count = 0
1112
self._leave_lock = False
1115
return "%s(%s)" % (self.__class__.__name__, self.base)
1119
def _ensure_real(self):
1120
"""Ensure that there is a _real_branch set.
1122
Used before calls to self._real_branch.
1124
if not self._real_branch:
1125
assert vfs.vfs_enabled()
1126
self.bzrdir._ensure_real()
1127
self._real_branch = self.bzrdir._real_bzrdir.open_branch()
1128
# Give the remote repository the matching real repo.
1129
real_repo = self._real_branch.repository
1130
if isinstance(real_repo, RemoteRepository):
1131
real_repo._ensure_real()
1132
real_repo = real_repo._real_repository
1133
self.repository._set_real_repository(real_repo)
1134
# Give the branch the remote repository to let fast-pathing happen.
1135
self._real_branch.repository = self.repository
1136
# XXX: deal with _lock_mode == 'w'
1137
if self._lock_mode == 'r':
1138
self._real_branch.lock_read()
1141
def control_files(self):
1142
# Defer actually creating RemoteBranchLockableFiles until its needed,
1143
# because it triggers an _ensure_real that we otherwise might not need.
1144
if self._control_files is None:
1145
self._control_files = RemoteBranchLockableFiles(
1146
self.bzrdir, self._client)
1147
return self._control_files
1149
def _get_checkout_format(self):
1151
return self._real_branch._get_checkout_format()
1153
def get_physical_lock_status(self):
1154
"""See Branch.get_physical_lock_status()."""
1155
# should be an API call to the server, as branches must be lockable.
1157
return self._real_branch.get_physical_lock_status()
1159
def lock_read(self):
1160
if not self._lock_mode:
1161
self._lock_mode = 'r'
1162
self._lock_count = 1
1163
if self._real_branch is not None:
1164
self._real_branch.lock_read()
1166
self._lock_count += 1
1168
def _remote_lock_write(self, token):
1170
branch_token = repo_token = ''
1172
branch_token = token
1173
repo_token = self.repository.lock_write()
1174
self.repository.unlock()
1175
path = self.bzrdir._path_for_remote_call(self._client)
1176
response = self._client.call('Branch.lock_write', path, branch_token,
1178
if response[0] == 'ok':
1179
ok, branch_token, repo_token = response
1180
return branch_token, repo_token
1181
elif response[0] == 'LockContention':
1182
raise errors.LockContention('(remote lock)')
1183
elif response[0] == 'TokenMismatch':
1184
raise errors.TokenMismatch(token, '(remote token)')
1185
elif response[0] == 'UnlockableTransport':
1186
raise errors.UnlockableTransport(self.bzrdir.root_transport)
1187
elif response[0] == 'ReadOnlyError':
1188
raise errors.ReadOnlyError(self)
1189
elif response[0] == 'LockFailed':
1190
raise errors.LockFailed(response[1], response[2])
1192
raise errors.UnexpectedSmartServerResponse(response)
1194
def lock_write(self, token=None):
1195
if not self._lock_mode:
1196
remote_tokens = self._remote_lock_write(token)
1197
self._lock_token, self._repo_lock_token = remote_tokens
1198
assert self._lock_token, 'Remote server did not return a token!'
1199
# TODO: We really, really, really don't want to call _ensure_real
1200
# here, but it's the easiest way to ensure coherency between the
1201
# state of the RemoteBranch and RemoteRepository objects and the
1202
# physical locks. If we don't materialise the real objects here,
1203
# then getting everything in the right state later is complex, so
1204
# for now we just do it the lazy way.
1205
# -- Andrew Bennetts, 2007-02-22.
1207
if self._real_branch is not None:
1208
self._real_branch.repository.lock_write(
1209
token=self._repo_lock_token)
1211
self._real_branch.lock_write(token=self._lock_token)
1213
self._real_branch.repository.unlock()
1214
if token is not None:
1215
self._leave_lock = True
1217
# XXX: this case seems to be unreachable; token cannot be None.
1218
self._leave_lock = False
1219
self._lock_mode = 'w'
1220
self._lock_count = 1
1221
elif self._lock_mode == 'r':
1222
raise errors.ReadOnlyTransaction
1224
if token is not None:
1225
# A token was given to lock_write, and we're relocking, so check
1226
# that the given token actually matches the one we already have.
1227
if token != self._lock_token:
1228
raise errors.TokenMismatch(token, self._lock_token)
1229
self._lock_count += 1
1230
return self._lock_token or None
1232
def _unlock(self, branch_token, repo_token):
1233
path = self.bzrdir._path_for_remote_call(self._client)
1234
response = self._client.call('Branch.unlock', path, branch_token,
1236
if response == ('ok',):
1238
elif response[0] == 'TokenMismatch':
1239
raise errors.TokenMismatch(
1240
str((branch_token, repo_token)), '(remote tokens)')
1242
raise errors.UnexpectedSmartServerResponse(response)
1245
self._lock_count -= 1
1246
if not self._lock_count:
1247
self._clear_cached_state()
1248
mode = self._lock_mode
1249
self._lock_mode = None
1250
if self._real_branch is not None:
1251
if (not self._leave_lock and mode == 'w' and
1252
self._repo_lock_token):
1253
# If this RemoteBranch will remove the physical lock for the
1254
# repository, make sure the _real_branch doesn't do it
1255
# first. (Because the _real_branch's repository is set to
1256
# be the RemoteRepository.)
1257
self._real_branch.repository.leave_lock_in_place()
1258
self._real_branch.unlock()
1260
# Only write-locked branched need to make a remote method call
1261
# to perfom the unlock.
1263
assert self._lock_token, 'Locked, but no token!'
1264
branch_token = self._lock_token
1265
repo_token = self._repo_lock_token
1266
self._lock_token = None
1267
self._repo_lock_token = None
1268
if not self._leave_lock:
1269
self._unlock(branch_token, repo_token)
1271
def break_lock(self):
1273
return self._real_branch.break_lock()
1275
def leave_lock_in_place(self):
1276
if not self._lock_token:
1277
raise NotImplementedError(self.leave_lock_in_place)
1278
self._leave_lock = True
1280
def dont_leave_lock_in_place(self):
1281
if not self._lock_token:
1282
raise NotImplementedError(self.dont_leave_lock_in_place)
1283
self._leave_lock = False
1285
def last_revision_info(self):
1286
"""See Branch.last_revision_info()."""
1287
path = self.bzrdir._path_for_remote_call(self._client)
1288
response = self._client.call('Branch.last_revision_info', path)
1289
assert response[0] == 'ok', 'unexpected response code %s' % (response,)
1290
revno = int(response[1])
1291
last_revision = response[2]
1292
return (revno, last_revision)
1294
def _gen_revision_history(self):
1295
"""See Branch._gen_revision_history()."""
1296
path = self.bzrdir._path_for_remote_call(self._client)
1297
response = self._client.call_expecting_body(
1298
'Branch.revision_history', path)
1299
assert response[0][0] == 'ok', ('unexpected response code %s'
1301
result = response[1].read_body_bytes().split('\x00')
1307
def set_revision_history(self, rev_history):
1308
# Send just the tip revision of the history; the server will generate
1309
# the full history from that. If the revision doesn't exist in this
1310
# branch, NoSuchRevision will be raised.
1311
path = self.bzrdir._path_for_remote_call(self._client)
1312
if rev_history == []:
1315
rev_id = rev_history[-1]
1316
self._clear_cached_state()
1317
response = self._client.call('Branch.set_last_revision',
1318
path, self._lock_token, self._repo_lock_token, rev_id)
1319
if response[0] == 'NoSuchRevision':
1320
raise NoSuchRevision(self, rev_id)
1322
assert response == ('ok',), (
1323
'unexpected response code %r' % (response,))
1324
self._cache_revision_history(rev_history)
1326
def get_parent(self):
1328
return self._real_branch.get_parent()
1330
def set_parent(self, url):
1332
return self._real_branch.set_parent(url)
1334
def get_config(self):
1335
return RemoteBranchConfig(self)
1337
def sprout(self, to_bzrdir, revision_id=None):
1338
# Like Branch.sprout, except that it sprouts a branch in the default
1339
# format, because RemoteBranches can't be created at arbitrary URLs.
1340
# XXX: if to_bzrdir is a RemoteBranch, this should perhaps do
1341
# to_bzrdir.create_branch...
1343
result = self._real_branch._format.initialize(to_bzrdir)
1344
self.copy_content_into(result, revision_id=revision_id)
1345
result.set_parent(self.bzrdir.root_transport.base)
1349
def pull(self, source, overwrite=False, stop_revision=None,
1351
# FIXME: This asks the real branch to run the hooks, which means
1352
# they're called with the wrong target branch parameter.
1353
# The test suite specifically allows this at present but it should be
1354
# fixed. It should get a _override_hook_target branch,
1355
# as push does. -- mbp 20070405
1357
self._real_branch.pull(
1358
source, overwrite=overwrite, stop_revision=stop_revision,
1362
def push(self, target, overwrite=False, stop_revision=None):
1364
return self._real_branch.push(
1365
target, overwrite=overwrite, stop_revision=stop_revision,
1366
_override_hook_source_branch=self)
1368
def is_locked(self):
1369
return self._lock_count >= 1
1371
def set_last_revision_info(self, revno, revision_id):
1373
self._clear_cached_state()
1374
return self._real_branch.set_last_revision_info(revno, revision_id)
1376
def generate_revision_history(self, revision_id, last_rev=None,
1379
return self._real_branch.generate_revision_history(
1380
revision_id, last_rev=last_rev, other_branch=other_branch)
1385
return self._real_branch.tags
1387
def set_push_location(self, location):
1389
return self._real_branch.set_push_location(location)
1391
def update_revisions(self, other, stop_revision=None, overwrite=False):
1393
return self._real_branch.update_revisions(
1394
other, stop_revision=stop_revision, overwrite=overwrite)
1397
class RemoteBranchConfig(BranchConfig):
1400
self.branch._ensure_real()
1401
return self.branch._real_branch.get_config().username()
1403
def _get_branch_data_config(self):
1404
self.branch._ensure_real()
1405
if self._branch_data_config is None:
1406
self._branch_data_config = TreeConfig(self.branch._real_branch)
1407
return self._branch_data_config
1410
def _extract_tar(tar, to_dir):
1411
"""Extract all the contents of a tarfile object.
1413
A replacement for extractall, which is not present in python2.4
1416
tar.extract(tarinfo, to_dir)
added
removed
bzrlib/remote.py
