~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/fetch.py

  • Committer: Martin Pool
  • Date: 2009-03-18 02:17:57 UTC
  • mto: (4070.11.9 249908-doc-generate)
  • mto: This revision was merged to the branch mainline in revision 4165.
  • Revision ID: mbp@sourcefrog.net-20090318021757-k72mahr4tjxk9i2v
Quote URL scheme to stop ReST linkifying it

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2008, 2009 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
 
    graph as _mod_graph,
32
 
    static_tuple,
33
 
    tsort,
34
 
    versionedfile,
35
 
    )
36
 
""")
37
35
import bzrlib
38
 
from bzrlib import (
39
 
    errors,
40
 
    symbol_versioning,
41
 
    ui,
42
 
    )
 
36
import bzrlib.errors as errors
 
37
from bzrlib.errors import InstallFailed
 
38
from bzrlib.progress import ProgressPhase
43
39
from bzrlib.revision import NULL_REVISION
 
40
from bzrlib.tsort import topo_sort
44
41
from bzrlib.trace import mutter
 
42
import bzrlib.ui
 
43
from bzrlib.versionedfile import 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
45
61
 
46
62
 
47
63
class RepoFetcher(object):
48
64
    """Pull revisions and texts from one repository to another.
49
65
 
 
66
    last_revision
 
67
        if set, try to limit to the data this revision references.
 
68
 
50
69
    This should not be used directly, it's essential a object to encapsulate
51
70
    the logic in InterRepository.fetch().
52
71
    """
53
72
 
54
 
    def __init__(self, to_repository, from_repository, last_revision=None,
55
 
        pb=None, find_ghosts=True, fetch_spec=None):
 
73
    def __init__(self, to_repository, from_repository, last_revision=None, pb=None,
 
74
        find_ghosts=True):
56
75
        """Create a repo fetcher.
57
76
 
58
 
        :param last_revision: If set, try to limit to the data this revision
59
 
            references.
60
77
        :param find_ghosts: If True search the entire history for ghosts.
61
 
        :param pb: ProgressBar object to use; deprecated and ignored.
62
 
            This method will just create one on top of the stack.
 
78
        :param _write_group_acquired_callable: Don't use; this parameter only
 
79
            exists to facilitate a hack done in InterPackRepo.fetch.  We would
 
80
            like to remove this parameter.
63
81
        """
64
 
        if pb is not None:
65
 
            symbol_versioning.warn(
66
 
                symbol_versioning.deprecated_in((1, 14, 0))
67
 
                % "pb parameter to RepoFetcher.__init__")
68
 
            # and for simplicity it is in fact ignored
69
 
        # repository.fetch has the responsibility for short-circuiting
70
 
        # attempts to copy between a repository and itself.
 
82
        if to_repository.has_same_location(from_repository):
 
83
            # repository.fetch should be taking care of this case.
 
84
            raise errors.BzrError('RepoFetcher run '
 
85
                    'between two objects at the same location: '
 
86
                    '%r and %r' % (to_repository, from_repository))
71
87
        self.to_repository = to_repository
72
88
        self.from_repository = from_repository
73
89
        self.sink = to_repository._get_sink()
74
90
        # must not mutate self._last_revision as its potentially a shared instance
75
91
        self._last_revision = last_revision
76
 
        self._fetch_spec = fetch_spec
77
92
        self.find_ghosts = find_ghosts
 
93
        if pb is None:
 
94
            self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
95
            self.nested_pb = self.pb
 
96
        else:
 
97
            self.pb = pb
 
98
            self.nested_pb = None
78
99
        self.from_repository.lock_read()
79
 
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
80
 
               self.from_repository, self.from_repository._format,
81
 
               self.to_repository, self.to_repository._format)
82
100
        try:
83
 
            self.__fetch()
 
101
            try:
 
102
                self.__fetch()
 
103
            finally:
 
104
                if self.nested_pb is not None:
 
105
                    self.nested_pb.finished()
84
106
        finally:
85
107
            self.from_repository.unlock()
86
108
 
98
120
        # assert not missing
99
121
        self.count_total = 0
100
122
        self.file_ids_names = {}
101
 
        pb = ui.ui_factory.nested_progress_bar()
102
 
        pb.show_pct = pb.show_count = False
 
123
        pp = ProgressPhase('Transferring', 4, self.pb)
103
124
        try:
104
 
            pb.update("Finding revisions", 0, 2)
 
125
            pp.next_phase()
105
126
            search = self._revids_to_fetch()
106
127
            if search is None:
107
128
                return
108
 
            pb.update("Fetching revisions", 1, 2)
109
 
            self._fetch_everything_for_search(search)
 
129
            self._fetch_everything_for_search(search, pp)
110
130
        finally:
111
 
            pb.finished()
 
131
            self.pb.clear()
112
132
 
113
 
    def _fetch_everything_for_search(self, search):
 
133
    def _fetch_everything_for_search(self, search, pp):
114
134
        """Fetch all data for the given set of revisions."""
115
135
        # The first phase is "file".  We pass the progress bar for it directly
116
136
        # into item_keys_introduced_by, which has more information about how
125
145
            raise errors.IncompatibleRepositories(
126
146
                self.from_repository, self.to_repository,
127
147
                "different rich-root support")
128
 
        pb = ui.ui_factory.nested_progress_bar()
 
148
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
129
149
        try:
130
 
            pb.update("Get stream source")
131
150
            source = self.from_repository._get_source(
132
151
                self.to_repository._format)
133
152
            stream = source.get_stream(search)
134
153
            from_format = self.from_repository._format
135
 
            pb.update("Inserting stream")
136
154
            resume_tokens, missing_keys = self.sink.insert_stream(
137
155
                stream, from_format, [])
138
 
            if self.to_repository._fallback_repositories:
139
 
                missing_keys.update(
140
 
                    self._parent_inventories(search.get_keys()))
141
156
            if missing_keys:
142
 
                pb.update("Missing keys")
143
157
                stream = source.get_stream_for_missing_keys(missing_keys)
144
 
                pb.update("Inserting missing keys")
145
158
                resume_tokens, missing_keys = self.sink.insert_stream(
146
159
                    stream, from_format, resume_tokens)
147
160
            if missing_keys:
152
165
                raise AssertionError(
153
166
                    "second push failed to commit the fetch %r." % (
154
167
                        resume_tokens,))
155
 
            pb.update("Finishing stream")
156
168
            self.sink.finished()
157
169
        finally:
158
 
            pb.finished()
 
170
            if self.pb is not None:
 
171
                self.pb.finished()
159
172
 
160
173
    def _revids_to_fetch(self):
161
174
        """Determines the exact revisions needed from self.from_repository to
163
176
 
164
177
        If no revisions need to be fetched, then this just returns None.
165
178
        """
166
 
        if self._fetch_spec is not None:
167
 
            return self._fetch_spec
168
179
        mutter('fetch up to rev {%s}', self._last_revision)
169
180
        if self._last_revision is NULL_REVISION:
170
181
            # explicit limit of no revisions needed
171
182
            return None
172
 
        return self.to_repository.search_missing_revision_ids(
173
 
            self.from_repository, self._last_revision,
174
 
            find_ghosts=self.find_ghosts)
175
 
 
176
 
    def _parent_inventories(self, revision_ids):
177
 
        # Find all the parent revisions referenced by the stream, but
178
 
        # not present in the stream, and make sure we send their
179
 
        # inventories.
180
 
        parent_maps = self.to_repository.get_parent_map(revision_ids)
181
 
        parents = set()
182
 
        map(parents.update, parent_maps.itervalues())
183
 
        parents.discard(NULL_REVISION)
184
 
        parents.difference_update(revision_ids)
185
 
        missing_keys = set(('inventories', rev_id) for rev_id in parents)
186
 
        return missing_keys
 
183
        if (self._last_revision is not None and
 
184
            self.to_repository.has_revision(self._last_revision)):
 
185
            return None
 
186
        try:
 
187
            return self.to_repository.search_missing_revision_ids(
 
188
                self.from_repository, self._last_revision,
 
189
                find_ghosts=self.find_ghosts)
 
190
        except errors.NoSuchRevision, e:
 
191
            raise InstallFailed([self._last_revision])
187
192
 
188
193
 
189
194
class Inter1and2Helper(object):
220
225
 
221
226
    def _find_root_ids(self, revs, parent_map, graph):
222
227
        revision_root = {}
 
228
        planned_versions = {}
223
229
        for tree in self.iter_rev_trees(revs):
224
230
            revision_id = tree.inventory.root.revision
225
231
            root_id = tree.get_root_id()
 
232
            planned_versions.setdefault(root_id, []).append(revision_id)
226
233
            revision_root[revision_id] = root_id
227
234
        # Find out which parents we don't already know root ids for
228
235
        parents = set()
234
241
        for tree in self.iter_rev_trees(parents):
235
242
            root_id = tree.get_root_id()
236
243
            revision_root[tree.get_revision_id()] = root_id
237
 
        return revision_root
 
244
        return revision_root, planned_versions
238
245
 
239
246
    def generate_root_texts(self, revs):
240
247
        """Generate VersionedFiles for all root ids.
243
250
        """
244
251
        graph = self.source.get_graph()
245
252
        parent_map = graph.get_parent_map(revs)
246
 
        rev_order = tsort.topo_sort(parent_map)
247
 
        rev_id_to_root_id = self._find_root_ids(revs, parent_map, graph)
 
253
        rev_order = topo_sort(parent_map)
 
254
        rev_id_to_root_id, root_id_to_rev_ids = self._find_root_ids(
 
255
            revs, parent_map, graph)
248
256
        root_id_order = [(rev_id_to_root_id[rev_id], rev_id) for rev_id in
249
257
            rev_order]
250
258
        # Guaranteed stable, this groups all the file id operations together
253
261
        # yet, and are unlikely to in non-rich-root environments anyway.
254
262
        root_id_order.sort(key=operator.itemgetter(0))
255
263
        # Create a record stream containing the roots to create.
256
 
        if len(revs) > 100:
257
 
            graph = _get_rich_root_heads_graph(self.source_repo, revs)
258
 
        new_roots_stream = _new_root_data_stream(
259
 
            root_id_order, rev_id_to_root_id, parent_map, self.source, graph)
260
 
        return [('texts', new_roots_stream)]
261
 
 
262
 
 
263
 
def _get_rich_root_heads_graph(source_repo, revision_ids):
264
 
    """Get a Graph object suitable for asking heads() for new rich roots."""
265
 
    st = static_tuple.StaticTuple
266
 
    revision_keys = [st(r_id).intern() for r_id in revision_ids]
267
 
    known_graph = source_repo.revisions.get_known_graph_ancestry(
268
 
                    revision_keys)
269
 
    return _mod_graph.GraphThunkIdsToKeys(known_graph)
270
 
 
271
 
 
272
 
def _new_root_data_stream(
273
 
    root_keys_to_create, rev_id_to_root_id_map, parent_map, repo, graph=None):
274
 
    """Generate a texts substream of synthesised root entries.
275
 
 
276
 
    Used in fetches that do rich-root upgrades.
277
 
    
278
 
    :param root_keys_to_create: iterable of (root_id, rev_id) pairs describing
279
 
        the root entries to create.
280
 
    :param rev_id_to_root_id_map: dict of known rev_id -> root_id mappings for
281
 
        calculating the parents.  If a parent rev_id is not found here then it
282
 
        will be recalculated.
283
 
    :param parent_map: a parent map for all the revisions in
284
 
        root_keys_to_create.
285
 
    :param graph: a graph to use instead of repo.get_graph().
286
 
    """
287
 
    for root_key in root_keys_to_create:
288
 
        root_id, rev_id = root_key
289
 
        parent_keys = _parent_keys_for_root_version(
290
 
            root_id, rev_id, rev_id_to_root_id_map, parent_map, repo, graph)
291
 
        yield versionedfile.FulltextContentFactory(
292
 
            root_key, parent_keys, None, '')
293
 
 
294
 
 
295
 
def _parent_keys_for_root_version(
296
 
    root_id, rev_id, rev_id_to_root_id_map, parent_map, repo, graph=None):
297
 
    """Get the parent keys for a given root id.
298
 
    
299
 
    A helper function for _new_root_data_stream.
300
 
    """
301
 
    # Include direct parents of the revision, but only if they used the same
302
 
    # root_id and are heads.
303
 
    rev_parents = parent_map[rev_id]
304
 
    parent_ids = []
305
 
    for parent_id in rev_parents:
306
 
        if parent_id == NULL_REVISION:
307
 
            continue
308
 
        if parent_id not in rev_id_to_root_id_map:
309
 
            # We probably didn't read this revision, go spend the extra effort
310
 
            # to actually check
311
 
            try:
312
 
                tree = repo.revision_tree(parent_id)
313
 
            except errors.NoSuchRevision:
314
 
                # Ghost, fill out rev_id_to_root_id in case we encounter this
315
 
                # again.
316
 
                # But set parent_root_id to None since we don't really know
317
 
                parent_root_id = None
318
 
            else:
319
 
                parent_root_id = tree.get_root_id()
320
 
            rev_id_to_root_id_map[parent_id] = None
321
 
            # XXX: why not:
322
 
            #   rev_id_to_root_id_map[parent_id] = parent_root_id
323
 
            # memory consumption maybe?
324
 
        else:
325
 
            parent_root_id = rev_id_to_root_id_map[parent_id]
326
 
        if root_id == parent_root_id:
327
 
            # With stacking we _might_ want to refer to a non-local revision,
328
 
            # but this code path only applies when we have the full content
329
 
            # available, so ghosts really are ghosts, not just the edge of
330
 
            # local data.
331
 
            parent_ids.append(parent_id)
332
 
        else:
333
 
            # root_id may be in the parent anyway.
334
 
            try:
335
 
                tree = repo.revision_tree(parent_id)
336
 
            except errors.NoSuchRevision:
337
 
                # ghost, can't refer to it.
338
 
                pass
339
 
            else:
340
 
                try:
341
 
                    parent_ids.append(tree.inventory[root_id].revision)
342
 
                except errors.NoSuchId:
343
 
                    # not in the tree
344
 
                    pass
345
 
    # Drop non-head parents
346
 
    if graph is None:
347
 
        graph = repo.get_graph()
348
 
    heads = graph.heads(parent_ids)
349
 
    selected_ids = []
350
 
    for parent_id in parent_ids:
351
 
        if parent_id in heads and parent_id not in selected_ids:
352
 
            selected_ids.append(parent_id)
353
 
    parent_keys = [(root_id, parent_id) for parent_id in selected_ids]
354
 
    return parent_keys
 
264
        def yield_roots():
 
265
            for key in root_id_order:
 
266
                root_id, rev_id = key
 
267
                rev_parents = parent_map[rev_id]
 
268
                # We drop revision parents with different file-ids, because
 
269
                # that represents a rename of the root to a different location
 
270
                # - its not actually a parent for us. (We could look for that
 
271
                # file id in the revision tree at considerably more expense,
 
272
                # but for now this is sufficient (and reconcile will catch and
 
273
                # correct this anyway).
 
274
                # When a parent revision is a ghost, we guess that its root id
 
275
                # was unchanged (rather than trimming it from the parent list).
 
276
                parent_keys = tuple((root_id, parent) for parent in rev_parents
 
277
                    if parent != NULL_REVISION and
 
278
                        rev_id_to_root_id.get(parent, root_id) == root_id)
 
279
                yield FulltextContentFactory(key, parent_keys, None, '')
 
280
        return [('texts', yield_roots())]