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
49
# TODO: Avoid repeatedly opening weaves so many times.
51
# XXX: This doesn't handle ghost (not present in branch) revisions at
52
# all yet. I'm not sure they really should be supported.
54
# NOTE: This doesn't copy revisions which may be present but not
55
# merged into the last revision. I'm not sure we want to do that.
57
# - get a list of revisions that need to be pulled in
58
# - for each one, pull in that revision file
59
# and get the inventory, and store the inventory with right
61
# - and get the ancestry, and store that with right parents too
62
# - and keep a note of all file ids and version seen
63
# - then go through all files; for each one get the weave,
64
# and add in all file versions
67
@deprecated_function(zero_eight)
68
def greedy_fetch(to_branch, from_branch, revision=None, pb=None):
69
"""Legacy API, please see branch.fetch(from_branch, last_revision, pb)."""
70
f = Fetcher(to_branch, from_branch, revision, pb)
71
return f.count_copied, f.failed_revisions
76
class RepoFetcher(object):
77
"""Pull revisions and texts from one repository to another.
80
if set, try to limit to the data this revision references.
83
count_copied -- number of revisions copied
85
This should not be used directory, its essential a object to encapsulate
86
the logic in InterRepository.fetch().
88
def __init__(self, to_repository, from_repository, last_revision=None, pb=None):
90
self.failed_revisions = []
92
if to_repository.control_files._transport.base == from_repository.control_files._transport.base:
93
# check that last_revision is in 'from' and then return a no-operation.
94
if last_revision not in (None, NULL_REVISION):
95
from_repository.get_revision(last_revision)
97
self.to_repository = to_repository
98
self.from_repository = from_repository
99
# must not mutate self._last_revision as its potentially a shared instance
100
self._last_revision = last_revision
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()
118
self.to_repository.commit_write_group()
120
if self.nested_pb is not None:
121
self.nested_pb.finished()
122
self.to_repository.unlock()
124
self.from_repository.unlock()
127
"""Primary worker function.
129
This initialises all the needed variables, and then fetches the
130
requested revisions, finally clearing the progress bar.
132
self.to_weaves = self.to_repository.weave_store
133
self.to_control = self.to_repository.control_weaves
134
self.from_weaves = self.from_repository.weave_store
135
self.from_control = self.from_repository.control_weaves
137
self.file_ids_names = {}
138
pp = ProgressPhase('Fetch phase', 4, self.pb)
141
revs = self._revids_to_fetch()
145
self._fetch_weave_texts(revs)
147
self._fetch_inventory_weave(revs)
149
self._fetch_revision_texts(revs)
150
self.count_copied += len(revs)
154
def _revids_to_fetch(self):
155
mutter('fetch up to rev {%s}', self._last_revision)
156
if self._last_revision is NULL_REVISION:
157
# explicit limit of no revisions needed
159
if (self._last_revision is not None and
160
self.to_repository.has_revision(self._last_revision)):
164
return self.to_repository.missing_revision_ids(self.from_repository,
166
except errors.NoSuchRevision:
167
raise InstallFailed([self._last_revision])
169
def _fetch_weave_texts(self, revs):
170
texts_pb = bzrlib.ui.ui_factory.nested_progress_bar()
172
# fileids_altered_by_revision_ids requires reading the inventory
173
# weave, we will need to read the inventory weave again when
174
# all this is done, so enable caching for that specific weave
175
inv_w = self.from_repository.get_inventory_weave()
177
file_ids = self.from_repository.fileids_altered_by_revision_ids(revs)
179
num_file_ids = len(file_ids)
180
for file_id, required_versions in file_ids.items():
181
texts_pb.update("fetch texts", count, num_file_ids)
183
to_weave = self.to_weaves.get_weave_or_empty(file_id,
184
self.to_repository.get_transaction())
185
from_weave = self.from_weaves.get_weave(file_id,
186
self.from_repository.get_transaction())
187
# we fetch all the texts, because texts do
188
# not reference anything, and its cheap enough
189
to_weave.join(from_weave, version_ids=required_versions)
190
# we don't need *all* of this data anymore, but we dont know
191
# what we do. This cache clearing will result in a new read
192
# of the knit data when we do the checkout, but probably we
193
# want to emit the needed data on the fly rather than at the
195
# the from weave should know not to cache data being joined,
196
# but its ok to ask it to clear.
197
from_weave.clear_cache()
198
to_weave.clear_cache()
202
def _fetch_inventory_weave(self, revs):
203
pb = bzrlib.ui.ui_factory.nested_progress_bar()
205
pb.update("fetch inventory", 0, 2)
206
to_weave = self.to_control.get_weave('inventory',
207
self.to_repository.get_transaction())
209
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
211
# just merge, this is optimisable and its means we don't
212
# copy unreferenced data such as not-needed inventories.
213
pb.update("fetch inventory", 1, 3)
214
from_weave = self.from_repository.get_inventory_weave()
215
pb.update("fetch inventory", 2, 3)
216
# we fetch only the referenced inventories because we do not
217
# know for unselected inventories whether all their required
218
# texts are present in the other repository - it could be
220
to_weave.join(from_weave, pb=child_pb, msg='merge inventory',
222
from_weave.clear_cache()
229
class GenericRepoFetcher(RepoFetcher):
230
"""This is a generic repo to repo fetcher.
232
This makes minimal assumptions about repo layout and contents.
233
It triggers a reconciliation after fetching to ensure integrity.
236
def _fetch_revision_texts(self, revs):
237
"""Fetch revision object texts"""
238
rev_pb = bzrlib.ui.ui_factory.nested_progress_bar()
240
to_txn = self.to_transaction = self.to_repository.get_transaction()
243
to_store = self.to_repository._revision_store
245
pb = bzrlib.ui.ui_factory.nested_progress_bar()
247
pb.update('copying revisions', count, total)
249
sig_text = self.from_repository.get_signature_text(rev)
250
to_store.add_revision_signature_text(rev, sig_text, to_txn)
251
except errors.NoSuchRevision:
254
to_store.add_revision(self.from_repository.get_revision(rev),
259
# fixup inventory if needed:
260
# this is expensive because we have no inverse index to current ghosts.
261
# but on local disk its a few seconds and sftp push is already insane.
263
# FIXME: repository should inform if this is needed.
264
self.to_repository.reconcile()
269
class KnitRepoFetcher(RepoFetcher):
270
"""This is a knit format repository specific fetcher.
272
This differs from the GenericRepoFetcher by not doing a
273
reconciliation after copying, and using knit joining to
277
def _fetch_revision_texts(self, revs):
278
# may need to be a InterRevisionStore call here.
279
from_transaction = self.from_repository.get_transaction()
280
to_transaction = self.to_repository.get_transaction()
281
to_sf = self.to_repository._revision_store.get_signature_file(
283
from_sf = self.from_repository._revision_store.get_signature_file(
285
to_sf.join(from_sf, version_ids=revs, ignore_missing=True)
286
to_rf = self.to_repository._revision_store.get_revision_file(
288
from_rf = self.from_repository._revision_store.get_revision_file(
290
to_rf.join(from_rf, version_ids=revs)
293
class Inter1and2Helper(object):
294
"""Helper for operations that convert data from model 1 and 2
296
This is for use by fetchers and converters.
299
def __init__(self, source, target):
302
:param source: The repository data comes from
303
:param target: The repository data goes to
308
def iter_rev_trees(self, revs):
309
"""Iterate through RevisionTrees efficiently.
311
Additionally, the inventory's revision_id is set if unset.
313
Trees are retrieved in batches of 100, and then yielded in the order
316
:param revs: A list of revision ids
319
for tree in self.source.revision_trees(revs[:100]):
320
if tree.inventory.revision_id is None:
321
tree.inventory.revision_id = tree.get_revision_id()
325
def generate_root_texts(self, revs):
326
"""Generate VersionedFiles for all root ids.
328
:param revs: the revisions to include
330
inventory_weave = self.source.get_inventory_weave()
333
to_store = self.target.weave_store
334
for tree in self.iter_rev_trees(revs):
335
revision_id = tree.inventory.root.revision
336
root_id = tree.inventory.root.file_id
337
parents = inventory_weave.get_parents(revision_id)
338
if root_id not in versionedfile:
339
versionedfile[root_id] = to_store.get_weave_or_empty(root_id,
340
self.target.get_transaction())
341
parent_texts[root_id] = versionedfile[root_id].add_lines(
342
revision_id, parents, [], parent_texts)
344
def regenerate_inventory(self, revs):
345
"""Generate a new inventory versionedfile in target, convertin data.
347
The inventory is retrieved from the source, (deserializing it), and
348
stored in the target (reserializing it in a different format).
349
:param revs: The revisions to include
351
inventory_weave = self.source.get_inventory_weave()
352
for tree in self.iter_rev_trees(revs):
353
parents = inventory_weave.get_parents(tree.get_revision_id())
354
self.target.add_inventory(tree.get_revision_id(), tree.inventory,
358
class Model1toKnit2Fetcher(GenericRepoFetcher):
359
"""Fetch from a Model1 repository into a Knit2 repository
361
def __init__(self, to_repository, from_repository, last_revision=None,
363
self.helper = Inter1and2Helper(from_repository, to_repository)
364
GenericRepoFetcher.__init__(self, to_repository, from_repository,
367
def _fetch_weave_texts(self, revs):
368
GenericRepoFetcher._fetch_weave_texts(self, revs)
369
# Now generate a weave for the tree root
370
self.helper.generate_root_texts(revs)
372
def _fetch_inventory_weave(self, revs):
373
self.helper.regenerate_inventory(revs)
376
class Knit1to2Fetcher(KnitRepoFetcher):
377
"""Fetch from a Knit1 repository into a Knit2 repository"""
379
def __init__(self, to_repository, from_repository, last_revision=None,
381
self.helper = Inter1and2Helper(from_repository, to_repository)
382
KnitRepoFetcher.__init__(self, to_repository, from_repository,
385
def _fetch_weave_texts(self, revs):
386
KnitRepoFetcher._fetch_weave_texts(self, revs)
387
# Now generate a weave for the tree root
388
self.helper.generate_root_texts(revs)
390
def _fetch_inventory_weave(self, revs):
391
self.helper.regenerate_inventory(revs)
394
class Fetcher(object):
395
"""Backwards compatibility glue for branch.fetch()."""
397
@deprecated_method(zero_eight)
398
def __init__(self, to_branch, from_branch, last_revision=None, pb=None):
399
"""Please see branch.fetch()."""
400
to_branch.fetch(from_branch, last_revision, pb)
added
removed
bzrlib/fetch.py
