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
28
from bzrlib.branch import Branch, BranchReferenceFormat
29
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
30
from bzrlib.config import BranchConfig, TreeConfig
31
from bzrlib.decorators import needs_read_lock, needs_write_lock
32
from bzrlib.errors import NoSuchRevision
33
from bzrlib.lockable_files import LockableFiles
34
from bzrlib.pack import ContainerReader
35
from bzrlib.revision import NULL_REVISION
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):
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_id == NULL_REVISION:
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
if revid in (None, NULL_REVISION):
389
if committers is None or not committers:
390
fmt_committers = 'no'
392
fmt_committers = 'yes'
393
response = self._client.call_expecting_body(
394
'Repository.gather_stats', path, fmt_revid, fmt_committers)
395
assert response[0][0] == 'ok', \
396
'unexpected response code %s' % (response[0],)
398
body = response[1].read_body_bytes()
400
for line in body.split('\n'):
403
key, val_text = line.split(':')
404
if key in ('revisions', 'size', 'committers'):
405
result[key] = int(val_text)
406
elif key in ('firstrev', 'latestrev'):
407
values = val_text.split(' ')[1:]
408
result[key] = (float(values[0]), long(values[1]))
412
def get_physical_lock_status(self):
413
"""See Repository.get_physical_lock_status()."""
416
def is_in_write_group(self):
417
"""Return True if there is an open write group.
419
write groups are only applicable locally for the smart server..
421
if self._real_repository:
422
return self._real_repository.is_in_write_group()
425
return self._lock_count >= 1
428
"""See Repository.is_shared()."""
429
path = self.bzrdir._path_for_remote_call(self._client)
430
response = self._client.call('Repository.is_shared', path)
431
assert response[0] in ('yes', 'no'), 'unexpected response code %s' % (response,)
432
return response[0] == 'yes'
434
def is_write_locked(self):
435
return self._lock_mode == 'w'
438
# wrong eventually - want a local lock cache context
439
if not self._lock_mode:
440
self._lock_mode = 'r'
442
if self._real_repository is not None:
443
self._real_repository.lock_read()
445
self._lock_count += 1
447
def _remote_lock_write(self, token):
448
path = self.bzrdir._path_for_remote_call(self._client)
451
response = self._client.call('Repository.lock_write', path, token)
452
if response[0] == 'ok':
455
elif response[0] == 'LockContention':
456
raise errors.LockContention('(remote lock)')
457
elif response[0] == 'UnlockableTransport':
458
raise errors.UnlockableTransport(self.bzrdir.root_transport)
459
elif response[0] == 'LockFailed':
460
raise errors.LockFailed(response[1], response[2])
462
raise errors.UnexpectedSmartServerResponse(response)
464
def lock_write(self, token=None):
465
if not self._lock_mode:
466
self._lock_token = self._remote_lock_write(token)
467
assert self._lock_token, 'Remote server did not return a token!'
468
if self._real_repository is not None:
469
self._real_repository.lock_write(token=self._lock_token)
470
if token is not None:
471
self._leave_lock = True
473
self._leave_lock = False
474
self._lock_mode = 'w'
476
elif self._lock_mode == 'r':
477
raise errors.ReadOnlyError(self)
479
self._lock_count += 1
480
return self._lock_token
482
def leave_lock_in_place(self):
483
self._leave_lock = True
485
def dont_leave_lock_in_place(self):
486
self._leave_lock = False
488
def _set_real_repository(self, repository):
489
"""Set the _real_repository for this repository.
491
:param repository: The repository to fallback to for non-hpss
492
implemented operations.
494
assert not isinstance(repository, RemoteRepository)
495
self._real_repository = repository
496
if self._lock_mode == 'w':
497
# if we are already locked, the real repository must be able to
498
# acquire the lock with our token.
499
self._real_repository.lock_write(self._lock_token)
500
elif self._lock_mode == 'r':
501
self._real_repository.lock_read()
503
def start_write_group(self):
504
"""Start a write group on the decorated repository.
506
Smart methods peform operations in a single step so this api
507
is not really applicable except as a compatibility thunk
508
for older plugins that don't use e.g. the CommitBuilder
512
return self._real_repository.start_write_group()
514
def _unlock(self, token):
515
path = self.bzrdir._path_for_remote_call(self._client)
516
response = self._client.call('Repository.unlock', path, token)
517
if response == ('ok',):
519
elif response[0] == 'TokenMismatch':
520
raise errors.TokenMismatch(token, '(remote token)')
522
raise errors.UnexpectedSmartServerResponse(response)
525
self._lock_count -= 1
526
if self._lock_count > 0:
528
old_mode = self._lock_mode
529
self._lock_mode = None
531
# The real repository is responsible at present for raising an
532
# exception if it's in an unfinished write group. However, it
533
# normally will *not* actually remove the lock from disk - that's
534
# done by the server on receiving the Repository.unlock call.
535
# This is just to let the _real_repository stay up to date.
536
if self._real_repository is not None:
537
self._real_repository.unlock()
539
# The rpc-level lock should be released even if there was a
540
# problem releasing the vfs-based lock.
542
# Only write-locked repositories need to make a remote method
543
# call to perfom the unlock.
544
assert self._lock_token, \
545
'%s is locked, but has no token' \
547
old_token = self._lock_token
548
self._lock_token = None
549
if not self._leave_lock:
550
self._unlock(old_token)
552
def break_lock(self):
553
# should hand off to the network
555
return self._real_repository.break_lock()
557
def _get_tarball(self, compression):
558
"""Return a TemporaryFile containing a repository tarball.
560
Returns None if the server does not support sending tarballs.
563
path = self.bzrdir._path_for_remote_call(self._client)
564
response, protocol = self._client.call_expecting_body(
565
'Repository.tarball', path, compression)
566
if response[0] == 'ok':
567
# Extract the tarball and return it
568
t = tempfile.NamedTemporaryFile()
569
# TODO: rpc layer should read directly into it...
570
t.write(protocol.read_body_bytes())
573
if (response == ('error', "Generic bzr smart protocol error: "
574
"bad request 'Repository.tarball'") or
575
response == ('error', "Generic bzr smart protocol error: "
576
"bad request u'Repository.tarball'")):
577
protocol.cancel_read_body()
579
raise errors.UnexpectedSmartServerResponse(response)
581
def sprout(self, to_bzrdir, revision_id=None):
582
# TODO: Option to control what format is created?
583
dest_repo = to_bzrdir.create_repository()
584
dest_repo.fetch(self, revision_id=revision_id)
587
### These methods are just thin shims to the VFS object for now.
589
def revision_tree(self, revision_id):
591
return self._real_repository.revision_tree(revision_id)
593
def get_serializer_format(self):
595
return self._real_repository.get_serializer_format()
597
def get_commit_builder(self, branch, parents, config, timestamp=None,
598
timezone=None, committer=None, revprops=None,
600
# FIXME: It ought to be possible to call this without immediately
601
# triggering _ensure_real. For now it's the easiest thing to do.
603
builder = self._real_repository.get_commit_builder(branch, parents,
604
config, timestamp=timestamp, timezone=timezone,
605
committer=committer, revprops=revprops, revision_id=revision_id)
606
# Make the builder use this RemoteRepository rather than the real one.
607
builder.repository = self
611
def add_inventory(self, revid, inv, parents):
613
return self._real_repository.add_inventory(revid, inv, parents)
616
def add_revision(self, rev_id, rev, inv=None, config=None):
618
return self._real_repository.add_revision(
619
rev_id, rev, inv=inv, config=config)
622
def get_inventory(self, revision_id):
624
return self._real_repository.get_inventory(revision_id)
627
def get_revision(self, revision_id):
629
return self._real_repository.get_revision(revision_id)
632
def weave_store(self):
634
return self._real_repository.weave_store
636
def get_transaction(self):
638
return self._real_repository.get_transaction()
641
def clone(self, a_bzrdir, revision_id=None):
643
return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
645
def make_working_trees(self):
646
"""RemoteRepositories never create working trees by default."""
649
def fetch(self, source, revision_id=None, pb=None):
650
if self.has_same_location(source):
651
# check that last_revision is in 'from' and then return a
653
if (revision_id is not None and
654
not _mod_revision.is_null(revision_id)):
655
self.get_revision(revision_id)
658
return self._real_repository.fetch(
659
source, revision_id=revision_id, pb=pb)
661
def create_bundle(self, target, base, fileobj, format=None):
663
self._real_repository.create_bundle(target, base, fileobj, format)
666
def control_weaves(self):
668
return self._real_repository.control_weaves
671
def get_ancestry(self, revision_id, topo_sorted=True):
673
return self._real_repository.get_ancestry(revision_id, topo_sorted)
676
def get_inventory_weave(self):
678
return self._real_repository.get_inventory_weave()
680
def fileids_altered_by_revision_ids(self, revision_ids):
682
return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
684
def get_versioned_file_checker(self, revisions, revision_versions_cache):
686
return self._real_repository.get_versioned_file_checker(
687
revisions, revision_versions_cache)
689
def iter_files_bytes(self, desired_files):
690
"""See Repository.iter_file_bytes.
693
return self._real_repository.iter_files_bytes(desired_files)
696
def get_signature_text(self, revision_id):
698
return self._real_repository.get_signature_text(revision_id)
701
def get_revision_graph_with_ghosts(self, revision_ids=None):
703
return self._real_repository.get_revision_graph_with_ghosts(
704
revision_ids=revision_ids)
707
def get_inventory_xml(self, revision_id):
709
return self._real_repository.get_inventory_xml(revision_id)
711
def deserialise_inventory(self, revision_id, xml):
713
return self._real_repository.deserialise_inventory(revision_id, xml)
715
def reconcile(self, other=None, thorough=False):
717
return self._real_repository.reconcile(other=other, thorough=thorough)
719
def all_revision_ids(self):
721
return self._real_repository.all_revision_ids()
724
def get_deltas_for_revisions(self, revisions):
726
return self._real_repository.get_deltas_for_revisions(revisions)
729
def get_revision_delta(self, revision_id):
731
return self._real_repository.get_revision_delta(revision_id)
734
def revision_trees(self, revision_ids):
736
return self._real_repository.revision_trees(revision_ids)
739
def get_revision_reconcile(self, revision_id):
741
return self._real_repository.get_revision_reconcile(revision_id)
744
def check(self, revision_ids=None):
746
return self._real_repository.check(revision_ids=revision_ids)
748
def copy_content_into(self, destination, revision_id=None):
750
return self._real_repository.copy_content_into(
751
destination, revision_id=revision_id)
753
def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
754
# get a tarball of the remote repository, and copy from that into the
756
from bzrlib import osutils
759
from StringIO import StringIO
760
# TODO: Maybe a progress bar while streaming the tarball?
761
note("Copying repository content as tarball...")
762
tar_file = self._get_tarball('bz2')
765
destination = to_bzrdir.create_repository()
767
tar = tarfile.open('repository', fileobj=tar_file,
769
tmpdir = tempfile.mkdtemp()
771
_extract_tar(tar, tmpdir)
772
tmp_bzrdir = BzrDir.open(tmpdir)
773
tmp_repo = tmp_bzrdir.open_repository()
774
tmp_repo.copy_content_into(destination, revision_id)
776
osutils.rmtree(tmpdir)
780
# TODO: Suggestion from john: using external tar is much faster than
781
# python's tarfile library, but it may not work on windows.
785
"""Compress the data within the repository.
787
This is not currently implemented within the smart server.
790
return self._real_repository.pack()
792
def set_make_working_trees(self, new_value):
793
raise NotImplementedError(self.set_make_working_trees)
796
def sign_revision(self, revision_id, gpg_strategy):
798
return self._real_repository.sign_revision(revision_id, gpg_strategy)
801
def get_revisions(self, revision_ids):
803
return self._real_repository.get_revisions(revision_ids)
805
def supports_rich_root(self):
807
return self._real_repository.supports_rich_root()
809
def iter_reverse_revision_history(self, revision_id):
811
return self._real_repository.iter_reverse_revision_history(revision_id)
814
def _serializer(self):
816
return self._real_repository._serializer
818
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
820
return self._real_repository.store_revision_signature(
821
gpg_strategy, plaintext, revision_id)
823
def has_signature_for_revision_id(self, revision_id):
825
return self._real_repository.has_signature_for_revision_id(revision_id)
827
def get_data_stream(self, revision_ids):
828
path = self.bzrdir._path_for_remote_call(self._client)
829
response, protocol = self._client.call_expecting_body(
830
'Repository.stream_knit_data_for_revisions', path, *revision_ids)
831
if response == ('ok',):
832
return self._deserialise_stream(protocol)
833
elif (response == ('error', "Generic bzr smart protocol error: "
834
"bad request 'Repository.stream_knit_data_for_revisions'") or
835
response == ('error', "Generic bzr smart protocol error: "
836
"bad request u'Repository.stream_knit_data_for_revisions'")):
837
protocol.cancel_read_body()
839
return self._real_repository.get_data_stream(revision_ids)
841
raise errors.UnexpectedSmartServerResponse(response)
843
def _deserialise_stream(self, protocol):
844
buffer = StringIO(protocol.read_body_bytes())
845
reader = ContainerReader(buffer)
846
for record_names, read_bytes in reader.iter_records():
848
# These records should have only one name, and that name
849
# should be a one-element tuple.
850
[name_tuple] = record_names
852
raise errors.SmartProtocolError(
853
'Repository data stream had invalid record name %r'
855
yield name_tuple, read_bytes(None)
857
def insert_data_stream(self, stream):
859
self._real_repository.insert_data_stream(stream)
861
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
863
return self._real_repository.item_keys_introduced_by(revision_ids,
866
def revision_graph_can_have_wrong_parents(self):
867
# The answer depends on the remote repo format.
869
return self._real_repository.revision_graph_can_have_wrong_parents()
871
def _find_inconsistent_revision_parents(self):
873
return self._real_repository._find_inconsistent_revision_parents()
875
def _check_for_inconsistent_revision_parents(self):
877
return self._real_repository._check_for_inconsistent_revision_parents()
880
class RemoteBranchLockableFiles(LockableFiles):
881
"""A 'LockableFiles' implementation that talks to a smart server.
883
This is not a public interface class.
886
def __init__(self, bzrdir, _client):
888
self._client = _client
889
self._need_find_modes = True
890
LockableFiles.__init__(
891
self, bzrdir.get_branch_transport(None),
892
'lock', lockdir.LockDir)
894
def _find_modes(self):
895
# RemoteBranches don't let the client set the mode of control files.
896
self._dir_mode = None
897
self._file_mode = None
900
"""'get' a remote path as per the LockableFiles interface.
902
:param path: the file to 'get'. If this is 'branch.conf', we do not
903
just retrieve a file, instead we ask the smart server to generate
904
a configuration for us - which is retrieved as an INI file.
906
if path == 'branch.conf':
907
path = self.bzrdir._path_for_remote_call(self._client)
908
response = self._client.call_expecting_body(
909
'Branch.get_config_file', path)
910
assert response[0][0] == 'ok', \
911
'unexpected response code %s' % (response[0],)
912
return StringIO(response[1].read_body_bytes())
915
return LockableFiles.get(self, path)
918
class RemoteBranchFormat(branch.BranchFormat):
920
def __eq__(self, other):
921
return (isinstance(other, RemoteBranchFormat) and
922
self.__dict__ == other.__dict__)
924
def get_format_description(self):
925
return 'Remote BZR Branch'
927
def get_format_string(self):
928
return 'Remote BZR Branch'
930
def open(self, a_bzrdir):
931
assert isinstance(a_bzrdir, RemoteBzrDir)
932
return a_bzrdir.open_branch()
934
def initialize(self, a_bzrdir):
935
assert isinstance(a_bzrdir, RemoteBzrDir)
936
return a_bzrdir.create_branch()
938
def supports_tags(self):
939
# Remote branches might support tags, but we won't know until we
940
# access the real remote branch.
944
class RemoteBranch(branch.Branch):
945
"""Branch stored on a server accessed by HPSS RPC.
947
At the moment most operations are mapped down to simple file operations.
950
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
952
"""Create a RemoteBranch instance.
954
:param real_branch: An optional local implementation of the branch
955
format, usually accessing the data via the VFS.
956
:param _client: Private parameter for testing.
958
# We intentionally don't call the parent class's __init__, because it
959
# will try to assign to self.tags, which is a property in this subclass.
960
# And the parent's __init__ doesn't do much anyway.
961
self._revision_history_cache = None
962
self.bzrdir = remote_bzrdir
963
if _client is not None:
964
self._client = _client
966
self._client = client._SmartClient(self.bzrdir._shared_medium)
967
self.repository = remote_repository
968
if real_branch is not None:
969
self._real_branch = real_branch
970
# Give the remote repository the matching real repo.
971
real_repo = self._real_branch.repository
972
if isinstance(real_repo, RemoteRepository):
973
real_repo._ensure_real()
974
real_repo = real_repo._real_repository
975
self.repository._set_real_repository(real_repo)
976
# Give the branch the remote repository to let fast-pathing happen.
977
self._real_branch.repository = self.repository
979
self._real_branch = None
980
# Fill out expected attributes of branch for bzrlib api users.
981
self._format = RemoteBranchFormat()
982
self.base = self.bzrdir.root_transport.base
983
self._control_files = None
984
self._lock_mode = None
985
self._lock_token = None
987
self._leave_lock = False
990
return "%s(%s)" % (self.__class__.__name__, self.base)
994
def _ensure_real(self):
995
"""Ensure that there is a _real_branch set.
997
Used before calls to self._real_branch.
999
if not self._real_branch:
1000
assert vfs.vfs_enabled()
1001
self.bzrdir._ensure_real()
1002
self._real_branch = self.bzrdir._real_bzrdir.open_branch()
1003
# Give the remote repository the matching real repo.
1004
real_repo = self._real_branch.repository
1005
if isinstance(real_repo, RemoteRepository):
1006
real_repo._ensure_real()
1007
real_repo = real_repo._real_repository
1008
self.repository._set_real_repository(real_repo)
1009
# Give the branch the remote repository to let fast-pathing happen.
1010
self._real_branch.repository = self.repository
1011
# XXX: deal with _lock_mode == 'w'
1012
if self._lock_mode == 'r':
1013
self._real_branch.lock_read()
1016
def control_files(self):
1017
# Defer actually creating RemoteBranchLockableFiles until its needed,
1018
# because it triggers an _ensure_real that we otherwise might not need.
1019
if self._control_files is None:
1020
self._control_files = RemoteBranchLockableFiles(
1021
self.bzrdir, self._client)
1022
return self._control_files
1024
def _get_checkout_format(self):
1026
return self._real_branch._get_checkout_format()
1028
def get_physical_lock_status(self):
1029
"""See Branch.get_physical_lock_status()."""
1030
# should be an API call to the server, as branches must be lockable.
1032
return self._real_branch.get_physical_lock_status()
1034
def lock_read(self):
1035
if not self._lock_mode:
1036
self._lock_mode = 'r'
1037
self._lock_count = 1
1038
if self._real_branch is not None:
1039
self._real_branch.lock_read()
1041
self._lock_count += 1
1043
def _remote_lock_write(self, token):
1045
branch_token = repo_token = ''
1047
branch_token = token
1048
repo_token = self.repository.lock_write()
1049
self.repository.unlock()
1050
path = self.bzrdir._path_for_remote_call(self._client)
1051
response = self._client.call('Branch.lock_write', path, branch_token,
1053
if response[0] == 'ok':
1054
ok, branch_token, repo_token = response
1055
return branch_token, repo_token
1056
elif response[0] == 'LockContention':
1057
raise errors.LockContention('(remote lock)')
1058
elif response[0] == 'TokenMismatch':
1059
raise errors.TokenMismatch(token, '(remote token)')
1060
elif response[0] == 'UnlockableTransport':
1061
raise errors.UnlockableTransport(self.bzrdir.root_transport)
1062
elif response[0] == 'ReadOnlyError':
1063
raise errors.ReadOnlyError(self)
1064
elif response[0] == 'LockFailed':
1065
raise errors.LockFailed(response[1], response[2])
1067
raise errors.UnexpectedSmartServerResponse(response)
1069
def lock_write(self, token=None):
1070
if not self._lock_mode:
1071
remote_tokens = self._remote_lock_write(token)
1072
self._lock_token, self._repo_lock_token = remote_tokens
1073
assert self._lock_token, 'Remote server did not return a token!'
1074
# TODO: We really, really, really don't want to call _ensure_real
1075
# here, but it's the easiest way to ensure coherency between the
1076
# state of the RemoteBranch and RemoteRepository objects and the
1077
# physical locks. If we don't materialise the real objects here,
1078
# then getting everything in the right state later is complex, so
1079
# for now we just do it the lazy way.
1080
# -- Andrew Bennetts, 2007-02-22.
1082
if self._real_branch is not None:
1083
self._real_branch.repository.lock_write(
1084
token=self._repo_lock_token)
1086
self._real_branch.lock_write(token=self._lock_token)
1088
self._real_branch.repository.unlock()
1089
if token is not None:
1090
self._leave_lock = True
1092
# XXX: this case seems to be unreachable; token cannot be None.
1093
self._leave_lock = False
1094
self._lock_mode = 'w'
1095
self._lock_count = 1
1096
elif self._lock_mode == 'r':
1097
raise errors.ReadOnlyTransaction
1099
if token is not None:
1100
# A token was given to lock_write, and we're relocking, so check
1101
# that the given token actually matches the one we already have.
1102
if token != self._lock_token:
1103
raise errors.TokenMismatch(token, self._lock_token)
1104
self._lock_count += 1
1105
return self._lock_token
1107
def _unlock(self, branch_token, repo_token):
1108
path = self.bzrdir._path_for_remote_call(self._client)
1109
response = self._client.call('Branch.unlock', path, branch_token,
1111
if response == ('ok',):
1113
elif response[0] == 'TokenMismatch':
1114
raise errors.TokenMismatch(
1115
str((branch_token, repo_token)), '(remote tokens)')
1117
raise errors.UnexpectedSmartServerResponse(response)
1120
self._lock_count -= 1
1121
if not self._lock_count:
1122
self._clear_cached_state()
1123
mode = self._lock_mode
1124
self._lock_mode = None
1125
if self._real_branch is not None:
1126
if not self._leave_lock:
1127
# If this RemoteBranch will remove the physical lock for the
1128
# repository, make sure the _real_branch doesn't do it
1129
# first. (Because the _real_branch's repository is set to
1130
# be the RemoteRepository.)
1131
self._real_branch.repository.leave_lock_in_place()
1132
self._real_branch.unlock()
1134
# Only write-locked branched need to make a remote method call
1135
# to perfom the unlock.
1137
assert self._lock_token, 'Locked, but no token!'
1138
branch_token = self._lock_token
1139
repo_token = self._repo_lock_token
1140
self._lock_token = None
1141
self._repo_lock_token = None
1142
if not self._leave_lock:
1143
self._unlock(branch_token, repo_token)
1145
def break_lock(self):
1147
return self._real_branch.break_lock()
1149
def leave_lock_in_place(self):
1150
self._leave_lock = True
1152
def dont_leave_lock_in_place(self):
1153
self._leave_lock = False
1155
def last_revision_info(self):
1156
"""See Branch.last_revision_info()."""
1157
path = self.bzrdir._path_for_remote_call(self._client)
1158
response = self._client.call('Branch.last_revision_info', path)
1159
assert response[0] == 'ok', 'unexpected response code %s' % (response,)
1160
revno = int(response[1])
1161
last_revision = response[2]
1162
return (revno, last_revision)
1164
def _gen_revision_history(self):
1165
"""See Branch._gen_revision_history()."""
1166
path = self.bzrdir._path_for_remote_call(self._client)
1167
response = self._client.call_expecting_body(
1168
'Branch.revision_history', path)
1169
assert response[0][0] == 'ok', ('unexpected response code %s'
1171
result = response[1].read_body_bytes().split('\x00')
1177
def set_revision_history(self, rev_history):
1178
# Send just the tip revision of the history; the server will generate
1179
# the full history from that. If the revision doesn't exist in this
1180
# branch, NoSuchRevision will be raised.
1181
path = self.bzrdir._path_for_remote_call(self._client)
1182
if rev_history == []:
1185
rev_id = rev_history[-1]
1186
self._clear_cached_state()
1187
response = self._client.call('Branch.set_last_revision',
1188
path, self._lock_token, self._repo_lock_token, rev_id)
1189
if response[0] == 'NoSuchRevision':
1190
raise NoSuchRevision(self, rev_id)
1192
assert response == ('ok',), (
1193
'unexpected response code %r' % (response,))
1194
self._cache_revision_history(rev_history)
1196
def get_parent(self):
1198
return self._real_branch.get_parent()
1200
def set_parent(self, url):
1202
return self._real_branch.set_parent(url)
1204
def get_config(self):
1205
return RemoteBranchConfig(self)
1207
def sprout(self, to_bzrdir, revision_id=None):
1208
# Like Branch.sprout, except that it sprouts a branch in the default
1209
# format, because RemoteBranches can't be created at arbitrary URLs.
1210
# XXX: if to_bzrdir is a RemoteBranch, this should perhaps do
1211
# to_bzrdir.create_branch...
1212
result = branch.BranchFormat.get_default_format().initialize(to_bzrdir)
1213
self.copy_content_into(result, revision_id=revision_id)
1214
result.set_parent(self.bzrdir.root_transport.base)
1218
def pull(self, source, overwrite=False, stop_revision=None,
1220
# FIXME: This asks the real branch to run the hooks, which means
1221
# they're called with the wrong target branch parameter.
1222
# The test suite specifically allows this at present but it should be
1223
# fixed. It should get a _override_hook_target branch,
1224
# as push does. -- mbp 20070405
1226
self._real_branch.pull(
1227
source, overwrite=overwrite, stop_revision=stop_revision,
1231
def push(self, target, overwrite=False, stop_revision=None):
1233
return self._real_branch.push(
1234
target, overwrite=overwrite, stop_revision=stop_revision,
1235
_override_hook_source_branch=self)
1237
def is_locked(self):
1238
return self._lock_count >= 1
1240
def set_last_revision_info(self, revno, revision_id):
1242
self._clear_cached_state()
1243
return self._real_branch.set_last_revision_info(revno, revision_id)
1245
def generate_revision_history(self, revision_id, last_rev=None,
1248
return self._real_branch.generate_revision_history(
1249
revision_id, last_rev=last_rev, other_branch=other_branch)
1254
return self._real_branch.tags
1256
def set_push_location(self, location):
1258
return self._real_branch.set_push_location(location)
1260
def update_revisions(self, other, stop_revision=None):
1262
return self._real_branch.update_revisions(
1263
other, stop_revision=stop_revision)
1266
class RemoteBranchConfig(BranchConfig):
1269
self.branch._ensure_real()
1270
return self.branch._real_branch.get_config().username()
1272
def _get_branch_data_config(self):
1273
self.branch._ensure_real()
1274
if self._branch_data_config is None:
1275
self._branch_data_config = TreeConfig(self.branch._real_branch)
1276
return self._branch_data_config
1279
def _extract_tar(tar, to_dir):
1280
"""Extract all the contents of a tarfile object.
1282
A replacement for extractall, which is not present in python2.4
1285
tar.extract(tarinfo, to_dir)
added
removed
bzrlib/remote.py
