← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/switch.py

Merge bzr.dev and tree-file-ids-as-tuples.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/switch.py
 
1
# Copyright (C) 2007, 2009, 2010 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
from __future__ import absolute_import
 
18
 
 
19
# Original author: David Allouche
 
20
 
 
21
from bzrlib import errors, merge, revision
 
22
from bzrlib.branch import Branch
 
23
from bzrlib.i18n import gettext
 
24
from bzrlib.trace import note
 
25
 
 
26
def _run_post_switch_hooks(control_dir, to_branch, force, revision_id):
 
27
    from bzrlib.branch import SwitchHookParams
 
28
    hooks = Branch.hooks['post_switch']
 
29
    if not hooks:
 
30
        return
 
31
    params = SwitchHookParams(control_dir, to_branch, force, revision_id)
 
32
    for hook in hooks:
 
33
        hook(params)
 
34
 
 
35
def switch(control_dir, to_branch, force=False, quiet=False, revision_id=None):
 
36
    """Switch the branch associated with a checkout.
 
37
 
 
38
    :param control_dir: ControlDir of the checkout to change
 
39
    :param to_branch: branch that the checkout is to reference
 
40
    :param force: skip the check for local commits in a heavy checkout
 
41
    :param revision_id: revision ID to switch to.
 
42
    """
 
43
    _check_pending_merges(control_dir, force)
 
44
    try:
 
45
        source_repository = control_dir.open_branch().repository
 
46
    except errors.NotBranchError:
 
47
        source_repository = to_branch.repository
 
48
    _set_branch_location(control_dir, to_branch, force)
 
49
    tree = control_dir.open_workingtree()
 
50
    _update(tree, source_repository, quiet, revision_id)
 
51
    _run_post_switch_hooks(control_dir, to_branch, force, revision_id)
 
52
 
 
53
def _check_pending_merges(control, force=False):
 
54
    """Check that there are no outstanding pending merges before switching.
 
55
 
 
56
    :param control: ControlDir of the branch to check
 
57
    """
 
58
    try:
 
59
        tree = control.open_workingtree()
 
60
    except errors.NotBranchError, ex:
 
61
        # Lightweight checkout and branch is no longer there
 
62
        if force:
 
63
            return
 
64
        else:
 
65
            raise ex
 
66
    # XXX: Should the tree be locked for get_parent_ids?
 
67
    existing_pending_merges = tree.get_parent_ids()[1:]
 
68
    if len(existing_pending_merges) > 0:
 
69
        raise errors.BzrCommandError(gettext('Pending merges must be '
 
70
            'committed or reverted before using switch.'))
 
71
 
 
72
 
 
73
def _set_branch_location(control, to_branch, force=False):
 
74
    """Set location value of a branch reference.
 
75
 
 
76
    :param control: ControlDir of the checkout to change
 
77
    :param to_branch: branch that the checkout is to reference
 
78
    :param force: skip the check for local commits in a heavy checkout
 
79
    """
 
80
    branch_format = control.find_branch_format()
 
81
    if branch_format.get_reference(control) is not None:
 
82
        # Lightweight checkout: update the branch reference
 
83
        branch_format.set_reference(control, None, to_branch)
 
84
    else:
 
85
        b = control.open_branch()
 
86
        bound_branch = b.get_bound_location()
 
87
        if bound_branch is not None:
 
88
            # Heavyweight checkout: check all local commits
 
89
            # have been pushed to the current bound branch then
 
90
            # synchronise the local branch with the new remote branch
 
91
            # and bind to it
 
92
            possible_transports = []
 
93
            try:
 
94
                if not force and _any_local_commits(b, possible_transports):
 
95
                    raise errors.BzrCommandError(gettext(
 
96
                        'Cannot switch as local commits found in the checkout. '
 
97
                        'Commit these to the bound branch or use --force to '
 
98
                        'throw them away.'))
 
99
            except errors.BoundBranchConnectionFailure, e:
 
100
                raise errors.BzrCommandError(gettext(
 
101
                        'Unable to connect to current master branch %(target)s: '
 
102
                        '%(error)s To switch anyway, use --force.') %
 
103
                        e.__dict__)
 
104
            b.set_bound_location(None)
 
105
            b.pull(to_branch, overwrite=True,
 
106
                possible_transports=possible_transports)
 
107
            b.set_bound_location(to_branch.base)
 
108
            b.set_parent(b.get_master_branch().get_parent())
 
109
        else:
 
110
            # If this is a standalone tree and the new branch
 
111
            # is derived from this one, create a lightweight checkout.
 
112
            graph = b.repository.get_graph(to_branch.repository)
 
113
            if (b.bzrdir._format.colocated_branches and
 
114
                 (force or graph.is_ancestor(b.last_revision(),
 
115
                    to_branch.last_revision()))):
 
116
                b.bzrdir.destroy_branch()
 
117
                b.bzrdir.set_branch_reference(to_branch, name="")
 
118
            else:
 
119
                raise errors.BzrCommandError(gettext('Cannot switch a branch, '
 
120
                    'only a checkout.'))
 
121
 
 
122
 
 
123
def _any_local_commits(this_branch, possible_transports):
 
124
    """Does this branch have any commits not in the master branch?"""
 
125
    last_rev = revision.ensure_null(this_branch.last_revision())
 
126
    if last_rev != revision.NULL_REVISION:
 
127
        other_branch = this_branch.get_master_branch(possible_transports)
 
128
        this_branch.lock_read()
 
129
        other_branch.lock_read()
 
130
        try:
 
131
            other_last_rev = other_branch.last_revision()
 
132
            graph = this_branch.repository.get_graph(
 
133
                other_branch.repository)
 
134
            if not graph.is_ancestor(last_rev, other_last_rev):
 
135
                return True
 
136
        finally:
 
137
            other_branch.unlock()
 
138
            this_branch.unlock()
 
139
    return False
 
140
 
 
141
 
 
142
def _update(tree, source_repository, quiet=False, revision_id=None):
 
143
    """Update a working tree to the latest revision of its branch.
 
144
 
 
145
    :param tree: the working tree
 
146
    :param source_repository: repository holding the revisions
 
147
    """
 
148
    tree.lock_tree_write()
 
149
    try:
 
150
        to_branch = tree.branch
 
151
        if revision_id is None:
 
152
            revision_id = to_branch.last_revision()
 
153
        if tree.last_revision() == revision_id:
 
154
            if not quiet:
 
155
                note(gettext("Tree is up to date at revision %d."), to_branch.revno())
 
156
            return
 
157
        base_tree = source_repository.revision_tree(tree.last_revision())
 
158
        merge.Merge3Merger(tree, tree, base_tree, to_branch.repository.revision_tree(revision_id))
 
159
        tree.set_last_revision(to_branch.last_revision())
 
160
        if not quiet:
 
161
            note(gettext('Updated to revision %d.') % to_branch.revno())
 
162
    finally:
 
163
        tree.unlock()