← 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-12-11 02:07:30 UTC
  • mto: (3119.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 3120.
  • Revision ID: ian.clatworthy@internode.on.net-20071211020730-sdj4kj794dw0628e
make help topics more discoverable

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