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'
401
def is_write_locked(self):
402
return self._lock_mode == 'w'
405
# wrong eventually - want a local lock cache context
406
if not self._lock_mode:
407
self._lock_mode = 'r'
409
if self._real_repository is not None:
410
self._real_repository.lock_read()
412
self._lock_count += 1
414
def _remote_lock_write(self, token):
415
path = self.bzrdir._path_for_remote_call(self._client)
418
response = self._client.call('Repository.lock_write', path, token)
419
if response[0] == 'ok':
422
elif response[0] == 'LockContention':
423
raise errors.LockContention('(remote lock)')
424
elif response[0] == 'UnlockableTransport':
425
raise errors.UnlockableTransport(self.bzrdir.root_transport)
426
elif response[0] == 'LockFailed':
427
raise errors.LockFailed(response[1], response[2])
429
raise errors.UnexpectedSmartServerResponse(response)
431
def lock_write(self, token=None):
432
if not self._lock_mode:
433
self._lock_token = self._remote_lock_write(token)
434
assert self._lock_token, 'Remote server did not return a token!'
435
if self._real_repository is not None:
436
self._real_repository.lock_write(token=self._lock_token)
437
if token is not None:
438
self._leave_lock = True
440
self._leave_lock = False
441
self._lock_mode = 'w'
443
elif self._lock_mode == 'r':
444
raise errors.ReadOnlyError(self)
446
self._lock_count += 1
447
return self._lock_token
449
def leave_lock_in_place(self):
450
self._leave_lock = True
452
def dont_leave_lock_in_place(self):
453
self._leave_lock = False
455
def _set_real_repository(self, repository):
456
"""Set the _real_repository for this repository.
458
:param repository: The repository to fallback to for non-hpss
459
implemented operations.
461
assert not isinstance(repository, RemoteRepository)
462
self._real_repository = repository
463
if self._lock_mode == 'w':
464
# if we are already locked, the real repository must be able to
465
# acquire the lock with our token.
466
self._real_repository.lock_write(self._lock_token)
467
elif self._lock_mode == 'r':
468
self._real_repository.lock_read()
470
def start_write_group(self):
471
"""Start a write group on the decorated repository.
473
Smart methods peform operations in a single step so this api
474
is not really applicable except as a compatibility thunk
475
for older plugins that don't use e.g. the CommitBuilder
479
return self._real_repository.start_write_group()
481
def _unlock(self, token):
482
path = self.bzrdir._path_for_remote_call(self._client)
483
response = self._client.call('Repository.unlock', path, token)
484
if response == ('ok',):
486
elif response[0] == 'TokenMismatch':
487
raise errors.TokenMismatch(token, '(remote token)')
489
raise errors.UnexpectedSmartServerResponse(response)
492
if self._lock_count == 1 and self._lock_mode == 'w':
493
# don't unlock if inside a write group.
494
if self.is_in_write_group():
495
raise errors.BzrError(
496
'Must end write groups before releasing write locks.')
497
self._lock_count -= 1
498
if not self._lock_count:
499
mode = self._lock_mode
500
self._lock_mode = None
501
if self._real_repository is not None:
502
self._real_repository.unlock()
504
# Only write-locked repositories need to make a remote method
505
# call to perfom the unlock.
507
assert self._lock_token, 'Locked, but no token!'
508
token = self._lock_token
509
self._lock_token = None
510
if not self._leave_lock:
513
def break_lock(self):
514
# should hand off to the network
516
return self._real_repository.break_lock()
518
def _get_tarball(self, compression):
519
"""Return a TemporaryFile containing a repository tarball.
521
Returns None if the server does not support sending tarballs.
524
path = self.bzrdir._path_for_remote_call(self._client)
525
response, protocol = self._client.call_expecting_body(
526
'Repository.tarball', path, compression)
527
if response[0] == 'ok':
528
# Extract the tarball and return it
529
t = tempfile.NamedTemporaryFile()
530
# TODO: rpc layer should read directly into it...
531
t.write(protocol.read_body_bytes())
534
if (response == ('error', "Generic bzr smart protocol error: "
535
"bad request 'Repository.tarball'") or
536
response == ('error', "Generic bzr smart protocol error: "
537
"bad request u'Repository.tarball'")):
538
protocol.cancel_read_body()
540
raise errors.UnexpectedSmartServerResponse(response)
542
def sprout(self, to_bzrdir, revision_id=None):
543
# TODO: Option to control what format is created?
544
to_repo = self._copy_repository_tarball(to_bzrdir, revision_id)
547
return self._real_repository.sprout(
548
to_bzrdir, revision_id=revision_id)
552
### These methods are just thin shims to the VFS object for now.
554
def revision_tree(self, revision_id):
556
return self._real_repository.revision_tree(revision_id)
558
def get_serializer_format(self):
560
return self._real_repository.get_serializer_format()
562
def get_commit_builder(self, branch, parents, config, timestamp=None,
563
timezone=None, committer=None, revprops=None,
565
# FIXME: It ought to be possible to call this without immediately
566
# triggering _ensure_real. For now it's the easiest thing to do.
568
builder = self._real_repository.get_commit_builder(branch, parents,
569
config, timestamp=timestamp, timezone=timezone,
570
committer=committer, revprops=revprops, revision_id=revision_id)
571
# Make the builder use this RemoteRepository rather than the real one.
572
builder.repository = self
576
def add_inventory(self, revid, inv, parents):
578
return self._real_repository.add_inventory(revid, inv, parents)
581
def add_revision(self, rev_id, rev, inv=None, config=None):
583
return self._real_repository.add_revision(
584
rev_id, rev, inv=inv, config=config)
587
def get_inventory(self, revision_id):
589
return self._real_repository.get_inventory(revision_id)
592
def get_revision(self, revision_id):
594
return self._real_repository.get_revision(revision_id)
597
def weave_store(self):
599
return self._real_repository.weave_store
601
def get_transaction(self):
603
return self._real_repository.get_transaction()
606
def clone(self, a_bzrdir, revision_id=None):
608
return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
610
def make_working_trees(self):
611
"""RemoteRepositories never create working trees by default."""
614
def fetch(self, source, revision_id=None, pb=None):
615
if self.has_same_location(source):
616
# check that last_revision is in 'from' and then return a
618
if (revision_id is not None and
619
not _mod_revision.is_null(revision_id)):
620
self.get_revision(revision_id)
623
return self._real_repository.fetch(
624
source, revision_id=revision_id, pb=pb)
626
def create_bundle(self, target, base, fileobj, format=None):
628
self._real_repository.create_bundle(target, base, fileobj, format)
631
def control_weaves(self):
633
return self._real_repository.control_weaves
636
def get_ancestry(self, revision_id, topo_sorted=True):
638
return self._real_repository.get_ancestry(revision_id, topo_sorted)
641
def get_inventory_weave(self):
643
return self._real_repository.get_inventory_weave()
645
def fileids_altered_by_revision_ids(self, revision_ids):
647
return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
649
def iter_files_bytes(self, desired_files):
650
"""See Repository.iter_file_bytes.
653
return self._real_repository.iter_files_bytes(desired_files)
656
def get_signature_text(self, revision_id):
658
return self._real_repository.get_signature_text(revision_id)
661
def get_revision_graph_with_ghosts(self, revision_ids=None):
663
return self._real_repository.get_revision_graph_with_ghosts(
664
revision_ids=revision_ids)
667
def get_inventory_xml(self, revision_id):
669
return self._real_repository.get_inventory_xml(revision_id)
671
def deserialise_inventory(self, revision_id, xml):
673
return self._real_repository.deserialise_inventory(revision_id, xml)
675
def reconcile(self, other=None, thorough=False):
677
return self._real_repository.reconcile(other=other, thorough=thorough)
679
def all_revision_ids(self):
681
return self._real_repository.all_revision_ids()
684
def get_deltas_for_revisions(self, revisions):
686
return self._real_repository.get_deltas_for_revisions(revisions)
689
def get_revision_delta(self, revision_id):
691
return self._real_repository.get_revision_delta(revision_id)
694
def revision_trees(self, revision_ids):
696
return self._real_repository.revision_trees(revision_ids)
699
def get_revision_reconcile(self, revision_id):
701
return self._real_repository.get_revision_reconcile(revision_id)
704
def check(self, revision_ids):
706
return self._real_repository.check(revision_ids)
708
def copy_content_into(self, destination, revision_id=None):
710
return self._real_repository.copy_content_into(
711
destination, revision_id=revision_id)
713
def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
714
# get a tarball of the remote repository, and copy from that into the
716
from bzrlib import osutils
719
from StringIO import StringIO
720
# TODO: Maybe a progress bar while streaming the tarball?
721
note("Copying repository content as tarball...")
722
tar_file = self._get_tarball('bz2')
725
destination = to_bzrdir.create_repository()
727
tar = tarfile.open('repository', fileobj=tar_file,
729
tmpdir = tempfile.mkdtemp()
731
_extract_tar(tar, tmpdir)
732
tmp_bzrdir = BzrDir.open(tmpdir)
733
tmp_repo = tmp_bzrdir.open_repository()
734
tmp_repo.copy_content_into(destination, revision_id)
736
osutils.rmtree(tmpdir)
740
# TODO: Suggestion from john: using external tar is much faster than
741
# python's tarfile library, but it may not work on windows.
745
"""Compress the data within the repository.
747
This is not currently implemented within the smart server.
750
return self._real_repository.pack()
752
def set_make_working_trees(self, new_value):
753
raise NotImplementedError(self.set_make_working_trees)
756
def sign_revision(self, revision_id, gpg_strategy):
758
return self._real_repository.sign_revision(revision_id, gpg_strategy)
761
def get_revisions(self, revision_ids):
763
return self._real_repository.get_revisions(revision_ids)
765
def supports_rich_root(self):
767
return self._real_repository.supports_rich_root()
769
def iter_reverse_revision_history(self, revision_id):
771
return self._real_repository.iter_reverse_revision_history(revision_id)
774
def _serializer(self):
776
return self._real_repository._serializer
778
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
780
return self._real_repository.store_revision_signature(
781
gpg_strategy, plaintext, revision_id)
783
def has_signature_for_revision_id(self, revision_id):
785
return self._real_repository.has_signature_for_revision_id(revision_id)
788
class RemoteBranchLockableFiles(LockableFiles):
789
"""A 'LockableFiles' implementation that talks to a smart server.
791
This is not a public interface class.
794
def __init__(self, bzrdir, _client):
796
self._client = _client
797
self._need_find_modes = True
798
LockableFiles.__init__(
799
self, bzrdir.get_branch_transport(None),
800
'lock', lockdir.LockDir)
802
def _find_modes(self):
803
# RemoteBranches don't let the client set the mode of control files.
804
self._dir_mode = None
805
self._file_mode = None
808
"""'get' a remote path as per the LockableFiles interface.
810
:param path: the file to 'get'. If this is 'branch.conf', we do not
811
just retrieve a file, instead we ask the smart server to generate
812
a configuration for us - which is retrieved as an INI file.
814
if path == 'branch.conf':
815
path = self.bzrdir._path_for_remote_call(self._client)
816
response = self._client.call_expecting_body(
817
'Branch.get_config_file', path)
818
assert response[0][0] == 'ok', \
819
'unexpected response code %s' % (response[0],)
820
return StringIO(response[1].read_body_bytes())
823
return LockableFiles.get(self, path)
826
class RemoteBranchFormat(branch.BranchFormat):
828
def __eq__(self, other):
829
return (isinstance(other, RemoteBranchFormat) and
830
self.__dict__ == other.__dict__)
832
def get_format_description(self):
833
return 'Remote BZR Branch'
835
def get_format_string(self):
836
return 'Remote BZR Branch'
838
def open(self, a_bzrdir):
839
assert isinstance(a_bzrdir, RemoteBzrDir)
840
return a_bzrdir.open_branch()
842
def initialize(self, a_bzrdir):
843
assert isinstance(a_bzrdir, RemoteBzrDir)
844
return a_bzrdir.create_branch()
846
def supports_tags(self):
847
# Remote branches might support tags, but we won't know until we
848
# access the real remote branch.
852
class RemoteBranch(branch.Branch):
853
"""Branch stored on a server accessed by HPSS RPC.
855
At the moment most operations are mapped down to simple file operations.
858
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
860
"""Create a RemoteBranch instance.
862
:param real_branch: An optional local implementation of the branch
863
format, usually accessing the data via the VFS.
864
:param _client: Private parameter for testing.
866
# We intentionally don't call the parent class's __init__, because it
867
# will try to assign to self.tags, which is a property in this subclass.
868
# And the parent's __init__ doesn't do much anyway.
869
self._revision_history_cache = None
870
self.bzrdir = remote_bzrdir
871
if _client is not None:
872
self._client = _client
874
self._client = client._SmartClient(self.bzrdir._shared_medium)
875
self.repository = remote_repository
876
if real_branch is not None:
877
self._real_branch = real_branch
878
# Give the remote repository the matching real repo.
879
real_repo = self._real_branch.repository
880
if isinstance(real_repo, RemoteRepository):
881
real_repo._ensure_real()
882
real_repo = real_repo._real_repository
883
self.repository._set_real_repository(real_repo)
884
# Give the branch the remote repository to let fast-pathing happen.
885
self._real_branch.repository = self.repository
887
self._real_branch = None
888
# Fill out expected attributes of branch for bzrlib api users.
889
self._format = RemoteBranchFormat()
890
self.base = self.bzrdir.root_transport.base
891
self._control_files = None
892
self._lock_mode = None
893
self._lock_token = None
895
self._leave_lock = False
898
return "%s(%s)" % (self.__class__.__name__, self.base)
902
def _ensure_real(self):
903
"""Ensure that there is a _real_branch set.
905
Used before calls to self._real_branch.
907
if not self._real_branch:
908
assert vfs.vfs_enabled()
909
self.bzrdir._ensure_real()
910
self._real_branch = self.bzrdir._real_bzrdir.open_branch()
911
# Give the remote repository the matching real repo.
912
real_repo = self._real_branch.repository
913
if isinstance(real_repo, RemoteRepository):
914
real_repo._ensure_real()
915
real_repo = real_repo._real_repository
916
self.repository._set_real_repository(real_repo)
917
# Give the branch the remote repository to let fast-pathing happen.
918
self._real_branch.repository = self.repository
919
# XXX: deal with _lock_mode == 'w'
920
if self._lock_mode == 'r':
921
self._real_branch.lock_read()
924
def control_files(self):
925
# Defer actually creating RemoteBranchLockableFiles until its needed,
926
# because it triggers an _ensure_real that we otherwise might not need.
927
if self._control_files is None:
928
self._control_files = RemoteBranchLockableFiles(
929
self.bzrdir, self._client)
930
return self._control_files
932
def _get_checkout_format(self):
934
return self._real_branch._get_checkout_format()
936
def get_physical_lock_status(self):
937
"""See Branch.get_physical_lock_status()."""
938
# should be an API call to the server, as branches must be lockable.
940
return self._real_branch.get_physical_lock_status()
943
if not self._lock_mode:
944
self._lock_mode = 'r'
946
if self._real_branch is not None:
947
self._real_branch.lock_read()
949
self._lock_count += 1
951
def _remote_lock_write(self, token):
953
branch_token = repo_token = ''
956
repo_token = self.repository.lock_write()
957
self.repository.unlock()
958
path = self.bzrdir._path_for_remote_call(self._client)
959
response = self._client.call('Branch.lock_write', path, branch_token,
961
if response[0] == 'ok':
962
ok, branch_token, repo_token = response
963
return branch_token, repo_token
964
elif response[0] == 'LockContention':
965
raise errors.LockContention('(remote lock)')
966
elif response[0] == 'TokenMismatch':
967
raise errors.TokenMismatch(token, '(remote token)')
968
elif response[0] == 'UnlockableTransport':
969
raise errors.UnlockableTransport(self.bzrdir.root_transport)
970
elif response[0] == 'ReadOnlyError':
971
raise errors.ReadOnlyError(self)
972
elif response[0] == 'LockFailed':
973
raise errors.LockFailed(response[1], response[2])
975
raise errors.UnexpectedSmartServerResponse(response)
977
def lock_write(self, token=None):
978
if not self._lock_mode:
979
remote_tokens = self._remote_lock_write(token)
980
self._lock_token, self._repo_lock_token = remote_tokens
981
assert self._lock_token, 'Remote server did not return a token!'
982
# TODO: We really, really, really don't want to call _ensure_real
983
# here, but it's the easiest way to ensure coherency between the
984
# state of the RemoteBranch and RemoteRepository objects and the
985
# physical locks. If we don't materialise the real objects here,
986
# then getting everything in the right state later is complex, so
987
# for now we just do it the lazy way.
988
# -- Andrew Bennetts, 2007-02-22.
990
if self._real_branch is not None:
991
self._real_branch.repository.lock_write(
992
token=self._repo_lock_token)
994
self._real_branch.lock_write(token=self._lock_token)
996
self._real_branch.repository.unlock()
997
if token is not None:
998
self._leave_lock = True
1000
# XXX: this case seems to be unreachable; token cannot be None.
1001
self._leave_lock = False
1002
self._lock_mode = 'w'
1003
self._lock_count = 1
1004
elif self._lock_mode == 'r':
1005
raise errors.ReadOnlyTransaction
1007
if token is not None:
1008
# A token was given to lock_write, and we're relocking, so check
1009
# that the given token actually matches the one we already have.
1010
if token != self._lock_token:
1011
raise errors.TokenMismatch(token, self._lock_token)
1012
self._lock_count += 1
1013
return self._lock_token
1015
def _unlock(self, branch_token, repo_token):
1016
path = self.bzrdir._path_for_remote_call(self._client)
1017
response = self._client.call('Branch.unlock', path, branch_token,
1019
if response == ('ok',):
1021
elif response[0] == 'TokenMismatch':
1022
raise errors.TokenMismatch(
1023
str((branch_token, repo_token)), '(remote tokens)')
1025
raise errors.UnexpectedSmartServerResponse(response)
1028
self._lock_count -= 1
1029
if not self._lock_count:
1030
self._clear_cached_state()
1031
mode = self._lock_mode
1032
self._lock_mode = None
1033
if self._real_branch is not None:
1034
if not self._leave_lock:
1035
# If this RemoteBranch will remove the physical lock for the
1036
# repository, make sure the _real_branch doesn't do it
1037
# first. (Because the _real_branch's repository is set to
1038
# be the RemoteRepository.)
1039
self._real_branch.repository.leave_lock_in_place()
1040
self._real_branch.unlock()
1042
# Only write-locked branched need to make a remote method call
1043
# to perfom the unlock.
1045
assert self._lock_token, 'Locked, but no token!'
1046
branch_token = self._lock_token
1047
repo_token = self._repo_lock_token
1048
self._lock_token = None
1049
self._repo_lock_token = None
1050
if not self._leave_lock:
1051
self._unlock(branch_token, repo_token)
1053
def break_lock(self):
1055
return self._real_branch.break_lock()
1057
def leave_lock_in_place(self):
1058
self._leave_lock = True
1060
def dont_leave_lock_in_place(self):
1061
self._leave_lock = False
1063
def last_revision_info(self):
1064
"""See Branch.last_revision_info()."""
1065
path = self.bzrdir._path_for_remote_call(self._client)
1066
response = self._client.call('Branch.last_revision_info', path)
1067
assert response[0] == 'ok', 'unexpected response code %s' % (response,)
1068
revno = int(response[1])
1069
last_revision = response[2]
1070
return (revno, last_revision)
1072
def _gen_revision_history(self):
1073
"""See Branch._gen_revision_history()."""
1074
path = self.bzrdir._path_for_remote_call(self._client)
1075
response = self._client.call_expecting_body(
1076
'Branch.revision_history', path)
1077
assert response[0][0] == 'ok', ('unexpected response code %s'
1079
result = response[1].read_body_bytes().split('\x00')
1085
def set_revision_history(self, rev_history):
1086
# Send just the tip revision of the history; the server will generate
1087
# the full history from that. If the revision doesn't exist in this
1088
# branch, NoSuchRevision will be raised.
1089
path = self.bzrdir._path_for_remote_call(self._client)
1090
if rev_history == []:
1093
rev_id = rev_history[-1]
1094
self._clear_cached_state()
1095
response = self._client.call('Branch.set_last_revision',
1096
path, self._lock_token, self._repo_lock_token, rev_id)
1097
if response[0] == 'NoSuchRevision':
1098
raise NoSuchRevision(self, rev_id)
1100
assert response == ('ok',), (
1101
'unexpected response code %r' % (response,))
1102
self._cache_revision_history(rev_history)
1104
def get_parent(self):
1106
return self._real_branch.get_parent()
1108
def set_parent(self, url):
1110
return self._real_branch.set_parent(url)
1112
def get_config(self):
1113
return RemoteBranchConfig(self)
1115
def sprout(self, to_bzrdir, revision_id=None):
1116
# Like Branch.sprout, except that it sprouts a branch in the default
1117
# format, because RemoteBranches can't be created at arbitrary URLs.
1118
# XXX: if to_bzrdir is a RemoteBranch, this should perhaps do
1119
# to_bzrdir.create_branch...
1120
result = branch.BranchFormat.get_default_format().initialize(to_bzrdir)
1121
self.copy_content_into(result, revision_id=revision_id)
1122
result.set_parent(self.bzrdir.root_transport.base)
1126
def pull(self, source, overwrite=False, stop_revision=None,
1128
# FIXME: This asks the real branch to run the hooks, which means
1129
# they're called with the wrong target branch parameter.
1130
# The test suite specifically allows this at present but it should be
1131
# fixed. It should get a _override_hook_target branch,
1132
# as push does. -- mbp 20070405
1134
self._real_branch.pull(
1135
source, overwrite=overwrite, stop_revision=stop_revision,
1139
def push(self, target, overwrite=False, stop_revision=None):
1141
return self._real_branch.push(
1142
target, overwrite=overwrite, stop_revision=stop_revision,
1143
_override_hook_source_branch=self)
1145
def is_locked(self):
1146
return self._lock_count >= 1
1148
def set_last_revision_info(self, revno, revision_id):
1150
self._clear_cached_state()
1151
return self._real_branch.set_last_revision_info(revno, revision_id)
1153
def generate_revision_history(self, revision_id, last_rev=None,
1156
return self._real_branch.generate_revision_history(
1157
revision_id, last_rev=last_rev, other_branch=other_branch)
1162
return self._real_branch.tags
1164
def set_push_location(self, location):
1166
return self._real_branch.set_push_location(location)
1168
def update_revisions(self, other, stop_revision=None):
1170
return self._real_branch.update_revisions(
1171
other, stop_revision=stop_revision)
1174
class RemoteBranchConfig(BranchConfig):
1177
self.branch._ensure_real()
1178
return self.branch._real_branch.get_config().username()
1180
def _get_branch_data_config(self):
1181
self.branch._ensure_real()
1182
if self._branch_data_config is None:
1183
self._branch_data_config = TreeConfig(self.branch._real_branch)
1184
return self._branch_data_config
1187
def _extract_tar(tar, to_dir):
1188
"""Extract all the contents of a tarfile object.
1190
A replacement for extractall, which is not present in python2.4
1193
tar.extract(tarinfo, to_dir)
added
removed
bzrlib/remote.py
