← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/fetch.py

  • Committer: Martin Pool
  • Date: 2009-01-13 03:06:36 UTC
  • mfrom: (3932.2.3 1.11)
  • mto: This revision was merged to the branch mainline in revision 3937.
  • Revision ID: mbp@sourcefrog.net-20090113030636-dqx4t8yaaqgdvam5
Merge 1.11rc1

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/fetch.py
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2008 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
16
17
 
17
18
"""Copying of history from one branch to another.
18
19
 
20
21
that has merged into it.  As the first step of a merge, pull, or
21
22
branch operation we copy history from the source into the destination
22
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 then return to the inventories.
23
31
"""
24
32
 
25
 
from __future__ import absolute_import
26
 
 
27
33
import operator
28
34
 
29
 
from bzrlib.lazy_import import lazy_import
30
 
lazy_import(globals(), """
31
 
from bzrlib import (
32
 
    tsort,
33
 
    versionedfile,
34
 
    vf_search,
35
 
    )
36
 
""")
37
 
from bzrlib import (
38
 
    errors,
39
 
    ui,
40
 
    )
41
 
from bzrlib.i18n import gettext
42
 
from bzrlib.revision import NULL_REVISION
 
35
import bzrlib
 
36
import bzrlib.errors as errors
 
37
from bzrlib.errors import InstallFailed
 
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
        )
 
43
from bzrlib.tsort import topo_sort
43
44
from bzrlib.trace import mutter
 
45
import bzrlib.ui
 
46
from bzrlib.versionedfile import filter_absent, FulltextContentFactory
 
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
44
64
 
45
65
 
46
66
class RepoFetcher(object):
47
67
    """Pull revisions and texts from one repository to another.
48
68
 
 
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
 
49
75
    This should not be used directly, it's essential a object to encapsulate
50
76
    the logic in InterRepository.fetch().
51
77
    """
52
78
 
53
 
    def __init__(self, to_repository, from_repository, last_revision=None,
54
 
        find_ghosts=True, fetch_spec=None):
 
79
    def __init__(self, to_repository, from_repository, last_revision=None, pb=None,
 
80
        find_ghosts=True):
55
81
        """Create a repo fetcher.
56
82
 
57
 
        :param last_revision: If set, try to limit to the data this revision
58
 
            references.
59
 
        :param fetch_spec: A SearchResult specifying which revisions to fetch.
60
 
            If set, this overrides last_revision.
61
83
        :param find_ghosts: If True search the entire history for ghosts.
 
84
        :param _write_group_acquired_callable: Don't use; this parameter only
 
85
            exists to facilitate a hack done in InterPackRepo.fetch.  We would
 
86
            like to remove this parameter.
62
87
        """
63
 
        # repository.fetch has the responsibility for short-circuiting
64
 
        # attempts to copy between a repository and itself.
 
88
        # result variables.
 
89
        self.failed_revisions = []
 
90
        self.count_copied = 0
 
91
        if to_repository.has_same_location(from_repository):
 
92
            # repository.fetch should be taking care of this case.
 
93
            raise errors.BzrError('RepoFetcher run '
 
94
                    'between two objects at the same location: '
 
95
                    '%r and %r' % (to_repository, from_repository))
65
96
        self.to_repository = to_repository
66
97
        self.from_repository = from_repository
67
 
        self.sink = to_repository._get_sink()
68
98
        # must not mutate self._last_revision as its potentially a shared instance
69
99
        self._last_revision = last_revision
70
 
        self._fetch_spec = fetch_spec
71
100
        self.find_ghosts = find_ghosts
 
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
72
107
        self.from_repository.lock_read()
73
 
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
74
 
               self.from_repository, self.from_repository._format,
75
 
               self.to_repository, self.to_repository._format)
76
108
        try:
77
 
            self.__fetch()
 
109
            self.to_repository.lock_write()
 
110
            try:
 
111
                self.to_repository.start_write_group()
 
112
                try:
 
113
                    self.__fetch()
 
114
                except:
 
115
                    self.to_repository.abort_write_group(suppress_errors=True)
 
116
                    raise
 
117
                else:
 
118
                    self.to_repository.commit_write_group()
 
119
            finally:
 
120
                try:
 
121
                    if self.nested_pb is not None:
 
122
                        self.nested_pb.finished()
 
123
                finally:
 
124
                    self.to_repository.unlock()
78
125
        finally:
79
126
            self.from_repository.unlock()
80
127
 
81
128
    def __fetch(self):
82
129
        """Primary worker function.
83
130
 
84
 
        This initialises all the needed variables, and then fetches the
 
131
        This initialises all the needed variables, and then fetches the 
85
132
        requested revisions, finally clearing the progress bar.
86
133
        """
87
 
        # Roughly this is what we're aiming for fetch to become:
88
 
        #
89
 
        # missing = self.sink.insert_stream(self.source.get_stream(search))
90
 
        # if missing:
91
 
        #     missing = self.sink.insert_stream(self.source.get_items(missing))
92
 
        # assert not missing
93
134
        self.count_total = 0
94
135
        self.file_ids_names = {}
95
 
        pb = ui.ui_factory.nested_progress_bar()
96
 
        pb.show_pct = pb.show_count = False
 
136
        pp = ProgressPhase('Transferring', 4, self.pb)
97
137
        try:
98
 
            pb.update(gettext("Finding revisions"), 0, 2)
99
 
            search_result = self._revids_to_fetch()
100
 
            mutter('fetching: %s', search_result)
101
 
            if search_result.is_empty():
 
138
            pp.next_phase()
 
139
            search = self._revids_to_fetch()
 
140
            if search is None:
102
141
                return
103
 
            pb.update(gettext("Fetching revisions"), 1, 2)
104
 
            self._fetch_everything_for_search(search_result)
 
142
            if getattr(self, '_fetch_everything_for_search', None) is not None:
 
143
                self._fetch_everything_for_search(search, pp)
 
144
            else:
 
145
                # backward compatibility
 
146
                self._fetch_everything_for_revisions(search.get_keys, pp)
105
147
        finally:
106
 
            pb.finished()
 
148
            self.pb.clear()
107
149
 
108
 
    def _fetch_everything_for_search(self, search):
 
150
    def _fetch_everything_for_search(self, search, pp):
109
151
        """Fetch all data for the given set of revisions."""
110
152
        # The first phase is "file".  We pass the progress bar for it directly
111
153
        # into item_keys_introduced_by, which has more information about how
115
157
        # item_keys_introduced_by should have a richer API than it does at the
116
158
        # moment, so that it can feed the progress information back to this
117
159
        # function?
118
 
        if (self.from_repository._format.rich_root_data and
119
 
            not self.to_repository._format.rich_root_data):
120
 
            raise errors.IncompatibleRepositories(
121
 
                self.from_repository, self.to_repository,
122
 
                "different rich-root support")
123
 
        pb = ui.ui_factory.nested_progress_bar()
 
160
        phase = 'file'
 
161
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
124
162
        try:
125
 
            pb.update("Get stream source")
126
 
            source = self.from_repository._get_source(
127
 
                self.to_repository._format)
128
 
            stream = source.get_stream(search)
129
 
            from_format = self.from_repository._format
130
 
            pb.update("Inserting stream")
131
 
            resume_tokens, missing_keys = self.sink.insert_stream(
132
 
                stream, from_format, [])
133
 
            if missing_keys:
134
 
                pb.update("Missing keys")
135
 
                stream = source.get_stream_for_missing_keys(missing_keys)
136
 
                pb.update("Inserting missing keys")
137
 
                resume_tokens, missing_keys = self.sink.insert_stream(
138
 
                    stream, from_format, resume_tokens)
139
 
            if missing_keys:
140
 
                raise AssertionError(
141
 
                    "second push failed to complete a fetch %r." % (
142
 
                        missing_keys,))
143
 
            if resume_tokens:
144
 
                raise AssertionError(
145
 
                    "second push failed to commit the fetch %r." % (
146
 
                        resume_tokens,))
147
 
            pb.update("Finishing stream")
148
 
            self.sink.finished()
 
163
            revs = search.get_keys()
 
164
            graph = self.from_repository.get_graph()
 
165
            revs = list(graph.iter_topo_order(revs))
 
166
            data_to_fetch = self.from_repository.item_keys_introduced_by(revs,
 
167
                                                                         pb)
 
168
            text_keys = []
 
169
            for knit_kind, file_id, revisions in data_to_fetch:
 
170
                if knit_kind != phase:
 
171
                    phase = knit_kind
 
172
                    # Make a new progress bar for this phase
 
173
                    pb.finished()
 
174
                    pp.next_phase()
 
175
                    pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
176
                if knit_kind == "file":
 
177
                    # Accumulate file texts
 
178
                    text_keys.extend([(file_id, revision) for revision in
 
179
                        revisions])
 
180
                elif knit_kind == "inventory":
 
181
                    # Now copy the file texts.
 
182
                    to_texts = self.to_repository.texts
 
183
                    from_texts = self.from_repository.texts
 
184
                    to_texts.insert_record_stream(from_texts.get_record_stream(
 
185
                        text_keys, self.to_repository._fetch_order,
 
186
                        not self.to_repository._fetch_uses_deltas))
 
187
                    # Cause an error if a text occurs after we have done the
 
188
                    # copy.
 
189
                    text_keys = None
 
190
                    # Before we process the inventory we generate the root
 
191
                    # texts (if necessary) so that the inventories references
 
192
                    # will be valid.
 
193
                    self._generate_root_texts(revs)
 
194
                    # NB: This currently reopens the inventory weave in source;
 
195
                    # using a single stream interface instead would avoid this.
 
196
                    self._fetch_inventory_weave(revs, pb)
 
197
                elif knit_kind == "signatures":
 
198
                    # Nothing to do here; this will be taken care of when
 
199
                    # _fetch_revision_texts happens.
 
200
                    pass
 
201
                elif knit_kind == "revisions":
 
202
                    self._fetch_revision_texts(revs, pb)
 
203
                else:
 
204
                    raise AssertionError("Unknown knit kind %r" % knit_kind)
 
205
            if self.to_repository._fetch_reconcile:
 
206
                self.to_repository.reconcile()
149
207
        finally:
150
 
            pb.finished()
151
 
 
 
208
            if pb is not None:
 
209
                pb.finished()
 
210
        self.count_copied += len(revs)
 
211
        
152
212
    def _revids_to_fetch(self):
153
213
        """Determines the exact revisions needed from self.from_repository to
154
214
        install self._last_revision in self.to_repository.
155
215
 
156
 
        :returns: A SearchResult of some sort.  (Possibly a
157
 
            PendingAncestryResult, EmptySearchResult, etc.)
 
216
        If no revisions need to be fetched, then this just returns None.
158
217
        """
159
 
        if self._fetch_spec is not None:
160
 
            # The fetch spec is already a concrete search result.
161
 
            return self._fetch_spec
162
 
        elif self._last_revision == NULL_REVISION:
163
 
            # fetch_spec is None + last_revision is null => empty fetch.
 
218
        mutter('fetch up to rev {%s}', self._last_revision)
 
219
        if self._last_revision is NULL_REVISION:
164
220
            # explicit limit of no revisions needed
165
 
            return vf_search.EmptySearchResult()
166
 
        elif self._last_revision is not None:
167
 
            return vf_search.NotInOtherForRevs(self.to_repository,
168
 
                self.from_repository, [self._last_revision],
169
 
                find_ghosts=self.find_ghosts).execute()
170
 
        else: # self._last_revision is None:
171
 
            return vf_search.EverythingNotInOther(self.to_repository,
172
 
                self.from_repository,
173
 
                find_ghosts=self.find_ghosts).execute()
 
221
            return None
 
222
        if (self._last_revision is not None and
 
223
            self.to_repository.has_revision(self._last_revision)):
 
224
            return None
 
225
        try:
 
226
            return self.to_repository.search_missing_revision_ids(
 
227
                self.from_repository, self._last_revision,
 
228
                find_ghosts=self.find_ghosts)
 
229
        except errors.NoSuchRevision, e:
 
230
            raise InstallFailed([self._last_revision])
 
231
 
 
232
    def _fetch_inventory_weave(self, revs, pb):
 
233
        pb.update("fetch inventory", 0, 2)
 
234
        to_weave = self.to_repository.inventories
 
235
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
236
        try:
 
237
            # just merge, this is optimisable and its means we don't
 
238
            # copy unreferenced data such as not-needed inventories.
 
239
            pb.update("fetch inventory", 1, 3)
 
240
            from_weave = self.from_repository.inventories
 
241
            pb.update("fetch inventory", 2, 3)
 
242
            # we fetch only the referenced inventories because we do not
 
243
            # know for unselected inventories whether all their required
 
244
            # texts are present in the other repository - it could be
 
245
            # corrupt.
 
246
            to_weave.insert_record_stream(from_weave.get_record_stream(
 
247
                [(rev_id,) for rev_id in revs],
 
248
                self.to_repository._fetch_order,
 
249
                not self.to_repository._fetch_uses_deltas))
 
250
        finally:
 
251
            child_pb.finished()
 
252
 
 
253
    def _fetch_revision_texts(self, revs, pb):
 
254
        # fetch signatures first and then the revision texts
 
255
        # may need to be a InterRevisionStore call here.
 
256
        to_sf = self.to_repository.signatures
 
257
        from_sf = self.from_repository.signatures
 
258
        # A missing signature is just skipped.
 
259
        to_sf.insert_record_stream(filter_absent(from_sf.get_record_stream(
 
260
            [(rev_id,) for rev_id in revs],
 
261
            self.to_repository._fetch_order,
 
262
            not self.to_repository._fetch_uses_deltas)))
 
263
        self._fetch_just_revision_texts(revs)
 
264
 
 
265
    def _fetch_just_revision_texts(self, version_ids):
 
266
        to_rf = self.to_repository.revisions
 
267
        from_rf = self.from_repository.revisions
 
268
        # If a revision has a delta, this is actually expanded inside the
 
269
        # insert_record_stream code now, which is an alternate fix for
 
270
        # bug #261339
 
271
        to_rf.insert_record_stream(from_rf.get_record_stream(
 
272
            [(rev_id,) for rev_id in version_ids],
 
273
            self.to_repository._fetch_order,
 
274
            not self.to_repository._fetch_uses_deltas))
 
275
 
 
276
    def _generate_root_texts(self, revs):
 
277
        """This will be called by __fetch between fetching weave texts and
 
278
        fetching the inventory weave.
 
279
 
 
280
        Subclasses should override this if they need to generate root texts
 
281
        after fetching weave texts.
 
282
        """
 
283
        pass
174
284
 
175
285
 
176
286
class Inter1and2Helper(object):
177
287
    """Helper for operations that convert data from model 1 and 2
178
 
 
 
288
    
179
289
    This is for use by fetchers and converters.
180
290
    """
181
291
 
182
 
    # This is a class variable so that the test suite can override it.
183
 
    known_graph_threshold = 100
184
 
 
185
 
    def __init__(self, source):
 
292
    def __init__(self, source, target):
186
293
        """Constructor.
187
294
 
188
295
        :param source: The repository data comes from
 
296
        :param target: The repository data goes to
189
297
        """
190
298
        self.source = source
 
299
        self.target = target
191
300
 
192
301
    def iter_rev_trees(self, revs):
193
302
        """Iterate through RevisionTrees efficiently.
203
312
        revs = list(revs)
204
313
        while revs:
205
314
            for tree in self.source.revision_trees(revs[:100]):
206
 
                if tree.root_inventory.revision_id is None:
207
 
                    tree.root_inventory.revision_id = tree.get_revision_id()
 
315
                if tree.inventory.revision_id is None:
 
316
                    tree.inventory.revision_id = tree.get_revision_id()
208
317
                yield tree
209
318
            revs = revs[100:]
210
319
 
211
320
    def _find_root_ids(self, revs, parent_map, graph):
212
321
        revision_root = {}
 
322
        planned_versions = {}
213
323
        for tree in self.iter_rev_trees(revs):
 
324
            revision_id = tree.inventory.root.revision
214
325
            root_id = tree.get_root_id()
215
 
            revision_id = tree.get_file_revision(root_id, u"")
 
326
            planned_versions.setdefault(root_id, []).append(revision_id)
216
327
            revision_root[revision_id] = root_id
217
328
        # Find out which parents we don't already know root ids for
218
329
        parents = set()
224
335
        for tree in self.iter_rev_trees(parents):
225
336
            root_id = tree.get_root_id()
226
337
            revision_root[tree.get_revision_id()] = root_id
227
 
        return revision_root
 
338
        return revision_root, planned_versions
228
339
 
229
340
    def generate_root_texts(self, revs):
230
341
        """Generate VersionedFiles for all root ids.
231
342
 
232
343
        :param revs: the revisions to include
233
344
        """
 
345
        to_texts = self.target.texts
234
346
        graph = self.source.get_graph()
235
347
        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)
 
348
        rev_order = topo_sort(parent_map)
 
349
        rev_id_to_root_id, root_id_to_rev_ids = self._find_root_ids(
 
350
            revs, parent_map, graph)
238
351
        root_id_order = [(rev_id_to_root_id[rev_id], rev_id) for rev_id in
239
352
            rev_order]
240
353
        # Guaranteed stable, this groups all the file id operations together
243
356
        # yet, and are unlikely to in non-rich-root environments anyway.
244
357
        root_id_order.sort(key=operator.itemgetter(0))
245
358
        # Create a record stream containing the roots to create.
246
 
        if len(revs) > self.known_graph_threshold:
247
 
            graph = self.source.get_known_graph_ancestry(revs)
248
 
        new_roots_stream = _new_root_data_stream(
249
 
            root_id_order, rev_id_to_root_id, parent_map, self.source, graph)
250
 
        return [('texts', new_roots_stream)]
251
 
 
252
 
 
253
 
def _new_root_data_stream(
254
 
    root_keys_to_create, rev_id_to_root_id_map, parent_map, repo, graph=None):
255
 
    """Generate a texts substream of synthesised root entries.
256
 
 
257
 
    Used in fetches that do rich-root upgrades.
258
 
    
259
 
    :param root_keys_to_create: iterable of (root_id, rev_id) pairs describing
260
 
        the root entries to create.
261
 
    :param rev_id_to_root_id_map: dict of known rev_id -> root_id mappings for
262
 
        calculating the parents.  If a parent rev_id is not found here then it
263
 
        will be recalculated.
264
 
    :param parent_map: a parent map for all the revisions in
265
 
        root_keys_to_create.
266
 
    :param graph: a graph to use instead of repo.get_graph().
267
 
    """
268
 
    for root_key in root_keys_to_create:
269
 
        root_id, rev_id = root_key
270
 
        parent_keys = _parent_keys_for_root_version(
271
 
            root_id, rev_id, rev_id_to_root_id_map, parent_map, repo, graph)
272
 
        yield versionedfile.FulltextContentFactory(
273
 
            root_key, parent_keys, None, '')
274
 
 
275
 
 
276
 
def _parent_keys_for_root_version(
277
 
    root_id, rev_id, rev_id_to_root_id_map, parent_map, repo, graph=None):
278
 
    """Get the parent keys for a given root id.
279
 
    
280
 
    A helper function for _new_root_data_stream.
281
 
    """
282
 
    # Include direct parents of the revision, but only if they used the same
283
 
    # root_id and are heads.
284
 
    rev_parents = parent_map[rev_id]
285
 
    parent_ids = []
286
 
    for parent_id in rev_parents:
287
 
        if parent_id == NULL_REVISION:
288
 
            continue
289
 
        if parent_id not in rev_id_to_root_id_map:
290
 
            # We probably didn't read this revision, go spend the extra effort
291
 
            # to actually check
292
 
            try:
293
 
                tree = repo.revision_tree(parent_id)
294
 
            except errors.NoSuchRevision:
295
 
                # Ghost, fill out rev_id_to_root_id in case we encounter this
296
 
                # again.
297
 
                # But set parent_root_id to None since we don't really know
298
 
                parent_root_id = None
299
 
            else:
300
 
                parent_root_id = tree.get_root_id()
301
 
            rev_id_to_root_id_map[parent_id] = None
302
 
            # XXX: why not:
303
 
            #   rev_id_to_root_id_map[parent_id] = parent_root_id
304
 
            # memory consumption maybe?
305
 
        else:
306
 
            parent_root_id = rev_id_to_root_id_map[parent_id]
307
 
        if root_id == parent_root_id:
308
 
            # With stacking we _might_ want to refer to a non-local revision,
309
 
            # but this code path only applies when we have the full content
310
 
            # available, so ghosts really are ghosts, not just the edge of
311
 
            # local data.
312
 
            parent_ids.append(parent_id)
313
 
        else:
314
 
            # root_id may be in the parent anyway.
315
 
            try:
316
 
                tree = repo.revision_tree(parent_id)
317
 
            except errors.NoSuchRevision:
318
 
                # ghost, can't refer to it.
 
359
        def yield_roots():
 
360
            for key in root_id_order:
 
361
                root_id, rev_id = key
 
362
                rev_parents = parent_map[rev_id]
 
363
                # We drop revision parents with different file-ids, because
 
364
                # that represents a rename of the root to a different location
 
365
                # - its not actually a parent for us. (We could look for that
 
366
                # file id in the revision tree at considerably more expense,
 
367
                # but for now this is sufficient (and reconcile will catch and
 
368
                # correct this anyway).
 
369
                # When a parent revision is a ghost, we guess that its root id
 
370
                # was unchanged (rather than trimming it from the parent list).
 
371
                parent_keys = tuple((root_id, parent) for parent in rev_parents
 
372
                    if parent != NULL_REVISION and
 
373
                        rev_id_to_root_id.get(parent, root_id) == root_id)
 
374
                yield FulltextContentFactory(key, parent_keys, None, '')
 
375
        to_texts.insert_record_stream(yield_roots())
 
376
 
 
377
    def regenerate_inventory(self, revs):
 
378
        """Generate a new inventory versionedfile in target, convertin data.
 
379
        
 
380
        The inventory is retrieved from the source, (deserializing it), and
 
381
        stored in the target (reserializing it in a different format).
 
382
        :param revs: The revisions to include
 
383
        """
 
384
        for tree in self.iter_rev_trees(revs):
 
385
            parents = tree.get_parent_ids()
 
386
            self.target.add_inventory(tree.get_revision_id(), tree.inventory,
 
387
                                      parents)
 
388
 
 
389
    def fetch_revisions(self, revision_ids):
 
390
        # TODO: should this batch them up rather than requesting 10,000
 
391
        #       revisions at once?
 
392
        for revision in self.source.get_revisions(revision_ids):
 
393
            self.target.add_revision(revision.revision_id, revision)
 
394
 
 
395
 
 
396
class Model1toKnit2Fetcher(RepoFetcher):
 
397
    """Fetch from a Model1 repository into a Knit2 repository
 
398
    """
 
399
    def __init__(self, to_repository, from_repository, last_revision=None,
 
400
                 pb=None, find_ghosts=True):
 
401
        self.helper = Inter1and2Helper(from_repository, to_repository)
 
402
        RepoFetcher.__init__(self, to_repository, from_repository,
 
403
            last_revision, pb, find_ghosts)
 
404
 
 
405
    def _generate_root_texts(self, revs):
 
406
        self.helper.generate_root_texts(revs)
 
407
 
 
408
    def _fetch_inventory_weave(self, revs, pb):
 
409
        self.helper.regenerate_inventory(revs)
 
410
 
 
411
    def _fetch_revision_texts(self, revs, pb):
 
412
        """Fetch revision object texts"""
 
413
        count = 0
 
414
        total = len(revs)
 
415
        for rev in revs:
 
416
            pb.update('copying revisions', count, total)
 
417
            try:
 
418
                sig_text = self.from_repository.get_signature_text(rev)
 
419
                self.to_repository.add_signature_text(rev, sig_text)
 
420
            except errors.NoSuchRevision:
 
421
                # not signed.
319
422
                pass
320
 
            else:
321
 
                try:
322
 
                    parent_ids.append(tree.get_file_revision(root_id))
323
 
                except errors.NoSuchId:
324
 
                    # not in the tree
325
 
                    pass
326
 
    # Drop non-head parents
327
 
    if graph is None:
328
 
        graph = repo.get_graph()
329
 
    heads = graph.heads(parent_ids)
330
 
    selected_ids = []
331
 
    for parent_id in parent_ids:
332
 
        if parent_id in heads and parent_id not in selected_ids:
333
 
            selected_ids.append(parent_id)
334
 
    parent_keys = [(root_id, parent_id) for parent_id in selected_ids]
335
 
    return parent_keys
336
 
 
337
 
 
338
 
class TargetRepoKinds(object):
339
 
    """An enum-like set of constants.
340
 
    
341
 
    They are the possible values of FetchSpecFactory.target_repo_kinds.
342
 
    """
343
 
    
344
 
    PREEXISTING = 'preexisting'
345
 
    STACKED = 'stacked'
346
 
    EMPTY = 'empty'
347
 
 
348
 
 
349
 
class FetchSpecFactory(object):
350
 
    """A helper for building the best fetch spec for a sprout call.
351
 
 
352
 
    Factors that go into determining the sort of fetch to perform:
353
 
     * did the caller specify any revision IDs?
354
 
     * did the caller specify a source branch (need to fetch its
355
 
       heads_to_fetch(), usually the tip + tags)
356
 
     * is there an existing target repo (don't need to refetch revs it
357
 
       already has)
358
 
     * target is stacked?  (similar to pre-existing target repo: even if
359
 
       the target itself is new don't want to refetch existing revs)
360
 
 
361
 
    :ivar source_branch: the source branch if one specified, else None.
362
 
    :ivar source_branch_stop_revision_id: fetch up to this revision of
363
 
        source_branch, rather than its tip.
364
 
    :ivar source_repo: the source repository if one found, else None.
365
 
    :ivar target_repo: the target repository acquired by sprout.
366
 
    :ivar target_repo_kind: one of the TargetRepoKinds constants.
367
 
    """
368
 
 
369
 
    def __init__(self):
370
 
        self._explicit_rev_ids = set()
371
 
        self.source_branch = None
372
 
        self.source_branch_stop_revision_id = None
373
 
        self.source_repo = None
374
 
        self.target_repo = None
375
 
        self.target_repo_kind = None
376
 
        self.limit = None
377
 
 
378
 
    def add_revision_ids(self, revision_ids):
379
 
        """Add revision_ids to the set of revision_ids to be fetched."""
380
 
        self._explicit_rev_ids.update(revision_ids)
381
 
 
382
 
    def make_fetch_spec(self):
383
 
        """Build a SearchResult or PendingAncestryResult or etc."""
384
 
        if self.target_repo_kind is None or self.source_repo is None:
385
 
            raise AssertionError(
386
 
                'Incomplete FetchSpecFactory: %r' % (self.__dict__,))
387
 
        if len(self._explicit_rev_ids) == 0 and self.source_branch is None:
388
 
            if self.limit is not None:
389
 
                raise NotImplementedError(
390
 
                    "limit is only supported with a source branch set")
391
 
            # Caller hasn't specified any revisions or source branch
392
 
            if self.target_repo_kind == TargetRepoKinds.EMPTY:
393
 
                return vf_search.EverythingResult(self.source_repo)
394
 
            else:
395
 
                # We want everything not already in the target (or target's
396
 
                # fallbacks).
397
 
                return vf_search.EverythingNotInOther(
398
 
                    self.target_repo, self.source_repo).execute()
399
 
        heads_to_fetch = set(self._explicit_rev_ids)
400
 
        if self.source_branch is not None:
401
 
            must_fetch, if_present_fetch = self.source_branch.heads_to_fetch()
402
 
            if self.source_branch_stop_revision_id is not None:
403
 
                # Replace the tip rev from must_fetch with the stop revision
404
 
                # XXX: this might be wrong if the tip rev is also in the
405
 
                # must_fetch set for other reasons (e.g. it's the tip of
406
 
                # multiple loom threads?), but then it's pretty unclear what it
407
 
                # should mean to specify a stop_revision in that case anyway.
408
 
                must_fetch.discard(self.source_branch.last_revision())
409
 
                must_fetch.add(self.source_branch_stop_revision_id)
410
 
            heads_to_fetch.update(must_fetch)
411
 
        else:
412
 
            if_present_fetch = set()
413
 
        if self.target_repo_kind == TargetRepoKinds.EMPTY:
414
 
            # PendingAncestryResult does not raise errors if a requested head
415
 
            # is absent.  Ideally it would support the
416
 
            # required_ids/if_present_ids distinction, but in practice
417
 
            # heads_to_fetch will almost certainly be present so this doesn't
418
 
            # matter much.
419
 
            all_heads = heads_to_fetch.union(if_present_fetch)
420
 
            ret = vf_search.PendingAncestryResult(all_heads, self.source_repo)
421
 
            if self.limit is not None:
422
 
                graph = self.source_repo.get_graph()
423
 
                topo_order = list(graph.iter_topo_order(ret.get_keys()))
424
 
                result_set = topo_order[:self.limit]
425
 
                ret = self.source_repo.revision_ids_to_search_result(result_set)
426
 
            return ret
427
 
        else:
428
 
            return vf_search.NotInOtherForRevs(self.target_repo, self.source_repo,
429
 
                required_ids=heads_to_fetch, if_present_ids=if_present_fetch,
430
 
                limit=self.limit).execute()
 
423
            self._copy_revision(rev)
 
424
            count += 1
 
425
 
 
426
    def _copy_revision(self, rev):
 
427
        self.helper.fetch_revisions([rev])
 
428
 
 
429
 
 
430
class Knit1to2Fetcher(RepoFetcher):
 
431
    """Fetch from a Knit1 repository into a Knit2 repository"""
 
432
 
 
433
    def __init__(self, to_repository, from_repository, last_revision=None,
 
434
                 pb=None, find_ghosts=True):
 
435
        self.helper = Inter1and2Helper(from_repository, to_repository)
 
436
        RepoFetcher.__init__(self, to_repository, from_repository,
 
437
            last_revision, pb, find_ghosts)
 
438
 
 
439
    def _generate_root_texts(self, revs):
 
440
        self.helper.generate_root_texts(revs)
 
441
 
 
442
    def _fetch_inventory_weave(self, revs, pb):
 
443
        self.helper.regenerate_inventory(revs)
 
444
 
 
445
    def _fetch_just_revision_texts(self, version_ids):
 
446
        self.helper.fetch_revisions(version_ids)