3
# Copyright (C) 2005 Canonical Ltd
5
# This program is free software; you can redistribute it and/or modify
6
# it under the terms of the GNU General Public License as published by
7
# the Free Software Foundation; either version 2 of the License, or
8
# (at your option) any later version.
10
# This program is distributed in the hope that it will be useful,
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
# GNU General Public License for more details.
15
# You should have received a copy of the GNU General Public License
16
# along with this program; if not, write to the Free Software
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
"""Experiment in converting existing bzr branches to weaves."""
21
# To make this properly useful
23
# 1. assign text version ids, and put those text versions into
24
# the inventory as they're converted.
26
# 2. keep track of the previous version of each file, rather than
27
# just using the last one imported
29
# 3. assign entry versions when files are added, renamed or moved.
31
# 4. when merged-in versions are observed, walk down through them
32
# to discover everything, then commit bottom-up
34
# 5. track ancestry as things are merged in, and commit that in each
37
# Perhaps it's best to first walk the whole graph and make a plan for
38
# what should be imported in what order? Need a kind of topological
39
# sort of all revisions. (Or do we, can we just before doing a revision
40
# see that all its parents have either been converted or abandoned?)
43
# Cannot import a revision until all its parents have been
44
# imported. in other words, we can only import revisions whose
45
# parents have all been imported. the first step must be to
46
# import a revision with no parents, of which there must be at
47
# least one. (So perhaps it's useful to store forward pointers
48
# from a list of parents to their children?)
50
# Another (equivalent?) approach is to build up the ordered
51
# ancestry list for the last revision, and walk through that. We
52
# are going to need that.
54
# We don't want to have to recurse all the way back down the list.
56
# Suppose we keep a queue of the revisions able to be processed at
57
# any point. This starts out with all the revisions having no
60
# This seems like a generally useful algorithm...
62
# The current algorithm is dumb (O(n**2)?) but will do the job, and
63
# takes less than a second on the bzr.dev branch.
65
# This currently does a kind of lazy conversion of file texts, where a
66
# new text is written in every version. That's unnecessary but for
67
# the moment saves us having to worry about when files need new
71
# TODO: Don't create a progress bar here, have it passed by the caller.
72
# At least do it from the UI factory.
88
from bzrlib.branch import Branch, find_branch
89
from bzrlib.branch import BZR_BRANCH_FORMAT_5, BZR_BRANCH_FORMAT_6
90
import bzrlib.hashcache as hashcache
91
from bzrlib.revfile import Revfile
92
from bzrlib.weave import Weave
93
from bzrlib.weavefile import read_weave, write_weave
94
from bzrlib.ui import ui_factory
95
from bzrlib.atomicfile import AtomicFile
96
from bzrlib.xml4 import serializer_v4
97
from bzrlib.xml5 import serializer_v5
98
from bzrlib.trace import mutter, note, warning, enable_default_logging
99
from bzrlib.osutils import sha_strings, sha_string
102
class Convert(object):
103
def __init__(self, base_dir):
105
self.converted_revs = set()
106
self.absent_revisions = set()
113
if not self._open_branch():
115
note('starting upgrade of %s', os.path.abspath(self.base))
116
self._backup_control_dir()
117
self.pb = ui_factory.progress_bar()
118
if self.old_format == 4:
119
note('starting upgrade from format 4 to 5')
120
self._convert_to_weaves()
122
if self.old_format == 5:
123
note('starting upgrade from format 5 to 6')
124
self._convert_to_prefixed()
126
cache = hashcache.HashCache(os.path.abspath(self.base))
132
def _convert_to_prefixed(self):
133
from bzrlib.store import hash_prefix
134
for store_name in ["weaves", "revision-store"]:
135
note("adding prefixes to %s" % store_name)
136
store_dir = os.path.join(self.base, ".bzr", store_name)
137
for filename in os.listdir(store_dir):
138
if filename.endswith(".weave") or filename.endswith(".gz"):
139
file_id = os.path.splitext(filename)[0]
142
prefix_dir = os.path.join(store_dir, hash_prefix(file_id))
143
if not os.path.isdir(prefix_dir):
145
os.rename(os.path.join(store_dir, filename),
146
os.path.join(prefix_dir, filename))
147
self._set_new_format(BZR_BRANCH_FORMAT_6)
150
def _convert_to_weaves(self):
151
note('note: upgrade may be faster if all store files are ungzipped first')
152
if not os.path.isdir(self.base + '/.bzr/weaves'):
153
os.mkdir(self.base + '/.bzr/weaves')
154
self.inv_weave = Weave('inventory')
155
# holds in-memory weaves for all files
156
self.text_weaves = {}
157
os.remove(self.branch.controlfilename('branch-format'))
158
self._convert_working_inv()
159
rev_history = self.branch.revision_history()
160
# to_read is a stack holding the revisions we still need to process;
161
# appending to it adds new highest-priority revisions
162
self.known_revisions = set(rev_history)
163
self.to_read = [rev_history[-1]]
165
rev_id = self.to_read.pop()
166
if (rev_id not in self.revisions
167
and rev_id not in self.absent_revisions):
168
self._load_one_rev(rev_id)
170
to_import = self._make_order()
171
for i, rev_id in enumerate(to_import):
172
self.pb.update('converting revision', i, len(to_import))
173
self._convert_one_rev(rev_id)
175
note('upgraded to weaves:')
176
note(' %6d revisions and inventories' % len(self.revisions))
177
note(' %6d revisions not present' % len(self.absent_revisions))
178
note(' %6d texts' % self.text_count)
179
self._write_all_weaves()
180
self._write_all_revs()
181
self._cleanup_spare_files()
182
self._set_new_format(BZR_BRANCH_FORMAT_5)
185
def _open_branch(self):
186
self.branch = Branch.open_downlevel(self.base)
187
self.old_format = self.branch._branch_format
188
if self.old_format == 6:
189
note('this branch is in the most current format')
191
if self.old_format not in (4, 5):
192
raise BzrError("cannot upgrade from branch format %r" %
193
self.branch._branch_format)
197
def _set_new_format(self, format):
198
self.branch.put_controlfile('branch-format', format)
201
def _cleanup_spare_files(self):
202
for n in 'merged-patches', 'pending-merged-patches':
203
p = self.branch.controlfilename(n)
204
if not os.path.exists(p):
206
## assert os.path.getsize(p) == 0
208
shutil.rmtree(self.base + '/.bzr/inventory-store')
209
shutil.rmtree(self.base + '/.bzr/text-store')
212
def _backup_control_dir(self):
213
orig = self.base + '/.bzr'
214
backup = orig + '.backup'
215
note('making backup of tree history')
216
shutil.copytree(orig, backup)
217
note('%s has been backed up to %s', orig, backup)
218
note('if conversion fails, you can move this directory back to .bzr')
219
note('if it succeeds, you can remove this directory if you wish')
222
def _convert_working_inv(self):
224
inv = serializer_v4.read_inventory(branch.controlfile('inventory', 'rb'))
225
new_inv_xml = serializer_v5.write_inventory_to_string(inv)
226
branch.put_controlfile('inventory', new_inv_xml)
230
def _write_all_weaves(self):
231
write_a_weave(self.inv_weave, self.base + '/.bzr/inventory.weave')
234
for file_id, file_weave in self.text_weaves.items():
235
self.pb.update('writing weave', i, len(self.text_weaves))
236
write_a_weave(file_weave, self.base + '/.bzr/weaves/%s.weave' % file_id)
242
def _write_all_revs(self):
243
"""Write all revisions out in new form."""
244
shutil.rmtree(self.base + '/.bzr/revision-store')
245
os.mkdir(self.base + '/.bzr/revision-store')
247
for i, rev_id in enumerate(self.converted_revs):
248
self.pb.update('write revision', i, len(self.converted_revs))
249
f = file(self.base + '/.bzr/revision-store/%s' % rev_id, 'wb')
251
serializer_v5.write_revision(self.revisions[rev_id], f)
258
def _load_one_rev(self, rev_id):
259
"""Load a revision object into memory.
261
Any parents not either loaded or abandoned get queued to be
263
self.pb.update('loading revision',
265
len(self.known_revisions))
266
if rev_id not in self.branch.revision_store:
268
note('revision {%s} not present in branch; '
269
'will be converted as a ghost',
271
self.absent_revisions.add(rev_id)
273
rev_xml = self.branch.revision_store[rev_id].read()
274
rev = serializer_v4.read_revision_from_string(rev_xml)
275
for parent_id in rev.parent_ids:
276
self.known_revisions.add(parent_id)
277
self.to_read.append(parent_id)
278
self.revisions[rev_id] = rev
281
def _load_old_inventory(self, rev_id):
282
assert rev_id not in self.converted_revs
283
old_inv_xml = self.branch.inventory_store[rev_id].read()
284
inv = serializer_v4.read_inventory_from_string(old_inv_xml)
285
rev = self.revisions[rev_id]
286
if rev.inventory_sha1:
287
assert rev.inventory_sha1 == sha_string(old_inv_xml), \
288
'inventory sha mismatch for {%s}' % rev_id
292
def _load_updated_inventory(self, rev_id):
293
assert rev_id in self.converted_revs
294
inv_xml = self.inv_weave.get_text(rev_id)
295
inv = serializer_v5.read_inventory_from_string(inv_xml)
299
def _convert_one_rev(self, rev_id):
300
"""Convert revision and all referenced objects to new format."""
301
rev = self.revisions[rev_id]
302
inv = self._load_old_inventory(rev_id)
303
present_parents = [p for p in rev.parent_ids
304
if p not in self.absent_revisions]
305
self._convert_revision_contents(rev, inv, present_parents)
306
self._store_new_weave(rev, inv, present_parents)
307
self.converted_revs.add(rev_id)
310
def _store_new_weave(self, rev, inv, present_parents):
311
# the XML is now updated with text versions
315
if ie.kind == 'root_directory':
317
assert hasattr(ie, 'revision'), \
318
'no revision on {%s} in {%s}' % \
319
(file_id, rev.revision_id)
320
new_inv_xml = serializer_v5.write_inventory_to_string(inv)
321
new_inv_sha1 = sha_string(new_inv_xml)
322
self.inv_weave.add(rev.revision_id,
324
new_inv_xml.splitlines(True),
326
rev.inventory_sha1 = new_inv_sha1
328
def _convert_revision_contents(self, rev, inv, present_parents):
329
"""Convert all the files within a revision.
331
Also upgrade the inventory to refer to the text revision ids."""
332
rev_id = rev.revision_id
333
mutter('converting texts of revision {%s}',
335
parent_invs = map(self._load_updated_inventory, present_parents)
338
self._convert_file_version(rev, ie, parent_invs)
340
def _convert_file_version(self, rev, ie, parent_invs):
341
"""Convert one version of one file.
343
The file needs to be added into the weave if it is a merge
344
of >=2 parents or if it's changed from its parent.
346
if ie.kind == 'root_directory':
349
rev_id = rev.revision_id
350
w = self.text_weaves.get(file_id)
353
self.text_weaves[file_id] = w
355
previous_entries = ie.find_previous_heads(parent_invs, w)
356
for old_revision in previous_entries:
357
# if this fails, its a ghost ?
358
assert old_revision in self.converted_revs
359
self.snapshot_ie(previous_entries, ie, w, rev_id)
361
assert getattr(ie, 'revision', None) is not None
363
def snapshot_ie(self, previous_revisions, ie, w, rev_id):
364
# TODO: convert this logic, which is ~= snapshot to
365
# a call to:. This needs the path figured out. rather than a work_tree
366
# a v4 revision_tree can be given, or something that looks enough like
367
# one to give the file content to the entry if it needs it.
368
# and we need something that looks like a weave store for snapshot to
370
#ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
371
if len(previous_revisions) == 1:
372
previous_ie = previous_revisions.values()[0]
373
if ie._unchanged(previous_ie):
374
ie.revision = previous_ie.revision
376
parent_indexes = map(w.lookup, previous_revisions)
378
file_lines = self.branch.text_store[ie.text_id].readlines()
379
assert sha_strings(file_lines) == ie.text_sha1
380
assert sum(map(len, file_lines)) == ie.text_size
381
w.add(rev_id, parent_indexes, file_lines, ie.text_sha1)
384
w.add(rev_id, parent_indexes, [], None)
386
##mutter('import text {%s} of {%s}',
387
## ie.text_id, file_id)
389
def _make_order(self):
390
"""Return a suitable order for importing revisions.
392
The order must be such that an revision is imported after all
393
its (present) parents.
395
todo = set(self.revisions.keys())
396
done = self.absent_revisions.copy()
399
# scan through looking for a revision whose parents
401
for rev_id in sorted(list(todo)):
402
rev = self.revisions[rev_id]
403
parent_ids = set(rev.parent_ids)
404
if parent_ids.issubset(done):
405
# can take this one now
412
def write_a_weave(weave, filename):
413
inv_wf = file(filename, 'wb')
415
write_weave(weave, inv_wf)
420
def upgrade(base_dir):
added
removed
bzrlib/upgrade.py
