← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/msgeditor.py

  • Committer: Ian Clatworthy
  • Date: 2007-11-27 21:17:06 UTC
  • mto: (3054.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 3055.
  • Revision ID: ian.clatworthy@internode.on.net-20071127211706-871zcqst0yi5tcvl
make fixes suggested by proof-readers

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/msgeditor.py
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005, 2006 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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
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
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
16
17
 
17
18
"""Commit message editor support."""
18
19
 
19
 
from __future__ import absolute_import
20
 
 
21
20
import codecs
 
21
import errno
22
22
import os
23
23
from subprocess import call
24
24
import sys
25
25
 
26
 
from bzrlib import (
27
 
    cmdline,
28
 
    config,
29
 
    osutils,
30
 
    trace,
31
 
    transport,
32
 
    ui,
33
 
    )
 
26
import bzrlib
 
27
import bzrlib.config as config
34
28
from bzrlib.errors import BzrError, BadCommitMessageEncoding
35
 
from bzrlib.hooks import Hooks
 
29
from bzrlib.trace import warning, mutter
36
30
 
37
31
 
38
32
def _get_editor():
39
33
    """Return a sequence of possible editor binaries for the current platform"""
40
34
    try:
41
 
        yield os.environ["BZR_EDITOR"], '$BZR_EDITOR'
 
35
        yield os.environ["BZR_EDITOR"]
42
36
    except KeyError:
43
37
        pass
44
38
 
45
 
    e = config.GlobalStack().get('editor')
 
39
    e = config.GlobalConfig().get_editor()
46
40
    if e is not None:
47
 
        yield e, config.config_filename()
48
 
 
 
41
        yield e
 
42
        
49
43
    for varname in 'VISUAL', 'EDITOR':
50
44
        if varname in os.environ:
51
 
            yield os.environ[varname], '$' + varname
 
45
            yield os.environ[varname]
52
46
 
53
47
    if sys.platform == 'win32':
54
48
        for editor in 'wordpad.exe', 'notepad.exe':
55
 
            yield editor, None
 
49
            yield editor
56
50
    else:
57
51
        for editor in ['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe']:
58
 
            yield editor, None
 
52
            yield editor
59
53
 
60
54
 
61
55
def _run_editor(filename):
62
56
    """Try to execute an editor to edit the commit message."""
63
 
    for candidate, candidate_source in _get_editor():
64
 
        edargs = cmdline.split(candidate)
 
57
    for e in _get_editor():
 
58
        edargs = e.split(' ')
65
59
        try:
66
60
            ## mutter("trying editor: %r", (edargs +[filename]))
67
61
            x = call(edargs + [filename])
68
62
        except OSError, e:
69
 
            if candidate_source is not None:
70
 
                # We tried this editor because some user configuration (an
71
 
                # environment variable or config file) said to try it.  Let
72
 
                # the user know their configuration is broken.
73
 
                trace.warning(
74
 
                    'Could not start editor "%s" (specified by %s): %s\n'
75
 
                    % (candidate, candidate_source, str(e)))
76
 
            continue
77
 
            raise
 
63
           # We're searching for an editor, so catch safe errors and continue
 
64
           if e.errno in (errno.ENOENT, ):
 
65
               continue
 
66
           raise
78
67
        if x == 0:
79
68
            return True
80
69
        elif x == 127:
112
101
    """
113
102
 
114
103
    if not start_message is None:
115
 
        start_message = start_message.encode(osutils.get_user_encoding())
116
 
    infotext = infotext.encode(osutils.get_user_encoding(), 'replace')
 
104
        start_message = start_message.encode(bzrlib.user_encoding)
 
105
    infotext = infotext.encode(bzrlib.user_encoding, 'replace')
117
106
    return edit_commit_message_encoded(infotext, ignoreline, start_message)
118
107
 
119
108
 
142
131
    try:
143
132
        msgfilename, hasinfo = _create_temp_file_with_commit_template(
144
133
                                    infotext, ignoreline, start_message)
145
 
        if not msgfilename:
146
 
            return None
147
 
        basename = osutils.basename(msgfilename)
148
 
        msg_transport = transport.get_transport_from_path(osutils.dirname(msgfilename))
149
 
        reference_content = msg_transport.get_bytes(basename)
150
 
        if not _run_editor(msgfilename):
151
 
            return None
152
 
        edited_content = msg_transport.get_bytes(basename)
153
 
        if edited_content == reference_content:
154
 
            if not ui.ui_factory.confirm_action(
155
 
                u"Commit message was not edited, use anyway",
156
 
                "bzrlib.msgeditor.unchanged",
157
 
                {}):
158
 
                # Returning "" makes cmd_commit raise 'empty commit message
159
 
                # specified' which is a reasonable error, given the user has
160
 
                # rejected using the unedited template.
161
 
                return ""
 
134
 
 
135
        if not msgfilename or not _run_editor(msgfilename):
 
136
            return None
 
137
        
162
138
        started = False
163
139
        msg = []
164
140
        lastline, nlines = 0, 0
167
143
        f = file(msgfilename, 'rU')
168
144
        try:
169
145
            try:
170
 
                for line in codecs.getreader(osutils.get_user_encoding())(f):
 
146
                for line in codecs.getreader(bzrlib.user_encoding)(f):
171
147
                    stripped_line = line.strip()
172
148
                    # strip empty line before the log message starts
173
149
                    if not started:
204
180
            try:
205
181
                os.unlink(msgfilename)
206
182
            except IOError, e:
207
 
                trace.warning(
208
 
                    "failed to unlink %s: %s; ignored", msgfilename, e)
 
183
                warning("failed to unlink %s: %s; ignored", msgfilename, e)
209
184
 
210
185
 
211
186
def _create_temp_file_with_commit_template(infotext,
212
187
                                           ignoreline=DEFAULT_IGNORE_LINE,
213
 
                                           start_message=None,
214
 
                                           tmpdir=None):
 
188
                                           start_message=None):
215
189
    """Create temp file and write commit template in it.
216
190
 
217
 
    :param infotext: Text to be displayed at bottom of message for the
218
 
        user's reference; currently similar to 'bzr status'.  The text is
219
 
        already encoded.
 
191
    :param infotext:    Text to be displayed at bottom of message
 
192
                        for the user's reference;
 
193
                        currently similar to 'bzr status'.
 
194
                        The text is already encoded.
220
195
 
221
196
    :param ignoreline:  The separator to use above the infotext.
222
197
 
223
 
    :param start_message: The text to place above the separator, if any.
224
 
        This will not be removed from the message after the user has edited
225
 
        it.  The string is already encoded
 
198
    :param start_message:   The text to place above the separator, if any.
 
199
                            This will not be removed from the message
 
200
                            after the user has edited it.
 
201
                            The string is already encoded
226
202
 
227
203
    :return:    2-tuple (temp file name, hasinfo)
228
204
    """
229
205
    import tempfile
230
206
    tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
231
 
                                               dir=tmpdir, text=True)
 
207
                                               dir=u'.',
 
208
                                               text=True)
232
209
    msgfile = os.fdopen(tmp_fileno, 'w')
233
210
    try:
234
211
        if start_message is not None:
258
235
    from StringIO import StringIO       # must be unicode-safe
259
236
    from bzrlib.status import show_tree_status
260
237
    status_tmp = StringIO()
261
 
    show_tree_status(working_tree, specific_files=specific_files,
262
 
                     to_file=status_tmp, verbose=True)
 
238
    show_tree_status(working_tree, specific_files=specific_files, 
 
239
                     to_file=status_tmp)
263
240
    return status_tmp.getvalue()
264
241
 
265
242
 
288
265
        template = template + '\n' + stream.getvalue()
289
266
 
290
267
    return template
291
 
 
292
 
 
293
 
class MessageEditorHooks(Hooks):
294
 
    """A dictionary mapping hook name to a list of callables for message editor
295
 
    hooks.
296
 
 
297
 
    e.g. ['commit_message_template'] is the list of items to be called to
298
 
    generate a commit message template
299
 
    """
300
 
 
301
 
    def __init__(self):
302
 
        """Create the default hooks.
303
 
 
304
 
        These are all empty initially.
305
 
        """
306
 
        Hooks.__init__(self, "bzrlib.msgeditor", "hooks")
307
 
        self.add_hook('set_commit_message',
308
 
            "Set a fixed commit message. "
309
 
            "set_commit_message is called with the "
310
 
            "bzrlib.commit.Commit object (so you can also change e.g. revision "
311
 
            "properties by editing commit.builder._revprops) and the message "
312
 
            "so far. set_commit_message must return the message to use or None"
313
 
            " if it should use the message editor as normal.", (2, 4))
314
 
        self.add_hook('commit_message_template',
315
 
            "Called when a commit message is being generated. "
316
 
            "commit_message_template is called with the bzrlib.commit.Commit "
317
 
            "object and the message that is known so far. "
318
 
            "commit_message_template must return a new message to use (which "
319
 
            "could be the same as it was given). When there are multiple "
320
 
            "hooks registered for commit_message_template, they are chained "
321
 
            "with the result from the first passed into the second, and so "
322
 
            "on.", (1, 10))
323
 
 
324
 
 
325
 
hooks = MessageEditorHooks()
326
 
 
327
 
 
328
 
def set_commit_message(commit, start_message=None):
329
 
    """Sets the commit message.
330
 
    :param commit: Commit object for the active commit.
331
 
    :return: The commit message or None to continue using the message editor
332
 
    """
333
 
    start_message = None
334
 
    for hook in hooks['set_commit_message']:
335
 
        start_message = hook(commit, start_message)
336
 
    return start_message
337
 
 
338
 
 
339
 
def generate_commit_message_template(commit, start_message=None):
340
 
    """Generate a commit message template.
341
 
 
342
 
    :param commit: Commit object for the active commit.
343
 
    :param start_message: Message to start with.
344
 
    :return: A start commit message or None for an empty start commit message.
345
 
    """
346
 
    start_message = None
347
 
    for hook in hooks['commit_message_template']:
348
 
        start_message = hook(commit, start_message)
349
 
    return start_message