1
# Copyright (C) 2005, 2006 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 then return to the inventories.
34
import bzrlib.errors as errors
35
from bzrlib.errors import InstallFailed
36
from bzrlib.progress import ProgressPhase
37
from bzrlib.revision import is_null, NULL_REVISION
38
from bzrlib.symbol_versioning import (deprecated_function,
41
from bzrlib.trace import mutter
43
from bzrlib.versionedfile import filter_absent
45
# TODO: Avoid repeatedly opening weaves so many times.
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.
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.
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
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
63
class RepoFetcher(object):
64
"""Pull revisions and texts from one repository to another.
67
if set, try to limit to the data this revision references.
70
count_copied -- number of revisions copied
72
This should not be used directly, it's essential a object to encapsulate
73
the logic in InterRepository.fetch().
76
def __init__(self, to_repository, from_repository, last_revision=None, pb=None,
78
"""Create a repo fetcher.
80
:param find_ghosts: If True search the entire history for ghosts.
83
self.failed_revisions = []
85
if to_repository.has_same_location(from_repository):
86
# repository.fetch should be taking care of this case.
87
raise errors.BzrError('RepoFetcher run '
88
'between two objects at the same location: '
89
'%r and %r' % (to_repository, from_repository))
90
self.to_repository = to_repository
91
self.from_repository = from_repository
92
# must not mutate self._last_revision as its potentially a shared instance
93
self._last_revision = last_revision
94
self.find_ghosts = find_ghosts
96
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
97
self.nested_pb = self.pb
100
self.nested_pb = None
101
self.from_repository.lock_read()
103
self.to_repository.lock_write()
105
self.to_repository.start_write_group()
109
self.to_repository.abort_write_group()
112
self.to_repository.commit_write_group()
115
if self.nested_pb is not None:
116
self.nested_pb.finished()
118
self.to_repository.unlock()
120
self.from_repository.unlock()
123
"""Primary worker function.
125
This initialises all the needed variables, and then fetches the
126
requested revisions, finally clearing the progress bar.
128
self.to_weaves = self.to_repository.weave_store
129
self.from_weaves = self.from_repository.weave_store
131
self.file_ids_names = {}
132
pp = ProgressPhase('Transferring', 4, self.pb)
135
search = self._revids_to_fetch()
138
if getattr(self, '_fetch_everything_for_search', None) is not None:
139
self._fetch_everything_for_search(search, pp)
141
# backward compatibility
142
self._fetch_everything_for_revisions(search.get_keys, pp)
146
def _fetch_everything_for_search(self, search, pp):
147
"""Fetch all data for the given set of revisions."""
148
# The first phase is "file". We pass the progress bar for it directly
149
# into item_keys_introduced_by, which has more information about how
150
# that phase is progressing than we do. Progress updates for the other
151
# phases are taken care of in this function.
152
# XXX: there should be a clear owner of the progress reporting. Perhaps
153
# item_keys_introduced_by should have a richer API than it does at the
154
# moment, so that it can feed the progress information back to this
157
pb = bzrlib.ui.ui_factory.nested_progress_bar()
159
revs = search.get_keys()
160
data_to_fetch = self.from_repository.item_keys_introduced_by(revs, pb)
161
for knit_kind, file_id, revisions in data_to_fetch:
162
if knit_kind != phase:
164
# Make a new progress bar for this phase
167
pb = bzrlib.ui.ui_factory.nested_progress_bar()
168
if knit_kind == "file":
169
self._fetch_weave_text(file_id, revisions)
170
elif knit_kind == "inventory":
171
# Before we process the inventory we generate the root
172
# texts (if necessary) so that the inventories references
174
self._generate_root_texts(revs)
175
# NB: This currently reopens the inventory weave in source;
176
# using a full get_data_stream instead would avoid this.
177
self._fetch_inventory_weave(revs, pb)
178
elif knit_kind == "signatures":
179
# Nothing to do here; this will be taken care of when
180
# _fetch_revision_texts happens.
182
elif knit_kind == "revisions":
183
self._fetch_revision_texts(revs, pb)
185
raise AssertionError("Unknown knit kind %r" % knit_kind)
189
self.count_copied += len(revs)
191
def _revids_to_fetch(self):
192
"""Determines the exact revisions needed from self.from_repository to
193
install self._last_revision in self.to_repository.
195
If no revisions need to be fetched, then this just returns None.
197
mutter('fetch up to rev {%s}', self._last_revision)
198
if self._last_revision is NULL_REVISION:
199
# explicit limit of no revisions needed
201
if (self._last_revision is not None and
202
self.to_repository.has_revision(self._last_revision)):
205
return self.to_repository.search_missing_revision_ids(
206
self.from_repository, self._last_revision,
207
find_ghosts=self.find_ghosts)
208
except errors.NoSuchRevision, e:
209
raise InstallFailed([self._last_revision])
211
def _fetch_weave_text(self, file_id, required_versions):
212
to_weave = self.to_weaves.get_weave_or_empty(file_id,
213
self.to_repository.get_transaction())
214
from_weave = self.from_weaves.get_weave(file_id,
215
self.from_repository.get_transaction())
216
# Fetch all the texts.
217
to_weave.insert_record_stream(from_weave.get_record_stream(required_versions,
218
'topological', False))
220
def _fetch_inventory_weave(self, revs, pb):
221
pb.update("fetch inventory", 0, 2)
222
to_weave = self.to_repository.get_inventory_weave()
223
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
225
# just merge, this is optimisable and its means we don't
226
# copy unreferenced data such as not-needed inventories.
227
pb.update("fetch inventory", 1, 3)
228
from_weave = self.from_repository.get_inventory_weave()
229
pb.update("fetch inventory", 2, 3)
230
# we fetch only the referenced inventories because we do not
231
# know for unselected inventories whether all their required
232
# texts are present in the other repository - it could be
234
to_weave.insert_record_stream(from_weave.get_record_stream(revs,
235
'topological', False))
239
def _generate_root_texts(self, revs):
240
"""This will be called by __fetch between fetching weave texts and
241
fetching the inventory weave.
243
Subclasses should override this if they need to generate root texts
244
after fetching weave texts.
249
class GenericRepoFetcher(RepoFetcher):
250
"""This is a generic repo to repo fetcher.
252
This makes minimal assumptions about repo layout and contents.
253
It triggers a reconciliation after fetching to ensure integrity.
256
def _fetch_revision_texts(self, revs, pb):
257
"""Fetch revision object texts"""
258
to_txn = self.to_transaction = self.to_repository.get_transaction()
261
to_store = self.to_repository._revision_store
263
pb.update('copying revisions', count, total)
265
sig_text = self.from_repository.get_signature_text(rev)
266
to_store.add_revision_signature_text(rev, sig_text, to_txn)
267
except errors.NoSuchRevision:
270
to_store.add_revision(self.from_repository.get_revision(rev),
273
# fixup inventory if needed:
274
# this is expensive because we have no inverse index to current ghosts.
275
# but on local disk its a few seconds and sftp push is already insane.
277
# FIXME: repository should inform if this is needed.
278
self.to_repository.reconcile()
281
class KnitRepoFetcher(RepoFetcher):
282
"""This is a knit format repository specific fetcher.
284
This differs from the GenericRepoFetcher by not doing a
285
reconciliation after copying, and using knit joining to
289
def _fetch_revision_texts(self, revs, pb):
290
# may need to be a InterRevisionStore call here.
291
from_transaction = self.from_repository.get_transaction()
292
to_transaction = self.to_repository.get_transaction()
293
to_sf = self.to_repository._revision_store.get_signature_file(
295
from_sf = self.from_repository._revision_store.get_signature_file(
297
# A missing signature is just skipped.
298
to_sf.insert_record_stream(filter_absent(from_sf.get_record_stream(revs,
299
'unordered', False)))
300
to_rf = self.to_repository._revision_store.get_revision_file(
302
from_rf = self.from_repository._revision_store.get_revision_file(
304
to_rf.insert_record_stream(from_rf.get_record_stream(revs,
305
'topological', False))
308
class Inter1and2Helper(object):
309
"""Helper for operations that convert data from model 1 and 2
311
This is for use by fetchers and converters.
314
def __init__(self, source, target):
317
:param source: The repository data comes from
318
:param target: The repository data goes to
323
def iter_rev_trees(self, revs):
324
"""Iterate through RevisionTrees efficiently.
326
Additionally, the inventory's revision_id is set if unset.
328
Trees are retrieved in batches of 100, and then yielded in the order
331
:param revs: A list of revision ids
333
# In case that revs is not a list.
336
for tree in self.source.revision_trees(revs[:100]):
337
if tree.inventory.revision_id is None:
338
tree.inventory.revision_id = tree.get_revision_id()
342
def generate_root_texts(self, revs):
343
"""Generate VersionedFiles for all root ids.
345
:param revs: the revisions to include
347
inventory_weave = self.source.get_inventory_weave()
350
to_store = self.target.weave_store
351
parent_map = self.source.get_graph().get_parent_map(revs)
352
for tree in self.iter_rev_trees(revs):
353
revision_id = tree.inventory.root.revision
354
root_id = tree.get_root_id()
355
parents = parent_map[revision_id]
356
if parents[0] == NULL_REVISION:
358
if root_id not in versionedfile:
359
versionedfile[root_id] = to_store.get_weave_or_empty(root_id,
360
self.target.get_transaction())
361
_, _, parent_texts[root_id] = versionedfile[root_id].add_lines(
362
revision_id, parents, [], parent_texts)
364
def regenerate_inventory(self, revs):
365
"""Generate a new inventory versionedfile in target, convertin data.
367
The inventory is retrieved from the source, (deserializing it), and
368
stored in the target (reserializing it in a different format).
369
:param revs: The revisions to include
371
for tree in self.iter_rev_trees(revs):
372
parents = tree.get_parent_ids()
373
self.target.add_inventory(tree.get_revision_id(), tree.inventory,
377
class Model1toKnit2Fetcher(GenericRepoFetcher):
378
"""Fetch from a Model1 repository into a Knit2 repository
380
def __init__(self, to_repository, from_repository, last_revision=None,
381
pb=None, find_ghosts=True):
382
self.helper = Inter1and2Helper(from_repository, to_repository)
383
GenericRepoFetcher.__init__(self, to_repository, from_repository,
384
last_revision, pb, find_ghosts)
386
def _generate_root_texts(self, revs):
387
self.helper.generate_root_texts(revs)
389
def _fetch_inventory_weave(self, revs, pb):
390
self.helper.regenerate_inventory(revs)
393
class Knit1to2Fetcher(KnitRepoFetcher):
394
"""Fetch from a Knit1 repository into a Knit2 repository"""
396
def __init__(self, to_repository, from_repository, last_revision=None,
397
pb=None, find_ghosts=True):
398
self.helper = Inter1and2Helper(from_repository, to_repository)
399
KnitRepoFetcher.__init__(self, to_repository, from_repository,
400
last_revision, pb, find_ghosts)
402
def _generate_root_texts(self, revs):
403
self.helper.generate_root_texts(revs)
405
def _fetch_inventory_weave(self, revs, pb):
406
self.helper.regenerate_inventory(revs)
409
class RemoteToOtherFetcher(GenericRepoFetcher):
411
def _fetch_everything_for_search(self, search, pp):
412
data_stream = self.from_repository.get_data_stream_for_search(search)
413
self.to_repository.insert_data_stream(data_stream)
added
removed
bzrlib/fetch.py
