/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-2011 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
"""Commit message editor support."""
 
18
 
 
19
from __future__ import absolute_import
 
20
 
 
21
import codecs
 
22
import os
 
23
from subprocess import call
 
24
import sys
 
25
 
 
26
from . import (
 
27
    cmdline,
 
28
    config,
 
29
    osutils,
 
30
    trace,
 
31
    transport,
 
32
    ui,
 
33
    )
 
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.'
 
46
 
 
47
 
 
48
def _get_editor():
 
49
    """Return sequence of possible editor binaries for the current platform"""
 
50
    try:
 
51
        yield os.environ["BRZ_EDITOR"], '$BRZ_EDITOR'
 
52
    except KeyError:
 
53
        pass
 
54
 
 
55
    e = config.GlobalStack().get('editor')
 
56
    if e is not None:
 
57
        yield e, config.config_filename()
 
58
 
 
59
    for varname in 'VISUAL', 'EDITOR':
 
60
        if varname in os.environ:
 
61
            yield os.environ[varname], '$' + varname
 
62
 
 
63
    if sys.platform == 'win32':
 
64
        for editor in 'wordpad.exe', 'notepad.exe':
 
65
            yield editor, None
 
66
    else:
 
67
        for editor in ['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe']:
 
68
            yield editor, None
 
69
 
 
70
 
 
71
def _run_editor(filename):
 
72
    """Try to execute an editor to edit the commit message."""
 
73
    for candidate, candidate_source in _get_editor():
 
74
        edargs = cmdline.split(candidate)
 
75
        try:
 
76
            x = call(edargs + [filename])
 
77
        except OSError as e:
 
78
            if candidate_source is not None:
 
79
                # We tried this editor because some user configuration (an
 
80
                # environment variable or config file) said to try it.  Let
 
81
                # the user know their configuration is broken.
 
82
                trace.warning(
 
83
                    'Could not start editor "%s" (specified by %s): %s\n'
 
84
                    % (candidate, candidate_source, str(e)))
 
85
            continue
 
86
            raise
 
87
        if x == 0:
 
88
            return True
 
89
        elif x == 127:
 
90
            continue
 
91
        else:
 
92
            break
 
93
    raise BzrError("Could not start any editor.\nPlease specify one with:\n"
 
94
                   " - $BRZ_EDITOR\n - editor=/some/path in %s\n"
 
95
                   " - $VISUAL\n - $EDITOR" %
 
96
                   config.config_filename())
 
97
 
 
98
 
 
99
DEFAULT_IGNORE_LINE = "%(bar)s %(msg)s %(bar)s" % \
 
100
    {'bar': '-' * 14, 'msg': 'This line and the following will be ignored'}
 
101
 
 
102
 
 
103
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE,
 
104
                        start_message=None):
 
105
    """Let the user edit a commit message in a temp file.
 
106
 
 
107
    This is run if they don't give a message or
 
108
    message-containing file on the command line.
 
109
 
 
110
    :param infotext:    Text to be displayed at bottom of message
 
111
                        for the user's reference;
 
112
                        currently similar to 'bzr status'.
 
113
 
 
114
    :param ignoreline:  The separator to use above the infotext.
 
115
 
 
116
    :param start_message:   The text to place above the separator, if any.
 
117
                            This will not be removed from the message
 
118
                            after the user has edited it.
 
119
 
 
120
    :return:    commit message or None.
 
121
    """
 
122
 
 
123
    if start_message is not None:
 
124
        start_message = start_message.encode(osutils.get_user_encoding())
 
125
    infotext = infotext.encode(osutils.get_user_encoding(), 'replace')
 
126
    return edit_commit_message_encoded(infotext, ignoreline, start_message)
 
127
 
 
128
 
 
129
def edit_commit_message_encoded(infotext, ignoreline=DEFAULT_IGNORE_LINE,
 
130
                                start_message=None):
 
131
    """Let the user edit a commit message in a temp file.
 
132
 
 
133
    This is run if they don't give a message or
 
134
    message-containing file on the command line.
 
135
 
 
136
    :param infotext:    Text to be displayed at bottom of message
 
137
                        for the user's reference;
 
138
                        currently similar to 'bzr status'.
 
139
                        The string is already encoded
 
140
 
 
141
    :param ignoreline:  The separator to use above the infotext.
 
142
 
 
143
    :param start_message:   The text to place above the separator, if any.
 
144
                            This will not be removed from the message
 
145
                            after the user has edited it.
 
146
                            The string is already encoded
 
147
 
 
148
    :return:    commit message or None.
 
149
    """
 
150
    msgfilename = None
 
151
    try:
 
152
        msgfilename, hasinfo = _create_temp_file_with_commit_template(
 
153
            infotext, ignoreline, start_message)
 
154
        if not msgfilename:
 
155
            return None
 
156
        basename = osutils.basename(msgfilename)
 
157
        msg_transport = transport.get_transport_from_path(
 
158
            osutils.dirname(msgfilename))
 
159
        reference_content = msg_transport.get_bytes(basename)
 
160
        if not _run_editor(msgfilename):
 
161
            return None
 
162
        edited_content = msg_transport.get_bytes(basename)
 
163
        if edited_content == reference_content:
 
164
            if not ui.ui_factory.confirm_action(
 
165
                u"Commit message was not edited, use anyway",
 
166
                "breezy.msgeditor.unchanged",
 
167
                    {}):
 
168
                # Returning "" makes cmd_commit raise 'empty commit message
 
169
                # specified' which is a reasonable error, given the user has
 
170
                # rejected using the unedited template.
 
171
                return ""
 
172
        started = False
 
173
        msg = []
 
174
        lastline, nlines = 0, 0
 
175
        with codecs.open(msgfilename, mode='rb', encoding=osutils.get_user_encoding()) as f:
 
176
            try:
 
177
                for line in f:
 
178
                    stripped_line = line.strip()
 
179
                    # strip empty line before the log message starts
 
180
                    if not started:
 
181
                        if stripped_line != "":
 
182
                            started = True
 
183
                        else:
 
184
                            continue
 
185
                    # check for the ignore line only if there
 
186
                    # is additional information at the end
 
187
                    if hasinfo and stripped_line == ignoreline:
 
188
                        break
 
189
                    nlines += 1
 
190
                    # keep track of the last line that had some content
 
191
                    if stripped_line != "":
 
192
                        lastline = nlines
 
193
                    msg.append(line)
 
194
            except UnicodeDecodeError:
 
195
                raise BadCommitMessageEncoding()
 
196
 
 
197
        if len(msg) == 0:
 
198
            return ""
 
199
        # delete empty lines at the end
 
200
        del msg[lastline:]
 
201
        # add a newline at the end, if needed
 
202
        if not msg[-1].endswith("\n"):
 
203
            return "%s%s" % ("".join(msg), "\n")
 
204
        else:
 
205
            return "".join(msg)
 
206
    finally:
 
207
        # delete the msg file in any case
 
208
        if msgfilename is not None:
 
209
            try:
 
210
                os.unlink(msgfilename)
 
211
            except IOError as e:
 
212
                trace.warning(
 
213
                    "failed to unlink %s: %s; ignored", msgfilename, e)
 
214
 
 
215
 
 
216
def _create_temp_file_with_commit_template(infotext,
 
217
                                           ignoreline=DEFAULT_IGNORE_LINE,
 
218
                                           start_message=None,
 
219
                                           tmpdir=None):
 
220
    """Create temp file and write commit template in it.
 
221
 
 
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.
 
225
 
 
226
    :param ignoreline:  The separator to use above the infotext.
 
227
 
 
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
 
231
 
 
232
    :return:    2-tuple (temp file name, hasinfo)
 
233
    """
 
234
    import tempfile
 
235
    tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
 
236
                                               dir=tmpdir, text=True)
 
237
    with os.fdopen(tmp_fileno, 'wb') as msgfile:
 
238
        if start_message is not None:
 
239
            msgfile.write(b"%s\n" % start_message)
 
240
 
 
241
        if infotext is not None and infotext != "":
 
242
            hasinfo = True
 
243
            trailer = b"\n\n%s\n\n%s" % (
 
244
                ignoreline.encode(osutils.get_user_encoding()), infotext)
 
245
            msgfile.write(trailer)
 
246
        else:
 
247
            hasinfo = False
 
248
 
 
249
    return (msgfilename, hasinfo)
 
250
 
 
251
 
 
252
def make_commit_message_template(working_tree, specific_files):
 
253
    """Prepare a template file for a commit into a branch.
 
254
 
 
255
    Returns a unicode string containing the template.
 
256
    """
 
257
    # TODO: make provision for this to be overridden or modified by a hook
 
258
    #
 
259
    # TODO: Rather than running the status command, should prepare a draft of
 
260
    # the revision to be committed, then pause and ask the user to
 
261
    # confirm/write a message.
 
262
    from .status import show_tree_status
 
263
    status_tmp = StringIO()
 
264
    show_tree_status(working_tree, specific_files=specific_files,
 
265
                     to_file=status_tmp, verbose=True)
 
266
    return status_tmp.getvalue()
 
267
 
 
268
 
 
269
def make_commit_message_template_encoded(working_tree, specific_files,
 
270
                                         diff=None, output_encoding='utf-8'):
 
271
    """Prepare a template file for a commit into a branch.
 
272
 
 
273
    Returns an encoded string.
 
274
    """
 
275
    # TODO: make provision for this to be overridden or modified by a hook
 
276
    #
 
277
    # TODO: Rather than running the status command, should prepare a draft of
 
278
    # the revision to be committed, then pause and ask the user to
 
279
    # confirm/write a message.
 
280
    from .diff import show_diff_trees
 
281
 
 
282
    template = make_commit_message_template(working_tree, specific_files)
 
283
    template = template.encode(output_encoding, "replace")
 
284
 
 
285
    if diff:
 
286
        stream = BytesIO()
 
287
        show_diff_trees(working_tree.basis_tree(),
 
288
                        working_tree, stream, specific_files,
 
289
                        path_encoding=output_encoding)
 
290
        template = template + b'\n' + stream.getvalue()
 
291
 
 
292
    return template
 
293
 
 
294
 
 
295
class MessageEditorHooks(Hooks):
 
296
    """A dictionary mapping hook name to a list of callables for message editor
 
297
    hooks.
 
298
 
 
299
    e.g. ['commit_message_template'] is the list of items to be called to
 
300
    generate a commit message template
 
301
    """
 
302
 
 
303
    def __init__(self):
 
304
        """Create the default hooks.
 
305
 
 
306
        These are all empty initially.
 
307
        """
 
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',
 
320
            "Called when a commit message is being generated. "
 
321
            "commit_message_template is called with the breezy.commit.Commit "
 
322
            "object and the message that is known so far. "
 
323
            "commit_message_template must return a new message to use (which "
 
324
            "could be the same as it was given). When there are multiple "
 
325
            "hooks registered for commit_message_template, they are chained "
 
326
            "with the result from the first passed into the second, and so "
 
327
            "on.", (1, 10))
 
328
 
 
329
 
 
330
hooks = MessageEditorHooks()
 
331
 
 
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
 
 
344
def generate_commit_message_template(commit, start_message=None):
 
345
    """Generate a commit message template.
 
346
 
 
347
    :param commit: Commit object for the active commit.
 
348
    :param start_message: Message to start with.
 
349
    :return: A start commit message or None for an empty start commit message.
 
350
    """
 
351
    start_message = None
 
352
    for hook in hooks['commit_message_template']:
 
353
        start_message = hook(commit, start_message)
 
354
    return start_message