The Android Open Source Project | cf31fe9 | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 1 | # |
| 2 | # Copyright (C) 2008 The Android Open Source Project |
| 3 | # |
| 4 | # Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | # you may not use this file except in compliance with the License. |
| 6 | # You may obtain a copy of the License at |
| 7 | # |
| 8 | # http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | # |
| 10 | # Unless required by applicable law or agreed to in writing, software |
| 11 | # distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | # See the License for the specific language governing permissions and |
| 14 | # limitations under the License. |
| 15 | |
| 16 | import os |
Shawn O. Pearce | 1dcb58a | 2009-07-02 12:45:47 -0700 | [diff] [blame] | 17 | import re |
The Android Open Source Project | cf31fe9 | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 18 | import sys |
| 19 | import subprocess |
| 20 | import tempfile |
| 21 | |
| 22 | from error import EditorError |
| 23 | |
| 24 | class Editor(object): |
| 25 | """Manages the user's preferred text editor.""" |
| 26 | |
| 27 | _editor = None |
| 28 | globalConfig = None |
| 29 | |
| 30 | @classmethod |
| 31 | def _GetEditor(cls): |
| 32 | if cls._editor is None: |
| 33 | cls._editor = cls._SelectEditor() |
| 34 | return cls._editor |
| 35 | |
| 36 | @classmethod |
| 37 | def _SelectEditor(cls): |
| 38 | e = os.getenv('GIT_EDITOR') |
| 39 | if e: |
| 40 | return e |
| 41 | |
Shawn O. Pearce | 1dcb58a | 2009-07-02 12:45:47 -0700 | [diff] [blame] | 42 | if cls.globalConfig: |
| 43 | e = cls.globalConfig.GetString('core.editor') |
| 44 | if e: |
| 45 | return e |
The Android Open Source Project | cf31fe9 | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 46 | |
| 47 | e = os.getenv('VISUAL') |
| 48 | if e: |
| 49 | return e |
| 50 | |
| 51 | e = os.getenv('EDITOR') |
| 52 | if e: |
| 53 | return e |
| 54 | |
| 55 | if os.getenv('TERM') == 'dumb': |
| 56 | print >>sys.stderr,\ |
| 57 | """No editor specified in GIT_EDITOR, core.editor, VISUAL or EDITOR. |
| 58 | Tried to fall back to vi but terminal is dumb. Please configure at |
| 59 | least one of these before using this command.""" |
| 60 | sys.exit(1) |
| 61 | |
| 62 | return 'vi' |
| 63 | |
| 64 | @classmethod |
| 65 | def EditString(cls, data): |
| 66 | """Opens an editor to edit the given content. |
| 67 | |
| 68 | Args: |
| 69 | data : the text to edit |
| 70 | |
| 71 | Returns: |
| 72 | new value of edited text; None if editing did not succeed |
| 73 | """ |
Shawn O. Pearce | 1dcb58a | 2009-07-02 12:45:47 -0700 | [diff] [blame] | 74 | editor = cls._GetEditor() |
| 75 | if editor == ':': |
| 76 | return data |
| 77 | |
The Android Open Source Project | cf31fe9 | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 78 | fd, path = tempfile.mkstemp() |
| 79 | try: |
| 80 | os.write(fd, data) |
| 81 | os.close(fd) |
| 82 | fd = None |
| 83 | |
Shawn O. Pearce | 1dcb58a | 2009-07-02 12:45:47 -0700 | [diff] [blame] | 84 | if re.compile("^.*[$ \t'].*$").match(editor): |
Patrick Dubroy | b715b14 | 2010-07-29 17:10:47 -0700 | [diff] [blame^] | 85 | args = [editor + ' "$@"', 'sh'] |
Shawn O. Pearce | 1dcb58a | 2009-07-02 12:45:47 -0700 | [diff] [blame] | 86 | shell = True |
| 87 | else: |
| 88 | args = [editor] |
| 89 | shell = False |
| 90 | args.append(path) |
| 91 | |
Shawn O. Pearce | 54fccd7 | 2009-06-24 07:09:51 -0700 | [diff] [blame] | 92 | try: |
Shawn O. Pearce | 1dcb58a | 2009-07-02 12:45:47 -0700 | [diff] [blame] | 93 | rc = subprocess.Popen(args, shell=shell).wait() |
Shawn O. Pearce | 54fccd7 | 2009-06-24 07:09:51 -0700 | [diff] [blame] | 94 | except OSError, e: |
| 95 | raise EditorError('editor failed, %s: %s %s' |
Shawn O. Pearce | 1dcb58a | 2009-07-02 12:45:47 -0700 | [diff] [blame] | 96 | % (str(e), editor, path)) |
Shawn O. Pearce | 54fccd7 | 2009-06-24 07:09:51 -0700 | [diff] [blame] | 97 | if rc != 0: |
| 98 | raise EditorError('editor failed with exit status %d: %s %s' |
Shawn O. Pearce | 1dcb58a | 2009-07-02 12:45:47 -0700 | [diff] [blame] | 99 | % (rc, editor, path)) |
Shawn O. Pearce | 54fccd7 | 2009-06-24 07:09:51 -0700 | [diff] [blame] | 100 | |
Shawn O. Pearce | a8421a1 | 2009-04-18 16:57:46 -0700 | [diff] [blame] | 101 | fd2 = open(path) |
Shawn O. Pearce | 76ca9f8 | 2009-04-18 14:48:03 -0700 | [diff] [blame] | 102 | try: |
Shawn O. Pearce | a8421a1 | 2009-04-18 16:57:46 -0700 | [diff] [blame] | 103 | return fd2.read() |
Shawn O. Pearce | 76ca9f8 | 2009-04-18 14:48:03 -0700 | [diff] [blame] | 104 | finally: |
Shawn O. Pearce | a8421a1 | 2009-04-18 16:57:46 -0700 | [diff] [blame] | 105 | fd2.close() |
The Android Open Source Project | cf31fe9 | 2008-10-21 07:00:00 -0700 | [diff] [blame] | 106 | finally: |
| 107 | if fd: |
| 108 | os.close(fd) |
| 109 | os.remove(path) |