← 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: 2006-05-04 02:40:31 UTC
  • mto: This revision was merged to the branch mainline in revision 1697.
  • Revision ID: mbp@sourcefrog.net-20060504024031-82abe45d799c9350
Remove backup warning from bzr help

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
 
1
# Copyright (C) 2005, 2006 by Canonical Ltd
4
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
20
18
"""Commit message editor support."""
21
19
 
22
20
import os
 
21
import errno
 
22
from subprocess import call
 
23
 
 
24
import bzrlib.config as config
23
25
from bzrlib.errors import BzrError
24
26
 
25
27
def _get_editor():
26
28
    """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")
 
29
    try:
 
30
        yield os.environ["BZR_EDITOR"]
 
31
    except KeyError:
 
32
        pass
 
33
 
 
34
    e = config.GlobalConfig().get_editor()
30
35
    if e is not None:
31
36
        yield e
32
37
        
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"
 
38
    try:
 
39
        yield os.environ["EDITOR"]
 
40
    except KeyError:
 
41
        pass
 
42
 
 
43
    if sys.platform == 'win32':
 
44
        for editor in 'wordpad.exe', 'notepad.exe':
 
45
            yield editor
 
46
    else:
 
47
        for editor in ['vi', 'pico', 'nano', 'joe']:
 
48
            yield editor
40
49
 
41
50
 
42
51
def _run_editor(filename):
43
52
    """Try to execute an editor to edit the commit message."""
44
53
    for e in _get_editor():
45
54
        edargs = e.split(' ')
46
 
        x = os.spawnvp(os.P_WAIT, edargs[0],
47
 
                       edargs + [filename])
 
55
        try:
 
56
            x = call(edargs + [filename])
 
57
        except OSError, e:
 
58
           # We're searching for an editor, so catch safe errors and continue
 
59
           if e.errno in (errno.ENOENT, ):
 
60
               continue
 
61
           raise
48
62
        if x == 0:
49
63
            return True
50
64
        elif x == 127:
51
65
            continue
52
66
        else:
53
67
            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):
 
68
    raise BzrError("Could not start any editor.\nPlease specify one with:\n"
 
69
                   " - $BZR_EDITOR\n - editor=/some/path in %s\n - $EDITOR" % \
 
70
                    config.config_filename())
 
71
 
 
72
 
 
73
DEFAULT_IGNORE_LINE = "%(bar)s %(msg)s %(bar)s" % \
 
74
    { 'bar' : '-' * 14, 'msg' : 'This line and the following will be ignored' }
 
75
 
 
76
 
 
77
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE):
59
78
    """Let the user edit a commit message in a temp file.
60
79
 
61
80
    This is run if they don't give a message or
67
86
        'bzr status'.
68
87
    """
69
88
    import tempfile
70
 
    
71
 
    if ignoreline is None:
72
 
        ignoreline = "-- This line and the following will be ignored --"
73
 
        
 
89
 
74
90
    try:
75
 
        tmp_fileno, msgfilename = tempfile.mkstemp()
 
91
        tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.', dir=u'.')
76
92
        msgfile = os.close(tmp_fileno)
77
93
        if infotext is not None and infotext != "":
78
94
            hasinfo = True
79
95
            msgfile = file(msgfilename, "w")
80
 
            msgfile.write("\n\n%s\n\n%s" % (ignoreline, infotext))
 
96
            msgfile.write("\n%s\n\n%s" % (ignoreline, infotext))
81
97
            msgfile.close()
82
98
        else:
83
99
            hasinfo = False
107
123
            msg.append(line)
108
124
            
109
125
        if len(msg) == 0:
110
 
            return None
 
126
            return ""
111
127
        # delete empty lines at the end
112
128
        del msg[lastline:]
113
129
        # add a newline at the end, if needed
120
136
        try: os.unlink(msgfilename)
121
137
        except IOError: pass
122
138
 
 
139
 
 
140
def make_commit_message_template(working_tree, specific_files):
 
141
    """Prepare a template file for a commit into a branch.
 
142
 
 
143
    Returns a unicode string containing the template.
 
144
    """
 
145
    # TODO: Should probably be given the WorkingTree not the branch
 
146
    #
 
147
    # TODO: make provision for this to be overridden or modified by a hook
 
148
    #
 
149
    # TODO: Rather than running the status command, should prepare a draft of
 
150
    # the revision to be committed, then pause and ask the user to
 
151
    # confirm/write a message.
 
152
    from StringIO import StringIO       # must be unicode-safe
 
153
    from bzrlib.status import show_tree_status
 
154
    status_tmp = StringIO()
 
155
    show_tree_status(working_tree, specific_files=specific_files, 
 
156
                     to_file=status_tmp)
 
157
    return status_tmp.getvalue()