lisp/net/browse-url.el

   1 ;;; browse-url.el --- pass a URL to a WWW browser
   2
   3 ;; Copyright (C) 1995-2013 Free Software Foundation, Inc.
   4
   5 ;; Author: Denis Howe <dbh@doc.ic.ac.uk>
   6 ;; Maintainer: FSF
   7 ;; Created: 03 Apr 1995
   8 ;; Keywords: hypertext, hypermedia, mouse
   9
  10 ;; This file is part of GNU Emacs.
  11
  12 ;; GNU Emacs is free software: you can redistribute it and/or modify
  13 ;; it under the terms of the GNU General Public License as published by
  14 ;; the Free Software Foundation, either version 3 of the License, or
  15 ;; (at your option) any later version.
  16
  17 ;; GNU Emacs is distributed in the hope that it will be useful,
  18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 ;; GNU General Public License for more details.
  21
  22 ;; You should have received a copy of the GNU General Public License
  23 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  24
  25 ;;; Commentary:
  26
  27 ;; This package provides functions which read a URL (Uniform Resource
  28 ;; Locator) from the minibuffer, defaulting to the URL around point,
  29 ;; and ask a World-Wide Web browser to load it.  It can also load the
  30 ;; URL associated with the current buffer.  Different browsers use
  31 ;; different methods of remote control so there is one function for
  32 ;; each supported browser.  If the chosen browser is not running, it
  33 ;; is started.  Currently there is support for the following browsers,
  34 ;; some of them probably now obsolete:
  35
  36 ;; Function                           Browser     Earliest version
  37 ;; browse-url-mozilla                 Mozilla     Don't know
  38 ;; browse-url-firefox                 Firefox     Don't know (tried with 1.0.1)
  39 ;; browse-url-chromium                Chromium    3.0
  40 ;; browse-url-galeon                  Galeon      Don't know
  41 ;; browse-url-epiphany                Epiphany    Don't know
  42 ;; browse-url-netscape                Netscape    1.1b1
  43 ;; browse-url-mosaic                  XMosaic/mMosaic <= 2.4
  44 ;; browse-url-cci                     XMosaic     2.5
  45 ;; browse-url-w3                      w3          0
  46 ;; browse-url-w3-gnudoit              w3 remotely
  47 ;; browse-url-text-*                  Any text browser     0
  48 ;; browse-url-generic                 arbitrary
  49 ;; browse-url-default-windows-browser MS-Windows browser
  50 ;; browse-url-default-macosx-browser  Mac OS X browser
  51 ;; browse-url-xdg-open                Free Desktop xdg-open on Gnome, KDE, Xfce4, LXDE
  52 ;; browse-url-gnome-moz               GNOME interface to Mozilla
  53 ;; browse-url-kde                     KDE konqueror (kfm)
  54 ;; browse-url-elinks                  Elinks      Don't know (tried with 0.12.GIT)
  55
  56 ;; [A version of the Netscape browser is now free software
  57 ;; <URL:http://www.mozilla.org/>, albeit not GPLed, so it is
  58 ;; reasonable to have that as the default.]
  59
  60 ;; Note that versions of Netscape before 1.1b1 did not have remote
  61 ;; control.  <URL:http://www.netscape.com/newsref/std/x-remote.html>.
  62
  63 ;; Browsers can cache Web pages so it may be necessary to tell them to
  64 ;; reload the current page if it has changed (e.g. if you have edited
  65 ;; it).  There is currently no perfect automatic solution to this.
  66
  67 ;; Netscape allows you to specify the id of the window you want to
  68 ;; control but which window DO you want to control and how do you
  69 ;; discover its id?
  70
  71 ;; William M.  Perry's excellent "w3" WWW browser for
  72 ;; Emacs <URL:ftp://cs.indiana.edu/pub/elisp/w3/>
  73 ;; has a function w3-follow-url-at-point, but that
  74 ;; doesn't let you edit the URL like browse-url.
  75 ;; The `gnuserv' package that can be used to control it in another
  76 ;; Emacs process is available from
  77 ;; <URL:ftp://ftp.splode.com/pub/users/friedman/packages/>.
  78
  79 ;; Lynx is now distributed by the FSF.  See also
  80 ;; <URL:http://lynx.browser.org/>.
  81
  82 ;; Free graphical browsers that could be used by `browse-url-generic'
  83 ;; include Chimera <URL:ftp://ftp.cs.unlv.edu/pub/chimera> and
  84 ;; <URL:http://www.unlv.edu/chimera/>, Arena
  85 ;; <URL:ftp://ftp.yggdrasil.com/pub/dist/web/arena> and Amaya
  86 ;; <URL:ftp://ftp.w3.org/pub/amaya>.  mMosaic
  87 ;; <URL:ftp://ftp.enst.fr/pub/mbone/mMosaic/>,
  88 ;; <URL:http://www.enst.fr/~dauphin/mMosaic/> (with development
  89 ;; support for Java applets and multicast) can be used like Mosaic by
  90 ;; setting `browse-url-mosaic-program' appropriately.
  91
  92 ;; I [Denis Howe, not Dave Love] recommend Nelson Minar
  93 ;; <nelson@santafe.edu>'s excellent html-helper-mode.el for editing
  94 ;; HTML and thank Nelson for his many useful comments on this code.
  95 ;; <URL:http://www.santafe.edu/%7Enelson/hhm-beta/>
  96
  97 ;; See also hm--html-menus <URL:http://www.tnt.uni-hannover.de/%7Emuenkel/
  98 ;; software/own/hm--html-menus/>.  For composing correct HTML see also
  99 ;; PSGML the general SGML structure editor package
 100 ;; <URL:ftp://ftp.lysator.liu.se/pub/sgml>; hm--html-menus can be used
 101 ;; with this.
 102
 103 ;; This package generalizes function html-previewer-process in Marc
 104 ;; Andreessen's html-mode (LCD modes/html-mode.el.Z).  See also the
 105 ;; ffap.el package.  The huge hyperbole package also contains similar
 106 ;; functions.
 107
 108 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 109 ;; Help!
 110
 111 ;; Can you write and test some code for the Macintrash and Windoze
 112 ;; Netscape remote control APIs?  (See the URL above).
 113
 114 ;; Do any other browsers have remote control?
 115
 116 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 117 ;; Usage
 118
 119 ;; To display the URL at or before point:
 120 ;; M-x browse-url-at-point RET
 121 ;; or, similarly but with the opportunity to edit the URL extracted from
 122 ;; the buffer, use:
 123 ;; M-x browse-url
 124
 125 ;; To display a URL by shift-clicking on it, put this in your init file:
 126 ;;      (global-set-key [S-mouse-2] 'browse-url-at-mouse)
 127 ;; (Note that using Shift-mouse-1 is not desirable because
 128 ;; that event has a standard meaning in Emacs.)
 129
 130 ;; To display the current buffer in a web browser:
 131 ;; M-x browse-url-of-buffer RET
 132
 133 ;; To display the current region in a web browser:
 134 ;; M-x browse-url-of-region RET
 135
 136 ;; In Dired, to display the file named on the current line:
 137 ;; M-x browse-url-of-dired-file RET
 138
 139 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 140 ;; Customization (~/.emacs)
 141
 142 ;; To see what variables are available for customization, type
 143 ;; `M-x set-variable browse-url TAB'.  Better, use
 144 ;; `M-x customize-group browse-url'.
 145
 146 ;; Bind the browse-url commands to keys with the `C-c C-z' prefix
 147 ;; (as used by html-helper-mode):
 148 ;;      (global-set-key "\C-c\C-z." 'browse-url-at-point)
 149 ;;      (global-set-key "\C-c\C-zb" 'browse-url-of-buffer)
 150 ;;      (global-set-key "\C-c\C-zr" 'browse-url-of-region)
 151 ;;      (global-set-key "\C-c\C-zu" 'browse-url)
 152 ;;      (global-set-key "\C-c\C-zv" 'browse-url-of-file)
 153 ;;      (add-hook 'dired-mode-hook
 154 ;;                (lambda ()
 155 ;;                   (local-set-key "\C-c\C-zf" 'browse-url-of-dired-file)))
 156
 157 ;; Browse URLs in mail messages under RMAIL by clicking mouse-2:
 158 ;;      (add-hook 'rmail-mode-hook (lambda () ; rmail-mode startup
 159 ;;        (define-key rmail-mode-map [mouse-2] 'browse-url-at-mouse)))
 160 ;; Alternatively, add `goto-address' to `rmail-show-message-hook'.
 161
 162 ;; Gnus provides a standard feature to activate URLs in article
 163 ;; buffers for invocation of browse-url.
 164
 165 ;; Use the Emacs w3 browser when not running under X11:
 166 ;;      (or (eq window-system 'x)
 167 ;;          (setq browse-url-browser-function 'browse-url-w3))
 168
 169 ;; To always save modified buffers before displaying the file in a browser:
 170 ;;      (setq browse-url-save-file t)
 171
 172 ;; To get round the Netscape caching problem, you could EITHER have
 173 ;; write-file in html-helper-mode make Netscape reload the document:
 174 ;;
 175 ;;      (autoload 'browse-url-netscape-reload "browse-url"
 176 ;;        "Ask a WWW browser to redisplay the current file." t)
 177 ;;      (add-hook 'html-helper-mode-hook
 178 ;;                (lambda ()
 179 ;;                   (add-hook 'local-write-file-hooks
 180 ;;                             (lambda ()
 181 ;;                                (let ((local-write-file-hooks))
 182 ;;                                  (save-buffer))
 183 ;;                                (browse-url-netscape-reload)
 184 ;;                                t)                    ; => file written by hook
 185 ;;                             t)))                     ; append to l-w-f-hooks
 186 ;;
 187 ;; OR have browse-url-of-file ask Netscape to load and then reload the
 188 ;; file:
 189 ;;
 190 ;;      (add-hook 'browse-url-of-file-hook 'browse-url-netscape-reload)
 191
 192 ;; You may also want to customize browse-url-netscape-arguments, e.g.
 193 ;;      (setq browse-url-netscape-arguments '("-install"))
 194 ;;
 195 ;; or similarly for the other browsers.
 196
 197 ;; To invoke different browsers for different URLs:
 198 ;;      (setq browse-url-browser-function '(("^mailto:" . browse-url-mail)
 199 ;;                                          ("." . browse-url-netscape)))
 200
 201 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 202 ;;; Code:
 203
 204 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 205 ;; Variables
 206
 207 (defgroup browse-url nil
 208   "Use a web browser to look at a URL."
 209   :prefix "browse-url-"
 210   :link '(emacs-commentary-link "browse-url")
 211   :group 'external
 212   :group 'comm)
 213
 214 ;;;###autoload
 215 (defcustom browse-url-browser-function
 216   'browse-url-default-browser
 217   "Function to display the current buffer in a WWW browser.
 218 This is used by the `browse-url-at-point', `browse-url-at-mouse', and
 219 `browse-url-of-file' commands.
 220
 221 If the value is not a function it should be a list of pairs
 222 \(REGEXP . FUNCTION).  In this case the function called will be the one
 223 associated with the first REGEXP which matches the current URL.  The
 224 function is passed the URL and any other args of `browse-url'.  The last
 225 regexp should probably be \".\" to specify a default browser."
 226   :type '(choice
 227           (function-item :tag "Emacs W3" :value  browse-url-w3)
 228           (function-item :tag "W3 in another Emacs via `gnudoit'"
 229                          :value  browse-url-w3-gnudoit)
 230           (function-item :tag "Mozilla" :value  browse-url-mozilla)
 231           (function-item :tag "Firefox" :value browse-url-firefox)
 232           (function-item :tag "Chromium" :value browse-url-chromium)
 233           (function-item :tag "Galeon" :value  browse-url-galeon)
 234           (function-item :tag "Epiphany" :value  browse-url-epiphany)
 235           (function-item :tag "Netscape" :value  browse-url-netscape)
 236           (function-item :tag "Mosaic" :value  browse-url-mosaic)
 237           (function-item :tag "Mosaic using CCI" :value  browse-url-cci)
 238           (function-item :tag "Text browser in an xterm window"
 239                          :value browse-url-text-xterm)
 240           (function-item :tag "Text browser in an Emacs window"
 241                          :value browse-url-text-emacs)
 242           (function-item :tag "KDE" :value browse-url-kde)
 243           (function-item :tag "Elinks" :value browse-url-elinks)
 244           (function-item :tag "Specified by `Browse Url Generic Program'"
 245                          :value browse-url-generic)
 246           (function-item :tag "Default Windows browser"
 247                          :value browse-url-default-windows-browser)
 248           (function-item :tag "Default Mac OS X browser"
 249                          :value browse-url-default-macosx-browser)
 250           (function-item :tag "GNOME invoking Mozilla"
 251                          :value browse-url-gnome-moz)
 252           (function-item :tag "Default browser"
 253                          :value browse-url-default-browser)
 254           (function :tag "Your own function")
 255           (alist :tag "Regexp/function association list"
 256                  :key-type regexp :value-type function))
 257   :version "24.1"
 258   :group 'browse-url)
 259
 260 (defcustom browse-url-mailto-function 'browse-url-mail
 261   "Function to display mailto: links.
 262 This variable uses the same syntax as the
 263 `browse-url-browser-function' variable.  If the
 264 `browse-url-mailto-function' variable is nil, that variable will
 265 be used instead."
 266   :type '(choice
 267           (function-item :tag "Emacs Mail" :value browse-url-mail)
 268           (function-item :tag "None" nil))
 269   :version "24.1"
 270   :group 'browse-url)
 271
 272 (defcustom browse-url-netscape-program "netscape"
 273   ;; Info about netscape-remote from Karl Berry.
 274   "The name by which to invoke Netscape.
 275
 276 The free program `netscape-remote' from
 277 <URL:http://home.netscape.com/newsref/std/remote.c> is said to start
 278 up very much quicker than `netscape'.  Reported to compile on a GNU
 279 system, given vroot.h from the same directory, with cc flags
 280  -DSTANDALONE -L/usr/X11R6/lib -lXmu -lX11."
 281   :type 'string
 282   :group 'browse-url)
 283
 284 (defcustom browse-url-netscape-arguments nil
 285   "A list of strings to pass to Netscape as arguments."
 286   :type '(repeat (string :tag "Argument"))
 287   :group 'browse-url)
 288
 289 (defcustom browse-url-netscape-startup-arguments browse-url-netscape-arguments
 290   "A list of strings to pass to Netscape when it starts up.
 291 Defaults to the value of `browse-url-netscape-arguments' at the time
 292 `browse-url' is loaded."
 293   :type '(repeat (string :tag "Argument"))
 294   :group 'browse-url)
 295
 296 (defcustom browse-url-browser-display nil
 297   "The X display for running the browser, if not same as Emacs's."
 298   :type '(choice string (const :tag "Default" nil))
 299   :group 'browse-url)
 300
 301 (defcustom browse-url-mozilla-program "mozilla"
 302   "The name by which to invoke Mozilla."
 303   :type 'string
 304   :group 'browse-url)
 305
 306 (defcustom browse-url-mozilla-arguments nil
 307   "A list of strings to pass to Mozilla as arguments."
 308   :type '(repeat (string :tag "Argument"))
 309   :group 'browse-url)
 310
 311 (defcustom browse-url-mozilla-startup-arguments browse-url-mozilla-arguments
 312   "A list of strings to pass to Mozilla when it starts up.
 313 Defaults to the value of `browse-url-mozilla-arguments' at the time
 314 `browse-url' is loaded."
 315   :type '(repeat (string :tag "Argument"))
 316   :group 'browse-url)
 317
 318 (defcustom browse-url-firefox-program
 319   (let ((candidates '("firefox" "iceweasel" "icecat")))
 320     (while (and candidates (not (executable-find (car candidates))))
 321       (setq candidates (cdr candidates)))
 322     (or (car candidates) "firefox"))
 323   "The name by which to invoke Firefox."
 324   :type 'string
 325   :group 'browse-url)
 326
 327 (defcustom browse-url-firefox-arguments nil
 328   "A list of strings to pass to Firefox as arguments."
 329   :type '(repeat (string :tag "Argument"))
 330   :group 'browse-url)
 331
 332 (defcustom browse-url-firefox-startup-arguments browse-url-firefox-arguments
 333   "A list of strings to pass to Firefox when it starts up.
 334 Defaults to the value of `browse-url-firefox-arguments' at the time
 335 `browse-url' is loaded."
 336   :type '(repeat (string :tag "Argument"))
 337   :group 'browse-url)
 338
 339 (defcustom browse-url-chromium-program
 340   (let ((candidates '("chromium" "chromium-browser")))
 341     (while (and candidates (not (executable-find (car candidates))))
 342       (setq candidates (cdr candidates)))
 343     (or (car candidates) "chromium"))
 344   "The name by which to invoke Chromium."
 345   :type 'string
 346   :version "24.1"
 347   :group 'browse-url)
 348
 349 (defcustom browse-url-chromium-arguments nil
 350   "A list of strings to pass to Chromium as arguments."
 351   :type '(repeat (string :tag "Argument"))
 352   :version "24.1"
 353   :group 'browse-url)
 354
 355 (defcustom browse-url-galeon-program "galeon"
 356   "The name by which to invoke Galeon."
 357   :type 'string
 358   :group 'browse-url)
 359
 360 (defcustom browse-url-galeon-arguments nil
 361   "A list of strings to pass to Galeon as arguments."
 362   :type '(repeat (string :tag "Argument"))
 363   :group 'browse-url)
 364
 365 (defcustom browse-url-galeon-startup-arguments browse-url-galeon-arguments
 366   "A list of strings to pass to Galeon when it starts up.
 367 Defaults to the value of `browse-url-galeon-arguments' at the time
 368 `browse-url' is loaded."
 369   :type '(repeat (string :tag "Argument"))
 370   :group 'browse-url)
 371
 372 (defcustom browse-url-epiphany-program "epiphany"
 373   "The name by which to invoke Epiphany."
 374   :type 'string
 375   :group 'browse-url)
 376
 377 (defcustom browse-url-epiphany-arguments nil
 378   "A list of strings to pass to Epiphany as arguments."
 379   :type '(repeat (string :tag "Argument"))
 380   :group 'browse-url)
 381
 382 (defcustom browse-url-epiphany-startup-arguments browse-url-epiphany-arguments
 383   "A list of strings to pass to Epiphany when it starts up.
 384 Defaults to the value of `browse-url-epiphany-arguments' at the time
 385 `browse-url' is loaded."
 386   :type '(repeat (string :tag "Argument"))
 387   :group 'browse-url)
 388
 389 ;; GNOME means of invoking either Mozilla or Netscape.
 390 (defvar browse-url-gnome-moz-program "gnome-moz-remote")
 391
 392 (defcustom browse-url-gnome-moz-arguments '()
 393   "A list of strings passed to the GNOME mozilla viewer as arguments."
 394   :version "21.1"
 395   :type '(repeat (string :tag "Argument"))
 396   :group 'browse-url)
 397
 398 (defcustom browse-url-mozilla-new-window-is-tab nil
 399   "Whether to open up new windows in a tab or a new window.
 400 If non-nil, then open the URL in a new tab rather than a new window if
 401 `browse-url-mozilla' is asked to open it in a new window."
 402   :type 'boolean
 403   :group 'browse-url)
 404
 405 (defcustom browse-url-firefox-new-window-is-tab nil
 406   "Whether to open up new windows in a tab or a new window.
 407 If non-nil, then open the URL in a new tab rather than a new window if
 408 `browse-url-firefox' is asked to open it in a new window.
 409
 410 This option is currently ignored on MS-Windows, since the necessary
 411 functionality is not available there."
 412   :type 'boolean
 413   :group 'browse-url)
 414
 415 (defcustom browse-url-galeon-new-window-is-tab nil
 416   "Whether to open up new windows in a tab or a new window.
 417 If non-nil, then open the URL in a new tab rather than a new window if
 418 `browse-url-galeon' is asked to open it in a new window."
 419   :type 'boolean
 420   :group 'browse-url)
 421
 422 (defcustom browse-url-epiphany-new-window-is-tab nil
 423   "Whether to open up new windows in a tab or a new window.
 424 If non-nil, then open the URL in a new tab rather than a new window if
 425 `browse-url-epiphany' is asked to open it in a new window."
 426   :type 'boolean
 427   :group 'browse-url)
 428
 429 (defcustom browse-url-netscape-new-window-is-tab nil
 430   "Whether to open up new windows in a tab or a new window.
 431 If non-nil, then open the URL in a new tab rather than a new
 432 window if `browse-url-netscape' is asked to open it in a new
 433 window."
 434   :type 'boolean
 435   :group 'browse-url)
 436
 437 (defcustom browse-url-new-window-flag nil
 438   "Non-nil means always open a new browser window with appropriate browsers.
 439 Passing an interactive argument to \\[browse-url], or specific browser
 440 commands reverses the effect of this variable.  Requires Netscape version
 441 1.1N or later or XMosaic version 2.5 or later if using those browsers."
 442   :type 'boolean
 443   :group 'browse-url)
 444
 445 (defcustom browse-url-mosaic-program "xmosaic"
 446   "The name by which to invoke Mosaic (or mMosaic)."
 447   :type 'string
 448   :version "20.3"
 449   :group 'browse-url)
 450
 451 (defcustom browse-url-mosaic-arguments nil
 452   "A list of strings to pass to Mosaic as arguments."
 453   :type '(repeat (string :tag "Argument"))
 454   :group 'browse-url)
 455
 456 (defcustom browse-url-mosaic-pidfile "~/.mosaicpid"
 457   "The name of the pidfile created by Mosaic."
 458   :type 'string
 459   :group 'browse-url)
 460
 461 (defcustom browse-url-filename-alist
 462   `(("^/\\(ftp@\\|anonymous@\\)?\\([^:]+\\):/*" . "ftp://\\2/")
 463     ;; The above loses the username to avoid the browser prompting for
 464     ;; it in anonymous cases.  If it's not anonymous the next regexp
 465     ;; applies.
 466     ("^/\\([^:@]+@\\)?\\([^:]+\\):/*" . "ftp://\\1\\2/")
 467     ,@(if (memq system-type '(windows-nt ms-dos))
 468           '(("^\\([a-zA-Z]:\\)[\\/]" . "file:///\\1/")
 469             ("^[\\/][\\/]+" . "file://")))
 470     ("^/+" . "file:///"))
 471   "An alist of (REGEXP . STRING) pairs used by `browse-url-of-file'.
 472 Any substring of a filename matching one of the REGEXPs is replaced by
 473 the corresponding STRING using `replace-match', not treating STRING
 474 literally.  All pairs are applied in the order given.  The default
 475 value converts ange-ftp/EFS-style file names into ftp URLs and prepends
 476 `file:' to any file name beginning with `/'.
 477
 478 For example, adding to the default a specific translation of an ange-ftp
 479 address to an HTTP URL:
 480
 481     (setq browse-url-filename-alist
 482           '((\"/webmaster@webserver:/home/www/html/\" .
 483              \"http://www.acme.co.uk/\")
 484             (\"^/\\(ftp@\\|anonymous@\\)?\\([^:]+\\):/*\" . \"ftp://\\2/\")
 485             (\"^/\\([^:@]+@\\)?\\([^:]+\\):/*\" . \"ftp://\\1\\2/\")
 486             (\"^/+\" . \"file:/\")))"
 487   :type '(repeat (cons :format "%v"
 488                        (regexp :tag "Regexp")
 489                        (string :tag "Replacement")))
 490   :version "23.1"
 491   :group 'browse-url)
 492
 493 (defcustom browse-url-save-file nil
 494   "If non-nil, save the buffer before displaying its file.
 495 Used by the `browse-url-of-file' command."
 496   :type 'boolean
 497   :group 'browse-url)
 498
 499 (defcustom browse-url-of-file-hook nil
 500   "Run after `browse-url-of-file' has asked a browser to load a file.
 501
 502 Set this to `browse-url-netscape-reload' to force Netscape to load the
 503 file rather than displaying a cached copy."
 504   :type 'hook
 505   :options '(browse-url-netscape-reload)
 506   :group 'browse-url)
 507
 508 (defcustom browse-url-CCI-port 3003
 509   "Port to access XMosaic via CCI.
 510 This can be any number between 1024 and 65535 but must correspond to
 511 the value set in the browser."
 512   :type 'integer
 513   :group 'browse-url)
 514
 515 (defcustom browse-url-CCI-host "localhost"
 516   "Host to access XMosaic via CCI.
 517 This should be the host name of the machine running XMosaic with CCI
 518 enabled.  The port number should be set in `browse-url-CCI-port'."
 519   :type 'string
 520   :group 'browse-url)
 521
 522 (defvar browse-url-temp-file-name nil)
 523 (make-variable-buffer-local 'browse-url-temp-file-name)
 524
 525 (defcustom browse-url-xterm-program "xterm"
 526   "The name of the terminal emulator used by `browse-url-text-xterm'.
 527 This might, for instance, be a separate color version of xterm."
 528   :type 'string
 529   :group 'browse-url)
 530
 531 (defcustom browse-url-xterm-args nil
 532   "A list of strings defining options for `browse-url-xterm-program'.
 533 These might set its size, for instance."
 534   :type '(repeat (string :tag "Argument"))
 535   :group 'browse-url)
 536
 537 (defcustom browse-url-gnudoit-program "gnudoit"
 538   "The name of the `gnudoit' program used by `browse-url-w3-gnudoit'."
 539   :type 'string
 540   :group 'browse-url)
 541
 542 (defcustom browse-url-gnudoit-args '("-q")
 543   "A list of strings defining options for `browse-url-gnudoit-program'.
 544 These might set the port, for instance."
 545   :type '(repeat (string :tag "Argument"))
 546   :group 'browse-url)
 547
 548 (defcustom browse-url-generic-program nil
 549   "The name of the browser program used by `browse-url-generic'."
 550   :type '(choice string (const :tag "None" nil))
 551   :group 'browse-url)
 552
 553 (defcustom browse-url-generic-args nil
 554   "A list of strings defining options for `browse-url-generic-program'."
 555   :type '(repeat (string :tag "Argument"))
 556   :group 'browse-url)
 557
 558 (defcustom browse-url-temp-dir temporary-file-directory
 559   "The name of a directory for browse-url's temporary files.
 560 Such files are generated by functions like `browse-url-of-region'.
 561 You might want to set this to somewhere with restricted read permissions
 562 for privacy's sake."
 563   :type 'string
 564   :group 'browse-url)
 565
 566 (defcustom browse-url-netscape-version 3
 567   "The version of Netscape you are using.
 568 This affects how URL reloading is done; the mechanism changed
 569 incompatibly at version 4."
 570   :type 'number
 571   :group 'browse-url)
 572
 573 (defcustom browse-url-text-browser "lynx"
 574   "The name of the text browser to invoke."
 575   :type 'string
 576   :group 'browse-url
 577   :version "23.1")
 578
 579 (defcustom browse-url-text-emacs-args (and (not window-system)
 580                                            '("-show_cursor"))
 581   "A list of strings defining options for a text browser in an Emacs buffer.
 582
 583 The default is none in a window system, otherwise `-show_cursor' to
 584 indicate the position of the current link in the absence of
 585 highlighting, assuming the normal default for showing the cursor."
 586   :type '(repeat (string :tag "Argument"))
 587   :version "23.1"
 588   :group 'browse-url)
 589
 590 (defcustom browse-url-text-input-field 'avoid
 591   "Action on selecting an existing text browser buffer at an input field.
 592 What to do when sending a new URL to an existing text browser buffer in Emacs
 593 if the browser cursor is on an input field (in which case the `g' command
 594 would be entered as data).  Such fields are recognized by the
 595 underlines ____.  Allowed values: nil: disregard it, `warn': warn the
 596 user and don't emit the URL, `avoid': try to avoid the field by moving
 597 down (this *won't* always work)."
 598   :type '(choice (const :tag "Move to try to avoid field" :value avoid)
 599                  (const :tag "Disregard" :value nil)
 600                  (const :tag "Warn, don't emit URL" :value warn))
 601   :version "23.1"
 602   :group 'browse-url)
 603
 604 (defcustom browse-url-text-input-attempts 10
 605   "How many times to try to move down from a series of text browser input fields."
 606   :type 'integer
 607   :version "23.1"
 608   :group 'browse-url)
 609
 610 (defcustom browse-url-text-input-delay 0.2
 611   "Seconds to wait for a text browser between moves down from an input field."
 612   :type 'number
 613   :version "23.1"
 614   :group 'browse-url)
 615
 616 (defcustom browse-url-kde-program "kfmclient"
 617   "The name by which to invoke the KDE web browser."
 618   :type 'string
 619   :version "21.1"
 620   :group 'browse-url)
 621
 622 (defcustom browse-url-kde-args '("openURL")
 623   "A list of strings defining options for `browse-url-kde-program'."
 624   :type '(repeat (string :tag "Argument"))
 625   :group 'browse-url)
 626
 627 (defcustom browse-url-elinks-wrapper '("xterm" "-e")
 628   "Wrapper command prepended to the Elinks command-line."
 629   :type '(repeat (string :tag "Wrapper"))
 630   :group 'browse-url)
 631
 632 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 633 ;; URL encoding
 634
 635 (defun browse-url-url-encode-chars (text chars)
 636   "URL-encode the chars in TEXT that match CHARS.
 637 CHARS is a regexp-like character alternative (e.g., \"[)$]\")."
 638   (let ((encoded-text (copy-sequence text))
 639         (s 0))
 640     (while (setq s (string-match chars encoded-text s))
 641       (setq encoded-text
 642             (replace-match (format "%%%X"
 643                                    (string-to-char (match-string 0 encoded-text)))
 644                            t t encoded-text)
 645             s (1+ s)))
 646     encoded-text))
 647
 648 (defun browse-url-encode-url (url)
 649   "Escape annoying characters in URL.
 650 The annoying characters are those that can mislead a web browser
 651 regarding its parameter treatment."
 652   ;; FIXME: Is there an actual example of a web browser getting
 653   ;; confused?  (This used to encode commas, but at least Firefox
 654   ;; handles commas correctly and doesn't accept encoded commas.)
 655   (browse-url-url-encode-chars url "[\")$] "))
 656
 657 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 658 ;; URL input
 659
 660 (defun browse-url-url-at-point ()
 661   (or (thing-at-point 'url t)
 662       ;; assume that the user is pointing at something like gnu.org/gnu
 663       (let ((f (thing-at-point 'filename t)))
 664         (and f (concat "http://" f)))))
 665
 666 ;; Having this as a separate function called by the browser-specific
 667 ;; functions allows them to be stand-alone commands, making it easier
 668 ;; to switch between browsers.
 669
 670 (defun browse-url-interactive-arg (prompt)
 671   "Read a URL from the minibuffer, prompting with PROMPT.
 672 If `transient-mark-mode' is non-nil and the mark is active,
 673 it defaults to the current region, else to the URL at or before
 674 point.  If invoked with a mouse button, it moves point to the
 675 position clicked before acting.
 676
 677 This function returns a list (URL NEW-WINDOW-FLAG)
 678 for use in `interactive'."
 679   (let ((event (elt (this-command-keys) 0)))
 680     (and (listp event) (mouse-set-point event)))
 681   (list (read-string prompt (or (and transient-mark-mode mark-active
 682                                      ;; rfc2396 Appendix E.
 683                                      (replace-regexp-in-string
 684                                       "[\t\r\f\n ]+" ""
 685                                       (buffer-substring-no-properties
 686                                        (region-beginning) (region-end))))
 687                                 (browse-url-url-at-point)))
 688         (not (eq (null browse-url-new-window-flag)
 689                  (null current-prefix-arg)))))
 690
 691 ;; called-interactive-p needs to be called at a function's top-level, hence
 692 ;; this macro.  We use that rather than interactive-p because
 693 ;; use in a keyboard macro should not change this behavior.
 694 (defmacro browse-url-maybe-new-window (arg)
 695   `(if (or noninteractive (not (called-interactively-p 'any)))
 696        ,arg
 697      browse-url-new-window-flag))
 698
 699 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 700 ;; Browse current buffer
 701
 702 ;;;###autoload
 703 (defun browse-url-of-file (&optional file)
 704   "Ask a WWW browser to display FILE.
 705 Display the current buffer's file if FILE is nil or if called
 706 interactively.  Turn the filename into a URL with function
 707 `browse-url-file-url'.  Pass the URL to a browser using the
 708 `browse-url' function then run `browse-url-of-file-hook'."
 709   (interactive)
 710   (or file
 711       (setq file (buffer-file-name))
 712       (error "Current buffer has no file"))
 713   (let ((buf (get-file-buffer file)))
 714     (if buf
 715         (with-current-buffer buf
 716           (cond ((not (buffer-modified-p)))
 717                 (browse-url-save-file (save-buffer))
 718                 (t (message "%s modified since last save" file))))))
 719   (browse-url (browse-url-file-url file))
 720   (run-hooks 'browse-url-of-file-hook))
 721
 722 (defun browse-url-file-url (file)
 723   "Return the URL corresponding to FILE.
 724 Use variable `browse-url-filename-alist' to map filenames to URLs."
 725   (let ((coding (and (default-value 'enable-multibyte-characters)
 726                      (or file-name-coding-system
 727                          default-file-name-coding-system))))
 728     (if coding (setq file (encode-coding-string file coding))))
 729   (setq file (browse-url-url-encode-chars file "[*\"()',=;?% ]"))
 730   (dolist (map browse-url-filename-alist)
 731     (when (and map (string-match (car map) file))
 732       (setq file (replace-match (cdr map) t nil file))))
 733   file)
 734
 735 ;;;###autoload
 736 (defun browse-url-of-buffer (&optional buffer)
 737   "Ask a WWW browser to display BUFFER.
 738 Display the current buffer if BUFFER is nil.  Display only the
 739 currently visible part of BUFFER (from a temporary file) if buffer is
 740 narrowed."
 741   (interactive)
 742   (save-excursion
 743     (and buffer (set-buffer buffer))
 744     (let ((file-name
 745            ;; Ignore real name if restricted
 746            (and (not (buffer-narrowed-p))
 747                 (or buffer-file-name
 748                     (and (boundp 'dired-directory) dired-directory)))))
 749       (or file-name
 750           (progn
 751             (or browse-url-temp-file-name
 752                 (setq browse-url-temp-file-name
 753                       (convert-standard-filename
 754                        (make-temp-file
 755                         (expand-file-name "burl" browse-url-temp-dir)
 756                         nil ".html"))))
 757             (setq file-name browse-url-temp-file-name)
 758             (write-region (point-min) (point-max) file-name nil 'no-message)))
 759       (browse-url-of-file file-name))))
 760
 761 (defun browse-url-delete-temp-file (&optional temp-file-name)
 762   ;; Delete browse-url-temp-file-name from the file system
 763   ;; If optional arg TEMP-FILE-NAME is non-nil, delete it instead
 764   (let ((file-name (or temp-file-name browse-url-temp-file-name)))
 765     (if (and file-name (file-exists-p file-name))
 766         (delete-file file-name))))
 767
 768 (add-hook 'kill-buffer-hook 'browse-url-delete-temp-file)
 769
 770 (declare-function dired-get-filename "dired"
 771                   (&optional localp no-error-if-not-filep))
 772
 773 ;;;###autoload
 774 (defun browse-url-of-dired-file ()
 775   "In Dired, ask a WWW browser to display the file named on this line."
 776   (interactive)
 777   (let ((tem (dired-get-filename t t)))
 778     (if tem
 779         (browse-url-of-file (expand-file-name tem))
 780       (error "No file on this line"))))
 781
 782 ;;;###autoload
 783 (defun browse-url-of-region (min max)
 784   "Ask a WWW browser to display the current region."
 785   (interactive "r")
 786   (save-excursion
 787     (save-restriction
 788       (narrow-to-region min max)
 789       (browse-url-of-buffer))))
 790
 791 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 792 ;; Browser-independent commands
 793
 794 ;; A generic command to call the current browse-url-browser-function
 795
 796 ;;;###autoload
 797 (defun browse-url (url &rest args)
 798   "Ask a WWW browser to load URL.
 799 Prompts for a URL, defaulting to the URL at or before point.  Variable
 800 `browse-url-browser-function' says which browser to use.
 801 If the URL is a mailto: URL, consult `browse-url-mailto-function'
 802 first, if that exists."
 803   (interactive (browse-url-interactive-arg "URL: "))
 804   (unless (called-interactively-p 'interactive)
 805     (setq args (or args (list browse-url-new-window-flag))))
 806   (let ((process-environment (copy-sequence process-environment))
 807         (function (or (and (string-match "\\`mailto:" url)
 808                            browse-url-mailto-function)
 809                       browse-url-browser-function))
 810         ;; Ensure that `default-directory' exists and is readable (b#6077).
 811         (default-directory (if (and (file-directory-p default-directory)
 812                                     (file-readable-p default-directory))
 813                                default-directory
 814                              (expand-file-name "~/"))))
 815     ;; When connected to various displays, be careful to use the display of
 816     ;; the currently selected frame, rather than the original start display,
 817     ;; which may not even exist any more.
 818     (if (stringp (frame-parameter (selected-frame) 'display))
 819         (setenv "DISPLAY" (frame-parameter (selected-frame) 'display)))
 820     (if (and (consp function)
 821              (not (functionp function)))
 822         ;; The `function' can be an alist; look down it for first match
 823         ;; and apply the function (which might be a lambda).
 824         (catch 'done
 825           (dolist (bf function)
 826             (when (string-match (car bf) url)
 827               (apply (cdr bf) url args)
 828               (throw 'done t)))
 829           (error "No browse-url-browser-function matching URL %s"
 830                  url))
 831       ;; Unbound symbols go down this leg, since void-function from
 832       ;; apply is clearer than wrong-type-argument from dolist.
 833       (apply function url args))))
 834
 835 ;;;###autoload
 836 (defun browse-url-at-point (&optional arg)
 837   "Ask a WWW browser to load the URL at or before point.
 838 Doesn't let you edit the URL like `browse-url'.  Variable
 839 `browse-url-browser-function' says which browser to use."
 840   (interactive "P")
 841   (let ((url (browse-url-url-at-point)))
 842     (if url
 843         (browse-url url (if arg
 844                             (not browse-url-new-window-flag)
 845                           browse-url-new-window-flag))
 846       (error "No URL found"))))
 847
 848 ;;;###autoload
 849 (defun browse-url-at-mouse (event)
 850   "Ask a WWW browser to load a URL clicked with the mouse.
 851 The URL is the one around or before the position of the mouse click
 852 but point is not changed.  Doesn't let you edit the URL like
 853 `browse-url'.  Variable `browse-url-browser-function' says which browser
 854 to use."
 855   (interactive "e")
 856   (save-excursion
 857     (mouse-set-point event)
 858     ;; This handles browse-url-new-window-flag properly
 859     ;; when it gets no arg.
 860     (browse-url-at-point)))
 861
 862 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 863 ;; Browser-specific commands
 864
 865 ;; --- Default MS-Windows browser ---
 866
 867 (defvar dos-windows-version)
 868 (declare-function w32-shell-execute "w32fns.c")    ;; Defined in C.
 869
 870 (defun browse-url-default-windows-browser (url &optional new-window)
 871   (interactive (browse-url-interactive-arg "URL: "))
 872   (cond ((eq system-type 'ms-dos)
 873          (if dos-windows-version
 874              (shell-command (concat "start " (shell-quote-argument url)))
 875            (error "Browsing URLs is not supported on this system")))
 876         ((eq system-type 'cygwin)
 877          (call-process "cygstart" nil nil nil url))
 878         (t (w32-shell-execute "open" url))))
 879
 880 (defun browse-url-default-macosx-browser (url &optional new-window)
 881   (interactive (browse-url-interactive-arg "URL: "))
 882   (start-process (concat "open " url) nil "open" url))
 883
 884 ;; --- Netscape ---
 885
 886 (defun browse-url-process-environment ()
 887   "Set DISPLAY in the environment to the X display the browser will use.
 888 This is either the value of variable `browse-url-browser-display' if
 889 non-nil, or the same display as Emacs if different from the current
 890 environment, otherwise just use the current environment."
 891   (let ((display (or browse-url-browser-display (browse-url-emacs-display))))
 892     (if display
 893         (cons (concat "DISPLAY=" display) process-environment)
 894       process-environment)))
 895
 896 (defun browse-url-emacs-display ()
 897   "Return the X display Emacs is running on.
 898 This is nil if the display is the same as the DISPLAY environment variable.
 899
 900 Actually Emacs could be using several displays; this just returns the
 901 one showing the selected frame."
 902   (let ((display (cdr-safe (assq 'display (frame-parameters)))))
 903     (and (not (equal display (getenv "DISPLAY")))
 904          display)))
 905
 906 (defun browse-url-default-browser (url &rest args)
 907   "Find a suitable browser and ask it to load URL.
 908 Default to the URL around or before point.
 909
 910 When called interactively, if variable `browse-url-new-window-flag' is
 911 non-nil, load the document in a new window, if possible, otherwise use
 912 a random existing one.  A non-nil interactive prefix argument reverses
 913 the effect of `browse-url-new-window-flag'.
 914
 915 When called non-interactively, optional second argument NEW-WINDOW is
 916 used instead of `browse-url-new-window-flag'."
 917   (apply
 918    (cond
 919     ((memq system-type '(windows-nt ms-dos cygwin))
 920      'browse-url-default-windows-browser)
 921     ((memq system-type '(darwin))
 922      'browse-url-default-macosx-browser)
 923     ((browse-url-can-use-xdg-open) 'browse-url-xdg-open)
 924     ((executable-find browse-url-gnome-moz-program) 'browse-url-gnome-moz)
 925     ((executable-find browse-url-mozilla-program) 'browse-url-mozilla)
 926     ((executable-find browse-url-firefox-program) 'browse-url-firefox)
 927     ((executable-find browse-url-chromium-program) 'browse-url-chromium)
 928     ((executable-find browse-url-galeon-program) 'browse-url-galeon)
 929     ((executable-find browse-url-kde-program) 'browse-url-kde)
 930     ((executable-find browse-url-netscape-program) 'browse-url-netscape)
 931     ((executable-find browse-url-mosaic-program) 'browse-url-mosaic)
 932     ((executable-find browse-url-xterm-program) 'browse-url-text-xterm)
 933     ((locate-library "w3") 'browse-url-w3)
 934     (t
 935      (lambda (&rest ignore) (error "No usable browser found"))))
 936    url args))
 937
 938 (defun browse-url-can-use-xdg-open ()
 939   "Return non-nil if the \"xdg-open\" program can be used.
 940 xdg-open is a desktop utility that calls your preferred web browser.
 941 This requires you to be running either Gnome, KDE, Xfce4 or LXDE."
 942   (and (getenv "DISPLAY")
 943        (executable-find "xdg-open")
 944        ;; xdg-open may call gnome-open and that does not wait for its child
 945        ;; to finish.  This child may then be killed when the parent dies.
 946        ;; Use nohup to work around.  See bug#7166, bug#8917, bug#9779 and
 947        ;; http://lists.gnu.org/archive/html/emacs-devel/2009-07/msg00279.html
 948        (executable-find "nohup")
 949        (or (getenv "GNOME_DESKTOP_SESSION_ID")
 950            ;; GNOME_DESKTOP_SESSION_ID is deprecated, check on Dbus also.
 951            (condition-case nil
 952                (eq 0 (call-process
 953                       "dbus-send" nil nil nil
 954                                   "--dest=org.gnome.SessionManager"
 955                                   "--print-reply"
 956                                   "/org/gnome/SessionManager"
 957                                   "org.gnome.SessionManager.CanShutdown"))
 958              (error nil))
 959            (equal (getenv "KDE_FULL_SESSION") "true")
 960            (condition-case nil
 961                (eq 0 (call-process
 962                       "/bin/sh" nil nil nil
 963                       "-c"
 964                       ;; FIXME use string-match rather than grep.
 965                       "xprop -root _DT_SAVE_MODE|grep xfce4"))
 966              (error nil))
 967            (member (getenv "DESKTOP_SESSION") '("LXDE" "Lubuntu"))
 968            (equal (getenv "XDG_CURRENT_DESKTOP") "LXDE"))))
 969
 970
 971 ;;;###autoload
 972 (defun browse-url-xdg-open (url &optional ignored)
 973   "Pass the specified URL to the \"xdg-open\" command.
 974 xdg-open is a desktop utility that calls your preferred web browser.
 975 The optional argument IGNORED is not used."
 976   (interactive (browse-url-interactive-arg "URL: "))
 977   (call-process "xdg-open" nil 0 nil url))
 978
 979 ;;;###autoload
 980 (defun browse-url-netscape (url &optional new-window)
 981   "Ask the Netscape WWW browser to load URL.
 982 Default to the URL around or before point.  The strings in variable
 983 `browse-url-netscape-arguments' are also passed to Netscape.
 984
 985 When called interactively, if variable `browse-url-new-window-flag' is
 986 non-nil, load the document in a new Netscape window, otherwise use a
 987 random existing one.  A non-nil interactive prefix argument reverses
 988 the effect of `browse-url-new-window-flag'.
 989
 990 If `browse-url-netscape-new-window-is-tab' is non-nil, then
 991 whenever a document would otherwise be loaded in a new window, it
 992 is loaded in a new tab in an existing window instead.
 993
 994 When called non-interactively, optional second argument NEW-WINDOW is
 995 used instead of `browse-url-new-window-flag'."
 996   (interactive (browse-url-interactive-arg "URL: "))
 997   (setq url (browse-url-encode-url url))
 998   (let* ((process-environment (browse-url-process-environment))
 999          (process
1000           (apply 'start-process
1001                  (concat "netscape " url) nil
1002                  browse-url-netscape-program
1003                  (append
1004                   browse-url-netscape-arguments
1005                   (if (eq window-system 'w32)
1006                       (list url)
1007                     (append
1008                      (if new-window '("-noraise"))
1009                      (list "-remote"
1010                            (concat "openURL(" url
1011                                    (if (browse-url-maybe-new-window
1012                                         new-window)
1013                                        (if browse-url-netscape-new-window-is-tab
1014                                            ",new-tab"
1015                                          ",new-window"))
1016                                    ")"))))))))
1017     (set-process-sentinel process
1018                           `(lambda (process change)
1019                              (browse-url-netscape-sentinel process ,url)))))
1020
1021 (defun browse-url-netscape-sentinel (process url)
1022   "Handle a change to the process communicating with Netscape."
1023   (or (eq (process-exit-status process) 0)
1024       (let* ((process-environment (browse-url-process-environment)))
1025         ;; Netscape not running - start it
1026         (message "Starting %s..." browse-url-netscape-program)
1027         (apply 'start-process (concat "netscape" url) nil
1028                browse-url-netscape-program
1029                (append browse-url-netscape-startup-arguments (list url))))))
1030
1031 (defun browse-url-netscape-reload ()
1032   "Ask Netscape to reload its current document.
1033 How depends on `browse-url-netscape-version'."
1034   (interactive)
1035   ;; Backwards incompatibility reported by
1036   ;; <peter.kruse@psychologie.uni-regensburg.de>.
1037   (browse-url-netscape-send (if (>= browse-url-netscape-version 4)
1038                                 "xfeDoCommand(reload)"
1039                               "reload")))
1040
1041 (defun browse-url-netscape-send (command)
1042   "Send a remote control command to Netscape."
1043   (let* ((process-environment (browse-url-process-environment)))
1044     (apply 'start-process "netscape" nil
1045            browse-url-netscape-program
1046            (append browse-url-netscape-arguments
1047                    (list "-remote" command)))))
1048
1049 ;;;###autoload
1050 (defun browse-url-mozilla (url &optional new-window)
1051   "Ask the Mozilla WWW browser to load URL.
1052 Default to the URL around or before point.  The strings in variable
1053 `browse-url-mozilla-arguments' are also passed to Mozilla.
1054
1055 When called interactively, if variable `browse-url-new-window-flag' is
1056 non-nil, load the document in a new Mozilla window, otherwise use a
1057 random existing one.  A non-nil interactive prefix argument reverses
1058 the effect of `browse-url-new-window-flag'.
1059
1060 If `browse-url-mozilla-new-window-is-tab' is non-nil, then whenever a
1061 document would otherwise be loaded in a new window, it is loaded in a
1062 new tab in an existing window instead.
1063
1064 When called non-interactively, optional second argument NEW-WINDOW is
1065 used instead of `browse-url-new-window-flag'."
1066   (interactive (browse-url-interactive-arg "URL: "))
1067   (setq url (browse-url-encode-url url))
1068   (let* ((process-environment (browse-url-process-environment))
1069          (process
1070           (apply 'start-process
1071                  (concat "mozilla " url) nil
1072                  browse-url-mozilla-program
1073                  (append
1074                   browse-url-mozilla-arguments
1075                   (list "-remote"
1076                         (concat "openURL("
1077                                 url
1078                                 (if (browse-url-maybe-new-window
1079                                      new-window)
1080                                     (if browse-url-mozilla-new-window-is-tab
1081                                         ",new-tab"
1082                                       ",new-window"))
1083                                 ")"))))))
1084     (set-process-sentinel process
1085                           `(lambda (process change)
1086                              (browse-url-mozilla-sentinel process ,url)))))
1087
1088 (defun browse-url-mozilla-sentinel (process url)
1089   "Handle a change to the process communicating with Mozilla."
1090   (or (eq (process-exit-status process) 0)
1091       (let* ((process-environment (browse-url-process-environment)))
1092         ;; Mozilla is not running - start it
1093         (message "Starting %s..." browse-url-mozilla-program)
1094         (apply 'start-process (concat "mozilla " url) nil
1095                browse-url-mozilla-program
1096                (append browse-url-mozilla-startup-arguments (list url))))))
1097
1098 ;;;###autoload
1099 (defun browse-url-firefox (url &optional new-window)
1100   "Ask the Firefox WWW browser to load URL.
1101 Default to the URL around or before point.  The strings in
1102 variable `browse-url-firefox-arguments' are also passed to
1103 Firefox.
1104
1105 When called interactively, if variable
1106 `browse-url-new-window-flag' is non-nil, load the document in a
1107 new Firefox window, otherwise use a random existing one.  A
1108 non-nil interactive prefix argument reverses the effect of
1109 `browse-url-new-window-flag'.
1110
1111 If `browse-url-firefox-new-window-is-tab' is non-nil, then
1112 whenever a document would otherwise be loaded in a new window, it
1113 is loaded in a new tab in an existing window instead.
1114
1115 When called non-interactively, optional second argument
1116 NEW-WINDOW is used instead of `browse-url-new-window-flag'.
1117
1118 On MS-Windows systems the optional `new-window' parameter is
1119 ignored.  Firefox for Windows does not support the \"-remote\"
1120 command line parameter.  Therefore, the
1121 `browse-url-new-window-flag' and `browse-url-firefox-new-window-is-tab'
1122 are ignored as well.  Firefox on Windows will always open the requested
1123 URL in a new window."
1124   (interactive (browse-url-interactive-arg "URL: "))
1125   (setq url (browse-url-encode-url url))
1126   (let* ((process-environment (browse-url-process-environment))
1127          (use-remote
1128           (not (memq system-type '(windows-nt ms-dos))))
1129          (process
1130           (apply 'start-process
1131                  (concat "firefox " url) nil
1132                  browse-url-firefox-program
1133                  (append
1134                   browse-url-firefox-arguments
1135                   (if use-remote
1136                       (list "-remote"
1137                             (concat
1138                              "openURL("
1139                              url
1140                              (if (browse-url-maybe-new-window new-window)
1141                                  (if browse-url-firefox-new-window-is-tab
1142                                      ",new-tab"
1143                                    ",new-window"))
1144                              ")"))
1145                     (list url))))))
1146     ;; If we use -remote, the process exits with status code 2 if
1147     ;; Firefox is not already running.  The sentinel runs firefox
1148     ;; directly if that happens.
1149     (when use-remote
1150       (set-process-sentinel process
1151                             `(lambda (process change)
1152                                (browse-url-firefox-sentinel process ,url))))))
1153
1154 (defun browse-url-firefox-sentinel (process url)
1155   "Handle a change to the process communicating with Firefox."
1156   (or (eq (process-exit-status process) 0)
1157       (let* ((process-environment (browse-url-process-environment)))
1158         ;; Firefox is not running - start it
1159         (message "Starting Firefox...")
1160         (apply 'start-process (concat "firefox " url) nil
1161                browse-url-firefox-program
1162                (append browse-url-firefox-startup-arguments (list url))))))
1163
1164 ;;;###autoload
1165 (defun browse-url-chromium (url &optional new-window)
1166   "Ask the Chromium WWW browser to load URL.
1167 Default to the URL around or before point.  The strings in
1168 variable `browse-url-chromium-arguments' are also passed to
1169 Chromium."
1170   (interactive (browse-url-interactive-arg "URL: "))
1171   (setq url (browse-url-encode-url url))
1172   (let* ((process-environment (browse-url-process-environment)))
1173     (apply 'start-process
1174            (concat "chromium " url) nil
1175            browse-url-chromium-program
1176            (append
1177             browse-url-chromium-arguments
1178             (list url)))))
1179
1180 ;;;###autoload
1181 (defun browse-url-galeon (url &optional new-window)
1182   "Ask the Galeon WWW browser to load URL.
1183 Default to the URL around or before point.  The strings in variable
1184 `browse-url-galeon-arguments' are also passed to Galeon.
1185
1186 When called interactively, if variable `browse-url-new-window-flag' is
1187 non-nil, load the document in a new Galeon window, otherwise use a
1188 random existing one.  A non-nil interactive prefix argument reverses
1189 the effect of `browse-url-new-window-flag'.
1190
1191 If `browse-url-galeon-new-window-is-tab' is non-nil, then whenever a
1192 document would otherwise be loaded in a new window, it is loaded in a
1193 new tab in an existing window instead.
1194
1195 When called non-interactively, optional second argument NEW-WINDOW is
1196 used instead of `browse-url-new-window-flag'."
1197   (interactive (browse-url-interactive-arg "URL: "))
1198   (setq url (browse-url-encode-url url))
1199   (let* ((process-environment (browse-url-process-environment))
1200          (process (apply 'start-process
1201                          (concat "galeon " url)
1202                          nil
1203                          browse-url-galeon-program
1204                          (append
1205                           browse-url-galeon-arguments
1206                           (if (browse-url-maybe-new-window new-window)
1207                               (if browse-url-galeon-new-window-is-tab
1208                                   '("--new-tab")
1209                                 '("--new-window" "--noraise"))
1210                             '("--existing"))
1211                           (list url)))))
1212     (set-process-sentinel process
1213                           `(lambda (process change)
1214                              (browse-url-galeon-sentinel process ,url)))))
1215
1216 (defun browse-url-galeon-sentinel (process url)
1217   "Handle a change to the process communicating with Galeon."
1218   (or (eq (process-exit-status process) 0)
1219       (let* ((process-environment (browse-url-process-environment)))
1220         ;; Galeon is not running - start it
1221         (message "Starting %s..." browse-url-galeon-program)
1222         (apply 'start-process (concat "galeon " url) nil
1223                browse-url-galeon-program
1224                (append browse-url-galeon-startup-arguments (list url))))))
1225
1226 (defun browse-url-epiphany (url &optional new-window)
1227   "Ask the Epiphany WWW browser to load URL.
1228 Default to the URL around or before point.  The strings in variable
1229 `browse-url-galeon-arguments' are also passed to Epiphany.
1230
1231 When called interactively, if variable `browse-url-new-window-flag' is
1232 non-nil, load the document in a new Epiphany window, otherwise use a
1233 random existing one.  A non-nil interactive prefix argument reverses
1234 the effect of `browse-url-new-window-flag'.
1235
1236 If `browse-url-epiphany-new-window-is-tab' is non-nil, then whenever a
1237 document would otherwise be loaded in a new window, it is loaded in a
1238 new tab in an existing window instead.
1239
1240 When called non-interactively, optional second argument NEW-WINDOW is
1241 used instead of `browse-url-new-window-flag'."
1242   (interactive (browse-url-interactive-arg "URL: "))
1243   (setq url (browse-url-encode-url url))
1244   (let* ((process-environment (browse-url-process-environment))
1245          (process (apply 'start-process
1246                          (concat "epiphany " url)
1247                          nil
1248                          browse-url-epiphany-program
1249                          (append
1250                           browse-url-epiphany-arguments
1251                           (if (browse-url-maybe-new-window new-window)
1252                               (if browse-url-epiphany-new-window-is-tab
1253                                   '("--new-tab")
1254                                 '("--new-window" "--noraise"))
1255                             '("--existing"))
1256                           (list url)))))
1257     (set-process-sentinel process
1258                           `(lambda (process change)
1259                              (browse-url-epiphany-sentinel process ,url)))))
1260
1261 (defun browse-url-epiphany-sentinel (process url)
1262   "Handle a change to the process communicating with Epiphany."
1263   (or (eq (process-exit-status process) 0)
1264       (let* ((process-environment (browse-url-process-environment)))
1265         ;; Epiphany is not running - start it
1266         (message "Starting %s..." browse-url-epiphany-program)
1267         (apply 'start-process (concat "epiphany " url) nil
1268                browse-url-epiphany-program
1269                (append browse-url-epiphany-startup-arguments (list url))))))
1270
1271 (defvar url-handler-regexp)
1272
1273 ;;;###autoload
1274 (defun browse-url-emacs (url &optional new-window)
1275   "Ask Emacs to load URL into a buffer and show it in another window."
1276   (interactive (browse-url-interactive-arg "URL: "))
1277   (require 'url-handlers)
1278   (let ((file-name-handler-alist
1279          (cons (cons url-handler-regexp 'url-file-handler)
1280                file-name-handler-alist)))
1281     ;; Ignore `new-window': with all other browsers the URL is always shown
1282     ;; in another window than the current Emacs one since it's shown in
1283     ;; another application's window.
1284     ;; (if new-window (find-file-other-window url) (find-file url))
1285     (find-file-other-window url)))
1286
1287 ;;;###autoload
1288 (defun browse-url-gnome-moz (url &optional new-window)
1289   "Ask Mozilla/Netscape to load URL via the GNOME program `gnome-moz-remote'.
1290 Default to the URL around or before point.  The strings in variable
1291 `browse-url-gnome-moz-arguments' are also passed.
1292
1293 When called interactively, if variable `browse-url-new-window-flag' is
1294 non-nil, load the document in a new browser window, otherwise use an
1295 existing one.  A non-nil interactive prefix argument reverses the
1296 effect of `browse-url-new-window-flag'.
1297
1298 When called non-interactively, optional second argument NEW-WINDOW is
1299 used instead of `browse-url-new-window-flag'."
1300   (interactive (browse-url-interactive-arg "URL: "))
1301   (apply 'start-process (concat "gnome-moz-remote " url)
1302          nil
1303          browse-url-gnome-moz-program
1304          (append
1305           browse-url-gnome-moz-arguments
1306           (if (browse-url-maybe-new-window new-window)
1307               '("--newwin"))
1308           (list "--raise" url))))
1309
1310 ;; --- Mosaic ---
1311
1312 ;;;###autoload
1313 (defun browse-url-mosaic (url &optional new-window)
1314   "Ask the XMosaic WWW browser to load URL.
1315
1316 Default to the URL around or before point.  The strings in variable
1317 `browse-url-mosaic-arguments' are also passed to Mosaic and the
1318 program is invoked according to the variable
1319 `browse-url-mosaic-program'.
1320
1321 When called interactively, if variable `browse-url-new-window-flag' is
1322 non-nil, load the document in a new Mosaic window, otherwise use a
1323 random existing one.  A non-nil interactive prefix argument reverses
1324 the effect of `browse-url-new-window-flag'.
1325
1326 When called non-interactively, optional second argument NEW-WINDOW is
1327 used instead of `browse-url-new-window-flag'."
1328   (interactive (browse-url-interactive-arg "Mosaic URL: "))
1329   (let ((pidfile (expand-file-name browse-url-mosaic-pidfile))
1330         pid)
1331     (if (file-readable-p pidfile)
1332         (save-excursion
1333           (find-file pidfile)
1334           (goto-char (point-min))
1335           (setq pid (read (current-buffer)))
1336           (kill-buffer nil)))
1337     (if (and pid (zerop (signal-process pid 0))) ; Mosaic running
1338         (save-excursion
1339           (find-file (format "/tmp/Mosaic.%d" pid))
1340           (erase-buffer)
1341           (insert (if (browse-url-maybe-new-window new-window)
1342                       "newwin\n"
1343                     "goto\n")
1344                   url "\n")
1345           (save-buffer)
1346           (kill-buffer nil)
1347           ;; Send signal SIGUSR to Mosaic
1348           (message "Signaling Mosaic...")
1349           (signal-process pid 'SIGUSR1)
1350           ;; Or you could try:
1351           ;; (call-process "kill" nil 0 nil "-USR1" (int-to-string pid))
1352           (message "Signaling Mosaic...done")
1353           )
1354       ;; Mosaic not running - start it
1355       (message "Starting %s..." browse-url-mosaic-program)
1356       (apply 'start-process "xmosaic" nil browse-url-mosaic-program
1357              (append browse-url-mosaic-arguments (list url)))
1358       (message "Starting %s...done" browse-url-mosaic-program))))
1359
1360 ;; --- Mosaic using CCI ---
1361
1362 ;;;###autoload
1363 (defun browse-url-cci (url &optional new-window)
1364   "Ask the XMosaic WWW browser to load URL.
1365 Default to the URL around or before point.
1366
1367 This function only works for XMosaic version 2.5 or later.  You must
1368 select `CCI' from XMosaic's File menu, set the CCI Port Address to the
1369 value of variable `browse-url-CCI-port', and enable `Accept requests'.
1370
1371 When called interactively, if variable `browse-url-new-window-flag' is
1372 non-nil, load the document in a new browser window, otherwise use a
1373 random existing one.  A non-nil interactive prefix argument reverses
1374 the effect of `browse-url-new-window-flag'.
1375
1376 When called non-interactively, optional second argument NEW-WINDOW is
1377 used instead of `browse-url-new-window-flag'."
1378   (interactive (browse-url-interactive-arg "Mosaic URL: "))
1379   (open-network-stream "browse-url" " *browse-url*"
1380                        browse-url-CCI-host browse-url-CCI-port)
1381   ;; Todo: start browser if fails
1382   (process-send-string "browse-url"
1383                        (concat "get url (" url ") output "
1384                                (if (browse-url-maybe-new-window new-window)
1385                                    "new"
1386                                  "current")
1387                                "\r\n"))
1388   (process-send-string "browse-url" "disconnect\r\n")
1389   (delete-process "browse-url"))
1390
1391 ;; --- W3 ---
1392
1393 ;; External.
1394 (declare-function w3-fetch-other-window "ext:w3m" (&optional url))
1395 (declare-function w3-fetch              "ext:w3m" (&optional url target))
1396
1397 ;;;###autoload
1398 (defun browse-url-w3 (url &optional new-window)
1399   "Ask the w3 WWW browser to load URL.
1400 Default to the URL around or before point.
1401
1402 When called interactively, if variable `browse-url-new-window-flag' is
1403 non-nil, load the document in a new window.  A non-nil interactive
1404 prefix argument reverses the effect of `browse-url-new-window-flag'.
1405
1406 When called non-interactively, optional second argument NEW-WINDOW is
1407 used instead of `browse-url-new-window-flag'."
1408   (interactive (browse-url-interactive-arg "W3 URL: "))
1409   (require 'w3)                 ; w3-fetch-other-window not autoloaded
1410   (if (browse-url-maybe-new-window new-window)
1411       (w3-fetch-other-window url)
1412     (w3-fetch url)))
1413
1414 ;;;###autoload
1415 (defun browse-url-w3-gnudoit (url &optional new-window)
1416   ;; new-window ignored
1417   "Ask another Emacs running gnuserv to load the URL using the W3 browser.
1418 The `browse-url-gnudoit-program' program is used with options given by
1419 `browse-url-gnudoit-args'.  Default to the URL around or before point."
1420   (interactive (browse-url-interactive-arg "W3 URL: "))
1421   (apply 'start-process (concat "gnudoit:" url) nil
1422          browse-url-gnudoit-program
1423          (append browse-url-gnudoit-args
1424                  (list (concat "(w3-fetch \"" url "\")")
1425                        "(raise-frame)"))))
1426
1427 ;; --- Lynx in an xterm ---
1428
1429 ;;;###autoload
1430 (defun browse-url-text-xterm (url &optional new-window)
1431   ;; new-window ignored
1432   "Ask a text browser to load URL.
1433 URL defaults to the URL around or before point.
1434 This runs the text browser specified by `browse-url-text-browser'.
1435 in an Xterm window using the Xterm program named by `browse-url-xterm-program'
1436 with possible additional arguments `browse-url-xterm-args'."
1437   (interactive (browse-url-interactive-arg "Text browser URL: "))
1438   (apply #'start-process `(,(concat browse-url-text-browser url)
1439                            nil ,browse-url-xterm-program
1440                            ,@browse-url-xterm-args "-e" ,browse-url-text-browser
1441                            ,url)))
1442
1443 ;; --- Lynx in an Emacs "term" window ---
1444
1445 (declare-function term-char-mode "term" ())
1446 (declare-function term-send-down "term" ())
1447 (declare-function term-send-string "term" (proc str))
1448
1449 ;;;###autoload
1450 (defun browse-url-text-emacs (url &optional new-buffer)
1451   "Ask a text browser to load URL.
1452 URL defaults to the URL around or before point.
1453 This runs the text browser specified by `browse-url-text-browser'.
1454 With a prefix argument, it runs a new browser process in a new buffer.
1455
1456 When called interactively, if variable `browse-url-new-window-flag' is
1457 non-nil, load the document in a new browser process in a new term window,
1458 otherwise use any existing one.  A non-nil interactive prefix argument
1459 reverses the effect of `browse-url-new-window-flag'.
1460
1461 When called non-interactively, optional second argument NEW-WINDOW is
1462 used instead of `browse-url-new-window-flag'."
1463   (interactive (browse-url-interactive-arg "Text browser URL: "))
1464   (let* ((system-uses-terminfo t)     ; Lynx uses terminfo
1465          ;; (term-term-name "vt100") ; ??
1466          (buf (get-buffer "*text browser*"))
1467          (proc (and buf (get-buffer-process buf)))
1468          (n browse-url-text-input-attempts))
1469     (require 'term)
1470     (if (and (browse-url-maybe-new-window new-buffer) buf)
1471         ;; Rename away the OLD buffer. This isn't very polite, but
1472         ;; term insists on working in a buffer named *lynx* and would
1473         ;; choke on *lynx*<1>
1474         (progn (set-buffer buf)
1475                (rename-uniquely)))
1476     (if (or (browse-url-maybe-new-window new-buffer)
1477             (not buf)
1478             (not proc)
1479             (not (memq (process-status proc) '(run stop))))
1480         ;; start a new text browser
1481         (progn
1482           (setq buf
1483                 (apply #'make-term
1484                        `(,browse-url-text-browser
1485                          ,browse-url-text-browser
1486                          nil ,@browse-url-text-emacs-args
1487                          ,url)))
1488           (switch-to-buffer buf)
1489           (term-char-mode)
1490           (set-process-sentinel
1491            (get-buffer-process buf)
1492            ;; Don't leave around a dead one (especially because of its
1493            ;; munged keymap.)
1494            (lambda (process event)
1495              (if (not (memq (process-status process) '(run stop)))
1496                  (let ((buf (process-buffer process)))
1497                    (if buf (kill-buffer buf)))))))
1498       ;; Send the url to the text browser in the old buffer
1499       (let ((win (get-buffer-window buf t)))
1500         (if win
1501             (select-window win)
1502           (switch-to-buffer buf)))
1503       (if (eq (following-char) ?_)
1504           (cond ((eq browse-url-text-input-field 'warn)
1505                  (error "Please move out of the input field first"))
1506                 ((eq browse-url-text-input-field 'avoid)
1507                  (while (and (eq (following-char) ?_) (> n 0))
1508                    (term-send-down)     ; down arrow
1509                    (sit-for browse-url-text-input-delay))
1510                  (if (eq (following-char) ?_)
1511                      (error "Cannot move out of the input field, sorry")))))
1512       (term-send-string proc (concat "g"    ; goto
1513                                      "\C-u" ; kill default url
1514                                      url
1515                                      "\r")))))
1516
1517 ;; --- mailto ---
1518
1519 (autoload 'rfc2368-parse-mailto-url "rfc2368")
1520
1521 ;;;###autoload
1522 (defun browse-url-mail (url &optional new-window)
1523   "Open a new mail message buffer within Emacs for the RFC 2368 URL.
1524 Default to using the mailto: URL around or before point as the
1525 recipient's address.  Supplying a non-nil interactive prefix argument
1526 will cause the mail to be composed in another window rather than the
1527 current one.
1528
1529 When called interactively, if variable `browse-url-new-window-flag' is
1530 non-nil use `compose-mail-other-window', otherwise `compose-mail'.  A
1531 non-nil interactive prefix argument reverses the effect of
1532 `browse-url-new-window-flag'.
1533
1534 When called non-interactively, optional second argument NEW-WINDOW is
1535 used instead of `browse-url-new-window-flag'."
1536   (interactive (browse-url-interactive-arg "Mailto URL: "))
1537   (save-excursion
1538     (let* ((alist (rfc2368-parse-mailto-url url))
1539            (to (assoc "To" alist))
1540            (subject (assoc "Subject" alist))
1541            (body (assoc "Body" alist))
1542            (rest (delq to (delq subject (delq body alist))))
1543            (to (cdr to))
1544            (subject (cdr subject))
1545            (body (cdr body))
1546            (mail-citation-hook (unless body mail-citation-hook)))
1547       (if (browse-url-maybe-new-window new-window)
1548           (compose-mail-other-window to subject rest nil
1549                                      (list 'insert-buffer (current-buffer)))
1550         (compose-mail to subject rest nil nil
1551                       (list 'insert-buffer (current-buffer))))
1552       (when body
1553         (goto-char (point-min))
1554         (unless (or (search-forward (concat "\n" mail-header-separator "\n")
1555                                     nil 'move)
1556                     (bolp))
1557           (insert "\n"))
1558         (goto-char (prog1
1559                        (point)
1560                      (insert (replace-regexp-in-string "\r\n" "\n" body))
1561                      (unless (bolp)
1562                        (insert "\n"))))))))
1563
1564 ;; --- Random browser ---
1565
1566 ;;;###autoload
1567 (defun browse-url-generic (url &optional new-window)
1568   ;; new-window ignored
1569   "Ask the WWW browser defined by `browse-url-generic-program' to load URL.
1570 Default to the URL around or before point.  A fresh copy of the
1571 browser is started up in a new process with possible additional arguments
1572 `browse-url-generic-args'.  This is appropriate for browsers which
1573 don't offer a form of remote control."
1574   (interactive (browse-url-interactive-arg "URL: "))
1575   (if (not browse-url-generic-program)
1576       (error "No browser defined (`browse-url-generic-program')"))
1577   (apply 'call-process browse-url-generic-program nil
1578          0 nil
1579          (append browse-url-generic-args (list url))))
1580
1581 ;;;###autoload
1582 (defun browse-url-kde (url &optional new-window)
1583   "Ask the KDE WWW browser to load URL.
1584 Default to the URL around or before point."
1585   (interactive (browse-url-interactive-arg "KDE URL: "))
1586   (message "Sending URL to KDE...")
1587   (apply #'start-process (concat "KDE " url) nil browse-url-kde-program
1588          (append browse-url-kde-args (list url))))
1589
1590 (defun browse-url-elinks-new-window (url)
1591   "Ask the Elinks WWW browser to load URL in a new window."
1592   (let ((process-environment (browse-url-process-environment)))
1593     (apply #'start-process
1594            (append (list (concat "elinks:" url)
1595                          nil)
1596                    browse-url-elinks-wrapper
1597                    (list "elinks" url)))))
1598
1599 ;;;###autoload
1600 (defun browse-url-elinks (url &optional new-window)
1601   "Ask the Elinks WWW browser to load URL.
1602 Default to the URL around the point.
1603
1604 The document is loaded in a new tab of a running Elinks or, if
1605 none yet running, a newly started instance.
1606
1607 The Elinks command will be prepended by the program+arguments
1608 from `browse-url-elinks-wrapper'."
1609   (interactive (browse-url-interactive-arg "URL: "))
1610   (setq url (browse-url-encode-url url))
1611   (if new-window
1612       (browse-url-elinks-new-window url)
1613     (let ((process-environment (browse-url-process-environment))
1614           (elinks-ping-process (start-process "elinks-ping" nil
1615                                               "elinks" "-remote" "ping()")))
1616       (set-process-sentinel elinks-ping-process
1617                             `(lambda (process change)
1618                                (browse-url-elinks-sentinel process ,url))))))
1619
1620 (defun browse-url-elinks-sentinel (process url)
1621   "Determines if Elinks is running or a new one has to be started."
1622   ;; Try to determine if an instance is running or if we have to
1623   ;; create a new one.
1624   (pcase (process-exit-status process)
1625     (5
1626      ;; No instance, start a new one.
1627      (browse-url-elinks-new-window url))
1628     (0
1629      ;; Found an instance, open URL in new tab.
1630      (let ((process-environment (browse-url-process-environment)))
1631        (start-process (concat "elinks:" url) nil
1632                       "elinks" "-remote"
1633                       (concat "openURL(\"" url "\",new-tab)"))))
1634     (exit-status
1635      (error "Unrecognized exit-code %d of process `elinks'"
1636             exit-status))))
1637
1638 (provide 'browse-url)
1639
1640 ;;; browse-url.el ends here