1 ;;; browse-url.el --- ask a WWW browser to load a URL
3 ;; Copyright 1995, 1996 Free Software Foundation, Inc.
5 ;; Author: Denis Howe <dbh@doc.ic.ac.uk>
6 ;; Maintainer: Denis Howe <dbh@doc.ic.ac.uk>
7 ;; Created: 03 Apr 1995
9 ;; X-Home page: http://wombat.doc.ic.ac.uk/
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 ;; The latest version of this package should be available from
31 ;; <URL:http://wombat.doc.ic.ac.uk/emacs/browse-url.el>.
33 ;; This package provides functions which read a URL (Uniform Resource
34 ;; Locator) from the minibuffer, defaulting to the URL around point,
35 ;; and ask a World-Wide Web browser to load it. It can also load the
36 ;; URL associated with the current buffer. Different browsers use
37 ;; different methods of remote control so there is one function for
38 ;; each supported browser. If the chosen browser is not running, it
39 ;; is started. Currently there is support for:
41 ;; Function Browser Earliest version
42 ;; browse-url-netscape Netscape 1.1b1
43 ;; browse-url-mosaic XMosaic <= 2.4
44 ;; browse-url-cci XMosaic 2.5
46 ;; browse-url-iximosaic IXI Mosaic ?
48 ;; Note that versions of Netscape before 1.1b1 did not have remote
49 ;; control. <URL:http://home.netscape.com/newsref/std/x-remote.html>
50 ;; and <URL:http://home.netscape.com/info/APIs/>.
52 ;; Netscape can cache Web pages so it may be necessary to tell it to
53 ;; reload the current page if it has changed (eg. if you have edited
54 ;; it). There is currently no perfect automatic solution to this.
56 ;; Netscape allows you to specify the id of the window you want to
57 ;; control but which window DO you want to control and how do you
60 ;; If using XMosaic before version 2.5, check the definition of
61 ;; browse-url-usr1-signal below.
62 ;; <URL:http://www.ncsa.uiuc.edu/SDG/Software/XMosaic/remote-control.html>
64 ;; XMosaic version 2.5 introduced Common Client Interface allowing you
65 ;; to control mosaic through Unix sockets.
66 ;; <URL:http://www.ncsa.uiuc.edu/SDG/Software/XMosaic/CCI/cci-spec.html>
68 ;; William M. Perry's excellent "w3" WWW browser for
69 ;; Emacs <URL:ftp://cs.indiana.edu/pub/elisp/w3/>
70 ;; has a function w3-follow-url-at-point, but that
71 ;; doesn't let you edit the URL like browse-url.
73 ;; I recommend Nelson Minar <nelson@santafe.edu>'s excellent
74 ;; html-helper-mode.el for editing HTML and thank Nelson for
75 ;; his many useful comments on this code.
76 ;; <URL:http://www.santafe.edu/~nelson/hhm-beta/>
78 ;; This package generalises function html-previewer-process in Marc
79 ;; Andreessen <marca@ncsa.uiuc.edu>'s html-mode (LCD
80 ;; modes/html-mode.el.Z) and provides better versions of the URL
81 ;; functions in Michelangelo Grigni <mic@cs.ucsd.edu>'s ffap.el
82 ;; (find-file-at-point) <URL:ftp://cs.ucsd.edu:/pub/mic/>. The huge
83 ;; hyperbole package also contains similar functions.
85 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
88 ;; Can you write and test some code for the Macintrash and Windoze
89 ;; Netscape remote control APIs? (See the URL above).
91 ;; Do any other browsers have remote control?
93 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
96 ;; To display the URL at or before point:
97 ;; M-x browse-url-at-point RET
99 ;; To display a URL by shift-clicking on it, put this in your ~/.emacs
101 ;; (global-set-key [S-mouse-2] 'browse-url-at-mouse)
102 ;; (Note that using Shift-mouse-1 is not desirable because
103 ;; that event has a standard meaning in Emacs.)
105 ;; To display the current buffer in a web browser:
106 ;; M-x browse-url-of-buffer RET
108 ;; In Dired, to display the file named on the current line:
109 ;; M-x browse-url-of-dired-file RET
111 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
112 ;; Customisation (~/.emacs)
114 ;; To see what variables are available for customization, type `M-x
115 ;; set-variable browse-url TAB'.
117 ;; To bind the browse-url commands to keys with the `C-c u' prefix:
118 ;; (global-set-key "\C-cu." 'browse-url-at-point)
119 ;; (global-set-key "\C-cub" 'browse-url-of-buffer)
120 ;; (global-set-key "\C-cuf" 'browse-url-of-file)
121 ;; (add-hook 'dired-mode-hook
123 ;; (local-set-key "\C-cuf" 'browse-url-of-dired-file))))
124 ;; (if (boundp 'browse-url-browser-function)
125 ;; (global-set-key "\C-cuu" browse-url-browser-function)
128 ;; '(global-set-key "\C-cuu" browse-url-browser-function)))
130 ;; To use the Emacs w3 browser when not running under X11:
131 ;; (if (not (eq window-system 'x))
132 ;; (setq browse-url-browser-function 'browse-url-w3))
134 ;; To always save modified buffers before displaying the file in a browser:
135 ;; (setq browse-url-save-file t)
137 ;; To get round the Netscape caching problem, you could try either of
138 ;; the following (but not both). EITHER write-file in
139 ;; html-helper-mode makes Netscape reload document:
141 ;; (autoload 'browse-url-netscape-reload "browse-url"
142 ;; "Ask a WWW browser to redisplay the current file." t)
143 ;; (add-hook 'html-helper-mode-hook
144 ;; (function (lambda ()
145 ;; (add-hook 'local-write-file-hooks
146 ;; (function (lambda ()
147 ;; (let ((local-write-file-hooks))
149 ;; (browse-url-netscape-reload)
150 ;; t)) ; => file written by hook
151 ;; t)))) ; append to l-w-f-hooks
153 ;; [Does this work for html-mode too?]
155 ;; OR browse-url-of-file ask Netscape to load and then reload the
158 ;; (add-hook 'browse-url-of-file-hook 'browse-url-netscape-reload)
160 ;; You may also want to customise browse-url-netscape-arguments, eg.
162 ;; (setq browse-url-netscape-arguments '("-install"))
164 ;; or similarly for the other browsers.
166 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
169 ;; 0.00 03 Apr 1995 Denis Howe <dbh@doc.ic.ac.uk>
173 ;; All names start with "browse-url-". Added provide.
176 ;; Save file at start of browse-url-of-file.
177 ;; Use start-process instead of start-process-shell-command.
180 ;; Add browse-url-netscape-reload, browse-url-netscape-command.
181 ;; browse-url-of-file save file option.
184 ;; b-u-file-url separate function. Change b-u-filename-alist
188 ;; Added b-u-of-file-hook.
191 ;; Improved .emacs suggestions and documentation.
194 ;; Added browse-url-interactive-arg optional prompt.
197 ;; Exclude final "." from browse-url-regexp.
200 ;; Added mouse-set-point to browse-url-interactive-arg.
203 ;; Added Mosaic signal sending variations.
204 ;; Thanks Brian K Servis <servis@ecn.purdue.edu>.
205 ;; Don't use xprop for Netscape.
208 ;; Fix reading of ~/.mosaicpid. Thanks Dag.H.Wanvik@kvatro.no.
211 ;; Interactive prefix arg => URL *after* point.
212 ;; Thanks Michelangelo Grigni <mic@cs.ucsd.edu>.
213 ;; Added IXI Mosaic support.
214 ;; Thanks David Karr <dkarr@nmo.gtegsc.com>.
217 ;; Exclude final [,;] from browse-url-regexp.
220 ;; Provide browser argument variables.
223 ;; More Netscape options. Thanks Peter Arius
224 ;; <arius@immd2.informatik.uni-erlangen.de>.
227 ;; Added browse-url-at-mouse.
228 ;; Thanks Wayne Mesard <wmesard@sgi.com>
231 ;; Renamed browse-url-at-point to browse-url-url-at-point.
232 ;; Added browse-url-at-point.
233 ;; Thanks Jonathan Cano <cano@patch.tandem.com>.
236 ;; Fixed call to browse-url-url-at-point in browse-url-at-point.
237 ;; Thanks Eric Ding <ericding@San-Jose.ate.slb.com>.
240 ;; Improved documentation.
241 ;; Thanks Kevin Rodgers <kevin.rodgers@ihs.com>.
244 ;; browse-url-of-buffer to handle file-less buffers.
245 ;; browse-url-of-dired-file browses current file in dired.
246 ;; Thanks Kevin Rodgers <kevin.rodgers@ihs.com>.
249 ;; XMosaic CCI functions.
250 ;; Thanks Marc Furrer <Marc.Furrer@di.epfl.ch>.
253 ;; Fixed new-window documentation and added to browse-url-cci.
254 ;; Thanks Dilip Sequeira <djs@dcs.ed.ac.uk>.
256 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
259 (defvar browse-url-regexp
260 "\\(https?://\\|ftp://\\|gopher://\\|telnet://\\|wais://\\|file:/\\|s?news:\\|mailto:\\)[^]\t\n \"'()<>[^`{}]*[^]\t\n \"'()<>[^`{}.,;]+"
261 "A regular expression probably matching a URL.")
263 (defvar browse-url-browser-function
265 "*Function to display the current buffer in a WWW browser.
266 Used by the `browse-url-at-point', `browse-url-at-mouse', and
267 `browse-url-of-file' commands.")
269 (defvar browse-url-netscape-program
"netscape"
270 "*The name for invoking Netscape.")
272 (defvar browse-url-netscape-arguments nil
273 "*A list of strings to pass to Netscape as arguments.")
275 (defvar browse-url-new-window-p nil
276 "*If non-nil, always open a new browser window.
277 Passing an interactive argument to \\[browse-url-netscape] or
278 \\[browse-url-cci] reverses the effect of this variable. Requires
279 Netscape version 1.1N or later or XMosaic version 2.5 or later.")
281 (defvar browse-url-mosaic-program
"xmosaic"
282 "*The name for invoking Mosaic.")
284 (defvar browse-url-mosaic-arguments nil
285 "*A list of strings to pass to Mosaic as arguments.")
287 (defvar browse-url-filename-alist
288 '(("^/+" .
"file:/"))
289 "An alist of (REGEXP . STRING) pairs.
290 Any substring of a filename matching one of the REGEXPs is replaced by
291 the corresponding STRING. All pairs are applied in the order given.
292 Used by the `browse-url-of-file' command.")
294 (defvar browse-url-save-file nil
295 "If non-nil, save the buffer before displaying its file.
296 Used by the `browse-url-of-file' command.")
298 (defvar browse-url-of-file-hook nil
299 "A hook to be run with run-hook after `browse-url-of-file' has asked
300 a browser to load a file.
302 Set this to `browse-url-netscape-reload' to force Netscape to load the
303 file rather than displaying a cached copy.")
305 (defvar browse-url-usr1-signal
306 (if (and (boundp 'emacs-major-version
)
307 (or (> emacs-major-version
19) (>= emacs-minor-version
29)))
309 30) ; Check /usr/include/signal.h.
310 "The argument to `signal-process' for sending SIGUSR1 to XMosaic.
311 Emacs 19.29 accepts 'SIGUSR1, earlier versions require an integer
312 which is 30 on SunOS and 16 on HP-UX and Solaris.")
314 (defvar browse-url-CCI-port
3003
315 "Port to access XMosaic via CCI.
316 This can be any number between 1024 and 65535 but must correspond to
317 the value set in the browser.")
319 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
322 ;; thingatpt.el doesn't work for complex regexps.
324 (defun browse-url-url-at-point ()
325 "Return the URL around or before point.
326 Then search backwards for the start of a URL. If no URL found, return
328 (if (or (looking-at browse-url-regexp
) ; Already at start
329 (let ((eol (save-excursion (end-of-line) (point))))
330 ;; Search forwards for the next URL or end of line in case
331 ;; we're in the middle of one.
332 (and (re-search-forward browse-url-regexp eol
'lim
)
333 (goto-char (match-beginning 0)))
334 ;; Now back to where we started or earlier.
335 (re-search-backward browse-url-regexp nil t
)))
336 (buffer-substring (match-beginning 0) (match-end 0))
339 ;; Todo: restrict to around or immediately before point. Expand bare
342 (defun browse-url-interactive-arg (&optional prompt
)
343 "Read a URL from the minibuffer, optionally prompting with PROMPT.
344 Default to the URL at or before point. If bound to a mouse button,
345 set point to the position clicked. Return the result as a list for
346 use in `interactive'."
347 (let ((event (elt (this-command-keys) 0)))
348 (and (listp event
) (mouse-set-point event
)))
349 (list (read-string (or prompt
"URL: ") (browse-url-url-at-point))))
352 (defun browse-url-at-point ()
353 "Ask a WWW browser to load the URL at or before point.
354 The URL is loaded according to the value of `browse-url-browser-function'."
356 (funcall browse-url-browser-function
(browse-url-url-at-point)))
359 (defun browse-url-at-mouse (event)
360 "Ask a WWW browser to load a URL clicked with the mouse.
361 The URL is the one around or before the position of the mouse click
362 but point is not changed. The URL is loaded according to the value of
363 `browse-url-browser-function'."
366 (let ((posn (event-start event
)))
367 (set-buffer (window-buffer (posn-window posn
)))
368 (goto-char (posn-point posn
))
369 (let ((url (browse-url-url-at-point)))
370 (if (string-equal url
"")
371 (error "No URL found"))
372 (funcall browse-url-browser-function url
)))))
374 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
375 ;; Browse current buffer
378 (defun browse-url-of-file (&optional file
)
379 "Ask a WWW browser to display FILE.
380 Display the current buffer's file if FILE is nil or if called
381 interactively. Turn the filename into a URL by performing
382 replacements given in variable `browse-url-filename-alist'. Pass the
383 URL to a browser using variable `browse-url-browser-function' then run
384 `browse-url-of-file-hook'."
389 (error "Current buffer has no file")))
390 (let ((buf (get-file-buffer file
)))
394 (cond ((not (buffer-modified-p)))
395 (browse-url-save-file (save-buffer))
396 (t (message "%s modified since last save" file
))))))
397 (funcall browse-url-browser-function
(browse-url-file-url file
))
398 (run-hooks 'browse-url-of-file-hook
))
400 (defun browse-url-file-url (file)
401 "Return the URL corresponding to FILE.
402 Uses variable `browse-url-filename-alist' to map filenames to URLs."
403 (let ((maps browse-url-filename-alist
))
405 (let* ((map (car maps
))
407 (to-string (cdr map
)))
408 (setq maps
(cdr maps
))
409 (if (string-match from-re file
)
410 (setq file
(concat (substring file
0 (match-beginning 0))
412 (substring file
(match-end 0))))))))
415 (defvar browse-url-temp-file-name nil
)
416 (make-variable-buffer-local 'browse-url-temp-file-name
)
418 (defvar browse-url-temp-file-list
'())
421 (defun browse-url-of-buffer (&optional buffer
)
422 "Ask a WWW browser to display BUFFER.
423 Display the current buffer if BUFFER is nil."
426 (set-buffer (or buffer
(current-buffer)))
429 (and (boundp 'dired-directory
) dired-directory
))))
432 (if (null browse-url-temp-file-name
)
434 (setq browse-url-temp-file-name
436 (expand-file-name (buffer-name)
437 (or (getenv "TMPDIR") "/tmp"))))
438 (setq browse-url-temp-file-list
439 (cons browse-url-temp-file-name
440 browse-url-temp-file-list
))))
441 (write-region (point-min) (point-max) browse-url-temp-file-name
443 (browse-url-of-file (or file-name browse-url-temp-file-name
)))))
445 (defun browse-url-delete-temp-file (&optional temp-file-name
)
446 ;; Delete browse-url-temp-file-name from the file system and from
447 ;; browse-url-temp-file-list. If optional arg TEMP-FILE-NAME is
448 ;; non-nil, delete it instead, but only from the file system --
449 ;; browse-url-temp-file-list is not affected.
450 (let ((file-name (or temp-file-name browse-url-temp-file-name
)))
451 (if (and file-name
(file-exists-p file-name
))
453 (delete-file file-name
)
454 (if (null temp-file-name
)
455 (setq browse-url-temp-file-list
456 (delete browse-url-temp-file-name
457 browse-url-temp-file-list
)))))))
459 (defun browse-url-delete-temp-file-list ()
460 ;; Delete all elements of browse-url-temp-file-list.
461 (while browse-url-temp-file-list
462 (browse-url-delete-temp-file (car browse-url-temp-file-list
))
463 (setq browse-url-temp-file-list
464 (cdr browse-url-temp-file-list
))))
466 (add-hook 'kill-buffer-hook
'browse-url-delete-temp-file
)
467 (add-hook 'kill-emacs-hook
'browse-url-delete-temp-file-list
)
470 (defun browse-url-of-dired-file ()
471 "In Dired, ask a WWW browser to display the file named on this line."
473 (browse-url-of-file (dired-get-filename)))
475 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
476 ;; Browser-specific functions
478 (defun browse-url-netscape (url &optional new-window
)
479 "Ask the Netscape WWW browser to load URL.
481 Default to the URL around or before point. The strings in variable
482 `browse-url-netscape-arguments' are also passed to Netscape.
484 When called interactively, if variable `browse-url-new-window-p' is
485 non-nil, load the document in a new Netscape window, otherwise use a
486 random existing one. A non-nil interactive prefix argument reverses
487 the effect of browse-url-new-window-p.
489 When called non-interactively, optional second argument NEW-WINDOW is
490 used instead of browse-url-new-window-p."
492 (interactive (append (browse-url-interactive-arg "Netscape URL: ")
493 (list (not (eq (null browse-url-new-window-p
)
494 (null current-prefix-arg
))))))
496 (apply 'call-process browse-url-netscape-program nil nil nil
497 (append browse-url-netscape-arguments
498 (if new-window
'("-noraise"))
500 (concat "openURL(" url
501 (if new-window
",new-window")
505 (error "netscape got signal: %s" res
)
507 (progn ; Netscape not running - start it
508 (message "Starting Netscape...")
509 (apply 'start-process
"netscape" nil browse-url-netscape-program
510 (append browse-url-netscape-arguments
(list url
))))))))
512 (defun browse-url-netscape-reload ()
513 "Ask Netscape to reload its current document."
515 (browse-url-netscape-command "reload"))
517 (defun browse-url-netscape-command (command)
518 "Send a remote control command to Netscape."
519 (apply 'start-process
"netscape" nil
"netscape"
520 (append browse-url-netscape-arguments
521 (list "-remote" command
))))
523 (defun browse-url-mosaic (url)
524 "Ask the XMosaic WWW browser to load URL.
525 Default to the URL around or before point."
526 (interactive (browse-url-interactive-arg "Mosaic URL: "))
527 (let ((pidfile (expand-file-name "~/.mosaicpid"))
529 (if (file-readable-p pidfile
)
532 (goto-char (point-min))
533 (setq pid
(read (current-buffer)))
535 (if (and pid
(zerop (signal-process pid
0))) ; Mosaic running
537 (find-file (format "/tmp/Mosaic.%d" pid
))
539 (insert "goto\n" url
"\n")
542 ;; Send signal SIGUSR to Mosaic
543 (signal-process pid browse-url-usr1-signal
)
544 (message "Signal sent to Mosaic")
546 ;; (call-process "kill" nil 0 nil "-USR1" (int-to-string pid))
548 ;; Mosaic not running - start it
549 (message "Starting Mosaic...")
550 (apply 'start-process
"xmosaic" nil browse-url-mosaic-program
551 (append browse-url-mosaic-arguments
(list url
)))
552 (message "Starting Mosaic...done"))))
554 (defun browse-url-cci (url &optional new-window
)
555 "Ask the XMosaic WWW browser to load URL.
556 Default to the URL around or before point.
558 This function only works for XMosaic version 2.5 or later. You must
559 select `CCI' from XMosaic's File menu, set the CCI Port Address to the
560 value of variable `browse-url-CCI-port', and enable `Accept requests'.
562 When called interactively, if variable `browse-url-new-window-p' is
563 non-nil, load the document in a new browser window, otherwise use a
564 random existing one. A non-nil interactive prefix argument reverses
565 the effect of browse-url-new-window-p.
567 When called non-interactively, optional second argument NEW-WINDOW is
568 used instead of browse-url-new-window-p."
569 (interactive (append (browse-url-interactive-arg "Mosaic URL: ")
570 (list (not (eq (null browse-url-new-window-p
)
571 (null current-prefix-arg
))))))
572 (open-network-stream "browse-url" " *browse-url*"
573 "localhost" browse-url-CCI-port
)
574 ;; Todo: start browser if fails
575 (process-send-string "browse-url"
576 (concat "get url (" url
") output "
577 (if new-window
"new" "current") "\r\n"))
578 (process-send-string "browse-url" "disconnect\r\n")
579 (delete-process "browse-url"))
581 (defun browse-url-iximosaic (url)
582 "Ask the IXIMosaic WWW browser to load URL.
583 Default to the URL around or before point."
584 (interactive (browse-url-interactive-arg "IXI Mosaic URL: "))
585 (start-process "tellw3b" nil
"tellw3b"
586 "-service WWW_BROWSER ixi_showurl " url
))
588 (defun browse-url-w3 (url)
589 "Ask the w3 WWW browser to load URL.
590 Default to the URL around or before point."
591 (interactive (browse-url-interactive-arg "W3 URL: "))
594 (provide 'browse-url
)
596 ;;; browse-url.el ends here