~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-03-12 03:39:10 UTC
  • mfrom: (4103.3.5 progress)
  • Revision ID: pqm@pqm.ubuntu.com-20090312033910-9umj7rwjo98zl7up
(mbp) small progress improvements

Show diffs side-by-side

added added

removed removed

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