1
# Copyright (C) 2006, 2007, 2008 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
# TODO: At some point, handle upgrades by just passing the whole request
18
# across to run on the server.
35
from bzrlib.branch import BranchReferenceFormat
36
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
37
from bzrlib.decorators import needs_read_lock, needs_write_lock
38
from bzrlib.errors import (
42
from bzrlib.lockable_files import LockableFiles
43
from bzrlib.smart import client, vfs, repository as smart_repo
44
from bzrlib.revision import ensure_null, NULL_REVISION
45
from bzrlib.trace import mutter, note, warning
46
from bzrlib.util import bencode
49
class _RpcHelper(object):
50
"""Mixin class that helps with issuing RPCs."""
52
def _call(self, method, *args, **err_context):
54
return self._client.call(method, *args)
55
except errors.ErrorFromSmartServer, err:
56
self._translate_error(err, **err_context)
58
def _call_expecting_body(self, method, *args, **err_context):
60
return self._client.call_expecting_body(method, *args)
61
except errors.ErrorFromSmartServer, err:
62
self._translate_error(err, **err_context)
64
def _call_with_body_bytes_expecting_body(self, method, args, body_bytes,
67
return self._client.call_with_body_bytes_expecting_body(
68
method, args, body_bytes)
69
except errors.ErrorFromSmartServer, err:
70
self._translate_error(err, **err_context)
73
def response_tuple_to_repo_format(response):
74
"""Convert a response tuple describing a repository format to a format."""
75
format = RemoteRepositoryFormat()
76
format._rich_root_data = (response[0] == 'yes')
77
format._supports_tree_reference = (response[1] == 'yes')
78
format._supports_external_lookups = (response[2] == 'yes')
79
format._network_name = response[3]
83
# Note: RemoteBzrDirFormat is in bzrdir.py
85
class RemoteBzrDir(BzrDir, _RpcHelper):
86
"""Control directory on a remote server, accessed via bzr:// or similar."""
88
def __init__(self, transport, format, _client=None):
89
"""Construct a RemoteBzrDir.
91
:param _client: Private parameter for testing. Disables probing and the
94
BzrDir.__init__(self, transport, format)
95
# this object holds a delegated bzrdir that uses file-level operations
96
# to talk to the other side
97
self._real_bzrdir = None
98
# 1-shot cache for the call pattern 'create_branch; open_branch' - see
99
# create_branch for details.
100
self._next_open_branch_result = None
103
medium = transport.get_smart_medium()
104
self._client = client._SmartClient(medium)
106
self._client = _client
109
path = self._path_for_remote_call(self._client)
110
response = self._call('BzrDir.open', path)
111
if response not in [('yes',), ('no',)]:
112
raise errors.UnexpectedSmartServerResponse(response)
113
if response == ('no',):
114
raise errors.NotBranchError(path=transport.base)
116
def _ensure_real(self):
117
"""Ensure that there is a _real_bzrdir set.
119
Used before calls to self._real_bzrdir.
121
if not self._real_bzrdir:
122
self._real_bzrdir = BzrDir.open_from_transport(
123
self.root_transport, _server_formats=False)
124
self._format._network_name = \
125
self._real_bzrdir._format.network_name()
127
def _translate_error(self, err, **context):
128
_translate_error(err, bzrdir=self, **context)
130
def break_lock(self):
131
# Prevent aliasing problems in the next_open_branch_result cache.
132
# See create_branch for rationale.
133
self._next_open_branch_result = None
134
return BzrDir.break_lock(self)
136
def _vfs_cloning_metadir(self, require_stacking=False):
138
return self._real_bzrdir.cloning_metadir(
139
require_stacking=require_stacking)
141
def cloning_metadir(self, require_stacking=False):
142
medium = self._client._medium
143
if medium._is_remote_before((1, 13)):
144
return self._vfs_cloning_metadir(require_stacking=require_stacking)
145
verb = 'BzrDir.cloning_metadir'
150
path = self._path_for_remote_call(self._client)
152
response = self._call(verb, path, stacking)
153
except errors.UnknownSmartMethod:
154
medium._remember_remote_is_before((1, 13))
155
return self._vfs_cloning_metadir(require_stacking=require_stacking)
156
if len(response) != 3:
157
raise errors.UnexpectedSmartServerResponse(response)
158
control_name, repo_name, branch_info = response
159
if len(branch_info) != 2:
160
raise errors.UnexpectedSmartServerResponse(response)
161
branch_ref, branch_name = branch_info
162
format = bzrdir.network_format_registry.get(control_name)
164
format.repository_format = repository.network_format_registry.get(
166
if branch_ref == 'ref':
167
# XXX: we need possible_transports here to avoid reopening the
168
# connection to the referenced location
169
ref_bzrdir = BzrDir.open(branch_name)
170
branch_format = ref_bzrdir.cloning_metadir().get_branch_format()
171
format.set_branch_format(branch_format)
172
elif branch_ref == 'branch':
174
format.set_branch_format(
175
branch.network_format_registry.get(branch_name))
177
raise errors.UnexpectedSmartServerResponse(response)
180
def create_repository(self, shared=False):
181
# as per meta1 formats - just delegate to the format object which may
183
result = self._format.repository_format.initialize(self, shared)
184
if not isinstance(result, RemoteRepository):
185
return self.open_repository()
189
def destroy_repository(self):
190
"""See BzrDir.destroy_repository"""
192
self._real_bzrdir.destroy_repository()
194
def create_branch(self):
195
# as per meta1 formats - just delegate to the format object which may
197
real_branch = self._format.get_branch_format().initialize(self)
198
if not isinstance(real_branch, RemoteBranch):
199
result = RemoteBranch(self, self.find_repository(), real_branch)
202
# BzrDir.clone_on_transport() uses the result of create_branch but does
203
# not return it to its callers; we save approximately 8% of our round
204
# trips by handing the branch we created back to the first caller to
205
# open_branch rather than probing anew. Long term we need a API in
206
# bzrdir that doesn't discard result objects (like result_branch).
208
self._next_open_branch_result = result
211
def destroy_branch(self):
212
"""See BzrDir.destroy_branch"""
214
self._real_bzrdir.destroy_branch()
215
self._next_open_branch_result = None
217
def create_workingtree(self, revision_id=None, from_branch=None):
218
raise errors.NotLocalUrl(self.transport.base)
220
def find_branch_format(self):
221
"""Find the branch 'format' for this bzrdir.
223
This might be a synthetic object for e.g. RemoteBranch and SVN.
225
b = self.open_branch()
228
def get_branch_reference(self):
229
"""See BzrDir.get_branch_reference()."""
230
response = self._get_branch_reference()
231
if response[0] == 'ref':
236
def _get_branch_reference(self):
237
path = self._path_for_remote_call(self._client)
238
medium = self._client._medium
239
if not medium._is_remote_before((1, 13)):
241
response = self._call('BzrDir.open_branchV2', path)
242
if response[0] not in ('ref', 'branch'):
243
raise errors.UnexpectedSmartServerResponse(response)
245
except errors.UnknownSmartMethod:
246
medium._remember_remote_is_before((1, 13))
247
response = self._call('BzrDir.open_branch', path)
248
if response[0] != 'ok':
249
raise errors.UnexpectedSmartServerResponse(response)
250
if response[1] != '':
251
return ('ref', response[1])
253
return ('branch', '')
255
def _get_tree_branch(self):
256
"""See BzrDir._get_tree_branch()."""
257
return None, self.open_branch()
259
def open_branch(self, _unsupported=False):
261
raise NotImplementedError('unsupported flag support not implemented yet.')
262
if self._next_open_branch_result is not None:
263
# See create_branch for details.
264
result = self._next_open_branch_result
265
self._next_open_branch_result = None
267
response = self._get_branch_reference()
268
if response[0] == 'ref':
269
# a branch reference, use the existing BranchReference logic.
270
format = BranchReferenceFormat()
271
return format.open(self, _found=True, location=response[1])
272
branch_format_name = response[1]
273
if not branch_format_name:
274
branch_format_name = None
275
format = RemoteBranchFormat(network_name=branch_format_name)
276
return RemoteBranch(self, self.find_repository(), format=format)
278
def _open_repo_v1(self, path):
279
verb = 'BzrDir.find_repository'
280
response = self._call(verb, path)
281
if response[0] != 'ok':
282
raise errors.UnexpectedSmartServerResponse(response)
283
# servers that only support the v1 method don't support external
286
repo = self._real_bzrdir.open_repository()
287
response = response + ('no', repo._format.network_name())
288
return response, repo
290
def _open_repo_v2(self, path):
291
verb = 'BzrDir.find_repositoryV2'
292
response = self._call(verb, path)
293
if response[0] != 'ok':
294
raise errors.UnexpectedSmartServerResponse(response)
296
repo = self._real_bzrdir.open_repository()
297
response = response + (repo._format.network_name(),)
298
return response, repo
300
def _open_repo_v3(self, path):
301
verb = 'BzrDir.find_repositoryV3'
302
medium = self._client._medium
303
if medium._is_remote_before((1, 13)):
304
raise errors.UnknownSmartMethod(verb)
306
response = self._call(verb, path)
307
except errors.UnknownSmartMethod:
308
medium._remember_remote_is_before((1, 13))
310
if response[0] != 'ok':
311
raise errors.UnexpectedSmartServerResponse(response)
312
return response, None
314
def open_repository(self):
315
path = self._path_for_remote_call(self._client)
317
for probe in [self._open_repo_v3, self._open_repo_v2,
320
response, real_repo = probe(path)
322
except errors.UnknownSmartMethod:
325
raise errors.UnknownSmartMethod('BzrDir.find_repository{3,2,}')
326
if response[0] != 'ok':
327
raise errors.UnexpectedSmartServerResponse(response)
328
if len(response) != 6:
329
raise SmartProtocolError('incorrect response length %s' % (response,))
330
if response[1] == '':
331
# repo is at this dir.
332
format = response_tuple_to_repo_format(response[2:])
333
# Used to support creating a real format instance when needed.
334
format._creating_bzrdir = self
335
remote_repo = RemoteRepository(self, format)
336
format._creating_repo = remote_repo
337
if real_repo is not None:
338
remote_repo._set_real_repository(real_repo)
341
raise errors.NoRepositoryPresent(self)
343
def open_workingtree(self, recommend_upgrade=True):
345
if self._real_bzrdir.has_workingtree():
346
raise errors.NotLocalUrl(self.root_transport)
348
raise errors.NoWorkingTree(self.root_transport.base)
350
def _path_for_remote_call(self, client):
351
"""Return the path to be used for this bzrdir in a remote call."""
352
return client.remote_path_from_transport(self.root_transport)
354
def get_branch_transport(self, branch_format):
356
return self._real_bzrdir.get_branch_transport(branch_format)
358
def get_repository_transport(self, repository_format):
360
return self._real_bzrdir.get_repository_transport(repository_format)
362
def get_workingtree_transport(self, workingtree_format):
364
return self._real_bzrdir.get_workingtree_transport(workingtree_format)
366
def can_convert_format(self):
367
"""Upgrading of remote bzrdirs is not supported yet."""
370
def needs_format_conversion(self, format=None):
371
"""Upgrading of remote bzrdirs is not supported yet."""
373
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
374
% 'needs_format_conversion(format=None)')
377
def clone(self, url, revision_id=None, force_new_repo=False,
378
preserve_stacking=False):
380
return self._real_bzrdir.clone(url, revision_id=revision_id,
381
force_new_repo=force_new_repo, preserve_stacking=preserve_stacking)
383
def get_config(self):
385
return self._real_bzrdir.get_config()
388
class RemoteRepositoryFormat(repository.RepositoryFormat):
389
"""Format for repositories accessed over a _SmartClient.
391
Instances of this repository are represented by RemoteRepository
394
The RemoteRepositoryFormat is parameterized during construction
395
to reflect the capabilities of the real, remote format. Specifically
396
the attributes rich_root_data and supports_tree_reference are set
397
on a per instance basis, and are not set (and should not be) at
400
:ivar _custom_format: If set, a specific concrete repository format that
401
will be used when initializing a repository with this
402
RemoteRepositoryFormat.
403
:ivar _creating_repo: If set, the repository object that this
404
RemoteRepositoryFormat was created for: it can be called into
405
to obtain data like the network name.
408
_matchingbzrdir = RemoteBzrDirFormat()
411
repository.RepositoryFormat.__init__(self)
412
self._custom_format = None
413
self._network_name = None
414
self._creating_bzrdir = None
415
self._supports_external_lookups = None
416
self._supports_tree_reference = None
417
self._rich_root_data = None
420
def fast_deltas(self):
422
return self._custom_format.fast_deltas
425
def rich_root_data(self):
426
if self._rich_root_data is None:
428
self._rich_root_data = self._custom_format.rich_root_data
429
return self._rich_root_data
432
def supports_external_lookups(self):
433
if self._supports_external_lookups is None:
435
self._supports_external_lookups = \
436
self._custom_format.supports_external_lookups
437
return self._supports_external_lookups
440
def supports_tree_reference(self):
441
if self._supports_tree_reference is None:
443
self._supports_tree_reference = \
444
self._custom_format.supports_tree_reference
445
return self._supports_tree_reference
447
def _vfs_initialize(self, a_bzrdir, shared):
448
"""Helper for common code in initialize."""
449
if self._custom_format:
450
# Custom format requested
451
result = self._custom_format.initialize(a_bzrdir, shared=shared)
452
elif self._creating_bzrdir is not None:
453
# Use the format that the repository we were created to back
455
prior_repo = self._creating_bzrdir.open_repository()
456
prior_repo._ensure_real()
457
result = prior_repo._real_repository._format.initialize(
458
a_bzrdir, shared=shared)
460
# assume that a_bzr is a RemoteBzrDir but the smart server didn't
461
# support remote initialization.
462
# We delegate to a real object at this point (as RemoteBzrDir
463
# delegate to the repository format which would lead to infinite
464
# recursion if we just called a_bzrdir.create_repository.
465
a_bzrdir._ensure_real()
466
result = a_bzrdir._real_bzrdir.create_repository(shared=shared)
467
if not isinstance(result, RemoteRepository):
468
return self.open(a_bzrdir)
472
def initialize(self, a_bzrdir, shared=False):
473
# Being asked to create on a non RemoteBzrDir:
474
if not isinstance(a_bzrdir, RemoteBzrDir):
475
return self._vfs_initialize(a_bzrdir, shared)
476
medium = a_bzrdir._client._medium
477
if medium._is_remote_before((1, 13)):
478
return self._vfs_initialize(a_bzrdir, shared)
479
# Creating on a remote bzr dir.
480
# 1) get the network name to use.
481
if self._custom_format:
482
network_name = self._custom_format.network_name()
484
# Select the current bzrlib default and ask for that.
485
reference_bzrdir_format = bzrdir.format_registry.get('default')()
486
reference_format = reference_bzrdir_format.repository_format
487
network_name = reference_format.network_name()
488
# 2) try direct creation via RPC
489
path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
490
verb = 'BzrDir.create_repository'
496
response = a_bzrdir._call(verb, path, network_name, shared_str)
497
except errors.UnknownSmartMethod:
498
# Fallback - use vfs methods
499
medium._remember_remote_is_before((1, 13))
500
return self._vfs_initialize(a_bzrdir, shared)
502
# Turn the response into a RemoteRepository object.
503
format = response_tuple_to_repo_format(response[1:])
504
# Used to support creating a real format instance when needed.
505
format._creating_bzrdir = a_bzrdir
506
remote_repo = RemoteRepository(a_bzrdir, format)
507
format._creating_repo = remote_repo
510
def open(self, a_bzrdir):
511
if not isinstance(a_bzrdir, RemoteBzrDir):
512
raise AssertionError('%r is not a RemoteBzrDir' % (a_bzrdir,))
513
return a_bzrdir.open_repository()
515
def _ensure_real(self):
516
if self._custom_format is None:
517
self._custom_format = repository.network_format_registry.get(
521
def _fetch_order(self):
523
return self._custom_format._fetch_order
526
def _fetch_uses_deltas(self):
528
return self._custom_format._fetch_uses_deltas
531
def _fetch_reconcile(self):
533
return self._custom_format._fetch_reconcile
535
def get_format_description(self):
536
return 'bzr remote repository'
538
def __eq__(self, other):
539
return self.__class__ is other.__class__
541
def check_conversion_target(self, target_format):
542
if self.rich_root_data and not target_format.rich_root_data:
543
raise errors.BadConversionTarget(
544
'Does not support rich root data.', target_format)
545
if (self.supports_tree_reference and
546
not getattr(target_format, 'supports_tree_reference', False)):
547
raise errors.BadConversionTarget(
548
'Does not support nested trees', target_format)
550
def network_name(self):
551
if self._network_name:
552
return self._network_name
553
self._creating_repo._ensure_real()
554
return self._creating_repo._real_repository._format.network_name()
557
def _serializer(self):
559
return self._custom_format._serializer
562
class RemoteRepository(_RpcHelper):
563
"""Repository accessed over rpc.
565
For the moment most operations are performed using local transport-backed
569
def __init__(self, remote_bzrdir, format, real_repository=None, _client=None):
570
"""Create a RemoteRepository instance.
572
:param remote_bzrdir: The bzrdir hosting this repository.
573
:param format: The RemoteFormat object to use.
574
:param real_repository: If not None, a local implementation of the
575
repository logic for the repository, usually accessing the data
577
:param _client: Private testing parameter - override the smart client
578
to be used by the repository.
581
self._real_repository = real_repository
583
self._real_repository = None
584
self.bzrdir = remote_bzrdir
586
self._client = remote_bzrdir._client
588
self._client = _client
589
self._format = format
590
self._lock_mode = None
591
self._lock_token = None
593
self._leave_lock = False
594
self._unstacked_provider = graph.CachingParentsProvider(
595
get_parent_map=self._get_parent_map_rpc)
596
self._unstacked_provider.disable_cache()
598
# These depend on the actual remote format, so force them off for
599
# maximum compatibility. XXX: In future these should depend on the
600
# remote repository instance, but this is irrelevant until we perform
601
# reconcile via an RPC call.
602
self._reconcile_does_inventory_gc = False
603
self._reconcile_fixes_text_parents = False
604
self._reconcile_backsup_inventory = False
605
self.base = self.bzrdir.transport.base
606
# Additional places to query for data.
607
self._fallback_repositories = []
610
return "%s(%s)" % (self.__class__.__name__, self.base)
614
def abort_write_group(self, suppress_errors=False):
615
"""Complete a write group on the decorated repository.
617
Smart methods peform operations in a single step so this api
618
is not really applicable except as a compatibility thunk
619
for older plugins that don't use e.g. the CommitBuilder
622
:param suppress_errors: see Repository.abort_write_group.
625
return self._real_repository.abort_write_group(
626
suppress_errors=suppress_errors)
628
def commit_write_group(self):
629
"""Complete a write group on the decorated repository.
631
Smart methods peform operations in a single step so this api
632
is not really applicable except as a compatibility thunk
633
for older plugins that don't use e.g. the CommitBuilder
637
return self._real_repository.commit_write_group()
639
def resume_write_group(self, tokens):
641
return self._real_repository.resume_write_group(tokens)
643
def suspend_write_group(self):
645
return self._real_repository.suspend_write_group()
647
def _ensure_real(self):
648
"""Ensure that there is a _real_repository set.
650
Used before calls to self._real_repository.
652
Note that _ensure_real causes many roundtrips to the server which are
653
not desirable, and prevents the use of smart one-roundtrip RPC's to
654
perform complex operations (such as accessing parent data, streaming
655
revisions etc). Adding calls to _ensure_real should only be done when
656
bringing up new functionality, adding fallbacks for smart methods that
657
require a fallback path, and never to replace an existing smart method
658
invocation. If in doubt chat to the bzr network team.
660
if self._real_repository is None:
661
self.bzrdir._ensure_real()
662
self._set_real_repository(
663
self.bzrdir._real_bzrdir.open_repository())
665
def _translate_error(self, err, **context):
666
self.bzrdir._translate_error(err, repository=self, **context)
668
def find_text_key_references(self):
669
"""Find the text key references within the repository.
671
:return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
672
revision_ids. Each altered file-ids has the exact revision_ids that
673
altered it listed explicitly.
674
:return: A dictionary mapping text keys ((fileid, revision_id) tuples)
675
to whether they were referred to by the inventory of the
676
revision_id that they contain. The inventory texts from all present
677
revision ids are assessed to generate this report.
680
return self._real_repository.find_text_key_references()
682
def _generate_text_key_index(self):
683
"""Generate a new text key index for the repository.
685
This is an expensive function that will take considerable time to run.
687
:return: A dict mapping (file_id, revision_id) tuples to a list of
688
parents, also (file_id, revision_id) tuples.
691
return self._real_repository._generate_text_key_index()
693
def _get_revision_graph(self, revision_id):
694
"""Private method for using with old (< 1.2) servers to fallback."""
695
if revision_id is None:
697
elif revision.is_null(revision_id):
700
path = self.bzrdir._path_for_remote_call(self._client)
701
response = self._call_expecting_body(
702
'Repository.get_revision_graph', path, revision_id)
703
response_tuple, response_handler = response
704
if response_tuple[0] != 'ok':
705
raise errors.UnexpectedSmartServerResponse(response_tuple)
706
coded = response_handler.read_body_bytes()
708
# no revisions in this repository!
710
lines = coded.split('\n')
713
d = tuple(line.split())
714
revision_graph[d[0]] = d[1:]
716
return revision_graph
719
"""See Repository._get_sink()."""
720
return RemoteStreamSink(self)
722
def _get_source(self, to_format):
723
"""Return a source for streaming from this repository."""
724
return RemoteStreamSource(self, to_format)
726
def has_revision(self, revision_id):
727
"""See Repository.has_revision()."""
728
if revision_id == NULL_REVISION:
729
# The null revision is always present.
731
path = self.bzrdir._path_for_remote_call(self._client)
732
response = self._call('Repository.has_revision', path, revision_id)
733
if response[0] not in ('yes', 'no'):
734
raise errors.UnexpectedSmartServerResponse(response)
735
if response[0] == 'yes':
737
for fallback_repo in self._fallback_repositories:
738
if fallback_repo.has_revision(revision_id):
742
def has_revisions(self, revision_ids):
743
"""See Repository.has_revisions()."""
744
# FIXME: This does many roundtrips, particularly when there are
745
# fallback repositories. -- mbp 20080905
747
for revision_id in revision_ids:
748
if self.has_revision(revision_id):
749
result.add(revision_id)
752
def has_same_location(self, other):
753
return (self.__class__ is other.__class__ and
754
self.bzrdir.transport.base == other.bzrdir.transport.base)
756
def get_graph(self, other_repository=None):
757
"""Return the graph for this repository format"""
758
parents_provider = self._make_parents_provider(other_repository)
759
return graph.Graph(parents_provider)
761
def gather_stats(self, revid=None, committers=None):
762
"""See Repository.gather_stats()."""
763
path = self.bzrdir._path_for_remote_call(self._client)
764
# revid can be None to indicate no revisions, not just NULL_REVISION
765
if revid is None or revision.is_null(revid):
769
if committers is None or not committers:
770
fmt_committers = 'no'
772
fmt_committers = 'yes'
773
response_tuple, response_handler = self._call_expecting_body(
774
'Repository.gather_stats', path, fmt_revid, fmt_committers)
775
if response_tuple[0] != 'ok':
776
raise errors.UnexpectedSmartServerResponse(response_tuple)
778
body = response_handler.read_body_bytes()
780
for line in body.split('\n'):
783
key, val_text = line.split(':')
784
if key in ('revisions', 'size', 'committers'):
785
result[key] = int(val_text)
786
elif key in ('firstrev', 'latestrev'):
787
values = val_text.split(' ')[1:]
788
result[key] = (float(values[0]), long(values[1]))
792
def find_branches(self, using=False):
793
"""See Repository.find_branches()."""
794
# should be an API call to the server.
796
return self._real_repository.find_branches(using=using)
798
def get_physical_lock_status(self):
799
"""See Repository.get_physical_lock_status()."""
800
# should be an API call to the server.
802
return self._real_repository.get_physical_lock_status()
804
def is_in_write_group(self):
805
"""Return True if there is an open write group.
807
write groups are only applicable locally for the smart server..
809
if self._real_repository:
810
return self._real_repository.is_in_write_group()
813
return self._lock_count >= 1
816
"""See Repository.is_shared()."""
817
path = self.bzrdir._path_for_remote_call(self._client)
818
response = self._call('Repository.is_shared', path)
819
if response[0] not in ('yes', 'no'):
820
raise SmartProtocolError('unexpected response code %s' % (response,))
821
return response[0] == 'yes'
823
def is_write_locked(self):
824
return self._lock_mode == 'w'
827
# wrong eventually - want a local lock cache context
828
if not self._lock_mode:
829
self._lock_mode = 'r'
831
self._unstacked_provider.enable_cache(cache_misses=False)
832
if self._real_repository is not None:
833
self._real_repository.lock_read()
835
self._lock_count += 1
837
def _remote_lock_write(self, token):
838
path = self.bzrdir._path_for_remote_call(self._client)
841
err_context = {'token': token}
842
response = self._call('Repository.lock_write', path, token,
844
if response[0] == 'ok':
848
raise errors.UnexpectedSmartServerResponse(response)
850
def lock_write(self, token=None, _skip_rpc=False):
851
if not self._lock_mode:
853
if self._lock_token is not None:
854
if token != self._lock_token:
855
raise errors.TokenMismatch(token, self._lock_token)
856
self._lock_token = token
858
self._lock_token = self._remote_lock_write(token)
859
# if self._lock_token is None, then this is something like packs or
860
# svn where we don't get to lock the repo, or a weave style repository
861
# where we cannot lock it over the wire and attempts to do so will
863
if self._real_repository is not None:
864
self._real_repository.lock_write(token=self._lock_token)
865
if token is not None:
866
self._leave_lock = True
868
self._leave_lock = False
869
self._lock_mode = 'w'
871
self._unstacked_provider.enable_cache(cache_misses=False)
872
elif self._lock_mode == 'r':
873
raise errors.ReadOnlyError(self)
875
self._lock_count += 1
876
return self._lock_token or None
878
def leave_lock_in_place(self):
879
if not self._lock_token:
880
raise NotImplementedError(self.leave_lock_in_place)
881
self._leave_lock = True
883
def dont_leave_lock_in_place(self):
884
if not self._lock_token:
885
raise NotImplementedError(self.dont_leave_lock_in_place)
886
self._leave_lock = False
888
def _set_real_repository(self, repository):
889
"""Set the _real_repository for this repository.
891
:param repository: The repository to fallback to for non-hpss
892
implemented operations.
894
if self._real_repository is not None:
895
# Replacing an already set real repository.
896
# We cannot do this [currently] if the repository is locked -
897
# synchronised state might be lost.
899
raise AssertionError('_real_repository is already set')
900
if isinstance(repository, RemoteRepository):
901
raise AssertionError()
902
self._real_repository = repository
903
# If the _real_repository has _fallback_repositories, clear them out,
904
# because we want it to have the same set as this repository. This is
905
# reasonable to do because the fallbacks we clear here are from a
906
# "real" branch, and we're about to replace them with the equivalents
907
# from a RemoteBranch.
908
self._real_repository._fallback_repositories = []
909
for fb in self._fallback_repositories:
910
self._real_repository.add_fallback_repository(fb)
911
if self._lock_mode == 'w':
912
# if we are already locked, the real repository must be able to
913
# acquire the lock with our token.
914
self._real_repository.lock_write(self._lock_token)
915
elif self._lock_mode == 'r':
916
self._real_repository.lock_read()
918
def start_write_group(self):
919
"""Start a write group on the decorated repository.
921
Smart methods peform operations in a single step so this api
922
is not really applicable except as a compatibility thunk
923
for older plugins that don't use e.g. the CommitBuilder
927
return self._real_repository.start_write_group()
929
def _unlock(self, token):
930
path = self.bzrdir._path_for_remote_call(self._client)
932
# with no token the remote repository is not persistently locked.
934
err_context = {'token': token}
935
response = self._call('Repository.unlock', path, token,
937
if response == ('ok',):
940
raise errors.UnexpectedSmartServerResponse(response)
943
if not self._lock_count:
944
raise errors.LockNotHeld(self)
945
self._lock_count -= 1
946
if self._lock_count > 0:
948
self._unstacked_provider.disable_cache()
949
old_mode = self._lock_mode
950
self._lock_mode = None
952
# The real repository is responsible at present for raising an
953
# exception if it's in an unfinished write group. However, it
954
# normally will *not* actually remove the lock from disk - that's
955
# done by the server on receiving the Repository.unlock call.
956
# This is just to let the _real_repository stay up to date.
957
if self._real_repository is not None:
958
self._real_repository.unlock()
960
# The rpc-level lock should be released even if there was a
961
# problem releasing the vfs-based lock.
963
# Only write-locked repositories need to make a remote method
964
# call to perfom the unlock.
965
old_token = self._lock_token
966
self._lock_token = None
967
if not self._leave_lock:
968
self._unlock(old_token)
970
def break_lock(self):
971
# should hand off to the network
973
return self._real_repository.break_lock()
975
def _get_tarball(self, compression):
976
"""Return a TemporaryFile containing a repository tarball.
978
Returns None if the server does not support sending tarballs.
981
path = self.bzrdir._path_for_remote_call(self._client)
983
response, protocol = self._call_expecting_body(
984
'Repository.tarball', path, compression)
985
except errors.UnknownSmartMethod:
986
protocol.cancel_read_body()
988
if response[0] == 'ok':
989
# Extract the tarball and return it
990
t = tempfile.NamedTemporaryFile()
991
# TODO: rpc layer should read directly into it...
992
t.write(protocol.read_body_bytes())
995
raise errors.UnexpectedSmartServerResponse(response)
997
def sprout(self, to_bzrdir, revision_id=None):
998
# TODO: Option to control what format is created?
1000
dest_repo = self._real_repository._format.initialize(to_bzrdir,
1002
dest_repo.fetch(self, revision_id=revision_id)
1005
### These methods are just thin shims to the VFS object for now.
1007
def revision_tree(self, revision_id):
1009
return self._real_repository.revision_tree(revision_id)
1011
def get_serializer_format(self):
1013
return self._real_repository.get_serializer_format()
1015
def get_commit_builder(self, branch, parents, config, timestamp=None,
1016
timezone=None, committer=None, revprops=None,
1018
# FIXME: It ought to be possible to call this without immediately
1019
# triggering _ensure_real. For now it's the easiest thing to do.
1021
real_repo = self._real_repository
1022
builder = real_repo.get_commit_builder(branch, parents,
1023
config, timestamp=timestamp, timezone=timezone,
1024
committer=committer, revprops=revprops, revision_id=revision_id)
1027
def add_fallback_repository(self, repository):
1028
"""Add a repository to use for looking up data not held locally.
1030
:param repository: A repository.
1032
if not self._format.supports_external_lookups:
1033
raise errors.UnstackableRepositoryFormat(
1034
self._format.network_name(), self.base)
1035
# We need to accumulate additional repositories here, to pass them in
1038
self._fallback_repositories.append(repository)
1039
# If self._real_repository was parameterised already (e.g. because a
1040
# _real_branch had its get_stacked_on_url method called), then the
1041
# repository to be added may already be in the _real_repositories list.
1042
if self._real_repository is not None:
1043
if repository not in self._real_repository._fallback_repositories:
1044
self._real_repository.add_fallback_repository(repository)
1046
# They are also seen by the fallback repository. If it doesn't
1047
# exist yet they'll be added then. This implicitly copies them.
1050
def add_inventory(self, revid, inv, parents):
1052
return self._real_repository.add_inventory(revid, inv, parents)
1054
def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1057
return self._real_repository.add_inventory_by_delta(basis_revision_id,
1058
delta, new_revision_id, parents)
1060
def add_revision(self, rev_id, rev, inv=None, config=None):
1062
return self._real_repository.add_revision(
1063
rev_id, rev, inv=inv, config=config)
1066
def get_inventory(self, revision_id):
1068
return self._real_repository.get_inventory(revision_id)
1070
def iter_inventories(self, revision_ids):
1072
return self._real_repository.iter_inventories(revision_ids)
1075
def get_revision(self, revision_id):
1077
return self._real_repository.get_revision(revision_id)
1079
def get_transaction(self):
1081
return self._real_repository.get_transaction()
1084
def clone(self, a_bzrdir, revision_id=None):
1086
return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
1088
def make_working_trees(self):
1089
"""See Repository.make_working_trees"""
1091
return self._real_repository.make_working_trees()
1093
def refresh_data(self):
1094
"""Re-read any data needed to to synchronise with disk.
1096
This method is intended to be called after another repository instance
1097
(such as one used by a smart server) has inserted data into the
1098
repository. It may not be called during a write group, but may be
1099
called at any other time.
1101
if self.is_in_write_group():
1102
raise errors.InternalBzrError(
1103
"May not refresh_data while in a write group.")
1104
if self._real_repository is not None:
1105
self._real_repository.refresh_data()
1107
def revision_ids_to_search_result(self, result_set):
1108
"""Convert a set of revision ids to a graph SearchResult."""
1109
result_parents = set()
1110
for parents in self.get_graph().get_parent_map(
1111
result_set).itervalues():
1112
result_parents.update(parents)
1113
included_keys = result_set.intersection(result_parents)
1114
start_keys = result_set.difference(included_keys)
1115
exclude_keys = result_parents.difference(result_set)
1116
result = graph.SearchResult(start_keys, exclude_keys,
1117
len(result_set), result_set)
1121
def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1122
"""Return the revision ids that other has that this does not.
1124
These are returned in topological order.
1126
revision_id: only return revision ids included by revision_id.
1128
return repository.InterRepository.get(
1129
other, self).search_missing_revision_ids(revision_id, find_ghosts)
1131
def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
1133
# No base implementation to use as RemoteRepository is not a subclass
1134
# of Repository; so this is a copy of Repository.fetch().
1135
if fetch_spec is not None and revision_id is not None:
1136
raise AssertionError(
1137
"fetch_spec and revision_id are mutually exclusive.")
1138
if self.is_in_write_group():
1139
raise errors.InternalBzrError(
1140
"May not fetch while in a write group.")
1141
# fast path same-url fetch operations
1142
if self.has_same_location(source) and fetch_spec is None:
1143
# check that last_revision is in 'from' and then return a
1145
if (revision_id is not None and
1146
not revision.is_null(revision_id)):
1147
self.get_revision(revision_id)
1149
# if there is no specific appropriate InterRepository, this will get
1150
# the InterRepository base class, which raises an
1151
# IncompatibleRepositories when asked to fetch.
1152
inter = repository.InterRepository.get(source, self)
1153
return inter.fetch(revision_id=revision_id, pb=pb,
1154
find_ghosts=find_ghosts, fetch_spec=fetch_spec)
1156
def create_bundle(self, target, base, fileobj, format=None):
1158
self._real_repository.create_bundle(target, base, fileobj, format)
1161
def get_ancestry(self, revision_id, topo_sorted=True):
1163
return self._real_repository.get_ancestry(revision_id, topo_sorted)
1165
def fileids_altered_by_revision_ids(self, revision_ids):
1167
return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
1169
def _get_versioned_file_checker(self, revisions, revision_versions_cache):
1171
return self._real_repository._get_versioned_file_checker(
1172
revisions, revision_versions_cache)
1174
def iter_files_bytes(self, desired_files):
1175
"""See Repository.iter_file_bytes.
1178
return self._real_repository.iter_files_bytes(desired_files)
1180
def get_parent_map(self, revision_ids):
1181
"""See bzrlib.Graph.get_parent_map()."""
1182
return self._make_parents_provider().get_parent_map(revision_ids)
1184
def _get_parent_map_rpc(self, keys):
1185
"""Helper for get_parent_map that performs the RPC."""
1186
medium = self._client._medium
1187
if medium._is_remote_before((1, 2)):
1188
# We already found out that the server can't understand
1189
# Repository.get_parent_map requests, so just fetch the whole
1192
# Note that this reads the whole graph, when only some keys are
1193
# wanted. On this old server there's no way (?) to get them all
1194
# in one go, and the user probably will have seen a warning about
1195
# the server being old anyhow.
1196
rg = self._get_revision_graph(None)
1197
# There is an api discrepency between get_parent_map and
1198
# get_revision_graph. Specifically, a "key:()" pair in
1199
# get_revision_graph just means a node has no parents. For
1200
# "get_parent_map" it means the node is a ghost. So fix up the
1201
# graph to correct this.
1202
# https://bugs.launchpad.net/bzr/+bug/214894
1203
# There is one other "bug" which is that ghosts in
1204
# get_revision_graph() are not returned at all. But we won't worry
1205
# about that for now.
1206
for node_id, parent_ids in rg.iteritems():
1207
if parent_ids == ():
1208
rg[node_id] = (NULL_REVISION,)
1209
rg[NULL_REVISION] = ()
1214
raise ValueError('get_parent_map(None) is not valid')
1215
if NULL_REVISION in keys:
1216
keys.discard(NULL_REVISION)
1217
found_parents = {NULL_REVISION:()}
1219
return found_parents
1222
# TODO(Needs analysis): We could assume that the keys being requested
1223
# from get_parent_map are in a breadth first search, so typically they
1224
# will all be depth N from some common parent, and we don't have to
1225
# have the server iterate from the root parent, but rather from the
1226
# keys we're searching; and just tell the server the keyspace we
1227
# already have; but this may be more traffic again.
1229
# Transform self._parents_map into a search request recipe.
1230
# TODO: Manage this incrementally to avoid covering the same path
1231
# repeatedly. (The server will have to on each request, but the less
1232
# work done the better).
1233
parents_map = self._unstacked_provider.get_cached_map()
1234
if parents_map is None:
1235
# Repository is not locked, so there's no cache.
1237
start_set = set(parents_map)
1238
result_parents = set()
1239
for parents in parents_map.itervalues():
1240
result_parents.update(parents)
1241
stop_keys = result_parents.difference(start_set)
1242
included_keys = start_set.intersection(result_parents)
1243
start_set.difference_update(included_keys)
1244
recipe = ('manual', start_set, stop_keys, len(parents_map))
1245
body = self._serialise_search_recipe(recipe)
1246
path = self.bzrdir._path_for_remote_call(self._client)
1248
if type(key) is not str:
1250
"key %r not a plain string" % (key,))
1251
verb = 'Repository.get_parent_map'
1252
args = (path,) + tuple(keys)
1254
response = self._call_with_body_bytes_expecting_body(
1256
except errors.UnknownSmartMethod:
1257
# Server does not support this method, so get the whole graph.
1258
# Worse, we have to force a disconnection, because the server now
1259
# doesn't realise it has a body on the wire to consume, so the
1260
# only way to recover is to abandon the connection.
1262
'Server is too old for fast get_parent_map, reconnecting. '
1263
'(Upgrade the server to Bazaar 1.2 to avoid this)')
1265
# To avoid having to disconnect repeatedly, we keep track of the
1266
# fact the server doesn't understand remote methods added in 1.2.
1267
medium._remember_remote_is_before((1, 2))
1268
# Recurse just once and we should use the fallback code.
1269
return self._get_parent_map_rpc(keys)
1270
response_tuple, response_handler = response
1271
if response_tuple[0] not in ['ok']:
1272
response_handler.cancel_read_body()
1273
raise errors.UnexpectedSmartServerResponse(response_tuple)
1274
if response_tuple[0] == 'ok':
1275
coded = bz2.decompress(response_handler.read_body_bytes())
1277
# no revisions found
1279
lines = coded.split('\n')
1282
d = tuple(line.split())
1284
revision_graph[d[0]] = d[1:]
1286
# No parents - so give the Graph result (NULL_REVISION,).
1287
revision_graph[d[0]] = (NULL_REVISION,)
1288
return revision_graph
1291
def get_signature_text(self, revision_id):
1293
return self._real_repository.get_signature_text(revision_id)
1296
def get_inventory_xml(self, revision_id):
1298
return self._real_repository.get_inventory_xml(revision_id)
1300
def deserialise_inventory(self, revision_id, xml):
1302
return self._real_repository.deserialise_inventory(revision_id, xml)
1304
def reconcile(self, other=None, thorough=False):
1306
return self._real_repository.reconcile(other=other, thorough=thorough)
1308
def all_revision_ids(self):
1310
return self._real_repository.all_revision_ids()
1313
def get_deltas_for_revisions(self, revisions, specific_fileids=None):
1315
return self._real_repository.get_deltas_for_revisions(revisions,
1316
specific_fileids=specific_fileids)
1319
def get_revision_delta(self, revision_id, specific_fileids=None):
1321
return self._real_repository.get_revision_delta(revision_id,
1322
specific_fileids=specific_fileids)
1325
def revision_trees(self, revision_ids):
1327
return self._real_repository.revision_trees(revision_ids)
1330
def get_revision_reconcile(self, revision_id):
1332
return self._real_repository.get_revision_reconcile(revision_id)
1335
def check(self, revision_ids=None):
1337
return self._real_repository.check(revision_ids=revision_ids)
1339
def copy_content_into(self, destination, revision_id=None):
1341
return self._real_repository.copy_content_into(
1342
destination, revision_id=revision_id)
1344
def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
1345
# get a tarball of the remote repository, and copy from that into the
1347
from bzrlib import osutils
1349
# TODO: Maybe a progress bar while streaming the tarball?
1350
note("Copying repository content as tarball...")
1351
tar_file = self._get_tarball('bz2')
1352
if tar_file is None:
1354
destination = to_bzrdir.create_repository()
1356
tar = tarfile.open('repository', fileobj=tar_file,
1358
tmpdir = osutils.mkdtemp()
1360
_extract_tar(tar, tmpdir)
1361
tmp_bzrdir = BzrDir.open(tmpdir)
1362
tmp_repo = tmp_bzrdir.open_repository()
1363
tmp_repo.copy_content_into(destination, revision_id)
1365
osutils.rmtree(tmpdir)
1369
# TODO: Suggestion from john: using external tar is much faster than
1370
# python's tarfile library, but it may not work on windows.
1373
def inventories(self):
1374
"""Decorate the real repository for now.
1376
In the long term a full blown network facility is needed to
1377
avoid creating a real repository object locally.
1380
return self._real_repository.inventories
1384
"""Compress the data within the repository.
1386
This is not currently implemented within the smart server.
1389
return self._real_repository.pack()
1392
def revisions(self):
1393
"""Decorate the real repository for now.
1395
In the short term this should become a real object to intercept graph
1398
In the long term a full blown network facility is needed.
1401
return self._real_repository.revisions
1403
def set_make_working_trees(self, new_value):
1405
new_value_str = "True"
1407
new_value_str = "False"
1408
path = self.bzrdir._path_for_remote_call(self._client)
1410
response = self._call(
1411
'Repository.set_make_working_trees', path, new_value_str)
1412
except errors.UnknownSmartMethod:
1414
self._real_repository.set_make_working_trees(new_value)
1416
if response[0] != 'ok':
1417
raise errors.UnexpectedSmartServerResponse(response)
1420
def signatures(self):
1421
"""Decorate the real repository for now.
1423
In the long term a full blown network facility is needed to avoid
1424
creating a real repository object locally.
1427
return self._real_repository.signatures
1430
def sign_revision(self, revision_id, gpg_strategy):
1432
return self._real_repository.sign_revision(revision_id, gpg_strategy)
1436
"""Decorate the real repository for now.
1438
In the long term a full blown network facility is needed to avoid
1439
creating a real repository object locally.
1442
return self._real_repository.texts
1445
def get_revisions(self, revision_ids):
1447
return self._real_repository.get_revisions(revision_ids)
1449
def supports_rich_root(self):
1450
return self._format.rich_root_data
1452
def iter_reverse_revision_history(self, revision_id):
1454
return self._real_repository.iter_reverse_revision_history(revision_id)
1457
def _serializer(self):
1458
return self._format._serializer
1460
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1462
return self._real_repository.store_revision_signature(
1463
gpg_strategy, plaintext, revision_id)
1465
def add_signature_text(self, revision_id, signature):
1467
return self._real_repository.add_signature_text(revision_id, signature)
1469
def has_signature_for_revision_id(self, revision_id):
1471
return self._real_repository.has_signature_for_revision_id(revision_id)
1473
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
1475
return self._real_repository.item_keys_introduced_by(revision_ids,
1476
_files_pb=_files_pb)
1478
def revision_graph_can_have_wrong_parents(self):
1479
# The answer depends on the remote repo format.
1481
return self._real_repository.revision_graph_can_have_wrong_parents()
1483
def _find_inconsistent_revision_parents(self):
1485
return self._real_repository._find_inconsistent_revision_parents()
1487
def _check_for_inconsistent_revision_parents(self):
1489
return self._real_repository._check_for_inconsistent_revision_parents()
1491
def _make_parents_provider(self, other=None):
1492
providers = [self._unstacked_provider]
1493
if other is not None:
1494
providers.insert(0, other)
1495
providers.extend(r._make_parents_provider() for r in
1496
self._fallback_repositories)
1497
return graph._StackedParentsProvider(providers)
1499
def _serialise_search_recipe(self, recipe):
1500
"""Serialise a graph search recipe.
1502
:param recipe: A search recipe (start, stop, count).
1503
:return: Serialised bytes.
1505
start_keys = ' '.join(recipe[1])
1506
stop_keys = ' '.join(recipe[2])
1507
count = str(recipe[3])
1508
return '\n'.join((start_keys, stop_keys, count))
1510
def _serialise_search_result(self, search_result):
1511
if isinstance(search_result, graph.PendingAncestryResult):
1512
parts = ['ancestry-of']
1513
parts.extend(search_result.heads)
1515
recipe = search_result.get_recipe()
1516
parts = [recipe[0], self._serialise_search_recipe(recipe)]
1517
return '\n'.join(parts)
1520
path = self.bzrdir._path_for_remote_call(self._client)
1522
response = self._call('PackRepository.autopack', path)
1523
except errors.UnknownSmartMethod:
1525
self._real_repository._pack_collection.autopack()
1528
if response[0] != 'ok':
1529
raise errors.UnexpectedSmartServerResponse(response)
1532
class RemoteStreamSink(repository.StreamSink):
1534
def _insert_real(self, stream, src_format, resume_tokens):
1535
self.target_repo._ensure_real()
1536
sink = self.target_repo._real_repository._get_sink()
1537
result = sink.insert_stream(stream, src_format, resume_tokens)
1539
self.target_repo.autopack()
1542
def insert_stream(self, stream, src_format, resume_tokens):
1543
target = self.target_repo
1544
if target._lock_token:
1545
verb = 'Repository.insert_stream_locked'
1546
extra_args = (target._lock_token or '',)
1547
required_version = (1, 14)
1549
verb = 'Repository.insert_stream'
1551
required_version = (1, 13)
1552
client = target._client
1553
medium = client._medium
1554
if medium._is_remote_before(required_version):
1555
# No possible way this can work.
1556
return self._insert_real(stream, src_format, resume_tokens)
1557
path = target.bzrdir._path_for_remote_call(client)
1558
if not resume_tokens:
1559
# XXX: Ugly but important for correctness, *will* be fixed during
1560
# 1.13 cycle. Pushing a stream that is interrupted results in a
1561
# fallback to the _real_repositories sink *with a partial stream*.
1562
# Thats bad because we insert less data than bzr expected. To avoid
1563
# this we do a trial push to make sure the verb is accessible, and
1564
# do not fallback when actually pushing the stream. A cleanup patch
1565
# is going to look at rewinding/restarting the stream/partial
1567
byte_stream = smart_repo._stream_to_byte_stream([], src_format)
1569
response = client.call_with_body_stream(
1570
(verb, path, '') + extra_args, byte_stream)
1571
except errors.UnknownSmartMethod:
1572
medium._remember_remote_is_before(required_version)
1573
return self._insert_real(stream, src_format, resume_tokens)
1574
byte_stream = smart_repo._stream_to_byte_stream(
1576
resume_tokens = ' '.join(resume_tokens)
1577
response = client.call_with_body_stream(
1578
(verb, path, resume_tokens) + extra_args, byte_stream)
1579
if response[0][0] not in ('ok', 'missing-basis'):
1580
raise errors.UnexpectedSmartServerResponse(response)
1581
if response[0][0] == 'missing-basis':
1582
tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
1583
resume_tokens = tokens
1584
return resume_tokens, missing_keys
1586
self.target_repo.refresh_data()
1590
class RemoteStreamSource(repository.StreamSource):
1591
"""Stream data from a remote server."""
1593
def get_stream(self, search):
1594
if (self.from_repository._fallback_repositories and
1595
self.to_format._fetch_order == 'topological'):
1596
return self._real_stream(self.from_repository, search)
1597
return self.missing_parents_chain(search, [self.from_repository] +
1598
self.from_repository._fallback_repositories)
1600
def _real_stream(self, repo, search):
1601
"""Get a stream for search from repo.
1603
This never called RemoteStreamSource.get_stream, and is a heler
1604
for RemoteStreamSource._get_stream to allow getting a stream
1605
reliably whether fallback back because of old servers or trying
1606
to stream from a non-RemoteRepository (which the stacked support
1609
source = repo._get_source(self.to_format)
1610
if isinstance(source, RemoteStreamSource):
1611
return repository.StreamSource.get_stream(source, search)
1612
return source.get_stream(search)
1614
def _get_stream(self, repo, search):
1615
"""Core worker to get a stream from repo for search.
1617
This is used by both get_stream and the stacking support logic. It
1618
deliberately gets a stream for repo which does not need to be
1619
self.from_repository. In the event that repo is not Remote, or
1620
cannot do a smart stream, a fallback is made to the generic
1621
repository._get_stream() interface, via self._real_stream.
1623
In the event of stacking, streams from _get_stream will not
1624
contain all the data for search - this is normal (see get_stream).
1626
:param repo: A repository.
1627
:param search: A search.
1629
# Fallbacks may be non-smart
1630
if not isinstance(repo, RemoteRepository):
1631
return self._real_stream(repo, search)
1632
client = repo._client
1633
medium = client._medium
1634
if medium._is_remote_before((1, 13)):
1635
# streaming was added in 1.13
1636
return self._real_stream(repo, search)
1637
path = repo.bzrdir._path_for_remote_call(client)
1639
search_bytes = repo._serialise_search_result(search)
1640
response = repo._call_with_body_bytes_expecting_body(
1641
'Repository.get_stream',
1642
(path, self.to_format.network_name()), search_bytes)
1643
response_tuple, response_handler = response
1644
except errors.UnknownSmartMethod:
1645
medium._remember_remote_is_before((1,13))
1646
return self._real_stream(repo, search)
1647
if response_tuple[0] != 'ok':
1648
raise errors.UnexpectedSmartServerResponse(response_tuple)
1649
byte_stream = response_handler.read_streamed_body()
1650
src_format, stream = smart_repo._byte_stream_to_stream(byte_stream)
1651
if src_format.network_name() != repo._format.network_name():
1652
raise AssertionError(
1653
"Mismatched RemoteRepository and stream src %r, %r" % (
1654
src_format.network_name(), repo._format.network_name()))
1657
def missing_parents_chain(self, search, sources):
1658
"""Chain multiple streams together to handle stacking.
1660
:param search: The overall search to satisfy with streams.
1661
:param sources: A list of Repository objects to query.
1663
self.serialiser = self.to_format._serializer
1664
self.seen_revs = set()
1665
self.referenced_revs = set()
1666
# If there are heads in the search, or the key count is > 0, we are not
1668
while not search.is_empty() and len(sources) > 1:
1669
source = sources.pop(0)
1670
stream = self._get_stream(source, search)
1671
for kind, substream in stream:
1672
if kind != 'revisions':
1673
yield kind, substream
1675
yield kind, self.missing_parents_rev_handler(substream)
1676
search = search.refine(self.seen_revs, self.referenced_revs)
1677
self.seen_revs = set()
1678
self.referenced_revs = set()
1679
if not search.is_empty():
1680
for kind, stream in self._get_stream(sources[0], search):
1683
def missing_parents_rev_handler(self, substream):
1684
for content in substream:
1685
revision_bytes = content.get_bytes_as('fulltext')
1686
revision = self.serialiser.read_revision_from_string(revision_bytes)
1687
self.seen_revs.add(content.key[-1])
1688
self.referenced_revs.update(revision.parent_ids)
1692
class RemoteBranchLockableFiles(LockableFiles):
1693
"""A 'LockableFiles' implementation that talks to a smart server.
1695
This is not a public interface class.
1698
def __init__(self, bzrdir, _client):
1699
self.bzrdir = bzrdir
1700
self._client = _client
1701
self._need_find_modes = True
1702
LockableFiles.__init__(
1703
self, bzrdir.get_branch_transport(None),
1704
'lock', lockdir.LockDir)
1706
def _find_modes(self):
1707
# RemoteBranches don't let the client set the mode of control files.
1708
self._dir_mode = None
1709
self._file_mode = None
1712
class RemoteBranchFormat(branch.BranchFormat):
1714
def __init__(self, network_name=None):
1715
super(RemoteBranchFormat, self).__init__()
1716
self._matchingbzrdir = RemoteBzrDirFormat()
1717
self._matchingbzrdir.set_branch_format(self)
1718
self._custom_format = None
1719
self._network_name = network_name
1721
def __eq__(self, other):
1722
return (isinstance(other, RemoteBranchFormat) and
1723
self.__dict__ == other.__dict__)
1725
def _ensure_real(self):
1726
if self._custom_format is None:
1727
self._custom_format = branch.network_format_registry.get(
1730
def get_format_description(self):
1731
return 'Remote BZR Branch'
1733
def network_name(self):
1734
return self._network_name
1736
def open(self, a_bzrdir):
1737
return a_bzrdir.open_branch()
1739
def _vfs_initialize(self, a_bzrdir):
1740
# Initialisation when using a local bzrdir object, or a non-vfs init
1741
# method is not available on the server.
1742
# self._custom_format is always set - the start of initialize ensures
1744
if isinstance(a_bzrdir, RemoteBzrDir):
1745
a_bzrdir._ensure_real()
1746
result = self._custom_format.initialize(a_bzrdir._real_bzrdir)
1748
# We assume the bzrdir is parameterised; it may not be.
1749
result = self._custom_format.initialize(a_bzrdir)
1750
if (isinstance(a_bzrdir, RemoteBzrDir) and
1751
not isinstance(result, RemoteBranch)):
1752
result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result)
1755
def initialize(self, a_bzrdir):
1756
# 1) get the network name to use.
1757
if self._custom_format:
1758
network_name = self._custom_format.network_name()
1760
# Select the current bzrlib default and ask for that.
1761
reference_bzrdir_format = bzrdir.format_registry.get('default')()
1762
reference_format = reference_bzrdir_format.get_branch_format()
1763
self._custom_format = reference_format
1764
network_name = reference_format.network_name()
1765
# Being asked to create on a non RemoteBzrDir:
1766
if not isinstance(a_bzrdir, RemoteBzrDir):
1767
return self._vfs_initialize(a_bzrdir)
1768
medium = a_bzrdir._client._medium
1769
if medium._is_remote_before((1, 13)):
1770
return self._vfs_initialize(a_bzrdir)
1771
# Creating on a remote bzr dir.
1772
# 2) try direct creation via RPC
1773
path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
1774
verb = 'BzrDir.create_branch'
1776
response = a_bzrdir._call(verb, path, network_name)
1777
except errors.UnknownSmartMethod:
1778
# Fallback - use vfs methods
1779
medium._remember_remote_is_before((1, 13))
1780
return self._vfs_initialize(a_bzrdir)
1781
if response[0] != 'ok':
1782
raise errors.UnexpectedSmartServerResponse(response)
1783
# Turn the response into a RemoteRepository object.
1784
format = RemoteBranchFormat(network_name=response[1])
1785
repo_format = response_tuple_to_repo_format(response[3:])
1786
if response[2] == '':
1787
repo_bzrdir = a_bzrdir
1789
repo_bzrdir = RemoteBzrDir(
1790
a_bzrdir.root_transport.clone(response[2]), a_bzrdir._format,
1792
remote_repo = RemoteRepository(repo_bzrdir, repo_format)
1793
remote_branch = RemoteBranch(a_bzrdir, remote_repo,
1794
format=format, setup_stacking=False)
1795
# XXX: We know this is a new branch, so it must have revno 0, revid
1796
# NULL_REVISION. Creating the branch locked would make this be unable
1797
# to be wrong; here its simply very unlikely to be wrong. RBC 20090225
1798
remote_branch._last_revision_info_cache = 0, NULL_REVISION
1799
return remote_branch
1801
def make_tags(self, branch):
1803
return self._custom_format.make_tags(branch)
1805
def supports_tags(self):
1806
# Remote branches might support tags, but we won't know until we
1807
# access the real remote branch.
1809
return self._custom_format.supports_tags()
1811
def supports_stacking(self):
1813
return self._custom_format.supports_stacking()
1816
class RemoteBranch(branch.Branch, _RpcHelper):
1817
"""Branch stored on a server accessed by HPSS RPC.
1819
At the moment most operations are mapped down to simple file operations.
1822
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
1823
_client=None, format=None, setup_stacking=True):
1824
"""Create a RemoteBranch instance.
1826
:param real_branch: An optional local implementation of the branch
1827
format, usually accessing the data via the VFS.
1828
:param _client: Private parameter for testing.
1829
:param format: A RemoteBranchFormat object, None to create one
1830
automatically. If supplied it should have a network_name already
1832
:param setup_stacking: If True make an RPC call to determine the
1833
stacked (or not) status of the branch. If False assume the branch
1836
# We intentionally don't call the parent class's __init__, because it
1837
# will try to assign to self.tags, which is a property in this subclass.
1838
# And the parent's __init__ doesn't do much anyway.
1839
self._revision_id_to_revno_cache = None
1840
self._partial_revision_id_to_revno_cache = {}
1841
self._revision_history_cache = None
1842
self._last_revision_info_cache = None
1843
self._merge_sorted_revisions_cache = None
1844
self.bzrdir = remote_bzrdir
1845
if _client is not None:
1846
self._client = _client
1848
self._client = remote_bzrdir._client
1849
self.repository = remote_repository
1850
if real_branch is not None:
1851
self._real_branch = real_branch
1852
# Give the remote repository the matching real repo.
1853
real_repo = self._real_branch.repository
1854
if isinstance(real_repo, RemoteRepository):
1855
real_repo._ensure_real()
1856
real_repo = real_repo._real_repository
1857
self.repository._set_real_repository(real_repo)
1858
# Give the branch the remote repository to let fast-pathing happen.
1859
self._real_branch.repository = self.repository
1861
self._real_branch = None
1862
# Fill out expected attributes of branch for bzrlib api users.
1863
self.base = self.bzrdir.root_transport.base
1864
self._control_files = None
1865
self._lock_mode = None
1866
self._lock_token = None
1867
self._repo_lock_token = None
1868
self._lock_count = 0
1869
self._leave_lock = False
1870
# Setup a format: note that we cannot call _ensure_real until all the
1871
# attributes above are set: This code cannot be moved higher up in this
1874
self._format = RemoteBranchFormat()
1875
if real_branch is not None:
1876
self._format._network_name = \
1877
self._real_branch._format.network_name()
1879
self._format = format
1880
if not self._format._network_name:
1881
# Did not get from open_branchV2 - old server.
1883
self._format._network_name = \
1884
self._real_branch._format.network_name()
1885
self.tags = self._format.make_tags(self)
1886
# The base class init is not called, so we duplicate this:
1887
hooks = branch.Branch.hooks['open']
1891
self._setup_stacking()
1893
def _setup_stacking(self):
1894
# configure stacking into the remote repository, by reading it from
1897
fallback_url = self.get_stacked_on_url()
1898
except (errors.NotStacked, errors.UnstackableBranchFormat,
1899
errors.UnstackableRepositoryFormat), e:
1901
# it's relative to this branch...
1902
fallback_url = urlutils.join(self.base, fallback_url)
1903
transports = [self.bzrdir.root_transport]
1904
stacked_on = branch.Branch.open(fallback_url,
1905
possible_transports=transports)
1906
self.repository.add_fallback_repository(stacked_on.repository)
1908
def _get_real_transport(self):
1909
# if we try vfs access, return the real branch's vfs transport
1911
return self._real_branch._transport
1913
_transport = property(_get_real_transport)
1916
return "%s(%s)" % (self.__class__.__name__, self.base)
1920
def _ensure_real(self):
1921
"""Ensure that there is a _real_branch set.
1923
Used before calls to self._real_branch.
1925
if self._real_branch is None:
1926
if not vfs.vfs_enabled():
1927
raise AssertionError('smart server vfs must be enabled '
1928
'to use vfs implementation')
1929
self.bzrdir._ensure_real()
1930
self._real_branch = self.bzrdir._real_bzrdir.open_branch()
1931
if self.repository._real_repository is None:
1932
# Give the remote repository the matching real repo.
1933
real_repo = self._real_branch.repository
1934
if isinstance(real_repo, RemoteRepository):
1935
real_repo._ensure_real()
1936
real_repo = real_repo._real_repository
1937
self.repository._set_real_repository(real_repo)
1938
# Give the real branch the remote repository to let fast-pathing
1940
self._real_branch.repository = self.repository
1941
if self._lock_mode == 'r':
1942
self._real_branch.lock_read()
1943
elif self._lock_mode == 'w':
1944
self._real_branch.lock_write(token=self._lock_token)
1946
def _translate_error(self, err, **context):
1947
self.repository._translate_error(err, branch=self, **context)
1949
def _clear_cached_state(self):
1950
super(RemoteBranch, self)._clear_cached_state()
1951
if self._real_branch is not None:
1952
self._real_branch._clear_cached_state()
1954
def _clear_cached_state_of_remote_branch_only(self):
1955
"""Like _clear_cached_state, but doesn't clear the cache of
1958
This is useful when falling back to calling a method of
1959
self._real_branch that changes state. In that case the underlying
1960
branch changes, so we need to invalidate this RemoteBranch's cache of
1961
it. However, there's no need to invalidate the _real_branch's cache
1962
too, in fact doing so might harm performance.
1964
super(RemoteBranch, self)._clear_cached_state()
1967
def control_files(self):
1968
# Defer actually creating RemoteBranchLockableFiles until its needed,
1969
# because it triggers an _ensure_real that we otherwise might not need.
1970
if self._control_files is None:
1971
self._control_files = RemoteBranchLockableFiles(
1972
self.bzrdir, self._client)
1973
return self._control_files
1975
def _get_checkout_format(self):
1977
return self._real_branch._get_checkout_format()
1979
def get_physical_lock_status(self):
1980
"""See Branch.get_physical_lock_status()."""
1981
# should be an API call to the server, as branches must be lockable.
1983
return self._real_branch.get_physical_lock_status()
1985
def get_stacked_on_url(self):
1986
"""Get the URL this branch is stacked against.
1988
:raises NotStacked: If the branch is not stacked.
1989
:raises UnstackableBranchFormat: If the branch does not support
1991
:raises UnstackableRepositoryFormat: If the repository does not support
1995
# there may not be a repository yet, so we can't use
1996
# self._translate_error, so we can't use self._call either.
1997
response = self._client.call('Branch.get_stacked_on_url',
1998
self._remote_path())
1999
except errors.ErrorFromSmartServer, err:
2000
# there may not be a repository yet, so we can't call through
2001
# its _translate_error
2002
_translate_error(err, branch=self)
2003
except errors.UnknownSmartMethod, err:
2005
return self._real_branch.get_stacked_on_url()
2006
if response[0] != 'ok':
2007
raise errors.UnexpectedSmartServerResponse(response)
2010
def _vfs_get_tags_bytes(self):
2012
return self._real_branch._get_tags_bytes()
2014
def _get_tags_bytes(self):
2015
medium = self._client._medium
2016
if medium._is_remote_before((1, 13)):
2017
return self._vfs_get_tags_bytes()
2019
response = self._call('Branch.get_tags_bytes', self._remote_path())
2020
except errors.UnknownSmartMethod:
2021
medium._remember_remote_is_before((1, 13))
2022
return self._vfs_get_tags_bytes()
2025
def lock_read(self):
2026
self.repository.lock_read()
2027
if not self._lock_mode:
2028
self._lock_mode = 'r'
2029
self._lock_count = 1
2030
if self._real_branch is not None:
2031
self._real_branch.lock_read()
2033
self._lock_count += 1
2035
def _remote_lock_write(self, token):
2037
branch_token = repo_token = ''
2039
branch_token = token
2040
repo_token = self.repository.lock_write()
2041
self.repository.unlock()
2042
err_context = {'token': token}
2043
response = self._call(
2044
'Branch.lock_write', self._remote_path(), branch_token,
2045
repo_token or '', **err_context)
2046
if response[0] != 'ok':
2047
raise errors.UnexpectedSmartServerResponse(response)
2048
ok, branch_token, repo_token = response
2049
return branch_token, repo_token
2051
def lock_write(self, token=None):
2052
if not self._lock_mode:
2053
# Lock the branch and repo in one remote call.
2054
remote_tokens = self._remote_lock_write(token)
2055
self._lock_token, self._repo_lock_token = remote_tokens
2056
if not self._lock_token:
2057
raise SmartProtocolError('Remote server did not return a token!')
2058
# Tell the self.repository object that it is locked.
2059
self.repository.lock_write(
2060
self._repo_lock_token, _skip_rpc=True)
2062
if self._real_branch is not None:
2063
self._real_branch.lock_write(token=self._lock_token)
2064
if token is not None:
2065
self._leave_lock = True
2067
self._leave_lock = False
2068
self._lock_mode = 'w'
2069
self._lock_count = 1
2070
elif self._lock_mode == 'r':
2071
raise errors.ReadOnlyTransaction
2073
if token is not None:
2074
# A token was given to lock_write, and we're relocking, so
2075
# check that the given token actually matches the one we
2077
if token != self._lock_token:
2078
raise errors.TokenMismatch(token, self._lock_token)
2079
self._lock_count += 1
2080
# Re-lock the repository too.
2081
self.repository.lock_write(self._repo_lock_token)
2082
return self._lock_token or None
2084
def _set_tags_bytes(self, bytes):
2086
return self._real_branch._set_tags_bytes(bytes)
2088
def _unlock(self, branch_token, repo_token):
2089
err_context = {'token': str((branch_token, repo_token))}
2090
response = self._call(
2091
'Branch.unlock', self._remote_path(), branch_token,
2092
repo_token or '', **err_context)
2093
if response == ('ok',):
2095
raise errors.UnexpectedSmartServerResponse(response)
2099
self._lock_count -= 1
2100
if not self._lock_count:
2101
self._clear_cached_state()
2102
mode = self._lock_mode
2103
self._lock_mode = None
2104
if self._real_branch is not None:
2105
if (not self._leave_lock and mode == 'w' and
2106
self._repo_lock_token):
2107
# If this RemoteBranch will remove the physical lock
2108
# for the repository, make sure the _real_branch
2109
# doesn't do it first. (Because the _real_branch's
2110
# repository is set to be the RemoteRepository.)
2111
self._real_branch.repository.leave_lock_in_place()
2112
self._real_branch.unlock()
2114
# Only write-locked branched need to make a remote method
2115
# call to perfom the unlock.
2117
if not self._lock_token:
2118
raise AssertionError('Locked, but no token!')
2119
branch_token = self._lock_token
2120
repo_token = self._repo_lock_token
2121
self._lock_token = None
2122
self._repo_lock_token = None
2123
if not self._leave_lock:
2124
self._unlock(branch_token, repo_token)
2126
self.repository.unlock()
2128
def break_lock(self):
2130
return self._real_branch.break_lock()
2132
def leave_lock_in_place(self):
2133
if not self._lock_token:
2134
raise NotImplementedError(self.leave_lock_in_place)
2135
self._leave_lock = True
2137
def dont_leave_lock_in_place(self):
2138
if not self._lock_token:
2139
raise NotImplementedError(self.dont_leave_lock_in_place)
2140
self._leave_lock = False
2142
def _last_revision_info(self):
2143
response = self._call('Branch.last_revision_info', self._remote_path())
2144
if response[0] != 'ok':
2145
raise SmartProtocolError('unexpected response code %s' % (response,))
2146
revno = int(response[1])
2147
last_revision = response[2]
2148
return (revno, last_revision)
2150
def _gen_revision_history(self):
2151
"""See Branch._gen_revision_history()."""
2152
response_tuple, response_handler = self._call_expecting_body(
2153
'Branch.revision_history', self._remote_path())
2154
if response_tuple[0] != 'ok':
2155
raise errors.UnexpectedSmartServerResponse(response_tuple)
2156
result = response_handler.read_body_bytes().split('\x00')
2161
def _remote_path(self):
2162
return self.bzrdir._path_for_remote_call(self._client)
2164
def _set_last_revision_descendant(self, revision_id, other_branch,
2165
allow_diverged=False, allow_overwrite_descendant=False):
2166
# This performs additional work to meet the hook contract; while its
2167
# undesirable, we have to synthesise the revno to call the hook, and
2168
# not calling the hook is worse as it means changes can't be prevented.
2169
# Having calculated this though, we can't just call into
2170
# set_last_revision_info as a simple call, because there is a set_rh
2171
# hook that some folk may still be using.
2172
old_revno, old_revid = self.last_revision_info()
2173
history = self._lefthand_history(revision_id)
2174
self._run_pre_change_branch_tip_hooks(len(history), revision_id)
2175
err_context = {'other_branch': other_branch}
2176
response = self._call('Branch.set_last_revision_ex',
2177
self._remote_path(), self._lock_token, self._repo_lock_token,
2178
revision_id, int(allow_diverged), int(allow_overwrite_descendant),
2180
self._clear_cached_state()
2181
if len(response) != 3 and response[0] != 'ok':
2182
raise errors.UnexpectedSmartServerResponse(response)
2183
new_revno, new_revision_id = response[1:]
2184
self._last_revision_info_cache = new_revno, new_revision_id
2185
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2186
if self._real_branch is not None:
2187
cache = new_revno, new_revision_id
2188
self._real_branch._last_revision_info_cache = cache
2190
def _set_last_revision(self, revision_id):
2191
old_revno, old_revid = self.last_revision_info()
2192
# This performs additional work to meet the hook contract; while its
2193
# undesirable, we have to synthesise the revno to call the hook, and
2194
# not calling the hook is worse as it means changes can't be prevented.
2195
# Having calculated this though, we can't just call into
2196
# set_last_revision_info as a simple call, because there is a set_rh
2197
# hook that some folk may still be using.
2198
history = self._lefthand_history(revision_id)
2199
self._run_pre_change_branch_tip_hooks(len(history), revision_id)
2200
self._clear_cached_state()
2201
response = self._call('Branch.set_last_revision',
2202
self._remote_path(), self._lock_token, self._repo_lock_token,
2204
if response != ('ok',):
2205
raise errors.UnexpectedSmartServerResponse(response)
2206
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2209
def set_revision_history(self, rev_history):
2210
# Send just the tip revision of the history; the server will generate
2211
# the full history from that. If the revision doesn't exist in this
2212
# branch, NoSuchRevision will be raised.
2213
if rev_history == []:
2216
rev_id = rev_history[-1]
2217
self._set_last_revision(rev_id)
2218
for hook in branch.Branch.hooks['set_rh']:
2219
hook(self, rev_history)
2220
self._cache_revision_history(rev_history)
2222
def _get_parent_location(self):
2223
medium = self._client._medium
2224
if medium._is_remote_before((1, 13)):
2225
return self._vfs_get_parent_location()
2227
response = self._call('Branch.get_parent', self._remote_path())
2228
except errors.UnknownSmartMethod:
2229
medium._remember_remote_is_before((1, 13))
2230
return self._vfs_get_parent_location()
2231
if len(response) != 1:
2232
raise errors.UnexpectedSmartServerResponse(response)
2233
parent_location = response[0]
2234
if parent_location == '':
2236
return parent_location
2238
def _vfs_get_parent_location(self):
2240
return self._real_branch._get_parent_location()
2242
def set_parent(self, url):
2244
return self._real_branch.set_parent(url)
2246
def _set_parent_location(self, url):
2247
# Used by tests, to poke bad urls into branch configurations
2249
self.set_parent(url)
2252
return self._real_branch._set_parent_location(url)
2254
def set_stacked_on_url(self, stacked_location):
2255
"""Set the URL this branch is stacked against.
2257
:raises UnstackableBranchFormat: If the branch does not support
2259
:raises UnstackableRepositoryFormat: If the repository does not support
2263
return self._real_branch.set_stacked_on_url(stacked_location)
2266
def pull(self, source, overwrite=False, stop_revision=None,
2268
self._clear_cached_state_of_remote_branch_only()
2270
return self._real_branch.pull(
2271
source, overwrite=overwrite, stop_revision=stop_revision,
2272
_override_hook_target=self, **kwargs)
2275
def push(self, target, overwrite=False, stop_revision=None):
2277
return self._real_branch.push(
2278
target, overwrite=overwrite, stop_revision=stop_revision,
2279
_override_hook_source_branch=self)
2281
def is_locked(self):
2282
return self._lock_count >= 1
2285
def revision_id_to_revno(self, revision_id):
2287
return self._real_branch.revision_id_to_revno(revision_id)
2290
def set_last_revision_info(self, revno, revision_id):
2291
# XXX: These should be returned by the set_last_revision_info verb
2292
old_revno, old_revid = self.last_revision_info()
2293
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2294
revision_id = ensure_null(revision_id)
2296
response = self._call('Branch.set_last_revision_info',
2297
self._remote_path(), self._lock_token, self._repo_lock_token,
2298
str(revno), revision_id)
2299
except errors.UnknownSmartMethod:
2301
self._clear_cached_state_of_remote_branch_only()
2302
self._real_branch.set_last_revision_info(revno, revision_id)
2303
self._last_revision_info_cache = revno, revision_id
2305
if response == ('ok',):
2306
self._clear_cached_state()
2307
self._last_revision_info_cache = revno, revision_id
2308
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2309
# Update the _real_branch's cache too.
2310
if self._real_branch is not None:
2311
cache = self._last_revision_info_cache
2312
self._real_branch._last_revision_info_cache = cache
2314
raise errors.UnexpectedSmartServerResponse(response)
2317
def generate_revision_history(self, revision_id, last_rev=None,
2319
medium = self._client._medium
2320
if not medium._is_remote_before((1, 6)):
2321
# Use a smart method for 1.6 and above servers
2323
self._set_last_revision_descendant(revision_id, other_branch,
2324
allow_diverged=True, allow_overwrite_descendant=True)
2326
except errors.UnknownSmartMethod:
2327
medium._remember_remote_is_before((1, 6))
2328
self._clear_cached_state_of_remote_branch_only()
2329
self.set_revision_history(self._lefthand_history(revision_id,
2330
last_rev=last_rev,other_branch=other_branch))
2332
def set_push_location(self, location):
2334
return self._real_branch.set_push_location(location)
2337
def _extract_tar(tar, to_dir):
2338
"""Extract all the contents of a tarfile object.
2340
A replacement for extractall, which is not present in python2.4
2343
tar.extract(tarinfo, to_dir)
2346
def _translate_error(err, **context):
2347
"""Translate an ErrorFromSmartServer into a more useful error.
2349
Possible context keys:
2357
If the error from the server doesn't match a known pattern, then
2358
UnknownErrorFromSmartServer is raised.
2362
return context[name]
2363
except KeyError, key_err:
2364
mutter('Missing key %r in context %r', key_err.args[0], context)
2367
"""Get the path from the context if present, otherwise use first error
2371
return context['path']
2372
except KeyError, key_err:
2374
return err.error_args[0]
2375
except IndexError, idx_err:
2377
'Missing key %r in context %r', key_err.args[0], context)
2380
if err.error_verb == 'NoSuchRevision':
2381
raise NoSuchRevision(find('branch'), err.error_args[0])
2382
elif err.error_verb == 'nosuchrevision':
2383
raise NoSuchRevision(find('repository'), err.error_args[0])
2384
elif err.error_tuple == ('nobranch',):
2385
raise errors.NotBranchError(path=find('bzrdir').root_transport.base)
2386
elif err.error_verb == 'norepository':
2387
raise errors.NoRepositoryPresent(find('bzrdir'))
2388
elif err.error_verb == 'LockContention':
2389
raise errors.LockContention('(remote lock)')
2390
elif err.error_verb == 'UnlockableTransport':
2391
raise errors.UnlockableTransport(find('bzrdir').root_transport)
2392
elif err.error_verb == 'LockFailed':
2393
raise errors.LockFailed(err.error_args[0], err.error_args[1])
2394
elif err.error_verb == 'TokenMismatch':
2395
raise errors.TokenMismatch(find('token'), '(remote token)')
2396
elif err.error_verb == 'Diverged':
2397
raise errors.DivergedBranches(find('branch'), find('other_branch'))
2398
elif err.error_verb == 'TipChangeRejected':
2399
raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
2400
elif err.error_verb == 'UnstackableBranchFormat':
2401
raise errors.UnstackableBranchFormat(*err.error_args)
2402
elif err.error_verb == 'UnstackableRepositoryFormat':
2403
raise errors.UnstackableRepositoryFormat(*err.error_args)
2404
elif err.error_verb == 'NotStacked':
2405
raise errors.NotStacked(branch=find('branch'))
2406
elif err.error_verb == 'PermissionDenied':
2408
if len(err.error_args) >= 2:
2409
extra = err.error_args[1]
2412
raise errors.PermissionDenied(path, extra=extra)
2413
elif err.error_verb == 'ReadError':
2415
raise errors.ReadError(path)
2416
elif err.error_verb == 'NoSuchFile':
2418
raise errors.NoSuchFile(path)
2419
elif err.error_verb == 'FileExists':
2420
raise errors.FileExists(err.error_args[0])
2421
elif err.error_verb == 'DirectoryNotEmpty':
2422
raise errors.DirectoryNotEmpty(err.error_args[0])
2423
elif err.error_verb == 'ShortReadvError':
2424
args = err.error_args
2425
raise errors.ShortReadvError(
2426
args[0], int(args[1]), int(args[2]), int(args[3]))
2427
elif err.error_verb in ('UnicodeEncodeError', 'UnicodeDecodeError'):
2428
encoding = str(err.error_args[0]) # encoding must always be a string
2429
val = err.error_args[1]
2430
start = int(err.error_args[2])
2431
end = int(err.error_args[3])
2432
reason = str(err.error_args[4]) # reason must always be a string
2433
if val.startswith('u:'):
2434
val = val[2:].decode('utf-8')
2435
elif val.startswith('s:'):
2436
val = val[2:].decode('base64')
2437
if err.error_verb == 'UnicodeDecodeError':
2438
raise UnicodeDecodeError(encoding, val, start, end, reason)
2439
elif err.error_verb == 'UnicodeEncodeError':
2440
raise UnicodeEncodeError(encoding, val, start, end, reason)
2441
elif err.error_verb == 'ReadOnlyError':
2442
raise errors.TransportNotPossible('readonly transport')
2443
raise errors.UnknownErrorFromSmartServer(err)
added
removed
bzrlib/remote.py
