~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/fetch.py

  • Committer: Robert Collins
  • Date: 2010-05-06 23:54:05 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506235405-wii4elupfhzl3jvy
Add __str__ to the new helper classes.

Show diffs side-by-side

added added

removed removed

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