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
def _get_revision_graph(self, revision_id):
689
"""Private method for using with old (< 1.2) servers to fallback."""
690
if revision_id is None:
692
elif revision.is_null(revision_id):
695
path = self.bzrdir._path_for_remote_call(self._client)
696
response = self._call_expecting_body(
697
'Repository.get_revision_graph', path, revision_id)
698
response_tuple, response_handler = response
699
if response_tuple[0] != 'ok':
700
raise errors.UnexpectedSmartServerResponse(response_tuple)
701
coded = response_handler.read_body_bytes()
703
# no revisions in this repository!
705
lines = coded.split('\n')
708
d = tuple(line.split())
709
revision_graph[d[0]] = d[1:]
711
return revision_graph
714
"""See Repository._get_sink()."""
715
return RemoteStreamSink(self)
717
def _get_source(self, to_format):
718
"""Return a source for streaming from this repository."""
719
return RemoteStreamSource(self, to_format)
721
def has_revision(self, revision_id):
722
"""See Repository.has_revision()."""
723
if revision_id == NULL_REVISION:
724
# The null revision is always present.
726
path = self.bzrdir._path_for_remote_call(self._client)
727
response = self._call('Repository.has_revision', path, revision_id)
728
if response[0] not in ('yes', 'no'):
729
raise errors.UnexpectedSmartServerResponse(response)
730
if response[0] == 'yes':
732
for fallback_repo in self._fallback_repositories:
733
if fallback_repo.has_revision(revision_id):
737
def has_revisions(self, revision_ids):
738
"""See Repository.has_revisions()."""
739
# FIXME: This does many roundtrips, particularly when there are
740
# fallback repositories. -- mbp 20080905
742
for revision_id in revision_ids:
743
if self.has_revision(revision_id):
744
result.add(revision_id)
747
def has_same_location(self, other):
748
return (self.__class__ is other.__class__ and
749
self.bzrdir.transport.base == other.bzrdir.transport.base)
751
def get_graph(self, other_repository=None):
752
"""Return the graph for this repository format"""
753
parents_provider = self._make_parents_provider(other_repository)
754
return graph.Graph(parents_provider)
756
def gather_stats(self, revid=None, committers=None):
757
"""See Repository.gather_stats()."""
758
path = self.bzrdir._path_for_remote_call(self._client)
759
# revid can be None to indicate no revisions, not just NULL_REVISION
760
if revid is None or revision.is_null(revid):
764
if committers is None or not committers:
765
fmt_committers = 'no'
767
fmt_committers = 'yes'
768
response_tuple, response_handler = self._call_expecting_body(
769
'Repository.gather_stats', path, fmt_revid, fmt_committers)
770
if response_tuple[0] != 'ok':
771
raise errors.UnexpectedSmartServerResponse(response_tuple)
773
body = response_handler.read_body_bytes()
775
for line in body.split('\n'):
778
key, val_text = line.split(':')
779
if key in ('revisions', 'size', 'committers'):
780
result[key] = int(val_text)
781
elif key in ('firstrev', 'latestrev'):
782
values = val_text.split(' ')[1:]
783
result[key] = (float(values[0]), long(values[1]))
787
def find_branches(self, using=False):
788
"""See Repository.find_branches()."""
789
# should be an API call to the server.
791
return self._real_repository.find_branches(using=using)
793
def get_physical_lock_status(self):
794
"""See Repository.get_physical_lock_status()."""
795
# should be an API call to the server.
797
return self._real_repository.get_physical_lock_status()
799
def is_in_write_group(self):
800
"""Return True if there is an open write group.
802
write groups are only applicable locally for the smart server..
804
if self._real_repository:
805
return self._real_repository.is_in_write_group()
808
return self._lock_count >= 1
811
"""See Repository.is_shared()."""
812
path = self.bzrdir._path_for_remote_call(self._client)
813
response = self._call('Repository.is_shared', path)
814
if response[0] not in ('yes', 'no'):
815
raise SmartProtocolError('unexpected response code %s' % (response,))
816
return response[0] == 'yes'
818
def is_write_locked(self):
819
return self._lock_mode == 'w'
822
# wrong eventually - want a local lock cache context
823
if not self._lock_mode:
824
self._lock_mode = 'r'
826
self._unstacked_provider.enable_cache(cache_misses=False)
827
if self._real_repository is not None:
828
self._real_repository.lock_read()
830
self._lock_count += 1
832
def _remote_lock_write(self, token):
833
path = self.bzrdir._path_for_remote_call(self._client)
836
err_context = {'token': token}
837
response = self._call('Repository.lock_write', path, token,
839
if response[0] == 'ok':
843
raise errors.UnexpectedSmartServerResponse(response)
845
def lock_write(self, token=None, _skip_rpc=False):
846
if not self._lock_mode:
848
if self._lock_token is not None:
849
if token != self._lock_token:
850
raise errors.TokenMismatch(token, self._lock_token)
851
self._lock_token = token
853
self._lock_token = self._remote_lock_write(token)
854
# if self._lock_token is None, then this is something like packs or
855
# svn where we don't get to lock the repo, or a weave style repository
856
# where we cannot lock it over the wire and attempts to do so will
858
if self._real_repository is not None:
859
self._real_repository.lock_write(token=self._lock_token)
860
if token is not None:
861
self._leave_lock = True
863
self._leave_lock = False
864
self._lock_mode = 'w'
866
self._unstacked_provider.enable_cache(cache_misses=False)
867
elif self._lock_mode == 'r':
868
raise errors.ReadOnlyError(self)
870
self._lock_count += 1
871
return self._lock_token or None
873
def leave_lock_in_place(self):
874
if not self._lock_token:
875
raise NotImplementedError(self.leave_lock_in_place)
876
self._leave_lock = True
878
def dont_leave_lock_in_place(self):
879
if not self._lock_token:
880
raise NotImplementedError(self.dont_leave_lock_in_place)
881
self._leave_lock = False
883
def _set_real_repository(self, repository):
884
"""Set the _real_repository for this repository.
886
:param repository: The repository to fallback to for non-hpss
887
implemented operations.
889
if self._real_repository is not None:
890
# Replacing an already set real repository.
891
# We cannot do this [currently] if the repository is locked -
892
# synchronised state might be lost.
894
raise AssertionError('_real_repository is already set')
895
if isinstance(repository, RemoteRepository):
896
raise AssertionError()
897
self._real_repository = repository
898
# If the _real_repository has _fallback_repositories, clear them out,
899
# because we want it to have the same set as this repository. This is
900
# reasonable to do because the fallbacks we clear here are from a
901
# "real" branch, and we're about to replace them with the equivalents
902
# from a RemoteBranch.
903
self._real_repository._fallback_repositories = []
904
for fb in self._fallback_repositories:
905
self._real_repository.add_fallback_repository(fb)
906
if self._lock_mode == 'w':
907
# if we are already locked, the real repository must be able to
908
# acquire the lock with our token.
909
self._real_repository.lock_write(self._lock_token)
910
elif self._lock_mode == 'r':
911
self._real_repository.lock_read()
913
def start_write_group(self):
914
"""Start a write group on the decorated repository.
916
Smart methods peform operations in a single step so this api
917
is not really applicable except as a compatibility thunk
918
for older plugins that don't use e.g. the CommitBuilder
922
return self._real_repository.start_write_group()
924
def _unlock(self, token):
925
path = self.bzrdir._path_for_remote_call(self._client)
927
# with no token the remote repository is not persistently locked.
929
err_context = {'token': token}
930
response = self._call('Repository.unlock', path, token,
932
if response == ('ok',):
935
raise errors.UnexpectedSmartServerResponse(response)
938
if not self._lock_count:
939
raise errors.LockNotHeld(self)
940
self._lock_count -= 1
941
if self._lock_count > 0:
943
self._unstacked_provider.disable_cache()
944
old_mode = self._lock_mode
945
self._lock_mode = None
947
# The real repository is responsible at present for raising an
948
# exception if it's in an unfinished write group. However, it
949
# normally will *not* actually remove the lock from disk - that's
950
# done by the server on receiving the Repository.unlock call.
951
# This is just to let the _real_repository stay up to date.
952
if self._real_repository is not None:
953
self._real_repository.unlock()
955
# The rpc-level lock should be released even if there was a
956
# problem releasing the vfs-based lock.
958
# Only write-locked repositories need to make a remote method
959
# call to perfom the unlock.
960
old_token = self._lock_token
961
self._lock_token = None
962
if not self._leave_lock:
963
self._unlock(old_token)
965
def break_lock(self):
966
# should hand off to the network
968
return self._real_repository.break_lock()
970
def _get_tarball(self, compression):
971
"""Return a TemporaryFile containing a repository tarball.
973
Returns None if the server does not support sending tarballs.
976
path = self.bzrdir._path_for_remote_call(self._client)
978
response, protocol = self._call_expecting_body(
979
'Repository.tarball', path, compression)
980
except errors.UnknownSmartMethod:
981
protocol.cancel_read_body()
983
if response[0] == 'ok':
984
# Extract the tarball and return it
985
t = tempfile.NamedTemporaryFile()
986
# TODO: rpc layer should read directly into it...
987
t.write(protocol.read_body_bytes())
990
raise errors.UnexpectedSmartServerResponse(response)
992
def sprout(self, to_bzrdir, revision_id=None):
993
# TODO: Option to control what format is created?
995
dest_repo = self._real_repository._format.initialize(to_bzrdir,
997
dest_repo.fetch(self, revision_id=revision_id)
1000
### These methods are just thin shims to the VFS object for now.
1002
def revision_tree(self, revision_id):
1004
return self._real_repository.revision_tree(revision_id)
1006
def get_serializer_format(self):
1008
return self._real_repository.get_serializer_format()
1010
def get_commit_builder(self, branch, parents, config, timestamp=None,
1011
timezone=None, committer=None, revprops=None,
1013
# FIXME: It ought to be possible to call this without immediately
1014
# triggering _ensure_real. For now it's the easiest thing to do.
1016
real_repo = self._real_repository
1017
builder = real_repo.get_commit_builder(branch, parents,
1018
config, timestamp=timestamp, timezone=timezone,
1019
committer=committer, revprops=revprops, revision_id=revision_id)
1022
def add_fallback_repository(self, repository):
1023
"""Add a repository to use for looking up data not held locally.
1025
:param repository: A repository.
1027
if not self._format.supports_external_lookups:
1028
raise errors.UnstackableRepositoryFormat(
1029
self._format.network_name(), self.base)
1030
# We need to accumulate additional repositories here, to pass them in
1033
self._fallback_repositories.append(repository)
1034
# If self._real_repository was parameterised already (e.g. because a
1035
# _real_branch had its get_stacked_on_url method called), then the
1036
# repository to be added may already be in the _real_repositories list.
1037
if self._real_repository is not None:
1038
if repository not in self._real_repository._fallback_repositories:
1039
self._real_repository.add_fallback_repository(repository)
1041
# They are also seen by the fallback repository. If it doesn't
1042
# exist yet they'll be added then. This implicitly copies them.
1045
def add_inventory(self, revid, inv, parents):
1047
return self._real_repository.add_inventory(revid, inv, parents)
1049
def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1052
return self._real_repository.add_inventory_by_delta(basis_revision_id,
1053
delta, new_revision_id, parents)
1055
def add_revision(self, rev_id, rev, inv=None, config=None):
1057
return self._real_repository.add_revision(
1058
rev_id, rev, inv=inv, config=config)
1061
def get_inventory(self, revision_id):
1063
return self._real_repository.get_inventory(revision_id)
1065
def iter_inventories(self, revision_ids):
1067
return self._real_repository.iter_inventories(revision_ids)
1070
def get_revision(self, revision_id):
1072
return self._real_repository.get_revision(revision_id)
1074
def get_transaction(self):
1076
return self._real_repository.get_transaction()
1079
def clone(self, a_bzrdir, revision_id=None):
1081
return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
1083
def make_working_trees(self):
1084
"""See Repository.make_working_trees"""
1086
return self._real_repository.make_working_trees()
1088
def refresh_data(self):
1089
"""Re-read any data needed to to synchronise with disk.
1091
This method is intended to be called after another repository instance
1092
(such as one used by a smart server) has inserted data into the
1093
repository. It may not be called during a write group, but may be
1094
called at any other time.
1096
if self.is_in_write_group():
1097
raise errors.InternalBzrError(
1098
"May not refresh_data while in a write group.")
1099
if self._real_repository is not None:
1100
self._real_repository.refresh_data()
1102
def revision_ids_to_search_result(self, result_set):
1103
"""Convert a set of revision ids to a graph SearchResult."""
1104
result_parents = set()
1105
for parents in self.get_graph().get_parent_map(
1106
result_set).itervalues():
1107
result_parents.update(parents)
1108
included_keys = result_set.intersection(result_parents)
1109
start_keys = result_set.difference(included_keys)
1110
exclude_keys = result_parents.difference(result_set)
1111
result = graph.SearchResult(start_keys, exclude_keys,
1112
len(result_set), result_set)
1116
def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1117
"""Return the revision ids that other has that this does not.
1119
These are returned in topological order.
1121
revision_id: only return revision ids included by revision_id.
1123
return repository.InterRepository.get(
1124
other, self).search_missing_revision_ids(revision_id, find_ghosts)
1126
def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
1128
# No base implementation to use as RemoteRepository is not a subclass
1129
# of Repository; so this is a copy of Repository.fetch().
1130
if fetch_spec is not None and revision_id is not None:
1131
raise AssertionError(
1132
"fetch_spec and revision_id are mutually exclusive.")
1133
if self.is_in_write_group():
1134
raise errors.InternalBzrError(
1135
"May not fetch while in a write group.")
1136
# fast path same-url fetch operations
1137
if self.has_same_location(source) and fetch_spec is None:
1138
# check that last_revision is in 'from' and then return a
1140
if (revision_id is not None and
1141
not revision.is_null(revision_id)):
1142
self.get_revision(revision_id)
1144
# if there is no specific appropriate InterRepository, this will get
1145
# the InterRepository base class, which raises an
1146
# IncompatibleRepositories when asked to fetch.
1147
inter = repository.InterRepository.get(source, self)
1148
return inter.fetch(revision_id=revision_id, pb=pb,
1149
find_ghosts=find_ghosts, fetch_spec=fetch_spec)
1151
def create_bundle(self, target, base, fileobj, format=None):
1153
self._real_repository.create_bundle(target, base, fileobj, format)
1156
def get_ancestry(self, revision_id, topo_sorted=True):
1158
return self._real_repository.get_ancestry(revision_id, topo_sorted)
1160
def fileids_altered_by_revision_ids(self, revision_ids):
1162
return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
1164
def _get_versioned_file_checker(self, revisions, revision_versions_cache):
1166
return self._real_repository._get_versioned_file_checker(
1167
revisions, revision_versions_cache)
1169
def iter_files_bytes(self, desired_files):
1170
"""See Repository.iter_file_bytes.
1173
return self._real_repository.iter_files_bytes(desired_files)
1175
def get_parent_map(self, revision_ids):
1176
"""See bzrlib.Graph.get_parent_map()."""
1177
return self._make_parents_provider().get_parent_map(revision_ids)
1179
def _get_parent_map_rpc(self, keys):
1180
"""Helper for get_parent_map that performs the RPC."""
1181
medium = self._client._medium
1182
if medium._is_remote_before((1, 2)):
1183
# We already found out that the server can't understand
1184
# Repository.get_parent_map requests, so just fetch the whole
1186
# XXX: Note that this will issue a deprecation warning. This is ok
1187
# :- its because we're working with a deprecated server anyway, and
1188
# the user will almost certainly have seen a warning about the
1189
# server version already.
1190
rg = self.get_revision_graph()
1191
# There is an api discrepency between get_parent_map and
1192
# get_revision_graph. Specifically, a "key:()" pair in
1193
# get_revision_graph just means a node has no parents. For
1194
# "get_parent_map" it means the node is a ghost. So fix up the
1195
# graph to correct this.
1196
# https://bugs.launchpad.net/bzr/+bug/214894
1197
# There is one other "bug" which is that ghosts in
1198
# get_revision_graph() are not returned at all. But we won't worry
1199
# about that for now.
1200
for node_id, parent_ids in rg.iteritems():
1201
if parent_ids == ():
1202
rg[node_id] = (NULL_REVISION,)
1203
rg[NULL_REVISION] = ()
1208
raise ValueError('get_parent_map(None) is not valid')
1209
if NULL_REVISION in keys:
1210
keys.discard(NULL_REVISION)
1211
found_parents = {NULL_REVISION:()}
1213
return found_parents
1216
# TODO(Needs analysis): We could assume that the keys being requested
1217
# from get_parent_map are in a breadth first search, so typically they
1218
# will all be depth N from some common parent, and we don't have to
1219
# have the server iterate from the root parent, but rather from the
1220
# keys we're searching; and just tell the server the keyspace we
1221
# already have; but this may be more traffic again.
1223
# Transform self._parents_map into a search request recipe.
1224
# TODO: Manage this incrementally to avoid covering the same path
1225
# repeatedly. (The server will have to on each request, but the less
1226
# work done the better).
1227
parents_map = self._unstacked_provider.get_cached_map()
1228
if parents_map is None:
1229
# Repository is not locked, so there's no cache.
1231
start_set = set(parents_map)
1232
result_parents = set()
1233
for parents in parents_map.itervalues():
1234
result_parents.update(parents)
1235
stop_keys = result_parents.difference(start_set)
1236
included_keys = start_set.intersection(result_parents)
1237
start_set.difference_update(included_keys)
1238
recipe = (start_set, stop_keys, len(parents_map))
1239
body = self._serialise_search_recipe(recipe)
1240
path = self.bzrdir._path_for_remote_call(self._client)
1242
if type(key) is not str:
1244
"key %r not a plain string" % (key,))
1245
verb = 'Repository.get_parent_map'
1246
args = (path,) + tuple(keys)
1248
response = self._call_with_body_bytes_expecting_body(
1250
except errors.UnknownSmartMethod:
1251
# Server does not support this method, so get the whole graph.
1252
# Worse, we have to force a disconnection, because the server now
1253
# doesn't realise it has a body on the wire to consume, so the
1254
# only way to recover is to abandon the connection.
1256
'Server is too old for fast get_parent_map, reconnecting. '
1257
'(Upgrade the server to Bazaar 1.2 to avoid this)')
1259
# To avoid having to disconnect repeatedly, we keep track of the
1260
# fact the server doesn't understand remote methods added in 1.2.
1261
medium._remember_remote_is_before((1, 2))
1262
return self.get_revision_graph(None)
1263
response_tuple, response_handler = response
1264
if response_tuple[0] not in ['ok']:
1265
response_handler.cancel_read_body()
1266
raise errors.UnexpectedSmartServerResponse(response_tuple)
1267
if response_tuple[0] == 'ok':
1268
coded = bz2.decompress(response_handler.read_body_bytes())
1270
# no revisions found
1272
lines = coded.split('\n')
1275
d = tuple(line.split())
1277
revision_graph[d[0]] = d[1:]
1279
# No parents - so give the Graph result (NULL_REVISION,).
1280
revision_graph[d[0]] = (NULL_REVISION,)
1281
return revision_graph
1284
def get_signature_text(self, revision_id):
1286
return self._real_repository.get_signature_text(revision_id)
1289
def get_inventory_xml(self, revision_id):
1291
return self._real_repository.get_inventory_xml(revision_id)
1293
def deserialise_inventory(self, revision_id, xml):
1295
return self._real_repository.deserialise_inventory(revision_id, xml)
1297
def reconcile(self, other=None, thorough=False):
1299
return self._real_repository.reconcile(other=other, thorough=thorough)
1301
def all_revision_ids(self):
1303
return self._real_repository.all_revision_ids()
1306
def get_deltas_for_revisions(self, revisions):
1308
return self._real_repository.get_deltas_for_revisions(revisions)
1311
def get_revision_delta(self, revision_id):
1313
return self._real_repository.get_revision_delta(revision_id)
1316
def revision_trees(self, revision_ids):
1318
return self._real_repository.revision_trees(revision_ids)
1321
def get_revision_reconcile(self, revision_id):
1323
return self._real_repository.get_revision_reconcile(revision_id)
1326
def check(self, revision_ids=None):
1328
return self._real_repository.check(revision_ids=revision_ids)
1330
def copy_content_into(self, destination, revision_id=None):
1332
return self._real_repository.copy_content_into(
1333
destination, revision_id=revision_id)
1335
def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
1336
# get a tarball of the remote repository, and copy from that into the
1338
from bzrlib import osutils
1340
# TODO: Maybe a progress bar while streaming the tarball?
1341
note("Copying repository content as tarball...")
1342
tar_file = self._get_tarball('bz2')
1343
if tar_file is None:
1345
destination = to_bzrdir.create_repository()
1347
tar = tarfile.open('repository', fileobj=tar_file,
1349
tmpdir = osutils.mkdtemp()
1351
_extract_tar(tar, tmpdir)
1352
tmp_bzrdir = BzrDir.open(tmpdir)
1353
tmp_repo = tmp_bzrdir.open_repository()
1354
tmp_repo.copy_content_into(destination, revision_id)
1356
osutils.rmtree(tmpdir)
1360
# TODO: Suggestion from john: using external tar is much faster than
1361
# python's tarfile library, but it may not work on windows.
1364
def inventories(self):
1365
"""Decorate the real repository for now.
1367
In the long term a full blown network facility is needed to
1368
avoid creating a real repository object locally.
1371
return self._real_repository.inventories
1375
"""Compress the data within the repository.
1377
This is not currently implemented within the smart server.
1380
return self._real_repository.pack()
1383
def revisions(self):
1384
"""Decorate the real repository for now.
1386
In the short term this should become a real object to intercept graph
1389
In the long term a full blown network facility is needed.
1392
return self._real_repository.revisions
1394
def set_make_working_trees(self, new_value):
1396
new_value_str = "True"
1398
new_value_str = "False"
1399
path = self.bzrdir._path_for_remote_call(self._client)
1401
response = self._call(
1402
'Repository.set_make_working_trees', path, new_value_str)
1403
except errors.UnknownSmartMethod:
1405
self._real_repository.set_make_working_trees(new_value)
1407
if response[0] != 'ok':
1408
raise errors.UnexpectedSmartServerResponse(response)
1411
def signatures(self):
1412
"""Decorate the real repository for now.
1414
In the long term a full blown network facility is needed to avoid
1415
creating a real repository object locally.
1418
return self._real_repository.signatures
1421
def sign_revision(self, revision_id, gpg_strategy):
1423
return self._real_repository.sign_revision(revision_id, gpg_strategy)
1427
"""Decorate the real repository for now.
1429
In the long term a full blown network facility is needed to avoid
1430
creating a real repository object locally.
1433
return self._real_repository.texts
1436
def get_revisions(self, revision_ids):
1438
return self._real_repository.get_revisions(revision_ids)
1440
def supports_rich_root(self):
1441
return self._format.rich_root_data
1443
def iter_reverse_revision_history(self, revision_id):
1445
return self._real_repository.iter_reverse_revision_history(revision_id)
1448
def _serializer(self):
1449
return self._format._serializer
1451
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1453
return self._real_repository.store_revision_signature(
1454
gpg_strategy, plaintext, revision_id)
1456
def add_signature_text(self, revision_id, signature):
1458
return self._real_repository.add_signature_text(revision_id, signature)
1460
def has_signature_for_revision_id(self, revision_id):
1462
return self._real_repository.has_signature_for_revision_id(revision_id)
1464
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
1466
return self._real_repository.item_keys_introduced_by(revision_ids,
1467
_files_pb=_files_pb)
1469
def revision_graph_can_have_wrong_parents(self):
1470
# The answer depends on the remote repo format.
1472
return self._real_repository.revision_graph_can_have_wrong_parents()
1474
def _find_inconsistent_revision_parents(self):
1476
return self._real_repository._find_inconsistent_revision_parents()
1478
def _check_for_inconsistent_revision_parents(self):
1480
return self._real_repository._check_for_inconsistent_revision_parents()
1482
def _make_parents_provider(self, other=None):
1483
providers = [self._unstacked_provider]
1484
if other is not None:
1485
providers.insert(0, other)
1486
providers.extend(r._make_parents_provider() for r in
1487
self._fallback_repositories)
1488
return graph._StackedParentsProvider(providers)
1490
def _serialise_search_recipe(self, recipe):
1491
"""Serialise a graph search recipe.
1493
:param recipe: A search recipe (start, stop, count).
1494
:return: Serialised bytes.
1496
start_keys = ' '.join(recipe[0])
1497
stop_keys = ' '.join(recipe[1])
1498
count = str(recipe[2])
1499
return '\n'.join((start_keys, stop_keys, count))
1501
def _serialise_search_result(self, search_result):
1502
if isinstance(search_result, graph.PendingAncestryResult):
1503
parts = ['ancestry-of']
1504
parts.extend(search_result.heads)
1506
recipe = search_result.get_recipe()
1507
parts = ['search', self._serialise_search_recipe(recipe)]
1508
return '\n'.join(parts)
1511
path = self.bzrdir._path_for_remote_call(self._client)
1513
response = self._call('PackRepository.autopack', path)
1514
except errors.UnknownSmartMethod:
1516
self._real_repository._pack_collection.autopack()
1519
if response[0] != 'ok':
1520
raise errors.UnexpectedSmartServerResponse(response)
1523
class RemoteStreamSink(repository.StreamSink):
1525
def _insert_real(self, stream, src_format, resume_tokens):
1526
self.target_repo._ensure_real()
1527
sink = self.target_repo._real_repository._get_sink()
1528
result = sink.insert_stream(stream, src_format, resume_tokens)
1530
self.target_repo.autopack()
1533
def insert_stream(self, stream, src_format, resume_tokens):
1534
target = self.target_repo
1535
if target._lock_token:
1536
verb = 'Repository.insert_stream_locked'
1537
extra_args = (target._lock_token or '',)
1538
required_version = (1, 14)
1540
verb = 'Repository.insert_stream'
1542
required_version = (1, 13)
1543
client = target._client
1544
medium = client._medium
1545
if medium._is_remote_before(required_version):
1546
# No possible way this can work.
1547
return self._insert_real(stream, src_format, resume_tokens)
1548
path = target.bzrdir._path_for_remote_call(client)
1549
if not resume_tokens:
1550
# XXX: Ugly but important for correctness, *will* be fixed during
1551
# 1.13 cycle. Pushing a stream that is interrupted results in a
1552
# fallback to the _real_repositories sink *with a partial stream*.
1553
# Thats bad because we insert less data than bzr expected. To avoid
1554
# this we do a trial push to make sure the verb is accessible, and
1555
# do not fallback when actually pushing the stream. A cleanup patch
1556
# is going to look at rewinding/restarting the stream/partial
1558
byte_stream = smart_repo._stream_to_byte_stream([], src_format)
1560
response = client.call_with_body_stream(
1561
(verb, path, '') + extra_args, byte_stream)
1562
except errors.UnknownSmartMethod:
1563
medium._remember_remote_is_before(required_version)
1564
return self._insert_real(stream, src_format, resume_tokens)
1565
byte_stream = smart_repo._stream_to_byte_stream(
1567
resume_tokens = ' '.join(resume_tokens)
1568
response = client.call_with_body_stream(
1569
(verb, path, resume_tokens) + extra_args, byte_stream)
1570
if response[0][0] not in ('ok', 'missing-basis'):
1571
raise errors.UnexpectedSmartServerResponse(response)
1572
if response[0][0] == 'missing-basis':
1573
tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
1574
resume_tokens = tokens
1575
return resume_tokens, missing_keys
1577
self.target_repo.refresh_data()
1581
class RemoteStreamSource(repository.StreamSource):
1582
"""Stream data from a remote server."""
1584
def get_stream(self, search):
1585
# streaming with fallback repositories is not well defined yet: The
1586
# remote repository cannot see the fallback repositories, and thus
1587
# cannot satisfy the entire search in the general case. Likewise the
1588
# fallback repositories cannot reify the search to determine what they
1589
# should send. It likely needs a return value in the stream listing the
1590
# edge of the search to resume from in fallback repositories.
1591
if self.from_repository._fallback_repositories:
1592
return repository.StreamSource.get_stream(self, search)
1593
repo = self.from_repository
1594
client = repo._client
1595
medium = client._medium
1596
if medium._is_remote_before((1, 13)):
1597
# No possible way this can work.
1598
return repository.StreamSource.get_stream(self, search)
1599
path = repo.bzrdir._path_for_remote_call(client)
1601
search_bytes = repo._serialise_search_result(search)
1602
response = repo._call_with_body_bytes_expecting_body(
1603
'Repository.get_stream',
1604
(path, self.to_format.network_name()), search_bytes)
1605
response_tuple, response_handler = response
1606
except errors.UnknownSmartMethod:
1607
medium._remember_remote_is_before((1,13))
1608
return repository.StreamSource.get_stream(self, search)
1609
if response_tuple[0] != 'ok':
1610
raise errors.UnexpectedSmartServerResponse(response_tuple)
1611
byte_stream = response_handler.read_streamed_body()
1612
src_format, stream = smart_repo._byte_stream_to_stream(byte_stream)
1613
if src_format.network_name() != repo._format.network_name():
1614
raise AssertionError(
1615
"Mismatched RemoteRepository and stream src %r, %r" % (
1616
src_format.network_name(), repo._format.network_name()))
1620
class RemoteBranchLockableFiles(LockableFiles):
1621
"""A 'LockableFiles' implementation that talks to a smart server.
1623
This is not a public interface class.
1626
def __init__(self, bzrdir, _client):
1627
self.bzrdir = bzrdir
1628
self._client = _client
1629
self._need_find_modes = True
1630
LockableFiles.__init__(
1631
self, bzrdir.get_branch_transport(None),
1632
'lock', lockdir.LockDir)
1634
def _find_modes(self):
1635
# RemoteBranches don't let the client set the mode of control files.
1636
self._dir_mode = None
1637
self._file_mode = None
1640
class RemoteBranchFormat(branch.BranchFormat):
1642
def __init__(self, network_name=None):
1643
super(RemoteBranchFormat, self).__init__()
1644
self._matchingbzrdir = RemoteBzrDirFormat()
1645
self._matchingbzrdir.set_branch_format(self)
1646
self._custom_format = None
1647
self._network_name = network_name
1649
def __eq__(self, other):
1650
return (isinstance(other, RemoteBranchFormat) and
1651
self.__dict__ == other.__dict__)
1653
def _ensure_real(self):
1654
if self._custom_format is None:
1655
self._custom_format = branch.network_format_registry.get(
1658
def get_format_description(self):
1659
return 'Remote BZR Branch'
1661
def network_name(self):
1662
return self._network_name
1664
def open(self, a_bzrdir):
1665
return a_bzrdir.open_branch()
1667
def _vfs_initialize(self, a_bzrdir):
1668
# Initialisation when using a local bzrdir object, or a non-vfs init
1669
# method is not available on the server.
1670
# self._custom_format is always set - the start of initialize ensures
1672
if isinstance(a_bzrdir, RemoteBzrDir):
1673
a_bzrdir._ensure_real()
1674
result = self._custom_format.initialize(a_bzrdir._real_bzrdir)
1676
# We assume the bzrdir is parameterised; it may not be.
1677
result = self._custom_format.initialize(a_bzrdir)
1678
if (isinstance(a_bzrdir, RemoteBzrDir) and
1679
not isinstance(result, RemoteBranch)):
1680
result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result)
1683
def initialize(self, a_bzrdir):
1684
# 1) get the network name to use.
1685
if self._custom_format:
1686
network_name = self._custom_format.network_name()
1688
# Select the current bzrlib default and ask for that.
1689
reference_bzrdir_format = bzrdir.format_registry.get('default')()
1690
reference_format = reference_bzrdir_format.get_branch_format()
1691
self._custom_format = reference_format
1692
network_name = reference_format.network_name()
1693
# Being asked to create on a non RemoteBzrDir:
1694
if not isinstance(a_bzrdir, RemoteBzrDir):
1695
return self._vfs_initialize(a_bzrdir)
1696
medium = a_bzrdir._client._medium
1697
if medium._is_remote_before((1, 13)):
1698
return self._vfs_initialize(a_bzrdir)
1699
# Creating on a remote bzr dir.
1700
# 2) try direct creation via RPC
1701
path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
1702
verb = 'BzrDir.create_branch'
1704
response = a_bzrdir._call(verb, path, network_name)
1705
except errors.UnknownSmartMethod:
1706
# Fallback - use vfs methods
1707
medium._remember_remote_is_before((1, 13))
1708
return self._vfs_initialize(a_bzrdir)
1709
if response[0] != 'ok':
1710
raise errors.UnexpectedSmartServerResponse(response)
1711
# Turn the response into a RemoteRepository object.
1712
format = RemoteBranchFormat(network_name=response[1])
1713
repo_format = response_tuple_to_repo_format(response[3:])
1714
if response[2] == '':
1715
repo_bzrdir = a_bzrdir
1717
repo_bzrdir = RemoteBzrDir(
1718
a_bzrdir.root_transport.clone(response[2]), a_bzrdir._format,
1720
remote_repo = RemoteRepository(repo_bzrdir, repo_format)
1721
remote_branch = RemoteBranch(a_bzrdir, remote_repo,
1722
format=format, setup_stacking=False)
1723
# XXX: We know this is a new branch, so it must have revno 0, revid
1724
# NULL_REVISION. Creating the branch locked would make this be unable
1725
# to be wrong; here its simply very unlikely to be wrong. RBC 20090225
1726
remote_branch._last_revision_info_cache = 0, NULL_REVISION
1727
return remote_branch
1729
def make_tags(self, branch):
1731
return self._custom_format.make_tags(branch)
1733
def supports_tags(self):
1734
# Remote branches might support tags, but we won't know until we
1735
# access the real remote branch.
1737
return self._custom_format.supports_tags()
1739
def supports_stacking(self):
1741
return self._custom_format.supports_stacking()
1744
class RemoteBranch(branch.Branch, _RpcHelper):
1745
"""Branch stored on a server accessed by HPSS RPC.
1747
At the moment most operations are mapped down to simple file operations.
1750
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
1751
_client=None, format=None, setup_stacking=True):
1752
"""Create a RemoteBranch instance.
1754
:param real_branch: An optional local implementation of the branch
1755
format, usually accessing the data via the VFS.
1756
:param _client: Private parameter for testing.
1757
:param format: A RemoteBranchFormat object, None to create one
1758
automatically. If supplied it should have a network_name already
1760
:param setup_stacking: If True make an RPC call to determine the
1761
stacked (or not) status of the branch. If False assume the branch
1764
# We intentionally don't call the parent class's __init__, because it
1765
# will try to assign to self.tags, which is a property in this subclass.
1766
# And the parent's __init__ doesn't do much anyway.
1767
self._revision_id_to_revno_cache = None
1768
self._partial_revision_id_to_revno_cache = {}
1769
self._revision_history_cache = None
1770
self._last_revision_info_cache = None
1771
self._merge_sorted_revisions_cache = None
1772
self.bzrdir = remote_bzrdir
1773
if _client is not None:
1774
self._client = _client
1776
self._client = remote_bzrdir._client
1777
self.repository = remote_repository
1778
if real_branch is not None:
1779
self._real_branch = real_branch
1780
# Give the remote repository the matching real repo.
1781
real_repo = self._real_branch.repository
1782
if isinstance(real_repo, RemoteRepository):
1783
real_repo._ensure_real()
1784
real_repo = real_repo._real_repository
1785
self.repository._set_real_repository(real_repo)
1786
# Give the branch the remote repository to let fast-pathing happen.
1787
self._real_branch.repository = self.repository
1789
self._real_branch = None
1790
# Fill out expected attributes of branch for bzrlib api users.
1791
self.base = self.bzrdir.root_transport.base
1792
self._control_files = None
1793
self._lock_mode = None
1794
self._lock_token = None
1795
self._repo_lock_token = None
1796
self._lock_count = 0
1797
self._leave_lock = False
1798
# Setup a format: note that we cannot call _ensure_real until all the
1799
# attributes above are set: This code cannot be moved higher up in this
1802
self._format = RemoteBranchFormat()
1803
if real_branch is not None:
1804
self._format._network_name = \
1805
self._real_branch._format.network_name()
1807
self._format = format
1808
if not self._format._network_name:
1809
# Did not get from open_branchV2 - old server.
1811
self._format._network_name = \
1812
self._real_branch._format.network_name()
1813
self.tags = self._format.make_tags(self)
1814
# The base class init is not called, so we duplicate this:
1815
hooks = branch.Branch.hooks['open']
1819
self._setup_stacking()
1821
def _setup_stacking(self):
1822
# configure stacking into the remote repository, by reading it from
1825
fallback_url = self.get_stacked_on_url()
1826
except (errors.NotStacked, errors.UnstackableBranchFormat,
1827
errors.UnstackableRepositoryFormat), e:
1829
# it's relative to this branch...
1830
fallback_url = urlutils.join(self.base, fallback_url)
1831
transports = [self.bzrdir.root_transport]
1832
stacked_on = branch.Branch.open(fallback_url,
1833
possible_transports=transports)
1834
self.repository.add_fallback_repository(stacked_on.repository)
1836
def _get_real_transport(self):
1837
# if we try vfs access, return the real branch's vfs transport
1839
return self._real_branch._transport
1841
_transport = property(_get_real_transport)
1844
return "%s(%s)" % (self.__class__.__name__, self.base)
1848
def _ensure_real(self):
1849
"""Ensure that there is a _real_branch set.
1851
Used before calls to self._real_branch.
1853
if self._real_branch is None:
1854
if not vfs.vfs_enabled():
1855
raise AssertionError('smart server vfs must be enabled '
1856
'to use vfs implementation')
1857
self.bzrdir._ensure_real()
1858
self._real_branch = self.bzrdir._real_bzrdir.open_branch()
1859
if self.repository._real_repository is None:
1860
# Give the remote repository the matching real repo.
1861
real_repo = self._real_branch.repository
1862
if isinstance(real_repo, RemoteRepository):
1863
real_repo._ensure_real()
1864
real_repo = real_repo._real_repository
1865
self.repository._set_real_repository(real_repo)
1866
# Give the real branch the remote repository to let fast-pathing
1868
self._real_branch.repository = self.repository
1869
if self._lock_mode == 'r':
1870
self._real_branch.lock_read()
1871
elif self._lock_mode == 'w':
1872
self._real_branch.lock_write(token=self._lock_token)
1874
def _translate_error(self, err, **context):
1875
self.repository._translate_error(err, branch=self, **context)
1877
def _clear_cached_state(self):
1878
super(RemoteBranch, self)._clear_cached_state()
1879
if self._real_branch is not None:
1880
self._real_branch._clear_cached_state()
1882
def _clear_cached_state_of_remote_branch_only(self):
1883
"""Like _clear_cached_state, but doesn't clear the cache of
1886
This is useful when falling back to calling a method of
1887
self._real_branch that changes state. In that case the underlying
1888
branch changes, so we need to invalidate this RemoteBranch's cache of
1889
it. However, there's no need to invalidate the _real_branch's cache
1890
too, in fact doing so might harm performance.
1892
super(RemoteBranch, self)._clear_cached_state()
1895
def control_files(self):
1896
# Defer actually creating RemoteBranchLockableFiles until its needed,
1897
# because it triggers an _ensure_real that we otherwise might not need.
1898
if self._control_files is None:
1899
self._control_files = RemoteBranchLockableFiles(
1900
self.bzrdir, self._client)
1901
return self._control_files
1903
def _get_checkout_format(self):
1905
return self._real_branch._get_checkout_format()
1907
def get_physical_lock_status(self):
1908
"""See Branch.get_physical_lock_status()."""
1909
# should be an API call to the server, as branches must be lockable.
1911
return self._real_branch.get_physical_lock_status()
1913
def get_stacked_on_url(self):
1914
"""Get the URL this branch is stacked against.
1916
:raises NotStacked: If the branch is not stacked.
1917
:raises UnstackableBranchFormat: If the branch does not support
1919
:raises UnstackableRepositoryFormat: If the repository does not support
1923
# there may not be a repository yet, so we can't use
1924
# self._translate_error, so we can't use self._call either.
1925
response = self._client.call('Branch.get_stacked_on_url',
1926
self._remote_path())
1927
except errors.ErrorFromSmartServer, err:
1928
# there may not be a repository yet, so we can't call through
1929
# its _translate_error
1930
_translate_error(err, branch=self)
1931
except errors.UnknownSmartMethod, err:
1933
return self._real_branch.get_stacked_on_url()
1934
if response[0] != 'ok':
1935
raise errors.UnexpectedSmartServerResponse(response)
1938
def _vfs_get_tags_bytes(self):
1940
return self._real_branch._get_tags_bytes()
1942
def _get_tags_bytes(self):
1943
medium = self._client._medium
1944
if medium._is_remote_before((1, 13)):
1945
return self._vfs_get_tags_bytes()
1947
response = self._call('Branch.get_tags_bytes', self._remote_path())
1948
except errors.UnknownSmartMethod:
1949
medium._remember_remote_is_before((1, 13))
1950
return self._vfs_get_tags_bytes()
1953
def lock_read(self):
1954
self.repository.lock_read()
1955
if not self._lock_mode:
1956
self._lock_mode = 'r'
1957
self._lock_count = 1
1958
if self._real_branch is not None:
1959
self._real_branch.lock_read()
1961
self._lock_count += 1
1963
def _remote_lock_write(self, token):
1965
branch_token = repo_token = ''
1967
branch_token = token
1968
repo_token = self.repository.lock_write()
1969
self.repository.unlock()
1970
err_context = {'token': token}
1971
response = self._call(
1972
'Branch.lock_write', self._remote_path(), branch_token,
1973
repo_token or '', **err_context)
1974
if response[0] != 'ok':
1975
raise errors.UnexpectedSmartServerResponse(response)
1976
ok, branch_token, repo_token = response
1977
return branch_token, repo_token
1979
def lock_write(self, token=None):
1980
if not self._lock_mode:
1981
# Lock the branch and repo in one remote call.
1982
remote_tokens = self._remote_lock_write(token)
1983
self._lock_token, self._repo_lock_token = remote_tokens
1984
if not self._lock_token:
1985
raise SmartProtocolError('Remote server did not return a token!')
1986
# Tell the self.repository object that it is locked.
1987
self.repository.lock_write(
1988
self._repo_lock_token, _skip_rpc=True)
1990
if self._real_branch is not None:
1991
self._real_branch.lock_write(token=self._lock_token)
1992
if token is not None:
1993
self._leave_lock = True
1995
self._leave_lock = False
1996
self._lock_mode = 'w'
1997
self._lock_count = 1
1998
elif self._lock_mode == 'r':
1999
raise errors.ReadOnlyTransaction
2001
if token is not None:
2002
# A token was given to lock_write, and we're relocking, so
2003
# check that the given token actually matches the one we
2005
if token != self._lock_token:
2006
raise errors.TokenMismatch(token, self._lock_token)
2007
self._lock_count += 1
2008
# Re-lock the repository too.
2009
self.repository.lock_write(self._repo_lock_token)
2010
return self._lock_token or None
2012
def _set_tags_bytes(self, bytes):
2014
return self._real_branch._set_tags_bytes(bytes)
2016
def _unlock(self, branch_token, repo_token):
2017
err_context = {'token': str((branch_token, repo_token))}
2018
response = self._call(
2019
'Branch.unlock', self._remote_path(), branch_token,
2020
repo_token or '', **err_context)
2021
if response == ('ok',):
2023
raise errors.UnexpectedSmartServerResponse(response)
2027
self._lock_count -= 1
2028
if not self._lock_count:
2029
self._clear_cached_state()
2030
mode = self._lock_mode
2031
self._lock_mode = None
2032
if self._real_branch is not None:
2033
if (not self._leave_lock and mode == 'w' and
2034
self._repo_lock_token):
2035
# If this RemoteBranch will remove the physical lock
2036
# for the repository, make sure the _real_branch
2037
# doesn't do it first. (Because the _real_branch's
2038
# repository is set to be the RemoteRepository.)
2039
self._real_branch.repository.leave_lock_in_place()
2040
self._real_branch.unlock()
2042
# Only write-locked branched need to make a remote method
2043
# call to perfom the unlock.
2045
if not self._lock_token:
2046
raise AssertionError('Locked, but no token!')
2047
branch_token = self._lock_token
2048
repo_token = self._repo_lock_token
2049
self._lock_token = None
2050
self._repo_lock_token = None
2051
if not self._leave_lock:
2052
self._unlock(branch_token, repo_token)
2054
self.repository.unlock()
2056
def break_lock(self):
2058
return self._real_branch.break_lock()
2060
def leave_lock_in_place(self):
2061
if not self._lock_token:
2062
raise NotImplementedError(self.leave_lock_in_place)
2063
self._leave_lock = True
2065
def dont_leave_lock_in_place(self):
2066
if not self._lock_token:
2067
raise NotImplementedError(self.dont_leave_lock_in_place)
2068
self._leave_lock = False
2070
def _last_revision_info(self):
2071
response = self._call('Branch.last_revision_info', self._remote_path())
2072
if response[0] != 'ok':
2073
raise SmartProtocolError('unexpected response code %s' % (response,))
2074
revno = int(response[1])
2075
last_revision = response[2]
2076
return (revno, last_revision)
2078
def _gen_revision_history(self):
2079
"""See Branch._gen_revision_history()."""
2080
response_tuple, response_handler = self._call_expecting_body(
2081
'Branch.revision_history', self._remote_path())
2082
if response_tuple[0] != 'ok':
2083
raise errors.UnexpectedSmartServerResponse(response_tuple)
2084
result = response_handler.read_body_bytes().split('\x00')
2089
def _remote_path(self):
2090
return self.bzrdir._path_for_remote_call(self._client)
2092
def _set_last_revision_descendant(self, revision_id, other_branch,
2093
allow_diverged=False, allow_overwrite_descendant=False):
2094
# This performs additional work to meet the hook contract; while its
2095
# undesirable, we have to synthesise the revno to call the hook, and
2096
# not calling the hook is worse as it means changes can't be prevented.
2097
# Having calculated this though, we can't just call into
2098
# set_last_revision_info as a simple call, because there is a set_rh
2099
# hook that some folk may still be using.
2100
old_revno, old_revid = self.last_revision_info()
2101
history = self._lefthand_history(revision_id)
2102
self._run_pre_change_branch_tip_hooks(len(history), revision_id)
2103
err_context = {'other_branch': other_branch}
2104
response = self._call('Branch.set_last_revision_ex',
2105
self._remote_path(), self._lock_token, self._repo_lock_token,
2106
revision_id, int(allow_diverged), int(allow_overwrite_descendant),
2108
self._clear_cached_state()
2109
if len(response) != 3 and response[0] != 'ok':
2110
raise errors.UnexpectedSmartServerResponse(response)
2111
new_revno, new_revision_id = response[1:]
2112
self._last_revision_info_cache = new_revno, new_revision_id
2113
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2114
if self._real_branch is not None:
2115
cache = new_revno, new_revision_id
2116
self._real_branch._last_revision_info_cache = cache
2118
def _set_last_revision(self, revision_id):
2119
old_revno, old_revid = self.last_revision_info()
2120
# This performs additional work to meet the hook contract; while its
2121
# undesirable, we have to synthesise the revno to call the hook, and
2122
# not calling the hook is worse as it means changes can't be prevented.
2123
# Having calculated this though, we can't just call into
2124
# set_last_revision_info as a simple call, because there is a set_rh
2125
# hook that some folk may still be using.
2126
history = self._lefthand_history(revision_id)
2127
self._run_pre_change_branch_tip_hooks(len(history), revision_id)
2128
self._clear_cached_state()
2129
response = self._call('Branch.set_last_revision',
2130
self._remote_path(), self._lock_token, self._repo_lock_token,
2132
if response != ('ok',):
2133
raise errors.UnexpectedSmartServerResponse(response)
2134
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2137
def set_revision_history(self, rev_history):
2138
# Send just the tip revision of the history; the server will generate
2139
# the full history from that. If the revision doesn't exist in this
2140
# branch, NoSuchRevision will be raised.
2141
if rev_history == []:
2144
rev_id = rev_history[-1]
2145
self._set_last_revision(rev_id)
2146
for hook in branch.Branch.hooks['set_rh']:
2147
hook(self, rev_history)
2148
self._cache_revision_history(rev_history)
2150
def _get_parent_location(self):
2151
medium = self._client._medium
2152
if medium._is_remote_before((1, 13)):
2153
return self._vfs_get_parent_location()
2155
response = self._call('Branch.get_parent', self._remote_path())
2156
except errors.UnknownSmartMethod:
2157
medium._remember_remote_is_before((1, 13))
2158
return self._vfs_get_parent_location()
2159
if len(response) != 1:
2160
raise errors.UnexpectedSmartServerResponse(response)
2161
parent_location = response[0]
2162
if parent_location == '':
2164
return parent_location
2166
def _vfs_get_parent_location(self):
2168
return self._real_branch._get_parent_location()
2170
def set_parent(self, url):
2172
return self._real_branch.set_parent(url)
2174
def _set_parent_location(self, url):
2175
# Used by tests, to poke bad urls into branch configurations
2177
self.set_parent(url)
2180
return self._real_branch._set_parent_location(url)
2182
def set_stacked_on_url(self, stacked_location):
2183
"""Set the URL this branch is stacked against.
2185
:raises UnstackableBranchFormat: If the branch does not support
2187
:raises UnstackableRepositoryFormat: If the repository does not support
2191
return self._real_branch.set_stacked_on_url(stacked_location)
2194
def pull(self, source, overwrite=False, stop_revision=None,
2196
self._clear_cached_state_of_remote_branch_only()
2198
return self._real_branch.pull(
2199
source, overwrite=overwrite, stop_revision=stop_revision,
2200
_override_hook_target=self, **kwargs)
2203
def push(self, target, overwrite=False, stop_revision=None):
2205
return self._real_branch.push(
2206
target, overwrite=overwrite, stop_revision=stop_revision,
2207
_override_hook_source_branch=self)
2209
def is_locked(self):
2210
return self._lock_count >= 1
2213
def revision_id_to_revno(self, revision_id):
2215
return self._real_branch.revision_id_to_revno(revision_id)
2218
def set_last_revision_info(self, revno, revision_id):
2219
# XXX: These should be returned by the set_last_revision_info verb
2220
old_revno, old_revid = self.last_revision_info()
2221
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2222
revision_id = ensure_null(revision_id)
2224
response = self._call('Branch.set_last_revision_info',
2225
self._remote_path(), self._lock_token, self._repo_lock_token,
2226
str(revno), revision_id)
2227
except errors.UnknownSmartMethod:
2229
self._clear_cached_state_of_remote_branch_only()
2230
self._real_branch.set_last_revision_info(revno, revision_id)
2231
self._last_revision_info_cache = revno, revision_id
2233
if response == ('ok',):
2234
self._clear_cached_state()
2235
self._last_revision_info_cache = revno, revision_id
2236
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2237
# Update the _real_branch's cache too.
2238
if self._real_branch is not None:
2239
cache = self._last_revision_info_cache
2240
self._real_branch._last_revision_info_cache = cache
2242
raise errors.UnexpectedSmartServerResponse(response)
2245
def generate_revision_history(self, revision_id, last_rev=None,
2247
medium = self._client._medium
2248
if not medium._is_remote_before((1, 6)):
2249
# Use a smart method for 1.6 and above servers
2251
self._set_last_revision_descendant(revision_id, other_branch,
2252
allow_diverged=True, allow_overwrite_descendant=True)
2254
except errors.UnknownSmartMethod:
2255
medium._remember_remote_is_before((1, 6))
2256
self._clear_cached_state_of_remote_branch_only()
2257
self.set_revision_history(self._lefthand_history(revision_id,
2258
last_rev=last_rev,other_branch=other_branch))
2260
def set_push_location(self, location):
2262
return self._real_branch.set_push_location(location)
2265
def _extract_tar(tar, to_dir):
2266
"""Extract all the contents of a tarfile object.
2268
A replacement for extractall, which is not present in python2.4
2271
tar.extract(tarinfo, to_dir)
2274
def _translate_error(err, **context):
2275
"""Translate an ErrorFromSmartServer into a more useful error.
2277
Possible context keys:
2285
If the error from the server doesn't match a known pattern, then
2286
UnknownErrorFromSmartServer is raised.
2290
return context[name]
2291
except KeyError, key_err:
2292
mutter('Missing key %r in context %r', key_err.args[0], context)
2295
"""Get the path from the context if present, otherwise use first error
2299
return context['path']
2300
except KeyError, key_err:
2302
return err.error_args[0]
2303
except IndexError, idx_err:
2305
'Missing key %r in context %r', key_err.args[0], context)
2308
if err.error_verb == 'NoSuchRevision':
2309
raise NoSuchRevision(find('branch'), err.error_args[0])
2310
elif err.error_verb == 'nosuchrevision':
2311
raise NoSuchRevision(find('repository'), err.error_args[0])
2312
elif err.error_tuple == ('nobranch',):
2313
raise errors.NotBranchError(path=find('bzrdir').root_transport.base)
2314
elif err.error_verb == 'norepository':
2315
raise errors.NoRepositoryPresent(find('bzrdir'))
2316
elif err.error_verb == 'LockContention':
2317
raise errors.LockContention('(remote lock)')
2318
elif err.error_verb == 'UnlockableTransport':
2319
raise errors.UnlockableTransport(find('bzrdir').root_transport)
2320
elif err.error_verb == 'LockFailed':
2321
raise errors.LockFailed(err.error_args[0], err.error_args[1])
2322
elif err.error_verb == 'TokenMismatch':
2323
raise errors.TokenMismatch(find('token'), '(remote token)')
2324
elif err.error_verb == 'Diverged':
2325
raise errors.DivergedBranches(find('branch'), find('other_branch'))
2326
elif err.error_verb == 'TipChangeRejected':
2327
raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
2328
elif err.error_verb == 'UnstackableBranchFormat':
2329
raise errors.UnstackableBranchFormat(*err.error_args)
2330
elif err.error_verb == 'UnstackableRepositoryFormat':
2331
raise errors.UnstackableRepositoryFormat(*err.error_args)
2332
elif err.error_verb == 'NotStacked':
2333
raise errors.NotStacked(branch=find('branch'))
2334
elif err.error_verb == 'PermissionDenied':
2336
if len(err.error_args) >= 2:
2337
extra = err.error_args[1]
2340
raise errors.PermissionDenied(path, extra=extra)
2341
elif err.error_verb == 'ReadError':
2343
raise errors.ReadError(path)
2344
elif err.error_verb == 'NoSuchFile':
2346
raise errors.NoSuchFile(path)
2347
elif err.error_verb == 'FileExists':
2348
raise errors.FileExists(err.error_args[0])
2349
elif err.error_verb == 'DirectoryNotEmpty':
2350
raise errors.DirectoryNotEmpty(err.error_args[0])
2351
elif err.error_verb == 'ShortReadvError':
2352
args = err.error_args
2353
raise errors.ShortReadvError(
2354
args[0], int(args[1]), int(args[2]), int(args[3]))
2355
elif err.error_verb in ('UnicodeEncodeError', 'UnicodeDecodeError'):
2356
encoding = str(err.error_args[0]) # encoding must always be a string
2357
val = err.error_args[1]
2358
start = int(err.error_args[2])
2359
end = int(err.error_args[3])
2360
reason = str(err.error_args[4]) # reason must always be a string
2361
if val.startswith('u:'):
2362
val = val[2:].decode('utf-8')
2363
elif val.startswith('s:'):
2364
val = val[2:].decode('base64')
2365
if err.error_verb == 'UnicodeDecodeError':
2366
raise UnicodeDecodeError(encoding, val, start, end, reason)
2367
elif err.error_verb == 'UnicodeEncodeError':
2368
raise UnicodeEncodeError(encoding, val, start, end, reason)
2369
elif err.error_verb == 'ReadOnlyError':
2370
raise errors.TransportNotPossible('readonly transport')
2371
raise errors.UnknownErrorFromSmartServer(err)
added
removed
bzrlib/remote.py
