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
self._reconcile_does_inventory_gc = True
263
self._reconcile_fixes_text_parents = True
264
self.base = self.bzrdir.transport.base
267
return "%s(%s)" % (self.__class__.__name__, self.base)
271
def abort_write_group(self):
272
"""Complete a write group on the decorated repository.
274
Smart methods peform operations in a single step so this api
275
is not really applicable except as a compatibility thunk
276
for older plugins that don't use e.g. the CommitBuilder
280
return self._real_repository.abort_write_group()
282
def commit_write_group(self):
283
"""Complete a write group on the decorated repository.
285
Smart methods peform operations in a single step so this api
286
is not really applicable except as a compatibility thunk
287
for older plugins that don't use e.g. the CommitBuilder
291
return self._real_repository.commit_write_group()
293
def _ensure_real(self):
294
"""Ensure that there is a _real_repository set.
296
Used before calls to self._real_repository.
298
if not self._real_repository:
299
self.bzrdir._ensure_real()
300
#self._real_repository = self.bzrdir._real_bzrdir.open_repository()
301
self._set_real_repository(self.bzrdir._real_bzrdir.open_repository())
303
def get_revision_graph(self, revision_id=None):
304
"""See Repository.get_revision_graph()."""
305
if revision_id is None:
307
elif revision_id == NULL_REVISION:
310
path = self.bzrdir._path_for_remote_call(self._client)
311
assert type(revision_id) is str
312
response = self._client.call_expecting_body(
313
'Repository.get_revision_graph', path, revision_id)
314
if response[0][0] not in ['ok', 'nosuchrevision']:
315
raise errors.UnexpectedSmartServerResponse(response[0])
316
if response[0][0] == 'ok':
317
coded = response[1].read_body_bytes()
319
# no revisions in this repository!
321
lines = coded.split('\n')
324
d = tuple(line.split())
325
revision_graph[d[0]] = d[1:]
327
return revision_graph
329
response_body = response[1].read_body_bytes()
330
assert response_body == ''
331
raise NoSuchRevision(self, revision_id)
333
def has_revision(self, revision_id):
334
"""See Repository.has_revision()."""
335
if revision_id is None:
336
# The null revision is always present.
338
path = self.bzrdir._path_for_remote_call(self._client)
339
response = self._client.call('Repository.has_revision', path, revision_id)
340
assert response[0] in ('yes', 'no'), 'unexpected response code %s' % (response,)
341
return response[0] == 'yes'
343
def has_same_location(self, other):
344
return (self.__class__ == other.__class__ and
345
self.bzrdir.transport.base == other.bzrdir.transport.base)
347
def get_graph(self, other_repository=None):
348
"""Return the graph for this repository format"""
350
return self._real_repository.get_graph(other_repository)
352
def gather_stats(self, revid=None, committers=None):
353
"""See Repository.gather_stats()."""
354
path = self.bzrdir._path_for_remote_call(self._client)
355
if revid in (None, NULL_REVISION):
359
if committers is None or not committers:
360
fmt_committers = 'no'
362
fmt_committers = 'yes'
363
response = self._client.call_expecting_body(
364
'Repository.gather_stats', path, fmt_revid, fmt_committers)
365
assert response[0][0] == 'ok', \
366
'unexpected response code %s' % (response[0],)
368
body = response[1].read_body_bytes()
370
for line in body.split('\n'):
373
key, val_text = line.split(':')
374
if key in ('revisions', 'size', 'committers'):
375
result[key] = int(val_text)
376
elif key in ('firstrev', 'latestrev'):
377
values = val_text.split(' ')[1:]
378
result[key] = (float(values[0]), long(values[1]))
382
def get_physical_lock_status(self):
383
"""See Repository.get_physical_lock_status()."""
386
def is_in_write_group(self):
387
"""Return True if there is an open write group.
389
write groups are only applicable locally for the smart server..
391
if self._real_repository:
392
return self._real_repository.is_in_write_group()
395
return self._lock_count >= 1
398
"""See Repository.is_shared()."""
399
path = self.bzrdir._path_for_remote_call(self._client)
400
response = self._client.call('Repository.is_shared', path)
401
assert response[0] in ('yes', 'no'), 'unexpected response code %s' % (response,)
402
return response[0] == 'yes'
404
def is_write_locked(self):
405
return self._lock_mode == 'w'
408
# wrong eventually - want a local lock cache context
409
if not self._lock_mode:
410
self._lock_mode = 'r'
412
if self._real_repository is not None:
413
self._real_repository.lock_read()
415
self._lock_count += 1
417
def _remote_lock_write(self, token):
418
path = self.bzrdir._path_for_remote_call(self._client)
421
response = self._client.call('Repository.lock_write', path, token)
422
if response[0] == 'ok':
425
elif response[0] == 'LockContention':
426
raise errors.LockContention('(remote lock)')
427
elif response[0] == 'UnlockableTransport':
428
raise errors.UnlockableTransport(self.bzrdir.root_transport)
429
elif response[0] == 'LockFailed':
430
raise errors.LockFailed(response[1], response[2])
432
raise errors.UnexpectedSmartServerResponse(response)
434
def lock_write(self, token=None):
435
if not self._lock_mode:
436
self._lock_token = self._remote_lock_write(token)
437
assert self._lock_token, 'Remote server did not return a token!'
438
if self._real_repository is not None:
439
self._real_repository.lock_write(token=self._lock_token)
440
if token is not None:
441
self._leave_lock = True
443
self._leave_lock = False
444
self._lock_mode = 'w'
446
elif self._lock_mode == 'r':
447
raise errors.ReadOnlyError(self)
449
self._lock_count += 1
450
return self._lock_token
452
def leave_lock_in_place(self):
453
self._leave_lock = True
455
def dont_leave_lock_in_place(self):
456
self._leave_lock = False
458
def _set_real_repository(self, repository):
459
"""Set the _real_repository for this repository.
461
:param repository: The repository to fallback to for non-hpss
462
implemented operations.
464
assert not isinstance(repository, RemoteRepository)
465
self._real_repository = repository
466
if self._lock_mode == 'w':
467
# if we are already locked, the real repository must be able to
468
# acquire the lock with our token.
469
self._real_repository.lock_write(self._lock_token)
470
elif self._lock_mode == 'r':
471
self._real_repository.lock_read()
473
def start_write_group(self):
474
"""Start a write group on the decorated repository.
476
Smart methods peform operations in a single step so this api
477
is not really applicable except as a compatibility thunk
478
for older plugins that don't use e.g. the CommitBuilder
482
return self._real_repository.start_write_group()
484
def _unlock(self, token):
485
path = self.bzrdir._path_for_remote_call(self._client)
486
response = self._client.call('Repository.unlock', path, token)
487
if response == ('ok',):
489
elif response[0] == 'TokenMismatch':
490
raise errors.TokenMismatch(token, '(remote token)')
492
raise errors.UnexpectedSmartServerResponse(response)
495
self._lock_count -= 1
496
if self._lock_count > 0:
498
old_mode = self._lock_mode
499
self._lock_mode = None
501
# The real repository is responsible at present for raising an
502
# exception if it's in an unfinished write group. However, it
503
# normally will *not* actually remove the lock from disk - that's
504
# done by the server on receiving the Repository.unlock call.
505
# This is just to let the _real_repository stay up to date.
506
if self._real_repository is not None:
507
self._real_repository.unlock()
509
# The rpc-level lock should be released even if there was a
510
# problem releasing the vfs-based lock.
512
# Only write-locked repositories need to make a remote method
513
# call to perfom the unlock.
514
assert self._lock_token, \
515
'%s is locked, but has no token' \
517
old_token = self._lock_token
518
self._lock_token = None
519
if not self._leave_lock:
520
self._unlock(old_token)
522
def break_lock(self):
523
# should hand off to the network
525
return self._real_repository.break_lock()
527
def _get_tarball(self, compression):
528
"""Return a TemporaryFile containing a repository tarball.
530
Returns None if the server does not support sending tarballs.
533
path = self.bzrdir._path_for_remote_call(self._client)
534
response, protocol = self._client.call_expecting_body(
535
'Repository.tarball', path, compression)
536
if response[0] == 'ok':
537
# Extract the tarball and return it
538
t = tempfile.NamedTemporaryFile()
539
# TODO: rpc layer should read directly into it...
540
t.write(protocol.read_body_bytes())
543
if (response == ('error', "Generic bzr smart protocol error: "
544
"bad request 'Repository.tarball'") or
545
response == ('error', "Generic bzr smart protocol error: "
546
"bad request u'Repository.tarball'")):
547
protocol.cancel_read_body()
549
raise errors.UnexpectedSmartServerResponse(response)
551
def sprout(self, to_bzrdir, revision_id=None):
552
# TODO: Option to control what format is created?
553
dest_repo = to_bzrdir.create_repository()
554
dest_repo.fetch(self, revision_id=revision_id)
557
### These methods are just thin shims to the VFS object for now.
559
def revision_tree(self, revision_id):
561
return self._real_repository.revision_tree(revision_id)
563
def get_serializer_format(self):
565
return self._real_repository.get_serializer_format()
567
def get_commit_builder(self, branch, parents, config, timestamp=None,
568
timezone=None, committer=None, revprops=None,
570
# FIXME: It ought to be possible to call this without immediately
571
# triggering _ensure_real. For now it's the easiest thing to do.
573
builder = self._real_repository.get_commit_builder(branch, parents,
574
config, timestamp=timestamp, timezone=timezone,
575
committer=committer, revprops=revprops, revision_id=revision_id)
576
# Make the builder use this RemoteRepository rather than the real one.
577
builder.repository = self
581
def add_inventory(self, revid, inv, parents):
583
return self._real_repository.add_inventory(revid, inv, parents)
586
def add_revision(self, rev_id, rev, inv=None, config=None):
588
return self._real_repository.add_revision(
589
rev_id, rev, inv=inv, config=config)
592
def get_inventory(self, revision_id):
594
return self._real_repository.get_inventory(revision_id)
597
def get_revision(self, revision_id):
599
return self._real_repository.get_revision(revision_id)
602
def weave_store(self):
604
return self._real_repository.weave_store
606
def get_transaction(self):
608
return self._real_repository.get_transaction()
611
def clone(self, a_bzrdir, revision_id=None):
613
return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
615
def make_working_trees(self):
616
"""RemoteRepositories never create working trees by default."""
619
def fetch(self, source, revision_id=None, pb=None):
620
if self.has_same_location(source):
621
# check that last_revision is in 'from' and then return a
623
if (revision_id is not None and
624
not _mod_revision.is_null(revision_id)):
625
self.get_revision(revision_id)
628
return self._real_repository.fetch(
629
source, revision_id=revision_id, pb=pb)
631
def create_bundle(self, target, base, fileobj, format=None):
633
self._real_repository.create_bundle(target, base, fileobj, format)
636
def control_weaves(self):
638
return self._real_repository.control_weaves
641
def get_ancestry(self, revision_id, topo_sorted=True):
643
return self._real_repository.get_ancestry(revision_id, topo_sorted)
646
def get_inventory_weave(self):
648
return self._real_repository.get_inventory_weave()
650
def fileids_altered_by_revision_ids(self, revision_ids):
652
return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
654
def get_versioned_file_checker(self, revisions, revision_versions_cache):
656
return self._real_repository.get_versioned_file_checker(
657
revisions, revision_versions_cache)
659
def iter_files_bytes(self, desired_files):
660
"""See Repository.iter_file_bytes.
663
return self._real_repository.iter_files_bytes(desired_files)
666
def get_signature_text(self, revision_id):
668
return self._real_repository.get_signature_text(revision_id)
671
def get_revision_graph_with_ghosts(self, revision_ids=None):
673
return self._real_repository.get_revision_graph_with_ghosts(
674
revision_ids=revision_ids)
677
def get_inventory_xml(self, revision_id):
679
return self._real_repository.get_inventory_xml(revision_id)
681
def deserialise_inventory(self, revision_id, xml):
683
return self._real_repository.deserialise_inventory(revision_id, xml)
685
def reconcile(self, other=None, thorough=False):
687
return self._real_repository.reconcile(other=other, thorough=thorough)
689
def all_revision_ids(self):
691
return self._real_repository.all_revision_ids()
694
def get_deltas_for_revisions(self, revisions):
696
return self._real_repository.get_deltas_for_revisions(revisions)
699
def get_revision_delta(self, revision_id):
701
return self._real_repository.get_revision_delta(revision_id)
704
def revision_trees(self, revision_ids):
706
return self._real_repository.revision_trees(revision_ids)
709
def get_revision_reconcile(self, revision_id):
711
return self._real_repository.get_revision_reconcile(revision_id)
714
def check(self, revision_ids=None):
716
return self._real_repository.check(revision_ids=revision_ids)
718
def copy_content_into(self, destination, revision_id=None):
720
return self._real_repository.copy_content_into(
721
destination, revision_id=revision_id)
723
def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
724
# get a tarball of the remote repository, and copy from that into the
726
from bzrlib import osutils
729
from StringIO import StringIO
730
# TODO: Maybe a progress bar while streaming the tarball?
731
note("Copying repository content as tarball...")
732
tar_file = self._get_tarball('bz2')
735
destination = to_bzrdir.create_repository()
737
tar = tarfile.open('repository', fileobj=tar_file,
739
tmpdir = tempfile.mkdtemp()
741
_extract_tar(tar, tmpdir)
742
tmp_bzrdir = BzrDir.open(tmpdir)
743
tmp_repo = tmp_bzrdir.open_repository()
744
tmp_repo.copy_content_into(destination, revision_id)
746
osutils.rmtree(tmpdir)
750
# TODO: Suggestion from john: using external tar is much faster than
751
# python's tarfile library, but it may not work on windows.
755
"""Compress the data within the repository.
757
This is not currently implemented within the smart server.
760
return self._real_repository.pack()
762
def set_make_working_trees(self, new_value):
763
raise NotImplementedError(self.set_make_working_trees)
766
def sign_revision(self, revision_id, gpg_strategy):
768
return self._real_repository.sign_revision(revision_id, gpg_strategy)
771
def get_revisions(self, revision_ids):
773
return self._real_repository.get_revisions(revision_ids)
775
def supports_rich_root(self):
777
return self._real_repository.supports_rich_root()
779
def iter_reverse_revision_history(self, revision_id):
781
return self._real_repository.iter_reverse_revision_history(revision_id)
784
def _serializer(self):
786
return self._real_repository._serializer
788
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
790
return self._real_repository.store_revision_signature(
791
gpg_strategy, plaintext, revision_id)
793
def has_signature_for_revision_id(self, revision_id):
795
return self._real_repository.has_signature_for_revision_id(revision_id)
797
def get_data_stream(self, revision_ids):
798
path = self.bzrdir._path_for_remote_call(self._client)
799
response, protocol = self._client.call_expecting_body(
800
'Repository.stream_knit_data_for_revisions', path, *revision_ids)
801
if response == ('ok',):
802
return self._deserialise_stream(protocol)
803
elif (response == ('error', "Generic bzr smart protocol error: "
804
"bad request 'Repository.stream_knit_data_for_revisions'") or
805
response == ('error', "Generic bzr smart protocol error: "
806
"bad request u'Repository.stream_knit_data_for_revisions'")):
807
protocol.cancel_read_body()
809
return self._real_repository.get_data_stream(revision_ids)
811
raise errors.UnexpectedSmartServerResponse(response)
813
def _deserialise_stream(self, protocol):
814
buffer = StringIO(protocol.read_body_bytes())
815
reader = ContainerReader(buffer)
816
for record_names, read_bytes in reader.iter_records():
818
# These records should have only one name, and that name
819
# should be a one-element tuple.
820
[name_tuple] = record_names
822
raise errors.SmartProtocolError(
823
'Repository data stream had invalid record name %r'
825
yield name_tuple, read_bytes(None)
827
def insert_data_stream(self, stream):
829
self._real_repository.insert_data_stream(stream)
831
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
833
return self._real_repository.item_keys_introduced_by(revision_ids,
836
def revision_graph_can_have_wrong_parents(self):
837
# The answer depends on the remote repo format.
839
return self._real_repository.revision_graph_can_have_wrong_parents()
841
def _find_inconsistent_revision_parents(self):
843
return self._real_repository._find_inconsistent_revision_parents()
845
def _check_for_inconsistent_revision_parents(self):
847
return self._real_repository._check_for_inconsistent_revision_parents()
850
class RemoteBranchLockableFiles(LockableFiles):
851
"""A 'LockableFiles' implementation that talks to a smart server.
853
This is not a public interface class.
856
def __init__(self, bzrdir, _client):
858
self._client = _client
859
self._need_find_modes = True
860
LockableFiles.__init__(
861
self, bzrdir.get_branch_transport(None),
862
'lock', lockdir.LockDir)
864
def _find_modes(self):
865
# RemoteBranches don't let the client set the mode of control files.
866
self._dir_mode = None
867
self._file_mode = None
870
"""'get' a remote path as per the LockableFiles interface.
872
:param path: the file to 'get'. If this is 'branch.conf', we do not
873
just retrieve a file, instead we ask the smart server to generate
874
a configuration for us - which is retrieved as an INI file.
876
if path == 'branch.conf':
877
path = self.bzrdir._path_for_remote_call(self._client)
878
response = self._client.call_expecting_body(
879
'Branch.get_config_file', path)
880
assert response[0][0] == 'ok', \
881
'unexpected response code %s' % (response[0],)
882
return StringIO(response[1].read_body_bytes())
885
return LockableFiles.get(self, path)
888
class RemoteBranchFormat(branch.BranchFormat):
890
def __eq__(self, other):
891
return (isinstance(other, RemoteBranchFormat) and
892
self.__dict__ == other.__dict__)
894
def get_format_description(self):
895
return 'Remote BZR Branch'
897
def get_format_string(self):
898
return 'Remote BZR Branch'
900
def open(self, a_bzrdir):
901
assert isinstance(a_bzrdir, RemoteBzrDir)
902
return a_bzrdir.open_branch()
904
def initialize(self, a_bzrdir):
905
assert isinstance(a_bzrdir, RemoteBzrDir)
906
return a_bzrdir.create_branch()
908
def supports_tags(self):
909
# Remote branches might support tags, but we won't know until we
910
# access the real remote branch.
914
class RemoteBranch(branch.Branch):
915
"""Branch stored on a server accessed by HPSS RPC.
917
At the moment most operations are mapped down to simple file operations.
920
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
922
"""Create a RemoteBranch instance.
924
:param real_branch: An optional local implementation of the branch
925
format, usually accessing the data via the VFS.
926
:param _client: Private parameter for testing.
928
# We intentionally don't call the parent class's __init__, because it
929
# will try to assign to self.tags, which is a property in this subclass.
930
# And the parent's __init__ doesn't do much anyway.
931
self._revision_history_cache = None
932
self.bzrdir = remote_bzrdir
933
if _client is not None:
934
self._client = _client
936
self._client = client._SmartClient(self.bzrdir._shared_medium)
937
self.repository = remote_repository
938
if real_branch is not None:
939
self._real_branch = real_branch
940
# Give the remote repository the matching real repo.
941
real_repo = self._real_branch.repository
942
if isinstance(real_repo, RemoteRepository):
943
real_repo._ensure_real()
944
real_repo = real_repo._real_repository
945
self.repository._set_real_repository(real_repo)
946
# Give the branch the remote repository to let fast-pathing happen.
947
self._real_branch.repository = self.repository
949
self._real_branch = None
950
# Fill out expected attributes of branch for bzrlib api users.
951
self._format = RemoteBranchFormat()
952
self.base = self.bzrdir.root_transport.base
953
self._control_files = None
954
self._lock_mode = None
955
self._lock_token = None
957
self._leave_lock = False
960
return "%s(%s)" % (self.__class__.__name__, self.base)
964
def _ensure_real(self):
965
"""Ensure that there is a _real_branch set.
967
Used before calls to self._real_branch.
969
if not self._real_branch:
970
assert vfs.vfs_enabled()
971
self.bzrdir._ensure_real()
972
self._real_branch = self.bzrdir._real_bzrdir.open_branch()
973
# Give the remote repository the matching real repo.
974
real_repo = self._real_branch.repository
975
if isinstance(real_repo, RemoteRepository):
976
real_repo._ensure_real()
977
real_repo = real_repo._real_repository
978
self.repository._set_real_repository(real_repo)
979
# Give the branch the remote repository to let fast-pathing happen.
980
self._real_branch.repository = self.repository
981
# XXX: deal with _lock_mode == 'w'
982
if self._lock_mode == 'r':
983
self._real_branch.lock_read()
986
def control_files(self):
987
# Defer actually creating RemoteBranchLockableFiles until its needed,
988
# because it triggers an _ensure_real that we otherwise might not need.
989
if self._control_files is None:
990
self._control_files = RemoteBranchLockableFiles(
991
self.bzrdir, self._client)
992
return self._control_files
994
def _get_checkout_format(self):
996
return self._real_branch._get_checkout_format()
998
def get_physical_lock_status(self):
999
"""See Branch.get_physical_lock_status()."""
1000
# should be an API call to the server, as branches must be lockable.
1002
return self._real_branch.get_physical_lock_status()
1004
def lock_read(self):
1005
if not self._lock_mode:
1006
self._lock_mode = 'r'
1007
self._lock_count = 1
1008
if self._real_branch is not None:
1009
self._real_branch.lock_read()
1011
self._lock_count += 1
1013
def _remote_lock_write(self, token):
1015
branch_token = repo_token = ''
1017
branch_token = token
1018
repo_token = self.repository.lock_write()
1019
self.repository.unlock()
1020
path = self.bzrdir._path_for_remote_call(self._client)
1021
response = self._client.call('Branch.lock_write', path, branch_token,
1023
if response[0] == 'ok':
1024
ok, branch_token, repo_token = response
1025
return branch_token, repo_token
1026
elif response[0] == 'LockContention':
1027
raise errors.LockContention('(remote lock)')
1028
elif response[0] == 'TokenMismatch':
1029
raise errors.TokenMismatch(token, '(remote token)')
1030
elif response[0] == 'UnlockableTransport':
1031
raise errors.UnlockableTransport(self.bzrdir.root_transport)
1032
elif response[0] == 'ReadOnlyError':
1033
raise errors.ReadOnlyError(self)
1034
elif response[0] == 'LockFailed':
1035
raise errors.LockFailed(response[1], response[2])
1037
raise errors.UnexpectedSmartServerResponse(response)
1039
def lock_write(self, token=None):
1040
if not self._lock_mode:
1041
remote_tokens = self._remote_lock_write(token)
1042
self._lock_token, self._repo_lock_token = remote_tokens
1043
assert self._lock_token, 'Remote server did not return a token!'
1044
# TODO: We really, really, really don't want to call _ensure_real
1045
# here, but it's the easiest way to ensure coherency between the
1046
# state of the RemoteBranch and RemoteRepository objects and the
1047
# physical locks. If we don't materialise the real objects here,
1048
# then getting everything in the right state later is complex, so
1049
# for now we just do it the lazy way.
1050
# -- Andrew Bennetts, 2007-02-22.
1052
if self._real_branch is not None:
1053
self._real_branch.repository.lock_write(
1054
token=self._repo_lock_token)
1056
self._real_branch.lock_write(token=self._lock_token)
1058
self._real_branch.repository.unlock()
1059
if token is not None:
1060
self._leave_lock = True
1062
# XXX: this case seems to be unreachable; token cannot be None.
1063
self._leave_lock = False
1064
self._lock_mode = 'w'
1065
self._lock_count = 1
1066
elif self._lock_mode == 'r':
1067
raise errors.ReadOnlyTransaction
1069
if token is not None:
1070
# A token was given to lock_write, and we're relocking, so check
1071
# that the given token actually matches the one we already have.
1072
if token != self._lock_token:
1073
raise errors.TokenMismatch(token, self._lock_token)
1074
self._lock_count += 1
1075
return self._lock_token
1077
def _unlock(self, branch_token, repo_token):
1078
path = self.bzrdir._path_for_remote_call(self._client)
1079
response = self._client.call('Branch.unlock', path, branch_token,
1081
if response == ('ok',):
1083
elif response[0] == 'TokenMismatch':
1084
raise errors.TokenMismatch(
1085
str((branch_token, repo_token)), '(remote tokens)')
1087
raise errors.UnexpectedSmartServerResponse(response)
1090
self._lock_count -= 1
1091
if not self._lock_count:
1092
self._clear_cached_state()
1093
mode = self._lock_mode
1094
self._lock_mode = None
1095
if self._real_branch is not None:
1096
if not self._leave_lock:
1097
# If this RemoteBranch will remove the physical lock for the
1098
# repository, make sure the _real_branch doesn't do it
1099
# first. (Because the _real_branch's repository is set to
1100
# be the RemoteRepository.)
1101
self._real_branch.repository.leave_lock_in_place()
1102
self._real_branch.unlock()
1104
# Only write-locked branched need to make a remote method call
1105
# to perfom the unlock.
1107
assert self._lock_token, 'Locked, but no token!'
1108
branch_token = self._lock_token
1109
repo_token = self._repo_lock_token
1110
self._lock_token = None
1111
self._repo_lock_token = None
1112
if not self._leave_lock:
1113
self._unlock(branch_token, repo_token)
1115
def break_lock(self):
1117
return self._real_branch.break_lock()
1119
def leave_lock_in_place(self):
1120
self._leave_lock = True
1122
def dont_leave_lock_in_place(self):
1123
self._leave_lock = False
1125
def last_revision_info(self):
1126
"""See Branch.last_revision_info()."""
1127
path = self.bzrdir._path_for_remote_call(self._client)
1128
response = self._client.call('Branch.last_revision_info', path)
1129
assert response[0] == 'ok', 'unexpected response code %s' % (response,)
1130
revno = int(response[1])
1131
last_revision = response[2]
1132
return (revno, last_revision)
1134
def _gen_revision_history(self):
1135
"""See Branch._gen_revision_history()."""
1136
path = self.bzrdir._path_for_remote_call(self._client)
1137
response = self._client.call_expecting_body(
1138
'Branch.revision_history', path)
1139
assert response[0][0] == 'ok', ('unexpected response code %s'
1141
result = response[1].read_body_bytes().split('\x00')
1147
def set_revision_history(self, rev_history):
1148
# Send just the tip revision of the history; the server will generate
1149
# the full history from that. If the revision doesn't exist in this
1150
# branch, NoSuchRevision will be raised.
1151
path = self.bzrdir._path_for_remote_call(self._client)
1152
if rev_history == []:
1155
rev_id = rev_history[-1]
1156
self._clear_cached_state()
1157
response = self._client.call('Branch.set_last_revision',
1158
path, self._lock_token, self._repo_lock_token, rev_id)
1159
if response[0] == 'NoSuchRevision':
1160
raise NoSuchRevision(self, rev_id)
1162
assert response == ('ok',), (
1163
'unexpected response code %r' % (response,))
1164
self._cache_revision_history(rev_history)
1166
def get_parent(self):
1168
return self._real_branch.get_parent()
1170
def set_parent(self, url):
1172
return self._real_branch.set_parent(url)
1174
def get_config(self):
1175
return RemoteBranchConfig(self)
1177
def sprout(self, to_bzrdir, revision_id=None):
1178
# Like Branch.sprout, except that it sprouts a branch in the default
1179
# format, because RemoteBranches can't be created at arbitrary URLs.
1180
# XXX: if to_bzrdir is a RemoteBranch, this should perhaps do
1181
# to_bzrdir.create_branch...
1182
result = branch.BranchFormat.get_default_format().initialize(to_bzrdir)
1183
self.copy_content_into(result, revision_id=revision_id)
1184
result.set_parent(self.bzrdir.root_transport.base)
1188
def pull(self, source, overwrite=False, stop_revision=None,
1190
# FIXME: This asks the real branch to run the hooks, which means
1191
# they're called with the wrong target branch parameter.
1192
# The test suite specifically allows this at present but it should be
1193
# fixed. It should get a _override_hook_target branch,
1194
# as push does. -- mbp 20070405
1196
self._real_branch.pull(
1197
source, overwrite=overwrite, stop_revision=stop_revision,
1201
def push(self, target, overwrite=False, stop_revision=None):
1203
return self._real_branch.push(
1204
target, overwrite=overwrite, stop_revision=stop_revision,
1205
_override_hook_source_branch=self)
1207
def is_locked(self):
1208
return self._lock_count >= 1
1210
def set_last_revision_info(self, revno, revision_id):
1212
self._clear_cached_state()
1213
return self._real_branch.set_last_revision_info(revno, revision_id)
1215
def generate_revision_history(self, revision_id, last_rev=None,
1218
return self._real_branch.generate_revision_history(
1219
revision_id, last_rev=last_rev, other_branch=other_branch)
1224
return self._real_branch.tags
1226
def set_push_location(self, location):
1228
return self._real_branch.set_push_location(location)
1230
def update_revisions(self, other, stop_revision=None):
1232
return self._real_branch.update_revisions(
1233
other, stop_revision=stop_revision)
1236
class RemoteBranchConfig(BranchConfig):
1239
self.branch._ensure_real()
1240
return self.branch._real_branch.get_config().username()
1242
def _get_branch_data_config(self):
1243
self.branch._ensure_real()
1244
if self._branch_data_config is None:
1245
self._branch_data_config = TreeConfig(self.branch._real_branch)
1246
return self._branch_data_config
1249
def _extract_tar(tar, to_dir):
1250
"""Extract all the contents of a tarfile object.
1252
A replacement for extractall, which is not present in python2.4
1255
tar.extract(tarinfo, to_dir)
added
removed
bzrlib/remote.py
