← 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-10-16 21:31:35 UTC
  • mfrom: (3363.19.4 fix-iter-changes)
  • Revision ID: pqm@pqm.ubuntu.com-20081016213135-0115pw9c95l2dyxq
PreviewTree.iter_changes accepts all standard parameters (abentley)

Show diffs side-by-side

added added

removed removed

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