Benjamin Peterson | 90f5ba5 | 2010-03-11 22:53:45 +0000 | [diff] [blame] | 1 | #! /usr/bin/env python3 |
Ka-Ping Yee | 0a8c29b | 2001-03-02 02:01:40 +0000 | [diff] [blame] | 2 | """Interfaces for launching and remotely controlling Web browsers.""" |
Guido van Rossum | 992d4a3 | 2007-07-11 13:09:30 +0000 | [diff] [blame] | 3 | # Maintained by Georg Brandl. |
Fred Drake | c70b448 | 2000-07-09 16:45:56 +0000 | [diff] [blame] | 4 | |
| 5 | import os |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 6 | import shlex |
Serhiy Storchaka | 540dcba | 2013-02-13 12:19:40 +0200 | [diff] [blame] | 7 | import shutil |
Fred Drake | c70b448 | 2000-07-09 16:45:56 +0000 | [diff] [blame] | 8 | import sys |
Georg Brandl | 23929f2 | 2006-01-20 21:03:35 +0000 | [diff] [blame] | 9 | import subprocess |
Fred Drake | c70b448 | 2000-07-09 16:45:56 +0000 | [diff] [blame] | 10 | |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 11 | __all__ = ["Error", "open", "open_new", "open_new_tab", "get", "register"] |
Skip Montanaro | 40fc160 | 2001-03-01 04:27:19 +0000 | [diff] [blame] | 12 | |
Fred Drake | c70b448 | 2000-07-09 16:45:56 +0000 | [diff] [blame] | 13 | class Error(Exception): |
| 14 | pass |
| 15 | |
David Steele | e3ce695 | 2017-02-24 23:47:38 -0500 | [diff] [blame^] | 16 | _browsers = {} # Dictionary of available browser controllers |
| 17 | _tryorder = [] # Preference order of available browsers |
| 18 | _os_preferred_browser = None # The preferred browser |
Fred Drake | c70b448 | 2000-07-09 16:45:56 +0000 | [diff] [blame] | 19 | |
David Steele | e3ce695 | 2017-02-24 23:47:38 -0500 | [diff] [blame^] | 20 | def register(name, klass, instance=None, *, preferred=False): |
| 21 | """Register a browser connector.""" |
Fred Drake | c70b448 | 2000-07-09 16:45:56 +0000 | [diff] [blame] | 22 | _browsers[name.lower()] = [klass, instance] |
David Steele | e3ce695 | 2017-02-24 23:47:38 -0500 | [diff] [blame^] | 23 | |
| 24 | # Preferred browsers go to the front of the list. |
| 25 | # Need to match to the default browser returned by xdg-settings, which |
| 26 | # may be of the form e.g. "firefox.desktop". |
| 27 | if preferred or (_os_preferred_browser and name in _os_preferred_browser): |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 28 | _tryorder.insert(0, name) |
David Steele | e3ce695 | 2017-02-24 23:47:38 -0500 | [diff] [blame^] | 29 | else: |
| 30 | _tryorder.append(name) |
Fred Drake | c70b448 | 2000-07-09 16:45:56 +0000 | [diff] [blame] | 31 | |
Eric S. Raymond | f7f1851 | 2001-01-23 13:16:32 +0000 | [diff] [blame] | 32 | def get(using=None): |
| 33 | """Return a browser launcher instance appropriate for the environment.""" |
Raymond Hettinger | 10ff706 | 2002-06-02 03:04:52 +0000 | [diff] [blame] | 34 | if using is not None: |
Eric S. Raymond | f7f1851 | 2001-01-23 13:16:32 +0000 | [diff] [blame] | 35 | alternatives = [using] |
| 36 | else: |
| 37 | alternatives = _tryorder |
| 38 | for browser in alternatives: |
Raymond Hettinger | bac788a | 2004-05-04 09:21:43 +0000 | [diff] [blame] | 39 | if '%s' in browser: |
Georg Brandl | 23929f2 | 2006-01-20 21:03:35 +0000 | [diff] [blame] | 40 | # User gave us a command line, split it into name and args |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 41 | browser = shlex.split(browser) |
| 42 | if browser[-1] == '&': |
| 43 | return BackgroundBrowser(browser[:-1]) |
| 44 | else: |
| 45 | return GenericBrowser(browser) |
Eric S. Raymond | f7f1851 | 2001-01-23 13:16:32 +0000 | [diff] [blame] | 46 | else: |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 47 | # User gave us a browser name or path. |
Fred Drake | f4e5bd9 | 2001-04-12 22:07:27 +0000 | [diff] [blame] | 48 | try: |
| 49 | command = _browsers[browser.lower()] |
| 50 | except KeyError: |
| 51 | command = _synthesize(browser) |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 52 | if command[1] is not None: |
Eric S. Raymond | f7f1851 | 2001-01-23 13:16:32 +0000 | [diff] [blame] | 53 | return command[1] |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 54 | elif command[0] is not None: |
| 55 | return command[0]() |
Eric S. Raymond | f7f1851 | 2001-01-23 13:16:32 +0000 | [diff] [blame] | 56 | raise Error("could not locate runnable browser") |
Fred Drake | c70b448 | 2000-07-09 16:45:56 +0000 | [diff] [blame] | 57 | |
| 58 | # Please note: the following definition hides a builtin function. |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 59 | # It is recommended one does "import webbrowser" and uses webbrowser.open(url) |
| 60 | # instead of "from webbrowser import *". |
Fred Drake | c70b448 | 2000-07-09 16:45:56 +0000 | [diff] [blame] | 61 | |
Alexandre Vassalotti | e223eb8 | 2009-07-29 20:12:15 +0000 | [diff] [blame] | 62 | def open(url, new=0, autoraise=True): |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 63 | for name in _tryorder: |
| 64 | browser = get(name) |
| 65 | if browser.open(url, new, autoraise): |
| 66 | return True |
| 67 | return False |
Fred Drake | c70b448 | 2000-07-09 16:45:56 +0000 | [diff] [blame] | 68 | |
Fred Drake | 3f8f164 | 2001-07-19 03:46:26 +0000 | [diff] [blame] | 69 | def open_new(url): |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 70 | return open(url, 1) |
| 71 | |
| 72 | def open_new_tab(url): |
| 73 | return open(url, 2) |
Fred Drake | c70b448 | 2000-07-09 16:45:56 +0000 | [diff] [blame] | 74 | |
Fred Drake | f4e5bd9 | 2001-04-12 22:07:27 +0000 | [diff] [blame] | 75 | |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 76 | def _synthesize(browser, update_tryorder=1): |
Fred Drake | f4e5bd9 | 2001-04-12 22:07:27 +0000 | [diff] [blame] | 77 | """Attempt to synthesize a controller base on existing controllers. |
| 78 | |
| 79 | This is useful to create a controller when a user specifies a path to |
| 80 | an entry in the BROWSER environment variable -- we can copy a general |
| 81 | controller to operate using a specific installation of the desired |
| 82 | browser in this way. |
| 83 | |
| 84 | If we can't create a controller in this way, or if there is no |
| 85 | executable for the requested browser, return [None, None]. |
| 86 | |
| 87 | """ |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 88 | cmd = browser.split()[0] |
Serhiy Storchaka | 540dcba | 2013-02-13 12:19:40 +0200 | [diff] [blame] | 89 | if not shutil.which(cmd): |
Fred Drake | f4e5bd9 | 2001-04-12 22:07:27 +0000 | [diff] [blame] | 90 | return [None, None] |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 91 | name = os.path.basename(cmd) |
Fred Drake | f4e5bd9 | 2001-04-12 22:07:27 +0000 | [diff] [blame] | 92 | try: |
| 93 | command = _browsers[name.lower()] |
| 94 | except KeyError: |
| 95 | return [None, None] |
| 96 | # now attempt to clone to fit the new name: |
| 97 | controller = command[1] |
| 98 | if controller and name.lower() == controller.basename: |
| 99 | import copy |
| 100 | controller = copy.copy(controller) |
| 101 | controller.name = browser |
| 102 | controller.basename = os.path.basename(browser) |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 103 | register(browser, None, controller, update_tryorder) |
Fred Drake | f4e5bd9 | 2001-04-12 22:07:27 +0000 | [diff] [blame] | 104 | return [None, controller] |
Andrew M. Kuchling | 118aa53 | 2001-08-13 14:37:23 +0000 | [diff] [blame] | 105 | return [None, None] |
Fred Drake | f4e5bd9 | 2001-04-12 22:07:27 +0000 | [diff] [blame] | 106 | |
Fred Drake | 3f8f164 | 2001-07-19 03:46:26 +0000 | [diff] [blame] | 107 | |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 108 | # General parent classes |
| 109 | |
| 110 | class BaseBrowser(object): |
Georg Brandl | 23929f2 | 2006-01-20 21:03:35 +0000 | [diff] [blame] | 111 | """Parent class for all browsers. Do not use directly.""" |
Tim Peters | 887c080 | 2006-01-20 23:40:56 +0000 | [diff] [blame] | 112 | |
Georg Brandl | 23929f2 | 2006-01-20 21:03:35 +0000 | [diff] [blame] | 113 | args = ['%s'] |
Tim Peters | 887c080 | 2006-01-20 23:40:56 +0000 | [diff] [blame] | 114 | |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 115 | def __init__(self, name=""): |
| 116 | self.name = name |
Georg Brandl | b980113 | 2005-10-08 20:47:38 +0000 | [diff] [blame] | 117 | self.basename = name |
Tim Peters | 536cf99 | 2005-12-25 23:18:31 +0000 | [diff] [blame] | 118 | |
Alexandre Vassalotti | e223eb8 | 2009-07-29 20:12:15 +0000 | [diff] [blame] | 119 | def open(self, url, new=0, autoraise=True): |
Neal Norwitz | 196f733 | 2005-10-04 03:17:49 +0000 | [diff] [blame] | 120 | raise NotImplementedError |
| 121 | |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 122 | def open_new(self, url): |
| 123 | return self.open(url, 1) |
| 124 | |
| 125 | def open_new_tab(self, url): |
| 126 | return self.open(url, 2) |
Fred Drake | 3f8f164 | 2001-07-19 03:46:26 +0000 | [diff] [blame] | 127 | |
| 128 | |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 129 | class GenericBrowser(BaseBrowser): |
| 130 | """Class for all browsers started with a command |
| 131 | and without remote functionality.""" |
| 132 | |
Georg Brandl | 23929f2 | 2006-01-20 21:03:35 +0000 | [diff] [blame] | 133 | def __init__(self, name): |
Guido van Rossum | 3172c5d | 2007-10-16 18:12:55 +0000 | [diff] [blame] | 134 | if isinstance(name, str): |
Georg Brandl | 23929f2 | 2006-01-20 21:03:35 +0000 | [diff] [blame] | 135 | self.name = name |
Guido van Rossum | 992d4a3 | 2007-07-11 13:09:30 +0000 | [diff] [blame] | 136 | self.args = ["%s"] |
Georg Brandl | 23929f2 | 2006-01-20 21:03:35 +0000 | [diff] [blame] | 137 | else: |
| 138 | # name should be a list with arguments |
| 139 | self.name = name[0] |
| 140 | self.args = name[1:] |
Georg Brandl | b980113 | 2005-10-08 20:47:38 +0000 | [diff] [blame] | 141 | self.basename = os.path.basename(self.name) |
Fred Drake | 3f8f164 | 2001-07-19 03:46:26 +0000 | [diff] [blame] | 142 | |
Alexandre Vassalotti | e223eb8 | 2009-07-29 20:12:15 +0000 | [diff] [blame] | 143 | def open(self, url, new=0, autoraise=True): |
Tim Peters | 887c080 | 2006-01-20 23:40:56 +0000 | [diff] [blame] | 144 | cmdline = [self.name] + [arg.replace("%s", url) |
Georg Brandl | 23929f2 | 2006-01-20 21:03:35 +0000 | [diff] [blame] | 145 | for arg in self.args] |
| 146 | try: |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 147 | if sys.platform[:3] == 'win': |
| 148 | p = subprocess.Popen(cmdline) |
| 149 | else: |
| 150 | p = subprocess.Popen(cmdline, close_fds=True) |
Georg Brandl | 23929f2 | 2006-01-20 21:03:35 +0000 | [diff] [blame] | 151 | return not p.wait() |
| 152 | except OSError: |
| 153 | return False |
| 154 | |
| 155 | |
| 156 | class BackgroundBrowser(GenericBrowser): |
| 157 | """Class for all browsers which are to be started in the |
| 158 | background.""" |
| 159 | |
Alexandre Vassalotti | e223eb8 | 2009-07-29 20:12:15 +0000 | [diff] [blame] | 160 | def open(self, url, new=0, autoraise=True): |
Georg Brandl | 23929f2 | 2006-01-20 21:03:35 +0000 | [diff] [blame] | 161 | cmdline = [self.name] + [arg.replace("%s", url) |
| 162 | for arg in self.args] |
Georg Brandl | 23929f2 | 2006-01-20 21:03:35 +0000 | [diff] [blame] | 163 | try: |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 164 | if sys.platform[:3] == 'win': |
| 165 | p = subprocess.Popen(cmdline) |
| 166 | else: |
Gregory P. Smith | feac398 | 2014-08-27 09:34:38 -0700 | [diff] [blame] | 167 | p = subprocess.Popen(cmdline, close_fds=True, |
| 168 | start_new_session=True) |
Georg Brandl | 23929f2 | 2006-01-20 21:03:35 +0000 | [diff] [blame] | 169 | return (p.poll() is None) |
| 170 | except OSError: |
| 171 | return False |
Fred Drake | 3f8f164 | 2001-07-19 03:46:26 +0000 | [diff] [blame] | 172 | |
| 173 | |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 174 | class UnixBrowser(BaseBrowser): |
| 175 | """Parent class for all Unix browsers with remote functionality.""" |
Fred Drake | 3f8f164 | 2001-07-19 03:46:26 +0000 | [diff] [blame] | 176 | |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 177 | raise_opts = None |
R David Murray | 94dd7cb | 2012-09-03 12:30:12 -0400 | [diff] [blame] | 178 | background = False |
| 179 | redirect_stdout = True |
| 180 | # In remote_args, %s will be replaced with the requested URL. %action will |
| 181 | # be replaced depending on the value of 'new' passed to open. |
| 182 | # remote_action is used for new=0 (open). If newwin is not None, it is |
| 183 | # used for new=1 (open_new). If newtab is not None, it is used for |
| 184 | # new=3 (open_new_tab). After both substitutions are made, any empty |
| 185 | # strings in the transformed remote_args list will be removed. |
Georg Brandl | 23929f2 | 2006-01-20 21:03:35 +0000 | [diff] [blame] | 186 | remote_args = ['%action', '%s'] |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 187 | remote_action = None |
| 188 | remote_action_newwin = None |
| 189 | remote_action_newtab = None |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 190 | |
Georg Brandl | 23929f2 | 2006-01-20 21:03:35 +0000 | [diff] [blame] | 191 | def _invoke(self, args, remote, autoraise): |
| 192 | raise_opt = [] |
| 193 | if remote and self.raise_opts: |
| 194 | # use autoraise argument only for remote invocation |
Alexandre Vassalotti | e223eb8 | 2009-07-29 20:12:15 +0000 | [diff] [blame] | 195 | autoraise = int(autoraise) |
Georg Brandl | 23929f2 | 2006-01-20 21:03:35 +0000 | [diff] [blame] | 196 | opt = self.raise_opts[autoraise] |
| 197 | if opt: raise_opt = [opt] |
| 198 | |
| 199 | cmdline = [self.name] + raise_opt + args |
Tim Peters | 887c080 | 2006-01-20 23:40:56 +0000 | [diff] [blame] | 200 | |
Georg Brandl | 23929f2 | 2006-01-20 21:03:35 +0000 | [diff] [blame] | 201 | if remote or self.background: |
R David Murray | 02ca144 | 2012-09-03 12:44:29 -0400 | [diff] [blame] | 202 | inout = subprocess.DEVNULL |
Georg Brandl | 23929f2 | 2006-01-20 21:03:35 +0000 | [diff] [blame] | 203 | else: |
| 204 | # for TTY browsers, we need stdin/out |
| 205 | inout = None |
Georg Brandl | 23929f2 | 2006-01-20 21:03:35 +0000 | [diff] [blame] | 206 | p = subprocess.Popen(cmdline, close_fds=True, stdin=inout, |
| 207 | stdout=(self.redirect_stdout and inout or None), |
Gregory P. Smith | 8f7724f | 2011-03-15 15:24:43 -0400 | [diff] [blame] | 208 | stderr=inout, start_new_session=True) |
Georg Brandl | 23929f2 | 2006-01-20 21:03:35 +0000 | [diff] [blame] | 209 | if remote: |
Jesus Cea | c9aa321 | 2012-08-01 03:57:52 +0200 | [diff] [blame] | 210 | # wait at most five seconds. If the subprocess is not finished, the |
Georg Brandl | 23929f2 | 2006-01-20 21:03:35 +0000 | [diff] [blame] | 211 | # remote invocation has (hopefully) started a new instance. |
Jesus Cea | c9aa321 | 2012-08-01 03:57:52 +0200 | [diff] [blame] | 212 | try: |
| 213 | rc = p.wait(5) |
| 214 | # if remote call failed, open() will try direct invocation |
| 215 | return not rc |
| 216 | except subprocess.TimeoutExpired: |
| 217 | return True |
Georg Brandl | 23929f2 | 2006-01-20 21:03:35 +0000 | [diff] [blame] | 218 | elif self.background: |
| 219 | if p.poll() is None: |
| 220 | return True |
| 221 | else: |
| 222 | return False |
| 223 | else: |
| 224 | return not p.wait() |
Fred Drake | 3f8f164 | 2001-07-19 03:46:26 +0000 | [diff] [blame] | 225 | |
Alexandre Vassalotti | e223eb8 | 2009-07-29 20:12:15 +0000 | [diff] [blame] | 226 | def open(self, url, new=0, autoraise=True): |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 227 | if new == 0: |
| 228 | action = self.remote_action |
| 229 | elif new == 1: |
| 230 | action = self.remote_action_newwin |
| 231 | elif new == 2: |
| 232 | if self.remote_action_newtab is None: |
| 233 | action = self.remote_action_newwin |
| 234 | else: |
| 235 | action = self.remote_action_newtab |
Fred Drake | 3f8f164 | 2001-07-19 03:46:26 +0000 | [diff] [blame] | 236 | else: |
Georg Brandl | 23929f2 | 2006-01-20 21:03:35 +0000 | [diff] [blame] | 237 | raise Error("Bad 'new' parameter to open(); " + |
| 238 | "expected 0, 1, or 2, got %s" % new) |
Tim Peters | 887c080 | 2006-01-20 23:40:56 +0000 | [diff] [blame] | 239 | |
Georg Brandl | 23929f2 | 2006-01-20 21:03:35 +0000 | [diff] [blame] | 240 | args = [arg.replace("%s", url).replace("%action", action) |
| 241 | for arg in self.remote_args] |
R David Murray | 94dd7cb | 2012-09-03 12:30:12 -0400 | [diff] [blame] | 242 | args = [arg for arg in args if arg] |
Georg Brandl | 23929f2 | 2006-01-20 21:03:35 +0000 | [diff] [blame] | 243 | success = self._invoke(args, True, autoraise) |
| 244 | if not success: |
| 245 | # remote invocation failed, try straight way |
| 246 | args = [arg.replace("%s", url) for arg in self.args] |
| 247 | return self._invoke(args, False, False) |
| 248 | else: |
| 249 | return True |
Fred Drake | 3f8f164 | 2001-07-19 03:46:26 +0000 | [diff] [blame] | 250 | |
| 251 | |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 252 | class Mozilla(UnixBrowser): |
Serhiy Storchaka | c9b750d | 2016-10-30 19:16:33 +0200 | [diff] [blame] | 253 | """Launcher class for Mozilla browsers.""" |
| 254 | |
| 255 | remote_args = ['%action', '%s'] |
| 256 | remote_action = "" |
| 257 | remote_action_newwin = "-new-window" |
| 258 | remote_action_newtab = "-new-tab" |
| 259 | background = True |
| 260 | |
| 261 | |
| 262 | class Netscape(UnixBrowser): |
| 263 | """Launcher class for Netscape browser.""" |
Neal Norwitz | 8dd28eb | 2002-10-10 22:49:29 +0000 | [diff] [blame] | 264 | |
Georg Brandl | 23929f2 | 2006-01-20 21:03:35 +0000 | [diff] [blame] | 265 | raise_opts = ["-noraise", "-raise"] |
Georg Brandl | 23929f2 | 2006-01-20 21:03:35 +0000 | [diff] [blame] | 266 | remote_args = ['-remote', 'openURL(%s%action)'] |
| 267 | remote_action = "" |
| 268 | remote_action_newwin = ",new-window" |
| 269 | remote_action_newtab = ",new-tab" |
Georg Brandl | 23929f2 | 2006-01-20 21:03:35 +0000 | [diff] [blame] | 270 | background = True |
Neal Norwitz | 8dd28eb | 2002-10-10 22:49:29 +0000 | [diff] [blame] | 271 | |
Neal Norwitz | 8dd28eb | 2002-10-10 22:49:29 +0000 | [diff] [blame] | 272 | |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 273 | class Galeon(UnixBrowser): |
| 274 | """Launcher class for Galeon/Epiphany browsers.""" |
| 275 | |
Georg Brandl | 23929f2 | 2006-01-20 21:03:35 +0000 | [diff] [blame] | 276 | raise_opts = ["-noraise", ""] |
| 277 | remote_args = ['%action', '%s'] |
| 278 | remote_action = "-n" |
| 279 | remote_action_newwin = "-w" |
Georg Brandl | 23929f2 | 2006-01-20 21:03:35 +0000 | [diff] [blame] | 280 | background = True |
Fred Drake | 3f8f164 | 2001-07-19 03:46:26 +0000 | [diff] [blame] | 281 | |
| 282 | |
Senthil Kumaran | ea6b418 | 2011-12-21 22:20:32 +0800 | [diff] [blame] | 283 | class Chrome(UnixBrowser): |
| 284 | "Launcher class for Google Chrome browser." |
| 285 | |
| 286 | remote_args = ['%action', '%s'] |
| 287 | remote_action = "" |
| 288 | remote_action_newwin = "--new-window" |
| 289 | remote_action_newtab = "" |
| 290 | background = True |
| 291 | |
| 292 | Chromium = Chrome |
| 293 | |
| 294 | |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 295 | class Opera(UnixBrowser): |
| 296 | "Launcher class for Opera browser." |
| 297 | |
Terry Reedy | dad532f | 2010-12-28 19:30:19 +0000 | [diff] [blame] | 298 | raise_opts = ["-noraise", ""] |
Georg Brandl | 23929f2 | 2006-01-20 21:03:35 +0000 | [diff] [blame] | 299 | remote_args = ['-remote', 'openURL(%s%action)'] |
| 300 | remote_action = "" |
| 301 | remote_action_newwin = ",new-window" |
| 302 | remote_action_newtab = ",new-page" |
| 303 | background = True |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 304 | |
| 305 | |
| 306 | class Elinks(UnixBrowser): |
| 307 | "Launcher class for Elinks browsers." |
| 308 | |
Georg Brandl | 23929f2 | 2006-01-20 21:03:35 +0000 | [diff] [blame] | 309 | remote_args = ['-remote', 'openURL(%s%action)'] |
| 310 | remote_action = "" |
| 311 | remote_action_newwin = ",new-window" |
| 312 | remote_action_newtab = ",new-tab" |
| 313 | background = False |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 314 | |
Georg Brandl | 23929f2 | 2006-01-20 21:03:35 +0000 | [diff] [blame] | 315 | # elinks doesn't like its stdout to be redirected - |
| 316 | # it uses redirected stdout as a signal to do -dump |
| 317 | redirect_stdout = False |
| 318 | |
| 319 | |
| 320 | class Konqueror(BaseBrowser): |
| 321 | """Controller for the KDE File Manager (kfm, or Konqueror). |
| 322 | |
| 323 | See the output of ``kfmclient --commands`` |
| 324 | for more information on the Konqueror remote-control interface. |
| 325 | """ |
| 326 | |
Alexandre Vassalotti | e223eb8 | 2009-07-29 20:12:15 +0000 | [diff] [blame] | 327 | def open(self, url, new=0, autoraise=True): |
Georg Brandl | 23929f2 | 2006-01-20 21:03:35 +0000 | [diff] [blame] | 328 | # XXX Currently I know no way to prevent KFM from opening a new win. |
| 329 | if new == 2: |
| 330 | action = "newTab" |
| 331 | else: |
| 332 | action = "openURL" |
Tim Peters | 887c080 | 2006-01-20 23:40:56 +0000 | [diff] [blame] | 333 | |
R David Murray | 02ca144 | 2012-09-03 12:44:29 -0400 | [diff] [blame] | 334 | devnull = subprocess.DEVNULL |
Tim Peters | 887c080 | 2006-01-20 23:40:56 +0000 | [diff] [blame] | 335 | |
Georg Brandl | 23929f2 | 2006-01-20 21:03:35 +0000 | [diff] [blame] | 336 | try: |
| 337 | p = subprocess.Popen(["kfmclient", action, url], |
| 338 | close_fds=True, stdin=devnull, |
| 339 | stdout=devnull, stderr=devnull) |
| 340 | except OSError: |
| 341 | # fall through to next variant |
| 342 | pass |
| 343 | else: |
| 344 | p.wait() |
| 345 | # kfmclient's return code unfortunately has no meaning as it seems |
| 346 | return True |
| 347 | |
| 348 | try: |
| 349 | p = subprocess.Popen(["konqueror", "--silent", url], |
| 350 | close_fds=True, stdin=devnull, |
| 351 | stdout=devnull, stderr=devnull, |
Gregory P. Smith | feac398 | 2014-08-27 09:34:38 -0700 | [diff] [blame] | 352 | start_new_session=True) |
Georg Brandl | 23929f2 | 2006-01-20 21:03:35 +0000 | [diff] [blame] | 353 | except OSError: |
| 354 | # fall through to next variant |
| 355 | pass |
| 356 | else: |
| 357 | if p.poll() is None: |
| 358 | # Should be running now. |
| 359 | return True |
Tim Peters | 887c080 | 2006-01-20 23:40:56 +0000 | [diff] [blame] | 360 | |
Georg Brandl | 23929f2 | 2006-01-20 21:03:35 +0000 | [diff] [blame] | 361 | try: |
| 362 | p = subprocess.Popen(["kfm", "-d", url], |
| 363 | close_fds=True, stdin=devnull, |
| 364 | stdout=devnull, stderr=devnull, |
Gregory P. Smith | feac398 | 2014-08-27 09:34:38 -0700 | [diff] [blame] | 365 | start_new_session=True) |
Georg Brandl | 23929f2 | 2006-01-20 21:03:35 +0000 | [diff] [blame] | 366 | except OSError: |
| 367 | return False |
| 368 | else: |
| 369 | return (p.poll() is None) |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 370 | |
| 371 | |
| 372 | class Grail(BaseBrowser): |
Fred Drake | 3f8f164 | 2001-07-19 03:46:26 +0000 | [diff] [blame] | 373 | # There should be a way to maintain a connection to Grail, but the |
| 374 | # Grail remote control protocol doesn't really allow that at this |
Georg Brandl | 23929f2 | 2006-01-20 21:03:35 +0000 | [diff] [blame] | 375 | # point. It probably never will! |
Fred Drake | 3f8f164 | 2001-07-19 03:46:26 +0000 | [diff] [blame] | 376 | def _find_grail_rc(self): |
| 377 | import glob |
| 378 | import pwd |
| 379 | import socket |
| 380 | import tempfile |
| 381 | tempdir = os.path.join(tempfile.gettempdir(), |
| 382 | ".grail-unix") |
Fred Drake | 16623fe | 2001-10-13 16:00:52 +0000 | [diff] [blame] | 383 | user = pwd.getpwuid(os.getuid())[0] |
Fred Drake | 3f8f164 | 2001-07-19 03:46:26 +0000 | [diff] [blame] | 384 | filename = os.path.join(tempdir, user + "-*") |
| 385 | maybes = glob.glob(filename) |
| 386 | if not maybes: |
| 387 | return None |
| 388 | s = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) |
| 389 | for fn in maybes: |
| 390 | # need to PING each one until we find one that's live |
| 391 | try: |
| 392 | s.connect(fn) |
Andrew Svetlov | 0832af6 | 2012-12-18 23:10:48 +0200 | [diff] [blame] | 393 | except OSError: |
Fred Drake | 3f8f164 | 2001-07-19 03:46:26 +0000 | [diff] [blame] | 394 | # no good; attempt to clean it out, but don't fail: |
| 395 | try: |
| 396 | os.unlink(fn) |
Andrew Svetlov | f7a17b4 | 2012-12-25 16:47:37 +0200 | [diff] [blame] | 397 | except OSError: |
Fred Drake | 3f8f164 | 2001-07-19 03:46:26 +0000 | [diff] [blame] | 398 | pass |
| 399 | else: |
| 400 | return s |
| 401 | |
| 402 | def _remote(self, action): |
| 403 | s = self._find_grail_rc() |
| 404 | if not s: |
| 405 | return 0 |
| 406 | s.send(action) |
| 407 | s.close() |
| 408 | return 1 |
| 409 | |
Alexandre Vassalotti | e223eb8 | 2009-07-29 20:12:15 +0000 | [diff] [blame] | 410 | def open(self, url, new=0, autoraise=True): |
Fred Drake | 3f8f164 | 2001-07-19 03:46:26 +0000 | [diff] [blame] | 411 | if new: |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 412 | ok = self._remote("LOADNEW " + url) |
Fred Drake | 3f8f164 | 2001-07-19 03:46:26 +0000 | [diff] [blame] | 413 | else: |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 414 | ok = self._remote("LOAD " + url) |
| 415 | return ok |
Fred Drake | 3f8f164 | 2001-07-19 03:46:26 +0000 | [diff] [blame] | 416 | |
Fred Drake | c70b448 | 2000-07-09 16:45:56 +0000 | [diff] [blame] | 417 | |
Tim Peters | 658cba6 | 2001-02-09 20:06:00 +0000 | [diff] [blame] | 418 | # |
Eric S. Raymond | f7f1851 | 2001-01-23 13:16:32 +0000 | [diff] [blame] | 419 | # Platform support for Unix |
| 420 | # |
Fred Drake | c70b448 | 2000-07-09 16:45:56 +0000 | [diff] [blame] | 421 | |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 422 | # These are the right tests because all these Unix browsers require either |
| 423 | # a console terminal or an X display to run. |
Fred Drake | c70b448 | 2000-07-09 16:45:56 +0000 | [diff] [blame] | 424 | |
Neal Norwitz | 196f733 | 2005-10-04 03:17:49 +0000 | [diff] [blame] | 425 | def register_X_browsers(): |
Eric S. Raymond | f7f1851 | 2001-01-23 13:16:32 +0000 | [diff] [blame] | 426 | |
Matthias Klose | da80b1e | 2012-04-04 14:19:04 +0200 | [diff] [blame] | 427 | # use xdg-open if around |
Serhiy Storchaka | 540dcba | 2013-02-13 12:19:40 +0200 | [diff] [blame] | 428 | if shutil.which("xdg-open"): |
Matthias Klose | da80b1e | 2012-04-04 14:19:04 +0200 | [diff] [blame] | 429 | register("xdg-open", None, BackgroundBrowser("xdg-open")) |
| 430 | |
| 431 | # The default GNOME3 browser |
Serhiy Storchaka | 540dcba | 2013-02-13 12:19:40 +0200 | [diff] [blame] | 432 | if "GNOME_DESKTOP_SESSION_ID" in os.environ and shutil.which("gvfs-open"): |
Matthias Klose | da80b1e | 2012-04-04 14:19:04 +0200 | [diff] [blame] | 433 | register("gvfs-open", None, BackgroundBrowser("gvfs-open")) |
| 434 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 435 | # The default GNOME browser |
Serhiy Storchaka | 540dcba | 2013-02-13 12:19:40 +0200 | [diff] [blame] | 436 | if "GNOME_DESKTOP_SESSION_ID" in os.environ and shutil.which("gnome-open"): |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 437 | register("gnome-open", None, BackgroundBrowser("gnome-open")) |
Eric S. Raymond | f7f1851 | 2001-01-23 13:16:32 +0000 | [diff] [blame] | 438 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 439 | # The default KDE browser |
Serhiy Storchaka | 540dcba | 2013-02-13 12:19:40 +0200 | [diff] [blame] | 440 | if "KDE_FULL_SESSION" in os.environ and shutil.which("kfmclient"): |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 441 | register("kfmclient", Konqueror, Konqueror("kfmclient")) |
| 442 | |
doko@ubuntu.com | f85aca8 | 2013-03-24 18:50:23 +0100 | [diff] [blame] | 443 | if shutil.which("x-www-browser"): |
doko@ubuntu.com | 945c3bb | 2013-03-24 18:46:49 +0100 | [diff] [blame] | 444 | register("x-www-browser", None, BackgroundBrowser("x-www-browser")) |
| 445 | |
Serhiy Storchaka | c9b750d | 2016-10-30 19:16:33 +0200 | [diff] [blame] | 446 | # The Mozilla browsers |
| 447 | for browser in ("firefox", "iceweasel", "iceape", "seamonkey"): |
Serhiy Storchaka | 540dcba | 2013-02-13 12:19:40 +0200 | [diff] [blame] | 448 | if shutil.which(browser): |
Georg Brandl | 4a5a918 | 2005-11-22 19:18:01 +0000 | [diff] [blame] | 449 | register(browser, None, Mozilla(browser)) |
| 450 | |
Serhiy Storchaka | c9b750d | 2016-10-30 19:16:33 +0200 | [diff] [blame] | 451 | # The Netscape and old Mozilla browsers |
| 452 | for browser in ("mozilla-firefox", |
| 453 | "mozilla-firebird", "firebird", |
| 454 | "mozilla", "netscape"): |
| 455 | if shutil.which(browser): |
| 456 | register(browser, None, Netscape(browser)) |
| 457 | |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 458 | # Konqueror/kfm, the KDE browser. |
Serhiy Storchaka | 540dcba | 2013-02-13 12:19:40 +0200 | [diff] [blame] | 459 | if shutil.which("kfm"): |
Georg Brandl | b980113 | 2005-10-08 20:47:38 +0000 | [diff] [blame] | 460 | register("kfm", Konqueror, Konqueror("kfm")) |
Serhiy Storchaka | 540dcba | 2013-02-13 12:19:40 +0200 | [diff] [blame] | 461 | elif shutil.which("konqueror"): |
Georg Brandl | b980113 | 2005-10-08 20:47:38 +0000 | [diff] [blame] | 462 | register("konqueror", Konqueror, Konqueror("konqueror")) |
Neal Norwitz | 8dd28eb | 2002-10-10 22:49:29 +0000 | [diff] [blame] | 463 | |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 464 | # Gnome's Galeon and Epiphany |
| 465 | for browser in ("galeon", "epiphany"): |
Serhiy Storchaka | 540dcba | 2013-02-13 12:19:40 +0200 | [diff] [blame] | 466 | if shutil.which(browser): |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 467 | register(browser, None, Galeon(browser)) |
Gustavo Niemeyer | 1456fde | 2002-11-25 17:25:04 +0000 | [diff] [blame] | 468 | |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 469 | # Skipstone, another Gtk/Mozilla based browser |
Serhiy Storchaka | 540dcba | 2013-02-13 12:19:40 +0200 | [diff] [blame] | 470 | if shutil.which("skipstone"): |
Georg Brandl | 23929f2 | 2006-01-20 21:03:35 +0000 | [diff] [blame] | 471 | register("skipstone", None, BackgroundBrowser("skipstone")) |
Eric S. Raymond | f7f1851 | 2001-01-23 13:16:32 +0000 | [diff] [blame] | 472 | |
Senthil Kumaran | ea6b418 | 2011-12-21 22:20:32 +0800 | [diff] [blame] | 473 | # Google Chrome/Chromium browsers |
| 474 | for browser in ("google-chrome", "chrome", "chromium", "chromium-browser"): |
Serhiy Storchaka | 540dcba | 2013-02-13 12:19:40 +0200 | [diff] [blame] | 475 | if shutil.which(browser): |
Senthil Kumaran | ea6b418 | 2011-12-21 22:20:32 +0800 | [diff] [blame] | 476 | register(browser, None, Chrome(browser)) |
| 477 | |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 478 | # Opera, quite popular |
Serhiy Storchaka | 540dcba | 2013-02-13 12:19:40 +0200 | [diff] [blame] | 479 | if shutil.which("opera"): |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 480 | register("opera", None, Opera("opera")) |
Eric S. Raymond | f7f1851 | 2001-01-23 13:16:32 +0000 | [diff] [blame] | 481 | |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 482 | # Next, Mosaic -- old but still in use. |
Serhiy Storchaka | 540dcba | 2013-02-13 12:19:40 +0200 | [diff] [blame] | 483 | if shutil.which("mosaic"): |
Georg Brandl | 23929f2 | 2006-01-20 21:03:35 +0000 | [diff] [blame] | 484 | register("mosaic", None, BackgroundBrowser("mosaic")) |
Fred Drake | 3f8f164 | 2001-07-19 03:46:26 +0000 | [diff] [blame] | 485 | |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 486 | # Grail, the Python browser. Does anybody still use it? |
Serhiy Storchaka | 540dcba | 2013-02-13 12:19:40 +0200 | [diff] [blame] | 487 | if shutil.which("grail"): |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 488 | register("grail", Grail, None) |
Fred Drake | 3f8f164 | 2001-07-19 03:46:26 +0000 | [diff] [blame] | 489 | |
Neal Norwitz | 196f733 | 2005-10-04 03:17:49 +0000 | [diff] [blame] | 490 | # Prefer X browsers if present |
| 491 | if os.environ.get("DISPLAY"): |
David Steele | e3ce695 | 2017-02-24 23:47:38 -0500 | [diff] [blame^] | 492 | try: |
| 493 | cmd = "xdg-settings get default-web-browser".split() |
| 494 | result = subprocess.check_output(cmd).decode().strip() |
| 495 | except (FileNotFoundError, subprocess.CalledProcessError): |
| 496 | pass |
| 497 | else: |
| 498 | _os_preferred_browser = result |
| 499 | |
Neal Norwitz | 196f733 | 2005-10-04 03:17:49 +0000 | [diff] [blame] | 500 | register_X_browsers() |
| 501 | |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 502 | # Also try console browsers |
| 503 | if os.environ.get("TERM"): |
doko@ubuntu.com | f85aca8 | 2013-03-24 18:50:23 +0100 | [diff] [blame] | 504 | if shutil.which("www-browser"): |
doko@ubuntu.com | 945c3bb | 2013-03-24 18:46:49 +0100 | [diff] [blame] | 505 | register("www-browser", None, GenericBrowser("www-browser")) |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 506 | # The Links/elinks browsers <http://artax.karlin.mff.cuni.cz/~mikulas/links/> |
Serhiy Storchaka | 540dcba | 2013-02-13 12:19:40 +0200 | [diff] [blame] | 507 | if shutil.which("links"): |
Georg Brandl | 23929f2 | 2006-01-20 21:03:35 +0000 | [diff] [blame] | 508 | register("links", None, GenericBrowser("links")) |
Serhiy Storchaka | 540dcba | 2013-02-13 12:19:40 +0200 | [diff] [blame] | 509 | if shutil.which("elinks"): |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 510 | register("elinks", None, Elinks("elinks")) |
| 511 | # The Lynx browser <http://lynx.isc.org/>, <http://lynx.browser.org/> |
Serhiy Storchaka | 540dcba | 2013-02-13 12:19:40 +0200 | [diff] [blame] | 512 | if shutil.which("lynx"): |
Georg Brandl | 23929f2 | 2006-01-20 21:03:35 +0000 | [diff] [blame] | 513 | register("lynx", None, GenericBrowser("lynx")) |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 514 | # The w3m browser <http://w3m.sourceforge.net/> |
Serhiy Storchaka | 540dcba | 2013-02-13 12:19:40 +0200 | [diff] [blame] | 515 | if shutil.which("w3m"): |
Georg Brandl | 23929f2 | 2006-01-20 21:03:35 +0000 | [diff] [blame] | 516 | register("w3m", None, GenericBrowser("w3m")) |
Fred Drake | 3f8f164 | 2001-07-19 03:46:26 +0000 | [diff] [blame] | 517 | |
Eric S. Raymond | f7f1851 | 2001-01-23 13:16:32 +0000 | [diff] [blame] | 518 | # |
| 519 | # Platform support for Windows |
| 520 | # |
Fred Drake | c70b448 | 2000-07-09 16:45:56 +0000 | [diff] [blame] | 521 | |
| 522 | if sys.platform[:3] == "win": |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 523 | class WindowsDefault(BaseBrowser): |
Alexandre Vassalotti | e223eb8 | 2009-07-29 20:12:15 +0000 | [diff] [blame] | 524 | def open(self, url, new=0, autoraise=True): |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 525 | try: |
Steve Dower | 2ebd8f5 | 2015-09-05 11:57:47 -0700 | [diff] [blame] | 526 | os.startfile(url) |
Andrew Svetlov | 2606a6f | 2012-12-19 14:33:35 +0200 | [diff] [blame] | 527 | except OSError: |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 528 | # [Error 22] No application is associated with the specified |
| 529 | # file for this operation: '<URL>' |
| 530 | return False |
| 531 | else: |
| 532 | return True |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 533 | |
| 534 | _tryorder = [] |
| 535 | _browsers = {} |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 536 | |
Steve Dower | 2ebd8f5 | 2015-09-05 11:57:47 -0700 | [diff] [blame] | 537 | # First try to use the default Windows browser |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 538 | register("windows-default", WindowsDefault) |
| 539 | |
Steve Dower | 2ebd8f5 | 2015-09-05 11:57:47 -0700 | [diff] [blame] | 540 | # Detect some common Windows browsers, fallback to IE |
| 541 | iexplore = os.path.join(os.environ.get("PROGRAMFILES", "C:\\Program Files"), |
| 542 | "Internet Explorer\\IEXPLORE.EXE") |
| 543 | for browser in ("firefox", "firebird", "seamonkey", "mozilla", |
| 544 | "netscape", "opera", iexplore): |
| 545 | if shutil.which(browser): |
| 546 | register(browser, None, BackgroundBrowser(browser)) |
Fred Drake | c70b448 | 2000-07-09 16:45:56 +0000 | [diff] [blame] | 547 | |
Fred Drake | c70b448 | 2000-07-09 16:45:56 +0000 | [diff] [blame] | 548 | # |
Eric S. Raymond | f7f1851 | 2001-01-23 13:16:32 +0000 | [diff] [blame] | 549 | # Platform support for MacOS |
| 550 | # |
Fred Drake | c70b448 | 2000-07-09 16:45:56 +0000 | [diff] [blame] | 551 | |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 552 | if sys.platform == 'darwin': |
| 553 | # Adapted from patch submitted to SourceForge by Steven J. Burr |
| 554 | class MacOSX(BaseBrowser): |
| 555 | """Launcher class for Aqua browsers on Mac OS X |
| 556 | |
| 557 | Optionally specify a browser name on instantiation. Note that this |
| 558 | will not work for Aqua browsers if the user has moved the application |
| 559 | package after installation. |
| 560 | |
| 561 | If no browser is specified, the default browser, as specified in the |
| 562 | Internet System Preferences panel, will be used. |
| 563 | """ |
| 564 | def __init__(self, name): |
| 565 | self.name = name |
| 566 | |
Alexandre Vassalotti | e223eb8 | 2009-07-29 20:12:15 +0000 | [diff] [blame] | 567 | def open(self, url, new=0, autoraise=True): |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 568 | assert "'" not in url |
Georg Brandl | 23929f2 | 2006-01-20 21:03:35 +0000 | [diff] [blame] | 569 | # hack for local urls |
| 570 | if not ':' in url: |
| 571 | url = 'file:'+url |
Tim Peters | 887c080 | 2006-01-20 23:40:56 +0000 | [diff] [blame] | 572 | |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 573 | # new must be 0 or 1 |
| 574 | new = int(bool(new)) |
| 575 | if self.name == "default": |
| 576 | # User called open, open_new or get without a browser parameter |
Georg Brandl | 1cb179e | 2005-11-09 21:42:48 +0000 | [diff] [blame] | 577 | script = 'open location "%s"' % url.replace('"', '%22') # opens in default browser |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 578 | else: |
| 579 | # User called get and chose a browser |
| 580 | if self.name == "OmniWeb": |
| 581 | toWindow = "" |
| 582 | else: |
| 583 | # Include toWindow parameter of OpenURL command for browsers |
| 584 | # that support it. 0 == new window; -1 == existing |
| 585 | toWindow = "toWindow %d" % (new - 1) |
Georg Brandl | 1cb179e | 2005-11-09 21:42:48 +0000 | [diff] [blame] | 586 | cmd = 'OpenURL "%s"' % url.replace('"', '%22') |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 587 | script = '''tell application "%s" |
| 588 | activate |
| 589 | %s %s |
| 590 | end tell''' % (self.name, cmd, toWindow) |
| 591 | # Open pipe to AppleScript through osascript command |
| 592 | osapipe = os.popen("osascript", "w") |
| 593 | if osapipe is None: |
| 594 | return False |
| 595 | # Write script to osascript's stdin |
| 596 | osapipe.write(script) |
| 597 | rc = osapipe.close() |
| 598 | return not rc |
| 599 | |
Ronald Oussoren | 4d39f6e | 2010-05-02 09:54:35 +0000 | [diff] [blame] | 600 | class MacOSXOSAScript(BaseBrowser): |
| 601 | def __init__(self, name): |
| 602 | self._name = name |
| 603 | |
| 604 | def open(self, url, new=0, autoraise=True): |
| 605 | if self._name == 'default': |
| 606 | script = 'open location "%s"' % url.replace('"', '%22') # opens in default browser |
| 607 | else: |
| 608 | script = ''' |
| 609 | tell application "%s" |
| 610 | activate |
| 611 | open location "%s" |
| 612 | end |
| 613 | '''%(self._name, url.replace('"', '%22')) |
| 614 | |
| 615 | osapipe = os.popen("osascript", "w") |
| 616 | if osapipe is None: |
| 617 | return False |
| 618 | |
| 619 | osapipe.write(script) |
| 620 | rc = osapipe.close() |
| 621 | return not rc |
| 622 | |
| 623 | |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 624 | # Don't clear _tryorder or _browsers since OS X can use above Unix support |
| 625 | # (but we prefer using the OS X specific stuff) |
David Steele | e3ce695 | 2017-02-24 23:47:38 -0500 | [diff] [blame^] | 626 | register("safari", None, MacOSXOSAScript('safari'), preferred=True) |
| 627 | register("firefox", None, MacOSXOSAScript('firefox'), preferred=True) |
| 628 | register("chrome", None, MacOSXOSAScript('chrome'), preferred=True) |
| 629 | register("MacOSX", None, MacOSXOSAScript('default'), preferred=True) |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 630 | |
Eric S. Raymond | f7f1851 | 2001-01-23 13:16:32 +0000 | [diff] [blame] | 631 | |
| 632 | # OK, now that we know what the default preference orders for each |
| 633 | # platform are, allow user to override them with the BROWSER variable. |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 634 | if "BROWSER" in os.environ: |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 635 | _userchoices = os.environ["BROWSER"].split(os.pathsep) |
| 636 | _userchoices.reverse() |
Skip Montanaro | cdab3bf | 2001-07-18 20:03:32 +0000 | [diff] [blame] | 637 | |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 638 | # Treat choices in same way as if passed into get() but do register |
| 639 | # and prepend to _tryorder |
| 640 | for cmdline in _userchoices: |
| 641 | if cmdline != '': |
Benjamin Peterson | 8719ad5 | 2009-09-11 22:24:02 +0000 | [diff] [blame] | 642 | cmd = _synthesize(cmdline, -1) |
| 643 | if cmd[1] is None: |
David Steele | e3ce695 | 2017-02-24 23:47:38 -0500 | [diff] [blame^] | 644 | register(cmdline, None, GenericBrowser(cmdline), preferred=True) |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 645 | cmdline = None # to make del work if _userchoices was empty |
| 646 | del cmdline |
| 647 | del _userchoices |
Skip Montanaro | cdab3bf | 2001-07-18 20:03:32 +0000 | [diff] [blame] | 648 | |
Skip Montanaro | cdab3bf | 2001-07-18 20:03:32 +0000 | [diff] [blame] | 649 | # what to do if _tryorder is now empty? |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 650 | |
| 651 | |
| 652 | def main(): |
| 653 | import getopt |
| 654 | usage = """Usage: %s [-n | -t] url |
| 655 | -n: open new window |
| 656 | -t: open new tab""" % sys.argv[0] |
| 657 | try: |
| 658 | opts, args = getopt.getopt(sys.argv[1:], 'ntd') |
Guido van Rossum | b940e11 | 2007-01-10 16:19:56 +0000 | [diff] [blame] | 659 | except getopt.error as msg: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 660 | print(msg, file=sys.stderr) |
| 661 | print(usage, file=sys.stderr) |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 662 | sys.exit(1) |
| 663 | new_win = 0 |
| 664 | for o, a in opts: |
| 665 | if o == '-n': new_win = 1 |
| 666 | elif o == '-t': new_win = 2 |
Guido van Rossum | b053cd8 | 2006-08-24 03:53:23 +0000 | [diff] [blame] | 667 | if len(args) != 1: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 668 | print(usage, file=sys.stderr) |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 669 | sys.exit(1) |
| 670 | |
| 671 | url = args[0] |
| 672 | open(url, new_win) |
| 673 | |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 674 | print("\a") |
Georg Brandl | 23929f2 | 2006-01-20 21:03:35 +0000 | [diff] [blame] | 675 | |
Georg Brandl | e8f2443 | 2005-10-03 14:16:44 +0000 | [diff] [blame] | 676 | if __name__ == "__main__": |
| 677 | main() |