← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/msgeditor.py

https://launchpad.net/bugs/524184
NEWS section template into a separate file

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/msgeditor.py
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."""
23
23
from subprocess import call
24
24
import sys
25
25
 
26
 
import bzrlib
27
 
import bzrlib.config as config
28
 
from bzrlib import osutils
 
26
from bzrlib import (
 
27
    config,
 
28
    osutils,
 
29
    trace,
 
30
    )
29
31
from bzrlib.errors import BzrError, BadCommitMessageEncoding
30
 
from bzrlib.trace import warning, mutter
 
32
from bzrlib.hooks import HookPoint, Hooks
31
33
 
32
34
 
33
35
def _get_editor():
34
36
    """Return a sequence of possible editor binaries for the current platform"""
35
37
    try:
36
 
        yield os.environ["BZR_EDITOR"]
 
38
        yield os.environ["BZR_EDITOR"], '$BZR_EDITOR'
37
39
    except KeyError:
38
40
        pass
39
41
 
40
42
    e = config.GlobalConfig().get_editor()
41
43
    if e is not None:
42
 
        yield e
43
 
        
 
44
        yield e, config.config_filename()
 
45
 
44
46
    for varname in 'VISUAL', 'EDITOR':
45
47
        if varname in os.environ:
46
 
            yield os.environ[varname]
 
48
            yield os.environ[varname], '$' + varname
47
49
 
48
50
    if sys.platform == 'win32':
49
51
        for editor in 'wordpad.exe', 'notepad.exe':
50
 
            yield editor
 
52
            yield editor, None
51
53
    else:
52
54
        for editor in ['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe']:
53
 
            yield editor
 
55
            yield editor, None
54
56
 
55
57
 
56
58
def _run_editor(filename):
57
59
    """Try to execute an editor to edit the commit message."""
58
 
    for e in _get_editor():
59
 
        edargs = e.split(' ')
 
60
    for candidate, candidate_source in _get_editor():
 
61
        edargs = candidate.split(' ')
60
62
        try:
61
63
            ## mutter("trying editor: %r", (edargs +[filename]))
62
64
            x = call(edargs + [filename])
63
65
        except OSError, e:
64
66
            # We're searching for an editor, so catch safe errors and continue
65
 
            if e.errno in (errno.ENOENT, ):
 
67
            if e.errno in (errno.ENOENT, errno.EACCES):
 
68
                if candidate_source is not None:
 
69
                    # We tried this editor because some user configuration (an
 
70
                    # environment variable or config file) said to try it.  Let
 
71
                    # the user know their configuration is broken.
 
72
                    trace.warning(
 
73
                        'Could not start editor "%s" (specified by %s): %s\n'
 
74
                        % (candidate, candidate_source, str(e)))
66
75
                continue
67
76
            raise
68
77
        if x == 0:
102
111
    """
103
112
 
104
113
    if not start_message is None:
105
 
        start_message = start_message.encode(bzrlib.user_encoding)
106
 
    infotext = infotext.encode(bzrlib.user_encoding, 'replace')
 
114
        start_message = start_message.encode(osutils.get_user_encoding())
 
115
    infotext = infotext.encode(osutils.get_user_encoding(), 'replace')
107
116
    return edit_commit_message_encoded(infotext, ignoreline, start_message)
108
117
 
109
118
 
135
144
 
136
145
        if not msgfilename or not _run_editor(msgfilename):
137
146
            return None
138
 
        
 
147
 
139
148
        started = False
140
149
        msg = []
141
150
        lastline, nlines = 0, 0
144
153
        f = file(msgfilename, 'rU')
145
154
        try:
146
155
            try:
147
 
                for line in codecs.getreader(bzrlib.user_encoding)(f):
 
156
                for line in codecs.getreader(osutils.get_user_encoding())(f):
148
157
                    stripped_line = line.strip()
149
158
                    # strip empty line before the log message starts
150
159
                    if not started:
181
190
            try:
182
191
                os.unlink(msgfilename)
183
192
            except IOError, e:
184
 
                warning("failed to unlink %s: %s; ignored", msgfilename, e)
 
193
                trace.warning(
 
194
                    "failed to unlink %s: %s; ignored", msgfilename, e)
185
195
 
186
196
 
187
197
def _create_temp_file_with_commit_template(infotext,
237
247
    from StringIO import StringIO       # must be unicode-safe
238
248
    from bzrlib.status import show_tree_status
239
249
    status_tmp = StringIO()
240
 
    show_tree_status(working_tree, specific_files=specific_files, 
241
 
                     to_file=status_tmp)
 
250
    show_tree_status(working_tree, specific_files=specific_files,
 
251
                     to_file=status_tmp, verbose=True)
242
252
    return status_tmp.getvalue()
243
253
 
244
254
 
267
277
        template = template + '\n' + stream.getvalue()
268
278
 
269
279
    return template
 
280
 
 
281
 
 
282
class MessageEditorHooks(Hooks):
 
283
    """A dictionary mapping hook name to a list of callables for message editor
 
284
    hooks.
 
285
 
 
286
    e.g. ['commit_message_template'] is the list of items to be called to
 
287
    generate a commit message template
 
288
    """
 
289
 
 
290
    def __init__(self):
 
291
        """Create the default hooks.
 
292
 
 
293
        These are all empty initially.
 
294
        """
 
295
        Hooks.__init__(self)
 
296
        self.create_hook(HookPoint('commit_message_template',
 
297
            "Called when a commit message is being generated. "
 
298
            "commit_message_template is called with the bzrlib.commit.Commit "
 
299
            "object and the message that is known so far. "
 
300
            "commit_message_template must return a new message to use (which "
 
301
            "could be the same as it was given. When there are multiple "
 
302
            "hooks registered for commit_message_template, they are chained "
 
303
            "with the result from the first passed into the second, and so "
 
304
            "on.", (1, 10), None))
 
305
 
 
306
 
 
307
hooks = MessageEditorHooks()
 
308
 
 
309
 
 
310
def generate_commit_message_template(commit, start_message=None):
 
311
    """Generate a commit message template.
 
312
 
 
313
    :param commit: Commit object for the active commit.
 
314
    :param start_message: Message to start with.
 
315
    :return: A start commit message or None for an empty start commit message.
 
316
    """
 
317
    start_message = None
 
318
    for hook in hooks['commit_message_template']:
 
319
        start_message = hook(commit, start_message)
 
320
    return start_message