/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

Only chown() the .bzr.log when creating it, fixing NEWS entry to put it under 2.2b3

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/fetch.py
1
 
# Copyright (C) 2005, 2006 by 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
 
                           )
 
36
from bzrlib import (
 
37
    errors,
 
38
    symbol_versioning,
 
39
    ui,
 
40
    )
 
41
from bzrlib.revision import NULL_REVISION
38
42
from bzrlib.trace import mutter
39
 
from bzrlib.progress import ProgressPhase
40
 
from bzrlib.revision import NULL_REVISION
41
 
from bzrlib.symbol_versioning import (deprecated_function,
42
 
        deprecated_method,
43
 
        zero_eight,
44
 
        )
45
 
 
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
 
 
64
 
 
65
 
@deprecated_function(zero_eight)
66
 
def greedy_fetch(to_branch, from_branch, revision=None, pb=None):
67
 
    """Legacy API, please see branch.fetch(from_branch, last_revision, pb)."""
68
 
    f = Fetcher(to_branch, from_branch, revision, pb)
69
 
    return f.count_copied, f.failed_revisions
70
 
 
71
 
fetch = greedy_fetch
72
43
 
73
44
 
74
45
class RepoFetcher(object):
75
46
    """Pull revisions and texts from one repository to another.
76
47
 
77
 
    last_revision
78
 
        if set, try to limit to the data this revision references.
79
 
 
80
 
    after running:
81
 
    count_copied -- number of revisions copied
82
 
 
83
 
    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
84
49
    the logic in InterRepository.fetch().
85
50
    """
86
 
    def __init__(self, to_repository, from_repository, last_revision=None, pb=None):
87
 
        # result variables.
88
 
        self.failed_revisions = []
89
 
        self.count_copied = 0
90
 
        if to_repository.control_files._transport.base == from_repository.control_files._transport.base:
91
 
            # check that last_revision is in 'from' and then return a no-operation.
92
 
            if last_revision not in (None, NULL_REVISION):
93
 
                from_repository.get_revision(last_revision)
94
 
            return
 
51
 
 
52
    def __init__(self, to_repository, from_repository, last_revision=None,
 
53
        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
        """
 
60
        # repository.fetch has the responsibility for short-circuiting
 
61
        # attempts to copy between a repository and itself.
95
62
        self.to_repository = to_repository
96
63
        self.from_repository = from_repository
 
64
        self.sink = to_repository._get_sink()
97
65
        # must not mutate self._last_revision as its potentially a shared instance
98
66
        self._last_revision = last_revision
99
 
        if pb is None:
100
 
            self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
101
 
            self.nested_pb = self.pb
102
 
        else:
103
 
            self.pb = pb
104
 
            self.nested_pb = None
 
67
        self._fetch_spec = fetch_spec
 
68
        self.find_ghosts = find_ghosts
105
69
        self.from_repository.lock_read()
 
70
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
71
               self.from_repository, self.from_repository._format,
 
72
               self.to_repository, self.to_repository._format)
106
73
        try:
107
 
            self.to_repository.lock_write()
108
 
            try:
109
 
                self.__fetch()
110
 
            finally:
111
 
                if self.nested_pb is not None:
112
 
                    self.nested_pb.finished()
113
 
                self.to_repository.unlock()
 
74
            self.__fetch()
114
75
        finally:
115
76
            self.from_repository.unlock()
116
77
 
117
78
    def __fetch(self):
118
79
        """Primary worker function.
119
80
 
120
 
        This initialises all the needed variables, and then fetches the 
 
81
        This initialises all the needed variables, and then fetches the
121
82
        requested revisions, finally clearing the progress bar.
122
83
        """
123
 
        self.to_weaves = self.to_repository.weave_store
124
 
        self.to_control = self.to_repository.control_weaves
125
 
        self.from_weaves = self.from_repository.weave_store
126
 
        self.from_control = self.from_repository.control_weaves
 
84
        # Roughly this is what we're aiming for fetch to become:
 
85
        #
 
86
        # missing = self.sink.insert_stream(self.source.get_stream(search))
 
87
        # if missing:
 
88
        #     missing = self.sink.insert_stream(self.source.get_items(missing))
 
89
        # assert not missing
127
90
        self.count_total = 0
128
91
        self.file_ids_names = {}
129
 
        pp = ProgressPhase('Fetch phase', 4, self.pb)
130
 
        try:
131
 
            pp.next_phase()
132
 
            revs = self._revids_to_fetch()
133
 
            # something to do ?
134
 
            if revs:
135
 
                pp.next_phase()
136
 
                self._fetch_weave_texts(revs)
137
 
                pp.next_phase()
138
 
                self._fetch_inventory_weave(revs)
139
 
                pp.next_phase()
140
 
                self._fetch_revision_texts(revs)
141
 
                self.count_copied += len(revs)
142
 
        finally:
143
 
            self.pb.clear()
 
92
        pb = ui.ui_factory.nested_progress_bar()
 
93
        pb.show_pct = pb.show_count = False
 
94
        try:
 
95
            pb.update("Finding revisions", 0, 2)
 
96
            search = self._revids_to_fetch()
 
97
            if search is None:
 
98
                return
 
99
            pb.update("Fetching revisions", 1, 2)
 
100
            self._fetch_everything_for_search(search)
 
101
        finally:
 
102
            pb.finished()
 
103
 
 
104
    def _fetch_everything_for_search(self, search):
 
105
        """Fetch all data for the given set of revisions."""
 
106
        # The first phase is "file".  We pass the progress bar for it directly
 
107
        # into item_keys_introduced_by, which has more information about how
 
108
        # that phase is progressing than we do.  Progress updates for the other
 
109
        # phases are taken care of in this function.
 
110
        # XXX: there should be a clear owner of the progress reporting.  Perhaps
 
111
        # item_keys_introduced_by should have a richer API than it does at the
 
112
        # moment, so that it can feed the progress information back to this
 
113
        # function?
 
114
        if (self.from_repository._format.rich_root_data and
 
115
            not self.to_repository._format.rich_root_data):
 
116
            raise errors.IncompatibleRepositories(
 
117
                self.from_repository, self.to_repository,
 
118
                "different rich-root support")
 
119
        pb = ui.ui_factory.nested_progress_bar()
 
120
        try:
 
121
            pb.update("Get stream source")
 
122
            source = self.from_repository._get_source(
 
123
                self.to_repository._format)
 
124
            stream = source.get_stream(search)
 
125
            from_format = self.from_repository._format
 
126
            pb.update("Inserting stream")
 
127
            resume_tokens, missing_keys = self.sink.insert_stream(
 
128
                stream, from_format, [])
 
129
            if self.to_repository._fallback_repositories:
 
130
                missing_keys.update(
 
131
                    self._parent_inventories(search.get_keys()))
 
132
            if missing_keys:
 
133
                pb.update("Missing keys")
 
134
                stream = source.get_stream_for_missing_keys(missing_keys)
 
135
                pb.update("Inserting missing keys")
 
136
                resume_tokens, missing_keys = self.sink.insert_stream(
 
137
                    stream, from_format, resume_tokens)
 
138
            if missing_keys:
 
139
                raise AssertionError(
 
140
                    "second push failed to complete a fetch %r." % (
 
141
                        missing_keys,))
 
142
            if resume_tokens:
 
143
                raise AssertionError(
 
144
                    "second push failed to commit the fetch %r." % (
 
145
                        resume_tokens,))
 
146
            pb.update("Finishing stream")
 
147
            self.sink.finished()
 
148
        finally:
 
149
            pb.finished()
144
150
 
145
151
    def _revids_to_fetch(self):
 
152
        """Determines the exact revisions needed from self.from_repository to
 
153
        install self._last_revision in self.to_repository.
 
154
 
 
155
        If no revisions need to be fetched, then this just returns None.
 
156
        """
 
157
        if self._fetch_spec is not None:
 
158
            return self._fetch_spec
146
159
        mutter('fetch up to rev {%s}', self._last_revision)
147
160
        if self._last_revision is NULL_REVISION:
148
161
            # explicit limit of no revisions needed
149
162
            return None
150
 
        if (self._last_revision is not None and
151
 
            self.to_repository.has_revision(self._last_revision)):
152
 
            return None
153
 
            
154
 
        try:
155
 
            return self.to_repository.missing_revision_ids(self.from_repository,
156
 
                                                           self._last_revision)
157
 
        except errors.NoSuchRevision:
158
 
            raise InstallFailed([self._last_revision])
159
 
 
160
 
    def _fetch_weave_texts(self, revs):
161
 
        texts_pb = bzrlib.ui.ui_factory.nested_progress_bar()
162
 
        try:
163
 
            # fileids_altered_by_revision_ids requires reading the inventory
164
 
            # weave, we will need to read the inventory weave again when
165
 
            # all this is done, so enable caching for that specific weave
166
 
            inv_w = self.from_repository.get_inventory_weave()
167
 
            inv_w.enable_cache()
168
 
            file_ids = self.from_repository.fileids_altered_by_revision_ids(revs)
169
 
            count = 0
170
 
            num_file_ids = len(file_ids)
171
 
            for file_id, required_versions in file_ids.items():
172
 
                texts_pb.update("fetch texts", count, num_file_ids)
173
 
                count +=1
174
 
                to_weave = self.to_weaves.get_weave_or_empty(file_id,
175
 
                    self.to_repository.get_transaction())
176
 
                from_weave = self.from_weaves.get_weave(file_id,
177
 
                    self.from_repository.get_transaction())
178
 
                # we fetch all the texts, because texts do
179
 
                # not reference anything, and its cheap enough
180
 
                to_weave.join(from_weave, version_ids=required_versions)
181
 
                # we don't need *all* of this data anymore, but we dont know
182
 
                # what we do. This cache clearing will result in a new read 
183
 
                # of the knit data when we do the checkout, but probably we
184
 
                # want to emit the needed data on the fly rather than at the
185
 
                # end anyhow.
186
 
                # the from weave should know not to cache data being joined,
187
 
                # but its ok to ask it to clear.
188
 
                from_weave.clear_cache()
189
 
                to_weave.clear_cache()
190
 
        finally:
191
 
            texts_pb.finished()
192
 
 
193
 
    def _fetch_inventory_weave(self, revs):
194
 
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
195
 
        try:
196
 
            pb.update("fetch inventory", 0, 2)
197
 
            to_weave = self.to_control.get_weave('inventory',
198
 
                    self.to_repository.get_transaction())
199
 
    
200
 
            child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
201
 
            try:
202
 
                # just merge, this is optimisable and its means we don't
203
 
                # copy unreferenced data such as not-needed inventories.
204
 
                pb.update("fetch inventory", 1, 3)
205
 
                from_weave = self.from_repository.get_inventory_weave()
206
 
                pb.update("fetch inventory", 2, 3)
207
 
                # we fetch only the referenced inventories because we do not
208
 
                # know for unselected inventories whether all their required
209
 
                # texts are present in the other repository - it could be
210
 
                # corrupt.
211
 
                to_weave.join(from_weave, pb=child_pb, msg='merge inventory',
212
 
                              version_ids=revs)
213
 
                from_weave.clear_cache()
214
 
            finally:
215
 
                child_pb.finished()
216
 
        finally:
217
 
            pb.finished()
218
 
 
219
 
 
220
 
class GenericRepoFetcher(RepoFetcher):
221
 
    """This is a generic repo to repo fetcher.
222
 
 
223
 
    This makes minimal assumptions about repo layout and contents.
224
 
    It triggers a reconciliation after fetching to ensure integrity.
225
 
    """
226
 
 
227
 
    def _fetch_revision_texts(self, revs):
228
 
        """Fetch revision object texts"""
229
 
        rev_pb = bzrlib.ui.ui_factory.nested_progress_bar()
230
 
        try:
231
 
            to_txn = self.to_transaction = self.to_repository.get_transaction()
232
 
            count = 0
233
 
            total = len(revs)
234
 
            to_store = self.to_repository._revision_store
235
 
            for rev in revs:
236
 
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
237
 
                try:
238
 
                    pb.update('copying revisions', count, total)
239
 
                    try:
240
 
                        sig_text = self.from_repository.get_signature_text(rev)
241
 
                        to_store.add_revision_signature_text(rev, sig_text, to_txn)
242
 
                    except errors.NoSuchRevision:
243
 
                        # not signed.
244
 
                        pass
245
 
                    to_store.add_revision(self.from_repository.get_revision(rev),
246
 
                                          to_txn)
247
 
                    count += 1
248
 
                finally:
249
 
                    pb.finished()
250
 
            # fixup inventory if needed: 
251
 
            # this is expensive because we have no inverse index to current ghosts.
252
 
            # but on local disk its a few seconds and sftp push is already insane.
253
 
            # so we just-do-it.
254
 
            # FIXME: repository should inform if this is needed.
255
 
            self.to_repository.reconcile()
256
 
        finally:
257
 
            rev_pb.finished()
258
 
    
259
 
 
260
 
class KnitRepoFetcher(RepoFetcher):
261
 
    """This is a knit format repository specific fetcher.
262
 
 
263
 
    This differs from the GenericRepoFetcher by not doing a 
264
 
    reconciliation after copying, and using knit joining to
265
 
    copy revision texts.
266
 
    """
267
 
 
268
 
    def _fetch_revision_texts(self, revs):
269
 
        # may need to be a InterRevisionStore call here.
270
 
        from_transaction = self.from_repository.get_transaction()
271
 
        to_transaction = self.to_repository.get_transaction()
272
 
        to_sf = self.to_repository._revision_store.get_signature_file(
273
 
            to_transaction)
274
 
        from_sf = self.from_repository._revision_store.get_signature_file(
275
 
            from_transaction)
276
 
        to_sf.join(from_sf, version_ids=revs, ignore_missing=True)
277
 
        to_rf = self.to_repository._revision_store.get_revision_file(
278
 
            to_transaction)
279
 
        from_rf = self.from_repository._revision_store.get_revision_file(
280
 
            from_transaction)
281
 
        to_rf.join(from_rf, version_ids=revs)
 
163
        return self.to_repository.search_missing_revision_ids(
 
164
            self.from_repository, self._last_revision,
 
165
            find_ghosts=self.find_ghosts)
 
166
 
 
167
    def _parent_inventories(self, revision_ids):
 
168
        # Find all the parent revisions referenced by the stream, but
 
169
        # not present in the stream, and make sure we send their
 
170
        # inventories.
 
171
        parent_maps = self.to_repository.get_parent_map(revision_ids)
 
172
        parents = set()
 
173
        map(parents.update, parent_maps.itervalues())
 
174
        parents.discard(NULL_REVISION)
 
175
        parents.difference_update(revision_ids)
 
176
        missing_keys = set(('inventories', rev_id) for rev_id in parents)
 
177
        return missing_keys
282
178
 
283
179
 
284
180
class Inter1and2Helper(object):
285
181
    """Helper for operations that convert data from model 1 and 2
286
 
    
 
182
 
287
183
    This is for use by fetchers and converters.
288
184
    """
289
185
 
290
 
    def __init__(self, source, target):
 
186
    def __init__(self, source):
291
187
        """Constructor.
292
188
 
293
189
        :param source: The repository data comes from
294
 
        :param target: The repository data goes to
295
190
        """
296
191
        self.source = source
297
 
        self.target = target
298
192
 
299
193
    def iter_rev_trees(self, revs):
300
194
        """Iterate through RevisionTrees efficiently.
306
200
 
307
201
        :param revs: A list of revision ids
308
202
        """
 
203
        # In case that revs is not a list.
 
204
        revs = list(revs)
309
205
        while revs:
310
206
            for tree in self.source.revision_trees(revs[:100]):
311
207
                if tree.inventory.revision_id is None:
313
209
                yield tree
314
210
            revs = revs[100:]
315
211
 
 
212
    def _find_root_ids(self, revs, parent_map, graph):
 
213
        revision_root = {}
 
214
        for tree in self.iter_rev_trees(revs):
 
215
            revision_id = tree.inventory.root.revision
 
216
            root_id = tree.get_root_id()
 
217
            revision_root[revision_id] = root_id
 
218
        # Find out which parents we don't already know root ids for
 
219
        parents = set()
 
220
        for revision_parents in parent_map.itervalues():
 
221
            parents.update(revision_parents)
 
222
        parents.difference_update(revision_root.keys() + [NULL_REVISION])
 
223
        # Limit to revisions present in the versionedfile
 
224
        parents = graph.get_parent_map(parents).keys()
 
225
        for tree in self.iter_rev_trees(parents):
 
226
            root_id = tree.get_root_id()
 
227
            revision_root[tree.get_revision_id()] = root_id
 
228
        return revision_root
 
229
 
316
230
    def generate_root_texts(self, revs):
317
231
        """Generate VersionedFiles for all root ids.
318
 
        
 
232
 
319
233
        :param revs: the revisions to include
320
234
        """
321
 
        inventory_weave = self.source.get_inventory_weave()
322
 
        parent_texts = {}
323
 
        versionedfile = {}
324
 
        to_store = self.target.weave_store
325
 
        for tree in self.iter_rev_trees(revs):
326
 
            revision_id = tree.inventory.root.revision
327
 
            root_id = tree.inventory.root.file_id
328
 
            parents = inventory_weave.get_parents(revision_id)
329
 
            if root_id not in versionedfile:
330
 
                versionedfile[root_id] = to_store.get_weave_or_empty(root_id, 
331
 
                    self.target.get_transaction())
332
 
            parent_texts[root_id] = versionedfile[root_id].add_lines(
333
 
                revision_id, parents, [], parent_texts)
334
 
 
335
 
    def regenerate_inventory(self, revs):
336
 
        """Generate a new inventory versionedfile in target, convertin data.
337
 
        
338
 
        The inventory is retrieved from the source, (deserializing it), and
339
 
        stored in the target (reserializing it in a different format).
340
 
        :param revs: The revisions to include
341
 
        """
342
 
        inventory_weave = self.source.get_inventory_weave()
343
 
        for tree in self.iter_rev_trees(revs):
344
 
            parents = inventory_weave.get_parents(tree.get_revision_id())
345
 
            self.target.add_inventory(tree.get_revision_id(), tree.inventory,
346
 
                                      parents)
347
 
 
348
 
 
349
 
class Model1toKnit2Fetcher(GenericRepoFetcher):
350
 
    """Fetch from a Model1 repository into a Knit2 repository
351
 
    """
352
 
    def __init__(self, to_repository, from_repository, last_revision=None, 
353
 
                 pb=None):
354
 
        self.helper = Inter1and2Helper(from_repository, to_repository)
355
 
        GenericRepoFetcher.__init__(self, to_repository, from_repository,
356
 
                                    last_revision, pb)
357
 
 
358
 
    def _fetch_weave_texts(self, revs):
359
 
        GenericRepoFetcher._fetch_weave_texts(self, revs)
360
 
        # Now generate a weave for the tree root
361
 
        self.helper.generate_root_texts(revs)
362
 
 
363
 
    def _fetch_inventory_weave(self, revs):
364
 
        self.helper.regenerate_inventory(revs)
365
 
 
366
 
 
367
 
class Knit1to2Fetcher(KnitRepoFetcher):
368
 
    """Fetch from a Knit1 repository into a Knit2 repository"""
369
 
 
370
 
    def __init__(self, to_repository, from_repository, last_revision=None, 
371
 
                 pb=None):
372
 
        self.helper = Inter1and2Helper(from_repository, to_repository)
373
 
        KnitRepoFetcher.__init__(self, to_repository, from_repository,
374
 
                                 last_revision, pb)
375
 
 
376
 
    def _fetch_weave_texts(self, revs):
377
 
        KnitRepoFetcher._fetch_weave_texts(self, revs)
378
 
        # Now generate a weave for the tree root
379
 
        self.helper.generate_root_texts(revs)
380
 
 
381
 
    def _fetch_inventory_weave(self, revs):
382
 
        self.helper.regenerate_inventory(revs)
383
 
        
384
 
 
385
 
class Fetcher(object):
386
 
    """Backwards compatibility glue for branch.fetch()."""
387
 
 
388
 
    @deprecated_method(zero_eight)
389
 
    def __init__(self, to_branch, from_branch, last_revision=None, pb=None):
390
 
        """Please see branch.fetch()."""
391
 
        to_branch.fetch(from_branch, last_revision, pb)
 
235
        graph = self.source.get_graph()
 
236
        parent_map = graph.get_parent_map(revs)
 
237
        rev_order = tsort.topo_sort(parent_map)
 
238
        rev_id_to_root_id = self._find_root_ids(revs, parent_map, graph)
 
239
        root_id_order = [(rev_id_to_root_id[rev_id], rev_id) for rev_id in
 
240
            rev_order]
 
241
        # Guaranteed stable, this groups all the file id operations together
 
242
        # retaining topological order within the revisions of a file id.
 
243
        # File id splits and joins would invalidate this, but they don't exist
 
244
        # yet, and are unlikely to in non-rich-root environments anyway.
 
245
        root_id_order.sort(key=operator.itemgetter(0))
 
246
        # Create a record stream containing the roots to create.
 
247
        if len(revs) > 100:
 
248
            # XXX: not covered by tests, should have a flag to always run
 
249
            # this. -- mbp 20100129
 
250
            graph = self.source_repo.get_known_graph_ancestry(revs)
 
251
        new_roots_stream = _new_root_data_stream(
 
252
            root_id_order, rev_id_to_root_id, parent_map, self.source, graph)
 
253
        return [('texts', new_roots_stream)]
 
254
 
 
255
 
 
256
def _get_rich_root_heads_graph(source_repo, revision_ids):
 
257
    """Get a Graph object suitable for asking heads() for new rich roots."""
 
258
    return 
 
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