lisp/net/browse-url.el

   1 ;;; browse-url.el --- pass a URL to a WWW browser
   2
   3 ;; Copyright (C) 1995, 96, 97, 98, 99, 2000, 2001
   4 ;;   Free Software Foundation, Inc.
   5
   6 ;; Author: Denis Howe <dbh@doc.ic.ac.uk>
   7 ;; Maintainer: FSF
   8 ;; Created: 03 Apr 1995
   9 ;; Keywords: hypertext, hypermedia, mouse
  10
  11 ;; This file is part of GNU Emacs.
  12
  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)
  16 ;; any later version.
  17
  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.
  22
  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.
  27
  28 ;;; Commentary:
  29
  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:
  38
  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
  45 ;; browse-url-w3                      w3          0
  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)
  55
  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.]
  59
  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>.
  62
  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.
  66
  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
  69 ;; discover its id?
  70
  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/>.
  78
  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>.
  86
  87 ;; Lynx is now distributed by the FSF.  See also
  88 ;; <URL:http://lynx.browser.org/>.
  89
  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://ftp.enst.fr/pub/mbone/mMosaic/>,
  96 ;; <URL:http://www.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.
  99
 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/>
 104
 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
 109 ;; with this.
 110
 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
 114 ;; functions.
 115
 116 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 117 ;; Help!
 118
 119 ;; Can you write and test some code for the Macintrash and Windoze
 120 ;; Netscape remote control APIs?  (See the URL above).
 121
 122 ;; Do any other browsers have remote control?
 123
 124 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 125 ;; Usage
 126
 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
 130 ;; the buffer, use:
 131 ;; M-x browse-url
 132
 133 ;; To display a URL by shift-clicking on it, put this in your ~/.emacs
 134 ;; file:
 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.)
 138
 139 ;; To display the current buffer in a web browser:
 140 ;; M-x browse-url-of-buffer RET
 141
 142 ;; To display the current region in a web browser:
 143 ;; M-x browse-url-of-region RET
 144
 145 ;; In Dired, to display the file named on the current line:
 146 ;; M-x browse-url-of-dired-file RET
 147
 148 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 149 ;; Customisation (~/.emacs)
 150
 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'.
 154
 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
 163 ;;                (lambda ()
 164 ;;                   (local-set-key "\C-c\C-zf" 'browse-url-of-dired-file)))
 165
 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'.
 170
 171 ;; Gnus provides a standard feature to activate URLs in article
 172 ;; buffers for invocation of browse-url.
 173
 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))
 177
 178 ;; To always save modified buffers before displaying the file in a browser:
 179 ;;      (setq browse-url-save-file t)
 180
 181 ;; To get round the Netscape caching problem, you could EITHER have
 182 ;; write-file in html-helper-mode make Netscape reload the document:
 183 ;;
 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
 187 ;;                (lambda ()
 188 ;;                   (add-hook 'local-write-file-hooks
 189 ;;                             (lambda ()
 190 ;;                                (let ((local-write-file-hooks))
 191 ;;                                  (save-buffer))
 192 ;;                                (browse-url-netscape-reload)
 193 ;;                                t)                    ; => file written by hook
 194 ;;                             t)))                     ; append to l-w-f-hooks
 195 ;;
 196 ;; OR have browse-url-of-file ask Netscape to load and then reload the
 197 ;; file:
 198 ;;
 199 ;;      (add-hook 'browse-url-of-file-hook 'browse-url-netscape-reload)
 200
 201 ;; You may also want to customise browse-url-netscape-arguments, e.g.
 202 ;;      (setq browse-url-netscape-arguments '("-install"))
 203 ;;
 204 ;; or similarly for the other browsers.
 205
 206 ;; To invoke different browsers for different URLs:
 207 ;;      (setq browse-url-browser-function '(("^mailto:" . browse-url-mail)
 208 ;;                                          ("." . browse-url-netscape)))
 209
 210 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 211 ;;; Code:
 212
 213 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 214 ;; Variables
 215
 216 (eval-when-compile (require 'thingatpt)
 217                    (require 'term)
 218                    (require 'dired)
 219                    (require 'executable)
 220                    (require 'w3-auto nil t))
 221
 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")
 226   :group 'hypermedia)
 227
 228 ;;;###autoload
 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.
 236
 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."
 242   :type '(choice
 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))
 270   :version "21.1"
 271   :group 'browse-url)
 272
 273 (defcustom browse-url-netscape-program "netscape"
 274   ;; Info about netscape-remote from Karl Berry.
 275   "*The name by which to invoke Netscape.
 276
 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."
 282   :type 'string
 283   :group 'browse-url)
 284
 285 (defcustom browse-url-netscape-arguments nil
 286   "*A list of strings to pass to Netscape as arguments."
 287   :type '(repeat (string :tag "Argument"))
 288   :group 'browse-url)
 289
 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"))
 295   :group 'browse-url)
 296
 297 ;;;###autoload
 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))
 301   :group 'browse-url)
 302
 303 (defcustom browse-url-mozilla-program "mozilla"
 304   "*The name by which to invoke Mozilla."
 305   :type 'string
 306   :group 'browse-url)
 307
 308 (defcustom browse-url-mozilla-arguments nil
 309   "*A list of strings to pass to Mozilla as arguments."
 310   :type '(repeat (string :tag "Argument"))
 311   :group 'browse-url)
 312
 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"))
 318   :group 'browse-url)
 319
 320 ;;;###autoload
 321 (defcustom browse-url-galeon-program "galeon"
 322   "*The name by which to invoke Galeon."
 323   :type 'string
 324   :group 'browse-url)
 325
 326 (defcustom browse-url-galeon-arguments nil
 327   "*A list of strings to pass to Galeon as arguments."
 328   :type '(repeat (string :tag "Argument"))
 329   :group 'browse-url)
 330
 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"))
 336   :group 'browse-url)
 337
 338 (defcustom browse-url-mozilla-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-mozilla' is asked to open it in a new window."
 342   :type 'boolean
 343   :group 'browse-url)
 344
 345 (defcustom browse-url-galeon-new-window-is-tab nil
 346   "*Whether to open up new windows in a tab or a new window.
 347 If non-nil, then open the URL in a new tab rather than a new window if
 348 `browse-url-galeon' is asked to open it in a new window."
 349   :type 'boolean
 350   :group 'browse-url)
 351
 352 ;;;###autoload
 353 (defcustom browse-url-new-window-flag nil
 354   "*If non-nil, always open a new browser window with appropriate browsers.
 355 Passing an interactive argument to \\[browse-url], or specific browser
 356 commands reverses the effect of this variable.  Requires Netscape version
 357 1.1N or later or XMosaic version 2.5 or later if using those browsers."
 358   :type 'boolean
 359   :group 'browse-url)
 360
 361 (defcustom browse-url-mosaic-program "xmosaic"
 362   "*The name by which to invoke Mosaic (or mMosaic)."
 363   :type 'string
 364   :version "20.3"
 365   :group 'browse-url)
 366
 367 (defcustom browse-url-mosaic-arguments nil
 368   "*A list of strings to pass to Mosaic as arguments."
 369   :type '(repeat (string :tag "Argument"))
 370   :group 'browse-url)
 371
 372 (defcustom browse-url-mosaic-pidfile "~/.mosaicpid"
 373   "*The name of the pidfile created by Mosaic."
 374   :type 'string
 375   :group 'browse-url)
 376
 377 (defcustom browse-url-filename-alist
 378   (\`                                   ; Backquote syntax won't work.
 379    (("^/\\(ftp@\\|anonymous@\\)?\\([^:]+\\):/*" . "ftp://\\2/")
 380     ;; The above loses the username to avoid the browser prompting for
 381     ;; it in anonymous cases.  If it's not anonymous the next regexp
 382     ;; applies.
 383     ("^/\\([^:@]+@\\)?\\([^:]+\\):/*" . "ftp://\\1\\2/")
 384     (,@ (if (memq system-type '(windows-nt ms-dos))
 385             '(("^\\([a-zA-Z]:\\)[\\/]" . "file:\\1/")
 386               ("^[\\/][\\/]+" . "file://"))))
 387     ("^/+" . "file:/")))
 388   "*An alist of (REGEXP . STRING) pairs used by `browse-url-of-file'.
 389 Any substring of a filename matching one of the REGEXPs is replaced by
 390 the corresponding STRING using `replace-match', not treating STRING
 391 literally.  All pairs are applied in the order given.  The default
 392 value converts ange-ftp/EFS-style paths into ftp URLs and prepends
 393 `file:' to any path beginning with `/'.
 394
 395 For example, adding to the default a specific translation of an ange-ftp
 396 address to an HTTP URL:
 397
 398     (setq browse-url-filename-alist
 399           '((\"/webmaster@webserver:/home/www/html/\" .
 400              \"http://www.acme.co.uk/\")
 401             (\"^/\\(ftp@\\|anonymous@\\)?\\([^:]+\\):/*\" . \"ftp://\\2/\")
 402             (\"^/\\([^:@]+@\\)?\\([^:]+\\):/*\" . \"ftp://\\1\\2/\")
 403             (\"^/+\" . \"file:/\")))
 404 "
 405   :type '(repeat (cons :format "%v"
 406                        (regexp :tag "Regexp")
 407                        (string :tag "Replacement")))
 408   :version "20.3"
 409   :group 'browse-url)
 410
 411 ;;;###autoload
 412 (defcustom browse-url-save-file nil
 413   "*If non-nil, save the buffer before displaying its file.
 414 Used by the `browse-url-of-file' command."
 415   :type 'boolean
 416   :group 'browse-url)
 417
 418 (defcustom browse-url-of-file-hook nil
 419   "*Run after `browse-url-of-file' has asked a browser to load a file.
 420
 421 Set this to `browse-url-netscape-reload' to force Netscape to load the
 422 file rather than displaying a cached copy."
 423   :type 'hook
 424   :options '(browse-url-netscape-reload)
 425   :group 'browse-url)
 426
 427 (defvar browse-url-usr1-signal
 428   (if (and (boundp 'emacs-major-version)
 429            (or (> emacs-major-version 19) (>= emacs-minor-version 29)))
 430       'SIGUSR1 ; Why did I think this was in lower case before?
 431     30)                                 ; Check /usr/include/signal.h.
 432   "The argument to `signal-process' for sending SIGUSR1 to XMosaic.
 433 Emacs 19.29 accepts 'SIGUSR1, earlier versions require an integer
 434 which is 30 on SunOS and 16 on HP-UX and Solaris.")
 435
 436 (defcustom browse-url-CCI-port 3003
 437   "*Port to access XMosaic via CCI.
 438 This can be any number between 1024 and 65535 but must correspond to
 439 the value set in the browser."
 440   :type 'integer
 441   :group 'browse-url)
 442
 443 (defcustom browse-url-CCI-host "localhost"
 444   "*Host to access XMosaic via CCI.
 445 This should be the host name of the machine running XMosaic with CCI
 446 enabled.  The port number should be set in `browse-url-CCI-port'."
 447   :type 'string
 448   :group 'browse-url)
 449
 450 (defvar browse-url-temp-file-name nil)
 451 (make-variable-buffer-local 'browse-url-temp-file-name)
 452
 453 (defcustom browse-url-xterm-program "xterm"
 454   "*The name of the terminal emulator used by `browse-url-lynx-xterm'.
 455 This might, for instance, be a separate colour version of xterm."
 456   :type 'string
 457   :group 'browse-url)
 458
 459 (defcustom browse-url-xterm-args nil
 460   "*A list of strings defining options for `browse-url-xterm-program'.
 461 These might set its size, for instance."
 462   :type '(repeat (string :tag "Argument"))
 463   :group 'browse-url)
 464
 465 (defcustom browse-url-lynx-emacs-args (and (not window-system)
 466                                            '("-show_cursor"))
 467   "*A list of strings defining options for Lynx in an Emacs buffer.
 468
 469 The default is none in a window system, otherwise `-show_cursor' to
 470 indicate the position of the current link in the absence of
 471 highlighting, assuming the normal default for showing the cursor."
 472   :type '(repeat (string :tag "Argument"))
 473   :version "20.3"
 474   :group 'browse-url)
 475
 476 (defcustom browse-url-gnudoit-program "gnudoit"
 477   "*The name of the `gnudoit' program used by `browse-url-w3-gnudoit'."
 478   :type 'string
 479   :group 'browse-url)
 480
 481 (defcustom browse-url-gnudoit-args '("-q")
 482   "*A list of strings defining options for `browse-url-gnudoit-program'.
 483 These might set the port, for instance."
 484   :type '(repeat (string :tag "Argument"))
 485   :group 'browse-url)
 486
 487 ;;;###autoload
 488 (defcustom browse-url-generic-program nil
 489   "*The name of the browser program used by `browse-url-generic'."
 490   :type '(choice string (const :tag "None" nil))
 491   :group 'browse-url)
 492
 493 (defcustom browse-url-generic-args nil
 494   "*A list of strings defining options for `browse-url-generic-program'."
 495   :type '(repeat (string :tag "Argument"))
 496   :group 'browse-url)
 497
 498 (defcustom browse-url-temp-dir temporary-file-directory
 499   "*The name of a directory for browse-url's temporary files.
 500 Such files are generated by functions like `browse-url-of-region'.
 501 You might want to set this to somewhere with restricted read permissions
 502 for privacy's sake."
 503   :type 'string
 504   :group 'browse-url)
 505
 506 (defcustom browse-url-netscape-version
 507   3
 508   "*The version of Netscape you are using.
 509 This affects how URL reloading is done; the mechanism changed
 510 incompatibly at version 4."
 511   :type 'number
 512   :group 'browse-url)
 513
 514 (defcustom browse-url-lynx-input-field 'avoid
 515   "*Action on selecting an existing Lynx buffer at an input field.
 516 What to do when sending a new URL to an existing Lynx buffer in Emacs
 517 if the Lynx cursor is on an input field (in which case the `g' command
 518 would be entered as data).  Such fields are recognized by the
 519 underlines ____.  Allowed values: nil: disregard it, 'warn: warn the
 520 user and don't emit the URL, 'avoid: try to avoid the field by moving
 521 down (this *won't* always work)."
 522   :type '(choice (const :tag "Move to try to avoid field" :value avoid)
 523                  (const :tag "Disregard" :value nil)
 524                  (const :tag "Warn, don't emit URL" :value warn))
 525   :version "20.3"
 526   :group 'browse-url)
 527
 528 (defcustom browse-url-lynx-input-attempts 10
 529   "*How many times to try to move down from a series of lynx input fields."
 530   :type 'integer
 531   :group 'browse-url)
 532
 533 (defcustom browse-url-lynx-input-delay 0.2
 534   "*How many seconds to wait for lynx between moves down from an input field."
 535   :type 'number
 536   :group 'browse-url)
 537
 538 (defcustom browse-url-kde-program "kfmclient"
 539   "*The name by which to invoke the KDE web browser."
 540   :type 'string
 541   :version "21.1"
 542   :group 'browse-url)
 543
 544 (defcustom browse-url-kde-args '("openURL")
 545   "*A list of strings defining options for `browse-url-kde-program'."
 546   :type '(repeat (string :tag "Argument"))
 547   :group 'browse-url)
 548
 549 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 550 ;; URL input
 551
 552 (defun browse-url-url-at-point ()
 553   (let ((url (thing-at-point 'url)))
 554     (set-text-properties 0 (length url) nil url)
 555     url))
 556
 557 ;; Having this as a separate function called by the browser-specific
 558 ;; functions allows them to be stand-alone commands, making it easier
 559 ;; to switch between browsers.
 560
 561 (defun browse-url-interactive-arg (prompt)
 562   "Read a URL from the minibuffer, prompting with PROMPT.
 563 Default to the URL at or before point.  If invoked with a mouse button,
 564 set point to the position clicked first.  Return a list for use in
 565 `interactive' containing the URL and `browse-url-new-window-flag' or its
 566 negation if a prefix argument was given."
 567   (let ((event (elt (this-command-keys) 0)))
 568     (and (listp event) (mouse-set-point event)))
 569   (list (read-string prompt (browse-url-url-at-point))
 570         (not (eq (null browse-url-new-window-flag)
 571                  (null current-prefix-arg)))))
 572
 573 ;; interactive-p needs to be called at a function's top-level, hence
 574 ;; the macro.
 575 (defmacro browse-url-maybe-new-window (arg)
 576   `(if (not (interactive-p))
 577        ,arg
 578      browse-url-new-window-flag))
 579
 580 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 581 ;; Browse current buffer
 582
 583 ;;;###autoload
 584 (defun browse-url-of-file (&optional file)
 585   "Ask a WWW browser to display FILE.
 586 Display the current buffer's file if FILE is nil or if called
 587 interactively.  Turn the filename into a URL with function
 588 `browse-url-file-url'.  Pass the URL to a browser using the
 589 `browse-url' function then run `browse-url-of-file-hook'."
 590   (interactive)
 591   (or file
 592       (setq file (buffer-file-name))
 593       (error "Current buffer has no file"))
 594   (let ((buf (get-file-buffer file)))
 595     (if buf
 596         (save-excursion
 597           (set-buffer buf)
 598           (cond ((not (buffer-modified-p)))
 599                 (browse-url-save-file (save-buffer))
 600                 (t (message "%s modified since last save" file))))))
 601   (browse-url (browse-url-file-url file))
 602   (run-hooks 'browse-url-of-file-hook))
 603
 604 (defun browse-url-file-url (file)
 605   "Return the URL corresponding to FILE.
 606 Use variable `browse-url-filename-alist' to map filenames to URLs."
 607   ;; URL-encode special chars, do % first
 608   (let ((s 0))
 609     (while (setq s (string-match "%" file s))
 610       (setq file (replace-match "%25" t t file)
 611             s (1+ s))))
 612   (while (string-match "[*\"()',=;? ]" file)
 613     (let ((enc (format "%%%x" (aref file (match-beginning 0)))))
 614       (setq file (replace-match enc t t file))))
 615   (dolist (map browse-url-filename-alist)
 616     (when (and map (string-match (car map) file))
 617       (setq file (replace-match (cdr map) t nil file))))
 618   file)
 619
 620 ;;;###autoload
 621 (defun browse-url-of-buffer (&optional buffer)
 622   "Ask a WWW browser to display BUFFER.
 623 Display the current buffer if BUFFER is nil.  Display only the
 624 currently visible part of BUFFER (from a temporary file) if buffer is
 625 narrowed."
 626   (interactive)
 627   (save-excursion
 628     (and buffer (set-buffer buffer))
 629     (let ((file-name
 630            ;; Ignore real name if restricted
 631            (and (= (- (point-max) (point-min)) (buffer-size))
 632                 (or buffer-file-name
 633                     (and (boundp 'dired-directory) dired-directory)))))
 634       (or file-name
 635           (progn
 636             (or browse-url-temp-file-name
 637                 (setq browse-url-temp-file-name
 638                       (convert-standard-filename
 639                        (make-temp-file
 640                         (expand-file-name "burl" browse-url-temp-dir)))))
 641             (setq file-name browse-url-temp-file-name)
 642             (write-region (point-min) (point-max) file-name nil 'no-message)))
 643       (browse-url-of-file file-name))))
 644
 645 (defun browse-url-delete-temp-file (&optional temp-file-name)
 646   ;; Delete browse-url-temp-file-name from the file system
 647   ;; If optional arg TEMP-FILE-NAME is non-nil, delete it instead
 648   (let ((file-name (or temp-file-name browse-url-temp-file-name)))
 649     (if (and file-name (file-exists-p file-name))
 650         (delete-file file-name))))
 651
 652 (add-hook 'kill-buffer-hook 'browse-url-delete-temp-file)
 653
 654 ;;;###autoload
 655 (defun browse-url-of-dired-file ()
 656   "In Dired, ask a WWW browser to display the file named on this line."
 657   (interactive)
 658   (browse-url-of-file (dired-get-filename)))
 659
 660 ;;;###autoload
 661 (defun browse-url-of-region (min max)
 662   "Ask a WWW browser to display the current region."
 663   (interactive "r")
 664   (save-excursion
 665     (save-restriction
 666       (narrow-to-region min max)
 667       (browse-url-of-buffer))))
 668
 669 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 670 ;; Browser-independent commands
 671
 672 ;; A generic command to call the current browse-url-browser-function
 673
 674 ;;;###autoload
 675 (defun browse-url (url &rest args)
 676   "Ask a WWW browser to load URL.
 677 Prompts for a URL, defaulting to the URL at or before point.  Variable
 678 `browse-url-browser-function' says which browser to use."
 679   (interactive (browse-url-interactive-arg "URL: "))
 680   (unless (interactive-p)
 681     (setq args (or args (list browse-url-new-window-flag))))
 682   (if (functionp browse-url-browser-function)
 683       (apply browse-url-browser-function url args)
 684     ;; The `function' can be an alist; look down it for first match
 685     ;; and apply the function (which might be a lambda).
 686     (catch 'done
 687       (dolist (bf browse-url-browser-function)
 688         (when (string-match (car bf) url)
 689           (apply (cdr bf) url args)
 690           (throw 'done t)))
 691       (error "No browse-url-browser-function matching URL %s"
 692              url))))
 693
 694 ;;;###autoload
 695 (defun browse-url-at-point (&optional arg)
 696   "Ask a WWW browser to load the URL at or before point.
 697 Doesn't let you edit the URL like `browse-url'.  Variable
 698 `browse-url-browser-function' says which browser to use."
 699   (interactive "P")
 700   (let ((url (browse-url-url-at-point)))
 701     (if url
 702         (browse-url url (if arg
 703                             (not browse-url-new-window-flag)
 704                           browse-url-new-window-flag))
 705       (error "No URL found"))))
 706
 707 ;;;###autoload
 708 (defun browse-url-at-mouse (event)
 709   "Ask a WWW browser to load a URL clicked with the mouse.
 710 The URL is the one around or before the position of the mouse click
 711 but point is not changed.  Doesn't let you edit the URL like
 712 `browse-url'.  Variable `browse-url-browser-function' says which browser
 713 to use."
 714   (interactive "e")
 715   (save-excursion
 716     (mouse-set-point event)
 717     ;; This handles browse-url-new-window-flag properly
 718     ;; when it gets no arg.
 719     (browse-url-at-point)))
 720
 721 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 722 ;; Browser-specific commands
 723
 724 ;; --- Default MS-Windows browser ---
 725
 726 (defun browse-url-default-windows-browser (url &optional new-window)
 727   (interactive (browse-url-interactive-arg "URL: "))
 728   (if (eq system-type 'ms-dos)
 729       (if dos-windows-version
 730           (shell-command (concat "start " (shell-quote-argument url)))
 731         (error "Browsing URLs is not supported on this system"))
 732     (w32-shell-execute "open" url)))
 733
 734 ;; --- Netscape ---
 735
 736 (defun browse-url-process-environment ()
 737   "Set DISPLAY in the environment to the X display the browser will use.
 738 This is either the value of variable `browse-url-browser-display' if
 739 non-nil, or the same display as Emacs if different from the current
 740 environment, otherwise just use the current environment."
 741   (let ((display (or browse-url-browser-display (browse-url-emacs-display))))
 742     (if display
 743         (cons (concat "DISPLAY=" display) process-environment)
 744       process-environment)))
 745
 746 (defun browse-url-emacs-display ()
 747   "Return the X display Emacs is running on.
 748 This is nil if the display is the same as the DISPLAY environment variable.
 749
 750 Actually Emacs could be using several displays; this just returns the
 751 one showing the selected frame."
 752   (let ((display (cdr-safe (assq 'display (frame-parameters)))))
 753     (and (not (equal display (getenv "DISPLAY")))
 754          display)))
 755
 756 ;;;###autoload
 757 (defun browse-url-default-browser (url &rest args)
 758   "Find a suitable browser and ask it to load URL.
 759 Default to the URL around or before point.
 760
 761 When called interactively, if variable `browse-url-new-window-flag' is
 762 non-nil, load the document in a new window, if possible, otherwise use
 763 a random existing one.  A non-nil interactive prefix argument reverses
 764 the effect of `browse-url-new-window-flag'.
 765
 766 When called non-interactively, optional second argument NEW-WINDOW is
 767 used instead of `browse-url-new-window-flag'.
 768
 769 The order attempted is gnome-moz-remote, Mozilla, Galeon, Netscape,
 770 Mosaic, IXI Mosaic, Lynx in an xterm, MMM, Konqueror, and then W3."
 771   (apply
 772     (cond
 773      ((executable-find "gnome-moz-remote") 'browse-url-gnome-moz)
 774      ((executable-find browse-url-mozilla-program) 'browse-url-mozilla)
 775      ((executable-find browse-url-galeon-program) 'browse-url-galeon)
 776      ((executable-find browse-url-kde-program) 'browse-url-kde)
 777      ((executable-find browse-url-netscape-program) 'browse-url-netscape)
 778      ((executable-find browse-url-mosaic-program) 'browse-url-mosaic)
 779      ((executable-find "tellw3b") 'browse-url-iximosaic)
 780      ((executable-find browse-url-xterm-program) 'browse-url-lynx-xterm)
 781      ((executable-find "mmm") 'browse-url-mmm)
 782      (t 'browse-url-w3))
 783      url args))
 784
 785 ;;;###autoload
 786 (defun browse-url-netscape (url &optional new-window)
 787   "Ask the Netscape WWW browser to load URL.
 788 Default to the URL around or before point.  The strings in variable
 789 `browse-url-netscape-arguments' are also passed to Netscape.
 790
 791 When called interactively, if variable `browse-url-new-window-flag' is
 792 non-nil, load the document in a new Netscape window, otherwise use a
 793 random existing one.  A non-nil interactive prefix argument reverses
 794 the effect of `browse-url-new-window-flag'.
 795
 796 When called non-interactively, optional second argument NEW-WINDOW is
 797 used instead of `browse-url-new-window-flag'."
 798   (interactive (browse-url-interactive-arg "URL: "))
 799   ;; URL encode any `confusing' characters in the URL.  This needs to
 800   ;; include at least commas; presumably also close parens.
 801   (while (string-match "[,)]" url)
 802     (setq url (replace-match
 803                (format "%%%x" (string-to-char (match-string 0 url))) t t url)))
 804   (let* ((process-environment (browse-url-process-environment))
 805          (process (apply 'start-process
 806                          (concat "netscape " url) nil
 807                          browse-url-netscape-program
 808                          (append
 809                           browse-url-netscape-arguments
 810                           (if (eq window-system 'w32)
 811                               (list url)
 812                             (append
 813                              (if new-window '("-noraise"))
 814                              (list "-remote"
 815                                    (concat "openURL(" url
 816                                            (if (browse-url-maybe-new-window
 817                                                 new-window)
 818                                                ",new-window")
 819                                            ")"))))))))
 820     (set-process-sentinel process
 821                           `(lambda (process change)
 822                              (browse-url-netscape-sentinel process ,url)))))
 823
 824 (defun browse-url-netscape-sentinel (process url)
 825   "Handle a change to the process communicating with Netscape."
 826   (or (eq (process-exit-status process) 0)
 827       (let* ((process-environment (browse-url-process-environment)))
 828         ;; Netscape not running - start it
 829         (message "Starting Netscape...")
 830         (apply 'start-process (concat "netscape" url) nil
 831                browse-url-netscape-program
 832                (append browse-url-netscape-startup-arguments (list url))))))
 833
 834 (defun browse-url-netscape-reload ()
 835   "Ask Netscape to reload its current document.
 836 How depends on `browse-url-netscape-version'."
 837   (interactive)
 838   ;; Backwards incompatibility reported by
 839   ;; <peter.kruse@psychologie.uni-regensburg.de>.
 840   (browse-url-netscape-send (if (>= browse-url-netscape-version 4)
 841                                 "xfeDoCommand(reload)"
 842                                 "reload")))
 843
 844 (defun browse-url-netscape-send (command)
 845   "Send a remote control command to Netscape."
 846   (let* ((process-environment (browse-url-process-environment)))
 847     (apply 'start-process "netscape" nil
 848            browse-url-netscape-program
 849            (append browse-url-netscape-arguments
 850                    (list "-remote" command)))))
 851
 852 ;;;###autoload
 853 (defun browse-url-mozilla (url &optional new-window)
 854   "Ask the Mozilla WWW browser to load URL.
 855 Default to the URL around or before point.  The strings in variable
 856 `browse-url-mozilla-arguments' are also passed to Mozilla.
 857
 858 When called interactively, if variable `browse-url-new-window-flag' is
 859 non-nil, load the document in a new Mozilla window, otherwise use a
 860 random existing one.  A non-nil interactive prefix argument reverses
 861 the effect of `browse-url-new-window-flag'.
 862
 863 If `browse-url-mozilla-new-window-is-tab' is non-nil, then whenever a
 864 document would otherwise be loaded in a new window, it is loaded in a
 865 new tab in an existing window instead.
 866
 867 When called non-interactively, optional second argument NEW-WINDOW is
 868 used instead of `browse-url-new-window-flag'."
 869   (interactive (browse-url-interactive-arg "URL: "))
 870   ;; URL encode any `confusing' characters in the URL.  This needs to
 871   ;; include at least commas; presumably also close parens.
 872   (while (string-match "[,)]" url)
 873     (setq url (replace-match
 874                (format "%%%x" (string-to-char (match-string 0 url))) t t url)))
 875   (let* ((process-environment (browse-url-process-environment))
 876          (process
 877           (apply 'start-process
 878                  (concat "mozilla " url) nil
 879                  browse-url-mozilla-program
 880                  (append
 881                   browse-url-mozilla-arguments
 882                   (list "-remote"
 883                         (concat "openURL("
 884                                 url
 885                                 (if (browse-url-maybe-new-window
 886                                      new-window)
 887                                     (if browse-url-mozilla-new-window-is-tab
 888                                         ",new-tab")
 889                                   ",new-window")
 890                                 ")"))))))
 891     (set-process-sentinel process
 892                           `(lambda (process change)
 893                              (browse-url-mozilla-sentinel process ,url)))))
 894
 895 (defun browse-url-mozilla-sentinel (process url)
 896   "Handle a change to the process communicating with Mozilla."
 897   (or (eq (process-exit-status process) 0)
 898       (let* ((process-environment (browse-url-process-environment)))
 899         ;; Mozilla is not running - start it
 900         (message "Starting Mozilla...")
 901         (apply 'start-process (concat "mozilla " url) nil
 902                browse-url-mozilla-program
 903                (append browse-url-mozilla-startup-arguments (list url))))))
 904
 905 ;;;###autoload
 906 (defun browse-url-galeon (url &optional new-window)
 907   "Ask the Galeon WWW browser to load URL.
 908 Default to the URL around or before point.  The strings in variable
 909 `browse-url-galeon-arguments' are also passed to Galeon.
 910
 911 When called interactively, if variable `browse-url-new-window-flag' is
 912 non-nil, load the document in a new Galeon window, otherwise use a
 913 random existing one.  A non-nil interactive prefix argument reverses
 914 the effect of `browse-url-new-window-flag'.
 915
 916 If `browse-url-galeon-new-window-is-tab' is non-nil, then whenever a
 917 document would otherwise be loaded in a new window, it is loaded in a
 918 new tab in an existing window instead.
 919
 920 When called non-interactively, optional second argument NEW-WINDOW is
 921 used instead of `browse-url-new-window-flag'."
 922   (interactive (browse-url-interactive-arg "URL: "))
 923   ;; URL encode any `confusing' characters in the URL.  This needs to
 924   ;; include at least commas; presumably also close parens.
 925   (while (string-match "[,)]" url)
 926     (setq url (replace-match
 927                (format "%%%x" (string-to-char (match-string 0 url))) t t url)))
 928   (let* ((process-environment (browse-url-process-environment))
 929          (process (apply 'start-process
 930                          (concat "galeon " url) nil
 931                          browse-url-galeon-program
 932                          (append
 933                           browse-url-galeon-arguments
 934                           (if (browse-url-maybe-new-window new-window)
 935                               (if browse-url-galeon-new-window-is-tab
 936                                   '("--new-tab")
 937                                 '("--new-window" "--noraise"))
 938                             '("--existing"))
 939                           (list url)))))
 940     (set-process-sentinel process
 941                           `(lambda (process change)
 942                              (browse-url-galeon-sentinel process ,url)))))
 943
 944 (defun browse-url-galeon-sentinel (process url)
 945   "Handle a change to the process communicating with Galeon."
 946   (or (eq (process-exit-status process) 0)
 947       (let* ((process-environment (browse-url-process-environment)))
 948         ;; Galeon is not running - start it
 949         (message "Starting Galeon...")
 950         (apply 'start-process (concat "galeon " url) nil
 951                browse-url-galeon-program
 952                (append browse-url-galeon-startup-arguments (list url))))))
 953
 954 ;; GNOME means of invoking either Mozilla or Netrape.
 955
 956 (defcustom browse-url-gnome-moz-arguments '()
 957   "*A list of strings passed to the GNOME mozilla viewer as arguments."
 958   :version "21.1"
 959   :type '(repeat (string :tag "Argument"))
 960   :group 'browse-url)
 961
 962 ;;;###autoload
 963 (defun browse-url-gnome-moz (url &optional new-window)
 964   "Ask Mozilla/Netscape to load URL via the GNOME program `gnome-moz-remote'.
 965 Default to the URL around or before point.  The strings in variable
 966 `browse-url-gnome-moz-arguments' are also passed.
 967
 968 When called interactively, if variable `browse-url-new-window-flag' is
 969 non-nil, load the document in a new browser window, otherwise use an
 970 existing one.  A non-nil interactive prefix argument reverses the
 971 effect of `browse-url-new-window-flag'.
 972
 973 When called non-interactively, optional second argument NEW-WINDOW is
 974 used instead of `browse-url-new-window-flag'."
 975   (interactive (browse-url-interactive-arg "URL: "))
 976   (apply 'start-process (concat "gnome-moz-remote " url)
 977          nil
 978          "gnome-moz-remote"
 979          (append
 980           browse-url-gnome-moz-arguments
 981           (if (browse-url-maybe-new-window new-window)
 982             '("--newwin"))
 983           (list "--raise" url))))
 984
 985 ;; --- Mosaic ---
 986
 987 ;;;###autoload
 988 (defun browse-url-mosaic (url &optional new-window)
 989   "Ask the XMosaic WWW browser to load URL.
 990
 991 Default to the URL around or before point.  The strings in variable
 992 `browse-url-mosaic-arguments' are also passed to Mosaic and the
 993 program is invoked according to the variable
 994 `browse-url-mosaic-program'.
 995
 996 When called interactively, if variable `browse-url-new-window-flag' is
 997 non-nil, load the document in a new Mosaic window, otherwise use a
 998 random existing one.  A non-nil interactive prefix argument reverses
 999 the effect of `browse-url-new-window-flag'.
1000
1001 When called non-interactively, optional second argument NEW-WINDOW is
1002 used instead of `browse-url-new-window-flag'."
1003   (interactive (browse-url-interactive-arg "Mosaic URL: "))
1004   (let ((pidfile (expand-file-name browse-url-mosaic-pidfile))
1005         pid)
1006     (if (file-readable-p pidfile)
1007         (save-excursion
1008           (find-file pidfile)
1009           (goto-char (point-min))
1010           (setq pid (read (current-buffer)))
1011           (kill-buffer nil)))
1012     (if (and pid (zerop (signal-process pid 0))) ; Mosaic running
1013         (save-excursion
1014           (find-file (format "/tmp/Mosaic.%d" pid))
1015           (erase-buffer)
1016           (insert (if (browse-url-maybe-new-window new-window)
1017                       "newwin\n"
1018                     "goto\n")
1019                   url "\n")
1020           (save-buffer)
1021           (kill-buffer nil)
1022           ;; Send signal SIGUSR to Mosaic
1023           (message "Signalling Mosaic...")
1024           (signal-process pid browse-url-usr1-signal)
1025           ;; Or you could try:
1026           ;; (call-process "kill" nil 0 nil "-USR1" (int-to-string pid))
1027           (message "Signalling Mosaic...done")
1028           )
1029       ;; Mosaic not running - start it
1030       (message "Starting Mosaic...")
1031       (apply 'start-process "xmosaic" nil browse-url-mosaic-program
1032              (append browse-url-mosaic-arguments (list url)))
1033       (message "Starting Mosaic...done"))))
1034
1035 ;; --- Grail ---
1036
1037 ;;;###autoload
1038 (defvar browse-url-grail
1039   (concat (or (getenv "GRAILDIR") "~/.grail") "/user/rcgrail.py")
1040   "Location of Grail remote control client script `rcgrail.py'.
1041 Typically found in $GRAILDIR/rcgrail.py, or ~/.grail/user/rcgrail.py.")
1042
1043 ;;;###autoload
1044 (defun browse-url-grail (url &optional new-window)
1045   "Ask the Grail WWW browser to load URL.
1046 Default to the URL around or before point.  Runs the program in the
1047 variable `browse-url-grail'."
1048   (interactive (browse-url-interactive-arg "Grail URL: "))
1049   (message "Sending URL to Grail...")
1050   (save-excursion
1051     (set-buffer (get-buffer-create " *Shell Command Output*"))
1052     (erase-buffer)
1053     ;; don't worry about this failing.
1054     (if (browse-url-maybe-new-window new-window)
1055         (call-process browse-url-grail nil 0 nil "-b" url)
1056       (call-process browse-url-grail nil 0 nil url))
1057     (message "Sending URL to Grail... done")))
1058
1059 ;; --- Mosaic using CCI ---
1060
1061 ;;;###autoload
1062 (defun browse-url-cci (url &optional new-window)
1063   "Ask the XMosaic WWW browser to load URL.
1064 Default to the URL around or before point.
1065
1066 This function only works for XMosaic version 2.5 or later.  You must
1067 select `CCI' from XMosaic's File menu, set the CCI Port Address to the
1068 value of variable `browse-url-CCI-port', and enable `Accept requests'.
1069
1070 When called interactively, if variable `browse-url-new-window-flag' is
1071 non-nil, load the document in a new browser window, otherwise use a
1072 random existing one.  A non-nil interactive prefix argument reverses
1073 the effect of `browse-url-new-window-flag'.
1074
1075 When called non-interactively, optional second argument NEW-WINDOW is
1076 used instead of `browse-url-new-window-flag'."
1077   (interactive (browse-url-interactive-arg "Mosaic URL: "))
1078   (open-network-stream "browse-url" " *browse-url*"
1079                        browse-url-CCI-host browse-url-CCI-port)
1080   ;; Todo: start browser if fails
1081   (process-send-string "browse-url"
1082                        (concat "get url (" url ") output "
1083                                (if (browse-url-maybe-new-window new-window)
1084                                    "new"
1085                                  "current")
1086                                "\r\n"))
1087   (process-send-string "browse-url" "disconnect\r\n")
1088   (delete-process "browse-url"))
1089
1090 ;; --- IXI Mosaic ---
1091
1092 ;;;###autoload
1093 (defun browse-url-iximosaic (url &optional new-window)
1094   ;; new-window ignored
1095   "Ask the IXIMosaic WWW browser to load URL.
1096 Default to the URL around or before point."
1097   (interactive (browse-url-interactive-arg "IXI Mosaic URL: "))
1098   (start-process "tellw3b" nil "tellw3b"
1099                  "-service WWW_BROWSER ixi_showurl " url))
1100
1101 ;; --- W3 ---
1102
1103 ;;;###autoload
1104 (defun browse-url-w3 (url &optional new-window)
1105   "Ask the w3 WWW browser to load URL.
1106 Default to the URL around or before point.
1107
1108 When called interactively, if variable `browse-url-new-window-flag' is
1109 non-nil, load the document in a new window.  A non-nil interactive
1110 prefix argument reverses the effect of `browse-url-new-window-flag'.
1111
1112 When called non-interactively, optional second argument NEW-WINDOW is
1113 used instead of `browse-url-new-window-flag'."
1114   (interactive (browse-url-interactive-arg "W3 URL: "))
1115   (require 'w3)                         ; w3-fetch-other-window not autoloaded
1116   (if (browse-url-maybe-new-window new-window)
1117       (w3-fetch-other-window url)
1118     (w3-fetch url)))
1119
1120 ;;;###autoload
1121 (defun browse-url-w3-gnudoit (url &optional new-window)
1122   ;; new-window ignored
1123   "Ask another Emacs running gnuserv to load the URL using the W3 browser.
1124 The `browse-url-gnudoit-program' program is used with options given by
1125 `browse-url-gnudoit-args'.  Default to the URL around or before point."
1126   (interactive (browse-url-interactive-arg "W3 URL: "))
1127     (apply 'start-process (concat "gnudoit:" url) nil
1128            browse-url-gnudoit-program
1129            (append browse-url-gnudoit-args
1130                    (list (concat "(w3-fetch \"" url "\")")
1131                          "(raise-frame)"))))
1132
1133 ;; --- Lynx in an xterm ---
1134
1135 ;;;###autoload
1136 (defun browse-url-lynx-xterm (url &optional new-window)
1137   ;; new-window ignored
1138   "Ask the Lynx WWW browser to load URL.
1139 Default to the URL around or before point.  A new Lynx process is run
1140 in an Xterm window using the Xterm program named by `browse-url-xterm-program'
1141 with possible additional arguments `browse-url-xterm-args'."
1142   (interactive (browse-url-interactive-arg "Lynx URL: "))
1143   (apply #'start-process `(,(concat "lynx" url) nil ,browse-url-xterm-program
1144              ,@browse-url-xterm-args "-e" "lynx"
1145              ,url)))
1146
1147 ;; --- Lynx in an Emacs "term" window ---
1148
1149 ;;;###autoload
1150 (defun browse-url-lynx-emacs (url &optional new-buffer)
1151   "Ask the Lynx WWW browser to load URL.
1152 Default to the URL around or before point.  With a prefix argument, run
1153 a new Lynx process in a new buffer.
1154
1155 When called interactively, if variable `browse-url-new-window-flag' is
1156 non-nil, load the document in a new lynx in a new term window,
1157 otherwise use any existing one.  A non-nil interactive prefix argument
1158 reverses the effect of `browse-url-new-window-flag'.
1159
1160 When called non-interactively, optional second argument NEW-WINDOW is
1161 used instead of `browse-url-new-window-flag'."
1162   (interactive (browse-url-interactive-arg "Lynx URL: "))
1163   (let* ((system-uses-terminfo t)       ; Lynx uses terminfo
1164          ;; (term-term-name "vt100") ; ??
1165          (buf (get-buffer "*lynx*"))
1166          (proc (and buf (get-buffer-process buf)))
1167          (n browse-url-lynx-input-attempts))
1168     (if (and (browse-url-maybe-new-window new-buffer) buf)
1169         ;; Rename away the OLD buffer. This isn't very polite, but
1170         ;; term insists on working in a buffer named *lynx* and would
1171         ;; choke on *lynx*<1>
1172         (progn (set-buffer buf)
1173                (rename-uniquely)))
1174     (if (or (browse-url-maybe-new-window new-buffer)
1175             (not buf)
1176             (not proc)
1177             (not (memq (process-status proc) '(run stop))))
1178         ;; start a new lynx
1179         (progn
1180           (setq buf
1181                 (apply #'make-term
1182                        `("lynx" "lynx" nil ,@browse-url-lynx-emacs-args
1183                          ,url)))
1184           (switch-to-buffer buf)
1185           (term-char-mode)
1186           (set-process-sentinel
1187            (get-buffer-process buf)
1188            ;; Don't leave around a dead one (especially because of its
1189            ;; munged keymap.)
1190            (lambda (process event)
1191              (if (not (memq (process-status process) '(run stop)))
1192                  (let ((buf (process-buffer process)))
1193                    (if buf (kill-buffer buf)))))))
1194       ;; send the url to lynx in the old buffer
1195       (let ((win (get-buffer-window buf t)))
1196         (if win
1197             (select-window win)
1198           (switch-to-buffer buf)))
1199       (if (eq (following-char) ?_)
1200           (cond ((eq browse-url-lynx-input-field 'warn)
1201                  (error "Please move out of the input field first"))
1202                 ((eq browse-url-lynx-input-field 'avoid)
1203                  (while (and (eq (following-char) ?_) (> n 0))
1204                    (term-send-down) ; down arrow
1205                    (sit-for browse-url-lynx-input-delay))
1206                  (if (eq (following-char) ?_)
1207                      (error "Cannot move out of the input field, sorry")))))
1208       (term-send-string proc (concat "g" ; goto
1209                                      "\C-u" ; kill default url
1210                                      url
1211                                      "\r")))))
1212
1213 ;; --- MMM ---
1214
1215 ;;;###autoload
1216 (defun browse-url-mmm (url &optional new-window)
1217   "Ask the MMM WWW browser to load URL.
1218 Default to the URL around or before point."
1219   (interactive (browse-url-interactive-arg "MMM URL: "))
1220   (message "Sending URL to MMM...")
1221   (save-excursion
1222     (set-buffer (get-buffer-create " *Shell Command Output*"))
1223     (erase-buffer)
1224     ;; mmm_remote just SEGVs if the file isn't there...
1225     (if (or (file-exists-p (expand-file-name "~/.mmm_remote"))
1226             ;; location in v 0.4:
1227             (file-exists-p (expand-file-name "~/.mmm/remote")))
1228         (call-process "mmm_remote" nil 0 nil url)
1229       (call-process "mmm" nil 0 nil "-external" url))
1230     (message "Sending URL to MMM... done")))
1231
1232 ;; --- mailto ---
1233
1234 ;;;###autoload
1235 (defun browse-url-mail (url &optional new-window)
1236   "Open a new mail message buffer within Emacs.
1237 Default to using the mailto: URL around or before point as the
1238 recipient's address.  Supplying a non-nil interactive prefix argument
1239 will cause the mail to be composed in another window rather than the
1240 current one.
1241
1242 When called interactively, if variable `browse-url-new-window-flag' is
1243 non-nil use `compose-mail-other-window', otherwise `compose-mail'.  A
1244 non-nil interactive prefix argument reverses the effect of
1245 `browse-url-new-window-flag'.
1246
1247 When called non-interactively, optional second argument NEW-WINDOW is
1248 used instead of `browse-url-new-window-flag'."
1249   (interactive (browse-url-interactive-arg "Mailto URL: "))
1250   (save-excursion
1251     (let ((to (if (string-match "^mailto:" url)
1252                   (substring url 7)
1253                 url)))
1254       (if (browse-url-maybe-new-window new-window)
1255           (compose-mail-other-window to nil nil nil
1256                                      (list 'insert-buffer (current-buffer)))
1257         (compose-mail to nil nil nil nil
1258                       (list 'insert-buffer (current-buffer)))))))
1259
1260 ;; --- Random browser ---
1261
1262 ;;;###autoload
1263 (defun browse-url-generic (url &optional new-window)
1264   ;; new-window ignored
1265   "Ask the WWW browser defined by `browse-url-generic-program' to load URL.
1266 Default to the URL around or before point.  A fresh copy of the
1267 browser is started up in a new process with possible additional arguments
1268 `browse-url-generic-args'.  This is appropriate for browsers which
1269 don't offer a form of remote control."
1270   (interactive (browse-url-interactive-arg "URL: "))
1271   (if (not browse-url-generic-program)
1272     (error "No browser defined (`browse-url-generic-program')"))
1273   (apply 'start-process (concat browse-url-generic-program url) nil
1274          browse-url-generic-program
1275          (append browse-url-generic-args (list url))))
1276
1277 ;;;###autoload
1278 (defun browse-url-kde (url &optional new-window)
1279   "Ask the KDE WWW browser to load URL.
1280 Default to the URL around or before point."
1281   (interactive (browse-url-interactive-arg "KDE URL: "))
1282   (message "Sending URL to KDE...")
1283   (apply #'start-process `(,(concat "KDE" url) nil ,browse-url-kde-program
1284                            ,@browse-url-kde-args ,url)))
1285
1286 (provide 'browse-url)
1287
1288 ;;; browse-url.el ends here