1
# Copyright (C) 2005, 2006 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,
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,
47
# TODO: Avoid repeatedly opening weaves so many times.
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.
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.
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
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
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
74
class RepoFetcher(object):
75
"""Pull revisions and texts from one repository to another.
78
if set, try to limit to the data this revision references.
81
count_copied -- number of revisions copied
83
This should not be used directory, its essential a object to encapsulate
84
the logic in InterRepository.fetch().
86
def __init__(self, to_repository, from_repository, last_revision=None, pb=None):
88
self.failed_revisions = []
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)
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
100
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
101
self.nested_pb = self.pb
104
self.nested_pb = None
105
self.from_repository.lock_read()
107
self.to_repository.lock_write()
111
if self.nested_pb is not None:
112
self.nested_pb.finished()
113
self.to_repository.unlock()
115
self.from_repository.unlock()
118
"""Primary worker function.
120
This initialises all the needed variables, and then fetches the
121
requested revisions, finally clearing the progress bar.
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
128
self.file_ids_names = {}
129
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
texts_pb = bzrlib.ui.ui_factory.nested_progress_bar()
162
file_ids = self.from_repository.fileids_altered_by_revision_ids(revs)
164
num_file_ids = len(file_ids)
165
for file_id, required_versions in file_ids.items():
166
texts_pb.update("fetch texts", count, num_file_ids)
168
to_weave = self.to_weaves.get_weave_or_empty(file_id,
169
self.to_repository.get_transaction())
170
from_weave = self.from_weaves.get_weave(file_id,
171
self.from_repository.get_transaction())
172
# we fetch all the texts, because texts do
173
# not reference anything, and its cheap enough
174
to_weave.join(from_weave, version_ids=required_versions)
175
# we don't need *all* of this data anymore, but we dont know
176
# what we do. This cache clearing will result in a new read
177
# of the knit data when we do the checkout, but probably we
178
# want to emit the needed data on the fly rather than at the
180
# the from weave should know not to cache data being joined,
181
# but its ok to ask it to clear.
182
from_weave.clear_cache()
183
to_weave.clear_cache()
187
def _fetch_inventory_weave(self, revs):
188
pb = bzrlib.ui.ui_factory.nested_progress_bar()
190
pb.update("fetch inventory", 0, 2)
191
to_weave = self.to_control.get_weave('inventory',
192
self.to_repository.get_transaction())
194
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
196
# just merge, this is optimisable and its means we don't
197
# copy unreferenced data such as not-needed inventories.
198
pb.update("fetch inventory", 1, 3)
199
from_weave = self.from_repository.get_inventory_weave()
200
pb.update("fetch inventory", 2, 3)
201
# we fetch only the referenced inventories because we do not
202
# know for unselected inventories whether all their required
203
# texts are present in the other repository - it could be
205
to_weave.join(from_weave, pb=child_pb, msg='merge inventory',
213
class GenericRepoFetcher(RepoFetcher):
214
"""This is a generic repo to repo fetcher.
216
This makes minimal assumptions about repo layout and contents.
217
It triggers a reconciliation after fetching to ensure integrity.
220
def _fetch_revision_texts(self, revs):
221
"""Fetch revision object texts"""
222
rev_pb = bzrlib.ui.ui_factory.nested_progress_bar()
224
to_txn = self.to_transaction = self.to_repository.get_transaction()
227
to_store = self.to_repository._revision_store
229
pb = bzrlib.ui.ui_factory.nested_progress_bar()
231
pb.update('copying revisions', count, total)
233
sig_text = self.from_repository.get_signature_text(rev)
234
to_store.add_revision_signature_text(rev, sig_text, to_txn)
235
except errors.NoSuchRevision:
238
to_store.add_revision(self.from_repository.get_revision(rev),
243
# fixup inventory if needed:
244
# this is expensive because we have no inverse index to current ghosts.
245
# but on local disk its a few seconds and sftp push is already insane.
247
# FIXME: repository should inform if this is needed.
248
self.to_repository.reconcile()
253
class KnitRepoFetcher(RepoFetcher):
254
"""This is a knit format repository specific fetcher.
256
This differs from the GenericRepoFetcher by not doing a
257
reconciliation after copying, and using knit joining to
261
def _fetch_revision_texts(self, revs):
262
# may need to be a InterRevisionStore call here.
263
from_transaction = self.from_repository.get_transaction()
264
to_transaction = self.to_repository.get_transaction()
265
to_sf = self.to_repository._revision_store.get_signature_file(
267
from_sf = self.from_repository._revision_store.get_signature_file(
269
to_sf.join(from_sf, version_ids=revs, ignore_missing=True)
270
to_rf = self.to_repository._revision_store.get_revision_file(
272
from_rf = self.from_repository._revision_store.get_revision_file(
274
to_rf.join(from_rf, version_ids=revs)
277
class Fetcher(object):
278
"""Backwards compatibility glue for branch.fetch()."""
280
@deprecated_method(zero_eight)
281
def __init__(self, to_branch, from_branch, last_revision=None, pb=None):
282
"""Please see branch.fetch()."""
283
to_branch.fetch(from_branch, last_revision, pb)