~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/fetch.py

  • Committer: John Arbash Meinel
  • Author(s): Mark Hammond
  • Date: 2008-09-09 17:02:21 UTC
  • mto: This revision was merged to the branch mainline in revision 3697.
  • Revision ID: john@arbash-meinel.com-20080909170221-svim3jw2mrz0amp3
An updated transparent icon for bzr.

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
35
import bzrlib
29
 
from bzrlib import (
30
 
    errors,
31
 
    symbol_versioning,
32
 
    )
33
 
from bzrlib.revision import NULL_REVISION
 
36
import bzrlib.errors as errors
 
37
from bzrlib.errors import InstallFailed
 
38
from bzrlib.progress import ProgressPhase
 
39
from bzrlib.revision import is_null, NULL_REVISION
 
40
from bzrlib.symbol_versioning import (deprecated_function,
 
41
        deprecated_method,
 
42
        )
34
43
from bzrlib.tsort import topo_sort
35
44
from bzrlib.trace import mutter
36
45
import bzrlib.ui
37
 
from bzrlib.versionedfile import FulltextContentFactory
 
46
from bzrlib.versionedfile import filter_absent, FulltextContentFactory
 
47
 
 
48
# TODO: Avoid repeatedly opening weaves so many times.
 
49
 
 
50
# XXX: This doesn't handle ghost (not present in branch) revisions at
 
51
# all yet.  I'm not sure they really should be supported.
 
52
 
 
53
# NOTE: This doesn't copy revisions which may be present but not
 
54
# merged into the last revision.  I'm not sure we want to do that.
 
55
 
 
56
# - get a list of revisions that need to be pulled in
 
57
# - for each one, pull in that revision file
 
58
#   and get the inventory, and store the inventory with right
 
59
#   parents.
 
60
# - and get the ancestry, and store that with right parents too
 
61
# - and keep a note of all file ids and version seen
 
62
# - then go through all files; for each one get the weave,
 
63
#   and add in all file versions
38
64
 
39
65
 
40
66
class RepoFetcher(object):
41
67
    """Pull revisions and texts from one repository to another.
42
68
 
 
69
    last_revision
 
70
        if set, try to limit to the data this revision references.
 
71
 
 
72
    after running:
 
73
    count_copied -- number of revisions copied
 
74
 
43
75
    This should not be used directly, it's essential a object to encapsulate
44
76
    the logic in InterRepository.fetch().
45
77
    """
46
78
 
47
 
    def __init__(self, to_repository, from_repository, last_revision=None,
48
 
        pb=None, find_ghosts=True, fetch_spec=None):
 
79
    def __init__(self, to_repository, from_repository, last_revision=None, pb=None,
 
80
        find_ghosts=True):
49
81
        """Create a repo fetcher.
50
82
 
51
 
        :param last_revision: If set, try to limit to the data this revision
52
 
            references.
53
83
        :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
84
        """
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
 
        # repository.fetch has the responsibility for short-circuiting
63
 
        # attempts to copy between a repository and itself.
 
85
        # result variables.
 
86
        self.failed_revisions = []
 
87
        self.count_copied = 0
 
88
        if to_repository.has_same_location(from_repository):
 
89
            # repository.fetch should be taking care of this case.
 
90
            raise errors.BzrError('RepoFetcher run '
 
91
                    'between two objects at the same location: '
 
92
                    '%r and %r' % (to_repository, from_repository))
64
93
        self.to_repository = to_repository
65
94
        self.from_repository = from_repository
66
 
        self.sink = to_repository._get_sink()
67
95
        # must not mutate self._last_revision as its potentially a shared instance
68
96
        self._last_revision = last_revision
69
 
        self._fetch_spec = fetch_spec
70
97
        self.find_ghosts = find_ghosts
 
98
        if pb is None:
 
99
            self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
100
            self.nested_pb = self.pb
 
101
        else:
 
102
            self.pb = pb
 
103
            self.nested_pb = None
71
104
        self.from_repository.lock_read()
72
 
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
73
 
               self.from_repository, self.from_repository._format,
74
 
               self.to_repository, self.to_repository._format)
75
105
        try:
76
 
            self.__fetch()
 
106
            self.to_repository.lock_write()
 
107
            try:
 
108
                self.to_repository.start_write_group()
 
109
                try:
 
110
                    self.__fetch()
 
111
                except:
 
112
                    self.to_repository.abort_write_group()
 
113
                    raise
 
114
                else:
 
115
                    self.to_repository.commit_write_group()
 
116
            finally:
 
117
                try:
 
118
                    if self.nested_pb is not None:
 
119
                        self.nested_pb.finished()
 
120
                finally:
 
121
                    self.to_repository.unlock()
77
122
        finally:
78
123
            self.from_repository.unlock()
79
124
 
80
125
    def __fetch(self):
81
126
        """Primary worker function.
82
127
 
83
 
        This initialises all the needed variables, and then fetches the
 
128
        This initialises all the needed variables, and then fetches the 
84
129
        requested revisions, finally clearing the progress bar.
85
130
        """
86
 
        # Roughly this is what we're aiming for fetch to become:
87
 
        #
88
 
        # missing = self.sink.insert_stream(self.source.get_stream(search))
89
 
        # if missing:
90
 
        #     missing = self.sink.insert_stream(self.source.get_items(missing))
91
 
        # assert not missing
92
131
        self.count_total = 0
93
132
        self.file_ids_names = {}
94
 
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
95
 
        pb.show_pct = pb.show_count = False
 
133
        pp = ProgressPhase('Transferring', 4, self.pb)
96
134
        try:
97
 
            pb.update("Finding revisions", 0, 2)
 
135
            pp.next_phase()
98
136
            search = self._revids_to_fetch()
99
137
            if search is None:
100
138
                return
101
 
            pb.update("Fetching revisions", 1, 2)
102
 
            self._fetch_everything_for_search(search)
 
139
            if getattr(self, '_fetch_everything_for_search', None) is not None:
 
140
                self._fetch_everything_for_search(search, pp)
 
141
            else:
 
142
                # backward compatibility
 
143
                self._fetch_everything_for_revisions(search.get_keys, pp)
103
144
        finally:
104
 
            pb.finished()
 
145
            self.pb.clear()
105
146
 
106
 
    def _fetch_everything_for_search(self, search):
 
147
    def _fetch_everything_for_search(self, search, pp):
107
148
        """Fetch all data for the given set of revisions."""
108
149
        # The first phase is "file".  We pass the progress bar for it directly
109
150
        # into item_keys_introduced_by, which has more information about how
113
154
        # item_keys_introduced_by should have a richer API than it does at the
114
155
        # moment, so that it can feed the progress information back to this
115
156
        # function?
116
 
        if (self.from_repository._format.rich_root_data and
117
 
            not self.to_repository._format.rich_root_data):
118
 
            raise errors.IncompatibleRepositories(
119
 
                self.from_repository, self.to_repository,
120
 
                "different rich-root support")
 
157
        phase = 'file'
121
158
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
122
159
        try:
123
 
            pb.update("Get stream source")
124
 
            source = self.from_repository._get_source(
125
 
                self.to_repository._format)
126
 
            stream = source.get_stream(search)
127
 
            from_format = self.from_repository._format
128
 
            pb.update("Inserting stream")
129
 
            resume_tokens, missing_keys = self.sink.insert_stream(
130
 
                stream, from_format, [])
131
 
            if self.to_repository._fallback_repositories:
132
 
                missing_keys.update(
133
 
                    self._parent_inventories(search.get_keys()))
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()
 
160
            revs = search.get_keys()
 
161
            graph = self.from_repository.get_graph()
 
162
            revs = list(graph.iter_topo_order(revs))
 
163
            data_to_fetch = self.from_repository.item_keys_introduced_by(revs,
 
164
                                                                         pb)
 
165
            text_keys = []
 
166
            for knit_kind, file_id, revisions in data_to_fetch:
 
167
                if knit_kind != phase:
 
168
                    phase = knit_kind
 
169
                    # Make a new progress bar for this phase
 
170
                    pb.finished()
 
171
                    pp.next_phase()
 
172
                    pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
173
                if knit_kind == "file":
 
174
                    # Accumulate file texts
 
175
                    text_keys.extend([(file_id, revision) for revision in
 
176
                        revisions])
 
177
                elif knit_kind == "inventory":
 
178
                    # Now copy the file texts.
 
179
                    to_texts = self.to_repository.texts
 
180
                    from_texts = self.from_repository.texts
 
181
                    to_texts.insert_record_stream(from_texts.get_record_stream(
 
182
                        text_keys, self.to_repository._fetch_order,
 
183
                        not self.to_repository._fetch_uses_deltas))
 
184
                    # Cause an error if a text occurs after we have done the
 
185
                    # copy.
 
186
                    text_keys = None
 
187
                    # Before we process the inventory we generate the root
 
188
                    # texts (if necessary) so that the inventories references
 
189
                    # will be valid.
 
190
                    self._generate_root_texts(revs)
 
191
                    # NB: This currently reopens the inventory weave in source;
 
192
                    # using a single stream interface instead would avoid this.
 
193
                    self._fetch_inventory_weave(revs, pb)
 
194
                elif knit_kind == "signatures":
 
195
                    # Nothing to do here; this will be taken care of when
 
196
                    # _fetch_revision_texts happens.
 
197
                    pass
 
198
                elif knit_kind == "revisions":
 
199
                    self._fetch_revision_texts(revs, pb)
 
200
                else:
 
201
                    raise AssertionError("Unknown knit kind %r" % knit_kind)
 
202
            if self.to_repository._fetch_reconcile:
 
203
                self.to_repository.reconcile()
150
204
        finally:
151
 
            pb.finished()
152
 
 
 
205
            if pb is not None:
 
206
                pb.finished()
 
207
        self.count_copied += len(revs)
 
208
        
153
209
    def _revids_to_fetch(self):
154
210
        """Determines the exact revisions needed from self.from_repository to
155
211
        install self._last_revision in self.to_repository.
156
212
 
157
213
        If no revisions need to be fetched, then this just returns None.
158
214
        """
159
 
        if self._fetch_spec is not None:
160
 
            return self._fetch_spec
161
215
        mutter('fetch up to rev {%s}', self._last_revision)
162
216
        if self._last_revision is NULL_REVISION:
163
217
            # explicit limit of no revisions needed
164
218
            return None
165
 
        return self.to_repository.search_missing_revision_ids(
166
 
            self.from_repository, self._last_revision,
167
 
            find_ghosts=self.find_ghosts)
168
 
 
169
 
    def _parent_inventories(self, revision_ids):
170
 
        # Find all the parent revisions referenced by the stream, but
171
 
        # not present in the stream, and make sure we send their
172
 
        # inventories.
173
 
        parent_maps = self.to_repository.get_parent_map(revision_ids)
174
 
        parents = set()
175
 
        map(parents.update, parent_maps.itervalues())
176
 
        parents.discard(NULL_REVISION)
177
 
        parents.difference_update(revision_ids)
178
 
        missing_keys = set(('inventories', rev_id) for rev_id in parents)
179
 
        return missing_keys
 
219
        if (self._last_revision is not None and
 
220
            self.to_repository.has_revision(self._last_revision)):
 
221
            return None
 
222
        try:
 
223
            return self.to_repository.search_missing_revision_ids(
 
224
                self.from_repository, self._last_revision,
 
225
                find_ghosts=self.find_ghosts)
 
226
        except errors.NoSuchRevision, e:
 
227
            raise InstallFailed([self._last_revision])
 
228
 
 
229
    def _fetch_inventory_weave(self, revs, pb):
 
230
        pb.update("fetch inventory", 0, 2)
 
231
        to_weave = self.to_repository.inventories
 
232
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
233
        try:
 
234
            # just merge, this is optimisable and its means we don't
 
235
            # copy unreferenced data such as not-needed inventories.
 
236
            pb.update("fetch inventory", 1, 3)
 
237
            from_weave = self.from_repository.inventories
 
238
            pb.update("fetch inventory", 2, 3)
 
239
            # we fetch only the referenced inventories because we do not
 
240
            # know for unselected inventories whether all their required
 
241
            # texts are present in the other repository - it could be
 
242
            # corrupt.
 
243
            to_weave.insert_record_stream(from_weave.get_record_stream(
 
244
                [(rev_id,) for rev_id in revs],
 
245
                self.to_repository._fetch_order,
 
246
                not self.to_repository._fetch_uses_deltas))
 
247
        finally:
 
248
            child_pb.finished()
 
249
 
 
250
    def _fetch_revision_texts(self, revs, pb):
 
251
        # may need to be a InterRevisionStore call here.
 
252
        to_sf = self.to_repository.signatures
 
253
        from_sf = self.from_repository.signatures
 
254
        # A missing signature is just skipped.
 
255
        to_sf.insert_record_stream(filter_absent(from_sf.get_record_stream(
 
256
            [(rev_id,) for rev_id in revs],
 
257
            self.to_repository._fetch_order,
 
258
            True)))
 
259
        # Bug #261339, some knit repositories accidentally had deltas in their
 
260
        # revision stream, when you weren't ever supposed to have deltas.
 
261
        # So we now *force* fulltext copying for signatures and revisions
 
262
        self._fetch_just_revision_texts(revs)
 
263
 
 
264
    def _fetch_just_revision_texts(self, version_ids):
 
265
        to_rf = self.to_repository.revisions
 
266
        from_rf = self.from_repository.revisions
 
267
        to_rf.insert_record_stream(from_rf.get_record_stream(
 
268
            [(rev_id,) for rev_id in version_ids],
 
269
            self.to_repository._fetch_order,
 
270
            True))
 
271
        # Bug #261339, some knit repositories accidentally had deltas in their
 
272
        # revision stream, when you weren't ever supposed to have deltas.
 
273
        # So we now *force* fulltext copying for signatures and revisions
 
274
 
 
275
    def _generate_root_texts(self, revs):
 
276
        """This will be called by __fetch between fetching weave texts and
 
277
        fetching the inventory weave.
 
278
 
 
279
        Subclasses should override this if they need to generate root texts
 
280
        after fetching weave texts.
 
281
        """
 
282
        pass
180
283
 
181
284
 
182
285
class Inter1and2Helper(object):
183
286
    """Helper for operations that convert data from model 1 and 2
184
 
 
 
287
    
185
288
    This is for use by fetchers and converters.
186
289
    """
187
290
 
188
 
    def __init__(self, source):
 
291
    def __init__(self, source, target):
189
292
        """Constructor.
190
293
 
191
294
        :param source: The repository data comes from
 
295
        :param target: The repository data goes to
192
296
        """
193
297
        self.source = source
 
298
        self.target = target
194
299
 
195
300
    def iter_rev_trees(self, revs):
196
301
        """Iterate through RevisionTrees efficiently.
236
341
 
237
342
        :param revs: the revisions to include
238
343
        """
 
344
        to_texts = self.target.texts
239
345
        graph = self.source.get_graph()
240
346
        parent_map = graph.get_parent_map(revs)
241
347
        rev_order = topo_sort(parent_map)
265
371
                    if parent != NULL_REVISION and
266
372
                        rev_id_to_root_id.get(parent, root_id) == root_id)
267
373
                yield FulltextContentFactory(key, parent_keys, None, '')
268
 
        return [('texts', yield_roots())]
 
374
        to_texts.insert_record_stream(yield_roots())
 
375
 
 
376
    def regenerate_inventory(self, revs):
 
377
        """Generate a new inventory versionedfile in target, convertin data.
 
378
        
 
379
        The inventory is retrieved from the source, (deserializing it), and
 
380
        stored in the target (reserializing it in a different format).
 
381
        :param revs: The revisions to include
 
382
        """
 
383
        for tree in self.iter_rev_trees(revs):
 
384
            parents = tree.get_parent_ids()
 
385
            self.target.add_inventory(tree.get_revision_id(), tree.inventory,
 
386
                                      parents)
 
387
 
 
388
    def fetch_revisions(self, revision_ids):
 
389
        # TODO: should this batch them up rather than requesting 10,000
 
390
        #       revisions at once?
 
391
        for revision in self.source.get_revisions(revision_ids):
 
392
            self.target.add_revision(revision.revision_id, revision)
 
393
 
 
394
 
 
395
class Model1toKnit2Fetcher(RepoFetcher):
 
396
    """Fetch from a Model1 repository into a Knit2 repository
 
397
    """
 
398
    def __init__(self, to_repository, from_repository, last_revision=None,
 
399
                 pb=None, find_ghosts=True):
 
400
        self.helper = Inter1and2Helper(from_repository, to_repository)
 
401
        RepoFetcher.__init__(self, to_repository, from_repository,
 
402
            last_revision, pb, find_ghosts)
 
403
 
 
404
    def _generate_root_texts(self, revs):
 
405
        self.helper.generate_root_texts(revs)
 
406
 
 
407
    def _fetch_inventory_weave(self, revs, pb):
 
408
        self.helper.regenerate_inventory(revs)
 
409
 
 
410
    def _fetch_revision_texts(self, revs, pb):
 
411
        """Fetch revision object texts"""
 
412
        count = 0
 
413
        total = len(revs)
 
414
        for rev in revs:
 
415
            pb.update('copying revisions', count, total)
 
416
            try:
 
417
                sig_text = self.from_repository.get_signature_text(rev)
 
418
                self.to_repository.add_signature_text(rev, sig_text)
 
419
            except errors.NoSuchRevision:
 
420
                # not signed.
 
421
                pass
 
422
            self._copy_revision(rev)
 
423
            count += 1
 
424
 
 
425
    def _copy_revision(self, rev):
 
426
        self.helper.fetch_revisions([rev])
 
427
 
 
428
 
 
429
class Knit1to2Fetcher(RepoFetcher):
 
430
    """Fetch from a Knit1 repository into a Knit2 repository"""
 
431
 
 
432
    def __init__(self, to_repository, from_repository, last_revision=None,
 
433
                 pb=None, find_ghosts=True):
 
434
        self.helper = Inter1and2Helper(from_repository, to_repository)
 
435
        RepoFetcher.__init__(self, to_repository, from_repository,
 
436
            last_revision, pb, find_ghosts)
 
437
 
 
438
    def _generate_root_texts(self, revs):
 
439
        self.helper.generate_root_texts(revs)
 
440
 
 
441
    def _fetch_inventory_weave(self, revs, pb):
 
442
        self.helper.regenerate_inventory(revs)
 
443
 
 
444
    def _fetch_just_revision_texts(self, version_ids):
 
445
        self.helper.fetch_revisions(version_ids)