~bzr-pqm/bzr/bzr.dev

5017.2.4 by Martin Pool
Move or remove some unconditionally loaded code
1
# Copyright (C) 2009, 2010 Canonical Ltd
4367.1.2 by Jelmer Vernooij
Move send command to a separate file, move send format registry out of cmd_send.
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
5086.3.3 by Jelmer Vernooij
Allow merge directives to output multiple patch files.
18
import os
4367.1.2 by Jelmer Vernooij
Move send command to a separate file, move send format registry out of cmd_send.
19
import time
20
21
from bzrlib import (
6207.3.3 by jelmer at samba
Fix tests and the like.
22
    controldir,
4367.1.2 by Jelmer Vernooij
Move send command to a separate file, move send format registry out of cmd_send.
23
    errors,
24
    osutils,
25
    registry,
26
    trace,
27
    )
6138.3.5 by Jonathan Riddell
make the test suite pass
28
from bzrlib.i18n import gettext
4367.1.3 by Jelmer Vernooij
Move cmd_{send,bundle_revisions} back to bzrlib.builtins per Ians request.
29
from bzrlib.branch import (
30
    Branch,
31
    )
32
from bzrlib.revision import (
33
    NULL_REVISION,
34
    )
4367.1.2 by Jelmer Vernooij
Move send command to a separate file, move send format registry out of cmd_send.
35
36
37
format_registry = registry.Registry()
38
39
4367.1.3 by Jelmer Vernooij
Move cmd_{send,bundle_revisions} back to bzrlib.builtins per Ians request.
40
def send(submit_branch, revision, public_branch, remember, format,
4464.3.4 by Vincent Ladeuil
Fix bug #206577 by adding a --strict option to send.
41
         no_bundle, no_patch, output, from_, mail_to, message, body,
42
         to_file, strict=None):
6207.3.3 by jelmer at samba
Fix tests and the like.
43
    tree, branch = controldir.ControlDir.open_containing_tree_or_branch(
44
        from_)[:2]
4367.1.3 by Jelmer Vernooij
Move cmd_{send,bundle_revisions} back to bzrlib.builtins per Ians request.
45
    # we may need to write data into branch's repository to calculate
46
    # the data to send.
47
    branch.lock_write()
48
    try:
49
        if output is None:
50
            config = branch.get_config()
51
            if mail_to is None:
52
                mail_to = config.get_user_option('submit_to')
53
            mail_client = config.get_mail_client()
54
            if (not getattr(mail_client, 'supports_body', False)
55
                and body is not None):
6138.3.7 by Jonathan Riddell
add gettext() to BzrCommandError uses
56
                raise errors.BzrCommandError(gettext(
57
                    'Mail client "%s" does not support specifying body') %
4367.1.3 by Jelmer Vernooij
Move cmd_{send,bundle_revisions} back to bzrlib.builtins per Ians request.
58
                    mail_client.__class__.__name__)
59
        if remember and submit_branch is None:
6138.3.7 by Jonathan Riddell
add gettext() to BzrCommandError uses
60
            raise errors.BzrCommandError(gettext(
61
                '--remember requires a branch to be specified.'))
4367.1.3 by Jelmer Vernooij
Move cmd_{send,bundle_revisions} back to bzrlib.builtins per Ians request.
62
        stored_submit_branch = branch.get_submit_branch()
63
        remembered_submit_branch = None
64
        if submit_branch is None:
65
            submit_branch = stored_submit_branch
66
            remembered_submit_branch = "submit"
67
        else:
5861.1.4 by Vincent Ladeuil
Fix send --no-remember when no location is set.
68
            # Remembers if asked explicitly or no previous location is set
69
            if remember or (remember is None and stored_submit_branch is None):
4367.1.3 by Jelmer Vernooij
Move cmd_{send,bundle_revisions} back to bzrlib.builtins per Ians request.
70
                branch.set_submit_branch(submit_branch)
71
        if submit_branch is None:
72
            submit_branch = branch.get_parent()
73
            remembered_submit_branch = "parent"
74
        if submit_branch is None:
6138.3.7 by Jonathan Riddell
add gettext() to BzrCommandError uses
75
            raise errors.BzrCommandError(gettext('No submit branch known or'
76
                                         ' specified'))
4367.1.3 by Jelmer Vernooij
Move cmd_{send,bundle_revisions} back to bzrlib.builtins per Ians request.
77
        if remembered_submit_branch is not None:
6147.1.1 by Jonathan Riddell
use .format() instead of % for string formatting where there are multiple formats in one string to allow for translations
78
            trace.note(gettext('Using saved {0} location "{1}" to determine '
79
                       'what changes to submit.').format(
80
                                    remembered_submit_branch, submit_branch))
4367.1.3 by Jelmer Vernooij
Move cmd_{send,bundle_revisions} back to bzrlib.builtins per Ians request.
81
4367.1.5 by Jelmer Vernooij
merge bzr.dev.
82
        if mail_to is None or format is None:
4543.2.1 by John Arbash Meinel
Fix some comments in the send code.
83
            # TODO: jam 20090716 we open the submit_branch here, but we *don't*
84
            #       pass it down into the format creation, so it will have to
85
            #       open it again
4367.1.5 by Jelmer Vernooij
merge bzr.dev.
86
            submit_br = Branch.open(submit_branch)
87
            submit_config = submit_br.get_config()
88
            if mail_to is None:
89
                mail_to = submit_config.get_user_option("child_submit_to")
90
            if format is None:
91
                formatname = submit_br.get_child_submit_format()
92
                try:
93
                    format = format_registry.get(formatname)
94
                except KeyError:
6138.3.7 by Jonathan Riddell
add gettext() to BzrCommandError uses
95
                    raise errors.BzrCommandError(gettext("No such send format '%s'.") % 
4367.1.5 by Jelmer Vernooij
merge bzr.dev.
96
                                                 formatname)
4367.1.3 by Jelmer Vernooij
Move cmd_{send,bundle_revisions} back to bzrlib.builtins per Ians request.
97
98
        stored_public_branch = branch.get_public_branch()
99
        if public_branch is None:
100
            public_branch = stored_public_branch
5861.1.4 by Vincent Ladeuil
Fix send --no-remember when no location is set.
101
        # Remembers if asked explicitly or no previous location is set
102
        elif (remember
103
              or (remember is None and stored_public_branch is None)):
4367.1.3 by Jelmer Vernooij
Move cmd_{send,bundle_revisions} back to bzrlib.builtins per Ians request.
104
            branch.set_public_branch(public_branch)
105
        if no_bundle and public_branch is None:
6138.3.7 by Jonathan Riddell
add gettext() to BzrCommandError uses
106
            raise errors.BzrCommandError(gettext('No public branch specified or'
107
                                         ' known'))
4367.1.3 by Jelmer Vernooij
Move cmd_{send,bundle_revisions} back to bzrlib.builtins per Ians request.
108
        base_revision_id = None
109
        revision_id = None
110
        if revision is not None:
111
            if len(revision) > 2:
6138.3.7 by Jonathan Riddell
add gettext() to BzrCommandError uses
112
                raise errors.BzrCommandError(gettext('bzr send takes '
113
                    'at most two one revision identifiers'))
4367.1.3 by Jelmer Vernooij
Move cmd_{send,bundle_revisions} back to bzrlib.builtins per Ians request.
114
            revision_id = revision[-1].as_revision_id(branch)
115
            if len(revision) == 2:
116
                base_revision_id = revision[0].as_revision_id(branch)
117
        if revision_id is None:
5147.2.2 by Vincent Ladeuil
Fix bug #519319 by defaulting to a warning for dirty trees.
118
            if tree is not None:
5171.2.2 by Vincent Ladeuil
Explain that the uncommitted changes are not processed when
119
                tree.check_changed_or_out_of_date(
120
                    strict, 'send_strict',
121
                    more_error='Use --no-strict to force the send.',
122
                    more_warning='Uncommitted changes will not be sent.')
4367.1.3 by Jelmer Vernooij
Move cmd_{send,bundle_revisions} back to bzrlib.builtins per Ians request.
123
            revision_id = branch.last_revision()
124
        if revision_id == NULL_REVISION:
6138.3.7 by Jonathan Riddell
add gettext() to BzrCommandError uses
125
            raise errors.BzrCommandError(gettext('No revisions to submit.'))
4367.1.3 by Jelmer Vernooij
Move cmd_{send,bundle_revisions} back to bzrlib.builtins per Ians request.
126
        if format is None:
127
            format = format_registry.get()
4464.3.11 by Vincent Ladeuil
Add a check for tree/branch sync and tweak help.
128
        directive = format(branch, revision_id, submit_branch,
4367.1.3 by Jelmer Vernooij
Move cmd_{send,bundle_revisions} back to bzrlib.builtins per Ians request.
129
            public_branch, no_patch, no_bundle, message, base_revision_id)
4367.1.2 by Jelmer Vernooij
Move send command to a separate file, move send format registry out of cmd_send.
130
        if output is None:
4367.1.3 by Jelmer Vernooij
Move cmd_{send,bundle_revisions} back to bzrlib.builtins per Ians request.
131
            directive.compose_merge_request(mail_client, mail_to, body,
132
                                            branch, tree)
133
        else:
5086.3.3 by Jelmer Vernooij
Allow merge directives to output multiple patch files.
134
            if directive.multiple_output_files:
135
                if output == '-':
6138.3.7 by Jonathan Riddell
add gettext() to BzrCommandError uses
136
                    raise errors.BzrCommandError(gettext('- not supported for '
137
                        'merge directives that use more than one output file.'))
5086.3.3 by Jelmer Vernooij
Allow merge directives to output multiple patch files.
138
                if not os.path.exists(output):
139
                    os.mkdir(output, 0755)
140
                for (filename, lines) in directive.to_files():
141
                    path = os.path.join(output, filename)
142
                    outfile = open(path, 'wb')
143
                    try:
144
                        outfile.writelines(lines)
145
                    finally:
146
                        outfile.close()
4367.1.3 by Jelmer Vernooij
Move cmd_{send,bundle_revisions} back to bzrlib.builtins per Ians request.
147
            else:
5086.3.3 by Jelmer Vernooij
Allow merge directives to output multiple patch files.
148
                if output == '-':
149
                    outfile = to_file
150
                else:
151
                    outfile = open(output, 'wb')
152
                try:
153
                    outfile.writelines(directive.to_lines())
154
                finally:
155
                    if outfile is not to_file:
156
                        outfile.close()
4367.1.3 by Jelmer Vernooij
Move cmd_{send,bundle_revisions} back to bzrlib.builtins per Ians request.
157
    finally:
158
        branch.unlock()
4367.1.2 by Jelmer Vernooij
Move send command to a separate file, move send format registry out of cmd_send.
159
160
161
def _send_4(branch, revision_id, submit_branch, public_branch,
162
            no_patch, no_bundle, message, base_revision_id):
5017.2.4 by Martin Pool
Move or remove some unconditionally loaded code
163
    from bzrlib import merge_directive
4367.1.2 by Jelmer Vernooij
Move send command to a separate file, move send format registry out of cmd_send.
164
    return merge_directive.MergeDirective2.from_objects(
165
        branch.repository, revision_id, time.time(),
166
        osutils.local_time_offset(), submit_branch,
167
        public_branch=public_branch, include_patch=not no_patch,
168
        include_bundle=not no_bundle, message=message,
169
        base_revision_id=base_revision_id)
170
171
172
def _send_0_9(branch, revision_id, submit_branch, public_branch,
173
              no_patch, no_bundle, message, base_revision_id):
174
    if not no_bundle:
175
        if not no_patch:
176
            patch_type = 'bundle'
177
        else:
6138.3.7 by Jonathan Riddell
add gettext() to BzrCommandError uses
178
            raise errors.BzrCommandError(gettext('Format 0.9 does not'
179
                ' permit bundle with no patch'))
4367.1.2 by Jelmer Vernooij
Move send command to a separate file, move send format registry out of cmd_send.
180
    else:
181
        if not no_patch:
182
            patch_type = 'diff'
183
        else:
184
            patch_type = None
5017.2.4 by Martin Pool
Move or remove some unconditionally loaded code
185
    from bzrlib import merge_directive
4367.1.2 by Jelmer Vernooij
Move send command to a separate file, move send format registry out of cmd_send.
186
    return merge_directive.MergeDirective.from_objects(
187
        branch.repository, revision_id, time.time(),
188
        osutils.local_time_offset(), submit_branch,
189
        public_branch=public_branch, patch_type=patch_type,
190
        message=message)
191
192
193
format_registry.register('4', 
194
    _send_4, 'Bundle format 4, Merge Directive 2 (default)')
195
format_registry.register('0.9',
196
    _send_0_9, 'Bundle format 0.9, Merge Directive 1')
197
format_registry.default_key = '4'