1 ;;; browse-url.el --- pass a URL to a WWW browser
3 ;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
4 ;; 2004, 2005, 2006, 2007, 2008, 2009, 2010
5 ;; Free Software Foundation, Inc.
7 ;; Author: Denis Howe <dbh@doc.ic.ac.uk>
9 ;; Created: 03 Apr 1995
10 ;; Keywords: hypertext, hypermedia, mouse
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
29 ;; This package provides functions which read a URL (Uniform Resource
30 ;; Locator) from the minibuffer, defaulting to the URL around point,
31 ;; and ask a World-Wide Web browser to load it. It can also load the
32 ;; URL associated with the current buffer. Different browsers use
33 ;; different methods of remote control so there is one function for
34 ;; each supported browser. If the chosen browser is not running, it
35 ;; is started. Currently there is support for the following browsers,
36 ;; some of them probably now obsolete:
38 ;; Function Browser Earliest version
39 ;; browse-url-mozilla Mozilla Don't know
40 ;; browse-url-firefox Firefox Don't know (tried with 1.0.1)
41 ;; browse-url-galeon Galeon Don't know
42 ;; browse-url-epiphany Epiphany Don't know
43 ;; browse-url-netscape Netscape 1.1b1
44 ;; browse-url-mosaic XMosaic/mMosaic <= 2.4
45 ;; browse-url-cci XMosaic 2.5
47 ;; browse-url-w3-gnudoit w3 remotely
48 ;; browse-url-text-* Any text browser 0
49 ;; browse-url-generic arbitrary
50 ;; browse-url-default-windows-browser MS-Windows browser
51 ;; browse-url-default-macosx-browser Mac OS X browser
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
220 ((memq system-type '(windows-nt ms-dos cygwin))
221 'browse-url-default-windows-browser)
222 ((memq system-type '(darwin))
223 'browse-url-default-macosx-browser)
225 'browse-url-default-browser))
226 "Function to display the current buffer in a WWW browser.
227 This is used by the `browse-url-at-point', `browse-url-at-mouse', and
228 `browse-url-of-file' commands.
230 If the value is not a function it should be a list of pairs
231 \(REGEXP . FUNCTION). In this case the function called will be the one
232 associated with the first REGEXP which matches the current URL. The
233 function is passed the URL and any other args of `browse-url'. The last
234 regexp should probably be \".\" to specify a default browser."
236 (function-item :tag "Emacs W3" :value browse-url-w3)
237 (function-item :tag "W3 in another Emacs via `gnudoit'"
238 :value browse-url-w3-gnudoit)
239 (function-item :tag "Mozilla" :value browse-url-mozilla)
240 (function-item :tag "Firefox" :value browse-url-firefox)
241 (function-item :tag "Galeon" :value browse-url-galeon)
242 (function-item :tag "Epiphany" :value browse-url-epiphany)
243 (function-item :tag "Netscape" :value browse-url-netscape)
244 (function-item :tag "Mosaic" :value browse-url-mosaic)
245 (function-item :tag "Mosaic using CCI" :value browse-url-cci)
246 (function-item :tag "Text browser in an xterm window"
247 :value browse-url-text-xterm)
248 (function-item :tag "Text browser in an Emacs window"
249 :value browse-url-text-emacs)
250 (function-item :tag "KDE" :value browse-url-kde)
251 (function-item :tag "Elinks" :value browse-url-elinks)
252 (function-item :tag "Specified by `Browse Url Generic Program'"
253 :value browse-url-generic)
254 (function-item :tag "Default Windows browser"
255 :value browse-url-default-windows-browser)
256 (function-item :tag "Default Mac OS X browser"
257 :value browse-url-default-macosx-browser)
258 (function-item :tag "GNOME invoking Mozilla"
259 :value browse-url-gnome-moz)
260 (function-item :tag "Default browser"
261 :value browse-url-default-browser)
262 (function :tag "Your own function")
263 (alist :tag "Regexp/function association list"
264 :key-type regexp :value-type function))
268 (defcustom browse-url-mailto-function 'browse-url-mail
269 "Function to display mailto: links.
270 This variable uses the same syntax as the
271 `browse-url-browser-function' variable. If the
272 `browse-url-mailto-function' variable is nil, that variable will
275 (function-item :tag "Emacs Mail" :value browse-url-mail)
276 (function-item :tag "None" nil))
280 (defcustom browse-url-netscape-program "netscape"
281 ;; Info about netscape-remote from Karl Berry.
282 "The name by which to invoke Netscape.
284 The free program `netscape-remote' from
285 <URL:http://home.netscape.com/newsref/std/remote.c> is said to start
286 up very much quicker than `netscape'. Reported to compile on a GNU
287 system, given vroot.h from the same directory, with cc flags
288 -DSTANDALONE -L/usr/X11R6/lib -lXmu -lX11."
292 (defcustom browse-url-netscape-arguments nil
293 "A list of strings to pass to Netscape as arguments."
294 :type '(repeat (string :tag "Argument"))
297 (defcustom browse-url-netscape-startup-arguments browse-url-netscape-arguments
298 "A list of strings to pass to Netscape when it starts up.
299 Defaults to the value of `browse-url-netscape-arguments' at the time
300 `browse-url' is loaded."
301 :type '(repeat (string :tag "Argument"))
304 (defcustom browse-url-browser-display nil
305 "The X display for running the browser, if not same as Emacs'."
306 :type '(choice string (const :tag "Default" nil))
309 (defcustom browse-url-mozilla-program "mozilla"
310 "The name by which to invoke Mozilla."
314 (defcustom browse-url-mozilla-arguments nil
315 "A list of strings to pass to Mozilla as arguments."
316 :type '(repeat (string :tag "Argument"))
319 (defcustom browse-url-mozilla-startup-arguments browse-url-mozilla-arguments
320 "A list of strings to pass to Mozilla when it starts up.
321 Defaults to the value of `browse-url-mozilla-arguments' at the time
322 `browse-url' is loaded."
323 :type '(repeat (string :tag "Argument"))
326 (defcustom browse-url-firefox-program
327 (let ((candidates '("firefox" "iceweasel")))
328 (while (and candidates (not (executable-find (car candidates))))
329 (setq candidates (cdr candidates)))
330 (or (car candidates) "firefox"))
331 "The name by which to invoke Firefox."
335 (defcustom browse-url-firefox-arguments nil
336 "A list of strings to pass to Firefox as arguments."
337 :type '(repeat (string :tag "Argument"))
340 (defcustom browse-url-firefox-startup-arguments browse-url-firefox-arguments
341 "A list of strings to pass to Firefox when it starts up.
342 Defaults to the value of `browse-url-firefox-arguments' at the time
343 `browse-url' is loaded."
344 :type '(repeat (string :tag "Argument"))
347 (defcustom browse-url-galeon-program "galeon"
348 "The name by which to invoke Galeon."
352 (defcustom browse-url-galeon-arguments nil
353 "A list of strings to pass to Galeon as arguments."
354 :type '(repeat (string :tag "Argument"))
357 (defcustom browse-url-galeon-startup-arguments browse-url-galeon-arguments
358 "A list of strings to pass to Galeon when it starts up.
359 Defaults to the value of `browse-url-galeon-arguments' at the time
360 `browse-url' is loaded."
361 :type '(repeat (string :tag "Argument"))
364 (defcustom browse-url-epiphany-program "epiphany"
365 "The name by which to invoke Epiphany."
369 (defcustom browse-url-epiphany-arguments nil
370 "A list of strings to pass to Epiphany as arguments."
371 :type '(repeat (string :tag "Argument"))
374 (defcustom browse-url-epiphany-startup-arguments browse-url-epiphany-arguments
375 "A list of strings to pass to Epiphany when it starts up.
376 Defaults to the value of `browse-url-epiphany-arguments' at the time
377 `browse-url' is loaded."
378 :type '(repeat (string :tag "Argument"))
381 ;; GNOME means of invoking either Mozilla or Netrape.
382 (defvar browse-url-gnome-moz-program "gnome-moz-remote")
384 (defcustom browse-url-gnome-moz-arguments '()
385 "A list of strings passed to the GNOME mozilla viewer as arguments."
387 :type '(repeat (string :tag "Argument"))
390 (defcustom browse-url-mozilla-new-window-is-tab nil
391 "Whether to open up new windows in a tab or a new window.
392 If non-nil, then open the URL in a new tab rather than a new window if
393 `browse-url-mozilla' is asked to open it in a new window."
397 (defcustom browse-url-firefox-new-window-is-tab nil
398 "Whether to open up new windows in a tab or a new window.
399 If non-nil, then open the URL in a new tab rather than a new window if
400 `browse-url-firefox' is asked to open it in a new window.
402 This option is currently ignored on MS-Windows, since the necessary
403 functionality is not available there."
407 (defcustom browse-url-galeon-new-window-is-tab nil
408 "Whether to open up new windows in a tab or a new window.
409 If non-nil, then open the URL in a new tab rather than a new window if
410 `browse-url-galeon' is asked to open it in a new window."
414 (defcustom browse-url-epiphany-new-window-is-tab nil
415 "Whether to open up new windows in a tab or a new window.
416 If non-nil, then open the URL in a new tab rather than a new window if
417 `browse-url-epiphany' is asked to open it in a new window."
421 (defcustom browse-url-netscape-new-window-is-tab nil
422 "Whether to open up new windows in a tab or a new window.
423 If non-nil, then open the URL in a new tab rather than a new
424 window if `browse-url-netscape' is asked to open it in a new
429 (defcustom browse-url-new-window-flag nil
430 "Non-nil means always open a new browser window with appropriate browsers.
431 Passing an interactive argument to \\[browse-url], or specific browser
432 commands reverses the effect of this variable. Requires Netscape version
433 1.1N or later or XMosaic version 2.5 or later if using those browsers."
437 (defcustom browse-url-mosaic-program "xmosaic"
438 "The name by which to invoke Mosaic (or mMosaic)."
443 (defcustom browse-url-mosaic-arguments nil
444 "A list of strings to pass to Mosaic as arguments."
445 :type '(repeat (string :tag "Argument"))
448 (defcustom browse-url-mosaic-pidfile "~/.mosaicpid"
449 "The name of the pidfile created by Mosaic."
453 (defcustom browse-url-filename-alist
454 `(("^/\\(ftp@\\|anonymous@\\)?\\([^:]+\\):/*" . "ftp://\\2/")
455 ;; The above loses the username to avoid the browser prompting for
456 ;; it in anonymous cases. If it's not anonymous the next regexp
458 ("^/\\([^:@]+@\\)?\\([^:]+\\):/*" . "ftp://\\1\\2/")
459 ,@(if (memq system-type '(windows-nt ms-dos cygwin))
460 '(("^\\([a-zA-Z]:\\)[\\/]" . "file:///\\1/")
461 ("^[\\/][\\/]+" . "file://")))
462 ("^/+" . "file:///"))
463 "An alist of (REGEXP . STRING) pairs used by `browse-url-of-file'.
464 Any substring of a filename matching one of the REGEXPs is replaced by
465 the corresponding STRING using `replace-match', not treating STRING
466 literally. All pairs are applied in the order given. The default
467 value converts ange-ftp/EFS-style file names into ftp URLs and prepends
468 `file:' to any file name beginning with `/'.
470 For example, adding to the default a specific translation of an ange-ftp
471 address to an HTTP URL:
473 (setq browse-url-filename-alist
474 '((\"/webmaster@webserver:/home/www/html/\" .
475 \"http://www.acme.co.uk/\")
476 (\"^/\\(ftp@\\|anonymous@\\)?\\([^:]+\\):/*\" . \"ftp://\\2/\")
477 (\"^/\\([^:@]+@\\)?\\([^:]+\\):/*\" . \"ftp://\\1\\2/\")
478 (\"^/+\" . \"file:/\")))"
479 :type '(repeat (cons :format "%v"
480 (regexp :tag "Regexp")
481 (string :tag "Replacement")))
485 (defcustom browse-url-save-file nil
486 "If non-nil, save the buffer before displaying its file.
487 Used by the `browse-url-of-file' command."
491 (defcustom browse-url-of-file-hook nil
492 "Run after `browse-url-of-file' has asked a browser to load a file.
494 Set this to `browse-url-netscape-reload' to force Netscape to load the
495 file rather than displaying a cached copy."
497 :options '(browse-url-netscape-reload)
500 (defcustom browse-url-CCI-port 3003
501 "Port to access XMosaic via CCI.
502 This can be any number between 1024 and 65535 but must correspond to
503 the value set in the browser."
507 (defcustom browse-url-CCI-host "localhost"
508 "Host to access XMosaic via CCI.
509 This should be the host name of the machine running XMosaic with CCI
510 enabled. The port number should be set in `browse-url-CCI-port'."
514 (defvar browse-url-temp-file-name nil)
515 (make-variable-buffer-local 'browse-url-temp-file-name)
517 (defcustom browse-url-xterm-program "xterm"
518 "The name of the terminal emulator used by `browse-url-text-xterm'.
519 This might, for instance, be a separate color version of xterm."
523 (defcustom browse-url-xterm-args nil
524 "A list of strings defining options for `browse-url-xterm-program'.
525 These might set its size, for instance."
526 :type '(repeat (string :tag "Argument"))
529 (defcustom browse-url-gnudoit-program "gnudoit"
530 "The name of the `gnudoit' program used by `browse-url-w3-gnudoit'."
534 (defcustom browse-url-gnudoit-args '("-q")
535 "A list of strings defining options for `browse-url-gnudoit-program'.
536 These might set the port, for instance."
537 :type '(repeat (string :tag "Argument"))
540 (defcustom browse-url-generic-program nil
541 "The name of the browser program used by `browse-url-generic'."
542 :type '(choice string (const :tag "None" nil))
545 (defcustom browse-url-generic-args nil
546 "A list of strings defining options for `browse-url-generic-program'."
547 :type '(repeat (string :tag "Argument"))
550 (defcustom browse-url-temp-dir temporary-file-directory
551 "The name of a directory for browse-url's temporary files.
552 Such files are generated by functions like `browse-url-of-region'.
553 You might want to set this to somewhere with restricted read permissions
558 (defcustom browse-url-netscape-version 3
559 "The version of Netscape you are using.
560 This affects how URL reloading is done; the mechanism changed
561 incompatibly at version 4."
565 (defcustom browse-url-text-browser "lynx"
566 "The name of the text browser to invoke."
571 (defcustom browse-url-text-emacs-args (and (not window-system)
573 "A list of strings defining options for a text browser in an Emacs buffer.
575 The default is none in a window system, otherwise `-show_cursor' to
576 indicate the position of the current link in the absence of
577 highlighting, assuming the normal default for showing the cursor."
578 :type '(repeat (string :tag "Argument"))
582 (defcustom browse-url-text-input-field 'avoid
583 "Action on selecting an existing text browser buffer at an input field.
584 What to do when sending a new URL to an existing text browser buffer in Emacs
585 if the browser cursor is on an input field (in which case the `g' command
586 would be entered as data). Such fields are recognized by the
587 underlines ____. Allowed values: nil: disregard it, `warn': warn the
588 user and don't emit the URL, `avoid': try to avoid the field by moving
589 down (this *won't* always work)."
590 :type '(choice (const :tag "Move to try to avoid field" :value avoid)
591 (const :tag "Disregard" :value nil)
592 (const :tag "Warn, don't emit URL" :value warn))
596 (defcustom browse-url-text-input-attempts 10
597 "How many times to try to move down from a series of text browser input fields."
602 (defcustom browse-url-text-input-delay 0.2
603 "Seconds to wait for a text browser between moves down from an input field."
608 (defcustom browse-url-kde-program "kfmclient"
609 "The name by which to invoke the KDE web browser."
614 (defcustom browse-url-kde-args '("openURL")
615 "A list of strings defining options for `browse-url-kde-program'."
616 :type '(repeat (string :tag "Argument"))
619 (defcustom browse-url-elinks-wrapper '("xterm" "-e")
620 "Wrapper command prepended to the Elinks command-line."
621 :type '(repeat (string :tag "Wrapper"))
624 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
627 (defun browse-url-url-encode-chars (text chars)
628 "URL-encode the chars in TEXT that match CHARS.
629 CHARS is a regexp-like character alternative (e.g., \"[)$]\")."
630 (let ((encoded-text (copy-sequence text))
632 (while (setq s (string-match chars encoded-text s))
634 (replace-match (format "%%%x"
635 (string-to-char (match-string 0 encoded-text)))
640 (defun browse-url-encode-url (url)
641 "Escape annoying characters in URL.
642 The annoying characters are those that can mislead a web browser
643 regarding its parameter treatment."
644 ;; FIXME: Is there an actual example of a web browser getting
645 ;; confused? (This used to encode commas, but at least Firefox
646 ;; handles commas correctly and doesn't accept encoded commas.)
647 (browse-url-url-encode-chars url "[)$]"))
649 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
652 (defun browse-url-url-at-point ()
653 (let ((url (thing-at-point 'url)))
654 (set-text-properties 0 (length url) nil url)
657 ;; Having this as a separate function called by the browser-specific
658 ;; functions allows them to be stand-alone commands, making it easier
659 ;; to switch between browsers.
661 (defun browse-url-interactive-arg (prompt)
662 "Read a URL from the minibuffer, prompting with PROMPT.
663 If `transient-mark-mode' is non-nil and the mark is active,
664 it defaults to the current region, else to the URL at or before
665 point. If invoked with a mouse button, it moves point to the
666 position clicked before acting.
668 This function returns a list (URL NEW-WINDOW-FLAG)
669 for use in `interactive'."
670 (let ((event (elt (this-command-keys) 0)))
671 (and (listp event) (mouse-set-point event)))
672 (list (read-string prompt (or (and transient-mark-mode mark-active
673 ;; rfc2396 Appendix E.
674 (replace-regexp-in-string
676 (buffer-substring-no-properties
677 (region-beginning) (region-end))))
678 (browse-url-url-at-point)))
679 (not (eq (null browse-url-new-window-flag)
680 (null current-prefix-arg)))))
682 ;; called-interactive-p needs to be called at a function's top-level, hence
683 ;; this macro. We use that rather than interactive-p because
684 ;; use in a keyboard macro should not change this behavior.
685 (defmacro browse-url-maybe-new-window (arg)
686 `(if (or noninteractive (not (called-interactively-p 'any)))
688 browse-url-new-window-flag))
690 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
691 ;; Browse current buffer
694 (defun browse-url-of-file (&optional file)
695 "Ask a WWW browser to display FILE.
696 Display the current buffer's file if FILE is nil or if called
697 interactively. Turn the filename into a URL with function
698 `browse-url-file-url'. Pass the URL to a browser using the
699 `browse-url' function then run `browse-url-of-file-hook'."
702 (setq file (buffer-file-name))
703 (error "Current buffer has no file"))
704 (let ((buf (get-file-buffer file)))
706 (with-current-buffer buf
707 (cond ((not (buffer-modified-p)))
708 (browse-url-save-file (save-buffer))
709 (t (message "%s modified since last save" file))))))
710 (browse-url (browse-url-file-url file))
711 (run-hooks 'browse-url-of-file-hook))
713 (defun browse-url-file-url (file)
714 "Return the URL corresponding to FILE.
715 Use variable `browse-url-filename-alist' to map filenames to URLs."
716 ;; De-munge Cygwin filenames before passing them to Windows browser.
717 (if (eq system-type 'cygwin)
718 (let ((winfile (with-output-to-string
719 (call-process "cygpath" nil standard-output
721 (setq file (substring winfile 0 -1))))
722 (let ((coding (and (default-value 'enable-multibyte-characters)
723 (or file-name-coding-system
724 default-file-name-coding-system))))
725 (if coding (setq file (encode-coding-string file coding))))
726 (setq file (browse-url-url-encode-chars file "[*\"()',=;?% ]"))
727 (dolist (map browse-url-filename-alist)
728 (when (and map (string-match (car map) file))
729 (setq file (replace-match (cdr map) t nil file))))
733 (defun browse-url-of-buffer (&optional buffer)
734 "Ask a WWW browser to display BUFFER.
735 Display the current buffer if BUFFER is nil. Display only the
736 currently visible part of BUFFER (from a temporary file) if buffer is
740 (and buffer (set-buffer buffer))
742 ;; Ignore real name if restricted
743 (and (= (- (point-max) (point-min)) (buffer-size))
745 (and (boundp 'dired-directory) dired-directory)))))
748 (or browse-url-temp-file-name
749 (setq browse-url-temp-file-name
750 (convert-standard-filename
752 (expand-file-name "burl" browse-url-temp-dir)
754 (setq file-name browse-url-temp-file-name)
755 (write-region (point-min) (point-max) file-name nil 'no-message)))
756 (browse-url-of-file file-name))))
758 (defun browse-url-delete-temp-file (&optional temp-file-name)
759 ;; Delete browse-url-temp-file-name from the file system
760 ;; If optional arg TEMP-FILE-NAME is non-nil, delete it instead
761 (let ((file-name (or temp-file-name browse-url-temp-file-name)))
762 (if (and file-name (file-exists-p file-name))
763 (delete-file file-name))))
765 (add-hook 'kill-buffer-hook 'browse-url-delete-temp-file)
767 (declare-function dired-get-filename "dired"
768 (&optional localp no-error-if-not-filep))
771 (defun browse-url-of-dired-file ()
772 "In Dired, ask a WWW browser to display the file named on this line."
774 (browse-url-of-file (dired-get-filename)))
777 (defun browse-url-of-region (min max)
778 "Ask a WWW browser to display the current region."
782 (narrow-to-region min max)
783 (browse-url-of-buffer))))
785 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
786 ;; Browser-independent commands
788 ;; A generic command to call the current browse-url-browser-function
791 (defun browse-url (url &rest args)
792 "Ask a WWW browser to load URL.
793 Prompts for a URL, defaulting to the URL at or before point. Variable
794 `browse-url-browser-function' says which browser to use.
795 If the URL is a mailto: URL, consult `browse-url-mailto-function'
796 first, if that exists."
797 (interactive (browse-url-interactive-arg "URL: "))
798 (unless (called-interactively-p 'interactive)
799 (setq args (or args (list browse-url-new-window-flag))))
800 (let ((process-environment (copy-sequence process-environment))
801 (function (or (and (string-match "\\`mailto:" url)
802 browse-url-mailto-function)
803 browse-url-browser-function)))
804 ;; When connected to various displays, be careful to use the display of
805 ;; the currently selected frame, rather than the original start display,
806 ;; which may not even exist any more.
807 (if (stringp (frame-parameter (selected-frame) 'display))
808 (setenv "DISPLAY" (frame-parameter (selected-frame) 'display)))
809 (if (and (consp function)
810 (not (functionp function)))
811 ;; The `function' can be an alist; look down it for first match
812 ;; and apply the function (which might be a lambda).
814 (dolist (bf function)
815 (when (string-match (car bf) url)
816 (apply (cdr bf) url args)
818 (error "No browse-url-browser-function matching URL %s"
820 ;; Unbound symbols go down this leg, since void-function from
821 ;; apply is clearer than wrong-type-argument from dolist.
822 (apply function url args))))
825 (defun browse-url-at-point (&optional arg)
826 "Ask a WWW browser to load the URL at or before point.
827 Doesn't let you edit the URL like `browse-url'. Variable
828 `browse-url-browser-function' says which browser to use."
830 (let ((url (browse-url-url-at-point)))
832 (browse-url url (if arg
833 (not browse-url-new-window-flag)
834 browse-url-new-window-flag))
835 (error "No URL found"))))
838 (defun browse-url-at-mouse (event)
839 "Ask a WWW browser to load a URL clicked with the mouse.
840 The URL is the one around or before the position of the mouse click
841 but point is not changed. Doesn't let you edit the URL like
842 `browse-url'. Variable `browse-url-browser-function' says which browser
846 (mouse-set-point event)
847 ;; This handles browse-url-new-window-flag properly
848 ;; when it gets no arg.
849 (browse-url-at-point)))
851 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
852 ;; Browser-specific commands
854 ;; --- Default MS-Windows browser ---
856 (defvar dos-windows-version)
857 (declare-function w32-shell-execute "w32fns.c") ;; Defined in C.
859 (defun browse-url-default-windows-browser (url &optional new-window)
860 (interactive (browse-url-interactive-arg "URL: "))
861 (cond ((eq system-type 'ms-dos)
862 (if dos-windows-version
863 (shell-command (concat "start " (shell-quote-argument url)))
864 (error "Browsing URLs is not supported on this system")))
865 ((eq system-type 'cygwin)
866 (call-process "cygstart" nil nil nil url))
867 (t (w32-shell-execute "open" url))))
869 (defun browse-url-default-macosx-browser (url &optional new-window)
870 (interactive (browse-url-interactive-arg "URL: "))
871 (start-process (concat "open " url) nil "open" url))
875 (defun browse-url-process-environment ()
876 "Set DISPLAY in the environment to the X display the browser will use.
877 This is either the value of variable `browse-url-browser-display' if
878 non-nil, or the same display as Emacs if different from the current
879 environment, otherwise just use the current environment."
880 (let ((display (or browse-url-browser-display (browse-url-emacs-display))))
882 (cons (concat "DISPLAY=" display) process-environment)
883 process-environment)))
885 (defun browse-url-emacs-display ()
886 "Return the X display Emacs is running on.
887 This is nil if the display is the same as the DISPLAY environment variable.
889 Actually Emacs could be using several displays; this just returns the
890 one showing the selected frame."
891 (let ((display (cdr-safe (assq 'display (frame-parameters)))))
892 (and (not (equal display (getenv "DISPLAY")))
895 (defun browse-url-default-browser (url &rest args)
896 "Find a suitable browser and ask it to load URL.
897 Default to the URL around or before point.
899 When called interactively, if variable `browse-url-new-window-flag' is
900 non-nil, load the document in a new window, if possible, otherwise use
901 a random existing one. A non-nil interactive prefix argument reverses
902 the effect of `browse-url-new-window-flag'.
904 When called non-interactively, optional second argument NEW-WINDOW is
905 used instead of `browse-url-new-window-flag'.
907 The order attempted is gnome-moz-remote, Mozilla, Firefox,
908 Galeon, Konqueror, Netscape, Mosaic, Lynx in an xterm, and then W3."
911 ((browse-url-can-use-xdg-open) 'browse-url-xdg-open)
912 ((executable-find browse-url-gnome-moz-program) 'browse-url-gnome-moz)
913 ((executable-find browse-url-mozilla-program) 'browse-url-mozilla)
914 ((executable-find browse-url-firefox-program) 'browse-url-firefox)
915 ((executable-find browse-url-galeon-program) 'browse-url-galeon)
916 ((executable-find browse-url-kde-program) 'browse-url-kde)
917 ((executable-find browse-url-netscape-program) 'browse-url-netscape)
918 ((executable-find browse-url-mosaic-program) 'browse-url-mosaic)
919 ((executable-find browse-url-xterm-program) 'browse-url-text-xterm)
920 ((locate-library "w3") 'browse-url-w3)
922 (lambda (&rest ignore) (error "No usable browser found"))))
925 (defun browse-url-can-use-xdg-open ()
926 "Check if xdg-open can be used, i.e. we are on Gnome, KDE or xfce4."
927 (and (getenv "DISPLAY")
928 (executable-find "xdg-open")
929 ;; xdg-open may call gnome-open and that does not wait for its child
930 ;; to finish. This child may then be killed when the parent dies.
931 ;; Use nohup to work around.
932 (executable-find "nohup")
933 (or (getenv "GNOME_DESKTOP_SESSION_ID")
934 ;; GNOME_DESKTOP_SESSION_ID is deprecated, check on Dbus also.
937 "dbus-send" nil nil nil
938 "--dest=org.gnome.SessionManager"
940 "/org/gnome/SessionManager"
941 "org.gnome.SessionManager.CanShutdown"))
943 (equal (getenv "KDE_FULL_SESSION") "true")
946 "/bin/sh" nil nil nil
948 "xprop -root _DT_SAVE_MODE|grep xfce4"))
953 (defun browse-url-xdg-open (url &optional new-window)
954 (interactive (browse-url-interactive-arg "URL: "))
955 (call-process "nohup" nil nil nil "xdg-open" url))
958 (defun browse-url-netscape (url &optional new-window)
959 "Ask the Netscape WWW browser to load URL.
960 Default to the URL around or before point. The strings in variable
961 `browse-url-netscape-arguments' are also passed to Netscape.
963 When called interactively, if variable `browse-url-new-window-flag' is
964 non-nil, load the document in a new Netscape window, otherwise use a
965 random existing one. A non-nil interactive prefix argument reverses
966 the effect of `browse-url-new-window-flag'.
968 If `browse-url-netscape-new-window-is-tab' is non-nil, then
969 whenever a document would otherwise be loaded in a new window, it
970 is loaded in a new tab in an existing window instead.
972 When called non-interactively, optional second argument NEW-WINDOW is
973 used instead of `browse-url-new-window-flag'."
974 (interactive (browse-url-interactive-arg "URL: "))
975 (setq url (browse-url-encode-url url))
976 (let* ((process-environment (browse-url-process-environment))
978 (apply 'start-process
979 (concat "netscape " url) nil
980 browse-url-netscape-program
982 browse-url-netscape-arguments
983 (if (eq window-system 'w32)
986 (if new-window '("-noraise"))
988 (concat "openURL(" url
989 (if (browse-url-maybe-new-window
991 (if browse-url-netscape-new-window-is-tab
995 (set-process-sentinel process
996 `(lambda (process change)
997 (browse-url-netscape-sentinel process ,url)))))
999 (defun browse-url-netscape-sentinel (process url)
1000 "Handle a change to the process communicating with Netscape."
1001 (or (eq (process-exit-status process) 0)
1002 (let* ((process-environment (browse-url-process-environment)))
1003 ;; Netscape not running - start it
1004 (message "Starting %s..." browse-url-netscape-program)
1005 (apply 'start-process (concat "netscape" url) nil
1006 browse-url-netscape-program
1007 (append browse-url-netscape-startup-arguments (list url))))))
1009 (defun browse-url-netscape-reload ()
1010 "Ask Netscape to reload its current document.
1011 How depends on `browse-url-netscape-version'."
1013 ;; Backwards incompatibility reported by
1014 ;; <peter.kruse@psychologie.uni-regensburg.de>.
1015 (browse-url-netscape-send (if (>= browse-url-netscape-version 4)
1016 "xfeDoCommand(reload)"
1019 (defun browse-url-netscape-send (command)
1020 "Send a remote control command to Netscape."
1021 (let* ((process-environment (browse-url-process-environment)))
1022 (apply 'start-process "netscape" nil
1023 browse-url-netscape-program
1024 (append browse-url-netscape-arguments
1025 (list "-remote" command)))))
1028 (defun browse-url-mozilla (url &optional new-window)
1029 "Ask the Mozilla WWW browser to load URL.
1030 Default to the URL around or before point. The strings in variable
1031 `browse-url-mozilla-arguments' are also passed to Mozilla.
1033 When called interactively, if variable `browse-url-new-window-flag' is
1034 non-nil, load the document in a new Mozilla window, otherwise use a
1035 random existing one. A non-nil interactive prefix argument reverses
1036 the effect of `browse-url-new-window-flag'.
1038 If `browse-url-mozilla-new-window-is-tab' is non-nil, then whenever a
1039 document would otherwise be loaded in a new window, it is loaded in a
1040 new tab in an existing window instead.
1042 When called non-interactively, optional second argument NEW-WINDOW is
1043 used instead of `browse-url-new-window-flag'."
1044 (interactive (browse-url-interactive-arg "URL: "))
1045 (setq url (browse-url-encode-url url))
1046 (let* ((process-environment (browse-url-process-environment))
1048 (apply 'start-process
1049 (concat "mozilla " url) nil
1050 browse-url-mozilla-program
1052 browse-url-mozilla-arguments
1056 (if (browse-url-maybe-new-window
1058 (if browse-url-mozilla-new-window-is-tab
1062 (set-process-sentinel process
1063 `(lambda (process change)
1064 (browse-url-mozilla-sentinel process ,url)))))
1066 (defun browse-url-mozilla-sentinel (process url)
1067 "Handle a change to the process communicating with Mozilla."
1068 (or (eq (process-exit-status process) 0)
1069 (let* ((process-environment (browse-url-process-environment)))
1070 ;; Mozilla is not running - start it
1071 (message "Starting %s..." browse-url-mozilla-program)
1072 (apply 'start-process (concat "mozilla " url) nil
1073 browse-url-mozilla-program
1074 (append browse-url-mozilla-startup-arguments (list url))))))
1077 (defun browse-url-firefox (url &optional new-window)
1078 "Ask the Firefox WWW browser to load URL.
1079 Default to the URL around or before point. The strings in
1080 variable `browse-url-firefox-arguments' are also passed to
1083 When called interactively, if variable
1084 `browse-url-new-window-flag' is non-nil, load the document in a
1085 new Firefox window, otherwise use a random existing one. A
1086 non-nil interactive prefix argument reverses the effect of
1087 `browse-url-new-window-flag'.
1089 If `browse-url-firefox-new-window-is-tab' is non-nil, then
1090 whenever a document would otherwise be loaded in a new window, it
1091 is loaded in a new tab in an existing window instead.
1093 When called non-interactively, optional second argument
1094 NEW-WINDOW is used instead of `browse-url-new-window-flag'.
1096 On MS-Windows systems the optional `new-window' parameter is
1097 ignored. Firefox for Windows does not support the \"-remote\"
1098 command line parameter. Therefore, the
1099 `browse-url-new-window-flag' and `browse-url-firefox-new-window-is-tab'
1100 are ignored as well. Firefox on Windows will always open the requested
1101 URL in a new window."
1102 (interactive (browse-url-interactive-arg "URL: "))
1103 (setq url (browse-url-encode-url url))
1104 (let* ((process-environment (browse-url-process-environment))
1106 (apply 'start-process
1107 (concat "firefox " url) nil
1108 browse-url-firefox-program
1110 browse-url-firefox-arguments
1111 (if (or (featurep 'dos-w32)
1112 (string-match "win32" system-configuration))
1117 (if (browse-url-maybe-new-window
1119 (if browse-url-firefox-new-window-is-tab
1123 (set-process-sentinel process
1124 `(lambda (process change)
1125 (browse-url-firefox-sentinel process ,url)))))
1127 (defun browse-url-firefox-sentinel (process url)
1128 "Handle a change to the process communicating with Firefox."
1129 (or (eq (process-exit-status process) 0)
1130 (let* ((process-environment (browse-url-process-environment)))
1131 ;; Firefox is not running - start it
1132 (message "Starting Firefox...")
1133 (apply 'start-process (concat "firefox " url) nil
1134 browse-url-firefox-program
1135 (append browse-url-firefox-startup-arguments (list url))))))
1138 (defun browse-url-galeon (url &optional new-window)
1139 "Ask the Galeon WWW browser to load URL.
1140 Default to the URL around or before point. The strings in variable
1141 `browse-url-galeon-arguments' are also passed to Galeon.
1143 When called interactively, if variable `browse-url-new-window-flag' is
1144 non-nil, load the document in a new Galeon window, otherwise use a
1145 random existing one. A non-nil interactive prefix argument reverses
1146 the effect of `browse-url-new-window-flag'.
1148 If `browse-url-galeon-new-window-is-tab' is non-nil, then whenever a
1149 document would otherwise be loaded in a new window, it is loaded in a
1150 new tab in an existing window instead.
1152 When called non-interactively, optional second argument NEW-WINDOW is
1153 used instead of `browse-url-new-window-flag'."
1154 (interactive (browse-url-interactive-arg "URL: "))
1155 (setq url (browse-url-encode-url url))
1156 (let* ((process-environment (browse-url-process-environment))
1157 (process (apply 'start-process
1158 (concat "galeon " url)
1160 browse-url-galeon-program
1162 browse-url-galeon-arguments
1163 (if (browse-url-maybe-new-window new-window)
1164 (if browse-url-galeon-new-window-is-tab
1166 '("--new-window" "--noraise"))
1169 (set-process-sentinel process
1170 `(lambda (process change)
1171 (browse-url-galeon-sentinel process ,url)))))
1173 (defun browse-url-galeon-sentinel (process url)
1174 "Handle a change to the process communicating with Galeon."
1175 (or (eq (process-exit-status process) 0)
1176 (let* ((process-environment (browse-url-process-environment)))
1177 ;; Galeon is not running - start it
1178 (message "Starting %s..." browse-url-galeon-program)
1179 (apply 'start-process (concat "galeon " url) nil
1180 browse-url-galeon-program
1181 (append browse-url-galeon-startup-arguments (list url))))))
1183 (defun browse-url-epiphany (url &optional new-window)
1184 "Ask the Epiphany WWW browser to load URL.
1185 Default to the URL around or before point. The strings in variable
1186 `browse-url-galeon-arguments' are also passed to Epiphany.
1188 When called interactively, if variable `browse-url-new-window-flag' is
1189 non-nil, load the document in a new Epiphany window, otherwise use a
1190 random existing one. A non-nil interactive prefix argument reverses
1191 the effect of `browse-url-new-window-flag'.
1193 If `browse-url-epiphany-new-window-is-tab' is non-nil, then whenever a
1194 document would otherwise be loaded in a new window, it is loaded in a
1195 new tab in an existing window instead.
1197 When called non-interactively, optional second argument NEW-WINDOW is
1198 used instead of `browse-url-new-window-flag'."
1199 (interactive (browse-url-interactive-arg "URL: "))
1200 (setq url (browse-url-encode-url url))
1201 (let* ((process-environment (browse-url-process-environment))
1202 (process (apply 'start-process
1203 (concat "epiphany " url)
1205 browse-url-epiphany-program
1207 browse-url-epiphany-arguments
1208 (if (browse-url-maybe-new-window new-window)
1209 (if browse-url-epiphany-new-window-is-tab
1211 '("--new-window" "--noraise"))
1214 (set-process-sentinel process
1215 `(lambda (process change)
1216 (browse-url-epiphany-sentinel process ,url)))))
1218 (defun browse-url-epiphany-sentinel (process url)
1219 "Handle a change to the process communicating with Epiphany."
1220 (or (eq (process-exit-status process) 0)
1221 (let* ((process-environment (browse-url-process-environment)))
1222 ;; Epiphany is not running - start it
1223 (message "Starting %s..." browse-url-epiphany-program)
1224 (apply 'start-process (concat "epiphany " url) nil
1225 browse-url-epiphany-program
1226 (append browse-url-epiphany-startup-arguments (list url))))))
1228 (defvar url-handler-regexp)
1231 (defun browse-url-emacs (url &optional new-window)
1232 "Ask Emacs to load URL into a buffer and show it in another window."
1233 (interactive (browse-url-interactive-arg "URL: "))
1234 (require 'url-handlers)
1235 (let ((file-name-handler-alist
1236 (cons (cons url-handler-regexp 'url-file-handler)
1237 file-name-handler-alist)))
1238 ;; Ignore `new-window': with all other browsers the URL is always shown
1239 ;; in another window than the current Emacs one since it's shown in
1240 ;; another application's window.
1241 ;; (if new-window (find-file-other-window url) (find-file url))
1242 (find-file-other-window url)))
1245 (defun browse-url-gnome-moz (url &optional new-window)
1246 "Ask Mozilla/Netscape to load URL via the GNOME program `gnome-moz-remote'.
1247 Default to the URL around or before point. The strings in variable
1248 `browse-url-gnome-moz-arguments' are also passed.
1250 When called interactively, if variable `browse-url-new-window-flag' is
1251 non-nil, load the document in a new browser window, otherwise use an
1252 existing one. A non-nil interactive prefix argument reverses the
1253 effect of `browse-url-new-window-flag'.
1255 When called non-interactively, optional second argument NEW-WINDOW is
1256 used instead of `browse-url-new-window-flag'."
1257 (interactive (browse-url-interactive-arg "URL: "))
1258 (apply 'start-process (concat "gnome-moz-remote " url)
1260 browse-url-gnome-moz-program
1262 browse-url-gnome-moz-arguments
1263 (if (browse-url-maybe-new-window new-window)
1265 (list "--raise" url))))
1270 (defun browse-url-mosaic (url &optional new-window)
1271 "Ask the XMosaic WWW browser to load URL.
1273 Default to the URL around or before point. The strings in variable
1274 `browse-url-mosaic-arguments' are also passed to Mosaic and the
1275 program is invoked according to the variable
1276 `browse-url-mosaic-program'.
1278 When called interactively, if variable `browse-url-new-window-flag' is
1279 non-nil, load the document in a new Mosaic window, otherwise use a
1280 random existing one. A non-nil interactive prefix argument reverses
1281 the effect of `browse-url-new-window-flag'.
1283 When called non-interactively, optional second argument NEW-WINDOW is
1284 used instead of `browse-url-new-window-flag'."
1285 (interactive (browse-url-interactive-arg "Mosaic URL: "))
1286 (let ((pidfile (expand-file-name browse-url-mosaic-pidfile))
1288 (if (file-readable-p pidfile)
1291 (goto-char (point-min))
1292 (setq pid (read (current-buffer)))
1294 (if (and pid (zerop (signal-process pid 0))) ; Mosaic running
1296 (find-file (format "/tmp/Mosaic.%d" pid))
1298 (insert (if (browse-url-maybe-new-window new-window)
1304 ;; Send signal SIGUSR to Mosaic
1305 (message "Signaling Mosaic...")
1306 (signal-process pid 'SIGUSR1)
1307 ;; Or you could try:
1308 ;; (call-process "kill" nil 0 nil "-USR1" (int-to-string pid))
1309 (message "Signaling Mosaic...done")
1311 ;; Mosaic not running - start it
1312 (message "Starting %s..." browse-url-mosaic-program)
1313 (apply 'start-process "xmosaic" nil browse-url-mosaic-program
1314 (append browse-url-mosaic-arguments (list url)))
1315 (message "Starting %s...done" browse-url-mosaic-program))))
1317 ;; --- Mosaic using CCI ---
1320 (defun browse-url-cci (url &optional new-window)
1321 "Ask the XMosaic WWW browser to load URL.
1322 Default to the URL around or before point.
1324 This function only works for XMosaic version 2.5 or later. You must
1325 select `CCI' from XMosaic's File menu, set the CCI Port Address to the
1326 value of variable `browse-url-CCI-port', and enable `Accept requests'.
1328 When called interactively, if variable `browse-url-new-window-flag' is
1329 non-nil, load the document in a new browser window, otherwise use a
1330 random existing one. A non-nil interactive prefix argument reverses
1331 the effect of `browse-url-new-window-flag'.
1333 When called non-interactively, optional second argument NEW-WINDOW is
1334 used instead of `browse-url-new-window-flag'."
1335 (interactive (browse-url-interactive-arg "Mosaic URL: "))
1336 (open-network-stream "browse-url" " *browse-url*"
1337 browse-url-CCI-host browse-url-CCI-port)
1338 ;; Todo: start browser if fails
1339 (process-send-string "browse-url"
1340 (concat "get url (" url ") output "
1341 (if (browse-url-maybe-new-window new-window)
1345 (process-send-string "browse-url" "disconnect\r\n")
1346 (delete-process "browse-url"))
1351 (declare-function w3-fetch-other-window "ext:w3m" (&optional url))
1352 (declare-function w3-fetch "ext:w3m" (&optional url target))
1355 (defun browse-url-w3 (url &optional new-window)
1356 "Ask the w3 WWW browser to load URL.
1357 Default to the URL around or before point.
1359 When called interactively, if variable `browse-url-new-window-flag' is
1360 non-nil, load the document in a new window. A non-nil interactive
1361 prefix argument reverses the effect of `browse-url-new-window-flag'.
1363 When called non-interactively, optional second argument NEW-WINDOW is
1364 used instead of `browse-url-new-window-flag'."
1365 (interactive (browse-url-interactive-arg "W3 URL: "))
1366 (require 'w3) ; w3-fetch-other-window not autoloaded
1367 (if (browse-url-maybe-new-window new-window)
1368 (w3-fetch-other-window url)
1372 (defun browse-url-w3-gnudoit (url &optional new-window)
1373 ;; new-window ignored
1374 "Ask another Emacs running gnuserv to load the URL using the W3 browser.
1375 The `browse-url-gnudoit-program' program is used with options given by
1376 `browse-url-gnudoit-args'. Default to the URL around or before point."
1377 (interactive (browse-url-interactive-arg "W3 URL: "))
1378 (apply 'start-process (concat "gnudoit:" url) nil
1379 browse-url-gnudoit-program
1380 (append browse-url-gnudoit-args
1381 (list (concat "(w3-fetch \"" url "\")")
1384 ;; --- Lynx in an xterm ---
1387 (defun browse-url-text-xterm (url &optional new-window)
1388 ;; new-window ignored
1389 "Ask a text browser to load URL.
1390 URL defaults to the URL around or before point.
1391 This runs the text browser specified by `browse-url-text-browser'.
1392 in an Xterm window using the Xterm program named by `browse-url-xterm-program'
1393 with possible additional arguments `browse-url-xterm-args'."
1394 (interactive (browse-url-interactive-arg "Text browser URL: "))
1395 (apply #'start-process `(,(concat browse-url-text-browser url)
1396 nil ,browse-url-xterm-program
1397 ,@browse-url-xterm-args "-e" ,browse-url-text-browser
1400 ;; --- Lynx in an Emacs "term" window ---
1402 (declare-function term-char-mode "term" ())
1403 (declare-function term-send-down "term" ())
1404 (declare-function term-send-string "term" (proc str))
1407 (defun browse-url-text-emacs (url &optional new-buffer)
1408 "Ask a text browser to load URL.
1409 URL defaults to the URL around or before point.
1410 This runs the text browser specified by `browse-url-text-browser'.
1411 With a prefix argument, it runs a new browser process in a new buffer.
1413 When called interactively, if variable `browse-url-new-window-flag' is
1414 non-nil, load the document in a new browser process in a new term window,
1415 otherwise use any existing one. A non-nil interactive prefix argument
1416 reverses the effect of `browse-url-new-window-flag'.
1418 When called non-interactively, optional second argument NEW-WINDOW is
1419 used instead of `browse-url-new-window-flag'."
1420 (interactive (browse-url-interactive-arg "Text browser URL: "))
1421 (let* ((system-uses-terminfo t) ; Lynx uses terminfo
1422 ;; (term-term-name "vt100") ; ??
1423 (buf (get-buffer "*text browser*"))
1424 (proc (and buf (get-buffer-process buf)))
1425 (n browse-url-text-input-attempts))
1427 (if (and (browse-url-maybe-new-window new-buffer) buf)
1428 ;; Rename away the OLD buffer. This isn't very polite, but
1429 ;; term insists on working in a buffer named *lynx* and would
1430 ;; choke on *lynx*<1>
1431 (progn (set-buffer buf)
1433 (if (or (browse-url-maybe-new-window new-buffer)
1436 (not (memq (process-status proc) '(run stop))))
1437 ;; start a new text browser
1441 `(,browse-url-text-browser
1442 ,browse-url-text-browser
1443 nil ,@browse-url-text-emacs-args
1445 (switch-to-buffer buf)
1447 (set-process-sentinel
1448 (get-buffer-process buf)
1449 ;; Don't leave around a dead one (especially because of its
1451 (lambda (process event)
1452 (if (not (memq (process-status process) '(run stop)))
1453 (let ((buf (process-buffer process)))
1454 (if buf (kill-buffer buf)))))))
1455 ;; Send the url to the text browser in the old buffer
1456 (let ((win (get-buffer-window buf t)))
1459 (switch-to-buffer buf)))
1460 (if (eq (following-char) ?_)
1461 (cond ((eq browse-url-text-input-field 'warn)
1462 (error "Please move out of the input field first"))
1463 ((eq browse-url-text-input-field 'avoid)
1464 (while (and (eq (following-char) ?_) (> n 0))
1465 (term-send-down) ; down arrow
1466 (sit-for browse-url-text-input-delay))
1467 (if (eq (following-char) ?_)
1468 (error "Cannot move out of the input field, sorry")))))
1469 (term-send-string proc (concat "g" ; goto
1470 "\C-u" ; kill default url
1476 (autoload 'rfc2368-parse-mailto-url "rfc2368")
1479 (defun browse-url-mail (url &optional new-window)
1480 "Open a new mail message buffer within Emacs for the RFC 2368 URL.
1481 Default to using the mailto: URL around or before point as the
1482 recipient's address. Supplying a non-nil interactive prefix argument
1483 will cause the mail to be composed in another window rather than the
1486 When called interactively, if variable `browse-url-new-window-flag' is
1487 non-nil use `compose-mail-other-window', otherwise `compose-mail'. A
1488 non-nil interactive prefix argument reverses the effect of
1489 `browse-url-new-window-flag'.
1491 When called non-interactively, optional second argument NEW-WINDOW is
1492 used instead of `browse-url-new-window-flag'."
1493 (interactive (browse-url-interactive-arg "Mailto URL: "))
1495 (let* ((alist (rfc2368-parse-mailto-url url))
1496 (to (assoc "To" alist))
1497 (subject (assoc "Subject" alist))
1498 (body (assoc "Body" alist))
1499 (rest (delq to (delq subject (delq body alist))))
1501 (subject (cdr subject))
1503 (mail-citation-hook (unless body mail-citation-hook)))
1504 (if (browse-url-maybe-new-window new-window)
1505 (compose-mail-other-window to subject rest nil
1506 (list 'insert-buffer (current-buffer)))
1507 (compose-mail to subject rest nil nil
1508 (list 'insert-buffer (current-buffer))))
1510 (goto-char (point-min))
1511 (unless (or (search-forward (concat "\n" mail-header-separator "\n")
1517 (insert (replace-regexp-in-string "\r\n" "\n" body))
1519 (insert "\n"))))))))
1521 ;; --- Random browser ---
1524 (defun browse-url-generic (url &optional new-window)
1525 ;; new-window ignored
1526 "Ask the WWW browser defined by `browse-url-generic-program' to load URL.
1527 Default to the URL around or before point. A fresh copy of the
1528 browser is started up in a new process with possible additional arguments
1529 `browse-url-generic-args'. This is appropriate for browsers which
1530 don't offer a form of remote control."
1531 (interactive (browse-url-interactive-arg "URL: "))
1532 (if (not browse-url-generic-program)
1533 (error "No browser defined (`browse-url-generic-program')"))
1534 (apply 'call-process browse-url-generic-program nil
1536 (append browse-url-generic-args (list url))))
1539 (defun browse-url-kde (url &optional new-window)
1540 "Ask the KDE WWW browser to load URL.
1541 Default to the URL around or before point."
1542 (interactive (browse-url-interactive-arg "KDE URL: "))
1543 (message "Sending URL to KDE...")
1544 (apply #'start-process (concat "KDE " url) nil browse-url-kde-program
1545 (append browse-url-kde-args (list url))))
1547 (defun browse-url-elinks-new-window (url)
1548 "Ask the Elinks WWW browser to load URL in a new window."
1549 (let ((process-environment (browse-url-process-environment)))
1550 (apply #'start-process
1551 (append (list (concat "elinks:" url)
1553 browse-url-elinks-wrapper
1554 (list "elinks" url)))))
1557 (defun browse-url-elinks (url &optional new-window)
1558 "Ask the Elinks WWW browser to load URL.
1559 Default to the URL around the point.
1561 The document is loaded in a new tab of a running Elinks or, if
1562 none yet running, a newly started instance.
1564 The Elinks command will be prepended by the program+arguments
1565 from `browse-url-elinks-wrapper'."
1566 (interactive (browse-url-interactive-arg "URL: "))
1567 (setq url (browse-url-encode-url url))
1569 (browse-url-elinks-new-window url)
1570 (let ((process-environment (browse-url-process-environment))
1571 (elinks-ping-process (start-process "elinks-ping" nil
1572 "elinks" "-remote" "ping()")))
1573 (set-process-sentinel elinks-ping-process
1574 `(lambda (process change)
1575 (browse-url-elinks-sentinel process ,url))))))
1577 (defun browse-url-elinks-sentinel (process url)
1578 "Determines if Elinks is running or a new one has to be started."
1579 (let ((exit-status (process-exit-status process)))
1580 ;; Try to determine if an instance is running or if we have to
1581 ;; create a new one.
1584 ;; No instance, start a new one.
1585 (browse-url-elinks-new-window url))
1587 ;; Found an instance, open URL in new tab.
1588 (let ((process-environment (browse-url-process-environment)))
1589 (start-process (concat "elinks:" url) nil
1591 (concat "openURL(\"" url "\",new-tab)"))))
1593 (error "Unrecognized exit-code %d of process `elinks'"
1596 (provide 'browse-url)
1598 ;;; browse-url.el ends here