← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/msgeditor.py

  • Committer: John Arbash Meinel
  • Author(s): Mark Hammond
  • Date: 2008-09-09 17:02:21 UTC
  • mto: This revision was merged to the branch mainline in revision 3697.
  • Revision ID: john@arbash-meinel.com-20080909170221-svim3jw2mrz0amp3
An updated transparent icon for bzr.

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
 
28
from bzrlib import osutils
34
29
from bzrlib.errors import BzrError, BadCommitMessageEncoding
35
 
from bzrlib.hooks import Hooks
 
30
from bzrlib.trace import warning, mutter
36
31
 
37
32
 
38
33
def _get_editor():
39
34
    """Return a sequence of possible editor binaries for the current platform"""
40
35
    try:
41
 
        yield os.environ["BZR_EDITOR"], '$BZR_EDITOR'
 
36
        yield os.environ["BZR_EDITOR"]
42
37
    except KeyError:
43
38
        pass
44
39
 
45
 
    e = config.GlobalStack().get('editor')
 
40
    e = config.GlobalConfig().get_editor()
46
41
    if e is not None:
47
 
        yield e, config.config_filename()
48
 
 
 
42
        yield e
 
43
        
49
44
    for varname in 'VISUAL', 'EDITOR':
50
45
        if varname in os.environ:
51
 
            yield os.environ[varname], '$' + varname
 
46
            yield os.environ[varname]
52
47
 
53
48
    if sys.platform == 'win32':
54
49
        for editor in 'wordpad.exe', 'notepad.exe':
55
 
            yield editor, None
 
50
            yield editor
56
51
    else:
57
52
        for editor in ['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe']:
58
 
            yield editor, None
 
53
            yield editor
59
54
 
60
55
 
61
56
def _run_editor(filename):
62
57
    """Try to execute an editor to edit the commit message."""
63
 
    for candidate, candidate_source in _get_editor():
64
 
        edargs = cmdline.split(candidate)
 
58
    for e in _get_editor():
 
59
        edargs = e.split(' ')
65
60
        try:
66
61
            ## mutter("trying editor: %r", (edargs +[filename]))
67
62
            x = call(edargs + [filename])
68
63
        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
 
64
            # We're searching for an editor, so catch safe errors and continue
 
65
            if e.errno in (errno.ENOENT, ):
 
66
                continue
77
67
            raise
78
68
        if x == 0:
79
69
            return True
112
102
    """
113
103
 
114
104
    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')
 
105
        start_message = start_message.encode(bzrlib.user_encoding)
 
106
    infotext = infotext.encode(bzrlib.user_encoding, 'replace')
117
107
    return edit_commit_message_encoded(infotext, ignoreline, start_message)
118
108
 
119
109
 
142
132
    try:
143
133
        msgfilename, hasinfo = _create_temp_file_with_commit_template(
144
134
                                    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 ""
 
135
 
 
136
        if not msgfilename or not _run_editor(msgfilename):
 
137
            return None
 
138
        
162
139
        started = False
163
140
        msg = []
164
141
        lastline, nlines = 0, 0
167
144
        f = file(msgfilename, 'rU')
168
145
        try:
169
146
            try:
170
 
                for line in codecs.getreader(osutils.get_user_encoding())(f):
 
147
                for line in codecs.getreader(bzrlib.user_encoding)(f):
171
148
                    stripped_line = line.strip()
172
149
                    # strip empty line before the log message starts
173
150
                    if not started:
204
181
            try:
205
182
                os.unlink(msgfilename)
206
183
            except IOError, e:
207
 
                trace.warning(
208
 
                    "failed to unlink %s: %s; ignored", msgfilename, e)
 
184
                warning("failed to unlink %s: %s; ignored", msgfilename, e)
209
185
 
210
186
 
211
187
def _create_temp_file_with_commit_template(infotext,
212
188
                                           ignoreline=DEFAULT_IGNORE_LINE,
213
 
                                           start_message=None,
214
 
                                           tmpdir=None):
 
189
                                           start_message=None):
215
190
    """Create temp file and write commit template in it.
216
191
 
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.
 
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.
220
196
 
221
197
    :param ignoreline:  The separator to use above the infotext.
222
198
 
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
 
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
226
203
 
227
204
    :return:    2-tuple (temp file name, hasinfo)
228
205
    """
229
206
    import tempfile
230
207
    tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
231
 
                                               dir=tmpdir, text=True)
 
208
                                               dir='.',
 
209
                                               text=True)
 
210
    msgfilename = osutils.basename(msgfilename)
232
211
    msgfile = os.fdopen(tmp_fileno, 'w')
233
212
    try:
234
213
        if start_message is not None:
258
237
    from StringIO import StringIO       # must be unicode-safe
259
238
    from bzrlib.status import show_tree_status
260
239
    status_tmp = StringIO()
261
 
    show_tree_status(working_tree, specific_files=specific_files,
262
 
                     to_file=status_tmp, verbose=True)
 
240
    show_tree_status(working_tree, specific_files=specific_files, 
 
241
                     to_file=status_tmp)
263
242
    return status_tmp.getvalue()
264
243
 
265
244
 
288
267
        template = template + '\n' + stream.getvalue()
289
268
 
290
269
    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