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
# Original author: David Allouche
25
from .branch import Branch
26
from .i18n import gettext
27
from .trace import note
30
def _run_post_switch_hooks(control_dir, to_branch, force, revision_id):
31
from .branch import SwitchHookParams
32
hooks = Branch.hooks['post_switch']
35
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, possible_transports=None):
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
52
tree = control_dir.open_workingtree()
53
except errors.NotBranchError as ex:
54
# Lightweight checkout and branch is no longer there
55
if not force or store_uncommitted:
60
if store_uncommitted or tree.branch.get_bound_location():
63
tree.lock_tree_write()
66
parent_ids = tree.get_parent_ids()
67
if len(parent_ids) > 1:
68
raise errors.CommandError(
69
gettext('Pending merges must be '
70
'committed or reverted before using switch.'))
73
tree.store_uncommitted()
75
source_repository = to_branch.repository
76
base_revision_id = None
78
source_repository = tree.branch.repository
79
# Attempt to retrieve the base_revision_id now, since some
80
# working tree formats (i.e. git) don't have their own
81
# last_revision but just use that of the currently active branch.
82
base_revision_id = tree.last_revision()
86
with to_branch.lock_read():
87
_set_branch_location(control_dir, to_branch, tree.branch if tree else None, force)
88
tree = control_dir.open_workingtree()
92
tree.lock_tree_write()
94
if base_revision_id is None:
95
# If we couldn't get to the tree's last_revision earlier, perhaps
97
base_revision_id = tree.last_revision()
98
if revision_id is None:
99
revision_id = to_branch.last_revision()
100
if base_revision_id == revision_id:
102
note(gettext("Tree is up to date at revision %d."),
105
base_tree = source_repository.revision_tree(base_revision_id)
106
target_tree = to_branch.repository.revision_tree(revision_id)
107
merge.Merge3Merger(tree, tree, base_tree, target_tree)
108
tree.set_last_revision(revision_id)
110
note(gettext('Updated to revision %d.') % to_branch.revno())
111
if store_uncommitted:
112
tree.restore_uncommitted()
113
_run_post_switch_hooks(control_dir, to_branch, force, revision_id)
118
def _set_branch_location(control, to_branch, current_branch, force=False):
119
"""Set location value of a branch reference.
121
:param control: ControlDir of the checkout to change
122
:param to_branch: branch that the checkout is to reference
123
:param force: skip the check for local commits in a heavy checkout
125
branch_format = control.find_branch_format()
126
if branch_format.get_reference(control) is not None:
127
# Lightweight checkout: update the branch reference
128
branch_format.set_reference(control, None, to_branch)
131
bound_branch = b.get_bound_location()
132
if bound_branch is not None:
133
# Heavyweight checkout: check all local commits
134
# have been pushed to the current bound branch then
135
# synchronise the local branch with the new remote branch
137
possible_transports = []
139
if not force and _any_local_commits(b, possible_transports):
140
raise errors.CommandError(gettext(
141
'Cannot switch as local commits found in the checkout. '
142
'Commit these to the bound branch or use --force to '
144
except errors.BoundBranchConnectionFailure as e:
145
raise errors.CommandError(gettext(
146
'Unable to connect to current master branch %(target)s: '
147
'%(error)s To switch anyway, use --force.') %
150
b.set_bound_location(None)
151
b.pull(to_branch, overwrite=True,
152
possible_transports=possible_transports)
153
b.set_bound_location(to_branch.base)
154
b.set_parent(b.get_master_branch().get_parent())
156
# If this is a standalone tree and the new branch
157
# is derived from this one, create a lightweight checkout.
159
graph = b.repository.get_graph(to_branch.repository)
160
if (b.controldir._format.colocated_branches and
161
(force or graph.is_ancestor(
162
b.last_revision(), to_branch.last_revision()))):
163
b.controldir.destroy_branch()
164
b.controldir.set_branch_reference(to_branch, name="")
166
raise errors.CommandError(
167
gettext('Cannot switch a branch, only a checkout.'))
170
def _any_local_commits(this_branch, possible_transports):
171
"""Does this branch have any commits not in the master branch?"""
172
last_rev = revision.ensure_null(this_branch.last_revision())
173
if last_rev != revision.NULL_REVISION:
174
other_branch = this_branch.get_master_branch(possible_transports)
175
with this_branch.lock_read(), other_branch.lock_read():
176
other_last_rev = other_branch.last_revision()
177
graph = this_branch.repository.get_graph(
178
other_branch.repository)
179
if not graph.is_ancestor(last_rev, other_last_rev):