/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 breezy/bzr/fetch.py

  • Committer: Jelmer Vernooij
  • Date: 2018-11-21 03:39:28 UTC
  • mto: This revision was merged to the branch mainline in revision 7206.
  • Revision ID: jelmer@jelmer.uk-20181121033928-ck4sb5zfdwosw35b
Fix test.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/bzr/fetch.py
 
1
# Copyright (C) 2005-2011 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
"""Copying of history from one branch to another.
 
18
 
 
19
The basic plan is that every branch knows the history of everything
 
20
that has merged into it.  As the first step of a merge, pull, or
 
21
branch operation we copy history from the source into the destination
 
22
branch.
 
23
"""
 
24
 
 
25
from __future__ import absolute_import
 
26
 
 
27
import operator
 
28
 
 
29
from ..lazy_import import lazy_import
 
30
lazy_import(globals(), """
 
31
from breezy import (
 
32
    tsort,
 
33
    )
 
34
from breezy.bzr import (
 
35
    versionedfile,
 
36
    vf_search,
 
37
    )
 
38
""")
 
39
from .. import (
 
40
    errors,
 
41
    ui,
 
42
    )
 
43
from ..i18n import gettext
 
44
from ..revision import NULL_REVISION
 
45
from ..sixish import (
 
46
    viewvalues,
 
47
    )
 
48
from ..trace import mutter
 
49
 
 
50
 
 
51
class RepoFetcher(object):
 
52
    """Pull revisions and texts from one repository to another.
 
53
 
 
54
    This should not be used directly, it's essential a object to encapsulate
 
55
    the logic in InterRepository.fetch().
 
56
    """
 
57
 
 
58
    def __init__(self, to_repository, from_repository, last_revision=None,
 
59
                 find_ghosts=True, fetch_spec=None):
 
60
        """Create a repo fetcher.
 
61
 
 
62
        :param last_revision: If set, try to limit to the data this revision
 
63
            references.
 
64
        :param fetch_spec: A SearchResult specifying which revisions to fetch.
 
65
            If set, this overrides last_revision.
 
66
        :param find_ghosts: If True search the entire history for ghosts.
 
67
        """
 
68
        # repository.fetch has the responsibility for short-circuiting
 
69
        # attempts to copy between a repository and itself.
 
70
        self.to_repository = to_repository
 
71
        self.from_repository = from_repository
 
72
        self.sink = to_repository._get_sink()
 
73
        # must not mutate self._last_revision as its potentially a shared instance
 
74
        self._last_revision = last_revision
 
75
        self._fetch_spec = fetch_spec
 
76
        self.find_ghosts = find_ghosts
 
77
        self.from_repository.lock_read()
 
78
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
79
               str(self.from_repository), str(self.from_repository._format),
 
80
               str(self.to_repository), str(self.to_repository._format))
 
81
        try:
 
82
            self.__fetch()
 
83
        finally:
 
84
            self.from_repository.unlock()
 
85
 
 
86
    def __fetch(self):
 
87
        """Primary worker function.
 
88
 
 
89
        This initialises all the needed variables, and then fetches the
 
90
        requested revisions, finally clearing the progress bar.
 
91
        """
 
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
 
98
        self.count_total = 0
 
99
        self.file_ids_names = {}
 
100
        with ui.ui_factory.nested_progress_bar() as pb:
 
101
            pb.show_pct = pb.show_count = False
 
102
            pb.update(gettext("Finding revisions"), 0, 2)
 
103
            search_result = self._revids_to_fetch()
 
104
            mutter('fetching: %s', str(search_result))
 
105
            if search_result.is_empty():
 
106
                return
 
107
            pb.update(gettext("Fetching revisions"), 1, 2)
 
108
            self._fetch_everything_for_search(search_result)
 
109
 
 
110
    def _fetch_everything_for_search(self, search):
 
111
        """Fetch all data for the given set of revisions."""
 
112
        # The first phase is "file".  We pass the progress bar for it directly
 
113
        # into item_keys_introduced_by, which has more information about how
 
114
        # that phase is progressing than we do.  Progress updates for the other
 
115
        # phases are taken care of in this function.
 
116
        # XXX: there should be a clear owner of the progress reporting.  Perhaps
 
117
        # item_keys_introduced_by should have a richer API than it does at the
 
118
        # moment, so that it can feed the progress information back to this
 
119
        # function?
 
120
        if (self.from_repository._format.rich_root_data and
 
121
                not self.to_repository._format.rich_root_data):
 
122
            raise errors.IncompatibleRepositories(
 
123
                self.from_repository, self.to_repository,
 
124
                "different rich-root support")
 
125
        with ui.ui_factory.nested_progress_bar() as pb:
 
126
            pb.update("Get stream source")
 
127
            source = self.from_repository._get_source(
 
128
                self.to_repository._format)
 
129
            stream = source.get_stream(search)
 
130
            from_format = self.from_repository._format
 
131
            pb.update("Inserting stream")
 
132
            resume_tokens, missing_keys = self.sink.insert_stream(
 
133
                stream, from_format, [])
 
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
 
 
151
    def _revids_to_fetch(self):
 
152
        """Determines the exact revisions needed from self.from_repository to
 
153
        install self._last_revision in self.to_repository.
 
154
 
 
155
        :returns: A SearchResult of some sort.  (Possibly a
 
156
            PendingAncestryResult, EmptySearchResult, etc.)
 
157
        """
 
158
        if self._fetch_spec is not None:
 
159
            # The fetch spec is already a concrete search result.
 
160
            return self._fetch_spec
 
161
        elif self._last_revision == NULL_REVISION:
 
162
            # fetch_spec is None + last_revision is null => empty fetch.
 
163
            # explicit limit of no revisions needed
 
164
            return vf_search.EmptySearchResult()
 
165
        elif self._last_revision is not None:
 
166
            return vf_search.NotInOtherForRevs(self.to_repository,
 
167
                                               self.from_repository, [
 
168
                                                   self._last_revision],
 
169
                                               find_ghosts=self.find_ghosts).execute()
 
170
        else:  # self._last_revision is None:
 
171
            return vf_search.EverythingNotInOther(self.to_repository,
 
172
                                                  self.from_repository,
 
173
                                                  find_ghosts=self.find_ghosts).execute()
 
174
 
 
175
 
 
176
class Inter1and2Helper(object):
 
177
    """Helper for operations that convert data from model 1 and 2
 
178
 
 
179
    This is for use by fetchers and converters.
 
180
    """
 
181
 
 
182
    # This is a class variable so that the test suite can override it.
 
183
    known_graph_threshold = 100
 
184
 
 
185
    def __init__(self, source):
 
186
        """Constructor.
 
187
 
 
188
        :param source: The repository data comes from
 
189
        """
 
190
        self.source = source
 
191
 
 
192
    def iter_rev_trees(self, revs):
 
193
        """Iterate through RevisionTrees efficiently.
 
194
 
 
195
        Additionally, the inventory's revision_id is set if unset.
 
196
 
 
197
        Trees are retrieved in batches of 100, and then yielded in the order
 
198
        they were requested.
 
199
 
 
200
        :param revs: A list of revision ids
 
201
        """
 
202
        # In case that revs is not a list.
 
203
        revs = list(revs)
 
204
        while revs:
 
205
            for tree in self.source.revision_trees(revs[:100]):
 
206
                if tree.root_inventory.revision_id is None:
 
207
                    tree.root_inventory.revision_id = tree.get_revision_id()
 
208
                yield tree
 
209
            revs = revs[100:]
 
210
 
 
211
    def _find_root_ids(self, revs, parent_map, graph):
 
212
        revision_root = {}
 
213
        for tree in self.iter_rev_trees(revs):
 
214
            root_id = tree.get_root_id()
 
215
            revision_id = tree.get_file_revision(u'')
 
216
            revision_root[revision_id] = root_id
 
217
        # Find out which parents we don't already know root ids for
 
218
        parents = set(viewvalues(parent_map))
 
219
        parents.difference_update(revision_root)
 
220
        parents.discard(NULL_REVISION)
 
221
        # Limit to revisions present in the versionedfile
 
222
        parents = graph.get_parent_map(parents)
 
223
        for tree in self.iter_rev_trees(parents):
 
224
            root_id = tree.get_root_id()
 
225
            revision_root[tree.get_revision_id()] = root_id
 
226
        return revision_root
 
227
 
 
228
    def generate_root_texts(self, revs):
 
229
        """Generate VersionedFiles for all root ids.
 
230
 
 
231
        :param revs: the revisions to include
 
232
        """
 
233
        graph = self.source.get_graph()
 
234
        parent_map = graph.get_parent_map(revs)
 
235
        rev_order = tsort.topo_sort(parent_map)
 
236
        rev_id_to_root_id = self._find_root_ids(revs, parent_map, graph)
 
237
        root_id_order = [(rev_id_to_root_id[rev_id], rev_id) for rev_id in
 
238
                         rev_order]
 
239
        # Guaranteed stable, this groups all the file id operations together
 
240
        # retaining topological order within the revisions of a file id.
 
241
        # File id splits and joins would invalidate this, but they don't exist
 
242
        # yet, and are unlikely to in non-rich-root environments anyway.
 
243
        root_id_order.sort(key=operator.itemgetter(0))
 
244
        # Create a record stream containing the roots to create.
 
245
        if len(revs) > self.known_graph_threshold:
 
246
            graph = self.source.get_known_graph_ancestry(revs)
 
247
        new_roots_stream = _new_root_data_stream(
 
248
            root_id_order, rev_id_to_root_id, parent_map, self.source, graph)
 
249
        return [('texts', new_roots_stream)]
 
250
 
 
251
 
 
252
def _new_root_data_stream(
 
253
        root_keys_to_create, rev_id_to_root_id_map, parent_map, repo, graph=None):
 
254
    """Generate a texts substream of synthesised root entries.
 
255
 
 
256
    Used in fetches that do rich-root upgrades.
 
257
 
 
258
    :param root_keys_to_create: iterable of (root_id, rev_id) pairs describing
 
259
        the root entries to create.
 
260
    :param rev_id_to_root_id_map: dict of known rev_id -> root_id mappings for
 
261
        calculating the parents.  If a parent rev_id is not found here then it
 
262
        will be recalculated.
 
263
    :param parent_map: a parent map for all the revisions in
 
264
        root_keys_to_create.
 
265
    :param graph: a graph to use instead of repo.get_graph().
 
266
    """
 
267
    for root_key in root_keys_to_create:
 
268
        root_id, rev_id = root_key
 
269
        parent_keys = _parent_keys_for_root_version(
 
270
            root_id, rev_id, rev_id_to_root_id_map, parent_map, repo, graph)
 
271
        yield versionedfile.FulltextContentFactory(
 
272
            root_key, parent_keys, None, b'')
 
273
 
 
274
 
 
275
def _parent_keys_for_root_version(
 
276
        root_id, rev_id, rev_id_to_root_id_map, parent_map, repo, graph=None):
 
277
    """Get the parent keys for a given root id.
 
278
 
 
279
    A helper function for _new_root_data_stream.
 
280
    """
 
281
    # Include direct parents of the revision, but only if they used the same
 
282
    # root_id and are heads.
 
283
    rev_parents = parent_map[rev_id]
 
284
    parent_ids = []
 
285
    for parent_id in rev_parents:
 
286
        if parent_id == NULL_REVISION:
 
287
            continue
 
288
        if parent_id not in rev_id_to_root_id_map:
 
289
            # We probably didn't read this revision, go spend the extra effort
 
290
            # to actually check
 
291
            try:
 
292
                tree = repo.revision_tree(parent_id)
 
293
            except errors.NoSuchRevision:
 
294
                # Ghost, fill out rev_id_to_root_id in case we encounter this
 
295
                # again.
 
296
                # But set parent_root_id to None since we don't really know
 
297
                parent_root_id = None
 
298
            else:
 
299
                parent_root_id = tree.get_root_id()
 
300
            rev_id_to_root_id_map[parent_id] = None
 
301
            # XXX: why not:
 
302
            #   rev_id_to_root_id_map[parent_id] = parent_root_id
 
303
            # memory consumption maybe?
 
304
        else:
 
305
            parent_root_id = rev_id_to_root_id_map[parent_id]
 
306
        if root_id == parent_root_id:
 
307
            # With stacking we _might_ want to refer to a non-local revision,
 
308
            # but this code path only applies when we have the full content
 
309
            # available, so ghosts really are ghosts, not just the edge of
 
310
            # local data.
 
311
            parent_ids.append(parent_id)
 
312
        else:
 
313
            # root_id may be in the parent anyway.
 
314
            try:
 
315
                tree = repo.revision_tree(parent_id)
 
316
            except errors.NoSuchRevision:
 
317
                # ghost, can't refer to it.
 
318
                pass
 
319
            else:
 
320
                try:
 
321
                    parent_ids.append(
 
322
                        tree.get_file_revision(tree.id2path(root_id)))
 
323
                except errors.NoSuchId:
 
324
                    # not in the tree
 
325
                    pass
 
326
    # Drop non-head parents
 
327
    if graph is None:
 
328
        graph = repo.get_graph()
 
329
    heads = graph.heads(parent_ids)
 
330
    selected_ids = []
 
331
    for parent_id in parent_ids:
 
332
        if parent_id in heads and parent_id not in selected_ids:
 
333
            selected_ids.append(parent_id)
 
334
    parent_keys = [(root_id, parent_id) for parent_id in selected_ids]
 
335
    return parent_keys
 
336
 
 
337
 
 
338
class TargetRepoKinds(object):
 
339
    """An enum-like set of constants.
 
340
 
 
341
    They are the possible values of FetchSpecFactory.target_repo_kinds.
 
342
    """
 
343
 
 
344
    PREEXISTING = 'preexisting'
 
345
    STACKED = 'stacked'
 
346
    EMPTY = 'empty'
 
347
 
 
348
 
 
349
class FetchSpecFactory(object):
 
350
    """A helper for building the best fetch spec for a sprout call.
 
351
 
 
352
    Factors that go into determining the sort of fetch to perform:
 
353
     * did the caller specify any revision IDs?
 
354
     * did the caller specify a source branch (need to fetch its
 
355
       heads_to_fetch(), usually the tip + tags)
 
356
     * is there an existing target repo (don't need to refetch revs it
 
357
       already has)
 
358
     * target is stacked?  (similar to pre-existing target repo: even if
 
359
       the target itself is new don't want to refetch existing revs)
 
360
 
 
361
    :ivar source_branch: the source branch if one specified, else None.
 
362
    :ivar source_branch_stop_revision_id: fetch up to this revision of
 
363
        source_branch, rather than its tip.
 
364
    :ivar source_repo: the source repository if one found, else None.
 
365
    :ivar target_repo: the target repository acquired by sprout.
 
366
    :ivar target_repo_kind: one of the TargetRepoKinds constants.
 
367
    """
 
368
 
 
369
    def __init__(self):
 
370
        self._explicit_rev_ids = set()
 
371
        self.source_branch = None
 
372
        self.source_branch_stop_revision_id = None
 
373
        self.source_repo = None
 
374
        self.target_repo = None
 
375
        self.target_repo_kind = None
 
376
        self.limit = None
 
377
 
 
378
    def add_revision_ids(self, revision_ids):
 
379
        """Add revision_ids to the set of revision_ids to be fetched."""
 
380
        self._explicit_rev_ids.update(revision_ids)
 
381
 
 
382
    def make_fetch_spec(self):
 
383
        """Build a SearchResult or PendingAncestryResult or etc."""
 
384
        if self.target_repo_kind is None or self.source_repo is None:
 
385
            raise AssertionError(
 
386
                'Incomplete FetchSpecFactory: %r' % (self.__dict__,))
 
387
        if len(self._explicit_rev_ids) == 0 and self.source_branch is None:
 
388
            if self.limit is not None:
 
389
                raise NotImplementedError(
 
390
                    "limit is only supported with a source branch set")
 
391
            # Caller hasn't specified any revisions or source branch
 
392
            if self.target_repo_kind == TargetRepoKinds.EMPTY:
 
393
                return vf_search.EverythingResult(self.source_repo)
 
394
            else:
 
395
                # We want everything not already in the target (or target's
 
396
                # fallbacks).
 
397
                return vf_search.EverythingNotInOther(
 
398
                    self.target_repo, self.source_repo).execute()
 
399
        heads_to_fetch = set(self._explicit_rev_ids)
 
400
        if self.source_branch is not None:
 
401
            must_fetch, if_present_fetch = self.source_branch.heads_to_fetch()
 
402
            if self.source_branch_stop_revision_id is not None:
 
403
                # Replace the tip rev from must_fetch with the stop revision
 
404
                # XXX: this might be wrong if the tip rev is also in the
 
405
                # must_fetch set for other reasons (e.g. it's the tip of
 
406
                # multiple loom threads?), but then it's pretty unclear what it
 
407
                # should mean to specify a stop_revision in that case anyway.
 
408
                must_fetch.discard(self.source_branch.last_revision())
 
409
                must_fetch.add(self.source_branch_stop_revision_id)
 
410
            heads_to_fetch.update(must_fetch)
 
411
        else:
 
412
            if_present_fetch = set()
 
413
        if self.target_repo_kind == TargetRepoKinds.EMPTY:
 
414
            # PendingAncestryResult does not raise errors if a requested head
 
415
            # is absent.  Ideally it would support the
 
416
            # required_ids/if_present_ids distinction, but in practice
 
417
            # heads_to_fetch will almost certainly be present so this doesn't
 
418
            # matter much.
 
419
            all_heads = heads_to_fetch.union(if_present_fetch)
 
420
            ret = vf_search.PendingAncestryResult(all_heads, self.source_repo)
 
421
            if self.limit is not None:
 
422
                graph = self.source_repo.get_graph()
 
423
                topo_order = list(graph.iter_topo_order(ret.get_keys()))
 
424
                result_set = topo_order[:self.limit]
 
425
                ret = self.source_repo.revision_ids_to_search_result(
 
426
                    result_set)
 
427
            return ret
 
428
        else:
 
429
            return vf_search.NotInOtherForRevs(self.target_repo, self.source_repo,
 
430
                                               required_ids=heads_to_fetch, if_present_ids=if_present_fetch,
 
431
                                               limit=self.limit).execute()