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