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