1
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
# TODO: At some point, handle upgrades by just passing the whole request
18
# across to run on the server.
35
from bzrlib.branch import BranchReferenceFormat
36
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
37
from bzrlib.decorators import needs_read_lock, needs_write_lock
38
from bzrlib.errors import (
42
from bzrlib.lockable_files import LockableFiles
43
from bzrlib.smart import client, vfs, repository as smart_repo
44
from bzrlib.revision import ensure_null, NULL_REVISION
45
from bzrlib.trace import mutter, note, warning
46
from bzrlib.util import bencode
49
class _RpcHelper(object):
50
"""Mixin class that helps with issuing RPCs."""
52
def _call(self, method, *args, **err_context):
54
return self._client.call(method, *args)
55
except errors.ErrorFromSmartServer, err:
56
self._translate_error(err, **err_context)
58
def _call_expecting_body(self, method, *args, **err_context):
60
return self._client.call_expecting_body(method, *args)
61
except errors.ErrorFromSmartServer, err:
62
self._translate_error(err, **err_context)
64
def _call_with_body_bytes_expecting_body(self, method, args, body_bytes,
67
return self._client.call_with_body_bytes_expecting_body(
68
method, args, body_bytes)
69
except errors.ErrorFromSmartServer, err:
70
self._translate_error(err, **err_context)
73
def response_tuple_to_repo_format(response):
74
"""Convert a response tuple describing a repository format to a format."""
75
format = RemoteRepositoryFormat()
76
format._rich_root_data = (response[0] == 'yes')
77
format._supports_tree_reference = (response[1] == 'yes')
78
format._supports_external_lookups = (response[2] == 'yes')
79
format._network_name = response[3]
83
# Note: RemoteBzrDirFormat is in bzrdir.py
85
class RemoteBzrDir(BzrDir, _RpcHelper):
86
"""Control directory on a remote server, accessed via bzr:// or similar."""
88
def __init__(self, transport, format, _client=None):
89
"""Construct a RemoteBzrDir.
91
:param _client: Private parameter for testing. Disables probing and the
94
BzrDir.__init__(self, transport, format)
95
# this object holds a delegated bzrdir that uses file-level operations
96
# to talk to the other side
97
self._real_bzrdir = None
98
# 1-shot cache for the call pattern 'create_branch; open_branch' - see
99
# create_branch for details.
100
self._next_open_branch_result = None
103
medium = transport.get_smart_medium()
104
self._client = client._SmartClient(medium)
106
self._client = _client
109
path = self._path_for_remote_call(self._client)
110
response = self._call('BzrDir.open', path)
111
if response not in [('yes',), ('no',)]:
112
raise errors.UnexpectedSmartServerResponse(response)
113
if response == ('no',):
114
raise errors.NotBranchError(path=transport.base)
116
def _ensure_real(self):
117
"""Ensure that there is a _real_bzrdir set.
119
Used before calls to self._real_bzrdir.
121
if not self._real_bzrdir:
122
self._real_bzrdir = BzrDir.open_from_transport(
123
self.root_transport, _server_formats=False)
124
self._format._network_name = \
125
self._real_bzrdir._format.network_name()
127
def _translate_error(self, err, **context):
128
_translate_error(err, bzrdir=self, **context)
130
def break_lock(self):
131
# Prevent aliasing problems in the next_open_branch_result cache.
132
# See create_branch for rationale.
133
self._next_open_branch_result = None
134
return BzrDir.break_lock(self)
136
def _vfs_cloning_metadir(self, require_stacking=False):
138
return self._real_bzrdir.cloning_metadir(
139
require_stacking=require_stacking)
141
def cloning_metadir(self, require_stacking=False):
142
medium = self._client._medium
143
if medium._is_remote_before((1, 13)):
144
return self._vfs_cloning_metadir(require_stacking=require_stacking)
145
verb = 'BzrDir.cloning_metadir'
150
path = self._path_for_remote_call(self._client)
152
response = self._call(verb, path, stacking)
153
except errors.UnknownSmartMethod:
154
medium._remember_remote_is_before((1, 13))
155
return self._vfs_cloning_metadir(require_stacking=require_stacking)
156
except errors.UnknownErrorFromSmartServer, err:
157
if err.error_tuple != ('BranchReference',):
159
# We need to resolve the branch reference to determine the
160
# cloning_metadir. This causes unnecessary RPCs to open the
161
# referenced branch (and bzrdir, etc) but only when the caller
162
# didn't already resolve the branch reference.
163
referenced_branch = self.open_branch()
164
return referenced_branch.bzrdir.cloning_metadir()
165
if len(response) != 3:
166
raise errors.UnexpectedSmartServerResponse(response)
167
control_name, repo_name, branch_info = response
168
if len(branch_info) != 2:
169
raise errors.UnexpectedSmartServerResponse(response)
170
branch_ref, branch_name = branch_info
171
format = bzrdir.network_format_registry.get(control_name)
173
format.repository_format = repository.network_format_registry.get(
175
if branch_ref == 'ref':
176
# XXX: we need possible_transports here to avoid reopening the
177
# connection to the referenced location
178
ref_bzrdir = BzrDir.open(branch_name)
179
branch_format = ref_bzrdir.cloning_metadir().get_branch_format()
180
format.set_branch_format(branch_format)
181
elif branch_ref == 'branch':
183
format.set_branch_format(
184
branch.network_format_registry.get(branch_name))
186
raise errors.UnexpectedSmartServerResponse(response)
189
def create_repository(self, shared=False):
190
# as per meta1 formats - just delegate to the format object which may
192
result = self._format.repository_format.initialize(self, shared)
193
if not isinstance(result, RemoteRepository):
194
return self.open_repository()
198
def destroy_repository(self):
199
"""See BzrDir.destroy_repository"""
201
self._real_bzrdir.destroy_repository()
203
def create_branch(self):
204
# as per meta1 formats - just delegate to the format object which may
206
real_branch = self._format.get_branch_format().initialize(self)
207
if not isinstance(real_branch, RemoteBranch):
208
result = RemoteBranch(self, self.find_repository(), real_branch)
211
# BzrDir.clone_on_transport() uses the result of create_branch but does
212
# not return it to its callers; we save approximately 8% of our round
213
# trips by handing the branch we created back to the first caller to
214
# open_branch rather than probing anew. Long term we need a API in
215
# bzrdir that doesn't discard result objects (like result_branch).
217
self._next_open_branch_result = result
220
def destroy_branch(self):
221
"""See BzrDir.destroy_branch"""
223
self._real_bzrdir.destroy_branch()
224
self._next_open_branch_result = None
226
def create_workingtree(self, revision_id=None, from_branch=None):
227
raise errors.NotLocalUrl(self.transport.base)
229
def find_branch_format(self):
230
"""Find the branch 'format' for this bzrdir.
232
This might be a synthetic object for e.g. RemoteBranch and SVN.
234
b = self.open_branch()
237
def get_branch_reference(self):
238
"""See BzrDir.get_branch_reference()."""
239
response = self._get_branch_reference()
240
if response[0] == 'ref':
245
def _get_branch_reference(self):
246
path = self._path_for_remote_call(self._client)
247
medium = self._client._medium
248
if not medium._is_remote_before((1, 13)):
250
response = self._call('BzrDir.open_branchV2', path)
251
if response[0] not in ('ref', 'branch'):
252
raise errors.UnexpectedSmartServerResponse(response)
254
except errors.UnknownSmartMethod:
255
medium._remember_remote_is_before((1, 13))
256
response = self._call('BzrDir.open_branch', path)
257
if response[0] != 'ok':
258
raise errors.UnexpectedSmartServerResponse(response)
259
if response[1] != '':
260
return ('ref', response[1])
262
return ('branch', '')
264
def _get_tree_branch(self):
265
"""See BzrDir._get_tree_branch()."""
266
return None, self.open_branch()
268
def open_branch(self, _unsupported=False, ignore_fallbacks=False):
270
raise NotImplementedError('unsupported flag support not implemented yet.')
271
if self._next_open_branch_result is not None:
272
# See create_branch for details.
273
result = self._next_open_branch_result
274
self._next_open_branch_result = None
276
response = self._get_branch_reference()
277
if response[0] == 'ref':
278
# a branch reference, use the existing BranchReference logic.
279
format = BranchReferenceFormat()
280
return format.open(self, _found=True, location=response[1],
281
ignore_fallbacks=ignore_fallbacks)
282
branch_format_name = response[1]
283
if not branch_format_name:
284
branch_format_name = None
285
format = RemoteBranchFormat(network_name=branch_format_name)
286
return RemoteBranch(self, self.find_repository(), format=format,
287
setup_stacking=not ignore_fallbacks)
289
def _open_repo_v1(self, path):
290
verb = 'BzrDir.find_repository'
291
response = self._call(verb, path)
292
if response[0] != 'ok':
293
raise errors.UnexpectedSmartServerResponse(response)
294
# servers that only support the v1 method don't support external
297
repo = self._real_bzrdir.open_repository()
298
response = response + ('no', repo._format.network_name())
299
return response, repo
301
def _open_repo_v2(self, path):
302
verb = 'BzrDir.find_repositoryV2'
303
response = self._call(verb, path)
304
if response[0] != 'ok':
305
raise errors.UnexpectedSmartServerResponse(response)
307
repo = self._real_bzrdir.open_repository()
308
response = response + (repo._format.network_name(),)
309
return response, repo
311
def _open_repo_v3(self, path):
312
verb = 'BzrDir.find_repositoryV3'
313
medium = self._client._medium
314
if medium._is_remote_before((1, 13)):
315
raise errors.UnknownSmartMethod(verb)
317
response = self._call(verb, path)
318
except errors.UnknownSmartMethod:
319
medium._remember_remote_is_before((1, 13))
321
if response[0] != 'ok':
322
raise errors.UnexpectedSmartServerResponse(response)
323
return response, None
325
def open_repository(self):
326
path = self._path_for_remote_call(self._client)
328
for probe in [self._open_repo_v3, self._open_repo_v2,
331
response, real_repo = probe(path)
333
except errors.UnknownSmartMethod:
336
raise errors.UnknownSmartMethod('BzrDir.find_repository{3,2,}')
337
if response[0] != 'ok':
338
raise errors.UnexpectedSmartServerResponse(response)
339
if len(response) != 6:
340
raise SmartProtocolError('incorrect response length %s' % (response,))
341
if response[1] == '':
342
# repo is at this dir.
343
format = response_tuple_to_repo_format(response[2:])
344
# Used to support creating a real format instance when needed.
345
format._creating_bzrdir = self
346
remote_repo = RemoteRepository(self, format)
347
format._creating_repo = remote_repo
348
if real_repo is not None:
349
remote_repo._set_real_repository(real_repo)
352
raise errors.NoRepositoryPresent(self)
354
def open_workingtree(self, recommend_upgrade=True):
356
if self._real_bzrdir.has_workingtree():
357
raise errors.NotLocalUrl(self.root_transport)
359
raise errors.NoWorkingTree(self.root_transport.base)
361
def _path_for_remote_call(self, client):
362
"""Return the path to be used for this bzrdir in a remote call."""
363
return client.remote_path_from_transport(self.root_transport)
365
def get_branch_transport(self, branch_format):
367
return self._real_bzrdir.get_branch_transport(branch_format)
369
def get_repository_transport(self, repository_format):
371
return self._real_bzrdir.get_repository_transport(repository_format)
373
def get_workingtree_transport(self, workingtree_format):
375
return self._real_bzrdir.get_workingtree_transport(workingtree_format)
377
def can_convert_format(self):
378
"""Upgrading of remote bzrdirs is not supported yet."""
381
def needs_format_conversion(self, format=None):
382
"""Upgrading of remote bzrdirs is not supported yet."""
384
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
385
% 'needs_format_conversion(format=None)')
388
def clone(self, url, revision_id=None, force_new_repo=False,
389
preserve_stacking=False):
391
return self._real_bzrdir.clone(url, revision_id=revision_id,
392
force_new_repo=force_new_repo, preserve_stacking=preserve_stacking)
394
def get_config(self):
396
return self._real_bzrdir.get_config()
399
class RemoteRepositoryFormat(repository.RepositoryFormat):
400
"""Format for repositories accessed over a _SmartClient.
402
Instances of this repository are represented by RemoteRepository
405
The RemoteRepositoryFormat is parameterized during construction
406
to reflect the capabilities of the real, remote format. Specifically
407
the attributes rich_root_data and supports_tree_reference are set
408
on a per instance basis, and are not set (and should not be) at
411
:ivar _custom_format: If set, a specific concrete repository format that
412
will be used when initializing a repository with this
413
RemoteRepositoryFormat.
414
:ivar _creating_repo: If set, the repository object that this
415
RemoteRepositoryFormat was created for: it can be called into
416
to obtain data like the network name.
419
_matchingbzrdir = RemoteBzrDirFormat()
422
repository.RepositoryFormat.__init__(self)
423
self._custom_format = None
424
self._network_name = None
425
self._creating_bzrdir = None
426
self._supports_external_lookups = None
427
self._supports_tree_reference = None
428
self._rich_root_data = None
431
def fast_deltas(self):
433
return self._custom_format.fast_deltas
436
def rich_root_data(self):
437
if self._rich_root_data is None:
439
self._rich_root_data = self._custom_format.rich_root_data
440
return self._rich_root_data
443
def supports_external_lookups(self):
444
if self._supports_external_lookups is None:
446
self._supports_external_lookups = \
447
self._custom_format.supports_external_lookups
448
return self._supports_external_lookups
451
def supports_tree_reference(self):
452
if self._supports_tree_reference is None:
454
self._supports_tree_reference = \
455
self._custom_format.supports_tree_reference
456
return self._supports_tree_reference
458
def _vfs_initialize(self, a_bzrdir, shared):
459
"""Helper for common code in initialize."""
460
if self._custom_format:
461
# Custom format requested
462
result = self._custom_format.initialize(a_bzrdir, shared=shared)
463
elif self._creating_bzrdir is not None:
464
# Use the format that the repository we were created to back
466
prior_repo = self._creating_bzrdir.open_repository()
467
prior_repo._ensure_real()
468
result = prior_repo._real_repository._format.initialize(
469
a_bzrdir, shared=shared)
471
# assume that a_bzr is a RemoteBzrDir but the smart server didn't
472
# support remote initialization.
473
# We delegate to a real object at this point (as RemoteBzrDir
474
# delegate to the repository format which would lead to infinite
475
# recursion if we just called a_bzrdir.create_repository.
476
a_bzrdir._ensure_real()
477
result = a_bzrdir._real_bzrdir.create_repository(shared=shared)
478
if not isinstance(result, RemoteRepository):
479
return self.open(a_bzrdir)
483
def initialize(self, a_bzrdir, shared=False):
484
# Being asked to create on a non RemoteBzrDir:
485
if not isinstance(a_bzrdir, RemoteBzrDir):
486
return self._vfs_initialize(a_bzrdir, shared)
487
medium = a_bzrdir._client._medium
488
if medium._is_remote_before((1, 13)):
489
return self._vfs_initialize(a_bzrdir, shared)
490
# Creating on a remote bzr dir.
491
# 1) get the network name to use.
492
if self._custom_format:
493
network_name = self._custom_format.network_name()
495
# Select the current bzrlib default and ask for that.
496
reference_bzrdir_format = bzrdir.format_registry.get('default')()
497
reference_format = reference_bzrdir_format.repository_format
498
network_name = reference_format.network_name()
499
# 2) try direct creation via RPC
500
path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
501
verb = 'BzrDir.create_repository'
507
response = a_bzrdir._call(verb, path, network_name, shared_str)
508
except errors.UnknownSmartMethod:
509
# Fallback - use vfs methods
510
medium._remember_remote_is_before((1, 13))
511
return self._vfs_initialize(a_bzrdir, shared)
513
# Turn the response into a RemoteRepository object.
514
format = response_tuple_to_repo_format(response[1:])
515
# Used to support creating a real format instance when needed.
516
format._creating_bzrdir = a_bzrdir
517
remote_repo = RemoteRepository(a_bzrdir, format)
518
format._creating_repo = remote_repo
521
def open(self, a_bzrdir):
522
if not isinstance(a_bzrdir, RemoteBzrDir):
523
raise AssertionError('%r is not a RemoteBzrDir' % (a_bzrdir,))
524
return a_bzrdir.open_repository()
526
def _ensure_real(self):
527
if self._custom_format is None:
528
self._custom_format = repository.network_format_registry.get(
532
def _fetch_order(self):
534
return self._custom_format._fetch_order
537
def _fetch_uses_deltas(self):
539
return self._custom_format._fetch_uses_deltas
542
def _fetch_reconcile(self):
544
return self._custom_format._fetch_reconcile
546
def get_format_description(self):
547
return 'bzr remote repository'
549
def __eq__(self, other):
550
return self.__class__ is other.__class__
552
def check_conversion_target(self, target_format):
553
if self.rich_root_data and not target_format.rich_root_data:
554
raise errors.BadConversionTarget(
555
'Does not support rich root data.', target_format)
556
if (self.supports_tree_reference and
557
not getattr(target_format, 'supports_tree_reference', False)):
558
raise errors.BadConversionTarget(
559
'Does not support nested trees', target_format)
561
def network_name(self):
562
if self._network_name:
563
return self._network_name
564
self._creating_repo._ensure_real()
565
return self._creating_repo._real_repository._format.network_name()
568
def _serializer(self):
570
return self._custom_format._serializer
573
class RemoteRepository(_RpcHelper):
574
"""Repository accessed over rpc.
576
For the moment most operations are performed using local transport-backed
580
def __init__(self, remote_bzrdir, format, real_repository=None, _client=None):
581
"""Create a RemoteRepository instance.
583
:param remote_bzrdir: The bzrdir hosting this repository.
584
:param format: The RemoteFormat object to use.
585
:param real_repository: If not None, a local implementation of the
586
repository logic for the repository, usually accessing the data
588
:param _client: Private testing parameter - override the smart client
589
to be used by the repository.
592
self._real_repository = real_repository
594
self._real_repository = None
595
self.bzrdir = remote_bzrdir
597
self._client = remote_bzrdir._client
599
self._client = _client
600
self._format = format
601
self._lock_mode = None
602
self._lock_token = None
604
self._leave_lock = False
605
self._unstacked_provider = graph.CachingParentsProvider(
606
get_parent_map=self._get_parent_map_rpc)
607
self._unstacked_provider.disable_cache()
609
# These depend on the actual remote format, so force them off for
610
# maximum compatibility. XXX: In future these should depend on the
611
# remote repository instance, but this is irrelevant until we perform
612
# reconcile via an RPC call.
613
self._reconcile_does_inventory_gc = False
614
self._reconcile_fixes_text_parents = False
615
self._reconcile_backsup_inventory = False
616
self.base = self.bzrdir.transport.base
617
# Additional places to query for data.
618
self._fallback_repositories = []
621
return "%s(%s)" % (self.__class__.__name__, self.base)
625
def abort_write_group(self, suppress_errors=False):
626
"""Complete a write group on the decorated repository.
628
Smart methods peform operations in a single step so this api
629
is not really applicable except as a compatibility thunk
630
for older plugins that don't use e.g. the CommitBuilder
633
:param suppress_errors: see Repository.abort_write_group.
636
return self._real_repository.abort_write_group(
637
suppress_errors=suppress_errors)
641
"""Decorate the real repository for now.
643
In the long term a full blown network facility is needed to avoid
644
creating a real repository object locally.
647
return self._real_repository.chk_bytes
649
def commit_write_group(self):
650
"""Complete a write group on the decorated repository.
652
Smart methods peform operations in a single step so this api
653
is not really applicable except as a compatibility thunk
654
for older plugins that don't use e.g. the CommitBuilder
658
return self._real_repository.commit_write_group()
660
def resume_write_group(self, tokens):
662
return self._real_repository.resume_write_group(tokens)
664
def suspend_write_group(self):
666
return self._real_repository.suspend_write_group()
668
def _ensure_real(self):
669
"""Ensure that there is a _real_repository set.
671
Used before calls to self._real_repository.
673
Note that _ensure_real causes many roundtrips to the server which are
674
not desirable, and prevents the use of smart one-roundtrip RPC's to
675
perform complex operations (such as accessing parent data, streaming
676
revisions etc). Adding calls to _ensure_real should only be done when
677
bringing up new functionality, adding fallbacks for smart methods that
678
require a fallback path, and never to replace an existing smart method
679
invocation. If in doubt chat to the bzr network team.
681
if self._real_repository is None:
682
self.bzrdir._ensure_real()
683
self._set_real_repository(
684
self.bzrdir._real_bzrdir.open_repository())
686
def _translate_error(self, err, **context):
687
self.bzrdir._translate_error(err, repository=self, **context)
689
def find_text_key_references(self):
690
"""Find the text key references within the repository.
692
:return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
693
revision_ids. Each altered file-ids has the exact revision_ids that
694
altered it listed explicitly.
695
:return: A dictionary mapping text keys ((fileid, revision_id) tuples)
696
to whether they were referred to by the inventory of the
697
revision_id that they contain. The inventory texts from all present
698
revision ids are assessed to generate this report.
701
return self._real_repository.find_text_key_references()
703
def _generate_text_key_index(self):
704
"""Generate a new text key index for the repository.
706
This is an expensive function that will take considerable time to run.
708
:return: A dict mapping (file_id, revision_id) tuples to a list of
709
parents, also (file_id, revision_id) tuples.
712
return self._real_repository._generate_text_key_index()
714
def _get_revision_graph(self, revision_id):
715
"""Private method for using with old (< 1.2) servers to fallback."""
716
if revision_id is None:
718
elif revision.is_null(revision_id):
721
path = self.bzrdir._path_for_remote_call(self._client)
722
response = self._call_expecting_body(
723
'Repository.get_revision_graph', path, revision_id)
724
response_tuple, response_handler = response
725
if response_tuple[0] != 'ok':
726
raise errors.UnexpectedSmartServerResponse(response_tuple)
727
coded = response_handler.read_body_bytes()
729
# no revisions in this repository!
731
lines = coded.split('\n')
734
d = tuple(line.split())
735
revision_graph[d[0]] = d[1:]
737
return revision_graph
740
"""See Repository._get_sink()."""
741
return RemoteStreamSink(self)
743
def _get_source(self, to_format):
744
"""Return a source for streaming from this repository."""
745
return RemoteStreamSource(self, to_format)
747
def has_revision(self, revision_id):
748
"""See Repository.has_revision()."""
749
if revision_id == NULL_REVISION:
750
# The null revision is always present.
752
path = self.bzrdir._path_for_remote_call(self._client)
753
response = self._call('Repository.has_revision', path, revision_id)
754
if response[0] not in ('yes', 'no'):
755
raise errors.UnexpectedSmartServerResponse(response)
756
if response[0] == 'yes':
758
for fallback_repo in self._fallback_repositories:
759
if fallback_repo.has_revision(revision_id):
763
def has_revisions(self, revision_ids):
764
"""See Repository.has_revisions()."""
765
# FIXME: This does many roundtrips, particularly when there are
766
# fallback repositories. -- mbp 20080905
768
for revision_id in revision_ids:
769
if self.has_revision(revision_id):
770
result.add(revision_id)
773
def has_same_location(self, other):
774
return (self.__class__ is other.__class__ and
775
self.bzrdir.transport.base == other.bzrdir.transport.base)
777
def get_graph(self, other_repository=None):
778
"""Return the graph for this repository format"""
779
parents_provider = self._make_parents_provider(other_repository)
780
return graph.Graph(parents_provider)
782
def gather_stats(self, revid=None, committers=None):
783
"""See Repository.gather_stats()."""
784
path = self.bzrdir._path_for_remote_call(self._client)
785
# revid can be None to indicate no revisions, not just NULL_REVISION
786
if revid is None or revision.is_null(revid):
790
if committers is None or not committers:
791
fmt_committers = 'no'
793
fmt_committers = 'yes'
794
response_tuple, response_handler = self._call_expecting_body(
795
'Repository.gather_stats', path, fmt_revid, fmt_committers)
796
if response_tuple[0] != 'ok':
797
raise errors.UnexpectedSmartServerResponse(response_tuple)
799
body = response_handler.read_body_bytes()
801
for line in body.split('\n'):
804
key, val_text = line.split(':')
805
if key in ('revisions', 'size', 'committers'):
806
result[key] = int(val_text)
807
elif key in ('firstrev', 'latestrev'):
808
values = val_text.split(' ')[1:]
809
result[key] = (float(values[0]), long(values[1]))
813
def find_branches(self, using=False):
814
"""See Repository.find_branches()."""
815
# should be an API call to the server.
817
return self._real_repository.find_branches(using=using)
819
def get_physical_lock_status(self):
820
"""See Repository.get_physical_lock_status()."""
821
# should be an API call to the server.
823
return self._real_repository.get_physical_lock_status()
825
def is_in_write_group(self):
826
"""Return True if there is an open write group.
828
write groups are only applicable locally for the smart server..
830
if self._real_repository:
831
return self._real_repository.is_in_write_group()
834
return self._lock_count >= 1
837
"""See Repository.is_shared()."""
838
path = self.bzrdir._path_for_remote_call(self._client)
839
response = self._call('Repository.is_shared', path)
840
if response[0] not in ('yes', 'no'):
841
raise SmartProtocolError('unexpected response code %s' % (response,))
842
return response[0] == 'yes'
844
def is_write_locked(self):
845
return self._lock_mode == 'w'
848
# wrong eventually - want a local lock cache context
849
if not self._lock_mode:
850
self._lock_mode = 'r'
852
self._unstacked_provider.enable_cache(cache_misses=True)
853
if self._real_repository is not None:
854
self._real_repository.lock_read()
856
self._lock_count += 1
858
def _remote_lock_write(self, token):
859
path = self.bzrdir._path_for_remote_call(self._client)
862
err_context = {'token': token}
863
response = self._call('Repository.lock_write', path, token,
865
if response[0] == 'ok':
869
raise errors.UnexpectedSmartServerResponse(response)
871
def lock_write(self, token=None, _skip_rpc=False):
872
if not self._lock_mode:
874
if self._lock_token is not None:
875
if token != self._lock_token:
876
raise errors.TokenMismatch(token, self._lock_token)
877
self._lock_token = token
879
self._lock_token = self._remote_lock_write(token)
880
# if self._lock_token is None, then this is something like packs or
881
# svn where we don't get to lock the repo, or a weave style repository
882
# where we cannot lock it over the wire and attempts to do so will
884
if self._real_repository is not None:
885
self._real_repository.lock_write(token=self._lock_token)
886
if token is not None:
887
self._leave_lock = True
889
self._leave_lock = False
890
self._lock_mode = 'w'
892
self._unstacked_provider.enable_cache(cache_misses=False)
893
elif self._lock_mode == 'r':
894
raise errors.ReadOnlyError(self)
896
self._lock_count += 1
897
return self._lock_token or None
899
def leave_lock_in_place(self):
900
if not self._lock_token:
901
raise NotImplementedError(self.leave_lock_in_place)
902
self._leave_lock = True
904
def dont_leave_lock_in_place(self):
905
if not self._lock_token:
906
raise NotImplementedError(self.dont_leave_lock_in_place)
907
self._leave_lock = False
909
def _set_real_repository(self, repository):
910
"""Set the _real_repository for this repository.
912
:param repository: The repository to fallback to for non-hpss
913
implemented operations.
915
if self._real_repository is not None:
916
# Replacing an already set real repository.
917
# We cannot do this [currently] if the repository is locked -
918
# synchronised state might be lost.
920
raise AssertionError('_real_repository is already set')
921
if isinstance(repository, RemoteRepository):
922
raise AssertionError()
923
self._real_repository = repository
924
# If the _real_repository has _fallback_repositories, clear them out,
925
# because we want it to have the same set as this repository. This is
926
# reasonable to do because the fallbacks we clear here are from a
927
# "real" branch, and we're about to replace them with the equivalents
928
# from a RemoteBranch.
929
self._real_repository._fallback_repositories = []
930
for fb in self._fallback_repositories:
931
self._real_repository.add_fallback_repository(fb)
932
if self._lock_mode == 'w':
933
# if we are already locked, the real repository must be able to
934
# acquire the lock with our token.
935
self._real_repository.lock_write(self._lock_token)
936
elif self._lock_mode == 'r':
937
self._real_repository.lock_read()
939
def start_write_group(self):
940
"""Start a write group on the decorated repository.
942
Smart methods peform operations in a single step so this api
943
is not really applicable except as a compatibility thunk
944
for older plugins that don't use e.g. the CommitBuilder
948
return self._real_repository.start_write_group()
950
def _unlock(self, token):
951
path = self.bzrdir._path_for_remote_call(self._client)
953
# with no token the remote repository is not persistently locked.
955
err_context = {'token': token}
956
response = self._call('Repository.unlock', path, token,
958
if response == ('ok',):
961
raise errors.UnexpectedSmartServerResponse(response)
964
if not self._lock_count:
965
raise errors.LockNotHeld(self)
966
self._lock_count -= 1
967
if self._lock_count > 0:
969
self._unstacked_provider.disable_cache()
970
old_mode = self._lock_mode
971
self._lock_mode = None
973
# The real repository is responsible at present for raising an
974
# exception if it's in an unfinished write group. However, it
975
# normally will *not* actually remove the lock from disk - that's
976
# done by the server on receiving the Repository.unlock call.
977
# This is just to let the _real_repository stay up to date.
978
if self._real_repository is not None:
979
self._real_repository.unlock()
981
# The rpc-level lock should be released even if there was a
982
# problem releasing the vfs-based lock.
984
# Only write-locked repositories need to make a remote method
985
# call to perfom the unlock.
986
old_token = self._lock_token
987
self._lock_token = None
988
if not self._leave_lock:
989
self._unlock(old_token)
991
def break_lock(self):
992
# should hand off to the network
994
return self._real_repository.break_lock()
996
def _get_tarball(self, compression):
997
"""Return a TemporaryFile containing a repository tarball.
999
Returns None if the server does not support sending tarballs.
1002
path = self.bzrdir._path_for_remote_call(self._client)
1004
response, protocol = self._call_expecting_body(
1005
'Repository.tarball', path, compression)
1006
except errors.UnknownSmartMethod:
1007
protocol.cancel_read_body()
1009
if response[0] == 'ok':
1010
# Extract the tarball and return it
1011
t = tempfile.NamedTemporaryFile()
1012
# TODO: rpc layer should read directly into it...
1013
t.write(protocol.read_body_bytes())
1016
raise errors.UnexpectedSmartServerResponse(response)
1018
def sprout(self, to_bzrdir, revision_id=None):
1019
# TODO: Option to control what format is created?
1021
dest_repo = self._real_repository._format.initialize(to_bzrdir,
1023
dest_repo.fetch(self, revision_id=revision_id)
1026
### These methods are just thin shims to the VFS object for now.
1028
def revision_tree(self, revision_id):
1030
return self._real_repository.revision_tree(revision_id)
1032
def get_serializer_format(self):
1034
return self._real_repository.get_serializer_format()
1036
def get_commit_builder(self, branch, parents, config, timestamp=None,
1037
timezone=None, committer=None, revprops=None,
1039
# FIXME: It ought to be possible to call this without immediately
1040
# triggering _ensure_real. For now it's the easiest thing to do.
1042
real_repo = self._real_repository
1043
builder = real_repo.get_commit_builder(branch, parents,
1044
config, timestamp=timestamp, timezone=timezone,
1045
committer=committer, revprops=revprops, revision_id=revision_id)
1048
def add_fallback_repository(self, repository):
1049
"""Add a repository to use for looking up data not held locally.
1051
:param repository: A repository.
1053
if not self._format.supports_external_lookups:
1054
raise errors.UnstackableRepositoryFormat(
1055
self._format.network_name(), self.base)
1056
# We need to accumulate additional repositories here, to pass them in
1059
self._fallback_repositories.append(repository)
1060
# If self._real_repository was parameterised already (e.g. because a
1061
# _real_branch had its get_stacked_on_url method called), then the
1062
# repository to be added may already be in the _real_repositories list.
1063
if self._real_repository is not None:
1064
if repository not in self._real_repository._fallback_repositories:
1065
self._real_repository.add_fallback_repository(repository)
1067
# They are also seen by the fallback repository. If it doesn't
1068
# exist yet they'll be added then. This implicitly copies them.
1071
def add_inventory(self, revid, inv, parents):
1073
return self._real_repository.add_inventory(revid, inv, parents)
1075
def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1078
return self._real_repository.add_inventory_by_delta(basis_revision_id,
1079
delta, new_revision_id, parents)
1081
def add_revision(self, rev_id, rev, inv=None, config=None):
1083
return self._real_repository.add_revision(
1084
rev_id, rev, inv=inv, config=config)
1087
def get_inventory(self, revision_id):
1089
return self._real_repository.get_inventory(revision_id)
1091
def iter_inventories(self, revision_ids):
1093
return self._real_repository.iter_inventories(revision_ids)
1096
def get_revision(self, revision_id):
1098
return self._real_repository.get_revision(revision_id)
1100
def get_transaction(self):
1102
return self._real_repository.get_transaction()
1105
def clone(self, a_bzrdir, revision_id=None):
1107
return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
1109
def make_working_trees(self):
1110
"""See Repository.make_working_trees"""
1112
return self._real_repository.make_working_trees()
1114
def refresh_data(self):
1115
"""Re-read any data needed to to synchronise with disk.
1117
This method is intended to be called after another repository instance
1118
(such as one used by a smart server) has inserted data into the
1119
repository. It may not be called during a write group, but may be
1120
called at any other time.
1122
if self.is_in_write_group():
1123
raise errors.InternalBzrError(
1124
"May not refresh_data while in a write group.")
1125
if self._real_repository is not None:
1126
self._real_repository.refresh_data()
1128
def revision_ids_to_search_result(self, result_set):
1129
"""Convert a set of revision ids to a graph SearchResult."""
1130
result_parents = set()
1131
for parents in self.get_graph().get_parent_map(
1132
result_set).itervalues():
1133
result_parents.update(parents)
1134
included_keys = result_set.intersection(result_parents)
1135
start_keys = result_set.difference(included_keys)
1136
exclude_keys = result_parents.difference(result_set)
1137
result = graph.SearchResult(start_keys, exclude_keys,
1138
len(result_set), result_set)
1142
def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1143
"""Return the revision ids that other has that this does not.
1145
These are returned in topological order.
1147
revision_id: only return revision ids included by revision_id.
1149
return repository.InterRepository.get(
1150
other, self).search_missing_revision_ids(revision_id, find_ghosts)
1152
def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
1154
# No base implementation to use as RemoteRepository is not a subclass
1155
# of Repository; so this is a copy of Repository.fetch().
1156
if fetch_spec is not None and revision_id is not None:
1157
raise AssertionError(
1158
"fetch_spec and revision_id are mutually exclusive.")
1159
if self.is_in_write_group():
1160
raise errors.InternalBzrError(
1161
"May not fetch while in a write group.")
1162
# fast path same-url fetch operations
1163
if self.has_same_location(source) and fetch_spec is None:
1164
# check that last_revision is in 'from' and then return a
1166
if (revision_id is not None and
1167
not revision.is_null(revision_id)):
1168
self.get_revision(revision_id)
1170
# if there is no specific appropriate InterRepository, this will get
1171
# the InterRepository base class, which raises an
1172
# IncompatibleRepositories when asked to fetch.
1173
inter = repository.InterRepository.get(source, self)
1174
return inter.fetch(revision_id=revision_id, pb=pb,
1175
find_ghosts=find_ghosts, fetch_spec=fetch_spec)
1177
def create_bundle(self, target, base, fileobj, format=None):
1179
self._real_repository.create_bundle(target, base, fileobj, format)
1182
def get_ancestry(self, revision_id, topo_sorted=True):
1184
return self._real_repository.get_ancestry(revision_id, topo_sorted)
1186
def fileids_altered_by_revision_ids(self, revision_ids):
1188
return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
1190
def _get_versioned_file_checker(self, revisions, revision_versions_cache):
1192
return self._real_repository._get_versioned_file_checker(
1193
revisions, revision_versions_cache)
1195
def iter_files_bytes(self, desired_files):
1196
"""See Repository.iter_file_bytes.
1199
return self._real_repository.iter_files_bytes(desired_files)
1201
def get_parent_map(self, revision_ids):
1202
"""See bzrlib.Graph.get_parent_map()."""
1203
return self._make_parents_provider().get_parent_map(revision_ids)
1205
def _get_parent_map_rpc(self, keys):
1206
"""Helper for get_parent_map that performs the RPC."""
1207
medium = self._client._medium
1208
if medium._is_remote_before((1, 2)):
1209
# We already found out that the server can't understand
1210
# Repository.get_parent_map requests, so just fetch the whole
1213
# Note that this reads the whole graph, when only some keys are
1214
# wanted. On this old server there's no way (?) to get them all
1215
# in one go, and the user probably will have seen a warning about
1216
# the server being old anyhow.
1217
rg = self._get_revision_graph(None)
1218
# There is an api discrepency between get_parent_map and
1219
# get_revision_graph. Specifically, a "key:()" pair in
1220
# get_revision_graph just means a node has no parents. For
1221
# "get_parent_map" it means the node is a ghost. So fix up the
1222
# graph to correct this.
1223
# https://bugs.launchpad.net/bzr/+bug/214894
1224
# There is one other "bug" which is that ghosts in
1225
# get_revision_graph() are not returned at all. But we won't worry
1226
# about that for now.
1227
for node_id, parent_ids in rg.iteritems():
1228
if parent_ids == ():
1229
rg[node_id] = (NULL_REVISION,)
1230
rg[NULL_REVISION] = ()
1235
raise ValueError('get_parent_map(None) is not valid')
1236
if NULL_REVISION in keys:
1237
keys.discard(NULL_REVISION)
1238
found_parents = {NULL_REVISION:()}
1240
return found_parents
1243
# TODO(Needs analysis): We could assume that the keys being requested
1244
# from get_parent_map are in a breadth first search, so typically they
1245
# will all be depth N from some common parent, and we don't have to
1246
# have the server iterate from the root parent, but rather from the
1247
# keys we're searching; and just tell the server the keyspace we
1248
# already have; but this may be more traffic again.
1250
# Transform self._parents_map into a search request recipe.
1251
# TODO: Manage this incrementally to avoid covering the same path
1252
# repeatedly. (The server will have to on each request, but the less
1253
# work done the better).
1255
# Negative caching notes:
1256
# new server sends missing when a request including the revid
1257
# 'include-missing:' is present in the request.
1258
# missing keys are serialised as missing:X, and we then call
1259
# provider.note_missing(X) for-all X
1260
parents_map = self._unstacked_provider.get_cached_map()
1261
if parents_map is None:
1262
# Repository is not locked, so there's no cache.
1264
# start_set is all the keys in the cache
1265
start_set = set(parents_map)
1266
# result set is all the references to keys in the cache
1267
result_parents = set()
1268
for parents in parents_map.itervalues():
1269
result_parents.update(parents)
1270
stop_keys = result_parents.difference(start_set)
1271
# We don't need to send ghosts back to the server as a position to
1273
stop_keys.difference_update(self._unstacked_provider.missing_keys)
1274
included_keys = start_set.intersection(result_parents)
1275
start_set.difference_update(included_keys)
1276
recipe = ('manual', start_set, stop_keys, len(parents_map))
1277
body = self._serialise_search_recipe(recipe)
1278
path = self.bzrdir._path_for_remote_call(self._client)
1280
if type(key) is not str:
1282
"key %r not a plain string" % (key,))
1283
verb = 'Repository.get_parent_map'
1284
args = (path, 'include-missing:') + tuple(keys)
1286
response = self._call_with_body_bytes_expecting_body(
1288
except errors.UnknownSmartMethod:
1289
# Server does not support this method, so get the whole graph.
1290
# Worse, we have to force a disconnection, because the server now
1291
# doesn't realise it has a body on the wire to consume, so the
1292
# only way to recover is to abandon the connection.
1294
'Server is too old for fast get_parent_map, reconnecting. '
1295
'(Upgrade the server to Bazaar 1.2 to avoid this)')
1297
# To avoid having to disconnect repeatedly, we keep track of the
1298
# fact the server doesn't understand remote methods added in 1.2.
1299
medium._remember_remote_is_before((1, 2))
1300
# Recurse just once and we should use the fallback code.
1301
return self._get_parent_map_rpc(keys)
1302
response_tuple, response_handler = response
1303
if response_tuple[0] not in ['ok']:
1304
response_handler.cancel_read_body()
1305
raise errors.UnexpectedSmartServerResponse(response_tuple)
1306
if response_tuple[0] == 'ok':
1307
coded = bz2.decompress(response_handler.read_body_bytes())
1309
# no revisions found
1311
lines = coded.split('\n')
1314
d = tuple(line.split())
1316
revision_graph[d[0]] = d[1:]
1319
if d[0].startswith('missing:'):
1321
self._unstacked_provider.note_missing_key(revid)
1323
# no parents - so give the Graph result
1325
revision_graph[d[0]] = (NULL_REVISION,)
1326
return revision_graph
1329
def get_signature_text(self, revision_id):
1331
return self._real_repository.get_signature_text(revision_id)
1334
def get_inventory_xml(self, revision_id):
1336
return self._real_repository.get_inventory_xml(revision_id)
1338
def deserialise_inventory(self, revision_id, xml):
1340
return self._real_repository.deserialise_inventory(revision_id, xml)
1342
def reconcile(self, other=None, thorough=False):
1344
return self._real_repository.reconcile(other=other, thorough=thorough)
1346
def all_revision_ids(self):
1348
return self._real_repository.all_revision_ids()
1351
def get_deltas_for_revisions(self, revisions, specific_fileids=None):
1353
return self._real_repository.get_deltas_for_revisions(revisions,
1354
specific_fileids=specific_fileids)
1357
def get_revision_delta(self, revision_id, specific_fileids=None):
1359
return self._real_repository.get_revision_delta(revision_id,
1360
specific_fileids=specific_fileids)
1363
def revision_trees(self, revision_ids):
1365
return self._real_repository.revision_trees(revision_ids)
1368
def get_revision_reconcile(self, revision_id):
1370
return self._real_repository.get_revision_reconcile(revision_id)
1373
def check(self, revision_ids=None):
1375
return self._real_repository.check(revision_ids=revision_ids)
1377
def copy_content_into(self, destination, revision_id=None):
1379
return self._real_repository.copy_content_into(
1380
destination, revision_id=revision_id)
1382
def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
1383
# get a tarball of the remote repository, and copy from that into the
1385
from bzrlib import osutils
1387
# TODO: Maybe a progress bar while streaming the tarball?
1388
note("Copying repository content as tarball...")
1389
tar_file = self._get_tarball('bz2')
1390
if tar_file is None:
1392
destination = to_bzrdir.create_repository()
1394
tar = tarfile.open('repository', fileobj=tar_file,
1396
tmpdir = osutils.mkdtemp()
1398
_extract_tar(tar, tmpdir)
1399
tmp_bzrdir = BzrDir.open(tmpdir)
1400
tmp_repo = tmp_bzrdir.open_repository()
1401
tmp_repo.copy_content_into(destination, revision_id)
1403
osutils.rmtree(tmpdir)
1407
# TODO: Suggestion from john: using external tar is much faster than
1408
# python's tarfile library, but it may not work on windows.
1411
def inventories(self):
1412
"""Decorate the real repository for now.
1414
In the long term a full blown network facility is needed to
1415
avoid creating a real repository object locally.
1418
return self._real_repository.inventories
1422
"""Compress the data within the repository.
1424
This is not currently implemented within the smart server.
1427
return self._real_repository.pack()
1430
def revisions(self):
1431
"""Decorate the real repository for now.
1433
In the short term this should become a real object to intercept graph
1436
In the long term a full blown network facility is needed.
1439
return self._real_repository.revisions
1441
def set_make_working_trees(self, new_value):
1443
new_value_str = "True"
1445
new_value_str = "False"
1446
path = self.bzrdir._path_for_remote_call(self._client)
1448
response = self._call(
1449
'Repository.set_make_working_trees', path, new_value_str)
1450
except errors.UnknownSmartMethod:
1452
self._real_repository.set_make_working_trees(new_value)
1454
if response[0] != 'ok':
1455
raise errors.UnexpectedSmartServerResponse(response)
1458
def signatures(self):
1459
"""Decorate the real repository for now.
1461
In the long term a full blown network facility is needed to avoid
1462
creating a real repository object locally.
1465
return self._real_repository.signatures
1468
def sign_revision(self, revision_id, gpg_strategy):
1470
return self._real_repository.sign_revision(revision_id, gpg_strategy)
1474
"""Decorate the real repository for now.
1476
In the long term a full blown network facility is needed to avoid
1477
creating a real repository object locally.
1480
return self._real_repository.texts
1483
def get_revisions(self, revision_ids):
1485
return self._real_repository.get_revisions(revision_ids)
1487
def supports_rich_root(self):
1488
return self._format.rich_root_data
1490
def iter_reverse_revision_history(self, revision_id):
1492
return self._real_repository.iter_reverse_revision_history(revision_id)
1495
def _serializer(self):
1496
return self._format._serializer
1498
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1500
return self._real_repository.store_revision_signature(
1501
gpg_strategy, plaintext, revision_id)
1503
def add_signature_text(self, revision_id, signature):
1505
return self._real_repository.add_signature_text(revision_id, signature)
1507
def has_signature_for_revision_id(self, revision_id):
1509
return self._real_repository.has_signature_for_revision_id(revision_id)
1511
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
1513
return self._real_repository.item_keys_introduced_by(revision_ids,
1514
_files_pb=_files_pb)
1516
def revision_graph_can_have_wrong_parents(self):
1517
# The answer depends on the remote repo format.
1519
return self._real_repository.revision_graph_can_have_wrong_parents()
1521
def _find_inconsistent_revision_parents(self):
1523
return self._real_repository._find_inconsistent_revision_parents()
1525
def _check_for_inconsistent_revision_parents(self):
1527
return self._real_repository._check_for_inconsistent_revision_parents()
1529
def _make_parents_provider(self, other=None):
1530
providers = [self._unstacked_provider]
1531
if other is not None:
1532
providers.insert(0, other)
1533
providers.extend(r._make_parents_provider() for r in
1534
self._fallback_repositories)
1535
return graph._StackedParentsProvider(providers)
1537
def _serialise_search_recipe(self, recipe):
1538
"""Serialise a graph search recipe.
1540
:param recipe: A search recipe (start, stop, count).
1541
:return: Serialised bytes.
1543
start_keys = ' '.join(recipe[1])
1544
stop_keys = ' '.join(recipe[2])
1545
count = str(recipe[3])
1546
return '\n'.join((start_keys, stop_keys, count))
1548
def _serialise_search_result(self, search_result):
1549
if isinstance(search_result, graph.PendingAncestryResult):
1550
parts = ['ancestry-of']
1551
parts.extend(search_result.heads)
1553
recipe = search_result.get_recipe()
1554
parts = [recipe[0], self._serialise_search_recipe(recipe)]
1555
return '\n'.join(parts)
1558
path = self.bzrdir._path_for_remote_call(self._client)
1560
response = self._call('PackRepository.autopack', path)
1561
except errors.UnknownSmartMethod:
1563
self._real_repository._pack_collection.autopack()
1566
if response[0] != 'ok':
1567
raise errors.UnexpectedSmartServerResponse(response)
1570
class RemoteStreamSink(repository.StreamSink):
1572
def _insert_real(self, stream, src_format, resume_tokens):
1573
self.target_repo._ensure_real()
1574
sink = self.target_repo._real_repository._get_sink()
1575
result = sink.insert_stream(stream, src_format, resume_tokens)
1577
self.target_repo.autopack()
1580
def insert_stream(self, stream, src_format, resume_tokens):
1581
target = self.target_repo
1582
if target._lock_token:
1583
verb = 'Repository.insert_stream_locked'
1584
extra_args = (target._lock_token or '',)
1585
required_version = (1, 14)
1587
verb = 'Repository.insert_stream'
1589
required_version = (1, 13)
1590
client = target._client
1591
medium = client._medium
1592
if medium._is_remote_before(required_version):
1593
# No possible way this can work.
1594
return self._insert_real(stream, src_format, resume_tokens)
1595
path = target.bzrdir._path_for_remote_call(client)
1596
if not resume_tokens:
1597
# XXX: Ugly but important for correctness, *will* be fixed during
1598
# 1.13 cycle. Pushing a stream that is interrupted results in a
1599
# fallback to the _real_repositories sink *with a partial stream*.
1600
# Thats bad because we insert less data than bzr expected. To avoid
1601
# this we do a trial push to make sure the verb is accessible, and
1602
# do not fallback when actually pushing the stream. A cleanup patch
1603
# is going to look at rewinding/restarting the stream/partial
1605
byte_stream = smart_repo._stream_to_byte_stream([], src_format)
1607
response = client.call_with_body_stream(
1608
(verb, path, '') + extra_args, byte_stream)
1609
except errors.UnknownSmartMethod:
1610
medium._remember_remote_is_before(required_version)
1611
return self._insert_real(stream, src_format, resume_tokens)
1612
byte_stream = smart_repo._stream_to_byte_stream(
1614
resume_tokens = ' '.join(resume_tokens)
1615
response = client.call_with_body_stream(
1616
(verb, path, resume_tokens) + extra_args, byte_stream)
1617
if response[0][0] not in ('ok', 'missing-basis'):
1618
raise errors.UnexpectedSmartServerResponse(response)
1619
if response[0][0] == 'missing-basis':
1620
tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
1621
resume_tokens = tokens
1622
return resume_tokens, missing_keys
1624
self.target_repo.refresh_data()
1628
class RemoteStreamSource(repository.StreamSource):
1629
"""Stream data from a remote server."""
1631
def get_stream(self, search):
1632
if (self.from_repository._fallback_repositories and
1633
self.to_format._fetch_order == 'topological'):
1634
return self._real_stream(self.from_repository, search)
1635
return self.missing_parents_chain(search, [self.from_repository] +
1636
self.from_repository._fallback_repositories)
1638
def _real_stream(self, repo, search):
1639
"""Get a stream for search from repo.
1641
This never called RemoteStreamSource.get_stream, and is a heler
1642
for RemoteStreamSource._get_stream to allow getting a stream
1643
reliably whether fallback back because of old servers or trying
1644
to stream from a non-RemoteRepository (which the stacked support
1647
source = repo._get_source(self.to_format)
1648
if isinstance(source, RemoteStreamSource):
1649
return repository.StreamSource.get_stream(source, search)
1650
return source.get_stream(search)
1652
def _get_stream(self, repo, search):
1653
"""Core worker to get a stream from repo for search.
1655
This is used by both get_stream and the stacking support logic. It
1656
deliberately gets a stream for repo which does not need to be
1657
self.from_repository. In the event that repo is not Remote, or
1658
cannot do a smart stream, a fallback is made to the generic
1659
repository._get_stream() interface, via self._real_stream.
1661
In the event of stacking, streams from _get_stream will not
1662
contain all the data for search - this is normal (see get_stream).
1664
:param repo: A repository.
1665
:param search: A search.
1667
# Fallbacks may be non-smart
1668
if not isinstance(repo, RemoteRepository):
1669
return self._real_stream(repo, search)
1670
client = repo._client
1671
medium = client._medium
1672
if medium._is_remote_before((1, 13)):
1673
# streaming was added in 1.13
1674
return self._real_stream(repo, search)
1675
path = repo.bzrdir._path_for_remote_call(client)
1677
search_bytes = repo._serialise_search_result(search)
1678
response = repo._call_with_body_bytes_expecting_body(
1679
'Repository.get_stream',
1680
(path, self.to_format.network_name()), search_bytes)
1681
response_tuple, response_handler = response
1682
except errors.UnknownSmartMethod:
1683
medium._remember_remote_is_before((1,13))
1684
return self._real_stream(repo, search)
1685
if response_tuple[0] != 'ok':
1686
raise errors.UnexpectedSmartServerResponse(response_tuple)
1687
byte_stream = response_handler.read_streamed_body()
1688
src_format, stream = smart_repo._byte_stream_to_stream(byte_stream)
1689
if src_format.network_name() != repo._format.network_name():
1690
raise AssertionError(
1691
"Mismatched RemoteRepository and stream src %r, %r" % (
1692
src_format.network_name(), repo._format.network_name()))
1695
def missing_parents_chain(self, search, sources):
1696
"""Chain multiple streams together to handle stacking.
1698
:param search: The overall search to satisfy with streams.
1699
:param sources: A list of Repository objects to query.
1701
self.serialiser = self.to_format._serializer
1702
self.seen_revs = set()
1703
self.referenced_revs = set()
1704
# If there are heads in the search, or the key count is > 0, we are not
1706
while not search.is_empty() and len(sources) > 1:
1707
source = sources.pop(0)
1708
stream = self._get_stream(source, search)
1709
for kind, substream in stream:
1710
if kind != 'revisions':
1711
yield kind, substream
1713
yield kind, self.missing_parents_rev_handler(substream)
1714
search = search.refine(self.seen_revs, self.referenced_revs)
1715
self.seen_revs = set()
1716
self.referenced_revs = set()
1717
if not search.is_empty():
1718
for kind, stream in self._get_stream(sources[0], search):
1721
def missing_parents_rev_handler(self, substream):
1722
for content in substream:
1723
revision_bytes = content.get_bytes_as('fulltext')
1724
revision = self.serialiser.read_revision_from_string(revision_bytes)
1725
self.seen_revs.add(content.key[-1])
1726
self.referenced_revs.update(revision.parent_ids)
1730
class RemoteBranchLockableFiles(LockableFiles):
1731
"""A 'LockableFiles' implementation that talks to a smart server.
1733
This is not a public interface class.
1736
def __init__(self, bzrdir, _client):
1737
self.bzrdir = bzrdir
1738
self._client = _client
1739
self._need_find_modes = True
1740
LockableFiles.__init__(
1741
self, bzrdir.get_branch_transport(None),
1742
'lock', lockdir.LockDir)
1744
def _find_modes(self):
1745
# RemoteBranches don't let the client set the mode of control files.
1746
self._dir_mode = None
1747
self._file_mode = None
1750
class RemoteBranchFormat(branch.BranchFormat):
1752
def __init__(self, network_name=None):
1753
super(RemoteBranchFormat, self).__init__()
1754
self._matchingbzrdir = RemoteBzrDirFormat()
1755
self._matchingbzrdir.set_branch_format(self)
1756
self._custom_format = None
1757
self._network_name = network_name
1759
def __eq__(self, other):
1760
return (isinstance(other, RemoteBranchFormat) and
1761
self.__dict__ == other.__dict__)
1763
def _ensure_real(self):
1764
if self._custom_format is None:
1765
self._custom_format = branch.network_format_registry.get(
1768
def get_format_description(self):
1769
return 'Remote BZR Branch'
1771
def network_name(self):
1772
return self._network_name
1774
def open(self, a_bzrdir, ignore_fallbacks=False):
1775
return a_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
1777
def _vfs_initialize(self, a_bzrdir):
1778
# Initialisation when using a local bzrdir object, or a non-vfs init
1779
# method is not available on the server.
1780
# self._custom_format is always set - the start of initialize ensures
1782
if isinstance(a_bzrdir, RemoteBzrDir):
1783
a_bzrdir._ensure_real()
1784
result = self._custom_format.initialize(a_bzrdir._real_bzrdir)
1786
# We assume the bzrdir is parameterised; it may not be.
1787
result = self._custom_format.initialize(a_bzrdir)
1788
if (isinstance(a_bzrdir, RemoteBzrDir) and
1789
not isinstance(result, RemoteBranch)):
1790
result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result)
1793
def initialize(self, a_bzrdir):
1794
# 1) get the network name to use.
1795
if self._custom_format:
1796
network_name = self._custom_format.network_name()
1798
# Select the current bzrlib default and ask for that.
1799
reference_bzrdir_format = bzrdir.format_registry.get('default')()
1800
reference_format = reference_bzrdir_format.get_branch_format()
1801
self._custom_format = reference_format
1802
network_name = reference_format.network_name()
1803
# Being asked to create on a non RemoteBzrDir:
1804
if not isinstance(a_bzrdir, RemoteBzrDir):
1805
return self._vfs_initialize(a_bzrdir)
1806
medium = a_bzrdir._client._medium
1807
if medium._is_remote_before((1, 13)):
1808
return self._vfs_initialize(a_bzrdir)
1809
# Creating on a remote bzr dir.
1810
# 2) try direct creation via RPC
1811
path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
1812
verb = 'BzrDir.create_branch'
1814
response = a_bzrdir._call(verb, path, network_name)
1815
except errors.UnknownSmartMethod:
1816
# Fallback - use vfs methods
1817
medium._remember_remote_is_before((1, 13))
1818
return self._vfs_initialize(a_bzrdir)
1819
if response[0] != 'ok':
1820
raise errors.UnexpectedSmartServerResponse(response)
1821
# Turn the response into a RemoteRepository object.
1822
format = RemoteBranchFormat(network_name=response[1])
1823
repo_format = response_tuple_to_repo_format(response[3:])
1824
if response[2] == '':
1825
repo_bzrdir = a_bzrdir
1827
repo_bzrdir = RemoteBzrDir(
1828
a_bzrdir.root_transport.clone(response[2]), a_bzrdir._format,
1830
remote_repo = RemoteRepository(repo_bzrdir, repo_format)
1831
remote_branch = RemoteBranch(a_bzrdir, remote_repo,
1832
format=format, setup_stacking=False)
1833
# XXX: We know this is a new branch, so it must have revno 0, revid
1834
# NULL_REVISION. Creating the branch locked would make this be unable
1835
# to be wrong; here its simply very unlikely to be wrong. RBC 20090225
1836
remote_branch._last_revision_info_cache = 0, NULL_REVISION
1837
return remote_branch
1839
def make_tags(self, branch):
1841
return self._custom_format.make_tags(branch)
1843
def supports_tags(self):
1844
# Remote branches might support tags, but we won't know until we
1845
# access the real remote branch.
1847
return self._custom_format.supports_tags()
1849
def supports_stacking(self):
1851
return self._custom_format.supports_stacking()
1854
class RemoteBranch(branch.Branch, _RpcHelper):
1855
"""Branch stored on a server accessed by HPSS RPC.
1857
At the moment most operations are mapped down to simple file operations.
1860
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
1861
_client=None, format=None, setup_stacking=True):
1862
"""Create a RemoteBranch instance.
1864
:param real_branch: An optional local implementation of the branch
1865
format, usually accessing the data via the VFS.
1866
:param _client: Private parameter for testing.
1867
:param format: A RemoteBranchFormat object, None to create one
1868
automatically. If supplied it should have a network_name already
1870
:param setup_stacking: If True make an RPC call to determine the
1871
stacked (or not) status of the branch. If False assume the branch
1874
# We intentionally don't call the parent class's __init__, because it
1875
# will try to assign to self.tags, which is a property in this subclass.
1876
# And the parent's __init__ doesn't do much anyway.
1877
self._revision_id_to_revno_cache = None
1878
self._partial_revision_id_to_revno_cache = {}
1879
self._revision_history_cache = None
1880
self._last_revision_info_cache = None
1881
self._merge_sorted_revisions_cache = None
1882
self.bzrdir = remote_bzrdir
1883
if _client is not None:
1884
self._client = _client
1886
self._client = remote_bzrdir._client
1887
self.repository = remote_repository
1888
if real_branch is not None:
1889
self._real_branch = real_branch
1890
# Give the remote repository the matching real repo.
1891
real_repo = self._real_branch.repository
1892
if isinstance(real_repo, RemoteRepository):
1893
real_repo._ensure_real()
1894
real_repo = real_repo._real_repository
1895
self.repository._set_real_repository(real_repo)
1896
# Give the branch the remote repository to let fast-pathing happen.
1897
self._real_branch.repository = self.repository
1899
self._real_branch = None
1900
# Fill out expected attributes of branch for bzrlib api users.
1901
self.base = self.bzrdir.root_transport.base
1902
self._control_files = None
1903
self._lock_mode = None
1904
self._lock_token = None
1905
self._repo_lock_token = None
1906
self._lock_count = 0
1907
self._leave_lock = False
1908
# Setup a format: note that we cannot call _ensure_real until all the
1909
# attributes above are set: This code cannot be moved higher up in this
1912
self._format = RemoteBranchFormat()
1913
if real_branch is not None:
1914
self._format._network_name = \
1915
self._real_branch._format.network_name()
1917
self._format = format
1918
if not self._format._network_name:
1919
# Did not get from open_branchV2 - old server.
1921
self._format._network_name = \
1922
self._real_branch._format.network_name()
1923
self.tags = self._format.make_tags(self)
1924
# The base class init is not called, so we duplicate this:
1925
hooks = branch.Branch.hooks['open']
1929
self._setup_stacking()
1931
def _setup_stacking(self):
1932
# configure stacking into the remote repository, by reading it from
1935
fallback_url = self.get_stacked_on_url()
1936
except (errors.NotStacked, errors.UnstackableBranchFormat,
1937
errors.UnstackableRepositoryFormat), e:
1939
# it's relative to this branch...
1940
fallback_url = urlutils.join(self.base, fallback_url)
1941
transports = [self.bzrdir.root_transport]
1942
stacked_on = branch.Branch.open(fallback_url,
1943
possible_transports=transports)
1944
self.repository.add_fallback_repository(stacked_on.repository)
1946
def _get_real_transport(self):
1947
# if we try vfs access, return the real branch's vfs transport
1949
return self._real_branch._transport
1951
_transport = property(_get_real_transport)
1954
return "%s(%s)" % (self.__class__.__name__, self.base)
1958
def _ensure_real(self):
1959
"""Ensure that there is a _real_branch set.
1961
Used before calls to self._real_branch.
1963
if self._real_branch is None:
1964
if not vfs.vfs_enabled():
1965
raise AssertionError('smart server vfs must be enabled '
1966
'to use vfs implementation')
1967
self.bzrdir._ensure_real()
1968
self._real_branch = self.bzrdir._real_bzrdir.open_branch()
1969
if self.repository._real_repository is None:
1970
# Give the remote repository the matching real repo.
1971
real_repo = self._real_branch.repository
1972
if isinstance(real_repo, RemoteRepository):
1973
real_repo._ensure_real()
1974
real_repo = real_repo._real_repository
1975
self.repository._set_real_repository(real_repo)
1976
# Give the real branch the remote repository to let fast-pathing
1978
self._real_branch.repository = self.repository
1979
if self._lock_mode == 'r':
1980
self._real_branch.lock_read()
1981
elif self._lock_mode == 'w':
1982
self._real_branch.lock_write(token=self._lock_token)
1984
def _translate_error(self, err, **context):
1985
self.repository._translate_error(err, branch=self, **context)
1987
def _clear_cached_state(self):
1988
super(RemoteBranch, self)._clear_cached_state()
1989
if self._real_branch is not None:
1990
self._real_branch._clear_cached_state()
1992
def _clear_cached_state_of_remote_branch_only(self):
1993
"""Like _clear_cached_state, but doesn't clear the cache of
1996
This is useful when falling back to calling a method of
1997
self._real_branch that changes state. In that case the underlying
1998
branch changes, so we need to invalidate this RemoteBranch's cache of
1999
it. However, there's no need to invalidate the _real_branch's cache
2000
too, in fact doing so might harm performance.
2002
super(RemoteBranch, self)._clear_cached_state()
2005
def control_files(self):
2006
# Defer actually creating RemoteBranchLockableFiles until its needed,
2007
# because it triggers an _ensure_real that we otherwise might not need.
2008
if self._control_files is None:
2009
self._control_files = RemoteBranchLockableFiles(
2010
self.bzrdir, self._client)
2011
return self._control_files
2013
def _get_checkout_format(self):
2015
return self._real_branch._get_checkout_format()
2017
def get_physical_lock_status(self):
2018
"""See Branch.get_physical_lock_status()."""
2019
# should be an API call to the server, as branches must be lockable.
2021
return self._real_branch.get_physical_lock_status()
2023
def get_stacked_on_url(self):
2024
"""Get the URL this branch is stacked against.
2026
:raises NotStacked: If the branch is not stacked.
2027
:raises UnstackableBranchFormat: If the branch does not support
2029
:raises UnstackableRepositoryFormat: If the repository does not support
2033
# there may not be a repository yet, so we can't use
2034
# self._translate_error, so we can't use self._call either.
2035
response = self._client.call('Branch.get_stacked_on_url',
2036
self._remote_path())
2037
except errors.ErrorFromSmartServer, err:
2038
# there may not be a repository yet, so we can't call through
2039
# its _translate_error
2040
_translate_error(err, branch=self)
2041
except errors.UnknownSmartMethod, err:
2043
return self._real_branch.get_stacked_on_url()
2044
if response[0] != 'ok':
2045
raise errors.UnexpectedSmartServerResponse(response)
2048
def _vfs_get_tags_bytes(self):
2050
return self._real_branch._get_tags_bytes()
2052
def _get_tags_bytes(self):
2053
medium = self._client._medium
2054
if medium._is_remote_before((1, 13)):
2055
return self._vfs_get_tags_bytes()
2057
response = self._call('Branch.get_tags_bytes', self._remote_path())
2058
except errors.UnknownSmartMethod:
2059
medium._remember_remote_is_before((1, 13))
2060
return self._vfs_get_tags_bytes()
2063
def lock_read(self):
2064
self.repository.lock_read()
2065
if not self._lock_mode:
2066
self._lock_mode = 'r'
2067
self._lock_count = 1
2068
if self._real_branch is not None:
2069
self._real_branch.lock_read()
2071
self._lock_count += 1
2073
def _remote_lock_write(self, token):
2075
branch_token = repo_token = ''
2077
branch_token = token
2078
repo_token = self.repository.lock_write()
2079
self.repository.unlock()
2080
err_context = {'token': token}
2081
response = self._call(
2082
'Branch.lock_write', self._remote_path(), branch_token,
2083
repo_token or '', **err_context)
2084
if response[0] != 'ok':
2085
raise errors.UnexpectedSmartServerResponse(response)
2086
ok, branch_token, repo_token = response
2087
return branch_token, repo_token
2089
def lock_write(self, token=None):
2090
if not self._lock_mode:
2091
# Lock the branch and repo in one remote call.
2092
remote_tokens = self._remote_lock_write(token)
2093
self._lock_token, self._repo_lock_token = remote_tokens
2094
if not self._lock_token:
2095
raise SmartProtocolError('Remote server did not return a token!')
2096
# Tell the self.repository object that it is locked.
2097
self.repository.lock_write(
2098
self._repo_lock_token, _skip_rpc=True)
2100
if self._real_branch is not None:
2101
self._real_branch.lock_write(token=self._lock_token)
2102
if token is not None:
2103
self._leave_lock = True
2105
self._leave_lock = False
2106
self._lock_mode = 'w'
2107
self._lock_count = 1
2108
elif self._lock_mode == 'r':
2109
raise errors.ReadOnlyTransaction
2111
if token is not None:
2112
# A token was given to lock_write, and we're relocking, so
2113
# check that the given token actually matches the one we
2115
if token != self._lock_token:
2116
raise errors.TokenMismatch(token, self._lock_token)
2117
self._lock_count += 1
2118
# Re-lock the repository too.
2119
self.repository.lock_write(self._repo_lock_token)
2120
return self._lock_token or None
2122
def _set_tags_bytes(self, bytes):
2124
return self._real_branch._set_tags_bytes(bytes)
2126
def _unlock(self, branch_token, repo_token):
2127
err_context = {'token': str((branch_token, repo_token))}
2128
response = self._call(
2129
'Branch.unlock', self._remote_path(), branch_token,
2130
repo_token or '', **err_context)
2131
if response == ('ok',):
2133
raise errors.UnexpectedSmartServerResponse(response)
2137
self._lock_count -= 1
2138
if not self._lock_count:
2139
self._clear_cached_state()
2140
mode = self._lock_mode
2141
self._lock_mode = None
2142
if self._real_branch is not None:
2143
if (not self._leave_lock and mode == 'w' and
2144
self._repo_lock_token):
2145
# If this RemoteBranch will remove the physical lock
2146
# for the repository, make sure the _real_branch
2147
# doesn't do it first. (Because the _real_branch's
2148
# repository is set to be the RemoteRepository.)
2149
self._real_branch.repository.leave_lock_in_place()
2150
self._real_branch.unlock()
2152
# Only write-locked branched need to make a remote method
2153
# call to perfom the unlock.
2155
if not self._lock_token:
2156
raise AssertionError('Locked, but no token!')
2157
branch_token = self._lock_token
2158
repo_token = self._repo_lock_token
2159
self._lock_token = None
2160
self._repo_lock_token = None
2161
if not self._leave_lock:
2162
self._unlock(branch_token, repo_token)
2164
self.repository.unlock()
2166
def break_lock(self):
2168
return self._real_branch.break_lock()
2170
def leave_lock_in_place(self):
2171
if not self._lock_token:
2172
raise NotImplementedError(self.leave_lock_in_place)
2173
self._leave_lock = True
2175
def dont_leave_lock_in_place(self):
2176
if not self._lock_token:
2177
raise NotImplementedError(self.dont_leave_lock_in_place)
2178
self._leave_lock = False
2180
def _last_revision_info(self):
2181
response = self._call('Branch.last_revision_info', self._remote_path())
2182
if response[0] != 'ok':
2183
raise SmartProtocolError('unexpected response code %s' % (response,))
2184
revno = int(response[1])
2185
last_revision = response[2]
2186
return (revno, last_revision)
2188
def _gen_revision_history(self):
2189
"""See Branch._gen_revision_history()."""
2190
response_tuple, response_handler = self._call_expecting_body(
2191
'Branch.revision_history', self._remote_path())
2192
if response_tuple[0] != 'ok':
2193
raise errors.UnexpectedSmartServerResponse(response_tuple)
2194
result = response_handler.read_body_bytes().split('\x00')
2199
def _remote_path(self):
2200
return self.bzrdir._path_for_remote_call(self._client)
2202
def _set_last_revision_descendant(self, revision_id, other_branch,
2203
allow_diverged=False, allow_overwrite_descendant=False):
2204
# This performs additional work to meet the hook contract; while its
2205
# undesirable, we have to synthesise the revno to call the hook, and
2206
# not calling the hook is worse as it means changes can't be prevented.
2207
# Having calculated this though, we can't just call into
2208
# set_last_revision_info as a simple call, because there is a set_rh
2209
# hook that some folk may still be using.
2210
old_revno, old_revid = self.last_revision_info()
2211
history = self._lefthand_history(revision_id)
2212
self._run_pre_change_branch_tip_hooks(len(history), revision_id)
2213
err_context = {'other_branch': other_branch}
2214
response = self._call('Branch.set_last_revision_ex',
2215
self._remote_path(), self._lock_token, self._repo_lock_token,
2216
revision_id, int(allow_diverged), int(allow_overwrite_descendant),
2218
self._clear_cached_state()
2219
if len(response) != 3 and response[0] != 'ok':
2220
raise errors.UnexpectedSmartServerResponse(response)
2221
new_revno, new_revision_id = response[1:]
2222
self._last_revision_info_cache = new_revno, new_revision_id
2223
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2224
if self._real_branch is not None:
2225
cache = new_revno, new_revision_id
2226
self._real_branch._last_revision_info_cache = cache
2228
def _set_last_revision(self, revision_id):
2229
old_revno, old_revid = self.last_revision_info()
2230
# This performs additional work to meet the hook contract; while its
2231
# undesirable, we have to synthesise the revno to call the hook, and
2232
# not calling the hook is worse as it means changes can't be prevented.
2233
# Having calculated this though, we can't just call into
2234
# set_last_revision_info as a simple call, because there is a set_rh
2235
# hook that some folk may still be using.
2236
history = self._lefthand_history(revision_id)
2237
self._run_pre_change_branch_tip_hooks(len(history), revision_id)
2238
self._clear_cached_state()
2239
response = self._call('Branch.set_last_revision',
2240
self._remote_path(), self._lock_token, self._repo_lock_token,
2242
if response != ('ok',):
2243
raise errors.UnexpectedSmartServerResponse(response)
2244
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2247
def set_revision_history(self, rev_history):
2248
# Send just the tip revision of the history; the server will generate
2249
# the full history from that. If the revision doesn't exist in this
2250
# branch, NoSuchRevision will be raised.
2251
if rev_history == []:
2254
rev_id = rev_history[-1]
2255
self._set_last_revision(rev_id)
2256
for hook in branch.Branch.hooks['set_rh']:
2257
hook(self, rev_history)
2258
self._cache_revision_history(rev_history)
2260
def _get_parent_location(self):
2261
medium = self._client._medium
2262
if medium._is_remote_before((1, 13)):
2263
return self._vfs_get_parent_location()
2265
response = self._call('Branch.get_parent', self._remote_path())
2266
except errors.UnknownSmartMethod:
2267
medium._remember_remote_is_before((1, 13))
2268
return self._vfs_get_parent_location()
2269
if len(response) != 1:
2270
raise errors.UnexpectedSmartServerResponse(response)
2271
parent_location = response[0]
2272
if parent_location == '':
2274
return parent_location
2276
def _vfs_get_parent_location(self):
2278
return self._real_branch._get_parent_location()
2280
def set_parent(self, url):
2282
return self._real_branch.set_parent(url)
2284
def _set_parent_location(self, url):
2285
# Used by tests, to poke bad urls into branch configurations
2287
self.set_parent(url)
2290
return self._real_branch._set_parent_location(url)
2292
def set_stacked_on_url(self, stacked_location):
2293
"""Set the URL this branch is stacked against.
2295
:raises UnstackableBranchFormat: If the branch does not support
2297
:raises UnstackableRepositoryFormat: If the repository does not support
2301
return self._real_branch.set_stacked_on_url(stacked_location)
2304
def pull(self, source, overwrite=False, stop_revision=None,
2306
self._clear_cached_state_of_remote_branch_only()
2308
return self._real_branch.pull(
2309
source, overwrite=overwrite, stop_revision=stop_revision,
2310
_override_hook_target=self, **kwargs)
2313
def push(self, target, overwrite=False, stop_revision=None):
2315
return self._real_branch.push(
2316
target, overwrite=overwrite, stop_revision=stop_revision,
2317
_override_hook_source_branch=self)
2319
def is_locked(self):
2320
return self._lock_count >= 1
2323
def revision_id_to_revno(self, revision_id):
2325
return self._real_branch.revision_id_to_revno(revision_id)
2328
def set_last_revision_info(self, revno, revision_id):
2329
# XXX: These should be returned by the set_last_revision_info verb
2330
old_revno, old_revid = self.last_revision_info()
2331
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2332
revision_id = ensure_null(revision_id)
2334
response = self._call('Branch.set_last_revision_info',
2335
self._remote_path(), self._lock_token, self._repo_lock_token,
2336
str(revno), revision_id)
2337
except errors.UnknownSmartMethod:
2339
self._clear_cached_state_of_remote_branch_only()
2340
self._real_branch.set_last_revision_info(revno, revision_id)
2341
self._last_revision_info_cache = revno, revision_id
2343
if response == ('ok',):
2344
self._clear_cached_state()
2345
self._last_revision_info_cache = revno, revision_id
2346
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2347
# Update the _real_branch's cache too.
2348
if self._real_branch is not None:
2349
cache = self._last_revision_info_cache
2350
self._real_branch._last_revision_info_cache = cache
2352
raise errors.UnexpectedSmartServerResponse(response)
2355
def generate_revision_history(self, revision_id, last_rev=None,
2357
medium = self._client._medium
2358
if not medium._is_remote_before((1, 6)):
2359
# Use a smart method for 1.6 and above servers
2361
self._set_last_revision_descendant(revision_id, other_branch,
2362
allow_diverged=True, allow_overwrite_descendant=True)
2364
except errors.UnknownSmartMethod:
2365
medium._remember_remote_is_before((1, 6))
2366
self._clear_cached_state_of_remote_branch_only()
2367
self.set_revision_history(self._lefthand_history(revision_id,
2368
last_rev=last_rev,other_branch=other_branch))
2370
def set_push_location(self, location):
2372
return self._real_branch.set_push_location(location)
2375
def _extract_tar(tar, to_dir):
2376
"""Extract all the contents of a tarfile object.
2378
A replacement for extractall, which is not present in python2.4
2381
tar.extract(tarinfo, to_dir)
2384
def _translate_error(err, **context):
2385
"""Translate an ErrorFromSmartServer into a more useful error.
2387
Possible context keys:
2395
If the error from the server doesn't match a known pattern, then
2396
UnknownErrorFromSmartServer is raised.
2400
return context[name]
2401
except KeyError, key_err:
2402
mutter('Missing key %r in context %r', key_err.args[0], context)
2405
"""Get the path from the context if present, otherwise use first error
2409
return context['path']
2410
except KeyError, key_err:
2412
return err.error_args[0]
2413
except IndexError, idx_err:
2415
'Missing key %r in context %r', key_err.args[0], context)
2418
if err.error_verb == 'NoSuchRevision':
2419
raise NoSuchRevision(find('branch'), err.error_args[0])
2420
elif err.error_verb == 'nosuchrevision':
2421
raise NoSuchRevision(find('repository'), err.error_args[0])
2422
elif err.error_tuple == ('nobranch',):
2423
raise errors.NotBranchError(path=find('bzrdir').root_transport.base)
2424
elif err.error_verb == 'norepository':
2425
raise errors.NoRepositoryPresent(find('bzrdir'))
2426
elif err.error_verb == 'LockContention':
2427
raise errors.LockContention('(remote lock)')
2428
elif err.error_verb == 'UnlockableTransport':
2429
raise errors.UnlockableTransport(find('bzrdir').root_transport)
2430
elif err.error_verb == 'LockFailed':
2431
raise errors.LockFailed(err.error_args[0], err.error_args[1])
2432
elif err.error_verb == 'TokenMismatch':
2433
raise errors.TokenMismatch(find('token'), '(remote token)')
2434
elif err.error_verb == 'Diverged':
2435
raise errors.DivergedBranches(find('branch'), find('other_branch'))
2436
elif err.error_verb == 'TipChangeRejected':
2437
raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
2438
elif err.error_verb == 'UnstackableBranchFormat':
2439
raise errors.UnstackableBranchFormat(*err.error_args)
2440
elif err.error_verb == 'UnstackableRepositoryFormat':
2441
raise errors.UnstackableRepositoryFormat(*err.error_args)
2442
elif err.error_verb == 'NotStacked':
2443
raise errors.NotStacked(branch=find('branch'))
2444
elif err.error_verb == 'PermissionDenied':
2446
if len(err.error_args) >= 2:
2447
extra = err.error_args[1]
2450
raise errors.PermissionDenied(path, extra=extra)
2451
elif err.error_verb == 'ReadError':
2453
raise errors.ReadError(path)
2454
elif err.error_verb == 'NoSuchFile':
2456
raise errors.NoSuchFile(path)
2457
elif err.error_verb == 'FileExists':
2458
raise errors.FileExists(err.error_args[0])
2459
elif err.error_verb == 'DirectoryNotEmpty':
2460
raise errors.DirectoryNotEmpty(err.error_args[0])
2461
elif err.error_verb == 'ShortReadvError':
2462
args = err.error_args
2463
raise errors.ShortReadvError(
2464
args[0], int(args[1]), int(args[2]), int(args[3]))
2465
elif err.error_verb in ('UnicodeEncodeError', 'UnicodeDecodeError'):
2466
encoding = str(err.error_args[0]) # encoding must always be a string
2467
val = err.error_args[1]
2468
start = int(err.error_args[2])
2469
end = int(err.error_args[3])
2470
reason = str(err.error_args[4]) # reason must always be a string
2471
if val.startswith('u:'):
2472
val = val[2:].decode('utf-8')
2473
elif val.startswith('s:'):
2474
val = val[2:].decode('base64')
2475
if err.error_verb == 'UnicodeDecodeError':
2476
raise UnicodeDecodeError(encoding, val, start, end, reason)
2477
elif err.error_verb == 'UnicodeEncodeError':
2478
raise UnicodeEncodeError(encoding, val, start, end, reason)
2479
elif err.error_verb == 'ReadOnlyError':
2480
raise errors.TransportNotPossible('readonly transport')
2481
raise errors.UnknownErrorFromSmartServer(err)
added
removed
bzrlib/remote.py
