1
# Copyright (C) 2007, 2009, 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
# Original author: David Allouche
19
from bzrlib import errors, merge, revision
20
from bzrlib.trace import note
23
def _run_post_switch_hooks(control_dir, to_branch, force, revision_id):
24
from bzrlib.branch import SwitchHookParams
25
hooks = Branch.hooks['post_switch']
28
params = SwitchHookParams(control_dir, to_branch, force, revision_id)
32
def switch(control_dir, to_branch, force=False, quiet=False, revision_id=None):
33
"""Switch the branch associated with a checkout.
35
:param control_dir: BzrDir of the checkout to change
36
:param to_branch: branch that the checkout is to reference
37
:param force: skip the check for local commits in a heavy checkout
38
:param revision_id: revision ID to switch to.
40
_check_pending_merges(control_dir, force)
42
source_repository = control_dir.open_branch().repository
43
except errors.NotBranchError:
44
source_repository = to_branch.repository
45
_set_branch_location(control_dir, to_branch, force)
46
tree = control_dir.open_workingtree()
47
_update(tree, source_repository, quiet, revision_id)
48
_run_post_switch_hooks(control_dir, to_branch, force, revision_id)
50
def _check_pending_merges(control, force=False):
51
"""Check that there are no outstanding pending merges before switching.
53
:param control: BzrDir of the branch to check
56
tree = control.open_workingtree()
57
except errors.NotBranchError, ex:
58
# Lightweight checkout and branch is no longer there
63
# XXX: Should the tree be locked for get_parent_ids?
64
existing_pending_merges = tree.get_parent_ids()[1:]
65
if len(existing_pending_merges) > 0:
66
raise errors.BzrCommandError('Pending merges must be '
67
'committed or reverted before using switch.')
70
def _set_branch_location(control, to_branch, force=False):
71
"""Set location value of a branch reference.
73
:param control: BzrDir of the checkout to change
74
:param to_branch: branch that the checkout is to reference
75
:param force: skip the check for local commits in a heavy checkout
77
branch_format = control.find_branch_format()
78
if branch_format.get_reference(control) is not None:
79
# Lightweight checkout: update the branch reference
80
branch_format.set_reference(control, to_branch)
82
b = control.open_branch()
83
bound_branch = b.get_bound_location()
84
if bound_branch is not None:
85
# Heavyweight checkout: check all local commits
86
# have been pushed to the current bound branch then
87
# synchronise the local branch with the new remote branch
89
possible_transports = []
91
if not force and _any_local_commits(b, possible_transports):
92
raise errors.BzrCommandError(
93
'Cannot switch as local commits found in the checkout. '
94
'Commit these to the bound branch or use --force to '
96
except errors.BoundBranchConnectionFailure, e:
97
raise errors.BzrCommandError(
98
'Unable to connect to current master branch %(target)s: '
99
'%(error)s To switch anyway, use --force.' %
101
b.set_bound_location(None)
102
b.pull(to_branch, overwrite=True,
103
possible_transports=possible_transports)
104
b.set_bound_location(to_branch.base)
106
raise errors.BzrCommandError('Cannot switch a branch, '
110
def _any_local_commits(this_branch, possible_transports):
111
"""Does this branch have any commits not in the master branch?"""
112
last_rev = revision.ensure_null(this_branch.last_revision())
113
if last_rev != revision.NULL_REVISION:
114
other_branch = this_branch.get_master_branch(possible_transports)
115
this_branch.lock_read()
116
other_branch.lock_read()
118
other_last_rev = other_branch.last_revision()
119
graph = this_branch.repository.get_graph(
120
other_branch.repository)
121
if not graph.is_ancestor(last_rev, other_last_rev):
124
other_branch.unlock()
129
def _update(tree, source_repository, quiet=False, revision_id=None):
130
"""Update a working tree to the latest revision of its branch.
132
:param tree: the working tree
133
:param source_repository: repository holding the revisions
135
tree.lock_tree_write()
137
to_branch = tree.branch
138
if revision_id is None:
139
revision_id = to_branch.last_revision()
140
if tree.last_revision() == revision_id:
142
note("Tree is up to date at revision %d.", to_branch.revno())
144
base_tree = source_repository.revision_tree(tree.last_revision())
145
merge.Merge3Merger(tree, tree, base_tree, to_branch.repository.revision_tree(revision_id))
146
tree.set_last_revision(to_branch.last_revision())
148
note('Updated to revision %d.' % to_branch.revno())