~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/fetch.py

  • Committer: Robert Collins
  • Date: 2006-03-11 13:58:48 UTC
  • mto: (1615.1.2 bzr.mbp.integration)
  • mto: This revision was merged to the branch mainline in revision 1616.
  • Revision ID: robertc@robertcollins.net-20060311135848-789fa616b8da4662
Note potential improvements in knit adds.

Show diffs side-by-side

added added

removed removed

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