13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""brz upgrade logic."""
19
from __future__ import absolute_import
27
from .controldir import (
31
from .i18n import gettext
32
from .bzr.remote import RemoteBzrDir
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""Experiment in converting existing bzr branches to weaves."""
19
# To make this properly useful
21
# 1. assign text version ids, and put those text versions into
22
# the inventory as they're converted.
24
# 2. keep track of the previous version of each file, rather than
25
# just using the last one imported
27
# 3. assign entry versions when files are added, renamed or moved.
29
# 4. when merged-in versions are observed, walk down through them
30
# to discover everything, then commit bottom-up
32
# 5. track ancestry as things are merged in, and commit that in each
35
# Perhaps it's best to first walk the whole graph and make a plan for
36
# what should be imported in what order? Need a kind of topological
37
# sort of all revisions. (Or do we, can we just before doing a revision
38
# see that all its parents have either been converted or abandoned?)
41
# Cannot import a revision until all its parents have been
42
# imported. in other words, we can only import revisions whose
43
# parents have all been imported. the first step must be to
44
# import a revision with no parents, of which there must be at
45
# least one. (So perhaps it's useful to store forward pointers
46
# from a list of parents to their children?)
48
# Another (equivalent?) approach is to build up the ordered
49
# ancestry list for the last revision, and walk through that. We
50
# are going to need that.
52
# We don't want to have to recurse all the way back down the list.
54
# Suppose we keep a queue of the revisions able to be processed at
55
# any point. This starts out with all the revisions having no
58
# This seems like a generally useful algorithm...
60
# The current algorithm is dumb (O(n**2)?) but will do the job, and
61
# takes less than a second on the bzr.dev branch.
63
# This currently does a kind of lazy conversion of file texts, where a
64
# new text is written in every version. That's unnecessary but for
65
# the moment saves us having to worry about when files need new
74
from bzrlib.branch import Branch, find_branch
75
from bzrlib.branch import BZR_BRANCH_FORMAT_5, BZR_BRANCH_FORMAT_6
76
import bzrlib.hashcache as hashcache
77
from bzrlib.weave import Weave
78
from bzrlib.weavefile import read_weave, write_weave
79
from bzrlib.ui import ui_factory
80
from bzrlib.atomicfile import AtomicFile
81
from bzrlib.xml4 import serializer_v4
82
from bzrlib.xml5 import serializer_v5
83
from bzrlib.trace import mutter, note, warning
84
from bzrlib.osutils import sha_strings, sha_string
35
87
class Convert(object):
37
def __init__(self, url=None, format=None, control_dir=None):
38
"""Convert a Bazaar control directory to a given format.
40
Either the url or control_dir parameter must be given.
42
:param url: the URL of the control directory or None if the
43
control_dir is explicitly given instead
44
:param format: the format to convert to or None for the default
45
:param control_dir: the control directory or None if it is
46
specified via the URL parameter instead
49
# XXX: Change to cleanup
50
warning_id = 'cross_format_fetch'
51
saved_warning = warning_id in ui.ui_factory.suppressed_warnings
52
if url is None and control_dir is None:
54
"either the url or control_dir parameter must be set.")
55
if control_dir is not None:
56
self.controldir = control_dir
58
self.controldir = ControlDir.open_unsupported(url)
59
if isinstance(self.controldir, RemoteBzrDir):
60
self.controldir._ensure_real()
61
self.controldir = self.controldir._real_bzrdir
62
if self.controldir.root_transport.is_readonly():
63
raise errors.UpgradeReadonly
64
self.transport = self.controldir.root_transport
65
ui.ui_factory.suppressed_warnings.add(warning_id)
70
ui.ui_factory.suppressed_warnings.remove(warning_id)
88
def __init__(self, base_dir):
90
self.converted_revs = set()
91
self.absent_revisions = set()
74
branch = self.controldir.open_branch()
75
if branch.user_url != self.controldir.user_url:
76
ui.ui_factory.note(gettext(
77
'This is a checkout. The branch (%s) needs to be upgraded'
78
' separately.') % (urlutils.unescape_for_display(
79
branch.user_url, 'utf-8')))
81
except (errors.NotBranchError, errors.IncompatibleRepositories):
82
# might not be a format we can open without upgrading; see e.g.
83
# https://bugs.launchpad.net/bzr/+bug/253891
85
if self.format is None:
87
rich_root = self.controldir.find_repository()._format.rich_root_data
88
except errors.NoRepositoryPresent:
89
rich_root = False # assume no rich roots
91
format_name = "default-rich-root"
93
format_name = "default"
94
format = format_registry.make_controldir(format_name)
97
if not self.controldir.needs_format_conversion(format):
98
raise errors.UpToDateFormat(self.controldir._format)
99
if not self.controldir.can_convert_format():
100
raise errors.BzrError(gettext("cannot upgrade from bzrdir format %s") %
101
self.controldir._format)
102
self.controldir.check_conversion_target(format)
103
ui.ui_factory.note(gettext('starting upgrade of %s') %
104
urlutils.unescape_for_display(self.transport.base, 'utf-8'))
106
self.backup_oldpath, self.backup_newpath = self.controldir.backup_bzrdir()
107
while self.controldir.needs_format_conversion(format):
108
converter = self.controldir._format.get_converter(format)
109
self.controldir = converter.convert(self.controldir, None)
110
ui.ui_factory.note(gettext('finished'))
113
"""Clean-up after a conversion.
115
This removes the backup.bzr directory.
117
transport = self.transport
118
backup_relpath = transport.relpath(self.backup_newpath)
119
with ui.ui_factory.nested_progress_bar() as child_pb:
120
child_pb.update(gettext('Deleting backup.bzr'))
121
transport.delete_tree(backup_relpath)
124
def upgrade(url, format=None, clean_up=False, dry_run=False):
125
"""Upgrade locations to format.
127
This routine wraps the smart_upgrade() routine with a nicer UI.
128
In particular, it ensures all URLs can be opened before starting
129
and reports a summary at the end if more than one upgrade was attempted.
130
This routine is useful for command line tools. Other breezy clients
131
probably ought to use smart_upgrade() instead.
133
:param url: a URL of the locations to upgrade.
134
:param format: the format to convert to or None for the best default
135
:param clean-up: if True, the backup.bzr directory is removed if the
136
upgrade succeeded for a given repo/branch/tree
137
:param dry_run: show what would happen but don't actually do any upgrades
138
:return: the list of exceptions encountered
140
control_dirs = [ControlDir.open_unsupported(url)]
141
attempted, succeeded, exceptions = smart_upgrade(control_dirs,
142
format, clean_up=clean_up, dry_run=dry_run)
143
if len(attempted) > 1:
144
attempted_count = len(attempted)
145
succeeded_count = len(succeeded)
146
failed_count = attempted_count - succeeded_count
148
gettext('\nSUMMARY: {0} upgrades attempted, {1} succeeded,'
149
' {2} failed').format(
150
attempted_count, succeeded_count, failed_count))
154
def smart_upgrade(control_dirs, format, clean_up=False,
156
"""Convert control directories to a new format intelligently.
158
If the control directory is a shared repository, dependent branches
159
are also converted provided the repository converted successfully.
160
If the conversion of a branch fails, remaining branches are still tried.
162
:param control_dirs: the BzrDirs to upgrade
163
:param format: the format to convert to or None for the best default
164
:param clean_up: if True, the backup.bzr directory is removed if the
165
upgrade succeeded for a given repo/branch/tree
166
:param dry_run: show what would happen but don't actually do any upgrades
167
:return: attempted-control-dirs, succeeded-control-dirs, exceptions
172
for control_dir in control_dirs:
173
attempted, succeeded, exceptions = _smart_upgrade_one(control_dir,
174
format, clean_up=clean_up, dry_run=dry_run)
175
all_attempted.extend(attempted)
176
all_succeeded.extend(succeeded)
177
all_exceptions.extend(exceptions)
178
return all_attempted, all_succeeded, all_exceptions
181
def _smart_upgrade_one(control_dir, format, clean_up=False,
183
"""Convert a control directory to a new format intelligently.
185
See smart_upgrade for parameter details.
187
# If the URL is a shared repository, find the dependent branches
190
repo = control_dir.open_repository()
191
except errors.NoRepositoryPresent:
192
# A branch or checkout using a shared repository higher up
195
# The URL is a repository. If it successfully upgrades,
196
# then upgrade the dependent branches as well.
198
dependents = list(repo.find_branches(using=True))
201
attempted = [control_dir]
202
succeeded, exceptions = _convert_items([control_dir], format, clean_up,
204
if succeeded and dependents:
205
ui.ui_factory.note(gettext('Found %d dependent branches - upgrading ...')
206
% (len(dependents),))
207
# Convert dependent branches
208
branch_cdirs = [b.controldir for b in dependents]
209
successes, problems = _convert_items(branch_cdirs, format, clean_up,
210
dry_run, label="branch")
211
attempted.extend(branch_cdirs)
212
succeeded.extend(successes)
213
exceptions.extend(problems)
216
return attempted, succeeded, exceptions
218
# FIXME: There are several problems below:
219
# - RemoteRepository doesn't support _unsupported (really ?)
220
# - raising AssertionError is rude and may not be necessary
222
# - the only caller uses only the label
225
def _get_object_and_label(control_dir):
226
"""Return the primary object and type label for a control directory.
228
:return: object, label where:
229
* object is a Branch, Repository or WorkingTree and
232
* repository - a repository
233
* tree - a lightweight checkout
237
br = control_dir.open_branch(unsupported=True,
238
ignore_fallbacks=True)
239
except NotImplementedError:
240
# RemoteRepository doesn't support the unsupported parameter
241
br = control_dir.open_branch(ignore_fallbacks=True)
242
except errors.NotBranchError:
247
repo = control_dir.open_repository()
248
except errors.NoRepositoryPresent:
251
return repo, "repository"
253
wt = control_dir.open_workingtree()
254
except (errors.NoWorkingTree, errors.NotLocalUrl):
258
raise AssertionError("unknown type of control directory %s", control_dir)
261
def _convert_items(items, format, clean_up, dry_run, label=None):
262
"""Convert a sequence of control directories to the given format.
264
:param items: the control directories to upgrade
265
:param format: the format to convert to or None for the best default
266
:param clean-up: if True, the backup.bzr directory is removed if the
267
upgrade succeeded for a given repo/branch/tree
268
:param dry_run: show what would happen but don't actually do any upgrades
269
:param label: the label for these items or None to calculate one
270
:return: items successfully upgraded, exceptions
274
with ui.ui_factory.nested_progress_bar() as child_pb:
275
child_pb.update(gettext('Upgrading bzrdirs'), 0, len(items))
276
for i, control_dir in enumerate(items):
278
location = control_dir.root_transport.base
279
bzr_object, bzr_label = _get_object_and_label(control_dir)
280
type_label = label or bzr_label
281
child_pb.update(gettext("Upgrading %s") %
282
(type_label), i + 1, len(items))
283
ui.ui_factory.note(gettext('Upgrading {0} {1} ...').format(type_label,
284
urlutils.unescape_for_display(location, 'utf-8'),))
287
cv = Convert(control_dir=control_dir, format=format)
288
except errors.UpToDateFormat as ex:
289
ui.ui_factory.note(str(ex))
290
succeeded.append(control_dir)
292
except Exception as ex:
293
trace.warning('conversion error: %s' % ex)
294
exceptions.append(ex)
297
# Do any required post processing
298
succeeded.append(control_dir)
98
if not self._open_branch():
100
note('starting upgrade of %s', os.path.abspath(self.base))
101
self._backup_control_dir()
102
self.pb = ui_factory.progress_bar()
103
if self.old_format == 4:
104
note('starting upgrade from format 4 to 5')
105
self._convert_to_weaves()
107
if self.old_format == 5:
108
note('starting upgrade from format 5 to 6')
109
self._convert_to_prefixed()
111
cache = hashcache.HashCache(os.path.abspath(self.base))
117
def _convert_to_prefixed(self):
118
from bzrlib.store import hash_prefix
119
for store_name in ["weaves", "revision-store"]:
120
note("adding prefixes to %s" % store_name)
121
store_dir = os.path.join(self.base, ".bzr", store_name)
122
for filename in os.listdir(store_dir):
123
if filename.endswith(".weave") or filename.endswith(".gz"):
124
file_id = os.path.splitext(filename)[0]
127
prefix_dir = os.path.join(store_dir, hash_prefix(file_id))
128
if not os.path.isdir(prefix_dir):
130
os.rename(os.path.join(store_dir, filename),
131
os.path.join(prefix_dir, filename))
132
self._set_new_format(BZR_BRANCH_FORMAT_6)
135
def _convert_to_weaves(self):
136
note('note: upgrade may be faster if all store files are ungzipped first')
137
if not os.path.isdir(self.base + '/.bzr/weaves'):
138
os.mkdir(self.base + '/.bzr/weaves')
139
self.inv_weave = Weave('inventory')
140
# holds in-memory weaves for all files
141
self.text_weaves = {}
142
os.remove(self.branch.controlfilename('branch-format'))
143
self._convert_working_inv()
144
rev_history = self.branch.revision_history()
145
# to_read is a stack holding the revisions we still need to process;
146
# appending to it adds new highest-priority revisions
147
self.known_revisions = set(rev_history)
148
self.to_read = rev_history[-1:]
150
rev_id = self.to_read.pop()
151
if (rev_id not in self.revisions
152
and rev_id not in self.absent_revisions):
153
self._load_one_rev(rev_id)
155
to_import = self._make_order()
156
for i, rev_id in enumerate(to_import):
157
self.pb.update('converting revision', i, len(to_import))
158
self._convert_one_rev(rev_id)
160
note('upgraded to weaves:')
161
note(' %6d revisions and inventories' % len(self.revisions))
162
note(' %6d revisions not present' % len(self.absent_revisions))
163
note(' %6d texts' % self.text_count)
164
self._write_all_weaves()
165
self._write_all_revs()
166
self._cleanup_spare_files()
167
self._set_new_format(BZR_BRANCH_FORMAT_5)
170
def _open_branch(self):
171
self.branch = Branch.open_downlevel(self.base)
172
self.old_format = self.branch._branch_format
173
if self.old_format == 6:
174
note('this branch is in the most current format')
176
if self.old_format not in (4, 5):
177
raise BzrError("cannot upgrade from branch format %r" %
178
self.branch._branch_format)
182
def _set_new_format(self, format):
183
self.branch.put_controlfile('branch-format', format)
186
def _cleanup_spare_files(self):
187
for n in 'merged-patches', 'pending-merged-patches':
188
p = self.branch.controlfilename(n)
189
if not os.path.exists(p):
191
## assert os.path.getsize(p) == 0
193
shutil.rmtree(self.base + '/.bzr/inventory-store')
194
shutil.rmtree(self.base + '/.bzr/text-store')
197
def _backup_control_dir(self):
198
orig = self.base + '/.bzr'
199
backup = orig + '.backup'
200
note('making backup of tree history')
201
shutil.copytree(orig, backup)
202
note('%s has been backed up to %s', orig, backup)
203
note('if conversion fails, you can move this directory back to .bzr')
204
note('if it succeeds, you can remove this directory if you wish')
207
def _convert_working_inv(self):
209
inv = serializer_v4.read_inventory(branch.controlfile('inventory', 'rb'))
210
new_inv_xml = serializer_v5.write_inventory_to_string(inv)
211
branch.put_controlfile('inventory', new_inv_xml)
215
def _write_all_weaves(self):
216
write_a_weave(self.inv_weave, self.base + '/.bzr/inventory.weave')
219
for file_id, file_weave in self.text_weaves.items():
220
self.pb.update('writing weave', i, len(self.text_weaves))
221
write_a_weave(file_weave, self.base + '/.bzr/weaves/%s.weave' % file_id)
227
def _write_all_revs(self):
228
"""Write all revisions out in new form."""
229
shutil.rmtree(self.base + '/.bzr/revision-store')
230
os.mkdir(self.base + '/.bzr/revision-store')
232
for i, rev_id in enumerate(self.converted_revs):
233
self.pb.update('write revision', i, len(self.converted_revs))
234
f = file(self.base + '/.bzr/revision-store/%s' % rev_id, 'wb')
301
ui.ui_factory.note(gettext('Removing backup ...'))
304
except Exception as ex:
306
gettext('failed to clean-up {0}: {1}') % (location, ex))
307
exceptions.append(ex)
310
return succeeded, exceptions
236
serializer_v5.write_revision(self.revisions[rev_id], f)
243
def _load_one_rev(self, rev_id):
244
"""Load a revision object into memory.
246
Any parents not either loaded or abandoned get queued to be
248
self.pb.update('loading revision',
250
len(self.known_revisions))
251
if not self.branch.revision_store.has_id(rev_id):
253
note('revision {%s} not present in branch; '
254
'will be converted as a ghost',
256
self.absent_revisions.add(rev_id)
258
rev_xml = self.branch.revision_store.get(rev_id).read()
259
rev = serializer_v4.read_revision_from_string(rev_xml)
260
for parent_id in rev.parent_ids:
261
self.known_revisions.add(parent_id)
262
self.to_read.append(parent_id)
263
self.revisions[rev_id] = rev
266
def _load_old_inventory(self, rev_id):
267
assert rev_id not in self.converted_revs
268
old_inv_xml = self.branch.inventory_store.get(rev_id).read()
269
inv = serializer_v4.read_inventory_from_string(old_inv_xml)
270
rev = self.revisions[rev_id]
271
if rev.inventory_sha1:
272
assert rev.inventory_sha1 == sha_string(old_inv_xml), \
273
'inventory sha mismatch for {%s}' % rev_id
277
def _load_updated_inventory(self, rev_id):
278
assert rev_id in self.converted_revs
279
inv_xml = self.inv_weave.get_text(rev_id)
280
inv = serializer_v5.read_inventory_from_string(inv_xml)
284
def _convert_one_rev(self, rev_id):
285
"""Convert revision and all referenced objects to new format."""
286
rev = self.revisions[rev_id]
287
inv = self._load_old_inventory(rev_id)
288
present_parents = [p for p in rev.parent_ids
289
if p not in self.absent_revisions]
290
self._convert_revision_contents(rev, inv, present_parents)
291
self._store_new_weave(rev, inv, present_parents)
292
self.converted_revs.add(rev_id)
295
def _store_new_weave(self, rev, inv, present_parents):
296
# the XML is now updated with text versions
300
if ie.kind == 'root_directory':
302
assert hasattr(ie, 'revision'), \
303
'no revision on {%s} in {%s}' % \
304
(file_id, rev.revision_id)
305
new_inv_xml = serializer_v5.write_inventory_to_string(inv)
306
new_inv_sha1 = sha_string(new_inv_xml)
307
self.inv_weave.add(rev.revision_id,
309
new_inv_xml.splitlines(True),
311
rev.inventory_sha1 = new_inv_sha1
313
def _convert_revision_contents(self, rev, inv, present_parents):
314
"""Convert all the files within a revision.
316
Also upgrade the inventory to refer to the text revision ids."""
317
rev_id = rev.revision_id
318
mutter('converting texts of revision {%s}',
320
parent_invs = map(self._load_updated_inventory, present_parents)
323
self._convert_file_version(rev, ie, parent_invs)
325
def _convert_file_version(self, rev, ie, parent_invs):
326
"""Convert one version of one file.
328
The file needs to be added into the weave if it is a merge
329
of >=2 parents or if it's changed from its parent.
331
if ie.kind == 'root_directory':
334
rev_id = rev.revision_id
335
w = self.text_weaves.get(file_id)
338
self.text_weaves[file_id] = w
340
previous_entries = ie.find_previous_heads(parent_invs, w)
341
for old_revision in previous_entries:
342
# if this fails, its a ghost ?
343
assert old_revision in self.converted_revs
344
self.snapshot_ie(previous_entries, ie, w, rev_id)
346
assert getattr(ie, 'revision', None) is not None
348
def snapshot_ie(self, previous_revisions, ie, w, rev_id):
349
# TODO: convert this logic, which is ~= snapshot to
350
# a call to:. This needs the path figured out. rather than a work_tree
351
# a v4 revision_tree can be given, or something that looks enough like
352
# one to give the file content to the entry if it needs it.
353
# and we need something that looks like a weave store for snapshot to
355
#ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
356
if len(previous_revisions) == 1:
357
previous_ie = previous_revisions.values()[0]
358
if ie._unchanged(previous_ie):
359
ie.revision = previous_ie.revision
361
parent_indexes = map(w.lookup, previous_revisions)
363
file_lines = self.branch.text_store.get(ie.text_id).readlines()
364
assert sha_strings(file_lines) == ie.text_sha1
365
assert sum(map(len, file_lines)) == ie.text_size
366
w.add(rev_id, parent_indexes, file_lines, ie.text_sha1)
369
w.add(rev_id, parent_indexes, [], None)
371
##mutter('import text {%s} of {%s}',
372
## ie.text_id, file_id)
374
def _make_order(self):
375
"""Return a suitable order for importing revisions.
377
The order must be such that an revision is imported after all
378
its (present) parents.
380
todo = set(self.revisions.keys())
381
done = self.absent_revisions.copy()
384
# scan through looking for a revision whose parents
386
for rev_id in sorted(list(todo)):
387
rev = self.revisions[rev_id]
388
parent_ids = set(rev.parent_ids)
389
if parent_ids.issubset(done):
390
# can take this one now
397
def write_a_weave(weave, filename):
398
inv_wf = file(filename, 'wb')
400
write_weave(weave, inv_wf)
405
def upgrade(base_dir):
added
removed
bzrlib/upgrade.py
