← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/msgeditor.py

  • Committer: Ian Clatworthy
  • Date: 2009-09-09 11:43:10 UTC
  • mto: (4634.37.2 prepare-2.0)
  • mto: This revision was merged to the branch mainline in revision 4689.
  • Revision ID: ian.clatworthy@canonical.com-20090909114310-glw7tv76i5gnx9pt
put rules back in Makefile supporting plain-style docs

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/msgeditor.py
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
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
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
 
18
18
"""Commit message editor support."""
23
23
from subprocess import call
24
24
import sys
25
25
 
26
 
import bzrlib
27
 
import bzrlib.config as config
 
26
from bzrlib import (
 
27
    config,
 
28
    osutils,
 
29
    trace,
 
30
    )
28
31
from bzrlib.errors import BzrError, BadCommitMessageEncoding
29
 
from bzrlib.trace import warning, mutter
 
32
from bzrlib.hooks import HookPoint, Hooks
30
33
 
31
34
 
32
35
def _get_editor():
33
36
    """Return a sequence of possible editor binaries for the current platform"""
34
37
    try:
35
 
        yield os.environ["BZR_EDITOR"]
 
38
        yield os.environ["BZR_EDITOR"], '$BZR_EDITOR'
36
39
    except KeyError:
37
40
        pass
38
41
 
39
42
    e = config.GlobalConfig().get_editor()
40
43
    if e is not None:
41
 
        yield e
42
 
        
 
44
        yield e, config.config_filename()
 
45
 
43
46
    for varname in 'VISUAL', 'EDITOR':
44
47
        if varname in os.environ:
45
 
            yield os.environ[varname]
 
48
            yield os.environ[varname], '$' + varname
46
49
 
47
50
    if sys.platform == 'win32':
48
51
        for editor in 'wordpad.exe', 'notepad.exe':
49
 
            yield editor
 
52
            yield editor, None
50
53
    else:
51
54
        for editor in ['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe']:
52
 
            yield editor
 
55
            yield editor, None
53
56
 
54
57
 
55
58
def _run_editor(filename):
56
59
    """Try to execute an editor to edit the commit message."""
57
 
    for e in _get_editor():
58
 
        edargs = e.split(' ')
 
60
    for candidate, candidate_source in _get_editor():
 
61
        edargs = candidate.split(' ')
59
62
        try:
60
63
            ## mutter("trying editor: %r", (edargs +[filename]))
61
64
            x = call(edargs + [filename])
62
65
        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
 
66
            # We're searching for an editor, so catch safe errors and continue
 
67
            if e.errno in (errno.ENOENT, errno.EACCES):
 
68
                if candidate_source is not None:
 
69
                    # We tried this editor because some user configuration (an
 
70
                    # environment variable or config file) said to try it.  Let
 
71
                    # the user know their configuration is broken.
 
72
                    trace.warning(
 
73
                        'Could not start editor "%s" (specified by %s): %s\n'
 
74
                        % (candidate, candidate_source, str(e)))
 
75
                continue
 
76
            raise
67
77
        if x == 0:
68
78
            return True
69
79
        elif x == 127:
101
111
    """
102
112
 
103
113
    if not start_message is None:
104
 
        start_message = start_message.encode(bzrlib.user_encoding)
105
 
    return edit_commit_message_encoded(infotext.encode(bzrlib.user_encoding),
106
 
                                       ignoreline, start_message)
 
114
        start_message = start_message.encode(osutils.get_user_encoding())
 
115
    infotext = infotext.encode(osutils.get_user_encoding(), 'replace')
 
116
    return edit_commit_message_encoded(infotext, ignoreline, start_message)
107
117
 
108
118
 
109
119
def edit_commit_message_encoded(infotext, ignoreline=DEFAULT_IGNORE_LINE,
134
144
 
135
145
        if not msgfilename or not _run_editor(msgfilename):
136
146
            return None
137
 
        
 
147
 
138
148
        started = False
139
149
        msg = []
140
150
        lastline, nlines = 0, 0
143
153
        f = file(msgfilename, 'rU')
144
154
        try:
145
155
            try:
146
 
                for line in codecs.getreader(bzrlib.user_encoding)(f):
 
156
                for line in codecs.getreader(osutils.get_user_encoding())(f):
147
157
                    stripped_line = line.strip()
148
158
                    # strip empty line before the log message starts
149
159
                    if not started:
180
190
            try:
181
191
                os.unlink(msgfilename)
182
192
            except IOError, e:
183
 
                warning("failed to unlink %s: %s; ignored", msgfilename, e)
 
193
                trace.warning(
 
194
                    "failed to unlink %s: %s; ignored", msgfilename, e)
184
195
 
185
196
 
186
197
def _create_temp_file_with_commit_template(infotext,
204
215
    """
205
216
    import tempfile
206
217
    tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
207
 
                                               dir=u'.',
 
218
                                               dir='.',
208
219
                                               text=True)
 
220
    msgfilename = osutils.basename(msgfilename)
209
221
    msgfile = os.fdopen(tmp_fileno, 'w')
210
222
    try:
211
223
        if start_message is not None:
235
247
    from StringIO import StringIO       # must be unicode-safe
236
248
    from bzrlib.status import show_tree_status
237
249
    status_tmp = StringIO()
238
 
    show_tree_status(working_tree, specific_files=specific_files, 
239
 
                     to_file=status_tmp)
 
250
    show_tree_status(working_tree, specific_files=specific_files,
 
251
                     to_file=status_tmp, verbose=True)
240
252
    return status_tmp.getvalue()
241
253
 
242
254
 
265
277
        template = template + '\n' + stream.getvalue()
266
278
 
267
279
    return template
 
280
 
 
281
 
 
282
class MessageEditorHooks(Hooks):
 
283
    """A dictionary mapping hook name to a list of callables for message editor
 
284
    hooks.
 
285
 
 
286
    e.g. ['commit_message_template'] is the list of items to be called to
 
287
    generate a commit message template
 
288
    """
 
289
 
 
290
    def __init__(self):
 
291
        """Create the default hooks.
 
292
 
 
293
        These are all empty initially.
 
294
        """
 
295
        Hooks.__init__(self)
 
296
        self.create_hook(HookPoint('commit_message_template',
 
297
            "Called when a commit message is being generated. "
 
298
            "commit_message_template is called with the bzrlib.commit.Commit "
 
299
            "object and the message that is known so far. "
 
300
            "commit_message_template must return a new message to use (which "
 
301
            "could be the same as it was given. When there are multiple "
 
302
            "hooks registered for commit_message_template, they are chained "
 
303
            "with the result from the first passed into the second, and so "
 
304
            "on.", (1, 10), None))
 
305
 
 
306
 
 
307
hooks = MessageEditorHooks()
 
308
 
 
309
 
 
310
def generate_commit_message_template(commit, start_message=None):
 
311
    """Generate a commit message template.
 
312
 
 
313
    :param commit: Commit object for the active commit.
 
314
    :param start_message: Message to start with.
 
315
    :return: A start commit message or None for an empty start commit message.
 
316
    """
 
317
    start_message = None
 
318
    for hook in hooks['commit_message_template']:
 
319
        start_message = hook(commit, start_message)
 
320
    return start_message