/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-08-26 16:16:11 UTC
  • mto: This revision was merged to the branch mainline in revision 6763.
  • Revision ID: gzlist@googlemail.com-20170826161611-gzjgbcvq03u9vr38
One last dict.iteritems() in hooks 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
    StringIO,
 
38
    )
 
39
 
 
40
 
 
41
class BadCommitMessageEncoding(BzrError):
 
42
 
 
43
    _fmt = 'The specified commit message contains characters unsupported by '\
 
44
        'the current encoding.'
34
45
 
35
46
 
36
47
def _get_editor():
37
48
    """Return a sequence of possible editor binaries for the current platform"""
38
49
    try:
39
 
        yield os.environ["BZR_EDITOR"], '$BZR_EDITOR'
 
50
        yield os.environ["BRZ_EDITOR"], '$BRZ_EDITOR'
40
51
    except KeyError:
41
52
        pass
42
53
 
43
 
    e = config.GlobalConfig().get_editor()
 
54
    e = config.GlobalStack().get('editor')
44
55
    if e is not None:
45
56
        yield e, config.config_filename()
46
57
 
59
70
def _run_editor(filename):
60
71
    """Try to execute an editor to edit the commit message."""
61
72
    for candidate, candidate_source in _get_editor():
62
 
        edargs = candidate.split(' ')
 
73
        edargs = cmdline.split(candidate)
63
74
        try:
64
75
            ## 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"
 
94
                   " - $BRZ_EDITOR\n - editor=/some/path in %s\n"
84
95
                   " - $VISUAL\n - $EDITOR" % \
85
96
                    config.config_filename())
86
97
 
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(osutils.dirname(msgfilename))
147
158
        reference_content = msg_transport.get_bytes(basename)
148
159
        if not _run_editor(msgfilename):
149
160
            return None
150
161
        edited_content = msg_transport.get_bytes(basename)
151
162
        if edited_content == reference_content:
152
 
            if not ui.ui_factory.get_boolean(
153
 
                "Commit message was not edited, use anyway"):
 
163
            if not ui.ui_factory.confirm_action(
 
164
                u"Commit message was not edited, use anyway",
 
165
                "breezy.msgeditor.unchanged",
 
166
                {}):
154
167
                # Returning "" makes cmd_commit raise 'empty commit message
155
168
                # specified' which is a reasonable error, given the user has
156
169
                # rejected using the unedited template.
199
212
        if msgfilename is not None:
200
213
            try:
201
214
                os.unlink(msgfilename)
202
 
            except IOError, e:
 
215
            except IOError as e:
203
216
                trace.warning(
204
217
                    "failed to unlink %s: %s; ignored", msgfilename, e)
205
218
 
206
219
 
207
220
def _create_temp_file_with_commit_template(infotext,
208
221
                                           ignoreline=DEFAULT_IGNORE_LINE,
209
 
                                           start_message=None):
 
222
                                           start_message=None,
 
223
                                           tmpdir=None):
210
224
    """Create temp file and write commit template in it.
211
225
 
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.
 
226
    :param infotext: Text to be displayed at bottom of message for the
 
227
        user's reference; currently similar to 'bzr status'.  The text is
 
228
        already encoded.
216
229
 
217
230
    :param ignoreline:  The separator to use above the infotext.
218
231
 
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
 
232
    :param start_message: The text to place above the separator, if any.
 
233
        This will not be removed from the message after the user has edited
 
234
        it.  The string is already encoded
223
235
 
224
236
    :return:    2-tuple (temp file name, hasinfo)
225
237
    """
226
238
    import tempfile
227
239
    tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
228
 
                                               dir='.',
229
 
                                               text=True)
230
 
    msgfilename = osutils.basename(msgfilename)
 
240
                                               dir=tmpdir, text=True)
231
241
    msgfile = os.fdopen(tmp_fileno, 'w')
232
242
    try:
233
243
        if start_message is not None:
254
264
    # TODO: Rather than running the status command, should prepare a draft of
255
265
    # the revision to be committed, then pause and ask the user to
256
266
    # confirm/write a message.
257
 
    from StringIO import StringIO       # must be unicode-safe
258
 
    from bzrlib.status import show_tree_status
 
267
    from .status import show_tree_status
259
268
    status_tmp = StringIO()
260
269
    show_tree_status(working_tree, specific_files=specific_files,
261
270
                     to_file=status_tmp, verbose=True)
273
282
    # TODO: Rather than running the status command, should prepare a draft of
274
283
    # the revision to be committed, then pause and ask the user to
275
284
    # confirm/write a message.
276
 
    from StringIO import StringIO       # must be unicode-safe
277
 
    from bzrlib.diff import show_diff_trees
 
285
    from .diff import show_diff_trees
278
286
 
279
287
    template = make_commit_message_template(working_tree, specific_files)
280
288
    template = template.encode(output_encoding, "replace")
302
310
 
303
311
        These are all empty initially.
304
312
        """
305
 
        Hooks.__init__(self)
306
 
        self.create_hook(HookPoint('commit_message_template',
 
313
        Hooks.__init__(self, "breezy.msgeditor", "hooks")
 
314
        self.add_hook('set_commit_message',
 
315
            "Set a fixed commit message. "
 
316
            "set_commit_message is called with the "
 
317
            "breezy.commit.Commit object (so you can also change e.g. revision "
 
318
            "properties by editing commit.builder._revprops) and the message "
 
319
            "so far. set_commit_message must return the message to use or None"
 
320
            " if it should use the message editor as normal.", (2, 4))
 
321
        self.add_hook('commit_message_template',
307
322
            "Called when a commit message is being generated. "
308
 
            "commit_message_template is called with the bzrlib.commit.Commit "
 
323
            "commit_message_template is called with the breezy.commit.Commit "
309
324
            "object and the message that is known so far. "
310
325
            "commit_message_template must return a new message to use (which "
311
 
            "could be the same as it was given. When there are multiple "
 
326
            "could be the same as it was given). When there are multiple "
312
327
            "hooks registered for commit_message_template, they are chained "
313
328
            "with the result from the first passed into the second, and so "
314
 
            "on.", (1, 10), None))
 
329
            "on.", (1, 10))
315
330
 
316
331
 
317
332
hooks = MessageEditorHooks()
318
333
 
319
334
 
 
335
def set_commit_message(commit, start_message=None):
 
336
    """Sets the commit message.
 
337
    :param commit: Commit object for the active commit.
 
338
    :return: The commit message or None to continue using the message editor
 
339
    """
 
340
    start_message = None
 
341
    for hook in hooks['set_commit_message']:
 
342
        start_message = hook(commit, start_message)
 
343
    return start_message
 
344
 
 
345
 
320
346
def generate_commit_message_template(commit, start_message=None):
321
347
    """Generate a commit message template.
322
348