]> code.delx.au - gnu-emacs/blob - lisp/net/browse-url.el
subr.el (read-passwd): Move back from password.el.
[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 ;; interactive-p needs to be called at a function's top-level, hence
600 ;; the macro.
601 (defmacro browse-url-maybe-new-window (arg)
602 `(if (not (interactive-p))
603 ,arg
604 browse-url-new-window-flag))
605
606 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
607 ;; Browse current buffer
608
609 ;;;###autoload
610 (defun browse-url-of-file (&optional file)
611 "Ask a WWW browser to display FILE.
612 Display the current buffer's file if FILE is nil or if called
613 interactively. Turn the filename into a URL with function
614 `browse-url-file-url'. Pass the URL to a browser using the
615 `browse-url' function then run `browse-url-of-file-hook'."
616 (interactive)
617 (or file
618 (setq file (buffer-file-name))
619 (error "Current buffer has no file"))
620 (let ((buf (get-file-buffer file)))
621 (if buf
622 (save-excursion
623 (set-buffer buf)
624 (cond ((not (buffer-modified-p)))
625 (browse-url-save-file (save-buffer))
626 (t (message "%s modified since last save" file))))))
627 (browse-url (browse-url-file-url file))
628 (run-hooks 'browse-url-of-file-hook))
629
630 (defun browse-url-file-url (file)
631 "Return the URL corresponding to FILE.
632 Use variable `browse-url-filename-alist' to map filenames to URLs."
633 ;; URL-encode special chars, do % first
634 (let ((s 0))
635 (while (setq s (string-match "%" file s))
636 (setq file (replace-match "%25" t t file)
637 s (1+ s))))
638 (while (string-match "[*\"()',=;? ]" file)
639 (let ((enc (format "%%%x" (aref file (match-beginning 0)))))
640 (setq file (replace-match enc t t file))))
641 (dolist (map browse-url-filename-alist)
642 (when (and map (string-match (car map) file))
643 (setq file (replace-match (cdr map) t nil file))))
644 file)
645
646 ;;;###autoload
647 (defun browse-url-of-buffer (&optional buffer)
648 "Ask a WWW browser to display BUFFER.
649 Display the current buffer if BUFFER is nil. Display only the
650 currently visible part of BUFFER (from a temporary file) if buffer is
651 narrowed."
652 (interactive)
653 (save-excursion
654 (and buffer (set-buffer buffer))
655 (let ((file-name
656 ;; Ignore real name if restricted
657 (and (= (- (point-max) (point-min)) (buffer-size))
658 (or buffer-file-name
659 (and (boundp 'dired-directory) dired-directory)))))
660 (or file-name
661 (progn
662 (or browse-url-temp-file-name
663 (setq browse-url-temp-file-name
664 (convert-standard-filename
665 (make-temp-file
666 (expand-file-name "burl" browse-url-temp-dir)))))
667 (setq file-name browse-url-temp-file-name)
668 (write-region (point-min) (point-max) file-name nil 'no-message)))
669 (browse-url-of-file file-name))))
670
671 (defun browse-url-delete-temp-file (&optional temp-file-name)
672 ;; Delete browse-url-temp-file-name from the file system
673 ;; If optional arg TEMP-FILE-NAME is non-nil, delete it instead
674 (let ((file-name (or temp-file-name browse-url-temp-file-name)))
675 (if (and file-name (file-exists-p file-name))
676 (delete-file file-name))))
677
678 (add-hook 'kill-buffer-hook 'browse-url-delete-temp-file)
679
680 ;;;###autoload
681 (defun browse-url-of-dired-file ()
682 "In Dired, ask a WWW browser to display the file named on this line."
683 (interactive)
684 (browse-url-of-file (dired-get-filename)))
685
686 ;;;###autoload
687 (defun browse-url-of-region (min max)
688 "Ask a WWW browser to display the current region."
689 (interactive "r")
690 (save-excursion
691 (save-restriction
692 (narrow-to-region min max)
693 (browse-url-of-buffer))))
694
695 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
696 ;; Browser-independent commands
697
698 ;; A generic command to call the current browse-url-browser-function
699
700 ;;;###autoload
701 (defun browse-url (url &rest args)
702 "Ask a WWW browser to load URL.
703 Prompts for a URL, defaulting to the URL at or before point. Variable
704 `browse-url-browser-function' says which browser to use."
705 (interactive (browse-url-interactive-arg "URL: "))
706 (unless (interactive-p)
707 (setq args (or args (list browse-url-new-window-flag))))
708 (if (functionp browse-url-browser-function)
709 (apply browse-url-browser-function url args)
710 ;; The `function' can be an alist; look down it for first match
711 ;; and apply the function (which might be a lambda).
712 (catch 'done
713 (dolist (bf browse-url-browser-function)
714 (when (string-match (car bf) url)
715 (apply (cdr bf) url args)
716 (throw 'done t)))
717 (error "No browse-url-browser-function matching URL %s"
718 url))))
719
720 ;;;###autoload
721 (defun browse-url-at-point (&optional arg)
722 "Ask a WWW browser to load the URL at or before point.
723 Doesn't let you edit the URL like `browse-url'. Variable
724 `browse-url-browser-function' says which browser to use."
725 (interactive "P")
726 (let ((url (browse-url-url-at-point)))
727 (if url
728 (browse-url url (if arg
729 (not browse-url-new-window-flag)
730 browse-url-new-window-flag))
731 (error "No URL found"))))
732
733 ;;;###autoload
734 (defun browse-url-at-mouse (event)
735 "Ask a WWW browser to load a URL clicked with the mouse.
736 The URL is the one around or before the position of the mouse click
737 but point is not changed. Doesn't let you edit the URL like
738 `browse-url'. Variable `browse-url-browser-function' says which browser
739 to use."
740 (interactive "e")
741 (save-excursion
742 (mouse-set-point event)
743 ;; This handles browse-url-new-window-flag properly
744 ;; when it gets no arg.
745 (browse-url-at-point)))
746
747 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
748 ;; Browser-specific commands
749
750 ;; --- Default MS-Windows browser ---
751
752 (defun browse-url-default-windows-browser (url &optional new-window)
753 (interactive (browse-url-interactive-arg "URL: "))
754 (if (eq system-type 'ms-dos)
755 (if dos-windows-version
756 (shell-command (concat "start " (shell-quote-argument url)))
757 (error "Browsing URLs is not supported on this system"))
758 (w32-shell-execute "open" url)))
759
760 (defun browse-url-default-macosx-browser (url &optional new-window)
761 (interactive (browse-url-interactive-arg "URL: "))
762 (start-process (concat "open " url) nil "open" url))
763
764 ;; --- Netscape ---
765
766 (defun browse-url-process-environment ()
767 "Set DISPLAY in the environment to the X display the browser will use.
768 This is either the value of variable `browse-url-browser-display' if
769 non-nil, or the same display as Emacs if different from the current
770 environment, otherwise just use the current environment."
771 (let ((display (or browse-url-browser-display (browse-url-emacs-display))))
772 (if display
773 (cons (concat "DISPLAY=" display) process-environment)
774 process-environment)))
775
776 (defun browse-url-emacs-display ()
777 "Return the X display Emacs is running on.
778 This is nil if the display is the same as the DISPLAY environment variable.
779
780 Actually Emacs could be using several displays; this just returns the
781 one showing the selected frame."
782 (let ((display (cdr-safe (assq 'display (frame-parameters)))))
783 (and (not (equal display (getenv "DISPLAY")))
784 display)))
785
786 ;;;###autoload
787 (defun browse-url-default-browser (url &rest args)
788 "Find a suitable browser and ask it to load URL.
789 Default to the URL around or before point.
790
791 When called interactively, if variable `browse-url-new-window-flag' is
792 non-nil, load the document in a new window, if possible, otherwise use
793 a random existing one. A non-nil interactive prefix argument reverses
794 the effect of `browse-url-new-window-flag'.
795
796 When called non-interactively, optional second argument NEW-WINDOW is
797 used instead of `browse-url-new-window-flag'.
798
799 The order attempted is gnome-moz-remote, Mozilla, Galeon, Netscape,
800 Mosaic, IXI Mosaic, Lynx in an xterm, MMM, Konqueror, and then W3."
801 (apply
802 (cond
803 ((executable-find browse-url-gnome-moz-program) 'browse-url-gnome-moz)
804 ((executable-find browse-url-mozilla-program) 'browse-url-mozilla)
805 ((executable-find browse-url-galeon-program) 'browse-url-galeon)
806 ((executable-find browse-url-kde-program) 'browse-url-kde)
807 ((executable-find browse-url-netscape-program) 'browse-url-netscape)
808 ((executable-find browse-url-mosaic-program) 'browse-url-mosaic)
809 ((executable-find "tellw3b") 'browse-url-iximosaic)
810 ((executable-find browse-url-xterm-program) 'browse-url-lynx-xterm)
811 ((executable-find "mmm") 'browse-url-mmm)
812 (t 'browse-url-w3))
813 url args))
814
815 ;;;###autoload
816 (defun browse-url-netscape (url &optional new-window)
817 "Ask the Netscape WWW browser to load URL.
818 Default to the URL around or before point. The strings in variable
819 `browse-url-netscape-arguments' are also passed to Netscape.
820
821 When called interactively, if variable `browse-url-new-window-flag' is
822 non-nil, load the document in a new Netscape window, otherwise use a
823 random existing one. A non-nil interactive prefix argument reverses
824 the effect of `browse-url-new-window-flag'.
825
826 When called non-interactively, optional second argument NEW-WINDOW is
827 used instead of `browse-url-new-window-flag'."
828 (interactive (browse-url-interactive-arg "URL: "))
829 ;; URL encode any `confusing' characters in the URL. This needs to
830 ;; include at least commas; presumably also close parens and dollars.
831 (while (string-match "[,)$]" url)
832 (setq url (replace-match
833 (format "%%%x" (string-to-char (match-string 0 url))) t t url)))
834 (let* ((process-environment (browse-url-process-environment))
835 (process (apply 'start-process
836 (concat "netscape " url) nil
837 browse-url-netscape-program
838 (append
839 browse-url-netscape-arguments
840 (if (eq window-system 'w32)
841 (list url)
842 (append
843 (if new-window '("-noraise"))
844 (list "-remote"
845 (concat "openURL(" url
846 (if (browse-url-maybe-new-window
847 new-window)
848 ",new-window")
849 ")"))))))))
850 (set-process-sentinel process
851 `(lambda (process change)
852 (browse-url-netscape-sentinel process ,url)))))
853
854 (defun browse-url-netscape-sentinel (process url)
855 "Handle a change to the process communicating with Netscape."
856 (or (eq (process-exit-status process) 0)
857 (let* ((process-environment (browse-url-process-environment)))
858 ;; Netscape not running - start it
859 (message "Starting %s..." browse-url-netscape-program)
860 (apply 'start-process (concat "netscape" url) nil
861 browse-url-netscape-program
862 (append browse-url-netscape-startup-arguments (list url))))))
863
864 (defun browse-url-netscape-reload ()
865 "Ask Netscape to reload its current document.
866 How depends on `browse-url-netscape-version'."
867 (interactive)
868 ;; Backwards incompatibility reported by
869 ;; <peter.kruse@psychologie.uni-regensburg.de>.
870 (browse-url-netscape-send (if (>= browse-url-netscape-version 4)
871 "xfeDoCommand(reload)"
872 "reload")))
873
874 (defun browse-url-netscape-send (command)
875 "Send a remote control command to Netscape."
876 (let* ((process-environment (browse-url-process-environment)))
877 (apply 'start-process "netscape" nil
878 browse-url-netscape-program
879 (append browse-url-netscape-arguments
880 (list "-remote" command)))))
881
882 ;;;###autoload
883 (defun browse-url-mozilla (url &optional new-window)
884 "Ask the Mozilla WWW browser to load URL.
885 Default to the URL around or before point. The strings in variable
886 `browse-url-mozilla-arguments' are also passed to Mozilla.
887
888 When called interactively, if variable `browse-url-new-window-flag' is
889 non-nil, load the document in a new Mozilla window, otherwise use a
890 random existing one. A non-nil interactive prefix argument reverses
891 the effect of `browse-url-new-window-flag'.
892
893 If `browse-url-mozilla-new-window-is-tab' is non-nil, then whenever a
894 document would otherwise be loaded in a new window, it is loaded in a
895 new tab in an existing window instead.
896
897 When called non-interactively, optional second argument NEW-WINDOW is
898 used instead of `browse-url-new-window-flag'."
899 (interactive (browse-url-interactive-arg "URL: "))
900 ;; URL encode any `confusing' characters in the URL. This needs to
901 ;; include at least commas; presumably also close parens and dollars.
902 (while (string-match "[,)$]" url)
903 (setq url (replace-match
904 (format "%%%x" (string-to-char (match-string 0 url))) t t url)))
905 (let* ((process-environment (browse-url-process-environment))
906 (process
907 (apply 'start-process
908 (concat "mozilla " url) nil
909 browse-url-mozilla-program
910 (append
911 browse-url-mozilla-arguments
912 (list "-remote"
913 (concat "openURL("
914 url
915 (if (browse-url-maybe-new-window
916 new-window)
917 (if browse-url-mozilla-new-window-is-tab
918 ",new-tab"
919 ",new-window"))
920 ")"))))))
921 (set-process-sentinel process
922 `(lambda (process change)
923 (browse-url-mozilla-sentinel process ,url)))))
924
925 (defun browse-url-mozilla-sentinel (process url)
926 "Handle a change to the process communicating with Mozilla."
927 (or (eq (process-exit-status process) 0)
928 (let* ((process-environment (browse-url-process-environment)))
929 ;; Mozilla is not running - start it
930 (message "Starting %s..." browse-url-mozilla-program)
931 (apply 'start-process (concat "mozilla " url) nil
932 browse-url-mozilla-program
933 (append browse-url-mozilla-startup-arguments (list url))))))
934
935 ;;;###autoload
936 (defun browse-url-galeon (url &optional new-window)
937 "Ask the Galeon WWW browser to load URL.
938 Default to the URL around or before point. The strings in variable
939 `browse-url-galeon-arguments' are also passed to Galeon.
940
941 When called interactively, if variable `browse-url-new-window-flag' is
942 non-nil, load the document in a new Galeon window, otherwise use a
943 random existing one. A non-nil interactive prefix argument reverses
944 the effect of `browse-url-new-window-flag'.
945
946 If `browse-url-galeon-new-window-is-tab' is non-nil, then whenever a
947 document would otherwise be loaded in a new window, it is loaded in a
948 new tab in an existing window instead.
949
950 When called non-interactively, optional second argument NEW-WINDOW is
951 used instead of `browse-url-new-window-flag'."
952 (interactive (browse-url-interactive-arg "URL: "))
953 ;; URL encode any `confusing' characters in the URL. This needs to
954 ;; include at least commas; presumably also close parens and dollars.
955 (while (string-match "[,)$]" url)
956 (setq url (replace-match
957 (format "%%%x" (string-to-char (match-string 0 url))) t t url)))
958 (let* ((process-environment (browse-url-process-environment))
959 (process (apply 'start-process
960 (concat "galeon " url)
961 nil
962 browse-url-galeon-program
963 (append
964 browse-url-galeon-arguments
965 (if (browse-url-maybe-new-window new-window)
966 (if browse-url-galeon-new-window-is-tab
967 '("--new-tab")
968 '("--new-window" "--noraise"))
969 '("--existing"))
970 (list url)))))
971 (set-process-sentinel process
972 `(lambda (process change)
973 (browse-url-galeon-sentinel process ,url)))))
974
975 (defun browse-url-galeon-sentinel (process url)
976 "Handle a change to the process communicating with Galeon."
977 (or (eq (process-exit-status process) 0)
978 (let* ((process-environment (browse-url-process-environment)))
979 ;; Galeon is not running - start it
980 (message "Starting %s..." browse-url-galeon-program)
981 (apply 'start-process (concat "galeon " url) nil
982 browse-url-galeon-program
983 (append browse-url-galeon-startup-arguments (list url))))))
984
985 (defun browse-url-epiphany (url &optional new-window)
986 "Ask the Epiphany WWW browser to load URL.
987 Default to the URL around or before point. The strings in variable
988 `browse-url-galeon-arguments' are also passed to Epiphany.
989
990 When called interactively, if variable `browse-url-new-window-flag' is
991 non-nil, load the document in a new Epiphany window, otherwise use a
992 random existing one. A non-nil interactive prefix argument reverses
993 the effect of `browse-url-new-window-flag'.
994
995 If `browse-url-epiphany-new-window-is-tab' is non-nil, then whenever a
996 document would otherwise be loaded in a new window, it is loaded in a
997 new tab in an existing window instead.
998
999 When called non-interactively, optional second argument NEW-WINDOW is
1000 used instead of `browse-url-new-window-flag'."
1001 (interactive (browse-url-interactive-arg "URL: "))
1002 ;; URL encode any `confusing' characters in the URL. This needs to
1003 ;; include at least commas; presumably also close parens and dollars.
1004 (while (string-match "[,)$]" url)
1005 (setq url (replace-match
1006 (format "%%%x" (string-to-char (match-string 0 url))) t t url)))
1007 (let* ((process-environment (browse-url-process-environment))
1008 (process (apply 'start-process
1009 (concat "epiphany " url)
1010 nil
1011 browse-url-epiphany-program
1012 (append
1013 browse-url-epiphany-arguments
1014 (if (browse-url-maybe-new-window new-window)
1015 (if browse-url-epiphany-new-window-is-tab
1016 '("--new-tab")
1017 '("--new-window" "--noraise"))
1018 '("--existing"))
1019 (list url)))))
1020 (set-process-sentinel process
1021 `(lambda (process change)
1022 (browse-url-epiphany-sentinel process ,url)))))
1023
1024 (defun browse-url-epiphany-sentinel (process url)
1025 "Handle a change to the process communicating with Epiphany."
1026 (or (eq (process-exit-status process) 0)
1027 (let* ((process-environment (browse-url-process-environment)))
1028 ;; Epiphany is not running - start it
1029 (message "Starting %s..." browse-url-epiphany-program)
1030 (apply 'start-process (concat "epiphany " url) nil
1031 browse-url-epiphany-program
1032 (append browse-url-epiphany-startup-arguments (list url))))))
1033
1034 ;; GNOME means of invoking either Mozilla or Netrape.
1035 (defvar browse-url-gnome-moz-program "gnome-moz-remote")
1036 (defcustom browse-url-gnome-moz-arguments '()
1037 "*A list of strings passed to the GNOME mozilla viewer as arguments."
1038 :version "21.1"
1039 :type '(repeat (string :tag "Argument"))
1040 :group 'browse-url)
1041
1042 ;;;###autoload
1043 (defun browse-url-gnome-moz (url &optional new-window)
1044 "Ask Mozilla/Netscape to load URL via the GNOME program `gnome-moz-remote'.
1045 Default to the URL around or before point. The strings in variable
1046 `browse-url-gnome-moz-arguments' are also passed.
1047
1048 When called interactively, if variable `browse-url-new-window-flag' is
1049 non-nil, load the document in a new browser window, otherwise use an
1050 existing one. A non-nil interactive prefix argument reverses the
1051 effect of `browse-url-new-window-flag'.
1052
1053 When called non-interactively, optional second argument NEW-WINDOW is
1054 used instead of `browse-url-new-window-flag'."
1055 (interactive (browse-url-interactive-arg "URL: "))
1056 (apply 'start-process (concat "gnome-moz-remote " url)
1057 nil
1058 browse-url-gnome-moz-program
1059 (append
1060 browse-url-gnome-moz-arguments
1061 (if (browse-url-maybe-new-window new-window)
1062 '("--newwin"))
1063 (list "--raise" url))))
1064
1065 ;; --- Mosaic ---
1066
1067 ;;;###autoload
1068 (defun browse-url-mosaic (url &optional new-window)
1069 "Ask the XMosaic WWW browser to load URL.
1070
1071 Default to the URL around or before point. The strings in variable
1072 `browse-url-mosaic-arguments' are also passed to Mosaic and the
1073 program is invoked according to the variable
1074 `browse-url-mosaic-program'.
1075
1076 When called interactively, if variable `browse-url-new-window-flag' is
1077 non-nil, load the document in a new Mosaic window, otherwise use a
1078 random existing one. A non-nil interactive prefix argument reverses
1079 the effect of `browse-url-new-window-flag'.
1080
1081 When called non-interactively, optional second argument NEW-WINDOW is
1082 used instead of `browse-url-new-window-flag'."
1083 (interactive (browse-url-interactive-arg "Mosaic URL: "))
1084 (let ((pidfile (expand-file-name browse-url-mosaic-pidfile))
1085 pid)
1086 (if (file-readable-p pidfile)
1087 (save-excursion
1088 (find-file pidfile)
1089 (goto-char (point-min))
1090 (setq pid (read (current-buffer)))
1091 (kill-buffer nil)))
1092 (if (and pid (zerop (signal-process pid 0))) ; Mosaic running
1093 (save-excursion
1094 (find-file (format "/tmp/Mosaic.%d" pid))
1095 (erase-buffer)
1096 (insert (if (browse-url-maybe-new-window new-window)
1097 "newwin\n"
1098 "goto\n")
1099 url "\n")
1100 (save-buffer)
1101 (kill-buffer nil)
1102 ;; Send signal SIGUSR to Mosaic
1103 (message "Signalling Mosaic...")
1104 (signal-process pid 'SIGUSR1)
1105 ;; Or you could try:
1106 ;; (call-process "kill" nil 0 nil "-USR1" (int-to-string pid))
1107 (message "Signalling Mosaic...done")
1108 )
1109 ;; Mosaic not running - start it
1110 (message "Starting %s..." browse-url-mosaic-program)
1111 (apply 'start-process "xmosaic" nil browse-url-mosaic-program
1112 (append browse-url-mosaic-arguments (list url)))
1113 (message "Starting %s...done" browse-url-mosaic-program))))
1114
1115 ;; --- Grail ---
1116
1117 (defvar browse-url-grail
1118 (concat (or (getenv "GRAILDIR") "~/.grail") "/user/rcgrail.py")
1119 "Location of Grail remote control client script `rcgrail.py'.
1120 Typically found in $GRAILDIR/rcgrail.py, or ~/.grail/user/rcgrail.py.")
1121
1122 ;;;###autoload
1123 (defun browse-url-grail (url &optional new-window)
1124 "Ask the Grail WWW browser to load URL.
1125 Default to the URL around or before point. Runs the program in the
1126 variable `browse-url-grail'."
1127 (interactive (browse-url-interactive-arg "Grail URL: "))
1128 (message "Sending URL to Grail...")
1129 (save-excursion
1130 (set-buffer (get-buffer-create " *Shell Command Output*"))
1131 (erase-buffer)
1132 ;; don't worry about this failing.
1133 (if (browse-url-maybe-new-window new-window)
1134 (call-process browse-url-grail nil 0 nil "-b" url)
1135 (call-process browse-url-grail nil 0 nil url))
1136 (message "Sending URL to Grail... done")))
1137
1138 ;; --- Mosaic using CCI ---
1139
1140 ;;;###autoload
1141 (defun browse-url-cci (url &optional new-window)
1142 "Ask the XMosaic WWW browser to load URL.
1143 Default to the URL around or before point.
1144
1145 This function only works for XMosaic version 2.5 or later. You must
1146 select `CCI' from XMosaic's File menu, set the CCI Port Address to the
1147 value of variable `browse-url-CCI-port', and enable `Accept requests'.
1148
1149 When called interactively, if variable `browse-url-new-window-flag' is
1150 non-nil, load the document in a new browser window, otherwise use a
1151 random existing one. A non-nil interactive prefix argument reverses
1152 the effect of `browse-url-new-window-flag'.
1153
1154 When called non-interactively, optional second argument NEW-WINDOW is
1155 used instead of `browse-url-new-window-flag'."
1156 (interactive (browse-url-interactive-arg "Mosaic URL: "))
1157 (open-network-stream "browse-url" " *browse-url*"
1158 browse-url-CCI-host browse-url-CCI-port)
1159 ;; Todo: start browser if fails
1160 (process-send-string "browse-url"
1161 (concat "get url (" url ") output "
1162 (if (browse-url-maybe-new-window new-window)
1163 "new"
1164 "current")
1165 "\r\n"))
1166 (process-send-string "browse-url" "disconnect\r\n")
1167 (delete-process "browse-url"))
1168
1169 ;; --- IXI Mosaic ---
1170
1171 ;;;###autoload
1172 (defun browse-url-iximosaic (url &optional new-window)
1173 ;; new-window ignored
1174 "Ask the IXIMosaic WWW browser to load URL.
1175 Default to the URL around or before point."
1176 (interactive (browse-url-interactive-arg "IXI Mosaic URL: "))
1177 (start-process "tellw3b" nil "tellw3b"
1178 "-service WWW_BROWSER ixi_showurl " url))
1179
1180 ;; --- W3 ---
1181
1182 ;;;###autoload
1183 (defun browse-url-w3 (url &optional new-window)
1184 "Ask the w3 WWW browser to load URL.
1185 Default to the URL around or before point.
1186
1187 When called interactively, if variable `browse-url-new-window-flag' is
1188 non-nil, load the document in a new window. A non-nil interactive
1189 prefix argument reverses the effect of `browse-url-new-window-flag'.
1190
1191 When called non-interactively, optional second argument NEW-WINDOW is
1192 used instead of `browse-url-new-window-flag'."
1193 (interactive (browse-url-interactive-arg "W3 URL: "))
1194 (require 'w3) ; w3-fetch-other-window not autoloaded
1195 (if (browse-url-maybe-new-window new-window)
1196 (w3-fetch-other-window url)
1197 (w3-fetch url)))
1198
1199 ;;;###autoload
1200 (defun browse-url-w3-gnudoit (url &optional new-window)
1201 ;; new-window ignored
1202 "Ask another Emacs running gnuserv to load the URL using the W3 browser.
1203 The `browse-url-gnudoit-program' program is used with options given by
1204 `browse-url-gnudoit-args'. Default to the URL around or before point."
1205 (interactive (browse-url-interactive-arg "W3 URL: "))
1206 (apply 'start-process (concat "gnudoit:" url) nil
1207 browse-url-gnudoit-program
1208 (append browse-url-gnudoit-args
1209 (list (concat "(w3-fetch \"" url "\")")
1210 "(raise-frame)"))))
1211
1212 ;; --- Lynx in an xterm ---
1213
1214 ;;;###autoload
1215 (defun browse-url-lynx-xterm (url &optional new-window)
1216 ;; new-window ignored
1217 "Ask the Lynx WWW browser to load URL.
1218 Default to the URL around or before point. A new Lynx process is run
1219 in an Xterm window using the Xterm program named by `browse-url-xterm-program'
1220 with possible additional arguments `browse-url-xterm-args'."
1221 (interactive (browse-url-interactive-arg "Lynx URL: "))
1222 (apply #'start-process `(,(concat "lynx" url) nil ,browse-url-xterm-program
1223 ,@browse-url-xterm-args "-e" "lynx"
1224 ,url)))
1225
1226 ;; --- Lynx in an Emacs "term" window ---
1227
1228 ;;;###autoload
1229 (defun browse-url-lynx-emacs (url &optional new-buffer)
1230 "Ask the Lynx WWW browser to load URL.
1231 Default to the URL around or before point. With a prefix argument, run
1232 a new Lynx process in a new buffer.
1233
1234 When called interactively, if variable `browse-url-new-window-flag' is
1235 non-nil, load the document in a new lynx in a new term window,
1236 otherwise use any existing one. A non-nil interactive prefix argument
1237 reverses the effect of `browse-url-new-window-flag'.
1238
1239 When called non-interactively, optional second argument NEW-WINDOW is
1240 used instead of `browse-url-new-window-flag'."
1241 (interactive (browse-url-interactive-arg "Lynx URL: "))
1242 (let* ((system-uses-terminfo t) ; Lynx uses terminfo
1243 ;; (term-term-name "vt100") ; ??
1244 (buf (get-buffer "*lynx*"))
1245 (proc (and buf (get-buffer-process buf)))
1246 (n browse-url-lynx-input-attempts))
1247 (if (and (browse-url-maybe-new-window new-buffer) buf)
1248 ;; Rename away the OLD buffer. This isn't very polite, but
1249 ;; term insists on working in a buffer named *lynx* and would
1250 ;; choke on *lynx*<1>
1251 (progn (set-buffer buf)
1252 (rename-uniquely)))
1253 (if (or (browse-url-maybe-new-window new-buffer)
1254 (not buf)
1255 (not proc)
1256 (not (memq (process-status proc) '(run stop))))
1257 ;; start a new lynx
1258 (progn
1259 (setq buf
1260 (apply #'make-term
1261 `("lynx" "lynx" nil ,@browse-url-lynx-emacs-args
1262 ,url)))
1263 (switch-to-buffer buf)
1264 (term-char-mode)
1265 (set-process-sentinel
1266 (get-buffer-process buf)
1267 ;; Don't leave around a dead one (especially because of its
1268 ;; munged keymap.)
1269 (lambda (process event)
1270 (if (not (memq (process-status process) '(run stop)))
1271 (let ((buf (process-buffer process)))
1272 (if buf (kill-buffer buf)))))))
1273 ;; send the url to lynx in the old buffer
1274 (let ((win (get-buffer-window buf t)))
1275 (if win
1276 (select-window win)
1277 (switch-to-buffer buf)))
1278 (if (eq (following-char) ?_)
1279 (cond ((eq browse-url-lynx-input-field 'warn)
1280 (error "Please move out of the input field first"))
1281 ((eq browse-url-lynx-input-field 'avoid)
1282 (while (and (eq (following-char) ?_) (> n 0))
1283 (term-send-down) ; down arrow
1284 (sit-for browse-url-lynx-input-delay))
1285 (if (eq (following-char) ?_)
1286 (error "Cannot move out of the input field, sorry")))))
1287 (term-send-string proc (concat "g" ; goto
1288 "\C-u" ; kill default url
1289 url
1290 "\r")))))
1291
1292 ;; --- MMM ---
1293
1294 ;;;###autoload
1295 (defun browse-url-mmm (url &optional new-window)
1296 "Ask the MMM WWW browser to load URL.
1297 Default to the URL around or before point."
1298 (interactive (browse-url-interactive-arg "MMM URL: "))
1299 (message "Sending URL to MMM...")
1300 (save-excursion
1301 (set-buffer (get-buffer-create " *Shell Command Output*"))
1302 (erase-buffer)
1303 ;; mmm_remote just SEGVs if the file isn't there...
1304 (if (or (file-exists-p (expand-file-name "~/.mmm_remote"))
1305 ;; location in v 0.4:
1306 (file-exists-p (expand-file-name "~/.mmm/remote")))
1307 (call-process "mmm_remote" nil 0 nil url)
1308 (call-process "mmm" nil 0 nil "-external" url))
1309 (message "Sending URL to MMM... done")))
1310
1311 ;; --- mailto ---
1312
1313 (autoload 'rfc2368-parse-mailto-url "rfc2368")
1314
1315 ;;;###autoload
1316 (defun browse-url-mail (url &optional new-window)
1317 "Open a new mail message buffer within Emacs for the RFC 2368 URL.
1318 Default to using the mailto: URL around or before point as the
1319 recipient's address. Supplying a non-nil interactive prefix argument
1320 will cause the mail to be composed in another window rather than the
1321 current one.
1322
1323 When called interactively, if variable `browse-url-new-window-flag' is
1324 non-nil use `compose-mail-other-window', otherwise `compose-mail'. A
1325 non-nil interactive prefix argument reverses the effect of
1326 `browse-url-new-window-flag'.
1327
1328 When called non-interactively, optional second argument NEW-WINDOW is
1329 used instead of `browse-url-new-window-flag'."
1330 (interactive (browse-url-interactive-arg "Mailto URL: "))
1331 (save-excursion
1332 (let* ((alist (rfc2368-parse-mailto-url url))
1333 (to (assoc "To" alist))
1334 (subject (assoc "Subject" alist))
1335 (body (assoc "Body" alist))
1336 (rest (delete to (delete subject (delete body alist))))
1337 (to (cdr to))
1338 (subject (cdr subject))
1339 (body (cdr body))
1340 (mail-citation-hook (unless body mail-citation-hook)))
1341 (if (browse-url-maybe-new-window new-window)
1342 (compose-mail-other-window to subject rest nil
1343 (if body
1344 (list 'insert body)
1345 (list 'insert-buffer (current-buffer))))
1346 (compose-mail to subject rest nil nil
1347 (if body
1348 (list 'insert body)
1349 (list 'insert-buffer (current-buffer))))))))
1350
1351 ;; --- Random browser ---
1352
1353 ;;;###autoload
1354 (defun browse-url-generic (url &optional new-window)
1355 ;; new-window ignored
1356 "Ask the WWW browser defined by `browse-url-generic-program' to load URL.
1357 Default to the URL around or before point. A fresh copy of the
1358 browser is started up in a new process with possible additional arguments
1359 `browse-url-generic-args'. This is appropriate for browsers which
1360 don't offer a form of remote control."
1361 (interactive (browse-url-interactive-arg "URL: "))
1362 (if (not browse-url-generic-program)
1363 (error "No browser defined (`browse-url-generic-program')"))
1364 (apply 'call-process browse-url-generic-program nil
1365 0 nil
1366 (append browse-url-generic-args (list url))))
1367
1368 ;;;###autoload
1369 (defun browse-url-kde (url &optional new-window)
1370 "Ask the KDE WWW browser to load URL.
1371 Default to the URL around or before point."
1372 (interactive (browse-url-interactive-arg "KDE URL: "))
1373 (message "Sending URL to KDE...")
1374 (apply #'start-process (concat "KDE " url) nil browse-url-kde-program
1375 (append browse-url-kde-args (list url))))
1376
1377 (provide 'browse-url)
1378
1379 ;;; arch-tag: d2079573-5c06-4097-9598-f550fba19430
1380 ;;; browse-url.el ends here