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
30
from bzrlib.branch import BranchReferenceFormat
31
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
32
from bzrlib.config import BranchConfig, TreeConfig
33
from bzrlib.decorators import needs_read_lock, needs_write_lock
34
from bzrlib.errors import NoSuchRevision
35
from bzrlib.lockable_files import LockableFiles
36
from bzrlib.pack import ContainerPushParser
37
from bzrlib.smart import client, vfs
38
from bzrlib.symbol_versioning import (
42
from bzrlib.revision import NULL_REVISION
43
from bzrlib.trace import note
45
# Note: RemoteBzrDirFormat is in bzrdir.py
47
class RemoteBzrDir(BzrDir):
48
"""Control directory on a remote server, accessed via bzr:// or similar."""
50
def __init__(self, transport, _client=None):
51
"""Construct a RemoteBzrDir.
53
:param _client: Private parameter for testing. Disables probing and the
56
BzrDir.__init__(self, transport, RemoteBzrDirFormat())
57
# this object holds a delegated bzrdir that uses file-level operations
58
# to talk to the other side
59
self._real_bzrdir = None
62
self._shared_medium = transport.get_shared_medium()
63
self._client = client._SmartClient(self._shared_medium)
65
self._client = _client
66
self._shared_medium = None
69
path = self._path_for_remote_call(self._client)
70
response = self._client.call('BzrDir.open', path)
71
if response not in [('yes',), ('no',)]:
72
raise errors.UnexpectedSmartServerResponse(response)
73
if response == ('no',):
74
raise errors.NotBranchError(path=transport.base)
76
def _ensure_real(self):
77
"""Ensure that there is a _real_bzrdir set.
79
Used before calls to self._real_bzrdir.
81
if not self._real_bzrdir:
82
self._real_bzrdir = BzrDir.open_from_transport(
83
self.root_transport, _server_formats=False)
85
def create_repository(self, shared=False):
87
self._real_bzrdir.create_repository(shared=shared)
88
return self.open_repository()
90
def destroy_repository(self):
91
"""See BzrDir.destroy_repository"""
93
self._real_bzrdir.destroy_repository()
95
def create_branch(self):
97
real_branch = self._real_bzrdir.create_branch()
98
return RemoteBranch(self, self.find_repository(), real_branch)
100
def destroy_branch(self):
101
"""See BzrDir.destroy_branch"""
103
self._real_bzrdir.destroy_branch()
105
def create_workingtree(self, revision_id=None, from_branch=None):
106
raise errors.NotLocalUrl(self.transport.base)
108
def find_branch_format(self):
109
"""Find the branch 'format' for this bzrdir.
111
This might be a synthetic object for e.g. RemoteBranch and SVN.
113
b = self.open_branch()
116
def get_branch_reference(self):
117
"""See BzrDir.get_branch_reference()."""
118
path = self._path_for_remote_call(self._client)
119
response = self._client.call('BzrDir.open_branch', path)
120
if response[0] == 'ok':
121
if response[1] == '':
122
# branch at this location.
125
# a branch reference, use the existing BranchReference logic.
127
elif response == ('nobranch',):
128
raise errors.NotBranchError(path=self.root_transport.base)
130
raise errors.UnexpectedSmartServerResponse(response)
132
def open_branch(self, _unsupported=False):
133
assert _unsupported == False, 'unsupported flag support not implemented yet.'
134
reference_url = self.get_branch_reference()
135
if reference_url is None:
136
# branch at this location.
137
return RemoteBranch(self, self.find_repository())
139
# a branch reference, use the existing BranchReference logic.
140
format = BranchReferenceFormat()
141
return format.open(self, _found=True, location=reference_url)
143
def open_repository(self):
144
path = self._path_for_remote_call(self._client)
145
response = self._client.call('BzrDir.find_repository', path)
146
assert response[0] in ('ok', 'norepository'), \
147
'unexpected response code %s' % (response,)
148
if response[0] == 'norepository':
149
raise errors.NoRepositoryPresent(self)
150
assert len(response) == 4, 'incorrect response length %s' % (response,)
151
if response[1] == '':
152
format = RemoteRepositoryFormat()
153
format.rich_root_data = (response[2] == 'yes')
154
format.supports_tree_reference = (response[3] == 'yes')
155
return RemoteRepository(self, format)
157
raise errors.NoRepositoryPresent(self)
159
def open_workingtree(self, recommend_upgrade=True):
161
if self._real_bzrdir.has_workingtree():
162
raise errors.NotLocalUrl(self.root_transport)
164
raise errors.NoWorkingTree(self.root_transport.base)
166
def _path_for_remote_call(self, client):
167
"""Return the path to be used for this bzrdir in a remote call."""
168
return client.remote_path_from_transport(self.root_transport)
170
def get_branch_transport(self, branch_format):
172
return self._real_bzrdir.get_branch_transport(branch_format)
174
def get_repository_transport(self, repository_format):
176
return self._real_bzrdir.get_repository_transport(repository_format)
178
def get_workingtree_transport(self, workingtree_format):
180
return self._real_bzrdir.get_workingtree_transport(workingtree_format)
182
def can_convert_format(self):
183
"""Upgrading of remote bzrdirs is not supported yet."""
186
def needs_format_conversion(self, format=None):
187
"""Upgrading of remote bzrdirs is not supported yet."""
190
def clone(self, url, revision_id=None, force_new_repo=False):
192
return self._real_bzrdir.clone(url, revision_id=revision_id,
193
force_new_repo=force_new_repo)
196
class RemoteRepositoryFormat(repository.RepositoryFormat):
197
"""Format for repositories accessed over a _SmartClient.
199
Instances of this repository are represented by RemoteRepository
202
The RemoteRepositoryFormat is parameterized during construction
203
to reflect the capabilities of the real, remote format. Specifically
204
the attributes rich_root_data and supports_tree_reference are set
205
on a per instance basis, and are not set (and should not be) at
209
_matchingbzrdir = RemoteBzrDirFormat
211
def initialize(self, a_bzrdir, shared=False):
212
assert isinstance(a_bzrdir, RemoteBzrDir), \
213
'%r is not a RemoteBzrDir' % (a_bzrdir,)
214
return a_bzrdir.create_repository(shared=shared)
216
def open(self, a_bzrdir):
217
assert isinstance(a_bzrdir, RemoteBzrDir)
218
return a_bzrdir.open_repository()
220
def get_format_description(self):
221
return 'bzr remote repository'
223
def __eq__(self, other):
224
return self.__class__ == other.__class__
226
def check_conversion_target(self, target_format):
227
if self.rich_root_data and not target_format.rich_root_data:
228
raise errors.BadConversionTarget(
229
'Does not support rich root data.', target_format)
230
if (self.supports_tree_reference and
231
not getattr(target_format, 'supports_tree_reference', False)):
232
raise errors.BadConversionTarget(
233
'Does not support nested trees', target_format)
236
class RemoteRepository(object):
237
"""Repository accessed over rpc.
239
For the moment most operations are performed using local transport-backed
243
def __init__(self, remote_bzrdir, format, real_repository=None, _client=None):
244
"""Create a RemoteRepository instance.
246
:param remote_bzrdir: The bzrdir hosting this repository.
247
:param format: The RemoteFormat object to use.
248
:param real_repository: If not None, a local implementation of the
249
repository logic for the repository, usually accessing the data
251
:param _client: Private testing parameter - override the smart client
252
to be used by the repository.
255
self._real_repository = real_repository
257
self._real_repository = None
258
self.bzrdir = remote_bzrdir
260
self._client = client._SmartClient(self.bzrdir._shared_medium)
262
self._client = _client
263
self._format = format
264
self._lock_mode = None
265
self._lock_token = None
267
self._leave_lock = False
268
# A cache of looked up revision parent data; reset at unlock time.
269
self._parents_map = None
271
# These depend on the actual remote format, so force them off for
272
# maximum compatibility. XXX: In future these should depend on the
273
# remote repository instance, but this is irrelevant until we perform
274
# reconcile via an RPC call.
275
self._reconcile_does_inventory_gc = False
276
self._reconcile_fixes_text_parents = False
277
self._reconcile_backsup_inventory = False
278
self.base = self.bzrdir.transport.base
281
return "%s(%s)" % (self.__class__.__name__, self.base)
285
def abort_write_group(self):
286
"""Complete a write group on the decorated repository.
288
Smart methods peform operations in a single step so this api
289
is not really applicable except as a compatibility thunk
290
for older plugins that don't use e.g. the CommitBuilder
294
return self._real_repository.abort_write_group()
296
def commit_write_group(self):
297
"""Complete a write group on the decorated repository.
299
Smart methods peform operations in a single step so this api
300
is not really applicable except as a compatibility thunk
301
for older plugins that don't use e.g. the CommitBuilder
305
return self._real_repository.commit_write_group()
307
def _ensure_real(self):
308
"""Ensure that there is a _real_repository set.
310
Used before calls to self._real_repository.
312
if not self._real_repository:
313
self.bzrdir._ensure_real()
314
#self._real_repository = self.bzrdir._real_bzrdir.open_repository()
315
self._set_real_repository(self.bzrdir._real_bzrdir.open_repository())
317
def find_text_key_references(self):
318
"""Find the text key references within the repository.
320
:return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
321
revision_ids. Each altered file-ids has the exact revision_ids that
322
altered it listed explicitly.
323
:return: A dictionary mapping text keys ((fileid, revision_id) tuples)
324
to whether they were referred to by the inventory of the
325
revision_id that they contain. The inventory texts from all present
326
revision ids are assessed to generate this report.
329
return self._real_repository.find_text_key_references()
331
def _generate_text_key_index(self):
332
"""Generate a new text key index for the repository.
334
This is an expensive function that will take considerable time to run.
336
:return: A dict mapping (file_id, revision_id) tuples to a list of
337
parents, also (file_id, revision_id) tuples.
340
return self._real_repository._generate_text_key_index()
342
def get_revision_graph(self, revision_id=None):
343
"""See Repository.get_revision_graph()."""
344
if revision_id is None:
346
elif revision.is_null(revision_id):
349
path = self.bzrdir._path_for_remote_call(self._client)
350
assert type(revision_id) is str
351
response = self._client.call_expecting_body(
352
'Repository.get_revision_graph', path, revision_id)
353
if response[0][0] not in ['ok', 'nosuchrevision']:
354
raise errors.UnexpectedSmartServerResponse(response[0])
355
if response[0][0] == 'ok':
356
coded = response[1].read_body_bytes()
358
# no revisions in this repository!
360
lines = coded.split('\n')
363
d = tuple(line.split())
364
revision_graph[d[0]] = d[1:]
366
return revision_graph
368
response_body = response[1].read_body_bytes()
369
assert response_body == ''
370
raise NoSuchRevision(self, revision_id)
372
def has_revision(self, revision_id):
373
"""See Repository.has_revision()."""
374
if revision_id == NULL_REVISION:
375
# The null revision is always present.
377
path = self.bzrdir._path_for_remote_call(self._client)
378
response = self._client.call('Repository.has_revision', path, revision_id)
379
assert response[0] in ('yes', 'no'), 'unexpected response code %s' % (response,)
380
return response[0] == 'yes'
382
def has_revisions(self, revision_ids):
383
"""See Repository.has_revisions()."""
385
for revision_id in revision_ids:
386
if self.has_revision(revision_id):
387
result.add(revision_id)
390
def has_same_location(self, other):
391
return (self.__class__ == other.__class__ and
392
self.bzrdir.transport.base == other.bzrdir.transport.base)
394
def get_graph(self, other_repository=None):
395
"""Return the graph for this repository format"""
396
parents_provider = self
397
if (other_repository is not None and
398
other_repository.bzrdir.transport.base !=
399
self.bzrdir.transport.base):
400
parents_provider = graph._StackedParentsProvider(
401
[parents_provider, other_repository._make_parents_provider()])
402
return graph.Graph(parents_provider)
404
def gather_stats(self, revid=None, committers=None):
405
"""See Repository.gather_stats()."""
406
path = self.bzrdir._path_for_remote_call(self._client)
407
# revid can be None to indicate no revisions, not just NULL_REVISION
408
if revid is None or revision.is_null(revid):
412
if committers is None or not committers:
413
fmt_committers = 'no'
415
fmt_committers = 'yes'
416
response = self._client.call_expecting_body(
417
'Repository.gather_stats', path, fmt_revid, fmt_committers)
418
assert response[0][0] == 'ok', \
419
'unexpected response code %s' % (response[0],)
421
body = response[1].read_body_bytes()
423
for line in body.split('\n'):
426
key, val_text = line.split(':')
427
if key in ('revisions', 'size', 'committers'):
428
result[key] = int(val_text)
429
elif key in ('firstrev', 'latestrev'):
430
values = val_text.split(' ')[1:]
431
result[key] = (float(values[0]), long(values[1]))
435
def find_branches(self, using=False):
436
"""See Repository.find_branches()."""
437
# should be an API call to the server.
439
return self._real_repository.find_branches(using=using)
441
def get_physical_lock_status(self):
442
"""See Repository.get_physical_lock_status()."""
443
# should be an API call to the server.
445
return self._real_repository.get_physical_lock_status()
447
def is_in_write_group(self):
448
"""Return True if there is an open write group.
450
write groups are only applicable locally for the smart server..
452
if self._real_repository:
453
return self._real_repository.is_in_write_group()
456
return self._lock_count >= 1
459
"""See Repository.is_shared()."""
460
path = self.bzrdir._path_for_remote_call(self._client)
461
response = self._client.call('Repository.is_shared', path)
462
assert response[0] in ('yes', 'no'), 'unexpected response code %s' % (response,)
463
return response[0] == 'yes'
465
def is_write_locked(self):
466
return self._lock_mode == 'w'
469
# wrong eventually - want a local lock cache context
470
if not self._lock_mode:
471
self._lock_mode = 'r'
473
self._parents_map = {}
474
if self._real_repository is not None:
475
self._real_repository.lock_read()
477
self._lock_count += 1
479
def _remote_lock_write(self, token):
480
path = self.bzrdir._path_for_remote_call(self._client)
483
response = self._client.call('Repository.lock_write', path, token)
484
if response[0] == 'ok':
487
elif response[0] == 'LockContention':
488
raise errors.LockContention('(remote lock)')
489
elif response[0] == 'UnlockableTransport':
490
raise errors.UnlockableTransport(self.bzrdir.root_transport)
491
elif response[0] == 'LockFailed':
492
raise errors.LockFailed(response[1], response[2])
494
raise errors.UnexpectedSmartServerResponse(response)
496
def lock_write(self, token=None):
497
if not self._lock_mode:
498
self._lock_token = self._remote_lock_write(token)
499
# if self._lock_token is None, then this is something like packs or
500
# svn where we don't get to lock the repo, or a weave style repository
501
# where we cannot lock it over the wire and attempts to do so will
503
if self._real_repository is not None:
504
self._real_repository.lock_write(token=self._lock_token)
505
if token is not None:
506
self._leave_lock = True
508
self._leave_lock = False
509
self._lock_mode = 'w'
511
self._parents_map = {}
512
elif self._lock_mode == 'r':
513
raise errors.ReadOnlyError(self)
515
self._lock_count += 1
516
return self._lock_token or None
518
def leave_lock_in_place(self):
519
if not self._lock_token:
520
raise NotImplementedError(self.leave_lock_in_place)
521
self._leave_lock = True
523
def dont_leave_lock_in_place(self):
524
if not self._lock_token:
525
raise NotImplementedError(self.dont_leave_lock_in_place)
526
self._leave_lock = False
528
def _set_real_repository(self, repository):
529
"""Set the _real_repository for this repository.
531
:param repository: The repository to fallback to for non-hpss
532
implemented operations.
534
assert not isinstance(repository, RemoteRepository)
535
self._real_repository = repository
536
if self._lock_mode == 'w':
537
# if we are already locked, the real repository must be able to
538
# acquire the lock with our token.
539
self._real_repository.lock_write(self._lock_token)
540
elif self._lock_mode == 'r':
541
self._real_repository.lock_read()
543
def start_write_group(self):
544
"""Start a write group on the decorated repository.
546
Smart methods peform operations in a single step so this api
547
is not really applicable except as a compatibility thunk
548
for older plugins that don't use e.g. the CommitBuilder
552
return self._real_repository.start_write_group()
554
def _unlock(self, token):
555
path = self.bzrdir._path_for_remote_call(self._client)
557
# with no token the remote repository is not persistently locked.
559
response = self._client.call('Repository.unlock', path, token)
560
if response == ('ok',):
562
elif response[0] == 'TokenMismatch':
563
raise errors.TokenMismatch(token, '(remote token)')
565
raise errors.UnexpectedSmartServerResponse(response)
568
self._lock_count -= 1
569
if self._lock_count > 0:
571
self._parents_map = None
572
old_mode = self._lock_mode
573
self._lock_mode = None
575
# The real repository is responsible at present for raising an
576
# exception if it's in an unfinished write group. However, it
577
# normally will *not* actually remove the lock from disk - that's
578
# done by the server on receiving the Repository.unlock call.
579
# This is just to let the _real_repository stay up to date.
580
if self._real_repository is not None:
581
self._real_repository.unlock()
583
# The rpc-level lock should be released even if there was a
584
# problem releasing the vfs-based lock.
586
# Only write-locked repositories need to make a remote method
587
# call to perfom the unlock.
588
old_token = self._lock_token
589
self._lock_token = None
590
if not self._leave_lock:
591
self._unlock(old_token)
593
def break_lock(self):
594
# should hand off to the network
596
return self._real_repository.break_lock()
598
def _get_tarball(self, compression):
599
"""Return a TemporaryFile containing a repository tarball.
601
Returns None if the server does not support sending tarballs.
604
path = self.bzrdir._path_for_remote_call(self._client)
605
response, protocol = self._client.call_expecting_body(
606
'Repository.tarball', path, compression)
607
if response[0] == 'ok':
608
# Extract the tarball and return it
609
t = tempfile.NamedTemporaryFile()
610
# TODO: rpc layer should read directly into it...
611
t.write(protocol.read_body_bytes())
614
if (response == ('error', "Generic bzr smart protocol error: "
615
"bad request 'Repository.tarball'") or
616
response == ('error', "Generic bzr smart protocol error: "
617
"bad request u'Repository.tarball'")):
618
protocol.cancel_read_body()
620
raise errors.UnexpectedSmartServerResponse(response)
622
def sprout(self, to_bzrdir, revision_id=None):
623
# TODO: Option to control what format is created?
625
dest_repo = self._real_repository._format.initialize(to_bzrdir,
627
dest_repo.fetch(self, revision_id=revision_id)
630
### These methods are just thin shims to the VFS object for now.
632
def revision_tree(self, revision_id):
634
return self._real_repository.revision_tree(revision_id)
636
def get_serializer_format(self):
638
return self._real_repository.get_serializer_format()
640
def get_commit_builder(self, branch, parents, config, timestamp=None,
641
timezone=None, committer=None, revprops=None,
643
# FIXME: It ought to be possible to call this without immediately
644
# triggering _ensure_real. For now it's the easiest thing to do.
646
builder = self._real_repository.get_commit_builder(branch, parents,
647
config, timestamp=timestamp, timezone=timezone,
648
committer=committer, revprops=revprops, revision_id=revision_id)
652
def add_inventory(self, revid, inv, parents):
654
return self._real_repository.add_inventory(revid, inv, parents)
657
def add_revision(self, rev_id, rev, inv=None, config=None):
659
return self._real_repository.add_revision(
660
rev_id, rev, inv=inv, config=config)
663
def get_inventory(self, revision_id):
665
return self._real_repository.get_inventory(revision_id)
667
def iter_inventories(self, revision_ids):
669
return self._real_repository.iter_inventories(revision_ids)
672
def get_revision(self, revision_id):
674
return self._real_repository.get_revision(revision_id)
677
def weave_store(self):
679
return self._real_repository.weave_store
681
def get_transaction(self):
683
return self._real_repository.get_transaction()
686
def clone(self, a_bzrdir, revision_id=None):
688
return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
690
def make_working_trees(self):
691
"""RemoteRepositories never create working trees by default."""
694
def revision_ids_to_search_result(self, result_set):
695
"""Convert a set of revision ids to a graph SearchResult."""
696
result_parents = set()
697
for parents in self.get_graph().get_parent_map(
698
result_set).itervalues():
699
result_parents.update(parents)
700
included_keys = result_set.intersection(result_parents)
701
start_keys = result_set.difference(included_keys)
702
exclude_keys = result_parents.difference(result_set)
703
result = graph.SearchResult(start_keys, exclude_keys,
704
len(result_set), result_set)
708
def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
709
"""Return the revision ids that other has that this does not.
711
These are returned in topological order.
713
revision_id: only return revision ids included by revision_id.
715
return repository.InterRepository.get(
716
other, self).search_missing_revision_ids(revision_id, find_ghosts)
718
def fetch(self, source, revision_id=None, pb=None):
719
if self.has_same_location(source):
720
# check that last_revision is in 'from' and then return a
722
if (revision_id is not None and
723
not revision.is_null(revision_id)):
724
self.get_revision(revision_id)
727
return self._real_repository.fetch(
728
source, revision_id=revision_id, pb=pb)
730
def create_bundle(self, target, base, fileobj, format=None):
732
self._real_repository.create_bundle(target, base, fileobj, format)
735
def control_weaves(self):
737
return self._real_repository.control_weaves
740
def get_ancestry(self, revision_id, topo_sorted=True):
742
return self._real_repository.get_ancestry(revision_id, topo_sorted)
745
def get_inventory_weave(self):
747
return self._real_repository.get_inventory_weave()
749
def fileids_altered_by_revision_ids(self, revision_ids):
751
return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
753
def _get_versioned_file_checker(self, revisions, revision_versions_cache):
755
return self._real_repository._get_versioned_file_checker(
756
revisions, revision_versions_cache)
758
def iter_files_bytes(self, desired_files):
759
"""See Repository.iter_file_bytes.
762
return self._real_repository.iter_files_bytes(desired_files)
764
def get_parent_map(self, keys):
765
"""See bzrlib.Graph.get_parent_map()."""
766
# Hack to build up the caching logic.
767
ancestry = self._parents_map
768
missing_revisions = set(key for key in keys if key not in ancestry)
769
if missing_revisions:
770
self._parents_map.update(self._get_parent_map(missing_revisions))
771
return dict((k, ancestry[k]) for k in keys if k in ancestry)
773
def _response_is_unknown_method(self, response, verb):
774
"""Return True if response is an unknonwn method response to verb.
776
:param response: The response from a smart client call_expecting_body
778
:param verb: The verb used in that call.
779
:return: True if an unknown method was encountered.
781
# This might live better on
782
# bzrlib.smart.protocol.SmartClientRequestProtocolOne
783
if (response[0] == ('error', "Generic bzr smart protocol error: "
784
"bad request '%s'" % verb) or
785
response[0] == ('error', "Generic bzr smart protocol error: "
786
"bad request u'%s'" % verb)):
787
response[1].cancel_read_body()
791
def _get_parent_map(self, keys):
792
"""Helper for get_parent_map that performs the RPC."""
794
if NULL_REVISION in keys:
795
keys.discard(NULL_REVISION)
796
found_parents = {NULL_REVISION:()}
801
path = self.bzrdir._path_for_remote_call(self._client)
803
assert type(key) is str
804
verb = 'Repository.get_parent_map'
805
response = self._client.call_expecting_body(
807
if self._response_is_unknown_method(response, verb):
808
# Server that does not support this method, get the whole graph.
809
response = self._client.call_expecting_body(
810
'Repository.get_revision_graph', path, '')
811
if response[0][0] not in ['ok', 'nosuchrevision']:
812
reponse[1].cancel_read_body()
813
raise errors.UnexpectedSmartServerResponse(response[0])
814
elif response[0][0] not in ['ok']:
815
reponse[1].cancel_read_body()
816
raise errors.UnexpectedSmartServerResponse(response[0])
817
if response[0][0] == 'ok':
818
coded = response[1].read_body_bytes()
822
lines = coded.split('\n')
825
d = tuple(line.split())
827
revision_graph[d[0]] = d[1:]
829
# No parents - so give the Graph result (NULL_REVISION,).
830
revision_graph[d[0]] = (NULL_REVISION,)
831
return revision_graph
834
def get_signature_text(self, revision_id):
836
return self._real_repository.get_signature_text(revision_id)
839
def get_revision_graph_with_ghosts(self, revision_ids=None):
841
return self._real_repository.get_revision_graph_with_ghosts(
842
revision_ids=revision_ids)
845
def get_inventory_xml(self, revision_id):
847
return self._real_repository.get_inventory_xml(revision_id)
849
def deserialise_inventory(self, revision_id, xml):
851
return self._real_repository.deserialise_inventory(revision_id, xml)
853
def reconcile(self, other=None, thorough=False):
855
return self._real_repository.reconcile(other=other, thorough=thorough)
857
def all_revision_ids(self):
859
return self._real_repository.all_revision_ids()
862
def get_deltas_for_revisions(self, revisions):
864
return self._real_repository.get_deltas_for_revisions(revisions)
867
def get_revision_delta(self, revision_id):
869
return self._real_repository.get_revision_delta(revision_id)
872
def revision_trees(self, revision_ids):
874
return self._real_repository.revision_trees(revision_ids)
877
def get_revision_reconcile(self, revision_id):
879
return self._real_repository.get_revision_reconcile(revision_id)
882
def check(self, revision_ids=None):
884
return self._real_repository.check(revision_ids=revision_ids)
886
def copy_content_into(self, destination, revision_id=None):
888
return self._real_repository.copy_content_into(
889
destination, revision_id=revision_id)
891
def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
892
# get a tarball of the remote repository, and copy from that into the
894
from bzrlib import osutils
897
# TODO: Maybe a progress bar while streaming the tarball?
898
note("Copying repository content as tarball...")
899
tar_file = self._get_tarball('bz2')
902
destination = to_bzrdir.create_repository()
904
tar = tarfile.open('repository', fileobj=tar_file,
906
tmpdir = tempfile.mkdtemp()
908
_extract_tar(tar, tmpdir)
909
tmp_bzrdir = BzrDir.open(tmpdir)
910
tmp_repo = tmp_bzrdir.open_repository()
911
tmp_repo.copy_content_into(destination, revision_id)
913
osutils.rmtree(tmpdir)
917
# TODO: Suggestion from john: using external tar is much faster than
918
# python's tarfile library, but it may not work on windows.
922
"""Compress the data within the repository.
924
This is not currently implemented within the smart server.
927
return self._real_repository.pack()
929
def set_make_working_trees(self, new_value):
930
raise NotImplementedError(self.set_make_working_trees)
933
def sign_revision(self, revision_id, gpg_strategy):
935
return self._real_repository.sign_revision(revision_id, gpg_strategy)
938
def get_revisions(self, revision_ids):
940
return self._real_repository.get_revisions(revision_ids)
942
def supports_rich_root(self):
944
return self._real_repository.supports_rich_root()
946
def iter_reverse_revision_history(self, revision_id):
948
return self._real_repository.iter_reverse_revision_history(revision_id)
951
def _serializer(self):
953
return self._real_repository._serializer
955
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
957
return self._real_repository.store_revision_signature(
958
gpg_strategy, plaintext, revision_id)
960
def add_signature_text(self, revision_id, signature):
962
return self._real_repository.add_signature_text(revision_id, signature)
964
def has_signature_for_revision_id(self, revision_id):
966
return self._real_repository.has_signature_for_revision_id(revision_id)
968
def get_data_stream_for_search(self, search):
969
REQUEST_NAME = 'Repository.stream_revisions_chunked'
970
path = self.bzrdir._path_for_remote_call(self._client)
971
recipe = search.get_recipe()
972
start_keys = ' '.join(recipe[0])
973
stop_keys = ' '.join(recipe[1])
974
count = str(recipe[2])
975
body = '\n'.join((start_keys, stop_keys, count))
976
response, protocol = self._client.call_with_body_bytes_expecting_body(
977
REQUEST_NAME, (path,), body)
979
if response == ('ok',):
980
return self._deserialise_stream(protocol)
981
if response == ('NoSuchRevision', ):
982
# We cannot easily identify the revision that is missing in this
983
# situation without doing much more network IO. For now, bail.
984
raise NoSuchRevision(self, "unknown")
985
elif (response == ('error', "Generic bzr smart protocol error: "
986
"bad request '%s'" % REQUEST_NAME) or
987
response == ('error', "Generic bzr smart protocol error: "
988
"bad request u'%s'" % REQUEST_NAME)):
989
protocol.cancel_read_body()
991
return self._real_repository.get_data_stream_for_search(search)
993
raise errors.UnexpectedSmartServerResponse(response)
995
def _deserialise_stream(self, protocol):
996
stream = protocol.read_streamed_body()
997
container_parser = ContainerPushParser()
999
container_parser.accept_bytes(bytes)
1000
records = container_parser.read_pending_records()
1001
for record_names, record_bytes in records:
1002
if len(record_names) != 1:
1003
# These records should have only one name, and that name
1004
# should be a one-element tuple.
1005
raise errors.SmartProtocolError(
1006
'Repository data stream had invalid record name %r'
1008
name_tuple = record_names[0]
1009
yield name_tuple, record_bytes
1011
def insert_data_stream(self, stream):
1013
self._real_repository.insert_data_stream(stream)
1015
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
1017
return self._real_repository.item_keys_introduced_by(revision_ids,
1018
_files_pb=_files_pb)
1020
def revision_graph_can_have_wrong_parents(self):
1021
# The answer depends on the remote repo format.
1023
return self._real_repository.revision_graph_can_have_wrong_parents()
1025
def _find_inconsistent_revision_parents(self):
1027
return self._real_repository._find_inconsistent_revision_parents()
1029
def _check_for_inconsistent_revision_parents(self):
1031
return self._real_repository._check_for_inconsistent_revision_parents()
1033
def _make_parents_provider(self):
1037
class RemoteBranchLockableFiles(LockableFiles):
1038
"""A 'LockableFiles' implementation that talks to a smart server.
1040
This is not a public interface class.
1043
def __init__(self, bzrdir, _client):
1044
self.bzrdir = bzrdir
1045
self._client = _client
1046
self._need_find_modes = True
1047
LockableFiles.__init__(
1048
self, bzrdir.get_branch_transport(None),
1049
'lock', lockdir.LockDir)
1051
def _find_modes(self):
1052
# RemoteBranches don't let the client set the mode of control files.
1053
self._dir_mode = None
1054
self._file_mode = None
1056
def get(self, path):
1057
"""'get' a remote path as per the LockableFiles interface.
1059
:param path: the file to 'get'. If this is 'branch.conf', we do not
1060
just retrieve a file, instead we ask the smart server to generate
1061
a configuration for us - which is retrieved as an INI file.
1063
if path == 'branch.conf':
1064
path = self.bzrdir._path_for_remote_call(self._client)
1065
response = self._client.call_expecting_body(
1066
'Branch.get_config_file', path)
1067
assert response[0][0] == 'ok', \
1068
'unexpected response code %s' % (response[0],)
1069
return StringIO(response[1].read_body_bytes())
1072
return LockableFiles.get(self, path)
1075
class RemoteBranchFormat(branch.BranchFormat):
1077
def __eq__(self, other):
1078
return (isinstance(other, RemoteBranchFormat) and
1079
self.__dict__ == other.__dict__)
1081
def get_format_description(self):
1082
return 'Remote BZR Branch'
1084
def get_format_string(self):
1085
return 'Remote BZR Branch'
1087
def open(self, a_bzrdir):
1088
assert isinstance(a_bzrdir, RemoteBzrDir)
1089
return a_bzrdir.open_branch()
1091
def initialize(self, a_bzrdir):
1092
assert isinstance(a_bzrdir, RemoteBzrDir)
1093
return a_bzrdir.create_branch()
1095
def supports_tags(self):
1096
# Remote branches might support tags, but we won't know until we
1097
# access the real remote branch.
1101
class RemoteBranch(branch.Branch):
1102
"""Branch stored on a server accessed by HPSS RPC.
1104
At the moment most operations are mapped down to simple file operations.
1107
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
1109
"""Create a RemoteBranch instance.
1111
:param real_branch: An optional local implementation of the branch
1112
format, usually accessing the data via the VFS.
1113
:param _client: Private parameter for testing.
1115
# We intentionally don't call the parent class's __init__, because it
1116
# will try to assign to self.tags, which is a property in this subclass.
1117
# And the parent's __init__ doesn't do much anyway.
1118
self._revision_id_to_revno_cache = None
1119
self._revision_history_cache = None
1120
self.bzrdir = remote_bzrdir
1121
if _client is not None:
1122
self._client = _client
1124
self._client = client._SmartClient(self.bzrdir._shared_medium)
1125
self.repository = remote_repository
1126
if real_branch is not None:
1127
self._real_branch = real_branch
1128
# Give the remote repository the matching real repo.
1129
real_repo = self._real_branch.repository
1130
if isinstance(real_repo, RemoteRepository):
1131
real_repo._ensure_real()
1132
real_repo = real_repo._real_repository
1133
self.repository._set_real_repository(real_repo)
1134
# Give the branch the remote repository to let fast-pathing happen.
1135
self._real_branch.repository = self.repository
1137
self._real_branch = None
1138
# Fill out expected attributes of branch for bzrlib api users.
1139
self._format = RemoteBranchFormat()
1140
self.base = self.bzrdir.root_transport.base
1141
self._control_files = None
1142
self._lock_mode = None
1143
self._lock_token = None
1144
self._lock_count = 0
1145
self._leave_lock = False
1148
return "%s(%s)" % (self.__class__.__name__, self.base)
1152
def _ensure_real(self):
1153
"""Ensure that there is a _real_branch set.
1155
Used before calls to self._real_branch.
1157
if not self._real_branch:
1158
assert vfs.vfs_enabled()
1159
self.bzrdir._ensure_real()
1160
self._real_branch = self.bzrdir._real_bzrdir.open_branch()
1161
# Give the remote repository the matching real repo.
1162
real_repo = self._real_branch.repository
1163
if isinstance(real_repo, RemoteRepository):
1164
real_repo._ensure_real()
1165
real_repo = real_repo._real_repository
1166
self.repository._set_real_repository(real_repo)
1167
# Give the branch the remote repository to let fast-pathing happen.
1168
self._real_branch.repository = self.repository
1169
# XXX: deal with _lock_mode == 'w'
1170
if self._lock_mode == 'r':
1171
self._real_branch.lock_read()
1174
def control_files(self):
1175
# Defer actually creating RemoteBranchLockableFiles until its needed,
1176
# because it triggers an _ensure_real that we otherwise might not need.
1177
if self._control_files is None:
1178
self._control_files = RemoteBranchLockableFiles(
1179
self.bzrdir, self._client)
1180
return self._control_files
1182
def _get_checkout_format(self):
1184
return self._real_branch._get_checkout_format()
1186
def get_physical_lock_status(self):
1187
"""See Branch.get_physical_lock_status()."""
1188
# should be an API call to the server, as branches must be lockable.
1190
return self._real_branch.get_physical_lock_status()
1192
def lock_read(self):
1193
if not self._lock_mode:
1194
self._lock_mode = 'r'
1195
self._lock_count = 1
1196
if self._real_branch is not None:
1197
self._real_branch.lock_read()
1199
self._lock_count += 1
1201
def _remote_lock_write(self, token):
1203
branch_token = repo_token = ''
1205
branch_token = token
1206
repo_token = self.repository.lock_write()
1207
self.repository.unlock()
1208
path = self.bzrdir._path_for_remote_call(self._client)
1209
response = self._client.call('Branch.lock_write', path, branch_token,
1211
if response[0] == 'ok':
1212
ok, branch_token, repo_token = response
1213
return branch_token, repo_token
1214
elif response[0] == 'LockContention':
1215
raise errors.LockContention('(remote lock)')
1216
elif response[0] == 'TokenMismatch':
1217
raise errors.TokenMismatch(token, '(remote token)')
1218
elif response[0] == 'UnlockableTransport':
1219
raise errors.UnlockableTransport(self.bzrdir.root_transport)
1220
elif response[0] == 'ReadOnlyError':
1221
raise errors.ReadOnlyError(self)
1222
elif response[0] == 'LockFailed':
1223
raise errors.LockFailed(response[1], response[2])
1225
raise errors.UnexpectedSmartServerResponse(response)
1227
def lock_write(self, token=None):
1228
if not self._lock_mode:
1229
remote_tokens = self._remote_lock_write(token)
1230
self._lock_token, self._repo_lock_token = remote_tokens
1231
assert self._lock_token, 'Remote server did not return a token!'
1232
# TODO: We really, really, really don't want to call _ensure_real
1233
# here, but it's the easiest way to ensure coherency between the
1234
# state of the RemoteBranch and RemoteRepository objects and the
1235
# physical locks. If we don't materialise the real objects here,
1236
# then getting everything in the right state later is complex, so
1237
# for now we just do it the lazy way.
1238
# -- Andrew Bennetts, 2007-02-22.
1240
if self._real_branch is not None:
1241
self._real_branch.repository.lock_write(
1242
token=self._repo_lock_token)
1244
self._real_branch.lock_write(token=self._lock_token)
1246
self._real_branch.repository.unlock()
1247
if token is not None:
1248
self._leave_lock = True
1250
# XXX: this case seems to be unreachable; token cannot be None.
1251
self._leave_lock = False
1252
self._lock_mode = 'w'
1253
self._lock_count = 1
1254
elif self._lock_mode == 'r':
1255
raise errors.ReadOnlyTransaction
1257
if token is not None:
1258
# A token was given to lock_write, and we're relocking, so check
1259
# that the given token actually matches the one we already have.
1260
if token != self._lock_token:
1261
raise errors.TokenMismatch(token, self._lock_token)
1262
self._lock_count += 1
1263
return self._lock_token or None
1265
def _unlock(self, branch_token, repo_token):
1266
path = self.bzrdir._path_for_remote_call(self._client)
1267
response = self._client.call('Branch.unlock', path, branch_token,
1269
if response == ('ok',):
1271
elif response[0] == 'TokenMismatch':
1272
raise errors.TokenMismatch(
1273
str((branch_token, repo_token)), '(remote tokens)')
1275
raise errors.UnexpectedSmartServerResponse(response)
1278
self._lock_count -= 1
1279
if not self._lock_count:
1280
self._clear_cached_state()
1281
mode = self._lock_mode
1282
self._lock_mode = None
1283
if self._real_branch is not None:
1284
if (not self._leave_lock and mode == 'w' and
1285
self._repo_lock_token):
1286
# If this RemoteBranch will remove the physical lock for the
1287
# repository, make sure the _real_branch doesn't do it
1288
# first. (Because the _real_branch's repository is set to
1289
# be the RemoteRepository.)
1290
self._real_branch.repository.leave_lock_in_place()
1291
self._real_branch.unlock()
1293
# Only write-locked branched need to make a remote method call
1294
# to perfom the unlock.
1296
assert self._lock_token, 'Locked, but no token!'
1297
branch_token = self._lock_token
1298
repo_token = self._repo_lock_token
1299
self._lock_token = None
1300
self._repo_lock_token = None
1301
if not self._leave_lock:
1302
self._unlock(branch_token, repo_token)
1304
def break_lock(self):
1306
return self._real_branch.break_lock()
1308
def leave_lock_in_place(self):
1309
if not self._lock_token:
1310
raise NotImplementedError(self.leave_lock_in_place)
1311
self._leave_lock = True
1313
def dont_leave_lock_in_place(self):
1314
if not self._lock_token:
1315
raise NotImplementedError(self.dont_leave_lock_in_place)
1316
self._leave_lock = False
1318
def last_revision_info(self):
1319
"""See Branch.last_revision_info()."""
1320
path = self.bzrdir._path_for_remote_call(self._client)
1321
response = self._client.call('Branch.last_revision_info', path)
1322
assert response[0] == 'ok', 'unexpected response code %s' % (response,)
1323
revno = int(response[1])
1324
last_revision = response[2]
1325
return (revno, last_revision)
1327
def _gen_revision_history(self):
1328
"""See Branch._gen_revision_history()."""
1329
path = self.bzrdir._path_for_remote_call(self._client)
1330
response = self._client.call_expecting_body(
1331
'Branch.revision_history', path)
1332
assert response[0][0] == 'ok', ('unexpected response code %s'
1334
result = response[1].read_body_bytes().split('\x00')
1340
def set_revision_history(self, rev_history):
1341
# Send just the tip revision of the history; the server will generate
1342
# the full history from that. If the revision doesn't exist in this
1343
# branch, NoSuchRevision will be raised.
1344
path = self.bzrdir._path_for_remote_call(self._client)
1345
if rev_history == []:
1348
rev_id = rev_history[-1]
1349
self._clear_cached_state()
1350
response = self._client.call('Branch.set_last_revision',
1351
path, self._lock_token, self._repo_lock_token, rev_id)
1352
if response[0] == 'NoSuchRevision':
1353
raise NoSuchRevision(self, rev_id)
1355
assert response == ('ok',), (
1356
'unexpected response code %r' % (response,))
1357
self._cache_revision_history(rev_history)
1359
def get_parent(self):
1361
return self._real_branch.get_parent()
1363
def set_parent(self, url):
1365
return self._real_branch.set_parent(url)
1367
def get_config(self):
1368
return RemoteBranchConfig(self)
1370
def sprout(self, to_bzrdir, revision_id=None):
1371
# Like Branch.sprout, except that it sprouts a branch in the default
1372
# format, because RemoteBranches can't be created at arbitrary URLs.
1373
# XXX: if to_bzrdir is a RemoteBranch, this should perhaps do
1374
# to_bzrdir.create_branch...
1376
result = self._real_branch._format.initialize(to_bzrdir)
1377
self.copy_content_into(result, revision_id=revision_id)
1378
result.set_parent(self.bzrdir.root_transport.base)
1382
def pull(self, source, overwrite=False, stop_revision=None,
1384
# FIXME: This asks the real branch to run the hooks, which means
1385
# they're called with the wrong target branch parameter.
1386
# The test suite specifically allows this at present but it should be
1387
# fixed. It should get a _override_hook_target branch,
1388
# as push does. -- mbp 20070405
1390
self._real_branch.pull(
1391
source, overwrite=overwrite, stop_revision=stop_revision,
1395
def push(self, target, overwrite=False, stop_revision=None):
1397
return self._real_branch.push(
1398
target, overwrite=overwrite, stop_revision=stop_revision,
1399
_override_hook_source_branch=self)
1401
def is_locked(self):
1402
return self._lock_count >= 1
1404
def set_last_revision_info(self, revno, revision_id):
1406
self._clear_cached_state()
1407
return self._real_branch.set_last_revision_info(revno, revision_id)
1409
def generate_revision_history(self, revision_id, last_rev=None,
1412
return self._real_branch.generate_revision_history(
1413
revision_id, last_rev=last_rev, other_branch=other_branch)
1418
return self._real_branch.tags
1420
def set_push_location(self, location):
1422
return self._real_branch.set_push_location(location)
1424
def update_revisions(self, other, stop_revision=None, overwrite=False):
1426
return self._real_branch.update_revisions(
1427
other, stop_revision=stop_revision, overwrite=overwrite)
1430
class RemoteBranchConfig(BranchConfig):
1433
self.branch._ensure_real()
1434
return self.branch._real_branch.get_config().username()
1436
def _get_branch_data_config(self):
1437
self.branch._ensure_real()
1438
if self._branch_data_config is None:
1439
self._branch_data_config = TreeConfig(self.branch._real_branch)
1440
return self._branch_data_config
1443
def _extract_tar(tar, to_dir):
1444
"""Extract all the contents of a tarfile object.
1446
A replacement for extractall, which is not present in python2.4
1449
tar.extract(tarinfo, to_dir)
added
removed
bzrlib/remote.py
