~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/fetch.py

  • Committer: Martin Pool
  • Date: 2005-08-12 15:41:44 UTC
  • Revision ID: mbp@sourcefrog.net-20050812154144-bc98570a78b8f633
- merge in deferred revfile work

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, 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
 
# TODO: Avoid repeatedly opening weaves so many times.
46
 
 
47
 
# XXX: This doesn't handle ghost (not present in branch) revisions at
48
 
# all yet.  I'm not sure they really should be supported.
49
 
 
50
 
# NOTE: This doesn't copy revisions which may be present but not
51
 
# merged into the last revision.  I'm not sure we want to do that.
52
 
 
53
 
# - get a list of revisions that need to be pulled in
54
 
# - for each one, pull in that revision file
55
 
#   and get the inventory, and store the inventory with right
56
 
#   parents.
57
 
# - and get the ancestry, and store that with right parents too
58
 
# - and keep a note of all file ids and version seen
59
 
# - then go through all files; for each one get the weave,
60
 
#   and add in all file versions
61
 
 
62
 
 
63
 
@deprecated_function(zero_eight)
64
 
def greedy_fetch(to_branch, from_branch, revision=None, pb=None):
65
 
    """Legacy API, please see branch.fetch(from_branch, last_revision, pb)."""
66
 
    f = Fetcher(to_branch, from_branch, revision, pb)
67
 
    return f.count_copied, f.failed_revisions
68
 
 
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:
79
 
    count_copied -- number of revisions copied
80
 
 
81
 
    This should not be used directory, its essential a object to encapsulate
82
 
    the logic in InterRepository.fetch().
83
 
    """
84
 
    def __init__(self, to_repository, from_repository, last_revision=None, pb=None):
85
 
        # result variables.
86
 
        self.failed_revisions = []
87
 
        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
97
 
        if pb is None:
98
 
            self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
99
 
            self.nested_pb = self.pb
100
 
        else:
101
 
            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
150
 
            
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.fileid_involved_by_set(revs)
161
 
            count = 0
162
 
            num_file_ids = len(file_ids)
163
 
            for file_id in file_ids:
164
 
                texts_pb.update("fetch texts", count, num_file_ids)
165
 
                count +=1
166
 
                try:
167
 
                    to_weave = self.to_weaves.get_weave(file_id,
168
 
                        self.to_repository.get_transaction())
169
 
                except errors.NoSuchFile:
170
 
                    # destination is empty, just copy it.
171
 
                    # this copies all the texts, which is useful and 
172
 
                    # on per-file basis quite cheap.
173
 
                    self.to_weaves.copy_multi(
174
 
                        self.from_weaves,
175
 
                        [file_id],
176
 
                        None,
177
 
                        self.from_repository.get_transaction(),
178
 
                        self.to_repository.get_transaction())
179
 
                else:
180
 
                    # destination has contents, must merge
181
 
                    from_weave = self.from_weaves.get_weave(file_id,
182
 
                        self.from_repository.get_transaction())
183
 
                    # we fetch all the texts, because texts do
184
 
                    # not reference anything, and its cheap enough
185
 
                    to_weave.join(from_weave)
186
 
        finally:
187
 
            texts_pb.finished()
188
 
 
189
 
    def _fetch_inventory_weave(self, revs):
190
 
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
191
 
        try:
192
 
            pb.update("fetch inventory", 0, 2)
193
 
            to_weave = self.to_control.get_weave('inventory',
194
 
                    self.to_repository.get_transaction())
195
 
    
196
 
            child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
197
 
            try:
198
 
                # just merge, this is optimisable and its means we dont
199
 
                # copy unreferenced data such as not-needed inventories.
200
 
                pb.update("fetch inventory", 1, 3)
201
 
                from_weave = self.from_repository.get_inventory_weave()
202
 
                pb.update("fetch inventory", 2, 3)
203
 
                # we fetch only the referenced inventories because we do not
204
 
                # know for unselected inventories whether all their required
205
 
                # texts are present in the other repository - it could be
206
 
                # corrupt.
207
 
                to_weave.join(from_weave, pb=child_pb, msg='merge inventory',
208
 
                              version_ids=revs)
209
 
            finally:
210
 
                child_pb.finished()
211
 
        finally:
212
 
            pb.finished()
213
 
 
214
 
 
215
 
class GenericRepoFetcher(RepoFetcher):
216
 
    """This is a generic repo to repo fetcher.
217
 
 
218
 
    This makes minimal assumptions about repo layout and contents.
219
 
    It triggers a reconciliation after fetching to ensure integrity.
220
 
    """
221
 
 
222
 
    def _fetch_revision_texts(self, revs):
223
 
        """Fetch revision object texts"""
224
 
        rev_pb = bzrlib.ui.ui_factory.nested_progress_bar()
225
 
        try:
226
 
            to_txn = self.to_transaction = self.to_repository.get_transaction()
227
 
            count = 0
228
 
            total = len(revs)
229
 
            to_store = self.to_repository._revision_store
230
 
            for rev in revs:
231
 
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
232
 
                try:
233
 
                    pb.update('copying revisions', count, total)
234
 
                    try:
235
 
                        sig_text = self.from_repository.get_signature_text(rev)
236
 
                        to_store.add_revision_signature_text(rev, sig_text, to_txn)
237
 
                    except errors.NoSuchRevision:
238
 
                        # not signed.
239
 
                        pass
240
 
                    to_store.add_revision(self.from_repository.get_revision(rev),
241
 
                                          to_txn)
242
 
                    count += 1
243
 
                finally:
244
 
                    pb.finished()
245
 
            # fixup inventory if needed: 
246
 
            # this is expensive because we have no inverse index to current ghosts.
247
 
            # but on local disk its a few seconds and sftp push is already insane.
248
 
            # so we just-do-it.
249
 
            # FIXME: repository should inform if this is needed.
250
 
            self.to_repository.reconcile()
251
 
        finally:
252
 
            rev_pb.finished()
253
 
    
254
 
 
255
 
class KnitRepoFetcher(RepoFetcher):
256
 
    """This is a knit format repository specific fetcher.
257
 
 
258
 
    This differs from the GenericRepoFetcher by not doing a 
259
 
    reconciliation after copying, and using knit joining to
260
 
    copy revision texts.
261
 
    """
262
 
 
263
 
    def _fetch_revision_texts(self, revs):
264
 
        # may need to be a InterRevisionStore call here.
265
 
        from_transaction = self.from_repository.get_transaction()
266
 
        to_transaction = self.to_repository.get_transaction()
267
 
        to_sf = self.to_repository._revision_store.get_signature_file(
268
 
            to_transaction)
269
 
        from_sf = self.from_repository._revision_store.get_signature_file(
270
 
            from_transaction)
271
 
        to_sf.join(from_sf, version_ids=revs, ignore_missing=True)
272
 
        to_rf = self.to_repository._revision_store.get_revision_file(
273
 
            to_transaction)
274
 
        from_rf = self.from_repository._revision_store.get_revision_file(
275
 
            from_transaction)
276
 
        to_rf.join(from_rf, version_ids=revs)
277
 
 
278
 
 
279
 
class Fetcher(object):
280
 
    """Backwards compatability glue for branch.fetch()."""
281
 
 
282
 
    @deprecated_method(zero_eight)
283
 
    def __init__(self, to_branch, from_branch, last_revision=None, pb=None):
284
 
        """Please see branch.fetch()."""
285
 
        to_branch.fetch(from_branch, last_revision, pb)