← 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-08-28 08:23:40 UTC
  • mfrom: (2757.1.1 ianc-integration)
  • Revision ID: pqm@pqm.ubuntu.com-20070828082340-2byilw23kzl3cjx4
(Daniel Watkins) Better explanation of -r in uncommit help

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