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
29
from bzrlib.branch import Branch, BranchReferenceFormat
30
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
31
from bzrlib.config import BranchConfig, TreeConfig
32
from bzrlib.decorators import needs_read_lock, needs_write_lock
33
from bzrlib.errors import NoSuchRevision
34
from bzrlib.lockable_files import LockableFiles
35
from bzrlib.pack import ContainerReader
36
from bzrlib.smart import client, vfs
37
from bzrlib.symbol_versioning import (
41
from bzrlib.trace import note
43
# Note: RemoteBzrDirFormat is in bzrdir.py
45
class RemoteBzrDir(BzrDir):
46
"""Control directory on a remote server, accessed via bzr:// or similar."""
48
def __init__(self, transport, _client=None):
49
"""Construct a RemoteBzrDir.
51
:param _client: Private parameter for testing. Disables probing and the
54
BzrDir.__init__(self, transport, RemoteBzrDirFormat())
55
# this object holds a delegated bzrdir that uses file-level operations
56
# to talk to the other side
57
self._real_bzrdir = None
60
self._shared_medium = transport.get_shared_medium()
61
self._client = client._SmartClient(self._shared_medium)
63
self._client = _client
64
self._shared_medium = None
67
path = self._path_for_remote_call(self._client)
68
response = self._client.call('BzrDir.open', path)
69
if response not in [('yes',), ('no',)]:
70
raise errors.UnexpectedSmartServerResponse(response)
71
if response == ('no',):
72
raise errors.NotBranchError(path=transport.base)
74
def _ensure_real(self):
75
"""Ensure that there is a _real_bzrdir set.
77
Used before calls to self._real_bzrdir.
79
if not self._real_bzrdir:
80
self._real_bzrdir = BzrDir.open_from_transport(
81
self.root_transport, _server_formats=False)
83
def create_repository(self, shared=False):
85
self._real_bzrdir.create_repository(shared=shared)
86
return self.open_repository()
88
def create_branch(self):
90
real_branch = self._real_bzrdir.create_branch()
91
return RemoteBranch(self, self.find_repository(), real_branch)
93
def destroy_branch(self):
94
"""See BzrDir.destroy_branch"""
96
self._real_bzrdir.destroy_branch()
98
def create_workingtree(self, revision_id=None, from_branch=None):
99
raise errors.NotLocalUrl(self.transport.base)
101
def find_branch_format(self):
102
"""Find the branch 'format' for this bzrdir.
104
This might be a synthetic object for e.g. RemoteBranch and SVN.
106
b = self.open_branch()
109
def get_branch_reference(self):
110
"""See BzrDir.get_branch_reference()."""
111
path = self._path_for_remote_call(self._client)
112
response = self._client.call('BzrDir.open_branch', path)
113
if response[0] == 'ok':
114
if response[1] == '':
115
# branch at this location.
118
# a branch reference, use the existing BranchReference logic.
120
elif response == ('nobranch',):
121
raise errors.NotBranchError(path=self.root_transport.base)
123
raise errors.UnexpectedSmartServerResponse(response)
125
def open_branch(self, _unsupported=False):
126
assert _unsupported == False, 'unsupported flag support not implemented yet.'
127
reference_url = self.get_branch_reference()
128
if reference_url is None:
129
# branch at this location.
130
return RemoteBranch(self, self.find_repository())
132
# a branch reference, use the existing BranchReference logic.
133
format = BranchReferenceFormat()
134
return format.open(self, _found=True, location=reference_url)
136
def open_repository(self):
137
path = self._path_for_remote_call(self._client)
138
response = self._client.call('BzrDir.find_repository', path)
139
assert response[0] in ('ok', 'norepository'), \
140
'unexpected response code %s' % (response,)
141
if response[0] == 'norepository':
142
raise errors.NoRepositoryPresent(self)
143
assert len(response) == 4, 'incorrect response length %s' % (response,)
144
if response[1] == '':
145
format = RemoteRepositoryFormat()
146
format.rich_root_data = (response[2] == 'yes')
147
format.supports_tree_reference = (response[3] == 'yes')
148
return RemoteRepository(self, format)
150
raise errors.NoRepositoryPresent(self)
152
def open_workingtree(self, recommend_upgrade=True):
154
if self._real_bzrdir.has_workingtree():
155
raise errors.NotLocalUrl(self.root_transport)
157
raise errors.NoWorkingTree(self.root_transport.base)
159
def _path_for_remote_call(self, client):
160
"""Return the path to be used for this bzrdir in a remote call."""
161
return client.remote_path_from_transport(self.root_transport)
163
def get_branch_transport(self, branch_format):
165
return self._real_bzrdir.get_branch_transport(branch_format)
167
def get_repository_transport(self, repository_format):
169
return self._real_bzrdir.get_repository_transport(repository_format)
171
def get_workingtree_transport(self, workingtree_format):
173
return self._real_bzrdir.get_workingtree_transport(workingtree_format)
175
def can_convert_format(self):
176
"""Upgrading of remote bzrdirs is not supported yet."""
179
def needs_format_conversion(self, format=None):
180
"""Upgrading of remote bzrdirs is not supported yet."""
183
def clone(self, url, revision_id=None, force_new_repo=False):
185
return self._real_bzrdir.clone(url, revision_id=revision_id,
186
force_new_repo=force_new_repo)
189
class RemoteRepositoryFormat(repository.RepositoryFormat):
190
"""Format for repositories accessed over a _SmartClient.
192
Instances of this repository are represented by RemoteRepository
195
The RemoteRepositoryFormat is parameterised during construction
196
to reflect the capabilities of the real, remote format. Specifically
197
the attributes rich_root_data and supports_tree_reference are set
198
on a per instance basis, and are not set (and should not be) at
202
_matchingbzrdir = RemoteBzrDirFormat
204
def initialize(self, a_bzrdir, shared=False):
205
assert isinstance(a_bzrdir, RemoteBzrDir), \
206
'%r is not a RemoteBzrDir' % (a_bzrdir,)
207
return a_bzrdir.create_repository(shared=shared)
209
def open(self, a_bzrdir):
210
assert isinstance(a_bzrdir, RemoteBzrDir)
211
return a_bzrdir.open_repository()
213
def get_format_description(self):
214
return 'bzr remote repository'
216
def __eq__(self, other):
217
return self.__class__ == other.__class__
219
def check_conversion_target(self, target_format):
220
if self.rich_root_data and not target_format.rich_root_data:
221
raise errors.BadConversionTarget(
222
'Does not support rich root data.', target_format)
223
if (self.supports_tree_reference and
224
not getattr(target_format, 'supports_tree_reference', False)):
225
raise errors.BadConversionTarget(
226
'Does not support nested trees', target_format)
229
class RemoteRepository(object):
230
"""Repository accessed over rpc.
232
For the moment most operations are performed using local transport-backed
236
def __init__(self, remote_bzrdir, format, real_repository=None, _client=None):
237
"""Create a RemoteRepository instance.
239
:param remote_bzrdir: The bzrdir hosting this repository.
240
:param format: The RemoteFormat object to use.
241
:param real_repository: If not None, a local implementation of the
242
repository logic for the repository, usually accessing the data
244
:param _client: Private testing parameter - override the smart client
245
to be used by the repository.
248
self._real_repository = real_repository
250
self._real_repository = None
251
self.bzrdir = remote_bzrdir
253
self._client = client._SmartClient(self.bzrdir._shared_medium)
255
self._client = _client
256
self._format = format
257
self._lock_mode = None
258
self._lock_token = None
260
self._leave_lock = False
262
# These depend on the actual remote format, so force them off for
263
# maximum compatibility. XXX: In future these should depend on the
264
# remote repository instance, but this is irrelevant until we perform
265
# reconcile via an RPC call.
266
self._reconcile_does_inventory_gc = False
267
self._reconcile_fixes_text_parents = False
268
self._reconcile_backsup_inventory = False
269
self.base = self.bzrdir.transport.base
272
return "%s(%s)" % (self.__class__.__name__, self.base)
276
def abort_write_group(self):
277
"""Complete a write group on the decorated repository.
279
Smart methods peform operations in a single step so this api
280
is not really applicable except as a compatibility thunk
281
for older plugins that don't use e.g. the CommitBuilder
285
return self._real_repository.abort_write_group()
287
def commit_write_group(self):
288
"""Complete a write group on the decorated repository.
290
Smart methods peform operations in a single step so this api
291
is not really applicable except as a compatibility thunk
292
for older plugins that don't use e.g. the CommitBuilder
296
return self._real_repository.commit_write_group()
298
def _ensure_real(self):
299
"""Ensure that there is a _real_repository set.
301
Used before calls to self._real_repository.
303
if not self._real_repository:
304
self.bzrdir._ensure_real()
305
#self._real_repository = self.bzrdir._real_bzrdir.open_repository()
306
self._set_real_repository(self.bzrdir._real_bzrdir.open_repository())
308
def find_text_key_references(self):
309
"""Find the text key references within the repository.
311
:return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
312
revision_ids. Each altered file-ids has the exact revision_ids that
313
altered it listed explicitly.
314
:return: A dictionary mapping text keys ((fileid, revision_id) tuples)
315
to whether they were referred to by the inventory of the
316
revision_id that they contain. The inventory texts from all present
317
revision ids are assessed to generate this report.
320
return self._real_repository.find_text_key_references()
322
def _generate_text_key_index(self):
323
"""Generate a new text key index for the repository.
325
This is an expensive function that will take considerable time to run.
327
:return: A dict mapping (file_id, revision_id) tuples to a list of
328
parents, also (file_id, revision_id) tuples.
331
return self._real_repository._generate_text_key_index()
333
def get_revision_graph(self, revision_id=None):
334
"""See Repository.get_revision_graph()."""
335
if revision_id is None:
337
elif revision.is_null(revision_id):
340
path = self.bzrdir._path_for_remote_call(self._client)
341
assert type(revision_id) is str
342
response = self._client.call_expecting_body(
343
'Repository.get_revision_graph', path, revision_id)
344
if response[0][0] not in ['ok', 'nosuchrevision']:
345
raise errors.UnexpectedSmartServerResponse(response[0])
346
if response[0][0] == 'ok':
347
coded = response[1].read_body_bytes()
349
# no revisions in this repository!
351
lines = coded.split('\n')
354
d = tuple(line.split())
355
revision_graph[d[0]] = d[1:]
357
return revision_graph
359
response_body = response[1].read_body_bytes()
360
assert response_body == ''
361
raise NoSuchRevision(self, revision_id)
363
def has_revision(self, revision_id):
364
"""See Repository.has_revision()."""
365
if revision_id is None:
366
# The null revision is always present.
368
path = self.bzrdir._path_for_remote_call(self._client)
369
response = self._client.call('Repository.has_revision', path, revision_id)
370
assert response[0] in ('yes', 'no'), 'unexpected response code %s' % (response,)
371
return response[0] == 'yes'
373
def has_same_location(self, other):
374
return (self.__class__ == other.__class__ and
375
self.bzrdir.transport.base == other.bzrdir.transport.base)
377
def get_graph(self, other_repository=None):
378
"""Return the graph for this repository format"""
380
return self._real_repository.get_graph(other_repository)
382
def gather_stats(self, revid=None, committers=None):
383
"""See Repository.gather_stats()."""
384
path = self.bzrdir._path_for_remote_call(self._client)
385
# revid can be None to indicate no revisions, not just NULL_REVISION
386
if revid is None or revision.is_null(revid):
390
if committers is None or not committers:
391
fmt_committers = 'no'
393
fmt_committers = 'yes'
394
response = self._client.call_expecting_body(
395
'Repository.gather_stats', path, fmt_revid, fmt_committers)
396
assert response[0][0] == 'ok', \
397
'unexpected response code %s' % (response[0],)
399
body = response[1].read_body_bytes()
401
for line in body.split('\n'):
404
key, val_text = line.split(':')
405
if key in ('revisions', 'size', 'committers'):
406
result[key] = int(val_text)
407
elif key in ('firstrev', 'latestrev'):
408
values = val_text.split(' ')[1:]
409
result[key] = (float(values[0]), long(values[1]))
413
def get_physical_lock_status(self):
414
"""See Repository.get_physical_lock_status()."""
415
# should be an API call to the server.
417
return self._real_repository.get_physical_lock_status()
419
def is_in_write_group(self):
420
"""Return True if there is an open write group.
422
write groups are only applicable locally for the smart server..
424
if self._real_repository:
425
return self._real_repository.is_in_write_group()
428
return self._lock_count >= 1
431
"""See Repository.is_shared()."""
432
path = self.bzrdir._path_for_remote_call(self._client)
433
response = self._client.call('Repository.is_shared', path)
434
assert response[0] in ('yes', 'no'), 'unexpected response code %s' % (response,)
435
return response[0] == 'yes'
437
def is_write_locked(self):
438
return self._lock_mode == 'w'
441
# wrong eventually - want a local lock cache context
442
if not self._lock_mode:
443
self._lock_mode = 'r'
445
if self._real_repository is not None:
446
self._real_repository.lock_read()
448
self._lock_count += 1
450
def _remote_lock_write(self, token):
451
path = self.bzrdir._path_for_remote_call(self._client)
454
response = self._client.call('Repository.lock_write', path, token)
455
if response[0] == 'ok':
458
elif response[0] == 'LockContention':
459
raise errors.LockContention('(remote lock)')
460
elif response[0] == 'UnlockableTransport':
461
raise errors.UnlockableTransport(self.bzrdir.root_transport)
462
elif response[0] == 'LockFailed':
463
raise errors.LockFailed(response[1], response[2])
465
raise errors.UnexpectedSmartServerResponse(response)
467
def lock_write(self, token=None):
468
if not self._lock_mode:
469
self._lock_token = self._remote_lock_write(token)
470
# if self._lock_token is None, then this is something like packs or
471
# svn where we don't get to lock the repo, or a weave style repository
472
# where we cannot lock it over the wire and attempts to do so will
474
if self._real_repository is not None:
475
self._real_repository.lock_write(token=self._lock_token)
476
if token is not None:
477
self._leave_lock = True
479
self._leave_lock = False
480
self._lock_mode = 'w'
482
elif self._lock_mode == 'r':
483
raise errors.ReadOnlyError(self)
485
self._lock_count += 1
486
return self._lock_token or None
488
def leave_lock_in_place(self):
489
if not self._lock_token:
490
raise NotImplementedError(self.leave_lock_in_place)
491
self._leave_lock = True
493
def dont_leave_lock_in_place(self):
494
if not self._lock_token:
495
raise NotImplementedError(self.leave_lock_in_place)
496
self._leave_lock = False
498
def _set_real_repository(self, repository):
499
"""Set the _real_repository for this repository.
501
:param repository: The repository to fallback to for non-hpss
502
implemented operations.
504
assert not isinstance(repository, RemoteRepository)
505
self._real_repository = repository
506
if self._lock_mode == 'w':
507
# if we are already locked, the real repository must be able to
508
# acquire the lock with our token.
509
self._real_repository.lock_write(self._lock_token)
510
elif self._lock_mode == 'r':
511
self._real_repository.lock_read()
513
def start_write_group(self):
514
"""Start a write group on the decorated repository.
516
Smart methods peform operations in a single step so this api
517
is not really applicable except as a compatibility thunk
518
for older plugins that don't use e.g. the CommitBuilder
522
return self._real_repository.start_write_group()
524
def _unlock(self, token):
525
path = self.bzrdir._path_for_remote_call(self._client)
527
# with no token the remote repository is not persistently locked.
529
response = self._client.call('Repository.unlock', path, token)
530
if response == ('ok',):
532
elif response[0] == 'TokenMismatch':
533
raise errors.TokenMismatch(token, '(remote token)')
535
raise errors.UnexpectedSmartServerResponse(response)
538
self._lock_count -= 1
539
if self._lock_count > 0:
541
old_mode = self._lock_mode
542
self._lock_mode = None
544
# The real repository is responsible at present for raising an
545
# exception if it's in an unfinished write group. However, it
546
# normally will *not* actually remove the lock from disk - that's
547
# done by the server on receiving the Repository.unlock call.
548
# This is just to let the _real_repository stay up to date.
549
if self._real_repository is not None:
550
self._real_repository.unlock()
552
# The rpc-level lock should be released even if there was a
553
# problem releasing the vfs-based lock.
555
# Only write-locked repositories need to make a remote method
556
# call to perfom the unlock.
557
old_token = self._lock_token
558
self._lock_token = None
559
if not self._leave_lock:
560
self._unlock(old_token)
562
def break_lock(self):
563
# should hand off to the network
565
return self._real_repository.break_lock()
567
def _get_tarball(self, compression):
568
"""Return a TemporaryFile containing a repository tarball.
570
Returns None if the server does not support sending tarballs.
573
path = self.bzrdir._path_for_remote_call(self._client)
574
response, protocol = self._client.call_expecting_body(
575
'Repository.tarball', path, compression)
576
if response[0] == 'ok':
577
# Extract the tarball and return it
578
t = tempfile.NamedTemporaryFile()
579
# TODO: rpc layer should read directly into it...
580
t.write(protocol.read_body_bytes())
583
if (response == ('error', "Generic bzr smart protocol error: "
584
"bad request 'Repository.tarball'") or
585
response == ('error', "Generic bzr smart protocol error: "
586
"bad request u'Repository.tarball'")):
587
protocol.cancel_read_body()
589
raise errors.UnexpectedSmartServerResponse(response)
591
def sprout(self, to_bzrdir, revision_id=None):
592
# TODO: Option to control what format is created?
593
dest_repo = to_bzrdir.create_repository()
594
dest_repo.fetch(self, revision_id=revision_id)
597
### These methods are just thin shims to the VFS object for now.
599
def revision_tree(self, revision_id):
601
return self._real_repository.revision_tree(revision_id)
603
def get_serializer_format(self):
605
return self._real_repository.get_serializer_format()
607
def get_commit_builder(self, branch, parents, config, timestamp=None,
608
timezone=None, committer=None, revprops=None,
610
# FIXME: It ought to be possible to call this without immediately
611
# triggering _ensure_real. For now it's the easiest thing to do.
613
builder = self._real_repository.get_commit_builder(branch, parents,
614
config, timestamp=timestamp, timezone=timezone,
615
committer=committer, revprops=revprops, revision_id=revision_id)
616
## We used to do this for knits, so that invidual methods could be
617
## accelerated, but actually this was in hindsight a bad idea. Because
618
## really we do need the real repository to assemble the work it's own
620
## # Make the builder use this RemoteRepository rather than the real one.
621
## builder.repository = self
625
def add_inventory(self, revid, inv, parents):
627
return self._real_repository.add_inventory(revid, inv, parents)
630
def add_revision(self, rev_id, rev, inv=None, config=None):
632
return self._real_repository.add_revision(
633
rev_id, rev, inv=inv, config=config)
636
def get_inventory(self, revision_id):
638
return self._real_repository.get_inventory(revision_id)
641
def get_revision(self, revision_id):
643
return self._real_repository.get_revision(revision_id)
646
def weave_store(self):
648
return self._real_repository.weave_store
650
def get_transaction(self):
652
return self._real_repository.get_transaction()
655
def clone(self, a_bzrdir, revision_id=None):
657
return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
659
def make_working_trees(self):
660
"""RemoteRepositories never create working trees by default."""
663
def fetch(self, source, revision_id=None, pb=None):
664
if self.has_same_location(source):
665
# check that last_revision is in 'from' and then return a
667
if (revision_id is not None and
668
not revision.is_null(revision_id)):
669
self.get_revision(revision_id)
672
return self._real_repository.fetch(
673
source, revision_id=revision_id, pb=pb)
675
def create_bundle(self, target, base, fileobj, format=None):
677
self._real_repository.create_bundle(target, base, fileobj, format)
680
def control_weaves(self):
682
return self._real_repository.control_weaves
685
def get_ancestry(self, revision_id, topo_sorted=True):
687
return self._real_repository.get_ancestry(revision_id, topo_sorted)
690
def get_inventory_weave(self):
692
return self._real_repository.get_inventory_weave()
694
def fileids_altered_by_revision_ids(self, revision_ids):
696
return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
698
def get_versioned_file_checker(self, revisions, revision_versions_cache):
700
return self._real_repository.get_versioned_file_checker(
701
revisions, revision_versions_cache)
703
def iter_files_bytes(self, desired_files):
704
"""See Repository.iter_file_bytes.
707
return self._real_repository.iter_files_bytes(desired_files)
710
def get_signature_text(self, revision_id):
712
return self._real_repository.get_signature_text(revision_id)
715
def get_revision_graph_with_ghosts(self, revision_ids=None):
717
return self._real_repository.get_revision_graph_with_ghosts(
718
revision_ids=revision_ids)
721
def get_inventory_xml(self, revision_id):
723
return self._real_repository.get_inventory_xml(revision_id)
725
def deserialise_inventory(self, revision_id, xml):
727
return self._real_repository.deserialise_inventory(revision_id, xml)
729
def reconcile(self, other=None, thorough=False):
731
return self._real_repository.reconcile(other=other, thorough=thorough)
733
def all_revision_ids(self):
735
return self._real_repository.all_revision_ids()
738
def get_deltas_for_revisions(self, revisions):
740
return self._real_repository.get_deltas_for_revisions(revisions)
743
def get_revision_delta(self, revision_id):
745
return self._real_repository.get_revision_delta(revision_id)
748
def revision_trees(self, revision_ids):
750
return self._real_repository.revision_trees(revision_ids)
753
def get_revision_reconcile(self, revision_id):
755
return self._real_repository.get_revision_reconcile(revision_id)
758
def check(self, revision_ids=None):
760
return self._real_repository.check(revision_ids=revision_ids)
762
def copy_content_into(self, destination, revision_id=None):
764
return self._real_repository.copy_content_into(
765
destination, revision_id=revision_id)
767
def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
768
# get a tarball of the remote repository, and copy from that into the
770
from bzrlib import osutils
773
from StringIO import StringIO
774
# TODO: Maybe a progress bar while streaming the tarball?
775
note("Copying repository content as tarball...")
776
tar_file = self._get_tarball('bz2')
779
destination = to_bzrdir.create_repository()
781
tar = tarfile.open('repository', fileobj=tar_file,
783
tmpdir = tempfile.mkdtemp()
785
_extract_tar(tar, tmpdir)
786
tmp_bzrdir = BzrDir.open(tmpdir)
787
tmp_repo = tmp_bzrdir.open_repository()
788
tmp_repo.copy_content_into(destination, revision_id)
790
osutils.rmtree(tmpdir)
794
# TODO: Suggestion from john: using external tar is much faster than
795
# python's tarfile library, but it may not work on windows.
799
"""Compress the data within the repository.
801
This is not currently implemented within the smart server.
804
return self._real_repository.pack()
806
def set_make_working_trees(self, new_value):
807
raise NotImplementedError(self.set_make_working_trees)
810
def sign_revision(self, revision_id, gpg_strategy):
812
return self._real_repository.sign_revision(revision_id, gpg_strategy)
815
def get_revisions(self, revision_ids):
817
return self._real_repository.get_revisions(revision_ids)
819
def supports_rich_root(self):
821
return self._real_repository.supports_rich_root()
823
def iter_reverse_revision_history(self, revision_id):
825
return self._real_repository.iter_reverse_revision_history(revision_id)
828
def _serializer(self):
830
return self._real_repository._serializer
832
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
834
return self._real_repository.store_revision_signature(
835
gpg_strategy, plaintext, revision_id)
837
def add_signature_text(self, revision_id, signature):
839
return self._real_repository.add_signature_text(revision_id, signature)
841
def has_signature_for_revision_id(self, revision_id):
843
return self._real_repository.has_signature_for_revision_id(revision_id)
845
def get_data_stream(self, revision_ids):
846
path = self.bzrdir._path_for_remote_call(self._client)
847
response, protocol = self._client.call_expecting_body(
848
'Repository.stream_knit_data_for_revisions', path, *revision_ids)
849
if response == ('ok',):
850
return self._deserialise_stream(protocol)
851
elif (response == ('error', "Generic bzr smart protocol error: "
852
"bad request 'Repository.stream_knit_data_for_revisions'") or
853
response == ('error', "Generic bzr smart protocol error: "
854
"bad request u'Repository.stream_knit_data_for_revisions'")):
855
protocol.cancel_read_body()
857
return self._real_repository.get_data_stream(revision_ids)
859
raise errors.UnexpectedSmartServerResponse(response)
861
def _deserialise_stream(self, protocol):
862
buffer = StringIO(protocol.read_body_bytes())
863
reader = ContainerReader(buffer)
864
for record_names, read_bytes in reader.iter_records():
866
# These records should have only one name, and that name
867
# should be a one-element tuple.
868
[name_tuple] = record_names
870
raise errors.SmartProtocolError(
871
'Repository data stream had invalid record name %r'
873
yield name_tuple, read_bytes(None)
875
def insert_data_stream(self, stream):
877
self._real_repository.insert_data_stream(stream)
879
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
881
return self._real_repository.item_keys_introduced_by(revision_ids,
884
def revision_graph_can_have_wrong_parents(self):
885
# The answer depends on the remote repo format.
887
return self._real_repository.revision_graph_can_have_wrong_parents()
889
def _find_inconsistent_revision_parents(self):
891
return self._real_repository._find_inconsistent_revision_parents()
893
def _check_for_inconsistent_revision_parents(self):
895
return self._real_repository._check_for_inconsistent_revision_parents()
898
class RemoteBranchLockableFiles(LockableFiles):
899
"""A 'LockableFiles' implementation that talks to a smart server.
901
This is not a public interface class.
904
def __init__(self, bzrdir, _client):
906
self._client = _client
907
self._need_find_modes = True
908
LockableFiles.__init__(
909
self, bzrdir.get_branch_transport(None),
910
'lock', lockdir.LockDir)
912
def _find_modes(self):
913
# RemoteBranches don't let the client set the mode of control files.
914
self._dir_mode = None
915
self._file_mode = None
918
"""'get' a remote path as per the LockableFiles interface.
920
:param path: the file to 'get'. If this is 'branch.conf', we do not
921
just retrieve a file, instead we ask the smart server to generate
922
a configuration for us - which is retrieved as an INI file.
924
if path == 'branch.conf':
925
path = self.bzrdir._path_for_remote_call(self._client)
926
response = self._client.call_expecting_body(
927
'Branch.get_config_file', path)
928
assert response[0][0] == 'ok', \
929
'unexpected response code %s' % (response[0],)
930
return StringIO(response[1].read_body_bytes())
933
return LockableFiles.get(self, path)
936
class RemoteBranchFormat(branch.BranchFormat):
938
def __eq__(self, other):
939
return (isinstance(other, RemoteBranchFormat) and
940
self.__dict__ == other.__dict__)
942
def get_format_description(self):
943
return 'Remote BZR Branch'
945
def get_format_string(self):
946
return 'Remote BZR Branch'
948
def open(self, a_bzrdir):
949
assert isinstance(a_bzrdir, RemoteBzrDir)
950
return a_bzrdir.open_branch()
952
def initialize(self, a_bzrdir):
953
assert isinstance(a_bzrdir, RemoteBzrDir)
954
return a_bzrdir.create_branch()
956
def supports_tags(self):
957
# Remote branches might support tags, but we won't know until we
958
# access the real remote branch.
962
class RemoteBranch(branch.Branch):
963
"""Branch stored on a server accessed by HPSS RPC.
965
At the moment most operations are mapped down to simple file operations.
968
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
970
"""Create a RemoteBranch instance.
972
:param real_branch: An optional local implementation of the branch
973
format, usually accessing the data via the VFS.
974
:param _client: Private parameter for testing.
976
# We intentionally don't call the parent class's __init__, because it
977
# will try to assign to self.tags, which is a property in this subclass.
978
# And the parent's __init__ doesn't do much anyway.
979
self._revision_id_to_revno_cache = None
980
self._revision_history_cache = None
981
self.bzrdir = remote_bzrdir
982
if _client is not None:
983
self._client = _client
985
self._client = client._SmartClient(self.bzrdir._shared_medium)
986
self.repository = remote_repository
987
if real_branch is not None:
988
self._real_branch = real_branch
989
# Give the remote repository the matching real repo.
990
real_repo = self._real_branch.repository
991
if isinstance(real_repo, RemoteRepository):
992
real_repo._ensure_real()
993
real_repo = real_repo._real_repository
994
self.repository._set_real_repository(real_repo)
995
# Give the branch the remote repository to let fast-pathing happen.
996
self._real_branch.repository = self.repository
998
self._real_branch = None
999
# Fill out expected attributes of branch for bzrlib api users.
1000
self._format = RemoteBranchFormat()
1001
self.base = self.bzrdir.root_transport.base
1002
self._control_files = None
1003
self._lock_mode = None
1004
self._lock_token = None
1005
self._lock_count = 0
1006
self._leave_lock = False
1009
return "%s(%s)" % (self.__class__.__name__, self.base)
1013
def _ensure_real(self):
1014
"""Ensure that there is a _real_branch set.
1016
Used before calls to self._real_branch.
1018
if not self._real_branch:
1019
assert vfs.vfs_enabled()
1020
self.bzrdir._ensure_real()
1021
self._real_branch = self.bzrdir._real_bzrdir.open_branch()
1022
# Give the remote repository the matching real repo.
1023
real_repo = self._real_branch.repository
1024
if isinstance(real_repo, RemoteRepository):
1025
real_repo._ensure_real()
1026
real_repo = real_repo._real_repository
1027
self.repository._set_real_repository(real_repo)
1028
# Give the branch the remote repository to let fast-pathing happen.
1029
self._real_branch.repository = self.repository
1030
# XXX: deal with _lock_mode == 'w'
1031
if self._lock_mode == 'r':
1032
self._real_branch.lock_read()
1035
def control_files(self):
1036
# Defer actually creating RemoteBranchLockableFiles until its needed,
1037
# because it triggers an _ensure_real that we otherwise might not need.
1038
if self._control_files is None:
1039
self._control_files = RemoteBranchLockableFiles(
1040
self.bzrdir, self._client)
1041
return self._control_files
1043
def _get_checkout_format(self):
1045
return self._real_branch._get_checkout_format()
1047
def get_physical_lock_status(self):
1048
"""See Branch.get_physical_lock_status()."""
1049
# should be an API call to the server, as branches must be lockable.
1051
return self._real_branch.get_physical_lock_status()
1053
def lock_read(self):
1054
if not self._lock_mode:
1055
self._lock_mode = 'r'
1056
self._lock_count = 1
1057
if self._real_branch is not None:
1058
self._real_branch.lock_read()
1060
self._lock_count += 1
1062
def _remote_lock_write(self, token):
1064
branch_token = repo_token = ''
1066
branch_token = token
1067
repo_token = self.repository.lock_write()
1068
self.repository.unlock()
1069
path = self.bzrdir._path_for_remote_call(self._client)
1070
response = self._client.call('Branch.lock_write', path, branch_token,
1072
if response[0] == 'ok':
1073
ok, branch_token, repo_token = response
1074
return branch_token, repo_token
1075
elif response[0] == 'LockContention':
1076
raise errors.LockContention('(remote lock)')
1077
elif response[0] == 'TokenMismatch':
1078
raise errors.TokenMismatch(token, '(remote token)')
1079
elif response[0] == 'UnlockableTransport':
1080
raise errors.UnlockableTransport(self.bzrdir.root_transport)
1081
elif response[0] == 'ReadOnlyError':
1082
raise errors.ReadOnlyError(self)
1083
elif response[0] == 'LockFailed':
1084
raise errors.LockFailed(response[1], response[2])
1086
raise errors.UnexpectedSmartServerResponse(response)
1088
def lock_write(self, token=None):
1089
if not self._lock_mode:
1090
remote_tokens = self._remote_lock_write(token)
1091
self._lock_token, self._repo_lock_token = remote_tokens
1092
assert self._lock_token, 'Remote server did not return a token!'
1093
# TODO: We really, really, really don't want to call _ensure_real
1094
# here, but it's the easiest way to ensure coherency between the
1095
# state of the RemoteBranch and RemoteRepository objects and the
1096
# physical locks. If we don't materialise the real objects here,
1097
# then getting everything in the right state later is complex, so
1098
# for now we just do it the lazy way.
1099
# -- Andrew Bennetts, 2007-02-22.
1101
if self._real_branch is not None:
1102
self._real_branch.repository.lock_write(
1103
token=self._repo_lock_token)
1105
self._real_branch.lock_write(token=self._lock_token)
1107
self._real_branch.repository.unlock()
1108
if token is not None:
1109
self._leave_lock = True
1111
# XXX: this case seems to be unreachable; token cannot be None.
1112
self._leave_lock = False
1113
self._lock_mode = 'w'
1114
self._lock_count = 1
1115
elif self._lock_mode == 'r':
1116
raise errors.ReadOnlyTransaction
1118
if token is not None:
1119
# A token was given to lock_write, and we're relocking, so check
1120
# that the given token actually matches the one we already have.
1121
if token != self._lock_token:
1122
raise errors.TokenMismatch(token, self._lock_token)
1123
self._lock_count += 1
1124
return self._lock_token or None
1126
def _unlock(self, branch_token, repo_token):
1127
path = self.bzrdir._path_for_remote_call(self._client)
1128
response = self._client.call('Branch.unlock', path, branch_token,
1130
if response == ('ok',):
1132
elif response[0] == 'TokenMismatch':
1133
raise errors.TokenMismatch(
1134
str((branch_token, repo_token)), '(remote tokens)')
1136
raise errors.UnexpectedSmartServerResponse(response)
1139
self._lock_count -= 1
1140
if not self._lock_count:
1141
self._clear_cached_state()
1142
mode = self._lock_mode
1143
self._lock_mode = None
1144
if self._real_branch is not None:
1145
if (not self._leave_lock and mode == 'w' and
1146
self._repo_lock_token):
1147
# If this RemoteBranch will remove the physical lock for the
1148
# repository, make sure the _real_branch doesn't do it
1149
# first. (Because the _real_branch's repository is set to
1150
# be the RemoteRepository.)
1151
self._real_branch.repository.leave_lock_in_place()
1152
self._real_branch.unlock()
1154
# Only write-locked branched need to make a remote method call
1155
# to perfom the unlock.
1157
assert self._lock_token, 'Locked, but no token!'
1158
branch_token = self._lock_token
1159
repo_token = self._repo_lock_token
1160
self._lock_token = None
1161
self._repo_lock_token = None
1162
if not self._leave_lock:
1163
self._unlock(branch_token, repo_token)
1165
def break_lock(self):
1167
return self._real_branch.break_lock()
1169
def leave_lock_in_place(self):
1170
if not self._lock_token:
1171
raise NotImplementedError(self.leave_lock_in_place)
1172
self._leave_lock = True
1174
def dont_leave_lock_in_place(self):
1175
if not self._lock_token:
1176
raise NotImplementedError(self.leave_lock_in_place)
1177
self._leave_lock = False
1179
def last_revision_info(self):
1180
"""See Branch.last_revision_info()."""
1181
path = self.bzrdir._path_for_remote_call(self._client)
1182
response = self._client.call('Branch.last_revision_info', path)
1183
assert response[0] == 'ok', 'unexpected response code %s' % (response,)
1184
revno = int(response[1])
1185
last_revision = response[2]
1186
return (revno, last_revision)
1188
def _gen_revision_history(self):
1189
"""See Branch._gen_revision_history()."""
1190
path = self.bzrdir._path_for_remote_call(self._client)
1191
response = self._client.call_expecting_body(
1192
'Branch.revision_history', path)
1193
assert response[0][0] == 'ok', ('unexpected response code %s'
1195
result = response[1].read_body_bytes().split('\x00')
1201
def set_revision_history(self, rev_history):
1202
# Send just the tip revision of the history; the server will generate
1203
# the full history from that. If the revision doesn't exist in this
1204
# branch, NoSuchRevision will be raised.
1205
path = self.bzrdir._path_for_remote_call(self._client)
1206
if rev_history == []:
1209
rev_id = rev_history[-1]
1210
self._clear_cached_state()
1211
response = self._client.call('Branch.set_last_revision',
1212
path, self._lock_token, self._repo_lock_token, rev_id)
1213
if response[0] == 'NoSuchRevision':
1214
raise NoSuchRevision(self, rev_id)
1216
assert response == ('ok',), (
1217
'unexpected response code %r' % (response,))
1218
self._cache_revision_history(rev_history)
1220
def get_parent(self):
1222
return self._real_branch.get_parent()
1224
def set_parent(self, url):
1226
return self._real_branch.set_parent(url)
1228
def get_config(self):
1229
return RemoteBranchConfig(self)
1231
def sprout(self, to_bzrdir, revision_id=None):
1232
# Like Branch.sprout, except that it sprouts a branch in the default
1233
# format, because RemoteBranches can't be created at arbitrary URLs.
1234
# XXX: if to_bzrdir is a RemoteBranch, this should perhaps do
1235
# to_bzrdir.create_branch...
1236
result = branch.BranchFormat.get_default_format().initialize(to_bzrdir)
1237
self.copy_content_into(result, revision_id=revision_id)
1238
result.set_parent(self.bzrdir.root_transport.base)
1242
def pull(self, source, overwrite=False, stop_revision=None,
1244
# FIXME: This asks the real branch to run the hooks, which means
1245
# they're called with the wrong target branch parameter.
1246
# The test suite specifically allows this at present but it should be
1247
# fixed. It should get a _override_hook_target branch,
1248
# as push does. -- mbp 20070405
1250
self._real_branch.pull(
1251
source, overwrite=overwrite, stop_revision=stop_revision,
1255
def push(self, target, overwrite=False, stop_revision=None):
1257
return self._real_branch.push(
1258
target, overwrite=overwrite, stop_revision=stop_revision,
1259
_override_hook_source_branch=self)
1261
def is_locked(self):
1262
return self._lock_count >= 1
1264
def set_last_revision_info(self, revno, revision_id):
1266
self._clear_cached_state()
1267
return self._real_branch.set_last_revision_info(revno, revision_id)
1269
def generate_revision_history(self, revision_id, last_rev=None,
1272
return self._real_branch.generate_revision_history(
1273
revision_id, last_rev=last_rev, other_branch=other_branch)
1278
return self._real_branch.tags
1280
def set_push_location(self, location):
1282
return self._real_branch.set_push_location(location)
1284
def update_revisions(self, other, stop_revision=None):
1286
return self._real_branch.update_revisions(
1287
other, stop_revision=stop_revision)
1290
class RemoteBranchConfig(BranchConfig):
1293
self.branch._ensure_real()
1294
return self.branch._real_branch.get_config().username()
1296
def _get_branch_data_config(self):
1297
self.branch._ensure_real()
1298
if self._branch_data_config is None:
1299
self._branch_data_config = TreeConfig(self.branch._real_branch)
1300
return self._branch_data_config
1303
def _extract_tar(tar, to_dir):
1304
"""Extract all the contents of a tarfile object.
1306
A replacement for extractall, which is not present in python2.4
1309
tar.extract(tarinfo, to_dir)
added
removed
bzrlib/remote.py
