]> code.delx.au - gnu-emacs/blob - lisp/net/browse-url.el
(tramp-uudecode): Mention `uudecode -o /dev/stdout'.
[gnu-emacs] / lisp / net / browse-url.el
1 ;;; browse-url.el --- pass a URL to a WWW browser
2
3 ;; Copyright (C) 1995, 96, 97, 98, 99, 2000, 2001, 2004
4 ;; 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., 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
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-galeon Galeon Don't know
42 ;; browse-url-epiphany Epiphany Don't know
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
54 ;; browse-url-default-macosx-browser Mac OS X browser
55 ;; browse-url-gnome-moz GNOME interface to Mozilla
56 ;; browse-url-kde KDE konqueror (kfm)
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
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
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
97 ;; <URL:ftp://ftp.enst.fr/pub/mbone/mMosaic/>,
98 ;; <URL:http://www.enst.fr/~dauphin/mMosaic/> (with development
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
168 ;; Browse URLs in mail messages under RMAIL by clicking mouse-2:
169 ;; (add-hook 'rmail-mode-hook (lambda () ; rmail-mode startup
170 ;; (define-key rmail-mode-map [mouse-2] 'browse-url-at-mouse)))
171 ;; Alternatively, add `goto-address' to `rmail-show-message-hook'.
172
173 ;; Gnus provides a standard feature to activate URLs in article
174 ;; buffers for invocation of browse-url.
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)
221 (require 'executable)
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-"
227 :link '(emacs-commentary-link "browse-url")
228 :group 'hypermedia)
229
230 ;;;###autoload
231 (defcustom browse-url-browser-function
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))
237 "*Function to display the current buffer in a WWW browser.
238 This is used by the `browse-url-at-point', `browse-url-at-mouse', and
239 `browse-url-of-file' commands.
240
241 If the value is not a function it should be a list of pairs
242 \(REGEXP . FUNCTION). In this case the function called will be the one
243 associated with the first REGEXP which matches the current URL. The
244 function is passed the URL and any other args of `browse-url'. The last
245 regexp should probably be \".\" to specify a default browser."
246 :type '(choice
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)
250 (function-item :tag "Mozilla" :value browse-url-mozilla)
251 (function-item :tag "Galeon" :value browse-url-galeon)
252 (function-item :tag "Epiphany" :value browse-url-epiphany)
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)
263 (function-item :tag "KDE" :value browse-url-kde)
264 (function-item :tag "Specified by `Browse Url Generic Program'"
265 :value browse-url-generic)
266 (function-item :tag "Default Windows browser"
267 :value browse-url-default-windows-browser)
268 (function-item :tag "Default Mac OS X browser"
269 :value browse-url-default-macosx-browser)
270 (function-item :tag "GNOME invoking Mozilla"
271 :value browse-url-gnome-moz)
272 (function-item :tag "Default browser"
273 :value browse-url-default-browser)
274 (function :tag "Your own function")
275 (alist :tag "Regexp/function association list"
276 :key-type regexp :value-type function))
277 :version "21.1"
278 :group 'browse-url)
279
280 (defcustom browse-url-netscape-program "netscape"
281 ;; Info about netscape-remote from Karl Berry.
282 "*The name by which to invoke Netscape.
283
284 The free program `netscape-remote' from
285 <URL:http://home.netscape.com/newsref/std/remote.c> is said to start
286 up very much quicker than `netscape'. Reported to compile on a GNU
287 system, 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
293 "*A list of strings to pass to Netscape as arguments."
294 :type '(repeat (string :tag "Argument"))
295 :group 'browse-url)
296
297 (defcustom browse-url-netscape-startup-arguments browse-url-netscape-arguments
298 "*A list of strings to pass to Netscape when it starts up.
299 Defaults 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
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"
310 "*The name by which to invoke Mozilla."
311 :type 'string
312 :group 'browse-url)
313
314 (defcustom browse-url-mozilla-arguments nil
315 "*A list of strings to pass to Mozilla as arguments."
316 :type '(repeat (string :tag "Argument"))
317 :group 'browse-url)
318
319 (defcustom browse-url-mozilla-startup-arguments browse-url-mozilla-arguments
320 "*A list of strings to pass to Mozilla when it starts up.
321 Defaults 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
326 (defcustom browse-url-galeon-program "galeon"
327 "*The name by which to invoke Galeon."
328 :type 'string
329 :group 'browse-url)
330
331 (defcustom browse-url-galeon-arguments nil
332 "*A list of strings to pass to Galeon as arguments."
333 :type '(repeat (string :tag "Argument"))
334 :group 'browse-url)
335
336 (defcustom browse-url-galeon-startup-arguments browse-url-galeon-arguments
337 "*A list of strings to pass to Galeon when it starts up.
338 Defaults 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
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.
355 Defaults 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
360 (defcustom browse-url-mozilla-new-window-is-tab nil
361 "*Whether to open up new windows in a tab or a new window.
362 If 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
367 (defcustom browse-url-galeon-new-window-is-tab nil
368 "*Whether to open up new windows in a tab or a new window.
369 If 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
374 (defcustom browse-url-epiphany-new-window-is-tab nil
375 "*Whether to open up new windows in a tab or a new window.
376 If 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
381 (defcustom browse-url-new-window-flag nil
382 "*If non-nil, always open a new browser window with appropriate browsers.
383 Passing an interactive argument to \\[browse-url], or specific browser
384 commands reverses the effect of this variable. Requires Netscape version
385 1.1N or later or XMosaic version 2.5 or later if using those browsers."
386 :type 'boolean
387 :group 'browse-url)
388
389 (defcustom browse-url-mosaic-program "xmosaic"
390 "*The name by which to invoke Mosaic (or mMosaic)."
391 :type 'string
392 :version "20.3"
393 :group 'browse-url)
394
395 (defcustom browse-url-mosaic-arguments nil
396 "*A list of strings to pass to Mosaic as arguments."
397 :type '(repeat (string :tag "Argument"))
398 :group 'browse-url)
399
400 (defcustom browse-url-mosaic-pidfile "~/.mosaicpid"
401 "*The name of the pidfile created by Mosaic."
402 :type 'string
403 :group 'browse-url)
404
405 (defcustom browse-url-filename-alist
406 (\` ; Backquote syntax won't work.
407 (("^/\\(ftp@\\|anonymous@\\)?\\([^:]+\\):/*" . "ftp://\\2/")
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/")
412 (,@ (if (memq system-type '(windows-nt ms-dos cygwin))
413 '(("^\\([a-zA-Z]:\\)[\\/]" . "file:\\1/")
414 ("^[\\/][\\/]+" . "file://"))))
415 ("^/+" . "file:/")))
416 "*An alist of (REGEXP . STRING) pairs used by `browse-url-of-file'.
417 Any substring of a filename matching one of the REGEXPs is replaced by
418 the corresponding STRING using `replace-match', not treating STRING
419 literally. All pairs are applied in the order given. The default
420 value converts ange-ftp/EFS-style file names into ftp URLs and prepends
421 `file:' to any file name beginning with `/'.
422
423 For example, adding to the default a specific translation of an ange-ftp
424 address 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
439 (defcustom browse-url-save-file nil
440 "*If non-nil, save the buffer before displaying its file.
441 Used by the `browse-url-of-file' command."
442 :type 'boolean
443 :group 'browse-url)
444
445 (defcustom browse-url-of-file-hook nil
446 "*Run after `browse-url-of-file' has asked a browser to load a file.
447
448 Set this to `browse-url-netscape-reload' to force Netscape to load the
449 file rather than displaying a cached copy."
450 :type 'hook
451 :options '(browse-url-netscape-reload)
452 :group 'browse-url)
453
454 (defcustom browse-url-CCI-port 3003
455 "*Port to access XMosaic via CCI.
456 This can be any number between 1024 and 65535 but must correspond to
457 the 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.
463 This should be the host name of the machine running XMosaic with CCI
464 enabled. 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"
472 "*The name of the terminal emulator used by `browse-url-lynx-xterm'.
473 This 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'.
479 These might set its size, for instance."
480 :type '(repeat (string :tag "Argument"))
481 :group 'browse-url)
482
483 (defcustom browse-url-lynx-emacs-args (and (not window-system)
484 '("-show_cursor"))
485 "*A list of strings defining options for Lynx in an Emacs buffer.
486
487 The default is none in a window system, otherwise `-show_cursor' to
488 indicate the position of the current link in the absence of
489 highlighting, 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"
495 "*The name of the `gnudoit' program used by `browse-url-w3-gnudoit'."
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'.
501 These might set the port, for instance."
502 :type '(repeat (string :tag "Argument"))
503 :group 'browse-url)
504
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
516 "*The name of a directory for browse-url's temporary files.
517 Such files are generated by functions like `browse-url-of-region'.
518 You might want to set this to somewhere with restricted read permissions
519 for privacy's sake."
520 :type 'string
521 :group 'browse-url)
522
523 (defcustom browse-url-netscape-version
524 3
525 "*The version of Netscape you are using.
526 This affects how URL reloading is done; the mechanism changed
527 incompatibly 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.
533 What to do when sending a new URL to an existing Lynx buffer in Emacs
534 if the Lynx cursor is on an input field (in which case the `g' command
535 would be entered as data). Such fields are recognized by the
536 underlines ____. Allowed values: nil: disregard it, 'warn: warn the
537 user and don't emit the URL, 'avoid: try to avoid the field by moving
538 down (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
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)
549
550 (defcustom browse-url-lynx-input-delay 0.2
551 "*How many seconds to wait for lynx between moves down from an input field."
552 :type 'number
553 :group 'browse-url)
554
555 (defcustom browse-url-kde-program "kfmclient"
556 "*The name by which to invoke the KDE web browser."
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
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.
580 If `transient-mark-mode' is non-nil and the mark is active,
581 it defaults to the current region, else to the URL at or before
582 point. If invoked with a mouse button, it moves point to the
583 position clicked before acting.
584
585 This function returns a list (URL NEW-WINDOW-FLAG)
586 for use in `interactive'."
587 (let ((event (elt (this-command-keys) 0)))
588 (and (listp event) (mouse-set-point event)))
589 (list (read-string prompt (or (and transient-mark-mode mark-active
590 ;; rfc2396 Appendix E.
591 (replace-regexp-in-string
592 "[\t\r\f\n ]+" ""
593 (buffer-substring-no-properties
594 (region-beginning) (region-end))))
595 (browse-url-url-at-point)))
596 (not (eq (null browse-url-new-window-flag)
597 (null current-prefix-arg)))))
598
599 ;; called-interactive-p needs to be called at a function's top-level, hence
600 ;; this macro. We use that rather than interactive-p because
601 ;; use in a keyboard macro should not change this behavior.
602 (defmacro browse-url-maybe-new-window (arg)
603 `(if (or noninteractive (not (called-interactively-p)))
604 ,arg
605 browse-url-new-window-flag))
606
607 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
608 ;; Browse current buffer
609
610 ;;;###autoload
611 (defun browse-url-of-file (&optional file)
612 "Ask a WWW browser to display FILE.
613 Display the current buffer's file if FILE is nil or if called
614 interactively. Turn the filename into a URL with function
615 `browse-url-file-url'. Pass the URL to a browser using the
616 `browse-url' function then run `browse-url-of-file-hook'."
617 (interactive)
618 (or file
619 (setq file (buffer-file-name))
620 (error "Current buffer has no file"))
621 (let ((buf (get-file-buffer file)))
622 (if buf
623 (save-excursion
624 (set-buffer buf)
625 (cond ((not (buffer-modified-p)))
626 (browse-url-save-file (save-buffer))
627 (t (message "%s modified since last save" file))))))
628 (browse-url (browse-url-file-url file))
629 (run-hooks 'browse-url-of-file-hook))
630
631 (defun browse-url-file-url (file)
632 "Return the URL corresponding to FILE.
633 Use variable `browse-url-filename-alist' to map filenames to URLs."
634 ;; URL-encode special chars, do % first
635 (let ((s 0))
636 (while (setq s (string-match "%" file s))
637 (setq file (replace-match "%25" t t file)
638 s (1+ s))))
639 (while (string-match "[*\"()',=;? ]" file)
640 (let ((enc (format "%%%x" (aref file (match-beginning 0)))))
641 (setq file (replace-match enc t t file))))
642 (dolist (map browse-url-filename-alist)
643 (when (and map (string-match (car map) file))
644 (setq file (replace-match (cdr map) t nil file))))
645 file)
646
647 ;;;###autoload
648 (defun browse-url-of-buffer (&optional buffer)
649 "Ask a WWW browser to display BUFFER.
650 Display the current buffer if BUFFER is nil. Display only the
651 currently visible part of BUFFER (from a temporary file) if buffer is
652 narrowed."
653 (interactive)
654 (save-excursion
655 (and buffer (set-buffer buffer))
656 (let ((file-name
657 ;; Ignore real name if restricted
658 (and (= (- (point-max) (point-min)) (buffer-size))
659 (or buffer-file-name
660 (and (boundp 'dired-directory) dired-directory)))))
661 (or file-name
662 (progn
663 (or browse-url-temp-file-name
664 (setq browse-url-temp-file-name
665 (convert-standard-filename
666 (make-temp-file
667 (expand-file-name "burl" browse-url-temp-dir)))))
668 (setq file-name browse-url-temp-file-name)
669 (write-region (point-min) (point-max) file-name nil 'no-message)))
670 (browse-url-of-file file-name))))
671
672 (defun browse-url-delete-temp-file (&optional temp-file-name)
673 ;; Delete browse-url-temp-file-name from the file system
674 ;; If optional arg TEMP-FILE-NAME is non-nil, delete it instead
675 (let ((file-name (or temp-file-name browse-url-temp-file-name)))
676 (if (and file-name (file-exists-p file-name))
677 (delete-file file-name))))
678
679 (add-hook 'kill-buffer-hook 'browse-url-delete-temp-file)
680
681 ;;;###autoload
682 (defun browse-url-of-dired-file ()
683 "In Dired, ask a WWW browser to display the file named on this line."
684 (interactive)
685 (browse-url-of-file (dired-get-filename)))
686
687 ;;;###autoload
688 (defun browse-url-of-region (min max)
689 "Ask a WWW browser to display the current region."
690 (interactive "r")
691 (save-excursion
692 (save-restriction
693 (narrow-to-region min max)
694 (browse-url-of-buffer))))
695
696 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
697 ;; Browser-independent commands
698
699 ;; A generic command to call the current browse-url-browser-function
700
701 ;;;###autoload
702 (defun browse-url (url &rest args)
703 "Ask a WWW browser to load URL.
704 Prompts for a URL, defaulting to the URL at or before point. Variable
705 `browse-url-browser-function' says which browser to use."
706 (interactive (browse-url-interactive-arg "URL: "))
707 (unless (interactive-p)
708 (setq args (or args (list browse-url-new-window-flag))))
709 (if (functionp browse-url-browser-function)
710 (apply browse-url-browser-function url args)
711 ;; The `function' can be an alist; look down it for first match
712 ;; and apply the function (which might be a lambda).
713 (catch 'done
714 (dolist (bf browse-url-browser-function)
715 (when (string-match (car bf) url)
716 (apply (cdr bf) url args)
717 (throw 'done t)))
718 (error "No browse-url-browser-function matching URL %s"
719 url))))
720
721 ;;;###autoload
722 (defun browse-url-at-point (&optional arg)
723 "Ask a WWW browser to load the URL at or before point.
724 Doesn't let you edit the URL like `browse-url'. Variable
725 `browse-url-browser-function' says which browser to use."
726 (interactive "P")
727 (let ((url (browse-url-url-at-point)))
728 (if url
729 (browse-url url (if arg
730 (not browse-url-new-window-flag)
731 browse-url-new-window-flag))
732 (error "No URL found"))))
733
734 ;;;###autoload
735 (defun browse-url-at-mouse (event)
736 "Ask a WWW browser to load a URL clicked with the mouse.
737 The URL is the one around or before the position of the mouse click
738 but point is not changed. Doesn't let you edit the URL like
739 `browse-url'. Variable `browse-url-browser-function' says which browser
740 to use."
741 (interactive "e")
742 (save-excursion
743 (mouse-set-point event)
744 ;; This handles browse-url-new-window-flag properly
745 ;; when it gets no arg.
746 (browse-url-at-point)))
747
748 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
749 ;; Browser-specific commands
750
751 ;; --- Default MS-Windows browser ---
752
753 (defun browse-url-default-windows-browser (url &optional new-window)
754 (interactive (browse-url-interactive-arg "URL: "))
755 (if (eq system-type 'ms-dos)
756 (if dos-windows-version
757 (shell-command (concat "start " (shell-quote-argument url)))
758 (error "Browsing URLs is not supported on this system"))
759 (w32-shell-execute "open" url)))
760
761 (defun browse-url-default-macosx-browser (url &optional new-window)
762 (interactive (browse-url-interactive-arg "URL: "))
763 (start-process (concat "open " url) nil "open" url))
764
765 ;; --- Netscape ---
766
767 (defun browse-url-process-environment ()
768 "Set DISPLAY in the environment to the X display the browser will use.
769 This is either the value of variable `browse-url-browser-display' if
770 non-nil, or the same display as Emacs if different from the current
771 environment, otherwise just use the current environment."
772 (let ((display (or browse-url-browser-display (browse-url-emacs-display))))
773 (if display
774 (cons (concat "DISPLAY=" display) process-environment)
775 process-environment)))
776
777 (defun browse-url-emacs-display ()
778 "Return the X display Emacs is running on.
779 This is nil if the display is the same as the DISPLAY environment variable.
780
781 Actually Emacs could be using several displays; this just returns the
782 one showing the selected frame."
783 (let ((display (cdr-safe (assq 'display (frame-parameters)))))
784 (and (not (equal display (getenv "DISPLAY")))
785 display)))
786
787 ;;;###autoload
788 (defun browse-url-default-browser (url &rest args)
789 "Find a suitable browser and ask it to load URL.
790 Default to the URL around or before point.
791
792 When called interactively, if variable `browse-url-new-window-flag' is
793 non-nil, load the document in a new window, if possible, otherwise use
794 a random existing one. A non-nil interactive prefix argument reverses
795 the effect of `browse-url-new-window-flag'.
796
797 When called non-interactively, optional second argument NEW-WINDOW is
798 used instead of `browse-url-new-window-flag'.
799
800 The order attempted is gnome-moz-remote, Mozilla, Galeon, Netscape,
801 Mosaic, IXI Mosaic, Lynx in an xterm, MMM, Konqueror, and then W3."
802 (apply
803 (cond
804 ((executable-find browse-url-gnome-moz-program) 'browse-url-gnome-moz)
805 ((executable-find browse-url-mozilla-program) 'browse-url-mozilla)
806 ((executable-find browse-url-galeon-program) 'browse-url-galeon)
807 ((executable-find browse-url-kde-program) 'browse-url-kde)
808 ((executable-find browse-url-netscape-program) 'browse-url-netscape)
809 ((executable-find browse-url-mosaic-program) 'browse-url-mosaic)
810 ((executable-find "tellw3b") 'browse-url-iximosaic)
811 ((executable-find browse-url-xterm-program) 'browse-url-lynx-xterm)
812 ((executable-find "mmm") 'browse-url-mmm)
813 (t 'browse-url-w3))
814 url args))
815
816 ;;;###autoload
817 (defun browse-url-netscape (url &optional new-window)
818 "Ask the Netscape WWW browser to load URL.
819 Default to the URL around or before point. The strings in variable
820 `browse-url-netscape-arguments' are also passed to Netscape.
821
822 When called interactively, if variable `browse-url-new-window-flag' is
823 non-nil, load the document in a new Netscape window, otherwise use a
824 random existing one. A non-nil interactive prefix argument reverses
825 the effect of `browse-url-new-window-flag'.
826
827 When called non-interactively, optional second argument NEW-WINDOW is
828 used instead of `browse-url-new-window-flag'."
829 (interactive (browse-url-interactive-arg "URL: "))
830 ;; URL encode any `confusing' characters in the URL. This needs to
831 ;; include at least commas; presumably also close parens and dollars.
832 (while (string-match "[,)$]" url)
833 (setq url (replace-match
834 (format "%%%x" (string-to-char (match-string 0 url))) t t url)))
835 (let* ((process-environment (browse-url-process-environment))
836 (process (apply 'start-process
837 (concat "netscape " url) nil
838 browse-url-netscape-program
839 (append
840 browse-url-netscape-arguments
841 (if (eq window-system 'w32)
842 (list url)
843 (append
844 (if new-window '("-noraise"))
845 (list "-remote"
846 (concat "openURL(" url
847 (if (browse-url-maybe-new-window
848 new-window)
849 ",new-window")
850 ")"))))))))
851 (set-process-sentinel process
852 `(lambda (process change)
853 (browse-url-netscape-sentinel process ,url)))))
854
855 (defun browse-url-netscape-sentinel (process url)
856 "Handle a change to the process communicating with Netscape."
857 (or (eq (process-exit-status process) 0)
858 (let* ((process-environment (browse-url-process-environment)))
859 ;; Netscape not running - start it
860 (message "Starting %s..." browse-url-netscape-program)
861 (apply 'start-process (concat "netscape" url) nil
862 browse-url-netscape-program
863 (append browse-url-netscape-startup-arguments (list url))))))
864
865 (defun browse-url-netscape-reload ()
866 "Ask Netscape to reload its current document.
867 How depends on `browse-url-netscape-version'."
868 (interactive)
869 ;; Backwards incompatibility reported by
870 ;; <peter.kruse@psychologie.uni-regensburg.de>.
871 (browse-url-netscape-send (if (>= browse-url-netscape-version 4)
872 "xfeDoCommand(reload)"
873 "reload")))
874
875 (defun browse-url-netscape-send (command)
876 "Send a remote control command to Netscape."
877 (let* ((process-environment (browse-url-process-environment)))
878 (apply 'start-process "netscape" nil
879 browse-url-netscape-program
880 (append browse-url-netscape-arguments
881 (list "-remote" command)))))
882
883 ;;;###autoload
884 (defun browse-url-mozilla (url &optional new-window)
885 "Ask the Mozilla WWW browser to load URL.
886 Default to the URL around or before point. The strings in variable
887 `browse-url-mozilla-arguments' are also passed to Mozilla.
888
889 When called interactively, if variable `browse-url-new-window-flag' is
890 non-nil, load the document in a new Mozilla window, otherwise use a
891 random existing one. A non-nil interactive prefix argument reverses
892 the effect of `browse-url-new-window-flag'.
893
894 If `browse-url-mozilla-new-window-is-tab' is non-nil, then whenever a
895 document would otherwise be loaded in a new window, it is loaded in a
896 new tab in an existing window instead.
897
898 When called non-interactively, optional second argument NEW-WINDOW is
899 used instead of `browse-url-new-window-flag'."
900 (interactive (browse-url-interactive-arg "URL: "))
901 ;; URL encode any `confusing' characters in the URL. This needs to
902 ;; include at least commas; presumably also close parens and dollars.
903 (while (string-match "[,)$]" url)
904 (setq url (replace-match
905 (format "%%%x" (string-to-char (match-string 0 url))) t t url)))
906 (let* ((process-environment (browse-url-process-environment))
907 (process
908 (apply 'start-process
909 (concat "mozilla " url) nil
910 browse-url-mozilla-program
911 (append
912 browse-url-mozilla-arguments
913 (list "-remote"
914 (concat "openURL("
915 url
916 (if (browse-url-maybe-new-window
917 new-window)
918 (if browse-url-mozilla-new-window-is-tab
919 ",new-tab"
920 ",new-window"))
921 ")"))))))
922 (set-process-sentinel process
923 `(lambda (process change)
924 (browse-url-mozilla-sentinel process ,url)))))
925
926 (defun browse-url-mozilla-sentinel (process url)
927 "Handle a change to the process communicating with Mozilla."
928 (or (eq (process-exit-status process) 0)
929 (let* ((process-environment (browse-url-process-environment)))
930 ;; Mozilla is not running - start it
931 (message "Starting %s..." browse-url-mozilla-program)
932 (apply 'start-process (concat "mozilla " url) nil
933 browse-url-mozilla-program
934 (append browse-url-mozilla-startup-arguments (list url))))))
935
936 ;;;###autoload
937 (defun browse-url-galeon (url &optional new-window)
938 "Ask the Galeon WWW browser to load URL.
939 Default to the URL around or before point. The strings in variable
940 `browse-url-galeon-arguments' are also passed to Galeon.
941
942 When called interactively, if variable `browse-url-new-window-flag' is
943 non-nil, load the document in a new Galeon window, otherwise use a
944 random existing one. A non-nil interactive prefix argument reverses
945 the effect of `browse-url-new-window-flag'.
946
947 If `browse-url-galeon-new-window-is-tab' is non-nil, then whenever a
948 document would otherwise be loaded in a new window, it is loaded in a
949 new tab in an existing window instead.
950
951 When called non-interactively, optional second argument NEW-WINDOW is
952 used instead of `browse-url-new-window-flag'."
953 (interactive (browse-url-interactive-arg "URL: "))
954 ;; URL encode any `confusing' characters in the URL. This needs to
955 ;; include at least commas; presumably also close parens and dollars.
956 (while (string-match "[,)$]" url)
957 (setq url (replace-match
958 (format "%%%x" (string-to-char (match-string 0 url))) t t url)))
959 (let* ((process-environment (browse-url-process-environment))
960 (process (apply 'start-process
961 (concat "galeon " url)
962 nil
963 browse-url-galeon-program
964 (append
965 browse-url-galeon-arguments
966 (if (browse-url-maybe-new-window new-window)
967 (if browse-url-galeon-new-window-is-tab
968 '("--new-tab")
969 '("--new-window" "--noraise"))
970 '("--existing"))
971 (list url)))))
972 (set-process-sentinel process
973 `(lambda (process change)
974 (browse-url-galeon-sentinel process ,url)))))
975
976 (defun browse-url-galeon-sentinel (process url)
977 "Handle a change to the process communicating with Galeon."
978 (or (eq (process-exit-status process) 0)
979 (let* ((process-environment (browse-url-process-environment)))
980 ;; Galeon is not running - start it
981 (message "Starting %s..." browse-url-galeon-program)
982 (apply 'start-process (concat "galeon " url) nil
983 browse-url-galeon-program
984 (append browse-url-galeon-startup-arguments (list url))))))
985
986 (defun browse-url-epiphany (url &optional new-window)
987 "Ask the Epiphany WWW browser to load URL.
988 Default to the URL around or before point. The strings in variable
989 `browse-url-galeon-arguments' are also passed to Epiphany.
990
991 When called interactively, if variable `browse-url-new-window-flag' is
992 non-nil, load the document in a new Epiphany window, otherwise use a
993 random existing one. A non-nil interactive prefix argument reverses
994 the effect of `browse-url-new-window-flag'.
995
996 If `browse-url-epiphany-new-window-is-tab' is non-nil, then whenever a
997 document would otherwise be loaded in a new window, it is loaded in a
998 new tab in an existing window instead.
999
1000 When called non-interactively, optional second argument NEW-WINDOW is
1001 used instead of `browse-url-new-window-flag'."
1002 (interactive (browse-url-interactive-arg "URL: "))
1003 ;; URL encode any `confusing' characters in the URL. This needs to
1004 ;; include at least commas; presumably also close parens and dollars.
1005 (while (string-match "[,)$]" url)
1006 (setq url (replace-match
1007 (format "%%%x" (string-to-char (match-string 0 url))) t t url)))
1008 (let* ((process-environment (browse-url-process-environment))
1009 (process (apply 'start-process
1010 (concat "epiphany " url)
1011 nil
1012 browse-url-epiphany-program
1013 (append
1014 browse-url-epiphany-arguments
1015 (if (browse-url-maybe-new-window new-window)
1016 (if browse-url-epiphany-new-window-is-tab
1017 '("--new-tab")
1018 '("--new-window" "--noraise"))
1019 '("--existing"))
1020 (list url)))))
1021 (set-process-sentinel process
1022 `(lambda (process change)
1023 (browse-url-epiphany-sentinel process ,url)))))
1024
1025 (defun browse-url-epiphany-sentinel (process url)
1026 "Handle a change to the process communicating with Epiphany."
1027 (or (eq (process-exit-status process) 0)
1028 (let* ((process-environment (browse-url-process-environment)))
1029 ;; Epiphany is not running - start it
1030 (message "Starting %s..." browse-url-epiphany-program)
1031 (apply 'start-process (concat "epiphany " url) nil
1032 browse-url-epiphany-program
1033 (append browse-url-epiphany-startup-arguments (list url))))))
1034
1035 ;; GNOME means of invoking either Mozilla or Netrape.
1036 (defvar browse-url-gnome-moz-program "gnome-moz-remote")
1037 (defcustom browse-url-gnome-moz-arguments '()
1038 "*A list of strings passed to the GNOME mozilla viewer as arguments."
1039 :version "21.1"
1040 :type '(repeat (string :tag "Argument"))
1041 :group 'browse-url)
1042
1043 ;;;###autoload
1044 (defun browse-url-gnome-moz (url &optional new-window)
1045 "Ask Mozilla/Netscape to load URL via the GNOME program `gnome-moz-remote'.
1046 Default to the URL around or before point. The strings in variable
1047 `browse-url-gnome-moz-arguments' are also passed.
1048
1049 When called interactively, if variable `browse-url-new-window-flag' is
1050 non-nil, load the document in a new browser window, otherwise use an
1051 existing one. A non-nil interactive prefix argument reverses the
1052 effect of `browse-url-new-window-flag'.
1053
1054 When called non-interactively, optional second argument NEW-WINDOW is
1055 used instead of `browse-url-new-window-flag'."
1056 (interactive (browse-url-interactive-arg "URL: "))
1057 (apply 'start-process (concat "gnome-moz-remote " url)
1058 nil
1059 browse-url-gnome-moz-program
1060 (append
1061 browse-url-gnome-moz-arguments
1062 (if (browse-url-maybe-new-window new-window)
1063 '("--newwin"))
1064 (list "--raise" url))))
1065
1066 ;; --- Mosaic ---
1067
1068 ;;;###autoload
1069 (defun browse-url-mosaic (url &optional new-window)
1070 "Ask the XMosaic WWW browser to load URL.
1071
1072 Default to the URL around or before point. The strings in variable
1073 `browse-url-mosaic-arguments' are also passed to Mosaic and the
1074 program is invoked according to the variable
1075 `browse-url-mosaic-program'.
1076
1077 When called interactively, if variable `browse-url-new-window-flag' is
1078 non-nil, load the document in a new Mosaic window, otherwise use a
1079 random existing one. A non-nil interactive prefix argument reverses
1080 the effect of `browse-url-new-window-flag'.
1081
1082 When called non-interactively, optional second argument NEW-WINDOW is
1083 used instead of `browse-url-new-window-flag'."
1084 (interactive (browse-url-interactive-arg "Mosaic URL: "))
1085 (let ((pidfile (expand-file-name browse-url-mosaic-pidfile))
1086 pid)
1087 (if (file-readable-p pidfile)
1088 (save-excursion
1089 (find-file pidfile)
1090 (goto-char (point-min))
1091 (setq pid (read (current-buffer)))
1092 (kill-buffer nil)))
1093 (if (and pid (zerop (signal-process pid 0))) ; Mosaic running
1094 (save-excursion
1095 (find-file (format "/tmp/Mosaic.%d" pid))
1096 (erase-buffer)
1097 (insert (if (browse-url-maybe-new-window new-window)
1098 "newwin\n"
1099 "goto\n")
1100 url "\n")
1101 (save-buffer)
1102 (kill-buffer nil)
1103 ;; Send signal SIGUSR to Mosaic
1104 (message "Signalling Mosaic...")
1105 (signal-process pid 'SIGUSR1)
1106 ;; Or you could try:
1107 ;; (call-process "kill" nil 0 nil "-USR1" (int-to-string pid))
1108 (message "Signalling Mosaic...done")
1109 )
1110 ;; Mosaic not running - start it
1111 (message "Starting %s..." browse-url-mosaic-program)
1112 (apply 'start-process "xmosaic" nil browse-url-mosaic-program
1113 (append browse-url-mosaic-arguments (list url)))
1114 (message "Starting %s...done" browse-url-mosaic-program))))
1115
1116 ;; --- Grail ---
1117
1118 (defvar browse-url-grail
1119 (concat (or (getenv "GRAILDIR") "~/.grail") "/user/rcgrail.py")
1120 "Location of Grail remote control client script `rcgrail.py'.
1121 Typically found in $GRAILDIR/rcgrail.py, or ~/.grail/user/rcgrail.py.")
1122
1123 ;;;###autoload
1124 (defun browse-url-grail (url &optional new-window)
1125 "Ask the Grail WWW browser to load URL.
1126 Default to the URL around or before point. Runs the program in the
1127 variable `browse-url-grail'."
1128 (interactive (browse-url-interactive-arg "Grail URL: "))
1129 (message "Sending URL to Grail...")
1130 (save-excursion
1131 (set-buffer (get-buffer-create " *Shell Command Output*"))
1132 (erase-buffer)
1133 ;; don't worry about this failing.
1134 (if (browse-url-maybe-new-window new-window)
1135 (call-process browse-url-grail nil 0 nil "-b" url)
1136 (call-process browse-url-grail nil 0 nil url))
1137 (message "Sending URL to Grail... done")))
1138
1139 ;; --- Mosaic using CCI ---
1140
1141 ;;;###autoload
1142 (defun browse-url-cci (url &optional new-window)
1143 "Ask the XMosaic WWW browser to load URL.
1144 Default to the URL around or before point.
1145
1146 This function only works for XMosaic version 2.5 or later. You must
1147 select `CCI' from XMosaic's File menu, set the CCI Port Address to the
1148 value of variable `browse-url-CCI-port', and enable `Accept requests'.
1149
1150 When called interactively, if variable `browse-url-new-window-flag' is
1151 non-nil, load the document in a new browser window, otherwise use a
1152 random existing one. A non-nil interactive prefix argument reverses
1153 the effect of `browse-url-new-window-flag'.
1154
1155 When called non-interactively, optional second argument NEW-WINDOW is
1156 used instead of `browse-url-new-window-flag'."
1157 (interactive (browse-url-interactive-arg "Mosaic URL: "))
1158 (open-network-stream "browse-url" " *browse-url*"
1159 browse-url-CCI-host browse-url-CCI-port)
1160 ;; Todo: start browser if fails
1161 (process-send-string "browse-url"
1162 (concat "get url (" url ") output "
1163 (if (browse-url-maybe-new-window new-window)
1164 "new"
1165 "current")
1166 "\r\n"))
1167 (process-send-string "browse-url" "disconnect\r\n")
1168 (delete-process "browse-url"))
1169
1170 ;; --- IXI Mosaic ---
1171
1172 ;;;###autoload
1173 (defun browse-url-iximosaic (url &optional new-window)
1174 ;; new-window ignored
1175 "Ask the IXIMosaic WWW browser to load URL.
1176 Default to the URL around or before point."
1177 (interactive (browse-url-interactive-arg "IXI Mosaic URL: "))
1178 (start-process "tellw3b" nil "tellw3b"
1179 "-service WWW_BROWSER ixi_showurl " url))
1180
1181 ;; --- W3 ---
1182
1183 ;;;###autoload
1184 (defun browse-url-w3 (url &optional new-window)
1185 "Ask the w3 WWW browser to load URL.
1186 Default to the URL around or before point.
1187
1188 When called interactively, if variable `browse-url-new-window-flag' is
1189 non-nil, load the document in a new window. A non-nil interactive
1190 prefix argument reverses the effect of `browse-url-new-window-flag'.
1191
1192 When called non-interactively, optional second argument NEW-WINDOW is
1193 used instead of `browse-url-new-window-flag'."
1194 (interactive (browse-url-interactive-arg "W3 URL: "))
1195 (require 'w3) ; w3-fetch-other-window not autoloaded
1196 (if (browse-url-maybe-new-window new-window)
1197 (w3-fetch-other-window url)
1198 (w3-fetch url)))
1199
1200 ;;;###autoload
1201 (defun browse-url-w3-gnudoit (url &optional new-window)
1202 ;; new-window ignored
1203 "Ask another Emacs running gnuserv to load the URL using the W3 browser.
1204 The `browse-url-gnudoit-program' program is used with options given by
1205 `browse-url-gnudoit-args'. Default to the URL around or before point."
1206 (interactive (browse-url-interactive-arg "W3 URL: "))
1207 (apply 'start-process (concat "gnudoit:" url) nil
1208 browse-url-gnudoit-program
1209 (append browse-url-gnudoit-args
1210 (list (concat "(w3-fetch \"" url "\")")
1211 "(raise-frame)"))))
1212
1213 ;; --- Lynx in an xterm ---
1214
1215 ;;;###autoload
1216 (defun browse-url-lynx-xterm (url &optional new-window)
1217 ;; new-window ignored
1218 "Ask the Lynx WWW browser to load URL.
1219 Default to the URL around or before point. A new Lynx process is run
1220 in an Xterm window using the Xterm program named by `browse-url-xterm-program'
1221 with possible additional arguments `browse-url-xterm-args'."
1222 (interactive (browse-url-interactive-arg "Lynx URL: "))
1223 (apply #'start-process `(,(concat "lynx" url) nil ,browse-url-xterm-program
1224 ,@browse-url-xterm-args "-e" "lynx"
1225 ,url)))
1226
1227 ;; --- Lynx in an Emacs "term" window ---
1228
1229 ;;;###autoload
1230 (defun browse-url-lynx-emacs (url &optional new-buffer)
1231 "Ask the Lynx WWW browser to load URL.
1232 Default to the URL around or before point. With a prefix argument, run
1233 a new Lynx process in a new buffer.
1234
1235 When called interactively, if variable `browse-url-new-window-flag' is
1236 non-nil, load the document in a new lynx in a new term window,
1237 otherwise use any existing one. A non-nil interactive prefix argument
1238 reverses the effect of `browse-url-new-window-flag'.
1239
1240 When called non-interactively, optional second argument NEW-WINDOW is
1241 used instead of `browse-url-new-window-flag'."
1242 (interactive (browse-url-interactive-arg "Lynx URL: "))
1243 (let* ((system-uses-terminfo t) ; Lynx uses terminfo
1244 ;; (term-term-name "vt100") ; ??
1245 (buf (get-buffer "*lynx*"))
1246 (proc (and buf (get-buffer-process buf)))
1247 (n browse-url-lynx-input-attempts))
1248 (if (and (browse-url-maybe-new-window new-buffer) buf)
1249 ;; Rename away the OLD buffer. This isn't very polite, but
1250 ;; term insists on working in a buffer named *lynx* and would
1251 ;; choke on *lynx*<1>
1252 (progn (set-buffer buf)
1253 (rename-uniquely)))
1254 (if (or (browse-url-maybe-new-window new-buffer)
1255 (not buf)
1256 (not proc)
1257 (not (memq (process-status proc) '(run stop))))
1258 ;; start a new lynx
1259 (progn
1260 (setq buf
1261 (apply #'make-term
1262 `("lynx" "lynx" nil ,@browse-url-lynx-emacs-args
1263 ,url)))
1264 (switch-to-buffer buf)
1265 (term-char-mode)
1266 (set-process-sentinel
1267 (get-buffer-process buf)
1268 ;; Don't leave around a dead one (especially because of its
1269 ;; munged keymap.)
1270 (lambda (process event)
1271 (if (not (memq (process-status process) '(run stop)))
1272 (let ((buf (process-buffer process)))
1273 (if buf (kill-buffer buf)))))))
1274 ;; send the url to lynx in the old buffer
1275 (let ((win (get-buffer-window buf t)))
1276 (if win
1277 (select-window win)
1278 (switch-to-buffer buf)))
1279 (if (eq (following-char) ?_)
1280 (cond ((eq browse-url-lynx-input-field 'warn)
1281 (error "Please move out of the input field first"))
1282 ((eq browse-url-lynx-input-field 'avoid)
1283 (while (and (eq (following-char) ?_) (> n 0))
1284 (term-send-down) ; down arrow
1285 (sit-for browse-url-lynx-input-delay))
1286 (if (eq (following-char) ?_)
1287 (error "Cannot move out of the input field, sorry")))))
1288 (term-send-string proc (concat "g" ; goto
1289 "\C-u" ; kill default url
1290 url
1291 "\r")))))
1292
1293 ;; --- MMM ---
1294
1295 ;;;###autoload
1296 (defun browse-url-mmm (url &optional new-window)
1297 "Ask the MMM WWW browser to load URL.
1298 Default to the URL around or before point."
1299 (interactive (browse-url-interactive-arg "MMM URL: "))
1300 (message "Sending URL to MMM...")
1301 (save-excursion
1302 (set-buffer (get-buffer-create " *Shell Command Output*"))
1303 (erase-buffer)
1304 ;; mmm_remote just SEGVs if the file isn't there...
1305 (if (or (file-exists-p (expand-file-name "~/.mmm_remote"))
1306 ;; location in v 0.4:
1307 (file-exists-p (expand-file-name "~/.mmm/remote")))
1308 (call-process "mmm_remote" nil 0 nil url)
1309 (call-process "mmm" nil 0 nil "-external" url))
1310 (message "Sending URL to MMM... done")))
1311
1312 ;; --- mailto ---
1313
1314 (autoload 'rfc2368-parse-mailto-url "rfc2368")
1315
1316 ;;;###autoload
1317 (defun browse-url-mail (url &optional new-window)
1318 "Open a new mail message buffer within Emacs for the RFC 2368 URL.
1319 Default to using the mailto: URL around or before point as the
1320 recipient's address. Supplying a non-nil interactive prefix argument
1321 will cause the mail to be composed in another window rather than the
1322 current one.
1323
1324 When called interactively, if variable `browse-url-new-window-flag' is
1325 non-nil use `compose-mail-other-window', otherwise `compose-mail'. A
1326 non-nil interactive prefix argument reverses the effect of
1327 `browse-url-new-window-flag'.
1328
1329 When called non-interactively, optional second argument NEW-WINDOW is
1330 used instead of `browse-url-new-window-flag'."
1331 (interactive (browse-url-interactive-arg "Mailto URL: "))
1332 (save-excursion
1333 (let* ((alist (rfc2368-parse-mailto-url url))
1334 (to (assoc "To" alist))
1335 (subject (assoc "Subject" alist))
1336 (body (assoc "Body" alist))
1337 (rest (delete to (delete subject (delete body alist))))
1338 (to (cdr to))
1339 (subject (cdr subject))
1340 (body (cdr body))
1341 (mail-citation-hook (unless body mail-citation-hook)))
1342 (if (browse-url-maybe-new-window new-window)
1343 (compose-mail-other-window to subject rest nil
1344 (if body
1345 (list 'insert body)
1346 (list 'insert-buffer (current-buffer))))
1347 (compose-mail to subject rest nil nil
1348 (if body
1349 (list 'insert body)
1350 (list 'insert-buffer (current-buffer))))))))
1351
1352 ;; --- Random browser ---
1353
1354 ;;;###autoload
1355 (defun browse-url-generic (url &optional new-window)
1356 ;; new-window ignored
1357 "Ask the WWW browser defined by `browse-url-generic-program' to load URL.
1358 Default to the URL around or before point. A fresh copy of the
1359 browser is started up in a new process with possible additional arguments
1360 `browse-url-generic-args'. This is appropriate for browsers which
1361 don't offer a form of remote control."
1362 (interactive (browse-url-interactive-arg "URL: "))
1363 (if (not browse-url-generic-program)
1364 (error "No browser defined (`browse-url-generic-program')"))
1365 (apply 'call-process browse-url-generic-program nil
1366 0 nil
1367 (append browse-url-generic-args (list url))))
1368
1369 ;;;###autoload
1370 (defun browse-url-kde (url &optional new-window)
1371 "Ask the KDE WWW browser to load URL.
1372 Default to the URL around or before point."
1373 (interactive (browse-url-interactive-arg "KDE URL: "))
1374 (message "Sending URL to KDE...")
1375 (apply #'start-process (concat "KDE " url) nil browse-url-kde-program
1376 (append browse-url-kde-args (list url))))
1377
1378 (provide 'browse-url)
1379
1380 ;;; arch-tag: d2079573-5c06-4097-9598-f550fba19430
1381 ;;; browse-url.el ends here