← 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-06-18 05:22:35 UTC
  • mfrom: (1551.15.27 Aaron's mergeable stuff)
  • Revision ID: pqm@pqm.ubuntu.com-20070618052235-mvns8j28szyzscy0
Turn list-weave into list-versionedfile

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/msgeditor.py
25
25
 
26
26
import bzrlib
27
27
import bzrlib.config as config
28
 
from bzrlib import osutils
29
 
from bzrlib.errors import BzrError, BadCommitMessageEncoding
 
28
from bzrlib.errors import BzrError
30
29
from bzrlib.trace import warning, mutter
31
30
 
32
31
 
100
99
 
101
100
    :return:    commit message or None.
102
101
    """
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
102
    msgfilename = None
132
103
    try:
133
104
        msgfilename, hasinfo = _create_temp_file_with_commit_template(
142
113
        # codecs.open() ALWAYS opens file in binary mode but we need text mode
143
114
        # 'rU' mode useful when bzr.exe used on Cygwin (bialix 20070430)
144
115
        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()
 
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()
168
134
 
169
135
        if len(msg) == 0:
170
136
            return ""
192
158
    :param infotext:    Text to be displayed at bottom of message
193
159
                        for the user's reference;
194
160
                        currently similar to 'bzr status'.
195
 
                        The text is already encoded.
196
161
 
197
162
    :param ignoreline:  The separator to use above the infotext.
198
163
 
199
164
    :param start_message:   The text to place above the separator, if any.
200
165
                            This will not be removed from the message
201
166
                            after the user has edited it.
202
 
                            The string is already encoded
203
167
 
204
168
    :return:    2-tuple (temp file name, hasinfo)
205
169
    """
206
170
    import tempfile
207
171
    tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
208
 
                                               dir='.',
 
172
                                               dir=u'.',
209
173
                                               text=True)
210
 
    msgfilename = osutils.basename(msgfilename)
211
174
    msgfile = os.fdopen(tmp_fileno, 'w')
212
175
    try:
213
176
        if start_message is not None:
214
 
            msgfile.write("%s\n" % start_message)
 
177
            msgfile.write("%s\n" % start_message.encode(
 
178
                                       bzrlib.user_encoding, 'replace'))
215
179
 
216
180
        if infotext is not None and infotext != "":
217
181
            hasinfo = True
218
 
            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')))
219
185
        else:
220
186
            hasinfo = False
221
187
    finally:
229
195
 
230
196
    Returns a unicode string containing the template.
231
197
    """
 
198
    # TODO: Should probably be given the WorkingTree not the branch
 
199
    #
232
200
    # TODO: make provision for this to be overridden or modified by a hook
233
201
    #
234
202
    # TODO: Rather than running the status command, should prepare a draft of
240
208
    show_tree_status(working_tree, specific_files=specific_files, 
241
209
                     to_file=status_tmp)
242
210
    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