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