~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/fetch.py

  • Committer: Aaron Bentley
  • Date: 2006-05-15 11:51:02 UTC
  • mto: (1185.82.108 w-changeset)
  • mto: This revision was merged to the branch mainline in revision 1738.
  • Revision ID: aaron.bentley@utoronto.ca-20060515115102-1f88e5f55acddde8
Started work on testing install_revisions/handling empty changesets

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005 by Canonical Ltd
 
1
# Copyright (C) 2005, 2006 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
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, 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
 
44
45
# TODO: Avoid repeatedly opening weaves so many times.
45
46
 
46
47
# XXX: This doesn't handle ghost (not present in branch) revisions at
59
60
#   and add in all file versions
60
61
 
61
62
 
62
 
 
 
63
@deprecated_function(zero_eight)
63
64
def greedy_fetch(to_branch, from_branch, revision=None, pb=None):
 
65
    """Legacy API, please see branch.fetch(from_branch, last_revision, pb)."""
64
66
    f = Fetcher(to_branch, from_branch, revision, pb)
65
67
    return f.count_copied, f.failed_revisions
66
68
 
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
 
 
 
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:
84
79
    count_copied -- number of revisions copied
85
80
 
86
 
    count_weaves -- number of file weaves copied
 
81
    This should not be used directory, its essential a object to encapsulate
 
82
    the logic in InterRepository.fetch().
87
83
    """
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
 
84
    def __init__(self, to_repository, from_repository, last_revision=None, pb=None):
 
85
        # result variables.
97
86
        self.failed_revisions = []
98
87
        self.count_copied = 0
99
 
        self.count_total = 0
100
 
        self.count_weaves = 0
101
 
        self.copied_file_ids = set()
 
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
102
97
        if pb is None:
103
 
            self.pb = bzrlib.ui.ui_factory.progress_bar()
 
98
            self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
99
            self.nested_pb = self.pb
104
100
        else:
105
101
            self.pb = pb
106
 
        self.from_branch.lock_read()
107
 
        try:
108
 
            self._fetch_revisions(last_revision)
109
 
        finally:
110
 
            self.from_branch.unlock()
 
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:
111
140
            self.pb.clear()
112
141
 
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
 
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
142
150
            
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
 
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)