/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: 2017-06-10 16:40:42 UTC
  • mfrom: (6653.6.7 rename-controldir)
  • mto: This revision was merged to the branch mainline in revision 6690.
  • Revision ID: jelmer@jelmer.uk-20170610164042-zrxqgy2htyduvke2
Merge rename-controldir branch.

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, BadCommitMessageEncoding
 
35
from .hooks import Hooks
 
36
from .sixish import (
 
37
    StringIO,
 
38
    )
34
39
 
35
40
 
36
41
def _get_editor():
37
42
    """Return a sequence of possible editor binaries for the current platform"""
38
43
    try:
39
 
        yield os.environ["BZR_EDITOR"], '$BZR_EDITOR'
 
44
        yield os.environ["BRZ_EDITOR"], '$BRZ_EDITOR'
40
45
    except KeyError:
41
46
        pass
42
47
 
43
 
    e = config.GlobalConfig().get_editor()
 
48
    e = config.GlobalStack().get('editor')
44
49
    if e is not None:
45
50
        yield e, config.config_filename()
46
51
 
59
64
def _run_editor(filename):
60
65
    """Try to execute an editor to edit the commit message."""
61
66
    for candidate, candidate_source in _get_editor():
62
 
        edargs = candidate.split(' ')
 
67
        edargs = cmdline.split(candidate)
63
68
        try:
64
69
            ## mutter("trying editor: %r", (edargs +[filename]))
65
70
            x = call(edargs + [filename])
66
 
        except OSError, e:
 
71
        except OSError as e:
67
72
            if candidate_source is not None:
68
73
                # We tried this editor because some user configuration (an
69
74
                # environment variable or config file) said to try it.  Let
80
85
        else:
81
86
            break
82
87
    raise BzrError("Could not start any editor.\nPlease specify one with:\n"
83
 
                   " - $BZR_EDITOR\n - editor=/some/path in %s\n"
 
88
                   " - $BRZ_EDITOR\n - editor=/some/path in %s\n"
84
89
                   " - $VISUAL\n - $EDITOR" % \
85
90
                    config.config_filename())
86
91
 
143
148
        if not msgfilename:
144
149
            return None
145
150
        basename = osutils.basename(msgfilename)
146
 
        msg_transport = transport.get_transport(osutils.dirname(msgfilename))
 
151
        msg_transport = transport.get_transport_from_path(osutils.dirname(msgfilename))
147
152
        reference_content = msg_transport.get_bytes(basename)
148
153
        if not _run_editor(msgfilename):
149
154
            return None
150
155
        edited_content = msg_transport.get_bytes(basename)
151
156
        if edited_content == reference_content:
152
 
            if not ui.ui_factory.get_boolean(
153
 
                "Commit message was not edited, use anyway"):
 
157
            if not ui.ui_factory.confirm_action(
 
158
                u"Commit message was not edited, use anyway",
 
159
                "breezy.msgeditor.unchanged",
 
160
                {}):
154
161
                # Returning "" makes cmd_commit raise 'empty commit message
155
162
                # specified' which is a reasonable error, given the user has
156
163
                # rejected using the unedited template.
199
206
        if msgfilename is not None:
200
207
            try:
201
208
                os.unlink(msgfilename)
202
 
            except IOError, e:
 
209
            except IOError as e:
203
210
                trace.warning(
204
211
                    "failed to unlink %s: %s; ignored", msgfilename, e)
205
212
 
206
213
 
207
214
def _create_temp_file_with_commit_template(infotext,
208
215
                                           ignoreline=DEFAULT_IGNORE_LINE,
209
 
                                           start_message=None):
 
216
                                           start_message=None,
 
217
                                           tmpdir=None):
210
218
    """Create temp file and write commit template in it.
211
219
 
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.
 
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.
216
223
 
217
224
    :param ignoreline:  The separator to use above the infotext.
218
225
 
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
 
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
223
229
 
224
230
    :return:    2-tuple (temp file name, hasinfo)
225
231
    """
226
232
    import tempfile
227
233
    tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
228
 
                                               dir='.',
229
 
                                               text=True)
230
 
    msgfilename = osutils.basename(msgfilename)
 
234
                                               dir=tmpdir, text=True)
231
235
    msgfile = os.fdopen(tmp_fileno, 'w')
232
236
    try:
233
237
        if start_message is not None:
254
258
    # TODO: Rather than running the status command, should prepare a draft of
255
259
    # the revision to be committed, then pause and ask the user to
256
260
    # confirm/write a message.
257
 
    from StringIO import StringIO       # must be unicode-safe
258
 
    from bzrlib.status import show_tree_status
 
261
    from .status import show_tree_status
259
262
    status_tmp = StringIO()
260
263
    show_tree_status(working_tree, specific_files=specific_files,
261
264
                     to_file=status_tmp, verbose=True)
273
276
    # TODO: Rather than running the status command, should prepare a draft of
274
277
    # the revision to be committed, then pause and ask the user to
275
278
    # confirm/write a message.
276
 
    from StringIO import StringIO       # must be unicode-safe
277
 
    from bzrlib.diff import show_diff_trees
 
279
    from .diff import show_diff_trees
278
280
 
279
281
    template = make_commit_message_template(working_tree, specific_files)
280
282
    template = template.encode(output_encoding, "replace")
302
304
 
303
305
        These are all empty initially.
304
306
        """
305
 
        Hooks.__init__(self)
306
 
        self.create_hook(HookPoint('commit_message_template',
 
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',
307
316
            "Called when a commit message is being generated. "
308
 
            "commit_message_template is called with the bzrlib.commit.Commit "
 
317
            "commit_message_template is called with the breezy.commit.Commit "
309
318
            "object and the message that is known so far. "
310
319
            "commit_message_template must return a new message to use (which "
311
 
            "could be the same as it was given. When there are multiple "
 
320
            "could be the same as it was given). When there are multiple "
312
321
            "hooks registered for commit_message_template, they are chained "
313
322
            "with the result from the first passed into the second, and so "
314
 
            "on.", (1, 10), None))
 
323
            "on.", (1, 10))
315
324
 
316
325
 
317
326
hooks = MessageEditorHooks()
318
327
 
319
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
 
320
340
def generate_commit_message_template(commit, start_message=None):
321
341
    """Generate a commit message template.
322
342