← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/fetch.py

  • Committer: John Arbash Meinel
  • Date: 2006-09-20 23:43:18 UTC
  • mto: This revision was merged to the branch mainline in revision 2027.
  • Revision ID: john@arbash-meinel.com-20060920234318-05de23e98f7e7876
Move out export tests from test_too_much, refactor
and re-enable doc tests for export.get_root_name()

Show diffs side-by-side

added added

removed removed

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