Rename WebKitTools to Tools
[WebKit-https.git] / Tools / Scripts / webkitpy / common / system / user.py
1 # Copyright (c) 2009, Google Inc. All rights reserved.
2
3 # Redistribution and use in source and binary forms, with or without
4 # modification, are permitted provided that the following conditions are
5 # met:
6
7 #     * Redistributions of source code must retain the above copyright
8 # notice, this list of conditions and the following disclaimer.
9 #     * Redistributions in binary form must reproduce the above
10 # copyright notice, this list of conditions and the following disclaimer
11 # in the documentation and/or other materials provided with the
12 # distribution.
13 #     * Neither the name of Google Inc. nor the names of its
14 # contributors may be used to endorse or promote products derived from
15 # this software without specific prior written permission.
16
17 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
29 import logging
30 import os
31 import re
32 import shlex
33 import subprocess
34 import sys
35 import webbrowser
36
37
38 _log = logging.getLogger("webkitpy.common.system.user")
39
40
41 try:
42     import readline
43 except ImportError:
44     if sys.platform != "win32":
45         # There is no readline module for win32, not much to do except cry.
46         _log.warn("Unable to import readline.")
47     # FIXME: We could give instructions for non-mac platforms.
48     # Lack of readline results in a very bad user experiance.
49     if sys.platform == "darwin":
50         _log.warn("If you're using MacPorts, try running:")
51         _log.warn("  sudo port install py25-readline")
52
53
54 class User(object):
55     DEFAULT_NO = 'n'
56     DEFAULT_YES = 'y'
57
58     # FIXME: These are @classmethods because bugzilla.py doesn't have a Tool object (thus no User instance).
59     @classmethod
60     def prompt(cls, message, repeat=1, raw_input=raw_input):
61         response = None
62         while (repeat and not response):
63             repeat -= 1
64             response = raw_input(message)
65         return response
66
67     @classmethod
68     def prompt_with_list(cls, list_title, list_items, can_choose_multiple=False, raw_input=raw_input):
69         print list_title
70         i = 0
71         for item in list_items:
72             i += 1
73             print "%2d. %s" % (i, item)
74
75         # Loop until we get valid input
76         while True:
77             if can_choose_multiple:
78                 response = cls.prompt("Enter one or more numbers (comma-separated), or \"all\": ", raw_input=raw_input)
79                 if not response.strip() or response == "all":
80                     return list_items
81                 try:
82                     indices = [int(r) - 1 for r in re.split("\s*,\s*", response)]
83                 except ValueError, err:
84                     continue
85                 return [list_items[i] for i in indices]
86             else:
87                 try:
88                     result = int(cls.prompt("Enter a number: ", raw_input=raw_input)) - 1
89                 except ValueError, err:
90                     continue
91                 return list_items[result]
92
93     def edit(self, files):
94         editor = os.environ.get("EDITOR") or "vi"
95         args = shlex.split(editor)
96         # Note: Not thread safe: http://bugs.python.org/issue2320
97         subprocess.call(args + files)
98
99     def _warn_if_application_is_xcode(self, edit_application):
100         if "Xcode" in edit_application:
101             print "Instead of using Xcode.app, consider using EDITOR=\"xed --wait\"."
102
103     def edit_changelog(self, files):
104         edit_application = os.environ.get("CHANGE_LOG_EDIT_APPLICATION")
105         if edit_application and sys.platform == "darwin":
106             # On Mac we support editing ChangeLogs using an application.
107             args = shlex.split(edit_application)
108             print "Using editor in the CHANGE_LOG_EDIT_APPLICATION environment variable."
109             print "Please quit the editor application when done editing."
110             self._warn_if_application_is_xcode(edit_application)
111             subprocess.call(["open", "-W", "-n", "-a"] + args + files)
112             return
113         self.edit(files)
114
115     def page(self, message):
116         pager = os.environ.get("PAGER") or "less"
117         try:
118             # Note: Not thread safe: http://bugs.python.org/issue2320
119             child_process = subprocess.Popen([pager], stdin=subprocess.PIPE)
120             child_process.communicate(input=message)
121         except IOError, e:
122             pass
123
124     def confirm(self, message=None, default=DEFAULT_YES, raw_input=raw_input):
125         if not message:
126             message = "Continue?"
127         choice = {'y': 'Y/n', 'n': 'y/N'}[default]
128         response = raw_input("%s [%s]: " % (message, choice))
129         if not response:
130             response = default
131         return response.lower() == 'y'
132
133     def can_open_url(self):
134         try:
135             webbrowser.get()
136             return True
137         except webbrowser.Error, e:
138             return False
139
140     def open_url(self, url):
141         if not self.can_open_url():
142             _log.warn("Failed to open %s" % url)
143         webbrowser.open(url)