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)
424
raise errors.UnexpectedSmartServerResponse(response)
426
def lock_write(self, token=None):
427
if not self._lock_mode:
428
self._lock_token = self._remote_lock_write(token)
429
assert self._lock_token, 'Remote server did not return a token!'
430
if self._real_repository is not None:
431
self._real_repository.lock_write(token=self._lock_token)
432
if token is not None:
433
self._leave_lock = True
435
self._leave_lock = False
436
self._lock_mode = 'w'
438
elif self._lock_mode == 'r':
439
raise errors.ReadOnlyError(self)
441
self._lock_count += 1
442
return self._lock_token
444
def leave_lock_in_place(self):
445
self._leave_lock = True
447
def dont_leave_lock_in_place(self):
448
self._leave_lock = False
450
def _set_real_repository(self, repository):
451
"""Set the _real_repository for this repository.
453
:param repository: The repository to fallback to for non-hpss
454
implemented operations.
456
assert not isinstance(repository, RemoteRepository)
457
self._real_repository = repository
458
if self._lock_mode == 'w':
459
# if we are already locked, the real repository must be able to
460
# acquire the lock with our token.
461
self._real_repository.lock_write(self._lock_token)
462
elif self._lock_mode == 'r':
463
self._real_repository.lock_read()
465
def start_write_group(self):
466
"""Start a write group on the decorated repository.
468
Smart methods peform operations in a single step so this api
469
is not really applicable except as a compatibility thunk
470
for older plugins that don't use e.g. the CommitBuilder
474
return self._real_repository.start_write_group()
476
def _unlock(self, token):
477
path = self.bzrdir._path_for_remote_call(self._client)
478
response = self._client.call('Repository.unlock', path, token)
479
if response == ('ok',):
481
elif response[0] == 'TokenMismatch':
482
raise errors.TokenMismatch(token, '(remote token)')
484
raise errors.UnexpectedSmartServerResponse(response)
487
if self._lock_count == 1 and self._lock_mode == 'w':
488
# don't unlock if inside a write group.
489
if self.is_in_write_group():
490
raise errors.BzrError(
491
'Must end write groups before releasing write locks.')
492
self._lock_count -= 1
493
if not self._lock_count:
494
mode = self._lock_mode
495
self._lock_mode = None
496
if self._real_repository is not None:
497
self._real_repository.unlock()
499
# Only write-locked repositories need to make a remote method
500
# call to perfom the unlock.
502
assert self._lock_token, 'Locked, but no token!'
503
token = self._lock_token
504
self._lock_token = None
505
if not self._leave_lock:
508
def break_lock(self):
509
# should hand off to the network
511
return self._real_repository.break_lock()
513
def _get_tarball(self, compression):
514
"""Return a TemporaryFile containing a repository tarball.
516
Returns None if the server does not support sending tarballs.
519
path = self.bzrdir._path_for_remote_call(self._client)
520
response, protocol = self._client.call_expecting_body(
521
'Repository.tarball', path, compression)
522
if response[0] == 'ok':
523
# Extract the tarball and return it
524
t = tempfile.NamedTemporaryFile()
525
# TODO: rpc layer should read directly into it...
526
t.write(protocol.read_body_bytes())
529
if (response == ('error', "Generic bzr smart protocol error: "
530
"bad request 'Repository.tarball'") or
531
response == ('error', "Generic bzr smart protocol error: "
532
"bad request u'Repository.tarball'")):
533
protocol.cancel_read_body()
535
raise errors.UnexpectedSmartServerResponse(response)
537
def sprout(self, to_bzrdir, revision_id=None):
538
# TODO: Option to control what format is created?
539
to_repo = self._copy_repository_tarball(to_bzrdir, revision_id)
542
return self._real_repository.sprout(
543
to_bzrdir, revision_id=revision_id)
547
### These methods are just thin shims to the VFS object for now.
549
def revision_tree(self, revision_id):
551
return self._real_repository.revision_tree(revision_id)
553
def get_serializer_format(self):
555
return self._real_repository.get_serializer_format()
557
def get_commit_builder(self, branch, parents, config, timestamp=None,
558
timezone=None, committer=None, revprops=None,
560
# FIXME: It ought to be possible to call this without immediately
561
# triggering _ensure_real. For now it's the easiest thing to do.
563
builder = self._real_repository.get_commit_builder(branch, parents,
564
config, timestamp=timestamp, timezone=timezone,
565
committer=committer, revprops=revprops, revision_id=revision_id)
566
# Make the builder use this RemoteRepository rather than the real one.
567
builder.repository = self
571
def add_inventory(self, revid, inv, parents):
573
return self._real_repository.add_inventory(revid, inv, parents)
576
def add_revision(self, rev_id, rev, inv=None, config=None):
578
return self._real_repository.add_revision(
579
rev_id, rev, inv=inv, config=config)
582
def get_inventory(self, revision_id):
584
return self._real_repository.get_inventory(revision_id)
587
def get_revision(self, revision_id):
589
return self._real_repository.get_revision(revision_id)
592
def weave_store(self):
594
return self._real_repository.weave_store
596
def get_transaction(self):
598
return self._real_repository.get_transaction()
601
def clone(self, a_bzrdir, revision_id=None):
603
return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
605
def make_working_trees(self):
606
"""RemoteRepositories never create working trees by default."""
609
def fetch(self, source, revision_id=None, pb=None):
611
return self._real_repository.fetch(
612
source, revision_id=revision_id, pb=pb)
614
def create_bundle(self, target, base, fileobj, format=None):
616
self._real_repository.create_bundle(target, base, fileobj, format)
619
def control_weaves(self):
621
return self._real_repository.control_weaves
624
def get_ancestry(self, revision_id, topo_sorted=True):
626
return self._real_repository.get_ancestry(revision_id, topo_sorted)
629
def get_inventory_weave(self):
631
return self._real_repository.get_inventory_weave()
633
def fileids_altered_by_revision_ids(self, revision_ids):
635
return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
637
def iter_files_bytes(self, desired_files):
638
"""See Repository.iter_file_bytes.
641
return self._real_repository.iter_files_bytes(desired_files)
644
def get_signature_text(self, revision_id):
646
return self._real_repository.get_signature_text(revision_id)
649
def get_revision_graph_with_ghosts(self, revision_ids=None):
651
return self._real_repository.get_revision_graph_with_ghosts(
652
revision_ids=revision_ids)
655
def get_inventory_xml(self, revision_id):
657
return self._real_repository.get_inventory_xml(revision_id)
659
def deserialise_inventory(self, revision_id, xml):
661
return self._real_repository.deserialise_inventory(revision_id, xml)
663
def reconcile(self, other=None, thorough=False):
665
return self._real_repository.reconcile(other=other, thorough=thorough)
667
def all_revision_ids(self):
669
return self._real_repository.all_revision_ids()
672
def get_deltas_for_revisions(self, revisions):
674
return self._real_repository.get_deltas_for_revisions(revisions)
677
def get_revision_delta(self, revision_id):
679
return self._real_repository.get_revision_delta(revision_id)
682
def revision_trees(self, revision_ids):
684
return self._real_repository.revision_trees(revision_ids)
687
def get_revision_reconcile(self, revision_id):
689
return self._real_repository.get_revision_reconcile(revision_id)
692
def check(self, revision_ids):
694
return self._real_repository.check(revision_ids)
696
def copy_content_into(self, destination, revision_id=None):
698
return self._real_repository.copy_content_into(
699
destination, revision_id=revision_id)
701
def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
702
# get a tarball of the remote repository, and copy from that into the
704
from bzrlib import osutils
707
from StringIO import StringIO
708
# TODO: Maybe a progress bar while streaming the tarball?
709
note("Copying repository content as tarball...")
710
tar_file = self._get_tarball('bz2')
713
destination = to_bzrdir.create_repository()
715
tar = tarfile.open('repository', fileobj=tar_file,
717
tmpdir = tempfile.mkdtemp()
719
_extract_tar(tar, tmpdir)
720
tmp_bzrdir = BzrDir.open(tmpdir)
721
tmp_repo = tmp_bzrdir.open_repository()
722
tmp_repo.copy_content_into(destination, revision_id)
724
osutils.rmtree(tmpdir)
728
# TODO: Suggestion from john: using external tar is much faster than
729
# python's tarfile library, but it may not work on windows.
733
"""Compress the data within the repository.
735
This is not currently implemented within the smart server.
738
return self._real_repository.pack()
740
def set_make_working_trees(self, new_value):
741
raise NotImplementedError(self.set_make_working_trees)
744
def sign_revision(self, revision_id, gpg_strategy):
746
return self._real_repository.sign_revision(revision_id, gpg_strategy)
749
def get_revisions(self, revision_ids):
751
return self._real_repository.get_revisions(revision_ids)
753
def supports_rich_root(self):
755
return self._real_repository.supports_rich_root()
757
def iter_reverse_revision_history(self, revision_id):
759
return self._real_repository.iter_reverse_revision_history(revision_id)
762
def _serializer(self):
764
return self._real_repository._serializer
766
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
768
return self._real_repository.store_revision_signature(
769
gpg_strategy, plaintext, revision_id)
771
def has_signature_for_revision_id(self, revision_id):
773
return self._real_repository.has_signature_for_revision_id(revision_id)
776
class RemoteBranchLockableFiles(LockableFiles):
777
"""A 'LockableFiles' implementation that talks to a smart server.
779
This is not a public interface class.
782
def __init__(self, bzrdir, _client):
784
self._client = _client
785
self._need_find_modes = True
786
LockableFiles.__init__(
787
self, bzrdir.get_branch_transport(None),
788
'lock', lockdir.LockDir)
790
def _find_modes(self):
791
# RemoteBranches don't let the client set the mode of control files.
792
self._dir_mode = None
793
self._file_mode = None
796
"""'get' a remote path as per the LockableFiles interface.
798
:param path: the file to 'get'. If this is 'branch.conf', we do not
799
just retrieve a file, instead we ask the smart server to generate
800
a configuration for us - which is retrieved as an INI file.
802
if path == 'branch.conf':
803
path = self.bzrdir._path_for_remote_call(self._client)
804
response = self._client.call_expecting_body(
805
'Branch.get_config_file', path)
806
assert response[0][0] == 'ok', \
807
'unexpected response code %s' % (response[0],)
808
return StringIO(response[1].read_body_bytes())
811
return LockableFiles.get(self, path)
814
class RemoteBranchFormat(branch.BranchFormat):
816
def __eq__(self, other):
817
return (isinstance(other, RemoteBranchFormat) and
818
self.__dict__ == other.__dict__)
820
def get_format_description(self):
821
return 'Remote BZR Branch'
823
def get_format_string(self):
824
return 'Remote BZR Branch'
826
def open(self, a_bzrdir):
827
assert isinstance(a_bzrdir, RemoteBzrDir)
828
return a_bzrdir.open_branch()
830
def initialize(self, a_bzrdir):
831
assert isinstance(a_bzrdir, RemoteBzrDir)
832
return a_bzrdir.create_branch()
834
def supports_tags(self):
835
# Remote branches might support tags, but we won't know until we
836
# access the real remote branch.
840
class RemoteBranch(branch.Branch):
841
"""Branch stored on a server accessed by HPSS RPC.
843
At the moment most operations are mapped down to simple file operations.
846
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
848
"""Create a RemoteBranch instance.
850
:param real_branch: An optional local implementation of the branch
851
format, usually accessing the data via the VFS.
852
:param _client: Private parameter for testing.
854
# We intentionally don't call the parent class's __init__, because it
855
# will try to assign to self.tags, which is a property in this subclass.
856
# And the parent's __init__ doesn't do much anyway.
857
self._revision_history_cache = None
858
self.bzrdir = remote_bzrdir
859
if _client is not None:
860
self._client = _client
862
self._client = client._SmartClient(self.bzrdir._shared_medium)
863
self.repository = remote_repository
864
if real_branch is not None:
865
self._real_branch = real_branch
866
# Give the remote repository the matching real repo.
867
real_repo = self._real_branch.repository
868
if isinstance(real_repo, RemoteRepository):
869
real_repo._ensure_real()
870
real_repo = real_repo._real_repository
871
self.repository._set_real_repository(real_repo)
872
# Give the branch the remote repository to let fast-pathing happen.
873
self._real_branch.repository = self.repository
875
self._real_branch = None
876
# Fill out expected attributes of branch for bzrlib api users.
877
self._format = RemoteBranchFormat()
878
self.base = self.bzrdir.root_transport.base
879
self._control_files = None
880
self._lock_mode = None
881
self._lock_token = None
883
self._leave_lock = False
886
return "%s(%s)" % (self.__class__.__name__, self.base)
890
def _ensure_real(self):
891
"""Ensure that there is a _real_branch set.
893
Used before calls to self._real_branch.
895
if not self._real_branch:
896
assert vfs.vfs_enabled()
897
self.bzrdir._ensure_real()
898
self._real_branch = self.bzrdir._real_bzrdir.open_branch()
899
# Give the remote repository the matching real repo.
900
real_repo = self._real_branch.repository
901
if isinstance(real_repo, RemoteRepository):
902
real_repo._ensure_real()
903
real_repo = real_repo._real_repository
904
self.repository._set_real_repository(real_repo)
905
# Give the branch the remote repository to let fast-pathing happen.
906
self._real_branch.repository = self.repository
907
# XXX: deal with _lock_mode == 'w'
908
if self._lock_mode == 'r':
909
self._real_branch.lock_read()
912
def control_files(self):
913
# Defer actually creating RemoteBranchLockableFiles until its needed,
914
# because it triggers an _ensure_real that we otherwise might not need.
915
if self._control_files is None:
916
self._control_files = RemoteBranchLockableFiles(
917
self.bzrdir, self._client)
918
return self._control_files
920
def _get_checkout_format(self):
922
return self._real_branch._get_checkout_format()
924
def get_physical_lock_status(self):
925
"""See Branch.get_physical_lock_status()."""
926
# should be an API call to the server, as branches must be lockable.
928
return self._real_branch.get_physical_lock_status()
931
if not self._lock_mode:
932
self._lock_mode = 'r'
934
if self._real_branch is not None:
935
self._real_branch.lock_read()
937
self._lock_count += 1
939
def _remote_lock_write(self, token):
941
branch_token = repo_token = ''
944
repo_token = self.repository.lock_write()
945
self.repository.unlock()
946
path = self.bzrdir._path_for_remote_call(self._client)
947
response = self._client.call('Branch.lock_write', path, branch_token,
949
if response[0] == 'ok':
950
ok, branch_token, repo_token = response
951
return branch_token, repo_token
952
elif response[0] == 'LockContention':
953
raise errors.LockContention('(remote lock)')
954
elif response[0] == 'TokenMismatch':
955
raise errors.TokenMismatch(token, '(remote token)')
956
elif response[0] == 'UnlockableTransport':
957
raise errors.UnlockableTransport(self.bzrdir.root_transport)
958
elif response[0] == 'ReadOnlyError':
959
raise errors.ReadOnlyError(self)
961
raise errors.UnexpectedSmartServerResponse(response)
963
def lock_write(self, token=None):
964
if not self._lock_mode:
965
remote_tokens = self._remote_lock_write(token)
966
self._lock_token, self._repo_lock_token = remote_tokens
967
assert self._lock_token, 'Remote server did not return a token!'
968
# TODO: We really, really, really don't want to call _ensure_real
969
# here, but it's the easiest way to ensure coherency between the
970
# state of the RemoteBranch and RemoteRepository objects and the
971
# physical locks. If we don't materialise the real objects here,
972
# then getting everything in the right state later is complex, so
973
# for now we just do it the lazy way.
974
# -- Andrew Bennetts, 2007-02-22.
976
if self._real_branch is not None:
977
self._real_branch.repository.lock_write(
978
token=self._repo_lock_token)
980
self._real_branch.lock_write(token=self._lock_token)
982
self._real_branch.repository.unlock()
983
if token is not None:
984
self._leave_lock = True
986
# XXX: this case seems to be unreachable; token cannot be None.
987
self._leave_lock = False
988
self._lock_mode = 'w'
990
elif self._lock_mode == 'r':
991
raise errors.ReadOnlyTransaction
993
if token is not None:
994
# A token was given to lock_write, and we're relocking, so check
995
# that the given token actually matches the one we already have.
996
if token != self._lock_token:
997
raise errors.TokenMismatch(token, self._lock_token)
998
self._lock_count += 1
999
return self._lock_token
1001
def _unlock(self, branch_token, repo_token):
1002
path = self.bzrdir._path_for_remote_call(self._client)
1003
response = self._client.call('Branch.unlock', path, branch_token,
1005
if response == ('ok',):
1007
elif response[0] == 'TokenMismatch':
1008
raise errors.TokenMismatch(
1009
str((branch_token, repo_token)), '(remote tokens)')
1011
raise errors.UnexpectedSmartServerResponse(response)
1014
self._lock_count -= 1
1015
if not self._lock_count:
1016
self._clear_cached_state()
1017
mode = self._lock_mode
1018
self._lock_mode = None
1019
if self._real_branch is not None:
1020
if not self._leave_lock:
1021
# If this RemoteBranch will remove the physical lock for the
1022
# repository, make sure the _real_branch doesn't do it
1023
# first. (Because the _real_branch's repository is set to
1024
# be the RemoteRepository.)
1025
self._real_branch.repository.leave_lock_in_place()
1026
self._real_branch.unlock()
1028
# Only write-locked branched need to make a remote method call
1029
# to perfom the unlock.
1031
assert self._lock_token, 'Locked, but no token!'
1032
branch_token = self._lock_token
1033
repo_token = self._repo_lock_token
1034
self._lock_token = None
1035
self._repo_lock_token = None
1036
if not self._leave_lock:
1037
self._unlock(branch_token, repo_token)
1039
def break_lock(self):
1041
return self._real_branch.break_lock()
1043
def leave_lock_in_place(self):
1044
self._leave_lock = True
1046
def dont_leave_lock_in_place(self):
1047
self._leave_lock = False
1049
def last_revision_info(self):
1050
"""See Branch.last_revision_info()."""
1051
path = self.bzrdir._path_for_remote_call(self._client)
1052
response = self._client.call('Branch.last_revision_info', path)
1053
assert response[0] == 'ok', 'unexpected response code %s' % (response,)
1054
revno = int(response[1])
1055
last_revision = response[2]
1056
return (revno, last_revision)
1058
def _gen_revision_history(self):
1059
"""See Branch._gen_revision_history()."""
1060
path = self.bzrdir._path_for_remote_call(self._client)
1061
response = self._client.call_expecting_body(
1062
'Branch.revision_history', path)
1063
assert response[0][0] == 'ok', ('unexpected response code %s'
1065
result = response[1].read_body_bytes().split('\x00')
1071
def set_revision_history(self, rev_history):
1072
# Send just the tip revision of the history; the server will generate
1073
# the full history from that. If the revision doesn't exist in this
1074
# branch, NoSuchRevision will be raised.
1075
path = self.bzrdir._path_for_remote_call(self._client)
1076
if rev_history == []:
1079
rev_id = rev_history[-1]
1080
self._clear_cached_state()
1081
response = self._client.call('Branch.set_last_revision',
1082
path, self._lock_token, self._repo_lock_token, rev_id)
1083
if response[0] == 'NoSuchRevision':
1084
raise NoSuchRevision(self, rev_id)
1086
assert response == ('ok',), (
1087
'unexpected response code %r' % (response,))
1088
self._cache_revision_history(rev_history)
1090
def get_parent(self):
1092
return self._real_branch.get_parent()
1094
def set_parent(self, url):
1096
return self._real_branch.set_parent(url)
1098
def get_config(self):
1099
return RemoteBranchConfig(self)
1101
def sprout(self, to_bzrdir, revision_id=None):
1102
# Like Branch.sprout, except that it sprouts a branch in the default
1103
# format, because RemoteBranches can't be created at arbitrary URLs.
1104
# XXX: if to_bzrdir is a RemoteBranch, this should perhaps do
1105
# to_bzrdir.create_branch...
1106
result = branch.BranchFormat.get_default_format().initialize(to_bzrdir)
1107
self.copy_content_into(result, revision_id=revision_id)
1108
result.set_parent(self.bzrdir.root_transport.base)
1112
def pull(self, source, overwrite=False, stop_revision=None,
1114
# FIXME: This asks the real branch to run the hooks, which means
1115
# they're called with the wrong target branch parameter.
1116
# The test suite specifically allows this at present but it should be
1117
# fixed. It should get a _override_hook_target branch,
1118
# as push does. -- mbp 20070405
1120
self._real_branch.pull(
1121
source, overwrite=overwrite, stop_revision=stop_revision,
1125
def push(self, target, overwrite=False, stop_revision=None):
1127
return self._real_branch.push(
1128
target, overwrite=overwrite, stop_revision=stop_revision,
1129
_override_hook_source_branch=self)
1131
def is_locked(self):
1132
return self._lock_count >= 1
1134
def set_last_revision_info(self, revno, revision_id):
1136
self._clear_cached_state()
1137
return self._real_branch.set_last_revision_info(revno, revision_id)
1139
def generate_revision_history(self, revision_id, last_rev=None,
1142
return self._real_branch.generate_revision_history(
1143
revision_id, last_rev=last_rev, other_branch=other_branch)
1148
return self._real_branch.tags
1150
def set_push_location(self, location):
1152
return self._real_branch.set_push_location(location)
1154
def update_revisions(self, other, stop_revision=None):
1156
return self._real_branch.update_revisions(
1157
other, stop_revision=stop_revision)
1160
class RemoteBranchConfig(BranchConfig):
1163
self.branch._ensure_real()
1164
return self.branch._real_branch.get_config().username()
1166
def _get_branch_data_config(self):
1167
self.branch._ensure_real()
1168
if self._branch_data_config is None:
1169
self._branch_data_config = TreeConfig(self.branch._real_branch)
1170
return self._branch_data_config
1173
def _extract_tar(tar, to_dir):
1174
"""Extract all the contents of a tarfile object.
1176
A replacement for extractall, which is not present in python2.4
1179
tar.extract(tarinfo, to_dir)
added
removed
bzrlib/remote.py
