← 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: 2007-01-25 05:18:17 UTC
  • mfrom: (2241.1.3 repoformats)
  • Revision ID: pqm@pqm.ubuntu.com-20070125051817-53a80525dbdf87b4
(mbp) Change RepositoryFormat to use a registry (r=john)

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 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
34
    try:
31
35
        yield os.environ["BZR_EDITOR"]
32
36
    except KeyError:
33
37
        pass
34
38
 
35
 
    e = _read_config_value("editor")
 
39
    e = config.GlobalConfig().get_editor()
36
40
    if e is not None:
37
41
        yield e
38
42
        
39
 
    try:
40
 
        yield os.environ["EDITOR"]
41
 
    except KeyError:
42
 
        pass
 
43
    for varname in 'VISUAL', 'EDITOR':
 
44
        if varname in os.environ:
 
45
            yield os.environ[varname]
43
46
 
44
 
    if os.name == "nt":
45
 
        yield "notepad.exe"
46
 
    elif os.name == "posix":
47
 
        yield "/usr/bin/vi"
 
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
48
53
 
49
54
 
50
55
def _run_editor(filename):
51
56
    """Try to execute an editor to edit the commit message."""
52
57
    for e in _get_editor():
53
58
        edargs = e.split(' ')
54
 
        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
55
67
        if x == 0:
56
68
            return True
57
69
        elif x == 127:
58
70
            continue
59
71
        else:
60
72
            break
61
 
    raise BzrError("Could not start any editor. "
62
 
                   "Please specify $EDITOR or use ~/.bzr.conf/editor")
63
 
                          
64
 
 
65
 
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):
66
84
    """Let the user edit a commit message in a temp file.
67
85
 
68
86
    This is run if they don't give a message or
74
92
        'bzr status'.
75
93
    """
76
94
    import tempfile
77
 
    
78
 
    if ignoreline is None:
79
 
        ignoreline = "-- This line and the following will be ignored --"
80
 
        
 
95
 
 
96
    msgfilename = None
81
97
    try:
82
 
        tmp_fileno, msgfilename = tempfile.mkstemp()
 
98
        tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.', dir=u'.')
83
99
        msgfile = os.close(tmp_fileno)
84
100
        if infotext is not None and infotext != "":
85
101
            hasinfo = True
86
102
            msgfile = file(msgfilename, "w")
87
 
            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')))
88
105
            msgfile.close()
89
106
        else:
90
107
            hasinfo = False
95
112
        started = False
96
113
        msg = []
97
114
        lastline, nlines = 0, 0
98
 
        for line in file(msgfilename, "r"):
 
115
        for line in codecs.open(msgfilename, 'r', bzrlib.user_encoding):
99
116
            stripped_line = line.strip()
100
117
            # strip empty line before the log message starts
101
118
            if not started:
124
141
            return "".join(msg)
125
142
    finally:
126
143
        # delete the msg file in any case
127
 
        try: os.unlink(msgfilename)
128
 
        except IOError: pass
129
 
 
 
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()