← 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: 2006-08-14 04:29:57 UTC
  • mfrom: (1912.1.2 bzr.mbp.integration)
  • Revision ID: pqm@pqm.ubuntu.com-20060814042957-3fa43995db57512a
(mbp) merge from 0.9, update for 0.10

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/msgeditor.py
1
 
# Bazaar-NG -- distributed version control
2
 
 
3
 
# Copyright (C) 2005 by Canonical Ltd
4
 
 
 
1
# Copyright (C) 2005, 2006 by 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
from subprocess import call
 
24
import sys
 
25
 
 
26
import bzrlib
 
27
import bzrlib.config as config
23
28
from bzrlib.errors import BzrError
 
29
from bzrlib.trace import warning, mutter
 
30
 
24
31
 
25
32
def _get_editor():
26
33
    """Return a sequence of possible editor binaries for the current platform"""
27
 
    from bzrlib.osutils import _read_config_value
28
 
    
29
 
    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()
30
40
    if e is not None:
31
41
        yield e
32
42
        
33
 
    if os.name == "windows":
34
 
        yield "notepad.exe"
35
 
    elif os.name == "posix":
36
 
        try:
37
 
            yield os.environ["EDITOR"]
38
 
        except KeyError:
39
 
            yield "/usr/bin/vi"
 
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
40
53
 
41
54
 
42
55
def _run_editor(filename):
43
56
    """Try to execute an editor to edit the commit message."""
44
57
    for e in _get_editor():
45
58
        edargs = e.split(' ')
46
 
        x = os.spawnvp(os.P_WAIT, edargs[0],
47
 
                       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 - $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):
59
83
    """Let the user edit a commit message in a temp file.
60
84
 
61
85
    This is run if they don't give a message or
67
91
        'bzr status'.
68
92
    """
69
93
    import tempfile
70
 
    
71
 
    if ignoreline is None:
72
 
        ignoreline = "-- This line and the following will be ignored --"
73
 
        
 
94
 
 
95
    msgfilename = None
74
96
    try:
75
 
        tmp_fileno, msgfilename = tempfile.mkstemp()
 
97
        tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.', dir=u'.')
76
98
        msgfile = os.close(tmp_fileno)
77
99
        if infotext is not None and infotext != "":
78
100
            hasinfo = True
79
101
            msgfile = file(msgfilename, "w")
80
 
            msgfile.write("\n\n%s\n\n%s" % (ignoreline, infotext))
 
102
            msgfile.write("\n\n%s\n\n%s" % (ignoreline,
 
103
                infotext.encode(bzrlib.user_encoding, 'replace')))
81
104
            msgfile.close()
82
105
        else:
83
106
            hasinfo = False
88
111
        started = False
89
112
        msg = []
90
113
        lastline, nlines = 0, 0
91
 
        for line in file(msgfilename, "r"):
 
114
        for line in codecs.open(msgfilename, 'r', bzrlib.user_encoding):
92
115
            stripped_line = line.strip()
93
116
            # strip empty line before the log message starts
94
117
            if not started:
107
130
            msg.append(line)
108
131
            
109
132
        if len(msg) == 0:
110
 
            return None
 
133
            return ""
111
134
        # delete empty lines at the end
112
135
        del msg[lastline:]
113
136
        # add a newline at the end, if needed
117
140
            return "".join(msg)
118
141
    finally:
119
142
        # delete the msg file in any case
120
 
        try: os.unlink(msgfilename)
121
 
        except IOError: pass
122
 
 
 
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()