~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/fetch.py

  • Committer: Martin Pool
  • Date: 2005-09-16 08:23:10 UTC
  • Revision ID: mbp@sourcefrog.net-20050916082310-ecb5a25c40253839
- wrap wide strings when showing exceptions

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006 by Canonical Ltd
 
1
# Copyright (C) 2005 by 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
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.errors
 
21
from bzrlib.trace import mutter, note, warning
 
22
from bzrlib.branch import Branch, INVENTORY_FILEID, ANCESTRY_FILEID
 
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
17
27
 
18
28
"""Copying of history from one branch to another.
19
29
 
26
36
add a revision to the store until everything it refers to is also
27
37
stored, so that if a revision is present we can totally recreate it.
28
38
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.
 
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.
32
41
"""
33
42
 
34
 
import bzrlib
35
 
import bzrlib.errors as errors
36
 
from bzrlib.errors import (InstallFailed, NoSuchRevision,
37
 
                           MissingText)
38
 
from bzrlib.trace import mutter
39
 
from bzrlib.progress import ProgressBar, ProgressPhase
40
 
from bzrlib.reconcile import RepoReconciler
41
 
from bzrlib.revision import NULL_REVISION
42
 
from bzrlib.symbol_versioning import *
43
 
 
44
 
 
45
43
# TODO: Avoid repeatedly opening weaves so many times.
46
44
 
47
45
# XXX: This doesn't handle ghost (not present in branch) revisions at
60
58
#   and add in all file versions
61
59
 
62
60
 
63
 
@deprecated_function(zero_eight)
 
61
 
64
62
def greedy_fetch(to_branch, from_branch, revision=None, pb=None):
65
 
    """Legacy API, please see branch.fetch(from_branch, last_revision, pb)."""
66
63
    f = Fetcher(to_branch, from_branch, revision, pb)
67
64
    return f.count_copied, f.failed_revisions
68
65
 
69
 
fetch = greedy_fetch
70
 
 
71
 
 
72
 
class RepoFetcher(object):
73
 
    """Pull revisions and texts from one repository to another.
74
 
 
75
 
    last_revision
76
 
        if set, try to limit to the data this revision references.
77
 
 
78
 
    after running:
 
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
 
79
83
    count_copied -- number of revisions copied
80
84
 
81
 
    This should not be used directory, its essential a object to encapsulate
82
 
    the logic in InterRepository.fetch().
 
85
    count_texts -- number of file texts copied
83
86
    """
84
 
    def __init__(self, to_repository, from_repository, last_revision=None, pb=None):
85
 
        # result variables.
 
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.from_branch = from_branch
 
91
        self.from_weaves = from_branch.weave_store
86
92
        self.failed_revisions = []
87
93
        self.count_copied = 0
88
 
        if to_repository.control_files._transport.base == from_repository.control_files._transport.base:
89
 
            # check that last_revision is in 'from' and then return a no-operation.
90
 
            if last_revision not in (None, NULL_REVISION):
91
 
                from_repository.get_revision(last_revision)
92
 
            return
93
 
        self.to_repository = to_repository
94
 
        self.from_repository = from_repository
95
 
        # must not mutate self._last_revision as its potentially a shared instance
96
 
        self._last_revision = last_revision
 
94
        self.count_total = 0
 
95
        self.count_texts = 0
97
96
        if pb is None:
98
 
            self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
99
 
            self.nested_pb = self.pb
 
97
            self.pb = bzrlib.ui.ui_factory.progress_bar()
100
98
        else:
101
99
            self.pb = pb
102
 
            self.nested_pb = None
103
 
        self.from_repository.lock_read()
104
 
        try:
105
 
            self.to_repository.lock_write()
106
 
            try:
107
 
                self.__fetch()
108
 
            finally:
109
 
                if self.nested_pb is not None:
110
 
                    self.nested_pb.finished()
111
 
                self.to_repository.unlock()
112
 
        finally:
113
 
            self.from_repository.unlock()
114
 
 
115
 
    def __fetch(self):
116
 
        """Primary worker function.
117
 
 
118
 
        This initialises all the needed variables, and then fetches the 
119
 
        requested revisions, finally clearing the progress bar.
120
 
        """
121
 
        self.to_weaves = self.to_repository.weave_store
122
 
        self.to_control = self.to_repository.control_weaves
123
 
        self.from_weaves = self.from_repository.weave_store
124
 
        self.from_control = self.from_repository.control_weaves
125
 
        self.count_total = 0
126
 
        self.file_ids_names = {}
127
 
        pp = ProgressPhase('fetch phase', 4, self.pb)
128
 
        try:
129
 
            revs = self._revids_to_fetch()
130
 
            # something to do ?
131
 
            if revs:
132
 
                pp.next_phase()
133
 
                self._fetch_weave_texts(revs)
134
 
                pp.next_phase()
135
 
                self._fetch_inventory_weave(revs)
136
 
                pp.next_phase()
137
 
                self._fetch_revision_texts(revs)
138
 
                self.count_copied += len(revs)
139
 
        finally:
140
 
            self.pb.clear()
141
 
 
142
 
    def _revids_to_fetch(self):
143
 
        mutter('fetch up to rev {%s}', self._last_revision)
144
 
        if self._last_revision is NULL_REVISION:
145
 
            # explicit limit of no revisions needed
146
 
            return None
147
 
        if (self._last_revision != None and
148
 
            self.to_repository.has_revision(self._last_revision)):
149
 
            return None
 
100
        self.last_revision = self._find_last_revision(last_revision)
 
101
        mutter('fetch up to rev {%s}', self.last_revision)
 
102
        revs_to_fetch = self._compare_ancestries()
 
103
        self._copy_revisions(revs_to_fetch)
 
104
        self.new_ancestry = revs_to_fetch
 
105
 
 
106
        
 
107
 
 
108
    def _find_last_revision(self, last_revision):
 
109
        """Find the limiting source revision.
 
110
 
 
111
        Every ancestor of that revision will be merged across.
 
112
 
 
113
        Returns the revision_id, or returns None if there's no history
 
114
        in the source branch."""
 
115
        self.pb.update('get source history')
 
116
        from_history = self.from_branch.revision_history()
 
117
        self.pb.update('get destination history')
 
118
        if last_revision:
 
119
            if last_revision not in from_history:
 
120
                raise NoSuchRevision(self.from_branch, last_revision)
 
121
            else:
 
122
                return last_revision
 
123
        elif from_history:
 
124
            return from_history[-1]
 
125
        else:
 
126
            return None                 # no history in the source branch
150
127
            
151
 
        try:
152
 
            return self.to_repository.missing_revision_ids(self.from_repository,
153
 
                                                           self._last_revision)
154
 
        except errors.NoSuchRevision:
155
 
            raise InstallFailed([self._last_revision])
156
 
 
157
 
    def _fetch_weave_texts(self, revs):
158
 
        texts_pb = bzrlib.ui.ui_factory.nested_progress_bar()
159
 
        try:
160
 
            file_ids = self.from_repository.fileids_altered_by_revision_ids(revs)
161
 
            count = 0
162
 
            num_file_ids = len(file_ids)
163
 
            for file_id, required_versions in file_ids.items():
164
 
                texts_pb.update("fetch texts", count, num_file_ids)
165
 
                count +=1
166
 
                to_weave = self.to_weaves.get_weave_or_empty(file_id,
167
 
                    self.to_repository.get_transaction())
168
 
                from_weave = self.from_weaves.get_weave(file_id,
169
 
                    self.from_repository.get_transaction())
170
 
                # we fetch all the texts, because texts do
171
 
                # not reference anything, and its cheap enough
172
 
                to_weave.join(from_weave, version_ids=required_versions)
173
 
        finally:
174
 
            texts_pb.finished()
175
 
 
176
 
    def _fetch_inventory_weave(self, revs):
177
 
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
178
 
        try:
179
 
            pb.update("fetch inventory", 0, 2)
180
 
            to_weave = self.to_control.get_weave('inventory',
181
 
                    self.to_repository.get_transaction())
182
 
    
183
 
            child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
184
 
            try:
185
 
                # just merge, this is optimisable and its means we dont
186
 
                # copy unreferenced data such as not-needed inventories.
187
 
                pb.update("fetch inventory", 1, 3)
188
 
                from_weave = self.from_repository.get_inventory_weave()
189
 
                pb.update("fetch inventory", 2, 3)
190
 
                # we fetch only the referenced inventories because we do not
191
 
                # know for unselected inventories whether all their required
192
 
                # texts are present in the other repository - it could be
193
 
                # corrupt.
194
 
                to_weave.join(from_weave, pb=child_pb, msg='merge inventory',
195
 
                              version_ids=revs)
196
 
            finally:
197
 
                child_pb.finished()
198
 
        finally:
199
 
            pb.finished()
200
 
 
201
 
 
202
 
class GenericRepoFetcher(RepoFetcher):
203
 
    """This is a generic repo to repo fetcher.
204
 
 
205
 
    This makes minimal assumptions about repo layout and contents.
206
 
    It triggers a reconciliation after fetching to ensure integrity.
207
 
    """
208
 
 
209
 
    def _fetch_revision_texts(self, revs):
210
 
        """Fetch revision object texts"""
211
 
        rev_pb = bzrlib.ui.ui_factory.nested_progress_bar()
212
 
        try:
213
 
            to_txn = self.to_transaction = self.to_repository.get_transaction()
214
 
            count = 0
215
 
            total = len(revs)
216
 
            to_store = self.to_repository._revision_store
217
 
            for rev in revs:
218
 
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
219
 
                try:
220
 
                    pb.update('copying revisions', count, total)
221
 
                    try:
222
 
                        sig_text = self.from_repository.get_signature_text(rev)
223
 
                        to_store.add_revision_signature_text(rev, sig_text, to_txn)
224
 
                    except errors.NoSuchRevision:
225
 
                        # not signed.
226
 
                        pass
227
 
                    to_store.add_revision(self.from_repository.get_revision(rev),
228
 
                                          to_txn)
229
 
                    count += 1
230
 
                finally:
231
 
                    pb.finished()
232
 
            # fixup inventory if needed: 
233
 
            # this is expensive because we have no inverse index to current ghosts.
234
 
            # but on local disk its a few seconds and sftp push is already insane.
235
 
            # so we just-do-it.
236
 
            # FIXME: repository should inform if this is needed.
237
 
            self.to_repository.reconcile()
238
 
        finally:
239
 
            rev_pb.finished()
240
 
    
241
 
 
242
 
class KnitRepoFetcher(RepoFetcher):
243
 
    """This is a knit format repository specific fetcher.
244
 
 
245
 
    This differs from the GenericRepoFetcher by not doing a 
246
 
    reconciliation after copying, and using knit joining to
247
 
    copy revision texts.
248
 
    """
249
 
 
250
 
    def _fetch_revision_texts(self, revs):
251
 
        # may need to be a InterRevisionStore call here.
252
 
        from_transaction = self.from_repository.get_transaction()
253
 
        to_transaction = self.to_repository.get_transaction()
254
 
        to_sf = self.to_repository._revision_store.get_signature_file(
255
 
            to_transaction)
256
 
        from_sf = self.from_repository._revision_store.get_signature_file(
257
 
            from_transaction)
258
 
        to_sf.join(from_sf, version_ids=revs, ignore_missing=True)
259
 
        to_rf = self.to_repository._revision_store.get_revision_file(
260
 
            to_transaction)
261
 
        from_rf = self.from_repository._revision_store.get_revision_file(
262
 
            from_transaction)
263
 
        to_rf.join(from_rf, version_ids=revs)
264
 
 
265
 
 
266
 
class Fetcher(object):
267
 
    """Backwards compatability glue for branch.fetch()."""
268
 
 
269
 
    @deprecated_method(zero_eight)
270
 
    def __init__(self, to_branch, from_branch, last_revision=None, pb=None):
271
 
        """Please see branch.fetch()."""
272
 
        to_branch.fetch(from_branch, last_revision, pb)
 
128
 
 
129
    def _compare_ancestries(self):
 
130
        """Get a list of revisions that must be copied.
 
131
 
 
132
        That is, every revision that's in the ancestry of the source
 
133
        branch and not in the destination branch."""
 
134
        self.pb.update('get source ancestry')
 
135
        self.from_ancestry = self.from_branch.get_ancestry(self.last_revision)
 
136
 
 
137
        dest_last_rev = self.to_branch.last_revision()
 
138
        self.pb.update('get destination ancestry')
 
139
        if dest_last_rev:
 
140
            dest_ancestry = self.to_branch.get_ancestry(dest_last_rev)
 
141
        else:
 
142
            dest_ancestry = []
 
143
        ss = set(dest_ancestry)
 
144
        to_fetch = []
 
145
        for rev_id in self.from_ancestry:
 
146
            if rev_id not in ss:
 
147
                to_fetch.append(rev_id)
 
148
                mutter('need to get revision {%s}', rev_id)
 
149
        mutter('need to get %d revisions in total', len(to_fetch))
 
150
        self.count_total = len(to_fetch)
 
151
        return to_fetch
 
152
                
 
153
 
 
154
 
 
155
    def _copy_revisions(self, revs_to_fetch):
 
156
        i = 0
 
157
        for rev_id in revs_to_fetch:
 
158
            i += 1
 
159
            if self.to_branch.has_revision(rev_id):
 
160
                continue
 
161
            self.pb.update('fetch revision', i, self.count_total)
 
162
            self._copy_one_revision(rev_id)
 
163
            self.count_copied += 1
 
164
 
 
165
 
 
166
    def _copy_one_revision(self, rev_id):
 
167
        """Copy revision and everything referenced by it."""
 
168
        mutter('copying revision {%s}', rev_id)
 
169
        rev_xml = self.from_branch.get_revision_xml(rev_id)
 
170
        inv_xml = self.from_branch.get_inventory_xml(rev_id)
 
171
        rev = serializer_v5.read_revision_from_string(rev_xml)
 
172
        inv = serializer_v5.read_inventory_from_string(inv_xml)
 
173
        assert rev.revision_id == rev_id
 
174
        assert rev.inventory_sha1 == sha_string(inv_xml)
 
175
        mutter('  commiter %s, %d parents',
 
176
               rev.committer,
 
177
               len(rev.parents))
 
178
        self._copy_new_texts(rev_id, inv)
 
179
        parent_ids = [x.revision_id for x in rev.parents]
 
180
        self._copy_inventory(rev_id, inv_xml, parent_ids)
 
181
        self._copy_ancestry(rev_id, parent_ids)
 
182
        self.to_branch.revision_store.add(StringIO(rev_xml), rev_id)
 
183
 
 
184
 
 
185
    def _copy_inventory(self, rev_id, inv_xml, parent_ids):
 
186
        self.to_weaves.add_text(INVENTORY_FILEID, rev_id,
 
187
                                split_lines(inv_xml), parent_ids)
 
188
 
 
189
 
 
190
    def _copy_ancestry(self, rev_id, parent_ids):
 
191
        ancestry_lines = self.from_weaves.get_lines(ANCESTRY_FILEID, rev_id)
 
192
        self.to_weaves.add_text(ANCESTRY_FILEID, rev_id, ancestry_lines,
 
193
                                parent_ids)
 
194
 
 
195
        
 
196
    def _copy_new_texts(self, rev_id, inv):
 
197
        """Copy any new texts occuring in this revision."""
 
198
        # TODO: Rather than writing out weaves every time, hold them
 
199
        # in memory until everything's done?  But this way is nicer
 
200
        # if it's interrupted.
 
201
        for path, ie in inv.iter_entries():
 
202
            if ie.kind != 'file':
 
203
                continue
 
204
            if ie.text_version != rev_id:
 
205
                continue
 
206
            mutter('%s {%s} is changed in this revision',
 
207
                   path, ie.file_id)
 
208
            self._copy_one_text(rev_id, ie.file_id)
 
209
 
 
210
 
 
211
    def _copy_one_text(self, rev_id, file_id):
 
212
        """Copy one file text."""
 
213
        mutter('copy text version {%s} of file {%s}',
 
214
               rev_id, file_id)
 
215
        from_weave = self.from_weaves.get_weave(file_id)
 
216
        from_idx = from_weave.lookup(rev_id)
 
217
        from_parents = map(from_weave.idx_to_name, from_weave.parents(from_idx))
 
218
        text_lines = from_weave.get(from_idx)
 
219
        to_weave = self.to_weaves.get_weave_or_empty(file_id)
 
220
        to_parents = map(to_weave.lookup, from_parents)
 
221
        # it's ok to add even if the text is already there
 
222
        to_weave.add(rev_id, to_parents, text_lines)
 
223
        self.to_weaves.put_weave(file_id, to_weave)
 
224
        self.count_texts += 1
 
225
 
 
226
 
 
227
fetch = Fetcher