~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/send.py

  • Committer: Patch Queue Manager
  • Date: 2016-04-21 04:10:52 UTC
  • mfrom: (6616.1.1 fix-en-user-guide)
  • Revision ID: pqm@pqm.ubuntu.com-20160421041052-clcye7ns1qcl2n7w
(richard-wilbur) Ensure build of English use guide always uses English text
 even when user's locale specifies a different language. (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 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
import os
 
20
import time
 
21
 
 
22
from bzrlib import (
 
23
    controldir,
 
24
    errors,
 
25
    osutils,
 
26
    registry,
 
27
    trace,
 
28
    )
 
29
from bzrlib.i18n import gettext
 
30
from bzrlib.branch import (
 
31
    Branch,
 
32
    )
 
33
from bzrlib.revision import (
 
34
    NULL_REVISION,
 
35
    )
 
36
 
 
37
 
 
38
format_registry = registry.Registry()
 
39
 
 
40
 
 
41
def send(target_branch, revision, public_branch, remember,
 
42
         format, no_bundle, no_patch, output, from_, mail_to, message, body,
 
43
         to_file, strict=None):
 
44
    possible_transports = []
 
45
    tree, branch = controldir.ControlDir.open_containing_tree_or_branch(
 
46
        from_, possible_transports=possible_transports)[:2]
 
47
    # we may need to write data into branch's repository to calculate
 
48
    # the data to send.
 
49
    branch.lock_write()
 
50
    try:
 
51
        if output is None:
 
52
            config_stack = branch.get_config_stack()
 
53
            if mail_to is None:
 
54
                mail_to = config_stack.get('submit_to')
 
55
            mail_client = config_stack.get('mail_client')(config_stack)
 
56
            if (not getattr(mail_client, 'supports_body', False)
 
57
                and body is not None):
 
58
                raise errors.BzrCommandError(gettext(
 
59
                    'Mail client "%s" does not support specifying body') %
 
60
                    mail_client.__class__.__name__)
 
61
        if remember and target_branch is None:
 
62
            raise errors.BzrCommandError(gettext(
 
63
                '--remember requires a branch to be specified.'))
 
64
        stored_target_branch = branch.get_submit_branch()
 
65
        remembered_target_branch = None
 
66
        if target_branch is None:
 
67
            target_branch = stored_target_branch
 
68
            remembered_target_branch = "submit"
 
69
        else:
 
70
            # Remembers if asked explicitly or no previous location is set
 
71
            if remember or (
 
72
                    remember is None and stored_target_branch is None):
 
73
                branch.set_submit_branch(target_branch)
 
74
        if target_branch is None:
 
75
            target_branch = branch.get_parent()
 
76
            remembered_target_branch = "parent"
 
77
        if target_branch is None:
 
78
            raise errors.BzrCommandError(gettext('No submit branch known or'
 
79
                                         ' specified'))
 
80
        if remembered_target_branch is not None:
 
81
            trace.note(gettext('Using saved {0} location "{1}" to determine '
 
82
                       'what changes to submit.').format(
 
83
                                    remembered_target_branch,
 
84
                                    target_branch))
 
85
 
 
86
        submit_branch = Branch.open(target_branch,
 
87
            possible_transports=possible_transports)
 
88
        possible_transports.append(submit_branch.bzrdir.root_transport)
 
89
        if mail_to is None or format is None:
 
90
            if mail_to is None:
 
91
                mail_to = submit_branch.get_config_stack().get(
 
92
                    'child_submit_to')
 
93
            if format is None:
 
94
                formatname = submit_branch.get_child_submit_format()
 
95
                try:
 
96
                    format = format_registry.get(formatname)
 
97
                except KeyError:
 
98
                    raise errors.BzrCommandError(
 
99
                        gettext("No such send format '%s'.") % formatname)
 
100
 
 
101
        stored_public_branch = branch.get_public_branch()
 
102
        if public_branch is None:
 
103
            public_branch = stored_public_branch
 
104
        # Remembers if asked explicitly or no previous location is set
 
105
        elif (remember
 
106
              or (remember is None and stored_public_branch is None)):
 
107
            branch.set_public_branch(public_branch)
 
108
        if no_bundle and public_branch is None:
 
109
            raise errors.BzrCommandError(gettext('No public branch specified or'
 
110
                                         ' known'))
 
111
        base_revision_id = None
 
112
        revision_id = None
 
113
        if revision is not None:
 
114
            if len(revision) > 2:
 
115
                raise errors.BzrCommandError(gettext('bzr send takes '
 
116
                    'at most two one revision identifiers'))
 
117
            revision_id = revision[-1].as_revision_id(branch)
 
118
            if len(revision) == 2:
 
119
                base_revision_id = revision[0].as_revision_id(branch)
 
120
        if revision_id is None:
 
121
            if tree is not None:
 
122
                tree.check_changed_or_out_of_date(
 
123
                    strict, 'send_strict',
 
124
                    more_error='Use --no-strict to force the send.',
 
125
                    more_warning='Uncommitted changes will not be sent.')
 
126
            revision_id = branch.last_revision()
 
127
        if revision_id == NULL_REVISION:
 
128
            raise errors.BzrCommandError(gettext('No revisions to submit.'))
 
129
        if format is None:
 
130
            format = format_registry.get()
 
131
        directive = format(branch, revision_id, target_branch,
 
132
            public_branch, no_patch, no_bundle, message, base_revision_id,
 
133
            submit_branch)
 
134
        if output is None:
 
135
            directive.compose_merge_request(mail_client, mail_to, body,
 
136
                                            branch, tree)
 
137
        else:
 
138
            if directive.multiple_output_files:
 
139
                if output == '-':
 
140
                    raise errors.BzrCommandError(gettext('- not supported for '
 
141
                        'merge directives that use more than one output file.'))
 
142
                if not os.path.exists(output):
 
143
                    os.mkdir(output, 0755)
 
144
                for (filename, lines) in directive.to_files():
 
145
                    path = os.path.join(output, filename)
 
146
                    outfile = open(path, 'wb')
 
147
                    try:
 
148
                        outfile.writelines(lines)
 
149
                    finally:
 
150
                        outfile.close()
 
151
            else:
 
152
                if output == '-':
 
153
                    outfile = to_file
 
154
                else:
 
155
                    outfile = open(output, 'wb')
 
156
                try:
 
157
                    outfile.writelines(directive.to_lines())
 
158
                finally:
 
159
                    if outfile is not to_file:
 
160
                        outfile.close()
 
161
    finally:
 
162
        branch.unlock()
 
163
 
 
164
 
 
165
def _send_4(branch, revision_id, target_branch, public_branch,
 
166
            no_patch, no_bundle, message,
 
167
            base_revision_id, local_target_branch=None):
 
168
    from bzrlib import merge_directive
 
169
    return merge_directive.MergeDirective2.from_objects(
 
170
        branch.repository, revision_id, time.time(),
 
171
        osutils.local_time_offset(), target_branch,
 
172
        public_branch=public_branch,
 
173
        include_patch=not no_patch,
 
174
        include_bundle=not no_bundle, message=message,
 
175
        base_revision_id=base_revision_id,
 
176
        local_target_branch=local_target_branch)
 
177
 
 
178
 
 
179
def _send_0_9(branch, revision_id, submit_branch, public_branch,
 
180
              no_patch, no_bundle, message,
 
181
              base_revision_id, local_target_branch=None):
 
182
    if not no_bundle:
 
183
        if not no_patch:
 
184
            patch_type = 'bundle'
 
185
        else:
 
186
            raise errors.BzrCommandError(gettext('Format 0.9 does not'
 
187
                ' permit bundle with no patch'))
 
188
    else:
 
189
        if not no_patch:
 
190
            patch_type = 'diff'
 
191
        else:
 
192
            patch_type = None
 
193
    from bzrlib import merge_directive
 
194
    return merge_directive.MergeDirective.from_objects(
 
195
        branch.repository, revision_id, time.time(),
 
196
        osutils.local_time_offset(), submit_branch,
 
197
        public_branch=public_branch, patch_type=patch_type,
 
198
        message=message, local_target_branch=local_target_branch)
 
199
 
 
200
 
 
201
format_registry.register('4',
 
202
    _send_4, 'Bundle format 4, Merge Directive 2 (default)')
 
203
format_registry.register('0.9',
 
204
    _send_0_9, 'Bundle format 0.9, Merge Directive 1')
 
205
format_registry.default_key = '4'