← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/switch.py

  • Committer: Jelmer Vernooij
  • Date: 2012-02-07 00:49:58 UTC
  • mto: This revision was merged to the branch mainline in revision 6465.
  • Revision ID: jelmer@samba.org-20120207004958-rdtzmipi10p1oq97
Migrate 'bugtracker' setting to config stacks.

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