1
# Copyright (C) 2005, 2006, 2008-2011 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""bzr upgrade logic."""
25
from bzrlib.bzrdir import (
29
from bzrlib.remote import RemoteBzrDir
32
class Convert(object):
34
def __init__(self, url=None, format=None, control_dir=None):
35
"""Convert a Bazaar control directory to a given format.
37
Either the url or control_dir parameter must be given.
39
:param url: the URL of the control directory or None if the
40
control_dir is explicitly given instead
41
:param format: the format to convert to or None for the default
42
:param control_dir: the control directory or None if it is
43
specified via the URL parameter instead
46
# XXX: Change to cleanup
47
warning_id = 'cross_format_fetch'
48
saved_warning = warning_id in ui.ui_factory.suppressed_warnings
49
if url is None and control_dir is None:
51
"either the url or control_dir parameter must be set.")
52
if control_dir is not None:
53
self.bzrdir = control_dir
55
self.bzrdir = BzrDir.open_unsupported(url)
56
if isinstance(self.bzrdir, RemoteBzrDir):
57
self.bzrdir._ensure_real()
58
self.bzrdir = self.bzrdir._real_bzrdir
59
if self.bzrdir.root_transport.is_readonly():
60
raise errors.UpgradeReadonly
61
self.transport = self.bzrdir.root_transport
62
ui.ui_factory.suppressed_warnings.add(warning_id)
67
ui.ui_factory.suppressed_warnings.remove(warning_id)
71
branch = self.bzrdir.open_branch()
72
if branch.user_url != self.bzrdir.user_url:
74
'This is a checkout. The branch (%s) needs to be upgraded'
75
' separately.' % (branch.user_url,))
77
except (errors.NotBranchError, errors.IncompatibleRepositories):
78
# might not be a format we can open without upgrading; see e.g.
79
# https://bugs.launchpad.net/bzr/+bug/253891
81
if self.format is None:
83
rich_root = self.bzrdir.find_repository()._format.rich_root_data
84
except errors.NoRepositoryPresent:
85
rich_root = False # assume no rich roots
87
format_name = "default-rich-root"
89
format_name = "default"
90
format = format_registry.make_bzrdir(format_name)
93
if not self.bzrdir.needs_format_conversion(format):
94
raise errors.UpToDateFormat(self.bzrdir._format)
95
if not self.bzrdir.can_convert_format():
96
raise errors.BzrError("cannot upgrade from bzrdir format %s" %
98
self.bzrdir.check_conversion_target(format)
99
ui.ui_factory.note('starting upgrade of %s' % self.transport.base)
101
self.backup_oldpath, self.backup_newpath = self.bzrdir.backup_bzrdir()
102
while self.bzrdir.needs_format_conversion(format):
103
converter = self.bzrdir._format.get_converter(format)
104
self.bzrdir = converter.convert(self.bzrdir, None)
105
ui.ui_factory.note('finished')
108
"""Clean-up after a conversion.
110
This removes the backup.bzr directory.
112
transport = self.transport
113
backup_relpath = transport.relpath(self.backup_newpath)
114
child_pb = ui.ui_factory.nested_progress_bar()
115
child_pb.update('Deleting backup.bzr')
117
transport.delete_tree(backup_relpath)
122
def upgrade(url, format=None, clean_up=False, dry_run=False):
123
"""Upgrade locations to format.
125
This routine wraps the smart_upgrade() routine with a nicer UI.
126
In particular, it ensures all URLs can be opened before starting
127
and reports a summary at the end if more than one upgrade was attempted.
128
This routine is useful for command line tools. Other bzrlib clients
129
probably ought to use smart_upgrade() instead.
131
:param url: a URL of the locations to upgrade.
132
:param format: the format to convert to or None for the best default
133
:param clean-up: if True, the backup.bzr directory is removed if the
134
upgrade succeeded for a given repo/branch/tree
135
:param dry_run: show what would happen but don't actually do any upgrades
136
:return: the list of exceptions encountered
138
control_dirs = [BzrDir.open_unsupported(url)]
139
attempted, succeeded, exceptions = smart_upgrade(control_dirs,
140
format, clean_up=clean_up, dry_run=dry_run)
141
if len(attempted) > 1:
142
attempted_count = len(attempted)
143
succeeded_count = len(succeeded)
144
failed_count = attempted_count - succeeded_count
146
'\nSUMMARY: %d upgrades attempted, %d succeeded, %d failed'
147
% (attempted_count, succeeded_count, failed_count))
151
def smart_upgrade(control_dirs, format, clean_up=False,
153
"""Convert control directories to a new format intelligently.
155
If the control directory is a shared repository, dependent branches
156
are also converted provided the repository converted successfully.
157
If the conversion of a branch fails, remaining branches are still tried.
159
:param control_dirs: the BzrDirs to upgrade
160
:param format: the format to convert to or None for the best default
161
:param clean_up: if True, the backup.bzr directory is removed if the
162
upgrade succeeded for a given repo/branch/tree
163
:param dry_run: show what would happen but don't actually do any upgrades
164
:return: attempted-control-dirs, succeeded-control-dirs, exceptions
169
for control_dir in control_dirs:
170
attempted, succeeded, exceptions = _smart_upgrade_one(control_dir,
171
format, clean_up=clean_up, dry_run=dry_run)
172
all_attempted.extend(attempted)
173
all_succeeded.extend(succeeded)
174
all_exceptions.extend(exceptions)
175
return all_attempted, all_succeeded, all_exceptions
178
def _smart_upgrade_one(control_dir, format, clean_up=False,
180
"""Convert a control directory to a new format intelligently.
182
See smart_upgrade for parameter details.
184
# If the URL is a shared repository, find the dependent branches
187
repo = control_dir.open_repository()
188
except errors.NoRepositoryPresent:
189
# A branch or checkout using a shared repository higher up
192
# The URL is a repository. If it successfully upgrades,
193
# then upgrade the dependent branches as well.
195
dependents = repo.find_branches(using=True)
198
attempted = [control_dir]
199
succeeded, exceptions = _convert_items([control_dir], format, clean_up,
201
if succeeded and dependents:
202
ui.ui_factory.note('Found %d dependent branches - upgrading ...'
203
% (len(dependents),))
204
# Convert dependent branches
205
branch_cdirs = [b.bzrdir for b in dependents]
206
successes, problems = _convert_items(branch_cdirs, format, clean_up,
207
dry_run, label="branch")
208
attempted.extend(branch_cdirs)
209
succeeded.extend(successes)
210
exceptions.extend(problems)
213
return attempted, succeeded, exceptions
215
# FIXME: There are several problems below:
216
# - RemoteRepository doesn't support _unsupported (really ?)
217
# - raising AssertionError is rude and may not be necessary
219
# - the only caller uses only the label
220
def _get_object_and_label(control_dir):
221
"""Return the primary object and type label for a control directory.
223
:return: object, label where:
224
* object is a Branch, Repository or WorkingTree and
227
* repository - a repository
228
* tree - a lightweight checkout
232
br = control_dir.open_branch(unsupported=True,
233
ignore_fallbacks=True)
234
except NotImplementedError:
235
# RemoteRepository doesn't support the unsupported parameter
236
br = control_dir.open_branch(ignore_fallbacks=True)
237
except errors.NotBranchError:
242
repo = control_dir.open_repository()
243
except errors.NoRepositoryPresent:
246
return repo, "repository"
248
wt = control_dir.open_workingtree()
249
except (errors.NoWorkingTree, errors.NotLocalUrl):
253
raise AssertionError("unknown type of control directory %s", control_dir)
256
def _convert_items(items, format, clean_up, dry_run, label=None):
257
"""Convert a sequence of control directories to the given format.
259
:param items: the control directories to upgrade
260
:param format: the format to convert to or None for the best default
261
:param clean-up: if True, the backup.bzr directory is removed if the
262
upgrade succeeded for a given repo/branch/tree
263
:param dry_run: show what would happen but don't actually do any upgrades
264
:param label: the label for these items or None to calculate one
265
:return: items successfully upgraded, exceptions
269
child_pb = ui.ui_factory.nested_progress_bar()
270
child_pb.update('Upgrading bzrdirs', 0, len(items))
271
for i, control_dir in enumerate(items):
273
location = control_dir.root_transport.base
274
bzr_object, bzr_label = _get_object_and_label(control_dir)
275
type_label = label or bzr_label
276
child_pb.update("Upgrading %s" % (type_label), i+1, len(items))
277
ui.ui_factory.note('Upgrading %s %s ...' % (type_label, location,))
280
cv = Convert(control_dir=control_dir, format=format)
281
except Exception, ex:
282
trace.warning('conversion error: %s' % ex)
283
exceptions.append(ex)
286
# Do any required post processing
287
succeeded.append(control_dir)
290
ui.ui_factory.note('Removing backup ...')
293
except Exception, ex:
294
trace.warning('failed to clean-up %s: %s' % (location, ex))
295
exceptions.append(ex)
300
return succeeded, exceptions
added
removed
bzrlib/upgrade.py
