~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/fetch.py

  • Committer: mbp at sourcefrog
  • Date: 2005-03-09 04:08:15 UTC
  • Revision ID: mbp@sourcefrog.net-20050309040815-13242001617e4a06
import from baz patch-364

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
2
 
#
3
 
# This program is free software; you can redistribute it and/or modify
4
 
# it under the terms of the GNU General Public License as published by
5
 
# the Free Software Foundation; either version 2 of the License, or
6
 
# (at your option) any later version.
7
 
#
8
 
# This program is distributed in the hope that it will be useful,
9
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
 
# GNU General Public License for more details.
12
 
#
13
 
# You should have received a copy of the GNU General Public License
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
16
 
 
17
 
 
18
 
"""Copying of history from one branch to another.
19
 
 
20
 
The basic plan is that every branch knows the history of everything
21
 
that has merged into it.  As the first step of a merge, pull, or
22
 
branch operation we copy history from the source into the destination
23
 
branch.
24
 
"""
25
 
 
26
 
import operator
27
 
 
28
 
from bzrlib.lazy_import import lazy_import
29
 
lazy_import(globals(), """
30
 
from bzrlib import (
31
 
    tsort,
32
 
    versionedfile,
33
 
    )
34
 
""")
35
 
import bzrlib
36
 
from bzrlib import (
37
 
    errors,
38
 
    ui,
39
 
    )
40
 
from bzrlib.revision import NULL_REVISION
41
 
from bzrlib.trace import mutter
42
 
 
43
 
 
44
 
class RepoFetcher(object):
45
 
    """Pull revisions and texts from one repository to another.
46
 
 
47
 
    This should not be used directly, it's essential a object to encapsulate
48
 
    the logic in InterRepository.fetch().
49
 
    """
50
 
 
51
 
    def __init__(self, to_repository, from_repository, last_revision=None,
52
 
        find_ghosts=True, fetch_spec=None):
53
 
        """Create a repo fetcher.
54
 
 
55
 
        :param last_revision: If set, try to limit to the data this revision
56
 
            references.
57
 
        :param find_ghosts: If True search the entire history for ghosts.
58
 
        """
59
 
        # repository.fetch has the responsibility for short-circuiting
60
 
        # attempts to copy between a repository and itself.
61
 
        self.to_repository = to_repository
62
 
        self.from_repository = from_repository
63
 
        self.sink = to_repository._get_sink()
64
 
        # must not mutate self._last_revision as its potentially a shared instance
65
 
        self._last_revision = last_revision
66
 
        self._fetch_spec = fetch_spec
67
 
        self.find_ghosts = find_ghosts
68
 
        self.from_repository.lock_read()
69
 
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
70
 
               self.from_repository, self.from_repository._format,
71
 
               self.to_repository, self.to_repository._format)
72
 
        try:
73
 
            self.__fetch()
74
 
        finally:
75
 
            self.from_repository.unlock()
76
 
 
77
 
    def __fetch(self):
78
 
        """Primary worker function.
79
 
 
80
 
        This initialises all the needed variables, and then fetches the
81
 
        requested revisions, finally clearing the progress bar.
82
 
        """
83
 
        # Roughly this is what we're aiming for fetch to become:
84
 
        #
85
 
        # missing = self.sink.insert_stream(self.source.get_stream(search))
86
 
        # if missing:
87
 
        #     missing = self.sink.insert_stream(self.source.get_items(missing))
88
 
        # assert not missing
89
 
        self.count_total = 0
90
 
        self.file_ids_names = {}
91
 
        pb = ui.ui_factory.nested_progress_bar()
92
 
        pb.show_pct = pb.show_count = False
93
 
        try:
94
 
            pb.update("Finding revisions", 0, 2)
95
 
            search = self._revids_to_fetch()
96
 
            if search is None:
97
 
                return
98
 
            pb.update("Fetching revisions", 1, 2)
99
 
            self._fetch_everything_for_search(search)
100
 
        finally:
101
 
            pb.finished()
102
 
 
103
 
    def _fetch_everything_for_search(self, search):
104
 
        """Fetch all data for the given set of revisions."""
105
 
        # The first phase is "file".  We pass the progress bar for it directly
106
 
        # into item_keys_introduced_by, which has more information about how
107
 
        # that phase is progressing than we do.  Progress updates for the other
108
 
        # phases are taken care of in this function.
109
 
        # XXX: there should be a clear owner of the progress reporting.  Perhaps
110
 
        # item_keys_introduced_by should have a richer API than it does at the
111
 
        # moment, so that it can feed the progress information back to this
112
 
        # function?
113
 
        if (self.from_repository._format.rich_root_data and
114
 
            not self.to_repository._format.rich_root_data):
115
 
            raise errors.IncompatibleRepositories(
116
 
                self.from_repository, self.to_repository,
117
 
                "different rich-root support")
118
 
        pb = ui.ui_factory.nested_progress_bar()
119
 
        try:
120
 
            pb.update("Get stream source")
121
 
            source = self.from_repository._get_source(
122
 
                self.to_repository._format)
123
 
            stream = source.get_stream(search)
124
 
            from_format = self.from_repository._format
125
 
            pb.update("Inserting stream")
126
 
            resume_tokens, missing_keys = self.sink.insert_stream(
127
 
                stream, from_format, [])
128
 
            if self.to_repository._fallback_repositories:
129
 
                missing_keys.update(
130
 
                    self._parent_inventories(search.get_keys()))
131
 
            if missing_keys:
132
 
                pb.update("Missing keys")
133
 
                stream = source.get_stream_for_missing_keys(missing_keys)
134
 
                pb.update("Inserting missing keys")
135
 
                resume_tokens, missing_keys = self.sink.insert_stream(
136
 
                    stream, from_format, resume_tokens)
137
 
            if missing_keys:
138
 
                raise AssertionError(
139
 
                    "second push failed to complete a fetch %r." % (
140
 
                        missing_keys,))
141
 
            if resume_tokens:
142
 
                raise AssertionError(
143
 
                    "second push failed to commit the fetch %r." % (
144
 
                        resume_tokens,))
145
 
            pb.update("Finishing stream")
146
 
            self.sink.finished()
147
 
        finally:
148
 
            pb.finished()
149
 
 
150
 
    def _revids_to_fetch(self):
151
 
        """Determines the exact revisions needed from self.from_repository to
152
 
        install self._last_revision in self.to_repository.
153
 
 
154
 
        If no revisions need to be fetched, then this just returns None.
155
 
        """
156
 
        if self._fetch_spec is not None:
157
 
            return self._fetch_spec
158
 
        mutter('fetch up to rev {%s}', self._last_revision)
159
 
        if self._last_revision is NULL_REVISION:
160
 
            # explicit limit of no revisions needed
161
 
            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
177
 
 
178
 
 
179
 
class Inter1and2Helper(object):
180
 
    """Helper for operations that convert data from model 1 and 2
181
 
 
182
 
    This is for use by fetchers and converters.
183
 
    """
184
 
 
185
 
    # This is a class variable so that the test suite can override it.
186
 
    known_graph_threshold = 100
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
 
        for tree in self.iter_rev_trees(revs):
217
 
            revision_id = tree.inventory.root.revision
218
 
            root_id = tree.get_root_id()
219
 
            revision_root[revision_id] = root_id
220
 
        # Find out which parents we don't already know root ids for
221
 
        parents = set()
222
 
        for revision_parents in parent_map.itervalues():
223
 
            parents.update(revision_parents)
224
 
        parents.difference_update(revision_root.keys() + [NULL_REVISION])
225
 
        # Limit to revisions present in the versionedfile
226
 
        parents = graph.get_parent_map(parents).keys()
227
 
        for tree in self.iter_rev_trees(parents):
228
 
            root_id = tree.get_root_id()
229
 
            revision_root[tree.get_revision_id()] = root_id
230
 
        return revision_root
231
 
 
232
 
    def generate_root_texts(self, revs):
233
 
        """Generate VersionedFiles for all root ids.
234
 
 
235
 
        :param revs: the revisions to include
236
 
        """
237
 
        graph = self.source.get_graph()
238
 
        parent_map = graph.get_parent_map(revs)
239
 
        rev_order = tsort.topo_sort(parent_map)
240
 
        rev_id_to_root_id = self._find_root_ids(revs, parent_map, graph)
241
 
        root_id_order = [(rev_id_to_root_id[rev_id], rev_id) for rev_id in
242
 
            rev_order]
243
 
        # Guaranteed stable, this groups all the file id operations together
244
 
        # retaining topological order within the revisions of a file id.
245
 
        # File id splits and joins would invalidate this, but they don't exist
246
 
        # yet, and are unlikely to in non-rich-root environments anyway.
247
 
        root_id_order.sort(key=operator.itemgetter(0))
248
 
        # Create a record stream containing the roots to create.
249
 
        if len(revs) > self.known_graph_threshold:
250
 
            graph = self.source.get_known_graph_ancestry(revs)
251
 
        new_roots_stream = _new_root_data_stream(
252
 
            root_id_order, rev_id_to_root_id, parent_map, self.source, graph)
253
 
        return [('texts', new_roots_stream)]
254
 
 
255
 
 
256
 
def _new_root_data_stream(
257
 
    root_keys_to_create, rev_id_to_root_id_map, parent_map, repo, graph=None):
258
 
    """Generate a texts substream of synthesised root entries.
259
 
 
260
 
    Used in fetches that do rich-root upgrades.
261
 
    
262
 
    :param root_keys_to_create: iterable of (root_id, rev_id) pairs describing
263
 
        the root entries to create.
264
 
    :param rev_id_to_root_id_map: dict of known rev_id -> root_id mappings for
265
 
        calculating the parents.  If a parent rev_id is not found here then it
266
 
        will be recalculated.
267
 
    :param parent_map: a parent map for all the revisions in
268
 
        root_keys_to_create.
269
 
    :param graph: a graph to use instead of repo.get_graph().
270
 
    """
271
 
    for root_key in root_keys_to_create:
272
 
        root_id, rev_id = root_key
273
 
        parent_keys = _parent_keys_for_root_version(
274
 
            root_id, rev_id, rev_id_to_root_id_map, parent_map, repo, graph)
275
 
        yield versionedfile.FulltextContentFactory(
276
 
            root_key, parent_keys, None, '')
277
 
 
278
 
 
279
 
def _parent_keys_for_root_version(
280
 
    root_id, rev_id, rev_id_to_root_id_map, parent_map, repo, graph=None):
281
 
    """Get the parent keys for a given root id.
282
 
    
283
 
    A helper function for _new_root_data_stream.
284
 
    """
285
 
    # Include direct parents of the revision, but only if they used the same
286
 
    # root_id and are heads.
287
 
    rev_parents = parent_map[rev_id]
288
 
    parent_ids = []
289
 
    for parent_id in rev_parents:
290
 
        if parent_id == NULL_REVISION:
291
 
            continue
292
 
        if parent_id not in rev_id_to_root_id_map:
293
 
            # We probably didn't read this revision, go spend the extra effort
294
 
            # to actually check
295
 
            try:
296
 
                tree = repo.revision_tree(parent_id)
297
 
            except errors.NoSuchRevision:
298
 
                # Ghost, fill out rev_id_to_root_id in case we encounter this
299
 
                # again.
300
 
                # But set parent_root_id to None since we don't really know
301
 
                parent_root_id = None
302
 
            else:
303
 
                parent_root_id = tree.get_root_id()
304
 
            rev_id_to_root_id_map[parent_id] = None
305
 
            # XXX: why not:
306
 
            #   rev_id_to_root_id_map[parent_id] = parent_root_id
307
 
            # memory consumption maybe?
308
 
        else:
309
 
            parent_root_id = rev_id_to_root_id_map[parent_id]
310
 
        if root_id == parent_root_id:
311
 
            # With stacking we _might_ want to refer to a non-local revision,
312
 
            # but this code path only applies when we have the full content
313
 
            # available, so ghosts really are ghosts, not just the edge of
314
 
            # local data.
315
 
            parent_ids.append(parent_id)
316
 
        else:
317
 
            # root_id may be in the parent anyway.
318
 
            try:
319
 
                tree = repo.revision_tree(parent_id)
320
 
            except errors.NoSuchRevision:
321
 
                # ghost, can't refer to it.
322
 
                pass
323
 
            else:
324
 
                try:
325
 
                    parent_ids.append(tree.inventory[root_id].revision)
326
 
                except errors.NoSuchId:
327
 
                    # not in the tree
328
 
                    pass
329
 
    # Drop non-head parents
330
 
    if graph is None:
331
 
        graph = repo.get_graph()
332
 
    heads = graph.heads(parent_ids)
333
 
    selected_ids = []
334
 
    for parent_id in parent_ids:
335
 
        if parent_id in heads and parent_id not in selected_ids:
336
 
            selected_ids.append(parent_id)
337
 
    parent_keys = [(root_id, parent_id) for parent_id in selected_ids]
338
 
    return parent_keys