/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: Martin
  • Date: 2017-06-05 20:48:31 UTC
  • mto: This revision was merged to the branch mainline in revision 6658.
  • Revision ID: gzlist@googlemail.com-20170605204831-20accykspjcrx0a8
Apply 2to3 dict fixer and clean up resulting mess using view helpers

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