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)
653
def add_inventory(self, revid, inv, parents):
655
return self._real_repository.add_inventory(revid, inv, parents)
658
def add_revision(self, rev_id, rev, inv=None, config=None):
660
return self._real_repository.add_revision(
661
rev_id, rev, inv=inv, config=config)
664
def get_inventory(self, revision_id):
666
return self._real_repository.get_inventory(revision_id)
668
def iter_inventories(self, revision_ids):
670
return self._real_repository.iter_inventories(revision_ids)
673
def get_revision(self, revision_id):
675
return self._real_repository.get_revision(revision_id)
678
def weave_store(self):
680
return self._real_repository.weave_store
682
def get_transaction(self):
684
return self._real_repository.get_transaction()
687
def clone(self, a_bzrdir, revision_id=None):
689
return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
691
def make_working_trees(self):
692
"""RemoteRepositories never create working trees by default."""
695
def revision_ids_to_search_result(self, result_set):
696
"""Convert a set of revision ids to a graph SearchResult."""
697
result_parents = set()
698
for parents in self.get_graph().get_parent_map(
699
result_set).itervalues():
700
result_parents.update(parents)
701
included_keys = result_set.intersection(result_parents)
702
start_keys = result_set.difference(included_keys)
703
exclude_keys = result_parents.difference(result_set)
704
result = graph.SearchResult(start_keys, exclude_keys,
705
len(result_set), result_set)
709
def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
710
"""Return the revision ids that other has that this does not.
712
These are returned in topological order.
714
revision_id: only return revision ids included by revision_id.
716
return repository.InterRepository.get(
717
other, self).search_missing_revision_ids(revision_id, find_ghosts)
719
def fetch(self, source, revision_id=None, pb=None):
720
if self.has_same_location(source):
721
# check that last_revision is in 'from' and then return a
723
if (revision_id is not None and
724
not revision.is_null(revision_id)):
725
self.get_revision(revision_id)
728
return self._real_repository.fetch(
729
source, revision_id=revision_id, pb=pb)
731
def create_bundle(self, target, base, fileobj, format=None):
733
self._real_repository.create_bundle(target, base, fileobj, format)
736
def control_weaves(self):
738
return self._real_repository.control_weaves
741
def get_ancestry(self, revision_id, topo_sorted=True):
743
return self._real_repository.get_ancestry(revision_id, topo_sorted)
746
def get_inventory_weave(self):
748
return self._real_repository.get_inventory_weave()
750
def fileids_altered_by_revision_ids(self, revision_ids):
752
return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
754
def _get_versioned_file_checker(self, revisions, revision_versions_cache):
756
return self._real_repository._get_versioned_file_checker(
757
revisions, revision_versions_cache)
759
def iter_files_bytes(self, desired_files):
760
"""See Repository.iter_file_bytes.
763
return self._real_repository.iter_files_bytes(desired_files)
765
def get_parent_map(self, keys):
766
"""See bzrlib.Graph.get_parent_map()."""
767
# Hack to build up the caching logic.
768
ancestry = self._parents_map
769
missing_revisions = set(key for key in keys if key not in ancestry)
770
if missing_revisions:
771
parent_map = self._get_parent_map(missing_revisions)
772
if 'hpss' in debug.debug_flags:
773
mutter('retransmitted revisions: %d of %d',
774
len(set(self._parents_map).intersection(parent_map)),
776
self._parents_map.update(parent_map)
777
return dict((k, ancestry[k]) for k in keys if k in ancestry)
779
def _response_is_unknown_method(self, response, verb):
780
"""Return True if response is an unknonwn method response to verb.
782
:param response: The response from a smart client call_expecting_body
784
:param verb: The verb used in that call.
785
:return: True if an unknown method was encountered.
787
# This might live better on
788
# bzrlib.smart.protocol.SmartClientRequestProtocolOne
789
if (response[0] == ('error', "Generic bzr smart protocol error: "
790
"bad request '%s'" % verb) or
791
response[0] == ('error', "Generic bzr smart protocol error: "
792
"bad request u'%s'" % verb)):
793
response[1].cancel_read_body()
797
def _get_parent_map(self, keys):
798
"""Helper for get_parent_map that performs the RPC."""
800
if NULL_REVISION in keys:
801
keys.discard(NULL_REVISION)
802
found_parents = {NULL_REVISION:()}
807
path = self.bzrdir._path_for_remote_call(self._client)
809
assert type(key) is str
810
verb = 'Repository.get_parent_map'
811
response = self._client.call_expecting_body(
813
if self._response_is_unknown_method(response, verb):
814
# Server that does not support this method, get the whole graph.
815
response = self._client.call_expecting_body(
816
'Repository.get_revision_graph', path, '')
817
if response[0][0] not in ['ok', 'nosuchrevision']:
818
reponse[1].cancel_read_body()
819
raise errors.UnexpectedSmartServerResponse(response[0])
820
elif response[0][0] not in ['ok']:
821
reponse[1].cancel_read_body()
822
raise errors.UnexpectedSmartServerResponse(response[0])
823
if response[0][0] == 'ok':
824
coded = response[1].read_body_bytes()
828
lines = coded.split('\n')
831
d = tuple(line.split())
833
revision_graph[d[0]] = d[1:]
835
# No parents - so give the Graph result (NULL_REVISION,).
836
revision_graph[d[0]] = (NULL_REVISION,)
837
return revision_graph
840
def get_signature_text(self, revision_id):
842
return self._real_repository.get_signature_text(revision_id)
845
def get_revision_graph_with_ghosts(self, revision_ids=None):
847
return self._real_repository.get_revision_graph_with_ghosts(
848
revision_ids=revision_ids)
851
def get_inventory_xml(self, revision_id):
853
return self._real_repository.get_inventory_xml(revision_id)
855
def deserialise_inventory(self, revision_id, xml):
857
return self._real_repository.deserialise_inventory(revision_id, xml)
859
def reconcile(self, other=None, thorough=False):
861
return self._real_repository.reconcile(other=other, thorough=thorough)
863
def all_revision_ids(self):
865
return self._real_repository.all_revision_ids()
868
def get_deltas_for_revisions(self, revisions):
870
return self._real_repository.get_deltas_for_revisions(revisions)
873
def get_revision_delta(self, revision_id):
875
return self._real_repository.get_revision_delta(revision_id)
878
def revision_trees(self, revision_ids):
880
return self._real_repository.revision_trees(revision_ids)
883
def get_revision_reconcile(self, revision_id):
885
return self._real_repository.get_revision_reconcile(revision_id)
888
def check(self, revision_ids=None):
890
return self._real_repository.check(revision_ids=revision_ids)
892
def copy_content_into(self, destination, revision_id=None):
894
return self._real_repository.copy_content_into(
895
destination, revision_id=revision_id)
897
def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
898
# get a tarball of the remote repository, and copy from that into the
900
from bzrlib import osutils
903
# TODO: Maybe a progress bar while streaming the tarball?
904
note("Copying repository content as tarball...")
905
tar_file = self._get_tarball('bz2')
908
destination = to_bzrdir.create_repository()
910
tar = tarfile.open('repository', fileobj=tar_file,
912
tmpdir = tempfile.mkdtemp()
914
_extract_tar(tar, tmpdir)
915
tmp_bzrdir = BzrDir.open(tmpdir)
916
tmp_repo = tmp_bzrdir.open_repository()
917
tmp_repo.copy_content_into(destination, revision_id)
919
osutils.rmtree(tmpdir)
923
# TODO: Suggestion from john: using external tar is much faster than
924
# python's tarfile library, but it may not work on windows.
928
"""Compress the data within the repository.
930
This is not currently implemented within the smart server.
933
return self._real_repository.pack()
935
def set_make_working_trees(self, new_value):
936
raise NotImplementedError(self.set_make_working_trees)
939
def sign_revision(self, revision_id, gpg_strategy):
941
return self._real_repository.sign_revision(revision_id, gpg_strategy)
944
def get_revisions(self, revision_ids):
946
return self._real_repository.get_revisions(revision_ids)
948
def supports_rich_root(self):
950
return self._real_repository.supports_rich_root()
952
def iter_reverse_revision_history(self, revision_id):
954
return self._real_repository.iter_reverse_revision_history(revision_id)
957
def _serializer(self):
959
return self._real_repository._serializer
961
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
963
return self._real_repository.store_revision_signature(
964
gpg_strategy, plaintext, revision_id)
966
def add_signature_text(self, revision_id, signature):
968
return self._real_repository.add_signature_text(revision_id, signature)
970
def has_signature_for_revision_id(self, revision_id):
972
return self._real_repository.has_signature_for_revision_id(revision_id)
974
def get_data_stream_for_search(self, search):
975
REQUEST_NAME = 'Repository.stream_revisions_chunked'
976
path = self.bzrdir._path_for_remote_call(self._client)
977
recipe = search.get_recipe()
978
start_keys = ' '.join(recipe[0])
979
stop_keys = ' '.join(recipe[1])
980
count = str(recipe[2])
981
body = '\n'.join((start_keys, stop_keys, count))
982
response, protocol = self._client.call_with_body_bytes_expecting_body(
983
REQUEST_NAME, (path,), body)
985
if response == ('ok',):
986
return self._deserialise_stream(protocol)
987
if response == ('NoSuchRevision', ):
988
# We cannot easily identify the revision that is missing in this
989
# situation without doing much more network IO. For now, bail.
990
raise NoSuchRevision(self, "unknown")
991
elif (response == ('error', "Generic bzr smart protocol error: "
992
"bad request '%s'" % REQUEST_NAME) or
993
response == ('error', "Generic bzr smart protocol error: "
994
"bad request u'%s'" % REQUEST_NAME)):
995
protocol.cancel_read_body()
997
return self._real_repository.get_data_stream_for_search(search)
999
raise errors.UnexpectedSmartServerResponse(response)
1001
def _deserialise_stream(self, protocol):
1002
stream = protocol.read_streamed_body()
1003
container_parser = ContainerPushParser()
1004
for bytes in stream:
1005
container_parser.accept_bytes(bytes)
1006
records = container_parser.read_pending_records()
1007
for record_names, record_bytes in records:
1008
if len(record_names) != 1:
1009
# These records should have only one name, and that name
1010
# should be a one-element tuple.
1011
raise errors.SmartProtocolError(
1012
'Repository data stream had invalid record name %r'
1014
name_tuple = record_names[0]
1015
yield name_tuple, record_bytes
1017
def insert_data_stream(self, stream):
1019
self._real_repository.insert_data_stream(stream)
1021
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
1023
return self._real_repository.item_keys_introduced_by(revision_ids,
1024
_files_pb=_files_pb)
1026
def revision_graph_can_have_wrong_parents(self):
1027
# The answer depends on the remote repo format.
1029
return self._real_repository.revision_graph_can_have_wrong_parents()
1031
def _find_inconsistent_revision_parents(self):
1033
return self._real_repository._find_inconsistent_revision_parents()
1035
def _check_for_inconsistent_revision_parents(self):
1037
return self._real_repository._check_for_inconsistent_revision_parents()
1039
def _make_parents_provider(self):
1043
class RemoteBranchLockableFiles(LockableFiles):
1044
"""A 'LockableFiles' implementation that talks to a smart server.
1046
This is not a public interface class.
1049
def __init__(self, bzrdir, _client):
1050
self.bzrdir = bzrdir
1051
self._client = _client
1052
self._need_find_modes = True
1053
LockableFiles.__init__(
1054
self, bzrdir.get_branch_transport(None),
1055
'lock', lockdir.LockDir)
1057
def _find_modes(self):
1058
# RemoteBranches don't let the client set the mode of control files.
1059
self._dir_mode = None
1060
self._file_mode = None
1062
def get(self, path):
1063
"""'get' a remote path as per the LockableFiles interface.
1065
:param path: the file to 'get'. If this is 'branch.conf', we do not
1066
just retrieve a file, instead we ask the smart server to generate
1067
a configuration for us - which is retrieved as an INI file.
1069
if path == 'branch.conf':
1070
path = self.bzrdir._path_for_remote_call(self._client)
1071
response = self._client.call_expecting_body(
1072
'Branch.get_config_file', path)
1073
assert response[0][0] == 'ok', \
1074
'unexpected response code %s' % (response[0],)
1075
return StringIO(response[1].read_body_bytes())
1078
return LockableFiles.get(self, path)
1081
class RemoteBranchFormat(branch.BranchFormat):
1083
def __eq__(self, other):
1084
return (isinstance(other, RemoteBranchFormat) and
1085
self.__dict__ == other.__dict__)
1087
def get_format_description(self):
1088
return 'Remote BZR Branch'
1090
def get_format_string(self):
1091
return 'Remote BZR Branch'
1093
def open(self, a_bzrdir):
1094
assert isinstance(a_bzrdir, RemoteBzrDir)
1095
return a_bzrdir.open_branch()
1097
def initialize(self, a_bzrdir):
1098
assert isinstance(a_bzrdir, RemoteBzrDir)
1099
return a_bzrdir.create_branch()
1101
def supports_tags(self):
1102
# Remote branches might support tags, but we won't know until we
1103
# access the real remote branch.
1107
class RemoteBranch(branch.Branch):
1108
"""Branch stored on a server accessed by HPSS RPC.
1110
At the moment most operations are mapped down to simple file operations.
1113
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
1115
"""Create a RemoteBranch instance.
1117
:param real_branch: An optional local implementation of the branch
1118
format, usually accessing the data via the VFS.
1119
:param _client: Private parameter for testing.
1121
# We intentionally don't call the parent class's __init__, because it
1122
# will try to assign to self.tags, which is a property in this subclass.
1123
# And the parent's __init__ doesn't do much anyway.
1124
self._revision_id_to_revno_cache = None
1125
self._revision_history_cache = None
1126
self.bzrdir = remote_bzrdir
1127
if _client is not None:
1128
self._client = _client
1130
self._client = client._SmartClient(self.bzrdir._shared_medium)
1131
self.repository = remote_repository
1132
if real_branch is not None:
1133
self._real_branch = real_branch
1134
# Give the remote repository the matching real repo.
1135
real_repo = self._real_branch.repository
1136
if isinstance(real_repo, RemoteRepository):
1137
real_repo._ensure_real()
1138
real_repo = real_repo._real_repository
1139
self.repository._set_real_repository(real_repo)
1140
# Give the branch the remote repository to let fast-pathing happen.
1141
self._real_branch.repository = self.repository
1143
self._real_branch = None
1144
# Fill out expected attributes of branch for bzrlib api users.
1145
self._format = RemoteBranchFormat()
1146
self.base = self.bzrdir.root_transport.base
1147
self._control_files = None
1148
self._lock_mode = None
1149
self._lock_token = None
1150
self._lock_count = 0
1151
self._leave_lock = False
1154
return "%s(%s)" % (self.__class__.__name__, self.base)
1158
def _ensure_real(self):
1159
"""Ensure that there is a _real_branch set.
1161
Used before calls to self._real_branch.
1163
if not self._real_branch:
1164
assert vfs.vfs_enabled()
1165
self.bzrdir._ensure_real()
1166
self._real_branch = self.bzrdir._real_bzrdir.open_branch()
1167
# Give the remote repository the matching real repo.
1168
real_repo = self._real_branch.repository
1169
if isinstance(real_repo, RemoteRepository):
1170
real_repo._ensure_real()
1171
real_repo = real_repo._real_repository
1172
self.repository._set_real_repository(real_repo)
1173
# Give the branch the remote repository to let fast-pathing happen.
1174
self._real_branch.repository = self.repository
1175
# XXX: deal with _lock_mode == 'w'
1176
if self._lock_mode == 'r':
1177
self._real_branch.lock_read()
1180
def control_files(self):
1181
# Defer actually creating RemoteBranchLockableFiles until its needed,
1182
# because it triggers an _ensure_real that we otherwise might not need.
1183
if self._control_files is None:
1184
self._control_files = RemoteBranchLockableFiles(
1185
self.bzrdir, self._client)
1186
return self._control_files
1188
def _get_checkout_format(self):
1190
return self._real_branch._get_checkout_format()
1192
def get_physical_lock_status(self):
1193
"""See Branch.get_physical_lock_status()."""
1194
# should be an API call to the server, as branches must be lockable.
1196
return self._real_branch.get_physical_lock_status()
1198
def lock_read(self):
1199
if not self._lock_mode:
1200
self._lock_mode = 'r'
1201
self._lock_count = 1
1202
if self._real_branch is not None:
1203
self._real_branch.lock_read()
1205
self._lock_count += 1
1207
def _remote_lock_write(self, token):
1209
branch_token = repo_token = ''
1211
branch_token = token
1212
repo_token = self.repository.lock_write()
1213
self.repository.unlock()
1214
path = self.bzrdir._path_for_remote_call(self._client)
1215
response = self._client.call('Branch.lock_write', path, branch_token,
1217
if response[0] == 'ok':
1218
ok, branch_token, repo_token = response
1219
return branch_token, repo_token
1220
elif response[0] == 'LockContention':
1221
raise errors.LockContention('(remote lock)')
1222
elif response[0] == 'TokenMismatch':
1223
raise errors.TokenMismatch(token, '(remote token)')
1224
elif response[0] == 'UnlockableTransport':
1225
raise errors.UnlockableTransport(self.bzrdir.root_transport)
1226
elif response[0] == 'ReadOnlyError':
1227
raise errors.ReadOnlyError(self)
1228
elif response[0] == 'LockFailed':
1229
raise errors.LockFailed(response[1], response[2])
1231
raise errors.UnexpectedSmartServerResponse(response)
1233
def lock_write(self, token=None):
1234
if not self._lock_mode:
1235
remote_tokens = self._remote_lock_write(token)
1236
self._lock_token, self._repo_lock_token = remote_tokens
1237
assert self._lock_token, 'Remote server did not return a token!'
1238
# TODO: We really, really, really don't want to call _ensure_real
1239
# here, but it's the easiest way to ensure coherency between the
1240
# state of the RemoteBranch and RemoteRepository objects and the
1241
# physical locks. If we don't materialise the real objects here,
1242
# then getting everything in the right state later is complex, so
1243
# for now we just do it the lazy way.
1244
# -- Andrew Bennetts, 2007-02-22.
1246
if self._real_branch is not None:
1247
self._real_branch.repository.lock_write(
1248
token=self._repo_lock_token)
1250
self._real_branch.lock_write(token=self._lock_token)
1252
self._real_branch.repository.unlock()
1253
if token is not None:
1254
self._leave_lock = True
1256
# XXX: this case seems to be unreachable; token cannot be None.
1257
self._leave_lock = False
1258
self._lock_mode = 'w'
1259
self._lock_count = 1
1260
elif self._lock_mode == 'r':
1261
raise errors.ReadOnlyTransaction
1263
if token is not None:
1264
# A token was given to lock_write, and we're relocking, so check
1265
# that the given token actually matches the one we already have.
1266
if token != self._lock_token:
1267
raise errors.TokenMismatch(token, self._lock_token)
1268
self._lock_count += 1
1269
return self._lock_token or None
1271
def _unlock(self, branch_token, repo_token):
1272
path = self.bzrdir._path_for_remote_call(self._client)
1273
response = self._client.call('Branch.unlock', path, branch_token,
1275
if response == ('ok',):
1277
elif response[0] == 'TokenMismatch':
1278
raise errors.TokenMismatch(
1279
str((branch_token, repo_token)), '(remote tokens)')
1281
raise errors.UnexpectedSmartServerResponse(response)
1284
self._lock_count -= 1
1285
if not self._lock_count:
1286
self._clear_cached_state()
1287
mode = self._lock_mode
1288
self._lock_mode = None
1289
if self._real_branch is not None:
1290
if (not self._leave_lock and mode == 'w' and
1291
self._repo_lock_token):
1292
# If this RemoteBranch will remove the physical lock for the
1293
# repository, make sure the _real_branch doesn't do it
1294
# first. (Because the _real_branch's repository is set to
1295
# be the RemoteRepository.)
1296
self._real_branch.repository.leave_lock_in_place()
1297
self._real_branch.unlock()
1299
# Only write-locked branched need to make a remote method call
1300
# to perfom the unlock.
1302
assert self._lock_token, 'Locked, but no token!'
1303
branch_token = self._lock_token
1304
repo_token = self._repo_lock_token
1305
self._lock_token = None
1306
self._repo_lock_token = None
1307
if not self._leave_lock:
1308
self._unlock(branch_token, repo_token)
1310
def break_lock(self):
1312
return self._real_branch.break_lock()
1314
def leave_lock_in_place(self):
1315
if not self._lock_token:
1316
raise NotImplementedError(self.leave_lock_in_place)
1317
self._leave_lock = True
1319
def dont_leave_lock_in_place(self):
1320
if not self._lock_token:
1321
raise NotImplementedError(self.dont_leave_lock_in_place)
1322
self._leave_lock = False
1324
def last_revision_info(self):
1325
"""See Branch.last_revision_info()."""
1326
path = self.bzrdir._path_for_remote_call(self._client)
1327
response = self._client.call('Branch.last_revision_info', path)
1328
assert response[0] == 'ok', 'unexpected response code %s' % (response,)
1329
revno = int(response[1])
1330
last_revision = response[2]
1331
return (revno, last_revision)
1333
def _gen_revision_history(self):
1334
"""See Branch._gen_revision_history()."""
1335
path = self.bzrdir._path_for_remote_call(self._client)
1336
response = self._client.call_expecting_body(
1337
'Branch.revision_history', path)
1338
assert response[0][0] == 'ok', ('unexpected response code %s'
1340
result = response[1].read_body_bytes().split('\x00')
1346
def set_revision_history(self, rev_history):
1347
# Send just the tip revision of the history; the server will generate
1348
# the full history from that. If the revision doesn't exist in this
1349
# branch, NoSuchRevision will be raised.
1350
path = self.bzrdir._path_for_remote_call(self._client)
1351
if rev_history == []:
1354
rev_id = rev_history[-1]
1355
self._clear_cached_state()
1356
response = self._client.call('Branch.set_last_revision',
1357
path, self._lock_token, self._repo_lock_token, rev_id)
1358
if response[0] == 'NoSuchRevision':
1359
raise NoSuchRevision(self, rev_id)
1361
assert response == ('ok',), (
1362
'unexpected response code %r' % (response,))
1363
self._cache_revision_history(rev_history)
1365
def get_parent(self):
1367
return self._real_branch.get_parent()
1369
def set_parent(self, url):
1371
return self._real_branch.set_parent(url)
1373
def get_config(self):
1374
return RemoteBranchConfig(self)
1376
def sprout(self, to_bzrdir, revision_id=None):
1377
# Like Branch.sprout, except that it sprouts a branch in the default
1378
# format, because RemoteBranches can't be created at arbitrary URLs.
1379
# XXX: if to_bzrdir is a RemoteBranch, this should perhaps do
1380
# to_bzrdir.create_branch...
1382
result = self._real_branch._format.initialize(to_bzrdir)
1383
self.copy_content_into(result, revision_id=revision_id)
1384
result.set_parent(self.bzrdir.root_transport.base)
1388
def pull(self, source, overwrite=False, stop_revision=None,
1390
# FIXME: This asks the real branch to run the hooks, which means
1391
# they're called with the wrong target branch parameter.
1392
# The test suite specifically allows this at present but it should be
1393
# fixed. It should get a _override_hook_target branch,
1394
# as push does. -- mbp 20070405
1396
self._real_branch.pull(
1397
source, overwrite=overwrite, stop_revision=stop_revision,
1401
def push(self, target, overwrite=False, stop_revision=None):
1403
return self._real_branch.push(
1404
target, overwrite=overwrite, stop_revision=stop_revision,
1405
_override_hook_source_branch=self)
1407
def is_locked(self):
1408
return self._lock_count >= 1
1410
def set_last_revision_info(self, revno, revision_id):
1412
self._clear_cached_state()
1413
return self._real_branch.set_last_revision_info(revno, revision_id)
1415
def generate_revision_history(self, revision_id, last_rev=None,
1418
return self._real_branch.generate_revision_history(
1419
revision_id, last_rev=last_rev, other_branch=other_branch)
1424
return self._real_branch.tags
1426
def set_push_location(self, location):
1428
return self._real_branch.set_push_location(location)
1430
def update_revisions(self, other, stop_revision=None, overwrite=False):
1432
return self._real_branch.update_revisions(
1433
other, stop_revision=stop_revision, overwrite=overwrite)
1436
class RemoteBranchConfig(BranchConfig):
1439
self.branch._ensure_real()
1440
return self.branch._real_branch.get_config().username()
1442
def _get_branch_data_config(self):
1443
self.branch._ensure_real()
1444
if self._branch_data_config is None:
1445
self._branch_data_config = TreeConfig(self.branch._real_branch)
1446
return self._branch_data_config
1449
def _extract_tar(tar, to_dir):
1450
"""Extract all the contents of a tarfile object.
1452
A replacement for extractall, which is not present in python2.4
1455
tar.extract(tarinfo, to_dir)
added
removed
bzrlib/remote.py
