1 ;;; elpher.el --- A friendly gopher and gemini client -*- lexical-binding: t -*-
3 ;; Copyright (C) 2019-2024 Tim Vaughan <plugd@thelambdalab.xyz>
4 ;; Copyright (C) 2020-2022 Elpher contributors (See info manual for full list)
6 ;; Author: Tim Vaughan <plugd@thelambdalab.xyz>
7 ;; Created: 11 April 2019
9 ;; Keywords: comm gopher gemini
10 ;; Homepage: https://thelambdalab.xyz/elpher
11 ;; Package-Requires: ((emacs "27.1"))
13 ;; This file is not part of GNU Emacs.
15 ;; This program is free software: you can redistribute it and/or modify
16 ;; it under the terms of the GNU General Public License as published by
17 ;; the Free Software Foundation, either version 3 of the License, or
18 ;; (at your option) any later version.
20 ;; This program is distributed in the hope that it will be useful,
21 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
22 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 ;; GNU General Public License for more details.
25 ;; You should have received a copy of the GNU General Public License
26 ;; along with this file. If not, see <http://www.gnu.org/licenses/>.
30 ;; Elpher aims to provide a practical and friendly gopher and gemini
31 ;; client for GNU Emacs. It supports:
33 ;; - intuitive keyboard and mouse-driven browsing,
34 ;; - out-of-the-box compatibility with evil-mode,
35 ;; - clickable web and gopher links *in plain text*,
36 ;; - caching of visited sites,
37 ;; - pleasant and configurable colouring of Gopher directories,
38 ;; - direct visualisation of image files,
39 ;; - gopher connections using TLS encryption,
40 ;; - the fledgling Gemini protocol,
41 ;; - the greybeard Finger protocol.
43 ;; To launch Elpher, simply use 'M-x elpher'. This will open a start
44 ;; page containing information on key bindings and suggested starting
45 ;; points for your gopher exploration.
47 ;; Full instructions can be found in the Elpher info manual.
49 ;; Elpher is under active development. Any suggestions for
50 ;; improvements are welcome, and can be made on the official project
51 ;; page, gopher://thelambdalab.xyz/1/projects/elpher, or via the
52 ;; project mailing list at https://lists.sr.ht/~michel-slm/elpher.
74 (defconst elpher-version "3.6.0"
75 "Current version of elpher.")
77 (defconst elpher-margin-width 6
78 "Width of left-hand margin used when rendering indicies.")
80 (defconst elpher-type-map
81 '(((gopher ?0) elpher-get-gopher-page elpher-render-text "txt" elpher-text)
82 ((gopher ?1) elpher-get-gopher-page elpher-render-index "/" elpher-index)
83 ((gopher ?4) elpher-get-gopher-page elpher-render-download "bin" elpher-binary)
84 ((gopher ?5) elpher-get-gopher-page elpher-render-download "bin" elpher-binary)
85 ((gopher ?7) elpher-get-gopher-query-page elpher-render-index "?" elpher-search)
86 ((gopher ?9) elpher-get-gopher-page elpher-render-download "bin" elpher-binary)
87 ((gopher ?g) elpher-get-gopher-page elpher-render-image "img" elpher-image)
88 ((gopher ?p) elpher-get-gopher-page elpher-render-image "img" elpher-image)
89 ((gopher ?I) elpher-get-gopher-page elpher-render-image "img" elpher-image)
90 ((gopher ?d) elpher-get-gopher-page elpher-render-download "doc" elpher-binary)
91 ((gopher ?P) elpher-get-gopher-page elpher-render-download "doc" elpher-binary)
92 ((gopher ?s) elpher-get-gopher-page elpher-render-download "snd" elpher-binary)
93 ((gopher ?h) elpher-get-gopher-page elpher-render-html "htm" elpher-html)
94 (gemini elpher-get-gemini-page elpher-render-gemini "gem" elpher-gemini)
95 (finger elpher-get-finger-page elpher-render-text "txt" elpher-text)
96 (telnet elpher-get-telnet-page nil "tel" elpher-telnet)
97 (other-url elpher-get-other-url-page nil "url" elpher-other-url)
98 (file elpher-get-file-page nil "~" elpher-gemini)
99 ((about welcome) elpher-get-welcome-page nil "E" elpher-index)
100 ((about bookmarks) elpher-get-bookmarks-page nil "E" elpher-index)
101 ((about history) elpher-get-history-page nil "E" elpher-index)
102 ((about visited-pages) elpher-get-visited-pages-page nil "E" elpher-index))
103 "Association list from types to getters, renderers, margin codes and index faces.")
106 ;;; Declarations to avoid compiler warnings.
110 (declare-function ansi-color-filter-apply "ansi-color")
111 (declare-function ansi-color-apply "ansi-color")
112 (declare-function bookmark-store "bookmark")
113 (declare-function org-link-store-props "ol")
114 (declare-function org-link-set-parameters "ol")
115 (defvar ansi-color-context)
116 (defvar xterm-color--current-fg)
117 (defvar xterm-color--current-bg)
118 (defvar bookmark-make-record-function)
119 (defvar mu4e~view-beginning-of-url-regexp)
120 (defvar eww-use-browse-url)
121 (defvar thing-at-point-uri-schemes))
124 ;;; Customization group
128 "A gopher and gemini client."
129 :group 'applications)
131 ;; General appearance and customizations
133 (defcustom elpher-open-urls-with-eww nil
134 "If non-nil, open URL selectors using eww.
135 Otherwise, use the system browser via the `browse-url' function."
138 (defcustom elpher-use-header t
139 "If non-nil, display current page information in buffer header."
142 (defcustom elpher-auto-disengage-TLS nil
143 "If non-nil, automatically disengage TLS following an unsuccessful connection.
144 While enabling this may seem convenient, it is also potentially
145 dangerous as it allows switching from an encrypted channel back to
146 plain text without user input."
149 (defcustom elpher-connection-timeout 5
150 "Specifies the number of seconds to wait for a network connection to time out."
153 (defcustom elpher-filter-ansi-from-text nil
154 "If non-nil, filter ANSI escape sequences from text.
155 The default behaviour is to use the ansi-color package (or xterm-color if it is
156 available) to interpret these sequences."
159 (defcustom elpher-certificate-directory
160 (file-name-as-directory (locate-user-emacs-file "elpher-certificates"))
161 "Specify the name of the directory where client certificates will be stored.
162 These certificates may be used for establishing authenticated TLS connections."
165 (defcustom elpher-openssl-command "openssl"
166 "The command used to launch openssl when generating TLS client certificates."
169 (defcustom elpher-default-url-type "gopher"
170 "Default URL type (i.e. scheme) to assume if not explicitly given."
171 :type '(choice (const "gopher")
174 (defcustom elpher-gemini-TLS-cert-checks nil
175 "If non-nil, verify gemini server TLS certs using the default security level.
176 Otherwise, certificate verification is disabled.
178 This defaults to off because it is standard practice for Gemini servers
179 to use self-signed certificates, meaning that most servers provide what
180 EMACS considers to be an invalid certificate."
183 (defcustom elpher-gemini-max-fill-width 80
184 "Specify the maximum default width (in columns) of text/gemini documents.
185 The actual width used is the minimum of this value and the window width at
186 the time when the text is rendered."
189 (defcustom elpher-gemini-link-string "→ "
190 "Specify the string used to indicate links when rendering gemini maps.
194 (defcustom elpher-gemini-bullet-string "•"
195 "Specify the string used for bullets when rendering gemini maps."
198 (defcustom elpher-ipv4-always nil
199 "If non-nil, elpher will always use IPv4 to establish network connections.
200 This can be useful when browsing from a computer that supports IPv6, because
201 some servers which do not support IPv6 can take a long time to time-out."
204 (defcustom elpher-socks-always nil
205 "If non-nil, elpher will establish network connections over a SOCKS proxy.
206 Otherwise, the SOCKS proxy is only used for connections to onion services."
209 (defcustom elpher-use-emacs-bookmark-menu nil
210 "If non-nil, elpher will only use the native Emacs bookmark menu.
211 Otherwise, \\[elpher-show-bookmarks] will visit a special elpher bookmark
212 page within which all of the standard elpher keybindings are active."
215 (defcustom elpher-start-page-url "about:welcome"
216 "Specify the page displayed initially by elpher.
217 The default welcome screen is \"about:welcome\", while the bookmarks list
218 is \"about:bookmarks\". You can also specify local files via \"file:\".
220 Beware that using \"about:bookmarks\" as a start page in combination with
221 the `elpher-use-bookmark-menu' variable set to non-nil will prevent the
222 Emacs bookmark menu being accessible via \\[elpher-show-bookmarks] from
226 (defcustom elpher-gemini-hide-preformatted nil
227 "Cause elpher to hide preformatted gemini text by default.
228 When this option is enabled, preformatted text in text/gemini documents
229 is replaced with a button which can be used to toggle its display.
231 This is intended to improve accessibility, as preformatted text often
232 includes art which can be difficult for screen readers to interpret
236 (defcustom elpher-gemini-preformatted-toggle-bullet "‣ "
237 "Margin symbol used to distinguish the preformatted text toggle."
240 (defcustom elpher-gemini-preformatted-toggle-label "[Toggle Preformatted Text]"
241 "Label of button used to toggle formatted text."
244 (defcustom elpher-certificate-map nil
245 "Register client certificates to be used for gemini URLs.
246 This variable contains an alist representing a mapping between gemini
247 URLs and the names of client certificates which will be automatically
248 activated for those URLs. Beware that the certificates will also be
249 active for all subdirectories of the given URLs."
250 :type '(alist :key-type string :value-type string))
252 ;; Face customizations
254 (defgroup elpher-faces nil
255 "Elpher face customizations."
258 (defface elpher-index
259 '((t :inherit font-lock-keyword-face))
260 "Face used for directory type directory records.")
264 "Face used for text type directory records.")
267 '((t :inherit default))
268 "Face used for info type directory records.")
270 (defface elpher-image
271 '((t :inherit font-lock-string-face))
272 "Face used for image type directory records.")
274 (defface elpher-search
275 '((t :inherit warning))
276 "Face used for search type directory records.")
279 '((t :inherit font-lock-comment-face))
280 "Face used for html type directory records.")
282 (defface elpher-gemini
283 '((t :inherit font-lock-constant-face))
284 "Face used for Gemini type directory records.")
286 (defface elpher-other-url
287 '((t :inherit font-lock-comment-face))
288 "Face used for other URL type links records.")
290 (defface elpher-telnet
291 '((t :inherit font-lock-function-name-face))
292 "Face used for telnet type directory records.")
294 (defface elpher-binary
295 '((t :inherit font-lock-doc-face))
296 "Face used for binary type directory records.")
298 (defface elpher-unknown
299 '((t :inherit error))
300 "Face used for directory records with unknown/unsupported types.")
302 (defface elpher-margin-key
304 "Face used for directory margin key.")
306 (defface elpher-margin-brackets
307 '((t :inherit shadow))
308 "Face used for brackets around directory margin key.")
310 (defface elpher-gemini-heading1
311 '((t :inherit bold :height 1.8))
312 "Face used for gemini heading level 1.")
314 (defface elpher-gemini-heading2
315 '((t :inherit bold :height 1.5))
316 "Face used for gemini heading level 2.")
318 (defface elpher-gemini-heading3
319 '((t :inherit bold :height 1.2))
320 "Face used for gemini heading level 3.")
322 (defface elpher-gemini-quoted
323 '((t :inherit font-lock-doc-face))
324 "Face used for gemini quoted texts.")
326 (defface elpher-gemini-preformatted
327 '((t :inherit default))
328 "Face used for gemini preformatted text.")
330 (defface elpher-gemini-preformatted-toggle
331 '((t :inherit button))
332 "Face used for buttons used to toggle display of preformatted text.")
339 ;; An elpher "address" object is either a url object or a symbol.
340 ;; Addresses with the "about" type, corresponding to pages generated
341 ;; dynamically for and by elpher. All others represent pages which
342 ;; rely on content retrieved over the network.
344 (defun elpher-address-from-url (url-string &optional default-scheme)
345 "Create a ADDRESS object corresponding to the given URL-STRING.
346 If DEFAULT-SCHEME is non-nil, this sets the scheme of the URL when one
347 is not explicitly given."
348 (let ((data (match-data))) ; Prevent parsing clobbering match data
350 (let ((url (url-generic-parse-url url-string)))
351 (unless (and (not (url-fullness url)) (url-type url))
352 (unless (url-type url)
353 (setf (url-type url) default-scheme))
354 (unless (url-host url)
355 (let ((p (split-string (url-filename url) "/" nil nil)))
356 (setf (url-host url) (car p))
357 (setf (url-filename url)
359 (concat "/" (mapconcat #'identity (cdr p) "/"))
361 (when (not (string-empty-p (url-host url)))
362 (setf (url-fullness url) t)
363 (setf (url-host url) (puny-encode-domain (url-host url))))
364 (when (or (equal "gopher" (url-type url))
365 (equal "gophers" (url-type url)))
367 (when (or (equal (url-filename url) "")
368 (equal (url-filename url) "/"))
369 (setf (url-filename url) "/1")))
370 (when (equal "gemini" (url-type url))
372 (if (equal (url-filename url) "")
373 (setf (url-filename url) "/"))))
374 (elpher-remove-redundant-ports url))
375 (set-match-data data))))
377 (defun elpher-remove-redundant-ports (address)
378 "Remove redundant port specifiers from ADDRESS.
379 Here `redundant' means that the specified port matches the default
380 for that protocol, eg 70 for gopher."
381 (if (and (not (elpher-address-about-p address))
382 (eq (url-portspec address) ; (url-port) is too slow!
383 (pcase (url-type address)
385 ((or "gopher" "gophers") 70)
388 (setf (url-portspec address) nil))
391 (defun elpher-make-gopher-address (type selector host port &optional tls)
392 "Create an ADDRESS object using gopher directory record attributes.
393 The basic attributes include: TYPE, SELECTOR, HOST and PORT.
394 If the optional attribute TLS is non-nil, the address will be marked as
395 requiring gopher-over-TLS."
397 ((equal type ?i) nil)
398 ((and (equal type ?h)
399 (string-prefix-p "URL:" selector))
400 (elpher-address-from-url (elt (split-string selector "URL:") 1)))
402 (elpher-address-from-url
405 ":" (number-to-string port))))
407 (elpher-address-from-url
408 (concat "gopher" (if tls "s" "")
410 ":" (number-to-string port)
414 (defun elpher-make-about-address (type)
415 "Create an ADDRESS object corresponding to the given about address TYPE."
416 (elpher-address-from-url (concat "about:" (symbol-name type))))
418 (defun elpher-address-to-url (address)
419 "Get string representation of ADDRESS."
420 (url-encode-url (url-recreate-url address)))
422 (defun elpher-address-type (address)
423 "Retrieve type of ADDRESS object.
424 This is used to determine how to retrieve and render the document the
425 address refers to, via the table `elpher-type-map'."
426 (pcase (url-type address)
428 (list 'about (intern (url-filename address))))
429 ((or "gopher" "gophers")
431 (if (member (url-filename address) '("" "/"))
433 (string-to-char (substring (url-filename address) 1)))))
440 (defun elpher-address-about-p (address)
441 "Return non-nil if ADDRESS is an about address."
442 (pcase (elpher-address-type address) (`(about ,_) t)))
444 (defun elpher-address-gopher-p (address)
445 "Return non-nil if ADDRESS object is a gopher address."
446 (pcase (elpher-address-type address) (`(gopher ,_) t)))
448 (defun elpher-address-protocol (address)
449 "Retrieve the transport protocol for ADDRESS."
452 (defun elpher-address-filename (address)
453 "Retrieve the filename component of ADDRESS.
454 For gopher addresses this is a combination of the selector type and selector."
455 (url-unhex-string (url-filename address)))
457 (defun elpher-address-host (address)
458 "Retrieve host from ADDRESS object."
459 (pcase (url-host address)
460 ;; The following strips out square brackets which sometimes enclose IPv6
461 ;; addresses. Doing this here rather than at the parsing stage may seem
462 ;; weird, but this lets us way we avoid having to muck with both URL parsing
463 ;; and reconstruction. It's also more efficient, as this method is not
464 ;; called during page rendering.
465 ((rx (: "[" (let ipv6 (* (not "]"))) "]"))
467 ;; The following is a work-around for a parsing bug that causes
468 ;; URLs with empty (but not absent, see RFC 1738) usernames to have
469 ;; @ prepended to the hostname.
470 ((rx (: "@" (let rest (+ anything))))
475 (defun elpher-address-user (address)
476 "Retrieve user from ADDRESS object."
479 (defun elpher-address-port (address)
480 "Retrieve port from ADDRESS object.
481 If no address is defined, returns 0. (This is for compatibility with
483 (let ((port (url-portspec address))) ; (url-port) is too slow!
486 (defun elpher-gopher-address-selector (address)
487 "Retrieve gopher selector from ADDRESS object."
488 (if (member (url-filename address) '("" "/"))
490 (url-unhex-string (substring (url-filename address) 2))))
495 (defvar elpher-content-cache (make-hash-table :test 'equal))
496 (defvar elpher-pos-cache (make-hash-table :test 'equal))
498 (defun elpher-get-cached-content (address)
499 "Retrieve the cached content for ADDRESS, or nil if none exists."
500 (gethash address elpher-content-cache))
502 (defun elpher-cache-content (address content)
503 "Set the content cache for ADDRESS to CONTENT."
504 (puthash address content elpher-content-cache))
506 (defun elpher-get-cached-pos (address)
507 "Retrieve the cached cursor position for ADDRESS, or nil if none exists."
508 (gethash address elpher-pos-cache))
510 (defun elpher-cache-pos (address pos)
511 "Set the cursor position cache for ADDRESS to POS."
512 (puthash address pos elpher-pos-cache))
517 (defun elpher-make-page (display-string address)
518 "Create a page with DISPLAY-STRING and ADDRESS."
519 (list display-string address))
521 (defun elpher-make-start-page ()
522 "Create the start page."
523 (elpher-make-page "Start Page"
524 (elpher-address-from-url elpher-start-page-url)))
526 (defun elpher-page-display-string (page)
527 "Retrieve the display string corresponding to PAGE."
530 (defun elpher-page-address (page)
531 "Retrieve the address corresponding to PAGE."
534 (defun elpher-page-set-address (page new-address)
535 "Set the address corresponding to PAGE to NEW-ADDRESS."
536 (setcar (cdr page) new-address))
538 (defun elpher-page-from-url (url &optional default-scheme)
539 "Create a page with address and display string defined by URL.
540 The URL is unhexed prior to its use as a display string to improve
543 If DEFAULT-SCHEME is non-nil, this scheme is applied to the URL
544 in the instance that URL itself doesn't specify one."
545 (let ((address (elpher-address-from-url url default-scheme)))
546 (elpher-make-page (elpher-address-to-iri address) address)))
548 (defun elpher-address-to-iri (address)
549 "Return an IRI for ADDRESS.
550 Decode percent-escapes and handle punycode in the domain name.
551 Drop the password, if any."
552 (let ((data (match-data)) ; Prevent parsing clobbering match data
553 (host (url-host address))
554 (pass (url-password address)))
556 (let* ((host (url-host address))
557 (pass (url-password address)))
559 (setf (url-host address) (puny-decode-domain host)))
560 (when pass ; RFC 3986 says we should not render
561 (setf (url-password address) nil)) ; the password as clear text
562 (elpher-decode (url-unhex-string (url-recreate-url address))))
563 (setf (url-host address) host)
564 (setf (url-password address) pass)
565 (set-match-data data))))
567 (defvar elpher-current-page nil
568 "The current page for this Elpher buffer.")
570 (defvar elpher-history nil
571 "The local history stack for this Elpher buffer.
572 This variable is used by `elpher-back' and
573 `elpher-show-history'.")
575 (defvar elpher-visited-pages nil
576 "The global history for all Elpher buffers.
577 This variable is used by `elpher-show-visited-pages'.")
579 (defun elpher-visit-page (page &optional renderer no-history)
580 "Visit PAGE using its own renderer or RENDERER, if non-nil.
581 Additionally, push PAGE onto the history stack and the list of
582 previously-visited pages, unless NO-HISTORY is non-nil."
584 (elpher-process-cleanup)
586 (unless (or (not elpher-current-page)
587 (equal (elpher-page-address elpher-current-page)
588 (elpher-page-address page)))
589 (push elpher-current-page elpher-history)
590 (unless (or (elpher-address-about-p (elpher-page-address page))
591 (and elpher-visited-pages
592 (equal page (car elpher-visited-pages))))
593 (push page elpher-visited-pages))))
594 (setq-local elpher-current-page page)
595 (let* ((address (elpher-page-address page))
596 (type (elpher-address-type address))
597 (type-record (cdr (assoc type elpher-type-map))))
599 (funcall (car type-record)
603 (elpher-visit-previous-page)
605 (`(gopher ,type-char)
606 (error "Unsupported gopher selector type '%c' for '%s'"
607 type-char (elpher-address-to-url address)))
609 (error "Unsupported address type '%S' for '%s'"
610 other (elpher-address-to-url address)))))))
612 (defun elpher-visit-previous-page ()
613 "Visit the previous page in the history."
615 (elpher-visit-page (pop elpher-history) nil t)
616 (error "No previous page")))
618 (defun elpher-reload-current-page ()
619 "Reload the current page, discarding any existing cached content."
620 (elpher-cache-content (elpher-page-address elpher-current-page) nil)
621 (elpher-visit-page elpher-current-page))
623 (defun elpher-save-pos ()
624 "Save the current position of point to the current page."
625 (when elpher-current-page
626 (elpher-cache-pos (elpher-page-address elpher-current-page) (point))))
628 (defun elpher-restore-pos ()
629 "Restore the position of point to that cached in the current page."
630 (let ((pos (elpher-get-cached-pos (elpher-page-address elpher-current-page))))
633 (goto-char (point-min)))))
635 (defun elpher-get-default-url-scheme ()
636 "Suggest default URL scheme for visiting addresses based on the current page."
637 (if elpher-current-page
638 (let* ((address (elpher-page-address elpher-current-page))
639 (current-type (elpher-address-type address)))
641 ((or (and 'file (guard (not elpher-history)))
643 elpher-default-url-type)
645 (url-type address))))
646 elpher-default-url-type))
649 ;;; Buffer preparation
652 (defvar elpher-buffer-name "*elpher*"
653 "The default name of the Elpher buffer.")
655 (defun elpher-update-header ()
656 "If `elpher-use-header' is true, display current page info in window header."
657 (if (and elpher-use-header elpher-current-page)
658 (let* ((display-string (elpher-page-display-string elpher-current-page))
659 (sanitized-display-string (replace-regexp-in-string "%" "%%" display-string))
660 (address (elpher-page-address elpher-current-page))
661 (tls-string (if (and (not (elpher-address-about-p address))
662 (member (elpher-address-protocol address)
663 '("gophers" "gemini")))
666 (header (concat sanitized-display-string
667 (propertize tls-string 'face 'bold))))
668 (setq header-line-format header))))
670 (defmacro elpher-with-clean-buffer (&rest args)
671 "Evaluate ARGS with a clean *elpher* buffer as current."
672 (declare (debug (body))) ;; Allow edebug to step through body
673 `(with-current-buffer elpher-buffer-name
674 (unless (eq major-mode 'elpher-mode)
675 ;; avoid resetting buffer-local variables
677 (let ((inhibit-read-only t)
678 (ansi-color-context nil)) ;; clean ansi interpreter state (also next 2 lines)
679 (setq-local xterm-color--current-fg nil)
680 (setq-local xterm-color--current-bg nil)
681 (setq-local network-security-level
682 (default-value 'network-security-level))
684 (elpher-update-header)
687 (defun elpher-buffer-message (string &optional line)
688 "Replace first line in elpher buffer with STRING.
689 If LINE is non-nil, replace that line instead."
690 (with-current-buffer elpher-buffer-name
691 (let ((inhibit-read-only t))
692 (goto-char (point-min))
695 (let ((data (match-data)))
698 (re-search-forward "^.*$")
699 (replace-match string))
700 (set-match-data data))))))
702 ;;; Link button definitions
705 (defvar elpher-link-keymap
706 (let ((map (make-sparse-keymap)))
707 (keymap-set map "S-<down-mouse-1>" 'ignore) ;Prevent buffer face popup
708 (keymap-set map "S-<mouse-1>" #'elpher--open-link-new-buffer-mouse)
709 (keymap-set map "S-<return>" #'elpher--open-link-new-buffer)
710 (set-keymap-parent map button-map)
713 (defun elpher--click-link (button)
714 "Function called when the gopher link BUTTON is activated."
715 (let ((page (button-get button 'elpher-page)))
716 (elpher-visit-page page)))
718 (defun elpher--open-link-new-buffer ()
719 "Internal function used by Elpher to open links in a new buffer."
721 (let ((page (button-get (button-at (point)) 'elpher-page))
722 (new-buf (generate-new-buffer (default-value 'elpher-buffer-name))))
723 (pop-to-buffer new-buf)
725 (elpher-visit-page page)))
727 (defun elpher--open-link-new-buffer-mouse (event)
728 "Internal function used by Elpher to open links in a new buffer.
729 The EVENT argument is the mouse event which caused this function to be
732 (mouse-set-point event)
733 (elpher--open-link-new-buffer))
735 (defun elpher--page-button-help (_window buffer pos)
736 "Function called by Emacs to generate mouse-over text.
737 The arguments specify the BUFFER and the POS within the buffer of the item
738 for which help is required. The function returns the help to be
739 displayed. The _WINDOW argument is currently unused."
740 (with-current-buffer buffer
741 (let ((button (button-at pos)))
743 (let* ((page (button-get button 'elpher-page))
744 (address (elpher-page-address page)))
745 (format "mouse-1, RET: open '%s'" (elpher-address-to-url address)))))))
747 (define-button-type 'elpher-link
748 'action #'elpher--click-link
749 'keymap elpher-link-keymap
751 'help-echo #'elpher--page-button-help
757 (defvar elpher-user-coding-system nil
758 "User-specified coding system to use for decoding text responses.")
760 (defun elpher-decode (string)
761 "Decode STRING using autodetected or user-specified coding system."
762 (decode-coding-string string
763 (if elpher-user-coding-system
764 elpher-user-coding-system
765 (detect-coding-string string t))))
767 (defun elpher-preprocess-text-response (string)
768 "Preprocess text selector response contained in STRING.
769 This involes decoding the character representation, and clearing
770 away CRs and any terminating period."
771 (elpher-decode (replace-regexp-in-string "\n\\.\n$" "\n"
772 (replace-regexp-in-string "\r" "" string))))
776 (defconst elpher-url-regex
777 "\\([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_~?/@|#-]\\)?\\)?"
778 "Regexp used to locate and buttonify URLs in text files loaded by elpher.")
780 (defun elpher-buttonify-urls (string)
781 "Turn substrings which look like urls in STRING into clickable buttons."
784 (goto-char (point-min))
785 (while (re-search-forward elpher-url-regex nil t)
786 (let ((page (elpher-page-from-url (substring-no-properties (match-string 0)))))
787 (make-text-button (match-beginning 0)
790 :type 'elpher-link)))
794 ;; ANSI colors or XTerm colors (application and filtering)
796 (or (require 'xterm-color nil t)
797 (require 'ansi-color))
799 (defalias 'elpher-color-filter-apply
800 (if (fboundp 'xterm-color-filter)
802 (let ((_xterm-color-render nil))
803 (xterm-color-filter s)))
804 #'ansi-color-filter-apply)
805 "A function to filter out ANSI escape sequences.")
807 (defalias 'elpher-color-apply
808 (if (fboundp 'xterm-color-filter)
811 "A function to apply ANSI escape sequences.")
813 (defun elpher-text-has-ansi-escapes-p (string)
814 "Return non-nil if STRING includes an ANSI escape code."
816 (string-match "\x1b\\[" string)))
819 ;; Processing text for display
821 (defun elpher-process-text-for-display (string)
822 "Perform any desired processing of STRING prior to display as text.
823 Currently includes buttonifying URLs and processing ANSI escape codes."
824 (elpher-buttonify-urls (if (elpher-text-has-ansi-escapes-p string)
825 (if elpher-filter-ansi-from-text
826 (elpher-color-filter-apply string)
827 (elpher-color-apply string))
831 ;;; General network communication
834 (defun elpher-network-error (address error)
835 "Display ERROR message following unsuccessful negotiation with ADDRESS.
836 ERROR can be either an error object or a string."
837 (elpher-with-clean-buffer
838 (insert (propertize "\n---- ERROR -----\n\n" 'face 'error)
839 "When attempting to retrieve " (elpher-address-to-url address) ":\n"
840 (if (stringp error) error (error-message-string error)) "\n"
841 (propertize "\n----------------\n\n" 'face 'error)
842 "Press 'u' to return to the previous page.")))
845 (defvar elpher-network-timer nil
846 "Timer used for network connections.")
848 (defvar elpher-use-tls nil
849 "If non-nil, use TLS to communicate with gopher servers.")
851 (defvar elpher-client-certificate nil
852 "If non-nil, contains client certificate details to use for TLS connections.")
854 (defun elpher-process-cleanup ()
855 "Immediately shut down any extant elpher process and timers."
856 (let ((p (get-process "elpher-process")))
857 (if p (delete-process p)))
858 (if (timerp elpher-network-timer)
859 (cancel-timer elpher-network-timer)))
861 (defun elpher-make-network-timer (thunk)
862 "Create a timer to run the THUNK after `elpher-connection-timeout' seconds.
863 This is just a wraper around `run-at-time' which additionally sets the
864 buffer-local variable `elpher-network-timer' to allow
865 `elpher-process-cleanup' to also clear the timer."
866 (let ((timer (run-at-time elpher-connection-timeout nil thunk)))
867 (setq-local elpher-network-timer timer)
870 (defun elpher-get-host-response (address default-port query-string response-processor
871 &optional use-tls force-ipv4)
872 "Generic function for retrieving data from ADDRESS.
874 When ADDRESS lacks a specific port, DEFAULT-PORT is used instead.
875 QUERY-STRING is a string sent to the host specified by ADDRESS to
876 illicet a response. This response is passed as an argument to the
877 function RESPONSE-PROCESSOR.
879 If non-nil, USE-TLS specifies that the connection is to be made over
880 TLS. If set to gemini, the certificate verification will be disabled
881 unless `elpher-gemini-TLS-cert-checks' is non-nil.
883 If non-nil, FORCE-IPV4 causes the network connection to be made over
884 ipv4 only. (The default behaviour when this is not set depends on
885 the host operating system and the local network capabilities.)"
886 (if (and use-tls (not (gnutls-available-p)))
887 (error "Use of TLS requires Emacs to be compiled with GNU TLS support")
888 (unless (< (elpher-address-port address) 65536)
889 (error "Cannot establish network connection: port number > 65536"))
890 (when (and (eq use-tls 'gemini) (not elpher-gemini-TLS-cert-checks))
891 (setq-local network-security-level 'low)
892 (setq-local gnutls-verify-error nil))
894 (let* ((kill-buffer-query-functions nil)
895 (port (elpher-address-port address))
896 (host (elpher-address-host address))
897 (service (if (> port 0) port default-port))
898 (response-string-parts nil)
901 (socks (or elpher-socks-always (string-suffix-p ".onion" host)))
902 (gnutls-params (list :type 'gnutls-x509pki
905 (elpher-get-current-keylist address)))
906 (timer (elpher-make-network-timer
908 (elpher-process-cleanup)
910 ; Try again with IPv4
911 ((not (or elpher-ipv4-always force-ipv4 socks))
912 (message "Connection timed out. Retrying with IPv4.")
913 (elpher-get-host-response address default-port
918 (not (eq use-tls 'gemini))
919 (or elpher-auto-disengage-TLS
921 "TLS connetion failed. Disable TLS mode and retry? ")))
922 (setq elpher-use-tls nil)
923 (elpher-get-host-response address default-port
928 (elpher-network-error address "Connection time-out."))))))
930 (socks-open-network-stream "elpher-process" nil host service)
931 (make-network-process :name "elpher-process"
933 :family (and (or force-ipv4
941 (cons 'gnutls-x509pki
942 (apply #'gnutls-boot-parameters
944 (process-put proc 'elpher-buffer (current-buffer))
945 (setq elpher-network-timer timer)
946 (set-process-coding-system proc 'binary 'binary)
947 (set-process-query-on-exit-flag proc nil)
948 (elpher-buffer-message (concat "Connecting to " host "..."
949 " (press 'u' to abort)"))
950 (set-process-filter proc
951 (lambda (_proc string)
955 (setq bytes-received (+ bytes-received (length string)))
956 (let ((new-hkbytes-received (/ bytes-received 102400)))
957 (when (> new-hkbytes-received hkbytes-received)
958 (setq hkbytes-received new-hkbytes-received)
959 (elpher-buffer-message
961 (number-to-string (/ hkbytes-received 10.0))
964 (setq response-string-parts
965 (cons string response-string-parts))))
966 (set-process-sentinel proc
969 (cancel-timer timer))
970 (condition-case the-error
972 ((string-prefix-p "open" event) ; request URL
973 (elpher-buffer-message
974 (concat "Connected to " host ". Receiving data..."
975 " (press 'u' to abort)"))
976 (let ((inhibit-eol-conversion t))
977 (process-send-string proc query-string)))
978 ((string-prefix-p "deleted" event)) ; do nothing
979 ((and (not response-string-parts)
980 (not (or elpher-ipv4-always force-ipv4 socks)))
981 ; Try again with IPv4
982 (message "Connection failed. Retrying with IPv4.")
983 (elpher-get-host-response address default-port
987 (response-string-parts
988 (with-current-buffer (process-get proc 'elpher-buffer)
989 (elpher-with-clean-buffer
990 (insert "Data received. Rendering..."))
991 (funcall response-processor
992 (apply #'concat (reverse response-string-parts)))
993 (elpher-restore-pos)))
995 (error "No response from server")))
997 (elpher-network-error address the-error)))))
1000 (apply #'gnutls-negotiate :process proc gnutls-params))
1001 (funcall (process-sentinel proc) proc "open\n")))
1003 (elpher-process-cleanup)
1004 (error "Error initiating connection to server")))))
1007 ;;; Client-side TLS Certificate Management
1010 (defun elpher-generate-certificate (common-name key-file cert-file url-prefix
1011 &optional temporary)
1012 "Generate a key and a self-signed client TLS certificate using openssl.
1014 The Common Name field of the certificate is set to COMMON-NAME. The
1015 arguments KEY-FILE and CERT-FILE should contain the absolute paths of
1016 the key and certificate files to write.
1018 If TEMPORARY is non-nil, the certificate will be given an exporation
1019 period of one day, and the key and certificate files will be deleted
1020 when the certificate is no longer needed for the current session.
1022 Otherwise, the certificate will be given a 100 year expiration period
1023 and the files will not be deleted.
1025 The function returns a list containing the URL-PREFIX of addresses
1026 for which the certificate should be used in this session, the
1027 temporary flag, and the key and cert file names in the form required
1028 by `gnutls-boot-parameters`."
1029 (let ((exp-key-file (expand-file-name key-file))
1030 (exp-cert-file (expand-file-name cert-file)))
1033 (call-process elpher-openssl-command nil nil nil
1034 "req" "-x509" "-newkey" "rsa:2048"
1035 "-days" (if temporary "1" "36500")
1037 "-subj" (concat "/CN=" common-name)
1038 "-keyout" exp-key-file
1039 "-out" exp-cert-file)
1040 (list url-prefix temporary exp-key-file exp-cert-file))
1042 (message "Check that openssl is installed, or customize `elpher-openssl-command`.")
1043 (error "Program 'openssl', required for certificate generation, not found")))))
1045 (defun elpher-generate-throwaway-certificate (url-prefix)
1046 "Generate and return details of a throwaway certificate.
1047 The key and certificate files will be deleted when they are no
1048 longer needed for this session.
1050 The certificate will be marked as applying to all addresses with URLs
1051 starting with URL-PREFIX."
1052 (let* ((file-base (make-temp-name "elpher"))
1053 (key-file (concat temporary-file-directory file-base ".key"))
1054 (cert-file (concat temporary-file-directory file-base ".crt")))
1055 (elpher-generate-certificate file-base key-file cert-file url-prefix t)))
1057 (defun elpher-generate-persistent-certificate (file-base common-name url-prefix)
1058 "Generate and return details of a persistent certificate.
1059 The argument FILE-BASE is used as the base for the key and certificate
1060 files, while COMMON-NAME specifies the common name field of the
1063 The key and certificate files are written to in `elpher-certificate-directory'.
1065 In this session, the certificate will remain active for all addresses
1066 having URLs starting with URL-PREFIX."
1067 (let* ((key-file (concat elpher-certificate-directory file-base ".key"))
1068 (cert-file (concat elpher-certificate-directory file-base ".crt")))
1069 (elpher-generate-certificate common-name key-file cert-file url-prefix)))
1071 (defun elpher-get-existing-certificate (file-base url-prefix)
1072 "Return a certificate object corresponding to an existing certificate.
1073 It is assumed that the key files FILE-BASE.key and FILE-BASE.crt exist in
1074 the directory `elpher-certificate-directory'.
1076 In this session, the certificate will remain active for all addresses
1077 having URLs starting with URL-PREFIX."
1078 (let* ((key-file (concat elpher-certificate-directory file-base ".key"))
1079 (cert-file (concat elpher-certificate-directory file-base ".crt")))
1082 (expand-file-name key-file)
1083 (expand-file-name cert-file))))
1085 (defun elpher-install-certificate (key-file-src cert-file-src file-base url-prefix)
1086 "Install a key+certificate file pair in `elpher-certificate-directory'.
1087 The strings KEY-FILE-SRC and CERT-FILE-SRC are the existing key and
1088 certificate files to install. The argument FILE-BASE is used as the
1089 base for the installed key and certificate files.
1091 In this session, the certificate will remain active for all addresses
1092 having URLs starting with URL-PREFIX."
1093 (let* ((key-file (concat elpher-certificate-directory file-base ".key"))
1094 (cert-file (concat elpher-certificate-directory file-base ".crt")))
1095 (if (or (file-exists-p key-file)
1096 (file-exists-p cert-file))
1097 (error "A certificate with base name %s is already installed" file-base))
1098 (unless (and (file-exists-p key-file-src)
1099 (file-exists-p cert-file-src))
1100 (error "Either of the key or certificate files do not exist"))
1101 (copy-file key-file-src key-file)
1102 (copy-file cert-file-src cert-file)
1105 (expand-file-name key-file)
1106 (expand-file-name cert-file))))
1108 (defun elpher-list-existing-certificates ()
1109 "Return a list of the persistent certificates in `elpher-certificate-directory'."
1110 (unless (file-directory-p elpher-certificate-directory)
1111 (make-directory elpher-certificate-directory))
1114 (file-name-sans-extension file))
1115 (directory-files elpher-certificate-directory nil "\\.key$")))
1117 (defun elpher-forget-current-certificate ()
1118 "Causes any current certificate to be forgotten.)
1119 In the case of throwaway certificates, the key and certificate files
1122 (when elpher-client-certificate
1123 (unless (and (called-interactively-p 'any)
1124 (not (y-or-n-p (concat "Really forget client certificate? "
1125 "(Throwaway certificates will be deleted.)"))))
1126 (when (cadr elpher-client-certificate)
1127 (delete-file (elt elpher-client-certificate 2))
1128 (delete-file (elt elpher-client-certificate 3)))
1129 (setq-local elpher-client-certificate nil)
1130 (if (called-interactively-p 'any)
1131 (message "Client certificate forgotten.")))))
1133 (defun elpher-get-current-keylist (address)
1134 "Retrieve the `gnutls-boot-parameters'-compatable keylist.
1136 This is obtained from the client certificate described by
1137 `elpher-current-certificate', if one is available and the
1138 URL prefix for that certificate matches ADDRESS.
1140 If `elpher-current-certificate' is non-nil, and its URL prefix doesn't
1141 match that of ADDRESS, the certificate is forgotten."
1142 (if elpher-client-certificate
1143 (if (string-prefix-p (car elpher-client-certificate)
1144 (elpher-address-to-url address))
1145 (list (cddr elpher-client-certificate))
1146 (elpher-forget-current-certificate)
1147 (message "Disabling client certificate for new host")
1152 ;;; Gopher selector retrieval
1155 (defun elpher-get-gopher-response (address renderer)
1156 "Get response string from gopher server at ADDRESS and render using RENDERER."
1157 (elpher-get-host-response address 70
1158 (concat (elpher-gopher-address-selector address) "\r\n")
1160 (or (string= (elpher-address-protocol address) "gophers")
1163 (defun elpher-get-gopher-page (renderer)
1164 "Getter function for gopher pages.
1165 The RENDERER procedure is used to display the contents of the page
1166 once they are retrieved from the gopher server."
1167 (let* ((address (elpher-page-address elpher-current-page))
1168 (content (elpher-get-cached-content address)))
1169 (if (and content (funcall renderer nil))
1170 (elpher-with-clean-buffer
1172 (elpher-restore-pos))
1173 (elpher-with-clean-buffer
1174 (insert "LOADING... (use 'u' to cancel)\n"))
1175 (condition-case the-error
1176 (elpher-get-gopher-response address renderer)
1178 (elpher-network-error address the-error))))))
1181 ;;; Gopher index rendering
1184 (defun elpher-insert-margin (&optional type-name)
1185 "Insert index margin, optionally containing the TYPE-NAME, into current buffer."
1188 (insert (format (concat "%" (number-to-string (- elpher-margin-width 1)) "s")
1190 (propertize "[" 'face 'elpher-margin-brackets)
1191 (propertize type-name 'face 'elpher-margin-key)
1192 (propertize "]" 'face 'elpher-margin-brackets))))
1194 (insert (make-string elpher-margin-width ?\s))))
1196 (defun elpher-insert-index-record (display-string &optional address)
1197 "Function to insert an index record into the current buffer.
1198 The contents of the record are dictated by DISPLAY-STRING and ADDRESS.
1199 If ADDRESS is not supplied or nil the record is rendered as an
1200 `information' line."
1201 (let* ((type (if address (elpher-address-type address) nil))
1202 (type-map-entry (cdr (assoc type elpher-type-map))))
1204 (let* ((margin-code (elt type-map-entry 2))
1205 (face (elt type-map-entry 3))
1206 (filtered-display-string (elpher-color-filter-apply display-string))
1207 (page (elpher-make-page filtered-display-string address)))
1208 (elpher-insert-margin margin-code)
1209 (insert-text-button filtered-display-string
1212 :type 'elpher-link))
1214 ('nil ;; Information
1215 (elpher-insert-margin)
1216 (let ((propertized-display-string
1217 (propertize display-string 'face 'elpher-info)))
1218 (insert (elpher-process-text-for-display propertized-display-string))))
1219 (`(gopher ,selector-type) ;; Unknown
1220 (elpher-insert-margin (concat (char-to-string selector-type) "?"))
1221 (insert (propertize display-string
1222 'face 'elpher-unknown)))))
1225 (defun elpher-render-index (data &optional _mime-type-string)
1226 "Render DATA as an index. MIME-TYPE-STRING is unused."
1227 (elpher-with-clean-buffer
1230 (let ((data-processed (elpher-preprocess-text-response data)))
1231 (dolist (line (split-string data-processed "\n"))
1233 (unless (= (length line) 0)
1234 (let* ((type (elt line 0))
1235 (fields (split-string (substring line 1) "\t"))
1236 (display-string (elt fields 0))
1237 (selector (elt fields 1))
1238 (host (elt fields 2))
1239 (port (if (elt fields 3)
1240 (string-to-number (elt fields 3))
1242 (address (elpher-make-gopher-address type selector host port)))
1243 (elpher-insert-index-record display-string address))))))
1244 (elpher-cache-content (elpher-page-address elpher-current-page)
1248 ;;; Gopher text rendering
1251 (defun elpher-render-text (data &optional _mime-type-string)
1252 "Render DATA as text. MIME-TYPE-STRING is unused."
1253 (elpher-with-clean-buffer
1256 (insert (elpher-process-text-for-display (elpher-preprocess-text-response data)))
1257 (elpher-cache-content
1258 (elpher-page-address elpher-current-page)
1265 (defun elpher-render-image (data &optional _mime-type-string)
1266 "Display DATA as image. MIME-TYPE-STRING is unused."
1269 (if (display-images-p)
1270 (let* ((image (create-image
1274 (error "Unsupported image format")
1275 (let ((window (get-buffer-window elpher-buffer-name)))
1277 (setf (image-property image :max-width) (window-body-width window t))
1278 (setf (image-property image :max-height) (window-body-height window t))))
1279 (elpher-with-clean-buffer
1280 (insert-image image)
1281 (elpher-restore-pos))))
1282 (elpher-render-download data))))
1285 ;;; Gopher search retrieval and rendering
1288 (defun elpher-get-gopher-query-page (renderer)
1289 "Getter for gopher addresses requiring input.
1290 The response is rendered using the rendering function RENDERER."
1291 (let* ((address (elpher-page-address elpher-current-page))
1292 (content (elpher-get-cached-content address))
1294 (if (and content (funcall renderer nil))
1295 (elpher-with-clean-buffer
1297 (elpher-restore-pos)
1298 (message "Displaying cached search results. Reload to perform a new search."))
1300 (let* ((query-string (read-string "Query: "))
1301 (query-selector (concat (elpher-gopher-address-selector address) "\t" query-string))
1302 (search-address (elpher-make-gopher-address ?1
1304 (elpher-address-host address)
1305 (elpher-address-port address)
1306 (equal (elpher-address-type address) "gophers"))))
1309 (elpher-with-clean-buffer
1310 (insert "LOADING RESULTS... (use 'u' to cancel)"))
1311 (elpher-get-gopher-response search-address renderer))
1313 (elpher-visit-previous-page))))))
1316 ;;; Raw server response rendering
1319 (defun elpher-render-raw (data &optional mime-type-string)
1320 "Display raw DATA in buffer. MIME-TYPE-STRING is also displayed if provided."
1323 (elpher-with-clean-buffer
1324 (when mime-type-string
1325 (insert "MIME type specified by server: '" mime-type-string "'\n"))
1327 (goto-char (point-min)))
1328 (message "Displaying raw server response. Reload or redraw to return to standard view.")))
1331 ;;; File save "rendering"
1334 (defun elpher-render-download (data &optional _mime-type-string)
1335 "Save DATA to file. MIME-TYPE-STRING is unused."
1338 (let* ((address (elpher-page-address elpher-current-page))
1339 (selector (if (elpher-address-gopher-p address)
1340 (elpher-gopher-address-selector address)
1341 (elpher-address-filename address))))
1342 (elpher-visit-previous-page) ; Do first in case of non-local exits.
1343 (let* ((filename-proposal (file-name-nondirectory selector))
1344 (filename (read-file-name "Download complete. Save file as: "
1346 (if (> (length filename-proposal) 0)
1349 (let ((coding-system-for-write 'binary))
1350 (with-temp-file filename
1352 (message (format "Saved to file %s." filename))))))
1358 (defun elpher-render-html (data &optional _mime-type-string)
1359 "Render DATA as HTML using shr. MIME-TYPE-STRING is unused."
1360 (elpher-with-clean-buffer
1363 (let ((dom (with-temp-buffer
1365 (libxml-parse-html-region (point-min) (point-max)))))
1366 (shr-insert-document dom)))))
1369 ;;; Gemini page retrieval
1372 (defvar elpher-gemini-redirect-chain)
1374 (defun elpher-get-gemini-response (address renderer)
1375 "Get response string from gemini server at ADDRESS and render using RENDERER."
1376 (elpher-get-host-response address 1965
1377 (concat (elpher-address-to-url address) "\r\n")
1378 (lambda (response-string)
1379 (elpher-process-gemini-response response-string renderer))
1382 (defun elpher-parse-gemini-response (response)
1383 "Parse the RESPONSE string and return a list of components.
1384 The list is of the form (code meta body). A response of nil implies
1385 that the response was malformed."
1386 (let ((header-end-idx (string-match "\r\n" response)))
1388 (let ((header (string-trim (substring response 0 header-end-idx)))
1389 (body (substring response (+ header-end-idx 2))))
1390 (if (>= (length header) 2)
1391 (let ((code (substring header 0 2))
1392 (meta (string-trim (substring header 2))))
1393 (list code meta body))
1394 (error "Malformed response: No response status found in header %s" header)))
1395 (error "Malformed response: No CRLF-delimited header found in response %s" response))))
1397 (defun elpher-process-gemini-response (response-string renderer)
1398 "Process the gemini response RESPONSE-STRING and pass the result to RENDERER."
1399 (let ((response-components (elpher-parse-gemini-response response-string)))
1400 (let ((response-code (elt response-components 0))
1401 (response-meta (elt response-components 1))
1402 (response-body (elt response-components 2)))
1403 (pcase (elt response-code 0)
1404 (?1 ; Input required
1405 (elpher-with-clean-buffer
1406 (insert "Gemini server is requesting input."))
1407 (let* ((query-string
1409 (if (eq (elt response-code 1) ?1)
1410 (read-passwd (concat response-meta ": "))
1411 (read-string (concat response-meta ": ")))))
1412 (query-address (seq-copy (elpher-page-address elpher-current-page)))
1413 (old-fname (url-filename query-address)))
1414 (if (not query-string)
1415 (elpher-visit-previous-page)
1416 (setf (url-filename query-address)
1417 (concat old-fname "?" (url-build-query-string `((,query-string)))))
1418 (elpher-get-gemini-response query-address renderer))))
1419 (?2 ; Normal response
1420 (funcall renderer response-body response-meta))
1422 (message "Following redirect to %s" response-meta)
1423 (if (>= (length elpher-gemini-redirect-chain) 5)
1424 (error "More than 5 consecutive redirects followed"))
1425 (let ((redirect-address (elpher-address-from-gemini-url response-meta)))
1426 (if (member redirect-address elpher-gemini-redirect-chain)
1427 (error "Redirect loop detected"))
1428 (if (not (eq (elpher-address-type redirect-address) 'gemini))
1429 (error "Server tried to automatically redirect to non-gemini URL: %s"
1431 (elpher-page-set-address elpher-current-page redirect-address)
1432 (add-to-list 'elpher-gemini-redirect-chain redirect-address)
1433 (elpher-get-gemini-response redirect-address renderer)))
1434 (?4 ; Temporary failure
1435 (error "Gemini server reports TEMPORARY FAILURE for this request: %s %s"
1436 response-code response-meta))
1437 (?5 ; Permanent failure
1438 (error "Gemini server reports PERMANENT FAILURE for this request: %s %s"
1439 response-code response-meta))
1440 (?6 ; Client certificate required
1441 (elpher-with-clean-buffer
1442 (if elpher-client-certificate
1443 (insert "Gemini server does not recognise the provided TLS certificate:\n\n")
1444 (insert "Gemini server is requesting a valid TLS certificate:\n\n"))
1446 (elpher-gemini-insert-text response-meta))
1447 (let ((chosen-certificate
1449 (elpher-acquire-client-certificate
1450 (elpher-address-to-url (elpher-page-address elpher-current-page))))))
1451 (unless chosen-certificate
1452 (error "Gemini server requires a client certificate and none was provided"))
1453 (setq-local elpher-client-certificate chosen-certificate))
1454 (elpher-with-clean-buffer)
1455 (elpher-get-gemini-response (elpher-page-address elpher-current-page) renderer))
1457 (error "Gemini server response unknown: %s %s"
1458 response-code response-meta))))))
1460 (defun elpher-acquire-client-certificate (url-prefix)
1461 "Select a pre-defined client certificate or prompt for one.
1462 In this case, \"pre-defined\" means a certificate provided by
1463 the `elpher-certificate-map' variable.
1465 For this session, the certificate will remain active for all addresses
1466 having URLs begining with URL-PREFIX."
1467 (let ((entry (assoc url-prefix
1468 elpher-certificate-map
1469 #'string-prefix-p)))
1471 (let ((cert-url-prefix (car entry))
1472 (cert-name (cadr entry)))
1473 (message "Using certificate \"%s\" specified in elpher-certificate-map with prefix \"%s\""
1474 cert-name cert-url-prefix)
1475 (elpher-get-existing-certificate cert-name cert-url-prefix))
1476 (elpher-prompt-for-client-certificate url-prefix))))
1478 (defun elpher--read-answer-polyfill (question answers)
1479 "Polyfill for `read-answer' in Emacs 26.1.
1480 QUESTION is a string containing a question, and ANSWERS
1481 is a list of possible answers, or an alist whose keys
1482 are the possible answers."
1483 (completing-read question answers))
1485 (if (fboundp 'read-answer)
1486 (defalias 'elpher-read-answer 'read-answer)
1487 (defalias 'elpher-read-answer 'elpher--read-answer-polyfill))
1491 (defun elpher-prompt-for-client-certificate (url-prefix)
1492 "Prompt for a client certificate to use to establish a TLS connection.
1494 In this session, the chosen certificate will remain active for all
1495 addresses with URLs matching URL-PREFIX."
1496 (let* ((read-answer-short t))
1497 (pcase (read-answer "What do you want to do? "
1499 "generate and use throw-away certificate")
1501 "generate new or use existing persistent certificate")
1503 "stop immediately")))
1505 (setq-local elpher-client-certificate (elpher-generate-throwaway-certificate url-prefix)))
1507 (let* ((existing-certificates (elpher-list-existing-certificates))
1508 (file-base (completing-read
1509 "Nickname for new or existing certificate (autocompletes, empty response aborts): "
1510 existing-certificates)))
1511 (if (string-empty-p (string-trim file-base))
1513 (if (member file-base existing-certificates)
1514 (setq-local elpher-client-certificate
1515 (elpher-get-existing-certificate file-base url-prefix))
1516 (pcase (read-answer "Generate new certificate or install externally-generated one? "
1518 "generate new certificate")
1520 "install existing certificate")
1522 "stop immediately")))
1524 (let ((common-name (read-string "Common Name field for new certificate: "
1526 (message "New key and self-signed certificate written to %s"
1527 elpher-certificate-directory)
1528 (elpher-generate-persistent-certificate file-base
1532 (let* ((cert-file (read-file-name "Certificate file: " nil nil t))
1533 (key-file (read-file-name "Key file: " nil nil t)))
1534 (message "Key and certificate installed in %s for future use"
1535 elpher-certificate-directory)
1536 (elpher-install-certificate key-file cert-file file-base
1541 (defun elpher-get-gemini-page (renderer)
1542 "Getter which retrieves and renders a Gemini page and renders it using RENDERER."
1543 (let* ((address (elpher-page-address elpher-current-page))
1544 (content (elpher-get-cached-content address)))
1545 (condition-case the-error
1546 (if (and content (funcall renderer nil))
1547 (elpher-with-clean-buffer
1549 (elpher-restore-pos))
1550 (elpher-with-clean-buffer
1551 (insert "LOADING GEMINI... (use 'u' to cancel)\n"))
1552 (setq elpher-gemini-redirect-chain nil)
1553 (elpher-get-gemini-response address renderer))
1555 (elpher-network-error address the-error)))))
1557 ;;; Gemini page rendering
1560 (defun elpher-render-gemini (body &optional mime-type-string)
1561 "Render gemini response BODY with rendering MIME-TYPE-STRING."
1564 (let* ((mime-type-string* (if (or (not mime-type-string)
1565 (string-empty-p mime-type-string))
1566 "text/gemini; charset=utf-8"
1568 (mime-type-split (split-string mime-type-string* ";" t))
1569 (mime-type (string-trim (car mime-type-split)))
1570 (parameters (mapcar (lambda (s)
1571 (let ((key-val (split-string s "=")))
1572 (list (downcase (string-trim (car key-val)))
1573 (downcase (string-trim (cadr key-val))))))
1574 (cdr mime-type-split))))
1575 (when (string-prefix-p "text/" mime-type)
1576 (setq body (decode-coding-string
1578 (if (assoc "charset" parameters)
1579 (intern (cadr (assoc "charset" parameters)))
1581 (setq body (replace-regexp-in-string "\r" "" body)))
1583 ((or "text/gemini" "")
1584 (elpher-render-gemini-map body parameters))
1586 (elpher-render-html body))
1587 ((pred (string-prefix-p "text/"))
1588 (elpher-render-gemini-plain-text body parameters))
1589 ((pred (string-prefix-p "image/"))
1590 (elpher-render-image body))
1592 (elpher-render-download body))))))
1594 (defun elpher-gemini-get-link-url (link-line)
1595 "Extract the url portion of LINK-LINE, a gemini map file link line.
1596 Returns nil in the event that the contents of the line following the
1597 => prefix are empty."
1598 (let ((l (split-string (substring link-line 2))))
1600 (string-trim (elt l 0))
1603 (defun elpher-gemini-get-link-display-string (link-line)
1604 "Extract the display string portion of LINK-LINE, a gemini map file link line.
1605 Return nil if this portion is not provided."
1606 (let* ((rest (string-trim (elt (split-string link-line "=>") 1)))
1607 (idx (string-match "[ \t]" rest)))
1609 (elpher-color-filter-apply (string-trim (substring rest (+ idx 1)))))))
1611 (defun elpher-collapse-dot-sequences (filename)
1612 "Collapse dot sequences in the (absolute) FILENAME.
1613 For instance, the filename \"/a/b/../c/./d\" will reduce to \"/a/c/d\""
1614 (let* ((path (split-string filename "/" t))
1615 (is-directory (string-match-p (rx (: (or "." ".." "/") line-end)) filename))
1616 (path-reversed-normalized
1617 (seq-reduce (lambda (a b)
1618 (cond ((equal b "..") (cdr a))
1622 (path-normalized (reverse path-reversed-normalized)))
1624 (concat "/" (string-join path-normalized "/") (and is-directory "/"))
1627 (defun elpher-address-from-gemini-url (url)
1628 "Extract address from URL with defaults as per gemini map files.
1629 While there's obviously some redundancy here between this function and
1630 `elpher-address-from-url', gemini map file URLs require enough special
1631 treatment that a separate function is warranted."
1632 (let ((address (url-generic-parse-url url))
1633 (current-address (elpher-page-address elpher-current-page)))
1634 (unless (and (url-type address) (not (url-fullness address))) ;avoid mangling mailto: urls
1635 (if (url-host address) ;if there is an explicit host, filenames are absolute
1636 (if (string-empty-p (url-filename address))
1637 (setf (url-filename address) "/")) ;ensure empty filename is marked as absolute
1638 (setf (url-host address) (url-host current-address))
1639 (setf (url-fullness address) (url-host address)) ;set fullness to t if host is set
1640 (setf (url-portspec address) (url-portspec current-address)) ;(url-port) too slow!
1642 ((string-prefix-p "/" (url-filename address))) ;do nothing for absolute case
1643 ((string-prefix-p "?" (url-filename address)) ;handle query-only links
1644 (setf (url-filename address)
1645 (concat (url-filename current-address)
1646 (url-filename address))))
1647 (t ;deal with relative links
1648 (setf (url-filename address)
1649 (concat (file-name-directory (url-filename current-address))
1650 (url-filename address))))))
1651 (when (url-host address)
1652 (setf (url-host address) (puny-encode-domain (url-host address))))
1653 (unless (url-type address)
1654 (setf (url-type address) (url-type current-address)))
1655 (when (equal (url-type address) "gemini")
1656 (setf (url-filename address)
1657 (elpher-collapse-dot-sequences (url-filename address)))))
1658 (elpher-remove-redundant-ports address)))
1660 (defun elpher-gemini-insert-link (link-line)
1661 "Insert link described by LINK-LINE into a text/gemini document."
1662 (let ((url (elpher-gemini-get-link-url link-line)))
1664 (let* ((given-display-string (elpher-gemini-get-link-display-string link-line))
1665 (address (elpher-address-from-gemini-url url))
1666 (type (if address (elpher-address-type address) nil))
1667 (type-map-entry (cdr (assoc type elpher-type-map)))
1668 (fill-prefix (make-string (+ 1 (length elpher-gemini-link-string)) ?\s)))
1669 (when type-map-entry
1670 (insert elpher-gemini-link-string)
1671 (let* ((face (elt type-map-entry 3))
1672 (display-string (or given-display-string
1673 (elpher-address-to-iri address)))
1674 (page (elpher-make-page display-string
1676 (insert-text-button display-string
1679 :type 'elpher-link))
1682 (defun elpher-gemini-insert-header (header-line)
1683 "Insert header described by HEADER-LINE into a text/gemini document.
1684 The gemini map file line describing the header is given
1686 (when (string-match "^\\(#+\\)[ \t]*" header-line)
1687 (let* ((level (length (match-string 1 header-line)))
1688 (header (substring header-line (match-end 0)))
1690 (1 'elpher-gemini-heading1)
1691 (2 'elpher-gemini-heading2)
1692 (3 'elpher-gemini-heading3)
1694 (fill-column (if (display-graphic-p)
1696 (font-get (font-spec :name (face-font 'default)) :size))
1697 (font-get (font-spec :name (face-font face)) :size)) fill-column)))
1698 (unless (display-graphic-p)
1699 (insert (make-string level ?#) " "))
1700 (insert (propertize header
1706 (defun elpher-gemini-insert-text (text-line)
1707 "Insert a plain non-preformatted TEXT-LINE into a text/gemini document.
1708 This function uses Emacs' auto-fill to wrap text sensibly to a maximum
1709 width defined by `elpher-gemini-max-fill-width'."
1713 (group (or (: "*" (+ (any " \t")))
1714 (: ">" (* (any " \t"))))))))
1716 (let* ((line-prefix (match-string 1 text-line))
1717 (processed-text-line
1719 (cond ((string-prefix-p "*" line-prefix)
1721 (replace-regexp-in-string "\\*"
1722 elpher-gemini-bullet-string
1723 (match-string 0 text-line))
1724 (substring text-line (match-end 0))))
1725 ((string-prefix-p ">" line-prefix)
1726 (propertize text-line 'face 'elpher-gemini-quoted))
1729 (fill-prefix (if line-prefix
1730 (make-string (length (match-string 0 text-line)) ?\s)
1732 (insert (elpher-process-text-for-display processed-text-line))
1735 (defun elpher-gemini-pref-expand-collapse (button)
1736 "Function called when the preformatted text toggle BUTTON is activated."
1737 (let ((id (button-get button 'pref-id)))
1738 (if (invisible-p id)
1739 (remove-from-invisibility-spec id)
1740 (add-to-invisibility-spec id))
1743 (defun elpher-gemini-insert-preformatted-toggler (alt-text)
1744 "Insert a button for toggling the visibility of preformatted text.
1745 If non-nil, ALT-TEXT is displayed alongside the button."
1746 (let* ((url-string (url-recreate-url (elpher-page-address elpher-current-page)))
1747 (pref-id (intern (concat "pref-"
1748 (number-to-string (point))
1751 (insert elpher-gemini-preformatted-toggle-bullet)
1753 (insert (propertize (concat alt-text " ")
1754 'face 'elpher-gemin-preformatted)))
1755 (insert-text-button elpher-gemini-preformatted-toggle-label
1756 'action #'elpher-gemini-pref-expand-collapse
1758 'face 'elpher-gemini-preformatted-toggle)
1759 (add-to-invisibility-spec pref-id)
1763 (defun elpher-gemini-insert-preformatted-line (line &optional pref-id)
1764 "Insert a LINE of preformatted text.
1765 PREF-ID is the value assigned to the \"invisible\" text attribute, which
1766 can be used to toggle the display of the preformatted text."
1767 (insert (propertize (concat (elpher-process-text-for-display
1768 (propertize line 'face 'elpher-gemini-preformatted))
1771 'rear-nonsticky t)))
1773 (defun elpher-render-gemini-map (data _parameters)
1774 "Render DATA as a gemini map file, PARAMETERS is currently unused."
1775 (elpher-with-clean-buffer
1777 (setq-local buffer-invisibility-spec nil)
1778 (let ((preformatted nil)
1779 (adaptive-fill-mode nil)) ;Prevent automatic setting of fill-prefix
1780 (setq-local fill-column (min (window-width) elpher-gemini-max-fill-width))
1781 (dolist (line (split-string data "\n"))
1783 ((rx (: string-start "```" (opt (let alt-text (+ any)))))
1787 (if elpher-gemini-hide-preformatted
1788 (elpher-gemini-insert-preformatted-toggler alt-text)
1790 ((guard preformatted)
1791 (elpher-gemini-insert-preformatted-line line preformatted))
1792 ((pred (string-prefix-p "=>"))
1793 (elpher-gemini-insert-link line))
1794 ((pred (string-prefix-p "#"))
1795 (elpher-gemini-insert-header line))
1796 (_ (elpher-gemini-insert-text line))))
1797 (elpher-cache-content
1798 (elpher-page-address elpher-current-page)
1801 (defun elpher-render-gemini-plain-text (data _parameters)
1802 "Render DATA as plain text file. PARAMETERS is currently unused."
1803 (elpher-with-clean-buffer
1804 (insert (elpher-process-text-for-display data))
1805 (elpher-cache-content
1806 (elpher-page-address elpher-current-page)
1809 (defun elpher-build-current-imenu-index ()
1810 "Build imenu index for current elpher buffer."
1812 (goto-char (point-min))
1815 (while (setq match (text-property-search-forward 'gemini-heading t t))
1817 (buffer-substring-no-properties (prop-match-beginning match)
1818 (prop-match-end match))
1819 (prop-match-beginning match))
1821 (reverse headers))))
1824 ;;; Finger page connection
1827 (defun elpher-get-finger-page (renderer)
1828 "Opens a finger connection to the current page address.
1829 The result is rendered using RENDERER."
1830 (let* ((address (elpher-page-address elpher-current-page))
1831 (content (elpher-get-cached-content address)))
1832 (if (and content (funcall renderer nil))
1833 (elpher-with-clean-buffer
1835 (elpher-restore-pos))
1836 (elpher-with-clean-buffer
1837 (insert "LOADING... (use 'u' to cancel)\n"))
1838 (condition-case the-error
1839 (let* ((kill-buffer-query-functions nil)
1840 (user (let ((filename (elpher-address-filename address)))
1841 (if (> (length filename) 1)
1842 (substring filename 1)
1843 (elpher-address-user address)))))
1844 (elpher-get-host-response address 79
1845 (concat user "\r\n")
1848 (elpher-network-error address the-error))))))
1851 ;;; Telnet page connection
1854 (defun elpher-get-telnet-page (renderer)
1855 "Opens a telnet connection to the current page address (RENDERER must be nil)."
1857 (elpher-visit-previous-page)
1858 (error "Command not supported for telnet URLs"))
1859 (let* ((address (elpher-page-address elpher-current-page))
1860 (host (elpher-address-host address))
1861 (port (elpher-address-port address)))
1862 (elpher-visit-previous-page)
1868 ;;; Other URL page opening
1871 (defun elpher-get-other-url-page (renderer)
1872 "Getter which attempts to open the URL specified by the current page.
1873 The RENDERER argument to this getter must be nil."
1875 (elpher-visit-previous-page)
1876 (error "Command not supported for general URLs"))
1877 (let* ((address (elpher-page-address elpher-current-page))
1878 (url (elpher-address-to-url address)))
1879 (elpher-visit-previous-page) ; Do first in case of non-local exits.
1880 (message "Opening URL...")
1881 (if elpher-open-urls-with-eww
1889 (defun elpher-get-file-page (renderer)
1890 "Getter which renders a local file using RENDERER.
1891 Assumes UTF-8 encoding for all text files."
1892 (let* ((address (elpher-page-address elpher-current-page))
1893 (filename (elpher-address-filename address)))
1894 (unless (file-exists-p filename)
1895 (elpher-visit-previous-page)
1896 (error "File not found"))
1897 (unless (file-readable-p filename)
1898 (elpher-visit-previous-page)
1899 (error "Could not read from file"))
1900 (let ((body (with-temp-buffer
1901 (let ((coding-system-for-read 'binary)
1902 (coding-system-for-write 'binary))
1903 (insert-file-contents-literally filename)
1904 (encode-coding-string (buffer-string) 'raw-text)))))
1906 (funcall renderer body nil)
1907 (pcase (file-name-extension filename)
1908 ((or "gmi" "gemini")
1909 (elpher-render-gemini-map (decode-coding-string body 'utf-8) nil))
1911 (elpher-render-html (decode-coding-string body 'utf-8)))
1913 (elpher-render-text (decode-coding-string body 'utf-8)))
1914 ((or "jpg" "jpeg" "gif" "png" "bmp" "tif" "tiff")
1915 (elpher-render-image body))
1916 ((or "gopher" "gophermap")
1917 (elpher-render-index (elpher-decode body)))
1919 (elpher-render-download body))))
1920 (elpher-restore-pos))))
1923 ;;; Welcome page retrieval
1926 (defun elpher-get-welcome-page (renderer)
1927 "Getter which displays the welcome page (RENDERER must be nil)."
1929 (elpher-visit-previous-page)
1930 (error "Command not supported for welcome page"))
1931 (elpher-with-clean-buffer
1932 (insert " --------------------------------------------\n"
1933 " Elpher Gopher and Gemini Client \n"
1934 " version " elpher-version "\n"
1935 " --------------------------------------------\n"
1937 "Default bindings:\n"
1939 " - TAB/Shift-TAB: next/prev item on current page\n"
1940 " - RET/mouse-1: open item under cursor (with Shift to open in new buffer)\n"
1941 " - m: select an item on current page by name (autocompletes)\n"
1942 " - u/mouse-3/U: return to previous page or to the start page\n"
1943 " - g: go to a particular address (gopher, gemini, finger)\n"
1944 " - o/O: open a different address selector or the root menu of the current server\n"
1945 " - d/D: download item under cursor or current page\n"
1946 " - i/I: info on item under cursor or current page\n"
1947 " - c/C: copy URL representation of item under cursor or current page\n"
1948 " - a/A: bookmark the item under cursor or current page\n"
1949 " - B: list all bookmarks\n"
1950 " - s/S: show current history stack or all previously visted pages\n"
1951 " - r: redraw current page (using cached contents if available)\n"
1952 " - R: reload current page (regenerates cache)\n"
1953 " - !: set character coding system for gopher (default is to autodetect)\n"
1954 " - T: toggle TLS gopher mode\n"
1955 " - F: forget/discard current TLS client certificate\n"
1956 " - .: display the raw server response for the current page\n"
1958 "Start your exploration of gopher space and gemini:\n")
1959 (elpher-insert-index-record "Floodgap Systems Gopher Server"
1960 (elpher-make-gopher-address ?1 "" "gopher.floodgap.com" 70))
1961 (elpher-insert-index-record "Project Gemini home page"
1962 (elpher-address-from-url "gemini://geminiprotocol.net/"))
1964 "Alternatively, select a search engine and enter some search terms:\n")
1965 (elpher-insert-index-record "Gopher Search Engine (Veronica-2)"
1966 (elpher-make-gopher-address ?7 "/v2/vs" "gopher.floodgap.com" 70))
1967 (elpher-insert-index-record "Gemini Search Engine (auragem.letz.dev)"
1968 (elpher-address-from-url "gemini://auragem.letz.dev/search/s"))
1970 "Your bookmarks are stored in your ")
1971 (insert-text-button "bookmark list"
1974 (elpher-make-page "Elpher Bookmarks"
1975 (elpher-make-about-address 'bookmarks))
1979 "(Bookmarks from legacy elpher-bookmarks files will be automatically imported.)\n"
1982 "The gopher home of the Elpher project is here:\n")
1983 (elpher-insert-index-record "The Elpher Project Page"
1984 (elpher-make-gopher-address ?1
1988 (let ((help-string "RET,mouse-1: Open Elpher info manual (if available)"))
1990 "The following info documentation is available:\n"
1992 (insert-text-button "Elpher Manual"
1998 'help-echo help-string)
2000 (insert-text-button "Changes introduced by the latest release"
2004 (info "(elpher)News"))
2006 'help-echo help-string))
2009 (concat "(These documents should be available if you have installed Elpher\n"
2010 " from MELPA or non-GNU ELPA. Otherwise you may have to install the\n"
2011 " manual yourself.)\n")
2013 (elpher-restore-pos)))
2016 ;;; History page retrieval
2019 (defun elpher-show-history ()
2020 "Show the current contents of elpher's history stack.
2021 Use \\[elpher-show-visited-pages] to see the entire history.
2022 This is rendered using `elpher-get-history-page' via `elpher-type-map'."
2025 (elpher-make-page "Current History Stack"
2026 (elpher-make-about-address 'history))))
2028 (defun elpher-show-visited-pages ()
2029 "Show the all the pages you've visited using Elpher.
2030 Use \\[elpher-show-history] to see just the current history stack.
2031 This is rendered using `elpher-get-visited-pages-page' via `elpher-type-map'."
2034 (elpher-make-page "Elpher Visted Pages"
2035 (elpher-make-about-address 'visited-pages))))
2037 (defun elpher-get-history-page (renderer)
2038 "Getter which displays the history page (RENDERER must be nil)."
2040 (elpher-visit-previous-page)
2041 (error "Command not supported for history page"))
2042 (elpher-display-history-links elpher-history "Current history stack"))
2044 (defun elpher-get-visited-pages-page (renderer)
2045 "Getter which displays the list of visited pages (RENDERER must be nil)."
2047 (elpher-visit-previous-page)
2048 (error "Command not supported for history page"))
2049 (elpher-display-history-links
2050 (seq-filter (lambda (page)
2051 (not (elpher-address-about-p (elpher-page-address page))))
2052 elpher-visited-pages)
2053 "All visited pages"))
2055 (defun elpher-display-history-links (pages title)
2056 "Show all PAGES in an Elpher buffer with a given TITLE."
2057 (let* ((title-line (concat " ---- " title " ----"))
2058 (footer-line (make-string (length title-line) ?-)))
2059 (elpher-with-clean-buffer
2060 (insert title-line "\n\n")
2062 (dolist (page pages)
2064 (let ((display-string (elpher-page-display-string page))
2065 (address (elpher-page-address page)))
2066 (elpher-insert-index-record display-string address))))
2067 (insert "No history items found.\n"))
2068 (insert "\n " footer-line "\n"
2069 "Select an entry or press 'u' to return to the previous page.")
2070 (elpher-restore-pos))))
2076 ;; This code allows Elpher to use the standard Emacs bookmarks: `C-x r
2077 ;; m' to add a bookmark, `C-x r l' to list bookmarks (which is where
2078 ;; you can anotate bookmarks!), `C-x r b' to jump to a bookmark, and
2079 ;; so on. See the Bookmarks section in the Emacs info manual for more.
2081 (defvar elpher-bookmark-link nil
2082 "Prefer bookmarking a link or the current page.
2083 Bind this variable dynamically, or set it to t.
2084 If you set it to t, the commands \\[bookmark-set-no-overwrite]
2085 and \\[elpher-set-bookmark-no-overwrite] do the same thing.")
2087 (defun elpher-bookmark-make-record ()
2088 "Return a bookmark record.
2089 If `elpher-bookmark-link' is non-nil and point is on a link button,
2090 return a bookmark record for that link. Otherwise, return a bookmark
2091 record for the current elpher page."
2092 (let* ((button (and elpher-bookmark-link (button-at (point))))
2094 (button-get button 'elpher-page)
2095 elpher-current-page)))
2097 (error "Cannot bookmark this link"))
2098 (let* ((address (elpher-page-address page))
2099 (url (elpher-address-to-url address))
2100 (display-string (elpher-page-display-string page))
2101 (pos (if button nil (point))))
2102 (if (elpher-address-about-p address)
2103 (error "Cannot bookmark %s" display-string)
2105 (defaults . (,display-string))
2108 (handler . elpher-bookmark-jump))))))
2111 (defun elpher-bookmark-jump (bookmark)
2112 "Handler used to open a bookmark using elpher.
2113 The argument BOOKMARK is a bookmark record passed to the function.
2114 This handler is responsible for loading the bookmark in some buffer,
2115 then making that buffer the current buffer. It should not switch
2117 (let* ((url (cdr (assq 'location bookmark)))
2118 (cleaned-url (string-trim url))
2119 (page (elpher-page-from-url cleaned-url))
2120 (buffer (get-buffer-create elpher-buffer-name)))
2121 (elpher-with-clean-buffer
2122 (elpher-visit-page page))
2126 (defun elpher-bookmark-link ()
2127 "Bookmark the link at point.
2128 To bookmark the current page, use \\[elpher-bookmark-current]."
2130 (let ((elpher-bookmark-link t))
2131 (bookmark-set-no-overwrite)))
2133 (defun elpher-bookmark-current ()
2134 "Bookmark the current page.
2135 To bookmark the link at point use \\[elpher-bookmark-link]."
2137 (call-interactively #'bookmark-set-no-overwrite))
2139 (defun elpher-bookmark-import (file)
2140 "Import legacy Elpher bookmarks file FILE into Emacs bookmarks."
2141 (interactive (list (if (and (boundp 'elpher-bookmarks-file)
2142 (file-readable-p elpher-bookmarks-file))
2143 elpher-bookmarks-file
2144 (read-file-name "Old Elpher bookmarks: "
2145 user-emacs-directory nil t
2146 "elpher-bookmarks"))))
2147 (dolist (bookmark (with-temp-buffer
2148 (insert-file-contents file)
2149 (read (current-buffer))))
2150 (let* ((display-string (car bookmark))
2151 (url (cadr bookmark))
2152 (record `(,display-string
2154 (handler . elpher-bookmark-jump))))
2155 (bookmark-store display-string (cdr record) t)))
2158 (defun elpher-get-bookmarks-page (renderer)
2159 "Getter which displays the bookmarks (RENDERER must be nil)."
2161 (elpher-visit-previous-page)
2162 (error "Command not supported for bookmarks page"))
2164 (let ((old-bookmarks-file (or (and (boundp 'elpher-bookmarks-file)
2165 elpher-bookmarks-file)
2166 (locate-user-emacs-file "elpher-bookmarks"))))
2167 (when (and (file-readable-p old-bookmarks-file)
2168 (y-or-n-p (concat "Legacy elpher-bookmarks file \""
2170 "\" found. Import now?")))
2171 (elpher-bookmark-import old-bookmarks-file)
2172 (rename-file old-bookmarks-file (concat old-bookmarks-file "-legacy"))))
2174 (if (and elpher-use-emacs-bookmark-menu
2177 (elpher-visit-previous-page)
2178 (call-interactively #'bookmark-bmenu-list))
2179 (elpher-with-clean-buffer
2180 (insert " ---- Elpher Bookmarks ---- \n\n")
2181 (bookmark-maybe-load-default-file)
2182 (dolist (bookmark (bookmark-maybe-sort-alist))
2183 (when (eq #'elpher-bookmark-jump (alist-get 'handler (cdr bookmark)))
2184 (let* ((name (car bookmark))
2185 (url (alist-get 'location (cdr bookmark)))
2186 (address (elpher-address-from-url url)))
2187 (elpher-insert-index-record name address))))
2188 (when (<= (line-number-at-pos) 3)
2189 (insert "No bookmarked pages found.\n"))
2190 (insert "\n --------------------------\n\n"
2191 "Select an entry or press 'u' to return to the previous page.\n\n"
2192 "Bookmarks can be renamed or deleted via the ")
2193 (insert-text-button "Emacs bookmark menu"
2196 (call-interactively #'bookmark-bmenu-list))
2198 'help-echo "RET,mouse-1: open Emacs bookmark menu")
2199 (insert (substitute-command-keys
2200 ",\nwhich can also be opened from anywhere using '\\[bookmark-bmenu-list]'."))
2201 (elpher-restore-pos))))
2203 (defun elpher-show-bookmarks ()
2204 "Interactive function to display the current list of elpher bookmarks."
2207 (elpher-make-page "Elpher Bookmarks"
2208 (elpher-make-about-address 'bookmarks))))
2216 (defun elpher-org-export-link (link description format protocol)
2217 "Export a LINK with DESCRIPTION for the given PROTOCOL and FORMAT.
2219 FORMAT is an Org export backend. DESCRIPTION may be nil. PROTOCOL may be one
2220 of gemini, gopher or finger."
2221 (let* ((url (if (equal protocol "elpher")
2222 (string-remove-prefix "elpher:" link)
2223 (format "%s:%s" protocol link)))
2224 (desc (or description url)))
2226 (`gemini (format "=> %s %s" url desc))
2227 (`html (format "<a href=\"%s\">%s</a>" url desc))
2228 (`latex (format "\\href{%s}{%s}" url desc))
2229 (_ (if (not description)
2231 (format "%s (%s)" desc url))))))
2233 (defun elpher-org-store-link ()
2234 "Store link to an `elpher' page in Org."
2235 (when (eq major-mode 'elpher-mode)
2236 (let* ((url (elpher-info-current))
2237 (desc (car elpher-current-page))
2239 ((string-prefix-p "gemini:" url) "gemini")
2240 ((string-prefix-p "gopher:" url) "gopher")
2241 ((string-prefix-p "finger:" url) "finger")
2243 (when (equal "elpher" protocol)
2244 ;; Weird link. Or special inner link?
2245 (setq url (concat "elpher:" url)))
2246 (org-link-store-props :type protocol :link url :description desc)
2249 (defun elpher-org-follow-link (link protocol)
2250 "Visit a LINK for the given PROTOCOL.
2252 PROTOCOL may be one of gemini, gopher or finger. This method also
2253 supports the old protocol elpher, where the link is self-contained."
2254 (let ((url (if (equal protocol "elpher")
2255 (string-remove-prefix "elpher:" link)
2256 (format "%s:%s" protocol link))))
2259 (defun elpher-org-mode-integration ()
2260 "Set up `elpher' integration for `org-mode'."
2261 (org-link-set-parameters
2263 :store #'elpher-org-store-link
2264 :export (lambda (link description format _plist)
2265 (elpher-org-export-link link description format "elpher"))
2266 :follow (lambda (link _arg) (elpher-org-follow-link link "elpher")))
2267 (org-link-set-parameters
2269 :export (lambda (link description format _plist)
2270 (elpher-org-export-link link description format "gemini"))
2271 :follow (lambda (link _arg) (elpher-org-follow-link link "gemini")))
2272 (org-link-set-parameters
2274 :export (lambda (link description format _plist)
2275 (elpher-org-export-link link description format "gopher"))
2276 :follow (lambda (link _arg) (elpher-org-follow-link link "gopher")))
2277 (org-link-set-parameters
2279 :export (lambda (link description format _plist)
2280 (elpher-org-export-link link description format "gophers"))
2281 :follow (lambda (link _arg) (elpher-org-follow-link link "gophers")))
2282 (org-link-set-parameters
2284 :export (lambda (link description format _plist)
2285 (elpher-org-export-link link description format "finger"))
2286 :follow (lambda (link _arg) (elpher-org-follow-link link "finger"))))
2288 (add-hook 'org-mode-hook #'elpher-org-mode-integration)
2293 (defun elpher-browse-url-elpher (url &rest _args)
2294 "Browse URL using Elpher. This function is used by `browse-url'."
2295 (interactive (browse-url-interactive-arg "Elpher URL: "))
2298 ;; Use elpher to open gopher, finger and gemini links
2299 ;; For recent version of `browse-url' package
2300 (if (boundp 'browse-url-default-handlers)
2302 'browse-url-default-handlers
2303 '("^\\(gopher\\|gophers\\|finger\\|gemini\\)://" . elpher-browse-url-elpher))
2304 ;; Patch `browse-url-browser-function' for older ones. The value of
2305 ;; that variable is `browse-url-default-browser' by default, so
2306 ;; that's the function that gets advised. If the value is an alist,
2307 ;; however, we don't know what to do. Better not interfere?
2308 (when (and (symbolp browse-url-browser-function)
2309 (fboundp browse-url-browser-function))
2310 (advice-add browse-url-browser-function :before-while
2311 (lambda (url &rest _args)
2312 "Handle gemini, gopher, and finger schemes using Elpher."
2313 (let ((scheme (downcase (car (split-string url ":" t)))))
2314 (if (member scheme '("gemini" "gopher" "gophers" "finger"))
2315 ;; `elpher-go' always returns nil, which will stop the
2316 ;; advice chain here in a before-while
2318 ;; chain must continue, then return t.
2321 ;; Register "gemini://" as a URI scheme so `browse-url' does the right thing
2322 (with-eval-after-load 'thingatpt
2323 (add-to-list 'thing-at-point-uri-schemes "gemini://"))
2327 ;; Make mu4e aware of the gemini world
2328 (setq mu4e~view-beginning-of-url-regexp
2329 "\\(?:https?\\|gopher\\|gophers\\|finger\\|gemini\\)://\\|mailto:")
2333 ;; Let elpher handle gemini, gopher links in eww buffer.
2334 (setq eww-use-browse-url
2335 "\\`mailto:\\|\\(\\`gemini\\|\\`gopher\\|\\`gophers\\|\\`finger\\)://")
2338 ;;; Interactive procedures
2341 (defun elpher-next-link ()
2342 "Move point to the next link on the current page."
2346 (defun elpher-prev-link ()
2347 "Move point to the previous link on the current page."
2349 (backward-button 1))
2351 (defun elpher-follow-current-link ()
2352 "Open the link or url at point."
2354 (elpher--click-link (button-at (point))))
2356 (defun elpher-follow-current-link-new-buffer ()
2357 "Open the link or url at point."
2359 (elpher--open-link-new-buffer))
2362 (defun elpher-go (host-or-url)
2363 "Go to a particular gopher site HOST-OR-URL.
2364 When run interactively HOST-OR-URL is read from the minibuffer."
2366 (read-string (format "Visit URL (default scheme %s): "
2367 (elpher-get-default-url-scheme)))))
2368 (let ((trimmed-host-or-url (string-trim host-or-url)))
2369 (unless (string-empty-p trimmed-host-or-url)
2370 (let ((page (elpher-page-from-url trimmed-host-or-url
2371 (elpher-get-default-url-scheme))))
2372 (unless (get-buffer-window elpher-buffer-name t)
2373 (switch-to-buffer elpher-buffer-name))
2374 (elpher-with-clean-buffer
2375 (elpher-visit-page page))
2376 nil)))) ; non-nil value is displayed by eshell
2378 (defun elpher-go-current ()
2379 "Go to a particular URL which is read from the minibuffer.
2380 Unlike `elpher-go', the reader is initialized with the URL of the
2383 (let* ((address (elpher-page-address elpher-current-page))
2384 (url (read-string (format "Visit URL (default scheme %s): "
2385 (elpher-get-default-url-scheme))
2386 (elpher-address-to-url address))))
2387 (let ((trimmed-url (string-trim url)))
2388 (unless (string-empty-p trimmed-url)
2389 (elpher-with-clean-buffer
2391 (elpher-page-from-url trimmed-url (elpher-get-default-url-scheme))))))))
2393 (defun elpher-redraw ()
2394 "Redraw current page."
2396 (elpher-visit-page elpher-current-page))
2398 (defun elpher-reload ()
2399 "Reload current page."
2401 (elpher-reload-current-page))
2403 (defun elpher-toggle-tls ()
2404 "Toggle TLS encryption mode for gopher."
2406 (setq elpher-use-tls (not elpher-use-tls))
2408 (if (gnutls-available-p)
2409 (message "TLS gopher mode enabled. (Will not affect current page until reload.)")
2410 (setq elpher-use-tls nil)
2411 (error "Cannot enable TLS gopher mode: GnuTLS not available"))
2412 (message "TLS gopher mode disabled. (Will not affect current page until reload.)")))
2414 (defun elpher-view-raw ()
2415 "View raw server response for current page."
2417 (if (elpher-address-about-p (elpher-page-address elpher-current-page))
2418 (error "This page was not generated by a server")
2419 (elpher-visit-page elpher-current-page
2420 #'elpher-render-raw)))
2422 (defun elpher-back ()
2423 "Go to previous site."
2425 (elpher-visit-previous-page))
2427 (defun elpher-back-to-start ()
2428 "Go all the way back to the start page."
2430 (setq-local elpher-current-page nil)
2431 (setq-local elpher-history nil)
2432 (elpher-visit-page (elpher-make-start-page)))
2434 (defun elpher-download ()
2435 "Download the link at point."
2437 (let ((button (button-at (point))))
2439 (let ((page (button-get button 'elpher-page)))
2441 (error "Not an elpher page"))
2442 (when (elpher-address-about-p (elpher-page-address page))
2443 (error "Cannot download %s" (elpher-page-display-string page)))
2444 (elpher-visit-page (button-get button 'elpher-page)
2445 #'elpher-render-download))
2446 (error "No link selected"))))
2448 (defun elpher-download-current ()
2449 "Download the current page."
2451 (if (elpher-address-about-p (elpher-page-address elpher-current-page))
2452 (error "Cannot download %s"
2453 (elpher-page-display-string elpher-current-page))
2454 (elpher-visit-page elpher-current-page
2455 #'elpher-render-download
2458 (defun elpher--build-link-map ()
2459 "Build alist mapping link names to destination pages in current buffer."
2460 (let ((link-map nil)
2461 (b (next-button (point-min) t)))
2463 (push (cons (button-label b) b) link-map)
2464 (setq b (next-button (button-start b))))
2467 (defun elpher-jump ()
2468 "Select a directory entry by name. Similar to the info browser (m)enu command."
2470 (let* ((link-map (elpher--build-link-map)))
2472 (let ((key (let ((completion-ignore-case t))
2473 (completing-read "Directory item/link: "
2475 (if (and key (> (length key) 0))
2476 (let ((b (cdr (assoc key link-map))))
2477 (goto-char (button-start b))
2478 (button-activate b)))))))
2480 (defun elpher-root-dir ()
2481 "Visit root of current server."
2483 (let ((address (elpher-page-address elpher-current-page)))
2484 (if (not (elpher-address-about-p address))
2485 (if (or (member (url-filename address) '("/" ""))
2486 (and (elpher-address-gopher-p address)
2487 (= (length (elpher-gopher-address-selector address)) 0)))
2488 (error "Already at root directory of current server")
2489 (let ((address-copy (elpher-address-from-url
2490 (elpher-address-to-url address))))
2491 (setf (url-filename address-copy) "")
2492 (elpher-go (elpher-address-to-url address-copy))))
2493 (error "Command invalid for %s" (elpher-page-display-string elpher-current-page)))))
2495 (defun elpher-info-page (page)
2496 "Display URL of PAGE in minibuffer."
2497 (let* ((address (elpher-page-address page))
2498 (url (elpher-address-to-url address))
2499 (iri (elpher-address-to-iri address)))
2502 (message "%s (Raw: %s)" iri url))))
2504 (defun elpher-info-link ()
2505 "Display information on page corresponding to link at point."
2507 (let ((button (button-at (point))))
2509 (error "No item selected"))
2510 (let ((page (button-get button 'elpher-page)))
2512 (error "Not an elpher page"))
2513 (elpher-info-page page))))
2515 (defun elpher-info-current ()
2516 "Display information on current page."
2518 (elpher-info-page elpher-current-page))
2520 (defun elpher-copy-page-url (page)
2521 "Copy URL representation of address of PAGE to `kill-ring'."
2522 (let* ((address (elpher-page-address page))
2523 (url (elpher-address-to-url address)))
2524 (message "Copied \"%s\" to kill-ring/clipboard." url)
2527 (defun elpher-copy-link-url ()
2528 "Copy URL of item at point to `kill-ring'."
2530 (let ((button (button-at (point))))
2532 (error "No item selected"))
2533 (let ((page (button-get button 'elpher-page)))
2535 (error "Not an elpher page"))
2536 (elpher-copy-page-url page))))
2538 (defun elpher-copy-current-url ()
2539 "Copy URL of current page to `kill-ring'."
2541 (elpher-copy-page-url elpher-current-page))
2543 (defun elpher-set-gopher-coding-system ()
2544 "Specify an explicit character coding system for gopher selectors."
2546 (let ((system (read-coding-system "Set coding system to use for gopher (default is to autodetect): " nil)))
2547 (setq elpher-user-coding-system system)
2549 (message "Gopher coding system fixed to %s. (Reload to see effect)." system)
2550 (message "Gopher coding system set to autodetect. (Reload to see effect)."))))
2556 (defvar elpher-mode-map
2557 (let ((map (make-sparse-keymap)))
2558 (define-key map (kbd "TAB") 'elpher-next-link)
2559 (define-key map (kbd "<backtab>") 'elpher-prev-link)
2560 (define-key map (kbd "C-M-i") 'elpher-prev-link)
2561 (define-key map (kbd "u") 'elpher-back)
2562 (define-key map (kbd "-") 'elpher-back)
2563 (define-key map (kbd "^") 'elpher-back)
2564 (define-key map [mouse-3] 'elpher-back)
2565 (define-key map (kbd "U") 'elpher-back-to-start)
2566 (define-key map (kbd "g") 'elpher-go)
2567 (define-key map (kbd "o") 'elpher-go-current)
2568 (define-key map (kbd "O") 'elpher-root-dir)
2569 (define-key map (kbd "s") 'elpher-show-history)
2570 (define-key map (kbd "S") 'elpher-show-visited-pages)
2571 (define-key map (kbd "r") 'elpher-redraw)
2572 (define-key map (kbd "R") 'elpher-reload)
2573 (define-key map (kbd "T") 'elpher-toggle-tls)
2574 (define-key map (kbd ".") 'elpher-view-raw)
2575 (define-key map (kbd "d") 'elpher-download)
2576 (define-key map (kbd "D") 'elpher-download-current)
2577 (define-key map (kbd "m") 'elpher-jump)
2578 (define-key map (kbd "i") 'elpher-info-link)
2579 (define-key map (kbd "I") 'elpher-info-current)
2580 (define-key map (kbd "c") 'elpher-copy-link-url)
2581 (define-key map (kbd "C") 'elpher-copy-current-url)
2582 (define-key map (kbd "a") 'elpher-bookmark-link)
2583 (define-key map (kbd "A") 'elpher-bookmark-current)
2584 (define-key map (kbd "B") 'elpher-show-bookmarks)
2585 (define-key map (kbd "!") 'elpher-set-gopher-coding-system)
2586 (define-key map (kbd "F") 'elpher-forget-current-certificate)
2587 (when (fboundp 'evil-define-key*)
2590 (kbd "TAB") 'elpher-next-link
2591 (kbd "C-t") 'elpher-back
2592 (kbd "u") 'elpher-back
2593 (kbd "-") 'elpher-back
2594 (kbd "^") 'elpher-back
2595 [mouse-3] 'elpher-back
2596 (kbd "U") 'elpher-back-to-start
2597 (kbd "g") 'elpher-go
2598 (kbd "o") 'elpher-go-current
2599 (kbd "O") 'elpher-root-dir
2600 (kbd "s") 'elpher-show-history
2601 (kbd "S") 'elpher-show-visited-pages
2602 (kbd "r") 'elpher-redraw
2603 (kbd "R") 'elpher-reload
2604 (kbd "T") 'elpher-toggle-tls
2605 (kbd ".") 'elpher-view-raw
2606 (kbd "d") 'elpher-download
2607 (kbd "D") 'elpher-download-current
2608 (kbd "m") 'elpher-jump
2609 (kbd "i") 'elpher-info-link
2610 (kbd "I") 'elpher-info-current
2611 (kbd "c") 'elpher-copy-link-url
2612 (kbd "C") 'elpher-copy-current-url
2613 (kbd "a") 'elpher-bookmark-link
2614 (kbd "A") 'elpher-bookmark-current
2615 (kbd "B") 'elpher-show-bookmarks
2616 (kbd "!") 'elpher-set-gopher-coding-system
2617 (kbd "F") 'elpher-forget-current-certificate))
2619 "Keymap for gopher client.")
2621 (define-derived-mode elpher-mode special-mode "elpher"
2622 "Major mode for elpher, an elisp gopher client.
2624 This mode is automatically enabled by the interactive
2625 functions which initialize the client, namely
2626 `elpher', and `elpher-go'."
2627 (setq-local elpher-current-page nil)
2628 (setq-local elpher-history nil)
2629 (setq-local elpher-buffer-name (buffer-name))
2630 (setq-local bookmark-make-record-function #'elpher-bookmark-make-record)
2631 (setq-local imenu-create-index-function #'elpher-build-current-imenu-index))
2633 (when (fboundp 'evil-set-initial-state)
2634 (evil-set-initial-state 'elpher-mode 'motion))
2637 ;;; Main start procedure
2641 (defun elpher (&optional arg)
2642 "Start elpher with default landing page.
2643 The buffer used for Elpher sessions is determined by the value of
2644 ‘elpher-buffer-name’. If there is already an Elpher session active in
2645 that buffer, Emacs will simply switch to it. Otherwise, a new session
2646 will begin. A numeric prefix ARG (as in ‘\\[universal-argument] 42
2647 \\[execute-extended-command] elpher RET’) switches to the session with
2648 that number, creating it if necessary. A non numeric prefix ARG means
2649 to create a new session. Returns the buffer selected (or created)."
2651 (let* ((name (default-value 'elpher-buffer-name))
2652 (buf (cond ((numberp arg)
2653 (get-buffer-create (format "%s<%d>" name arg)))
2655 (generate-new-buffer name))
2657 (get-buffer-create name)))))
2658 (pop-to-buffer-same-window buf)
2659 (unless (buffer-modified-p)
2661 (elpher-visit-page (elpher-make-start-page))
2662 "Started Elpher."))); Otherwise (elpher) evaluates to start page string.
2664 ;;; elpher.el ends here