/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: 2020-04-05 19:11:34 UTC
  • mto: (7490.7.16 work)
  • mto: This revision was merged to the branch mainline in revision 7501.
  • Revision ID: jelmer@jelmer.uk-20200405191134-0aebh8ikiwygxma5
Populate the .gitignore file.

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