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 finally actually join
35
import bzrlib.errors as errors
36
from bzrlib.errors import (InstallFailed,
38
from bzrlib.progress import ProgressPhase
39
from bzrlib.revision import NULL_REVISION
40
from bzrlib.symbol_versioning import (deprecated_function,
44
from bzrlib.trace import mutter
47
from bzrlib.lazy_import import lazy_import
48
lazy_import(globals(), '''
49
from bzrlib.remote import RemoteRepository
52
# TODO: Avoid repeatedly opening weaves so many times.
54
# XXX: This doesn't handle ghost (not present in branch) revisions at
55
# all yet. I'm not sure they really should be supported.
57
# NOTE: This doesn't copy revisions which may be present but not
58
# merged into the last revision. I'm not sure we want to do that.
60
# - get a list of revisions that need to be pulled in
61
# - for each one, pull in that revision file
62
# and get the inventory, and store the inventory with right
64
# - and get the ancestry, and store that with right parents too
65
# - and keep a note of all file ids and version seen
66
# - then go through all files; for each one get the weave,
67
# and add in all file versions
70
@deprecated_function(zero_eight)
71
def greedy_fetch(to_branch, from_branch, revision=None, pb=None):
72
"""Legacy API, please see branch.fetch(from_branch, last_revision, pb)."""
73
f = Fetcher(to_branch, from_branch, revision, pb)
74
return f.count_copied, f.failed_revisions
79
class RepoFetcher(object):
80
"""Pull revisions and texts from one repository to another.
83
if set, try to limit to the data this revision references.
86
count_copied -- number of revisions copied
88
This should not be used directory, its essential a object to encapsulate
89
the logic in InterRepository.fetch().
91
def __init__(self, to_repository, from_repository, last_revision=None, pb=None):
93
self.failed_revisions = []
95
if to_repository.control_files._transport.base == from_repository.control_files._transport.base:
96
# check that last_revision is in 'from' and then return a no-operation.
97
if last_revision not in (None, NULL_REVISION):
98
from_repository.get_revision(last_revision)
100
self.to_repository = to_repository
101
self.from_repository = from_repository
102
# must not mutate self._last_revision as its potentially a shared instance
103
self._last_revision = last_revision
105
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
106
self.nested_pb = self.pb
109
self.nested_pb = None
110
self.from_repository.lock_read()
112
self.to_repository.lock_write()
116
if self.nested_pb is not None:
117
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.to_control = self.to_repository.control_weaves
130
self.from_weaves = self.from_repository.weave_store
131
self.from_control = self.from_repository.control_weaves
133
self.file_ids_names = {}
134
pp = ProgressPhase('Fetch phase', 4, self.pb)
137
revs = self._revids_to_fetch()
141
self._fetch_weave_texts(revs)
143
self._fetch_inventory_weave(revs)
145
self._fetch_revision_texts(revs)
146
self.count_copied += len(revs)
150
def _revids_to_fetch(self):
151
mutter('fetch up to rev {%s}', self._last_revision)
152
if self._last_revision is NULL_REVISION:
153
# explicit limit of no revisions needed
155
if (self._last_revision is not None and
156
self.to_repository.has_revision(self._last_revision)):
160
return self.to_repository.missing_revision_ids(self.from_repository,
162
except errors.NoSuchRevision:
163
raise InstallFailed([self._last_revision])
165
def _fetch_weave_texts(self, revs):
166
texts_pb = bzrlib.ui.ui_factory.nested_progress_bar()
168
# fileids_altered_by_revision_ids requires reading the inventory
169
# weave, we will need to read the inventory weave again when
170
# all this is done, so enable caching for that specific weave
171
inv_w = self.from_repository.get_inventory_weave()
173
file_ids = self.from_repository.fileids_altered_by_revision_ids(revs)
175
num_file_ids = len(file_ids)
176
for file_id, required_versions in file_ids.items():
177
texts_pb.update("fetch texts", count, num_file_ids)
179
to_weave = self.to_weaves.get_weave_or_empty(file_id,
180
self.to_repository.get_transaction())
181
from_weave = self.from_weaves.get_weave(file_id,
182
self.from_repository.get_transaction())
183
# we fetch all the texts, because texts do
184
# not reference anything, and its cheap enough
185
to_weave.join(from_weave, version_ids=required_versions)
186
# we don't need *all* of this data anymore, but we dont know
187
# what we do. This cache clearing will result in a new read
188
# of the knit data when we do the checkout, but probably we
189
# want to emit the needed data on the fly rather than at the
191
# the from weave should know not to cache data being joined,
192
# but its ok to ask it to clear.
193
from_weave.clear_cache()
194
to_weave.clear_cache()
198
def _fetch_inventory_weave(self, revs):
199
pb = bzrlib.ui.ui_factory.nested_progress_bar()
201
pb.update("fetch inventory", 0, 2)
202
to_weave = self.to_control.get_weave('inventory',
203
self.to_repository.get_transaction())
205
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
207
# just merge, this is optimisable and its means we don't
208
# copy unreferenced data such as not-needed inventories.
209
pb.update("fetch inventory", 1, 3)
210
from_weave = self.from_repository.get_inventory_weave()
211
pb.update("fetch inventory", 2, 3)
212
# we fetch only the referenced inventories because we do not
213
# know for unselected inventories whether all their required
214
# texts are present in the other repository - it could be
216
to_weave.join(from_weave, pb=child_pb, msg='merge inventory',
218
from_weave.clear_cache()
225
class GenericRepoFetcher(RepoFetcher):
226
"""This is a generic repo to repo fetcher.
228
This makes minimal assumptions about repo layout and contents.
229
It triggers a reconciliation after fetching to ensure integrity.
232
def _fetch_revision_texts(self, revs):
233
"""Fetch revision object texts"""
234
rev_pb = bzrlib.ui.ui_factory.nested_progress_bar()
236
to_txn = self.to_transaction = self.to_repository.get_transaction()
239
to_store = self.to_repository._revision_store
241
pb = bzrlib.ui.ui_factory.nested_progress_bar()
243
pb.update('copying revisions', count, total)
245
sig_text = self.from_repository.get_signature_text(rev)
246
to_store.add_revision_signature_text(rev, sig_text, to_txn)
247
except errors.NoSuchRevision:
250
to_store.add_revision(self.from_repository.get_revision(rev),
255
# fixup inventory if needed:
256
# this is expensive because we have no inverse index to current ghosts.
257
# but on local disk its a few seconds and sftp push is already insane.
259
# FIXME: repository should inform if this is needed.
260
self.to_repository.reconcile()
265
class KnitRepoFetcher(RepoFetcher):
266
"""This is a knit format repository specific fetcher.
268
This differs from the GenericRepoFetcher by not doing a
269
reconciliation after copying, and using knit joining to
273
def _fetch_revision_texts(self, revs):
274
# may need to be a InterRevisionStore call here.
275
from_transaction = self.from_repository.get_transaction()
276
to_transaction = self.to_repository.get_transaction()
277
to_sf = self.to_repository._revision_store.get_signature_file(
279
from_sf = self.from_repository._revision_store.get_signature_file(
281
to_sf.join(from_sf, version_ids=revs, ignore_missing=True)
282
to_rf = self.to_repository._revision_store.get_revision_file(
284
from_rf = self.from_repository._revision_store.get_revision_file(
286
to_rf.join(from_rf, version_ids=revs)
289
class Inter1and2Helper(object):
290
"""Helper for operations that convert data from model 1 and 2
292
This is for use by fetchers and converters.
295
def __init__(self, source, target):
298
:param source: The repository data comes from
299
:param target: The repository data goes to
304
def iter_rev_trees(self, revs):
305
"""Iterate through RevisionTrees efficiently.
307
Additionally, the inventory's revision_id is set if unset.
309
Trees are retrieved in batches of 100, and then yielded in the order
312
:param revs: A list of revision ids
315
for tree in self.source.revision_trees(revs[:100]):
316
if tree.inventory.revision_id is None:
317
tree.inventory.revision_id = tree.get_revision_id()
321
def generate_root_texts(self, revs):
322
"""Generate VersionedFiles for all root ids.
324
:param revs: the revisions to include
326
inventory_weave = self.source.get_inventory_weave()
329
to_store = self.target.weave_store
330
for tree in self.iter_rev_trees(revs):
331
revision_id = tree.inventory.root.revision
332
root_id = tree.inventory.root.file_id
333
parents = inventory_weave.get_parents(revision_id)
334
if root_id not in versionedfile:
335
versionedfile[root_id] = to_store.get_weave_or_empty(root_id,
336
self.target.get_transaction())
337
parent_texts[root_id] = versionedfile[root_id].add_lines(
338
revision_id, parents, [], parent_texts)
340
def regenerate_inventory(self, revs):
341
"""Generate a new inventory versionedfile in target, convertin data.
343
The inventory is retrieved from the source, (deserializing it), and
344
stored in the target (reserializing it in a different format).
345
:param revs: The revisions to include
347
inventory_weave = self.source.get_inventory_weave()
348
for tree in self.iter_rev_trees(revs):
349
parents = inventory_weave.get_parents(tree.get_revision_id())
350
self.target.add_inventory(tree.get_revision_id(), tree.inventory,
354
class Model1toKnit2Fetcher(GenericRepoFetcher):
355
"""Fetch from a Model1 repository into a Knit2 repository
357
def __init__(self, to_repository, from_repository, last_revision=None,
359
self.helper = Inter1and2Helper(from_repository, to_repository)
360
GenericRepoFetcher.__init__(self, to_repository, from_repository,
363
def _fetch_weave_texts(self, revs):
364
GenericRepoFetcher._fetch_weave_texts(self, revs)
365
# Now generate a weave for the tree root
366
self.helper.generate_root_texts(revs)
368
def _fetch_inventory_weave(self, revs):
369
self.helper.regenerate_inventory(revs)
372
class Knit1to2Fetcher(KnitRepoFetcher):
373
"""Fetch from a Knit1 repository into a Knit2 repository"""
375
def __init__(self, to_repository, from_repository, last_revision=None,
377
self.helper = Inter1and2Helper(from_repository, to_repository)
378
KnitRepoFetcher.__init__(self, to_repository, from_repository,
381
def _fetch_weave_texts(self, revs):
382
KnitRepoFetcher._fetch_weave_texts(self, revs)
383
# Now generate a weave for the tree root
384
self.helper.generate_root_texts(revs)
386
def _fetch_inventory_weave(self, revs):
387
self.helper.regenerate_inventory(revs)
390
class Fetcher(object):
391
"""Backwards compatibility glue for branch.fetch()."""
393
@deprecated_method(zero_eight)
394
def __init__(self, to_branch, from_branch, last_revision=None, pb=None):
395
"""Please see branch.fetch()."""
396
to_branch.fetch(from_branch, last_revision, pb)
added
removed
bzrlib/fetch.py
