14
16
# along with this program; if not, write to the Free Software
15
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""bzr upgrade logic."""
19
# change upgrade from .bzr to create a '.bzr-new', then do a bait and switch.
22
from bzrlib.bzrdir import ConvertBzrDir4To5, ConvertBzrDir5To6, BzrDir, BzrDirFormat4, BzrDirFormat5
23
import bzrlib.errors as errors
24
from bzrlib.transport import get_transport
25
import bzrlib.ui as ui
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
85
from bzrlib.branch import Branch, find_branch, BZR_BRANCH_FORMAT_5
86
from bzrlib.revfile import Revfile
87
from bzrlib.weave import Weave
88
from bzrlib.weavefile import read_weave, write_weave
89
from bzrlib.progress import ProgressBar
90
from bzrlib.atomicfile import AtomicFile
91
from bzrlib.xml4 import serializer_v4
92
from bzrlib.xml5 import serializer_v5
93
from bzrlib.trace import mutter, note, warning, enable_default_logging
94
from bzrlib.osutils import sha_strings, sha_string
95
from bzrlib.commit import merge_ancestry_lines
28
98
class Convert(object):
99
def __init__(self, base_dir):
101
self.converted_revs = set()
102
self.absent_revisions = set()
30
def __init__(self, url, format):
32
self.bzrdir = BzrDir.open_unsupported(url)
33
if self.bzrdir.root_transport.is_readonly():
34
raise errors.UpgradeReadonly
35
self.transport = self.bzrdir.root_transport
36
self.pb = ui.ui_factory.nested_progress_bar()
42
108
def convert(self):
44
branch = self.bzrdir.open_branch()
45
if branch.bzrdir.root_transport.base != \
46
self.bzrdir.root_transport.base:
47
self.pb.note("This is a checkout. The branch (%s) needs to be "
48
"upgraded separately.",
49
branch.bzrdir.root_transport.base)
50
except errors.NotBranchError:
52
if not self.bzrdir.needs_format_conversion(self.format):
53
raise errors.UpToDateFormat(self.bzrdir._format)
54
if not self.bzrdir.can_convert_format():
55
raise errors.BzrError("cannot upgrade from branch format %s" %
57
self.pb.note('starting upgrade of %s', self.transport.base)
109
if not self._open_branch():
111
note('starting upgrade of %s', os.path.abspath(self.base))
58
112
self._backup_control_dir()
59
while self.bzrdir.needs_format_conversion(self.format):
60
converter = self.bzrdir._format.get_converter(self.format)
61
self.bzrdir = converter.convert(self.bzrdir, self.pb)
62
self.pb.note("finished")
113
note('starting upgrade')
114
note('note: upgrade may be faster if all store files are ungzipped first')
115
self.pb = ProgressBar()
116
if not os.path.isdir(self.base + '/.bzr/weaves'):
117
os.mkdir(self.base + '/.bzr/weaves')
118
self.inv_weave = Weave('inventory')
119
self.anc_weave = Weave('ancestry')
121
# holds in-memory weaves for all files
122
self.text_weaves = {}
123
os.remove(self.branch.controlfilename('branch-format'))
124
self._convert_working_inv()
125
rev_history = self.branch.revision_history()
126
# to_read is a stack holding the revisions we still need to process;
127
# appending to it adds new highest-priority revisions
128
self.known_revisions = set(rev_history)
129
self.to_read = [rev_history[-1]]
131
rev_id = self.to_read.pop()
132
if (rev_id not in self.revisions
133
and rev_id not in self.absent_revisions):
134
self._load_one_rev(rev_id)
136
to_import = self._make_order()
137
for i, rev_id in enumerate(to_import):
138
self.pb.update('converting revision', i, len(to_import))
139
self._convert_one_rev(rev_id)
141
note('upgraded to weaves:')
142
note(' %6d revisions and inventories' % len(self.revisions))
143
note(' %6d absent revisions removed' % len(self.absent_revisions))
144
note(' %6d texts' % self.text_count)
145
self._write_all_weaves()
146
self._write_all_revs()
147
self._set_new_format()
148
self._cleanup_spare_files()
151
def _open_branch(self):
152
self.branch = Branch.open_downlevel(self.base)
153
if self.branch._branch_format == 5:
154
note('this branch is already in the most current format')
156
if self.branch._branch_format != 4:
157
raise BzrError("cannot upgrade from branch format %r" %
158
self.branch._branch_format)
162
def _set_new_format(self):
163
self.branch.put_controlfile('branch-format', BZR_BRANCH_FORMAT_5)
166
def _cleanup_spare_files(self):
167
for n in 'merged-patches', 'pending-merged-patches':
168
p = self.branch.controlfilename(n)
169
if not os.path.exists(p):
171
## assert os.path.getsize(p) == 0
173
shutil.rmtree(self.base + '/.bzr/inventory-store')
174
shutil.rmtree(self.base + '/.bzr/text-store')
64
177
def _backup_control_dir(self):
65
self.pb.note('making backup of tree history')
66
self.transport.copy_tree('.bzr', '.bzr.backup')
67
self.pb.note('%s.bzr has been backed up to %s.bzr.backup',
70
self.pb.note('if conversion fails, you can move this directory back to .bzr')
71
self.pb.note('if it succeeds, you can remove this directory if you wish')
73
def upgrade(url, format=None):
74
"""Upgrade to format, or the default bzrdir format if not supplied."""
178
orig = self.base + '/.bzr'
179
backup = orig + '.backup'
180
note('making backup of tree history')
181
shutil.copytree(orig, backup)
182
note('%s has been backed up to %s', orig, backup)
183
note('if conversion fails, you can move this directory back to .bzr')
184
note('if it succeeds, you can remove this directory if you wish')
187
def _convert_working_inv(self):
189
inv = serializer_v4.read_inventory(branch.controlfile('inventory', 'rb'))
190
new_inv_xml = serializer_v5.write_inventory_to_string(inv)
191
branch.put_controlfile('inventory', new_inv_xml)
195
def _write_all_weaves(self):
196
write_a_weave(self.inv_weave, self.base + '/.bzr/inventory.weave')
197
write_a_weave(self.anc_weave, self.base + '/.bzr/ancestry.weave')
200
for file_id, file_weave in self.text_weaves.items():
201
self.pb.update('writing weave', i, len(self.text_weaves))
202
write_a_weave(file_weave, self.base + '/.bzr/weaves/%s.weave' % file_id)
208
def _write_all_revs(self):
209
"""Write all revisions out in new form."""
210
shutil.rmtree(self.base + '/.bzr/revision-store')
211
os.mkdir(self.base + '/.bzr/revision-store')
213
for i, rev_id in enumerate(self.converted_revs):
214
self.pb.update('write revision', i, len(self.converted_revs))
215
f = file(self.base + '/.bzr/revision-store/%s' % rev_id, 'wb')
217
serializer_v5.write_revision(self.revisions[rev_id], f)
224
def _load_one_rev(self, rev_id):
225
"""Load a revision object into memory.
227
Any parents not either loaded or abandoned get queued to be
229
self.pb.update('loading revision',
231
len(self.known_revisions))
232
if rev_id not in self.branch.revision_store:
234
note('revision {%s} not present in branch; '
235
'will not be converted',
237
self.absent_revisions.add(rev_id)
239
rev_xml = self.branch.revision_store[rev_id].read()
240
rev = serializer_v4.read_revision_from_string(rev_xml)
241
for parent_id in rev.parent_ids:
242
self.known_revisions.add(parent_id)
243
self.to_read.append(parent_id)
244
self.revisions[rev_id] = rev
247
def _load_old_inventory(self, rev_id):
248
assert rev_id not in self.converted_revs
249
old_inv_xml = self.branch.inventory_store[rev_id].read()
250
inv = serializer_v4.read_inventory_from_string(old_inv_xml)
251
rev = self.revisions[rev_id]
252
if rev.inventory_sha1:
253
assert rev.inventory_sha1 == sha_string(old_inv_xml), \
254
'inventory sha mismatch for {%s}' % rev_id
258
def _load_updated_inventory(self, rev_id):
259
assert rev_id in self.converted_revs
260
inv_xml = self.inv_weave.get_text(rev_id)
261
inv = serializer_v5.read_inventory_from_string(inv_xml)
265
def _convert_one_rev(self, rev_id):
266
"""Convert revision and all referenced objects to new format."""
267
rev = self.revisions[rev_id]
268
inv = self._load_old_inventory(rev_id)
269
for parent_id in rev.parent_ids[:]:
270
if parent_id in self.absent_revisions:
271
rev.parent_ids.remove(parent_id)
273
note('remove {%s} as parent of {%s}', parent_id, rev_id)
274
self._convert_revision_contents(rev, inv)
275
self._store_new_weave(rev, inv)
276
self._make_rev_ancestry(rev)
277
self.converted_revs.add(rev_id)
280
def _store_new_weave(self, rev, inv):
281
# the XML is now updated with text versions
285
if ie.kind == 'root_directory':
287
assert hasattr(ie, 'revision'), \
288
'no revision on {%s} in {%s}' % \
289
(file_id, rev.revision_id)
291
new_inv_xml = serializer_v5.write_inventory_to_string(inv)
292
new_inv_sha1 = sha_string(new_inv_xml)
293
self.inv_weave.add(rev.revision_id, rev.parent_ids,
294
new_inv_xml.splitlines(True),
296
rev.inventory_sha1 = new_inv_sha1
299
def _make_rev_ancestry(self, rev):
300
rev_id = rev.revision_id
301
for parent_id in rev.parent_ids:
302
assert parent_id in self.converted_revs
304
lines = list(self.anc_weave.mash_iter(rev.parent_ids))
307
lines.append(rev_id + '\n')
309
parent_ancestries = [self.ancestries[p] for p in rev.parent_ids]
310
new_lines = merge_ancestry_lines(rev_id, parent_ancestries)
311
assert set(lines) == set(new_lines)
312
self.ancestries[rev_id] = new_lines
313
self.anc_weave.add(rev_id, rev.parent_ids, lines)
316
def _convert_revision_contents(self, rev, inv):
317
"""Convert all the files within a revision.
319
Also upgrade the inventory to refer to the text revision ids."""
320
rev_id = rev.revision_id
321
mutter('converting texts of revision {%s}',
323
parent_invs = map(self._load_updated_inventory, rev.parent_ids)
326
self._set_revision(rev, ie, parent_invs)
327
if ie.kind != 'file':
329
self._convert_file_version(rev, ie, parent_invs)
332
def _set_revision(self, rev, ie, parent_invs):
333
"""Set name version for a file.
335
Done in a slightly lazy way: if the file is renamed or in a merge revision
336
it gets a new version, otherwise the same as before.
339
if ie.kind == 'root_directory':
341
if len(parent_invs) != 1:
342
ie.revision = rev.revision_id
344
old_inv = parent_invs[0]
345
if not old_inv.has_id(file_id):
346
ie.revision = rev.revision_id
348
old_ie = old_inv[file_id]
349
if (old_ie.parent_id != ie.parent_id
350
or old_ie.name != ie.name):
351
ie.revision = rev.revision_id
353
ie.revision = old_ie.revision
357
def _convert_file_version(self, rev, ie, parent_invs):
358
"""Convert one version of one file.
360
The file needs to be added into the weave if it is a merge
361
of >=2 parents or if it's changed from its parent.
364
rev_id = rev.revision_id
365
w = self.text_weaves.get(file_id)
368
self.text_weaves[file_id] = w
371
for parent_inv in parent_invs:
372
if parent_inv.has_id(file_id):
373
parent_ie = parent_inv[file_id]
374
old_revision = parent_ie.revision
375
# if this fails, its a ghost ?
376
assert old_revision in self.converted_revs
377
if old_revision not in file_parents:
378
file_parents.append(old_revision)
379
if parent_ie.text_sha1 != ie.text_sha1:
381
if len(file_parents) != 1 or text_changed:
382
file_lines = self.branch.text_store[ie.text_id].readlines()
383
assert sha_strings(file_lines) == ie.text_sha1
384
assert sum(map(len, file_lines)) == ie.text_size
385
w.add(rev_id, file_parents, file_lines, ie.text_sha1)
388
##mutter('import text {%s} of {%s}',
389
## ie.text_id, file_id)
391
##mutter('text of {%s} unchanged from parent', file_id)
392
ie.revision = file_parents[0]
397
def _make_order(self):
398
"""Return a suitable order for importing revisions.
400
The order must be such that an revision is imported after all
401
its (present) parents.
403
todo = set(self.revisions.keys())
404
done = self.absent_revisions.copy()
407
# scan through looking for a revision whose parents
409
for rev_id in sorted(list(todo)):
410
rev = self.revisions[rev_id]
411
parent_ids = set(rev.parent_ids)
412
if parent_ids.issubset(done):
413
# can take this one now
420
def write_a_weave(weave, filename):
421
inv_wf = file(filename, 'wb')
423
write_weave(weave, inv_wf)
428
def upgrade(base_dir):
added
removed
bzrlib/upgrade.py
