1
# Copyright (C) 2006, 2007 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
# Original author: David Allouche
19
from bzrlib import errors, merge, revision
20
from bzrlib.branch import Branch, BranchFormat, BranchReferenceFormat
21
from bzrlib.bzrdir import BzrDir
22
from bzrlib.trace import note
25
def switch(control_dir, to_branch, force=False):
26
"""Switch the branch associated with a checkout.
28
:param control_dir: BzrDir of the checkout to change
29
:param to_branch: branch that the checkout is to reference
30
:param force: skip the check for local commits in a heavy checkout
32
_check_pending_merges(control_dir)
34
source_repository = control_dir.open_branch().repository
35
except errors.NotBranchError:
36
source_repository = to_branch.repository
37
_set_branch_location(control_dir, to_branch, force)
38
tree = control_dir.open_workingtree()
39
_update(tree, source_repository)
42
def _check_pending_merges(control):
43
"""Check that there are no outstanding pending merges before switching.
45
:param control: BzrDir of the branch to check
48
tree = control.open_workingtree()
49
except errors.NotBranchError:
52
# XXX: Should the tree be locked for get_parent_ids?
53
existing_pending_merges = tree.get_parent_ids()[1:]
54
if len(existing_pending_merges) > 0:
55
raise errors.BzrCommandError('Pending merges must be '
56
'committed or reverted before using switch.')
59
def _set_branch_location(control, to_branch, force=False):
60
"""Set location value of a branch reference.
62
:param control: BzrDir of the checkout to change
63
:param to_branch: branch that the checkout is to reference
64
:param force: skip the check for local commits in a heavy checkout
66
branch_format = control.find_branch_format()
67
if branch_format.get_reference(control) is not None:
68
# Lightweight checkout: update the branch reference
69
branch_format.set_reference(control, to_branch)
71
b = control.open_branch()
72
bound_branch = b.get_bound_location()
73
if bound_branch is not None:
74
# Heavyweight checkout: check all local commits
75
# have been pushed to the current bound branch then
76
# synchronise the local branch with the new remote branch
78
if not force and _any_local_commits(b, bound_branch):
79
raise errors.BzrCommandError(
80
'Cannot switch as local commits found in the checkout. '
81
'Commit these to the bound branch or use --force to '
83
b.set_bound_location(None)
84
b.pull(to_branch, overwrite=True)
85
b.set_bound_location(to_branch.base)
87
raise errors.BzrCommandError('Cannot switch a branch, '
91
def _any_local_commits(this_branch, other_branch_url):
92
"""Does this branch have any commits not in the other branch?"""
93
last_rev = revision.ensure_null(this_branch.last_revision())
94
if last_rev != revision.NULL_REVISION:
95
a_bzrdir, relpath = BzrDir.open_containing(other_branch_url)
96
other_branch = a_bzrdir.open_branch()
97
other_branch.lock_read()
99
other_last_rev = other_branch.last_revision()
100
remote_graph = other_branch.repository.get_revision_graph(
102
if last_rev not in remote_graph:
105
other_branch.unlock()
109
def _update(tree, source_repository):
110
"""Update a working tree to the latest revision of its branch.
112
:param tree: the working tree
113
:param source_repository: repository holding the revisions
115
tree.lock_tree_write()
117
to_branch = tree.branch
118
if tree.last_revision() == to_branch.last_revision():
119
note("Tree is up to date at revision %d.", to_branch.revno())
121
base_tree = source_repository.revision_tree(tree.last_revision())
122
merge.Merge3Merger(tree, tree, base_tree, to_branch.basis_tree())
123
tree.set_last_revision(to_branch.last_revision())
124
note('Updated to revision %d.' % to_branch.revno())