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
48
class _RpcHelper(object):
49
"""Mixin class that helps with issuing RPCs."""
51
def _call(self, method, *args, **err_context):
53
return self._client.call(method, *args)
54
except errors.ErrorFromSmartServer, err:
55
self._translate_error(err, **err_context)
57
def _call_expecting_body(self, method, *args, **err_context):
59
return self._client.call_expecting_body(method, *args)
60
except errors.ErrorFromSmartServer, err:
61
self._translate_error(err, **err_context)
63
def _call_with_body_bytes_expecting_body(self, method, args, body_bytes,
66
return self._client.call_with_body_bytes_expecting_body(
67
method, args, body_bytes)
68
except errors.ErrorFromSmartServer, err:
69
self._translate_error(err, **err_context)
71
# Note: RemoteBzrDirFormat is in bzrdir.py
73
class RemoteBzrDir(BzrDir, _RpcHelper):
74
"""Control directory on a remote server, accessed via bzr:// or similar."""
76
def __init__(self, transport, format, _client=None):
77
"""Construct a RemoteBzrDir.
79
:param _client: Private parameter for testing. Disables probing and the
82
BzrDir.__init__(self, transport, format)
83
# this object holds a delegated bzrdir that uses file-level operations
84
# to talk to the other side
85
self._real_bzrdir = None
88
medium = transport.get_smart_medium()
89
self._client = client._SmartClient(medium)
91
self._client = _client
94
path = self._path_for_remote_call(self._client)
95
response = self._call('BzrDir.open', path)
96
if response not in [('yes',), ('no',)]:
97
raise errors.UnexpectedSmartServerResponse(response)
98
if response == ('no',):
99
raise errors.NotBranchError(path=transport.base)
101
def _ensure_real(self):
102
"""Ensure that there is a _real_bzrdir set.
104
Used before calls to self._real_bzrdir.
106
if not self._real_bzrdir:
107
self._real_bzrdir = BzrDir.open_from_transport(
108
self.root_transport, _server_formats=False)
110
def _translate_error(self, err, **context):
111
_translate_error(err, bzrdir=self, **context)
113
def cloning_metadir(self, stacked=False):
115
return self._real_bzrdir.cloning_metadir(stacked)
117
def create_repository(self, shared=False):
118
# as per meta1 formats - just delegate to the format object which may
120
result = self._format.repository_format.initialize(self, shared)
121
if not isinstance(result, RemoteRepository):
122
return self.open_repository()
126
def destroy_repository(self):
127
"""See BzrDir.destroy_repository"""
129
self._real_bzrdir.destroy_repository()
131
def create_branch(self):
132
# as per meta1 formats - just delegate to the format object which may
134
real_branch = self._format.get_branch_format().initialize(self)
135
if not isinstance(real_branch, RemoteBranch):
136
return RemoteBranch(self, self.find_repository(), real_branch)
140
def destroy_branch(self):
141
"""See BzrDir.destroy_branch"""
143
self._real_bzrdir.destroy_branch()
145
def create_workingtree(self, revision_id=None, from_branch=None):
146
raise errors.NotLocalUrl(self.transport.base)
148
def find_branch_format(self):
149
"""Find the branch 'format' for this bzrdir.
151
This might be a synthetic object for e.g. RemoteBranch and SVN.
153
b = self.open_branch()
156
def get_branch_reference(self):
157
"""See BzrDir.get_branch_reference()."""
158
path = self._path_for_remote_call(self._client)
159
response = self._call('BzrDir.open_branch', path)
160
if response[0] == 'ok':
161
if response[1] == '':
162
# branch at this location.
165
# a branch reference, use the existing BranchReference logic.
168
raise errors.UnexpectedSmartServerResponse(response)
170
def _get_tree_branch(self):
171
"""See BzrDir._get_tree_branch()."""
172
return None, self.open_branch()
174
def open_branch(self, _unsupported=False):
176
raise NotImplementedError('unsupported flag support not implemented yet.')
177
reference_url = self.get_branch_reference()
178
if reference_url is None:
179
# branch at this location.
180
return RemoteBranch(self, self.find_repository())
182
# a branch reference, use the existing BranchReference logic.
183
format = BranchReferenceFormat()
184
return format.open(self, _found=True, location=reference_url)
186
def open_repository(self):
187
path = self._path_for_remote_call(self._client)
188
verb = 'BzrDir.find_repositoryV2'
190
response = self._call(verb, path)
191
except errors.UnknownSmartMethod:
192
verb = 'BzrDir.find_repository'
193
response = self._call(verb, path)
194
if response[0] != 'ok':
195
raise errors.UnexpectedSmartServerResponse(response)
196
if verb == 'BzrDir.find_repository':
197
# servers that don't support the V2 method don't support external
199
response = response + ('no', )
200
if not (len(response) == 5):
201
raise SmartProtocolError('incorrect response length %s' % (response,))
202
if response[1] == '':
203
format = RemoteRepositoryFormat()
204
format.rich_root_data = (response[2] == 'yes')
205
format.supports_tree_reference = (response[3] == 'yes')
206
# No wire format to check this yet.
207
format.supports_external_lookups = (response[4] == 'yes')
208
# Used to support creating a real format instance when needed.
209
format._creating_bzrdir = self
210
remote_repo = RemoteRepository(self, format)
211
format._creating_repo = remote_repo
214
raise errors.NoRepositoryPresent(self)
216
def open_workingtree(self, recommend_upgrade=True):
218
if self._real_bzrdir.has_workingtree():
219
raise errors.NotLocalUrl(self.root_transport)
221
raise errors.NoWorkingTree(self.root_transport.base)
223
def _path_for_remote_call(self, client):
224
"""Return the path to be used for this bzrdir in a remote call."""
225
return client.remote_path_from_transport(self.root_transport)
227
def get_branch_transport(self, branch_format):
229
return self._real_bzrdir.get_branch_transport(branch_format)
231
def get_repository_transport(self, repository_format):
233
return self._real_bzrdir.get_repository_transport(repository_format)
235
def get_workingtree_transport(self, workingtree_format):
237
return self._real_bzrdir.get_workingtree_transport(workingtree_format)
239
def can_convert_format(self):
240
"""Upgrading of remote bzrdirs is not supported yet."""
243
def needs_format_conversion(self, format=None):
244
"""Upgrading of remote bzrdirs is not supported yet."""
246
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
247
% 'needs_format_conversion(format=None)')
250
def clone(self, url, revision_id=None, force_new_repo=False,
251
preserve_stacking=False):
253
return self._real_bzrdir.clone(url, revision_id=revision_id,
254
force_new_repo=force_new_repo, preserve_stacking=preserve_stacking)
256
def get_config(self):
258
return self._real_bzrdir.get_config()
261
class RemoteRepositoryFormat(repository.RepositoryFormat):
262
"""Format for repositories accessed over a _SmartClient.
264
Instances of this repository are represented by RemoteRepository
267
The RemoteRepositoryFormat is parameterized during construction
268
to reflect the capabilities of the real, remote format. Specifically
269
the attributes rich_root_data and supports_tree_reference are set
270
on a per instance basis, and are not set (and should not be) at
273
:ivar _custom_format: If set, a specific concrete repository format that
274
will be used when initializing a repository with this
275
RemoteRepositoryFormat.
276
:ivar _creating_repo: If set, the repository object that this
277
RemoteRepositoryFormat was created for: it can be called into
278
to obtain data like the network name.
281
_matchingbzrdir = RemoteBzrDirFormat()
284
repository.RepositoryFormat.__init__(self)
285
self._custom_format = None
286
self._network_name = None
287
self._creating_bzrdir = None
289
def _vfs_initialize(self, a_bzrdir, shared):
290
"""Helper for common code in initialize."""
291
if self._custom_format:
292
# Custom format requested
293
result = self._custom_format.initialize(a_bzrdir, shared=shared)
294
elif self._creating_bzrdir is not None:
295
# Use the format that the repository we were created to back
297
prior_repo = self._creating_bzrdir.open_repository()
298
prior_repo._ensure_real()
299
result = prior_repo._real_repository._format.initialize(
300
a_bzrdir, shared=shared)
302
# assume that a_bzr is a RemoteBzrDir but the smart server didn't
303
# support remote initialization.
304
# We delegate to a real object at this point (as RemoteBzrDir
305
# delegate to the repository format which would lead to infinite
306
# recursion if we just called a_bzrdir.create_repository.
307
a_bzrdir._ensure_real()
308
result = a_bzrdir._real_bzrdir.create_repository(shared=shared)
309
if not isinstance(result, RemoteRepository):
310
return self.open(a_bzrdir)
314
def initialize(self, a_bzrdir, shared=False):
315
# Being asked to create on a non RemoteBzrDir:
316
if not isinstance(a_bzrdir, RemoteBzrDir):
317
return self._vfs_initialize(a_bzrdir, shared)
318
medium = a_bzrdir._client._medium
319
if medium._is_remote_before((1, 13)):
320
return self._vfs_initialize(a_bzrdir, shared)
321
# Creating on a remote bzr dir.
322
# 1) get the network name to use.
323
if self._custom_format:
324
network_name = self._custom_format.network_name()
326
# Select the current bzrlib default and ask for that.
327
reference_bzrdir_format = bzrdir.format_registry.get('default')()
328
reference_format = reference_bzrdir_format.repository_format
329
network_name = reference_format.network_name()
330
# 2) try direct creation via RPC
331
path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
332
verb = 'BzrDir.create_repository'
338
response = a_bzrdir._call(verb, path, network_name, shared_str)
339
except errors.UnknownSmartMethod:
340
# Fallback - use vfs methods
341
return self._vfs_initialize(a_bzrdir, shared)
343
# Turn the response into a RemoteRepository object.
344
format = RemoteRepositoryFormat()
345
format.rich_root_data = (response[1] == 'yes')
346
format.supports_tree_reference = (response[2] == 'yes')
347
format.supports_external_lookups = (response[3] == 'yes')
348
format._network_name = response[4]
349
# Used to support creating a real format instance when needed.
350
format._creating_bzrdir = a_bzrdir
351
remote_repo = RemoteRepository(a_bzrdir, format)
352
format._creating_repo = remote_repo
355
def open(self, a_bzrdir):
356
if not isinstance(a_bzrdir, RemoteBzrDir):
357
raise AssertionError('%r is not a RemoteBzrDir' % (a_bzrdir,))
358
return a_bzrdir.open_repository()
360
def get_format_description(self):
361
return 'bzr remote repository'
363
def __eq__(self, other):
364
return self.__class__ == other.__class__
366
def check_conversion_target(self, target_format):
367
if self.rich_root_data and not target_format.rich_root_data:
368
raise errors.BadConversionTarget(
369
'Does not support rich root data.', target_format)
370
if (self.supports_tree_reference and
371
not getattr(target_format, 'supports_tree_reference', False)):
372
raise errors.BadConversionTarget(
373
'Does not support nested trees', target_format)
375
def network_name(self):
376
if self._network_name:
377
return self._network_name
378
self._creating_repo._ensure_real()
379
return self._creating_repo._real_repository._format.network_name()
382
def _serializer(self):
383
# We should only be getting asked for the serializer for
384
# RemoteRepositoryFormat objects when the RemoteRepositoryFormat object
385
# is a concrete instance for a RemoteRepository. In this case we know
386
# the creating_repo and can use it to supply the serializer.
387
self._creating_repo._ensure_real()
388
return self._creating_repo._real_repository._format._serializer
391
class RemoteRepository(_RpcHelper):
392
"""Repository accessed over rpc.
394
For the moment most operations are performed using local transport-backed
398
def __init__(self, remote_bzrdir, format, real_repository=None, _client=None):
399
"""Create a RemoteRepository instance.
401
:param remote_bzrdir: The bzrdir hosting this repository.
402
:param format: The RemoteFormat object to use.
403
:param real_repository: If not None, a local implementation of the
404
repository logic for the repository, usually accessing the data
406
:param _client: Private testing parameter - override the smart client
407
to be used by the repository.
410
self._real_repository = real_repository
412
self._real_repository = None
413
self.bzrdir = remote_bzrdir
415
self._client = remote_bzrdir._client
417
self._client = _client
418
self._format = format
419
self._lock_mode = None
420
self._lock_token = None
422
self._leave_lock = False
423
self._unstacked_provider = graph.CachingParentsProvider(
424
get_parent_map=self._get_parent_map_rpc)
425
self._unstacked_provider.disable_cache()
427
# These depend on the actual remote format, so force them off for
428
# maximum compatibility. XXX: In future these should depend on the
429
# remote repository instance, but this is irrelevant until we perform
430
# reconcile via an RPC call.
431
self._reconcile_does_inventory_gc = False
432
self._reconcile_fixes_text_parents = False
433
self._reconcile_backsup_inventory = False
434
self.base = self.bzrdir.transport.base
435
# Additional places to query for data.
436
self._fallback_repositories = []
439
return "%s(%s)" % (self.__class__.__name__, self.base)
443
def abort_write_group(self, suppress_errors=False):
444
"""Complete a write group on the decorated repository.
446
Smart methods peform operations in a single step so this api
447
is not really applicable except as a compatibility thunk
448
for older plugins that don't use e.g. the CommitBuilder
451
:param suppress_errors: see Repository.abort_write_group.
454
return self._real_repository.abort_write_group(
455
suppress_errors=suppress_errors)
457
def commit_write_group(self):
458
"""Complete a write group on the decorated repository.
460
Smart methods peform operations in a single step so this api
461
is not really applicable except as a compatibility thunk
462
for older plugins that don't use e.g. the CommitBuilder
466
return self._real_repository.commit_write_group()
468
def _ensure_real(self):
469
"""Ensure that there is a _real_repository set.
471
Used before calls to self._real_repository.
473
if self._real_repository is None:
474
self.bzrdir._ensure_real()
475
self._set_real_repository(
476
self.bzrdir._real_bzrdir.open_repository())
478
def _translate_error(self, err, **context):
479
self.bzrdir._translate_error(err, repository=self, **context)
481
def find_text_key_references(self):
482
"""Find the text key references within the repository.
484
:return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
485
revision_ids. Each altered file-ids has the exact revision_ids that
486
altered it listed explicitly.
487
:return: A dictionary mapping text keys ((fileid, revision_id) tuples)
488
to whether they were referred to by the inventory of the
489
revision_id that they contain. The inventory texts from all present
490
revision ids are assessed to generate this report.
493
return self._real_repository.find_text_key_references()
495
def _generate_text_key_index(self):
496
"""Generate a new text key index for the repository.
498
This is an expensive function that will take considerable time to run.
500
:return: A dict mapping (file_id, revision_id) tuples to a list of
501
parents, also (file_id, revision_id) tuples.
504
return self._real_repository._generate_text_key_index()
506
@symbol_versioning.deprecated_method(symbol_versioning.one_four)
507
def get_revision_graph(self, revision_id=None):
508
"""See Repository.get_revision_graph()."""
509
return self._get_revision_graph(revision_id)
511
def _get_revision_graph(self, revision_id):
512
"""Private method for using with old (< 1.2) servers to fallback."""
513
if revision_id is None:
515
elif revision.is_null(revision_id):
518
path = self.bzrdir._path_for_remote_call(self._client)
519
response = self._call_expecting_body(
520
'Repository.get_revision_graph', path, revision_id)
521
response_tuple, response_handler = response
522
if response_tuple[0] != 'ok':
523
raise errors.UnexpectedSmartServerResponse(response_tuple)
524
coded = response_handler.read_body_bytes()
526
# no revisions in this repository!
528
lines = coded.split('\n')
531
d = tuple(line.split())
532
revision_graph[d[0]] = d[1:]
534
return revision_graph
537
"""See Repository._get_sink()."""
539
return self._real_repository._get_sink()
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
def _length_prefix(bytes):
1339
return struct.pack('!L', len(bytes))
1342
class RemoteBranchLockableFiles(LockableFiles):
1343
"""A 'LockableFiles' implementation that talks to a smart server.
1345
This is not a public interface class.
1348
def __init__(self, bzrdir, _client):
1349
self.bzrdir = bzrdir
1350
self._client = _client
1351
self._need_find_modes = True
1352
LockableFiles.__init__(
1353
self, bzrdir.get_branch_transport(None),
1354
'lock', lockdir.LockDir)
1356
def _find_modes(self):
1357
# RemoteBranches don't let the client set the mode of control files.
1358
self._dir_mode = None
1359
self._file_mode = None
1362
class RemoteBranchFormat(branch.BranchFormat):
1365
super(RemoteBranchFormat, self).__init__()
1366
self._matchingbzrdir = RemoteBzrDirFormat()
1367
self._matchingbzrdir.set_branch_format(self)
1369
def __eq__(self, other):
1370
return (isinstance(other, RemoteBranchFormat) and
1371
self.__dict__ == other.__dict__)
1373
def get_format_description(self):
1374
return 'Remote BZR Branch'
1376
def get_format_string(self):
1377
return 'Remote BZR Branch'
1379
def open(self, a_bzrdir):
1380
return a_bzrdir.open_branch()
1382
def initialize(self, a_bzrdir):
1383
# Delegate to a _real object here - the RemoteBzrDir format now
1384
# supports delegating to parameterised branch formats and as such
1385
# this RemoteBranchFormat method is only called when no specific format
1387
if not isinstance(a_bzrdir, RemoteBzrDir):
1388
result = a_bzrdir.create_branch()
1390
a_bzrdir._ensure_real()
1391
result = a_bzrdir._real_bzrdir.create_branch()
1392
if not isinstance(result, RemoteBranch):
1393
result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result)
1396
def supports_tags(self):
1397
# Remote branches might support tags, but we won't know until we
1398
# access the real remote branch.
1402
class RemoteBranch(branch.Branch, _RpcHelper):
1403
"""Branch stored on a server accessed by HPSS RPC.
1405
At the moment most operations are mapped down to simple file operations.
1408
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
1410
"""Create a RemoteBranch instance.
1412
:param real_branch: An optional local implementation of the branch
1413
format, usually accessing the data via the VFS.
1414
:param _client: Private parameter for testing.
1416
# We intentionally don't call the parent class's __init__, because it
1417
# will try to assign to self.tags, which is a property in this subclass.
1418
# And the parent's __init__ doesn't do much anyway.
1419
self._revision_id_to_revno_cache = None
1420
self._partial_revision_id_to_revno_cache = {}
1421
self._revision_history_cache = None
1422
self._last_revision_info_cache = None
1423
self._merge_sorted_revisions_cache = None
1424
self.bzrdir = remote_bzrdir
1425
if _client is not None:
1426
self._client = _client
1428
self._client = remote_bzrdir._client
1429
self.repository = remote_repository
1430
if real_branch is not None:
1431
self._real_branch = real_branch
1432
# Give the remote repository the matching real repo.
1433
real_repo = self._real_branch.repository
1434
if isinstance(real_repo, RemoteRepository):
1435
real_repo._ensure_real()
1436
real_repo = real_repo._real_repository
1437
self.repository._set_real_repository(real_repo)
1438
# Give the branch the remote repository to let fast-pathing happen.
1439
self._real_branch.repository = self.repository
1441
self._real_branch = None
1442
# Fill out expected attributes of branch for bzrlib api users.
1443
self._format = RemoteBranchFormat()
1444
self.base = self.bzrdir.root_transport.base
1445
self._control_files = None
1446
self._lock_mode = None
1447
self._lock_token = None
1448
self._repo_lock_token = None
1449
self._lock_count = 0
1450
self._leave_lock = False
1451
# The base class init is not called, so we duplicate this:
1452
hooks = branch.Branch.hooks['open']
1455
self._setup_stacking()
1457
def _setup_stacking(self):
1458
# configure stacking into the remote repository, by reading it from
1461
fallback_url = self.get_stacked_on_url()
1462
except (errors.NotStacked, errors.UnstackableBranchFormat,
1463
errors.UnstackableRepositoryFormat), e:
1465
# it's relative to this branch...
1466
fallback_url = urlutils.join(self.base, fallback_url)
1467
transports = [self.bzrdir.root_transport]
1468
if self._real_branch is not None:
1469
transports.append(self._real_branch._transport)
1470
stacked_on = branch.Branch.open(fallback_url,
1471
possible_transports=transports)
1472
self.repository.add_fallback_repository(stacked_on.repository)
1474
def _get_real_transport(self):
1475
# if we try vfs access, return the real branch's vfs transport
1477
return self._real_branch._transport
1479
_transport = property(_get_real_transport)
1482
return "%s(%s)" % (self.__class__.__name__, self.base)
1486
def _ensure_real(self):
1487
"""Ensure that there is a _real_branch set.
1489
Used before calls to self._real_branch.
1491
if self._real_branch is None:
1492
if not vfs.vfs_enabled():
1493
raise AssertionError('smart server vfs must be enabled '
1494
'to use vfs implementation')
1495
self.bzrdir._ensure_real()
1496
self._real_branch = self.bzrdir._real_bzrdir.open_branch()
1497
if self.repository._real_repository is None:
1498
# Give the remote repository the matching real repo.
1499
real_repo = self._real_branch.repository
1500
if isinstance(real_repo, RemoteRepository):
1501
real_repo._ensure_real()
1502
real_repo = real_repo._real_repository
1503
self.repository._set_real_repository(real_repo)
1504
# Give the real branch the remote repository to let fast-pathing
1506
self._real_branch.repository = self.repository
1507
if self._lock_mode == 'r':
1508
self._real_branch.lock_read()
1509
elif self._lock_mode == 'w':
1510
self._real_branch.lock_write(token=self._lock_token)
1512
def _translate_error(self, err, **context):
1513
self.repository._translate_error(err, branch=self, **context)
1515
def _clear_cached_state(self):
1516
super(RemoteBranch, self)._clear_cached_state()
1517
if self._real_branch is not None:
1518
self._real_branch._clear_cached_state()
1520
def _clear_cached_state_of_remote_branch_only(self):
1521
"""Like _clear_cached_state, but doesn't clear the cache of
1524
This is useful when falling back to calling a method of
1525
self._real_branch that changes state. In that case the underlying
1526
branch changes, so we need to invalidate this RemoteBranch's cache of
1527
it. However, there's no need to invalidate the _real_branch's cache
1528
too, in fact doing so might harm performance.
1530
super(RemoteBranch, self)._clear_cached_state()
1533
def control_files(self):
1534
# Defer actually creating RemoteBranchLockableFiles until its needed,
1535
# because it triggers an _ensure_real that we otherwise might not need.
1536
if self._control_files is None:
1537
self._control_files = RemoteBranchLockableFiles(
1538
self.bzrdir, self._client)
1539
return self._control_files
1541
def _get_checkout_format(self):
1543
return self._real_branch._get_checkout_format()
1545
def get_physical_lock_status(self):
1546
"""See Branch.get_physical_lock_status()."""
1547
# should be an API call to the server, as branches must be lockable.
1549
return self._real_branch.get_physical_lock_status()
1551
def get_stacked_on_url(self):
1552
"""Get the URL this branch is stacked against.
1554
:raises NotStacked: If the branch is not stacked.
1555
:raises UnstackableBranchFormat: If the branch does not support
1557
:raises UnstackableRepositoryFormat: If the repository does not support
1561
# there may not be a repository yet, so we can't use
1562
# self._translate_error, so we can't use self._call either.
1563
response = self._client.call('Branch.get_stacked_on_url',
1564
self._remote_path())
1565
except errors.ErrorFromSmartServer, err:
1566
# there may not be a repository yet, so we can't call through
1567
# its _translate_error
1568
_translate_error(err, branch=self)
1569
except errors.UnknownSmartMethod, err:
1571
return self._real_branch.get_stacked_on_url()
1572
if response[0] != 'ok':
1573
raise errors.UnexpectedSmartServerResponse(response)
1576
def lock_read(self):
1577
self.repository.lock_read()
1578
if not self._lock_mode:
1579
self._lock_mode = 'r'
1580
self._lock_count = 1
1581
if self._real_branch is not None:
1582
self._real_branch.lock_read()
1584
self._lock_count += 1
1586
def _remote_lock_write(self, token):
1588
branch_token = repo_token = ''
1590
branch_token = token
1591
repo_token = self.repository.lock_write()
1592
self.repository.unlock()
1593
err_context = {'token': token}
1594
response = self._call(
1595
'Branch.lock_write', self._remote_path(), branch_token,
1596
repo_token or '', **err_context)
1597
if response[0] != 'ok':
1598
raise errors.UnexpectedSmartServerResponse(response)
1599
ok, branch_token, repo_token = response
1600
return branch_token, repo_token
1602
def lock_write(self, token=None):
1603
if not self._lock_mode:
1604
# Lock the branch and repo in one remote call.
1605
remote_tokens = self._remote_lock_write(token)
1606
self._lock_token, self._repo_lock_token = remote_tokens
1607
if not self._lock_token:
1608
raise SmartProtocolError('Remote server did not return a token!')
1609
# Tell the self.repository object that it is locked.
1610
self.repository.lock_write(
1611
self._repo_lock_token, _skip_rpc=True)
1613
if self._real_branch is not None:
1614
self._real_branch.lock_write(token=self._lock_token)
1615
if token is not None:
1616
self._leave_lock = True
1618
self._leave_lock = False
1619
self._lock_mode = 'w'
1620
self._lock_count = 1
1621
elif self._lock_mode == 'r':
1622
raise errors.ReadOnlyTransaction
1624
if token is not None:
1625
# A token was given to lock_write, and we're relocking, so
1626
# check that the given token actually matches the one we
1628
if token != self._lock_token:
1629
raise errors.TokenMismatch(token, self._lock_token)
1630
self._lock_count += 1
1631
# Re-lock the repository too.
1632
self.repository.lock_write(self._repo_lock_token)
1633
return self._lock_token or None
1635
def _unlock(self, branch_token, repo_token):
1636
err_context = {'token': str((branch_token, repo_token))}
1637
response = self._call(
1638
'Branch.unlock', self._remote_path(), branch_token,
1639
repo_token or '', **err_context)
1640
if response == ('ok',):
1642
raise errors.UnexpectedSmartServerResponse(response)
1646
self._lock_count -= 1
1647
if not self._lock_count:
1648
self._clear_cached_state()
1649
mode = self._lock_mode
1650
self._lock_mode = None
1651
if self._real_branch is not None:
1652
if (not self._leave_lock and mode == 'w' and
1653
self._repo_lock_token):
1654
# If this RemoteBranch will remove the physical lock
1655
# for the repository, make sure the _real_branch
1656
# doesn't do it first. (Because the _real_branch's
1657
# repository is set to be the RemoteRepository.)
1658
self._real_branch.repository.leave_lock_in_place()
1659
self._real_branch.unlock()
1661
# Only write-locked branched need to make a remote method
1662
# call to perfom the unlock.
1664
if not self._lock_token:
1665
raise AssertionError('Locked, but no token!')
1666
branch_token = self._lock_token
1667
repo_token = self._repo_lock_token
1668
self._lock_token = None
1669
self._repo_lock_token = None
1670
if not self._leave_lock:
1671
self._unlock(branch_token, repo_token)
1673
self.repository.unlock()
1675
def break_lock(self):
1677
return self._real_branch.break_lock()
1679
def leave_lock_in_place(self):
1680
if not self._lock_token:
1681
raise NotImplementedError(self.leave_lock_in_place)
1682
self._leave_lock = True
1684
def dont_leave_lock_in_place(self):
1685
if not self._lock_token:
1686
raise NotImplementedError(self.dont_leave_lock_in_place)
1687
self._leave_lock = False
1689
def _last_revision_info(self):
1690
response = self._call('Branch.last_revision_info', self._remote_path())
1691
if response[0] != 'ok':
1692
raise SmartProtocolError('unexpected response code %s' % (response,))
1693
revno = int(response[1])
1694
last_revision = response[2]
1695
return (revno, last_revision)
1697
def _gen_revision_history(self):
1698
"""See Branch._gen_revision_history()."""
1699
response_tuple, response_handler = self._call_expecting_body(
1700
'Branch.revision_history', self._remote_path())
1701
if response_tuple[0] != 'ok':
1702
raise errors.UnexpectedSmartServerResponse(response_tuple)
1703
result = response_handler.read_body_bytes().split('\x00')
1708
def _remote_path(self):
1709
return self.bzrdir._path_for_remote_call(self._client)
1711
def _set_last_revision_descendant(self, revision_id, other_branch,
1712
allow_diverged=False, allow_overwrite_descendant=False):
1713
# This performs additional work to meet the hook contract; while its
1714
# undesirable, we have to synthesise the revno to call the hook, and
1715
# not calling the hook is worse as it means changes can't be prevented.
1716
# Having calculated this though, we can't just call into
1717
# set_last_revision_info as a simple call, because there is a set_rh
1718
# hook that some folk may still be using.
1719
old_revno, old_revid = self.last_revision_info()
1720
history = self._lefthand_history(revision_id)
1721
self._run_pre_change_branch_tip_hooks(len(history), revision_id)
1722
err_context = {'other_branch': other_branch}
1723
response = self._call('Branch.set_last_revision_ex',
1724
self._remote_path(), self._lock_token, self._repo_lock_token,
1725
revision_id, int(allow_diverged), int(allow_overwrite_descendant),
1727
self._clear_cached_state()
1728
if len(response) != 3 and response[0] != 'ok':
1729
raise errors.UnexpectedSmartServerResponse(response)
1730
new_revno, new_revision_id = response[1:]
1731
self._last_revision_info_cache = new_revno, new_revision_id
1732
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1733
if self._real_branch is not None:
1734
cache = new_revno, new_revision_id
1735
self._real_branch._last_revision_info_cache = cache
1737
def _set_last_revision(self, revision_id):
1738
old_revno, old_revid = self.last_revision_info()
1739
# This performs additional work to meet the hook contract; while its
1740
# undesirable, we have to synthesise the revno to call the hook, and
1741
# not calling the hook is worse as it means changes can't be prevented.
1742
# Having calculated this though, we can't just call into
1743
# set_last_revision_info as a simple call, because there is a set_rh
1744
# hook that some folk may still be using.
1745
history = self._lefthand_history(revision_id)
1746
self._run_pre_change_branch_tip_hooks(len(history), revision_id)
1747
self._clear_cached_state()
1748
response = self._call('Branch.set_last_revision',
1749
self._remote_path(), self._lock_token, self._repo_lock_token,
1751
if response != ('ok',):
1752
raise errors.UnexpectedSmartServerResponse(response)
1753
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1756
def set_revision_history(self, rev_history):
1757
# Send just the tip revision of the history; the server will generate
1758
# the full history from that. If the revision doesn't exist in this
1759
# branch, NoSuchRevision will be raised.
1760
if rev_history == []:
1763
rev_id = rev_history[-1]
1764
self._set_last_revision(rev_id)
1765
for hook in branch.Branch.hooks['set_rh']:
1766
hook(self, rev_history)
1767
self._cache_revision_history(rev_history)
1769
def get_parent(self):
1771
return self._real_branch.get_parent()
1773
def _get_parent_location(self):
1774
# Used by tests, when checking normalisation of given vs stored paths.
1776
return self._real_branch._get_parent_location()
1778
def set_parent(self, url):
1780
return self._real_branch.set_parent(url)
1782
def _set_parent_location(self, url):
1783
# Used by tests, to poke bad urls into branch configurations
1785
self.set_parent(url)
1788
return self._real_branch._set_parent_location(url)
1790
def set_stacked_on_url(self, stacked_location):
1791
"""Set the URL this branch is stacked against.
1793
:raises UnstackableBranchFormat: If the branch does not support
1795
:raises UnstackableRepositoryFormat: If the repository does not support
1799
return self._real_branch.set_stacked_on_url(stacked_location)
1801
def sprout(self, to_bzrdir, revision_id=None):
1802
branch_format = to_bzrdir._format._branch_format
1803
if (branch_format is None or
1804
isinstance(branch_format, RemoteBranchFormat)):
1805
# The to_bzrdir specifies RemoteBranchFormat (or no format, which
1806
# implies the same thing), but RemoteBranches can't be created at
1807
# arbitrary URLs. So create a branch in the same format as
1808
# _real_branch instead.
1809
# XXX: if to_bzrdir is a RemoteBzrDir, this should perhaps do
1810
# to_bzrdir.create_branch to create a RemoteBranch after all...
1812
result = self._real_branch._format.initialize(to_bzrdir)
1813
self.copy_content_into(result, revision_id=revision_id)
1814
result.set_parent(self.bzrdir.root_transport.base)
1816
result = branch.Branch.sprout(
1817
self, to_bzrdir, revision_id=revision_id)
1821
def pull(self, source, overwrite=False, stop_revision=None,
1823
self._clear_cached_state_of_remote_branch_only()
1825
return self._real_branch.pull(
1826
source, overwrite=overwrite, stop_revision=stop_revision,
1827
_override_hook_target=self, **kwargs)
1830
def push(self, target, overwrite=False, stop_revision=None):
1832
return self._real_branch.push(
1833
target, overwrite=overwrite, stop_revision=stop_revision,
1834
_override_hook_source_branch=self)
1836
def is_locked(self):
1837
return self._lock_count >= 1
1840
def revision_id_to_revno(self, revision_id):
1842
return self._real_branch.revision_id_to_revno(revision_id)
1845
def set_last_revision_info(self, revno, revision_id):
1846
# XXX: These should be returned by the set_last_revision_info verb
1847
old_revno, old_revid = self.last_revision_info()
1848
self._run_pre_change_branch_tip_hooks(revno, revision_id)
1849
revision_id = ensure_null(revision_id)
1851
response = self._call('Branch.set_last_revision_info',
1852
self._remote_path(), self._lock_token, self._repo_lock_token,
1853
str(revno), revision_id)
1854
except errors.UnknownSmartMethod:
1856
self._clear_cached_state_of_remote_branch_only()
1857
self._real_branch.set_last_revision_info(revno, revision_id)
1858
self._last_revision_info_cache = revno, revision_id
1860
if response == ('ok',):
1861
self._clear_cached_state()
1862
self._last_revision_info_cache = revno, revision_id
1863
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1864
# Update the _real_branch's cache too.
1865
if self._real_branch is not None:
1866
cache = self._last_revision_info_cache
1867
self._real_branch._last_revision_info_cache = cache
1869
raise errors.UnexpectedSmartServerResponse(response)
1872
def generate_revision_history(self, revision_id, last_rev=None,
1874
medium = self._client._medium
1875
if not medium._is_remote_before((1, 6)):
1876
# Use a smart method for 1.6 and above servers
1878
self._set_last_revision_descendant(revision_id, other_branch,
1879
allow_diverged=True, allow_overwrite_descendant=True)
1881
except errors.UnknownSmartMethod:
1882
medium._remember_remote_is_before((1, 6))
1883
self._clear_cached_state_of_remote_branch_only()
1884
self.set_revision_history(self._lefthand_history(revision_id,
1885
last_rev=last_rev,other_branch=other_branch))
1890
return self._real_branch.tags
1892
def set_push_location(self, location):
1894
return self._real_branch.set_push_location(location)
1897
def update_revisions(self, other, stop_revision=None, overwrite=False,
1899
"""See Branch.update_revisions."""
1902
if stop_revision is None:
1903
stop_revision = other.last_revision()
1904
if revision.is_null(stop_revision):
1905
# if there are no commits, we're done.
1907
self.fetch(other, stop_revision)
1910
# Just unconditionally set the new revision. We don't care if
1911
# the branches have diverged.
1912
self._set_last_revision(stop_revision)
1914
medium = self._client._medium
1915
if not medium._is_remote_before((1, 6)):
1917
self._set_last_revision_descendant(stop_revision, other)
1919
except errors.UnknownSmartMethod:
1920
medium._remember_remote_is_before((1, 6))
1921
# Fallback for pre-1.6 servers: check for divergence
1922
# client-side, then do _set_last_revision.
1923
last_rev = revision.ensure_null(self.last_revision())
1925
graph = self.repository.get_graph()
1926
if self._check_if_descendant_or_diverged(
1927
stop_revision, last_rev, graph, other):
1928
# stop_revision is a descendant of last_rev, but we aren't
1929
# overwriting, so we're done.
1931
self._set_last_revision(stop_revision)
1936
def _extract_tar(tar, to_dir):
1937
"""Extract all the contents of a tarfile object.
1939
A replacement for extractall, which is not present in python2.4
1942
tar.extract(tarinfo, to_dir)
1945
def _translate_error(err, **context):
1946
"""Translate an ErrorFromSmartServer into a more useful error.
1948
Possible context keys:
1956
If the error from the server doesn't match a known pattern, then
1957
UnknownErrorFromSmartServer is raised.
1961
return context[name]
1962
except KeyError, key_err:
1963
mutter('Missing key %r in context %r', key_err.args[0], context)
1966
"""Get the path from the context if present, otherwise use first error
1970
return context['path']
1971
except KeyError, key_err:
1973
return err.error_args[0]
1974
except IndexError, idx_err:
1976
'Missing key %r in context %r', key_err.args[0], context)
1979
if err.error_verb == 'NoSuchRevision':
1980
raise NoSuchRevision(find('branch'), err.error_args[0])
1981
elif err.error_verb == 'nosuchrevision':
1982
raise NoSuchRevision(find('repository'), err.error_args[0])
1983
elif err.error_tuple == ('nobranch',):
1984
raise errors.NotBranchError(path=find('bzrdir').root_transport.base)
1985
elif err.error_verb == 'norepository':
1986
raise errors.NoRepositoryPresent(find('bzrdir'))
1987
elif err.error_verb == 'LockContention':
1988
raise errors.LockContention('(remote lock)')
1989
elif err.error_verb == 'UnlockableTransport':
1990
raise errors.UnlockableTransport(find('bzrdir').root_transport)
1991
elif err.error_verb == 'LockFailed':
1992
raise errors.LockFailed(err.error_args[0], err.error_args[1])
1993
elif err.error_verb == 'TokenMismatch':
1994
raise errors.TokenMismatch(find('token'), '(remote token)')
1995
elif err.error_verb == 'Diverged':
1996
raise errors.DivergedBranches(find('branch'), find('other_branch'))
1997
elif err.error_verb == 'TipChangeRejected':
1998
raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
1999
elif err.error_verb == 'UnstackableBranchFormat':
2000
raise errors.UnstackableBranchFormat(*err.error_args)
2001
elif err.error_verb == 'UnstackableRepositoryFormat':
2002
raise errors.UnstackableRepositoryFormat(*err.error_args)
2003
elif err.error_verb == 'NotStacked':
2004
raise errors.NotStacked(branch=find('branch'))
2005
elif err.error_verb == 'PermissionDenied':
2007
if len(err.error_args) >= 2:
2008
extra = err.error_args[1]
2011
raise errors.PermissionDenied(path, extra=extra)
2012
elif err.error_verb == 'ReadError':
2014
raise errors.ReadError(path)
2015
elif err.error_verb == 'NoSuchFile':
2017
raise errors.NoSuchFile(path)
2018
elif err.error_verb == 'FileExists':
2019
raise errors.FileExists(err.error_args[0])
2020
elif err.error_verb == 'DirectoryNotEmpty':
2021
raise errors.DirectoryNotEmpty(err.error_args[0])
2022
elif err.error_verb == 'ShortReadvError':
2023
args = err.error_args
2024
raise errors.ShortReadvError(
2025
args[0], int(args[1]), int(args[2]), int(args[3]))
2026
elif err.error_verb in ('UnicodeEncodeError', 'UnicodeDecodeError'):
2027
encoding = str(err.error_args[0]) # encoding must always be a string
2028
val = err.error_args[1]
2029
start = int(err.error_args[2])
2030
end = int(err.error_args[3])
2031
reason = str(err.error_args[4]) # reason must always be a string
2032
if val.startswith('u:'):
2033
val = val[2:].decode('utf-8')
2034
elif val.startswith('s:'):
2035
val = val[2:].decode('base64')
2036
if err.error_verb == 'UnicodeDecodeError':
2037
raise UnicodeDecodeError(encoding, val, start, end, reason)
2038
elif err.error_verb == 'UnicodeEncodeError':
2039
raise UnicodeEncodeError(encoding, val, start, end, reason)
2040
elif err.error_verb == 'ReadOnlyError':
2041
raise errors.TransportNotPossible('readonly transport')
2042
raise errors.UnknownErrorFromSmartServer(err)
added
removed
bzrlib/remote.py
