~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/fetch.py

  • Committer: Frank Aspell
  • Date: 2009-02-22 16:54:02 UTC
  • mto: This revision was merged to the branch mainline in revision 4256.
  • Revision ID: frankaspell@googlemail.com-20090222165402-2myrucnu7er5w4ha
Fixing various typos

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 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
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 then return to the inventories.
24
31
"""
25
32
 
26
33
import operator
27
34
 
28
 
from bzrlib.lazy_import import lazy_import
29
 
lazy_import(globals(), """
30
 
from bzrlib import (
31
 
    tsort,
32
 
    versionedfile,
33
 
    )
34
 
""")
35
35
import bzrlib
36
 
from bzrlib import (
37
 
    errors,
38
 
    ui,
39
 
    )
 
36
import bzrlib.errors as errors
 
37
from bzrlib.errors import InstallFailed
 
38
from bzrlib.progress import ProgressPhase
40
39
from bzrlib.revision import NULL_REVISION
 
40
from bzrlib.tsort import topo_sort
41
41
from bzrlib.trace import mutter
 
42
import bzrlib.ui
 
43
from bzrlib.versionedfile import filter_absent, FulltextContentFactory
 
44
 
 
45
# TODO: Avoid repeatedly opening weaves so many times.
 
46
 
 
47
# XXX: This doesn't handle ghost (not present in branch) revisions at
 
48
# all yet.  I'm not sure they really should be supported.
 
49
 
 
50
# NOTE: This doesn't copy revisions which may be present but not
 
51
# merged into the last revision.  I'm not sure we want to do that.
 
52
 
 
53
# - get a list of revisions that need to be pulled in
 
54
# - for each one, pull in that revision file
 
55
#   and get the inventory, and store the inventory with right
 
56
#   parents.
 
57
# - and get the ancestry, and store that with right parents too
 
58
# - and keep a note of all file ids and version seen
 
59
# - then go through all files; for each one get the weave,
 
60
#   and add in all file versions
42
61
 
43
62
 
44
63
class RepoFetcher(object):
45
64
    """Pull revisions and texts from one repository to another.
46
65
 
 
66
    last_revision
 
67
        if set, try to limit to the data this revision references.
 
68
 
 
69
    after running:
 
70
    count_copied -- number of revisions copied
 
71
 
47
72
    This should not be used directly, it's essential a object to encapsulate
48
73
    the logic in InterRepository.fetch().
49
74
    """
50
75
 
51
 
    def __init__(self, to_repository, from_repository, last_revision=None,
52
 
        find_ghosts=True, fetch_spec=None):
 
76
    def __init__(self, to_repository, from_repository, last_revision=None, pb=None,
 
77
        find_ghosts=True):
53
78
        """Create a repo fetcher.
54
79
 
55
 
        :param last_revision: If set, try to limit to the data this revision
56
 
            references.
57
80
        :param find_ghosts: If True search the entire history for ghosts.
 
81
        :param _write_group_acquired_callable: Don't use; this parameter only
 
82
            exists to facilitate a hack done in InterPackRepo.fetch.  We would
 
83
            like to remove this parameter.
58
84
        """
59
 
        # repository.fetch has the responsibility for short-circuiting
60
 
        # attempts to copy between a repository and itself.
 
85
        # result variables.
 
86
        self.failed_revisions = []
 
87
        self.count_copied = 0
 
88
        if to_repository.has_same_location(from_repository):
 
89
            # repository.fetch should be taking care of this case.
 
90
            raise errors.BzrError('RepoFetcher run '
 
91
                    'between two objects at the same location: '
 
92
                    '%r and %r' % (to_repository, from_repository))
61
93
        self.to_repository = to_repository
62
94
        self.from_repository = from_repository
63
95
        self.sink = to_repository._get_sink()
64
96
        # must not mutate self._last_revision as its potentially a shared instance
65
97
        self._last_revision = last_revision
66
 
        self._fetch_spec = fetch_spec
67
98
        self.find_ghosts = find_ghosts
 
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
68
105
        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)
72
106
        try:
73
 
            self.__fetch()
 
107
            self.to_repository.lock_write()
 
108
            try:
 
109
                self.to_repository.start_write_group()
 
110
                try:
 
111
                    self.__fetch()
 
112
                except:
 
113
                    self.to_repository.abort_write_group(suppress_errors=True)
 
114
                    raise
 
115
                else:
 
116
                    self.to_repository.commit_write_group()
 
117
            finally:
 
118
                try:
 
119
                    if self.nested_pb is not None:
 
120
                        self.nested_pb.finished()
 
121
                finally:
 
122
                    self.to_repository.unlock()
74
123
        finally:
75
124
            self.from_repository.unlock()
76
125
 
77
126
    def __fetch(self):
78
127
        """Primary worker function.
79
128
 
80
 
        This initialises all the needed variables, and then fetches the
 
129
        This initialises all the needed variables, and then fetches the 
81
130
        requested revisions, finally clearing the progress bar.
82
131
        """
83
132
        # Roughly this is what we're aiming for fetch to become:
88
137
        # assert not missing
89
138
        self.count_total = 0
90
139
        self.file_ids_names = {}
91
 
        pb = ui.ui_factory.nested_progress_bar()
92
 
        pb.show_pct = pb.show_count = False
 
140
        pp = ProgressPhase('Transferring', 4, self.pb)
93
141
        try:
94
 
            pb.update("Finding revisions", 0, 2)
 
142
            pp.next_phase()
95
143
            search = self._revids_to_fetch()
96
144
            if search is None:
97
145
                return
98
 
            pb.update("Fetching revisions", 1, 2)
99
 
            self._fetch_everything_for_search(search)
 
146
            self._fetch_everything_for_search(search, pp)
100
147
        finally:
101
 
            pb.finished()
 
148
            self.pb.clear()
102
149
 
103
 
    def _fetch_everything_for_search(self, search):
 
150
    def _fetch_everything_for_search(self, search, pp):
104
151
        """Fetch all data for the given set of revisions."""
105
152
        # The first phase is "file".  We pass the progress bar for it directly
106
153
        # into item_keys_introduced_by, which has more information about how
110
157
        # item_keys_introduced_by should have a richer API than it does at the
111
158
        # moment, so that it can feed the progress information back to this
112
159
        # 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()
 
160
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
119
161
        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
162
            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")
 
163
            stream = self.get_stream(search, pp)
 
164
            self.sink.insert_stream(stream, from_format)
146
165
            self.sink.finished()
147
166
        finally:
148
 
            pb.finished()
 
167
            if self.pb is not None:
 
168
                self.pb.finished()
 
169
        
 
170
    def get_stream(self, search, pp):
 
171
        phase = 'file'
 
172
        revs = search.get_keys()
 
173
        graph = self.from_repository.get_graph()
 
174
        revs = list(graph.iter_topo_order(revs))
 
175
        data_to_fetch = self.from_repository.item_keys_introduced_by(
 
176
            revs, self.pb)
 
177
        text_keys = []
 
178
        for knit_kind, file_id, revisions in data_to_fetch:
 
179
            if knit_kind != phase:
 
180
                phase = knit_kind
 
181
                # Make a new progress bar for this phase
 
182
                self.pb.finished()
 
183
                pp.next_phase()
 
184
                self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
185
            if knit_kind == "file":
 
186
                # Accumulate file texts
 
187
                text_keys.extend([(file_id, revision) for revision in
 
188
                    revisions])
 
189
            elif knit_kind == "inventory":
 
190
                # Now copy the file texts.
 
191
                to_texts = self.to_repository.texts
 
192
                from_texts = self.from_repository.texts
 
193
                yield ('texts', from_texts.get_record_stream(
 
194
                    text_keys, self.to_repository._fetch_order,
 
195
                    not self.to_repository._fetch_uses_deltas))
 
196
                # Cause an error if a text occurs after we have done the
 
197
                # copy.
 
198
                text_keys = None
 
199
                # Before we process the inventory we generate the root
 
200
                # texts (if necessary) so that the inventories references
 
201
                # will be valid.
 
202
                for _ in self._generate_root_texts(revs):
 
203
                    yield _
 
204
                # NB: This currently reopens the inventory weave in source;
 
205
                # using a single stream interface instead would avoid this.
 
206
                self.pb.update("fetch inventory", 0, 1)
 
207
                from_weave = self.from_repository.inventories
 
208
                # we fetch only the referenced inventories because we do not
 
209
                # know for unselected inventories whether all their required
 
210
                # texts are present in the other repository - it could be
 
211
                # corrupt.
 
212
                yield ('inventories', from_weave.get_record_stream(
 
213
                    [(rev_id,) for rev_id in revs],
 
214
                    self.inventory_fetch_order(),
 
215
                    not self.delta_on_metadata()))
 
216
            elif knit_kind == "signatures":
 
217
                # Nothing to do here; this will be taken care of when
 
218
                # _fetch_revision_texts happens.
 
219
                pass
 
220
            elif knit_kind == "revisions":
 
221
                for _ in self._fetch_revision_texts(revs, self.pb):
 
222
                    yield _
 
223
            else:
 
224
                raise AssertionError("Unknown knit kind %r" % knit_kind)
 
225
        self.count_copied += len(revs)
149
226
 
150
227
    def _revids_to_fetch(self):
151
228
        """Determines the exact revisions needed from self.from_repository to
153
230
 
154
231
        If no revisions need to be fetched, then this just returns None.
155
232
        """
156
 
        if self._fetch_spec is not None:
157
 
            return self._fetch_spec
158
233
        mutter('fetch up to rev {%s}', self._last_revision)
159
234
        if self._last_revision is NULL_REVISION:
160
235
            # explicit limit of no revisions needed
161
236
            return None
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
 
237
        if (self._last_revision is not None and
 
238
            self.to_repository.has_revision(self._last_revision)):
 
239
            return None
 
240
        try:
 
241
            return self.to_repository.search_missing_revision_ids(
 
242
                self.from_repository, self._last_revision,
 
243
                find_ghosts=self.find_ghosts)
 
244
        except errors.NoSuchRevision, e:
 
245
            raise InstallFailed([self._last_revision])
 
246
 
 
247
    def _fetch_revision_texts(self, revs, pb):
 
248
        # fetch signatures first and then the revision texts
 
249
        # may need to be a InterRevisionStore call here.
 
250
        from_sf = self.from_repository.signatures
 
251
        # A missing signature is just skipped.
 
252
        keys = [(rev_id,) for rev_id in revs]
 
253
        signatures = filter_absent(from_sf.get_record_stream(
 
254
            keys,
 
255
            self.to_repository._fetch_order,
 
256
            not self.to_repository._fetch_uses_deltas))
 
257
        # If a revision has a delta, this is actually expanded inside the
 
258
        # insert_record_stream code now, which is an alternate fix for
 
259
        # bug #261339
 
260
        from_rf = self.from_repository.revisions
 
261
        revisions = from_rf.get_record_stream(
 
262
            keys,
 
263
            self.to_repository._fetch_order,
 
264
            not self.delta_on_metadata())
 
265
        return [('signatures', signatures), ('revisions', revisions)]
 
266
 
 
267
    def _generate_root_texts(self, revs):
 
268
        """This will be called by __fetch between fetching weave texts and
 
269
        fetching the inventory weave.
 
270
 
 
271
        Subclasses should override this if they need to generate root texts
 
272
        after fetching weave texts.
 
273
        """
 
274
        return []
 
275
 
 
276
    def inventory_fetch_order(self):
 
277
        return self.to_repository._fetch_order
 
278
 
 
279
    def delta_on_metadata(self):
 
280
        src_serializer = self.from_repository._format._serializer
 
281
        target_serializer = self.to_repository._format._serializer
 
282
        return (self.to_repository._fetch_uses_deltas and
 
283
            src_serializer == target_serializer)
177
284
 
178
285
 
179
286
class Inter1and2Helper(object):
180
287
    """Helper for operations that convert data from model 1 and 2
181
 
 
 
288
    
182
289
    This is for use by fetchers and converters.
183
290
    """
184
291
 
210
317
 
211
318
    def _find_root_ids(self, revs, parent_map, graph):
212
319
        revision_root = {}
 
320
        planned_versions = {}
213
321
        for tree in self.iter_rev_trees(revs):
214
322
            revision_id = tree.inventory.root.revision
215
323
            root_id = tree.get_root_id()
 
324
            planned_versions.setdefault(root_id, []).append(revision_id)
216
325
            revision_root[revision_id] = root_id
217
326
        # Find out which parents we don't already know root ids for
218
327
        parents = set()
224
333
        for tree in self.iter_rev_trees(parents):
225
334
            root_id = tree.get_root_id()
226
335
            revision_root[tree.get_revision_id()] = root_id
227
 
        return revision_root
 
336
        return revision_root, planned_versions
228
337
 
229
338
    def generate_root_texts(self, revs):
230
339
        """Generate VersionedFiles for all root ids.
233
342
        """
234
343
        graph = self.source.get_graph()
235
344
        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)
 
345
        rev_order = topo_sort(parent_map)
 
346
        rev_id_to_root_id, root_id_to_rev_ids = self._find_root_ids(
 
347
            revs, parent_map, graph)
238
348
        root_id_order = [(rev_id_to_root_id[rev_id], rev_id) for rev_id in
239
349
            rev_order]
240
350
        # Guaranteed stable, this groups all the file id operations together
243
353
        # yet, and are unlikely to in non-rich-root environments anyway.
244
354
        root_id_order.sort(key=operator.itemgetter(0))
245
355
        # 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
 
356
        def yield_roots():
 
357
            for key in root_id_order:
 
358
                root_id, rev_id = key
 
359
                rev_parents = parent_map[rev_id]
 
360
                # We drop revision parents with different file-ids, because
 
361
                # that represents a rename of the root to a different location
 
362
                # - its not actually a parent for us. (We could look for that
 
363
                # file id in the revision tree at considerably more expense,
 
364
                # but for now this is sufficient (and reconcile will catch and
 
365
                # correct this anyway).
 
366
                # When a parent revision is a ghost, we guess that its root id
 
367
                # was unchanged (rather than trimming it from the parent list).
 
368
                parent_keys = tuple((root_id, parent) for parent in rev_parents
 
369
                    if parent != NULL_REVISION and
 
370
                        rev_id_to_root_id.get(parent, root_id) == root_id)
 
371
                yield FulltextContentFactory(key, parent_keys, None, '')
 
372
        return [('texts', yield_roots())]
 
373
 
 
374
 
 
375
class Model1toKnit2Fetcher(RepoFetcher):
 
376
    """Fetch from a Model1 repository into a Knit2 repository
 
377
    """
 
378
    def __init__(self, to_repository, from_repository, last_revision=None,
 
379
                 pb=None, find_ghosts=True):
 
380
        self.helper = Inter1and2Helper(from_repository)
 
381
        RepoFetcher.__init__(self, to_repository, from_repository,
 
382
            last_revision, pb, find_ghosts)
 
383
 
 
384
    def _generate_root_texts(self, revs):
 
385
        return self.helper.generate_root_texts(revs)
 
386
 
 
387
    def inventory_fetch_order(self):
 
388
        return 'topological'
 
389
 
 
390
Knit1to2Fetcher = Model1toKnit2Fetcher