~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/fetch.py

  • Committer: Aaron Bentley
  • Date: 2006-11-10 01:55:55 UTC
  • mto: This revision was merged to the branch mainline in revision 2127.
  • Revision ID: aaron.bentley@utoronto.ca-20061110015555-f48202744b630209
Ignore html docs (both kinds)

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
16
 
17
 
import os
18
 
from cStringIO import StringIO
19
 
 
20
 
import bzrlib
21
 
import bzrlib.errors as errors
22
 
from bzrlib.errors import InstallFailed, NoSuchRevision, WeaveError
23
 
from bzrlib.trace import mutter, note, warning
24
 
from bzrlib.branch import Branch
25
 
from bzrlib.progress import ProgressBar
26
 
from bzrlib.xml5 import serializer_v5
27
 
from bzrlib.osutils import sha_string, split_lines
28
17
 
29
18
"""Copying of history from one branch to another.
30
19
 
37
26
add a revision to the store until everything it refers to is also
38
27
stored, so that if a revision is present we can totally recreate it.
39
28
However, we can't know what files are included in a revision until we
40
 
read its inventory.  Therefore, we first pull the XML and hold it in
41
 
memory until we've updated all of the files referenced.
 
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.
42
32
"""
43
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
 
44
47
# TODO: Avoid repeatedly opening weaves so many times.
45
48
 
46
49
# XXX: This doesn't handle ghost (not present in branch) revisions at
59
62
#   and add in all file versions
60
63
 
61
64
 
62
 
 
 
65
@deprecated_function(zero_eight)
63
66
def greedy_fetch(to_branch, from_branch, revision=None, pb=None):
 
67
    """Legacy API, please see branch.fetch(from_branch, last_revision, pb)."""
64
68
    f = Fetcher(to_branch, from_branch, revision, pb)
65
69
    return f.count_copied, f.failed_revisions
66
70
 
67
 
 
68
 
 
69
 
class Fetcher(object):
70
 
    """Pull revisions and texts from one branch to another.
71
 
 
72
 
    This doesn't update the destination's history; that can be done
73
 
    separately if desired.  
74
 
 
75
 
    revision_limit
76
 
        If set, pull only up to this revision_id.
77
 
 
78
 
    After running:
79
 
 
80
 
    last_revision -- if last_revision
81
 
        is given it will be that, otherwise the last revision of
82
 
        from_branch
83
 
 
 
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:
84
81
    count_copied -- number of revisions copied
85
82
 
86
 
    count_weaves -- number of file weaves copied
 
83
    This should not be used directory, its essential a object to encapsulate
 
84
    the logic in InterRepository.fetch().
87
85
    """
88
 
    def __init__(self, to_branch, from_branch, last_revision=None, pb=None):
89
 
        if to_branch == from_branch:
90
 
            raise Exception("can't fetch from a branch to itself")
91
 
        self.to_branch = to_branch
92
 
        self.to_weaves = to_branch.weave_store
93
 
        self.to_control = to_branch.control_weaves
94
 
        self.from_branch = from_branch
95
 
        self.from_weaves = from_branch.weave_store
96
 
        self.from_control = from_branch.control_weaves
 
86
    def __init__(self, to_repository, from_repository, last_revision=None, pb=None):
 
87
        # result variables.
97
88
        self.failed_revisions = []
98
89
        self.count_copied = 0
99
 
        self.count_total = 0
100
 
        self.count_weaves = 0
101
 
        self.copied_file_ids = set()
 
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
102
99
        if pb is None:
103
 
            self.pb = bzrlib.ui.ui_factory.progress_bar()
 
100
            self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
101
            self.nested_pb = self.pb
104
102
        else:
105
103
            self.pb = pb
106
 
        self.from_branch.lock_read()
107
 
        try:
108
 
            self._fetch_revisions(last_revision)
109
 
        finally:
110
 
            self.from_branch.unlock()
 
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:
111
143
            self.pb.clear()
112
144
 
113
 
    def _fetch_revisions(self, last_revision):
114
 
        self.last_revision = self._find_last_revision(last_revision)
115
 
        mutter('fetch up to rev {%s}', self.last_revision)
116
 
        if (self.last_revision is not None and 
117
 
            self.to_branch.has_revision(self.last_revision)):
118
 
            return
119
 
        try:
120
 
            revs_to_fetch = self._compare_ancestries()
121
 
        except WeaveError:
122
 
            raise InstallFailed([self.last_revision])
123
 
        self._copy_revisions(revs_to_fetch)
124
 
        self.new_ancestry = revs_to_fetch
125
 
 
126
 
    def _find_last_revision(self, last_revision):
127
 
        """Find the limiting source revision.
128
 
 
129
 
        Every ancestor of that revision will be merged across.
130
 
 
131
 
        Returns the revision_id, or returns None if there's no history
132
 
        in the source branch."""
133
 
        if last_revision:
134
 
            return last_revision
135
 
        self.pb.update('get source history')
136
 
        from_history = self.from_branch.revision_history()
137
 
        self.pb.update('get destination history')
138
 
        if from_history:
139
 
            return from_history[-1]
140
 
        else:
141
 
            return None                 # no history in the source branch
 
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
142
153
            
143
 
 
144
 
    def _compare_ancestries(self):
145
 
        """Get a list of revisions that must be copied.
146
 
 
147
 
        That is, every revision that's in the ancestry of the source
148
 
        branch and not in the destination branch."""
149
 
        self.pb.update('get source ancestry')
150
 
        self.from_ancestry = self.from_branch.get_ancestry(self.last_revision)
151
 
 
152
 
        dest_last_rev = self.to_branch.last_revision()
153
 
        self.pb.update('get destination ancestry')
154
 
        if dest_last_rev:
155
 
            dest_ancestry = self.to_branch.get_ancestry(dest_last_rev)
156
 
        else:
157
 
            dest_ancestry = []
158
 
        ss = set(dest_ancestry)
159
 
        to_fetch = []
160
 
        for rev_id in self.from_ancestry:
161
 
            if rev_id not in ss:
162
 
                to_fetch.append(rev_id)
163
 
                mutter('need to get revision {%s}', rev_id)
164
 
        mutter('need to get %d revisions in total', len(to_fetch))
165
 
        self.count_total = len(to_fetch)
166
 
        return to_fetch
167
 
 
168
 
    def _copy_revisions(self, revs_to_fetch):
169
 
        i = 0
170
 
        for rev_id in revs_to_fetch:
171
 
            i += 1
172
 
            if rev_id is None:
173
 
                continue
174
 
            if self.to_branch.has_revision(rev_id):
175
 
                continue
176
 
            self.pb.update('fetch revision', i, self.count_total)
177
 
            self._copy_one_revision(rev_id)
178
 
            self.count_copied += 1
179
 
 
180
 
 
181
 
    def _copy_one_revision(self, rev_id):
182
 
        """Copy revision and everything referenced by it."""
183
 
        mutter('copying revision {%s}', rev_id)
184
 
        rev_xml = self.from_branch.get_revision_xml(rev_id)
185
 
        inv_xml = self.from_branch.get_inventory_xml(rev_id)
186
 
        rev = serializer_v5.read_revision_from_string(rev_xml)
187
 
        inv = serializer_v5.read_inventory_from_string(inv_xml)
188
 
        assert rev.revision_id == rev_id
189
 
        assert rev.inventory_sha1 == sha_string(inv_xml)
190
 
        mutter('  commiter %s, %d parents',
191
 
               rev.committer,
192
 
               len(rev.parent_ids))
193
 
        self._copy_new_texts(rev_id, inv)
194
 
        parents = rev.parent_ids
195
 
        for parent in parents:
196
 
            if not self.to_branch.has_revision(parent):
197
 
                parents.pop(parents.index(parent))
198
 
        self._copy_inventory(rev_id, inv_xml, parents)
199
 
        self.to_branch.revision_store.add(StringIO(rev_xml), rev_id)
200
 
        mutter('copied revision %s', rev_id)
201
 
 
202
 
 
203
 
    def _copy_inventory(self, rev_id, inv_xml, parent_ids):
204
 
        self.to_control.add_text('inventory', rev_id,
205
 
                                split_lines(inv_xml), parent_ids,
206
 
                                self.to_branch.get_transaction())
207
 
 
208
 
    def _copy_new_texts(self, rev_id, inv):
209
 
        """Copy any new texts occuring in this revision."""
210
 
        # TODO: Rather than writing out weaves every time, hold them
211
 
        # in memory until everything's done?  But this way is nicer
212
 
        # if it's interrupted.
213
 
        for path, ie in inv.iter_entries():
214
 
            if ie.revision != rev_id:
215
 
                continue
216
 
            mutter('%s {%s} is changed in this revision',
217
 
                   path, ie.file_id)
218
 
            self._copy_one_weave(rev_id, ie.file_id)
219
 
 
220
 
 
221
 
    def _copy_one_weave(self, rev_id, file_id):
222
 
        """Copy one file weave."""
223
 
        mutter('copy file {%s} modified in {%s}', file_id, rev_id)
224
 
        if file_id in self.copied_file_ids:
225
 
            mutter('file {%s} already copied', file_id)
226
 
            return
227
 
        from_weave = self.from_weaves.get_weave(file_id,
228
 
            self.from_branch.get_transaction())
229
 
        to_weave = self.to_weaves.get_weave_or_empty(file_id,
230
 
            self.to_branch.get_transaction())
231
 
        try:
232
 
            to_weave.join(from_weave)
233
 
        except errors.WeaveParentMismatch:
234
 
            to_weave.reweave(from_weave)
235
 
        self.to_weaves.put_weave(file_id, to_weave,
236
 
            self.to_branch.get_transaction())
237
 
        self.count_weaves += 1
238
 
        self.copied_file_ids.add(file_id)
239
 
        mutter('copied file {%s}', file_id)
240
 
 
241
 
 
242
 
fetch = Fetcher
 
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)