← 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: 2008-05-29 15:57:16 UTC
  • mfrom: (3427.5.9 dep_warnings)
  • Revision ID: pqm@pqm.ubuntu.com-20080529155716-0w3kic8lioa63231
(jam) Enable Deprecation Warnings when running -Werror and when
        running selftest

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/msgeditor.py
1
 
# Bazaar-NG -- distributed version control
2
 
 
3
 
# Copyright (C) 2005 by Canonical Ltd
4
 
 
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
 
2
#
5
3
# This program is free software; you can redistribute it and/or modify
6
4
# it under the terms of the GNU General Public License as published by
7
5
# the Free Software Foundation; either version 2 of the License, or
8
6
# (at your option) any later version.
9
 
 
 
7
#
10
8
# This program is distributed in the hope that it will be useful,
11
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13
11
# GNU General Public License for more details.
14
 
 
 
12
#
15
13
# You should have received a copy of the GNU General Public License
16
14
# along with this program; if not, write to the Free Software
17
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19
17
 
20
18
"""Commit message editor support."""
21
19
 
 
20
import codecs
 
21
import errno
22
22
import os
23
 
import errno
24
23
from subprocess import call
 
24
import sys
25
25
 
 
26
import bzrlib
26
27
import bzrlib.config as config
27
 
from bzrlib.errors import BzrError
 
28
from bzrlib import osutils
 
29
from bzrlib.errors import BzrError, BadCommitMessageEncoding
 
30
from bzrlib.trace import warning, mutter
 
31
 
28
32
 
29
33
def _get_editor():
30
34
    """Return a sequence of possible editor binaries for the current platform"""
37
41
    if e is not None:
38
42
        yield e
39
43
        
40
 
    try:
41
 
        yield os.environ["EDITOR"]
42
 
    except KeyError:
43
 
        pass
 
44
    for varname in 'VISUAL', 'EDITOR':
 
45
        if varname in os.environ:
 
46
            yield os.environ[varname]
44
47
 
45
 
    if os.name == "nt":
46
 
        yield "notepad.exe"
47
 
    elif os.name == "posix":
48
 
        yield "/usr/bin/vi"
 
48
    if sys.platform == 'win32':
 
49
        for editor in 'wordpad.exe', 'notepad.exe':
 
50
            yield editor
 
51
    else:
 
52
        for editor in ['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe']:
 
53
            yield editor
49
54
 
50
55
 
51
56
def _run_editor(filename):
53
58
    for e in _get_editor():
54
59
        edargs = e.split(' ')
55
60
        try:
 
61
            ## mutter("trying editor: %r", (edargs +[filename]))
56
62
            x = call(edargs + [filename])
57
63
        except OSError, e:
58
 
           # ENOENT means no such editor
59
 
           if e.errno == errno.ENOENT:
60
 
               continue
61
 
           raise
 
64
            # We're searching for an editor, so catch safe errors and continue
 
65
            if e.errno in (errno.ENOENT, ):
 
66
                continue
 
67
            raise
62
68
        if x == 0:
63
69
            return True
64
70
        elif x == 127:
65
71
            continue
66
72
        else:
67
73
            break
68
 
    raise BzrError("Could not start any editor. "
69
 
                   "Please specify $EDITOR or use ~/.bzr.conf/editor")
 
74
    raise BzrError("Could not start any editor.\nPlease specify one with:\n"
 
75
                   " - $BZR_EDITOR\n - editor=/some/path in %s\n"
 
76
                   " - $VISUAL\n - $EDITOR" % \
 
77
                    config.config_filename())
70
78
 
71
79
 
72
80
DEFAULT_IGNORE_LINE = "%(bar)s %(msg)s %(bar)s" % \
73
81
    { 'bar' : '-' * 14, 'msg' : 'This line and the following will be ignored' }
74
82
 
75
83
 
76
 
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE):
77
 
    """Let the user edit a commit message in a temp file.
78
 
 
79
 
    This is run if they don't give a message or
80
 
    message-containing file on the command line.
81
 
 
82
 
    infotext:
83
 
        Text to be displayed at bottom of message for
84
 
        the user's reference; currently similar to
85
 
        'bzr status'.
86
 
    """
87
 
    import tempfile
88
 
 
 
84
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE,
 
85
                        start_message=None):
 
86
    """Let the user edit a commit message in a temp file.
 
87
 
 
88
    This is run if they don't give a message or
 
89
    message-containing file on the command line.
 
90
 
 
91
    :param infotext:    Text to be displayed at bottom of message
 
92
                        for the user's reference;
 
93
                        currently similar to 'bzr status'.
 
94
 
 
95
    :param ignoreline:  The separator to use above the infotext.
 
96
 
 
97
    :param start_message:   The text to place above the separator, if any.
 
98
                            This will not be removed from the message
 
99
                            after the user has edited it.
 
100
 
 
101
    :return:    commit message or None.
 
102
    """
 
103
 
 
104
    if not start_message is None:
 
105
        start_message = start_message.encode(bzrlib.user_encoding)
 
106
    infotext = infotext.encode(bzrlib.user_encoding, 'replace')
 
107
    return edit_commit_message_encoded(infotext, ignoreline, start_message)
 
108
 
 
109
 
 
110
def edit_commit_message_encoded(infotext, ignoreline=DEFAULT_IGNORE_LINE,
 
111
                                start_message=None):
 
112
    """Let the user edit a commit message in a temp file.
 
113
 
 
114
    This is run if they don't give a message or
 
115
    message-containing file on the command line.
 
116
 
 
117
    :param infotext:    Text to be displayed at bottom of message
 
118
                        for the user's reference;
 
119
                        currently similar to 'bzr status'.
 
120
                        The string is already encoded
 
121
 
 
122
    :param ignoreline:  The separator to use above the infotext.
 
123
 
 
124
    :param start_message:   The text to place above the separator, if any.
 
125
                            This will not be removed from the message
 
126
                            after the user has edited it.
 
127
                            The string is already encoded
 
128
 
 
129
    :return:    commit message or None.
 
130
    """
 
131
    msgfilename = None
89
132
    try:
90
 
        tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.', dir=u'.')
91
 
        msgfile = os.close(tmp_fileno)
92
 
        if infotext is not None and infotext != "":
93
 
            hasinfo = True
94
 
            msgfile = file(msgfilename, "w")
95
 
            msgfile.write("\n\n%s\n\n%s" % (ignoreline, infotext))
96
 
            msgfile.close()
97
 
        else:
98
 
            hasinfo = False
 
133
        msgfilename, hasinfo = _create_temp_file_with_commit_template(
 
134
                                    infotext, ignoreline, start_message)
99
135
 
100
 
        if not _run_editor(msgfilename):
 
136
        if not msgfilename or not _run_editor(msgfilename):
101
137
            return None
102
138
        
103
139
        started = False
104
140
        msg = []
105
141
        lastline, nlines = 0, 0
106
 
        for line in file(msgfilename, "r"):
107
 
            stripped_line = line.strip()
108
 
            # strip empty line before the log message starts
109
 
            if not started:
110
 
                if stripped_line != "":
111
 
                    started = True
112
 
                else:
113
 
                    continue
114
 
            # check for the ignore line only if there
115
 
            # is additional information at the end
116
 
            if hasinfo and stripped_line == ignoreline:
117
 
                break
118
 
            nlines += 1
119
 
            # keep track of the last line that had some content
120
 
            if stripped_line != "":
121
 
                lastline = nlines
122
 
            msg.append(line)
123
 
            
 
142
        # codecs.open() ALWAYS opens file in binary mode but we need text mode
 
143
        # 'rU' mode useful when bzr.exe used on Cygwin (bialix 20070430)
 
144
        f = file(msgfilename, 'rU')
 
145
        try:
 
146
            try:
 
147
                for line in codecs.getreader(bzrlib.user_encoding)(f):
 
148
                    stripped_line = line.strip()
 
149
                    # strip empty line before the log message starts
 
150
                    if not started:
 
151
                        if stripped_line != "":
 
152
                            started = True
 
153
                        else:
 
154
                            continue
 
155
                    # check for the ignore line only if there
 
156
                    # is additional information at the end
 
157
                    if hasinfo and stripped_line == ignoreline:
 
158
                        break
 
159
                    nlines += 1
 
160
                    # keep track of the last line that had some content
 
161
                    if stripped_line != "":
 
162
                        lastline = nlines
 
163
                    msg.append(line)
 
164
            except UnicodeDecodeError:
 
165
                raise BadCommitMessageEncoding()
 
166
        finally:
 
167
            f.close()
 
168
 
124
169
        if len(msg) == 0:
125
170
            return ""
126
171
        # delete empty lines at the end
132
177
            return "".join(msg)
133
178
    finally:
134
179
        # delete the msg file in any case
135
 
        try: os.unlink(msgfilename)
136
 
        except IOError: pass
 
180
        if msgfilename is not None:
 
181
            try:
 
182
                os.unlink(msgfilename)
 
183
            except IOError, e:
 
184
                warning("failed to unlink %s: %s; ignored", msgfilename, e)
 
185
 
 
186
 
 
187
def _create_temp_file_with_commit_template(infotext,
 
188
                                           ignoreline=DEFAULT_IGNORE_LINE,
 
189
                                           start_message=None):
 
190
    """Create temp file and write commit template in it.
 
191
 
 
192
    :param infotext:    Text to be displayed at bottom of message
 
193
                        for the user's reference;
 
194
                        currently similar to 'bzr status'.
 
195
                        The text is already encoded.
 
196
 
 
197
    :param ignoreline:  The separator to use above the infotext.
 
198
 
 
199
    :param start_message:   The text to place above the separator, if any.
 
200
                            This will not be removed from the message
 
201
                            after the user has edited it.
 
202
                            The string is already encoded
 
203
 
 
204
    :return:    2-tuple (temp file name, hasinfo)
 
205
    """
 
206
    import tempfile
 
207
    tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
 
208
                                               dir='.',
 
209
                                               text=True)
 
210
    msgfilename = osutils.basename(msgfilename)
 
211
    msgfile = os.fdopen(tmp_fileno, 'w')
 
212
    try:
 
213
        if start_message is not None:
 
214
            msgfile.write("%s\n" % start_message)
 
215
 
 
216
        if infotext is not None and infotext != "":
 
217
            hasinfo = True
 
218
            msgfile.write("\n\n%s\n\n%s" %(ignoreline, infotext))
 
219
        else:
 
220
            hasinfo = False
 
221
    finally:
 
222
        msgfile.close()
 
223
 
 
224
    return (msgfilename, hasinfo)
137
225
 
138
226
 
139
227
def make_commit_message_template(working_tree, specific_files):
141
229
 
142
230
    Returns a unicode string containing the template.
143
231
    """
144
 
    # TODO: Should probably be given the WorkingTree not the branch
145
 
    #
146
232
    # TODO: make provision for this to be overridden or modified by a hook
147
233
    #
148
234
    # TODO: Rather than running the status command, should prepare a draft of
154
240
    show_tree_status(working_tree, specific_files=specific_files, 
155
241
                     to_file=status_tmp)
156
242
    return status_tmp.getvalue()
 
243
 
 
244
 
 
245
def make_commit_message_template_encoded(working_tree, specific_files,
 
246
                                         diff=None, output_encoding='utf-8'):
 
247
    """Prepare a template file for a commit into a branch.
 
248
 
 
249
    Returns an encoded string.
 
250
    """
 
251
    # TODO: make provision for this to be overridden or modified by a hook
 
252
    #
 
253
    # TODO: Rather than running the status command, should prepare a draft of
 
254
    # the revision to be committed, then pause and ask the user to
 
255
    # confirm/write a message.
 
256
    from StringIO import StringIO       # must be unicode-safe
 
257
    from bzrlib.diff import show_diff_trees
 
258
 
 
259
    template = make_commit_message_template(working_tree, specific_files)
 
260
    template = template.encode(output_encoding, "replace")
 
261
 
 
262
    if diff:
 
263
        stream = StringIO()
 
264
        show_diff_trees(working_tree.basis_tree(),
 
265
                        working_tree, stream, specific_files,
 
266
                        path_encoding=output_encoding)
 
267
        template = template + '\n' + stream.getvalue()
 
268
 
 
269
    return template