21
21
that has merged into it. As the first step of a merge, pull, or
22
22
branch operation we copy history from the source into the destination
25
The copying is done in a slightly complicated order. We don't want to
26
add a revision to the store until everything it refers to is also
27
stored, so that if a revision is present we can totally recreate it.
28
However, we can't know what files are included in a revision until we
29
read its inventory. So we query the inventory store of the source for
30
the ids we need, and then pull those ids and then return to the inventories.
28
from bzrlib.lazy_import import lazy_import
29
lazy_import(globals(), """
40
from bzrlib.i18n import gettext
41
from bzrlib.revision import NULL_REVISION
36
import bzrlib.errors as errors
37
from bzrlib.errors import InstallFailed
38
from bzrlib.progress import ProgressPhase
39
from bzrlib.revision import is_null, NULL_REVISION
40
from bzrlib.symbol_versioning import (deprecated_function,
43
from bzrlib.tsort import topo_sort
42
44
from bzrlib.trace import mutter
46
from bzrlib.versionedfile import filter_absent, FulltextContentFactory
48
# TODO: Avoid repeatedly opening weaves so many times.
50
# XXX: This doesn't handle ghost (not present in branch) revisions at
51
# all yet. I'm not sure they really should be supported.
53
# NOTE: This doesn't copy revisions which may be present but not
54
# merged into the last revision. I'm not sure we want to do that.
56
# - get a list of revisions that need to be pulled in
57
# - for each one, pull in that revision file
58
# and get the inventory, and store the inventory with right
60
# - and get the ancestry, and store that with right parents too
61
# - and keep a note of all file ids and version seen
62
# - then go through all files; for each one get the weave,
63
# and add in all file versions
45
66
class RepoFetcher(object):
46
67
"""Pull revisions and texts from one repository to another.
70
if set, try to limit to the data this revision references.
73
count_copied -- number of revisions copied
48
75
This should not be used directly, it's essential a object to encapsulate
49
76
the logic in InterRepository.fetch().
52
def __init__(self, to_repository, from_repository, last_revision=None,
53
find_ghosts=True, fetch_spec=None):
79
def __init__(self, to_repository, from_repository, last_revision=None, pb=None,
54
81
"""Create a repo fetcher.
56
:param last_revision: If set, try to limit to the data this revision
58
:param fetch_spec: A SearchResult specifying which revisions to fetch.
59
If set, this overrides last_revision.
60
83
:param find_ghosts: If True search the entire history for ghosts.
84
:param _write_group_acquired_callable: Don't use; this parameter only
85
exists to facilitate a hack done in InterPackRepo.fetch. We would
86
like to remove this parameter.
62
# repository.fetch has the responsibility for short-circuiting
63
# attempts to copy between a repository and itself.
89
self.failed_revisions = []
91
if to_repository.has_same_location(from_repository):
92
# repository.fetch should be taking care of this case.
93
raise errors.BzrError('RepoFetcher run '
94
'between two objects at the same location: '
95
'%r and %r' % (to_repository, from_repository))
64
96
self.to_repository = to_repository
65
97
self.from_repository = from_repository
66
self.sink = to_repository._get_sink()
67
98
# must not mutate self._last_revision as its potentially a shared instance
68
99
self._last_revision = last_revision
69
self._fetch_spec = fetch_spec
70
100
self.find_ghosts = find_ghosts
102
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
103
self.nested_pb = self.pb
106
self.nested_pb = None
71
107
self.from_repository.lock_read()
72
mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
73
self.from_repository, self.from_repository._format,
74
self.to_repository, self.to_repository._format)
109
self.to_repository.lock_write()
111
self.to_repository.start_write_group()
115
self.to_repository.abort_write_group(suppress_errors=True)
118
self.to_repository.commit_write_group()
121
if self.nested_pb is not None:
122
self.nested_pb.finished()
124
self.to_repository.unlock()
78
126
self.from_repository.unlock()
80
128
def __fetch(self):
81
129
"""Primary worker function.
83
This initialises all the needed variables, and then fetches the
131
This initialises all the needed variables, and then fetches the
84
132
requested revisions, finally clearing the progress bar.
86
# Roughly this is what we're aiming for fetch to become:
88
# missing = self.sink.insert_stream(self.source.get_stream(search))
90
# missing = self.sink.insert_stream(self.source.get_items(missing))
92
134
self.count_total = 0
93
135
self.file_ids_names = {}
94
pb = ui.ui_factory.nested_progress_bar()
95
pb.show_pct = pb.show_count = False
136
pp = ProgressPhase('Transferring', 4, self.pb)
97
pb.update(gettext("Finding revisions"), 0, 2)
98
search_result = self._revids_to_fetch()
99
mutter('fetching: %s', search_result)
100
if search_result.is_empty():
139
search = self._revids_to_fetch()
102
pb.update(gettext("Fetching revisions"), 1, 2)
103
self._fetch_everything_for_search(search_result)
142
if getattr(self, '_fetch_everything_for_search', None) is not None:
143
self._fetch_everything_for_search(search, pp)
145
# backward compatibility
146
self._fetch_everything_for_revisions(search.get_keys, pp)
107
def _fetch_everything_for_search(self, search):
150
def _fetch_everything_for_search(self, search, pp):
108
151
"""Fetch all data for the given set of revisions."""
109
152
# The first phase is "file". We pass the progress bar for it directly
110
153
# into item_keys_introduced_by, which has more information about how
114
157
# item_keys_introduced_by should have a richer API than it does at the
115
158
# moment, so that it can feed the progress information back to this
117
if (self.from_repository._format.rich_root_data and
118
not self.to_repository._format.rich_root_data):
119
raise errors.IncompatibleRepositories(
120
self.from_repository, self.to_repository,
121
"different rich-root support")
122
pb = ui.ui_factory.nested_progress_bar()
161
pb = bzrlib.ui.ui_factory.nested_progress_bar()
124
pb.update("Get stream source")
125
source = self.from_repository._get_source(
126
self.to_repository._format)
127
stream = source.get_stream(search)
128
from_format = self.from_repository._format
129
pb.update("Inserting stream")
130
resume_tokens, missing_keys = self.sink.insert_stream(
131
stream, from_format, [])
133
pb.update("Missing keys")
134
stream = source.get_stream_for_missing_keys(missing_keys)
135
pb.update("Inserting missing keys")
136
resume_tokens, missing_keys = self.sink.insert_stream(
137
stream, from_format, resume_tokens)
139
raise AssertionError(
140
"second push failed to complete a fetch %r." % (
143
raise AssertionError(
144
"second push failed to commit the fetch %r." % (
146
pb.update("Finishing stream")
163
revs = search.get_keys()
164
graph = self.from_repository.get_graph()
165
revs = list(graph.iter_topo_order(revs))
166
data_to_fetch = self.from_repository.item_keys_introduced_by(revs,
169
for knit_kind, file_id, revisions in data_to_fetch:
170
if knit_kind != phase:
172
# Make a new progress bar for this phase
175
pb = bzrlib.ui.ui_factory.nested_progress_bar()
176
if knit_kind == "file":
177
# Accumulate file texts
178
text_keys.extend([(file_id, revision) for revision in
180
elif knit_kind == "inventory":
181
# Now copy the file texts.
182
to_texts = self.to_repository.texts
183
from_texts = self.from_repository.texts
184
to_texts.insert_record_stream(from_texts.get_record_stream(
185
text_keys, self.to_repository._fetch_order,
186
not self.to_repository._fetch_uses_deltas))
187
# Cause an error if a text occurs after we have done the
190
# Before we process the inventory we generate the root
191
# texts (if necessary) so that the inventories references
193
self._generate_root_texts(revs)
194
# NB: This currently reopens the inventory weave in source;
195
# using a single stream interface instead would avoid this.
196
self._fetch_inventory_weave(revs, pb)
197
elif knit_kind == "signatures":
198
# Nothing to do here; this will be taken care of when
199
# _fetch_revision_texts happens.
201
elif knit_kind == "revisions":
202
self._fetch_revision_texts(revs, pb)
204
raise AssertionError("Unknown knit kind %r" % knit_kind)
205
if self.to_repository._fetch_reconcile:
206
self.to_repository.reconcile()
210
self.count_copied += len(revs)
151
212
def _revids_to_fetch(self):
152
213
"""Determines the exact revisions needed from self.from_repository to
153
214
install self._last_revision in self.to_repository.
155
:returns: A SearchResult of some sort. (Possibly a
156
PendingAncestryResult, EmptySearchResult, etc.)
216
If no revisions need to be fetched, then this just returns None.
158
if self._fetch_spec is not None:
159
# The fetch spec is already a concrete search result.
160
return self._fetch_spec
161
elif self._last_revision == NULL_REVISION:
162
# fetch_spec is None + last_revision is null => empty fetch.
218
mutter('fetch up to rev {%s}', self._last_revision)
219
if self._last_revision is NULL_REVISION:
163
220
# explicit limit of no revisions needed
164
return _mod_graph.EmptySearchResult()
165
elif self._last_revision is not None:
166
return _mod_graph.NotInOtherForRevs(self.to_repository,
167
self.from_repository, [self._last_revision],
168
find_ghosts=self.find_ghosts).execute()
169
else: # self._last_revision is None:
170
return _mod_graph.EverythingNotInOther(self.to_repository,
171
self.from_repository,
172
find_ghosts=self.find_ghosts).execute()
222
if (self._last_revision is not None and
223
self.to_repository.has_revision(self._last_revision)):
226
return self.to_repository.search_missing_revision_ids(
227
self.from_repository, self._last_revision,
228
find_ghosts=self.find_ghosts)
229
except errors.NoSuchRevision, e:
230
raise InstallFailed([self._last_revision])
232
def _fetch_inventory_weave(self, revs, pb):
233
pb.update("fetch inventory", 0, 2)
234
to_weave = self.to_repository.inventories
235
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
237
# just merge, this is optimisable and its means we don't
238
# copy unreferenced data such as not-needed inventories.
239
pb.update("fetch inventory", 1, 3)
240
from_weave = self.from_repository.inventories
241
pb.update("fetch inventory", 2, 3)
242
# we fetch only the referenced inventories because we do not
243
# know for unselected inventories whether all their required
244
# texts are present in the other repository - it could be
246
to_weave.insert_record_stream(from_weave.get_record_stream(
247
[(rev_id,) for rev_id in revs],
248
self.to_repository._fetch_order,
249
not self.to_repository._fetch_uses_deltas))
253
def _fetch_revision_texts(self, revs, pb):
254
# fetch signatures first and then the revision texts
255
# may need to be a InterRevisionStore call here.
256
to_sf = self.to_repository.signatures
257
from_sf = self.from_repository.signatures
258
# A missing signature is just skipped.
259
to_sf.insert_record_stream(filter_absent(from_sf.get_record_stream(
260
[(rev_id,) for rev_id in revs],
261
self.to_repository._fetch_order,
262
not self.to_repository._fetch_uses_deltas)))
263
self._fetch_just_revision_texts(revs)
265
def _fetch_just_revision_texts(self, version_ids):
266
to_rf = self.to_repository.revisions
267
from_rf = self.from_repository.revisions
268
# If a revision has a delta, this is actually expanded inside the
269
# insert_record_stream code now, which is an alternate fix for
271
to_rf.insert_record_stream(from_rf.get_record_stream(
272
[(rev_id,) for rev_id in version_ids],
273
self.to_repository._fetch_order,
274
not self.to_repository._fetch_uses_deltas))
276
def _generate_root_texts(self, revs):
277
"""This will be called by __fetch between fetching weave texts and
278
fetching the inventory weave.
280
Subclasses should override this if they need to generate root texts
281
after fetching weave texts.
175
286
class Inter1and2Helper(object):
176
287
"""Helper for operations that convert data from model 1 and 2
178
289
This is for use by fetchers and converters.
181
# This is a class variable so that the test suite can override it.
182
known_graph_threshold = 100
184
def __init__(self, source):
292
def __init__(self, source, target):
187
295
:param source: The repository data comes from
296
:param target: The repository data goes to
189
298
self.source = source
191
301
def iter_rev_trees(self, revs):
192
302
"""Iterate through RevisionTrees efficiently.
242
356
# yet, and are unlikely to in non-rich-root environments anyway.
243
357
root_id_order.sort(key=operator.itemgetter(0))
244
358
# Create a record stream containing the roots to create.
245
if len(revs) > self.known_graph_threshold:
246
graph = self.source.get_known_graph_ancestry(revs)
247
new_roots_stream = _new_root_data_stream(
248
root_id_order, rev_id_to_root_id, parent_map, self.source, graph)
249
return [('texts', new_roots_stream)]
252
def _new_root_data_stream(
253
root_keys_to_create, rev_id_to_root_id_map, parent_map, repo, graph=None):
254
"""Generate a texts substream of synthesised root entries.
256
Used in fetches that do rich-root upgrades.
258
:param root_keys_to_create: iterable of (root_id, rev_id) pairs describing
259
the root entries to create.
260
:param rev_id_to_root_id_map: dict of known rev_id -> root_id mappings for
261
calculating the parents. If a parent rev_id is not found here then it
262
will be recalculated.
263
:param parent_map: a parent map for all the revisions in
265
:param graph: a graph to use instead of repo.get_graph().
267
for root_key in root_keys_to_create:
268
root_id, rev_id = root_key
269
parent_keys = _parent_keys_for_root_version(
270
root_id, rev_id, rev_id_to_root_id_map, parent_map, repo, graph)
271
yield versionedfile.FulltextContentFactory(
272
root_key, parent_keys, None, '')
275
def _parent_keys_for_root_version(
276
root_id, rev_id, rev_id_to_root_id_map, parent_map, repo, graph=None):
277
"""Get the parent keys for a given root id.
279
A helper function for _new_root_data_stream.
281
# Include direct parents of the revision, but only if they used the same
282
# root_id and are heads.
283
rev_parents = parent_map[rev_id]
285
for parent_id in rev_parents:
286
if parent_id == NULL_REVISION:
288
if parent_id not in rev_id_to_root_id_map:
289
# We probably didn't read this revision, go spend the extra effort
292
tree = repo.revision_tree(parent_id)
293
except errors.NoSuchRevision:
294
# Ghost, fill out rev_id_to_root_id in case we encounter this
296
# But set parent_root_id to None since we don't really know
297
parent_root_id = None
299
parent_root_id = tree.get_root_id()
300
rev_id_to_root_id_map[parent_id] = None
302
# rev_id_to_root_id_map[parent_id] = parent_root_id
303
# memory consumption maybe?
305
parent_root_id = rev_id_to_root_id_map[parent_id]
306
if root_id == parent_root_id:
307
# With stacking we _might_ want to refer to a non-local revision,
308
# but this code path only applies when we have the full content
309
# available, so ghosts really are ghosts, not just the edge of
311
parent_ids.append(parent_id)
313
# root_id may be in the parent anyway.
315
tree = repo.revision_tree(parent_id)
316
except errors.NoSuchRevision:
317
# ghost, can't refer to it.
360
for key in root_id_order:
361
root_id, rev_id = key
362
rev_parents = parent_map[rev_id]
363
# We drop revision parents with different file-ids, because
364
# that represents a rename of the root to a different location
365
# - its not actually a parent for us. (We could look for that
366
# file id in the revision tree at considerably more expense,
367
# but for now this is sufficient (and reconcile will catch and
368
# correct this anyway).
369
# When a parent revision is a ghost, we guess that its root id
370
# was unchanged (rather than trimming it from the parent list).
371
parent_keys = tuple((root_id, parent) for parent in rev_parents
372
if parent != NULL_REVISION and
373
rev_id_to_root_id.get(parent, root_id) == root_id)
374
yield FulltextContentFactory(key, parent_keys, None, '')
375
to_texts.insert_record_stream(yield_roots())
377
def regenerate_inventory(self, revs):
378
"""Generate a new inventory versionedfile in target, convertin data.
380
The inventory is retrieved from the source, (deserializing it), and
381
stored in the target (reserializing it in a different format).
382
:param revs: The revisions to include
384
for tree in self.iter_rev_trees(revs):
385
parents = tree.get_parent_ids()
386
self.target.add_inventory(tree.get_revision_id(), tree.inventory,
389
def fetch_revisions(self, revision_ids):
390
# TODO: should this batch them up rather than requesting 10,000
392
for revision in self.source.get_revisions(revision_ids):
393
self.target.add_revision(revision.revision_id, revision)
396
class Model1toKnit2Fetcher(RepoFetcher):
397
"""Fetch from a Model1 repository into a Knit2 repository
399
def __init__(self, to_repository, from_repository, last_revision=None,
400
pb=None, find_ghosts=True):
401
self.helper = Inter1and2Helper(from_repository, to_repository)
402
RepoFetcher.__init__(self, to_repository, from_repository,
403
last_revision, pb, find_ghosts)
405
def _generate_root_texts(self, revs):
406
self.helper.generate_root_texts(revs)
408
def _fetch_inventory_weave(self, revs, pb):
409
self.helper.regenerate_inventory(revs)
411
def _fetch_revision_texts(self, revs, pb):
412
"""Fetch revision object texts"""
416
pb.update('copying revisions', count, total)
418
sig_text = self.from_repository.get_signature_text(rev)
419
self.to_repository.add_signature_text(rev, sig_text)
420
except errors.NoSuchRevision:
321
parent_ids.append(tree.get_file_revision(root_id))
322
except errors.NoSuchId:
325
# Drop non-head parents
327
graph = repo.get_graph()
328
heads = graph.heads(parent_ids)
330
for parent_id in parent_ids:
331
if parent_id in heads and parent_id not in selected_ids:
332
selected_ids.append(parent_id)
333
parent_keys = [(root_id, parent_id) for parent_id in selected_ids]
337
class TargetRepoKinds(object):
338
"""An enum-like set of constants.
340
They are the possible values of FetchSpecFactory.target_repo_kinds.
343
PREEXISTING = 'preexisting'
348
class FetchSpecFactory(object):
349
"""A helper for building the best fetch spec for a sprout call.
351
Factors that go into determining the sort of fetch to perform:
352
* did the caller specify any revision IDs?
353
* did the caller specify a source branch (need to fetch its
354
heads_to_fetch(), usually the tip + tags)
355
* is there an existing target repo (don't need to refetch revs it
357
* target is stacked? (similar to pre-existing target repo: even if
358
the target itself is new don't want to refetch existing revs)
360
:ivar source_branch: the source branch if one specified, else None.
361
:ivar source_branch_stop_revision_id: fetch up to this revision of
362
source_branch, rather than its tip.
363
:ivar source_repo: the source repository if one found, else None.
364
:ivar target_repo: the target repository acquired by sprout.
365
:ivar target_repo_kind: one of the TargetRepoKinds constants.
369
self._explicit_rev_ids = set()
370
self.source_branch = None
371
self.source_branch_stop_revision_id = None
372
self.source_repo = None
373
self.target_repo = None
374
self.target_repo_kind = None
377
def add_revision_ids(self, revision_ids):
378
"""Add revision_ids to the set of revision_ids to be fetched."""
379
self._explicit_rev_ids.update(revision_ids)
381
def make_fetch_spec(self):
382
"""Build a SearchResult or PendingAncestryResult or etc."""
383
if self.target_repo_kind is None or self.source_repo is None:
384
raise AssertionError(
385
'Incomplete FetchSpecFactory: %r' % (self.__dict__,))
386
if len(self._explicit_rev_ids) == 0 and self.source_branch is None:
387
if self.limit is not None:
388
raise NotImplementedError(
389
"limit is only supported with a source branch set")
390
# Caller hasn't specified any revisions or source branch
391
if self.target_repo_kind == TargetRepoKinds.EMPTY:
392
return _mod_graph.EverythingResult(self.source_repo)
394
# We want everything not already in the target (or target's
396
return _mod_graph.EverythingNotInOther(
397
self.target_repo, self.source_repo).execute()
398
heads_to_fetch = set(self._explicit_rev_ids)
399
if self.source_branch is not None:
400
must_fetch, if_present_fetch = self.source_branch.heads_to_fetch()
401
if self.source_branch_stop_revision_id is not None:
402
# Replace the tip rev from must_fetch with the stop revision
403
# XXX: this might be wrong if the tip rev is also in the
404
# must_fetch set for other reasons (e.g. it's the tip of
405
# multiple loom threads?), but then it's pretty unclear what it
406
# should mean to specify a stop_revision in that case anyway.
407
must_fetch.discard(self.source_branch.last_revision())
408
must_fetch.add(self.source_branch_stop_revision_id)
409
heads_to_fetch.update(must_fetch)
411
if_present_fetch = set()
412
if self.target_repo_kind == TargetRepoKinds.EMPTY:
413
# PendingAncestryResult does not raise errors if a requested head
414
# is absent. Ideally it would support the
415
# required_ids/if_present_ids distinction, but in practice
416
# heads_to_fetch will almost certainly be present so this doesn't
418
all_heads = heads_to_fetch.union(if_present_fetch)
419
ret = _mod_graph.PendingAncestryResult(all_heads, self.source_repo)
420
if self.limit is not None:
421
graph = self.source_repo.get_graph()
422
topo_order = list(graph.iter_topo_order(ret.get_keys()))
423
result_set = topo_order[:self.limit]
424
ret = self.source_repo.revision_ids_to_search_result(result_set)
427
return _mod_graph.NotInOtherForRevs(self.target_repo, self.source_repo,
428
required_ids=heads_to_fetch, if_present_ids=if_present_fetch,
429
limit=self.limit).execute()
423
self._copy_revision(rev)
426
def _copy_revision(self, rev):
427
self.helper.fetch_revisions([rev])
430
class Knit1to2Fetcher(RepoFetcher):
431
"""Fetch from a Knit1 repository into a Knit2 repository"""
433
def __init__(self, to_repository, from_repository, last_revision=None,
434
pb=None, find_ghosts=True):
435
self.helper = Inter1and2Helper(from_repository, to_repository)
436
RepoFetcher.__init__(self, to_repository, from_repository,
437
last_revision, pb, find_ghosts)
439
def _generate_root_texts(self, revs):
440
self.helper.generate_root_texts(revs)
442
def _fetch_inventory_weave(self, revs, pb):
443
self.helper.regenerate_inventory(revs)
445
def _fetch_just_revision_texts(self, version_ids):
446
self.helper.fetch_revisions(version_ids)
added
removed
bzrlib/fetch.py
