/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: Aaron Bentley
  • Date: 2007-08-29 20:06:09 UTC
  • mto: This revision was merged to the branch mainline in revision 2769.
  • Revision ID: abentley@panoramicfeedback.com-20070829200609-62b03g4cib5s4rkz
Add documentation for hooks

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."""
19
19
 
20
20
import codecs
 
21
import errno
21
22
import os
22
23
from subprocess import call
23
24
import sys
24
25
 
25
 
from bzrlib import (
26
 
    config,
27
 
    osutils,
28
 
    trace,
29
 
    transport,
30
 
    ui,
31
 
    )
 
26
import bzrlib
 
27
import bzrlib.config as config
32
28
from bzrlib.errors import BzrError, BadCommitMessageEncoding
33
 
from bzrlib.hooks import HookPoint, Hooks
 
29
from bzrlib.trace import warning, mutter
34
30
 
35
31
 
36
32
def _get_editor():
37
33
    """Return a sequence of possible editor binaries for the current platform"""
38
34
    try:
39
 
        yield os.environ["BZR_EDITOR"], '$BZR_EDITOR'
 
35
        yield os.environ["BZR_EDITOR"]
40
36
    except KeyError:
41
37
        pass
42
38
 
43
39
    e = config.GlobalConfig().get_editor()
44
40
    if e is not None:
45
 
        yield e, config.config_filename()
46
 
 
 
41
        yield e
 
42
        
47
43
    for varname in 'VISUAL', 'EDITOR':
48
44
        if varname in os.environ:
49
 
            yield os.environ[varname], '$' + varname
 
45
            yield os.environ[varname]
50
46
 
51
47
    if sys.platform == 'win32':
52
48
        for editor in 'wordpad.exe', 'notepad.exe':
53
 
            yield editor, None
 
49
            yield editor
54
50
    else:
55
51
        for editor in ['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe']:
56
 
            yield editor, None
 
52
            yield editor
57
53
 
58
54
 
59
55
def _run_editor(filename):
60
56
    """Try to execute an editor to edit the commit message."""
61
 
    for candidate, candidate_source in _get_editor():
62
 
        edargs = candidate.split(' ')
 
57
    for e in _get_editor():
 
58
        edargs = e.split(' ')
63
59
        try:
64
60
            ## mutter("trying editor: %r", (edargs +[filename]))
65
61
            x = call(edargs + [filename])
66
62
        except OSError, e:
67
 
            if candidate_source is not None:
68
 
                # We tried this editor because some user configuration (an
69
 
                # environment variable or config file) said to try it.  Let
70
 
                # the user know their configuration is broken.
71
 
                trace.warning(
72
 
                    'Could not start editor "%s" (specified by %s): %s\n'
73
 
                    % (candidate, candidate_source, str(e)))
74
 
            continue
75
 
            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
76
67
        if x == 0:
77
68
            return True
78
69
        elif x == 127:
108
99
 
109
100
    :return:    commit message or None.
110
101
    """
111
 
 
112
 
    if not start_message is None:
113
 
        start_message = start_message.encode(osutils.get_user_encoding())
114
 
    infotext = infotext.encode(osutils.get_user_encoding(), 'replace')
115
 
    return edit_commit_message_encoded(infotext, ignoreline, start_message)
116
 
 
117
 
 
118
 
def edit_commit_message_encoded(infotext, ignoreline=DEFAULT_IGNORE_LINE,
119
 
                                start_message=None):
120
 
    """Let the user edit a commit message in a temp file.
121
 
 
122
 
    This is run if they don't give a message or
123
 
    message-containing file on the command line.
124
 
 
125
 
    :param infotext:    Text to be displayed at bottom of message
126
 
                        for the user's reference;
127
 
                        currently similar to 'bzr status'.
128
 
                        The string is already encoded
129
 
 
130
 
    :param ignoreline:  The separator to use above the infotext.
131
 
 
132
 
    :param start_message:   The text to place above the separator, if any.
133
 
                            This will not be removed from the message
134
 
                            after the user has edited it.
135
 
                            The string is already encoded
136
 
 
137
 
    :return:    commit message or None.
138
 
    """
139
102
    msgfilename = None
140
103
    try:
141
104
        msgfilename, hasinfo = _create_temp_file_with_commit_template(
142
105
                                    infotext, ignoreline, start_message)
143
 
        if not msgfilename:
144
 
            return None
145
 
        basename = osutils.basename(msgfilename)
146
 
        msg_transport = transport.get_transport(osutils.dirname(msgfilename))
147
 
        reference_content = msg_transport.get_bytes(basename)
148
 
        if not _run_editor(msgfilename):
149
 
            return None
150
 
        edited_content = msg_transport.get_bytes(basename)
151
 
        if edited_content == reference_content:
152
 
            if not ui.ui_factory.get_boolean(
153
 
                "Commit message was not edited, use anyway"):
154
 
                # Returning "" makes cmd_commit raise 'empty commit message
155
 
                # specified' which is a reasonable error, given the user has
156
 
                # rejected using the unedited template.
157
 
                return ""
 
106
 
 
107
        if not msgfilename or not _run_editor(msgfilename):
 
108
            return None
 
109
        
158
110
        started = False
159
111
        msg = []
160
112
        lastline, nlines = 0, 0
163
115
        f = file(msgfilename, 'rU')
164
116
        try:
165
117
            try:
166
 
                for line in codecs.getreader(osutils.get_user_encoding())(f):
 
118
                for line in codecs.getreader(bzrlib.user_encoding)(f):
167
119
                    stripped_line = line.strip()
168
120
                    # strip empty line before the log message starts
169
121
                    if not started:
200
152
            try:
201
153
                os.unlink(msgfilename)
202
154
            except IOError, e:
203
 
                trace.warning(
204
 
                    "failed to unlink %s: %s; ignored", msgfilename, e)
 
155
                warning("failed to unlink %s: %s; ignored", msgfilename, e)
205
156
 
206
157
 
207
158
def _create_temp_file_with_commit_template(infotext,
212
163
    :param infotext:    Text to be displayed at bottom of message
213
164
                        for the user's reference;
214
165
                        currently similar to 'bzr status'.
215
 
                        The text is already encoded.
216
166
 
217
167
    :param ignoreline:  The separator to use above the infotext.
218
168
 
219
169
    :param start_message:   The text to place above the separator, if any.
220
170
                            This will not be removed from the message
221
171
                            after the user has edited it.
222
 
                            The string is already encoded
223
172
 
224
173
    :return:    2-tuple (temp file name, hasinfo)
225
174
    """
226
175
    import tempfile
227
176
    tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
228
 
                                               dir='.',
 
177
                                               dir=u'.',
229
178
                                               text=True)
230
 
    msgfilename = osutils.basename(msgfilename)
231
179
    msgfile = os.fdopen(tmp_fileno, 'w')
232
180
    try:
233
181
        if start_message is not None:
234
 
            msgfile.write("%s\n" % start_message)
 
182
            msgfile.write("%s\n" % start_message.encode(
 
183
                                       bzrlib.user_encoding, 'replace'))
235
184
 
236
185
        if infotext is not None and infotext != "":
237
186
            hasinfo = True
238
 
            msgfile.write("\n\n%s\n\n%s" %(ignoreline, infotext))
 
187
            msgfile.write("\n\n%s\n\n%s" % (ignoreline,
 
188
                          infotext.encode(bzrlib.user_encoding,
 
189
                                                'replace')))
239
190
        else:
240
191
            hasinfo = False
241
192
    finally:
249
200
 
250
201
    Returns a unicode string containing the template.
251
202
    """
 
203
    # TODO: Should probably be given the WorkingTree not the branch
 
204
    #
252
205
    # TODO: make provision for this to be overridden or modified by a hook
253
206
    #
254
207
    # TODO: Rather than running the status command, should prepare a draft of
257
210
    from StringIO import StringIO       # must be unicode-safe
258
211
    from bzrlib.status import show_tree_status
259
212
    status_tmp = StringIO()
260
 
    show_tree_status(working_tree, specific_files=specific_files,
261
 
                     to_file=status_tmp, verbose=True)
 
213
    show_tree_status(working_tree, specific_files=specific_files, 
 
214
                     to_file=status_tmp)
262
215
    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)
306
 
        self.create_hook(HookPoint('commit_message_template',
307
 
            "Called when a commit message is being generated. "
308
 
            "commit_message_template is called with the bzrlib.commit.Commit "
309
 
            "object and the message that is known so far. "
310
 
            "commit_message_template must return a new message to use (which "
311
 
            "could be the same as it was given. When there are multiple "
312
 
            "hooks registered for commit_message_template, they are chained "
313
 
            "with the result from the first passed into the second, and so "
314
 
            "on.", (1, 10), None))
315
 
 
316
 
 
317
 
hooks = MessageEditorHooks()
318
 
 
319
 
 
320
 
def generate_commit_message_template(commit, start_message=None):
321
 
    """Generate a commit message template.
322
 
 
323
 
    :param commit: Commit object for the active commit.
324
 
    :param start_message: Message to start with.
325
 
    :return: A start commit message or None for an empty start commit message.
326
 
    """
327
 
    start_message = None
328
 
    for hook in hooks['commit_message_template']:
329
 
        start_message = hook(commit, start_message)
330
 
    return start_message