~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/fetch.py

  • Committer: Martin Pool
  • Date: 2005-05-03 08:00:27 UTC
  • Revision ID: mbp@sourcefrog.net-20050503080027-908edb5b39982198
doc

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006 by Canonical Ltd
2
 
 
3
 
# This program is free software; you can redistribute it and/or modify
4
 
# it under the terms of the GNU General Public License as published by
5
 
# the Free Software Foundation; either version 2 of the License, or
6
 
# (at your option) any later version.
7
 
 
8
 
# This program is distributed in the hope that it will be useful,
9
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
 
# GNU General Public License for more details.
12
 
 
13
 
# You should have received a copy of the GNU General Public License
14
 
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
17
 
 
18
 
"""Copying of history from one branch to another.
19
 
 
20
 
The basic plan is that every branch knows the history of everything
21
 
that has merged into it.  As the first step of a merge, pull, or
22
 
branch operation we copy history from the source into the destination
23
 
branch.
24
 
 
25
 
The copying is done in a slightly complicated order.  We don't want to
26
 
add a revision to the store until everything it refers to is also
27
 
stored, so that if a revision is present we can totally recreate it.
28
 
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.
32
 
"""
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
 
# TODO: Avoid repeatedly opening weaves so many times.
48
 
 
49
 
# XXX: This doesn't handle ghost (not present in branch) revisions at
50
 
# all yet.  I'm not sure they really should be supported.
51
 
 
52
 
# NOTE: This doesn't copy revisions which may be present but not
53
 
# merged into the last revision.  I'm not sure we want to do that.
54
 
 
55
 
# - get a list of revisions that need to be pulled in
56
 
# - for each one, pull in that revision file
57
 
#   and get the inventory, and store the inventory with right
58
 
#   parents.
59
 
# - and get the ancestry, and store that with right parents too
60
 
# - and keep a note of all file ids and version seen
61
 
# - then go through all files; for each one get the weave,
62
 
#   and add in all file versions
63
 
 
64
 
 
65
 
@deprecated_function(zero_eight)
66
 
def greedy_fetch(to_branch, from_branch, revision=None, pb=None):
67
 
    """Legacy API, please see branch.fetch(from_branch, last_revision, pb)."""
68
 
    f = Fetcher(to_branch, from_branch, revision, pb)
69
 
    return f.count_copied, f.failed_revisions
70
 
 
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:
81
 
    count_copied -- number of revisions copied
82
 
 
83
 
    This should not be used directory, its essential a object to encapsulate
84
 
    the logic in InterRepository.fetch().
85
 
    """
86
 
    def __init__(self, to_repository, from_repository, last_revision=None, pb=None):
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
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
99
 
        if pb is None:
100
 
            self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
101
 
            self.nested_pb = self.pb
102
 
        else:
103
 
            self.pb = pb
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:
143
 
            self.pb.clear()
144
 
 
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 != None and
151
 
            self.to_repository.has_revision(self._last_revision)):
152
 
            return None
153
 
            
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
 
            file_ids = self.from_repository.fileids_altered_by_revision_ids(revs)
164
 
            count = 0
165
 
            num_file_ids = len(file_ids)
166
 
            for file_id, required_versions in file_ids.items():
167
 
                texts_pb.update("fetch texts", count, num_file_ids)
168
 
                count +=1
169
 
                to_weave = self.to_weaves.get_weave_or_empty(file_id,
170
 
                    self.to_repository.get_transaction())
171
 
                from_weave = self.from_weaves.get_weave(file_id,
172
 
                    self.from_repository.get_transaction())
173
 
                # we fetch all the texts, because texts do
174
 
                # not reference anything, and its cheap enough
175
 
                to_weave.join(from_weave, version_ids=required_versions) 
176
 
                # we don't need *all* of this data anymore, but we dont know
177
 
                # what we do. This cache clearing will result in a new read 
178
 
                # of the knit data when we do the checkout, but probably we
179
 
                # want to emit the needed data on the fly rather than at the
180
 
                # end anyhow.
181
 
                # the from weave should know not to cache data being joined,
182
 
                # but its ok to ask it to clear.
183
 
                from_weave.clear_cache()
184
 
                to_weave.clear_cache()
185
 
        finally:
186
 
            texts_pb.finished()
187
 
 
188
 
    def _fetch_inventory_weave(self, revs):
189
 
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
190
 
        try:
191
 
            pb.update("fetch inventory", 0, 2)
192
 
            to_weave = self.to_control.get_weave('inventory',
193
 
                    self.to_repository.get_transaction())
194
 
    
195
 
            child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
196
 
            try:
197
 
                # just merge, this is optimisable and its means we don't
198
 
                # copy unreferenced data such as not-needed inventories.
199
 
                pb.update("fetch inventory", 1, 3)
200
 
                from_weave = self.from_repository.get_inventory_weave()
201
 
                pb.update("fetch inventory", 2, 3)
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, pb=child_pb, msg='merge inventory',
207
 
                              version_ids=revs)
208
 
            finally:
209
 
                child_pb.finished()
210
 
        finally:
211
 
            pb.finished()
212
 
 
213
 
 
214
 
class GenericRepoFetcher(RepoFetcher):
215
 
    """This is a generic repo to repo fetcher.
216
 
 
217
 
    This makes minimal assumptions about repo layout and contents.
218
 
    It triggers a reconciliation after fetching to ensure integrity.
219
 
    """
220
 
 
221
 
    def _fetch_revision_texts(self, revs):
222
 
        """Fetch revision object texts"""
223
 
        rev_pb = bzrlib.ui.ui_factory.nested_progress_bar()
224
 
        try:
225
 
            to_txn = self.to_transaction = self.to_repository.get_transaction()
226
 
            count = 0
227
 
            total = len(revs)
228
 
            to_store = self.to_repository._revision_store
229
 
            for rev in revs:
230
 
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
231
 
                try:
232
 
                    pb.update('copying revisions', count, total)
233
 
                    try:
234
 
                        sig_text = self.from_repository.get_signature_text(rev)
235
 
                        to_store.add_revision_signature_text(rev, sig_text, to_txn)
236
 
                    except errors.NoSuchRevision:
237
 
                        # not signed.
238
 
                        pass
239
 
                    to_store.add_revision(self.from_repository.get_revision(rev),
240
 
                                          to_txn)
241
 
                    count += 1
242
 
                finally:
243
 
                    pb.finished()
244
 
            # fixup inventory if needed: 
245
 
            # this is expensive because we have no inverse index to current ghosts.
246
 
            # but on local disk its a few seconds and sftp push is already insane.
247
 
            # so we just-do-it.
248
 
            # FIXME: repository should inform if this is needed.
249
 
            self.to_repository.reconcile()
250
 
        finally:
251
 
            rev_pb.finished()
252
 
    
253
 
 
254
 
class KnitRepoFetcher(RepoFetcher):
255
 
    """This is a knit format repository specific fetcher.
256
 
 
257
 
    This differs from the GenericRepoFetcher by not doing a 
258
 
    reconciliation after copying, and using knit joining to
259
 
    copy revision texts.
260
 
    """
261
 
 
262
 
    def _fetch_revision_texts(self, revs):
263
 
        # may need to be a InterRevisionStore call here.
264
 
        from_transaction = self.from_repository.get_transaction()
265
 
        to_transaction = self.to_repository.get_transaction()
266
 
        to_sf = self.to_repository._revision_store.get_signature_file(
267
 
            to_transaction)
268
 
        from_sf = self.from_repository._revision_store.get_signature_file(
269
 
            from_transaction)
270
 
        to_sf.join(from_sf, version_ids=revs, ignore_missing=True)
271
 
        to_rf = self.to_repository._revision_store.get_revision_file(
272
 
            to_transaction)
273
 
        from_rf = self.from_repository._revision_store.get_revision_file(
274
 
            from_transaction)
275
 
        to_rf.join(from_rf, version_ids=revs)
276
 
 
277
 
 
278
 
class Fetcher(object):
279
 
    """Backwards compatibility glue for branch.fetch()."""
280
 
 
281
 
    @deprecated_method(zero_eight)
282
 
    def __init__(self, to_branch, from_branch, last_revision=None, pb=None):
283
 
        """Please see branch.fetch()."""
284
 
        to_branch.fetch(from_branch, last_revision, pb)