13
13
# You should have received a copy of the GNU General Public License
14
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.
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21
from cStringIO import StringIO
23
19
from bzrlib import (
31
revision as _mod_revision,
33
34
from bzrlib.branch import BranchReferenceFormat
34
35
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
35
from bzrlib.config import BranchConfig, TreeConfig
36
36
from bzrlib.decorators import needs_read_lock, needs_write_lock
37
37
from bzrlib.errors import (
39
39
SmartProtocolError,
41
41
from bzrlib.lockable_files import LockableFiles
42
from bzrlib.pack import ContainerPushParser
43
from bzrlib.smart import client, vfs
44
from bzrlib.symbol_versioning import (
42
from bzrlib.smart import client, vfs, repository as smart_repo
48
43
from bzrlib.revision import ensure_null, NULL_REVISION
49
44
from bzrlib.trace import mutter, note, warning
47
class _RpcHelper(object):
48
"""Mixin class that helps with issuing RPCs."""
50
def _call(self, method, *args, **err_context):
52
return self._client.call(method, *args)
53
except errors.ErrorFromSmartServer, err:
54
self._translate_error(err, **err_context)
56
def _call_expecting_body(self, method, *args, **err_context):
58
return self._client.call_expecting_body(method, *args)
59
except errors.ErrorFromSmartServer, err:
60
self._translate_error(err, **err_context)
62
def _call_with_body_bytes(self, method, args, body_bytes, **err_context):
64
return self._client.call_with_body_bytes(method, args, body_bytes)
65
except errors.ErrorFromSmartServer, err:
66
self._translate_error(err, **err_context)
68
def _call_with_body_bytes_expecting_body(self, method, args, body_bytes,
71
return self._client.call_with_body_bytes_expecting_body(
72
method, args, body_bytes)
73
except errors.ErrorFromSmartServer, err:
74
self._translate_error(err, **err_context)
77
def response_tuple_to_repo_format(response):
78
"""Convert a response tuple describing a repository format to a format."""
79
format = RemoteRepositoryFormat()
80
format._rich_root_data = (response[0] == 'yes')
81
format._supports_tree_reference = (response[1] == 'yes')
82
format._supports_external_lookups = (response[2] == 'yes')
83
format._network_name = response[3]
52
87
# Note: RemoteBzrDirFormat is in bzrdir.py
54
class RemoteBzrDir(BzrDir):
89
class RemoteBzrDir(BzrDir, _RpcHelper):
55
90
"""Control directory on a remote server, accessed via bzr:// or similar."""
57
def __init__(self, transport, _client=None):
92
def __init__(self, transport, format, _client=None):
58
93
"""Construct a RemoteBzrDir.
60
95
:param _client: Private parameter for testing. Disables probing and the
61
96
use of a real bzrdir.
63
BzrDir.__init__(self, transport, RemoteBzrDirFormat())
98
BzrDir.__init__(self, transport, format)
64
99
# this object holds a delegated bzrdir that uses file-level operations
65
100
# to talk to the other side
66
101
self._real_bzrdir = None
102
# 1-shot cache for the call pattern 'create_branch; open_branch' - see
103
# create_branch for details.
104
self._next_open_branch_result = None
68
106
if _client is None:
69
107
medium = transport.get_smart_medium()
87
125
if not self._real_bzrdir:
88
126
self._real_bzrdir = BzrDir.open_from_transport(
89
127
self.root_transport, _server_formats=False)
128
self._format._network_name = \
129
self._real_bzrdir._format.network_name()
131
def _translate_error(self, err, **context):
132
_translate_error(err, bzrdir=self, **context)
134
def break_lock(self):
135
# Prevent aliasing problems in the next_open_branch_result cache.
136
# See create_branch for rationale.
137
self._next_open_branch_result = None
138
return BzrDir.break_lock(self)
140
def _vfs_cloning_metadir(self, require_stacking=False):
142
return self._real_bzrdir.cloning_metadir(
143
require_stacking=require_stacking)
145
def cloning_metadir(self, require_stacking=False):
146
medium = self._client._medium
147
if medium._is_remote_before((1, 13)):
148
return self._vfs_cloning_metadir(require_stacking=require_stacking)
149
verb = 'BzrDir.cloning_metadir'
154
path = self._path_for_remote_call(self._client)
156
response = self._call(verb, path, stacking)
157
except errors.UnknownSmartMethod:
158
medium._remember_remote_is_before((1, 13))
159
return self._vfs_cloning_metadir(require_stacking=require_stacking)
160
except errors.UnknownErrorFromSmartServer, err:
161
if err.error_tuple != ('BranchReference',):
163
# We need to resolve the branch reference to determine the
164
# cloning_metadir. This causes unnecessary RPCs to open the
165
# referenced branch (and bzrdir, etc) but only when the caller
166
# didn't already resolve the branch reference.
167
referenced_branch = self.open_branch()
168
return referenced_branch.bzrdir.cloning_metadir()
169
if len(response) != 3:
170
raise errors.UnexpectedSmartServerResponse(response)
171
control_name, repo_name, branch_info = response
172
if len(branch_info) != 2:
173
raise errors.UnexpectedSmartServerResponse(response)
174
branch_ref, branch_name = branch_info
175
format = bzrdir.network_format_registry.get(control_name)
177
format.repository_format = repository.network_format_registry.get(
179
if branch_ref == 'ref':
180
# XXX: we need possible_transports here to avoid reopening the
181
# connection to the referenced location
182
ref_bzrdir = BzrDir.open(branch_name)
183
branch_format = ref_bzrdir.cloning_metadir().get_branch_format()
184
format.set_branch_format(branch_format)
185
elif branch_ref == 'branch':
187
format.set_branch_format(
188
branch.network_format_registry.get(branch_name))
190
raise errors.UnexpectedSmartServerResponse(response)
91
193
def create_repository(self, shared=False):
93
self._real_bzrdir.create_repository(shared=shared)
94
return self.open_repository()
194
# as per meta1 formats - just delegate to the format object which may
196
result = self._format.repository_format.initialize(self, shared)
197
if not isinstance(result, RemoteRepository):
198
return self.open_repository()
96
202
def destroy_repository(self):
97
203
"""See BzrDir.destroy_repository"""
122
241
def get_branch_reference(self):
123
242
"""See BzrDir.get_branch_reference()."""
243
response = self._get_branch_reference()
244
if response[0] == 'ref':
249
def _get_branch_reference(self):
124
250
path = self._path_for_remote_call(self._client)
126
response = self._client.call('BzrDir.open_branch', path)
127
except errors.ErrorFromSmartServer, err:
128
if err.error_tuple == ('nobranch',):
129
raise errors.NotBranchError(path=self.root_transport.base)
131
if response[0] == 'ok':
132
if response[1] == '':
133
# branch at this location.
136
# a branch reference, use the existing BranchReference logic.
251
medium = self._client._medium
252
if not medium._is_remote_before((1, 13)):
254
response = self._call('BzrDir.open_branchV2', path)
255
if response[0] not in ('ref', 'branch'):
256
raise errors.UnexpectedSmartServerResponse(response)
258
except errors.UnknownSmartMethod:
259
medium._remember_remote_is_before((1, 13))
260
response = self._call('BzrDir.open_branch', path)
261
if response[0] != 'ok':
139
262
raise errors.UnexpectedSmartServerResponse(response)
263
if response[1] != '':
264
return ('ref', response[1])
266
return ('branch', '')
141
268
def _get_tree_branch(self):
142
269
"""See BzrDir._get_tree_branch()."""
143
270
return None, self.open_branch()
145
def open_branch(self, _unsupported=False):
272
def open_branch(self, _unsupported=False, ignore_fallbacks=False):
147
274
raise NotImplementedError('unsupported flag support not implemented yet.')
148
reference_url = self.get_branch_reference()
149
if reference_url is None:
150
# branch at this location.
151
return RemoteBranch(self, self.find_repository())
275
if self._next_open_branch_result is not None:
276
# See create_branch for details.
277
result = self._next_open_branch_result
278
self._next_open_branch_result = None
280
response = self._get_branch_reference()
281
if response[0] == 'ref':
153
282
# a branch reference, use the existing BranchReference logic.
154
283
format = BranchReferenceFormat()
155
return format.open(self, _found=True, location=reference_url)
284
return format.open(self, _found=True, location=response[1],
285
ignore_fallbacks=ignore_fallbacks)
286
branch_format_name = response[1]
287
if not branch_format_name:
288
branch_format_name = None
289
format = RemoteBranchFormat(network_name=branch_format_name)
290
return RemoteBranch(self, self.find_repository(), format=format,
291
setup_stacking=not ignore_fallbacks)
293
def _open_repo_v1(self, path):
294
verb = 'BzrDir.find_repository'
295
response = self._call(verb, path)
296
if response[0] != 'ok':
297
raise errors.UnexpectedSmartServerResponse(response)
298
# servers that only support the v1 method don't support external
301
repo = self._real_bzrdir.open_repository()
302
response = response + ('no', repo._format.network_name())
303
return response, repo
305
def _open_repo_v2(self, path):
306
verb = 'BzrDir.find_repositoryV2'
307
response = self._call(verb, path)
308
if response[0] != 'ok':
309
raise errors.UnexpectedSmartServerResponse(response)
311
repo = self._real_bzrdir.open_repository()
312
response = response + (repo._format.network_name(),)
313
return response, repo
315
def _open_repo_v3(self, path):
316
verb = 'BzrDir.find_repositoryV3'
317
medium = self._client._medium
318
if medium._is_remote_before((1, 13)):
319
raise errors.UnknownSmartMethod(verb)
321
response = self._call(verb, path)
322
except errors.UnknownSmartMethod:
323
medium._remember_remote_is_before((1, 13))
325
if response[0] != 'ok':
326
raise errors.UnexpectedSmartServerResponse(response)
327
return response, None
157
329
def open_repository(self):
158
330
path = self._path_for_remote_call(self._client)
159
verb = 'BzrDir.find_repositoryV2'
332
for probe in [self._open_repo_v3, self._open_repo_v2,
162
response = self._client.call(verb, path)
335
response, real_repo = probe(path)
163
337
except errors.UnknownSmartMethod:
164
verb = 'BzrDir.find_repository'
165
response = self._client.call(verb, path)
166
except errors.ErrorFromSmartServer, err:
167
if err.error_verb == 'norepository':
168
raise errors.NoRepositoryPresent(self)
340
raise errors.UnknownSmartMethod('BzrDir.find_repository{3,2,}')
170
341
if response[0] != 'ok':
171
342
raise errors.UnexpectedSmartServerResponse(response)
172
if verb == 'BzrDir.find_repository':
173
# servers that don't support the V2 method don't support external
175
response = response + ('no', )
176
if not (len(response) == 5):
343
if len(response) != 6:
177
344
raise SmartProtocolError('incorrect response length %s' % (response,))
178
345
if response[1] == '':
179
format = RemoteRepositoryFormat()
180
format.rich_root_data = (response[2] == 'yes')
181
format.supports_tree_reference = (response[3] == 'yes')
182
# No wire format to check this yet.
183
format.supports_external_lookups = (response[4] == 'yes')
346
# repo is at this dir.
347
format = response_tuple_to_repo_format(response[2:])
184
348
# Used to support creating a real format instance when needed.
185
349
format._creating_bzrdir = self
186
return RemoteRepository(self, format)
350
remote_repo = RemoteRepository(self, format)
351
format._creating_repo = remote_repo
352
if real_repo is not None:
353
remote_repo._set_real_repository(real_repo)
188
356
raise errors.NoRepositoryPresent(self)
235
410
the attributes rich_root_data and supports_tree_reference are set
236
411
on a per instance basis, and are not set (and should not be) at
414
:ivar _custom_format: If set, a specific concrete repository format that
415
will be used when initializing a repository with this
416
RemoteRepositoryFormat.
417
:ivar _creating_repo: If set, the repository object that this
418
RemoteRepositoryFormat was created for: it can be called into
419
to obtain data like the network name.
240
_matchingbzrdir = RemoteBzrDirFormat
242
def initialize(self, a_bzrdir, shared=False):
243
if not isinstance(a_bzrdir, RemoteBzrDir):
422
_matchingbzrdir = RemoteBzrDirFormat()
425
repository.RepositoryFormat.__init__(self)
426
self._custom_format = None
427
self._network_name = None
428
self._creating_bzrdir = None
429
self._supports_chks = None
430
self._supports_external_lookups = None
431
self._supports_tree_reference = None
432
self._rich_root_data = None
435
return "%s(_network_name=%r)" % (self.__class__.__name__,
439
def fast_deltas(self):
441
return self._custom_format.fast_deltas
444
def rich_root_data(self):
445
if self._rich_root_data is None:
447
self._rich_root_data = self._custom_format.rich_root_data
448
return self._rich_root_data
451
def supports_chks(self):
452
if self._supports_chks is None:
454
self._supports_chks = self._custom_format.supports_chks
455
return self._supports_chks
458
def supports_external_lookups(self):
459
if self._supports_external_lookups is None:
461
self._supports_external_lookups = \
462
self._custom_format.supports_external_lookups
463
return self._supports_external_lookups
466
def supports_tree_reference(self):
467
if self._supports_tree_reference is None:
469
self._supports_tree_reference = \
470
self._custom_format.supports_tree_reference
471
return self._supports_tree_reference
473
def _vfs_initialize(self, a_bzrdir, shared):
474
"""Helper for common code in initialize."""
475
if self._custom_format:
476
# Custom format requested
477
result = self._custom_format.initialize(a_bzrdir, shared=shared)
478
elif self._creating_bzrdir is not None:
479
# Use the format that the repository we were created to back
244
481
prior_repo = self._creating_bzrdir.open_repository()
245
482
prior_repo._ensure_real()
246
return prior_repo._real_repository._format.initialize(
483
result = prior_repo._real_repository._format.initialize(
247
484
a_bzrdir, shared=shared)
248
return a_bzrdir.create_repository(shared=shared)
486
# assume that a_bzr is a RemoteBzrDir but the smart server didn't
487
# support remote initialization.
488
# We delegate to a real object at this point (as RemoteBzrDir
489
# delegate to the repository format which would lead to infinite
490
# recursion if we just called a_bzrdir.create_repository.
491
a_bzrdir._ensure_real()
492
result = a_bzrdir._real_bzrdir.create_repository(shared=shared)
493
if not isinstance(result, RemoteRepository):
494
return self.open(a_bzrdir)
498
def initialize(self, a_bzrdir, shared=False):
499
# Being asked to create on a non RemoteBzrDir:
500
if not isinstance(a_bzrdir, RemoteBzrDir):
501
return self._vfs_initialize(a_bzrdir, shared)
502
medium = a_bzrdir._client._medium
503
if medium._is_remote_before((1, 13)):
504
return self._vfs_initialize(a_bzrdir, shared)
505
# Creating on a remote bzr dir.
506
# 1) get the network name to use.
507
if self._custom_format:
508
network_name = self._custom_format.network_name()
509
elif self._network_name:
510
network_name = self._network_name
512
# Select the current bzrlib default and ask for that.
513
reference_bzrdir_format = bzrdir.format_registry.get('default')()
514
reference_format = reference_bzrdir_format.repository_format
515
network_name = reference_format.network_name()
516
# 2) try direct creation via RPC
517
path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
518
verb = 'BzrDir.create_repository'
524
response = a_bzrdir._call(verb, path, network_name, shared_str)
525
except errors.UnknownSmartMethod:
526
# Fallback - use vfs methods
527
medium._remember_remote_is_before((1, 13))
528
return self._vfs_initialize(a_bzrdir, shared)
530
# Turn the response into a RemoteRepository object.
531
format = response_tuple_to_repo_format(response[1:])
532
# Used to support creating a real format instance when needed.
533
format._creating_bzrdir = a_bzrdir
534
remote_repo = RemoteRepository(a_bzrdir, format)
535
format._creating_repo = remote_repo
250
538
def open(self, a_bzrdir):
251
539
if not isinstance(a_bzrdir, RemoteBzrDir):
252
540
raise AssertionError('%r is not a RemoteBzrDir' % (a_bzrdir,))
253
541
return a_bzrdir.open_repository()
543
def _ensure_real(self):
544
if self._custom_format is None:
545
self._custom_format = repository.network_format_registry.get(
549
def _fetch_order(self):
551
return self._custom_format._fetch_order
554
def _fetch_uses_deltas(self):
556
return self._custom_format._fetch_uses_deltas
559
def _fetch_reconcile(self):
561
return self._custom_format._fetch_reconcile
255
563
def get_format_description(self):
256
564
return 'bzr remote repository'
258
566
def __eq__(self, other):
259
return self.__class__ == other.__class__
261
def check_conversion_target(self, target_format):
262
if self.rich_root_data and not target_format.rich_root_data:
263
raise errors.BadConversionTarget(
264
'Does not support rich root data.', target_format)
265
if (self.supports_tree_reference and
266
not getattr(target_format, 'supports_tree_reference', False)):
267
raise errors.BadConversionTarget(
268
'Does not support nested trees', target_format)
271
class RemoteRepository(object):
567
return self.__class__ is other.__class__
569
def network_name(self):
570
if self._network_name:
571
return self._network_name
572
self._creating_repo._ensure_real()
573
return self._creating_repo._real_repository._format.network_name()
576
def pack_compresses(self):
578
return self._custom_format.pack_compresses
581
def _serializer(self):
583
return self._custom_format._serializer
586
class RemoteRepository(_RpcHelper):
272
587
"""Repository accessed over rpc.
274
589
For the moment most operations are performed using local transport-backed
343
672
self._ensure_real()
344
673
return self._real_repository.commit_write_group()
675
def resume_write_group(self, tokens):
677
return self._real_repository.resume_write_group(tokens)
679
def suspend_write_group(self):
681
return self._real_repository.suspend_write_group()
683
def get_missing_parent_inventories(self, check_for_missing_texts=True):
685
return self._real_repository.get_missing_parent_inventories(
686
check_for_missing_texts=check_for_missing_texts)
688
def _get_rev_id_for_revno_vfs(self, revno, known_pair):
690
return self._real_repository.get_rev_id_for_revno(
693
def get_rev_id_for_revno(self, revno, known_pair):
694
"""See Repository.get_rev_id_for_revno."""
695
path = self.bzrdir._path_for_remote_call(self._client)
697
if self._client._medium._is_remote_before((1, 17)):
698
return self._get_rev_id_for_revno_vfs(revno, known_pair)
699
response = self._call(
700
'Repository.get_rev_id_for_revno', path, revno, known_pair)
701
except errors.UnknownSmartMethod:
702
self._client._medium._remember_remote_is_before((1, 17))
703
return self._get_rev_id_for_revno_vfs(revno, known_pair)
704
if response[0] == 'ok':
705
return True, response[1]
706
elif response[0] == 'history-incomplete':
707
known_pair = response[1:3]
708
for fallback in self._fallback_repositories:
709
found, result = fallback.get_rev_id_for_revno(revno, known_pair)
714
# Not found in any fallbacks
715
return False, known_pair
717
raise errors.UnexpectedSmartServerResponse(response)
346
719
def _ensure_real(self):
347
720
"""Ensure that there is a _real_repository set.
349
722
Used before calls to self._real_repository.
724
Note that _ensure_real causes many roundtrips to the server which are
725
not desirable, and prevents the use of smart one-roundtrip RPC's to
726
perform complex operations (such as accessing parent data, streaming
727
revisions etc). Adding calls to _ensure_real should only be done when
728
bringing up new functionality, adding fallbacks for smart methods that
729
require a fallback path, and never to replace an existing smart method
730
invocation. If in doubt chat to the bzr network team.
351
if not self._real_repository:
732
if self._real_repository is None:
733
if 'hpssvfs' in debug.debug_flags:
735
warning('VFS Repository access triggered\n%s',
736
''.join(traceback.format_stack()))
737
self._unstacked_provider.missing_keys.clear()
352
738
self.bzrdir._ensure_real()
353
#self._real_repository = self.bzrdir._real_bzrdir.open_repository()
354
self._set_real_repository(self.bzrdir._real_bzrdir.open_repository())
739
self._set_real_repository(
740
self.bzrdir._real_bzrdir.open_repository())
742
def _translate_error(self, err, **context):
743
self.bzrdir._translate_error(err, repository=self, **context)
356
745
def find_text_key_references(self):
357
746
"""Find the text key references within the repository.
410
789
for line in lines:
411
790
d = tuple(line.split())
412
791
revision_graph[d[0]] = d[1:]
414
793
return revision_graph
796
"""See Repository._get_sink()."""
797
return RemoteStreamSink(self)
799
def _get_source(self, to_format):
800
"""Return a source for streaming from this repository."""
801
return RemoteStreamSource(self, to_format)
416
804
def has_revision(self, revision_id):
417
"""See Repository.has_revision()."""
418
if revision_id == NULL_REVISION:
419
# The null revision is always present.
421
path = self.bzrdir._path_for_remote_call(self._client)
422
response = self._client.call(
423
'Repository.has_revision', path, revision_id)
424
if response[0] not in ('yes', 'no'):
425
raise errors.UnexpectedSmartServerResponse(response)
426
return response[0] == 'yes'
805
"""True if this repository has a copy of the revision."""
806
# Copy of bzrlib.repository.Repository.has_revision
807
return revision_id in self.has_revisions((revision_id,))
428
810
def has_revisions(self, revision_ids):
429
"""See Repository.has_revisions()."""
431
for revision_id in revision_ids:
432
if self.has_revision(revision_id):
433
result.add(revision_id)
811
"""Probe to find out the presence of multiple revisions.
813
:param revision_ids: An iterable of revision_ids.
814
:return: A set of the revision_ids that were present.
816
# Copy of bzrlib.repository.Repository.has_revisions
817
parent_map = self.get_parent_map(revision_ids)
818
result = set(parent_map)
819
if _mod_revision.NULL_REVISION in revision_ids:
820
result.add(_mod_revision.NULL_REVISION)
823
def _has_same_fallbacks(self, other_repo):
824
"""Returns true if the repositories have the same fallbacks."""
825
# XXX: copied from Repository; it should be unified into a base class
826
# <https://bugs.edge.launchpad.net/bzr/+bug/401622>
827
my_fb = self._fallback_repositories
828
other_fb = other_repo._fallback_repositories
829
if len(my_fb) != len(other_fb):
831
for f, g in zip(my_fb, other_fb):
832
if not f.has_same_location(g):
436
836
def has_same_location(self, other):
437
return (self.__class__ == other.__class__ and
837
# TODO: Move to RepositoryBase and unify with the regular Repository
838
# one; unfortunately the tests rely on slightly different behaviour at
839
# present -- mbp 20090710
840
return (self.__class__ is other.__class__ and
438
841
self.bzrdir.transport.base == other.bzrdir.transport.base)
440
843
def get_graph(self, other_repository=None):
441
844
"""Return the graph for this repository format"""
442
parents_provider = self
443
if (other_repository is not None and
444
other_repository.bzrdir.transport.base !=
445
self.bzrdir.transport.base):
446
parents_provider = graph._StackedParentsProvider(
447
[parents_provider, other_repository._make_parents_provider()])
845
parents_provider = self._make_parents_provider(other_repository)
448
846
return graph.Graph(parents_provider)
450
848
def gather_stats(self, revid=None, committers=None):
702
1129
# FIXME: It ought to be possible to call this without immediately
703
1130
# triggering _ensure_real. For now it's the easiest thing to do.
704
1131
self._ensure_real()
705
builder = self._real_repository.get_commit_builder(branch, parents,
1132
real_repo = self._real_repository
1133
builder = real_repo.get_commit_builder(branch, parents,
706
1134
config, timestamp=timestamp, timezone=timezone,
707
1135
committer=committer, revprops=revprops, revision_id=revision_id)
710
1138
def add_fallback_repository(self, repository):
711
1139
"""Add a repository to use for looking up data not held locally.
713
1141
:param repository: A repository.
715
1143
if not self._format.supports_external_lookups:
716
raise errors.UnstackableRepositoryFormat(self._format, self.base)
1144
raise errors.UnstackableRepositoryFormat(
1145
self._format.network_name(), self.base)
717
1146
# We need to accumulate additional repositories here, to pass them in
718
1147
# on various RPC's.
1149
if self.is_locked():
1150
# We will call fallback.unlock() when we transition to the unlocked
1151
# state, so always add a lock here. If a caller passes us a locked
1152
# repository, they are responsible for unlocking it later.
1153
repository.lock_read()
719
1154
self._fallback_repositories.append(repository)
1155
# If self._real_repository was parameterised already (e.g. because a
1156
# _real_branch had its get_stacked_on_url method called), then the
1157
# repository to be added may already be in the _real_repositories list.
1158
if self._real_repository is not None:
1159
fallback_locations = [repo.bzrdir.root_transport.base for repo in
1160
self._real_repository._fallback_repositories]
1161
if repository.bzrdir.root_transport.base not in fallback_locations:
1162
self._real_repository.add_fallback_repository(repository)
721
1164
def add_inventory(self, revid, inv, parents):
722
1165
self._ensure_real()
723
1166
return self._real_repository.add_inventory(revid, inv, parents)
1168
def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1171
return self._real_repository.add_inventory_by_delta(basis_revision_id,
1172
delta, new_revision_id, parents)
725
1174
def add_revision(self, rev_id, rev, inv=None, config=None):
726
1175
self._ensure_real()
727
1176
return self._real_repository.add_revision(
808
1286
self._ensure_real()
809
1287
return self._real_repository._get_versioned_file_checker(
810
1288
revisions, revision_versions_cache)
812
1290
def iter_files_bytes(self, desired_files):
813
1291
"""See Repository.iter_file_bytes.
815
1293
self._ensure_real()
816
1294
return self._real_repository.iter_files_bytes(desired_files)
818
def get_parent_map(self, keys):
1296
def get_parent_map(self, revision_ids):
819
1297
"""See bzrlib.Graph.get_parent_map()."""
820
# Hack to build up the caching logic.
821
ancestry = self._parents_map
823
# Repository is not locked, so there's no cache.
824
missing_revisions = set(keys)
827
missing_revisions = set(key for key in keys if key not in ancestry)
828
if missing_revisions:
829
parent_map = self._get_parent_map(missing_revisions)
830
if 'hpss' in debug.debug_flags:
831
mutter('retransmitted revisions: %d of %d',
832
len(set(ancestry).intersection(parent_map)),
834
ancestry.update(parent_map)
835
present_keys = [k for k in keys if k in ancestry]
836
if 'hpss' in debug.debug_flags:
837
if self._requested_parents is not None and len(ancestry) != 0:
838
self._requested_parents.update(present_keys)
839
mutter('Current RemoteRepository graph hit rate: %d%%',
840
100.0 * len(self._requested_parents) / len(ancestry))
841
return dict((k, ancestry[k]) for k in present_keys)
1298
return self._make_parents_provider().get_parent_map(revision_ids)
843
def _get_parent_map(self, keys):
1300
def _get_parent_map_rpc(self, keys):
844
1301
"""Helper for get_parent_map that performs the RPC."""
845
1302
medium = self._client._medium
846
1303
if medium._is_remote_before((1, 2)):
847
1304
# We already found out that the server can't understand
848
1305
# Repository.get_parent_map requests, so just fetch the whole
850
# XXX: Note that this will issue a deprecation warning. This is ok
851
# :- its because we're working with a deprecated server anyway, and
852
# the user will almost certainly have seen a warning about the
853
# server version already.
854
rg = self.get_revision_graph()
855
# There is an api discrepency between get_parent_map and
1308
# Note that this reads the whole graph, when only some keys are
1309
# wanted. On this old server there's no way (?) to get them all
1310
# in one go, and the user probably will have seen a warning about
1311
# the server being old anyhow.
1312
rg = self._get_revision_graph(None)
1313
# There is an API discrepancy between get_parent_map and
856
1314
# get_revision_graph. Specifically, a "key:()" pair in
857
1315
# get_revision_graph just means a node has no parents. For
858
1316
# "get_parent_map" it means the node is a ghost. So fix up the
1150
1645
:param recipe: A search recipe (start, stop, count).
1151
1646
:return: Serialised bytes.
1153
start_keys = ' '.join(recipe[0])
1154
stop_keys = ' '.join(recipe[1])
1155
count = str(recipe[2])
1648
start_keys = ' '.join(recipe[1])
1649
stop_keys = ' '.join(recipe[2])
1650
count = str(recipe[3])
1156
1651
return '\n'.join((start_keys, stop_keys, count))
1653
def _serialise_search_result(self, search_result):
1654
if isinstance(search_result, graph.PendingAncestryResult):
1655
parts = ['ancestry-of']
1656
parts.extend(search_result.heads)
1658
recipe = search_result.get_recipe()
1659
parts = [recipe[0], self._serialise_search_recipe(recipe)]
1660
return '\n'.join(parts)
1663
path = self.bzrdir._path_for_remote_call(self._client)
1665
response = self._call('PackRepository.autopack', path)
1666
except errors.UnknownSmartMethod:
1668
self._real_repository._pack_collection.autopack()
1671
if response[0] != 'ok':
1672
raise errors.UnexpectedSmartServerResponse(response)
1675
class RemoteStreamSink(repository.StreamSink):
1677
def _insert_real(self, stream, src_format, resume_tokens):
1678
self.target_repo._ensure_real()
1679
sink = self.target_repo._real_repository._get_sink()
1680
result = sink.insert_stream(stream, src_format, resume_tokens)
1682
self.target_repo.autopack()
1685
def insert_stream(self, stream, src_format, resume_tokens):
1686
target = self.target_repo
1687
target._unstacked_provider.missing_keys.clear()
1688
candidate_calls = [('Repository.insert_stream_1.19', (1, 19))]
1689
if target._lock_token:
1690
candidate_calls.append(('Repository.insert_stream_locked', (1, 14)))
1691
lock_args = (target._lock_token or '',)
1693
candidate_calls.append(('Repository.insert_stream', (1, 13)))
1695
client = target._client
1696
medium = client._medium
1697
path = target.bzrdir._path_for_remote_call(client)
1698
# Probe for the verb to use with an empty stream before sending the
1699
# real stream to it. We do this both to avoid the risk of sending a
1700
# large request that is then rejected, and because we don't want to
1701
# implement a way to buffer, rewind, or restart the stream.
1703
for verb, required_version in candidate_calls:
1704
if medium._is_remote_before(required_version):
1707
# We've already done the probing (and set _is_remote_before) on
1708
# a previous insert.
1711
byte_stream = smart_repo._stream_to_byte_stream([], src_format)
1713
response = client.call_with_body_stream(
1714
(verb, path, '') + lock_args, byte_stream)
1715
except errors.UnknownSmartMethod:
1716
medium._remember_remote_is_before(required_version)
1722
return self._insert_real(stream, src_format, resume_tokens)
1723
self._last_inv_record = None
1724
self._last_substream = None
1725
if required_version < (1, 19):
1726
# Remote side doesn't support inventory deltas. Wrap the stream to
1727
# make sure we don't send any. If the stream contains inventory
1728
# deltas we'll interrupt the smart insert_stream request and
1730
stream = self._stop_stream_if_inventory_delta(stream)
1731
byte_stream = smart_repo._stream_to_byte_stream(
1733
resume_tokens = ' '.join(resume_tokens)
1734
response = client.call_with_body_stream(
1735
(verb, path, resume_tokens) + lock_args, byte_stream)
1736
if response[0][0] not in ('ok', 'missing-basis'):
1737
raise errors.UnexpectedSmartServerResponse(response)
1738
if self._last_substream is not None:
1739
# The stream included an inventory-delta record, but the remote
1740
# side isn't new enough to support them. So we need to send the
1741
# rest of the stream via VFS.
1742
self.target_repo.refresh_data()
1743
return self._resume_stream_with_vfs(response, src_format)
1744
if response[0][0] == 'missing-basis':
1745
tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
1746
resume_tokens = tokens
1747
return resume_tokens, set(missing_keys)
1749
self.target_repo.refresh_data()
1752
def _resume_stream_with_vfs(self, response, src_format):
1753
"""Resume sending a stream via VFS, first resending the record and
1754
substream that couldn't be sent via an insert_stream verb.
1756
if response[0][0] == 'missing-basis':
1757
tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
1758
# Ignore missing_keys, we haven't finished inserting yet
1761
def resume_substream():
1762
# Yield the substream that was interrupted.
1763
for record in self._last_substream:
1765
self._last_substream = None
1766
def resume_stream():
1767
# Finish sending the interrupted substream
1768
yield ('inventory-deltas', resume_substream())
1769
# Then simply continue sending the rest of the stream.
1770
for substream_kind, substream in self._last_stream:
1771
yield substream_kind, substream
1772
return self._insert_real(resume_stream(), src_format, tokens)
1774
def _stop_stream_if_inventory_delta(self, stream):
1775
"""Normally this just lets the original stream pass-through unchanged.
1777
However if any 'inventory-deltas' substream occurs it will stop
1778
streaming, and store the interrupted substream and stream in
1779
self._last_substream and self._last_stream so that the stream can be
1780
resumed by _resume_stream_with_vfs.
1783
stream_iter = iter(stream)
1784
for substream_kind, substream in stream_iter:
1785
if substream_kind == 'inventory-deltas':
1786
self._last_substream = substream
1787
self._last_stream = stream_iter
1790
yield substream_kind, substream
1793
class RemoteStreamSource(repository.StreamSource):
1794
"""Stream data from a remote server."""
1796
def get_stream(self, search):
1797
if (self.from_repository._fallback_repositories and
1798
self.to_format._fetch_order == 'topological'):
1799
return self._real_stream(self.from_repository, search)
1802
repos = [self.from_repository]
1808
repos.extend(repo._fallback_repositories)
1809
sources.append(repo)
1810
return self.missing_parents_chain(search, sources)
1812
def get_stream_for_missing_keys(self, missing_keys):
1813
self.from_repository._ensure_real()
1814
real_repo = self.from_repository._real_repository
1815
real_source = real_repo._get_source(self.to_format)
1816
return real_source.get_stream_for_missing_keys(missing_keys)
1818
def _real_stream(self, repo, search):
1819
"""Get a stream for search from repo.
1821
This never called RemoteStreamSource.get_stream, and is a heler
1822
for RemoteStreamSource._get_stream to allow getting a stream
1823
reliably whether fallback back because of old servers or trying
1824
to stream from a non-RemoteRepository (which the stacked support
1827
source = repo._get_source(self.to_format)
1828
if isinstance(source, RemoteStreamSource):
1830
source = repo._real_repository._get_source(self.to_format)
1831
return source.get_stream(search)
1833
def _get_stream(self, repo, search):
1834
"""Core worker to get a stream from repo for search.
1836
This is used by both get_stream and the stacking support logic. It
1837
deliberately gets a stream for repo which does not need to be
1838
self.from_repository. In the event that repo is not Remote, or
1839
cannot do a smart stream, a fallback is made to the generic
1840
repository._get_stream() interface, via self._real_stream.
1842
In the event of stacking, streams from _get_stream will not
1843
contain all the data for search - this is normal (see get_stream).
1845
:param repo: A repository.
1846
:param search: A search.
1848
# Fallbacks may be non-smart
1849
if not isinstance(repo, RemoteRepository):
1850
return self._real_stream(repo, search)
1851
client = repo._client
1852
medium = client._medium
1853
path = repo.bzrdir._path_for_remote_call(client)
1854
search_bytes = repo._serialise_search_result(search)
1855
args = (path, self.to_format.network_name())
1857
('Repository.get_stream_1.19', (1, 19)),
1858
('Repository.get_stream', (1, 13))]
1860
for verb, version in candidate_verbs:
1861
if medium._is_remote_before(version):
1864
response = repo._call_with_body_bytes_expecting_body(
1865
verb, args, search_bytes)
1866
except errors.UnknownSmartMethod:
1867
medium._remember_remote_is_before(version)
1869
response_tuple, response_handler = response
1873
return self._real_stream(repo, search)
1874
if response_tuple[0] != 'ok':
1875
raise errors.UnexpectedSmartServerResponse(response_tuple)
1876
byte_stream = response_handler.read_streamed_body()
1877
src_format, stream = smart_repo._byte_stream_to_stream(byte_stream)
1878
if src_format.network_name() != repo._format.network_name():
1879
raise AssertionError(
1880
"Mismatched RemoteRepository and stream src %r, %r" % (
1881
src_format.network_name(), repo._format.network_name()))
1884
def missing_parents_chain(self, search, sources):
1885
"""Chain multiple streams together to handle stacking.
1887
:param search: The overall search to satisfy with streams.
1888
:param sources: A list of Repository objects to query.
1890
self.from_serialiser = self.from_repository._format._serializer
1891
self.seen_revs = set()
1892
self.referenced_revs = set()
1893
# If there are heads in the search, or the key count is > 0, we are not
1895
while not search.is_empty() and len(sources) > 1:
1896
source = sources.pop(0)
1897
stream = self._get_stream(source, search)
1898
for kind, substream in stream:
1899
if kind != 'revisions':
1900
yield kind, substream
1902
yield kind, self.missing_parents_rev_handler(substream)
1903
search = search.refine(self.seen_revs, self.referenced_revs)
1904
self.seen_revs = set()
1905
self.referenced_revs = set()
1906
if not search.is_empty():
1907
for kind, stream in self._get_stream(sources[0], search):
1910
def missing_parents_rev_handler(self, substream):
1911
for content in substream:
1912
revision_bytes = content.get_bytes_as('fulltext')
1913
revision = self.from_serialiser.read_revision_from_string(
1915
self.seen_revs.add(content.key[-1])
1916
self.referenced_revs.update(revision.parent_ids)
1159
1920
class RemoteBranchLockableFiles(LockableFiles):
1160
1921
"""A 'LockableFiles' implementation that talks to a smart server.
1162
1923
This is not a public interface class.
1179
1940
class RemoteBranchFormat(branch.BranchFormat):
1942
def __init__(self, network_name=None):
1943
super(RemoteBranchFormat, self).__init__()
1944
self._matchingbzrdir = RemoteBzrDirFormat()
1945
self._matchingbzrdir.set_branch_format(self)
1946
self._custom_format = None
1947
self._network_name = network_name
1181
1949
def __eq__(self, other):
1182
return (isinstance(other, RemoteBranchFormat) and
1950
return (isinstance(other, RemoteBranchFormat) and
1183
1951
self.__dict__ == other.__dict__)
1953
def _ensure_real(self):
1954
if self._custom_format is None:
1955
self._custom_format = branch.network_format_registry.get(
1185
1958
def get_format_description(self):
1186
1959
return 'Remote BZR Branch'
1188
def get_format_string(self):
1189
return 'Remote BZR Branch'
1191
def open(self, a_bzrdir):
1192
return a_bzrdir.open_branch()
1961
def network_name(self):
1962
return self._network_name
1964
def open(self, a_bzrdir, ignore_fallbacks=False):
1965
return a_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
1967
def _vfs_initialize(self, a_bzrdir):
1968
# Initialisation when using a local bzrdir object, or a non-vfs init
1969
# method is not available on the server.
1970
# self._custom_format is always set - the start of initialize ensures
1972
if isinstance(a_bzrdir, RemoteBzrDir):
1973
a_bzrdir._ensure_real()
1974
result = self._custom_format.initialize(a_bzrdir._real_bzrdir)
1976
# We assume the bzrdir is parameterised; it may not be.
1977
result = self._custom_format.initialize(a_bzrdir)
1978
if (isinstance(a_bzrdir, RemoteBzrDir) and
1979
not isinstance(result, RemoteBranch)):
1980
result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result)
1194
1983
def initialize(self, a_bzrdir):
1195
return a_bzrdir.create_branch()
1984
# 1) get the network name to use.
1985
if self._custom_format:
1986
network_name = self._custom_format.network_name()
1988
# Select the current bzrlib default and ask for that.
1989
reference_bzrdir_format = bzrdir.format_registry.get('default')()
1990
reference_format = reference_bzrdir_format.get_branch_format()
1991
self._custom_format = reference_format
1992
network_name = reference_format.network_name()
1993
# Being asked to create on a non RemoteBzrDir:
1994
if not isinstance(a_bzrdir, RemoteBzrDir):
1995
return self._vfs_initialize(a_bzrdir)
1996
medium = a_bzrdir._client._medium
1997
if medium._is_remote_before((1, 13)):
1998
return self._vfs_initialize(a_bzrdir)
1999
# Creating on a remote bzr dir.
2000
# 2) try direct creation via RPC
2001
path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
2002
verb = 'BzrDir.create_branch'
2004
response = a_bzrdir._call(verb, path, network_name)
2005
except errors.UnknownSmartMethod:
2006
# Fallback - use vfs methods
2007
medium._remember_remote_is_before((1, 13))
2008
return self._vfs_initialize(a_bzrdir)
2009
if response[0] != 'ok':
2010
raise errors.UnexpectedSmartServerResponse(response)
2011
# Turn the response into a RemoteRepository object.
2012
format = RemoteBranchFormat(network_name=response[1])
2013
repo_format = response_tuple_to_repo_format(response[3:])
2014
if response[2] == '':
2015
repo_bzrdir = a_bzrdir
2017
repo_bzrdir = RemoteBzrDir(
2018
a_bzrdir.root_transport.clone(response[2]), a_bzrdir._format,
2020
remote_repo = RemoteRepository(repo_bzrdir, repo_format)
2021
remote_branch = RemoteBranch(a_bzrdir, remote_repo,
2022
format=format, setup_stacking=False)
2023
# XXX: We know this is a new branch, so it must have revno 0, revid
2024
# NULL_REVISION. Creating the branch locked would make this be unable
2025
# to be wrong; here its simply very unlikely to be wrong. RBC 20090225
2026
remote_branch._last_revision_info_cache = 0, NULL_REVISION
2027
return remote_branch
2029
def make_tags(self, branch):
2031
return self._custom_format.make_tags(branch)
1197
2033
def supports_tags(self):
1198
2034
# Remote branches might support tags, but we won't know until we
1199
2035
# access the real remote branch.
1203
class RemoteBranch(branch.Branch):
2037
return self._custom_format.supports_tags()
2039
def supports_stacking(self):
2041
return self._custom_format.supports_stacking()
2043
def supports_set_append_revisions_only(self):
2045
return self._custom_format.supports_set_append_revisions_only()
2048
class RemoteBranch(branch.Branch, _RpcHelper):
1204
2049
"""Branch stored on a server accessed by HPSS RPC.
1206
2051
At the moment most operations are mapped down to simple file operations.
1209
2054
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
2055
_client=None, format=None, setup_stacking=True):
1211
2056
"""Create a RemoteBranch instance.
1213
2058
:param real_branch: An optional local implementation of the branch
1214
2059
format, usually accessing the data via the VFS.
1215
2060
:param _client: Private parameter for testing.
2061
:param format: A RemoteBranchFormat object, None to create one
2062
automatically. If supplied it should have a network_name already
2064
:param setup_stacking: If True make an RPC call to determine the
2065
stacked (or not) status of the branch. If False assume the branch
1217
2068
# We intentionally don't call the parent class's __init__, because it
1218
2069
# will try to assign to self.tags, which is a property in this subclass.
1219
2070
# And the parent's __init__ doesn't do much anyway.
1220
self._revision_id_to_revno_cache = None
1221
self._revision_history_cache = None
1222
self._last_revision_info_cache = None
1223
2071
self.bzrdir = remote_bzrdir
1224
2072
if _client is not None:
1225
2073
self._client = _client
1328
2223
:raises UnstackableRepositoryFormat: If the repository does not support
1332
return self._real_branch.get_stacked_on()
2227
# there may not be a repository yet, so we can't use
2228
# self._translate_error, so we can't use self._call either.
2229
response = self._client.call('Branch.get_stacked_on_url',
2230
self._remote_path())
2231
except errors.ErrorFromSmartServer, err:
2232
# there may not be a repository yet, so we can't call through
2233
# its _translate_error
2234
_translate_error(err, branch=self)
2235
except errors.UnknownSmartMethod, err:
2237
return self._real_branch.get_stacked_on_url()
2238
if response[0] != 'ok':
2239
raise errors.UnexpectedSmartServerResponse(response)
2242
def set_stacked_on_url(self, url):
2243
branch.Branch.set_stacked_on_url(self, url)
2245
self._is_stacked = False
2247
self._is_stacked = True
2249
def _vfs_get_tags_bytes(self):
2251
return self._real_branch._get_tags_bytes()
2253
def _get_tags_bytes(self):
2254
medium = self._client._medium
2255
if medium._is_remote_before((1, 13)):
2256
return self._vfs_get_tags_bytes()
2258
response = self._call('Branch.get_tags_bytes', self._remote_path())
2259
except errors.UnknownSmartMethod:
2260
medium._remember_remote_is_before((1, 13))
2261
return self._vfs_get_tags_bytes()
2264
def _vfs_set_tags_bytes(self, bytes):
2266
return self._real_branch._set_tags_bytes(bytes)
2268
def _set_tags_bytes(self, bytes):
2269
medium = self._client._medium
2270
if medium._is_remote_before((1, 18)):
2271
self._vfs_set_tags_bytes(bytes)
2275
self._remote_path(), self._lock_token, self._repo_lock_token)
2276
response = self._call_with_body_bytes(
2277
'Branch.set_tags_bytes', args, bytes)
2278
except errors.UnknownSmartMethod:
2279
medium._remember_remote_is_before((1, 18))
2280
self._vfs_set_tags_bytes(bytes)
1334
2282
def lock_read(self):
2283
self.repository.lock_read()
1335
2284
if not self._lock_mode:
1336
2285
self._lock_mode = 'r'
1337
2286
self._lock_count = 1
1347
2296
branch_token = token
1348
2297
repo_token = self.repository.lock_write()
1349
2298
self.repository.unlock()
1350
path = self.bzrdir._path_for_remote_call(self._client)
1352
response = self._client.call(
1353
'Branch.lock_write', path, branch_token, repo_token or '')
1354
except errors.ErrorFromSmartServer, err:
1355
if err.error_verb == 'LockContention':
1356
raise errors.LockContention('(remote lock)')
1357
elif err.error_verb == 'TokenMismatch':
1358
raise errors.TokenMismatch(token, '(remote token)')
1359
elif err.error_verb == 'UnlockableTransport':
1360
raise errors.UnlockableTransport(self.bzrdir.root_transport)
1361
elif err.error_verb == 'ReadOnlyError':
1362
raise errors.ReadOnlyError(self)
1363
elif err.error_verb == 'LockFailed':
1364
raise errors.LockFailed(err.error_args[0], err.error_args[1])
2299
err_context = {'token': token}
2300
response = self._call(
2301
'Branch.lock_write', self._remote_path(), branch_token,
2302
repo_token or '', **err_context)
1366
2303
if response[0] != 'ok':
1367
2304
raise errors.UnexpectedSmartServerResponse(response)
1368
2305
ok, branch_token, repo_token = response
1369
2306
return branch_token, repo_token
1371
2308
def lock_write(self, token=None):
1372
2309
if not self._lock_mode:
2310
# Lock the branch and repo in one remote call.
1373
2311
remote_tokens = self._remote_lock_write(token)
1374
2312
self._lock_token, self._repo_lock_token = remote_tokens
1375
2313
if not self._lock_token:
1376
2314
raise SmartProtocolError('Remote server did not return a token!')
1377
# TODO: We really, really, really don't want to call _ensure_real
1378
# here, but it's the easiest way to ensure coherency between the
1379
# state of the RemoteBranch and RemoteRepository objects and the
1380
# physical locks. If we don't materialise the real objects here,
1381
# then getting everything in the right state later is complex, so
1382
# for now we just do it the lazy way.
1383
# -- Andrew Bennetts, 2007-02-22.
2315
# Tell the self.repository object that it is locked.
2316
self.repository.lock_write(
2317
self._repo_lock_token, _skip_rpc=True)
1385
2319
if self._real_branch is not None:
1386
self._real_branch.repository.lock_write(
1387
token=self._repo_lock_token)
1389
self._real_branch.lock_write(token=self._lock_token)
1391
self._real_branch.repository.unlock()
2320
self._real_branch.lock_write(token=self._lock_token)
1392
2321
if token is not None:
1393
2322
self._leave_lock = True
1395
# XXX: this case seems to be unreachable; token cannot be None.
1396
2324
self._leave_lock = False
1397
2325
self._lock_mode = 'w'
1398
2326
self._lock_count = 1
1400
2328
raise errors.ReadOnlyTransaction
1402
2330
if token is not None:
1403
# A token was given to lock_write, and we're relocking, so check
1404
# that the given token actually matches the one we already have.
2331
# A token was given to lock_write, and we're relocking, so
2332
# check that the given token actually matches the one we
1405
2334
if token != self._lock_token:
1406
2335
raise errors.TokenMismatch(token, self._lock_token)
1407
2336
self._lock_count += 1
2337
# Re-lock the repository too.
2338
self.repository.lock_write(self._repo_lock_token)
1408
2339
return self._lock_token or None
1410
2341
def _unlock(self, branch_token, repo_token):
1411
path = self.bzrdir._path_for_remote_call(self._client)
1413
response = self._client.call('Branch.unlock', path, branch_token,
1415
except errors.ErrorFromSmartServer, err:
1416
if err.error_verb == 'TokenMismatch':
1417
raise errors.TokenMismatch(
1418
str((branch_token, repo_token)), '(remote tokens)')
2342
err_context = {'token': str((branch_token, repo_token))}
2343
response = self._call(
2344
'Branch.unlock', self._remote_path(), branch_token,
2345
repo_token or '', **err_context)
1420
2346
if response == ('ok',):
1422
2348
raise errors.UnexpectedSmartServerResponse(response)
1424
2350
def unlock(self):
1425
self._lock_count -= 1
1426
if not self._lock_count:
1427
self._clear_cached_state()
1428
mode = self._lock_mode
1429
self._lock_mode = None
1430
if self._real_branch is not None:
1431
if (not self._leave_lock and mode == 'w' and
1432
self._repo_lock_token):
1433
# If this RemoteBranch will remove the physical lock for the
1434
# repository, make sure the _real_branch doesn't do it
1435
# first. (Because the _real_branch's repository is set to
1436
# be the RemoteRepository.)
1437
self._real_branch.repository.leave_lock_in_place()
1438
self._real_branch.unlock()
1440
# Only write-locked branched need to make a remote method call
1441
# to perfom the unlock.
1443
if not self._lock_token:
1444
raise AssertionError('Locked, but no token!')
1445
branch_token = self._lock_token
1446
repo_token = self._repo_lock_token
1447
self._lock_token = None
1448
self._repo_lock_token = None
1449
if not self._leave_lock:
1450
self._unlock(branch_token, repo_token)
2352
self._lock_count -= 1
2353
if not self._lock_count:
2354
self._clear_cached_state()
2355
mode = self._lock_mode
2356
self._lock_mode = None
2357
if self._real_branch is not None:
2358
if (not self._leave_lock and mode == 'w' and
2359
self._repo_lock_token):
2360
# If this RemoteBranch will remove the physical lock
2361
# for the repository, make sure the _real_branch
2362
# doesn't do it first. (Because the _real_branch's
2363
# repository is set to be the RemoteRepository.)
2364
self._real_branch.repository.leave_lock_in_place()
2365
self._real_branch.unlock()
2367
# Only write-locked branched need to make a remote method
2368
# call to perform the unlock.
2370
if not self._lock_token:
2371
raise AssertionError('Locked, but no token!')
2372
branch_token = self._lock_token
2373
repo_token = self._repo_lock_token
2374
self._lock_token = None
2375
self._repo_lock_token = None
2376
if not self._leave_lock:
2377
self._unlock(branch_token, repo_token)
2379
self.repository.unlock()
1452
2381
def break_lock(self):
1453
2382
self._ensure_real()
2435
def _remote_path(self):
2436
return self.bzrdir._path_for_remote_call(self._client)
1487
2438
def _set_last_revision_descendant(self, revision_id, other_branch,
1488
2439
allow_diverged=False, allow_overwrite_descendant=False):
1489
path = self.bzrdir._path_for_remote_call(self._client)
1491
response = self._client.call('Branch.set_last_revision_ex',
1492
path, self._lock_token, self._repo_lock_token, revision_id,
1493
int(allow_diverged), int(allow_overwrite_descendant))
1494
except errors.ErrorFromSmartServer, err:
1495
if err.error_verb == 'NoSuchRevision':
1496
raise NoSuchRevision(self, revision_id)
1497
elif err.error_verb == 'Diverged':
1498
raise errors.DivergedBranches(self, other_branch)
2440
# This performs additional work to meet the hook contract; while its
2441
# undesirable, we have to synthesise the revno to call the hook, and
2442
# not calling the hook is worse as it means changes can't be prevented.
2443
# Having calculated this though, we can't just call into
2444
# set_last_revision_info as a simple call, because there is a set_rh
2445
# hook that some folk may still be using.
2446
old_revno, old_revid = self.last_revision_info()
2447
history = self._lefthand_history(revision_id)
2448
self._run_pre_change_branch_tip_hooks(len(history), revision_id)
2449
err_context = {'other_branch': other_branch}
2450
response = self._call('Branch.set_last_revision_ex',
2451
self._remote_path(), self._lock_token, self._repo_lock_token,
2452
revision_id, int(allow_diverged), int(allow_overwrite_descendant),
1500
2454
self._clear_cached_state()
1501
2455
if len(response) != 3 and response[0] != 'ok':
1502
2456
raise errors.UnexpectedSmartServerResponse(response)
1503
2457
new_revno, new_revision_id = response[1:]
1504
2458
self._last_revision_info_cache = new_revno, new_revision_id
1505
self._real_branch._last_revision_info_cache = new_revno, new_revision_id
2459
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2460
if self._real_branch is not None:
2461
cache = new_revno, new_revision_id
2462
self._real_branch._last_revision_info_cache = cache
1507
2464
def _set_last_revision(self, revision_id):
1508
path = self.bzrdir._path_for_remote_call(self._client)
2465
old_revno, old_revid = self.last_revision_info()
2466
# This performs additional work to meet the hook contract; while its
2467
# undesirable, we have to synthesise the revno to call the hook, and
2468
# not calling the hook is worse as it means changes can't be prevented.
2469
# Having calculated this though, we can't just call into
2470
# set_last_revision_info as a simple call, because there is a set_rh
2471
# hook that some folk may still be using.
2472
history = self._lefthand_history(revision_id)
2473
self._run_pre_change_branch_tip_hooks(len(history), revision_id)
1509
2474
self._clear_cached_state()
1511
response = self._client.call('Branch.set_last_revision',
1512
path, self._lock_token, self._repo_lock_token, revision_id)
1513
except errors.ErrorFromSmartServer, err:
1514
if err.error_verb == 'NoSuchRevision':
1515
raise NoSuchRevision(self, revision_id)
2475
response = self._call('Branch.set_last_revision',
2476
self._remote_path(), self._lock_token, self._repo_lock_token,
1517
2478
if response != ('ok',):
1518
2479
raise errors.UnexpectedSmartServerResponse(response)
2480
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1520
2482
@needs_write_lock
1521
2483
def set_revision_history(self, rev_history):
1528
2490
rev_id = rev_history[-1]
1529
2491
self._set_last_revision(rev_id)
2492
for hook in branch.Branch.hooks['set_rh']:
2493
hook(self, rev_history)
1530
2494
self._cache_revision_history(rev_history)
1532
def get_parent(self):
1534
return self._real_branch.get_parent()
1536
def set_parent(self, url):
1538
return self._real_branch.set_parent(url)
1540
def set_stacked_on(self, stacked_location):
1541
"""Set the URL this branch is stacked against.
1543
:raises UnstackableBranchFormat: If the branch does not support
1545
:raises UnstackableRepositoryFormat: If the repository does not support
1549
return self._real_branch.set_stacked_on(stacked_location)
1551
def sprout(self, to_bzrdir, revision_id=None):
1552
# Like Branch.sprout, except that it sprouts a branch in the default
1553
# format, because RemoteBranches can't be created at arbitrary URLs.
1554
# XXX: if to_bzrdir is a RemoteBranch, this should perhaps do
1555
# to_bzrdir.create_branch...
1557
result = self._real_branch._format.initialize(to_bzrdir)
1558
self.copy_content_into(result, revision_id=revision_id)
1559
result.set_parent(self.bzrdir.root_transport.base)
2496
def _get_parent_location(self):
2497
medium = self._client._medium
2498
if medium._is_remote_before((1, 13)):
2499
return self._vfs_get_parent_location()
2501
response = self._call('Branch.get_parent', self._remote_path())
2502
except errors.UnknownSmartMethod:
2503
medium._remember_remote_is_before((1, 13))
2504
return self._vfs_get_parent_location()
2505
if len(response) != 1:
2506
raise errors.UnexpectedSmartServerResponse(response)
2507
parent_location = response[0]
2508
if parent_location == '':
2510
return parent_location
2512
def _vfs_get_parent_location(self):
2514
return self._real_branch._get_parent_location()
2516
def _set_parent_location(self, url):
2517
medium = self._client._medium
2518
if medium._is_remote_before((1, 15)):
2519
return self._vfs_set_parent_location(url)
2521
call_url = url or ''
2522
if type(call_url) is not str:
2523
raise AssertionError('url must be a str or None (%s)' % url)
2524
response = self._call('Branch.set_parent_location',
2525
self._remote_path(), self._lock_token, self._repo_lock_token,
2527
except errors.UnknownSmartMethod:
2528
medium._remember_remote_is_before((1, 15))
2529
return self._vfs_set_parent_location(url)
2531
raise errors.UnexpectedSmartServerResponse(response)
2533
def _vfs_set_parent_location(self, url):
2535
return self._real_branch._set_parent_location(url)
1562
2537
@needs_write_lock
1563
2538
def pull(self, source, overwrite=False, stop_revision=None,
1617
2598
except errors.UnknownSmartMethod:
1618
2599
medium._remember_remote_is_before((1, 6))
1619
2600
self._clear_cached_state_of_remote_branch_only()
1621
self._real_branch.generate_revision_history(
1622
revision_id, last_rev=last_rev, other_branch=other_branch)
1627
return self._real_branch.tags
2601
self.set_revision_history(self._lefthand_history(revision_id,
2602
last_rev=last_rev,other_branch=other_branch))
1629
2604
def set_push_location(self, location):
1630
2605
self._ensure_real()
1631
2606
return self._real_branch.set_push_location(location)
1634
def update_revisions(self, other, stop_revision=None, overwrite=False,
1636
"""See Branch.update_revisions."""
2609
class RemoteConfig(object):
2610
"""A Config that reads and writes from smart verbs.
2612
It is a low-level object that considers config data to be name/value pairs
2613
that may be associated with a section. Assigning meaning to the these
2614
values is done at higher levels like bzrlib.config.TreeConfig.
2617
def get_option(self, name, section=None, default=None):
2618
"""Return the value associated with a named option.
2620
:param name: The name of the value
2621
:param section: The section the option is in (if any)
2622
:param default: The value to return if the value is not set
2623
:return: The value or default value
1639
if stop_revision is None:
1640
stop_revision = other.last_revision()
1641
if revision.is_null(stop_revision):
1642
# if there are no commits, we're done.
1644
self.fetch(other, stop_revision)
1647
# Just unconditionally set the new revision. We don't care if
1648
# the branches have diverged.
1649
self._set_last_revision(stop_revision)
2626
configobj = self._get_configobj()
2628
section_obj = configobj
1651
medium = self._client._medium
1652
if not medium._is_remote_before((1, 6)):
1654
self._set_last_revision_descendant(stop_revision, other)
1656
except errors.UnknownSmartMethod:
1657
medium._remember_remote_is_before((1, 6))
1658
# Fallback for pre-1.6 servers: check for divergence
1659
# client-side, then do _set_last_revision.
1660
last_rev = revision.ensure_null(self.last_revision())
1662
graph = self.repository.get_graph()
1663
if self._check_if_descendant_or_diverged(
1664
stop_revision, last_rev, graph, other):
1665
# stop_revision is a descendant of last_rev, but we aren't
1666
# overwriting, so we're done.
1668
self._set_last_revision(stop_revision)
2631
section_obj = configobj[section]
2634
return section_obj.get(name, default)
2635
except errors.UnknownSmartMethod:
2636
return self._vfs_get_option(name, section, default)
2638
def _response_to_configobj(self, response):
2639
if len(response[0]) and response[0][0] != 'ok':
2640
raise errors.UnexpectedSmartServerResponse(response)
2641
lines = response[1].read_body_bytes().splitlines()
2642
return config.ConfigObj(lines, encoding='utf-8')
2645
class RemoteBranchConfig(RemoteConfig):
2646
"""A RemoteConfig for Branches."""
2648
def __init__(self, branch):
2649
self._branch = branch
2651
def _get_configobj(self):
2652
path = self._branch._remote_path()
2653
response = self._branch._client.call_expecting_body(
2654
'Branch.get_config_file', path)
2655
return self._response_to_configobj(response)
2657
def set_option(self, value, name, section=None):
2658
"""Set the value associated with a named option.
2660
:param value: The value to set
2661
:param name: The name of the value to set
2662
:param section: The section the option is in (if any)
2664
medium = self._branch._client._medium
2665
if medium._is_remote_before((1, 14)):
2666
return self._vfs_set_option(value, name, section)
2668
path = self._branch._remote_path()
2669
response = self._branch._client.call('Branch.set_config_option',
2670
path, self._branch._lock_token, self._branch._repo_lock_token,
2671
value.encode('utf8'), name, section or '')
2672
except errors.UnknownSmartMethod:
2673
medium._remember_remote_is_before((1, 14))
2674
return self._vfs_set_option(value, name, section)
2676
raise errors.UnexpectedSmartServerResponse(response)
2678
def _real_object(self):
2679
self._branch._ensure_real()
2680
return self._branch._real_branch
2682
def _vfs_set_option(self, value, name, section=None):
2683
return self._real_object()._get_config().set_option(
2684
value, name, section)
2687
class RemoteBzrDirConfig(RemoteConfig):
2688
"""A RemoteConfig for BzrDirs."""
2690
def __init__(self, bzrdir):
2691
self._bzrdir = bzrdir
2693
def _get_configobj(self):
2694
medium = self._bzrdir._client._medium
2695
verb = 'BzrDir.get_config_file'
2696
if medium._is_remote_before((1, 15)):
2697
raise errors.UnknownSmartMethod(verb)
2698
path = self._bzrdir._path_for_remote_call(self._bzrdir._client)
2699
response = self._bzrdir._call_expecting_body(
2701
return self._response_to_configobj(response)
2703
def _vfs_get_option(self, name, section, default):
2704
return self._real_object()._get_config().get_option(
2705
name, section, default)
2707
def set_option(self, value, name, section=None):
2708
"""Set the value associated with a named option.
2710
:param value: The value to set
2711
:param name: The name of the value to set
2712
:param section: The section the option is in (if any)
2714
return self._real_object()._get_config().set_option(
2715
value, name, section)
2717
def _real_object(self):
2718
self._bzrdir._ensure_real()
2719
return self._bzrdir._real_bzrdir
1673
2723
def _extract_tar(tar, to_dir):
1678
2728
for tarinfo in tar:
1679
2729
tar.extract(tarinfo, to_dir)
2732
def _translate_error(err, **context):
2733
"""Translate an ErrorFromSmartServer into a more useful error.
2735
Possible context keys:
2743
If the error from the server doesn't match a known pattern, then
2744
UnknownErrorFromSmartServer is raised.
2748
return context[name]
2749
except KeyError, key_err:
2750
mutter('Missing key %r in context %r', key_err.args[0], context)
2753
"""Get the path from the context if present, otherwise use first error
2757
return context['path']
2758
except KeyError, key_err:
2760
return err.error_args[0]
2761
except IndexError, idx_err:
2763
'Missing key %r in context %r', key_err.args[0], context)
2766
if err.error_verb == 'IncompatibleRepositories':
2767
raise errors.IncompatibleRepositories(err.error_args[0],
2768
err.error_args[1], err.error_args[2])
2769
elif err.error_verb == 'NoSuchRevision':
2770
raise NoSuchRevision(find('branch'), err.error_args[0])
2771
elif err.error_verb == 'nosuchrevision':
2772
raise NoSuchRevision(find('repository'), err.error_args[0])
2773
elif err.error_tuple == ('nobranch',):
2774
raise errors.NotBranchError(path=find('bzrdir').root_transport.base)
2775
elif err.error_verb == 'norepository':
2776
raise errors.NoRepositoryPresent(find('bzrdir'))
2777
elif err.error_verb == 'LockContention':
2778
raise errors.LockContention('(remote lock)')
2779
elif err.error_verb == 'UnlockableTransport':
2780
raise errors.UnlockableTransport(find('bzrdir').root_transport)
2781
elif err.error_verb == 'LockFailed':
2782
raise errors.LockFailed(err.error_args[0], err.error_args[1])
2783
elif err.error_verb == 'TokenMismatch':
2784
raise errors.TokenMismatch(find('token'), '(remote token)')
2785
elif err.error_verb == 'Diverged':
2786
raise errors.DivergedBranches(find('branch'), find('other_branch'))
2787
elif err.error_verb == 'TipChangeRejected':
2788
raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
2789
elif err.error_verb == 'UnstackableBranchFormat':
2790
raise errors.UnstackableBranchFormat(*err.error_args)
2791
elif err.error_verb == 'UnstackableRepositoryFormat':
2792
raise errors.UnstackableRepositoryFormat(*err.error_args)
2793
elif err.error_verb == 'NotStacked':
2794
raise errors.NotStacked(branch=find('branch'))
2795
elif err.error_verb == 'PermissionDenied':
2797
if len(err.error_args) >= 2:
2798
extra = err.error_args[1]
2801
raise errors.PermissionDenied(path, extra=extra)
2802
elif err.error_verb == 'ReadError':
2804
raise errors.ReadError(path)
2805
elif err.error_verb == 'NoSuchFile':
2807
raise errors.NoSuchFile(path)
2808
elif err.error_verb == 'FileExists':
2809
raise errors.FileExists(err.error_args[0])
2810
elif err.error_verb == 'DirectoryNotEmpty':
2811
raise errors.DirectoryNotEmpty(err.error_args[0])
2812
elif err.error_verb == 'ShortReadvError':
2813
args = err.error_args
2814
raise errors.ShortReadvError(
2815
args[0], int(args[1]), int(args[2]), int(args[3]))
2816
elif err.error_verb in ('UnicodeEncodeError', 'UnicodeDecodeError'):
2817
encoding = str(err.error_args[0]) # encoding must always be a string
2818
val = err.error_args[1]
2819
start = int(err.error_args[2])
2820
end = int(err.error_args[3])
2821
reason = str(err.error_args[4]) # reason must always be a string
2822
if val.startswith('u:'):
2823
val = val[2:].decode('utf-8')
2824
elif val.startswith('s:'):
2825
val = val[2:].decode('base64')
2826
if err.error_verb == 'UnicodeDecodeError':
2827
raise UnicodeDecodeError(encoding, val, start, end, reason)
2828
elif err.error_verb == 'UnicodeEncodeError':
2829
raise UnicodeEncodeError(encoding, val, start, end, reason)
2830
elif err.error_verb == 'ReadOnlyError':
2831
raise errors.TransportNotPossible('readonly transport')
2832
raise errors.UnknownErrorFromSmartServer(err)
added
removed
bzrlib/remote.py
