~bzr-pqm/bzr/bzr.dev

3221.19.1 by Ian Clatworthy
refactor cmd_push to use a helper function
1
# Copyright (C) 2008 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
4183.7.1 by Sabin Iacob
update FSF mailing address
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
3221.19.1 by Ian Clatworthy
refactor cmd_push to use a helper function
16
17
"""UI helper for the push command."""
18
3978.3.13 by Jelmer Vernooij
Store the pushed branches' URL rather than the URL of the branch itself.
19
from bzrlib import (
20
    builtins,
21
    branch,
22
    bzrdir,
23
    errors,
24
    revision as _mod_revision,
25
    transport,
26
    )
27
from bzrlib.trace import (
28
    note,
29
    warning,
30
    )
3221.19.1 by Ian Clatworthy
refactor cmd_push to use a helper function
31
32
4053.3.2 by Jelmer Vernooij
Use PushResult in push.py.
33
class PushResult(object):
34
    """Result of a push operation.
35
36
    :ivar branch_push_result: Result of a push between branches
3978.3.11 by Jelmer Vernooij
Move InterBranchBzrDir to bzrlib.push.
37
    :ivar target_branch: The target branch
4053.3.2 by Jelmer Vernooij
Use PushResult in push.py.
38
    :ivar stacked_on: URL of the branch on which the result is stacked
3978.3.11 by Jelmer Vernooij
Move InterBranchBzrDir to bzrlib.push.
39
    :ivar workingtree_updated: Whether or not the target workingtree was updated.
4053.3.2 by Jelmer Vernooij
Use PushResult in push.py.
40
    """
41
42
    def __init__(self):
43
        self.branch_push_result = None
44
        self.stacked_on = None
3978.3.11 by Jelmer Vernooij
Move InterBranchBzrDir to bzrlib.push.
45
        self.workingtree_updated = None
46
        self.target_branch = None
4053.3.2 by Jelmer Vernooij
Use PushResult in push.py.
47
48
    def report(self, to_file):
49
        """Write a human-readable description of the result."""
50
        if self.branch_push_result is None:
51
            if self.stacked_on is not None:
52
                note('Created new stacked branch referring to %s.' %
53
                    self.stacked_on)
54
            else:
55
                note('Created new branch.')
56
        else:
57
            self.branch_push_result.report(to_file)
58
59
3221.19.1 by Ian Clatworthy
refactor cmd_push to use a helper function
60
def _show_push_branch(br_from, revision_id, location, to_file, verbose=False,
3549.1.1 by Martin Pool
rename push --reference to --stacked-on
61
    overwrite=False, remember=False, stacked_on=None, create_prefix=False,
3221.19.1 by Ian Clatworthy
refactor cmd_push to use a helper function
62
    use_existing_dir=False):
63
    """Push a branch to a location.
64
65
    :param br_from: the source branch
66
    :param revision_id: the revision-id to push up to
67
    :param location: the url of the destination
68
    :param to_file: the output stream
69
    :param verbose: if True, display more output than normal
70
    :param overwrite: if False, a current branch at the destination may not
71
        have diverged from the source, otherwise the push fails
72
    :param remember: if True, store the location as the push location for
73
        the source branch
3549.1.1 by Martin Pool
rename push --reference to --stacked-on
74
    :param stacked_on: the url of the branch, if any, to stack on;
3221.19.1 by Ian Clatworthy
refactor cmd_push to use a helper function
75
        if set, only the revisions not in that branch are pushed
76
    :param create_prefix: if True, create the necessary parent directories
77
        at the destination if they don't already exist
78
    :param use_existing_dir: if True, proceed even if the destination
79
        directory exists without a current .bzr directory in it
80
    """
81
    to_transport = transport.get_transport(location)
82
    try:
83
        dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
84
    except errors.NotBranchError:
4294.2.1 by Robert Collins
Move directory checking for bzr push options into Branch.create_clone_on_transport.
85
        # Didn't find anything
86
        dir_to = None
3221.19.1 by Ian Clatworthy
refactor cmd_push to use a helper function
87
88
    if dir_to is None:
4294.2.6 by Robert Collins
Report errors back in the UI layer for push, to use the url the user gave us.
89
        try:
90
            br_to = br_from.create_clone_on_transport(to_transport,
91
                revision_id=revision_id, stacked_on=stacked_on,
92
                create_prefix=create_prefix, use_existing_dir=use_existing_dir)
93
        except errors.FileExists:
94
            if not use_existing_dir:
95
                raise errors.BzrCommandError("Target directory %s"
96
                     " already exists, but does not have a valid .bzr"
97
                     " directory. Supply --use-existing-dir to push"
98
                     " there anyway." % location)
99
        except errors.NoSuchFile:
100
            if not create_prefix:
101
                raise errors.BzrCommandError("Parent directory of %s"
102
                    " does not exist."
103
                    "\nYou may supply --create-prefix to create all"
104
                    " leading parent directories."
105
                    % location)
106
        except errors.TooManyRedirections:
107
            raise errors.BzrCommandError("Too many redirections trying "
108
                                         "to make %s." % location)
4294.2.1 by Robert Collins
Move directory checking for bzr push options into Branch.create_clone_on_transport.
109
        push_result = PushResult()
3221.19.1 by Ian Clatworthy
refactor cmd_push to use a helper function
110
        # TODO: Some more useful message about what was copied
3650.5.2 by Aaron Bentley
Always show stacked message if stacking done.
111
        try:
3978.3.3 by Jelmer Vernooij
Use PushResult everywhere.
112
            push_result.stacked_on = br_to.get_stacked_on_url()
3650.5.2 by Aaron Bentley
Always show stacked message if stacking done.
113
        except (errors.UnstackableBranchFormat,
114
                errors.UnstackableRepositoryFormat,
115
                errors.NotStacked):
3978.3.3 by Jelmer Vernooij
Use PushResult everywhere.
116
            push_result.stacked_on = None
3978.3.11 by Jelmer Vernooij
Move InterBranchBzrDir to bzrlib.push.
117
        push_result.target_branch = br_to
3978.3.13 by Jelmer Vernooij
Store the pushed branches' URL rather than the URL of the branch itself.
118
        push_result.old_revid = _mod_revision.NULL_REVISION
119
        push_result.old_revno = 0
3978.3.4 by Jelmer Vernooij
Fix remaining tests; set push location of source branch, not target branch.
120
        if br_from.get_push_location() is None or remember:
3978.3.13 by Jelmer Vernooij
Store the pushed branches' URL rather than the URL of the branch itself.
121
            br_from.set_push_location(br_to.base)
3978.3.2 by Jelmer Vernooij
Move most of push to IterGenericBranchBzrDir.
122
    else:
3549.1.1 by Martin Pool
rename push --reference to --stacked-on
123
        if stacked_on is not None:
3221.19.4 by Ian Clatworthy
shallow -> stacked
124
            warning("Ignoring request for a stacked branch as repository "
3221.19.2 by Ian Clatworthy
tweaks to ui during review by igc
125
                    "already exists at the destination location.")
3221.19.1 by Ian Clatworthy
refactor cmd_push to use a helper function
126
        try:
3978.3.15 by Jelmer Vernooij
Rename BzrDir.push() to BzrDir.push_branch().
127
            push_result = dir_to.push_branch(br_from, revision_id, overwrite, 
4416.8.1 by Jelmer Vernooij
Pass create_prefix paremeter to BzrDir.push_branch.
128
                remember, create_prefix)
3221.19.1 by Ian Clatworthy
refactor cmd_push to use a helper function
129
        except errors.DivergedBranches:
130
            raise errors.BzrCommandError('These branches have diverged.'
4416.4.1 by Neil Martinsen-Burrell
Fix 269477 Add documentation about diverged branches and refer to it when pushing fails
131
                                    '  See "bzr help diverged-branches"'
132
                                    ' for more information.')
3978.3.13 by Jelmer Vernooij
Store the pushed branches' URL rather than the URL of the branch itself.
133
        except errors.NoRepositoryPresent:
134
            # we have a bzrdir but no branch or repository
135
            # XXX: Figure out what to do other than complain.
136
            raise errors.BzrCommandError("At %s you have a valid .bzr"
137
                " control directory, but not a branch or repository. This"
138
                " is an unsupported configuration. Please move the target"
139
                " directory out of the way and try again." % location)
3978.3.11 by Jelmer Vernooij
Move InterBranchBzrDir to bzrlib.push.
140
        if push_result.workingtree_updated == False:
3978.3.2 by Jelmer Vernooij
Move most of push to IterGenericBranchBzrDir.
141
            warning("This transport does not update the working " 
142
                    "tree of: %s. See 'bzr help working-trees' for "
143
                    "more information." % push_result.target_branch.base)
3978.3.3 by Jelmer Vernooij
Use PushResult everywhere.
144
    push_result.report(to_file)
3848.1.19 by Aaron Bentley
Show log for non-initial push -v
145
    if verbose:
3978.3.11 by Jelmer Vernooij
Move InterBranchBzrDir to bzrlib.push.
146
        br_to = push_result.target_branch
3848.1.18 by Aaron Bentley
Update push to use show_branch_change
147
        br_to.lock_read()
148
        try:
149
            from bzrlib.log import show_branch_change
3978.3.13 by Jelmer Vernooij
Store the pushed branches' URL rather than the URL of the branch itself.
150
            show_branch_change(br_to, to_file, push_result.old_revno, 
151
                               push_result.old_revid)
3848.1.18 by Aaron Bentley
Update push to use show_branch_change
152
        finally:
153
            br_to.unlock()
3978.3.11 by Jelmer Vernooij
Move InterBranchBzrDir to bzrlib.push.
154
155