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.revision import ensure_null, NULL_REVISION
45
from bzrlib.trace import mutter, note, warning
47
# Note: RemoteBzrDirFormat is in bzrdir.py
49
class RemoteBzrDir(BzrDir):
50
"""Control directory on a remote server, accessed via bzr:// or similar."""
52
def __init__(self, transport, _client=None):
53
"""Construct a RemoteBzrDir.
55
:param _client: Private parameter for testing. Disables probing and the
58
BzrDir.__init__(self, transport, RemoteBzrDirFormat())
59
# this object holds a delegated bzrdir that uses file-level operations
60
# to talk to the other side
61
self._real_bzrdir = None
64
medium = transport.get_smart_medium()
65
self._client = client._SmartClient(medium, transport.base)
67
self._client = _client
70
path = self._path_for_remote_call(self._client)
71
response = self._client.call('BzrDir.open', path)
72
if response not in [('yes',), ('no',)]:
73
raise errors.UnexpectedSmartServerResponse(response)
74
if response == ('no',):
75
raise errors.NotBranchError(path=transport.base)
77
def _ensure_real(self):
78
"""Ensure that there is a _real_bzrdir set.
80
Used before calls to self._real_bzrdir.
82
if not self._real_bzrdir:
83
self._real_bzrdir = BzrDir.open_from_transport(
84
self.root_transport, _server_formats=False)
86
def create_repository(self, shared=False):
88
self._real_bzrdir.create_repository(shared=shared)
89
return self.open_repository()
91
def destroy_repository(self):
92
"""See BzrDir.destroy_repository"""
94
self._real_bzrdir.destroy_repository()
96
def create_branch(self):
98
real_branch = self._real_bzrdir.create_branch()
99
return RemoteBranch(self, self.find_repository(), real_branch)
101
def destroy_branch(self):
102
"""See BzrDir.destroy_branch"""
104
self._real_bzrdir.destroy_branch()
106
def create_workingtree(self, revision_id=None, from_branch=None):
107
raise errors.NotLocalUrl(self.transport.base)
109
def find_branch_format(self):
110
"""Find the branch 'format' for this bzrdir.
112
This might be a synthetic object for e.g. RemoteBranch and SVN.
114
b = self.open_branch()
117
def get_branch_reference(self):
118
"""See BzrDir.get_branch_reference()."""
119
path = self._path_for_remote_call(self._client)
121
response = self._client.call('BzrDir.open_branch', path)
122
except errors.ErrorFromSmartServer, err:
123
if err.error_tuple == ('nobranch',):
124
raise errors.NotBranchError(path=self.root_transport.base)
126
if response[0] == 'ok':
127
if response[1] == '':
128
# branch at this location.
131
# a branch reference, use the existing BranchReference logic.
134
raise errors.UnexpectedSmartServerResponse(response)
136
def _get_tree_branch(self):
137
"""See BzrDir._get_tree_branch()."""
138
return None, self.open_branch()
140
def open_branch(self, _unsupported=False):
142
raise NotImplementedError('unsupported flag support not implemented yet.')
143
reference_url = self.get_branch_reference()
144
if reference_url is None:
145
# branch at this location.
146
return RemoteBranch(self, self.find_repository())
148
# a branch reference, use the existing BranchReference logic.
149
format = BranchReferenceFormat()
150
return format.open(self, _found=True, location=reference_url)
152
def open_repository(self):
153
path = self._path_for_remote_call(self._client)
154
verb = 'BzrDir.find_repositoryV2'
157
response = self._client.call(verb, path)
158
except errors.UnknownSmartMethod:
159
verb = 'BzrDir.find_repository'
160
response = self._client.call(verb, path)
161
except errors.ErrorFromSmartServer, err:
162
if err.error_verb == 'norepository':
163
raise errors.NoRepositoryPresent(self)
165
if response[0] != 'ok':
166
raise errors.UnexpectedSmartServerResponse(response)
167
if verb == 'BzrDir.find_repository':
168
# servers that don't support the V2 method don't support external
170
response = response + ('no', )
171
if not (len(response) == 5):
172
raise SmartProtocolError('incorrect response length %s' % (response,))
173
if response[1] == '':
174
format = RemoteRepositoryFormat()
175
format.rich_root_data = (response[2] == 'yes')
176
format.supports_tree_reference = (response[3] == 'yes')
177
# No wire format to check this yet.
178
format.supports_external_lookups = (response[4] == 'yes')
179
return RemoteRepository(self, format)
181
raise errors.NoRepositoryPresent(self)
183
def open_workingtree(self, recommend_upgrade=True):
185
if self._real_bzrdir.has_workingtree():
186
raise errors.NotLocalUrl(self.root_transport)
188
raise errors.NoWorkingTree(self.root_transport.base)
190
def _path_for_remote_call(self, client):
191
"""Return the path to be used for this bzrdir in a remote call."""
192
return client.remote_path_from_transport(self.root_transport)
194
def get_branch_transport(self, branch_format):
196
return self._real_bzrdir.get_branch_transport(branch_format)
198
def get_repository_transport(self, repository_format):
200
return self._real_bzrdir.get_repository_transport(repository_format)
202
def get_workingtree_transport(self, workingtree_format):
204
return self._real_bzrdir.get_workingtree_transport(workingtree_format)
206
def can_convert_format(self):
207
"""Upgrading of remote bzrdirs is not supported yet."""
210
def needs_format_conversion(self, format=None):
211
"""Upgrading of remote bzrdirs is not supported yet."""
214
def clone(self, url, revision_id=None, force_new_repo=False):
216
return self._real_bzrdir.clone(url, revision_id=revision_id,
217
force_new_repo=force_new_repo)
220
class RemoteRepositoryFormat(repository.RepositoryFormat):
221
"""Format for repositories accessed over a _SmartClient.
223
Instances of this repository are represented by RemoteRepository
226
The RemoteRepositoryFormat is parameterized during construction
227
to reflect the capabilities of the real, remote format. Specifically
228
the attributes rich_root_data and supports_tree_reference are set
229
on a per instance basis, and are not set (and should not be) at
233
_matchingbzrdir = RemoteBzrDirFormat
235
def initialize(self, a_bzrdir, shared=False):
236
if not isinstance(a_bzrdir, RemoteBzrDir):
237
raise AssertionError('%r is not a RemoteBzrDir' % (a_bzrdir,))
238
return a_bzrdir.create_repository(shared=shared)
240
def open(self, a_bzrdir):
241
if not isinstance(a_bzrdir, RemoteBzrDir):
242
raise AssertionError('%r is not a RemoteBzrDir' % (a_bzrdir,))
243
return a_bzrdir.open_repository()
245
def get_format_description(self):
246
return 'bzr remote repository'
248
def __eq__(self, other):
249
return self.__class__ == other.__class__
251
def check_conversion_target(self, target_format):
252
if self.rich_root_data and not target_format.rich_root_data:
253
raise errors.BadConversionTarget(
254
'Does not support rich root data.', target_format)
255
if (self.supports_tree_reference and
256
not getattr(target_format, 'supports_tree_reference', False)):
257
raise errors.BadConversionTarget(
258
'Does not support nested trees', target_format)
261
class RemoteRepository(object):
262
"""Repository accessed over rpc.
264
For the moment most operations are performed using local transport-backed
268
def __init__(self, remote_bzrdir, format, real_repository=None, _client=None):
269
"""Create a RemoteRepository instance.
271
:param remote_bzrdir: The bzrdir hosting this repository.
272
:param format: The RemoteFormat object to use.
273
:param real_repository: If not None, a local implementation of the
274
repository logic for the repository, usually accessing the data
276
:param _client: Private testing parameter - override the smart client
277
to be used by the repository.
280
self._real_repository = real_repository
282
self._real_repository = None
283
self.bzrdir = remote_bzrdir
285
self._client = remote_bzrdir._client
287
self._client = _client
288
self._format = format
289
self._lock_mode = None
290
self._lock_token = None
292
self._leave_lock = False
293
# A cache of looked up revision parent data; reset at unlock time.
294
self._parents_map = None
295
if 'hpss' in debug.debug_flags:
296
self._requested_parents = None
298
# These depend on the actual remote format, so force them off for
299
# maximum compatibility. XXX: In future these should depend on the
300
# remote repository instance, but this is irrelevant until we perform
301
# reconcile via an RPC call.
302
self._reconcile_does_inventory_gc = False
303
self._reconcile_fixes_text_parents = False
304
self._reconcile_backsup_inventory = False
305
self.base = self.bzrdir.transport.base
308
return "%s(%s)" % (self.__class__.__name__, self.base)
312
def abort_write_group(self):
313
"""Complete a write group on the decorated repository.
315
Smart methods peform operations in a single step so this api
316
is not really applicable except as a compatibility thunk
317
for older plugins that don't use e.g. the CommitBuilder
321
return self._real_repository.abort_write_group()
323
def commit_write_group(self):
324
"""Complete a write group on the decorated repository.
326
Smart methods peform operations in a single step so this api
327
is not really applicable except as a compatibility thunk
328
for older plugins that don't use e.g. the CommitBuilder
332
return self._real_repository.commit_write_group()
334
def _ensure_real(self):
335
"""Ensure that there is a _real_repository set.
337
Used before calls to self._real_repository.
339
if not self._real_repository:
340
self.bzrdir._ensure_real()
341
#self._real_repository = self.bzrdir._real_bzrdir.open_repository()
342
self._set_real_repository(self.bzrdir._real_bzrdir.open_repository())
344
def find_text_key_references(self):
345
"""Find the text key references within the repository.
347
:return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
348
revision_ids. Each altered file-ids has the exact revision_ids that
349
altered it listed explicitly.
350
:return: A dictionary mapping text keys ((fileid, revision_id) tuples)
351
to whether they were referred to by the inventory of the
352
revision_id that they contain. The inventory texts from all present
353
revision ids are assessed to generate this report.
356
return self._real_repository.find_text_key_references()
358
def _generate_text_key_index(self):
359
"""Generate a new text key index for the repository.
361
This is an expensive function that will take considerable time to run.
363
:return: A dict mapping (file_id, revision_id) tuples to a list of
364
parents, also (file_id, revision_id) tuples.
367
return self._real_repository._generate_text_key_index()
369
@symbol_versioning.deprecated_method(symbol_versioning.one_four)
370
def get_revision_graph(self, revision_id=None):
371
"""See Repository.get_revision_graph()."""
372
return self._get_revision_graph(revision_id)
374
def _get_revision_graph(self, revision_id):
375
"""Private method for using with old (< 1.2) servers to fallback."""
376
if revision_id is None:
378
elif revision.is_null(revision_id):
381
path = self.bzrdir._path_for_remote_call(self._client)
383
response = self._client.call_expecting_body(
384
'Repository.get_revision_graph', path, revision_id)
385
except errors.ErrorFromSmartServer, err:
386
if err.error_verb == 'nosuchrevision':
387
raise NoSuchRevision(self, revision_id)
389
response_tuple, response_handler = response
390
if response_tuple[0] != 'ok':
391
raise errors.UnexpectedSmartServerResponse(response_tuple)
392
coded = response_handler.read_body_bytes()
394
# no revisions in this repository!
396
lines = coded.split('\n')
399
d = tuple(line.split())
400
revision_graph[d[0]] = d[1:]
402
return revision_graph
404
def has_revision(self, revision_id):
405
"""See Repository.has_revision()."""
406
if revision_id == NULL_REVISION:
407
# The null revision is always present.
409
path = self.bzrdir._path_for_remote_call(self._client)
410
response = self._client.call(
411
'Repository.has_revision', path, revision_id)
412
if response[0] not in ('yes', 'no'):
413
raise errors.UnexpectedSmartServerResponse(response)
414
return response[0] == 'yes'
416
def has_revisions(self, revision_ids):
417
"""See Repository.has_revisions()."""
419
for revision_id in revision_ids:
420
if self.has_revision(revision_id):
421
result.add(revision_id)
424
def has_same_location(self, other):
425
return (self.__class__ == other.__class__ and
426
self.bzrdir.transport.base == other.bzrdir.transport.base)
428
def get_graph(self, other_repository=None):
429
"""Return the graph for this repository format"""
430
parents_provider = self
431
if (other_repository is not None and
432
other_repository.bzrdir.transport.base !=
433
self.bzrdir.transport.base):
434
parents_provider = graph._StackedParentsProvider(
435
[parents_provider, other_repository._make_parents_provider()])
436
return graph.Graph(parents_provider)
438
def gather_stats(self, revid=None, committers=None):
439
"""See Repository.gather_stats()."""
440
path = self.bzrdir._path_for_remote_call(self._client)
441
# revid can be None to indicate no revisions, not just NULL_REVISION
442
if revid is None or revision.is_null(revid):
446
if committers is None or not committers:
447
fmt_committers = 'no'
449
fmt_committers = 'yes'
450
response_tuple, response_handler = self._client.call_expecting_body(
451
'Repository.gather_stats', path, fmt_revid, fmt_committers)
452
if response_tuple[0] != 'ok':
453
raise errors.UnexpectedSmartServerResponse(response_tuple)
455
body = response_handler.read_body_bytes()
457
for line in body.split('\n'):
460
key, val_text = line.split(':')
461
if key in ('revisions', 'size', 'committers'):
462
result[key] = int(val_text)
463
elif key in ('firstrev', 'latestrev'):
464
values = val_text.split(' ')[1:]
465
result[key] = (float(values[0]), long(values[1]))
469
def find_branches(self, using=False):
470
"""See Repository.find_branches()."""
471
# should be an API call to the server.
473
return self._real_repository.find_branches(using=using)
475
def get_physical_lock_status(self):
476
"""See Repository.get_physical_lock_status()."""
477
# should be an API call to the server.
479
return self._real_repository.get_physical_lock_status()
481
def is_in_write_group(self):
482
"""Return True if there is an open write group.
484
write groups are only applicable locally for the smart server..
486
if self._real_repository:
487
return self._real_repository.is_in_write_group()
490
return self._lock_count >= 1
493
"""See Repository.is_shared()."""
494
path = self.bzrdir._path_for_remote_call(self._client)
495
response = self._client.call('Repository.is_shared', path)
496
if response[0] not in ('yes', 'no'):
497
raise SmartProtocolError('unexpected response code %s' % (response,))
498
return response[0] == 'yes'
500
def is_write_locked(self):
501
return self._lock_mode == 'w'
504
# wrong eventually - want a local lock cache context
505
if not self._lock_mode:
506
self._lock_mode = 'r'
508
self._parents_map = {}
509
if 'hpss' in debug.debug_flags:
510
self._requested_parents = set()
511
if self._real_repository is not None:
512
self._real_repository.lock_read()
514
self._lock_count += 1
516
def _remote_lock_write(self, token):
517
path = self.bzrdir._path_for_remote_call(self._client)
521
response = self._client.call('Repository.lock_write', path, token)
522
except errors.ErrorFromSmartServer, err:
523
if err.error_verb == 'LockContention':
524
raise errors.LockContention('(remote lock)')
525
elif err.error_verb == 'UnlockableTransport':
526
raise errors.UnlockableTransport(self.bzrdir.root_transport)
527
elif err.error_verb == 'LockFailed':
528
raise errors.LockFailed(err.error_args[0], err.error_args[1])
531
if response[0] == 'ok':
535
raise errors.UnexpectedSmartServerResponse(response)
537
def lock_write(self, token=None):
538
if not self._lock_mode:
539
self._lock_token = self._remote_lock_write(token)
540
# if self._lock_token is None, then this is something like packs or
541
# svn where we don't get to lock the repo, or a weave style repository
542
# where we cannot lock it over the wire and attempts to do so will
544
if self._real_repository is not None:
545
self._real_repository.lock_write(token=self._lock_token)
546
if token is not None:
547
self._leave_lock = True
549
self._leave_lock = False
550
self._lock_mode = 'w'
552
self._parents_map = {}
553
if 'hpss' in debug.debug_flags:
554
self._requested_parents = set()
555
elif self._lock_mode == 'r':
556
raise errors.ReadOnlyError(self)
558
self._lock_count += 1
559
return self._lock_token or None
561
def leave_lock_in_place(self):
562
if not self._lock_token:
563
raise NotImplementedError(self.leave_lock_in_place)
564
self._leave_lock = True
566
def dont_leave_lock_in_place(self):
567
if not self._lock_token:
568
raise NotImplementedError(self.dont_leave_lock_in_place)
569
self._leave_lock = False
571
def _set_real_repository(self, repository):
572
"""Set the _real_repository for this repository.
574
:param repository: The repository to fallback to for non-hpss
575
implemented operations.
577
if isinstance(repository, RemoteRepository):
578
raise AssertionError()
579
self._real_repository = repository
580
if self._lock_mode == 'w':
581
# if we are already locked, the real repository must be able to
582
# acquire the lock with our token.
583
self._real_repository.lock_write(self._lock_token)
584
elif self._lock_mode == 'r':
585
self._real_repository.lock_read()
587
def start_write_group(self):
588
"""Start a write group on the decorated repository.
590
Smart methods peform operations in a single step so this api
591
is not really applicable except as a compatibility thunk
592
for older plugins that don't use e.g. the CommitBuilder
596
return self._real_repository.start_write_group()
598
def _unlock(self, token):
599
path = self.bzrdir._path_for_remote_call(self._client)
601
# with no token the remote repository is not persistently locked.
604
response = self._client.call('Repository.unlock', path, token)
605
except errors.ErrorFromSmartServer, err:
606
if err.error_verb == 'TokenMismatch':
607
raise errors.TokenMismatch(token, '(remote token)')
609
if response == ('ok',):
612
raise errors.UnexpectedSmartServerResponse(response)
615
self._lock_count -= 1
616
if self._lock_count > 0:
618
self._parents_map = None
619
if 'hpss' in debug.debug_flags:
620
self._requested_parents = None
621
old_mode = self._lock_mode
622
self._lock_mode = None
624
# The real repository is responsible at present for raising an
625
# exception if it's in an unfinished write group. However, it
626
# normally will *not* actually remove the lock from disk - that's
627
# done by the server on receiving the Repository.unlock call.
628
# This is just to let the _real_repository stay up to date.
629
if self._real_repository is not None:
630
self._real_repository.unlock()
632
# The rpc-level lock should be released even if there was a
633
# problem releasing the vfs-based lock.
635
# Only write-locked repositories need to make a remote method
636
# call to perfom the unlock.
637
old_token = self._lock_token
638
self._lock_token = None
639
if not self._leave_lock:
640
self._unlock(old_token)
642
def break_lock(self):
643
# should hand off to the network
645
return self._real_repository.break_lock()
647
def _get_tarball(self, compression):
648
"""Return a TemporaryFile containing a repository tarball.
650
Returns None if the server does not support sending tarballs.
653
path = self.bzrdir._path_for_remote_call(self._client)
655
response, protocol = self._client.call_expecting_body(
656
'Repository.tarball', path, compression)
657
except errors.UnknownSmartMethod:
658
protocol.cancel_read_body()
660
if response[0] == 'ok':
661
# Extract the tarball and return it
662
t = tempfile.NamedTemporaryFile()
663
# TODO: rpc layer should read directly into it...
664
t.write(protocol.read_body_bytes())
667
raise errors.UnexpectedSmartServerResponse(response)
669
def sprout(self, to_bzrdir, revision_id=None):
670
# TODO: Option to control what format is created?
672
dest_repo = self._real_repository._format.initialize(to_bzrdir,
674
dest_repo.fetch(self, revision_id=revision_id)
677
### These methods are just thin shims to the VFS object for now.
679
def revision_tree(self, revision_id):
681
return self._real_repository.revision_tree(revision_id)
683
def get_serializer_format(self):
685
return self._real_repository.get_serializer_format()
687
def get_commit_builder(self, branch, parents, config, timestamp=None,
688
timezone=None, committer=None, revprops=None,
690
# FIXME: It ought to be possible to call this without immediately
691
# triggering _ensure_real. For now it's the easiest thing to do.
693
builder = self._real_repository.get_commit_builder(branch, parents,
694
config, timestamp=timestamp, timezone=timezone,
695
committer=committer, revprops=revprops, revision_id=revision_id)
698
def add_inventory(self, revid, inv, parents):
700
return self._real_repository.add_inventory(revid, inv, parents)
702
def add_revision(self, rev_id, rev, inv=None, config=None):
704
return self._real_repository.add_revision(
705
rev_id, rev, inv=inv, config=config)
708
def get_inventory(self, revision_id):
710
return self._real_repository.get_inventory(revision_id)
712
def iter_inventories(self, revision_ids):
714
return self._real_repository.iter_inventories(revision_ids)
717
def get_revision(self, revision_id):
719
return self._real_repository.get_revision(revision_id)
722
def weave_store(self):
724
return self._real_repository.weave_store
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 control_weaves(self):
783
return self._real_repository.control_weaves
786
def get_ancestry(self, revision_id, topo_sorted=True):
788
return self._real_repository.get_ancestry(revision_id, topo_sorted)
791
def get_inventory_weave(self):
793
return self._real_repository.get_inventory_weave()
795
def fileids_altered_by_revision_ids(self, revision_ids):
797
return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
799
def _get_versioned_file_checker(self, revisions, revision_versions_cache):
801
return self._real_repository._get_versioned_file_checker(
802
revisions, revision_versions_cache)
804
def iter_files_bytes(self, desired_files):
805
"""See Repository.iter_file_bytes.
808
return self._real_repository.iter_files_bytes(desired_files)
810
def get_parent_map(self, keys):
811
"""See bzrlib.Graph.get_parent_map()."""
812
# Hack to build up the caching logic.
813
ancestry = self._parents_map
815
# Repository is not locked, so there's no cache.
816
missing_revisions = set(keys)
819
missing_revisions = set(key for key in keys if key not in ancestry)
820
if missing_revisions:
821
parent_map = self._get_parent_map(missing_revisions)
822
if 'hpss' in debug.debug_flags:
823
mutter('retransmitted revisions: %d of %d',
824
len(set(ancestry).intersection(parent_map)),
826
ancestry.update(parent_map)
827
present_keys = [k for k in keys if k in ancestry]
828
if 'hpss' in debug.debug_flags:
829
if self._requested_parents is not None and len(ancestry) != 0:
830
self._requested_parents.update(present_keys)
831
mutter('Current RemoteRepository graph hit rate: %d%%',
832
100.0 * len(self._requested_parents) / len(ancestry))
833
return dict((k, ancestry[k]) for k in present_keys)
835
def _get_parent_map(self, keys):
836
"""Helper for get_parent_map that performs the RPC."""
837
medium = self._client._medium
838
if not medium._remote_is_at_least_1_2:
839
# We already found out that the server can't understand
840
# Repository.get_parent_map requests, so just fetch the whole
842
# XXX: Note that this will issue a deprecation warning. This is ok
843
# :- its because we're working with a deprecated server anyway, and
844
# the user will almost certainly have seen a warning about the
845
# server version already.
846
rg = self.get_revision_graph()
847
# There is an api discrepency between get_parent_map and
848
# get_revision_graph. Specifically, a "key:()" pair in
849
# get_revision_graph just means a node has no parents. For
850
# "get_parent_map" it means the node is a ghost. So fix up the
851
# graph to correct this.
852
# https://bugs.launchpad.net/bzr/+bug/214894
853
# There is one other "bug" which is that ghosts in
854
# get_revision_graph() are not returned at all. But we won't worry
855
# about that for now.
856
for node_id, parent_ids in rg.iteritems():
858
rg[node_id] = (NULL_REVISION,)
859
rg[NULL_REVISION] = ()
863
if NULL_REVISION in keys:
864
keys.discard(NULL_REVISION)
865
found_parents = {NULL_REVISION:()}
870
# TODO(Needs analysis): We could assume that the keys being requested
871
# from get_parent_map are in a breadth first search, so typically they
872
# will all be depth N from some common parent, and we don't have to
873
# have the server iterate from the root parent, but rather from the
874
# keys we're searching; and just tell the server the keyspace we
875
# already have; but this may be more traffic again.
877
# Transform self._parents_map into a search request recipe.
878
# TODO: Manage this incrementally to avoid covering the same path
879
# repeatedly. (The server will have to on each request, but the less
880
# work done the better).
881
parents_map = self._parents_map
882
if parents_map is None:
883
# Repository is not locked, so there's no cache.
885
start_set = set(parents_map)
886
result_parents = set()
887
for parents in parents_map.itervalues():
888
result_parents.update(parents)
889
stop_keys = result_parents.difference(start_set)
890
included_keys = start_set.intersection(result_parents)
891
start_set.difference_update(included_keys)
892
recipe = (start_set, stop_keys, len(parents_map))
893
body = self._serialise_search_recipe(recipe)
894
path = self.bzrdir._path_for_remote_call(self._client)
896
if type(key) is not str:
898
"key %r not a plain string" % (key,))
899
verb = 'Repository.get_parent_map'
900
args = (path,) + tuple(keys)
902
response = self._client.call_with_body_bytes_expecting_body(
903
verb, args, self._serialise_search_recipe(recipe))
904
except errors.UnknownSmartMethod:
905
# Server does not support this method, so get the whole graph.
906
# Worse, we have to force a disconnection, because the server now
907
# doesn't realise it has a body on the wire to consume, so the
908
# only way to recover is to abandon the connection.
910
'Server is too old for fast get_parent_map, reconnecting. '
911
'(Upgrade the server to Bazaar 1.2 to avoid this)')
913
# To avoid having to disconnect repeatedly, we keep track of the
914
# fact the server doesn't understand remote methods added in 1.2.
915
medium._remote_is_at_least_1_2 = False
916
return self.get_revision_graph(None)
917
response_tuple, response_handler = response
918
if response_tuple[0] not in ['ok']:
919
response_handler.cancel_read_body()
920
raise errors.UnexpectedSmartServerResponse(response_tuple)
921
if response_tuple[0] == 'ok':
922
coded = bz2.decompress(response_handler.read_body_bytes())
926
lines = coded.split('\n')
929
d = tuple(line.split())
931
revision_graph[d[0]] = d[1:]
933
# No parents - so give the Graph result (NULL_REVISION,).
934
revision_graph[d[0]] = (NULL_REVISION,)
935
return revision_graph
938
def get_signature_text(self, revision_id):
940
return self._real_repository.get_signature_text(revision_id)
943
@symbol_versioning.deprecated_method(symbol_versioning.one_three)
944
def get_revision_graph_with_ghosts(self, revision_ids=None):
946
return self._real_repository.get_revision_graph_with_ghosts(
947
revision_ids=revision_ids)
950
def get_inventory_xml(self, revision_id):
952
return self._real_repository.get_inventory_xml(revision_id)
954
def deserialise_inventory(self, revision_id, xml):
956
return self._real_repository.deserialise_inventory(revision_id, xml)
958
def reconcile(self, other=None, thorough=False):
960
return self._real_repository.reconcile(other=other, thorough=thorough)
962
def all_revision_ids(self):
964
return self._real_repository.all_revision_ids()
967
def get_deltas_for_revisions(self, revisions):
969
return self._real_repository.get_deltas_for_revisions(revisions)
972
def get_revision_delta(self, revision_id):
974
return self._real_repository.get_revision_delta(revision_id)
977
def revision_trees(self, revision_ids):
979
return self._real_repository.revision_trees(revision_ids)
982
def get_revision_reconcile(self, revision_id):
984
return self._real_repository.get_revision_reconcile(revision_id)
987
def check(self, revision_ids=None):
989
return self._real_repository.check(revision_ids=revision_ids)
991
def copy_content_into(self, destination, revision_id=None):
993
return self._real_repository.copy_content_into(
994
destination, revision_id=revision_id)
996
def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
997
# get a tarball of the remote repository, and copy from that into the
999
from bzrlib import osutils
1002
# TODO: Maybe a progress bar while streaming the tarball?
1003
note("Copying repository content as tarball...")
1004
tar_file = self._get_tarball('bz2')
1005
if tar_file is None:
1007
destination = to_bzrdir.create_repository()
1009
tar = tarfile.open('repository', fileobj=tar_file,
1011
tmpdir = tempfile.mkdtemp()
1013
_extract_tar(tar, tmpdir)
1014
tmp_bzrdir = BzrDir.open(tmpdir)
1015
tmp_repo = tmp_bzrdir.open_repository()
1016
tmp_repo.copy_content_into(destination, revision_id)
1018
osutils.rmtree(tmpdir)
1022
# TODO: Suggestion from john: using external tar is much faster than
1023
# python's tarfile library, but it may not work on windows.
1027
"""Compress the data within the repository.
1029
This is not currently implemented within the smart server.
1032
return self._real_repository.pack()
1034
def set_make_working_trees(self, new_value):
1036
self._real_repository.set_make_working_trees(new_value)
1039
def sign_revision(self, revision_id, gpg_strategy):
1041
return self._real_repository.sign_revision(revision_id, gpg_strategy)
1044
def get_revisions(self, revision_ids):
1046
return self._real_repository.get_revisions(revision_ids)
1048
def supports_rich_root(self):
1050
return self._real_repository.supports_rich_root()
1052
def iter_reverse_revision_history(self, revision_id):
1054
return self._real_repository.iter_reverse_revision_history(revision_id)
1057
def _serializer(self):
1059
return self._real_repository._serializer
1061
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1063
return self._real_repository.store_revision_signature(
1064
gpg_strategy, plaintext, revision_id)
1066
def add_signature_text(self, revision_id, signature):
1068
return self._real_repository.add_signature_text(revision_id, signature)
1070
def has_signature_for_revision_id(self, revision_id):
1072
return self._real_repository.has_signature_for_revision_id(revision_id)
1074
def get_data_stream_for_search(self, search):
1075
medium = self._client._medium
1076
if not medium._remote_is_at_least_1_2:
1078
return self._real_repository.get_data_stream_for_search(search)
1079
REQUEST_NAME = 'Repository.stream_revisions_chunked'
1080
path = self.bzrdir._path_for_remote_call(self._client)
1081
body = self._serialise_search_recipe(search.get_recipe())
1083
result = self._client.call_with_body_bytes_expecting_body(
1084
REQUEST_NAME, (path,), body)
1085
response, protocol = result
1086
except errors.UnknownSmartMethod:
1087
# Server does not support this method, so fall back to VFS.
1088
# Worse, we have to force a disconnection, because the server now
1089
# doesn't realise it has a body on the wire to consume, so the
1090
# only way to recover is to abandon the connection.
1092
'Server is too old for streaming pull, reconnecting. '
1093
'(Upgrade the server to Bazaar 1.2 to avoid this)')
1095
# To avoid having to disconnect repeatedly, we keep track of the
1096
# fact the server doesn't understand this remote method.
1097
medium._remote_is_at_least_1_2 = False
1099
return self._real_repository.get_data_stream_for_search(search)
1101
if response == ('ok',):
1102
return self._deserialise_stream(protocol)
1103
if response == ('NoSuchRevision', ):
1104
# We cannot easily identify the revision that is missing in this
1105
# situation without doing much more network IO. For now, bail.
1106
raise NoSuchRevision(self, "unknown")
1108
raise errors.UnexpectedSmartServerResponse(response)
1110
def _deserialise_stream(self, protocol):
1111
stream = protocol.read_streamed_body()
1112
container_parser = ContainerPushParser()
1113
for bytes in stream:
1114
container_parser.accept_bytes(bytes)
1115
records = container_parser.read_pending_records()
1116
for record_names, record_bytes in records:
1117
if len(record_names) != 1:
1118
# These records should have only one name, and that name
1119
# should be a one-element tuple.
1120
raise errors.SmartProtocolError(
1121
'Repository data stream had invalid record name %r'
1123
name_tuple = record_names[0]
1124
yield name_tuple, record_bytes
1126
def insert_data_stream(self, stream):
1128
self._real_repository.insert_data_stream(stream)
1130
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
1132
return self._real_repository.item_keys_introduced_by(revision_ids,
1133
_files_pb=_files_pb)
1135
def revision_graph_can_have_wrong_parents(self):
1136
# The answer depends on the remote repo format.
1138
return self._real_repository.revision_graph_can_have_wrong_parents()
1140
def _find_inconsistent_revision_parents(self):
1142
return self._real_repository._find_inconsistent_revision_parents()
1144
def _check_for_inconsistent_revision_parents(self):
1146
return self._real_repository._check_for_inconsistent_revision_parents()
1148
def _make_parents_provider(self):
1151
def _serialise_search_recipe(self, recipe):
1152
"""Serialise a graph search recipe.
1154
:param recipe: A search recipe (start, stop, count).
1155
:return: Serialised bytes.
1157
start_keys = ' '.join(recipe[0])
1158
stop_keys = ' '.join(recipe[1])
1159
count = str(recipe[2])
1160
return '\n'.join((start_keys, stop_keys, count))
1163
class RemoteBranchLockableFiles(LockableFiles):
1164
"""A 'LockableFiles' implementation that talks to a smart server.
1166
This is not a public interface class.
1169
def __init__(self, bzrdir, _client):
1170
self.bzrdir = bzrdir
1171
self._client = _client
1172
self._need_find_modes = True
1173
LockableFiles.__init__(
1174
self, bzrdir.get_branch_transport(None),
1175
'lock', lockdir.LockDir)
1177
def _find_modes(self):
1178
# RemoteBranches don't let the client set the mode of control files.
1179
self._dir_mode = None
1180
self._file_mode = None
1183
class RemoteBranchFormat(branch.BranchFormat):
1185
def __eq__(self, other):
1186
return (isinstance(other, RemoteBranchFormat) and
1187
self.__dict__ == other.__dict__)
1189
def get_format_description(self):
1190
return 'Remote BZR Branch'
1192
def get_format_string(self):
1193
return 'Remote BZR Branch'
1195
def open(self, a_bzrdir):
1196
return a_bzrdir.open_branch()
1198
def initialize(self, a_bzrdir):
1199
return a_bzrdir.create_branch()
1201
def supports_tags(self):
1202
# Remote branches might support tags, but we won't know until we
1203
# access the real remote branch.
1207
class RemoteBranch(branch.Branch):
1208
"""Branch stored on a server accessed by HPSS RPC.
1210
At the moment most operations are mapped down to simple file operations.
1213
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
1215
"""Create a RemoteBranch instance.
1217
:param real_branch: An optional local implementation of the branch
1218
format, usually accessing the data via the VFS.
1219
:param _client: Private parameter for testing.
1221
# We intentionally don't call the parent class's __init__, because it
1222
# will try to assign to self.tags, which is a property in this subclass.
1223
# And the parent's __init__ doesn't do much anyway.
1224
self._revision_id_to_revno_cache = None
1225
self._revision_history_cache = None
1226
self.bzrdir = remote_bzrdir
1227
if _client is not None:
1228
self._client = _client
1230
self._client = remote_bzrdir._client
1231
self.repository = remote_repository
1232
if real_branch is not None:
1233
self._real_branch = real_branch
1234
# Give the remote repository the matching real repo.
1235
real_repo = self._real_branch.repository
1236
if isinstance(real_repo, RemoteRepository):
1237
real_repo._ensure_real()
1238
real_repo = real_repo._real_repository
1239
self.repository._set_real_repository(real_repo)
1240
# Give the branch the remote repository to let fast-pathing happen.
1241
self._real_branch.repository = self.repository
1243
self._real_branch = None
1244
# Fill out expected attributes of branch for bzrlib api users.
1245
self._format = RemoteBranchFormat()
1246
self.base = self.bzrdir.root_transport.base
1247
self._control_files = None
1248
self._lock_mode = None
1249
self._lock_token = None
1250
self._repo_lock_token = None
1251
self._lock_count = 0
1252
self._leave_lock = False
1255
return "%s(%s)" % (self.__class__.__name__, self.base)
1259
def _ensure_real(self):
1260
"""Ensure that there is a _real_branch set.
1262
Used before calls to self._real_branch.
1264
if not self._real_branch:
1265
if not vfs.vfs_enabled():
1266
raise AssertionError('smart server vfs must be enabled '
1267
'to use vfs implementation')
1268
self.bzrdir._ensure_real()
1269
self._real_branch = self.bzrdir._real_bzrdir.open_branch()
1270
# Give the remote repository the matching real repo.
1271
real_repo = self._real_branch.repository
1272
if isinstance(real_repo, RemoteRepository):
1273
real_repo._ensure_real()
1274
real_repo = real_repo._real_repository
1275
self.repository._set_real_repository(real_repo)
1276
# Give the branch the remote repository to let fast-pathing happen.
1277
self._real_branch.repository = self.repository
1278
# XXX: deal with _lock_mode == 'w'
1279
if self._lock_mode == 'r':
1280
self._real_branch.lock_read()
1283
def control_files(self):
1284
# Defer actually creating RemoteBranchLockableFiles until its needed,
1285
# because it triggers an _ensure_real that we otherwise might not need.
1286
if self._control_files is None:
1287
self._control_files = RemoteBranchLockableFiles(
1288
self.bzrdir, self._client)
1289
return self._control_files
1291
def _get_checkout_format(self):
1293
return self._real_branch._get_checkout_format()
1295
def get_physical_lock_status(self):
1296
"""See Branch.get_physical_lock_status()."""
1297
# should be an API call to the server, as branches must be lockable.
1299
return self._real_branch.get_physical_lock_status()
1301
def lock_read(self):
1302
if not self._lock_mode:
1303
self._lock_mode = 'r'
1304
self._lock_count = 1
1305
if self._real_branch is not None:
1306
self._real_branch.lock_read()
1308
self._lock_count += 1
1310
def _remote_lock_write(self, token):
1312
branch_token = repo_token = ''
1314
branch_token = token
1315
repo_token = self.repository.lock_write()
1316
self.repository.unlock()
1317
path = self.bzrdir._path_for_remote_call(self._client)
1319
response = self._client.call(
1320
'Branch.lock_write', path, branch_token, repo_token or '')
1321
except errors.ErrorFromSmartServer, err:
1322
if err.error_verb == 'LockContention':
1323
raise errors.LockContention('(remote lock)')
1324
elif err.error_verb == 'TokenMismatch':
1325
raise errors.TokenMismatch(token, '(remote token)')
1326
elif err.error_verb == 'UnlockableTransport':
1327
raise errors.UnlockableTransport(self.bzrdir.root_transport)
1328
elif err.error_verb == 'ReadOnlyError':
1329
raise errors.ReadOnlyError(self)
1330
elif err.error_verb == 'LockFailed':
1331
raise errors.LockFailed(err.error_args[0], err.error_args[1])
1333
if response[0] != 'ok':
1334
raise errors.UnexpectedSmartServerResponse(response)
1335
ok, branch_token, repo_token = response
1336
return branch_token, repo_token
1338
def lock_write(self, token=None):
1339
if not self._lock_mode:
1340
remote_tokens = self._remote_lock_write(token)
1341
self._lock_token, self._repo_lock_token = remote_tokens
1342
if not self._lock_token:
1343
raise SmartProtocolError('Remote server did not return a token!')
1344
# TODO: We really, really, really don't want to call _ensure_real
1345
# here, but it's the easiest way to ensure coherency between the
1346
# state of the RemoteBranch and RemoteRepository objects and the
1347
# physical locks. If we don't materialise the real objects here,
1348
# then getting everything in the right state later is complex, so
1349
# for now we just do it the lazy way.
1350
# -- Andrew Bennetts, 2007-02-22.
1352
if self._real_branch is not None:
1353
self._real_branch.repository.lock_write(
1354
token=self._repo_lock_token)
1356
self._real_branch.lock_write(token=self._lock_token)
1358
self._real_branch.repository.unlock()
1359
if token is not None:
1360
self._leave_lock = True
1362
# XXX: this case seems to be unreachable; token cannot be None.
1363
self._leave_lock = False
1364
self._lock_mode = 'w'
1365
self._lock_count = 1
1366
elif self._lock_mode == 'r':
1367
raise errors.ReadOnlyTransaction
1369
if token is not None:
1370
# A token was given to lock_write, and we're relocking, so check
1371
# that the given token actually matches the one we already have.
1372
if token != self._lock_token:
1373
raise errors.TokenMismatch(token, self._lock_token)
1374
self._lock_count += 1
1375
return self._lock_token or None
1377
def _unlock(self, branch_token, repo_token):
1378
path = self.bzrdir._path_for_remote_call(self._client)
1380
response = self._client.call('Branch.unlock', path, branch_token,
1382
except errors.ErrorFromSmartServer, err:
1383
if err.error_verb == 'TokenMismatch':
1384
raise errors.TokenMismatch(
1385
str((branch_token, repo_token)), '(remote tokens)')
1387
if response == ('ok',):
1389
raise errors.UnexpectedSmartServerResponse(response)
1392
self._lock_count -= 1
1393
if not self._lock_count:
1394
self._clear_cached_state()
1395
mode = self._lock_mode
1396
self._lock_mode = None
1397
if self._real_branch is not None:
1398
if (not self._leave_lock and mode == 'w' and
1399
self._repo_lock_token):
1400
# If this RemoteBranch will remove the physical lock for the
1401
# repository, make sure the _real_branch doesn't do it
1402
# first. (Because the _real_branch's repository is set to
1403
# be the RemoteRepository.)
1404
self._real_branch.repository.leave_lock_in_place()
1405
self._real_branch.unlock()
1407
# Only write-locked branched need to make a remote method call
1408
# to perfom the unlock.
1410
if not self._lock_token:
1411
raise AssertionError('Locked, but no token!')
1412
branch_token = self._lock_token
1413
repo_token = self._repo_lock_token
1414
self._lock_token = None
1415
self._repo_lock_token = None
1416
if not self._leave_lock:
1417
self._unlock(branch_token, repo_token)
1419
def break_lock(self):
1421
return self._real_branch.break_lock()
1423
def leave_lock_in_place(self):
1424
if not self._lock_token:
1425
raise NotImplementedError(self.leave_lock_in_place)
1426
self._leave_lock = True
1428
def dont_leave_lock_in_place(self):
1429
if not self._lock_token:
1430
raise NotImplementedError(self.dont_leave_lock_in_place)
1431
self._leave_lock = False
1433
def last_revision_info(self):
1434
"""See Branch.last_revision_info()."""
1435
path = self.bzrdir._path_for_remote_call(self._client)
1436
response = self._client.call('Branch.last_revision_info', path)
1437
if response[0] != 'ok':
1438
raise SmartProtocolError('unexpected response code %s' % (response,))
1439
revno = int(response[1])
1440
last_revision = response[2]
1441
return (revno, last_revision)
1443
def _gen_revision_history(self):
1444
"""See Branch._gen_revision_history()."""
1445
path = self.bzrdir._path_for_remote_call(self._client)
1446
response_tuple, response_handler = self._client.call_expecting_body(
1447
'Branch.revision_history', path)
1448
if response_tuple[0] != 'ok':
1449
raise UnexpectedSmartServerResponse(response_tuple)
1450
result = response_handler.read_body_bytes().split('\x00')
1456
def set_revision_history(self, rev_history):
1457
# Send just the tip revision of the history; the server will generate
1458
# the full history from that. If the revision doesn't exist in this
1459
# branch, NoSuchRevision will be raised.
1460
path = self.bzrdir._path_for_remote_call(self._client)
1461
if rev_history == []:
1464
rev_id = rev_history[-1]
1465
self._clear_cached_state()
1467
response = self._client.call('Branch.set_last_revision',
1468
path, self._lock_token, self._repo_lock_token, rev_id)
1469
except errors.ErrorFromSmartServer, err:
1470
if err.error_verb == 'NoSuchRevision':
1471
raise NoSuchRevision(self, rev_id)
1473
if response != ('ok',):
1474
raise errors.UnexpectedSmartServerResponse(response)
1475
self._cache_revision_history(rev_history)
1477
def get_parent(self):
1479
return self._real_branch.get_parent()
1481
def set_parent(self, url):
1483
return self._real_branch.set_parent(url)
1485
def sprout(self, to_bzrdir, revision_id=None):
1486
# Like Branch.sprout, except that it sprouts a branch in the default
1487
# format, because RemoteBranches can't be created at arbitrary URLs.
1488
# XXX: if to_bzrdir is a RemoteBranch, this should perhaps do
1489
# to_bzrdir.create_branch...
1491
result = self._real_branch._format.initialize(to_bzrdir)
1492
self.copy_content_into(result, revision_id=revision_id)
1493
result.set_parent(self.bzrdir.root_transport.base)
1497
def pull(self, source, overwrite=False, stop_revision=None,
1499
# FIXME: This asks the real branch to run the hooks, which means
1500
# they're called with the wrong target branch parameter.
1501
# The test suite specifically allows this at present but it should be
1502
# fixed. It should get a _override_hook_target branch,
1503
# as push does. -- mbp 20070405
1505
self._real_branch.pull(
1506
source, overwrite=overwrite, stop_revision=stop_revision,
1510
def push(self, target, overwrite=False, stop_revision=None):
1512
return self._real_branch.push(
1513
target, overwrite=overwrite, stop_revision=stop_revision,
1514
_override_hook_source_branch=self)
1516
def is_locked(self):
1517
return self._lock_count >= 1
1520
def set_last_revision_info(self, revno, revision_id):
1521
revision_id = ensure_null(revision_id)
1522
path = self.bzrdir._path_for_remote_call(self._client)
1524
response = self._client.call('Branch.set_last_revision_info',
1525
path, self._lock_token, self._repo_lock_token, str(revno), revision_id)
1526
except errors.UnknownSmartMethod:
1528
self._clear_cached_state()
1529
return self._real_branch.set_last_revision_info(revno, revision_id)
1530
except errors.ErrorFromSmartServer, err:
1531
if err.error_verb == 'NoSuchRevision':
1532
raise NoSuchRevision(self, err.error_args[0])
1534
if response == ('ok',):
1535
self._clear_cached_state()
1537
raise errors.UnexpectedSmartServerResponse(response)
1539
def generate_revision_history(self, revision_id, last_rev=None,
1542
return self._real_branch.generate_revision_history(
1543
revision_id, last_rev=last_rev, other_branch=other_branch)
1548
return self._real_branch.tags
1550
def set_push_location(self, location):
1552
return self._real_branch.set_push_location(location)
1554
def update_revisions(self, other, stop_revision=None, overwrite=False):
1556
return self._real_branch.update_revisions(
1557
other, stop_revision=stop_revision, overwrite=overwrite)
1560
def _extract_tar(tar, to_dir):
1561
"""Extract all the contents of a tarfile object.
1563
A replacement for extractall, which is not present in python2.4
1566
tar.extract(tarinfo, to_dir)