1
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
# TODO: At some point, handle upgrades by just passing the whole request
18
# across to run on the server.
35
from bzrlib.branch import BranchReferenceFormat
36
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
37
from bzrlib.decorators import needs_read_lock, needs_write_lock
38
from bzrlib.errors import (
42
from bzrlib.lockable_files import LockableFiles
43
from bzrlib.smart import client, vfs, repository as smart_repo
44
from bzrlib.revision import ensure_null, NULL_REVISION
45
from bzrlib.trace import mutter, note, warning
46
from bzrlib.util import bencode
49
class _RpcHelper(object):
50
"""Mixin class that helps with issuing RPCs."""
52
def _call(self, method, *args, **err_context):
54
return self._client.call(method, *args)
55
except errors.ErrorFromSmartServer, err:
56
self._translate_error(err, **err_context)
58
def _call_expecting_body(self, method, *args, **err_context):
60
return self._client.call_expecting_body(method, *args)
61
except errors.ErrorFromSmartServer, err:
62
self._translate_error(err, **err_context)
64
def _call_with_body_bytes_expecting_body(self, method, args, body_bytes,
67
return self._client.call_with_body_bytes_expecting_body(
68
method, args, body_bytes)
69
except errors.ErrorFromSmartServer, err:
70
self._translate_error(err, **err_context)
73
def response_tuple_to_repo_format(response):
74
"""Convert a response tuple describing a repository format to a format."""
75
format = RemoteRepositoryFormat()
76
format._rich_root_data = (response[0] == 'yes')
77
format._supports_tree_reference = (response[1] == 'yes')
78
format._supports_external_lookups = (response[2] == 'yes')
79
format._network_name = response[3]
83
# Note: RemoteBzrDirFormat is in bzrdir.py
85
class RemoteBzrDir(BzrDir, _RpcHelper):
86
"""Control directory on a remote server, accessed via bzr:// or similar."""
88
def __init__(self, transport, format, _client=None):
89
"""Construct a RemoteBzrDir.
91
:param _client: Private parameter for testing. Disables probing and the
94
BzrDir.__init__(self, transport, format)
95
# this object holds a delegated bzrdir that uses file-level operations
96
# to talk to the other side
97
self._real_bzrdir = None
98
# 1-shot cache for the call pattern 'create_branch; open_branch' - see
99
# create_branch for details.
100
self._next_open_branch_result = None
103
medium = transport.get_smart_medium()
104
self._client = client._SmartClient(medium)
106
self._client = _client
109
path = self._path_for_remote_call(self._client)
110
response = self._call('BzrDir.open', path)
111
if response not in [('yes',), ('no',)]:
112
raise errors.UnexpectedSmartServerResponse(response)
113
if response == ('no',):
114
raise errors.NotBranchError(path=transport.base)
116
def _ensure_real(self):
117
"""Ensure that there is a _real_bzrdir set.
119
Used before calls to self._real_bzrdir.
121
if not self._real_bzrdir:
122
self._real_bzrdir = BzrDir.open_from_transport(
123
self.root_transport, _server_formats=False)
124
self._format._network_name = \
125
self._real_bzrdir._format.network_name()
127
def _translate_error(self, err, **context):
128
_translate_error(err, bzrdir=self, **context)
130
def break_lock(self):
131
# Prevent aliasing problems in the next_open_branch_result cache.
132
# See create_branch for rationale.
133
self._next_open_branch_result = None
134
return BzrDir.break_lock(self)
136
def _vfs_cloning_metadir(self, require_stacking=False):
138
return self._real_bzrdir.cloning_metadir(
139
require_stacking=require_stacking)
141
def cloning_metadir(self, require_stacking=False):
142
medium = self._client._medium
143
if medium._is_remote_before((1, 13)):
144
return self._vfs_cloning_metadir(require_stacking=require_stacking)
145
verb = 'BzrDir.cloning_metadir'
150
path = self._path_for_remote_call(self._client)
152
response = self._call(verb, path, stacking)
153
except errors.UnknownSmartMethod:
154
medium._remember_remote_is_before((1, 13))
155
return self._vfs_cloning_metadir(require_stacking=require_stacking)
156
if len(response) != 3:
157
raise errors.UnexpectedSmartServerResponse(response)
158
control_name, repo_name, branch_info = response
159
if len(branch_info) != 2:
160
raise errors.UnexpectedSmartServerResponse(response)
161
branch_ref, branch_name = branch_info
162
format = bzrdir.network_format_registry.get(control_name)
164
format.repository_format = repository.network_format_registry.get(
166
if branch_ref == 'ref':
167
# XXX: we need possible_transports here to avoid reopening the
168
# connection to the referenced location
169
ref_bzrdir = BzrDir.open(branch_name)
170
branch_format = ref_bzrdir.cloning_metadir().get_branch_format()
171
format.set_branch_format(branch_format)
172
elif branch_ref == 'branch':
174
format.set_branch_format(
175
branch.network_format_registry.get(branch_name))
177
raise errors.UnexpectedSmartServerResponse(response)
180
def create_repository(self, shared=False):
181
# as per meta1 formats - just delegate to the format object which may
183
result = self._format.repository_format.initialize(self, shared)
184
if not isinstance(result, RemoteRepository):
185
return self.open_repository()
189
def destroy_repository(self):
190
"""See BzrDir.destroy_repository"""
192
self._real_bzrdir.destroy_repository()
194
def create_branch(self):
195
# as per meta1 formats - just delegate to the format object which may
197
real_branch = self._format.get_branch_format().initialize(self)
198
if not isinstance(real_branch, RemoteBranch):
199
result = RemoteBranch(self, self.find_repository(), real_branch)
202
# BzrDir.clone_on_transport() uses the result of create_branch but does
203
# not return it to its callers; we save approximately 8% of our round
204
# trips by handing the branch we created back to the first caller to
205
# open_branch rather than probing anew. Long term we need a API in
206
# bzrdir that doesn't discard result objects (like result_branch).
208
self._next_open_branch_result = result
211
def destroy_branch(self):
212
"""See BzrDir.destroy_branch"""
214
self._real_bzrdir.destroy_branch()
215
self._next_open_branch_result = None
217
def create_workingtree(self, revision_id=None, from_branch=None):
218
raise errors.NotLocalUrl(self.transport.base)
220
def find_branch_format(self):
221
"""Find the branch 'format' for this bzrdir.
223
This might be a synthetic object for e.g. RemoteBranch and SVN.
225
b = self.open_branch()
228
def get_branch_reference(self):
229
"""See BzrDir.get_branch_reference()."""
230
response = self._get_branch_reference()
231
if response[0] == 'ref':
236
def _get_branch_reference(self):
237
path = self._path_for_remote_call(self._client)
238
medium = self._client._medium
239
if not medium._is_remote_before((1, 13)):
241
response = self._call('BzrDir.open_branchV2', path)
242
if response[0] not in ('ref', 'branch'):
243
raise errors.UnexpectedSmartServerResponse(response)
245
except errors.UnknownSmartMethod:
246
medium._remember_remote_is_before((1, 13))
247
response = self._call('BzrDir.open_branch', path)
248
if response[0] != 'ok':
249
raise errors.UnexpectedSmartServerResponse(response)
250
if response[1] != '':
251
return ('ref', response[1])
253
return ('branch', '')
255
def _get_tree_branch(self):
256
"""See BzrDir._get_tree_branch()."""
257
return None, self.open_branch()
259
def open_branch(self, _unsupported=False):
261
raise NotImplementedError('unsupported flag support not implemented yet.')
262
if self._next_open_branch_result is not None:
263
# See create_branch for details.
264
result = self._next_open_branch_result
265
self._next_open_branch_result = None
267
response = self._get_branch_reference()
268
if response[0] == 'ref':
269
# a branch reference, use the existing BranchReference logic.
270
format = BranchReferenceFormat()
271
return format.open(self, _found=True, location=response[1])
272
branch_format_name = response[1]
273
if not branch_format_name:
274
branch_format_name = None
275
format = RemoteBranchFormat(network_name=branch_format_name)
276
return RemoteBranch(self, self.find_repository(), format=format)
278
def _open_repo_v1(self, path):
279
verb = 'BzrDir.find_repository'
280
response = self._call(verb, path)
281
if response[0] != 'ok':
282
raise errors.UnexpectedSmartServerResponse(response)
283
# servers that only support the v1 method don't support external
286
repo = self._real_bzrdir.open_repository()
287
response = response + ('no', repo._format.network_name())
288
return response, repo
290
def _open_repo_v2(self, path):
291
verb = 'BzrDir.find_repositoryV2'
292
response = self._call(verb, path)
293
if response[0] != 'ok':
294
raise errors.UnexpectedSmartServerResponse(response)
296
repo = self._real_bzrdir.open_repository()
297
response = response + (repo._format.network_name(),)
298
return response, repo
300
def _open_repo_v3(self, path):
301
verb = 'BzrDir.find_repositoryV3'
302
medium = self._client._medium
303
if medium._is_remote_before((1, 13)):
304
raise errors.UnknownSmartMethod(verb)
306
response = self._call(verb, path)
307
except errors.UnknownSmartMethod:
308
medium._remember_remote_is_before((1, 13))
310
if response[0] != 'ok':
311
raise errors.UnexpectedSmartServerResponse(response)
312
return response, None
314
def open_repository(self):
315
path = self._path_for_remote_call(self._client)
317
for probe in [self._open_repo_v3, self._open_repo_v2,
320
response, real_repo = probe(path)
322
except errors.UnknownSmartMethod:
325
raise errors.UnknownSmartMethod('BzrDir.find_repository{3,2,}')
326
if response[0] != 'ok':
327
raise errors.UnexpectedSmartServerResponse(response)
328
if len(response) != 6:
329
raise SmartProtocolError('incorrect response length %s' % (response,))
330
if response[1] == '':
331
# repo is at this dir.
332
format = response_tuple_to_repo_format(response[2:])
333
# Used to support creating a real format instance when needed.
334
format._creating_bzrdir = self
335
remote_repo = RemoteRepository(self, format)
336
format._creating_repo = remote_repo
337
if real_repo is not None:
338
remote_repo._set_real_repository(real_repo)
341
raise errors.NoRepositoryPresent(self)
343
def open_workingtree(self, recommend_upgrade=True):
345
if self._real_bzrdir.has_workingtree():
346
raise errors.NotLocalUrl(self.root_transport)
348
raise errors.NoWorkingTree(self.root_transport.base)
350
def _path_for_remote_call(self, client):
351
"""Return the path to be used for this bzrdir in a remote call."""
352
return client.remote_path_from_transport(self.root_transport)
354
def get_branch_transport(self, branch_format):
356
return self._real_bzrdir.get_branch_transport(branch_format)
358
def get_repository_transport(self, repository_format):
360
return self._real_bzrdir.get_repository_transport(repository_format)
362
def get_workingtree_transport(self, workingtree_format):
364
return self._real_bzrdir.get_workingtree_transport(workingtree_format)
366
def can_convert_format(self):
367
"""Upgrading of remote bzrdirs is not supported yet."""
370
def needs_format_conversion(self, format=None):
371
"""Upgrading of remote bzrdirs is not supported yet."""
373
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
374
% 'needs_format_conversion(format=None)')
377
def clone(self, url, revision_id=None, force_new_repo=False,
378
preserve_stacking=False):
380
return self._real_bzrdir.clone(url, revision_id=revision_id,
381
force_new_repo=force_new_repo, preserve_stacking=preserve_stacking)
383
def get_config(self):
385
return self._real_bzrdir.get_config()
388
class RemoteRepositoryFormat(repository.RepositoryFormat):
389
"""Format for repositories accessed over a _SmartClient.
391
Instances of this repository are represented by RemoteRepository
394
The RemoteRepositoryFormat is parameterized during construction
395
to reflect the capabilities of the real, remote format. Specifically
396
the attributes rich_root_data and supports_tree_reference are set
397
on a per instance basis, and are not set (and should not be) at
400
:ivar _custom_format: If set, a specific concrete repository format that
401
will be used when initializing a repository with this
402
RemoteRepositoryFormat.
403
:ivar _creating_repo: If set, the repository object that this
404
RemoteRepositoryFormat was created for: it can be called into
405
to obtain data like the network name.
408
_matchingbzrdir = RemoteBzrDirFormat()
411
repository.RepositoryFormat.__init__(self)
412
self._custom_format = None
413
self._network_name = None
414
self._creating_bzrdir = None
415
self._supports_external_lookups = None
416
self._supports_tree_reference = None
417
self._rich_root_data = None
420
def rich_root_data(self):
421
if self._rich_root_data is None:
423
self._rich_root_data = self._custom_format.rich_root_data
424
return self._rich_root_data
427
def supports_external_lookups(self):
428
if self._supports_external_lookups is None:
430
self._supports_external_lookups = \
431
self._custom_format.supports_external_lookups
432
return self._supports_external_lookups
435
def supports_tree_reference(self):
436
if self._supports_tree_reference is None:
438
self._supports_tree_reference = \
439
self._custom_format.supports_tree_reference
440
return self._supports_tree_reference
442
def _vfs_initialize(self, a_bzrdir, shared):
443
"""Helper for common code in initialize."""
444
if self._custom_format:
445
# Custom format requested
446
result = self._custom_format.initialize(a_bzrdir, shared=shared)
447
elif self._creating_bzrdir is not None:
448
# Use the format that the repository we were created to back
450
prior_repo = self._creating_bzrdir.open_repository()
451
prior_repo._ensure_real()
452
result = prior_repo._real_repository._format.initialize(
453
a_bzrdir, shared=shared)
455
# assume that a_bzr is a RemoteBzrDir but the smart server didn't
456
# support remote initialization.
457
# We delegate to a real object at this point (as RemoteBzrDir
458
# delegate to the repository format which would lead to infinite
459
# recursion if we just called a_bzrdir.create_repository.
460
a_bzrdir._ensure_real()
461
result = a_bzrdir._real_bzrdir.create_repository(shared=shared)
462
if not isinstance(result, RemoteRepository):
463
return self.open(a_bzrdir)
467
def initialize(self, a_bzrdir, shared=False):
468
# Being asked to create on a non RemoteBzrDir:
469
if not isinstance(a_bzrdir, RemoteBzrDir):
470
return self._vfs_initialize(a_bzrdir, shared)
471
medium = a_bzrdir._client._medium
472
if medium._is_remote_before((1, 13)):
473
return self._vfs_initialize(a_bzrdir, shared)
474
# Creating on a remote bzr dir.
475
# 1) get the network name to use.
476
if self._custom_format:
477
network_name = self._custom_format.network_name()
479
# Select the current bzrlib default and ask for that.
480
reference_bzrdir_format = bzrdir.format_registry.get('default')()
481
reference_format = reference_bzrdir_format.repository_format
482
network_name = reference_format.network_name()
483
# 2) try direct creation via RPC
484
path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
485
verb = 'BzrDir.create_repository'
491
response = a_bzrdir._call(verb, path, network_name, shared_str)
492
except errors.UnknownSmartMethod:
493
# Fallback - use vfs methods
494
medium._remember_remote_is_before((1, 13))
495
return self._vfs_initialize(a_bzrdir, shared)
497
# Turn the response into a RemoteRepository object.
498
format = response_tuple_to_repo_format(response[1:])
499
# Used to support creating a real format instance when needed.
500
format._creating_bzrdir = a_bzrdir
501
remote_repo = RemoteRepository(a_bzrdir, format)
502
format._creating_repo = remote_repo
505
def open(self, a_bzrdir):
506
if not isinstance(a_bzrdir, RemoteBzrDir):
507
raise AssertionError('%r is not a RemoteBzrDir' % (a_bzrdir,))
508
return a_bzrdir.open_repository()
510
def _ensure_real(self):
511
if self._custom_format is None:
512
self._custom_format = repository.network_format_registry.get(
516
def _fetch_order(self):
518
return self._custom_format._fetch_order
521
def _fetch_uses_deltas(self):
523
return self._custom_format._fetch_uses_deltas
526
def _fetch_reconcile(self):
528
return self._custom_format._fetch_reconcile
530
def get_format_description(self):
531
return 'bzr remote repository'
533
def __eq__(self, other):
534
return self.__class__ is other.__class__
536
def check_conversion_target(self, target_format):
537
if self.rich_root_data and not target_format.rich_root_data:
538
raise errors.BadConversionTarget(
539
'Does not support rich root data.', target_format)
540
if (self.supports_tree_reference and
541
not getattr(target_format, 'supports_tree_reference', False)):
542
raise errors.BadConversionTarget(
543
'Does not support nested trees', target_format)
545
def network_name(self):
546
if self._network_name:
547
return self._network_name
548
self._creating_repo._ensure_real()
549
return self._creating_repo._real_repository._format.network_name()
552
def _serializer(self):
554
return self._custom_format._serializer
557
class RemoteRepository(_RpcHelper):
558
"""Repository accessed over rpc.
560
For the moment most operations are performed using local transport-backed
564
def __init__(self, remote_bzrdir, format, real_repository=None, _client=None):
565
"""Create a RemoteRepository instance.
567
:param remote_bzrdir: The bzrdir hosting this repository.
568
:param format: The RemoteFormat object to use.
569
:param real_repository: If not None, a local implementation of the
570
repository logic for the repository, usually accessing the data
572
:param _client: Private testing parameter - override the smart client
573
to be used by the repository.
576
self._real_repository = real_repository
578
self._real_repository = None
579
self.bzrdir = remote_bzrdir
581
self._client = remote_bzrdir._client
583
self._client = _client
584
self._format = format
585
self._lock_mode = None
586
self._lock_token = None
588
self._leave_lock = False
589
self._unstacked_provider = graph.CachingParentsProvider(
590
get_parent_map=self._get_parent_map_rpc)
591
self._unstacked_provider.disable_cache()
593
# These depend on the actual remote format, so force them off for
594
# maximum compatibility. XXX: In future these should depend on the
595
# remote repository instance, but this is irrelevant until we perform
596
# reconcile via an RPC call.
597
self._reconcile_does_inventory_gc = False
598
self._reconcile_fixes_text_parents = False
599
self._reconcile_backsup_inventory = False
600
self.base = self.bzrdir.transport.base
601
# Additional places to query for data.
602
self._fallback_repositories = []
605
return "%s(%s)" % (self.__class__.__name__, self.base)
609
def abort_write_group(self, suppress_errors=False):
610
"""Complete a write group on the decorated repository.
612
Smart methods peform operations in a single step so this api
613
is not really applicable except as a compatibility thunk
614
for older plugins that don't use e.g. the CommitBuilder
617
:param suppress_errors: see Repository.abort_write_group.
620
return self._real_repository.abort_write_group(
621
suppress_errors=suppress_errors)
623
def commit_write_group(self):
624
"""Complete a write group on the decorated repository.
626
Smart methods peform operations in a single step so this api
627
is not really applicable except as a compatibility thunk
628
for older plugins that don't use e.g. the CommitBuilder
632
return self._real_repository.commit_write_group()
634
def resume_write_group(self, tokens):
636
return self._real_repository.resume_write_group(tokens)
638
def suspend_write_group(self):
640
return self._real_repository.suspend_write_group()
642
def _ensure_real(self):
643
"""Ensure that there is a _real_repository set.
645
Used before calls to self._real_repository.
647
Note that _ensure_real causes many roundtrips to the server which are
648
not desirable, and prevents the use of smart one-roundtrip RPC's to
649
perform complex operations (such as accessing parent data, streaming
650
revisions etc). Adding calls to _ensure_real should only be done when
651
bringing up new functionality, adding fallbacks for smart methods that
652
require a fallback path, and never to replace an existing smart method
653
invocation. If in doubt chat to the bzr network team.
655
if self._real_repository is None:
656
self.bzrdir._ensure_real()
657
self._set_real_repository(
658
self.bzrdir._real_bzrdir.open_repository())
660
def _translate_error(self, err, **context):
661
self.bzrdir._translate_error(err, repository=self, **context)
663
def find_text_key_references(self):
664
"""Find the text key references within the repository.
666
:return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
667
revision_ids. Each altered file-ids has the exact revision_ids that
668
altered it listed explicitly.
669
:return: A dictionary mapping text keys ((fileid, revision_id) tuples)
670
to whether they were referred to by the inventory of the
671
revision_id that they contain. The inventory texts from all present
672
revision ids are assessed to generate this report.
675
return self._real_repository.find_text_key_references()
677
def _generate_text_key_index(self):
678
"""Generate a new text key index for the repository.
680
This is an expensive function that will take considerable time to run.
682
:return: A dict mapping (file_id, revision_id) tuples to a list of
683
parents, also (file_id, revision_id) tuples.
686
return self._real_repository._generate_text_key_index()
688
@symbol_versioning.deprecated_method(symbol_versioning.one_four)
689
def get_revision_graph(self, revision_id=None):
690
"""See Repository.get_revision_graph()."""
691
return self._get_revision_graph(revision_id)
693
def _get_revision_graph(self, revision_id):
694
"""Private method for using with old (< 1.2) servers to fallback."""
695
if revision_id is None:
697
elif revision.is_null(revision_id):
700
path = self.bzrdir._path_for_remote_call(self._client)
701
response = self._call_expecting_body(
702
'Repository.get_revision_graph', path, revision_id)
703
response_tuple, response_handler = response
704
if response_tuple[0] != 'ok':
705
raise errors.UnexpectedSmartServerResponse(response_tuple)
706
coded = response_handler.read_body_bytes()
708
# no revisions in this repository!
710
lines = coded.split('\n')
713
d = tuple(line.split())
714
revision_graph[d[0]] = d[1:]
716
return revision_graph
719
"""See Repository._get_sink()."""
720
return RemoteStreamSink(self)
722
def _get_source(self, to_format):
723
"""Return a source for streaming from this repository."""
724
return RemoteStreamSource(self, to_format)
726
def has_revision(self, revision_id):
727
"""See Repository.has_revision()."""
728
if revision_id == NULL_REVISION:
729
# The null revision is always present.
731
path = self.bzrdir._path_for_remote_call(self._client)
732
response = self._call('Repository.has_revision', path, revision_id)
733
if response[0] not in ('yes', 'no'):
734
raise errors.UnexpectedSmartServerResponse(response)
735
if response[0] == 'yes':
737
for fallback_repo in self._fallback_repositories:
738
if fallback_repo.has_revision(revision_id):
742
def has_revisions(self, revision_ids):
743
"""See Repository.has_revisions()."""
744
# FIXME: This does many roundtrips, particularly when there are
745
# fallback repositories. -- mbp 20080905
747
for revision_id in revision_ids:
748
if self.has_revision(revision_id):
749
result.add(revision_id)
752
def has_same_location(self, other):
753
return (self.__class__ is other.__class__ and
754
self.bzrdir.transport.base == other.bzrdir.transport.base)
756
def get_graph(self, other_repository=None):
757
"""Return the graph for this repository format"""
758
parents_provider = self._make_parents_provider(other_repository)
759
return graph.Graph(parents_provider)
761
def gather_stats(self, revid=None, committers=None):
762
"""See Repository.gather_stats()."""
763
path = self.bzrdir._path_for_remote_call(self._client)
764
# revid can be None to indicate no revisions, not just NULL_REVISION
765
if revid is None or revision.is_null(revid):
769
if committers is None or not committers:
770
fmt_committers = 'no'
772
fmt_committers = 'yes'
773
response_tuple, response_handler = self._call_expecting_body(
774
'Repository.gather_stats', path, fmt_revid, fmt_committers)
775
if response_tuple[0] != 'ok':
776
raise errors.UnexpectedSmartServerResponse(response_tuple)
778
body = response_handler.read_body_bytes()
780
for line in body.split('\n'):
783
key, val_text = line.split(':')
784
if key in ('revisions', 'size', 'committers'):
785
result[key] = int(val_text)
786
elif key in ('firstrev', 'latestrev'):
787
values = val_text.split(' ')[1:]
788
result[key] = (float(values[0]), long(values[1]))
792
def find_branches(self, using=False):
793
"""See Repository.find_branches()."""
794
# should be an API call to the server.
796
return self._real_repository.find_branches(using=using)
798
def get_physical_lock_status(self):
799
"""See Repository.get_physical_lock_status()."""
800
# should be an API call to the server.
802
return self._real_repository.get_physical_lock_status()
804
def is_in_write_group(self):
805
"""Return True if there is an open write group.
807
write groups are only applicable locally for the smart server..
809
if self._real_repository:
810
return self._real_repository.is_in_write_group()
813
return self._lock_count >= 1
816
"""See Repository.is_shared()."""
817
path = self.bzrdir._path_for_remote_call(self._client)
818
response = self._call('Repository.is_shared', path)
819
if response[0] not in ('yes', 'no'):
820
raise SmartProtocolError('unexpected response code %s' % (response,))
821
return response[0] == 'yes'
823
def is_write_locked(self):
824
return self._lock_mode == 'w'
827
# wrong eventually - want a local lock cache context
828
if not self._lock_mode:
829
self._lock_mode = 'r'
831
self._unstacked_provider.enable_cache(cache_misses=False)
832
if self._real_repository is not None:
833
self._real_repository.lock_read()
835
self._lock_count += 1
837
def _remote_lock_write(self, token):
838
path = self.bzrdir._path_for_remote_call(self._client)
841
err_context = {'token': token}
842
response = self._call('Repository.lock_write', path, token,
844
if response[0] == 'ok':
848
raise errors.UnexpectedSmartServerResponse(response)
850
def lock_write(self, token=None, _skip_rpc=False):
851
if not self._lock_mode:
853
if self._lock_token is not None:
854
if token != self._lock_token:
855
raise errors.TokenMismatch(token, self._lock_token)
856
self._lock_token = token
858
self._lock_token = self._remote_lock_write(token)
859
# if self._lock_token is None, then this is something like packs or
860
# svn where we don't get to lock the repo, or a weave style repository
861
# where we cannot lock it over the wire and attempts to do so will
863
if self._real_repository is not None:
864
self._real_repository.lock_write(token=self._lock_token)
865
if token is not None:
866
self._leave_lock = True
868
self._leave_lock = False
869
self._lock_mode = 'w'
871
self._unstacked_provider.enable_cache(cache_misses=False)
872
elif self._lock_mode == 'r':
873
raise errors.ReadOnlyError(self)
875
self._lock_count += 1
876
return self._lock_token or None
878
def leave_lock_in_place(self):
879
if not self._lock_token:
880
raise NotImplementedError(self.leave_lock_in_place)
881
self._leave_lock = True
883
def dont_leave_lock_in_place(self):
884
if not self._lock_token:
885
raise NotImplementedError(self.dont_leave_lock_in_place)
886
self._leave_lock = False
888
def _set_real_repository(self, repository):
889
"""Set the _real_repository for this repository.
891
:param repository: The repository to fallback to for non-hpss
892
implemented operations.
894
if self._real_repository is not None:
895
# Replacing an already set real repository.
896
# We cannot do this [currently] if the repository is locked -
897
# synchronised state might be lost.
899
raise AssertionError('_real_repository is already set')
900
if isinstance(repository, RemoteRepository):
901
raise AssertionError()
902
self._real_repository = repository
903
# If the _real_repository has _fallback_repositories, clear them out,
904
# because we want it to have the same set as this repository. This is
905
# reasonable to do because the fallbacks we clear here are from a
906
# "real" branch, and we're about to replace them with the equivalents
907
# from a RemoteBranch.
908
self._real_repository._fallback_repositories = []
909
for fb in self._fallback_repositories:
910
self._real_repository.add_fallback_repository(fb)
911
if self._lock_mode == 'w':
912
# if we are already locked, the real repository must be able to
913
# acquire the lock with our token.
914
self._real_repository.lock_write(self._lock_token)
915
elif self._lock_mode == 'r':
916
self._real_repository.lock_read()
918
def start_write_group(self):
919
"""Start a write group on the decorated repository.
921
Smart methods peform operations in a single step so this api
922
is not really applicable except as a compatibility thunk
923
for older plugins that don't use e.g. the CommitBuilder
927
return self._real_repository.start_write_group()
929
def _unlock(self, token):
930
path = self.bzrdir._path_for_remote_call(self._client)
932
# with no token the remote repository is not persistently locked.
934
err_context = {'token': token}
935
response = self._call('Repository.unlock', path, token,
937
if response == ('ok',):
940
raise errors.UnexpectedSmartServerResponse(response)
943
if not self._lock_count:
944
raise errors.LockNotHeld(self)
945
self._lock_count -= 1
946
if self._lock_count > 0:
948
self._unstacked_provider.disable_cache()
949
old_mode = self._lock_mode
950
self._lock_mode = None
952
# The real repository is responsible at present for raising an
953
# exception if it's in an unfinished write group. However, it
954
# normally will *not* actually remove the lock from disk - that's
955
# done by the server on receiving the Repository.unlock call.
956
# This is just to let the _real_repository stay up to date.
957
if self._real_repository is not None:
958
self._real_repository.unlock()
960
# The rpc-level lock should be released even if there was a
961
# problem releasing the vfs-based lock.
963
# Only write-locked repositories need to make a remote method
964
# call to perfom the unlock.
965
old_token = self._lock_token
966
self._lock_token = None
967
if not self._leave_lock:
968
self._unlock(old_token)
970
def break_lock(self):
971
# should hand off to the network
973
return self._real_repository.break_lock()
975
def _get_tarball(self, compression):
976
"""Return a TemporaryFile containing a repository tarball.
978
Returns None if the server does not support sending tarballs.
981
path = self.bzrdir._path_for_remote_call(self._client)
983
response, protocol = self._call_expecting_body(
984
'Repository.tarball', path, compression)
985
except errors.UnknownSmartMethod:
986
protocol.cancel_read_body()
988
if response[0] == 'ok':
989
# Extract the tarball and return it
990
t = tempfile.NamedTemporaryFile()
991
# TODO: rpc layer should read directly into it...
992
t.write(protocol.read_body_bytes())
995
raise errors.UnexpectedSmartServerResponse(response)
997
def sprout(self, to_bzrdir, revision_id=None):
998
# TODO: Option to control what format is created?
1000
dest_repo = self._real_repository._format.initialize(to_bzrdir,
1002
dest_repo.fetch(self, revision_id=revision_id)
1005
### These methods are just thin shims to the VFS object for now.
1007
def revision_tree(self, revision_id):
1009
return self._real_repository.revision_tree(revision_id)
1011
def get_serializer_format(self):
1013
return self._real_repository.get_serializer_format()
1015
def get_commit_builder(self, branch, parents, config, timestamp=None,
1016
timezone=None, committer=None, revprops=None,
1018
# FIXME: It ought to be possible to call this without immediately
1019
# triggering _ensure_real. For now it's the easiest thing to do.
1021
real_repo = self._real_repository
1022
builder = real_repo.get_commit_builder(branch, parents,
1023
config, timestamp=timestamp, timezone=timezone,
1024
committer=committer, revprops=revprops, revision_id=revision_id)
1027
def add_fallback_repository(self, repository):
1028
"""Add a repository to use for looking up data not held locally.
1030
:param repository: A repository.
1032
if not self._format.supports_external_lookups:
1033
raise errors.UnstackableRepositoryFormat(
1034
self._format.network_name(), self.base)
1035
# We need to accumulate additional repositories here, to pass them in
1038
self._fallback_repositories.append(repository)
1039
# If self._real_repository was parameterised already (e.g. because a
1040
# _real_branch had its get_stacked_on_url method called), then the
1041
# repository to be added may already be in the _real_repositories list.
1042
if self._real_repository is not None:
1043
if repository not in self._real_repository._fallback_repositories:
1044
self._real_repository.add_fallback_repository(repository)
1046
# They are also seen by the fallback repository. If it doesn't
1047
# exist yet they'll be added then. This implicitly copies them.
1050
def add_inventory(self, revid, inv, parents):
1052
return self._real_repository.add_inventory(revid, inv, parents)
1054
def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1057
return self._real_repository.add_inventory_by_delta(basis_revision_id,
1058
delta, new_revision_id, parents)
1060
def add_revision(self, rev_id, rev, inv=None, config=None):
1062
return self._real_repository.add_revision(
1063
rev_id, rev, inv=inv, config=config)
1066
def get_inventory(self, revision_id):
1068
return self._real_repository.get_inventory(revision_id)
1070
def iter_inventories(self, revision_ids):
1072
return self._real_repository.iter_inventories(revision_ids)
1075
def get_revision(self, revision_id):
1077
return self._real_repository.get_revision(revision_id)
1079
def get_transaction(self):
1081
return self._real_repository.get_transaction()
1084
def clone(self, a_bzrdir, revision_id=None):
1086
return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
1088
def make_working_trees(self):
1089
"""See Repository.make_working_trees"""
1091
return self._real_repository.make_working_trees()
1093
def refresh_data(self):
1094
"""Re-read any data needed to to synchronise with disk.
1096
This method is intended to be called after another repository instance
1097
(such as one used by a smart server) has inserted data into the
1098
repository. It may not be called during a write group, but may be
1099
called at any other time.
1101
if self.is_in_write_group():
1102
raise errors.InternalBzrError(
1103
"May not refresh_data while in a write group.")
1104
if self._real_repository is not None:
1105
self._real_repository.refresh_data()
1107
def revision_ids_to_search_result(self, result_set):
1108
"""Convert a set of revision ids to a graph SearchResult."""
1109
result_parents = set()
1110
for parents in self.get_graph().get_parent_map(
1111
result_set).itervalues():
1112
result_parents.update(parents)
1113
included_keys = result_set.intersection(result_parents)
1114
start_keys = result_set.difference(included_keys)
1115
exclude_keys = result_parents.difference(result_set)
1116
result = graph.SearchResult(start_keys, exclude_keys,
1117
len(result_set), result_set)
1121
def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1122
"""Return the revision ids that other has that this does not.
1124
These are returned in topological order.
1126
revision_id: only return revision ids included by revision_id.
1128
return repository.InterRepository.get(
1129
other, self).search_missing_revision_ids(revision_id, find_ghosts)
1131
def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
1133
# No base implementation to use as RemoteRepository is not a subclass
1134
# of Repository; so this is a copy of Repository.fetch().
1135
if fetch_spec is not None and revision_id is not None:
1136
raise AssertionError(
1137
"fetch_spec and revision_id are mutually exclusive.")
1138
if self.is_in_write_group():
1139
raise errors.InternalBzrError(
1140
"May not fetch while in a write group.")
1141
# fast path same-url fetch operations
1142
if self.has_same_location(source) and fetch_spec is None:
1143
# check that last_revision is in 'from' and then return a
1145
if (revision_id is not None and
1146
not revision.is_null(revision_id)):
1147
self.get_revision(revision_id)
1149
# if there is no specific appropriate InterRepository, this will get
1150
# the InterRepository base class, which raises an
1151
# IncompatibleRepositories when asked to fetch.
1152
inter = repository.InterRepository.get(source, self)
1153
return inter.fetch(revision_id=revision_id, pb=pb,
1154
find_ghosts=find_ghosts, fetch_spec=fetch_spec)
1156
def create_bundle(self, target, base, fileobj, format=None):
1158
self._real_repository.create_bundle(target, base, fileobj, format)
1161
def get_ancestry(self, revision_id, topo_sorted=True):
1163
return self._real_repository.get_ancestry(revision_id, topo_sorted)
1165
def fileids_altered_by_revision_ids(self, revision_ids):
1167
return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
1169
def _get_versioned_file_checker(self, revisions, revision_versions_cache):
1171
return self._real_repository._get_versioned_file_checker(
1172
revisions, revision_versions_cache)
1174
def iter_files_bytes(self, desired_files):
1175
"""See Repository.iter_file_bytes.
1178
return self._real_repository.iter_files_bytes(desired_files)
1180
def get_parent_map(self, revision_ids):
1181
"""See bzrlib.Graph.get_parent_map()."""
1182
return self._make_parents_provider().get_parent_map(revision_ids)
1184
def _get_parent_map_rpc(self, keys):
1185
"""Helper for get_parent_map that performs the RPC."""
1186
medium = self._client._medium
1187
if medium._is_remote_before((1, 2)):
1188
# We already found out that the server can't understand
1189
# Repository.get_parent_map requests, so just fetch the whole
1191
# XXX: Note that this will issue a deprecation warning. This is ok
1192
# :- its because we're working with a deprecated server anyway, and
1193
# the user will almost certainly have seen a warning about the
1194
# server version already.
1195
rg = self.get_revision_graph()
1196
# There is an api discrepency between get_parent_map and
1197
# get_revision_graph. Specifically, a "key:()" pair in
1198
# get_revision_graph just means a node has no parents. For
1199
# "get_parent_map" it means the node is a ghost. So fix up the
1200
# graph to correct this.
1201
# https://bugs.launchpad.net/bzr/+bug/214894
1202
# There is one other "bug" which is that ghosts in
1203
# get_revision_graph() are not returned at all. But we won't worry
1204
# about that for now.
1205
for node_id, parent_ids in rg.iteritems():
1206
if parent_ids == ():
1207
rg[node_id] = (NULL_REVISION,)
1208
rg[NULL_REVISION] = ()
1213
raise ValueError('get_parent_map(None) is not valid')
1214
if NULL_REVISION in keys:
1215
keys.discard(NULL_REVISION)
1216
found_parents = {NULL_REVISION:()}
1218
return found_parents
1221
# TODO(Needs analysis): We could assume that the keys being requested
1222
# from get_parent_map are in a breadth first search, so typically they
1223
# will all be depth N from some common parent, and we don't have to
1224
# have the server iterate from the root parent, but rather from the
1225
# keys we're searching; and just tell the server the keyspace we
1226
# already have; but this may be more traffic again.
1228
# Transform self._parents_map into a search request recipe.
1229
# TODO: Manage this incrementally to avoid covering the same path
1230
# repeatedly. (The server will have to on each request, but the less
1231
# work done the better).
1232
parents_map = self._unstacked_provider.get_cached_map()
1233
if parents_map is None:
1234
# Repository is not locked, so there's no cache.
1236
start_set = set(parents_map)
1237
result_parents = set()
1238
for parents in parents_map.itervalues():
1239
result_parents.update(parents)
1240
stop_keys = result_parents.difference(start_set)
1241
included_keys = start_set.intersection(result_parents)
1242
start_set.difference_update(included_keys)
1243
recipe = ('manual', start_set, stop_keys, len(parents_map))
1244
body = self._serialise_search_recipe(recipe)
1245
path = self.bzrdir._path_for_remote_call(self._client)
1247
if type(key) is not str:
1249
"key %r not a plain string" % (key,))
1250
verb = 'Repository.get_parent_map'
1251
args = (path,) + tuple(keys)
1253
response = self._call_with_body_bytes_expecting_body(
1255
except errors.UnknownSmartMethod:
1256
# Server does not support this method, so get the whole graph.
1257
# Worse, we have to force a disconnection, because the server now
1258
# doesn't realise it has a body on the wire to consume, so the
1259
# only way to recover is to abandon the connection.
1261
'Server is too old for fast get_parent_map, reconnecting. '
1262
'(Upgrade the server to Bazaar 1.2 to avoid this)')
1264
# To avoid having to disconnect repeatedly, we keep track of the
1265
# fact the server doesn't understand remote methods added in 1.2.
1266
medium._remember_remote_is_before((1, 2))
1267
return self.get_revision_graph(None)
1268
response_tuple, response_handler = response
1269
if response_tuple[0] not in ['ok']:
1270
response_handler.cancel_read_body()
1271
raise errors.UnexpectedSmartServerResponse(response_tuple)
1272
if response_tuple[0] == 'ok':
1273
coded = bz2.decompress(response_handler.read_body_bytes())
1275
# no revisions found
1277
lines = coded.split('\n')
1280
d = tuple(line.split())
1282
revision_graph[d[0]] = d[1:]
1284
# No parents - so give the Graph result (NULL_REVISION,).
1285
revision_graph[d[0]] = (NULL_REVISION,)
1286
return revision_graph
1289
def get_signature_text(self, revision_id):
1291
return self._real_repository.get_signature_text(revision_id)
1294
@symbol_versioning.deprecated_method(symbol_versioning.one_three)
1295
def get_revision_graph_with_ghosts(self, revision_ids=None):
1297
return self._real_repository.get_revision_graph_with_ghosts(
1298
revision_ids=revision_ids)
1301
def get_inventory_xml(self, revision_id):
1303
return self._real_repository.get_inventory_xml(revision_id)
1305
def deserialise_inventory(self, revision_id, xml):
1307
return self._real_repository.deserialise_inventory(revision_id, xml)
1309
def reconcile(self, other=None, thorough=False):
1311
return self._real_repository.reconcile(other=other, thorough=thorough)
1313
def all_revision_ids(self):
1315
return self._real_repository.all_revision_ids()
1318
def get_deltas_for_revisions(self, revisions):
1320
return self._real_repository.get_deltas_for_revisions(revisions)
1323
def get_revision_delta(self, revision_id):
1325
return self._real_repository.get_revision_delta(revision_id)
1328
def revision_trees(self, revision_ids):
1330
return self._real_repository.revision_trees(revision_ids)
1333
def get_revision_reconcile(self, revision_id):
1335
return self._real_repository.get_revision_reconcile(revision_id)
1338
def check(self, revision_ids=None):
1340
return self._real_repository.check(revision_ids=revision_ids)
1342
def copy_content_into(self, destination, revision_id=None):
1344
return self._real_repository.copy_content_into(
1345
destination, revision_id=revision_id)
1347
def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
1348
# get a tarball of the remote repository, and copy from that into the
1350
from bzrlib import osutils
1352
# TODO: Maybe a progress bar while streaming the tarball?
1353
note("Copying repository content as tarball...")
1354
tar_file = self._get_tarball('bz2')
1355
if tar_file is None:
1357
destination = to_bzrdir.create_repository()
1359
tar = tarfile.open('repository', fileobj=tar_file,
1361
tmpdir = osutils.mkdtemp()
1363
_extract_tar(tar, tmpdir)
1364
tmp_bzrdir = BzrDir.open(tmpdir)
1365
tmp_repo = tmp_bzrdir.open_repository()
1366
tmp_repo.copy_content_into(destination, revision_id)
1368
osutils.rmtree(tmpdir)
1372
# TODO: Suggestion from john: using external tar is much faster than
1373
# python's tarfile library, but it may not work on windows.
1376
def inventories(self):
1377
"""Decorate the real repository for now.
1379
In the long term a full blown network facility is needed to
1380
avoid creating a real repository object locally.
1383
return self._real_repository.inventories
1387
"""Compress the data within the repository.
1389
This is not currently implemented within the smart server.
1392
return self._real_repository.pack()
1395
def revisions(self):
1396
"""Decorate the real repository for now.
1398
In the short term this should become a real object to intercept graph
1401
In the long term a full blown network facility is needed.
1404
return self._real_repository.revisions
1406
def set_make_working_trees(self, new_value):
1408
new_value_str = "True"
1410
new_value_str = "False"
1411
path = self.bzrdir._path_for_remote_call(self._client)
1413
response = self._call(
1414
'Repository.set_make_working_trees', path, new_value_str)
1415
except errors.UnknownSmartMethod:
1417
self._real_repository.set_make_working_trees(new_value)
1419
if response[0] != 'ok':
1420
raise errors.UnexpectedSmartServerResponse(response)
1423
def signatures(self):
1424
"""Decorate the real repository for now.
1426
In the long term a full blown network facility is needed to avoid
1427
creating a real repository object locally.
1430
return self._real_repository.signatures
1433
def sign_revision(self, revision_id, gpg_strategy):
1435
return self._real_repository.sign_revision(revision_id, gpg_strategy)
1439
"""Decorate the real repository for now.
1441
In the long term a full blown network facility is needed to avoid
1442
creating a real repository object locally.
1445
return self._real_repository.texts
1448
def get_revisions(self, revision_ids):
1450
return self._real_repository.get_revisions(revision_ids)
1452
def supports_rich_root(self):
1453
return self._format.rich_root_data
1455
def iter_reverse_revision_history(self, revision_id):
1457
return self._real_repository.iter_reverse_revision_history(revision_id)
1460
def _serializer(self):
1461
return self._format._serializer
1463
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1465
return self._real_repository.store_revision_signature(
1466
gpg_strategy, plaintext, revision_id)
1468
def add_signature_text(self, revision_id, signature):
1470
return self._real_repository.add_signature_text(revision_id, signature)
1472
def has_signature_for_revision_id(self, revision_id):
1474
return self._real_repository.has_signature_for_revision_id(revision_id)
1476
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
1478
return self._real_repository.item_keys_introduced_by(revision_ids,
1479
_files_pb=_files_pb)
1481
def revision_graph_can_have_wrong_parents(self):
1482
# The answer depends on the remote repo format.
1484
return self._real_repository.revision_graph_can_have_wrong_parents()
1486
def _find_inconsistent_revision_parents(self):
1488
return self._real_repository._find_inconsistent_revision_parents()
1490
def _check_for_inconsistent_revision_parents(self):
1492
return self._real_repository._check_for_inconsistent_revision_parents()
1494
def _make_parents_provider(self, other=None):
1495
providers = [self._unstacked_provider]
1496
if other is not None:
1497
providers.insert(0, other)
1498
providers.extend(r._make_parents_provider() for r in
1499
self._fallback_repositories)
1500
return graph._StackedParentsProvider(providers)
1502
def _serialise_search_recipe(self, recipe):
1503
"""Serialise a graph search recipe.
1505
:param recipe: A search recipe (start, stop, count).
1506
:return: Serialised bytes.
1508
start_keys = ' '.join(recipe[1])
1509
stop_keys = ' '.join(recipe[2])
1510
count = str(recipe[3])
1511
return '\n'.join((start_keys, stop_keys, count))
1513
def _serialise_search_result(self, search_result):
1514
if isinstance(search_result, graph.PendingAncestryResult):
1515
parts = ['ancestry-of']
1516
parts.extend(search_result.heads)
1518
recipe = search_result.get_recipe()
1519
parts = [recipe[0], self._serialise_search_recipe(recipe)]
1520
return '\n'.join(parts)
1523
path = self.bzrdir._path_for_remote_call(self._client)
1525
response = self._call('PackRepository.autopack', path)
1526
except errors.UnknownSmartMethod:
1528
self._real_repository._pack_collection.autopack()
1531
if response[0] != 'ok':
1532
raise errors.UnexpectedSmartServerResponse(response)
1535
class RemoteStreamSink(repository.StreamSink):
1537
def _insert_real(self, stream, src_format, resume_tokens):
1538
self.target_repo._ensure_real()
1539
sink = self.target_repo._real_repository._get_sink()
1540
result = sink.insert_stream(stream, src_format, resume_tokens)
1542
self.target_repo.autopack()
1545
def insert_stream(self, stream, src_format, resume_tokens):
1546
target = self.target_repo
1547
if target._lock_token:
1548
verb = 'Repository.insert_stream_locked'
1549
extra_args = (target._lock_token or '',)
1550
required_version = (1, 14)
1552
verb = 'Repository.insert_stream'
1554
required_version = (1, 13)
1555
client = target._client
1556
medium = client._medium
1557
if medium._is_remote_before(required_version):
1558
# No possible way this can work.
1559
return self._insert_real(stream, src_format, resume_tokens)
1560
path = target.bzrdir._path_for_remote_call(client)
1561
if not resume_tokens:
1562
# XXX: Ugly but important for correctness, *will* be fixed during
1563
# 1.13 cycle. Pushing a stream that is interrupted results in a
1564
# fallback to the _real_repositories sink *with a partial stream*.
1565
# Thats bad because we insert less data than bzr expected. To avoid
1566
# this we do a trial push to make sure the verb is accessible, and
1567
# do not fallback when actually pushing the stream. A cleanup patch
1568
# is going to look at rewinding/restarting the stream/partial
1570
byte_stream = smart_repo._stream_to_byte_stream([], src_format)
1572
response = client.call_with_body_stream(
1573
(verb, path, '') + extra_args, byte_stream)
1574
except errors.UnknownSmartMethod:
1575
medium._remember_remote_is_before(required_version)
1576
return self._insert_real(stream, src_format, resume_tokens)
1577
byte_stream = smart_repo._stream_to_byte_stream(
1579
resume_tokens = ' '.join(resume_tokens)
1580
response = client.call_with_body_stream(
1581
(verb, path, resume_tokens) + extra_args, byte_stream)
1582
if response[0][0] not in ('ok', 'missing-basis'):
1583
raise errors.UnexpectedSmartServerResponse(response)
1584
if response[0][0] == 'missing-basis':
1585
tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
1586
resume_tokens = tokens
1587
return resume_tokens, missing_keys
1589
self.target_repo.refresh_data()
1593
class RemoteStreamSource(repository.StreamSource):
1594
"""Stream data from a remote server."""
1596
def get_stream(self, search):
1597
if (self.from_repository._fallback_repositories and
1598
self.to_format._fetch_order == 'topological'):
1599
return self._real_stream(self.from_repository, search)
1600
return self.missing_parents_chain(search, [self.from_repository] +
1601
self.from_repository._fallback_repositories)
1603
def _real_stream(self, repo, search):
1604
"""Get a stream for search from repo.
1606
This never called RemoteStreamSource.get_stream, and is a heler
1607
for RemoteStreamSource._get_stream to allow getting a stream
1608
reliably whether fallback back because of old servers or trying
1609
to stream from a non-RemoteRepository (which the stacked support
1612
source = repo._get_source(self.to_format)
1613
if isinstance(source, RemoteStreamSource):
1614
return repository.StreamSource.get_stream(source, search)
1615
return source.get_stream(search)
1617
def _get_stream(self, repo, search):
1618
"""Core worker to get a stream from repo for search.
1620
This is used by both get_stream and the stacking support logic. It
1621
deliberately gets a stream for repo which does not need to be
1622
self.from_repository. In the event that repo is not Remote, or
1623
cannot do a smart stream, a fallback is made to the generic
1624
repository._get_stream() interface, via self._real_stream.
1626
In the event of stacking, streams from _get_stream will not
1627
contain all the data for search - this is normal (see get_stream).
1629
:param repo: A repository.
1630
:param search: A search.
1632
# Fallbacks may be non-smart
1633
if not isinstance(repo, RemoteRepository):
1634
return self._real_stream(repo, search)
1635
client = repo._client
1636
medium = client._medium
1637
if medium._is_remote_before((1, 13)):
1638
# streaming was added in 1.13
1639
return self._real_stream(repo, search)
1640
path = repo.bzrdir._path_for_remote_call(client)
1642
search_bytes = repo._serialise_search_result(search)
1643
response = repo._call_with_body_bytes_expecting_body(
1644
'Repository.get_stream',
1645
(path, self.to_format.network_name()), search_bytes)
1646
response_tuple, response_handler = response
1647
except errors.UnknownSmartMethod:
1648
medium._remember_remote_is_before((1,13))
1649
return self._real_stream(repo, search)
1650
if response_tuple[0] != 'ok':
1651
raise errors.UnexpectedSmartServerResponse(response_tuple)
1652
byte_stream = response_handler.read_streamed_body()
1653
src_format, stream = smart_repo._byte_stream_to_stream(byte_stream)
1654
if src_format.network_name() != repo._format.network_name():
1655
raise AssertionError(
1656
"Mismatched RemoteRepository and stream src %r, %r" % (
1657
src_format.network_name(), repo._format.network_name()))
1660
def missing_parents_chain(self, search, sources):
1661
"""Chain multiple streams together to handle stacking.
1663
:param search: The overall search to satisfy with streams.
1664
:param sources: A list of Repository objects to query.
1666
self.serialiser = self.to_format._serializer
1667
self.seen_revs = set()
1668
self.referenced_revs = set()
1669
# If there are heads in the search, or the key count is > 0, we are not
1671
while not search.is_empty() and len(sources) > 1:
1672
source = sources.pop(0)
1673
stream = self._get_stream(source, search)
1674
for kind, substream in stream:
1675
if kind != 'revisions':
1676
yield kind, substream
1678
yield kind, self.missing_parents_rev_handler(substream)
1679
search = search.refine(self.seen_revs, self.referenced_revs)
1680
self.seen_revs = set()
1681
self.referenced_revs = set()
1682
if not search.is_empty():
1683
for kind, stream in self._get_stream(sources[0], search):
1686
def missing_parents_rev_handler(self, substream):
1687
for content in substream:
1688
revision_bytes = content.get_bytes_as('fulltext')
1689
revision = self.serialiser.read_revision_from_string(revision_bytes)
1690
self.seen_revs.add(content.key[-1])
1691
self.referenced_revs.update(revision.parent_ids)
1695
class RemoteBranchLockableFiles(LockableFiles):
1696
"""A 'LockableFiles' implementation that talks to a smart server.
1698
This is not a public interface class.
1701
def __init__(self, bzrdir, _client):
1702
self.bzrdir = bzrdir
1703
self._client = _client
1704
self._need_find_modes = True
1705
LockableFiles.__init__(
1706
self, bzrdir.get_branch_transport(None),
1707
'lock', lockdir.LockDir)
1709
def _find_modes(self):
1710
# RemoteBranches don't let the client set the mode of control files.
1711
self._dir_mode = None
1712
self._file_mode = None
1715
class RemoteBranchFormat(branch.BranchFormat):
1717
def __init__(self, network_name=None):
1718
super(RemoteBranchFormat, self).__init__()
1719
self._matchingbzrdir = RemoteBzrDirFormat()
1720
self._matchingbzrdir.set_branch_format(self)
1721
self._custom_format = None
1722
self._network_name = network_name
1724
def __eq__(self, other):
1725
return (isinstance(other, RemoteBranchFormat) and
1726
self.__dict__ == other.__dict__)
1728
def _ensure_real(self):
1729
if self._custom_format is None:
1730
self._custom_format = branch.network_format_registry.get(
1733
def get_format_description(self):
1734
return 'Remote BZR Branch'
1736
def network_name(self):
1737
return self._network_name
1739
def open(self, a_bzrdir):
1740
return a_bzrdir.open_branch()
1742
def _vfs_initialize(self, a_bzrdir):
1743
# Initialisation when using a local bzrdir object, or a non-vfs init
1744
# method is not available on the server.
1745
# self._custom_format is always set - the start of initialize ensures
1747
if isinstance(a_bzrdir, RemoteBzrDir):
1748
a_bzrdir._ensure_real()
1749
result = self._custom_format.initialize(a_bzrdir._real_bzrdir)
1751
# We assume the bzrdir is parameterised; it may not be.
1752
result = self._custom_format.initialize(a_bzrdir)
1753
if (isinstance(a_bzrdir, RemoteBzrDir) and
1754
not isinstance(result, RemoteBranch)):
1755
result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result)
1758
def initialize(self, a_bzrdir):
1759
# 1) get the network name to use.
1760
if self._custom_format:
1761
network_name = self._custom_format.network_name()
1763
# Select the current bzrlib default and ask for that.
1764
reference_bzrdir_format = bzrdir.format_registry.get('default')()
1765
reference_format = reference_bzrdir_format.get_branch_format()
1766
self._custom_format = reference_format
1767
network_name = reference_format.network_name()
1768
# Being asked to create on a non RemoteBzrDir:
1769
if not isinstance(a_bzrdir, RemoteBzrDir):
1770
return self._vfs_initialize(a_bzrdir)
1771
medium = a_bzrdir._client._medium
1772
if medium._is_remote_before((1, 13)):
1773
return self._vfs_initialize(a_bzrdir)
1774
# Creating on a remote bzr dir.
1775
# 2) try direct creation via RPC
1776
path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
1777
verb = 'BzrDir.create_branch'
1779
response = a_bzrdir._call(verb, path, network_name)
1780
except errors.UnknownSmartMethod:
1781
# Fallback - use vfs methods
1782
medium._remember_remote_is_before((1, 13))
1783
return self._vfs_initialize(a_bzrdir)
1784
if response[0] != 'ok':
1785
raise errors.UnexpectedSmartServerResponse(response)
1786
# Turn the response into a RemoteRepository object.
1787
format = RemoteBranchFormat(network_name=response[1])
1788
repo_format = response_tuple_to_repo_format(response[3:])
1789
if response[2] == '':
1790
repo_bzrdir = a_bzrdir
1792
repo_bzrdir = RemoteBzrDir(
1793
a_bzrdir.root_transport.clone(response[2]), a_bzrdir._format,
1795
remote_repo = RemoteRepository(repo_bzrdir, repo_format)
1796
remote_branch = RemoteBranch(a_bzrdir, remote_repo,
1797
format=format, setup_stacking=False)
1798
# XXX: We know this is a new branch, so it must have revno 0, revid
1799
# NULL_REVISION. Creating the branch locked would make this be unable
1800
# to be wrong; here its simply very unlikely to be wrong. RBC 20090225
1801
remote_branch._last_revision_info_cache = 0, NULL_REVISION
1802
return remote_branch
1804
def make_tags(self, branch):
1806
return self._custom_format.make_tags(branch)
1808
def supports_tags(self):
1809
# Remote branches might support tags, but we won't know until we
1810
# access the real remote branch.
1812
return self._custom_format.supports_tags()
1814
def supports_stacking(self):
1816
return self._custom_format.supports_stacking()
1819
class RemoteBranch(branch.Branch, _RpcHelper):
1820
"""Branch stored on a server accessed by HPSS RPC.
1822
At the moment most operations are mapped down to simple file operations.
1825
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
1826
_client=None, format=None, setup_stacking=True):
1827
"""Create a RemoteBranch instance.
1829
:param real_branch: An optional local implementation of the branch
1830
format, usually accessing the data via the VFS.
1831
:param _client: Private parameter for testing.
1832
:param format: A RemoteBranchFormat object, None to create one
1833
automatically. If supplied it should have a network_name already
1835
:param setup_stacking: If True make an RPC call to determine the
1836
stacked (or not) status of the branch. If False assume the branch
1839
# We intentionally don't call the parent class's __init__, because it
1840
# will try to assign to self.tags, which is a property in this subclass.
1841
# And the parent's __init__ doesn't do much anyway.
1842
self._revision_id_to_revno_cache = None
1843
self._partial_revision_id_to_revno_cache = {}
1844
self._revision_history_cache = None
1845
self._last_revision_info_cache = None
1846
self._merge_sorted_revisions_cache = None
1847
self.bzrdir = remote_bzrdir
1848
if _client is not None:
1849
self._client = _client
1851
self._client = remote_bzrdir._client
1852
self.repository = remote_repository
1853
if real_branch is not None:
1854
self._real_branch = real_branch
1855
# Give the remote repository the matching real repo.
1856
real_repo = self._real_branch.repository
1857
if isinstance(real_repo, RemoteRepository):
1858
real_repo._ensure_real()
1859
real_repo = real_repo._real_repository
1860
self.repository._set_real_repository(real_repo)
1861
# Give the branch the remote repository to let fast-pathing happen.
1862
self._real_branch.repository = self.repository
1864
self._real_branch = None
1865
# Fill out expected attributes of branch for bzrlib api users.
1866
self.base = self.bzrdir.root_transport.base
1867
self._control_files = None
1868
self._lock_mode = None
1869
self._lock_token = None
1870
self._repo_lock_token = None
1871
self._lock_count = 0
1872
self._leave_lock = False
1873
# Setup a format: note that we cannot call _ensure_real until all the
1874
# attributes above are set: This code cannot be moved higher up in this
1877
self._format = RemoteBranchFormat()
1878
if real_branch is not None:
1879
self._format._network_name = \
1880
self._real_branch._format.network_name()
1882
self._format = format
1883
if not self._format._network_name:
1884
# Did not get from open_branchV2 - old server.
1886
self._format._network_name = \
1887
self._real_branch._format.network_name()
1888
self.tags = self._format.make_tags(self)
1889
# The base class init is not called, so we duplicate this:
1890
hooks = branch.Branch.hooks['open']
1894
self._setup_stacking()
1896
def _setup_stacking(self):
1897
# configure stacking into the remote repository, by reading it from
1900
fallback_url = self.get_stacked_on_url()
1901
except (errors.NotStacked, errors.UnstackableBranchFormat,
1902
errors.UnstackableRepositoryFormat), e:
1904
# it's relative to this branch...
1905
fallback_url = urlutils.join(self.base, fallback_url)
1906
transports = [self.bzrdir.root_transport]
1907
stacked_on = branch.Branch.open(fallback_url,
1908
possible_transports=transports)
1909
self.repository.add_fallback_repository(stacked_on.repository)
1911
def _get_real_transport(self):
1912
# if we try vfs access, return the real branch's vfs transport
1914
return self._real_branch._transport
1916
_transport = property(_get_real_transport)
1919
return "%s(%s)" % (self.__class__.__name__, self.base)
1923
def _ensure_real(self):
1924
"""Ensure that there is a _real_branch set.
1926
Used before calls to self._real_branch.
1928
if self._real_branch is None:
1929
if not vfs.vfs_enabled():
1930
raise AssertionError('smart server vfs must be enabled '
1931
'to use vfs implementation')
1932
self.bzrdir._ensure_real()
1933
self._real_branch = self.bzrdir._real_bzrdir.open_branch()
1934
if self.repository._real_repository is None:
1935
# Give the remote repository the matching real repo.
1936
real_repo = self._real_branch.repository
1937
if isinstance(real_repo, RemoteRepository):
1938
real_repo._ensure_real()
1939
real_repo = real_repo._real_repository
1940
self.repository._set_real_repository(real_repo)
1941
# Give the real branch the remote repository to let fast-pathing
1943
self._real_branch.repository = self.repository
1944
if self._lock_mode == 'r':
1945
self._real_branch.lock_read()
1946
elif self._lock_mode == 'w':
1947
self._real_branch.lock_write(token=self._lock_token)
1949
def _translate_error(self, err, **context):
1950
self.repository._translate_error(err, branch=self, **context)
1952
def _clear_cached_state(self):
1953
super(RemoteBranch, self)._clear_cached_state()
1954
if self._real_branch is not None:
1955
self._real_branch._clear_cached_state()
1957
def _clear_cached_state_of_remote_branch_only(self):
1958
"""Like _clear_cached_state, but doesn't clear the cache of
1961
This is useful when falling back to calling a method of
1962
self._real_branch that changes state. In that case the underlying
1963
branch changes, so we need to invalidate this RemoteBranch's cache of
1964
it. However, there's no need to invalidate the _real_branch's cache
1965
too, in fact doing so might harm performance.
1967
super(RemoteBranch, self)._clear_cached_state()
1970
def control_files(self):
1971
# Defer actually creating RemoteBranchLockableFiles until its needed,
1972
# because it triggers an _ensure_real that we otherwise might not need.
1973
if self._control_files is None:
1974
self._control_files = RemoteBranchLockableFiles(
1975
self.bzrdir, self._client)
1976
return self._control_files
1978
def _get_checkout_format(self):
1980
return self._real_branch._get_checkout_format()
1982
def get_physical_lock_status(self):
1983
"""See Branch.get_physical_lock_status()."""
1984
# should be an API call to the server, as branches must be lockable.
1986
return self._real_branch.get_physical_lock_status()
1988
def get_stacked_on_url(self):
1989
"""Get the URL this branch is stacked against.
1991
:raises NotStacked: If the branch is not stacked.
1992
:raises UnstackableBranchFormat: If the branch does not support
1994
:raises UnstackableRepositoryFormat: If the repository does not support
1998
# there may not be a repository yet, so we can't use
1999
# self._translate_error, so we can't use self._call either.
2000
response = self._client.call('Branch.get_stacked_on_url',
2001
self._remote_path())
2002
except errors.ErrorFromSmartServer, err:
2003
# there may not be a repository yet, so we can't call through
2004
# its _translate_error
2005
_translate_error(err, branch=self)
2006
except errors.UnknownSmartMethod, err:
2008
return self._real_branch.get_stacked_on_url()
2009
if response[0] != 'ok':
2010
raise errors.UnexpectedSmartServerResponse(response)
2013
def _vfs_get_tags_bytes(self):
2015
return self._real_branch._get_tags_bytes()
2017
def _get_tags_bytes(self):
2018
medium = self._client._medium
2019
if medium._is_remote_before((1, 13)):
2020
return self._vfs_get_tags_bytes()
2022
response = self._call('Branch.get_tags_bytes', self._remote_path())
2023
except errors.UnknownSmartMethod:
2024
medium._remember_remote_is_before((1, 13))
2025
return self._vfs_get_tags_bytes()
2028
def lock_read(self):
2029
self.repository.lock_read()
2030
if not self._lock_mode:
2031
self._lock_mode = 'r'
2032
self._lock_count = 1
2033
if self._real_branch is not None:
2034
self._real_branch.lock_read()
2036
self._lock_count += 1
2038
def _remote_lock_write(self, token):
2040
branch_token = repo_token = ''
2042
branch_token = token
2043
repo_token = self.repository.lock_write()
2044
self.repository.unlock()
2045
err_context = {'token': token}
2046
response = self._call(
2047
'Branch.lock_write', self._remote_path(), branch_token,
2048
repo_token or '', **err_context)
2049
if response[0] != 'ok':
2050
raise errors.UnexpectedSmartServerResponse(response)
2051
ok, branch_token, repo_token = response
2052
return branch_token, repo_token
2054
def lock_write(self, token=None):
2055
if not self._lock_mode:
2056
# Lock the branch and repo in one remote call.
2057
remote_tokens = self._remote_lock_write(token)
2058
self._lock_token, self._repo_lock_token = remote_tokens
2059
if not self._lock_token:
2060
raise SmartProtocolError('Remote server did not return a token!')
2061
# Tell the self.repository object that it is locked.
2062
self.repository.lock_write(
2063
self._repo_lock_token, _skip_rpc=True)
2065
if self._real_branch is not None:
2066
self._real_branch.lock_write(token=self._lock_token)
2067
if token is not None:
2068
self._leave_lock = True
2070
self._leave_lock = False
2071
self._lock_mode = 'w'
2072
self._lock_count = 1
2073
elif self._lock_mode == 'r':
2074
raise errors.ReadOnlyTransaction
2076
if token is not None:
2077
# A token was given to lock_write, and we're relocking, so
2078
# check that the given token actually matches the one we
2080
if token != self._lock_token:
2081
raise errors.TokenMismatch(token, self._lock_token)
2082
self._lock_count += 1
2083
# Re-lock the repository too.
2084
self.repository.lock_write(self._repo_lock_token)
2085
return self._lock_token or None
2087
def _set_tags_bytes(self, bytes):
2089
return self._real_branch._set_tags_bytes(bytes)
2091
def _unlock(self, branch_token, repo_token):
2092
err_context = {'token': str((branch_token, repo_token))}
2093
response = self._call(
2094
'Branch.unlock', self._remote_path(), branch_token,
2095
repo_token or '', **err_context)
2096
if response == ('ok',):
2098
raise errors.UnexpectedSmartServerResponse(response)
2102
self._lock_count -= 1
2103
if not self._lock_count:
2104
self._clear_cached_state()
2105
mode = self._lock_mode
2106
self._lock_mode = None
2107
if self._real_branch is not None:
2108
if (not self._leave_lock and mode == 'w' and
2109
self._repo_lock_token):
2110
# If this RemoteBranch will remove the physical lock
2111
# for the repository, make sure the _real_branch
2112
# doesn't do it first. (Because the _real_branch's
2113
# repository is set to be the RemoteRepository.)
2114
self._real_branch.repository.leave_lock_in_place()
2115
self._real_branch.unlock()
2117
# Only write-locked branched need to make a remote method
2118
# call to perfom the unlock.
2120
if not self._lock_token:
2121
raise AssertionError('Locked, but no token!')
2122
branch_token = self._lock_token
2123
repo_token = self._repo_lock_token
2124
self._lock_token = None
2125
self._repo_lock_token = None
2126
if not self._leave_lock:
2127
self._unlock(branch_token, repo_token)
2129
self.repository.unlock()
2131
def break_lock(self):
2133
return self._real_branch.break_lock()
2135
def leave_lock_in_place(self):
2136
if not self._lock_token:
2137
raise NotImplementedError(self.leave_lock_in_place)
2138
self._leave_lock = True
2140
def dont_leave_lock_in_place(self):
2141
if not self._lock_token:
2142
raise NotImplementedError(self.dont_leave_lock_in_place)
2143
self._leave_lock = False
2145
def _last_revision_info(self):
2146
response = self._call('Branch.last_revision_info', self._remote_path())
2147
if response[0] != 'ok':
2148
raise SmartProtocolError('unexpected response code %s' % (response,))
2149
revno = int(response[1])
2150
last_revision = response[2]
2151
return (revno, last_revision)
2153
def _gen_revision_history(self):
2154
"""See Branch._gen_revision_history()."""
2155
response_tuple, response_handler = self._call_expecting_body(
2156
'Branch.revision_history', self._remote_path())
2157
if response_tuple[0] != 'ok':
2158
raise errors.UnexpectedSmartServerResponse(response_tuple)
2159
result = response_handler.read_body_bytes().split('\x00')
2164
def _remote_path(self):
2165
return self.bzrdir._path_for_remote_call(self._client)
2167
def _set_last_revision_descendant(self, revision_id, other_branch,
2168
allow_diverged=False, allow_overwrite_descendant=False):
2169
# This performs additional work to meet the hook contract; while its
2170
# undesirable, we have to synthesise the revno to call the hook, and
2171
# not calling the hook is worse as it means changes can't be prevented.
2172
# Having calculated this though, we can't just call into
2173
# set_last_revision_info as a simple call, because there is a set_rh
2174
# hook that some folk may still be using.
2175
old_revno, old_revid = self.last_revision_info()
2176
history = self._lefthand_history(revision_id)
2177
self._run_pre_change_branch_tip_hooks(len(history), revision_id)
2178
err_context = {'other_branch': other_branch}
2179
response = self._call('Branch.set_last_revision_ex',
2180
self._remote_path(), self._lock_token, self._repo_lock_token,
2181
revision_id, int(allow_diverged), int(allow_overwrite_descendant),
2183
self._clear_cached_state()
2184
if len(response) != 3 and response[0] != 'ok':
2185
raise errors.UnexpectedSmartServerResponse(response)
2186
new_revno, new_revision_id = response[1:]
2187
self._last_revision_info_cache = new_revno, new_revision_id
2188
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2189
if self._real_branch is not None:
2190
cache = new_revno, new_revision_id
2191
self._real_branch._last_revision_info_cache = cache
2193
def _set_last_revision(self, revision_id):
2194
old_revno, old_revid = self.last_revision_info()
2195
# This performs additional work to meet the hook contract; while its
2196
# undesirable, we have to synthesise the revno to call the hook, and
2197
# not calling the hook is worse as it means changes can't be prevented.
2198
# Having calculated this though, we can't just call into
2199
# set_last_revision_info as a simple call, because there is a set_rh
2200
# hook that some folk may still be using.
2201
history = self._lefthand_history(revision_id)
2202
self._run_pre_change_branch_tip_hooks(len(history), revision_id)
2203
self._clear_cached_state()
2204
response = self._call('Branch.set_last_revision',
2205
self._remote_path(), self._lock_token, self._repo_lock_token,
2207
if response != ('ok',):
2208
raise errors.UnexpectedSmartServerResponse(response)
2209
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2212
def set_revision_history(self, rev_history):
2213
# Send just the tip revision of the history; the server will generate
2214
# the full history from that. If the revision doesn't exist in this
2215
# branch, NoSuchRevision will be raised.
2216
if rev_history == []:
2219
rev_id = rev_history[-1]
2220
self._set_last_revision(rev_id)
2221
for hook in branch.Branch.hooks['set_rh']:
2222
hook(self, rev_history)
2223
self._cache_revision_history(rev_history)
2225
def _get_parent_location(self):
2226
medium = self._client._medium
2227
if medium._is_remote_before((1, 13)):
2228
return self._vfs_get_parent_location()
2230
response = self._call('Branch.get_parent', self._remote_path())
2231
except errors.UnknownSmartMethod:
2232
medium._remember_remote_is_before((1, 13))
2233
return self._vfs_get_parent_location()
2234
if len(response) != 1:
2235
raise errors.UnexpectedSmartServerResponse(response)
2236
parent_location = response[0]
2237
if parent_location == '':
2239
return parent_location
2241
def _vfs_get_parent_location(self):
2243
return self._real_branch._get_parent_location()
2245
def set_parent(self, url):
2247
return self._real_branch.set_parent(url)
2249
def _set_parent_location(self, url):
2250
# Used by tests, to poke bad urls into branch configurations
2252
self.set_parent(url)
2255
return self._real_branch._set_parent_location(url)
2257
def set_stacked_on_url(self, stacked_location):
2258
"""Set the URL this branch is stacked against.
2260
:raises UnstackableBranchFormat: If the branch does not support
2262
:raises UnstackableRepositoryFormat: If the repository does not support
2266
return self._real_branch.set_stacked_on_url(stacked_location)
2269
def pull(self, source, overwrite=False, stop_revision=None,
2271
self._clear_cached_state_of_remote_branch_only()
2273
return self._real_branch.pull(
2274
source, overwrite=overwrite, stop_revision=stop_revision,
2275
_override_hook_target=self, **kwargs)
2278
def push(self, target, overwrite=False, stop_revision=None):
2280
return self._real_branch.push(
2281
target, overwrite=overwrite, stop_revision=stop_revision,
2282
_override_hook_source_branch=self)
2284
def is_locked(self):
2285
return self._lock_count >= 1
2288
def revision_id_to_revno(self, revision_id):
2290
return self._real_branch.revision_id_to_revno(revision_id)
2293
def set_last_revision_info(self, revno, revision_id):
2294
# XXX: These should be returned by the set_last_revision_info verb
2295
old_revno, old_revid = self.last_revision_info()
2296
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2297
revision_id = ensure_null(revision_id)
2299
response = self._call('Branch.set_last_revision_info',
2300
self._remote_path(), self._lock_token, self._repo_lock_token,
2301
str(revno), revision_id)
2302
except errors.UnknownSmartMethod:
2304
self._clear_cached_state_of_remote_branch_only()
2305
self._real_branch.set_last_revision_info(revno, revision_id)
2306
self._last_revision_info_cache = revno, revision_id
2308
if response == ('ok',):
2309
self._clear_cached_state()
2310
self._last_revision_info_cache = revno, revision_id
2311
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2312
# Update the _real_branch's cache too.
2313
if self._real_branch is not None:
2314
cache = self._last_revision_info_cache
2315
self._real_branch._last_revision_info_cache = cache
2317
raise errors.UnexpectedSmartServerResponse(response)
2320
def generate_revision_history(self, revision_id, last_rev=None,
2322
medium = self._client._medium
2323
if not medium._is_remote_before((1, 6)):
2324
# Use a smart method for 1.6 and above servers
2326
self._set_last_revision_descendant(revision_id, other_branch,
2327
allow_diverged=True, allow_overwrite_descendant=True)
2329
except errors.UnknownSmartMethod:
2330
medium._remember_remote_is_before((1, 6))
2331
self._clear_cached_state_of_remote_branch_only()
2332
self.set_revision_history(self._lefthand_history(revision_id,
2333
last_rev=last_rev,other_branch=other_branch))
2335
def set_push_location(self, location):
2337
return self._real_branch.set_push_location(location)
2340
def _extract_tar(tar, to_dir):
2341
"""Extract all the contents of a tarfile object.
2343
A replacement for extractall, which is not present in python2.4
2346
tar.extract(tarinfo, to_dir)
2349
def _translate_error(err, **context):
2350
"""Translate an ErrorFromSmartServer into a more useful error.
2352
Possible context keys:
2360
If the error from the server doesn't match a known pattern, then
2361
UnknownErrorFromSmartServer is raised.
2365
return context[name]
2366
except KeyError, key_err:
2367
mutter('Missing key %r in context %r', key_err.args[0], context)
2370
"""Get the path from the context if present, otherwise use first error
2374
return context['path']
2375
except KeyError, key_err:
2377
return err.error_args[0]
2378
except IndexError, idx_err:
2380
'Missing key %r in context %r', key_err.args[0], context)
2383
if err.error_verb == 'NoSuchRevision':
2384
raise NoSuchRevision(find('branch'), err.error_args[0])
2385
elif err.error_verb == 'nosuchrevision':
2386
raise NoSuchRevision(find('repository'), err.error_args[0])
2387
elif err.error_tuple == ('nobranch',):
2388
raise errors.NotBranchError(path=find('bzrdir').root_transport.base)
2389
elif err.error_verb == 'norepository':
2390
raise errors.NoRepositoryPresent(find('bzrdir'))
2391
elif err.error_verb == 'LockContention':
2392
raise errors.LockContention('(remote lock)')
2393
elif err.error_verb == 'UnlockableTransport':
2394
raise errors.UnlockableTransport(find('bzrdir').root_transport)
2395
elif err.error_verb == 'LockFailed':
2396
raise errors.LockFailed(err.error_args[0], err.error_args[1])
2397
elif err.error_verb == 'TokenMismatch':
2398
raise errors.TokenMismatch(find('token'), '(remote token)')
2399
elif err.error_verb == 'Diverged':
2400
raise errors.DivergedBranches(find('branch'), find('other_branch'))
2401
elif err.error_verb == 'TipChangeRejected':
2402
raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
2403
elif err.error_verb == 'UnstackableBranchFormat':
2404
raise errors.UnstackableBranchFormat(*err.error_args)
2405
elif err.error_verb == 'UnstackableRepositoryFormat':
2406
raise errors.UnstackableRepositoryFormat(*err.error_args)
2407
elif err.error_verb == 'NotStacked':
2408
raise errors.NotStacked(branch=find('branch'))
2409
elif err.error_verb == 'PermissionDenied':
2411
if len(err.error_args) >= 2:
2412
extra = err.error_args[1]
2415
raise errors.PermissionDenied(path, extra=extra)
2416
elif err.error_verb == 'ReadError':
2418
raise errors.ReadError(path)
2419
elif err.error_verb == 'NoSuchFile':
2421
raise errors.NoSuchFile(path)
2422
elif err.error_verb == 'FileExists':
2423
raise errors.FileExists(err.error_args[0])
2424
elif err.error_verb == 'DirectoryNotEmpty':
2425
raise errors.DirectoryNotEmpty(err.error_args[0])
2426
elif err.error_verb == 'ShortReadvError':
2427
args = err.error_args
2428
raise errors.ShortReadvError(
2429
args[0], int(args[1]), int(args[2]), int(args[3]))
2430
elif err.error_verb in ('UnicodeEncodeError', 'UnicodeDecodeError'):
2431
encoding = str(err.error_args[0]) # encoding must always be a string
2432
val = err.error_args[1]
2433
start = int(err.error_args[2])
2434
end = int(err.error_args[3])
2435
reason = str(err.error_args[4]) # reason must always be a string
2436
if val.startswith('u:'):
2437
val = val[2:].decode('utf-8')
2438
elif val.startswith('s:'):
2439
val = val[2:].decode('base64')
2440
if err.error_verb == 'UnicodeDecodeError':
2441
raise UnicodeDecodeError(encoding, val, start, end, reason)
2442
elif err.error_verb == 'UnicodeEncodeError':
2443
raise UnicodeEncodeError(encoding, val, start, end, reason)
2444
elif err.error_verb == 'ReadOnlyError':
2445
raise errors.TransportNotPossible('readonly transport')
2446
raise errors.UnknownErrorFromSmartServer(err)
added
removed
bzrlib/remote.py
