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, 2005
   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-epiphany                Epiphany    Don't know
  43 ;; browse-url-netscape                Netscape    1.1b1
  44 ;; browse-url-mosaic                  XMosaic/mMosaic <= 2.4
  45 ;; browse-url-cci                     XMosaic     2.5
  46 ;; browse-url-w3                      w3          0
  47 ;; browse-url-w3-gnudoit              w3 remotely
  48 ;; browse-url-iximosaic               IXI Mosaic  ?
  49 ;; browse-url-lynx-*                  Lynx           0
  50 ;; browse-url-grail                   Grail       0.3b1
  51 ;; browse-url-mmm                     MMM         ?
  52 ;; browse-url-generic                 arbitrary
  53 ;; browse-url-default-windows-browser MS-Windows browser
  54 ;; browse-url-default-macosx-browser  Mac OS X browser
  55 ;; browse-url-gnome-moz               GNOME interface to Mozilla
  56 ;; browse-url-kde                     KDE konqueror (kfm)
  57
  58 ;; [A version of the Netscape browser is now free software
  59 ;; <URL:http://www.mozilla.org/>, albeit not GPLed, so it is
  60 ;; reasonable to have that as the default.]
  61
  62 ;; Note that versions of Netscape before 1.1b1 did not have remote
  63 ;; control.  <URL:http://www.netscape.com/newsref/std/x-remote.html>.
  64
  65 ;; Browsers can cache Web pages so it may be necessary to tell them to
  66 ;; reload the current page if it has changed (e.g. if you have edited
  67 ;; it).  There is currently no perfect automatic solution to this.
  68
  69 ;; Netscape allows you to specify the id of the window you want to
  70 ;; control but which window DO you want to control and how do you
  71 ;; discover its id?
  72
  73 ;; William M. Perry's excellent "w3" WWW browser for
  74 ;; Emacs <URL:ftp://cs.indiana.edu/pub/elisp/w3/>
  75 ;; has a function w3-follow-url-at-point, but that
  76 ;; doesn't let you edit the URL like browse-url.
  77 ;; The `gnuserv' package that can be used to control it in another
  78 ;; Emacs process is available from
  79 ;; <URL:ftp://ftp.splode.com/pub/users/friedman/packages/>.
  80
  81 ;; Grail is the freely available WWW browser implemented in Python, a
  82 ;; cool object-oriented freely available interpreted language.  Grail
  83 ;; 0.3b1 was the first version to have remote control as distributed.
  84 ;; For more information on Grail see
  85 ;; <URL:http://grail.cnri.reston.va.us/> and for more information on
  86 ;; Python see <url:http://www.python.org/>.  Grail support in
  87 ;; browse-url.el written by Barry Warsaw <bwarsaw@python.org>.
  88
  89 ;; Lynx is now distributed by the FSF.  See also
  90 ;; <URL:http://lynx.browser.org/>.
  91
  92 ;; Free graphical browsers that could be used by `browse-url-generic'
  93 ;; include Chimera <URL:ftp://ftp.cs.unlv.edu/pub/chimera> and
  94 ;; <URL:http://www.unlv.edu/chimera/>, Arena
  95 ;; <URL:ftp://ftp.yggdrasil.com/pub/dist/web/arena> and Amaya
  96 ;; <URL:ftp://ftp.w3.org/pub/amaya>.  mMosaic
  97 ;; <URL:ftp://ftp.enst.fr/pub/mbone/mMosaic/>,
  98 ;; <URL:http://www.enst.fr/~dauphin/mMosaic/> (with development
  99 ;; support for Java applets and multicast) can be used like Mosaic by
 100 ;; setting `browse-url-mosaic-program' appropriately.
 101
 102 ;; I [Denis Howe, not Dave Love] recommend Nelson Minar
 103 ;; <nelson@santafe.edu>'s excellent html-helper-mode.el for editing
 104 ;; HTML and thank Nelson for his many useful comments on this code.
 105 ;; <URL:http://www.santafe.edu/%7Enelson/hhm-beta/>
 106
 107 ;; See also hm--html-menus <URL:http://www.tnt.uni-hannover.de/%7Emuenkel/
 108 ;; software/own/hm--html-menus/>.  For composing correct HTML see also
 109 ;; PSGML the general SGML structure editor package
 110 ;; <URL:ftp://ftp.lysator.liu.se/pub/sgml>; hm--html-menus can be used
 111 ;; with this.
 112
 113 ;; This package generalises function html-previewer-process in Marc
 114 ;; Andreessen's html-mode (LCD modes/html-mode.el.Z).  See also the
 115 ;; ffap.el package.  The huge hyperbole package also contains similar
 116 ;; functions.
 117
 118 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 119 ;; Help!
 120
 121 ;; Can you write and test some code for the Macintrash and Windoze
 122 ;; Netscape remote control APIs?  (See the URL above).
 123
 124 ;; Do any other browsers have remote control?
 125
 126 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 127 ;; Usage
 128
 129 ;; To display the URL at or before point:
 130 ;; M-x browse-url-at-point RET
 131 ;; or, similarly but with the opportunity to edit the URL extracted from
 132 ;; the buffer, use:
 133 ;; M-x browse-url
 134
 135 ;; To display a URL by shift-clicking on it, put this in your ~/.emacs
 136 ;; file:
 137 ;;      (global-set-key [S-mouse-2] 'browse-url-at-mouse)
 138 ;; (Note that using Shift-mouse-1 is not desirable because
 139 ;; that event has a standard meaning in Emacs.)
 140
 141 ;; To display the current buffer in a web browser:
 142 ;; M-x browse-url-of-buffer RET
 143
 144 ;; To display the current region in a web browser:
 145 ;; M-x browse-url-of-region RET
 146
 147 ;; In Dired, to display the file named on the current line:
 148 ;; M-x browse-url-of-dired-file RET
 149
 150 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 151 ;; Customisation (~/.emacs)
 152
 153 ;; To see what variables are available for customization, type
 154 ;; `M-x set-variable browse-url TAB'.  Better, use
 155 ;; `M-x customize-group browse-url'.
 156
 157 ;; Bind the browse-url commands to keys with the `C-c C-z' prefix
 158 ;; (as used by html-helper-mode):
 159 ;;      (global-set-key "\C-c\C-z." 'browse-url-at-point)
 160 ;;      (global-set-key "\C-c\C-zb" 'browse-url-of-buffer)
 161 ;;      (global-set-key "\C-c\C-zr" 'browse-url-of-region)
 162 ;;      (global-set-key "\C-c\C-zu" 'browse-url)
 163 ;;      (global-set-key "\C-c\C-zv" 'browse-url-of-file)
 164 ;;      (add-hook 'dired-mode-hook
 165 ;;                (lambda ()
 166 ;;                   (local-set-key "\C-c\C-zf" 'browse-url-of-dired-file)))
 167
 168 ;; Browse URLs in mail messages under RMAIL by clicking mouse-2:
 169 ;;      (add-hook 'rmail-mode-hook (lambda () ; rmail-mode startup
 170 ;;        (define-key rmail-mode-map [mouse-2] 'browse-url-at-mouse)))
 171 ;; Alternatively, add `goto-address' to `rmail-show-message-hook'.
 172
 173 ;; Gnus provides a standard feature to activate URLs in article
 174 ;; buffers for invocation of browse-url.
 175
 176 ;; Use the Emacs w3 browser when not running under X11:
 177 ;;      (or (eq window-system 'x)
 178 ;;          (setq browse-url-browser-function 'browse-url-w3))
 179
 180 ;; To always save modified buffers before displaying the file in a browser:
 181 ;;      (setq browse-url-save-file t)
 182
 183 ;; To get round the Netscape caching problem, you could EITHER have
 184 ;; write-file in html-helper-mode make Netscape reload the document:
 185 ;;
 186 ;;      (autoload 'browse-url-netscape-reload "browse-url"
 187 ;;        "Ask a WWW browser to redisplay the current file." t)
 188 ;;      (add-hook 'html-helper-mode-hook
 189 ;;                (lambda ()
 190 ;;                   (add-hook 'local-write-file-hooks
 191 ;;                             (lambda ()
 192 ;;                                (let ((local-write-file-hooks))
 193 ;;                                  (save-buffer))
 194 ;;                                (browse-url-netscape-reload)
 195 ;;                                t)                    ; => file written by hook
 196 ;;                             t)))                     ; append to l-w-f-hooks
 197 ;;
 198 ;; OR have browse-url-of-file ask Netscape to load and then reload the
 199 ;; file:
 200 ;;
 201 ;;      (add-hook 'browse-url-of-file-hook 'browse-url-netscape-reload)
 202
 203 ;; You may also want to customise browse-url-netscape-arguments, e.g.
 204 ;;      (setq browse-url-netscape-arguments '("-install"))
 205 ;;
 206 ;; or similarly for the other browsers.
 207
 208 ;; To invoke different browsers for different URLs:
 209 ;;      (setq browse-url-browser-function '(("^mailto:" . browse-url-mail)
 210 ;;                                          ("." . browse-url-netscape)))
 211
 212 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 213 ;;; Code:
 214
 215 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 216 ;; Variables
 217
 218 (eval-when-compile (require 'thingatpt)
 219                    (require 'term)
 220                    (require 'dired)
 221                    (require 'executable)
 222                    (require 'w3-auto nil t))
 223
 224 (defgroup browse-url nil
 225   "Use a web browser to look at a URL."
 226   :prefix "browse-url-"
 227   :link '(emacs-commentary-link "browse-url")
 228   :group 'hypermedia)
 229
 230 ;;;###autoload
 231 (defcustom browse-url-browser-function
 232   (cond
 233    ((memq system-type '(windows-nt ms-dos cygwin))
 234     'browse-url-default-windows-browser)
 235    ((memq system-type '(darwin)) 'browse-url-default-macosx-browser)
 236    (t 'browse-url-default-browser))
 237   "*Function to display the current buffer in a WWW browser.
 238 This is used by the `browse-url-at-point', `browse-url-at-mouse', and
 239 `browse-url-of-file' commands.
 240
 241 If the value is not a function it should be a list of pairs
 242 \(REGEXP . FUNCTION).  In this case the function called will be the one
 243 associated with the first REGEXP which matches the current URL.  The
 244 function is passed the URL and any other args of `browse-url'.  The last
 245 regexp should probably be \".\" to specify a default browser."
 246   :type '(choice
 247           (function-item :tag "Emacs W3" :value  browse-url-w3)
 248           (function-item :tag "W3 in another Emacs via `gnudoit'"
 249                          :value  browse-url-w3-gnudoit)
 250           (function-item :tag "Mozilla" :value  browse-url-mozilla)
 251           (function-item :tag "Galeon" :value  browse-url-galeon)
 252           (function-item :tag "Epiphany" :value  browse-url-epiphany)
 253           (function-item :tag "Netscape" :value  browse-url-netscape)
 254           (function-item :tag "Mosaic" :value  browse-url-mosaic)
 255           (function-item :tag "Mosaic using CCI" :value  browse-url-cci)
 256           (function-item :tag "IXI Mosaic" :value  browse-url-iximosaic)
 257           (function-item :tag "Lynx in an xterm window"
 258                          :value browse-url-lynx-xterm)
 259           (function-item :tag "Lynx in an Emacs window"
 260                          :value browse-url-lynx-emacs)
 261           (function-item :tag "Grail" :value  browse-url-grail)
 262           (function-item :tag "MMM" :value  browse-url-mmm)
 263           (function-item :tag "KDE" :value browse-url-kde)
 264           (function-item :tag "Specified by `Browse Url Generic Program'"
 265                          :value browse-url-generic)
 266           (function-item :tag "Default Windows browser"
 267                          :value browse-url-default-windows-browser)
 268           (function-item :tag "Default Mac OS X browser"
 269                          :value browse-url-default-macosx-browser)
 270           (function-item :tag "GNOME invoking Mozilla"
 271                          :value browse-url-gnome-moz)
 272           (function-item :tag "Default browser"
 273                          :value browse-url-default-browser)
 274           (function :tag "Your own function")
 275           (alist :tag "Regexp/function association list"
 276                  :key-type regexp :value-type function))
 277   :version "21.1"
 278   :group 'browse-url)
 279
 280 (defcustom browse-url-netscape-program "netscape"
 281   ;; Info about netscape-remote from Karl Berry.
 282   "*The name by which to invoke Netscape.
 283
 284 The free program `netscape-remote' from
 285 <URL:http://home.netscape.com/newsref/std/remote.c> is said to start
 286 up very much quicker than `netscape'.  Reported to compile on a GNU
 287 system, given vroot.h from the same directory, with cc flags
 288  -DSTANDALONE -L/usr/X11R6/lib -lXmu -lX11."
 289   :type 'string
 290   :group 'browse-url)
 291
 292 (defcustom browse-url-netscape-arguments nil
 293   "*A list of strings to pass to Netscape as arguments."
 294   :type '(repeat (string :tag "Argument"))
 295   :group 'browse-url)
 296
 297 (defcustom browse-url-netscape-startup-arguments browse-url-netscape-arguments
 298   "*A list of strings to pass to Netscape when it starts up.
 299 Defaults to the value of `browse-url-netscape-arguments' at the time
 300 `browse-url' is loaded."
 301   :type '(repeat (string :tag "Argument"))
 302   :group 'browse-url)
 303
 304 (defcustom browse-url-browser-display nil
 305   "*The X display for running the browser, if not same as Emacs'."
 306   :type '(choice string (const :tag "Default" nil))
 307   :group 'browse-url)
 308
 309 (defcustom browse-url-mozilla-program "mozilla"
 310   "*The name by which to invoke Mozilla."
 311   :type 'string
 312   :group 'browse-url)
 313
 314 (defcustom browse-url-mozilla-arguments nil
 315   "*A list of strings to pass to Mozilla as arguments."
 316   :type '(repeat (string :tag "Argument"))
 317   :group 'browse-url)
 318
 319 (defcustom browse-url-mozilla-startup-arguments browse-url-mozilla-arguments
 320   "*A list of strings to pass to Mozilla when it starts up.
 321 Defaults to the value of `browse-url-mozilla-arguments' at the time
 322 `browse-url' is loaded."
 323   :type '(repeat (string :tag "Argument"))
 324   :group 'browse-url)
 325
 326 (defcustom browse-url-galeon-program "galeon"
 327   "*The name by which to invoke Galeon."
 328   :type 'string
 329   :group 'browse-url)
 330
 331 (defcustom browse-url-galeon-arguments nil
 332   "*A list of strings to pass to Galeon as arguments."
 333   :type '(repeat (string :tag "Argument"))
 334   :group 'browse-url)
 335
 336 (defcustom browse-url-galeon-startup-arguments browse-url-galeon-arguments
 337   "*A list of strings to pass to Galeon when it starts up.
 338 Defaults to the value of `browse-url-galeon-arguments' at the time
 339 `browse-url' is loaded."
 340   :type '(repeat (string :tag "Argument"))
 341   :group 'browse-url)
 342
 343 (defcustom browse-url-epiphany-program "epiphany"
 344   "*The name by which to invoke Epiphany."
 345   :type 'string
 346   :group 'browse-url)
 347
 348 (defcustom browse-url-epiphany-arguments nil
 349   "*A list of strings to pass to Epiphany as arguments."
 350   :type '(repeat (string :tag "Argument"))
 351   :group 'browse-url)
 352
 353 (defcustom browse-url-epiphany-startup-arguments browse-url-epiphany-arguments
 354   "*A list of strings to pass to Epiphany when it starts up.
 355 Defaults to the value of `browse-url-epiphany-arguments' at the time
 356 `browse-url' is loaded."
 357   :type '(repeat (string :tag "Argument"))
 358   :group 'browse-url)
 359
 360 ;; GNOME means of invoking either Mozilla or Netrape.
 361 (defvar browse-url-gnome-moz-program "gnome-moz-remote")
 362
 363 (defcustom browse-url-gnome-moz-arguments '()
 364   "*A list of strings passed to the GNOME mozilla viewer as arguments."
 365   :version "21.1"
 366   :type '(repeat (string :tag "Argument"))
 367   :group 'browse-url)
 368
 369 (defcustom browse-url-mozilla-new-window-is-tab nil
 370   "*Whether to open up new windows in a tab or a new window.
 371 If non-nil, then open the URL in a new tab rather than a new window if
 372 `browse-url-mozilla' is asked to open it in a new window."
 373   :type 'boolean
 374   :group 'browse-url)
 375
 376 (defcustom browse-url-galeon-new-window-is-tab nil
 377   "*Whether to open up new windows in a tab or a new window.
 378 If non-nil, then open the URL in a new tab rather than a new window if
 379 `browse-url-galeon' is asked to open it in a new window."
 380   :type 'boolean
 381   :group 'browse-url)
 382
 383 (defcustom browse-url-epiphany-new-window-is-tab nil
 384   "*Whether to open up new windows in a tab or a new window.
 385 If non-nil, then open the URL in a new tab rather than a new window if
 386 `browse-url-epiphany' is asked to open it in a new window."
 387   :type 'boolean
 388   :group 'browse-url)
 389
 390 (defcustom browse-url-netscape-new-window-is-tab nil
 391   "*Whether to open up new windows in a tab or a new window.
 392 If non-nil, then open the URL in a new tab rather than a new
 393 window if `browse-url-netscape' is asked to open it in a new
 394 window."
 395   :type 'boolean
 396   :group 'browse-url)
 397
 398 (defcustom browse-url-new-window-flag nil
 399   "*If non-nil, always open a new browser window with appropriate browsers.
 400 Passing an interactive argument to \\[browse-url], or specific browser
 401 commands reverses the effect of this variable.  Requires Netscape version
 402 1.1N or later or XMosaic version 2.5 or later if using those browsers."
 403   :type 'boolean
 404   :group 'browse-url)
 405
 406 (defcustom browse-url-mosaic-program "xmosaic"
 407   "*The name by which to invoke Mosaic (or mMosaic)."
 408   :type 'string
 409   :version "20.3"
 410   :group 'browse-url)
 411
 412 (defcustom browse-url-mosaic-arguments nil
 413   "*A list of strings to pass to Mosaic as arguments."
 414   :type '(repeat (string :tag "Argument"))
 415   :group 'browse-url)
 416
 417 (defcustom browse-url-mosaic-pidfile "~/.mosaicpid"
 418   "*The name of the pidfile created by Mosaic."
 419   :type 'string
 420   :group 'browse-url)
 421
 422 (defcustom browse-url-filename-alist
 423   (\`                                   ; Backquote syntax won't work.
 424    (("^/\\(ftp@\\|anonymous@\\)?\\([^:]+\\):/*" . "ftp://\\2/")
 425     ;; The above loses the username to avoid the browser prompting for
 426     ;; it in anonymous cases.  If it's not anonymous the next regexp
 427     ;; applies.
 428     ("^/\\([^:@]+@\\)?\\([^:]+\\):/*" . "ftp://\\1\\2/")
 429     (,@ (if (memq system-type '(windows-nt ms-dos cygwin))
 430             '(("^\\([a-zA-Z]:\\)[\\/]" . "file:\\1/")
 431               ("^[\\/][\\/]+" . "file://"))))
 432     ("^/+" . "file:/")))
 433   "*An alist of (REGEXP . STRING) pairs used by `browse-url-of-file'.
 434 Any substring of a filename matching one of the REGEXPs is replaced by
 435 the corresponding STRING using `replace-match', not treating STRING
 436 literally.  All pairs are applied in the order given.  The default
 437 value converts ange-ftp/EFS-style file names into ftp URLs and prepends
 438 `file:' to any file name beginning with `/'.
 439
 440 For example, adding to the default a specific translation of an ange-ftp
 441 address to an HTTP URL:
 442
 443     (setq browse-url-filename-alist
 444           '((\"/webmaster@webserver:/home/www/html/\" .
 445              \"http://www.acme.co.uk/\")
 446             (\"^/\\(ftp@\\|anonymous@\\)?\\([^:]+\\):/*\" . \"ftp://\\2/\")
 447             (\"^/\\([^:@]+@\\)?\\([^:]+\\):/*\" . \"ftp://\\1\\2/\")
 448             (\"^/+\" . \"file:/\")))
 449 "
 450   :type '(repeat (cons :format "%v"
 451                        (regexp :tag "Regexp")
 452                        (string :tag "Replacement")))
 453   :version "20.3"
 454   :group 'browse-url)
 455
 456 (defcustom browse-url-save-file nil
 457   "*If non-nil, save the buffer before displaying its file.
 458 Used by the `browse-url-of-file' command."
 459   :type 'boolean
 460   :group 'browse-url)
 461
 462 (defcustom browse-url-of-file-hook nil
 463   "*Run after `browse-url-of-file' has asked a browser to load a file.
 464
 465 Set this to `browse-url-netscape-reload' to force Netscape to load the
 466 file rather than displaying a cached copy."
 467   :type 'hook
 468   :options '(browse-url-netscape-reload)
 469   :group 'browse-url)
 470
 471 (defcustom browse-url-CCI-port 3003
 472   "*Port to access XMosaic via CCI.
 473 This can be any number between 1024 and 65535 but must correspond to
 474 the value set in the browser."
 475   :type 'integer
 476   :group 'browse-url)
 477
 478 (defcustom browse-url-CCI-host "localhost"
 479   "*Host to access XMosaic via CCI.
 480 This should be the host name of the machine running XMosaic with CCI
 481 enabled.  The port number should be set in `browse-url-CCI-port'."
 482   :type 'string
 483   :group 'browse-url)
 484
 485 (defvar browse-url-temp-file-name nil)
 486 (make-variable-buffer-local 'browse-url-temp-file-name)
 487
 488 (defcustom browse-url-xterm-program "xterm"
 489   "*The name of the terminal emulator used by `browse-url-lynx-xterm'.
 490 This might, for instance, be a separate colour version of xterm."
 491   :type 'string
 492   :group 'browse-url)
 493
 494 (defcustom browse-url-xterm-args nil
 495   "*A list of strings defining options for `browse-url-xterm-program'.
 496 These might set its size, for instance."
 497   :type '(repeat (string :tag "Argument"))
 498   :group 'browse-url)
 499
 500 (defcustom browse-url-lynx-emacs-args (and (not window-system)
 501                                            '("-show_cursor"))
 502   "*A list of strings defining options for Lynx in an Emacs buffer.
 503
 504 The default is none in a window system, otherwise `-show_cursor' to
 505 indicate the position of the current link in the absence of
 506 highlighting, assuming the normal default for showing the cursor."
 507   :type '(repeat (string :tag "Argument"))
 508   :version "20.3"
 509   :group 'browse-url)
 510
 511 (defcustom browse-url-gnudoit-program "gnudoit"
 512   "*The name of the `gnudoit' program used by `browse-url-w3-gnudoit'."
 513   :type 'string
 514   :group 'browse-url)
 515
 516 (defcustom browse-url-gnudoit-args '("-q")
 517   "*A list of strings defining options for `browse-url-gnudoit-program'.
 518 These might set the port, for instance."
 519   :type '(repeat (string :tag "Argument"))
 520   :group 'browse-url)
 521
 522 (defcustom browse-url-generic-program nil
 523   "*The name of the browser program used by `browse-url-generic'."
 524   :type '(choice string (const :tag "None" nil))
 525   :group 'browse-url)
 526
 527 (defcustom browse-url-generic-args nil
 528   "*A list of strings defining options for `browse-url-generic-program'."
 529   :type '(repeat (string :tag "Argument"))
 530   :group 'browse-url)
 531
 532 (defcustom browse-url-temp-dir temporary-file-directory
 533   "*The name of a directory for browse-url's temporary files.
 534 Such files are generated by functions like `browse-url-of-region'.
 535 You might want to set this to somewhere with restricted read permissions
 536 for privacy's sake."
 537   :type 'string
 538   :group 'browse-url)
 539
 540 (defcustom browse-url-netscape-version
 541   3
 542   "*The version of Netscape you are using.
 543 This affects how URL reloading is done; the mechanism changed
 544 incompatibly at version 4."
 545   :type 'number
 546   :group 'browse-url)
 547
 548 (defcustom browse-url-lynx-input-field 'avoid
 549   "*Action on selecting an existing Lynx buffer at an input field.
 550 What to do when sending a new URL to an existing Lynx buffer in Emacs
 551 if the Lynx cursor is on an input field (in which case the `g' command
 552 would be entered as data).  Such fields are recognized by the
 553 underlines ____.  Allowed values: nil: disregard it, 'warn: warn the
 554 user and don't emit the URL, 'avoid: try to avoid the field by moving
 555 down (this *won't* always work)."
 556   :type '(choice (const :tag "Move to try to avoid field" :value avoid)
 557                  (const :tag "Disregard" :value nil)
 558                  (const :tag "Warn, don't emit URL" :value warn))
 559   :version "20.3"
 560   :group 'browse-url)
 561
 562 (defcustom browse-url-lynx-input-attempts 10
 563   "*How many times to try to move down from a series of lynx input fields."
 564   :type 'integer
 565   :group 'browse-url)
 566
 567 (defcustom browse-url-lynx-input-delay 0.2
 568   "*How many seconds to wait for lynx between moves down from an input field."
 569   :type 'number
 570   :group 'browse-url)
 571
 572 (defcustom browse-url-kde-program "kfmclient"
 573   "*The name by which to invoke the KDE web browser."
 574   :type 'string
 575   :version "21.1"
 576   :group 'browse-url)
 577
 578 (defcustom browse-url-kde-args '("openURL")
 579   "*A list of strings defining options for `browse-url-kde-program'."
 580   :type '(repeat (string :tag "Argument"))
 581   :group 'browse-url)
 582
 583 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 584 ;; URL input
 585
 586 ;;;###autoload
 587 (defun browse-url-url-at-point ()
 588   (let ((url (thing-at-point 'url)))
 589     (set-text-properties 0 (length url) nil url)
 590     url))
 591
 592 ;; Having this as a separate function called by the browser-specific
 593 ;; functions allows them to be stand-alone commands, making it easier
 594 ;; to switch between browsers.
 595
 596 (defun browse-url-interactive-arg (prompt)
 597   "Read a URL from the minibuffer, prompting with PROMPT.
 598 If `transient-mark-mode' is non-nil and the mark is active,
 599 it defaults to the current region, else to the URL at or before
 600 point.  If invoked with a mouse button, it moves point to the
 601 position clicked before acting.
 602
 603 This function returns a list (URL NEW-WINDOW-FLAG)
 604 for use in `interactive'."
 605   (let ((event (elt (this-command-keys) 0)))
 606     (and (listp event) (mouse-set-point event)))
 607   (list (read-string prompt (or (and transient-mark-mode mark-active
 608                                      ;; rfc2396 Appendix E.
 609                                      (replace-regexp-in-string
 610                                       "[\t\r\f\n ]+" ""
 611                                       (buffer-substring-no-properties
 612                                        (region-beginning) (region-end))))
 613                                 (browse-url-url-at-point)))
 614         (not (eq (null browse-url-new-window-flag)
 615                  (null current-prefix-arg)))))
 616
 617 ;; called-interactive-p needs to be called at a function's top-level, hence
 618 ;; this macro.  We use that rather than interactive-p because
 619 ;; use in a keyboard macro should not change this behavior.
 620 (defmacro browse-url-maybe-new-window (arg)
 621   `(if (or noninteractive (not (called-interactively-p)))
 622        ,arg
 623      browse-url-new-window-flag))
 624
 625 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 626 ;; Browse current buffer
 627
 628 ;;;###autoload
 629 (defun browse-url-of-file (&optional file)
 630   "Ask a WWW browser to display FILE.
 631 Display the current buffer's file if FILE is nil or if called
 632 interactively.  Turn the filename into a URL with function
 633 `browse-url-file-url'.  Pass the URL to a browser using the
 634 `browse-url' function then run `browse-url-of-file-hook'."
 635   (interactive)
 636   (or file
 637       (setq file (buffer-file-name))
 638       (error "Current buffer has no file"))
 639   (let ((buf (get-file-buffer file)))
 640     (if buf
 641         (save-excursion
 642           (set-buffer buf)
 643           (cond ((not (buffer-modified-p)))
 644                 (browse-url-save-file (save-buffer))
 645                 (t (message "%s modified since last save" file))))))
 646   (browse-url (browse-url-file-url file))
 647   (run-hooks 'browse-url-of-file-hook))
 648
 649 (defun browse-url-file-url (file)
 650   "Return the URL corresponding to FILE.
 651 Use variable `browse-url-filename-alist' to map filenames to URLs."
 652   ;; URL-encode special chars, do % first
 653   (let ((s 0))
 654     (while (setq s (string-match "%" file s))
 655       (setq file (replace-match "%25" t t file)
 656             s (1+ s))))
 657   (while (string-match "[*\"()',=;? ]" file)
 658     (let ((enc (format "%%%x" (aref file (match-beginning 0)))))
 659       (setq file (replace-match enc t t file))))
 660   (dolist (map browse-url-filename-alist)
 661     (when (and map (string-match (car map) file))
 662       (setq file (replace-match (cdr map) t nil file))))
 663   file)
 664
 665 ;;;###autoload
 666 (defun browse-url-of-buffer (&optional buffer)
 667   "Ask a WWW browser to display BUFFER.
 668 Display the current buffer if BUFFER is nil.  Display only the
 669 currently visible part of BUFFER (from a temporary file) if buffer is
 670 narrowed."
 671   (interactive)
 672   (save-excursion
 673     (and buffer (set-buffer buffer))
 674     (let ((file-name
 675            ;; Ignore real name if restricted
 676            (and (= (- (point-max) (point-min)) (buffer-size))
 677                 (or buffer-file-name
 678                     (and (boundp 'dired-directory) dired-directory)))))
 679       (or file-name
 680           (progn
 681             (or browse-url-temp-file-name
 682                 (setq browse-url-temp-file-name
 683                       (convert-standard-filename
 684                        (make-temp-file
 685                         (expand-file-name "burl" browse-url-temp-dir)))))
 686             (setq file-name browse-url-temp-file-name)
 687             (write-region (point-min) (point-max) file-name nil 'no-message)))
 688       (browse-url-of-file file-name))))
 689
 690 (defun browse-url-delete-temp-file (&optional temp-file-name)
 691   ;; Delete browse-url-temp-file-name from the file system
 692   ;; If optional arg TEMP-FILE-NAME is non-nil, delete it instead
 693   (let ((file-name (or temp-file-name browse-url-temp-file-name)))
 694     (if (and file-name (file-exists-p file-name))
 695         (delete-file file-name))))
 696
 697 (add-hook 'kill-buffer-hook 'browse-url-delete-temp-file)
 698
 699 ;;;###autoload
 700 (defun browse-url-of-dired-file ()
 701   "In Dired, ask a WWW browser to display the file named on this line."
 702   (interactive)
 703   (browse-url-of-file (dired-get-filename)))
 704
 705 ;;;###autoload
 706 (defun browse-url-of-region (min max)
 707   "Ask a WWW browser to display the current region."
 708   (interactive "r")
 709   (save-excursion
 710     (save-restriction
 711       (narrow-to-region min max)
 712       (browse-url-of-buffer))))
 713
 714 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 715 ;; Browser-independent commands
 716
 717 ;; A generic command to call the current browse-url-browser-function
 718
 719 ;;;###autoload
 720 (defun browse-url (url &rest args)
 721   "Ask a WWW browser to load URL.
 722 Prompts for a URL, defaulting to the URL at or before point.  Variable
 723 `browse-url-browser-function' says which browser to use."
 724   (interactive (browse-url-interactive-arg "URL: "))
 725   (unless (interactive-p)
 726     (setq args (or args (list browse-url-new-window-flag))))
 727   (if (functionp browse-url-browser-function)
 728       (apply browse-url-browser-function url args)
 729     ;; The `function' can be an alist; look down it for first match
 730     ;; and apply the function (which might be a lambda).
 731     (catch 'done
 732       (dolist (bf browse-url-browser-function)
 733         (when (string-match (car bf) url)
 734           (apply (cdr bf) url args)
 735           (throw 'done t)))
 736       (error "No browse-url-browser-function matching URL %s"
 737              url))))
 738
 739 ;;;###autoload
 740 (defun browse-url-at-point (&optional arg)
 741   "Ask a WWW browser to load the URL at or before point.
 742 Doesn't let you edit the URL like `browse-url'.  Variable
 743 `browse-url-browser-function' says which browser to use."
 744   (interactive "P")
 745   (let ((url (browse-url-url-at-point)))
 746     (if url
 747         (browse-url url (if arg
 748                             (not browse-url-new-window-flag)
 749                           browse-url-new-window-flag))
 750       (error "No URL found"))))
 751
 752 ;;;###autoload
 753 (defun browse-url-at-mouse (event)
 754   "Ask a WWW browser to load a URL clicked with the mouse.
 755 The URL is the one around or before the position of the mouse click
 756 but point is not changed.  Doesn't let you edit the URL like
 757 `browse-url'.  Variable `browse-url-browser-function' says which browser
 758 to use."
 759   (interactive "e")
 760   (save-excursion
 761     (mouse-set-point event)
 762     ;; This handles browse-url-new-window-flag properly
 763     ;; when it gets no arg.
 764     (browse-url-at-point)))
 765
 766 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 767 ;; Browser-specific commands
 768
 769 ;; --- Default MS-Windows browser ---
 770
 771 (defun browse-url-default-windows-browser (url &optional new-window)
 772   (interactive (browse-url-interactive-arg "URL: "))
 773   (if (eq system-type 'ms-dos)
 774       (if dos-windows-version
 775           (shell-command (concat "start " (shell-quote-argument url)))
 776         (error "Browsing URLs is not supported on this system"))
 777     (w32-shell-execute "open" url)))
 778
 779 (defun browse-url-default-macosx-browser (url &optional new-window)
 780   (interactive (browse-url-interactive-arg "URL: "))
 781   (start-process (concat "open " url) nil "open" url))
 782
 783 ;; --- Netscape ---
 784
 785 (defun browse-url-process-environment ()
 786   "Set DISPLAY in the environment to the X display the browser will use.
 787 This is either the value of variable `browse-url-browser-display' if
 788 non-nil, or the same display as Emacs if different from the current
 789 environment, otherwise just use the current environment."
 790   (let ((display (or browse-url-browser-display (browse-url-emacs-display))))
 791     (if display
 792         (cons (concat "DISPLAY=" display) process-environment)
 793       process-environment)))
 794
 795 (defun browse-url-emacs-display ()
 796   "Return the X display Emacs is running on.
 797 This is nil if the display is the same as the DISPLAY environment variable.
 798
 799 Actually Emacs could be using several displays; this just returns the
 800 one showing the selected frame."
 801   (let ((display (cdr-safe (assq 'display (frame-parameters)))))
 802     (and (not (equal display (getenv "DISPLAY")))
 803          display)))
 804
 805 ;;;###autoload
 806 (defun browse-url-default-browser (url &rest args)
 807   "Find a suitable browser and ask it to load URL.
 808 Default to the URL around or before point.
 809
 810 When called interactively, if variable `browse-url-new-window-flag' is
 811 non-nil, load the document in a new window, if possible, otherwise use
 812 a random existing one.  A non-nil interactive prefix argument reverses
 813 the effect of `browse-url-new-window-flag'.
 814
 815 When called non-interactively, optional second argument NEW-WINDOW is
 816 used instead of `browse-url-new-window-flag'.
 817
 818 The order attempted is gnome-moz-remote, Mozilla, Galeon,
 819 Konqueror, Netscape, Mosaic, IXI Mosaic, Lynx in an xterm, MMM,
 820 and then W3."
 821   (apply
 822     (cond
 823      ((executable-find browse-url-gnome-moz-program) 'browse-url-gnome-moz)
 824      ((executable-find browse-url-mozilla-program) 'browse-url-mozilla)
 825      ((executable-find browse-url-galeon-program) 'browse-url-galeon)
 826      ((executable-find browse-url-kde-program) 'browse-url-kde)
 827      ((executable-find browse-url-netscape-program) 'browse-url-netscape)
 828      ((executable-find browse-url-mosaic-program) 'browse-url-mosaic)
 829      ((executable-find "tellw3b") 'browse-url-iximosaic)
 830      ((executable-find browse-url-xterm-program) 'browse-url-lynx-xterm)
 831      ((executable-find "mmm") 'browse-url-mmm)
 832      (t 'browse-url-w3))
 833      url args))
 834
 835 ;;;###autoload
 836 (defun browse-url-netscape (url &optional new-window)
 837   "Ask the Netscape WWW browser to load URL.
 838 Default to the URL around or before point.  The strings in variable
 839 `browse-url-netscape-arguments' are also passed to Netscape.
 840
 841 When called interactively, if variable `browse-url-new-window-flag' is
 842 non-nil, load the document in a new Netscape window, otherwise use a
 843 random existing one.  A non-nil interactive prefix argument reverses
 844 the effect of `browse-url-new-window-flag'.
 845
 846 If `browse-url-netscape-new-window-is-tab' is non-nil, then
 847 whenever a document would otherwise be loaded in a new window, it
 848 is loaded in a new tab in an existing window instead.
 849
 850 When called non-interactively, optional second argument NEW-WINDOW is
 851 used instead of `browse-url-new-window-flag'."
 852   (interactive (browse-url-interactive-arg "URL: "))
 853   ;; URL encode any `confusing' characters in the URL.  This needs to
 854   ;; include at least commas; presumably also close parens and dollars.
 855   (while (string-match "[,)$]" url)
 856     (setq url (replace-match
 857                (format "%%%x" (string-to-char (match-string 0 url))) t t url)))
 858   (let* ((process-environment (browse-url-process-environment))
 859          (process
 860           (apply 'start-process
 861                  (concat "netscape " url) nil
 862                  browse-url-netscape-program
 863                  (append
 864                   browse-url-netscape-arguments
 865                   (if (eq window-system 'w32)
 866                       (list url)
 867                     (append
 868                      (if new-window '("-noraise"))
 869                      (list "-remote"
 870                            (concat "openURL(" url
 871                                    (if (browse-url-maybe-new-window
 872                                         new-window)
 873                                        (if browse-url-netscape-new-window-is-tab
 874                                            ",new-tab"
 875                                          ",new-window"))
 876                                    ")"))))))))
 877     (set-process-sentinel process
 878                           `(lambda (process change)
 879                              (browse-url-netscape-sentinel process ,url)))))
 880
 881 (defun browse-url-netscape-sentinel (process url)
 882   "Handle a change to the process communicating with Netscape."
 883   (or (eq (process-exit-status process) 0)
 884       (let* ((process-environment (browse-url-process-environment)))
 885         ;; Netscape not running - start it
 886         (message "Starting %s..." browse-url-netscape-program)
 887         (apply 'start-process (concat "netscape" url) nil
 888                browse-url-netscape-program
 889                (append browse-url-netscape-startup-arguments (list url))))))
 890
 891 (defun browse-url-netscape-reload ()
 892   "Ask Netscape to reload its current document.
 893 How depends on `browse-url-netscape-version'."
 894   (interactive)
 895   ;; Backwards incompatibility reported by
 896   ;; <peter.kruse@psychologie.uni-regensburg.de>.
 897   (browse-url-netscape-send (if (>= browse-url-netscape-version 4)
 898                                 "xfeDoCommand(reload)"
 899                                 "reload")))
 900
 901 (defun browse-url-netscape-send (command)
 902   "Send a remote control command to Netscape."
 903   (let* ((process-environment (browse-url-process-environment)))
 904     (apply 'start-process "netscape" nil
 905            browse-url-netscape-program
 906            (append browse-url-netscape-arguments
 907                    (list "-remote" command)))))
 908
 909 ;;;###autoload
 910 (defun browse-url-mozilla (url &optional new-window)
 911   "Ask the Mozilla WWW browser to load URL.
 912 Default to the URL around or before point.  The strings in variable
 913 `browse-url-mozilla-arguments' are also passed to Mozilla.
 914
 915 When called interactively, if variable `browse-url-new-window-flag' is
 916 non-nil, load the document in a new Mozilla window, otherwise use a
 917 random existing one.  A non-nil interactive prefix argument reverses
 918 the effect of `browse-url-new-window-flag'.
 919
 920 If `browse-url-mozilla-new-window-is-tab' is non-nil, then whenever a
 921 document would otherwise be loaded in a new window, it is loaded in a
 922 new tab in an existing window instead.
 923
 924 When called non-interactively, optional second argument NEW-WINDOW is
 925 used instead of `browse-url-new-window-flag'."
 926   (interactive (browse-url-interactive-arg "URL: "))
 927   ;; URL encode any `confusing' characters in the URL.  This needs to
 928   ;; include at least commas; presumably also close parens and dollars.
 929   (while (string-match "[,)$]" url)
 930     (setq url (replace-match
 931                (format "%%%x" (string-to-char (match-string 0 url))) t t url)))
 932   (let* ((process-environment (browse-url-process-environment))
 933          (process
 934           (apply 'start-process
 935                  (concat "mozilla " url) nil
 936                  browse-url-mozilla-program
 937                  (append
 938                   browse-url-mozilla-arguments
 939                   (list "-remote"
 940                         (concat "openURL("
 941                                 url
 942                                 (if (browse-url-maybe-new-window
 943                                      new-window)
 944                                     (if browse-url-mozilla-new-window-is-tab
 945                                         ",new-tab"
 946                                       ",new-window"))
 947                                 ")"))))))
 948     (set-process-sentinel process
 949                           `(lambda (process change)
 950                              (browse-url-mozilla-sentinel process ,url)))))
 951
 952 (defun browse-url-mozilla-sentinel (process url)
 953   "Handle a change to the process communicating with Mozilla."
 954   (or (eq (process-exit-status process) 0)
 955       (let* ((process-environment (browse-url-process-environment)))
 956         ;; Mozilla is not running - start it
 957         (message "Starting %s..." browse-url-mozilla-program)
 958         (apply 'start-process (concat "mozilla " url) nil
 959                browse-url-mozilla-program
 960                (append browse-url-mozilla-startup-arguments (list url))))))
 961
 962 ;;;###autoload
 963 (defun browse-url-galeon (url &optional new-window)
 964   "Ask the Galeon WWW browser to load URL.
 965 Default to the URL around or before point.  The strings in variable
 966 `browse-url-galeon-arguments' are also passed to Galeon.
 967
 968 When called interactively, if variable `browse-url-new-window-flag' is
 969 non-nil, load the document in a new Galeon window, otherwise use a
 970 random existing one.  A non-nil interactive prefix argument reverses
 971 the effect of `browse-url-new-window-flag'.
 972
 973 If `browse-url-galeon-new-window-is-tab' is non-nil, then whenever a
 974 document would otherwise be loaded in a new window, it is loaded in a
 975 new tab in an existing window instead.
 976
 977 When called non-interactively, optional second argument NEW-WINDOW is
 978 used instead of `browse-url-new-window-flag'."
 979   (interactive (browse-url-interactive-arg "URL: "))
 980   ;; URL encode any `confusing' characters in the URL.  This needs to
 981   ;; include at least commas; presumably also close parens and dollars.
 982   (while (string-match "[,)$]" url)
 983     (setq url (replace-match
 984                (format "%%%x" (string-to-char (match-string 0 url))) t t url)))
 985   (let* ((process-environment (browse-url-process-environment))
 986          (process (apply 'start-process
 987                          (concat "galeon " url)
 988                          nil
 989                          browse-url-galeon-program
 990                          (append
 991                           browse-url-galeon-arguments
 992                           (if (browse-url-maybe-new-window new-window)
 993                               (if browse-url-galeon-new-window-is-tab
 994                                   '("--new-tab")
 995                                 '("--new-window" "--noraise"))
 996                             '("--existing"))
 997                           (list url)))))
 998     (set-process-sentinel process
 999                           `(lambda (process change)
1000                              (browse-url-galeon-sentinel process ,url)))))
1001
1002 (defun browse-url-galeon-sentinel (process url)
1003   "Handle a change to the process communicating with Galeon."
1004   (or (eq (process-exit-status process) 0)
1005       (let* ((process-environment (browse-url-process-environment)))
1006         ;; Galeon is not running - start it
1007         (message "Starting %s..." browse-url-galeon-program)
1008         (apply 'start-process (concat "galeon " url) nil
1009                browse-url-galeon-program
1010                (append browse-url-galeon-startup-arguments (list url))))))
1011
1012 (defun browse-url-epiphany (url &optional new-window)
1013   "Ask the Epiphany WWW browser to load URL.
1014 Default to the URL around or before point.  The strings in variable
1015 `browse-url-galeon-arguments' are also passed to Epiphany.
1016
1017 When called interactively, if variable `browse-url-new-window-flag' is
1018 non-nil, load the document in a new Epiphany window, otherwise use a
1019 random existing one.  A non-nil interactive prefix argument reverses
1020 the effect of `browse-url-new-window-flag'.
1021
1022 If `browse-url-epiphany-new-window-is-tab' is non-nil, then whenever a
1023 document would otherwise be loaded in a new window, it is loaded in a
1024 new tab in an existing window instead.
1025
1026 When called non-interactively, optional second argument NEW-WINDOW is
1027 used instead of `browse-url-new-window-flag'."
1028   (interactive (browse-url-interactive-arg "URL: "))
1029   ;; URL encode any `confusing' characters in the URL.  This needs to
1030   ;; include at least commas; presumably also close parens and dollars.
1031   (while (string-match "[,)$]" url)
1032     (setq url (replace-match
1033                (format "%%%x" (string-to-char (match-string 0 url))) t t url)))
1034   (let* ((process-environment (browse-url-process-environment))
1035          (process (apply 'start-process
1036                          (concat "epiphany " url)
1037                          nil
1038                          browse-url-epiphany-program
1039                          (append
1040                           browse-url-epiphany-arguments
1041                           (if (browse-url-maybe-new-window new-window)
1042                               (if browse-url-epiphany-new-window-is-tab
1043                                   '("--new-tab")
1044                                 '("--new-window" "--noraise"))
1045                             '("--existing"))
1046                           (list url)))))
1047     (set-process-sentinel process
1048                           `(lambda (process change)
1049                              (browse-url-epiphany-sentinel process ,url)))))
1050
1051 (defun browse-url-epiphany-sentinel (process url)
1052   "Handle a change to the process communicating with Epiphany."
1053   (or (eq (process-exit-status process) 0)
1054       (let* ((process-environment (browse-url-process-environment)))
1055         ;; Epiphany is not running - start it
1056         (message "Starting %s..." browse-url-epiphany-program)
1057         (apply 'start-process (concat "epiphany " url) nil
1058                browse-url-epiphany-program
1059                (append browse-url-epiphany-startup-arguments (list url))))))
1060
1061 ;;;###autoload
1062 (defun browse-url-gnome-moz (url &optional new-window)
1063   "Ask Mozilla/Netscape to load URL via the GNOME program `gnome-moz-remote'.
1064 Default to the URL around or before point.  The strings in variable
1065 `browse-url-gnome-moz-arguments' are also passed.
1066
1067 When called interactively, if variable `browse-url-new-window-flag' is
1068 non-nil, load the document in a new browser window, otherwise use an
1069 existing one.  A non-nil interactive prefix argument reverses the
1070 effect of `browse-url-new-window-flag'.
1071
1072 When called non-interactively, optional second argument NEW-WINDOW is
1073 used instead of `browse-url-new-window-flag'."
1074   (interactive (browse-url-interactive-arg "URL: "))
1075   (apply 'start-process (concat "gnome-moz-remote " url)
1076          nil
1077          browse-url-gnome-moz-program
1078          (append
1079           browse-url-gnome-moz-arguments
1080           (if (browse-url-maybe-new-window new-window)
1081             '("--newwin"))
1082           (list "--raise" url))))
1083
1084 ;; --- Mosaic ---
1085
1086 ;;;###autoload
1087 (defun browse-url-mosaic (url &optional new-window)
1088   "Ask the XMosaic WWW browser to load URL.
1089
1090 Default to the URL around or before point.  The strings in variable
1091 `browse-url-mosaic-arguments' are also passed to Mosaic and the
1092 program is invoked according to the variable
1093 `browse-url-mosaic-program'.
1094
1095 When called interactively, if variable `browse-url-new-window-flag' is
1096 non-nil, load the document in a new Mosaic window, otherwise use a
1097 random existing one.  A non-nil interactive prefix argument reverses
1098 the effect of `browse-url-new-window-flag'.
1099
1100 When called non-interactively, optional second argument NEW-WINDOW is
1101 used instead of `browse-url-new-window-flag'."
1102   (interactive (browse-url-interactive-arg "Mosaic URL: "))
1103   (let ((pidfile (expand-file-name browse-url-mosaic-pidfile))
1104         pid)
1105     (if (file-readable-p pidfile)
1106         (save-excursion
1107           (find-file pidfile)
1108           (goto-char (point-min))
1109           (setq pid (read (current-buffer)))
1110           (kill-buffer nil)))
1111     (if (and pid (zerop (signal-process pid 0))) ; Mosaic running
1112         (save-excursion
1113           (find-file (format "/tmp/Mosaic.%d" pid))
1114           (erase-buffer)
1115           (insert (if (browse-url-maybe-new-window new-window)
1116                       "newwin\n"
1117                     "goto\n")
1118                   url "\n")
1119           (save-buffer)
1120           (kill-buffer nil)
1121           ;; Send signal SIGUSR to Mosaic
1122           (message "Signalling Mosaic...")
1123           (signal-process pid 'SIGUSR1)
1124           ;; Or you could try:
1125           ;; (call-process "kill" nil 0 nil "-USR1" (int-to-string pid))
1126           (message "Signalling Mosaic...done")
1127           )
1128       ;; Mosaic not running - start it
1129       (message "Starting %s..." browse-url-mosaic-program)
1130       (apply 'start-process "xmosaic" nil browse-url-mosaic-program
1131              (append browse-url-mosaic-arguments (list url)))
1132       (message "Starting %s...done" browse-url-mosaic-program))))
1133
1134 ;; --- Grail ---
1135
1136 (defvar browse-url-grail
1137   (concat (or (getenv "GRAILDIR") "~/.grail") "/user/rcgrail.py")
1138   "Location of Grail remote control client script `rcgrail.py'.
1139 Typically found in $GRAILDIR/rcgrail.py, or ~/.grail/user/rcgrail.py.")
1140
1141 ;;;###autoload
1142 (defun browse-url-grail (url &optional new-window)
1143   "Ask the Grail WWW browser to load URL.
1144 Default to the URL around or before point.  Runs the program in the
1145 variable `browse-url-grail'."
1146   (interactive (browse-url-interactive-arg "Grail URL: "))
1147   (message "Sending URL to Grail...")
1148   (save-excursion
1149     (set-buffer (get-buffer-create " *Shell Command Output*"))
1150     (erase-buffer)
1151     ;; don't worry about this failing.
1152     (if (browse-url-maybe-new-window new-window)
1153         (call-process browse-url-grail nil 0 nil "-b" url)
1154       (call-process browse-url-grail nil 0 nil url))
1155     (message "Sending URL to Grail... done")))
1156
1157 ;; --- Mosaic using CCI ---
1158
1159 ;;;###autoload
1160 (defun browse-url-cci (url &optional new-window)
1161   "Ask the XMosaic WWW browser to load URL.
1162 Default to the URL around or before point.
1163
1164 This function only works for XMosaic version 2.5 or later.  You must
1165 select `CCI' from XMosaic's File menu, set the CCI Port Address to the
1166 value of variable `browse-url-CCI-port', and enable `Accept requests'.
1167
1168 When called interactively, if variable `browse-url-new-window-flag' is
1169 non-nil, load the document in a new browser window, otherwise use a
1170 random existing one.  A non-nil interactive prefix argument reverses
1171 the effect of `browse-url-new-window-flag'.
1172
1173 When called non-interactively, optional second argument NEW-WINDOW is
1174 used instead of `browse-url-new-window-flag'."
1175   (interactive (browse-url-interactive-arg "Mosaic URL: "))
1176   (open-network-stream "browse-url" " *browse-url*"
1177                        browse-url-CCI-host browse-url-CCI-port)
1178   ;; Todo: start browser if fails
1179   (process-send-string "browse-url"
1180                        (concat "get url (" url ") output "
1181                                (if (browse-url-maybe-new-window new-window)
1182                                    "new"
1183                                  "current")
1184                                "\r\n"))
1185   (process-send-string "browse-url" "disconnect\r\n")
1186   (delete-process "browse-url"))
1187
1188 ;; --- IXI Mosaic ---
1189
1190 ;;;###autoload
1191 (defun browse-url-iximosaic (url &optional new-window)
1192   ;; new-window ignored
1193   "Ask the IXIMosaic WWW browser to load URL.
1194 Default to the URL around or before point."
1195   (interactive (browse-url-interactive-arg "IXI Mosaic URL: "))
1196   (start-process "tellw3b" nil "tellw3b"
1197                  "-service WWW_BROWSER ixi_showurl " url))
1198
1199 ;; --- W3 ---
1200
1201 ;;;###autoload
1202 (defun browse-url-w3 (url &optional new-window)
1203   "Ask the w3 WWW browser to load URL.
1204 Default to the URL around or before point.
1205
1206 When called interactively, if variable `browse-url-new-window-flag' is
1207 non-nil, load the document in a new window.  A non-nil interactive
1208 prefix argument reverses the effect of `browse-url-new-window-flag'.
1209
1210 When called non-interactively, optional second argument NEW-WINDOW is
1211 used instead of `browse-url-new-window-flag'."
1212   (interactive (browse-url-interactive-arg "W3 URL: "))
1213   (require 'w3)                         ; w3-fetch-other-window not autoloaded
1214   (if (browse-url-maybe-new-window new-window)
1215       (w3-fetch-other-window url)
1216     (w3-fetch url)))
1217
1218 ;;;###autoload
1219 (defun browse-url-w3-gnudoit (url &optional new-window)
1220   ;; new-window ignored
1221   "Ask another Emacs running gnuserv to load the URL using the W3 browser.
1222 The `browse-url-gnudoit-program' program is used with options given by
1223 `browse-url-gnudoit-args'.  Default to the URL around or before point."
1224   (interactive (browse-url-interactive-arg "W3 URL: "))
1225     (apply 'start-process (concat "gnudoit:" url) nil
1226            browse-url-gnudoit-program
1227            (append browse-url-gnudoit-args
1228                    (list (concat "(w3-fetch \"" url "\")")
1229                          "(raise-frame)"))))
1230
1231 ;; --- Lynx in an xterm ---
1232
1233 ;;;###autoload
1234 (defun browse-url-lynx-xterm (url &optional new-window)
1235   ;; new-window ignored
1236   "Ask the Lynx WWW browser to load URL.
1237 Default to the URL around or before point.  A new Lynx process is run
1238 in an Xterm window using the Xterm program named by `browse-url-xterm-program'
1239 with possible additional arguments `browse-url-xterm-args'."
1240   (interactive (browse-url-interactive-arg "Lynx URL: "))
1241   (apply #'start-process `(,(concat "lynx" url) nil ,browse-url-xterm-program
1242              ,@browse-url-xterm-args "-e" "lynx"
1243              ,url)))
1244
1245 ;; --- Lynx in an Emacs "term" window ---
1246
1247 ;;;###autoload
1248 (defun browse-url-lynx-emacs (url &optional new-buffer)
1249   "Ask the Lynx WWW browser to load URL.
1250 Default to the URL around or before point.  With a prefix argument, run
1251 a new Lynx process in a new buffer.
1252
1253 When called interactively, if variable `browse-url-new-window-flag' is
1254 non-nil, load the document in a new lynx in a new term window,
1255 otherwise use any existing one.  A non-nil interactive prefix argument
1256 reverses the effect of `browse-url-new-window-flag'.
1257
1258 When called non-interactively, optional second argument NEW-WINDOW is
1259 used instead of `browse-url-new-window-flag'."
1260   (interactive (browse-url-interactive-arg "Lynx URL: "))
1261   (let* ((system-uses-terminfo t)       ; Lynx uses terminfo
1262          ;; (term-term-name "vt100") ; ??
1263          (buf (get-buffer "*lynx*"))
1264          (proc (and buf (get-buffer-process buf)))
1265          (n browse-url-lynx-input-attempts))
1266     (if (and (browse-url-maybe-new-window new-buffer) buf)
1267         ;; Rename away the OLD buffer. This isn't very polite, but
1268         ;; term insists on working in a buffer named *lynx* and would
1269         ;; choke on *lynx*<1>
1270         (progn (set-buffer buf)
1271                (rename-uniquely)))
1272     (if (or (browse-url-maybe-new-window new-buffer)
1273             (not buf)
1274             (not proc)
1275             (not (memq (process-status proc) '(run stop))))
1276         ;; start a new lynx
1277         (progn
1278           (setq buf
1279                 (apply #'make-term
1280                        `("lynx" "lynx" nil ,@browse-url-lynx-emacs-args
1281                          ,url)))
1282           (switch-to-buffer buf)
1283           (term-char-mode)
1284           (set-process-sentinel
1285            (get-buffer-process buf)
1286            ;; Don't leave around a dead one (especially because of its
1287            ;; munged keymap.)
1288            (lambda (process event)
1289              (if (not (memq (process-status process) '(run stop)))
1290                  (let ((buf (process-buffer process)))
1291                    (if buf (kill-buffer buf)))))))
1292       ;; send the url to lynx in the old buffer
1293       (let ((win (get-buffer-window buf t)))
1294         (if win
1295             (select-window win)
1296           (switch-to-buffer buf)))
1297       (if (eq (following-char) ?_)
1298           (cond ((eq browse-url-lynx-input-field 'warn)
1299                  (error "Please move out of the input field first"))
1300                 ((eq browse-url-lynx-input-field 'avoid)
1301                  (while (and (eq (following-char) ?_) (> n 0))
1302                    (term-send-down) ; down arrow
1303                    (sit-for browse-url-lynx-input-delay))
1304                  (if (eq (following-char) ?_)
1305                      (error "Cannot move out of the input field, sorry")))))
1306       (term-send-string proc (concat "g" ; goto
1307                                      "\C-u" ; kill default url
1308                                      url
1309                                      "\r")))))
1310
1311 ;; --- MMM ---
1312
1313 ;;;###autoload
1314 (defun browse-url-mmm (url &optional new-window)
1315   "Ask the MMM WWW browser to load URL.
1316 Default to the URL around or before point."
1317   (interactive (browse-url-interactive-arg "MMM URL: "))
1318   (message "Sending URL to MMM...")
1319   (save-excursion
1320     (set-buffer (get-buffer-create " *Shell Command Output*"))
1321     (erase-buffer)
1322     ;; mmm_remote just SEGVs if the file isn't there...
1323     (if (or (file-exists-p (expand-file-name "~/.mmm_remote"))
1324             ;; location in v 0.4:
1325             (file-exists-p (expand-file-name "~/.mmm/remote")))
1326         (call-process "mmm_remote" nil 0 nil url)
1327       (call-process "mmm" nil 0 nil "-external" url))
1328     (message "Sending URL to MMM... done")))
1329
1330 ;; --- mailto ---
1331
1332 (autoload 'rfc2368-parse-mailto-url "rfc2368")
1333
1334 ;;;###autoload
1335 (defun browse-url-mail (url &optional new-window)
1336   "Open a new mail message buffer within Emacs for the RFC 2368 URL.
1337 Default to using the mailto: URL around or before point as the
1338 recipient's address.  Supplying a non-nil interactive prefix argument
1339 will cause the mail to be composed in another window rather than the
1340 current one.
1341
1342 When called interactively, if variable `browse-url-new-window-flag' is
1343 non-nil use `compose-mail-other-window', otherwise `compose-mail'.  A
1344 non-nil interactive prefix argument reverses the effect of
1345 `browse-url-new-window-flag'.
1346
1347 When called non-interactively, optional second argument NEW-WINDOW is
1348 used instead of `browse-url-new-window-flag'."
1349   (interactive (browse-url-interactive-arg "Mailto URL: "))
1350   (save-excursion
1351     (let* ((alist (rfc2368-parse-mailto-url url))
1352            (to (assoc "To" alist))
1353            (subject (assoc "Subject" alist))
1354            (body (assoc "Body" alist))
1355            (rest (delete to (delete subject (delete body alist))))
1356            (to (cdr to))
1357            (subject (cdr subject))
1358            (body (cdr body))
1359            (mail-citation-hook (unless body mail-citation-hook)))
1360       (if (browse-url-maybe-new-window new-window)
1361           (compose-mail-other-window to subject rest nil
1362                                      (if body
1363                                          (list 'insert body)
1364                                        (list 'insert-buffer (current-buffer))))
1365         (compose-mail to subject rest nil nil
1366                       (if body
1367                           (list 'insert body)
1368                         (list 'insert-buffer (current-buffer))))))))
1369
1370 ;; --- Random browser ---
1371
1372 ;;;###autoload
1373 (defun browse-url-generic (url &optional new-window)
1374   ;; new-window ignored
1375   "Ask the WWW browser defined by `browse-url-generic-program' to load URL.
1376 Default to the URL around or before point.  A fresh copy of the
1377 browser is started up in a new process with possible additional arguments
1378 `browse-url-generic-args'.  This is appropriate for browsers which
1379 don't offer a form of remote control."
1380   (interactive (browse-url-interactive-arg "URL: "))
1381   (if (not browse-url-generic-program)
1382     (error "No browser defined (`browse-url-generic-program')"))
1383   (apply 'call-process browse-url-generic-program nil
1384          0 nil
1385          (append browse-url-generic-args (list url))))
1386
1387 ;;;###autoload
1388 (defun browse-url-kde (url &optional new-window)
1389   "Ask the KDE WWW browser to load URL.
1390 Default to the URL around or before point."
1391   (interactive (browse-url-interactive-arg "KDE URL: "))
1392   (message "Sending URL to KDE...")
1393   (apply #'start-process (concat "KDE " url) nil browse-url-kde-program
1394                          (append browse-url-kde-args (list url))))
1395
1396 (provide 'browse-url)
1397
1398 ;;; arch-tag: d2079573-5c06-4097-9598-f550fba19430
1399 ;;; browse-url.el ends here