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.pack import ContainerReader
35
from bzrlib.revision import NULL_REVISION
36
from bzrlib.smart import client, vfs
37
from bzrlib.symbol_versioning import (
41
from bzrlib.trace import note
43
# Note: RemoteBzrDirFormat is in bzrdir.py
45
class RemoteBzrDir(BzrDir):
46
"""Control directory on a remote server, accessed via bzr:// or similar."""
48
def __init__(self, transport, _client=None):
49
"""Construct a RemoteBzrDir.
51
:param _client: Private parameter for testing. Disables probing and the
54
BzrDir.__init__(self, transport, RemoteBzrDirFormat())
55
# this object holds a delegated bzrdir that uses file-level operations
56
# to talk to the other side
57
self._real_bzrdir = None
60
self._shared_medium = transport.get_shared_medium()
61
self._client = client._SmartClient(self._shared_medium)
63
self._client = _client
64
self._shared_medium = None
67
path = self._path_for_remote_call(self._client)
68
response = self._client.call('BzrDir.open', path)
69
if response not in [('yes',), ('no',)]:
70
raise errors.UnexpectedSmartServerResponse(response)
71
if response == ('no',):
72
raise errors.NotBranchError(path=transport.base)
74
def _ensure_real(self):
75
"""Ensure that there is a _real_bzrdir set.
77
Used before calls to self._real_bzrdir.
79
if not self._real_bzrdir:
80
self._real_bzrdir = BzrDir.open_from_transport(
81
self.root_transport, _server_formats=False)
83
def create_repository(self, shared=False):
85
self._real_bzrdir.create_repository(shared=shared)
86
return self.open_repository()
88
def create_branch(self):
90
real_branch = self._real_bzrdir.create_branch()
91
return RemoteBranch(self, self.find_repository(), real_branch)
93
def destroy_branch(self):
94
"""See BzrDir.destroy_branch"""
96
self._real_bzrdir.destroy_branch()
98
def create_workingtree(self, revision_id=None):
99
raise errors.NotLocalUrl(self.transport.base)
101
def find_branch_format(self):
102
"""Find the branch 'format' for this bzrdir.
104
This might be a synthetic object for e.g. RemoteBranch and SVN.
106
b = self.open_branch()
109
def get_branch_reference(self):
110
"""See BzrDir.get_branch_reference()."""
111
path = self._path_for_remote_call(self._client)
112
response = self._client.call('BzrDir.open_branch', path)
113
if response[0] == 'ok':
114
if response[1] == '':
115
# branch at this location.
118
# a branch reference, use the existing BranchReference logic.
120
elif response == ('nobranch',):
121
raise errors.NotBranchError(path=self.root_transport.base)
123
raise errors.UnexpectedSmartServerResponse(response)
125
def open_branch(self, _unsupported=False):
126
assert _unsupported == False, 'unsupported flag support not implemented yet.'
127
reference_url = self.get_branch_reference()
128
if reference_url is None:
129
# branch at this location.
130
return RemoteBranch(self, self.find_repository())
132
# a branch reference, use the existing BranchReference logic.
133
format = BranchReferenceFormat()
134
return format.open(self, _found=True, location=reference_url)
136
def open_repository(self):
137
path = self._path_for_remote_call(self._client)
138
response = self._client.call('BzrDir.find_repository', path)
139
assert response[0] in ('ok', 'norepository'), \
140
'unexpected response code %s' % (response,)
141
if response[0] == 'norepository':
142
raise errors.NoRepositoryPresent(self)
143
assert len(response) == 4, 'incorrect response length %s' % (response,)
144
if response[1] == '':
145
format = RemoteRepositoryFormat()
146
format.rich_root_data = (response[2] == 'yes')
147
format.supports_tree_reference = (response[3] == 'yes')
148
return RemoteRepository(self, format)
150
raise errors.NoRepositoryPresent(self)
152
def open_workingtree(self, recommend_upgrade=True):
154
if self._real_bzrdir.has_workingtree():
155
raise errors.NotLocalUrl(self.root_transport)
157
raise errors.NoWorkingTree(self.root_transport.base)
159
def _path_for_remote_call(self, client):
160
"""Return the path to be used for this bzrdir in a remote call."""
161
return client.remote_path_from_transport(self.root_transport)
163
def get_branch_transport(self, branch_format):
165
return self._real_bzrdir.get_branch_transport(branch_format)
167
def get_repository_transport(self, repository_format):
169
return self._real_bzrdir.get_repository_transport(repository_format)
171
def get_workingtree_transport(self, workingtree_format):
173
return self._real_bzrdir.get_workingtree_transport(workingtree_format)
175
def can_convert_format(self):
176
"""Upgrading of remote bzrdirs is not supported yet."""
179
def needs_format_conversion(self, format=None):
180
"""Upgrading of remote bzrdirs is not supported yet."""
183
def clone(self, url, revision_id=None, force_new_repo=False):
185
return self._real_bzrdir.clone(url, revision_id=revision_id,
186
force_new_repo=force_new_repo)
189
class RemoteRepositoryFormat(repository.RepositoryFormat):
190
"""Format for repositories accessed over a _SmartClient.
192
Instances of this repository are represented by RemoteRepository
195
The RemoteRepositoryFormat is parameterised during construction
196
to reflect the capabilities of the real, remote format. Specifically
197
the attributes rich_root_data and supports_tree_reference are set
198
on a per instance basis, and are not set (and should not be) at
202
_matchingbzrdir = RemoteBzrDirFormat
204
def initialize(self, a_bzrdir, shared=False):
205
assert isinstance(a_bzrdir, RemoteBzrDir), \
206
'%r is not a RemoteBzrDir' % (a_bzrdir,)
207
return a_bzrdir.create_repository(shared=shared)
209
def open(self, a_bzrdir):
210
assert isinstance(a_bzrdir, RemoteBzrDir)
211
return a_bzrdir.open_repository()
213
def get_format_description(self):
214
return 'bzr remote repository'
216
def __eq__(self, other):
217
return self.__class__ == other.__class__
219
def check_conversion_target(self, target_format):
220
if self.rich_root_data and not target_format.rich_root_data:
221
raise errors.BadConversionTarget(
222
'Does not support rich root data.', target_format)
223
if (self.supports_tree_reference and
224
not getattr(target_format, 'supports_tree_reference', False)):
225
raise errors.BadConversionTarget(
226
'Does not support nested trees', target_format)
229
class RemoteRepository(object):
230
"""Repository accessed over rpc.
232
For the moment most operations are performed using local transport-backed
236
def __init__(self, remote_bzrdir, format, real_repository=None, _client=None):
237
"""Create a RemoteRepository instance.
239
:param remote_bzrdir: The bzrdir hosting this repository.
240
:param format: The RemoteFormat object to use.
241
:param real_repository: If not None, a local implementation of the
242
repository logic for the repository, usually accessing the data
244
:param _client: Private testing parameter - override the smart client
245
to be used by the repository.
248
self._real_repository = real_repository
250
self._real_repository = None
251
self.bzrdir = remote_bzrdir
253
self._client = client._SmartClient(self.bzrdir._shared_medium)
255
self._client = _client
256
self._format = format
257
self._lock_mode = None
258
self._lock_token = None
260
self._leave_lock = False
262
self._reconcile_does_inventory_gc = True
263
self._reconcile_fixes_text_parents = True
264
self.base = self.bzrdir.transport.base
267
return "%s(%s)" % (self.__class__.__name__, self.base)
271
def abort_write_group(self):
272
"""Complete a write group on the decorated repository.
274
Smart methods peform operations in a single step so this api
275
is not really applicable except as a compatibility thunk
276
for older plugins that don't use e.g. the CommitBuilder
280
return self._real_repository.abort_write_group()
282
def commit_write_group(self):
283
"""Complete a write group on the decorated repository.
285
Smart methods peform operations in a single step so this api
286
is not really applicable except as a compatibility thunk
287
for older plugins that don't use e.g. the CommitBuilder
291
return self._real_repository.commit_write_group()
293
def _ensure_real(self):
294
"""Ensure that there is a _real_repository set.
296
Used before calls to self._real_repository.
298
if not self._real_repository:
299
self.bzrdir._ensure_real()
300
#self._real_repository = self.bzrdir._real_bzrdir.open_repository()
301
self._set_real_repository(self.bzrdir._real_bzrdir.open_repository())
303
def get_revision_graph(self, revision_id=None):
304
"""See Repository.get_revision_graph()."""
305
if revision_id is None:
307
elif revision_id == NULL_REVISION:
310
path = self.bzrdir._path_for_remote_call(self._client)
311
assert type(revision_id) is str
312
response = self._client.call_expecting_body(
313
'Repository.get_revision_graph', path, revision_id)
314
if response[0][0] not in ['ok', 'nosuchrevision']:
315
raise errors.UnexpectedSmartServerResponse(response[0])
316
if response[0][0] == 'ok':
317
coded = response[1].read_body_bytes()
319
# no revisions in this repository!
321
lines = coded.split('\n')
324
d = tuple(line.split())
325
revision_graph[d[0]] = d[1:]
327
return revision_graph
329
response_body = response[1].read_body_bytes()
330
assert response_body == ''
331
raise NoSuchRevision(self, revision_id)
333
def has_revision(self, revision_id):
334
"""See Repository.has_revision()."""
335
if revision_id is None:
336
# The null revision is always present.
338
path = self.bzrdir._path_for_remote_call(self._client)
339
response = self._client.call('Repository.has_revision', path, revision_id)
340
assert response[0] in ('yes', 'no'), 'unexpected response code %s' % (response,)
341
return response[0] == 'yes'
343
def has_same_location(self, other):
344
return (self.__class__ == other.__class__ and
345
self.bzrdir.transport.base == other.bzrdir.transport.base)
347
def get_graph(self, other_repository=None):
348
"""Return the graph for this repository format"""
350
return self._real_repository.get_graph(other_repository)
352
def gather_stats(self, revid=None, committers=None):
353
"""See Repository.gather_stats()."""
354
path = self.bzrdir._path_for_remote_call(self._client)
355
if revid in (None, NULL_REVISION):
359
if committers is None or not committers:
360
fmt_committers = 'no'
362
fmt_committers = 'yes'
363
response = self._client.call_expecting_body(
364
'Repository.gather_stats', path, fmt_revid, fmt_committers)
365
assert response[0][0] == 'ok', \
366
'unexpected response code %s' % (response[0],)
368
body = response[1].read_body_bytes()
370
for line in body.split('\n'):
373
key, val_text = line.split(':')
374
if key in ('revisions', 'size', 'committers'):
375
result[key] = int(val_text)
376
elif key in ('firstrev', 'latestrev'):
377
values = val_text.split(' ')[1:]
378
result[key] = (float(values[0]), long(values[1]))
382
def get_physical_lock_status(self):
383
"""See Repository.get_physical_lock_status()."""
386
def is_in_write_group(self):
387
"""Return True if there is an open write group.
389
write groups are only applicable locally for the smart server..
391
if self._real_repository:
392
return self._real_repository.is_in_write_group()
395
return self._lock_count >= 1
398
"""See Repository.is_shared()."""
399
path = self.bzrdir._path_for_remote_call(self._client)
400
response = self._client.call('Repository.is_shared', path)
401
assert response[0] in ('yes', 'no'), 'unexpected response code %s' % (response,)
402
return response[0] == 'yes'
404
def is_write_locked(self):
405
return self._lock_mode == 'w'
408
# wrong eventually - want a local lock cache context
409
if not self._lock_mode:
410
self._lock_mode = 'r'
412
if self._real_repository is not None:
413
self._real_repository.lock_read()
415
self._lock_count += 1
417
def _remote_lock_write(self, token):
418
path = self.bzrdir._path_for_remote_call(self._client)
421
response = self._client.call('Repository.lock_write', path, token)
422
if response[0] == 'ok':
425
elif response[0] == 'LockContention':
426
raise errors.LockContention('(remote lock)')
427
elif response[0] == 'UnlockableTransport':
428
raise errors.UnlockableTransport(self.bzrdir.root_transport)
429
elif response[0] == 'LockFailed':
430
raise errors.LockFailed(response[1], response[2])
432
raise errors.UnexpectedSmartServerResponse(response)
434
def lock_write(self, token=None):
435
if not self._lock_mode:
436
self._lock_token = self._remote_lock_write(token)
437
assert self._lock_token, 'Remote server did not return a token!'
438
if self._real_repository is not None:
439
self._real_repository.lock_write(token=self._lock_token)
440
if token is not None:
441
self._leave_lock = True
443
self._leave_lock = False
444
self._lock_mode = 'w'
446
elif self._lock_mode == 'r':
447
raise errors.ReadOnlyError(self)
449
self._lock_count += 1
450
return self._lock_token
452
def leave_lock_in_place(self):
453
self._leave_lock = True
455
def dont_leave_lock_in_place(self):
456
self._leave_lock = False
458
def _set_real_repository(self, repository):
459
"""Set the _real_repository for this repository.
461
:param repository: The repository to fallback to for non-hpss
462
implemented operations.
464
assert not isinstance(repository, RemoteRepository)
465
self._real_repository = repository
466
if self._lock_mode == 'w':
467
# if we are already locked, the real repository must be able to
468
# acquire the lock with our token.
469
self._real_repository.lock_write(self._lock_token)
470
elif self._lock_mode == 'r':
471
self._real_repository.lock_read()
473
def start_write_group(self):
474
"""Start a write group on the decorated repository.
476
Smart methods peform operations in a single step so this api
477
is not really applicable except as a compatibility thunk
478
for older plugins that don't use e.g. the CommitBuilder
482
return self._real_repository.start_write_group()
484
def _unlock(self, token):
485
path = self.bzrdir._path_for_remote_call(self._client)
486
response = self._client.call('Repository.unlock', path, token)
487
if response == ('ok',):
489
elif response[0] == 'TokenMismatch':
490
raise errors.TokenMismatch(token, '(remote token)')
492
raise errors.UnexpectedSmartServerResponse(response)
495
if self._lock_count == 1 and self._lock_mode == 'w':
496
# don't unlock if inside a write group.
497
if self.is_in_write_group():
498
raise errors.BzrError(
499
'Must end write groups before releasing write locks.')
500
self._lock_count -= 1
501
if not self._lock_count:
502
mode = self._lock_mode
503
self._lock_mode = None
504
if self._real_repository is not None:
505
self._real_repository.unlock()
507
# Only write-locked repositories need to make a remote method
508
# call to perfom the unlock.
510
assert self._lock_token, 'Locked, but no token!'
511
token = self._lock_token
512
self._lock_token = None
513
if not self._leave_lock:
516
def break_lock(self):
517
# should hand off to the network
519
return self._real_repository.break_lock()
521
def _get_tarball(self, compression):
522
"""Return a TemporaryFile containing a repository tarball.
524
Returns None if the server does not support sending tarballs.
527
path = self.bzrdir._path_for_remote_call(self._client)
528
response, protocol = self._client.call_expecting_body(
529
'Repository.tarball', path, compression)
530
if response[0] == 'ok':
531
# Extract the tarball and return it
532
t = tempfile.NamedTemporaryFile()
533
# TODO: rpc layer should read directly into it...
534
t.write(protocol.read_body_bytes())
537
if (response == ('error', "Generic bzr smart protocol error: "
538
"bad request 'Repository.tarball'") or
539
response == ('error', "Generic bzr smart protocol error: "
540
"bad request u'Repository.tarball'")):
541
protocol.cancel_read_body()
543
raise errors.UnexpectedSmartServerResponse(response)
545
def sprout(self, to_bzrdir, revision_id=None):
546
# TODO: Option to control what format is created?
547
dest_repo = to_bzrdir.create_repository()
548
dest_repo.fetch(self, revision_id=revision_id)
551
### These methods are just thin shims to the VFS object for now.
553
def revision_tree(self, revision_id):
555
return self._real_repository.revision_tree(revision_id)
557
def get_serializer_format(self):
559
return self._real_repository.get_serializer_format()
561
def get_commit_builder(self, branch, parents, config, timestamp=None,
562
timezone=None, committer=None, revprops=None,
564
# FIXME: It ought to be possible to call this without immediately
565
# triggering _ensure_real. For now it's the easiest thing to do.
567
builder = self._real_repository.get_commit_builder(branch, parents,
568
config, timestamp=timestamp, timezone=timezone,
569
committer=committer, revprops=revprops, revision_id=revision_id)
570
# Make the builder use this RemoteRepository rather than the real one.
571
builder.repository = self
575
def add_inventory(self, revid, inv, parents):
577
return self._real_repository.add_inventory(revid, inv, parents)
580
def add_revision(self, rev_id, rev, inv=None, config=None):
582
return self._real_repository.add_revision(
583
rev_id, rev, inv=inv, config=config)
586
def get_inventory(self, revision_id):
588
return self._real_repository.get_inventory(revision_id)
591
def get_revision(self, revision_id):
593
return self._real_repository.get_revision(revision_id)
596
def weave_store(self):
598
return self._real_repository.weave_store
600
def get_transaction(self):
602
return self._real_repository.get_transaction()
605
def clone(self, a_bzrdir, revision_id=None):
607
return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
609
def make_working_trees(self):
610
"""RemoteRepositories never create working trees by default."""
613
def fetch(self, source, revision_id=None, pb=None):
614
if self.has_same_location(source):
615
# check that last_revision is in 'from' and then return a
617
if (revision_id is not None and
618
not _mod_revision.is_null(revision_id)):
619
self.get_revision(revision_id)
622
return self._real_repository.fetch(
623
source, revision_id=revision_id, pb=pb)
625
def create_bundle(self, target, base, fileobj, format=None):
627
self._real_repository.create_bundle(target, base, fileobj, format)
630
def control_weaves(self):
632
return self._real_repository.control_weaves
635
def get_ancestry(self, revision_id, topo_sorted=True):
637
return self._real_repository.get_ancestry(revision_id, topo_sorted)
640
def get_inventory_weave(self):
642
return self._real_repository.get_inventory_weave()
644
def fileids_altered_by_revision_ids(self, revision_ids):
646
return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
648
def get_versioned_file_checker(self, revisions, revision_versions_cache):
650
return self._real_repository.get_versioned_file_checker(
651
revisions, revision_versions_cache)
653
def iter_files_bytes(self, desired_files):
654
"""See Repository.iter_file_bytes.
657
return self._real_repository.iter_files_bytes(desired_files)
660
def get_signature_text(self, revision_id):
662
return self._real_repository.get_signature_text(revision_id)
665
def get_revision_graph_with_ghosts(self, revision_ids=None):
667
return self._real_repository.get_revision_graph_with_ghosts(
668
revision_ids=revision_ids)
671
def get_inventory_xml(self, revision_id):
673
return self._real_repository.get_inventory_xml(revision_id)
675
def deserialise_inventory(self, revision_id, xml):
677
return self._real_repository.deserialise_inventory(revision_id, xml)
679
def reconcile(self, other=None, thorough=False):
681
return self._real_repository.reconcile(other=other, thorough=thorough)
683
def all_revision_ids(self):
685
return self._real_repository.all_revision_ids()
688
def get_deltas_for_revisions(self, revisions):
690
return self._real_repository.get_deltas_for_revisions(revisions)
693
def get_revision_delta(self, revision_id):
695
return self._real_repository.get_revision_delta(revision_id)
698
def revision_trees(self, revision_ids):
700
return self._real_repository.revision_trees(revision_ids)
703
def get_revision_reconcile(self, revision_id):
705
return self._real_repository.get_revision_reconcile(revision_id)
708
def check(self, revision_ids=None):
710
return self._real_repository.check(revision_ids=revision_ids)
712
def copy_content_into(self, destination, revision_id=None):
714
return self._real_repository.copy_content_into(
715
destination, revision_id=revision_id)
717
def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
718
# get a tarball of the remote repository, and copy from that into the
720
from bzrlib import osutils
723
from StringIO import StringIO
724
# TODO: Maybe a progress bar while streaming the tarball?
725
note("Copying repository content as tarball...")
726
tar_file = self._get_tarball('bz2')
729
destination = to_bzrdir.create_repository()
731
tar = tarfile.open('repository', fileobj=tar_file,
733
tmpdir = tempfile.mkdtemp()
735
_extract_tar(tar, tmpdir)
736
tmp_bzrdir = BzrDir.open(tmpdir)
737
tmp_repo = tmp_bzrdir.open_repository()
738
tmp_repo.copy_content_into(destination, revision_id)
740
osutils.rmtree(tmpdir)
744
# TODO: Suggestion from john: using external tar is much faster than
745
# python's tarfile library, but it may not work on windows.
749
"""Compress the data within the repository.
751
This is not currently implemented within the smart server.
754
return self._real_repository.pack()
756
def set_make_working_trees(self, new_value):
757
raise NotImplementedError(self.set_make_working_trees)
760
def sign_revision(self, revision_id, gpg_strategy):
762
return self._real_repository.sign_revision(revision_id, gpg_strategy)
765
def get_revisions(self, revision_ids):
767
return self._real_repository.get_revisions(revision_ids)
769
def supports_rich_root(self):
771
return self._real_repository.supports_rich_root()
773
def iter_reverse_revision_history(self, revision_id):
775
return self._real_repository.iter_reverse_revision_history(revision_id)
778
def _serializer(self):
780
return self._real_repository._serializer
782
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
784
return self._real_repository.store_revision_signature(
785
gpg_strategy, plaintext, revision_id)
787
def has_signature_for_revision_id(self, revision_id):
789
return self._real_repository.has_signature_for_revision_id(revision_id)
791
def get_data_stream(self, revision_ids):
792
path = self.bzrdir._path_for_remote_call(self._client)
793
response, protocol = self._client.call_expecting_body(
794
'Repository.stream_knit_data_for_revisions', path, *revision_ids)
795
if response == ('ok',):
796
return self._deserialise_stream(protocol)
797
elif (response == ('error', "Generic bzr smart protocol error: "
798
"bad request 'Repository.stream_knit_data_for_revisions'") or
799
response == ('error', "Generic bzr smart protocol error: "
800
"bad request u'Repository.stream_knit_data_for_revisions'")):
801
protocol.cancel_read_body()
803
return self._real_repository.get_data_stream(revision_ids)
805
raise errors.UnexpectedSmartServerResponse(response)
807
def _deserialise_stream(self, protocol):
808
buffer = StringIO(protocol.read_body_bytes())
809
reader = ContainerReader(buffer)
810
for record_names, read_bytes in reader.iter_records():
812
# These records should have only one name, and that name
813
# should be a one-element tuple.
814
[name_tuple] = record_names
816
raise errors.SmartProtocolError(
817
'Repository data stream had invalid record name %r'
819
yield name_tuple, read_bytes(None)
821
def insert_data_stream(self, stream):
823
self._real_repository.insert_data_stream(stream)
825
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
827
return self._real_repository.item_keys_introduced_by(revision_ids,
830
def revision_graph_can_have_wrong_parents(self):
831
# The answer depends on the remote repo format.
833
return self._real_repository.revision_graph_can_have_wrong_parents()
835
def _find_inconsistent_revision_parents(self):
837
return self._real_repository._find_inconsistent_revision_parents()
839
def _check_for_inconsistent_revision_parents(self):
841
return self._real_repository._check_for_inconsistent_revision_parents()
844
class RemoteBranchLockableFiles(LockableFiles):
845
"""A 'LockableFiles' implementation that talks to a smart server.
847
This is not a public interface class.
850
def __init__(self, bzrdir, _client):
852
self._client = _client
853
self._need_find_modes = True
854
LockableFiles.__init__(
855
self, bzrdir.get_branch_transport(None),
856
'lock', lockdir.LockDir)
858
def _find_modes(self):
859
# RemoteBranches don't let the client set the mode of control files.
860
self._dir_mode = None
861
self._file_mode = None
864
"""'get' a remote path as per the LockableFiles interface.
866
:param path: the file to 'get'. If this is 'branch.conf', we do not
867
just retrieve a file, instead we ask the smart server to generate
868
a configuration for us - which is retrieved as an INI file.
870
if path == 'branch.conf':
871
path = self.bzrdir._path_for_remote_call(self._client)
872
response = self._client.call_expecting_body(
873
'Branch.get_config_file', path)
874
assert response[0][0] == 'ok', \
875
'unexpected response code %s' % (response[0],)
876
return StringIO(response[1].read_body_bytes())
879
return LockableFiles.get(self, path)
882
class RemoteBranchFormat(branch.BranchFormat):
884
def __eq__(self, other):
885
return (isinstance(other, RemoteBranchFormat) and
886
self.__dict__ == other.__dict__)
888
def get_format_description(self):
889
return 'Remote BZR Branch'
891
def get_format_string(self):
892
return 'Remote BZR Branch'
894
def open(self, a_bzrdir):
895
assert isinstance(a_bzrdir, RemoteBzrDir)
896
return a_bzrdir.open_branch()
898
def initialize(self, a_bzrdir):
899
assert isinstance(a_bzrdir, RemoteBzrDir)
900
return a_bzrdir.create_branch()
902
def supports_tags(self):
903
# Remote branches might support tags, but we won't know until we
904
# access the real remote branch.
908
class RemoteBranch(branch.Branch):
909
"""Branch stored on a server accessed by HPSS RPC.
911
At the moment most operations are mapped down to simple file operations.
914
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
916
"""Create a RemoteBranch instance.
918
:param real_branch: An optional local implementation of the branch
919
format, usually accessing the data via the VFS.
920
:param _client: Private parameter for testing.
922
# We intentionally don't call the parent class's __init__, because it
923
# will try to assign to self.tags, which is a property in this subclass.
924
# And the parent's __init__ doesn't do much anyway.
925
self._revision_history_cache = None
926
self.bzrdir = remote_bzrdir
927
if _client is not None:
928
self._client = _client
930
self._client = client._SmartClient(self.bzrdir._shared_medium)
931
self.repository = remote_repository
932
if real_branch is not None:
933
self._real_branch = real_branch
934
# Give the remote repository the matching real repo.
935
real_repo = self._real_branch.repository
936
if isinstance(real_repo, RemoteRepository):
937
real_repo._ensure_real()
938
real_repo = real_repo._real_repository
939
self.repository._set_real_repository(real_repo)
940
# Give the branch the remote repository to let fast-pathing happen.
941
self._real_branch.repository = self.repository
943
self._real_branch = None
944
# Fill out expected attributes of branch for bzrlib api users.
945
self._format = RemoteBranchFormat()
946
self.base = self.bzrdir.root_transport.base
947
self._control_files = None
948
self._lock_mode = None
949
self._lock_token = None
951
self._leave_lock = False
954
return "%s(%s)" % (self.__class__.__name__, self.base)
958
def _ensure_real(self):
959
"""Ensure that there is a _real_branch set.
961
Used before calls to self._real_branch.
963
if not self._real_branch:
964
assert vfs.vfs_enabled()
965
self.bzrdir._ensure_real()
966
self._real_branch = self.bzrdir._real_bzrdir.open_branch()
967
# Give the remote repository the matching real repo.
968
real_repo = self._real_branch.repository
969
if isinstance(real_repo, RemoteRepository):
970
real_repo._ensure_real()
971
real_repo = real_repo._real_repository
972
self.repository._set_real_repository(real_repo)
973
# Give the branch the remote repository to let fast-pathing happen.
974
self._real_branch.repository = self.repository
975
# XXX: deal with _lock_mode == 'w'
976
if self._lock_mode == 'r':
977
self._real_branch.lock_read()
980
def control_files(self):
981
# Defer actually creating RemoteBranchLockableFiles until its needed,
982
# because it triggers an _ensure_real that we otherwise might not need.
983
if self._control_files is None:
984
self._control_files = RemoteBranchLockableFiles(
985
self.bzrdir, self._client)
986
return self._control_files
988
def _get_checkout_format(self):
990
return self._real_branch._get_checkout_format()
992
def get_physical_lock_status(self):
993
"""See Branch.get_physical_lock_status()."""
994
# should be an API call to the server, as branches must be lockable.
996
return self._real_branch.get_physical_lock_status()
999
if not self._lock_mode:
1000
self._lock_mode = 'r'
1001
self._lock_count = 1
1002
if self._real_branch is not None:
1003
self._real_branch.lock_read()
1005
self._lock_count += 1
1007
def _remote_lock_write(self, token):
1009
branch_token = repo_token = ''
1011
branch_token = token
1012
repo_token = self.repository.lock_write()
1013
self.repository.unlock()
1014
path = self.bzrdir._path_for_remote_call(self._client)
1015
response = self._client.call('Branch.lock_write', path, branch_token,
1017
if response[0] == 'ok':
1018
ok, branch_token, repo_token = response
1019
return branch_token, repo_token
1020
elif response[0] == 'LockContention':
1021
raise errors.LockContention('(remote lock)')
1022
elif response[0] == 'TokenMismatch':
1023
raise errors.TokenMismatch(token, '(remote token)')
1024
elif response[0] == 'UnlockableTransport':
1025
raise errors.UnlockableTransport(self.bzrdir.root_transport)
1026
elif response[0] == 'ReadOnlyError':
1027
raise errors.ReadOnlyError(self)
1028
elif response[0] == 'LockFailed':
1029
raise errors.LockFailed(response[1], response[2])
1031
raise errors.UnexpectedSmartServerResponse(response)
1033
def lock_write(self, token=None):
1034
if not self._lock_mode:
1035
remote_tokens = self._remote_lock_write(token)
1036
self._lock_token, self._repo_lock_token = remote_tokens
1037
assert self._lock_token, 'Remote server did not return a token!'
1038
# TODO: We really, really, really don't want to call _ensure_real
1039
# here, but it's the easiest way to ensure coherency between the
1040
# state of the RemoteBranch and RemoteRepository objects and the
1041
# physical locks. If we don't materialise the real objects here,
1042
# then getting everything in the right state later is complex, so
1043
# for now we just do it the lazy way.
1044
# -- Andrew Bennetts, 2007-02-22.
1046
if self._real_branch is not None:
1047
self._real_branch.repository.lock_write(
1048
token=self._repo_lock_token)
1050
self._real_branch.lock_write(token=self._lock_token)
1052
self._real_branch.repository.unlock()
1053
if token is not None:
1054
self._leave_lock = True
1056
# XXX: this case seems to be unreachable; token cannot be None.
1057
self._leave_lock = False
1058
self._lock_mode = 'w'
1059
self._lock_count = 1
1060
elif self._lock_mode == 'r':
1061
raise errors.ReadOnlyTransaction
1063
if token is not None:
1064
# A token was given to lock_write, and we're relocking, so check
1065
# that the given token actually matches the one we already have.
1066
if token != self._lock_token:
1067
raise errors.TokenMismatch(token, self._lock_token)
1068
self._lock_count += 1
1069
return self._lock_token
1071
def _unlock(self, branch_token, repo_token):
1072
path = self.bzrdir._path_for_remote_call(self._client)
1073
response = self._client.call('Branch.unlock', path, branch_token,
1075
if response == ('ok',):
1077
elif response[0] == 'TokenMismatch':
1078
raise errors.TokenMismatch(
1079
str((branch_token, repo_token)), '(remote tokens)')
1081
raise errors.UnexpectedSmartServerResponse(response)
1084
self._lock_count -= 1
1085
if not self._lock_count:
1086
self._clear_cached_state()
1087
mode = self._lock_mode
1088
self._lock_mode = None
1089
if self._real_branch is not None:
1090
if not self._leave_lock:
1091
# If this RemoteBranch will remove the physical lock for the
1092
# repository, make sure the _real_branch doesn't do it
1093
# first. (Because the _real_branch's repository is set to
1094
# be the RemoteRepository.)
1095
self._real_branch.repository.leave_lock_in_place()
1096
self._real_branch.unlock()
1098
# Only write-locked branched need to make a remote method call
1099
# to perfom the unlock.
1101
assert self._lock_token, 'Locked, but no token!'
1102
branch_token = self._lock_token
1103
repo_token = self._repo_lock_token
1104
self._lock_token = None
1105
self._repo_lock_token = None
1106
if not self._leave_lock:
1107
self._unlock(branch_token, repo_token)
1109
def break_lock(self):
1111
return self._real_branch.break_lock()
1113
def leave_lock_in_place(self):
1114
self._leave_lock = True
1116
def dont_leave_lock_in_place(self):
1117
self._leave_lock = False
1119
def last_revision_info(self):
1120
"""See Branch.last_revision_info()."""
1121
path = self.bzrdir._path_for_remote_call(self._client)
1122
response = self._client.call('Branch.last_revision_info', path)
1123
assert response[0] == 'ok', 'unexpected response code %s' % (response,)
1124
revno = int(response[1])
1125
last_revision = response[2]
1126
return (revno, last_revision)
1128
def _gen_revision_history(self):
1129
"""See Branch._gen_revision_history()."""
1130
path = self.bzrdir._path_for_remote_call(self._client)
1131
response = self._client.call_expecting_body(
1132
'Branch.revision_history', path)
1133
assert response[0][0] == 'ok', ('unexpected response code %s'
1135
result = response[1].read_body_bytes().split('\x00')
1141
def set_revision_history(self, rev_history):
1142
# Send just the tip revision of the history; the server will generate
1143
# the full history from that. If the revision doesn't exist in this
1144
# branch, NoSuchRevision will be raised.
1145
path = self.bzrdir._path_for_remote_call(self._client)
1146
if rev_history == []:
1149
rev_id = rev_history[-1]
1150
self._clear_cached_state()
1151
response = self._client.call('Branch.set_last_revision',
1152
path, self._lock_token, self._repo_lock_token, rev_id)
1153
if response[0] == 'NoSuchRevision':
1154
raise NoSuchRevision(self, rev_id)
1156
assert response == ('ok',), (
1157
'unexpected response code %r' % (response,))
1158
self._cache_revision_history(rev_history)
1160
def get_parent(self):
1162
return self._real_branch.get_parent()
1164
def set_parent(self, url):
1166
return self._real_branch.set_parent(url)
1168
def get_config(self):
1169
return RemoteBranchConfig(self)
1171
def sprout(self, to_bzrdir, revision_id=None):
1172
# Like Branch.sprout, except that it sprouts a branch in the default
1173
# format, because RemoteBranches can't be created at arbitrary URLs.
1174
# XXX: if to_bzrdir is a RemoteBranch, this should perhaps do
1175
# to_bzrdir.create_branch...
1176
result = branch.BranchFormat.get_default_format().initialize(to_bzrdir)
1177
self.copy_content_into(result, revision_id=revision_id)
1178
result.set_parent(self.bzrdir.root_transport.base)
1182
def pull(self, source, overwrite=False, stop_revision=None,
1184
# FIXME: This asks the real branch to run the hooks, which means
1185
# they're called with the wrong target branch parameter.
1186
# The test suite specifically allows this at present but it should be
1187
# fixed. It should get a _override_hook_target branch,
1188
# as push does. -- mbp 20070405
1190
self._real_branch.pull(
1191
source, overwrite=overwrite, stop_revision=stop_revision,
1195
def push(self, target, overwrite=False, stop_revision=None):
1197
return self._real_branch.push(
1198
target, overwrite=overwrite, stop_revision=stop_revision,
1199
_override_hook_source_branch=self)
1201
def is_locked(self):
1202
return self._lock_count >= 1
1204
def set_last_revision_info(self, revno, revision_id):
1206
self._clear_cached_state()
1207
return self._real_branch.set_last_revision_info(revno, revision_id)
1209
def generate_revision_history(self, revision_id, last_rev=None,
1212
return self._real_branch.generate_revision_history(
1213
revision_id, last_rev=last_rev, other_branch=other_branch)
1218
return self._real_branch.tags
1220
def set_push_location(self, location):
1222
return self._real_branch.set_push_location(location)
1224
def update_revisions(self, other, stop_revision=None):
1226
return self._real_branch.update_revisions(
1227
other, stop_revision=stop_revision)
1230
class RemoteBranchConfig(BranchConfig):
1233
self.branch._ensure_real()
1234
return self.branch._real_branch.get_config().username()
1236
def _get_branch_data_config(self):
1237
self.branch._ensure_real()
1238
if self._branch_data_config is None:
1239
self._branch_data_config = TreeConfig(self.branch._real_branch)
1240
return self._branch_data_config
1243
def _extract_tar(tar, to_dir):
1244
"""Extract all the contents of a tarfile object.
1246
A replacement for extractall, which is not present in python2.4
1249
tar.extract(tarinfo, to_dir)
added
removed
bzrlib/remote.py
