1 ;;; browse-url.el --- pass a URL to a WWW browser
3 ;; Copyright (C) 1995-2015 Free Software Foundation, Inc.
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
10 ;; This file is part of GNU Emacs.
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.
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.
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/>.
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:
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
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)
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.]
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>.
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.
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
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/>.
79 ;; Lynx is now distributed by the FSF. See also
80 ;; <URL:http://lynx.browser.org/>.
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.
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/>
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
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
108 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
111 ;; Can you write and test some code for the Macintrash and Windoze
112 ;; Netscape remote control APIs? (See the URL above).
114 ;; Do any other browsers have remote control?
116 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
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
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.)
130 ;; To display the current buffer in a web browser:
131 ;; M-x browse-url-of-buffer RET
133 ;; To display the current region in a web browser:
134 ;; M-x browse-url-of-region RET
136 ;; In Dired, to display the file named on the current line:
137 ;; M-x browse-url-of-dired-file RET
139 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
140 ;; Customization (~/.emacs)
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'.
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
155 ;; (local-set-key "\C-c\C-zf" 'browse-url-of-dired-file)))
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'.
162 ;; Gnus provides a standard feature to activate URLs in article
163 ;; buffers for invocation of browse-url.
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))
169 ;; To always save modified buffers before displaying the file in a browser:
170 ;; (setq browse-url-save-file t)
172 ;; To get round the Netscape caching problem, you could EITHER have
173 ;; write-file in html-helper-mode make Netscape reload the document:
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
179 ;; (add-hook 'local-write-file-hooks
181 ;; (let ((local-write-file-hooks))
183 ;; (browse-url-netscape-reload)
184 ;; t) ; => file written by hook
185 ;; t))) ; append to l-w-f-hooks
187 ;; OR have browse-url-of-file ask Netscape to load and then reload the
190 ;; (add-hook 'browse-url-of-file-hook 'browse-url-netscape-reload)
192 ;; You may also want to customize browse-url-netscape-arguments, e.g.
193 ;; (setq browse-url-netscape-arguments '("-install"))
195 ;; or similarly for the other browsers.
197 ;; To invoke different browsers for different URLs:
198 ;; (setq browse-url-browser-function '(("^mailto:" . browse-url-mail)
199 ;; ("." . browse-url-netscape)))
201 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
204 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
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")
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.
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."
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))
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
268 (function-item :tag "Emacs Mail" :value browse-url-mail)
269 (function-item :tag "None" nil))
273 (defcustom browse-url-netscape-program "netscape"
274 ;; Info about netscape-remote from Karl Berry.
275 "The name by which to invoke Netscape.
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."
285 (defcustom browse-url-netscape-arguments nil
286 "A list of strings to pass to Netscape as arguments."
287 :type '(repeat (string :tag "Argument"))
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"))
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))
302 (defcustom browse-url-mozilla-program "mozilla"
303 "The name by which to invoke Mozilla."
307 (defcustom browse-url-mozilla-arguments nil
308 "A list of strings to pass to Mozilla as arguments."
309 :type '(repeat (string :tag "Argument"))
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"))
319 (defcustom browse-url-firefox-program
320 (let ((candidates '("icecat" "iceweasel" "firefox")))
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 or a variant of it."
328 (defcustom browse-url-firefox-arguments nil
329 "A list of strings to pass to Firefox (or variant) as arguments."
330 :type '(repeat (string :tag "Argument"))
333 (defcustom browse-url-firefox-startup-arguments browse-url-firefox-arguments
334 "A list of strings to pass to Firefox (or variant) 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"))
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."
350 (defcustom browse-url-chromium-arguments nil
351 "A list of strings to pass to Chromium as arguments."
352 :type '(repeat (string :tag "Argument"))
356 (defcustom browse-url-galeon-program "galeon"
357 "The name by which to invoke Galeon."
361 (defcustom browse-url-galeon-arguments nil
362 "A list of strings to pass to Galeon as arguments."
363 :type '(repeat (string :tag "Argument"))
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"))
373 (defcustom browse-url-epiphany-program "epiphany"
374 "The name by which to invoke Epiphany."
378 (defcustom browse-url-epiphany-arguments nil
379 "A list of strings to pass to Epiphany as arguments."
380 :type '(repeat (string :tag "Argument"))
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"))
390 ;; GNOME means of invoking either Mozilla or Netscape.
391 (defvar browse-url-gnome-moz-program "gnome-moz-remote")
393 (defcustom browse-url-gnome-moz-arguments '()
394 "A list of strings passed to the GNOME mozilla viewer as arguments."
396 :type '(repeat (string :tag "Argument"))
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."
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.
411 This option is currently ignored on MS-Windows, since the necessary
412 functionality is not available there."
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."
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."
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
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."
446 (defcustom browse-url-mosaic-program "xmosaic"
447 "The name by which to invoke Mosaic (or mMosaic)."
452 (defcustom browse-url-mosaic-arguments nil
453 "A list of strings to pass to Mosaic as arguments."
454 :type '(repeat (string :tag "Argument"))
457 (defcustom browse-url-mosaic-pidfile "~/.mosaicpid"
458 "The name of the pidfile created by Mosaic."
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
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 `/'.
479 For example, adding to the default a specific translation of an ange-ftp
480 address to an HTTP URL:
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")))
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."
500 (defcustom browse-url-of-file-hook nil
501 "Run after `browse-url-of-file' has asked a browser to load a file.
503 Set this to `browse-url-netscape-reload' to force Netscape to load the
504 file rather than displaying a cached copy."
506 :options '(browse-url-netscape-reload)
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."
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'."
523 (defvar browse-url-temp-file-name nil)
524 (make-variable-buffer-local 'browse-url-temp-file-name)
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."
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"))
538 (defcustom browse-url-gnudoit-program "gnudoit"
539 "The name of the `gnudoit' program used by `browse-url-w3-gnudoit'."
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"))
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))
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"))
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
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."
574 (defcustom browse-url-text-browser "lynx"
575 "The name of the text browser to invoke."
580 (defcustom browse-url-text-emacs-args (and (not window-system)
582 "A list of strings defining options for a text browser in an Emacs buffer.
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"))
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))
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."
611 (defcustom browse-url-text-input-delay 0.2
612 "Seconds to wait for a text browser between moves down from an input field."
617 (defcustom browse-url-kde-program "kfmclient"
618 "The name by which to invoke the KDE web browser."
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"))
628 (defcustom browse-url-elinks-wrapper '("xterm" "-e")
629 "Wrapper command prepended to the Elinks command-line."
630 :type '(repeat (string :tag "Wrapper"))
633 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
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))
641 (while (setq s (string-match chars encoded-text s))
643 (replace-match (format "%%%X"
644 (string-to-char (match-string 0 encoded-text)))
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 "[\")$] "))
658 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
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)))))
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.
671 (defun browse-url-interactive-arg (prompt &optional default-url)
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.
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
686 (buffer-substring-no-properties
687 (region-beginning) (region-end))))
688 (browse-url-url-at-point)
690 (not (eq (null browse-url-new-window-flag)
691 (null current-prefix-arg)))))
693 ;; called-interactive-p needs to be called at a function's top-level, hence
694 ;; this macro. We use that rather than interactive-p because
695 ;; use in a keyboard macro should not change this behavior.
696 (defmacro browse-url-maybe-new-window (arg)
697 `(if (or noninteractive (not (called-interactively-p 'any)))
699 browse-url-new-window-flag))
701 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
702 ;; Browse current buffer
705 (defun browse-url-of-file (&optional file)
706 "Ask a WWW browser to display FILE.
707 Display the current buffer's file if FILE is nil or if called
708 interactively. Turn the filename into a URL with function
709 `browse-url-file-url'. Pass the URL to a browser using the
710 `browse-url' function then run `browse-url-of-file-hook'."
713 (setq file (buffer-file-name))
714 (error "Current buffer has no file"))
715 (let ((buf (get-file-buffer file)))
717 (with-current-buffer buf
718 (cond ((not (buffer-modified-p)))
719 (browse-url-save-file (save-buffer))
720 (t (message "%s modified since last save" file))))))
721 (browse-url (browse-url-file-url file))
722 (run-hooks 'browse-url-of-file-hook))
724 (defun browse-url-file-url (file)
725 "Return the URL corresponding to FILE.
726 Use variable `browse-url-filename-alist' to map filenames to URLs."
727 (let ((coding (if (equal system-type 'windows-nt)
728 ;; W32 pretends that file names are UTF-8 encoded.
730 (and (default-value 'enable-multibyte-characters)
731 (or file-name-coding-system
732 default-file-name-coding-system)))))
733 (if coding (setq file (encode-coding-string file coding))))
734 (setq file (browse-url-url-encode-chars file "[*\"()',=;?% ]"))
735 (dolist (map browse-url-filename-alist)
736 (when (and map (string-match (car map) file))
737 (setq file (replace-match (cdr map) t nil file))))
741 (defun browse-url-of-buffer (&optional buffer)
742 "Ask a WWW browser to display BUFFER.
743 Display the current buffer if BUFFER is nil. Display only the
744 currently visible part of BUFFER (from a temporary file) if buffer is
748 (and buffer (set-buffer buffer))
750 ;; Ignore real name if restricted
751 (and (not (buffer-narrowed-p))
753 (and (boundp 'dired-directory) dired-directory)))))
756 (or browse-url-temp-file-name
757 (setq browse-url-temp-file-name
758 (convert-standard-filename
760 (expand-file-name "burl" browse-url-temp-dir)
762 (setq file-name browse-url-temp-file-name)
763 (write-region (point-min) (point-max) file-name nil 'no-message)))
764 (browse-url-of-file file-name))))
766 (defun browse-url-delete-temp-file (&optional temp-file-name)
767 ;; Delete browse-url-temp-file-name from the file system
768 ;; If optional arg TEMP-FILE-NAME is non-nil, delete it instead
769 (let ((file-name (or temp-file-name browse-url-temp-file-name)))
770 (if (and file-name (file-exists-p file-name))
771 (delete-file file-name))))
773 (add-hook 'kill-buffer-hook 'browse-url-delete-temp-file)
775 (declare-function dired-get-filename "dired"
776 (&optional localp no-error-if-not-filep))
779 (defun browse-url-of-dired-file ()
780 "In Dired, ask a WWW browser to display the file named on this line."
782 (let ((tem (dired-get-filename t t)))
784 (browse-url-of-file (expand-file-name tem))
785 (error "No file on this line"))))
788 (defun browse-url-of-region (min max)
789 "Ask a WWW browser to display the current region."
793 (narrow-to-region min max)
794 (browse-url-of-buffer))))
796 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
797 ;; Browser-independent commands
799 (defun url-tidy (url)
800 "Tidy up URL as much as possible."
801 (if (equal 0 (string-match ".*://" url))
803 (concat "http://" url) ;;TODO guess more url forms, like mailto
806 ;; A generic command to call the current browse-url-browser-function
809 (defun browse-url (url &rest args)
810 "Ask a WWW browser to load URL.
811 Prompts for a URL, defaulting to the URL at or before point. Variable
812 `browse-url-browser-function' says which browser to use.
813 If the URL is a mailto: URL, consult `browse-url-mailto-function'
814 first, if that exists."
815 (interactive (browse-url-interactive-arg "URL: "))
816 (unless (called-interactively-p 'interactive)
817 (setq args (or args (list browse-url-new-window-flag))))
818 (setq url (url-tidy url))
819 (when (and url-handler-mode (not (file-name-absolute-p url)))
820 (setq url (expand-file-name url)))
821 (let ((process-environment (copy-sequence process-environment))
822 (function (or (and (string-match "\\`mailto:" url)
823 browse-url-mailto-function)
824 browse-url-browser-function))
825 ;; Ensure that `default-directory' exists and is readable (b#6077).
826 (default-directory (or (unhandled-file-name-directory default-directory)
827 (expand-file-name "~/"))))
828 ;; When connected to various displays, be careful to use the display of
829 ;; the currently selected frame, rather than the original start display,
830 ;; which may not even exist any more.
831 (if (stringp (frame-parameter nil 'display))
832 (setenv "DISPLAY" (frame-parameter nil 'display)))
833 (if (and (consp function)
834 (not (functionp function)))
835 ;; The `function' can be an alist; look down it for first match
836 ;; and apply the function (which might be a lambda).
838 (dolist (bf function)
839 (when (string-match (car bf) url)
840 (apply (cdr bf) url args)
842 (error "No browse-url-browser-function matching URL %s"
844 ;; Unbound symbols go down this leg, since void-function from
845 ;; apply is clearer than wrong-type-argument from dolist.
846 (apply function url args))))
849 (defun browse-url-at-point (&optional arg)
850 "Ask a WWW browser to load the URL at or before point.
851 Doesn't let you edit the URL like `browse-url'. Variable
852 `browse-url-browser-function' says which browser to use."
854 (let ((url (browse-url-url-at-point)))
856 (browse-url url (if arg
857 (not browse-url-new-window-flag)
858 browse-url-new-window-flag))
859 (error "No URL found"))))
862 (defun browse-url-at-mouse (event)
863 "Ask a WWW browser to load a URL clicked with the mouse.
864 The URL is the one around or before the position of the mouse click
865 but point is not changed. Doesn't let you edit the URL like
866 `browse-url'. Variable `browse-url-browser-function' says which browser
870 (mouse-set-point event)
871 ;; This handles browse-url-new-window-flag properly
872 ;; when it gets no arg.
873 (browse-url-at-point)))
875 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
876 ;; Browser-specific commands
878 ;; --- Default MS-Windows browser ---
880 (defvar dos-windows-version)
881 (declare-function w32-shell-execute "w32fns.c") ;; Defined in C.
883 (defun browse-url-default-windows-browser (url &optional _new-window)
884 (interactive (browse-url-interactive-arg "URL: "))
885 (cond ((eq system-type 'ms-dos)
886 (if dos-windows-version
887 (shell-command (concat "start " (shell-quote-argument url)))
888 (error "Browsing URLs is not supported on this system")))
889 ((eq system-type 'cygwin)
890 (call-process "cygstart" nil nil nil url))
891 (t (w32-shell-execute "open" url))))
893 (defun browse-url-default-macosx-browser (url &optional _new-window)
894 (interactive (browse-url-interactive-arg "URL: "))
895 (start-process (concat "open " url) nil "open" url))
899 (defun browse-url-process-environment ()
900 "Set DISPLAY in the environment to the X display the browser will use.
901 This is either the value of variable `browse-url-browser-display' if
902 non-nil, or the same display as Emacs if different from the current
903 environment, otherwise just use the current environment."
904 (let ((display (or browse-url-browser-display (browse-url-emacs-display))))
906 (cons (concat "DISPLAY=" display) process-environment)
907 process-environment)))
909 (defun browse-url-emacs-display ()
910 "Return the X display Emacs is running on.
911 This is nil if the display is the same as the DISPLAY environment variable.
913 Actually Emacs could be using several displays; this just returns the
914 one showing the selected frame."
915 (let ((display (cdr-safe (assq 'display (frame-parameters)))))
916 (and (not (equal display (getenv "DISPLAY")))
919 (defun browse-url-default-browser (url &rest args)
920 "Find a suitable browser and ask it to load URL.
921 Default to the URL around or before point.
923 When called interactively, if variable `browse-url-new-window-flag' is
924 non-nil, load the document in a new window, if possible, otherwise use
925 a random existing one. A non-nil interactive prefix argument reverses
926 the effect of `browse-url-new-window-flag'.
928 When called non-interactively, optional second argument NEW-WINDOW is
929 used instead of `browse-url-new-window-flag'."
932 ((memq system-type '(windows-nt ms-dos cygwin))
933 'browse-url-default-windows-browser)
934 ((memq system-type '(darwin))
935 'browse-url-default-macosx-browser)
936 ((browse-url-can-use-xdg-open) 'browse-url-xdg-open)
937 ((executable-find browse-url-gnome-moz-program) 'browse-url-gnome-moz)
938 ((executable-find browse-url-mozilla-program) 'browse-url-mozilla)
939 ((executable-find browse-url-firefox-program) 'browse-url-firefox)
940 ((executable-find browse-url-chromium-program) 'browse-url-chromium)
941 ((executable-find browse-url-galeon-program) 'browse-url-galeon)
942 ((executable-find browse-url-kde-program) 'browse-url-kde)
943 ((executable-find browse-url-netscape-program) 'browse-url-netscape)
944 ((executable-find browse-url-mosaic-program) 'browse-url-mosaic)
945 ((executable-find browse-url-xterm-program) 'browse-url-text-xterm)
946 ((locate-library "w3") 'browse-url-w3)
948 (lambda (&rest _ignore) (error "No usable browser found"))))
951 (defun browse-url-can-use-xdg-open ()
952 "Return non-nil if the \"xdg-open\" program can be used.
953 xdg-open is a desktop utility that calls your preferred web browser.
954 This requires you to be running either Gnome, KDE, Xfce4 or LXDE."
955 (and (getenv "DISPLAY")
956 (executable-find "xdg-open")
957 ;; xdg-open may call gnome-open and that does not wait for its child
958 ;; to finish. This child may then be killed when the parent dies.
959 ;; Use nohup to work around. See bug#7166, bug#8917, bug#9779 and
960 ;; http://lists.gnu.org/archive/html/emacs-devel/2009-07/msg00279.html
961 (executable-find "nohup")
962 (or (getenv "GNOME_DESKTOP_SESSION_ID")
963 ;; GNOME_DESKTOP_SESSION_ID is deprecated, check on Dbus also.
966 "dbus-send" nil nil nil
967 "--dest=org.gnome.SessionManager"
969 "/org/gnome/SessionManager"
970 "org.gnome.SessionManager.CanShutdown"))
972 (equal (getenv "KDE_FULL_SESSION") "true")
975 "/bin/sh" nil nil nil
977 ;; FIXME use string-match rather than grep.
978 "xprop -root _DT_SAVE_MODE|grep xfce4"))
980 (member (getenv "DESKTOP_SESSION") '("LXDE" "Lubuntu"))
981 (equal (getenv "XDG_CURRENT_DESKTOP") "LXDE"))))
985 (defun browse-url-xdg-open (url &optional ignored)
986 "Pass the specified URL to the \"xdg-open\" command.
987 xdg-open is a desktop utility that calls your preferred web browser.
988 The optional argument IGNORED is not used."
989 (interactive (browse-url-interactive-arg "URL: "))
990 (call-process "xdg-open" nil 0 nil url))
993 (defun browse-url-netscape (url &optional new-window)
994 "Ask the Netscape WWW browser to load URL.
995 Default to the URL around or before point. The strings in variable
996 `browse-url-netscape-arguments' are also passed to Netscape.
998 When called interactively, if variable `browse-url-new-window-flag' is
999 non-nil, load the document in a new Netscape window, otherwise use a
1000 random existing one. A non-nil interactive prefix argument reverses
1001 the effect of `browse-url-new-window-flag'.
1003 If `browse-url-netscape-new-window-is-tab' is non-nil, then
1004 whenever a document would otherwise be loaded in a new window, it
1005 is loaded in a new tab in an existing window instead.
1007 When called non-interactively, optional second argument NEW-WINDOW is
1008 used instead of `browse-url-new-window-flag'."
1009 (interactive (browse-url-interactive-arg "URL: "))
1010 (setq url (browse-url-encode-url url))
1011 (let* ((process-environment (browse-url-process-environment))
1013 (apply 'start-process
1014 (concat "netscape " url) nil
1015 browse-url-netscape-program
1017 browse-url-netscape-arguments
1018 (if (eq window-system 'w32)
1021 (if new-window '("-noraise"))
1023 (concat "openURL(" url
1024 (if (browse-url-maybe-new-window
1026 (if browse-url-netscape-new-window-is-tab
1030 (set-process-sentinel process
1031 `(lambda (process change)
1032 (browse-url-netscape-sentinel process ,url)))))
1034 (defun browse-url-netscape-sentinel (process url)
1035 "Handle a change to the process communicating with Netscape."
1036 (or (eq (process-exit-status process) 0)
1037 (let* ((process-environment (browse-url-process-environment)))
1038 ;; Netscape not running - start it
1039 (message "Starting %s..." browse-url-netscape-program)
1040 (apply 'start-process (concat "netscape" url) nil
1041 browse-url-netscape-program
1042 (append browse-url-netscape-startup-arguments (list url))))))
1044 (defun browse-url-netscape-reload ()
1045 "Ask Netscape to reload its current document.
1046 How depends on `browse-url-netscape-version'."
1048 ;; Backwards incompatibility reported by
1049 ;; <peter.kruse@psychologie.uni-regensburg.de>.
1050 (browse-url-netscape-send (if (>= browse-url-netscape-version 4)
1051 "xfeDoCommand(reload)"
1054 (defun browse-url-netscape-send (command)
1055 "Send a remote control command to Netscape."
1056 (let* ((process-environment (browse-url-process-environment)))
1057 (apply 'start-process "netscape" nil
1058 browse-url-netscape-program
1059 (append browse-url-netscape-arguments
1060 (list "-remote" command)))))
1063 (defun browse-url-mozilla (url &optional new-window)
1064 "Ask the Mozilla WWW browser to load URL.
1065 Default to the URL around or before point. The strings in variable
1066 `browse-url-mozilla-arguments' are also passed to Mozilla.
1068 When called interactively, if variable `browse-url-new-window-flag' is
1069 non-nil, load the document in a new Mozilla window, otherwise use a
1070 random existing one. A non-nil interactive prefix argument reverses
1071 the effect of `browse-url-new-window-flag'.
1073 If `browse-url-mozilla-new-window-is-tab' is non-nil, then whenever a
1074 document would otherwise be loaded in a new window, it is loaded in a
1075 new tab in an existing window instead.
1077 When called non-interactively, optional second argument NEW-WINDOW is
1078 used instead of `browse-url-new-window-flag'."
1079 (interactive (browse-url-interactive-arg "URL: "))
1080 (setq url (browse-url-encode-url url))
1081 (let* ((process-environment (browse-url-process-environment))
1083 (apply 'start-process
1084 (concat "mozilla " url) nil
1085 browse-url-mozilla-program
1087 browse-url-mozilla-arguments
1091 (if (browse-url-maybe-new-window
1093 (if browse-url-mozilla-new-window-is-tab
1097 (set-process-sentinel process
1098 `(lambda (process change)
1099 (browse-url-mozilla-sentinel process ,url)))))
1101 (defun browse-url-mozilla-sentinel (process url)
1102 "Handle a change to the process communicating with Mozilla."
1103 (or (eq (process-exit-status process) 0)
1104 (let* ((process-environment (browse-url-process-environment)))
1105 ;; Mozilla is not running - start it
1106 (message "Starting %s..." browse-url-mozilla-program)
1107 (apply 'start-process (concat "mozilla " url) nil
1108 browse-url-mozilla-program
1109 (append browse-url-mozilla-startup-arguments (list url))))))
1112 (defun browse-url-firefox (url &optional new-window)
1113 "Ask the Firefox WWW browser to load URL.
1114 Default to the URL around or before point. The strings in
1115 variable `browse-url-firefox-arguments' are also passed to
1118 When called interactively, if variable
1119 `browse-url-new-window-flag' is non-nil, load the document in a
1120 new Firefox window, otherwise use a random existing one. A
1121 non-nil interactive prefix argument reverses the effect of
1122 `browse-url-new-window-flag'.
1124 If `browse-url-firefox-new-window-is-tab' is non-nil, then
1125 whenever a document would otherwise be loaded in a new window, it
1126 is loaded in a new tab in an existing window instead.
1128 When called non-interactively, optional second argument
1129 NEW-WINDOW is used instead of `browse-url-new-window-flag'.
1131 On MS-Windows systems the optional `new-window' parameter is
1132 ignored. Firefox for Windows does not support the \"-remote\"
1133 command line parameter. Therefore, the
1134 `browse-url-new-window-flag' and `browse-url-firefox-new-window-is-tab'
1135 are ignored as well. Firefox on Windows will always open the requested
1136 URL in a new window."
1137 (interactive (browse-url-interactive-arg "URL: "))
1138 (setq url (browse-url-encode-url url))
1139 (let* ((process-environment (browse-url-process-environment))
1141 (not (memq system-type '(windows-nt ms-dos))))
1143 (apply 'start-process
1144 (concat "firefox " url) nil
1145 browse-url-firefox-program
1147 browse-url-firefox-arguments
1153 (if (browse-url-maybe-new-window new-window)
1154 (if browse-url-firefox-new-window-is-tab
1159 ;; If we use -remote, the process exits with status code 2 if
1160 ;; Firefox is not already running. The sentinel runs firefox
1161 ;; directly if that happens.
1163 (set-process-sentinel process
1164 `(lambda (process change)
1165 (browse-url-firefox-sentinel process ,url))))))
1167 (defun browse-url-firefox-sentinel (process url)
1168 "Handle a change to the process communicating with Firefox."
1169 (or (eq (process-exit-status process) 0)
1170 (let* ((process-environment (browse-url-process-environment)))
1171 ;; Firefox is not running - start it
1172 (message "Starting Firefox...")
1173 (apply 'start-process (concat "firefox " url) nil
1174 browse-url-firefox-program
1175 (append browse-url-firefox-startup-arguments (list url))))))
1178 (defun browse-url-chromium (url &optional _new-window)
1179 "Ask the Chromium WWW browser to load URL.
1180 Default to the URL around or before point. The strings in
1181 variable `browse-url-chromium-arguments' are also passed to
1183 (interactive (browse-url-interactive-arg "URL: "))
1184 (setq url (browse-url-encode-url url))
1185 (let* ((process-environment (browse-url-process-environment)))
1186 (apply 'start-process
1187 (concat "chromium " url) nil
1188 browse-url-chromium-program
1190 browse-url-chromium-arguments
1194 (defun browse-url-galeon (url &optional new-window)
1195 "Ask the Galeon WWW browser to load URL.
1196 Default to the URL around or before point. The strings in variable
1197 `browse-url-galeon-arguments' are also passed to Galeon.
1199 When called interactively, if variable `browse-url-new-window-flag' is
1200 non-nil, load the document in a new Galeon window, otherwise use a
1201 random existing one. A non-nil interactive prefix argument reverses
1202 the effect of `browse-url-new-window-flag'.
1204 If `browse-url-galeon-new-window-is-tab' is non-nil, then whenever a
1205 document would otherwise be loaded in a new window, it is loaded in a
1206 new tab in an existing window instead.
1208 When called non-interactively, optional second argument NEW-WINDOW is
1209 used instead of `browse-url-new-window-flag'."
1210 (interactive (browse-url-interactive-arg "URL: "))
1211 (setq url (browse-url-encode-url url))
1212 (let* ((process-environment (browse-url-process-environment))
1213 (process (apply 'start-process
1214 (concat "galeon " url)
1216 browse-url-galeon-program
1218 browse-url-galeon-arguments
1219 (if (browse-url-maybe-new-window new-window)
1220 (if browse-url-galeon-new-window-is-tab
1222 '("--new-window" "--noraise"))
1225 (set-process-sentinel process
1226 `(lambda (process change)
1227 (browse-url-galeon-sentinel process ,url)))))
1229 (defun browse-url-galeon-sentinel (process url)
1230 "Handle a change to the process communicating with Galeon."
1231 (or (eq (process-exit-status process) 0)
1232 (let* ((process-environment (browse-url-process-environment)))
1233 ;; Galeon is not running - start it
1234 (message "Starting %s..." browse-url-galeon-program)
1235 (apply 'start-process (concat "galeon " url) nil
1236 browse-url-galeon-program
1237 (append browse-url-galeon-startup-arguments (list url))))))
1239 (defun browse-url-epiphany (url &optional new-window)
1240 "Ask the Epiphany WWW browser to load URL.
1241 Default to the URL around or before point. The strings in variable
1242 `browse-url-galeon-arguments' are also passed to Epiphany.
1244 When called interactively, if variable `browse-url-new-window-flag' is
1245 non-nil, load the document in a new Epiphany window, otherwise use a
1246 random existing one. A non-nil interactive prefix argument reverses
1247 the effect of `browse-url-new-window-flag'.
1249 If `browse-url-epiphany-new-window-is-tab' is non-nil, then whenever a
1250 document would otherwise be loaded in a new window, it is loaded in a
1251 new tab in an existing window instead.
1253 When called non-interactively, optional second argument NEW-WINDOW is
1254 used instead of `browse-url-new-window-flag'."
1255 (interactive (browse-url-interactive-arg "URL: "))
1256 (setq url (browse-url-encode-url url))
1257 (let* ((process-environment (browse-url-process-environment))
1258 (process (apply 'start-process
1259 (concat "epiphany " url)
1261 browse-url-epiphany-program
1263 browse-url-epiphany-arguments
1264 (if (browse-url-maybe-new-window new-window)
1265 (if browse-url-epiphany-new-window-is-tab
1267 '("--new-window" "--noraise"))
1270 (set-process-sentinel process
1271 `(lambda (process change)
1272 (browse-url-epiphany-sentinel process ,url)))))
1274 (defun browse-url-epiphany-sentinel (process url)
1275 "Handle a change to the process communicating with Epiphany."
1276 (or (eq (process-exit-status process) 0)
1277 (let* ((process-environment (browse-url-process-environment)))
1278 ;; Epiphany is not running - start it
1279 (message "Starting %s..." browse-url-epiphany-program)
1280 (apply 'start-process (concat "epiphany " url) nil
1281 browse-url-epiphany-program
1282 (append browse-url-epiphany-startup-arguments (list url))))))
1284 (defvar url-handler-regexp)
1287 (defun browse-url-emacs (url &optional _new-window)
1288 "Ask Emacs to load URL into a buffer and show it in another window."
1289 (interactive (browse-url-interactive-arg "URL: "))
1290 (require 'url-handlers)
1291 (let ((file-name-handler-alist
1292 (cons (cons url-handler-regexp 'url-file-handler)
1293 file-name-handler-alist)))
1294 ;; Ignore `new-window': with all other browsers the URL is always shown
1295 ;; in another window than the current Emacs one since it's shown in
1296 ;; another application's window.
1297 ;; (if new-window (find-file-other-window url) (find-file url))
1298 (find-file-other-window url)))
1301 (defun browse-url-gnome-moz (url &optional new-window)
1302 "Ask Mozilla/Netscape to load URL via the GNOME program `gnome-moz-remote'.
1303 Default to the URL around or before point. The strings in variable
1304 `browse-url-gnome-moz-arguments' are also passed.
1306 When called interactively, if variable `browse-url-new-window-flag' is
1307 non-nil, load the document in a new browser window, otherwise use an
1308 existing one. A non-nil interactive prefix argument reverses the
1309 effect of `browse-url-new-window-flag'.
1311 When called non-interactively, optional second argument NEW-WINDOW is
1312 used instead of `browse-url-new-window-flag'."
1313 (interactive (browse-url-interactive-arg "URL: "))
1314 (apply 'start-process (concat "gnome-moz-remote " url)
1316 browse-url-gnome-moz-program
1318 browse-url-gnome-moz-arguments
1319 (if (browse-url-maybe-new-window new-window)
1321 (list "--raise" url))))
1326 (defun browse-url-mosaic (url &optional new-window)
1327 "Ask the XMosaic WWW browser to load URL.
1329 Default to the URL around or before point. The strings in variable
1330 `browse-url-mosaic-arguments' are also passed to Mosaic and the
1331 program is invoked according to the variable
1332 `browse-url-mosaic-program'.
1334 When called interactively, if variable `browse-url-new-window-flag' is
1335 non-nil, load the document in a new Mosaic window, otherwise use a
1336 random existing one. A non-nil interactive prefix argument reverses
1337 the effect of `browse-url-new-window-flag'.
1339 When called non-interactively, optional second argument NEW-WINDOW is
1340 used instead of `browse-url-new-window-flag'."
1341 (interactive (browse-url-interactive-arg "Mosaic URL: "))
1342 (let ((pidfile (expand-file-name browse-url-mosaic-pidfile))
1344 (if (file-readable-p pidfile)
1346 (insert-file-contents pidfile)
1347 (setq pid (read (current-buffer)))))
1348 (if (and (integerp pid) (zerop (signal-process pid 0))) ; Mosaic running
1351 (insert (if (browse-url-maybe-new-window new-window)
1355 (with-file-modes ?\700
1357 (setq pidfile (format "/tmp/Mosaic.%d" pid)))
1358 (delete-file pidfile))
1359 ;; http://debbugs.gnu.org/17428. Use O_EXCL.
1360 (write-region nil nil pidfile nil 'silent nil 'excl)))
1361 ;; Send signal SIGUSR to Mosaic
1362 (message "Signaling Mosaic...")
1363 (signal-process pid 'SIGUSR1)
1364 ;; Or you could try:
1365 ;; (call-process "kill" nil 0 nil "-USR1" (int-to-string pid))
1366 (message "Signaling Mosaic...done"))
1367 ;; Mosaic not running - start it
1368 (message "Starting %s..." browse-url-mosaic-program)
1369 (apply 'start-process "xmosaic" nil browse-url-mosaic-program
1370 (append browse-url-mosaic-arguments (list url)))
1371 (message "Starting %s...done" browse-url-mosaic-program))))
1373 ;; --- Mosaic using CCI ---
1376 (defun browse-url-cci (url &optional new-window)
1377 "Ask the XMosaic WWW browser to load URL.
1378 Default to the URL around or before point.
1380 This function only works for XMosaic version 2.5 or later. You must
1381 select `CCI' from XMosaic's File menu, set the CCI Port Address to the
1382 value of variable `browse-url-CCI-port', and enable `Accept requests'.
1384 When called interactively, if variable `browse-url-new-window-flag' is
1385 non-nil, load the document in a new browser window, otherwise use a
1386 random existing one. A non-nil interactive prefix argument reverses
1387 the effect of `browse-url-new-window-flag'.
1389 When called non-interactively, optional second argument NEW-WINDOW is
1390 used instead of `browse-url-new-window-flag'."
1391 (interactive (browse-url-interactive-arg "Mosaic URL: "))
1392 (open-network-stream "browse-url" " *browse-url*"
1393 browse-url-CCI-host browse-url-CCI-port)
1394 ;; Todo: start browser if fails
1395 (process-send-string "browse-url"
1396 (concat "get url (" url ") output "
1397 (if (browse-url-maybe-new-window new-window)
1401 (process-send-string "browse-url" "disconnect\r\n")
1402 (delete-process "browse-url"))
1407 (declare-function w3-fetch-other-window "ext:w3m" (&optional url))
1408 (declare-function w3-fetch "ext:w3m" (&optional url target))
1411 (defun browse-url-w3 (url &optional new-window)
1412 "Ask the w3 WWW browser to load URL.
1413 Default to the URL around or before point.
1415 When called interactively, if variable `browse-url-new-window-flag' is
1416 non-nil, load the document in a new window. A non-nil interactive
1417 prefix argument reverses the effect of `browse-url-new-window-flag'.
1419 When called non-interactively, optional second argument NEW-WINDOW is
1420 used instead of `browse-url-new-window-flag'."
1421 (interactive (browse-url-interactive-arg "W3 URL: "))
1422 (require 'w3) ; w3-fetch-other-window not autoloaded
1423 (if (browse-url-maybe-new-window new-window)
1424 (w3-fetch-other-window url)
1428 (defun browse-url-w3-gnudoit (url &optional _new-window)
1429 ;; new-window ignored
1430 "Ask another Emacs running gnuserv to load the URL using the W3 browser.
1431 The `browse-url-gnudoit-program' program is used with options given by
1432 `browse-url-gnudoit-args'. Default to the URL around or before point."
1433 (interactive (browse-url-interactive-arg "W3 URL: "))
1434 (apply 'start-process (concat "gnudoit:" url) nil
1435 browse-url-gnudoit-program
1436 (append browse-url-gnudoit-args
1437 (list (concat "(w3-fetch \"" url "\")")
1440 ;; --- Lynx in an xterm ---
1443 (defun browse-url-text-xterm (url &optional _new-window)
1444 ;; new-window ignored
1445 "Ask a text browser to load URL.
1446 URL defaults to the URL around or before point.
1447 This runs the text browser specified by `browse-url-text-browser'.
1448 in an Xterm window using the Xterm program named by `browse-url-xterm-program'
1449 with possible additional arguments `browse-url-xterm-args'."
1450 (interactive (browse-url-interactive-arg "Text browser URL: "))
1451 (apply #'start-process `(,(concat browse-url-text-browser url)
1452 nil ,browse-url-xterm-program
1453 ,@browse-url-xterm-args "-e" ,browse-url-text-browser
1456 ;; --- Lynx in an Emacs "term" window ---
1458 (declare-function term-char-mode "term" ())
1459 (declare-function term-send-down "term" ())
1460 (declare-function term-send-string "term" (proc str))
1463 (defun browse-url-text-emacs (url &optional new-buffer)
1464 "Ask a text browser to load URL.
1465 URL defaults to the URL around or before point.
1466 This runs the text browser specified by `browse-url-text-browser'.
1467 With a prefix argument, it runs a new browser process in a new buffer.
1469 When called interactively, if variable `browse-url-new-window-flag' is
1470 non-nil, load the document in a new browser process in a new term window,
1471 otherwise use any existing one. A non-nil interactive prefix argument
1472 reverses the effect of `browse-url-new-window-flag'.
1474 When called non-interactively, optional second argument NEW-WINDOW is
1475 used instead of `browse-url-new-window-flag'."
1476 (interactive (browse-url-interactive-arg "Text browser URL: "))
1477 (let* ((system-uses-terminfo t) ; Lynx uses terminfo
1478 ;; (term-term-name "vt100") ; ??
1479 (buf (get-buffer "*text browser*"))
1480 (proc (and buf (get-buffer-process buf)))
1481 (n browse-url-text-input-attempts))
1483 (if (and (browse-url-maybe-new-window new-buffer) buf)
1484 ;; Rename away the OLD buffer. This isn't very polite, but
1485 ;; term insists on working in a buffer named *lynx* and would
1486 ;; choke on *lynx*<1>
1487 (progn (set-buffer buf)
1489 (if (or (browse-url-maybe-new-window new-buffer)
1492 (not (memq (process-status proc) '(run stop))))
1493 ;; start a new text browser
1497 `(,browse-url-text-browser
1498 ,browse-url-text-browser
1499 nil ,@browse-url-text-emacs-args
1501 (switch-to-buffer buf)
1503 (set-process-sentinel
1504 (get-buffer-process buf)
1505 ;; Don't leave around a dead one (especially because of its
1507 (lambda (process _event)
1508 (if (not (memq (process-status process) '(run stop)))
1509 (let ((buf (process-buffer process)))
1510 (if buf (kill-buffer buf)))))))
1511 ;; Send the url to the text browser in the old buffer
1512 (let ((win (get-buffer-window buf t)))
1515 (switch-to-buffer buf)))
1516 (if (eq (following-char) ?_)
1517 (cond ((eq browse-url-text-input-field 'warn)
1518 (error "Please move out of the input field first"))
1519 ((eq browse-url-text-input-field 'avoid)
1520 (while (and (eq (following-char) ?_) (> n 0))
1521 (term-send-down) ; down arrow
1522 (sit-for browse-url-text-input-delay))
1523 (if (eq (following-char) ?_)
1524 (error "Cannot move out of the input field, sorry")))))
1525 (term-send-string proc (concat "g" ; goto
1526 "\C-u" ; kill default url
1532 (autoload 'rfc2368-parse-mailto-url "rfc2368")
1535 (defun browse-url-mail (url &optional new-window)
1536 "Open a new mail message buffer within Emacs for the RFC 2368 URL.
1537 Default to using the mailto: URL around or before point as the
1538 recipient's address. Supplying a non-nil interactive prefix argument
1539 will cause the mail to be composed in another window rather than the
1542 When called interactively, if variable `browse-url-new-window-flag' is
1543 non-nil use `compose-mail-other-window', otherwise `compose-mail'. A
1544 non-nil interactive prefix argument reverses the effect of
1545 `browse-url-new-window-flag'.
1547 When called non-interactively, optional second argument NEW-WINDOW is
1548 used instead of `browse-url-new-window-flag'."
1549 (interactive (browse-url-interactive-arg "Mailto URL: "))
1551 (let* ((alist (rfc2368-parse-mailto-url url))
1552 (to (assoc "To" alist))
1553 (subject (assoc "Subject" alist))
1554 (body (assoc "Body" alist))
1555 (rest (delq to (delq subject (delq body alist))))
1557 (subject (cdr subject))
1559 (mail-citation-hook (unless body mail-citation-hook)))
1560 (if (browse-url-maybe-new-window new-window)
1561 (compose-mail-other-window to subject rest nil
1562 (list 'insert-buffer (current-buffer)))
1563 (compose-mail to subject rest nil nil
1564 (list 'insert-buffer (current-buffer))))
1566 (goto-char (point-min))
1567 (unless (or (search-forward (concat "\n" mail-header-separator "\n")
1573 (insert (replace-regexp-in-string "\r\n" "\n" body))
1575 (insert "\n"))))))))
1577 ;; --- Random browser ---
1580 (defun browse-url-generic (url &optional _new-window)
1581 ;; new-window ignored
1582 "Ask the WWW browser defined by `browse-url-generic-program' to load URL.
1583 Default to the URL around or before point. A fresh copy of the
1584 browser is started up in a new process with possible additional arguments
1585 `browse-url-generic-args'. This is appropriate for browsers which
1586 don't offer a form of remote control."
1587 (interactive (browse-url-interactive-arg "URL: "))
1588 (if (not browse-url-generic-program)
1589 (error "No browser defined (`browse-url-generic-program')"))
1590 (apply 'call-process browse-url-generic-program nil
1592 (append browse-url-generic-args (list url))))
1595 (defun browse-url-kde (url &optional _new-window)
1596 "Ask the KDE WWW browser to load URL.
1597 Default to the URL around or before point."
1598 (interactive (browse-url-interactive-arg "KDE URL: "))
1599 (message "Sending URL to KDE...")
1600 (apply #'start-process (concat "KDE " url) nil browse-url-kde-program
1601 (append browse-url-kde-args (list url))))
1603 (defun browse-url-elinks-new-window (url)
1604 "Ask the Elinks WWW browser to load URL in a new window."
1605 (let ((process-environment (browse-url-process-environment)))
1606 (apply #'start-process
1607 (append (list (concat "elinks:" url)
1609 browse-url-elinks-wrapper
1610 (list "elinks" url)))))
1613 (defun browse-url-elinks (url &optional new-window)
1614 "Ask the Elinks WWW browser to load URL.
1615 Default to the URL around the point.
1617 The document is loaded in a new tab of a running Elinks or, if
1618 none yet running, a newly started instance.
1620 The Elinks command will be prepended by the program+arguments
1621 from `browse-url-elinks-wrapper'."
1622 (interactive (browse-url-interactive-arg "URL: "))
1623 (setq url (browse-url-encode-url url))
1625 (browse-url-elinks-new-window url)
1626 (let ((process-environment (browse-url-process-environment))
1627 (elinks-ping-process (start-process "elinks-ping" nil
1628 "elinks" "-remote" "ping()")))
1629 (set-process-sentinel elinks-ping-process
1630 `(lambda (process change)
1631 (browse-url-elinks-sentinel process ,url))))))
1633 (defun browse-url-elinks-sentinel (process url)
1634 "Determines if Elinks is running or a new one has to be started."
1635 ;; Try to determine if an instance is running or if we have to
1636 ;; create a new one.
1637 (pcase (process-exit-status process)
1639 ;; No instance, start a new one.
1640 (browse-url-elinks-new-window url))
1642 ;; Found an instance, open URL in new tab.
1643 (let ((process-environment (browse-url-process-environment)))
1644 (start-process (concat "elinks:" url) nil
1646 (concat "openURL(\"" url "\",new-tab)"))))
1648 (error "Unrecognized exit-code %d of process `elinks'"
1651 (provide 'browse-url)
1653 ;;; browse-url.el ends here