Commit | Line | Data |
---|---|---|
e8af40ee | 1 | ;;; browse-url.el --- pass a URL to a WWW browser |
8749abea | 2 | |
408d5219 GM |
3 | ;; Copyright (C) 1995, 96, 97, 98, 99, 2000, 2001 |
4 | ;; 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 | ||
13 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
14 | ;; it under the terms of the GNU General Public License as published by | |
15 | ;; the Free Software Foundation; either version 2, or (at your option) | |
16 | ;; any later version. | |
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 | |
24 | ;; along with GNU Emacs; see the file COPYING. If not, write to the | |
25 | ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
26 | ;; Boston, MA 02111-1307, USA. | |
27 | ||
28 | ;;; Commentary: | |
29 | ||
30 | ;; This package provides functions which read a URL (Uniform Resource | |
31 | ;; Locator) from the minibuffer, defaulting to the URL around point, | |
32 | ;; and ask a World-Wide Web browser to load it. It can also load the | |
33 | ;; URL associated with the current buffer. Different browsers use | |
34 | ;; different methods of remote control so there is one function for | |
35 | ;; each supported browser. If the chosen browser is not running, it | |
3abc9fa1 DL |
36 | ;; is started. Currently there is support for the following browsers, |
37 | ;; some of them probably now obsolete: | |
38 | ||
39 | ;; Function Browser Earliest version | |
7f61a9ee RS |
40 | ;; browse-url-mozilla Mozilla Don't know |
41 | ;; browse-url-galeon Galeon 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 | |
47 | ;; browse-url-iximosaic IXI Mosaic ? | |
48 | ;; browse-url-lynx-* Lynx 0 | |
49 | ;; browse-url-grail Grail 0.3b1 | |
50 | ;; browse-url-mmm MMM ? | |
51 | ;; browse-url-generic arbitrary | |
52 | ;; browse-url-default-windows-browser MS-Windows browser | |
b12e6de3 | 53 | ;; browse-url-gnome-moz GNOME interface to Mozilla |
af06f459 | 54 | ;; browse-url-kde KDE konqueror (kfm) |
8749abea GM |
55 | |
56 | ;; [A version of the Netscape browser is now free software | |
57 | ;; <URL:http://www.mozilla.org/>, albeit not GPLed, so it is | |
58 | ;; reasonable to have that as the default.] | |
59 | ||
60 | ;; Note that versions of Netscape before 1.1b1 did not have remote | |
61 | ;; control. <URL:http://www.netscape.com/newsref/std/x-remote.html>. | |
62 | ||
63 | ;; Browsers can cache Web pages so it may be necessary to tell them to | |
64 | ;; reload the current page if it has changed (e.g. if you have edited | |
65 | ;; it). There is currently no perfect automatic solution to this. | |
66 | ||
67 | ;; Netscape allows you to specify the id of the window you want to | |
68 | ;; control but which window DO you want to control and how do you | |
69 | ;; discover its id? | |
70 | ||
8749abea GM |
71 | ;; William M. Perry's excellent "w3" WWW browser for |
72 | ;; Emacs <URL:ftp://cs.indiana.edu/pub/elisp/w3/> | |
73 | ;; has a function w3-follow-url-at-point, but that | |
74 | ;; doesn't let you edit the URL like browse-url. | |
75 | ;; The `gnuserv' package that can be used to control it in another | |
76 | ;; Emacs process is available from | |
77 | ;; <URL:ftp://ftp.splode.com/pub/users/friedman/packages/>. | |
78 | ||
79 | ;; Grail is the freely available WWW browser implemented in Python, a | |
80 | ;; cool object-oriented freely available interpreted language. Grail | |
81 | ;; 0.3b1 was the first version to have remote control as distributed. | |
82 | ;; For more information on Grail see | |
83 | ;; <URL:http://grail.cnri.reston.va.us/> and for more information on | |
84 | ;; Python see <url:http://www.python.org/>. Grail support in | |
85 | ;; browse-url.el written by Barry Warsaw <bwarsaw@python.org>. | |
86 | ||
8749abea GM |
87 | ;; Lynx is now distributed by the FSF. See also |
88 | ;; <URL:http://lynx.browser.org/>. | |
89 | ||
90 | ;; Free graphical browsers that could be used by `browse-url-generic' | |
91 | ;; include Chimera <URL:ftp://ftp.cs.unlv.edu/pub/chimera> and | |
92 | ;; <URL:http://www.unlv.edu/chimera/>, Arena | |
93 | ;; <URL:ftp://ftp.yggdrasil.com/pub/dist/web/arena> and Amaya | |
94 | ;; <URL:ftp://ftp.w3.org/pub/amaya>. mMosaic | |
95 | ;; <URL:ftp://sig.enst.fr/pub/multicast/mMosaic/>, | |
96 | ;; <URL:http://sig.enst.fr/~dauphin/mMosaic/> (with development | |
97 | ;; support for Java applets and multicast) can be used like Mosaic by | |
98 | ;; setting `browse-url-mosaic-program' appropriately. | |
99 | ||
100 | ;; I [Denis Howe, not Dave Love] recommend Nelson Minar | |
101 | ;; <nelson@santafe.edu>'s excellent html-helper-mode.el for editing | |
102 | ;; HTML and thank Nelson for his many useful comments on this code. | |
103 | ;; <URL:http://www.santafe.edu/%7Enelson/hhm-beta/> | |
104 | ||
105 | ;; See also hm--html-menus <URL:http://www.tnt.uni-hannover.de/%7Emuenkel/ | |
106 | ;; software/own/hm--html-menus/>. For composing correct HTML see also | |
107 | ;; PSGML the general SGML structure editor package | |
108 | ;; <URL:ftp://ftp.lysator.liu.se/pub/sgml>; hm--html-menus can be used | |
109 | ;; with this. | |
110 | ||
111 | ;; This package generalises function html-previewer-process in Marc | |
112 | ;; Andreessen's html-mode (LCD modes/html-mode.el.Z). See also the | |
113 | ;; ffap.el package. The huge hyperbole package also contains similar | |
114 | ;; functions. | |
115 | ||
116 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
117 | ;; Help! | |
118 | ||
119 | ;; Can you write and test some code for the Macintrash and Windoze | |
120 | ;; Netscape remote control APIs? (See the URL above). | |
121 | ||
122 | ;; Do any other browsers have remote control? | |
123 | ||
124 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
125 | ;; Usage | |
126 | ||
127 | ;; To display the URL at or before point: | |
128 | ;; M-x browse-url-at-point RET | |
129 | ;; or, similarly but with the opportunity to edit the URL extracted from | |
130 | ;; the buffer, use: | |
131 | ;; M-x browse-url | |
132 | ||
133 | ;; To display a URL by shift-clicking on it, put this in your ~/.emacs | |
134 | ;; file: | |
135 | ;; (global-set-key [S-mouse-2] 'browse-url-at-mouse) | |
136 | ;; (Note that using Shift-mouse-1 is not desirable because | |
137 | ;; that event has a standard meaning in Emacs.) | |
138 | ||
139 | ;; To display the current buffer in a web browser: | |
140 | ;; M-x browse-url-of-buffer RET | |
141 | ||
142 | ;; To display the current region in a web browser: | |
143 | ;; M-x browse-url-of-region RET | |
144 | ||
145 | ;; In Dired, to display the file named on the current line: | |
146 | ;; M-x browse-url-of-dired-file RET | |
147 | ||
148 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
149 | ;; Customisation (~/.emacs) | |
150 | ||
151 | ;; To see what variables are available for customization, type | |
152 | ;; `M-x set-variable browse-url TAB'. Better, use | |
153 | ;; `M-x customize-group browse-url'. | |
154 | ||
155 | ;; Bind the browse-url commands to keys with the `C-c C-z' prefix | |
156 | ;; (as used by html-helper-mode): | |
157 | ;; (global-set-key "\C-c\C-z." 'browse-url-at-point) | |
158 | ;; (global-set-key "\C-c\C-zb" 'browse-url-of-buffer) | |
159 | ;; (global-set-key "\C-c\C-zr" 'browse-url-of-region) | |
160 | ;; (global-set-key "\C-c\C-zu" 'browse-url) | |
161 | ;; (global-set-key "\C-c\C-zv" 'browse-url-of-file) | |
162 | ;; (add-hook 'dired-mode-hook | |
163 | ;; (lambda () | |
164 | ;; (local-set-key "\C-c\C-zf" 'browse-url-of-dired-file))) | |
165 | ||
3abc9fa1 | 166 | ;; Browse URLs in mail messages under RMAIL by clicking mouse-2: |
8749abea GM |
167 | ;; (add-hook 'rmail-mode-hook (lambda () ; rmail-mode startup |
168 | ;; (define-key rmail-mode-map [mouse-2] 'browse-url-at-mouse))) | |
3abc9fa1 | 169 | ;; Alternatively, add `goto-address' to `rmail-show-message-hook'. |
8749abea | 170 | |
3abc9fa1 DL |
171 | ;; Gnus provides a standard feature to activate URLs in article |
172 | ;; buffers for invocation of browse-url. | |
8749abea GM |
173 | |
174 | ;; Use the Emacs w3 browser when not running under X11: | |
175 | ;; (or (eq window-system 'x) | |
176 | ;; (setq browse-url-browser-function 'browse-url-w3)) | |
177 | ||
178 | ;; To always save modified buffers before displaying the file in a browser: | |
179 | ;; (setq browse-url-save-file t) | |
180 | ||
181 | ;; To get round the Netscape caching problem, you could EITHER have | |
182 | ;; write-file in html-helper-mode make Netscape reload the document: | |
183 | ;; | |
184 | ;; (autoload 'browse-url-netscape-reload "browse-url" | |
185 | ;; "Ask a WWW browser to redisplay the current file." t) | |
186 | ;; (add-hook 'html-helper-mode-hook | |
187 | ;; (lambda () | |
188 | ;; (add-hook 'local-write-file-hooks | |
189 | ;; (lambda () | |
190 | ;; (let ((local-write-file-hooks)) | |
191 | ;; (save-buffer)) | |
192 | ;; (browse-url-netscape-reload) | |
193 | ;; t) ; => file written by hook | |
194 | ;; t))) ; append to l-w-f-hooks | |
195 | ;; | |
196 | ;; OR have browse-url-of-file ask Netscape to load and then reload the | |
197 | ;; file: | |
198 | ;; | |
199 | ;; (add-hook 'browse-url-of-file-hook 'browse-url-netscape-reload) | |
200 | ||
201 | ;; You may also want to customise browse-url-netscape-arguments, e.g. | |
202 | ;; (setq browse-url-netscape-arguments '("-install")) | |
203 | ;; | |
204 | ;; or similarly for the other browsers. | |
205 | ||
206 | ;; To invoke different browsers for different URLs: | |
207 | ;; (setq browse-url-browser-function '(("^mailto:" . browse-url-mail) | |
208 | ;; ("." . browse-url-netscape))) | |
209 | ||
210 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
211 | ;;; Code: | |
212 | ||
213 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
214 | ;; Variables | |
215 | ||
216 | (eval-when-compile (require 'thingatpt) | |
217 | (require 'term) | |
218 | (require 'dired) | |
7f61a9ee | 219 | (require 'executable) |
8749abea GM |
220 | (require 'w3-auto nil t)) |
221 | ||
222 | (defgroup browse-url nil | |
223 | "Use a web browser to look at a URL." | |
224 | :prefix "browse-url-" | |
082527fe | 225 | :link '(emacs-commentary-link "browse-url") |
8749abea GM |
226 | :group 'hypermedia) |
227 | ||
228 | ;;;###autoload | |
229 | (defcustom browse-url-browser-function | |
51a91c09 | 230 | (if (memq system-type '(windows-nt ms-dos)) |
8749abea | 231 | 'browse-url-default-windows-browser |
7f61a9ee | 232 | 'browse-url-default-browser) |
8749abea GM |
233 | "*Function to display the current buffer in a WWW browser. |
234 | This is used by the `browse-url-at-point', `browse-url-at-mouse', and | |
235 | `browse-url-of-file' commands. | |
236 | ||
237 | If the value is not a function it should be a list of pairs | |
082527fe | 238 | \(REGEXP . FUNCTION). In this case the function called will be the one |
8749abea GM |
239 | associated with the first REGEXP which matches the current URL. The |
240 | function is passed the URL and any other args of `browse-url'. The last | |
241 | regexp should probably be \".\" to specify a default browser." | |
242 | :type '(choice | |
082527fe DL |
243 | (function-item :tag "Emacs W3" :value browse-url-w3) |
244 | (function-item :tag "W3 in another Emacs via `gnudoit'" | |
245 | :value browse-url-w3-gnudoit) | |
7f61a9ee RS |
246 | (function-item :tag "Mozilla" :value browse-url-mozilla) |
247 | (function-item :tag "Galeon" :value browse-url-galeon) | |
082527fe DL |
248 | (function-item :tag "Netscape" :value browse-url-netscape) |
249 | (function-item :tag "Mosaic" :value browse-url-mosaic) | |
250 | (function-item :tag "Mosaic using CCI" :value browse-url-cci) | |
251 | (function-item :tag "IXI Mosaic" :value browse-url-iximosaic) | |
252 | (function-item :tag "Lynx in an xterm window" | |
253 | :value browse-url-lynx-xterm) | |
254 | (function-item :tag "Lynx in an Emacs window" | |
255 | :value browse-url-lynx-emacs) | |
256 | (function-item :tag "Grail" :value browse-url-grail) | |
257 | (function-item :tag "MMM" :value browse-url-mmm) | |
af06f459 | 258 | (function-item :tag "KDE" :value browse-url-kde) |
082527fe DL |
259 | (function-item :tag "Specified by `Browse Url Generic Program'" |
260 | :value browse-url-generic) | |
261 | (function-item :tag "Default Windows browser" | |
b12e6de3 DL |
262 | :value browse-url-default-windows-browser) |
263 | (function-item :tag "GNOME invoking Mozilla" | |
264 | :value browse-url-gnome-moz) | |
7f61a9ee RS |
265 | (function-item :tag "Default browser" |
266 | :value browse-url-default-browser) | |
082527fe DL |
267 | (function :tag "Your own function") |
268 | (alist :tag "Regexp/function association list" | |
269 | :key-type regexp :value-type function)) | |
f86f6d1e | 270 | :version "21.1" |
8749abea GM |
271 | :group 'browse-url) |
272 | ||
273 | (defcustom browse-url-netscape-program "netscape" | |
274 | ;; Info about netscape-remote from Karl Berry. | |
1665be47 | 275 | "*The name by which to invoke Netscape. |
8749abea GM |
276 | |
277 | The free program `netscape-remote' from | |
278 | <URL:http://home.netscape.com/newsref/std/remote.c> is said to start | |
279 | up very much quicker than `netscape'. Reported to compile on a GNU | |
280 | system, given vroot.h from the same directory, with cc flags | |
281 | -DSTANDALONE -L/usr/X11R6/lib -lXmu -lX11." | |
282 | :type 'string | |
283 | :group 'browse-url) | |
284 | ||
285 | (defcustom browse-url-netscape-arguments nil | |
1665be47 | 286 | "*A list of strings to pass to Netscape as arguments." |
8749abea GM |
287 | :type '(repeat (string :tag "Argument")) |
288 | :group 'browse-url) | |
289 | ||
290 | (defcustom browse-url-netscape-startup-arguments browse-url-netscape-arguments | |
1665be47 | 291 | "*A list of strings to pass to Netscape when it starts up. |
8749abea GM |
292 | Defaults to the value of `browse-url-netscape-arguments' at the time |
293 | `browse-url' is loaded." | |
294 | :type '(repeat (string :tag "Argument")) | |
295 | :group 'browse-url) | |
296 | ||
7f61a9ee RS |
297 | ;;;###autoload |
298 | (defcustom browse-url-browser-display nil | |
299 | "*The X display for running the browser, if not same as Emacs'." | |
300 | :type '(choice string (const :tag "Default" nil)) | |
301 | :group 'browse-url) | |
302 | ||
303 | (defcustom browse-url-mozilla-program "mozilla" | |
1665be47 | 304 | "*The name by which to invoke Mozilla." |
7f61a9ee RS |
305 | :type 'string |
306 | :group 'browse-url) | |
307 | ||
308 | (defcustom browse-url-mozilla-arguments nil | |
1665be47 | 309 | "*A list of strings to pass to Mozilla as arguments." |
7f61a9ee RS |
310 | :type '(repeat (string :tag "Argument")) |
311 | :group 'browse-url) | |
312 | ||
313 | (defcustom browse-url-mozilla-startup-arguments browse-url-mozilla-arguments | |
1665be47 | 314 | "*A list of strings to pass to Mozilla when it starts up. |
7f61a9ee RS |
315 | Defaults to the value of `browse-url-mozilla-arguments' at the time |
316 | `browse-url' is loaded." | |
317 | :type '(repeat (string :tag "Argument")) | |
318 | :group 'browse-url) | |
319 | ||
320 | ;;;###autoload | |
321 | (defcustom browse-url-galeon-program "galeon" | |
1665be47 | 322 | "*The name by which to invoke Galeon." |
7f61a9ee RS |
323 | :type 'string |
324 | :group 'browse-url) | |
325 | ||
326 | (defcustom browse-url-galeon-arguments nil | |
1665be47 | 327 | "*A list of strings to pass to Galeon as arguments." |
7f61a9ee RS |
328 | :type '(repeat (string :tag "Argument")) |
329 | :group 'browse-url) | |
330 | ||
331 | (defcustom browse-url-galeon-startup-arguments browse-url-galeon-arguments | |
1665be47 | 332 | "*A list of strings to pass to Galeon when it starts up. |
7f61a9ee RS |
333 | Defaults to the value of `browse-url-galeon-arguments' at the time |
334 | `browse-url' is loaded." | |
335 | :type '(repeat (string :tag "Argument")) | |
336 | :group 'browse-url) | |
337 | ||
1d5d4123 | 338 | (defcustom browse-url-galeon-new-window-is-tab nil |
1665be47 | 339 | "*Whether to open up new windows in a tab or a new window. |
1d5d4123 RS |
340 | If non-nil, then open the URL in a new tab rather than a new window if |
341 | `browse-url-galeon' is asked to open it in a new window." | |
342 | :type 'boolean | |
343 | :group 'browse-url) | |
344 | ||
8749abea | 345 | ;;;###autoload |
408d5219 | 346 | (defcustom browse-url-new-window-flag nil |
8749abea GM |
347 | "*If non-nil, always open a new browser window with appropriate browsers. |
348 | Passing an interactive argument to \\[browse-url], or specific browser | |
349 | commands reverses the effect of this variable. Requires Netscape version | |
350 | 1.1N or later or XMosaic version 2.5 or later if using those browsers." | |
351 | :type 'boolean | |
352 | :group 'browse-url) | |
353 | ||
8749abea | 354 | (defcustom browse-url-mosaic-program "xmosaic" |
1665be47 | 355 | "*The name by which to invoke Mosaic (or mMosaic)." |
8749abea GM |
356 | :type 'string |
357 | :version "20.3" | |
358 | :group 'browse-url) | |
359 | ||
360 | (defcustom browse-url-mosaic-arguments nil | |
1665be47 | 361 | "*A list of strings to pass to Mosaic as arguments." |
8749abea GM |
362 | :type '(repeat (string :tag "Argument")) |
363 | :group 'browse-url) | |
364 | ||
1665be47 RS |
365 | (defcustom browse-url-mosaic-pidfile "~/.mosaicpid" |
366 | "*The name of the pidfile created by Mosaic." | |
367 | :type 'string | |
368 | :group 'browse-url) | |
369 | ||
8749abea | 370 | (defcustom browse-url-filename-alist |
9fbe1327 DL |
371 | (\` ; Backquote syntax won't work. |
372 | (("^/\\(ftp@\\|anonymous@\\)?\\([^:]+\\):/*" . "ftp://\\2/") | |
8749abea GM |
373 | ;; The above loses the username to avoid the browser prompting for |
374 | ;; it in anonymous cases. If it's not anonymous the next regexp | |
375 | ;; applies. | |
376 | ("^/\\([^:@]+@\\)?\\([^:]+\\):/*" . "ftp://\\1\\2/") | |
9fbe1327 | 377 | (,@ (if (memq system-type '(windows-nt ms-dos)) |
74cb6a62 GM |
378 | '(("^\\([a-zA-Z]:\\)[\\/]" . "file:\\1/") |
379 | ("^[\\/][\\/]+" . "file://")))) | |
9fbe1327 | 380 | ("^/+" . "file:/"))) |
1665be47 | 381 | "*An alist of (REGEXP . STRING) pairs used by `browse-url-of-file'. |
8749abea GM |
382 | Any substring of a filename matching one of the REGEXPs is replaced by |
383 | the corresponding STRING using `replace-match', not treating STRING | |
384 | literally. All pairs are applied in the order given. The default | |
385 | value converts ange-ftp/EFS-style paths into ftp URLs and prepends | |
386 | `file:' to any path beginning with `/'. | |
387 | ||
388 | For example, adding to the default a specific translation of an ange-ftp | |
389 | address to an HTTP URL: | |
390 | ||
391 | (setq browse-url-filename-alist | |
392 | '((\"/webmaster@webserver:/home/www/html/\" . | |
393 | \"http://www.acme.co.uk/\") | |
394 | (\"^/\\(ftp@\\|anonymous@\\)?\\([^:]+\\):/*\" . \"ftp://\\2/\") | |
395 | (\"^/\\([^:@]+@\\)?\\([^:]+\\):/*\" . \"ftp://\\1\\2/\") | |
396 | (\"^/+\" . \"file:/\"))) | |
397 | " | |
398 | :type '(repeat (cons :format "%v" | |
399 | (regexp :tag "Regexp") | |
400 | (string :tag "Replacement"))) | |
401 | :version "20.3" | |
402 | :group 'browse-url) | |
403 | ||
404 | ;;;###autoload | |
405 | (defcustom browse-url-save-file nil | |
406 | "*If non-nil, save the buffer before displaying its file. | |
407 | Used by the `browse-url-of-file' command." | |
408 | :type 'boolean | |
409 | :group 'browse-url) | |
410 | ||
411 | (defcustom browse-url-of-file-hook nil | |
1665be47 | 412 | "*Run after `browse-url-of-file' has asked a browser to load a file. |
8749abea GM |
413 | |
414 | Set this to `browse-url-netscape-reload' to force Netscape to load the | |
415 | file rather than displaying a cached copy." | |
416 | :type 'hook | |
417 | :options '(browse-url-netscape-reload) | |
418 | :group 'browse-url) | |
419 | ||
420 | (defvar browse-url-usr1-signal | |
421 | (if (and (boundp 'emacs-major-version) | |
422 | (or (> emacs-major-version 19) (>= emacs-minor-version 29))) | |
423 | 'SIGUSR1 ; Why did I think this was in lower case before? | |
424 | 30) ; Check /usr/include/signal.h. | |
425 | "The argument to `signal-process' for sending SIGUSR1 to XMosaic. | |
426 | Emacs 19.29 accepts 'SIGUSR1, earlier versions require an integer | |
427 | which is 30 on SunOS and 16 on HP-UX and Solaris.") | |
428 | ||
429 | (defcustom browse-url-CCI-port 3003 | |
1665be47 | 430 | "*Port to access XMosaic via CCI. |
8749abea GM |
431 | This can be any number between 1024 and 65535 but must correspond to |
432 | the value set in the browser." | |
433 | :type 'integer | |
434 | :group 'browse-url) | |
435 | ||
436 | (defcustom browse-url-CCI-host "localhost" | |
437 | "*Host to access XMosaic via CCI. | |
438 | This should be the host name of the machine running XMosaic with CCI | |
439 | enabled. The port number should be set in `browse-url-CCI-port'." | |
440 | :type 'string | |
441 | :group 'browse-url) | |
442 | ||
443 | (defvar browse-url-temp-file-name nil) | |
444 | (make-variable-buffer-local 'browse-url-temp-file-name) | |
445 | ||
446 | (defcustom browse-url-xterm-program "xterm" | |
1665be47 | 447 | "*The name of the terminal emulator used by `browse-url-lynx-xterm'. |
8749abea GM |
448 | This might, for instance, be a separate colour version of xterm." |
449 | :type 'string | |
450 | :group 'browse-url) | |
451 | ||
452 | (defcustom browse-url-xterm-args nil | |
453 | "*A list of strings defining options for `browse-url-xterm-program'. | |
454 | These might set its size, for instance." | |
455 | :type '(repeat (string :tag "Argument")) | |
456 | :group 'browse-url) | |
457 | ||
63900fcf | 458 | (defcustom browse-url-lynx-emacs-args (and (not window-system) |
8749abea | 459 | '("-show_cursor")) |
1665be47 | 460 | "*A list of strings defining options for Lynx in an Emacs buffer. |
8749abea GM |
461 | |
462 | The default is none in a window system, otherwise `-show_cursor' to | |
463 | indicate the position of the current link in the absence of | |
464 | highlighting, assuming the normal default for showing the cursor." | |
465 | :type '(repeat (string :tag "Argument")) | |
466 | :version "20.3" | |
467 | :group 'browse-url) | |
468 | ||
469 | (defcustom browse-url-gnudoit-program "gnudoit" | |
1665be47 | 470 | "*The name of the `gnudoit' program used by `browse-url-w3-gnudoit'." |
8749abea GM |
471 | :type 'string |
472 | :group 'browse-url) | |
473 | ||
474 | (defcustom browse-url-gnudoit-args '("-q") | |
475 | "*A list of strings defining options for `browse-url-gnudoit-program'. | |
476 | These might set the port, for instance." | |
477 | :type '(repeat (string :tag "Argument")) | |
478 | :group 'browse-url) | |
479 | ||
480 | ;;;###autoload | |
481 | (defcustom browse-url-generic-program nil | |
482 | "*The name of the browser program used by `browse-url-generic'." | |
483 | :type '(choice string (const :tag "None" nil)) | |
484 | :group 'browse-url) | |
485 | ||
486 | (defcustom browse-url-generic-args nil | |
487 | "*A list of strings defining options for `browse-url-generic-program'." | |
488 | :type '(repeat (string :tag "Argument")) | |
489 | :group 'browse-url) | |
490 | ||
491 | (defcustom browse-url-temp-dir temporary-file-directory | |
1665be47 | 492 | "*The name of a directory for browse-url's temporary files. |
8749abea GM |
493 | Such files are generated by functions like `browse-url-of-region'. |
494 | You might want to set this to somewhere with restricted read permissions | |
495 | for privacy's sake." | |
496 | :type 'string | |
497 | :group 'browse-url) | |
498 | ||
499 | (defcustom browse-url-netscape-version | |
500 | 3 | |
1665be47 | 501 | "*The version of Netscape you are using. |
8749abea GM |
502 | This affects how URL reloading is done; the mechanism changed |
503 | incompatibly at version 4." | |
504 | :type 'number | |
505 | :group 'browse-url) | |
506 | ||
507 | (defcustom browse-url-lynx-input-field 'avoid | |
508 | "*Action on selecting an existing Lynx buffer at an input field. | |
509 | What to do when sending a new URL to an existing Lynx buffer in Emacs | |
510 | if the Lynx cursor is on an input field (in which case the `g' command | |
511 | would be entered as data). Such fields are recognized by the | |
512 | underlines ____. Allowed values: nil: disregard it, 'warn: warn the | |
513 | user and don't emit the URL, 'avoid: try to avoid the field by moving | |
514 | down (this *won't* always work)." | |
515 | :type '(choice (const :tag "Move to try to avoid field" :value avoid) | |
516 | (const :tag "Disregard" :value nil) | |
517 | (const :tag "Warn, don't emit URL" :value warn)) | |
518 | :version "20.3" | |
519 | :group 'browse-url) | |
520 | ||
521 | (defvar browse-url-lynx-input-attempts 10 | |
522 | "*How many times to try to move down from a series of lynx input fields.") | |
523 | ||
524 | (defcustom browse-url-lynx-input-delay 0.2 | |
1665be47 | 525 | "*How many seconds to wait for lynx between moves down from an input field.") |
8749abea | 526 | |
af06f459 | 527 | (defcustom browse-url-kde-program "kfmclient" |
1665be47 | 528 | "*The name by which to invoke the KDE web browser." |
af06f459 GM |
529 | :type 'string |
530 | :version "21.1" | |
531 | :group 'browse-url) | |
532 | ||
533 | (defcustom browse-url-kde-args '("openURL") | |
534 | "*A list of strings defining options for `browse-url-kde-program'." | |
535 | :type '(repeat (string :tag "Argument")) | |
536 | :group 'browse-url) | |
537 | ||
8749abea GM |
538 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
539 | ;; URL input | |
540 | ||
541 | (defun browse-url-url-at-point () | |
542 | (let ((url (thing-at-point 'url))) | |
543 | (set-text-properties 0 (length url) nil url) | |
544 | url)) | |
545 | ||
546 | ;; Having this as a separate function called by the browser-specific | |
547 | ;; functions allows them to be stand-alone commands, making it easier | |
548 | ;; to switch between browsers. | |
549 | ||
550 | (defun browse-url-interactive-arg (prompt) | |
551 | "Read a URL from the minibuffer, prompting with PROMPT. | |
552 | Default to the URL at or before point. If invoked with a mouse button, | |
553 | set point to the position clicked first. Return a list for use in | |
408d5219 | 554 | `interactive' containing the URL and `browse-url-new-window-flag' or its |
8749abea GM |
555 | negation if a prefix argument was given." |
556 | (let ((event (elt (this-command-keys) 0))) | |
557 | (and (listp event) (mouse-set-point event))) | |
558 | (list (read-string prompt (browse-url-url-at-point)) | |
408d5219 | 559 | (not (eq (null browse-url-new-window-flag) |
8749abea GM |
560 | (null current-prefix-arg))))) |
561 | ||
01f97560 DL |
562 | ;; interactive-p needs to be called at a function's top-level, hence |
563 | ;; the macro. | |
564 | (defmacro browse-url-maybe-new-window (arg) | |
f1ec0007 | 565 | `(if (not (interactive-p)) |
01f97560 | 566 | ,arg |
408d5219 | 567 | browse-url-new-window-flag)) |
01f97560 | 568 | |
8749abea GM |
569 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
570 | ;; Browse current buffer | |
571 | ||
572 | ;;;###autoload | |
573 | (defun browse-url-of-file (&optional file) | |
574 | "Ask a WWW browser to display FILE. | |
575 | Display the current buffer's file if FILE is nil or if called | |
576 | interactively. Turn the filename into a URL with function | |
577 | `browse-url-file-url'. Pass the URL to a browser using the | |
578 | `browse-url' function then run `browse-url-of-file-hook'." | |
579 | (interactive) | |
580 | (or file | |
581 | (setq file (buffer-file-name)) | |
582 | (error "Current buffer has no file")) | |
583 | (let ((buf (get-file-buffer file))) | |
584 | (if buf | |
585 | (save-excursion | |
586 | (set-buffer buf) | |
587 | (cond ((not (buffer-modified-p))) | |
588 | (browse-url-save-file (save-buffer)) | |
589 | (t (message "%s modified since last save" file)))))) | |
590 | (browse-url (browse-url-file-url file)) | |
591 | (run-hooks 'browse-url-of-file-hook)) | |
592 | ||
593 | (defun browse-url-file-url (file) | |
594 | "Return the URL corresponding to FILE. | |
595 | Use variable `browse-url-filename-alist' to map filenames to URLs." | |
596 | ;; URL-encode special chars, do % first | |
597 | (let ((s 0)) | |
598 | (while (setq s (string-match "%" file s)) | |
599 | (setq file (replace-match "%25" t t file) | |
600 | s (1+ s)))) | |
601 | (while (string-match "[*\"()',=;? ]" file) | |
602 | (let ((enc (format "%%%x" (aref file (match-beginning 0))))) | |
603 | (setq file (replace-match enc t t file)))) | |
63900fcf SS |
604 | (dolist (map browse-url-filename-alist) |
605 | (when (and map (string-match (car map) file)) | |
606 | (setq file (replace-match (cdr map) t nil file)))) | |
8749abea GM |
607 | file) |
608 | ||
609 | ;;;###autoload | |
610 | (defun browse-url-of-buffer (&optional buffer) | |
611 | "Ask a WWW browser to display BUFFER. | |
612 | Display the current buffer if BUFFER is nil. Display only the | |
613 | currently visible part of BUFFER (from a temporary file) if buffer is | |
614 | narrowed." | |
615 | (interactive) | |
616 | (save-excursion | |
617 | (and buffer (set-buffer buffer)) | |
618 | (let ((file-name | |
619 | ;; Ignore real name if restricted | |
620 | (and (= (- (point-max) (point-min)) (buffer-size)) | |
621 | (or buffer-file-name | |
622 | (and (boundp 'dired-directory) dired-directory))))) | |
623 | (or file-name | |
624 | (progn | |
625 | (or browse-url-temp-file-name | |
626 | (setq browse-url-temp-file-name | |
627 | (convert-standard-filename | |
628 | (make-temp-file | |
629 | (expand-file-name "burl" browse-url-temp-dir))))) | |
630 | (setq file-name browse-url-temp-file-name) | |
631 | (write-region (point-min) (point-max) file-name nil 'no-message))) | |
632 | (browse-url-of-file file-name)))) | |
633 | ||
634 | (defun browse-url-delete-temp-file (&optional temp-file-name) | |
635 | ;; Delete browse-url-temp-file-name from the file system | |
636 | ;; If optional arg TEMP-FILE-NAME is non-nil, delete it instead | |
637 | (let ((file-name (or temp-file-name browse-url-temp-file-name))) | |
638 | (if (and file-name (file-exists-p file-name)) | |
639 | (delete-file file-name)))) | |
640 | ||
641 | (add-hook 'kill-buffer-hook 'browse-url-delete-temp-file) | |
642 | ||
643 | ;;;###autoload | |
644 | (defun browse-url-of-dired-file () | |
645 | "In Dired, ask a WWW browser to display the file named on this line." | |
646 | (interactive) | |
647 | (browse-url-of-file (dired-get-filename))) | |
648 | ||
649 | ;;;###autoload | |
650 | (defun browse-url-of-region (min max) | |
651 | "Ask a WWW browser to display the current region." | |
652 | (interactive "r") | |
653 | (save-excursion | |
654 | (save-restriction | |
655 | (narrow-to-region min max) | |
656 | (browse-url-of-buffer)))) | |
657 | ||
658 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
659 | ;; Browser-independent commands | |
660 | ||
661 | ;; A generic command to call the current browse-url-browser-function | |
662 | ||
663 | ;;;###autoload | |
664 | (defun browse-url (url &rest args) | |
665 | "Ask a WWW browser to load URL. | |
666 | Prompts for a URL, defaulting to the URL at or before point. Variable | |
667 | `browse-url-browser-function' says which browser to use." | |
668 | (interactive (browse-url-interactive-arg "URL: ")) | |
01f97560 | 669 | (unless (interactive-p) |
408d5219 | 670 | (setq args (or args (list browse-url-new-window-flag)))) |
8749abea GM |
671 | (if (functionp browse-url-browser-function) |
672 | (apply browse-url-browser-function url args) | |
673 | ;; The `function' can be an alist; look down it for first match | |
674 | ;; and apply the function (which might be a lambda). | |
675 | (catch 'done | |
3abc9fa1 DL |
676 | (dolist (bf browse-url-browser-function) |
677 | (when (string-match (car bf) url) | |
678 | (apply (cdr bf) url args) | |
679 | (throw 'done t))) | |
680 | (error "No browse-url-browser-function matching URL %s" | |
8749abea GM |
681 | url)))) |
682 | ||
683 | ;;;###autoload | |
01f97560 | 684 | (defun browse-url-at-point (&optional arg) |
8749abea GM |
685 | "Ask a WWW browser to load the URL at or before point. |
686 | Doesn't let you edit the URL like `browse-url'. Variable | |
687 | `browse-url-browser-function' says which browser to use." | |
01f97560 | 688 | (interactive "P") |
3abc9fa1 DL |
689 | (let ((url (browse-url-url-at-point))) |
690 | (if url | |
691 | (browse-url url (if arg | |
408d5219 GM |
692 | (not browse-url-new-window-flag) |
693 | browse-url-new-window-flag)) | |
3abc9fa1 | 694 | (error "No URL found")))) |
8749abea GM |
695 | |
696 | ;;;###autoload | |
697 | (defun browse-url-at-mouse (event) | |
698 | "Ask a WWW browser to load a URL clicked with the mouse. | |
699 | The URL is the one around or before the position of the mouse click | |
700 | but point is not changed. Doesn't let you edit the URL like | |
701 | `browse-url'. Variable `browse-url-browser-function' says which browser | |
702 | to use." | |
703 | (interactive "e") | |
704 | (save-excursion | |
3abc9fa1 | 705 | (mouse-set-point event) |
408d5219 | 706 | (browse-url-at-point browse-url-new-window-flag))) |
8749abea GM |
707 | |
708 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
709 | ;; Browser-specific commands | |
710 | ||
711 | ;; --- Default MS-Windows browser --- | |
712 | ||
713 | (defun browse-url-default-windows-browser (url &optional new-window) | |
714 | (interactive (browse-url-interactive-arg "URL: ")) | |
51a91c09 EZ |
715 | (if (eq system-type 'ms-dos) |
716 | (if dos-windows-version | |
717 | (shell-command (concat "start " (shell-quote-argument url))) | |
718 | (error "Browsing URLs is not supported on this system")) | |
719 | (w32-shell-execute "open" url))) | |
8749abea GM |
720 | |
721 | ;; --- Netscape --- | |
722 | ||
723 | (defun browse-url-process-environment () | |
7f61a9ee RS |
724 | "Set DISPLAY in the environment to the X display the browser will use. |
725 | This is either the value of variable `browse-url-browser-display' if | |
8749abea GM |
726 | non-nil, or the same display as Emacs if different from the current |
727 | environment, otherwise just use the current environment." | |
7f61a9ee | 728 | (let ((display (or browse-url-browser-display (browse-url-emacs-display)))) |
8749abea GM |
729 | (if display |
730 | (cons (concat "DISPLAY=" display) process-environment) | |
731 | process-environment))) | |
732 | ||
733 | (defun browse-url-emacs-display () | |
734 | "Return the X display Emacs is running on. | |
735 | This is nil if the display is the same as the DISPLAY environment variable. | |
736 | ||
737 | Actually Emacs could be using several displays; this just returns the | |
738 | one showing the selected frame." | |
739 | (let ((display (cdr-safe (assq 'display (frame-parameters))))) | |
740 | (and (not (equal display (getenv "DISPLAY"))) | |
741 | display))) | |
742 | ||
7f61a9ee RS |
743 | ;;;###autoload |
744 | (defun browse-url-default-browser (url &rest args) | |
745 | "Find a suitable browser and ask it to load URL. | |
746 | Default to the URL around or before point. | |
747 | ||
748 | When called interactively, if variable `browse-url-new-window-flag' is | |
749 | non-nil, load the document in a new window, if possible, otherwise use | |
750 | a random existing one. A non-nil interactive prefix argument reverses | |
751 | the effect of `browse-url-new-window-flag'. | |
752 | ||
753 | When called non-interactively, optional second argument NEW-WINDOW is | |
754 | used instead of `browse-url-new-window-flag'. | |
755 | ||
756 | The order attempted is gnome-moz-remote, Mozilla, Galeon, Netscape, | |
757 | Mosaic, IXI Mosaic, Lynx in an xterm, MMM, Konqueror, and then W3." | |
758 | (apply | |
759 | (cond | |
760 | ((executable-find "gnome-moz-remote") 'browse-url-gnome-moz) | |
761 | ((executable-find browse-url-mozilla-program) 'browse-url-mozilla) | |
762 | ((executable-find browse-url-galeon-program) 'browse-url-galeon) | |
763 | ((executable-find browse-url-kde-program) 'browse-url-kde) | |
764 | ((executable-find browse-url-netscape-program) 'browse-url-netscape) | |
765 | ((executable-find browse-url-mosaic-program) 'browse-url-mosaic) | |
766 | ((executable-find "tellw3b") 'browse-url-iximosaic) | |
767 | ((executable-find browse-url-xterm-program) 'browse-url-lynx-xterm) | |
768 | ((executable-find "mmm") 'browse-url-mmm) | |
769 | (t 'browse-url-w3)) | |
770 | url args)) | |
771 | ||
8749abea GM |
772 | ;;;###autoload |
773 | (defun browse-url-netscape (url &optional new-window) | |
774 | "Ask the Netscape WWW browser to load URL. | |
8749abea GM |
775 | Default to the URL around or before point. The strings in variable |
776 | `browse-url-netscape-arguments' are also passed to Netscape. | |
777 | ||
408d5219 | 778 | When called interactively, if variable `browse-url-new-window-flag' is |
8749abea GM |
779 | non-nil, load the document in a new Netscape window, otherwise use a |
780 | random existing one. A non-nil interactive prefix argument reverses | |
408d5219 | 781 | the effect of `browse-url-new-window-flag'. |
8749abea GM |
782 | |
783 | When called non-interactively, optional second argument NEW-WINDOW is | |
408d5219 | 784 | used instead of `browse-url-new-window-flag'." |
de5552d5 | 785 | (interactive (browse-url-interactive-arg "URL: ")) |
8749abea GM |
786 | ;; URL encode any `confusing' characters in the URL. This needs to |
787 | ;; include at least commas; presumably also close parens. | |
788 | (while (string-match "[,)]" url) | |
789 | (setq url (replace-match | |
790 | (format "%%%x" (string-to-char (match-string 0 url))) t t url))) | |
791 | (let* ((process-environment (browse-url-process-environment)) | |
792 | (process (apply 'start-process | |
793 | (concat "netscape " url) nil | |
794 | browse-url-netscape-program | |
795 | (append | |
796 | browse-url-netscape-arguments | |
797 | (if (eq window-system 'w32) | |
798 | (list url) | |
799 | (append | |
800 | (if new-window '("-noraise")) | |
801 | (list "-remote" | |
802 | (concat "openURL(" url | |
01f97560 DL |
803 | (if (browse-url-maybe-new-window |
804 | new-window) | |
805 | ",new-window") | |
8749abea GM |
806 | ")")))))))) |
807 | (set-process-sentinel process | |
3abc9fa1 DL |
808 | `(lambda (process change) |
809 | (browse-url-netscape-sentinel process ,url))))) | |
8749abea GM |
810 | |
811 | (defun browse-url-netscape-sentinel (process url) | |
812 | "Handle a change to the process communicating with Netscape." | |
813 | (or (eq (process-exit-status process) 0) | |
814 | (let* ((process-environment (browse-url-process-environment))) | |
815 | ;; Netscape not running - start it | |
816 | (message "Starting Netscape...") | |
817 | (apply 'start-process (concat "netscape" url) nil | |
818 | browse-url-netscape-program | |
819 | (append browse-url-netscape-startup-arguments (list url)))))) | |
820 | ||
821 | (defun browse-url-netscape-reload () | |
822 | "Ask Netscape to reload its current document. | |
823 | How depends on `browse-url-netscape-version'." | |
824 | (interactive) | |
825 | ;; Backwards incompatibility reported by | |
826 | ;; <peter.kruse@psychologie.uni-regensburg.de>. | |
827 | (browse-url-netscape-send (if (>= browse-url-netscape-version 4) | |
828 | "xfeDoCommand(reload)" | |
829 | "reload"))) | |
830 | ||
831 | (defun browse-url-netscape-send (command) | |
832 | "Send a remote control command to Netscape." | |
833 | (let* ((process-environment (browse-url-process-environment))) | |
834 | (apply 'start-process "netscape" nil | |
835 | browse-url-netscape-program | |
836 | (append browse-url-netscape-arguments | |
837 | (list "-remote" command))))) | |
838 | ||
7f61a9ee RS |
839 | ;;;###autoload |
840 | (defun browse-url-mozilla (url &optional new-window) | |
841 | "Ask the Mozilla WWW browser to load URL. | |
842 | Default to the URL around or before point. The strings in variable | |
843 | `browse-url-mozilla-arguments' are also passed to Mozilla. | |
844 | ||
845 | When called interactively, if variable `browse-url-new-window-flag' is | |
846 | non-nil, load the document in a new Mozilla window, otherwise use a | |
847 | random existing one. A non-nil interactive prefix argument reverses | |
848 | the effect of `browse-url-new-window-flag'. | |
849 | ||
850 | When called non-interactively, optional second argument NEW-WINDOW is | |
851 | used instead of `browse-url-new-window-flag'." | |
852 | (interactive (browse-url-interactive-arg "URL: ")) | |
853 | ;; URL encode any `confusing' characters in the URL. This needs to | |
854 | ;; include at least commas; presumably also close parens. | |
855 | (while (string-match "[,)]" url) | |
856 | (setq url (replace-match | |
857 | (format "%%%x" (string-to-char (match-string 0 url))) t t url))) | |
858 | (let* ((process-environment (browse-url-process-environment)) | |
859 | (process (apply 'start-process | |
860 | (concat "mozilla " url) nil | |
861 | browse-url-mozilla-program | |
862 | (append | |
863 | browse-url-mozilla-arguments | |
864 | (list "-remote" | |
865 | (concat "openURL(" | |
866 | url | |
867 | (if new-window ",new-window") | |
868 | ")")))))) | |
869 | (set-process-sentinel process | |
870 | `(lambda (process change) | |
871 | (browse-url-mozilla-sentinel process ,url))))) | |
872 | ||
873 | (defun browse-url-mozilla-sentinel (process url) | |
874 | "Handle a change to the process communicating with Mozilla." | |
875 | (or (eq (process-exit-status process) 0) | |
876 | (let* ((process-environment (browse-url-process-environment))) | |
877 | ;; Mozilla is not running - start it | |
878 | (message "Starting Mozilla...") | |
879 | (apply 'start-process (concat "mozilla " url) nil | |
880 | browse-url-mozilla-program | |
881 | (append browse-url-mozilla-startup-arguments (list url)))))) | |
882 | ||
883 | ;;;###autoload | |
884 | (defun browse-url-galeon (url &optional new-window) | |
885 | "Ask the Galeon WWW browser to load URL. | |
886 | Default to the URL around or before point. The strings in variable | |
887 | `browse-url-galeon-arguments' are also passed to Galeon. | |
888 | ||
889 | When called interactively, if variable `browse-url-new-window-flag' is | |
890 | non-nil, load the document in a new Galeon window, otherwise use a | |
891 | random existing one. A non-nil interactive prefix argument reverses | |
892 | the effect of `browse-url-new-window-flag'. | |
893 | ||
b77784f7 RS |
894 | If `browse-url-galeon-new-window-is-tab' is non-nil, then whenever a |
895 | document would otherwise be loaded in a new window, it is loaded in a | |
896 | new tab in an existing window instead. | |
897 | ||
7f61a9ee RS |
898 | When called non-interactively, optional second argument NEW-WINDOW is |
899 | used instead of `browse-url-new-window-flag'." | |
900 | (interactive (browse-url-interactive-arg "URL: ")) | |
901 | ;; URL encode any `confusing' characters in the URL. This needs to | |
902 | ;; include at least commas; presumably also close parens. | |
903 | (while (string-match "[,)]" url) | |
904 | (setq url (replace-match | |
905 | (format "%%%x" (string-to-char (match-string 0 url))) t t url))) | |
906 | (let* ((process-environment (browse-url-process-environment)) | |
907 | (process (apply 'start-process | |
908 | (concat "galeon " url) nil | |
909 | browse-url-galeon-program | |
910 | (append | |
911 | browse-url-galeon-arguments | |
1d5d4123 RS |
912 | (if (browse-url-maybe-new-window new-window) |
913 | (if browse-url-galeon-new-window-is-tab | |
914 | '("--new-tab") | |
b77784f7 RS |
915 | '("--new-window" "--noraise")) |
916 | '("--existing")) | |
917 | (list url))))) | |
7f61a9ee RS |
918 | (set-process-sentinel process |
919 | `(lambda (process change) | |
920 | (browse-url-galeon-sentinel process ,url))))) | |
921 | ||
922 | (defun browse-url-galeon-sentinel (process url) | |
923 | "Handle a change to the process communicating with Galeon." | |
924 | (or (eq (process-exit-status process) 0) | |
925 | (let* ((process-environment (browse-url-process-environment))) | |
926 | ;; Galeon is not running - start it | |
927 | (message "Starting Galeon...") | |
928 | (apply 'start-process (concat "galeon " url) nil | |
929 | browse-url-galeon-program | |
930 | (append browse-url-galeon-startup-arguments (list url)))))) | |
931 | ||
de5552d5 DL |
932 | ;; GNOME means of invoking either Mozilla or Netrape. |
933 | ||
934 | (defcustom browse-url-gnome-moz-arguments '() | |
1665be47 | 935 | "*A list of strings passed to the GNOME mozilla viewer as arguments." |
de5552d5 DL |
936 | :version "21.1" |
937 | :type '(repeat (string :tag "Argument")) | |
938 | :group 'browse-url) | |
939 | ||
b12e6de3 | 940 | ;;;###autoload |
de5552d5 DL |
941 | (defun browse-url-gnome-moz (url &optional new-window) |
942 | "Ask Mozilla/Netscape to load URL via the GNOME program `gnome-moz-remote'. | |
943 | Default to the URL around or before point. The strings in variable | |
944 | `browse-url-gnome-moz-arguments' are also passed. | |
945 | ||
408d5219 | 946 | When called interactively, if variable `browse-url-new-window-flag' is |
de5552d5 DL |
947 | non-nil, load the document in a new browser window, otherwise use an |
948 | existing one. A non-nil interactive prefix argument reverses the | |
408d5219 | 949 | effect of `browse-url-new-window-flag'. |
de5552d5 DL |
950 | |
951 | When called non-interactively, optional second argument NEW-WINDOW is | |
408d5219 | 952 | used instead of `browse-url-new-window-flag'." |
de5552d5 DL |
953 | (interactive (browse-url-interactive-arg "URL: ")) |
954 | (apply 'start-process (concat "gnome-moz-remote " url) | |
955 | nil | |
956 | "gnome-moz-remote" | |
957 | (append | |
958 | browse-url-gnome-moz-arguments | |
959 | (if (browse-url-maybe-new-window new-window) | |
960 | '("--newwin")) | |
961 | (list "--raise" url)))) | |
962 | ||
8749abea GM |
963 | ;; --- Mosaic --- |
964 | ||
965 | ;;;###autoload | |
966 | (defun browse-url-mosaic (url &optional new-window) | |
967 | "Ask the XMosaic WWW browser to load URL. | |
968 | ||
969 | Default to the URL around or before point. The strings in variable | |
970 | `browse-url-mosaic-arguments' are also passed to Mosaic and the | |
971 | program is invoked according to the variable | |
972 | `browse-url-mosaic-program'. | |
973 | ||
408d5219 | 974 | When called interactively, if variable `browse-url-new-window-flag' is |
8749abea GM |
975 | non-nil, load the document in a new Mosaic window, otherwise use a |
976 | random existing one. A non-nil interactive prefix argument reverses | |
408d5219 | 977 | the effect of `browse-url-new-window-flag'. |
8749abea GM |
978 | |
979 | When called non-interactively, optional second argument NEW-WINDOW is | |
408d5219 | 980 | used instead of `browse-url-new-window-flag'." |
8749abea | 981 | (interactive (browse-url-interactive-arg "Mosaic URL: ")) |
1665be47 | 982 | (let ((pidfile (expand-file-name browse-url-mosaic-pidfile)) |
8749abea GM |
983 | pid) |
984 | (if (file-readable-p pidfile) | |
985 | (save-excursion | |
986 | (find-file pidfile) | |
987 | (goto-char (point-min)) | |
988 | (setq pid (read (current-buffer))) | |
989 | (kill-buffer nil))) | |
990 | (if (and pid (zerop (signal-process pid 0))) ; Mosaic running | |
991 | (save-excursion | |
992 | (find-file (format "/tmp/Mosaic.%d" pid)) | |
993 | (erase-buffer) | |
01f97560 | 994 | (insert (if (browse-url-maybe-new-window new-window) |
8749abea GM |
995 | "newwin\n" |
996 | "goto\n") | |
997 | url "\n") | |
998 | (save-buffer) | |
999 | (kill-buffer nil) | |
1000 | ;; Send signal SIGUSR to Mosaic | |
1001 | (message "Signalling Mosaic...") | |
1002 | (signal-process pid browse-url-usr1-signal) | |
1003 | ;; Or you could try: | |
1004 | ;; (call-process "kill" nil 0 nil "-USR1" (int-to-string pid)) | |
1005 | (message "Signalling Mosaic...done") | |
1006 | ) | |
1007 | ;; Mosaic not running - start it | |
1008 | (message "Starting Mosaic...") | |
1009 | (apply 'start-process "xmosaic" nil browse-url-mosaic-program | |
1010 | (append browse-url-mosaic-arguments (list url))) | |
1011 | (message "Starting Mosaic...done")))) | |
1012 | ||
1013 | ;; --- Grail --- | |
1014 | ||
1015 | ;;;###autoload | |
1016 | (defvar browse-url-grail | |
1017 | (concat (or (getenv "GRAILDIR") "~/.grail") "/user/rcgrail.py") | |
1018 | "Location of Grail remote control client script `rcgrail.py'. | |
1019 | Typically found in $GRAILDIR/rcgrail.py, or ~/.grail/user/rcgrail.py.") | |
1020 | ||
1021 | ;;;###autoload | |
1022 | (defun browse-url-grail (url &optional new-window) | |
1023 | "Ask the Grail WWW browser to load URL. | |
1024 | Default to the URL around or before point. Runs the program in the | |
1025 | variable `browse-url-grail'." | |
1026 | (interactive (browse-url-interactive-arg "Grail URL: ")) | |
1027 | (message "Sending URL to Grail...") | |
1028 | (save-excursion | |
1029 | (set-buffer (get-buffer-create " *Shell Command Output*")) | |
1030 | (erase-buffer) | |
1031 | ;; don't worry about this failing. | |
0deef26e | 1032 | (if (browse-url-maybe-new-window new-window) |
8749abea GM |
1033 | (call-process browse-url-grail nil 0 nil "-b" url) |
1034 | (call-process browse-url-grail nil 0 nil url)) | |
1035 | (message "Sending URL to Grail... done"))) | |
1036 | ||
1037 | ;; --- Mosaic using CCI --- | |
1038 | ||
1039 | ;;;###autoload | |
1040 | (defun browse-url-cci (url &optional new-window) | |
1041 | "Ask the XMosaic WWW browser to load URL. | |
1042 | Default to the URL around or before point. | |
1043 | ||
1044 | This function only works for XMosaic version 2.5 or later. You must | |
1045 | select `CCI' from XMosaic's File menu, set the CCI Port Address to the | |
1046 | value of variable `browse-url-CCI-port', and enable `Accept requests'. | |
1047 | ||
408d5219 | 1048 | When called interactively, if variable `browse-url-new-window-flag' is |
8749abea GM |
1049 | non-nil, load the document in a new browser window, otherwise use a |
1050 | random existing one. A non-nil interactive prefix argument reverses | |
408d5219 | 1051 | the effect of `browse-url-new-window-flag'. |
8749abea GM |
1052 | |
1053 | When called non-interactively, optional second argument NEW-WINDOW is | |
408d5219 | 1054 | used instead of `browse-url-new-window-flag'." |
8749abea GM |
1055 | (interactive (browse-url-interactive-arg "Mosaic URL: ")) |
1056 | (open-network-stream "browse-url" " *browse-url*" | |
1057 | browse-url-CCI-host browse-url-CCI-port) | |
1058 | ;; Todo: start browser if fails | |
1059 | (process-send-string "browse-url" | |
1060 | (concat "get url (" url ") output " | |
01f97560 | 1061 | (if (browse-url-maybe-new-window new-window) |
8749abea GM |
1062 | "new" |
1063 | "current") | |
1064 | "\r\n")) | |
1065 | (process-send-string "browse-url" "disconnect\r\n") | |
1066 | (delete-process "browse-url")) | |
1067 | ||
1068 | ;; --- IXI Mosaic --- | |
1069 | ||
1070 | ;;;###autoload | |
1071 | (defun browse-url-iximosaic (url &optional new-window) | |
1072 | ;; new-window ignored | |
1073 | "Ask the IXIMosaic WWW browser to load URL. | |
1074 | Default to the URL around or before point." | |
1075 | (interactive (browse-url-interactive-arg "IXI Mosaic URL: ")) | |
1076 | (start-process "tellw3b" nil "tellw3b" | |
1077 | "-service WWW_BROWSER ixi_showurl " url)) | |
1078 | ||
1079 | ;; --- W3 --- | |
1080 | ||
1081 | ;;;###autoload | |
1082 | (defun browse-url-w3 (url &optional new-window) | |
1083 | "Ask the w3 WWW browser to load URL. | |
1084 | Default to the URL around or before point. | |
1085 | ||
408d5219 | 1086 | When called interactively, if variable `browse-url-new-window-flag' is |
8749abea | 1087 | non-nil, load the document in a new window. A non-nil interactive |
408d5219 | 1088 | prefix argument reverses the effect of `browse-url-new-window-flag'. |
8749abea GM |
1089 | |
1090 | When called non-interactively, optional second argument NEW-WINDOW is | |
408d5219 | 1091 | used instead of `browse-url-new-window-flag'." |
8749abea GM |
1092 | (interactive (browse-url-interactive-arg "W3 URL: ")) |
1093 | (require 'w3) ; w3-fetch-other-window not autoloaded | |
01f97560 | 1094 | (if (browse-url-maybe-new-window new-window) |
8749abea GM |
1095 | (w3-fetch-other-window url) |
1096 | (w3-fetch url))) | |
1097 | ||
1098 | ;;;###autoload | |
1099 | (defun browse-url-w3-gnudoit (url &optional new-window) | |
1100 | ;; new-window ignored | |
1101 | "Ask another Emacs running gnuserv to load the URL using the W3 browser. | |
1102 | The `browse-url-gnudoit-program' program is used with options given by | |
1103 | `browse-url-gnudoit-args'. Default to the URL around or before point." | |
1104 | (interactive (browse-url-interactive-arg "W3 URL: ")) | |
1105 | (apply 'start-process (concat "gnudoit:" url) nil | |
1106 | browse-url-gnudoit-program | |
01f97560 DL |
1107 | (append browse-url-gnudoit-args |
1108 | (list (concat "(w3-fetch \"" url "\")") | |
1109 | "(raise-frame)")))) | |
8749abea GM |
1110 | |
1111 | ;; --- Lynx in an xterm --- | |
1112 | ||
1113 | ;;;###autoload | |
1114 | (defun browse-url-lynx-xterm (url &optional new-window) | |
1115 | ;; new-window ignored | |
1116 | "Ask the Lynx WWW browser to load URL. | |
1117 | Default to the URL around or before point. A new Lynx process is run | |
1118 | in an Xterm window using the Xterm program named by `browse-url-xterm-program' | |
1119 | with possible additional arguments `browse-url-xterm-args'." | |
1120 | (interactive (browse-url-interactive-arg "Lynx URL: ")) | |
1121 | (apply #'start-process `(,(concat "lynx" url) nil ,browse-url-xterm-program | |
01f97560 DL |
1122 | ,@browse-url-xterm-args "-e" "lynx" |
1123 | ,url))) | |
8749abea GM |
1124 | |
1125 | ;; --- Lynx in an Emacs "term" window --- | |
1126 | ||
1127 | ;;;###autoload | |
1128 | (defun browse-url-lynx-emacs (url &optional new-buffer) | |
1129 | "Ask the Lynx WWW browser to load URL. | |
1130 | Default to the URL around or before point. With a prefix argument, run | |
1131 | a new Lynx process in a new buffer. | |
1132 | ||
408d5219 | 1133 | When called interactively, if variable `browse-url-new-window-flag' is |
8749abea GM |
1134 | non-nil, load the document in a new lynx in a new term window, |
1135 | otherwise use any existing one. A non-nil interactive prefix argument | |
408d5219 | 1136 | reverses the effect of `browse-url-new-window-flag'. |
8749abea GM |
1137 | |
1138 | When called non-interactively, optional second argument NEW-WINDOW is | |
408d5219 | 1139 | used instead of `browse-url-new-window-flag'." |
8749abea GM |
1140 | (interactive (browse-url-interactive-arg "Lynx URL: ")) |
1141 | (let* ((system-uses-terminfo t) ; Lynx uses terminfo | |
1142 | ;; (term-term-name "vt100") ; ?? | |
1143 | (buf (get-buffer "*lynx*")) | |
1144 | (proc (and buf (get-buffer-process buf))) | |
1145 | (n browse-url-lynx-input-attempts)) | |
01f97560 | 1146 | (if (and (browse-url-maybe-new-window new-buffer) buf) |
8749abea GM |
1147 | ;; Rename away the OLD buffer. This isn't very polite, but |
1148 | ;; term insists on working in a buffer named *lynx* and would | |
1149 | ;; choke on *lynx*<1> | |
1150 | (progn (set-buffer buf) | |
1151 | (rename-uniquely))) | |
01f97560 | 1152 | (if (or (browse-url-maybe-new-window new-buffer) |
8749abea GM |
1153 | (not buf) |
1154 | (not proc) | |
1155 | (not (memq (process-status proc) '(run stop)))) | |
1156 | ;; start a new lynx | |
1157 | (progn | |
1158 | (setq buf | |
1159 | (apply #'make-term | |
01f97560 DL |
1160 | `("lynx" "lynx" nil ,@browse-url-lynx-emacs-args |
1161 | ,url))) | |
8749abea GM |
1162 | (switch-to-buffer buf) |
1163 | (term-char-mode) | |
1164 | (set-process-sentinel | |
1165 | (get-buffer-process buf) | |
1166 | ;; Don't leave around a dead one (especially because of its | |
1167 | ;; munged keymap.) | |
1168 | (lambda (process event) | |
1169 | (if (not (memq (process-status process) '(run stop))) | |
1170 | (let ((buf (process-buffer process))) | |
1171 | (if buf (kill-buffer buf))))))) | |
1172 | ;; send the url to lynx in the old buffer | |
1173 | (let ((win (get-buffer-window buf t))) | |
1174 | (if win | |
1175 | (select-window win) | |
1176 | (switch-to-buffer buf))) | |
1177 | (if (eq (following-char) ?_) | |
1178 | (cond ((eq browse-url-lynx-input-field 'warn) | |
e8af40ee | 1179 | (error "Please move out of the input field first")) |
8749abea GM |
1180 | ((eq browse-url-lynx-input-field 'avoid) |
1181 | (while (and (eq (following-char) ?_) (> n 0)) | |
1182 | (term-send-down) ; down arrow | |
1183 | (sit-for browse-url-lynx-input-delay)) | |
1184 | (if (eq (following-char) ?_) | |
e8af40ee | 1185 | (error "Cannot move out of the input field, sorry"))))) |
8749abea GM |
1186 | (term-send-string proc (concat "g" ; goto |
1187 | "\C-u" ; kill default url | |
1188 | url | |
1189 | "\r"))))) | |
1190 | ||
1191 | ;; --- MMM --- | |
1192 | ||
1193 | ;;;###autoload | |
1194 | (defun browse-url-mmm (url &optional new-window) | |
1195 | "Ask the MMM WWW browser to load URL. | |
1196 | Default to the URL around or before point." | |
1197 | (interactive (browse-url-interactive-arg "MMM URL: ")) | |
1198 | (message "Sending URL to MMM...") | |
1199 | (save-excursion | |
1200 | (set-buffer (get-buffer-create " *Shell Command Output*")) | |
1201 | (erase-buffer) | |
1202 | ;; mmm_remote just SEGVs if the file isn't there... | |
1203 | (if (or (file-exists-p (expand-file-name "~/.mmm_remote")) | |
1204 | ;; location in v 0.4: | |
1205 | (file-exists-p (expand-file-name "~/.mmm/remote"))) | |
1206 | (call-process "mmm_remote" nil 0 nil url) | |
1207 | (call-process "mmm" nil 0 nil "-external" url)) | |
1208 | (message "Sending URL to MMM... done"))) | |
1209 | ||
1210 | ;; --- mailto --- | |
1211 | ||
1212 | ;;;###autoload | |
1213 | (defun browse-url-mail (url &optional new-window) | |
1214 | "Open a new mail message buffer within Emacs. | |
1215 | Default to using the mailto: URL around or before point as the | |
1216 | recipient's address. Supplying a non-nil interactive prefix argument | |
1217 | will cause the mail to be composed in another window rather than the | |
1218 | current one. | |
1219 | ||
408d5219 | 1220 | When called interactively, if variable `browse-url-new-window-flag' is |
8749abea GM |
1221 | non-nil use `compose-mail-other-window', otherwise `compose-mail'. A |
1222 | non-nil interactive prefix argument reverses the effect of | |
408d5219 | 1223 | `browse-url-new-window-flag'. |
8749abea GM |
1224 | |
1225 | When called non-interactively, optional second argument NEW-WINDOW is | |
408d5219 | 1226 | used instead of `browse-url-new-window-flag'." |
8749abea GM |
1227 | (interactive (browse-url-interactive-arg "Mailto URL: ")) |
1228 | (save-excursion | |
1229 | (let ((to (if (string-match "^mailto:" url) | |
1230 | (substring url 7) | |
1231 | url))) | |
01f97560 | 1232 | (if (browse-url-maybe-new-window new-window) |
8749abea GM |
1233 | (compose-mail-other-window to nil nil nil |
1234 | (list 'insert-buffer (current-buffer))) | |
1235 | (compose-mail to nil nil nil nil | |
1236 | (list 'insert-buffer (current-buffer))))))) | |
1237 | ||
1238 | ;; --- Random browser --- | |
1239 | ||
1240 | ;;;###autoload | |
1241 | (defun browse-url-generic (url &optional new-window) | |
1242 | ;; new-window ignored | |
1243 | "Ask the WWW browser defined by `browse-url-generic-program' to load URL. | |
1244 | Default to the URL around or before point. A fresh copy of the | |
1245 | browser is started up in a new process with possible additional arguments | |
1246 | `browse-url-generic-args'. This is appropriate for browsers which | |
1247 | don't offer a form of remote control." | |
1248 | (interactive (browse-url-interactive-arg "URL: ")) | |
1249 | (if (not browse-url-generic-program) | |
1250 | (error "No browser defined (`browse-url-generic-program')")) | |
1251 | (apply 'start-process (concat browse-url-generic-program url) nil | |
1252 | browse-url-generic-program | |
1253 | (append browse-url-generic-args (list url)))) | |
1254 | ||
af06f459 GM |
1255 | ;;;###autoload |
1256 | (defun browse-url-kde (url &optional new-window) | |
1257 | "Ask the KDE WWW browser to load URL. | |
1258 | Default to the URL around or before point." | |
1259 | (interactive (browse-url-interactive-arg "KDE URL: ")) | |
1260 | (message "Sending URL to KDE...") | |
1261 | (apply #'start-process `(,(concat "KDE" url) nil ,browse-url-kde-program | |
1262 | ,@browse-url-kde-args ,url))) | |
1263 | ||
8749abea GM |
1264 | (provide 'browse-url) |
1265 | ||
1266 | ;;; browse-url.el ends here |