elpher.el

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