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)
786
def inventories(self):
788
return self._real_repository.inventories
790
def fileids_altered_by_revision_ids(self, revision_ids):
792
return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
794
def _get_versioned_file_checker(self, revisions, revision_versions_cache):
796
return self._real_repository._get_versioned_file_checker(
797
revisions, revision_versions_cache)
799
def iter_files_bytes(self, desired_files):
800
"""See Repository.iter_file_bytes.
803
return self._real_repository.iter_files_bytes(desired_files)
805
def get_parent_map(self, keys):
806
"""See bzrlib.Graph.get_parent_map()."""
807
# Hack to build up the caching logic.
808
ancestry = self._parents_map
810
# Repository is not locked, so there's no cache.
811
missing_revisions = set(keys)
814
missing_revisions = set(key for key in keys if key not in ancestry)
815
if missing_revisions:
816
parent_map = self._get_parent_map(missing_revisions)
817
if 'hpss' in debug.debug_flags:
818
mutter('retransmitted revisions: %d of %d',
819
len(set(ancestry).intersection(parent_map)),
821
ancestry.update(parent_map)
822
present_keys = [k for k in keys if k in ancestry]
823
if 'hpss' in debug.debug_flags:
824
if self._requested_parents is not None and len(ancestry) != 0:
825
self._requested_parents.update(present_keys)
826
mutter('Current RemoteRepository graph hit rate: %d%%',
827
100.0 * len(self._requested_parents) / len(ancestry))
828
return dict((k, ancestry[k]) for k in present_keys)
830
def _get_parent_map(self, keys):
831
"""Helper for get_parent_map that performs the RPC."""
832
medium = self._client._medium
833
if not medium._remote_is_at_least_1_2:
834
# We already found out that the server can't understand
835
# Repository.get_parent_map requests, so just fetch the whole
837
# XXX: Note that this will issue a deprecation warning. This is ok
838
# :- its because we're working with a deprecated server anyway, and
839
# the user will almost certainly have seen a warning about the
840
# server version already.
841
rg = self.get_revision_graph()
842
# There is an api discrepency between get_parent_map and
843
# get_revision_graph. Specifically, a "key:()" pair in
844
# get_revision_graph just means a node has no parents. For
845
# "get_parent_map" it means the node is a ghost. So fix up the
846
# graph to correct this.
847
# https://bugs.launchpad.net/bzr/+bug/214894
848
# There is one other "bug" which is that ghosts in
849
# get_revision_graph() are not returned at all. But we won't worry
850
# about that for now.
851
for node_id, parent_ids in rg.iteritems():
853
rg[node_id] = (NULL_REVISION,)
854
rg[NULL_REVISION] = ()
859
raise ValueError('get_parent_map(None) is not valid')
860
if NULL_REVISION in keys:
861
keys.discard(NULL_REVISION)
862
found_parents = {NULL_REVISION:()}
867
# TODO(Needs analysis): We could assume that the keys being requested
868
# from get_parent_map are in a breadth first search, so typically they
869
# will all be depth N from some common parent, and we don't have to
870
# have the server iterate from the root parent, but rather from the
871
# keys we're searching; and just tell the server the keyspace we
872
# already have; but this may be more traffic again.
874
# Transform self._parents_map into a search request recipe.
875
# TODO: Manage this incrementally to avoid covering the same path
876
# repeatedly. (The server will have to on each request, but the less
877
# work done the better).
878
parents_map = self._parents_map
879
if parents_map is None:
880
# Repository is not locked, so there's no cache.
882
start_set = set(parents_map)
883
result_parents = set()
884
for parents in parents_map.itervalues():
885
result_parents.update(parents)
886
stop_keys = result_parents.difference(start_set)
887
included_keys = start_set.intersection(result_parents)
888
start_set.difference_update(included_keys)
889
recipe = (start_set, stop_keys, len(parents_map))
890
body = self._serialise_search_recipe(recipe)
891
path = self.bzrdir._path_for_remote_call(self._client)
893
if type(key) is not str:
895
"key %r not a plain string" % (key,))
896
verb = 'Repository.get_parent_map'
897
args = (path,) + tuple(keys)
899
response = self._client.call_with_body_bytes_expecting_body(
900
verb, args, self._serialise_search_recipe(recipe))
901
except errors.UnknownSmartMethod:
902
# Server does not support this method, so get the whole graph.
903
# Worse, we have to force a disconnection, because the server now
904
# doesn't realise it has a body on the wire to consume, so the
905
# only way to recover is to abandon the connection.
907
'Server is too old for fast get_parent_map, reconnecting. '
908
'(Upgrade the server to Bazaar 1.2 to avoid this)')
910
# To avoid having to disconnect repeatedly, we keep track of the
911
# fact the server doesn't understand remote methods added in 1.2.
912
medium._remote_is_at_least_1_2 = False
913
return self.get_revision_graph(None)
914
response_tuple, response_handler = response
915
if response_tuple[0] not in ['ok']:
916
response_handler.cancel_read_body()
917
raise errors.UnexpectedSmartServerResponse(response_tuple)
918
if response_tuple[0] == 'ok':
919
coded = bz2.decompress(response_handler.read_body_bytes())
923
lines = coded.split('\n')
926
d = tuple(line.split())
928
revision_graph[d[0]] = d[1:]
930
# No parents - so give the Graph result (NULL_REVISION,).
931
revision_graph[d[0]] = (NULL_REVISION,)
932
return revision_graph
935
def get_signature_text(self, revision_id):
937
return self._real_repository.get_signature_text(revision_id)
940
@symbol_versioning.deprecated_method(symbol_versioning.one_three)
941
def get_revision_graph_with_ghosts(self, revision_ids=None):
943
return self._real_repository.get_revision_graph_with_ghosts(
944
revision_ids=revision_ids)
947
def get_inventory_xml(self, revision_id):
949
return self._real_repository.get_inventory_xml(revision_id)
951
def deserialise_inventory(self, revision_id, xml):
953
return self._real_repository.deserialise_inventory(revision_id, xml)
955
def reconcile(self, other=None, thorough=False):
957
return self._real_repository.reconcile(other=other, thorough=thorough)
959
def all_revision_ids(self):
961
return self._real_repository.all_revision_ids()
964
def get_deltas_for_revisions(self, revisions):
966
return self._real_repository.get_deltas_for_revisions(revisions)
969
def get_revision_delta(self, revision_id):
971
return self._real_repository.get_revision_delta(revision_id)
974
def revision_trees(self, revision_ids):
976
return self._real_repository.revision_trees(revision_ids)
979
def get_revision_reconcile(self, revision_id):
981
return self._real_repository.get_revision_reconcile(revision_id)
984
def check(self, revision_ids=None):
986
return self._real_repository.check(revision_ids=revision_ids)
988
def copy_content_into(self, destination, revision_id=None):
990
return self._real_repository.copy_content_into(
991
destination, revision_id=revision_id)
993
def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
994
# get a tarball of the remote repository, and copy from that into the
996
from bzrlib import osutils
999
# TODO: Maybe a progress bar while streaming the tarball?
1000
note("Copying repository content as tarball...")
1001
tar_file = self._get_tarball('bz2')
1002
if tar_file is None:
1004
destination = to_bzrdir.create_repository()
1006
tar = tarfile.open('repository', fileobj=tar_file,
1008
tmpdir = tempfile.mkdtemp()
1010
_extract_tar(tar, tmpdir)
1011
tmp_bzrdir = BzrDir.open(tmpdir)
1012
tmp_repo = tmp_bzrdir.open_repository()
1013
tmp_repo.copy_content_into(destination, revision_id)
1015
osutils.rmtree(tmpdir)
1019
# TODO: Suggestion from john: using external tar is much faster than
1020
# python's tarfile library, but it may not work on windows.
1023
def inventories(self):
1024
"""Decorate the real repository for now.
1026
In the long term a full blown network facility is needed to
1027
avoid creating a real repository object locally.
1030
return self._real_repository.inventories
1034
"""Compress the data within the repository.
1036
This is not currently implemented within the smart server.
1039
return self._real_repository.pack()
1042
def revisions(self):
1043
"""Decorate the real repository for now.
1045
In the short term this should become a real object to intercept graph
1048
In the long term a full blown network facility is needed.
1051
return self._real_repository.revisions
1053
def set_make_working_trees(self, new_value):
1055
self._real_repository.set_make_working_trees(new_value)
1058
def signatures(self):
1059
"""Decorate the real repository for now.
1061
In the long term a full blown network facility is needed to avoid
1062
creating a real repository object locally.
1065
return self._real_repository.signatures
1068
def sign_revision(self, revision_id, gpg_strategy):
1070
return self._real_repository.sign_revision(revision_id, gpg_strategy)
1074
"""Decorate the real repository for now.
1076
In the long term a full blown network facility is needed to avoid
1077
creating a real repository object locally.
1080
return self._real_repository.texts
1083
def get_revisions(self, revision_ids):
1085
return self._real_repository.get_revisions(revision_ids)
1087
def supports_rich_root(self):
1089
return self._real_repository.supports_rich_root()
1091
def iter_reverse_revision_history(self, revision_id):
1093
return self._real_repository.iter_reverse_revision_history(revision_id)
1096
def _serializer(self):
1098
return self._real_repository._serializer
1100
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1102
return self._real_repository.store_revision_signature(
1103
gpg_strategy, plaintext, revision_id)
1105
def add_signature_text(self, revision_id, signature):
1107
return self._real_repository.add_signature_text(revision_id, signature)
1109
def has_signature_for_revision_id(self, revision_id):
1111
return self._real_repository.has_signature_for_revision_id(revision_id)
1113
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
1115
return self._real_repository.item_keys_introduced_by(revision_ids,
1116
_files_pb=_files_pb)
1118
def revision_graph_can_have_wrong_parents(self):
1119
# The answer depends on the remote repo format.
1121
return self._real_repository.revision_graph_can_have_wrong_parents()
1123
def _find_inconsistent_revision_parents(self):
1125
return self._real_repository._find_inconsistent_revision_parents()
1127
def _check_for_inconsistent_revision_parents(self):
1129
return self._real_repository._check_for_inconsistent_revision_parents()
1131
def _make_parents_provider(self):
1134
def _serialise_search_recipe(self, recipe):
1135
"""Serialise a graph search recipe.
1137
:param recipe: A search recipe (start, stop, count).
1138
:return: Serialised bytes.
1140
start_keys = ' '.join(recipe[0])
1141
stop_keys = ' '.join(recipe[1])
1142
count = str(recipe[2])
1143
return '\n'.join((start_keys, stop_keys, count))
1146
class RemoteBranchLockableFiles(LockableFiles):
1147
"""A 'LockableFiles' implementation that talks to a smart server.
1149
This is not a public interface class.
1152
def __init__(self, bzrdir, _client):
1153
self.bzrdir = bzrdir
1154
self._client = _client
1155
self._need_find_modes = True
1156
LockableFiles.__init__(
1157
self, bzrdir.get_branch_transport(None),
1158
'lock', lockdir.LockDir)
1160
def _find_modes(self):
1161
# RemoteBranches don't let the client set the mode of control files.
1162
self._dir_mode = None
1163
self._file_mode = None
1166
class RemoteBranchFormat(branch.BranchFormat):
1168
def __eq__(self, other):
1169
return (isinstance(other, RemoteBranchFormat) and
1170
self.__dict__ == other.__dict__)
1172
def get_format_description(self):
1173
return 'Remote BZR Branch'
1175
def get_format_string(self):
1176
return 'Remote BZR Branch'
1178
def open(self, a_bzrdir):
1179
return a_bzrdir.open_branch()
1181
def initialize(self, a_bzrdir):
1182
return a_bzrdir.create_branch()
1184
def supports_tags(self):
1185
# Remote branches might support tags, but we won't know until we
1186
# access the real remote branch.
1190
class RemoteBranch(branch.Branch):
1191
"""Branch stored on a server accessed by HPSS RPC.
1193
At the moment most operations are mapped down to simple file operations.
1196
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
1198
"""Create a RemoteBranch instance.
1200
:param real_branch: An optional local implementation of the branch
1201
format, usually accessing the data via the VFS.
1202
:param _client: Private parameter for testing.
1204
# We intentionally don't call the parent class's __init__, because it
1205
# will try to assign to self.tags, which is a property in this subclass.
1206
# And the parent's __init__ doesn't do much anyway.
1207
self._revision_id_to_revno_cache = None
1208
self._revision_history_cache = None
1209
self.bzrdir = remote_bzrdir
1210
if _client is not None:
1211
self._client = _client
1213
self._client = remote_bzrdir._client
1214
self.repository = remote_repository
1215
if real_branch is not None:
1216
self._real_branch = real_branch
1217
# Give the remote repository the matching real repo.
1218
real_repo = self._real_branch.repository
1219
if isinstance(real_repo, RemoteRepository):
1220
real_repo._ensure_real()
1221
real_repo = real_repo._real_repository
1222
self.repository._set_real_repository(real_repo)
1223
# Give the branch the remote repository to let fast-pathing happen.
1224
self._real_branch.repository = self.repository
1226
self._real_branch = None
1227
# Fill out expected attributes of branch for bzrlib api users.
1228
self._format = RemoteBranchFormat()
1229
self.base = self.bzrdir.root_transport.base
1230
self._control_files = None
1231
self._lock_mode = None
1232
self._lock_token = None
1233
self._repo_lock_token = None
1234
self._lock_count = 0
1235
self._leave_lock = False
1237
def _get_real_transport(self):
1238
# if we try vfs access, return the real branch's vfs transport
1240
return self._real_branch._transport
1242
_transport = property(_get_real_transport)
1245
return "%s(%s)" % (self.__class__.__name__, self.base)
1249
def _ensure_real(self):
1250
"""Ensure that there is a _real_branch set.
1252
Used before calls to self._real_branch.
1254
if self._real_branch is None:
1255
if not vfs.vfs_enabled():
1256
raise AssertionError('smart server vfs must be enabled '
1257
'to use vfs implementation')
1258
self.bzrdir._ensure_real()
1259
self._real_branch = self.bzrdir._real_bzrdir.open_branch()
1260
# Give the remote repository the matching real repo.
1261
real_repo = self._real_branch.repository
1262
if isinstance(real_repo, RemoteRepository):
1263
real_repo._ensure_real()
1264
real_repo = real_repo._real_repository
1265
self.repository._set_real_repository(real_repo)
1266
# Give the branch the remote repository to let fast-pathing happen.
1267
self._real_branch.repository = self.repository
1268
# XXX: deal with _lock_mode == 'w'
1269
if self._lock_mode == 'r':
1270
self._real_branch.lock_read()
1273
def control_files(self):
1274
# Defer actually creating RemoteBranchLockableFiles until its needed,
1275
# because it triggers an _ensure_real that we otherwise might not need.
1276
if self._control_files is None:
1277
self._control_files = RemoteBranchLockableFiles(
1278
self.bzrdir, self._client)
1279
return self._control_files
1281
def _get_checkout_format(self):
1283
return self._real_branch._get_checkout_format()
1285
def get_physical_lock_status(self):
1286
"""See Branch.get_physical_lock_status()."""
1287
# should be an API call to the server, as branches must be lockable.
1289
return self._real_branch.get_physical_lock_status()
1291
def lock_read(self):
1292
if not self._lock_mode:
1293
self._lock_mode = 'r'
1294
self._lock_count = 1
1295
if self._real_branch is not None:
1296
self._real_branch.lock_read()
1298
self._lock_count += 1
1300
def _remote_lock_write(self, token):
1302
branch_token = repo_token = ''
1304
branch_token = token
1305
repo_token = self.repository.lock_write()
1306
self.repository.unlock()
1307
path = self.bzrdir._path_for_remote_call(self._client)
1309
response = self._client.call(
1310
'Branch.lock_write', path, branch_token, repo_token or '')
1311
except errors.ErrorFromSmartServer, err:
1312
if err.error_verb == 'LockContention':
1313
raise errors.LockContention('(remote lock)')
1314
elif err.error_verb == 'TokenMismatch':
1315
raise errors.TokenMismatch(token, '(remote token)')
1316
elif err.error_verb == 'UnlockableTransport':
1317
raise errors.UnlockableTransport(self.bzrdir.root_transport)
1318
elif err.error_verb == 'ReadOnlyError':
1319
raise errors.ReadOnlyError(self)
1320
elif err.error_verb == 'LockFailed':
1321
raise errors.LockFailed(err.error_args[0], err.error_args[1])
1323
if response[0] != 'ok':
1324
raise errors.UnexpectedSmartServerResponse(response)
1325
ok, branch_token, repo_token = response
1326
return branch_token, repo_token
1328
def lock_write(self, token=None):
1329
if not self._lock_mode:
1330
remote_tokens = self._remote_lock_write(token)
1331
self._lock_token, self._repo_lock_token = remote_tokens
1332
if not self._lock_token:
1333
raise SmartProtocolError('Remote server did not return a token!')
1334
# TODO: We really, really, really don't want to call _ensure_real
1335
# here, but it's the easiest way to ensure coherency between the
1336
# state of the RemoteBranch and RemoteRepository objects and the
1337
# physical locks. If we don't materialise the real objects here,
1338
# then getting everything in the right state later is complex, so
1339
# for now we just do it the lazy way.
1340
# -- Andrew Bennetts, 2007-02-22.
1342
if self._real_branch is not None:
1343
self._real_branch.repository.lock_write(
1344
token=self._repo_lock_token)
1346
self._real_branch.lock_write(token=self._lock_token)
1348
self._real_branch.repository.unlock()
1349
if token is not None:
1350
self._leave_lock = True
1352
# XXX: this case seems to be unreachable; token cannot be None.
1353
self._leave_lock = False
1354
self._lock_mode = 'w'
1355
self._lock_count = 1
1356
elif self._lock_mode == 'r':
1357
raise errors.ReadOnlyTransaction
1359
if token is not None:
1360
# A token was given to lock_write, and we're relocking, so check
1361
# that the given token actually matches the one we already have.
1362
if token != self._lock_token:
1363
raise errors.TokenMismatch(token, self._lock_token)
1364
self._lock_count += 1
1365
return self._lock_token or None
1367
def _unlock(self, branch_token, repo_token):
1368
path = self.bzrdir._path_for_remote_call(self._client)
1370
response = self._client.call('Branch.unlock', path, branch_token,
1372
except errors.ErrorFromSmartServer, err:
1373
if err.error_verb == 'TokenMismatch':
1374
raise errors.TokenMismatch(
1375
str((branch_token, repo_token)), '(remote tokens)')
1377
if response == ('ok',):
1379
raise errors.UnexpectedSmartServerResponse(response)
1382
self._lock_count -= 1
1383
if not self._lock_count:
1384
self._clear_cached_state()
1385
mode = self._lock_mode
1386
self._lock_mode = None
1387
if self._real_branch is not None:
1388
if (not self._leave_lock and mode == 'w' and
1389
self._repo_lock_token):
1390
# If this RemoteBranch will remove the physical lock for the
1391
# repository, make sure the _real_branch doesn't do it
1392
# first. (Because the _real_branch's repository is set to
1393
# be the RemoteRepository.)
1394
self._real_branch.repository.leave_lock_in_place()
1395
self._real_branch.unlock()
1397
# Only write-locked branched need to make a remote method call
1398
# to perfom the unlock.
1400
if not self._lock_token:
1401
raise AssertionError('Locked, but no token!')
1402
branch_token = self._lock_token
1403
repo_token = self._repo_lock_token
1404
self._lock_token = None
1405
self._repo_lock_token = None
1406
if not self._leave_lock:
1407
self._unlock(branch_token, repo_token)
1409
def break_lock(self):
1411
return self._real_branch.break_lock()
1413
def leave_lock_in_place(self):
1414
if not self._lock_token:
1415
raise NotImplementedError(self.leave_lock_in_place)
1416
self._leave_lock = True
1418
def dont_leave_lock_in_place(self):
1419
if not self._lock_token:
1420
raise NotImplementedError(self.dont_leave_lock_in_place)
1421
self._leave_lock = False
1423
def last_revision_info(self):
1424
"""See Branch.last_revision_info()."""
1425
path = self.bzrdir._path_for_remote_call(self._client)
1426
response = self._client.call('Branch.last_revision_info', path)
1427
if response[0] != 'ok':
1428
raise SmartProtocolError('unexpected response code %s' % (response,))
1429
revno = int(response[1])
1430
last_revision = response[2]
1431
return (revno, last_revision)
1433
def _gen_revision_history(self):
1434
"""See Branch._gen_revision_history()."""
1435
path = self.bzrdir._path_for_remote_call(self._client)
1436
response_tuple, response_handler = self._client.call_expecting_body(
1437
'Branch.revision_history', path)
1438
if response_tuple[0] != 'ok':
1439
raise UnexpectedSmartServerResponse(response_tuple)
1440
result = response_handler.read_body_bytes().split('\x00')
1446
def set_revision_history(self, rev_history):
1447
# Send just the tip revision of the history; the server will generate
1448
# the full history from that. If the revision doesn't exist in this
1449
# branch, NoSuchRevision will be raised.
1450
path = self.bzrdir._path_for_remote_call(self._client)
1451
if rev_history == []:
1454
rev_id = rev_history[-1]
1455
self._clear_cached_state()
1457
response = self._client.call('Branch.set_last_revision',
1458
path, self._lock_token, self._repo_lock_token, rev_id)
1459
except errors.ErrorFromSmartServer, err:
1460
if err.error_verb == 'NoSuchRevision':
1461
raise NoSuchRevision(self, rev_id)
1463
if response != ('ok',):
1464
raise errors.UnexpectedSmartServerResponse(response)
1465
self._cache_revision_history(rev_history)
1467
def get_parent(self):
1469
return self._real_branch.get_parent()
1471
def set_parent(self, url):
1473
return self._real_branch.set_parent(url)
1475
def sprout(self, to_bzrdir, revision_id=None):
1476
# Like Branch.sprout, except that it sprouts a branch in the default
1477
# format, because RemoteBranches can't be created at arbitrary URLs.
1478
# XXX: if to_bzrdir is a RemoteBranch, this should perhaps do
1479
# to_bzrdir.create_branch...
1481
result = self._real_branch._format.initialize(to_bzrdir)
1482
self.copy_content_into(result, revision_id=revision_id)
1483
result.set_parent(self.bzrdir.root_transport.base)
1487
def pull(self, source, overwrite=False, stop_revision=None,
1489
# FIXME: This asks the real branch to run the hooks, which means
1490
# they're called with the wrong target branch parameter.
1491
# The test suite specifically allows this at present but it should be
1492
# fixed. It should get a _override_hook_target branch,
1493
# as push does. -- mbp 20070405
1495
return self._real_branch.pull(
1496
source, overwrite=overwrite, stop_revision=stop_revision,
1500
def push(self, target, overwrite=False, stop_revision=None):
1502
return self._real_branch.push(
1503
target, overwrite=overwrite, stop_revision=stop_revision,
1504
_override_hook_source_branch=self)
1506
def is_locked(self):
1507
return self._lock_count >= 1
1510
def set_last_revision_info(self, revno, revision_id):
1511
revision_id = ensure_null(revision_id)
1512
path = self.bzrdir._path_for_remote_call(self._client)
1514
response = self._client.call('Branch.set_last_revision_info',
1515
path, self._lock_token, self._repo_lock_token, str(revno), revision_id)
1516
except errors.UnknownSmartMethod:
1518
self._clear_cached_state()
1519
return self._real_branch.set_last_revision_info(revno, revision_id)
1520
except errors.ErrorFromSmartServer, err:
1521
if err.error_verb == 'NoSuchRevision':
1522
raise NoSuchRevision(self, err.error_args[0])
1524
if response == ('ok',):
1525
self._clear_cached_state()
1527
raise errors.UnexpectedSmartServerResponse(response)
1529
def generate_revision_history(self, revision_id, last_rev=None,
1532
return self._real_branch.generate_revision_history(
1533
revision_id, last_rev=last_rev, other_branch=other_branch)
1538
return self._real_branch.tags
1540
def set_push_location(self, location):
1542
return self._real_branch.set_push_location(location)
1544
def update_revisions(self, other, stop_revision=None, overwrite=False,
1547
return self._real_branch.update_revisions(
1548
other, stop_revision=stop_revision, overwrite=overwrite,
1552
def _extract_tar(tar, to_dir):
1553
"""Extract all the contents of a tarfile object.
1555
A replacement for extractall, which is not present in python2.4
1558
tar.extract(tarinfo, to_dir)
added
removed
bzrlib/remote.py
