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., 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.
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 rich_root_data(self):
421
if self._rich_root_data is None:
423
self._rich_root_data = self._custom_format.rich_root_data
424
return self._rich_root_data
427
def supports_external_lookups(self):
428
if self._supports_external_lookups is None:
430
self._supports_external_lookups = \
431
self._custom_format.supports_external_lookups
432
return self._supports_external_lookups
435
def supports_tree_reference(self):
436
if self._supports_tree_reference is None:
438
self._supports_tree_reference = \
439
self._custom_format.supports_tree_reference
440
return self._supports_tree_reference
442
def _vfs_initialize(self, a_bzrdir, shared):
443
"""Helper for common code in initialize."""
444
if self._custom_format:
445
# Custom format requested
446
result = self._custom_format.initialize(a_bzrdir, shared=shared)
447
elif self._creating_bzrdir is not None:
448
# Use the format that the repository we were created to back
450
prior_repo = self._creating_bzrdir.open_repository()
451
prior_repo._ensure_real()
452
result = prior_repo._real_repository._format.initialize(
453
a_bzrdir, shared=shared)
455
# assume that a_bzr is a RemoteBzrDir but the smart server didn't
456
# support remote initialization.
457
# We delegate to a real object at this point (as RemoteBzrDir
458
# delegate to the repository format which would lead to infinite
459
# recursion if we just called a_bzrdir.create_repository.
460
a_bzrdir._ensure_real()
461
result = a_bzrdir._real_bzrdir.create_repository(shared=shared)
462
if not isinstance(result, RemoteRepository):
463
return self.open(a_bzrdir)
467
def initialize(self, a_bzrdir, shared=False):
468
# Being asked to create on a non RemoteBzrDir:
469
if not isinstance(a_bzrdir, RemoteBzrDir):
470
return self._vfs_initialize(a_bzrdir, shared)
471
medium = a_bzrdir._client._medium
472
if medium._is_remote_before((1, 13)):
473
return self._vfs_initialize(a_bzrdir, shared)
474
# Creating on a remote bzr dir.
475
# 1) get the network name to use.
476
if self._custom_format:
477
network_name = self._custom_format.network_name()
479
# Select the current bzrlib default and ask for that.
480
reference_bzrdir_format = bzrdir.format_registry.get('default')()
481
reference_format = reference_bzrdir_format.repository_format
482
network_name = reference_format.network_name()
483
# 2) try direct creation via RPC
484
path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
485
verb = 'BzrDir.create_repository'
491
response = a_bzrdir._call(verb, path, network_name, shared_str)
492
except errors.UnknownSmartMethod:
493
# Fallback - use vfs methods
494
medium._remember_remote_is_before((1, 13))
495
return self._vfs_initialize(a_bzrdir, shared)
497
# Turn the response into a RemoteRepository object.
498
format = response_tuple_to_repo_format(response[1:])
499
# Used to support creating a real format instance when needed.
500
format._creating_bzrdir = a_bzrdir
501
remote_repo = RemoteRepository(a_bzrdir, format)
502
format._creating_repo = remote_repo
505
def open(self, a_bzrdir):
506
if not isinstance(a_bzrdir, RemoteBzrDir):
507
raise AssertionError('%r is not a RemoteBzrDir' % (a_bzrdir,))
508
return a_bzrdir.open_repository()
510
def _ensure_real(self):
511
if self._custom_format is None:
512
self._custom_format = repository.network_format_registry.get(
516
def _fetch_order(self):
518
return self._custom_format._fetch_order
521
def _fetch_uses_deltas(self):
523
return self._custom_format._fetch_uses_deltas
526
def _fetch_reconcile(self):
528
return self._custom_format._fetch_reconcile
530
def get_format_description(self):
531
return 'bzr remote repository'
533
def __eq__(self, other):
534
return self.__class__ is other.__class__
536
def check_conversion_target(self, target_format):
537
if self.rich_root_data and not target_format.rich_root_data:
538
raise errors.BadConversionTarget(
539
'Does not support rich root data.', target_format)
540
if (self.supports_tree_reference and
541
not getattr(target_format, 'supports_tree_reference', False)):
542
raise errors.BadConversionTarget(
543
'Does not support nested trees', target_format)
545
def network_name(self):
546
if self._network_name:
547
return self._network_name
548
self._creating_repo._ensure_real()
549
return self._creating_repo._real_repository._format.network_name()
552
def _serializer(self):
554
return self._custom_format._serializer
557
class RemoteRepository(_RpcHelper):
558
"""Repository accessed over rpc.
560
For the moment most operations are performed using local transport-backed
564
def __init__(self, remote_bzrdir, format, real_repository=None, _client=None):
565
"""Create a RemoteRepository instance.
567
:param remote_bzrdir: The bzrdir hosting this repository.
568
:param format: The RemoteFormat object to use.
569
:param real_repository: If not None, a local implementation of the
570
repository logic for the repository, usually accessing the data
572
:param _client: Private testing parameter - override the smart client
573
to be used by the repository.
576
self._real_repository = real_repository
578
self._real_repository = None
579
self.bzrdir = remote_bzrdir
581
self._client = remote_bzrdir._client
583
self._client = _client
584
self._format = format
585
self._lock_mode = None
586
self._lock_token = None
588
self._leave_lock = False
589
self._unstacked_provider = graph.CachingParentsProvider(
590
get_parent_map=self._get_parent_map_rpc)
591
self._unstacked_provider.disable_cache()
593
# These depend on the actual remote format, so force them off for
594
# maximum compatibility. XXX: In future these should depend on the
595
# remote repository instance, but this is irrelevant until we perform
596
# reconcile via an RPC call.
597
self._reconcile_does_inventory_gc = False
598
self._reconcile_fixes_text_parents = False
599
self._reconcile_backsup_inventory = False
600
self.base = self.bzrdir.transport.base
601
# Additional places to query for data.
602
self._fallback_repositories = []
605
return "%s(%s)" % (self.__class__.__name__, self.base)
609
def abort_write_group(self, suppress_errors=False):
610
"""Complete a write group on the decorated repository.
612
Smart methods peform operations in a single step so this api
613
is not really applicable except as a compatibility thunk
614
for older plugins that don't use e.g. the CommitBuilder
617
:param suppress_errors: see Repository.abort_write_group.
620
return self._real_repository.abort_write_group(
621
suppress_errors=suppress_errors)
623
def commit_write_group(self):
624
"""Complete a write group on the decorated repository.
626
Smart methods peform operations in a single step so this api
627
is not really applicable except as a compatibility thunk
628
for older plugins that don't use e.g. the CommitBuilder
632
return self._real_repository.commit_write_group()
634
def resume_write_group(self, tokens):
636
return self._real_repository.resume_write_group(tokens)
638
def suspend_write_group(self):
640
return self._real_repository.suspend_write_group()
642
def _ensure_real(self):
643
"""Ensure that there is a _real_repository set.
645
Used before calls to self._real_repository.
647
Note that _ensure_real causes many roundtrips to the server which are
648
not desirable, and prevents the use of smart one-roundtrip RPC's to
649
perform complex operations (such as accessing parent data, streaming
650
revisions etc). Adding calls to _ensure_real should only be done when
651
bringing up new functionality, adding fallbacks for smart methods that
652
require a fallback path, and never to replace an existing smart method
653
invocation. If in doubt chat to the bzr network team.
655
if self._real_repository is None:
656
self.bzrdir._ensure_real()
657
self._set_real_repository(
658
self.bzrdir._real_bzrdir.open_repository())
660
def _translate_error(self, err, **context):
661
self.bzrdir._translate_error(err, repository=self, **context)
663
def find_text_key_references(self):
664
"""Find the text key references within the repository.
666
:return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
667
revision_ids. Each altered file-ids has the exact revision_ids that
668
altered it listed explicitly.
669
:return: A dictionary mapping text keys ((fileid, revision_id) tuples)
670
to whether they were referred to by the inventory of the
671
revision_id that they contain. The inventory texts from all present
672
revision ids are assessed to generate this report.
675
return self._real_repository.find_text_key_references()
677
def _generate_text_key_index(self):
678
"""Generate a new text key index for the repository.
680
This is an expensive function that will take considerable time to run.
682
:return: A dict mapping (file_id, revision_id) tuples to a list of
683
parents, also (file_id, revision_id) tuples.
686
return self._real_repository._generate_text_key_index()
688
@symbol_versioning.deprecated_method(symbol_versioning.one_four)
689
def get_revision_graph(self, revision_id=None):
690
"""See Repository.get_revision_graph()."""
691
return self._get_revision_graph(revision_id)
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
1191
# XXX: Note that this will issue a deprecation warning. This is ok
1192
# :- its because we're working with a deprecated server anyway, and
1193
# the user will almost certainly have seen a warning about the
1194
# server version already.
1195
rg = self.get_revision_graph()
1196
# There is an api discrepency between get_parent_map and
1197
# get_revision_graph. Specifically, a "key:()" pair in
1198
# get_revision_graph just means a node has no parents. For
1199
# "get_parent_map" it means the node is a ghost. So fix up the
1200
# graph to correct this.
1201
# https://bugs.launchpad.net/bzr/+bug/214894
1202
# There is one other "bug" which is that ghosts in
1203
# get_revision_graph() are not returned at all. But we won't worry
1204
# about that for now.
1205
for node_id, parent_ids in rg.iteritems():
1206
if parent_ids == ():
1207
rg[node_id] = (NULL_REVISION,)
1208
rg[NULL_REVISION] = ()
1213
raise ValueError('get_parent_map(None) is not valid')
1214
if NULL_REVISION in keys:
1215
keys.discard(NULL_REVISION)
1216
found_parents = {NULL_REVISION:()}
1218
return found_parents
1221
# TODO(Needs analysis): We could assume that the keys being requested
1222
# from get_parent_map are in a breadth first search, so typically they
1223
# will all be depth N from some common parent, and we don't have to
1224
# have the server iterate from the root parent, but rather from the
1225
# keys we're searching; and just tell the server the keyspace we
1226
# already have; but this may be more traffic again.
1228
# Transform self._parents_map into a search request recipe.
1229
# TODO: Manage this incrementally to avoid covering the same path
1230
# repeatedly. (The server will have to on each request, but the less
1231
# work done the better).
1232
parents_map = self._unstacked_provider.get_cached_map()
1233
if parents_map is None:
1234
# Repository is not locked, so there's no cache.
1236
start_set = set(parents_map)
1237
result_parents = set()
1238
for parents in parents_map.itervalues():
1239
result_parents.update(parents)
1240
stop_keys = result_parents.difference(start_set)
1241
included_keys = start_set.intersection(result_parents)
1242
start_set.difference_update(included_keys)
1243
recipe = (start_set, stop_keys, len(parents_map))
1244
body = self._serialise_search_recipe(recipe)
1245
path = self.bzrdir._path_for_remote_call(self._client)
1247
if type(key) is not str:
1249
"key %r not a plain string" % (key,))
1250
verb = 'Repository.get_parent_map'
1251
args = (path,) + tuple(keys)
1253
response = self._call_with_body_bytes_expecting_body(
1255
except errors.UnknownSmartMethod:
1256
# Server does not support this method, so get the whole graph.
1257
# Worse, we have to force a disconnection, because the server now
1258
# doesn't realise it has a body on the wire to consume, so the
1259
# only way to recover is to abandon the connection.
1261
'Server is too old for fast get_parent_map, reconnecting. '
1262
'(Upgrade the server to Bazaar 1.2 to avoid this)')
1264
# To avoid having to disconnect repeatedly, we keep track of the
1265
# fact the server doesn't understand remote methods added in 1.2.
1266
medium._remember_remote_is_before((1, 2))
1267
return self.get_revision_graph(None)
1268
response_tuple, response_handler = response
1269
if response_tuple[0] not in ['ok']:
1270
response_handler.cancel_read_body()
1271
raise errors.UnexpectedSmartServerResponse(response_tuple)
1272
if response_tuple[0] == 'ok':
1273
coded = bz2.decompress(response_handler.read_body_bytes())
1275
# no revisions found
1277
lines = coded.split('\n')
1280
d = tuple(line.split())
1282
revision_graph[d[0]] = d[1:]
1284
# No parents - so give the Graph result (NULL_REVISION,).
1285
revision_graph[d[0]] = (NULL_REVISION,)
1286
return revision_graph
1289
def get_signature_text(self, revision_id):
1291
return self._real_repository.get_signature_text(revision_id)
1294
@symbol_versioning.deprecated_method(symbol_versioning.one_three)
1295
def get_revision_graph_with_ghosts(self, revision_ids=None):
1297
return self._real_repository.get_revision_graph_with_ghosts(
1298
revision_ids=revision_ids)
1301
def get_inventory_xml(self, revision_id):
1303
return self._real_repository.get_inventory_xml(revision_id)
1305
def deserialise_inventory(self, revision_id, xml):
1307
return self._real_repository.deserialise_inventory(revision_id, xml)
1309
def reconcile(self, other=None, thorough=False):
1311
return self._real_repository.reconcile(other=other, thorough=thorough)
1313
def all_revision_ids(self):
1315
return self._real_repository.all_revision_ids()
1318
def get_deltas_for_revisions(self, revisions):
1320
return self._real_repository.get_deltas_for_revisions(revisions)
1323
def get_revision_delta(self, revision_id):
1325
return self._real_repository.get_revision_delta(revision_id)
1328
def revision_trees(self, revision_ids):
1330
return self._real_repository.revision_trees(revision_ids)
1333
def get_revision_reconcile(self, revision_id):
1335
return self._real_repository.get_revision_reconcile(revision_id)
1338
def check(self, revision_ids=None):
1340
return self._real_repository.check(revision_ids=revision_ids)
1342
def copy_content_into(self, destination, revision_id=None):
1344
return self._real_repository.copy_content_into(
1345
destination, revision_id=revision_id)
1347
def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
1348
# get a tarball of the remote repository, and copy from that into the
1350
from bzrlib import osutils
1352
# TODO: Maybe a progress bar while streaming the tarball?
1353
note("Copying repository content as tarball...")
1354
tar_file = self._get_tarball('bz2')
1355
if tar_file is None:
1357
destination = to_bzrdir.create_repository()
1359
tar = tarfile.open('repository', fileobj=tar_file,
1361
tmpdir = osutils.mkdtemp()
1363
_extract_tar(tar, tmpdir)
1364
tmp_bzrdir = BzrDir.open(tmpdir)
1365
tmp_repo = tmp_bzrdir.open_repository()
1366
tmp_repo.copy_content_into(destination, revision_id)
1368
osutils.rmtree(tmpdir)
1372
# TODO: Suggestion from john: using external tar is much faster than
1373
# python's tarfile library, but it may not work on windows.
1376
def inventories(self):
1377
"""Decorate the real repository for now.
1379
In the long term a full blown network facility is needed to
1380
avoid creating a real repository object locally.
1383
return self._real_repository.inventories
1387
"""Compress the data within the repository.
1389
This is not currently implemented within the smart server.
1392
return self._real_repository.pack()
1395
def revisions(self):
1396
"""Decorate the real repository for now.
1398
In the short term this should become a real object to intercept graph
1401
In the long term a full blown network facility is needed.
1404
return self._real_repository.revisions
1406
def set_make_working_trees(self, new_value):
1408
new_value_str = "True"
1410
new_value_str = "False"
1411
path = self.bzrdir._path_for_remote_call(self._client)
1413
response = self._call(
1414
'Repository.set_make_working_trees', path, new_value_str)
1415
except errors.UnknownSmartMethod:
1417
self._real_repository.set_make_working_trees(new_value)
1419
if response[0] != 'ok':
1420
raise errors.UnexpectedSmartServerResponse(response)
1423
def signatures(self):
1424
"""Decorate the real repository for now.
1426
In the long term a full blown network facility is needed to avoid
1427
creating a real repository object locally.
1430
return self._real_repository.signatures
1433
def sign_revision(self, revision_id, gpg_strategy):
1435
return self._real_repository.sign_revision(revision_id, gpg_strategy)
1439
"""Decorate the real repository for now.
1441
In the long term a full blown network facility is needed to avoid
1442
creating a real repository object locally.
1445
return self._real_repository.texts
1448
def get_revisions(self, revision_ids):
1450
return self._real_repository.get_revisions(revision_ids)
1452
def supports_rich_root(self):
1453
return self._format.rich_root_data
1455
def iter_reverse_revision_history(self, revision_id):
1457
return self._real_repository.iter_reverse_revision_history(revision_id)
1460
def _serializer(self):
1461
return self._format._serializer
1463
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1465
return self._real_repository.store_revision_signature(
1466
gpg_strategy, plaintext, revision_id)
1468
def add_signature_text(self, revision_id, signature):
1470
return self._real_repository.add_signature_text(revision_id, signature)
1472
def has_signature_for_revision_id(self, revision_id):
1474
return self._real_repository.has_signature_for_revision_id(revision_id)
1476
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
1478
return self._real_repository.item_keys_introduced_by(revision_ids,
1479
_files_pb=_files_pb)
1481
def revision_graph_can_have_wrong_parents(self):
1482
# The answer depends on the remote repo format.
1484
return self._real_repository.revision_graph_can_have_wrong_parents()
1486
def _find_inconsistent_revision_parents(self):
1488
return self._real_repository._find_inconsistent_revision_parents()
1490
def _check_for_inconsistent_revision_parents(self):
1492
return self._real_repository._check_for_inconsistent_revision_parents()
1494
def _make_parents_provider(self, other=None):
1495
providers = [self._unstacked_provider]
1496
if other is not None:
1497
providers.insert(0, other)
1498
providers.extend(r._make_parents_provider() for r in
1499
self._fallback_repositories)
1500
return graph._StackedParentsProvider(providers)
1502
def _serialise_search_recipe(self, recipe):
1503
"""Serialise a graph search recipe.
1505
:param recipe: A search recipe (start, stop, count).
1506
:return: Serialised bytes.
1508
start_keys = ' '.join(recipe[0])
1509
stop_keys = ' '.join(recipe[1])
1510
count = str(recipe[2])
1511
return '\n'.join((start_keys, stop_keys, count))
1513
def _serialise_search_result(self, search_result):
1514
if isinstance(search_result, graph.PendingAncestryResult):
1515
parts = ['ancestry-of']
1516
parts.extend(search_result.heads)
1518
recipe = search_result.get_recipe()
1519
parts = ['search', self._serialise_search_recipe(recipe)]
1520
return '\n'.join(parts)
1523
path = self.bzrdir._path_for_remote_call(self._client)
1525
response = self._call('PackRepository.autopack', path)
1526
except errors.UnknownSmartMethod:
1528
self._real_repository._pack_collection.autopack()
1531
if response[0] != 'ok':
1532
raise errors.UnexpectedSmartServerResponse(response)
1535
class RemoteStreamSink(repository.StreamSink):
1537
def _insert_real(self, stream, src_format, resume_tokens):
1538
self.target_repo._ensure_real()
1539
sink = self.target_repo._real_repository._get_sink()
1540
result = sink.insert_stream(stream, src_format, resume_tokens)
1542
self.target_repo.autopack()
1545
def insert_stream(self, stream, src_format, resume_tokens):
1546
repo = self.target_repo
1547
client = repo._client
1548
medium = client._medium
1549
if medium._is_remote_before((1, 13)):
1550
# No possible way this can work.
1551
return self._insert_real(stream, src_format, resume_tokens)
1552
path = repo.bzrdir._path_for_remote_call(client)
1553
if not resume_tokens:
1554
# XXX: Ugly but important for correctness, *will* be fixed during
1555
# 1.13 cycle. Pushing a stream that is interrupted results in a
1556
# fallback to the _real_repositories sink *with a partial stream*.
1557
# Thats bad because we insert less data than bzr expected. To avoid
1558
# this we do a trial push to make sure the verb is accessible, and
1559
# do not fallback when actually pushing the stream. A cleanup patch
1560
# is going to look at rewinding/restarting the stream/partial
1562
byte_stream = smart_repo._stream_to_byte_stream([], src_format)
1564
response = client.call_with_body_stream(
1565
('Repository.insert_stream', path, ''), byte_stream)
1566
except errors.UnknownSmartMethod:
1567
medium._remember_remote_is_before((1,13))
1568
return self._insert_real(stream, src_format, resume_tokens)
1569
byte_stream = smart_repo._stream_to_byte_stream(
1571
resume_tokens = ' '.join(resume_tokens)
1572
response = client.call_with_body_stream(
1573
('Repository.insert_stream', path, resume_tokens), byte_stream)
1574
if response[0][0] not in ('ok', 'missing-basis'):
1575
raise errors.UnexpectedSmartServerResponse(response)
1576
if response[0][0] == 'missing-basis':
1577
tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
1578
resume_tokens = tokens
1579
return resume_tokens, missing_keys
1581
self.target_repo.refresh_data()
1585
class RemoteStreamSource(repository.StreamSource):
1586
"""Stream data from a remote server."""
1588
def get_stream(self, search):
1589
# streaming with fallback repositories is not well defined yet: The
1590
# remote repository cannot see the fallback repositories, and thus
1591
# cannot satisfy the entire search in the general case. Likewise the
1592
# fallback repositories cannot reify the search to determine what they
1593
# should send. It likely needs a return value in the stream listing the
1594
# edge of the search to resume from in fallback repositories.
1595
if self.from_repository._fallback_repositories:
1596
return repository.StreamSource.get_stream(self, search)
1597
repo = self.from_repository
1598
client = repo._client
1599
medium = client._medium
1600
if medium._is_remote_before((1, 13)):
1601
# No possible way this can work.
1602
return repository.StreamSource.get_stream(self, search)
1603
path = repo.bzrdir._path_for_remote_call(client)
1605
search_bytes = repo._serialise_search_result(search)
1606
response = repo._call_with_body_bytes_expecting_body(
1607
'Repository.get_stream',
1608
(path, self.to_format.network_name()), search_bytes)
1609
response_tuple, response_handler = response
1610
except errors.UnknownSmartMethod:
1611
medium._remember_remote_is_before((1,13))
1612
return repository.StreamSource.get_stream(self, search)
1613
if response_tuple[0] != 'ok':
1614
raise errors.UnexpectedSmartServerResponse(response_tuple)
1615
byte_stream = response_handler.read_streamed_body()
1616
src_format, stream = smart_repo._byte_stream_to_stream(byte_stream)
1617
if src_format.network_name() != repo._format.network_name():
1618
raise AssertionError(
1619
"Mismatched RemoteRepository and stream src %r, %r" % (
1620
src_format.network_name(), repo._format.network_name()))
1624
class RemoteBranchLockableFiles(LockableFiles):
1625
"""A 'LockableFiles' implementation that talks to a smart server.
1627
This is not a public interface class.
1630
def __init__(self, bzrdir, _client):
1631
self.bzrdir = bzrdir
1632
self._client = _client
1633
self._need_find_modes = True
1634
LockableFiles.__init__(
1635
self, bzrdir.get_branch_transport(None),
1636
'lock', lockdir.LockDir)
1638
def _find_modes(self):
1639
# RemoteBranches don't let the client set the mode of control files.
1640
self._dir_mode = None
1641
self._file_mode = None
1644
class RemoteBranchFormat(branch.BranchFormat):
1646
def __init__(self, network_name=None):
1647
super(RemoteBranchFormat, self).__init__()
1648
self._matchingbzrdir = RemoteBzrDirFormat()
1649
self._matchingbzrdir.set_branch_format(self)
1650
self._custom_format = None
1651
self._network_name = network_name
1653
def __eq__(self, other):
1654
return (isinstance(other, RemoteBranchFormat) and
1655
self.__dict__ == other.__dict__)
1657
def _ensure_real(self):
1658
if self._custom_format is None:
1659
self._custom_format = branch.network_format_registry.get(
1662
def get_format_description(self):
1663
return 'Remote BZR Branch'
1665
def network_name(self):
1666
return self._network_name
1668
def open(self, a_bzrdir):
1669
return a_bzrdir.open_branch()
1671
def _vfs_initialize(self, a_bzrdir):
1672
# Initialisation when using a local bzrdir object, or a non-vfs init
1673
# method is not available on the server.
1674
# self._custom_format is always set - the start of initialize ensures
1676
if isinstance(a_bzrdir, RemoteBzrDir):
1677
a_bzrdir._ensure_real()
1678
result = self._custom_format.initialize(a_bzrdir._real_bzrdir)
1680
# We assume the bzrdir is parameterised; it may not be.
1681
result = self._custom_format.initialize(a_bzrdir)
1682
if (isinstance(a_bzrdir, RemoteBzrDir) and
1683
not isinstance(result, RemoteBranch)):
1684
result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result)
1687
def initialize(self, a_bzrdir):
1688
# 1) get the network name to use.
1689
if self._custom_format:
1690
network_name = self._custom_format.network_name()
1692
# Select the current bzrlib default and ask for that.
1693
reference_bzrdir_format = bzrdir.format_registry.get('default')()
1694
reference_format = reference_bzrdir_format.get_branch_format()
1695
self._custom_format = reference_format
1696
network_name = reference_format.network_name()
1697
# Being asked to create on a non RemoteBzrDir:
1698
if not isinstance(a_bzrdir, RemoteBzrDir):
1699
return self._vfs_initialize(a_bzrdir)
1700
medium = a_bzrdir._client._medium
1701
if medium._is_remote_before((1, 13)):
1702
return self._vfs_initialize(a_bzrdir)
1703
# Creating on a remote bzr dir.
1704
# 2) try direct creation via RPC
1705
path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
1706
verb = 'BzrDir.create_branch'
1708
response = a_bzrdir._call(verb, path, network_name)
1709
except errors.UnknownSmartMethod:
1710
# Fallback - use vfs methods
1711
medium._remember_remote_is_before((1, 13))
1712
return self._vfs_initialize(a_bzrdir)
1713
if response[0] != 'ok':
1714
raise errors.UnexpectedSmartServerResponse(response)
1715
# Turn the response into a RemoteRepository object.
1716
format = RemoteBranchFormat(network_name=response[1])
1717
repo_format = response_tuple_to_repo_format(response[3:])
1718
if response[2] == '':
1719
repo_bzrdir = a_bzrdir
1721
repo_bzrdir = RemoteBzrDir(
1722
a_bzrdir.root_transport.clone(response[2]), a_bzrdir._format,
1724
remote_repo = RemoteRepository(repo_bzrdir, repo_format)
1725
remote_branch = RemoteBranch(a_bzrdir, remote_repo,
1726
format=format, setup_stacking=False)
1727
# XXX: We know this is a new branch, so it must have revno 0, revid
1728
# NULL_REVISION. Creating the branch locked would make this be unable
1729
# to be wrong; here its simply very unlikely to be wrong. RBC 20090225
1730
remote_branch._last_revision_info_cache = 0, NULL_REVISION
1731
return remote_branch
1733
def make_tags(self, branch):
1735
return self._custom_format.make_tags(branch)
1737
def supports_tags(self):
1738
# Remote branches might support tags, but we won't know until we
1739
# access the real remote branch.
1741
return self._custom_format.supports_tags()
1743
def supports_stacking(self):
1745
return self._custom_format.supports_stacking()
1748
class RemoteBranch(branch.Branch, _RpcHelper):
1749
"""Branch stored on a server accessed by HPSS RPC.
1751
At the moment most operations are mapped down to simple file operations.
1754
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
1755
_client=None, format=None, setup_stacking=True):
1756
"""Create a RemoteBranch instance.
1758
:param real_branch: An optional local implementation of the branch
1759
format, usually accessing the data via the VFS.
1760
:param _client: Private parameter for testing.
1761
:param format: A RemoteBranchFormat object, None to create one
1762
automatically. If supplied it should have a network_name already
1764
:param setup_stacking: If True make an RPC call to determine the
1765
stacked (or not) status of the branch. If False assume the branch
1768
# We intentionally don't call the parent class's __init__, because it
1769
# will try to assign to self.tags, which is a property in this subclass.
1770
# And the parent's __init__ doesn't do much anyway.
1771
self._revision_id_to_revno_cache = None
1772
self._partial_revision_id_to_revno_cache = {}
1773
self._revision_history_cache = None
1774
self._last_revision_info_cache = None
1775
self._merge_sorted_revisions_cache = None
1776
self.bzrdir = remote_bzrdir
1777
if _client is not None:
1778
self._client = _client
1780
self._client = remote_bzrdir._client
1781
self.repository = remote_repository
1782
if real_branch is not None:
1783
self._real_branch = real_branch
1784
# Give the remote repository the matching real repo.
1785
real_repo = self._real_branch.repository
1786
if isinstance(real_repo, RemoteRepository):
1787
real_repo._ensure_real()
1788
real_repo = real_repo._real_repository
1789
self.repository._set_real_repository(real_repo)
1790
# Give the branch the remote repository to let fast-pathing happen.
1791
self._real_branch.repository = self.repository
1793
self._real_branch = None
1794
# Fill out expected attributes of branch for bzrlib api users.
1795
self.base = self.bzrdir.root_transport.base
1796
self._control_files = None
1797
self._lock_mode = None
1798
self._lock_token = None
1799
self._repo_lock_token = None
1800
self._lock_count = 0
1801
self._leave_lock = False
1802
# Setup a format: note that we cannot call _ensure_real until all the
1803
# attributes above are set: This code cannot be moved higher up in this
1806
self._format = RemoteBranchFormat()
1807
if real_branch is not None:
1808
self._format._network_name = \
1809
self._real_branch._format.network_name()
1811
self._format = format
1812
if not self._format._network_name:
1813
# Did not get from open_branchV2 - old server.
1815
self._format._network_name = \
1816
self._real_branch._format.network_name()
1817
self.tags = self._format.make_tags(self)
1818
# The base class init is not called, so we duplicate this:
1819
hooks = branch.Branch.hooks['open']
1823
self._setup_stacking()
1825
def _setup_stacking(self):
1826
# configure stacking into the remote repository, by reading it from
1829
fallback_url = self.get_stacked_on_url()
1830
except (errors.NotStacked, errors.UnstackableBranchFormat,
1831
errors.UnstackableRepositoryFormat), e:
1833
# it's relative to this branch...
1834
fallback_url = urlutils.join(self.base, fallback_url)
1835
transports = [self.bzrdir.root_transport]
1836
stacked_on = branch.Branch.open(fallback_url,
1837
possible_transports=transports)
1838
self.repository.add_fallback_repository(stacked_on.repository)
1840
def _get_real_transport(self):
1841
# if we try vfs access, return the real branch's vfs transport
1843
return self._real_branch._transport
1845
_transport = property(_get_real_transport)
1848
return "%s(%s)" % (self.__class__.__name__, self.base)
1852
def _ensure_real(self):
1853
"""Ensure that there is a _real_branch set.
1855
Used before calls to self._real_branch.
1857
if self._real_branch is None:
1858
if not vfs.vfs_enabled():
1859
raise AssertionError('smart server vfs must be enabled '
1860
'to use vfs implementation')
1861
self.bzrdir._ensure_real()
1862
self._real_branch = self.bzrdir._real_bzrdir.open_branch()
1863
if self.repository._real_repository is None:
1864
# Give the remote repository the matching real repo.
1865
real_repo = self._real_branch.repository
1866
if isinstance(real_repo, RemoteRepository):
1867
real_repo._ensure_real()
1868
real_repo = real_repo._real_repository
1869
self.repository._set_real_repository(real_repo)
1870
# Give the real branch the remote repository to let fast-pathing
1872
self._real_branch.repository = self.repository
1873
if self._lock_mode == 'r':
1874
self._real_branch.lock_read()
1875
elif self._lock_mode == 'w':
1876
self._real_branch.lock_write(token=self._lock_token)
1878
def _translate_error(self, err, **context):
1879
self.repository._translate_error(err, branch=self, **context)
1881
def _clear_cached_state(self):
1882
super(RemoteBranch, self)._clear_cached_state()
1883
if self._real_branch is not None:
1884
self._real_branch._clear_cached_state()
1886
def _clear_cached_state_of_remote_branch_only(self):
1887
"""Like _clear_cached_state, but doesn't clear the cache of
1890
This is useful when falling back to calling a method of
1891
self._real_branch that changes state. In that case the underlying
1892
branch changes, so we need to invalidate this RemoteBranch's cache of
1893
it. However, there's no need to invalidate the _real_branch's cache
1894
too, in fact doing so might harm performance.
1896
super(RemoteBranch, self)._clear_cached_state()
1899
def control_files(self):
1900
# Defer actually creating RemoteBranchLockableFiles until its needed,
1901
# because it triggers an _ensure_real that we otherwise might not need.
1902
if self._control_files is None:
1903
self._control_files = RemoteBranchLockableFiles(
1904
self.bzrdir, self._client)
1905
return self._control_files
1907
def _get_checkout_format(self):
1909
return self._real_branch._get_checkout_format()
1911
def get_physical_lock_status(self):
1912
"""See Branch.get_physical_lock_status()."""
1913
# should be an API call to the server, as branches must be lockable.
1915
return self._real_branch.get_physical_lock_status()
1917
def get_stacked_on_url(self):
1918
"""Get the URL this branch is stacked against.
1920
:raises NotStacked: If the branch is not stacked.
1921
:raises UnstackableBranchFormat: If the branch does not support
1923
:raises UnstackableRepositoryFormat: If the repository does not support
1927
# there may not be a repository yet, so we can't use
1928
# self._translate_error, so we can't use self._call either.
1929
response = self._client.call('Branch.get_stacked_on_url',
1930
self._remote_path())
1931
except errors.ErrorFromSmartServer, err:
1932
# there may not be a repository yet, so we can't call through
1933
# its _translate_error
1934
_translate_error(err, branch=self)
1935
except errors.UnknownSmartMethod, err:
1937
return self._real_branch.get_stacked_on_url()
1938
if response[0] != 'ok':
1939
raise errors.UnexpectedSmartServerResponse(response)
1942
def _vfs_get_tags_bytes(self):
1944
return self._real_branch._get_tags_bytes()
1946
def _get_tags_bytes(self):
1947
medium = self._client._medium
1948
if medium._is_remote_before((1, 13)):
1949
return self._vfs_get_tags_bytes()
1951
response = self._call('Branch.get_tags_bytes', self._remote_path())
1952
except errors.UnknownSmartMethod:
1953
medium._remember_remote_is_before((1, 13))
1954
return self._vfs_get_tags_bytes()
1957
def lock_read(self):
1958
self.repository.lock_read()
1959
if not self._lock_mode:
1960
self._lock_mode = 'r'
1961
self._lock_count = 1
1962
if self._real_branch is not None:
1963
self._real_branch.lock_read()
1965
self._lock_count += 1
1967
def _remote_lock_write(self, token):
1969
branch_token = repo_token = ''
1971
branch_token = token
1972
repo_token = self.repository.lock_write()
1973
self.repository.unlock()
1974
err_context = {'token': token}
1975
response = self._call(
1976
'Branch.lock_write', self._remote_path(), branch_token,
1977
repo_token or '', **err_context)
1978
if response[0] != 'ok':
1979
raise errors.UnexpectedSmartServerResponse(response)
1980
ok, branch_token, repo_token = response
1981
return branch_token, repo_token
1983
def lock_write(self, token=None):
1984
if not self._lock_mode:
1985
# Lock the branch and repo in one remote call.
1986
remote_tokens = self._remote_lock_write(token)
1987
self._lock_token, self._repo_lock_token = remote_tokens
1988
if not self._lock_token:
1989
raise SmartProtocolError('Remote server did not return a token!')
1990
# Tell the self.repository object that it is locked.
1991
self.repository.lock_write(
1992
self._repo_lock_token, _skip_rpc=True)
1994
if self._real_branch is not None:
1995
self._real_branch.lock_write(token=self._lock_token)
1996
if token is not None:
1997
self._leave_lock = True
1999
self._leave_lock = False
2000
self._lock_mode = 'w'
2001
self._lock_count = 1
2002
elif self._lock_mode == 'r':
2003
raise errors.ReadOnlyTransaction
2005
if token is not None:
2006
# A token was given to lock_write, and we're relocking, so
2007
# check that the given token actually matches the one we
2009
if token != self._lock_token:
2010
raise errors.TokenMismatch(token, self._lock_token)
2011
self._lock_count += 1
2012
# Re-lock the repository too.
2013
self.repository.lock_write(self._repo_lock_token)
2014
return self._lock_token or None
2016
def _set_tags_bytes(self, bytes):
2018
return self._real_branch._set_tags_bytes(bytes)
2020
def _unlock(self, branch_token, repo_token):
2021
err_context = {'token': str((branch_token, repo_token))}
2022
response = self._call(
2023
'Branch.unlock', self._remote_path(), branch_token,
2024
repo_token or '', **err_context)
2025
if response == ('ok',):
2027
raise errors.UnexpectedSmartServerResponse(response)
2031
self._lock_count -= 1
2032
if not self._lock_count:
2033
self._clear_cached_state()
2034
mode = self._lock_mode
2035
self._lock_mode = None
2036
if self._real_branch is not None:
2037
if (not self._leave_lock and mode == 'w' and
2038
self._repo_lock_token):
2039
# If this RemoteBranch will remove the physical lock
2040
# for the repository, make sure the _real_branch
2041
# doesn't do it first. (Because the _real_branch's
2042
# repository is set to be the RemoteRepository.)
2043
self._real_branch.repository.leave_lock_in_place()
2044
self._real_branch.unlock()
2046
# Only write-locked branched need to make a remote method
2047
# call to perfom the unlock.
2049
if not self._lock_token:
2050
raise AssertionError('Locked, but no token!')
2051
branch_token = self._lock_token
2052
repo_token = self._repo_lock_token
2053
self._lock_token = None
2054
self._repo_lock_token = None
2055
if not self._leave_lock:
2056
self._unlock(branch_token, repo_token)
2058
self.repository.unlock()
2060
def break_lock(self):
2062
return self._real_branch.break_lock()
2064
def leave_lock_in_place(self):
2065
if not self._lock_token:
2066
raise NotImplementedError(self.leave_lock_in_place)
2067
self._leave_lock = True
2069
def dont_leave_lock_in_place(self):
2070
if not self._lock_token:
2071
raise NotImplementedError(self.dont_leave_lock_in_place)
2072
self._leave_lock = False
2074
def _last_revision_info(self):
2075
response = self._call('Branch.last_revision_info', self._remote_path())
2076
if response[0] != 'ok':
2077
raise SmartProtocolError('unexpected response code %s' % (response,))
2078
revno = int(response[1])
2079
last_revision = response[2]
2080
return (revno, last_revision)
2082
def _gen_revision_history(self):
2083
"""See Branch._gen_revision_history()."""
2084
response_tuple, response_handler = self._call_expecting_body(
2085
'Branch.revision_history', self._remote_path())
2086
if response_tuple[0] != 'ok':
2087
raise errors.UnexpectedSmartServerResponse(response_tuple)
2088
result = response_handler.read_body_bytes().split('\x00')
2093
def _remote_path(self):
2094
return self.bzrdir._path_for_remote_call(self._client)
2096
def _set_last_revision_descendant(self, revision_id, other_branch,
2097
allow_diverged=False, allow_overwrite_descendant=False):
2098
# This performs additional work to meet the hook contract; while its
2099
# undesirable, we have to synthesise the revno to call the hook, and
2100
# not calling the hook is worse as it means changes can't be prevented.
2101
# Having calculated this though, we can't just call into
2102
# set_last_revision_info as a simple call, because there is a set_rh
2103
# hook that some folk may still be using.
2104
old_revno, old_revid = self.last_revision_info()
2105
history = self._lefthand_history(revision_id)
2106
self._run_pre_change_branch_tip_hooks(len(history), revision_id)
2107
err_context = {'other_branch': other_branch}
2108
response = self._call('Branch.set_last_revision_ex',
2109
self._remote_path(), self._lock_token, self._repo_lock_token,
2110
revision_id, int(allow_diverged), int(allow_overwrite_descendant),
2112
self._clear_cached_state()
2113
if len(response) != 3 and response[0] != 'ok':
2114
raise errors.UnexpectedSmartServerResponse(response)
2115
new_revno, new_revision_id = response[1:]
2116
self._last_revision_info_cache = new_revno, new_revision_id
2117
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2118
if self._real_branch is not None:
2119
cache = new_revno, new_revision_id
2120
self._real_branch._last_revision_info_cache = cache
2122
def _set_last_revision(self, revision_id):
2123
old_revno, old_revid = self.last_revision_info()
2124
# This performs additional work to meet the hook contract; while its
2125
# undesirable, we have to synthesise the revno to call the hook, and
2126
# not calling the hook is worse as it means changes can't be prevented.
2127
# Having calculated this though, we can't just call into
2128
# set_last_revision_info as a simple call, because there is a set_rh
2129
# hook that some folk may still be using.
2130
history = self._lefthand_history(revision_id)
2131
self._run_pre_change_branch_tip_hooks(len(history), revision_id)
2132
self._clear_cached_state()
2133
response = self._call('Branch.set_last_revision',
2134
self._remote_path(), self._lock_token, self._repo_lock_token,
2136
if response != ('ok',):
2137
raise errors.UnexpectedSmartServerResponse(response)
2138
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2141
def set_revision_history(self, rev_history):
2142
# Send just the tip revision of the history; the server will generate
2143
# the full history from that. If the revision doesn't exist in this
2144
# branch, NoSuchRevision will be raised.
2145
if rev_history == []:
2148
rev_id = rev_history[-1]
2149
self._set_last_revision(rev_id)
2150
for hook in branch.Branch.hooks['set_rh']:
2151
hook(self, rev_history)
2152
self._cache_revision_history(rev_history)
2154
def _get_parent_location(self):
2155
medium = self._client._medium
2156
if medium._is_remote_before((1, 13)):
2157
return self._vfs_get_parent_location()
2159
response = self._call('Branch.get_parent', self._remote_path())
2160
except errors.UnknownSmartMethod:
2161
medium._remember_remote_is_before((1, 13))
2162
return self._vfs_get_parent_location()
2163
if len(response) != 1:
2164
raise errors.UnexpectedSmartServerResponse(response)
2165
parent_location = response[0]
2166
if parent_location == '':
2168
return parent_location
2170
def _vfs_get_parent_location(self):
2172
return self._real_branch._get_parent_location()
2174
def set_parent(self, url):
2176
return self._real_branch.set_parent(url)
2178
def _set_parent_location(self, url):
2179
# Used by tests, to poke bad urls into branch configurations
2181
self.set_parent(url)
2184
return self._real_branch._set_parent_location(url)
2186
def set_stacked_on_url(self, stacked_location):
2187
"""Set the URL this branch is stacked against.
2189
:raises UnstackableBranchFormat: If the branch does not support
2191
:raises UnstackableRepositoryFormat: If the repository does not support
2195
return self._real_branch.set_stacked_on_url(stacked_location)
2198
def pull(self, source, overwrite=False, stop_revision=None,
2200
self._clear_cached_state_of_remote_branch_only()
2202
return self._real_branch.pull(
2203
source, overwrite=overwrite, stop_revision=stop_revision,
2204
_override_hook_target=self, **kwargs)
2207
def push(self, target, overwrite=False, stop_revision=None):
2209
return self._real_branch.push(
2210
target, overwrite=overwrite, stop_revision=stop_revision,
2211
_override_hook_source_branch=self)
2213
def is_locked(self):
2214
return self._lock_count >= 1
2217
def revision_id_to_revno(self, revision_id):
2219
return self._real_branch.revision_id_to_revno(revision_id)
2222
def set_last_revision_info(self, revno, revision_id):
2223
# XXX: These should be returned by the set_last_revision_info verb
2224
old_revno, old_revid = self.last_revision_info()
2225
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2226
revision_id = ensure_null(revision_id)
2228
response = self._call('Branch.set_last_revision_info',
2229
self._remote_path(), self._lock_token, self._repo_lock_token,
2230
str(revno), revision_id)
2231
except errors.UnknownSmartMethod:
2233
self._clear_cached_state_of_remote_branch_only()
2234
self._real_branch.set_last_revision_info(revno, revision_id)
2235
self._last_revision_info_cache = revno, revision_id
2237
if response == ('ok',):
2238
self._clear_cached_state()
2239
self._last_revision_info_cache = revno, revision_id
2240
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2241
# Update the _real_branch's cache too.
2242
if self._real_branch is not None:
2243
cache = self._last_revision_info_cache
2244
self._real_branch._last_revision_info_cache = cache
2246
raise errors.UnexpectedSmartServerResponse(response)
2249
def generate_revision_history(self, revision_id, last_rev=None,
2251
medium = self._client._medium
2252
if not medium._is_remote_before((1, 6)):
2253
# Use a smart method for 1.6 and above servers
2255
self._set_last_revision_descendant(revision_id, other_branch,
2256
allow_diverged=True, allow_overwrite_descendant=True)
2258
except errors.UnknownSmartMethod:
2259
medium._remember_remote_is_before((1, 6))
2260
self._clear_cached_state_of_remote_branch_only()
2261
self.set_revision_history(self._lefthand_history(revision_id,
2262
last_rev=last_rev,other_branch=other_branch))
2264
def set_push_location(self, location):
2266
return self._real_branch.set_push_location(location)
2269
def _extract_tar(tar, to_dir):
2270
"""Extract all the contents of a tarfile object.
2272
A replacement for extractall, which is not present in python2.4
2275
tar.extract(tarinfo, to_dir)
2278
def _translate_error(err, **context):
2279
"""Translate an ErrorFromSmartServer into a more useful error.
2281
Possible context keys:
2289
If the error from the server doesn't match a known pattern, then
2290
UnknownErrorFromSmartServer is raised.
2294
return context[name]
2295
except KeyError, key_err:
2296
mutter('Missing key %r in context %r', key_err.args[0], context)
2299
"""Get the path from the context if present, otherwise use first error
2303
return context['path']
2304
except KeyError, key_err:
2306
return err.error_args[0]
2307
except IndexError, idx_err:
2309
'Missing key %r in context %r', key_err.args[0], context)
2312
if err.error_verb == 'NoSuchRevision':
2313
raise NoSuchRevision(find('branch'), err.error_args[0])
2314
elif err.error_verb == 'nosuchrevision':
2315
raise NoSuchRevision(find('repository'), err.error_args[0])
2316
elif err.error_tuple == ('nobranch',):
2317
raise errors.NotBranchError(path=find('bzrdir').root_transport.base)
2318
elif err.error_verb == 'norepository':
2319
raise errors.NoRepositoryPresent(find('bzrdir'))
2320
elif err.error_verb == 'LockContention':
2321
raise errors.LockContention('(remote lock)')
2322
elif err.error_verb == 'UnlockableTransport':
2323
raise errors.UnlockableTransport(find('bzrdir').root_transport)
2324
elif err.error_verb == 'LockFailed':
2325
raise errors.LockFailed(err.error_args[0], err.error_args[1])
2326
elif err.error_verb == 'TokenMismatch':
2327
raise errors.TokenMismatch(find('token'), '(remote token)')
2328
elif err.error_verb == 'Diverged':
2329
raise errors.DivergedBranches(find('branch'), find('other_branch'))
2330
elif err.error_verb == 'TipChangeRejected':
2331
raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
2332
elif err.error_verb == 'UnstackableBranchFormat':
2333
raise errors.UnstackableBranchFormat(*err.error_args)
2334
elif err.error_verb == 'UnstackableRepositoryFormat':
2335
raise errors.UnstackableRepositoryFormat(*err.error_args)
2336
elif err.error_verb == 'NotStacked':
2337
raise errors.NotStacked(branch=find('branch'))
2338
elif err.error_verb == 'PermissionDenied':
2340
if len(err.error_args) >= 2:
2341
extra = err.error_args[1]
2344
raise errors.PermissionDenied(path, extra=extra)
2345
elif err.error_verb == 'ReadError':
2347
raise errors.ReadError(path)
2348
elif err.error_verb == 'NoSuchFile':
2350
raise errors.NoSuchFile(path)
2351
elif err.error_verb == 'FileExists':
2352
raise errors.FileExists(err.error_args[0])
2353
elif err.error_verb == 'DirectoryNotEmpty':
2354
raise errors.DirectoryNotEmpty(err.error_args[0])
2355
elif err.error_verb == 'ShortReadvError':
2356
args = err.error_args
2357
raise errors.ShortReadvError(
2358
args[0], int(args[1]), int(args[2]), int(args[3]))
2359
elif err.error_verb in ('UnicodeEncodeError', 'UnicodeDecodeError'):
2360
encoding = str(err.error_args[0]) # encoding must always be a string
2361
val = err.error_args[1]
2362
start = int(err.error_args[2])
2363
end = int(err.error_args[3])
2364
reason = str(err.error_args[4]) # reason must always be a string
2365
if val.startswith('u:'):
2366
val = val[2:].decode('utf-8')
2367
elif val.startswith('s:'):
2368
val = val[2:].decode('base64')
2369
if err.error_verb == 'UnicodeDecodeError':
2370
raise UnicodeDecodeError(encoding, val, start, end, reason)
2371
elif err.error_verb == 'UnicodeEncodeError':
2372
raise UnicodeEncodeError(encoding, val, start, end, reason)
2373
elif err.error_verb == 'ReadOnlyError':
2374
raise errors.TransportNotPossible('readonly transport')
2375
raise errors.UnknownErrorFromSmartServer(err)