← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/msgeditor.py

  • Committer: Martin Pool
  • Date: 2005-05-03 08:00:27 UTC
  • Revision ID: mbp@sourcefrog.net-20050503080027-908edb5b39982198
doc

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/msgeditor.py
1
 
# Copyright (C) 2005, 2006 by Canonical Ltd
2
 
 
3
 
# This program is free software; you can redistribute it and/or modify
4
 
# it under the terms of the GNU General Public License as published by
5
 
# the Free Software Foundation; either version 2 of the License, or
6
 
# (at your option) any later version.
7
 
 
8
 
# This program is distributed in the hope that it will be useful,
9
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
 
# GNU General Public License for more details.
12
 
 
13
 
# You should have received a copy of the GNU General Public License
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
16
 
 
17
 
 
18
 
"""Commit message editor support."""
19
 
 
20
 
import codecs
21
 
import errno
22
 
import os
23
 
from subprocess import call
24
 
import sys
25
 
 
26
 
import bzrlib
27
 
import bzrlib.config as config
28
 
from bzrlib.errors import BzrError
29
 
from bzrlib.trace import warning, mutter
30
 
 
31
 
 
32
 
def _get_editor():
33
 
    """Return a sequence of possible editor binaries for the current platform"""
34
 
    try:
35
 
        yield os.environ["BZR_EDITOR"]
36
 
    except KeyError:
37
 
        pass
38
 
 
39
 
    e = config.GlobalConfig().get_editor()
40
 
    if e is not None:
41
 
        yield e
42
 
        
43
 
    for varname in 'VISUAL', 'EDITOR':
44
 
        if os.environ.has_key(varname):
45
 
            yield os.environ[varname]
46
 
 
47
 
    if sys.platform == 'win32':
48
 
        for editor in 'wordpad.exe', 'notepad.exe':
49
 
            yield editor
50
 
    else:
51
 
        for editor in ['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe']:
52
 
            yield editor
53
 
 
54
 
 
55
 
def _run_editor(filename):
56
 
    """Try to execute an editor to edit the commit message."""
57
 
    for e in _get_editor():
58
 
        edargs = e.split(' ')
59
 
        try:
60
 
            ## mutter("trying editor: %r", (edargs +[filename]))
61
 
            x = call(edargs + [filename])
62
 
        except OSError, e:
63
 
           # We're searching for an editor, so catch safe errors and continue
64
 
           if e.errno in (errno.ENOENT, ):
65
 
               continue
66
 
           raise
67
 
        if x == 0:
68
 
            return True
69
 
        elif x == 127:
70
 
            continue
71
 
        else:
72
 
            break
73
 
    raise BzrError("Could not start any editor.\nPlease specify one with:\n"
74
 
                   " - $BZR_EDITOR\n - editor=/some/path in %s\n - $EDITOR" % \
75
 
                    config.config_filename())
76
 
 
77
 
 
78
 
DEFAULT_IGNORE_LINE = "%(bar)s %(msg)s %(bar)s" % \
79
 
    { 'bar' : '-' * 14, 'msg' : 'This line and the following will be ignored' }
80
 
 
81
 
 
82
 
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE):
83
 
    """Let the user edit a commit message in a temp file.
84
 
 
85
 
    This is run if they don't give a message or
86
 
    message-containing file on the command line.
87
 
 
88
 
    infotext:
89
 
        Text to be displayed at bottom of message for
90
 
        the user's reference; currently similar to
91
 
        'bzr status'.
92
 
    """
93
 
    import tempfile
94
 
 
95
 
    msgfilename = None
96
 
    try:
97
 
        tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.', dir=u'.')
98
 
        msgfile = os.close(tmp_fileno)
99
 
        if infotext is not None and infotext != "":
100
 
            hasinfo = True
101
 
            msgfile = file(msgfilename, "w")
102
 
            msgfile.write("\n\n%s\n\n%s" % (ignoreline,
103
 
                infotext.encode(bzrlib.user_encoding, 'replace')))
104
 
            msgfile.close()
105
 
        else:
106
 
            hasinfo = False
107
 
 
108
 
        if not _run_editor(msgfilename):
109
 
            return None
110
 
        
111
 
        started = False
112
 
        msg = []
113
 
        lastline, nlines = 0, 0
114
 
        for line in codecs.open(msgfilename, 'r', bzrlib.user_encoding):
115
 
            stripped_line = line.strip()
116
 
            # strip empty line before the log message starts
117
 
            if not started:
118
 
                if stripped_line != "":
119
 
                    started = True
120
 
                else:
121
 
                    continue
122
 
            # check for the ignore line only if there
123
 
            # is additional information at the end
124
 
            if hasinfo and stripped_line == ignoreline:
125
 
                break
126
 
            nlines += 1
127
 
            # keep track of the last line that had some content
128
 
            if stripped_line != "":
129
 
                lastline = nlines
130
 
            msg.append(line)
131
 
            
132
 
        if len(msg) == 0:
133
 
            return ""
134
 
        # delete empty lines at the end
135
 
        del msg[lastline:]
136
 
        # add a newline at the end, if needed
137
 
        if not msg[-1].endswith("\n"):
138
 
            return "%s%s" % ("".join(msg), "\n")
139
 
        else:
140
 
            return "".join(msg)
141
 
    finally:
142
 
        # delete the msg file in any case
143
 
        if msgfilename is not None:
144
 
            try:
145
 
                os.unlink(msgfilename)
146
 
            except IOError, e:
147
 
                warning("failed to unlink %s: %s; ignored", msgfilename, e)
148
 
 
149
 
 
150
 
def make_commit_message_template(working_tree, specific_files):
151
 
    """Prepare a template file for a commit into a branch.
152
 
 
153
 
    Returns a unicode string containing the template.
154
 
    """
155
 
    # TODO: Should probably be given the WorkingTree not the branch
156
 
    #
157
 
    # TODO: make provision for this to be overridden or modified by a hook
158
 
    #
159
 
    # TODO: Rather than running the status command, should prepare a draft of
160
 
    # the revision to be committed, then pause and ask the user to
161
 
    # confirm/write a message.
162
 
    from StringIO import StringIO       # must be unicode-safe
163
 
    from bzrlib.status import show_tree_status
164
 
    status_tmp = StringIO()
165
 
    show_tree_status(working_tree, specific_files=specific_files, 
166
 
                     to_file=status_tmp)
167
 
    return status_tmp.getvalue()