/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/fetch.py

  • Committer: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

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
 
from bzrlib.progress import ProgressPhase
38
 
from bzrlib.revision import is_null, NULL_REVISION
39
 
from bzrlib.symbol_versioning import (deprecated_function,
40
 
        deprecated_method,
41
 
        )
 
36
from bzrlib import (
 
37
    errors,
 
38
    ui,
 
39
    )
 
40
from bzrlib.revision import NULL_REVISION
42
41
from bzrlib.trace import mutter
43
 
import bzrlib.ui
44
 
 
45
 
from bzrlib.lazy_import import lazy_import
46
 
 
47
 
# TODO: Avoid repeatedly opening weaves so many times.
48
 
 
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.
51
 
 
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.
54
 
 
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
58
 
#   parents.
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
63
42
 
64
43
 
65
44
class RepoFetcher(object):
66
45
    """Pull revisions and texts from one repository to another.
67
46
 
68
 
    last_revision
69
 
        if set, try to limit to the data this revision references.
70
 
 
71
 
    after running:
72
 
    count_copied -- number of revisions copied
73
 
 
74
47
    This should not be used directly, it's essential a object to encapsulate
75
48
    the logic in InterRepository.fetch().
76
49
    """
77
50
 
78
 
    def __init__(self, to_repository, from_repository, last_revision=None, pb=None,
79
 
        find_ghosts=True):
 
51
    def __init__(self, to_repository, from_repository, last_revision=None,
 
52
        find_ghosts=True, fetch_spec=None):
80
53
        """Create a repo fetcher.
81
54
 
 
55
        :param last_revision: If set, try to limit to the data this revision
 
56
            references.
82
57
        :param find_ghosts: If True search the entire history for ghosts.
83
58
        """
84
 
        # result variables.
85
 
        self.failed_revisions = []
86
 
        self.count_copied = 0
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))
 
59
        # repository.fetch has the responsibility for short-circuiting
 
60
        # attempts to copy between a repository and itself.
92
61
        self.to_repository = to_repository
93
62
        self.from_repository = from_repository
 
63
        self.sink = to_repository._get_sink()
94
64
        # must not mutate self._last_revision as its potentially a shared instance
95
65
        self._last_revision = last_revision
 
66
        self._fetch_spec = fetch_spec
96
67
        self.find_ghosts = find_ghosts
97
 
        if pb is None:
98
 
            self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
99
 
            self.nested_pb = self.pb
100
 
        else:
101
 
            self.pb = pb
102
 
            self.nested_pb = None
103
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)
104
72
        try:
105
 
            self.to_repository.lock_write()
106
 
            try:
107
 
                self.to_repository.start_write_group()
108
 
                try:
109
 
                    self.__fetch()
110
 
                except:
111
 
                    self.to_repository.abort_write_group()
112
 
                    raise
113
 
                else:
114
 
                    self.to_repository.commit_write_group()
115
 
            finally:
116
 
                if self.nested_pb is not None:
117
 
                    self.nested_pb.finished()
118
 
                self.to_repository.unlock()
 
73
            self.__fetch()
119
74
        finally:
120
75
            self.from_repository.unlock()
121
76
 
122
77
    def __fetch(self):
123
78
        """Primary worker function.
124
79
 
125
 
        This initialises all the needed variables, and then fetches the 
 
80
        This initialises all the needed variables, and then fetches the
126
81
        requested revisions, finally clearing the progress bar.
127
82
        """
128
 
        self.to_weaves = self.to_repository.weave_store
129
 
        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
130
89
        self.count_total = 0
131
90
        self.file_ids_names = {}
132
 
        pp = ProgressPhase('Transferring', 4, self.pb)
 
91
        pb = ui.ui_factory.nested_progress_bar()
 
92
        pb.show_pct = pb.show_count = False
133
93
        try:
134
 
            pp.next_phase()
 
94
            pb.update("Finding revisions", 0, 2)
135
95
            search = self._revids_to_fetch()
136
96
            if search is None:
137
97
                return
138
 
            if getattr(self, '_fetch_everything_for_search', None) is not None:
139
 
                self._fetch_everything_for_search(search, pp)
140
 
            else:
141
 
                # backward compatibility
142
 
                self._fetch_everything_for_revisions(search.get_keys, pp)
 
98
            pb.update("Fetching revisions", 1, 2)
 
99
            self._fetch_everything_for_search(search)
143
100
        finally:
144
 
            self.pb.clear()
 
101
            pb.finished()
145
102
 
146
 
    def _fetch_everything_for_search(self, search, pp):
 
103
    def _fetch_everything_for_search(self, search):
147
104
        """Fetch all data for the given set of revisions."""
148
105
        # The first phase is "file".  We pass the progress bar for it directly
149
106
        # into item_keys_introduced_by, which has more information about how
153
110
        # item_keys_introduced_by should have a richer API than it does at the
154
111
        # moment, so that it can feed the progress information back to this
155
112
        # function?
156
 
        phase = 'file'
157
 
        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()
158
119
        try:
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:
163
 
                    phase = knit_kind
164
 
                    # Make a new progress bar for this phase
165
 
                    pb.finished()
166
 
                    pp.next_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":
171
 
                    # XXX:
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.
182
 
                    pass
183
 
                elif knit_kind == "revisions":
184
 
                    self._fetch_revision_texts(revs, pb)
185
 
                else:
186
 
                    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()
187
147
        finally:
188
 
            if pb is not None:
189
 
                pb.finished()
190
 
        self.count_copied += len(revs)
191
 
        
 
148
            pb.finished()
 
149
 
192
150
    def _revids_to_fetch(self):
193
151
        """Determines the exact revisions needed from self.from_repository to
194
152
        install self._last_revision in self.to_repository.
195
153
 
196
154
        If no revisions need to be fetched, then this just returns None.
197
155
        """
 
156
        if self._fetch_spec is not None:
 
157
            return self._fetch_spec
198
158
        mutter('fetch up to rev {%s}', self._last_revision)
199
159
        if self._last_revision is NULL_REVISION:
200
160
            # explicit limit of no revisions needed
201
161
            return None
202
 
        if (self._last_revision is not None and
203
 
            self.to_repository.has_revision(self._last_revision)):
204
 
            return None
205
 
        try:
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])
211
 
 
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
224
 
        # end anyhow.
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()
229
 
 
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()
234
 
        try:
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
243
 
            # corrupt.
244
 
            to_weave.join(from_weave, pb=child_pb, msg='merge inventory',
245
 
                          version_ids=revs)
246
 
            from_weave.clear_cache()
247
 
        finally:
248
 
            child_pb.finished()
249
 
 
250
 
    def _generate_root_texts(self, revs):
251
 
        """This will be called by __fetch between fetching weave texts and
252
 
        fetching the inventory weave.
253
 
 
254
 
        Subclasses should override this if they need to generate root texts
255
 
        after fetching weave texts.
256
 
        """
257
 
        pass
258
 
 
259
 
 
260
 
class GenericRepoFetcher(RepoFetcher):
261
 
    """This is a generic repo to repo fetcher.
262
 
 
263
 
    This makes minimal assumptions about repo layout and contents.
264
 
    It triggers a reconciliation after fetching to ensure integrity.
265
 
    """
266
 
 
267
 
    def _fetch_revision_texts(self, revs, pb):
268
 
        """Fetch revision object texts"""
269
 
        to_txn = self.to_transaction = self.to_repository.get_transaction()
270
 
        count = 0
271
 
        total = len(revs)
272
 
        to_store = self.to_repository._revision_store
273
 
        for rev in revs:
274
 
            pb.update('copying revisions', count, total)
275
 
            try:
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:
279
 
                # not signed.
280
 
                pass
281
 
            to_store.add_revision(self.from_repository.get_revision(rev),
282
 
                                  to_txn)
283
 
            count += 1
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.
287
 
        # so we just-do-it.
288
 
        # FIXME: repository should inform if this is needed.
289
 
        self.to_repository.reconcile()
290
 
    
291
 
 
292
 
class KnitRepoFetcher(RepoFetcher):
293
 
    """This is a knit format repository specific fetcher.
294
 
 
295
 
    This differs from the GenericRepoFetcher by not doing a 
296
 
    reconciliation after copying, and using knit joining to
297
 
    copy revision texts.
298
 
    """
299
 
 
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(
305
 
            to_transaction)
306
 
        from_sf = self.from_repository._revision_store.get_signature_file(
307
 
            from_transaction)
308
 
        to_sf.join(from_sf, version_ids=revs, ignore_missing=True)
309
 
        to_rf = self.to_repository._revision_store.get_revision_file(
310
 
            to_transaction)
311
 
        from_rf = self.from_repository._revision_store.get_revision_file(
312
 
            from_transaction)
313
 
        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
314
177
 
315
178
 
316
179
class Inter1and2Helper(object):
317
180
    """Helper for operations that convert data from model 1 and 2
318
 
    
 
181
 
319
182
    This is for use by fetchers and converters.
320
183
    """
321
184
 
322
 
    def __init__(self, source, target):
 
185
    def __init__(self, source):
323
186
        """Constructor.
324
187
 
325
188
        :param source: The repository data comes from
326
 
        :param target: The repository data goes to
327
189
        """
328
190
        self.source = source
329
 
        self.target = target
330
191
 
331
192
    def iter_rev_trees(self, revs):
332
193
        """Iterate through RevisionTrees efficiently.
347
208
                yield tree
348
209
            revs = revs[100:]
349
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
 
350
229
    def generate_root_texts(self, revs):
351
230
        """Generate VersionedFiles for all root ids.
352
 
        
 
231
 
353
232
        :param revs: the revisions to include
354
233
        """
355
 
        inventory_weave = self.source.get_inventory_weave()
356
 
        parent_texts = {}
357
 
        versionedfile = {}
358
 
        to_store = self.target.weave_store
359
 
        parent_map = self.source.get_graph().get_parent_map(revs)
360
 
        for tree in self.iter_rev_trees(revs):
361
 
            revision_id = tree.inventory.root.revision
362
 
            root_id = tree.get_root_id()
363
 
            parents = parent_map[revision_id]
364
 
            if parents[0] == NULL_REVISION:
365
 
                parents = ()
366
 
            if root_id not in versionedfile:
367
 
                versionedfile[root_id] = to_store.get_weave_or_empty(root_id,
368
 
                    self.target.get_transaction())
369
 
            _, _, parent_texts[root_id] = versionedfile[root_id].add_lines(
370
 
                revision_id, parents, [], parent_texts)
371
 
 
372
 
    def regenerate_inventory(self, revs):
373
 
        """Generate a new inventory versionedfile in target, convertin data.
374
 
        
375
 
        The inventory is retrieved from the source, (deserializing it), and
376
 
        stored in the target (reserializing it in a different format).
377
 
        :param revs: The revisions to include
378
 
        """
379
 
        for tree in self.iter_rev_trees(revs):
380
 
            parents = tree.get_parent_ids()
381
 
            self.target.add_inventory(tree.get_revision_id(), tree.inventory,
382
 
                                      parents)
383
 
 
384
 
 
385
 
class Model1toKnit2Fetcher(GenericRepoFetcher):
386
 
    """Fetch from a Model1 repository into a Knit2 repository
387
 
    """
388
 
    def __init__(self, to_repository, from_repository, last_revision=None,
389
 
                 pb=None, find_ghosts=True):
390
 
        self.helper = Inter1and2Helper(from_repository, to_repository)
391
 
        GenericRepoFetcher.__init__(self, to_repository, from_repository,
392
 
            last_revision, pb, find_ghosts)
393
 
 
394
 
    def _generate_root_texts(self, revs):
395
 
        self.helper.generate_root_texts(revs)
396
 
 
397
 
    def _fetch_inventory_weave(self, revs, pb):
398
 
        self.helper.regenerate_inventory(revs)
399
 
 
400
 
 
401
 
class Knit1to2Fetcher(KnitRepoFetcher):
402
 
    """Fetch from a Knit1 repository into a Knit2 repository"""
403
 
 
404
 
    def __init__(self, to_repository, from_repository, last_revision=None, 
405
 
                 pb=None, find_ghosts=True):
406
 
        self.helper = Inter1and2Helper(from_repository, to_repository)
407
 
        KnitRepoFetcher.__init__(self, to_repository, from_repository,
408
 
            last_revision, pb, find_ghosts)
409
 
 
410
 
    def _generate_root_texts(self, revs):
411
 
        self.helper.generate_root_texts(revs)
412
 
 
413
 
    def _fetch_inventory_weave(self, revs, pb):
414
 
        self.helper.regenerate_inventory(revs)
415
 
 
416
 
 
417
 
class RemoteToOtherFetcher(GenericRepoFetcher):
418
 
 
419
 
    def _fetch_everything_for_search(self, search, pp):
420
 
        data_stream = self.from_repository.get_data_stream_for_search(search)
421
 
        self.to_repository.insert_data_stream(data_stream)
422
 
 
423
 
 
 
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