elpher.el

   1 ;;; elpher.el --- A friendly gopher client  -*- lexical-binding:t -*-
   2
   3 ;; Copyright (C) 2019 Tim Vaughan
   4
   5 ;; Author: Tim Vaughan <timv@ughan.xyz>
   6 ;; Created: 11 April 2019
   7 ;; Version: 2.7.0
   8 ;; Keywords: comm gopher
   9 ;; Homepage: http://thelambdalab.xyz/elpher
  10 ;; Package-Requires: ((emacs "26"))
  11
  12 ;; This file is not part of GNU Emacs.
  13
  14 ;; This program is free software: you can redistribute it and/or modify
  15 ;; it under the terms of the GNU General Public License as published by
  16 ;; the Free Software Foundation, either version 3 of the License, or
  17 ;; (at your option) any later version.
  18
  19 ;; This program is distributed in the hope that it will be useful,
  20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22 ;; GNU General Public License for more details.
  23
  24 ;; You should have received a copy of the GNU General Public License
  25 ;; along with this file.  If not, see <http://www.gnu.org/licenses/>.
  26
  27 ;;; Commentary:
  28
  29 ;; Elpher aims to provide a practical and friendly gopher client
  30 ;; for GNU Emacs.  It supports:
  31
  32 ;; - intuitive keyboard and mouse-driven browsing,
  33 ;; - out-of-the-box compatibility with evil-mode,
  34 ;; - clickable web and gopher links *in plain text*,
  35 ;; - caching of visited sites,
  36 ;; - pleasant and configurable colouring of Gopher directories,
  37 ;; - direct visualisation of image files,
  38 ;; - a simple bookmark management system,
  39 ;; - connections using TLS encryption,
  40 ;; - the fledgling Gemini protocol,
  41 ;; - the greybeard Finger protocol.
  42
  43 ;; To launch Elpher, simply use 'M-x elpher'.  This will open a start
  44 ;; page containing information on key bindings and suggested starting
  45 ;; points for your gopher exploration.
  46
  47 ;; Full instructions can be found in the Elpher info manual.
  48
  49 ;; Elpher is under active development.  Any suggestions for
  50 ;; improvements are welcome, and can be made on the official
  51 ;; project page, gopher://thelambdalab.xyz/1/projects/elpher/.
  52
  53 ;;; Code:
  54
  55 (provide 'elpher)
  56
  57 ;;; Dependencies
  58 ;;
  59
  60 (require 'seq)
  61 (require 'pp)
  62 (require 'shr)
  63 (require 'url-util)
  64 (require 'subr-x)
  65 (require 'dns)
  66 (require 'ansi-color)
  67 (require 'nsm)
  68
  69
  70 ;;; Global constants
  71 ;;
  72
  73 (defconst elpher-version "2.7.0"
  74   "Current version of elpher.")
  75
  76 (defconst elpher-margin-width 6
  77   "Width of left-hand margin used when rendering indicies.")
  78
  79 (defconst elpher-type-map
  80   '(((gopher ?0) elpher-get-gopher-page elpher-render-text "txt" elpher-text)
  81     ((gopher ?1) elpher-get-gopher-page elpher-render-index "/" elpher-index)
  82     ((gopher ?4) elpher-get-gopher-page elpher-render-download "bin" elpher-binary)
  83     ((gopher ?5) elpher-get-gopher-page elpher-render-download "bin" elpher-binary)
  84     ((gopher ?7) elpher-get-gopher-query-page elpher-render-index "?" elpher-search)
  85     ((gopher ?9) elpher-get-gopher-page elpher-render-download "bin" elpher-binary)
  86     ((gopher ?g) elpher-get-gopher-page elpher-render-image "img" elpher-image)
  87     ((gopher ?p) elpher-get-gopher-page elpher-render-image "img" elpher-image)
  88     ((gopher ?I) elpher-get-gopher-page elpher-render-image "img" elpher-image)
  89     ((gopher ?d) elpher-get-gopher-page elpher-render-download "doc" elpher-binary)
  90     ((gopher ?P) elpher-get-gopher-page elpher-render-download "doc" elpher-binary)
  91     ((gopher ?s) elpher-get-gopher-page elpher-render-download "snd" elpher-binary)
  92     ((gopher ?h) elpher-get-gopher-page elpher-render-html "htm" elpher-html)
  93     (gemini elpher-get-gemini-page elpher-render-gemini "gem" elpher-gemini)
  94     (finger elpher-get-finger-page elpher-render-text "txt" elpher-text)
  95     (telnet elpher-get-telnet-page nil "tel" elpher-telnet)
  96     (other-url elpher-get-other-url-page nil "url" elpher-other-url)
  97     ((special bookmarks) elpher-get-bookmarks-page nil "/" elpher-index)
  98     ((special start) elpher-get-start-page nil))
  99   "Association list from types to getters, renderers, margin codes and index faces.")
 100
 101
 102 ;;; Customization group
 103 ;;
 104
 105 (defgroup elpher nil
 106   "A gopher client."
 107   :group 'applications)
 108
 109 ;; General appearance and customizations
 110
 111 (defcustom elpher-open-urls-with-eww nil
 112   "If non-nil, open URL selectors using eww.
 113 Otherwise, use the system browser via the BROWSE-URL function."
 114   :type '(boolean))
 115
 116 (defcustom elpher-use-header t
 117   "If non-nil, display current page information in buffer header."
 118   :type '(boolean))
 119
 120 (defcustom elpher-auto-disengage-TLS nil
 121   "If non-nil, automatically disengage TLS following an unsuccessful connection.
 122 While enabling this may seem convenient, it is also potentially dangerous as it
 123 allows switching from an encrypted channel back to plain text without user input."
 124   :type '(boolean))
 125
 126 (defcustom elpher-connection-timeout 5
 127   "Specifies the number of seconds to wait for a network connection to time out."
 128   :type '(integer))
 129
 130 (defcustom elpher-filter-ansi-from-text nil
 131   "If non-nil, filter ANSI escape sequences from text.
 132 The default behaviour is to use the ansi-color package to interpret these
 133 sequences."
 134   :type '(boolean))
 135
 136 (defcustom elpher-gemini-TLS-cert-checks nil
 137   "If non-nil, verify gemini server TLS certs using the default security level.
 138 Otherwise, certificate verification is disabled.
 139
 140 This defaults to off because it is standard practice for Gemini servers
 141 to use self-signed certificates, meaning that most servers provide what
 142 EMACS considers to be an invalid certificate."
 143   :type '(boolean))
 144
 145 (defcustom elpher-gemini-max-fill-width 80
 146   "Specify the maximum default width (in columns) of text/gemini documents.
 147 The actual width used is the minimum of this value and the window width at
 148 the time when the text is rendered."
 149   :type '(integer))
 150
 151 ;; Face customizations
 152
 153 (defgroup elpher-faces nil
 154   "Elpher face customizations."
 155   :group 'elpher)
 156
 157 (defface elpher-index
 158   '((t :inherit font-lock-keyword-face))
 159   "Face used for directory type directory records.")
 160
 161 (defface elpher-text
 162   '((t :inherit bold))
 163   "Face used for text type directory records.")
 164
 165 (defface elpher-info
 166   '((t :inherit default))
 167   "Face used for info type directory records.")
 168
 169 (defface elpher-image
 170   '((t :inherit font-lock-string-face))
 171   "Face used for image type directory records.")
 172
 173 (defface elpher-search
 174   '((t :inherit warning))
 175   "Face used for search type directory records.")
 176
 177 (defface elpher-html
 178   '((t :inherit font-lock-comment-face))
 179   "Face used for html type directory records.")
 180
 181 (defface elpher-gemini
 182   '((t :inherit font-lock-regexp-grouping-backslash))
 183   "Face used for Gemini type directory records.")
 184
 185 (defface elpher-other-url
 186   '((t :inherit font-lock-comment-face))
 187   "Face used for other URL type links records.")
 188
 189 (defface elpher-telnet
 190   '((t :inherit font-lock-function-name-face))
 191   "Face used for telnet type directory records.")
 192
 193 (defface elpher-binary
 194   '((t :inherit font-lock-doc-face))
 195   "Face used for binary type directory records.")
 196
 197 (defface elpher-unknown
 198   '((t :inherit error))
 199   "Face used for directory records with unknown/unsupported types.")
 200
 201 (defface elpher-margin-key
 202   '((t :inherit bold))
 203   "Face used for directory margin key.")
 204
 205 (defface elpher-margin-brackets
 206   '((t :inherit shadow))
 207   "Face used for brackets around directory margin key.")
 208
 209 (defface elpher-gemini-heading1
 210   '((t :inherit bold :height 1.8))
 211   "Face used for brackets around directory margin key.")
 212
 213 (defface elpher-gemini-heading2
 214   '((t :inherit bold :height 1.5))
 215   "Face used for brackets around directory margin key.")
 216
 217 (defface elpher-gemini-heading3
 218   '((t :inherit bold :height 1.2))
 219   "Face used for brackets around directory margin key.")
 220
 221 ;;; Model
 222 ;;
 223
 224 ;; Address
 225
 226 ;; An elpher "address" object is either a url object or a symbol.
 227 ;; Symbol addresses are "special", corresponding to pages generated
 228 ;; dynamically for and by elpher.  All others represent pages which
 229 ;; rely on content retrieved over the network.
 230
 231 (defun elpher-address-from-url (url-string)
 232   "Create a ADDRESS object corresponding to the given URL-STRING."
 233   (let ((data (match-data))) ; Prevent parsing clobbering match data
 234     (unwind-protect
 235         (let ((url (url-generic-parse-url url-string)))
 236           (unless (and (not (url-fullness url)) (url-type url))
 237             (setf (url-fullness url) t)
 238             (setf (url-filename url)
 239                   (url-unhex-string (url-filename url)))
 240             (unless (url-type url)
 241               (setf (url-type url) "gopher"))
 242             (when (or (equal "gopher" (url-type url))
 243                       (equal "gophers" (url-type url)))
 244               ;; Gopher defaults
 245               (unless (url-host url)
 246                 (setf (url-host url) (url-filename url))
 247                 (setf (url-filename url) ""))
 248               (when (or (equal (url-filename url) "")
 249                         (equal (url-filename url) "/"))
 250                 (setf (url-filename url) "/1")))
 251             (when (equal "gemini" (url-type url))
 252               ;; Gemini defaults
 253               (if (equal (url-filename url) "")
 254                   (setf (url-filename url) "/"))))
 255           url)
 256       (set-match-data data))))
 257
 258 (defun elpher-make-gopher-address (type selector host port &optional tls)
 259   "Create an ADDRESS object using gopher directory record attributes.
 260 The basic attributes include: TYPE, SELECTOR, HOST and PORT.
 261 If the optional attribute TLS is non-nil, the address will be marked as
 262 requiring gopher-over-TLS."
 263   (cond
 264    ((and (equal type ?h)
 265          (string-prefix-p "URL:" selector))
 266     (elpher-address-from-url (elt (split-string selector "URL:") 1)))
 267    ((equal type ?8)
 268     (elpher-address-from-url
 269      (concat "telnet"
 270              "://" host
 271              ":" (number-to-string port))))
 272    (t
 273     (elpher-address-from-url
 274      (concat "gopher" (if tls "s" "")
 275              "://" host
 276              ":" (number-to-string port)
 277              "/" (string type)
 278              selector)))))
 279
 280 (defun elpher-make-special-address (type)
 281   "Create an ADDRESS object corresponding to the given special address symbol TYPE."
 282   type)
 283
 284 (defun elpher-address-to-url (address)
 285   "Get string representation of ADDRESS, or nil if ADDRESS is special."
 286   (if (not (elpher-address-special-p address))
 287       (url-encode-url (url-recreate-url address))
 288     nil))
 289
 290 (defun elpher-address-type (address)
 291   "Retrieve type of ADDRESS object.
 292 This is used to determine how to retrieve and render the document the
 293 address refers to, via the table `elpher-type-map'."
 294   (if (symbolp address)
 295       (list 'special address)
 296     (let ((protocol (url-type address)))
 297       (cond ((or (equal protocol "gopher")
 298                  (equal protocol "gophers"))
 299              (list 'gopher
 300                    (if (member (url-filename address) '("" "/"))
 301                        ?1
 302                      (string-to-char (substring (url-filename address) 1)))))
 303             ((equal protocol "gemini")
 304              'gemini)
 305             ((equal protocol "telnet")
 306              'telnet)
 307             ((equal protocol "finger")
 308              'finger)
 309             (t 'other-url)))))
 310
 311 (defun elpher-address-protocol (address)
 312   "Retrieve the transport protocol for ADDRESS.  This is nil for special addresses."
 313   (if (symbolp address)
 314       nil
 315     (url-type address)))
 316
 317 (defun elpher-address-filename (address)
 318   "Retrieve the filename component of ADDRESS.
 319 For gopher addresses this is a combination of the selector type and selector."
 320   (if (symbolp address)
 321       nil
 322     (url-filename address)))
 323
 324 (defun elpher-address-host (address)
 325   "Retrieve host from ADDRESS object."
 326   (url-host address))
 327
 328 (defun elpher-address-user (address)
 329   "Retrieve user from ADDRESS object."
 330   (url-user address))
 331
 332 (defun elpher-address-port (address)
 333   "Retrieve port from ADDRESS object.
 334 If no address is defined, returns 0.  (This is for compatibility with the URL library.)"
 335   (if (symbolp address)
 336       0
 337     (url-port address)))
 338
 339 (defun elpher-address-special-p (address)
 340   "Return non-nil if ADDRESS object is special (e.g. start page, bookmarks page)."
 341   (symbolp address))
 342
 343 (defun elpher-address-gopher-p (address)
 344   "Return non-nill if ADDRESS object is a gopher address."
 345   (and (not (elpher-address-special-p address))
 346        (member (elpher-address-protocol address) '("gopher gophers"))))
 347
 348 (defun elpher-gopher-address-selector (address)
 349   "Retrieve gopher selector from ADDRESS object."
 350   (if (member (url-filename address) '("" "/"))
 351       ""
 352     (substring (url-filename address) 2)))
 353
 354
 355 ;; Cache
 356
 357 (defvar elpher-content-cache (make-hash-table :test 'equal))
 358 (defvar elpher-pos-cache (make-hash-table :test 'equal))
 359
 360 (defun elpher-get-cached-content (address)
 361   "Retrieve the cached content for ADDRESS, or nil if none exists."
 362   (gethash address elpher-content-cache))
 363
 364 (defun elpher-cache-content (address content)
 365   "Set the content cache for ADDRESS to CONTENT."
 366   (puthash address content elpher-content-cache))
 367
 368 (defun elpher-get-cached-pos (address)
 369   "Retrieve the cached cursor position for ADDRESS, or nil if none exists."
 370   (gethash address elpher-pos-cache))
 371
 372 (defun elpher-cache-pos (address pos)
 373   "Set the cursor position cache for ADDRESS to POS."
 374   (puthash address pos elpher-pos-cache))
 375
 376
 377 ;; Page
 378
 379 (defun elpher-make-page (display-string address)
 380   "Create a page with DISPLAY-STRING and ADDRESS."
 381   (list display-string address))
 382
 383 (defun elpher-page-display-string (page)
 384   "Retrieve the display string corresponding to PAGE."
 385   (elt page 0))
 386
 387 (defun elpher-page-address (page)
 388   "Retrieve the address corresponding to PAGE."
 389   (elt page 1))
 390
 391 (defvar elpher-current-page nil)
 392 (defvar elpher-history nil)
 393
 394 (defun elpher-visit-page (page &optional renderer no-history)
 395   "Visit PAGE using its own renderer or RENDERER, if non-nil.
 396 Additionally, push PAGE onto the stack of previously-visited pages,
 397 unless NO-HISTORY is non-nil."
 398   (elpher-save-pos)
 399   (elpher-process-cleanup)
 400   (unless (or no-history
 401               (equal (elpher-page-address elpher-current-page)
 402                      (elpher-page-address page)))
 403     (push elpher-current-page elpher-history))
 404   (setq elpher-current-page page)
 405   (let* ((address (elpher-page-address page))
 406          (type (elpher-address-type address))
 407          (type-record (cdr (assoc type elpher-type-map))))
 408     (if type-record
 409         (funcall (car type-record)
 410                  (if renderer
 411                      renderer
 412                    (cadr type-record)))
 413       (elpher-visit-previous-page)
 414       (pcase type
 415         (`(gopher ,type-char)
 416          (error "Unsupported gopher selector type '%c' for '%s'"
 417                 type-char (elpher-address-to-url address)))
 418         (other
 419          (error "Unsupported address type '%S' for '%s'"
 420                 other (elpher-address-to-url address)))))))
 421
 422 (defun elpher-visit-previous-page ()
 423   "Visit the previous page in the history."
 424   (let ((previous-page (pop elpher-history)))
 425     (if previous-page
 426         (elpher-visit-page previous-page nil t)
 427       (error "No previous page"))))
 428
 429 (defun elpher-reload-current-page ()
 430   "Reload the current page, discarding any existing cached content."
 431   (elpher-cache-content (elpher-page-address elpher-current-page) nil)
 432   (elpher-visit-page elpher-current-page))
 433
 434 (defun elpher-save-pos ()
 435   "Save the current position of point to the current page."
 436   (when elpher-current-page
 437     (elpher-cache-pos (elpher-page-address elpher-current-page) (point))))
 438
 439 (defun elpher-restore-pos ()
 440   "Restore the position of point to that cached in the current page."
 441   (let ((pos (elpher-get-cached-pos (elpher-page-address elpher-current-page))))
 442     (if pos
 443         (goto-char pos)
 444       (goto-char (point-min)))))
 445
 446
 447 ;;; Buffer preparation
 448 ;;
 449
 450 (defun elpher-update-header ()
 451   "If `elpher-use-header' is true, display current page info in window header."
 452   (if elpher-use-header
 453       (let* ((display-string (elpher-page-display-string elpher-current-page))
 454              (address (elpher-page-address elpher-current-page))
 455              (tls-string (if (and (not (elpher-address-special-p address))
 456                                   (member (elpher-address-protocol address)
 457                                           '("gophers" "gemini")))
 458                              " [TLS encryption]"
 459                            ""))
 460              (header (concat display-string
 461                              (propertize tls-string 'face 'bold))))
 462         (setq header-line-format header))))
 463
 464 (defmacro elpher-with-clean-buffer (&rest args)
 465   "Evaluate ARGS with a clean *elpher* buffer as current."
 466   (list 'with-current-buffer "*elpher*"
 467         '(elpher-mode)
 468         (append (list 'let '((inhibit-read-only t))
 469                       '(setq-local network-security-level
 470                                    (default-value 'network-security-level))
 471                       '(erase-buffer)
 472                       '(elpher-update-header))
 473                 args)))
 474
 475
 476 ;;; Text Processing
 477 ;;
 478
 479 (defvar elpher-user-coding-system nil
 480   "User-specified coding system to use for decoding text responses.")
 481
 482 (defun elpher-decode (string)
 483   "Decode STRING using autodetected or user-specified coding system."
 484   (decode-coding-string string
 485                         (if elpher-user-coding-system
 486                             elpher-user-coding-system
 487                           (detect-coding-string string t))))
 488
 489 (defun elpher-preprocess-text-response (string)
 490   "Preprocess text selector response contained in STRING.
 491 This involes decoding the character representation, and clearing
 492 away CRs and any terminating period."
 493   (elpher-decode (replace-regexp-in-string "\n\.\n$" "\n"
 494                                            (replace-regexp-in-string "\r" "" string))))
 495
 496
 497 ;;; Network error reporting
 498 ;;
 499
 500 (defun elpher-network-error (address error)
 501   "Display ERROR message following unsuccessful negotiation with ADDRESS.
 502 ERROR can be either an error object or a string."
 503   (elpher-with-clean-buffer
 504    (insert (propertize "\n---- ERROR -----\n\n" 'face 'error)
 505            "When attempting to retrieve " (elpher-address-to-url address) ":\n"
 506            (if (stringp error) error (error-message-string error)) "\n"
 507            (propertize "\n----------------\n\n" 'face 'error)
 508            "Press 'u' to return to the previous page.")))
 509
 510
 511 ;;; Gopher selector retrieval
 512 ;;
 513
 514 (defvar elpher-network-timer nil
 515   "Timer used for network connections.")
 516
 517 (defun elpher-process-cleanup ()
 518   "Immediately shut down any extant elpher process and timers."
 519   (let ((p (get-process "elpher-process")))
 520     (if p (delete-process p)))
 521   (if (timerp elpher-network-timer)
 522       (cancel-timer elpher-network-timer)))
 523
 524 (defvar elpher-use-tls nil
 525   "If non-nil, use TLS to communicate with gopher servers.")
 526
 527 (defun elpher-get-selector (address renderer &optional force-ipv4)
 528   "Retrieve selector specified by ADDRESS, then render it using RENDERER.
 529 If FORCE-IPV4 is non-nil, explicitly look up and use IPv4 address corresponding
 530 to ADDRESS."
 531   (when (equal (elpher-address-protocol address) "gophers")
 532     (if (gnutls-available-p)
 533         (when (not elpher-use-tls)
 534           (setq elpher-use-tls t)
 535           (message "Engaging TLS gopher mode."))
 536       (error "Cannot retrieve TLS gopher selector: GnuTLS not available")))
 537   (unless (< (elpher-address-port address) 65536)
 538     (error "Cannot retrieve gopher selector: port number > 65536"))
 539   (condition-case nil
 540       (let* ((kill-buffer-query-functions nil)
 541              (port (elpher-address-port address))
 542              (host (elpher-address-host address))
 543              (selector-string-parts nil)
 544              (proc (open-network-stream "elpher-process"
 545                                         nil
 546                                         (if force-ipv4 (dns-query host) host)
 547                                         (if (> port 0) port 70)
 548                                         :type (if elpher-use-tls 'tls 'plain)
 549                                         :nowait t))
 550              (timer (run-at-time elpher-connection-timeout
 551                                  nil
 552                                  (lambda ()
 553                                    (pcase (process-status proc)
 554                                      ('failed
 555                                       (if (and (not (equal (elpher-address-protocol address)
 556                                                            "gophers"))
 557                                                elpher-use-tls
 558                                                (or elpher-auto-disengage-TLS
 559                                                    (yes-or-no-p "Could not establish encrypted connection.  Disable TLS mode?")))
 560                                           (progn
 561                                             (message "Disabling TLS mode.")
 562                                             (setq elpher-use-tls nil)
 563                                             (elpher-get-selector address renderer))
 564                                         (elpher-network-error address "Could not establish encrypted connection")))
 565                                      ('connect
 566                                       (elpher-process-cleanup)
 567                                       (unless force-ipv4
 568                                         (message "Connection timed out. Retrying with IPv4 address.")
 569                                         (elpher-get-selector address renderer t))))))))
 570         (setq elpher-network-timer timer)
 571         (set-process-coding-system proc 'binary)
 572         (set-process-filter proc
 573                             (lambda (_proc string)
 574                               (cancel-timer timer)
 575                               (setq selector-string-parts
 576                                     (cons string selector-string-parts))))
 577         (set-process-sentinel proc
 578                               (lambda (_proc event)
 579                                 (condition-case the-error
 580                                     (cond
 581                                      ((string-prefix-p "deleted" event))
 582                                      ((string-prefix-p "open" event)
 583                                       (let ((inhibit-eol-conversion t))
 584                                         (process-send-string
 585                                          proc
 586                                          (concat (elpher-gopher-address-selector address)
 587                                                  "\r\n"))))
 588                                      (t
 589                                       (cancel-timer timer)
 590                                       (funcall renderer (apply #'concat
 591                                                                (reverse selector-string-parts)))
 592                                       (elpher-restore-pos)))
 593                                   (error
 594                                    (elpher-network-error address the-error))))))
 595     (error
 596      (error "Error initiating connection to server"))))
 597
 598 (defun elpher-get-gopher-page (renderer)
 599   "Getter function for gopher pages.
 600 The RENDERER procedure is used to display the contents of the page
 601 once they are retrieved from the gopher server."
 602   (let* ((address (elpher-page-address elpher-current-page))
 603          (content (elpher-get-cached-content address)))
 604     (if (and content (funcall renderer nil))
 605         (elpher-with-clean-buffer
 606          (insert content)
 607          (elpher-restore-pos))
 608       (elpher-with-clean-buffer
 609        (insert "LOADING... (use 'u' to cancel)"))
 610       (condition-case the-error
 611           (elpher-get-selector address renderer)
 612         (error
 613          (elpher-network-error address the-error))))))
 614
 615 ;; Index rendering
 616
 617 (defun elpher-insert-index (string)
 618   "Insert the index corresponding to STRING into the current buffer."
 619   ;; Should be able to split directly on CRLF, but some non-conformant
 620   ;; LF-only servers sadly exist, hence the following.
 621   (let ((str-processed (elpher-preprocess-text-response string)))
 622     (dolist (line (split-string str-processed "\n"))
 623       (ignore-errors
 624         (unless (= (length line) 0)
 625           (let* ((type (elt line 0))
 626                  (fields (split-string (substring line 1) "\t"))
 627                  (display-string (elt fields 0))
 628                  (selector (elt fields 1))
 629                  (host (elt fields 2))
 630                  (port (if (elt fields 3)
 631                            (string-to-number (elt fields 3))
 632                          nil))
 633                  (address (elpher-make-gopher-address type selector host port)))
 634             (elpher-insert-index-record display-string address)))))))
 635
 636 (defun elpher-insert-margin (&optional type-name)
 637   "Insert index margin, optionally containing the TYPE-NAME, into the current buffer."
 638   (if type-name
 639       (progn
 640         (insert (format (concat "%" (number-to-string (- elpher-margin-width 1)) "s")
 641                         (concat
 642                          (propertize "[" 'face 'elpher-margin-brackets)
 643                          (propertize type-name 'face 'elpher-margin-key)
 644                          (propertize "]" 'face 'elpher-margin-brackets))))
 645         (insert " "))
 646     (insert (make-string elpher-margin-width ?\s))))
 647
 648 (defun elpher-page-button-help (page)
 649   "Return a string containing the help text for a button corresponding to PAGE."
 650   (let ((address (elpher-page-address page)))
 651     (format "mouse-1, RET: open '%s'" (if (elpher-address-special-p address)
 652                                           address
 653                                         (elpher-address-to-url address)))))
 654
 655 (defun elpher-insert-index-record (display-string &optional address)
 656   "Function to insert an index record into the current buffer.
 657 The contents of the record are dictated by DISPLAY-STRING and ADDRESS.
 658 If ADDRESS is not supplied or nil the record is rendered as an
 659 'information' line."
 660   (let* ((type (if address (elpher-address-type address) nil))
 661          (type-map-entry (cdr (assoc type elpher-type-map))))
 662     (if type-map-entry
 663         (let* ((margin-code (elt type-map-entry 2))
 664                (face (elt type-map-entry 3))
 665                (filtered-display-string (ansi-color-filter-apply display-string))
 666                (page (elpher-make-page filtered-display-string address)))
 667           (elpher-insert-margin margin-code)
 668           (insert-text-button filtered-display-string
 669                               'face face
 670                               'elpher-page page
 671                               'action #'elpher-click-link
 672                               'follow-link t
 673                               'help-echo (elpher-page-button-help page)))
 674       (pcase type
 675         ((or '(gopher ?i) 'nil) ;; Information
 676          (elpher-insert-margin)
 677          (let ((propertized-display-string
 678                 (propertize display-string 'face 'elpher-info)))
 679            (insert (elpher-process-text-for-display propertized-display-string))))
 680         (`(gopher ,selector-type) ;; Unknown
 681          (elpher-insert-margin (concat (char-to-string selector-type) "?"))
 682          (insert (propertize display-string
 683                              'face 'elpher-unknown)))))
 684     (insert "\n")))
 685
 686 (defun elpher-click-link (button)
 687   "Function called when the gopher link BUTTON is activated (via mouse or keypress)."
 688   (let ((page (button-get button 'elpher-page)))
 689     (elpher-visit-page page)))
 690
 691 (defun elpher-render-index (data &optional _mime-type-string)
 692   "Render DATA as an index.  MIME-TYPE-STRING is unused."
 693   (elpher-with-clean-buffer
 694    (if (not data)
 695        t
 696      (elpher-insert-index data)
 697      (elpher-cache-content (elpher-page-address elpher-current-page)
 698                            (buffer-string)))))
 699
 700 ;; Text rendering
 701
 702 (defconst elpher-url-regex
 703   "\\([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\-_~?/@|#]\\)?\\)?"
 704   "Regexp used to locate and buttinofy URLs in text files loaded by elpher.")
 705
 706 (defun elpher-buttonify-urls (string)
 707   "Turn substrings which look like urls in STRING into clickable buttons."
 708   (with-temp-buffer
 709     (insert string)
 710     (goto-char (point-min))
 711     (while (re-search-forward elpher-url-regex nil t)
 712       (let ((page (elpher-make-page (substring-no-properties (match-string 0))
 713                                     (elpher-address-from-url (match-string 0)))))
 714           (make-text-button (match-beginning 0)
 715                             (match-end 0)
 716                             'elpher-page  page
 717                             'action #'elpher-click-link
 718                             'follow-link t
 719                             'help-echo (elpher-page-button-help page)
 720                             'face 'button)))
 721     (buffer-string)))
 722
 723 (defconst elpher-ansi-regex "\x1b\\[[^m]*m"
 724   "Wildly incomplete regexp used to strip out some troublesome ANSI escape sequences.")
 725
 726 (defun elpher-process-text-for-display (string)
 727   "Perform any desired processing of STRING prior to display as text.
 728 Currently includes buttonifying URLs and processing ANSI escape codes."
 729   (elpher-buttonify-urls (if elpher-filter-ansi-from-text
 730                              (ansi-color-filter-apply string)
 731                            (ansi-color-apply string))))
 732
 733 (defun elpher-render-text (data &optional _mime-type-string)
 734   "Render DATA as text.  MIME-TYPE-STRING is unused."
 735   (elpher-with-clean-buffer
 736    (if (not data)
 737        t
 738      (insert (elpher-process-text-for-display (elpher-preprocess-text-response data)))
 739      (elpher-cache-content
 740       (elpher-page-address elpher-current-page)
 741       (buffer-string)))))
 742
 743 ;; Image retrieval
 744
 745 (defun elpher-render-image (data &optional _mime-type-string)
 746   "Display DATA as image.  MIME-TYPE-STRING is unused."
 747   (if (not data)
 748       nil
 749     (if (display-images-p)
 750         (progn
 751           (let ((image (create-image
 752                         data
 753                         nil t)))
 754             (elpher-with-clean-buffer
 755              (insert-image image)
 756              (elpher-restore-pos))))
 757       (elpher-render-download data))))
 758
 759 ;; Search retrieval and rendering
 760
 761 (defun elpher-get-gopher-query-page (renderer)
 762   "Getter for gopher addresses requiring input.
 763 The response is rendered using the rendering function RENDERER."
 764    (let* ((address (elpher-page-address elpher-current-page))
 765           (content (elpher-get-cached-content address))
 766           (aborted t))
 767     (if (and content (funcall renderer nil))
 768         (elpher-with-clean-buffer
 769          (insert content)
 770          (elpher-restore-pos)
 771          (message "Displaying cached search results.  Reload to perform a new search."))
 772       (unwind-protect
 773           (let* ((query-string (read-string "Query: "))
 774                  (query-selector (concat (elpher-gopher-address-selector address) "\t" query-string))
 775                  (search-address (elpher-make-gopher-address ?1
 776                                                              query-selector
 777                                                              (elpher-address-host address)
 778                                                              (elpher-address-port address)
 779                                                              (equal (elpher-address-type address) "gophers"))))
 780             (setq aborted nil)
 781
 782             (elpher-with-clean-buffer
 783              (insert "LOADING RESULTS... (use 'u' to cancel)"))
 784             (elpher-get-selector search-address renderer))
 785         (if aborted
 786             (elpher-visit-previous-page))))))
 787
 788 ;; Raw server response rendering
 789
 790 (defun elpher-render-raw (data &optional mime-type-string)
 791   "Display raw DATA in buffer.  MIME-TYPE-STRING is also displayed if provided."
 792   (if (not data)
 793       nil
 794     (elpher-with-clean-buffer
 795      (when mime-type-string
 796        (insert "MIME type specified by server: '" mime-type-string "'\n"))
 797      (insert data)
 798      (goto-char (point-min)))
 799     (message "Displaying raw server response.  Reload or redraw to return to standard view.")))
 800
 801 ;; File save "rendering"
 802
 803 (defun elpher-render-download (data &optional _mime-type-string)
 804   "Save DATA to file.  MIME-TYPE-STRING is unused."
 805   (if (not data)
 806       nil
 807     (let* ((address (elpher-page-address elpher-current-page))
 808            (selector (elpher-gopher-address-selector address)))
 809       (elpher-visit-previous-page) ; Do first in case of non-local exits.
 810       (let* ((filename-proposal (file-name-nondirectory selector))
 811              (filename (read-file-name "Download complete. Save file as: "
 812                                        nil nil nil
 813                                        (if (> (length filename-proposal) 0)
 814                                            filename-proposal
 815                                          "download.file"))))
 816         (let ((coding-system-for-write 'binary))
 817           (with-temp-file filename
 818             (insert data)))
 819         (message (format "Saved to file %s." filename))))))
 820
 821 ;; HTML rendering
 822
 823 (defun elpher-render-html (data &optional _mime-type-string)
 824   "Render DATA as HTML using shr.  MIME-TYPE-STRING is unused."
 825   (elpher-with-clean-buffer
 826    (if (not data)
 827        t
 828      (let ((dom (with-temp-buffer
 829                   (insert data)
 830                   (libxml-parse-html-region (point-min) (point-max)))))
 831        (shr-insert-document dom)))))
 832
 833 ;; Gemini page retrieval
 834
 835 (defvar elpher-gemini-redirect-chain)
 836
 837 (defun elpher-get-gemini-response (address renderer &optional force-ipv4)
 838   "Retrieve gemini ADDRESS, then render using RENDERER.
 839 If FORCE-IPV4 is non-nil, explicitly look up and use IPv4 address corresponding
 840 to ADDRESS."
 841   (unless elpher-gemini-TLS-cert-checks
 842     (setq-local network-security-level 'low))
 843   (if (not (gnutls-available-p))
 844       (error "Cannot establish gemini connection: GnuTLS not available")
 845     (unless (< (elpher-address-port address) 65536)
 846       (error "Cannot establish gemini connection: port number > 65536"))
 847     (condition-case nil
 848         (let* ((kill-buffer-query-functions nil)
 849                (port (elpher-address-port address))
 850                (host (elpher-address-host address))
 851                (response-string-parts nil)
 852                (proc (open-network-stream "elpher-process"
 853                                           nil
 854                                           (if force-ipv4 (dns-query host) host)
 855                                           (if (> port 0) port 1965)
 856                                           :type 'tls
 857                                           :nowait t))
 858                (timer (run-at-time elpher-connection-timeout nil
 859                                    (lambda ()
 860                                      (elpher-process-cleanup)
 861                                      (unless force-ipv4
 862                                         ; Try again with IPv4
 863                                        (message "Connection timed out.  Retrying with IPv4.")
 864                                        (elpher-get-gemini-response address renderer t))))))
 865           (setq elpher-network-timer timer)
 866           (set-process-coding-system proc 'binary)
 867           (set-process-filter proc
 868                               (lambda (_proc string)
 869                                 (when timer
 870                                   (cancel-timer timer)
 871                                   (setq timer nil))
 872                                 (setq response-string-parts
 873                                       (cons string response-string-parts))))
 874           (set-process-sentinel proc
 875                                 (lambda (proc event)
 876                                   (condition-case the-error
 877                                       (cond
 878                                        ((string-prefix-p "open" event)    ; request URL
 879                                         (let ((inhibit-eol-conversion t))
 880                                           (process-send-string
 881                                            proc
 882                                            (concat (elpher-address-to-url address)
 883                                                    "\r\n"))))
 884                                        ((string-prefix-p "deleted" event)) ; do nothing
 885                                        ((and (not response-string-parts)
 886                                              (not force-ipv4))
 887                                         ; Try again with IPv4
 888                                         (message "Connection failed. Retrying with IPv4.")
 889                                         (cancel-timer timer)
 890                                         (elpher-get-gemini-response address renderer t))
 891                                        (t
 892                                         (funcall #'elpher-process-gemini-response
 893                                                  (apply #'concat (reverse response-string-parts))
 894                                                  renderer)
 895                                         (elpher-restore-pos)))
 896                                     (error
 897                                            (elpher-network-error address the-error))))))
 898       (error
 899        (error "Error initiating connection to server")))))
 900
 901 (defun elpher-parse-gemini-response (response)
 902   "Parse the RESPONSE string and return a list of components.
 903 The list is of the form (code meta body).  A response of nil implies
 904 that the response was malformed."
 905   (let ((header-end-idx (string-match "\r\n" response)))
 906     (if header-end-idx
 907         (let ((header (string-trim (substring response 0 header-end-idx)))
 908               (body (substring response (+ header-end-idx 2))))
 909           (if (>= (length header) 2)
 910               (let ((code (substring header 0 2))
 911                     (meta (string-trim (substring header 2))))
 912                 (list code meta body))
 913             (error "Malformed response: No response status found in header %s" header)))
 914       (error "Malformed response: No CRLF-delimited header found"))))
 915
 916 (defun elpher-process-gemini-response (response-string renderer)
 917   "Process the gemini response RESPONSE-STRING and pass the result to RENDERER."
 918   (let ((response-components (elpher-parse-gemini-response response-string)))
 919     (let ((response-code (elt response-components 0))
 920           (response-meta (elt response-components 1))
 921           (response-body (elt response-components 2)))
 922       (pcase (elt response-code 0)
 923         (?1 ; Input required
 924          (elpher-with-clean-buffer
 925           (insert "Gemini server is requesting input."))
 926          (let* ((query-string (read-string (concat response-meta ": ")))
 927                 (url (elpher-address-to-url (elpher-page-address elpher-current-page)))
 928                 (query-address (elpher-address-from-url (concat url "?" query-string))))
 929            (elpher-get-gemini-response query-address renderer)))
 930         (?2 ; Normal response
 931          (funcall renderer response-body response-meta))
 932         (?3 ; Redirect
 933          (message "Following redirect to %s" response-meta)
 934          (if (>= (length elpher-gemini-redirect-chain) 5)
 935              (error "More than 5 consecutive redirects followed"))
 936          (let ((redirect-address (elpher-address-from-gemini-url response-meta)))
 937            (if (member redirect-address elpher-gemini-redirect-chain)
 938                (error "Redirect loop detected"))
 939            (if (not (string= (elpher-address-protocol redirect-address)
 940                              "gemini"))
 941                (error "Server tried to automatically redirect to non-gemini URL: %s"
 942                       response-meta))
 943            (add-to-list 'elpher-gemini-redirect-chain redirect-address)
 944            (elpher-get-gemini-response redirect-address renderer)))
 945         (?4 ; Temporary failure
 946          (error "Gemini server reports TEMPORARY FAILURE for this request: %s %s"
 947                 response-code response-meta))
 948         (?5 ; Permanent failure
 949          (error "Gemini server reports PERMANENT FAILURE for this request: %s %s"
 950                 response-code response-meta))
 951         (?6 ; Client certificate required
 952          (error "Gemini server requires client certificate (unsupported at this time)"))
 953         (_other
 954          (error "Gemini server response unknown: %s %s"
 955                 response-code response-meta))))))
 956
 957 (defun elpher-get-gemini-page (renderer)
 958   "Getter which retrieves and renders a Gemini page and renders it using RENDERER."
 959   (let* ((address (elpher-page-address elpher-current-page))
 960          (content (elpher-get-cached-content address)))
 961     (condition-case the-error
 962         (if (and content (funcall renderer nil))
 963             (elpher-with-clean-buffer
 964               (insert content)
 965               (elpher-restore-pos))
 966           (elpher-with-clean-buffer
 967            (insert "LOADING GEMINI... (use 'u' to cancel)"))
 968           (setq elpher-gemini-redirect-chain nil)
 969           (elpher-get-gemini-response address renderer))
 970       (error
 971        (elpher-network-error address the-error)))))
 972
 973
 974 (defun elpher-render-gemini (body &optional mime-type-string)
 975   "Render gemini response BODY with rendering MIME-TYPE-STRING."
 976   (if (not body)
 977       t
 978     (let* ((mime-type-string* (if (or (not mime-type-string)
 979                                       (string-empty-p mime-type-string))
 980                                   "text/gemini; charset=utf-8"
 981                                 mime-type-string))
 982            (mime-type-split (split-string mime-type-string* ";" t))
 983            (mime-type (string-trim (car mime-type-split)))
 984            (parameters (mapcar (lambda (s)
 985                                  (let ((key-val (split-string s "=")))
 986                                    (list (downcase (string-trim (car key-val)))
 987                                          (downcase (string-trim (cadr key-val))))))
 988                                (cdr mime-type-split))))
 989       (when (string-prefix-p "text/" mime-type)
 990         (setq body (decode-coding-string
 991                     body
 992                     (if (assoc "charset" parameters)
 993                         (intern (cadr (assoc "charset" parameters)))
 994                       'utf-8)))
 995         (setq body (replace-regexp-in-string "\r" "" body)))
 996       (pcase mime-type
 997         ((or "text/gemini" "")
 998          (elpher-render-gemini-map body parameters))
 999         ("text/html"
1000          (elpher-render-html body))
1001         ((pred (string-prefix-p "text/"))
1002          (elpher-render-gemini-plain-text body parameters))
1003         ((pred (string-prefix-p "image/"))
1004          (elpher-render-image body))
1005         (_other
1006          (error "Unsupported MIME type %S" mime-type))))))
1007
1008 (defun elpher-gemini-get-link-url (line)
1009   "Extract the url portion of LINE, a gemini map file link line."
1010   (string-trim (elt (split-string (substring line 2)) 0)))
1011
1012 (defun elpher-gemini-get-link-display-string (line)
1013   "Extract the display string portion of LINE, a gemini map file link line."
1014   (let* ((rest (string-trim (elt (split-string line "=>") 1)))
1015          (idx (string-match "[ \t]" rest)))
1016     (if idx
1017         (string-trim (substring rest (+ idx 1)))
1018       "")))
1019
1020 (defun elpher-collapse-dot-sequences (filename)
1021   "Collapse dot sequences in FILENAME.
1022 For instance, the filename /a/b/../c/./d will reduce to /a/c/d"
1023   (let* ((path (split-string filename "/"))
1024          (path-reversed-normalized
1025           (seq-reduce (lambda (a b)
1026                         (cond ((and a (equal b "..") (cdr a)))
1027                               ((and (not a) (equal b "..")) a) ;leading .. are dropped
1028                               ((equal b ".") a)
1029                               (t (cons b a))))
1030                       path nil)))
1031     (string-join (reverse path-reversed-normalized) "/")))
1032
1033 (defun elpher-address-from-gemini-url (url)
1034   "Extract address from URL with defaults as per gemini map files."
1035   (let ((address (url-generic-parse-url url)))
1036     (unless (and (url-type address) (not (url-fullness address))) ;avoid mangling mailto: urls
1037       (setf (url-fullness address) t)
1038       (if (url-host address) ;if there is an explicit host, filenames are absolute
1039           (if (string-empty-p (url-filename address))
1040               (setf (url-filename address) "/")) ;ensure empty filename is marked as absolute
1041         (setf (url-host address) (url-host (elpher-page-address elpher-current-page)))
1042         (unless (string-prefix-p "/" (url-filename address)) ;deal with relative links
1043           (setf (url-filename address)
1044                 (concat (file-name-directory
1045                          (url-filename (elpher-page-address elpher-current-page)))
1046                         (url-filename address)))))
1047       (unless (url-type address)
1048         (setf (url-type address) "gemini"))
1049       (if (equal (url-type address) "gemini")
1050           (setf (url-filename address)
1051                 (elpher-collapse-dot-sequences (url-filename address)))))
1052     address))
1053
1054 (defun elpher-gemini-insert-link (link-line)
1055   "Insert link described by LINK-LINE into a text/gemini document."
1056   (let* ((url (elpher-gemini-get-link-url link-line))
1057          (display-string (let ((s (elpher-gemini-get-link-display-string link-line)))
1058                            (if (string-empty-p s) url s)))
1059          (address (elpher-address-from-gemini-url url))
1060          (type (if address (elpher-address-type address) nil))
1061          (type-map-entry (cdr (assoc type elpher-type-map))))
1062     (insert "→ ")
1063     (if type-map-entry
1064         (let* ((face (elt type-map-entry 3))
1065                (filtered-display-string (ansi-color-filter-apply display-string))
1066                (page (elpher-make-page filtered-display-string address)))
1067           (insert-text-button filtered-display-string
1068                               'face face
1069                               'elpher-page page
1070                               'action #'elpher-click-link
1071                               'follow-link t
1072                               'help-echo (elpher-page-button-help page)))
1073       (insert (propertize display-string 'face 'elpher-unknown)))
1074     (insert "\n")))
1075
1076 (defun elpher-gemini-insert-header (header-line)
1077   "Insert header described by HEADER-LINE into a text/gemini document.
1078 The gemini map file line describing the header is given
1079 by HEADER-LINE."
1080   (when (string-match "^\\(#+\\)[ \t]*" header-line)
1081     (let ((level (length (match-string 1 header-line)))
1082           (header (substring header-line (match-end 0))))
1083       (unless (display-graphic-p)
1084         (insert (make-string level ?#) " "))
1085       (insert (propertize header 'face
1086                           (pcase level
1087                             (1 'elpher-gemini-heading1)
1088                             (2 'elpher-gemini-heading2)
1089                             (3 'elpher-gemini-heading3)
1090                             (_ 'default)))
1091               "\n"))))
1092
1093 (defun elpher-render-gemini-map (data _parameters)
1094   "Render DATA as a gemini map file, PARAMETERS is currently unused."
1095   (elpher-with-clean-buffer
1096    (let ((preformatted nil))
1097      (auto-fill-mode 1)
1098      (setq-local fill-column (min (window-width) elpher-gemini-max-fill-width))
1099      (dolist (line (split-string data "\n"))
1100        (cond
1101         ((string-prefix-p "```" line) (setq preformatted (not preformatted)))
1102         (preformatted (insert (elpher-process-text-for-display line) "\n"))
1103         ((string-prefix-p "=>" line) (elpher-gemini-insert-link line))
1104         ((string-prefix-p "#" line) (elpher-gemini-insert-header line))
1105         (t (insert (elpher-process-text-for-display line)) (newline)))))
1106    (elpher-cache-content
1107     (elpher-page-address elpher-current-page)
1108     (buffer-string))))
1109
1110 (defun elpher-render-gemini-plain-text (data _parameters)
1111   "Render DATA as plain text file.  PARAMETERS is currently unused."
1112   (elpher-with-clean-buffer
1113    (insert (elpher-process-text-for-display data))
1114    (elpher-cache-content
1115     (elpher-page-address elpher-current-page)
1116     (buffer-string))))
1117
1118 ;; Finger page connection
1119
1120 (defun elpher-get-finger-page (renderer &optional force-ipv4)
1121   "Opens a finger connection to the current page address and renders it using RENDERER."
1122   (let* ((address (elpher-page-address elpher-current-page))
1123          (content (elpher-get-cached-content address)))
1124     (if (and content (funcall renderer nil))
1125         (elpher-with-clean-buffer
1126          (insert content)
1127          (elpher-restore-pos))
1128       (elpher-with-clean-buffer
1129        (insert "LOADING... (use 'u' to cancel)"))
1130       (condition-case the-error
1131           (let* ((kill-buffer-query-functions nil)
1132                  (user (let ((filename (elpher-address-filename address)))
1133                          (if (> (length filename) 1)
1134                              (substring filename 1)
1135                            (elpher-address-user address))))
1136                  (port (let ((given-port (elpher-address-port address)))
1137                          (if (> given-port 0) given-port 79)))
1138                  (host (elpher-address-host address))
1139                  (selector-string-parts nil)
1140                  (proc (open-network-stream "elpher-process"
1141                                             nil
1142                                             (if force-ipv4 (dns-query host) host)
1143                                             port
1144                                             :type 'plain
1145                                             :nowait t))
1146                  (timer (run-at-time elpher-connection-timeout
1147                                      nil
1148                                      (lambda ()
1149                                        (pcase (process-status proc)
1150                                          ('connect
1151                                           (elpher-process-cleanup)
1152                                           (unless force-ipv4
1153                                             (message "Connection timed out. Retrying with IPv4 address.")
1154                                             (elpher-get-finger-page renderer t))))))))
1155             (setq elpher-network-timer timer)
1156             (set-process-coding-system proc 'binary)
1157             (set-process-filter proc
1158                                 (lambda (_proc string)
1159                                   (cancel-timer timer)
1160                                   (setq selector-string-parts
1161                                         (cons string selector-string-parts))))
1162             (set-process-sentinel proc
1163                                   (lambda (_proc event)
1164                                     (condition-case the-error
1165                                         (cond
1166                                          ((string-prefix-p "deleted" event))
1167                                          ((string-prefix-p "open" event)
1168                                           (let ((inhibit-eol-conversion t))
1169                                             (process-send-string
1170                                              proc
1171                                              (concat user "\r\n"))))
1172                                          (t
1173                                           (cancel-timer timer)
1174                                           (funcall renderer (apply #'concat
1175                                                                    (reverse selector-string-parts)))
1176                                           (elpher-restore-pos)))))))
1177         (error
1178          (elpher-network-error address the-error))))))
1179
1180
1181 ;; Other URL page opening
1182
1183 (defun elpher-get-other-url-page (renderer)
1184   "Getter which attempts to open the URL specified by the current page (RENDERER must be nil)."
1185   (when renderer
1186     (elpher-visit-previous-page)
1187     (error "Command not supported for general URLs"))
1188   (let* ((address (elpher-page-address elpher-current-page))
1189          (url (elpher-address-to-url address)))
1190     (progn
1191       (elpher-visit-previous-page) ; Do first in case of non-local exits.
1192       (message "Opening URL...")
1193       (if elpher-open-urls-with-eww
1194           (browse-web url)
1195         (browse-url url)))))
1196
1197 ;; Telnet page connection
1198
1199 (defun elpher-get-telnet-page (renderer)
1200   "Opens a telnet connection to the current page address (RENDERER must be nil)."
1201   (when renderer
1202     (elpher-visit-previous-page)
1203     (error "Command not supported for telnet URLs"))
1204   (let* ((address (elpher-page-address elpher-current-page))
1205          (host (elpher-address-host address))
1206          (port (elpher-address-port address)))
1207     (elpher-visit-previous-page)
1208     (if (> port 0)
1209         (telnet host port)
1210       (telnet host))))
1211
1212 ;; Start page page retrieval
1213
1214 (defun elpher-get-start-page (renderer)
1215   "Getter which displays the start page (RENDERER must be nil)."
1216   (when renderer
1217     (elpher-visit-previous-page)
1218     (error "Command not supported for start page"))
1219   (elpher-with-clean-buffer
1220    (insert "     --------------------------------------------\n"
1221            "                Elpher Gopher Client             \n"
1222            "                   version " elpher-version "\n"
1223            "     --------------------------------------------\n"
1224            "\n"
1225            "Default bindings:\n"
1226            "\n"
1227            " - TAB/Shift-TAB: next/prev item on current page\n"
1228            " - RET/mouse-1: open item under cursor\n"
1229            " - m: select an item on current page by name (autocompletes)\n"
1230            " - u/mouse-3: return to previous page\n"
1231            " - o/O: visit different selector or the root menu of the current server\n"
1232            " - g: go to a particular gopher address\n"
1233            " - d/D: download item under cursor or current page\n"
1234            " - i/I: info on item under cursor or current page\n"
1235            " - c/C: copy URL representation of item under cursor or current page\n"
1236            " - a/A: bookmark the item under cursor or current page\n"
1237            " - x/X: remove bookmark for item under cursor or current page\n"
1238            " - B: visit the bookmarks page\n"
1239            " - r: redraw current page (using cached contents if available)\n"
1240            " - R: reload current page (regenerates cache)\n"
1241            " - S: set character coding system for gopher (default is to autodetect)\n"
1242            " - T: toggle TLS gopher mode\n"
1243            " - .: display the raw server response for the current page\n"
1244            "\n"
1245            "Start your exploration of gopher space:\n")
1246    (elpher-insert-index-record "Floodgap Systems Gopher Server"
1247                                (elpher-make-gopher-address ?1 "" "gopher.floodgap.com" 70))
1248    (insert "\n"
1249            "Alternatively, select the following item and enter some search terms:\n")
1250    (elpher-insert-index-record "Veronica-2 Gopher Search Engine"
1251                                (elpher-make-gopher-address ?7 "/v2/vs" "gopher.floodgap.com" 70))
1252    (insert "\n"
1253            "This page contains your bookmarked sites (also visit with B):\n")
1254    (elpher-insert-index-record "Your Bookmarks" 'bookmarks)
1255    (insert "\n"
1256            "For Elpher release news or to leave feedback, visit:\n")
1257    (elpher-insert-index-record "The Elpher Project Page"
1258                                (elpher-make-gopher-address ?1
1259                                                            "/projects/elpher/"
1260                                                            "thelambdalab.xyz"
1261                                                            70))
1262    (insert "\n"
1263            "** Refer to the ")
1264    (let ((help-string "RET,mouse-1: Open Elpher info manual (if available)"))
1265      (insert-text-button "Elpher info manual"
1266                          'face 'link
1267                          'action (lambda (_)
1268                                    (interactive)
1269                                    (info "(elpher)"))
1270                          'follow-link t
1271                          'help-echo help-string))
1272    (insert " for the full documentation. **\n")
1273    (insert (propertize
1274             (concat "  (This should be available if you have installed Elpher using\n"
1275                     "   MELPA. Otherwise you will have to install the manual yourself.)\n")
1276             'face 'shadow))
1277    (elpher-restore-pos)))
1278
1279 ;; Bookmarks page page retrieval
1280
1281 (defun elpher-get-bookmarks-page (renderer)
1282   "Getter to load and display the current bookmark list (RENDERER must be nil)."
1283   (when renderer
1284     (elpher-visit-previous-page)
1285     (error "Command not supported for bookmarks page"))
1286   (elpher-with-clean-buffer
1287    (insert "---- Bookmark list ----\n\n")
1288    (let ((bookmarks (elpher-load-bookmarks)))
1289      (if bookmarks
1290          (dolist (bookmark bookmarks)
1291            (let ((display-string (elpher-bookmark-display-string bookmark))
1292                  (address (elpher-address-from-url (elpher-bookmark-url bookmark))))
1293              (elpher-insert-index-record display-string address)))
1294        (insert "No bookmarks found.\n")))
1295    (insert "\n-----------------------\n"
1296            "\n"
1297            "- u: return to previous page\n"
1298            "- x: delete selected bookmark\n"
1299            "- a: rename selected bookmark\n"
1300            "\n"
1301            "Bookmarks are stored in the file ")
1302    (let ((filename (locate-user-emacs-file "elpher-bookmarks"))
1303          (help-string "RET,mouse-1: Open bookmarks file in new buffer for editing."))
1304      (insert-text-button filename
1305                          'face 'link
1306                          'action (lambda (_)
1307                                    (interactive)
1308                                    (find-file filename))
1309                          'follow-link t
1310                          'help-echo help-string))
1311    (insert "\n")
1312    (elpher-restore-pos)))
1313
1314
1315 ;;; Bookmarks
1316 ;;
1317
1318 (defun elpher-make-bookmark (display-string url)
1319   "Make an elpher bookmark.
1320 DISPLAY-STRING determines how the bookmark will appear in the
1321 bookmark list, while URL is the url of the entry."
1322   (list display-string url))
1323
1324 (defun elpher-bookmark-display-string (bookmark)
1325   "Get the display string of BOOKMARK."
1326   (elt bookmark 0))
1327
1328 (defun elpher-set-bookmark-display-string (bookmark display-string)
1329   "Set the display string of BOOKMARK to DISPLAY-STRING."
1330   (setcar bookmark display-string))
1331
1332 (defun elpher-bookmark-url (bookmark)
1333   "Get the address for BOOKMARK."
1334   (elt bookmark 1))
1335
1336 (defun elpher-save-bookmarks (bookmarks)
1337   "Record the bookmark list BOOKMARKS to the user's bookmark file.
1338 Beware that this completely replaces the existing contents of the file."
1339   (with-temp-file (locate-user-emacs-file "elpher-bookmarks")
1340     (erase-buffer)
1341     (insert "; Elpher bookmarks file\n\n"
1342             "; Bookmarks are stored as a list of (label URL) items.\n"
1343             "; Feel free to edit by hand, but take care to ensure\n"
1344             "; the list structure remains intact.\n\n")
1345     (pp bookmarks (current-buffer))))
1346
1347 (defun elpher-load-bookmarks ()
1348   "Get the list of bookmarks from the users's bookmark file."
1349   (let ((bookmarks
1350          (with-temp-buffer
1351            (ignore-errors
1352              (insert-file-contents (locate-user-emacs-file "elpher-bookmarks"))
1353              (goto-char (point-min))
1354              (read (current-buffer))))))
1355     (if (and bookmarks (listp (cadar bookmarks)))
1356         (progn
1357           (message "Reading old bookmark file. (Will be updated on write.)")
1358           (mapcar (lambda (old-bm)
1359                     (list (car old-bm)
1360                           (elpher-address-to-url (apply #'elpher-make-gopher-address
1361                                                         (cadr old-bm)))))
1362                   bookmarks))
1363       bookmarks)))
1364
1365 (defun elpher-add-address-bookmark (address display-string)
1366   "Save a bookmark for ADDRESS with label DISPLAY-STRING.)))
1367 If ADDRESS is already bookmarked, update the label only."
1368   (let ((bookmarks (elpher-load-bookmarks))
1369         (url (elpher-address-to-url address)))
1370     (let ((existing-bookmark (rassoc (list url) bookmarks)))
1371       (if existing-bookmark
1372           (elpher-set-bookmark-display-string existing-bookmark display-string)
1373         (push (elpher-make-bookmark display-string url) bookmarks)))
1374     (elpher-save-bookmarks bookmarks)))
1375
1376 (defun elpher-remove-address-bookmark (address)
1377   "Remove any bookmark to ADDRESS."
1378   (let ((url (elpher-address-to-url address)))
1379     (elpher-save-bookmarks
1380      (seq-filter (lambda (bookmark)
1381                    (not (equal (elpher-bookmark-url bookmark) url)))
1382                  (elpher-load-bookmarks)))))
1383
1384 ;;; Interactive procedures
1385 ;;
1386
1387 (defun elpher-next-link ()
1388   "Move point to the next link on the current page."
1389   (interactive)
1390   (forward-button 1))
1391
1392 (defun elpher-prev-link ()
1393   "Move point to the previous link on the current page."
1394   (interactive)
1395   (backward-button 1))
1396
1397 (defun elpher-follow-current-link ()
1398   "Open the link or url at point."
1399   (interactive)
1400   (push-button))
1401
1402 (defun elpher-go (host-or-url)
1403   "Go to a particular gopher site HOST-OR-URL.
1404 When run interactively HOST-OR-URL is read from the minibuffer."
1405   (interactive "sGopher or Gemini URL: ")
1406   (let ((page (elpher-make-page host-or-url
1407                                 (elpher-address-from-url host-or-url))))
1408     (switch-to-buffer "*elpher*")
1409     (elpher-visit-page page)
1410     '()))
1411
1412 (defun elpher-go-current ()
1413   "Go to a particular site read from the minibuffer, initialized with the current URL."
1414   (interactive)
1415   (let ((address (elpher-page-address elpher-current-page)))
1416     (if (elpher-address-special-p address)
1417         (error "Command invalid for this page")
1418       (let ((url (read-string "Gopher or Gemini URL: " (elpher-address-to-url address))))
1419         (elpher-visit-page (elpher-make-page url (elpher-address-from-url url)))))))
1420
1421 (defun elpher-redraw ()
1422   "Redraw current page."
1423   (interactive)
1424   (elpher-visit-page elpher-current-page))
1425
1426 (defun elpher-reload ()
1427   "Reload current page."
1428   (interactive)
1429   (elpher-reload-current-page))
1430
1431 (defun elpher-toggle-tls ()
1432   "Toggle TLS encryption mode for gopher."
1433   (interactive)
1434   (setq elpher-use-tls (not elpher-use-tls))
1435   (if elpher-use-tls
1436       (if (gnutls-available-p)
1437           (message "TLS gopher mode enabled.  (Will not affect current page until reload.)")
1438         (setq elpher-use-tls nil)
1439         (error "Cannot enable TLS gopher mode: GnuTLS not available"))
1440     (message "TLS gopher mode disabled.  (Will not affect current page until reload.)")))
1441
1442 (defun elpher-view-raw ()
1443   "View raw server response for current page."
1444   (interactive)
1445   (if (elpher-address-special-p (elpher-page-address elpher-current-page))
1446       (error "This page was not generated by a server")
1447     (elpher-visit-page elpher-current-page
1448                        #'elpher-render-raw)))
1449
1450 (defun elpher-back ()
1451   "Go to previous site."
1452   (interactive)
1453   (elpher-visit-previous-page))
1454
1455 (defun elpher-download ()
1456   "Download the link at point."
1457   (interactive)
1458   (let ((button (button-at (point))))
1459     (if button
1460         (let ((page (button-get button 'elpher-page)))
1461           (if (elpher-address-special-p (elpher-page-address page))
1462               (error "Cannot download %s"
1463                      (elpher-page-display-string page))
1464             (elpher-visit-page (button-get button 'elpher-page)
1465                                #'elpher-render-download)))
1466       (error "No link selected"))))
1467
1468 (defun elpher-download-current ()
1469   "Download the current page."
1470   (interactive)
1471   (if (elpher-address-special-p (elpher-page-address elpher-current-page))
1472       (error "Cannot download %s"
1473              (elpher-page-display-string elpher-current-page))
1474     (elpher-visit-page (elpher-make-page
1475                         (elpher-page-display-string elpher-current-page)
1476                         (elpher-page-address elpher-current-page))
1477                        #'elpher-render-download
1478                        t)))
1479
1480 (defun elpher-build-link-map ()
1481   "Build alist mapping link names to destination pages in current buffer."
1482   (let ((link-map nil)
1483         (b (next-button (point-min) t)))
1484     (while b
1485       (push (cons (button-label b) b) link-map)
1486       (setq b (next-button (button-start b))))
1487     link-map))
1488
1489 (defun elpher-jump ()
1490   "Select a directory entry by name.  Similar to the info browser (m)enu command."
1491   (interactive)
1492   (let* ((link-map (elpher-build-link-map)))
1493     (if link-map
1494         (let ((key (let ((completion-ignore-case t))
1495                      (completing-read "Directory item/link: "
1496                                       link-map nil t))))
1497           (if (and key (> (length key) 0))
1498               (let ((b (cdr (assoc key link-map))))
1499                 (goto-char (button-start b))
1500                 (button-activate b)))))))
1501
1502 (defun elpher-root-dir ()
1503   "Visit root of current server."
1504   (interactive)
1505   (let ((address (elpher-page-address elpher-current-page)))
1506     (if (not (elpher-address-special-p address))
1507         (if (or (member (url-filename address) '("/" ""))
1508                 (and (elpher-address-gopher-p address)
1509                      (= (length (elpher-gopher-address-selector address)) 0)))
1510             (error "Already at root directory of current server")
1511           (let ((address-copy (elpher-address-from-url
1512                                (elpher-address-to-url address))))
1513             (setf (url-filename address-copy) "")
1514             (elpher-go (elpher-address-to-url address-copy))))
1515       (error "Command invalid for %s" (elpher-page-display-string elpher-current-page)))))
1516
1517 (defun elpher-bookmarks-current-p ()
1518   "Return non-nil if current page is a bookmarks page."
1519   (equal (elpher-address-type (elpher-page-address elpher-current-page))
1520          '(special bookmarks)))
1521
1522 (defun elpher-reload-bookmarks ()
1523   "Reload bookmarks if current page is a bookmarks page."
1524   (if (elpher-bookmarks-current-p)
1525       (elpher-reload-current-page)))
1526
1527 (defun elpher-bookmark-current ()
1528   "Bookmark the current page."
1529   (interactive)
1530   (let ((address (elpher-page-address elpher-current-page))
1531         (display-string (elpher-page-display-string elpher-current-page)))
1532     (if (not (elpher-address-special-p address))
1533         (let ((bookmark-display-string (read-string "Bookmark display string: "
1534                                                     display-string)))
1535           (elpher-add-address-bookmark address bookmark-display-string)
1536           (message "Bookmark added."))
1537       (error "Cannot bookmark %s" display-string))))
1538
1539 (defun elpher-bookmark-link ()
1540   "Bookmark the link at point."
1541   (interactive)
1542   (let ((button (button-at (point))))
1543     (if button
1544         (let* ((page (button-get button 'elpher-page))
1545                (address (elpher-page-address page))
1546                (display-string (elpher-page-display-string page)))
1547           (if (not (elpher-address-special-p address))
1548               (let ((bookmark-display-string (read-string "Bookmark display string: "
1549                                                           display-string)))
1550                 (elpher-add-address-bookmark address bookmark-display-string)
1551                 (elpher-reload-bookmarks)
1552                 (message "Bookmark added."))
1553             (error "Cannot bookmark %s" display-string)))
1554       (error "No link selected"))))
1555
1556 (defun elpher-unbookmark-current ()
1557   "Remove bookmark for the current page."
1558   (interactive)
1559   (let ((address (elpher-page-address elpher-current-page)))
1560     (unless (elpher-address-special-p address)
1561       (elpher-remove-address-bookmark address)
1562       (message "Bookmark removed."))))
1563
1564 (defun elpher-unbookmark-link ()
1565   "Remove bookmark for the link at point."
1566   (interactive)
1567   (let ((button (button-at (point))))
1568     (if button
1569         (let ((page (button-get button 'elpher-page)))
1570           (elpher-remove-address-bookmark (elpher-page-address page))
1571           (elpher-reload-bookmarks)
1572           (message "Bookmark removed."))
1573       (error "No link selected"))))
1574
1575 (defun elpher-bookmarks ()
1576   "Visit bookmarks page."
1577   (interactive)
1578   (switch-to-buffer "*elpher*")
1579   (elpher-visit-page
1580    (elpher-make-page "Bookmarks Page" (elpher-make-special-address 'bookmarks))))
1581
1582 (defun elpher-info-page (page)
1583   "Display information on PAGE."
1584   (let ((display-string (elpher-page-display-string page))
1585         (address (elpher-page-address page)))
1586     (if (elpher-address-special-p address)
1587         (message "Special page: %s" display-string)
1588       (message "%s" (elpher-address-to-url address)))))
1589
1590 (defun elpher-info-link ()
1591   "Display information on page corresponding to link at point."
1592   (interactive)
1593   (let ((button (button-at (point))))
1594     (if button
1595         (elpher-info-page (button-get button 'elpher-page))
1596       (error "No item selected"))))
1597
1598 (defun elpher-info-current ()
1599   "Display information on current page."
1600   (interactive)
1601   (elpher-info-page elpher-current-page))
1602
1603 (defun elpher-copy-page-url (page)
1604   "Copy URL representation of address of PAGE to `kill-ring'."
1605   (let ((address (elpher-page-address page)))
1606     (if (elpher-address-special-p address)
1607         (error (format "Cannot represent %s as URL" (elpher-page-display-string page)))
1608       (let ((url (elpher-address-to-url address)))
1609         (message "Copied \"%s\" to kill-ring/clipboard." url)
1610         (kill-new url)))))
1611
1612 (defun elpher-copy-link-url ()
1613   "Copy URL of item at point to `kill-ring'."
1614   (interactive)
1615   (let ((button (button-at (point))))
1616     (if button
1617         (elpher-copy-page-url (button-get button 'elpher-page))
1618       (error "No item selected"))))
1619
1620 (defun elpher-copy-current-url ()
1621   "Copy URL of current page to `kill-ring'."
1622   (interactive)
1623   (elpher-copy-page-url elpher-current-page))
1624
1625 (defun elpher-set-gopher-coding-system ()
1626   "Specify an explicit character coding system for gopher selectors."
1627   (interactive)
1628   (let ((system (read-coding-system "Set coding system to use for gopher (default is to autodetect): " nil)))
1629     (setq elpher-user-coding-system system)
1630     (if system
1631         (message "Gopher coding system fixed to %s. (Reload to see effect)." system)
1632       (message "Gopher coding system set to autodetect. (Reload to see effect)."))))
1633
1634
1635 ;;; Mode and keymap
1636 ;;
1637
1638 (defvar elpher-mode-map
1639   (let ((map (make-sparse-keymap)))
1640     (define-key map (kbd "TAB") 'elpher-next-link)
1641     (define-key map (kbd "<backtab>") 'elpher-prev-link)
1642     (define-key map (kbd "u") 'elpher-back)
1643     (define-key map [mouse-3] 'elpher-back)
1644     (define-key map (kbd "O") 'elpher-root-dir)
1645     (define-key map (kbd "g") 'elpher-go)
1646     (define-key map (kbd "o") 'elpher-go-current)
1647     (define-key map (kbd "r") 'elpher-redraw)
1648     (define-key map (kbd "R") 'elpher-reload)
1649     (define-key map (kbd "T") 'elpher-toggle-tls)
1650     (define-key map (kbd ".") 'elpher-view-raw)
1651     (define-key map (kbd "d") 'elpher-download)
1652     (define-key map (kbd "D") 'elpher-download-current)
1653     (define-key map (kbd "m") 'elpher-jump)
1654     (define-key map (kbd "i") 'elpher-info-link)
1655     (define-key map (kbd "I") 'elpher-info-current)
1656     (define-key map (kbd "c") 'elpher-copy-link-url)
1657     (define-key map (kbd "C") 'elpher-copy-current-url)
1658     (define-key map (kbd "a") 'elpher-bookmark-link)
1659     (define-key map (kbd "A") 'elpher-bookmark-current)
1660     (define-key map (kbd "x") 'elpher-unbookmark-link)
1661     (define-key map (kbd "X") 'elpher-unbookmark-current)
1662     (define-key map (kbd "B") 'elpher-bookmarks)
1663     (define-key map (kbd "S") 'elpher-set-gopher-coding-system)
1664     (when (fboundp 'evil-define-key*)
1665       (evil-define-key* 'motion map
1666         (kbd "TAB") 'elpher-next-link
1667         (kbd "C-") 'elpher-follow-current-link
1668         (kbd "C-t") 'elpher-back
1669         (kbd "u") 'elpher-back
1670         [mouse-3] 'elpher-back
1671         (kbd "g") 'elpher-go
1672         (kbd "o") 'elpher-go-current
1673         (kbd "r") 'elpher-redraw
1674         (kbd "R") 'elpher-reload
1675         (kbd "T") 'elpher-toggle-tls
1676         (kbd ".") 'elpher-view-raw
1677         (kbd "d") 'elpher-download
1678         (kbd "D") 'elpher-download-current
1679         (kbd "m") 'elpher-jump
1680         (kbd "i") 'elpher-info-link
1681         (kbd "I") 'elpher-info-current
1682         (kbd "c") 'elpher-copy-link-url
1683         (kbd "C") 'elpher-copy-current-url
1684         (kbd "a") 'elpher-bookmark-link
1685         (kbd "A") 'elpher-bookmark-current
1686         (kbd "x") 'elpher-unbookmark-link
1687         (kbd "X") 'elpher-unbookmark-current
1688         (kbd "B") 'elpher-bookmarks
1689         (kbd "S") 'elpher-set-gopher-coding-system))
1690     map)
1691   "Keymap for gopher client.")
1692
1693 (define-derived-mode elpher-mode special-mode "elpher"
1694   "Major mode for elpher, an elisp gopher client.
1695
1696 This mode is automatically enabled by the interactive
1697 functions which initialize the gopher client, namely
1698 `elpher', `elpher-go' and `elpher-bookmarks'.")
1699
1700 (when (fboundp 'evil-set-initial-state)
1701   (evil-set-initial-state 'elpher-mode 'motion))
1702
1703
1704 ;;; Main start procedure
1705 ;;
1706
1707 ;;;###autoload
1708 (defun elpher ()
1709   "Start elpher with default landing page."
1710   (interactive)
1711   (if (get-buffer "*elpher*")
1712       (switch-to-buffer "*elpher*")
1713     (switch-to-buffer "*elpher*")
1714     (setq elpher-current-page nil)
1715     (let ((start-page (elpher-make-page "Elpher Start Page"
1716                                         (elpher-make-special-address 'start))))
1717       (elpher-visit-page start-page)))
1718   "Started Elpher.") ; Otherwise (elpher) evaluates to start page string.
1719
1720 ;;; elpher.el ends here