elpher.el

   1 ;;; elpher.el --- A friendly gopher and gemini client  -*- lexical-binding: t -*-
   2
   3 ;; Copyright (C) 2019-2022 Tim Vaughan <plugd@thelambdalab.xyz>
   4 ;; Copyright (C) 2020-2022 Elpher contributors (See info manual for full list)
   5
   6 ;; Author: Tim Vaughan <plugd@thelambdalab.xyz>
   7 ;; Created: 11 April 2019
   8 ;; Version: 3.4.2
   9 ;; Keywords: comm gopher
  10 ;; Homepage: https://thelambdalab.xyz/elpher
  11 ;; Package-Requires: ((emacs "27.1"))
  12
  13 ;; This file is not part of GNU Emacs.
  14
  15 ;; This program is free software: you can redistribute it and/or modify
  16 ;; it under the terms of the GNU General Public License as published by
  17 ;; the Free Software Foundation, either version 3 of the License, or
  18 ;; (at your option) any later version.
  19
  20 ;; This program is distributed in the hope that it will be useful,
  21 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  22 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  23 ;; GNU General Public License for more details.
  24
  25 ;; You should have received a copy of the GNU General Public License
  26 ;; along with this file.  If not, see <http://www.gnu.org/licenses/>.
  27
  28 ;;; Commentary:
  29
  30 ;; Elpher aims to provide a practical and friendly gopher and gemini
  31 ;; client for GNU Emacs.  It supports:
  32
  33 ;; - intuitive keyboard and mouse-driven browsing,
  34 ;; - out-of-the-box compatibility with evil-mode,
  35 ;; - clickable web and gopher links *in plain text*,
  36 ;; - caching of visited sites,
  37 ;; - pleasant and configurable colouring of Gopher directories,
  38 ;; - direct visualisation of image files,
  39 ;; - gopher connections using TLS encryption,
  40 ;; - the fledgling Gemini protocol,
  41 ;; - the greybeard Finger protocol.
  42
  43 ;; To launch Elpher, simply use 'M-x elpher'.  This will open a start
  44 ;; page containing information on key bindings and suggested starting
  45 ;; points for your gopher exploration.
  46
  47 ;; Full instructions can be found in the Elpher info manual.
  48
  49 ;; Elpher is under active development.  Any suggestions for
  50 ;; improvements are welcome, and can be made on the official project
  51 ;; page, gopher://thelambdalab.xyz/1/projects/elpher, or via the
  52 ;; project mailing list at https://lists.sr.ht/~michel-slm/elpher.
  53
  54 ;;; Code:
  55
  56 (provide 'elpher)
  57
  58 ;;; Dependencies
  59 ;;
  60
  61 (require 'seq)
  62 (require 'shr)
  63 (require 'url-util)
  64 (require 'subr-x)
  65 (require 'nsm)
  66 (require 'gnutls)
  67 (require 'socks)
  68 (require 'bookmark)
  69 (require 'rx)
  70
  71 ;;; Global constants
  72 ;;
  73
  74 (defconst elpher-version "3.4.2"
  75   "Current version of elpher.")
  76
  77 (defconst elpher-margin-width 6
  78   "Width of left-hand margin used when rendering indicies.")
  79
  80 (defconst elpher-type-map
  81   '(((gopher ?0) elpher-get-gopher-page elpher-render-text "txt" elpher-text)
  82     ((gopher ?1) elpher-get-gopher-page elpher-render-index "/" elpher-index)
  83     ((gopher ?4) elpher-get-gopher-page elpher-render-download "bin" elpher-binary)
  84     ((gopher ?5) elpher-get-gopher-page elpher-render-download "bin" elpher-binary)
  85     ((gopher ?7) elpher-get-gopher-query-page elpher-render-index "?" elpher-search)
  86     ((gopher ?9) elpher-get-gopher-page elpher-render-download "bin" elpher-binary)
  87     ((gopher ?g) elpher-get-gopher-page elpher-render-image "img" elpher-image)
  88     ((gopher ?p) elpher-get-gopher-page elpher-render-image "img" elpher-image)
  89     ((gopher ?I) elpher-get-gopher-page elpher-render-image "img" elpher-image)
  90     ((gopher ?d) elpher-get-gopher-page elpher-render-download "doc" elpher-binary)
  91     ((gopher ?P) elpher-get-gopher-page elpher-render-download "doc" elpher-binary)
  92     ((gopher ?s) elpher-get-gopher-page elpher-render-download "snd" elpher-binary)
  93     ((gopher ?h) elpher-get-gopher-page elpher-render-html "htm" elpher-html)
  94     (gemini elpher-get-gemini-page elpher-render-gemini "gem" elpher-gemini)
  95     (finger elpher-get-finger-page elpher-render-text "txt" elpher-text)
  96     (telnet elpher-get-telnet-page nil "tel" elpher-telnet)
  97     (other-url elpher-get-other-url-page nil "url" elpher-other-url)
  98     (file elpher-get-file-page nil "~" elpher-gemini)
  99     ((about welcome) elpher-get-welcome-page nil "E" elpher-index)
 100     ((about bookmarks) elpher-get-bookmarks-page nil "E" elpher-index)
 101     ((about history) elpher-get-history-page nil "E" elpher-index)
 102     ((about visited-pages) elpher-get-visited-pages-page nil "E" elpher-index))
 103   "Association list from types to getters, renderers, margin codes and index faces.")
 104
 105
 106 ;;; Declarations to avoid compiler warnings.
 107 ;;
 108
 109 (eval-when-compile
 110   (declare-function ansi-color-filter-apply "ansi-color")
 111   (declare-function ansi-color-apply "ansi-color")
 112   (declare-function bookmark-store "bookmark")
 113   (declare-function org-link-store-props "ol")
 114   (declare-function org-link-set-parameters "ol")
 115   (defvar ansi-color-context)
 116   (defvar xterm-color--current-fg)
 117   (defvar xterm-color--current-bg)
 118   (defvar bookmark-make-record-function)
 119   (defvar mu4e~view-beginning-of-url-regexp)
 120   (defvar eww-use-browse-url)
 121   (defvar thing-at-point-uri-schemes))
 122
 123
 124 ;;; Customization group
 125 ;;
 126
 127 (defgroup elpher nil
 128   "A gopher and gemini client."
 129   :group 'applications)
 130
 131 ;; General appearance and customizations
 132
 133 (defcustom elpher-open-urls-with-eww nil
 134   "If non-nil, open URL selectors using eww.
 135 Otherwise, use the system browser via the `browse-url' function."
 136   :type '(boolean))
 137
 138 (defcustom elpher-use-header t
 139   "If non-nil, display current page information in buffer header."
 140   :type '(boolean))
 141
 142 (defcustom elpher-auto-disengage-TLS nil
 143   "If non-nil, automatically disengage TLS following an unsuccessful connection.
 144 While enabling this may seem convenient, it is also potentially
 145 dangerous as it allows switching from an encrypted channel back to
 146 plain text without user input."
 147   :type '(boolean))
 148
 149 (defcustom elpher-connection-timeout 5
 150   "Specifies the number of seconds to wait for a network connection to time out."
 151   :type '(integer))
 152
 153 (defcustom elpher-filter-ansi-from-text nil
 154   "If non-nil, filter ANSI escape sequences from text.
 155 The default behaviour is to use the ansi-color package (or xterm-color if it is
 156 available) to interpret these sequences."
 157   :type '(boolean))
 158
 159 (defcustom elpher-certificate-directory
 160   (file-name-as-directory (locate-user-emacs-file "elpher-certificates"))
 161   "Specify the name of the directory where client certificates will be stored.
 162 These certificates may be used for establishing authenticated TLS connections."
 163   :type '(directory))
 164
 165 (defcustom elpher-openssl-command "openssl"
 166   "The command used to launch openssl when generating TLS client certificates."
 167   :type '(file))
 168
 169 (defcustom elpher-default-url-type "gopher"
 170   "Default URL type (i.e. scheme) to assume if not explicitly given."
 171   :type '(choice (const "gopher")
 172                  (const "gemini")))
 173
 174 (defcustom elpher-gemini-TLS-cert-checks nil
 175   "If non-nil, verify gemini server TLS certs using the default security level.
 176 Otherwise, certificate verification is disabled.
 177
 178 This defaults to off because it is standard practice for Gemini servers
 179 to use self-signed certificates, meaning that most servers provide what
 180 EMACS considers to be an invalid certificate."
 181   :type '(boolean))
 182
 183 (defcustom elpher-gemini-max-fill-width 80
 184   "Specify the maximum default width (in columns) of text/gemini documents.
 185 The actual width used is the minimum of this value and the window width at
 186 the time when the text is rendered."
 187   :type '(integer))
 188
 189 (defcustom elpher-gemini-link-string "→ "
 190   "Specify the string used to indicate links when rendering gemini maps.
 191 May be empty."
 192   :type '(string))
 193
 194 (defcustom elpher-gemini-bullet-string "•"
 195   "Specify the string used for bullets when rendering gemini maps."
 196   :type '(string))
 197
 198 (defcustom elpher-ipv4-always nil
 199   "If non-nil, elpher will always use IPv4 to establish network connections.
 200 This can be useful when browsing from a computer that supports IPv6, because
 201 some servers which do not support IPv6 can take a long time to time-out."
 202   :type '(boolean))
 203
 204 (defcustom elpher-socks-always nil
 205   "If non-nil, elpher will establish network connections over a SOCKS proxy.
 206 Otherwise, the SOCKS proxy is only used for connections to onion services."
 207   :type '(boolean))
 208
 209 (defcustom elpher-use-emacs-bookmark-menu nil
 210   "If non-nil, elpher will only use the native Emacs bookmark menu.
 211 Otherwise, \\[elpher-show-bookmarks] will visit a special elpher bookmark
 212 page within which all of the standard elpher keybindings are active."
 213   :type '(boolean))
 214
 215 (defcustom elpher-start-page-url "about:welcome"
 216   "Specify the page displayed initially by elpher.
 217 The default welcome screen is \"about:welcome\", while the bookmarks list
 218 is \"about:bookmarks\".  You can also specify local files via \"file:\".
 219
 220 Beware that using \"about:bookmarks\" as a start page in combination with
 221 the `elpher-use-bookmark-menu' variable set to non-nil will prevent the
 222 Emacs bookmark menu being accessible via \\[elpher-show-bookmarks] from
 223 the start page."
 224   :type '(string))
 225
 226 (defcustom elpher-gemini-hide-preformatted nil
 227   "Cause elpher to hide preformatted gemini text by default.
 228 When this option is enabled, preformatted text in text/gemini documents
 229 is replaced with a button which can be used to toggle its display.
 230
 231 This is intended to improve accessibility, as preformatted text often
 232 includes art which can be difficult for screen readers to interpret
 233 meaningfully."
 234   :type '(boolean))
 235
 236 (defcustom elpher-gemini-preformatted-toggle-bullet "‣ "
 237   "Margin symbol used to distinguish the preformatted text toggle."
 238   :type '(string))
 239
 240 (defcustom elpher-gemini-preformatted-toggle-label "[Toggle Preformatted Text]"
 241   "Label of button used to toggle formatted text."
 242   :type '(string))
 243
 244 ;; Face customizations
 245
 246 (defgroup elpher-faces nil
 247   "Elpher face customizations."
 248   :group 'elpher)
 249
 250 (defface elpher-index
 251   '((t :inherit font-lock-keyword-face))
 252   "Face used for directory type directory records.")
 253
 254 (defface elpher-text
 255   '((t :inherit bold))
 256   "Face used for text type directory records.")
 257
 258 (defface elpher-info
 259   '((t :inherit default))
 260   "Face used for info type directory records.")
 261
 262 (defface elpher-image
 263   '((t :inherit font-lock-string-face))
 264   "Face used for image type directory records.")
 265
 266 (defface elpher-search
 267   '((t :inherit warning))
 268   "Face used for search type directory records.")
 269
 270 (defface elpher-html
 271   '((t :inherit font-lock-comment-face))
 272   "Face used for html type directory records.")
 273
 274 (defface elpher-gemini
 275   '((t :inherit font-lock-constant-face))
 276   "Face used for Gemini type directory records.")
 277
 278 (defface elpher-other-url
 279   '((t :inherit font-lock-comment-face))
 280   "Face used for other URL type links records.")
 281
 282 (defface elpher-telnet
 283   '((t :inherit font-lock-function-name-face))
 284   "Face used for telnet type directory records.")
 285
 286 (defface elpher-binary
 287   '((t :inherit font-lock-doc-face))
 288   "Face used for binary type directory records.")
 289
 290 (defface elpher-unknown
 291   '((t :inherit error))
 292   "Face used for directory records with unknown/unsupported types.")
 293
 294 (defface elpher-margin-key
 295   '((t :inherit bold))
 296   "Face used for directory margin key.")
 297
 298 (defface elpher-margin-brackets
 299   '((t :inherit shadow))
 300   "Face used for brackets around directory margin key.")
 301
 302 (defface elpher-gemini-heading1
 303   '((t :inherit bold :height 1.8))
 304   "Face used for gemini heading level 1.")
 305
 306 (defface elpher-gemini-heading2
 307   '((t :inherit bold :height 1.5))
 308   "Face used for gemini heading level 2.")
 309
 310 (defface elpher-gemini-heading3
 311   '((t :inherit bold :height 1.2))
 312   "Face used for gemini heading level 3.")
 313
 314 (defface elpher-gemini-quoted
 315   '((t :inherit font-lock-doc-face))
 316   "Face used for gemini quoted texts.")
 317
 318 (defface elpher-gemini-preformatted
 319   '((t :inherit default))
 320   "Face used for gemini preformatted text.")
 321
 322 (defface elpher-gemini-preformatted-toggle
 323   '((t :inherit button))
 324   "Face used for buttons used to toggle display of preformatted text.")
 325
 326 ;;; Model
 327 ;;
 328
 329 ;; Address
 330
 331 ;; An elpher "address" object is either a url object or a symbol.
 332 ;; Addresses with the "about" type, corresponding to pages generated
 333 ;; dynamically for and by elpher.  All others represent pages which
 334 ;; rely on content retrieved over the network.
 335
 336 (defun elpher-address-from-url (url-string &optional default-scheme)
 337   "Create a ADDRESS object corresponding to the given URL-STRING.
 338 If DEFAULT-SCHEME is non-nil, this sets the scheme of the URL when one
 339 is not explicitly given."
 340   (let ((data (match-data))) ; Prevent parsing clobbering match data
 341     (unwind-protect
 342         (let ((url (url-generic-parse-url url-string)))
 343           (unless (and (not (url-fullness url)) (url-type url))
 344             (unless (url-type url)
 345               (setf (url-type url) default-scheme))
 346             (unless (url-host url)
 347               (let ((p (split-string (url-filename url) "/" nil nil)))
 348                 (setf (url-host url) (car p))
 349                 (setf (url-filename url)
 350                       (if (cdr p)
 351                           (concat "/" (mapconcat #'identity (cdr p) "/"))
 352                         ""))))
 353             (when (not (string-empty-p (url-host url)))
 354               (setf (url-fullness url) t)
 355               (setf (url-host url) (puny-encode-domain (url-host url))))
 356             (when (or (equal "gopher" (url-type url))
 357                       (equal "gophers" (url-type url)))
 358               ;; Gopher defaults
 359               (when (or (equal (url-filename url) "")
 360                         (equal (url-filename url) "/"))
 361                 (setf (url-filename url) "/1")))
 362             (when (equal "gemini" (url-type url))
 363               ;; Gemini defaults
 364               (if (equal (url-filename url) "")
 365                   (setf (url-filename url) "/"))))
 366           (elpher-remove-redundant-ports url))
 367       (set-match-data data))))
 368
 369 (defun elpher-remove-redundant-ports (address)
 370   "Remove redundant port specifiers from ADDRESS.
 371 Here 'redundant' means that the specified port matches the default
 372 for that protocol, eg 70 for gopher."
 373   (if (and (not (elpher-address-about-p address))
 374            (eq (url-portspec address) ; (url-port) is too slow!
 375                (pcase (url-type address)
 376                  ("gemini" 1965)
 377                  ((or "gopher" "gophers") 70)
 378                  ("finger" 79)
 379                  (_ -1))))
 380       (setf (url-portspec address) nil))
 381   address)
 382
 383 (defun elpher-make-gopher-address (type selector host port &optional tls)
 384   "Create an ADDRESS object using gopher directory record attributes.
 385 The basic attributes include: TYPE, SELECTOR, HOST and PORT.
 386 If the optional attribute TLS is non-nil, the address will be marked as
 387 requiring gopher-over-TLS."
 388   (cond
 389    ((equal type ?i) nil)
 390    ((and (equal type ?h)
 391          (string-prefix-p "URL:" selector))
 392     (elpher-address-from-url (elt (split-string selector "URL:") 1)))
 393    ((equal type ?8)
 394     (elpher-address-from-url
 395      (concat "telnet"
 396              "://" host
 397              ":" (number-to-string port))))
 398    (t
 399     (elpher-address-from-url
 400      (concat "gopher" (if tls "s" "")
 401              "://" host
 402              ":" (number-to-string port)
 403              "/" (string type)
 404              selector)))))
 405
 406 (defun elpher-make-about-address (type)
 407   "Create an ADDRESS object corresponding to the given about address TYPE."
 408   (elpher-address-from-url (concat "about:" (symbol-name type))))
 409
 410 (defun elpher-address-to-url (address)
 411   "Get string representation of ADDRESS."
 412   (url-encode-url (url-recreate-url address)))
 413
 414 (defun elpher-address-type (address)
 415   "Retrieve type of ADDRESS object.
 416 This is used to determine how to retrieve and render the document the
 417 address refers to, via the table `elpher-type-map'."
 418   (pcase (url-type address)
 419     ("about"
 420      (list 'about (intern (url-filename address))))
 421     ((or "gopher" "gophers")
 422      (list 'gopher
 423            (if (member (url-filename address) '("" "/"))
 424                ?1
 425              (string-to-char (substring (url-filename address) 1)))))
 426     ("gemini" 'gemini)
 427     ("telnet" 'telnet)
 428     ("finger" 'finger)
 429     ("file" 'file)
 430     (_ 'other-url)))
 431
 432 (defun elpher-address-about-p (address)
 433   "Return non-nil if ADDRESS is an about address."
 434   (pcase (elpher-address-type address) (`(about ,_) t)))
 435
 436 (defun elpher-address-gopher-p (address)
 437   "Return non-nil if ADDRESS object is a gopher address."
 438   (pcase (elpher-address-type address) (`(gopher ,_) t)))
 439
 440 (defun elpher-address-protocol (address)
 441   "Retrieve the transport protocol for ADDRESS."
 442   (url-type address))
 443
 444 (defun elpher-address-filename (address)
 445   "Retrieve the filename component of ADDRESS.
 446 For gopher addresses this is a combination of the selector type and selector."
 447   (url-unhex-string (url-filename address)))
 448
 449 (defun elpher-address-host (address)
 450   "Retrieve host from ADDRESS object."
 451   (pcase (url-host address)
 452     ;; The following strips out square brackets which sometimes enclose IPv6
 453     ;; addresses.  Doing this here rather than at the parsing stage may seem
 454     ;; weird, but this lets us way we avoid having to muck with both URL parsing
 455     ;; and reconstruction.  It's also more efficient, as this method is not
 456     ;; called during page rendering.
 457     ((rx (: "[" (let ipv6 (* (not "]"))) "]"))
 458      ipv6)
 459     ;; The following is a work-around for a parsing bug that causes
 460     ;; URLs with empty (but not absent, see RFC 1738) usernames to have
 461     ;; @ prepended to the hostname.
 462     ((rx (: "@" (let rest (+ anything))))
 463      rest)
 464     (addr
 465      addr)))
 466
 467 (defun elpher-address-user (address)
 468   "Retrieve user from ADDRESS object."
 469   (url-user address))
 470
 471 (defun elpher-address-port (address)
 472   "Retrieve port from ADDRESS object.
 473 If no address is defined, returns 0.  (This is for compatibility with
 474 the URL library.)"
 475   (let ((port (url-portspec address))) ; (url-port) is too slow!
 476     (if port port 0)))
 477
 478 (defun elpher-gopher-address-selector (address)
 479   "Retrieve gopher selector from ADDRESS object."
 480   (if (member (url-filename address) '("" "/"))
 481       ""
 482     (url-unhex-string (substring (url-filename address) 2))))
 483
 484
 485 ;; Cache
 486
 487 (defvar elpher-content-cache (make-hash-table :test 'equal))
 488 (defvar elpher-pos-cache (make-hash-table :test 'equal))
 489
 490 (defun elpher-get-cached-content (address)
 491   "Retrieve the cached content for ADDRESS, or nil if none exists."
 492   (gethash address elpher-content-cache))
 493
 494 (defun elpher-cache-content (address content)
 495   "Set the content cache for ADDRESS to CONTENT."
 496   (puthash address content elpher-content-cache))
 497
 498 (defun elpher-get-cached-pos (address)
 499   "Retrieve the cached cursor position for ADDRESS, or nil if none exists."
 500   (gethash address elpher-pos-cache))
 501
 502 (defun elpher-cache-pos (address pos)
 503   "Set the cursor position cache for ADDRESS to POS."
 504   (puthash address pos elpher-pos-cache))
 505
 506
 507 ;; Page
 508
 509 (defun elpher-make-page (display-string address)
 510   "Create a page with DISPLAY-STRING and ADDRESS."
 511   (list display-string address))
 512
 513 (defun elpher-make-start-page ()
 514   "Create the start page."
 515   (elpher-make-page "Start Page"
 516                     (elpher-address-from-url elpher-start-page-url)))
 517
 518 (defun elpher-page-display-string (page)
 519   "Retrieve the display string corresponding to PAGE."
 520   (elt page 0))
 521
 522 (defun elpher-page-address (page)
 523   "Retrieve the address corresponding to PAGE."
 524   (elt page 1))
 525
 526 (defun elpher-page-set-address (page new-address)
 527   "Set the address corresponding to PAGE to NEW-ADDRESS."
 528   (setcar (cdr page) new-address))
 529
 530 (defun elpher-page-from-url (url &optional default-scheme)
 531   "Create a page with address and display string defined by URL.
 532 The URL is unhexed prior to its use as a display string to improve
 533 readability.
 534
 535 If DEFAULT-SCHEME is non-nil, this scheme is applied to the URL
 536 in the instance that URL itself doesn't specify one."
 537   (let ((address (elpher-address-from-url url default-scheme)))
 538     (elpher-make-page (elpher-address-to-iri address) address)))
 539
 540 (defun elpher-address-to-iri (address)
 541   "Return an IRI for ADDRESS.
 542 Decode percent-escapes and handle punycode in the domain name.
 543 Drop the password, if any."
 544   (let ((data (match-data)) ; Prevent parsing clobbering match data
 545         (host (url-host address))
 546         (pass (url-password address)))
 547     (unwind-protect
 548         (let* ((host (url-host address))
 549                (pass (url-password address)))
 550           (when host
 551             (setf (url-host address) (puny-decode-domain host)))
 552           (when pass                             ; RFC 3986 says we should not render
 553             (setf (url-password address) nil)) ; the password as clear text
 554           (elpher-decode (url-unhex-string (url-recreate-url address))))
 555       (setf (url-host address) host)
 556       (setf (url-password address) pass)
 557       (set-match-data data))))
 558
 559 (defvar elpher-current-page nil
 560   "The current page for this Elpher buffer.")
 561
 562 (defvar elpher-history nil
 563   "The local history stack for this Elpher buffer.
 564 This variable is used by `elpher-back' and
 565 `elpher-show-history'.")
 566
 567 (defvar elpher-visited-pages nil
 568   "The global history for all Elpher buffers.
 569 This variable is used by `elpher-show-visited-pages'.")
 570
 571 (defun elpher-visit-page (page &optional renderer no-history)
 572   "Visit PAGE using its own renderer or RENDERER, if non-nil.
 573 Additionally, push PAGE onto the history stack and the list of
 574 previously-visited pages, unless NO-HISTORY is non-nil."
 575   (elpher-save-pos)
 576   (elpher-process-cleanup)
 577   (unless no-history
 578     (unless (or (not elpher-current-page)
 579                  (equal (elpher-page-address elpher-current-page)
 580                         (elpher-page-address page)))
 581       (push elpher-current-page elpher-history)
 582       (unless (or (elpher-address-about-p (elpher-page-address page))
 583                   (and elpher-visited-pages
 584                        (equal page (car elpher-visited-pages))))
 585         (push page elpher-visited-pages))))
 586   (setq-local elpher-current-page page)
 587   (let* ((address (elpher-page-address page))
 588          (type (elpher-address-type address))
 589          (type-record (cdr (assoc type elpher-type-map))))
 590     (if type-record
 591         (funcall (car type-record)
 592                  (if renderer
 593                      renderer
 594                    (cadr type-record)))
 595       (elpher-visit-previous-page)
 596       (pcase type
 597         (`(gopher ,type-char)
 598          (error "Unsupported gopher selector type '%c' for '%s'"
 599                 type-char (elpher-address-to-url address)))
 600         (other
 601          (error "Unsupported address type '%S' for '%s'"
 602                 other (elpher-address-to-url address)))))))
 603
 604 (defun elpher-visit-previous-page ()
 605   "Visit the previous page in the history."
 606   (if elpher-history
 607       (elpher-visit-page (pop elpher-history) nil t)
 608     (error "No previous page")))
 609
 610 (defun elpher-reload-current-page ()
 611   "Reload the current page, discarding any existing cached content."
 612   (elpher-cache-content (elpher-page-address elpher-current-page) nil)
 613   (elpher-visit-page elpher-current-page))
 614
 615 (defun elpher-save-pos ()
 616   "Save the current position of point to the current page."
 617   (when elpher-current-page
 618     (elpher-cache-pos (elpher-page-address elpher-current-page) (point))))
 619
 620 (defun elpher-restore-pos ()
 621   "Restore the position of point to that cached in the current page."
 622   (let ((pos (elpher-get-cached-pos (elpher-page-address elpher-current-page))))
 623     (if pos
 624         (goto-char pos)
 625       (goto-char (point-min)))))
 626
 627 (defun elpher-get-default-url-scheme ()
 628   "Suggest default URL scheme for visiting addresses based on the current page."
 629   (if elpher-current-page
 630       (let* ((address (elpher-page-address elpher-current-page))
 631              (current-type (elpher-address-type address)))
 632         (pcase current-type
 633           ((or (and 'file (guard (not elpher-history)))
 634                `(about ,_))
 635            elpher-default-url-type)
 636           (_
 637            (url-type address))))
 638       elpher-default-url-type))
 639
 640
 641 ;;; Buffer preparation
 642 ;;
 643
 644 (defvar elpher-buffer-name "*elpher*"
 645   "The default name of the Elpher buffer.")
 646
 647 (defun elpher-update-header ()
 648   "If `elpher-use-header' is true, display current page info in window header."
 649   (if (and elpher-use-header elpher-current-page)
 650       (let* ((display-string (elpher-page-display-string elpher-current-page))
 651              (sanitized-display-string (replace-regexp-in-string "%" "%%" display-string))
 652              (address (elpher-page-address elpher-current-page))
 653              (tls-string (if (and (not (elpher-address-about-p address))
 654                                   (member (elpher-address-protocol address)
 655                                           '("gophers" "gemini")))
 656                              " [TLS encryption]"
 657                            ""))
 658              (header (concat sanitized-display-string
 659                              (propertize tls-string 'face 'bold))))
 660         (setq header-line-format header))))
 661
 662 (defmacro elpher-with-clean-buffer (&rest args)
 663   "Evaluate ARGS with a clean *elpher* buffer as current."
 664   (declare (debug (body))) ;; Allow edebug to step through body
 665   `(with-current-buffer elpher-buffer-name
 666      (unless (eq major-mode 'elpher-mode)
 667        ;; avoid resetting buffer-local variables
 668        (elpher-mode))
 669      (let ((inhibit-read-only t)
 670            (ansi-color-context nil)) ;; clean ansi interpreter state (also next 2 lines)
 671        (setq-local xterm-color--current-fg nil)
 672        (setq-local xterm-color--current-bg nil)
 673        (setq-local network-security-level
 674                    (default-value 'network-security-level))
 675        (erase-buffer)
 676        (elpher-update-header)
 677        ,@args)))
 678
 679 (defun elpher-buffer-message (string &optional line)
 680   "Replace first line in elpher buffer with STRING.
 681 If LINE is non-nil, replace that line instead."
 682   (with-current-buffer elpher-buffer-name
 683     (let ((inhibit-read-only t))
 684       (goto-char (point-min))
 685       (if line
 686           (forward-line line))
 687       (let ((data (match-data)))
 688         (unwind-protect
 689             (progn
 690               (re-search-forward "^.*$")
 691               (replace-match string))
 692           (set-match-data data))))))
 693
 694
 695 ;;; Text Processing
 696 ;;
 697
 698 (defvar elpher-user-coding-system nil
 699   "User-specified coding system to use for decoding text responses.")
 700
 701 (defun elpher-decode (string)
 702   "Decode STRING using autodetected or user-specified coding system."
 703   (decode-coding-string string
 704                         (if elpher-user-coding-system
 705                             elpher-user-coding-system
 706                           (detect-coding-string string t))))
 707
 708 (defun elpher-preprocess-text-response (string)
 709   "Preprocess text selector response contained in STRING.
 710 This involes decoding the character representation, and clearing
 711 away CRs and any terminating period."
 712   (elpher-decode (replace-regexp-in-string "\n\\.\n$" "\n"
 713                                            (replace-regexp-in-string "\r" "" string))))
 714
 715 ;;; Buttonify urls
 716
 717 (defconst elpher-url-regex
 718   "\\([a-zA-Z]+\\)://\\([a-zA-Z0-9.-]*[a-zA-Z0-9-]\\|\\[[a-zA-Z0-9:]+\\]\\)\\(:[0-9]+\\)?\\(/\\([0-9a-zA-Z_~?/@|:.%#=&-]*[0-9a-zA-Z_~?/@|#-]\\)?\\)?"
 719   "Regexp used to locate and buttonify URLs in text files loaded by elpher.")
 720
 721 (defun elpher-buttonify-urls (string)
 722   "Turn substrings which look like urls in STRING into clickable buttons."
 723   (with-temp-buffer
 724     (insert string)
 725     (goto-char (point-min))
 726     (while (re-search-forward elpher-url-regex nil t)
 727       (let ((page (elpher-page-from-url (substring-no-properties (match-string 0)))))
 728         (make-text-button (match-beginning 0)
 729                           (match-end 0)
 730                           'elpher-page  page
 731                           'action #'elpher-click-link
 732                           'follow-link t
 733                           'help-echo #'elpher--page-button-help
 734                           'face 'button)))
 735     (buffer-string)))
 736
 737
 738 ;; ANSI colors or XTerm colors (application and filtering)
 739
 740 (or (require 'xterm-color nil t)
 741     (require 'ansi-color))
 742
 743 (defalias 'elpher-color-filter-apply
 744   (if (fboundp 'xterm-color-filter)
 745       (lambda (s)
 746         (let ((_xterm-color-render nil))
 747           (xterm-color-filter s)))
 748     #'ansi-color-filter-apply)
 749   "A function to filter out ANSI escape sequences.")
 750
 751 (defalias 'elpher-color-apply
 752   (if (fboundp 'xterm-color-filter)
 753       #'xterm-color-filter
 754     #'ansi-color-apply)
 755   "A function to apply ANSI escape sequences.")
 756
 757 (defun elpher-text-has-ansi-escapes-p (string)
 758   "Return non-nil if STRING includes an ANSI escape code."
 759   (save-match-data
 760     (string-match "\x1b\\[" string)))
 761
 762
 763 ;; Processing text for display
 764
 765 (defun elpher-process-text-for-display (string)
 766   "Perform any desired processing of STRING prior to display as text.
 767 Currently includes buttonifying URLs and processing ANSI escape codes."
 768   (elpher-buttonify-urls (if (elpher-text-has-ansi-escapes-p string)
 769                              (if elpher-filter-ansi-from-text
 770                                  (elpher-color-filter-apply string)
 771                                (elpher-color-apply string))
 772                            string)))
 773
 774
 775 ;;; General network communication
 776 ;;
 777
 778 (defun elpher-network-error (address error)
 779   "Display ERROR message following unsuccessful negotiation with ADDRESS.
 780 ERROR can be either an error object or a string."
 781   (elpher-with-clean-buffer
 782    (insert (propertize "\n---- ERROR -----\n\n" 'face 'error)
 783            "When attempting to retrieve " (elpher-address-to-url address) ":\n"
 784            (if (stringp error) error (error-message-string error)) "\n"
 785            (propertize "\n----------------\n\n" 'face 'error)
 786            "Press 'u' to return to the previous page.")))
 787
 788
 789 (defvar elpher-network-timer nil
 790   "Timer used for network connections.")
 791
 792 (defvar elpher-use-tls nil
 793   "If non-nil, use TLS to communicate with gopher servers.")
 794
 795 (defvar elpher-client-certificate nil
 796   "If non-nil, contains client certificate details to use for TLS connections.")
 797
 798 (defun elpher-process-cleanup ()
 799   "Immediately shut down any extant elpher process and timers."
 800   (let ((p (get-process "elpher-process")))
 801     (if p (delete-process p)))
 802   (if (timerp elpher-network-timer)
 803       (cancel-timer elpher-network-timer)))
 804
 805 (defun elpher-make-network-timer (thunk)
 806   "Create a timer to run the THUNK after `elpher-connection-timeout' seconds.
 807 This is just a wraper around `run-at-time' which additionally sets the
 808 buffer-local variable `elpher-network-timer' to allow
 809 `elpher-process-cleanup' to also clear the timer."
 810   (let ((timer (run-at-time elpher-connection-timeout nil thunk)))
 811     (setq-local elpher-network-timer timer)
 812     timer))
 813
 814 (defun elpher-get-host-response (address default-port query-string response-processor
 815                                          &optional use-tls force-ipv4)
 816   "Generic function for retrieving data from ADDRESS.
 817
 818 When ADDRESS lacks a specific port, DEFAULT-PORT is used instead.
 819 QUERY-STRING is a string sent to the host specified by ADDRESS to
 820 illicet a response.  This response is passed as an argument to the
 821 function RESPONSE-PROCESSOR.
 822
 823 If non-nil, USE-TLS specifies that the connection is to be made over
 824 TLS.  If set to gemini, the certificate verification will be disabled
 825 unless `elpher-gemini-TLS-cert-checks' is non-nil.
 826
 827 If non-nil, FORCE-IPV4 causes the network connection to be made over
 828 ipv4 only.  (The default behaviour when this is not set depends on
 829 the host operating system and the local network capabilities.)"
 830   (if (and use-tls (not (gnutls-available-p)))
 831       (error "Use of TLS requires Emacs to be compiled with GNU TLS support")
 832     (unless (< (elpher-address-port address) 65536)
 833       (error "Cannot establish network connection: port number > 65536"))
 834     (when (and (eq use-tls 'gemini) (not elpher-gemini-TLS-cert-checks))
 835       (setq-local network-security-level 'low)
 836       (setq-local gnutls-verify-error nil))
 837     (condition-case nil
 838         (let* ((kill-buffer-query-functions nil)
 839                (port (elpher-address-port address))
 840                (host (elpher-address-host address))
 841                (service (if (> port 0) port default-port))
 842                (response-string-parts nil)
 843                (bytes-received 0)
 844                (hkbytes-received 0)
 845                (socks (or elpher-socks-always (string-suffix-p ".onion" host)))
 846                (gnutls-params (list :type 'gnutls-x509pki
 847                                     :hostname host
 848                                     :keylist
 849                                     (elpher-get-current-keylist address)))
 850                (timer (elpher-make-network-timer
 851                                    (lambda ()
 852                                      (elpher-process-cleanup)
 853                                      (cond
 854                                         ; Try again with IPv4
 855                                       ((not (or elpher-ipv4-always force-ipv4 socks))
 856                                        (message "Connection timed out.  Retrying with IPv4.")
 857                                        (elpher-get-host-response address default-port
 858                                                                  query-string
 859                                                                  response-processor
 860                                                                  use-tls t))
 861                                       ((and use-tls
 862                                             (not (eq use-tls 'gemini))
 863                                             (or elpher-auto-disengage-TLS
 864                                                 (y-or-n-p
 865                                                  "TLS connetion failed.  Disable TLS mode and retry? ")))
 866                                        (setq elpher-use-tls nil)
 867                                        (elpher-get-host-response address default-port
 868                                                                  query-string
 869                                                                  response-processor
 870                                                                  nil force-ipv4))
 871                                       (t
 872                                        (elpher-network-error address "Connection time-out."))))))
 873                (proc (if socks
 874                          (socks-open-network-stream "elpher-process" nil host service)
 875                        (make-network-process :name "elpher-process"
 876                                              :host host
 877                                              :family (and (or force-ipv4
 878                                                               elpher-ipv4-always)
 879                                                           'ipv4)
 880                                              :service service
 881                                              :buffer nil
 882                                              :nowait t
 883                                              :tls-parameters
 884                                              (and use-tls
 885                                                   (cons 'gnutls-x509pki
 886                                                         (apply #'gnutls-boot-parameters
 887                                                                gnutls-params)))))))
 888           (process-put proc 'elpher-buffer (current-buffer))
 889           (setq elpher-network-timer timer)
 890           (set-process-coding-system proc 'binary 'binary)
 891           (set-process-query-on-exit-flag proc nil)
 892           (elpher-buffer-message (concat "Connecting to " host "..."
 893                                          " (press 'u' to abort)"))
 894           (set-process-filter proc
 895                               (lambda (_proc string)
 896                                 (when timer
 897                                   (cancel-timer timer)
 898                                   (setq timer nil))
 899                                 (setq bytes-received (+ bytes-received (length string)))
 900                                 (let ((new-hkbytes-received (/ bytes-received 102400)))
 901                                   (when (> new-hkbytes-received hkbytes-received)
 902                                     (setq hkbytes-received new-hkbytes-received)
 903                                     (elpher-buffer-message
 904                                      (concat "("
 905                                              (number-to-string (/ hkbytes-received 10.0))
 906                                              " MB read)")
 907                                      1)))
 908                                 (setq response-string-parts
 909                                       (cons string response-string-parts))))
 910           (set-process-sentinel proc
 911                                 (lambda (proc event)
 912                                   (when timer
 913                                     (cancel-timer timer))
 914                                   (condition-case the-error
 915                                       (cond
 916                                        ((string-prefix-p "open" event)    ; request URL
 917                                         (elpher-buffer-message
 918                                          (concat "Connected to " host ". Receiving data..."
 919                                                  " (press 'u' to abort)"))
 920                                         (let ((inhibit-eol-conversion t))
 921                                           (process-send-string proc query-string)))
 922                                        ((string-prefix-p "deleted" event)) ; do nothing
 923                                        ((and (not response-string-parts)
 924                                              (not (or elpher-ipv4-always force-ipv4 socks)))
 925                                         ; Try again with IPv4
 926                                         (message "Connection failed. Retrying with IPv4.")
 927                                         (elpher-get-host-response address default-port
 928                                                                   query-string
 929                                                                   response-processor
 930                                                                   use-tls t))
 931                                        (response-string-parts
 932                                         (with-current-buffer (process-get proc 'elpher-buffer)
 933                                           (elpher-with-clean-buffer
 934                                            (insert "Data received.  Rendering..."))
 935                                           (funcall response-processor
 936                                                    (apply #'concat (reverse response-string-parts)))
 937                                           (elpher-restore-pos)))
 938                                        (t
 939                                         (error "No response from server")))
 940                                     (error
 941                                      (elpher-network-error address the-error)))))
 942           (when socks
 943             (if use-tls
 944                 (apply #'gnutls-negotiate :process proc gnutls-params))
 945             (funcall (process-sentinel proc) proc "open\n")))
 946       (error
 947        (elpher-process-cleanup)
 948        (error "Error initiating connection to server")))))
 949
 950
 951 ;;; Client-side TLS Certificate Management
 952 ;;
 953
 954 (defun elpher-generate-certificate (common-name key-file cert-file &optional temporary)
 955   "Generate a key and a self-signed client TLS certificate using openssl.
 956
 957 The Common Name field of the certificate is set to COMMON-NAME.  The
 958 arguments KEY-FILE and CERT-FILE should contain the absolute paths of
 959 the key and certificate files to write.
 960
 961 If TEMPORARY is non-nil, the certificate will be given an exporation
 962 period of one day, and the key and certificate files will be deleted
 963 when the certificate is no longer needed for the current session.
 964
 965 Otherwise, the certificate will be given a 100 year expiration period
 966 and the files will not be deleted.
 967
 968 The function returns a list containing the current host name, the
 969 temporary flag, and the key and cert file names in the form required
 970 by `gnutls-boot-parameters`."
 971   (let ((exp-key-file (expand-file-name key-file))
 972         (exp-cert-file (expand-file-name cert-file)))
 973     (condition-case nil
 974         (progn
 975           (call-process elpher-openssl-command nil nil nil
 976                         "req" "-x509" "-newkey" "rsa:2048"
 977                         "-days" (if temporary "1" "36500")
 978                         "-nodes"
 979                         "-subj" (concat "/CN=" common-name)
 980                         "-keyout" exp-key-file
 981                         "-out" exp-cert-file)
 982           (list (elpher-address-host (elpher-page-address elpher-current-page))
 983                 temporary exp-key-file exp-cert-file))
 984       (error
 985        (message "Check that openssl is installed, or customize `elpher-openssl-command`.")
 986        (error "Program 'openssl', required for certificate generation, not found")))))
 987
 988 (defun elpher-generate-throwaway-certificate ()
 989   "Generate and return details of a throwaway certificate.
 990 The key and certificate files will be deleted when they are no
 991 longer needed for this session."
 992   (let* ((file-base (make-temp-name "elpher"))
 993          (key-file (concat temporary-file-directory file-base ".key"))
 994          (cert-file (concat temporary-file-directory file-base ".crt")))
 995     (elpher-generate-certificate file-base key-file cert-file t)))
 996
 997 (defun elpher-generate-persistent-certificate (file-base common-name)
 998   "Generate and return details of a persistent certificate.
 999 The argument FILE-BASE is used as the base for the key and certificate
1000 files, while COMMON-NAME specifies the common name field of the
1001 certificate.
1002
1003 The key and certificate files are written to in `elpher-certificate-directory'."
1004   (let* ((key-file (concat elpher-certificate-directory file-base ".key"))
1005          (cert-file (concat elpher-certificate-directory file-base ".crt")))
1006     (elpher-generate-certificate common-name key-file cert-file)))
1007
1008 (defun elpher-get-existing-certificate (file-base)
1009   "Return a certificate object corresponding to an existing certificate.
1010 It is assumed that the key files FILE-BASE.key and FILE-BASE.crt exist in
1011 the directory `elpher-certificate-directory'."
1012   (let* ((key-file (concat elpher-certificate-directory file-base ".key"))
1013          (cert-file (concat elpher-certificate-directory file-base ".crt")))
1014     (list (elpher-address-host (elpher-page-address elpher-current-page))
1015           nil
1016           (expand-file-name key-file)
1017           (expand-file-name cert-file))))
1018
1019 (defun elpher-install-and-use-existing-certificate (key-file-src cert-file-src file-base)
1020   "Install a key+certificate file pair in `elpher-certificate-directory'.
1021 The strings KEY-FILE-SRC and CERT-FILE-SRC are the existing key and
1022 certificate files to install.  The argument FILE-BASE is used as the
1023 base for the installed key and certificate files."
1024   (let* ((key-file (concat elpher-certificate-directory file-base ".key"))
1025          (cert-file (concat elpher-certificate-directory file-base ".crt")))
1026     (if (or (file-exists-p key-file)
1027             (file-exists-p cert-file))
1028         (error "A certificate with base name %s is already installed" file-base))
1029     (copy-file key-file-src key-file)
1030     (copy-file cert-file-src cert-file)
1031     (list (elpher-address-host (elpher-page-address elpher-current-page))
1032           nil
1033           (expand-file-name key-file)
1034           (expand-file-name cert-file))))
1035
1036 (defun elpher-list-existing-certificates ()
1037   "Return a list of the persistent certificates in `elpher-certificate-directory'."
1038   (unless (file-directory-p elpher-certificate-directory)
1039     (make-directory elpher-certificate-directory))
1040   (mapcar
1041    (lambda (file)
1042      (file-name-sans-extension file))
1043    (directory-files elpher-certificate-directory nil "\\.key$")))
1044
1045 (defun elpher-forget-current-certificate ()
1046   "Causes any current certificate to be forgotten.)
1047 In the case of throwaway certificates, the key and certificate files
1048 are also deleted."
1049   (interactive)
1050   (when elpher-client-certificate
1051     (unless (and (called-interactively-p 'any)
1052                  (not (y-or-n-p (concat "Really forget client certificate? "
1053                                         "(Throwaway certificates will be deleted.)"))))
1054       (when (cadr elpher-client-certificate)
1055         (delete-file (elt elpher-client-certificate 2))
1056         (delete-file (elt elpher-client-certificate 3)))
1057       (setq elpher-client-certificate nil)
1058       (if (called-interactively-p 'any)
1059           (message "Client certificate forgotten.")))))
1060
1061 (defun elpher-get-current-keylist (address)
1062   "Retrieve the `gnutls-boot-parameters'-compatable keylist.
1063
1064 This is obtained from the client certificate described by
1065 `elpher-current-certificate', if one is available and the host for
1066 that certificate matches the host in ADDRESS.
1067
1068 If `elpher-current-certificate' is non-nil, and its host name doesn't
1069 match that of ADDRESS, the certificate is forgotten."
1070   (if elpher-client-certificate
1071       (if (string= (car elpher-client-certificate)
1072                    (elpher-address-host address))
1073           (list (cddr elpher-client-certificate))
1074         (elpher-forget-current-certificate)
1075         (message "Disabling client certificate for new host")
1076         nil)
1077     nil))
1078
1079
1080 ;;; Gopher selector retrieval
1081 ;;
1082
1083 (defun elpher-get-gopher-response (address renderer)
1084   "Get response string from gopher server at ADDRESS and render using RENDERER."
1085   (elpher-get-host-response address 70
1086                             (concat (elpher-gopher-address-selector address) "\r\n")
1087                             renderer
1088                             (or (string= (elpher-address-protocol address) "gophers")
1089                                 elpher-use-tls)))
1090
1091 (defun elpher-get-gopher-page (renderer)
1092   "Getter function for gopher pages.
1093 The RENDERER procedure is used to display the contents of the page
1094 once they are retrieved from the gopher server."
1095   (let* ((address (elpher-page-address elpher-current-page))
1096          (content (elpher-get-cached-content address)))
1097     (if (and content (funcall renderer nil))
1098         (elpher-with-clean-buffer
1099          (insert content)
1100          (elpher-restore-pos))
1101       (elpher-with-clean-buffer
1102        (insert "LOADING... (use 'u' to cancel)\n"))
1103       (condition-case the-error
1104           (elpher-get-gopher-response address renderer)
1105         (error
1106          (elpher-network-error address the-error))))))
1107
1108
1109 ;;; Gopher index rendering
1110 ;;
1111
1112 (defun elpher-insert-margin (&optional type-name)
1113   "Insert index margin, optionally containing the TYPE-NAME, into current buffer."
1114   (if type-name
1115       (progn
1116         (insert (format (concat "%" (number-to-string (- elpher-margin-width 1)) "s")
1117                         (concat
1118                          (propertize "[" 'face 'elpher-margin-brackets)
1119                          (propertize type-name 'face 'elpher-margin-key)
1120                          (propertize "]" 'face 'elpher-margin-brackets))))
1121         (insert " "))
1122     (insert (make-string elpher-margin-width ?\s))))
1123
1124 (defun elpher--page-button-help (_window buffer pos)
1125   "Function called by Emacs to generate mouse-over text.
1126 The arguments specify the BUFFER and the POS within the buffer of the item
1127 for which help is required.  The function returns the help to be
1128 displayed.  The _WINDOW argument is currently unused."
1129   (with-current-buffer buffer
1130     (let ((button (button-at pos)))
1131       (when button
1132         (let* ((page (button-get button 'elpher-page))
1133                (address (elpher-page-address page)))
1134           (format "mouse-1, RET: open '%s'" (elpher-address-to-url address)))))))
1135
1136 (defun elpher-insert-index-record (display-string &optional address)
1137   "Function to insert an index record into the current buffer.
1138 The contents of the record are dictated by DISPLAY-STRING and ADDRESS.
1139 If ADDRESS is not supplied or nil the record is rendered as an
1140 'information' line."
1141   (let* ((type (if address (elpher-address-type address) nil))
1142          (type-map-entry (cdr (assoc type elpher-type-map))))
1143     (if type-map-entry
1144         (let* ((margin-code (elt type-map-entry 2))
1145                (face (elt type-map-entry 3))
1146                (filtered-display-string (elpher-color-filter-apply display-string))
1147                (page (elpher-make-page filtered-display-string address)))
1148           (elpher-insert-margin margin-code)
1149           (insert-text-button filtered-display-string
1150                               'face face
1151                               'elpher-page page
1152                               'action #'elpher-click-link
1153                               'follow-link t
1154                               'help-echo #'elpher--page-button-help))
1155       (pcase type
1156         ('nil ;; Information
1157          (elpher-insert-margin)
1158          (let ((propertized-display-string
1159                 (propertize display-string 'face 'elpher-info)))
1160            (insert (elpher-process-text-for-display propertized-display-string))))
1161         (`(gopher ,selector-type) ;; Unknown
1162          (elpher-insert-margin (concat (char-to-string selector-type) "?"))
1163          (insert (propertize display-string
1164                              'face 'elpher-unknown)))))
1165     (insert "\n")))
1166
1167 (defun elpher-click-link (button)
1168   "Function called when the gopher link BUTTON is activated."
1169   (let ((page (button-get button 'elpher-page)))
1170     (elpher-visit-page page)))
1171
1172 (defun elpher-render-index (data &optional _mime-type-string)
1173   "Render DATA as an index.  MIME-TYPE-STRING is unused."
1174   (elpher-with-clean-buffer
1175    (if (not data)
1176        t
1177      (let ((data-processed (elpher-preprocess-text-response data)))
1178        (dolist (line (split-string data-processed "\n"))
1179          (ignore-errors
1180            (unless (= (length line) 0)
1181              (let* ((type (elt line 0))
1182                     (fields (split-string (substring line 1) "\t"))
1183                     (display-string (elt fields 0))
1184                     (selector (elt fields 1))
1185                     (host (elt fields 2))
1186                     (port (if (elt fields 3)
1187                               (string-to-number (elt fields 3))
1188                             nil))
1189                     (address (elpher-make-gopher-address type selector host port)))
1190                (elpher-insert-index-record display-string address))))))
1191      (elpher-cache-content (elpher-page-address elpher-current-page)
1192                            (buffer-string)))))
1193
1194
1195 ;;; Gopher text rendering
1196 ;;
1197
1198 (defun elpher-render-text (data &optional _mime-type-string)
1199   "Render DATA as text.  MIME-TYPE-STRING is unused."
1200   (elpher-with-clean-buffer
1201    (if (not data)
1202        t
1203      (insert (elpher-process-text-for-display (elpher-preprocess-text-response data)))
1204      (elpher-cache-content
1205       (elpher-page-address elpher-current-page)
1206       (buffer-string)))))
1207
1208
1209 ;;; Image retrieval
1210 ;;
1211
1212 (defun elpher-render-image (data &optional _mime-type-string)
1213   "Display DATA as image.  MIME-TYPE-STRING is unused."
1214   (if (not data)
1215       nil
1216     (if (display-images-p)
1217         (let* ((image (create-image
1218                        data
1219                        nil t)))
1220           (if (not image)
1221               (error "Unsupported image format")
1222             (let ((window (get-buffer-window elpher-buffer-name)))
1223               (when window
1224                 (setf (image-property image :max-width) (window-body-width window t))
1225                 (setf (image-property image :max-height) (window-body-height window t))))
1226             (elpher-with-clean-buffer
1227              (insert-image image)
1228              (elpher-restore-pos))))
1229       (elpher-render-download data))))
1230
1231
1232 ;;; Gopher search retrieval and rendering
1233 ;;
1234
1235 (defun elpher-get-gopher-query-page (renderer)
1236   "Getter for gopher addresses requiring input.
1237 The response is rendered using the rendering function RENDERER."
1238   (let* ((address (elpher-page-address elpher-current-page))
1239          (content (elpher-get-cached-content address))
1240          (aborted t))
1241     (if (and content (funcall renderer nil))
1242         (elpher-with-clean-buffer
1243          (insert content)
1244          (elpher-restore-pos)
1245          (message "Displaying cached search results.  Reload to perform a new search."))
1246       (unwind-protect
1247           (let* ((query-string (read-string "Query: "))
1248                  (query-selector (concat (elpher-gopher-address-selector address) "\t" query-string))
1249                  (search-address (elpher-make-gopher-address ?1
1250                                                              query-selector
1251                                                              (elpher-address-host address)
1252                                                              (elpher-address-port address)
1253                                                              (equal (elpher-address-type address) "gophers"))))
1254             (setq aborted nil)
1255
1256             (elpher-with-clean-buffer
1257              (insert "LOADING RESULTS... (use 'u' to cancel)"))
1258             (elpher-get-gopher-response search-address renderer))
1259         (if aborted
1260             (elpher-visit-previous-page))))))
1261
1262
1263 ;;; Raw server response rendering
1264 ;;
1265
1266 (defun elpher-render-raw (data &optional mime-type-string)
1267   "Display raw DATA in buffer.  MIME-TYPE-STRING is also displayed if provided."
1268   (if (not data)
1269       nil
1270     (elpher-with-clean-buffer
1271      (when mime-type-string
1272        (insert "MIME type specified by server: '" mime-type-string "'\n"))
1273      (insert data)
1274      (goto-char (point-min)))
1275     (message "Displaying raw server response.  Reload or redraw to return to standard view.")))
1276
1277
1278 ;;; File save "rendering"
1279 ;;
1280
1281 (defun elpher-render-download (data &optional _mime-type-string)
1282   "Save DATA to file.  MIME-TYPE-STRING is unused."
1283   (if (not data)
1284       nil
1285     (let* ((address (elpher-page-address elpher-current-page))
1286            (selector (if (elpher-address-gopher-p address)
1287                          (elpher-gopher-address-selector address)
1288                        (elpher-address-filename address))))
1289       (elpher-visit-previous-page) ; Do first in case of non-local exits.
1290       (let* ((filename-proposal (file-name-nondirectory selector))
1291              (filename (read-file-name "Download complete. Save file as: "
1292                                        nil nil nil
1293                                        (if (> (length filename-proposal) 0)
1294                                            filename-proposal
1295                                          "download.file"))))
1296         (let ((coding-system-for-write 'binary))
1297           (with-temp-file filename
1298             (insert data)))
1299         (message (format "Saved to file %s." filename))))))
1300
1301
1302 ;;; HTML rendering
1303 ;;
1304
1305 (defun elpher-render-html (data &optional _mime-type-string)
1306   "Render DATA as HTML using shr.  MIME-TYPE-STRING is unused."
1307   (elpher-with-clean-buffer
1308    (if (not data)
1309        t
1310      (let ((dom (with-temp-buffer
1311                   (insert data)
1312                   (libxml-parse-html-region (point-min) (point-max)))))
1313        (shr-insert-document dom)))))
1314
1315
1316 ;;; Gemini page retrieval
1317 ;;
1318
1319 (defvar elpher-gemini-redirect-chain)
1320
1321 (defun elpher-get-gemini-response (address renderer)
1322   "Get response string from gemini server at ADDRESS and render using RENDERER."
1323   (elpher-get-host-response address 1965
1324                             (concat (elpher-address-to-url address) "\r\n")
1325                             (lambda (response-string)
1326                               (elpher-process-gemini-response response-string renderer))
1327                             'gemini))
1328
1329 (defun elpher-parse-gemini-response (response)
1330   "Parse the RESPONSE string and return a list of components.
1331 The list is of the form (code meta body).  A response of nil implies
1332 that the response was malformed."
1333   (let ((header-end-idx (string-match "\r\n" response)))
1334     (if header-end-idx
1335         (let ((header (string-trim (substring response 0 header-end-idx)))
1336               (body (substring response (+ header-end-idx 2))))
1337           (if (>= (length header) 2)
1338               (let ((code (substring header 0 2))
1339                     (meta (string-trim (substring header 2))))
1340                 (list code meta body))
1341             (error "Malformed response: No response status found in header %s" header)))
1342       (error "Malformed response: No CRLF-delimited header found in response %s" response))))
1343
1344 (defun elpher-process-gemini-response (response-string renderer)
1345   "Process the gemini response RESPONSE-STRING and pass the result to RENDERER."
1346   (let ((response-components (elpher-parse-gemini-response response-string)))
1347     (let ((response-code (elt response-components 0))
1348           (response-meta (elt response-components 1))
1349           (response-body (elt response-components 2)))
1350       (pcase (elt response-code 0)
1351         (?1 ; Input required
1352          (elpher-with-clean-buffer
1353           (insert "Gemini server is requesting input."))
1354          (let* ((query-string
1355                  (if (eq (elt response-code 1) ?1)
1356                      (read-passwd (concat response-meta ": "))
1357                    (read-string (concat response-meta ": "))))
1358                 (query-address (seq-copy (elpher-page-address elpher-current-page)))
1359                 (old-fname (url-filename query-address)))
1360            (setf (url-filename query-address)
1361                  (concat old-fname "?" (url-build-query-string `((,query-string)))))
1362            (elpher-get-gemini-response query-address renderer)))
1363         (?2 ; Normal response
1364          (funcall renderer response-body response-meta))
1365         (?3 ; Redirect
1366          (message "Following redirect to %s" response-meta)
1367          (if (>= (length elpher-gemini-redirect-chain) 5)
1368              (error "More than 5 consecutive redirects followed"))
1369          (let ((redirect-address (elpher-address-from-gemini-url response-meta)))
1370            (if (member redirect-address elpher-gemini-redirect-chain)
1371                (error "Redirect loop detected"))
1372            (if (not (eq (elpher-address-type redirect-address) 'gemini))
1373                (error "Server tried to automatically redirect to non-gemini URL: %s"
1374                       response-meta))
1375            (elpher-page-set-address elpher-current-page redirect-address)
1376            (add-to-list 'elpher-gemini-redirect-chain redirect-address)
1377            (elpher-get-gemini-response redirect-address renderer)))
1378         (?4 ; Temporary failure
1379          (error "Gemini server reports TEMPORARY FAILURE for this request: %s %s"
1380                 response-code response-meta))
1381         (?5 ; Permanent failure
1382          (error "Gemini server reports PERMANENT FAILURE for this request: %s %s"
1383                 response-code response-meta))
1384         (?6 ; Client certificate required
1385          (elpher-with-clean-buffer
1386           (if elpher-client-certificate
1387               (insert "Gemini server does not recognise the provided TLS certificate:\n\n")
1388             (insert "Gemini server is requesting a valid TLS certificate:\n\n"))
1389           (auto-fill-mode 1)
1390           (elpher-gemini-insert-text response-meta))
1391          (let ((chosen-certificate (elpher-choose-client-certificate)))
1392            (unless chosen-certificate
1393              (error "Gemini server requires a client certificate and none was provided"))
1394            (setq elpher-client-certificate chosen-certificate))
1395          (elpher-with-clean-buffer)
1396          (elpher-get-gemini-response (elpher-page-address elpher-current-page) renderer))
1397         (_other
1398          (error "Gemini server response unknown: %s %s"
1399                 response-code response-meta))))))
1400
1401 (defun elpher--read-answer-polyfill (question answers)
1402   "Polyfill for `read-answer' in Emacs 26.1.
1403 QUESTION is a string containing a question, and ANSWERS
1404 is a list of possible answers."
1405     (completing-read question (mapcar 'identity answers)))
1406
1407 (if (fboundp 'read-answer)
1408     (defalias 'elpher-read-answer 'read-answer)
1409   (defalias 'elpher-read-answer 'elpher--read-answer-polyfill))
1410
1411 (defun elpher-choose-client-certificate ()
1412   "Prompt for a client certificate to use to establish a TLS connection."
1413   (let* ((read-answer-short t))
1414     (pcase (read-answer "What do you want to do? "
1415                         '(("throwaway" ?t
1416                            "generate and use throw-away certificate")
1417                           ("persistent" ?p
1418                            "generate new or use existing persistent certificate")
1419                           ("abort" ?a
1420                            "stop immediately")))
1421       ("throwaway"
1422        (setq elpher-client-certificate (elpher-generate-throwaway-certificate)))
1423       ("persistent"
1424        (let* ((existing-certificates (elpher-list-existing-certificates))
1425               (file-base (completing-read
1426                           "Nickname for new or existing certificate (autocompletes, empty response aborts): "
1427                           existing-certificates)))
1428          (if (string-empty-p (string-trim file-base))
1429              nil
1430            (if (member file-base existing-certificates)
1431                (setq elpher-client-certificate
1432                      (elpher-get-existing-certificate file-base))
1433              (pcase (read-answer "Generate new certificate or install externally-generated one? "
1434                                  '(("new" ?n
1435                                     "generate new certificate")
1436                                    ("install" ?i
1437                                     "install existing certificate")
1438                                    ("abort" ?a
1439                                     "stop immediately")))
1440                ("new"
1441                 (let ((common-name (read-string "Common Name field for new certificate: "
1442                                                 file-base)))
1443                   (message "New key and self-signed certificate written to %s"
1444                            elpher-certificate-directory)
1445                   (elpher-generate-persistent-certificate file-base common-name)))
1446                ("install"
1447                 (let* ((cert-file (read-file-name "Certificate file: " nil nil t))
1448                        (key-file (read-file-name "Key file: " nil nil t)))
1449                   (message "Key and certificate installed in %s for future use"
1450                            elpher-certificate-directory)
1451                   (elpher-install-and-use-existing-certificate key-file
1452                                                                cert-file
1453                                                                file-base)))
1454                ("abort" nil))))))
1455       ("abort" nil))))
1456
1457 (defun elpher-get-gemini-page (renderer)
1458   "Getter which retrieves and renders a Gemini page and renders it using RENDERER."
1459   (let* ((address (elpher-page-address elpher-current-page))
1460          (content (elpher-get-cached-content address)))
1461     (condition-case the-error
1462         (if (and content (funcall renderer nil))
1463             (elpher-with-clean-buffer
1464              (insert content)
1465              (elpher-restore-pos))
1466           (elpher-with-clean-buffer
1467            (insert "LOADING GEMINI... (use 'u' to cancel)\n"))
1468           (setq elpher-gemini-redirect-chain nil)
1469           (elpher-get-gemini-response address renderer))
1470       (error
1471        (elpher-network-error address the-error)))))
1472
1473 ;;; Gemini page rendering
1474 ;;
1475
1476 (defun elpher-render-gemini (body &optional mime-type-string)
1477   "Render gemini response BODY with rendering MIME-TYPE-STRING."
1478   (if (not body)
1479       t
1480     (let* ((mime-type-string* (if (or (not mime-type-string)
1481                                       (string-empty-p mime-type-string))
1482                                   "text/gemini; charset=utf-8"
1483                                 mime-type-string))
1484            (mime-type-split (split-string mime-type-string* ";" t))
1485            (mime-type (string-trim (car mime-type-split)))
1486            (parameters (mapcar (lambda (s)
1487                                  (let ((key-val (split-string s "=")))
1488                                    (list (downcase (string-trim (car key-val)))
1489                                          (downcase (string-trim (cadr key-val))))))
1490                                (cdr mime-type-split))))
1491       (when (string-prefix-p "text/" mime-type)
1492         (setq body (decode-coding-string
1493                     body
1494                     (if (assoc "charset" parameters)
1495                         (intern (cadr (assoc "charset" parameters)))
1496                       'utf-8)))
1497         (setq body (replace-regexp-in-string "\r" "" body)))
1498       (pcase mime-type
1499         ((or "text/gemini" "")
1500          (elpher-render-gemini-map body parameters))
1501         ("text/html"
1502          (elpher-render-html body))
1503         ((pred (string-prefix-p "text/"))
1504          (elpher-render-gemini-plain-text body parameters))
1505         ((pred (string-prefix-p "image/"))
1506          (elpher-render-image body))
1507         (_other
1508          (elpher-render-download body))))))
1509
1510 (defun elpher-gemini-get-link-url (link-line)
1511   "Extract the url portion of LINK-LINE, a gemini map file link line.
1512 Returns nil in the event that the contents of the line following the
1513 => prefix are empty."
1514   (let ((l (split-string (substring link-line 2))))
1515     (if l
1516         (string-trim (elt l 0))
1517       nil)))
1518
1519 (defun elpher-gemini-get-link-display-string (link-line)
1520   "Extract the display string portion of LINK-LINE, a gemini map file link line.
1521 Return nil if this portion is not provided."
1522   (let* ((rest (string-trim (elt (split-string link-line "=>") 1)))
1523          (idx (string-match "[ \t]" rest)))
1524     (and idx
1525          (elpher-color-filter-apply (string-trim (substring rest (+ idx 1)))))))
1526
1527 (defun elpher-collapse-dot-sequences (filename)
1528   "Collapse dot sequences in the (absolute) FILENAME.
1529 For instance, the filename \"/a/b/../c/./d\" will reduce to \"/a/c/d\""
1530   (let* ((path (split-string filename "/" t))
1531          (is-directory (string-match-p (rx (: (or "." ".." "/") line-end)) filename))
1532          (path-reversed-normalized
1533           (seq-reduce (lambda (a b)
1534                         (cond ((equal b "..") (cdr a))
1535                               ((equal b ".") a)
1536                               (t (cons b a))))
1537                       path nil))
1538          (path-normalized (reverse path-reversed-normalized)))
1539     (if path-normalized
1540         (concat "/" (string-join path-normalized "/") (and is-directory "/"))
1541       "/")))
1542
1543 (defun elpher-address-from-gemini-url (url)
1544   "Extract address from URL with defaults as per gemini map files.
1545 While there's obviously some redundancy here between this function and
1546 `elpher-address-from-url', gemini map file URLs require enough special
1547 treatment that a separate function is warranted."
1548   (let ((address (url-generic-parse-url url))
1549         (current-address (elpher-page-address elpher-current-page)))
1550     (unless (and (url-type address) (not (url-fullness address))) ;avoid mangling mailto: urls
1551       (if (url-host address) ;if there is an explicit host, filenames are absolute
1552           (if (string-empty-p (url-filename address))
1553               (setf (url-filename address) "/")) ;ensure empty filename is marked as absolute
1554         (setf (url-host address) (url-host current-address))
1555         (setf (url-fullness address) (url-host address)) ; set fullness to t if host is set
1556         (setf (url-portspec address) (url-portspec current-address)) ; (url-port) too slow!
1557         (unless (string-prefix-p "/" (url-filename address)) ;deal with relative links
1558           (setf (url-filename address)
1559                 (concat (file-name-directory (url-filename current-address))
1560                         (url-filename address)))))
1561       (when (url-host address)
1562         (setf (url-host address) (puny-encode-domain (url-host address))))
1563       (unless (url-type address)
1564         (setf (url-type address) (url-type current-address)))
1565       (when (equal (url-type address) "gemini")
1566         (setf (url-filename address)
1567               (elpher-collapse-dot-sequences (url-filename address)))))
1568     (elpher-remove-redundant-ports address)))
1569
1570 (defun elpher-gemini-insert-link (link-line)
1571   "Insert link described by LINK-LINE into a text/gemini document."
1572   (let ((url (elpher-gemini-get-link-url link-line)))
1573     (when url
1574       (let* ((given-display-string (elpher-gemini-get-link-display-string link-line))
1575              (address (elpher-address-from-gemini-url url))
1576              (type (if address (elpher-address-type address) nil))
1577              (type-map-entry (cdr (assoc type elpher-type-map)))
1578              (fill-prefix (make-string (+ 1 (length elpher-gemini-link-string)) ?\s)))
1579         (when type-map-entry
1580           (insert elpher-gemini-link-string)
1581           (let* ((face (elt type-map-entry 3))
1582                  (display-string (or given-display-string
1583                                      (elpher-address-to-iri address)))
1584                  (page (elpher-make-page display-string
1585                                          address)))
1586             (insert-text-button display-string
1587                                 'face face
1588                                 'elpher-page page
1589                                 'action #'elpher-click-link
1590                                 'follow-link t
1591                                 'help-echo #'elpher--page-button-help))
1592           (newline))))))
1593
1594 (defun elpher-gemini-insert-header (header-line)
1595   "Insert header described by HEADER-LINE into a text/gemini document.
1596 The gemini map file line describing the header is given
1597 by HEADER-LINE."
1598   (when (string-match "^\\(#+\\)[ \t]*" header-line)
1599     (let* ((level (length (match-string 1 header-line)))
1600            (header (substring header-line (match-end 0)))
1601            (face (pcase level
1602                    (1 'elpher-gemini-heading1)
1603                    (2 'elpher-gemini-heading2)
1604                    (3 'elpher-gemini-heading3)
1605                    (_ 'default)))
1606            (fill-column (if (display-graphic-p)
1607                             (/ (* fill-column
1608                                   (font-get (font-spec :name (face-font 'default)) :size))
1609                                (font-get (font-spec :name (face-font face)) :size)) fill-column)))
1610       (unless (display-graphic-p)
1611         (insert (make-string level ?#) " "))
1612       (insert (propertize header
1613                           'face face
1614                           'gemini-heading t
1615                           'rear-nonsticky t))
1616       (newline))))
1617
1618 (defun elpher-gemini-insert-text (text-line)
1619   "Insert a plain non-preformatted TEXT-LINE into a text/gemini document.
1620 This function uses Emacs' auto-fill to wrap text sensibly to a maximum
1621 width defined by `elpher-gemini-max-fill-width'."
1622   (string-match
1623    (rx (: line-start
1624           (optional
1625            (group (or (: "*" (+ (any " \t")))
1626                       (: ">" (* (any " \t"))))))))
1627    text-line)
1628   (let* ((line-prefix (match-string 1 text-line))
1629          (processed-text-line
1630           (if line-prefix
1631               (cond ((string-prefix-p "*" line-prefix)
1632                      (concat
1633                       (replace-regexp-in-string "\\*"
1634                                                 elpher-gemini-bullet-string
1635                                                 (match-string 0 text-line))
1636                       (substring text-line (match-end 0))))
1637                     ((string-prefix-p ">" line-prefix)
1638                      (propertize text-line 'face 'elpher-gemini-quoted))
1639                     (t text-line))
1640             text-line))
1641          (fill-prefix (if line-prefix
1642                           (make-string (length (match-string 0 text-line)) ?\s)
1643                         "")))
1644     (insert (elpher-process-text-for-display processed-text-line))
1645     (newline)))
1646
1647 (defun elpher-gemini-pref-expand-collapse (button)
1648   "Function called when the preformatted text toggle BUTTON is activated."
1649   (let ((id (button-get button 'pref-id)))
1650     (if (invisible-p id)
1651         (remove-from-invisibility-spec id)
1652       (add-to-invisibility-spec id))
1653     (redraw-display)))
1654
1655 (defun elpher-gemini-insert-preformatted-toggler (alt-text)
1656   "Insert a button for toggling the visibility of preformatted text.
1657 If non-nil, ALT-TEXT is displayed alongside the button."
1658   (let* ((url-string (url-recreate-url (elpher-page-address elpher-current-page)))
1659          (pref-id (intern (concat "pref-"
1660                                   (number-to-string (point))
1661                                   "-"
1662                                   url-string))))
1663     (insert elpher-gemini-preformatted-toggle-bullet)
1664     (when alt-text
1665       (insert (propertize (concat alt-text " ")
1666                           'face 'elpher-gemin-preformatted)))
1667     (insert-text-button elpher-gemini-preformatted-toggle-label
1668                         'action #'elpher-gemini-pref-expand-collapse
1669                         'pref-id pref-id
1670                         'face 'elpher-gemini-preformatted-toggle)
1671     (add-to-invisibility-spec pref-id)
1672     (newline)
1673     pref-id))
1674
1675 (defun elpher-gemini-insert-preformatted-line (line &optional pref-id)
1676   "Insert a LINE of preformatted text.
1677 PREF-ID is the value assigned to the \"invisible\" text attribute, which
1678 can be used to toggle the display of the preformatted text."
1679   (insert (propertize (concat (elpher-process-text-for-display
1680                                (propertize line 'face 'elpher-gemini-preformatted))
1681                               "\n")
1682                       'invisible pref-id
1683                       'rear-nonsticky t)))
1684
1685 (defun elpher-render-gemini-map (data _parameters)
1686   "Render DATA as a gemini map file, PARAMETERS is currently unused."
1687   (elpher-with-clean-buffer
1688    (auto-fill-mode 1)
1689    (setq-local buffer-invisibility-spec nil)
1690    (let ((preformatted nil)
1691          (adaptive-fill-mode nil)) ;Prevent automatic setting of fill-prefix
1692      (setq-local fill-column (min (window-width) elpher-gemini-max-fill-width))
1693      (dolist (line (split-string data "\n"))
1694        (pcase line
1695          ((rx (: string-start "```" (opt (let alt-text (+ any)))))
1696           (setq preformatted
1697                 (if preformatted
1698                     nil
1699                   (if elpher-gemini-hide-preformatted
1700                       (elpher-gemini-insert-preformatted-toggler alt-text)
1701                     t))))
1702          ((guard  preformatted)
1703           (elpher-gemini-insert-preformatted-line line preformatted))
1704          ((pred (string-prefix-p "=>"))
1705           (elpher-gemini-insert-link line))
1706          ((pred (string-prefix-p "#"))
1707           (elpher-gemini-insert-header line))
1708          (_ (elpher-gemini-insert-text line))))
1709    (elpher-cache-content
1710     (elpher-page-address elpher-current-page)
1711     (buffer-string)))))
1712
1713 (defun elpher-render-gemini-plain-text (data _parameters)
1714   "Render DATA as plain text file.  PARAMETERS is currently unused."
1715   (elpher-with-clean-buffer
1716    (insert (elpher-process-text-for-display data))
1717    (elpher-cache-content
1718     (elpher-page-address elpher-current-page)
1719     (buffer-string))))
1720
1721 (defun elpher-build-current-imenu-index ()
1722   "Build imenu index for current elpher buffer."
1723   (save-excursion
1724     (goto-char (point-min))
1725     (let ((match nil)
1726           (headers nil))
1727       (while (setq match (text-property-search-forward 'gemini-heading t t))
1728         (push (cons
1729                (buffer-substring-no-properties (prop-match-beginning match)
1730                                                (prop-match-end match))
1731                (prop-match-beginning match))
1732               headers))
1733       (reverse headers))))
1734
1735
1736 ;;; Finger page connection
1737 ;;
1738
1739 (defun elpher-get-finger-page (renderer)
1740   "Opens a finger connection to the current page address.
1741 The result is rendered using RENDERER."
1742   (let* ((address (elpher-page-address elpher-current-page))
1743          (content (elpher-get-cached-content address)))
1744     (if (and content (funcall renderer nil))
1745         (elpher-with-clean-buffer
1746          (insert content)
1747          (elpher-restore-pos))
1748       (elpher-with-clean-buffer
1749        (insert "LOADING... (use 'u' to cancel)\n"))
1750       (condition-case the-error
1751           (let* ((kill-buffer-query-functions nil)
1752                  (user (let ((filename (elpher-address-filename address)))
1753                          (if (> (length filename) 1)
1754                              (substring filename 1)
1755                            (elpher-address-user address)))))
1756             (elpher-get-host-response address 79
1757                                       (concat user "\r\n")
1758                                       renderer))
1759         (error
1760          (elpher-network-error address the-error))))))
1761
1762
1763 ;;; Telnet page connection
1764 ;;
1765
1766 (defun elpher-get-telnet-page (renderer)
1767   "Opens a telnet connection to the current page address (RENDERER must be nil)."
1768   (when renderer
1769     (elpher-visit-previous-page)
1770     (error "Command not supported for telnet URLs"))
1771   (let* ((address (elpher-page-address elpher-current-page))
1772          (host (elpher-address-host address))
1773          (port (elpher-address-port address)))
1774     (elpher-visit-previous-page)
1775     (if (> port 0)
1776         (telnet host port)
1777       (telnet host))))
1778
1779
1780 ;;; Other URL page opening
1781 ;;
1782
1783 (defun elpher-get-other-url-page (renderer)
1784   "Getter which attempts to open the URL specified by the current page.
1785 The RENDERER argument to this getter must be nil."
1786   (when renderer
1787     (elpher-visit-previous-page)
1788     (error "Command not supported for general URLs"))
1789   (let* ((address (elpher-page-address elpher-current-page))
1790          (url (elpher-address-to-url address)))
1791     (elpher-visit-previous-page) ; Do first in case of non-local exits.
1792     (message "Opening URL...")
1793     (if elpher-open-urls-with-eww
1794         (browse-web url)
1795       (browse-url url))))
1796
1797
1798 ;;; File page
1799 ;;
1800
1801 (defun elpher-get-file-page (renderer)
1802   "Getter which renders a local file using RENDERER.
1803 Assumes UTF-8 encoding for all text files."
1804   (let* ((address (elpher-page-address elpher-current-page))
1805          (filename (elpher-address-filename address)))
1806     (unless (file-exists-p filename)
1807       (elpher-visit-previous-page)
1808       (error "File not found"))
1809     (unless (file-readable-p filename)
1810       (elpher-visit-previous-page)
1811       (error "Could not read from file"))
1812     (let ((body (with-temp-buffer
1813        (let ((coding-system-for-read 'binary)
1814              (coding-system-for-write 'binary))
1815          (insert-file-contents-literally filename)
1816          (encode-coding-string (buffer-string) 'raw-text)))))
1817        (if renderer
1818            (funcall renderer body nil)
1819          (pcase (file-name-extension filename)
1820            ((or  "gmi" "gemini")
1821             (elpher-render-gemini-map (decode-coding-string body 'utf-8) nil))
1822            ((or "htm" "html")
1823             (elpher-render-html (decode-coding-string body 'utf-8)))
1824            ((or "txt" "")
1825             (elpher-render-text (decode-coding-string body 'utf-8)))
1826            ((or "jpg" "jpeg" "gif" "png" "bmp" "tif" "tiff")
1827             (elpher-render-image body))
1828            ((or "gopher" "gophermap")
1829             (elpher-render-index (elpher-decode body)))
1830            (_
1831             (elpher-render-download body))))
1832        (elpher-restore-pos))))
1833
1834
1835 ;;; Welcome page retrieval
1836 ;;
1837
1838 (defun elpher-get-welcome-page (renderer)
1839   "Getter which displays the welcome page (RENDERER must be nil)."
1840   (when renderer
1841     (elpher-visit-previous-page)
1842     (error "Command not supported for welcome page"))
1843   (elpher-with-clean-buffer
1844    (insert "     --------------------------------------------\n"
1845            "           Elpher Gopher and Gemini Client       \n"
1846            "                   version " elpher-version "\n"
1847            "     --------------------------------------------\n"
1848            "\n"
1849            "Default bindings:\n"
1850            "\n"
1851            " - TAB/Shift-TAB: next/prev item on current page\n"
1852            " - RET/mouse-1: open item under cursor\n"
1853            " - m: select an item on current page by name (autocompletes)\n"
1854            " - u/mouse-3/U: return to previous page or to the start page\n"
1855            " - g: go to a particular address (gopher, gemini, finger)\n"
1856            " - o/O: open a different address selector or the root menu of the current server\n"
1857            " - d/D: download item under cursor or current page\n"
1858            " - i/I: info on item under cursor or current page\n"
1859            " - c/C: copy URL representation of item under cursor or current page\n"
1860            " - a/A: bookmark the item under cursor or current page\n"
1861            " - B: list all bookmarks\n"
1862            " - s/S: show current history stack or all previously visted pages\n"
1863            " - r: redraw current page (using cached contents if available)\n"
1864            " - R: reload current page (regenerates cache)\n"
1865            " - !: set character coding system for gopher (default is to autodetect)\n"
1866            " - T: toggle TLS gopher mode\n"
1867            " - F: forget/discard current TLS client certificate\n"
1868            " - .: display the raw server response for the current page\n"
1869            "\n"
1870            "Start your exploration of gopher space and gemini:\n")
1871    (elpher-insert-index-record "Floodgap Systems Gopher Server"
1872                                (elpher-make-gopher-address ?1 "" "gopher.floodgap.com" 70))
1873    (elpher-insert-index-record "Project Gemini home page"
1874                                (elpher-address-from-url "gemini://gemini.circumlunar.space/"))
1875    (insert "\n"
1876            "Alternatively, select a search engine and enter some search terms:\n")
1877    (elpher-insert-index-record "Gopher Search Engine (Veronica-2)"
1878                                (elpher-make-gopher-address ?7 "/v2/vs" "gopher.floodgap.com" 70))
1879    (elpher-insert-index-record "Gemini Search Engine (geminispace.info)"
1880                                (elpher-address-from-url "gemini://geminispace.info/search"))
1881    (insert "\n"
1882            "Your bookmarks are stored in your ")
1883    (insert-text-button "bookmark list"
1884                        'face 'link
1885                        'action #'elpher-click-link
1886                        'follow-link t
1887                        'help-echo #'elpher--page-button-help
1888                        'elpher-page
1889                        (elpher-make-page "Elpher Bookmarks"
1890                                          (elpher-make-about-address 'bookmarks)))
1891    (insert ".\n")
1892    (insert (propertize
1893             "(Bookmarks from legacy elpher-bookmarks files will be automatically imported.)\n"
1894             'face 'shadow))
1895    (insert "\n"
1896            "The gopher home of the Elpher project is here:\n")
1897    (elpher-insert-index-record "The Elpher Project Page"
1898                                (elpher-make-gopher-address ?1
1899                                                            "/projects/elpher/"
1900                                                            "thelambdalab.xyz"
1901                                                            70))
1902    (let ((help-string "RET,mouse-1: Open Elpher info manual (if available)"))
1903      (insert "\n"
1904              "The following info documentation is available:\n"
1905              "   - ")
1906      (insert-text-button "Elpher Manual"
1907                          'face 'link
1908                          'action (lambda (_)
1909                                    (interactive)
1910                                    (info "(elpher)"))
1911                          'follow-link t
1912                          'help-echo help-string)
1913      (insert "\n   - ")
1914      (insert-text-button "Changes introduced by the latest release"
1915                        'face 'link
1916                        'action (lambda (_)
1917                                  (interactive)
1918                                  (info "(elpher)News"))
1919                        'follow-link t
1920                        'help-echo help-string))
1921    (insert "\n")
1922    (insert (propertize
1923             (concat "(These documents should be available if you have installed Elpher\n"
1924                     " from MELPA or non-GNU ELPA. Otherwise you may have to install the\n"
1925                     " manual yourself.)\n")
1926             'face 'shadow))
1927    (elpher-restore-pos)))
1928
1929
1930 ;;; History page retrieval
1931 ;;
1932
1933 (defun elpher-show-history ()
1934   "Show the current contents of elpher's history stack.
1935 Use \\[elpher-show-visited-pages] to see the entire history.
1936 This is rendered using `elpher-get-history-page' via `elpher-type-map'."
1937   (interactive)
1938   (elpher-visit-page
1939    (elpher-make-page "Current History Stack"
1940                      (elpher-make-about-address 'history))))
1941
1942 (defun elpher-show-visited-pages ()
1943   "Show the all the pages you've visited using Elpher.
1944 Use \\[elpher-show-history] to see just the current history stack.
1945 This is rendered using `elpher-get-visited-pages-page' via `elpher-type-map'."
1946   (interactive)
1947   (elpher-visit-page
1948    (elpher-make-page "Elpher Visted Pages"
1949                      (elpher-make-about-address 'visited-pages))))
1950
1951 (defun elpher-get-history-page (renderer)
1952   "Getter which displays the history page (RENDERER must be nil)."
1953   (when renderer
1954     (elpher-visit-previous-page)
1955     (error "Command not supported for history page"))
1956   (elpher-display-history-links elpher-history "Current history stack"))
1957
1958 (defun elpher-get-visited-pages-page (renderer)
1959   "Getter which displays the list of visited pages (RENDERER must be nil)."
1960   (when renderer
1961     (elpher-visit-previous-page)
1962     (error "Command not supported for history page"))
1963   (elpher-display-history-links
1964    (seq-filter (lambda (page)
1965                  (not (elpher-address-about-p (elpher-page-address page))))
1966                elpher-visited-pages)
1967    "All visited pages"))
1968
1969 (defun elpher-display-history-links (pages title)
1970   "Show all PAGES in an Elpher buffer with a given TITLE."
1971   (let* ((title-line (concat " ---- " title " ----"))
1972          (footer-line (make-string (length title-line) ?-)))
1973     (elpher-with-clean-buffer
1974      (insert title-line "\n\n")
1975      (if pages
1976          (dolist (page pages)
1977            (when page
1978              (let ((display-string (elpher-page-display-string page))
1979                    (address (elpher-page-address page)))
1980                (elpher-insert-index-record display-string address))))
1981        (insert "No history items found.\n"))
1982      (insert "\n " footer-line "\n"
1983              "Select an entry or press 'u' to return to the previous page.")
1984      (elpher-restore-pos))))
1985
1986
1987 ;;; Bookmarks
1988 ;;
1989
1990 ;; This code allows Elpher to use the standard Emacs bookmarks: `C-x r
1991 ;; m' to add a bookmark, `C-x r l' to list bookmarks (which is where
1992 ;; you can anotate bookmarks!), `C-x r b' to jump to a bookmark, and
1993 ;; so on. See the Bookmarks section in the Emacs info manual for more.
1994
1995 (defvar elpher-bookmark-link nil
1996   "Prefer bookmarking a link or the current page.
1997 Bind this variable dynamically, or set it to t.
1998 If you set it to t, the commands \\[bookmark-set-no-overwrite]
1999 and \\[elpher-set-bookmark-no-overwrite] do the same thing.")
2000
2001 (defun elpher-bookmark-make-record ()
2002   "Return a bookmark record.
2003 If `elpher-bookmark-link' is non-nil and point is on a link button,
2004 return a bookmark record for that link.  Otherwise, return a bookmark
2005 record for the current elpher page."
2006   (let* ((button (and elpher-bookmark-link (button-at (point))))
2007          (page (if button
2008                    (button-get button 'elpher-page)
2009                  elpher-current-page)))
2010     (unless page
2011       (error "Cannot bookmark this link"))
2012     (let* ((address (elpher-page-address page))
2013            (url (elpher-address-to-url address))
2014            (display-string (elpher-page-display-string page))
2015            (pos (if button nil (point))))
2016       (if (elpher-address-about-p address)
2017           (error "Cannot bookmark %s" display-string)
2018         `(,display-string
2019           (defaults . (,display-string))
2020           (position . ,pos)
2021           (location . ,url)
2022           (handler . elpher-bookmark-jump))))))
2023
2024 ;;;###autoload
2025 (defun elpher-bookmark-jump (bookmark)
2026   "Handler used to open a bookmark using elpher.
2027 The argument BOOKMARK is a bookmark record passed to the function.
2028 This handler is responsible for loading the bookmark in some buffer,
2029 then making that buffer the current buffer.  It should not switch
2030 to the buffer."
2031   (let* ((url (cdr (assq 'location bookmark)))
2032          (cleaned-url (string-trim url))
2033          (page (elpher-page-from-url cleaned-url))
2034          (buffer (get-buffer-create elpher-buffer-name)))
2035     (elpher-with-clean-buffer
2036      (elpher-visit-page page))
2037     (set-buffer buffer)
2038     nil))
2039
2040 (defun elpher-bookmark-link ()
2041   "Bookmark the link at point.
2042 To bookmark the current page, use \\[elpher-bookmark-current]."
2043   (interactive)
2044   (let ((elpher-bookmark-link t))
2045     (bookmark-set-no-overwrite)))
2046
2047 (defun elpher-bookmark-current ()
2048   "Bookmark the current page.
2049 To bookmark the link at point use \\[elpher-bookmark-link]."
2050   (interactive)
2051   (call-interactively #'bookmark-set-no-overwrite))
2052
2053 (defun elpher-bookmark-import (file)
2054   "Import legacy Elpher bookmarks file FILE into Emacs bookmarks."
2055   (interactive (list (if (and (boundp 'elpher-bookmarks-file)
2056                               (file-readable-p elpher-bookmarks-file))
2057                          elpher-bookmarks-file
2058                        (read-file-name "Old Elpher bookmarks: "
2059                                        user-emacs-directory nil t
2060                                        "elpher-bookmarks"))))
2061   (dolist (bookmark (with-temp-buffer
2062                       (insert-file-contents file)
2063                       (read (current-buffer))))
2064     (let* ((display-string (car bookmark))
2065            (url (cadr bookmark))
2066            (record `(,display-string
2067                      (location . ,url)
2068                      (handler . elpher-bookmark-jump))))
2069       (bookmark-store display-string (cdr record) t)))
2070   (bookmark-save))
2071
2072 (defun elpher-get-bookmarks-page (renderer)
2073   "Getter which displays the bookmarks (RENDERER must be nil)."
2074   (when renderer
2075     (elpher-visit-previous-page)
2076     (error "Command not supported for bookmarks page"))
2077
2078   (let ((old-bookmarks-file (or (and (boundp 'elpher-bookmarks-file)
2079                                      elpher-bookmarks-file)
2080                                 (locate-user-emacs-file "elpher-bookmarks"))))
2081     (when (and (file-readable-p old-bookmarks-file)
2082                (y-or-n-p (concat "Legacy elpher-bookmarks file \""
2083                                  old-bookmarks-file
2084                                  "\" found. Import now?")))
2085       (elpher-bookmark-import old-bookmarks-file)
2086       (rename-file old-bookmarks-file (concat old-bookmarks-file "-legacy"))))
2087
2088   (if (and elpher-use-emacs-bookmark-menu
2089            elpher-history)
2090       (progn
2091         (elpher-visit-previous-page)
2092         (call-interactively #'bookmark-bmenu-list))
2093     (elpher-with-clean-buffer
2094      (insert " ---- Elpher Bookmarks ---- \n\n")
2095      (bookmark-maybe-load-default-file)
2096      (dolist (bookmark (bookmark-maybe-sort-alist))
2097        (when (eq #'elpher-bookmark-jump (alist-get 'handler (cdr bookmark)))
2098          (let* ((name (car bookmark))
2099                 (url (alist-get 'location (cdr bookmark)))
2100                 (address (elpher-address-from-url url)))
2101            (elpher-insert-index-record name address))))
2102      (when (<= (line-number-at-pos) 3)
2103        (insert "No bookmarked pages found.\n"))
2104      (insert "\n --------------------------\n\n"
2105              "Select an entry or press 'u' to return to the previous page.\n\n"
2106              "Bookmarks can be renamed or deleted via the ")
2107      (insert-text-button "Emacs bookmark menu"
2108                          'action (lambda (_)
2109                                    (interactive)
2110                                    (call-interactively #'bookmark-bmenu-list))
2111                          'follow-link t
2112                          'help-echo "RET,mouse-1: open Emacs bookmark menu")
2113      (insert (substitute-command-keys
2114               ",\nwhich can also be opened from anywhere using '\\[bookmark-bmenu-list]'."))
2115      (elpher-restore-pos))))
2116
2117 (defun elpher-show-bookmarks ()
2118   "Interactive function to display the current list of elpher bookmarks."
2119   (interactive)
2120   (elpher-visit-page
2121    (elpher-make-page "Elpher Bookmarks"
2122                      (elpher-make-about-address 'bookmarks))))
2123
2124
2125 ;;; Integrations
2126 ;;
2127
2128 ;;; Org
2129
2130 (defun elpher-org-export-link (link description format protocol)
2131   "Export a LINK with DESCRIPTION for the given PROTOCOL and FORMAT.
2132
2133 FORMAT is an Org export backend.  DESCRIPTION may be nil.  PROTOCOL may be one
2134 of gemini, gopher or finger."
2135   (let* ((url (if (equal protocol "elpher")
2136                   (string-remove-prefix "elpher:" link)
2137                 (format "%s:%s" protocol link)))
2138          (desc (or description url)))
2139     (pcase format
2140       (`gemini (format "=> %s %s" url desc))
2141       (`html (format "<a href=\"%s\">%s</a>" url desc))
2142       (`latex (format "\\href{%s}{%s}" url desc))
2143       (_ (if (not description)
2144              url
2145            (format "%s (%s)" desc url))))))
2146
2147 (defun elpher-org-store-link ()
2148   "Store link to an `elpher' page in Org."
2149   (when (eq major-mode 'elpher-mode)
2150     (let* ((url (elpher-info-current))
2151            (desc (car elpher-current-page))
2152            (protocol (cond
2153                       ((string-prefix-p "gemini:" url) "gemini")
2154                       ((string-prefix-p "gopher:" url) "gopher")
2155                       ((string-prefix-p "finger:" url) "finger")
2156                       (t "elpher"))))
2157       (when (equal "elpher" protocol)
2158         ;; Weird link. Or special inner link?
2159         (setq url (concat "elpher:" url)))
2160       (org-link-store-props :type protocol :link url :description desc)
2161       t)))
2162
2163 (defun elpher-org-follow-link (link protocol)
2164   "Visit a LINK for the given PROTOCOL.
2165
2166 PROTOCOL may be one of gemini, gopher or finger.  This method also
2167 supports the old protocol elpher, where the link is self-contained."
2168   (let ((url (if (equal protocol "elpher")
2169                  (string-remove-prefix "elpher:" link)
2170                (format "%s:%s" protocol link))))
2171     (elpher-go url)))
2172
2173 (defun elpher-org-mode-integration ()
2174   "Set up `elpher' integration for `org-mode'."
2175   (org-link-set-parameters
2176    "elpher"
2177    :store #'elpher-org-store-link
2178    :export (lambda (link description format _plist)
2179              (elpher-org-export-link link description format "elpher"))
2180    :follow (lambda (link _arg) (elpher-org-follow-link link "elpher")))
2181   (org-link-set-parameters
2182    "gemini"
2183    :export (lambda (link description format _plist)
2184              (elpher-org-export-link link description format "gemini"))
2185    :follow (lambda (link _arg) (elpher-org-follow-link link "gemini")))
2186   (org-link-set-parameters
2187    "gopher"
2188    :export (lambda (link description format _plist)
2189              (elpher-org-export-link link description format "gopher"))
2190    :follow (lambda (link _arg) (elpher-org-follow-link link "gopher")))
2191   (org-link-set-parameters
2192    "finger"
2193    :export (lambda (link description format _plist)
2194              (elpher-org-export-link link description format "finger"))
2195    :follow (lambda (link _arg) (elpher-org-follow-link link "finger"))))
2196
2197 (add-hook 'org-mode-hook #'elpher-org-mode-integration)
2198
2199 ;; Browse URL
2200
2201 ;;;###autoload
2202 (defun elpher-browse-url-elpher (url &rest _args)
2203   "Browse URL using Elpher.  This function is used by `browse-url'."
2204   (interactive (browse-url-interactive-arg "Elpher URL: "))
2205   (elpher-go url))
2206
2207 ;; Use elpher to open gopher, finger and gemini links
2208 ;; For recent version of `browse-url' package
2209 (if (boundp 'browse-url-default-handlers)
2210     (add-to-list
2211      'browse-url-default-handlers
2212      '("^\\(gopher\\|finger\\|gemini\\)://" . elpher-browse-url-elpher))
2213   ;; Patch `browse-url-browser-function' for older ones. The value of
2214   ;; that variable is `browse-url-default-browser' by default, so
2215   ;; that's the function that gets advised. If the value is an alist,
2216   ;; however, we don't know what to do. Better not interfere?
2217   (when (and (symbolp browse-url-browser-function)
2218              (fboundp browse-url-browser-function))
2219     (advice-add browse-url-browser-function :before-while
2220                 (lambda (url &rest _args)
2221                   "Handle gemini, gopher, and finger schemes using Elpher."
2222                   (let ((scheme (downcase (car (split-string url ":" t)))))
2223                     (if (member scheme '("gemini" "gopher" "finger"))
2224                         ;; `elpher-go' always returns nil, which will stop the
2225                         ;; advice chain here in a before-while
2226                         (elpher-go url)
2227                       ;; chain must continue, then return t.
2228                       t))))))
2229
2230 ;; Register "gemini://" as a URI scheme so `browse-url' does the right thing
2231 (with-eval-after-load 'thingatpt
2232   (add-to-list 'thing-at-point-uri-schemes "gemini://"))
2233
2234 ;; Mu4e:
2235
2236 ;; Make mu4e aware of the gemini world
2237 (setq mu4e~view-beginning-of-url-regexp
2238       "\\(?:https?\\|gopher\\|finger\\|gemini\\)://\\|mailto:")
2239
2240 ;; eww:
2241
2242 ;; Let elpher handle gemini, gopher links in eww buffer.
2243 (setq eww-use-browse-url
2244       "\\`mailto:\\|\\(\\`gemini\\|\\`gopher\\|\\`finger\\)://")
2245
2246
2247 ;;; Interactive procedures
2248 ;;
2249
2250 (defun elpher-next-link ()
2251   "Move point to the next link on the current page."
2252   (interactive)
2253   (forward-button 1))
2254
2255 (defun elpher-prev-link ()
2256   "Move point to the previous link on the current page."
2257   (interactive)
2258   (backward-button 1))
2259
2260 (defun elpher-follow-current-link ()
2261   "Open the link or url at point."
2262   (interactive)
2263   (push-button))
2264
2265 ;;;###autoload
2266 (defun elpher-go (host-or-url)
2267   "Go to a particular gopher site HOST-OR-URL.
2268 When run interactively HOST-OR-URL is read from the minibuffer."
2269   (interactive (list
2270                 (read-string (format "Visit URL (default scheme %s): "
2271                                      (elpher-get-default-url-scheme)))))
2272   (let ((trimmed-host-or-url (string-trim host-or-url)))
2273     (unless (string-empty-p trimmed-host-or-url)
2274       (let ((page (elpher-page-from-url trimmed-host-or-url
2275                                         (elpher-get-default-url-scheme))))
2276         (unless (get-buffer-window elpher-buffer-name t)
2277           (switch-to-buffer elpher-buffer-name))
2278         (elpher-with-clean-buffer
2279          (elpher-visit-page page))
2280         nil)))) ; non-nil value is displayed by eshell
2281
2282 (defun elpher-go-current ()
2283   "Go to a particular URL which is read from the minibuffer.
2284 Unlike `elpher-go', the reader is initialized with the URL of the
2285 current page."
2286   (interactive)
2287   (let* ((address (elpher-page-address elpher-current-page))
2288          (url (read-string (format "Visit URL (default scheme %s): "
2289                                    (elpher-get-default-url-scheme))
2290                            (elpher-address-to-url address))))
2291     (let ((trimmed-url (string-trim url)))
2292       (unless (string-empty-p trimmed-url)
2293         (elpher-with-clean-buffer
2294          (elpher-visit-page
2295           (elpher-page-from-url trimmed-url (elpher-get-default-url-scheme))))))))
2296
2297 (defun elpher-redraw ()
2298   "Redraw current page."
2299   (interactive)
2300   (elpher-visit-page elpher-current-page))
2301
2302 (defun elpher-reload ()
2303   "Reload current page."
2304   (interactive)
2305   (elpher-reload-current-page))
2306
2307 (defun elpher-toggle-tls ()
2308   "Toggle TLS encryption mode for gopher."
2309   (interactive)
2310   (setq elpher-use-tls (not elpher-use-tls))
2311   (if elpher-use-tls
2312       (if (gnutls-available-p)
2313           (message "TLS gopher mode enabled.  (Will not affect current page until reload.)")
2314         (setq elpher-use-tls nil)
2315         (error "Cannot enable TLS gopher mode: GnuTLS not available"))
2316     (message "TLS gopher mode disabled.  (Will not affect current page until reload.)")))
2317
2318 (defun elpher-view-raw ()
2319   "View raw server response for current page."
2320   (interactive)
2321   (if (elpher-address-about-p (elpher-page-address elpher-current-page))
2322       (error "This page was not generated by a server")
2323     (elpher-visit-page elpher-current-page
2324                        #'elpher-render-raw)))
2325
2326 (defun elpher-back ()
2327   "Go to previous site."
2328   (interactive)
2329   (elpher-visit-previous-page))
2330
2331 (defun elpher-back-to-start ()
2332   "Go all the way back to the start page."
2333   (interactive)
2334   (setq-local elpher-current-page nil)
2335   (setq-local elpher-history nil)
2336   (elpher-visit-page (elpher-make-start-page)))
2337
2338 (defun elpher-download ()
2339   "Download the link at point."
2340   (interactive)
2341   (let ((button (button-at (point))))
2342     (if button
2343         (let ((page (button-get button 'elpher-page)))
2344           (unless page
2345             (error "Not an elpher page"))
2346           (when (elpher-address-about-p (elpher-page-address page))
2347             (error "Cannot download %s" (elpher-page-display-string page)))
2348           (elpher-visit-page (button-get button 'elpher-page)
2349                              #'elpher-render-download))
2350       (error "No link selected"))))
2351
2352 (defun elpher-download-current ()
2353   "Download the current page."
2354   (interactive)
2355   (if (elpher-address-about-p (elpher-page-address elpher-current-page))
2356       (error "Cannot download %s"
2357              (elpher-page-display-string elpher-current-page))
2358     (elpher-visit-page elpher-current-page
2359                        #'elpher-render-download
2360                        t)))
2361
2362 (defun elpher--build-link-map ()
2363   "Build alist mapping link names to destination pages in current buffer."
2364   (let ((link-map nil)
2365         (b (next-button (point-min) t)))
2366     (while b
2367       (push (cons (button-label b) b) link-map)
2368       (setq b (next-button (button-start b))))
2369     link-map))
2370
2371 (defun elpher-jump ()
2372   "Select a directory entry by name.  Similar to the info browser (m)enu command."
2373   (interactive)
2374   (let* ((link-map (elpher--build-link-map)))
2375     (if link-map
2376         (let ((key (let ((completion-ignore-case t))
2377                      (completing-read "Directory item/link: "
2378                                       link-map nil t))))
2379           (if (and key (> (length key) 0))
2380               (let ((b (cdr (assoc key link-map))))
2381                 (goto-char (button-start b))
2382                 (button-activate b)))))))
2383
2384 (defun elpher-root-dir ()
2385   "Visit root of current server."
2386   (interactive)
2387   (let ((address (elpher-page-address elpher-current-page)))
2388     (if (not (elpher-address-about-p address))
2389         (if (or (member (url-filename address) '("/" ""))
2390                 (and (elpher-address-gopher-p address)
2391                      (= (length (elpher-gopher-address-selector address)) 0)))
2392             (error "Already at root directory of current server")
2393           (let ((address-copy (elpher-address-from-url
2394                                (elpher-address-to-url address))))
2395             (setf (url-filename address-copy) "")
2396             (elpher-go (elpher-address-to-url address-copy))))
2397       (error "Command invalid for %s" (elpher-page-display-string elpher-current-page)))))
2398
2399 (defun elpher-info-page (page)
2400   "Display URL of PAGE in minibuffer."
2401   (let* ((address (elpher-page-address page))
2402          (url (elpher-address-to-url address))
2403          (iri (elpher-address-to-iri address)))
2404     (if (equal url iri)
2405         (message "%s" url)
2406       (message "%s (Raw: %s)" iri url))))
2407
2408 (defun elpher-info-link ()
2409   "Display information on page corresponding to link at point."
2410   (interactive)
2411   (let ((button (button-at (point))))
2412     (unless button
2413       (error "No item selected"))
2414     (let ((page (button-get button 'elpher-page)))
2415       (unless page
2416         (error "Not an elpher page"))
2417       (elpher-info-page page))))
2418
2419 (defun elpher-info-current ()
2420   "Display information on current page."
2421   (interactive)
2422   (elpher-info-page elpher-current-page))
2423
2424 (defun elpher-copy-page-url (page)
2425   "Copy URL representation of address of PAGE to `kill-ring'."
2426   (let* ((address (elpher-page-address page))
2427          (url (elpher-address-to-url address)))
2428     (message "Copied \"%s\" to kill-ring/clipboard." url)
2429     (kill-new url)))
2430
2431 (defun elpher-copy-link-url ()
2432   "Copy URL of item at point to `kill-ring'."
2433   (interactive)
2434   (let ((button (button-at (point))))
2435     (unless button
2436       (error "No item selected"))
2437     (let ((page (button-get button 'elpher-page)))
2438       (unless page
2439         (error "Not an elpher page"))
2440       (elpher-copy-page-url page))))
2441
2442 (defun elpher-copy-current-url ()
2443   "Copy URL of current page to `kill-ring'."
2444   (interactive)
2445   (elpher-copy-page-url elpher-current-page))
2446
2447 (defun elpher-set-gopher-coding-system ()
2448   "Specify an explicit character coding system for gopher selectors."
2449   (interactive)
2450   (let ((system (read-coding-system "Set coding system to use for gopher (default is to autodetect): " nil)))
2451     (setq elpher-user-coding-system system)
2452     (if system
2453         (message "Gopher coding system fixed to %s. (Reload to see effect)." system)
2454       (message "Gopher coding system set to autodetect. (Reload to see effect)."))))
2455
2456
2457 ;;; Mode and keymap
2458 ;;
2459
2460 (defvar elpher-mode-map
2461   (let ((map (make-sparse-keymap)))
2462     (define-key map (kbd "TAB") 'elpher-next-link)
2463     (define-key map (kbd "<backtab>") 'elpher-prev-link)
2464     (define-key map (kbd "C-M-i") 'elpher-prev-link)
2465     (define-key map (kbd "u") 'elpher-back)
2466     (define-key map (kbd "-") 'elpher-back)
2467     (define-key map (kbd "^") 'elpher-back)
2468     (define-key map [mouse-3] 'elpher-back)
2469     (define-key map (kbd "U") 'elpher-back-to-start)
2470     (define-key map (kbd "g") 'elpher-go)
2471     (define-key map (kbd "o") 'elpher-go-current)
2472     (define-key map (kbd "O") 'elpher-root-dir)
2473     (define-key map (kbd "s") 'elpher-show-history)
2474     (define-key map (kbd "S") 'elpher-show-visited-pages)
2475     (define-key map (kbd "r") 'elpher-redraw)
2476     (define-key map (kbd "R") 'elpher-reload)
2477     (define-key map (kbd "T") 'elpher-toggle-tls)
2478     (define-key map (kbd ".") 'elpher-view-raw)
2479     (define-key map (kbd "d") 'elpher-download)
2480     (define-key map (kbd "D") 'elpher-download-current)
2481     (define-key map (kbd "m") 'elpher-jump)
2482     (define-key map (kbd "i") 'elpher-info-link)
2483     (define-key map (kbd "I") 'elpher-info-current)
2484     (define-key map (kbd "c") 'elpher-copy-link-url)
2485     (define-key map (kbd "C") 'elpher-copy-current-url)
2486     (define-key map (kbd "a") 'elpher-bookmark-link)
2487     (define-key map (kbd "A") 'elpher-bookmark-current)
2488     (define-key map (kbd "B") 'elpher-show-bookmarks)
2489     (define-key map (kbd "!") 'elpher-set-gopher-coding-system)
2490     (define-key map (kbd "F") 'elpher-forget-current-certificate)
2491     (when (fboundp 'evil-define-key*)
2492       (evil-define-key*
2493        'motion map
2494        (kbd "TAB") 'elpher-next-link
2495        (kbd "C-") 'elpher-follow-current-link
2496        (kbd "C-t") 'elpher-back
2497        (kbd "u") 'elpher-back
2498        (kbd "-") 'elpher-back
2499        (kbd "^") 'elpher-back
2500        [mouse-3] 'elpher-back
2501        (kbd "U") 'elpher-back-to-start
2502        (kbd "g") 'elpher-go
2503        (kbd "o") 'elpher-go-current
2504        (kbd "O") 'elpher-root-dir
2505        (kbd "s") 'elpher-show-history
2506        (kbd "S") 'elpher-show-visited-pages
2507        (kbd "r") 'elpher-redraw
2508        (kbd "R") 'elpher-reload
2509        (kbd "T") 'elpher-toggle-tls
2510        (kbd ".") 'elpher-view-raw
2511        (kbd "d") 'elpher-download
2512        (kbd "D") 'elpher-download-current
2513        (kbd "m") 'elpher-jump
2514        (kbd "i") 'elpher-info-link
2515        (kbd "I") 'elpher-info-current
2516        (kbd "c") 'elpher-copy-link-url
2517        (kbd "C") 'elpher-copy-current-url
2518        (kbd "a") 'elpher-bookmark-link
2519        (kbd "A") 'elpher-bookmark-current
2520        (kbd "B") 'elpher-show-bookmarks
2521        (kbd "!") 'elpher-set-gopher-coding-system
2522        (kbd "F") 'elpher-forget-current-certificate))
2523     map)
2524   "Keymap for gopher client.")
2525
2526 (define-derived-mode elpher-mode special-mode "elpher"
2527   "Major mode for elpher, an elisp gopher client.
2528
2529 This mode is automatically enabled by the interactive
2530 functions which initialize the client, namely
2531 `elpher', and `elpher-go'."
2532   (setq-local elpher-current-page nil)
2533   (setq-local elpher-history nil)
2534   (setq-local elpher-buffer-name (buffer-name))
2535   (setq-local bookmark-make-record-function #'elpher-bookmark-make-record)
2536   (setq-local imenu-create-index-function #'elpher-build-current-imenu-index))
2537
2538 (when (fboundp 'evil-set-initial-state)
2539   (evil-set-initial-state 'elpher-mode 'motion))
2540
2541
2542 ;;; Main start procedure
2543 ;;
2544
2545 ;;;###autoload
2546 (defun elpher (&optional arg)
2547   "Start elpher with default landing page.
2548 The buffer used for Elpher sessions is determined by the value of
2549 ‘elpher-buffer-name’.  If there is already an Elpher session active in
2550 that buffer, Emacs will simply switch to it.  Otherwise, a new session
2551 will begin.  A numeric prefix ARG (as in ‘\\[universal-argument] 42
2552 \\[execute-extended-command] elpher RET’) switches to the session with
2553 that number, creating it if necessary.  A non numeric prefix ARG means
2554 to create a new session.  Returns the buffer selected (or created)."
2555   (interactive "P")
2556   (let* ((name (default-value 'elpher-buffer-name))
2557          (buf (cond ((numberp arg)
2558                      (get-buffer-create (format "%s<%d>" name arg)))
2559                     (arg
2560                      (generate-new-buffer name))
2561                     (t
2562                      (get-buffer-create name)))))
2563     (pop-to-buffer-same-window buf)
2564     (unless (buffer-modified-p)
2565       (elpher-mode)
2566       (elpher-visit-page (elpher-make-start-page))
2567       "Started Elpher."))); Otherwise (elpher) evaluates to start page string.
2568
2569 ;;; elpher.el ends here