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.
33
from bzrlib.branch import BranchReferenceFormat
34
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
35
from bzrlib.decorators import needs_read_lock, needs_write_lock
36
from bzrlib.errors import (
40
from bzrlib.lockable_files import LockableFiles
41
from bzrlib.smart import client, vfs
42
from bzrlib.revision import ensure_null, NULL_REVISION
43
from bzrlib.trace import mutter, note, warning
46
class _RpcHelper(object):
47
"""Mixin class that helps with issuing RPCs."""
49
def _call(self, method, *args, **err_context):
51
return self._client.call(method, *args)
52
except errors.ErrorFromSmartServer, err:
53
self._translate_error(err, **err_context)
55
def _call_expecting_body(self, method, *args, **err_context):
57
return self._client.call_expecting_body(method, *args)
58
except errors.ErrorFromSmartServer, err:
59
self._translate_error(err, **err_context)
61
def _call_with_body_bytes_expecting_body(self, method, args, body_bytes,
64
return self._client.call_with_body_bytes_expecting_body(
65
method, args, body_bytes)
66
except errors.ErrorFromSmartServer, err:
67
self._translate_error(err, **err_context)
69
# Note: RemoteBzrDirFormat is in bzrdir.py
71
class RemoteBzrDir(BzrDir, _RpcHelper):
72
"""Control directory on a remote server, accessed via bzr:// or similar."""
74
def __init__(self, transport, format, _client=None):
75
"""Construct a RemoteBzrDir.
77
:param _client: Private parameter for testing. Disables probing and the
80
BzrDir.__init__(self, transport, format)
81
# this object holds a delegated bzrdir that uses file-level operations
82
# to talk to the other side
83
self._real_bzrdir = None
86
medium = transport.get_smart_medium()
87
self._client = client._SmartClient(medium)
89
self._client = _client
92
path = self._path_for_remote_call(self._client)
93
response = self._call('BzrDir.open', path)
94
if response not in [('yes',), ('no',)]:
95
raise errors.UnexpectedSmartServerResponse(response)
96
if response == ('no',):
97
raise errors.NotBranchError(path=transport.base)
99
def _ensure_real(self):
100
"""Ensure that there is a _real_bzrdir set.
102
Used before calls to self._real_bzrdir.
104
if not self._real_bzrdir:
105
self._real_bzrdir = BzrDir.open_from_transport(
106
self.root_transport, _server_formats=False)
108
def _translate_error(self, err, **context):
109
_translate_error(err, bzrdir=self, **context)
111
def cloning_metadir(self, stacked=False):
113
return self._real_bzrdir.cloning_metadir(stacked)
115
def create_repository(self, shared=False):
116
# as per meta1 formats - just delegate to the format object which may
118
result = self._format.repository_format.initialize(self, shared)
119
if not isinstance(result, RemoteRepository):
120
return self.open_repository()
124
def destroy_repository(self):
125
"""See BzrDir.destroy_repository"""
127
self._real_bzrdir.destroy_repository()
129
def create_branch(self):
130
# as per meta1 formats - just delegate to the format object which may
132
real_branch = self._format.get_branch_format().initialize(self)
133
if not isinstance(real_branch, RemoteBranch):
134
return RemoteBranch(self, self.find_repository(), real_branch)
138
def destroy_branch(self):
139
"""See BzrDir.destroy_branch"""
141
self._real_bzrdir.destroy_branch()
143
def create_workingtree(self, revision_id=None, from_branch=None):
144
raise errors.NotLocalUrl(self.transport.base)
146
def find_branch_format(self):
147
"""Find the branch 'format' for this bzrdir.
149
This might be a synthetic object for e.g. RemoteBranch and SVN.
151
b = self.open_branch()
154
def get_branch_reference(self):
155
"""See BzrDir.get_branch_reference()."""
156
path = self._path_for_remote_call(self._client)
157
response = self._call('BzrDir.open_branch', path)
158
if response[0] == 'ok':
159
if response[1] == '':
160
# branch at this location.
163
# a branch reference, use the existing BranchReference logic.
166
raise errors.UnexpectedSmartServerResponse(response)
168
def _get_tree_branch(self):
169
"""See BzrDir._get_tree_branch()."""
170
return None, self.open_branch()
172
def open_branch(self, _unsupported=False):
174
raise NotImplementedError('unsupported flag support not implemented yet.')
175
reference_url = self.get_branch_reference()
176
if reference_url is None:
177
# branch at this location.
178
return RemoteBranch(self, self.find_repository())
180
# a branch reference, use the existing BranchReference logic.
181
format = BranchReferenceFormat()
182
return format.open(self, _found=True, location=reference_url)
184
def open_repository(self):
185
path = self._path_for_remote_call(self._client)
186
verb = 'BzrDir.find_repositoryV2'
188
response = self._call(verb, path)
189
except errors.UnknownSmartMethod:
190
verb = 'BzrDir.find_repository'
191
response = self._call(verb, path)
192
if response[0] != 'ok':
193
raise errors.UnexpectedSmartServerResponse(response)
194
if verb == 'BzrDir.find_repository':
195
# servers that don't support the V2 method don't support external
197
response = response + ('no', )
198
if not (len(response) == 5):
199
raise SmartProtocolError('incorrect response length %s' % (response,))
200
if response[1] == '':
201
format = RemoteRepositoryFormat()
202
format.rich_root_data = (response[2] == 'yes')
203
format.supports_tree_reference = (response[3] == 'yes')
204
# No wire format to check this yet.
205
format.supports_external_lookups = (response[4] == 'yes')
206
# Used to support creating a real format instance when needed.
207
format._creating_bzrdir = self
208
return RemoteRepository(self, format)
210
raise errors.NoRepositoryPresent(self)
212
def open_workingtree(self, recommend_upgrade=True):
214
if self._real_bzrdir.has_workingtree():
215
raise errors.NotLocalUrl(self.root_transport)
217
raise errors.NoWorkingTree(self.root_transport.base)
219
def _path_for_remote_call(self, client):
220
"""Return the path to be used for this bzrdir in a remote call."""
221
return client.remote_path_from_transport(self.root_transport)
223
def get_branch_transport(self, branch_format):
225
return self._real_bzrdir.get_branch_transport(branch_format)
227
def get_repository_transport(self, repository_format):
229
return self._real_bzrdir.get_repository_transport(repository_format)
231
def get_workingtree_transport(self, workingtree_format):
233
return self._real_bzrdir.get_workingtree_transport(workingtree_format)
235
def can_convert_format(self):
236
"""Upgrading of remote bzrdirs is not supported yet."""
239
def needs_format_conversion(self, format=None):
240
"""Upgrading of remote bzrdirs is not supported yet."""
242
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
243
% 'needs_format_conversion(format=None)')
246
def clone(self, url, revision_id=None, force_new_repo=False,
247
preserve_stacking=False):
249
return self._real_bzrdir.clone(url, revision_id=revision_id,
250
force_new_repo=force_new_repo, preserve_stacking=preserve_stacking)
252
def get_config(self):
254
return self._real_bzrdir.get_config()
257
class RemoteRepositoryFormat(repository.RepositoryFormat):
258
"""Format for repositories accessed over a _SmartClient.
260
Instances of this repository are represented by RemoteRepository
263
The RemoteRepositoryFormat is parameterized during construction
264
to reflect the capabilities of the real, remote format. Specifically
265
the attributes rich_root_data and supports_tree_reference are set
266
on a per instance basis, and are not set (and should not be) at
270
_matchingbzrdir = RemoteBzrDirFormat()
273
repository.RepositoryFormat.__init__(self)
274
self._custom_format = None
276
def initialize(self, a_bzrdir, shared=False):
277
if self._custom_format:
278
# This returns a custom instance - e.g. a pack repo, not a remote
280
return self._custom_format.initialize(a_bzrdir, shared=shared)
281
if not isinstance(a_bzrdir, RemoteBzrDir):
282
prior_repo = self._creating_bzrdir.open_repository()
283
prior_repo._ensure_real()
284
return prior_repo._real_repository._format.initialize(
285
a_bzrdir, shared=shared)
286
# delegate to a real object at this point (remoteBzrDir delegate to the
287
# repository format which would lead to infinite recursion).
288
a_bzrdir._ensure_real()
289
result = a_bzrdir._real_bzrdir.create_repository(shared=shared)
290
if not isinstance(result, RemoteRepository):
291
return self.open(a_bzrdir)
295
def open(self, a_bzrdir):
296
if not isinstance(a_bzrdir, RemoteBzrDir):
297
raise AssertionError('%r is not a RemoteBzrDir' % (a_bzrdir,))
298
return a_bzrdir.open_repository()
300
def get_format_description(self):
301
return 'bzr remote repository'
303
def __eq__(self, other):
304
return self.__class__ == other.__class__
306
def check_conversion_target(self, target_format):
307
if self.rich_root_data and not target_format.rich_root_data:
308
raise errors.BadConversionTarget(
309
'Does not support rich root data.', target_format)
310
if (self.supports_tree_reference and
311
not getattr(target_format, 'supports_tree_reference', False)):
312
raise errors.BadConversionTarget(
313
'Does not support nested trees', target_format)
316
class RemoteRepository(_RpcHelper):
317
"""Repository accessed over rpc.
319
For the moment most operations are performed using local transport-backed
323
def __init__(self, remote_bzrdir, format, real_repository=None, _client=None):
324
"""Create a RemoteRepository instance.
326
:param remote_bzrdir: The bzrdir hosting this repository.
327
:param format: The RemoteFormat object to use.
328
:param real_repository: If not None, a local implementation of the
329
repository logic for the repository, usually accessing the data
331
:param _client: Private testing parameter - override the smart client
332
to be used by the repository.
335
self._real_repository = real_repository
337
self._real_repository = None
338
self.bzrdir = remote_bzrdir
340
self._client = remote_bzrdir._client
342
self._client = _client
343
self._format = format
344
self._lock_mode = None
345
self._lock_token = None
347
self._leave_lock = False
348
self._unstacked_provider = graph.CachingParentsProvider(
349
get_parent_map=self._get_parent_map_rpc)
350
self._unstacked_provider.disable_cache()
352
# These depend on the actual remote format, so force them off for
353
# maximum compatibility. XXX: In future these should depend on the
354
# remote repository instance, but this is irrelevant until we perform
355
# reconcile via an RPC call.
356
self._reconcile_does_inventory_gc = False
357
self._reconcile_fixes_text_parents = False
358
self._reconcile_backsup_inventory = False
359
self.base = self.bzrdir.transport.base
360
# Additional places to query for data.
361
self._fallback_repositories = []
364
return "%s(%s)" % (self.__class__.__name__, self.base)
368
def abort_write_group(self, suppress_errors=False):
369
"""Complete a write group on the decorated repository.
371
Smart methods peform operations in a single step so this api
372
is not really applicable except as a compatibility thunk
373
for older plugins that don't use e.g. the CommitBuilder
376
:param suppress_errors: see Repository.abort_write_group.
379
return self._real_repository.abort_write_group(
380
suppress_errors=suppress_errors)
382
def commit_write_group(self):
383
"""Complete a write group on the decorated repository.
385
Smart methods peform operations in a single step so this api
386
is not really applicable except as a compatibility thunk
387
for older plugins that don't use e.g. the CommitBuilder
391
return self._real_repository.commit_write_group()
393
def _ensure_real(self):
394
"""Ensure that there is a _real_repository set.
396
Used before calls to self._real_repository.
398
if self._real_repository is None:
399
self.bzrdir._ensure_real()
400
self._set_real_repository(
401
self.bzrdir._real_bzrdir.open_repository())
403
def _translate_error(self, err, **context):
404
self.bzrdir._translate_error(err, repository=self, **context)
406
def find_text_key_references(self):
407
"""Find the text key references within the repository.
409
:return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
410
revision_ids. Each altered file-ids has the exact revision_ids that
411
altered it listed explicitly.
412
:return: A dictionary mapping text keys ((fileid, revision_id) tuples)
413
to whether they were referred to by the inventory of the
414
revision_id that they contain. The inventory texts from all present
415
revision ids are assessed to generate this report.
418
return self._real_repository.find_text_key_references()
420
def _generate_text_key_index(self):
421
"""Generate a new text key index for the repository.
423
This is an expensive function that will take considerable time to run.
425
:return: A dict mapping (file_id, revision_id) tuples to a list of
426
parents, also (file_id, revision_id) tuples.
429
return self._real_repository._generate_text_key_index()
431
@symbol_versioning.deprecated_method(symbol_versioning.one_four)
432
def get_revision_graph(self, revision_id=None):
433
"""See Repository.get_revision_graph()."""
434
return self._get_revision_graph(revision_id)
436
def _get_revision_graph(self, revision_id):
437
"""Private method for using with old (< 1.2) servers to fallback."""
438
if revision_id is None:
440
elif revision.is_null(revision_id):
443
path = self.bzrdir._path_for_remote_call(self._client)
444
response = self._call_expecting_body(
445
'Repository.get_revision_graph', path, revision_id)
446
response_tuple, response_handler = response
447
if response_tuple[0] != 'ok':
448
raise errors.UnexpectedSmartServerResponse(response_tuple)
449
coded = response_handler.read_body_bytes()
451
# no revisions in this repository!
453
lines = coded.split('\n')
456
d = tuple(line.split())
457
revision_graph[d[0]] = d[1:]
459
return revision_graph
461
def has_revision(self, revision_id):
462
"""See Repository.has_revision()."""
463
if revision_id == NULL_REVISION:
464
# The null revision is always present.
466
path = self.bzrdir._path_for_remote_call(self._client)
467
response = self._call('Repository.has_revision', path, revision_id)
468
if response[0] not in ('yes', 'no'):
469
raise errors.UnexpectedSmartServerResponse(response)
470
if response[0] == 'yes':
472
for fallback_repo in self._fallback_repositories:
473
if fallback_repo.has_revision(revision_id):
477
def has_revisions(self, revision_ids):
478
"""See Repository.has_revisions()."""
479
# FIXME: This does many roundtrips, particularly when there are
480
# fallback repositories. -- mbp 20080905
482
for revision_id in revision_ids:
483
if self.has_revision(revision_id):
484
result.add(revision_id)
487
def has_same_location(self, other):
488
return (self.__class__ == other.__class__ and
489
self.bzrdir.transport.base == other.bzrdir.transport.base)
491
def get_graph(self, other_repository=None):
492
"""Return the graph for this repository format"""
493
parents_provider = self._make_parents_provider(other_repository)
494
return graph.Graph(parents_provider)
496
def gather_stats(self, revid=None, committers=None):
497
"""See Repository.gather_stats()."""
498
path = self.bzrdir._path_for_remote_call(self._client)
499
# revid can be None to indicate no revisions, not just NULL_REVISION
500
if revid is None or revision.is_null(revid):
504
if committers is None or not committers:
505
fmt_committers = 'no'
507
fmt_committers = 'yes'
508
response_tuple, response_handler = self._call_expecting_body(
509
'Repository.gather_stats', path, fmt_revid, fmt_committers)
510
if response_tuple[0] != 'ok':
511
raise errors.UnexpectedSmartServerResponse(response_tuple)
513
body = response_handler.read_body_bytes()
515
for line in body.split('\n'):
518
key, val_text = line.split(':')
519
if key in ('revisions', 'size', 'committers'):
520
result[key] = int(val_text)
521
elif key in ('firstrev', 'latestrev'):
522
values = val_text.split(' ')[1:]
523
result[key] = (float(values[0]), long(values[1]))
527
def find_branches(self, using=False):
528
"""See Repository.find_branches()."""
529
# should be an API call to the server.
531
return self._real_repository.find_branches(using=using)
533
def get_physical_lock_status(self):
534
"""See Repository.get_physical_lock_status()."""
535
# should be an API call to the server.
537
return self._real_repository.get_physical_lock_status()
539
def is_in_write_group(self):
540
"""Return True if there is an open write group.
542
write groups are only applicable locally for the smart server..
544
if self._real_repository:
545
return self._real_repository.is_in_write_group()
548
return self._lock_count >= 1
551
"""See Repository.is_shared()."""
552
path = self.bzrdir._path_for_remote_call(self._client)
553
response = self._call('Repository.is_shared', path)
554
if response[0] not in ('yes', 'no'):
555
raise SmartProtocolError('unexpected response code %s' % (response,))
556
return response[0] == 'yes'
558
def is_write_locked(self):
559
return self._lock_mode == 'w'
562
# wrong eventually - want a local lock cache context
563
if not self._lock_mode:
564
self._lock_mode = 'r'
566
self._unstacked_provider.enable_cache(cache_misses=False)
567
if self._real_repository is not None:
568
self._real_repository.lock_read()
570
self._lock_count += 1
572
def _remote_lock_write(self, token):
573
path = self.bzrdir._path_for_remote_call(self._client)
576
err_context = {'token': token}
577
response = self._call('Repository.lock_write', path, token,
579
if response[0] == 'ok':
583
raise errors.UnexpectedSmartServerResponse(response)
585
def lock_write(self, token=None, _skip_rpc=False):
586
if not self._lock_mode:
588
if self._lock_token is not None:
589
if token != self._lock_token:
590
raise errors.TokenMismatch(token, self._lock_token)
591
self._lock_token = token
593
self._lock_token = self._remote_lock_write(token)
594
# if self._lock_token is None, then this is something like packs or
595
# svn where we don't get to lock the repo, or a weave style repository
596
# where we cannot lock it over the wire and attempts to do so will
598
if self._real_repository is not None:
599
self._real_repository.lock_write(token=self._lock_token)
600
if token is not None:
601
self._leave_lock = True
603
self._leave_lock = False
604
self._lock_mode = 'w'
606
self._unstacked_provider.enable_cache(cache_misses=False)
607
elif self._lock_mode == 'r':
608
raise errors.ReadOnlyError(self)
610
self._lock_count += 1
611
return self._lock_token or None
613
def leave_lock_in_place(self):
614
if not self._lock_token:
615
raise NotImplementedError(self.leave_lock_in_place)
616
self._leave_lock = True
618
def dont_leave_lock_in_place(self):
619
if not self._lock_token:
620
raise NotImplementedError(self.dont_leave_lock_in_place)
621
self._leave_lock = False
623
def _set_real_repository(self, repository):
624
"""Set the _real_repository for this repository.
626
:param repository: The repository to fallback to for non-hpss
627
implemented operations.
629
if self._real_repository is not None:
630
raise AssertionError('_real_repository is already set')
631
if isinstance(repository, RemoteRepository):
632
raise AssertionError()
633
self._real_repository = repository
634
for fb in self._fallback_repositories:
635
self._real_repository.add_fallback_repository(fb)
636
if self._lock_mode == 'w':
637
# if we are already locked, the real repository must be able to
638
# acquire the lock with our token.
639
self._real_repository.lock_write(self._lock_token)
640
elif self._lock_mode == 'r':
641
self._real_repository.lock_read()
643
def start_write_group(self):
644
"""Start a write group on the decorated repository.
646
Smart methods peform operations in a single step so this api
647
is not really applicable except as a compatibility thunk
648
for older plugins that don't use e.g. the CommitBuilder
652
return self._real_repository.start_write_group()
654
def _unlock(self, token):
655
path = self.bzrdir._path_for_remote_call(self._client)
657
# with no token the remote repository is not persistently locked.
659
err_context = {'token': token}
660
response = self._call('Repository.unlock', path, token,
662
if response == ('ok',):
665
raise errors.UnexpectedSmartServerResponse(response)
668
self._lock_count -= 1
669
if self._lock_count > 0:
671
self._unstacked_provider.disable_cache()
672
old_mode = self._lock_mode
673
self._lock_mode = None
675
# The real repository is responsible at present for raising an
676
# exception if it's in an unfinished write group. However, it
677
# normally will *not* actually remove the lock from disk - that's
678
# done by the server on receiving the Repository.unlock call.
679
# This is just to let the _real_repository stay up to date.
680
if self._real_repository is not None:
681
self._real_repository.unlock()
683
# The rpc-level lock should be released even if there was a
684
# problem releasing the vfs-based lock.
686
# Only write-locked repositories need to make a remote method
687
# call to perfom the unlock.
688
old_token = self._lock_token
689
self._lock_token = None
690
if not self._leave_lock:
691
self._unlock(old_token)
693
def break_lock(self):
694
# should hand off to the network
696
return self._real_repository.break_lock()
698
def _get_tarball(self, compression):
699
"""Return a TemporaryFile containing a repository tarball.
701
Returns None if the server does not support sending tarballs.
704
path = self.bzrdir._path_for_remote_call(self._client)
706
response, protocol = self._call_expecting_body(
707
'Repository.tarball', path, compression)
708
except errors.UnknownSmartMethod:
709
protocol.cancel_read_body()
711
if response[0] == 'ok':
712
# Extract the tarball and return it
713
t = tempfile.NamedTemporaryFile()
714
# TODO: rpc layer should read directly into it...
715
t.write(protocol.read_body_bytes())
718
raise errors.UnexpectedSmartServerResponse(response)
720
def sprout(self, to_bzrdir, revision_id=None):
721
# TODO: Option to control what format is created?
723
dest_repo = self._real_repository._format.initialize(to_bzrdir,
725
dest_repo.fetch(self, revision_id=revision_id)
728
### These methods are just thin shims to the VFS object for now.
730
def revision_tree(self, revision_id):
732
return self._real_repository.revision_tree(revision_id)
734
def get_serializer_format(self):
736
return self._real_repository.get_serializer_format()
738
def get_commit_builder(self, branch, parents, config, timestamp=None,
739
timezone=None, committer=None, revprops=None,
741
# FIXME: It ought to be possible to call this without immediately
742
# triggering _ensure_real. For now it's the easiest thing to do.
744
real_repo = self._real_repository
745
builder = real_repo.get_commit_builder(branch, parents,
746
config, timestamp=timestamp, timezone=timezone,
747
committer=committer, revprops=revprops, revision_id=revision_id)
750
def add_fallback_repository(self, repository):
751
"""Add a repository to use for looking up data not held locally.
753
:param repository: A repository.
755
# XXX: At the moment the RemoteRepository will allow fallbacks
756
# unconditionally - however, a _real_repository will usually exist,
757
# and may raise an error if it's not accommodated by the underlying
758
# format. Eventually we should check when opening the repository
759
# whether it's willing to allow them or not.
761
# We need to accumulate additional repositories here, to pass them in
763
self._fallback_repositories.append(repository)
764
# They are also seen by the fallback repository. If it doesn't exist
765
# yet they'll be added then. This implicitly copies them.
768
def add_inventory(self, revid, inv, parents):
770
return self._real_repository.add_inventory(revid, inv, parents)
772
def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
775
return self._real_repository.add_inventory_by_delta(basis_revision_id,
776
delta, new_revision_id, parents)
778
def add_revision(self, rev_id, rev, inv=None, config=None):
780
return self._real_repository.add_revision(
781
rev_id, rev, inv=inv, config=config)
784
def get_inventory(self, revision_id):
786
return self._real_repository.get_inventory(revision_id)
788
def iter_inventories(self, revision_ids):
790
return self._real_repository.iter_inventories(revision_ids)
793
def get_revision(self, revision_id):
795
return self._real_repository.get_revision(revision_id)
797
def get_transaction(self):
799
return self._real_repository.get_transaction()
802
def clone(self, a_bzrdir, revision_id=None):
804
return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
806
def make_working_trees(self):
807
"""See Repository.make_working_trees"""
809
return self._real_repository.make_working_trees()
811
def revision_ids_to_search_result(self, result_set):
812
"""Convert a set of revision ids to a graph SearchResult."""
813
result_parents = set()
814
for parents in self.get_graph().get_parent_map(
815
result_set).itervalues():
816
result_parents.update(parents)
817
included_keys = result_set.intersection(result_parents)
818
start_keys = result_set.difference(included_keys)
819
exclude_keys = result_parents.difference(result_set)
820
result = graph.SearchResult(start_keys, exclude_keys,
821
len(result_set), result_set)
825
def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
826
"""Return the revision ids that other has that this does not.
828
These are returned in topological order.
830
revision_id: only return revision ids included by revision_id.
832
return repository.InterRepository.get(
833
other, self).search_missing_revision_ids(revision_id, find_ghosts)
835
def fetch(self, source, revision_id=None, pb=None, find_ghosts=False):
836
# Not delegated to _real_repository so that InterRepository.get has a
837
# chance to find an InterRepository specialised for RemoteRepository.
838
if self.has_same_location(source):
839
# check that last_revision is in 'from' and then return a
841
if (revision_id is not None and
842
not revision.is_null(revision_id)):
843
self.get_revision(revision_id)
845
inter = repository.InterRepository.get(source, self)
847
return inter.fetch(revision_id=revision_id, pb=pb, find_ghosts=find_ghosts)
848
except NotImplementedError:
849
raise errors.IncompatibleRepositories(source, self)
851
def create_bundle(self, target, base, fileobj, format=None):
853
self._real_repository.create_bundle(target, base, fileobj, format)
856
def get_ancestry(self, revision_id, topo_sorted=True):
858
return self._real_repository.get_ancestry(revision_id, topo_sorted)
860
def fileids_altered_by_revision_ids(self, revision_ids):
862
return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
864
def _get_versioned_file_checker(self, revisions, revision_versions_cache):
866
return self._real_repository._get_versioned_file_checker(
867
revisions, revision_versions_cache)
869
def iter_files_bytes(self, desired_files):
870
"""See Repository.iter_file_bytes.
873
return self._real_repository.iter_files_bytes(desired_files)
876
def _fetch_order(self):
877
"""Decorate the real repository for now.
879
In the long term getting this back from the remote repository as part
880
of open would be more efficient.
883
return self._real_repository._fetch_order
886
def _fetch_uses_deltas(self):
887
"""Decorate the real repository for now.
889
In the long term getting this back from the remote repository as part
890
of open would be more efficient.
893
return self._real_repository._fetch_uses_deltas
896
def _fetch_reconcile(self):
897
"""Decorate the real repository for now.
899
In the long term getting this back from the remote repository as part
900
of open would be more efficient.
903
return self._real_repository._fetch_reconcile
905
def get_parent_map(self, revision_ids):
906
"""See bzrlib.Graph.get_parent_map()."""
907
return self._make_parents_provider().get_parent_map(revision_ids)
909
def _get_parent_map_rpc(self, keys):
910
"""Helper for get_parent_map that performs the RPC."""
911
medium = self._client._medium
912
if medium._is_remote_before((1, 2)):
913
# We already found out that the server can't understand
914
# Repository.get_parent_map requests, so just fetch the whole
916
# XXX: Note that this will issue a deprecation warning. This is ok
917
# :- its because we're working with a deprecated server anyway, and
918
# the user will almost certainly have seen a warning about the
919
# server version already.
920
rg = self.get_revision_graph()
921
# There is an api discrepency between get_parent_map and
922
# get_revision_graph. Specifically, a "key:()" pair in
923
# get_revision_graph just means a node has no parents. For
924
# "get_parent_map" it means the node is a ghost. So fix up the
925
# graph to correct this.
926
# https://bugs.launchpad.net/bzr/+bug/214894
927
# There is one other "bug" which is that ghosts in
928
# get_revision_graph() are not returned at all. But we won't worry
929
# about that for now.
930
for node_id, parent_ids in rg.iteritems():
932
rg[node_id] = (NULL_REVISION,)
933
rg[NULL_REVISION] = ()
938
raise ValueError('get_parent_map(None) is not valid')
939
if NULL_REVISION in keys:
940
keys.discard(NULL_REVISION)
941
found_parents = {NULL_REVISION:()}
946
# TODO(Needs analysis): We could assume that the keys being requested
947
# from get_parent_map are in a breadth first search, so typically they
948
# will all be depth N from some common parent, and we don't have to
949
# have the server iterate from the root parent, but rather from the
950
# keys we're searching; and just tell the server the keyspace we
951
# already have; but this may be more traffic again.
953
# Transform self._parents_map into a search request recipe.
954
# TODO: Manage this incrementally to avoid covering the same path
955
# repeatedly. (The server will have to on each request, but the less
956
# work done the better).
957
parents_map = self._unstacked_provider.get_cached_map()
958
if parents_map is None:
959
# Repository is not locked, so there's no cache.
961
start_set = set(parents_map)
962
result_parents = set()
963
for parents in parents_map.itervalues():
964
result_parents.update(parents)
965
stop_keys = result_parents.difference(start_set)
966
included_keys = start_set.intersection(result_parents)
967
start_set.difference_update(included_keys)
968
recipe = (start_set, stop_keys, len(parents_map))
969
body = self._serialise_search_recipe(recipe)
970
path = self.bzrdir._path_for_remote_call(self._client)
972
if type(key) is not str:
974
"key %r not a plain string" % (key,))
975
verb = 'Repository.get_parent_map'
976
args = (path,) + tuple(keys)
978
response = self._call_with_body_bytes_expecting_body(
980
except errors.UnknownSmartMethod:
981
# Server does not support this method, so get the whole graph.
982
# Worse, we have to force a disconnection, because the server now
983
# doesn't realise it has a body on the wire to consume, so the
984
# only way to recover is to abandon the connection.
986
'Server is too old for fast get_parent_map, reconnecting. '
987
'(Upgrade the server to Bazaar 1.2 to avoid this)')
989
# To avoid having to disconnect repeatedly, we keep track of the
990
# fact the server doesn't understand remote methods added in 1.2.
991
medium._remember_remote_is_before((1, 2))
992
return self.get_revision_graph(None)
993
response_tuple, response_handler = response
994
if response_tuple[0] not in ['ok']:
995
response_handler.cancel_read_body()
996
raise errors.UnexpectedSmartServerResponse(response_tuple)
997
if response_tuple[0] == 'ok':
998
coded = bz2.decompress(response_handler.read_body_bytes())
1000
# no revisions found
1002
lines = coded.split('\n')
1005
d = tuple(line.split())
1007
revision_graph[d[0]] = d[1:]
1009
# No parents - so give the Graph result (NULL_REVISION,).
1010
revision_graph[d[0]] = (NULL_REVISION,)
1011
return revision_graph
1014
def get_signature_text(self, revision_id):
1016
return self._real_repository.get_signature_text(revision_id)
1019
@symbol_versioning.deprecated_method(symbol_versioning.one_three)
1020
def get_revision_graph_with_ghosts(self, revision_ids=None):
1022
return self._real_repository.get_revision_graph_with_ghosts(
1023
revision_ids=revision_ids)
1026
def get_inventory_xml(self, revision_id):
1028
return self._real_repository.get_inventory_xml(revision_id)
1030
def deserialise_inventory(self, revision_id, xml):
1032
return self._real_repository.deserialise_inventory(revision_id, xml)
1034
def reconcile(self, other=None, thorough=False):
1036
return self._real_repository.reconcile(other=other, thorough=thorough)
1038
def all_revision_ids(self):
1040
return self._real_repository.all_revision_ids()
1043
def get_deltas_for_revisions(self, revisions):
1045
return self._real_repository.get_deltas_for_revisions(revisions)
1048
def get_revision_delta(self, revision_id):
1050
return self._real_repository.get_revision_delta(revision_id)
1053
def revision_trees(self, revision_ids):
1055
return self._real_repository.revision_trees(revision_ids)
1058
def get_revision_reconcile(self, revision_id):
1060
return self._real_repository.get_revision_reconcile(revision_id)
1063
def check(self, revision_ids=None):
1065
return self._real_repository.check(revision_ids=revision_ids)
1067
def copy_content_into(self, destination, revision_id=None):
1069
return self._real_repository.copy_content_into(
1070
destination, revision_id=revision_id)
1072
def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
1073
# get a tarball of the remote repository, and copy from that into the
1075
from bzrlib import osutils
1077
# TODO: Maybe a progress bar while streaming the tarball?
1078
note("Copying repository content as tarball...")
1079
tar_file = self._get_tarball('bz2')
1080
if tar_file is None:
1082
destination = to_bzrdir.create_repository()
1084
tar = tarfile.open('repository', fileobj=tar_file,
1086
tmpdir = osutils.mkdtemp()
1088
_extract_tar(tar, tmpdir)
1089
tmp_bzrdir = BzrDir.open(tmpdir)
1090
tmp_repo = tmp_bzrdir.open_repository()
1091
tmp_repo.copy_content_into(destination, revision_id)
1093
osutils.rmtree(tmpdir)
1097
# TODO: Suggestion from john: using external tar is much faster than
1098
# python's tarfile library, but it may not work on windows.
1101
def inventories(self):
1102
"""Decorate the real repository for now.
1104
In the long term a full blown network facility is needed to
1105
avoid creating a real repository object locally.
1108
return self._real_repository.inventories
1112
"""Compress the data within the repository.
1114
This is not currently implemented within the smart server.
1117
return self._real_repository.pack()
1120
def revisions(self):
1121
"""Decorate the real repository for now.
1123
In the short term this should become a real object to intercept graph
1126
In the long term a full blown network facility is needed.
1129
return self._real_repository.revisions
1131
def set_make_working_trees(self, new_value):
1133
self._real_repository.set_make_working_trees(new_value)
1136
def signatures(self):
1137
"""Decorate the real repository for now.
1139
In the long term a full blown network facility is needed to avoid
1140
creating a real repository object locally.
1143
return self._real_repository.signatures
1146
def sign_revision(self, revision_id, gpg_strategy):
1148
return self._real_repository.sign_revision(revision_id, gpg_strategy)
1152
"""Decorate the real repository for now.
1154
In the long term a full blown network facility is needed to avoid
1155
creating a real repository object locally.
1158
return self._real_repository.texts
1161
def get_revisions(self, revision_ids):
1163
return self._real_repository.get_revisions(revision_ids)
1165
def supports_rich_root(self):
1167
return self._real_repository.supports_rich_root()
1169
def iter_reverse_revision_history(self, revision_id):
1171
return self._real_repository.iter_reverse_revision_history(revision_id)
1174
def _serializer(self):
1176
return self._real_repository._serializer
1178
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1180
return self._real_repository.store_revision_signature(
1181
gpg_strategy, plaintext, revision_id)
1183
def add_signature_text(self, revision_id, signature):
1185
return self._real_repository.add_signature_text(revision_id, signature)
1187
def has_signature_for_revision_id(self, revision_id):
1189
return self._real_repository.has_signature_for_revision_id(revision_id)
1191
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
1193
return self._real_repository.item_keys_introduced_by(revision_ids,
1194
_files_pb=_files_pb)
1196
def revision_graph_can_have_wrong_parents(self):
1197
# The answer depends on the remote repo format.
1199
return self._real_repository.revision_graph_can_have_wrong_parents()
1201
def _find_inconsistent_revision_parents(self):
1203
return self._real_repository._find_inconsistent_revision_parents()
1205
def _check_for_inconsistent_revision_parents(self):
1207
return self._real_repository._check_for_inconsistent_revision_parents()
1209
def _make_parents_provider(self, other=None):
1210
providers = [self._unstacked_provider]
1211
if other is not None:
1212
providers.insert(0, other)
1213
providers.extend(r._make_parents_provider() for r in
1214
self._fallback_repositories)
1215
return graph._StackedParentsProvider(providers)
1217
def _serialise_search_recipe(self, recipe):
1218
"""Serialise a graph search recipe.
1220
:param recipe: A search recipe (start, stop, count).
1221
:return: Serialised bytes.
1223
start_keys = ' '.join(recipe[0])
1224
stop_keys = ' '.join(recipe[1])
1225
count = str(recipe[2])
1226
return '\n'.join((start_keys, stop_keys, count))
1229
path = self.bzrdir._path_for_remote_call(self._client)
1231
response = self._call('PackRepository.autopack', path)
1232
except errors.UnknownSmartMethod:
1234
self._real_repository._pack_collection.autopack()
1236
if self._real_repository is not None:
1237
# Reset the real repository's cache of pack names.
1238
# XXX: At some point we may be able to skip this and just rely on
1239
# the automatic retry logic to do the right thing, but for now we
1240
# err on the side of being correct rather than being optimal.
1241
self._real_repository._pack_collection.reload_pack_names()
1242
if response[0] != 'ok':
1243
raise errors.UnexpectedSmartServerResponse(response)
1246
class RemoteBranchLockableFiles(LockableFiles):
1247
"""A 'LockableFiles' implementation that talks to a smart server.
1249
This is not a public interface class.
1252
def __init__(self, bzrdir, _client):
1253
self.bzrdir = bzrdir
1254
self._client = _client
1255
self._need_find_modes = True
1256
LockableFiles.__init__(
1257
self, bzrdir.get_branch_transport(None),
1258
'lock', lockdir.LockDir)
1260
def _find_modes(self):
1261
# RemoteBranches don't let the client set the mode of control files.
1262
self._dir_mode = None
1263
self._file_mode = None
1266
class RemoteBranchFormat(branch.BranchFormat):
1269
super(RemoteBranchFormat, self).__init__()
1270
self._matchingbzrdir = RemoteBzrDirFormat()
1271
self._matchingbzrdir.set_branch_format(self)
1273
def __eq__(self, other):
1274
return (isinstance(other, RemoteBranchFormat) and
1275
self.__dict__ == other.__dict__)
1277
def get_format_description(self):
1278
return 'Remote BZR Branch'
1280
def get_format_string(self):
1281
return 'Remote BZR Branch'
1283
def open(self, a_bzrdir):
1284
return a_bzrdir.open_branch()
1286
def initialize(self, a_bzrdir):
1287
# Delegate to a _real object here - the RemoteBzrDir format now
1288
# supports delegating to parameterised branch formats and as such
1289
# this RemoteBranchFormat method is only called when no specific format
1291
if not isinstance(a_bzrdir, RemoteBzrDir):
1292
result = a_bzrdir.create_branch()
1294
a_bzrdir._ensure_real()
1295
result = a_bzrdir._real_bzrdir.create_branch()
1296
if not isinstance(result, RemoteBranch):
1297
result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result)
1300
def supports_tags(self):
1301
# Remote branches might support tags, but we won't know until we
1302
# access the real remote branch.
1306
class RemoteBranch(branch.Branch, _RpcHelper):
1307
"""Branch stored on a server accessed by HPSS RPC.
1309
At the moment most operations are mapped down to simple file operations.
1312
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
1314
"""Create a RemoteBranch instance.
1316
:param real_branch: An optional local implementation of the branch
1317
format, usually accessing the data via the VFS.
1318
:param _client: Private parameter for testing.
1320
# We intentionally don't call the parent class's __init__, because it
1321
# will try to assign to self.tags, which is a property in this subclass.
1322
# And the parent's __init__ doesn't do much anyway.
1323
self._revision_id_to_revno_cache = None
1324
self._partial_revision_id_to_revno_cache = {}
1325
self._revision_history_cache = None
1326
self._last_revision_info_cache = None
1327
self._merge_sorted_revisions_cache = None
1328
self.bzrdir = remote_bzrdir
1329
if _client is not None:
1330
self._client = _client
1332
self._client = remote_bzrdir._client
1333
self.repository = remote_repository
1334
if real_branch is not None:
1335
self._real_branch = real_branch
1336
# Give the remote repository the matching real repo.
1337
real_repo = self._real_branch.repository
1338
if isinstance(real_repo, RemoteRepository):
1339
real_repo._ensure_real()
1340
real_repo = real_repo._real_repository
1341
self.repository._set_real_repository(real_repo)
1342
# Give the branch the remote repository to let fast-pathing happen.
1343
self._real_branch.repository = self.repository
1345
self._real_branch = None
1346
# Fill out expected attributes of branch for bzrlib api users.
1347
self._format = RemoteBranchFormat()
1348
self.base = self.bzrdir.root_transport.base
1349
self._control_files = None
1350
self._lock_mode = None
1351
self._lock_token = None
1352
self._repo_lock_token = None
1353
self._lock_count = 0
1354
self._leave_lock = False
1355
# The base class init is not called, so we duplicate this:
1356
hooks = branch.Branch.hooks['open']
1359
self._setup_stacking()
1361
def _setup_stacking(self):
1362
# configure stacking into the remote repository, by reading it from
1365
fallback_url = self.get_stacked_on_url()
1366
except (errors.NotStacked, errors.UnstackableBranchFormat,
1367
errors.UnstackableRepositoryFormat), e:
1369
# it's relative to this branch...
1370
fallback_url = urlutils.join(self.base, fallback_url)
1371
transports = [self.bzrdir.root_transport]
1372
if self._real_branch is not None:
1373
transports.append(self._real_branch._transport)
1374
stacked_on = branch.Branch.open(fallback_url,
1375
possible_transports=transports)
1376
self.repository.add_fallback_repository(stacked_on.repository)
1378
def _get_real_transport(self):
1379
# if we try vfs access, return the real branch's vfs transport
1381
return self._real_branch._transport
1383
_transport = property(_get_real_transport)
1386
return "%s(%s)" % (self.__class__.__name__, self.base)
1390
def _ensure_real(self):
1391
"""Ensure that there is a _real_branch set.
1393
Used before calls to self._real_branch.
1395
if self._real_branch is None:
1396
if not vfs.vfs_enabled():
1397
raise AssertionError('smart server vfs must be enabled '
1398
'to use vfs implementation')
1399
self.bzrdir._ensure_real()
1400
self._real_branch = self.bzrdir._real_bzrdir.open_branch()
1401
if self.repository._real_repository is None:
1402
# Give the remote repository the matching real repo.
1403
real_repo = self._real_branch.repository
1404
if isinstance(real_repo, RemoteRepository):
1405
real_repo._ensure_real()
1406
real_repo = real_repo._real_repository
1407
self.repository._set_real_repository(real_repo)
1408
# Give the real branch the remote repository to let fast-pathing
1410
self._real_branch.repository = self.repository
1411
if self._lock_mode == 'r':
1412
self._real_branch.lock_read()
1413
elif self._lock_mode == 'w':
1414
self._real_branch.lock_write(token=self._lock_token)
1416
def _translate_error(self, err, **context):
1417
self.repository._translate_error(err, branch=self, **context)
1419
def _clear_cached_state(self):
1420
super(RemoteBranch, self)._clear_cached_state()
1421
if self._real_branch is not None:
1422
self._real_branch._clear_cached_state()
1424
def _clear_cached_state_of_remote_branch_only(self):
1425
"""Like _clear_cached_state, but doesn't clear the cache of
1428
This is useful when falling back to calling a method of
1429
self._real_branch that changes state. In that case the underlying
1430
branch changes, so we need to invalidate this RemoteBranch's cache of
1431
it. However, there's no need to invalidate the _real_branch's cache
1432
too, in fact doing so might harm performance.
1434
super(RemoteBranch, self)._clear_cached_state()
1437
def control_files(self):
1438
# Defer actually creating RemoteBranchLockableFiles until its needed,
1439
# because it triggers an _ensure_real that we otherwise might not need.
1440
if self._control_files is None:
1441
self._control_files = RemoteBranchLockableFiles(
1442
self.bzrdir, self._client)
1443
return self._control_files
1445
def _get_checkout_format(self):
1447
return self._real_branch._get_checkout_format()
1449
def get_physical_lock_status(self):
1450
"""See Branch.get_physical_lock_status()."""
1451
# should be an API call to the server, as branches must be lockable.
1453
return self._real_branch.get_physical_lock_status()
1455
def get_stacked_on_url(self):
1456
"""Get the URL this branch is stacked against.
1458
:raises NotStacked: If the branch is not stacked.
1459
:raises UnstackableBranchFormat: If the branch does not support
1461
:raises UnstackableRepositoryFormat: If the repository does not support
1465
# there may not be a repository yet, so we can't use
1466
# self._translate_error, so we can't use self._call either.
1467
response = self._client.call('Branch.get_stacked_on_url',
1468
self._remote_path())
1469
except errors.ErrorFromSmartServer, err:
1470
# there may not be a repository yet, so we can't call through
1471
# its _translate_error
1472
_translate_error(err, branch=self)
1473
except errors.UnknownSmartMethod, err:
1475
return self._real_branch.get_stacked_on_url()
1476
if response[0] != 'ok':
1477
raise errors.UnexpectedSmartServerResponse(response)
1480
def lock_read(self):
1481
self.repository.lock_read()
1482
if not self._lock_mode:
1483
self._lock_mode = 'r'
1484
self._lock_count = 1
1485
if self._real_branch is not None:
1486
self._real_branch.lock_read()
1488
self._lock_count += 1
1490
def _remote_lock_write(self, token):
1492
branch_token = repo_token = ''
1494
branch_token = token
1495
repo_token = self.repository.lock_write()
1496
self.repository.unlock()
1497
err_context = {'token': token}
1498
response = self._call(
1499
'Branch.lock_write', self._remote_path(), branch_token,
1500
repo_token or '', **err_context)
1501
if response[0] != 'ok':
1502
raise errors.UnexpectedSmartServerResponse(response)
1503
ok, branch_token, repo_token = response
1504
return branch_token, repo_token
1506
def lock_write(self, token=None):
1507
if not self._lock_mode:
1508
# Lock the branch and repo in one remote call.
1509
remote_tokens = self._remote_lock_write(token)
1510
self._lock_token, self._repo_lock_token = remote_tokens
1511
if not self._lock_token:
1512
raise SmartProtocolError('Remote server did not return a token!')
1513
# Tell the self.repository object that it is locked.
1514
self.repository.lock_write(
1515
self._repo_lock_token, _skip_rpc=True)
1517
if self._real_branch is not None:
1518
self._real_branch.lock_write(token=self._lock_token)
1519
if token is not None:
1520
self._leave_lock = True
1522
self._leave_lock = False
1523
self._lock_mode = 'w'
1524
self._lock_count = 1
1525
elif self._lock_mode == 'r':
1526
raise errors.ReadOnlyTransaction
1528
if token is not None:
1529
# A token was given to lock_write, and we're relocking, so
1530
# check that the given token actually matches the one we
1532
if token != self._lock_token:
1533
raise errors.TokenMismatch(token, self._lock_token)
1534
self._lock_count += 1
1535
# Re-lock the repository too.
1536
self.repository.lock_write(self._repo_lock_token)
1537
return self._lock_token or None
1539
def _unlock(self, branch_token, repo_token):
1540
err_context = {'token': str((branch_token, repo_token))}
1541
response = self._call(
1542
'Branch.unlock', self._remote_path(), branch_token,
1543
repo_token or '', **err_context)
1544
if response == ('ok',):
1546
raise errors.UnexpectedSmartServerResponse(response)
1550
self._lock_count -= 1
1551
if not self._lock_count:
1552
self._clear_cached_state()
1553
mode = self._lock_mode
1554
self._lock_mode = None
1555
if self._real_branch is not None:
1556
if (not self._leave_lock and mode == 'w' and
1557
self._repo_lock_token):
1558
# If this RemoteBranch will remove the physical lock
1559
# for the repository, make sure the _real_branch
1560
# doesn't do it first. (Because the _real_branch's
1561
# repository is set to be the RemoteRepository.)
1562
self._real_branch.repository.leave_lock_in_place()
1563
self._real_branch.unlock()
1565
# Only write-locked branched need to make a remote method
1566
# call to perfom the unlock.
1568
if not self._lock_token:
1569
raise AssertionError('Locked, but no token!')
1570
branch_token = self._lock_token
1571
repo_token = self._repo_lock_token
1572
self._lock_token = None
1573
self._repo_lock_token = None
1574
if not self._leave_lock:
1575
self._unlock(branch_token, repo_token)
1577
self.repository.unlock()
1579
def break_lock(self):
1581
return self._real_branch.break_lock()
1583
def leave_lock_in_place(self):
1584
if not self._lock_token:
1585
raise NotImplementedError(self.leave_lock_in_place)
1586
self._leave_lock = True
1588
def dont_leave_lock_in_place(self):
1589
if not self._lock_token:
1590
raise NotImplementedError(self.dont_leave_lock_in_place)
1591
self._leave_lock = False
1593
def _last_revision_info(self):
1594
response = self._call('Branch.last_revision_info', self._remote_path())
1595
if response[0] != 'ok':
1596
raise SmartProtocolError('unexpected response code %s' % (response,))
1597
revno = int(response[1])
1598
last_revision = response[2]
1599
return (revno, last_revision)
1601
def _gen_revision_history(self):
1602
"""See Branch._gen_revision_history()."""
1603
response_tuple, response_handler = self._call_expecting_body(
1604
'Branch.revision_history', self._remote_path())
1605
if response_tuple[0] != 'ok':
1606
raise errors.UnexpectedSmartServerResponse(response_tuple)
1607
result = response_handler.read_body_bytes().split('\x00')
1612
def _remote_path(self):
1613
return self.bzrdir._path_for_remote_call(self._client)
1615
def _set_last_revision_descendant(self, revision_id, other_branch,
1616
allow_diverged=False, allow_overwrite_descendant=False):
1617
# This performs additional work to meet the hook contract; while its
1618
# undesirable, we have to synthesise the revno to call the hook, and
1619
# not calling the hook is worse as it means changes can't be prevented.
1620
# Having calculated this though, we can't just call into
1621
# set_last_revision_info as a simple call, because there is a set_rh
1622
# hook that some folk may still be using.
1623
old_revno, old_revid = self.last_revision_info()
1624
history = self._lefthand_history(revision_id)
1625
self._run_pre_change_branch_tip_hooks(len(history), revision_id)
1626
err_context = {'other_branch': other_branch}
1627
response = self._call('Branch.set_last_revision_ex',
1628
self._remote_path(), self._lock_token, self._repo_lock_token,
1629
revision_id, int(allow_diverged), int(allow_overwrite_descendant),
1631
self._clear_cached_state()
1632
if len(response) != 3 and response[0] != 'ok':
1633
raise errors.UnexpectedSmartServerResponse(response)
1634
new_revno, new_revision_id = response[1:]
1635
self._last_revision_info_cache = new_revno, new_revision_id
1636
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1637
if self._real_branch is not None:
1638
cache = new_revno, new_revision_id
1639
self._real_branch._last_revision_info_cache = cache
1641
def _set_last_revision(self, revision_id):
1642
old_revno, old_revid = self.last_revision_info()
1643
# This performs additional work to meet the hook contract; while its
1644
# undesirable, we have to synthesise the revno to call the hook, and
1645
# not calling the hook is worse as it means changes can't be prevented.
1646
# Having calculated this though, we can't just call into
1647
# set_last_revision_info as a simple call, because there is a set_rh
1648
# hook that some folk may still be using.
1649
history = self._lefthand_history(revision_id)
1650
self._run_pre_change_branch_tip_hooks(len(history), revision_id)
1651
self._clear_cached_state()
1652
response = self._call('Branch.set_last_revision',
1653
self._remote_path(), self._lock_token, self._repo_lock_token,
1655
if response != ('ok',):
1656
raise errors.UnexpectedSmartServerResponse(response)
1657
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1660
def set_revision_history(self, rev_history):
1661
# Send just the tip revision of the history; the server will generate
1662
# the full history from that. If the revision doesn't exist in this
1663
# branch, NoSuchRevision will be raised.
1664
if rev_history == []:
1667
rev_id = rev_history[-1]
1668
self._set_last_revision(rev_id)
1669
for hook in branch.Branch.hooks['set_rh']:
1670
hook(self, rev_history)
1671
self._cache_revision_history(rev_history)
1673
def get_parent(self):
1675
return self._real_branch.get_parent()
1677
def _get_parent_location(self):
1678
# Used by tests, when checking normalisation of given vs stored paths.
1680
return self._real_branch._get_parent_location()
1682
def set_parent(self, url):
1684
return self._real_branch.set_parent(url)
1686
def _set_parent_location(self, url):
1687
# Used by tests, to poke bad urls into branch configurations
1689
self.set_parent(url)
1692
return self._real_branch._set_parent_location(url)
1694
def set_stacked_on_url(self, stacked_location):
1695
"""Set the URL this branch is stacked against.
1697
:raises UnstackableBranchFormat: If the branch does not support
1699
:raises UnstackableRepositoryFormat: If the repository does not support
1703
return self._real_branch.set_stacked_on_url(stacked_location)
1705
def sprout(self, to_bzrdir, revision_id=None):
1706
branch_format = to_bzrdir._format._branch_format
1707
if (branch_format is None or
1708
isinstance(branch_format, RemoteBranchFormat)):
1709
# The to_bzrdir specifies RemoteBranchFormat (or no format, which
1710
# implies the same thing), but RemoteBranches can't be created at
1711
# arbitrary URLs. So create a branch in the same format as
1712
# _real_branch instead.
1713
# XXX: if to_bzrdir is a RemoteBzrDir, this should perhaps do
1714
# to_bzrdir.create_branch to create a RemoteBranch after all...
1716
result = self._real_branch._format.initialize(to_bzrdir)
1717
self.copy_content_into(result, revision_id=revision_id)
1718
result.set_parent(self.bzrdir.root_transport.base)
1720
result = branch.Branch.sprout(
1721
self, to_bzrdir, revision_id=revision_id)
1725
def pull(self, source, overwrite=False, stop_revision=None,
1727
self._clear_cached_state_of_remote_branch_only()
1729
return self._real_branch.pull(
1730
source, overwrite=overwrite, stop_revision=stop_revision,
1731
_override_hook_target=self, **kwargs)
1734
def push(self, target, overwrite=False, stop_revision=None):
1736
return self._real_branch.push(
1737
target, overwrite=overwrite, stop_revision=stop_revision,
1738
_override_hook_source_branch=self)
1740
def is_locked(self):
1741
return self._lock_count >= 1
1744
def revision_id_to_revno(self, revision_id):
1746
return self._real_branch.revision_id_to_revno(revision_id)
1749
def set_last_revision_info(self, revno, revision_id):
1750
# XXX: These should be returned by the set_last_revision_info verb
1751
old_revno, old_revid = self.last_revision_info()
1752
self._run_pre_change_branch_tip_hooks(revno, revision_id)
1753
revision_id = ensure_null(revision_id)
1755
response = self._call('Branch.set_last_revision_info',
1756
self._remote_path(), self._lock_token, self._repo_lock_token,
1757
str(revno), revision_id)
1758
except errors.UnknownSmartMethod:
1760
self._clear_cached_state_of_remote_branch_only()
1761
self._real_branch.set_last_revision_info(revno, revision_id)
1762
self._last_revision_info_cache = revno, revision_id
1764
if response == ('ok',):
1765
self._clear_cached_state()
1766
self._last_revision_info_cache = revno, revision_id
1767
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1768
# Update the _real_branch's cache too.
1769
if self._real_branch is not None:
1770
cache = self._last_revision_info_cache
1771
self._real_branch._last_revision_info_cache = cache
1773
raise errors.UnexpectedSmartServerResponse(response)
1776
def generate_revision_history(self, revision_id, last_rev=None,
1778
medium = self._client._medium
1779
if not medium._is_remote_before((1, 6)):
1780
# Use a smart method for 1.6 and above servers
1782
self._set_last_revision_descendant(revision_id, other_branch,
1783
allow_diverged=True, allow_overwrite_descendant=True)
1785
except errors.UnknownSmartMethod:
1786
medium._remember_remote_is_before((1, 6))
1787
self._clear_cached_state_of_remote_branch_only()
1788
self.set_revision_history(self._lefthand_history(revision_id,
1789
last_rev=last_rev,other_branch=other_branch))
1794
return self._real_branch.tags
1796
def set_push_location(self, location):
1798
return self._real_branch.set_push_location(location)
1801
def update_revisions(self, other, stop_revision=None, overwrite=False,
1803
"""See Branch.update_revisions."""
1806
if stop_revision is None:
1807
stop_revision = other.last_revision()
1808
if revision.is_null(stop_revision):
1809
# if there are no commits, we're done.
1811
self.fetch(other, stop_revision)
1814
# Just unconditionally set the new revision. We don't care if
1815
# the branches have diverged.
1816
self._set_last_revision(stop_revision)
1818
medium = self._client._medium
1819
if not medium._is_remote_before((1, 6)):
1821
self._set_last_revision_descendant(stop_revision, other)
1823
except errors.UnknownSmartMethod:
1824
medium._remember_remote_is_before((1, 6))
1825
# Fallback for pre-1.6 servers: check for divergence
1826
# client-side, then do _set_last_revision.
1827
last_rev = revision.ensure_null(self.last_revision())
1829
graph = self.repository.get_graph()
1830
if self._check_if_descendant_or_diverged(
1831
stop_revision, last_rev, graph, other):
1832
# stop_revision is a descendant of last_rev, but we aren't
1833
# overwriting, so we're done.
1835
self._set_last_revision(stop_revision)
1840
def _extract_tar(tar, to_dir):
1841
"""Extract all the contents of a tarfile object.
1843
A replacement for extractall, which is not present in python2.4
1846
tar.extract(tarinfo, to_dir)
1849
def _translate_error(err, **context):
1850
"""Translate an ErrorFromSmartServer into a more useful error.
1852
Possible context keys:
1860
If the error from the server doesn't match a known pattern, then
1861
UnknownErrorFromSmartServer is raised.
1865
return context[name]
1866
except KeyError, key_err:
1867
mutter('Missing key %r in context %r', key_err.args[0], context)
1870
"""Get the path from the context if present, otherwise use first error
1874
return context['path']
1875
except KeyError, key_err:
1877
return err.error_args[0]
1878
except IndexError, idx_err:
1880
'Missing key %r in context %r', key_err.args[0], context)
1883
if err.error_verb == 'NoSuchRevision':
1884
raise NoSuchRevision(find('branch'), err.error_args[0])
1885
elif err.error_verb == 'nosuchrevision':
1886
raise NoSuchRevision(find('repository'), err.error_args[0])
1887
elif err.error_tuple == ('nobranch',):
1888
raise errors.NotBranchError(path=find('bzrdir').root_transport.base)
1889
elif err.error_verb == 'norepository':
1890
raise errors.NoRepositoryPresent(find('bzrdir'))
1891
elif err.error_verb == 'LockContention':
1892
raise errors.LockContention('(remote lock)')
1893
elif err.error_verb == 'UnlockableTransport':
1894
raise errors.UnlockableTransport(find('bzrdir').root_transport)
1895
elif err.error_verb == 'LockFailed':
1896
raise errors.LockFailed(err.error_args[0], err.error_args[1])
1897
elif err.error_verb == 'TokenMismatch':
1898
raise errors.TokenMismatch(find('token'), '(remote token)')
1899
elif err.error_verb == 'Diverged':
1900
raise errors.DivergedBranches(find('branch'), find('other_branch'))
1901
elif err.error_verb == 'TipChangeRejected':
1902
raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
1903
elif err.error_verb == 'UnstackableBranchFormat':
1904
raise errors.UnstackableBranchFormat(*err.error_args)
1905
elif err.error_verb == 'UnstackableRepositoryFormat':
1906
raise errors.UnstackableRepositoryFormat(*err.error_args)
1907
elif err.error_verb == 'NotStacked':
1908
raise errors.NotStacked(branch=find('branch'))
1909
elif err.error_verb == 'PermissionDenied':
1911
if len(err.error_args) >= 2:
1912
extra = err.error_args[1]
1915
raise errors.PermissionDenied(path, extra=extra)
1916
elif err.error_verb == 'ReadError':
1918
raise errors.ReadError(path)
1919
elif err.error_verb == 'NoSuchFile':
1921
raise errors.NoSuchFile(path)
1922
elif err.error_verb == 'FileExists':
1923
raise errors.FileExists(err.error_args[0])
1924
elif err.error_verb == 'DirectoryNotEmpty':
1925
raise errors.DirectoryNotEmpty(err.error_args[0])
1926
elif err.error_verb == 'ShortReadvError':
1927
args = err.error_args
1928
raise errors.ShortReadvError(
1929
args[0], int(args[1]), int(args[2]), int(args[3]))
1930
elif err.error_verb in ('UnicodeEncodeError', 'UnicodeDecodeError'):
1931
encoding = str(err.error_args[0]) # encoding must always be a string
1932
val = err.error_args[1]
1933
start = int(err.error_args[2])
1934
end = int(err.error_args[3])
1935
reason = str(err.error_args[4]) # reason must always be a string
1936
if val.startswith('u:'):
1937
val = val[2:].decode('utf-8')
1938
elif val.startswith('s:'):
1939
val = val[2:].decode('base64')
1940
if err.error_verb == 'UnicodeDecodeError':
1941
raise UnicodeDecodeError(encoding, val, start, end, reason)
1942
elif err.error_verb == 'UnicodeEncodeError':
1943
raise UnicodeEncodeError(encoding, val, start, end, reason)
1944
elif err.error_verb == 'ReadOnlyError':
1945
raise errors.TransportNotPossible('readonly transport')
1946
raise errors.UnknownErrorFromSmartServer(err)
added
removed
bzrlib/remote.py
