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.BzrError("May not fetch while in a write group.")
1140
# fast path same-url fetch operations
1141
if self.has_same_location(source) and fetch_spec is None:
1142
# check that last_revision is in 'from' and then return a
1144
if (revision_id is not None and
1145
not _mod_revision.is_null(revision_id)):
1146
self.get_revision(revision_id)
1148
# if there is no specific appropriate InterRepository, this will get
1149
# the InterRepository base class, which raises an
1150
# IncompatibleRepositories when asked to fetch.
1151
inter = repository.InterRepository.get(source, self)
1152
return inter.fetch(revision_id=revision_id, pb=pb,
1153
find_ghosts=find_ghosts, fetch_spec=fetch_spec)
1155
def create_bundle(self, target, base, fileobj, format=None):
1157
self._real_repository.create_bundle(target, base, fileobj, format)
1160
def get_ancestry(self, revision_id, topo_sorted=True):
1162
return self._real_repository.get_ancestry(revision_id, topo_sorted)
1164
def fileids_altered_by_revision_ids(self, revision_ids):
1166
return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
1168
def _get_versioned_file_checker(self, revisions, revision_versions_cache):
1170
return self._real_repository._get_versioned_file_checker(
1171
revisions, revision_versions_cache)
1173
def iter_files_bytes(self, desired_files):
1174
"""See Repository.iter_file_bytes.
1177
return self._real_repository.iter_files_bytes(desired_files)
1179
def get_parent_map(self, revision_ids):
1180
"""See bzrlib.Graph.get_parent_map()."""
1181
return self._make_parents_provider().get_parent_map(revision_ids)
1183
def _get_parent_map_rpc(self, keys):
1184
"""Helper for get_parent_map that performs the RPC."""
1185
medium = self._client._medium
1186
if medium._is_remote_before((1, 2)):
1187
# We already found out that the server can't understand
1188
# Repository.get_parent_map requests, so just fetch the whole
1190
# XXX: Note that this will issue a deprecation warning. This is ok
1191
# :- its because we're working with a deprecated server anyway, and
1192
# the user will almost certainly have seen a warning about the
1193
# server version already.
1194
rg = self.get_revision_graph()
1195
# There is an api discrepency between get_parent_map and
1196
# get_revision_graph. Specifically, a "key:()" pair in
1197
# get_revision_graph just means a node has no parents. For
1198
# "get_parent_map" it means the node is a ghost. So fix up the
1199
# graph to correct this.
1200
# https://bugs.launchpad.net/bzr/+bug/214894
1201
# There is one other "bug" which is that ghosts in
1202
# get_revision_graph() are not returned at all. But we won't worry
1203
# about that for now.
1204
for node_id, parent_ids in rg.iteritems():
1205
if parent_ids == ():
1206
rg[node_id] = (NULL_REVISION,)
1207
rg[NULL_REVISION] = ()
1212
raise ValueError('get_parent_map(None) is not valid')
1213
if NULL_REVISION in keys:
1214
keys.discard(NULL_REVISION)
1215
found_parents = {NULL_REVISION:()}
1217
return found_parents
1220
# TODO(Needs analysis): We could assume that the keys being requested
1221
# from get_parent_map are in a breadth first search, so typically they
1222
# will all be depth N from some common parent, and we don't have to
1223
# have the server iterate from the root parent, but rather from the
1224
# keys we're searching; and just tell the server the keyspace we
1225
# already have; but this may be more traffic again.
1227
# Transform self._parents_map into a search request recipe.
1228
# TODO: Manage this incrementally to avoid covering the same path
1229
# repeatedly. (The server will have to on each request, but the less
1230
# work done the better).
1231
parents_map = self._unstacked_provider.get_cached_map()
1232
if parents_map is None:
1233
# Repository is not locked, so there's no cache.
1235
start_set = set(parents_map)
1236
result_parents = set()
1237
for parents in parents_map.itervalues():
1238
result_parents.update(parents)
1239
stop_keys = result_parents.difference(start_set)
1240
included_keys = start_set.intersection(result_parents)
1241
start_set.difference_update(included_keys)
1242
recipe = (start_set, stop_keys, len(parents_map))
1243
body = self._serialise_search_recipe(recipe)
1244
path = self.bzrdir._path_for_remote_call(self._client)
1246
if type(key) is not str:
1248
"key %r not a plain string" % (key,))
1249
verb = 'Repository.get_parent_map'
1250
args = (path,) + tuple(keys)
1252
response = self._call_with_body_bytes_expecting_body(
1254
except errors.UnknownSmartMethod:
1255
# Server does not support this method, so get the whole graph.
1256
# Worse, we have to force a disconnection, because the server now
1257
# doesn't realise it has a body on the wire to consume, so the
1258
# only way to recover is to abandon the connection.
1260
'Server is too old for fast get_parent_map, reconnecting. '
1261
'(Upgrade the server to Bazaar 1.2 to avoid this)')
1263
# To avoid having to disconnect repeatedly, we keep track of the
1264
# fact the server doesn't understand remote methods added in 1.2.
1265
medium._remember_remote_is_before((1, 2))
1266
return self.get_revision_graph(None)
1267
response_tuple, response_handler = response
1268
if response_tuple[0] not in ['ok']:
1269
response_handler.cancel_read_body()
1270
raise errors.UnexpectedSmartServerResponse(response_tuple)
1271
if response_tuple[0] == 'ok':
1272
coded = bz2.decompress(response_handler.read_body_bytes())
1274
# no revisions found
1276
lines = coded.split('\n')
1279
d = tuple(line.split())
1281
revision_graph[d[0]] = d[1:]
1283
# No parents - so give the Graph result (NULL_REVISION,).
1284
revision_graph[d[0]] = (NULL_REVISION,)
1285
return revision_graph
1288
def get_signature_text(self, revision_id):
1290
return self._real_repository.get_signature_text(revision_id)
1293
@symbol_versioning.deprecated_method(symbol_versioning.one_three)
1294
def get_revision_graph_with_ghosts(self, revision_ids=None):
1296
return self._real_repository.get_revision_graph_with_ghosts(
1297
revision_ids=revision_ids)
1300
def get_inventory_xml(self, revision_id):
1302
return self._real_repository.get_inventory_xml(revision_id)
1304
def deserialise_inventory(self, revision_id, xml):
1306
return self._real_repository.deserialise_inventory(revision_id, xml)
1308
def reconcile(self, other=None, thorough=False):
1310
return self._real_repository.reconcile(other=other, thorough=thorough)
1312
def all_revision_ids(self):
1314
return self._real_repository.all_revision_ids()
1317
def get_deltas_for_revisions(self, revisions):
1319
return self._real_repository.get_deltas_for_revisions(revisions)
1322
def get_revision_delta(self, revision_id):
1324
return self._real_repository.get_revision_delta(revision_id)
1327
def revision_trees(self, revision_ids):
1329
return self._real_repository.revision_trees(revision_ids)
1332
def get_revision_reconcile(self, revision_id):
1334
return self._real_repository.get_revision_reconcile(revision_id)
1337
def check(self, revision_ids=None):
1339
return self._real_repository.check(revision_ids=revision_ids)
1341
def copy_content_into(self, destination, revision_id=None):
1343
return self._real_repository.copy_content_into(
1344
destination, revision_id=revision_id)
1346
def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
1347
# get a tarball of the remote repository, and copy from that into the
1349
from bzrlib import osutils
1351
# TODO: Maybe a progress bar while streaming the tarball?
1352
note("Copying repository content as tarball...")
1353
tar_file = self._get_tarball('bz2')
1354
if tar_file is None:
1356
destination = to_bzrdir.create_repository()
1358
tar = tarfile.open('repository', fileobj=tar_file,
1360
tmpdir = osutils.mkdtemp()
1362
_extract_tar(tar, tmpdir)
1363
tmp_bzrdir = BzrDir.open(tmpdir)
1364
tmp_repo = tmp_bzrdir.open_repository()
1365
tmp_repo.copy_content_into(destination, revision_id)
1367
osutils.rmtree(tmpdir)
1371
# TODO: Suggestion from john: using external tar is much faster than
1372
# python's tarfile library, but it may not work on windows.
1375
def inventories(self):
1376
"""Decorate the real repository for now.
1378
In the long term a full blown network facility is needed to
1379
avoid creating a real repository object locally.
1382
return self._real_repository.inventories
1386
"""Compress the data within the repository.
1388
This is not currently implemented within the smart server.
1391
return self._real_repository.pack()
1394
def revisions(self):
1395
"""Decorate the real repository for now.
1397
In the short term this should become a real object to intercept graph
1400
In the long term a full blown network facility is needed.
1403
return self._real_repository.revisions
1405
def set_make_working_trees(self, new_value):
1407
new_value_str = "True"
1409
new_value_str = "False"
1410
path = self.bzrdir._path_for_remote_call(self._client)
1412
response = self._call(
1413
'Repository.set_make_working_trees', path, new_value_str)
1414
except errors.UnknownSmartMethod:
1416
self._real_repository.set_make_working_trees(new_value)
1418
if response[0] != 'ok':
1419
raise errors.UnexpectedSmartServerResponse(response)
1422
def signatures(self):
1423
"""Decorate the real repository for now.
1425
In the long term a full blown network facility is needed to avoid
1426
creating a real repository object locally.
1429
return self._real_repository.signatures
1432
def sign_revision(self, revision_id, gpg_strategy):
1434
return self._real_repository.sign_revision(revision_id, gpg_strategy)
1438
"""Decorate the real repository for now.
1440
In the long term a full blown network facility is needed to avoid
1441
creating a real repository object locally.
1444
return self._real_repository.texts
1447
def get_revisions(self, revision_ids):
1449
return self._real_repository.get_revisions(revision_ids)
1451
def supports_rich_root(self):
1452
return self._format.rich_root_data
1454
def iter_reverse_revision_history(self, revision_id):
1456
return self._real_repository.iter_reverse_revision_history(revision_id)
1459
def _serializer(self):
1460
return self._format._serializer
1462
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1464
return self._real_repository.store_revision_signature(
1465
gpg_strategy, plaintext, revision_id)
1467
def add_signature_text(self, revision_id, signature):
1469
return self._real_repository.add_signature_text(revision_id, signature)
1471
def has_signature_for_revision_id(self, revision_id):
1473
return self._real_repository.has_signature_for_revision_id(revision_id)
1475
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
1477
return self._real_repository.item_keys_introduced_by(revision_ids,
1478
_files_pb=_files_pb)
1480
def revision_graph_can_have_wrong_parents(self):
1481
# The answer depends on the remote repo format.
1483
return self._real_repository.revision_graph_can_have_wrong_parents()
1485
def _find_inconsistent_revision_parents(self):
1487
return self._real_repository._find_inconsistent_revision_parents()
1489
def _check_for_inconsistent_revision_parents(self):
1491
return self._real_repository._check_for_inconsistent_revision_parents()
1493
def _make_parents_provider(self, other=None):
1494
providers = [self._unstacked_provider]
1495
if other is not None:
1496
providers.insert(0, other)
1497
providers.extend(r._make_parents_provider() for r in
1498
self._fallback_repositories)
1499
return graph._StackedParentsProvider(providers)
1501
def _serialise_search_recipe(self, recipe):
1502
"""Serialise a graph search recipe.
1504
:param recipe: A search recipe (start, stop, count).
1505
:return: Serialised bytes.
1507
start_keys = ' '.join(recipe[0])
1508
stop_keys = ' '.join(recipe[1])
1509
count = str(recipe[2])
1510
return '\n'.join((start_keys, stop_keys, count))
1512
def _serialise_search_result(self, search_result):
1513
if isinstance(search_result, graph.PendingAncestryResult):
1514
parts = ['ancestry-of']
1515
parts.extend(search_result.heads)
1517
recipe = search_result.get_recipe()
1518
parts = ['search', self._serialise_search_recipe(recipe)]
1519
return '\n'.join(parts)
1522
path = self.bzrdir._path_for_remote_call(self._client)
1524
response = self._call('PackRepository.autopack', path)
1525
except errors.UnknownSmartMethod:
1527
self._real_repository._pack_collection.autopack()
1530
if response[0] != 'ok':
1531
raise errors.UnexpectedSmartServerResponse(response)
1534
class RemoteStreamSink(repository.StreamSink):
1536
def _insert_real(self, stream, src_format, resume_tokens):
1537
self.target_repo._ensure_real()
1538
sink = self.target_repo._real_repository._get_sink()
1539
result = sink.insert_stream(stream, src_format, resume_tokens)
1541
self.target_repo.autopack()
1544
def insert_stream(self, stream, src_format, resume_tokens):
1545
repo = self.target_repo
1546
client = repo._client
1547
medium = client._medium
1548
if medium._is_remote_before((1, 13)):
1549
# No possible way this can work.
1550
return self._insert_real(stream, src_format, resume_tokens)
1551
path = repo.bzrdir._path_for_remote_call(client)
1552
if not resume_tokens:
1553
# XXX: Ugly but important for correctness, *will* be fixed during
1554
# 1.13 cycle. Pushing a stream that is interrupted results in a
1555
# fallback to the _real_repositories sink *with a partial stream*.
1556
# Thats bad because we insert less data than bzr expected. To avoid
1557
# this we do a trial push to make sure the verb is accessible, and
1558
# do not fallback when actually pushing the stream. A cleanup patch
1559
# is going to look at rewinding/restarting the stream/partial
1561
byte_stream = smart_repo._stream_to_byte_stream([], src_format)
1563
response = client.call_with_body_stream(
1564
('Repository.insert_stream', path, ''), byte_stream)
1565
except errors.UnknownSmartMethod:
1566
medium._remember_remote_is_before((1,13))
1567
return self._insert_real(stream, src_format, resume_tokens)
1568
byte_stream = smart_repo._stream_to_byte_stream(
1570
resume_tokens = ' '.join(resume_tokens)
1571
response = client.call_with_body_stream(
1572
('Repository.insert_stream', path, resume_tokens), byte_stream)
1573
if response[0][0] not in ('ok', 'missing-basis'):
1574
raise errors.UnexpectedSmartServerResponse(response)
1575
if response[0][0] == 'missing-basis':
1576
tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
1577
resume_tokens = tokens
1578
return resume_tokens, missing_keys
1580
self.target_repo.refresh_data()
1584
class RemoteStreamSource(repository.StreamSource):
1585
"""Stream data from a remote server."""
1587
def get_stream(self, search):
1588
# streaming with fallback repositories is not well defined yet: The
1589
# remote repository cannot see the fallback repositories, and thus
1590
# cannot satisfy the entire search in the general case. Likewise the
1591
# fallback repositories cannot reify the search to determine what they
1592
# should send. It likely needs a return value in the stream listing the
1593
# edge of the search to resume from in fallback repositories.
1594
if self.from_repository._fallback_repositories:
1595
return repository.StreamSource.get_stream(self, search)
1596
repo = self.from_repository
1597
client = repo._client
1598
medium = client._medium
1599
if medium._is_remote_before((1, 13)):
1600
# No possible way this can work.
1601
return repository.StreamSource.get_stream(self, search)
1602
path = repo.bzrdir._path_for_remote_call(client)
1604
search_bytes = repo._serialise_search_result(search)
1605
response = repo._call_with_body_bytes_expecting_body(
1606
'Repository.get_stream',
1607
(path, self.to_format.network_name()), search_bytes)
1608
response_tuple, response_handler = response
1609
except errors.UnknownSmartMethod:
1610
medium._remember_remote_is_before((1,13))
1611
return repository.StreamSource.get_stream(self, search)
1612
if response_tuple[0] != 'ok':
1613
raise errors.UnexpectedSmartServerResponse(response_tuple)
1614
byte_stream = response_handler.read_streamed_body()
1615
src_format, stream = smart_repo._byte_stream_to_stream(byte_stream)
1616
if src_format.network_name() != repo._format.network_name():
1617
raise AssertionError(
1618
"Mismatched RemoteRepository and stream src %r, %r" % (
1619
src_format.network_name(), repo._format.network_name()))
1623
class RemoteBranchLockableFiles(LockableFiles):
1624
"""A 'LockableFiles' implementation that talks to a smart server.
1626
This is not a public interface class.
1629
def __init__(self, bzrdir, _client):
1630
self.bzrdir = bzrdir
1631
self._client = _client
1632
self._need_find_modes = True
1633
LockableFiles.__init__(
1634
self, bzrdir.get_branch_transport(None),
1635
'lock', lockdir.LockDir)
1637
def _find_modes(self):
1638
# RemoteBranches don't let the client set the mode of control files.
1639
self._dir_mode = None
1640
self._file_mode = None
1643
class RemoteBranchFormat(branch.BranchFormat):
1645
def __init__(self, network_name=None):
1646
super(RemoteBranchFormat, self).__init__()
1647
self._matchingbzrdir = RemoteBzrDirFormat()
1648
self._matchingbzrdir.set_branch_format(self)
1649
self._custom_format = None
1650
self._network_name = network_name
1652
def __eq__(self, other):
1653
return (isinstance(other, RemoteBranchFormat) and
1654
self.__dict__ == other.__dict__)
1656
def _ensure_real(self):
1657
if self._custom_format is None:
1658
self._custom_format = branch.network_format_registry.get(
1661
def get_format_description(self):
1662
return 'Remote BZR Branch'
1664
def network_name(self):
1665
return self._network_name
1667
def open(self, a_bzrdir):
1668
return a_bzrdir.open_branch()
1670
def _vfs_initialize(self, a_bzrdir):
1671
# Initialisation when using a local bzrdir object, or a non-vfs init
1672
# method is not available on the server.
1673
# self._custom_format is always set - the start of initialize ensures
1675
if isinstance(a_bzrdir, RemoteBzrDir):
1676
a_bzrdir._ensure_real()
1677
result = self._custom_format.initialize(a_bzrdir._real_bzrdir)
1679
# We assume the bzrdir is parameterised; it may not be.
1680
result = self._custom_format.initialize(a_bzrdir)
1681
if (isinstance(a_bzrdir, RemoteBzrDir) and
1682
not isinstance(result, RemoteBranch)):
1683
result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result)
1686
def initialize(self, a_bzrdir):
1687
# 1) get the network name to use.
1688
if self._custom_format:
1689
network_name = self._custom_format.network_name()
1691
# Select the current bzrlib default and ask for that.
1692
reference_bzrdir_format = bzrdir.format_registry.get('default')()
1693
reference_format = reference_bzrdir_format.get_branch_format()
1694
self._custom_format = reference_format
1695
network_name = reference_format.network_name()
1696
# Being asked to create on a non RemoteBzrDir:
1697
if not isinstance(a_bzrdir, RemoteBzrDir):
1698
return self._vfs_initialize(a_bzrdir)
1699
medium = a_bzrdir._client._medium
1700
if medium._is_remote_before((1, 13)):
1701
return self._vfs_initialize(a_bzrdir)
1702
# Creating on a remote bzr dir.
1703
# 2) try direct creation via RPC
1704
path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
1705
verb = 'BzrDir.create_branch'
1707
response = a_bzrdir._call(verb, path, network_name)
1708
except errors.UnknownSmartMethod:
1709
# Fallback - use vfs methods
1710
medium._remember_remote_is_before((1, 13))
1711
return self._vfs_initialize(a_bzrdir)
1712
if response[0] != 'ok':
1713
raise errors.UnexpectedSmartServerResponse(response)
1714
# Turn the response into a RemoteRepository object.
1715
format = RemoteBranchFormat(network_name=response[1])
1716
repo_format = response_tuple_to_repo_format(response[3:])
1717
if response[2] == '':
1718
repo_bzrdir = a_bzrdir
1720
repo_bzrdir = RemoteBzrDir(
1721
a_bzrdir.root_transport.clone(response[2]), a_bzrdir._format,
1723
remote_repo = RemoteRepository(repo_bzrdir, repo_format)
1724
remote_branch = RemoteBranch(a_bzrdir, remote_repo,
1725
format=format, setup_stacking=False)
1726
# XXX: We know this is a new branch, so it must have revno 0, revid
1727
# NULL_REVISION. Creating the branch locked would make this be unable
1728
# to be wrong; here its simply very unlikely to be wrong. RBC 20090225
1729
remote_branch._last_revision_info_cache = 0, NULL_REVISION
1730
return remote_branch
1732
def make_tags(self, branch):
1734
return self._custom_format.make_tags(branch)
1736
def supports_tags(self):
1737
# Remote branches might support tags, but we won't know until we
1738
# access the real remote branch.
1740
return self._custom_format.supports_tags()
1742
def supports_stacking(self):
1744
return self._custom_format.supports_stacking()
1747
class RemoteBranch(branch.Branch, _RpcHelper):
1748
"""Branch stored on a server accessed by HPSS RPC.
1750
At the moment most operations are mapped down to simple file operations.
1753
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
1754
_client=None, format=None, setup_stacking=True):
1755
"""Create a RemoteBranch instance.
1757
:param real_branch: An optional local implementation of the branch
1758
format, usually accessing the data via the VFS.
1759
:param _client: Private parameter for testing.
1760
:param format: A RemoteBranchFormat object, None to create one
1761
automatically. If supplied it should have a network_name already
1763
:param setup_stacking: If True make an RPC call to determine the
1764
stacked (or not) status of the branch. If False assume the branch
1767
# We intentionally don't call the parent class's __init__, because it
1768
# will try to assign to self.tags, which is a property in this subclass.
1769
# And the parent's __init__ doesn't do much anyway.
1770
self._revision_id_to_revno_cache = None
1771
self._partial_revision_id_to_revno_cache = {}
1772
self._revision_history_cache = None
1773
self._last_revision_info_cache = None
1774
self._merge_sorted_revisions_cache = None
1775
self.bzrdir = remote_bzrdir
1776
if _client is not None:
1777
self._client = _client
1779
self._client = remote_bzrdir._client
1780
self.repository = remote_repository
1781
if real_branch is not None:
1782
self._real_branch = real_branch
1783
# Give the remote repository the matching real repo.
1784
real_repo = self._real_branch.repository
1785
if isinstance(real_repo, RemoteRepository):
1786
real_repo._ensure_real()
1787
real_repo = real_repo._real_repository
1788
self.repository._set_real_repository(real_repo)
1789
# Give the branch the remote repository to let fast-pathing happen.
1790
self._real_branch.repository = self.repository
1792
self._real_branch = None
1793
# Fill out expected attributes of branch for bzrlib api users.
1794
self.base = self.bzrdir.root_transport.base
1795
self._control_files = None
1796
self._lock_mode = None
1797
self._lock_token = None
1798
self._repo_lock_token = None
1799
self._lock_count = 0
1800
self._leave_lock = False
1801
# Setup a format: note that we cannot call _ensure_real until all the
1802
# attributes above are set: This code cannot be moved higher up in this
1805
self._format = RemoteBranchFormat()
1806
if real_branch is not None:
1807
self._format._network_name = \
1808
self._real_branch._format.network_name()
1810
self._format = format
1811
if not self._format._network_name:
1812
# Did not get from open_branchV2 - old server.
1814
self._format._network_name = \
1815
self._real_branch._format.network_name()
1816
self.tags = self._format.make_tags(self)
1817
# The base class init is not called, so we duplicate this:
1818
hooks = branch.Branch.hooks['open']
1822
self._setup_stacking()
1824
def _setup_stacking(self):
1825
# configure stacking into the remote repository, by reading it from
1828
fallback_url = self.get_stacked_on_url()
1829
except (errors.NotStacked, errors.UnstackableBranchFormat,
1830
errors.UnstackableRepositoryFormat), e:
1832
# it's relative to this branch...
1833
fallback_url = urlutils.join(self.base, fallback_url)
1834
transports = [self.bzrdir.root_transport]
1835
stacked_on = branch.Branch.open(fallback_url,
1836
possible_transports=transports)
1837
self.repository.add_fallback_repository(stacked_on.repository)
1839
def _get_real_transport(self):
1840
# if we try vfs access, return the real branch's vfs transport
1842
return self._real_branch._transport
1844
_transport = property(_get_real_transport)
1847
return "%s(%s)" % (self.__class__.__name__, self.base)
1851
def _ensure_real(self):
1852
"""Ensure that there is a _real_branch set.
1854
Used before calls to self._real_branch.
1856
if self._real_branch is None:
1857
if not vfs.vfs_enabled():
1858
raise AssertionError('smart server vfs must be enabled '
1859
'to use vfs implementation')
1860
self.bzrdir._ensure_real()
1861
self._real_branch = self.bzrdir._real_bzrdir.open_branch()
1862
if self.repository._real_repository is None:
1863
# Give the remote repository the matching real repo.
1864
real_repo = self._real_branch.repository
1865
if isinstance(real_repo, RemoteRepository):
1866
real_repo._ensure_real()
1867
real_repo = real_repo._real_repository
1868
self.repository._set_real_repository(real_repo)
1869
# Give the real branch the remote repository to let fast-pathing
1871
self._real_branch.repository = self.repository
1872
if self._lock_mode == 'r':
1873
self._real_branch.lock_read()
1874
elif self._lock_mode == 'w':
1875
self._real_branch.lock_write(token=self._lock_token)
1877
def _translate_error(self, err, **context):
1878
self.repository._translate_error(err, branch=self, **context)
1880
def _clear_cached_state(self):
1881
super(RemoteBranch, self)._clear_cached_state()
1882
if self._real_branch is not None:
1883
self._real_branch._clear_cached_state()
1885
def _clear_cached_state_of_remote_branch_only(self):
1886
"""Like _clear_cached_state, but doesn't clear the cache of
1889
This is useful when falling back to calling a method of
1890
self._real_branch that changes state. In that case the underlying
1891
branch changes, so we need to invalidate this RemoteBranch's cache of
1892
it. However, there's no need to invalidate the _real_branch's cache
1893
too, in fact doing so might harm performance.
1895
super(RemoteBranch, self)._clear_cached_state()
1898
def control_files(self):
1899
# Defer actually creating RemoteBranchLockableFiles until its needed,
1900
# because it triggers an _ensure_real that we otherwise might not need.
1901
if self._control_files is None:
1902
self._control_files = RemoteBranchLockableFiles(
1903
self.bzrdir, self._client)
1904
return self._control_files
1906
def _get_checkout_format(self):
1908
return self._real_branch._get_checkout_format()
1910
def get_physical_lock_status(self):
1911
"""See Branch.get_physical_lock_status()."""
1912
# should be an API call to the server, as branches must be lockable.
1914
return self._real_branch.get_physical_lock_status()
1916
def get_stacked_on_url(self):
1917
"""Get the URL this branch is stacked against.
1919
:raises NotStacked: If the branch is not stacked.
1920
:raises UnstackableBranchFormat: If the branch does not support
1922
:raises UnstackableRepositoryFormat: If the repository does not support
1926
# there may not be a repository yet, so we can't use
1927
# self._translate_error, so we can't use self._call either.
1928
response = self._client.call('Branch.get_stacked_on_url',
1929
self._remote_path())
1930
except errors.ErrorFromSmartServer, err:
1931
# there may not be a repository yet, so we can't call through
1932
# its _translate_error
1933
_translate_error(err, branch=self)
1934
except errors.UnknownSmartMethod, err:
1936
return self._real_branch.get_stacked_on_url()
1937
if response[0] != 'ok':
1938
raise errors.UnexpectedSmartServerResponse(response)
1941
def _vfs_get_tags_bytes(self):
1943
return self._real_branch._get_tags_bytes()
1945
def _get_tags_bytes(self):
1946
medium = self._client._medium
1947
if medium._is_remote_before((1, 13)):
1948
return self._vfs_get_tags_bytes()
1950
response = self._call('Branch.get_tags_bytes', self._remote_path())
1951
except errors.UnknownSmartMethod:
1952
medium._remember_remote_is_before((1, 13))
1953
return self._vfs_get_tags_bytes()
1956
def lock_read(self):
1957
self.repository.lock_read()
1958
if not self._lock_mode:
1959
self._lock_mode = 'r'
1960
self._lock_count = 1
1961
if self._real_branch is not None:
1962
self._real_branch.lock_read()
1964
self._lock_count += 1
1966
def _remote_lock_write(self, token):
1968
branch_token = repo_token = ''
1970
branch_token = token
1971
repo_token = self.repository.lock_write()
1972
self.repository.unlock()
1973
err_context = {'token': token}
1974
response = self._call(
1975
'Branch.lock_write', self._remote_path(), branch_token,
1976
repo_token or '', **err_context)
1977
if response[0] != 'ok':
1978
raise errors.UnexpectedSmartServerResponse(response)
1979
ok, branch_token, repo_token = response
1980
return branch_token, repo_token
1982
def lock_write(self, token=None):
1983
if not self._lock_mode:
1984
# Lock the branch and repo in one remote call.
1985
remote_tokens = self._remote_lock_write(token)
1986
self._lock_token, self._repo_lock_token = remote_tokens
1987
if not self._lock_token:
1988
raise SmartProtocolError('Remote server did not return a token!')
1989
# Tell the self.repository object that it is locked.
1990
self.repository.lock_write(
1991
self._repo_lock_token, _skip_rpc=True)
1993
if self._real_branch is not None:
1994
self._real_branch.lock_write(token=self._lock_token)
1995
if token is not None:
1996
self._leave_lock = True
1998
self._leave_lock = False
1999
self._lock_mode = 'w'
2000
self._lock_count = 1
2001
elif self._lock_mode == 'r':
2002
raise errors.ReadOnlyTransaction
2004
if token is not None:
2005
# A token was given to lock_write, and we're relocking, so
2006
# check that the given token actually matches the one we
2008
if token != self._lock_token:
2009
raise errors.TokenMismatch(token, self._lock_token)
2010
self._lock_count += 1
2011
# Re-lock the repository too.
2012
self.repository.lock_write(self._repo_lock_token)
2013
return self._lock_token or None
2015
def _set_tags_bytes(self, bytes):
2017
return self._real_branch._set_tags_bytes(bytes)
2019
def _unlock(self, branch_token, repo_token):
2020
err_context = {'token': str((branch_token, repo_token))}
2021
response = self._call(
2022
'Branch.unlock', self._remote_path(), branch_token,
2023
repo_token or '', **err_context)
2024
if response == ('ok',):
2026
raise errors.UnexpectedSmartServerResponse(response)
2030
self._lock_count -= 1
2031
if not self._lock_count:
2032
self._clear_cached_state()
2033
mode = self._lock_mode
2034
self._lock_mode = None
2035
if self._real_branch is not None:
2036
if (not self._leave_lock and mode == 'w' and
2037
self._repo_lock_token):
2038
# If this RemoteBranch will remove the physical lock
2039
# for the repository, make sure the _real_branch
2040
# doesn't do it first. (Because the _real_branch's
2041
# repository is set to be the RemoteRepository.)
2042
self._real_branch.repository.leave_lock_in_place()
2043
self._real_branch.unlock()
2045
# Only write-locked branched need to make a remote method
2046
# call to perfom the unlock.
2048
if not self._lock_token:
2049
raise AssertionError('Locked, but no token!')
2050
branch_token = self._lock_token
2051
repo_token = self._repo_lock_token
2052
self._lock_token = None
2053
self._repo_lock_token = None
2054
if not self._leave_lock:
2055
self._unlock(branch_token, repo_token)
2057
self.repository.unlock()
2059
def break_lock(self):
2061
return self._real_branch.break_lock()
2063
def leave_lock_in_place(self):
2064
if not self._lock_token:
2065
raise NotImplementedError(self.leave_lock_in_place)
2066
self._leave_lock = True
2068
def dont_leave_lock_in_place(self):
2069
if not self._lock_token:
2070
raise NotImplementedError(self.dont_leave_lock_in_place)
2071
self._leave_lock = False
2073
def _last_revision_info(self):
2074
response = self._call('Branch.last_revision_info', self._remote_path())
2075
if response[0] != 'ok':
2076
raise SmartProtocolError('unexpected response code %s' % (response,))
2077
revno = int(response[1])
2078
last_revision = response[2]
2079
return (revno, last_revision)
2081
def _gen_revision_history(self):
2082
"""See Branch._gen_revision_history()."""
2083
response_tuple, response_handler = self._call_expecting_body(
2084
'Branch.revision_history', self._remote_path())
2085
if response_tuple[0] != 'ok':
2086
raise errors.UnexpectedSmartServerResponse(response_tuple)
2087
result = response_handler.read_body_bytes().split('\x00')
2092
def _remote_path(self):
2093
return self.bzrdir._path_for_remote_call(self._client)
2095
def _set_last_revision_descendant(self, revision_id, other_branch,
2096
allow_diverged=False, allow_overwrite_descendant=False):
2097
# This performs additional work to meet the hook contract; while its
2098
# undesirable, we have to synthesise the revno to call the hook, and
2099
# not calling the hook is worse as it means changes can't be prevented.
2100
# Having calculated this though, we can't just call into
2101
# set_last_revision_info as a simple call, because there is a set_rh
2102
# hook that some folk may still be using.
2103
old_revno, old_revid = self.last_revision_info()
2104
history = self._lefthand_history(revision_id)
2105
self._run_pre_change_branch_tip_hooks(len(history), revision_id)
2106
err_context = {'other_branch': other_branch}
2107
response = self._call('Branch.set_last_revision_ex',
2108
self._remote_path(), self._lock_token, self._repo_lock_token,
2109
revision_id, int(allow_diverged), int(allow_overwrite_descendant),
2111
self._clear_cached_state()
2112
if len(response) != 3 and response[0] != 'ok':
2113
raise errors.UnexpectedSmartServerResponse(response)
2114
new_revno, new_revision_id = response[1:]
2115
self._last_revision_info_cache = new_revno, new_revision_id
2116
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2117
if self._real_branch is not None:
2118
cache = new_revno, new_revision_id
2119
self._real_branch._last_revision_info_cache = cache
2121
def _set_last_revision(self, revision_id):
2122
old_revno, old_revid = self.last_revision_info()
2123
# This performs additional work to meet the hook contract; while its
2124
# undesirable, we have to synthesise the revno to call the hook, and
2125
# not calling the hook is worse as it means changes can't be prevented.
2126
# Having calculated this though, we can't just call into
2127
# set_last_revision_info as a simple call, because there is a set_rh
2128
# hook that some folk may still be using.
2129
history = self._lefthand_history(revision_id)
2130
self._run_pre_change_branch_tip_hooks(len(history), revision_id)
2131
self._clear_cached_state()
2132
response = self._call('Branch.set_last_revision',
2133
self._remote_path(), self._lock_token, self._repo_lock_token,
2135
if response != ('ok',):
2136
raise errors.UnexpectedSmartServerResponse(response)
2137
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2140
def set_revision_history(self, rev_history):
2141
# Send just the tip revision of the history; the server will generate
2142
# the full history from that. If the revision doesn't exist in this
2143
# branch, NoSuchRevision will be raised.
2144
if rev_history == []:
2147
rev_id = rev_history[-1]
2148
self._set_last_revision(rev_id)
2149
for hook in branch.Branch.hooks['set_rh']:
2150
hook(self, rev_history)
2151
self._cache_revision_history(rev_history)
2153
def _get_parent_location(self):
2154
medium = self._client._medium
2155
if medium._is_remote_before((1, 13)):
2156
return self._vfs_get_parent_location()
2158
response = self._call('Branch.get_parent', self._remote_path())
2159
except errors.UnknownSmartMethod:
2160
medium._remember_remote_is_before((1, 13))
2161
return self._vfs_get_parent_location()
2162
if len(response) != 1:
2163
raise errors.UnexpectedSmartServerResponse(response)
2164
parent_location = response[0]
2165
if parent_location == '':
2167
return parent_location
2169
def _vfs_get_parent_location(self):
2171
return self._real_branch._get_parent_location()
2173
def set_parent(self, url):
2175
return self._real_branch.set_parent(url)
2177
def _set_parent_location(self, url):
2178
# Used by tests, to poke bad urls into branch configurations
2180
self.set_parent(url)
2183
return self._real_branch._set_parent_location(url)
2185
def set_stacked_on_url(self, stacked_location):
2186
"""Set the URL this branch is stacked against.
2188
:raises UnstackableBranchFormat: If the branch does not support
2190
:raises UnstackableRepositoryFormat: If the repository does not support
2194
return self._real_branch.set_stacked_on_url(stacked_location)
2197
def pull(self, source, overwrite=False, stop_revision=None,
2199
self._clear_cached_state_of_remote_branch_only()
2201
return self._real_branch.pull(
2202
source, overwrite=overwrite, stop_revision=stop_revision,
2203
_override_hook_target=self, **kwargs)
2206
def push(self, target, overwrite=False, stop_revision=None):
2208
return self._real_branch.push(
2209
target, overwrite=overwrite, stop_revision=stop_revision,
2210
_override_hook_source_branch=self)
2212
def is_locked(self):
2213
return self._lock_count >= 1
2216
def revision_id_to_revno(self, revision_id):
2218
return self._real_branch.revision_id_to_revno(revision_id)
2221
def set_last_revision_info(self, revno, revision_id):
2222
# XXX: These should be returned by the set_last_revision_info verb
2223
old_revno, old_revid = self.last_revision_info()
2224
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2225
revision_id = ensure_null(revision_id)
2227
response = self._call('Branch.set_last_revision_info',
2228
self._remote_path(), self._lock_token, self._repo_lock_token,
2229
str(revno), revision_id)
2230
except errors.UnknownSmartMethod:
2232
self._clear_cached_state_of_remote_branch_only()
2233
self._real_branch.set_last_revision_info(revno, revision_id)
2234
self._last_revision_info_cache = revno, revision_id
2236
if response == ('ok',):
2237
self._clear_cached_state()
2238
self._last_revision_info_cache = revno, revision_id
2239
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2240
# Update the _real_branch's cache too.
2241
if self._real_branch is not None:
2242
cache = self._last_revision_info_cache
2243
self._real_branch._last_revision_info_cache = cache
2245
raise errors.UnexpectedSmartServerResponse(response)
2248
def generate_revision_history(self, revision_id, last_rev=None,
2250
medium = self._client._medium
2251
if not medium._is_remote_before((1, 6)):
2252
# Use a smart method for 1.6 and above servers
2254
self._set_last_revision_descendant(revision_id, other_branch,
2255
allow_diverged=True, allow_overwrite_descendant=True)
2257
except errors.UnknownSmartMethod:
2258
medium._remember_remote_is_before((1, 6))
2259
self._clear_cached_state_of_remote_branch_only()
2260
self.set_revision_history(self._lefthand_history(revision_id,
2261
last_rev=last_rev,other_branch=other_branch))
2263
def set_push_location(self, location):
2265
return self._real_branch.set_push_location(location)
2268
def _extract_tar(tar, to_dir):
2269
"""Extract all the contents of a tarfile object.
2271
A replacement for extractall, which is not present in python2.4
2274
tar.extract(tarinfo, to_dir)
2277
def _translate_error(err, **context):
2278
"""Translate an ErrorFromSmartServer into a more useful error.
2280
Possible context keys:
2288
If the error from the server doesn't match a known pattern, then
2289
UnknownErrorFromSmartServer is raised.
2293
return context[name]
2294
except KeyError, key_err:
2295
mutter('Missing key %r in context %r', key_err.args[0], context)
2298
"""Get the path from the context if present, otherwise use first error
2302
return context['path']
2303
except KeyError, key_err:
2305
return err.error_args[0]
2306
except IndexError, idx_err:
2308
'Missing key %r in context %r', key_err.args[0], context)
2311
if err.error_verb == 'NoSuchRevision':
2312
raise NoSuchRevision(find('branch'), err.error_args[0])
2313
elif err.error_verb == 'nosuchrevision':
2314
raise NoSuchRevision(find('repository'), err.error_args[0])
2315
elif err.error_tuple == ('nobranch',):
2316
raise errors.NotBranchError(path=find('bzrdir').root_transport.base)
2317
elif err.error_verb == 'norepository':
2318
raise errors.NoRepositoryPresent(find('bzrdir'))
2319
elif err.error_verb == 'LockContention':
2320
raise errors.LockContention('(remote lock)')
2321
elif err.error_verb == 'UnlockableTransport':
2322
raise errors.UnlockableTransport(find('bzrdir').root_transport)
2323
elif err.error_verb == 'LockFailed':
2324
raise errors.LockFailed(err.error_args[0], err.error_args[1])
2325
elif err.error_verb == 'TokenMismatch':
2326
raise errors.TokenMismatch(find('token'), '(remote token)')
2327
elif err.error_verb == 'Diverged':
2328
raise errors.DivergedBranches(find('branch'), find('other_branch'))
2329
elif err.error_verb == 'TipChangeRejected':
2330
raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
2331
elif err.error_verb == 'UnstackableBranchFormat':
2332
raise errors.UnstackableBranchFormat(*err.error_args)
2333
elif err.error_verb == 'UnstackableRepositoryFormat':
2334
raise errors.UnstackableRepositoryFormat(*err.error_args)
2335
elif err.error_verb == 'NotStacked':
2336
raise errors.NotStacked(branch=find('branch'))
2337
elif err.error_verb == 'PermissionDenied':
2339
if len(err.error_args) >= 2:
2340
extra = err.error_args[1]
2343
raise errors.PermissionDenied(path, extra=extra)
2344
elif err.error_verb == 'ReadError':
2346
raise errors.ReadError(path)
2347
elif err.error_verb == 'NoSuchFile':
2349
raise errors.NoSuchFile(path)
2350
elif err.error_verb == 'FileExists':
2351
raise errors.FileExists(err.error_args[0])
2352
elif err.error_verb == 'DirectoryNotEmpty':
2353
raise errors.DirectoryNotEmpty(err.error_args[0])
2354
elif err.error_verb == 'ShortReadvError':
2355
args = err.error_args
2356
raise errors.ShortReadvError(
2357
args[0], int(args[1]), int(args[2]), int(args[3]))
2358
elif err.error_verb in ('UnicodeEncodeError', 'UnicodeDecodeError'):
2359
encoding = str(err.error_args[0]) # encoding must always be a string
2360
val = err.error_args[1]
2361
start = int(err.error_args[2])
2362
end = int(err.error_args[3])
2363
reason = str(err.error_args[4]) # reason must always be a string
2364
if val.startswith('u:'):
2365
val = val[2:].decode('utf-8')
2366
elif val.startswith('s:'):
2367
val = val[2:].decode('base64')
2368
if err.error_verb == 'UnicodeDecodeError':
2369
raise UnicodeDecodeError(encoding, val, start, end, reason)
2370
elif err.error_verb == 'UnicodeEncodeError':
2371
raise UnicodeEncodeError(encoding, val, start, end, reason)
2372
elif err.error_verb == 'ReadOnlyError':
2373
raise errors.TransportNotPossible('readonly transport')
2374
raise errors.UnknownErrorFromSmartServer(err)