/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/msgeditor.py

  • Committer: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

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-2010 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
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
 
17
18
"""Commit message editor support."""
18
19
 
19
 
from __future__ import absolute_import
20
 
 
21
20
import codecs
22
21
import os
23
22
from subprocess import call
24
23
import sys
25
24
 
26
 
from . import (
27
 
    cmdline,
 
25
from bzrlib import (
28
26
    config,
29
27
    osutils,
30
28
    trace,
31
29
    transport,
32
30
    ui,
33
31
    )
34
 
from .errors import BzrError
35
 
from .hooks import Hooks
36
 
from .sixish import (
37
 
    BytesIO,
38
 
    StringIO,
39
 
    )
40
 
 
41
 
 
42
 
class BadCommitMessageEncoding(BzrError):
43
 
 
44
 
    _fmt = 'The specified commit message contains characters unsupported by '\
45
 
        'the current encoding.'
 
32
from bzrlib.errors import BzrError, BadCommitMessageEncoding
 
33
from bzrlib.hooks import HookPoint, Hooks
46
34
 
47
35
 
48
36
def _get_editor():
49
 
    """Return sequence of possible editor binaries for the current platform"""
 
37
    """Return a sequence of possible editor binaries for the current platform"""
50
38
    try:
51
 
        yield os.environ["BRZ_EDITOR"], '$BRZ_EDITOR'
 
39
        yield os.environ["BZR_EDITOR"], '$BZR_EDITOR'
52
40
    except KeyError:
53
41
        pass
54
42
 
55
 
    e = config.GlobalStack().get('editor')
 
43
    e = config.GlobalConfig().get_editor()
56
44
    if e is not None:
57
45
        yield e, config.config_filename()
58
46
 
71
59
def _run_editor(filename):
72
60
    """Try to execute an editor to edit the commit message."""
73
61
    for candidate, candidate_source in _get_editor():
74
 
        edargs = cmdline.split(candidate)
 
62
        edargs = candidate.split(' ')
75
63
        try:
 
64
            ## mutter("trying editor: %r", (edargs +[filename]))
76
65
            x = call(edargs + [filename])
77
 
        except OSError as e:
 
66
        except OSError, e:
78
67
            if candidate_source is not None:
79
68
                # We tried this editor because some user configuration (an
80
69
                # environment variable or config file) said to try it.  Let
91
80
        else:
92
81
            break
93
82
    raise BzrError("Could not start any editor.\nPlease specify one with:\n"
94
 
                   " - $BRZ_EDITOR\n - editor=/some/path in %s\n"
95
 
                   " - $VISUAL\n - $EDITOR" %
96
 
                   config.config_filename())
 
83
                   " - $BZR_EDITOR\n - editor=/some/path in %s\n"
 
84
                   " - $VISUAL\n - $EDITOR" % \
 
85
                    config.config_filename())
97
86
 
98
87
 
99
88
DEFAULT_IGNORE_LINE = "%(bar)s %(msg)s %(bar)s" % \
100
 
    {'bar': '-' * 14, 'msg': 'This line and the following will be ignored'}
 
89
    { 'bar' : '-' * 14, 'msg' : 'This line and the following will be ignored' }
101
90
 
102
91
 
103
92
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE,
120
109
    :return:    commit message or None.
121
110
    """
122
111
 
123
 
    if start_message is not None:
 
112
    if not start_message is None:
124
113
        start_message = start_message.encode(osutils.get_user_encoding())
125
114
    infotext = infotext.encode(osutils.get_user_encoding(), 'replace')
126
115
    return edit_commit_message_encoded(infotext, ignoreline, start_message)
150
139
    msgfilename = None
151
140
    try:
152
141
        msgfilename, hasinfo = _create_temp_file_with_commit_template(
153
 
            infotext, ignoreline, start_message)
 
142
                                    infotext, ignoreline, start_message)
154
143
        if not msgfilename:
155
144
            return None
156
145
        basename = osutils.basename(msgfilename)
157
 
        msg_transport = transport.get_transport_from_path(
158
 
            osutils.dirname(msgfilename))
 
146
        msg_transport = transport.get_transport(osutils.dirname(msgfilename))
159
147
        reference_content = msg_transport.get_bytes(basename)
160
148
        if not _run_editor(msgfilename):
161
149
            return None
162
150
        edited_content = msg_transport.get_bytes(basename)
163
151
        if edited_content == reference_content:
164
 
            if not ui.ui_factory.confirm_action(
165
 
                u"Commit message was not edited, use anyway",
166
 
                "breezy.msgeditor.unchanged",
167
 
                    {}):
 
152
            if not ui.ui_factory.get_boolean(
 
153
                "Commit message was not edited, use anyway"):
168
154
                # Returning "" makes cmd_commit raise 'empty commit message
169
155
                # specified' which is a reasonable error, given the user has
170
156
                # rejected using the unedited template.
172
158
        started = False
173
159
        msg = []
174
160
        lastline, nlines = 0, 0
175
 
        with codecs.open(msgfilename, mode='rb', encoding=osutils.get_user_encoding()) as f:
 
161
        # codecs.open() ALWAYS opens file in binary mode but we need text mode
 
162
        # 'rU' mode useful when bzr.exe used on Cygwin (bialix 20070430)
 
163
        f = file(msgfilename, 'rU')
 
164
        try:
176
165
            try:
177
 
                for line in f:
 
166
                for line in codecs.getreader(osutils.get_user_encoding())(f):
178
167
                    stripped_line = line.strip()
179
168
                    # strip empty line before the log message starts
180
169
                    if not started:
193
182
                    msg.append(line)
194
183
            except UnicodeDecodeError:
195
184
                raise BadCommitMessageEncoding()
 
185
        finally:
 
186
            f.close()
196
187
 
197
188
        if len(msg) == 0:
198
189
            return ""
208
199
        if msgfilename is not None:
209
200
            try:
210
201
                os.unlink(msgfilename)
211
 
            except IOError as e:
 
202
            except IOError, e:
212
203
                trace.warning(
213
204
                    "failed to unlink %s: %s; ignored", msgfilename, e)
214
205
 
215
206
 
216
207
def _create_temp_file_with_commit_template(infotext,
217
208
                                           ignoreline=DEFAULT_IGNORE_LINE,
218
 
                                           start_message=None,
219
 
                                           tmpdir=None):
 
209
                                           start_message=None):
220
210
    """Create temp file and write commit template in it.
221
211
 
222
 
    :param infotext: Text to be displayed at bottom of message for the
223
 
        user's reference; currently similar to 'bzr status'.  The text is
224
 
        already encoded.
 
212
    :param infotext:    Text to be displayed at bottom of message
 
213
                        for the user's reference;
 
214
                        currently similar to 'bzr status'.
 
215
                        The text is already encoded.
225
216
 
226
217
    :param ignoreline:  The separator to use above the infotext.
227
218
 
228
 
    :param start_message: The text to place above the separator, if any.
229
 
        This will not be removed from the message after the user has edited
230
 
        it.  The string is already encoded
 
219
    :param start_message:   The text to place above the separator, if any.
 
220
                            This will not be removed from the message
 
221
                            after the user has edited it.
 
222
                            The string is already encoded
231
223
 
232
224
    :return:    2-tuple (temp file name, hasinfo)
233
225
    """
234
226
    import tempfile
235
227
    tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
236
 
                                               dir=tmpdir, text=True)
237
 
    with os.fdopen(tmp_fileno, 'wb') as msgfile:
 
228
                                               dir='.',
 
229
                                               text=True)
 
230
    msgfilename = osutils.basename(msgfilename)
 
231
    msgfile = os.fdopen(tmp_fileno, 'w')
 
232
    try:
238
233
        if start_message is not None:
239
 
            msgfile.write(b"%s\n" % start_message)
 
234
            msgfile.write("%s\n" % start_message)
240
235
 
241
236
        if infotext is not None and infotext != "":
242
237
            hasinfo = True
243
 
            trailer = b"\n\n%s\n\n%s" % (
244
 
                ignoreline.encode(osutils.get_user_encoding()), infotext)
245
 
            msgfile.write(trailer)
 
238
            msgfile.write("\n\n%s\n\n%s" %(ignoreline, infotext))
246
239
        else:
247
240
            hasinfo = False
 
241
    finally:
 
242
        msgfile.close()
248
243
 
249
244
    return (msgfilename, hasinfo)
250
245
 
259
254
    # TODO: Rather than running the status command, should prepare a draft of
260
255
    # the revision to be committed, then pause and ask the user to
261
256
    # confirm/write a message.
262
 
    from .status import show_tree_status
 
257
    from StringIO import StringIO       # must be unicode-safe
 
258
    from bzrlib.status import show_tree_status
263
259
    status_tmp = StringIO()
264
260
    show_tree_status(working_tree, specific_files=specific_files,
265
261
                     to_file=status_tmp, verbose=True)
277
273
    # TODO: Rather than running the status command, should prepare a draft of
278
274
    # the revision to be committed, then pause and ask the user to
279
275
    # confirm/write a message.
280
 
    from .diff import show_diff_trees
 
276
    from StringIO import StringIO       # must be unicode-safe
 
277
    from bzrlib.diff import show_diff_trees
281
278
 
282
279
    template = make_commit_message_template(working_tree, specific_files)
283
280
    template = template.encode(output_encoding, "replace")
284
281
 
285
282
    if diff:
286
 
        stream = BytesIO()
 
283
        stream = StringIO()
287
284
        show_diff_trees(working_tree.basis_tree(),
288
285
                        working_tree, stream, specific_files,
289
286
                        path_encoding=output_encoding)
290
 
        template = template + b'\n' + stream.getvalue()
 
287
        template = template + '\n' + stream.getvalue()
291
288
 
292
289
    return template
293
290
 
305
302
 
306
303
        These are all empty initially.
307
304
        """
308
 
        Hooks.__init__(self, "breezy.msgeditor", "hooks")
309
 
        self.add_hook(
310
 
            'set_commit_message',
311
 
            "Set a fixed commit message. "
312
 
            "set_commit_message is called with the "
313
 
            "breezy.commit.Commit object (so you can also change e.g. "
314
 
            "revision properties by editing commit.builder._revprops) and the "
315
 
            "message so far. set_commit_message must return the message to "
316
 
            "use or None if it should use the message editor as normal.",
317
 
            (2, 4))
318
 
        self.add_hook(
319
 
            'commit_message_template',
 
305
        Hooks.__init__(self)
 
306
        self.create_hook(HookPoint('commit_message_template',
320
307
            "Called when a commit message is being generated. "
321
 
            "commit_message_template is called with the breezy.commit.Commit "
 
308
            "commit_message_template is called with the bzrlib.commit.Commit "
322
309
            "object and the message that is known so far. "
323
310
            "commit_message_template must return a new message to use (which "
324
 
            "could be the same as it was given). When there are multiple "
 
311
            "could be the same as it was given. When there are multiple "
325
312
            "hooks registered for commit_message_template, they are chained "
326
313
            "with the result from the first passed into the second, and so "
327
 
            "on.", (1, 10))
 
314
            "on.", (1, 10), None))
328
315
 
329
316
 
330
317
hooks = MessageEditorHooks()
331
318
 
332
319
 
333
 
def set_commit_message(commit, start_message=None):
334
 
    """Sets the commit message.
335
 
    :param commit: Commit object for the active commit.
336
 
    :return: The commit message or None to continue using the message editor
337
 
    """
338
 
    start_message = None
339
 
    for hook in hooks['set_commit_message']:
340
 
        start_message = hook(commit, start_message)
341
 
    return start_message
342
 
 
343
 
 
344
320
def generate_commit_message_template(commit, start_message=None):
345
321
    """Generate a commit message template.
346
322