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