elpher.el

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