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