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.revision import NULL_REVISION
35
from bzrlib.smart import client, vfs
36
from bzrlib.symbol_versioning import (
40
from bzrlib.trace import note
42
# Note: RemoteBzrDirFormat is in bzrdir.py
44
class RemoteBzrDir(BzrDir):
45
"""Control directory on a remote server, accessed via bzr:// or similar."""
47
def __init__(self, transport, _client=None):
48
"""Construct a RemoteBzrDir.
50
:param _client: Private parameter for testing. Disables probing and the
53
BzrDir.__init__(self, transport, RemoteBzrDirFormat())
54
# this object holds a delegated bzrdir that uses file-level operations
55
# to talk to the other side
56
self._real_bzrdir = None
59
self._shared_medium = transport.get_shared_medium()
60
self._client = client._SmartClient(self._shared_medium)
62
self._client = _client
63
self._shared_medium = None
66
path = self._path_for_remote_call(self._client)
67
response = self._client.call('BzrDir.open', path)
68
if response not in [('yes',), ('no',)]:
69
raise errors.UnexpectedSmartServerResponse(response)
70
if response == ('no',):
71
raise errors.NotBranchError(path=transport.base)
73
def _ensure_real(self):
74
"""Ensure that there is a _real_bzrdir set.
76
Used before calls to self._real_bzrdir.
78
if not self._real_bzrdir:
79
self._real_bzrdir = BzrDir.open_from_transport(
80
self.root_transport, _server_formats=False)
82
def create_repository(self, shared=False):
84
self._real_bzrdir.create_repository(shared=shared)
85
return self.open_repository()
87
def create_branch(self):
89
real_branch = self._real_bzrdir.create_branch()
90
return RemoteBranch(self, self.find_repository(), real_branch)
92
def destroy_branch(self):
93
"""See BzrDir.destroy_branch"""
95
self._real_bzrdir.destroy_branch()
97
def create_workingtree(self, revision_id=None):
98
raise errors.NotLocalUrl(self.transport.base)
100
def find_branch_format(self):
101
"""Find the branch 'format' for this bzrdir.
103
This might be a synthetic object for e.g. RemoteBranch and SVN.
105
b = self.open_branch()
108
def get_branch_reference(self):
109
"""See BzrDir.get_branch_reference()."""
110
path = self._path_for_remote_call(self._client)
111
response = self._client.call('BzrDir.open_branch', path)
112
if response[0] == 'ok':
113
if response[1] == '':
114
# branch at this location.
117
# a branch reference, use the existing BranchReference logic.
119
elif response == ('nobranch',):
120
raise errors.NotBranchError(path=self.root_transport.base)
122
raise errors.UnexpectedSmartServerResponse(response)
124
def open_branch(self, _unsupported=False):
125
assert _unsupported == False, 'unsupported flag support not implemented yet.'
126
reference_url = self.get_branch_reference()
127
if reference_url is None:
128
# branch at this location.
129
return RemoteBranch(self, self.find_repository())
131
# a branch reference, use the existing BranchReference logic.
132
format = BranchReferenceFormat()
133
return format.open(self, _found=True, location=reference_url)
135
def open_repository(self):
136
path = self._path_for_remote_call(self._client)
137
response = self._client.call('BzrDir.find_repository', path)
138
assert response[0] in ('ok', 'norepository'), \
139
'unexpected response code %s' % (response,)
140
if response[0] == 'norepository':
141
raise errors.NoRepositoryPresent(self)
142
assert len(response) == 4, 'incorrect response length %s' % (response,)
143
if response[1] == '':
144
format = RemoteRepositoryFormat()
145
format.rich_root_data = (response[2] == 'yes')
146
format.supports_tree_reference = (response[3] == 'yes')
147
return RemoteRepository(self, format)
149
raise errors.NoRepositoryPresent(self)
151
def open_workingtree(self, recommend_upgrade=True):
153
if self._real_bzrdir.has_workingtree():
154
raise errors.NotLocalUrl(self.root_transport)
156
raise errors.NoWorkingTree(self.root_transport.base)
158
def _path_for_remote_call(self, client):
159
"""Return the path to be used for this bzrdir in a remote call."""
160
return client.remote_path_from_transport(self.root_transport)
162
def get_branch_transport(self, branch_format):
164
return self._real_bzrdir.get_branch_transport(branch_format)
166
def get_repository_transport(self, repository_format):
168
return self._real_bzrdir.get_repository_transport(repository_format)
170
def get_workingtree_transport(self, workingtree_format):
172
return self._real_bzrdir.get_workingtree_transport(workingtree_format)
174
def can_convert_format(self):
175
"""Upgrading of remote bzrdirs is not supported yet."""
178
def needs_format_conversion(self, format=None):
179
"""Upgrading of remote bzrdirs is not supported yet."""
182
def clone(self, url, revision_id=None, force_new_repo=False):
184
return self._real_bzrdir.clone(url, revision_id=revision_id,
185
force_new_repo=force_new_repo)
188
class RemoteRepositoryFormat(repository.RepositoryFormat):
189
"""Format for repositories accessed over a _SmartClient.
191
Instances of this repository are represented by RemoteRepository
194
The RemoteRepositoryFormat is parameterised during construction
195
to reflect the capabilities of the real, remote format. Specifically
196
the attributes rich_root_data and supports_tree_reference are set
197
on a per instance basis, and are not set (and should not be) at
201
_matchingbzrdir = RemoteBzrDirFormat
203
def initialize(self, a_bzrdir, shared=False):
204
assert isinstance(a_bzrdir, RemoteBzrDir), \
205
'%r is not a RemoteBzrDir' % (a_bzrdir,)
206
return a_bzrdir.create_repository(shared=shared)
208
def open(self, a_bzrdir):
209
assert isinstance(a_bzrdir, RemoteBzrDir)
210
return a_bzrdir.open_repository()
212
def get_format_description(self):
213
return 'bzr remote repository'
215
def __eq__(self, other):
216
return self.__class__ == other.__class__
218
def check_conversion_target(self, target_format):
219
if self.rich_root_data and not target_format.rich_root_data:
220
raise errors.BadConversionTarget(
221
'Does not support rich root data.', target_format)
222
if (self.supports_tree_reference and
223
not getattr(target_format, 'supports_tree_reference', False)):
224
raise errors.BadConversionTarget(
225
'Does not support nested trees', target_format)
228
class RemoteRepository(object):
229
"""Repository accessed over rpc.
231
For the moment most operations are performed using local transport-backed
235
def __init__(self, remote_bzrdir, format, real_repository=None, _client=None):
236
"""Create a RemoteRepository instance.
238
:param remote_bzrdir: The bzrdir hosting this repository.
239
:param format: The RemoteFormat object to use.
240
:param real_repository: If not None, a local implementation of the
241
repository logic for the repository, usually accessing the data
243
:param _client: Private testing parameter - override the smart client
244
to be used by the repository.
247
self._real_repository = real_repository
249
self._real_repository = None
250
self.bzrdir = remote_bzrdir
252
self._client = client._SmartClient(self.bzrdir._shared_medium)
254
self._client = _client
255
self._format = format
256
self._lock_mode = None
257
self._lock_token = None
259
self._leave_lock = False
261
self._reconcile_does_inventory_gc = True
262
self.base = self.bzrdir.transport.base
265
return "%s(%s)" % (self.__class__.__name__, self.base)
269
def abort_write_group(self):
270
"""Complete a write group on the decorated repository.
272
Smart methods peform operations in a single step so this api
273
is not really applicable except as a compatibility thunk
274
for older plugins that don't use e.g. the CommitBuilder
278
return self._real_repository.abort_write_group()
280
def commit_write_group(self):
281
"""Complete a write group on the decorated repository.
283
Smart methods peform operations in a single step so this api
284
is not really applicable except as a compatibility thunk
285
for older plugins that don't use e.g. the CommitBuilder
289
return self._real_repository.commit_write_group()
291
def _ensure_real(self):
292
"""Ensure that there is a _real_repository set.
294
Used before calls to self._real_repository.
296
if not self._real_repository:
297
self.bzrdir._ensure_real()
298
#self._real_repository = self.bzrdir._real_bzrdir.open_repository()
299
self._set_real_repository(self.bzrdir._real_bzrdir.open_repository())
301
def get_revision_graph(self, revision_id=None):
302
"""See Repository.get_revision_graph()."""
303
if revision_id is None:
305
elif revision_id == NULL_REVISION:
308
path = self.bzrdir._path_for_remote_call(self._client)
309
assert type(revision_id) is str
310
response = self._client.call_expecting_body(
311
'Repository.get_revision_graph', path, revision_id)
312
if response[0][0] not in ['ok', 'nosuchrevision']:
313
raise errors.UnexpectedSmartServerResponse(response[0])
314
if response[0][0] == 'ok':
315
coded = response[1].read_body_bytes()
317
# no revisions in this repository!
319
lines = coded.split('\n')
322
d = tuple(line.split())
323
revision_graph[d[0]] = d[1:]
325
return revision_graph
327
response_body = response[1].read_body_bytes()
328
assert response_body == ''
329
raise NoSuchRevision(self, revision_id)
331
def has_revision(self, revision_id):
332
"""See Repository.has_revision()."""
333
if revision_id is None:
334
# The null revision is always present.
336
path = self.bzrdir._path_for_remote_call(self._client)
337
response = self._client.call('Repository.has_revision', path, revision_id)
338
assert response[0] in ('yes', 'no'), 'unexpected response code %s' % (response,)
339
return response[0] == 'yes'
341
def has_same_location(self, other):
342
return (self.__class__ == other.__class__ and
343
self.bzrdir.transport.base == other.bzrdir.transport.base)
345
def get_graph(self, other_repository=None):
346
"""Return the graph for this repository format"""
347
return self._real_repository.get_graph(other_repository)
349
def gather_stats(self, revid=None, committers=None):
350
"""See Repository.gather_stats()."""
351
path = self.bzrdir._path_for_remote_call(self._client)
352
if revid in (None, NULL_REVISION):
356
if committers is None or not committers:
357
fmt_committers = 'no'
359
fmt_committers = 'yes'
360
response = self._client.call_expecting_body(
361
'Repository.gather_stats', path, fmt_revid, fmt_committers)
362
assert response[0][0] == 'ok', \
363
'unexpected response code %s' % (response[0],)
365
body = response[1].read_body_bytes()
367
for line in body.split('\n'):
370
key, val_text = line.split(':')
371
if key in ('revisions', 'size', 'committers'):
372
result[key] = int(val_text)
373
elif key in ('firstrev', 'latestrev'):
374
values = val_text.split(' ')[1:]
375
result[key] = (float(values[0]), long(values[1]))
379
def get_physical_lock_status(self):
380
"""See Repository.get_physical_lock_status()."""
383
def is_in_write_group(self):
384
"""Return True if there is an open write group.
386
write groups are only applicable locally for the smart server..
388
if self._real_repository:
389
return self._real_repository.is_in_write_group()
392
return self._lock_count >= 1
395
"""See Repository.is_shared()."""
396
path = self.bzrdir._path_for_remote_call(self._client)
397
response = self._client.call('Repository.is_shared', path)
398
assert response[0] in ('yes', 'no'), 'unexpected response code %s' % (response,)
399
return response[0] == 'yes'
402
# wrong eventually - want a local lock cache context
403
if not self._lock_mode:
404
self._lock_mode = 'r'
406
if self._real_repository is not None:
407
self._real_repository.lock_read()
409
self._lock_count += 1
411
def _remote_lock_write(self, token):
412
path = self.bzrdir._path_for_remote_call(self._client)
415
response = self._client.call('Repository.lock_write', path, token)
416
if response[0] == 'ok':
419
elif response[0] == 'LockContention':
420
raise errors.LockContention('(remote lock)')
421
elif response[0] == 'UnlockableTransport':
422
raise errors.UnlockableTransport(self.bzrdir.root_transport)
423
elif response[0] == 'LockFailed':
424
raise errors.LockFailed(response[1], response[2])
426
raise errors.UnexpectedSmartServerResponse(response)
428
def lock_write(self, token=None):
429
if not self._lock_mode:
430
self._lock_token = self._remote_lock_write(token)
431
assert self._lock_token, 'Remote server did not return a token!'
432
if self._real_repository is not None:
433
self._real_repository.lock_write(token=self._lock_token)
434
if token is not None:
435
self._leave_lock = True
437
self._leave_lock = False
438
self._lock_mode = 'w'
440
elif self._lock_mode == 'r':
441
raise errors.ReadOnlyError(self)
443
self._lock_count += 1
444
return self._lock_token
446
def leave_lock_in_place(self):
447
self._leave_lock = True
449
def dont_leave_lock_in_place(self):
450
self._leave_lock = False
452
def _set_real_repository(self, repository):
453
"""Set the _real_repository for this repository.
455
:param repository: The repository to fallback to for non-hpss
456
implemented operations.
458
assert not isinstance(repository, RemoteRepository)
459
self._real_repository = repository
460
if self._lock_mode == 'w':
461
# if we are already locked, the real repository must be able to
462
# acquire the lock with our token.
463
self._real_repository.lock_write(self._lock_token)
464
elif self._lock_mode == 'r':
465
self._real_repository.lock_read()
467
def start_write_group(self):
468
"""Start a write group on the decorated repository.
470
Smart methods peform operations in a single step so this api
471
is not really applicable except as a compatibility thunk
472
for older plugins that don't use e.g. the CommitBuilder
476
return self._real_repository.start_write_group()
478
def _unlock(self, token):
479
path = self.bzrdir._path_for_remote_call(self._client)
480
response = self._client.call('Repository.unlock', path, token)
481
if response == ('ok',):
483
elif response[0] == 'TokenMismatch':
484
raise errors.TokenMismatch(token, '(remote token)')
486
raise errors.UnexpectedSmartServerResponse(response)
489
if self._lock_count == 1 and self._lock_mode == 'w':
490
# don't unlock if inside a write group.
491
if self.is_in_write_group():
492
raise errors.BzrError(
493
'Must end write groups before releasing write locks.')
494
self._lock_count -= 1
495
if not self._lock_count:
496
mode = self._lock_mode
497
self._lock_mode = None
498
if self._real_repository is not None:
499
self._real_repository.unlock()
501
# Only write-locked repositories need to make a remote method
502
# call to perfom the unlock.
504
assert self._lock_token, 'Locked, but no token!'
505
token = self._lock_token
506
self._lock_token = None
507
if not self._leave_lock:
510
def break_lock(self):
511
# should hand off to the network
513
return self._real_repository.break_lock()
515
def _get_tarball(self, compression):
516
"""Return a TemporaryFile containing a repository tarball.
518
Returns None if the server does not support sending tarballs.
521
path = self.bzrdir._path_for_remote_call(self._client)
522
response, protocol = self._client.call_expecting_body(
523
'Repository.tarball', path, compression)
524
if response[0] == 'ok':
525
# Extract the tarball and return it
526
t = tempfile.NamedTemporaryFile()
527
# TODO: rpc layer should read directly into it...
528
t.write(protocol.read_body_bytes())
531
if (response == ('error', "Generic bzr smart protocol error: "
532
"bad request 'Repository.tarball'") or
533
response == ('error', "Generic bzr smart protocol error: "
534
"bad request u'Repository.tarball'")):
535
protocol.cancel_read_body()
537
raise errors.UnexpectedSmartServerResponse(response)
539
def sprout(self, to_bzrdir, revision_id=None):
540
# TODO: Option to control what format is created?
541
to_repo = self._copy_repository_tarball(to_bzrdir, revision_id)
544
return self._real_repository.sprout(
545
to_bzrdir, revision_id=revision_id)
549
### These methods are just thin shims to the VFS object for now.
551
def revision_tree(self, revision_id):
553
return self._real_repository.revision_tree(revision_id)
555
def get_serializer_format(self):
557
return self._real_repository.get_serializer_format()
559
def get_commit_builder(self, branch, parents, config, timestamp=None,
560
timezone=None, committer=None, revprops=None,
562
# FIXME: It ought to be possible to call this without immediately
563
# triggering _ensure_real. For now it's the easiest thing to do.
565
builder = self._real_repository.get_commit_builder(branch, parents,
566
config, timestamp=timestamp, timezone=timezone,
567
committer=committer, revprops=revprops, revision_id=revision_id)
568
# Make the builder use this RemoteRepository rather than the real one.
569
builder.repository = self
573
def add_inventory(self, revid, inv, parents):
575
return self._real_repository.add_inventory(revid, inv, parents)
578
def add_revision(self, rev_id, rev, inv=None, config=None):
580
return self._real_repository.add_revision(
581
rev_id, rev, inv=inv, config=config)
584
def get_inventory(self, revision_id):
586
return self._real_repository.get_inventory(revision_id)
589
def get_revision(self, revision_id):
591
return self._real_repository.get_revision(revision_id)
594
def weave_store(self):
596
return self._real_repository.weave_store
598
def get_transaction(self):
600
return self._real_repository.get_transaction()
603
def clone(self, a_bzrdir, revision_id=None):
605
return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
607
def make_working_trees(self):
608
"""RemoteRepositories never create working trees by default."""
611
def fetch(self, source, revision_id=None, pb=None):
612
if self.has_same_location(source):
613
# check that last_revision is in 'from' and then return a
615
if (revision_id is not None and
616
not _mod_revision.is_null(revision_id)):
617
self.get_revision(revision_id)
620
return self._real_repository.fetch(
621
source, revision_id=revision_id, pb=pb)
623
def create_bundle(self, target, base, fileobj, format=None):
625
self._real_repository.create_bundle(target, base, fileobj, format)
628
def control_weaves(self):
630
return self._real_repository.control_weaves
633
def get_ancestry(self, revision_id, topo_sorted=True):
635
return self._real_repository.get_ancestry(revision_id, topo_sorted)
638
def get_inventory_weave(self):
640
return self._real_repository.get_inventory_weave()
642
def fileids_altered_by_revision_ids(self, revision_ids):
644
return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
646
def iter_files_bytes(self, desired_files):
647
"""See Repository.iter_file_bytes.
650
return self._real_repository.iter_files_bytes(desired_files)
653
def get_signature_text(self, revision_id):
655
return self._real_repository.get_signature_text(revision_id)
658
def get_revision_graph_with_ghosts(self, revision_ids=None):
660
return self._real_repository.get_revision_graph_with_ghosts(
661
revision_ids=revision_ids)
664
def get_inventory_xml(self, revision_id):
666
return self._real_repository.get_inventory_xml(revision_id)
668
def deserialise_inventory(self, revision_id, xml):
670
return self._real_repository.deserialise_inventory(revision_id, xml)
672
def reconcile(self, other=None, thorough=False):
674
return self._real_repository.reconcile(other=other, thorough=thorough)
676
def all_revision_ids(self):
678
return self._real_repository.all_revision_ids()
681
def get_deltas_for_revisions(self, revisions):
683
return self._real_repository.get_deltas_for_revisions(revisions)
686
def get_revision_delta(self, revision_id):
688
return self._real_repository.get_revision_delta(revision_id)
691
def revision_trees(self, revision_ids):
693
return self._real_repository.revision_trees(revision_ids)
696
def get_revision_reconcile(self, revision_id):
698
return self._real_repository.get_revision_reconcile(revision_id)
701
def check(self, revision_ids):
703
return self._real_repository.check(revision_ids)
705
def copy_content_into(self, destination, revision_id=None):
707
return self._real_repository.copy_content_into(
708
destination, revision_id=revision_id)
710
def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
711
# get a tarball of the remote repository, and copy from that into the
713
from bzrlib import osutils
716
from StringIO import StringIO
717
# TODO: Maybe a progress bar while streaming the tarball?
718
note("Copying repository content as tarball...")
719
tar_file = self._get_tarball('bz2')
722
destination = to_bzrdir.create_repository()
724
tar = tarfile.open('repository', fileobj=tar_file,
726
tmpdir = tempfile.mkdtemp()
728
_extract_tar(tar, tmpdir)
729
tmp_bzrdir = BzrDir.open(tmpdir)
730
tmp_repo = tmp_bzrdir.open_repository()
731
tmp_repo.copy_content_into(destination, revision_id)
733
osutils.rmtree(tmpdir)
737
# TODO: Suggestion from john: using external tar is much faster than
738
# python's tarfile library, but it may not work on windows.
742
"""Compress the data within the repository.
744
This is not currently implemented within the smart server.
747
return self._real_repository.pack()
749
def set_make_working_trees(self, new_value):
750
raise NotImplementedError(self.set_make_working_trees)
753
def sign_revision(self, revision_id, gpg_strategy):
755
return self._real_repository.sign_revision(revision_id, gpg_strategy)
758
def get_revisions(self, revision_ids):
760
return self._real_repository.get_revisions(revision_ids)
762
def supports_rich_root(self):
764
return self._real_repository.supports_rich_root()
766
def iter_reverse_revision_history(self, revision_id):
768
return self._real_repository.iter_reverse_revision_history(revision_id)
771
def _serializer(self):
773
return self._real_repository._serializer
775
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
777
return self._real_repository.store_revision_signature(
778
gpg_strategy, plaintext, revision_id)
780
def has_signature_for_revision_id(self, revision_id):
782
return self._real_repository.has_signature_for_revision_id(revision_id)
785
class RemoteBranchLockableFiles(LockableFiles):
786
"""A 'LockableFiles' implementation that talks to a smart server.
788
This is not a public interface class.
791
def __init__(self, bzrdir, _client):
793
self._client = _client
794
self._need_find_modes = True
795
LockableFiles.__init__(
796
self, bzrdir.get_branch_transport(None),
797
'lock', lockdir.LockDir)
799
def _find_modes(self):
800
# RemoteBranches don't let the client set the mode of control files.
801
self._dir_mode = None
802
self._file_mode = None
805
"""'get' a remote path as per the LockableFiles interface.
807
:param path: the file to 'get'. If this is 'branch.conf', we do not
808
just retrieve a file, instead we ask the smart server to generate
809
a configuration for us - which is retrieved as an INI file.
811
if path == 'branch.conf':
812
path = self.bzrdir._path_for_remote_call(self._client)
813
response = self._client.call_expecting_body(
814
'Branch.get_config_file', path)
815
assert response[0][0] == 'ok', \
816
'unexpected response code %s' % (response[0],)
817
return StringIO(response[1].read_body_bytes())
820
return LockableFiles.get(self, path)
823
class RemoteBranchFormat(branch.BranchFormat):
825
def __eq__(self, other):
826
return (isinstance(other, RemoteBranchFormat) and
827
self.__dict__ == other.__dict__)
829
def get_format_description(self):
830
return 'Remote BZR Branch'
832
def get_format_string(self):
833
return 'Remote BZR Branch'
835
def open(self, a_bzrdir):
836
assert isinstance(a_bzrdir, RemoteBzrDir)
837
return a_bzrdir.open_branch()
839
def initialize(self, a_bzrdir):
840
assert isinstance(a_bzrdir, RemoteBzrDir)
841
return a_bzrdir.create_branch()
843
def supports_tags(self):
844
# Remote branches might support tags, but we won't know until we
845
# access the real remote branch.
849
class RemoteBranch(branch.Branch):
850
"""Branch stored on a server accessed by HPSS RPC.
852
At the moment most operations are mapped down to simple file operations.
855
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
857
"""Create a RemoteBranch instance.
859
:param real_branch: An optional local implementation of the branch
860
format, usually accessing the data via the VFS.
861
:param _client: Private parameter for testing.
863
# We intentionally don't call the parent class's __init__, because it
864
# will try to assign to self.tags, which is a property in this subclass.
865
# And the parent's __init__ doesn't do much anyway.
866
self._revision_history_cache = None
867
self.bzrdir = remote_bzrdir
868
if _client is not None:
869
self._client = _client
871
self._client = client._SmartClient(self.bzrdir._shared_medium)
872
self.repository = remote_repository
873
if real_branch is not None:
874
self._real_branch = real_branch
875
# Give the remote repository the matching real repo.
876
real_repo = self._real_branch.repository
877
if isinstance(real_repo, RemoteRepository):
878
real_repo._ensure_real()
879
real_repo = real_repo._real_repository
880
self.repository._set_real_repository(real_repo)
881
# Give the branch the remote repository to let fast-pathing happen.
882
self._real_branch.repository = self.repository
884
self._real_branch = None
885
# Fill out expected attributes of branch for bzrlib api users.
886
self._format = RemoteBranchFormat()
887
self.base = self.bzrdir.root_transport.base
888
self._control_files = None
889
self._lock_mode = None
890
self._lock_token = None
892
self._leave_lock = False
895
return "%s(%s)" % (self.__class__.__name__, self.base)
899
def _ensure_real(self):
900
"""Ensure that there is a _real_branch set.
902
Used before calls to self._real_branch.
904
if not self._real_branch:
905
assert vfs.vfs_enabled()
906
self.bzrdir._ensure_real()
907
self._real_branch = self.bzrdir._real_bzrdir.open_branch()
908
# Give the remote repository the matching real repo.
909
real_repo = self._real_branch.repository
910
if isinstance(real_repo, RemoteRepository):
911
real_repo._ensure_real()
912
real_repo = real_repo._real_repository
913
self.repository._set_real_repository(real_repo)
914
# Give the branch the remote repository to let fast-pathing happen.
915
self._real_branch.repository = self.repository
916
# XXX: deal with _lock_mode == 'w'
917
if self._lock_mode == 'r':
918
self._real_branch.lock_read()
921
def control_files(self):
922
# Defer actually creating RemoteBranchLockableFiles until its needed,
923
# because it triggers an _ensure_real that we otherwise might not need.
924
if self._control_files is None:
925
self._control_files = RemoteBranchLockableFiles(
926
self.bzrdir, self._client)
927
return self._control_files
929
def _get_checkout_format(self):
931
return self._real_branch._get_checkout_format()
933
def get_physical_lock_status(self):
934
"""See Branch.get_physical_lock_status()."""
935
# should be an API call to the server, as branches must be lockable.
937
return self._real_branch.get_physical_lock_status()
940
if not self._lock_mode:
941
self._lock_mode = 'r'
943
if self._real_branch is not None:
944
self._real_branch.lock_read()
946
self._lock_count += 1
948
def _remote_lock_write(self, token):
950
branch_token = repo_token = ''
953
repo_token = self.repository.lock_write()
954
self.repository.unlock()
955
path = self.bzrdir._path_for_remote_call(self._client)
956
response = self._client.call('Branch.lock_write', path, branch_token,
958
if response[0] == 'ok':
959
ok, branch_token, repo_token = response
960
return branch_token, repo_token
961
elif response[0] == 'LockContention':
962
raise errors.LockContention('(remote lock)')
963
elif response[0] == 'TokenMismatch':
964
raise errors.TokenMismatch(token, '(remote token)')
965
elif response[0] == 'UnlockableTransport':
966
raise errors.UnlockableTransport(self.bzrdir.root_transport)
967
elif response[0] == 'ReadOnlyError':
968
raise errors.ReadOnlyError(self)
969
elif response[0] == 'LockFailed':
970
raise errors.LockFailed(response[1], response[2])
972
raise errors.UnexpectedSmartServerResponse(response)
974
def lock_write(self, token=None):
975
if not self._lock_mode:
976
remote_tokens = self._remote_lock_write(token)
977
self._lock_token, self._repo_lock_token = remote_tokens
978
assert self._lock_token, 'Remote server did not return a token!'
979
# TODO: We really, really, really don't want to call _ensure_real
980
# here, but it's the easiest way to ensure coherency between the
981
# state of the RemoteBranch and RemoteRepository objects and the
982
# physical locks. If we don't materialise the real objects here,
983
# then getting everything in the right state later is complex, so
984
# for now we just do it the lazy way.
985
# -- Andrew Bennetts, 2007-02-22.
987
if self._real_branch is not None:
988
self._real_branch.repository.lock_write(
989
token=self._repo_lock_token)
991
self._real_branch.lock_write(token=self._lock_token)
993
self._real_branch.repository.unlock()
994
if token is not None:
995
self._leave_lock = True
997
# XXX: this case seems to be unreachable; token cannot be None.
998
self._leave_lock = False
999
self._lock_mode = 'w'
1000
self._lock_count = 1
1001
elif self._lock_mode == 'r':
1002
raise errors.ReadOnlyTransaction
1004
if token is not None:
1005
# A token was given to lock_write, and we're relocking, so check
1006
# that the given token actually matches the one we already have.
1007
if token != self._lock_token:
1008
raise errors.TokenMismatch(token, self._lock_token)
1009
self._lock_count += 1
1010
return self._lock_token
1012
def _unlock(self, branch_token, repo_token):
1013
path = self.bzrdir._path_for_remote_call(self._client)
1014
response = self._client.call('Branch.unlock', path, branch_token,
1016
if response == ('ok',):
1018
elif response[0] == 'TokenMismatch':
1019
raise errors.TokenMismatch(
1020
str((branch_token, repo_token)), '(remote tokens)')
1022
raise errors.UnexpectedSmartServerResponse(response)
1025
self._lock_count -= 1
1026
if not self._lock_count:
1027
self._clear_cached_state()
1028
mode = self._lock_mode
1029
self._lock_mode = None
1030
if self._real_branch is not None:
1031
if not self._leave_lock:
1032
# If this RemoteBranch will remove the physical lock for the
1033
# repository, make sure the _real_branch doesn't do it
1034
# first. (Because the _real_branch's repository is set to
1035
# be the RemoteRepository.)
1036
self._real_branch.repository.leave_lock_in_place()
1037
self._real_branch.unlock()
1039
# Only write-locked branched need to make a remote method call
1040
# to perfom the unlock.
1042
assert self._lock_token, 'Locked, but no token!'
1043
branch_token = self._lock_token
1044
repo_token = self._repo_lock_token
1045
self._lock_token = None
1046
self._repo_lock_token = None
1047
if not self._leave_lock:
1048
self._unlock(branch_token, repo_token)
1050
def break_lock(self):
1052
return self._real_branch.break_lock()
1054
def leave_lock_in_place(self):
1055
self._leave_lock = True
1057
def dont_leave_lock_in_place(self):
1058
self._leave_lock = False
1060
def last_revision_info(self):
1061
"""See Branch.last_revision_info()."""
1062
path = self.bzrdir._path_for_remote_call(self._client)
1063
response = self._client.call('Branch.last_revision_info', path)
1064
assert response[0] == 'ok', 'unexpected response code %s' % (response,)
1065
revno = int(response[1])
1066
last_revision = response[2]
1067
return (revno, last_revision)
1069
def _gen_revision_history(self):
1070
"""See Branch._gen_revision_history()."""
1071
path = self.bzrdir._path_for_remote_call(self._client)
1072
response = self._client.call_expecting_body(
1073
'Branch.revision_history', path)
1074
assert response[0][0] == 'ok', ('unexpected response code %s'
1076
result = response[1].read_body_bytes().split('\x00')
1082
def set_revision_history(self, rev_history):
1083
# Send just the tip revision of the history; the server will generate
1084
# the full history from that. If the revision doesn't exist in this
1085
# branch, NoSuchRevision will be raised.
1086
path = self.bzrdir._path_for_remote_call(self._client)
1087
if rev_history == []:
1090
rev_id = rev_history[-1]
1091
self._clear_cached_state()
1092
response = self._client.call('Branch.set_last_revision',
1093
path, self._lock_token, self._repo_lock_token, rev_id)
1094
if response[0] == 'NoSuchRevision':
1095
raise NoSuchRevision(self, rev_id)
1097
assert response == ('ok',), (
1098
'unexpected response code %r' % (response,))
1099
self._cache_revision_history(rev_history)
1101
def get_parent(self):
1103
return self._real_branch.get_parent()
1105
def set_parent(self, url):
1107
return self._real_branch.set_parent(url)
1109
def get_config(self):
1110
return RemoteBranchConfig(self)
1112
def sprout(self, to_bzrdir, revision_id=None):
1113
# Like Branch.sprout, except that it sprouts a branch in the default
1114
# format, because RemoteBranches can't be created at arbitrary URLs.
1115
# XXX: if to_bzrdir is a RemoteBranch, this should perhaps do
1116
# to_bzrdir.create_branch...
1117
result = branch.BranchFormat.get_default_format().initialize(to_bzrdir)
1118
self.copy_content_into(result, revision_id=revision_id)
1119
result.set_parent(self.bzrdir.root_transport.base)
1123
def pull(self, source, overwrite=False, stop_revision=None,
1125
# FIXME: This asks the real branch to run the hooks, which means
1126
# they're called with the wrong target branch parameter.
1127
# The test suite specifically allows this at present but it should be
1128
# fixed. It should get a _override_hook_target branch,
1129
# as push does. -- mbp 20070405
1131
self._real_branch.pull(
1132
source, overwrite=overwrite, stop_revision=stop_revision,
1136
def push(self, target, overwrite=False, stop_revision=None):
1138
return self._real_branch.push(
1139
target, overwrite=overwrite, stop_revision=stop_revision,
1140
_override_hook_source_branch=self)
1142
def is_locked(self):
1143
return self._lock_count >= 1
1145
def set_last_revision_info(self, revno, revision_id):
1147
self._clear_cached_state()
1148
return self._real_branch.set_last_revision_info(revno, revision_id)
1150
def generate_revision_history(self, revision_id, last_rev=None,
1153
return self._real_branch.generate_revision_history(
1154
revision_id, last_rev=last_rev, other_branch=other_branch)
1159
return self._real_branch.tags
1161
def set_push_location(self, location):
1163
return self._real_branch.set_push_location(location)
1165
def update_revisions(self, other, stop_revision=None):
1167
return self._real_branch.update_revisions(
1168
other, stop_revision=stop_revision)
1171
class RemoteBranchConfig(BranchConfig):
1174
self.branch._ensure_real()
1175
return self.branch._real_branch.get_config().username()
1177
def _get_branch_data_config(self):
1178
self.branch._ensure_real()
1179
if self._branch_data_config is None:
1180
self._branch_data_config = TreeConfig(self.branch._real_branch)
1181
return self._branch_data_config
1184
def _extract_tar(tar, to_dir):
1185
"""Extract all the contents of a tarfile object.
1187
A replacement for extractall, which is not present in python2.4
1190
tar.extract(tarinfo, to_dir)
added
removed
bzrlib/remote.py
