1
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
# TODO: At some point, handle upgrades by just passing the whole request
18
# across to run on the server.
33
from bzrlib.branch import BranchReferenceFormat
34
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
35
from bzrlib.decorators import needs_read_lock, needs_write_lock
36
from bzrlib.errors import (
40
from bzrlib.lockable_files import LockableFiles
41
from bzrlib.smart import client, vfs
42
from bzrlib.revision import ensure_null, NULL_REVISION
43
from bzrlib.trace import mutter, note, warning
46
class _RpcHelper(object):
47
"""Mixin class that helps with issuing RPCs."""
49
def _call(self, method, *args, **err_context):
51
return self._client.call(method, *args)
52
except errors.ErrorFromSmartServer, err:
53
self._translate_error(err, **err_context)
55
def _call_expecting_body(self, method, *args, **err_context):
57
return self._client.call_expecting_body(method, *args)
58
except errors.ErrorFromSmartServer, err:
59
self._translate_error(err, **err_context)
61
def _call_with_body_bytes_expecting_body(self, method, args, body_bytes,
64
return self._client.call_with_body_bytes_expecting_body(
65
method, args, body_bytes)
66
except errors.ErrorFromSmartServer, err:
67
self._translate_error(err, **err_context)
69
# Note: RemoteBzrDirFormat is in bzrdir.py
71
class RemoteBzrDir(BzrDir, _RpcHelper):
72
"""Control directory on a remote server, accessed via bzr:// or similar."""
74
def __init__(self, transport, _client=None):
75
"""Construct a RemoteBzrDir.
77
:param _client: Private parameter for testing. Disables probing and the
80
BzrDir.__init__(self, transport, RemoteBzrDirFormat())
81
# this object holds a delegated bzrdir that uses file-level operations
82
# to talk to the other side
83
self._real_bzrdir = None
86
medium = transport.get_smart_medium()
87
self._client = client._SmartClient(medium)
89
self._client = _client
92
path = self._path_for_remote_call(self._client)
93
response = self._call('BzrDir.open', path)
94
if response not in [('yes',), ('no',)]:
95
raise errors.UnexpectedSmartServerResponse(response)
96
if response == ('no',):
97
raise errors.NotBranchError(path=transport.base)
99
def _ensure_real(self):
100
"""Ensure that there is a _real_bzrdir set.
102
Used before calls to self._real_bzrdir.
104
if not self._real_bzrdir:
105
self._real_bzrdir = BzrDir.open_from_transport(
106
self.root_transport, _server_formats=False)
108
def _translate_error(self, err, **context):
109
_translate_error(err, bzrdir=self, **context)
111
def cloning_metadir(self, stacked=False):
113
return self._real_bzrdir.cloning_metadir(stacked)
115
def create_repository(self, shared=False):
117
self._real_bzrdir.create_repository(shared=shared)
118
return self.open_repository()
120
def destroy_repository(self):
121
"""See BzrDir.destroy_repository"""
123
self._real_bzrdir.destroy_repository()
125
def create_branch(self):
127
real_branch = self._real_bzrdir.create_branch()
128
return RemoteBranch(self, self.find_repository(), real_branch)
130
def destroy_branch(self):
131
"""See BzrDir.destroy_branch"""
133
self._real_bzrdir.destroy_branch()
135
def create_workingtree(self, revision_id=None, from_branch=None):
136
raise errors.NotLocalUrl(self.transport.base)
138
def find_branch_format(self):
139
"""Find the branch 'format' for this bzrdir.
141
This might be a synthetic object for e.g. RemoteBranch and SVN.
143
b = self.open_branch()
146
def get_branch_reference(self):
147
"""See BzrDir.get_branch_reference()."""
148
path = self._path_for_remote_call(self._client)
149
response = self._call('BzrDir.open_branch', path)
150
if response[0] == 'ok':
151
if response[1] == '':
152
# branch at this location.
155
# a branch reference, use the existing BranchReference logic.
158
raise errors.UnexpectedSmartServerResponse(response)
160
def _get_tree_branch(self):
161
"""See BzrDir._get_tree_branch()."""
162
return None, self.open_branch()
164
def open_branch(self, _unsupported=False):
166
raise NotImplementedError('unsupported flag support not implemented yet.')
167
reference_url = self.get_branch_reference()
168
if reference_url is None:
169
# branch at this location.
170
return RemoteBranch(self, self.find_repository())
172
# a branch reference, use the existing BranchReference logic.
173
format = BranchReferenceFormat()
174
return format.open(self, _found=True, location=reference_url)
176
def open_repository(self):
177
path = self._path_for_remote_call(self._client)
178
verb = 'BzrDir.find_repositoryV2'
180
response = self._call(verb, path)
181
except errors.UnknownSmartMethod:
182
verb = 'BzrDir.find_repository'
183
response = self._call(verb, path)
184
if response[0] != 'ok':
185
raise errors.UnexpectedSmartServerResponse(response)
186
if verb == 'BzrDir.find_repository':
187
# servers that don't support the V2 method don't support external
189
response = response + ('no', )
190
if not (len(response) == 5):
191
raise SmartProtocolError('incorrect response length %s' % (response,))
192
if response[1] == '':
193
format = RemoteRepositoryFormat()
194
format.rich_root_data = (response[2] == 'yes')
195
format.supports_tree_reference = (response[3] == 'yes')
196
# No wire format to check this yet.
197
format.supports_external_lookups = (response[4] == 'yes')
198
# Used to support creating a real format instance when needed.
199
format._creating_bzrdir = self
200
return RemoteRepository(self, format)
202
raise errors.NoRepositoryPresent(self)
204
def open_workingtree(self, recommend_upgrade=True):
206
if self._real_bzrdir.has_workingtree():
207
raise errors.NotLocalUrl(self.root_transport)
209
raise errors.NoWorkingTree(self.root_transport.base)
211
def _path_for_remote_call(self, client):
212
"""Return the path to be used for this bzrdir in a remote call."""
213
return client.remote_path_from_transport(self.root_transport)
215
def get_branch_transport(self, branch_format):
217
return self._real_bzrdir.get_branch_transport(branch_format)
219
def get_repository_transport(self, repository_format):
221
return self._real_bzrdir.get_repository_transport(repository_format)
223
def get_workingtree_transport(self, workingtree_format):
225
return self._real_bzrdir.get_workingtree_transport(workingtree_format)
227
def can_convert_format(self):
228
"""Upgrading of remote bzrdirs is not supported yet."""
231
def needs_format_conversion(self, format=None):
232
"""Upgrading of remote bzrdirs is not supported yet."""
234
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
235
% 'needs_format_conversion(format=None)')
238
def clone(self, url, revision_id=None, force_new_repo=False,
239
preserve_stacking=False):
241
return self._real_bzrdir.clone(url, revision_id=revision_id,
242
force_new_repo=force_new_repo, preserve_stacking=preserve_stacking)
244
def get_config(self):
246
return self._real_bzrdir.get_config()
249
class RemoteRepositoryFormat(repository.RepositoryFormat):
250
"""Format for repositories accessed over a _SmartClient.
252
Instances of this repository are represented by RemoteRepository
255
The RemoteRepositoryFormat is parameterized during construction
256
to reflect the capabilities of the real, remote format. Specifically
257
the attributes rich_root_data and supports_tree_reference are set
258
on a per instance basis, and are not set (and should not be) at
262
_matchingbzrdir = RemoteBzrDirFormat()
264
def initialize(self, a_bzrdir, shared=False):
265
if not isinstance(a_bzrdir, RemoteBzrDir):
266
prior_repo = self._creating_bzrdir.open_repository()
267
prior_repo._ensure_real()
268
return prior_repo._real_repository._format.initialize(
269
a_bzrdir, shared=shared)
270
return a_bzrdir.create_repository(shared=shared)
272
def open(self, a_bzrdir):
273
if not isinstance(a_bzrdir, RemoteBzrDir):
274
raise AssertionError('%r is not a RemoteBzrDir' % (a_bzrdir,))
275
return a_bzrdir.open_repository()
277
def get_format_description(self):
278
return 'bzr remote repository'
280
def __eq__(self, other):
281
return self.__class__ == other.__class__
283
def check_conversion_target(self, target_format):
284
if self.rich_root_data and not target_format.rich_root_data:
285
raise errors.BadConversionTarget(
286
'Does not support rich root data.', target_format)
287
if (self.supports_tree_reference and
288
not getattr(target_format, 'supports_tree_reference', False)):
289
raise errors.BadConversionTarget(
290
'Does not support nested trees', target_format)
293
class RemoteRepository(_RpcHelper):
294
"""Repository accessed over rpc.
296
For the moment most operations are performed using local transport-backed
300
def __init__(self, remote_bzrdir, format, real_repository=None, _client=None):
301
"""Create a RemoteRepository instance.
303
:param remote_bzrdir: The bzrdir hosting this repository.
304
:param format: The RemoteFormat object to use.
305
:param real_repository: If not None, a local implementation of the
306
repository logic for the repository, usually accessing the data
308
:param _client: Private testing parameter - override the smart client
309
to be used by the repository.
312
self._real_repository = real_repository
314
self._real_repository = None
315
self.bzrdir = remote_bzrdir
317
self._client = remote_bzrdir._client
319
self._client = _client
320
self._format = format
321
self._lock_mode = None
322
self._lock_token = None
324
self._leave_lock = False
325
self._unstacked_provider = graph.CachingParentsProvider(
326
get_parent_map=self._get_parent_map_rpc)
327
self._unstacked_provider.disable_cache()
329
# These depend on the actual remote format, so force them off for
330
# maximum compatibility. XXX: In future these should depend on the
331
# remote repository instance, but this is irrelevant until we perform
332
# reconcile via an RPC call.
333
self._reconcile_does_inventory_gc = False
334
self._reconcile_fixes_text_parents = False
335
self._reconcile_backsup_inventory = False
336
self.base = self.bzrdir.transport.base
337
# Additional places to query for data.
338
self._fallback_repositories = []
341
return "%s(%s)" % (self.__class__.__name__, self.base)
345
def abort_write_group(self, suppress_errors=False):
346
"""Complete a write group on the decorated repository.
348
Smart methods peform operations in a single step so this api
349
is not really applicable except as a compatibility thunk
350
for older plugins that don't use e.g. the CommitBuilder
353
:param suppress_errors: see Repository.abort_write_group.
356
return self._real_repository.abort_write_group(
357
suppress_errors=suppress_errors)
359
def commit_write_group(self):
360
"""Complete a write group on the decorated repository.
362
Smart methods peform operations in a single step so this api
363
is not really applicable except as a compatibility thunk
364
for older plugins that don't use e.g. the CommitBuilder
368
return self._real_repository.commit_write_group()
370
def resume_write_group(self, tokens):
372
return self._real_repository.resume_write_group(tokens)
374
def suspend_write_group(self):
376
return self._real_repository.suspend_write_group()
378
def _ensure_real(self):
379
"""Ensure that there is a _real_repository set.
381
Used before calls to self._real_repository.
383
if self._real_repository is None:
384
self.bzrdir._ensure_real()
385
self._set_real_repository(
386
self.bzrdir._real_bzrdir.open_repository())
388
def _translate_error(self, err, **context):
389
self.bzrdir._translate_error(err, repository=self, **context)
391
def find_text_key_references(self):
392
"""Find the text key references within the repository.
394
:return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
395
revision_ids. Each altered file-ids has the exact revision_ids that
396
altered it listed explicitly.
397
:return: A dictionary mapping text keys ((fileid, revision_id) tuples)
398
to whether they were referred to by the inventory of the
399
revision_id that they contain. The inventory texts from all present
400
revision ids are assessed to generate this report.
403
return self._real_repository.find_text_key_references()
405
def _generate_text_key_index(self):
406
"""Generate a new text key index for the repository.
408
This is an expensive function that will take considerable time to run.
410
:return: A dict mapping (file_id, revision_id) tuples to a list of
411
parents, also (file_id, revision_id) tuples.
414
return self._real_repository._generate_text_key_index()
416
@symbol_versioning.deprecated_method(symbol_versioning.one_four)
417
def get_revision_graph(self, revision_id=None):
418
"""See Repository.get_revision_graph()."""
419
return self._get_revision_graph(revision_id)
421
def _get_revision_graph(self, revision_id):
422
"""Private method for using with old (< 1.2) servers to fallback."""
423
if revision_id is None:
425
elif revision.is_null(revision_id):
428
path = self.bzrdir._path_for_remote_call(self._client)
429
response = self._call_expecting_body(
430
'Repository.get_revision_graph', path, revision_id)
431
response_tuple, response_handler = response
432
if response_tuple[0] != 'ok':
433
raise errors.UnexpectedSmartServerResponse(response_tuple)
434
coded = response_handler.read_body_bytes()
436
# no revisions in this repository!
438
lines = coded.split('\n')
441
d = tuple(line.split())
442
revision_graph[d[0]] = d[1:]
444
return revision_graph
446
def has_revision(self, revision_id):
447
"""See Repository.has_revision()."""
448
if revision_id == NULL_REVISION:
449
# The null revision is always present.
451
path = self.bzrdir._path_for_remote_call(self._client)
452
response = self._call('Repository.has_revision', path, revision_id)
453
if response[0] not in ('yes', 'no'):
454
raise errors.UnexpectedSmartServerResponse(response)
455
if response[0] == 'yes':
457
for fallback_repo in self._fallback_repositories:
458
if fallback_repo.has_revision(revision_id):
462
def has_revisions(self, revision_ids):
463
"""See Repository.has_revisions()."""
464
# FIXME: This does many roundtrips, particularly when there are
465
# fallback repositories. -- mbp 20080905
467
for revision_id in revision_ids:
468
if self.has_revision(revision_id):
469
result.add(revision_id)
472
def has_same_location(self, other):
473
return (self.__class__ == other.__class__ and
474
self.bzrdir.transport.base == other.bzrdir.transport.base)
476
def get_graph(self, other_repository=None):
477
"""Return the graph for this repository format"""
478
parents_provider = self._make_parents_provider(other_repository)
479
return graph.Graph(parents_provider)
481
def gather_stats(self, revid=None, committers=None):
482
"""See Repository.gather_stats()."""
483
path = self.bzrdir._path_for_remote_call(self._client)
484
# revid can be None to indicate no revisions, not just NULL_REVISION
485
if revid is None or revision.is_null(revid):
489
if committers is None or not committers:
490
fmt_committers = 'no'
492
fmt_committers = 'yes'
493
response_tuple, response_handler = self._call_expecting_body(
494
'Repository.gather_stats', path, fmt_revid, fmt_committers)
495
if response_tuple[0] != 'ok':
496
raise errors.UnexpectedSmartServerResponse(response_tuple)
498
body = response_handler.read_body_bytes()
500
for line in body.split('\n'):
503
key, val_text = line.split(':')
504
if key in ('revisions', 'size', 'committers'):
505
result[key] = int(val_text)
506
elif key in ('firstrev', 'latestrev'):
507
values = val_text.split(' ')[1:]
508
result[key] = (float(values[0]), long(values[1]))
512
def find_branches(self, using=False):
513
"""See Repository.find_branches()."""
514
# should be an API call to the server.
516
return self._real_repository.find_branches(using=using)
518
def get_physical_lock_status(self):
519
"""See Repository.get_physical_lock_status()."""
520
# should be an API call to the server.
522
return self._real_repository.get_physical_lock_status()
524
def is_in_write_group(self):
525
"""Return True if there is an open write group.
527
write groups are only applicable locally for the smart server..
529
if self._real_repository:
530
return self._real_repository.is_in_write_group()
533
return self._lock_count >= 1
536
"""See Repository.is_shared()."""
537
path = self.bzrdir._path_for_remote_call(self._client)
538
response = self._call('Repository.is_shared', path)
539
if response[0] not in ('yes', 'no'):
540
raise SmartProtocolError('unexpected response code %s' % (response,))
541
return response[0] == 'yes'
543
def is_write_locked(self):
544
return self._lock_mode == 'w'
547
# wrong eventually - want a local lock cache context
548
if not self._lock_mode:
549
self._lock_mode = 'r'
551
self._unstacked_provider.enable_cache(cache_misses=False)
552
if self._real_repository is not None:
553
self._real_repository.lock_read()
555
self._lock_count += 1
557
def _remote_lock_write(self, token):
558
path = self.bzrdir._path_for_remote_call(self._client)
561
err_context = {'token': token}
562
response = self._call('Repository.lock_write', path, token,
564
if response[0] == 'ok':
568
raise errors.UnexpectedSmartServerResponse(response)
570
def lock_write(self, token=None, _skip_rpc=False):
571
if not self._lock_mode:
573
if self._lock_token is not None:
574
if token != self._lock_token:
575
raise errors.TokenMismatch(token, self._lock_token)
576
self._lock_token = token
578
self._lock_token = self._remote_lock_write(token)
579
# if self._lock_token is None, then this is something like packs or
580
# svn where we don't get to lock the repo, or a weave style repository
581
# where we cannot lock it over the wire and attempts to do so will
583
if self._real_repository is not None:
584
self._real_repository.lock_write(token=self._lock_token)
585
if token is not None:
586
self._leave_lock = True
588
self._leave_lock = False
589
self._lock_mode = 'w'
591
self._unstacked_provider.enable_cache(cache_misses=False)
592
elif self._lock_mode == 'r':
593
raise errors.ReadOnlyError(self)
595
self._lock_count += 1
596
return self._lock_token or None
598
def leave_lock_in_place(self):
599
if not self._lock_token:
600
raise NotImplementedError(self.leave_lock_in_place)
601
self._leave_lock = True
603
def dont_leave_lock_in_place(self):
604
if not self._lock_token:
605
raise NotImplementedError(self.dont_leave_lock_in_place)
606
self._leave_lock = False
608
def _set_real_repository(self, repository):
609
"""Set the _real_repository for this repository.
611
:param repository: The repository to fallback to for non-hpss
612
implemented operations.
614
if self._real_repository is not None:
615
raise AssertionError('_real_repository is already set')
616
if isinstance(repository, RemoteRepository):
617
raise AssertionError()
618
self._real_repository = repository
619
for fb in self._fallback_repositories:
620
self._real_repository.add_fallback_repository(fb)
621
if self._lock_mode == 'w':
622
# if we are already locked, the real repository must be able to
623
# acquire the lock with our token.
624
self._real_repository.lock_write(self._lock_token)
625
elif self._lock_mode == 'r':
626
self._real_repository.lock_read()
628
def start_write_group(self):
629
"""Start a write group on the decorated repository.
631
Smart methods peform operations in a single step so this api
632
is not really applicable except as a compatibility thunk
633
for older plugins that don't use e.g. the CommitBuilder
637
return self._real_repository.start_write_group()
639
def _unlock(self, token):
640
path = self.bzrdir._path_for_remote_call(self._client)
642
# with no token the remote repository is not persistently locked.
644
err_context = {'token': token}
645
response = self._call('Repository.unlock', path, token,
647
if response == ('ok',):
650
raise errors.UnexpectedSmartServerResponse(response)
653
self._lock_count -= 1
654
if self._lock_count > 0:
656
self._unstacked_provider.disable_cache()
657
old_mode = self._lock_mode
658
self._lock_mode = None
660
# The real repository is responsible at present for raising an
661
# exception if it's in an unfinished write group. However, it
662
# normally will *not* actually remove the lock from disk - that's
663
# done by the server on receiving the Repository.unlock call.
664
# This is just to let the _real_repository stay up to date.
665
if self._real_repository is not None:
666
self._real_repository.unlock()
668
# The rpc-level lock should be released even if there was a
669
# problem releasing the vfs-based lock.
671
# Only write-locked repositories need to make a remote method
672
# call to perfom the unlock.
673
old_token = self._lock_token
674
self._lock_token = None
675
if not self._leave_lock:
676
self._unlock(old_token)
678
def break_lock(self):
679
# should hand off to the network
681
return self._real_repository.break_lock()
683
def _get_tarball(self, compression):
684
"""Return a TemporaryFile containing a repository tarball.
686
Returns None if the server does not support sending tarballs.
689
path = self.bzrdir._path_for_remote_call(self._client)
691
response, protocol = self._call_expecting_body(
692
'Repository.tarball', path, compression)
693
except errors.UnknownSmartMethod:
694
protocol.cancel_read_body()
696
if response[0] == 'ok':
697
# Extract the tarball and return it
698
t = tempfile.NamedTemporaryFile()
699
# TODO: rpc layer should read directly into it...
700
t.write(protocol.read_body_bytes())
703
raise errors.UnexpectedSmartServerResponse(response)
705
def sprout(self, to_bzrdir, revision_id=None):
706
# TODO: Option to control what format is created?
708
dest_repo = self._real_repository._format.initialize(to_bzrdir,
710
dest_repo.fetch(self, revision_id=revision_id)
713
### These methods are just thin shims to the VFS object for now.
715
def revision_tree(self, revision_id):
717
return self._real_repository.revision_tree(revision_id)
719
def get_serializer_format(self):
721
return self._real_repository.get_serializer_format()
723
def get_commit_builder(self, branch, parents, config, timestamp=None,
724
timezone=None, committer=None, revprops=None,
726
# FIXME: It ought to be possible to call this without immediately
727
# triggering _ensure_real. For now it's the easiest thing to do.
729
real_repo = self._real_repository
730
builder = real_repo.get_commit_builder(branch, parents,
731
config, timestamp=timestamp, timezone=timezone,
732
committer=committer, revprops=revprops, revision_id=revision_id)
735
def add_fallback_repository(self, repository):
736
"""Add a repository to use for looking up data not held locally.
738
:param repository: A repository.
740
# XXX: At the moment the RemoteRepository will allow fallbacks
741
# unconditionally - however, a _real_repository will usually exist,
742
# and may raise an error if it's not accommodated by the underlying
743
# format. Eventually we should check when opening the repository
744
# whether it's willing to allow them or not.
746
# We need to accumulate additional repositories here, to pass them in
748
self._fallback_repositories.append(repository)
749
# They are also seen by the fallback repository. If it doesn't exist
750
# yet they'll be added then. This implicitly copies them.
753
def add_inventory(self, revid, inv, parents):
755
return self._real_repository.add_inventory(revid, inv, parents)
757
def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
760
return self._real_repository.add_inventory_by_delta(basis_revision_id,
761
delta, new_revision_id, parents)
763
def add_revision(self, rev_id, rev, inv=None, config=None):
765
return self._real_repository.add_revision(
766
rev_id, rev, inv=inv, config=config)
769
def get_inventory(self, revision_id):
771
return self._real_repository.get_inventory(revision_id)
773
def iter_inventories(self, revision_ids):
775
return self._real_repository.iter_inventories(revision_ids)
778
def get_revision(self, revision_id):
780
return self._real_repository.get_revision(revision_id)
782
def get_transaction(self):
784
return self._real_repository.get_transaction()
787
def clone(self, a_bzrdir, revision_id=None):
789
return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
791
def make_working_trees(self):
792
"""See Repository.make_working_trees"""
794
return self._real_repository.make_working_trees()
796
def revision_ids_to_search_result(self, result_set):
797
"""Convert a set of revision ids to a graph SearchResult."""
798
result_parents = set()
799
for parents in self.get_graph().get_parent_map(
800
result_set).itervalues():
801
result_parents.update(parents)
802
included_keys = result_set.intersection(result_parents)
803
start_keys = result_set.difference(included_keys)
804
exclude_keys = result_parents.difference(result_set)
805
result = graph.SearchResult(start_keys, exclude_keys,
806
len(result_set), result_set)
810
def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
811
"""Return the revision ids that other has that this does not.
813
These are returned in topological order.
815
revision_id: only return revision ids included by revision_id.
817
return repository.InterRepository.get(
818
other, self).search_missing_revision_ids(revision_id, find_ghosts)
820
def fetch(self, source, revision_id=None, pb=None, find_ghosts=False):
821
# Not delegated to _real_repository so that InterRepository.get has a
822
# chance to find an InterRepository specialised for RemoteRepository.
823
if self.has_same_location(source):
824
# check that last_revision is in 'from' and then return a
826
if (revision_id is not None and
827
not revision.is_null(revision_id)):
828
self.get_revision(revision_id)
830
inter = repository.InterRepository.get(source, self)
832
return inter.fetch(revision_id=revision_id, pb=pb, find_ghosts=find_ghosts)
833
except NotImplementedError:
834
raise errors.IncompatibleRepositories(source, self)
836
def create_bundle(self, target, base, fileobj, format=None):
838
self._real_repository.create_bundle(target, base, fileobj, format)
841
def get_ancestry(self, revision_id, topo_sorted=True):
843
return self._real_repository.get_ancestry(revision_id, topo_sorted)
845
def fileids_altered_by_revision_ids(self, revision_ids):
847
return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
849
def _get_versioned_file_checker(self, revisions, revision_versions_cache):
851
return self._real_repository._get_versioned_file_checker(
852
revisions, revision_versions_cache)
854
def iter_files_bytes(self, desired_files):
855
"""See Repository.iter_file_bytes.
858
return self._real_repository.iter_files_bytes(desired_files)
861
def _fetch_order(self):
862
"""Decorate the real repository for now.
864
In the long term getting this back from the remote repository as part
865
of open would be more efficient.
868
return self._real_repository._fetch_order
871
def _fetch_uses_deltas(self):
872
"""Decorate the real repository for now.
874
In the long term getting this back from the remote repository as part
875
of open would be more efficient.
878
return self._real_repository._fetch_uses_deltas
881
def _fetch_reconcile(self):
882
"""Decorate the real repository for now.
884
In the long term getting this back from the remote repository as part
885
of open would be more efficient.
888
return self._real_repository._fetch_reconcile
890
def get_parent_map(self, revision_ids):
891
"""See bzrlib.Graph.get_parent_map()."""
892
return self._make_parents_provider().get_parent_map(revision_ids)
894
def _get_parent_map_rpc(self, keys):
895
"""Helper for get_parent_map that performs the RPC."""
896
medium = self._client._medium
897
if medium._is_remote_before((1, 2)):
898
# We already found out that the server can't understand
899
# Repository.get_parent_map requests, so just fetch the whole
901
# XXX: Note that this will issue a deprecation warning. This is ok
902
# :- its because we're working with a deprecated server anyway, and
903
# the user will almost certainly have seen a warning about the
904
# server version already.
905
rg = self.get_revision_graph()
906
# There is an api discrepency between get_parent_map and
907
# get_revision_graph. Specifically, a "key:()" pair in
908
# get_revision_graph just means a node has no parents. For
909
# "get_parent_map" it means the node is a ghost. So fix up the
910
# graph to correct this.
911
# https://bugs.launchpad.net/bzr/+bug/214894
912
# There is one other "bug" which is that ghosts in
913
# get_revision_graph() are not returned at all. But we won't worry
914
# about that for now.
915
for node_id, parent_ids in rg.iteritems():
917
rg[node_id] = (NULL_REVISION,)
918
rg[NULL_REVISION] = ()
923
raise ValueError('get_parent_map(None) is not valid')
924
if NULL_REVISION in keys:
925
keys.discard(NULL_REVISION)
926
found_parents = {NULL_REVISION:()}
931
# TODO(Needs analysis): We could assume that the keys being requested
932
# from get_parent_map are in a breadth first search, so typically they
933
# will all be depth N from some common parent, and we don't have to
934
# have the server iterate from the root parent, but rather from the
935
# keys we're searching; and just tell the server the keyspace we
936
# already have; but this may be more traffic again.
938
# Transform self._parents_map into a search request recipe.
939
# TODO: Manage this incrementally to avoid covering the same path
940
# repeatedly. (The server will have to on each request, but the less
941
# work done the better).
942
parents_map = self._unstacked_provider.get_cached_map()
943
if parents_map is None:
944
# Repository is not locked, so there's no cache.
946
start_set = set(parents_map)
947
result_parents = set()
948
for parents in parents_map.itervalues():
949
result_parents.update(parents)
950
stop_keys = result_parents.difference(start_set)
951
included_keys = start_set.intersection(result_parents)
952
start_set.difference_update(included_keys)
953
recipe = (start_set, stop_keys, len(parents_map))
954
body = self._serialise_search_recipe(recipe)
955
path = self.bzrdir._path_for_remote_call(self._client)
957
if type(key) is not str:
959
"key %r not a plain string" % (key,))
960
verb = 'Repository.get_parent_map'
961
args = (path,) + tuple(keys)
963
response = self._call_with_body_bytes_expecting_body(
965
except errors.UnknownSmartMethod:
966
# Server does not support this method, so get the whole graph.
967
# Worse, we have to force a disconnection, because the server now
968
# doesn't realise it has a body on the wire to consume, so the
969
# only way to recover is to abandon the connection.
971
'Server is too old for fast get_parent_map, reconnecting. '
972
'(Upgrade the server to Bazaar 1.2 to avoid this)')
974
# To avoid having to disconnect repeatedly, we keep track of the
975
# fact the server doesn't understand remote methods added in 1.2.
976
medium._remember_remote_is_before((1, 2))
977
return self.get_revision_graph(None)
978
response_tuple, response_handler = response
979
if response_tuple[0] not in ['ok']:
980
response_handler.cancel_read_body()
981
raise errors.UnexpectedSmartServerResponse(response_tuple)
982
if response_tuple[0] == 'ok':
983
coded = bz2.decompress(response_handler.read_body_bytes())
987
lines = coded.split('\n')
990
d = tuple(line.split())
992
revision_graph[d[0]] = d[1:]
994
# No parents - so give the Graph result (NULL_REVISION,).
995
revision_graph[d[0]] = (NULL_REVISION,)
996
return revision_graph
999
def get_signature_text(self, revision_id):
1001
return self._real_repository.get_signature_text(revision_id)
1004
@symbol_versioning.deprecated_method(symbol_versioning.one_three)
1005
def get_revision_graph_with_ghosts(self, revision_ids=None):
1007
return self._real_repository.get_revision_graph_with_ghosts(
1008
revision_ids=revision_ids)
1011
def get_inventory_xml(self, revision_id):
1013
return self._real_repository.get_inventory_xml(revision_id)
1015
def deserialise_inventory(self, revision_id, xml):
1017
return self._real_repository.deserialise_inventory(revision_id, xml)
1019
def reconcile(self, other=None, thorough=False):
1021
return self._real_repository.reconcile(other=other, thorough=thorough)
1023
def all_revision_ids(self):
1025
return self._real_repository.all_revision_ids()
1028
def get_deltas_for_revisions(self, revisions):
1030
return self._real_repository.get_deltas_for_revisions(revisions)
1033
def get_revision_delta(self, revision_id):
1035
return self._real_repository.get_revision_delta(revision_id)
1038
def revision_trees(self, revision_ids):
1040
return self._real_repository.revision_trees(revision_ids)
1043
def get_revision_reconcile(self, revision_id):
1045
return self._real_repository.get_revision_reconcile(revision_id)
1048
def check(self, revision_ids=None):
1050
return self._real_repository.check(revision_ids=revision_ids)
1052
def copy_content_into(self, destination, revision_id=None):
1054
return self._real_repository.copy_content_into(
1055
destination, revision_id=revision_id)
1057
def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
1058
# get a tarball of the remote repository, and copy from that into the
1060
from bzrlib import osutils
1062
# TODO: Maybe a progress bar while streaming the tarball?
1063
note("Copying repository content as tarball...")
1064
tar_file = self._get_tarball('bz2')
1065
if tar_file is None:
1067
destination = to_bzrdir.create_repository()
1069
tar = tarfile.open('repository', fileobj=tar_file,
1071
tmpdir = osutils.mkdtemp()
1073
_extract_tar(tar, tmpdir)
1074
tmp_bzrdir = BzrDir.open(tmpdir)
1075
tmp_repo = tmp_bzrdir.open_repository()
1076
tmp_repo.copy_content_into(destination, revision_id)
1078
osutils.rmtree(tmpdir)
1082
# TODO: Suggestion from john: using external tar is much faster than
1083
# python's tarfile library, but it may not work on windows.
1086
def inventories(self):
1087
"""Decorate the real repository for now.
1089
In the long term a full blown network facility is needed to
1090
avoid creating a real repository object locally.
1093
return self._real_repository.inventories
1097
"""Compress the data within the repository.
1099
This is not currently implemented within the smart server.
1102
return self._real_repository.pack()
1105
def revisions(self):
1106
"""Decorate the real repository for now.
1108
In the short term this should become a real object to intercept graph
1111
In the long term a full blown network facility is needed.
1114
return self._real_repository.revisions
1116
def set_make_working_trees(self, new_value):
1118
self._real_repository.set_make_working_trees(new_value)
1121
def signatures(self):
1122
"""Decorate the real repository for now.
1124
In the long term a full blown network facility is needed to avoid
1125
creating a real repository object locally.
1128
return self._real_repository.signatures
1131
def sign_revision(self, revision_id, gpg_strategy):
1133
return self._real_repository.sign_revision(revision_id, gpg_strategy)
1137
"""Decorate the real repository for now.
1139
In the long term a full blown network facility is needed to avoid
1140
creating a real repository object locally.
1143
return self._real_repository.texts
1146
def get_revisions(self, revision_ids):
1148
return self._real_repository.get_revisions(revision_ids)
1150
def supports_rich_root(self):
1152
return self._real_repository.supports_rich_root()
1154
def iter_reverse_revision_history(self, revision_id):
1156
return self._real_repository.iter_reverse_revision_history(revision_id)
1159
def _serializer(self):
1161
return self._real_repository._serializer
1163
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1165
return self._real_repository.store_revision_signature(
1166
gpg_strategy, plaintext, revision_id)
1168
def add_signature_text(self, revision_id, signature):
1170
return self._real_repository.add_signature_text(revision_id, signature)
1172
def has_signature_for_revision_id(self, revision_id):
1174
return self._real_repository.has_signature_for_revision_id(revision_id)
1176
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
1178
return self._real_repository.item_keys_introduced_by(revision_ids,
1179
_files_pb=_files_pb)
1181
def revision_graph_can_have_wrong_parents(self):
1182
# The answer depends on the remote repo format.
1184
return self._real_repository.revision_graph_can_have_wrong_parents()
1186
def _find_inconsistent_revision_parents(self):
1188
return self._real_repository._find_inconsistent_revision_parents()
1190
def _check_for_inconsistent_revision_parents(self):
1192
return self._real_repository._check_for_inconsistent_revision_parents()
1194
def _make_parents_provider(self, other=None):
1195
providers = [self._unstacked_provider]
1196
if other is not None:
1197
providers.insert(0, other)
1198
providers.extend(r._make_parents_provider() for r in
1199
self._fallback_repositories)
1200
return graph._StackedParentsProvider(providers)
1202
def _serialise_search_recipe(self, recipe):
1203
"""Serialise a graph search recipe.
1205
:param recipe: A search recipe (start, stop, count).
1206
:return: Serialised bytes.
1208
start_keys = ' '.join(recipe[0])
1209
stop_keys = ' '.join(recipe[1])
1210
count = str(recipe[2])
1211
return '\n'.join((start_keys, stop_keys, count))
1214
path = self.bzrdir._path_for_remote_call(self._client)
1216
response = self._call('PackRepository.autopack', path)
1217
except errors.UnknownSmartMethod:
1219
self._real_repository._pack_collection.autopack()
1221
if self._real_repository is not None:
1222
# Reset the real repository's cache of pack names.
1223
# XXX: At some point we may be able to skip this and just rely on
1224
# the automatic retry logic to do the right thing, but for now we
1225
# err on the side of being correct rather than being optimal.
1226
self._real_repository._pack_collection.reload_pack_names()
1227
if response[0] != 'ok':
1228
raise errors.UnexpectedSmartServerResponse(response)
1231
class RemoteBranchLockableFiles(LockableFiles):
1232
"""A 'LockableFiles' implementation that talks to a smart server.
1234
This is not a public interface class.
1237
def __init__(self, bzrdir, _client):
1238
self.bzrdir = bzrdir
1239
self._client = _client
1240
self._need_find_modes = True
1241
LockableFiles.__init__(
1242
self, bzrdir.get_branch_transport(None),
1243
'lock', lockdir.LockDir)
1245
def _find_modes(self):
1246
# RemoteBranches don't let the client set the mode of control files.
1247
self._dir_mode = None
1248
self._file_mode = None
1251
class RemoteBranchFormat(branch.BranchFormat):
1254
super(RemoteBranchFormat, self).__init__()
1255
self._matchingbzrdir = RemoteBzrDirFormat()
1256
self._matchingbzrdir.set_branch_format(self)
1258
def __eq__(self, other):
1259
return (isinstance(other, RemoteBranchFormat) and
1260
self.__dict__ == other.__dict__)
1262
def get_format_description(self):
1263
return 'Remote BZR Branch'
1265
def get_format_string(self):
1266
return 'Remote BZR Branch'
1268
def open(self, a_bzrdir):
1269
return a_bzrdir.open_branch()
1271
def initialize(self, a_bzrdir):
1272
return a_bzrdir.create_branch()
1274
def supports_tags(self):
1275
# Remote branches might support tags, but we won't know until we
1276
# access the real remote branch.
1280
class RemoteBranch(branch.Branch, _RpcHelper):
1281
"""Branch stored on a server accessed by HPSS RPC.
1283
At the moment most operations are mapped down to simple file operations.
1286
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
1288
"""Create a RemoteBranch instance.
1290
:param real_branch: An optional local implementation of the branch
1291
format, usually accessing the data via the VFS.
1292
:param _client: Private parameter for testing.
1294
# We intentionally don't call the parent class's __init__, because it
1295
# will try to assign to self.tags, which is a property in this subclass.
1296
# And the parent's __init__ doesn't do much anyway.
1297
self._revision_id_to_revno_cache = None
1298
self._partial_revision_id_to_revno_cache = {}
1299
self._revision_history_cache = None
1300
self._last_revision_info_cache = None
1301
self._merge_sorted_revisions_cache = None
1302
self.bzrdir = remote_bzrdir
1303
if _client is not None:
1304
self._client = _client
1306
self._client = remote_bzrdir._client
1307
self.repository = remote_repository
1308
if real_branch is not None:
1309
self._real_branch = real_branch
1310
# Give the remote repository the matching real repo.
1311
real_repo = self._real_branch.repository
1312
if isinstance(real_repo, RemoteRepository):
1313
real_repo._ensure_real()
1314
real_repo = real_repo._real_repository
1315
self.repository._set_real_repository(real_repo)
1316
# Give the branch the remote repository to let fast-pathing happen.
1317
self._real_branch.repository = self.repository
1319
self._real_branch = None
1320
# Fill out expected attributes of branch for bzrlib api users.
1321
self._format = RemoteBranchFormat()
1322
self.base = self.bzrdir.root_transport.base
1323
self._control_files = None
1324
self._lock_mode = None
1325
self._lock_token = None
1326
self._repo_lock_token = None
1327
self._lock_count = 0
1328
self._leave_lock = False
1329
# The base class init is not called, so we duplicate this:
1330
hooks = branch.Branch.hooks['open']
1333
self._setup_stacking()
1335
def _setup_stacking(self):
1336
# configure stacking into the remote repository, by reading it from
1339
fallback_url = self.get_stacked_on_url()
1340
except (errors.NotStacked, errors.UnstackableBranchFormat,
1341
errors.UnstackableRepositoryFormat), e:
1343
# it's relative to this branch...
1344
fallback_url = urlutils.join(self.base, fallback_url)
1345
transports = [self.bzrdir.root_transport]
1346
if self._real_branch is not None:
1347
transports.append(self._real_branch._transport)
1348
stacked_on = branch.Branch.open(fallback_url,
1349
possible_transports=transports)
1350
self.repository.add_fallback_repository(stacked_on.repository)
1352
def _get_real_transport(self):
1353
# if we try vfs access, return the real branch's vfs transport
1355
return self._real_branch._transport
1357
_transport = property(_get_real_transport)
1360
return "%s(%s)" % (self.__class__.__name__, self.base)
1364
def _ensure_real(self):
1365
"""Ensure that there is a _real_branch set.
1367
Used before calls to self._real_branch.
1369
if self._real_branch is None:
1370
if not vfs.vfs_enabled():
1371
raise AssertionError('smart server vfs must be enabled '
1372
'to use vfs implementation')
1373
self.bzrdir._ensure_real()
1374
self._real_branch = self.bzrdir._real_bzrdir.open_branch()
1375
if self.repository._real_repository is None:
1376
# Give the remote repository the matching real repo.
1377
real_repo = self._real_branch.repository
1378
if isinstance(real_repo, RemoteRepository):
1379
real_repo._ensure_real()
1380
real_repo = real_repo._real_repository
1381
self.repository._set_real_repository(real_repo)
1382
# Give the real branch the remote repository to let fast-pathing
1384
self._real_branch.repository = self.repository
1385
if self._lock_mode == 'r':
1386
self._real_branch.lock_read()
1387
elif self._lock_mode == 'w':
1388
self._real_branch.lock_write(token=self._lock_token)
1390
def _translate_error(self, err, **context):
1391
self.repository._translate_error(err, branch=self, **context)
1393
def _clear_cached_state(self):
1394
super(RemoteBranch, self)._clear_cached_state()
1395
if self._real_branch is not None:
1396
self._real_branch._clear_cached_state()
1398
def _clear_cached_state_of_remote_branch_only(self):
1399
"""Like _clear_cached_state, but doesn't clear the cache of
1402
This is useful when falling back to calling a method of
1403
self._real_branch that changes state. In that case the underlying
1404
branch changes, so we need to invalidate this RemoteBranch's cache of
1405
it. However, there's no need to invalidate the _real_branch's cache
1406
too, in fact doing so might harm performance.
1408
super(RemoteBranch, self)._clear_cached_state()
1411
def control_files(self):
1412
# Defer actually creating RemoteBranchLockableFiles until its needed,
1413
# because it triggers an _ensure_real that we otherwise might not need.
1414
if self._control_files is None:
1415
self._control_files = RemoteBranchLockableFiles(
1416
self.bzrdir, self._client)
1417
return self._control_files
1419
def _get_checkout_format(self):
1421
return self._real_branch._get_checkout_format()
1423
def get_physical_lock_status(self):
1424
"""See Branch.get_physical_lock_status()."""
1425
# should be an API call to the server, as branches must be lockable.
1427
return self._real_branch.get_physical_lock_status()
1429
def get_stacked_on_url(self):
1430
"""Get the URL this branch is stacked against.
1432
:raises NotStacked: If the branch is not stacked.
1433
:raises UnstackableBranchFormat: If the branch does not support
1435
:raises UnstackableRepositoryFormat: If the repository does not support
1439
# there may not be a repository yet, so we can't use
1440
# self._translate_error, so we can't use self._call either.
1441
response = self._client.call('Branch.get_stacked_on_url',
1442
self._remote_path())
1443
except errors.ErrorFromSmartServer, err:
1444
# there may not be a repository yet, so we can't call through
1445
# its _translate_error
1446
_translate_error(err, branch=self)
1447
except errors.UnknownSmartMethod, err:
1449
return self._real_branch.get_stacked_on_url()
1450
if response[0] != 'ok':
1451
raise errors.UnexpectedSmartServerResponse(response)
1454
def lock_read(self):
1455
self.repository.lock_read()
1456
if not self._lock_mode:
1457
self._lock_mode = 'r'
1458
self._lock_count = 1
1459
if self._real_branch is not None:
1460
self._real_branch.lock_read()
1462
self._lock_count += 1
1464
def _remote_lock_write(self, token):
1466
branch_token = repo_token = ''
1468
branch_token = token
1469
repo_token = self.repository.lock_write()
1470
self.repository.unlock()
1471
err_context = {'token': token}
1472
response = self._call(
1473
'Branch.lock_write', self._remote_path(), branch_token,
1474
repo_token or '', **err_context)
1475
if response[0] != 'ok':
1476
raise errors.UnexpectedSmartServerResponse(response)
1477
ok, branch_token, repo_token = response
1478
return branch_token, repo_token
1480
def lock_write(self, token=None):
1481
if not self._lock_mode:
1482
# Lock the branch and repo in one remote call.
1483
remote_tokens = self._remote_lock_write(token)
1484
self._lock_token, self._repo_lock_token = remote_tokens
1485
if not self._lock_token:
1486
raise SmartProtocolError('Remote server did not return a token!')
1487
# Tell the self.repository object that it is locked.
1488
self.repository.lock_write(
1489
self._repo_lock_token, _skip_rpc=True)
1491
if self._real_branch is not None:
1492
self._real_branch.lock_write(token=self._lock_token)
1493
if token is not None:
1494
self._leave_lock = True
1496
self._leave_lock = False
1497
self._lock_mode = 'w'
1498
self._lock_count = 1
1499
elif self._lock_mode == 'r':
1500
raise errors.ReadOnlyTransaction
1502
if token is not None:
1503
# A token was given to lock_write, and we're relocking, so
1504
# check that the given token actually matches the one we
1506
if token != self._lock_token:
1507
raise errors.TokenMismatch(token, self._lock_token)
1508
self._lock_count += 1
1509
# Re-lock the repository too.
1510
self.repository.lock_write(self._repo_lock_token)
1511
return self._lock_token or None
1513
def _unlock(self, branch_token, repo_token):
1514
err_context = {'token': str((branch_token, repo_token))}
1515
response = self._call(
1516
'Branch.unlock', self._remote_path(), branch_token,
1517
repo_token or '', **err_context)
1518
if response == ('ok',):
1520
raise errors.UnexpectedSmartServerResponse(response)
1524
self._lock_count -= 1
1525
if not self._lock_count:
1526
self._clear_cached_state()
1527
mode = self._lock_mode
1528
self._lock_mode = None
1529
if self._real_branch is not None:
1530
if (not self._leave_lock and mode == 'w' and
1531
self._repo_lock_token):
1532
# If this RemoteBranch will remove the physical lock
1533
# for the repository, make sure the _real_branch
1534
# doesn't do it first. (Because the _real_branch's
1535
# repository is set to be the RemoteRepository.)
1536
self._real_branch.repository.leave_lock_in_place()
1537
self._real_branch.unlock()
1539
# Only write-locked branched need to make a remote method
1540
# call to perfom the unlock.
1542
if not self._lock_token:
1543
raise AssertionError('Locked, but no token!')
1544
branch_token = self._lock_token
1545
repo_token = self._repo_lock_token
1546
self._lock_token = None
1547
self._repo_lock_token = None
1548
if not self._leave_lock:
1549
self._unlock(branch_token, repo_token)
1551
self.repository.unlock()
1553
def break_lock(self):
1555
return self._real_branch.break_lock()
1557
def leave_lock_in_place(self):
1558
if not self._lock_token:
1559
raise NotImplementedError(self.leave_lock_in_place)
1560
self._leave_lock = True
1562
def dont_leave_lock_in_place(self):
1563
if not self._lock_token:
1564
raise NotImplementedError(self.dont_leave_lock_in_place)
1565
self._leave_lock = False
1567
def _last_revision_info(self):
1568
response = self._call('Branch.last_revision_info', self._remote_path())
1569
if response[0] != 'ok':
1570
raise SmartProtocolError('unexpected response code %s' % (response,))
1571
revno = int(response[1])
1572
last_revision = response[2]
1573
return (revno, last_revision)
1575
def _gen_revision_history(self):
1576
"""See Branch._gen_revision_history()."""
1577
response_tuple, response_handler = self._call_expecting_body(
1578
'Branch.revision_history', self._remote_path())
1579
if response_tuple[0] != 'ok':
1580
raise errors.UnexpectedSmartServerResponse(response_tuple)
1581
result = response_handler.read_body_bytes().split('\x00')
1586
def _remote_path(self):
1587
return self.bzrdir._path_for_remote_call(self._client)
1589
def _set_last_revision_descendant(self, revision_id, other_branch,
1590
allow_diverged=False, allow_overwrite_descendant=False):
1591
err_context = {'other_branch': other_branch}
1592
response = self._call('Branch.set_last_revision_ex',
1593
self._remote_path(), self._lock_token, self._repo_lock_token,
1594
revision_id, int(allow_diverged), int(allow_overwrite_descendant),
1596
self._clear_cached_state()
1597
if len(response) != 3 and response[0] != 'ok':
1598
raise errors.UnexpectedSmartServerResponse(response)
1599
new_revno, new_revision_id = response[1:]
1600
self._last_revision_info_cache = new_revno, new_revision_id
1601
if self._real_branch is not None:
1602
cache = new_revno, new_revision_id
1603
self._real_branch._last_revision_info_cache = cache
1605
def _set_last_revision(self, revision_id):
1606
self._clear_cached_state()
1607
response = self._call('Branch.set_last_revision',
1608
self._remote_path(), self._lock_token, self._repo_lock_token,
1610
if response != ('ok',):
1611
raise errors.UnexpectedSmartServerResponse(response)
1614
def set_revision_history(self, rev_history):
1615
# Send just the tip revision of the history; the server will generate
1616
# the full history from that. If the revision doesn't exist in this
1617
# branch, NoSuchRevision will be raised.
1618
if rev_history == []:
1621
rev_id = rev_history[-1]
1622
self._set_last_revision(rev_id)
1623
self._cache_revision_history(rev_history)
1625
def get_parent(self):
1627
return self._real_branch.get_parent()
1629
def set_parent(self, url):
1631
return self._real_branch.set_parent(url)
1633
def set_stacked_on_url(self, stacked_location):
1634
"""Set the URL this branch is stacked against.
1636
:raises UnstackableBranchFormat: If the branch does not support
1638
:raises UnstackableRepositoryFormat: If the repository does not support
1642
return self._real_branch.set_stacked_on_url(stacked_location)
1644
def sprout(self, to_bzrdir, revision_id=None):
1645
branch_format = to_bzrdir._format._branch_format
1646
if (branch_format is None or
1647
isinstance(branch_format, RemoteBranchFormat)):
1648
# The to_bzrdir specifies RemoteBranchFormat (or no format, which
1649
# implies the same thing), but RemoteBranches can't be created at
1650
# arbitrary URLs. So create a branch in the same format as
1651
# _real_branch instead.
1652
# XXX: if to_bzrdir is a RemoteBzrDir, this should perhaps do
1653
# to_bzrdir.create_branch to create a RemoteBranch after all...
1655
result = self._real_branch._format.initialize(to_bzrdir)
1656
self.copy_content_into(result, revision_id=revision_id)
1657
result.set_parent(self.bzrdir.root_transport.base)
1659
result = branch.Branch.sprout(
1660
self, to_bzrdir, revision_id=revision_id)
1664
def pull(self, source, overwrite=False, stop_revision=None,
1666
self._clear_cached_state_of_remote_branch_only()
1668
return self._real_branch.pull(
1669
source, overwrite=overwrite, stop_revision=stop_revision,
1670
_override_hook_target=self, **kwargs)
1673
def push(self, target, overwrite=False, stop_revision=None):
1675
return self._real_branch.push(
1676
target, overwrite=overwrite, stop_revision=stop_revision,
1677
_override_hook_source_branch=self)
1679
def is_locked(self):
1680
return self._lock_count >= 1
1683
def revision_id_to_revno(self, revision_id):
1685
return self._real_branch.revision_id_to_revno(revision_id)
1688
def set_last_revision_info(self, revno, revision_id):
1689
revision_id = ensure_null(revision_id)
1691
response = self._call('Branch.set_last_revision_info',
1692
self._remote_path(), self._lock_token, self._repo_lock_token,
1693
str(revno), revision_id)
1694
except errors.UnknownSmartMethod:
1696
self._clear_cached_state_of_remote_branch_only()
1697
self._real_branch.set_last_revision_info(revno, revision_id)
1698
self._last_revision_info_cache = revno, revision_id
1700
if response == ('ok',):
1701
self._clear_cached_state()
1702
self._last_revision_info_cache = revno, revision_id
1703
# Update the _real_branch's cache too.
1704
if self._real_branch is not None:
1705
cache = self._last_revision_info_cache
1706
self._real_branch._last_revision_info_cache = cache
1708
raise errors.UnexpectedSmartServerResponse(response)
1711
def generate_revision_history(self, revision_id, last_rev=None,
1713
medium = self._client._medium
1714
if not medium._is_remote_before((1, 6)):
1716
self._set_last_revision_descendant(revision_id, other_branch,
1717
allow_diverged=True, allow_overwrite_descendant=True)
1719
except errors.UnknownSmartMethod:
1720
medium._remember_remote_is_before((1, 6))
1721
self._clear_cached_state_of_remote_branch_only()
1723
self._real_branch.generate_revision_history(
1724
revision_id, last_rev=last_rev, other_branch=other_branch)
1729
return self._real_branch.tags
1731
def set_push_location(self, location):
1733
return self._real_branch.set_push_location(location)
1736
def update_revisions(self, other, stop_revision=None, overwrite=False,
1738
"""See Branch.update_revisions."""
1741
if stop_revision is None:
1742
stop_revision = other.last_revision()
1743
if revision.is_null(stop_revision):
1744
# if there are no commits, we're done.
1746
self.fetch(other, stop_revision)
1749
# Just unconditionally set the new revision. We don't care if
1750
# the branches have diverged.
1751
self._set_last_revision(stop_revision)
1753
medium = self._client._medium
1754
if not medium._is_remote_before((1, 6)):
1756
self._set_last_revision_descendant(stop_revision, other)
1758
except errors.UnknownSmartMethod:
1759
medium._remember_remote_is_before((1, 6))
1760
# Fallback for pre-1.6 servers: check for divergence
1761
# client-side, then do _set_last_revision.
1762
last_rev = revision.ensure_null(self.last_revision())
1764
graph = self.repository.get_graph()
1765
if self._check_if_descendant_or_diverged(
1766
stop_revision, last_rev, graph, other):
1767
# stop_revision is a descendant of last_rev, but we aren't
1768
# overwriting, so we're done.
1770
self._set_last_revision(stop_revision)
1775
def _extract_tar(tar, to_dir):
1776
"""Extract all the contents of a tarfile object.
1778
A replacement for extractall, which is not present in python2.4
1781
tar.extract(tarinfo, to_dir)
1784
def _translate_error(err, **context):
1785
"""Translate an ErrorFromSmartServer into a more useful error.
1787
Possible context keys:
1795
If the error from the server doesn't match a known pattern, then
1796
UnknownErrorFromSmartServer is raised.
1800
return context[name]
1801
except KeyError, key_err:
1802
mutter('Missing key %r in context %r', key_err.args[0], context)
1805
"""Get the path from the context if present, otherwise use first error
1809
return context['path']
1810
except KeyError, key_err:
1812
return err.error_args[0]
1813
except IndexError, idx_err:
1815
'Missing key %r in context %r', key_err.args[0], context)
1818
if err.error_verb == 'NoSuchRevision':
1819
raise NoSuchRevision(find('branch'), err.error_args[0])
1820
elif err.error_verb == 'nosuchrevision':
1821
raise NoSuchRevision(find('repository'), err.error_args[0])
1822
elif err.error_tuple == ('nobranch',):
1823
raise errors.NotBranchError(path=find('bzrdir').root_transport.base)
1824
elif err.error_verb == 'norepository':
1825
raise errors.NoRepositoryPresent(find('bzrdir'))
1826
elif err.error_verb == 'LockContention':
1827
raise errors.LockContention('(remote lock)')
1828
elif err.error_verb == 'UnlockableTransport':
1829
raise errors.UnlockableTransport(find('bzrdir').root_transport)
1830
elif err.error_verb == 'LockFailed':
1831
raise errors.LockFailed(err.error_args[0], err.error_args[1])
1832
elif err.error_verb == 'TokenMismatch':
1833
raise errors.TokenMismatch(find('token'), '(remote token)')
1834
elif err.error_verb == 'Diverged':
1835
raise errors.DivergedBranches(find('branch'), find('other_branch'))
1836
elif err.error_verb == 'TipChangeRejected':
1837
raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
1838
elif err.error_verb == 'UnstackableBranchFormat':
1839
raise errors.UnstackableBranchFormat(*err.error_args)
1840
elif err.error_verb == 'UnstackableRepositoryFormat':
1841
raise errors.UnstackableRepositoryFormat(*err.error_args)
1842
elif err.error_verb == 'NotStacked':
1843
raise errors.NotStacked(branch=find('branch'))
1844
elif err.error_verb == 'PermissionDenied':
1846
if len(err.error_args) >= 2:
1847
extra = err.error_args[1]
1850
raise errors.PermissionDenied(path, extra=extra)
1851
elif err.error_verb == 'ReadError':
1853
raise errors.ReadError(path)
1854
elif err.error_verb == 'NoSuchFile':
1856
raise errors.NoSuchFile(path)
1857
elif err.error_verb == 'FileExists':
1858
raise errors.FileExists(err.error_args[0])
1859
elif err.error_verb == 'DirectoryNotEmpty':
1860
raise errors.DirectoryNotEmpty(err.error_args[0])
1861
elif err.error_verb == 'ShortReadvError':
1862
args = err.error_args
1863
raise errors.ShortReadvError(
1864
args[0], int(args[1]), int(args[2]), int(args[3]))
1865
elif err.error_verb in ('UnicodeEncodeError', 'UnicodeDecodeError'):
1866
encoding = str(err.error_args[0]) # encoding must always be a string
1867
val = err.error_args[1]
1868
start = int(err.error_args[2])
1869
end = int(err.error_args[3])
1870
reason = str(err.error_args[4]) # reason must always be a string
1871
if val.startswith('u:'):
1872
val = val[2:].decode('utf-8')
1873
elif val.startswith('s:'):
1874
val = val[2:].decode('base64')
1875
if err.error_verb == 'UnicodeDecodeError':
1876
raise UnicodeDecodeError(encoding, val, start, end, reason)
1877
elif err.error_verb == 'UnicodeEncodeError':
1878
raise UnicodeEncodeError(encoding, val, start, end, reason)
1879
elif err.error_verb == 'ReadOnlyError':
1880
raise errors.TransportNotPossible('readonly transport')
1881
raise errors.UnknownErrorFromSmartServer(err)