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
44
from bzrlib.revision import ensure_null, NULL_REVISION
45
from bzrlib.trace import mutter, note, warning
46
from bzrlib.versionedfile import record_to_fulltext_bytes
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)
72
# Note: RemoteBzrDirFormat is in bzrdir.py
74
class RemoteBzrDir(BzrDir, _RpcHelper):
75
"""Control directory on a remote server, accessed via bzr:// or similar."""
77
def __init__(self, transport, format, _client=None):
78
"""Construct a RemoteBzrDir.
80
:param _client: Private parameter for testing. Disables probing and the
83
BzrDir.__init__(self, transport, format)
84
# this object holds a delegated bzrdir that uses file-level operations
85
# to talk to the other side
86
self._real_bzrdir = None
89
medium = transport.get_smart_medium()
90
self._client = client._SmartClient(medium)
92
self._client = _client
95
path = self._path_for_remote_call(self._client)
96
response = self._call('BzrDir.open', path)
97
if response not in [('yes',), ('no',)]:
98
raise errors.UnexpectedSmartServerResponse(response)
99
if response == ('no',):
100
raise errors.NotBranchError(path=transport.base)
102
def _ensure_real(self):
103
"""Ensure that there is a _real_bzrdir set.
105
Used before calls to self._real_bzrdir.
107
if not self._real_bzrdir:
108
self._real_bzrdir = BzrDir.open_from_transport(
109
self.root_transport, _server_formats=False)
111
def _translate_error(self, err, **context):
112
_translate_error(err, bzrdir=self, **context)
114
def cloning_metadir(self, stacked=False):
116
return self._real_bzrdir.cloning_metadir(stacked)
118
def create_repository(self, shared=False):
119
# as per meta1 formats - just delegate to the format object which may
121
result = self._format.repository_format.initialize(self, shared)
122
if not isinstance(result, RemoteRepository):
123
return self.open_repository()
127
def destroy_repository(self):
128
"""See BzrDir.destroy_repository"""
130
self._real_bzrdir.destroy_repository()
132
def create_branch(self):
133
# as per meta1 formats - just delegate to the format object which may
135
real_branch = self._format.get_branch_format().initialize(self)
136
if not isinstance(real_branch, RemoteBranch):
137
return RemoteBranch(self, self.find_repository(), real_branch)
141
def destroy_branch(self):
142
"""See BzrDir.destroy_branch"""
144
self._real_bzrdir.destroy_branch()
146
def create_workingtree(self, revision_id=None, from_branch=None):
147
raise errors.NotLocalUrl(self.transport.base)
149
def find_branch_format(self):
150
"""Find the branch 'format' for this bzrdir.
152
This might be a synthetic object for e.g. RemoteBranch and SVN.
154
b = self.open_branch()
157
def get_branch_reference(self):
158
"""See BzrDir.get_branch_reference()."""
159
path = self._path_for_remote_call(self._client)
160
response = self._call('BzrDir.open_branch', path)
161
if response[0] == 'ok':
162
if response[1] == '':
163
# branch at this location.
166
# a branch reference, use the existing BranchReference logic.
169
raise errors.UnexpectedSmartServerResponse(response)
171
def _get_tree_branch(self):
172
"""See BzrDir._get_tree_branch()."""
173
return None, self.open_branch()
175
def open_branch(self, _unsupported=False):
177
raise NotImplementedError('unsupported flag support not implemented yet.')
178
reference_url = self.get_branch_reference()
179
if reference_url is None:
180
# branch at this location.
181
return RemoteBranch(self, self.find_repository())
183
# a branch reference, use the existing BranchReference logic.
184
format = BranchReferenceFormat()
185
return format.open(self, _found=True, location=reference_url)
187
def open_repository(self):
188
path = self._path_for_remote_call(self._client)
189
verb = 'BzrDir.find_repositoryV2'
191
response = self._call(verb, path)
192
except errors.UnknownSmartMethod:
193
verb = 'BzrDir.find_repository'
194
response = self._call(verb, path)
195
if response[0] != 'ok':
196
raise errors.UnexpectedSmartServerResponse(response)
197
if verb == 'BzrDir.find_repository':
198
# servers that don't support the V2 method don't support external
200
response = response + ('no', )
201
if not (len(response) == 5):
202
raise SmartProtocolError('incorrect response length %s' % (response,))
203
if response[1] == '':
204
format = RemoteRepositoryFormat()
205
format.rich_root_data = (response[2] == 'yes')
206
format.supports_tree_reference = (response[3] == 'yes')
207
# No wire format to check this yet.
208
format.supports_external_lookups = (response[4] == 'yes')
209
# Used to support creating a real format instance when needed.
210
format._creating_bzrdir = self
211
remote_repo = RemoteRepository(self, format)
212
format._creating_repo = remote_repo
215
raise errors.NoRepositoryPresent(self)
217
def open_workingtree(self, recommend_upgrade=True):
219
if self._real_bzrdir.has_workingtree():
220
raise errors.NotLocalUrl(self.root_transport)
222
raise errors.NoWorkingTree(self.root_transport.base)
224
def _path_for_remote_call(self, client):
225
"""Return the path to be used for this bzrdir in a remote call."""
226
return client.remote_path_from_transport(self.root_transport)
228
def get_branch_transport(self, branch_format):
230
return self._real_bzrdir.get_branch_transport(branch_format)
232
def get_repository_transport(self, repository_format):
234
return self._real_bzrdir.get_repository_transport(repository_format)
236
def get_workingtree_transport(self, workingtree_format):
238
return self._real_bzrdir.get_workingtree_transport(workingtree_format)
240
def can_convert_format(self):
241
"""Upgrading of remote bzrdirs is not supported yet."""
244
def needs_format_conversion(self, format=None):
245
"""Upgrading of remote bzrdirs is not supported yet."""
247
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
248
% 'needs_format_conversion(format=None)')
251
def clone(self, url, revision_id=None, force_new_repo=False,
252
preserve_stacking=False):
254
return self._real_bzrdir.clone(url, revision_id=revision_id,
255
force_new_repo=force_new_repo, preserve_stacking=preserve_stacking)
257
def get_config(self):
259
return self._real_bzrdir.get_config()
262
class RemoteRepositoryFormat(repository.RepositoryFormat):
263
"""Format for repositories accessed over a _SmartClient.
265
Instances of this repository are represented by RemoteRepository
268
The RemoteRepositoryFormat is parameterized during construction
269
to reflect the capabilities of the real, remote format. Specifically
270
the attributes rich_root_data and supports_tree_reference are set
271
on a per instance basis, and are not set (and should not be) at
274
:ivar _custom_format: If set, a specific concrete repository format that
275
will be used when initializing a repository with this
276
RemoteRepositoryFormat.
277
:ivar _creating_repo: If set, the repository object that this
278
RemoteRepositoryFormat was created for: it can be called into
279
to obtain data like the network name.
282
_matchingbzrdir = RemoteBzrDirFormat()
285
repository.RepositoryFormat.__init__(self)
286
self._custom_format = None
287
self._network_name = None
288
self._creating_bzrdir = None
290
def _vfs_initialize(self, a_bzrdir, shared):
291
"""Helper for common code in initialize."""
292
if self._custom_format:
293
# Custom format requested
294
result = self._custom_format.initialize(a_bzrdir, shared=shared)
295
elif self._creating_bzrdir is not None:
296
# Use the format that the repository we were created to back
298
prior_repo = self._creating_bzrdir.open_repository()
299
prior_repo._ensure_real()
300
result = prior_repo._real_repository._format.initialize(
301
a_bzrdir, shared=shared)
303
# assume that a_bzr is a RemoteBzrDir but the smart server didn't
304
# support remote initialization.
305
# We delegate to a real object at this point (as RemoteBzrDir
306
# delegate to the repository format which would lead to infinite
307
# recursion if we just called a_bzrdir.create_repository.
308
a_bzrdir._ensure_real()
309
result = a_bzrdir._real_bzrdir.create_repository(shared=shared)
310
if not isinstance(result, RemoteRepository):
311
return self.open(a_bzrdir)
315
def initialize(self, a_bzrdir, shared=False):
316
# Being asked to create on a non RemoteBzrDir:
317
if not isinstance(a_bzrdir, RemoteBzrDir):
318
return self._vfs_initialize(a_bzrdir, shared)
319
medium = a_bzrdir._client._medium
320
if medium._is_remote_before((1, 13)):
321
return self._vfs_initialize(a_bzrdir, shared)
322
# Creating on a remote bzr dir.
323
# 1) get the network name to use.
324
if self._custom_format:
325
network_name = self._custom_format.network_name()
327
# Select the current bzrlib default and ask for that.
328
reference_bzrdir_format = bzrdir.format_registry.get('default')()
329
reference_format = reference_bzrdir_format.repository_format
330
network_name = reference_format.network_name()
331
# 2) try direct creation via RPC
332
path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
333
verb = 'BzrDir.create_repository'
339
response = a_bzrdir._call(verb, path, network_name, shared_str)
340
except errors.UnknownSmartMethod:
341
# Fallback - use vfs methods
342
return self._vfs_initialize(a_bzrdir, shared)
344
# Turn the response into a RemoteRepository object.
345
format = RemoteRepositoryFormat()
346
format.rich_root_data = (response[1] == 'yes')
347
format.supports_tree_reference = (response[2] == 'yes')
348
format.supports_external_lookups = (response[3] == 'yes')
349
format._network_name = response[4]
350
# Used to support creating a real format instance when needed.
351
format._creating_bzrdir = a_bzrdir
352
remote_repo = RemoteRepository(a_bzrdir, format)
353
format._creating_repo = remote_repo
356
def open(self, a_bzrdir):
357
if not isinstance(a_bzrdir, RemoteBzrDir):
358
raise AssertionError('%r is not a RemoteBzrDir' % (a_bzrdir,))
359
return a_bzrdir.open_repository()
361
def get_format_description(self):
362
return 'bzr remote repository'
364
def __eq__(self, other):
365
return self.__class__ == other.__class__
367
def check_conversion_target(self, target_format):
368
if self.rich_root_data and not target_format.rich_root_data:
369
raise errors.BadConversionTarget(
370
'Does not support rich root data.', target_format)
371
if (self.supports_tree_reference and
372
not getattr(target_format, 'supports_tree_reference', False)):
373
raise errors.BadConversionTarget(
374
'Does not support nested trees', target_format)
376
def network_name(self):
377
if self._network_name:
378
return self._network_name
379
self._creating_repo._ensure_real()
380
return self._creating_repo._real_repository._format.network_name()
383
def _serializer(self):
384
# We should only be getting asked for the serializer for
385
# RemoteRepositoryFormat objects when the RemoteRepositoryFormat object
386
# is a concrete instance for a RemoteRepository. In this case we know
387
# the creating_repo and can use it to supply the serializer.
388
self._creating_repo._ensure_real()
389
return self._creating_repo._real_repository._format._serializer
392
class RemoteRepository(_RpcHelper):
393
"""Repository accessed over rpc.
395
For the moment most operations are performed using local transport-backed
399
def __init__(self, remote_bzrdir, format, real_repository=None, _client=None):
400
"""Create a RemoteRepository instance.
402
:param remote_bzrdir: The bzrdir hosting this repository.
403
:param format: The RemoteFormat object to use.
404
:param real_repository: If not None, a local implementation of the
405
repository logic for the repository, usually accessing the data
407
:param _client: Private testing parameter - override the smart client
408
to be used by the repository.
411
self._real_repository = real_repository
413
self._real_repository = None
414
self.bzrdir = remote_bzrdir
416
self._client = remote_bzrdir._client
418
self._client = _client
419
self._format = format
420
self._lock_mode = None
421
self._lock_token = None
423
self._leave_lock = False
424
self._unstacked_provider = graph.CachingParentsProvider(
425
get_parent_map=self._get_parent_map_rpc)
426
self._unstacked_provider.disable_cache()
428
# These depend on the actual remote format, so force them off for
429
# maximum compatibility. XXX: In future these should depend on the
430
# remote repository instance, but this is irrelevant until we perform
431
# reconcile via an RPC call.
432
self._reconcile_does_inventory_gc = False
433
self._reconcile_fixes_text_parents = False
434
self._reconcile_backsup_inventory = False
435
self.base = self.bzrdir.transport.base
436
# Additional places to query for data.
437
self._fallback_repositories = []
440
return "%s(%s)" % (self.__class__.__name__, self.base)
444
def abort_write_group(self, suppress_errors=False):
445
"""Complete a write group on the decorated repository.
447
Smart methods peform operations in a single step so this api
448
is not really applicable except as a compatibility thunk
449
for older plugins that don't use e.g. the CommitBuilder
452
:param suppress_errors: see Repository.abort_write_group.
455
return self._real_repository.abort_write_group(
456
suppress_errors=suppress_errors)
458
def commit_write_group(self):
459
"""Complete a write group on the decorated repository.
461
Smart methods peform operations in a single step so this api
462
is not really applicable except as a compatibility thunk
463
for older plugins that don't use e.g. the CommitBuilder
467
return self._real_repository.commit_write_group()
469
def _ensure_real(self):
470
"""Ensure that there is a _real_repository set.
472
Used before calls to self._real_repository.
474
if self._real_repository is None:
475
self.bzrdir._ensure_real()
476
self._set_real_repository(
477
self.bzrdir._real_bzrdir.open_repository())
479
def _translate_error(self, err, **context):
480
self.bzrdir._translate_error(err, repository=self, **context)
482
def find_text_key_references(self):
483
"""Find the text key references within the repository.
485
:return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
486
revision_ids. Each altered file-ids has the exact revision_ids that
487
altered it listed explicitly.
488
:return: A dictionary mapping text keys ((fileid, revision_id) tuples)
489
to whether they were referred to by the inventory of the
490
revision_id that they contain. The inventory texts from all present
491
revision ids are assessed to generate this report.
494
return self._real_repository.find_text_key_references()
496
def _generate_text_key_index(self):
497
"""Generate a new text key index for the repository.
499
This is an expensive function that will take considerable time to run.
501
:return: A dict mapping (file_id, revision_id) tuples to a list of
502
parents, also (file_id, revision_id) tuples.
505
return self._real_repository._generate_text_key_index()
507
@symbol_versioning.deprecated_method(symbol_versioning.one_four)
508
def get_revision_graph(self, revision_id=None):
509
"""See Repository.get_revision_graph()."""
510
return self._get_revision_graph(revision_id)
512
def _get_revision_graph(self, revision_id):
513
"""Private method for using with old (< 1.2) servers to fallback."""
514
if revision_id is None:
516
elif revision.is_null(revision_id):
519
path = self.bzrdir._path_for_remote_call(self._client)
520
response = self._call_expecting_body(
521
'Repository.get_revision_graph', path, revision_id)
522
response_tuple, response_handler = response
523
if response_tuple[0] != 'ok':
524
raise errors.UnexpectedSmartServerResponse(response_tuple)
525
coded = response_handler.read_body_bytes()
527
# no revisions in this repository!
529
lines = coded.split('\n')
532
d = tuple(line.split())
533
revision_graph[d[0]] = d[1:]
535
return revision_graph
538
"""See Repository._get_sink()."""
539
return RemoteStreamSink(self)
541
def has_revision(self, revision_id):
542
"""See Repository.has_revision()."""
543
if revision_id == NULL_REVISION:
544
# The null revision is always present.
546
path = self.bzrdir._path_for_remote_call(self._client)
547
response = self._call('Repository.has_revision', path, revision_id)
548
if response[0] not in ('yes', 'no'):
549
raise errors.UnexpectedSmartServerResponse(response)
550
if response[0] == 'yes':
552
for fallback_repo in self._fallback_repositories:
553
if fallback_repo.has_revision(revision_id):
557
def has_revisions(self, revision_ids):
558
"""See Repository.has_revisions()."""
559
# FIXME: This does many roundtrips, particularly when there are
560
# fallback repositories. -- mbp 20080905
562
for revision_id in revision_ids:
563
if self.has_revision(revision_id):
564
result.add(revision_id)
567
def has_same_location(self, other):
568
return (self.__class__ == other.__class__ and
569
self.bzrdir.transport.base == other.bzrdir.transport.base)
571
def get_graph(self, other_repository=None):
572
"""Return the graph for this repository format"""
573
parents_provider = self._make_parents_provider(other_repository)
574
return graph.Graph(parents_provider)
576
def gather_stats(self, revid=None, committers=None):
577
"""See Repository.gather_stats()."""
578
path = self.bzrdir._path_for_remote_call(self._client)
579
# revid can be None to indicate no revisions, not just NULL_REVISION
580
if revid is None or revision.is_null(revid):
584
if committers is None or not committers:
585
fmt_committers = 'no'
587
fmt_committers = 'yes'
588
response_tuple, response_handler = self._call_expecting_body(
589
'Repository.gather_stats', path, fmt_revid, fmt_committers)
590
if response_tuple[0] != 'ok':
591
raise errors.UnexpectedSmartServerResponse(response_tuple)
593
body = response_handler.read_body_bytes()
595
for line in body.split('\n'):
598
key, val_text = line.split(':')
599
if key in ('revisions', 'size', 'committers'):
600
result[key] = int(val_text)
601
elif key in ('firstrev', 'latestrev'):
602
values = val_text.split(' ')[1:]
603
result[key] = (float(values[0]), long(values[1]))
607
def find_branches(self, using=False):
608
"""See Repository.find_branches()."""
609
# should be an API call to the server.
611
return self._real_repository.find_branches(using=using)
613
def get_physical_lock_status(self):
614
"""See Repository.get_physical_lock_status()."""
615
# should be an API call to the server.
617
return self._real_repository.get_physical_lock_status()
619
def is_in_write_group(self):
620
"""Return True if there is an open write group.
622
write groups are only applicable locally for the smart server..
624
if self._real_repository:
625
return self._real_repository.is_in_write_group()
628
return self._lock_count >= 1
631
"""See Repository.is_shared()."""
632
path = self.bzrdir._path_for_remote_call(self._client)
633
response = self._call('Repository.is_shared', path)
634
if response[0] not in ('yes', 'no'):
635
raise SmartProtocolError('unexpected response code %s' % (response,))
636
return response[0] == 'yes'
638
def is_write_locked(self):
639
return self._lock_mode == 'w'
642
# wrong eventually - want a local lock cache context
643
if not self._lock_mode:
644
self._lock_mode = 'r'
646
self._unstacked_provider.enable_cache(cache_misses=False)
647
if self._real_repository is not None:
648
self._real_repository.lock_read()
650
self._lock_count += 1
652
def _remote_lock_write(self, token):
653
path = self.bzrdir._path_for_remote_call(self._client)
656
err_context = {'token': token}
657
response = self._call('Repository.lock_write', path, token,
659
if response[0] == 'ok':
663
raise errors.UnexpectedSmartServerResponse(response)
665
def lock_write(self, token=None, _skip_rpc=False):
666
if not self._lock_mode:
668
if self._lock_token is not None:
669
if token != self._lock_token:
670
raise errors.TokenMismatch(token, self._lock_token)
671
self._lock_token = token
673
self._lock_token = self._remote_lock_write(token)
674
# if self._lock_token is None, then this is something like packs or
675
# svn where we don't get to lock the repo, or a weave style repository
676
# where we cannot lock it over the wire and attempts to do so will
678
if self._real_repository is not None:
679
self._real_repository.lock_write(token=self._lock_token)
680
if token is not None:
681
self._leave_lock = True
683
self._leave_lock = False
684
self._lock_mode = 'w'
686
self._unstacked_provider.enable_cache(cache_misses=False)
687
elif self._lock_mode == 'r':
688
raise errors.ReadOnlyError(self)
690
self._lock_count += 1
691
return self._lock_token or None
693
def leave_lock_in_place(self):
694
if not self._lock_token:
695
raise NotImplementedError(self.leave_lock_in_place)
696
self._leave_lock = True
698
def dont_leave_lock_in_place(self):
699
if not self._lock_token:
700
raise NotImplementedError(self.dont_leave_lock_in_place)
701
self._leave_lock = False
703
def _set_real_repository(self, repository):
704
"""Set the _real_repository for this repository.
706
:param repository: The repository to fallback to for non-hpss
707
implemented operations.
709
if self._real_repository is not None:
710
raise AssertionError('_real_repository is already set')
711
if isinstance(repository, RemoteRepository):
712
raise AssertionError()
713
self._real_repository = repository
714
for fb in self._fallback_repositories:
715
self._real_repository.add_fallback_repository(fb)
716
if self._lock_mode == 'w':
717
# if we are already locked, the real repository must be able to
718
# acquire the lock with our token.
719
self._real_repository.lock_write(self._lock_token)
720
elif self._lock_mode == 'r':
721
self._real_repository.lock_read()
723
def start_write_group(self):
724
"""Start a write group on the decorated repository.
726
Smart methods peform operations in a single step so this api
727
is not really applicable except as a compatibility thunk
728
for older plugins that don't use e.g. the CommitBuilder
732
return self._real_repository.start_write_group()
734
def _unlock(self, token):
735
path = self.bzrdir._path_for_remote_call(self._client)
737
# with no token the remote repository is not persistently locked.
739
err_context = {'token': token}
740
response = self._call('Repository.unlock', path, token,
742
if response == ('ok',):
745
raise errors.UnexpectedSmartServerResponse(response)
748
self._lock_count -= 1
749
if self._lock_count > 0:
751
self._unstacked_provider.disable_cache()
752
old_mode = self._lock_mode
753
self._lock_mode = None
755
# The real repository is responsible at present for raising an
756
# exception if it's in an unfinished write group. However, it
757
# normally will *not* actually remove the lock from disk - that's
758
# done by the server on receiving the Repository.unlock call.
759
# This is just to let the _real_repository stay up to date.
760
if self._real_repository is not None:
761
self._real_repository.unlock()
763
# The rpc-level lock should be released even if there was a
764
# problem releasing the vfs-based lock.
766
# Only write-locked repositories need to make a remote method
767
# call to perfom the unlock.
768
old_token = self._lock_token
769
self._lock_token = None
770
if not self._leave_lock:
771
self._unlock(old_token)
773
def break_lock(self):
774
# should hand off to the network
776
return self._real_repository.break_lock()
778
def _get_tarball(self, compression):
779
"""Return a TemporaryFile containing a repository tarball.
781
Returns None if the server does not support sending tarballs.
784
path = self.bzrdir._path_for_remote_call(self._client)
786
response, protocol = self._call_expecting_body(
787
'Repository.tarball', path, compression)
788
except errors.UnknownSmartMethod:
789
protocol.cancel_read_body()
791
if response[0] == 'ok':
792
# Extract the tarball and return it
793
t = tempfile.NamedTemporaryFile()
794
# TODO: rpc layer should read directly into it...
795
t.write(protocol.read_body_bytes())
798
raise errors.UnexpectedSmartServerResponse(response)
800
def sprout(self, to_bzrdir, revision_id=None):
801
# TODO: Option to control what format is created?
803
dest_repo = self._real_repository._format.initialize(to_bzrdir,
805
dest_repo.fetch(self, revision_id=revision_id)
808
### These methods are just thin shims to the VFS object for now.
810
def revision_tree(self, revision_id):
812
return self._real_repository.revision_tree(revision_id)
814
def get_serializer_format(self):
816
return self._real_repository.get_serializer_format()
818
def get_commit_builder(self, branch, parents, config, timestamp=None,
819
timezone=None, committer=None, revprops=None,
821
# FIXME: It ought to be possible to call this without immediately
822
# triggering _ensure_real. For now it's the easiest thing to do.
824
real_repo = self._real_repository
825
builder = real_repo.get_commit_builder(branch, parents,
826
config, timestamp=timestamp, timezone=timezone,
827
committer=committer, revprops=revprops, revision_id=revision_id)
830
def add_fallback_repository(self, repository):
831
"""Add a repository to use for looking up data not held locally.
833
:param repository: A repository.
835
# XXX: At the moment the RemoteRepository will allow fallbacks
836
# unconditionally - however, a _real_repository will usually exist,
837
# and may raise an error if it's not accommodated by the underlying
838
# format. Eventually we should check when opening the repository
839
# whether it's willing to allow them or not.
841
# We need to accumulate additional repositories here, to pass them in
843
self._fallback_repositories.append(repository)
844
# They are also seen by the fallback repository. If it doesn't exist
845
# yet they'll be added then. This implicitly copies them.
848
def add_inventory(self, revid, inv, parents):
850
return self._real_repository.add_inventory(revid, inv, parents)
852
def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
855
return self._real_repository.add_inventory_by_delta(basis_revision_id,
856
delta, new_revision_id, parents)
858
def add_revision(self, rev_id, rev, inv=None, config=None):
860
return self._real_repository.add_revision(
861
rev_id, rev, inv=inv, config=config)
864
def get_inventory(self, revision_id):
866
return self._real_repository.get_inventory(revision_id)
868
def iter_inventories(self, revision_ids):
870
return self._real_repository.iter_inventories(revision_ids)
873
def get_revision(self, revision_id):
875
return self._real_repository.get_revision(revision_id)
877
def get_transaction(self):
879
return self._real_repository.get_transaction()
882
def clone(self, a_bzrdir, revision_id=None):
884
return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
886
def make_working_trees(self):
887
"""See Repository.make_working_trees"""
889
return self._real_repository.make_working_trees()
891
def revision_ids_to_search_result(self, result_set):
892
"""Convert a set of revision ids to a graph SearchResult."""
893
result_parents = set()
894
for parents in self.get_graph().get_parent_map(
895
result_set).itervalues():
896
result_parents.update(parents)
897
included_keys = result_set.intersection(result_parents)
898
start_keys = result_set.difference(included_keys)
899
exclude_keys = result_parents.difference(result_set)
900
result = graph.SearchResult(start_keys, exclude_keys,
901
len(result_set), result_set)
905
def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
906
"""Return the revision ids that other has that this does not.
908
These are returned in topological order.
910
revision_id: only return revision ids included by revision_id.
912
return repository.InterRepository.get(
913
other, self).search_missing_revision_ids(revision_id, find_ghosts)
915
def fetch(self, source, revision_id=None, pb=None, find_ghosts=False):
916
# Not delegated to _real_repository so that InterRepository.get has a
917
# chance to find an InterRepository specialised for RemoteRepository.
918
if self.has_same_location(source):
919
# check that last_revision is in 'from' and then return a
921
if (revision_id is not None and
922
not revision.is_null(revision_id)):
923
self.get_revision(revision_id)
925
inter = repository.InterRepository.get(source, self)
927
return inter.fetch(revision_id=revision_id, pb=pb, find_ghosts=find_ghosts)
928
except NotImplementedError:
929
raise errors.IncompatibleRepositories(source, self)
931
def create_bundle(self, target, base, fileobj, format=None):
933
self._real_repository.create_bundle(target, base, fileobj, format)
936
def get_ancestry(self, revision_id, topo_sorted=True):
938
return self._real_repository.get_ancestry(revision_id, topo_sorted)
940
def fileids_altered_by_revision_ids(self, revision_ids):
942
return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
944
def _get_versioned_file_checker(self, revisions, revision_versions_cache):
946
return self._real_repository._get_versioned_file_checker(
947
revisions, revision_versions_cache)
949
def iter_files_bytes(self, desired_files):
950
"""See Repository.iter_file_bytes.
953
return self._real_repository.iter_files_bytes(desired_files)
956
def _fetch_order(self):
957
"""Decorate the real repository for now.
959
In the long term getting this back from the remote repository as part
960
of open would be more efficient.
963
return self._real_repository._fetch_order
966
def _fetch_uses_deltas(self):
967
"""Decorate the real repository for now.
969
In the long term getting this back from the remote repository as part
970
of open would be more efficient.
973
return self._real_repository._fetch_uses_deltas
976
def _fetch_reconcile(self):
977
"""Decorate the real repository for now.
979
In the long term getting this back from the remote repository as part
980
of open would be more efficient.
983
return self._real_repository._fetch_reconcile
985
def get_parent_map(self, revision_ids):
986
"""See bzrlib.Graph.get_parent_map()."""
987
return self._make_parents_provider().get_parent_map(revision_ids)
989
def _get_parent_map_rpc(self, keys):
990
"""Helper for get_parent_map that performs the RPC."""
991
medium = self._client._medium
992
if medium._is_remote_before((1, 2)):
993
# We already found out that the server can't understand
994
# Repository.get_parent_map requests, so just fetch the whole
996
# XXX: Note that this will issue a deprecation warning. This is ok
997
# :- its because we're working with a deprecated server anyway, and
998
# the user will almost certainly have seen a warning about the
999
# server version already.
1000
rg = self.get_revision_graph()
1001
# There is an api discrepency between get_parent_map and
1002
# get_revision_graph. Specifically, a "key:()" pair in
1003
# get_revision_graph just means a node has no parents. For
1004
# "get_parent_map" it means the node is a ghost. So fix up the
1005
# graph to correct this.
1006
# https://bugs.launchpad.net/bzr/+bug/214894
1007
# There is one other "bug" which is that ghosts in
1008
# get_revision_graph() are not returned at all. But we won't worry
1009
# about that for now.
1010
for node_id, parent_ids in rg.iteritems():
1011
if parent_ids == ():
1012
rg[node_id] = (NULL_REVISION,)
1013
rg[NULL_REVISION] = ()
1018
raise ValueError('get_parent_map(None) is not valid')
1019
if NULL_REVISION in keys:
1020
keys.discard(NULL_REVISION)
1021
found_parents = {NULL_REVISION:()}
1023
return found_parents
1026
# TODO(Needs analysis): We could assume that the keys being requested
1027
# from get_parent_map are in a breadth first search, so typically they
1028
# will all be depth N from some common parent, and we don't have to
1029
# have the server iterate from the root parent, but rather from the
1030
# keys we're searching; and just tell the server the keyspace we
1031
# already have; but this may be more traffic again.
1033
# Transform self._parents_map into a search request recipe.
1034
# TODO: Manage this incrementally to avoid covering the same path
1035
# repeatedly. (The server will have to on each request, but the less
1036
# work done the better).
1037
parents_map = self._unstacked_provider.get_cached_map()
1038
if parents_map is None:
1039
# Repository is not locked, so there's no cache.
1041
start_set = set(parents_map)
1042
result_parents = set()
1043
for parents in parents_map.itervalues():
1044
result_parents.update(parents)
1045
stop_keys = result_parents.difference(start_set)
1046
included_keys = start_set.intersection(result_parents)
1047
start_set.difference_update(included_keys)
1048
recipe = (start_set, stop_keys, len(parents_map))
1049
body = self._serialise_search_recipe(recipe)
1050
path = self.bzrdir._path_for_remote_call(self._client)
1052
if type(key) is not str:
1054
"key %r not a plain string" % (key,))
1055
verb = 'Repository.get_parent_map'
1056
args = (path,) + tuple(keys)
1058
response = self._call_with_body_bytes_expecting_body(
1060
except errors.UnknownSmartMethod:
1061
# Server does not support this method, so get the whole graph.
1062
# Worse, we have to force a disconnection, because the server now
1063
# doesn't realise it has a body on the wire to consume, so the
1064
# only way to recover is to abandon the connection.
1066
'Server is too old for fast get_parent_map, reconnecting. '
1067
'(Upgrade the server to Bazaar 1.2 to avoid this)')
1069
# To avoid having to disconnect repeatedly, we keep track of the
1070
# fact the server doesn't understand remote methods added in 1.2.
1071
medium._remember_remote_is_before((1, 2))
1072
return self.get_revision_graph(None)
1073
response_tuple, response_handler = response
1074
if response_tuple[0] not in ['ok']:
1075
response_handler.cancel_read_body()
1076
raise errors.UnexpectedSmartServerResponse(response_tuple)
1077
if response_tuple[0] == 'ok':
1078
coded = bz2.decompress(response_handler.read_body_bytes())
1080
# no revisions found
1082
lines = coded.split('\n')
1085
d = tuple(line.split())
1087
revision_graph[d[0]] = d[1:]
1089
# No parents - so give the Graph result (NULL_REVISION,).
1090
revision_graph[d[0]] = (NULL_REVISION,)
1091
return revision_graph
1094
def get_signature_text(self, revision_id):
1096
return self._real_repository.get_signature_text(revision_id)
1099
@symbol_versioning.deprecated_method(symbol_versioning.one_three)
1100
def get_revision_graph_with_ghosts(self, revision_ids=None):
1102
return self._real_repository.get_revision_graph_with_ghosts(
1103
revision_ids=revision_ids)
1106
def get_inventory_xml(self, revision_id):
1108
return self._real_repository.get_inventory_xml(revision_id)
1110
def deserialise_inventory(self, revision_id, xml):
1112
return self._real_repository.deserialise_inventory(revision_id, xml)
1114
def reconcile(self, other=None, thorough=False):
1116
return self._real_repository.reconcile(other=other, thorough=thorough)
1118
def all_revision_ids(self):
1120
return self._real_repository.all_revision_ids()
1123
def get_deltas_for_revisions(self, revisions):
1125
return self._real_repository.get_deltas_for_revisions(revisions)
1128
def get_revision_delta(self, revision_id):
1130
return self._real_repository.get_revision_delta(revision_id)
1133
def revision_trees(self, revision_ids):
1135
return self._real_repository.revision_trees(revision_ids)
1138
def get_revision_reconcile(self, revision_id):
1140
return self._real_repository.get_revision_reconcile(revision_id)
1143
def check(self, revision_ids=None):
1145
return self._real_repository.check(revision_ids=revision_ids)
1147
def copy_content_into(self, destination, revision_id=None):
1149
return self._real_repository.copy_content_into(
1150
destination, revision_id=revision_id)
1152
def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
1153
# get a tarball of the remote repository, and copy from that into the
1155
from bzrlib import osutils
1157
# TODO: Maybe a progress bar while streaming the tarball?
1158
note("Copying repository content as tarball...")
1159
tar_file = self._get_tarball('bz2')
1160
if tar_file is None:
1162
destination = to_bzrdir.create_repository()
1164
tar = tarfile.open('repository', fileobj=tar_file,
1166
tmpdir = osutils.mkdtemp()
1168
_extract_tar(tar, tmpdir)
1169
tmp_bzrdir = BzrDir.open(tmpdir)
1170
tmp_repo = tmp_bzrdir.open_repository()
1171
tmp_repo.copy_content_into(destination, revision_id)
1173
osutils.rmtree(tmpdir)
1177
# TODO: Suggestion from john: using external tar is much faster than
1178
# python's tarfile library, but it may not work on windows.
1181
def inventories(self):
1182
"""Decorate the real repository for now.
1184
In the long term a full blown network facility is needed to
1185
avoid creating a real repository object locally.
1188
return self._real_repository.inventories
1192
"""Compress the data within the repository.
1194
This is not currently implemented within the smart server.
1197
return self._real_repository.pack()
1200
def revisions(self):
1201
"""Decorate the real repository for now.
1203
In the short term this should become a real object to intercept graph
1206
In the long term a full blown network facility is needed.
1209
return self._real_repository.revisions
1211
def set_make_working_trees(self, new_value):
1213
new_value_str = "True"
1215
new_value_str = "False"
1216
path = self.bzrdir._path_for_remote_call(self._client)
1218
response = self._call(
1219
'Repository.set_make_working_trees', path, new_value_str)
1220
except errors.UnknownSmartMethod:
1222
self._real_repository.set_make_working_trees(new_value)
1224
if response[0] != 'ok':
1225
raise errors.UnexpectedSmartServerResponse(response)
1228
def signatures(self):
1229
"""Decorate the real repository for now.
1231
In the long term a full blown network facility is needed to avoid
1232
creating a real repository object locally.
1235
return self._real_repository.signatures
1238
def sign_revision(self, revision_id, gpg_strategy):
1240
return self._real_repository.sign_revision(revision_id, gpg_strategy)
1244
"""Decorate the real repository for now.
1246
In the long term a full blown network facility is needed to avoid
1247
creating a real repository object locally.
1250
return self._real_repository.texts
1253
def get_revisions(self, revision_ids):
1255
return self._real_repository.get_revisions(revision_ids)
1257
def supports_rich_root(self):
1259
return self._real_repository.supports_rich_root()
1261
def iter_reverse_revision_history(self, revision_id):
1263
return self._real_repository.iter_reverse_revision_history(revision_id)
1266
def _serializer(self):
1268
return self._real_repository._serializer
1270
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1272
return self._real_repository.store_revision_signature(
1273
gpg_strategy, plaintext, revision_id)
1275
def add_signature_text(self, revision_id, signature):
1277
return self._real_repository.add_signature_text(revision_id, signature)
1279
def has_signature_for_revision_id(self, revision_id):
1281
return self._real_repository.has_signature_for_revision_id(revision_id)
1283
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
1285
return self._real_repository.item_keys_introduced_by(revision_ids,
1286
_files_pb=_files_pb)
1288
def revision_graph_can_have_wrong_parents(self):
1289
# The answer depends on the remote repo format.
1291
return self._real_repository.revision_graph_can_have_wrong_parents()
1293
def _find_inconsistent_revision_parents(self):
1295
return self._real_repository._find_inconsistent_revision_parents()
1297
def _check_for_inconsistent_revision_parents(self):
1299
return self._real_repository._check_for_inconsistent_revision_parents()
1301
def _make_parents_provider(self, other=None):
1302
providers = [self._unstacked_provider]
1303
if other is not None:
1304
providers.insert(0, other)
1305
providers.extend(r._make_parents_provider() for r in
1306
self._fallback_repositories)
1307
return graph._StackedParentsProvider(providers)
1309
def _serialise_search_recipe(self, recipe):
1310
"""Serialise a graph search recipe.
1312
:param recipe: A search recipe (start, stop, count).
1313
:return: Serialised bytes.
1315
start_keys = ' '.join(recipe[0])
1316
stop_keys = ' '.join(recipe[1])
1317
count = str(recipe[2])
1318
return '\n'.join((start_keys, stop_keys, count))
1321
path = self.bzrdir._path_for_remote_call(self._client)
1323
response = self._call('PackRepository.autopack', path)
1324
except errors.UnknownSmartMethod:
1326
self._real_repository._pack_collection.autopack()
1328
if self._real_repository is not None:
1329
# Reset the real repository's cache of pack names.
1330
# XXX: At some point we may be able to skip this and just rely on
1331
# the automatic retry logic to do the right thing, but for now we
1332
# err on the side of being correct rather than being optimal.
1333
self._real_repository._pack_collection.reload_pack_names()
1334
if response[0] != 'ok':
1335
raise errors.UnexpectedSmartServerResponse(response)
1338
class RemoteStreamSink(repository.StreamSink):
1340
def _insert_real(self, stream, src_format):
1341
self.target_repo._ensure_real()
1342
sink = self.target_repo._real_repository._get_sink()
1343
return sink.insert_stream(stream, src_format)
1345
def insert_stream(self, stream, src_format):
1346
repo = self.target_repo
1347
# Until we can handle deltas in stack repositories we can't hand all
1348
# the processing off to a remote server.
1349
if self.target_repo._fallback_repositories:
1350
return self._insert_real(stream, src_format)
1351
client = repo._client
1352
path = repo.bzrdir._path_for_remote_call(client)
1353
byte_stream = self._stream_to_byte_stream(stream, src_format)
1355
response = client.call_with_body_stream(
1356
('Repository.insert_stream', path), byte_stream)
1357
except errors.UnknownSmartMethod:
1358
return self._insert_real(stream, src_format)
1360
def _stream_to_byte_stream(self, stream, src_format):
1362
pack_writer = pack.ContainerWriter(bytes.append)
1364
pack_writer.add_bytes_record(src_format.network_name(), '')
1366
def get_adapter(adapter_key):
1368
return adapters[adapter_key]
1370
adapter_factory = adapter_registry.get(adapter_key)
1371
adapter = adapter_factory(self)
1372
adapters[adapter_key] = adapter
1374
for substream_type, substream in stream:
1375
for record in substream:
1376
if record.storage_kind in ('chunked', 'fulltext'):
1377
serialised = record_to_fulltext_bytes(record)
1379
serialised = record.get_bytes_as(record.storage_kind)
1380
pack_writer.add_bytes_record(serialised, [(substream_type,)])
1389
class RemoteBranchLockableFiles(LockableFiles):
1390
"""A 'LockableFiles' implementation that talks to a smart server.
1392
This is not a public interface class.
1395
def __init__(self, bzrdir, _client):
1396
self.bzrdir = bzrdir
1397
self._client = _client
1398
self._need_find_modes = True
1399
LockableFiles.__init__(
1400
self, bzrdir.get_branch_transport(None),
1401
'lock', lockdir.LockDir)
1403
def _find_modes(self):
1404
# RemoteBranches don't let the client set the mode of control files.
1405
self._dir_mode = None
1406
self._file_mode = None
1409
class RemoteBranchFormat(branch.BranchFormat):
1412
super(RemoteBranchFormat, self).__init__()
1413
self._matchingbzrdir = RemoteBzrDirFormat()
1414
self._matchingbzrdir.set_branch_format(self)
1416
def __eq__(self, other):
1417
return (isinstance(other, RemoteBranchFormat) and
1418
self.__dict__ == other.__dict__)
1420
def get_format_description(self):
1421
return 'Remote BZR Branch'
1423
def get_format_string(self):
1424
return 'Remote BZR Branch'
1426
def open(self, a_bzrdir):
1427
return a_bzrdir.open_branch()
1429
def initialize(self, a_bzrdir):
1430
# Delegate to a _real object here - the RemoteBzrDir format now
1431
# supports delegating to parameterised branch formats and as such
1432
# this RemoteBranchFormat method is only called when no specific format
1434
if not isinstance(a_bzrdir, RemoteBzrDir):
1435
result = a_bzrdir.create_branch()
1437
a_bzrdir._ensure_real()
1438
result = a_bzrdir._real_bzrdir.create_branch()
1439
if not isinstance(result, RemoteBranch):
1440
result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result)
1443
def supports_tags(self):
1444
# Remote branches might support tags, but we won't know until we
1445
# access the real remote branch.
1449
class RemoteBranch(branch.Branch, _RpcHelper):
1450
"""Branch stored on a server accessed by HPSS RPC.
1452
At the moment most operations are mapped down to simple file operations.
1455
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
1457
"""Create a RemoteBranch instance.
1459
:param real_branch: An optional local implementation of the branch
1460
format, usually accessing the data via the VFS.
1461
:param _client: Private parameter for testing.
1463
# We intentionally don't call the parent class's __init__, because it
1464
# will try to assign to self.tags, which is a property in this subclass.
1465
# And the parent's __init__ doesn't do much anyway.
1466
self._revision_id_to_revno_cache = None
1467
self._partial_revision_id_to_revno_cache = {}
1468
self._revision_history_cache = None
1469
self._last_revision_info_cache = None
1470
self._merge_sorted_revisions_cache = None
1471
self.bzrdir = remote_bzrdir
1472
if _client is not None:
1473
self._client = _client
1475
self._client = remote_bzrdir._client
1476
self.repository = remote_repository
1477
if real_branch is not None:
1478
self._real_branch = real_branch
1479
# Give the remote repository the matching real repo.
1480
real_repo = self._real_branch.repository
1481
if isinstance(real_repo, RemoteRepository):
1482
real_repo._ensure_real()
1483
real_repo = real_repo._real_repository
1484
self.repository._set_real_repository(real_repo)
1485
# Give the branch the remote repository to let fast-pathing happen.
1486
self._real_branch.repository = self.repository
1488
self._real_branch = None
1489
# Fill out expected attributes of branch for bzrlib api users.
1490
self._format = RemoteBranchFormat()
1491
self.base = self.bzrdir.root_transport.base
1492
self._control_files = None
1493
self._lock_mode = None
1494
self._lock_token = None
1495
self._repo_lock_token = None
1496
self._lock_count = 0
1497
self._leave_lock = False
1498
# The base class init is not called, so we duplicate this:
1499
hooks = branch.Branch.hooks['open']
1502
self._setup_stacking()
1504
def _setup_stacking(self):
1505
# configure stacking into the remote repository, by reading it from
1508
fallback_url = self.get_stacked_on_url()
1509
except (errors.NotStacked, errors.UnstackableBranchFormat,
1510
errors.UnstackableRepositoryFormat), e:
1512
# it's relative to this branch...
1513
fallback_url = urlutils.join(self.base, fallback_url)
1514
transports = [self.bzrdir.root_transport]
1515
if self._real_branch is not None:
1516
transports.append(self._real_branch._transport)
1517
stacked_on = branch.Branch.open(fallback_url,
1518
possible_transports=transports)
1519
self.repository.add_fallback_repository(stacked_on.repository)
1521
def _get_real_transport(self):
1522
# if we try vfs access, return the real branch's vfs transport
1524
return self._real_branch._transport
1526
_transport = property(_get_real_transport)
1529
return "%s(%s)" % (self.__class__.__name__, self.base)
1533
def _ensure_real(self):
1534
"""Ensure that there is a _real_branch set.
1536
Used before calls to self._real_branch.
1538
if self._real_branch is None:
1539
if not vfs.vfs_enabled():
1540
raise AssertionError('smart server vfs must be enabled '
1541
'to use vfs implementation')
1542
self.bzrdir._ensure_real()
1543
self._real_branch = self.bzrdir._real_bzrdir.open_branch()
1544
if self.repository._real_repository is None:
1545
# Give the remote repository the matching real repo.
1546
real_repo = self._real_branch.repository
1547
if isinstance(real_repo, RemoteRepository):
1548
real_repo._ensure_real()
1549
real_repo = real_repo._real_repository
1550
self.repository._set_real_repository(real_repo)
1551
# Give the real branch the remote repository to let fast-pathing
1553
self._real_branch.repository = self.repository
1554
if self._lock_mode == 'r':
1555
self._real_branch.lock_read()
1556
elif self._lock_mode == 'w':
1557
self._real_branch.lock_write(token=self._lock_token)
1559
def _translate_error(self, err, **context):
1560
self.repository._translate_error(err, branch=self, **context)
1562
def _clear_cached_state(self):
1563
super(RemoteBranch, self)._clear_cached_state()
1564
if self._real_branch is not None:
1565
self._real_branch._clear_cached_state()
1567
def _clear_cached_state_of_remote_branch_only(self):
1568
"""Like _clear_cached_state, but doesn't clear the cache of
1571
This is useful when falling back to calling a method of
1572
self._real_branch that changes state. In that case the underlying
1573
branch changes, so we need to invalidate this RemoteBranch's cache of
1574
it. However, there's no need to invalidate the _real_branch's cache
1575
too, in fact doing so might harm performance.
1577
super(RemoteBranch, self)._clear_cached_state()
1580
def control_files(self):
1581
# Defer actually creating RemoteBranchLockableFiles until its needed,
1582
# because it triggers an _ensure_real that we otherwise might not need.
1583
if self._control_files is None:
1584
self._control_files = RemoteBranchLockableFiles(
1585
self.bzrdir, self._client)
1586
return self._control_files
1588
def _get_checkout_format(self):
1590
return self._real_branch._get_checkout_format()
1592
def get_physical_lock_status(self):
1593
"""See Branch.get_physical_lock_status()."""
1594
# should be an API call to the server, as branches must be lockable.
1596
return self._real_branch.get_physical_lock_status()
1598
def get_stacked_on_url(self):
1599
"""Get the URL this branch is stacked against.
1601
:raises NotStacked: If the branch is not stacked.
1602
:raises UnstackableBranchFormat: If the branch does not support
1604
:raises UnstackableRepositoryFormat: If the repository does not support
1608
# there may not be a repository yet, so we can't use
1609
# self._translate_error, so we can't use self._call either.
1610
response = self._client.call('Branch.get_stacked_on_url',
1611
self._remote_path())
1612
except errors.ErrorFromSmartServer, err:
1613
# there may not be a repository yet, so we can't call through
1614
# its _translate_error
1615
_translate_error(err, branch=self)
1616
except errors.UnknownSmartMethod, err:
1618
return self._real_branch.get_stacked_on_url()
1619
if response[0] != 'ok':
1620
raise errors.UnexpectedSmartServerResponse(response)
1623
def lock_read(self):
1624
self.repository.lock_read()
1625
if not self._lock_mode:
1626
self._lock_mode = 'r'
1627
self._lock_count = 1
1628
if self._real_branch is not None:
1629
self._real_branch.lock_read()
1631
self._lock_count += 1
1633
def _remote_lock_write(self, token):
1635
branch_token = repo_token = ''
1637
branch_token = token
1638
repo_token = self.repository.lock_write()
1639
self.repository.unlock()
1640
err_context = {'token': token}
1641
response = self._call(
1642
'Branch.lock_write', self._remote_path(), branch_token,
1643
repo_token or '', **err_context)
1644
if response[0] != 'ok':
1645
raise errors.UnexpectedSmartServerResponse(response)
1646
ok, branch_token, repo_token = response
1647
return branch_token, repo_token
1649
def lock_write(self, token=None):
1650
if not self._lock_mode:
1651
# Lock the branch and repo in one remote call.
1652
remote_tokens = self._remote_lock_write(token)
1653
self._lock_token, self._repo_lock_token = remote_tokens
1654
if not self._lock_token:
1655
raise SmartProtocolError('Remote server did not return a token!')
1656
# Tell the self.repository object that it is locked.
1657
self.repository.lock_write(
1658
self._repo_lock_token, _skip_rpc=True)
1660
if self._real_branch is not None:
1661
self._real_branch.lock_write(token=self._lock_token)
1662
if token is not None:
1663
self._leave_lock = True
1665
self._leave_lock = False
1666
self._lock_mode = 'w'
1667
self._lock_count = 1
1668
elif self._lock_mode == 'r':
1669
raise errors.ReadOnlyTransaction
1671
if token is not None:
1672
# A token was given to lock_write, and we're relocking, so
1673
# check that the given token actually matches the one we
1675
if token != self._lock_token:
1676
raise errors.TokenMismatch(token, self._lock_token)
1677
self._lock_count += 1
1678
# Re-lock the repository too.
1679
self.repository.lock_write(self._repo_lock_token)
1680
return self._lock_token or None
1682
def _unlock(self, branch_token, repo_token):
1683
err_context = {'token': str((branch_token, repo_token))}
1684
response = self._call(
1685
'Branch.unlock', self._remote_path(), branch_token,
1686
repo_token or '', **err_context)
1687
if response == ('ok',):
1689
raise errors.UnexpectedSmartServerResponse(response)
1693
self._lock_count -= 1
1694
if not self._lock_count:
1695
self._clear_cached_state()
1696
mode = self._lock_mode
1697
self._lock_mode = None
1698
if self._real_branch is not None:
1699
if (not self._leave_lock and mode == 'w' and
1700
self._repo_lock_token):
1701
# If this RemoteBranch will remove the physical lock
1702
# for the repository, make sure the _real_branch
1703
# doesn't do it first. (Because the _real_branch's
1704
# repository is set to be the RemoteRepository.)
1705
self._real_branch.repository.leave_lock_in_place()
1706
self._real_branch.unlock()
1708
# Only write-locked branched need to make a remote method
1709
# call to perfom the unlock.
1711
if not self._lock_token:
1712
raise AssertionError('Locked, but no token!')
1713
branch_token = self._lock_token
1714
repo_token = self._repo_lock_token
1715
self._lock_token = None
1716
self._repo_lock_token = None
1717
if not self._leave_lock:
1718
self._unlock(branch_token, repo_token)
1720
self.repository.unlock()
1722
def break_lock(self):
1724
return self._real_branch.break_lock()
1726
def leave_lock_in_place(self):
1727
if not self._lock_token:
1728
raise NotImplementedError(self.leave_lock_in_place)
1729
self._leave_lock = True
1731
def dont_leave_lock_in_place(self):
1732
if not self._lock_token:
1733
raise NotImplementedError(self.dont_leave_lock_in_place)
1734
self._leave_lock = False
1736
def _last_revision_info(self):
1737
response = self._call('Branch.last_revision_info', self._remote_path())
1738
if response[0] != 'ok':
1739
raise SmartProtocolError('unexpected response code %s' % (response,))
1740
revno = int(response[1])
1741
last_revision = response[2]
1742
return (revno, last_revision)
1744
def _gen_revision_history(self):
1745
"""See Branch._gen_revision_history()."""
1746
response_tuple, response_handler = self._call_expecting_body(
1747
'Branch.revision_history', self._remote_path())
1748
if response_tuple[0] != 'ok':
1749
raise errors.UnexpectedSmartServerResponse(response_tuple)
1750
result = response_handler.read_body_bytes().split('\x00')
1755
def _remote_path(self):
1756
return self.bzrdir._path_for_remote_call(self._client)
1758
def _set_last_revision_descendant(self, revision_id, other_branch,
1759
allow_diverged=False, allow_overwrite_descendant=False):
1760
# This performs additional work to meet the hook contract; while its
1761
# undesirable, we have to synthesise the revno to call the hook, and
1762
# not calling the hook is worse as it means changes can't be prevented.
1763
# Having calculated this though, we can't just call into
1764
# set_last_revision_info as a simple call, because there is a set_rh
1765
# hook that some folk may still be using.
1766
old_revno, old_revid = self.last_revision_info()
1767
history = self._lefthand_history(revision_id)
1768
self._run_pre_change_branch_tip_hooks(len(history), revision_id)
1769
err_context = {'other_branch': other_branch}
1770
response = self._call('Branch.set_last_revision_ex',
1771
self._remote_path(), self._lock_token, self._repo_lock_token,
1772
revision_id, int(allow_diverged), int(allow_overwrite_descendant),
1774
self._clear_cached_state()
1775
if len(response) != 3 and response[0] != 'ok':
1776
raise errors.UnexpectedSmartServerResponse(response)
1777
new_revno, new_revision_id = response[1:]
1778
self._last_revision_info_cache = new_revno, new_revision_id
1779
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1780
if self._real_branch is not None:
1781
cache = new_revno, new_revision_id
1782
self._real_branch._last_revision_info_cache = cache
1784
def _set_last_revision(self, revision_id):
1785
old_revno, old_revid = self.last_revision_info()
1786
# This performs additional work to meet the hook contract; while its
1787
# undesirable, we have to synthesise the revno to call the hook, and
1788
# not calling the hook is worse as it means changes can't be prevented.
1789
# Having calculated this though, we can't just call into
1790
# set_last_revision_info as a simple call, because there is a set_rh
1791
# hook that some folk may still be using.
1792
history = self._lefthand_history(revision_id)
1793
self._run_pre_change_branch_tip_hooks(len(history), revision_id)
1794
self._clear_cached_state()
1795
response = self._call('Branch.set_last_revision',
1796
self._remote_path(), self._lock_token, self._repo_lock_token,
1798
if response != ('ok',):
1799
raise errors.UnexpectedSmartServerResponse(response)
1800
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1803
def set_revision_history(self, rev_history):
1804
# Send just the tip revision of the history; the server will generate
1805
# the full history from that. If the revision doesn't exist in this
1806
# branch, NoSuchRevision will be raised.
1807
if rev_history == []:
1810
rev_id = rev_history[-1]
1811
self._set_last_revision(rev_id)
1812
for hook in branch.Branch.hooks['set_rh']:
1813
hook(self, rev_history)
1814
self._cache_revision_history(rev_history)
1816
def get_parent(self):
1818
return self._real_branch.get_parent()
1820
def _get_parent_location(self):
1821
# Used by tests, when checking normalisation of given vs stored paths.
1823
return self._real_branch._get_parent_location()
1825
def set_parent(self, url):
1827
return self._real_branch.set_parent(url)
1829
def _set_parent_location(self, url):
1830
# Used by tests, to poke bad urls into branch configurations
1832
self.set_parent(url)
1835
return self._real_branch._set_parent_location(url)
1837
def set_stacked_on_url(self, stacked_location):
1838
"""Set the URL this branch is stacked against.
1840
:raises UnstackableBranchFormat: If the branch does not support
1842
:raises UnstackableRepositoryFormat: If the repository does not support
1846
return self._real_branch.set_stacked_on_url(stacked_location)
1848
def sprout(self, to_bzrdir, revision_id=None):
1849
branch_format = to_bzrdir._format._branch_format
1850
if (branch_format is None or
1851
isinstance(branch_format, RemoteBranchFormat)):
1852
# The to_bzrdir specifies RemoteBranchFormat (or no format, which
1853
# implies the same thing), but RemoteBranches can't be created at
1854
# arbitrary URLs. So create a branch in the same format as
1855
# _real_branch instead.
1856
# XXX: if to_bzrdir is a RemoteBzrDir, this should perhaps do
1857
# to_bzrdir.create_branch to create a RemoteBranch after all...
1859
result = self._real_branch._format.initialize(to_bzrdir)
1860
self.copy_content_into(result, revision_id=revision_id)
1861
result.set_parent(self.bzrdir.root_transport.base)
1863
result = branch.Branch.sprout(
1864
self, to_bzrdir, revision_id=revision_id)
1868
def pull(self, source, overwrite=False, stop_revision=None,
1870
self._clear_cached_state_of_remote_branch_only()
1872
return self._real_branch.pull(
1873
source, overwrite=overwrite, stop_revision=stop_revision,
1874
_override_hook_target=self, **kwargs)
1877
def push(self, target, overwrite=False, stop_revision=None):
1879
return self._real_branch.push(
1880
target, overwrite=overwrite, stop_revision=stop_revision,
1881
_override_hook_source_branch=self)
1883
def is_locked(self):
1884
return self._lock_count >= 1
1887
def revision_id_to_revno(self, revision_id):
1889
return self._real_branch.revision_id_to_revno(revision_id)
1892
def set_last_revision_info(self, revno, revision_id):
1893
# XXX: These should be returned by the set_last_revision_info verb
1894
old_revno, old_revid = self.last_revision_info()
1895
self._run_pre_change_branch_tip_hooks(revno, revision_id)
1896
revision_id = ensure_null(revision_id)
1898
response = self._call('Branch.set_last_revision_info',
1899
self._remote_path(), self._lock_token, self._repo_lock_token,
1900
str(revno), revision_id)
1901
except errors.UnknownSmartMethod:
1903
self._clear_cached_state_of_remote_branch_only()
1904
self._real_branch.set_last_revision_info(revno, revision_id)
1905
self._last_revision_info_cache = revno, revision_id
1907
if response == ('ok',):
1908
self._clear_cached_state()
1909
self._last_revision_info_cache = revno, revision_id
1910
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1911
# Update the _real_branch's cache too.
1912
if self._real_branch is not None:
1913
cache = self._last_revision_info_cache
1914
self._real_branch._last_revision_info_cache = cache
1916
raise errors.UnexpectedSmartServerResponse(response)
1919
def generate_revision_history(self, revision_id, last_rev=None,
1921
medium = self._client._medium
1922
if not medium._is_remote_before((1, 6)):
1923
# Use a smart method for 1.6 and above servers
1925
self._set_last_revision_descendant(revision_id, other_branch,
1926
allow_diverged=True, allow_overwrite_descendant=True)
1928
except errors.UnknownSmartMethod:
1929
medium._remember_remote_is_before((1, 6))
1930
self._clear_cached_state_of_remote_branch_only()
1931
self.set_revision_history(self._lefthand_history(revision_id,
1932
last_rev=last_rev,other_branch=other_branch))
1937
return self._real_branch.tags
1939
def set_push_location(self, location):
1941
return self._real_branch.set_push_location(location)
1944
def update_revisions(self, other, stop_revision=None, overwrite=False,
1946
"""See Branch.update_revisions."""
1949
if stop_revision is None:
1950
stop_revision = other.last_revision()
1951
if revision.is_null(stop_revision):
1952
# if there are no commits, we're done.
1954
self.fetch(other, stop_revision)
1957
# Just unconditionally set the new revision. We don't care if
1958
# the branches have diverged.
1959
self._set_last_revision(stop_revision)
1961
medium = self._client._medium
1962
if not medium._is_remote_before((1, 6)):
1964
self._set_last_revision_descendant(stop_revision, other)
1966
except errors.UnknownSmartMethod:
1967
medium._remember_remote_is_before((1, 6))
1968
# Fallback for pre-1.6 servers: check for divergence
1969
# client-side, then do _set_last_revision.
1970
last_rev = revision.ensure_null(self.last_revision())
1972
graph = self.repository.get_graph()
1973
if self._check_if_descendant_or_diverged(
1974
stop_revision, last_rev, graph, other):
1975
# stop_revision is a descendant of last_rev, but we aren't
1976
# overwriting, so we're done.
1978
self._set_last_revision(stop_revision)
1983
def _extract_tar(tar, to_dir):
1984
"""Extract all the contents of a tarfile object.
1986
A replacement for extractall, which is not present in python2.4
1989
tar.extract(tarinfo, to_dir)
1992
def _translate_error(err, **context):
1993
"""Translate an ErrorFromSmartServer into a more useful error.
1995
Possible context keys:
2003
If the error from the server doesn't match a known pattern, then
2004
UnknownErrorFromSmartServer is raised.
2008
return context[name]
2009
except KeyError, key_err:
2010
mutter('Missing key %r in context %r', key_err.args[0], context)
2013
"""Get the path from the context if present, otherwise use first error
2017
return context['path']
2018
except KeyError, key_err:
2020
return err.error_args[0]
2021
except IndexError, idx_err:
2023
'Missing key %r in context %r', key_err.args[0], context)
2026
if err.error_verb == 'NoSuchRevision':
2027
raise NoSuchRevision(find('branch'), err.error_args[0])
2028
elif err.error_verb == 'nosuchrevision':
2029
raise NoSuchRevision(find('repository'), err.error_args[0])
2030
elif err.error_tuple == ('nobranch',):
2031
raise errors.NotBranchError(path=find('bzrdir').root_transport.base)
2032
elif err.error_verb == 'norepository':
2033
raise errors.NoRepositoryPresent(find('bzrdir'))
2034
elif err.error_verb == 'LockContention':
2035
raise errors.LockContention('(remote lock)')
2036
elif err.error_verb == 'UnlockableTransport':
2037
raise errors.UnlockableTransport(find('bzrdir').root_transport)
2038
elif err.error_verb == 'LockFailed':
2039
raise errors.LockFailed(err.error_args[0], err.error_args[1])
2040
elif err.error_verb == 'TokenMismatch':
2041
raise errors.TokenMismatch(find('token'), '(remote token)')
2042
elif err.error_verb == 'Diverged':
2043
raise errors.DivergedBranches(find('branch'), find('other_branch'))
2044
elif err.error_verb == 'TipChangeRejected':
2045
raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
2046
elif err.error_verb == 'UnstackableBranchFormat':
2047
raise errors.UnstackableBranchFormat(*err.error_args)
2048
elif err.error_verb == 'UnstackableRepositoryFormat':
2049
raise errors.UnstackableRepositoryFormat(*err.error_args)
2050
elif err.error_verb == 'NotStacked':
2051
raise errors.NotStacked(branch=find('branch'))
2052
elif err.error_verb == 'PermissionDenied':
2054
if len(err.error_args) >= 2:
2055
extra = err.error_args[1]
2058
raise errors.PermissionDenied(path, extra=extra)
2059
elif err.error_verb == 'ReadError':
2061
raise errors.ReadError(path)
2062
elif err.error_verb == 'NoSuchFile':
2064
raise errors.NoSuchFile(path)
2065
elif err.error_verb == 'FileExists':
2066
raise errors.FileExists(err.error_args[0])
2067
elif err.error_verb == 'DirectoryNotEmpty':
2068
raise errors.DirectoryNotEmpty(err.error_args[0])
2069
elif err.error_verb == 'ShortReadvError':
2070
args = err.error_args
2071
raise errors.ShortReadvError(
2072
args[0], int(args[1]), int(args[2]), int(args[3]))
2073
elif err.error_verb in ('UnicodeEncodeError', 'UnicodeDecodeError'):
2074
encoding = str(err.error_args[0]) # encoding must always be a string
2075
val = err.error_args[1]
2076
start = int(err.error_args[2])
2077
end = int(err.error_args[3])
2078
reason = str(err.error_args[4]) # reason must always be a string
2079
if val.startswith('u:'):
2080
val = val[2:].decode('utf-8')
2081
elif val.startswith('s:'):
2082
val = val[2:].decode('base64')
2083
if err.error_verb == 'UnicodeDecodeError':
2084
raise UnicodeDecodeError(encoding, val, start, end, reason)
2085
elif err.error_verb == 'UnicodeEncodeError':
2086
raise UnicodeEncodeError(encoding, val, start, end, reason)
2087
elif err.error_verb == 'ReadOnlyError':
2088
raise errors.TransportNotPossible('readonly transport')
2089
raise errors.UnknownErrorFromSmartServer(err)
added
removed
bzrlib/remote.py
