~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/fetch.py

  • Committer: Martin Pool
  • Date: 2009-09-14 01:19:11 UTC
  • mto: This revision was merged to the branch mainline in revision 4688.
  • Revision ID: mbp@sourcefrog.net-20090914011911-llu9ujul97k8f8s7
News for fix of 406113

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006 by Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2008, 2009 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
 
34
28
import bzrlib
35
 
import bzrlib.errors as errors
36
 
from bzrlib.errors import (InstallFailed,
37
 
                           )
 
29
from bzrlib import (
 
30
    errors,
 
31
    symbol_versioning,
 
32
    )
 
33
from bzrlib.revision import NULL_REVISION
 
34
from bzrlib.tsort import topo_sort
38
35
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
 
36
import bzrlib.ui
 
37
from bzrlib.versionedfile import FulltextContentFactory
72
38
 
73
39
 
74
40
class RepoFetcher(object):
75
41
    """Pull revisions and texts from one repository to another.
76
42
 
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
 
43
    This should not be used directly, it's essential a object to encapsulate
84
44
    the logic in InterRepository.fetch().
85
45
    """
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
 
46
 
 
47
    def __init__(self, to_repository, from_repository, last_revision=None,
 
48
        pb=None, find_ghosts=True, fetch_spec=None):
 
49
        """Create a repo fetcher.
 
50
 
 
51
        :param last_revision: If set, try to limit to the data this revision
 
52
            references.
 
53
        :param find_ghosts: If True search the entire history for ghosts.
 
54
        :param pb: ProgressBar object to use; deprecated and ignored.
 
55
            This method will just create one on top of the stack.
 
56
        """
 
57
        if pb is not None:
 
58
            symbol_versioning.warn(
 
59
                symbol_versioning.deprecated_in((1, 14, 0))
 
60
                % "pb parameter to RepoFetcher.__init__")
 
61
            # and for simplicity it is in fact ignored
 
62
        # repository.fetch has the responsibility for short-circuiting
 
63
        # attempts to copy between a repository and itself.
95
64
        self.to_repository = to_repository
96
65
        self.from_repository = from_repository
 
66
        self.sink = to_repository._get_sink()
97
67
        # must not mutate self._last_revision as its potentially a shared instance
98
68
        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
 
69
        self._fetch_spec = fetch_spec
 
70
        self.find_ghosts = find_ghosts
105
71
        self.from_repository.lock_read()
 
72
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
73
               self.from_repository, self.from_repository._format,
 
74
               self.to_repository, self.to_repository._format)
106
75
        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()
 
76
            self.__fetch()
114
77
        finally:
115
78
            self.from_repository.unlock()
116
79
 
117
80
    def __fetch(self):
118
81
        """Primary worker function.
119
82
 
120
 
        This initialises all the needed variables, and then fetches the 
 
83
        This initialises all the needed variables, and then fetches the
121
84
        requested revisions, finally clearing the progress bar.
122
85
        """
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
 
86
        # Roughly this is what we're aiming for fetch to become:
 
87
        #
 
88
        # missing = self.sink.insert_stream(self.source.get_stream(search))
 
89
        # if missing:
 
90
        #     missing = self.sink.insert_stream(self.source.get_items(missing))
 
91
        # assert not missing
127
92
        self.count_total = 0
128
93
        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()
 
94
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
95
        pb.show_pct = pb.show_count = False
 
96
        try:
 
97
            pb.update("Finding revisions", 0, 2)
 
98
            search = self._revids_to_fetch()
 
99
            if search is None:
 
100
                return
 
101
            pb.update("Fetching revisions", 1, 2)
 
102
            self._fetch_everything_for_search(search)
 
103
        finally:
 
104
            pb.finished()
 
105
 
 
106
    def _fetch_everything_for_search(self, search):
 
107
        """Fetch all data for the given set of revisions."""
 
108
        # The first phase is "file".  We pass the progress bar for it directly
 
109
        # into item_keys_introduced_by, which has more information about how
 
110
        # that phase is progressing than we do.  Progress updates for the other
 
111
        # phases are taken care of in this function.
 
112
        # XXX: there should be a clear owner of the progress reporting.  Perhaps
 
113
        # item_keys_introduced_by should have a richer API than it does at the
 
114
        # moment, so that it can feed the progress information back to this
 
115
        # function?
 
116
        if (self.from_repository._format.rich_root_data and
 
117
            not self.to_repository._format.rich_root_data):
 
118
            raise errors.IncompatibleRepositories(
 
119
                self.from_repository, self.to_repository,
 
120
                "different rich-root support")
 
121
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
122
        try:
 
123
            pb.update("Get stream source")
 
124
            source = self.from_repository._get_source(
 
125
                self.to_repository._format)
 
126
            stream = source.get_stream(search)
 
127
            from_format = self.from_repository._format
 
128
            pb.update("Inserting stream")
 
129
            resume_tokens, missing_keys = self.sink.insert_stream(
 
130
                stream, from_format, [])
 
131
            if self.to_repository._fallback_repositories:
 
132
                missing_keys.update(
 
133
                    self._parent_inventories(search.get_keys()))
 
134
            if missing_keys:
 
135
                pb.update("Missing keys")
 
136
                stream = source.get_stream_for_missing_keys(missing_keys)
 
137
                pb.update("Inserting missing keys")
 
138
                resume_tokens, missing_keys = self.sink.insert_stream(
 
139
                    stream, from_format, resume_tokens)
 
140
            if missing_keys:
 
141
                raise AssertionError(
 
142
                    "second push failed to complete a fetch %r." % (
 
143
                        missing_keys,))
 
144
            if resume_tokens:
 
145
                raise AssertionError(
 
146
                    "second push failed to commit the fetch %r." % (
 
147
                        resume_tokens,))
 
148
            pb.update("Finishing stream")
 
149
            self.sink.finished()
 
150
        finally:
 
151
            pb.finished()
144
152
 
145
153
    def _revids_to_fetch(self):
 
154
        """Determines the exact revisions needed from self.from_repository to
 
155
        install self._last_revision in self.to_repository.
 
156
 
 
157
        If no revisions need to be fetched, then this just returns None.
 
158
        """
 
159
        if self._fetch_spec is not None:
 
160
            return self._fetch_spec
146
161
        mutter('fetch up to rev {%s}', self._last_revision)
147
162
        if self._last_revision is NULL_REVISION:
148
163
            # explicit limit of no revisions needed
149
164
            return None
150
 
        if (self._last_revision != 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)
282
 
 
283
 
 
284
 
class Fetcher(object):
285
 
    """Backwards compatibility glue for branch.fetch()."""
286
 
 
287
 
    @deprecated_method(zero_eight)
288
 
    def __init__(self, to_branch, from_branch, last_revision=None, pb=None):
289
 
        """Please see branch.fetch()."""
290
 
        to_branch.fetch(from_branch, last_revision, pb)
 
165
        return self.to_repository.search_missing_revision_ids(
 
166
            self.from_repository, self._last_revision,
 
167
            find_ghosts=self.find_ghosts)
 
168
 
 
169
    def _parent_inventories(self, revision_ids):
 
170
        # Find all the parent revisions referenced by the stream, but
 
171
        # not present in the stream, and make sure we send their
 
172
        # inventories.
 
173
        parent_maps = self.to_repository.get_parent_map(revision_ids)
 
174
        parents = set()
 
175
        map(parents.update, parent_maps.itervalues())
 
176
        parents.discard(NULL_REVISION)
 
177
        parents.difference_update(revision_ids)
 
178
        missing_keys = set(('inventories', rev_id) for rev_id in parents)
 
179
        return missing_keys
 
180
 
 
181
 
 
182
class Inter1and2Helper(object):
 
183
    """Helper for operations that convert data from model 1 and 2
 
184
 
 
185
    This is for use by fetchers and converters.
 
186
    """
 
187
 
 
188
    def __init__(self, source):
 
189
        """Constructor.
 
190
 
 
191
        :param source: The repository data comes from
 
192
        """
 
193
        self.source = source
 
194
 
 
195
    def iter_rev_trees(self, revs):
 
196
        """Iterate through RevisionTrees efficiently.
 
197
 
 
198
        Additionally, the inventory's revision_id is set if unset.
 
199
 
 
200
        Trees are retrieved in batches of 100, and then yielded in the order
 
201
        they were requested.
 
202
 
 
203
        :param revs: A list of revision ids
 
204
        """
 
205
        # In case that revs is not a list.
 
206
        revs = list(revs)
 
207
        while revs:
 
208
            for tree in self.source.revision_trees(revs[:100]):
 
209
                if tree.inventory.revision_id is None:
 
210
                    tree.inventory.revision_id = tree.get_revision_id()
 
211
                yield tree
 
212
            revs = revs[100:]
 
213
 
 
214
    def _find_root_ids(self, revs, parent_map, graph):
 
215
        revision_root = {}
 
216
        planned_versions = {}
 
217
        for tree in self.iter_rev_trees(revs):
 
218
            revision_id = tree.inventory.root.revision
 
219
            root_id = tree.get_root_id()
 
220
            planned_versions.setdefault(root_id, []).append(revision_id)
 
221
            revision_root[revision_id] = root_id
 
222
        # Find out which parents we don't already know root ids for
 
223
        parents = set()
 
224
        for revision_parents in parent_map.itervalues():
 
225
            parents.update(revision_parents)
 
226
        parents.difference_update(revision_root.keys() + [NULL_REVISION])
 
227
        # Limit to revisions present in the versionedfile
 
228
        parents = graph.get_parent_map(parents).keys()
 
229
        for tree in self.iter_rev_trees(parents):
 
230
            root_id = tree.get_root_id()
 
231
            revision_root[tree.get_revision_id()] = root_id
 
232
        return revision_root, planned_versions
 
233
 
 
234
    def generate_root_texts(self, revs):
 
235
        """Generate VersionedFiles for all root ids.
 
236
 
 
237
        :param revs: the revisions to include
 
238
        """
 
239
        graph = self.source.get_graph()
 
240
        parent_map = graph.get_parent_map(revs)
 
241
        rev_order = topo_sort(parent_map)
 
242
        rev_id_to_root_id, root_id_to_rev_ids = self._find_root_ids(
 
243
            revs, parent_map, graph)
 
244
        root_id_order = [(rev_id_to_root_id[rev_id], rev_id) for rev_id in
 
245
            rev_order]
 
246
        # Guaranteed stable, this groups all the file id operations together
 
247
        # retaining topological order within the revisions of a file id.
 
248
        # File id splits and joins would invalidate this, but they don't exist
 
249
        # yet, and are unlikely to in non-rich-root environments anyway.
 
250
        root_id_order.sort(key=operator.itemgetter(0))
 
251
        # Create a record stream containing the roots to create.
 
252
        def yield_roots():
 
253
            for key in root_id_order:
 
254
                root_id, rev_id = key
 
255
                rev_parents = parent_map[rev_id]
 
256
                # We drop revision parents with different file-ids, because
 
257
                # that represents a rename of the root to a different location
 
258
                # - its not actually a parent for us. (We could look for that
 
259
                # file id in the revision tree at considerably more expense,
 
260
                # but for now this is sufficient (and reconcile will catch and
 
261
                # correct this anyway).
 
262
                # When a parent revision is a ghost, we guess that its root id
 
263
                # was unchanged (rather than trimming it from the parent list).
 
264
                parent_keys = tuple((root_id, parent) for parent in rev_parents
 
265
                    if parent != NULL_REVISION and
 
266
                        rev_id_to_root_id.get(parent, root_id) == root_id)
 
267
                yield FulltextContentFactory(key, parent_keys, None, '')
 
268
        return [('texts', yield_roots())]