~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/fetch.py

  • Committer: Robert Collins
  • Date: 2007-06-04 03:39:48 UTC
  • mto: (2507.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 2505.
  • Revision ID: robertc@robertcollins.net-20070604033948-erld0bugxcbo62gf
Review feedback.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005 by Canonical Ltd
2
 
 
 
1
# Copyright (C) 2005, 2006 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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
import bzrlib.errors
17
 
from bzrlib.trace import mutter, note
18
 
from bzrlib.branch import Branch
19
 
from bzrlib.progress import ProgressBar
20
 
import sys
21
 
import os
22
 
 
23
 
def has_revision(branch, revision_id):
24
 
    try:
25
 
        branch.get_revision_xml(revision_id)
26
 
        return True
27
 
    except bzrlib.errors.NoSuchRevision:
28
 
        return False
29
 
 
30
 
 
 
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 finally actually join
 
31
the inventories.
 
32
"""
 
33
 
 
34
import bzrlib
 
35
import bzrlib.errors as errors
 
36
from bzrlib.errors import (InstallFailed,
 
37
                           )
 
38
from bzrlib.progress import ProgressPhase
 
39
from bzrlib.revision import NULL_REVISION
 
40
from bzrlib.symbol_versioning import (deprecated_function,
 
41
        deprecated_method,
 
42
        zero_eight,
 
43
        )
 
44
from bzrlib.trace import mutter
 
45
import bzrlib.ui
 
46
 
 
47
from bzrlib.lazy_import import lazy_import
 
48
 
 
49
# TODO: Avoid repeatedly opening weaves so many times.
 
50
 
 
51
# XXX: This doesn't handle ghost (not present in branch) revisions at
 
52
# all yet.  I'm not sure they really should be supported.
 
53
 
 
54
# NOTE: This doesn't copy revisions which may be present but not
 
55
# merged into the last revision.  I'm not sure we want to do that.
 
56
 
 
57
# - get a list of revisions that need to be pulled in
 
58
# - for each one, pull in that revision file
 
59
#   and get the inventory, and store the inventory with right
 
60
#   parents.
 
61
# - and get the ancestry, and store that with right parents too
 
62
# - and keep a note of all file ids and version seen
 
63
# - then go through all files; for each one get the weave,
 
64
#   and add in all file versions
 
65
 
 
66
 
 
67
@deprecated_function(zero_eight)
31
68
def greedy_fetch(to_branch, from_branch, revision=None, pb=None):
32
 
    """Copy a revision and all available ancestors from one branch to another
33
 
    If no revision is specified, uses the last revision in the source branch's
34
 
    revision history.
 
69
    """Legacy API, please see branch.fetch(from_branch, last_revision, pb)."""
 
70
    f = Fetcher(to_branch, from_branch, revision, pb)
 
71
    return f.count_copied, f.failed_revisions
 
72
 
 
73
fetch = greedy_fetch
 
74
 
 
75
 
 
76
class RepoFetcher(object):
 
77
    """Pull revisions and texts from one repository to another.
 
78
 
 
79
    last_revision
 
80
        if set, try to limit to the data this revision references.
 
81
 
 
82
    after running:
 
83
    count_copied -- number of revisions copied
 
84
 
 
85
    This should not be used directory, its essential a object to encapsulate
 
86
    the logic in InterRepository.fetch().
35
87
    """
36
 
    from_history = from_branch.revision_history()
37
 
    required_revisions = set(from_history)
38
 
    all_failed = set()
39
 
    if revision is not None:
40
 
        required_revisions.add(revision)
41
 
        try:
42
 
            rev_index = from_history.index(revision)
43
 
        except ValueError:
44
 
            rev_index = None
45
 
        if rev_index is not None:
46
 
            from_history = from_history[:rev_index + 1]
 
88
    def __init__(self, to_repository, from_repository, last_revision=None, pb=None):
 
89
        # result variables.
 
90
        self.failed_revisions = []
 
91
        self.count_copied = 0
 
92
        if to_repository.control_files._transport.base == from_repository.control_files._transport.base:
 
93
            # check that last_revision is in 'from' and then return a no-operation.
 
94
            if last_revision not in (None, NULL_REVISION):
 
95
                from_repository.get_revision(last_revision)
 
96
            return
 
97
        self.to_repository = to_repository
 
98
        self.from_repository = from_repository
 
99
        # must not mutate self._last_revision as its potentially a shared instance
 
100
        self._last_revision = last_revision
 
101
        if pb is None:
 
102
            self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
103
            self.nested_pb = self.pb
47
104
        else:
48
 
            from_history = [revision]
49
 
    to_history = to_branch.revision_history()
50
 
    missing = []
51
 
    for rev_id in from_history:
52
 
        if not has_revision(to_branch, rev_id):
53
 
            missing.append(rev_id)
54
 
    
55
 
    count = 0
56
 
    while len(missing) > 0:
57
 
        installed, failed = to_branch.install_revisions(from_branch, 
58
 
                                                        revision_ids=missing,
59
 
                                                        pb=pb)
60
 
        count += installed
61
 
        required_failed = failed.intersection(required_revisions)
62
 
        if len(required_failed) > 0:
63
 
            raise bzrlib.errors.InstallFailed(required_failed)
64
 
        for rev_id in failed:
65
 
            note("Failed to install %s" % rev_id)
66
 
        all_failed.update(failed)
67
 
        new_missing = set() 
68
 
        for rev_id in missing:
69
 
            try:
70
 
                revision = from_branch.get_revision(rev_id)
71
 
            except bzrlib.errors.NoSuchRevision:
72
 
                if revision in from_history:
73
 
                    raise
74
 
                else:
75
 
                    continue
76
 
            for parent in [p.revision_id for p in revision.parents]:
77
 
                if not has_revision(to_branch, parent):
78
 
                    new_missing.add(parent)
79
 
        missing = new_missing
80
 
    return count, all_failed
81
 
 
82
 
 
 
105
            self.pb = pb
 
106
            self.nested_pb = None
 
107
        self.from_repository.lock_read()
 
108
        try:
 
109
            self.to_repository.lock_write()
 
110
            try:
 
111
                self.__fetch()
 
112
            finally:
 
113
                if self.nested_pb is not None:
 
114
                    self.nested_pb.finished()
 
115
                self.to_repository.unlock()
 
116
        finally:
 
117
            self.from_repository.unlock()
 
118
 
 
119
    def __fetch(self):
 
120
        """Primary worker function.
 
121
 
 
122
        This initialises all the needed variables, and then fetches the 
 
123
        requested revisions, finally clearing the progress bar.
 
124
        """
 
125
        self.to_weaves = self.to_repository.weave_store
 
126
        self.to_control = self.to_repository.control_weaves
 
127
        self.from_weaves = self.from_repository.weave_store
 
128
        self.from_control = self.from_repository.control_weaves
 
129
        self.count_total = 0
 
130
        self.file_ids_names = {}
 
131
        pp = ProgressPhase('Fetch phase', 4, self.pb)
 
132
        try:
 
133
            pp.next_phase()
 
134
            revs = self._revids_to_fetch()
 
135
            # something to do ?
 
136
            if revs:
 
137
                pp.next_phase()
 
138
                self._fetch_weave_texts(revs)
 
139
                pp.next_phase()
 
140
                self._fetch_inventory_weave(revs)
 
141
                pp.next_phase()
 
142
                self._fetch_revision_texts(revs)
 
143
                self.count_copied += len(revs)
 
144
        finally:
 
145
            self.pb.clear()
 
146
 
 
147
    def _revids_to_fetch(self):
 
148
        mutter('fetch up to rev {%s}', self._last_revision)
 
149
        if self._last_revision is NULL_REVISION:
 
150
            # explicit limit of no revisions needed
 
151
            return None
 
152
        if (self._last_revision is not None and
 
153
            self.to_repository.has_revision(self._last_revision)):
 
154
            return None
 
155
            
 
156
        try:
 
157
            return self.to_repository.missing_revision_ids(self.from_repository,
 
158
                                                           self._last_revision)
 
159
        except errors.NoSuchRevision:
 
160
            raise InstallFailed([self._last_revision])
 
161
 
 
162
    def _fetch_weave_texts(self, revs):
 
163
        texts_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
164
        try:
 
165
            # fileids_altered_by_revision_ids requires reading the inventory
 
166
            # weave, we will need to read the inventory weave again when
 
167
            # all this is done, so enable caching for that specific weave
 
168
            inv_w = self.from_repository.get_inventory_weave()
 
169
            inv_w.enable_cache()
 
170
            file_ids = self.from_repository.fileids_altered_by_revision_ids(revs)
 
171
            count = 0
 
172
            num_file_ids = len(file_ids)
 
173
            for file_id, required_versions in file_ids.items():
 
174
                texts_pb.update("fetch texts", count, num_file_ids)
 
175
                count +=1
 
176
                to_weave = self.to_weaves.get_weave_or_empty(file_id,
 
177
                    self.to_repository.get_transaction())
 
178
                from_weave = self.from_weaves.get_weave(file_id,
 
179
                    self.from_repository.get_transaction())
 
180
                # we fetch all the texts, because texts do
 
181
                # not reference anything, and its cheap enough
 
182
                to_weave.join(from_weave, version_ids=required_versions)
 
183
                # we don't need *all* of this data anymore, but we dont know
 
184
                # what we do. This cache clearing will result in a new read 
 
185
                # of the knit data when we do the checkout, but probably we
 
186
                # want to emit the needed data on the fly rather than at the
 
187
                # end anyhow.
 
188
                # the from weave should know not to cache data being joined,
 
189
                # but its ok to ask it to clear.
 
190
                from_weave.clear_cache()
 
191
                to_weave.clear_cache()
 
192
        finally:
 
193
            texts_pb.finished()
 
194
 
 
195
    def _fetch_inventory_weave(self, revs):
 
196
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
197
        try:
 
198
            pb.update("fetch inventory", 0, 2)
 
199
            to_weave = self.to_control.get_weave('inventory',
 
200
                    self.to_repository.get_transaction())
 
201
    
 
202
            child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
203
            try:
 
204
                # just merge, this is optimisable and its means we don't
 
205
                # copy unreferenced data such as not-needed inventories.
 
206
                pb.update("fetch inventory", 1, 3)
 
207
                from_weave = self.from_repository.get_inventory_weave()
 
208
                pb.update("fetch inventory", 2, 3)
 
209
                # we fetch only the referenced inventories because we do not
 
210
                # know for unselected inventories whether all their required
 
211
                # texts are present in the other repository - it could be
 
212
                # corrupt.
 
213
                to_weave.join(from_weave, pb=child_pb, msg='merge inventory',
 
214
                              version_ids=revs)
 
215
                from_weave.clear_cache()
 
216
            finally:
 
217
                child_pb.finished()
 
218
        finally:
 
219
            pb.finished()
 
220
 
 
221
 
 
222
class GenericRepoFetcher(RepoFetcher):
 
223
    """This is a generic repo to repo fetcher.
 
224
 
 
225
    This makes minimal assumptions about repo layout and contents.
 
226
    It triggers a reconciliation after fetching to ensure integrity.
 
227
    """
 
228
 
 
229
    def _fetch_revision_texts(self, revs):
 
230
        """Fetch revision object texts"""
 
231
        rev_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
232
        try:
 
233
            to_txn = self.to_transaction = self.to_repository.get_transaction()
 
234
            count = 0
 
235
            total = len(revs)
 
236
            to_store = self.to_repository._revision_store
 
237
            for rev in revs:
 
238
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
239
                try:
 
240
                    pb.update('copying revisions', count, total)
 
241
                    try:
 
242
                        sig_text = self.from_repository.get_signature_text(rev)
 
243
                        to_store.add_revision_signature_text(rev, sig_text, to_txn)
 
244
                    except errors.NoSuchRevision:
 
245
                        # not signed.
 
246
                        pass
 
247
                    to_store.add_revision(self.from_repository.get_revision(rev),
 
248
                                          to_txn)
 
249
                    count += 1
 
250
                finally:
 
251
                    pb.finished()
 
252
            # fixup inventory if needed: 
 
253
            # this is expensive because we have no inverse index to current ghosts.
 
254
            # but on local disk its a few seconds and sftp push is already insane.
 
255
            # so we just-do-it.
 
256
            # FIXME: repository should inform if this is needed.
 
257
            self.to_repository.reconcile()
 
258
        finally:
 
259
            rev_pb.finished()
 
260
    
 
261
 
 
262
class KnitRepoFetcher(RepoFetcher):
 
263
    """This is a knit format repository specific fetcher.
 
264
 
 
265
    This differs from the GenericRepoFetcher by not doing a 
 
266
    reconciliation after copying, and using knit joining to
 
267
    copy revision texts.
 
268
    """
 
269
 
 
270
    def _fetch_revision_texts(self, revs):
 
271
        # may need to be a InterRevisionStore call here.
 
272
        from_transaction = self.from_repository.get_transaction()
 
273
        to_transaction = self.to_repository.get_transaction()
 
274
        to_sf = self.to_repository._revision_store.get_signature_file(
 
275
            to_transaction)
 
276
        from_sf = self.from_repository._revision_store.get_signature_file(
 
277
            from_transaction)
 
278
        to_sf.join(from_sf, version_ids=revs, ignore_missing=True)
 
279
        to_rf = self.to_repository._revision_store.get_revision_file(
 
280
            to_transaction)
 
281
        from_rf = self.from_repository._revision_store.get_revision_file(
 
282
            from_transaction)
 
283
        to_rf.join(from_rf, version_ids=revs)
 
284
 
 
285
 
 
286
class Inter1and2Helper(object):
 
287
    """Helper for operations that convert data from model 1 and 2
 
288
    
 
289
    This is for use by fetchers and converters.
 
290
    """
 
291
 
 
292
    def __init__(self, source, target):
 
293
        """Constructor.
 
294
 
 
295
        :param source: The repository data comes from
 
296
        :param target: The repository data goes to
 
297
        """
 
298
        self.source = source
 
299
        self.target = target
 
300
 
 
301
    def iter_rev_trees(self, revs):
 
302
        """Iterate through RevisionTrees efficiently.
 
303
 
 
304
        Additionally, the inventory's revision_id is set if unset.
 
305
 
 
306
        Trees are retrieved in batches of 100, and then yielded in the order
 
307
        they were requested.
 
308
 
 
309
        :param revs: A list of revision ids
 
310
        """
 
311
        while revs:
 
312
            for tree in self.source.revision_trees(revs[:100]):
 
313
                if tree.inventory.revision_id is None:
 
314
                    tree.inventory.revision_id = tree.get_revision_id()
 
315
                yield tree
 
316
            revs = revs[100:]
 
317
 
 
318
    def generate_root_texts(self, revs):
 
319
        """Generate VersionedFiles for all root ids.
 
320
        
 
321
        :param revs: the revisions to include
 
322
        """
 
323
        inventory_weave = self.source.get_inventory_weave()
 
324
        parent_texts = {}
 
325
        versionedfile = {}
 
326
        to_store = self.target.weave_store
 
327
        for tree in self.iter_rev_trees(revs):
 
328
            revision_id = tree.inventory.root.revision
 
329
            root_id = tree.inventory.root.file_id
 
330
            parents = inventory_weave.get_parents(revision_id)
 
331
            if root_id not in versionedfile:
 
332
                versionedfile[root_id] = to_store.get_weave_or_empty(root_id, 
 
333
                    self.target.get_transaction())
 
334
            parent_texts[root_id] = versionedfile[root_id].add_lines(
 
335
                revision_id, parents, [], parent_texts)
 
336
 
 
337
    def regenerate_inventory(self, revs):
 
338
        """Generate a new inventory versionedfile in target, convertin data.
 
339
        
 
340
        The inventory is retrieved from the source, (deserializing it), and
 
341
        stored in the target (reserializing it in a different format).
 
342
        :param revs: The revisions to include
 
343
        """
 
344
        inventory_weave = self.source.get_inventory_weave()
 
345
        for tree in self.iter_rev_trees(revs):
 
346
            parents = inventory_weave.get_parents(tree.get_revision_id())
 
347
            self.target.add_inventory(tree.get_revision_id(), tree.inventory,
 
348
                                      parents)
 
349
 
 
350
 
 
351
class Model1toKnit2Fetcher(GenericRepoFetcher):
 
352
    """Fetch from a Model1 repository into a Knit2 repository
 
353
    """
 
354
    def __init__(self, to_repository, from_repository, last_revision=None, 
 
355
                 pb=None):
 
356
        self.helper = Inter1and2Helper(from_repository, to_repository)
 
357
        GenericRepoFetcher.__init__(self, to_repository, from_repository,
 
358
                                    last_revision, pb)
 
359
 
 
360
    def _fetch_weave_texts(self, revs):
 
361
        GenericRepoFetcher._fetch_weave_texts(self, revs)
 
362
        # Now generate a weave for the tree root
 
363
        self.helper.generate_root_texts(revs)
 
364
 
 
365
    def _fetch_inventory_weave(self, revs):
 
366
        self.helper.regenerate_inventory(revs)
 
367
 
 
368
 
 
369
class Knit1to2Fetcher(KnitRepoFetcher):
 
370
    """Fetch from a Knit1 repository into a Knit2 repository"""
 
371
 
 
372
    def __init__(self, to_repository, from_repository, last_revision=None, 
 
373
                 pb=None):
 
374
        self.helper = Inter1and2Helper(from_repository, to_repository)
 
375
        KnitRepoFetcher.__init__(self, to_repository, from_repository,
 
376
                                 last_revision, pb)
 
377
 
 
378
    def _fetch_weave_texts(self, revs):
 
379
        KnitRepoFetcher._fetch_weave_texts(self, revs)
 
380
        # Now generate a weave for the tree root
 
381
        self.helper.generate_root_texts(revs)
 
382
 
 
383
    def _fetch_inventory_weave(self, revs):
 
384
        self.helper.regenerate_inventory(revs)
 
385
        
 
386
 
 
387
class Fetcher(object):
 
388
    """Backwards compatibility glue for branch.fetch()."""
 
389
 
 
390
    @deprecated_method(zero_eight)
 
391
    def __init__(self, to_branch, from_branch, last_revision=None, pb=None):
 
392
        """Please see branch.fetch()."""
 
393
        to_branch.fetch(from_branch, last_revision, pb)