← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/fetch.py

  • Committer: John Arbash Meinel
  • Date: 2009-08-25 18:45:40 UTC
  • mto: (4634.6.15 2.0)
  • mto: This revision was merged to the branch mainline in revision 4667.
  • Revision ID: john@arbash-meinel.com-20090825184540-6dn3xjq62xhgj2gq
Add support for skipping ghost nodes.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/fetch.py
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2008, 2009 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
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
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
 
18
18
"""Copying of history from one branch to another.
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
23
23
branch.
24
 
 
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
31
 
the inventories.
32
24
"""
33
25
 
 
26
import operator
 
27
 
 
28
from bzrlib.lazy_import import lazy_import
 
29
lazy_import(globals(), """
 
30
from bzrlib import (
 
31
    tsort,
 
32
    versionedfile,
 
33
    )
 
34
""")
34
35
import bzrlib
35
 
import bzrlib.errors as errors
36
 
from bzrlib.errors import (InstallFailed,
37
 
                           )
38
 
from bzrlib.progress import ProgressPhase
39
 
from bzrlib.revision import is_null, NULL_REVISION
40
 
from bzrlib.symbol_versioning import (deprecated_function,
41
 
        deprecated_method,
42
 
        )
 
36
from bzrlib import (
 
37
    errors,
 
38
    symbol_versioning,
 
39
    )
 
40
from bzrlib.revision import NULL_REVISION
43
41
from bzrlib.trace import mutter
44
42
import bzrlib.ui
45
43
 
46
 
from bzrlib.lazy_import import lazy_import
47
 
 
48
 
# TODO: Avoid repeatedly opening weaves so many times.
49
 
 
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.
52
 
 
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.
55
 
 
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
59
 
#   parents.
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
64
 
 
65
44
 
66
45
class RepoFetcher(object):
67
46
    """Pull revisions and texts from one repository to another.
68
47
 
69
 
    last_revision
70
 
        if set, try to limit to the data this revision references.
71
 
 
72
 
    after running:
73
 
    count_copied -- number of revisions copied
74
 
 
75
 
    This should not be used directory, its essential a object to encapsulate
 
48
    This should not be used directly, it's essential a object to encapsulate
76
49
    the logic in InterRepository.fetch().
77
50
    """
78
 
    def __init__(self, to_repository, from_repository, last_revision=None, pb=None):
79
 
        # result variables.
80
 
        self.failed_revisions = []
81
 
        self.count_copied = 0
82
 
        if to_repository.has_same_location(from_repository):
83
 
            # check that last_revision is in 'from' and then return a
84
 
            # no-operation.
85
 
            if last_revision is not None and not is_null(last_revision):
86
 
                to_repository.get_revision(last_revision)
87
 
            return
 
51
 
 
52
    def __init__(self, to_repository, from_repository, last_revision=None,
 
53
        pb=None, find_ghosts=True, fetch_spec=None):
 
54
        """Create a repo fetcher.
 
55
 
 
56
        :param last_revision: If set, try to limit to the data this revision
 
57
            references.
 
58
        :param find_ghosts: If True search the entire history for ghosts.
 
59
        :param pb: ProgressBar object to use; deprecated and ignored.
 
60
            This method will just create one on top of the stack.
 
61
        """
 
62
        if pb is not None:
 
63
            symbol_versioning.warn(
 
64
                symbol_versioning.deprecated_in((1, 14, 0))
 
65
                % "pb parameter to RepoFetcher.__init__")
 
66
            # and for simplicity it is in fact ignored
 
67
        # repository.fetch has the responsibility for short-circuiting
 
68
        # attempts to copy between a repository and itself.
88
69
        self.to_repository = to_repository
89
70
        self.from_repository = from_repository
 
71
        self.sink = to_repository._get_sink()
90
72
        # must not mutate self._last_revision as its potentially a shared instance
91
73
        self._last_revision = last_revision
92
 
        if pb is None:
93
 
            self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
94
 
            self.nested_pb = self.pb
95
 
        else:
96
 
            self.pb = pb
97
 
            self.nested_pb = None
 
74
        self._fetch_spec = fetch_spec
 
75
        self.find_ghosts = find_ghosts
98
76
        self.from_repository.lock_read()
 
77
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
78
               self.from_repository, self.from_repository._format,
 
79
               self.to_repository, self.to_repository._format)
99
80
        try:
100
 
            self.to_repository.lock_write()
101
 
            try:
102
 
                self.to_repository.start_write_group()
103
 
                try:
104
 
                    self.__fetch()
105
 
                except:
106
 
                    self.to_repository.abort_write_group()
107
 
                    raise
108
 
                else:
109
 
                    self.to_repository.commit_write_group()
110
 
            finally:
111
 
                if self.nested_pb is not None:
112
 
                    self.nested_pb.finished()
113
 
                self.to_repository.unlock()
 
81
            self.__fetch()
114
82
        finally:
115
83
            self.from_repository.unlock()
116
84
 
117
85
    def __fetch(self):
118
86
        """Primary worker function.
119
87
 
120
 
        This initialises all the needed variables, and then fetches the 
 
88
        This initialises all the needed variables, and then fetches the
121
89
        requested revisions, finally clearing the progress bar.
122
90
        """
123
 
        self.to_weaves = self.to_repository.weave_store
124
 
        self.from_weaves = self.from_repository.weave_store
 
91
        # Roughly this is what we're aiming for fetch to become:
 
92
        #
 
93
        # missing = self.sink.insert_stream(self.source.get_stream(search))
 
94
        # if missing:
 
95
        #     missing = self.sink.insert_stream(self.source.get_items(missing))
 
96
        # assert not missing
125
97
        self.count_total = 0
126
98
        self.file_ids_names = {}
127
 
        pp = ProgressPhase('Fetch phase', 4, self.pb)
 
99
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
100
        pb.show_pct = pb.show_count = False
128
101
        try:
129
 
            pp.next_phase()
130
 
            revs = self._revids_to_fetch()
131
 
            self._fetch_everything_for_revisions(revs, pp)
 
102
            pb.update("Finding revisions", 0, 2)
 
103
            search = self._revids_to_fetch()
 
104
            if search is None:
 
105
                return
 
106
            pb.update("Fetching revisions", 1, 2)
 
107
            self._fetch_everything_for_search(search)
132
108
        finally:
133
 
            self.pb.clear()
 
109
            pb.finished()
134
110
 
135
 
    def _fetch_everything_for_revisions(self, revs, pp):
 
111
    def _fetch_everything_for_search(self, search):
136
112
        """Fetch all data for the given set of revisions."""
137
 
        if revs is None:
138
 
            return
139
113
        # The first phase is "file".  We pass the progress bar for it directly
140
114
        # into item_keys_introduced_by, which has more information about how
141
115
        # that phase is progressing than we do.  Progress updates for the other
144
118
        # item_keys_introduced_by should have a richer API than it does at the
145
119
        # moment, so that it can feed the progress information back to this
146
120
        # function?
147
 
        phase = 'file'
 
121
        if (self.from_repository._format.rich_root_data and
 
122
            not self.to_repository._format.rich_root_data):
 
123
            raise errors.IncompatibleRepositories(
 
124
                self.from_repository, self.to_repository,
 
125
                "different rich-root support")
148
126
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
149
127
        try:
150
 
            data_to_fetch = self.from_repository.item_keys_introduced_by(revs, pb)
151
 
            for knit_kind, file_id, revisions in data_to_fetch:
152
 
                if knit_kind != phase:
153
 
                    phase = knit_kind
154
 
                    # Make a new progress bar for this phase
155
 
                    pb.finished()
156
 
                    pp.next_phase()
157
 
                    pb = bzrlib.ui.ui_factory.nested_progress_bar()
158
 
                if knit_kind == "file":
159
 
                    self._fetch_weave_text(file_id, revisions)
160
 
                elif knit_kind == "inventory":
161
 
                    # XXX:
162
 
                    # Once we've processed all the files, then we generate the root
163
 
                    # texts (if necessary), then we process the inventory.  It's a
164
 
                    # bit distasteful to have knit_kind == "inventory" mean this,
165
 
                    # perhaps it should happen on the first non-"file" knit, in case
166
 
                    # it's not always inventory?
167
 
                    self._generate_root_texts(revs)
168
 
                    self._fetch_inventory_weave(revs, pb)
169
 
                elif knit_kind == "signatures":
170
 
                    # Nothing to do here; this will be taken care of when
171
 
                    # _fetch_revision_texts happens.
172
 
                    pass
173
 
                elif knit_kind == "revisions":
174
 
                    self._fetch_revision_texts(revs, pb)
175
 
                else:
176
 
                    raise AssertionError("Unknown knit kind %r" % knit_kind)
 
128
            pb.update("Get stream source")
 
129
            source = self.from_repository._get_source(
 
130
                self.to_repository._format)
 
131
            stream = source.get_stream(search)
 
132
            from_format = self.from_repository._format
 
133
            pb.update("Inserting stream")
 
134
            resume_tokens, missing_keys = self.sink.insert_stream(
 
135
                stream, from_format, [])
 
136
            if self.to_repository._fallback_repositories:
 
137
                missing_keys.update(
 
138
                    self._parent_inventories(search.get_keys()))
 
139
            if missing_keys:
 
140
                pb.update("Missing keys")
 
141
                stream = source.get_stream_for_missing_keys(missing_keys)
 
142
                pb.update("Inserting missing keys")
 
143
                resume_tokens, missing_keys = self.sink.insert_stream(
 
144
                    stream, from_format, resume_tokens)
 
145
            if missing_keys:
 
146
                raise AssertionError(
 
147
                    "second push failed to complete a fetch %r." % (
 
148
                        missing_keys,))
 
149
            if resume_tokens:
 
150
                raise AssertionError(
 
151
                    "second push failed to commit the fetch %r." % (
 
152
                        resume_tokens,))
 
153
            pb.update("Finishing stream")
 
154
            self.sink.finished()
177
155
        finally:
178
 
            if pb is not None:
179
 
                pb.finished()
180
 
        self.count_copied += len(revs)
181
 
        
 
156
            pb.finished()
 
157
 
182
158
    def _revids_to_fetch(self):
183
159
        """Determines the exact revisions needed from self.from_repository to
184
160
        install self._last_revision in self.to_repository.
185
161
 
186
162
        If no revisions need to be fetched, then this just returns None.
187
163
        """
 
164
        if self._fetch_spec is not None:
 
165
            return self._fetch_spec
188
166
        mutter('fetch up to rev {%s}', self._last_revision)
189
167
        if self._last_revision is NULL_REVISION:
190
168
            # explicit limit of no revisions needed
191
169
            return None
192
 
        if (self._last_revision is not None and
193
 
            self.to_repository.has_revision(self._last_revision)):
194
 
            return None
195
 
            
196
 
        try:
197
 
            return self.to_repository.missing_revision_ids(self.from_repository,
198
 
                                                           self._last_revision)
199
 
        except errors.NoSuchRevision:
200
 
            raise InstallFailed([self._last_revision])
201
 
 
202
 
    def _fetch_weave_text(self, file_id, required_versions):
203
 
        to_weave = self.to_weaves.get_weave_or_empty(file_id,
204
 
            self.to_repository.get_transaction())
205
 
        from_weave = self.from_weaves.get_weave(file_id,
206
 
            self.from_repository.get_transaction())
207
 
        # we fetch all the texts, because texts do
208
 
        # not reference anything, and its cheap enough
209
 
        to_weave.join(from_weave, version_ids=required_versions)
210
 
        # we don't need *all* of this data anymore, but we dont know
211
 
        # what we do. This cache clearing will result in a new read 
212
 
        # of the knit data when we do the checkout, but probably we
213
 
        # want to emit the needed data on the fly rather than at the
214
 
        # end anyhow.
215
 
        # the from weave should know not to cache data being joined,
216
 
        # but its ok to ask it to clear.
217
 
        from_weave.clear_cache()
218
 
        to_weave.clear_cache()
219
 
 
220
 
    def _fetch_inventory_weave(self, revs, pb):
221
 
        pb.update("fetch inventory", 0, 2)
222
 
        to_weave = self.to_repository.get_inventory_weave()
223
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
224
 
        try:
225
 
            # just merge, this is optimisable and its means we don't
226
 
            # copy unreferenced data such as not-needed inventories.
227
 
            pb.update("fetch inventory", 1, 3)
228
 
            from_weave = self.from_repository.get_inventory_weave()
229
 
            pb.update("fetch inventory", 2, 3)
230
 
            # we fetch only the referenced inventories because we do not
231
 
            # know for unselected inventories whether all their required
232
 
            # texts are present in the other repository - it could be
233
 
            # corrupt.
234
 
            to_weave.join(from_weave, pb=child_pb, msg='merge inventory',
235
 
                          version_ids=revs)
236
 
            from_weave.clear_cache()
237
 
        finally:
238
 
            child_pb.finished()
239
 
 
240
 
    def _generate_root_texts(self, revs):
241
 
        """This will be called by __fetch between fetching weave texts and
242
 
        fetching the inventory weave.
243
 
 
244
 
        Subclasses should override this if they need to generate root texts
245
 
        after fetching weave texts.
246
 
        """
247
 
        pass
248
 
 
249
 
 
250
 
class GenericRepoFetcher(RepoFetcher):
251
 
    """This is a generic repo to repo fetcher.
252
 
 
253
 
    This makes minimal assumptions about repo layout and contents.
254
 
    It triggers a reconciliation after fetching to ensure integrity.
255
 
    """
256
 
 
257
 
    def _fetch_revision_texts(self, revs, pb):
258
 
        """Fetch revision object texts"""
259
 
        to_txn = self.to_transaction = self.to_repository.get_transaction()
260
 
        count = 0
261
 
        total = len(revs)
262
 
        to_store = self.to_repository._revision_store
263
 
        for rev in revs:
264
 
            pb.update('copying revisions', count, total)
265
 
            try:
266
 
                sig_text = self.from_repository.get_signature_text(rev)
267
 
                to_store.add_revision_signature_text(rev, sig_text, to_txn)
268
 
            except errors.NoSuchRevision:
269
 
                # not signed.
270
 
                pass
271
 
            to_store.add_revision(self.from_repository.get_revision(rev),
272
 
                                  to_txn)
273
 
            count += 1
274
 
        # fixup inventory if needed: 
275
 
        # this is expensive because we have no inverse index to current ghosts.
276
 
        # but on local disk its a few seconds and sftp push is already insane.
277
 
        # so we just-do-it.
278
 
        # FIXME: repository should inform if this is needed.
279
 
        self.to_repository.reconcile()
280
 
    
281
 
 
282
 
class KnitRepoFetcher(RepoFetcher):
283
 
    """This is a knit format repository specific fetcher.
284
 
 
285
 
    This differs from the GenericRepoFetcher by not doing a 
286
 
    reconciliation after copying, and using knit joining to
287
 
    copy revision texts.
288
 
    """
289
 
 
290
 
    def _fetch_revision_texts(self, revs, pb):
291
 
        # may need to be a InterRevisionStore call here.
292
 
        from_transaction = self.from_repository.get_transaction()
293
 
        to_transaction = self.to_repository.get_transaction()
294
 
        to_sf = self.to_repository._revision_store.get_signature_file(
295
 
            to_transaction)
296
 
        from_sf = self.from_repository._revision_store.get_signature_file(
297
 
            from_transaction)
298
 
        to_sf.join(from_sf, version_ids=revs, ignore_missing=True)
299
 
        to_rf = self.to_repository._revision_store.get_revision_file(
300
 
            to_transaction)
301
 
        from_rf = self.from_repository._revision_store.get_revision_file(
302
 
            from_transaction)
303
 
        to_rf.join(from_rf, version_ids=revs)
 
170
        return self.to_repository.search_missing_revision_ids(
 
171
            self.from_repository, self._last_revision,
 
172
            find_ghosts=self.find_ghosts)
 
173
 
 
174
    def _parent_inventories(self, revision_ids):
 
175
        # Find all the parent revisions referenced by the stream, but
 
176
        # not present in the stream, and make sure we send their
 
177
        # inventories.
 
178
        parent_maps = self.to_repository.get_parent_map(revision_ids)
 
179
        parents = set()
 
180
        map(parents.update, parent_maps.itervalues())
 
181
        parents.discard(NULL_REVISION)
 
182
        parents.difference_update(revision_ids)
 
183
        missing_keys = set(('inventories', rev_id) for rev_id in parents)
 
184
        return missing_keys
304
185
 
305
186
 
306
187
class Inter1and2Helper(object):
307
188
    """Helper for operations that convert data from model 1 and 2
308
 
    
 
189
 
309
190
    This is for use by fetchers and converters.
310
191
    """
311
192
 
312
 
    def __init__(self, source, target):
 
193
    def __init__(self, source):
313
194
        """Constructor.
314
195
 
315
196
        :param source: The repository data comes from
316
 
        :param target: The repository data goes to
317
197
        """
318
198
        self.source = source
319
 
        self.target = target
320
199
 
321
200
    def iter_rev_trees(self, revs):
322
201
        """Iterate through RevisionTrees efficiently.
328
207
 
329
208
        :param revs: A list of revision ids
330
209
        """
 
210
        # In case that revs is not a list.
 
211
        revs = list(revs)
331
212
        while revs:
332
213
            for tree in self.source.revision_trees(revs[:100]):
333
214
                if tree.inventory.revision_id is None:
335
216
                yield tree
336
217
            revs = revs[100:]
337
218
 
 
219
    def _find_root_ids(self, revs, parent_map, graph):
 
220
        revision_root = {}
 
221
        for tree in self.iter_rev_trees(revs):
 
222
            revision_id = tree.inventory.root.revision
 
223
            root_id = tree.get_root_id()
 
224
            revision_root[revision_id] = root_id
 
225
        # Find out which parents we don't already know root ids for
 
226
        parents = set()
 
227
        for revision_parents in parent_map.itervalues():
 
228
            parents.update(revision_parents)
 
229
        parents.difference_update(revision_root.keys() + [NULL_REVISION])
 
230
        # Limit to revisions present in the versionedfile
 
231
        parents = graph.get_parent_map(parents).keys()
 
232
        for tree in self.iter_rev_trees(parents):
 
233
            root_id = tree.get_root_id()
 
234
            revision_root[tree.get_revision_id()] = root_id
 
235
        return revision_root
 
236
 
338
237
    def generate_root_texts(self, revs):
339
238
        """Generate VersionedFiles for all root ids.
340
 
        
 
239
 
341
240
        :param revs: the revisions to include
342
241
        """
343
 
        inventory_weave = self.source.get_inventory_weave()
344
 
        parent_texts = {}
345
 
        versionedfile = {}
346
 
        to_store = self.target.weave_store
347
 
        for tree in self.iter_rev_trees(revs):
348
 
            revision_id = tree.inventory.root.revision
349
 
            root_id = tree.inventory.root.file_id
350
 
            parents = inventory_weave.get_parents(revision_id)
351
 
            if root_id not in versionedfile:
352
 
                versionedfile[root_id] = to_store.get_weave_or_empty(root_id, 
353
 
                    self.target.get_transaction())
354
 
            parent_texts[root_id] = versionedfile[root_id].add_lines(
355
 
                revision_id, parents, [], parent_texts)
356
 
 
357
 
    def regenerate_inventory(self, revs):
358
 
        """Generate a new inventory versionedfile in target, convertin data.
359
 
        
360
 
        The inventory is retrieved from the source, (deserializing it), and
361
 
        stored in the target (reserializing it in a different format).
362
 
        :param revs: The revisions to include
363
 
        """
364
 
        inventory_weave = self.source.get_inventory_weave()
365
 
        for tree in self.iter_rev_trees(revs):
366
 
            parents = inventory_weave.get_parents(tree.get_revision_id())
367
 
            self.target.add_inventory(tree.get_revision_id(), tree.inventory,
368
 
                                      parents)
369
 
 
370
 
 
371
 
class Model1toKnit2Fetcher(GenericRepoFetcher):
372
 
    """Fetch from a Model1 repository into a Knit2 repository
373
 
    """
374
 
    def __init__(self, to_repository, from_repository, last_revision=None, 
375
 
                 pb=None):
376
 
        self.helper = Inter1and2Helper(from_repository, to_repository)
377
 
        GenericRepoFetcher.__init__(self, to_repository, from_repository,
378
 
                                    last_revision, pb)
379
 
 
380
 
    def _generate_root_texts(self, revs):
381
 
        self.helper.generate_root_texts(revs)
382
 
 
383
 
    def _fetch_inventory_weave(self, revs, pb):
384
 
        self.helper.regenerate_inventory(revs)
385
 
 
386
 
 
387
 
class Knit1to2Fetcher(KnitRepoFetcher):
388
 
    """Fetch from a Knit1 repository into a Knit2 repository"""
389
 
 
390
 
    def __init__(self, to_repository, from_repository, last_revision=None, 
391
 
                 pb=None):
392
 
        self.helper = Inter1and2Helper(from_repository, to_repository)
393
 
        KnitRepoFetcher.__init__(self, to_repository, from_repository,
394
 
                                 last_revision, pb)
395
 
 
396
 
    def _generate_root_texts(self, revs):
397
 
        self.helper.generate_root_texts(revs)
398
 
 
399
 
    def _fetch_inventory_weave(self, revs, pb):
400
 
        self.helper.regenerate_inventory(revs)
 
242
        graph = self.source.get_graph()
 
243
        parent_map = graph.get_parent_map(revs)
 
244
        rev_order = tsort.topo_sort(parent_map)
 
245
        rev_id_to_root_id = self._find_root_ids(revs, parent_map, graph)
 
246
        root_id_order = [(rev_id_to_root_id[rev_id], rev_id) for rev_id in
 
247
            rev_order]
 
248
        # Guaranteed stable, this groups all the file id operations together
 
249
        # retaining topological order within the revisions of a file id.
 
250
        # File id splits and joins would invalidate this, but they don't exist
 
251
        # yet, and are unlikely to in non-rich-root environments anyway.
 
252
        root_id_order.sort(key=operator.itemgetter(0))
 
253
        # Create a record stream containing the roots to create.
 
254
        from bzrlib.graph import FrozenHeadsCache
 
255
        graph = FrozenHeadsCache(graph)
 
256
        new_roots_stream = _new_root_data_stream(
 
257
            root_id_order, rev_id_to_root_id, parent_map, self.source, graph)
 
258
        return [('texts', new_roots_stream)]
 
259
 
 
260
 
 
261
def _new_root_data_stream(
 
262
    root_keys_to_create, rev_id_to_root_id_map, parent_map, repo, graph=None):
 
263
    """Generate a texts substream of synthesised root entries.
 
264
 
 
265
    Used in fetches that do rich-root upgrades.
 
266
    
 
267
    :param root_keys_to_create: iterable of (root_id, rev_id) pairs describing
 
268
        the root entries to create.
 
269
    :param rev_id_to_root_id_map: dict of known rev_id -> root_id mappings for
 
270
        calculating the parents.  If a parent rev_id is not found here then it
 
271
        will be recalculated.
 
272
    :param parent_map: a parent map for all the revisions in
 
273
        root_keys_to_create.
 
274
    :param graph: a graph to use instead of repo.get_graph().
 
275
    """
 
276
    for root_key in root_keys_to_create:
 
277
        root_id, rev_id = root_key
 
278
        parent_keys = _parent_keys_for_root_version(
 
279
            root_id, rev_id, rev_id_to_root_id_map, parent_map, repo, graph)
 
280
        yield versionedfile.FulltextContentFactory(
 
281
            root_key, parent_keys, None, '')
 
282
 
 
283
 
 
284
def _parent_keys_for_root_version(
 
285
    root_id, rev_id, rev_id_to_root_id_map, parent_map, repo, graph=None):
 
286
    """Get the parent keys for a given root id.
 
287
    
 
288
    A helper function for _new_root_data_stream.
 
289
    """
 
290
    # Include direct parents of the revision, but only if they used the same
 
291
    # root_id and are heads.
 
292
    rev_parents = parent_map[rev_id]
 
293
    parent_ids = []
 
294
    for parent_id in rev_parents:
 
295
        if parent_id == NULL_REVISION:
 
296
            continue
 
297
        if parent_id not in rev_id_to_root_id_map:
 
298
            # We probably didn't read this revision, go spend the extra effort
 
299
            # to actually check
 
300
            try:
 
301
                tree = repo.revision_tree(parent_id)
 
302
            except errors.NoSuchRevision:
 
303
                # Ghost, fill out rev_id_to_root_id in case we encounter this
 
304
                # again.
 
305
                # But set parent_root_id to None since we don't really know
 
306
                parent_root_id = None
 
307
            else:
 
308
                parent_root_id = tree.get_root_id()
 
309
            rev_id_to_root_id_map[parent_id] = None
 
310
            # XXX: why not:
 
311
            #   rev_id_to_root_id_map[parent_id] = parent_root_id
 
312
            # memory consumption maybe?
 
313
        else:
 
314
            parent_root_id = rev_id_to_root_id_map[parent_id]
 
315
        if root_id == parent_root_id:
 
316
            # With stacking we _might_ want to refer to a non-local revision,
 
317
            # but this code path only applies when we have the full content
 
318
            # available, so ghosts really are ghosts, not just the edge of
 
319
            # local data.
 
320
            parent_ids.append(parent_id)
 
321
        else:
 
322
            # root_id may be in the parent anyway.
 
323
            try:
 
324
                tree = repo.revision_tree(parent_id)
 
325
            except errors.NoSuchRevision:
 
326
                # ghost, can't refer to it.
 
327
                pass
 
328
            else:
 
329
                try:
 
330
                    parent_ids.append(tree.inventory[root_id].revision)
 
331
                except errors.NoSuchId:
 
332
                    # not in the tree
 
333
                    pass
 
334
    # Drop non-head parents
 
335
    if graph is None:
 
336
        graph = repo.get_graph()
 
337
    heads = graph.heads(parent_ids)
 
338
    selected_ids = []
 
339
    for parent_id in parent_ids:
 
340
        if parent_id in heads and parent_id not in selected_ids:
 
341
            selected_ids.append(parent_id)
 
342
    parent_keys = [(root_id, parent_id) for parent_id in selected_ids]
 
343
    return parent_keys