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, force)
 
 
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, force=False):
 
 
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, ex:
 
 
50
        # Lightweight checkout and branch is no longer there
 
 
55
    # XXX: Should the tree be locked for get_parent_ids?
 
 
56
    existing_pending_merges = tree.get_parent_ids()[1:]
 
 
57
    if len(existing_pending_merges) > 0:
 
 
58
        raise errors.BzrCommandError('Pending merges must be '
 
 
59
            'committed or reverted before using switch.')
 
 
62
def _set_branch_location(control, to_branch, force=False):
 
 
63
    """Set location value of a branch reference.
 
 
65
    :param control: BzrDir of the checkout to change
 
 
66
    :param to_branch: branch that the checkout is to reference
 
 
67
    :param force: skip the check for local commits in a heavy checkout
 
 
69
    branch_format = control.find_branch_format()
 
 
70
    if branch_format.get_reference(control) is not None:
 
 
71
        # Lightweight checkout: update the branch reference
 
 
72
        branch_format.set_reference(control, to_branch)
 
 
74
        b = control.open_branch()
 
 
75
        bound_branch = b.get_bound_location()
 
 
76
        if bound_branch is not None:
 
 
77
            # Heavyweight checkout: check all local commits
 
 
78
            # have been pushed to the current bound branch then
 
 
79
            # synchronise the local branch with the new remote branch
 
 
81
            possible_transports = []
 
 
82
            if not force and _any_local_commits(b, possible_transports):
 
 
83
                raise errors.BzrCommandError(
 
 
84
                    'Cannot switch as local commits found in the checkout. '
 
 
85
                    'Commit these to the bound branch or use --force to '
 
 
87
            b.set_bound_location(None)
 
 
88
            b.pull(to_branch, overwrite=True,
 
 
89
                possible_transports=possible_transports)
 
 
90
            b.set_bound_location(to_branch.base)
 
 
92
            raise errors.BzrCommandError('Cannot switch a branch, '
 
 
96
def _any_local_commits(this_branch, possible_transports):
 
 
97
    """Does this branch have any commits not in the master branch?"""
 
 
98
    last_rev = revision.ensure_null(this_branch.last_revision())
 
 
99
    if last_rev != revision.NULL_REVISION:
 
 
100
        other_branch = this_branch.get_master_branch(possible_transports)
 
 
101
        this_branch.lock_read()
 
 
102
        other_branch.lock_read()
 
 
104
            other_last_rev = other_branch.last_revision()
 
 
105
            graph = this_branch.repository.get_graph(
 
 
106
                other_branch.repository)
 
 
107
            if not graph.is_ancestor(last_rev, other_last_rev):
 
 
110
            other_branch.unlock()
 
 
115
def _update(tree, source_repository):
 
 
116
    """Update a working tree to the latest revision of its branch.
 
 
118
    :param tree: the working tree
 
 
119
    :param source_repository: repository holding the revisions
 
 
121
    tree.lock_tree_write()
 
 
123
        to_branch = tree.branch
 
 
124
        if tree.last_revision() == to_branch.last_revision():
 
 
125
            note("Tree is up to date at revision %d.", to_branch.revno())
 
 
127
        base_tree = source_repository.revision_tree(tree.last_revision())
 
 
128
        merge.Merge3Merger(tree, tree, base_tree, to_branch.basis_tree())
 
 
129
        tree.set_last_revision(to_branch.last_revision())
 
 
130
        note('Updated to revision %d.' % to_branch.revno())