Commit | Line | Data |
---|---|---|
e8af40ee | 1 | ;;; browse-url.el --- pass a URL to a WWW browser |
8749abea | 2 | |
5fd6d89f | 3 | ;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, |
114f9c96 | 4 | ;; 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc. |
8749abea GM |
5 | |
6 | ;; Author: Denis Howe <dbh@doc.ic.ac.uk> | |
7f61a9ee | 7 | ;; Maintainer: FSF |
8749abea GM |
8 | ;; Created: 03 Apr 1995 |
9 | ;; Keywords: hypertext, hypermedia, mouse | |
10 | ||
11 | ;; This file is part of GNU Emacs. | |
12 | ||
874a927a | 13 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
8749abea | 14 | ;; it under the terms of the GNU General Public License as published by |
874a927a GM |
15 | ;; the Free Software Foundation, either version 3 of the License, or |
16 | ;; (at your option) any later version. | |
8749abea GM |
17 | |
18 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
19 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
20 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
21 | ;; GNU General Public License for more details. | |
22 | ||
23 | ;; You should have received a copy of the GNU General Public License | |
874a927a | 24 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
8749abea GM |
25 | |
26 | ;;; Commentary: | |
27 | ||
28 | ;; This package provides functions which read a URL (Uniform Resource | |
29 | ;; Locator) from the minibuffer, defaulting to the URL around point, | |
30 | ;; and ask a World-Wide Web browser to load it. It can also load the | |
31 | ;; URL associated with the current buffer. Different browsers use | |
32 | ;; different methods of remote control so there is one function for | |
33 | ;; each supported browser. If the chosen browser is not running, it | |
3abc9fa1 DL |
34 | ;; is started. Currently there is support for the following browsers, |
35 | ;; some of them probably now obsolete: | |
36 | ||
37 | ;; Function Browser Earliest version | |
7f61a9ee | 38 | ;; browse-url-mozilla Mozilla Don't know |
49866ff8 | 39 | ;; browse-url-firefox Firefox Don't know (tried with 1.0.1) |
7f61a9ee | 40 | ;; browse-url-galeon Galeon Don't know |
654805e3 | 41 | ;; browse-url-epiphany Epiphany Don't know |
3abc9fa1 DL |
42 | ;; browse-url-netscape Netscape 1.1b1 |
43 | ;; browse-url-mosaic XMosaic/mMosaic <= 2.4 | |
44 | ;; browse-url-cci XMosaic 2.5 | |
45 | ;; browse-url-w3 w3 0 | |
46 | ;; browse-url-w3-gnudoit w3 remotely | |
d9774611 | 47 | ;; browse-url-text-* Any text browser 0 |
3abc9fa1 DL |
48 | ;; browse-url-generic arbitrary |
49 | ;; browse-url-default-windows-browser MS-Windows browser | |
662871dd | 50 | ;; browse-url-default-macosx-browser Mac OS X browser |
b12e6de3 | 51 | ;; browse-url-gnome-moz GNOME interface to Mozilla |
af06f459 | 52 | ;; browse-url-kde KDE konqueror (kfm) |
8c22c51a | 53 | ;; browse-url-elinks Elinks Don't know (tried with 0.12.GIT) |
8749abea GM |
54 | |
55 | ;; [A version of the Netscape browser is now free software | |
56 | ;; <URL:http://www.mozilla.org/>, albeit not GPLed, so it is | |
57 | ;; reasonable to have that as the default.] | |
58 | ||
59 | ;; Note that versions of Netscape before 1.1b1 did not have remote | |
60 | ;; control. <URL:http://www.netscape.com/newsref/std/x-remote.html>. | |
61 | ||
62 | ;; Browsers can cache Web pages so it may be necessary to tell them to | |
63 | ;; reload the current page if it has changed (e.g. if you have edited | |
64 | ;; it). There is currently no perfect automatic solution to this. | |
65 | ||
66 | ;; Netscape allows you to specify the id of the window you want to | |
67 | ;; control but which window DO you want to control and how do you | |
68 | ;; discover its id? | |
69 | ||
6eddc3bb | 70 | ;; William M. Perry's excellent "w3" WWW browser for |
8749abea GM |
71 | ;; Emacs <URL:ftp://cs.indiana.edu/pub/elisp/w3/> |
72 | ;; has a function w3-follow-url-at-point, but that | |
73 | ;; doesn't let you edit the URL like browse-url. | |
74 | ;; The `gnuserv' package that can be used to control it in another | |
75 | ;; Emacs process is available from | |
76 | ;; <URL:ftp://ftp.splode.com/pub/users/friedman/packages/>. | |
77 | ||
8749abea GM |
78 | ;; Lynx is now distributed by the FSF. See also |
79 | ;; <URL:http://lynx.browser.org/>. | |
80 | ||
81 | ;; Free graphical browsers that could be used by `browse-url-generic' | |
82 | ;; include Chimera <URL:ftp://ftp.cs.unlv.edu/pub/chimera> and | |
83 | ;; <URL:http://www.unlv.edu/chimera/>, Arena | |
84 | ;; <URL:ftp://ftp.yggdrasil.com/pub/dist/web/arena> and Amaya | |
85 | ;; <URL:ftp://ftp.w3.org/pub/amaya>. mMosaic | |
85d30d29 PJ |
86 | ;; <URL:ftp://ftp.enst.fr/pub/mbone/mMosaic/>, |
87 | ;; <URL:http://www.enst.fr/~dauphin/mMosaic/> (with development | |
8749abea GM |
88 | ;; support for Java applets and multicast) can be used like Mosaic by |
89 | ;; setting `browse-url-mosaic-program' appropriately. | |
90 | ||
91 | ;; I [Denis Howe, not Dave Love] recommend Nelson Minar | |
92 | ;; <nelson@santafe.edu>'s excellent html-helper-mode.el for editing | |
93 | ;; HTML and thank Nelson for his many useful comments on this code. | |
94 | ;; <URL:http://www.santafe.edu/%7Enelson/hhm-beta/> | |
95 | ||
96 | ;; See also hm--html-menus <URL:http://www.tnt.uni-hannover.de/%7Emuenkel/ | |
97 | ;; software/own/hm--html-menus/>. For composing correct HTML see also | |
98 | ;; PSGML the general SGML structure editor package | |
99 | ;; <URL:ftp://ftp.lysator.liu.se/pub/sgml>; hm--html-menus can be used | |
100 | ;; with this. | |
101 | ||
102 | ;; This package generalises function html-previewer-process in Marc | |
103 | ;; Andreessen's html-mode (LCD modes/html-mode.el.Z). See also the | |
104 | ;; ffap.el package. The huge hyperbole package also contains similar | |
105 | ;; functions. | |
106 | ||
107 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
108 | ;; Help! | |
109 | ||
110 | ;; Can you write and test some code for the Macintrash and Windoze | |
111 | ;; Netscape remote control APIs? (See the URL above). | |
112 | ||
113 | ;; Do any other browsers have remote control? | |
114 | ||
115 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
116 | ;; Usage | |
117 | ||
118 | ;; To display the URL at or before point: | |
119 | ;; M-x browse-url-at-point RET | |
120 | ;; or, similarly but with the opportunity to edit the URL extracted from | |
121 | ;; the buffer, use: | |
122 | ;; M-x browse-url | |
123 | ||
124 | ;; To display a URL by shift-clicking on it, put this in your ~/.emacs | |
125 | ;; file: | |
126 | ;; (global-set-key [S-mouse-2] 'browse-url-at-mouse) | |
127 | ;; (Note that using Shift-mouse-1 is not desirable because | |
128 | ;; that event has a standard meaning in Emacs.) | |
129 | ||
130 | ;; To display the current buffer in a web browser: | |
131 | ;; M-x browse-url-of-buffer RET | |
132 | ||
133 | ;; To display the current region in a web browser: | |
134 | ;; M-x browse-url-of-region RET | |
135 | ||
136 | ;; In Dired, to display the file named on the current line: | |
137 | ;; M-x browse-url-of-dired-file RET | |
138 | ||
139 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
140 | ;; Customisation (~/.emacs) | |
141 | ||
142 | ;; To see what variables are available for customization, type | |
143 | ;; `M-x set-variable browse-url TAB'. Better, use | |
144 | ;; `M-x customize-group browse-url'. | |
145 | ||
146 | ;; Bind the browse-url commands to keys with the `C-c C-z' prefix | |
147 | ;; (as used by html-helper-mode): | |
148 | ;; (global-set-key "\C-c\C-z." 'browse-url-at-point) | |
149 | ;; (global-set-key "\C-c\C-zb" 'browse-url-of-buffer) | |
150 | ;; (global-set-key "\C-c\C-zr" 'browse-url-of-region) | |
151 | ;; (global-set-key "\C-c\C-zu" 'browse-url) | |
152 | ;; (global-set-key "\C-c\C-zv" 'browse-url-of-file) | |
153 | ;; (add-hook 'dired-mode-hook | |
154 | ;; (lambda () | |
155 | ;; (local-set-key "\C-c\C-zf" 'browse-url-of-dired-file))) | |
156 | ||
3abc9fa1 | 157 | ;; Browse URLs in mail messages under RMAIL by clicking mouse-2: |
8749abea GM |
158 | ;; (add-hook 'rmail-mode-hook (lambda () ; rmail-mode startup |
159 | ;; (define-key rmail-mode-map [mouse-2] 'browse-url-at-mouse))) | |
3abc9fa1 | 160 | ;; Alternatively, add `goto-address' to `rmail-show-message-hook'. |
8749abea | 161 | |
3abc9fa1 DL |
162 | ;; Gnus provides a standard feature to activate URLs in article |
163 | ;; buffers for invocation of browse-url. | |
8749abea GM |
164 | |
165 | ;; Use the Emacs w3 browser when not running under X11: | |
166 | ;; (or (eq window-system 'x) | |
167 | ;; (setq browse-url-browser-function 'browse-url-w3)) | |
168 | ||
169 | ;; To always save modified buffers before displaying the file in a browser: | |
170 | ;; (setq browse-url-save-file t) | |
171 | ||
172 | ;; To get round the Netscape caching problem, you could EITHER have | |
173 | ;; write-file in html-helper-mode make Netscape reload the document: | |
174 | ;; | |
175 | ;; (autoload 'browse-url-netscape-reload "browse-url" | |
176 | ;; "Ask a WWW browser to redisplay the current file." t) | |
177 | ;; (add-hook 'html-helper-mode-hook | |
178 | ;; (lambda () | |
179 | ;; (add-hook 'local-write-file-hooks | |
180 | ;; (lambda () | |
181 | ;; (let ((local-write-file-hooks)) | |
182 | ;; (save-buffer)) | |
183 | ;; (browse-url-netscape-reload) | |
184 | ;; t) ; => file written by hook | |
185 | ;; t))) ; append to l-w-f-hooks | |
186 | ;; | |
187 | ;; OR have browse-url-of-file ask Netscape to load and then reload the | |
188 | ;; file: | |
189 | ;; | |
190 | ;; (add-hook 'browse-url-of-file-hook 'browse-url-netscape-reload) | |
191 | ||
192 | ;; You may also want to customise browse-url-netscape-arguments, e.g. | |
193 | ;; (setq browse-url-netscape-arguments '("-install")) | |
194 | ;; | |
195 | ;; or similarly for the other browsers. | |
196 | ||
197 | ;; To invoke different browsers for different URLs: | |
198 | ;; (setq browse-url-browser-function '(("^mailto:" . browse-url-mail) | |
199 | ;; ("." . browse-url-netscape))) | |
200 | ||
201 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
202 | ;;; Code: | |
203 | ||
204 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
205 | ;; Variables | |
206 | ||
5edcabcb EZ |
207 | (eval-when-compile (require 'cl) |
208 | (require 'thingatpt) | |
8749abea GM |
209 | (require 'term) |
210 | (require 'dired) | |
7f61a9ee | 211 | (require 'executable) |
8749abea GM |
212 | (require 'w3-auto nil t)) |
213 | ||
214 | (defgroup browse-url nil | |
215 | "Use a web browser to look at a URL." | |
216 | :prefix "browse-url-" | |
082527fe | 217 | :link '(emacs-commentary-link "browse-url") |
eba5b4dd CY |
218 | :group 'external |
219 | :group 'net) | |
8749abea GM |
220 | |
221 | ;;;###autoload | |
222 | (defcustom browse-url-browser-function | |
662871dd SM |
223 | (cond |
224 | ((memq system-type '(windows-nt ms-dos cygwin)) | |
225 | 'browse-url-default-windows-browser) | |
226 | ((memq system-type '(darwin)) 'browse-url-default-macosx-browser) | |
227 | (t 'browse-url-default-browser)) | |
5e835c9f | 228 | "Function to display the current buffer in a WWW browser. |
8749abea GM |
229 | This is used by the `browse-url-at-point', `browse-url-at-mouse', and |
230 | `browse-url-of-file' commands. | |
231 | ||
232 | If the value is not a function it should be a list of pairs | |
082527fe | 233 | \(REGEXP . FUNCTION). In this case the function called will be the one |
8749abea GM |
234 | associated with the first REGEXP which matches the current URL. The |
235 | function is passed the URL and any other args of `browse-url'. The last | |
236 | regexp should probably be \".\" to specify a default browser." | |
237 | :type '(choice | |
082527fe DL |
238 | (function-item :tag "Emacs W3" :value browse-url-w3) |
239 | (function-item :tag "W3 in another Emacs via `gnudoit'" | |
240 | :value browse-url-w3-gnudoit) | |
7f61a9ee | 241 | (function-item :tag "Mozilla" :value browse-url-mozilla) |
49866ff8 | 242 | (function-item :tag "Firefox" :value browse-url-firefox) |
7f61a9ee | 243 | (function-item :tag "Galeon" :value browse-url-galeon) |
654805e3 | 244 | (function-item :tag "Epiphany" :value browse-url-epiphany) |
082527fe DL |
245 | (function-item :tag "Netscape" :value browse-url-netscape) |
246 | (function-item :tag "Mosaic" :value browse-url-mosaic) | |
247 | (function-item :tag "Mosaic using CCI" :value browse-url-cci) | |
d9774611 RS |
248 | (function-item :tag "Text browser in an xterm window" |
249 | :value browse-url-text-xterm) | |
250 | (function-item :tag "Text browser in an Emacs window" | |
251 | :value browse-url-text-emacs) | |
af06f459 | 252 | (function-item :tag "KDE" :value browse-url-kde) |
8c22c51a | 253 | (function-item :tag "Elinks" :value browse-url-elinks) |
082527fe DL |
254 | (function-item :tag "Specified by `Browse Url Generic Program'" |
255 | :value browse-url-generic) | |
256 | (function-item :tag "Default Windows browser" | |
b12e6de3 | 257 | :value browse-url-default-windows-browser) |
662871dd SM |
258 | (function-item :tag "Default Mac OS X browser" |
259 | :value browse-url-default-macosx-browser) | |
b12e6de3 DL |
260 | (function-item :tag "GNOME invoking Mozilla" |
261 | :value browse-url-gnome-moz) | |
7f61a9ee RS |
262 | (function-item :tag "Default browser" |
263 | :value browse-url-default-browser) | |
082527fe DL |
264 | (function :tag "Your own function") |
265 | (alist :tag "Regexp/function association list" | |
266 | :key-type regexp :value-type function)) | |
f86f6d1e | 267 | :version "21.1" |
8749abea GM |
268 | :group 'browse-url) |
269 | ||
270 | (defcustom browse-url-netscape-program "netscape" | |
271 | ;; Info about netscape-remote from Karl Berry. | |
5e835c9f | 272 | "The name by which to invoke Netscape. |
8749abea GM |
273 | |
274 | The free program `netscape-remote' from | |
275 | <URL:http://home.netscape.com/newsref/std/remote.c> is said to start | |
276 | up very much quicker than `netscape'. Reported to compile on a GNU | |
277 | system, given vroot.h from the same directory, with cc flags | |
278 | -DSTANDALONE -L/usr/X11R6/lib -lXmu -lX11." | |
279 | :type 'string | |
280 | :group 'browse-url) | |
281 | ||
282 | (defcustom browse-url-netscape-arguments nil | |
5e835c9f | 283 | "A list of strings to pass to Netscape as arguments." |
8749abea GM |
284 | :type '(repeat (string :tag "Argument")) |
285 | :group 'browse-url) | |
286 | ||
287 | (defcustom browse-url-netscape-startup-arguments browse-url-netscape-arguments | |
5e835c9f | 288 | "A list of strings to pass to Netscape when it starts up. |
8749abea GM |
289 | Defaults to the value of `browse-url-netscape-arguments' at the time |
290 | `browse-url' is loaded." | |
291 | :type '(repeat (string :tag "Argument")) | |
292 | :group 'browse-url) | |
293 | ||
7f61a9ee | 294 | (defcustom browse-url-browser-display nil |
5e835c9f | 295 | "The X display for running the browser, if not same as Emacs'." |
7f61a9ee RS |
296 | :type '(choice string (const :tag "Default" nil)) |
297 | :group 'browse-url) | |
298 | ||
299 | (defcustom browse-url-mozilla-program "mozilla" | |
5e835c9f | 300 | "The name by which to invoke Mozilla." |
7f61a9ee RS |
301 | :type 'string |
302 | :group 'browse-url) | |
303 | ||
304 | (defcustom browse-url-mozilla-arguments nil | |
5e835c9f | 305 | "A list of strings to pass to Mozilla as arguments." |
7f61a9ee RS |
306 | :type '(repeat (string :tag "Argument")) |
307 | :group 'browse-url) | |
308 | ||
309 | (defcustom browse-url-mozilla-startup-arguments browse-url-mozilla-arguments | |
5e835c9f | 310 | "A list of strings to pass to Mozilla when it starts up. |
7f61a9ee RS |
311 | Defaults to the value of `browse-url-mozilla-arguments' at the time |
312 | `browse-url' is loaded." | |
313 | :type '(repeat (string :tag "Argument")) | |
314 | :group 'browse-url) | |
315 | ||
49866ff8 | 316 | ;;;###autoload |
1e8780b1 | 317 | (defcustom browse-url-firefox-program (purecopy "firefox") |
5e835c9f | 318 | "The name by which to invoke Firefox." |
49866ff8 EZ |
319 | :type 'string |
320 | :group 'browse-url) | |
321 | ||
322 | (defcustom browse-url-firefox-arguments nil | |
5e835c9f | 323 | "A list of strings to pass to Firefox as arguments." |
49866ff8 EZ |
324 | :type '(repeat (string :tag "Argument")) |
325 | :group 'browse-url) | |
326 | ||
327 | (defcustom browse-url-firefox-startup-arguments browse-url-firefox-arguments | |
5e835c9f | 328 | "A list of strings to pass to Firefox when it starts up. |
49866ff8 EZ |
329 | Defaults to the value of `browse-url-firefox-arguments' at the time |
330 | `browse-url' is loaded." | |
331 | :type '(repeat (string :tag "Argument")) | |
332 | :group 'browse-url) | |
333 | ||
334 | ;;;###autoload | |
1e8780b1 | 335 | (defcustom browse-url-galeon-program (purecopy "galeon") |
5e835c9f | 336 | "The name by which to invoke Galeon." |
7f61a9ee RS |
337 | :type 'string |
338 | :group 'browse-url) | |
339 | ||
340 | (defcustom browse-url-galeon-arguments nil | |
5e835c9f | 341 | "A list of strings to pass to Galeon as arguments." |
7f61a9ee RS |
342 | :type '(repeat (string :tag "Argument")) |
343 | :group 'browse-url) | |
344 | ||
345 | (defcustom browse-url-galeon-startup-arguments browse-url-galeon-arguments | |
5e835c9f | 346 | "A list of strings to pass to Galeon when it starts up. |
7f61a9ee RS |
347 | Defaults to the value of `browse-url-galeon-arguments' at the time |
348 | `browse-url' is loaded." | |
349 | :type '(repeat (string :tag "Argument")) | |
350 | :group 'browse-url) | |
351 | ||
654805e3 | 352 | (defcustom browse-url-epiphany-program "epiphany" |
5e835c9f | 353 | "The name by which to invoke Epiphany." |
654805e3 RS |
354 | :type 'string |
355 | :group 'browse-url) | |
356 | ||
357 | (defcustom browse-url-epiphany-arguments nil | |
5e835c9f | 358 | "A list of strings to pass to Epiphany as arguments." |
654805e3 RS |
359 | :type '(repeat (string :tag "Argument")) |
360 | :group 'browse-url) | |
361 | ||
362 | (defcustom browse-url-epiphany-startup-arguments browse-url-epiphany-arguments | |
5e835c9f | 363 | "A list of strings to pass to Epiphany when it starts up. |
654805e3 RS |
364 | Defaults to the value of `browse-url-epiphany-arguments' at the time |
365 | `browse-url' is loaded." | |
366 | :type '(repeat (string :tag "Argument")) | |
367 | :group 'browse-url) | |
368 | ||
db324706 RS |
369 | ;; GNOME means of invoking either Mozilla or Netrape. |
370 | (defvar browse-url-gnome-moz-program "gnome-moz-remote") | |
371 | ||
372 | (defcustom browse-url-gnome-moz-arguments '() | |
5e835c9f | 373 | "A list of strings passed to the GNOME mozilla viewer as arguments." |
db324706 RS |
374 | :version "21.1" |
375 | :type '(repeat (string :tag "Argument")) | |
376 | :group 'browse-url) | |
377 | ||
d6da15ec | 378 | (defcustom browse-url-mozilla-new-window-is-tab nil |
5e835c9f | 379 | "Whether to open up new windows in a tab or a new window. |
d6da15ec SJ |
380 | If non-nil, then open the URL in a new tab rather than a new window if |
381 | `browse-url-mozilla' is asked to open it in a new window." | |
382 | :type 'boolean | |
383 | :group 'browse-url) | |
384 | ||
49866ff8 | 385 | (defcustom browse-url-firefox-new-window-is-tab nil |
5e835c9f | 386 | "Whether to open up new windows in a tab or a new window. |
49866ff8 EZ |
387 | If non-nil, then open the URL in a new tab rather than a new window if |
388 | `browse-url-firefox' is asked to open it in a new window. | |
389 | ||
390 | This option is currently ignored on MS-Windows, since the necessary | |
391 | functionality is not available there." | |
392 | :type 'boolean | |
393 | :group 'browse-url) | |
394 | ||
1d5d4123 | 395 | (defcustom browse-url-galeon-new-window-is-tab nil |
5e835c9f | 396 | "Whether to open up new windows in a tab or a new window. |
1d5d4123 RS |
397 | If non-nil, then open the URL in a new tab rather than a new window if |
398 | `browse-url-galeon' is asked to open it in a new window." | |
399 | :type 'boolean | |
400 | :group 'browse-url) | |
401 | ||
654805e3 | 402 | (defcustom browse-url-epiphany-new-window-is-tab nil |
5e835c9f | 403 | "Whether to open up new windows in a tab or a new window. |
654805e3 RS |
404 | If non-nil, then open the URL in a new tab rather than a new window if |
405 | `browse-url-epiphany' is asked to open it in a new window." | |
406 | :type 'boolean | |
407 | :group 'browse-url) | |
408 | ||
fe77c061 | 409 | (defcustom browse-url-netscape-new-window-is-tab nil |
5e835c9f | 410 | "Whether to open up new windows in a tab or a new window. |
fe77c061 SJ |
411 | If non-nil, then open the URL in a new tab rather than a new |
412 | window if `browse-url-netscape' is asked to open it in a new | |
413 | window." | |
414 | :type 'boolean | |
415 | :group 'browse-url) | |
416 | ||
408d5219 | 417 | (defcustom browse-url-new-window-flag nil |
6eddc3bb | 418 | "Non-nil means always open a new browser window with appropriate browsers. |
8749abea GM |
419 | Passing an interactive argument to \\[browse-url], or specific browser |
420 | commands reverses the effect of this variable. Requires Netscape version | |
421 | 1.1N or later or XMosaic version 2.5 or later if using those browsers." | |
422 | :type 'boolean | |
423 | :group 'browse-url) | |
424 | ||
8749abea | 425 | (defcustom browse-url-mosaic-program "xmosaic" |
5e835c9f | 426 | "The name by which to invoke Mosaic (or mMosaic)." |
8749abea GM |
427 | :type 'string |
428 | :version "20.3" | |
429 | :group 'browse-url) | |
430 | ||
431 | (defcustom browse-url-mosaic-arguments nil | |
5e835c9f | 432 | "A list of strings to pass to Mosaic as arguments." |
8749abea GM |
433 | :type '(repeat (string :tag "Argument")) |
434 | :group 'browse-url) | |
435 | ||
1665be47 | 436 | (defcustom browse-url-mosaic-pidfile "~/.mosaicpid" |
5e835c9f | 437 | "The name of the pidfile created by Mosaic." |
1665be47 RS |
438 | :type 'string |
439 | :group 'browse-url) | |
440 | ||
8749abea | 441 | (defcustom browse-url-filename-alist |
5e835c9f | 442 | `(("^/\\(ftp@\\|anonymous@\\)?\\([^:]+\\):/*" . "ftp://\\2/") |
8749abea GM |
443 | ;; The above loses the username to avoid the browser prompting for |
444 | ;; it in anonymous cases. If it's not anonymous the next regexp | |
445 | ;; applies. | |
446 | ("^/\\([^:@]+@\\)?\\([^:]+\\):/*" . "ftp://\\1\\2/") | |
5e835c9f | 447 | ,@(if (memq system-type '(windows-nt ms-dos cygwin)) |
5241b291 | 448 | '(("^\\([a-zA-Z]:\\)[\\/]" . "file:///\\1/") |
5e835c9f | 449 | ("^[\\/][\\/]+" . "file://"))) |
dee8ac10 | 450 | ("^/+" . "file:///")) |
5e835c9f | 451 | "An alist of (REGEXP . STRING) pairs used by `browse-url-of-file'. |
8749abea GM |
452 | Any substring of a filename matching one of the REGEXPs is replaced by |
453 | the corresponding STRING using `replace-match', not treating STRING | |
454 | literally. All pairs are applied in the order given. The default | |
4dd14ef0 KS |
455 | value converts ange-ftp/EFS-style file names into ftp URLs and prepends |
456 | `file:' to any file name beginning with `/'. | |
8749abea GM |
457 | |
458 | For example, adding to the default a specific translation of an ange-ftp | |
459 | address to an HTTP URL: | |
460 | ||
461 | (setq browse-url-filename-alist | |
462 | '((\"/webmaster@webserver:/home/www/html/\" . | |
463 | \"http://www.acme.co.uk/\") | |
464 | (\"^/\\(ftp@\\|anonymous@\\)?\\([^:]+\\):/*\" . \"ftp://\\2/\") | |
465 | (\"^/\\([^:@]+@\\)?\\([^:]+\\):/*\" . \"ftp://\\1\\2/\") | |
5e835c9f | 466 | (\"^/+\" . \"file:/\")))" |
8749abea GM |
467 | :type '(repeat (cons :format "%v" |
468 | (regexp :tag "Regexp") | |
469 | (string :tag "Replacement"))) | |
3257a734 | 470 | :version "23.1" |
8749abea GM |
471 | :group 'browse-url) |
472 | ||
8749abea | 473 | (defcustom browse-url-save-file nil |
5e835c9f | 474 | "If non-nil, save the buffer before displaying its file. |
8749abea GM |
475 | Used by the `browse-url-of-file' command." |
476 | :type 'boolean | |
477 | :group 'browse-url) | |
478 | ||
479 | (defcustom browse-url-of-file-hook nil | |
5e835c9f | 480 | "Run after `browse-url-of-file' has asked a browser to load a file. |
8749abea GM |
481 | |
482 | Set this to `browse-url-netscape-reload' to force Netscape to load the | |
483 | file rather than displaying a cached copy." | |
484 | :type 'hook | |
485 | :options '(browse-url-netscape-reload) | |
486 | :group 'browse-url) | |
487 | ||
8749abea | 488 | (defcustom browse-url-CCI-port 3003 |
5e835c9f | 489 | "Port to access XMosaic via CCI. |
8749abea GM |
490 | This can be any number between 1024 and 65535 but must correspond to |
491 | the value set in the browser." | |
492 | :type 'integer | |
493 | :group 'browse-url) | |
494 | ||
495 | (defcustom browse-url-CCI-host "localhost" | |
5e835c9f | 496 | "Host to access XMosaic via CCI. |
8749abea GM |
497 | This should be the host name of the machine running XMosaic with CCI |
498 | enabled. The port number should be set in `browse-url-CCI-port'." | |
499 | :type 'string | |
500 | :group 'browse-url) | |
501 | ||
502 | (defvar browse-url-temp-file-name nil) | |
503 | (make-variable-buffer-local 'browse-url-temp-file-name) | |
db6003fb | 504 | |
8749abea | 505 | (defcustom browse-url-xterm-program "xterm" |
d9774611 | 506 | "The name of the terminal emulator used by `browse-url-text-xterm'. |
028f45d2 | 507 | This might, for instance, be a separate color version of xterm." |
8749abea GM |
508 | :type 'string |
509 | :group 'browse-url) | |
510 | ||
511 | (defcustom browse-url-xterm-args nil | |
5e835c9f | 512 | "A list of strings defining options for `browse-url-xterm-program'. |
8749abea GM |
513 | These might set its size, for instance." |
514 | :type '(repeat (string :tag "Argument")) | |
515 | :group 'browse-url) | |
516 | ||
8749abea | 517 | (defcustom browse-url-gnudoit-program "gnudoit" |
5e835c9f | 518 | "The name of the `gnudoit' program used by `browse-url-w3-gnudoit'." |
8749abea GM |
519 | :type 'string |
520 | :group 'browse-url) | |
521 | ||
522 | (defcustom browse-url-gnudoit-args '("-q") | |
5e835c9f | 523 | "A list of strings defining options for `browse-url-gnudoit-program'. |
8749abea GM |
524 | These might set the port, for instance." |
525 | :type '(repeat (string :tag "Argument")) | |
526 | :group 'browse-url) | |
527 | ||
8749abea | 528 | (defcustom browse-url-generic-program nil |
5e835c9f | 529 | "The name of the browser program used by `browse-url-generic'." |
8749abea GM |
530 | :type '(choice string (const :tag "None" nil)) |
531 | :group 'browse-url) | |
532 | ||
533 | (defcustom browse-url-generic-args nil | |
5e835c9f | 534 | "A list of strings defining options for `browse-url-generic-program'." |
8749abea GM |
535 | :type '(repeat (string :tag "Argument")) |
536 | :group 'browse-url) | |
537 | ||
538 | (defcustom browse-url-temp-dir temporary-file-directory | |
5e835c9f | 539 | "The name of a directory for browse-url's temporary files. |
8749abea GM |
540 | Such files are generated by functions like `browse-url-of-region'. |
541 | You might want to set this to somewhere with restricted read permissions | |
542 | for privacy's sake." | |
543 | :type 'string | |
544 | :group 'browse-url) | |
545 | ||
5e835c9f SM |
546 | (defcustom browse-url-netscape-version 3 |
547 | "The version of Netscape you are using. | |
8749abea GM |
548 | This affects how URL reloading is done; the mechanism changed |
549 | incompatibly at version 4." | |
550 | :type 'number | |
551 | :group 'browse-url) | |
552 | ||
d9774611 RS |
553 | (defcustom browse-url-text-browser "lynx" |
554 | "The name of the text browser to invoke." | |
555 | :type 'string | |
556 | :group 'browse-url | |
557 | :version "23.1") | |
558 | ||
559 | (defcustom browse-url-text-emacs-args (and (not window-system) | |
560 | '("-show_cursor")) | |
561 | "A list of strings defining options for a text browser in an Emacs buffer. | |
562 | ||
563 | The default is none in a window system, otherwise `-show_cursor' to | |
564 | indicate the position of the current link in the absence of | |
565 | highlighting, assuming the normal default for showing the cursor." | |
566 | :type '(repeat (string :tag "Argument")) | |
567 | :version "23.1" | |
568 | :group 'browse-url) | |
569 | ||
570 | (defcustom browse-url-text-input-field 'avoid | |
571 | "Action on selecting an existing text browser buffer at an input field. | |
572 | What to do when sending a new URL to an existing text browser buffer in Emacs | |
573 | if the browser cursor is on an input field (in which case the `g' command | |
8749abea | 574 | would be entered as data). Such fields are recognized by the |
d9774611 RS |
575 | underlines ____. Allowed values: nil: disregard it, `warn': warn the |
576 | user and don't emit the URL, `avoid': try to avoid the field by moving | |
8749abea GM |
577 | down (this *won't* always work)." |
578 | :type '(choice (const :tag "Move to try to avoid field" :value avoid) | |
579 | (const :tag "Disregard" :value nil) | |
580 | (const :tag "Warn, don't emit URL" :value warn)) | |
d9774611 | 581 | :version "23.1" |
8749abea GM |
582 | :group 'browse-url) |
583 | ||
d9774611 RS |
584 | (defcustom browse-url-text-input-attempts 10 |
585 | "How many times to try to move down from a series of text browser input fields." | |
64f6f486 | 586 | :type 'integer |
d9774611 | 587 | :version "23.1" |
64f6f486 | 588 | :group 'browse-url) |
8749abea | 589 | |
d9774611 RS |
590 | (defcustom browse-url-text-input-delay 0.2 |
591 | "Seconds to wait for a text browser between moves down from an input field." | |
64f6f486 | 592 | :type 'number |
d9774611 | 593 | :version "23.1" |
64f6f486 | 594 | :group 'browse-url) |
8749abea | 595 | |
af06f459 | 596 | (defcustom browse-url-kde-program "kfmclient" |
5e835c9f | 597 | "The name by which to invoke the KDE web browser." |
af06f459 GM |
598 | :type 'string |
599 | :version "21.1" | |
600 | :group 'browse-url) | |
601 | ||
602 | (defcustom browse-url-kde-args '("openURL") | |
5e835c9f | 603 | "A list of strings defining options for `browse-url-kde-program'." |
af06f459 GM |
604 | :type '(repeat (string :tag "Argument")) |
605 | :group 'browse-url) | |
606 | ||
8c22c51a GM |
607 | (defcustom browse-url-elinks-wrapper '("xterm" "-e") |
608 | "*Wrapper command prepended to the Elinks command-line." | |
609 | :type '(repeat (string :tag "Wrapper")) | |
610 | :group 'browse-url) | |
611 | ||
612 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
613 | ;; URL encoding | |
614 | ||
6eddc3bb MC |
615 | (defun browse-url-url-encode-chars (text chars) |
616 | "URL-encode the chars in TEXT that match CHARS. | |
da76998b | 617 | CHARS is a regexp-like character alternative (e.g., \"[)$]\")." |
59c4e1da | 618 | (let ((encoded-text (copy-sequence text)) |
ad56e18b | 619 | (s 0)) |
59c4e1da MC |
620 | (while (setq s (string-match chars encoded-text s)) |
621 | (setq encoded-text | |
8c22c51a | 622 | (replace-match (format "%%%x" |
59c4e1da MC |
623 | (string-to-char (match-string 0 encoded-text))) |
624 | t t encoded-text) | |
ad56e18b | 625 | s (1+ s))) |
59c4e1da | 626 | encoded-text)) |
8c22c51a | 627 | |
6eddc3bb MC |
628 | (defun browse-url-encode-url (url) |
629 | "Escape annoying characters in URL. | |
da76998b CY |
630 | The annoying characters are those that can mislead a web browser |
631 | regarding its parameter treatment." | |
632 | ;; FIXME: Is there an actual example of a web browser getting | |
633 | ;; confused? (This used to encode commas, but at least Firefox | |
634 | ;; handles commas correctly and doesn't accept encoded commas.) | |
635 | (browse-url-url-encode-chars url "[)$]")) | |
6eddc3bb | 636 | |
8749abea GM |
637 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
638 | ;; URL input | |
639 | ||
6be44fbf | 640 | ;;;###autoload |
8749abea GM |
641 | (defun browse-url-url-at-point () |
642 | (let ((url (thing-at-point 'url))) | |
643 | (set-text-properties 0 (length url) nil url) | |
644 | url)) | |
645 | ||
646 | ;; Having this as a separate function called by the browser-specific | |
647 | ;; functions allows them to be stand-alone commands, making it easier | |
648 | ;; to switch between browsers. | |
649 | ||
650 | (defun browse-url-interactive-arg (prompt) | |
651 | "Read a URL from the minibuffer, prompting with PROMPT. | |
4c493999 | 652 | If `transient-mark-mode' is non-nil and the mark is active, |
657962fc RS |
653 | it defaults to the current region, else to the URL at or before |
654 | point. If invoked with a mouse button, it moves point to the | |
655 | position clicked before acting. | |
656 | ||
657 | This function returns a list (URL NEW-WINDOW-FLAG) | |
658 | for use in `interactive'." | |
8749abea GM |
659 | (let ((event (elt (this-command-keys) 0))) |
660 | (and (listp event) (mouse-set-point event))) | |
4c493999 JB |
661 | (list (read-string prompt (or (and transient-mark-mode mark-active |
662 | ;; rfc2396 Appendix E. | |
663 | (replace-regexp-in-string | |
664 | "[\t\r\f\n ]+" "" | |
665 | (buffer-substring-no-properties | |
666 | (region-beginning) (region-end)))) | |
667 | (browse-url-url-at-point))) | |
408d5219 | 668 | (not (eq (null browse-url-new-window-flag) |
8749abea GM |
669 | (null current-prefix-arg))))) |
670 | ||
2de9d0c3 RS |
671 | ;; called-interactive-p needs to be called at a function's top-level, hence |
672 | ;; this macro. We use that rather than interactive-p because | |
673 | ;; use in a keyboard macro should not change this behavior. | |
01f97560 | 674 | (defmacro browse-url-maybe-new-window (arg) |
12a3c28c | 675 | `(if (or noninteractive (not (called-interactively-p 'any))) |
01f97560 | 676 | ,arg |
408d5219 | 677 | browse-url-new-window-flag)) |
01f97560 | 678 | |
8749abea GM |
679 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
680 | ;; Browse current buffer | |
681 | ||
682 | ;;;###autoload | |
683 | (defun browse-url-of-file (&optional file) | |
684 | "Ask a WWW browser to display FILE. | |
685 | Display the current buffer's file if FILE is nil or if called | |
686 | interactively. Turn the filename into a URL with function | |
687 | `browse-url-file-url'. Pass the URL to a browser using the | |
688 | `browse-url' function then run `browse-url-of-file-hook'." | |
689 | (interactive) | |
690 | (or file | |
691 | (setq file (buffer-file-name)) | |
692 | (error "Current buffer has no file")) | |
693 | (let ((buf (get-file-buffer file))) | |
694 | (if buf | |
378f9937 | 695 | (with-current-buffer buf |
8749abea GM |
696 | (cond ((not (buffer-modified-p))) |
697 | (browse-url-save-file (save-buffer)) | |
698 | (t (message "%s modified since last save" file)))))) | |
699 | (browse-url (browse-url-file-url file)) | |
700 | (run-hooks 'browse-url-of-file-hook)) | |
701 | ||
702 | (defun browse-url-file-url (file) | |
703 | "Return the URL corresponding to FILE. | |
704 | Use variable `browse-url-filename-alist' to map filenames to URLs." | |
5241b291 CY |
705 | ;; De-munge Cygwin filenames before passing them to Windows browser. |
706 | (if (eq system-type 'cygwin) | |
707 | (let ((winfile (with-output-to-string | |
708 | (call-process "cygpath" nil standard-output | |
709 | nil "-m" file)))) | |
710 | (setq file (substring winfile 0 -1)))) | |
95e55d20 | 711 | (let ((coding (and (default-value 'enable-multibyte-characters) |
59b71501 YM |
712 | (or file-name-coding-system |
713 | default-file-name-coding-system)))) | |
714 | (if coding (setq file (encode-coding-string file coding)))) | |
6eddc3bb | 715 | (setq file (browse-url-url-encode-chars file "[*\"()',=;?% ]")) |
63900fcf SS |
716 | (dolist (map browse-url-filename-alist) |
717 | (when (and map (string-match (car map) file)) | |
718 | (setq file (replace-match (cdr map) t nil file)))) | |
8749abea GM |
719 | file) |
720 | ||
721 | ;;;###autoload | |
722 | (defun browse-url-of-buffer (&optional buffer) | |
723 | "Ask a WWW browser to display BUFFER. | |
724 | Display the current buffer if BUFFER is nil. Display only the | |
725 | currently visible part of BUFFER (from a temporary file) if buffer is | |
726 | narrowed." | |
727 | (interactive) | |
728 | (save-excursion | |
729 | (and buffer (set-buffer buffer)) | |
730 | (let ((file-name | |
731 | ;; Ignore real name if restricted | |
732 | (and (= (- (point-max) (point-min)) (buffer-size)) | |
733 | (or buffer-file-name | |
734 | (and (boundp 'dired-directory) dired-directory))))) | |
735 | (or file-name | |
736 | (progn | |
737 | (or browse-url-temp-file-name | |
738 | (setq browse-url-temp-file-name | |
739 | (convert-standard-filename | |
740 | (make-temp-file | |
2e167dc4 RS |
741 | (expand-file-name "burl" browse-url-temp-dir) |
742 | nil ".html")))) | |
8749abea GM |
743 | (setq file-name browse-url-temp-file-name) |
744 | (write-region (point-min) (point-max) file-name nil 'no-message))) | |
745 | (browse-url-of-file file-name)))) | |
746 | ||
747 | (defun browse-url-delete-temp-file (&optional temp-file-name) | |
748 | ;; Delete browse-url-temp-file-name from the file system | |
749 | ;; If optional arg TEMP-FILE-NAME is non-nil, delete it instead | |
750 | (let ((file-name (or temp-file-name browse-url-temp-file-name))) | |
751 | (if (and file-name (file-exists-p file-name)) | |
752 | (delete-file file-name)))) | |
753 | ||
754 | (add-hook 'kill-buffer-hook 'browse-url-delete-temp-file) | |
755 | ||
756 | ;;;###autoload | |
757 | (defun browse-url-of-dired-file () | |
758 | "In Dired, ask a WWW browser to display the file named on this line." | |
759 | (interactive) | |
760 | (browse-url-of-file (dired-get-filename))) | |
761 | ||
762 | ;;;###autoload | |
763 | (defun browse-url-of-region (min max) | |
764 | "Ask a WWW browser to display the current region." | |
765 | (interactive "r") | |
766 | (save-excursion | |
767 | (save-restriction | |
768 | (narrow-to-region min max) | |
769 | (browse-url-of-buffer)))) | |
770 | ||
771 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
772 | ;; Browser-independent commands | |
773 | ||
774 | ;; A generic command to call the current browse-url-browser-function | |
775 | ||
776 | ;;;###autoload | |
777 | (defun browse-url (url &rest args) | |
778 | "Ask a WWW browser to load URL. | |
779 | Prompts for a URL, defaulting to the URL at or before point. Variable | |
780 | `browse-url-browser-function' says which browser to use." | |
781 | (interactive (browse-url-interactive-arg "URL: ")) | |
32226619 | 782 | (unless (called-interactively-p 'interactive) |
408d5219 | 783 | (setq args (or args (list browse-url-new-window-flag)))) |
addc252e SM |
784 | (let ((process-environment (copy-sequence process-environment))) |
785 | ;; When connected to various displays, be careful to use the display of | |
786 | ;; the currently selected frame, rather than the original start display, | |
787 | ;; which may not even exist any more. | |
788 | (if (stringp (frame-parameter (selected-frame) 'display)) | |
789 | (setenv "DISPLAY" (frame-parameter (selected-frame) 'display))) | |
9c16fc95 KR |
790 | (if (and (consp browse-url-browser-function) |
791 | (not (functionp browse-url-browser-function))) | |
792 | ;; The `function' can be an alist; look down it for first match | |
793 | ;; and apply the function (which might be a lambda). | |
794 | (catch 'done | |
795 | (dolist (bf browse-url-browser-function) | |
796 | (when (string-match (car bf) url) | |
797 | (apply (cdr bf) url args) | |
798 | (throw 'done t))) | |
799 | (error "No browse-url-browser-function matching URL %s" | |
800 | url)) | |
801 | ;; Unbound symbols go down this leg, since void-function from | |
802 | ;; apply is clearer than wrong-type-argument from dolist. | |
803 | (apply browse-url-browser-function url args)))) | |
8749abea GM |
804 | |
805 | ;;;###autoload | |
01f97560 | 806 | (defun browse-url-at-point (&optional arg) |
8749abea GM |
807 | "Ask a WWW browser to load the URL at or before point. |
808 | Doesn't let you edit the URL like `browse-url'. Variable | |
809 | `browse-url-browser-function' says which browser to use." | |
01f97560 | 810 | (interactive "P") |
3abc9fa1 DL |
811 | (let ((url (browse-url-url-at-point))) |
812 | (if url | |
813 | (browse-url url (if arg | |
408d5219 GM |
814 | (not browse-url-new-window-flag) |
815 | browse-url-new-window-flag)) | |
3abc9fa1 | 816 | (error "No URL found")))) |
8749abea GM |
817 | |
818 | ;;;###autoload | |
819 | (defun browse-url-at-mouse (event) | |
820 | "Ask a WWW browser to load a URL clicked with the mouse. | |
821 | The URL is the one around or before the position of the mouse click | |
822 | but point is not changed. Doesn't let you edit the URL like | |
823 | `browse-url'. Variable `browse-url-browser-function' says which browser | |
824 | to use." | |
825 | (interactive "e") | |
826 | (save-excursion | |
3abc9fa1 | 827 | (mouse-set-point event) |
857356cb RS |
828 | ;; This handles browse-url-new-window-flag properly |
829 | ;; when it gets no arg. | |
830 | (browse-url-at-point))) | |
8749abea GM |
831 | |
832 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
833 | ;; Browser-specific commands | |
834 | ||
835 | ;; --- Default MS-Windows browser --- | |
836 | ||
14a06a2d | 837 | (defvar dos-windows-version) |
73e6adaa | 838 | (declare-function w32-shell-execute "w32fns.c") ;; Defined in C. |
14a06a2d | 839 | |
8749abea GM |
840 | (defun browse-url-default-windows-browser (url &optional new-window) |
841 | (interactive (browse-url-interactive-arg "URL: ")) | |
e572025f CY |
842 | (cond ((eq system-type 'ms-dos) |
843 | (if dos-windows-version | |
844 | (shell-command (concat "start " (shell-quote-argument url))) | |
845 | (error "Browsing URLs is not supported on this system"))) | |
846 | ((eq system-type 'cygwin) | |
5241b291 | 847 | (call-process "cygstart" nil nil nil url)) |
e572025f | 848 | (t (w32-shell-execute "open" url)))) |
8749abea | 849 | |
662871dd SM |
850 | (defun browse-url-default-macosx-browser (url &optional new-window) |
851 | (interactive (browse-url-interactive-arg "URL: ")) | |
852 | (start-process (concat "open " url) nil "open" url)) | |
853 | ||
8749abea GM |
854 | ;; --- Netscape --- |
855 | ||
856 | (defun browse-url-process-environment () | |
7f61a9ee RS |
857 | "Set DISPLAY in the environment to the X display the browser will use. |
858 | This is either the value of variable `browse-url-browser-display' if | |
8749abea GM |
859 | non-nil, or the same display as Emacs if different from the current |
860 | environment, otherwise just use the current environment." | |
7f61a9ee | 861 | (let ((display (or browse-url-browser-display (browse-url-emacs-display)))) |
8749abea GM |
862 | (if display |
863 | (cons (concat "DISPLAY=" display) process-environment) | |
864 | process-environment))) | |
865 | ||
866 | (defun browse-url-emacs-display () | |
867 | "Return the X display Emacs is running on. | |
868 | This is nil if the display is the same as the DISPLAY environment variable. | |
869 | ||
870 | Actually Emacs could be using several displays; this just returns the | |
871 | one showing the selected frame." | |
872 | (let ((display (cdr-safe (assq 'display (frame-parameters))))) | |
873 | (and (not (equal display (getenv "DISPLAY"))) | |
874 | display))) | |
875 | ||
7f61a9ee RS |
876 | ;;;###autoload |
877 | (defun browse-url-default-browser (url &rest args) | |
878 | "Find a suitable browser and ask it to load URL. | |
879 | Default to the URL around or before point. | |
880 | ||
881 | When called interactively, if variable `browse-url-new-window-flag' is | |
882 | non-nil, load the document in a new window, if possible, otherwise use | |
883 | a random existing one. A non-nil interactive prefix argument reverses | |
884 | the effect of `browse-url-new-window-flag'. | |
885 | ||
886 | When called non-interactively, optional second argument NEW-WINDOW is | |
887 | used instead of `browse-url-new-window-flag'. | |
888 | ||
49866ff8 | 889 | The order attempted is gnome-moz-remote, Mozilla, Firefox, |
66dc1ca2 | 890 | Galeon, Konqueror, Netscape, Mosaic, Lynx in an xterm, and then W3." |
7f61a9ee | 891 | (apply |
6eddc3bb MC |
892 | (cond |
893 | ((executable-find browse-url-gnome-moz-program) 'browse-url-gnome-moz) | |
894 | ((executable-find browse-url-mozilla-program) 'browse-url-mozilla) | |
895 | ((executable-find browse-url-firefox-program) 'browse-url-firefox) | |
896 | ((executable-find browse-url-galeon-program) 'browse-url-galeon) | |
897 | ((executable-find browse-url-kde-program) 'browse-url-kde) | |
898 | ((executable-find browse-url-netscape-program) 'browse-url-netscape) | |
899 | ((executable-find browse-url-mosaic-program) 'browse-url-mosaic) | |
d9774611 | 900 | ((executable-find browse-url-xterm-program) 'browse-url-text-xterm) |
6eddc3bb MC |
901 | ((locate-library "w3") 'browse-url-w3) |
902 | (t | |
db6003fb | 903 | (lambda (&rest ignore) (error "No usable browser found")))) |
6eddc3bb | 904 | url args)) |
7f61a9ee | 905 | |
8749abea GM |
906 | ;;;###autoload |
907 | (defun browse-url-netscape (url &optional new-window) | |
908 | "Ask the Netscape WWW browser to load URL. | |
8749abea GM |
909 | Default to the URL around or before point. The strings in variable |
910 | `browse-url-netscape-arguments' are also passed to Netscape. | |
911 | ||
408d5219 | 912 | When called interactively, if variable `browse-url-new-window-flag' is |
8749abea GM |
913 | non-nil, load the document in a new Netscape window, otherwise use a |
914 | random existing one. A non-nil interactive prefix argument reverses | |
408d5219 | 915 | the effect of `browse-url-new-window-flag'. |
8749abea | 916 | |
fe77c061 SJ |
917 | If `browse-url-netscape-new-window-is-tab' is non-nil, then |
918 | whenever a document would otherwise be loaded in a new window, it | |
919 | is loaded in a new tab in an existing window instead. | |
920 | ||
8749abea | 921 | When called non-interactively, optional second argument NEW-WINDOW is |
408d5219 | 922 | used instead of `browse-url-new-window-flag'." |
de5552d5 | 923 | (interactive (browse-url-interactive-arg "URL: ")) |
8c22c51a | 924 | (setq url (browse-url-encode-url url)) |
8749abea | 925 | (let* ((process-environment (browse-url-process-environment)) |
fe77c061 SJ |
926 | (process |
927 | (apply 'start-process | |
928 | (concat "netscape " url) nil | |
929 | browse-url-netscape-program | |
930 | (append | |
931 | browse-url-netscape-arguments | |
932 | (if (eq window-system 'w32) | |
933 | (list url) | |
934 | (append | |
935 | (if new-window '("-noraise")) | |
936 | (list "-remote" | |
937 | (concat "openURL(" url | |
938 | (if (browse-url-maybe-new-window | |
939 | new-window) | |
940 | (if browse-url-netscape-new-window-is-tab | |
941 | ",new-tab" | |
942 | ",new-window")) | |
943 | ")")))))))) | |
8749abea | 944 | (set-process-sentinel process |
3abc9fa1 DL |
945 | `(lambda (process change) |
946 | (browse-url-netscape-sentinel process ,url))))) | |
8749abea GM |
947 | |
948 | (defun browse-url-netscape-sentinel (process url) | |
949 | "Handle a change to the process communicating with Netscape." | |
950 | (or (eq (process-exit-status process) 0) | |
951 | (let* ((process-environment (browse-url-process-environment))) | |
952 | ;; Netscape not running - start it | |
7844257c | 953 | (message "Starting %s..." browse-url-netscape-program) |
8749abea GM |
954 | (apply 'start-process (concat "netscape" url) nil |
955 | browse-url-netscape-program | |
956 | (append browse-url-netscape-startup-arguments (list url)))))) | |
957 | ||
958 | (defun browse-url-netscape-reload () | |
959 | "Ask Netscape to reload its current document. | |
960 | How depends on `browse-url-netscape-version'." | |
961 | (interactive) | |
962 | ;; Backwards incompatibility reported by | |
963 | ;; <peter.kruse@psychologie.uni-regensburg.de>. | |
964 | (browse-url-netscape-send (if (>= browse-url-netscape-version 4) | |
965 | "xfeDoCommand(reload)" | |
6eddc3bb | 966 | "reload"))) |
8749abea GM |
967 | |
968 | (defun browse-url-netscape-send (command) | |
969 | "Send a remote control command to Netscape." | |
970 | (let* ((process-environment (browse-url-process-environment))) | |
971 | (apply 'start-process "netscape" nil | |
972 | browse-url-netscape-program | |
973 | (append browse-url-netscape-arguments | |
974 | (list "-remote" command))))) | |
975 | ||
7f61a9ee RS |
976 | ;;;###autoload |
977 | (defun browse-url-mozilla (url &optional new-window) | |
978 | "Ask the Mozilla WWW browser to load URL. | |
979 | Default to the URL around or before point. The strings in variable | |
980 | `browse-url-mozilla-arguments' are also passed to Mozilla. | |
981 | ||
982 | When called interactively, if variable `browse-url-new-window-flag' is | |
983 | non-nil, load the document in a new Mozilla window, otherwise use a | |
984 | random existing one. A non-nil interactive prefix argument reverses | |
985 | the effect of `browse-url-new-window-flag'. | |
986 | ||
d6da15ec SJ |
987 | If `browse-url-mozilla-new-window-is-tab' is non-nil, then whenever a |
988 | document would otherwise be loaded in a new window, it is loaded in a | |
989 | new tab in an existing window instead. | |
990 | ||
7f61a9ee RS |
991 | When called non-interactively, optional second argument NEW-WINDOW is |
992 | used instead of `browse-url-new-window-flag'." | |
993 | (interactive (browse-url-interactive-arg "URL: ")) | |
8c22c51a | 994 | (setq url (browse-url-encode-url url)) |
7f61a9ee | 995 | (let* ((process-environment (browse-url-process-environment)) |
d6da15ec SJ |
996 | (process |
997 | (apply 'start-process | |
998 | (concat "mozilla " url) nil | |
999 | browse-url-mozilla-program | |
1000 | (append | |
1001 | browse-url-mozilla-arguments | |
1002 | (list "-remote" | |
1003 | (concat "openURL(" | |
1004 | url | |
1005 | (if (browse-url-maybe-new-window | |
1006 | new-window) | |
1007 | (if browse-url-mozilla-new-window-is-tab | |
c29cf9a4 RS |
1008 | ",new-tab" |
1009 | ",new-window")) | |
d6da15ec | 1010 | ")")))))) |
7f61a9ee RS |
1011 | (set-process-sentinel process |
1012 | `(lambda (process change) | |
1013 | (browse-url-mozilla-sentinel process ,url))))) | |
1014 | ||
1015 | (defun browse-url-mozilla-sentinel (process url) | |
1016 | "Handle a change to the process communicating with Mozilla." | |
1017 | (or (eq (process-exit-status process) 0) | |
1018 | (let* ((process-environment (browse-url-process-environment))) | |
1019 | ;; Mozilla is not running - start it | |
7844257c | 1020 | (message "Starting %s..." browse-url-mozilla-program) |
7f61a9ee RS |
1021 | (apply 'start-process (concat "mozilla " url) nil |
1022 | browse-url-mozilla-program | |
1023 | (append browse-url-mozilla-startup-arguments (list url)))))) | |
49866ff8 EZ |
1024 | |
1025 | ;;;###autoload | |
1026 | (defun browse-url-firefox (url &optional new-window) | |
1027 | "Ask the Firefox WWW browser to load URL. | |
1028 | Default to the URL around or before point. The strings in | |
1029 | variable `browse-url-firefox-arguments' are also passed to | |
1030 | Firefox. | |
1031 | ||
1032 | When called interactively, if variable | |
1033 | `browse-url-new-window-flag' is non-nil, load the document in a | |
1034 | new Firefox window, otherwise use a random existing one. A | |
1035 | non-nil interactive prefix argument reverses the effect of | |
1036 | `browse-url-new-window-flag'. | |
1037 | ||
1038 | If `browse-url-firefox-new-window-is-tab' is non-nil, then | |
1039 | whenever a document would otherwise be loaded in a new window, it | |
1040 | is loaded in a new tab in an existing window instead. | |
1041 | ||
1042 | When called non-interactively, optional second argument | |
1043 | NEW-WINDOW is used instead of `browse-url-new-window-flag'. | |
1044 | ||
1045 | On MS-Windows systems the optional `new-window' parameter is | |
1046 | ignored. Firefox for Windows does not support the \"-remote\" | |
1047 | command line parameter. Therefore, the | |
1048 | `browse-url-new-window-flag' and `browse-url-firefox-new-window-is-tab' | |
1049 | are ignored as well. Firefox on Windows will always open the requested | |
1050 | URL in a new window." | |
1051 | (interactive (browse-url-interactive-arg "URL: ")) | |
8c22c51a | 1052 | (setq url (browse-url-encode-url url)) |
49866ff8 EZ |
1053 | (let* ((process-environment (browse-url-process-environment)) |
1054 | (process | |
1055 | (apply 'start-process | |
1056 | (concat "firefox " url) nil | |
1057 | browse-url-firefox-program | |
1058 | (append | |
1059 | browse-url-firefox-arguments | |
1060 | (if (or (featurep 'dos-w32) | |
1061 | (string-match "win32" system-configuration)) | |
1062 | (list url) | |
1063 | (list "-remote" | |
1064 | (concat "openURL(" | |
1065 | url | |
1066 | (if (browse-url-maybe-new-window | |
1067 | new-window) | |
1068 | (if browse-url-firefox-new-window-is-tab | |
1069 | ",new-tab" | |
1070 | ",new-window")) | |
1071 | ")"))))))) | |
1072 | (set-process-sentinel process | |
1073 | `(lambda (process change) | |
1074 | (browse-url-firefox-sentinel process ,url))))) | |
1075 | ||
1076 | (defun browse-url-firefox-sentinel (process url) | |
1077 | "Handle a change to the process communicating with Firefox." | |
1078 | (or (eq (process-exit-status process) 0) | |
1079 | (let* ((process-environment (browse-url-process-environment))) | |
1080 | ;; Firefox is not running - start it | |
1081 | (message "Starting Firefox...") | |
1082 | (apply 'start-process (concat "firefox " url) nil | |
1083 | browse-url-firefox-program | |
1084 | (append browse-url-firefox-startup-arguments (list url)))))) | |
7f61a9ee RS |
1085 | |
1086 | ;;;###autoload | |
1087 | (defun browse-url-galeon (url &optional new-window) | |
1088 | "Ask the Galeon WWW browser to load URL. | |
1089 | Default to the URL around or before point. The strings in variable | |
1090 | `browse-url-galeon-arguments' are also passed to Galeon. | |
1091 | ||
1092 | When called interactively, if variable `browse-url-new-window-flag' is | |
1093 | non-nil, load the document in a new Galeon window, otherwise use a | |
1094 | random existing one. A non-nil interactive prefix argument reverses | |
1095 | the effect of `browse-url-new-window-flag'. | |
1096 | ||
b77784f7 RS |
1097 | If `browse-url-galeon-new-window-is-tab' is non-nil, then whenever a |
1098 | document would otherwise be loaded in a new window, it is loaded in a | |
1099 | new tab in an existing window instead. | |
1100 | ||
7f61a9ee RS |
1101 | When called non-interactively, optional second argument NEW-WINDOW is |
1102 | used instead of `browse-url-new-window-flag'." | |
1103 | (interactive (browse-url-interactive-arg "URL: ")) | |
5edcabcb | 1104 | (setq url (browse-url-encode-url url)) |
7f61a9ee RS |
1105 | (let* ((process-environment (browse-url-process-environment)) |
1106 | (process (apply 'start-process | |
654805e3 RS |
1107 | (concat "galeon " url) |
1108 | nil | |
7f61a9ee RS |
1109 | browse-url-galeon-program |
1110 | (append | |
1111 | browse-url-galeon-arguments | |
1d5d4123 RS |
1112 | (if (browse-url-maybe-new-window new-window) |
1113 | (if browse-url-galeon-new-window-is-tab | |
1114 | '("--new-tab") | |
b77784f7 RS |
1115 | '("--new-window" "--noraise")) |
1116 | '("--existing")) | |
1117 | (list url))))) | |
7f61a9ee RS |
1118 | (set-process-sentinel process |
1119 | `(lambda (process change) | |
1120 | (browse-url-galeon-sentinel process ,url))))) | |
1121 | ||
1122 | (defun browse-url-galeon-sentinel (process url) | |
1123 | "Handle a change to the process communicating with Galeon." | |
1124 | (or (eq (process-exit-status process) 0) | |
1125 | (let* ((process-environment (browse-url-process-environment))) | |
1126 | ;; Galeon is not running - start it | |
7844257c | 1127 | (message "Starting %s..." browse-url-galeon-program) |
7f61a9ee RS |
1128 | (apply 'start-process (concat "galeon " url) nil |
1129 | browse-url-galeon-program | |
1130 | (append browse-url-galeon-startup-arguments (list url)))))) | |
1131 | ||
654805e3 RS |
1132 | (defun browse-url-epiphany (url &optional new-window) |
1133 | "Ask the Epiphany WWW browser to load URL. | |
1134 | Default to the URL around or before point. The strings in variable | |
1135 | `browse-url-galeon-arguments' are also passed to Epiphany. | |
1136 | ||
1137 | When called interactively, if variable `browse-url-new-window-flag' is | |
1138 | non-nil, load the document in a new Epiphany window, otherwise use a | |
1139 | random existing one. A non-nil interactive prefix argument reverses | |
1140 | the effect of `browse-url-new-window-flag'. | |
1141 | ||
674dd916 | 1142 | If `browse-url-epiphany-new-window-is-tab' is non-nil, then whenever a |
654805e3 RS |
1143 | document would otherwise be loaded in a new window, it is loaded in a |
1144 | new tab in an existing window instead. | |
1145 | ||
1146 | When called non-interactively, optional second argument NEW-WINDOW is | |
1147 | used instead of `browse-url-new-window-flag'." | |
1148 | (interactive (browse-url-interactive-arg "URL: ")) | |
8c22c51a | 1149 | (setq url (browse-url-encode-url url)) |
654805e3 RS |
1150 | (let* ((process-environment (browse-url-process-environment)) |
1151 | (process (apply 'start-process | |
1152 | (concat "epiphany " url) | |
1153 | nil | |
1154 | browse-url-epiphany-program | |
1155 | (append | |
1156 | browse-url-epiphany-arguments | |
1157 | (if (browse-url-maybe-new-window new-window) | |
1158 | (if browse-url-epiphany-new-window-is-tab | |
1159 | '("--new-tab") | |
1160 | '("--new-window" "--noraise")) | |
1161 | '("--existing")) | |
1162 | (list url))))) | |
1163 | (set-process-sentinel process | |
1164 | `(lambda (process change) | |
1165 | (browse-url-epiphany-sentinel process ,url))))) | |
1166 | ||
1167 | (defun browse-url-epiphany-sentinel (process url) | |
1168 | "Handle a change to the process communicating with Epiphany." | |
1169 | (or (eq (process-exit-status process) 0) | |
1170 | (let* ((process-environment (browse-url-process-environment))) | |
1171 | ;; Epiphany is not running - start it | |
7844257c | 1172 | (message "Starting %s..." browse-url-epiphany-program) |
654805e3 RS |
1173 | (apply 'start-process (concat "epiphany " url) nil |
1174 | browse-url-epiphany-program | |
1175 | (append browse-url-epiphany-startup-arguments (list url)))))) | |
1176 | ||
3fe5c37a DN |
1177 | (defvar url-handler-regexp) |
1178 | ||
378f9937 SM |
1179 | ;;;###autoload |
1180 | (defun browse-url-emacs (url &optional new-window) | |
1181 | "Ask Emacs to load URL into a buffer and show it in another window." | |
1182 | (interactive (browse-url-interactive-arg "URL: ")) | |
1183 | (require 'url-handlers) | |
1184 | (let ((file-name-handler-alist | |
1185 | (cons (cons url-handler-regexp 'url-file-handler) | |
1186 | file-name-handler-alist))) | |
1187 | ;; Ignore `new-window': with all other browsers the URL is always shown | |
1188 | ;; in another window than the current Emacs one since it's shown in | |
1189 | ;; another application's window. | |
1190 | ;; (if new-window (find-file-other-window url) (find-file url)) | |
1191 | (find-file-other-window url))) | |
1192 | ||
b12e6de3 | 1193 | ;;;###autoload |
de5552d5 DL |
1194 | (defun browse-url-gnome-moz (url &optional new-window) |
1195 | "Ask Mozilla/Netscape to load URL via the GNOME program `gnome-moz-remote'. | |
1196 | Default to the URL around or before point. The strings in variable | |
1197 | `browse-url-gnome-moz-arguments' are also passed. | |
1198 | ||
408d5219 | 1199 | When called interactively, if variable `browse-url-new-window-flag' is |
de5552d5 DL |
1200 | non-nil, load the document in a new browser window, otherwise use an |
1201 | existing one. A non-nil interactive prefix argument reverses the | |
408d5219 | 1202 | effect of `browse-url-new-window-flag'. |
de5552d5 DL |
1203 | |
1204 | When called non-interactively, optional second argument NEW-WINDOW is | |
408d5219 | 1205 | used instead of `browse-url-new-window-flag'." |
c60ee5e7 | 1206 | (interactive (browse-url-interactive-arg "URL: ")) |
de5552d5 DL |
1207 | (apply 'start-process (concat "gnome-moz-remote " url) |
1208 | nil | |
662871dd | 1209 | browse-url-gnome-moz-program |
de5552d5 DL |
1210 | (append |
1211 | browse-url-gnome-moz-arguments | |
1212 | (if (browse-url-maybe-new-window new-window) | |
6eddc3bb | 1213 | '("--newwin")) |
de5552d5 DL |
1214 | (list "--raise" url)))) |
1215 | ||
8749abea GM |
1216 | ;; --- Mosaic --- |
1217 | ||
1218 | ;;;###autoload | |
1219 | (defun browse-url-mosaic (url &optional new-window) | |
1220 | "Ask the XMosaic WWW browser to load URL. | |
1221 | ||
1222 | Default to the URL around or before point. The strings in variable | |
1223 | `browse-url-mosaic-arguments' are also passed to Mosaic and the | |
1224 | program is invoked according to the variable | |
1225 | `browse-url-mosaic-program'. | |
1226 | ||
408d5219 | 1227 | When called interactively, if variable `browse-url-new-window-flag' is |
8749abea GM |
1228 | non-nil, load the document in a new Mosaic window, otherwise use a |
1229 | random existing one. A non-nil interactive prefix argument reverses | |
408d5219 | 1230 | the effect of `browse-url-new-window-flag'. |
8749abea GM |
1231 | |
1232 | When called non-interactively, optional second argument NEW-WINDOW is | |
408d5219 | 1233 | used instead of `browse-url-new-window-flag'." |
8749abea | 1234 | (interactive (browse-url-interactive-arg "Mosaic URL: ")) |
1665be47 | 1235 | (let ((pidfile (expand-file-name browse-url-mosaic-pidfile)) |
8749abea GM |
1236 | pid) |
1237 | (if (file-readable-p pidfile) | |
1238 | (save-excursion | |
1239 | (find-file pidfile) | |
1240 | (goto-char (point-min)) | |
1241 | (setq pid (read (current-buffer))) | |
1242 | (kill-buffer nil))) | |
1243 | (if (and pid (zerop (signal-process pid 0))) ; Mosaic running | |
1244 | (save-excursion | |
1245 | (find-file (format "/tmp/Mosaic.%d" pid)) | |
1246 | (erase-buffer) | |
01f97560 | 1247 | (insert (if (browse-url-maybe-new-window new-window) |
8749abea GM |
1248 | "newwin\n" |
1249 | "goto\n") | |
1250 | url "\n") | |
1251 | (save-buffer) | |
1252 | (kill-buffer nil) | |
1253 | ;; Send signal SIGUSR to Mosaic | |
84c2714c | 1254 | (message "Signaling Mosaic...") |
662871dd | 1255 | (signal-process pid 'SIGUSR1) |
8749abea GM |
1256 | ;; Or you could try: |
1257 | ;; (call-process "kill" nil 0 nil "-USR1" (int-to-string pid)) | |
84c2714c | 1258 | (message "Signaling Mosaic...done") |
8749abea GM |
1259 | ) |
1260 | ;; Mosaic not running - start it | |
7844257c | 1261 | (message "Starting %s..." browse-url-mosaic-program) |
8749abea GM |
1262 | (apply 'start-process "xmosaic" nil browse-url-mosaic-program |
1263 | (append browse-url-mosaic-arguments (list url))) | |
7844257c | 1264 | (message "Starting %s...done" browse-url-mosaic-program)))) |
8749abea | 1265 | |
8749abea GM |
1266 | ;; --- Mosaic using CCI --- |
1267 | ||
1268 | ;;;###autoload | |
1269 | (defun browse-url-cci (url &optional new-window) | |
1270 | "Ask the XMosaic WWW browser to load URL. | |
1271 | Default to the URL around or before point. | |
1272 | ||
1273 | This function only works for XMosaic version 2.5 or later. You must | |
1274 | select `CCI' from XMosaic's File menu, set the CCI Port Address to the | |
1275 | value of variable `browse-url-CCI-port', and enable `Accept requests'. | |
1276 | ||
408d5219 | 1277 | When called interactively, if variable `browse-url-new-window-flag' is |
8749abea GM |
1278 | non-nil, load the document in a new browser window, otherwise use a |
1279 | random existing one. A non-nil interactive prefix argument reverses | |
408d5219 | 1280 | the effect of `browse-url-new-window-flag'. |
8749abea GM |
1281 | |
1282 | When called non-interactively, optional second argument NEW-WINDOW is | |
408d5219 | 1283 | used instead of `browse-url-new-window-flag'." |
8749abea GM |
1284 | (interactive (browse-url-interactive-arg "Mosaic URL: ")) |
1285 | (open-network-stream "browse-url" " *browse-url*" | |
1286 | browse-url-CCI-host browse-url-CCI-port) | |
1287 | ;; Todo: start browser if fails | |
1288 | (process-send-string "browse-url" | |
1289 | (concat "get url (" url ") output " | |
01f97560 | 1290 | (if (browse-url-maybe-new-window new-window) |
8749abea GM |
1291 | "new" |
1292 | "current") | |
1293 | "\r\n")) | |
1294 | (process-send-string "browse-url" "disconnect\r\n") | |
1295 | (delete-process "browse-url")) | |
1296 | ||
8749abea GM |
1297 | ;; --- W3 --- |
1298 | ||
352d2dea GM |
1299 | ;; External. |
1300 | (declare-function w3-fetch-other-window "ext:w3m" (&optional url)) | |
1301 | (declare-function w3-fetch "ext:w3m" (&optional url target)) | |
1302 | ||
8749abea GM |
1303 | ;;;###autoload |
1304 | (defun browse-url-w3 (url &optional new-window) | |
1305 | "Ask the w3 WWW browser to load URL. | |
1306 | Default to the URL around or before point. | |
1307 | ||
408d5219 | 1308 | When called interactively, if variable `browse-url-new-window-flag' is |
8749abea | 1309 | non-nil, load the document in a new window. A non-nil interactive |
408d5219 | 1310 | prefix argument reverses the effect of `browse-url-new-window-flag'. |
8749abea GM |
1311 | |
1312 | When called non-interactively, optional second argument NEW-WINDOW is | |
408d5219 | 1313 | used instead of `browse-url-new-window-flag'." |
8749abea | 1314 | (interactive (browse-url-interactive-arg "W3 URL: ")) |
6eddc3bb | 1315 | (require 'w3) ; w3-fetch-other-window not autoloaded |
01f97560 | 1316 | (if (browse-url-maybe-new-window new-window) |
8749abea GM |
1317 | (w3-fetch-other-window url) |
1318 | (w3-fetch url))) | |
1319 | ||
1320 | ;;;###autoload | |
1321 | (defun browse-url-w3-gnudoit (url &optional new-window) | |
1322 | ;; new-window ignored | |
1323 | "Ask another Emacs running gnuserv to load the URL using the W3 browser. | |
1324 | The `browse-url-gnudoit-program' program is used with options given by | |
1325 | `browse-url-gnudoit-args'. Default to the URL around or before point." | |
1326 | (interactive (browse-url-interactive-arg "W3 URL: ")) | |
6eddc3bb MC |
1327 | (apply 'start-process (concat "gnudoit:" url) nil |
1328 | browse-url-gnudoit-program | |
1329 | (append browse-url-gnudoit-args | |
1330 | (list (concat "(w3-fetch \"" url "\")") | |
1331 | "(raise-frame)")))) | |
8749abea GM |
1332 | |
1333 | ;; --- Lynx in an xterm --- | |
1334 | ||
1335 | ;;;###autoload | |
d9774611 | 1336 | (defun browse-url-text-xterm (url &optional new-window) |
8749abea | 1337 | ;; new-window ignored |
d9774611 | 1338 | "Ask a text browser to load URL. |
db6003fb | 1339 | URL defaults to the URL around or before point. |
d9774611 | 1340 | This runs the text browser specified by `browse-url-text-browser'. |
8749abea GM |
1341 | in an Xterm window using the Xterm program named by `browse-url-xterm-program' |
1342 | with possible additional arguments `browse-url-xterm-args'." | |
d9774611 RS |
1343 | (interactive (browse-url-interactive-arg "Text browser URL: ")) |
1344 | (apply #'start-process `(,(concat browse-url-text-browser url) | |
1345 | nil ,browse-url-xterm-program | |
03e49c06 | 1346 | ,@browse-url-xterm-args "-e" ,browse-url-text-browser |
6eddc3bb | 1347 | ,url))) |
8749abea GM |
1348 | |
1349 | ;; --- Lynx in an Emacs "term" window --- | |
1350 | ||
1351 | ;;;###autoload | |
d9774611 RS |
1352 | (defun browse-url-text-emacs (url &optional new-buffer) |
1353 | "Ask a text browser to load URL. | |
db6003fb | 1354 | URL defaults to the URL around or before point. |
d9774611 RS |
1355 | This runs the text browser specified by `browse-url-text-browser'. |
1356 | With a prefix argument, it runs a new browser process in a new buffer. | |
8749abea | 1357 | |
408d5219 | 1358 | When called interactively, if variable `browse-url-new-window-flag' is |
d9774611 | 1359 | non-nil, load the document in a new browser process in a new term window, |
8749abea | 1360 | otherwise use any existing one. A non-nil interactive prefix argument |
408d5219 | 1361 | reverses the effect of `browse-url-new-window-flag'. |
8749abea GM |
1362 | |
1363 | When called non-interactively, optional second argument NEW-WINDOW is | |
408d5219 | 1364 | used instead of `browse-url-new-window-flag'." |
d9774611 | 1365 | (interactive (browse-url-interactive-arg "Text browser URL: ")) |
6eddc3bb | 1366 | (let* ((system-uses-terminfo t) ; Lynx uses terminfo |
8749abea | 1367 | ;; (term-term-name "vt100") ; ?? |
d9774611 | 1368 | (buf (get-buffer "*text browser*")) |
8749abea | 1369 | (proc (and buf (get-buffer-process buf))) |
d9774611 | 1370 | (n browse-url-text-input-attempts)) |
01f97560 | 1371 | (if (and (browse-url-maybe-new-window new-buffer) buf) |
8749abea GM |
1372 | ;; Rename away the OLD buffer. This isn't very polite, but |
1373 | ;; term insists on working in a buffer named *lynx* and would | |
1374 | ;; choke on *lynx*<1> | |
1375 | (progn (set-buffer buf) | |
1376 | (rename-uniquely))) | |
01f97560 | 1377 | (if (or (browse-url-maybe-new-window new-buffer) |
8749abea GM |
1378 | (not buf) |
1379 | (not proc) | |
1380 | (not (memq (process-status proc) '(run stop)))) | |
d9774611 | 1381 | ;; start a new text browser |
8749abea GM |
1382 | (progn |
1383 | (setq buf | |
1384 | (apply #'make-term | |
d9774611 RS |
1385 | `(,browse-url-text-browser |
1386 | ,browse-url-text-browser | |
1387 | nil ,@browse-url-text-emacs-args | |
01f97560 | 1388 | ,url))) |
8749abea GM |
1389 | (switch-to-buffer buf) |
1390 | (term-char-mode) | |
1391 | (set-process-sentinel | |
1392 | (get-buffer-process buf) | |
1393 | ;; Don't leave around a dead one (especially because of its | |
1394 | ;; munged keymap.) | |
1395 | (lambda (process event) | |
1396 | (if (not (memq (process-status process) '(run stop))) | |
1397 | (let ((buf (process-buffer process))) | |
1398 | (if buf (kill-buffer buf))))))) | |
d9774611 | 1399 | ;; Send the url to the text browser in the old buffer |
8749abea GM |
1400 | (let ((win (get-buffer-window buf t))) |
1401 | (if win | |
1402 | (select-window win) | |
1403 | (switch-to-buffer buf))) | |
1404 | (if (eq (following-char) ?_) | |
d9774611 | 1405 | (cond ((eq browse-url-text-input-field 'warn) |
e8af40ee | 1406 | (error "Please move out of the input field first")) |
d9774611 | 1407 | ((eq browse-url-text-input-field 'avoid) |
8749abea | 1408 | (while (and (eq (following-char) ?_) (> n 0)) |
6eddc3bb | 1409 | (term-send-down) ; down arrow |
d9774611 | 1410 | (sit-for browse-url-text-input-delay)) |
8749abea | 1411 | (if (eq (following-char) ?_) |
e8af40ee | 1412 | (error "Cannot move out of the input field, sorry"))))) |
6eddc3bb | 1413 | (term-send-string proc (concat "g" ; goto |
8749abea GM |
1414 | "\C-u" ; kill default url |
1415 | url | |
1416 | "\r"))))) | |
1417 | ||
8749abea GM |
1418 | ;; --- mailto --- |
1419 | ||
1abcd088 EZ |
1420 | (autoload 'rfc2368-parse-mailto-url "rfc2368") |
1421 | ||
8749abea GM |
1422 | ;;;###autoload |
1423 | (defun browse-url-mail (url &optional new-window) | |
1abcd088 | 1424 | "Open a new mail message buffer within Emacs for the RFC 2368 URL. |
8749abea GM |
1425 | Default to using the mailto: URL around or before point as the |
1426 | recipient's address. Supplying a non-nil interactive prefix argument | |
1427 | will cause the mail to be composed in another window rather than the | |
1428 | current one. | |
1429 | ||
408d5219 | 1430 | When called interactively, if variable `browse-url-new-window-flag' is |
8749abea GM |
1431 | non-nil use `compose-mail-other-window', otherwise `compose-mail'. A |
1432 | non-nil interactive prefix argument reverses the effect of | |
408d5219 | 1433 | `browse-url-new-window-flag'. |
8749abea GM |
1434 | |
1435 | When called non-interactively, optional second argument NEW-WINDOW is | |
408d5219 | 1436 | used instead of `browse-url-new-window-flag'." |
8749abea GM |
1437 | (interactive (browse-url-interactive-arg "Mailto URL: ")) |
1438 | (save-excursion | |
1abcd088 EZ |
1439 | (let* ((alist (rfc2368-parse-mailto-url url)) |
1440 | (to (assoc "To" alist)) | |
1441 | (subject (assoc "Subject" alist)) | |
1442 | (body (assoc "Body" alist)) | |
1443 | (rest (delete to (delete subject (delete body alist)))) | |
1444 | (to (cdr to)) | |
1445 | (subject (cdr subject)) | |
1446 | (body (cdr body)) | |
1447 | (mail-citation-hook (unless body mail-citation-hook))) | |
01f97560 | 1448 | (if (browse-url-maybe-new-window new-window) |
1abcd088 EZ |
1449 | (compose-mail-other-window to subject rest nil |
1450 | (if body | |
1451 | (list 'insert body) | |
1452 | (list 'insert-buffer (current-buffer)))) | |
1453 | (compose-mail to subject rest nil nil | |
1454 | (if body | |
1455 | (list 'insert body) | |
1456 | (list 'insert-buffer (current-buffer)))))))) | |
8749abea GM |
1457 | |
1458 | ;; --- Random browser --- | |
1459 | ||
1460 | ;;;###autoload | |
1461 | (defun browse-url-generic (url &optional new-window) | |
1462 | ;; new-window ignored | |
1463 | "Ask the WWW browser defined by `browse-url-generic-program' to load URL. | |
1464 | Default to the URL around or before point. A fresh copy of the | |
1465 | browser is started up in a new process with possible additional arguments | |
1466 | `browse-url-generic-args'. This is appropriate for browsers which | |
1467 | don't offer a form of remote control." | |
1468 | (interactive (browse-url-interactive-arg "URL: ")) | |
1469 | (if (not browse-url-generic-program) | |
6eddc3bb | 1470 | (error "No browser defined (`browse-url-generic-program')")) |
78cfc6ad DK |
1471 | (apply 'call-process browse-url-generic-program nil |
1472 | 0 nil | |
8749abea GM |
1473 | (append browse-url-generic-args (list url)))) |
1474 | ||
af06f459 GM |
1475 | ;;;###autoload |
1476 | (defun browse-url-kde (url &optional new-window) | |
1477 | "Ask the KDE WWW browser to load URL. | |
1478 | Default to the URL around or before point." | |
1479 | (interactive (browse-url-interactive-arg "KDE URL: ")) | |
1480 | (message "Sending URL to KDE...") | |
662871dd | 1481 | (apply #'start-process (concat "KDE " url) nil browse-url-kde-program |
6eddc3bb | 1482 | (append browse-url-kde-args (list url)))) |
af06f459 | 1483 | |
a38de16e MC |
1484 | (defun browse-url-elinks-new-window (url) |
1485 | "Ask the Elinks WWW browser to load URL in a new window." | |
db6003fb | 1486 | (let ((process-environment (browse-url-process-environment))) |
a38de16e MC |
1487 | (apply #'start-process |
1488 | (append (list (concat "elinks:" url) | |
1489 | nil) | |
1490 | browse-url-elinks-wrapper | |
1491 | (list "elinks" url))))) | |
1492 | ||
8c22c51a | 1493 | ;;;###autoload |
a38de16e | 1494 | (defun browse-url-elinks (url &optional new-window) |
8c22c51a GM |
1495 | "Ask the Elinks WWW browser to load URL. |
1496 | Default to the URL around the point. | |
1497 | ||
1498 | The document is loaded in a new tab of a running Elinks or, if | |
1499 | none yet running, a newly started instance. | |
1500 | ||
1501 | The Elinks command will be prepended by the program+arguments | |
a38de16e | 1502 | from `browse-url-elinks-wrapper'." |
8c22c51a GM |
1503 | (interactive (browse-url-interactive-arg "URL: ")) |
1504 | (setq url (browse-url-encode-url url)) | |
a38de16e MC |
1505 | (if new-window |
1506 | (browse-url-elinks-new-window url) | |
1507 | (let ((process-environment (browse-url-process-environment)) | |
1508 | (elinks-ping-process (start-process "elinks-ping" nil | |
1509 | "elinks" "-remote" "ping()"))) | |
1510 | (set-process-sentinel elinks-ping-process | |
1511 | `(lambda (process change) | |
1512 | (browse-url-elinks-sentinel process ,url)))))) | |
8c22c51a GM |
1513 | |
1514 | (defun browse-url-elinks-sentinel (process url) | |
1515 | "Determines if Elinks is running or a new one has to be started." | |
a38de16e | 1516 | (let ((exit-status (process-exit-status process))) |
8c22c51a GM |
1517 | ;; Try to determine if an instance is running or if we have to |
1518 | ;; create a new one. | |
1519 | (case exit-status | |
6eddc3bb MC |
1520 | (5 |
1521 | ;; No instance, start a new one. | |
a38de16e | 1522 | (browse-url-elinks-new-window url)) |
6eddc3bb MC |
1523 | (0 |
1524 | ;; Found an instance, open URL in new tab. | |
a38de16e MC |
1525 | (let ((process-environment (browse-url-process-environment))) |
1526 | (start-process (concat "elinks:" url) nil | |
1527 | "elinks" "-remote" | |
1528 | (concat "openURL(\"" url "\",new-tab)")))) | |
6eddc3bb | 1529 | (otherwise |
a38de16e MC |
1530 | (error "Unrecognized exit-code %d of process `elinks'" |
1531 | exit-status))))) | |
8c22c51a | 1532 | |
8749abea GM |
1533 | (provide 'browse-url) |
1534 | ||
378f9937 | 1535 | ;; arch-tag: d2079573-5c06-4097-9598-f550fba19430 |
8749abea | 1536 | ;;; browse-url.el ends here |