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
raise errors.UnexpectedSmartServerResponse(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
raise errors.UnexpectedSmartServerResponse(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
raise errors.UnexpectedSmartServerResponse(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_serializer_format(self):
475
return self._real_repository.get_serializer_format()
477
def get_commit_builder(self, branch, parents, config, timestamp=None,
478
timezone=None, committer=None, revprops=None,
480
# FIXME: It ought to be possible to call this without immediately
481
# triggering _ensure_real. For now it's the easiest thing to do.
483
builder = self._real_repository.get_commit_builder(branch, parents,
484
config, timestamp=timestamp, timezone=timezone,
485
committer=committer, revprops=revprops, revision_id=revision_id)
486
# Make the builder use this RemoteRepository rather than the real one.
487
builder.repository = self
491
def add_inventory(self, revid, inv, parents):
493
return self._real_repository.add_inventory(revid, inv, parents)
496
def add_revision(self, rev_id, rev, inv=None, config=None):
498
return self._real_repository.add_revision(
499
rev_id, rev, inv=inv, config=config)
502
def get_inventory(self, revision_id):
504
return self._real_repository.get_inventory(revision_id)
507
def get_revision(self, revision_id):
509
return self._real_repository.get_revision(revision_id)
512
def weave_store(self):
514
return self._real_repository.weave_store
516
def get_transaction(self):
518
return self._real_repository.get_transaction()
521
def clone(self, a_bzrdir, revision_id=None):
523
return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
525
def make_working_trees(self):
526
"""RemoteRepositories never create working trees by default."""
529
def fetch(self, source, revision_id=None, pb=None):
531
return self._real_repository.fetch(
532
source, revision_id=revision_id, pb=pb)
534
def create_bundle(self, target, base, fileobj, format=None):
536
self._real_repository.create_bundle(target, base, fileobj, format)
539
def control_weaves(self):
541
return self._real_repository.control_weaves
544
def get_ancestry(self, revision_id, topo_sorted=True):
546
return self._real_repository.get_ancestry(revision_id, topo_sorted)
549
def get_inventory_weave(self):
551
return self._real_repository.get_inventory_weave()
553
def fileids_altered_by_revision_ids(self, revision_ids):
555
return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
558
def get_signature_text(self, revision_id):
560
return self._real_repository.get_signature_text(revision_id)
563
def get_revision_graph_with_ghosts(self, revision_ids=None):
565
return self._real_repository.get_revision_graph_with_ghosts(
566
revision_ids=revision_ids)
569
def get_inventory_xml(self, revision_id):
571
return self._real_repository.get_inventory_xml(revision_id)
573
def deserialise_inventory(self, revision_id, xml):
575
return self._real_repository.deserialise_inventory(revision_id, xml)
577
def reconcile(self, other=None, thorough=False):
579
return self._real_repository.reconcile(other=other, thorough=thorough)
581
def all_revision_ids(self):
583
return self._real_repository.all_revision_ids()
586
def get_deltas_for_revisions(self, revisions):
588
return self._real_repository.get_deltas_for_revisions(revisions)
591
def get_revision_delta(self, revision_id):
593
return self._real_repository.get_revision_delta(revision_id)
596
def revision_trees(self, revision_ids):
598
return self._real_repository.revision_trees(revision_ids)
601
def get_revision_reconcile(self, revision_id):
603
return self._real_repository.get_revision_reconcile(revision_id)
606
def check(self, revision_ids):
608
return self._real_repository.check(revision_ids)
610
def copy_content_into(self, destination, revision_id=None):
612
return self._real_repository.copy_content_into(
613
destination, revision_id=revision_id)
615
def _copy_repository_tarball(self, destination, revision_id=None):
616
# get a tarball of the remote repository, and copy from that into the
618
from bzrlib import osutils
621
from StringIO import StringIO
622
# TODO: Maybe a progress bar while streaming the tarball?
623
note("Copying repository content as tarball...")
624
tar_file = self._get_tarball('bz2')
626
tar = tarfile.open('repository', fileobj=tar_file,
628
tmpdir = tempfile.mkdtemp()
630
_extract_tar(tar, tmpdir)
631
tmp_bzrdir = BzrDir.open(tmpdir)
632
tmp_repo = tmp_bzrdir.open_repository()
633
tmp_repo.copy_content_into(destination, revision_id)
635
osutils.rmtree(tmpdir)
638
# TODO: if the server doesn't support this operation, maybe do it the
639
# slow way using the _real_repository?
641
# TODO: Suggestion from john: using external tar is much faster than
642
# python's tarfile library, but it may not work on windows.
644
def set_make_working_trees(self, new_value):
645
raise NotImplementedError(self.set_make_working_trees)
648
def sign_revision(self, revision_id, gpg_strategy):
650
return self._real_repository.sign_revision(revision_id, gpg_strategy)
653
def get_revisions(self, revision_ids):
655
return self._real_repository.get_revisions(revision_ids)
657
def supports_rich_root(self):
659
return self._real_repository.supports_rich_root()
661
def iter_reverse_revision_history(self, revision_id):
663
return self._real_repository.iter_reverse_revision_history(revision_id)
666
def _serializer(self):
668
return self._real_repository._serializer
670
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
672
return self._real_repository.store_revision_signature(
673
gpg_strategy, plaintext, revision_id)
675
def has_signature_for_revision_id(self, revision_id):
677
return self._real_repository.has_signature_for_revision_id(revision_id)
680
class RemoteBranchLockableFiles(LockableFiles):
681
"""A 'LockableFiles' implementation that talks to a smart server.
683
This is not a public interface class.
686
def __init__(self, bzrdir, _client):
688
self._client = _client
689
self._need_find_modes = True
690
LockableFiles.__init__(
691
self, bzrdir.get_branch_transport(None),
692
'lock', lockdir.LockDir)
694
def _find_modes(self):
695
# RemoteBranches don't let the client set the mode of control files.
696
self._dir_mode = None
697
self._file_mode = None
700
"""'get' a remote path as per the LockableFiles interface.
702
:param path: the file to 'get'. If this is 'branch.conf', we do not
703
just retrieve a file, instead we ask the smart server to generate
704
a configuration for us - which is retrieved as an INI file.
706
if path == 'branch.conf':
707
path = self.bzrdir._path_for_remote_call(self._client)
708
response = self._client.call_expecting_body(
709
'Branch.get_config_file', path)
710
assert response[0][0] == 'ok', \
711
'unexpected response code %s' % (response[0],)
712
return StringIO(response[1].read_body_bytes())
715
return LockableFiles.get(self, path)
718
class RemoteBranchFormat(branch.BranchFormat):
720
def __eq__(self, other):
721
return (isinstance(other, RemoteBranchFormat) and
722
self.__dict__ == other.__dict__)
724
def get_format_description(self):
725
return 'Remote BZR Branch'
727
def get_format_string(self):
728
return 'Remote BZR Branch'
730
def open(self, a_bzrdir):
731
assert isinstance(a_bzrdir, RemoteBzrDir)
732
return a_bzrdir.open_branch()
734
def initialize(self, a_bzrdir):
735
assert isinstance(a_bzrdir, RemoteBzrDir)
736
return a_bzrdir.create_branch()
739
class RemoteBranch(branch.Branch):
740
"""Branch stored on a server accessed by HPSS RPC.
742
At the moment most operations are mapped down to simple file operations.
745
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
747
"""Create a RemoteBranch instance.
749
:param real_branch: An optional local implementation of the branch
750
format, usually accessing the data via the VFS.
751
:param _client: Private parameter for testing.
753
# We intentionally don't call the parent class's __init__, because it
754
# will try to assign to self.tags, which is a property in this subclass.
755
# And the parent's __init__ doesn't do much anyway.
756
self._revision_history_cache = None
757
self.bzrdir = remote_bzrdir
758
if _client is not None:
759
self._client = _client
761
self._client = client._SmartClient(self.bzrdir._medium)
762
self.repository = remote_repository
763
if real_branch is not None:
764
self._real_branch = real_branch
765
# Give the remote repository the matching real repo.
766
real_repo = self._real_branch.repository
767
if isinstance(real_repo, RemoteRepository):
768
real_repo._ensure_real()
769
real_repo = real_repo._real_repository
770
self.repository._set_real_repository(real_repo)
771
# Give the branch the remote repository to let fast-pathing happen.
772
self._real_branch.repository = self.repository
774
self._real_branch = None
775
# Fill out expected attributes of branch for bzrlib api users.
776
self._format = RemoteBranchFormat()
777
self.base = self.bzrdir.root_transport.base
778
self._control_files = None
779
self._lock_mode = None
780
self._lock_token = None
782
self._leave_lock = False
785
return "%s(%s)" % (self.__class__.__name__, self.base)
789
def _ensure_real(self):
790
"""Ensure that there is a _real_branch set.
792
Used before calls to self._real_branch.
794
if not self._real_branch:
795
assert vfs.vfs_enabled()
796
self.bzrdir._ensure_real()
797
self._real_branch = self.bzrdir._real_bzrdir.open_branch()
798
# Give the remote repository the matching real repo.
799
real_repo = self._real_branch.repository
800
if isinstance(real_repo, RemoteRepository):
801
real_repo._ensure_real()
802
real_repo = real_repo._real_repository
803
self.repository._set_real_repository(real_repo)
804
# Give the branch the remote repository to let fast-pathing happen.
805
self._real_branch.repository = self.repository
806
# XXX: deal with _lock_mode == 'w'
807
if self._lock_mode == 'r':
808
self._real_branch.lock_read()
811
def control_files(self):
812
# Defer actually creating RemoteBranchLockableFiles until its needed,
813
# because it triggers an _ensure_real that we otherwise might not need.
814
if self._control_files is None:
815
self._control_files = RemoteBranchLockableFiles(
816
self.bzrdir, self._client)
817
return self._control_files
819
def _get_checkout_format(self):
821
return self._real_branch._get_checkout_format()
823
def get_physical_lock_status(self):
824
"""See Branch.get_physical_lock_status()."""
825
# should be an API call to the server, as branches must be lockable.
827
return self._real_branch.get_physical_lock_status()
830
if not self._lock_mode:
831
self._lock_mode = 'r'
833
if self._real_branch is not None:
834
self._real_branch.lock_read()
836
self._lock_count += 1
838
def _remote_lock_write(self, token):
840
branch_token = repo_token = ''
843
repo_token = self.repository.lock_write()
844
self.repository.unlock()
845
path = self.bzrdir._path_for_remote_call(self._client)
846
response = self._client.call('Branch.lock_write', path, branch_token,
848
if response[0] == 'ok':
849
ok, branch_token, repo_token = response
850
return branch_token, repo_token
851
elif response[0] == 'LockContention':
852
raise errors.LockContention('(remote lock)')
853
elif response[0] == 'TokenMismatch':
854
raise errors.TokenMismatch(token, '(remote token)')
855
elif response[0] == 'UnlockableTransport':
856
raise errors.UnlockableTransport(self.bzrdir.root_transport)
857
elif response[0] == 'ReadOnlyError':
858
raise errors.ReadOnlyError(self)
860
raise errors.UnexpectedSmartServerResponse(response)
862
def lock_write(self, token=None):
863
if not self._lock_mode:
864
remote_tokens = self._remote_lock_write(token)
865
self._lock_token, self._repo_lock_token = remote_tokens
866
assert self._lock_token, 'Remote server did not return a token!'
867
# TODO: We really, really, really don't want to call _ensure_real
868
# here, but it's the easiest way to ensure coherency between the
869
# state of the RemoteBranch and RemoteRepository objects and the
870
# physical locks. If we don't materialise the real objects here,
871
# then getting everything in the right state later is complex, so
872
# for now we just do it the lazy way.
873
# -- Andrew Bennetts, 2007-02-22.
875
if self._real_branch is not None:
876
self._real_branch.repository.lock_write(
877
token=self._repo_lock_token)
879
self._real_branch.lock_write(token=self._lock_token)
881
self._real_branch.repository.unlock()
882
if token is not None:
883
self._leave_lock = True
885
# XXX: this case seems to be unreachable; token cannot be None.
886
self._leave_lock = False
887
self._lock_mode = 'w'
889
elif self._lock_mode == 'r':
890
raise errors.ReadOnlyTransaction
892
if token is not None:
893
# A token was given to lock_write, and we're relocking, so check
894
# that the given token actually matches the one we already have.
895
if token != self._lock_token:
896
raise errors.TokenMismatch(token, self._lock_token)
897
self._lock_count += 1
898
return self._lock_token
900
def _unlock(self, branch_token, repo_token):
901
path = self.bzrdir._path_for_remote_call(self._client)
902
response = self._client.call('Branch.unlock', path, branch_token,
904
if response == ('ok',):
906
elif response[0] == 'TokenMismatch':
907
raise errors.TokenMismatch(
908
str((branch_token, repo_token)), '(remote tokens)')
910
raise errors.UnexpectedSmartServerResponse(response)
913
self._lock_count -= 1
914
if not self._lock_count:
915
self._clear_cached_state()
916
mode = self._lock_mode
917
self._lock_mode = None
918
if self._real_branch is not None:
919
if not self._leave_lock:
920
# If this RemoteBranch will remove the physical lock for the
921
# repository, make sure the _real_branch doesn't do it
922
# first. (Because the _real_branch's repository is set to
923
# be the RemoteRepository.)
924
self._real_branch.repository.leave_lock_in_place()
925
self._real_branch.unlock()
927
# Only write-locked branched need to make a remote method call
928
# to perfom the unlock.
930
assert self._lock_token, 'Locked, but no token!'
931
branch_token = self._lock_token
932
repo_token = self._repo_lock_token
933
self._lock_token = None
934
self._repo_lock_token = None
935
if not self._leave_lock:
936
self._unlock(branch_token, repo_token)
938
def break_lock(self):
940
return self._real_branch.break_lock()
942
def leave_lock_in_place(self):
943
self._leave_lock = True
945
def dont_leave_lock_in_place(self):
946
self._leave_lock = False
948
def last_revision_info(self):
949
"""See Branch.last_revision_info()."""
950
path = self.bzrdir._path_for_remote_call(self._client)
951
response = self._client.call('Branch.last_revision_info', path)
952
assert response[0] == 'ok', 'unexpected response code %s' % (response,)
953
revno = int(response[1])
954
last_revision = response[2]
955
return (revno, last_revision)
957
def _gen_revision_history(self):
958
"""See Branch._gen_revision_history()."""
959
path = self.bzrdir._path_for_remote_call(self._client)
960
response = self._client.call_expecting_body(
961
'Branch.revision_history', path)
962
assert response[0][0] == 'ok', ('unexpected response code %s'
964
result = response[1].read_body_bytes().split('\x00')
970
def set_revision_history(self, rev_history):
971
# Send just the tip revision of the history; the server will generate
972
# the full history from that. If the revision doesn't exist in this
973
# branch, NoSuchRevision will be raised.
974
path = self.bzrdir._path_for_remote_call(self._client)
975
if rev_history == []:
978
rev_id = rev_history[-1]
979
self._clear_cached_state()
980
response = self._client.call('Branch.set_last_revision',
981
path, self._lock_token, self._repo_lock_token, rev_id)
982
if response[0] == 'NoSuchRevision':
983
raise NoSuchRevision(self, rev_id)
985
assert response == ('ok',), (
986
'unexpected response code %r' % (response,))
987
self._cache_revision_history(rev_history)
989
def get_parent(self):
991
return self._real_branch.get_parent()
993
def set_parent(self, url):
995
return self._real_branch.set_parent(url)
997
def get_config(self):
998
return RemoteBranchConfig(self)
1000
def sprout(self, to_bzrdir, revision_id=None):
1001
# Like Branch.sprout, except that it sprouts a branch in the default
1002
# format, because RemoteBranches can't be created at arbitrary URLs.
1003
# XXX: if to_bzrdir is a RemoteBranch, this should perhaps do
1004
# to_bzrdir.create_branch...
1005
result = branch.BranchFormat.get_default_format().initialize(to_bzrdir)
1006
self.copy_content_into(result, revision_id=revision_id)
1007
result.set_parent(self.bzrdir.root_transport.base)
1011
def append_revision(self, *revision_ids):
1013
return self._real_branch.append_revision(*revision_ids)
1016
def pull(self, source, overwrite=False, stop_revision=None,
1018
# FIXME: This asks the real branch to run the hooks, which means
1019
# they're called with the wrong target branch parameter.
1020
# The test suite specifically allows this at present but it should be
1021
# fixed. It should get a _override_hook_target branch,
1022
# as push does. -- mbp 20070405
1024
self._real_branch.pull(
1025
source, overwrite=overwrite, stop_revision=stop_revision,
1029
def push(self, target, overwrite=False, stop_revision=None):
1031
return self._real_branch.push(
1032
target, overwrite=overwrite, stop_revision=stop_revision,
1033
_override_hook_source_branch=self)
1035
def is_locked(self):
1036
return self._lock_count >= 1
1038
def set_last_revision_info(self, revno, revision_id):
1040
self._clear_cached_state()
1041
return self._real_branch.set_last_revision_info(revno, revision_id)
1043
def generate_revision_history(self, revision_id, last_rev=None,
1046
return self._real_branch.generate_revision_history(
1047
revision_id, last_rev=last_rev, other_branch=other_branch)
1052
return self._real_branch.tags
1054
def set_push_location(self, location):
1056
return self._real_branch.set_push_location(location)
1058
def update_revisions(self, other, stop_revision=None):
1060
return self._real_branch.update_revisions(
1061
other, stop_revision=stop_revision)
1064
class RemoteBranchConfig(BranchConfig):
1067
self.branch._ensure_real()
1068
return self.branch._real_branch.get_config().username()
1070
def _get_branch_data_config(self):
1071
self.branch._ensure_real()
1072
if self._branch_data_config is None:
1073
self._branch_data_config = TreeConfig(self.branch._real_branch)
1074
return self._branch_data_config
1077
def _extract_tar(tar, to_dir):
1078
"""Extract all the contents of a tarfile object.
1080
A replacement for extractall, which is not present in python2.4
1083
tar.extract(tarinfo, to_dir)
added
removed
bzrlib/remote.py
