← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/switch.py

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/switch.py
 
1
# Copyright (C) 2006, 2007 Canonical Ltd.
 
2
#
 
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.
 
7
#
 
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.
 
12
#
 
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
 
16
 
 
17
# Original author: David Allouche
 
18
 
 
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
 
23
 
 
24
 
 
25
def switch(control_dir, to_branch, force=False, quiet=False):
 
26
    """Switch the branch associated with a checkout.
 
27
 
 
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
 
31
    """
 
32
    _check_pending_merges(control_dir, force)
 
33
    try:
 
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, quiet)
 
40
 
 
41
 
 
42
def _check_pending_merges(control, force=False):
 
43
    """Check that there are no outstanding pending merges before switching.
 
44
 
 
45
    :param control: BzrDir of the branch to check
 
46
    """
 
47
    try:
 
48
        tree = control.open_workingtree()
 
49
    except errors.NotBranchError, ex:
 
50
        # Lightweight checkout and branch is no longer there
 
51
        if force:
 
52
            return
 
53
        else:
 
54
            raise ex
 
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.')
 
60
 
 
61
 
 
62
def _set_branch_location(control, to_branch, force=False):
 
63
    """Set location value of a branch reference.
 
64
 
 
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
 
68
    """
 
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)
 
73
    else:
 
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
 
80
            # and bind to it
 
81
            possible_transports = []
 
82
            try:
 
83
                if not force and _any_local_commits(b, possible_transports):
 
84
                    raise errors.BzrCommandError(
 
85
                        'Cannot switch as local commits found in the checkout. '
 
86
                        'Commit these to the bound branch or use --force to '
 
87
                        'throw them away.')
 
88
            except errors.BoundBranchConnectionFailure, e:
 
89
                raise errors.BzrCommandError(
 
90
                        'Unable to connect to current master branch %(target)s: '
 
91
                        '%(error)s To switch anyway, use --force.' %
 
92
                        e.__dict__)
 
93
            b.set_bound_location(None)
 
94
            b.pull(to_branch, overwrite=True,
 
95
                possible_transports=possible_transports)
 
96
            b.set_bound_location(to_branch.base)
 
97
        else:
 
98
            raise errors.BzrCommandError('Cannot switch a branch, '
 
99
                'only a checkout.')
 
100
 
 
101
 
 
102
def _any_local_commits(this_branch, possible_transports):
 
103
    """Does this branch have any commits not in the master branch?"""
 
104
    last_rev = revision.ensure_null(this_branch.last_revision())
 
105
    if last_rev != revision.NULL_REVISION:
 
106
        other_branch = this_branch.get_master_branch(possible_transports)
 
107
        this_branch.lock_read()
 
108
        other_branch.lock_read()
 
109
        try:
 
110
            other_last_rev = other_branch.last_revision()
 
111
            graph = this_branch.repository.get_graph(
 
112
                other_branch.repository)
 
113
            if not graph.is_ancestor(last_rev, other_last_rev):
 
114
                return True
 
115
        finally:
 
116
            other_branch.unlock()
 
117
            this_branch.unlock()
 
118
    return False
 
119
 
 
120
 
 
121
def _update(tree, source_repository, quiet=False):
 
122
    """Update a working tree to the latest revision of its branch.
 
123
 
 
124
    :param tree: the working tree
 
125
    :param source_repository: repository holding the revisions
 
126
    """
 
127
    tree.lock_tree_write()
 
128
    try:
 
129
        to_branch = tree.branch
 
130
        if tree.last_revision() == to_branch.last_revision():
 
131
            if not quiet:
 
132
                note("Tree is up to date at revision %d.", to_branch.revno())
 
133
            return
 
134
        base_tree = source_repository.revision_tree(tree.last_revision())
 
135
        merge.Merge3Merger(tree, tree, base_tree, to_branch.basis_tree())
 
136
        tree.set_last_revision(to_branch.last_revision())
 
137
        if not quiet:
 
138
            note('Updated to revision %d.' % to_branch.revno())
 
139
    finally:
 
140
        tree.unlock()