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