1
# Copyright (C) 2007, 2009-2012 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
from __future__ import absolute_import
19
# Original author: David Allouche
27
from .branch import Branch
28
from .i18n import gettext
29
from .trace import note
31
def _run_post_switch_hooks(control_dir, to_branch, force, revision_id):
32
from .branch import SwitchHookParams
33
hooks = Branch.hooks['post_switch']
36
params = SwitchHookParams(control_dir, to_branch, force, revision_id)
40
def switch(control_dir, to_branch, force=False, quiet=False, revision_id=None,
41
store_uncommitted=False):
42
"""Switch the branch associated with a checkout.
44
:param control_dir: ControlDir of the checkout to change
45
:param to_branch: branch that the checkout is to reference
46
:param force: skip the check for local commits in a heavy checkout
47
:param revision_id: revision ID to switch to.
48
:param store_uncommitted: If True, store uncommitted changes in the
51
_check_pending_merges(control_dir, force)
53
source_repository = control_dir.open_branch().repository
54
except errors.NotBranchError:
55
source_repository = to_branch.repository
57
with lock.write_locked(control_dir.open_workingtree()) as tree:
58
tree.store_uncommitted()
59
with to_branch.lock_read():
60
_set_branch_location(control_dir, to_branch, force)
61
tree = control_dir.open_workingtree()
62
_update(tree, source_repository, quiet, revision_id, store_uncommitted)
63
_run_post_switch_hooks(control_dir, to_branch, force, revision_id)
65
def _check_pending_merges(control, force=False):
66
"""Check that there are no outstanding pending merges before switching.
68
:param control: ControlDir of the branch to check
71
tree = control.open_workingtree()
72
except errors.NotBranchError as ex:
73
# Lightweight checkout and branch is no longer there
78
# XXX: Should the tree be locked for get_parent_ids?
79
existing_pending_merges = tree.get_parent_ids()[1:]
80
if len(existing_pending_merges) > 0:
81
raise errors.BzrCommandError(gettext('Pending merges must be '
82
'committed or reverted before using switch.'))
85
def _set_branch_location(control, to_branch, force=False):
86
"""Set location value of a branch reference.
88
:param control: ControlDir of the checkout to change
89
:param to_branch: branch that the checkout is to reference
90
:param force: skip the check for local commits in a heavy checkout
92
branch_format = control.find_branch_format()
93
if branch_format.get_reference(control) is not None:
94
# Lightweight checkout: update the branch reference
95
branch_format.set_reference(control, None, to_branch)
97
b = control.open_branch()
98
bound_branch = b.get_bound_location()
99
if bound_branch is not None:
100
# Heavyweight checkout: check all local commits
101
# have been pushed to the current bound branch then
102
# synchronise the local branch with the new remote branch
104
possible_transports = []
106
if not force and _any_local_commits(b, possible_transports):
107
raise errors.BzrCommandError(gettext(
108
'Cannot switch as local commits found in the checkout. '
109
'Commit these to the bound branch or use --force to '
111
except errors.BoundBranchConnectionFailure as e:
112
raise errors.BzrCommandError(gettext(
113
'Unable to connect to current master branch %(target)s: '
114
'%(error)s To switch anyway, use --force.') %
118
b.set_bound_location(None)
119
b.pull(to_branch, overwrite=True,
120
possible_transports=possible_transports)
121
b.set_bound_location(to_branch.base)
122
b.set_parent(b.get_master_branch().get_parent())
126
# If this is a standalone tree and the new branch
127
# is derived from this one, create a lightweight checkout.
129
graph = b.repository.get_graph(to_branch.repository)
130
if (b.controldir._format.colocated_branches and
131
(force or graph.is_ancestor(b.last_revision(),
132
to_branch.last_revision()))):
133
b.controldir.destroy_branch()
134
b.controldir.set_branch_reference(to_branch, name="")
136
raise errors.BzrCommandError(gettext('Cannot switch a branch, '
140
def _any_local_commits(this_branch, possible_transports):
141
"""Does this branch have any commits not in the master branch?"""
142
last_rev = revision.ensure_null(this_branch.last_revision())
143
if last_rev != revision.NULL_REVISION:
144
other_branch = this_branch.get_master_branch(possible_transports)
145
with this_branch.lock_read(), other_branch.lock_read():
146
other_last_rev = other_branch.last_revision()
147
graph = this_branch.repository.get_graph(
148
other_branch.repository)
149
if not graph.is_ancestor(last_rev, other_last_rev):
154
def _update(tree, source_repository, quiet=False, revision_id=None,
155
restore_uncommitted=False):
156
"""Update a working tree to the latest revision of its branch.
158
:param tree: the working tree
159
:param source_repository: repository holding the revisions
160
:param restore_uncommitted: restore any uncommitted changes in the branch.
162
if restore_uncommitted:
165
tree.lock_tree_write()
167
to_branch = tree.branch
168
if revision_id is None:
169
revision_id = to_branch.last_revision()
170
if tree.last_revision() == revision_id:
172
note(gettext("Tree is up to date at revision %d."), to_branch.revno())
174
base_tree = source_repository.revision_tree(tree.last_revision())
175
merge.Merge3Merger(tree, tree, base_tree,
176
to_branch.repository.revision_tree(revision_id))
177
tree.set_last_revision(to_branch.last_revision())
179
note(gettext('Updated to revision %d.') % to_branch.revno())
180
if restore_uncommitted:
181
tree.restore_uncommitted()