← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/msgeditor.py

  • Committer: Patch Queue Manager
  • Date: 2011-09-22 14:12:18 UTC
  • mfrom: (6155.3.1 jam)
  • Revision ID: pqm@pqm.ubuntu.com-20110922141218-86s4uu6nqvourw4f
(jameinel) Cleanup comments bzrlib/smart/__init__.py (John A Meinel)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/msgeditor.py
1
 
# Copyright (C) 2005, 2006 by Canonical Ltd
2
 
 
 
1
# Copyright (C) 2005-2011 Canonical Ltd
 
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
 
18
18
"""Commit message editor support."""
19
19
 
20
20
import codecs
21
 
import errno
22
21
import os
23
22
from subprocess import call
24
23
import sys
25
24
 
26
 
import bzrlib
27
 
import bzrlib.config as config
28
 
from bzrlib.errors import BzrError
29
 
from bzrlib.trace import mutter
 
25
from bzrlib import (
 
26
    cmdline,
 
27
    config,
 
28
    osutils,
 
29
    trace,
 
30
    transport,
 
31
    ui,
 
32
    )
 
33
from bzrlib.errors import BzrError, BadCommitMessageEncoding
 
34
from bzrlib.hooks import Hooks
30
35
 
31
36
 
32
37
def _get_editor():
33
38
    """Return a sequence of possible editor binaries for the current platform"""
34
39
    try:
35
 
        yield os.environ["BZR_EDITOR"]
 
40
        yield os.environ["BZR_EDITOR"], '$BZR_EDITOR'
36
41
    except KeyError:
37
42
        pass
38
43
 
39
 
    e = config.GlobalConfig().get_editor()
 
44
    e = config.GlobalStack().get('editor')
40
45
    if e is not None:
41
 
        yield e
42
 
        
 
46
        yield e, config.config_filename()
 
47
 
43
48
    for varname in 'VISUAL', 'EDITOR':
44
 
        if os.environ.has_key(varname):
45
 
            yield os.environ[varname]
 
49
        if varname in os.environ:
 
50
            yield os.environ[varname], '$' + varname
46
51
 
47
52
    if sys.platform == 'win32':
48
53
        for editor in 'wordpad.exe', 'notepad.exe':
49
 
            yield editor
 
54
            yield editor, None
50
55
    else:
51
56
        for editor in ['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe']:
52
 
            yield editor
 
57
            yield editor, None
53
58
 
54
59
 
55
60
def _run_editor(filename):
56
61
    """Try to execute an editor to edit the commit message."""
57
 
    for e in _get_editor():
58
 
        edargs = e.split(' ')
 
62
    for candidate, candidate_source in _get_editor():
 
63
        edargs = cmdline.split(candidate)
59
64
        try:
60
65
            ## mutter("trying editor: %r", (edargs +[filename]))
61
66
            x = call(edargs + [filename])
62
67
        except OSError, e:
63
 
           # We're searching for an editor, so catch safe errors and continue
64
 
           if e.errno in (errno.ENOENT, ):
65
 
               continue
66
 
           raise
 
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
67
77
        if x == 0:
68
78
            return True
69
79
        elif x == 127:
71
81
        else:
72
82
            break
73
83
    raise BzrError("Could not start any editor.\nPlease specify one with:\n"
74
 
                   " - $BZR_EDITOR\n - editor=/some/path in %s\n - $EDITOR" % \
 
84
                   " - $BZR_EDITOR\n - editor=/some/path in %s\n"
 
85
                   " - $VISUAL\n - $EDITOR" % \
75
86
                    config.config_filename())
76
87
 
77
88
 
79
90
    { 'bar' : '-' * 14, 'msg' : 'This line and the following will be ignored' }
80
91
 
81
92
 
82
 
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE):
83
 
    """Let the user edit a commit message in a temp file.
84
 
 
85
 
    This is run if they don't give a message or
86
 
    message-containing file on the command line.
87
 
 
88
 
    infotext:
89
 
        Text to be displayed at bottom of message for
90
 
        the user's reference; currently similar to
91
 
        'bzr status'.
92
 
    """
93
 
    import tempfile
94
 
 
 
93
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE,
 
94
                        start_message=None):
 
95
    """Let the user edit a commit message in a temp file.
 
96
 
 
97
    This is run if they don't give a message or
 
98
    message-containing file on the command line.
 
99
 
 
100
    :param infotext:    Text to be displayed at bottom of message
 
101
                        for the user's reference;
 
102
                        currently similar to 'bzr status'.
 
103
 
 
104
    :param ignoreline:  The separator to use above the infotext.
 
105
 
 
106
    :param start_message:   The text to place above the separator, if any.
 
107
                            This will not be removed from the message
 
108
                            after the user has edited it.
 
109
 
 
110
    :return:    commit message or None.
 
111
    """
 
112
 
 
113
    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')
 
116
    return edit_commit_message_encoded(infotext, ignoreline, start_message)
 
117
 
 
118
 
 
119
def edit_commit_message_encoded(infotext, ignoreline=DEFAULT_IGNORE_LINE,
 
120
                                start_message=None):
 
121
    """Let the user edit a commit message in a temp file.
 
122
 
 
123
    This is run if they don't give a message or
 
124
    message-containing file on the command line.
 
125
 
 
126
    :param infotext:    Text to be displayed at bottom of message
 
127
                        for the user's reference;
 
128
                        currently similar to 'bzr status'.
 
129
                        The string is already encoded
 
130
 
 
131
    :param ignoreline:  The separator to use above the infotext.
 
132
 
 
133
    :param start_message:   The text to place above the separator, if any.
 
134
                            This will not be removed from the message
 
135
                            after the user has edited it.
 
136
                            The string is already encoded
 
137
 
 
138
    :return:    commit message or None.
 
139
    """
95
140
    msgfilename = None
96
141
    try:
97
 
        tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.', dir=u'.')
98
 
        msgfile = os.close(tmp_fileno)
99
 
        if infotext is not None and infotext != "":
100
 
            hasinfo = True
101
 
            msgfile = file(msgfilename, "w")
102
 
            msgfile.write("\n\n%s\n\n%s" % (ignoreline,
103
 
                infotext.encode(bzrlib.user_encoding, 'replace')))
104
 
            msgfile.close()
105
 
        else:
106
 
            hasinfo = False
107
 
 
 
142
        msgfilename, hasinfo = _create_temp_file_with_commit_template(
 
143
                                    infotext, ignoreline, start_message)
 
144
        if not msgfilename:
 
145
            return None
 
146
        basename = osutils.basename(msgfilename)
 
147
        msg_transport = transport.get_transport_from_path(osutils.dirname(msgfilename))
 
148
        reference_content = msg_transport.get_bytes(basename)
108
149
        if not _run_editor(msgfilename):
109
150
            return None
110
 
        
 
151
        edited_content = msg_transport.get_bytes(basename)
 
152
        if edited_content == reference_content:
 
153
            if not ui.ui_factory.confirm_action(
 
154
                u"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 ""
111
161
        started = False
112
162
        msg = []
113
163
        lastline, nlines = 0, 0
114
 
        for line in codecs.open(msgfilename, 'r', bzrlib.user_encoding):
115
 
            stripped_line = line.strip()
116
 
            # strip empty line before the log message starts
117
 
            if not started:
118
 
                if stripped_line != "":
119
 
                    started = True
120
 
                else:
121
 
                    continue
122
 
            # check for the ignore line only if there
123
 
            # is additional information at the end
124
 
            if hasinfo and stripped_line == ignoreline:
125
 
                break
126
 
            nlines += 1
127
 
            # keep track of the last line that had some content
128
 
            if stripped_line != "":
129
 
                lastline = nlines
130
 
            msg.append(line)
131
 
            
 
164
        # codecs.open() ALWAYS opens file in binary mode but we need text mode
 
165
        # 'rU' mode useful when bzr.exe used on Cygwin (bialix 20070430)
 
166
        f = file(msgfilename, 'rU')
 
167
        try:
 
168
            try:
 
169
                for line in codecs.getreader(osutils.get_user_encoding())(f):
 
170
                    stripped_line = line.strip()
 
171
                    # strip empty line before the log message starts
 
172
                    if not started:
 
173
                        if stripped_line != "":
 
174
                            started = True
 
175
                        else:
 
176
                            continue
 
177
                    # check for the ignore line only if there
 
178
                    # is additional information at the end
 
179
                    if hasinfo and stripped_line == ignoreline:
 
180
                        break
 
181
                    nlines += 1
 
182
                    # keep track of the last line that had some content
 
183
                    if stripped_line != "":
 
184
                        lastline = nlines
 
185
                    msg.append(line)
 
186
            except UnicodeDecodeError:
 
187
                raise BadCommitMessageEncoding()
 
188
        finally:
 
189
            f.close()
 
190
 
132
191
        if len(msg) == 0:
133
192
            return ""
134
193
        # delete empty lines at the end
144
203
            try:
145
204
                os.unlink(msgfilename)
146
205
            except IOError, e:
147
 
                mutter("failed to unlink %s: %s; ignored", msgfilename, e)
 
206
                trace.warning(
 
207
                    "failed to unlink %s: %s; ignored", msgfilename, e)
 
208
 
 
209
 
 
210
def _create_temp_file_with_commit_template(infotext,
 
211
                                           ignoreline=DEFAULT_IGNORE_LINE,
 
212
                                           start_message=None,
 
213
                                           tmpdir=None):
 
214
    """Create temp file and write commit template in it.
 
215
 
 
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.
 
219
 
 
220
    :param ignoreline:  The separator to use above the infotext.
 
221
 
 
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
 
225
 
 
226
    :return:    2-tuple (temp file name, hasinfo)
 
227
    """
 
228
    import tempfile
 
229
    tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
 
230
                                               dir=tmpdir, text=True)
 
231
    msgfile = os.fdopen(tmp_fileno, 'w')
 
232
    try:
 
233
        if start_message is not None:
 
234
            msgfile.write("%s\n" % start_message)
 
235
 
 
236
        if infotext is not None and infotext != "":
 
237
            hasinfo = True
 
238
            msgfile.write("\n\n%s\n\n%s" %(ignoreline, infotext))
 
239
        else:
 
240
            hasinfo = False
 
241
    finally:
 
242
        msgfile.close()
 
243
 
 
244
    return (msgfilename, hasinfo)
148
245
 
149
246
 
150
247
def make_commit_message_template(working_tree, specific_files):
152
249
 
153
250
    Returns a unicode string containing the template.
154
251
    """
155
 
    # TODO: Should probably be given the WorkingTree not the branch
156
 
    #
157
252
    # TODO: make provision for this to be overridden or modified by a hook
158
253
    #
159
254
    # TODO: Rather than running the status command, should prepare a draft of
162
257
    from StringIO import StringIO       # must be unicode-safe
163
258
    from bzrlib.status import show_tree_status
164
259
    status_tmp = StringIO()
165
 
    show_tree_status(working_tree, specific_files=specific_files, 
166
 
                     to_file=status_tmp)
 
260
    show_tree_status(working_tree, specific_files=specific_files,
 
261
                     to_file=status_tmp, verbose=True)
167
262
    return status_tmp.getvalue()
 
263
 
 
264
 
 
265
def make_commit_message_template_encoded(working_tree, specific_files,
 
266
                                         diff=None, output_encoding='utf-8'):
 
267
    """Prepare a template file for a commit into a branch.
 
268
 
 
269
    Returns an encoded string.
 
270
    """
 
271
    # TODO: make provision for this to be overridden or modified by a hook
 
272
    #
 
273
    # TODO: Rather than running the status command, should prepare a draft of
 
274
    # the revision to be committed, then pause and ask the user to
 
275
    # confirm/write a message.
 
276
    from StringIO import StringIO       # must be unicode-safe
 
277
    from bzrlib.diff import show_diff_trees
 
278
 
 
279
    template = make_commit_message_template(working_tree, specific_files)
 
280
    template = template.encode(output_encoding, "replace")
 
281
 
 
282
    if diff:
 
283
        stream = StringIO()
 
284
        show_diff_trees(working_tree.basis_tree(),
 
285
                        working_tree, stream, specific_files,
 
286
                        path_encoding=output_encoding)
 
287
        template = template + '\n' + stream.getvalue()
 
288
 
 
289
    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('set_commit_message',
 
307
            "Set a fixed commit message. "
 
308
            "set_commit_message is called with the "
 
309
            "bzrlib.commit.Commit object (so you can also change e.g. revision "
 
310
            "properties by editing commit.builder._revprops) and the message "
 
311
            "so far. set_commit_message must return the message to use or None"
 
312
            " if it should use the message editor as normal.", (2, 4))
 
313
        self.add_hook('commit_message_template',
 
314
            "Called when a commit message is being generated. "
 
315
            "commit_message_template is called with the bzrlib.commit.Commit "
 
316
            "object and the message that is known so far. "
 
317
            "commit_message_template must return a new message to use (which "
 
318
            "could be the same as it was given). When there are multiple "
 
319
            "hooks registered for commit_message_template, they are chained "
 
320
            "with the result from the first passed into the second, and so "
 
321
            "on.", (1, 10))
 
322
 
 
323
 
 
324
hooks = MessageEditorHooks()
 
325
 
 
326
 
 
327
def set_commit_message(commit, start_message=None):
 
328
    """Sets the commit message.
 
329
    :param commit: Commit object for the active commit.
 
330
    :return: The commit message or None to continue using the message editor
 
331
    """
 
332
    start_message = None
 
333
    for hook in hooks['set_commit_message']:
 
334
        start_message = hook(commit, start_message)
 
335
    return start_message
 
336
 
 
337
 
 
338
def generate_commit_message_template(commit, start_message=None):
 
339
    """Generate a commit message template.
 
340
 
 
341
    :param commit: Commit object for the active commit.
 
342
    :param start_message: Message to start with.
 
343
    :return: A start commit message or None for an empty start commit message.
 
344
    """
 
345
    start_message = None
 
346
    for hook in hooks['commit_message_template']:
 
347
        start_message = hook(commit, start_message)
 
348
    return start_message