~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/msgeditor.py

  • Committer: Aaron Bentley
  • Date: 2007-03-02 15:03:07 UTC
  • mto: (2323.6.9 0.15-integration)
  • mto: This revision was merged to the branch mainline in revision 2330.
  • Revision ID: abentley@panoramicfeedback.com-20070302150307-zg8n768fzowijv7l
Patch-RIO does line breaks in slightly more readable places

Show diffs side-by-side

added added

removed removed

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