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.trace import note
38
# Note: RemoteBzrDirFormat is in bzrdir.py
40
class RemoteBzrDir(BzrDir):
41
"""Control directory on a remote server, accessed via bzr:// or similar."""
43
def __init__(self, transport, _client=None):
44
"""Construct a RemoteBzrDir.
46
:param _client: Private parameter for testing. Disables probing and the
49
BzrDir.__init__(self, transport, RemoteBzrDirFormat())
50
# this object holds a delegated bzrdir that uses file-level operations
51
# to talk to the other side
52
self._real_bzrdir = None
55
self._medium = transport.get_smart_client()
56
self._client = client._SmartClient(self._medium)
58
self._client = _client
62
path = self._path_for_remote_call(self._client)
63
response = self._client.call('BzrDir.open', path)
64
if response not in [('yes',), ('no',)]:
65
raise errors.UnexpectedSmartServerResponse(response)
66
if response == ('no',):
67
raise errors.NotBranchError(path=transport.base)
69
def _ensure_real(self):
70
"""Ensure that there is a _real_bzrdir set.
72
Used before calls to self._real_bzrdir.
74
if not self._real_bzrdir:
75
self._real_bzrdir = BzrDir.open_from_transport(
76
self.root_transport, _server_formats=False)
78
def create_repository(self, shared=False):
80
self._real_bzrdir.create_repository(shared=shared)
81
return self.open_repository()
83
def create_branch(self):
85
real_branch = self._real_bzrdir.create_branch()
86
return RemoteBranch(self, self.find_repository(), real_branch)
88
def create_workingtree(self, revision_id=None):
89
raise errors.NotLocalUrl(self.transport.base)
91
def find_branch_format(self):
92
"""Find the branch 'format' for this bzrdir.
94
This might be a synthetic object for e.g. RemoteBranch and SVN.
96
b = self.open_branch()
99
def get_branch_reference(self):
100
"""See BzrDir.get_branch_reference()."""
101
path = self._path_for_remote_call(self._client)
102
response = self._client.call('BzrDir.open_branch', path)
103
if response[0] == 'ok':
104
if response[1] == '':
105
# branch at this location.
108
# a branch reference, use the existing BranchReference logic.
110
elif response == ('nobranch',):
111
raise errors.NotBranchError(path=self.root_transport.base)
113
assert False, 'unexpected response code %r' % (response,)
115
def open_branch(self, _unsupported=False):
116
assert _unsupported == False, 'unsupported flag support not implemented yet.'
117
reference_url = self.get_branch_reference()
118
if reference_url is None:
119
# branch at this location.
120
return RemoteBranch(self, self.find_repository())
122
# a branch reference, use the existing BranchReference logic.
123
format = BranchReferenceFormat()
124
return format.open(self, _found=True, location=reference_url)
126
def open_repository(self):
127
path = self._path_for_remote_call(self._client)
128
response = self._client.call('BzrDir.find_repository', path)
129
assert response[0] in ('ok', 'norepository'), \
130
'unexpected response code %s' % (response,)
131
if response[0] == 'norepository':
132
raise errors.NoRepositoryPresent(self)
133
assert len(response) == 4, 'incorrect response length %s' % (response,)
134
if response[1] == '':
135
format = RemoteRepositoryFormat()
136
format.rich_root_data = (response[2] == 'yes')
137
format.supports_tree_reference = (response[3] == 'yes')
138
return RemoteRepository(self, format)
140
raise errors.NoRepositoryPresent(self)
142
def open_workingtree(self, recommend_upgrade=True):
144
if self._real_bzrdir.has_workingtree():
145
raise errors.NotLocalUrl(self.root_transport)
147
raise errors.NoWorkingTree(self.root_transport.base)
149
def _path_for_remote_call(self, client):
150
"""Return the path to be used for this bzrdir in a remote call."""
151
return client.remote_path_from_transport(self.root_transport)
153
def get_branch_transport(self, branch_format):
155
return self._real_bzrdir.get_branch_transport(branch_format)
157
def get_repository_transport(self, repository_format):
159
return self._real_bzrdir.get_repository_transport(repository_format)
161
def get_workingtree_transport(self, workingtree_format):
163
return self._real_bzrdir.get_workingtree_transport(workingtree_format)
165
def can_convert_format(self):
166
"""Upgrading of remote bzrdirs is not supported yet."""
169
def needs_format_conversion(self, format=None):
170
"""Upgrading of remote bzrdirs is not supported yet."""
173
def clone(self, url, revision_id=None, force_new_repo=False):
175
return self._real_bzrdir.clone(url, revision_id=revision_id,
176
force_new_repo=force_new_repo)
179
class RemoteRepositoryFormat(repository.RepositoryFormat):
180
"""Format for repositories accessed over a _SmartClient.
182
Instances of this repository are represented by RemoteRepository
185
The RemoteRepositoryFormat is parameterised during construction
186
to reflect the capabilities of the real, remote format. Specifically
187
the attributes rich_root_data and supports_tree_reference are set
188
on a per instance basis, and are not set (and should not be) at
192
_matchingbzrdir = RemoteBzrDirFormat
194
def initialize(self, a_bzrdir, shared=False):
195
assert isinstance(a_bzrdir, RemoteBzrDir), \
196
'%r is not a RemoteBzrDir' % (a_bzrdir,)
197
return a_bzrdir.create_repository(shared=shared)
199
def open(self, a_bzrdir):
200
assert isinstance(a_bzrdir, RemoteBzrDir)
201
return a_bzrdir.open_repository()
203
def get_format_description(self):
204
return 'bzr remote repository'
206
def __eq__(self, other):
207
return self.__class__ == other.__class__
209
def check_conversion_target(self, target_format):
210
if self.rich_root_data and not target_format.rich_root_data:
211
raise errors.BadConversionTarget(
212
'Does not support rich root data.', target_format)
213
if (self.supports_tree_reference and
214
not getattr(target_format, 'supports_tree_reference', False)):
215
raise errors.BadConversionTarget(
216
'Does not support nested trees', target_format)
219
class RemoteRepository(object):
220
"""Repository accessed over rpc.
222
For the moment most operations are performed using local transport-backed
226
def __init__(self, remote_bzrdir, format, real_repository=None, _client=None):
227
"""Create a RemoteRepository instance.
229
:param remote_bzrdir: The bzrdir hosting this repository.
230
:param format: The RemoteFormat object to use.
231
:param real_repository: If not None, a local implementation of the
232
repository logic for the repository, usually accessing the data
234
:param _client: Private testing parameter - override the smart client
235
to be used by the repository.
238
self._real_repository = real_repository
240
self._real_repository = None
241
self.bzrdir = remote_bzrdir
243
self._client = client._SmartClient(self.bzrdir._medium)
245
self._client = _client
246
self._format = format
247
self._lock_mode = None
248
self._lock_token = None
250
self._leave_lock = False
252
def _ensure_real(self):
253
"""Ensure that there is a _real_repository set.
255
Used before calls to self._real_repository.
257
if not self._real_repository:
258
self.bzrdir._ensure_real()
259
#self._real_repository = self.bzrdir._real_bzrdir.open_repository()
260
self._set_real_repository(self.bzrdir._real_bzrdir.open_repository())
262
def get_revision_graph(self, revision_id=None):
263
"""See Repository.get_revision_graph()."""
264
if revision_id is None:
266
elif revision_id == NULL_REVISION:
269
path = self.bzrdir._path_for_remote_call(self._client)
270
assert type(revision_id) is str
271
response = self._client.call_expecting_body(
272
'Repository.get_revision_graph', path, revision_id)
273
if response[0][0] not in ['ok', 'nosuchrevision']:
274
raise errors.UnexpectedSmartServerResponse(response[0])
275
if response[0][0] == 'ok':
276
coded = response[1].read_body_bytes()
278
# no revisions in this repository!
280
lines = coded.split('\n')
283
d = list(line.split())
284
revision_graph[d[0]] = d[1:]
286
return revision_graph
288
response_body = response[1].read_body_bytes()
289
assert response_body == ''
290
raise NoSuchRevision(self, revision_id)
292
def has_revision(self, revision_id):
293
"""See Repository.has_revision()."""
294
if revision_id is None:
295
# The null revision is always present.
297
path = self.bzrdir._path_for_remote_call(self._client)
298
response = self._client.call('Repository.has_revision', path, revision_id)
299
assert response[0] in ('yes', 'no'), 'unexpected response code %s' % (response,)
300
return response[0] == 'yes'
302
def get_graph(self, other_repository=None):
303
"""Return the graph for this repository format"""
304
return self._real_repository.get_graph(other_repository)
306
def gather_stats(self, revid=None, committers=None):
307
"""See Repository.gather_stats()."""
308
path = self.bzrdir._path_for_remote_call(self._client)
309
if revid in (None, NULL_REVISION):
313
if committers is None or not committers:
314
fmt_committers = 'no'
316
fmt_committers = 'yes'
317
response = self._client.call_expecting_body(
318
'Repository.gather_stats', path, fmt_revid, fmt_committers)
319
assert response[0][0] == 'ok', \
320
'unexpected response code %s' % (response[0],)
322
body = response[1].read_body_bytes()
324
for line in body.split('\n'):
327
key, val_text = line.split(':')
328
if key in ('revisions', 'size', 'committers'):
329
result[key] = int(val_text)
330
elif key in ('firstrev', 'latestrev'):
331
values = val_text.split(' ')[1:]
332
result[key] = (float(values[0]), long(values[1]))
336
def get_physical_lock_status(self):
337
"""See Repository.get_physical_lock_status()."""
341
"""See Repository.is_shared()."""
342
path = self.bzrdir._path_for_remote_call(self._client)
343
response = self._client.call('Repository.is_shared', path)
344
assert response[0] in ('yes', 'no'), 'unexpected response code %s' % (response,)
345
return response[0] == 'yes'
348
# wrong eventually - want a local lock cache context
349
if not self._lock_mode:
350
self._lock_mode = 'r'
352
if self._real_repository is not None:
353
self._real_repository.lock_read()
355
self._lock_count += 1
357
def _remote_lock_write(self, token):
358
path = self.bzrdir._path_for_remote_call(self._client)
361
response = self._client.call('Repository.lock_write', path, token)
362
if response[0] == 'ok':
365
elif response[0] == 'LockContention':
366
raise errors.LockContention('(remote lock)')
367
elif response[0] == 'UnlockableTransport':
368
raise errors.UnlockableTransport(self.bzrdir.root_transport)
370
assert False, 'unexpected response code %s' % (response,)
372
def lock_write(self, token=None):
373
if not self._lock_mode:
374
self._lock_token = self._remote_lock_write(token)
375
assert self._lock_token, 'Remote server did not return a token!'
376
if self._real_repository is not None:
377
self._real_repository.lock_write(token=self._lock_token)
378
if token is not None:
379
self._leave_lock = True
381
self._leave_lock = False
382
self._lock_mode = 'w'
384
elif self._lock_mode == 'r':
385
raise errors.ReadOnlyError(self)
387
self._lock_count += 1
388
return self._lock_token
390
def leave_lock_in_place(self):
391
self._leave_lock = True
393
def dont_leave_lock_in_place(self):
394
self._leave_lock = False
396
def _set_real_repository(self, repository):
397
"""Set the _real_repository for this repository.
399
:param repository: The repository to fallback to for non-hpss
400
implemented operations.
402
assert not isinstance(repository, RemoteRepository)
403
self._real_repository = repository
404
if self._lock_mode == 'w':
405
# if we are already locked, the real repository must be able to
406
# acquire the lock with our token.
407
self._real_repository.lock_write(self._lock_token)
408
elif self._lock_mode == 'r':
409
self._real_repository.lock_read()
411
def _unlock(self, token):
412
path = self.bzrdir._path_for_remote_call(self._client)
413
response = self._client.call('Repository.unlock', path, token)
414
if response == ('ok',):
416
elif response[0] == 'TokenMismatch':
417
raise errors.TokenMismatch(token, '(remote token)')
419
assert False, 'unexpected response code %s' % (response,)
422
self._lock_count -= 1
423
if not self._lock_count:
424
mode = self._lock_mode
425
self._lock_mode = None
426
if self._real_repository is not None:
427
self._real_repository.unlock()
429
# Only write-locked repositories need to make a remote method
430
# call to perfom the unlock.
432
assert self._lock_token, 'Locked, but no token!'
433
token = self._lock_token
434
self._lock_token = None
435
if not self._leave_lock:
438
def break_lock(self):
439
# should hand off to the network
441
return self._real_repository.break_lock()
443
def _get_tarball(self, compression):
444
"""Return a TemporaryFile containing a repository tarball"""
446
path = self.bzrdir._path_for_remote_call(self._client)
447
response, protocol = self._client.call_expecting_body(
448
'Repository.tarball', path, compression)
449
assert response[0] in ('ok', 'failure'), \
450
'unexpected response code %s' % (response,)
451
if response[0] == 'ok':
452
# Extract the tarball and return it
453
t = tempfile.NamedTemporaryFile()
454
# TODO: rpc layer should read directly into it...
455
t.write(protocol.read_body_bytes())
459
raise errors.SmartServerError(error_code=response)
461
def sprout(self, to_bzrdir, revision_id=None):
462
# TODO: Option to control what format is created?
463
to_repo = to_bzrdir.create_repository()
464
self._copy_repository_tarball(to_repo, revision_id)
467
### These methods are just thin shims to the VFS object for now.
469
def revision_tree(self, revision_id):
471
return self._real_repository.revision_tree(revision_id)
473
def get_commit_builder(self, branch, parents, config, timestamp=None,
474
timezone=None, committer=None, revprops=None,
476
# FIXME: It ought to be possible to call this without immediately
477
# triggering _ensure_real. For now it's the easiest thing to do.
479
builder = self._real_repository.get_commit_builder(branch, parents,
480
config, timestamp=timestamp, timezone=timezone,
481
committer=committer, revprops=revprops, revision_id=revision_id)
482
# Make the builder use this RemoteRepository rather than the real one.
483
builder.repository = self
487
def add_inventory(self, revid, inv, parents):
489
return self._real_repository.add_inventory(revid, inv, parents)
492
def add_revision(self, rev_id, rev, inv=None, config=None):
494
return self._real_repository.add_revision(
495
rev_id, rev, inv=inv, config=config)
498
def get_inventory(self, revision_id):
500
return self._real_repository.get_inventory(revision_id)
503
def get_revision(self, revision_id):
505
return self._real_repository.get_revision(revision_id)
508
def weave_store(self):
510
return self._real_repository.weave_store
512
def get_transaction(self):
514
return self._real_repository.get_transaction()
517
def clone(self, a_bzrdir, revision_id=None):
519
return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
521
def make_working_trees(self):
522
"""RemoteRepositories never create working trees by default."""
525
def fetch(self, source, revision_id=None, pb=None):
527
return self._real_repository.fetch(
528
source, revision_id=revision_id, pb=pb)
531
def control_weaves(self):
533
return self._real_repository.control_weaves
536
def get_ancestry(self, revision_id):
538
return self._real_repository.get_ancestry(revision_id)
541
def get_inventory_weave(self):
543
return self._real_repository.get_inventory_weave()
545
def fileids_altered_by_revision_ids(self, revision_ids):
547
return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
550
def get_signature_text(self, revision_id):
552
return self._real_repository.get_signature_text(revision_id)
555
def get_revision_graph_with_ghosts(self, revision_ids=None):
557
return self._real_repository.get_revision_graph_with_ghosts(
558
revision_ids=revision_ids)
561
def get_inventory_xml(self, revision_id):
563
return self._real_repository.get_inventory_xml(revision_id)
565
def deserialise_inventory(self, revision_id, xml):
567
return self._real_repository.deserialise_inventory(revision_id, xml)
569
def reconcile(self, other=None, thorough=False):
571
return self._real_repository.reconcile(other=other, thorough=thorough)
573
def all_revision_ids(self):
575
return self._real_repository.all_revision_ids()
578
def get_deltas_for_revisions(self, revisions):
580
return self._real_repository.get_deltas_for_revisions(revisions)
583
def get_revision_delta(self, revision_id):
585
return self._real_repository.get_revision_delta(revision_id)
588
def revision_trees(self, revision_ids):
590
return self._real_repository.revision_trees(revision_ids)
593
def get_revision_reconcile(self, revision_id):
595
return self._real_repository.get_revision_reconcile(revision_id)
598
def check(self, revision_ids):
600
return self._real_repository.check(revision_ids)
602
def copy_content_into(self, destination, revision_id=None):
604
return self._real_repository.copy_content_into(
605
destination, revision_id=revision_id)
607
def _copy_repository_tarball(self, destination, revision_id=None):
608
# get a tarball of the remote repository, and copy from that into the
610
from bzrlib import osutils
613
from StringIO import StringIO
614
# TODO: Maybe a progress bar while streaming the tarball?
615
note("Copying repository content as tarball...")
616
tar_file = self._get_tarball('bz2')
618
tar = tarfile.open('repository', fileobj=tar_file,
620
tmpdir = tempfile.mkdtemp()
622
_extract_tar(tar, tmpdir)
623
tmp_bzrdir = BzrDir.open(tmpdir)
624
tmp_repo = tmp_bzrdir.open_repository()
625
tmp_repo.copy_content_into(destination, revision_id)
627
osutils.rmtree(tmpdir)
630
# TODO: if the server doesn't support this operation, maybe do it the
631
# slow way using the _real_repository?
633
# TODO: Suggestion from john: using external tar is much faster than
634
# python's tarfile library, but it may not work on windows.
636
def set_make_working_trees(self, new_value):
637
raise NotImplementedError(self.set_make_working_trees)
640
def sign_revision(self, revision_id, gpg_strategy):
642
return self._real_repository.sign_revision(revision_id, gpg_strategy)
645
def get_revisions(self, revision_ids):
647
return self._real_repository.get_revisions(revision_ids)
649
def supports_rich_root(self):
651
return self._real_repository.supports_rich_root()
653
def iter_reverse_revision_history(self, revision_id):
655
return self._real_repository.iter_reverse_revision_history(revision_id)
658
def _serializer(self):
660
return self._real_repository._serializer
662
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
664
return self._real_repository.store_revision_signature(
665
gpg_strategy, plaintext, revision_id)
667
def has_signature_for_revision_id(self, revision_id):
669
return self._real_repository.has_signature_for_revision_id(revision_id)
672
class RemoteBranchLockableFiles(LockableFiles):
673
"""A 'LockableFiles' implementation that talks to a smart server.
675
This is not a public interface class.
678
def __init__(self, bzrdir, _client):
680
self._client = _client
681
self._need_find_modes = True
682
LockableFiles.__init__(
683
self, bzrdir.get_branch_transport(None),
684
'lock', lockdir.LockDir)
686
def _find_modes(self):
687
# RemoteBranches don't let the client set the mode of control files.
688
self._dir_mode = None
689
self._file_mode = None
692
"""'get' a remote path as per the LockableFiles interface.
694
:param path: the file to 'get'. If this is 'branch.conf', we do not
695
just retrieve a file, instead we ask the smart server to generate
696
a configuration for us - which is retrieved as an INI file.
698
if path == 'branch.conf':
699
path = self.bzrdir._path_for_remote_call(self._client)
700
response = self._client.call_expecting_body(
701
'Branch.get_config_file', path)
702
assert response[0][0] == 'ok', \
703
'unexpected response code %s' % (response[0],)
704
return StringIO(response[1].read_body_bytes())
707
return LockableFiles.get(self, path)
710
class RemoteBranchFormat(branch.BranchFormat):
712
def __eq__(self, other):
713
return (isinstance(other, RemoteBranchFormat) and
714
self.__dict__ == other.__dict__)
716
def get_format_description(self):
717
return 'Remote BZR Branch'
719
def get_format_string(self):
720
return 'Remote BZR Branch'
722
def open(self, a_bzrdir):
723
assert isinstance(a_bzrdir, RemoteBzrDir)
724
return a_bzrdir.open_branch()
726
def initialize(self, a_bzrdir):
727
assert isinstance(a_bzrdir, RemoteBzrDir)
728
return a_bzrdir.create_branch()
731
class RemoteBranch(branch.Branch):
732
"""Branch stored on a server accessed by HPSS RPC.
734
At the moment most operations are mapped down to simple file operations.
737
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
739
"""Create a RemoteBranch instance.
741
:param real_branch: An optional local implementation of the branch
742
format, usually accessing the data via the VFS.
743
:param _client: Private parameter for testing.
745
# We intentionally don't call the parent class's __init__, because it
746
# will try to assign to self.tags, which is a property in this subclass.
747
# And the parent's __init__ doesn't do much anyway.
748
self._revision_history_cache = None
749
self.bzrdir = remote_bzrdir
750
if _client is not None:
751
self._client = _client
753
self._client = client._SmartClient(self.bzrdir._medium)
754
self.repository = remote_repository
755
if real_branch is not None:
756
self._real_branch = real_branch
757
# Give the remote repository the matching real repo.
758
real_repo = self._real_branch.repository
759
if isinstance(real_repo, RemoteRepository):
760
real_repo._ensure_real()
761
real_repo = real_repo._real_repository
762
self.repository._set_real_repository(real_repo)
763
# Give the branch the remote repository to let fast-pathing happen.
764
self._real_branch.repository = self.repository
766
self._real_branch = None
767
# Fill out expected attributes of branch for bzrlib api users.
768
self._format = RemoteBranchFormat()
769
self.base = self.bzrdir.root_transport.base
770
self._control_files = None
771
self._lock_mode = None
772
self._lock_token = None
774
self._leave_lock = False
777
return "%s(%s)" % (self.__class__.__name__, self.base)
781
def _ensure_real(self):
782
"""Ensure that there is a _real_branch set.
784
Used before calls to self._real_branch.
786
if not self._real_branch:
787
assert vfs.vfs_enabled()
788
self.bzrdir._ensure_real()
789
self._real_branch = self.bzrdir._real_bzrdir.open_branch()
790
# Give the remote repository the matching real repo.
791
real_repo = self._real_branch.repository
792
if isinstance(real_repo, RemoteRepository):
793
real_repo._ensure_real()
794
real_repo = real_repo._real_repository
795
self.repository._set_real_repository(real_repo)
796
# Give the branch the remote repository to let fast-pathing happen.
797
self._real_branch.repository = self.repository
798
# XXX: deal with _lock_mode == 'w'
799
if self._lock_mode == 'r':
800
self._real_branch.lock_read()
803
def control_files(self):
804
# Defer actually creating RemoteBranchLockableFiles until its needed,
805
# because it triggers an _ensure_real that we otherwise might not need.
806
if self._control_files is None:
807
self._control_files = RemoteBranchLockableFiles(
808
self.bzrdir, self._client)
809
return self._control_files
811
def _get_checkout_format(self):
813
return self._real_branch._get_checkout_format()
815
def get_physical_lock_status(self):
816
"""See Branch.get_physical_lock_status()."""
817
# should be an API call to the server, as branches must be lockable.
819
return self._real_branch.get_physical_lock_status()
822
if not self._lock_mode:
823
self._lock_mode = 'r'
825
if self._real_branch is not None:
826
self._real_branch.lock_read()
828
self._lock_count += 1
830
def _remote_lock_write(self, token):
832
branch_token = repo_token = ''
835
repo_token = self.repository.lock_write()
836
self.repository.unlock()
837
path = self.bzrdir._path_for_remote_call(self._client)
838
response = self._client.call('Branch.lock_write', path, branch_token,
840
if response[0] == 'ok':
841
ok, branch_token, repo_token = response
842
return branch_token, repo_token
843
elif response[0] == 'LockContention':
844
raise errors.LockContention('(remote lock)')
845
elif response[0] == 'TokenMismatch':
846
raise errors.TokenMismatch(token, '(remote token)')
847
elif response[0] == 'UnlockableTransport':
848
raise errors.UnlockableTransport(self.bzrdir.root_transport)
849
elif response[0] == 'ReadOnlyError':
850
raise errors.ReadOnlyError(self)
852
assert False, 'unexpected response code %r' % (response,)
854
def lock_write(self, token=None):
855
if not self._lock_mode:
856
remote_tokens = self._remote_lock_write(token)
857
self._lock_token, self._repo_lock_token = remote_tokens
858
assert self._lock_token, 'Remote server did not return a token!'
859
# TODO: We really, really, really don't want to call _ensure_real
860
# here, but it's the easiest way to ensure coherency between the
861
# state of the RemoteBranch and RemoteRepository objects and the
862
# physical locks. If we don't materialise the real objects here,
863
# then getting everything in the right state later is complex, so
864
# for now we just do it the lazy way.
865
# -- Andrew Bennetts, 2007-02-22.
867
if self._real_branch is not None:
868
self._real_branch.repository.lock_write(
869
token=self._repo_lock_token)
871
self._real_branch.lock_write(token=self._lock_token)
873
self._real_branch.repository.unlock()
874
if token is not None:
875
self._leave_lock = True
877
# XXX: this case seems to be unreachable; token cannot be None.
878
self._leave_lock = False
879
self._lock_mode = 'w'
881
elif self._lock_mode == 'r':
882
raise errors.ReadOnlyTransaction
884
if token is not None:
885
# A token was given to lock_write, and we're relocking, so check
886
# that the given token actually matches the one we already have.
887
if token != self._lock_token:
888
raise errors.TokenMismatch(token, self._lock_token)
889
self._lock_count += 1
890
return self._lock_token
892
def _unlock(self, branch_token, repo_token):
893
path = self.bzrdir._path_for_remote_call(self._client)
894
response = self._client.call('Branch.unlock', path, branch_token,
896
if response == ('ok',):
898
elif response[0] == 'TokenMismatch':
899
raise errors.TokenMismatch(
900
str((branch_token, repo_token)), '(remote tokens)')
902
assert False, 'unexpected response code %s' % (response,)
905
self._lock_count -= 1
906
if not self._lock_count:
907
self._clear_cached_state()
908
mode = self._lock_mode
909
self._lock_mode = None
910
if self._real_branch is not None:
911
if not self._leave_lock:
912
# If this RemoteBranch will remove the physical lock for the
913
# repository, make sure the _real_branch doesn't do it
914
# first. (Because the _real_branch's repository is set to
915
# be the RemoteRepository.)
916
self._real_branch.repository.leave_lock_in_place()
917
self._real_branch.unlock()
919
# Only write-locked branched need to make a remote method call
920
# to perfom the unlock.
922
assert self._lock_token, 'Locked, but no token!'
923
branch_token = self._lock_token
924
repo_token = self._repo_lock_token
925
self._lock_token = None
926
self._repo_lock_token = None
927
if not self._leave_lock:
928
self._unlock(branch_token, repo_token)
930
def break_lock(self):
932
return self._real_branch.break_lock()
934
def leave_lock_in_place(self):
935
self._leave_lock = True
937
def dont_leave_lock_in_place(self):
938
self._leave_lock = False
940
def last_revision_info(self):
941
"""See Branch.last_revision_info()."""
942
path = self.bzrdir._path_for_remote_call(self._client)
943
response = self._client.call('Branch.last_revision_info', path)
944
assert response[0] == 'ok', 'unexpected response code %s' % (response,)
945
revno = int(response[1])
946
last_revision = response[2]
947
return (revno, last_revision)
949
def _gen_revision_history(self):
950
"""See Branch._gen_revision_history()."""
951
path = self.bzrdir._path_for_remote_call(self._client)
952
response = self._client.call_expecting_body(
953
'Branch.revision_history', path)
954
assert response[0][0] == 'ok', ('unexpected response code %s'
956
result = response[1].read_body_bytes().split('\x00')
962
def set_revision_history(self, rev_history):
963
# Send just the tip revision of the history; the server will generate
964
# the full history from that. If the revision doesn't exist in this
965
# branch, NoSuchRevision will be raised.
966
path = self.bzrdir._path_for_remote_call(self._client)
967
if rev_history == []:
970
rev_id = rev_history[-1]
971
self._clear_cached_state()
972
response = self._client.call('Branch.set_last_revision',
973
path, self._lock_token, self._repo_lock_token, rev_id)
974
if response[0] == 'NoSuchRevision':
975
raise NoSuchRevision(self, rev_id)
977
assert response == ('ok',), (
978
'unexpected response code %r' % (response,))
979
self._cache_revision_history(rev_history)
981
def get_parent(self):
983
return self._real_branch.get_parent()
985
def set_parent(self, url):
987
return self._real_branch.set_parent(url)
989
def get_config(self):
990
return RemoteBranchConfig(self)
992
def sprout(self, to_bzrdir, revision_id=None):
993
# Like Branch.sprout, except that it sprouts a branch in the default
994
# format, because RemoteBranches can't be created at arbitrary URLs.
995
# XXX: if to_bzrdir is a RemoteBranch, this should perhaps do
996
# to_bzrdir.create_branch...
997
result = branch.BranchFormat.get_default_format().initialize(to_bzrdir)
998
self.copy_content_into(result, revision_id=revision_id)
999
result.set_parent(self.bzrdir.root_transport.base)
1003
def append_revision(self, *revision_ids):
1005
return self._real_branch.append_revision(*revision_ids)
1008
def pull(self, source, overwrite=False, stop_revision=None,
1010
# FIXME: This asks the real branch to run the hooks, which means
1011
# they're called with the wrong target branch parameter.
1012
# The test suite specifically allows this at present but it should be
1013
# fixed. It should get a _override_hook_target branch,
1014
# as push does. -- mbp 20070405
1016
self._real_branch.pull(
1017
source, overwrite=overwrite, stop_revision=stop_revision,
1021
def push(self, target, overwrite=False, stop_revision=None):
1023
return self._real_branch.push(
1024
target, overwrite=overwrite, stop_revision=stop_revision,
1025
_override_hook_source_branch=self)
1027
def is_locked(self):
1028
return self._lock_count >= 1
1030
def set_last_revision_info(self, revno, revision_id):
1032
self._clear_cached_state()
1033
return self._real_branch.set_last_revision_info(revno, revision_id)
1035
def generate_revision_history(self, revision_id, last_rev=None,
1038
return self._real_branch.generate_revision_history(
1039
revision_id, last_rev=last_rev, other_branch=other_branch)
1044
return self._real_branch.tags
1046
def set_push_location(self, location):
1048
return self._real_branch.set_push_location(location)
1050
def update_revisions(self, other, stop_revision=None):
1052
return self._real_branch.update_revisions(
1053
other, stop_revision=stop_revision)
1056
class RemoteBranchConfig(BranchConfig):
1059
self.branch._ensure_real()
1060
return self.branch._real_branch.get_config().username()
1062
def _get_branch_data_config(self):
1063
self.branch._ensure_real()
1064
if self._branch_data_config is None:
1065
self._branch_data_config = TreeConfig(self.branch._real_branch)
1066
return self._branch_data_config
1069
def _extract_tar(tar, to_dir):
1070
"""Extract all the contents of a tarfile object.
1072
A replacement for extractall, which is not present in python2.4
1075
tar.extract(tarinfo, to_dir)
added
removed
bzrlib/remote.py
