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.
21
from cStringIO import StringIO
34
from bzrlib.branch import BranchReferenceFormat
35
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
36
from bzrlib.decorators import needs_read_lock, needs_write_lock
37
from bzrlib.errors import (
41
from bzrlib.lockable_files import LockableFiles
42
from bzrlib.smart import client, vfs
43
from bzrlib.revision import ensure_null, NULL_REVISION
44
from bzrlib.trace import mutter, note, warning
45
from bzrlib.versionedfile import VersionedFiles
48
# Note: RemoteBzrDirFormat is in bzrdir.py
50
class RemoteBzrDir(BzrDir):
51
"""Control directory on a remote server, accessed via bzr:// or similar."""
53
def __init__(self, transport, _client=None):
54
"""Construct a RemoteBzrDir.
56
:param _client: Private parameter for testing. Disables probing and the
59
BzrDir.__init__(self, transport, RemoteBzrDirFormat())
60
# this object holds a delegated bzrdir that uses file-level operations
61
# to talk to the other side
62
self._real_bzrdir = None
65
medium = transport.get_smart_medium()
66
self._client = client._SmartClient(medium)
68
self._client = _client
71
path = self._path_for_remote_call(self._client)
72
response = self._client.call('BzrDir.open', path)
73
if response not in [('yes',), ('no',)]:
74
raise errors.UnexpectedSmartServerResponse(response)
75
if response == ('no',):
76
raise errors.NotBranchError(path=transport.base)
78
def _ensure_real(self):
79
"""Ensure that there is a _real_bzrdir set.
81
Used before calls to self._real_bzrdir.
83
if not self._real_bzrdir:
84
self._real_bzrdir = BzrDir.open_from_transport(
85
self.root_transport, _server_formats=False)
87
def cloning_metadir(self, stacked=False):
89
return self._real_bzrdir.cloning_metadir(stacked)
91
def _translate_error(self, err, **context):
92
_translate_error(err, bzrdir=self, **context)
94
def create_repository(self, shared=False):
96
self._real_bzrdir.create_repository(shared=shared)
97
return self.open_repository()
99
def destroy_repository(self):
100
"""See BzrDir.destroy_repository"""
102
self._real_bzrdir.destroy_repository()
104
def create_branch(self):
106
real_branch = self._real_bzrdir.create_branch()
107
return RemoteBranch(self, self.find_repository(), real_branch)
109
def destroy_branch(self):
110
"""See BzrDir.destroy_branch"""
112
self._real_bzrdir.destroy_branch()
114
def create_workingtree(self, revision_id=None, from_branch=None):
115
raise errors.NotLocalUrl(self.transport.base)
117
def find_branch_format(self):
118
"""Find the branch 'format' for this bzrdir.
120
This might be a synthetic object for e.g. RemoteBranch and SVN.
122
b = self.open_branch()
125
def get_branch_reference(self):
126
"""See BzrDir.get_branch_reference()."""
127
path = self._path_for_remote_call(self._client)
129
response = self._client.call('BzrDir.open_branch', path)
130
except errors.ErrorFromSmartServer, err:
131
self._translate_error(err)
132
if response[0] == 'ok':
133
if response[1] == '':
134
# branch at this location.
137
# a branch reference, use the existing BranchReference logic.
140
raise errors.UnexpectedSmartServerResponse(response)
142
def _get_tree_branch(self):
143
"""See BzrDir._get_tree_branch()."""
144
return None, self.open_branch()
146
def open_branch(self, _unsupported=False):
148
raise NotImplementedError('unsupported flag support not implemented yet.')
149
reference_url = self.get_branch_reference()
150
if reference_url is None:
151
# branch at this location.
152
return RemoteBranch(self, self.find_repository())
154
# a branch reference, use the existing BranchReference logic.
155
format = BranchReferenceFormat()
156
return format.open(self, _found=True, location=reference_url)
158
def open_repository(self):
159
path = self._path_for_remote_call(self._client)
160
verb = 'BzrDir.find_repositoryV2'
163
response = self._client.call(verb, path)
164
except errors.UnknownSmartMethod:
165
verb = 'BzrDir.find_repository'
166
response = self._client.call(verb, path)
167
except errors.ErrorFromSmartServer, err:
168
self._translate_error(err)
169
if response[0] != 'ok':
170
raise errors.UnexpectedSmartServerResponse(response)
171
if verb == 'BzrDir.find_repository':
172
# servers that don't support the V2 method don't support external
174
response = response + ('no', )
175
if not (len(response) == 5):
176
raise SmartProtocolError('incorrect response length %s' % (response,))
177
if response[1] == '':
178
format = RemoteRepositoryFormat()
179
format.rich_root_data = (response[2] == 'yes')
180
format.supports_tree_reference = (response[3] == 'yes')
181
# No wire format to check this yet.
182
format.supports_external_lookups = (response[4] == 'yes')
183
# Used to support creating a real format instance when needed.
184
format._creating_bzrdir = self
185
return RemoteRepository(self, format)
187
raise errors.NoRepositoryPresent(self)
189
def open_workingtree(self, recommend_upgrade=True):
191
if self._real_bzrdir.has_workingtree():
192
raise errors.NotLocalUrl(self.root_transport)
194
raise errors.NoWorkingTree(self.root_transport.base)
196
def _path_for_remote_call(self, client):
197
"""Return the path to be used for this bzrdir in a remote call."""
198
return client.remote_path_from_transport(self.root_transport)
200
def get_branch_transport(self, branch_format):
202
return self._real_bzrdir.get_branch_transport(branch_format)
204
def get_repository_transport(self, repository_format):
206
return self._real_bzrdir.get_repository_transport(repository_format)
208
def get_workingtree_transport(self, workingtree_format):
210
return self._real_bzrdir.get_workingtree_transport(workingtree_format)
212
def can_convert_format(self):
213
"""Upgrading of remote bzrdirs is not supported yet."""
216
def needs_format_conversion(self, format=None):
217
"""Upgrading of remote bzrdirs is not supported yet."""
220
def clone(self, url, revision_id=None, force_new_repo=False,
221
preserve_stacking=False):
223
return self._real_bzrdir.clone(url, revision_id=revision_id,
224
force_new_repo=force_new_repo, preserve_stacking=preserve_stacking)
226
def get_config(self):
228
return self._real_bzrdir.get_config()
231
class RemoteRepositoryFormat(repository.RepositoryFormat):
232
"""Format for repositories accessed over a _SmartClient.
234
Instances of this repository are represented by RemoteRepository
237
The RemoteRepositoryFormat is parameterized during construction
238
to reflect the capabilities of the real, remote format. Specifically
239
the attributes rich_root_data and supports_tree_reference are set
240
on a per instance basis, and are not set (and should not be) at
244
_matchingbzrdir = RemoteBzrDirFormat()
246
def initialize(self, a_bzrdir, shared=False):
247
if not isinstance(a_bzrdir, RemoteBzrDir):
248
prior_repo = self._creating_bzrdir.open_repository()
249
prior_repo._ensure_real()
250
return prior_repo._real_repository._format.initialize(
251
a_bzrdir, shared=shared)
252
return a_bzrdir.create_repository(shared=shared)
254
def open(self, a_bzrdir):
255
if not isinstance(a_bzrdir, RemoteBzrDir):
256
raise AssertionError('%r is not a RemoteBzrDir' % (a_bzrdir,))
257
return a_bzrdir.open_repository()
259
def get_format_description(self):
260
return 'bzr remote repository'
262
def __eq__(self, other):
263
return self.__class__ == other.__class__
265
def check_conversion_target(self, target_format):
266
if self.rich_root_data and not target_format.rich_root_data:
267
raise errors.BadConversionTarget(
268
'Does not support rich root data.', target_format)
269
if (self.supports_tree_reference and
270
not getattr(target_format, 'supports_tree_reference', False)):
271
raise errors.BadConversionTarget(
272
'Does not support nested trees', target_format)
275
class RemoteRepository(object):
276
"""Repository accessed over rpc.
278
For the moment most operations are performed using local transport-backed
282
def __init__(self, remote_bzrdir, format, real_repository=None, _client=None):
283
"""Create a RemoteRepository instance.
285
:param remote_bzrdir: The bzrdir hosting this repository.
286
:param format: The RemoteFormat object to use.
287
:param real_repository: If not None, a local implementation of the
288
repository logic for the repository, usually accessing the data
290
:param _client: Private testing parameter - override the smart client
291
to be used by the repository.
294
self._real_repository = real_repository
296
self._real_repository = None
297
self.bzrdir = remote_bzrdir
299
self._client = remote_bzrdir._client
301
self._client = _client
302
self._format = format
303
self._lock_mode = None
304
self._lock_token = None
306
self._leave_lock = False
307
# A cache of looked up revision parent data; reset at unlock time.
308
self._parents_map = None
309
if 'hpss' in debug.debug_flags:
310
self._requested_parents = None
312
# These depend on the actual remote format, so force them off for
313
# maximum compatibility. XXX: In future these should depend on the
314
# remote repository instance, but this is irrelevant until we perform
315
# reconcile via an RPC call.
316
self._reconcile_does_inventory_gc = False
317
self._reconcile_fixes_text_parents = False
318
self._reconcile_backsup_inventory = False
319
self.base = self.bzrdir.transport.base
320
# Additional places to query for data.
321
self._fallback_repositories = []
322
self.texts = RemoteVersionedFiles(self, 'texts')
323
self.inventories = RemoteVersionedFiles(self, 'inventories')
324
self.signatures = RemoteVersionedFiles(self, 'signatures')
325
self.revisions = RemoteVersionedFiles(self, 'revisions')
327
self.texts, self.inventories, self.signatures, self.revisions]
330
return "%s(%s)" % (self.__class__.__name__, self.base)
334
def abort_write_group(self):
335
"""Complete a write group on the decorated repository.
337
Smart methods peform operations in a single step so this api
338
is not really applicable except as a compatibility thunk
339
for older plugins that don't use e.g. the CommitBuilder
343
return self._real_repository.abort_write_group()
345
def commit_write_group(self):
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
354
return self._real_repository.commit_write_group()
356
def _ensure_real(self):
357
"""Ensure that there is a _real_repository set.
359
Used before calls to self._real_repository.
361
if self._real_repository is None:
362
self.bzrdir._ensure_real()
363
self._set_real_repository(
364
self.bzrdir._real_bzrdir.open_repository())
366
def _translate_error(self, err, **context):
367
self.bzrdir._translate_error(err, repository=self, **context)
369
def find_text_key_references(self):
370
"""Find the text key references within the repository.
372
:return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
373
revision_ids. Each altered file-ids has the exact revision_ids that
374
altered it listed explicitly.
375
:return: A dictionary mapping text keys ((fileid, revision_id) tuples)
376
to whether they were referred to by the inventory of the
377
revision_id that they contain. The inventory texts from all present
378
revision ids are assessed to generate this report.
381
return self._real_repository.find_text_key_references()
383
def _generate_text_key_index(self):
384
"""Generate a new text key index for the repository.
386
This is an expensive function that will take considerable time to run.
388
:return: A dict mapping (file_id, revision_id) tuples to a list of
389
parents, also (file_id, revision_id) tuples.
392
return self._real_repository._generate_text_key_index()
394
@symbol_versioning.deprecated_method(symbol_versioning.one_four)
395
def get_revision_graph(self, revision_id=None):
396
"""See Repository.get_revision_graph()."""
397
return self._get_revision_graph(revision_id)
399
def _get_revision_graph(self, revision_id):
400
"""Private method for using with old (< 1.2) servers to fallback."""
401
if revision_id is None:
403
elif revision.is_null(revision_id):
406
path = self.bzrdir._path_for_remote_call(self._client)
408
response = self._client.call_expecting_body(
409
'Repository.get_revision_graph', path, revision_id)
410
except errors.ErrorFromSmartServer, err:
411
self._translate_error(err)
412
response_tuple, response_handler = response
413
if response_tuple[0] != 'ok':
414
raise errors.UnexpectedSmartServerResponse(response_tuple)
415
coded = response_handler.read_body_bytes()
417
# no revisions in this repository!
419
lines = coded.split('\n')
422
d = tuple(line.split())
423
revision_graph[d[0]] = d[1:]
425
return revision_graph
427
def has_revision(self, revision_id):
428
"""See Repository.has_revision()."""
429
if revision_id == NULL_REVISION:
430
# The null revision is always present.
432
path = self.bzrdir._path_for_remote_call(self._client)
433
response = self._client.call(
434
'Repository.has_revision', path, revision_id)
435
if response[0] not in ('yes', 'no'):
436
raise errors.UnexpectedSmartServerResponse(response)
437
if response[0] == 'yes':
439
for fallback_repo in self._fallback_repositories:
440
if fallback_repo.has_revision(revision_id):
444
def has_revisions(self, revision_ids):
445
"""See Repository.has_revisions()."""
446
# FIXME: This does many roundtrips, particularly when there are
447
# fallback repositories. -- mbp 20080905
449
for revision_id in revision_ids:
450
if self.has_revision(revision_id):
451
result.add(revision_id)
454
def has_same_location(self, other):
455
return (self.__class__ == other.__class__ and
456
self.bzrdir.transport.base == other.bzrdir.transport.base)
458
def get_graph(self, other_repository=None):
459
"""Return the graph for this repository format"""
460
parents_provider = self
461
if (other_repository is not None and
462
other_repository.bzrdir.transport.base !=
463
self.bzrdir.transport.base):
464
parents_provider = graph._StackedParentsProvider(
465
[parents_provider, other_repository._make_parents_provider()])
466
return graph.Graph(parents_provider)
468
def gather_stats(self, revid=None, committers=None):
469
"""See Repository.gather_stats()."""
470
path = self.bzrdir._path_for_remote_call(self._client)
471
# revid can be None to indicate no revisions, not just NULL_REVISION
472
if revid is None or revision.is_null(revid):
476
if committers is None or not committers:
477
fmt_committers = 'no'
479
fmt_committers = 'yes'
480
response_tuple, response_handler = self._client.call_expecting_body(
481
'Repository.gather_stats', path, fmt_revid, fmt_committers)
482
if response_tuple[0] != 'ok':
483
raise errors.UnexpectedSmartServerResponse(response_tuple)
485
body = response_handler.read_body_bytes()
487
for line in body.split('\n'):
490
key, val_text = line.split(':')
491
if key in ('revisions', 'size', 'committers'):
492
result[key] = int(val_text)
493
elif key in ('firstrev', 'latestrev'):
494
values = val_text.split(' ')[1:]
495
result[key] = (float(values[0]), long(values[1]))
499
def find_branches(self, using=False):
500
"""See Repository.find_branches()."""
501
# should be an API call to the server.
503
return self._real_repository.find_branches(using=using)
505
def get_physical_lock_status(self):
506
"""See Repository.get_physical_lock_status()."""
507
# should be an API call to the server.
509
return self._real_repository.get_physical_lock_status()
511
def is_in_write_group(self):
512
"""Return True if there is an open write group.
514
write groups are only applicable locally for the smart server..
516
if self._real_repository:
517
return self._real_repository.is_in_write_group()
520
return self._lock_count >= 1
523
"""See Repository.is_shared()."""
524
path = self.bzrdir._path_for_remote_call(self._client)
525
response = self._client.call('Repository.is_shared', path)
526
if response[0] not in ('yes', 'no'):
527
raise SmartProtocolError('unexpected response code %s' % (response,))
528
return response[0] == 'yes'
530
def is_write_locked(self):
531
return self._lock_mode == 'w'
534
# wrong eventually - want a local lock cache context
535
if not self._lock_mode:
536
self._lock_mode = 'r'
538
self._parents_map = {}
539
for vf in self._vf_objs:
541
if 'hpss' in debug.debug_flags:
542
self._requested_parents = set()
543
if self._real_repository is not None:
544
self._real_repository.lock_read()
546
self._lock_count += 1
548
def _remote_lock_write(self, token):
549
path = self.bzrdir._path_for_remote_call(self._client)
553
response = self._client.call('Repository.lock_write', path, token)
554
except errors.ErrorFromSmartServer, err:
555
self._translate_error(err, token=token)
557
if response[0] == 'ok':
561
raise errors.UnexpectedSmartServerResponse(response)
563
def lock_write(self, token=None, _skip_rpc=False):
564
if not self._lock_mode:
566
if self._lock_token is not None:
567
if token != self._lock_token:
568
raise errors.TokenMismatch(token, self._lock_token)
569
self._lock_token = token
571
self._lock_token = self._remote_lock_write(token)
572
# if self._lock_token is None, then this is something like packs or
573
# svn where we don't get to lock the repo, or a weave style repository
574
# where we cannot lock it over the wire and attempts to do so will
576
if self._real_repository is not None:
577
self._real_repository.lock_write(token=self._lock_token)
578
if token is not None:
579
self._leave_lock = True
581
self._leave_lock = False
582
self._lock_mode = 'w'
584
self._parents_map = {}
585
for vf in self._vf_objs:
587
if 'hpss' in debug.debug_flags:
588
self._requested_parents = set()
589
elif self._lock_mode == 'r':
590
raise errors.ReadOnlyError(self)
592
self._lock_count += 1
593
return self._lock_token or None
595
def leave_lock_in_place(self):
596
if not self._lock_token:
597
raise NotImplementedError(self.leave_lock_in_place)
598
self._leave_lock = True
600
def dont_leave_lock_in_place(self):
601
if not self._lock_token:
602
raise NotImplementedError(self.dont_leave_lock_in_place)
603
self._leave_lock = False
605
def _set_real_repository(self, repository):
606
"""Set the _real_repository for this repository.
608
:param repository: The repository to fallback to for non-hpss
609
implemented operations.
611
if self._real_repository is not None:
612
raise AssertionError('_real_repository is already set')
613
if isinstance(repository, RemoteRepository):
614
raise AssertionError()
615
self._real_repository = repository
616
for fb in self._fallback_repositories:
617
self._real_repository.add_fallback_repository(fb)
618
if self._lock_mode == 'w':
619
# if we are already locked, the real repository must be able to
620
# acquire the lock with our token.
621
self._real_repository.lock_write(self._lock_token)
622
elif self._lock_mode == 'r':
623
self._real_repository.lock_read()
625
def start_write_group(self):
626
"""Start a write group on the decorated repository.
628
Smart methods peform operations in a single step so this api
629
is not really applicable except as a compatibility thunk
630
for older plugins that don't use e.g. the CommitBuilder
634
return self._real_repository.start_write_group()
636
def _unlock(self, token):
637
path = self.bzrdir._path_for_remote_call(self._client)
639
# with no token the remote repository is not persistently locked.
642
response = self._client.call('Repository.unlock', path, token)
643
except errors.ErrorFromSmartServer, err:
644
self._translate_error(err, token=token)
645
if response == ('ok',):
648
raise errors.UnexpectedSmartServerResponse(response)
651
self._lock_count -= 1
652
if self._lock_count > 0:
654
self._parents_map = None
655
for vf in self._vf_objs:
656
vf._parents_map = None
657
if 'hpss' in debug.debug_flags:
658
self._requested_parents = None
659
old_mode = self._lock_mode
660
self._lock_mode = None
662
# The real repository is responsible at present for raising an
663
# exception if it's in an unfinished write group. However, it
664
# normally will *not* actually remove the lock from disk - that's
665
# done by the server on receiving the Repository.unlock call.
666
# This is just to let the _real_repository stay up to date.
667
if self._real_repository is not None:
668
self._real_repository.unlock()
670
# The rpc-level lock should be released even if there was a
671
# problem releasing the vfs-based lock.
673
# Only write-locked repositories need to make a remote method
674
# call to perfom the unlock.
675
old_token = self._lock_token
676
self._lock_token = None
677
if not self._leave_lock:
678
self._unlock(old_token)
680
def break_lock(self):
681
# should hand off to the network
683
return self._real_repository.break_lock()
685
def _get_tarball(self, compression):
686
"""Return a TemporaryFile containing a repository tarball.
688
Returns None if the server does not support sending tarballs.
691
path = self.bzrdir._path_for_remote_call(self._client)
693
response, protocol = self._client.call_expecting_body(
694
'Repository.tarball', path, compression)
695
except errors.UnknownSmartMethod:
696
protocol.cancel_read_body()
698
if response[0] == 'ok':
699
# Extract the tarball and return it
700
t = tempfile.NamedTemporaryFile()
701
# TODO: rpc layer should read directly into it...
702
t.write(protocol.read_body_bytes())
705
raise errors.UnexpectedSmartServerResponse(response)
707
def sprout(self, to_bzrdir, revision_id=None):
708
# TODO: Option to control what format is created?
710
dest_repo = self._real_repository._format.initialize(to_bzrdir,
712
dest_repo.fetch(self, revision_id=revision_id)
715
### These methods are just thin shims to the VFS object for now.
717
def revision_tree(self, revision_id):
719
return self._real_repository.revision_tree(revision_id)
721
def get_serializer_format(self):
723
return self._real_repository.get_serializer_format()
725
def get_commit_builder(self, branch, parents, config, timestamp=None,
726
timezone=None, committer=None, revprops=None,
728
# FIXME: It ought to be possible to call this without immediately
729
# triggering _ensure_real. For now it's the easiest thing to do.
731
real_repo = self._real_repository
732
builder = real_repo.get_commit_builder(branch, parents,
733
config, timestamp=timestamp, timezone=timezone,
734
committer=committer, revprops=revprops, revision_id=revision_id)
737
def add_fallback_repository(self, repository):
738
"""Add a repository to use for looking up data not held locally.
740
:param repository: A repository.
742
# XXX: At the moment the RemoteRepository will allow fallbacks
743
# unconditionally - however, a _real_repository will usually exist,
744
# and may raise an error if it's not accommodated by the underlying
745
# format. Eventually we should check when opening the repository
746
# whether it's willing to allow them or not.
748
# We need to accumulate additional repositories here, to pass them in
750
self._fallback_repositories.append(repository)
751
# They are also seen by the fallback repository. If it doesn't exist
752
# yet they'll be added then. This implicitly copies them.
755
def add_inventory(self, revid, inv, parents):
757
return self._real_repository.add_inventory(revid, inv, parents)
759
def add_revision(self, rev_id, rev, inv=None, config=None):
761
return self._real_repository.add_revision(
762
rev_id, rev, inv=inv, config=config)
765
def get_inventory(self, revision_id):
767
return self._real_repository.get_inventory(revision_id)
769
def iter_inventories(self, revision_ids):
771
return self._real_repository.iter_inventories(revision_ids)
774
def get_revision(self, revision_id):
776
return self._real_repository.get_revision(revision_id)
778
def get_transaction(self):
780
return self._real_repository.get_transaction()
783
def clone(self, a_bzrdir, revision_id=None):
785
return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
787
def make_working_trees(self):
788
"""See Repository.make_working_trees"""
790
return self._real_repository.make_working_trees()
792
def revision_ids_to_search_result(self, result_set):
793
"""Convert a set of revision ids to a graph SearchResult."""
794
result_parents = set()
795
for parents in self.get_graph().get_parent_map(
796
result_set).itervalues():
797
result_parents.update(parents)
798
included_keys = result_set.intersection(result_parents)
799
start_keys = result_set.difference(included_keys)
800
exclude_keys = result_parents.difference(result_set)
801
result = graph.SearchResult(start_keys, exclude_keys,
802
len(result_set), result_set)
806
def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
807
"""Return the revision ids that other has that this does not.
809
These are returned in topological order.
811
revision_id: only return revision ids included by revision_id.
813
return repository.InterRepository.get(
814
other, self).search_missing_revision_ids(revision_id, find_ghosts)
816
def fetch(self, source, revision_id=None, pb=None):
817
if self.has_same_location(source):
818
# check that last_revision is in 'from' and then return a
820
if (revision_id is not None and
821
not revision.is_null(revision_id)):
822
self.get_revision(revision_id)
825
return self._real_repository.fetch(
826
source, revision_id=revision_id, pb=pb)
828
def create_bundle(self, target, base, fileobj, format=None):
830
self._real_repository.create_bundle(target, base, fileobj, format)
833
def get_ancestry(self, revision_id, topo_sorted=True):
835
return self._real_repository.get_ancestry(revision_id, topo_sorted)
837
def fileids_altered_by_revision_ids(self, revision_ids):
839
return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
841
def _get_versioned_file_checker(self, revisions, revision_versions_cache):
843
return self._real_repository._get_versioned_file_checker(
844
revisions, revision_versions_cache)
846
def iter_files_bytes(self, desired_files):
847
"""See Repository.iter_file_bytes.
850
return self._real_repository.iter_files_bytes(desired_files)
853
def _fetch_order(self):
854
"""Decorate the real repository for now.
856
In the long term getting this back from the remote repository as part
857
of open would be more efficient.
860
return self._real_repository._fetch_order
863
def _fetch_uses_deltas(self):
864
"""Decorate the real repository for now.
866
In the long term getting this back from the remote repository as part
867
of open would be more efficient.
870
return self._real_repository._fetch_uses_deltas
873
def _fetch_reconcile(self):
874
"""Decorate the real repository for now.
876
In the long term getting this back from the remote repository as part
877
of open would be more efficient.
880
return self._real_repository._fetch_reconcile
882
def get_parent_map(self, keys):
883
"""See bzrlib.Graph.get_parent_map()."""
884
# Hack to build up the caching logic.
885
ancestry = self._parents_map
887
# Repository is not locked, so there's no cache.
888
missing_revisions = set(keys)
891
missing_revisions = set(key for key in keys if key not in ancestry)
892
if missing_revisions:
893
parent_map = self._get_parent_map(missing_revisions)
894
if 'hpss' in debug.debug_flags:
895
mutter('retransmitted revisions: %d of %d',
896
len(set(ancestry).intersection(parent_map)),
898
ancestry.update(parent_map)
899
present_keys = [k for k in keys if k in ancestry]
900
if 'hpss' in debug.debug_flags:
901
if self._requested_parents is not None and len(ancestry) != 0:
902
self._requested_parents.update(present_keys)
903
mutter('Current RemoteRepository graph hit rate: %d%%',
904
100.0 * len(self._requested_parents) / len(ancestry))
905
return dict((k, ancestry[k]) for k in present_keys)
907
def _get_parent_map(self, keys):
908
"""Helper for get_parent_map that performs the RPC."""
909
medium = self._client._medium
910
if medium._is_remote_before((1, 2)):
911
# We already found out that the server can't understand
912
# Repository.get_parent_map requests, so just fetch the whole
914
# XXX: Note that this will issue a deprecation warning. This is ok
915
# :- its because we're working with a deprecated server anyway, and
916
# the user will almost certainly have seen a warning about the
917
# server version already.
918
rg = self.get_revision_graph()
919
# There is an api discrepency between get_parent_map and
920
# get_revision_graph. Specifically, a "key:()" pair in
921
# get_revision_graph just means a node has no parents. For
922
# "get_parent_map" it means the node is a ghost. So fix up the
923
# graph to correct this.
924
# https://bugs.launchpad.net/bzr/+bug/214894
925
# There is one other "bug" which is that ghosts in
926
# get_revision_graph() are not returned at all. But we won't worry
927
# about that for now.
928
for node_id, parent_ids in rg.iteritems():
930
rg[node_id] = (NULL_REVISION,)
931
rg[NULL_REVISION] = ()
936
raise ValueError('get_parent_map(None) is not valid')
937
if NULL_REVISION in keys:
938
keys.discard(NULL_REVISION)
939
found_parents = {NULL_REVISION:()}
944
# TODO(Needs analysis): We could assume that the keys being requested
945
# from get_parent_map are in a breadth first search, so typically they
946
# will all be depth N from some common parent, and we don't have to
947
# have the server iterate from the root parent, but rather from the
948
# keys we're searching; and just tell the server the keyspace we
949
# already have; but this may be more traffic again.
951
# Transform self._parents_map into a search request recipe.
952
# TODO: Manage this incrementally to avoid covering the same path
953
# repeatedly. (The server will have to on each request, but the less
954
# work done the better).
955
parents_map = self._parents_map
956
if parents_map is None:
957
# Repository is not locked, so there's no cache.
959
start_set = set(parents_map)
960
result_parents = set()
961
for parents in parents_map.itervalues():
962
result_parents.update(parents)
963
stop_keys = result_parents.difference(start_set)
964
included_keys = start_set.intersection(result_parents)
965
start_set.difference_update(included_keys)
966
recipe = (start_set, stop_keys, len(parents_map))
967
path = self.bzrdir._path_for_remote_call(self._client)
969
if type(key) is not str:
971
"key %r not a plain string" % (key,))
972
verb = 'Repository.get_parent_map'
973
args = (path,) + tuple(keys)
975
response = self._client.call_with_body_bytes_expecting_body(
976
verb, args, _serialise_search_recipe(recipe))
977
except errors.UnknownSmartMethod:
978
# Server does not support this method, so get the whole graph.
979
# Worse, we have to force a disconnection, because the server now
980
# doesn't realise it has a body on the wire to consume, so the
981
# only way to recover is to abandon the connection.
983
'Server is too old for fast get_parent_map, reconnecting. '
984
'(Upgrade the server to Bazaar 1.2 to avoid this)')
986
# To avoid having to disconnect repeatedly, we keep track of the
987
# fact the server doesn't understand remote methods added in 1.2.
988
medium._remember_remote_is_before((1, 2))
989
return self.get_revision_graph(None)
990
response_tuple, response_handler = response
991
if response_tuple[0] not in ['ok']:
992
response_handler.cancel_read_body()
993
raise errors.UnexpectedSmartServerResponse(response_tuple)
994
if response_tuple[0] == 'ok':
995
coded = bz2.decompress(response_handler.read_body_bytes())
999
lines = coded.split('\n')
1002
d = tuple(line.split())
1004
revision_graph[d[0]] = d[1:]
1006
# No parents - so give the Graph result (NULL_REVISION,).
1007
revision_graph[d[0]] = (NULL_REVISION,)
1008
return revision_graph
1011
def get_signature_text(self, revision_id):
1013
return self._real_repository.get_signature_text(revision_id)
1016
@symbol_versioning.deprecated_method(symbol_versioning.one_three)
1017
def get_revision_graph_with_ghosts(self, revision_ids=None):
1019
return self._real_repository.get_revision_graph_with_ghosts(
1020
revision_ids=revision_ids)
1023
def get_inventory_xml(self, revision_id):
1025
return self._real_repository.get_inventory_xml(revision_id)
1027
def deserialise_inventory(self, revision_id, xml):
1029
return self._real_repository.deserialise_inventory(revision_id, xml)
1031
def reconcile(self, other=None, thorough=False):
1033
return self._real_repository.reconcile(other=other, thorough=thorough)
1035
def all_revision_ids(self):
1037
return self._real_repository.all_revision_ids()
1040
def get_deltas_for_revisions(self, revisions):
1042
return self._real_repository.get_deltas_for_revisions(revisions)
1045
def get_revision_delta(self, revision_id):
1047
return self._real_repository.get_revision_delta(revision_id)
1050
def revision_trees(self, revision_ids):
1052
return self._real_repository.revision_trees(revision_ids)
1055
def get_revision_reconcile(self, revision_id):
1057
return self._real_repository.get_revision_reconcile(revision_id)
1060
def check(self, revision_ids=None):
1062
return self._real_repository.check(revision_ids=revision_ids)
1064
def copy_content_into(self, destination, revision_id=None):
1066
return self._real_repository.copy_content_into(
1067
destination, revision_id=revision_id)
1069
def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
1070
# get a tarball of the remote repository, and copy from that into the
1072
from bzrlib import osutils
1074
# TODO: Maybe a progress bar while streaming the tarball?
1075
note("Copying repository content as tarball...")
1076
tar_file = self._get_tarball('bz2')
1077
if tar_file is None:
1079
destination = to_bzrdir.create_repository()
1081
tar = tarfile.open('repository', fileobj=tar_file,
1083
tmpdir = osutils.mkdtemp()
1085
_extract_tar(tar, tmpdir)
1086
tmp_bzrdir = BzrDir.open(tmpdir)
1087
tmp_repo = tmp_bzrdir.open_repository()
1088
tmp_repo.copy_content_into(destination, revision_id)
1090
osutils.rmtree(tmpdir)
1094
# TODO: Suggestion from john: using external tar is much faster than
1095
# python's tarfile library, but it may not work on windows.
1099
"""Compress the data within the repository.
1101
This is not currently implemented within the smart server.
1104
return self._real_repository.pack()
1106
def set_make_working_trees(self, new_value):
1108
self._real_repository.set_make_working_trees(new_value)
1111
def sign_revision(self, revision_id, gpg_strategy):
1113
return self._real_repository.sign_revision(revision_id, gpg_strategy)
1116
def get_revisions(self, revision_ids):
1118
return self._real_repository.get_revisions(revision_ids)
1120
def supports_rich_root(self):
1122
return self._real_repository.supports_rich_root()
1124
def iter_reverse_revision_history(self, revision_id):
1126
return self._real_repository.iter_reverse_revision_history(revision_id)
1129
def _serializer(self):
1131
return self._real_repository._serializer
1133
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1135
return self._real_repository.store_revision_signature(
1136
gpg_strategy, plaintext, revision_id)
1138
def add_signature_text(self, revision_id, signature):
1140
return self._real_repository.add_signature_text(revision_id, signature)
1142
def has_signature_for_revision_id(self, revision_id):
1144
return self._real_repository.has_signature_for_revision_id(revision_id)
1146
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
1148
return self._real_repository.item_keys_introduced_by(revision_ids,
1149
_files_pb=_files_pb)
1151
def revision_graph_can_have_wrong_parents(self):
1152
# The answer depends on the remote repo format.
1154
return self._real_repository.revision_graph_can_have_wrong_parents()
1156
def _find_inconsistent_revision_parents(self):
1158
return self._real_repository._find_inconsistent_revision_parents()
1160
def _check_for_inconsistent_revision_parents(self):
1162
return self._real_repository._check_for_inconsistent_revision_parents()
1164
def _make_parents_provider(self):
1167
def _serialise_search_recipe(recipe):
1168
"""Serialise a graph search recipe.
1170
:param recipe: A search recipe (start, stop, count).
1171
:return: Serialised bytes.
1173
start_keys = ' '.join(recipe[0])
1174
stop_keys = ' '.join(recipe[1])
1175
count = str(recipe[2])
1176
return '\n'.join((start_keys, stop_keys, count))
1178
def _serialise_search_tuple_key_recipe((start, stop, count)):
1179
"""Serialise a graph search recipe.
1181
:param recipe: A search recipe (start, stop, count).
1182
:return: Serialised bytes.
1185
# recipe = keys NEWLINE keys NEWLINE count
1187
# keys = key 0x00 key 0x00 key ...
1188
# key = key_elem SPACE key_elem SPACE key_elem ...
1190
start_keys = (' '.join(key) for key in start)
1191
buf.write('\0'.join(start_keys))
1193
stop_keys = (' '.join(key) for key in stop)
1194
buf.write('\0'.join(stop_keys))
1196
buf.write(str(count))
1197
return buf.getvalue()
1200
def _deserialise_search_result(bytes):
1202
for line in bytes.split('\n'):
1203
keys_bytes = line.split('\0')
1204
keys = [tuple(key_bytes.split(' ')) for key_bytes in keys_bytes]
1205
parents = tuple(keys[1:])
1206
if parents == (('',),):
1208
graph_dict[keys[0]] = parents
1212
class RemoteVersionedFiles(VersionedFiles):
1214
def __init__(self, remote_repo, vf_name):
1215
self.remote_repo = remote_repo
1216
self.vf_name = vf_name
1217
self._parents_map = None
1218
if 'hpss' in debug.debug_flags:
1219
self._requested_parents = None
1221
def _get_real_vf(self):
1222
self.remote_repo._ensure_real()
1223
return getattr(self.remote_repo._real_repository, self.vf_name)
1225
def add_lines(self, version_id, parents, lines, parent_texts=None,
1226
left_matching_blocks=None, nostore_sha=None, random_id=False,
1227
check_content=True):
1228
real_vf = self._get_real_vf()
1229
return real_vf.add_lines(version_id, parents, lines,
1230
parent_texts=parent_texts,
1231
left_matching_blocks=left_matching_blocks,
1232
nostore_sha=nostore_sha, random_id=random_id,
1233
check_content=check_content)
1235
def add_mpdiffs(self, records):
1236
real_vf = self._get_real_vf()
1237
return real_vf.add_mpdiffs(records)
1239
def annotate(self, key):
1240
real_vf = self._get_real_vf()
1241
return real_vf.annotate(key)
1243
def check(self, progress_bar=None):
1244
real_vf = self._get_real_vf()
1245
return real_vf.check(progress_bar=progress_bar)
1247
def get_parent_map(self, keys):
1248
# XXX: lots of duplication with RemoteRepository.get_parent_map.
1249
client = self.remote_repo._client
1250
medium = client._medium
1251
if medium._is_remote_before((1, 8)):
1252
real_vf = self._get_real_vf()
1253
return real_vf.get_parent_map(keys)
1254
# Hack to build up the caching logic.
1255
ancestry = self._parents_map
1256
if ancestry is None:
1257
# Repository is not locked, so there's no cache.
1258
missing_revisions = set(keys)
1261
missing_revisions = set(key for key in keys if key not in ancestry)
1262
if missing_revisions:
1264
parent_map = self._get_parent_map(missing_revisions)
1265
except errors.UnknownSmartMethod:
1266
medium._remember_remote_is_before((1, 8))
1267
real_vf = self._get_real_vf()
1268
return real_vf.get_parent_map(keys)
1269
if 'hpss' in debug.debug_flags:
1270
mutter('retransmitted revisions: %d of %d',
1271
len(set(ancestry).intersection(parent_map)),
1273
ancestry.update(parent_map)
1274
present_keys = [k for k in keys if k in ancestry]
1275
if 'hpss' in debug.debug_flags:
1276
if self._requested_parents is not None and len(ancestry) != 0:
1277
self._requested_parents.update(present_keys)
1278
mutter('Current RemoteRepository graph hit rate: %d%%',
1279
100.0 * len(self._requested_parents) / len(ancestry))
1280
return dict((k, ancestry[k]) for k in present_keys)
1282
def _get_parent_map(self, keys):
1283
# XXX: lots of duplication with RemoteRepository._get_parent_map.
1285
raise ValueError('get_parent_map(None) is not valid')
1286
if NULL_REVISION in keys:
1287
keys.discard(NULL_REVISION)
1288
found_parents = {NULL_REVISION:()}
1290
return found_parents
1293
# TODO(Needs analysis): We could assume that the keys being requested
1294
# from get_parent_map are in a breadth first search, so typically they
1295
# will all be depth N from some common parent, and we don't have to
1296
# have the server iterate from the root parent, but rather from the
1297
# keys we're searching; and just tell the server the keyspace we
1298
# already have; but this may be more traffic again.
1300
# Transform self._parents_map into a search request recipe.
1301
# TODO: Manage this incrementally to avoid covering the same path
1302
# repeatedly. (The server will have to on each request, but the less
1303
# work done the better).
1304
parents_map = self._parents_map
1305
if parents_map is None:
1306
# Repository is not locked, so there's no cache.
1308
start_set = set(parents_map)
1309
result_parents = set()
1310
for parents in parents_map.itervalues():
1311
result_parents.update(parents)
1312
stop_keys = result_parents.difference(start_set)
1313
included_keys = start_set.intersection(result_parents)
1314
start_set.difference_update(included_keys)
1315
recipe = (start_set, stop_keys, len(parents_map))
1316
client = self.remote_repo._client
1317
path = self.remote_repo.bzrdir._path_for_remote_call(client)
1319
if type(key) is not tuple:
1321
"key %r not a tuple of strs" % (key,))
1322
for key_elem in key:
1323
if type(key_elem) is not str:
1325
"key %r not a tuple of strs" % (key,))
1326
verb = 'VersionedFiles.get_parent_map'
1327
args = (path, self.vf_name) + tuple(keys)
1328
response = client.call_with_body_bytes_expecting_body(
1329
verb, args, _serialise_search_tuple_key_recipe(recipe))
1330
response_tuple, response_handler = response
1331
if response_tuple[0] not in ['ok']:
1332
response_handler.cancel_read_body()
1333
raise errors.UnexpectedSmartServerResponse(response_tuple)
1334
if response_tuple[0] == 'ok':
1335
coded = bz2.decompress(response_handler.read_body_bytes())
1336
revision_graph = _deserialise_search_result(coded)
1337
# The server doesn't return explicit results for keys it doesn't
1338
# have, so add empty entries for the missing keys to the result
1340
missing = keys.difference(revision_graph)
1341
for missing_key in missing:
1342
revision_graph[missing_key] = ()
1343
return revision_graph
1345
def get_record_stream(self, keys, ordering, include_delta_closure):
1346
real_vf = self._get_real_vf()
1347
return real_vf.get_record_stream(keys, ordering, include_delta_closure)
1349
def get_sha1s(self, keys):
1350
real_vf = self._get_real_vf()
1351
return real_vf.get_sha1s(keys)
1353
def insert_record_stream(self, stream):
1354
real_vf = self._get_real_vf()
1355
return real_vf.insert_record_stream(stream)
1357
def iter_lines_added_or_present_in_keys(self, keys, pb=None):
1358
real_vf = self._get_real_vf()
1359
return real_vf.iter_lines_added_or_present_in_keys(keys, pb=pb)
1362
real_vf = self._get_real_vf()
1363
return real_vf.keys()
1365
def make_mpdiffs(self, keys):
1366
real_vf = self._get_real_vf()
1367
return real_vf.make_mpdiffs(keys)
1370
class RemoteBranchLockableFiles(LockableFiles):
1371
"""A 'LockableFiles' implementation that talks to a smart server.
1373
This is not a public interface class.
1376
def __init__(self, bzrdir, _client):
1377
self.bzrdir = bzrdir
1378
self._client = _client
1379
self._need_find_modes = True
1380
LockableFiles.__init__(
1381
self, bzrdir.get_branch_transport(None),
1382
'lock', lockdir.LockDir)
1384
def _find_modes(self):
1385
# RemoteBranches don't let the client set the mode of control files.
1386
self._dir_mode = None
1387
self._file_mode = None
1390
class RemoteBranchFormat(branch.BranchFormat):
1392
def __eq__(self, other):
1393
return (isinstance(other, RemoteBranchFormat) and
1394
self.__dict__ == other.__dict__)
1396
def get_format_description(self):
1397
return 'Remote BZR Branch'
1399
def get_format_string(self):
1400
return 'Remote BZR Branch'
1402
def open(self, a_bzrdir):
1403
return a_bzrdir.open_branch()
1405
def initialize(self, a_bzrdir):
1406
return a_bzrdir.create_branch()
1408
def supports_tags(self):
1409
# Remote branches might support tags, but we won't know until we
1410
# access the real remote branch.
1414
class RemoteBranch(branch.Branch):
1415
"""Branch stored on a server accessed by HPSS RPC.
1417
At the moment most operations are mapped down to simple file operations.
1420
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
1422
"""Create a RemoteBranch instance.
1424
:param real_branch: An optional local implementation of the branch
1425
format, usually accessing the data via the VFS.
1426
:param _client: Private parameter for testing.
1428
# We intentionally don't call the parent class's __init__, because it
1429
# will try to assign to self.tags, which is a property in this subclass.
1430
# And the parent's __init__ doesn't do much anyway.
1431
self._revision_id_to_revno_cache = None
1432
self._revision_history_cache = None
1433
self._last_revision_info_cache = None
1434
self.bzrdir = remote_bzrdir
1435
if _client is not None:
1436
self._client = _client
1438
self._client = remote_bzrdir._client
1439
self.repository = remote_repository
1440
if real_branch is not None:
1441
self._real_branch = real_branch
1442
# Give the remote repository the matching real repo.
1443
real_repo = self._real_branch.repository
1444
if isinstance(real_repo, RemoteRepository):
1445
real_repo._ensure_real()
1446
real_repo = real_repo._real_repository
1447
self.repository._set_real_repository(real_repo)
1448
# Give the branch the remote repository to let fast-pathing happen.
1449
self._real_branch.repository = self.repository
1451
self._real_branch = None
1452
# Fill out expected attributes of branch for bzrlib api users.
1453
self._format = RemoteBranchFormat()
1454
self.base = self.bzrdir.root_transport.base
1455
self._control_files = None
1456
self._lock_mode = None
1457
self._lock_token = None
1458
self._repo_lock_token = None
1459
self._lock_count = 0
1460
self._leave_lock = False
1461
self._setup_stacking()
1463
def _setup_stacking(self):
1464
# configure stacking into the remote repository, by reading it from
1467
fallback_url = self.get_stacked_on_url()
1468
except (errors.NotStacked, errors.UnstackableBranchFormat,
1469
errors.UnstackableRepositoryFormat), e:
1471
# it's relative to this branch...
1472
fallback_url = urlutils.join(self.base, fallback_url)
1473
transports = [self.bzrdir.root_transport]
1474
if self._real_branch is not None:
1475
transports.append(self._real_branch._transport)
1476
fallback_bzrdir = BzrDir.open(fallback_url, transports)
1477
fallback_repo = fallback_bzrdir.open_repository()
1478
self.repository.add_fallback_repository(fallback_repo)
1480
def _get_real_transport(self):
1481
# if we try vfs access, return the real branch's vfs transport
1483
return self._real_branch._transport
1485
_transport = property(_get_real_transport)
1488
return "%s(%s)" % (self.__class__.__name__, self.base)
1492
def _ensure_real(self):
1493
"""Ensure that there is a _real_branch set.
1495
Used before calls to self._real_branch.
1497
if self._real_branch is None:
1498
if not vfs.vfs_enabled():
1499
raise AssertionError('smart server vfs must be enabled '
1500
'to use vfs implementation')
1501
self.bzrdir._ensure_real()
1502
self._real_branch = self.bzrdir._real_bzrdir.open_branch()
1503
if self.repository._real_repository is None:
1504
# Give the remote repository the matching real repo.
1505
real_repo = self._real_branch.repository
1506
if isinstance(real_repo, RemoteRepository):
1507
real_repo._ensure_real()
1508
real_repo = real_repo._real_repository
1509
self.repository._set_real_repository(real_repo)
1510
# Give the real branch the remote repository to let fast-pathing
1512
self._real_branch.repository = self.repository
1513
if self._lock_mode == 'r':
1514
self._real_branch.lock_read()
1515
elif self._lock_mode == 'w':
1516
self._real_branch.lock_write(token=self._lock_token)
1518
def _translate_error(self, err, **context):
1519
self.repository._translate_error(err, branch=self, **context)
1521
def _clear_cached_state(self):
1522
super(RemoteBranch, self)._clear_cached_state()
1523
if self._real_branch is not None:
1524
self._real_branch._clear_cached_state()
1526
def _clear_cached_state_of_remote_branch_only(self):
1527
"""Like _clear_cached_state, but doesn't clear the cache of
1530
This is useful when falling back to calling a method of
1531
self._real_branch that changes state. In that case the underlying
1532
branch changes, so we need to invalidate this RemoteBranch's cache of
1533
it. However, there's no need to invalidate the _real_branch's cache
1534
too, in fact doing so might harm performance.
1536
super(RemoteBranch, self)._clear_cached_state()
1539
def control_files(self):
1540
# Defer actually creating RemoteBranchLockableFiles until its needed,
1541
# because it triggers an _ensure_real that we otherwise might not need.
1542
if self._control_files is None:
1543
self._control_files = RemoteBranchLockableFiles(
1544
self.bzrdir, self._client)
1545
return self._control_files
1547
def _get_checkout_format(self):
1549
return self._real_branch._get_checkout_format()
1551
def get_physical_lock_status(self):
1552
"""See Branch.get_physical_lock_status()."""
1553
# should be an API call to the server, as branches must be lockable.
1555
return self._real_branch.get_physical_lock_status()
1557
def get_stacked_on_url(self):
1558
"""Get the URL this branch is stacked against.
1560
:raises NotStacked: If the branch is not stacked.
1561
:raises UnstackableBranchFormat: If the branch does not support
1563
:raises UnstackableRepositoryFormat: If the repository does not support
1567
response = self._client.call('Branch.get_stacked_on_url',
1568
self._remote_path())
1569
if response[0] != 'ok':
1570
raise errors.UnexpectedSmartServerResponse(response)
1572
except errors.ErrorFromSmartServer, err:
1573
# there may not be a repository yet, so we can't call through
1574
# its _translate_error
1575
_translate_error(err, branch=self)
1576
except errors.UnknownSmartMethod, err:
1578
return self._real_branch.get_stacked_on_url()
1580
def lock_read(self):
1581
self.repository.lock_read()
1582
if not self._lock_mode:
1583
self._lock_mode = 'r'
1584
self._lock_count = 1
1585
if self._real_branch is not None:
1586
self._real_branch.lock_read()
1588
self._lock_count += 1
1590
def _remote_lock_write(self, token):
1592
branch_token = repo_token = ''
1594
branch_token = token
1595
repo_token = self.repository.lock_write()
1596
self.repository.unlock()
1598
response = self._client.call(
1599
'Branch.lock_write', self._remote_path(),
1600
branch_token, repo_token or '')
1601
except errors.ErrorFromSmartServer, err:
1602
self._translate_error(err, token=token)
1603
if response[0] != 'ok':
1604
raise errors.UnexpectedSmartServerResponse(response)
1605
ok, branch_token, repo_token = response
1606
return branch_token, repo_token
1608
def lock_write(self, token=None):
1609
if not self._lock_mode:
1610
# Lock the branch and repo in one remote call.
1611
remote_tokens = self._remote_lock_write(token)
1612
self._lock_token, self._repo_lock_token = remote_tokens
1613
if not self._lock_token:
1614
raise SmartProtocolError('Remote server did not return a token!')
1615
# Tell the self.repository object that it is locked.
1616
self.repository.lock_write(
1617
self._repo_lock_token, _skip_rpc=True)
1619
if self._real_branch is not None:
1620
self._real_branch.lock_write(token=self._lock_token)
1621
if token is not None:
1622
self._leave_lock = True
1624
self._leave_lock = False
1625
self._lock_mode = 'w'
1626
self._lock_count = 1
1627
elif self._lock_mode == 'r':
1628
raise errors.ReadOnlyTransaction
1630
if token is not None:
1631
# A token was given to lock_write, and we're relocking, so
1632
# check that the given token actually matches the one we
1634
if token != self._lock_token:
1635
raise errors.TokenMismatch(token, self._lock_token)
1636
self._lock_count += 1
1637
# Re-lock the repository too.
1638
self.repository.lock_write(self._repo_lock_token)
1639
return self._lock_token or None
1641
def _unlock(self, branch_token, repo_token):
1643
response = self._client.call('Branch.unlock', self._remote_path(), branch_token,
1645
except errors.ErrorFromSmartServer, err:
1646
self._translate_error(err, token=str((branch_token, repo_token)))
1647
if response == ('ok',):
1649
raise errors.UnexpectedSmartServerResponse(response)
1653
self._lock_count -= 1
1654
if not self._lock_count:
1655
self._clear_cached_state()
1656
mode = self._lock_mode
1657
self._lock_mode = None
1658
if self._real_branch is not None:
1659
if (not self._leave_lock and mode == 'w' and
1660
self._repo_lock_token):
1661
# If this RemoteBranch will remove the physical lock
1662
# for the repository, make sure the _real_branch
1663
# doesn't do it first. (Because the _real_branch's
1664
# repository is set to be the RemoteRepository.)
1665
self._real_branch.repository.leave_lock_in_place()
1666
self._real_branch.unlock()
1668
# Only write-locked branched need to make a remote method
1669
# call to perfom the unlock.
1671
if not self._lock_token:
1672
raise AssertionError('Locked, but no token!')
1673
branch_token = self._lock_token
1674
repo_token = self._repo_lock_token
1675
self._lock_token = None
1676
self._repo_lock_token = None
1677
if not self._leave_lock:
1678
self._unlock(branch_token, repo_token)
1680
self.repository.unlock()
1682
def break_lock(self):
1684
return self._real_branch.break_lock()
1686
def leave_lock_in_place(self):
1687
if not self._lock_token:
1688
raise NotImplementedError(self.leave_lock_in_place)
1689
self._leave_lock = True
1691
def dont_leave_lock_in_place(self):
1692
if not self._lock_token:
1693
raise NotImplementedError(self.dont_leave_lock_in_place)
1694
self._leave_lock = False
1696
def _last_revision_info(self):
1697
response = self._client.call('Branch.last_revision_info', self._remote_path())
1698
if response[0] != 'ok':
1699
raise SmartProtocolError('unexpected response code %s' % (response,))
1700
revno = int(response[1])
1701
last_revision = response[2]
1702
return (revno, last_revision)
1704
def _gen_revision_history(self):
1705
"""See Branch._gen_revision_history()."""
1706
response_tuple, response_handler = self._client.call_expecting_body(
1707
'Branch.revision_history', self._remote_path())
1708
if response_tuple[0] != 'ok':
1709
raise errors.UnexpectedSmartServerResponse(response_tuple)
1710
result = response_handler.read_body_bytes().split('\x00')
1715
def _remote_path(self):
1716
return self.bzrdir._path_for_remote_call(self._client)
1718
def _set_last_revision_descendant(self, revision_id, other_branch,
1719
allow_diverged=False, allow_overwrite_descendant=False):
1721
response = self._client.call('Branch.set_last_revision_ex',
1722
self._remote_path(), self._lock_token, self._repo_lock_token, revision_id,
1723
int(allow_diverged), int(allow_overwrite_descendant))
1724
except errors.ErrorFromSmartServer, err:
1725
self._translate_error(err, other_branch=other_branch)
1726
self._clear_cached_state()
1727
if len(response) != 3 and response[0] != 'ok':
1728
raise errors.UnexpectedSmartServerResponse(response)
1729
new_revno, new_revision_id = response[1:]
1730
self._last_revision_info_cache = new_revno, new_revision_id
1731
if self._real_branch is not None:
1732
cache = new_revno, new_revision_id
1733
self._real_branch._last_revision_info_cache = cache
1735
def _set_last_revision(self, revision_id):
1736
self._clear_cached_state()
1738
response = self._client.call('Branch.set_last_revision',
1739
self._remote_path(), self._lock_token, self._repo_lock_token, revision_id)
1740
except errors.ErrorFromSmartServer, err:
1741
self._translate_error(err)
1742
if response != ('ok',):
1743
raise errors.UnexpectedSmartServerResponse(response)
1746
def set_revision_history(self, rev_history):
1747
# Send just the tip revision of the history; the server will generate
1748
# the full history from that. If the revision doesn't exist in this
1749
# branch, NoSuchRevision will be raised.
1750
if rev_history == []:
1753
rev_id = rev_history[-1]
1754
self._set_last_revision(rev_id)
1755
self._cache_revision_history(rev_history)
1757
def get_parent(self):
1759
return self._real_branch.get_parent()
1761
def set_parent(self, url):
1763
return self._real_branch.set_parent(url)
1765
def set_stacked_on_url(self, stacked_location):
1766
"""Set the URL this branch is stacked against.
1768
:raises UnstackableBranchFormat: If the branch does not support
1770
:raises UnstackableRepositoryFormat: If the repository does not support
1774
return self._real_branch.set_stacked_on_url(stacked_location)
1776
def sprout(self, to_bzrdir, revision_id=None):
1777
# Like Branch.sprout, except that it sprouts a branch in the default
1778
# format, because RemoteBranches can't be created at arbitrary URLs.
1779
# XXX: if to_bzrdir is a RemoteBranch, this should perhaps do
1780
# to_bzrdir.create_branch...
1782
result = self._real_branch._format.initialize(to_bzrdir)
1783
self.copy_content_into(result, revision_id=revision_id)
1784
result.set_parent(self.bzrdir.root_transport.base)
1788
def pull(self, source, overwrite=False, stop_revision=None,
1790
self._clear_cached_state_of_remote_branch_only()
1792
return self._real_branch.pull(
1793
source, overwrite=overwrite, stop_revision=stop_revision,
1794
_override_hook_target=self, **kwargs)
1797
def push(self, target, overwrite=False, stop_revision=None):
1799
return self._real_branch.push(
1800
target, overwrite=overwrite, stop_revision=stop_revision,
1801
_override_hook_source_branch=self)
1803
def is_locked(self):
1804
return self._lock_count >= 1
1807
def revision_id_to_revno(self, revision_id):
1809
return self._real_branch.revision_id_to_revno(revision_id)
1812
def set_last_revision_info(self, revno, revision_id):
1813
revision_id = ensure_null(revision_id)
1815
response = self._client.call('Branch.set_last_revision_info',
1816
self._remote_path(), self._lock_token, self._repo_lock_token, str(revno), revision_id)
1817
except errors.UnknownSmartMethod:
1819
self._clear_cached_state_of_remote_branch_only()
1820
self._real_branch.set_last_revision_info(revno, revision_id)
1821
self._last_revision_info_cache = revno, revision_id
1823
except errors.ErrorFromSmartServer, err:
1824
self._translate_error(err)
1825
if response == ('ok',):
1826
self._clear_cached_state()
1827
self._last_revision_info_cache = revno, revision_id
1828
# Update the _real_branch's cache too.
1829
if self._real_branch is not None:
1830
cache = self._last_revision_info_cache
1831
self._real_branch._last_revision_info_cache = cache
1833
raise errors.UnexpectedSmartServerResponse(response)
1836
def generate_revision_history(self, revision_id, last_rev=None,
1838
medium = self._client._medium
1839
if not medium._is_remote_before((1, 6)):
1841
self._set_last_revision_descendant(revision_id, other_branch,
1842
allow_diverged=True, allow_overwrite_descendant=True)
1844
except errors.UnknownSmartMethod:
1845
medium._remember_remote_is_before((1, 6))
1846
self._clear_cached_state_of_remote_branch_only()
1848
self._real_branch.generate_revision_history(
1849
revision_id, last_rev=last_rev, other_branch=other_branch)
1854
return self._real_branch.tags
1856
def set_push_location(self, location):
1858
return self._real_branch.set_push_location(location)
1861
def update_revisions(self, other, stop_revision=None, overwrite=False,
1863
"""See Branch.update_revisions."""
1866
if stop_revision is None:
1867
stop_revision = other.last_revision()
1868
if revision.is_null(stop_revision):
1869
# if there are no commits, we're done.
1871
self.fetch(other, stop_revision)
1874
# Just unconditionally set the new revision. We don't care if
1875
# the branches have diverged.
1876
self._set_last_revision(stop_revision)
1878
medium = self._client._medium
1879
if not medium._is_remote_before((1, 6)):
1881
self._set_last_revision_descendant(stop_revision, other)
1883
except errors.UnknownSmartMethod:
1884
medium._remember_remote_is_before((1, 6))
1885
# Fallback for pre-1.6 servers: check for divergence
1886
# client-side, then do _set_last_revision.
1887
last_rev = revision.ensure_null(self.last_revision())
1889
graph = self.repository.get_graph()
1890
if self._check_if_descendant_or_diverged(
1891
stop_revision, last_rev, graph, other):
1892
# stop_revision is a descendant of last_rev, but we aren't
1893
# overwriting, so we're done.
1895
self._set_last_revision(stop_revision)
1900
def _extract_tar(tar, to_dir):
1901
"""Extract all the contents of a tarfile object.
1903
A replacement for extractall, which is not present in python2.4
1906
tar.extract(tarinfo, to_dir)
1909
def _translate_error(err, **context):
1910
"""Translate an ErrorFromSmartServer into a more useful error.
1912
Possible context keys:
1919
If the error from the server doesn't match a known pattern, then
1920
UnknownErrorFromSmartServer is raised.
1924
return context[name]
1925
except KeyError, keyErr:
1926
mutter('Missing key %r in context %r', keyErr.args[0], context)
1928
if err.error_verb == 'NoSuchRevision':
1929
raise NoSuchRevision(find('branch'), err.error_args[0])
1930
elif err.error_verb == 'nosuchrevision':
1931
raise NoSuchRevision(find('repository'), err.error_args[0])
1932
elif err.error_tuple == ('nobranch',):
1933
raise errors.NotBranchError(path=find('bzrdir').root_transport.base)
1934
elif err.error_verb == 'norepository':
1935
raise errors.NoRepositoryPresent(find('bzrdir'))
1936
elif err.error_verb == 'LockContention':
1937
raise errors.LockContention('(remote lock)')
1938
elif err.error_verb == 'UnlockableTransport':
1939
raise errors.UnlockableTransport(find('bzrdir').root_transport)
1940
elif err.error_verb == 'LockFailed':
1941
raise errors.LockFailed(err.error_args[0], err.error_args[1])
1942
elif err.error_verb == 'TokenMismatch':
1943
raise errors.TokenMismatch(find('token'), '(remote token)')
1944
elif err.error_verb == 'Diverged':
1945
raise errors.DivergedBranches(find('branch'), find('other_branch'))
1946
elif err.error_verb == 'TipChangeRejected':
1947
raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
1948
elif err.error_verb == 'UnstackableBranchFormat':
1949
raise errors.UnstackableBranchFormat(*err.error_args)
1950
elif err.error_verb == 'UnstackableRepositoryFormat':
1951
raise errors.UnstackableRepositoryFormat(*err.error_args)
1952
elif err.error_verb == 'NotStacked':
1953
raise errors.NotStacked(branch=find('branch'))
1954
raise errors.UnknownErrorFromSmartServer(err)
added
removed
bzrlib/remote.py
