~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/fetch.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-07-07 21:30:06 UTC
  • mfrom: (5333.1.2 better_pyqt_include)
  • Revision ID: pqm@pqm.ubuntu.com-20100707213006-lriphkkbzwwrl7ne
(jameinel) Use a better list of PyQt includes and excludes. (Gary van der
 Merwe)

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