1 ;;; browse-url.el --- pass a URL to a WWW browser
3 ;; Copyright (C) 1995, 96, 97, 98, 99, 2000, 2001
4 ;; 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 2, or (at your option)
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; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
26 ;; Boston, MA 02111-1307, USA.
30 ;; This package provides functions which read a URL (Uniform Resource
31 ;; Locator) from the minibuffer, defaulting to the URL around point,
32 ;; and ask a World-Wide Web browser to load it. It can also load the
33 ;; URL associated with the current buffer. Different browsers use
34 ;; different methods of remote control so there is one function for
35 ;; each supported browser. If the chosen browser is not running, it
36 ;; is started. Currently there is support for the following browsers,
37 ;; some of them probably now obsolete:
39 ;; Function Browser Earliest version
40 ;; browse-url-mozilla Mozilla Don't know
41 ;; browse-url-galeon Galeon 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-iximosaic IXI Mosaic ?
48 ;; browse-url-lynx-* Lynx 0
49 ;; browse-url-grail Grail 0.3b1
50 ;; browse-url-mmm MMM ?
51 ;; browse-url-generic arbitrary
52 ;; browse-url-default-windows-browser MS-Windows browser
53 ;; browse-url-gnome-moz GNOME interface to Mozilla
54 ;; browse-url-kde KDE konqueror (kfm)
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 ;; Grail is the freely available WWW browser implemented in Python, a
80 ;; cool object-oriented freely available interpreted language. Grail
81 ;; 0.3b1 was the first version to have remote control as distributed.
82 ;; For more information on Grail see
83 ;; <URL:http://grail.cnri.reston.va.us/> and for more information on
84 ;; Python see <url:http://www.python.org/>. Grail support in
85 ;; browse-url.el written by Barry Warsaw <bwarsaw@python.org>.
87 ;; Lynx is now distributed by the FSF. See also
88 ;; <URL:http://lynx.browser.org/>.
90 ;; Free graphical browsers that could be used by `browse-url-generic'
91 ;; include Chimera <URL:ftp://ftp.cs.unlv.edu/pub/chimera> and
92 ;; <URL:http://www.unlv.edu/chimera/>, Arena
93 ;; <URL:ftp://ftp.yggdrasil.com/pub/dist/web/arena> and Amaya
94 ;; <URL:ftp://ftp.w3.org/pub/amaya>. mMosaic
95 ;; <URL:ftp://sig.enst.fr/pub/multicast/mMosaic/>,
96 ;; <URL:http://sig.enst.fr/~dauphin/mMosaic/> (with development
97 ;; support for Java applets and multicast) can be used like Mosaic by
98 ;; setting `browse-url-mosaic-program' appropriately.
100 ;; I [Denis Howe, not Dave Love] recommend Nelson Minar
101 ;; <nelson@santafe.edu>'s excellent html-helper-mode.el for editing
102 ;; HTML and thank Nelson for his many useful comments on this code.
103 ;; <URL:http://www.santafe.edu/%7Enelson/hhm-beta/>
105 ;; See also hm--html-menus <URL:http://www.tnt.uni-hannover.de/%7Emuenkel/
106 ;; software/own/hm--html-menus/>. For composing correct HTML see also
107 ;; PSGML the general SGML structure editor package
108 ;; <URL:ftp://ftp.lysator.liu.se/pub/sgml>; hm--html-menus can be used
111 ;; This package generalises function html-previewer-process in Marc
112 ;; Andreessen's html-mode (LCD modes/html-mode.el.Z). See also the
113 ;; ffap.el package. The huge hyperbole package also contains similar
116 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
119 ;; Can you write and test some code for the Macintrash and Windoze
120 ;; Netscape remote control APIs? (See the URL above).
122 ;; Do any other browsers have remote control?
124 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
127 ;; To display the URL at or before point:
128 ;; M-x browse-url-at-point RET
129 ;; or, similarly but with the opportunity to edit the URL extracted from
133 ;; To display a URL by shift-clicking on it, put this in your ~/.emacs
135 ;; (global-set-key [S-mouse-2] 'browse-url-at-mouse)
136 ;; (Note that using Shift-mouse-1 is not desirable because
137 ;; that event has a standard meaning in Emacs.)
139 ;; To display the current buffer in a web browser:
140 ;; M-x browse-url-of-buffer RET
142 ;; To display the current region in a web browser:
143 ;; M-x browse-url-of-region RET
145 ;; In Dired, to display the file named on the current line:
146 ;; M-x browse-url-of-dired-file RET
148 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
149 ;; Customisation (~/.emacs)
151 ;; To see what variables are available for customization, type
152 ;; `M-x set-variable browse-url TAB'. Better, use
153 ;; `M-x customize-group browse-url'.
155 ;; Bind the browse-url commands to keys with the `C-c C-z' prefix
156 ;; (as used by html-helper-mode):
157 ;; (global-set-key "\C-c\C-z." 'browse-url-at-point)
158 ;; (global-set-key "\C-c\C-zb" 'browse-url-of-buffer)
159 ;; (global-set-key "\C-c\C-zr" 'browse-url-of-region)
160 ;; (global-set-key "\C-c\C-zu" 'browse-url)
161 ;; (global-set-key "\C-c\C-zv" 'browse-url-of-file)
162 ;; (add-hook 'dired-mode-hook
164 ;; (local-set-key "\C-c\C-zf" 'browse-url-of-dired-file)))
166 ;; Browse URLs in mail messages under RMAIL by clicking mouse-2:
167 ;; (add-hook 'rmail-mode-hook (lambda () ; rmail-mode startup
168 ;; (define-key rmail-mode-map [mouse-2] 'browse-url-at-mouse)))
169 ;; Alternatively, add `goto-address' to `rmail-show-message-hook'.
171 ;; Gnus provides a standard feature to activate URLs in article
172 ;; buffers for invocation of browse-url.
174 ;; Use the Emacs w3 browser when not running under X11:
175 ;; (or (eq window-system 'x)
176 ;; (setq browse-url-browser-function 'browse-url-w3))
178 ;; To always save modified buffers before displaying the file in a browser:
179 ;; (setq browse-url-save-file t)
181 ;; To get round the Netscape caching problem, you could EITHER have
182 ;; write-file in html-helper-mode make Netscape reload the document:
184 ;; (autoload 'browse-url-netscape-reload "browse-url"
185 ;; "Ask a WWW browser to redisplay the current file." t)
186 ;; (add-hook 'html-helper-mode-hook
188 ;; (add-hook 'local-write-file-hooks
190 ;; (let ((local-write-file-hooks))
192 ;; (browse-url-netscape-reload)
193 ;; t) ; => file written by hook
194 ;; t))) ; append to l-w-f-hooks
196 ;; OR have browse-url-of-file ask Netscape to load and then reload the
199 ;; (add-hook 'browse-url-of-file-hook 'browse-url-netscape-reload)
201 ;; You may also want to customise browse-url-netscape-arguments, e.g.
202 ;; (setq browse-url-netscape-arguments '("-install"))
204 ;; or similarly for the other browsers.
206 ;; To invoke different browsers for different URLs:
207 ;; (setq browse-url-browser-function '(("^mailto:" . browse-url-mail)
208 ;; ("." . browse-url-netscape)))
210 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
213 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
216 (eval-when-compile (require 'thingatpt)
219 (require 'executable)
220 (require 'w3-auto nil t))
222 (defgroup browse-url nil
223 "Use a web browser to look at a URL."
224 :prefix "browse-url-"
225 :link '(emacs-commentary-link "browse-url")
229 (defcustom browse-url-browser-function
230 (if (memq system-type '(windows-nt ms-dos))
231 'browse-url-default-windows-browser
232 'browse-url-default-browser)
233 "*Function to display the current buffer in a WWW browser.
234 This is used by the `browse-url-at-point', `browse-url-at-mouse', and
235 `browse-url-of-file' commands.
237 If the value is not a function it should be a list of pairs
238 \(REGEXP . FUNCTION). In this case the function called will be the one
239 associated with the first REGEXP which matches the current URL. The
240 function is passed the URL and any other args of `browse-url'. The last
241 regexp should probably be \".\" to specify a default browser."
243 (function-item :tag "Emacs W3" :value browse-url-w3)
244 (function-item :tag "W3 in another Emacs via `gnudoit'"
245 :value browse-url-w3-gnudoit)
246 (function-item :tag "Mozilla" :value browse-url-mozilla)
247 (function-item :tag "Galeon" :value browse-url-galeon)
248 (function-item :tag "Netscape" :value browse-url-netscape)
249 (function-item :tag "Mosaic" :value browse-url-mosaic)
250 (function-item :tag "Mosaic using CCI" :value browse-url-cci)
251 (function-item :tag "IXI Mosaic" :value browse-url-iximosaic)
252 (function-item :tag "Lynx in an xterm window"
253 :value browse-url-lynx-xterm)
254 (function-item :tag "Lynx in an Emacs window"
255 :value browse-url-lynx-emacs)
256 (function-item :tag "Grail" :value browse-url-grail)
257 (function-item :tag "MMM" :value browse-url-mmm)
258 (function-item :tag "KDE" :value browse-url-kde)
259 (function-item :tag "Specified by `Browse Url Generic Program'"
260 :value browse-url-generic)
261 (function-item :tag "Default Windows browser"
262 :value browse-url-default-windows-browser)
263 (function-item :tag "GNOME invoking Mozilla"
264 :value browse-url-gnome-moz)
265 (function-item :tag "Default browser"
266 :value browse-url-default-browser)
267 (function :tag "Your own function")
268 (alist :tag "Regexp/function association list"
269 :key-type regexp :value-type function))
273 (defcustom browse-url-netscape-program "netscape"
274 ;; Info about netscape-remote from Karl Berry.
275 "The name by which to invoke Netscape.
277 The free program `netscape-remote' from
278 <URL:http://home.netscape.com/newsref/std/remote.c> is said to start
279 up very much quicker than `netscape'. Reported to compile on a GNU
280 system, given vroot.h from the same directory, with cc flags
281 -DSTANDALONE -L/usr/X11R6/lib -lXmu -lX11."
285 (defcustom browse-url-netscape-arguments nil
286 "A list of strings to pass to Netscape as arguments."
287 :type '(repeat (string :tag "Argument"))
290 (defcustom browse-url-netscape-startup-arguments browse-url-netscape-arguments
291 "A list of strings to pass to Netscape when it starts up.
292 Defaults to the value of `browse-url-netscape-arguments' at the time
293 `browse-url' is loaded."
294 :type '(repeat (string :tag "Argument"))
298 (defcustom browse-url-browser-display nil
299 "*The X display for running the browser, if not same as Emacs'."
300 :type '(choice string (const :tag "Default" nil))
303 (defcustom browse-url-mozilla-program "mozilla"
304 "The name by which to invoke Mozilla."
308 (defcustom browse-url-mozilla-arguments nil
309 "A list of strings to pass to Mozilla as arguments."
310 :type '(repeat (string :tag "Argument"))
313 (defcustom browse-url-mozilla-startup-arguments browse-url-mozilla-arguments
314 "A list of strings to pass to Mozilla when it starts up.
315 Defaults to the value of `browse-url-mozilla-arguments' at the time
316 `browse-url' is loaded."
317 :type '(repeat (string :tag "Argument"))
321 (defcustom browse-url-galeon-program "galeon"
322 "The name by which to invoke Galeon."
326 (defcustom browse-url-galeon-arguments nil
327 "A list of strings to pass to Galeon as arguments."
328 :type '(repeat (string :tag "Argument"))
331 (defcustom browse-url-galeon-startup-arguments browse-url-galeon-arguments
332 "A list of strings to pass to Galeon when it starts up.
333 Defaults to the value of `browse-url-galeon-arguments' at the time
334 `browse-url' is loaded."
335 :type '(repeat (string :tag "Argument"))
338 (defcustom browse-url-galeon-new-window-is-tab nil
339 "Whether to open up new windows in a tab or a new window.
340 If non-nil, then open the URL in a new tab rather than a new window if
341 `browse-url-galeon' is asked to open it in a new window."
346 (defcustom browse-url-new-window-flag nil
347 "*If non-nil, always open a new browser window with appropriate browsers.
348 Passing an interactive argument to \\[browse-url], or specific browser
349 commands reverses the effect of this variable. Requires Netscape version
350 1.1N or later or XMosaic version 2.5 or later if using those browsers."
354 (defcustom browse-url-mosaic-program "xmosaic"
355 "The name by which to invoke Mosaic (or mMosaic)."
360 (defcustom browse-url-mosaic-arguments nil
361 "A list of strings to pass to Mosaic as arguments."
362 :type '(repeat (string :tag "Argument"))
365 (defcustom browse-url-filename-alist
366 (\` ; Backquote syntax won't work.
367 (("^/\\(ftp@\\|anonymous@\\)?\\([^:]+\\):/*" . "ftp://\\2/")
368 ;; The above loses the username to avoid the browser prompting for
369 ;; it in anonymous cases. If it's not anonymous the next regexp
371 ("^/\\([^:@]+@\\)?\\([^:]+\\):/*" . "ftp://\\1\\2/")
372 (,@ (if (memq system-type '(windows-nt ms-dos))
373 '(("^\\([a-zA-Z]:\\)[\\/]" . "file:\\1/")
374 ("^[\\/][\\/]+" . "file://"))))
376 "An alist of (REGEXP . STRING) pairs used by `browse-url-of-file'.
377 Any substring of a filename matching one of the REGEXPs is replaced by
378 the corresponding STRING using `replace-match', not treating STRING
379 literally. All pairs are applied in the order given. The default
380 value converts ange-ftp/EFS-style paths into ftp URLs and prepends
381 `file:' to any path beginning with `/'.
383 For example, adding to the default a specific translation of an ange-ftp
384 address to an HTTP URL:
386 (setq browse-url-filename-alist
387 '((\"/webmaster@webserver:/home/www/html/\" .
388 \"http://www.acme.co.uk/\")
389 (\"^/\\(ftp@\\|anonymous@\\)?\\([^:]+\\):/*\" . \"ftp://\\2/\")
390 (\"^/\\([^:@]+@\\)?\\([^:]+\\):/*\" . \"ftp://\\1\\2/\")
391 (\"^/+\" . \"file:/\")))
393 :type '(repeat (cons :format "%v"
394 (regexp :tag "Regexp")
395 (string :tag "Replacement")))
400 (defcustom browse-url-save-file nil
401 "*If non-nil, save the buffer before displaying its file.
402 Used by the `browse-url-of-file' command."
406 (defcustom browse-url-of-file-hook nil
407 "Run after `browse-url-of-file' has asked a browser to load a file.
409 Set this to `browse-url-netscape-reload' to force Netscape to load the
410 file rather than displaying a cached copy."
412 :options '(browse-url-netscape-reload)
415 (defvar browse-url-usr1-signal
416 (if (and (boundp 'emacs-major-version)
417 (or (> emacs-major-version 19) (>= emacs-minor-version 29)))
418 'SIGUSR1 ; Why did I think this was in lower case before?
419 30) ; Check /usr/include/signal.h.
420 "The argument to `signal-process' for sending SIGUSR1 to XMosaic.
421 Emacs 19.29 accepts 'SIGUSR1, earlier versions require an integer
422 which is 30 on SunOS and 16 on HP-UX and Solaris.")
424 (defcustom browse-url-CCI-port 3003
425 "Port to access XMosaic via CCI.
426 This can be any number between 1024 and 65535 but must correspond to
427 the value set in the browser."
431 (defcustom browse-url-CCI-host "localhost"
432 "*Host to access XMosaic via CCI.
433 This should be the host name of the machine running XMosaic with CCI
434 enabled. The port number should be set in `browse-url-CCI-port'."
438 (defvar browse-url-temp-file-name nil)
439 (make-variable-buffer-local 'browse-url-temp-file-name)
441 (defcustom browse-url-xterm-program "xterm"
442 "The name of the terminal emulator used by `browse-url-lynx-xterm'.
443 This might, for instance, be a separate colour version of xterm."
447 (defcustom browse-url-xterm-args nil
448 "*A list of strings defining options for `browse-url-xterm-program'.
449 These might set its size, for instance."
450 :type '(repeat (string :tag "Argument"))
453 (defcustom browse-url-lynx-emacs-args (and (not window-system)
455 "A list of strings defining options for Lynx in an Emacs buffer.
457 The default is none in a window system, otherwise `-show_cursor' to
458 indicate the position of the current link in the absence of
459 highlighting, assuming the normal default for showing the cursor."
460 :type '(repeat (string :tag "Argument"))
464 (defcustom browse-url-gnudoit-program "gnudoit"
465 "The name of the `gnudoit' program used by `browse-url-w3-gnudoit'."
469 (defcustom browse-url-gnudoit-args '("-q")
470 "*A list of strings defining options for `browse-url-gnudoit-program'.
471 These might set the port, for instance."
472 :type '(repeat (string :tag "Argument"))
476 (defcustom browse-url-generic-program nil
477 "*The name of the browser program used by `browse-url-generic'."
478 :type '(choice string (const :tag "None" nil))
481 (defcustom browse-url-generic-args nil
482 "*A list of strings defining options for `browse-url-generic-program'."
483 :type '(repeat (string :tag "Argument"))
486 (defcustom browse-url-temp-dir temporary-file-directory
487 "The name of a directory for browse-url's temporary files.
488 Such files are generated by functions like `browse-url-of-region'.
489 You might want to set this to somewhere with restricted read permissions
494 (defcustom browse-url-netscape-version
496 "The version of Netscape you are using.
497 This affects how URL reloading is done; the mechanism changed
498 incompatibly at version 4."
502 (defcustom browse-url-lynx-input-field 'avoid
503 "*Action on selecting an existing Lynx buffer at an input field.
504 What to do when sending a new URL to an existing Lynx buffer in Emacs
505 if the Lynx cursor is on an input field (in which case the `g' command
506 would be entered as data). Such fields are recognized by the
507 underlines ____. Allowed values: nil: disregard it, 'warn: warn the
508 user and don't emit the URL, 'avoid: try to avoid the field by moving
509 down (this *won't* always work)."
510 :type '(choice (const :tag "Move to try to avoid field" :value avoid)
511 (const :tag "Disregard" :value nil)
512 (const :tag "Warn, don't emit URL" :value warn))
516 (defvar browse-url-lynx-input-attempts 10
517 "*How many times to try to move down from a series of lynx input fields.")
519 (defcustom browse-url-lynx-input-delay 0.2
520 "How many seconds to wait for lynx between moves down from an input field.")
522 (defcustom browse-url-kde-program "kfmclient"
523 "The name by which to invoke the KDE web browser."
528 (defcustom browse-url-kde-args '("openURL")
529 "*A list of strings defining options for `browse-url-kde-program'."
530 :type '(repeat (string :tag "Argument"))
533 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
536 (defun browse-url-url-at-point ()
537 (let ((url (thing-at-point 'url)))
538 (set-text-properties 0 (length url) nil url)
541 ;; Having this as a separate function called by the browser-specific
542 ;; functions allows them to be stand-alone commands, making it easier
543 ;; to switch between browsers.
545 (defun browse-url-interactive-arg (prompt)
546 "Read a URL from the minibuffer, prompting with PROMPT.
547 Default to the URL at or before point. If invoked with a mouse button,
548 set point to the position clicked first. Return a list for use in
549 `interactive' containing the URL and `browse-url-new-window-flag' or its
550 negation if a prefix argument was given."
551 (let ((event (elt (this-command-keys) 0)))
552 (and (listp event) (mouse-set-point event)))
553 (list (read-string prompt (browse-url-url-at-point))
554 (not (eq (null browse-url-new-window-flag)
555 (null current-prefix-arg)))))
557 ;; interactive-p needs to be called at a function's top-level, hence
559 (defmacro browse-url-maybe-new-window (arg)
562 browse-url-new-window-flag))
564 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
565 ;; Browse current buffer
568 (defun browse-url-of-file (&optional file)
569 "Ask a WWW browser to display FILE.
570 Display the current buffer's file if FILE is nil or if called
571 interactively. Turn the filename into a URL with function
572 `browse-url-file-url'. Pass the URL to a browser using the
573 `browse-url' function then run `browse-url-of-file-hook'."
576 (setq file (buffer-file-name))
577 (error "Current buffer has no file"))
578 (let ((buf (get-file-buffer file)))
582 (cond ((not (buffer-modified-p)))
583 (browse-url-save-file (save-buffer))
584 (t (message "%s modified since last save" file))))))
585 (browse-url (browse-url-file-url file))
586 (run-hooks 'browse-url-of-file-hook))
588 (defun browse-url-file-url (file)
589 "Return the URL corresponding to FILE.
590 Use variable `browse-url-filename-alist' to map filenames to URLs."
591 ;; URL-encode special chars, do % first
593 (while (setq s (string-match "%" file s))
594 (setq file (replace-match "%25" t t file)
596 (while (string-match "[*\"()',=;? ]" file)
597 (let ((enc (format "%%%x" (aref file (match-beginning 0)))))
598 (setq file (replace-match enc t t file))))
599 (dolist (map browse-url-filename-alist)
600 (when (and map (string-match (car map) file))
601 (setq file (replace-match (cdr map) t nil file))))
605 (defun browse-url-of-buffer (&optional buffer)
606 "Ask a WWW browser to display BUFFER.
607 Display the current buffer if BUFFER is nil. Display only the
608 currently visible part of BUFFER (from a temporary file) if buffer is
612 (and buffer (set-buffer buffer))
614 ;; Ignore real name if restricted
615 (and (= (- (point-max) (point-min)) (buffer-size))
617 (and (boundp 'dired-directory) dired-directory)))))
620 (or browse-url-temp-file-name
621 (setq browse-url-temp-file-name
622 (convert-standard-filename
624 (expand-file-name "burl" browse-url-temp-dir)))))
625 (setq file-name browse-url-temp-file-name)
626 (write-region (point-min) (point-max) file-name nil 'no-message)))
627 (browse-url-of-file file-name))))
629 (defun browse-url-delete-temp-file (&optional temp-file-name)
630 ;; Delete browse-url-temp-file-name from the file system
631 ;; If optional arg TEMP-FILE-NAME is non-nil, delete it instead
632 (let ((file-name (or temp-file-name browse-url-temp-file-name)))
633 (if (and file-name (file-exists-p file-name))
634 (delete-file file-name))))
636 (add-hook 'kill-buffer-hook 'browse-url-delete-temp-file)
639 (defun browse-url-of-dired-file ()
640 "In Dired, ask a WWW browser to display the file named on this line."
642 (browse-url-of-file (dired-get-filename)))
645 (defun browse-url-of-region (min max)
646 "Ask a WWW browser to display the current region."
650 (narrow-to-region min max)
651 (browse-url-of-buffer))))
653 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
654 ;; Browser-independent commands
656 ;; A generic command to call the current browse-url-browser-function
659 (defun browse-url (url &rest args)
660 "Ask a WWW browser to load URL.
661 Prompts for a URL, defaulting to the URL at or before point. Variable
662 `browse-url-browser-function' says which browser to use."
663 (interactive (browse-url-interactive-arg "URL: "))
664 (unless (interactive-p)
665 (setq args (or args (list browse-url-new-window-flag))))
666 (if (functionp browse-url-browser-function)
667 (apply browse-url-browser-function url args)
668 ;; The `function' can be an alist; look down it for first match
669 ;; and apply the function (which might be a lambda).
671 (dolist (bf browse-url-browser-function)
672 (when (string-match (car bf) url)
673 (apply (cdr bf) url args)
675 (error "No browse-url-browser-function matching URL %s"
679 (defun browse-url-at-point (&optional arg)
680 "Ask a WWW browser to load the URL at or before point.
681 Doesn't let you edit the URL like `browse-url'. Variable
682 `browse-url-browser-function' says which browser to use."
684 (let ((url (browse-url-url-at-point)))
686 (browse-url url (if arg
687 (not browse-url-new-window-flag)
688 browse-url-new-window-flag))
689 (error "No URL found"))))
692 (defun browse-url-at-mouse (event)
693 "Ask a WWW browser to load a URL clicked with the mouse.
694 The URL is the one around or before the position of the mouse click
695 but point is not changed. Doesn't let you edit the URL like
696 `browse-url'. Variable `browse-url-browser-function' says which browser
700 (mouse-set-point event)
701 (browse-url-at-point browse-url-new-window-flag)))
703 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
704 ;; Browser-specific commands
706 ;; --- Default MS-Windows browser ---
708 (defun browse-url-default-windows-browser (url &optional new-window)
709 (interactive (browse-url-interactive-arg "URL: "))
710 (if (eq system-type 'ms-dos)
711 (if dos-windows-version
712 (shell-command (concat "start " (shell-quote-argument url)))
713 (error "Browsing URLs is not supported on this system"))
714 (w32-shell-execute "open" url)))
718 (defun browse-url-process-environment ()
719 "Set DISPLAY in the environment to the X display the browser will use.
720 This is either the value of variable `browse-url-browser-display' if
721 non-nil, or the same display as Emacs if different from the current
722 environment, otherwise just use the current environment."
723 (let ((display (or browse-url-browser-display (browse-url-emacs-display))))
725 (cons (concat "DISPLAY=" display) process-environment)
726 process-environment)))
728 (defun browse-url-emacs-display ()
729 "Return the X display Emacs is running on.
730 This is nil if the display is the same as the DISPLAY environment variable.
732 Actually Emacs could be using several displays; this just returns the
733 one showing the selected frame."
734 (let ((display (cdr-safe (assq 'display (frame-parameters)))))
735 (and (not (equal display (getenv "DISPLAY")))
739 (defun browse-url-default-browser (url &rest args)
740 "Find a suitable browser and ask it to load URL.
741 Default to the URL around or before point.
743 When called interactively, if variable `browse-url-new-window-flag' is
744 non-nil, load the document in a new window, if possible, otherwise use
745 a random existing one. A non-nil interactive prefix argument reverses
746 the effect of `browse-url-new-window-flag'.
748 When called non-interactively, optional second argument NEW-WINDOW is
749 used instead of `browse-url-new-window-flag'.
751 The order attempted is gnome-moz-remote, Mozilla, Galeon, Netscape,
752 Mosaic, IXI Mosaic, Lynx in an xterm, MMM, Konqueror, and then W3."
755 ((executable-find "gnome-moz-remote") 'browse-url-gnome-moz)
756 ((executable-find browse-url-mozilla-program) 'browse-url-mozilla)
757 ((executable-find browse-url-galeon-program) 'browse-url-galeon)
758 ((executable-find browse-url-kde-program) 'browse-url-kde)
759 ((executable-find browse-url-netscape-program) 'browse-url-netscape)
760 ((executable-find browse-url-mosaic-program) 'browse-url-mosaic)
761 ((executable-find "tellw3b") 'browse-url-iximosaic)
762 ((executable-find browse-url-xterm-program) 'browse-url-lynx-xterm)
763 ((executable-find "mmm") 'browse-url-mmm)
768 (defun browse-url-netscape (url &optional new-window)
769 "Ask the Netscape WWW browser to load URL.
770 Default to the URL around or before point. The strings in variable
771 `browse-url-netscape-arguments' are also passed to Netscape.
773 When called interactively, if variable `browse-url-new-window-flag' is
774 non-nil, load the document in a new Netscape window, otherwise use a
775 random existing one. A non-nil interactive prefix argument reverses
776 the effect of `browse-url-new-window-flag'.
778 When called non-interactively, optional second argument NEW-WINDOW is
779 used instead of `browse-url-new-window-flag'."
780 (interactive (browse-url-interactive-arg "URL: "))
781 ;; URL encode any `confusing' characters in the URL. This needs to
782 ;; include at least commas; presumably also close parens.
783 (while (string-match "[,)]" url)
784 (setq url (replace-match
785 (format "%%%x" (string-to-char (match-string 0 url))) t t url)))
786 (let* ((process-environment (browse-url-process-environment))
787 (process (apply 'start-process
788 (concat "netscape " url) nil
789 browse-url-netscape-program
791 browse-url-netscape-arguments
792 (if (eq window-system 'w32)
795 (if new-window '("-noraise"))
797 (concat "openURL(" url
798 (if (browse-url-maybe-new-window
802 (set-process-sentinel process
803 `(lambda (process change)
804 (browse-url-netscape-sentinel process ,url)))))
806 (defun browse-url-netscape-sentinel (process url)
807 "Handle a change to the process communicating with Netscape."
808 (or (eq (process-exit-status process) 0)
809 (let* ((process-environment (browse-url-process-environment)))
810 ;; Netscape not running - start it
811 (message "Starting Netscape...")
812 (apply 'start-process (concat "netscape" url) nil
813 browse-url-netscape-program
814 (append browse-url-netscape-startup-arguments (list url))))))
816 (defun browse-url-netscape-reload ()
817 "Ask Netscape to reload its current document.
818 How depends on `browse-url-netscape-version'."
820 ;; Backwards incompatibility reported by
821 ;; <peter.kruse@psychologie.uni-regensburg.de>.
822 (browse-url-netscape-send (if (>= browse-url-netscape-version 4)
823 "xfeDoCommand(reload)"
826 (defun browse-url-netscape-send (command)
827 "Send a remote control command to Netscape."
828 (let* ((process-environment (browse-url-process-environment)))
829 (apply 'start-process "netscape" nil
830 browse-url-netscape-program
831 (append browse-url-netscape-arguments
832 (list "-remote" command)))))
835 (defun browse-url-mozilla (url &optional new-window)
836 "Ask the Mozilla WWW browser to load URL.
837 Default to the URL around or before point. The strings in variable
838 `browse-url-mozilla-arguments' are also passed to Mozilla.
840 When called interactively, if variable `browse-url-new-window-flag' is
841 non-nil, load the document in a new Mozilla window, otherwise use a
842 random existing one. A non-nil interactive prefix argument reverses
843 the effect of `browse-url-new-window-flag'.
845 When called non-interactively, optional second argument NEW-WINDOW is
846 used instead of `browse-url-new-window-flag'."
847 (interactive (browse-url-interactive-arg "URL: "))
848 ;; URL encode any `confusing' characters in the URL. This needs to
849 ;; include at least commas; presumably also close parens.
850 (while (string-match "[,)]" url)
851 (setq url (replace-match
852 (format "%%%x" (string-to-char (match-string 0 url))) t t url)))
853 (let* ((process-environment (browse-url-process-environment))
854 (process (apply 'start-process
855 (concat "mozilla " url) nil
856 browse-url-mozilla-program
858 browse-url-mozilla-arguments
862 (if new-window ",new-window")
864 (set-process-sentinel process
865 `(lambda (process change)
866 (browse-url-mozilla-sentinel process ,url)))))
868 (defun browse-url-mozilla-sentinel (process url)
869 "Handle a change to the process communicating with Mozilla."
870 (or (eq (process-exit-status process) 0)
871 (let* ((process-environment (browse-url-process-environment)))
872 ;; Mozilla is not running - start it
873 (message "Starting Mozilla...")
874 (apply 'start-process (concat "mozilla " url) nil
875 browse-url-mozilla-program
876 (append browse-url-mozilla-startup-arguments (list url))))))
879 (defun browse-url-galeon (url &optional new-window)
880 "Ask the Galeon WWW browser to load URL.
881 Default to the URL around or before point. The strings in variable
882 `browse-url-galeon-arguments' are also passed to Galeon.
884 When called interactively, if variable `browse-url-new-window-flag' is
885 non-nil, load the document in a new Galeon window, otherwise use a
886 random existing one. A non-nil interactive prefix argument reverses
887 the effect of `browse-url-new-window-flag'.
889 When called non-interactively, optional second argument NEW-WINDOW is
890 used instead of `browse-url-new-window-flag'."
891 (interactive (browse-url-interactive-arg "URL: "))
892 ;; URL encode any `confusing' characters in the URL. This needs to
893 ;; include at least commas; presumably also close parens.
894 (while (string-match "[,)]" url)
895 (setq url (replace-match
896 (format "%%%x" (string-to-char (match-string 0 url))) t t url)))
897 (let* ((process-environment (browse-url-process-environment))
898 (process (apply 'start-process
899 (concat "galeon " url) nil
900 browse-url-galeon-program
902 browse-url-galeon-arguments
903 (if (browse-url-maybe-new-window new-window)
904 (if browse-url-galeon-new-window-is-tab
906 '("--new-window" "--no-raise")))
908 (set-process-sentinel process
909 `(lambda (process change)
910 (browse-url-galeon-sentinel process ,url)))))
912 (defun browse-url-galeon-sentinel (process url)
913 "Handle a change to the process communicating with Galeon."
914 (or (eq (process-exit-status process) 0)
915 (let* ((process-environment (browse-url-process-environment)))
916 ;; Galeon is not running - start it
917 (message "Starting Galeon...")
918 (apply 'start-process (concat "galeon " url) nil
919 browse-url-galeon-program
920 (append browse-url-galeon-startup-arguments (list url))))))
922 ;; GNOME means of invoking either Mozilla or Netrape.
924 (defcustom browse-url-gnome-moz-arguments '()
925 "A list of strings passed to the GNOME mozilla viewer as arguments."
927 :type '(repeat (string :tag "Argument"))
931 (defun browse-url-gnome-moz (url &optional new-window)
932 "Ask Mozilla/Netscape to load URL via the GNOME program `gnome-moz-remote'.
933 Default to the URL around or before point. The strings in variable
934 `browse-url-gnome-moz-arguments' are also passed.
936 When called interactively, if variable `browse-url-new-window-flag' is
937 non-nil, load the document in a new browser window, otherwise use an
938 existing one. A non-nil interactive prefix argument reverses the
939 effect of `browse-url-new-window-flag'.
941 When called non-interactively, optional second argument NEW-WINDOW is
942 used instead of `browse-url-new-window-flag'."
943 (interactive (browse-url-interactive-arg "URL: "))
944 (apply 'start-process (concat "gnome-moz-remote " url)
948 browse-url-gnome-moz-arguments
949 (if (browse-url-maybe-new-window new-window)
951 (list "--raise" url))))
956 (defun browse-url-mosaic (url &optional new-window)
957 "Ask the XMosaic WWW browser to load URL.
959 Default to the URL around or before point. The strings in variable
960 `browse-url-mosaic-arguments' are also passed to Mosaic and the
961 program is invoked according to the variable
962 `browse-url-mosaic-program'.
964 When called interactively, if variable `browse-url-new-window-flag' is
965 non-nil, load the document in a new Mosaic window, otherwise use a
966 random existing one. A non-nil interactive prefix argument reverses
967 the effect of `browse-url-new-window-flag'.
969 When called non-interactively, optional second argument NEW-WINDOW is
970 used instead of `browse-url-new-window-flag'."
971 (interactive (browse-url-interactive-arg "Mosaic URL: "))
972 (let ((pidfile (expand-file-name "~/.mosaicpid"))
974 (if (file-readable-p pidfile)
977 (goto-char (point-min))
978 (setq pid (read (current-buffer)))
980 (if (and pid (zerop (signal-process pid 0))) ; Mosaic running
982 (find-file (format "/tmp/Mosaic.%d" pid))
984 (insert (if (browse-url-maybe-new-window new-window)
990 ;; Send signal SIGUSR to Mosaic
991 (message "Signalling Mosaic...")
992 (signal-process pid browse-url-usr1-signal)
994 ;; (call-process "kill" nil 0 nil "-USR1" (int-to-string pid))
995 (message "Signalling Mosaic...done")
997 ;; Mosaic not running - start it
998 (message "Starting Mosaic...")
999 (apply 'start-process "xmosaic" nil browse-url-mosaic-program
1000 (append browse-url-mosaic-arguments (list url)))
1001 (message "Starting Mosaic...done"))))
1006 (defvar browse-url-grail
1007 (concat (or (getenv "GRAILDIR") "~/.grail") "/user/rcgrail.py")
1008 "Location of Grail remote control client script `rcgrail.py'.
1009 Typically found in $GRAILDIR/rcgrail.py, or ~/.grail/user/rcgrail.py.")
1012 (defun browse-url-grail (url &optional new-window)
1013 "Ask the Grail WWW browser to load URL.
1014 Default to the URL around or before point. Runs the program in the
1015 variable `browse-url-grail'."
1016 (interactive (browse-url-interactive-arg "Grail URL: "))
1017 (message "Sending URL to Grail...")
1019 (set-buffer (get-buffer-create " *Shell Command Output*"))
1021 ;; don't worry about this failing.
1023 (call-process browse-url-grail nil 0 nil "-b" url)
1024 (call-process browse-url-grail nil 0 nil url))
1025 (message "Sending URL to Grail... done")))
1027 ;; --- Mosaic using CCI ---
1030 (defun browse-url-cci (url &optional new-window)
1031 "Ask the XMosaic WWW browser to load URL.
1032 Default to the URL around or before point.
1034 This function only works for XMosaic version 2.5 or later. You must
1035 select `CCI' from XMosaic's File menu, set the CCI Port Address to the
1036 value of variable `browse-url-CCI-port', and enable `Accept requests'.
1038 When called interactively, if variable `browse-url-new-window-flag' is
1039 non-nil, load the document in a new browser window, otherwise use a
1040 random existing one. A non-nil interactive prefix argument reverses
1041 the effect of `browse-url-new-window-flag'.
1043 When called non-interactively, optional second argument NEW-WINDOW is
1044 used instead of `browse-url-new-window-flag'."
1045 (interactive (browse-url-interactive-arg "Mosaic URL: "))
1046 (open-network-stream "browse-url" " *browse-url*"
1047 browse-url-CCI-host browse-url-CCI-port)
1048 ;; Todo: start browser if fails
1049 (process-send-string "browse-url"
1050 (concat "get url (" url ") output "
1051 (if (browse-url-maybe-new-window new-window)
1055 (process-send-string "browse-url" "disconnect\r\n")
1056 (delete-process "browse-url"))
1058 ;; --- IXI Mosaic ---
1061 (defun browse-url-iximosaic (url &optional new-window)
1062 ;; new-window ignored
1063 "Ask the IXIMosaic WWW browser to load URL.
1064 Default to the URL around or before point."
1065 (interactive (browse-url-interactive-arg "IXI Mosaic URL: "))
1066 (start-process "tellw3b" nil "tellw3b"
1067 "-service WWW_BROWSER ixi_showurl " url))
1072 (defun browse-url-w3 (url &optional new-window)
1073 "Ask the w3 WWW browser to load URL.
1074 Default to the URL around or before point.
1076 When called interactively, if variable `browse-url-new-window-flag' is
1077 non-nil, load the document in a new window. A non-nil interactive
1078 prefix argument reverses the effect of `browse-url-new-window-flag'.
1080 When called non-interactively, optional second argument NEW-WINDOW is
1081 used instead of `browse-url-new-window-flag'."
1082 (interactive (browse-url-interactive-arg "W3 URL: "))
1083 (require 'w3) ; w3-fetch-other-window not autoloaded
1084 (if (browse-url-maybe-new-window new-window)
1085 (w3-fetch-other-window url)
1089 (defun browse-url-w3-gnudoit (url &optional new-window)
1090 ;; new-window ignored
1091 "Ask another Emacs running gnuserv to load the URL using the W3 browser.
1092 The `browse-url-gnudoit-program' program is used with options given by
1093 `browse-url-gnudoit-args'. Default to the URL around or before point."
1094 (interactive (browse-url-interactive-arg "W3 URL: "))
1095 (apply 'start-process (concat "gnudoit:" url) nil
1096 browse-url-gnudoit-program
1097 (append browse-url-gnudoit-args
1098 (list (concat "(w3-fetch \"" url "\")")
1101 ;; --- Lynx in an xterm ---
1104 (defun browse-url-lynx-xterm (url &optional new-window)
1105 ;; new-window ignored
1106 "Ask the Lynx WWW browser to load URL.
1107 Default to the URL around or before point. A new Lynx process is run
1108 in an Xterm window using the Xterm program named by `browse-url-xterm-program'
1109 with possible additional arguments `browse-url-xterm-args'."
1110 (interactive (browse-url-interactive-arg "Lynx URL: "))
1111 (apply #'start-process `(,(concat "lynx" url) nil ,browse-url-xterm-program
1112 ,@browse-url-xterm-args "-e" "lynx"
1115 ;; --- Lynx in an Emacs "term" window ---
1118 (defun browse-url-lynx-emacs (url &optional new-buffer)
1119 "Ask the Lynx WWW browser to load URL.
1120 Default to the URL around or before point. With a prefix argument, run
1121 a new Lynx process in a new buffer.
1123 When called interactively, if variable `browse-url-new-window-flag' is
1124 non-nil, load the document in a new lynx in a new term window,
1125 otherwise use any existing one. A non-nil interactive prefix argument
1126 reverses the effect of `browse-url-new-window-flag'.
1128 When called non-interactively, optional second argument NEW-WINDOW is
1129 used instead of `browse-url-new-window-flag'."
1130 (interactive (browse-url-interactive-arg "Lynx URL: "))
1131 (let* ((system-uses-terminfo t) ; Lynx uses terminfo
1132 ;; (term-term-name "vt100") ; ??
1133 (buf (get-buffer "*lynx*"))
1134 (proc (and buf (get-buffer-process buf)))
1135 (n browse-url-lynx-input-attempts))
1136 (if (and (browse-url-maybe-new-window new-buffer) buf)
1137 ;; Rename away the OLD buffer. This isn't very polite, but
1138 ;; term insists on working in a buffer named *lynx* and would
1139 ;; choke on *lynx*<1>
1140 (progn (set-buffer buf)
1142 (if (or (browse-url-maybe-new-window new-buffer)
1145 (not (memq (process-status proc) '(run stop))))
1150 `("lynx" "lynx" nil ,@browse-url-lynx-emacs-args
1152 (switch-to-buffer buf)
1154 (set-process-sentinel
1155 (get-buffer-process buf)
1156 ;; Don't leave around a dead one (especially because of its
1158 (lambda (process event)
1159 (if (not (memq (process-status process) '(run stop)))
1160 (let ((buf (process-buffer process)))
1161 (if buf (kill-buffer buf)))))))
1162 ;; send the url to lynx in the old buffer
1163 (let ((win (get-buffer-window buf t)))
1166 (switch-to-buffer buf)))
1167 (if (eq (following-char) ?_)
1168 (cond ((eq browse-url-lynx-input-field 'warn)
1169 (error "Please move out of the input field first"))
1170 ((eq browse-url-lynx-input-field 'avoid)
1171 (while (and (eq (following-char) ?_) (> n 0))
1172 (term-send-down) ; down arrow
1173 (sit-for browse-url-lynx-input-delay))
1174 (if (eq (following-char) ?_)
1175 (error "Cannot move out of the input field, sorry")))))
1176 (term-send-string proc (concat "g" ; goto
1177 "\C-u" ; kill default url
1184 (defun browse-url-mmm (url &optional new-window)
1185 "Ask the MMM WWW browser to load URL.
1186 Default to the URL around or before point."
1187 (interactive (browse-url-interactive-arg "MMM URL: "))
1188 (message "Sending URL to MMM...")
1190 (set-buffer (get-buffer-create " *Shell Command Output*"))
1192 ;; mmm_remote just SEGVs if the file isn't there...
1193 (if (or (file-exists-p (expand-file-name "~/.mmm_remote"))
1194 ;; location in v 0.4:
1195 (file-exists-p (expand-file-name "~/.mmm/remote")))
1196 (call-process "mmm_remote" nil 0 nil url)
1197 (call-process "mmm" nil 0 nil "-external" url))
1198 (message "Sending URL to MMM... done")))
1203 (defun browse-url-mail (url &optional new-window)
1204 "Open a new mail message buffer within Emacs.
1205 Default to using the mailto: URL around or before point as the
1206 recipient's address. Supplying a non-nil interactive prefix argument
1207 will cause the mail to be composed in another window rather than the
1210 When called interactively, if variable `browse-url-new-window-flag' is
1211 non-nil use `compose-mail-other-window', otherwise `compose-mail'. A
1212 non-nil interactive prefix argument reverses the effect of
1213 `browse-url-new-window-flag'.
1215 When called non-interactively, optional second argument NEW-WINDOW is
1216 used instead of `browse-url-new-window-flag'."
1217 (interactive (browse-url-interactive-arg "Mailto URL: "))
1219 (let ((to (if (string-match "^mailto:" url)
1222 (if (browse-url-maybe-new-window new-window)
1223 (compose-mail-other-window to nil nil nil
1224 (list 'insert-buffer (current-buffer)))
1225 (compose-mail to nil nil nil nil
1226 (list 'insert-buffer (current-buffer)))))))
1228 ;; --- Random browser ---
1231 (defun browse-url-generic (url &optional new-window)
1232 ;; new-window ignored
1233 "Ask the WWW browser defined by `browse-url-generic-program' to load URL.
1234 Default to the URL around or before point. A fresh copy of the
1235 browser is started up in a new process with possible additional arguments
1236 `browse-url-generic-args'. This is appropriate for browsers which
1237 don't offer a form of remote control."
1238 (interactive (browse-url-interactive-arg "URL: "))
1239 (if (not browse-url-generic-program)
1240 (error "No browser defined (`browse-url-generic-program')"))
1241 (apply 'start-process (concat browse-url-generic-program url) nil
1242 browse-url-generic-program
1243 (append browse-url-generic-args (list url))))
1246 (defun browse-url-kde (url &optional new-window)
1247 "Ask the KDE WWW browser to load URL.
1248 Default to the URL around or before point."
1249 (interactive (browse-url-interactive-arg "KDE URL: "))
1250 (message "Sending URL to KDE...")
1251 (apply #'start-process `(,(concat "KDE" url) nil ,browse-url-kde-program
1252 ,@browse-url-kde-args ,url)))
1254 (provide 'browse-url)
1256 ;;; browse-url.el ends here