1 ;;; browse-url.el --- pass a URL to a WWW browser
3 ;; Copyright (C) 1995-2011 Free Software Foundation, Inc.
5 ;; Author: Denis Howe <dbh@doc.ic.ac.uk>
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 generalises 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 ~/.emacs
127 ;; (global-set-key [S-mouse-2] 'browse-url-at-mouse)
128 ;; (Note that using Shift-mouse-1 is not desirable because
129 ;; that event has a standard meaning in Emacs.)
131 ;; To display the current buffer in a web browser:
132 ;; M-x browse-url-of-buffer RET
134 ;; To display the current region in a web browser:
135 ;; M-x browse-url-of-region RET
137 ;; In Dired, to display the file named on the current line:
138 ;; M-x browse-url-of-dired-file RET
140 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
141 ;; Customisation (~/.emacs)
143 ;; To see what variables are available for customization, type
144 ;; `M-x set-variable browse-url TAB'. Better, use
145 ;; `M-x customize-group browse-url'.
147 ;; Bind the browse-url commands to keys with the `C-c C-z' prefix
148 ;; (as used by html-helper-mode):
149 ;; (global-set-key "\C-c\C-z." 'browse-url-at-point)
150 ;; (global-set-key "\C-c\C-zb" 'browse-url-of-buffer)
151 ;; (global-set-key "\C-c\C-zr" 'browse-url-of-region)
152 ;; (global-set-key "\C-c\C-zu" 'browse-url)
153 ;; (global-set-key "\C-c\C-zv" 'browse-url-of-file)
154 ;; (add-hook 'dired-mode-hook
156 ;; (local-set-key "\C-c\C-zf" 'browse-url-of-dired-file)))
158 ;; Browse URLs in mail messages under RMAIL by clicking mouse-2:
159 ;; (add-hook 'rmail-mode-hook (lambda () ; rmail-mode startup
160 ;; (define-key rmail-mode-map [mouse-2] 'browse-url-at-mouse)))
161 ;; Alternatively, add `goto-address' to `rmail-show-message-hook'.
163 ;; Gnus provides a standard feature to activate URLs in article
164 ;; buffers for invocation of browse-url.
166 ;; Use the Emacs w3 browser when not running under X11:
167 ;; (or (eq window-system 'x)
168 ;; (setq browse-url-browser-function 'browse-url-w3))
170 ;; To always save modified buffers before displaying the file in a browser:
171 ;; (setq browse-url-save-file t)
173 ;; To get round the Netscape caching problem, you could EITHER have
174 ;; write-file in html-helper-mode make Netscape reload the document:
176 ;; (autoload 'browse-url-netscape-reload "browse-url"
177 ;; "Ask a WWW browser to redisplay the current file." t)
178 ;; (add-hook 'html-helper-mode-hook
180 ;; (add-hook 'local-write-file-hooks
182 ;; (let ((local-write-file-hooks))
184 ;; (browse-url-netscape-reload)
185 ;; t) ; => file written by hook
186 ;; t))) ; append to l-w-f-hooks
188 ;; OR have browse-url-of-file ask Netscape to load and then reload the
191 ;; (add-hook 'browse-url-of-file-hook 'browse-url-netscape-reload)
193 ;; You may also want to customise browse-url-netscape-arguments, e.g.
194 ;; (setq browse-url-netscape-arguments '("-install"))
196 ;; or similarly for the other browsers.
198 ;; To invoke different browsers for different URLs:
199 ;; (setq browse-url-browser-function '(("^mailto:" . browse-url-mail)
200 ;; ("." . browse-url-netscape)))
202 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
205 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
208 (eval-when-compile (require 'cl))
210 (defgroup browse-url nil
211 "Use a web browser to look at a URL."
212 :prefix "browse-url-"
213 :link '(emacs-commentary-link "browse-url")
218 (defcustom browse-url-browser-function
219 'browse-url-default-browser
220 "Function to display the current buffer in a WWW browser.
221 This is used by the `browse-url-at-point', `browse-url-at-mouse', and
222 `browse-url-of-file' commands.
224 If the value is not a function it should be a list of pairs
225 \(REGEXP . FUNCTION). In this case the function called will be the one
226 associated with the first REGEXP which matches the current URL. The
227 function is passed the URL and any other args of `browse-url'. The last
228 regexp should probably be \".\" to specify a default browser."
230 (function-item :tag "Emacs W3" :value browse-url-w3)
231 (function-item :tag "W3 in another Emacs via `gnudoit'"
232 :value browse-url-w3-gnudoit)
233 (function-item :tag "Mozilla" :value browse-url-mozilla)
234 (function-item :tag "Firefox" :value browse-url-firefox)
235 (function-item :tag "Chromium" :value browse-url-chromium)
236 (function-item :tag "Galeon" :value browse-url-galeon)
237 (function-item :tag "Epiphany" :value browse-url-epiphany)
238 (function-item :tag "Netscape" :value browse-url-netscape)
239 (function-item :tag "Mosaic" :value browse-url-mosaic)
240 (function-item :tag "Mosaic using CCI" :value browse-url-cci)
241 (function-item :tag "Text browser in an xterm window"
242 :value browse-url-text-xterm)
243 (function-item :tag "Text browser in an Emacs window"
244 :value browse-url-text-emacs)
245 (function-item :tag "KDE" :value browse-url-kde)
246 (function-item :tag "Elinks" :value browse-url-elinks)
247 (function-item :tag "Specified by `Browse Url Generic Program'"
248 :value browse-url-generic)
249 (function-item :tag "Default Windows browser"
250 :value browse-url-default-windows-browser)
251 (function-item :tag "Default Mac OS X browser"
252 :value browse-url-default-macosx-browser)
253 (function-item :tag "GNOME invoking Mozilla"
254 :value browse-url-gnome-moz)
255 (function-item :tag "Default browser"
256 :value browse-url-default-browser)
257 (function :tag "Your own function")
258 (alist :tag "Regexp/function association list"
259 :key-type regexp :value-type function))
263 (defcustom browse-url-mailto-function 'browse-url-mail
264 "Function to display mailto: links.
265 This variable uses the same syntax as the
266 `browse-url-browser-function' variable. If the
267 `browse-url-mailto-function' variable is nil, that variable will
270 (function-item :tag "Emacs Mail" :value browse-url-mail)
271 (function-item :tag "None" nil))
275 (defcustom browse-url-netscape-program "netscape"
276 ;; Info about netscape-remote from Karl Berry.
277 "The name by which to invoke Netscape.
279 The free program `netscape-remote' from
280 <URL:http://home.netscape.com/newsref/std/remote.c> is said to start
281 up very much quicker than `netscape'. Reported to compile on a GNU
282 system, given vroot.h from the same directory, with cc flags
283 -DSTANDALONE -L/usr/X11R6/lib -lXmu -lX11."
287 (defcustom browse-url-netscape-arguments nil
288 "A list of strings to pass to Netscape as arguments."
289 :type '(repeat (string :tag "Argument"))
292 (defcustom browse-url-netscape-startup-arguments browse-url-netscape-arguments
293 "A list of strings to pass to Netscape when it starts up.
294 Defaults to the value of `browse-url-netscape-arguments' at the time
295 `browse-url' is loaded."
296 :type '(repeat (string :tag "Argument"))
299 (defcustom browse-url-browser-display nil
300 "The X display for running the browser, if not same as Emacs'."
301 :type '(choice string (const :tag "Default" nil))
304 (defcustom browse-url-mozilla-program "mozilla"
305 "The name by which to invoke Mozilla."
309 (defcustom browse-url-mozilla-arguments nil
310 "A list of strings to pass to Mozilla as arguments."
311 :type '(repeat (string :tag "Argument"))
314 (defcustom browse-url-mozilla-startup-arguments browse-url-mozilla-arguments
315 "A list of strings to pass to Mozilla when it starts up.
316 Defaults to the value of `browse-url-mozilla-arguments' at the time
317 `browse-url' is loaded."
318 :type '(repeat (string :tag "Argument"))
321 (defcustom browse-url-firefox-program
322 (let ((candidates '("firefox" "iceweasel" "icecat")))
323 (while (and candidates (not (executable-find (car candidates))))
324 (setq candidates (cdr candidates)))
325 (or (car candidates) "firefox"))
326 "The name by which to invoke Firefox."
330 (defcustom browse-url-firefox-arguments nil
331 "A list of strings to pass to Firefox as arguments."
332 :type '(repeat (string :tag "Argument"))
335 (defcustom browse-url-firefox-startup-arguments browse-url-firefox-arguments
336 "A list of strings to pass to Firefox when it starts up.
337 Defaults to the value of `browse-url-firefox-arguments' at the time
338 `browse-url' is loaded."
339 :type '(repeat (string :tag "Argument"))
342 (defcustom browse-url-chromium-program
343 (let ((candidates '("chromium" "chromium-browser")))
344 (while (and candidates (not (executable-find (car candidates))))
345 (setq candidates (cdr candidates)))
346 (or (car candidates) "chromium"))
347 "The name by which to invoke Chromium."
352 (defcustom browse-url-chromium-arguments nil
353 "A list of strings to pass to Chromium as arguments."
354 :type '(repeat (string :tag "Argument"))
358 (defcustom browse-url-galeon-program "galeon"
359 "The name by which to invoke Galeon."
363 (defcustom browse-url-galeon-arguments nil
364 "A list of strings to pass to Galeon as arguments."
365 :type '(repeat (string :tag "Argument"))
368 (defcustom browse-url-galeon-startup-arguments browse-url-galeon-arguments
369 "A list of strings to pass to Galeon when it starts up.
370 Defaults to the value of `browse-url-galeon-arguments' at the time
371 `browse-url' is loaded."
372 :type '(repeat (string :tag "Argument"))
375 (defcustom browse-url-epiphany-program "epiphany"
376 "The name by which to invoke Epiphany."
380 (defcustom browse-url-epiphany-arguments nil
381 "A list of strings to pass to Epiphany as arguments."
382 :type '(repeat (string :tag "Argument"))
385 (defcustom browse-url-epiphany-startup-arguments browse-url-epiphany-arguments
386 "A list of strings to pass to Epiphany when it starts up.
387 Defaults to the value of `browse-url-epiphany-arguments' at the time
388 `browse-url' is loaded."
389 :type '(repeat (string :tag "Argument"))
392 ;; GNOME means of invoking either Mozilla or Netrape.
393 (defvar browse-url-gnome-moz-program "gnome-moz-remote")
395 (defcustom browse-url-gnome-moz-arguments '()
396 "A list of strings passed to the GNOME mozilla viewer as arguments."
398 :type '(repeat (string :tag "Argument"))
401 (defcustom browse-url-mozilla-new-window-is-tab nil
402 "Whether to open up new windows in a tab or a new window.
403 If non-nil, then open the URL in a new tab rather than a new window if
404 `browse-url-mozilla' is asked to open it in a new window."
408 (defcustom browse-url-firefox-new-window-is-tab nil
409 "Whether to open up new windows in a tab or a new window.
410 If non-nil, then open the URL in a new tab rather than a new window if
411 `browse-url-firefox' is asked to open it in a new window.
413 This option is currently ignored on MS-Windows, since the necessary
414 functionality is not available there."
418 (defcustom browse-url-galeon-new-window-is-tab nil
419 "Whether to open up new windows in a tab or a new window.
420 If non-nil, then open the URL in a new tab rather than a new window if
421 `browse-url-galeon' is asked to open it in a new window."
425 (defcustom browse-url-epiphany-new-window-is-tab nil
426 "Whether to open up new windows in a tab or a new window.
427 If non-nil, then open the URL in a new tab rather than a new window if
428 `browse-url-epiphany' is asked to open it in a new window."
432 (defcustom browse-url-netscape-new-window-is-tab nil
433 "Whether to open up new windows in a tab or a new window.
434 If non-nil, then open the URL in a new tab rather than a new
435 window if `browse-url-netscape' is asked to open it in a new
440 (defcustom browse-url-new-window-flag nil
441 "Non-nil means always open a new browser window with appropriate browsers.
442 Passing an interactive argument to \\[browse-url], or specific browser
443 commands reverses the effect of this variable. Requires Netscape version
444 1.1N or later or XMosaic version 2.5 or later if using those browsers."
448 (defcustom browse-url-mosaic-program "xmosaic"
449 "The name by which to invoke Mosaic (or mMosaic)."
454 (defcustom browse-url-mosaic-arguments nil
455 "A list of strings to pass to Mosaic as arguments."
456 :type '(repeat (string :tag "Argument"))
459 (defcustom browse-url-mosaic-pidfile "~/.mosaicpid"
460 "The name of the pidfile created by Mosaic."
464 (defcustom browse-url-filename-alist
465 `(("^/\\(ftp@\\|anonymous@\\)?\\([^:]+\\):/*" . "ftp://\\2/")
466 ;; The above loses the username to avoid the browser prompting for
467 ;; it in anonymous cases. If it's not anonymous the next regexp
469 ("^/\\([^:@]+@\\)?\\([^:]+\\):/*" . "ftp://\\1\\2/")
470 ,@(if (memq system-type '(windows-nt ms-dos cygwin))
471 '(("^\\([a-zA-Z]:\\)[\\/]" . "file:///\\1/")
472 ("^[\\/][\\/]+" . "file://")))
473 ("^/+" . "file:///"))
474 "An alist of (REGEXP . STRING) pairs used by `browse-url-of-file'.
475 Any substring of a filename matching one of the REGEXPs is replaced by
476 the corresponding STRING using `replace-match', not treating STRING
477 literally. All pairs are applied in the order given. The default
478 value converts ange-ftp/EFS-style file names into ftp URLs and prepends
479 `file:' to any file name beginning with `/'.
481 For example, adding to the default a specific translation of an ange-ftp
482 address to an HTTP URL:
484 (setq browse-url-filename-alist
485 '((\"/webmaster@webserver:/home/www/html/\" .
486 \"http://www.acme.co.uk/\")
487 (\"^/\\(ftp@\\|anonymous@\\)?\\([^:]+\\):/*\" . \"ftp://\\2/\")
488 (\"^/\\([^:@]+@\\)?\\([^:]+\\):/*\" . \"ftp://\\1\\2/\")
489 (\"^/+\" . \"file:/\")))"
490 :type '(repeat (cons :format "%v"
491 (regexp :tag "Regexp")
492 (string :tag "Replacement")))
496 (defcustom browse-url-save-file nil
497 "If non-nil, save the buffer before displaying its file.
498 Used by the `browse-url-of-file' command."
502 (defcustom browse-url-of-file-hook nil
503 "Run after `browse-url-of-file' has asked a browser to load a file.
505 Set this to `browse-url-netscape-reload' to force Netscape to load the
506 file rather than displaying a cached copy."
508 :options '(browse-url-netscape-reload)
511 (defcustom browse-url-CCI-port 3003
512 "Port to access XMosaic via CCI.
513 This can be any number between 1024 and 65535 but must correspond to
514 the value set in the browser."
518 (defcustom browse-url-CCI-host "localhost"
519 "Host to access XMosaic via CCI.
520 This should be the host name of the machine running XMosaic with CCI
521 enabled. The port number should be set in `browse-url-CCI-port'."
525 (defvar browse-url-temp-file-name nil)
526 (make-variable-buffer-local 'browse-url-temp-file-name)
528 (defcustom browse-url-xterm-program "xterm"
529 "The name of the terminal emulator used by `browse-url-text-xterm'.
530 This might, for instance, be a separate color version of xterm."
534 (defcustom browse-url-xterm-args nil
535 "A list of strings defining options for `browse-url-xterm-program'.
536 These might set its size, for instance."
537 :type '(repeat (string :tag "Argument"))
540 (defcustom browse-url-gnudoit-program "gnudoit"
541 "The name of the `gnudoit' program used by `browse-url-w3-gnudoit'."
545 (defcustom browse-url-gnudoit-args '("-q")
546 "A list of strings defining options for `browse-url-gnudoit-program'.
547 These might set the port, for instance."
548 :type '(repeat (string :tag "Argument"))
551 (defcustom browse-url-generic-program nil
552 "The name of the browser program used by `browse-url-generic'."
553 :type '(choice string (const :tag "None" nil))
556 (defcustom browse-url-generic-args nil
557 "A list of strings defining options for `browse-url-generic-program'."
558 :type '(repeat (string :tag "Argument"))
561 (defcustom browse-url-temp-dir temporary-file-directory
562 "The name of a directory for browse-url's temporary files.
563 Such files are generated by functions like `browse-url-of-region'.
564 You might want to set this to somewhere with restricted read permissions
569 (defcustom browse-url-netscape-version 3
570 "The version of Netscape you are using.
571 This affects how URL reloading is done; the mechanism changed
572 incompatibly at version 4."
576 (defcustom browse-url-text-browser "lynx"
577 "The name of the text browser to invoke."
582 (defcustom browse-url-text-emacs-args (and (not window-system)
584 "A list of strings defining options for a text browser in an Emacs buffer.
586 The default is none in a window system, otherwise `-show_cursor' to
587 indicate the position of the current link in the absence of
588 highlighting, assuming the normal default for showing the cursor."
589 :type '(repeat (string :tag "Argument"))
593 (defcustom browse-url-text-input-field 'avoid
594 "Action on selecting an existing text browser buffer at an input field.
595 What to do when sending a new URL to an existing text browser buffer in Emacs
596 if the browser cursor is on an input field (in which case the `g' command
597 would be entered as data). Such fields are recognized by the
598 underlines ____. Allowed values: nil: disregard it, `warn': warn the
599 user and don't emit the URL, `avoid': try to avoid the field by moving
600 down (this *won't* always work)."
601 :type '(choice (const :tag "Move to try to avoid field" :value avoid)
602 (const :tag "Disregard" :value nil)
603 (const :tag "Warn, don't emit URL" :value warn))
607 (defcustom browse-url-text-input-attempts 10
608 "How many times to try to move down from a series of text browser input fields."
613 (defcustom browse-url-text-input-delay 0.2
614 "Seconds to wait for a text browser between moves down from an input field."
619 (defcustom browse-url-kde-program "kfmclient"
620 "The name by which to invoke the KDE web browser."
625 (defcustom browse-url-kde-args '("openURL")
626 "A list of strings defining options for `browse-url-kde-program'."
627 :type '(repeat (string :tag "Argument"))
630 (defcustom browse-url-elinks-wrapper '("xterm" "-e")
631 "Wrapper command prepended to the Elinks command-line."
632 :type '(repeat (string :tag "Wrapper"))
635 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
638 (defun browse-url-url-encode-chars (text chars)
639 "URL-encode the chars in TEXT that match CHARS.
640 CHARS is a regexp-like character alternative (e.g., \"[)$]\")."
641 (let ((encoded-text (copy-sequence text))
643 (while (setq s (string-match chars encoded-text s))
645 (replace-match (format "%%%x"
646 (string-to-char (match-string 0 encoded-text)))
651 (defun browse-url-encode-url (url)
652 "Escape annoying characters in URL.
653 The annoying characters are those that can mislead a web browser
654 regarding its parameter treatment."
655 ;; FIXME: Is there an actual example of a web browser getting
656 ;; confused? (This used to encode commas, but at least Firefox
657 ;; handles commas correctly and doesn't accept encoded commas.)
658 (browse-url-url-encode-chars url "[)$]"))
660 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
663 (defun browse-url-url-at-point ()
664 (let ((url (thing-at-point 'url)))
665 (set-text-properties 0 (length url) nil url)
668 ;; Having this as a separate function called by the browser-specific
669 ;; functions allows them to be stand-alone commands, making it easier
670 ;; to switch between browsers.
672 (defun browse-url-interactive-arg (prompt)
673 "Read a URL from the minibuffer, prompting with PROMPT.
674 If `transient-mark-mode' is non-nil and the mark is active,
675 it defaults to the current region, else to the URL at or before
676 point. If invoked with a mouse button, it moves point to the
677 position clicked before acting.
679 This function returns a list (URL NEW-WINDOW-FLAG)
680 for use in `interactive'."
681 (let ((event (elt (this-command-keys) 0)))
682 (and (listp event) (mouse-set-point event)))
683 (list (read-string prompt (or (and transient-mark-mode mark-active
684 ;; rfc2396 Appendix E.
685 (replace-regexp-in-string
687 (buffer-substring-no-properties
688 (region-beginning) (region-end))))
689 (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 ;; De-munge Cygwin filenames before passing them to Windows browser.
728 (if (eq system-type 'cygwin)
729 (let ((winfile (with-output-to-string
730 (call-process "cygpath" nil standard-output
732 (setq file (substring winfile 0 -1))))
733 (let ((coding (and (default-value 'enable-multibyte-characters)
734 (or file-name-coding-system
735 default-file-name-coding-system))))
736 (if coding (setq file (encode-coding-string file coding))))
737 (setq file (browse-url-url-encode-chars file "[*\"()',=;?% ]"))
738 (dolist (map browse-url-filename-alist)
739 (when (and map (string-match (car map) file))
740 (setq file (replace-match (cdr map) t nil file))))
744 (defun browse-url-of-buffer (&optional buffer)
745 "Ask a WWW browser to display BUFFER.
746 Display the current buffer if BUFFER is nil. Display only the
747 currently visible part of BUFFER (from a temporary file) if buffer is
751 (and buffer (set-buffer buffer))
753 ;; Ignore real name if restricted
754 (and (= (- (point-max) (point-min)) (buffer-size))
756 (and (boundp 'dired-directory) dired-directory)))))
759 (or browse-url-temp-file-name
760 (setq browse-url-temp-file-name
761 (convert-standard-filename
763 (expand-file-name "burl" browse-url-temp-dir)
765 (setq file-name browse-url-temp-file-name)
766 (write-region (point-min) (point-max) file-name nil 'no-message)))
767 (browse-url-of-file file-name))))
769 (defun browse-url-delete-temp-file (&optional temp-file-name)
770 ;; Delete browse-url-temp-file-name from the file system
771 ;; If optional arg TEMP-FILE-NAME is non-nil, delete it instead
772 (let ((file-name (or temp-file-name browse-url-temp-file-name)))
773 (if (and file-name (file-exists-p file-name))
774 (delete-file file-name))))
776 (add-hook 'kill-buffer-hook 'browse-url-delete-temp-file)
778 (declare-function dired-get-filename "dired"
779 (&optional localp no-error-if-not-filep))
782 (defun browse-url-of-dired-file ()
783 "In Dired, ask a WWW browser to display the file named on this line."
785 (let ((tem (dired-get-filename t t)))
787 (browse-url-of-file (expand-file-name tem))
788 (error "No file on this line"))))
791 (defun browse-url-of-region (min max)
792 "Ask a WWW browser to display the current region."
796 (narrow-to-region min max)
797 (browse-url-of-buffer))))
799 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
800 ;; Browser-independent commands
802 (defun url-tidy (url)
803 "Tidy up URL as much as possible."
804 (if (equal 0 (string-match ".*://" url))
806 (concat "http://" url) ;;TODO guess more url forms, like mailto
809 ;; A generic command to call the current browse-url-browser-function
812 (defun browse-url (url &rest args)
813 "Ask a WWW browser to load URL.
814 Prompts for a URL, defaulting to the URL at or before point. Variable
815 `browse-url-browser-function' says which browser to use.
816 If the URL is a mailto: URL, consult `browse-url-mailto-function'
817 first, if that exists."
818 (interactive (browse-url-interactive-arg "URL: "))
819 (unless (called-interactively-p 'interactive)
820 (setq args (or args (list browse-url-new-window-flag))))
821 (setq url (url-tidy url))
822 (let ((process-environment (copy-sequence process-environment))
823 (function (or (and (string-match "\\`mailto:" url)
824 browse-url-mailto-function)
825 browse-url-browser-function))
826 ;; Ensure that `default-directory' exists and is readable (b#6077).
827 (default-directory (if (and (file-directory-p default-directory)
828 (file-readable-p default-directory))
830 (expand-file-name "~/"))))
831 ;; When connected to various displays, be careful to use the display of
832 ;; the currently selected frame, rather than the original start display,
833 ;; which may not even exist any more.
834 (if (stringp (frame-parameter (selected-frame) 'display))
835 (setenv "DISPLAY" (frame-parameter (selected-frame) 'display)))
836 (if (and (consp function)
837 (not (functionp function)))
838 ;; The `function' can be an alist; look down it for first match
839 ;; and apply the function (which might be a lambda).
841 (dolist (bf function)
842 (when (string-match (car bf) url)
843 (apply (cdr bf) url args)
845 (error "No browse-url-browser-function matching URL %s"
847 ;; Unbound symbols go down this leg, since void-function from
848 ;; apply is clearer than wrong-type-argument from dolist.
849 (apply function url args))))
852 (defun browse-url-at-point (&optional arg)
853 "Ask a WWW browser to load the URL at or before point.
854 Doesn't let you edit the URL like `browse-url'. Variable
855 `browse-url-browser-function' says which browser to use."
857 (let ((url (browse-url-url-at-point)))
859 (browse-url url (if arg
860 (not browse-url-new-window-flag)
861 browse-url-new-window-flag))
862 (error "No URL found"))))
865 (defun browse-url-at-mouse (event)
866 "Ask a WWW browser to load a URL clicked with the mouse.
867 The URL is the one around or before the position of the mouse click
868 but point is not changed. Doesn't let you edit the URL like
869 `browse-url'. Variable `browse-url-browser-function' says which browser
873 (mouse-set-point event)
874 ;; This handles browse-url-new-window-flag properly
875 ;; when it gets no arg.
876 (browse-url-at-point)))
878 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
879 ;; Browser-specific commands
881 ;; --- Default MS-Windows browser ---
883 (defvar dos-windows-version)
884 (declare-function w32-shell-execute "w32fns.c") ;; Defined in C.
886 (defun browse-url-default-windows-browser (url &optional new-window)
887 (interactive (browse-url-interactive-arg "URL: "))
888 (cond ((eq system-type 'ms-dos)
889 (if dos-windows-version
890 (shell-command (concat "start " (shell-quote-argument url)))
891 (error "Browsing URLs is not supported on this system")))
892 ((eq system-type 'cygwin)
893 (call-process "cygstart" nil nil nil url))
894 (t (w32-shell-execute "open" url))))
896 (defun browse-url-default-macosx-browser (url &optional new-window)
897 (interactive (browse-url-interactive-arg "URL: "))
898 (start-process (concat "open " url) nil "open" url))
902 (defun browse-url-process-environment ()
903 "Set DISPLAY in the environment to the X display the browser will use.
904 This is either the value of variable `browse-url-browser-display' if
905 non-nil, or the same display as Emacs if different from the current
906 environment, otherwise just use the current environment."
907 (let ((display (or browse-url-browser-display (browse-url-emacs-display))))
909 (cons (concat "DISPLAY=" display) process-environment)
910 process-environment)))
912 (defun browse-url-emacs-display ()
913 "Return the X display Emacs is running on.
914 This is nil if the display is the same as the DISPLAY environment variable.
916 Actually Emacs could be using several displays; this just returns the
917 one showing the selected frame."
918 (let ((display (cdr-safe (assq 'display (frame-parameters)))))
919 (and (not (equal display (getenv "DISPLAY")))
922 (defun browse-url-default-browser (url &rest args)
923 "Find a suitable browser and ask it to load URL.
924 Default to the URL around or before point.
926 When called interactively, if variable `browse-url-new-window-flag' is
927 non-nil, load the document in a new window, if possible, otherwise use
928 a random existing one. A non-nil interactive prefix argument reverses
929 the effect of `browse-url-new-window-flag'.
931 When called non-interactively, optional second argument NEW-WINDOW is
932 used instead of `browse-url-new-window-flag'."
935 ((memq system-type '(windows-nt ms-dos cygwin))
936 'browse-url-default-windows-browser)
937 ((memq system-type '(darwin))
938 'browse-url-default-macosx-browser)
939 ((browse-url-can-use-xdg-open) 'browse-url-xdg-open)
940 ((executable-find browse-url-gnome-moz-program) 'browse-url-gnome-moz)
941 ((executable-find browse-url-mozilla-program) 'browse-url-mozilla)
942 ((executable-find browse-url-firefox-program) 'browse-url-firefox)
943 ((executable-find browse-url-chromium-program) 'browse-url-chromium)
944 ((executable-find browse-url-galeon-program) 'browse-url-galeon)
945 ((executable-find browse-url-kde-program) 'browse-url-kde)
946 ((executable-find browse-url-netscape-program) 'browse-url-netscape)
947 ((executable-find browse-url-mosaic-program) 'browse-url-mosaic)
948 ((executable-find browse-url-xterm-program) 'browse-url-text-xterm)
949 ((locate-library "w3") 'browse-url-w3)
951 (lambda (&rest ignore) (error "No usable browser found"))))
954 (defun browse-url-can-use-xdg-open ()
955 "Check if xdg-open can be used, i.e. we are on Gnome, KDE, Xfce4 or LXDE."
956 (and (getenv "DISPLAY")
957 (executable-find "xdg-open")
958 ;; xdg-open may call gnome-open and that does not wait for its child
959 ;; to finish. This child may then be killed when the parent dies.
960 ;; Use nohup to work around. See bug#7166, bug#8917, bug#9779 and
961 ;; http://lists.gnu.org/archive/html/emacs-devel/2009-07/msg00279.html
962 (executable-find "nohup")
963 (or (getenv "GNOME_DESKTOP_SESSION_ID")
964 ;; GNOME_DESKTOP_SESSION_ID is deprecated, check on Dbus also.
967 "dbus-send" nil nil nil
968 "--dest=org.gnome.SessionManager"
970 "/org/gnome/SessionManager"
971 "org.gnome.SessionManager.CanShutdown"))
973 (equal (getenv "KDE_FULL_SESSION") "true")
976 "/bin/sh" nil nil nil
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 new-window)
986 (interactive (browse-url-interactive-arg "URL: "))
987 (call-process "xdg-open" nil 0 nil url))
990 (defun browse-url-netscape (url &optional new-window)
991 "Ask the Netscape WWW browser to load URL.
992 Default to the URL around or before point. The strings in variable
993 `browse-url-netscape-arguments' are also passed to Netscape.
995 When called interactively, if variable `browse-url-new-window-flag' is
996 non-nil, load the document in a new Netscape window, otherwise use a
997 random existing one. A non-nil interactive prefix argument reverses
998 the effect of `browse-url-new-window-flag'.
1000 If `browse-url-netscape-new-window-is-tab' is non-nil, then
1001 whenever a document would otherwise be loaded in a new window, it
1002 is loaded in a new tab in an existing window instead.
1004 When called non-interactively, optional second argument NEW-WINDOW is
1005 used instead of `browse-url-new-window-flag'."
1006 (interactive (browse-url-interactive-arg "URL: "))
1007 (setq url (browse-url-encode-url url))
1008 (let* ((process-environment (browse-url-process-environment))
1010 (apply 'start-process
1011 (concat "netscape " url) nil
1012 browse-url-netscape-program
1014 browse-url-netscape-arguments
1015 (if (eq window-system 'w32)
1018 (if new-window '("-noraise"))
1020 (concat "openURL(" url
1021 (if (browse-url-maybe-new-window
1023 (if browse-url-netscape-new-window-is-tab
1027 (set-process-sentinel process
1028 `(lambda (process change)
1029 (browse-url-netscape-sentinel process ,url)))))
1031 (defun browse-url-netscape-sentinel (process url)
1032 "Handle a change to the process communicating with Netscape."
1033 (or (eq (process-exit-status process) 0)
1034 (let* ((process-environment (browse-url-process-environment)))
1035 ;; Netscape not running - start it
1036 (message "Starting %s..." browse-url-netscape-program)
1037 (apply 'start-process (concat "netscape" url) nil
1038 browse-url-netscape-program
1039 (append browse-url-netscape-startup-arguments (list url))))))
1041 (defun browse-url-netscape-reload ()
1042 "Ask Netscape to reload its current document.
1043 How depends on `browse-url-netscape-version'."
1045 ;; Backwards incompatibility reported by
1046 ;; <peter.kruse@psychologie.uni-regensburg.de>.
1047 (browse-url-netscape-send (if (>= browse-url-netscape-version 4)
1048 "xfeDoCommand(reload)"
1051 (defun browse-url-netscape-send (command)
1052 "Send a remote control command to Netscape."
1053 (let* ((process-environment (browse-url-process-environment)))
1054 (apply 'start-process "netscape" nil
1055 browse-url-netscape-program
1056 (append browse-url-netscape-arguments
1057 (list "-remote" command)))))
1060 (defun browse-url-mozilla (url &optional new-window)
1061 "Ask the Mozilla WWW browser to load URL.
1062 Default to the URL around or before point. The strings in variable
1063 `browse-url-mozilla-arguments' are also passed to Mozilla.
1065 When called interactively, if variable `browse-url-new-window-flag' is
1066 non-nil, load the document in a new Mozilla window, otherwise use a
1067 random existing one. A non-nil interactive prefix argument reverses
1068 the effect of `browse-url-new-window-flag'.
1070 If `browse-url-mozilla-new-window-is-tab' is non-nil, then whenever a
1071 document would otherwise be loaded in a new window, it is loaded in a
1072 new tab in an existing window instead.
1074 When called non-interactively, optional second argument NEW-WINDOW is
1075 used instead of `browse-url-new-window-flag'."
1076 (interactive (browse-url-interactive-arg "URL: "))
1077 (setq url (browse-url-encode-url url))
1078 (let* ((process-environment (browse-url-process-environment))
1080 (apply 'start-process
1081 (concat "mozilla " url) nil
1082 browse-url-mozilla-program
1084 browse-url-mozilla-arguments
1088 (if (browse-url-maybe-new-window
1090 (if browse-url-mozilla-new-window-is-tab
1094 (set-process-sentinel process
1095 `(lambda (process change)
1096 (browse-url-mozilla-sentinel process ,url)))))
1098 (defun browse-url-mozilla-sentinel (process url)
1099 "Handle a change to the process communicating with Mozilla."
1100 (or (eq (process-exit-status process) 0)
1101 (let* ((process-environment (browse-url-process-environment)))
1102 ;; Mozilla is not running - start it
1103 (message "Starting %s..." browse-url-mozilla-program)
1104 (apply 'start-process (concat "mozilla " url) nil
1105 browse-url-mozilla-program
1106 (append browse-url-mozilla-startup-arguments (list url))))))
1109 (defun browse-url-firefox (url &optional new-window)
1110 "Ask the Firefox WWW browser to load URL.
1111 Default to the URL around or before point. The strings in
1112 variable `browse-url-firefox-arguments' are also passed to
1115 When called interactively, if variable
1116 `browse-url-new-window-flag' is non-nil, load the document in a
1117 new Firefox window, otherwise use a random existing one. A
1118 non-nil interactive prefix argument reverses the effect of
1119 `browse-url-new-window-flag'.
1121 If `browse-url-firefox-new-window-is-tab' is non-nil, then
1122 whenever a document would otherwise be loaded in a new window, it
1123 is loaded in a new tab in an existing window instead.
1125 When called non-interactively, optional second argument
1126 NEW-WINDOW is used instead of `browse-url-new-window-flag'.
1128 On MS-Windows systems the optional `new-window' parameter is
1129 ignored. Firefox for Windows does not support the \"-remote\"
1130 command line parameter. Therefore, the
1131 `browse-url-new-window-flag' and `browse-url-firefox-new-window-is-tab'
1132 are ignored as well. Firefox on Windows will always open the requested
1133 URL in a new window."
1134 (interactive (browse-url-interactive-arg "URL: "))
1135 (setq url (browse-url-encode-url url))
1136 (let* ((process-environment (browse-url-process-environment))
1138 (not (memq system-type '(windows-nt ms-dos))))
1140 (apply 'start-process
1141 (concat "firefox " url) nil
1142 browse-url-firefox-program
1144 browse-url-firefox-arguments
1150 (if (browse-url-maybe-new-window new-window)
1151 (if browse-url-firefox-new-window-is-tab
1156 ;; If we use -remote, the process exits with status code 2 if
1157 ;; Firefox is not already running. The sentinel runs firefox
1158 ;; directly if that happens.
1160 (set-process-sentinel process
1161 `(lambda (process change)
1162 (browse-url-firefox-sentinel process ,url))))))
1164 (defun browse-url-firefox-sentinel (process url)
1165 "Handle a change to the process communicating with Firefox."
1166 (or (eq (process-exit-status process) 0)
1167 (let* ((process-environment (browse-url-process-environment)))
1168 ;; Firefox is not running - start it
1169 (message "Starting Firefox...")
1170 (apply 'start-process (concat "firefox " url) nil
1171 browse-url-firefox-program
1172 (append browse-url-firefox-startup-arguments (list url))))))
1175 (defun browse-url-chromium (url &optional new-window)
1176 "Ask the Chromium WWW browser to load URL.
1177 Default to the URL around or before point. The strings in
1178 variable `browse-url-chromium-arguments' are also passed to
1180 (interactive (browse-url-interactive-arg "URL: "))
1181 (setq url (browse-url-encode-url url))
1182 (let* ((process-environment (browse-url-process-environment)))
1183 (apply 'start-process
1184 (concat "chromium " url) nil
1185 browse-url-chromium-program
1187 browse-url-chromium-arguments
1191 (defun browse-url-galeon (url &optional new-window)
1192 "Ask the Galeon WWW browser to load URL.
1193 Default to the URL around or before point. The strings in variable
1194 `browse-url-galeon-arguments' are also passed to Galeon.
1196 When called interactively, if variable `browse-url-new-window-flag' is
1197 non-nil, load the document in a new Galeon window, otherwise use a
1198 random existing one. A non-nil interactive prefix argument reverses
1199 the effect of `browse-url-new-window-flag'.
1201 If `browse-url-galeon-new-window-is-tab' is non-nil, then whenever a
1202 document would otherwise be loaded in a new window, it is loaded in a
1203 new tab in an existing window instead.
1205 When called non-interactively, optional second argument NEW-WINDOW is
1206 used instead of `browse-url-new-window-flag'."
1207 (interactive (browse-url-interactive-arg "URL: "))
1208 (setq url (browse-url-encode-url url))
1209 (let* ((process-environment (browse-url-process-environment))
1210 (process (apply 'start-process
1211 (concat "galeon " url)
1213 browse-url-galeon-program
1215 browse-url-galeon-arguments
1216 (if (browse-url-maybe-new-window new-window)
1217 (if browse-url-galeon-new-window-is-tab
1219 '("--new-window" "--noraise"))
1222 (set-process-sentinel process
1223 `(lambda (process change)
1224 (browse-url-galeon-sentinel process ,url)))))
1226 (defun browse-url-galeon-sentinel (process url)
1227 "Handle a change to the process communicating with Galeon."
1228 (or (eq (process-exit-status process) 0)
1229 (let* ((process-environment (browse-url-process-environment)))
1230 ;; Galeon is not running - start it
1231 (message "Starting %s..." browse-url-galeon-program)
1232 (apply 'start-process (concat "galeon " url) nil
1233 browse-url-galeon-program
1234 (append browse-url-galeon-startup-arguments (list url))))))
1236 (defun browse-url-epiphany (url &optional new-window)
1237 "Ask the Epiphany WWW browser to load URL.
1238 Default to the URL around or before point. The strings in variable
1239 `browse-url-galeon-arguments' are also passed to Epiphany.
1241 When called interactively, if variable `browse-url-new-window-flag' is
1242 non-nil, load the document in a new Epiphany window, otherwise use a
1243 random existing one. A non-nil interactive prefix argument reverses
1244 the effect of `browse-url-new-window-flag'.
1246 If `browse-url-epiphany-new-window-is-tab' is non-nil, then whenever a
1247 document would otherwise be loaded in a new window, it is loaded in a
1248 new tab in an existing window instead.
1250 When called non-interactively, optional second argument NEW-WINDOW is
1251 used instead of `browse-url-new-window-flag'."
1252 (interactive (browse-url-interactive-arg "URL: "))
1253 (setq url (browse-url-encode-url url))
1254 (let* ((process-environment (browse-url-process-environment))
1255 (process (apply 'start-process
1256 (concat "epiphany " url)
1258 browse-url-epiphany-program
1260 browse-url-epiphany-arguments
1261 (if (browse-url-maybe-new-window new-window)
1262 (if browse-url-epiphany-new-window-is-tab
1264 '("--new-window" "--noraise"))
1267 (set-process-sentinel process
1268 `(lambda (process change)
1269 (browse-url-epiphany-sentinel process ,url)))))
1271 (defun browse-url-epiphany-sentinel (process url)
1272 "Handle a change to the process communicating with Epiphany."
1273 (or (eq (process-exit-status process) 0)
1274 (let* ((process-environment (browse-url-process-environment)))
1275 ;; Epiphany is not running - start it
1276 (message "Starting %s..." browse-url-epiphany-program)
1277 (apply 'start-process (concat "epiphany " url) nil
1278 browse-url-epiphany-program
1279 (append browse-url-epiphany-startup-arguments (list url))))))
1281 (defvar url-handler-regexp)
1284 (defun browse-url-emacs (url &optional new-window)
1285 "Ask Emacs to load URL into a buffer and show it in another window."
1286 (interactive (browse-url-interactive-arg "URL: "))
1287 (require 'url-handlers)
1288 (let ((file-name-handler-alist
1289 (cons (cons url-handler-regexp 'url-file-handler)
1290 file-name-handler-alist)))
1291 ;; Ignore `new-window': with all other browsers the URL is always shown
1292 ;; in another window than the current Emacs one since it's shown in
1293 ;; another application's window.
1294 ;; (if new-window (find-file-other-window url) (find-file url))
1295 (find-file-other-window url)))
1298 (defun browse-url-gnome-moz (url &optional new-window)
1299 "Ask Mozilla/Netscape to load URL via the GNOME program `gnome-moz-remote'.
1300 Default to the URL around or before point. The strings in variable
1301 `browse-url-gnome-moz-arguments' are also passed.
1303 When called interactively, if variable `browse-url-new-window-flag' is
1304 non-nil, load the document in a new browser window, otherwise use an
1305 existing one. A non-nil interactive prefix argument reverses the
1306 effect of `browse-url-new-window-flag'.
1308 When called non-interactively, optional second argument NEW-WINDOW is
1309 used instead of `browse-url-new-window-flag'."
1310 (interactive (browse-url-interactive-arg "URL: "))
1311 (apply 'start-process (concat "gnome-moz-remote " url)
1313 browse-url-gnome-moz-program
1315 browse-url-gnome-moz-arguments
1316 (if (browse-url-maybe-new-window new-window)
1318 (list "--raise" url))))
1323 (defun browse-url-mosaic (url &optional new-window)
1324 "Ask the XMosaic WWW browser to load URL.
1326 Default to the URL around or before point. The strings in variable
1327 `browse-url-mosaic-arguments' are also passed to Mosaic and the
1328 program is invoked according to the variable
1329 `browse-url-mosaic-program'.
1331 When called interactively, if variable `browse-url-new-window-flag' is
1332 non-nil, load the document in a new Mosaic window, otherwise use a
1333 random existing one. A non-nil interactive prefix argument reverses
1334 the effect of `browse-url-new-window-flag'.
1336 When called non-interactively, optional second argument NEW-WINDOW is
1337 used instead of `browse-url-new-window-flag'."
1338 (interactive (browse-url-interactive-arg "Mosaic URL: "))
1339 (let ((pidfile (expand-file-name browse-url-mosaic-pidfile))
1341 (if (file-readable-p pidfile)
1344 (goto-char (point-min))
1345 (setq pid (read (current-buffer)))
1347 (if (and pid (zerop (signal-process pid 0))) ; Mosaic running
1349 (find-file (format "/tmp/Mosaic.%d" pid))
1351 (insert (if (browse-url-maybe-new-window new-window)
1357 ;; Send signal SIGUSR to Mosaic
1358 (message "Signaling Mosaic...")
1359 (signal-process pid 'SIGUSR1)
1360 ;; Or you could try:
1361 ;; (call-process "kill" nil 0 nil "-USR1" (int-to-string pid))
1362 (message "Signaling Mosaic...done")
1364 ;; Mosaic not running - start it
1365 (message "Starting %s..." browse-url-mosaic-program)
1366 (apply 'start-process "xmosaic" nil browse-url-mosaic-program
1367 (append browse-url-mosaic-arguments (list url)))
1368 (message "Starting %s...done" browse-url-mosaic-program))))
1370 ;; --- Mosaic using CCI ---
1373 (defun browse-url-cci (url &optional new-window)
1374 "Ask the XMosaic WWW browser to load URL.
1375 Default to the URL around or before point.
1377 This function only works for XMosaic version 2.5 or later. You must
1378 select `CCI' from XMosaic's File menu, set the CCI Port Address to the
1379 value of variable `browse-url-CCI-port', and enable `Accept requests'.
1381 When called interactively, if variable `browse-url-new-window-flag' is
1382 non-nil, load the document in a new browser window, otherwise use a
1383 random existing one. A non-nil interactive prefix argument reverses
1384 the effect of `browse-url-new-window-flag'.
1386 When called non-interactively, optional second argument NEW-WINDOW is
1387 used instead of `browse-url-new-window-flag'."
1388 (interactive (browse-url-interactive-arg "Mosaic URL: "))
1389 (open-network-stream "browse-url" " *browse-url*"
1390 browse-url-CCI-host browse-url-CCI-port)
1391 ;; Todo: start browser if fails
1392 (process-send-string "browse-url"
1393 (concat "get url (" url ") output "
1394 (if (browse-url-maybe-new-window new-window)
1398 (process-send-string "browse-url" "disconnect\r\n")
1399 (delete-process "browse-url"))
1404 (declare-function w3-fetch-other-window "ext:w3m" (&optional url))
1405 (declare-function w3-fetch "ext:w3m" (&optional url target))
1408 (defun browse-url-w3 (url &optional new-window)
1409 "Ask the w3 WWW browser to load URL.
1410 Default to the URL around or before point.
1412 When called interactively, if variable `browse-url-new-window-flag' is
1413 non-nil, load the document in a new window. A non-nil interactive
1414 prefix argument reverses the effect of `browse-url-new-window-flag'.
1416 When called non-interactively, optional second argument NEW-WINDOW is
1417 used instead of `browse-url-new-window-flag'."
1418 (interactive (browse-url-interactive-arg "W3 URL: "))
1419 (require 'w3) ; w3-fetch-other-window not autoloaded
1420 (if (browse-url-maybe-new-window new-window)
1421 (w3-fetch-other-window url)
1425 (defun browse-url-w3-gnudoit (url &optional new-window)
1426 ;; new-window ignored
1427 "Ask another Emacs running gnuserv to load the URL using the W3 browser.
1428 The `browse-url-gnudoit-program' program is used with options given by
1429 `browse-url-gnudoit-args'. Default to the URL around or before point."
1430 (interactive (browse-url-interactive-arg "W3 URL: "))
1431 (apply 'start-process (concat "gnudoit:" url) nil
1432 browse-url-gnudoit-program
1433 (append browse-url-gnudoit-args
1434 (list (concat "(w3-fetch \"" url "\")")
1437 ;; --- Lynx in an xterm ---
1440 (defun browse-url-text-xterm (url &optional new-window)
1441 ;; new-window ignored
1442 "Ask a text browser to load URL.
1443 URL defaults to the URL around or before point.
1444 This runs the text browser specified by `browse-url-text-browser'.
1445 in an Xterm window using the Xterm program named by `browse-url-xterm-program'
1446 with possible additional arguments `browse-url-xterm-args'."
1447 (interactive (browse-url-interactive-arg "Text browser URL: "))
1448 (apply #'start-process `(,(concat browse-url-text-browser url)
1449 nil ,browse-url-xterm-program
1450 ,@browse-url-xterm-args "-e" ,browse-url-text-browser
1453 ;; --- Lynx in an Emacs "term" window ---
1455 (declare-function term-char-mode "term" ())
1456 (declare-function term-send-down "term" ())
1457 (declare-function term-send-string "term" (proc str))
1460 (defun browse-url-text-emacs (url &optional new-buffer)
1461 "Ask a text browser to load URL.
1462 URL defaults to the URL around or before point.
1463 This runs the text browser specified by `browse-url-text-browser'.
1464 With a prefix argument, it runs a new browser process in a new buffer.
1466 When called interactively, if variable `browse-url-new-window-flag' is
1467 non-nil, load the document in a new browser process in a new term window,
1468 otherwise use any existing one. A non-nil interactive prefix argument
1469 reverses the effect of `browse-url-new-window-flag'.
1471 When called non-interactively, optional second argument NEW-WINDOW is
1472 used instead of `browse-url-new-window-flag'."
1473 (interactive (browse-url-interactive-arg "Text browser URL: "))
1474 (let* ((system-uses-terminfo t) ; Lynx uses terminfo
1475 ;; (term-term-name "vt100") ; ??
1476 (buf (get-buffer "*text browser*"))
1477 (proc (and buf (get-buffer-process buf)))
1478 (n browse-url-text-input-attempts))
1480 (if (and (browse-url-maybe-new-window new-buffer) buf)
1481 ;; Rename away the OLD buffer. This isn't very polite, but
1482 ;; term insists on working in a buffer named *lynx* and would
1483 ;; choke on *lynx*<1>
1484 (progn (set-buffer buf)
1486 (if (or (browse-url-maybe-new-window new-buffer)
1489 (not (memq (process-status proc) '(run stop))))
1490 ;; start a new text browser
1494 `(,browse-url-text-browser
1495 ,browse-url-text-browser
1496 nil ,@browse-url-text-emacs-args
1498 (switch-to-buffer buf)
1500 (set-process-sentinel
1501 (get-buffer-process buf)
1502 ;; Don't leave around a dead one (especially because of its
1504 (lambda (process event)
1505 (if (not (memq (process-status process) '(run stop)))
1506 (let ((buf (process-buffer process)))
1507 (if buf (kill-buffer buf)))))))
1508 ;; Send the url to the text browser in the old buffer
1509 (let ((win (get-buffer-window buf t)))
1512 (switch-to-buffer buf)))
1513 (if (eq (following-char) ?_)
1514 (cond ((eq browse-url-text-input-field 'warn)
1515 (error "Please move out of the input field first"))
1516 ((eq browse-url-text-input-field 'avoid)
1517 (while (and (eq (following-char) ?_) (> n 0))
1518 (term-send-down) ; down arrow
1519 (sit-for browse-url-text-input-delay))
1520 (if (eq (following-char) ?_)
1521 (error "Cannot move out of the input field, sorry")))))
1522 (term-send-string proc (concat "g" ; goto
1523 "\C-u" ; kill default url
1529 (autoload 'rfc2368-parse-mailto-url "rfc2368")
1532 (defun browse-url-mail (url &optional new-window)
1533 "Open a new mail message buffer within Emacs for the RFC 2368 URL.
1534 Default to using the mailto: URL around or before point as the
1535 recipient's address. Supplying a non-nil interactive prefix argument
1536 will cause the mail to be composed in another window rather than the
1539 When called interactively, if variable `browse-url-new-window-flag' is
1540 non-nil use `compose-mail-other-window', otherwise `compose-mail'. A
1541 non-nil interactive prefix argument reverses the effect of
1542 `browse-url-new-window-flag'.
1544 When called non-interactively, optional second argument NEW-WINDOW is
1545 used instead of `browse-url-new-window-flag'."
1546 (interactive (browse-url-interactive-arg "Mailto URL: "))
1548 (let* ((alist (rfc2368-parse-mailto-url url))
1549 (to (assoc "To" alist))
1550 (subject (assoc "Subject" alist))
1551 (body (assoc "Body" alist))
1552 (rest (delq to (delq subject (delq body alist))))
1554 (subject (cdr subject))
1556 (mail-citation-hook (unless body mail-citation-hook)))
1557 (if (browse-url-maybe-new-window new-window)
1558 (compose-mail-other-window to subject rest nil
1559 (list 'insert-buffer (current-buffer)))
1560 (compose-mail to subject rest nil nil
1561 (list 'insert-buffer (current-buffer))))
1563 (goto-char (point-min))
1564 (unless (or (search-forward (concat "\n" mail-header-separator "\n")
1570 (insert (replace-regexp-in-string "\r\n" "\n" body))
1572 (insert "\n"))))))))
1574 ;; --- Random browser ---
1577 (defun browse-url-generic (url &optional new-window)
1578 ;; new-window ignored
1579 "Ask the WWW browser defined by `browse-url-generic-program' to load URL.
1580 Default to the URL around or before point. A fresh copy of the
1581 browser is started up in a new process with possible additional arguments
1582 `browse-url-generic-args'. This is appropriate for browsers which
1583 don't offer a form of remote control."
1584 (interactive (browse-url-interactive-arg "URL: "))
1585 (if (not browse-url-generic-program)
1586 (error "No browser defined (`browse-url-generic-program')"))
1587 (apply 'call-process browse-url-generic-program nil
1589 (append browse-url-generic-args (list url))))
1592 (defun browse-url-kde (url &optional new-window)
1593 "Ask the KDE WWW browser to load URL.
1594 Default to the URL around or before point."
1595 (interactive (browse-url-interactive-arg "KDE URL: "))
1596 (message "Sending URL to KDE...")
1597 (apply #'start-process (concat "KDE " url) nil browse-url-kde-program
1598 (append browse-url-kde-args (list url))))
1600 (defun browse-url-elinks-new-window (url)
1601 "Ask the Elinks WWW browser to load URL in a new window."
1602 (let ((process-environment (browse-url-process-environment)))
1603 (apply #'start-process
1604 (append (list (concat "elinks:" url)
1606 browse-url-elinks-wrapper
1607 (list "elinks" url)))))
1610 (defun browse-url-elinks (url &optional new-window)
1611 "Ask the Elinks WWW browser to load URL.
1612 Default to the URL around the point.
1614 The document is loaded in a new tab of a running Elinks or, if
1615 none yet running, a newly started instance.
1617 The Elinks command will be prepended by the program+arguments
1618 from `browse-url-elinks-wrapper'."
1619 (interactive (browse-url-interactive-arg "URL: "))
1620 (setq url (browse-url-encode-url url))
1622 (browse-url-elinks-new-window url)
1623 (let ((process-environment (browse-url-process-environment))
1624 (elinks-ping-process (start-process "elinks-ping" nil
1625 "elinks" "-remote" "ping()")))
1626 (set-process-sentinel elinks-ping-process
1627 `(lambda (process change)
1628 (browse-url-elinks-sentinel process ,url))))))
1630 (defun browse-url-elinks-sentinel (process url)
1631 "Determines if Elinks is running or a new one has to be started."
1632 (let ((exit-status (process-exit-status process)))
1633 ;; Try to determine if an instance is running or if we have to
1634 ;; create a new one.
1637 ;; No instance, start a new one.
1638 (browse-url-elinks-new-window url))
1640 ;; Found an instance, open URL in new tab.
1641 (let ((process-environment (browse-url-process-environment)))
1642 (start-process (concat "elinks:" url) nil
1644 (concat "openURL(\"" url "\",new-tab)"))))
1646 (error "Unrecognized exit-code %d of process `elinks'"
1649 (provide 'browse-url)
1651 ;;; browse-url.el ends here