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 revision_ids_to_search_result(self, result_set):
1094
"""Convert a set of revision ids to a graph SearchResult."""
1095
result_parents = set()
1096
for parents in self.get_graph().get_parent_map(
1097
result_set).itervalues():
1098
result_parents.update(parents)
1099
included_keys = result_set.intersection(result_parents)
1100
start_keys = result_set.difference(included_keys)
1101
exclude_keys = result_parents.difference(result_set)
1102
result = graph.SearchResult(start_keys, exclude_keys,
1103
len(result_set), result_set)
1107
def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1108
"""Return the revision ids that other has that this does not.
1110
These are returned in topological order.
1112
revision_id: only return revision ids included by revision_id.
1114
return repository.InterRepository.get(
1115
other, self).search_missing_revision_ids(revision_id, find_ghosts)
1117
def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
1119
# No base implementation to use as RemoteRepository is not a subclass
1120
# of Repository; so this is a copy of Repository.fetch().
1121
if fetch_spec is not None and revision_id is not None:
1122
raise AssertionError(
1123
"fetch_spec and revision_id are mutually exclusive.")
1124
if self.is_in_write_group():
1125
raise errors.BzrError("May not fetch while in a write group.")
1126
# fast path same-url fetch operations
1127
if self.has_same_location(source) and fetch_spec is None:
1128
# check that last_revision is in 'from' and then return a
1130
if (revision_id is not None and
1131
not _mod_revision.is_null(revision_id)):
1132
self.get_revision(revision_id)
1134
# if there is no specific appropriate InterRepository, this will get
1135
# the InterRepository base class, which raises an
1136
# IncompatibleRepositories when asked to fetch.
1137
inter = InterRepository.get(source, self)
1138
return inter.fetch(revision_id=revision_id, pb=pb,
1139
find_ghosts=find_ghosts, fetch_spec=fetch_spec)
1141
def create_bundle(self, target, base, fileobj, format=None):
1143
self._real_repository.create_bundle(target, base, fileobj, format)
1146
def get_ancestry(self, revision_id, topo_sorted=True):
1148
return self._real_repository.get_ancestry(revision_id, topo_sorted)
1150
def fileids_altered_by_revision_ids(self, revision_ids):
1152
return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
1154
def _get_versioned_file_checker(self, revisions, revision_versions_cache):
1156
return self._real_repository._get_versioned_file_checker(
1157
revisions, revision_versions_cache)
1159
def iter_files_bytes(self, desired_files):
1160
"""See Repository.iter_file_bytes.
1163
return self._real_repository.iter_files_bytes(desired_files)
1165
def get_parent_map(self, revision_ids):
1166
"""See bzrlib.Graph.get_parent_map()."""
1167
return self._make_parents_provider().get_parent_map(revision_ids)
1169
def _get_parent_map_rpc(self, keys):
1170
"""Helper for get_parent_map that performs the RPC."""
1171
medium = self._client._medium
1172
if medium._is_remote_before((1, 2)):
1173
# We already found out that the server can't understand
1174
# Repository.get_parent_map requests, so just fetch the whole
1176
# XXX: Note that this will issue a deprecation warning. This is ok
1177
# :- its because we're working with a deprecated server anyway, and
1178
# the user will almost certainly have seen a warning about the
1179
# server version already.
1180
rg = self.get_revision_graph()
1181
# There is an api discrepency between get_parent_map and
1182
# get_revision_graph. Specifically, a "key:()" pair in
1183
# get_revision_graph just means a node has no parents. For
1184
# "get_parent_map" it means the node is a ghost. So fix up the
1185
# graph to correct this.
1186
# https://bugs.launchpad.net/bzr/+bug/214894
1187
# There is one other "bug" which is that ghosts in
1188
# get_revision_graph() are not returned at all. But we won't worry
1189
# about that for now.
1190
for node_id, parent_ids in rg.iteritems():
1191
if parent_ids == ():
1192
rg[node_id] = (NULL_REVISION,)
1193
rg[NULL_REVISION] = ()
1198
raise ValueError('get_parent_map(None) is not valid')
1199
if NULL_REVISION in keys:
1200
keys.discard(NULL_REVISION)
1201
found_parents = {NULL_REVISION:()}
1203
return found_parents
1206
# TODO(Needs analysis): We could assume that the keys being requested
1207
# from get_parent_map are in a breadth first search, so typically they
1208
# will all be depth N from some common parent, and we don't have to
1209
# have the server iterate from the root parent, but rather from the
1210
# keys we're searching; and just tell the server the keyspace we
1211
# already have; but this may be more traffic again.
1213
# Transform self._parents_map into a search request recipe.
1214
# TODO: Manage this incrementally to avoid covering the same path
1215
# repeatedly. (The server will have to on each request, but the less
1216
# work done the better).
1217
parents_map = self._unstacked_provider.get_cached_map()
1218
if parents_map is None:
1219
# Repository is not locked, so there's no cache.
1221
start_set = set(parents_map)
1222
result_parents = set()
1223
for parents in parents_map.itervalues():
1224
result_parents.update(parents)
1225
stop_keys = result_parents.difference(start_set)
1226
included_keys = start_set.intersection(result_parents)
1227
start_set.difference_update(included_keys)
1228
recipe = (start_set, stop_keys, len(parents_map))
1229
body = self._serialise_search_recipe(recipe)
1230
path = self.bzrdir._path_for_remote_call(self._client)
1232
if type(key) is not str:
1234
"key %r not a plain string" % (key,))
1235
verb = 'Repository.get_parent_map'
1236
args = (path,) + tuple(keys)
1238
response = self._call_with_body_bytes_expecting_body(
1240
except errors.UnknownSmartMethod:
1241
# Server does not support this method, so get the whole graph.
1242
# Worse, we have to force a disconnection, because the server now
1243
# doesn't realise it has a body on the wire to consume, so the
1244
# only way to recover is to abandon the connection.
1246
'Server is too old for fast get_parent_map, reconnecting. '
1247
'(Upgrade the server to Bazaar 1.2 to avoid this)')
1249
# To avoid having to disconnect repeatedly, we keep track of the
1250
# fact the server doesn't understand remote methods added in 1.2.
1251
medium._remember_remote_is_before((1, 2))
1252
return self.get_revision_graph(None)
1253
response_tuple, response_handler = response
1254
if response_tuple[0] not in ['ok']:
1255
response_handler.cancel_read_body()
1256
raise errors.UnexpectedSmartServerResponse(response_tuple)
1257
if response_tuple[0] == 'ok':
1258
coded = bz2.decompress(response_handler.read_body_bytes())
1260
# no revisions found
1262
lines = coded.split('\n')
1265
d = tuple(line.split())
1267
revision_graph[d[0]] = d[1:]
1269
# No parents - so give the Graph result (NULL_REVISION,).
1270
revision_graph[d[0]] = (NULL_REVISION,)
1271
return revision_graph
1274
def get_signature_text(self, revision_id):
1276
return self._real_repository.get_signature_text(revision_id)
1279
@symbol_versioning.deprecated_method(symbol_versioning.one_three)
1280
def get_revision_graph_with_ghosts(self, revision_ids=None):
1282
return self._real_repository.get_revision_graph_with_ghosts(
1283
revision_ids=revision_ids)
1286
def get_inventory_xml(self, revision_id):
1288
return self._real_repository.get_inventory_xml(revision_id)
1290
def deserialise_inventory(self, revision_id, xml):
1292
return self._real_repository.deserialise_inventory(revision_id, xml)
1294
def reconcile(self, other=None, thorough=False):
1296
return self._real_repository.reconcile(other=other, thorough=thorough)
1298
def all_revision_ids(self):
1300
return self._real_repository.all_revision_ids()
1303
def get_deltas_for_revisions(self, revisions):
1305
return self._real_repository.get_deltas_for_revisions(revisions)
1308
def get_revision_delta(self, revision_id):
1310
return self._real_repository.get_revision_delta(revision_id)
1313
def revision_trees(self, revision_ids):
1315
return self._real_repository.revision_trees(revision_ids)
1318
def get_revision_reconcile(self, revision_id):
1320
return self._real_repository.get_revision_reconcile(revision_id)
1323
def check(self, revision_ids=None):
1325
return self._real_repository.check(revision_ids=revision_ids)
1327
def copy_content_into(self, destination, revision_id=None):
1329
return self._real_repository.copy_content_into(
1330
destination, revision_id=revision_id)
1332
def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
1333
# get a tarball of the remote repository, and copy from that into the
1335
from bzrlib import osutils
1337
# TODO: Maybe a progress bar while streaming the tarball?
1338
note("Copying repository content as tarball...")
1339
tar_file = self._get_tarball('bz2')
1340
if tar_file is None:
1342
destination = to_bzrdir.create_repository()
1344
tar = tarfile.open('repository', fileobj=tar_file,
1346
tmpdir = osutils.mkdtemp()
1348
_extract_tar(tar, tmpdir)
1349
tmp_bzrdir = BzrDir.open(tmpdir)
1350
tmp_repo = tmp_bzrdir.open_repository()
1351
tmp_repo.copy_content_into(destination, revision_id)
1353
osutils.rmtree(tmpdir)
1357
# TODO: Suggestion from john: using external tar is much faster than
1358
# python's tarfile library, but it may not work on windows.
1361
def inventories(self):
1362
"""Decorate the real repository for now.
1364
In the long term a full blown network facility is needed to
1365
avoid creating a real repository object locally.
1368
return self._real_repository.inventories
1372
"""Compress the data within the repository.
1374
This is not currently implemented within the smart server.
1377
return self._real_repository.pack()
1380
def revisions(self):
1381
"""Decorate the real repository for now.
1383
In the short term this should become a real object to intercept graph
1386
In the long term a full blown network facility is needed.
1389
return self._real_repository.revisions
1391
def set_make_working_trees(self, new_value):
1393
new_value_str = "True"
1395
new_value_str = "False"
1396
path = self.bzrdir._path_for_remote_call(self._client)
1398
response = self._call(
1399
'Repository.set_make_working_trees', path, new_value_str)
1400
except errors.UnknownSmartMethod:
1402
self._real_repository.set_make_working_trees(new_value)
1404
if response[0] != 'ok':
1405
raise errors.UnexpectedSmartServerResponse(response)
1408
def signatures(self):
1409
"""Decorate the real repository for now.
1411
In the long term a full blown network facility is needed to avoid
1412
creating a real repository object locally.
1415
return self._real_repository.signatures
1418
def sign_revision(self, revision_id, gpg_strategy):
1420
return self._real_repository.sign_revision(revision_id, gpg_strategy)
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.texts
1433
def get_revisions(self, revision_ids):
1435
return self._real_repository.get_revisions(revision_ids)
1437
def supports_rich_root(self):
1438
return self._format.rich_root_data
1440
def iter_reverse_revision_history(self, revision_id):
1442
return self._real_repository.iter_reverse_revision_history(revision_id)
1445
def _serializer(self):
1446
return self._format._serializer
1448
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1450
return self._real_repository.store_revision_signature(
1451
gpg_strategy, plaintext, revision_id)
1453
def add_signature_text(self, revision_id, signature):
1455
return self._real_repository.add_signature_text(revision_id, signature)
1457
def has_signature_for_revision_id(self, revision_id):
1459
return self._real_repository.has_signature_for_revision_id(revision_id)
1461
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
1463
return self._real_repository.item_keys_introduced_by(revision_ids,
1464
_files_pb=_files_pb)
1466
def revision_graph_can_have_wrong_parents(self):
1467
# The answer depends on the remote repo format.
1469
return self._real_repository.revision_graph_can_have_wrong_parents()
1471
def _find_inconsistent_revision_parents(self):
1473
return self._real_repository._find_inconsistent_revision_parents()
1475
def _check_for_inconsistent_revision_parents(self):
1477
return self._real_repository._check_for_inconsistent_revision_parents()
1479
def _make_parents_provider(self, other=None):
1480
providers = [self._unstacked_provider]
1481
if other is not None:
1482
providers.insert(0, other)
1483
providers.extend(r._make_parents_provider() for r in
1484
self._fallback_repositories)
1485
return graph._StackedParentsProvider(providers)
1487
def _serialise_search_recipe(self, recipe):
1488
"""Serialise a graph search recipe.
1490
:param recipe: A search recipe (start, stop, count).
1491
:return: Serialised bytes.
1493
start_keys = ' '.join(recipe[0])
1494
stop_keys = ' '.join(recipe[1])
1495
count = str(recipe[2])
1496
return '\n'.join((start_keys, stop_keys, count))
1498
def _serialise_search_result(self, search_result):
1499
if isinstance(search_result, graph.PendingAncestryResult):
1500
parts = ['ancestry-of']
1501
parts.extend(search_result.heads)
1503
recipe = search_result.get_recipe()
1504
parts = ['search', self._serialise_search_recipe(recipe)]
1505
return '\n'.join(parts)
1508
path = self.bzrdir._path_for_remote_call(self._client)
1510
response = self._call('PackRepository.autopack', path)
1511
except errors.UnknownSmartMethod:
1513
self._real_repository._pack_collection.autopack()
1515
if self._real_repository is not None:
1516
# Reset the real repository's cache of pack names.
1517
# XXX: At some point we may be able to skip this and just rely on
1518
# the automatic retry logic to do the right thing, but for now we
1519
# err on the side of being correct rather than being optimal.
1520
self._real_repository._pack_collection.reload_pack_names()
1521
if response[0] != 'ok':
1522
raise errors.UnexpectedSmartServerResponse(response)
1525
class RemoteStreamSink(repository.StreamSink):
1527
def _insert_real(self, stream, src_format, resume_tokens):
1528
self.target_repo._ensure_real()
1529
sink = self.target_repo._real_repository._get_sink()
1530
result = sink.insert_stream(stream, src_format, resume_tokens)
1532
self.target_repo.autopack()
1535
def insert_stream(self, stream, src_format, resume_tokens):
1536
repo = self.target_repo
1537
client = repo._client
1538
medium = client._medium
1539
if medium._is_remote_before((1, 13)):
1540
# No possible way this can work.
1541
return self._insert_real(stream, src_format, resume_tokens)
1542
path = repo.bzrdir._path_for_remote_call(client)
1543
if not resume_tokens:
1544
# XXX: Ugly but important for correctness, *will* be fixed during
1545
# 1.13 cycle. Pushing a stream that is interrupted results in a
1546
# fallback to the _real_repositories sink *with a partial stream*.
1547
# Thats bad because we insert less data than bzr expected. To avoid
1548
# this we do a trial push to make sure the verb is accessible, and
1549
# do not fallback when actually pushing the stream. A cleanup patch
1550
# is going to look at rewinding/restarting the stream/partial
1552
byte_stream = smart_repo._stream_to_byte_stream([], src_format)
1554
response = client.call_with_body_stream(
1555
('Repository.insert_stream', path, ''), byte_stream)
1556
except errors.UnknownSmartMethod:
1557
medium._remember_remote_is_before((1,13))
1558
return self._insert_real(stream, src_format, resume_tokens)
1559
byte_stream = smart_repo._stream_to_byte_stream(
1561
resume_tokens = ' '.join(resume_tokens)
1562
response = client.call_with_body_stream(
1563
('Repository.insert_stream', path, resume_tokens), byte_stream)
1564
if response[0][0] not in ('ok', 'missing-basis'):
1565
raise errors.UnexpectedSmartServerResponse(response)
1566
if response[0][0] == 'missing-basis':
1567
tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
1568
resume_tokens = tokens
1569
return resume_tokens, missing_keys
1571
if self.target_repo._real_repository is not None:
1572
collection = getattr(self.target_repo._real_repository,
1573
'_pack_collection', None)
1574
if collection is not None:
1575
collection.reload_pack_names()
1579
class RemoteStreamSource(repository.StreamSource):
1580
"""Stream data from a remote server."""
1582
def get_stream(self, search):
1583
# streaming with fallback repositories is not well defined yet: The
1584
# remote repository cannot see the fallback repositories, and thus
1585
# cannot satisfy the entire search in the general case. Likewise the
1586
# fallback repositories cannot reify the search to determine what they
1587
# should send. It likely needs a return value in the stream listing the
1588
# edge of the search to resume from in fallback repositories.
1589
if self.from_repository._fallback_repositories:
1590
return repository.StreamSource.get_stream(self, search)
1591
repo = self.from_repository
1592
client = repo._client
1593
medium = client._medium
1594
if medium._is_remote_before((1, 13)):
1595
# No possible way this can work.
1596
return repository.StreamSource.get_stream(self, search)
1597
path = repo.bzrdir._path_for_remote_call(client)
1599
search_bytes = repo._serialise_search_result(search)
1600
response = repo._call_with_body_bytes_expecting_body(
1601
'Repository.get_stream',
1602
(path, self.to_format.network_name()), search_bytes)
1603
response_tuple, response_handler = response
1604
except errors.UnknownSmartMethod:
1605
medium._remember_remote_is_before((1,13))
1606
return repository.StreamSource.get_stream(self, search)
1607
if response_tuple[0] != 'ok':
1608
raise errors.UnexpectedSmartServerResponse(response_tuple)
1609
byte_stream = response_handler.read_streamed_body()
1610
src_format, stream = smart_repo._byte_stream_to_stream(byte_stream)
1611
if src_format.network_name() != repo._format.network_name():
1612
raise AssertionError(
1613
"Mismatched RemoteRepository and stream src %r, %r" % (
1614
src_format.network_name(), repo._format.network_name()))
1618
class RemoteBranchLockableFiles(LockableFiles):
1619
"""A 'LockableFiles' implementation that talks to a smart server.
1621
This is not a public interface class.
1624
def __init__(self, bzrdir, _client):
1625
self.bzrdir = bzrdir
1626
self._client = _client
1627
self._need_find_modes = True
1628
LockableFiles.__init__(
1629
self, bzrdir.get_branch_transport(None),
1630
'lock', lockdir.LockDir)
1632
def _find_modes(self):
1633
# RemoteBranches don't let the client set the mode of control files.
1634
self._dir_mode = None
1635
self._file_mode = None
1638
class RemoteBranchFormat(branch.BranchFormat):
1640
def __init__(self, network_name=None):
1641
super(RemoteBranchFormat, self).__init__()
1642
self._matchingbzrdir = RemoteBzrDirFormat()
1643
self._matchingbzrdir.set_branch_format(self)
1644
self._custom_format = None
1645
self._network_name = network_name
1647
def __eq__(self, other):
1648
return (isinstance(other, RemoteBranchFormat) and
1649
self.__dict__ == other.__dict__)
1651
def _ensure_real(self):
1652
if self._custom_format is None:
1653
self._custom_format = branch.network_format_registry.get(
1656
def get_format_description(self):
1657
return 'Remote BZR Branch'
1659
def network_name(self):
1660
return self._network_name
1662
def open(self, a_bzrdir):
1663
return a_bzrdir.open_branch()
1665
def _vfs_initialize(self, a_bzrdir):
1666
# Initialisation when using a local bzrdir object, or a non-vfs init
1667
# method is not available on the server.
1668
# self._custom_format is always set - the start of initialize ensures
1670
if isinstance(a_bzrdir, RemoteBzrDir):
1671
a_bzrdir._ensure_real()
1672
result = self._custom_format.initialize(a_bzrdir._real_bzrdir)
1674
# We assume the bzrdir is parameterised; it may not be.
1675
result = self._custom_format.initialize(a_bzrdir)
1676
if (isinstance(a_bzrdir, RemoteBzrDir) and
1677
not isinstance(result, RemoteBranch)):
1678
result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result)
1681
def initialize(self, a_bzrdir):
1682
# 1) get the network name to use.
1683
if self._custom_format:
1684
network_name = self._custom_format.network_name()
1686
# Select the current bzrlib default and ask for that.
1687
reference_bzrdir_format = bzrdir.format_registry.get('default')()
1688
reference_format = reference_bzrdir_format.get_branch_format()
1689
self._custom_format = reference_format
1690
network_name = reference_format.network_name()
1691
# Being asked to create on a non RemoteBzrDir:
1692
if not isinstance(a_bzrdir, RemoteBzrDir):
1693
return self._vfs_initialize(a_bzrdir)
1694
medium = a_bzrdir._client._medium
1695
if medium._is_remote_before((1, 13)):
1696
return self._vfs_initialize(a_bzrdir)
1697
# Creating on a remote bzr dir.
1698
# 2) try direct creation via RPC
1699
path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
1700
verb = 'BzrDir.create_branch'
1702
response = a_bzrdir._call(verb, path, network_name)
1703
except errors.UnknownSmartMethod:
1704
# Fallback - use vfs methods
1705
medium._remember_remote_is_before((1, 13))
1706
return self._vfs_initialize(a_bzrdir)
1707
if response[0] != 'ok':
1708
raise errors.UnexpectedSmartServerResponse(response)
1709
# Turn the response into a RemoteRepository object.
1710
format = RemoteBranchFormat(network_name=response[1])
1711
repo_format = response_tuple_to_repo_format(response[3:])
1712
if response[2] == '':
1713
repo_bzrdir = a_bzrdir
1715
repo_bzrdir = RemoteBzrDir(
1716
a_bzrdir.root_transport.clone(response[2]), a_bzrdir._format,
1718
remote_repo = RemoteRepository(repo_bzrdir, repo_format)
1719
remote_branch = RemoteBranch(a_bzrdir, remote_repo,
1720
format=format, setup_stacking=False)
1721
# XXX: We know this is a new branch, so it must have revno 0, revid
1722
# NULL_REVISION. Creating the branch locked would make this be unable
1723
# to be wrong; here its simply very unlikely to be wrong. RBC 20090225
1724
remote_branch._last_revision_info_cache = 0, NULL_REVISION
1725
return remote_branch
1727
def make_tags(self, branch):
1729
return self._custom_format.make_tags(branch)
1731
def supports_tags(self):
1732
# Remote branches might support tags, but we won't know until we
1733
# access the real remote branch.
1735
return self._custom_format.supports_tags()
1737
def supports_stacking(self):
1739
return self._custom_format.supports_stacking()
1742
class RemoteBranch(branch.Branch, _RpcHelper):
1743
"""Branch stored on a server accessed by HPSS RPC.
1745
At the moment most operations are mapped down to simple file operations.
1748
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
1749
_client=None, format=None, setup_stacking=True):
1750
"""Create a RemoteBranch instance.
1752
:param real_branch: An optional local implementation of the branch
1753
format, usually accessing the data via the VFS.
1754
:param _client: Private parameter for testing.
1755
:param format: A RemoteBranchFormat object, None to create one
1756
automatically. If supplied it should have a network_name already
1758
:param setup_stacking: If True make an RPC call to determine the
1759
stacked (or not) status of the branch. If False assume the branch
1762
# We intentionally don't call the parent class's __init__, because it
1763
# will try to assign to self.tags, which is a property in this subclass.
1764
# And the parent's __init__ doesn't do much anyway.
1765
self._revision_id_to_revno_cache = None
1766
self._partial_revision_id_to_revno_cache = {}
1767
self._revision_history_cache = None
1768
self._last_revision_info_cache = None
1769
self._merge_sorted_revisions_cache = None
1770
self.bzrdir = remote_bzrdir
1771
if _client is not None:
1772
self._client = _client
1774
self._client = remote_bzrdir._client
1775
self.repository = remote_repository
1776
if real_branch is not None:
1777
self._real_branch = real_branch
1778
# Give the remote repository the matching real repo.
1779
real_repo = self._real_branch.repository
1780
if isinstance(real_repo, RemoteRepository):
1781
real_repo._ensure_real()
1782
real_repo = real_repo._real_repository
1783
self.repository._set_real_repository(real_repo)
1784
# Give the branch the remote repository to let fast-pathing happen.
1785
self._real_branch.repository = self.repository
1787
self._real_branch = None
1788
# Fill out expected attributes of branch for bzrlib api users.
1789
self.base = self.bzrdir.root_transport.base
1790
self._control_files = None
1791
self._lock_mode = None
1792
self._lock_token = None
1793
self._repo_lock_token = None
1794
self._lock_count = 0
1795
self._leave_lock = False
1796
# Setup a format: note that we cannot call _ensure_real until all the
1797
# attributes above are set: This code cannot be moved higher up in this
1800
self._format = RemoteBranchFormat()
1801
if real_branch is not None:
1802
self._format._network_name = \
1803
self._real_branch._format.network_name()
1805
self._format = format
1806
if not self._format._network_name:
1807
# Did not get from open_branchV2 - old server.
1809
self._format._network_name = \
1810
self._real_branch._format.network_name()
1811
self.tags = self._format.make_tags(self)
1812
# The base class init is not called, so we duplicate this:
1813
hooks = branch.Branch.hooks['open']
1817
self._setup_stacking()
1819
def _setup_stacking(self):
1820
# configure stacking into the remote repository, by reading it from
1823
fallback_url = self.get_stacked_on_url()
1824
except (errors.NotStacked, errors.UnstackableBranchFormat,
1825
errors.UnstackableRepositoryFormat), e:
1827
# it's relative to this branch...
1828
fallback_url = urlutils.join(self.base, fallback_url)
1829
transports = [self.bzrdir.root_transport]
1830
stacked_on = branch.Branch.open(fallback_url,
1831
possible_transports=transports)
1832
self.repository.add_fallback_repository(stacked_on.repository)
1834
def _get_real_transport(self):
1835
# if we try vfs access, return the real branch's vfs transport
1837
return self._real_branch._transport
1839
_transport = property(_get_real_transport)
1842
return "%s(%s)" % (self.__class__.__name__, self.base)
1846
def _ensure_real(self):
1847
"""Ensure that there is a _real_branch set.
1849
Used before calls to self._real_branch.
1851
if self._real_branch is None:
1852
if not vfs.vfs_enabled():
1853
raise AssertionError('smart server vfs must be enabled '
1854
'to use vfs implementation')
1855
self.bzrdir._ensure_real()
1856
self._real_branch = self.bzrdir._real_bzrdir.open_branch()
1857
if self.repository._real_repository is None:
1858
# Give the remote repository the matching real repo.
1859
real_repo = self._real_branch.repository
1860
if isinstance(real_repo, RemoteRepository):
1861
real_repo._ensure_real()
1862
real_repo = real_repo._real_repository
1863
self.repository._set_real_repository(real_repo)
1864
# Give the real branch the remote repository to let fast-pathing
1866
self._real_branch.repository = self.repository
1867
if self._lock_mode == 'r':
1868
self._real_branch.lock_read()
1869
elif self._lock_mode == 'w':
1870
self._real_branch.lock_write(token=self._lock_token)
1872
def _translate_error(self, err, **context):
1873
self.repository._translate_error(err, branch=self, **context)
1875
def _clear_cached_state(self):
1876
super(RemoteBranch, self)._clear_cached_state()
1877
if self._real_branch is not None:
1878
self._real_branch._clear_cached_state()
1880
def _clear_cached_state_of_remote_branch_only(self):
1881
"""Like _clear_cached_state, but doesn't clear the cache of
1884
This is useful when falling back to calling a method of
1885
self._real_branch that changes state. In that case the underlying
1886
branch changes, so we need to invalidate this RemoteBranch's cache of
1887
it. However, there's no need to invalidate the _real_branch's cache
1888
too, in fact doing so might harm performance.
1890
super(RemoteBranch, self)._clear_cached_state()
1893
def control_files(self):
1894
# Defer actually creating RemoteBranchLockableFiles until its needed,
1895
# because it triggers an _ensure_real that we otherwise might not need.
1896
if self._control_files is None:
1897
self._control_files = RemoteBranchLockableFiles(
1898
self.bzrdir, self._client)
1899
return self._control_files
1901
def _get_checkout_format(self):
1903
return self._real_branch._get_checkout_format()
1905
def get_physical_lock_status(self):
1906
"""See Branch.get_physical_lock_status()."""
1907
# should be an API call to the server, as branches must be lockable.
1909
return self._real_branch.get_physical_lock_status()
1911
def get_stacked_on_url(self):
1912
"""Get the URL this branch is stacked against.
1914
:raises NotStacked: If the branch is not stacked.
1915
:raises UnstackableBranchFormat: If the branch does not support
1917
:raises UnstackableRepositoryFormat: If the repository does not support
1921
# there may not be a repository yet, so we can't use
1922
# self._translate_error, so we can't use self._call either.
1923
response = self._client.call('Branch.get_stacked_on_url',
1924
self._remote_path())
1925
except errors.ErrorFromSmartServer, err:
1926
# there may not be a repository yet, so we can't call through
1927
# its _translate_error
1928
_translate_error(err, branch=self)
1929
except errors.UnknownSmartMethod, err:
1931
return self._real_branch.get_stacked_on_url()
1932
if response[0] != 'ok':
1933
raise errors.UnexpectedSmartServerResponse(response)
1936
def _vfs_get_tags_bytes(self):
1938
return self._real_branch._get_tags_bytes()
1940
def _get_tags_bytes(self):
1941
medium = self._client._medium
1942
if medium._is_remote_before((1, 13)):
1943
return self._vfs_get_tags_bytes()
1945
response = self._call('Branch.get_tags_bytes', self._remote_path())
1946
except errors.UnknownSmartMethod:
1947
medium._remember_remote_is_before((1, 13))
1948
return self._vfs_get_tags_bytes()
1951
def lock_read(self):
1952
self.repository.lock_read()
1953
if not self._lock_mode:
1954
self._lock_mode = 'r'
1955
self._lock_count = 1
1956
if self._real_branch is not None:
1957
self._real_branch.lock_read()
1959
self._lock_count += 1
1961
def _remote_lock_write(self, token):
1963
branch_token = repo_token = ''
1965
branch_token = token
1966
repo_token = self.repository.lock_write()
1967
self.repository.unlock()
1968
err_context = {'token': token}
1969
response = self._call(
1970
'Branch.lock_write', self._remote_path(), branch_token,
1971
repo_token or '', **err_context)
1972
if response[0] != 'ok':
1973
raise errors.UnexpectedSmartServerResponse(response)
1974
ok, branch_token, repo_token = response
1975
return branch_token, repo_token
1977
def lock_write(self, token=None):
1978
if not self._lock_mode:
1979
# Lock the branch and repo in one remote call.
1980
remote_tokens = self._remote_lock_write(token)
1981
self._lock_token, self._repo_lock_token = remote_tokens
1982
if not self._lock_token:
1983
raise SmartProtocolError('Remote server did not return a token!')
1984
# Tell the self.repository object that it is locked.
1985
self.repository.lock_write(
1986
self._repo_lock_token, _skip_rpc=True)
1988
if self._real_branch is not None:
1989
self._real_branch.lock_write(token=self._lock_token)
1990
if token is not None:
1991
self._leave_lock = True
1993
self._leave_lock = False
1994
self._lock_mode = 'w'
1995
self._lock_count = 1
1996
elif self._lock_mode == 'r':
1997
raise errors.ReadOnlyTransaction
1999
if token is not None:
2000
# A token was given to lock_write, and we're relocking, so
2001
# check that the given token actually matches the one we
2003
if token != self._lock_token:
2004
raise errors.TokenMismatch(token, self._lock_token)
2005
self._lock_count += 1
2006
# Re-lock the repository too.
2007
self.repository.lock_write(self._repo_lock_token)
2008
return self._lock_token or None
2010
def _set_tags_bytes(self, bytes):
2012
return self._real_branch._set_tags_bytes(bytes)
2014
def _unlock(self, branch_token, repo_token):
2015
err_context = {'token': str((branch_token, repo_token))}
2016
response = self._call(
2017
'Branch.unlock', self._remote_path(), branch_token,
2018
repo_token or '', **err_context)
2019
if response == ('ok',):
2021
raise errors.UnexpectedSmartServerResponse(response)
2025
self._lock_count -= 1
2026
if not self._lock_count:
2027
self._clear_cached_state()
2028
mode = self._lock_mode
2029
self._lock_mode = None
2030
if self._real_branch is not None:
2031
if (not self._leave_lock and mode == 'w' and
2032
self._repo_lock_token):
2033
# If this RemoteBranch will remove the physical lock
2034
# for the repository, make sure the _real_branch
2035
# doesn't do it first. (Because the _real_branch's
2036
# repository is set to be the RemoteRepository.)
2037
self._real_branch.repository.leave_lock_in_place()
2038
self._real_branch.unlock()
2040
# Only write-locked branched need to make a remote method
2041
# call to perfom the unlock.
2043
if not self._lock_token:
2044
raise AssertionError('Locked, but no token!')
2045
branch_token = self._lock_token
2046
repo_token = self._repo_lock_token
2047
self._lock_token = None
2048
self._repo_lock_token = None
2049
if not self._leave_lock:
2050
self._unlock(branch_token, repo_token)
2052
self.repository.unlock()
2054
def break_lock(self):
2056
return self._real_branch.break_lock()
2058
def leave_lock_in_place(self):
2059
if not self._lock_token:
2060
raise NotImplementedError(self.leave_lock_in_place)
2061
self._leave_lock = True
2063
def dont_leave_lock_in_place(self):
2064
if not self._lock_token:
2065
raise NotImplementedError(self.dont_leave_lock_in_place)
2066
self._leave_lock = False
2068
def _last_revision_info(self):
2069
response = self._call('Branch.last_revision_info', self._remote_path())
2070
if response[0] != 'ok':
2071
raise SmartProtocolError('unexpected response code %s' % (response,))
2072
revno = int(response[1])
2073
last_revision = response[2]
2074
return (revno, last_revision)
2076
def _gen_revision_history(self):
2077
"""See Branch._gen_revision_history()."""
2078
response_tuple, response_handler = self._call_expecting_body(
2079
'Branch.revision_history', self._remote_path())
2080
if response_tuple[0] != 'ok':
2081
raise errors.UnexpectedSmartServerResponse(response_tuple)
2082
result = response_handler.read_body_bytes().split('\x00')
2087
def _remote_path(self):
2088
return self.bzrdir._path_for_remote_call(self._client)
2090
def _set_last_revision_descendant(self, revision_id, other_branch,
2091
allow_diverged=False, allow_overwrite_descendant=False):
2092
# This performs additional work to meet the hook contract; while its
2093
# undesirable, we have to synthesise the revno to call the hook, and
2094
# not calling the hook is worse as it means changes can't be prevented.
2095
# Having calculated this though, we can't just call into
2096
# set_last_revision_info as a simple call, because there is a set_rh
2097
# hook that some folk may still be using.
2098
old_revno, old_revid = self.last_revision_info()
2099
history = self._lefthand_history(revision_id)
2100
self._run_pre_change_branch_tip_hooks(len(history), revision_id)
2101
err_context = {'other_branch': other_branch}
2102
response = self._call('Branch.set_last_revision_ex',
2103
self._remote_path(), self._lock_token, self._repo_lock_token,
2104
revision_id, int(allow_diverged), int(allow_overwrite_descendant),
2106
self._clear_cached_state()
2107
if len(response) != 3 and response[0] != 'ok':
2108
raise errors.UnexpectedSmartServerResponse(response)
2109
new_revno, new_revision_id = response[1:]
2110
self._last_revision_info_cache = new_revno, new_revision_id
2111
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2112
if self._real_branch is not None:
2113
cache = new_revno, new_revision_id
2114
self._real_branch._last_revision_info_cache = cache
2116
def _set_last_revision(self, revision_id):
2117
old_revno, old_revid = self.last_revision_info()
2118
# This performs additional work to meet the hook contract; while its
2119
# undesirable, we have to synthesise the revno to call the hook, and
2120
# not calling the hook is worse as it means changes can't be prevented.
2121
# Having calculated this though, we can't just call into
2122
# set_last_revision_info as a simple call, because there is a set_rh
2123
# hook that some folk may still be using.
2124
history = self._lefthand_history(revision_id)
2125
self._run_pre_change_branch_tip_hooks(len(history), revision_id)
2126
self._clear_cached_state()
2127
response = self._call('Branch.set_last_revision',
2128
self._remote_path(), self._lock_token, self._repo_lock_token,
2130
if response != ('ok',):
2131
raise errors.UnexpectedSmartServerResponse(response)
2132
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2135
def set_revision_history(self, rev_history):
2136
# Send just the tip revision of the history; the server will generate
2137
# the full history from that. If the revision doesn't exist in this
2138
# branch, NoSuchRevision will be raised.
2139
if rev_history == []:
2142
rev_id = rev_history[-1]
2143
self._set_last_revision(rev_id)
2144
for hook in branch.Branch.hooks['set_rh']:
2145
hook(self, rev_history)
2146
self._cache_revision_history(rev_history)
2148
def _get_parent_location(self):
2149
medium = self._client._medium
2150
if medium._is_remote_before((1, 13)):
2151
return self._vfs_get_parent_location()
2153
response = self._call('Branch.get_parent', self._remote_path())
2154
except errors.UnknownSmartMethod:
2155
medium._remember_remote_is_before((1, 13))
2156
return self._vfs_get_parent_location()
2157
if len(response) != 1:
2158
raise errors.UnexpectedSmartServerResponse(response)
2159
parent_location = response[0]
2160
if parent_location == '':
2162
return parent_location
2164
def _vfs_get_parent_location(self):
2166
return self._real_branch._get_parent_location()
2168
def set_parent(self, url):
2170
return self._real_branch.set_parent(url)
2172
def _set_parent_location(self, url):
2173
# Used by tests, to poke bad urls into branch configurations
2175
self.set_parent(url)
2178
return self._real_branch._set_parent_location(url)
2180
def set_stacked_on_url(self, stacked_location):
2181
"""Set the URL this branch is stacked against.
2183
:raises UnstackableBranchFormat: If the branch does not support
2185
:raises UnstackableRepositoryFormat: If the repository does not support
2189
return self._real_branch.set_stacked_on_url(stacked_location)
2192
def pull(self, source, overwrite=False, stop_revision=None,
2194
self._clear_cached_state_of_remote_branch_only()
2196
return self._real_branch.pull(
2197
source, overwrite=overwrite, stop_revision=stop_revision,
2198
_override_hook_target=self, **kwargs)
2201
def push(self, target, overwrite=False, stop_revision=None):
2203
return self._real_branch.push(
2204
target, overwrite=overwrite, stop_revision=stop_revision,
2205
_override_hook_source_branch=self)
2207
def is_locked(self):
2208
return self._lock_count >= 1
2211
def revision_id_to_revno(self, revision_id):
2213
return self._real_branch.revision_id_to_revno(revision_id)
2216
def set_last_revision_info(self, revno, revision_id):
2217
# XXX: These should be returned by the set_last_revision_info verb
2218
old_revno, old_revid = self.last_revision_info()
2219
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2220
revision_id = ensure_null(revision_id)
2222
response = self._call('Branch.set_last_revision_info',
2223
self._remote_path(), self._lock_token, self._repo_lock_token,
2224
str(revno), revision_id)
2225
except errors.UnknownSmartMethod:
2227
self._clear_cached_state_of_remote_branch_only()
2228
self._real_branch.set_last_revision_info(revno, revision_id)
2229
self._last_revision_info_cache = revno, revision_id
2231
if response == ('ok',):
2232
self._clear_cached_state()
2233
self._last_revision_info_cache = revno, revision_id
2234
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2235
# Update the _real_branch's cache too.
2236
if self._real_branch is not None:
2237
cache = self._last_revision_info_cache
2238
self._real_branch._last_revision_info_cache = cache
2240
raise errors.UnexpectedSmartServerResponse(response)
2243
def generate_revision_history(self, revision_id, last_rev=None,
2245
medium = self._client._medium
2246
if not medium._is_remote_before((1, 6)):
2247
# Use a smart method for 1.6 and above servers
2249
self._set_last_revision_descendant(revision_id, other_branch,
2250
allow_diverged=True, allow_overwrite_descendant=True)
2252
except errors.UnknownSmartMethod:
2253
medium._remember_remote_is_before((1, 6))
2254
self._clear_cached_state_of_remote_branch_only()
2255
self.set_revision_history(self._lefthand_history(revision_id,
2256
last_rev=last_rev,other_branch=other_branch))
2258
def set_push_location(self, location):
2260
return self._real_branch.set_push_location(location)
2263
def _extract_tar(tar, to_dir):
2264
"""Extract all the contents of a tarfile object.
2266
A replacement for extractall, which is not present in python2.4
2269
tar.extract(tarinfo, to_dir)
2272
def _translate_error(err, **context):
2273
"""Translate an ErrorFromSmartServer into a more useful error.
2275
Possible context keys:
2283
If the error from the server doesn't match a known pattern, then
2284
UnknownErrorFromSmartServer is raised.
2288
return context[name]
2289
except KeyError, key_err:
2290
mutter('Missing key %r in context %r', key_err.args[0], context)
2293
"""Get the path from the context if present, otherwise use first error
2297
return context['path']
2298
except KeyError, key_err:
2300
return err.error_args[0]
2301
except IndexError, idx_err:
2303
'Missing key %r in context %r', key_err.args[0], context)
2306
if err.error_verb == 'NoSuchRevision':
2307
raise NoSuchRevision(find('branch'), err.error_args[0])
2308
elif err.error_verb == 'nosuchrevision':
2309
raise NoSuchRevision(find('repository'), err.error_args[0])
2310
elif err.error_tuple == ('nobranch',):
2311
raise errors.NotBranchError(path=find('bzrdir').root_transport.base)
2312
elif err.error_verb == 'norepository':
2313
raise errors.NoRepositoryPresent(find('bzrdir'))
2314
elif err.error_verb == 'LockContention':
2315
raise errors.LockContention('(remote lock)')
2316
elif err.error_verb == 'UnlockableTransport':
2317
raise errors.UnlockableTransport(find('bzrdir').root_transport)
2318
elif err.error_verb == 'LockFailed':
2319
raise errors.LockFailed(err.error_args[0], err.error_args[1])
2320
elif err.error_verb == 'TokenMismatch':
2321
raise errors.TokenMismatch(find('token'), '(remote token)')
2322
elif err.error_verb == 'Diverged':
2323
raise errors.DivergedBranches(find('branch'), find('other_branch'))
2324
elif err.error_verb == 'TipChangeRejected':
2325
raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
2326
elif err.error_verb == 'UnstackableBranchFormat':
2327
raise errors.UnstackableBranchFormat(*err.error_args)
2328
elif err.error_verb == 'UnstackableRepositoryFormat':
2329
raise errors.UnstackableRepositoryFormat(*err.error_args)
2330
elif err.error_verb == 'NotStacked':
2331
raise errors.NotStacked(branch=find('branch'))
2332
elif err.error_verb == 'PermissionDenied':
2334
if len(err.error_args) >= 2:
2335
extra = err.error_args[1]
2338
raise errors.PermissionDenied(path, extra=extra)
2339
elif err.error_verb == 'ReadError':
2341
raise errors.ReadError(path)
2342
elif err.error_verb == 'NoSuchFile':
2344
raise errors.NoSuchFile(path)
2345
elif err.error_verb == 'FileExists':
2346
raise errors.FileExists(err.error_args[0])
2347
elif err.error_verb == 'DirectoryNotEmpty':
2348
raise errors.DirectoryNotEmpty(err.error_args[0])
2349
elif err.error_verb == 'ShortReadvError':
2350
args = err.error_args
2351
raise errors.ShortReadvError(
2352
args[0], int(args[1]), int(args[2]), int(args[3]))
2353
elif err.error_verb in ('UnicodeEncodeError', 'UnicodeDecodeError'):
2354
encoding = str(err.error_args[0]) # encoding must always be a string
2355
val = err.error_args[1]
2356
start = int(err.error_args[2])
2357
end = int(err.error_args[3])
2358
reason = str(err.error_args[4]) # reason must always be a string
2359
if val.startswith('u:'):
2360
val = val[2:].decode('utf-8')
2361
elif val.startswith('s:'):
2362
val = val[2:].decode('base64')
2363
if err.error_verb == 'UnicodeDecodeError':
2364
raise UnicodeDecodeError(encoding, val, start, end, reason)
2365
elif err.error_verb == 'UnicodeEncodeError':
2366
raise UnicodeEncodeError(encoding, val, start, end, reason)
2367
elif err.error_verb == 'ReadOnlyError':
2368
raise errors.TransportNotPossible('readonly transport')
2369
raise errors.UnknownErrorFromSmartServer(err)