← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/msgeditor.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-03-16 13:18:16 UTC
  • mfrom: (4149.1.1 bzr.integration)
  • Revision ID: pqm@pqm.ubuntu.com-20090316131816-p0a3ugbpmbqm3a04
(vila,
        jfroy) Provides all request parameters to authentication providers

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/msgeditor.py
1
 
# Copyright (C) 2005, 2006 by 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
23
23
from subprocess import call
24
24
import sys
25
25
 
26
 
import bzrlib
27
 
import bzrlib.config as config
28
 
from bzrlib.errors import BzrError
29
 
from bzrlib.trace import warning, mutter
 
26
from bzrlib import (
 
27
    config,
 
28
    osutils,
 
29
    trace,
 
30
    )
 
31
from bzrlib.errors import BzrError, BadCommitMessageEncoding
 
32
from bzrlib.hooks import HookPoint, Hooks
30
33
 
31
34
 
32
35
def _get_editor():
33
36
    """Return a sequence of possible editor binaries for the current platform"""
34
37
    try:
35
 
        yield os.environ["BZR_EDITOR"]
 
38
        yield os.environ["BZR_EDITOR"], '$BZR_EDITOR'
36
39
    except KeyError:
37
40
        pass
38
41
 
39
42
    e = config.GlobalConfig().get_editor()
40
43
    if e is not None:
41
 
        yield e
42
 
        
 
44
        yield e, config.config_filename()
 
45
 
43
46
    for varname in 'VISUAL', 'EDITOR':
44
47
        if varname in os.environ:
45
 
            yield os.environ[varname]
 
48
            yield os.environ[varname], '$' + varname
46
49
 
47
50
    if sys.platform == 'win32':
48
51
        for editor in 'wordpad.exe', 'notepad.exe':
49
 
            yield editor
 
52
            yield editor, None
50
53
    else:
51
54
        for editor in ['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe']:
52
 
            yield editor
 
55
            yield editor, None
53
56
 
54
57
 
55
58
def _run_editor(filename):
56
59
    """Try to execute an editor to edit the commit message."""
57
 
    for e in _get_editor():
58
 
        edargs = e.split(' ')
 
60
    for candidate, candidate_source in _get_editor():
 
61
        edargs = candidate.split(' ')
59
62
        try:
60
63
            ## mutter("trying editor: %r", (edargs +[filename]))
61
64
            x = call(edargs + [filename])
62
65
        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
 
66
            # We're searching for an editor, so catch safe errors and continue
 
67
            if e.errno in (errno.ENOENT, errno.EACCES):
 
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
 
142
        msgfilename, hasinfo = _create_temp_file_with_commit_template(
 
143
                                    infotext, ignoreline, start_message)
107
144
 
108
 
        if not _run_editor(msgfilename):
 
145
        if not msgfilename or not _run_editor(msgfilename):
109
146
            return None
110
 
        
 
147
 
111
148
        started = False
112
149
        msg = []
113
150
        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
 
            
 
151
        # codecs.open() ALWAYS opens file in binary mode but we need text mode
 
152
        # 'rU' mode useful when bzr.exe used on Cygwin (bialix 20070430)
 
153
        f = file(msgfilename, 'rU')
 
154
        try:
 
155
            try:
 
156
                for line in codecs.getreader(osutils.get_user_encoding())(f):
 
157
                    stripped_line = line.strip()
 
158
                    # strip empty line before the log message starts
 
159
                    if not started:
 
160
                        if stripped_line != "":
 
161
                            started = True
 
162
                        else:
 
163
                            continue
 
164
                    # check for the ignore line only if there
 
165
                    # is additional information at the end
 
166
                    if hasinfo and stripped_line == ignoreline:
 
167
                        break
 
168
                    nlines += 1
 
169
                    # keep track of the last line that had some content
 
170
                    if stripped_line != "":
 
171
                        lastline = nlines
 
172
                    msg.append(line)
 
173
            except UnicodeDecodeError:
 
174
                raise BadCommitMessageEncoding()
 
175
        finally:
 
176
            f.close()
 
177
 
132
178
        if len(msg) == 0:
133
179
            return ""
134
180
        # delete empty lines at the end
144
190
            try:
145
191
                os.unlink(msgfilename)
146
192
            except IOError, e:
147
 
                warning("failed to unlink %s: %s; ignored", msgfilename, e)
 
193
                trace.warning(
 
194
                    "failed to unlink %s: %s; ignored", msgfilename, e)
 
195
 
 
196
 
 
197
def _create_temp_file_with_commit_template(infotext,
 
198
                                           ignoreline=DEFAULT_IGNORE_LINE,
 
199
                                           start_message=None):
 
200
    """Create temp file and write commit template in it.
 
201
 
 
202
    :param infotext:    Text to be displayed at bottom of message
 
203
                        for the user's reference;
 
204
                        currently similar to 'bzr status'.
 
205
                        The text is already encoded.
 
206
 
 
207
    :param ignoreline:  The separator to use above the infotext.
 
208
 
 
209
    :param start_message:   The text to place above the separator, if any.
 
210
                            This will not be removed from the message
 
211
                            after the user has edited it.
 
212
                            The string is already encoded
 
213
 
 
214
    :return:    2-tuple (temp file name, hasinfo)
 
215
    """
 
216
    import tempfile
 
217
    tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
 
218
                                               dir='.',
 
219
                                               text=True)
 
220
    msgfilename = osutils.basename(msgfilename)
 
221
    msgfile = os.fdopen(tmp_fileno, 'w')
 
222
    try:
 
223
        if start_message is not None:
 
224
            msgfile.write("%s\n" % start_message)
 
225
 
 
226
        if infotext is not None and infotext != "":
 
227
            hasinfo = True
 
228
            msgfile.write("\n\n%s\n\n%s" %(ignoreline, infotext))
 
229
        else:
 
230
            hasinfo = False
 
231
    finally:
 
232
        msgfile.close()
 
233
 
 
234
    return (msgfilename, hasinfo)
148
235
 
149
236
 
150
237
def make_commit_message_template(working_tree, specific_files):
152
239
 
153
240
    Returns a unicode string containing the template.
154
241
    """
155
 
    # TODO: Should probably be given the WorkingTree not the branch
156
 
    #
157
242
    # TODO: make provision for this to be overridden or modified by a hook
158
243
    #
159
244
    # TODO: Rather than running the status command, should prepare a draft of
162
247
    from StringIO import StringIO       # must be unicode-safe
163
248
    from bzrlib.status import show_tree_status
164
249
    status_tmp = StringIO()
165
 
    show_tree_status(working_tree, specific_files=specific_files, 
166
 
                     to_file=status_tmp)
 
250
    show_tree_status(working_tree, specific_files=specific_files,
 
251
                     to_file=status_tmp, verbose=True)
167
252
    return status_tmp.getvalue()
 
253
 
 
254
 
 
255
def make_commit_message_template_encoded(working_tree, specific_files,
 
256
                                         diff=None, output_encoding='utf-8'):
 
257
    """Prepare a template file for a commit into a branch.
 
258
 
 
259
    Returns an encoded string.
 
260
    """
 
261
    # TODO: make provision for this to be overridden or modified by a hook
 
262
    #
 
263
    # TODO: Rather than running the status command, should prepare a draft of
 
264
    # the revision to be committed, then pause and ask the user to
 
265
    # confirm/write a message.
 
266
    from StringIO import StringIO       # must be unicode-safe
 
267
    from bzrlib.diff import show_diff_trees
 
268
 
 
269
    template = make_commit_message_template(working_tree, specific_files)
 
270
    template = template.encode(output_encoding, "replace")
 
271
 
 
272
    if diff:
 
273
        stream = StringIO()
 
274
        show_diff_trees(working_tree.basis_tree(),
 
275
                        working_tree, stream, specific_files,
 
276
                        path_encoding=output_encoding)
 
277
        template = template + '\n' + stream.getvalue()
 
278
 
 
279
    return template
 
280
 
 
281
 
 
282
class MessageEditorHooks(Hooks):
 
283
    """A dictionary mapping hook name to a list of callables for message editor
 
284
    hooks.
 
285
 
 
286
    e.g. ['commit_message_template'] is the list of items to be called to
 
287
    generate a commit message template
 
288
    """
 
289
 
 
290
    def __init__(self):
 
291
        """Create the default hooks.
 
292
 
 
293
        These are all empty initially.
 
294
        """
 
295
        Hooks.__init__(self)
 
296
        self.create_hook(HookPoint('commit_message_template',
 
297
            "Called when a commit message is being generated. "
 
298
            "commit_message_template is called with the bzrlib.commit.Commit "
 
299
            "object and the message that is known so far. "
 
300
            "commit_message_template must return a new message to use (which "
 
301
            "could be the same as it was given. When there are multiple "
 
302
            "hooks registered for commit_message_template, they are chained "
 
303
            "with the result from the first passed into the second, and so "
 
304
            "on.", (1, 10), None))
 
305
 
 
306
 
 
307
hooks = MessageEditorHooks()
 
308
 
 
309
 
 
310
def generate_commit_message_template(commit, start_message=None):
 
311
    """Generate a commit message template.
 
312
 
 
313
    :param commit: Commit object for the active commit.
 
314
    :param start_message: Message to start with.
 
315
    :return: A start commit message or None for an empty start commit message.
 
316
    """
 
317
    start_message = None
 
318
    for hook in hooks['commit_message_template']:
 
319
        start_message = hook(commit, start_message)
 
320
    return start_message