← 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: 2010-07-07 21:30:06 UTC
  • mfrom: (5333.1.2 better_pyqt_include)
  • Revision ID: pqm@pqm.ubuntu.com-20100707213006-lriphkkbzwwrl7ne
(jameinel) Use a better list of PyQt includes and excludes. (Gary van der
 Merwe)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/msgeditor.py
1
 
# Copyright (C) 2005, 2006 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
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
 
18
18
"""Commit message editor support."""
19
19
 
20
20
import codecs
21
 
import errno
22
21
import os
23
22
from subprocess import call
24
23
import sys
25
24
 
26
 
import bzrlib
27
 
import bzrlib.config as config
28
 
from bzrlib.errors import BzrError
29
 
from bzrlib.trace import warning, mutter
 
25
from bzrlib import (
 
26
    config,
 
27
    osutils,
 
28
    trace,
 
29
    transport,
 
30
    ui,
 
31
    )
 
32
from bzrlib.errors import BzrError, BadCommitMessageEncoding
 
33
from bzrlib.hooks import HookPoint, Hooks
30
34
 
31
35
 
32
36
def _get_editor():
33
37
    """Return a sequence of possible editor binaries for the current platform"""
34
38
    try:
35
 
        yield os.environ["BZR_EDITOR"]
 
39
        yield os.environ["BZR_EDITOR"], '$BZR_EDITOR'
36
40
    except KeyError:
37
41
        pass
38
42
 
39
43
    e = config.GlobalConfig().get_editor()
40
44
    if e is not None:
41
 
        yield e
42
 
        
 
45
        yield e, config.config_filename()
 
46
 
43
47
    for varname in 'VISUAL', 'EDITOR':
44
48
        if varname in os.environ:
45
 
            yield os.environ[varname]
 
49
            yield os.environ[varname], '$' + varname
46
50
 
47
51
    if sys.platform == 'win32':
48
52
        for editor in 'wordpad.exe', 'notepad.exe':
49
 
            yield editor
 
53
            yield editor, None
50
54
    else:
51
55
        for editor in ['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe']:
52
 
            yield editor
 
56
            yield editor, None
53
57
 
54
58
 
55
59
def _run_editor(filename):
56
60
    """Try to execute an editor to edit the commit message."""
57
 
    for e in _get_editor():
58
 
        edargs = e.split(' ')
 
61
    for candidate, candidate_source in _get_editor():
 
62
        edargs = candidate.split(' ')
59
63
        try:
60
64
            ## mutter("trying editor: %r", (edargs +[filename]))
61
65
            x = call(edargs + [filename])
62
66
        except OSError, e:
63
 
           # We're searching for an editor, so catch safe errors and continue
64
 
           if e.errno in (errno.ENOENT, ):
65
 
               continue
66
 
           raise
 
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
67
76
        if x == 0:
68
77
            return True
69
78
        elif x == 127:
99
108
 
100
109
    :return:    commit message or None.
101
110
    """
 
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
    """
102
139
    msgfilename = None
103
140
    try:
104
141
        msgfilename, hasinfo = _create_temp_file_with_commit_template(
105
142
                                    infotext, ignoreline, start_message)
106
 
 
107
 
        if not msgfilename or not _run_editor(msgfilename):
108
 
            return None
109
 
        
 
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 ""
110
158
        started = False
111
159
        msg = []
112
160
        lastline, nlines = 0, 0
113
161
        # codecs.open() ALWAYS opens file in binary mode but we need text mode
114
162
        # 'rU' mode useful when bzr.exe used on Cygwin (bialix 20070430)
115
163
        f = file(msgfilename, 'rU')
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()
 
164
        try:
 
165
            try:
 
166
                for line in codecs.getreader(osutils.get_user_encoding())(f):
 
167
                    stripped_line = line.strip()
 
168
                    # strip empty line before the log message starts
 
169
                    if not started:
 
170
                        if stripped_line != "":
 
171
                            started = True
 
172
                        else:
 
173
                            continue
 
174
                    # check for the ignore line only if there
 
175
                    # is additional information at the end
 
176
                    if hasinfo and stripped_line == ignoreline:
 
177
                        break
 
178
                    nlines += 1
 
179
                    # keep track of the last line that had some content
 
180
                    if stripped_line != "":
 
181
                        lastline = nlines
 
182
                    msg.append(line)
 
183
            except UnicodeDecodeError:
 
184
                raise BadCommitMessageEncoding()
 
185
        finally:
 
186
            f.close()
134
187
 
135
188
        if len(msg) == 0:
136
189
            return ""
147
200
            try:
148
201
                os.unlink(msgfilename)
149
202
            except IOError, e:
150
 
                warning("failed to unlink %s: %s; ignored", msgfilename, e)
 
203
                trace.warning(
 
204
                    "failed to unlink %s: %s; ignored", msgfilename, e)
151
205
 
152
206
 
153
207
def _create_temp_file_with_commit_template(infotext,
158
212
    :param infotext:    Text to be displayed at bottom of message
159
213
                        for the user's reference;
160
214
                        currently similar to 'bzr status'.
 
215
                        The text is already encoded.
161
216
 
162
217
    :param ignoreline:  The separator to use above the infotext.
163
218
 
164
219
    :param start_message:   The text to place above the separator, if any.
165
220
                            This will not be removed from the message
166
221
                            after the user has edited it.
 
222
                            The string is already encoded
167
223
 
168
224
    :return:    2-tuple (temp file name, hasinfo)
169
225
    """
170
226
    import tempfile
171
227
    tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
172
 
                                               dir=u'.',
 
228
                                               dir='.',
173
229
                                               text=True)
 
230
    msgfilename = osutils.basename(msgfilename)
174
231
    msgfile = os.fdopen(tmp_fileno, 'w')
175
232
    try:
176
233
        if start_message is not None:
177
 
            msgfile.write("%s\n" % start_message.encode(
178
 
                                       bzrlib.user_encoding, 'replace'))
 
234
            msgfile.write("%s\n" % start_message)
179
235
 
180
236
        if infotext is not None and infotext != "":
181
237
            hasinfo = True
182
 
            msgfile.write("\n\n%s\n\n%s" % (ignoreline,
183
 
                          infotext.encode(bzrlib.user_encoding,
184
 
                                                'replace')))
 
238
            msgfile.write("\n\n%s\n\n%s" %(ignoreline, infotext))
185
239
        else:
186
240
            hasinfo = False
187
241
    finally:
195
249
 
196
250
    Returns a unicode string containing the template.
197
251
    """
198
 
    # TODO: Should probably be given the WorkingTree not the branch
199
 
    #
200
252
    # TODO: make provision for this to be overridden or modified by a hook
201
253
    #
202
254
    # TODO: Rather than running the status command, should prepare a draft of
205
257
    from StringIO import StringIO       # must be unicode-safe
206
258
    from bzrlib.status import show_tree_status
207
259
    status_tmp = StringIO()
208
 
    show_tree_status(working_tree, specific_files=specific_files, 
209
 
                     to_file=status_tmp)
 
260
    show_tree_status(working_tree, specific_files=specific_files,
 
261
                     to_file=status_tmp, verbose=True)
210
262
    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