← 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: 2007-06-18 03:33:56 UTC
  • mfrom: (2527.1.1 breakin)
  • Revision ID: pqm@pqm.ubuntu.com-20070618033356-q24jtmuwbf03ojvd
Fix race in test_breakin_harder that can cause test suite hang.

Show diffs side-by-side

added added

removed removed

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