1
# Copyright (C) 2007-2010 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
"""Reconfigure a bzrdir into a new tree/branch/repository layout.
19
Various types of reconfiguration operation are available either by
20
constructing a class or using a factory method on Reconfigure.
34
# TODO: common base class for all reconfigure operations, making no
35
# assumptions about what kind of change will be done.
38
class ReconfigureStackedOn(object):
39
"""Reconfigures a branch to be stacked on another branch."""
41
def apply(self, bzrdir, stacked_on_url):
42
branch = bzrdir.open_branch()
43
# it may be a path relative to the cwd or a url; the branch wants
44
# a path relative to itself...
45
on_url = urlutils.relative_url(branch.base,
46
urlutils.normalize_url(stacked_on_url))
49
branch.set_stacked_on_url(on_url)
50
if not trace.is_quiet():
52
"%s is now stacked on %s\n"
53
% (branch.base, branch.get_stacked_on_url()))
58
class ReconfigureUnstacked(object):
60
def apply(self, bzrdir):
61
branch = bzrdir.open_branch()
64
branch.set_stacked_on_url(None)
65
if not trace.is_quiet():
67
"%s is now not stacked\n"
73
class Reconfigure(object):
75
def __init__(self, bzrdir, new_bound_location=None):
77
self.new_bound_location = new_bound_location
78
self.local_repository = None
80
self.repository = self.bzrdir.find_repository()
81
except errors.NoRepositoryPresent:
82
self.repository = None
83
self.local_repository = None
85
if (self.repository.bzrdir.root_transport.base ==
86
self.bzrdir.root_transport.base):
87
self.local_repository = self.repository
89
self.local_repository = None
91
branch = self.bzrdir.open_branch()
92
if branch.bzrdir.root_transport.base == bzrdir.root_transport.base:
93
self.local_branch = branch
94
self.referenced_branch = None
96
self.local_branch = None
97
self.referenced_branch = branch
98
except errors.NotBranchError:
99
self.local_branch = None
100
self.referenced_branch = None
102
self.tree = bzrdir.open_workingtree()
103
except errors.NoWorkingTree:
107
self._destroy_reference = False
108
self._create_reference = False
109
self._destroy_branch = False
110
self._create_branch = False
111
self._destroy_tree = False
112
self._create_tree = False
113
self._create_repository = False
114
self._destroy_repository = False
115
self._repository_trees = None
118
def to_branch(bzrdir):
119
"""Return a Reconfiguration to convert this bzrdir into a branch
121
:param bzrdir: The bzrdir to reconfigure
122
:raise errors.AlreadyBranch: if bzrdir is already a branch
124
reconfiguration = Reconfigure(bzrdir)
125
reconfiguration._plan_changes(want_tree=False, want_branch=True,
126
want_bound=False, want_reference=False)
127
if not reconfiguration.changes_planned():
128
raise errors.AlreadyBranch(bzrdir)
129
return reconfiguration
133
"""Return a Reconfiguration to convert this bzrdir into a tree
135
:param bzrdir: The bzrdir to reconfigure
136
:raise errors.AlreadyTree: if bzrdir is already a tree
138
reconfiguration = Reconfigure(bzrdir)
139
reconfiguration._plan_changes(want_tree=True, want_branch=True,
140
want_bound=False, want_reference=False)
141
if not reconfiguration.changes_planned():
142
raise errors.AlreadyTree(bzrdir)
143
return reconfiguration
146
def to_checkout(bzrdir, bound_location=None):
147
"""Return a Reconfiguration to convert this bzrdir into a checkout
149
:param bzrdir: The bzrdir to reconfigure
150
:param bound_location: The location the checkout should be bound to.
151
:raise errors.AlreadyCheckout: if bzrdir is already a checkout
153
reconfiguration = Reconfigure(bzrdir, bound_location)
154
reconfiguration._plan_changes(want_tree=True, want_branch=True,
155
want_bound=True, want_reference=False)
156
if not reconfiguration.changes_planned():
157
raise errors.AlreadyCheckout(bzrdir)
158
return reconfiguration
161
def to_lightweight_checkout(klass, bzrdir, reference_location=None):
162
"""Make a Reconfiguration to convert bzrdir into a lightweight checkout
164
:param bzrdir: The bzrdir to reconfigure
165
:param bound_location: The location the checkout should be bound to.
166
:raise errors.AlreadyLightweightCheckout: if bzrdir is already a
169
reconfiguration = klass(bzrdir, reference_location)
170
reconfiguration._plan_changes(want_tree=True, want_branch=False,
171
want_bound=False, want_reference=True)
172
if not reconfiguration.changes_planned():
173
raise errors.AlreadyLightweightCheckout(bzrdir)
174
return reconfiguration
177
def to_use_shared(klass, bzrdir):
178
"""Convert a standalone branch into a repository branch"""
179
reconfiguration = klass(bzrdir)
180
reconfiguration._set_use_shared(use_shared=True)
181
if not reconfiguration.changes_planned():
182
raise errors.AlreadyUsingShared(bzrdir)
183
return reconfiguration
186
def to_standalone(klass, bzrdir):
187
"""Convert a repository branch into a standalone branch"""
188
reconfiguration = klass(bzrdir)
189
reconfiguration._set_use_shared(use_shared=False)
190
if not reconfiguration.changes_planned():
191
raise errors.AlreadyStandalone(bzrdir)
192
return reconfiguration
195
def set_repository_trees(klass, bzrdir, with_trees):
196
"""Adjust a repository's working tree presence default"""
197
reconfiguration = klass(bzrdir)
198
if not reconfiguration.repository.is_shared():
199
raise errors.ReconfigurationNotSupported(reconfiguration.bzrdir)
200
if with_trees and reconfiguration.repository.make_working_trees():
201
raise errors.AlreadyWithTrees(bzrdir)
203
and not reconfiguration.repository.make_working_trees()):
204
raise errors.AlreadyWithNoTrees(bzrdir)
206
reconfiguration._repository_trees = with_trees
207
return reconfiguration
209
def _plan_changes(self, want_tree, want_branch, want_bound,
211
"""Determine which changes are needed to assume the configuration"""
212
if not want_branch and not want_reference:
213
raise errors.ReconfigurationNotSupported(self.bzrdir)
214
if want_branch and want_reference:
215
raise errors.ReconfigurationNotSupported(self.bzrdir)
216
if self.repository is None:
217
if not want_reference:
218
self._create_repository = True
220
if want_reference and (self.repository.bzrdir.root_transport.base
221
== self.bzrdir.root_transport.base):
222
if not self.repository.is_shared():
223
self._destroy_repository = True
224
if self.referenced_branch is None:
226
self._create_reference = True
227
if self.local_branch is not None:
228
self._destroy_branch = True
230
if not want_reference:
231
self._destroy_reference = True
232
if self.local_branch is None:
233
if want_branch is True:
234
self._create_branch = True
239
if self.local_branch.get_bound_location() is None:
242
if self.local_branch.get_bound_location() is not None:
244
if not want_tree and self.tree is not None:
245
self._destroy_tree = True
246
if want_tree and self.tree is None:
247
self._create_tree = True
249
def _set_use_shared(self, use_shared=None):
250
if use_shared is None:
253
if self.local_repository is not None:
254
self._destroy_repository = True
256
if self.local_repository is None:
257
self._create_repository = True
259
def changes_planned(self):
260
"""Return True if changes are planned, False otherwise"""
261
return (self._unbind or self._bind or self._destroy_tree
262
or self._create_tree or self._destroy_reference
263
or self._create_branch or self._create_repository
264
or self._create_reference or self._destroy_repository)
267
"""Raise if reconfiguration would destroy local changes"""
268
if self._destroy_tree and self.tree.has_changes():
269
raise errors.UncommittedChanges(self.tree)
270
if self._create_reference and self.local_branch is not None:
271
reference_branch = branch.Branch.open(self._select_bind_location())
272
if (reference_branch.last_revision() !=
273
self.local_branch.last_revision()):
274
raise errors.UnsyncedBranches(self.bzrdir, reference_branch)
276
def _select_bind_location(self):
277
"""Select a location to bind or create a reference to.
280
1. user specified location
281
2. branch reference location (it's a kind of bind location)
282
3. current bind location
283
4. previous bind location (it was a good choice once)
284
5. push location (it's writeable, so committable)
285
6. parent location (it's pullable, so update-from-able)
287
if self.new_bound_location is not None:
288
return self.new_bound_location
289
if self.local_branch is not None:
290
bound = self.local_branch.get_bound_location()
291
if bound is not None:
293
old_bound = self.local_branch.get_old_bound_location()
294
if old_bound is not None:
296
push_location = self.local_branch.get_push_location()
297
if push_location is not None:
299
parent = self.local_branch.get_parent()
300
if parent is not None:
302
elif self.referenced_branch is not None:
303
return self.referenced_branch.base
304
raise errors.NoBindLocation(self.bzrdir)
306
def apply(self, force=False):
307
"""Apply the reconfiguration
309
:param force: If true, the reconfiguration is applied even if it will
310
destroy local changes.
311
:raise errors.UncommittedChanges: if the local tree is to be destroyed
312
but contains uncommitted changes.
313
:raise errors.NoBindLocation: if no bind location was specified and
314
none could be autodetected.
318
if self._create_repository:
319
if self.local_branch and not self._destroy_branch:
320
old_repo = self.local_branch.repository
321
elif self._create_branch and self.referenced_branch is not None:
322
old_repo = self.referenced_branch.repository
325
if old_repo is not None:
326
repository_format = old_repo._format
328
repository_format = None
329
if repository_format is not None:
330
repo = repository_format.initialize(self.bzrdir)
332
repo = self.bzrdir.create_repository()
333
if self.local_branch and not self._destroy_branch:
334
repo.fetch(self.local_branch.repository,
335
self.local_branch.last_revision())
337
repo = self.repository
338
if self._create_branch and self.referenced_branch is not None:
339
repo.fetch(self.referenced_branch.repository,
340
self.referenced_branch.last_revision())
341
if self._create_reference:
342
reference_branch = branch.Branch.open(self._select_bind_location())
343
if self._destroy_repository:
344
if self._create_reference:
345
reference_branch.repository.fetch(self.repository)
346
elif self.local_branch is not None and not self._destroy_branch:
347
up = self.local_branch.bzrdir.root_transport.clone('..')
348
up_bzrdir = bzrdir.BzrDir.open_containing_from_transport(up)[0]
349
new_repo = up_bzrdir.find_repository()
350
new_repo.fetch(self.repository)
351
last_revision_info = None
352
if self._destroy_reference:
353
last_revision_info = self.referenced_branch.last_revision_info()
354
self.bzrdir.destroy_branch()
355
if self._destroy_branch:
356
last_revision_info = self.local_branch.last_revision_info()
357
if self._create_reference:
358
self.local_branch.tags.merge_to(reference_branch.tags)
359
self.bzrdir.destroy_branch()
360
if self._create_branch:
361
local_branch = self.bzrdir.create_branch()
362
if last_revision_info is not None:
363
local_branch.set_last_revision_info(*last_revision_info)
364
if self._destroy_reference:
365
self.referenced_branch.tags.merge_to(local_branch.tags)
366
self.referenced_branch.update_references(local_branch)
368
local_branch = self.local_branch
369
if self._create_reference:
370
format = branch.BranchReferenceFormat().initialize(self.bzrdir,
371
target_branch=reference_branch)
372
if self._destroy_tree:
373
self.bzrdir.destroy_workingtree()
374
if self._create_tree:
375
self.bzrdir.create_workingtree()
377
self.local_branch.unbind()
379
bind_location = self._select_bind_location()
380
local_branch.bind(branch.Branch.open(bind_location))
381
if self._destroy_repository:
382
self.bzrdir.destroy_repository()
383
if self._repository_trees is not None:
384
repo.set_make_working_trees(self._repository_trees)
added
removed
bzrlib/reconfigure.py
