1
# Copyright (C) 2005-2011 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""Copying of history from one branch to another.
19
The basic plan is that every branch knows the history of everything
20
that has merged into it. As the first step of a merge, pull, or
21
branch operation we copy history from the source into the destination
25
from __future__ import absolute_import
29
from .lazy_import import lazy_import
30
lazy_import(globals(), """
34
from breezy.bzr import (
43
from .i18n import gettext
44
from .revision import NULL_REVISION
48
from .trace import mutter
51
class RepoFetcher(object):
52
"""Pull revisions and texts from one repository to another.
54
This should not be used directly, it's essential a object to encapsulate
55
the logic in InterRepository.fetch().
58
def __init__(self, to_repository, from_repository, last_revision=None,
59
find_ghosts=True, fetch_spec=None):
60
"""Create a repo fetcher.
62
:param last_revision: If set, try to limit to the data this revision
64
:param fetch_spec: A SearchResult specifying which revisions to fetch.
65
If set, this overrides last_revision.
66
:param find_ghosts: If True search the entire history for ghosts.
68
# repository.fetch has the responsibility for short-circuiting
69
# attempts to copy between a repository and itself.
70
self.to_repository = to_repository
71
self.from_repository = from_repository
72
self.sink = to_repository._get_sink()
73
# must not mutate self._last_revision as its potentially a shared instance
74
self._last_revision = last_revision
75
self._fetch_spec = fetch_spec
76
self.find_ghosts = find_ghosts
77
self.from_repository.lock_read()
78
mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
79
self.from_repository, self.from_repository._format,
80
self.to_repository, self.to_repository._format)
84
self.from_repository.unlock()
87
"""Primary worker function.
89
This initialises all the needed variables, and then fetches the
90
requested revisions, finally clearing the progress bar.
92
# Roughly this is what we're aiming for fetch to become:
94
# missing = self.sink.insert_stream(self.source.get_stream(search))
96
# missing = self.sink.insert_stream(self.source.get_items(missing))
99
self.file_ids_names = {}
100
pb = ui.ui_factory.nested_progress_bar()
101
pb.show_pct = pb.show_count = False
103
pb.update(gettext("Finding revisions"), 0, 2)
104
search_result = self._revids_to_fetch()
105
mutter('fetching: %s', search_result)
106
if search_result.is_empty():
108
pb.update(gettext("Fetching revisions"), 1, 2)
109
self._fetch_everything_for_search(search_result)
113
def _fetch_everything_for_search(self, search):
114
"""Fetch all data for the given set of revisions."""
115
# The first phase is "file". We pass the progress bar for it directly
116
# into item_keys_introduced_by, which has more information about how
117
# that phase is progressing than we do. Progress updates for the other
118
# phases are taken care of in this function.
119
# XXX: there should be a clear owner of the progress reporting. Perhaps
120
# item_keys_introduced_by should have a richer API than it does at the
121
# moment, so that it can feed the progress information back to this
123
if (self.from_repository._format.rich_root_data and
124
not self.to_repository._format.rich_root_data):
125
raise errors.IncompatibleRepositories(
126
self.from_repository, self.to_repository,
127
"different rich-root support")
128
pb = ui.ui_factory.nested_progress_bar()
130
pb.update("Get stream source")
131
source = self.from_repository._get_source(
132
self.to_repository._format)
133
stream = source.get_stream(search)
134
from_format = self.from_repository._format
135
pb.update("Inserting stream")
136
resume_tokens, missing_keys = self.sink.insert_stream(
137
stream, from_format, [])
139
pb.update("Missing keys")
140
stream = source.get_stream_for_missing_keys(missing_keys)
141
pb.update("Inserting missing keys")
142
resume_tokens, missing_keys = self.sink.insert_stream(
143
stream, from_format, resume_tokens)
145
raise AssertionError(
146
"second push failed to complete a fetch %r." % (
149
raise AssertionError(
150
"second push failed to commit the fetch %r." % (
152
pb.update("Finishing stream")
157
def _revids_to_fetch(self):
158
"""Determines the exact revisions needed from self.from_repository to
159
install self._last_revision in self.to_repository.
161
:returns: A SearchResult of some sort. (Possibly a
162
PendingAncestryResult, EmptySearchResult, etc.)
164
if self._fetch_spec is not None:
165
# The fetch spec is already a concrete search result.
166
return self._fetch_spec
167
elif self._last_revision == NULL_REVISION:
168
# fetch_spec is None + last_revision is null => empty fetch.
169
# explicit limit of no revisions needed
170
return vf_search.EmptySearchResult()
171
elif self._last_revision is not None:
172
return vf_search.NotInOtherForRevs(self.to_repository,
173
self.from_repository, [self._last_revision],
174
find_ghosts=self.find_ghosts).execute()
175
else: # self._last_revision is None:
176
return vf_search.EverythingNotInOther(self.to_repository,
177
self.from_repository,
178
find_ghosts=self.find_ghosts).execute()
181
class Inter1and2Helper(object):
182
"""Helper for operations that convert data from model 1 and 2
184
This is for use by fetchers and converters.
187
# This is a class variable so that the test suite can override it.
188
known_graph_threshold = 100
190
def __init__(self, source):
193
:param source: The repository data comes from
197
def iter_rev_trees(self, revs):
198
"""Iterate through RevisionTrees efficiently.
200
Additionally, the inventory's revision_id is set if unset.
202
Trees are retrieved in batches of 100, and then yielded in the order
205
:param revs: A list of revision ids
207
# In case that revs is not a list.
210
for tree in self.source.revision_trees(revs[:100]):
211
if tree.root_inventory.revision_id is None:
212
tree.root_inventory.revision_id = tree.get_revision_id()
216
def _find_root_ids(self, revs, parent_map, graph):
218
for tree in self.iter_rev_trees(revs):
219
root_id = tree.get_root_id()
220
revision_id = tree.get_file_revision(root_id, u"")
221
revision_root[revision_id] = root_id
222
# Find out which parents we don't already know root ids for
223
parents = set(viewvalues(parent_map))
224
parents.difference_update(revision_root)
225
parents.discard(NULL_REVISION)
226
# Limit to revisions present in the versionedfile
227
parents = graph.get_parent_map(parents)
228
for tree in self.iter_rev_trees(parents):
229
root_id = tree.get_root_id()
230
revision_root[tree.get_revision_id()] = root_id
233
def generate_root_texts(self, revs):
234
"""Generate VersionedFiles for all root ids.
236
:param revs: the revisions to include
238
graph = self.source.get_graph()
239
parent_map = graph.get_parent_map(revs)
240
rev_order = tsort.topo_sort(parent_map)
241
rev_id_to_root_id = self._find_root_ids(revs, parent_map, graph)
242
root_id_order = [(rev_id_to_root_id[rev_id], rev_id) for rev_id in
244
# Guaranteed stable, this groups all the file id operations together
245
# retaining topological order within the revisions of a file id.
246
# File id splits and joins would invalidate this, but they don't exist
247
# yet, and are unlikely to in non-rich-root environments anyway.
248
root_id_order.sort(key=operator.itemgetter(0))
249
# Create a record stream containing the roots to create.
250
if len(revs) > self.known_graph_threshold:
251
graph = self.source.get_known_graph_ancestry(revs)
252
new_roots_stream = _new_root_data_stream(
253
root_id_order, rev_id_to_root_id, parent_map, self.source, graph)
254
return [('texts', new_roots_stream)]
257
def _new_root_data_stream(
258
root_keys_to_create, rev_id_to_root_id_map, parent_map, repo, graph=None):
259
"""Generate a texts substream of synthesised root entries.
261
Used in fetches that do rich-root upgrades.
263
:param root_keys_to_create: iterable of (root_id, rev_id) pairs describing
264
the root entries to create.
265
:param rev_id_to_root_id_map: dict of known rev_id -> root_id mappings for
266
calculating the parents. If a parent rev_id is not found here then it
267
will be recalculated.
268
:param parent_map: a parent map for all the revisions in
270
:param graph: a graph to use instead of repo.get_graph().
272
for root_key in root_keys_to_create:
273
root_id, rev_id = root_key
274
parent_keys = _parent_keys_for_root_version(
275
root_id, rev_id, rev_id_to_root_id_map, parent_map, repo, graph)
276
yield versionedfile.FulltextContentFactory(
277
root_key, parent_keys, None, '')
280
def _parent_keys_for_root_version(
281
root_id, rev_id, rev_id_to_root_id_map, parent_map, repo, graph=None):
282
"""Get the parent keys for a given root id.
284
A helper function for _new_root_data_stream.
286
# Include direct parents of the revision, but only if they used the same
287
# root_id and are heads.
288
rev_parents = parent_map[rev_id]
290
for parent_id in rev_parents:
291
if parent_id == NULL_REVISION:
293
if parent_id not in rev_id_to_root_id_map:
294
# We probably didn't read this revision, go spend the extra effort
297
tree = repo.revision_tree(parent_id)
298
except errors.NoSuchRevision:
299
# Ghost, fill out rev_id_to_root_id in case we encounter this
301
# But set parent_root_id to None since we don't really know
302
parent_root_id = None
304
parent_root_id = tree.get_root_id()
305
rev_id_to_root_id_map[parent_id] = None
307
# rev_id_to_root_id_map[parent_id] = parent_root_id
308
# memory consumption maybe?
310
parent_root_id = rev_id_to_root_id_map[parent_id]
311
if root_id == parent_root_id:
312
# With stacking we _might_ want to refer to a non-local revision,
313
# but this code path only applies when we have the full content
314
# available, so ghosts really are ghosts, not just the edge of
316
parent_ids.append(parent_id)
318
# root_id may be in the parent anyway.
320
tree = repo.revision_tree(parent_id)
321
except errors.NoSuchRevision:
322
# ghost, can't refer to it.
326
parent_ids.append(tree.get_file_revision(root_id))
327
except errors.NoSuchId:
330
# Drop non-head parents
332
graph = repo.get_graph()
333
heads = graph.heads(parent_ids)
335
for parent_id in parent_ids:
336
if parent_id in heads and parent_id not in selected_ids:
337
selected_ids.append(parent_id)
338
parent_keys = [(root_id, parent_id) for parent_id in selected_ids]
342
class TargetRepoKinds(object):
343
"""An enum-like set of constants.
345
They are the possible values of FetchSpecFactory.target_repo_kinds.
348
PREEXISTING = 'preexisting'
353
class FetchSpecFactory(object):
354
"""A helper for building the best fetch spec for a sprout call.
356
Factors that go into determining the sort of fetch to perform:
357
* did the caller specify any revision IDs?
358
* did the caller specify a source branch (need to fetch its
359
heads_to_fetch(), usually the tip + tags)
360
* is there an existing target repo (don't need to refetch revs it
362
* target is stacked? (similar to pre-existing target repo: even if
363
the target itself is new don't want to refetch existing revs)
365
:ivar source_branch: the source branch if one specified, else None.
366
:ivar source_branch_stop_revision_id: fetch up to this revision of
367
source_branch, rather than its tip.
368
:ivar source_repo: the source repository if one found, else None.
369
:ivar target_repo: the target repository acquired by sprout.
370
:ivar target_repo_kind: one of the TargetRepoKinds constants.
374
self._explicit_rev_ids = set()
375
self.source_branch = None
376
self.source_branch_stop_revision_id = None
377
self.source_repo = None
378
self.target_repo = None
379
self.target_repo_kind = None
382
def add_revision_ids(self, revision_ids):
383
"""Add revision_ids to the set of revision_ids to be fetched."""
384
self._explicit_rev_ids.update(revision_ids)
386
def make_fetch_spec(self):
387
"""Build a SearchResult or PendingAncestryResult or etc."""
388
if self.target_repo_kind is None or self.source_repo is None:
389
raise AssertionError(
390
'Incomplete FetchSpecFactory: %r' % (self.__dict__,))
391
if len(self._explicit_rev_ids) == 0 and self.source_branch is None:
392
if self.limit is not None:
393
raise NotImplementedError(
394
"limit is only supported with a source branch set")
395
# Caller hasn't specified any revisions or source branch
396
if self.target_repo_kind == TargetRepoKinds.EMPTY:
397
return vf_search.EverythingResult(self.source_repo)
399
# We want everything not already in the target (or target's
401
return vf_search.EverythingNotInOther(
402
self.target_repo, self.source_repo).execute()
403
heads_to_fetch = set(self._explicit_rev_ids)
404
if self.source_branch is not None:
405
must_fetch, if_present_fetch = self.source_branch.heads_to_fetch()
406
if self.source_branch_stop_revision_id is not None:
407
# Replace the tip rev from must_fetch with the stop revision
408
# XXX: this might be wrong if the tip rev is also in the
409
# must_fetch set for other reasons (e.g. it's the tip of
410
# multiple loom threads?), but then it's pretty unclear what it
411
# should mean to specify a stop_revision in that case anyway.
412
must_fetch.discard(self.source_branch.last_revision())
413
must_fetch.add(self.source_branch_stop_revision_id)
414
heads_to_fetch.update(must_fetch)
416
if_present_fetch = set()
417
if self.target_repo_kind == TargetRepoKinds.EMPTY:
418
# PendingAncestryResult does not raise errors if a requested head
419
# is absent. Ideally it would support the
420
# required_ids/if_present_ids distinction, but in practice
421
# heads_to_fetch will almost certainly be present so this doesn't
423
all_heads = heads_to_fetch.union(if_present_fetch)
424
ret = vf_search.PendingAncestryResult(all_heads, self.source_repo)
425
if self.limit is not None:
426
graph = self.source_repo.get_graph()
427
topo_order = list(graph.iter_topo_order(ret.get_keys()))
428
result_set = topo_order[:self.limit]
429
ret = self.source_repo.revision_ids_to_search_result(result_set)
432
return vf_search.NotInOtherForRevs(self.target_repo, self.source_repo,
433
required_ids=heads_to_fetch, if_present_ids=if_present_fetch,
434
limit=self.limit).execute()
added
removed
breezy/fetch.py
