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
29
from bzrlib.branch import Branch, BranchReferenceFormat
30
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
31
from bzrlib.config import BranchConfig, TreeConfig
32
from bzrlib.decorators import needs_read_lock, needs_write_lock
33
from bzrlib.errors import NoSuchRevision
34
from bzrlib.lockable_files import LockableFiles
35
from bzrlib.pack import ContainerReader
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 destroy_repository(self):
89
"""See BzrDir.destroy_repository"""
91
self._real_bzrdir.destroy_repository()
93
def create_branch(self):
95
real_branch = self._real_bzrdir.create_branch()
96
return RemoteBranch(self, self.find_repository(), real_branch)
98
def destroy_branch(self):
99
"""See BzrDir.destroy_branch"""
101
self._real_bzrdir.destroy_branch()
103
def create_workingtree(self, revision_id=None, from_branch=None):
104
raise errors.NotLocalUrl(self.transport.base)
106
def find_branch_format(self):
107
"""Find the branch 'format' for this bzrdir.
109
This might be a synthetic object for e.g. RemoteBranch and SVN.
111
b = self.open_branch()
114
def get_branch_reference(self):
115
"""See BzrDir.get_branch_reference()."""
116
path = self._path_for_remote_call(self._client)
117
response = self._client.call('BzrDir.open_branch', path)
118
if response[0] == 'ok':
119
if response[1] == '':
120
# branch at this location.
123
# a branch reference, use the existing BranchReference logic.
125
elif response == ('nobranch',):
126
raise errors.NotBranchError(path=self.root_transport.base)
128
raise errors.UnexpectedSmartServerResponse(response)
130
def open_branch(self, _unsupported=False):
131
assert _unsupported == False, 'unsupported flag support not implemented yet.'
132
reference_url = self.get_branch_reference()
133
if reference_url is None:
134
# branch at this location.
135
return RemoteBranch(self, self.find_repository())
137
# a branch reference, use the existing BranchReference logic.
138
format = BranchReferenceFormat()
139
return format.open(self, _found=True, location=reference_url)
141
def open_repository(self):
142
path = self._path_for_remote_call(self._client)
143
response = self._client.call('BzrDir.find_repository', path)
144
assert response[0] in ('ok', 'norepository'), \
145
'unexpected response code %s' % (response,)
146
if response[0] == 'norepository':
147
raise errors.NoRepositoryPresent(self)
148
assert len(response) == 4, 'incorrect response length %s' % (response,)
149
if response[1] == '':
150
format = RemoteRepositoryFormat()
151
format.rich_root_data = (response[2] == 'yes')
152
format.supports_tree_reference = (response[3] == 'yes')
153
return RemoteRepository(self, format)
155
raise errors.NoRepositoryPresent(self)
157
def open_workingtree(self, recommend_upgrade=True):
159
if self._real_bzrdir.has_workingtree():
160
raise errors.NotLocalUrl(self.root_transport)
162
raise errors.NoWorkingTree(self.root_transport.base)
164
def _path_for_remote_call(self, client):
165
"""Return the path to be used for this bzrdir in a remote call."""
166
return client.remote_path_from_transport(self.root_transport)
168
def get_branch_transport(self, branch_format):
170
return self._real_bzrdir.get_branch_transport(branch_format)
172
def get_repository_transport(self, repository_format):
174
return self._real_bzrdir.get_repository_transport(repository_format)
176
def get_workingtree_transport(self, workingtree_format):
178
return self._real_bzrdir.get_workingtree_transport(workingtree_format)
180
def can_convert_format(self):
181
"""Upgrading of remote bzrdirs is not supported yet."""
184
def needs_format_conversion(self, format=None):
185
"""Upgrading of remote bzrdirs is not supported yet."""
188
def clone(self, url, revision_id=None, force_new_repo=False):
190
return self._real_bzrdir.clone(url, revision_id=revision_id,
191
force_new_repo=force_new_repo)
194
class RemoteRepositoryFormat(repository.RepositoryFormat):
195
"""Format for repositories accessed over a _SmartClient.
197
Instances of this repository are represented by RemoteRepository
200
The RemoteRepositoryFormat is parameterized during construction
201
to reflect the capabilities of the real, remote format. Specifically
202
the attributes rich_root_data and supports_tree_reference are set
203
on a per instance basis, and are not set (and should not be) at
207
_matchingbzrdir = RemoteBzrDirFormat
209
def initialize(self, a_bzrdir, shared=False):
210
assert isinstance(a_bzrdir, RemoteBzrDir), \
211
'%r is not a RemoteBzrDir' % (a_bzrdir,)
212
return a_bzrdir.create_repository(shared=shared)
214
def open(self, a_bzrdir):
215
assert isinstance(a_bzrdir, RemoteBzrDir)
216
return a_bzrdir.open_repository()
218
def get_format_description(self):
219
return 'bzr remote repository'
221
def __eq__(self, other):
222
return self.__class__ == other.__class__
224
def check_conversion_target(self, target_format):
225
if self.rich_root_data and not target_format.rich_root_data:
226
raise errors.BadConversionTarget(
227
'Does not support rich root data.', target_format)
228
if (self.supports_tree_reference and
229
not getattr(target_format, 'supports_tree_reference', False)):
230
raise errors.BadConversionTarget(
231
'Does not support nested trees', target_format)
234
class RemoteRepository(object):
235
"""Repository accessed over rpc.
237
For the moment most operations are performed using local transport-backed
241
def __init__(self, remote_bzrdir, format, real_repository=None, _client=None):
242
"""Create a RemoteRepository instance.
244
:param remote_bzrdir: The bzrdir hosting this repository.
245
:param format: The RemoteFormat object to use.
246
:param real_repository: If not None, a local implementation of the
247
repository logic for the repository, usually accessing the data
249
:param _client: Private testing parameter - override the smart client
250
to be used by the repository.
253
self._real_repository = real_repository
255
self._real_repository = None
256
self.bzrdir = remote_bzrdir
258
self._client = client._SmartClient(self.bzrdir._shared_medium)
260
self._client = _client
261
self._format = format
262
self._lock_mode = None
263
self._lock_token = None
265
self._leave_lock = False
267
# These depend on the actual remote format, so force them off for
268
# maximum compatibility. XXX: In future these should depend on the
269
# remote repository instance, but this is irrelevant until we perform
270
# reconcile via an RPC call.
271
self._reconcile_does_inventory_gc = False
272
self._reconcile_fixes_text_parents = False
273
self._reconcile_backsup_inventory = False
274
self.base = self.bzrdir.transport.base
277
return "%s(%s)" % (self.__class__.__name__, self.base)
281
def abort_write_group(self):
282
"""Complete a write group on the decorated repository.
284
Smart methods peform operations in a single step so this api
285
is not really applicable except as a compatibility thunk
286
for older plugins that don't use e.g. the CommitBuilder
290
return self._real_repository.abort_write_group()
292
def commit_write_group(self):
293
"""Complete a write group on the decorated repository.
295
Smart methods peform operations in a single step so this api
296
is not really applicable except as a compatibility thunk
297
for older plugins that don't use e.g. the CommitBuilder
301
return self._real_repository.commit_write_group()
303
def _ensure_real(self):
304
"""Ensure that there is a _real_repository set.
306
Used before calls to self._real_repository.
308
if not self._real_repository:
309
self.bzrdir._ensure_real()
310
#self._real_repository = self.bzrdir._real_bzrdir.open_repository()
311
self._set_real_repository(self.bzrdir._real_bzrdir.open_repository())
313
def find_text_key_references(self):
314
"""Find the text key references within the repository.
316
:return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
317
revision_ids. Each altered file-ids has the exact revision_ids that
318
altered it listed explicitly.
319
:return: A dictionary mapping text keys ((fileid, revision_id) tuples)
320
to whether they were referred to by the inventory of the
321
revision_id that they contain. The inventory texts from all present
322
revision ids are assessed to generate this report.
325
return self._real_repository.find_text_key_references()
327
def _generate_text_key_index(self):
328
"""Generate a new text key index for the repository.
330
This is an expensive function that will take considerable time to run.
332
:return: A dict mapping (file_id, revision_id) tuples to a list of
333
parents, also (file_id, revision_id) tuples.
336
return self._real_repository._generate_text_key_index()
338
def get_revision_graph(self, revision_id=None):
339
"""See Repository.get_revision_graph()."""
340
if revision_id is None:
342
elif revision.is_null(revision_id):
345
path = self.bzrdir._path_for_remote_call(self._client)
346
assert type(revision_id) is str
347
response = self._client.call_expecting_body(
348
'Repository.get_revision_graph', path, revision_id)
349
if response[0][0] not in ['ok', 'nosuchrevision']:
350
raise errors.UnexpectedSmartServerResponse(response[0])
351
if response[0][0] == 'ok':
352
coded = response[1].read_body_bytes()
354
# no revisions in this repository!
356
lines = coded.split('\n')
359
d = tuple(line.split())
360
revision_graph[d[0]] = d[1:]
362
return revision_graph
364
response_body = response[1].read_body_bytes()
365
assert response_body == ''
366
raise NoSuchRevision(self, revision_id)
368
def has_revision(self, revision_id):
369
"""See Repository.has_revision()."""
370
if revision_id is None:
371
# The null revision is always present.
373
path = self.bzrdir._path_for_remote_call(self._client)
374
response = self._client.call('Repository.has_revision', path, revision_id)
375
assert response[0] in ('yes', 'no'), 'unexpected response code %s' % (response,)
376
return response[0] == 'yes'
378
def has_same_location(self, other):
379
return (self.__class__ == other.__class__ and
380
self.bzrdir.transport.base == other.bzrdir.transport.base)
382
def get_graph(self, other_repository=None):
383
"""Return the graph for this repository format"""
385
return self._real_repository.get_graph(other_repository)
387
def gather_stats(self, revid=None, committers=None):
388
"""See Repository.gather_stats()."""
389
path = self.bzrdir._path_for_remote_call(self._client)
390
# revid can be None to indicate no revisions, not just NULL_REVISION
391
if revid is None or revision.is_null(revid):
395
if committers is None or not committers:
396
fmt_committers = 'no'
398
fmt_committers = 'yes'
399
response = self._client.call_expecting_body(
400
'Repository.gather_stats', path, fmt_revid, fmt_committers)
401
assert response[0][0] == 'ok', \
402
'unexpected response code %s' % (response[0],)
404
body = response[1].read_body_bytes()
406
for line in body.split('\n'):
409
key, val_text = line.split(':')
410
if key in ('revisions', 'size', 'committers'):
411
result[key] = int(val_text)
412
elif key in ('firstrev', 'latestrev'):
413
values = val_text.split(' ')[1:]
414
result[key] = (float(values[0]), long(values[1]))
418
def find_branches(self, using=False):
419
"""See Repository.find_branches()."""
420
# should be an API call to the server.
422
return self._real_repository.find_branches(using=using)
424
def get_physical_lock_status(self):
425
"""See Repository.get_physical_lock_status()."""
426
# should be an API call to the server.
428
return self._real_repository.get_physical_lock_status()
430
def is_in_write_group(self):
431
"""Return True if there is an open write group.
433
write groups are only applicable locally for the smart server..
435
if self._real_repository:
436
return self._real_repository.is_in_write_group()
439
return self._lock_count >= 1
442
"""See Repository.is_shared()."""
443
path = self.bzrdir._path_for_remote_call(self._client)
444
response = self._client.call('Repository.is_shared', path)
445
assert response[0] in ('yes', 'no'), 'unexpected response code %s' % (response,)
446
return response[0] == 'yes'
448
def is_write_locked(self):
449
return self._lock_mode == 'w'
452
# wrong eventually - want a local lock cache context
453
if not self._lock_mode:
454
self._lock_mode = 'r'
456
if self._real_repository is not None:
457
self._real_repository.lock_read()
459
self._lock_count += 1
461
def _remote_lock_write(self, token):
462
path = self.bzrdir._path_for_remote_call(self._client)
465
response = self._client.call('Repository.lock_write', path, token)
466
if response[0] == 'ok':
469
elif response[0] == 'LockContention':
470
raise errors.LockContention('(remote lock)')
471
elif response[0] == 'UnlockableTransport':
472
raise errors.UnlockableTransport(self.bzrdir.root_transport)
473
elif response[0] == 'LockFailed':
474
raise errors.LockFailed(response[1], response[2])
476
raise errors.UnexpectedSmartServerResponse(response)
478
def lock_write(self, token=None):
479
if not self._lock_mode:
480
self._lock_token = self._remote_lock_write(token)
481
# if self._lock_token is None, then this is something like packs or
482
# svn where we don't get to lock the repo, or a weave style repository
483
# where we cannot lock it over the wire and attempts to do so will
485
if self._real_repository is not None:
486
self._real_repository.lock_write(token=self._lock_token)
487
if token is not None:
488
self._leave_lock = True
490
self._leave_lock = False
491
self._lock_mode = 'w'
493
elif self._lock_mode == 'r':
494
raise errors.ReadOnlyError(self)
496
self._lock_count += 1
497
return self._lock_token or None
499
def leave_lock_in_place(self):
500
if not self._lock_token:
501
raise NotImplementedError(self.leave_lock_in_place)
502
self._leave_lock = True
504
def dont_leave_lock_in_place(self):
505
if not self._lock_token:
506
raise NotImplementedError(self.dont_leave_lock_in_place)
507
self._leave_lock = False
509
def _set_real_repository(self, repository):
510
"""Set the _real_repository for this repository.
512
:param repository: The repository to fallback to for non-hpss
513
implemented operations.
515
assert not isinstance(repository, RemoteRepository)
516
self._real_repository = repository
517
if self._lock_mode == 'w':
518
# if we are already locked, the real repository must be able to
519
# acquire the lock with our token.
520
self._real_repository.lock_write(self._lock_token)
521
elif self._lock_mode == 'r':
522
self._real_repository.lock_read()
524
def start_write_group(self):
525
"""Start a write group on the decorated repository.
527
Smart methods peform operations in a single step so this api
528
is not really applicable except as a compatibility thunk
529
for older plugins that don't use e.g. the CommitBuilder
533
return self._real_repository.start_write_group()
535
def _unlock(self, token):
536
path = self.bzrdir._path_for_remote_call(self._client)
538
# with no token the remote repository is not persistently locked.
540
response = self._client.call('Repository.unlock', path, token)
541
if response == ('ok',):
543
elif response[0] == 'TokenMismatch':
544
raise errors.TokenMismatch(token, '(remote token)')
546
raise errors.UnexpectedSmartServerResponse(response)
549
self._lock_count -= 1
550
if self._lock_count > 0:
552
old_mode = self._lock_mode
553
self._lock_mode = None
555
# The real repository is responsible at present for raising an
556
# exception if it's in an unfinished write group. However, it
557
# normally will *not* actually remove the lock from disk - that's
558
# done by the server on receiving the Repository.unlock call.
559
# This is just to let the _real_repository stay up to date.
560
if self._real_repository is not None:
561
self._real_repository.unlock()
563
# The rpc-level lock should be released even if there was a
564
# problem releasing the vfs-based lock.
566
# Only write-locked repositories need to make a remote method
567
# call to perfom the unlock.
568
old_token = self._lock_token
569
self._lock_token = None
570
if not self._leave_lock:
571
self._unlock(old_token)
573
def break_lock(self):
574
# should hand off to the network
576
return self._real_repository.break_lock()
578
def _get_tarball(self, compression):
579
"""Return a TemporaryFile containing a repository tarball.
581
Returns None if the server does not support sending tarballs.
584
path = self.bzrdir._path_for_remote_call(self._client)
585
response, protocol = self._client.call_expecting_body(
586
'Repository.tarball', path, compression)
587
if response[0] == 'ok':
588
# Extract the tarball and return it
589
t = tempfile.NamedTemporaryFile()
590
# TODO: rpc layer should read directly into it...
591
t.write(protocol.read_body_bytes())
594
if (response == ('error', "Generic bzr smart protocol error: "
595
"bad request 'Repository.tarball'") or
596
response == ('error', "Generic bzr smart protocol error: "
597
"bad request u'Repository.tarball'")):
598
protocol.cancel_read_body()
600
raise errors.UnexpectedSmartServerResponse(response)
602
def sprout(self, to_bzrdir, revision_id=None):
603
# TODO: Option to control what format is created?
605
dest_repo = self._real_repository._format.initialize(to_bzrdir,
607
dest_repo.fetch(self, revision_id=revision_id)
610
### These methods are just thin shims to the VFS object for now.
612
def revision_tree(self, revision_id):
614
return self._real_repository.revision_tree(revision_id)
616
def get_serializer_format(self):
618
return self._real_repository.get_serializer_format()
620
def get_commit_builder(self, branch, parents, config, timestamp=None,
621
timezone=None, committer=None, revprops=None,
623
# FIXME: It ought to be possible to call this without immediately
624
# triggering _ensure_real. For now it's the easiest thing to do.
626
builder = self._real_repository.get_commit_builder(branch, parents,
627
config, timestamp=timestamp, timezone=timezone,
628
committer=committer, revprops=revprops, revision_id=revision_id)
632
def add_inventory(self, revid, inv, parents):
634
return self._real_repository.add_inventory(revid, inv, parents)
637
def add_revision(self, rev_id, rev, inv=None, config=None):
639
return self._real_repository.add_revision(
640
rev_id, rev, inv=inv, config=config)
643
def get_inventory(self, revision_id):
645
return self._real_repository.get_inventory(revision_id)
648
def get_revision(self, revision_id):
650
return self._real_repository.get_revision(revision_id)
653
def weave_store(self):
655
return self._real_repository.weave_store
657
def get_transaction(self):
659
return self._real_repository.get_transaction()
662
def clone(self, a_bzrdir, revision_id=None):
664
return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
666
def make_working_trees(self):
667
"""RemoteRepositories never create working trees by default."""
670
def fetch(self, source, revision_id=None, pb=None):
671
if self.has_same_location(source):
672
# check that last_revision is in 'from' and then return a
674
if (revision_id is not None and
675
not revision.is_null(revision_id)):
676
self.get_revision(revision_id)
679
return self._real_repository.fetch(
680
source, revision_id=revision_id, pb=pb)
682
def create_bundle(self, target, base, fileobj, format=None):
684
self._real_repository.create_bundle(target, base, fileobj, format)
687
def control_weaves(self):
689
return self._real_repository.control_weaves
692
def get_ancestry(self, revision_id, topo_sorted=True):
694
return self._real_repository.get_ancestry(revision_id, topo_sorted)
697
def get_inventory_weave(self):
699
return self._real_repository.get_inventory_weave()
701
def fileids_altered_by_revision_ids(self, revision_ids):
703
return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
705
def _get_versioned_file_checker(self, revisions, revision_versions_cache):
707
return self._real_repository._get_versioned_file_checker(
708
revisions, revision_versions_cache)
710
def iter_files_bytes(self, desired_files):
711
"""See Repository.iter_file_bytes.
714
return self._real_repository.iter_files_bytes(desired_files)
717
def get_signature_text(self, revision_id):
719
return self._real_repository.get_signature_text(revision_id)
722
def get_revision_graph_with_ghosts(self, revision_ids=None):
724
return self._real_repository.get_revision_graph_with_ghosts(
725
revision_ids=revision_ids)
728
def get_inventory_xml(self, revision_id):
730
return self._real_repository.get_inventory_xml(revision_id)
732
def deserialise_inventory(self, revision_id, xml):
734
return self._real_repository.deserialise_inventory(revision_id, xml)
736
def reconcile(self, other=None, thorough=False):
738
return self._real_repository.reconcile(other=other, thorough=thorough)
740
def all_revision_ids(self):
742
return self._real_repository.all_revision_ids()
745
def get_deltas_for_revisions(self, revisions):
747
return self._real_repository.get_deltas_for_revisions(revisions)
750
def get_revision_delta(self, revision_id):
752
return self._real_repository.get_revision_delta(revision_id)
755
def revision_trees(self, revision_ids):
757
return self._real_repository.revision_trees(revision_ids)
760
def get_revision_reconcile(self, revision_id):
762
return self._real_repository.get_revision_reconcile(revision_id)
765
def check(self, revision_ids=None):
767
return self._real_repository.check(revision_ids=revision_ids)
769
def copy_content_into(self, destination, revision_id=None):
771
return self._real_repository.copy_content_into(
772
destination, revision_id=revision_id)
774
def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
775
# get a tarball of the remote repository, and copy from that into the
777
from bzrlib import osutils
780
from StringIO import StringIO
781
# TODO: Maybe a progress bar while streaming the tarball?
782
note("Copying repository content as tarball...")
783
tar_file = self._get_tarball('bz2')
786
destination = to_bzrdir.create_repository()
788
tar = tarfile.open('repository', fileobj=tar_file,
790
tmpdir = tempfile.mkdtemp()
792
_extract_tar(tar, tmpdir)
793
tmp_bzrdir = BzrDir.open(tmpdir)
794
tmp_repo = tmp_bzrdir.open_repository()
795
tmp_repo.copy_content_into(destination, revision_id)
797
osutils.rmtree(tmpdir)
801
# TODO: Suggestion from john: using external tar is much faster than
802
# python's tarfile library, but it may not work on windows.
806
"""Compress the data within the repository.
808
This is not currently implemented within the smart server.
811
return self._real_repository.pack()
813
def set_make_working_trees(self, new_value):
814
raise NotImplementedError(self.set_make_working_trees)
817
def sign_revision(self, revision_id, gpg_strategy):
819
return self._real_repository.sign_revision(revision_id, gpg_strategy)
822
def get_revisions(self, revision_ids):
824
return self._real_repository.get_revisions(revision_ids)
826
def supports_rich_root(self):
828
return self._real_repository.supports_rich_root()
830
def iter_reverse_revision_history(self, revision_id):
832
return self._real_repository.iter_reverse_revision_history(revision_id)
835
def _serializer(self):
837
return self._real_repository._serializer
839
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
841
return self._real_repository.store_revision_signature(
842
gpg_strategy, plaintext, revision_id)
844
def add_signature_text(self, revision_id, signature):
846
return self._real_repository.add_signature_text(revision_id, signature)
848
def has_signature_for_revision_id(self, revision_id):
850
return self._real_repository.has_signature_for_revision_id(revision_id)
852
def get_data_stream(self, revision_ids):
853
path = self.bzrdir._path_for_remote_call(self._client)
854
response, protocol = self._client.call_expecting_body(
855
'Repository.stream_knit_data_for_revisions', path, *revision_ids)
856
if response == ('ok',):
857
return self._deserialise_stream(protocol)
858
elif (response == ('error', "Generic bzr smart protocol error: "
859
"bad request 'Repository.stream_knit_data_for_revisions'") or
860
response == ('error', "Generic bzr smart protocol error: "
861
"bad request u'Repository.stream_knit_data_for_revisions'")):
862
protocol.cancel_read_body()
864
return self._real_repository.get_data_stream(revision_ids)
866
raise errors.UnexpectedSmartServerResponse(response)
868
def _deserialise_stream(self, protocol):
869
buffer = StringIO(protocol.read_body_bytes())
870
reader = ContainerReader(buffer)
871
for record_names, read_bytes in reader.iter_records():
873
# These records should have only one name, and that name
874
# should be a one-element tuple.
875
[name_tuple] = record_names
877
raise errors.SmartProtocolError(
878
'Repository data stream had invalid record name %r'
880
yield name_tuple, read_bytes(None)
882
def insert_data_stream(self, stream):
884
self._real_repository.insert_data_stream(stream)
886
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
888
return self._real_repository.item_keys_introduced_by(revision_ids,
891
def revision_graph_can_have_wrong_parents(self):
892
# The answer depends on the remote repo format.
894
return self._real_repository.revision_graph_can_have_wrong_parents()
896
def _find_inconsistent_revision_parents(self):
898
return self._real_repository._find_inconsistent_revision_parents()
900
def _check_for_inconsistent_revision_parents(self):
902
return self._real_repository._check_for_inconsistent_revision_parents()
904
def _make_parents_provider(self):
906
return self._real_repository._make_parents_provider()
909
class RemoteBranchLockableFiles(LockableFiles):
910
"""A 'LockableFiles' implementation that talks to a smart server.
912
This is not a public interface class.
915
def __init__(self, bzrdir, _client):
917
self._client = _client
918
self._need_find_modes = True
919
LockableFiles.__init__(
920
self, bzrdir.get_branch_transport(None),
921
'lock', lockdir.LockDir)
923
def _find_modes(self):
924
# RemoteBranches don't let the client set the mode of control files.
925
self._dir_mode = None
926
self._file_mode = None
929
"""'get' a remote path as per the LockableFiles interface.
931
:param path: the file to 'get'. If this is 'branch.conf', we do not
932
just retrieve a file, instead we ask the smart server to generate
933
a configuration for us - which is retrieved as an INI file.
935
if path == 'branch.conf':
936
path = self.bzrdir._path_for_remote_call(self._client)
937
response = self._client.call_expecting_body(
938
'Branch.get_config_file', path)
939
assert response[0][0] == 'ok', \
940
'unexpected response code %s' % (response[0],)
941
return StringIO(response[1].read_body_bytes())
944
return LockableFiles.get(self, path)
947
class RemoteBranchFormat(branch.BranchFormat):
949
def __eq__(self, other):
950
return (isinstance(other, RemoteBranchFormat) and
951
self.__dict__ == other.__dict__)
953
def get_format_description(self):
954
return 'Remote BZR Branch'
956
def get_format_string(self):
957
return 'Remote BZR Branch'
959
def open(self, a_bzrdir):
960
assert isinstance(a_bzrdir, RemoteBzrDir)
961
return a_bzrdir.open_branch()
963
def initialize(self, a_bzrdir):
964
assert isinstance(a_bzrdir, RemoteBzrDir)
965
return a_bzrdir.create_branch()
967
def supports_tags(self):
968
# Remote branches might support tags, but we won't know until we
969
# access the real remote branch.
973
class RemoteBranch(branch.Branch):
974
"""Branch stored on a server accessed by HPSS RPC.
976
At the moment most operations are mapped down to simple file operations.
979
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
981
"""Create a RemoteBranch instance.
983
:param real_branch: An optional local implementation of the branch
984
format, usually accessing the data via the VFS.
985
:param _client: Private parameter for testing.
987
# We intentionally don't call the parent class's __init__, because it
988
# will try to assign to self.tags, which is a property in this subclass.
989
# And the parent's __init__ doesn't do much anyway.
990
self._revision_id_to_revno_cache = None
991
self._revision_history_cache = None
992
self.bzrdir = remote_bzrdir
993
if _client is not None:
994
self._client = _client
996
self._client = client._SmartClient(self.bzrdir._shared_medium)
997
self.repository = remote_repository
998
if real_branch is not None:
999
self._real_branch = real_branch
1000
# Give the remote repository the matching real repo.
1001
real_repo = self._real_branch.repository
1002
if isinstance(real_repo, RemoteRepository):
1003
real_repo._ensure_real()
1004
real_repo = real_repo._real_repository
1005
self.repository._set_real_repository(real_repo)
1006
# Give the branch the remote repository to let fast-pathing happen.
1007
self._real_branch.repository = self.repository
1009
self._real_branch = None
1010
# Fill out expected attributes of branch for bzrlib api users.
1011
self._format = RemoteBranchFormat()
1012
self.base = self.bzrdir.root_transport.base
1013
self._control_files = None
1014
self._lock_mode = None
1015
self._lock_token = None
1016
self._lock_count = 0
1017
self._leave_lock = False
1020
return "%s(%s)" % (self.__class__.__name__, self.base)
1024
def _ensure_real(self):
1025
"""Ensure that there is a _real_branch set.
1027
Used before calls to self._real_branch.
1029
if not self._real_branch:
1030
assert vfs.vfs_enabled()
1031
self.bzrdir._ensure_real()
1032
self._real_branch = self.bzrdir._real_bzrdir.open_branch()
1033
# Give the remote repository the matching real repo.
1034
real_repo = self._real_branch.repository
1035
if isinstance(real_repo, RemoteRepository):
1036
real_repo._ensure_real()
1037
real_repo = real_repo._real_repository
1038
self.repository._set_real_repository(real_repo)
1039
# Give the branch the remote repository to let fast-pathing happen.
1040
self._real_branch.repository = self.repository
1041
# XXX: deal with _lock_mode == 'w'
1042
if self._lock_mode == 'r':
1043
self._real_branch.lock_read()
1046
def control_files(self):
1047
# Defer actually creating RemoteBranchLockableFiles until its needed,
1048
# because it triggers an _ensure_real that we otherwise might not need.
1049
if self._control_files is None:
1050
self._control_files = RemoteBranchLockableFiles(
1051
self.bzrdir, self._client)
1052
return self._control_files
1054
def _get_checkout_format(self):
1056
return self._real_branch._get_checkout_format()
1058
def get_physical_lock_status(self):
1059
"""See Branch.get_physical_lock_status()."""
1060
# should be an API call to the server, as branches must be lockable.
1062
return self._real_branch.get_physical_lock_status()
1064
def lock_read(self):
1065
if not self._lock_mode:
1066
self._lock_mode = 'r'
1067
self._lock_count = 1
1068
if self._real_branch is not None:
1069
self._real_branch.lock_read()
1071
self._lock_count += 1
1073
def _remote_lock_write(self, token):
1075
branch_token = repo_token = ''
1077
branch_token = token
1078
repo_token = self.repository.lock_write()
1079
self.repository.unlock()
1080
path = self.bzrdir._path_for_remote_call(self._client)
1081
response = self._client.call('Branch.lock_write', path, branch_token,
1083
if response[0] == 'ok':
1084
ok, branch_token, repo_token = response
1085
return branch_token, repo_token
1086
elif response[0] == 'LockContention':
1087
raise errors.LockContention('(remote lock)')
1088
elif response[0] == 'TokenMismatch':
1089
raise errors.TokenMismatch(token, '(remote token)')
1090
elif response[0] == 'UnlockableTransport':
1091
raise errors.UnlockableTransport(self.bzrdir.root_transport)
1092
elif response[0] == 'ReadOnlyError':
1093
raise errors.ReadOnlyError(self)
1094
elif response[0] == 'LockFailed':
1095
raise errors.LockFailed(response[1], response[2])
1097
raise errors.UnexpectedSmartServerResponse(response)
1099
def lock_write(self, token=None):
1100
if not self._lock_mode:
1101
remote_tokens = self._remote_lock_write(token)
1102
self._lock_token, self._repo_lock_token = remote_tokens
1103
assert self._lock_token, 'Remote server did not return a token!'
1104
# TODO: We really, really, really don't want to call _ensure_real
1105
# here, but it's the easiest way to ensure coherency between the
1106
# state of the RemoteBranch and RemoteRepository objects and the
1107
# physical locks. If we don't materialise the real objects here,
1108
# then getting everything in the right state later is complex, so
1109
# for now we just do it the lazy way.
1110
# -- Andrew Bennetts, 2007-02-22.
1112
if self._real_branch is not None:
1113
self._real_branch.repository.lock_write(
1114
token=self._repo_lock_token)
1116
self._real_branch.lock_write(token=self._lock_token)
1118
self._real_branch.repository.unlock()
1119
if token is not None:
1120
self._leave_lock = True
1122
# XXX: this case seems to be unreachable; token cannot be None.
1123
self._leave_lock = False
1124
self._lock_mode = 'w'
1125
self._lock_count = 1
1126
elif self._lock_mode == 'r':
1127
raise errors.ReadOnlyTransaction
1129
if token is not None:
1130
# A token was given to lock_write, and we're relocking, so check
1131
# that the given token actually matches the one we already have.
1132
if token != self._lock_token:
1133
raise errors.TokenMismatch(token, self._lock_token)
1134
self._lock_count += 1
1135
return self._lock_token or None
1137
def _unlock(self, branch_token, repo_token):
1138
path = self.bzrdir._path_for_remote_call(self._client)
1139
response = self._client.call('Branch.unlock', path, branch_token,
1141
if response == ('ok',):
1143
elif response[0] == 'TokenMismatch':
1144
raise errors.TokenMismatch(
1145
str((branch_token, repo_token)), '(remote tokens)')
1147
raise errors.UnexpectedSmartServerResponse(response)
1150
self._lock_count -= 1
1151
if not self._lock_count:
1152
self._clear_cached_state()
1153
mode = self._lock_mode
1154
self._lock_mode = None
1155
if self._real_branch is not None:
1156
if (not self._leave_lock and mode == 'w' and
1157
self._repo_lock_token):
1158
# If this RemoteBranch will remove the physical lock for the
1159
# repository, make sure the _real_branch doesn't do it
1160
# first. (Because the _real_branch's repository is set to
1161
# be the RemoteRepository.)
1162
self._real_branch.repository.leave_lock_in_place()
1163
self._real_branch.unlock()
1165
# Only write-locked branched need to make a remote method call
1166
# to perfom the unlock.
1168
assert self._lock_token, 'Locked, but no token!'
1169
branch_token = self._lock_token
1170
repo_token = self._repo_lock_token
1171
self._lock_token = None
1172
self._repo_lock_token = None
1173
if not self._leave_lock:
1174
self._unlock(branch_token, repo_token)
1176
def break_lock(self):
1178
return self._real_branch.break_lock()
1180
def leave_lock_in_place(self):
1181
if not self._lock_token:
1182
raise NotImplementedError(self.leave_lock_in_place)
1183
self._leave_lock = True
1185
def dont_leave_lock_in_place(self):
1186
if not self._lock_token:
1187
raise NotImplementedError(self.dont_leave_lock_in_place)
1188
self._leave_lock = False
1190
def last_revision_info(self):
1191
"""See Branch.last_revision_info()."""
1192
path = self.bzrdir._path_for_remote_call(self._client)
1193
response = self._client.call('Branch.last_revision_info', path)
1194
assert response[0] == 'ok', 'unexpected response code %s' % (response,)
1195
revno = int(response[1])
1196
last_revision = response[2]
1197
return (revno, last_revision)
1199
def _gen_revision_history(self):
1200
"""See Branch._gen_revision_history()."""
1201
path = self.bzrdir._path_for_remote_call(self._client)
1202
response = self._client.call_expecting_body(
1203
'Branch.revision_history', path)
1204
assert response[0][0] == 'ok', ('unexpected response code %s'
1206
result = response[1].read_body_bytes().split('\x00')
1212
def set_revision_history(self, rev_history):
1213
# Send just the tip revision of the history; the server will generate
1214
# the full history from that. If the revision doesn't exist in this
1215
# branch, NoSuchRevision will be raised.
1216
path = self.bzrdir._path_for_remote_call(self._client)
1217
if rev_history == []:
1220
rev_id = rev_history[-1]
1221
self._clear_cached_state()
1222
response = self._client.call('Branch.set_last_revision',
1223
path, self._lock_token, self._repo_lock_token, rev_id)
1224
if response[0] == 'NoSuchRevision':
1225
raise NoSuchRevision(self, rev_id)
1227
assert response == ('ok',), (
1228
'unexpected response code %r' % (response,))
1229
self._cache_revision_history(rev_history)
1231
def get_parent(self):
1233
return self._real_branch.get_parent()
1235
def set_parent(self, url):
1237
return self._real_branch.set_parent(url)
1239
def get_config(self):
1240
return RemoteBranchConfig(self)
1242
def sprout(self, to_bzrdir, revision_id=None):
1243
# Like Branch.sprout, except that it sprouts a branch in the default
1244
# format, because RemoteBranches can't be created at arbitrary URLs.
1245
# XXX: if to_bzrdir is a RemoteBranch, this should perhaps do
1246
# to_bzrdir.create_branch...
1248
result = self._real_branch._format.initialize(to_bzrdir)
1249
self.copy_content_into(result, revision_id=revision_id)
1250
result.set_parent(self.bzrdir.root_transport.base)
1254
def pull(self, source, overwrite=False, stop_revision=None,
1256
# FIXME: This asks the real branch to run the hooks, which means
1257
# they're called with the wrong target branch parameter.
1258
# The test suite specifically allows this at present but it should be
1259
# fixed. It should get a _override_hook_target branch,
1260
# as push does. -- mbp 20070405
1262
self._real_branch.pull(
1263
source, overwrite=overwrite, stop_revision=stop_revision,
1267
def push(self, target, overwrite=False, stop_revision=None):
1269
return self._real_branch.push(
1270
target, overwrite=overwrite, stop_revision=stop_revision,
1271
_override_hook_source_branch=self)
1273
def is_locked(self):
1274
return self._lock_count >= 1
1276
def set_last_revision_info(self, revno, revision_id):
1278
self._clear_cached_state()
1279
return self._real_branch.set_last_revision_info(revno, revision_id)
1281
def generate_revision_history(self, revision_id, last_rev=None,
1284
return self._real_branch.generate_revision_history(
1285
revision_id, last_rev=last_rev, other_branch=other_branch)
1290
return self._real_branch.tags
1292
def set_push_location(self, location):
1294
return self._real_branch.set_push_location(location)
1296
def update_revisions(self, other, stop_revision=None, overwrite=False):
1298
return self._real_branch.update_revisions(
1299
other, stop_revision=stop_revision, overwrite=overwrite)
1302
class RemoteBranchConfig(BranchConfig):
1305
self.branch._ensure_real()
1306
return self.branch._real_branch.get_config().username()
1308
def _get_branch_data_config(self):
1309
self.branch._ensure_real()
1310
if self._branch_data_config is None:
1311
self._branch_data_config = TreeConfig(self.branch._real_branch)
1312
return self._branch_data_config
1315
def _extract_tar(tar, to_dir):
1316
"""Extract all the contents of a tarfile object.
1318
A replacement for extractall, which is not present in python2.4
1321
tar.extract(tarinfo, to_dir)
added
removed
bzrlib/remote.py
