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