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()."""
417
def is_in_write_group(self):
418
"""Return True if there is an open write group.
420
write groups are only applicable locally for the smart server..
422
if self._real_repository:
423
return self._real_repository.is_in_write_group()
426
return self._lock_count >= 1
429
"""See Repository.is_shared()."""
430
path = self.bzrdir._path_for_remote_call(self._client)
431
response = self._client.call('Repository.is_shared', path)
432
assert response[0] in ('yes', 'no'), 'unexpected response code %s' % (response,)
433
return response[0] == 'yes'
435
def is_write_locked(self):
436
return self._lock_mode == 'w'
439
# wrong eventually - want a local lock cache context
440
if not self._lock_mode:
441
self._lock_mode = 'r'
443
if self._real_repository is not None:
444
self._real_repository.lock_read()
446
self._lock_count += 1
448
def _remote_lock_write(self, token):
449
path = self.bzrdir._path_for_remote_call(self._client)
452
response = self._client.call('Repository.lock_write', path, token)
453
if response[0] == 'ok':
456
elif response[0] == 'LockContention':
457
raise errors.LockContention('(remote lock)')
458
elif response[0] == 'UnlockableTransport':
459
raise errors.UnlockableTransport(self.bzrdir.root_transport)
460
elif response[0] == 'LockFailed':
461
raise errors.LockFailed(response[1], response[2])
463
raise errors.UnexpectedSmartServerResponse(response)
465
def lock_write(self, token=None):
466
if not self._lock_mode:
467
self._lock_token = self._remote_lock_write(token)
468
assert self._lock_token, 'Remote server did not return a token!'
469
if self._real_repository is not None:
470
self._real_repository.lock_write(token=self._lock_token)
471
if token is not None:
472
self._leave_lock = True
474
self._leave_lock = False
475
self._lock_mode = 'w'
477
elif self._lock_mode == 'r':
478
raise errors.ReadOnlyError(self)
480
self._lock_count += 1
481
return self._lock_token
483
def leave_lock_in_place(self):
484
self._leave_lock = True
486
def dont_leave_lock_in_place(self):
487
self._leave_lock = False
489
def _set_real_repository(self, repository):
490
"""Set the _real_repository for this repository.
492
:param repository: The repository to fallback to for non-hpss
493
implemented operations.
495
assert not isinstance(repository, RemoteRepository)
496
self._real_repository = repository
497
if self._lock_mode == 'w':
498
# if we are already locked, the real repository must be able to
499
# acquire the lock with our token.
500
self._real_repository.lock_write(self._lock_token)
501
elif self._lock_mode == 'r':
502
self._real_repository.lock_read()
504
def start_write_group(self):
505
"""Start a write group on the decorated repository.
507
Smart methods peform operations in a single step so this api
508
is not really applicable except as a compatibility thunk
509
for older plugins that don't use e.g. the CommitBuilder
513
return self._real_repository.start_write_group()
515
def _unlock(self, token):
516
path = self.bzrdir._path_for_remote_call(self._client)
517
response = self._client.call('Repository.unlock', path, token)
518
if response == ('ok',):
520
elif response[0] == 'TokenMismatch':
521
raise errors.TokenMismatch(token, '(remote token)')
523
raise errors.UnexpectedSmartServerResponse(response)
526
self._lock_count -= 1
527
if self._lock_count > 0:
529
old_mode = self._lock_mode
530
self._lock_mode = None
532
# The real repository is responsible at present for raising an
533
# exception if it's in an unfinished write group. However, it
534
# normally will *not* actually remove the lock from disk - that's
535
# done by the server on receiving the Repository.unlock call.
536
# This is just to let the _real_repository stay up to date.
537
if self._real_repository is not None:
538
self._real_repository.unlock()
540
# The rpc-level lock should be released even if there was a
541
# problem releasing the vfs-based lock.
543
# Only write-locked repositories need to make a remote method
544
# call to perfom the unlock.
545
assert self._lock_token, \
546
'%s is locked, but has no token' \
548
old_token = self._lock_token
549
self._lock_token = None
550
if not self._leave_lock:
551
self._unlock(old_token)
553
def break_lock(self):
554
# should hand off to the network
556
return self._real_repository.break_lock()
558
def _get_tarball(self, compression):
559
"""Return a TemporaryFile containing a repository tarball.
561
Returns None if the server does not support sending tarballs.
564
path = self.bzrdir._path_for_remote_call(self._client)
565
response, protocol = self._client.call_expecting_body(
566
'Repository.tarball', path, compression)
567
if response[0] == 'ok':
568
# Extract the tarball and return it
569
t = tempfile.NamedTemporaryFile()
570
# TODO: rpc layer should read directly into it...
571
t.write(protocol.read_body_bytes())
574
if (response == ('error', "Generic bzr smart protocol error: "
575
"bad request 'Repository.tarball'") or
576
response == ('error', "Generic bzr smart protocol error: "
577
"bad request u'Repository.tarball'")):
578
protocol.cancel_read_body()
580
raise errors.UnexpectedSmartServerResponse(response)
582
def sprout(self, to_bzrdir, revision_id=None):
583
# TODO: Option to control what format is created?
584
dest_repo = to_bzrdir.create_repository()
585
dest_repo.fetch(self, revision_id=revision_id)
588
### These methods are just thin shims to the VFS object for now.
590
def revision_tree(self, revision_id):
592
return self._real_repository.revision_tree(revision_id)
594
def get_serializer_format(self):
596
return self._real_repository.get_serializer_format()
598
def get_commit_builder(self, branch, parents, config, timestamp=None,
599
timezone=None, committer=None, revprops=None,
601
# FIXME: It ought to be possible to call this without immediately
602
# triggering _ensure_real. For now it's the easiest thing to do.
604
builder = self._real_repository.get_commit_builder(branch, parents,
605
config, timestamp=timestamp, timezone=timezone,
606
committer=committer, revprops=revprops, revision_id=revision_id)
607
# Make the builder use this RemoteRepository rather than the real one.
608
builder.repository = self
612
def add_inventory(self, revid, inv, parents):
614
return self._real_repository.add_inventory(revid, inv, parents)
617
def add_revision(self, rev_id, rev, inv=None, config=None):
619
return self._real_repository.add_revision(
620
rev_id, rev, inv=inv, config=config)
623
def get_inventory(self, revision_id):
625
return self._real_repository.get_inventory(revision_id)
628
def get_revision(self, revision_id):
630
return self._real_repository.get_revision(revision_id)
633
def weave_store(self):
635
return self._real_repository.weave_store
637
def get_transaction(self):
639
return self._real_repository.get_transaction()
642
def clone(self, a_bzrdir, revision_id=None):
644
return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
646
def make_working_trees(self):
647
"""RemoteRepositories never create working trees by default."""
650
def fetch(self, source, revision_id=None, pb=None):
651
if self.has_same_location(source):
652
# check that last_revision is in 'from' and then return a
654
if (revision_id is not None and
655
not revision.is_null(revision_id)):
656
self.get_revision(revision_id)
659
return self._real_repository.fetch(
660
source, revision_id=revision_id, pb=pb)
662
def create_bundle(self, target, base, fileobj, format=None):
664
self._real_repository.create_bundle(target, base, fileobj, format)
667
def control_weaves(self):
669
return self._real_repository.control_weaves
672
def get_ancestry(self, revision_id, topo_sorted=True):
674
return self._real_repository.get_ancestry(revision_id, topo_sorted)
677
def get_inventory_weave(self):
679
return self._real_repository.get_inventory_weave()
681
def fileids_altered_by_revision_ids(self, revision_ids):
683
return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
685
def get_versioned_file_checker(self, revisions, revision_versions_cache):
687
return self._real_repository.get_versioned_file_checker(
688
revisions, revision_versions_cache)
690
def iter_files_bytes(self, desired_files):
691
"""See Repository.iter_file_bytes.
694
return self._real_repository.iter_files_bytes(desired_files)
697
def get_signature_text(self, revision_id):
699
return self._real_repository.get_signature_text(revision_id)
702
def get_revision_graph_with_ghosts(self, revision_ids=None):
704
return self._real_repository.get_revision_graph_with_ghosts(
705
revision_ids=revision_ids)
708
def get_inventory_xml(self, revision_id):
710
return self._real_repository.get_inventory_xml(revision_id)
712
def deserialise_inventory(self, revision_id, xml):
714
return self._real_repository.deserialise_inventory(revision_id, xml)
716
def reconcile(self, other=None, thorough=False):
718
return self._real_repository.reconcile(other=other, thorough=thorough)
720
def all_revision_ids(self):
722
return self._real_repository.all_revision_ids()
725
def get_deltas_for_revisions(self, revisions):
727
return self._real_repository.get_deltas_for_revisions(revisions)
730
def get_revision_delta(self, revision_id):
732
return self._real_repository.get_revision_delta(revision_id)
735
def revision_trees(self, revision_ids):
737
return self._real_repository.revision_trees(revision_ids)
740
def get_revision_reconcile(self, revision_id):
742
return self._real_repository.get_revision_reconcile(revision_id)
745
def check(self, revision_ids=None):
747
return self._real_repository.check(revision_ids=revision_ids)
749
def copy_content_into(self, destination, revision_id=None):
751
return self._real_repository.copy_content_into(
752
destination, revision_id=revision_id)
754
def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
755
# get a tarball of the remote repository, and copy from that into the
757
from bzrlib import osutils
760
from StringIO import StringIO
761
# TODO: Maybe a progress bar while streaming the tarball?
762
note("Copying repository content as tarball...")
763
tar_file = self._get_tarball('bz2')
766
destination = to_bzrdir.create_repository()
768
tar = tarfile.open('repository', fileobj=tar_file,
770
tmpdir = tempfile.mkdtemp()
772
_extract_tar(tar, tmpdir)
773
tmp_bzrdir = BzrDir.open(tmpdir)
774
tmp_repo = tmp_bzrdir.open_repository()
775
tmp_repo.copy_content_into(destination, revision_id)
777
osutils.rmtree(tmpdir)
781
# TODO: Suggestion from john: using external tar is much faster than
782
# python's tarfile library, but it may not work on windows.
786
"""Compress the data within the repository.
788
This is not currently implemented within the smart server.
791
return self._real_repository.pack()
793
def set_make_working_trees(self, new_value):
794
raise NotImplementedError(self.set_make_working_trees)
797
def sign_revision(self, revision_id, gpg_strategy):
799
return self._real_repository.sign_revision(revision_id, gpg_strategy)
802
def get_revisions(self, revision_ids):
804
return self._real_repository.get_revisions(revision_ids)
806
def supports_rich_root(self):
808
return self._real_repository.supports_rich_root()
810
def iter_reverse_revision_history(self, revision_id):
812
return self._real_repository.iter_reverse_revision_history(revision_id)
815
def _serializer(self):
817
return self._real_repository._serializer
819
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
821
return self._real_repository.store_revision_signature(
822
gpg_strategy, plaintext, revision_id)
824
def add_signature_text(self, revision_id, signature):
826
return self._real_repository.add_signature_text(revision_id, signature)
828
def has_signature_for_revision_id(self, revision_id):
830
return self._real_repository.has_signature_for_revision_id(revision_id)
832
def get_data_stream(self, revision_ids):
833
path = self.bzrdir._path_for_remote_call(self._client)
834
response, protocol = self._client.call_expecting_body(
835
'Repository.stream_knit_data_for_revisions', path, *revision_ids)
836
if response == ('ok',):
837
return self._deserialise_stream(protocol)
838
elif (response == ('error', "Generic bzr smart protocol error: "
839
"bad request 'Repository.stream_knit_data_for_revisions'") or
840
response == ('error', "Generic bzr smart protocol error: "
841
"bad request u'Repository.stream_knit_data_for_revisions'")):
842
protocol.cancel_read_body()
844
return self._real_repository.get_data_stream(revision_ids)
846
raise errors.UnexpectedSmartServerResponse(response)
848
def _deserialise_stream(self, protocol):
849
buffer = StringIO(protocol.read_body_bytes())
850
reader = ContainerReader(buffer)
851
for record_names, read_bytes in reader.iter_records():
853
# These records should have only one name, and that name
854
# should be a one-element tuple.
855
[name_tuple] = record_names
857
raise errors.SmartProtocolError(
858
'Repository data stream had invalid record name %r'
860
yield name_tuple, read_bytes(None)
862
def insert_data_stream(self, stream):
864
self._real_repository.insert_data_stream(stream)
866
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
868
return self._real_repository.item_keys_introduced_by(revision_ids,
871
def revision_graph_can_have_wrong_parents(self):
872
# The answer depends on the remote repo format.
874
return self._real_repository.revision_graph_can_have_wrong_parents()
876
def _find_inconsistent_revision_parents(self):
878
return self._real_repository._find_inconsistent_revision_parents()
880
def _check_for_inconsistent_revision_parents(self):
882
return self._real_repository._check_for_inconsistent_revision_parents()
885
class RemoteBranchLockableFiles(LockableFiles):
886
"""A 'LockableFiles' implementation that talks to a smart server.
888
This is not a public interface class.
891
def __init__(self, bzrdir, _client):
893
self._client = _client
894
self._need_find_modes = True
895
LockableFiles.__init__(
896
self, bzrdir.get_branch_transport(None),
897
'lock', lockdir.LockDir)
899
def _find_modes(self):
900
# RemoteBranches don't let the client set the mode of control files.
901
self._dir_mode = None
902
self._file_mode = None
905
"""'get' a remote path as per the LockableFiles interface.
907
:param path: the file to 'get'. If this is 'branch.conf', we do not
908
just retrieve a file, instead we ask the smart server to generate
909
a configuration for us - which is retrieved as an INI file.
911
if path == 'branch.conf':
912
path = self.bzrdir._path_for_remote_call(self._client)
913
response = self._client.call_expecting_body(
914
'Branch.get_config_file', path)
915
assert response[0][0] == 'ok', \
916
'unexpected response code %s' % (response[0],)
917
return StringIO(response[1].read_body_bytes())
920
return LockableFiles.get(self, path)
923
class RemoteBranchFormat(branch.BranchFormat):
925
def __eq__(self, other):
926
return (isinstance(other, RemoteBranchFormat) and
927
self.__dict__ == other.__dict__)
929
def get_format_description(self):
930
return 'Remote BZR Branch'
932
def get_format_string(self):
933
return 'Remote BZR Branch'
935
def open(self, a_bzrdir):
936
assert isinstance(a_bzrdir, RemoteBzrDir)
937
return a_bzrdir.open_branch()
939
def initialize(self, a_bzrdir):
940
assert isinstance(a_bzrdir, RemoteBzrDir)
941
return a_bzrdir.create_branch()
943
def supports_tags(self):
944
# Remote branches might support tags, but we won't know until we
945
# access the real remote branch.
949
class RemoteBranch(branch.Branch):
950
"""Branch stored on a server accessed by HPSS RPC.
952
At the moment most operations are mapped down to simple file operations.
955
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
957
"""Create a RemoteBranch instance.
959
:param real_branch: An optional local implementation of the branch
960
format, usually accessing the data via the VFS.
961
:param _client: Private parameter for testing.
963
# We intentionally don't call the parent class's __init__, because it
964
# will try to assign to self.tags, which is a property in this subclass.
965
# And the parent's __init__ doesn't do much anyway.
966
self._revision_id_to_revno_cache = None
967
self._revision_history_cache = None
968
self.bzrdir = remote_bzrdir
969
if _client is not None:
970
self._client = _client
972
self._client = client._SmartClient(self.bzrdir._shared_medium)
973
self.repository = remote_repository
974
if real_branch is not None:
975
self._real_branch = real_branch
976
# Give the remote repository the matching real repo.
977
real_repo = self._real_branch.repository
978
if isinstance(real_repo, RemoteRepository):
979
real_repo._ensure_real()
980
real_repo = real_repo._real_repository
981
self.repository._set_real_repository(real_repo)
982
# Give the branch the remote repository to let fast-pathing happen.
983
self._real_branch.repository = self.repository
985
self._real_branch = None
986
# Fill out expected attributes of branch for bzrlib api users.
987
self._format = RemoteBranchFormat()
988
self.base = self.bzrdir.root_transport.base
989
self._control_files = None
990
self._lock_mode = None
991
self._lock_token = None
993
self._leave_lock = False
996
return "%s(%s)" % (self.__class__.__name__, self.base)
1000
def _ensure_real(self):
1001
"""Ensure that there is a _real_branch set.
1003
Used before calls to self._real_branch.
1005
if not self._real_branch:
1006
assert vfs.vfs_enabled()
1007
self.bzrdir._ensure_real()
1008
self._real_branch = self.bzrdir._real_bzrdir.open_branch()
1009
# Give the remote repository the matching real repo.
1010
real_repo = self._real_branch.repository
1011
if isinstance(real_repo, RemoteRepository):
1012
real_repo._ensure_real()
1013
real_repo = real_repo._real_repository
1014
self.repository._set_real_repository(real_repo)
1015
# Give the branch the remote repository to let fast-pathing happen.
1016
self._real_branch.repository = self.repository
1017
# XXX: deal with _lock_mode == 'w'
1018
if self._lock_mode == 'r':
1019
self._real_branch.lock_read()
1022
def control_files(self):
1023
# Defer actually creating RemoteBranchLockableFiles until its needed,
1024
# because it triggers an _ensure_real that we otherwise might not need.
1025
if self._control_files is None:
1026
self._control_files = RemoteBranchLockableFiles(
1027
self.bzrdir, self._client)
1028
return self._control_files
1030
def _get_checkout_format(self):
1032
return self._real_branch._get_checkout_format()
1034
def get_physical_lock_status(self):
1035
"""See Branch.get_physical_lock_status()."""
1036
# should be an API call to the server, as branches must be lockable.
1038
return self._real_branch.get_physical_lock_status()
1040
def lock_read(self):
1041
if not self._lock_mode:
1042
self._lock_mode = 'r'
1043
self._lock_count = 1
1044
if self._real_branch is not None:
1045
self._real_branch.lock_read()
1047
self._lock_count += 1
1049
def _remote_lock_write(self, token):
1051
branch_token = repo_token = ''
1053
branch_token = token
1054
repo_token = self.repository.lock_write()
1055
self.repository.unlock()
1056
path = self.bzrdir._path_for_remote_call(self._client)
1057
response = self._client.call('Branch.lock_write', path, branch_token,
1059
if response[0] == 'ok':
1060
ok, branch_token, repo_token = response
1061
return branch_token, repo_token
1062
elif response[0] == 'LockContention':
1063
raise errors.LockContention('(remote lock)')
1064
elif response[0] == 'TokenMismatch':
1065
raise errors.TokenMismatch(token, '(remote token)')
1066
elif response[0] == 'UnlockableTransport':
1067
raise errors.UnlockableTransport(self.bzrdir.root_transport)
1068
elif response[0] == 'ReadOnlyError':
1069
raise errors.ReadOnlyError(self)
1070
elif response[0] == 'LockFailed':
1071
raise errors.LockFailed(response[1], response[2])
1073
raise errors.UnexpectedSmartServerResponse(response)
1075
def lock_write(self, token=None):
1076
if not self._lock_mode:
1077
remote_tokens = self._remote_lock_write(token)
1078
self._lock_token, self._repo_lock_token = remote_tokens
1079
assert self._lock_token, 'Remote server did not return a token!'
1080
# TODO: We really, really, really don't want to call _ensure_real
1081
# here, but it's the easiest way to ensure coherency between the
1082
# state of the RemoteBranch and RemoteRepository objects and the
1083
# physical locks. If we don't materialise the real objects here,
1084
# then getting everything in the right state later is complex, so
1085
# for now we just do it the lazy way.
1086
# -- Andrew Bennetts, 2007-02-22.
1088
if self._real_branch is not None:
1089
self._real_branch.repository.lock_write(
1090
token=self._repo_lock_token)
1092
self._real_branch.lock_write(token=self._lock_token)
1094
self._real_branch.repository.unlock()
1095
if token is not None:
1096
self._leave_lock = True
1098
# XXX: this case seems to be unreachable; token cannot be None.
1099
self._leave_lock = False
1100
self._lock_mode = 'w'
1101
self._lock_count = 1
1102
elif self._lock_mode == 'r':
1103
raise errors.ReadOnlyTransaction
1105
if token is not None:
1106
# A token was given to lock_write, and we're relocking, so check
1107
# that the given token actually matches the one we already have.
1108
if token != self._lock_token:
1109
raise errors.TokenMismatch(token, self._lock_token)
1110
self._lock_count += 1
1111
return self._lock_token
1113
def _unlock(self, branch_token, repo_token):
1114
path = self.bzrdir._path_for_remote_call(self._client)
1115
response = self._client.call('Branch.unlock', path, branch_token,
1117
if response == ('ok',):
1119
elif response[0] == 'TokenMismatch':
1120
raise errors.TokenMismatch(
1121
str((branch_token, repo_token)), '(remote tokens)')
1123
raise errors.UnexpectedSmartServerResponse(response)
1126
self._lock_count -= 1
1127
if not self._lock_count:
1128
self._clear_cached_state()
1129
mode = self._lock_mode
1130
self._lock_mode = None
1131
if self._real_branch is not None:
1132
if not self._leave_lock:
1133
# If this RemoteBranch will remove the physical lock for the
1134
# repository, make sure the _real_branch doesn't do it
1135
# first. (Because the _real_branch's repository is set to
1136
# be the RemoteRepository.)
1137
self._real_branch.repository.leave_lock_in_place()
1138
self._real_branch.unlock()
1140
# Only write-locked branched need to make a remote method call
1141
# to perfom the unlock.
1143
assert self._lock_token, 'Locked, but no token!'
1144
branch_token = self._lock_token
1145
repo_token = self._repo_lock_token
1146
self._lock_token = None
1147
self._repo_lock_token = None
1148
if not self._leave_lock:
1149
self._unlock(branch_token, repo_token)
1151
def break_lock(self):
1153
return self._real_branch.break_lock()
1155
def leave_lock_in_place(self):
1156
self._leave_lock = True
1158
def dont_leave_lock_in_place(self):
1159
self._leave_lock = False
1161
def last_revision_info(self):
1162
"""See Branch.last_revision_info()."""
1163
path = self.bzrdir._path_for_remote_call(self._client)
1164
response = self._client.call('Branch.last_revision_info', path)
1165
assert response[0] == 'ok', 'unexpected response code %s' % (response,)
1166
revno = int(response[1])
1167
last_revision = response[2]
1168
return (revno, last_revision)
1170
def _gen_revision_history(self):
1171
"""See Branch._gen_revision_history()."""
1172
path = self.bzrdir._path_for_remote_call(self._client)
1173
response = self._client.call_expecting_body(
1174
'Branch.revision_history', path)
1175
assert response[0][0] == 'ok', ('unexpected response code %s'
1177
result = response[1].read_body_bytes().split('\x00')
1183
def set_revision_history(self, rev_history):
1184
# Send just the tip revision of the history; the server will generate
1185
# the full history from that. If the revision doesn't exist in this
1186
# branch, NoSuchRevision will be raised.
1187
path = self.bzrdir._path_for_remote_call(self._client)
1188
if rev_history == []:
1191
rev_id = rev_history[-1]
1192
self._clear_cached_state()
1193
response = self._client.call('Branch.set_last_revision',
1194
path, self._lock_token, self._repo_lock_token, rev_id)
1195
if response[0] == 'NoSuchRevision':
1196
raise NoSuchRevision(self, rev_id)
1198
assert response == ('ok',), (
1199
'unexpected response code %r' % (response,))
1200
self._cache_revision_history(rev_history)
1202
def get_parent(self):
1204
return self._real_branch.get_parent()
1206
def set_parent(self, url):
1208
return self._real_branch.set_parent(url)
1210
def get_config(self):
1211
return RemoteBranchConfig(self)
1213
def sprout(self, to_bzrdir, revision_id=None):
1214
# Like Branch.sprout, except that it sprouts a branch in the default
1215
# format, because RemoteBranches can't be created at arbitrary URLs.
1216
# XXX: if to_bzrdir is a RemoteBranch, this should perhaps do
1217
# to_bzrdir.create_branch...
1218
result = branch.BranchFormat.get_default_format().initialize(to_bzrdir)
1219
self.copy_content_into(result, revision_id=revision_id)
1220
result.set_parent(self.bzrdir.root_transport.base)
1224
def pull(self, source, overwrite=False, stop_revision=None,
1226
# FIXME: This asks the real branch to run the hooks, which means
1227
# they're called with the wrong target branch parameter.
1228
# The test suite specifically allows this at present but it should be
1229
# fixed. It should get a _override_hook_target branch,
1230
# as push does. -- mbp 20070405
1232
self._real_branch.pull(
1233
source, overwrite=overwrite, stop_revision=stop_revision,
1237
def push(self, target, overwrite=False, stop_revision=None):
1239
return self._real_branch.push(
1240
target, overwrite=overwrite, stop_revision=stop_revision,
1241
_override_hook_source_branch=self)
1243
def is_locked(self):
1244
return self._lock_count >= 1
1246
def set_last_revision_info(self, revno, revision_id):
1248
self._clear_cached_state()
1249
return self._real_branch.set_last_revision_info(revno, revision_id)
1251
def generate_revision_history(self, revision_id, last_rev=None,
1254
return self._real_branch.generate_revision_history(
1255
revision_id, last_rev=last_rev, other_branch=other_branch)
1260
return self._real_branch.tags
1262
def set_push_location(self, location):
1264
return self._real_branch.set_push_location(location)
1266
def update_revisions(self, other, stop_revision=None):
1268
return self._real_branch.update_revisions(
1269
other, stop_revision=stop_revision)
1272
class RemoteBranchConfig(BranchConfig):
1275
self.branch._ensure_real()
1276
return self.branch._real_branch.get_config().username()
1278
def _get_branch_data_config(self):
1279
self.branch._ensure_real()
1280
if self._branch_data_config is None:
1281
self._branch_data_config = TreeConfig(self.branch._real_branch)
1282
return self._branch_data_config
1285
def _extract_tar(tar, to_dir):
1286
"""Extract all the contents of a tarfile object.
1288
A replacement for extractall, which is not present in python2.4
1291
tar.extract(tarinfo, to_dir)
added
removed
bzrlib/remote.py
