/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/fetch.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-05-05 14:19:49 UTC
  • mfrom: (4211.1.7 interbranch-push)
  • Revision ID: pqm@pqm.ubuntu.com-20090505141949-is3fyloox546i797
(Jelmer) Add InterBranch.push.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006 by Canonical Ltd
2
 
 
 
1
# Copyright (C) 2005, 2006, 2008, 2009 Canonical Ltd
 
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
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, NoSuchRevision,
37
 
                           MissingText)
 
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 ProgressBar, ProgressPhase
40
 
from bzrlib.reconcile import RepoReconciler
41
 
from bzrlib.revision import NULL_REVISION
42
 
from bzrlib.symbol_versioning import *
43
 
 
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
61
 
 
62
 
 
63
 
@deprecated_function(zero_eight)
64
 
def greedy_fetch(to_branch, from_branch, revision=None, pb=None):
65
 
    """Legacy API, please see branch.fetch(from_branch, last_revision, pb)."""
66
 
    f = Fetcher(to_branch, from_branch, revision, pb)
67
 
    return f.count_copied, f.failed_revisions
68
 
 
69
 
fetch = greedy_fetch
 
36
import bzrlib.ui
 
37
from bzrlib.versionedfile import FulltextContentFactory
70
38
 
71
39
 
72
40
class RepoFetcher(object):
73
41
    """Pull revisions and texts from one repository to another.
74
42
 
75
 
    last_revision
76
 
        if set, try to limit to the data this revision references.
77
 
 
78
 
    after running:
79
 
    count_copied -- number of revisions copied
80
 
 
81
 
    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
82
44
    the logic in InterRepository.fetch().
83
45
    """
84
 
    def __init__(self, to_repository, from_repository, last_revision=None, pb=None):
85
 
        # result variables.
86
 
        self.failed_revisions = []
87
 
        self.count_copied = 0
88
 
        if to_repository.control_files._transport.base == from_repository.control_files._transport.base:
89
 
            # check that last_revision is in 'from' and then return a no-operation.
90
 
            if last_revision not in (None, NULL_REVISION):
91
 
                from_repository.get_revision(last_revision)
92
 
            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 _write_group_acquired_callable: Don't use; this parameter only
 
55
            exists to facilitate a hack done in InterPackRepo.fetch.  We would
 
56
            like to remove this parameter.
 
57
        :param pb: ProgressBar object to use; deprecated and ignored.
 
58
            This method will just create one on top of the stack.
 
59
        """
 
60
        if pb is not None:
 
61
            symbol_versioning.warn(
 
62
                symbol_versioning.deprecated_in((1, 14, 0))
 
63
                % "pb parameter to RepoFetcher.__init__")
 
64
            # and for simplicity it is in fact ignored
 
65
        if to_repository.has_same_location(from_repository):
 
66
            # repository.fetch should be taking care of this case.
 
67
            raise errors.BzrError('RepoFetcher run '
 
68
                    'between two objects at the same location: '
 
69
                    '%r and %r' % (to_repository, from_repository))
93
70
        self.to_repository = to_repository
94
71
        self.from_repository = from_repository
 
72
        self.sink = to_repository._get_sink()
95
73
        # must not mutate self._last_revision as its potentially a shared instance
96
74
        self._last_revision = last_revision
97
 
        if pb is None:
98
 
            self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
99
 
            self.nested_pb = self.pb
100
 
        else:
101
 
            self.pb = pb
102
 
            self.nested_pb = None
 
75
        self._fetch_spec = fetch_spec
 
76
        self.find_ghosts = find_ghosts
103
77
        self.from_repository.lock_read()
 
78
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
79
               self.from_repository, self.from_repository._format,
 
80
               self.to_repository, self.to_repository._format)
104
81
        try:
105
 
            self.to_repository.lock_write()
106
 
            try:
107
 
                self.__fetch()
108
 
            finally:
109
 
                if self.nested_pb is not None:
110
 
                    self.nested_pb.finished()
111
 
                self.to_repository.unlock()
 
82
            self.__fetch()
112
83
        finally:
113
84
            self.from_repository.unlock()
114
85
 
115
86
    def __fetch(self):
116
87
        """Primary worker function.
117
88
 
118
 
        This initialises all the needed variables, and then fetches the 
 
89
        This initialises all the needed variables, and then fetches the
119
90
        requested revisions, finally clearing the progress bar.
120
91
        """
121
 
        self.to_weaves = self.to_repository.weave_store
122
 
        self.to_control = self.to_repository.control_weaves
123
 
        self.from_weaves = self.from_repository.weave_store
124
 
        self.from_control = self.from_repository.control_weaves
 
92
        # Roughly this is what we're aiming for fetch to become:
 
93
        #
 
94
        # missing = self.sink.insert_stream(self.source.get_stream(search))
 
95
        # if missing:
 
96
        #     missing = self.sink.insert_stream(self.source.get_items(missing))
 
97
        # assert not missing
125
98
        self.count_total = 0
126
99
        self.file_ids_names = {}
127
 
        pp = ProgressPhase('fetch phase', 4, self.pb)
128
 
        try:
129
 
            revs = self._revids_to_fetch()
130
 
            # something to do ?
131
 
            if revs:
132
 
                pp.next_phase()
133
 
                self._fetch_weave_texts(revs)
134
 
                pp.next_phase()
135
 
                self._fetch_inventory_weave(revs)
136
 
                pp.next_phase()
137
 
                self._fetch_revision_texts(revs)
138
 
                self.count_copied += len(revs)
139
 
        finally:
140
 
            self.pb.clear()
 
100
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
101
        pb.show_pct = pb.show_count = False
 
102
        try:
 
103
            pb.update("Finding revisions", 0, 2)
 
104
            search = self._revids_to_fetch()
 
105
            if search is None:
 
106
                return
 
107
            pb.update("Fetching revisions", 1, 2)
 
108
            self._fetch_everything_for_search(search)
 
109
        finally:
 
110
            pb.finished()
 
111
 
 
112
    def _fetch_everything_for_search(self, search):
 
113
        """Fetch all data for the given set of revisions."""
 
114
        # The first phase is "file".  We pass the progress bar for it directly
 
115
        # into item_keys_introduced_by, which has more information about how
 
116
        # that phase is progressing than we do.  Progress updates for the other
 
117
        # phases are taken care of in this function.
 
118
        # XXX: there should be a clear owner of the progress reporting.  Perhaps
 
119
        # item_keys_introduced_by should have a richer API than it does at the
 
120
        # moment, so that it can feed the progress information back to this
 
121
        # function?
 
122
        if (self.from_repository._format.rich_root_data and
 
123
            not self.to_repository._format.rich_root_data):
 
124
            raise errors.IncompatibleRepositories(
 
125
                self.from_repository, self.to_repository,
 
126
                "different rich-root support")
 
127
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
128
        try:
 
129
            pb.update("Get stream source")
 
130
            source = self.from_repository._get_source(
 
131
                self.to_repository._format)
 
132
            stream = source.get_stream(search)
 
133
            from_format = self.from_repository._format
 
134
            pb.update("Inserting stream")
 
135
            resume_tokens, missing_keys = self.sink.insert_stream(
 
136
                stream, from_format, [])
 
137
            if self.to_repository._fallback_repositories:
 
138
                missing_keys.update(
 
139
                    self._parent_inventories(search.get_keys()))
 
140
            if missing_keys:
 
141
                pb.update("Missing keys")
 
142
                stream = source.get_stream_for_missing_keys(missing_keys)
 
143
                pb.update("Inserting missing keys")
 
144
                resume_tokens, missing_keys = self.sink.insert_stream(
 
145
                    stream, from_format, resume_tokens)
 
146
            if missing_keys:
 
147
                raise AssertionError(
 
148
                    "second push failed to complete a fetch %r." % (
 
149
                        missing_keys,))
 
150
            if resume_tokens:
 
151
                raise AssertionError(
 
152
                    "second push failed to commit the fetch %r." % (
 
153
                        resume_tokens,))
 
154
            pb.update("Finishing stream")
 
155
            self.sink.finished()
 
156
        finally:
 
157
            pb.finished()
141
158
 
142
159
    def _revids_to_fetch(self):
 
160
        """Determines the exact revisions needed from self.from_repository to
 
161
        install self._last_revision in self.to_repository.
 
162
 
 
163
        If no revisions need to be fetched, then this just returns None.
 
164
        """
 
165
        if self._fetch_spec is not None:
 
166
            return self._fetch_spec
143
167
        mutter('fetch up to rev {%s}', self._last_revision)
144
168
        if self._last_revision is NULL_REVISION:
145
169
            # explicit limit of no revisions needed
146
170
            return None
147
 
        if (self._last_revision != None and
148
 
            self.to_repository.has_revision(self._last_revision)):
149
 
            return None
150
 
            
151
 
        try:
152
 
            return self.to_repository.missing_revision_ids(self.from_repository,
153
 
                                                           self._last_revision)
154
 
        except errors.NoSuchRevision:
155
 
            raise InstallFailed([self._last_revision])
156
 
 
157
 
    def _fetch_weave_texts(self, revs):
158
 
        texts_pb = bzrlib.ui.ui_factory.nested_progress_bar()
159
 
        try:
160
 
            file_ids = self.from_repository.fileid_involved_by_set(revs)
161
 
            count = 0
162
 
            num_file_ids = len(file_ids)
163
 
            for file_id in file_ids:
164
 
                texts_pb.update("fetch texts", count, num_file_ids)
165
 
                count +=1
166
 
                try:
167
 
                    to_weave = self.to_weaves.get_weave(file_id,
168
 
                        self.to_repository.get_transaction())
169
 
                except errors.NoSuchFile:
170
 
                    # destination is empty, just copy it.
171
 
                    # this copies all the texts, which is useful and 
172
 
                    # on per-file basis quite cheap.
173
 
                    self.to_weaves.copy_multi(
174
 
                        self.from_weaves,
175
 
                        [file_id],
176
 
                        None,
177
 
                        self.from_repository.get_transaction(),
178
 
                        self.to_repository.get_transaction())
179
 
                else:
180
 
                    # destination has contents, must merge
181
 
                    from_weave = self.from_weaves.get_weave(file_id,
182
 
                        self.from_repository.get_transaction())
183
 
                    # we fetch all the texts, because texts do
184
 
                    # not reference anything, and its cheap enough
185
 
                    to_weave.join(from_weave)
186
 
        finally:
187
 
            texts_pb.finished()
188
 
 
189
 
    def _fetch_inventory_weave(self, revs):
190
 
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
191
 
        try:
192
 
            pb.update("fetch inventory", 0, 2)
193
 
            to_weave = self.to_control.get_weave('inventory',
194
 
                    self.to_repository.get_transaction())
195
 
    
196
 
            child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
197
 
            try:
198
 
                # just merge, this is optimisable and its means we dont
199
 
                # copy unreferenced data such as not-needed inventories.
200
 
                pb.update("fetch inventory", 1, 3)
201
 
                from_weave = self.from_repository.get_inventory_weave()
202
 
                pb.update("fetch inventory", 2, 3)
203
 
                # we fetch only the referenced inventories because we do not
204
 
                # know for unselected inventories whether all their required
205
 
                # texts are present in the other repository - it could be
206
 
                # corrupt.
207
 
                to_weave.join(from_weave, pb=child_pb, msg='merge inventory',
208
 
                              version_ids=revs)
209
 
            finally:
210
 
                child_pb.finished()
211
 
        finally:
212
 
            pb.finished()
213
 
 
214
 
 
215
 
class GenericRepoFetcher(RepoFetcher):
216
 
    """This is a generic repo to repo fetcher.
217
 
 
218
 
    This makes minimal assumptions about repo layout and contents.
219
 
    It triggers a reconciliation after fetching to ensure integrity.
220
 
    """
221
 
 
222
 
    def _fetch_revision_texts(self, revs):
223
 
        """Fetch revision object texts"""
224
 
        rev_pb = bzrlib.ui.ui_factory.nested_progress_bar()
225
 
        try:
226
 
            to_txn = self.to_transaction = self.to_repository.get_transaction()
227
 
            count = 0
228
 
            total = len(revs)
229
 
            to_store = self.to_repository._revision_store
230
 
            for rev in revs:
231
 
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
232
 
                try:
233
 
                    pb.update('copying revisions', count, total)
234
 
                    try:
235
 
                        sig_text = self.from_repository.get_signature_text(rev)
236
 
                        to_store.add_revision_signature_text(rev, sig_text, to_txn)
237
 
                    except errors.NoSuchRevision:
238
 
                        # not signed.
239
 
                        pass
240
 
                    to_store.add_revision(self.from_repository.get_revision(rev),
241
 
                                          to_txn)
242
 
                    count += 1
243
 
                finally:
244
 
                    pb.finished()
245
 
            # fixup inventory if needed: 
246
 
            # this is expensive because we have no inverse index to current ghosts.
247
 
            # but on local disk its a few seconds and sftp push is already insane.
248
 
            # so we just-do-it.
249
 
            # FIXME: repository should inform if this is needed.
250
 
            self.to_repository.reconcile()
251
 
        finally:
252
 
            rev_pb.finished()
253
 
    
254
 
 
255
 
class KnitRepoFetcher(RepoFetcher):
256
 
    """This is a knit format repository specific fetcher.
257
 
 
258
 
    This differs from the GenericRepoFetcher by not doing a 
259
 
    reconciliation after copying, and using knit joining to
260
 
    copy revision texts.
261
 
    """
262
 
 
263
 
    def _fetch_revision_texts(self, revs):
264
 
        # may need to be a InterRevisionStore call here.
265
 
        from_transaction = self.from_repository.get_transaction()
266
 
        to_transaction = self.to_repository.get_transaction()
267
 
        to_sf = self.to_repository._revision_store.get_signature_file(
268
 
            to_transaction)
269
 
        from_sf = self.from_repository._revision_store.get_signature_file(
270
 
            from_transaction)
271
 
        to_sf.join(from_sf, version_ids=revs, ignore_missing=True)
272
 
        to_rf = self.to_repository._revision_store.get_revision_file(
273
 
            to_transaction)
274
 
        from_rf = self.from_repository._revision_store.get_revision_file(
275
 
            from_transaction)
276
 
        to_rf.join(from_rf, version_ids=revs)
277
 
 
278
 
 
279
 
class Fetcher(object):
280
 
    """Backwards compatability glue for branch.fetch()."""
281
 
 
282
 
    @deprecated_method(zero_eight)
283
 
    def __init__(self, to_branch, from_branch, last_revision=None, pb=None):
284
 
        """Please see branch.fetch()."""
285
 
        to_branch.fetch(from_branch, last_revision, pb)
 
171
        return self.to_repository.search_missing_revision_ids(
 
172
            self.from_repository, self._last_revision,
 
173
            find_ghosts=self.find_ghosts)
 
174
 
 
175
    def _parent_inventories(self, revision_ids):
 
176
        # Find all the parent revisions referenced by the stream, but
 
177
        # not present in the stream, and make sure we send their
 
178
        # inventories.
 
179
        parent_maps = self.to_repository.get_parent_map(revision_ids)
 
180
        parents = set()
 
181
        map(parents.update, parent_maps.itervalues())
 
182
        parents.discard(NULL_REVISION)
 
183
        parents.difference_update(revision_ids)
 
184
        missing_keys = set(('inventories', rev_id) for rev_id in parents)
 
185
        return missing_keys
 
186
 
 
187
 
 
188
class Inter1and2Helper(object):
 
189
    """Helper for operations that convert data from model 1 and 2
 
190
 
 
191
    This is for use by fetchers and converters.
 
192
    """
 
193
 
 
194
    def __init__(self, source):
 
195
        """Constructor.
 
196
 
 
197
        :param source: The repository data comes from
 
198
        """
 
199
        self.source = source
 
200
 
 
201
    def iter_rev_trees(self, revs):
 
202
        """Iterate through RevisionTrees efficiently.
 
203
 
 
204
        Additionally, the inventory's revision_id is set if unset.
 
205
 
 
206
        Trees are retrieved in batches of 100, and then yielded in the order
 
207
        they were requested.
 
208
 
 
209
        :param revs: A list of revision ids
 
210
        """
 
211
        # In case that revs is not a list.
 
212
        revs = list(revs)
 
213
        while revs:
 
214
            for tree in self.source.revision_trees(revs[:100]):
 
215
                if tree.inventory.revision_id is None:
 
216
                    tree.inventory.revision_id = tree.get_revision_id()
 
217
                yield tree
 
218
            revs = revs[100:]
 
219
 
 
220
    def _find_root_ids(self, revs, parent_map, graph):
 
221
        revision_root = {}
 
222
        planned_versions = {}
 
223
        for tree in self.iter_rev_trees(revs):
 
224
            revision_id = tree.inventory.root.revision
 
225
            root_id = tree.get_root_id()
 
226
            planned_versions.setdefault(root_id, []).append(revision_id)
 
227
            revision_root[revision_id] = root_id
 
228
        # Find out which parents we don't already know root ids for
 
229
        parents = set()
 
230
        for revision_parents in parent_map.itervalues():
 
231
            parents.update(revision_parents)
 
232
        parents.difference_update(revision_root.keys() + [NULL_REVISION])
 
233
        # Limit to revisions present in the versionedfile
 
234
        parents = graph.get_parent_map(parents).keys()
 
235
        for tree in self.iter_rev_trees(parents):
 
236
            root_id = tree.get_root_id()
 
237
            revision_root[tree.get_revision_id()] = root_id
 
238
        return revision_root, planned_versions
 
239
 
 
240
    def generate_root_texts(self, revs):
 
241
        """Generate VersionedFiles for all root ids.
 
242
 
 
243
        :param revs: the revisions to include
 
244
        """
 
245
        graph = self.source.get_graph()
 
246
        parent_map = graph.get_parent_map(revs)
 
247
        rev_order = topo_sort(parent_map)
 
248
        rev_id_to_root_id, root_id_to_rev_ids = self._find_root_ids(
 
249
            revs, parent_map, graph)
 
250
        root_id_order = [(rev_id_to_root_id[rev_id], rev_id) for rev_id in
 
251
            rev_order]
 
252
        # Guaranteed stable, this groups all the file id operations together
 
253
        # retaining topological order within the revisions of a file id.
 
254
        # File id splits and joins would invalidate this, but they don't exist
 
255
        # yet, and are unlikely to in non-rich-root environments anyway.
 
256
        root_id_order.sort(key=operator.itemgetter(0))
 
257
        # Create a record stream containing the roots to create.
 
258
        def yield_roots():
 
259
            for key in root_id_order:
 
260
                root_id, rev_id = key
 
261
                rev_parents = parent_map[rev_id]
 
262
                # We drop revision parents with different file-ids, because
 
263
                # that represents a rename of the root to a different location
 
264
                # - its not actually a parent for us. (We could look for that
 
265
                # file id in the revision tree at considerably more expense,
 
266
                # but for now this is sufficient (and reconcile will catch and
 
267
                # correct this anyway).
 
268
                # When a parent revision is a ghost, we guess that its root id
 
269
                # was unchanged (rather than trimming it from the parent list).
 
270
                parent_keys = tuple((root_id, parent) for parent in rev_parents
 
271
                    if parent != NULL_REVISION and
 
272
                        rev_id_to_root_id.get(parent, root_id) == root_id)
 
273
                yield FulltextContentFactory(key, parent_keys, None, '')
 
274
        return [('texts', yield_roots())]