/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/msgeditor.py

  • Committer: Jelmer Vernooij
  • Date: 2019-02-04 01:01:24 UTC
  • mto: This revision was merged to the branch mainline in revision 7268.
  • Revision ID: jelmer@jelmer.uk-20190204010124-ni0i4qc6f5tnbvux
Fix source tests.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/msgeditor.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
 
18
17
"""Commit message editor support."""
19
18
 
 
19
from __future__ import absolute_import
 
20
 
20
21
import codecs
21
22
import os
22
23
from subprocess import call
23
24
import sys
24
25
 
25
 
from bzrlib import (
 
26
from . import (
 
27
    cmdline,
26
28
    config,
27
29
    osutils,
28
30
    trace,
29
31
    transport,
30
32
    ui,
31
33
    )
32
 
from bzrlib.errors import BzrError, BadCommitMessageEncoding
33
 
from bzrlib.hooks import HookPoint, Hooks
 
34
from .errors import BzrError
 
35
from .hooks import Hooks
 
36
from .sixish import (
 
37
    BytesIO,
 
38
    StringIO,
 
39
    )
 
40
 
 
41
 
 
42
class BadCommitMessageEncoding(BzrError):
 
43
 
 
44
    _fmt = 'The specified commit message contains characters unsupported by '\
 
45
        'the current encoding.'
34
46
 
35
47
 
36
48
def _get_editor():
37
 
    """Return a sequence of possible editor binaries for the current platform"""
 
49
    """Return sequence of possible editor binaries for the current platform"""
38
50
    try:
39
 
        yield os.environ["BZR_EDITOR"], '$BZR_EDITOR'
 
51
        yield os.environ["BRZ_EDITOR"], '$BRZ_EDITOR'
40
52
    except KeyError:
41
53
        pass
42
54
 
43
 
    e = config.GlobalConfig().get_editor()
 
55
    e = config.GlobalStack().get('editor')
44
56
    if e is not None:
45
57
        yield e, config.config_filename()
46
58
 
59
71
def _run_editor(filename):
60
72
    """Try to execute an editor to edit the commit message."""
61
73
    for candidate, candidate_source in _get_editor():
62
 
        edargs = candidate.split(' ')
 
74
        edargs = cmdline.split(candidate)
63
75
        try:
64
 
            ## mutter("trying editor: %r", (edargs +[filename]))
65
76
            x = call(edargs + [filename])
66
 
        except OSError, e:
 
77
        except OSError as e:
67
78
            if candidate_source is not None:
68
79
                # We tried this editor because some user configuration (an
69
80
                # environment variable or config file) said to try it.  Let
80
91
        else:
81
92
            break
82
93
    raise BzrError("Could not start any editor.\nPlease specify one with:\n"
83
 
                   " - $BZR_EDITOR\n - editor=/some/path in %s\n"
84
 
                   " - $VISUAL\n - $EDITOR" % \
85
 
                    config.config_filename())
 
94
                   " - $BRZ_EDITOR\n - editor=/some/path in %s\n"
 
95
                   " - $VISUAL\n - $EDITOR" %
 
96
                   config.config_filename())
86
97
 
87
98
 
88
99
DEFAULT_IGNORE_LINE = "%(bar)s %(msg)s %(bar)s" % \
89
 
    { 'bar' : '-' * 14, 'msg' : 'This line and the following will be ignored' }
 
100
    {'bar': '-' * 14, 'msg': 'This line and the following will be ignored'}
90
101
 
91
102
 
92
103
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE,
109
120
    :return:    commit message or None.
110
121
    """
111
122
 
112
 
    if not start_message is None:
 
123
    if start_message is not None:
113
124
        start_message = start_message.encode(osutils.get_user_encoding())
114
125
    infotext = infotext.encode(osutils.get_user_encoding(), 'replace')
115
126
    return edit_commit_message_encoded(infotext, ignoreline, start_message)
139
150
    msgfilename = None
140
151
    try:
141
152
        msgfilename, hasinfo = _create_temp_file_with_commit_template(
142
 
                                    infotext, ignoreline, start_message)
 
153
            infotext, ignoreline, start_message)
143
154
        if not msgfilename:
144
155
            return None
145
156
        basename = osutils.basename(msgfilename)
146
 
        msg_transport = transport.get_transport(osutils.dirname(msgfilename))
 
157
        msg_transport = transport.get_transport_from_path(
 
158
            osutils.dirname(msgfilename))
147
159
        reference_content = msg_transport.get_bytes(basename)
148
160
        if not _run_editor(msgfilename):
149
161
            return None
150
162
        edited_content = msg_transport.get_bytes(basename)
151
163
        if edited_content == reference_content:
152
 
            if not ui.ui_factory.get_boolean(
153
 
                "Commit message was not edited, use anyway"):
 
164
            if not ui.ui_factory.confirm_action(
 
165
                u"Commit message was not edited, use anyway",
 
166
                "breezy.msgeditor.unchanged",
 
167
                    {}):
154
168
                # Returning "" makes cmd_commit raise 'empty commit message
155
169
                # specified' which is a reasonable error, given the user has
156
170
                # rejected using the unedited template.
158
172
        started = False
159
173
        msg = []
160
174
        lastline, nlines = 0, 0
161
 
        # codecs.open() ALWAYS opens file in binary mode but we need text mode
162
 
        # 'rU' mode useful when bzr.exe used on Cygwin (bialix 20070430)
163
 
        f = file(msgfilename, 'rU')
164
 
        try:
 
175
        with codecs.open(msgfilename, mode='rb', encoding=osutils.get_user_encoding()) as f:
165
176
            try:
166
 
                for line in codecs.getreader(osutils.get_user_encoding())(f):
 
177
                for line in f:
167
178
                    stripped_line = line.strip()
168
179
                    # strip empty line before the log message starts
169
180
                    if not started:
182
193
                    msg.append(line)
183
194
            except UnicodeDecodeError:
184
195
                raise BadCommitMessageEncoding()
185
 
        finally:
186
 
            f.close()
187
196
 
188
197
        if len(msg) == 0:
189
198
            return ""
199
208
        if msgfilename is not None:
200
209
            try:
201
210
                os.unlink(msgfilename)
202
 
            except IOError, e:
 
211
            except IOError as e:
203
212
                trace.warning(
204
213
                    "failed to unlink %s: %s; ignored", msgfilename, e)
205
214
 
206
215
 
207
216
def _create_temp_file_with_commit_template(infotext,
208
217
                                           ignoreline=DEFAULT_IGNORE_LINE,
209
 
                                           start_message=None):
 
218
                                           start_message=None,
 
219
                                           tmpdir=None):
210
220
    """Create temp file and write commit template in it.
211
221
 
212
 
    :param infotext:    Text to be displayed at bottom of message
213
 
                        for the user's reference;
214
 
                        currently similar to 'bzr status'.
215
 
                        The text is already encoded.
 
222
    :param infotext: Text to be displayed at bottom of message for the
 
223
        user's reference; currently similar to 'bzr status'.  The text is
 
224
        already encoded.
216
225
 
217
226
    :param ignoreline:  The separator to use above the infotext.
218
227
 
219
 
    :param start_message:   The text to place above the separator, if any.
220
 
                            This will not be removed from the message
221
 
                            after the user has edited it.
222
 
                            The string is already encoded
 
228
    :param start_message: The text to place above the separator, if any.
 
229
        This will not be removed from the message after the user has edited
 
230
        it.  The string is already encoded
223
231
 
224
232
    :return:    2-tuple (temp file name, hasinfo)
225
233
    """
226
234
    import tempfile
227
235
    tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
228
 
                                               dir='.',
229
 
                                               text=True)
230
 
    msgfilename = osutils.basename(msgfilename)
231
 
    msgfile = os.fdopen(tmp_fileno, 'w')
232
 
    try:
 
236
                                               dir=tmpdir, text=True)
 
237
    with os.fdopen(tmp_fileno, 'wb') as msgfile:
233
238
        if start_message is not None:
234
 
            msgfile.write("%s\n" % start_message)
 
239
            msgfile.write(b"%s\n" % start_message)
235
240
 
236
241
        if infotext is not None and infotext != "":
237
242
            hasinfo = True
238
 
            msgfile.write("\n\n%s\n\n%s" %(ignoreline, infotext))
 
243
            trailer = b"\n\n%s\n\n%s" % (
 
244
                ignoreline.encode(osutils.get_user_encoding()), infotext)
 
245
            msgfile.write(trailer)
239
246
        else:
240
247
            hasinfo = False
241
 
    finally:
242
 
        msgfile.close()
243
248
 
244
249
    return (msgfilename, hasinfo)
245
250
 
254
259
    # TODO: Rather than running the status command, should prepare a draft of
255
260
    # the revision to be committed, then pause and ask the user to
256
261
    # confirm/write a message.
257
 
    from StringIO import StringIO       # must be unicode-safe
258
 
    from bzrlib.status import show_tree_status
 
262
    from .status import show_tree_status
259
263
    status_tmp = StringIO()
260
264
    show_tree_status(working_tree, specific_files=specific_files,
261
265
                     to_file=status_tmp, verbose=True)
273
277
    # TODO: Rather than running the status command, should prepare a draft of
274
278
    # the revision to be committed, then pause and ask the user to
275
279
    # confirm/write a message.
276
 
    from StringIO import StringIO       # must be unicode-safe
277
 
    from bzrlib.diff import show_diff_trees
 
280
    from .diff import show_diff_trees
278
281
 
279
282
    template = make_commit_message_template(working_tree, specific_files)
280
283
    template = template.encode(output_encoding, "replace")
281
284
 
282
285
    if diff:
283
 
        stream = StringIO()
 
286
        stream = BytesIO()
284
287
        show_diff_trees(working_tree.basis_tree(),
285
288
                        working_tree, stream, specific_files,
286
289
                        path_encoding=output_encoding)
287
 
        template = template + '\n' + stream.getvalue()
 
290
        template = template + b'\n' + stream.getvalue()
288
291
 
289
292
    return template
290
293
 
302
305
 
303
306
        These are all empty initially.
304
307
        """
305
 
        Hooks.__init__(self)
306
 
        self.create_hook(HookPoint('commit_message_template',
 
308
        Hooks.__init__(self, "breezy.msgeditor", "hooks")
 
309
        self.add_hook(
 
310
            'set_commit_message',
 
311
            "Set a fixed commit message. "
 
312
            "set_commit_message is called with the "
 
313
            "breezy.commit.Commit object (so you can also change e.g. "
 
314
            "revision properties by editing commit.builder._revprops) and the "
 
315
            "message so far. set_commit_message must return the message to "
 
316
            "use or None if it should use the message editor as normal.",
 
317
            (2, 4))
 
318
        self.add_hook(
 
319
            'commit_message_template',
307
320
            "Called when a commit message is being generated. "
308
 
            "commit_message_template is called with the bzrlib.commit.Commit "
 
321
            "commit_message_template is called with the breezy.commit.Commit "
309
322
            "object and the message that is known so far. "
310
323
            "commit_message_template must return a new message to use (which "
311
 
            "could be the same as it was given. When there are multiple "
 
324
            "could be the same as it was given). When there are multiple "
312
325
            "hooks registered for commit_message_template, they are chained "
313
326
            "with the result from the first passed into the second, and so "
314
 
            "on.", (1, 10), None))
 
327
            "on.", (1, 10))
315
328
 
316
329
 
317
330
hooks = MessageEditorHooks()
318
331
 
319
332
 
 
333
def set_commit_message(commit, start_message=None):
 
334
    """Sets the commit message.
 
335
    :param commit: Commit object for the active commit.
 
336
    :return: The commit message or None to continue using the message editor
 
337
    """
 
338
    start_message = None
 
339
    for hook in hooks['set_commit_message']:
 
340
        start_message = hook(commit, start_message)
 
341
    return start_message
 
342
 
 
343
 
320
344
def generate_commit_message_template(commit, start_message=None):
321
345
    """Generate a commit message template.
322
346