1
# Copyright (C) 2005, 2006, 2008 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.
36
import bzrlib.errors as errors
37
from bzrlib.errors import InstallFailed
38
from bzrlib.progress import ProgressPhase
39
from bzrlib.revision import is_null, NULL_REVISION
40
from bzrlib.symbol_versioning import (deprecated_function,
43
from bzrlib.tsort import topo_sort
44
from bzrlib.trace import mutter
46
from bzrlib.versionedfile import filter_absent, FulltextContentFactory
48
# TODO: Avoid repeatedly opening weaves so many times.
50
# XXX: This doesn't handle ghost (not present in branch) revisions at
51
# all yet. I'm not sure they really should be supported.
53
# NOTE: This doesn't copy revisions which may be present but not
54
# merged into the last revision. I'm not sure we want to do that.
56
# - get a list of revisions that need to be pulled in
57
# - for each one, pull in that revision file
58
# and get the inventory, and store the inventory with right
60
# - and get the ancestry, and store that with right parents too
61
# - and keep a note of all file ids and version seen
62
# - then go through all files; for each one get the weave,
63
# and add in all file versions
66
class RepoFetcher(object):
67
"""Pull revisions and texts from one repository to another.
70
if set, try to limit to the data this revision references.
73
count_copied -- number of revisions copied
75
This should not be used directly, it's essential a object to encapsulate
76
the logic in InterRepository.fetch().
79
def __init__(self, to_repository, from_repository, last_revision=None, pb=None,
81
"""Create a repo fetcher.
83
:param find_ghosts: If True search the entire history for ghosts.
84
:param _write_group_acquired_callable: Don't use; this parameter only
85
exists to facilitate a hack done in InterPackRepo.fetch. We would
86
like to remove this parameter.
89
self.failed_revisions = []
91
if to_repository.has_same_location(from_repository):
92
# repository.fetch should be taking care of this case.
93
raise errors.BzrError('RepoFetcher run '
94
'between two objects at the same location: '
95
'%r and %r' % (to_repository, from_repository))
96
self.to_repository = to_repository
97
self.from_repository = from_repository
98
# must not mutate self._last_revision as its potentially a shared instance
99
self._last_revision = last_revision
100
self.find_ghosts = find_ghosts
102
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
103
self.nested_pb = self.pb
106
self.nested_pb = None
107
self.from_repository.lock_read()
109
self.to_repository.lock_write()
111
self.to_repository.start_write_group()
115
self.to_repository.abort_write_group(suppress_errors=True)
118
self.to_repository.commit_write_group()
121
if self.nested_pb is not None:
122
self.nested_pb.finished()
124
self.to_repository.unlock()
126
self.from_repository.unlock()
129
"""Primary worker function.
131
This initialises all the needed variables, and then fetches the
132
requested revisions, finally clearing the progress bar.
135
self.file_ids_names = {}
136
pp = ProgressPhase('Transferring', 4, self.pb)
139
search = self._revids_to_fetch()
142
if getattr(self, '_fetch_everything_for_search', None) is not None:
143
self._fetch_everything_for_search(search, pp)
145
# backward compatibility
146
self._fetch_everything_for_revisions(search.get_keys, pp)
150
def _fetch_everything_for_search(self, search, pp):
151
"""Fetch all data for the given set of revisions."""
152
# The first phase is "file". We pass the progress bar for it directly
153
# into item_keys_introduced_by, which has more information about how
154
# that phase is progressing than we do. Progress updates for the other
155
# phases are taken care of in this function.
156
# XXX: there should be a clear owner of the progress reporting. Perhaps
157
# item_keys_introduced_by should have a richer API than it does at the
158
# moment, so that it can feed the progress information back to this
161
pb = bzrlib.ui.ui_factory.nested_progress_bar()
163
revs = search.get_keys()
164
graph = self.from_repository.get_graph()
165
revs = list(graph.iter_topo_order(revs))
166
data_to_fetch = self.from_repository.item_keys_introduced_by(revs,
169
for knit_kind, file_id, revisions in data_to_fetch:
170
if knit_kind != phase:
172
# Make a new progress bar for this phase
175
pb = bzrlib.ui.ui_factory.nested_progress_bar()
176
if knit_kind == "file":
177
# Accumulate file texts
178
text_keys.extend([(file_id, revision) for revision in
180
elif knit_kind == "inventory":
181
# Now copy the file texts.
182
to_texts = self.to_repository.texts
183
from_texts = self.from_repository.texts
184
to_texts.insert_record_stream(from_texts.get_record_stream(
185
text_keys, self.to_repository._fetch_order,
186
not self.to_repository._fetch_uses_deltas))
187
# Cause an error if a text occurs after we have done the
190
# Before we process the inventory we generate the root
191
# texts (if necessary) so that the inventories references
193
self._generate_root_texts(revs)
194
# NB: This currently reopens the inventory weave in source;
195
# using a single stream interface instead would avoid this.
196
self._fetch_inventory_weave(revs, pb)
197
elif knit_kind == "signatures":
198
# Nothing to do here; this will be taken care of when
199
# _fetch_revision_texts happens.
201
elif knit_kind == "revisions":
202
self._fetch_revision_texts(revs, pb)
204
raise AssertionError("Unknown knit kind %r" % knit_kind)
205
if self.to_repository._fetch_reconcile:
206
self.to_repository.reconcile()
210
self.count_copied += len(revs)
212
def _revids_to_fetch(self):
213
"""Determines the exact revisions needed from self.from_repository to
214
install self._last_revision in self.to_repository.
216
If no revisions need to be fetched, then this just returns None.
218
mutter('fetch up to rev {%s}', self._last_revision)
219
if self._last_revision is NULL_REVISION:
220
# explicit limit of no revisions needed
222
if (self._last_revision is not None and
223
self.to_repository.has_revision(self._last_revision)):
226
return self.to_repository.search_missing_revision_ids(
227
self.from_repository, self._last_revision,
228
find_ghosts=self.find_ghosts)
229
except errors.NoSuchRevision, e:
230
raise InstallFailed([self._last_revision])
232
def _fetch_inventory_weave(self, revs, pb):
233
pb.update("fetch inventory", 0, 2)
234
to_weave = self.to_repository.inventories
235
# just merge, this is optimisable and its means we don't
236
# copy unreferenced data such as not-needed inventories.
237
pb.update("fetch inventory", 1, 3)
238
from_weave = self.from_repository.inventories
239
pb.update("fetch inventory", 2, 3)
240
# we fetch only the referenced inventories because we do not
241
# know for unselected inventories whether all their required
242
# texts are present in the other repository - it could be
244
to_weave.insert_record_stream(from_weave.get_record_stream(
245
[(rev_id,) for rev_id in revs],
246
self.to_repository._fetch_order,
247
not self.to_repository._fetch_uses_deltas))
249
def _fetch_revision_texts(self, revs, pb):
250
# fetch signatures first and then the revision texts
251
# may need to be a InterRevisionStore call here.
252
to_sf = self.to_repository.signatures
253
from_sf = self.from_repository.signatures
254
# A missing signature is just skipped.
255
to_sf.insert_record_stream(filter_absent(from_sf.get_record_stream(
256
[(rev_id,) for rev_id in revs],
257
self.to_repository._fetch_order,
258
not self.to_repository._fetch_uses_deltas)))
259
self._fetch_just_revision_texts(revs)
261
def _fetch_just_revision_texts(self, version_ids):
262
to_rf = self.to_repository.revisions
263
from_rf = self.from_repository.revisions
264
# If a revision has a delta, this is actually expanded inside the
265
# insert_record_stream code now, which is an alternate fix for
267
to_rf.insert_record_stream(from_rf.get_record_stream(
268
[(rev_id,) for rev_id in version_ids],
269
self.to_repository._fetch_order,
270
not self.to_repository._fetch_uses_deltas))
272
def _generate_root_texts(self, revs):
273
"""This will be called by __fetch between fetching weave texts and
274
fetching the inventory weave.
276
Subclasses should override this if they need to generate root texts
277
after fetching weave texts.
282
class Inter1and2Helper(object):
283
"""Helper for operations that convert data from model 1 and 2
285
This is for use by fetchers and converters.
288
def __init__(self, source, target):
291
:param source: The repository data comes from
292
:param target: The repository data goes to
297
def iter_rev_trees(self, revs):
298
"""Iterate through RevisionTrees efficiently.
300
Additionally, the inventory's revision_id is set if unset.
302
Trees are retrieved in batches of 100, and then yielded in the order
305
:param revs: A list of revision ids
307
# In case that revs is not a list.
310
for tree in self.source.revision_trees(revs[:100]):
311
if tree.inventory.revision_id is None:
312
tree.inventory.revision_id = tree.get_revision_id()
316
def _find_root_ids(self, revs, parent_map, graph):
318
planned_versions = {}
319
for tree in self.iter_rev_trees(revs):
320
revision_id = tree.inventory.root.revision
321
root_id = tree.get_root_id()
322
planned_versions.setdefault(root_id, []).append(revision_id)
323
revision_root[revision_id] = root_id
324
# Find out which parents we don't already know root ids for
326
for revision_parents in parent_map.itervalues():
327
parents.update(revision_parents)
328
parents.difference_update(revision_root.keys() + [NULL_REVISION])
329
# Limit to revisions present in the versionedfile
330
parents = graph.get_parent_map(parents).keys()
331
for tree in self.iter_rev_trees(parents):
332
root_id = tree.get_root_id()
333
revision_root[tree.get_revision_id()] = root_id
334
return revision_root, planned_versions
336
def generate_root_texts(self, revs):
337
"""Generate VersionedFiles for all root ids.
339
:param revs: the revisions to include
341
to_texts = self.target.texts
342
graph = self.source.get_graph()
343
parent_map = graph.get_parent_map(revs)
344
rev_order = topo_sort(parent_map)
345
rev_id_to_root_id, root_id_to_rev_ids = self._find_root_ids(
346
revs, parent_map, graph)
347
root_id_order = [(rev_id_to_root_id[rev_id], rev_id) for rev_id in
349
# Guaranteed stable, this groups all the file id operations together
350
# retaining topological order within the revisions of a file id.
351
# File id splits and joins would invalidate this, but they don't exist
352
# yet, and are unlikely to in non-rich-root environments anyway.
353
root_id_order.sort(key=operator.itemgetter(0))
354
# Create a record stream containing the roots to create.
356
for key in root_id_order:
357
root_id, rev_id = key
358
rev_parents = parent_map[rev_id]
359
# We drop revision parents with different file-ids, because
360
# that represents a rename of the root to a different location
361
# - its not actually a parent for us. (We could look for that
362
# file id in the revision tree at considerably more expense,
363
# but for now this is sufficient (and reconcile will catch and
364
# correct this anyway).
365
# When a parent revision is a ghost, we guess that its root id
366
# was unchanged (rather than trimming it from the parent list).
367
parent_keys = tuple((root_id, parent) for parent in rev_parents
368
if parent != NULL_REVISION and
369
rev_id_to_root_id.get(parent, root_id) == root_id)
370
yield FulltextContentFactory(key, parent_keys, None, '')
371
to_texts.insert_record_stream(yield_roots())
373
def regenerate_inventory(self, revs):
374
"""Generate a new inventory versionedfile in target, convertin data.
376
The inventory is retrieved from the source, (deserializing it), and
377
stored in the target (reserializing it in a different format).
378
:param revs: The revisions to include
380
for tree in self.iter_rev_trees(revs):
381
parents = tree.get_parent_ids()
382
self.target.add_inventory(tree.get_revision_id(), tree.inventory,
385
def fetch_revisions(self, revision_ids):
386
# TODO: should this batch them up rather than requesting 10,000
388
for revision in self.source.get_revisions(revision_ids):
389
self.target.add_revision(revision.revision_id, revision)
392
class Model1toKnit2Fetcher(RepoFetcher):
393
"""Fetch from a Model1 repository into a Knit2 repository
395
def __init__(self, to_repository, from_repository, last_revision=None,
396
pb=None, find_ghosts=True):
397
self.helper = Inter1and2Helper(from_repository, to_repository)
398
RepoFetcher.__init__(self, to_repository, from_repository,
399
last_revision, pb, find_ghosts)
401
def _generate_root_texts(self, revs):
402
self.helper.generate_root_texts(revs)
404
def _fetch_inventory_weave(self, revs, pb):
405
self.helper.regenerate_inventory(revs)
407
def _fetch_revision_texts(self, revs, pb):
408
"""Fetch revision object texts"""
412
pb.update('copying revisions', count, total)
414
sig_text = self.from_repository.get_signature_text(rev)
415
self.to_repository.add_signature_text(rev, sig_text)
416
except errors.NoSuchRevision:
419
self._copy_revision(rev)
422
def _copy_revision(self, rev):
423
self.helper.fetch_revisions([rev])
426
class Knit1to2Fetcher(RepoFetcher):
427
"""Fetch from a Knit1 repository into a Knit2 repository"""
429
def __init__(self, to_repository, from_repository, last_revision=None,
430
pb=None, find_ghosts=True):
431
self.helper = Inter1and2Helper(from_repository, to_repository)
432
RepoFetcher.__init__(self, to_repository, from_repository,
433
last_revision, pb, find_ghosts)
435
def _generate_root_texts(self, revs):
436
self.helper.generate_root_texts(revs)
438
def _fetch_inventory_weave(self, revs, pb):
439
self.helper.regenerate_inventory(revs)
441
def _fetch_just_revision_texts(self, version_ids):
442
self.helper.fetch_revisions(version_ids)
added
removed
bzrlib/fetch.py
