~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/fetch.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-06-27 00:29:53 UTC
  • mfrom: (4487.1.1 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20090627002953-q4333x7hfvw1q3wz
(igc) Teach get_app_path to read wordpad.exe (Alexander Belchenko)

Show diffs side-by-side

added added

removed removed

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