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

  • Committer: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005 by Canonical Ltd
2
 
 
 
1
# Copyright (C) 2005-2010 Canonical Ltd
 
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
17
 
import os
18
 
from cStringIO import StringIO
19
 
 
20
 
import bzrlib.errors
21
 
from bzrlib.trace import mutter, note, warning
22
 
from bzrlib.branch import Branch
23
 
from bzrlib.progress import ProgressBar
24
 
from bzrlib.xml5 import serializer_v5
25
 
from bzrlib.osutils import sha_string, split_lines
26
 
from bzrlib.errors import NoSuchRevision
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
27
17
 
28
18
"""Copying of history from one branch to another.
29
19
 
31
21
that has merged into it.  As the first step of a merge, pull, or
32
22
branch operation we copy history from the source into the destination
33
23
branch.
34
 
 
35
 
The copying is done in a slightly complicated order.  We don't want to
36
 
add a revision to the store until everything it refers to is also
37
 
stored, so that if a revision is present we can totally recreate it.
38
 
However, we can't know what files are included in a revision until we
39
 
read its inventory.  Therefore, we first pull the XML and hold it in
40
 
memory until we've updated all of the files referenced.
41
24
"""
42
25
 
43
 
# TODO: Avoid repeatedly opening weaves so many times.
44
 
 
45
 
# XXX: This doesn't handle ghost (not present in branch) revisions at
46
 
# all yet.  I'm not sure they really should be supported.
47
 
 
48
 
# NOTE: This doesn't copy revisions which may be present but not
49
 
# merged into the last revision.  I'm not sure we want to do that.
50
 
 
51
 
# - get a list of revisions that need to be pulled in
52
 
# - for each one, pull in that revision file
53
 
#   and get the inventory, and store the inventory with right
54
 
#   parents.
55
 
# - and get the ancestry, and store that with right parents too
56
 
# - and keep a note of all file ids and version seen
57
 
# - then go through all files; for each one get the weave,
58
 
#   and add in all file versions
59
 
 
60
 
 
61
 
 
62
 
def greedy_fetch(to_branch, from_branch, revision=None, pb=None):
63
 
    f = Fetcher(to_branch, from_branch, revision, pb)
64
 
    return f.count_copied, f.failed_revisions
65
 
 
66
 
 
67
 
 
68
 
class Fetcher(object):
69
 
    """Pull revisions and texts from one branch to another.
70
 
 
71
 
    This doesn't update the destination's history; that can be done
72
 
    separately if desired.  
73
 
 
74
 
    revision_limit
75
 
        If set, pull only up to this revision_id.
76
 
 
77
 
    After running:
78
 
 
79
 
    last_revision -- if last_revision
80
 
        is given it will be that, otherwise the last revision of
81
 
        from_branch
82
 
 
83
 
    count_copied -- number of revisions copied
84
 
 
85
 
    count_texts -- number of file texts copied
 
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().
86
49
    """
87
 
    def __init__(self, to_branch, from_branch, last_revision=None, pb=None):
88
 
        self.to_branch = to_branch
89
 
        self.to_weaves = to_branch.weave_store
90
 
        self.to_control = to_branch.control_weaves
91
 
        self.from_branch = from_branch
92
 
        self.from_weaves = from_branch.weave_store
93
 
        self.from_control = from_branch.control_weaves
94
 
        self.failed_revisions = []
95
 
        self.count_copied = 0
 
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
96
89
        self.count_total = 0
97
 
        self.count_texts = 0
98
 
        if pb is None:
99
 
            self.pb = bzrlib.ui.ui_factory.progress_bar()
100
 
        else:
101
 
            self.pb = pb
102
 
        self.last_revision = self._find_last_revision(last_revision)
103
 
        mutter('fetch up to rev {%s}', self.last_revision)
104
 
        revs_to_fetch = self._compare_ancestries()
105
 
        self._copy_revisions(revs_to_fetch)
106
 
        self.new_ancestry = revs_to_fetch
107
 
 
108
 
        
109
 
 
110
 
    def _find_last_revision(self, last_revision):
111
 
        """Find the limiting source revision.
112
 
 
113
 
        Every ancestor of that revision will be merged across.
114
 
 
115
 
        Returns the revision_id, or returns None if there's no history
116
 
        in the source branch."""
117
 
        self.pb.update('get source history')
118
 
        from_history = self.from_branch.revision_history()
119
 
        self.pb.update('get destination history')
120
 
        if last_revision:
121
 
            if last_revision not in from_history:
122
 
                raise NoSuchRevision(self.from_branch, last_revision)
123
 
            else:
124
 
                return last_revision
125
 
        elif from_history:
126
 
            return from_history[-1]
127
 
        else:
128
 
            return None                 # no history in the source branch
129
 
            
130
 
 
131
 
    def _compare_ancestries(self):
132
 
        """Get a list of revisions that must be copied.
133
 
 
134
 
        That is, every revision that's in the ancestry of the source
135
 
        branch and not in the destination branch."""
136
 
        self.pb.update('get source ancestry')
137
 
        self.from_ancestry = self.from_branch.get_ancestry(self.last_revision)
138
 
 
139
 
        dest_last_rev = self.to_branch.last_revision()
140
 
        self.pb.update('get destination ancestry')
141
 
        if dest_last_rev:
142
 
            dest_ancestry = self.to_branch.get_ancestry(dest_last_rev)
143
 
        else:
144
 
            dest_ancestry = []
145
 
        ss = set(dest_ancestry)
146
 
        to_fetch = []
147
 
        for rev_id in self.from_ancestry:
148
 
            if rev_id not in ss:
149
 
                to_fetch.append(rev_id)
150
 
                mutter('need to get revision {%s}', rev_id)
151
 
        mutter('need to get %d revisions in total', len(to_fetch))
152
 
        self.count_total = len(to_fetch)
153
 
        return to_fetch
154
 
                
155
 
 
156
 
 
157
 
    def _copy_revisions(self, revs_to_fetch):
158
 
        i = 0
159
 
        for rev_id in revs_to_fetch:
160
 
            i += 1
161
 
            if rev_id is None:
162
 
                continue
163
 
            if self.to_branch.has_revision(rev_id):
164
 
                continue
165
 
            self.pb.update('fetch revision', i, self.count_total)
166
 
            self._copy_one_revision(rev_id)
167
 
            self.count_copied += 1
168
 
 
169
 
 
170
 
    def _copy_one_revision(self, rev_id):
171
 
        """Copy revision and everything referenced by it."""
172
 
        mutter('copying revision {%s}', rev_id)
173
 
        rev_xml = self.from_branch.get_revision_xml(rev_id)
174
 
        inv_xml = self.from_branch.get_inventory_xml(rev_id)
175
 
        rev = serializer_v5.read_revision_from_string(rev_xml)
176
 
        inv = serializer_v5.read_inventory_from_string(inv_xml)
177
 
        assert rev.revision_id == rev_id
178
 
        assert rev.inventory_sha1 == sha_string(inv_xml)
179
 
        mutter('  commiter %s, %d parents',
180
 
               rev.committer,
181
 
               len(rev.parent_ids))
182
 
        self._copy_new_texts(rev_id, inv)
183
 
        self._copy_inventory(rev_id, inv_xml, rev.parent_ids)
184
 
        self._copy_ancestry(rev_id, rev.parent_ids)
185
 
        self.to_branch.revision_store.add(StringIO(rev_xml), rev_id)
186
 
 
187
 
 
188
 
    def _copy_inventory(self, rev_id, inv_xml, parent_ids):
189
 
        self.to_control.add_text('inventory', rev_id,
190
 
                                split_lines(inv_xml), parent_ids)
191
 
 
192
 
 
193
 
    def _copy_ancestry(self, rev_id, parent_ids):
194
 
        ancestry_lines = self.from_control.get_lines('ancestry', rev_id)
195
 
        self.to_control.add_text('ancestry', rev_id, ancestry_lines,
196
 
                                 parent_ids)
197
 
 
198
 
        
199
 
    def _copy_new_texts(self, rev_id, inv):
200
 
        """Copy any new texts occuring in this revision."""
201
 
        # TODO: Rather than writing out weaves every time, hold them
202
 
        # in memory until everything's done?  But this way is nicer
203
 
        # if it's interrupted.
204
 
        for path, ie in inv.iter_entries():
205
 
            if ie.kind != 'file':
206
 
                continue
207
 
            if ie.text_version != rev_id:
208
 
                continue
209
 
            mutter('%s {%s} is changed in this revision',
210
 
                   path, ie.file_id)
211
 
            self._copy_one_text(rev_id, ie.file_id)
212
 
 
213
 
 
214
 
    def _copy_one_text(self, rev_id, file_id):
215
 
        """Copy one file text."""
216
 
        mutter('copy text version {%s} of file {%s}',
217
 
               rev_id, file_id)
218
 
        from_weave = self.from_weaves.get_weave(file_id)
219
 
        from_idx = from_weave.lookup(rev_id)
220
 
        from_parents = map(from_weave.idx_to_name, from_weave.parents(from_idx))
221
 
        text_lines = from_weave.get(from_idx)
222
 
        to_weave = self.to_weaves.get_weave_or_empty(file_id)
223
 
        to_parents = map(to_weave.lookup, from_parents)
224
 
        # it's ok to add even if the text is already there
225
 
        to_weave.add(rev_id, to_parents, text_lines)
226
 
        self.to_weaves.put_weave(file_id, to_weave)
227
 
        self.count_texts += 1
228
 
 
229
 
 
230
 
fetch = Fetcher
 
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
    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.inventory.revision_id is None:
 
207
                    tree.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
            revision_id = tree.inventory.root.revision
 
215
            root_id = tree.get_root_id()
 
216
            revision_root[revision_id] = root_id
 
217
        # Find out which parents we don't already know root ids for
 
218
        parents = set()
 
219
        for revision_parents in parent_map.itervalues():
 
220
            parents.update(revision_parents)
 
221
        parents.difference_update(revision_root.keys() + [NULL_REVISION])
 
222
        # Limit to revisions present in the versionedfile
 
223
        parents = graph.get_parent_map(parents).keys()
 
224
        for tree in self.iter_rev_trees(parents):
 
225
            root_id = tree.get_root_id()
 
226
            revision_root[tree.get_revision_id()] = root_id
 
227
        return revision_root
 
228
 
 
229
    def generate_root_texts(self, revs):
 
230
        """Generate VersionedFiles for all root ids.
 
231
 
 
232
        :param revs: the revisions to include
 
233
        """
 
234
        graph = self.source.get_graph()
 
235
        parent_map = graph.get_parent_map(revs)
 
236
        rev_order = tsort.topo_sort(parent_map)
 
237
        rev_id_to_root_id = self._find_root_ids(revs, parent_map, graph)
 
238
        root_id_order = [(rev_id_to_root_id[rev_id], rev_id) for rev_id in
 
239
            rev_order]
 
240
        # Guaranteed stable, this groups all the file id operations together
 
241
        # retaining topological order within the revisions of a file id.
 
242
        # File id splits and joins would invalidate this, but they don't exist
 
243
        # yet, and are unlikely to in non-rich-root environments anyway.
 
244
        root_id_order.sort(key=operator.itemgetter(0))
 
245
        # Create a record stream containing the roots to create.
 
246
        if len(revs) > 100:
 
247
            # XXX: not covered by tests, should have a flag to always run
 
248
            # this. -- mbp 20100129
 
249
            graph = self.source_repo.get_known_graph_ancestry(revs)
 
250
        new_roots_stream = _new_root_data_stream(
 
251
            root_id_order, rev_id_to_root_id, parent_map, self.source, graph)
 
252
        return [('texts', new_roots_stream)]
 
253
 
 
254
 
 
255
def _get_rich_root_heads_graph(source_repo, revision_ids):
 
256
    """Get a Graph object suitable for asking heads() for new rich roots."""
 
257
    return 
 
258
 
 
259
 
 
260
def _new_root_data_stream(
 
261
    root_keys_to_create, rev_id_to_root_id_map, parent_map, repo, graph=None):
 
262
    """Generate a texts substream of synthesised root entries.
 
263
 
 
264
    Used in fetches that do rich-root upgrades.
 
265
    
 
266
    :param root_keys_to_create: iterable of (root_id, rev_id) pairs describing
 
267
        the root entries to create.
 
268
    :param rev_id_to_root_id_map: dict of known rev_id -> root_id mappings for
 
269
        calculating the parents.  If a parent rev_id is not found here then it
 
270
        will be recalculated.
 
271
    :param parent_map: a parent map for all the revisions in
 
272
        root_keys_to_create.
 
273
    :param graph: a graph to use instead of repo.get_graph().
 
274
    """
 
275
    for root_key in root_keys_to_create:
 
276
        root_id, rev_id = root_key
 
277
        parent_keys = _parent_keys_for_root_version(
 
278
            root_id, rev_id, rev_id_to_root_id_map, parent_map, repo, graph)
 
279
        yield versionedfile.FulltextContentFactory(
 
280
            root_key, parent_keys, None, '')
 
281
 
 
282
 
 
283
def _parent_keys_for_root_version(
 
284
    root_id, rev_id, rev_id_to_root_id_map, parent_map, repo, graph=None):
 
285
    """Get the parent keys for a given root id.
 
286
    
 
287
    A helper function for _new_root_data_stream.
 
288
    """
 
289
    # Include direct parents of the revision, but only if they used the same
 
290
    # root_id and are heads.
 
291
    rev_parents = parent_map[rev_id]
 
292
    parent_ids = []
 
293
    for parent_id in rev_parents:
 
294
        if parent_id == NULL_REVISION:
 
295
            continue
 
296
        if parent_id not in rev_id_to_root_id_map:
 
297
            # We probably didn't read this revision, go spend the extra effort
 
298
            # to actually check
 
299
            try:
 
300
                tree = repo.revision_tree(parent_id)
 
301
            except errors.NoSuchRevision:
 
302
                # Ghost, fill out rev_id_to_root_id in case we encounter this
 
303
                # again.
 
304
                # But set parent_root_id to None since we don't really know
 
305
                parent_root_id = None
 
306
            else:
 
307
                parent_root_id = tree.get_root_id()
 
308
            rev_id_to_root_id_map[parent_id] = None
 
309
            # XXX: why not:
 
310
            #   rev_id_to_root_id_map[parent_id] = parent_root_id
 
311
            # memory consumption maybe?
 
312
        else:
 
313
            parent_root_id = rev_id_to_root_id_map[parent_id]
 
314
        if root_id == parent_root_id:
 
315
            # With stacking we _might_ want to refer to a non-local revision,
 
316
            # but this code path only applies when we have the full content
 
317
            # available, so ghosts really are ghosts, not just the edge of
 
318
            # local data.
 
319
            parent_ids.append(parent_id)
 
320
        else:
 
321
            # root_id may be in the parent anyway.
 
322
            try:
 
323
                tree = repo.revision_tree(parent_id)
 
324
            except errors.NoSuchRevision:
 
325
                # ghost, can't refer to it.
 
326
                pass
 
327
            else:
 
328
                try:
 
329
                    parent_ids.append(tree.inventory[root_id].revision)
 
330
                except errors.NoSuchId:
 
331
                    # not in the tree
 
332
                    pass
 
333
    # Drop non-head parents
 
334
    if graph is None:
 
335
        graph = repo.get_graph()
 
336
    heads = graph.heads(parent_ids)
 
337
    selected_ids = []
 
338
    for parent_id in parent_ids:
 
339
        if parent_id in heads and parent_id not in selected_ids:
 
340
            selected_ids.append(parent_id)
 
341
    parent_keys = [(root_id, parent_id) for parent_id in selected_ids]
 
342
    return parent_keys