1
# Copyright (C) 2005 by Canonical Ltd
 
 
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.
 
 
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.
 
 
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
 
 
18
"""Copying of history from one branch to another.
 
 
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
 
 
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
 
 
35
import bzrlib.errors as errors
 
 
36
from bzrlib.errors import (InstallFailed, NoSuchRevision,
 
 
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 *
 
 
46
# TODO: Avoid repeatedly opening weaves so many times.
 
 
48
# XXX: This doesn't handle ghost (not present in branch) revisions at
 
 
49
# all yet.  I'm not sure they really should be supported.
 
 
51
# NOTE: This doesn't copy revisions which may be present but not
 
 
52
# merged into the last revision.  I'm not sure we want to do that.
 
 
54
# - get a list of revisions that need to be pulled in
 
 
55
# - for each one, pull in that revision file
 
 
56
#   and get the inventory, and store the inventory with right
 
 
58
# - and get the ancestry, and store that with right parents too
 
 
59
# - and keep a note of all file ids and version seen
 
 
60
# - then go through all files; for each one get the weave,
 
 
61
#   and add in all file versions
 
 
64
@deprecated_function(zero_eight)
 
 
65
def greedy_fetch(to_branch, from_branch, revision=None, pb=None):
 
 
66
    """Legacy API, please see branch.fetch(from_branch, last_revision, pb)."""
 
 
67
    f = Fetcher(to_branch, from_branch, revision, pb)
 
 
68
    return f.count_copied, f.failed_revisions
 
 
73
class RepoFetcher(object):
 
 
74
    """Pull revisions and texts from one repository to another.
 
 
77
        if set, try to limit to the data this revision references.
 
 
80
    count_copied -- number of revisions copied
 
 
82
    This should not be used directory, its essential a object to encapsulate
 
 
83
    the logic in InterRepository.fetch().
 
 
85
    def __init__(self, to_repository, from_repository, last_revision=None, pb=None):
 
 
87
        self.failed_revisions = []
 
 
89
        if to_repository.control_files._transport.base == from_repository.control_files._transport.base:
 
 
90
            # check that last_revision is in 'from' and then return a no-operation.
 
 
91
            if last_revision not in (None, NULL_REVISION):
 
 
92
                from_repository.get_revision(last_revision)
 
 
94
        self.to_repository = to_repository
 
 
95
        self.from_repository = from_repository
 
 
96
        # must not mutate self._last_revision as its potentially a shared instance
 
 
97
        self._last_revision = last_revision
 
 
99
            self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
 
100
            self.nested_pb = self.pb
 
 
103
            self.nested_pb = None
 
 
104
        self.from_repository.lock_read()
 
 
106
            self.to_repository.lock_write()
 
 
110
                if self.nested_pb is not None:
 
 
111
                    self.nested_pb.finished()
 
 
112
                self.to_repository.unlock()
 
 
114
            self.from_repository.unlock()
 
 
117
        """Primary worker function.
 
 
119
        This initialises all the needed variables, and then fetches the 
 
 
120
        requested revisions, finally clearing the progress bar.
 
 
122
        self.to_weaves = self.to_repository.weave_store
 
 
123
        self.to_control = self.to_repository.control_weaves
 
 
124
        self.from_weaves = self.from_repository.weave_store
 
 
125
        self.from_control = self.from_repository.control_weaves
 
 
127
        self.file_ids_names = {}
 
 
128
        pp = ProgressPhase('fetch phase', 4, self.pb)
 
 
131
            revs = self._revids_to_fetch()
 
 
135
                self._fetch_weave_texts(revs)
 
 
137
                self._fetch_inventory_weave(revs)
 
 
139
                self._fetch_revision_texts(revs)
 
 
140
                self.count_copied += len(revs)
 
 
144
    def _revids_to_fetch(self):
 
 
145
        mutter('fetch up to rev {%s}', self._last_revision)
 
 
146
        if self._last_revision is NULL_REVISION:
 
 
147
            # explicit limit of no revisions needed
 
 
149
        if (self._last_revision != None and
 
 
150
            self.to_repository.has_revision(self._last_revision)):
 
 
154
            return self.to_repository.missing_revision_ids(self.from_repository,
 
 
156
        except errors.NoSuchRevision:
 
 
157
            raise InstallFailed([self._last_revision])
 
 
159
    def _fetch_weave_texts(self, revs):
 
 
160
        file_ids = self.from_repository.fileid_involved_by_set(revs)
 
 
162
        num_file_ids = len(file_ids)
 
 
163
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
 
165
            for file_id in file_ids:
 
 
166
                pb.update("merge weaves", count, num_file_ids)
 
 
168
                to_weave = self.to_weaves.get_weave_or_empty(file_id,
 
 
169
                    self.to_repository.get_transaction())
 
 
171
                if to_weave.num_versions() > 0:
 
 
172
                    # destination has contents, must merge
 
 
173
                    from_weave = self.from_weaves.get_weave(file_id,
 
 
174
                        self.from_repository.get_transaction())
 
 
175
                    # we fetch all the texts, because texts do
 
 
176
                    # not reference anything, and its cheap enough
 
 
177
                    to_weave.join(from_weave)
 
 
179
                    # destination is empty, just copy it.
 
 
180
                    # this copies all the texts, which is useful and 
 
 
181
                    # on per-file basis quite cheap.
 
 
182
                    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
 
184
                        from_repo = self.from_repository
 
 
185
                        from_transaction = from_repo.get_transaction()
 
 
186
                        to_transaction = self.to_repository.get_transaction()
 
 
187
                        self.to_weaves.copy_multi(self.from_weaves, [file_id],
 
 
188
                                                  child_pb, from_transaction,
 
 
195
    def _fetch_inventory_weave(self, revs):
 
 
196
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
 
198
            pb.update("inventory fetch", 0, 3)
 
 
199
            to_weave = self.to_control.get_weave('inventory',
 
 
200
                    self.to_repository.get_transaction())
 
 
202
            child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
 
204
                # just merge, this is optimisable and its means we dont
 
 
205
                # copy unreferenced data such as not-needed inventories.
 
 
206
                pb.update("inventory fetch", 1, 3)
 
 
207
                from_weave = self.from_repository.get_inventory_weave()
 
 
208
                pb.update("inventory fetch", 2, 3)
 
 
209
                # we fetch only the referenced inventories because we do not
 
 
210
                # know for unselected inventories whether all their required
 
 
211
                # texts are present in the other repository - it could be
 
 
213
                to_weave.join(from_weave, pb=child_pb, msg='merge inventory',
 
 
221
class GenericRepoFetcher(RepoFetcher):
 
 
222
    """This is a generic repo to repo fetcher.
 
 
224
    This makes minimal assumptions about repo layout and contents.
 
 
225
    It triggers a reconciliation after fetching to ensure integrity.
 
 
228
    def _fetch_revision_texts(self, revs):
 
 
229
        self.to_transaction = self.to_repository.get_transaction()
 
 
232
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
 
235
                pb.update('copying revisions', count, total)
 
 
237
                    sig_text = self.from_repository.get_signature_text(rev)
 
 
238
                    store = self.to_repository._revision_store
 
 
239
                    store.add_revision_signature_text(rev, sig_text,
 
 
241
                except errors.NoSuchRevision:
 
 
244
                self.to_repository._revision_store.add_revision(
 
 
245
                    self.from_repository.get_revision(rev),
 
 
248
            pb.update('copying revisions', count, total)
 
 
251
        # fixup inventory if needed: 
 
 
252
        # this is expensive because we have no inverse index to current ghosts.
 
 
253
        # but on local disk its a few seconds and sftp push is already insane.
 
 
255
        # FIXME: repository should inform if this is needed.
 
 
256
        self.to_repository.reconcile()
 
 
259
class KnitRepoFetcher(RepoFetcher):
 
 
260
    """This is a knit format repository specific fetcher.
 
 
262
    This differs from the GenericRepoFetcher by not doing a 
 
 
263
    reconciliation after copying, and using knit joining to
 
 
267
    def _fetch_revision_texts(self, revs):
 
 
268
        # may need to be a InterRevisionStore call here.
 
 
269
        from_transaction = self.from_repository.get_transaction()
 
 
270
        to_transaction = self.to_repository.get_transaction()
 
 
271
        to_sf = self.to_repository._revision_store.get_signature_file(
 
 
273
        from_sf = self.from_repository._revision_store.get_signature_file(
 
 
275
        to_sf.join(from_sf, version_ids=revs, pb=self.pb, ignore_missing=True)
 
 
276
        to_rf = self.to_repository._revision_store.get_revision_file(
 
 
278
        from_rf = self.from_repository._revision_store.get_revision_file(
 
 
280
        to_rf.join(from_rf, version_ids=revs, pb=self.pb)
 
 
283
class Fetcher(object):
 
 
284
    """Backwards compatability glue for branch.fetch()."""
 
 
286
    @deprecated_method(zero_eight)
 
 
287
    def __init__(self, to_branch, from_branch, last_revision=None, pb=None):
 
 
288
        """Please see branch.fetch()."""
 
 
289
        to_branch.fetch(from_branch, last_revision, pb)