/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 23:41:35 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506234135-yivbzczw1sejxnxc
Lock methods on ``Tree``, ``Branch`` and ``Repository`` are now
expected to return an object which can be used to unlock them. This reduces
duplicate code when using cleanups. The previous 'tokens's returned by
``Branch.lock_write`` and ``Repository.lock_write`` are now attributes
on the result of the lock_write. ``repository.RepositoryWriteLockResult``
and ``branch.BranchWriteLockResult`` document this. (Robert Collins)

``log._get_info_for_log_files`` now takes an add_cleanup callable.
(Robert Collins)

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