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
33
from bzrlib.branch import BranchReferenceFormat
34
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
35
from bzrlib.config import BranchConfig, TreeConfig
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.pack import ContainerPushParser
43
from bzrlib.smart import client, vfs
44
from bzrlib.symbol_versioning import (
48
from bzrlib.revision import ensure_null, NULL_REVISION
49
from bzrlib.trace import mutter, note, warning
52
# Note: RemoteBzrDirFormat is in bzrdir.py
54
class RemoteBzrDir(BzrDir):
55
"""Control directory on a remote server, accessed via bzr:// or similar."""
57
def __init__(self, transport, _client=None):
58
"""Construct a RemoteBzrDir.
60
:param _client: Private parameter for testing. Disables probing and the
63
BzrDir.__init__(self, transport, RemoteBzrDirFormat())
64
# this object holds a delegated bzrdir that uses file-level operations
65
# to talk to the other side
66
self._real_bzrdir = None
69
medium = transport.get_smart_medium()
70
self._client = client._SmartClient(medium)
72
self._client = _client
75
path = self._path_for_remote_call(self._client)
76
response = self._client.call('BzrDir.open', path)
77
if response not in [('yes',), ('no',)]:
78
raise errors.UnexpectedSmartServerResponse(response)
79
if response == ('no',):
80
raise errors.NotBranchError(path=transport.base)
82
def _ensure_real(self):
83
"""Ensure that there is a _real_bzrdir set.
85
Used before calls to self._real_bzrdir.
87
if not self._real_bzrdir:
88
self._real_bzrdir = BzrDir.open_from_transport(
89
self.root_transport, _server_formats=False)
91
def create_repository(self, shared=False):
93
self._real_bzrdir.create_repository(shared=shared)
94
return self.open_repository()
96
def destroy_repository(self):
97
"""See BzrDir.destroy_repository"""
99
self._real_bzrdir.destroy_repository()
101
def create_branch(self):
103
real_branch = self._real_bzrdir.create_branch()
104
return RemoteBranch(self, self.find_repository(), real_branch)
106
def destroy_branch(self):
107
"""See BzrDir.destroy_branch"""
109
self._real_bzrdir.destroy_branch()
111
def create_workingtree(self, revision_id=None, from_branch=None):
112
raise errors.NotLocalUrl(self.transport.base)
114
def find_branch_format(self):
115
"""Find the branch 'format' for this bzrdir.
117
This might be a synthetic object for e.g. RemoteBranch and SVN.
119
b = self.open_branch()
122
def get_branch_reference(self):
123
"""See BzrDir.get_branch_reference()."""
124
path = self._path_for_remote_call(self._client)
126
response = self._client.call('BzrDir.open_branch', path)
127
except errors.ErrorFromSmartServer, err:
128
if err.error_tuple == ('nobranch',):
129
raise errors.NotBranchError(path=self.root_transport.base)
131
if response[0] == 'ok':
132
if response[1] == '':
133
# branch at this location.
136
# a branch reference, use the existing BranchReference logic.
139
raise errors.UnexpectedSmartServerResponse(response)
141
def _get_tree_branch(self):
142
"""See BzrDir._get_tree_branch()."""
143
return None, self.open_branch()
145
def open_branch(self, _unsupported=False):
147
raise NotImplementedError('unsupported flag support not implemented yet.')
148
reference_url = self.get_branch_reference()
149
if reference_url is None:
150
# branch at this location.
151
return RemoteBranch(self, self.find_repository())
153
# a branch reference, use the existing BranchReference logic.
154
format = BranchReferenceFormat()
155
return format.open(self, _found=True, location=reference_url)
157
def open_repository(self):
158
path = self._path_for_remote_call(self._client)
159
verb = 'BzrDir.find_repositoryV2'
162
response = self._client.call(verb, path)
163
except errors.UnknownSmartMethod:
164
verb = 'BzrDir.find_repository'
165
response = self._client.call(verb, path)
166
except errors.ErrorFromSmartServer, err:
167
if err.error_verb == 'norepository':
168
raise errors.NoRepositoryPresent(self)
170
if response[0] != 'ok':
171
raise errors.UnexpectedSmartServerResponse(response)
172
if verb == 'BzrDir.find_repository':
173
# servers that don't support the V2 method don't support external
175
response = response + ('no', )
176
if not (len(response) == 5):
177
raise SmartProtocolError('incorrect response length %s' % (response,))
178
if response[1] == '':
179
format = RemoteRepositoryFormat()
180
format.rich_root_data = (response[2] == 'yes')
181
format.supports_tree_reference = (response[3] == 'yes')
182
# No wire format to check this yet.
183
format.supports_external_lookups = (response[4] == 'yes')
184
return RemoteRepository(self, format)
186
raise errors.NoRepositoryPresent(self)
188
def open_workingtree(self, recommend_upgrade=True):
190
if self._real_bzrdir.has_workingtree():
191
raise errors.NotLocalUrl(self.root_transport)
193
raise errors.NoWorkingTree(self.root_transport.base)
195
def _path_for_remote_call(self, client):
196
"""Return the path to be used for this bzrdir in a remote call."""
197
return client.remote_path_from_transport(self.root_transport)
199
def get_branch_transport(self, branch_format):
201
return self._real_bzrdir.get_branch_transport(branch_format)
203
def get_repository_transport(self, repository_format):
205
return self._real_bzrdir.get_repository_transport(repository_format)
207
def get_workingtree_transport(self, workingtree_format):
209
return self._real_bzrdir.get_workingtree_transport(workingtree_format)
211
def can_convert_format(self):
212
"""Upgrading of remote bzrdirs is not supported yet."""
215
def needs_format_conversion(self, format=None):
216
"""Upgrading of remote bzrdirs is not supported yet."""
219
def clone(self, url, revision_id=None, force_new_repo=False):
221
return self._real_bzrdir.clone(url, revision_id=revision_id,
222
force_new_repo=force_new_repo)
225
class RemoteRepositoryFormat(repository.RepositoryFormat):
226
"""Format for repositories accessed over a _SmartClient.
228
Instances of this repository are represented by RemoteRepository
231
The RemoteRepositoryFormat is parameterized during construction
232
to reflect the capabilities of the real, remote format. Specifically
233
the attributes rich_root_data and supports_tree_reference are set
234
on a per instance basis, and are not set (and should not be) at
238
_matchingbzrdir = RemoteBzrDirFormat
240
def initialize(self, a_bzrdir, shared=False):
241
if not isinstance(a_bzrdir, RemoteBzrDir):
242
raise AssertionError('%r is not a RemoteBzrDir' % (a_bzrdir,))
243
return a_bzrdir.create_repository(shared=shared)
245
def open(self, a_bzrdir):
246
if not isinstance(a_bzrdir, RemoteBzrDir):
247
raise AssertionError('%r is not a RemoteBzrDir' % (a_bzrdir,))
248
return a_bzrdir.open_repository()
250
def get_format_description(self):
251
return 'bzr remote repository'
253
def __eq__(self, other):
254
return self.__class__ == other.__class__
256
def check_conversion_target(self, target_format):
257
if self.rich_root_data and not target_format.rich_root_data:
258
raise errors.BadConversionTarget(
259
'Does not support rich root data.', target_format)
260
if (self.supports_tree_reference and
261
not getattr(target_format, 'supports_tree_reference', False)):
262
raise errors.BadConversionTarget(
263
'Does not support nested trees', target_format)
266
class RemoteRepository(object):
267
"""Repository accessed over rpc.
269
For the moment most operations are performed using local transport-backed
273
def __init__(self, remote_bzrdir, format, real_repository=None, _client=None):
274
"""Create a RemoteRepository instance.
276
:param remote_bzrdir: The bzrdir hosting this repository.
277
:param format: The RemoteFormat object to use.
278
:param real_repository: If not None, a local implementation of the
279
repository logic for the repository, usually accessing the data
281
:param _client: Private testing parameter - override the smart client
282
to be used by the repository.
285
self._real_repository = real_repository
287
self._real_repository = None
288
self.bzrdir = remote_bzrdir
290
self._client = remote_bzrdir._client
292
self._client = _client
293
self._format = format
294
self._lock_mode = None
295
self._lock_token = None
297
self._leave_lock = False
298
# A cache of looked up revision parent data; reset at unlock time.
299
self._parents_map = None
300
if 'hpss' in debug.debug_flags:
301
self._requested_parents = None
303
# These depend on the actual remote format, so force them off for
304
# maximum compatibility. XXX: In future these should depend on the
305
# remote repository instance, but this is irrelevant until we perform
306
# reconcile via an RPC call.
307
self._reconcile_does_inventory_gc = False
308
self._reconcile_fixes_text_parents = False
309
self._reconcile_backsup_inventory = False
310
self.base = self.bzrdir.transport.base
313
return "%s(%s)" % (self.__class__.__name__, self.base)
317
def abort_write_group(self):
318
"""Complete a write group on the decorated repository.
320
Smart methods peform operations in a single step so this api
321
is not really applicable except as a compatibility thunk
322
for older plugins that don't use e.g. the CommitBuilder
326
return self._real_repository.abort_write_group()
328
def commit_write_group(self):
329
"""Complete a write group on the decorated repository.
331
Smart methods peform operations in a single step so this api
332
is not really applicable except as a compatibility thunk
333
for older plugins that don't use e.g. the CommitBuilder
337
return self._real_repository.commit_write_group()
339
def _ensure_real(self):
340
"""Ensure that there is a _real_repository set.
342
Used before calls to self._real_repository.
344
if not self._real_repository:
345
self.bzrdir._ensure_real()
346
#self._real_repository = self.bzrdir._real_bzrdir.open_repository()
347
self._set_real_repository(self.bzrdir._real_bzrdir.open_repository())
349
def find_text_key_references(self):
350
"""Find the text key references within the repository.
352
:return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
353
revision_ids. Each altered file-ids has the exact revision_ids that
354
altered it listed explicitly.
355
:return: A dictionary mapping text keys ((fileid, revision_id) tuples)
356
to whether they were referred to by the inventory of the
357
revision_id that they contain. The inventory texts from all present
358
revision ids are assessed to generate this report.
361
return self._real_repository.find_text_key_references()
363
def _generate_text_key_index(self):
364
"""Generate a new text key index for the repository.
366
This is an expensive function that will take considerable time to run.
368
:return: A dict mapping (file_id, revision_id) tuples to a list of
369
parents, also (file_id, revision_id) tuples.
372
return self._real_repository._generate_text_key_index()
374
@symbol_versioning.deprecated_method(symbol_versioning.one_four)
375
def get_revision_graph(self, revision_id=None):
376
"""See Repository.get_revision_graph()."""
377
return self._get_revision_graph(revision_id)
379
def _get_revision_graph(self, revision_id):
380
"""Private method for using with old (< 1.2) servers to fallback."""
381
if revision_id is None:
383
elif revision.is_null(revision_id):
386
path = self.bzrdir._path_for_remote_call(self._client)
388
response = self._client.call_expecting_body(
389
'Repository.get_revision_graph', path, revision_id)
390
except errors.ErrorFromSmartServer, err:
391
if err.error_verb == 'nosuchrevision':
392
raise NoSuchRevision(self, revision_id)
394
response_tuple, response_handler = response
395
if response_tuple[0] != 'ok':
396
raise errors.UnexpectedSmartServerResponse(response_tuple)
397
coded = response_handler.read_body_bytes()
399
# no revisions in this repository!
401
lines = coded.split('\n')
404
d = tuple(line.split())
405
revision_graph[d[0]] = d[1:]
407
return revision_graph
409
def has_revision(self, revision_id):
410
"""See Repository.has_revision()."""
411
if revision_id == NULL_REVISION:
412
# The null revision is always present.
414
path = self.bzrdir._path_for_remote_call(self._client)
415
response = self._client.call(
416
'Repository.has_revision', path, revision_id)
417
if response[0] not in ('yes', 'no'):
418
raise errors.UnexpectedSmartServerResponse(response)
419
return response[0] == 'yes'
421
def has_revisions(self, revision_ids):
422
"""See Repository.has_revisions()."""
424
for revision_id in revision_ids:
425
if self.has_revision(revision_id):
426
result.add(revision_id)
429
def has_same_location(self, other):
430
return (self.__class__ == other.__class__ and
431
self.bzrdir.transport.base == other.bzrdir.transport.base)
433
def get_graph(self, other_repository=None):
434
"""Return the graph for this repository format"""
435
parents_provider = self
436
if (other_repository is not None and
437
other_repository.bzrdir.transport.base !=
438
self.bzrdir.transport.base):
439
parents_provider = graph._StackedParentsProvider(
440
[parents_provider, other_repository._make_parents_provider()])
441
return graph.Graph(parents_provider)
443
def gather_stats(self, revid=None, committers=None):
444
"""See Repository.gather_stats()."""
445
path = self.bzrdir._path_for_remote_call(self._client)
446
# revid can be None to indicate no revisions, not just NULL_REVISION
447
if revid is None or revision.is_null(revid):
451
if committers is None or not committers:
452
fmt_committers = 'no'
454
fmt_committers = 'yes'
455
response_tuple, response_handler = self._client.call_expecting_body(
456
'Repository.gather_stats', path, fmt_revid, fmt_committers)
457
if response_tuple[0] != 'ok':
458
raise errors.UnexpectedSmartServerResponse(response_tuple)
460
body = response_handler.read_body_bytes()
462
for line in body.split('\n'):
465
key, val_text = line.split(':')
466
if key in ('revisions', 'size', 'committers'):
467
result[key] = int(val_text)
468
elif key in ('firstrev', 'latestrev'):
469
values = val_text.split(' ')[1:]
470
result[key] = (float(values[0]), long(values[1]))
474
def find_branches(self, using=False):
475
"""See Repository.find_branches()."""
476
# should be an API call to the server.
478
return self._real_repository.find_branches(using=using)
480
def get_physical_lock_status(self):
481
"""See Repository.get_physical_lock_status()."""
482
# should be an API call to the server.
484
return self._real_repository.get_physical_lock_status()
486
def is_in_write_group(self):
487
"""Return True if there is an open write group.
489
write groups are only applicable locally for the smart server..
491
if self._real_repository:
492
return self._real_repository.is_in_write_group()
495
return self._lock_count >= 1
498
"""See Repository.is_shared()."""
499
path = self.bzrdir._path_for_remote_call(self._client)
500
response = self._client.call('Repository.is_shared', path)
501
if response[0] not in ('yes', 'no'):
502
raise SmartProtocolError('unexpected response code %s' % (response,))
503
return response[0] == 'yes'
505
def is_write_locked(self):
506
return self._lock_mode == 'w'
509
# wrong eventually - want a local lock cache context
510
if not self._lock_mode:
511
self._lock_mode = 'r'
513
self._parents_map = {}
514
if 'hpss' in debug.debug_flags:
515
self._requested_parents = set()
516
if self._real_repository is not None:
517
self._real_repository.lock_read()
519
self._lock_count += 1
521
def _remote_lock_write(self, token):
522
path = self.bzrdir._path_for_remote_call(self._client)
526
response = self._client.call('Repository.lock_write', path, token)
527
except errors.ErrorFromSmartServer, err:
528
if err.error_verb == 'LockContention':
529
raise errors.LockContention('(remote lock)')
530
elif err.error_verb == 'UnlockableTransport':
531
raise errors.UnlockableTransport(self.bzrdir.root_transport)
532
elif err.error_verb == 'LockFailed':
533
raise errors.LockFailed(err.error_args[0], err.error_args[1])
536
if response[0] == 'ok':
540
raise errors.UnexpectedSmartServerResponse(response)
542
def lock_write(self, token=None):
543
if not self._lock_mode:
544
self._lock_token = self._remote_lock_write(token)
545
# if self._lock_token is None, then this is something like packs or
546
# svn where we don't get to lock the repo, or a weave style repository
547
# where we cannot lock it over the wire and attempts to do so will
549
if self._real_repository is not None:
550
self._real_repository.lock_write(token=self._lock_token)
551
if token is not None:
552
self._leave_lock = True
554
self._leave_lock = False
555
self._lock_mode = 'w'
557
self._parents_map = {}
558
if 'hpss' in debug.debug_flags:
559
self._requested_parents = set()
560
elif self._lock_mode == 'r':
561
raise errors.ReadOnlyError(self)
563
self._lock_count += 1
564
return self._lock_token or None
566
def leave_lock_in_place(self):
567
if not self._lock_token:
568
raise NotImplementedError(self.leave_lock_in_place)
569
self._leave_lock = True
571
def dont_leave_lock_in_place(self):
572
if not self._lock_token:
573
raise NotImplementedError(self.dont_leave_lock_in_place)
574
self._leave_lock = False
576
def _set_real_repository(self, repository):
577
"""Set the _real_repository for this repository.
579
:param repository: The repository to fallback to for non-hpss
580
implemented operations.
582
if isinstance(repository, RemoteRepository):
583
raise AssertionError()
584
self._real_repository = repository
585
if self._lock_mode == 'w':
586
# if we are already locked, the real repository must be able to
587
# acquire the lock with our token.
588
self._real_repository.lock_write(self._lock_token)
589
elif self._lock_mode == 'r':
590
self._real_repository.lock_read()
592
def start_write_group(self):
593
"""Start a write group on the decorated repository.
595
Smart methods peform operations in a single step so this api
596
is not really applicable except as a compatibility thunk
597
for older plugins that don't use e.g. the CommitBuilder
601
return self._real_repository.start_write_group()
603
def _unlock(self, token):
604
path = self.bzrdir._path_for_remote_call(self._client)
606
# with no token the remote repository is not persistently locked.
609
response = self._client.call('Repository.unlock', path, token)
610
except errors.ErrorFromSmartServer, err:
611
if err.error_verb == 'TokenMismatch':
612
raise errors.TokenMismatch(token, '(remote token)')
614
if response == ('ok',):
617
raise errors.UnexpectedSmartServerResponse(response)
620
self._lock_count -= 1
621
if self._lock_count > 0:
623
self._parents_map = None
624
if 'hpss' in debug.debug_flags:
625
self._requested_parents = None
626
old_mode = self._lock_mode
627
self._lock_mode = None
629
# The real repository is responsible at present for raising an
630
# exception if it's in an unfinished write group. However, it
631
# normally will *not* actually remove the lock from disk - that's
632
# done by the server on receiving the Repository.unlock call.
633
# This is just to let the _real_repository stay up to date.
634
if self._real_repository is not None:
635
self._real_repository.unlock()
637
# The rpc-level lock should be released even if there was a
638
# problem releasing the vfs-based lock.
640
# Only write-locked repositories need to make a remote method
641
# call to perfom the unlock.
642
old_token = self._lock_token
643
self._lock_token = None
644
if not self._leave_lock:
645
self._unlock(old_token)
647
def break_lock(self):
648
# should hand off to the network
650
return self._real_repository.break_lock()
652
def _get_tarball(self, compression):
653
"""Return a TemporaryFile containing a repository tarball.
655
Returns None if the server does not support sending tarballs.
658
path = self.bzrdir._path_for_remote_call(self._client)
660
response, protocol = self._client.call_expecting_body(
661
'Repository.tarball', path, compression)
662
except errors.UnknownSmartMethod:
663
protocol.cancel_read_body()
665
if response[0] == 'ok':
666
# Extract the tarball and return it
667
t = tempfile.NamedTemporaryFile()
668
# TODO: rpc layer should read directly into it...
669
t.write(protocol.read_body_bytes())
672
raise errors.UnexpectedSmartServerResponse(response)
674
def sprout(self, to_bzrdir, revision_id=None):
675
# TODO: Option to control what format is created?
677
dest_repo = self._real_repository._format.initialize(to_bzrdir,
679
dest_repo.fetch(self, revision_id=revision_id)
682
### These methods are just thin shims to the VFS object for now.
684
def revision_tree(self, revision_id):
686
return self._real_repository.revision_tree(revision_id)
688
def get_serializer_format(self):
690
return self._real_repository.get_serializer_format()
692
def get_commit_builder(self, branch, parents, config, timestamp=None,
693
timezone=None, committer=None, revprops=None,
695
# FIXME: It ought to be possible to call this without immediately
696
# triggering _ensure_real. For now it's the easiest thing to do.
698
builder = self._real_repository.get_commit_builder(branch, parents,
699
config, timestamp=timestamp, timezone=timezone,
700
committer=committer, revprops=revprops, revision_id=revision_id)
703
def add_inventory(self, revid, inv, parents):
705
return self._real_repository.add_inventory(revid, inv, parents)
707
def add_revision(self, rev_id, rev, inv=None, config=None):
709
return self._real_repository.add_revision(
710
rev_id, rev, inv=inv, config=config)
713
def get_inventory(self, revision_id):
715
return self._real_repository.get_inventory(revision_id)
717
def iter_inventories(self, revision_ids):
719
return self._real_repository.iter_inventories(revision_ids)
722
def get_revision(self, revision_id):
724
return self._real_repository.get_revision(revision_id)
726
def get_transaction(self):
728
return self._real_repository.get_transaction()
731
def clone(self, a_bzrdir, revision_id=None):
733
return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
735
def make_working_trees(self):
736
"""See Repository.make_working_trees"""
738
return self._real_repository.make_working_trees()
740
def revision_ids_to_search_result(self, result_set):
741
"""Convert a set of revision ids to a graph SearchResult."""
742
result_parents = set()
743
for parents in self.get_graph().get_parent_map(
744
result_set).itervalues():
745
result_parents.update(parents)
746
included_keys = result_set.intersection(result_parents)
747
start_keys = result_set.difference(included_keys)
748
exclude_keys = result_parents.difference(result_set)
749
result = graph.SearchResult(start_keys, exclude_keys,
750
len(result_set), result_set)
754
def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
755
"""Return the revision ids that other has that this does not.
757
These are returned in topological order.
759
revision_id: only return revision ids included by revision_id.
761
return repository.InterRepository.get(
762
other, self).search_missing_revision_ids(revision_id, find_ghosts)
764
def fetch(self, source, revision_id=None, pb=None):
765
if self.has_same_location(source):
766
# check that last_revision is in 'from' and then return a
768
if (revision_id is not None and
769
not revision.is_null(revision_id)):
770
self.get_revision(revision_id)
773
return self._real_repository.fetch(
774
source, revision_id=revision_id, pb=pb)
776
def create_bundle(self, target, base, fileobj, format=None):
778
self._real_repository.create_bundle(target, base, fileobj, format)
781
def get_ancestry(self, revision_id, topo_sorted=True):
783
return self._real_repository.get_ancestry(revision_id, topo_sorted)
785
def fileids_altered_by_revision_ids(self, revision_ids):
787
return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
789
def _get_versioned_file_checker(self, revisions, revision_versions_cache):
791
return self._real_repository._get_versioned_file_checker(
792
revisions, revision_versions_cache)
794
def iter_files_bytes(self, desired_files):
795
"""See Repository.iter_file_bytes.
798
return self._real_repository.iter_files_bytes(desired_files)
800
def get_parent_map(self, keys):
801
"""See bzrlib.Graph.get_parent_map()."""
802
# Hack to build up the caching logic.
803
ancestry = self._parents_map
805
# Repository is not locked, so there's no cache.
806
missing_revisions = set(keys)
809
missing_revisions = set(key for key in keys if key not in ancestry)
810
if missing_revisions:
811
parent_map = self._get_parent_map(missing_revisions)
812
if 'hpss' in debug.debug_flags:
813
mutter('retransmitted revisions: %d of %d',
814
len(set(ancestry).intersection(parent_map)),
816
ancestry.update(parent_map)
817
present_keys = [k for k in keys if k in ancestry]
818
if 'hpss' in debug.debug_flags:
819
if self._requested_parents is not None and len(ancestry) != 0:
820
self._requested_parents.update(present_keys)
821
mutter('Current RemoteRepository graph hit rate: %d%%',
822
100.0 * len(self._requested_parents) / len(ancestry))
823
return dict((k, ancestry[k]) for k in present_keys)
825
def _get_parent_map(self, keys):
826
"""Helper for get_parent_map that performs the RPC."""
827
medium = self._client._medium
828
if not medium._remote_is_at_least_1_2:
829
# We already found out that the server can't understand
830
# Repository.get_parent_map requests, so just fetch the whole
832
# XXX: Note that this will issue a deprecation warning. This is ok
833
# :- its because we're working with a deprecated server anyway, and
834
# the user will almost certainly have seen a warning about the
835
# server version already.
836
rg = self.get_revision_graph()
837
# There is an api discrepency between get_parent_map and
838
# get_revision_graph. Specifically, a "key:()" pair in
839
# get_revision_graph just means a node has no parents. For
840
# "get_parent_map" it means the node is a ghost. So fix up the
841
# graph to correct this.
842
# https://bugs.launchpad.net/bzr/+bug/214894
843
# There is one other "bug" which is that ghosts in
844
# get_revision_graph() are not returned at all. But we won't worry
845
# about that for now.
846
for node_id, parent_ids in rg.iteritems():
848
rg[node_id] = (NULL_REVISION,)
849
rg[NULL_REVISION] = ()
854
raise ValueError('get_parent_map(None) is not valid')
855
if NULL_REVISION in keys:
856
keys.discard(NULL_REVISION)
857
found_parents = {NULL_REVISION:()}
862
# TODO(Needs analysis): We could assume that the keys being requested
863
# from get_parent_map are in a breadth first search, so typically they
864
# will all be depth N from some common parent, and we don't have to
865
# have the server iterate from the root parent, but rather from the
866
# keys we're searching; and just tell the server the keyspace we
867
# already have; but this may be more traffic again.
869
# Transform self._parents_map into a search request recipe.
870
# TODO: Manage this incrementally to avoid covering the same path
871
# repeatedly. (The server will have to on each request, but the less
872
# work done the better).
873
parents_map = self._parents_map
874
if parents_map is None:
875
# Repository is not locked, so there's no cache.
877
start_set = set(parents_map)
878
result_parents = set()
879
for parents in parents_map.itervalues():
880
result_parents.update(parents)
881
stop_keys = result_parents.difference(start_set)
882
included_keys = start_set.intersection(result_parents)
883
start_set.difference_update(included_keys)
884
recipe = (start_set, stop_keys, len(parents_map))
885
body = self._serialise_search_recipe(recipe)
886
path = self.bzrdir._path_for_remote_call(self._client)
888
if type(key) is not str:
890
"key %r not a plain string" % (key,))
891
verb = 'Repository.get_parent_map'
892
args = (path,) + tuple(keys)
894
response = self._client.call_with_body_bytes_expecting_body(
895
verb, args, self._serialise_search_recipe(recipe))
896
except errors.UnknownSmartMethod:
897
# Server does not support this method, so get the whole graph.
898
# Worse, we have to force a disconnection, because the server now
899
# doesn't realise it has a body on the wire to consume, so the
900
# only way to recover is to abandon the connection.
902
'Server is too old for fast get_parent_map, reconnecting. '
903
'(Upgrade the server to Bazaar 1.2 to avoid this)')
905
# To avoid having to disconnect repeatedly, we keep track of the
906
# fact the server doesn't understand remote methods added in 1.2.
907
medium._remote_is_at_least_1_2 = False
908
return self.get_revision_graph(None)
909
response_tuple, response_handler = response
910
if response_tuple[0] not in ['ok']:
911
response_handler.cancel_read_body()
912
raise errors.UnexpectedSmartServerResponse(response_tuple)
913
if response_tuple[0] == 'ok':
914
coded = bz2.decompress(response_handler.read_body_bytes())
918
lines = coded.split('\n')
921
d = tuple(line.split())
923
revision_graph[d[0]] = d[1:]
925
# No parents - so give the Graph result (NULL_REVISION,).
926
revision_graph[d[0]] = (NULL_REVISION,)
927
return revision_graph
930
def get_signature_text(self, revision_id):
932
return self._real_repository.get_signature_text(revision_id)
935
@symbol_versioning.deprecated_method(symbol_versioning.one_three)
936
def get_revision_graph_with_ghosts(self, revision_ids=None):
938
return self._real_repository.get_revision_graph_with_ghosts(
939
revision_ids=revision_ids)
942
def get_inventory_xml(self, revision_id):
944
return self._real_repository.get_inventory_xml(revision_id)
946
def deserialise_inventory(self, revision_id, xml):
948
return self._real_repository.deserialise_inventory(revision_id, xml)
950
def reconcile(self, other=None, thorough=False):
952
return self._real_repository.reconcile(other=other, thorough=thorough)
954
def all_revision_ids(self):
956
return self._real_repository.all_revision_ids()
959
def get_deltas_for_revisions(self, revisions):
961
return self._real_repository.get_deltas_for_revisions(revisions)
964
def get_revision_delta(self, revision_id):
966
return self._real_repository.get_revision_delta(revision_id)
969
def revision_trees(self, revision_ids):
971
return self._real_repository.revision_trees(revision_ids)
974
def get_revision_reconcile(self, revision_id):
976
return self._real_repository.get_revision_reconcile(revision_id)
979
def check(self, revision_ids=None):
981
return self._real_repository.check(revision_ids=revision_ids)
983
def copy_content_into(self, destination, revision_id=None):
985
return self._real_repository.copy_content_into(
986
destination, revision_id=revision_id)
988
def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
989
# get a tarball of the remote repository, and copy from that into the
991
from bzrlib import osutils
994
# TODO: Maybe a progress bar while streaming the tarball?
995
note("Copying repository content as tarball...")
996
tar_file = self._get_tarball('bz2')
999
destination = to_bzrdir.create_repository()
1001
tar = tarfile.open('repository', fileobj=tar_file,
1003
tmpdir = tempfile.mkdtemp()
1005
_extract_tar(tar, tmpdir)
1006
tmp_bzrdir = BzrDir.open(tmpdir)
1007
tmp_repo = tmp_bzrdir.open_repository()
1008
tmp_repo.copy_content_into(destination, revision_id)
1010
osutils.rmtree(tmpdir)
1014
# TODO: Suggestion from john: using external tar is much faster than
1015
# python's tarfile library, but it may not work on windows.
1018
def inventories(self):
1019
"""Decorate the real repository for now.
1021
In the long term a full blown network facility is needed to
1022
avoid creating a real repository object locally.
1025
return self._real_repository.inventories
1029
"""Compress the data within the repository.
1031
This is not currently implemented within the smart server.
1034
return self._real_repository.pack()
1037
def revisions(self):
1038
"""Decorate the real repository for now.
1040
In the short term this should become a real object to intercept graph
1043
In the long term a full blown network facility is needed.
1046
return self._real_repository.revisions
1048
def set_make_working_trees(self, new_value):
1050
self._real_repository.set_make_working_trees(new_value)
1053
def signatures(self):
1054
"""Decorate the real repository for now.
1056
In the long term a full blown network facility is needed to avoid
1057
creating a real repository object locally.
1060
return self._real_repository.signatures
1063
def sign_revision(self, revision_id, gpg_strategy):
1065
return self._real_repository.sign_revision(revision_id, gpg_strategy)
1069
"""Decorate the real repository for now.
1071
In the long term a full blown network facility is needed to avoid
1072
creating a real repository object locally.
1075
return self._real_repository.texts
1078
def get_revisions(self, revision_ids):
1080
return self._real_repository.get_revisions(revision_ids)
1082
def supports_rich_root(self):
1084
return self._real_repository.supports_rich_root()
1086
def iter_reverse_revision_history(self, revision_id):
1088
return self._real_repository.iter_reverse_revision_history(revision_id)
1091
def _serializer(self):
1093
return self._real_repository._serializer
1095
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1097
return self._real_repository.store_revision_signature(
1098
gpg_strategy, plaintext, revision_id)
1100
def add_signature_text(self, revision_id, signature):
1102
return self._real_repository.add_signature_text(revision_id, signature)
1104
def has_signature_for_revision_id(self, revision_id):
1106
return self._real_repository.has_signature_for_revision_id(revision_id)
1108
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
1110
return self._real_repository.item_keys_introduced_by(revision_ids,
1111
_files_pb=_files_pb)
1113
def revision_graph_can_have_wrong_parents(self):
1114
# The answer depends on the remote repo format.
1116
return self._real_repository.revision_graph_can_have_wrong_parents()
1118
def _find_inconsistent_revision_parents(self):
1120
return self._real_repository._find_inconsistent_revision_parents()
1122
def _check_for_inconsistent_revision_parents(self):
1124
return self._real_repository._check_for_inconsistent_revision_parents()
1126
def _make_parents_provider(self):
1129
def _serialise_search_recipe(self, recipe):
1130
"""Serialise a graph search recipe.
1132
:param recipe: A search recipe (start, stop, count).
1133
:return: Serialised bytes.
1135
start_keys = ' '.join(recipe[0])
1136
stop_keys = ' '.join(recipe[1])
1137
count = str(recipe[2])
1138
return '\n'.join((start_keys, stop_keys, count))
1141
class RemoteBranchLockableFiles(LockableFiles):
1142
"""A 'LockableFiles' implementation that talks to a smart server.
1144
This is not a public interface class.
1147
def __init__(self, bzrdir, _client):
1148
self.bzrdir = bzrdir
1149
self._client = _client
1150
self._need_find_modes = True
1151
LockableFiles.__init__(
1152
self, bzrdir.get_branch_transport(None),
1153
'lock', lockdir.LockDir)
1155
def _find_modes(self):
1156
# RemoteBranches don't let the client set the mode of control files.
1157
self._dir_mode = None
1158
self._file_mode = None
1161
class RemoteBranchFormat(branch.BranchFormat):
1163
def __eq__(self, other):
1164
return (isinstance(other, RemoteBranchFormat) and
1165
self.__dict__ == other.__dict__)
1167
def get_format_description(self):
1168
return 'Remote BZR Branch'
1170
def get_format_string(self):
1171
return 'Remote BZR Branch'
1173
def open(self, a_bzrdir):
1174
return a_bzrdir.open_branch()
1176
def initialize(self, a_bzrdir):
1177
return a_bzrdir.create_branch()
1179
def supports_tags(self):
1180
# Remote branches might support tags, but we won't know until we
1181
# access the real remote branch.
1185
class RemoteBranch(branch.Branch):
1186
"""Branch stored on a server accessed by HPSS RPC.
1188
At the moment most operations are mapped down to simple file operations.
1191
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
1193
"""Create a RemoteBranch instance.
1195
:param real_branch: An optional local implementation of the branch
1196
format, usually accessing the data via the VFS.
1197
:param _client: Private parameter for testing.
1199
# We intentionally don't call the parent class's __init__, because it
1200
# will try to assign to self.tags, which is a property in this subclass.
1201
# And the parent's __init__ doesn't do much anyway.
1202
self._revision_id_to_revno_cache = None
1203
self._revision_history_cache = None
1204
self.bzrdir = remote_bzrdir
1205
if _client is not None:
1206
self._client = _client
1208
self._client = remote_bzrdir._client
1209
self.repository = remote_repository
1210
if real_branch is not None:
1211
self._real_branch = real_branch
1212
# Give the remote repository the matching real repo.
1213
real_repo = self._real_branch.repository
1214
if isinstance(real_repo, RemoteRepository):
1215
real_repo._ensure_real()
1216
real_repo = real_repo._real_repository
1217
self.repository._set_real_repository(real_repo)
1218
# Give the branch the remote repository to let fast-pathing happen.
1219
self._real_branch.repository = self.repository
1221
self._real_branch = None
1222
# Fill out expected attributes of branch for bzrlib api users.
1223
self._format = RemoteBranchFormat()
1224
self.base = self.bzrdir.root_transport.base
1225
self._control_files = None
1226
self._lock_mode = None
1227
self._lock_token = None
1228
self._repo_lock_token = None
1229
self._lock_count = 0
1230
self._leave_lock = False
1232
def _get_real_transport(self):
1233
# if we try vfs access, return the real branch's vfs transport
1235
return self._real_branch._transport
1237
_transport = property(_get_real_transport)
1240
return "%s(%s)" % (self.__class__.__name__, self.base)
1244
def _ensure_real(self):
1245
"""Ensure that there is a _real_branch set.
1247
Used before calls to self._real_branch.
1249
if self._real_branch is None:
1250
if not vfs.vfs_enabled():
1251
raise AssertionError('smart server vfs must be enabled '
1252
'to use vfs implementation')
1253
self.bzrdir._ensure_real()
1254
self._real_branch = self.bzrdir._real_bzrdir.open_branch()
1255
# Give the remote repository the matching real repo.
1256
real_repo = self._real_branch.repository
1257
if isinstance(real_repo, RemoteRepository):
1258
real_repo._ensure_real()
1259
real_repo = real_repo._real_repository
1260
self.repository._set_real_repository(real_repo)
1261
# Give the branch the remote repository to let fast-pathing happen.
1262
self._real_branch.repository = self.repository
1263
# XXX: deal with _lock_mode == 'w'
1264
if self._lock_mode == 'r':
1265
self._real_branch.lock_read()
1268
def control_files(self):
1269
# Defer actually creating RemoteBranchLockableFiles until its needed,
1270
# because it triggers an _ensure_real that we otherwise might not need.
1271
if self._control_files is None:
1272
self._control_files = RemoteBranchLockableFiles(
1273
self.bzrdir, self._client)
1274
return self._control_files
1276
def _get_checkout_format(self):
1278
return self._real_branch._get_checkout_format()
1280
def get_physical_lock_status(self):
1281
"""See Branch.get_physical_lock_status()."""
1282
# should be an API call to the server, as branches must be lockable.
1284
return self._real_branch.get_physical_lock_status()
1286
def lock_read(self):
1287
if not self._lock_mode:
1288
self._lock_mode = 'r'
1289
self._lock_count = 1
1290
if self._real_branch is not None:
1291
self._real_branch.lock_read()
1293
self._lock_count += 1
1295
def _remote_lock_write(self, token):
1297
branch_token = repo_token = ''
1299
branch_token = token
1300
repo_token = self.repository.lock_write()
1301
self.repository.unlock()
1302
path = self.bzrdir._path_for_remote_call(self._client)
1304
response = self._client.call(
1305
'Branch.lock_write', path, branch_token, repo_token or '')
1306
except errors.ErrorFromSmartServer, err:
1307
if err.error_verb == 'LockContention':
1308
raise errors.LockContention('(remote lock)')
1309
elif err.error_verb == 'TokenMismatch':
1310
raise errors.TokenMismatch(token, '(remote token)')
1311
elif err.error_verb == 'UnlockableTransport':
1312
raise errors.UnlockableTransport(self.bzrdir.root_transport)
1313
elif err.error_verb == 'ReadOnlyError':
1314
raise errors.ReadOnlyError(self)
1315
elif err.error_verb == 'LockFailed':
1316
raise errors.LockFailed(err.error_args[0], err.error_args[1])
1318
if response[0] != 'ok':
1319
raise errors.UnexpectedSmartServerResponse(response)
1320
ok, branch_token, repo_token = response
1321
return branch_token, repo_token
1323
def lock_write(self, token=None):
1324
if not self._lock_mode:
1325
remote_tokens = self._remote_lock_write(token)
1326
self._lock_token, self._repo_lock_token = remote_tokens
1327
if not self._lock_token:
1328
raise SmartProtocolError('Remote server did not return a token!')
1329
# TODO: We really, really, really don't want to call _ensure_real
1330
# here, but it's the easiest way to ensure coherency between the
1331
# state of the RemoteBranch and RemoteRepository objects and the
1332
# physical locks. If we don't materialise the real objects here,
1333
# then getting everything in the right state later is complex, so
1334
# for now we just do it the lazy way.
1335
# -- Andrew Bennetts, 2007-02-22.
1337
if self._real_branch is not None:
1338
self._real_branch.repository.lock_write(
1339
token=self._repo_lock_token)
1341
self._real_branch.lock_write(token=self._lock_token)
1343
self._real_branch.repository.unlock()
1344
if token is not None:
1345
self._leave_lock = True
1347
# XXX: this case seems to be unreachable; token cannot be None.
1348
self._leave_lock = False
1349
self._lock_mode = 'w'
1350
self._lock_count = 1
1351
elif self._lock_mode == 'r':
1352
raise errors.ReadOnlyTransaction
1354
if token is not None:
1355
# A token was given to lock_write, and we're relocking, so check
1356
# that the given token actually matches the one we already have.
1357
if token != self._lock_token:
1358
raise errors.TokenMismatch(token, self._lock_token)
1359
self._lock_count += 1
1360
return self._lock_token or None
1362
def _unlock(self, branch_token, repo_token):
1363
path = self.bzrdir._path_for_remote_call(self._client)
1365
response = self._client.call('Branch.unlock', path, branch_token,
1367
except errors.ErrorFromSmartServer, err:
1368
if err.error_verb == 'TokenMismatch':
1369
raise errors.TokenMismatch(
1370
str((branch_token, repo_token)), '(remote tokens)')
1372
if response == ('ok',):
1374
raise errors.UnexpectedSmartServerResponse(response)
1377
self._lock_count -= 1
1378
if not self._lock_count:
1379
self._clear_cached_state()
1380
mode = self._lock_mode
1381
self._lock_mode = None
1382
if self._real_branch is not None:
1383
if (not self._leave_lock and mode == 'w' and
1384
self._repo_lock_token):
1385
# If this RemoteBranch will remove the physical lock for the
1386
# repository, make sure the _real_branch doesn't do it
1387
# first. (Because the _real_branch's repository is set to
1388
# be the RemoteRepository.)
1389
self._real_branch.repository.leave_lock_in_place()
1390
self._real_branch.unlock()
1392
# Only write-locked branched need to make a remote method call
1393
# to perfom the unlock.
1395
if not self._lock_token:
1396
raise AssertionError('Locked, but no token!')
1397
branch_token = self._lock_token
1398
repo_token = self._repo_lock_token
1399
self._lock_token = None
1400
self._repo_lock_token = None
1401
if not self._leave_lock:
1402
self._unlock(branch_token, repo_token)
1404
def break_lock(self):
1406
return self._real_branch.break_lock()
1408
def leave_lock_in_place(self):
1409
if not self._lock_token:
1410
raise NotImplementedError(self.leave_lock_in_place)
1411
self._leave_lock = True
1413
def dont_leave_lock_in_place(self):
1414
if not self._lock_token:
1415
raise NotImplementedError(self.dont_leave_lock_in_place)
1416
self._leave_lock = False
1418
def last_revision_info(self):
1419
"""See Branch.last_revision_info()."""
1420
path = self.bzrdir._path_for_remote_call(self._client)
1421
response = self._client.call('Branch.last_revision_info', path)
1422
if response[0] != 'ok':
1423
raise SmartProtocolError('unexpected response code %s' % (response,))
1424
revno = int(response[1])
1425
last_revision = response[2]
1426
return (revno, last_revision)
1428
def _gen_revision_history(self):
1429
"""See Branch._gen_revision_history()."""
1430
path = self.bzrdir._path_for_remote_call(self._client)
1431
response_tuple, response_handler = self._client.call_expecting_body(
1432
'Branch.revision_history', path)
1433
if response_tuple[0] != 'ok':
1434
raise UnexpectedSmartServerResponse(response_tuple)
1435
result = response_handler.read_body_bytes().split('\x00')
1441
def set_revision_history(self, rev_history):
1442
# Send just the tip revision of the history; the server will generate
1443
# the full history from that. If the revision doesn't exist in this
1444
# branch, NoSuchRevision will be raised.
1445
path = self.bzrdir._path_for_remote_call(self._client)
1446
if rev_history == []:
1449
rev_id = rev_history[-1]
1450
self._clear_cached_state()
1452
response = self._client.call('Branch.set_last_revision',
1453
path, self._lock_token, self._repo_lock_token, rev_id)
1454
except errors.ErrorFromSmartServer, err:
1455
if err.error_verb == 'NoSuchRevision':
1456
raise NoSuchRevision(self, rev_id)
1458
if response != ('ok',):
1459
raise errors.UnexpectedSmartServerResponse(response)
1460
self._cache_revision_history(rev_history)
1462
def get_parent(self):
1464
return self._real_branch.get_parent()
1466
def set_parent(self, url):
1468
return self._real_branch.set_parent(url)
1470
def sprout(self, to_bzrdir, revision_id=None):
1471
# Like Branch.sprout, except that it sprouts a branch in the default
1472
# format, because RemoteBranches can't be created at arbitrary URLs.
1473
# XXX: if to_bzrdir is a RemoteBranch, this should perhaps do
1474
# to_bzrdir.create_branch...
1476
result = self._real_branch._format.initialize(to_bzrdir)
1477
self.copy_content_into(result, revision_id=revision_id)
1478
result.set_parent(self.bzrdir.root_transport.base)
1482
def pull(self, source, overwrite=False, stop_revision=None,
1484
# FIXME: This asks the real branch to run the hooks, which means
1485
# they're called with the wrong target branch parameter.
1486
# The test suite specifically allows this at present but it should be
1487
# fixed. It should get a _override_hook_target branch,
1488
# as push does. -- mbp 20070405
1490
return self._real_branch.pull(
1491
source, overwrite=overwrite, stop_revision=stop_revision,
1495
def push(self, target, overwrite=False, stop_revision=None):
1497
return self._real_branch.push(
1498
target, overwrite=overwrite, stop_revision=stop_revision,
1499
_override_hook_source_branch=self)
1501
def is_locked(self):
1502
return self._lock_count >= 1
1505
def set_last_revision_info(self, revno, revision_id):
1506
revision_id = ensure_null(revision_id)
1507
path = self.bzrdir._path_for_remote_call(self._client)
1509
response = self._client.call('Branch.set_last_revision_info',
1510
path, self._lock_token, self._repo_lock_token, str(revno), revision_id)
1511
except errors.UnknownSmartMethod:
1513
self._clear_cached_state()
1514
return self._real_branch.set_last_revision_info(revno, revision_id)
1515
except errors.ErrorFromSmartServer, err:
1516
if err.error_verb == 'NoSuchRevision':
1517
raise NoSuchRevision(self, err.error_args[0])
1519
if response == ('ok',):
1520
self._clear_cached_state()
1522
raise errors.UnexpectedSmartServerResponse(response)
1524
def generate_revision_history(self, revision_id, last_rev=None,
1527
return self._real_branch.generate_revision_history(
1528
revision_id, last_rev=last_rev, other_branch=other_branch)
1533
return self._real_branch.tags
1535
def set_push_location(self, location):
1537
return self._real_branch.set_push_location(location)
1539
def update_revisions(self, other, stop_revision=None, overwrite=False,
1542
return self._real_branch.update_revisions(
1543
other, stop_revision=stop_revision, overwrite=overwrite,
1547
def _extract_tar(tar, to_dir):
1548
"""Extract all the contents of a tarfile object.
1550
A replacement for extractall, which is not present in python2.4
1553
tar.extract(tarinfo, to_dir)
added
removed
bzrlib/remote.py
