← 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-08-15 15:50:31 UTC
  • mto: This revision was merged to the branch mainline in revision 1927.
  • Revision ID: john@arbash-meinel.com-20060815155031-f1480d692d2cf9d2
There is no strict ordering file addition, other than directories are added before child files

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
16
 
17
 
from copy import copy
18
 
import os
19
 
from cStringIO import StringIO
20
 
 
21
 
import bzrlib
22
 
import bzrlib.errors as errors
23
 
from bzrlib.errors import (InstallFailed, NoSuchRevision, WeaveError,
24
 
                           MissingText)
25
 
from bzrlib.trace import mutter, note, warning
26
 
from bzrlib.branch import Branch
27
 
from bzrlib.progress import ProgressBar
28
 
from bzrlib.revision import NULL_REVISION
29
 
from bzrlib.xml5 import serializer_v5
30
 
from bzrlib.osutils import sha_string, split_lines
31
17
 
32
18
"""Copying of history from one branch to another.
33
19
 
40
26
add a revision to the store until everything it refers to is also
41
27
stored, so that if a revision is present we can totally recreate it.
42
28
However, we can't know what files are included in a revision until we
43
 
read its inventory.  Therefore, we first pull the XML and hold it in
44
 
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.
45
32
"""
46
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
47
# TODO: Avoid repeatedly opening weaves so many times.
48
48
 
49
49
# XXX: This doesn't handle ghost (not present in branch) revisions at
62
62
#   and add in all file versions
63
63
 
64
64
 
65
 
 
 
65
@deprecated_function(zero_eight)
66
66
def greedy_fetch(to_branch, from_branch, revision=None, pb=None):
 
67
    """Legacy API, please see branch.fetch(from_branch, last_revision, pb)."""
67
68
    f = Fetcher(to_branch, from_branch, revision, pb)
68
69
    return f.count_copied, f.failed_revisions
69
70
 
 
71
fetch = greedy_fetch
 
72
 
70
73
 
71
74
class RepoFetcher(object):
72
75
    """Pull revisions and texts from one repository to another.
76
79
 
77
80
    after running:
78
81
    count_copied -- number of revisions copied
79
 
    count_weaves -- number of file weaves copied
 
82
 
 
83
    This should not be used directory, its essential a object to encapsulate
 
84
    the logic in InterRepository.fetch().
80
85
    """
81
86
    def __init__(self, to_repository, from_repository, last_revision=None, pb=None):
82
 
        if to_repository.bzrdir.transport.base == from_repository.bzrdir.transport.base:
83
 
            raise Exception("can't fetch from a repository to itself %s, %s" % 
84
 
                            (from_repository.bzrdir.transport.base,
85
 
                             to_repository.bzrdir.transport.base))
 
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
86
95
        self.to_repository = to_repository
87
96
        self.from_repository = from_repository
88
97
        # must not mutate self._last_revision as its potentially a shared instance
89
98
        self._last_revision = last_revision
90
99
        if pb is None:
91
 
            self.pb = bzrlib.ui.ui_factory.progress_bar()
 
100
            self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
101
            self.nested_pb = self.pb
92
102
        else:
93
103
            self.pb = pb
 
104
            self.nested_pb = None
94
105
        self.from_repository.lock_read()
95
106
        try:
96
107
            self.to_repository.lock_write()
97
108
            try:
98
109
                self.__fetch()
99
110
            finally:
 
111
                if self.nested_pb is not None:
 
112
                    self.nested_pb.finished()
100
113
                self.to_repository.unlock()
101
114
        finally:
102
115
            self.from_repository.unlock()
111
124
        self.to_control = self.to_repository.control_weaves
112
125
        self.from_weaves = self.from_repository.weave_store
113
126
        self.from_control = self.from_repository.control_weaves
114
 
        self.failed_revisions = []
115
 
        self.count_copied = 0
116
127
        self.count_total = 0
117
 
        self.count_weaves = 0
118
 
        self.copied_file_ids = set()
119
128
        self.file_ids_names = {}
 
129
        pp = ProgressPhase('Fetch phase', 4, self.pb)
120
130
        try:
 
131
            pp.next_phase()
121
132
            revs = self._revids_to_fetch()
122
 
            # nothing to do
123
 
            if revs: 
 
133
            # something to do ?
 
134
            if revs:
 
135
                pp.next_phase()
124
136
                self._fetch_weave_texts(revs)
 
137
                pp.next_phase()
125
138
                self._fetch_inventory_weave(revs)
 
139
                pp.next_phase()
126
140
                self._fetch_revision_texts(revs)
127
141
                self.count_copied += len(revs)
128
142
        finally:
143
157
        except errors.NoSuchRevision:
144
158
            raise InstallFailed([self._last_revision])
145
159
 
146
 
    def _fetch_revision_texts(self, revs):
147
 
        self.to_repository.revision_store.copy_multi(
148
 
            self.from_repository.revision_store,
149
 
            revs,
150
 
            pb=self.pb)
151
 
 
152
160
    def _fetch_weave_texts(self, revs):
153
 
        file_ids = self.from_repository.fileid_involved_by_set(revs)
154
 
        count = 0
155
 
        num_file_ids = len(file_ids)
156
 
        for file_id in file_ids:
157
 
            self.pb.update("merge weave merge", count, num_file_ids)
158
 
            count +=1
159
 
            to_weave = self.to_weaves.get_weave_or_empty(file_id,
160
 
                self.to_repository.get_transaction())
161
 
            from_weave = self.from_weaves.get_weave(file_id,
162
 
                self.from_repository.get_transaction())
163
 
 
164
 
            if to_weave.numversions() > 0:
165
 
                # destination has contents, must merge
 
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()
166
237
                try:
167
 
                    to_weave.join(from_weave)
168
 
                except errors.WeaveParentMismatch:
169
 
                    to_weave.reweave(from_weave)
170
 
            else:
171
 
                # destination is empty, just replace it
172
 
                to_weave = from_weave.copy()
173
 
 
174
 
            self.to_weaves.put_weave(file_id, to_weave,
175
 
                self.to_repository.get_transaction())
176
 
        self.pb.clear()
177
 
 
178
 
    def _fetch_inventory_weave(self, revs):
179
 
        self.pb.update("inventory fetch", 0, 2)
180
 
        from_weave = self.from_repository.get_inventory_weave()
181
 
        to_weave = self.to_repository.get_inventory_weave()
182
 
        self.pb.update("inventory fetch", 1, 2)
183
 
        to_weave = self.to_control.get_weave('inventory',
184
 
                self.to_repository.get_transaction())
185
 
        self.pb.update("inventory fetch", 2, 2)
186
 
 
187
 
        if to_weave.numversions() > 0:
188
 
            # destination has contents, must merge
189
 
            try:
190
 
                to_weave.join(from_weave, pb=self.pb, msg='merge inventory')
191
 
            except errors.WeaveParentMismatch:
192
 
                to_weave.reweave(from_weave, pb=self.pb, msg='reweave inventory')
193
 
        else:
194
 
            # destination is empty, just replace it
195
 
            to_weave = from_weave.copy()
196
 
 
197
 
        self.to_control.put_weave('inventory', to_weave,
198
 
            self.to_repository.get_transaction())
199
 
 
200
 
        self.pb.clear()
 
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)
201
282
 
202
283
 
203
284
class Fetcher(object):
204
 
    """Pull revisions and texts from one branch to another.
205
 
 
206
 
    This doesn't update the destination's history; that can be done
207
 
    separately if desired.  
208
 
 
209
 
    revision_limit
210
 
        If set, pull only up to this revision_id.
211
 
 
212
 
    After running:
213
 
 
214
 
    last_revision -- if last_revision
215
 
        is given it will be that, otherwise the last revision of
216
 
        from_branch
217
 
 
218
 
    count_copied -- number of revisions copied
219
 
 
220
 
    count_weaves -- number of file weaves copied
221
 
    """
 
285
    """Backwards compatibility glue for branch.fetch()."""
 
286
 
 
287
    @deprecated_method(zero_eight)
222
288
    def __init__(self, to_branch, from_branch, last_revision=None, pb=None):
223
 
        if to_branch.base == from_branch.base:
224
 
            raise Exception("can't fetch from a branch to itself %s, %s" % 
225
 
                            (from_branch.base, to_branch.base))
226
 
        
227
 
        self.to_branch = to_branch
228
 
        self.from_branch = from_branch
229
 
        self._last_revision = last_revision
230
 
        if pb is None:
231
 
            self.pb = bzrlib.ui.ui_factory.progress_bar()
232
 
        else:
233
 
            self.pb = pb
234
 
        self.from_branch.lock_read()
235
 
        try:
236
 
            self.to_branch.lock_write()
237
 
            try:
238
 
                self.__fetch()
239
 
            finally:
240
 
                self.to_branch.unlock()
241
 
        finally:
242
 
            self.from_branch.unlock()
243
 
 
244
 
    def __fetch(self):
245
 
        self._find_last_revision()
246
 
        repo_fetcher = RepoFetcher(to_repository=self.to_branch.repository,
247
 
                                   from_repository=self.from_branch.repository,
248
 
                                   pb=self.pb,
249
 
                                   last_revision=self._last_revision)
250
 
        self.failed_revisions = repo_fetcher.failed_revisions
251
 
        self.count_copied = repo_fetcher.count_copied
252
 
        self.count_total = repo_fetcher.count_total
253
 
        self.count_weaves = repo_fetcher.count_weaves
254
 
        self.copied_file_ids = repo_fetcher.copied_file_ids
255
 
 
256
 
    def _find_last_revision(self):
257
 
        """Find the limiting source revision.
258
 
 
259
 
        Every ancestor of that revision will be merged across.
260
 
 
261
 
        Returns the revision_id, or returns None if there's no history
262
 
        in the source branch."""
263
 
        if self._last_revision:
264
 
            return
265
 
        self.pb.update('get source history')
266
 
        from_history = self.from_branch.revision_history()
267
 
        self.pb.update('get destination history')
268
 
        if from_history:
269
 
            self._last_revision = from_history[-1]
270
 
        else:
271
 
            # no history in the source branch
272
 
            self._last_revision = NULL_REVISION
273
 
 
274
 
fetch = Fetcher
 
289
        """Please see branch.fetch()."""
 
290
        to_branch.fetch(from_branch, last_revision, pb)