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
31
from bzrlib.branch import BranchReferenceFormat
32
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
33
from bzrlib.config import BranchConfig, TreeConfig
34
from bzrlib.decorators import needs_read_lock, needs_write_lock
35
from bzrlib.errors import NoSuchRevision
36
from bzrlib.lockable_files import LockableFiles
37
from bzrlib.pack import ContainerPushParser
38
from bzrlib.smart import client, vfs
39
from bzrlib.symbol_versioning import (
43
from bzrlib.revision import NULL_REVISION
44
from bzrlib.trace import mutter, note
46
# Note: RemoteBzrDirFormat is in bzrdir.py
48
class RemoteBzrDir(BzrDir):
49
"""Control directory on a remote server, accessed via bzr:// or similar."""
51
def __init__(self, transport, _client=None):
52
"""Construct a RemoteBzrDir.
54
:param _client: Private parameter for testing. Disables probing and the
57
BzrDir.__init__(self, transport, RemoteBzrDirFormat())
58
# this object holds a delegated bzrdir that uses file-level operations
59
# to talk to the other side
60
self._real_bzrdir = None
63
self._shared_medium = transport.get_shared_medium()
64
self._client = client._SmartClient(self._shared_medium)
66
self._client = _client
67
self._shared_medium = None
70
path = self._path_for_remote_call(self._client)
71
response = self._client.call('BzrDir.open', path)
72
if response not in [('yes',), ('no',)]:
73
raise errors.UnexpectedSmartServerResponse(response)
74
if response == ('no',):
75
raise errors.NotBranchError(path=transport.base)
77
def _ensure_real(self):
78
"""Ensure that there is a _real_bzrdir set.
80
Used before calls to self._real_bzrdir.
82
if not self._real_bzrdir:
83
self._real_bzrdir = BzrDir.open_from_transport(
84
self.root_transport, _server_formats=False)
86
def create_repository(self, shared=False):
88
self._real_bzrdir.create_repository(shared=shared)
89
return self.open_repository()
91
def destroy_repository(self):
92
"""See BzrDir.destroy_repository"""
94
self._real_bzrdir.destroy_repository()
96
def create_branch(self):
98
real_branch = self._real_bzrdir.create_branch()
99
return RemoteBranch(self, self.find_repository(), real_branch)
101
def destroy_branch(self):
102
"""See BzrDir.destroy_branch"""
104
self._real_bzrdir.destroy_branch()
106
def create_workingtree(self, revision_id=None, from_branch=None):
107
raise errors.NotLocalUrl(self.transport.base)
109
def find_branch_format(self):
110
"""Find the branch 'format' for this bzrdir.
112
This might be a synthetic object for e.g. RemoteBranch and SVN.
114
b = self.open_branch()
117
def get_branch_reference(self):
118
"""See BzrDir.get_branch_reference()."""
119
path = self._path_for_remote_call(self._client)
120
response = self._client.call('BzrDir.open_branch', path)
121
if response[0] == 'ok':
122
if response[1] == '':
123
# branch at this location.
126
# a branch reference, use the existing BranchReference logic.
128
elif response == ('nobranch',):
129
raise errors.NotBranchError(path=self.root_transport.base)
131
raise errors.UnexpectedSmartServerResponse(response)
133
def open_branch(self, _unsupported=False):
134
assert _unsupported == False, 'unsupported flag support not implemented yet.'
135
reference_url = self.get_branch_reference()
136
if reference_url is None:
137
# branch at this location.
138
return RemoteBranch(self, self.find_repository())
140
# a branch reference, use the existing BranchReference logic.
141
format = BranchReferenceFormat()
142
return format.open(self, _found=True, location=reference_url)
144
def open_repository(self):
145
path = self._path_for_remote_call(self._client)
146
response = self._client.call('BzrDir.find_repository', path)
147
assert response[0] in ('ok', 'norepository'), \
148
'unexpected response code %s' % (response,)
149
if response[0] == 'norepository':
150
raise errors.NoRepositoryPresent(self)
151
assert len(response) == 4, 'incorrect response length %s' % (response,)
152
if response[1] == '':
153
format = RemoteRepositoryFormat()
154
format.rich_root_data = (response[2] == 'yes')
155
format.supports_tree_reference = (response[3] == 'yes')
156
return RemoteRepository(self, format)
158
raise errors.NoRepositoryPresent(self)
160
def open_workingtree(self, recommend_upgrade=True):
162
if self._real_bzrdir.has_workingtree():
163
raise errors.NotLocalUrl(self.root_transport)
165
raise errors.NoWorkingTree(self.root_transport.base)
167
def _path_for_remote_call(self, client):
168
"""Return the path to be used for this bzrdir in a remote call."""
169
return client.remote_path_from_transport(self.root_transport)
171
def get_branch_transport(self, branch_format):
173
return self._real_bzrdir.get_branch_transport(branch_format)
175
def get_repository_transport(self, repository_format):
177
return self._real_bzrdir.get_repository_transport(repository_format)
179
def get_workingtree_transport(self, workingtree_format):
181
return self._real_bzrdir.get_workingtree_transport(workingtree_format)
183
def can_convert_format(self):
184
"""Upgrading of remote bzrdirs is not supported yet."""
187
def needs_format_conversion(self, format=None):
188
"""Upgrading of remote bzrdirs is not supported yet."""
191
def clone(self, url, revision_id=None, force_new_repo=False):
193
return self._real_bzrdir.clone(url, revision_id=revision_id,
194
force_new_repo=force_new_repo)
197
class RemoteRepositoryFormat(repository.RepositoryFormat):
198
"""Format for repositories accessed over a _SmartClient.
200
Instances of this repository are represented by RemoteRepository
203
The RemoteRepositoryFormat is parameterized during construction
204
to reflect the capabilities of the real, remote format. Specifically
205
the attributes rich_root_data and supports_tree_reference are set
206
on a per instance basis, and are not set (and should not be) at
210
_matchingbzrdir = RemoteBzrDirFormat
212
def initialize(self, a_bzrdir, shared=False):
213
assert isinstance(a_bzrdir, RemoteBzrDir), \
214
'%r is not a RemoteBzrDir' % (a_bzrdir,)
215
return a_bzrdir.create_repository(shared=shared)
217
def open(self, a_bzrdir):
218
assert isinstance(a_bzrdir, RemoteBzrDir)
219
return a_bzrdir.open_repository()
221
def get_format_description(self):
222
return 'bzr remote repository'
224
def __eq__(self, other):
225
return self.__class__ == other.__class__
227
def check_conversion_target(self, target_format):
228
if self.rich_root_data and not target_format.rich_root_data:
229
raise errors.BadConversionTarget(
230
'Does not support rich root data.', target_format)
231
if (self.supports_tree_reference and
232
not getattr(target_format, 'supports_tree_reference', False)):
233
raise errors.BadConversionTarget(
234
'Does not support nested trees', target_format)
237
class RemoteRepository(object):
238
"""Repository accessed over rpc.
240
For the moment most operations are performed using local transport-backed
244
def __init__(self, remote_bzrdir, format, real_repository=None, _client=None):
245
"""Create a RemoteRepository instance.
247
:param remote_bzrdir: The bzrdir hosting this repository.
248
:param format: The RemoteFormat object to use.
249
:param real_repository: If not None, a local implementation of the
250
repository logic for the repository, usually accessing the data
252
:param _client: Private testing parameter - override the smart client
253
to be used by the repository.
256
self._real_repository = real_repository
258
self._real_repository = None
259
self.bzrdir = remote_bzrdir
261
self._client = client._SmartClient(self.bzrdir._shared_medium)
263
self._client = _client
264
self._format = format
265
self._lock_mode = None
266
self._lock_token = None
268
self._leave_lock = False
269
# A cache of looked up revision parent data; reset at unlock time.
270
self._parents_map = None
272
# These depend on the actual remote format, so force them off for
273
# maximum compatibility. XXX: In future these should depend on the
274
# remote repository instance, but this is irrelevant until we perform
275
# reconcile via an RPC call.
276
self._reconcile_does_inventory_gc = False
277
self._reconcile_fixes_text_parents = False
278
self._reconcile_backsup_inventory = False
279
self.base = self.bzrdir.transport.base
282
return "%s(%s)" % (self.__class__.__name__, self.base)
286
def abort_write_group(self):
287
"""Complete a write group on the decorated repository.
289
Smart methods peform operations in a single step so this api
290
is not really applicable except as a compatibility thunk
291
for older plugins that don't use e.g. the CommitBuilder
295
return self._real_repository.abort_write_group()
297
def commit_write_group(self):
298
"""Complete a write group on the decorated repository.
300
Smart methods peform operations in a single step so this api
301
is not really applicable except as a compatibility thunk
302
for older plugins that don't use e.g. the CommitBuilder
306
return self._real_repository.commit_write_group()
308
def _ensure_real(self):
309
"""Ensure that there is a _real_repository set.
311
Used before calls to self._real_repository.
313
if not self._real_repository:
314
self.bzrdir._ensure_real()
315
#self._real_repository = self.bzrdir._real_bzrdir.open_repository()
316
self._set_real_repository(self.bzrdir._real_bzrdir.open_repository())
318
def find_text_key_references(self):
319
"""Find the text key references within the repository.
321
:return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
322
revision_ids. Each altered file-ids has the exact revision_ids that
323
altered it listed explicitly.
324
:return: A dictionary mapping text keys ((fileid, revision_id) tuples)
325
to whether they were referred to by the inventory of the
326
revision_id that they contain. The inventory texts from all present
327
revision ids are assessed to generate this report.
330
return self._real_repository.find_text_key_references()
332
def _generate_text_key_index(self):
333
"""Generate a new text key index for the repository.
335
This is an expensive function that will take considerable time to run.
337
:return: A dict mapping (file_id, revision_id) tuples to a list of
338
parents, also (file_id, revision_id) tuples.
341
return self._real_repository._generate_text_key_index()
343
def get_revision_graph(self, revision_id=None):
344
"""See Repository.get_revision_graph()."""
345
if revision_id is None:
347
elif revision.is_null(revision_id):
350
path = self.bzrdir._path_for_remote_call(self._client)
351
assert type(revision_id) is str
352
response = self._client.call_expecting_body(
353
'Repository.get_revision_graph', path, revision_id)
354
if response[0][0] not in ['ok', 'nosuchrevision']:
355
raise errors.UnexpectedSmartServerResponse(response[0])
356
if response[0][0] == 'ok':
357
coded = response[1].read_body_bytes()
359
# no revisions in this repository!
361
lines = coded.split('\n')
364
d = tuple(line.split())
365
revision_graph[d[0]] = d[1:]
367
return revision_graph
369
response_body = response[1].read_body_bytes()
370
assert response_body == ''
371
raise NoSuchRevision(self, revision_id)
373
def has_revision(self, revision_id):
374
"""See Repository.has_revision()."""
375
if revision_id == NULL_REVISION:
376
# The null revision is always present.
378
path = self.bzrdir._path_for_remote_call(self._client)
379
response = self._client.call('Repository.has_revision', path, revision_id)
380
assert response[0] in ('yes', 'no'), 'unexpected response code %s' % (response,)
381
return response[0] == 'yes'
383
def has_revisions(self, revision_ids):
384
"""See Repository.has_revisions()."""
386
for revision_id in revision_ids:
387
if self.has_revision(revision_id):
388
result.add(revision_id)
391
def has_same_location(self, other):
392
return (self.__class__ == other.__class__ and
393
self.bzrdir.transport.base == other.bzrdir.transport.base)
395
def get_graph(self, other_repository=None):
396
"""Return the graph for this repository format"""
397
parents_provider = self
398
if (other_repository is not None and
399
other_repository.bzrdir.transport.base !=
400
self.bzrdir.transport.base):
401
parents_provider = graph._StackedParentsProvider(
402
[parents_provider, other_repository._make_parents_provider()])
403
return graph.Graph(parents_provider)
405
def gather_stats(self, revid=None, committers=None):
406
"""See Repository.gather_stats()."""
407
path = self.bzrdir._path_for_remote_call(self._client)
408
# revid can be None to indicate no revisions, not just NULL_REVISION
409
if revid is None or revision.is_null(revid):
413
if committers is None or not committers:
414
fmt_committers = 'no'
416
fmt_committers = 'yes'
417
response = self._client.call_expecting_body(
418
'Repository.gather_stats', path, fmt_revid, fmt_committers)
419
assert response[0][0] == 'ok', \
420
'unexpected response code %s' % (response[0],)
422
body = response[1].read_body_bytes()
424
for line in body.split('\n'):
427
key, val_text = line.split(':')
428
if key in ('revisions', 'size', 'committers'):
429
result[key] = int(val_text)
430
elif key in ('firstrev', 'latestrev'):
431
values = val_text.split(' ')[1:]
432
result[key] = (float(values[0]), long(values[1]))
436
def find_branches(self, using=False):
437
"""See Repository.find_branches()."""
438
# should be an API call to the server.
440
return self._real_repository.find_branches(using=using)
442
def get_physical_lock_status(self):
443
"""See Repository.get_physical_lock_status()."""
444
# should be an API call to the server.
446
return self._real_repository.get_physical_lock_status()
448
def is_in_write_group(self):
449
"""Return True if there is an open write group.
451
write groups are only applicable locally for the smart server..
453
if self._real_repository:
454
return self._real_repository.is_in_write_group()
457
return self._lock_count >= 1
460
"""See Repository.is_shared()."""
461
path = self.bzrdir._path_for_remote_call(self._client)
462
response = self._client.call('Repository.is_shared', path)
463
assert response[0] in ('yes', 'no'), 'unexpected response code %s' % (response,)
464
return response[0] == 'yes'
466
def is_write_locked(self):
467
return self._lock_mode == 'w'
470
# wrong eventually - want a local lock cache context
471
if not self._lock_mode:
472
self._lock_mode = 'r'
474
self._parents_map = {}
475
if self._real_repository is not None:
476
self._real_repository.lock_read()
478
self._lock_count += 1
480
def _remote_lock_write(self, token):
481
path = self.bzrdir._path_for_remote_call(self._client)
484
response = self._client.call('Repository.lock_write', path, token)
485
if response[0] == 'ok':
488
elif response[0] == 'LockContention':
489
raise errors.LockContention('(remote lock)')
490
elif response[0] == 'UnlockableTransport':
491
raise errors.UnlockableTransport(self.bzrdir.root_transport)
492
elif response[0] == 'LockFailed':
493
raise errors.LockFailed(response[1], response[2])
495
raise errors.UnexpectedSmartServerResponse(response)
497
def lock_write(self, token=None):
498
if not self._lock_mode:
499
self._lock_token = self._remote_lock_write(token)
500
# if self._lock_token is None, then this is something like packs or
501
# svn where we don't get to lock the repo, or a weave style repository
502
# where we cannot lock it over the wire and attempts to do so will
504
if self._real_repository is not None:
505
self._real_repository.lock_write(token=self._lock_token)
506
if token is not None:
507
self._leave_lock = True
509
self._leave_lock = False
510
self._lock_mode = 'w'
512
self._parents_map = {}
513
elif self._lock_mode == 'r':
514
raise errors.ReadOnlyError(self)
516
self._lock_count += 1
517
return self._lock_token or None
519
def leave_lock_in_place(self):
520
if not self._lock_token:
521
raise NotImplementedError(self.leave_lock_in_place)
522
self._leave_lock = True
524
def dont_leave_lock_in_place(self):
525
if not self._lock_token:
526
raise NotImplementedError(self.dont_leave_lock_in_place)
527
self._leave_lock = False
529
def _set_real_repository(self, repository):
530
"""Set the _real_repository for this repository.
532
:param repository: The repository to fallback to for non-hpss
533
implemented operations.
535
assert not isinstance(repository, RemoteRepository)
536
self._real_repository = repository
537
if self._lock_mode == 'w':
538
# if we are already locked, the real repository must be able to
539
# acquire the lock with our token.
540
self._real_repository.lock_write(self._lock_token)
541
elif self._lock_mode == 'r':
542
self._real_repository.lock_read()
544
def start_write_group(self):
545
"""Start a write group on the decorated repository.
547
Smart methods peform operations in a single step so this api
548
is not really applicable except as a compatibility thunk
549
for older plugins that don't use e.g. the CommitBuilder
553
return self._real_repository.start_write_group()
555
def _unlock(self, token):
556
path = self.bzrdir._path_for_remote_call(self._client)
558
# with no token the remote repository is not persistently locked.
560
response = self._client.call('Repository.unlock', path, token)
561
if response == ('ok',):
563
elif response[0] == 'TokenMismatch':
564
raise errors.TokenMismatch(token, '(remote token)')
566
raise errors.UnexpectedSmartServerResponse(response)
569
self._lock_count -= 1
570
if self._lock_count > 0:
572
self._parents_map = None
573
old_mode = self._lock_mode
574
self._lock_mode = None
576
# The real repository is responsible at present for raising an
577
# exception if it's in an unfinished write group. However, it
578
# normally will *not* actually remove the lock from disk - that's
579
# done by the server on receiving the Repository.unlock call.
580
# This is just to let the _real_repository stay up to date.
581
if self._real_repository is not None:
582
self._real_repository.unlock()
584
# The rpc-level lock should be released even if there was a
585
# problem releasing the vfs-based lock.
587
# Only write-locked repositories need to make a remote method
588
# call to perfom the unlock.
589
old_token = self._lock_token
590
self._lock_token = None
591
if not self._leave_lock:
592
self._unlock(old_token)
594
def break_lock(self):
595
# should hand off to the network
597
return self._real_repository.break_lock()
599
def _get_tarball(self, compression):
600
"""Return a TemporaryFile containing a repository tarball.
602
Returns None if the server does not support sending tarballs.
605
path = self.bzrdir._path_for_remote_call(self._client)
606
response, protocol = self._client.call_expecting_body(
607
'Repository.tarball', path, compression)
608
if response[0] == 'ok':
609
# Extract the tarball and return it
610
t = tempfile.NamedTemporaryFile()
611
# TODO: rpc layer should read directly into it...
612
t.write(protocol.read_body_bytes())
615
if (response == ('error', "Generic bzr smart protocol error: "
616
"bad request 'Repository.tarball'") or
617
response == ('error', "Generic bzr smart protocol error: "
618
"bad request u'Repository.tarball'")):
619
protocol.cancel_read_body()
621
raise errors.UnexpectedSmartServerResponse(response)
623
def sprout(self, to_bzrdir, revision_id=None):
624
# TODO: Option to control what format is created?
626
dest_repo = self._real_repository._format.initialize(to_bzrdir,
628
dest_repo.fetch(self, revision_id=revision_id)
631
### These methods are just thin shims to the VFS object for now.
633
def revision_tree(self, revision_id):
635
return self._real_repository.revision_tree(revision_id)
637
def get_serializer_format(self):
639
return self._real_repository.get_serializer_format()
641
def get_commit_builder(self, branch, parents, config, timestamp=None,
642
timezone=None, committer=None, revprops=None,
644
# FIXME: It ought to be possible to call this without immediately
645
# triggering _ensure_real. For now it's the easiest thing to do.
647
builder = self._real_repository.get_commit_builder(branch, parents,
648
config, timestamp=timestamp, timezone=timezone,
649
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)
656
def add_revision(self, rev_id, rev, inv=None, config=None):
658
return self._real_repository.add_revision(
659
rev_id, rev, inv=inv, config=config)
662
def get_inventory(self, revision_id):
664
return self._real_repository.get_inventory(revision_id)
666
def iter_inventories(self, revision_ids):
668
return self._real_repository.iter_inventories(revision_ids)
671
def get_revision(self, revision_id):
673
return self._real_repository.get_revision(revision_id)
676
def weave_store(self):
678
return self._real_repository.weave_store
680
def get_transaction(self):
682
return self._real_repository.get_transaction()
685
def clone(self, a_bzrdir, revision_id=None):
687
return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
689
def make_working_trees(self):
690
"""RemoteRepositories never create working trees by default."""
693
def revision_ids_to_search_result(self, result_set):
694
"""Convert a set of revision ids to a graph SearchResult."""
695
result_parents = set()
696
for parents in self.get_graph().get_parent_map(
697
result_set).itervalues():
698
result_parents.update(parents)
699
included_keys = result_set.intersection(result_parents)
700
start_keys = result_set.difference(included_keys)
701
exclude_keys = result_parents.difference(result_set)
702
result = graph.SearchResult(start_keys, exclude_keys,
703
len(result_set), result_set)
707
def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
708
"""Return the revision ids that other has that this does not.
710
These are returned in topological order.
712
revision_id: only return revision ids included by revision_id.
714
return repository.InterRepository.get(
715
other, self).search_missing_revision_ids(revision_id, find_ghosts)
717
def fetch(self, source, revision_id=None, pb=None):
718
if self.has_same_location(source):
719
# check that last_revision is in 'from' and then return a
721
if (revision_id is not None and
722
not revision.is_null(revision_id)):
723
self.get_revision(revision_id)
726
return self._real_repository.fetch(
727
source, revision_id=revision_id, pb=pb)
729
def create_bundle(self, target, base, fileobj, format=None):
731
self._real_repository.create_bundle(target, base, fileobj, format)
734
def control_weaves(self):
736
return self._real_repository.control_weaves
739
def get_ancestry(self, revision_id, topo_sorted=True):
741
return self._real_repository.get_ancestry(revision_id, topo_sorted)
744
def get_inventory_weave(self):
746
return self._real_repository.get_inventory_weave()
748
def fileids_altered_by_revision_ids(self, revision_ids):
750
return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
752
def _get_versioned_file_checker(self, revisions, revision_versions_cache):
754
return self._real_repository._get_versioned_file_checker(
755
revisions, revision_versions_cache)
757
def iter_files_bytes(self, desired_files):
758
"""See Repository.iter_file_bytes.
761
return self._real_repository.iter_files_bytes(desired_files)
763
def get_parent_map(self, keys):
764
"""See bzrlib.Graph.get_parent_map()."""
765
# Hack to build up the caching logic.
766
ancestry = self._parents_map
767
missing_revisions = set(key for key in keys if key not in ancestry)
768
if missing_revisions:
769
parent_map = self._get_parent_map(missing_revisions)
770
if 'hpss' in debug.debug_flags:
771
mutter('retransmitted revisions: %d of %d',
772
len(set(self._parents_map).intersection(parent_map)),
774
self._parents_map.update(parent_map)
775
return dict((k, ancestry[k]) for k in keys if k in ancestry)
777
def _response_is_unknown_method(self, response, verb):
778
"""Return True if response is an unknonwn method response to verb.
780
:param response: The response from a smart client call_expecting_body
782
:param verb: The verb used in that call.
783
:return: True if an unknown method was encountered.
785
# This might live better on
786
# bzrlib.smart.protocol.SmartClientRequestProtocolOne
787
if (response[0] == ('error', "Generic bzr smart protocol error: "
788
"bad request '%s'" % verb) or
789
response[0] == ('error', "Generic bzr smart protocol error: "
790
"bad request u'%s'" % verb)):
791
response[1].cancel_read_body()
795
def _get_parent_map(self, keys):
796
"""Helper for get_parent_map that performs the RPC."""
798
if NULL_REVISION in keys:
799
keys.discard(NULL_REVISION)
800
found_parents = {NULL_REVISION:()}
805
path = self.bzrdir._path_for_remote_call(self._client)
807
assert type(key) is str
808
verb = 'Repository.get_parent_map'
809
response = self._client.call_expecting_body(
811
if self._response_is_unknown_method(response, verb):
812
# Server that does not support this method, get the whole graph.
813
response = self._client.call_expecting_body(
814
'Repository.get_revision_graph', path, '')
815
if response[0][0] not in ['ok', 'nosuchrevision']:
816
reponse[1].cancel_read_body()
817
raise errors.UnexpectedSmartServerResponse(response[0])
818
elif response[0][0] not in ['ok']:
819
reponse[1].cancel_read_body()
820
raise errors.UnexpectedSmartServerResponse(response[0])
821
if response[0][0] == 'ok':
822
coded = response[1].read_body_bytes()
826
lines = coded.split('\n')
829
d = tuple(line.split())
831
revision_graph[d[0]] = d[1:]
833
# No parents - so give the Graph result (NULL_REVISION,).
834
revision_graph[d[0]] = (NULL_REVISION,)
835
return revision_graph
838
def get_signature_text(self, revision_id):
840
return self._real_repository.get_signature_text(revision_id)
843
def get_revision_graph_with_ghosts(self, revision_ids=None):
845
return self._real_repository.get_revision_graph_with_ghosts(
846
revision_ids=revision_ids)
849
def get_inventory_xml(self, revision_id):
851
return self._real_repository.get_inventory_xml(revision_id)
853
def deserialise_inventory(self, revision_id, xml):
855
return self._real_repository.deserialise_inventory(revision_id, xml)
857
def reconcile(self, other=None, thorough=False):
859
return self._real_repository.reconcile(other=other, thorough=thorough)
861
def all_revision_ids(self):
863
return self._real_repository.all_revision_ids()
866
def get_deltas_for_revisions(self, revisions):
868
return self._real_repository.get_deltas_for_revisions(revisions)
871
def get_revision_delta(self, revision_id):
873
return self._real_repository.get_revision_delta(revision_id)
876
def revision_trees(self, revision_ids):
878
return self._real_repository.revision_trees(revision_ids)
881
def get_revision_reconcile(self, revision_id):
883
return self._real_repository.get_revision_reconcile(revision_id)
886
def check(self, revision_ids=None):
888
return self._real_repository.check(revision_ids=revision_ids)
890
def copy_content_into(self, destination, revision_id=None):
892
return self._real_repository.copy_content_into(
893
destination, revision_id=revision_id)
895
def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
896
# get a tarball of the remote repository, and copy from that into the
898
from bzrlib import osutils
901
# TODO: Maybe a progress bar while streaming the tarball?
902
note("Copying repository content as tarball...")
903
tar_file = self._get_tarball('bz2')
906
destination = to_bzrdir.create_repository()
908
tar = tarfile.open('repository', fileobj=tar_file,
910
tmpdir = tempfile.mkdtemp()
912
_extract_tar(tar, tmpdir)
913
tmp_bzrdir = BzrDir.open(tmpdir)
914
tmp_repo = tmp_bzrdir.open_repository()
915
tmp_repo.copy_content_into(destination, revision_id)
917
osutils.rmtree(tmpdir)
921
# TODO: Suggestion from john: using external tar is much faster than
922
# python's tarfile library, but it may not work on windows.
926
"""Compress the data within the repository.
928
This is not currently implemented within the smart server.
931
return self._real_repository.pack()
933
def set_make_working_trees(self, new_value):
934
raise NotImplementedError(self.set_make_working_trees)
937
def sign_revision(self, revision_id, gpg_strategy):
939
return self._real_repository.sign_revision(revision_id, gpg_strategy)
942
def get_revisions(self, revision_ids):
944
return self._real_repository.get_revisions(revision_ids)
946
def supports_rich_root(self):
948
return self._real_repository.supports_rich_root()
950
def iter_reverse_revision_history(self, revision_id):
952
return self._real_repository.iter_reverse_revision_history(revision_id)
955
def _serializer(self):
957
return self._real_repository._serializer
959
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
961
return self._real_repository.store_revision_signature(
962
gpg_strategy, plaintext, revision_id)
964
def add_signature_text(self, revision_id, signature):
966
return self._real_repository.add_signature_text(revision_id, signature)
968
def has_signature_for_revision_id(self, revision_id):
970
return self._real_repository.has_signature_for_revision_id(revision_id)
972
def get_data_stream_for_search(self, search):
973
REQUEST_NAME = 'Repository.stream_revisions_chunked'
974
path = self.bzrdir._path_for_remote_call(self._client)
975
recipe = search.get_recipe()
976
start_keys = ' '.join(recipe[0])
977
stop_keys = ' '.join(recipe[1])
978
count = str(recipe[2])
979
body = '\n'.join((start_keys, stop_keys, count))
980
response, protocol = self._client.call_with_body_bytes_expecting_body(
981
REQUEST_NAME, (path,), body)
983
if response == ('ok',):
984
return self._deserialise_stream(protocol)
985
if response == ('NoSuchRevision', ):
986
# We cannot easily identify the revision that is missing in this
987
# situation without doing much more network IO. For now, bail.
988
raise NoSuchRevision(self, "unknown")
989
elif (response == ('error', "Generic bzr smart protocol error: "
990
"bad request '%s'" % REQUEST_NAME) or
991
response == ('error', "Generic bzr smart protocol error: "
992
"bad request u'%s'" % REQUEST_NAME)):
993
protocol.cancel_read_body()
995
return self._real_repository.get_data_stream_for_search(search)
997
raise errors.UnexpectedSmartServerResponse(response)
999
def _deserialise_stream(self, protocol):
1000
stream = protocol.read_streamed_body()
1001
container_parser = ContainerPushParser()
1002
for bytes in stream:
1003
container_parser.accept_bytes(bytes)
1004
records = container_parser.read_pending_records()
1005
for record_names, record_bytes in records:
1006
if len(record_names) != 1:
1007
# These records should have only one name, and that name
1008
# should be a one-element tuple.
1009
raise errors.SmartProtocolError(
1010
'Repository data stream had invalid record name %r'
1012
name_tuple = record_names[0]
1013
yield name_tuple, record_bytes
1015
def insert_data_stream(self, stream):
1017
self._real_repository.insert_data_stream(stream)
1019
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
1021
return self._real_repository.item_keys_introduced_by(revision_ids,
1022
_files_pb=_files_pb)
1024
def revision_graph_can_have_wrong_parents(self):
1025
# The answer depends on the remote repo format.
1027
return self._real_repository.revision_graph_can_have_wrong_parents()
1029
def _find_inconsistent_revision_parents(self):
1031
return self._real_repository._find_inconsistent_revision_parents()
1033
def _check_for_inconsistent_revision_parents(self):
1035
return self._real_repository._check_for_inconsistent_revision_parents()
1037
def _make_parents_provider(self):
1041
class RemoteBranchLockableFiles(LockableFiles):
1042
"""A 'LockableFiles' implementation that talks to a smart server.
1044
This is not a public interface class.
1047
def __init__(self, bzrdir, _client):
1048
self.bzrdir = bzrdir
1049
self._client = _client
1050
self._need_find_modes = True
1051
LockableFiles.__init__(
1052
self, bzrdir.get_branch_transport(None),
1053
'lock', lockdir.LockDir)
1055
def _find_modes(self):
1056
# RemoteBranches don't let the client set the mode of control files.
1057
self._dir_mode = None
1058
self._file_mode = None
1060
def get(self, path):
1061
"""'get' a remote path as per the LockableFiles interface.
1063
:param path: the file to 'get'. If this is 'branch.conf', we do not
1064
just retrieve a file, instead we ask the smart server to generate
1065
a configuration for us - which is retrieved as an INI file.
1067
if path == 'branch.conf':
1068
path = self.bzrdir._path_for_remote_call(self._client)
1069
response = self._client.call_expecting_body(
1070
'Branch.get_config_file', path)
1071
assert response[0][0] == 'ok', \
1072
'unexpected response code %s' % (response[0],)
1073
return StringIO(response[1].read_body_bytes())
1076
return LockableFiles.get(self, path)
1079
class RemoteBranchFormat(branch.BranchFormat):
1081
def __eq__(self, other):
1082
return (isinstance(other, RemoteBranchFormat) and
1083
self.__dict__ == other.__dict__)
1085
def get_format_description(self):
1086
return 'Remote BZR Branch'
1088
def get_format_string(self):
1089
return 'Remote BZR Branch'
1091
def open(self, a_bzrdir):
1092
assert isinstance(a_bzrdir, RemoteBzrDir)
1093
return a_bzrdir.open_branch()
1095
def initialize(self, a_bzrdir):
1096
assert isinstance(a_bzrdir, RemoteBzrDir)
1097
return a_bzrdir.create_branch()
1099
def supports_tags(self):
1100
# Remote branches might support tags, but we won't know until we
1101
# access the real remote branch.
1105
class RemoteBranch(branch.Branch):
1106
"""Branch stored on a server accessed by HPSS RPC.
1108
At the moment most operations are mapped down to simple file operations.
1111
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
1113
"""Create a RemoteBranch instance.
1115
:param real_branch: An optional local implementation of the branch
1116
format, usually accessing the data via the VFS.
1117
:param _client: Private parameter for testing.
1119
# We intentionally don't call the parent class's __init__, because it
1120
# will try to assign to self.tags, which is a property in this subclass.
1121
# And the parent's __init__ doesn't do much anyway.
1122
self._revision_id_to_revno_cache = None
1123
self._revision_history_cache = None
1124
self.bzrdir = remote_bzrdir
1125
if _client is not None:
1126
self._client = _client
1128
self._client = client._SmartClient(self.bzrdir._shared_medium)
1129
self.repository = remote_repository
1130
if real_branch is not None:
1131
self._real_branch = real_branch
1132
# Give the remote repository the matching real repo.
1133
real_repo = self._real_branch.repository
1134
if isinstance(real_repo, RemoteRepository):
1135
real_repo._ensure_real()
1136
real_repo = real_repo._real_repository
1137
self.repository._set_real_repository(real_repo)
1138
# Give the branch the remote repository to let fast-pathing happen.
1139
self._real_branch.repository = self.repository
1141
self._real_branch = None
1142
# Fill out expected attributes of branch for bzrlib api users.
1143
self._format = RemoteBranchFormat()
1144
self.base = self.bzrdir.root_transport.base
1145
self._control_files = None
1146
self._lock_mode = None
1147
self._lock_token = None
1148
self._lock_count = 0
1149
self._leave_lock = False
1152
return "%s(%s)" % (self.__class__.__name__, self.base)
1156
def _ensure_real(self):
1157
"""Ensure that there is a _real_branch set.
1159
Used before calls to self._real_branch.
1161
if not self._real_branch:
1162
assert vfs.vfs_enabled()
1163
self.bzrdir._ensure_real()
1164
self._real_branch = self.bzrdir._real_bzrdir.open_branch()
1165
# Give the remote repository the matching real repo.
1166
real_repo = self._real_branch.repository
1167
if isinstance(real_repo, RemoteRepository):
1168
real_repo._ensure_real()
1169
real_repo = real_repo._real_repository
1170
self.repository._set_real_repository(real_repo)
1171
# Give the branch the remote repository to let fast-pathing happen.
1172
self._real_branch.repository = self.repository
1173
# XXX: deal with _lock_mode == 'w'
1174
if self._lock_mode == 'r':
1175
self._real_branch.lock_read()
1178
def control_files(self):
1179
# Defer actually creating RemoteBranchLockableFiles until its needed,
1180
# because it triggers an _ensure_real that we otherwise might not need.
1181
if self._control_files is None:
1182
self._control_files = RemoteBranchLockableFiles(
1183
self.bzrdir, self._client)
1184
return self._control_files
1186
def _get_checkout_format(self):
1188
return self._real_branch._get_checkout_format()
1190
def get_physical_lock_status(self):
1191
"""See Branch.get_physical_lock_status()."""
1192
# should be an API call to the server, as branches must be lockable.
1194
return self._real_branch.get_physical_lock_status()
1196
def lock_read(self):
1197
if not self._lock_mode:
1198
self._lock_mode = 'r'
1199
self._lock_count = 1
1200
if self._real_branch is not None:
1201
self._real_branch.lock_read()
1203
self._lock_count += 1
1205
def _remote_lock_write(self, token):
1207
branch_token = repo_token = ''
1209
branch_token = token
1210
repo_token = self.repository.lock_write()
1211
self.repository.unlock()
1212
path = self.bzrdir._path_for_remote_call(self._client)
1213
response = self._client.call('Branch.lock_write', path, branch_token,
1215
if response[0] == 'ok':
1216
ok, branch_token, repo_token = response
1217
return branch_token, repo_token
1218
elif response[0] == 'LockContention':
1219
raise errors.LockContention('(remote lock)')
1220
elif response[0] == 'TokenMismatch':
1221
raise errors.TokenMismatch(token, '(remote token)')
1222
elif response[0] == 'UnlockableTransport':
1223
raise errors.UnlockableTransport(self.bzrdir.root_transport)
1224
elif response[0] == 'ReadOnlyError':
1225
raise errors.ReadOnlyError(self)
1226
elif response[0] == 'LockFailed':
1227
raise errors.LockFailed(response[1], response[2])
1229
raise errors.UnexpectedSmartServerResponse(response)
1231
def lock_write(self, token=None):
1232
if not self._lock_mode:
1233
remote_tokens = self._remote_lock_write(token)
1234
self._lock_token, self._repo_lock_token = remote_tokens
1235
assert self._lock_token, 'Remote server did not return a token!'
1236
# TODO: We really, really, really don't want to call _ensure_real
1237
# here, but it's the easiest way to ensure coherency between the
1238
# state of the RemoteBranch and RemoteRepository objects and the
1239
# physical locks. If we don't materialise the real objects here,
1240
# then getting everything in the right state later is complex, so
1241
# for now we just do it the lazy way.
1242
# -- Andrew Bennetts, 2007-02-22.
1244
if self._real_branch is not None:
1245
self._real_branch.repository.lock_write(
1246
token=self._repo_lock_token)
1248
self._real_branch.lock_write(token=self._lock_token)
1250
self._real_branch.repository.unlock()
1251
if token is not None:
1252
self._leave_lock = True
1254
# XXX: this case seems to be unreachable; token cannot be None.
1255
self._leave_lock = False
1256
self._lock_mode = 'w'
1257
self._lock_count = 1
1258
elif self._lock_mode == 'r':
1259
raise errors.ReadOnlyTransaction
1261
if token is not None:
1262
# A token was given to lock_write, and we're relocking, so check
1263
# that the given token actually matches the one we already have.
1264
if token != self._lock_token:
1265
raise errors.TokenMismatch(token, self._lock_token)
1266
self._lock_count += 1
1267
return self._lock_token or None
1269
def _unlock(self, branch_token, repo_token):
1270
path = self.bzrdir._path_for_remote_call(self._client)
1271
response = self._client.call('Branch.unlock', path, branch_token,
1273
if response == ('ok',):
1275
elif response[0] == 'TokenMismatch':
1276
raise errors.TokenMismatch(
1277
str((branch_token, repo_token)), '(remote tokens)')
1279
raise errors.UnexpectedSmartServerResponse(response)
1282
self._lock_count -= 1
1283
if not self._lock_count:
1284
self._clear_cached_state()
1285
mode = self._lock_mode
1286
self._lock_mode = None
1287
if self._real_branch is not None:
1288
if (not self._leave_lock and mode == 'w' and
1289
self._repo_lock_token):
1290
# If this RemoteBranch will remove the physical lock for the
1291
# repository, make sure the _real_branch doesn't do it
1292
# first. (Because the _real_branch's repository is set to
1293
# be the RemoteRepository.)
1294
self._real_branch.repository.leave_lock_in_place()
1295
self._real_branch.unlock()
1297
# Only write-locked branched need to make a remote method call
1298
# to perfom the unlock.
1300
assert self._lock_token, 'Locked, but no token!'
1301
branch_token = self._lock_token
1302
repo_token = self._repo_lock_token
1303
self._lock_token = None
1304
self._repo_lock_token = None
1305
if not self._leave_lock:
1306
self._unlock(branch_token, repo_token)
1308
def break_lock(self):
1310
return self._real_branch.break_lock()
1312
def leave_lock_in_place(self):
1313
if not self._lock_token:
1314
raise NotImplementedError(self.leave_lock_in_place)
1315
self._leave_lock = True
1317
def dont_leave_lock_in_place(self):
1318
if not self._lock_token:
1319
raise NotImplementedError(self.dont_leave_lock_in_place)
1320
self._leave_lock = False
1322
def last_revision_info(self):
1323
"""See Branch.last_revision_info()."""
1324
path = self.bzrdir._path_for_remote_call(self._client)
1325
response = self._client.call('Branch.last_revision_info', path)
1326
assert response[0] == 'ok', 'unexpected response code %s' % (response,)
1327
revno = int(response[1])
1328
last_revision = response[2]
1329
return (revno, last_revision)
1331
def _gen_revision_history(self):
1332
"""See Branch._gen_revision_history()."""
1333
path = self.bzrdir._path_for_remote_call(self._client)
1334
response = self._client.call_expecting_body(
1335
'Branch.revision_history', path)
1336
assert response[0][0] == 'ok', ('unexpected response code %s'
1338
result = response[1].read_body_bytes().split('\x00')
1344
def set_revision_history(self, rev_history):
1345
# Send just the tip revision of the history; the server will generate
1346
# the full history from that. If the revision doesn't exist in this
1347
# branch, NoSuchRevision will be raised.
1348
path = self.bzrdir._path_for_remote_call(self._client)
1349
if rev_history == []:
1352
rev_id = rev_history[-1]
1353
self._clear_cached_state()
1354
response = self._client.call('Branch.set_last_revision',
1355
path, self._lock_token, self._repo_lock_token, rev_id)
1356
if response[0] == 'NoSuchRevision':
1357
raise NoSuchRevision(self, rev_id)
1359
assert response == ('ok',), (
1360
'unexpected response code %r' % (response,))
1361
self._cache_revision_history(rev_history)
1363
def get_parent(self):
1365
return self._real_branch.get_parent()
1367
def set_parent(self, url):
1369
return self._real_branch.set_parent(url)
1371
def get_config(self):
1372
return RemoteBranchConfig(self)
1374
def sprout(self, to_bzrdir, revision_id=None):
1375
# Like Branch.sprout, except that it sprouts a branch in the default
1376
# format, because RemoteBranches can't be created at arbitrary URLs.
1377
# XXX: if to_bzrdir is a RemoteBranch, this should perhaps do
1378
# to_bzrdir.create_branch...
1380
result = self._real_branch._format.initialize(to_bzrdir)
1381
self.copy_content_into(result, revision_id=revision_id)
1382
result.set_parent(self.bzrdir.root_transport.base)
1386
def pull(self, source, overwrite=False, stop_revision=None,
1388
# FIXME: This asks the real branch to run the hooks, which means
1389
# they're called with the wrong target branch parameter.
1390
# The test suite specifically allows this at present but it should be
1391
# fixed. It should get a _override_hook_target branch,
1392
# as push does. -- mbp 20070405
1394
self._real_branch.pull(
1395
source, overwrite=overwrite, stop_revision=stop_revision,
1399
def push(self, target, overwrite=False, stop_revision=None):
1401
return self._real_branch.push(
1402
target, overwrite=overwrite, stop_revision=stop_revision,
1403
_override_hook_source_branch=self)
1405
def is_locked(self):
1406
return self._lock_count >= 1
1408
def set_last_revision_info(self, revno, revision_id):
1410
self._clear_cached_state()
1411
return self._real_branch.set_last_revision_info(revno, revision_id)
1413
def generate_revision_history(self, revision_id, last_rev=None,
1416
return self._real_branch.generate_revision_history(
1417
revision_id, last_rev=last_rev, other_branch=other_branch)
1422
return self._real_branch.tags
1424
def set_push_location(self, location):
1426
return self._real_branch.set_push_location(location)
1428
def update_revisions(self, other, stop_revision=None, overwrite=False):
1430
return self._real_branch.update_revisions(
1431
other, stop_revision=stop_revision, overwrite=overwrite)
1434
class RemoteBranchConfig(BranchConfig):
1437
self.branch._ensure_real()
1438
return self.branch._real_branch.get_config().username()
1440
def _get_branch_data_config(self):
1441
self.branch._ensure_real()
1442
if self._branch_data_config is None:
1443
self._branch_data_config = TreeConfig(self.branch._real_branch)
1444
return self._branch_data_config
1447
def _extract_tar(tar, to_dir):
1448
"""Extract all the contents of a tarfile object.
1450
A replacement for extractall, which is not present in python2.4
1453
tar.extract(tarinfo, to_dir)
added
removed
bzrlib/remote.py
