1 ;;; browse-url.el --- pass a URL to a WWW browser
3 ;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
4 ;; 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
6 ;; Author: Denis Howe <dbh@doc.ic.ac.uk>
8 ;; Created: 03 Apr 1995
9 ;; Keywords: hypertext, hypermedia, mouse
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
28 ;; This package provides functions which read a URL (Uniform Resource
29 ;; Locator) from the minibuffer, defaulting to the URL around point,
30 ;; and ask a World-Wide Web browser to load it. It can also load the
31 ;; URL associated with the current buffer. Different browsers use
32 ;; different methods of remote control so there is one function for
33 ;; each supported browser. If the chosen browser is not running, it
34 ;; is started. Currently there is support for the following browsers,
35 ;; some of them probably now obsolete:
37 ;; Function Browser Earliest version
38 ;; browse-url-mozilla Mozilla Don't know
39 ;; browse-url-firefox Firefox Don't know (tried with 1.0.1)
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-gnome-moz GNOME interface to Mozilla
52 ;; browse-url-kde KDE konqueror (kfm)
53 ;; browse-url-elinks Elinks Don't know (tried with 0.12.GIT)
55 ;; [A version of the Netscape browser is now free software
56 ;; <URL:http://www.mozilla.org/>, albeit not GPLed, so it is
57 ;; reasonable to have that as the default.]
59 ;; Note that versions of Netscape before 1.1b1 did not have remote
60 ;; control. <URL:http://www.netscape.com/newsref/std/x-remote.html>.
62 ;; Browsers can cache Web pages so it may be necessary to tell them to
63 ;; reload the current page if it has changed (e.g. if you have edited
64 ;; it). There is currently no perfect automatic solution to this.
66 ;; Netscape allows you to specify the id of the window you want to
67 ;; control but which window DO you want to control and how do you
70 ;; William M. Perry's excellent "w3" WWW browser for
71 ;; Emacs <URL:ftp://cs.indiana.edu/pub/elisp/w3/>
72 ;; has a function w3-follow-url-at-point, but that
73 ;; doesn't let you edit the URL like browse-url.
74 ;; The `gnuserv' package that can be used to control it in another
75 ;; Emacs process is available from
76 ;; <URL:ftp://ftp.splode.com/pub/users/friedman/packages/>.
78 ;; Lynx is now distributed by the FSF. See also
79 ;; <URL:http://lynx.browser.org/>.
81 ;; Free graphical browsers that could be used by `browse-url-generic'
82 ;; include Chimera <URL:ftp://ftp.cs.unlv.edu/pub/chimera> and
83 ;; <URL:http://www.unlv.edu/chimera/>, Arena
84 ;; <URL:ftp://ftp.yggdrasil.com/pub/dist/web/arena> and Amaya
85 ;; <URL:ftp://ftp.w3.org/pub/amaya>. mMosaic
86 ;; <URL:ftp://ftp.enst.fr/pub/mbone/mMosaic/>,
87 ;; <URL:http://www.enst.fr/~dauphin/mMosaic/> (with development
88 ;; support for Java applets and multicast) can be used like Mosaic by
89 ;; setting `browse-url-mosaic-program' appropriately.
91 ;; I [Denis Howe, not Dave Love] recommend Nelson Minar
92 ;; <nelson@santafe.edu>'s excellent html-helper-mode.el for editing
93 ;; HTML and thank Nelson for his many useful comments on this code.
94 ;; <URL:http://www.santafe.edu/%7Enelson/hhm-beta/>
96 ;; See also hm--html-menus <URL:http://www.tnt.uni-hannover.de/%7Emuenkel/
97 ;; software/own/hm--html-menus/>. For composing correct HTML see also
98 ;; PSGML the general SGML structure editor package
99 ;; <URL:ftp://ftp.lysator.liu.se/pub/sgml>; hm--html-menus can be used
102 ;; This package generalises function html-previewer-process in Marc
103 ;; Andreessen's html-mode (LCD modes/html-mode.el.Z). See also the
104 ;; ffap.el package. The huge hyperbole package also contains similar
107 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
110 ;; Can you write and test some code for the Macintrash and Windoze
111 ;; Netscape remote control APIs? (See the URL above).
113 ;; Do any other browsers have remote control?
115 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
118 ;; To display the URL at or before point:
119 ;; M-x browse-url-at-point RET
120 ;; or, similarly but with the opportunity to edit the URL extracted from
124 ;; To display a URL by shift-clicking on it, put this in your ~/.emacs
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 ;; Customisation (~/.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 customise 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 (eval-when-compile (require 'cl)
211 (require 'executable)
212 (require 'w3-auto nil t))
214 (defgroup browse-url nil
215 "Use a web browser to look at a URL."
216 :prefix "browse-url-"
217 :link '(emacs-commentary-link "browse-url")
221 (defcustom browse-url-browser-function
223 ((memq system-type '(windows-nt ms-dos cygwin))
224 'browse-url-default-windows-browser)
225 ((memq system-type '(darwin)) 'browse-url-default-macosx-browser)
226 (t 'browse-url-default-browser))
227 "Function to display the current buffer in a WWW browser.
228 This is used by the `browse-url-at-point', `browse-url-at-mouse', and
229 `browse-url-of-file' commands.
231 If the value is not a function it should be a list of pairs
232 \(REGEXP . FUNCTION). In this case the function called will be the one
233 associated with the first REGEXP which matches the current URL. The
234 function is passed the URL and any other args of `browse-url'. The last
235 regexp should probably be \".\" to specify a default browser."
237 (function-item :tag "Emacs W3" :value browse-url-w3)
238 (function-item :tag "W3 in another Emacs via `gnudoit'"
239 :value browse-url-w3-gnudoit)
240 (function-item :tag "Mozilla" :value browse-url-mozilla)
241 (function-item :tag "Firefox" :value browse-url-firefox)
242 (function-item :tag "Galeon" :value browse-url-galeon)
243 (function-item :tag "Epiphany" :value browse-url-epiphany)
244 (function-item :tag "Netscape" :value browse-url-netscape)
245 (function-item :tag "Mosaic" :value browse-url-mosaic)
246 (function-item :tag "Mosaic using CCI" :value browse-url-cci)
247 (function-item :tag "Text browser in an xterm window"
248 :value browse-url-text-xterm)
249 (function-item :tag "Text browser in an Emacs window"
250 :value browse-url-text-emacs)
251 (function-item :tag "KDE" :value browse-url-kde)
252 (function-item :tag "Elinks" :value browse-url-elinks)
253 (function-item :tag "Specified by `Browse Url Generic Program'"
254 :value browse-url-generic)
255 (function-item :tag "Default Windows browser"
256 :value browse-url-default-windows-browser)
257 (function-item :tag "Default Mac OS X browser"
258 :value browse-url-default-macosx-browser)
259 (function-item :tag "GNOME invoking Mozilla"
260 :value browse-url-gnome-moz)
261 (function-item :tag "Default browser"
262 :value browse-url-default-browser)
263 (function :tag "Your own function")
264 (alist :tag "Regexp/function association list"
265 :key-type regexp :value-type function))
269 (defcustom browse-url-netscape-program "netscape"
270 ;; Info about netscape-remote from Karl Berry.
271 "The name by which to invoke Netscape.
273 The free program `netscape-remote' from
274 <URL:http://home.netscape.com/newsref/std/remote.c> is said to start
275 up very much quicker than `netscape'. Reported to compile on a GNU
276 system, given vroot.h from the same directory, with cc flags
277 -DSTANDALONE -L/usr/X11R6/lib -lXmu -lX11."
281 (defcustom browse-url-netscape-arguments nil
282 "A list of strings to pass to Netscape as arguments."
283 :type '(repeat (string :tag "Argument"))
286 (defcustom browse-url-netscape-startup-arguments browse-url-netscape-arguments
287 "A list of strings to pass to Netscape when it starts up.
288 Defaults to the value of `browse-url-netscape-arguments' at the time
289 `browse-url' is loaded."
290 :type '(repeat (string :tag "Argument"))
293 (defcustom browse-url-browser-display nil
294 "The X display for running the browser, if not same as Emacs'."
295 :type '(choice string (const :tag "Default" nil))
298 (defcustom browse-url-mozilla-program "mozilla"
299 "The name by which to invoke Mozilla."
303 (defcustom browse-url-mozilla-arguments nil
304 "A list of strings to pass to Mozilla as arguments."
305 :type '(repeat (string :tag "Argument"))
308 (defcustom browse-url-mozilla-startup-arguments browse-url-mozilla-arguments
309 "A list of strings to pass to Mozilla when it starts up.
310 Defaults to the value of `browse-url-mozilla-arguments' at the time
311 `browse-url' is loaded."
312 :type '(repeat (string :tag "Argument"))
316 (defcustom browse-url-firefox-program "firefox"
317 "The name by which to invoke Firefox."
321 (defcustom browse-url-firefox-arguments nil
322 "A list of strings to pass to Firefox as arguments."
323 :type '(repeat (string :tag "Argument"))
326 (defcustom browse-url-firefox-startup-arguments browse-url-firefox-arguments
327 "A list of strings to pass to Firefox when it starts up.
328 Defaults to the value of `browse-url-firefox-arguments' at the time
329 `browse-url' is loaded."
330 :type '(repeat (string :tag "Argument"))
334 (defcustom browse-url-galeon-program "galeon"
335 "The name by which to invoke Galeon."
339 (defcustom browse-url-galeon-arguments nil
340 "A list of strings to pass to Galeon as arguments."
341 :type '(repeat (string :tag "Argument"))
344 (defcustom browse-url-galeon-startup-arguments browse-url-galeon-arguments
345 "A list of strings to pass to Galeon when it starts up.
346 Defaults to the value of `browse-url-galeon-arguments' at the time
347 `browse-url' is loaded."
348 :type '(repeat (string :tag "Argument"))
351 (defcustom browse-url-epiphany-program "epiphany"
352 "The name by which to invoke Epiphany."
356 (defcustom browse-url-epiphany-arguments nil
357 "A list of strings to pass to Epiphany as arguments."
358 :type '(repeat (string :tag "Argument"))
361 (defcustom browse-url-epiphany-startup-arguments browse-url-epiphany-arguments
362 "A list of strings to pass to Epiphany when it starts up.
363 Defaults to the value of `browse-url-epiphany-arguments' at the time
364 `browse-url' is loaded."
365 :type '(repeat (string :tag "Argument"))
368 ;; GNOME means of invoking either Mozilla or Netrape.
369 (defvar browse-url-gnome-moz-program "gnome-moz-remote")
371 (defcustom browse-url-gnome-moz-arguments '()
372 "A list of strings passed to the GNOME mozilla viewer as arguments."
374 :type '(repeat (string :tag "Argument"))
377 (defcustom browse-url-mozilla-new-window-is-tab nil
378 "Whether to open up new windows in a tab or a new window.
379 If non-nil, then open the URL in a new tab rather than a new window if
380 `browse-url-mozilla' is asked to open it in a new window."
384 (defcustom browse-url-firefox-new-window-is-tab nil
385 "Whether to open up new windows in a tab or a new window.
386 If non-nil, then open the URL in a new tab rather than a new window if
387 `browse-url-firefox' is asked to open it in a new window.
389 This option is currently ignored on MS-Windows, since the necessary
390 functionality is not available there."
394 (defcustom browse-url-galeon-new-window-is-tab nil
395 "Whether to open up new windows in a tab or a new window.
396 If non-nil, then open the URL in a new tab rather than a new window if
397 `browse-url-galeon' is asked to open it in a new window."
401 (defcustom browse-url-epiphany-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-epiphany' is asked to open it in a new window."
408 (defcustom browse-url-netscape-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
411 window if `browse-url-netscape' is asked to open it in a new
416 (defcustom browse-url-new-window-flag nil
417 "Non-nil means always open a new browser window with appropriate browsers.
418 Passing an interactive argument to \\[browse-url], or specific browser
419 commands reverses the effect of this variable. Requires Netscape version
420 1.1N or later or XMosaic version 2.5 or later if using those browsers."
424 (defcustom browse-url-mosaic-program "xmosaic"
425 "The name by which to invoke Mosaic (or mMosaic)."
430 (defcustom browse-url-mosaic-arguments nil
431 "A list of strings to pass to Mosaic as arguments."
432 :type '(repeat (string :tag "Argument"))
435 (defcustom browse-url-mosaic-pidfile "~/.mosaicpid"
436 "The name of the pidfile created by Mosaic."
440 (defcustom browse-url-filename-alist
441 `(("^/\\(ftp@\\|anonymous@\\)?\\([^:]+\\):/*" . "ftp://\\2/")
442 ;; The above loses the username to avoid the browser prompting for
443 ;; it in anonymous cases. If it's not anonymous the next regexp
445 ("^/\\([^:@]+@\\)?\\([^:]+\\):/*" . "ftp://\\1\\2/")
446 ,@(if (memq system-type '(windows-nt ms-dos cygwin))
447 '(("^\\([a-zA-Z]:\\)[\\/]" . "file:\\1/")
448 ("^[\\/][\\/]+" . "file://")))
449 ("^/+" . "file:///"))
450 "An alist of (REGEXP . STRING) pairs used by `browse-url-of-file'.
451 Any substring of a filename matching one of the REGEXPs is replaced by
452 the corresponding STRING using `replace-match', not treating STRING
453 literally. All pairs are applied in the order given. The default
454 value converts ange-ftp/EFS-style file names into ftp URLs and prepends
455 `file:' to any file name beginning with `/'.
457 For example, adding to the default a specific translation of an ange-ftp
458 address to an HTTP URL:
460 (setq browse-url-filename-alist
461 '((\"/webmaster@webserver:/home/www/html/\" .
462 \"http://www.acme.co.uk/\")
463 (\"^/\\(ftp@\\|anonymous@\\)?\\([^:]+\\):/*\" . \"ftp://\\2/\")
464 (\"^/\\([^:@]+@\\)?\\([^:]+\\):/*\" . \"ftp://\\1\\2/\")
465 (\"^/+\" . \"file:/\")))"
466 :type '(repeat (cons :format "%v"
467 (regexp :tag "Regexp")
468 (string :tag "Replacement")))
472 (defcustom browse-url-save-file nil
473 "If non-nil, save the buffer before displaying its file.
474 Used by the `browse-url-of-file' command."
478 (defcustom browse-url-of-file-hook nil
479 "Run after `browse-url-of-file' has asked a browser to load a file.
481 Set this to `browse-url-netscape-reload' to force Netscape to load the
482 file rather than displaying a cached copy."
484 :options '(browse-url-netscape-reload)
487 (defcustom browse-url-CCI-port 3003
488 "Port to access XMosaic via CCI.
489 This can be any number between 1024 and 65535 but must correspond to
490 the value set in the browser."
494 (defcustom browse-url-CCI-host "localhost"
495 "Host to access XMosaic via CCI.
496 This should be the host name of the machine running XMosaic with CCI
497 enabled. The port number should be set in `browse-url-CCI-port'."
501 (defvar browse-url-temp-file-name nil)
502 (make-variable-buffer-local 'browse-url-temp-file-name)
504 (defcustom browse-url-xterm-program "xterm"
505 "The name of the terminal emulator used by `browse-url-text-xterm'.
506 This might, for instance, be a separate color version of xterm."
510 (defcustom browse-url-xterm-args nil
511 "A list of strings defining options for `browse-url-xterm-program'.
512 These might set its size, for instance."
513 :type '(repeat (string :tag "Argument"))
516 (defcustom browse-url-gnudoit-program "gnudoit"
517 "The name of the `gnudoit' program used by `browse-url-w3-gnudoit'."
521 (defcustom browse-url-gnudoit-args '("-q")
522 "A list of strings defining options for `browse-url-gnudoit-program'.
523 These might set the port, for instance."
524 :type '(repeat (string :tag "Argument"))
527 (defcustom browse-url-generic-program nil
528 "The name of the browser program used by `browse-url-generic'."
529 :type '(choice string (const :tag "None" nil))
532 (defcustom browse-url-generic-args nil
533 "A list of strings defining options for `browse-url-generic-program'."
534 :type '(repeat (string :tag "Argument"))
537 (defcustom browse-url-temp-dir temporary-file-directory
538 "The name of a directory for browse-url's temporary files.
539 Such files are generated by functions like `browse-url-of-region'.
540 You might want to set this to somewhere with restricted read permissions
545 (defcustom browse-url-netscape-version 3
546 "The version of Netscape you are using.
547 This affects how URL reloading is done; the mechanism changed
548 incompatibly at version 4."
552 (defcustom browse-url-text-browser "lynx"
553 "The name of the text browser to invoke."
558 (defcustom browse-url-text-emacs-args (and (not window-system)
560 "A list of strings defining options for a text browser in an Emacs buffer.
562 The default is none in a window system, otherwise `-show_cursor' to
563 indicate the position of the current link in the absence of
564 highlighting, assuming the normal default for showing the cursor."
565 :type '(repeat (string :tag "Argument"))
569 (defcustom browse-url-text-input-field 'avoid
570 "Action on selecting an existing text browser buffer at an input field.
571 What to do when sending a new URL to an existing text browser buffer in Emacs
572 if the browser cursor is on an input field (in which case the `g' command
573 would be entered as data). Such fields are recognized by the
574 underlines ____. Allowed values: nil: disregard it, `warn': warn the
575 user and don't emit the URL, `avoid': try to avoid the field by moving
576 down (this *won't* always work)."
577 :type '(choice (const :tag "Move to try to avoid field" :value avoid)
578 (const :tag "Disregard" :value nil)
579 (const :tag "Warn, don't emit URL" :value warn))
583 (defcustom browse-url-text-input-attempts 10
584 "How many times to try to move down from a series of text browser input fields."
589 (defcustom browse-url-text-input-delay 0.2
590 "Seconds to wait for a text browser between moves down from an input field."
595 (defcustom browse-url-kde-program "kfmclient"
596 "The name by which to invoke the KDE web browser."
601 (defcustom browse-url-kde-args '("openURL")
602 "A list of strings defining options for `browse-url-kde-program'."
603 :type '(repeat (string :tag "Argument"))
606 (defcustom browse-url-elinks-wrapper '("xterm" "-e")
607 "*Wrapper command prepended to the Elinks command-line."
608 :type '(repeat (string :tag "Wrapper"))
611 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
614 (defun browse-url-url-encode-chars (text chars)
615 "URL-encode the chars in TEXT that match CHARS.
616 CHARS is a regexp-like character alternative (e.g., \"[,)$]\")."
617 (let ((encoded-text (copy-sequence text))
619 (while (setq s (string-match chars encoded-text s))
621 (replace-match (format "%%%x"
622 (string-to-char (match-string 0 encoded-text)))
627 (defun browse-url-encode-url (url)
628 "Escape annoying characters in URL.
629 The annoying characters are those that can mislead a webbrowser
630 regarding its parameter treatment. For instance, `,' can
631 be misleading because it could be used to separate URLs."
632 (browse-url-url-encode-chars url "[,)$]"))
634 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
638 (defun browse-url-url-at-point ()
639 (let ((url (thing-at-point 'url)))
640 (set-text-properties 0 (length url) nil url)
643 ;; Having this as a separate function called by the browser-specific
644 ;; functions allows them to be stand-alone commands, making it easier
645 ;; to switch between browsers.
647 (defun browse-url-interactive-arg (prompt)
648 "Read a URL from the minibuffer, prompting with PROMPT.
649 If `transient-mark-mode' is non-nil and the mark is active,
650 it defaults to the current region, else to the URL at or before
651 point. If invoked with a mouse button, it moves point to the
652 position clicked before acting.
654 This function returns a list (URL NEW-WINDOW-FLAG)
655 for use in `interactive'."
656 (let ((event (elt (this-command-keys) 0)))
657 (and (listp event) (mouse-set-point event)))
658 (list (read-string prompt (or (and transient-mark-mode mark-active
659 ;; rfc2396 Appendix E.
660 (replace-regexp-in-string
662 (buffer-substring-no-properties
663 (region-beginning) (region-end))))
664 (browse-url-url-at-point)))
665 (not (eq (null browse-url-new-window-flag)
666 (null current-prefix-arg)))))
668 ;; called-interactive-p needs to be called at a function's top-level, hence
669 ;; this macro. We use that rather than interactive-p because
670 ;; use in a keyboard macro should not change this behavior.
671 (defmacro browse-url-maybe-new-window (arg)
672 `(if (or noninteractive (not (called-interactively-p 'any)))
674 browse-url-new-window-flag))
676 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
677 ;; Browse current buffer
680 (defun browse-url-of-file (&optional file)
681 "Ask a WWW browser to display FILE.
682 Display the current buffer's file if FILE is nil or if called
683 interactively. Turn the filename into a URL with function
684 `browse-url-file-url'. Pass the URL to a browser using the
685 `browse-url' function then run `browse-url-of-file-hook'."
688 (setq file (buffer-file-name))
689 (error "Current buffer has no file"))
690 (let ((buf (get-file-buffer file)))
692 (with-current-buffer buf
693 (cond ((not (buffer-modified-p)))
694 (browse-url-save-file (save-buffer))
695 (t (message "%s modified since last save" file))))))
696 (browse-url (browse-url-file-url file))
697 (run-hooks 'browse-url-of-file-hook))
699 (defun browse-url-file-url (file)
700 "Return the URL corresponding to FILE.
701 Use variable `browse-url-filename-alist' to map filenames to URLs."
702 (let ((coding (and (default-value 'enable-multibyte-characters)
703 (or file-name-coding-system
704 default-file-name-coding-system))))
705 (if coding (setq file (encode-coding-string file coding))))
706 (setq file (browse-url-url-encode-chars file "[*\"()',=;?% ]"))
707 (dolist (map browse-url-filename-alist)
708 (when (and map (string-match (car map) file))
709 (setq file (replace-match (cdr map) t nil file))))
713 (defun browse-url-of-buffer (&optional buffer)
714 "Ask a WWW browser to display BUFFER.
715 Display the current buffer if BUFFER is nil. Display only the
716 currently visible part of BUFFER (from a temporary file) if buffer is
720 (and buffer (set-buffer buffer))
722 ;; Ignore real name if restricted
723 (and (= (- (point-max) (point-min)) (buffer-size))
725 (and (boundp 'dired-directory) dired-directory)))))
728 (or browse-url-temp-file-name
729 (setq browse-url-temp-file-name
730 (convert-standard-filename
732 (expand-file-name "burl" browse-url-temp-dir)
734 (setq file-name browse-url-temp-file-name)
735 (write-region (point-min) (point-max) file-name nil 'no-message)))
736 (browse-url-of-file file-name))))
738 (defun browse-url-delete-temp-file (&optional temp-file-name)
739 ;; Delete browse-url-temp-file-name from the file system
740 ;; If optional arg TEMP-FILE-NAME is non-nil, delete it instead
741 (let ((file-name (or temp-file-name browse-url-temp-file-name)))
742 (if (and file-name (file-exists-p file-name))
743 (delete-file file-name))))
745 (add-hook 'kill-buffer-hook 'browse-url-delete-temp-file)
748 (defun browse-url-of-dired-file ()
749 "In Dired, ask a WWW browser to display the file named on this line."
751 (browse-url-of-file (dired-get-filename)))
754 (defun browse-url-of-region (min max)
755 "Ask a WWW browser to display the current region."
759 (narrow-to-region min max)
760 (browse-url-of-buffer))))
762 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
763 ;; Browser-independent commands
765 ;; A generic command to call the current browse-url-browser-function
768 (defun browse-url (url &rest args)
769 "Ask a WWW browser to load URL.
770 Prompts for a URL, defaulting to the URL at or before point. Variable
771 `browse-url-browser-function' says which browser to use."
772 (interactive (browse-url-interactive-arg "URL: "))
773 (unless (called-interactively-p 'interactive)
774 (setq args (or args (list browse-url-new-window-flag))))
775 (let ((process-environment (copy-sequence process-environment)))
776 ;; When connected to various displays, be careful to use the display of
777 ;; the currently selected frame, rather than the original start display,
778 ;; which may not even exist any more.
779 (if (stringp (frame-parameter (selected-frame) 'display))
780 (setenv "DISPLAY" (frame-parameter (selected-frame) 'display)))
781 ;; Send any symbol to `apply', not just fboundp ones, since void-function
782 ;; from apply is clearer than wrong-type-argument from dolist.
783 (if (or (symbolp browse-url-browser-function)
784 (functionp browse-url-browser-function))
785 (apply browse-url-browser-function url args)
786 ;; The `function' can be an alist; look down it for first match
787 ;; and apply the function (which might be a lambda).
789 (dolist (bf browse-url-browser-function)
790 (when (string-match (car bf) url)
791 (apply (cdr bf) url args)
793 (error "No browse-url-browser-function matching URL %s"
797 (defun browse-url-at-point (&optional arg)
798 "Ask a WWW browser to load the URL at or before point.
799 Doesn't let you edit the URL like `browse-url'. Variable
800 `browse-url-browser-function' says which browser to use."
802 (let ((url (browse-url-url-at-point)))
804 (browse-url url (if arg
805 (not browse-url-new-window-flag)
806 browse-url-new-window-flag))
807 (error "No URL found"))))
810 (defun browse-url-at-mouse (event)
811 "Ask a WWW browser to load a URL clicked with the mouse.
812 The URL is the one around or before the position of the mouse click
813 but point is not changed. Doesn't let you edit the URL like
814 `browse-url'. Variable `browse-url-browser-function' says which browser
818 (mouse-set-point event)
819 ;; This handles browse-url-new-window-flag properly
820 ;; when it gets no arg.
821 (browse-url-at-point)))
823 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
824 ;; Browser-specific commands
826 ;; --- Default MS-Windows browser ---
828 (defvar dos-windows-version)
829 (declare-function w32-shell-execute "w32fns.c") ;; Defined in C.
831 (defun browse-url-default-windows-browser (url &optional new-window)
832 (interactive (browse-url-interactive-arg "URL: "))
833 (if (eq system-type 'ms-dos)
834 (if dos-windows-version
835 (shell-command (concat "start " (shell-quote-argument url)))
836 (error "Browsing URLs is not supported on this system"))
837 (w32-shell-execute "open" url)))
839 (defun browse-url-default-macosx-browser (url &optional new-window)
840 (interactive (browse-url-interactive-arg "URL: "))
841 (start-process (concat "open " url) nil "open" url))
845 (defun browse-url-process-environment ()
846 "Set DISPLAY in the environment to the X display the browser will use.
847 This is either the value of variable `browse-url-browser-display' if
848 non-nil, or the same display as Emacs if different from the current
849 environment, otherwise just use the current environment."
850 (let ((display (or browse-url-browser-display (browse-url-emacs-display))))
852 (cons (concat "DISPLAY=" display) process-environment)
853 process-environment)))
855 (defun browse-url-emacs-display ()
856 "Return the X display Emacs is running on.
857 This is nil if the display is the same as the DISPLAY environment variable.
859 Actually Emacs could be using several displays; this just returns the
860 one showing the selected frame."
861 (let ((display (cdr-safe (assq 'display (frame-parameters)))))
862 (and (not (equal display (getenv "DISPLAY")))
866 (defun browse-url-default-browser (url &rest args)
867 "Find a suitable browser and ask it to load URL.
868 Default to the URL around or before point.
870 When called interactively, if variable `browse-url-new-window-flag' is
871 non-nil, load the document in a new window, if possible, otherwise use
872 a random existing one. A non-nil interactive prefix argument reverses
873 the effect of `browse-url-new-window-flag'.
875 When called non-interactively, optional second argument NEW-WINDOW is
876 used instead of `browse-url-new-window-flag'.
878 The order attempted is gnome-moz-remote, Mozilla, Firefox,
879 Galeon, Konqueror, Netscape, Mosaic, Lynx in an xterm, and then W3."
882 ((executable-find browse-url-gnome-moz-program) 'browse-url-gnome-moz)
883 ((executable-find browse-url-mozilla-program) 'browse-url-mozilla)
884 ((executable-find browse-url-firefox-program) 'browse-url-firefox)
885 ((executable-find browse-url-galeon-program) 'browse-url-galeon)
886 ((executable-find browse-url-kde-program) 'browse-url-kde)
887 ((executable-find browse-url-netscape-program) 'browse-url-netscape)
888 ((executable-find browse-url-mosaic-program) 'browse-url-mosaic)
889 ((executable-find browse-url-xterm-program) 'browse-url-text-xterm)
890 ((locate-library "w3") 'browse-url-w3)
892 (lambda (&rest ignore) (error "No usable browser found"))))
896 (defun browse-url-netscape (url &optional new-window)
897 "Ask the Netscape WWW browser to load URL.
898 Default to the URL around or before point. The strings in variable
899 `browse-url-netscape-arguments' are also passed to Netscape.
901 When called interactively, if variable `browse-url-new-window-flag' is
902 non-nil, load the document in a new Netscape window, otherwise use a
903 random existing one. A non-nil interactive prefix argument reverses
904 the effect of `browse-url-new-window-flag'.
906 If `browse-url-netscape-new-window-is-tab' is non-nil, then
907 whenever a document would otherwise be loaded in a new window, it
908 is loaded in a new tab in an existing window instead.
910 When called non-interactively, optional second argument NEW-WINDOW is
911 used instead of `browse-url-new-window-flag'."
912 (interactive (browse-url-interactive-arg "URL: "))
913 (setq url (browse-url-encode-url url))
914 (let* ((process-environment (browse-url-process-environment))
916 (apply 'start-process
917 (concat "netscape " url) nil
918 browse-url-netscape-program
920 browse-url-netscape-arguments
921 (if (eq window-system 'w32)
924 (if new-window '("-noraise"))
926 (concat "openURL(" url
927 (if (browse-url-maybe-new-window
929 (if browse-url-netscape-new-window-is-tab
933 (set-process-sentinel process
934 `(lambda (process change)
935 (browse-url-netscape-sentinel process ,url)))))
937 (defun browse-url-netscape-sentinel (process url)
938 "Handle a change to the process communicating with Netscape."
939 (or (eq (process-exit-status process) 0)
940 (let* ((process-environment (browse-url-process-environment)))
941 ;; Netscape not running - start it
942 (message "Starting %s..." browse-url-netscape-program)
943 (apply 'start-process (concat "netscape" url) nil
944 browse-url-netscape-program
945 (append browse-url-netscape-startup-arguments (list url))))))
947 (defun browse-url-netscape-reload ()
948 "Ask Netscape to reload its current document.
949 How depends on `browse-url-netscape-version'."
951 ;; Backwards incompatibility reported by
952 ;; <peter.kruse@psychologie.uni-regensburg.de>.
953 (browse-url-netscape-send (if (>= browse-url-netscape-version 4)
954 "xfeDoCommand(reload)"
957 (defun browse-url-netscape-send (command)
958 "Send a remote control command to Netscape."
959 (let* ((process-environment (browse-url-process-environment)))
960 (apply 'start-process "netscape" nil
961 browse-url-netscape-program
962 (append browse-url-netscape-arguments
963 (list "-remote" command)))))
966 (defun browse-url-mozilla (url &optional new-window)
967 "Ask the Mozilla WWW browser to load URL.
968 Default to the URL around or before point. The strings in variable
969 `browse-url-mozilla-arguments' are also passed to Mozilla.
971 When called interactively, if variable `browse-url-new-window-flag' is
972 non-nil, load the document in a new Mozilla window, otherwise use a
973 random existing one. A non-nil interactive prefix argument reverses
974 the effect of `browse-url-new-window-flag'.
976 If `browse-url-mozilla-new-window-is-tab' is non-nil, then whenever a
977 document would otherwise be loaded in a new window, it is loaded in a
978 new tab in an existing window instead.
980 When called non-interactively, optional second argument NEW-WINDOW is
981 used instead of `browse-url-new-window-flag'."
982 (interactive (browse-url-interactive-arg "URL: "))
983 (setq url (browse-url-encode-url url))
984 (let* ((process-environment (browse-url-process-environment))
986 (apply 'start-process
987 (concat "mozilla " url) nil
988 browse-url-mozilla-program
990 browse-url-mozilla-arguments
994 (if (browse-url-maybe-new-window
996 (if browse-url-mozilla-new-window-is-tab
1000 (set-process-sentinel process
1001 `(lambda (process change)
1002 (browse-url-mozilla-sentinel process ,url)))))
1004 (defun browse-url-mozilla-sentinel (process url)
1005 "Handle a change to the process communicating with Mozilla."
1006 (or (eq (process-exit-status process) 0)
1007 (let* ((process-environment (browse-url-process-environment)))
1008 ;; Mozilla is not running - start it
1009 (message "Starting %s..." browse-url-mozilla-program)
1010 (apply 'start-process (concat "mozilla " url) nil
1011 browse-url-mozilla-program
1012 (append browse-url-mozilla-startup-arguments (list url))))))
1015 (defun browse-url-firefox (url &optional new-window)
1016 "Ask the Firefox WWW browser to load URL.
1017 Default to the URL around or before point. The strings in
1018 variable `browse-url-firefox-arguments' are also passed to
1021 When called interactively, if variable
1022 `browse-url-new-window-flag' is non-nil, load the document in a
1023 new Firefox window, otherwise use a random existing one. A
1024 non-nil interactive prefix argument reverses the effect of
1025 `browse-url-new-window-flag'.
1027 If `browse-url-firefox-new-window-is-tab' is non-nil, then
1028 whenever a document would otherwise be loaded in a new window, it
1029 is loaded in a new tab in an existing window instead.
1031 When called non-interactively, optional second argument
1032 NEW-WINDOW is used instead of `browse-url-new-window-flag'.
1034 On MS-Windows systems the optional `new-window' parameter is
1035 ignored. Firefox for Windows does not support the \"-remote\"
1036 command line parameter. Therefore, the
1037 `browse-url-new-window-flag' and `browse-url-firefox-new-window-is-tab'
1038 are ignored as well. Firefox on Windows will always open the requested
1039 URL in a new window."
1040 (interactive (browse-url-interactive-arg "URL: "))
1041 (setq url (browse-url-encode-url url))
1042 (let* ((process-environment (browse-url-process-environment))
1044 (apply 'start-process
1045 (concat "firefox " url) nil
1046 browse-url-firefox-program
1048 browse-url-firefox-arguments
1049 (if (or (featurep 'dos-w32)
1050 (string-match "win32" system-configuration))
1055 (if (browse-url-maybe-new-window
1057 (if browse-url-firefox-new-window-is-tab
1061 (set-process-sentinel process
1062 `(lambda (process change)
1063 (browse-url-firefox-sentinel process ,url)))))
1065 (defun browse-url-firefox-sentinel (process url)
1066 "Handle a change to the process communicating with Firefox."
1067 (or (eq (process-exit-status process) 0)
1068 (let* ((process-environment (browse-url-process-environment)))
1069 ;; Firefox is not running - start it
1070 (message "Starting Firefox...")
1071 (apply 'start-process (concat "firefox " url) nil
1072 browse-url-firefox-program
1073 (append browse-url-firefox-startup-arguments (list url))))))
1076 (defun browse-url-galeon (url &optional new-window)
1077 "Ask the Galeon WWW browser to load URL.
1078 Default to the URL around or before point. The strings in variable
1079 `browse-url-galeon-arguments' are also passed to Galeon.
1081 When called interactively, if variable `browse-url-new-window-flag' is
1082 non-nil, load the document in a new Galeon window, otherwise use a
1083 random existing one. A non-nil interactive prefix argument reverses
1084 the effect of `browse-url-new-window-flag'.
1086 If `browse-url-galeon-new-window-is-tab' is non-nil, then whenever a
1087 document would otherwise be loaded in a new window, it is loaded in a
1088 new tab in an existing window instead.
1090 When called non-interactively, optional second argument NEW-WINDOW is
1091 used instead of `browse-url-new-window-flag'."
1092 (interactive (browse-url-interactive-arg "URL: "))
1093 (setq url (browse-url-encode-url url))
1094 (let* ((process-environment (browse-url-process-environment))
1095 (process (apply 'start-process
1096 (concat "galeon " url)
1098 browse-url-galeon-program
1100 browse-url-galeon-arguments
1101 (if (browse-url-maybe-new-window new-window)
1102 (if browse-url-galeon-new-window-is-tab
1104 '("--new-window" "--noraise"))
1107 (set-process-sentinel process
1108 `(lambda (process change)
1109 (browse-url-galeon-sentinel process ,url)))))
1111 (defun browse-url-galeon-sentinel (process url)
1112 "Handle a change to the process communicating with Galeon."
1113 (or (eq (process-exit-status process) 0)
1114 (let* ((process-environment (browse-url-process-environment)))
1115 ;; Galeon is not running - start it
1116 (message "Starting %s..." browse-url-galeon-program)
1117 (apply 'start-process (concat "galeon " url) nil
1118 browse-url-galeon-program
1119 (append browse-url-galeon-startup-arguments (list url))))))
1121 (defun browse-url-epiphany (url &optional new-window)
1122 "Ask the Epiphany WWW browser to load URL.
1123 Default to the URL around or before point. The strings in variable
1124 `browse-url-galeon-arguments' are also passed to Epiphany.
1126 When called interactively, if variable `browse-url-new-window-flag' is
1127 non-nil, load the document in a new Epiphany window, otherwise use a
1128 random existing one. A non-nil interactive prefix argument reverses
1129 the effect of `browse-url-new-window-flag'.
1131 If `browse-url-epiphany-new-window-is-tab' is non-nil, then whenever a
1132 document would otherwise be loaded in a new window, it is loaded in a
1133 new tab in an existing window instead.
1135 When called non-interactively, optional second argument NEW-WINDOW is
1136 used instead of `browse-url-new-window-flag'."
1137 (interactive (browse-url-interactive-arg "URL: "))
1138 (setq url (browse-url-encode-url url))
1139 (let* ((process-environment (browse-url-process-environment))
1140 (process (apply 'start-process
1141 (concat "epiphany " url)
1143 browse-url-epiphany-program
1145 browse-url-epiphany-arguments
1146 (if (browse-url-maybe-new-window new-window)
1147 (if browse-url-epiphany-new-window-is-tab
1149 '("--new-window" "--noraise"))
1152 (set-process-sentinel process
1153 `(lambda (process change)
1154 (browse-url-epiphany-sentinel process ,url)))))
1156 (defun browse-url-epiphany-sentinel (process url)
1157 "Handle a change to the process communicating with Epiphany."
1158 (or (eq (process-exit-status process) 0)
1159 (let* ((process-environment (browse-url-process-environment)))
1160 ;; Epiphany is not running - start it
1161 (message "Starting %s..." browse-url-epiphany-program)
1162 (apply 'start-process (concat "epiphany " url) nil
1163 browse-url-epiphany-program
1164 (append browse-url-epiphany-startup-arguments (list url))))))
1166 (defvar url-handler-regexp)
1169 (defun browse-url-emacs (url &optional new-window)
1170 "Ask Emacs to load URL into a buffer and show it in another window."
1171 (interactive (browse-url-interactive-arg "URL: "))
1172 (require 'url-handlers)
1173 (let ((file-name-handler-alist
1174 (cons (cons url-handler-regexp 'url-file-handler)
1175 file-name-handler-alist)))
1176 ;; Ignore `new-window': with all other browsers the URL is always shown
1177 ;; in another window than the current Emacs one since it's shown in
1178 ;; another application's window.
1179 ;; (if new-window (find-file-other-window url) (find-file url))
1180 (find-file-other-window url)))
1183 (defun browse-url-gnome-moz (url &optional new-window)
1184 "Ask Mozilla/Netscape to load URL via the GNOME program `gnome-moz-remote'.
1185 Default to the URL around or before point. The strings in variable
1186 `browse-url-gnome-moz-arguments' are also passed.
1188 When called interactively, if variable `browse-url-new-window-flag' is
1189 non-nil, load the document in a new browser window, otherwise use an
1190 existing one. A non-nil interactive prefix argument reverses the
1191 effect of `browse-url-new-window-flag'.
1193 When called non-interactively, optional second argument NEW-WINDOW is
1194 used instead of `browse-url-new-window-flag'."
1195 (interactive (browse-url-interactive-arg "URL: "))
1196 (apply 'start-process (concat "gnome-moz-remote " url)
1198 browse-url-gnome-moz-program
1200 browse-url-gnome-moz-arguments
1201 (if (browse-url-maybe-new-window new-window)
1203 (list "--raise" url))))
1208 (defun browse-url-mosaic (url &optional new-window)
1209 "Ask the XMosaic WWW browser to load URL.
1211 Default to the URL around or before point. The strings in variable
1212 `browse-url-mosaic-arguments' are also passed to Mosaic and the
1213 program is invoked according to the variable
1214 `browse-url-mosaic-program'.
1216 When called interactively, if variable `browse-url-new-window-flag' is
1217 non-nil, load the document in a new Mosaic window, otherwise use a
1218 random existing one. A non-nil interactive prefix argument reverses
1219 the effect of `browse-url-new-window-flag'.
1221 When called non-interactively, optional second argument NEW-WINDOW is
1222 used instead of `browse-url-new-window-flag'."
1223 (interactive (browse-url-interactive-arg "Mosaic URL: "))
1224 (let ((pidfile (expand-file-name browse-url-mosaic-pidfile))
1226 (if (file-readable-p pidfile)
1229 (goto-char (point-min))
1230 (setq pid (read (current-buffer)))
1232 (if (and pid (zerop (signal-process pid 0))) ; Mosaic running
1234 (find-file (format "/tmp/Mosaic.%d" pid))
1236 (insert (if (browse-url-maybe-new-window new-window)
1242 ;; Send signal SIGUSR to Mosaic
1243 (message "Signaling Mosaic...")
1244 (signal-process pid 'SIGUSR1)
1245 ;; Or you could try:
1246 ;; (call-process "kill" nil 0 nil "-USR1" (int-to-string pid))
1247 (message "Signaling Mosaic...done")
1249 ;; Mosaic not running - start it
1250 (message "Starting %s..." browse-url-mosaic-program)
1251 (apply 'start-process "xmosaic" nil browse-url-mosaic-program
1252 (append browse-url-mosaic-arguments (list url)))
1253 (message "Starting %s...done" browse-url-mosaic-program))))
1255 ;; --- Mosaic using CCI ---
1258 (defun browse-url-cci (url &optional new-window)
1259 "Ask the XMosaic WWW browser to load URL.
1260 Default to the URL around or before point.
1262 This function only works for XMosaic version 2.5 or later. You must
1263 select `CCI' from XMosaic's File menu, set the CCI Port Address to the
1264 value of variable `browse-url-CCI-port', and enable `Accept requests'.
1266 When called interactively, if variable `browse-url-new-window-flag' is
1267 non-nil, load the document in a new browser window, otherwise use a
1268 random existing one. A non-nil interactive prefix argument reverses
1269 the effect of `browse-url-new-window-flag'.
1271 When called non-interactively, optional second argument NEW-WINDOW is
1272 used instead of `browse-url-new-window-flag'."
1273 (interactive (browse-url-interactive-arg "Mosaic URL: "))
1274 (open-network-stream "browse-url" " *browse-url*"
1275 browse-url-CCI-host browse-url-CCI-port)
1276 ;; Todo: start browser if fails
1277 (process-send-string "browse-url"
1278 (concat "get url (" url ") output "
1279 (if (browse-url-maybe-new-window new-window)
1283 (process-send-string "browse-url" "disconnect\r\n")
1284 (delete-process "browse-url"))
1289 (declare-function w3-fetch-other-window "ext:w3m" (&optional url))
1290 (declare-function w3-fetch "ext:w3m" (&optional url target))
1293 (defun browse-url-w3 (url &optional new-window)
1294 "Ask the w3 WWW browser to load URL.
1295 Default to the URL around or before point.
1297 When called interactively, if variable `browse-url-new-window-flag' is
1298 non-nil, load the document in a new window. A non-nil interactive
1299 prefix argument reverses the effect of `browse-url-new-window-flag'.
1301 When called non-interactively, optional second argument NEW-WINDOW is
1302 used instead of `browse-url-new-window-flag'."
1303 (interactive (browse-url-interactive-arg "W3 URL: "))
1304 (require 'w3) ; w3-fetch-other-window not autoloaded
1305 (if (browse-url-maybe-new-window new-window)
1306 (w3-fetch-other-window url)
1310 (defun browse-url-w3-gnudoit (url &optional new-window)
1311 ;; new-window ignored
1312 "Ask another Emacs running gnuserv to load the URL using the W3 browser.
1313 The `browse-url-gnudoit-program' program is used with options given by
1314 `browse-url-gnudoit-args'. Default to the URL around or before point."
1315 (interactive (browse-url-interactive-arg "W3 URL: "))
1316 (apply 'start-process (concat "gnudoit:" url) nil
1317 browse-url-gnudoit-program
1318 (append browse-url-gnudoit-args
1319 (list (concat "(w3-fetch \"" url "\")")
1322 ;; --- Lynx in an xterm ---
1325 (defun browse-url-text-xterm (url &optional new-window)
1326 ;; new-window ignored
1327 "Ask a text browser to load URL.
1328 URL defaults to the URL around or before point.
1329 This runs the text browser specified by `browse-url-text-browser'.
1330 in an Xterm window using the Xterm program named by `browse-url-xterm-program'
1331 with possible additional arguments `browse-url-xterm-args'."
1332 (interactive (browse-url-interactive-arg "Text browser URL: "))
1333 (apply #'start-process `(,(concat browse-url-text-browser url)
1334 nil ,browse-url-xterm-program
1335 ,@browse-url-xterm-args "-e" ,browse-url-text-browser
1338 ;; --- Lynx in an Emacs "term" window ---
1341 (defun browse-url-text-emacs (url &optional new-buffer)
1342 "Ask a text browser to load URL.
1343 URL defaults to the URL around or before point.
1344 This runs the text browser specified by `browse-url-text-browser'.
1345 With a prefix argument, it runs a new browser process in a new buffer.
1347 When called interactively, if variable `browse-url-new-window-flag' is
1348 non-nil, load the document in a new browser process in a new term window,
1349 otherwise use any existing one. A non-nil interactive prefix argument
1350 reverses the effect of `browse-url-new-window-flag'.
1352 When called non-interactively, optional second argument NEW-WINDOW is
1353 used instead of `browse-url-new-window-flag'."
1354 (interactive (browse-url-interactive-arg "Text browser URL: "))
1355 (let* ((system-uses-terminfo t) ; Lynx uses terminfo
1356 ;; (term-term-name "vt100") ; ??
1357 (buf (get-buffer "*text browser*"))
1358 (proc (and buf (get-buffer-process buf)))
1359 (n browse-url-text-input-attempts))
1360 (if (and (browse-url-maybe-new-window new-buffer) buf)
1361 ;; Rename away the OLD buffer. This isn't very polite, but
1362 ;; term insists on working in a buffer named *lynx* and would
1363 ;; choke on *lynx*<1>
1364 (progn (set-buffer buf)
1366 (if (or (browse-url-maybe-new-window new-buffer)
1369 (not (memq (process-status proc) '(run stop))))
1370 ;; start a new text browser
1374 `(,browse-url-text-browser
1375 ,browse-url-text-browser
1376 nil ,@browse-url-text-emacs-args
1378 (switch-to-buffer buf)
1380 (set-process-sentinel
1381 (get-buffer-process buf)
1382 ;; Don't leave around a dead one (especially because of its
1384 (lambda (process event)
1385 (if (not (memq (process-status process) '(run stop)))
1386 (let ((buf (process-buffer process)))
1387 (if buf (kill-buffer buf)))))))
1388 ;; Send the url to the text browser in the old buffer
1389 (let ((win (get-buffer-window buf t)))
1392 (switch-to-buffer buf)))
1393 (if (eq (following-char) ?_)
1394 (cond ((eq browse-url-text-input-field 'warn)
1395 (error "Please move out of the input field first"))
1396 ((eq browse-url-text-input-field 'avoid)
1397 (while (and (eq (following-char) ?_) (> n 0))
1398 (term-send-down) ; down arrow
1399 (sit-for browse-url-text-input-delay))
1400 (if (eq (following-char) ?_)
1401 (error "Cannot move out of the input field, sorry")))))
1402 (term-send-string proc (concat "g" ; goto
1403 "\C-u" ; kill default url
1409 (autoload 'rfc2368-parse-mailto-url "rfc2368")
1412 (defun browse-url-mail (url &optional new-window)
1413 "Open a new mail message buffer within Emacs for the RFC 2368 URL.
1414 Default to using the mailto: URL around or before point as the
1415 recipient's address. Supplying a non-nil interactive prefix argument
1416 will cause the mail to be composed in another window rather than the
1419 When called interactively, if variable `browse-url-new-window-flag' is
1420 non-nil use `compose-mail-other-window', otherwise `compose-mail'. A
1421 non-nil interactive prefix argument reverses the effect of
1422 `browse-url-new-window-flag'.
1424 When called non-interactively, optional second argument NEW-WINDOW is
1425 used instead of `browse-url-new-window-flag'."
1426 (interactive (browse-url-interactive-arg "Mailto URL: "))
1428 (let* ((alist (rfc2368-parse-mailto-url url))
1429 (to (assoc "To" alist))
1430 (subject (assoc "Subject" alist))
1431 (body (assoc "Body" alist))
1432 (rest (delete to (delete subject (delete body alist))))
1434 (subject (cdr subject))
1436 (mail-citation-hook (unless body mail-citation-hook)))
1437 (if (browse-url-maybe-new-window new-window)
1438 (compose-mail-other-window to subject rest nil
1441 (list 'insert-buffer (current-buffer))))
1442 (compose-mail to subject rest nil nil
1445 (list 'insert-buffer (current-buffer))))))))
1447 ;; --- Random browser ---
1450 (defun browse-url-generic (url &optional new-window)
1451 ;; new-window ignored
1452 "Ask the WWW browser defined by `browse-url-generic-program' to load URL.
1453 Default to the URL around or before point. A fresh copy of the
1454 browser is started up in a new process with possible additional arguments
1455 `browse-url-generic-args'. This is appropriate for browsers which
1456 don't offer a form of remote control."
1457 (interactive (browse-url-interactive-arg "URL: "))
1458 (if (not browse-url-generic-program)
1459 (error "No browser defined (`browse-url-generic-program')"))
1460 (apply 'call-process browse-url-generic-program nil
1462 (append browse-url-generic-args (list url))))
1465 (defun browse-url-kde (url &optional new-window)
1466 "Ask the KDE WWW browser to load URL.
1467 Default to the URL around or before point."
1468 (interactive (browse-url-interactive-arg "KDE URL: "))
1469 (message "Sending URL to KDE...")
1470 (apply #'start-process (concat "KDE " url) nil browse-url-kde-program
1471 (append browse-url-kde-args (list url))))
1473 (defun browse-url-elinks-new-window (url)
1474 "Ask the Elinks WWW browser to load URL in a new window."
1475 (let ((process-environment (browse-url-process-environment)))
1476 (apply #'start-process
1477 (append (list (concat "elinks:" url)
1479 browse-url-elinks-wrapper
1480 (list "elinks" url)))))
1483 (defun browse-url-elinks (url &optional new-window)
1484 "Ask the Elinks WWW browser to load URL.
1485 Default to the URL around the point.
1487 The document is loaded in a new tab of a running Elinks or, if
1488 none yet running, a newly started instance.
1490 The Elinks command will be prepended by the program+arguments
1491 from `browse-url-elinks-wrapper'."
1492 (interactive (browse-url-interactive-arg "URL: "))
1493 (setq url (browse-url-encode-url url))
1495 (browse-url-elinks-new-window url)
1496 (let ((process-environment (browse-url-process-environment))
1497 (elinks-ping-process (start-process "elinks-ping" nil
1498 "elinks" "-remote" "ping()")))
1499 (set-process-sentinel elinks-ping-process
1500 `(lambda (process change)
1501 (browse-url-elinks-sentinel process ,url))))))
1503 (defun browse-url-elinks-sentinel (process url)
1504 "Determines if Elinks is running or a new one has to be started."
1505 (let ((exit-status (process-exit-status process)))
1506 ;; Try to determine if an instance is running or if we have to
1507 ;; create a new one.
1510 ;; No instance, start a new one.
1511 (browse-url-elinks-new-window url))
1513 ;; Found an instance, open URL in new tab.
1514 (let ((process-environment (browse-url-process-environment)))
1515 (start-process (concat "elinks:" url) nil
1517 (concat "openURL(\"" url "\",new-tab)"))))
1519 (error "Unrecognized exit-code %d of process `elinks'"
1522 (provide 'browse-url)
1524 ;; arch-tag: d2079573-5c06-4097-9598-f550fba19430
1525 ;;; browse-url.el ends here