/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/msgeditor.py

  • Committer: Gustav Hartvigsson
  • Date: 2021-01-09 21:36:27 UTC
  • Revision ID: gustav.hartvigsson@gmail.com-20210109213627-h1xwcutzy9m7a99b
Added 'Case Preserving Working Tree Use Cases' from Canonical Wiki

* Addod a page from the Canonical Bazaar wiki
  with information on the scmeatics of case
  perserving filesystems an a case insensitive
  filesystem works.
  
  * Needs re-work, but this will do as it is the
    same inforamoton as what was on the linked
    page in the currint documentation.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/msgeditor.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 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
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
 
18
17
"""Commit message editor support."""
19
18
 
20
19
import codecs
 
20
from io import (
 
21
    BytesIO,
 
22
    StringIO,
 
23
    )
21
24
import os
22
25
from subprocess import call
23
26
import sys
24
27
 
25
 
from bzrlib import (
 
28
from . import (
 
29
    bedding,
 
30
    cmdline,
26
31
    config,
27
32
    osutils,
28
33
    trace,
29
34
    transport,
30
35
    ui,
31
36
    )
32
 
from bzrlib.errors import BzrError, BadCommitMessageEncoding
33
 
from bzrlib.hooks import HookPoint, Hooks
 
37
from .errors import BzrError
 
38
from .hooks import Hooks
 
39
 
 
40
 
 
41
class BadCommitMessageEncoding(BzrError):
 
42
 
 
43
    _fmt = 'The specified commit message contains characters unsupported by '\
 
44
        'the current encoding.'
34
45
 
35
46
 
36
47
def _get_editor():
37
 
    """Return a sequence of possible editor binaries for the current platform"""
 
48
    """Return sequence of possible editor binaries for the current platform"""
38
49
    try:
39
 
        yield os.environ["BZR_EDITOR"], '$BZR_EDITOR'
 
50
        yield os.environ["BRZ_EDITOR"], '$BRZ_EDITOR'
40
51
    except KeyError:
41
52
        pass
42
53
 
43
 
    e = config.GlobalConfig().get_editor()
 
54
    e = config.GlobalStack().get('editor')
44
55
    if e is not None:
45
 
        yield e, config.config_filename()
 
56
        yield e, bedding.config_path()
46
57
 
47
58
    for varname in 'VISUAL', 'EDITOR':
48
59
        if varname in os.environ:
59
70
def _run_editor(filename):
60
71
    """Try to execute an editor to edit the commit message."""
61
72
    for candidate, candidate_source in _get_editor():
62
 
        edargs = candidate.split(' ')
 
73
        edargs = cmdline.split(candidate)
63
74
        try:
64
 
            ## mutter("trying editor: %r", (edargs +[filename]))
65
75
            x = call(edargs + [filename])
66
 
        except OSError, e:
 
76
        except OSError as e:
67
77
            if candidate_source is not None:
68
78
                # We tried this editor because some user configuration (an
69
79
                # environment variable or config file) said to try it.  Let
80
90
        else:
81
91
            break
82
92
    raise BzrError("Could not start any editor.\nPlease specify one with:\n"
83
 
                   " - $BZR_EDITOR\n - editor=/some/path in %s\n"
84
 
                   " - $VISUAL\n - $EDITOR" % \
85
 
                    config.config_filename())
 
93
                   " - $BRZ_EDITOR\n - editor=/some/path in %s\n"
 
94
                   " - $VISUAL\n - $EDITOR" %
 
95
                   bedding.config_path())
86
96
 
87
97
 
88
98
DEFAULT_IGNORE_LINE = "%(bar)s %(msg)s %(bar)s" % \
89
 
    { 'bar' : '-' * 14, 'msg' : 'This line and the following will be ignored' }
 
99
    {'bar': '-' * 14, 'msg': 'This line and the following will be ignored'}
90
100
 
91
101
 
92
102
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE,
109
119
    :return:    commit message or None.
110
120
    """
111
121
 
112
 
    if not start_message is None:
 
122
    if start_message is not None:
113
123
        start_message = start_message.encode(osutils.get_user_encoding())
114
124
    infotext = infotext.encode(osutils.get_user_encoding(), 'replace')
115
125
    return edit_commit_message_encoded(infotext, ignoreline, start_message)
139
149
    msgfilename = None
140
150
    try:
141
151
        msgfilename, hasinfo = _create_temp_file_with_commit_template(
142
 
                                    infotext, ignoreline, start_message)
 
152
            infotext, ignoreline, start_message)
143
153
        if not msgfilename:
144
154
            return None
145
155
        basename = osutils.basename(msgfilename)
146
 
        msg_transport = transport.get_transport(osutils.dirname(msgfilename))
 
156
        msg_transport = transport.get_transport_from_path(
 
157
            osutils.dirname(msgfilename))
147
158
        reference_content = msg_transport.get_bytes(basename)
148
159
        if not _run_editor(msgfilename):
149
160
            return None
150
161
        edited_content = msg_transport.get_bytes(basename)
151
162
        if edited_content == reference_content:
152
 
            if not ui.ui_factory.get_boolean(
153
 
                "Commit message was not edited, use anyway"):
 
163
            if not ui.ui_factory.confirm_action(
 
164
                u"Commit message was not edited, use anyway",
 
165
                "breezy.msgeditor.unchanged",
 
166
                    {}):
154
167
                # Returning "" makes cmd_commit raise 'empty commit message
155
168
                # specified' which is a reasonable error, given the user has
156
169
                # rejected using the unedited template.
158
171
        started = False
159
172
        msg = []
160
173
        lastline, nlines = 0, 0
161
 
        # codecs.open() ALWAYS opens file in binary mode but we need text mode
162
 
        # 'rU' mode useful when bzr.exe used on Cygwin (bialix 20070430)
163
 
        f = file(msgfilename, 'rU')
164
 
        try:
 
174
        with codecs.open(msgfilename, mode='rb', encoding=osutils.get_user_encoding()) as f:
165
175
            try:
166
 
                for line in codecs.getreader(osutils.get_user_encoding())(f):
 
176
                for line in f:
167
177
                    stripped_line = line.strip()
168
178
                    # strip empty line before the log message starts
169
179
                    if not started:
182
192
                    msg.append(line)
183
193
            except UnicodeDecodeError:
184
194
                raise BadCommitMessageEncoding()
185
 
        finally:
186
 
            f.close()
187
195
 
188
196
        if len(msg) == 0:
189
197
            return ""
199
207
        if msgfilename is not None:
200
208
            try:
201
209
                os.unlink(msgfilename)
202
 
            except IOError, e:
 
210
            except IOError as e:
203
211
                trace.warning(
204
212
                    "failed to unlink %s: %s; ignored", msgfilename, e)
205
213
 
206
214
 
207
215
def _create_temp_file_with_commit_template(infotext,
208
216
                                           ignoreline=DEFAULT_IGNORE_LINE,
209
 
                                           start_message=None):
 
217
                                           start_message=None,
 
218
                                           tmpdir=None):
210
219
    """Create temp file and write commit template in it.
211
220
 
212
 
    :param infotext:    Text to be displayed at bottom of message
213
 
                        for the user's reference;
214
 
                        currently similar to 'bzr status'.
215
 
                        The text is already encoded.
 
221
    :param infotext: Text to be displayed at bottom of message for the
 
222
        user's reference; currently similar to 'bzr status'.  The text is
 
223
        already encoded.
216
224
 
217
225
    :param ignoreline:  The separator to use above the infotext.
218
226
 
219
 
    :param start_message:   The text to place above the separator, if any.
220
 
                            This will not be removed from the message
221
 
                            after the user has edited it.
222
 
                            The string is already encoded
 
227
    :param start_message: The text to place above the separator, if any.
 
228
        This will not be removed from the message after the user has edited
 
229
        it.  The string is already encoded
223
230
 
224
231
    :return:    2-tuple (temp file name, hasinfo)
225
232
    """
226
233
    import tempfile
227
234
    tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
228
 
                                               dir='.',
229
 
                                               text=True)
230
 
    msgfilename = osutils.basename(msgfilename)
231
 
    msgfile = os.fdopen(tmp_fileno, 'w')
232
 
    try:
 
235
                                               dir=tmpdir, text=True)
 
236
    with os.fdopen(tmp_fileno, 'wb') as msgfile:
233
237
        if start_message is not None:
234
 
            msgfile.write("%s\n" % start_message)
 
238
            msgfile.write(b"%s\n" % start_message)
235
239
 
236
240
        if infotext is not None and infotext != "":
237
241
            hasinfo = True
238
 
            msgfile.write("\n\n%s\n\n%s" %(ignoreline, infotext))
 
242
            trailer = b"\n\n%s\n\n%s" % (
 
243
                ignoreline.encode(osutils.get_user_encoding()), infotext)
 
244
            msgfile.write(trailer)
239
245
        else:
240
246
            hasinfo = False
241
 
    finally:
242
 
        msgfile.close()
243
247
 
244
248
    return (msgfilename, hasinfo)
245
249
 
254
258
    # TODO: Rather than running the status command, should prepare a draft of
255
259
    # the revision to be committed, then pause and ask the user to
256
260
    # confirm/write a message.
257
 
    from StringIO import StringIO       # must be unicode-safe
258
 
    from bzrlib.status import show_tree_status
 
261
    from .status import show_tree_status
259
262
    status_tmp = StringIO()
260
263
    show_tree_status(working_tree, specific_files=specific_files,
261
264
                     to_file=status_tmp, verbose=True)
273
276
    # TODO: Rather than running the status command, should prepare a draft of
274
277
    # the revision to be committed, then pause and ask the user to
275
278
    # confirm/write a message.
276
 
    from StringIO import StringIO       # must be unicode-safe
277
 
    from bzrlib.diff import show_diff_trees
 
279
    from .diff import show_diff_trees
278
280
 
279
281
    template = make_commit_message_template(working_tree, specific_files)
280
282
    template = template.encode(output_encoding, "replace")
281
283
 
282
284
    if diff:
283
 
        stream = StringIO()
 
285
        stream = BytesIO()
284
286
        show_diff_trees(working_tree.basis_tree(),
285
287
                        working_tree, stream, specific_files,
286
288
                        path_encoding=output_encoding)
287
 
        template = template + '\n' + stream.getvalue()
 
289
        template = template + b'\n' + stream.getvalue()
288
290
 
289
291
    return template
290
292
 
302
304
 
303
305
        These are all empty initially.
304
306
        """
305
 
        Hooks.__init__(self)
306
 
        self.create_hook(HookPoint('commit_message_template',
 
307
        Hooks.__init__(self, "breezy.msgeditor", "hooks")
 
308
        self.add_hook(
 
309
            'set_commit_message',
 
310
            "Set a fixed commit message. "
 
311
            "set_commit_message is called with the "
 
312
            "breezy.commit.Commit object (so you can also change e.g. "
 
313
            "revision properties by editing commit.builder._revprops) and the "
 
314
            "message so far. set_commit_message must return the message to "
 
315
            "use or None if it should use the message editor as normal.",
 
316
            (2, 4))
 
317
        self.add_hook(
 
318
            'commit_message_template',
307
319
            "Called when a commit message is being generated. "
308
 
            "commit_message_template is called with the bzrlib.commit.Commit "
 
320
            "commit_message_template is called with the breezy.commit.Commit "
309
321
            "object and the message that is known so far. "
310
322
            "commit_message_template must return a new message to use (which "
311
 
            "could be the same as it was given. When there are multiple "
 
323
            "could be the same as it was given). When there are multiple "
312
324
            "hooks registered for commit_message_template, they are chained "
313
325
            "with the result from the first passed into the second, and so "
314
 
            "on.", (1, 10), None))
 
326
            "on.", (1, 10))
315
327
 
316
328
 
317
329
hooks = MessageEditorHooks()
318
330
 
319
331
 
 
332
def set_commit_message(commit, start_message=None):
 
333
    """Sets the commit message.
 
334
    :param commit: Commit object for the active commit.
 
335
    :return: The commit message or None to continue using the message editor
 
336
    """
 
337
    start_message = None
 
338
    for hook in hooks['set_commit_message']:
 
339
        start_message = hook(commit, start_message)
 
340
    return start_message
 
341
 
 
342
 
320
343
def generate_commit_message_template(commit, start_message=None):
321
344
    """Generate a commit message template.
322
345