20
21
that has merged into it. As the first step of a merge, pull, or
21
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 finally actually join
25
from __future__ import absolute_import
35
import bzrlib.errors as errors
36
from bzrlib.errors import InstallFailed
37
from bzrlib.progress import ProgressPhase
38
from bzrlib.revision import is_null, NULL_REVISION
39
from bzrlib.symbol_versioning import (deprecated_function,
42
from bzrlib.trace import mutter
29
45
from bzrlib.lazy_import import lazy_import
30
lazy_import(globals(), """
41
from bzrlib.i18n import gettext
42
from bzrlib.revision import NULL_REVISION
43
from bzrlib.trace import mutter
47
# TODO: Avoid repeatedly opening weaves so many times.
49
# XXX: This doesn't handle ghost (not present in branch) revisions at
50
# all yet. I'm not sure they really should be supported.
52
# NOTE: This doesn't copy revisions which may be present but not
53
# merged into the last revision. I'm not sure we want to do that.
55
# - get a list of revisions that need to be pulled in
56
# - for each one, pull in that revision file
57
# and get the inventory, and store the inventory with right
59
# - and get the ancestry, and store that with right parents too
60
# - and keep a note of all file ids and version seen
61
# - then go through all files; for each one get the weave,
62
# and add in all file versions
46
65
class RepoFetcher(object):
47
66
"""Pull revisions and texts from one repository to another.
69
if set, try to limit to the data this revision references.
72
count_copied -- number of revisions copied
49
74
This should not be used directly, it's essential a object to encapsulate
50
75
the logic in InterRepository.fetch().
53
def __init__(self, to_repository, from_repository, last_revision=None,
54
find_ghosts=True, fetch_spec=None):
78
def __init__(self, to_repository, from_repository, last_revision=None, pb=None,
55
80
"""Create a repo fetcher.
57
:param last_revision: If set, try to limit to the data this revision
59
:param fetch_spec: A SearchResult specifying which revisions to fetch.
60
If set, this overrides last_revision.
61
82
:param find_ghosts: If True search the entire history for ghosts.
63
# repository.fetch has the responsibility for short-circuiting
64
# attempts to copy between a repository and itself.
85
self.failed_revisions = []
87
if to_repository.has_same_location(from_repository):
88
# repository.fetch should be taking care of this case.
89
raise errors.BzrError('RepoFetcher run '
90
'between two objects at the same location: '
91
'%r and %r' % (to_repository, from_repository))
65
92
self.to_repository = to_repository
66
93
self.from_repository = from_repository
67
self.sink = to_repository._get_sink()
68
94
# must not mutate self._last_revision as its potentially a shared instance
69
95
self._last_revision = last_revision
70
self._fetch_spec = fetch_spec
71
96
self.find_ghosts = find_ghosts
98
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
99
self.nested_pb = self.pb
102
self.nested_pb = None
72
103
self.from_repository.lock_read()
73
mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
74
self.from_repository, self.from_repository._format,
75
self.to_repository, self.to_repository._format)
105
self.to_repository.lock_write()
107
self.to_repository.start_write_group()
111
self.to_repository.abort_write_group()
114
self.to_repository.commit_write_group()
116
if self.nested_pb is not None:
117
self.nested_pb.finished()
118
self.to_repository.unlock()
79
120
self.from_repository.unlock()
81
122
def __fetch(self):
82
123
"""Primary worker function.
84
This initialises all the needed variables, and then fetches the
125
This initialises all the needed variables, and then fetches the
85
126
requested revisions, finally clearing the progress bar.
87
# Roughly this is what we're aiming for fetch to become:
89
# missing = self.sink.insert_stream(self.source.get_stream(search))
91
# missing = self.sink.insert_stream(self.source.get_items(missing))
128
self.to_weaves = self.to_repository.weave_store
129
self.from_weaves = self.from_repository.weave_store
93
130
self.count_total = 0
94
131
self.file_ids_names = {}
95
pb = ui.ui_factory.nested_progress_bar()
96
pb.show_pct = pb.show_count = False
132
pp = ProgressPhase('Transferring', 4, self.pb)
98
pb.update(gettext("Finding revisions"), 0, 2)
99
search_result = self._revids_to_fetch()
100
mutter('fetching: %s', search_result)
101
if search_result.is_empty():
135
search = self._revids_to_fetch()
103
pb.update(gettext("Fetching revisions"), 1, 2)
104
self._fetch_everything_for_search(search_result)
138
if getattr(self, '_fetch_everything_for_search', None) is not None:
139
self._fetch_everything_for_search(search, pp)
141
# backward compatibility
142
self._fetch_everything_for_revisions(search.get_keys, pp)
108
def _fetch_everything_for_search(self, search):
146
def _fetch_everything_for_search(self, search, pp):
109
147
"""Fetch all data for the given set of revisions."""
110
148
# The first phase is "file". We pass the progress bar for it directly
111
149
# into item_keys_introduced_by, which has more information about how
115
153
# item_keys_introduced_by should have a richer API than it does at the
116
154
# moment, so that it can feed the progress information back to this
118
if (self.from_repository._format.rich_root_data and
119
not self.to_repository._format.rich_root_data):
120
raise errors.IncompatibleRepositories(
121
self.from_repository, self.to_repository,
122
"different rich-root support")
123
pb = ui.ui_factory.nested_progress_bar()
157
pb = bzrlib.ui.ui_factory.nested_progress_bar()
125
pb.update("Get stream source")
126
source = self.from_repository._get_source(
127
self.to_repository._format)
128
stream = source.get_stream(search)
129
from_format = self.from_repository._format
130
pb.update("Inserting stream")
131
resume_tokens, missing_keys = self.sink.insert_stream(
132
stream, from_format, [])
134
pb.update("Missing keys")
135
stream = source.get_stream_for_missing_keys(missing_keys)
136
pb.update("Inserting missing keys")
137
resume_tokens, missing_keys = self.sink.insert_stream(
138
stream, from_format, resume_tokens)
140
raise AssertionError(
141
"second push failed to complete a fetch %r." % (
144
raise AssertionError(
145
"second push failed to commit the fetch %r." % (
147
pb.update("Finishing stream")
159
revs = search.get_keys()
160
data_to_fetch = self.from_repository.item_keys_introduced_by(revs, pb)
161
for knit_kind, file_id, revisions in data_to_fetch:
162
if knit_kind != phase:
164
# Make a new progress bar for this phase
167
pb = bzrlib.ui.ui_factory.nested_progress_bar()
168
if knit_kind == "file":
169
self._fetch_weave_text(file_id, revisions)
170
elif knit_kind == "inventory":
172
# Once we've processed all the files, then we generate the root
173
# texts (if necessary), then we process the inventory. It's a
174
# bit distasteful to have knit_kind == "inventory" mean this,
175
# perhaps it should happen on the first non-"file" knit, in case
176
# it's not always inventory?
177
self._generate_root_texts(revs)
178
self._fetch_inventory_weave(revs, pb)
179
elif knit_kind == "signatures":
180
# Nothing to do here; this will be taken care of when
181
# _fetch_revision_texts happens.
183
elif knit_kind == "revisions":
184
self._fetch_revision_texts(revs, pb)
186
raise AssertionError("Unknown knit kind %r" % knit_kind)
190
self.count_copied += len(revs)
152
192
def _revids_to_fetch(self):
153
193
"""Determines the exact revisions needed from self.from_repository to
154
194
install self._last_revision in self.to_repository.
156
:returns: A SearchResult of some sort. (Possibly a
157
PendingAncestryResult, EmptySearchResult, etc.)
196
If no revisions need to be fetched, then this just returns None.
159
if self._fetch_spec is not None:
160
# The fetch spec is already a concrete search result.
161
return self._fetch_spec
162
elif self._last_revision == NULL_REVISION:
163
# fetch_spec is None + last_revision is null => empty fetch.
198
mutter('fetch up to rev {%s}', self._last_revision)
199
if self._last_revision is NULL_REVISION:
164
200
# explicit limit of no revisions needed
165
return vf_search.EmptySearchResult()
166
elif self._last_revision is not None:
167
return vf_search.NotInOtherForRevs(self.to_repository,
168
self.from_repository, [self._last_revision],
169
find_ghosts=self.find_ghosts).execute()
170
else: # self._last_revision is None:
171
return vf_search.EverythingNotInOther(self.to_repository,
172
self.from_repository,
173
find_ghosts=self.find_ghosts).execute()
202
if (self._last_revision is not None and
203
self.to_repository.has_revision(self._last_revision)):
206
return self.to_repository.search_missing_revision_ids(
207
self.from_repository, self._last_revision,
208
find_ghosts=self.find_ghosts)
209
except errors.NoSuchRevision:
210
raise InstallFailed([self._last_revision])
212
def _fetch_weave_text(self, file_id, required_versions):
213
to_weave = self.to_weaves.get_weave_or_empty(file_id,
214
self.to_repository.get_transaction())
215
from_weave = self.from_weaves.get_weave(file_id,
216
self.from_repository.get_transaction())
217
# we fetch all the texts, because texts do
218
# not reference anything, and its cheap enough
219
to_weave.join(from_weave, version_ids=required_versions)
220
# we don't need *all* of this data anymore, but we dont know
221
# what we do. This cache clearing will result in a new read
222
# of the knit data when we do the checkout, but probably we
223
# want to emit the needed data on the fly rather than at the
225
# the from weave should know not to cache data being joined,
226
# but its ok to ask it to clear.
227
from_weave.clear_cache()
228
to_weave.clear_cache()
230
def _fetch_inventory_weave(self, revs, pb):
231
pb.update("fetch inventory", 0, 2)
232
to_weave = self.to_repository.get_inventory_weave()
233
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
235
# just merge, this is optimisable and its means we don't
236
# copy unreferenced data such as not-needed inventories.
237
pb.update("fetch inventory", 1, 3)
238
from_weave = self.from_repository.get_inventory_weave()
239
pb.update("fetch inventory", 2, 3)
240
# we fetch only the referenced inventories because we do not
241
# know for unselected inventories whether all their required
242
# texts are present in the other repository - it could be
244
to_weave.join(from_weave, pb=child_pb, msg='merge inventory',
246
from_weave.clear_cache()
250
def _generate_root_texts(self, revs):
251
"""This will be called by __fetch between fetching weave texts and
252
fetching the inventory weave.
254
Subclasses should override this if they need to generate root texts
255
after fetching weave texts.
260
class GenericRepoFetcher(RepoFetcher):
261
"""This is a generic repo to repo fetcher.
263
This makes minimal assumptions about repo layout and contents.
264
It triggers a reconciliation after fetching to ensure integrity.
267
def _fetch_revision_texts(self, revs, pb):
268
"""Fetch revision object texts"""
269
to_txn = self.to_transaction = self.to_repository.get_transaction()
272
to_store = self.to_repository._revision_store
274
pb.update('copying revisions', count, total)
276
sig_text = self.from_repository.get_signature_text(rev)
277
to_store.add_revision_signature_text(rev, sig_text, to_txn)
278
except errors.NoSuchRevision:
281
to_store.add_revision(self.from_repository.get_revision(rev),
284
# fixup inventory if needed:
285
# this is expensive because we have no inverse index to current ghosts.
286
# but on local disk its a few seconds and sftp push is already insane.
288
# FIXME: repository should inform if this is needed.
289
self.to_repository.reconcile()
292
class KnitRepoFetcher(RepoFetcher):
293
"""This is a knit format repository specific fetcher.
295
This differs from the GenericRepoFetcher by not doing a
296
reconciliation after copying, and using knit joining to
300
def _fetch_revision_texts(self, revs, pb):
301
# may need to be a InterRevisionStore call here.
302
from_transaction = self.from_repository.get_transaction()
303
to_transaction = self.to_repository.get_transaction()
304
to_sf = self.to_repository._revision_store.get_signature_file(
306
from_sf = self.from_repository._revision_store.get_signature_file(
308
to_sf.join(from_sf, version_ids=revs, ignore_missing=True)
309
to_rf = self.to_repository._revision_store.get_revision_file(
311
from_rf = self.from_repository._revision_store.get_revision_file(
313
to_rf.join(from_rf, version_ids=revs)
176
316
class Inter1and2Helper(object):
177
317
"""Helper for operations that convert data from model 1 and 2
179
319
This is for use by fetchers and converters.
182
# This is a class variable so that the test suite can override it.
183
known_graph_threshold = 100
185
def __init__(self, source):
322
def __init__(self, source, target):
188
325
:param source: The repository data comes from
326
:param target: The repository data goes to
190
328
self.source = source
192
331
def iter_rev_trees(self, revs):
193
332
"""Iterate through RevisionTrees efficiently.
203
342
revs = list(revs)
205
344
for tree in self.source.revision_trees(revs[:100]):
206
if tree.root_inventory.revision_id is None:
207
tree.root_inventory.revision_id = tree.get_revision_id()
345
if tree.inventory.revision_id is None:
346
tree.inventory.revision_id = tree.get_revision_id()
209
348
revs = revs[100:]
211
def _find_root_ids(self, revs, parent_map, graph):
213
for tree in self.iter_rev_trees(revs):
214
root_id = tree.get_root_id()
215
revision_id = tree.get_file_revision(root_id, u"")
216
revision_root[revision_id] = root_id
217
# Find out which parents we don't already know root ids for
219
for revision_parents in parent_map.itervalues():
220
parents.update(revision_parents)
221
parents.difference_update(revision_root.keys() + [NULL_REVISION])
222
# Limit to revisions present in the versionedfile
223
parents = graph.get_parent_map(parents).keys()
224
for tree in self.iter_rev_trees(parents):
225
root_id = tree.get_root_id()
226
revision_root[tree.get_revision_id()] = root_id
229
350
def generate_root_texts(self, revs):
230
351
"""Generate VersionedFiles for all root ids.
232
353
:param revs: the revisions to include
234
graph = self.source.get_graph()
235
parent_map = graph.get_parent_map(revs)
236
rev_order = tsort.topo_sort(parent_map)
237
rev_id_to_root_id = self._find_root_ids(revs, parent_map, graph)
238
root_id_order = [(rev_id_to_root_id[rev_id], rev_id) for rev_id in
240
# Guaranteed stable, this groups all the file id operations together
241
# retaining topological order within the revisions of a file id.
242
# File id splits and joins would invalidate this, but they don't exist
243
# yet, and are unlikely to in non-rich-root environments anyway.
244
root_id_order.sort(key=operator.itemgetter(0))
245
# Create a record stream containing the roots to create.
246
if len(revs) > self.known_graph_threshold:
247
graph = self.source.get_known_graph_ancestry(revs)
248
new_roots_stream = _new_root_data_stream(
249
root_id_order, rev_id_to_root_id, parent_map, self.source, graph)
250
return [('texts', new_roots_stream)]
253
def _new_root_data_stream(
254
root_keys_to_create, rev_id_to_root_id_map, parent_map, repo, graph=None):
255
"""Generate a texts substream of synthesised root entries.
257
Used in fetches that do rich-root upgrades.
259
:param root_keys_to_create: iterable of (root_id, rev_id) pairs describing
260
the root entries to create.
261
:param rev_id_to_root_id_map: dict of known rev_id -> root_id mappings for
262
calculating the parents. If a parent rev_id is not found here then it
263
will be recalculated.
264
:param parent_map: a parent map for all the revisions in
266
:param graph: a graph to use instead of repo.get_graph().
268
for root_key in root_keys_to_create:
269
root_id, rev_id = root_key
270
parent_keys = _parent_keys_for_root_version(
271
root_id, rev_id, rev_id_to_root_id_map, parent_map, repo, graph)
272
yield versionedfile.FulltextContentFactory(
273
root_key, parent_keys, None, '')
276
def _parent_keys_for_root_version(
277
root_id, rev_id, rev_id_to_root_id_map, parent_map, repo, graph=None):
278
"""Get the parent keys for a given root id.
280
A helper function for _new_root_data_stream.
282
# Include direct parents of the revision, but only if they used the same
283
# root_id and are heads.
284
rev_parents = parent_map[rev_id]
286
for parent_id in rev_parents:
287
if parent_id == NULL_REVISION:
289
if parent_id not in rev_id_to_root_id_map:
290
# We probably didn't read this revision, go spend the extra effort
293
tree = repo.revision_tree(parent_id)
294
except errors.NoSuchRevision:
295
# Ghost, fill out rev_id_to_root_id in case we encounter this
297
# But set parent_root_id to None since we don't really know
298
parent_root_id = None
300
parent_root_id = tree.get_root_id()
301
rev_id_to_root_id_map[parent_id] = None
303
# rev_id_to_root_id_map[parent_id] = parent_root_id
304
# memory consumption maybe?
306
parent_root_id = rev_id_to_root_id_map[parent_id]
307
if root_id == parent_root_id:
308
# With stacking we _might_ want to refer to a non-local revision,
309
# but this code path only applies when we have the full content
310
# available, so ghosts really are ghosts, not just the edge of
312
parent_ids.append(parent_id)
314
# root_id may be in the parent anyway.
316
tree = repo.revision_tree(parent_id)
317
except errors.NoSuchRevision:
318
# ghost, can't refer to it.
322
parent_ids.append(tree.get_file_revision(root_id))
323
except errors.NoSuchId:
326
# Drop non-head parents
328
graph = repo.get_graph()
329
heads = graph.heads(parent_ids)
331
for parent_id in parent_ids:
332
if parent_id in heads and parent_id not in selected_ids:
333
selected_ids.append(parent_id)
334
parent_keys = [(root_id, parent_id) for parent_id in selected_ids]
338
class TargetRepoKinds(object):
339
"""An enum-like set of constants.
341
They are the possible values of FetchSpecFactory.target_repo_kinds.
344
PREEXISTING = 'preexisting'
349
class FetchSpecFactory(object):
350
"""A helper for building the best fetch spec for a sprout call.
352
Factors that go into determining the sort of fetch to perform:
353
* did the caller specify any revision IDs?
354
* did the caller specify a source branch (need to fetch its
355
heads_to_fetch(), usually the tip + tags)
356
* is there an existing target repo (don't need to refetch revs it
358
* target is stacked? (similar to pre-existing target repo: even if
359
the target itself is new don't want to refetch existing revs)
361
:ivar source_branch: the source branch if one specified, else None.
362
:ivar source_branch_stop_revision_id: fetch up to this revision of
363
source_branch, rather than its tip.
364
:ivar source_repo: the source repository if one found, else None.
365
:ivar target_repo: the target repository acquired by sprout.
366
:ivar target_repo_kind: one of the TargetRepoKinds constants.
370
self._explicit_rev_ids = set()
371
self.source_branch = None
372
self.source_branch_stop_revision_id = None
373
self.source_repo = None
374
self.target_repo = None
375
self.target_repo_kind = None
378
def add_revision_ids(self, revision_ids):
379
"""Add revision_ids to the set of revision_ids to be fetched."""
380
self._explicit_rev_ids.update(revision_ids)
382
def make_fetch_spec(self):
383
"""Build a SearchResult or PendingAncestryResult or etc."""
384
if self.target_repo_kind is None or self.source_repo is None:
385
raise AssertionError(
386
'Incomplete FetchSpecFactory: %r' % (self.__dict__,))
387
if len(self._explicit_rev_ids) == 0 and self.source_branch is None:
388
if self.limit is not None:
389
raise NotImplementedError(
390
"limit is only supported with a source branch set")
391
# Caller hasn't specified any revisions or source branch
392
if self.target_repo_kind == TargetRepoKinds.EMPTY:
393
return vf_search.EverythingResult(self.source_repo)
395
# We want everything not already in the target (or target's
397
return vf_search.EverythingNotInOther(
398
self.target_repo, self.source_repo).execute()
399
heads_to_fetch = set(self._explicit_rev_ids)
400
if self.source_branch is not None:
401
must_fetch, if_present_fetch = self.source_branch.heads_to_fetch()
402
if self.source_branch_stop_revision_id is not None:
403
# Replace the tip rev from must_fetch with the stop revision
404
# XXX: this might be wrong if the tip rev is also in the
405
# must_fetch set for other reasons (e.g. it's the tip of
406
# multiple loom threads?), but then it's pretty unclear what it
407
# should mean to specify a stop_revision in that case anyway.
408
must_fetch.discard(self.source_branch.last_revision())
409
must_fetch.add(self.source_branch_stop_revision_id)
410
heads_to_fetch.update(must_fetch)
412
if_present_fetch = set()
413
if self.target_repo_kind == TargetRepoKinds.EMPTY:
414
# PendingAncestryResult does not raise errors if a requested head
415
# is absent. Ideally it would support the
416
# required_ids/if_present_ids distinction, but in practice
417
# heads_to_fetch will almost certainly be present so this doesn't
419
all_heads = heads_to_fetch.union(if_present_fetch)
420
ret = vf_search.PendingAncestryResult(all_heads, self.source_repo)
421
if self.limit is not None:
422
graph = self.source_repo.get_graph()
423
topo_order = list(graph.iter_topo_order(ret.get_keys()))
424
result_set = topo_order[:self.limit]
425
ret = self.source_repo.revision_ids_to_search_result(result_set)
428
return vf_search.NotInOtherForRevs(self.target_repo, self.source_repo,
429
required_ids=heads_to_fetch, if_present_ids=if_present_fetch,
430
limit=self.limit).execute()
355
inventory_weave = self.source.get_inventory_weave()
358
to_store = self.target.weave_store
359
for tree in self.iter_rev_trees(revs):
360
revision_id = tree.inventory.root.revision
361
root_id = tree.get_root_id()
362
parents = inventory_weave.get_parents(revision_id)
363
if root_id not in versionedfile:
364
versionedfile[root_id] = to_store.get_weave_or_empty(root_id,
365
self.target.get_transaction())
366
_, _, parent_texts[root_id] = versionedfile[root_id].add_lines(
367
revision_id, parents, [], parent_texts)
369
def regenerate_inventory(self, revs):
370
"""Generate a new inventory versionedfile in target, convertin data.
372
The inventory is retrieved from the source, (deserializing it), and
373
stored in the target (reserializing it in a different format).
374
:param revs: The revisions to include
376
for tree in self.iter_rev_trees(revs):
377
parents = tree.get_parent_ids()
378
self.target.add_inventory(tree.get_revision_id(), tree.inventory,
382
class Model1toKnit2Fetcher(GenericRepoFetcher):
383
"""Fetch from a Model1 repository into a Knit2 repository
385
def __init__(self, to_repository, from_repository, last_revision=None,
386
pb=None, find_ghosts=True):
387
self.helper = Inter1and2Helper(from_repository, to_repository)
388
GenericRepoFetcher.__init__(self, to_repository, from_repository,
389
last_revision, pb, find_ghosts)
391
def _generate_root_texts(self, revs):
392
self.helper.generate_root_texts(revs)
394
def _fetch_inventory_weave(self, revs, pb):
395
self.helper.regenerate_inventory(revs)
398
class Knit1to2Fetcher(KnitRepoFetcher):
399
"""Fetch from a Knit1 repository into a Knit2 repository"""
401
def __init__(self, to_repository, from_repository, last_revision=None,
402
pb=None, find_ghosts=True):
403
self.helper = Inter1and2Helper(from_repository, to_repository)
404
KnitRepoFetcher.__init__(self, to_repository, from_repository,
405
last_revision, pb, find_ghosts)
407
def _generate_root_texts(self, revs):
408
self.helper.generate_root_texts(revs)
410
def _fetch_inventory_weave(self, revs, pb):
411
self.helper.regenerate_inventory(revs)
414
class RemoteToOtherFetcher(GenericRepoFetcher):
416
def _fetch_everything_for_search(self, search, pp):
417
data_stream = self.from_repository.get_data_stream_for_search(search)
418
self.to_repository.insert_data_stream(data_stream)
added
removed
bzrlib/fetch.py
