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.  Therefore, we first pull the XML and hold it in
 
 
30
memory until we've updated all of the files referenced.
 
 
34
import bzrlib.errors as errors
 
 
35
from bzrlib.errors import (InstallFailed, NoSuchRevision, WeaveError,
 
 
37
from bzrlib.trace import mutter
 
 
38
from bzrlib.progress import ProgressBar
 
 
39
from bzrlib.revision import NULL_REVISION
 
 
40
from bzrlib.symbol_versioning import *
 
 
43
# TODO: Avoid repeatedly opening weaves so many times.
 
 
45
# XXX: This doesn't handle ghost (not present in branch) revisions at
 
 
46
# all yet.  I'm not sure they really should be supported.
 
 
48
# NOTE: This doesn't copy revisions which may be present but not
 
 
49
# merged into the last revision.  I'm not sure we want to do that.
 
 
51
# - get a list of revisions that need to be pulled in
 
 
52
# - for each one, pull in that revision file
 
 
53
#   and get the inventory, and store the inventory with right
 
 
55
# - and get the ancestry, and store that with right parents too
 
 
56
# - and keep a note of all file ids and version seen
 
 
57
# - then go through all files; for each one get the weave,
 
 
58
#   and add in all file versions
 
 
61
@deprecated_function(zero_eight)
 
 
62
def greedy_fetch(to_branch, from_branch, revision=None, pb=None):
 
 
63
    """Legacy API, please see branch.fetch(from_branch, last_revision, pb)."""
 
 
64
    f = Fetcher(to_branch, from_branch, revision, pb)
 
 
65
    return f.count_copied, f.failed_revisions
 
 
70
class RepoFetcher(object):
 
 
71
    """Pull revisions and texts from one repository to another.
 
 
74
        if set, try to limit to the data this revision references.
 
 
77
    count_copied -- number of revisions copied
 
 
79
    This should not be used directory, its essential a object to encapsulate
 
 
80
    the logic in InterRepository.fetch().
 
 
82
    def __init__(self, to_repository, from_repository, last_revision=None, pb=None):
 
 
84
        self.failed_revisions = []
 
 
86
        if to_repository.bzrdir.transport.base == from_repository.bzrdir.transport.base:
 
 
87
            # check that last_revision is in 'from' and then return a no-operation.
 
 
88
            if last_revision not in (None, NULL_REVISION):
 
 
89
                from_repository.get_revision(last_revision)
 
 
91
        self.to_repository = to_repository
 
 
92
        self.from_repository = from_repository
 
 
93
        # must not mutate self._last_revision as its potentially a shared instance
 
 
94
        self._last_revision = last_revision
 
 
96
            self.pb = bzrlib.ui.ui_factory.progress_bar()
 
 
99
        self.from_repository.lock_read()
 
 
101
            self.to_repository.lock_write()
 
 
105
                self.to_repository.unlock()
 
 
107
            self.from_repository.unlock()
 
 
110
        """Primary worker function.
 
 
112
        This initialises all the needed variables, and then fetches the 
 
 
113
        requested revisions, finally clearing the progress bar.
 
 
115
        self.to_weaves = self.to_repository.weave_store
 
 
116
        self.to_control = self.to_repository.control_weaves
 
 
117
        self.from_weaves = self.from_repository.weave_store
 
 
118
        self.from_control = self.from_repository.control_weaves
 
 
120
        self.file_ids_names = {}
 
 
122
            revs = self._revids_to_fetch()
 
 
125
                self._fetch_weave_texts(revs)
 
 
126
                self._fetch_inventory_weave(revs)
 
 
127
                self._fetch_revision_texts(revs)
 
 
128
                self.count_copied += len(revs)
 
 
132
    def _revids_to_fetch(self):
 
 
133
        self.pb.update('get destination history')
 
 
134
        mutter('fetch up to rev {%s}', self._last_revision)
 
 
135
        if self._last_revision is NULL_REVISION:
 
 
136
            # explicit limit of no revisions needed
 
 
138
        if (self._last_revision != None and
 
 
139
            self.to_repository.has_revision(self._last_revision)):
 
 
143
            return self.to_repository.missing_revision_ids(self.from_repository,
 
 
145
        except errors.NoSuchRevision:
 
 
146
            raise InstallFailed([self._last_revision])
 
 
148
    def _fetch_revision_texts(self, revs):
 
 
149
        self.to_repository.revision_store.copy_multi(
 
 
150
            self.from_repository.revision_store,
 
 
154
    def _fetch_weave_texts(self, revs):
 
 
155
        file_ids = self.from_repository.fileid_involved_by_set(revs)
 
 
157
        num_file_ids = len(file_ids)
 
 
158
        for file_id in file_ids:
 
 
159
            self.pb.update("merge weaves", count, num_file_ids)
 
 
161
            to_weave = self.to_weaves.get_weave_or_empty(file_id,
 
 
162
                self.to_repository.get_transaction())
 
 
163
            from_weave = self.from_weaves.get_weave(file_id,
 
 
164
                self.from_repository.get_transaction())
 
 
166
            if to_weave.numversions() > 0:
 
 
167
                # destination has contents, must merge
 
 
169
                    to_weave.join(from_weave)
 
 
170
                except errors.WeaveParentMismatch:
 
 
171
                    to_weave.reweave(from_weave)
 
 
173
                # destination is empty, just replace it
 
 
174
                to_weave = from_weave.copy()
 
 
176
            self.to_weaves.put_weave(file_id, to_weave,
 
 
177
                self.to_repository.get_transaction())
 
 
180
    def _fetch_inventory_weave(self, revs):
 
 
181
        self.pb.update("inventory fetch", 0, 2)
 
 
182
        from_weave = self.from_repository.get_inventory_weave()
 
 
183
        to_weave = self.to_repository.get_inventory_weave()
 
 
184
        self.pb.update("inventory fetch", 1, 2)
 
 
185
        to_weave = self.to_control.get_weave('inventory',
 
 
186
                self.to_repository.get_transaction())
 
 
187
        self.pb.update("inventory fetch", 2, 2)
 
 
189
        if to_weave.numversions() > 0:
 
 
190
            # destination has contents, must merge
 
 
192
                to_weave.join(from_weave, pb=self.pb, msg='merge inventory')
 
 
193
            except errors.WeaveParentMismatch:
 
 
194
                to_weave.reweave(from_weave, pb=self.pb, msg='reweave inventory')
 
 
196
            # destination is empty, just replace it
 
 
197
            to_weave = from_weave.copy()
 
 
199
        self.to_control.put_weave('inventory', to_weave,
 
 
200
            self.to_repository.get_transaction())
 
 
205
class Fetcher(object):
 
 
206
    """Backwards compatability glue for branch.fetch()."""
 
 
208
    @deprecated_method(zero_eight)
 
 
209
    def __init__(self, to_branch, from_branch, last_revision=None, pb=None):
 
 
210
        """Please see branch.fetch()."""
 
 
211
        to_branch.fetch(from_branch, last_revision, pb)