1 ;;; elpher.el --- A friendly gopher and gemini client -*- lexical-binding: t -*-
3 ;; Copyright (C) 2021 Jens Östlund <jostlund@gmail.com>
4 ;; Copyright (C) 2021 F. Jason Park <jp@neverwas.me>
5 ;; Copyright (C) 2021 Christopher Brannon <chris@the-brannons.com>
6 ;; Copyright (C) 2021 Omar Polo <op@omarpolo.com>
7 ;; Copyright (C) 2021 Noodles! <nnoodle@chiru.no>
8 ;; Copyright (C) 2021 Abhiseck Paira <abhiseckpaira@disroot.org>
9 ;; Copyright (C) 2020-2021 Alex Schroeder <alex@gnu.org>
10 ;; Copyright (C) 2020 Zhiwei Chen <chenzhiwei03@kuaishou.com>
11 ;; Copyright (C) 2020 condy0919 <condy0919@gmail.com>
12 ;; Copyright (C) 2020 Alexis <flexibeast@gmail.com>
13 ;; Copyright (C) 2020 Étienne Deparis <etienne@depar.is>
14 ;; Copyright (C) 2020 Simon Nicolussi <sinic@sinic.name>
15 ;; Copyright (C) 2020 Michel Alexandre Salim <michel@michel-slm.name>
16 ;; Copyright (C) 2020 Koushk Roy <kroy@twilio.com>
17 ;; Copyright (C) 2020 Vee <vee@vnsf.xyz>
18 ;; Copyright (C) 2020 Simon South <simon@simonsouth.net>
19 ;; Copyright (C) 2019-2021 Tim Vaughan <plugd@thelambdalab.xyz>
21 ;; Author: Tim Vaughan <plugd@thelambdalab.xyz>
22 ;; Created: 11 April 2019
24 ;; Keywords: comm gopher
25 ;; Homepage: https://thelambdalab.xyz/elpher
26 ;; Package-Requires: ((emacs "27.1"))
28 ;; This file is not part of GNU Emacs.
30 ;; This program is free software: you can redistribute it and/or modify
31 ;; it under the terms of the GNU General Public License as published by
32 ;; the Free Software Foundation, either version 3 of the License, or
33 ;; (at your option) any later version.
35 ;; This program is distributed in the hope that it will be useful,
36 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
37 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
38 ;; GNU General Public License for more details.
40 ;; You should have received a copy of the GNU General Public License
41 ;; along with this file. If not, see <http://www.gnu.org/licenses/>.
45 ;; Elpher aims to provide a practical and friendly gopher and gemini
46 ;; client for GNU Emacs. It supports:
48 ;; - intuitive keyboard and mouse-driven browsing,
49 ;; - out-of-the-box compatibility with evil-mode,
50 ;; - clickable web and gopher links *in plain text*,
51 ;; - caching of visited sites,
52 ;; - pleasant and configurable colouring of Gopher directories,
53 ;; - direct visualisation of image files,
54 ;; - gopher connections using TLS encryption,
55 ;; - the fledgling Gemini protocol,
56 ;; - the greybeard Finger protocol.
58 ;; To launch Elpher, simply use 'M-x elpher'. This will open a start
59 ;; page containing information on key bindings and suggested starting
60 ;; points for your gopher exploration.
62 ;; Full instructions can be found in the Elpher info manual.
64 ;; Elpher is under active development. Any suggestions for
65 ;; improvements are welcome, and can be made on the official project
66 ;; page, gopher://thelambdalab.xyz/1/projects/elpher, or via the
67 ;; project mailing list at https://lists.sr.ht/~michel-slm/elpher.
88 (defconst elpher-version "3.2.2"
89 "Current version of elpher.")
91 (defconst elpher-margin-width 6
92 "Width of left-hand margin used when rendering indicies.")
94 (defconst elpher-type-map
95 '(((gopher ?0) elpher-get-gopher-page elpher-render-text "txt" elpher-text)
96 ((gopher ?1) elpher-get-gopher-page elpher-render-index "/" elpher-index)
97 ((gopher ?4) elpher-get-gopher-page elpher-render-download "bin" elpher-binary)
98 ((gopher ?5) elpher-get-gopher-page elpher-render-download "bin" elpher-binary)
99 ((gopher ?7) elpher-get-gopher-query-page elpher-render-index "?" elpher-search)
100 ((gopher ?9) elpher-get-gopher-page elpher-render-download "bin" elpher-binary)
101 ((gopher ?g) elpher-get-gopher-page elpher-render-image "img" elpher-image)
102 ((gopher ?p) elpher-get-gopher-page elpher-render-image "img" elpher-image)
103 ((gopher ?I) elpher-get-gopher-page elpher-render-image "img" elpher-image)
104 ((gopher ?d) elpher-get-gopher-page elpher-render-download "doc" elpher-binary)
105 ((gopher ?P) elpher-get-gopher-page elpher-render-download "doc" elpher-binary)
106 ((gopher ?s) elpher-get-gopher-page elpher-render-download "snd" elpher-binary)
107 ((gopher ?h) elpher-get-gopher-page elpher-render-html "htm" elpher-html)
108 (gemini elpher-get-gemini-page elpher-render-gemini "gem" elpher-gemini)
109 (finger elpher-get-finger-page elpher-render-text "txt" elpher-text)
110 (telnet elpher-get-telnet-page nil "tel" elpher-telnet)
111 (other-url elpher-get-other-url-page nil "url" elpher-other-url)
112 (file elpher-get-file-page nil "~" elpher-gemini)
113 ((about welcome) elpher-get-welcome-page nil "E" elpher-index)
114 ((about bookmarks) elpher-get-bookmarks-page nil "E" elpher-index)
115 ((about history) elpher-get-history-page nil "E" elpher-index)
116 ((about visited-pages) elpher-get-visited-pages-page nil "E" elpher-index))
117 "Association list from types to getters, renderers, margin codes and index faces.")
120 ;;; Declarations to avoid compiler warnings.
124 (declare-function ansi-color-filter-apply "ansi-color")
125 (declare-function ansi-color-apply "ansi-color")
126 (declare-function bookmark-store "bookmark")
127 (declare-function org-link-store-props "ol")
128 (declare-function org-link-set-parameters "ol")
129 (defvar ansi-color-context)
130 (defvar bookmark-make-record-function)
131 (defvar mu4e~view-beginning-of-url-regexp)
132 (defvar eww-use-browse-url)
133 (defvar thing-at-point-uri-schemes)
134 (defvar xterm-color-preserve-properties))
137 ;;; Customization group
141 "A gopher and gemini client."
142 :group 'applications)
144 ;; General appearance and customizations
146 (defcustom elpher-open-urls-with-eww nil
147 "If non-nil, open URL selectors using eww.
148 Otherwise, use the system browser via the `browse-url' function."
151 (defcustom elpher-use-header t
152 "If non-nil, display current page information in buffer header."
155 (defcustom elpher-auto-disengage-TLS nil
156 "If non-nil, automatically disengage TLS following an unsuccessful connection.
157 While enabling this may seem convenient, it is also potentially
158 dangerous as it allows switching from an encrypted channel back to
159 plain text without user input."
162 (defcustom elpher-connection-timeout 5
163 "Specifies the number of seconds to wait for a network connection to time out."
166 (defcustom elpher-filter-ansi-from-text nil
167 "If non-nil, filter ANSI escape sequences from text.
168 The default behaviour is to use the ansi-color package to interpret these
172 (defcustom elpher-certificate-directory
173 (file-name-as-directory (locate-user-emacs-file "elpher-certificates"))
174 "Specify the name of the directory where client certificates will be stored.
175 These certificates may be used for establishing authenticated TLS connections."
178 (defcustom elpher-openssl-command "openssl"
179 "The command used to launch openssl when generating TLS client certificates."
182 (defcustom elpher-default-url-type "gopher"
183 "Default URL type (i.e. scheme) to assume if not explicitly given."
184 :type '(choice (const "gopher")
187 (defcustom elpher-gemini-TLS-cert-checks nil
188 "If non-nil, verify gemini server TLS certs using the default security level.
189 Otherwise, certificate verification is disabled.
191 This defaults to off because it is standard practice for Gemini servers
192 to use self-signed certificates, meaning that most servers provide what
193 EMACS considers to be an invalid certificate."
196 (defcustom elpher-gemini-max-fill-width 80
197 "Specify the maximum default width (in columns) of text/gemini documents.
198 The actual width used is the minimum of this value and the window width at
199 the time when the text is rendered."
202 (defcustom elpher-gemini-link-string "→ "
203 "Specify the string used to indicate links when rendering gemini maps.
207 (defcustom elpher-gemini-bullet-string "•"
208 "Specify the string used for bullets when rendering gemini maps."
211 (defcustom elpher-ipv4-always nil
212 "If non-nil, elpher will always use IPv4 to establish network connections.
213 This can be useful when browsing from a computer that supports IPv6, because
214 some servers which do not support IPv6 can take a long time to time-out."
217 (defcustom elpher-socks-always nil
218 "If non-nil, elpher will establish network connections over a SOCKS proxy.
219 Otherwise, the SOCKS proxy is only used for connections to onion services."
222 (defcustom elpher-use-emacs-bookmark-menu nil
223 "If non-nil, elpher will only use the native Emacs bookmark menu.
224 Otherwise, \\[elpher-show-bookmarks] will visit a special elpher bookmark
225 page within which all of the standard elpher keybindings are active."
228 (defcustom elpher-start-page-url "about:welcome"
229 "Specify the page displayed initially by elpher.
230 The default welcome screen is \"about:welcome\", while the bookmarks list
231 is \"about:bookmarks\". You can also specify local files via \"file:\".
233 Beware that using \"about:bookmarks\" as a start page in combination with
234 the `elpher-use-bookmark-menu' variable set to non-nil will prevent the
235 Emacs bookmark menu being accessible via \\[elpher-show-bookmarks] from
239 ;; Face customizations
241 (defgroup elpher-faces nil
242 "Elpher face customizations."
245 (defface elpher-index
246 '((t :inherit font-lock-keyword-face))
247 "Face used for directory type directory records.")
251 "Face used for text type directory records.")
254 '((t :inherit default))
255 "Face used for info type directory records.")
257 (defface elpher-image
258 '((t :inherit font-lock-string-face))
259 "Face used for image type directory records.")
261 (defface elpher-search
262 '((t :inherit warning))
263 "Face used for search type directory records.")
266 '((t :inherit font-lock-comment-face))
267 "Face used for html type directory records.")
269 (defface elpher-gemini
270 '((t :inherit font-lock-constant-face))
271 "Face used for Gemini type directory records.")
273 (defface elpher-other-url
274 '((t :inherit font-lock-comment-face))
275 "Face used for other URL type links records.")
277 (defface elpher-telnet
278 '((t :inherit font-lock-function-name-face))
279 "Face used for telnet type directory records.")
281 (defface elpher-binary
282 '((t :inherit font-lock-doc-face))
283 "Face used for binary type directory records.")
285 (defface elpher-unknown
286 '((t :inherit error))
287 "Face used for directory records with unknown/unsupported types.")
289 (defface elpher-margin-key
291 "Face used for directory margin key.")
293 (defface elpher-margin-brackets
294 '((t :inherit shadow))
295 "Face used for brackets around directory margin key.")
297 (defface elpher-gemini-heading1
298 '((t :inherit bold :height 1.8))
299 "Face used for gemini heading level 1.")
301 (defface elpher-gemini-heading2
302 '((t :inherit bold :height 1.5))
303 "Face used for gemini heading level 2.")
305 (defface elpher-gemini-heading3
306 '((t :inherit bold :height 1.2))
307 "Face used for gemini heading level 3.")
309 (defface elpher-gemini-preformatted
310 '((t :inherit fixed-pitch))
311 "Face used for pre-formatted gemini text blocks.")
313 (defface elpher-gemini-quoted
314 '((t :inherit font-lock-doc-face))
315 "Face used for gemini quoted texts.")
322 ;; An elpher "address" object is either a url object or a symbol.
323 ;; Addresses with the "about" type, corresponding to pages generated
324 ;; dynamically for and by elpher. All others represent pages which
325 ;; rely on content retrieved over the network.
327 (defun elpher-address-from-url (url-string)
328 "Create a ADDRESS object corresponding to the given URL-STRING."
329 (let ((data (match-data))) ; Prevent parsing clobbering match data
331 (let ((url (url-generic-parse-url url-string)))
332 (unless (and (not (url-fullness url)) (url-type url))
333 (setf (url-fullness url) t)
334 (unless (url-type url)
335 (setf (url-type url) elpher-default-url-type))
336 (unless (url-host url)
337 (let ((p (split-string (url-filename url) "/" nil nil)))
338 (setf (url-host url) (car p))
339 (setf (url-filename url)
341 (concat "/" (mapconcat #'identity (cdr p) "/"))
344 (setf (url-host url) (puny-encode-domain (url-host url))))
345 (when (or (equal "gopher" (url-type url))
346 (equal "gophers" (url-type url)))
348 (when (or (equal (url-filename url) "")
349 (equal (url-filename url) "/"))
350 (setf (url-filename url) "/1")))
351 (when (equal "gemini" (url-type url))
353 (if (equal (url-filename url) "")
354 (setf (url-filename url) "/"))))
355 (elpher-remove-redundant-ports url))
356 (set-match-data data))))
358 (defun elpher-remove-redundant-ports (address)
359 "Remove redundant port specifiers from ADDRESS.
360 Here 'redundant' means that the specified port matches the default
361 for that protocol, eg 70 for gopher."
362 (if (and (not (elpher-address-about-p address))
363 (eq (url-portspec address) ; (url-port) is too slow!
364 (pcase (url-type address)
366 ((or "gopher" "gophers") 70)
369 (setf (url-portspec address) nil))
372 (defun elpher-make-gopher-address (type selector host port &optional tls)
373 "Create an ADDRESS object using gopher directory record attributes.
374 The basic attributes include: TYPE, SELECTOR, HOST and PORT.
375 If the optional attribute TLS is non-nil, the address will be marked as
376 requiring gopher-over-TLS."
378 ((equal type ?i) nil)
379 ((and (equal type ?h)
380 (string-prefix-p "URL:" selector))
381 (elpher-address-from-url (elt (split-string selector "URL:") 1)))
383 (elpher-address-from-url
386 ":" (number-to-string port))))
388 (elpher-address-from-url
389 (concat "gopher" (if tls "s" "")
391 ":" (number-to-string port)
395 (defun elpher-make-about-address (type)
396 "Create an ADDRESS object corresponding to the given about address TYPE."
397 (elpher-address-from-url (concat "about:" (symbol-name type))))
399 (defun elpher-address-to-url (address)
400 "Get string representation of ADDRESS."
401 (url-encode-url (url-recreate-url address)))
403 (defun elpher-address-type (address)
404 "Retrieve type of ADDRESS object.
405 This is used to determine how to retrieve and render the document the
406 address refers to, via the table `elpher-type-map'."
407 (pcase (url-type address)
409 (list 'about (intern (url-filename address))))
410 ((or "gopher" "gophers")
412 (if (member (url-filename address) '("" "/"))
414 (string-to-char (substring (url-filename address) 1)))))
421 (defun elpher-address-about-p (address)
422 "Return non-nil if ADDRESS is an about address."
423 (pcase (elpher-address-type address) (`(about ,_) t)))
425 (defun elpher-address-gopher-p (address)
426 "Return non-nill if ADDRESS object is a gopher address."
427 (pcase (elpher-address-type address) (`(gopher ,_) t)))
429 (defun elpher-address-protocol (address)
430 "Retrieve the transport protocol for ADDRESS."
433 (defun elpher-address-filename (address)
434 "Retrieve the filename component of ADDRESS.
435 For gopher addresses this is a combination of the selector type and selector."
436 (url-unhex-string (url-filename address)))
438 (defun elpher-address-host (address)
439 "Retrieve host from ADDRESS object."
442 (defun elpher-address-user (address)
443 "Retrieve user from ADDRESS object."
446 (defun elpher-address-port (address)
447 "Retrieve port from ADDRESS object.
448 If no address is defined, returns 0. (This is for compatibility with the URL library.)"
451 (defun elpher-gopher-address-selector (address)
452 "Retrieve gopher selector from ADDRESS object."
453 (if (member (url-filename address) '("" "/"))
455 (url-unhex-string (substring (url-filename address) 2))))
460 (defvar elpher-content-cache (make-hash-table :test 'equal))
461 (defvar elpher-pos-cache (make-hash-table :test 'equal))
463 (defun elpher-get-cached-content (address)
464 "Retrieve the cached content for ADDRESS, or nil if none exists."
465 (gethash address elpher-content-cache))
467 (defun elpher-cache-content (address content)
468 "Set the content cache for ADDRESS to CONTENT."
469 (puthash address content elpher-content-cache))
471 (defun elpher-get-cached-pos (address)
472 "Retrieve the cached cursor position for ADDRESS, or nil if none exists."
473 (gethash address elpher-pos-cache))
475 (defun elpher-cache-pos (address pos)
476 "Set the cursor position cache for ADDRESS to POS."
477 (puthash address pos elpher-pos-cache))
482 (defun elpher-make-page (display-string address)
483 "Create a page with DISPLAY-STRING and ADDRESS."
484 (list display-string address))
486 (defun elpher-make-start-page ()
487 "Create the start page."
488 (elpher-make-page "Start Page"
489 (elpher-address-from-url elpher-start-page-url)))
491 (defun elpher-page-display-string (page)
492 "Retrieve the display string corresponding to PAGE."
495 (defun elpher-page-address (page)
496 "Retrieve the address corresponding to PAGE."
499 (defun elpher-page-set-address (page new-address)
500 "Set the address corresponding to PAGE to NEW-ADDRESS."
501 (setcar (cdr page) new-address))
503 (defun elpher-page-from-url (url)
504 "Create a page with address and display string defined by URL.
505 The URL is unhexed prior to its use as a display string to improve
507 (elpher-make-page (elpher-url-to-iri url)
508 (elpher-address-from-url url)))
510 (defun elpher-url-to-iri (url)
511 "Return an IRI for URL.
512 Decode percent-escapes and handle punycode in the domain name.
513 Drop the password, if any."
514 (let ((data (match-data))) ; Prevent parsing clobbering match data
516 (let* ((address (elpher-address-from-url (elpher-decode (url-unhex-string url))))
517 (host (url-host address))
518 (pass (url-password address)))
520 (setf (url-host address) (puny-decode-domain host)))
521 (when pass ; RFC 3986 says we should not render
522 (setf (url-password address) nil)) ; the password as clear text
523 (url-recreate-url address))
524 (set-match-data data))))
526 (defvar elpher-current-page nil
527 "The current page for this Elpher buffer.")
529 (defvar elpher-history nil
530 "The local history stack for this Elpher buffer.
531 This variable is used by `elpher-back' and
532 `elpher-show-history'.")
534 (defvar elpher-visited-pages nil
535 "The global history for all Elpher buffers.
536 This variable is used by `elpher-show-visited-pages'.")
538 (defun elpher-visit-page (page &optional renderer no-history)
539 "Visit PAGE using its own renderer or RENDERER, if non-nil.
540 Additionally, push PAGE onto the history stack and the list of
541 previously-visited pages,unless NO-HISTORY is non-nil."
543 (elpher-process-cleanup)
545 (unless (or (not elpher-current-page)
546 (equal (elpher-page-address elpher-current-page)
547 (elpher-page-address page)))
548 (push elpher-current-page elpher-history)
549 (unless (or (elpher-address-about-p (elpher-page-address page))
550 (and elpher-visited-pages
551 (equal page (car elpher-visited-pages))))
552 (push page elpher-visited-pages))))
553 (setq-local elpher-current-page page)
554 (let* ((address (elpher-page-address page))
555 (type (elpher-address-type address))
556 (type-record (cdr (assoc type elpher-type-map))))
558 (funcall (car type-record)
562 (elpher-visit-previous-page)
564 (`(gopher ,type-char)
565 (error "Unsupported gopher selector type '%c' for '%s'"
566 type-char (elpher-address-to-url address)))
568 (error "Unsupported address type '%S' for '%s'"
569 other (elpher-address-to-url address)))))))
571 (defun elpher-visit-previous-page ()
572 "Visit the previous page in the history."
574 (elpher-visit-page (pop elpher-history) nil t)
575 (error "No previous page")))
577 (defun elpher-reload-current-page ()
578 "Reload the current page, discarding any existing cached content."
579 (elpher-cache-content (elpher-page-address elpher-current-page) nil)
580 (elpher-visit-page elpher-current-page))
582 (defun elpher-save-pos ()
583 "Save the current position of point to the current page."
584 (when elpher-current-page
585 (elpher-cache-pos (elpher-page-address elpher-current-page) (point))))
587 (defun elpher-restore-pos ()
588 "Restore the position of point to that cached in the current page."
589 (let ((pos (elpher-get-cached-pos (elpher-page-address elpher-current-page))))
592 (goto-char (point-min)))))
595 ;;; Buffer preparation
598 (defvar elpher-buffer-name "*elpher*"
599 "The default name of the Elpher buffer.")
601 (defun elpher-update-header ()
602 "If `elpher-use-header' is true, display current page info in window header."
603 (if (and elpher-use-header elpher-current-page)
604 (let* ((display-string (elpher-page-display-string elpher-current-page))
605 (sanitized-display-string (replace-regexp-in-string "%" "%%" display-string))
606 (address (elpher-page-address elpher-current-page))
607 (tls-string (if (and (not (elpher-address-about-p address))
608 (member (elpher-address-protocol address)
609 '("gophers" "gemini")))
612 (header (concat sanitized-display-string
613 (propertize tls-string 'face 'bold))))
614 (setq header-line-format header))))
616 (defmacro elpher-with-clean-buffer (&rest args)
617 "Evaluate ARGS with a clean *elpher* buffer as current."
618 (declare (debug (body))) ;; Allow edebug to step through body
619 `(with-current-buffer elpher-buffer-name
620 (unless (eq major-mode 'elpher-mode)
621 ;; avoid resetting buffer-local variables
623 (let ((inhibit-read-only t)
624 (ansi-color-context nil)) ;; clean ansi interpreter state
625 (setq-local network-security-level
626 (default-value 'network-security-level))
628 (elpher-update-header)
631 (defun elpher-buffer-message (string &optional line)
632 "Replace first line in elpher buffer with STRING.
633 If LINE is non-nil, replace that line instead."
634 (with-current-buffer elpher-buffer-name
635 (let ((inhibit-read-only t))
636 (goto-char (point-min))
639 (let ((data (match-data)))
642 (re-search-forward "^.*$")
643 (replace-match string))
644 (set-match-data data))))))
650 (defvar elpher-user-coding-system nil
651 "User-specified coding system to use for decoding text responses.")
653 (defun elpher-decode (string)
654 "Decode STRING using autodetected or user-specified coding system."
655 (decode-coding-string string
656 (if elpher-user-coding-system
657 elpher-user-coding-system
658 (detect-coding-string string t))))
660 (defun elpher-preprocess-text-response (string)
661 "Preprocess text selector response contained in STRING.
662 This involes decoding the character representation, and clearing
663 away CRs and any terminating period."
664 (elpher-decode (replace-regexp-in-string "\n\\.\n$" "\n"
665 (replace-regexp-in-string "\r" "" string))))
669 (defconst elpher-url-regex
670 "\\([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_~?/@|#-]\\)?\\)?"
671 "Regexp used to locate and buttonify URLs in text files loaded by elpher.")
673 (defun elpher-buttonify-urls (string)
674 "Turn substrings which look like urls in STRING into clickable buttons."
677 (goto-char (point-min))
678 (while (re-search-forward elpher-url-regex nil t)
679 (let ((page (elpher-page-from-url (substring-no-properties (match-string 0)))))
680 (make-text-button (match-beginning 0)
683 'action #'elpher-click-link
685 'help-echo #'elpher--page-button-help
689 ;;; ANSI colors or XTerm colors (application and filtering)
691 (or (require 'xterm-color nil t)
692 (require 'ansi-color))
694 (defalias 'elpher-color-filter-apply
695 (if (fboundp 'xterm-color-filter)
697 (let ((_xterm-color-render nil))
698 (xterm-color-filter s)))
699 #'ansi-color-filter-apply)
700 "A function to filter out ANSI escape sequences.")
702 (defalias 'elpher-color-apply
703 (if (fboundp 'xterm-color-filter)
706 "A function to apply ANSI escape sequences.")
708 ;;; Processing text for display
710 (defun elpher-process-text-for-display (string)
711 "Perform any desired processing of STRING prior to display as text.
712 Currently includes buttonifying URLs and processing ANSI escape codes."
713 (elpher-buttonify-urls (if elpher-filter-ansi-from-text
714 (elpher-color-filter-apply string)
715 (elpher-color-apply string))))
718 ;;; Network error reporting
721 (defun elpher-network-error (address error)
722 "Display ERROR message following unsuccessful negotiation with ADDRESS.
723 ERROR can be either an error object or a string."
724 (elpher-with-clean-buffer
725 (insert (propertize "\n---- ERROR -----\n\n" 'face 'error)
726 "When attempting to retrieve " (elpher-address-to-url address) ":\n"
727 (if (stringp error) error (error-message-string error)) "\n"
728 (propertize "\n----------------\n\n" 'face 'error)
729 "Press 'u' to return to the previous page.")))
732 ;;; General network communication
735 (defvar elpher-network-timer nil
736 "Timer used for network connections.")
738 (defvar elpher-use-tls nil
739 "If non-nil, use TLS to communicate with gopher servers.")
741 (defvar elpher-client-certificate nil
742 "If non-nil, contains client certificate details to use for TLS connections.")
744 (defun elpher-process-cleanup ()
745 "Immediately shut down any extant elpher process and timers."
746 (let ((p (get-process "elpher-process")))
747 (if p (delete-process p)))
748 (if (timerp elpher-network-timer)
749 (cancel-timer elpher-network-timer)))
751 (defun elpher-make-network-timer (thunk)
752 "Create a timer to run the THUNK after `elpher-connection-timeout' seconds.
753 This is just a wraper around `run-at-time' which additionally sets the
754 buffer-local variable `elpher-network-timer' to allow
755 `elpher-process-cleanup' to also clear the timer."
756 (let ((timer (run-at-time elpher-connection-timeout nil thunk)))
757 (setq-local elpher-network-timer timer)
760 (defun elpher-get-host-response (address default-port query-string response-processor
761 &optional use-tls force-ipv4)
762 "Generic function for retrieving data from ADDRESS.
764 When ADDRESS lacks a specific port, DEFAULT-PORT is used instead.
765 QUERY-STRING is a string sent to the host specified by ADDRESS to
766 illicet a response. This response is passed as an argument to the
767 function RESPONSE-PROCESSOR.
769 If non-nil, USE-TLS specifies that the connection is to be made over
770 TLS. If set to gemini, the certificate verification will be disabled
771 unless `elpher-gemini-TLS-cert-checks' is non-nil.
773 If non-nil, FORCE-IPV4 causes the network connection to be made over
774 ipv4 only. (The default behaviour when this is not set depends on
775 the host operating system and the local network capabilities.)"
776 (if (and use-tls (not (gnutls-available-p)))
777 (error "Use of TLS requires Emacs to be compiled with GNU TLS support")
778 (unless (< (elpher-address-port address) 65536)
779 (error "Cannot establish network connection: port number > 65536"))
780 (when (and (eq use-tls 'gemini) (not elpher-gemini-TLS-cert-checks))
781 (setq-local network-security-level 'low)
782 (setq-local gnutls-verify-error nil))
784 (let* ((kill-buffer-query-functions nil)
785 (port (elpher-address-port address))
786 (host (elpher-address-host address))
787 (service (if (> port 0) port default-port))
788 (response-string-parts nil)
791 (socks (or elpher-socks-always (string-suffix-p ".onion" host)))
792 (gnutls-params (list :type 'gnutls-x509pki
795 (elpher-get-current-keylist address)))
796 (timer (elpher-make-network-timer
798 (elpher-process-cleanup)
800 ; Try again with IPv4
801 ((not (or elpher-ipv4-always force-ipv4 socks))
802 (message "Connection timed out. Retrying with IPv4.")
803 (elpher-get-host-response address default-port
808 (not (eq use-tls 'gemini))
809 (or elpher-auto-disengage-TLS
811 "TLS connetion failed. Disable TLS mode and retry? ")))
812 (setq elpher-use-tls nil)
813 (elpher-get-host-response address default-port
818 (elpher-network-error address "Connection time-out."))))))
819 (proc (if socks (socks-open-network-stream "elpher-process" nil host service)
820 (make-network-process :name "elpher-process"
822 :family (and (or force-ipv4
830 (cons 'gnutls-x509pki
831 (apply #'gnutls-boot-parameters
833 (setq elpher-network-timer timer)
834 (set-process-coding-system proc 'binary 'binary)
835 (set-process-query-on-exit-flag proc nil)
836 (elpher-buffer-message (concat "Connecting to " host "..."
837 " (press 'u' to abort)"))
838 (set-process-filter proc
839 (lambda (_proc string)
843 (setq bytes-received (+ bytes-received (length string)))
844 (let ((new-hkbytes-received (/ bytes-received 102400)))
845 (when (> new-hkbytes-received hkbytes-received)
846 (setq hkbytes-received new-hkbytes-received)
847 (elpher-buffer-message
849 (number-to-string (/ hkbytes-received 10.0))
852 (setq response-string-parts
853 (cons string response-string-parts))))
854 (set-process-sentinel proc
857 (cancel-timer timer))
858 (condition-case the-error
860 ((string-prefix-p "open" event) ; request URL
861 (elpher-buffer-message
862 (concat "Connected to " host ". Receiving data..."
863 " (press 'u' to abort)"))
864 (let ((inhibit-eol-conversion t))
865 (process-send-string proc query-string)))
866 ((string-prefix-p "deleted" event)) ; do nothing
867 ((and (not response-string-parts)
868 (not (or elpher-ipv4-always force-ipv4 socks)))
869 ; Try again with IPv4
870 (message "Connection failed. Retrying with IPv4.")
871 (elpher-get-host-response address default-port
875 (response-string-parts
876 (elpher-with-clean-buffer
877 (insert "Data received. Rendering..."))
878 (funcall response-processor
879 (apply #'concat (reverse response-string-parts)))
880 (elpher-restore-pos))
882 (error "No response from server")))
884 (elpher-network-error address the-error)))))
886 (if use-tls (apply #'gnutls-negotiate :process proc gnutls-params))
887 (funcall (process-sentinel proc) proc "open\n")))
889 (elpher-process-cleanup)
890 (error "Error initiating connection to server")))))
893 ;;; Client-side TLS Certificate Management
896 (defun elpher-generate-certificate (common-name key-file cert-file &optional temporary)
897 "Generate a key and a self-signed client TLS certificate using openssl.
899 The Common Name field of the certificate is set to COMMON-NAME. The
900 arguments KEY-FILE and CERT-FILE should contain the absolute paths of
901 the key and certificate files to write.
903 If TEMPORARY is non-nil, the certificate will be given an exporation
904 period of one day, and the key and certificate files will be deleted
905 when the certificate is no longer needed for the current session.
907 Otherwise, the certificate will be given a 100 year expiration period
908 and the files will not be deleted.
910 The function returns a list containing the current host name, the
911 temporary flag, and the key and cert file names in the form required
912 by `gnutls-boot-parameters`."
913 (let ((exp-key-file (expand-file-name key-file))
914 (exp-cert-file (expand-file-name cert-file)))
917 (call-process elpher-openssl-command nil nil nil
918 "req" "-x509" "-newkey" "rsa:2048"
919 "-days" (if temporary "1" "36500")
921 "-subj" (concat "/CN=" common-name)
922 "-keyout" exp-key-file
923 "-out" exp-cert-file)
924 (list (elpher-address-host (elpher-page-address elpher-current-page))
925 temporary exp-key-file exp-cert-file))
927 (message "Check that openssl is installed, or customize `elpher-openssl-command`.")
928 (error "Program 'openssl', required for certificate generation, not found")))))
930 (defun elpher-generate-throwaway-certificate ()
931 "Generate and return details of a throwaway certificate.
932 The key and certificate files will be deleted when they are no
933 longer needed for this session."
934 (let* ((file-base (make-temp-name "elpher"))
935 (key-file (concat temporary-file-directory file-base ".key"))
936 (cert-file (concat temporary-file-directory file-base ".crt")))
937 (elpher-generate-certificate file-base key-file cert-file t)))
939 (defun elpher-generate-persistent-certificate (file-base common-name)
940 "Generate and return details of a persistent certificate.
941 The argument FILE-BASE is used as the base for the key and certificate
942 files, while COMMON-NAME specifies the common name field of the
945 The key and certificate files are written to in `elpher-certificate-directory'."
946 (let* ((key-file (concat elpher-certificate-directory file-base ".key"))
947 (cert-file (concat elpher-certificate-directory file-base ".crt")))
948 (elpher-generate-certificate common-name key-file cert-file)))
950 (defun elpher-get-existing-certificate (file-base)
951 "Return a certificate object corresponding to an existing certificate.
952 It is assumed that the key files FILE-BASE.key and FILE-BASE.crt exist in
953 the directory `elpher-certificate-directory'."
954 (let* ((key-file (concat elpher-certificate-directory file-base ".key"))
955 (cert-file (concat elpher-certificate-directory file-base ".crt")))
956 (list (elpher-address-host (elpher-page-address elpher-current-page))
958 (expand-file-name key-file)
959 (expand-file-name cert-file))))
961 (defun elpher-install-and-use-existing-certificate (key-file-src cert-file-src file-base)
962 "Install a key+certificate file pair in `elpher-certificate-directory'.
963 The strings KEY-FILE-SRC and CERT-FILE-SRC are the existing key and
964 certificate files to install. The argument FILE-BASE is used as the
965 base for the installed key and certificate files."
966 (let* ((key-file (concat elpher-certificate-directory file-base ".key"))
967 (cert-file (concat elpher-certificate-directory file-base ".crt")))
968 (if (or (file-exists-p key-file)
969 (file-exists-p cert-file))
970 (error "A certificate with base name %s is already installed" file-base))
971 (copy-file key-file-src key-file)
972 (copy-file cert-file-src cert-file)
973 (list (elpher-address-host (elpher-page-address elpher-current-page))
975 (expand-file-name key-file)
976 (expand-file-name cert-file))))
978 (defun elpher-list-existing-certificates ()
979 "Return a list of the persistent certificates in `elpher-certificate-directory'."
980 (unless (file-directory-p elpher-certificate-directory)
981 (make-directory elpher-certificate-directory))
984 (file-name-sans-extension file))
985 (directory-files elpher-certificate-directory nil "\\.key$")))
987 (defun elpher-forget-current-certificate ()
988 "Causes any current certificate to be forgotten.)
989 In the case of throwaway certificates, the key and certificate files
992 (when elpher-client-certificate
993 (unless (and (called-interactively-p 'any)
994 (not (y-or-n-p (concat "Really forget client certificate? "
995 "(Throwaway certificates will be deleted.)"))))
996 (when (cadr elpher-client-certificate)
997 (delete-file (elt elpher-client-certificate 2))
998 (delete-file (elt elpher-client-certificate 3)))
999 (setq elpher-client-certificate nil)
1000 (if (called-interactively-p 'any)
1001 (message "Client certificate forgotten.")))))
1003 (defun elpher-get-current-keylist (address)
1004 "Retrieve the `gnutls-boot-parameters'-compatable keylist.
1006 This is obtained from the client certificate described by
1007 `elpher-current-certificate', if one is available and the host for
1008 that certificate matches the host in ADDRESS.
1010 If `elpher-current-certificate' is non-nil, and its host name doesn't
1011 match that of ADDRESS, the certificate is forgotten."
1012 (if elpher-client-certificate
1013 (if (string= (car elpher-client-certificate)
1014 (elpher-address-host address))
1015 (list (cddr elpher-client-certificate))
1016 (elpher-forget-current-certificate)
1017 (message "Disabling client certificate for new host")
1022 ;;; Gopher selector retrieval
1025 (defun elpher-get-gopher-response (address renderer)
1026 "Get response string from gopher server at ADDRESS and render using RENDERER."
1027 (elpher-get-host-response address 70
1028 (concat (elpher-gopher-address-selector address) "\r\n")
1030 (or (string= (elpher-address-protocol address) "gophers")
1033 (defun elpher-get-gopher-page (renderer)
1034 "Getter function for gopher pages.
1035 The RENDERER procedure is used to display the contents of the page
1036 once they are retrieved from the gopher server."
1037 (let* ((address (elpher-page-address elpher-current-page))
1038 (content (elpher-get-cached-content address)))
1039 (if (and content (funcall renderer nil))
1040 (elpher-with-clean-buffer
1042 (elpher-restore-pos))
1043 (elpher-with-clean-buffer
1044 (insert "LOADING... (use 'u' to cancel)\n"))
1045 (condition-case the-error
1046 (elpher-get-gopher-response address renderer)
1048 (elpher-network-error address the-error))))))
1052 (defun elpher-insert-margin (&optional type-name)
1053 "Insert index margin, optionally containing the TYPE-NAME, into the current buffer."
1056 (insert (format (concat "%" (number-to-string (- elpher-margin-width 1)) "s")
1058 (propertize "[" 'face 'elpher-margin-brackets)
1059 (propertize type-name 'face 'elpher-margin-key)
1060 (propertize "]" 'face 'elpher-margin-brackets))))
1062 (insert (make-string elpher-margin-width ?\s))))
1064 (defun elpher--page-button-help (_window buffer pos)
1065 "Function called by Emacs to generate mouse-over text.
1066 The arguments specify the BUFFER and the POS within the buffer of the item
1067 for which help is required. The function returns the help to be
1068 displayed. The _WINDOW argument is currently unused."
1069 (with-current-buffer buffer
1070 (let ((button (button-at pos)))
1072 (let* ((page (button-get button 'elpher-page))
1073 (address (elpher-page-address page)))
1074 (format "mouse-1, RET: open '%s'" (elpher-address-to-url address)))))))
1076 (defun elpher-insert-index-record (display-string &optional address)
1077 "Function to insert an index record into the current buffer.
1078 The contents of the record are dictated by DISPLAY-STRING and ADDRESS.
1079 If ADDRESS is not supplied or nil the record is rendered as an
1080 'information' line."
1081 (let* ((type (if address (elpher-address-type address) nil))
1082 (type-map-entry (cdr (assoc type elpher-type-map))))
1084 (let* ((margin-code (elt type-map-entry 2))
1085 (face (elt type-map-entry 3))
1086 (filtered-display-string (elpher-color-filter-apply display-string))
1087 (page (elpher-make-page filtered-display-string address)))
1088 (elpher-insert-margin margin-code)
1089 (insert-text-button filtered-display-string
1092 'action #'elpher-click-link
1094 'help-echo #'elpher--page-button-help))
1096 ('nil ;; Information
1097 (elpher-insert-margin)
1098 (let ((propertized-display-string
1099 (propertize display-string 'face 'elpher-info)))
1100 (insert (elpher-process-text-for-display propertized-display-string))))
1101 (`(gopher ,selector-type) ;; Unknown
1102 (elpher-insert-margin (concat (char-to-string selector-type) "?"))
1103 (insert (propertize display-string
1104 'face 'elpher-unknown)))))
1107 (defun elpher-click-link (button)
1108 "Function called when the gopher link BUTTON is activated (via mouse or keypress)."
1109 (let ((page (button-get button 'elpher-page)))
1110 (elpher-visit-page page)))
1112 (defun elpher-render-index (data &optional _mime-type-string)
1113 "Render DATA as an index. MIME-TYPE-STRING is unused."
1114 (elpher-with-clean-buffer
1117 (let ((data-processed (elpher-preprocess-text-response data)))
1118 (dolist (line (split-string data-processed "\n"))
1120 (unless (= (length line) 0)
1121 (let* ((type (elt line 0))
1122 (fields (split-string (substring line 1) "\t"))
1123 (display-string (elt fields 0))
1124 (selector (elt fields 1))
1125 (host (elt fields 2))
1126 (port (if (elt fields 3)
1127 (string-to-number (elt fields 3))
1129 (address (elpher-make-gopher-address type selector host port)))
1130 (elpher-insert-index-record display-string address))))))
1131 (elpher-cache-content (elpher-page-address elpher-current-page)
1136 (defun elpher-render-text (data &optional _mime-type-string)
1137 "Render DATA as text. MIME-TYPE-STRING is unused."
1138 (elpher-with-clean-buffer
1141 (insert (elpher-process-text-for-display (elpher-preprocess-text-response data)))
1142 (elpher-cache-content
1143 (elpher-page-address elpher-current-page)
1148 (defun elpher-render-image (data &optional _mime-type-string)
1149 "Display DATA as image. MIME-TYPE-STRING is unused."
1152 (if (display-images-p)
1153 (let* ((image (create-image
1156 (window (get-buffer-window elpher-buffer-name)))
1158 (setf (image-property image :max-width) (window-body-width window t))
1159 (setf (image-property image :max-height) (window-body-height window t)))
1160 (elpher-with-clean-buffer
1161 (insert-image image)
1162 (elpher-restore-pos)))
1163 (elpher-render-download data))))
1165 ;; Search retrieval and rendering
1167 (defun elpher-get-gopher-query-page (renderer)
1168 "Getter for gopher addresses requiring input.
1169 The response is rendered using the rendering function RENDERER."
1170 (let* ((address (elpher-page-address elpher-current-page))
1171 (content (elpher-get-cached-content address))
1173 (if (and content (funcall renderer nil))
1174 (elpher-with-clean-buffer
1176 (elpher-restore-pos)
1177 (message "Displaying cached search results. Reload to perform a new search."))
1179 (let* ((query-string (read-string "Query: "))
1180 (query-selector (concat (elpher-gopher-address-selector address) "\t" query-string))
1181 (search-address (elpher-make-gopher-address ?1
1183 (elpher-address-host address)
1184 (elpher-address-port address)
1185 (equal (elpher-address-type address) "gophers"))))
1188 (elpher-with-clean-buffer
1189 (insert "LOADING RESULTS... (use 'u' to cancel)"))
1190 (elpher-get-gopher-response search-address renderer))
1192 (elpher-visit-previous-page))))))
1194 ;; Raw server response rendering
1196 (defun elpher-render-raw (data &optional mime-type-string)
1197 "Display raw DATA in buffer. MIME-TYPE-STRING is also displayed if provided."
1200 (elpher-with-clean-buffer
1201 (when mime-type-string
1202 (insert "MIME type specified by server: '" mime-type-string "'\n"))
1204 (goto-char (point-min)))
1205 (message "Displaying raw server response. Reload or redraw to return to standard view.")))
1207 ;; File save "rendering"
1209 (defun elpher-render-download (data &optional _mime-type-string)
1210 "Save DATA to file. MIME-TYPE-STRING is unused."
1213 (let* ((address (elpher-page-address elpher-current-page))
1214 (selector (if (elpher-address-gopher-p address)
1215 (elpher-gopher-address-selector address)
1216 (elpher-address-filename address))))
1217 (elpher-visit-previous-page) ; Do first in case of non-local exits.
1218 (let* ((filename-proposal (file-name-nondirectory selector))
1219 (filename (read-file-name "Download complete. Save file as: "
1221 (if (> (length filename-proposal) 0)
1224 (let ((coding-system-for-write 'binary))
1225 (with-temp-file filename
1227 (message (format "Saved to file %s." filename))))))
1231 (defun elpher-render-html (data &optional _mime-type-string)
1232 "Render DATA as HTML using shr. MIME-TYPE-STRING is unused."
1233 (elpher-with-clean-buffer
1236 (let ((dom (with-temp-buffer
1238 (libxml-parse-html-region (point-min) (point-max)))))
1239 (shr-insert-document dom)))))
1241 ;; Gemini page retrieval
1243 (defvar elpher-gemini-redirect-chain)
1245 (defun elpher-get-gemini-response (address renderer)
1246 "Get response string from gemini server at ADDRESS and render using RENDERER."
1247 (elpher-get-host-response address 1965
1248 (concat (elpher-address-to-url address) "\r\n")
1249 (lambda (response-string)
1250 (elpher-process-gemini-response response-string renderer))
1253 (defun elpher-parse-gemini-response (response)
1254 "Parse the RESPONSE string and return a list of components.
1255 The list is of the form (code meta body). A response of nil implies
1256 that the response was malformed."
1257 (let ((header-end-idx (string-match "\r\n" response)))
1259 (let ((header (string-trim (substring response 0 header-end-idx)))
1260 (body (substring response (+ header-end-idx 2))))
1261 (if (>= (length header) 2)
1262 (let ((code (substring header 0 2))
1263 (meta (string-trim (substring header 2))))
1264 (list code meta body))
1265 (error "Malformed response: No response status found in header %s" header)))
1266 (error "Malformed response: No CRLF-delimited header found in response %s" response))))
1268 (defun elpher-process-gemini-response (response-string renderer)
1269 "Process the gemini response RESPONSE-STRING and pass the result to RENDERER."
1270 (let ((response-components (elpher-parse-gemini-response response-string)))
1271 (let ((response-code (elt response-components 0))
1272 (response-meta (elt response-components 1))
1273 (response-body (elt response-components 2)))
1274 (pcase (elt response-code 0)
1275 (?1 ; Input required
1276 (elpher-with-clean-buffer
1277 (insert "Gemini server is requesting input."))
1278 (let* ((query-string
1279 (if (eq (elt response-code 1) ?1)
1280 (read-passwd (concat response-meta ": "))
1281 (read-string (concat response-meta ": "))))
1282 (query-address (seq-copy (elpher-page-address elpher-current-page)))
1283 (old-fname (url-filename query-address)))
1284 (setf (url-filename query-address)
1285 (concat old-fname "?" (url-build-query-string `((,query-string)))))
1286 (elpher-get-gemini-response query-address renderer)))
1287 (?2 ; Normal response
1288 (funcall renderer response-body response-meta))
1290 (message "Following redirect to %s" response-meta)
1291 (if (>= (length elpher-gemini-redirect-chain) 5)
1292 (error "More than 5 consecutive redirects followed"))
1293 (let ((redirect-address (elpher-address-from-gemini-url response-meta)))
1294 (if (member redirect-address elpher-gemini-redirect-chain)
1295 (error "Redirect loop detected"))
1296 (if (not (eq (elpher-address-type redirect-address) 'gemini))
1297 (error "Server tried to automatically redirect to non-gemini URL: %s"
1299 (elpher-page-set-address elpher-current-page redirect-address)
1300 (add-to-list 'elpher-gemini-redirect-chain redirect-address)
1301 (elpher-get-gemini-response redirect-address renderer)))
1302 (?4 ; Temporary failure
1303 (error "Gemini server reports TEMPORARY FAILURE for this request: %s %s"
1304 response-code response-meta))
1305 (?5 ; Permanent failure
1306 (error "Gemini server reports PERMANENT FAILURE for this request: %s %s"
1307 response-code response-meta))
1308 (?6 ; Client certificate required
1309 (elpher-with-clean-buffer
1310 (if elpher-client-certificate
1311 (insert "Gemini server does not recognise the provided TLS certificate:\n\n")
1312 (insert "Gemini server is requesting a valid TLS certificate:\n\n"))
1314 (elpher-gemini-insert-text response-meta))
1315 (let ((chosen-certificate (elpher-choose-client-certificate)))
1316 (unless chosen-certificate
1317 (error "Gemini server requires a client certificate and none was provided"))
1318 (setq elpher-client-certificate chosen-certificate))
1319 (elpher-with-clean-buffer)
1320 (elpher-get-gemini-response (elpher-page-address elpher-current-page) renderer))
1322 (error "Gemini server response unknown: %s %s"
1323 response-code response-meta))))))
1325 (defun elpher--read-answer-polyfill (question answers)
1326 "Polyfill for `read-answer' in Emacs 26.1.
1327 QUESTION is a string containing a question, and ANSWERS
1328 is a list of possible answers."
1329 (completing-read question (mapcar 'identity answers)))
1331 (if (fboundp 'read-answer)
1332 (defalias 'elpher-read-answer 'read-answer)
1333 (defalias 'elpher-read-answer 'elpher--read-answer-polyfill))
1335 (defun elpher-choose-client-certificate ()
1336 "Prompt for a client certificate to use to establish a TLS connection."
1337 (let* ((read-answer-short t))
1338 (pcase (read-answer "What do you want to do? "
1340 "generate and use throw-away certificate")
1342 "generate new or use existing persistent certificate")
1344 "stop immediately")))
1346 (setq elpher-client-certificate (elpher-generate-throwaway-certificate)))
1348 (let* ((existing-certificates (elpher-list-existing-certificates))
1349 (file-base (completing-read
1350 "Nickname for new or existing certificate (autocompletes, empty response aborts): "
1351 existing-certificates)))
1352 (if (string-empty-p (string-trim file-base))
1354 (if (member file-base existing-certificates)
1355 (setq elpher-client-certificate
1356 (elpher-get-existing-certificate file-base))
1357 (pcase (read-answer "Generate new certificate or install externally-generated one? "
1359 "generate new certificate")
1361 "install existing certificate")
1363 "stop immediately")))
1365 (let ((common-name (read-string "Common Name field for new certificate: "
1367 (message "New key and self-signed certificate written to %s"
1368 elpher-certificate-directory)
1369 (elpher-generate-persistent-certificate file-base common-name)))
1371 (let* ((cert-file (read-file-name "Certificate file: " nil nil t))
1372 (key-file (read-file-name "Key file: " nil nil t)))
1373 (message "Key and certificate installed in %s for future use"
1374 elpher-certificate-directory)
1375 (elpher-install-and-use-existing-certificate key-file
1381 (defun elpher-get-gemini-page (renderer)
1382 "Getter which retrieves and renders a Gemini page and renders it using RENDERER."
1383 (let* ((address (elpher-page-address elpher-current-page))
1384 (content (elpher-get-cached-content address)))
1385 (condition-case the-error
1386 (if (and content (funcall renderer nil))
1387 (elpher-with-clean-buffer
1389 (elpher-restore-pos))
1390 (elpher-with-clean-buffer
1391 (insert "LOADING GEMINI... (use 'u' to cancel)\n"))
1392 (setq elpher-gemini-redirect-chain nil)
1393 (elpher-get-gemini-response address renderer))
1395 (elpher-network-error address the-error)))))
1397 (defun elpher-render-gemini (body &optional mime-type-string)
1398 "Render gemini response BODY with rendering MIME-TYPE-STRING."
1401 (let* ((mime-type-string* (if (or (not mime-type-string)
1402 (string-empty-p mime-type-string))
1403 "text/gemini; charset=utf-8"
1405 (mime-type-split (split-string mime-type-string* ";" t))
1406 (mime-type (string-trim (car mime-type-split)))
1407 (parameters (mapcar (lambda (s)
1408 (let ((key-val (split-string s "=")))
1409 (list (downcase (string-trim (car key-val)))
1410 (downcase (string-trim (cadr key-val))))))
1411 (cdr mime-type-split))))
1412 (when (string-prefix-p "text/" mime-type)
1413 (setq body (decode-coding-string
1415 (if (assoc "charset" parameters)
1416 (intern (cadr (assoc "charset" parameters)))
1418 (setq body (replace-regexp-in-string "\r" "" body)))
1420 ((or "text/gemini" "")
1421 (elpher-render-gemini-map body parameters))
1423 (elpher-render-html body))
1424 ((pred (string-prefix-p "text/"))
1425 (elpher-render-gemini-plain-text body parameters))
1426 ((pred (string-prefix-p "image/"))
1427 (elpher-render-image body))
1429 (elpher-render-download body))))))
1431 (defun elpher-gemini-get-link-url (link-line)
1432 "Extract the url portion of LINK-LINE, a gemini map file link line.
1433 Returns nil in the event that the contents of the line following the
1434 => prefix are empty."
1435 (let ((l (split-string (substring link-line 2))))
1437 (string-trim (elt l 0))
1440 (defun elpher-gemini-get-link-display-string (link-line)
1441 "Extract the display string portion of LINK-LINE, a gemini map file link line.
1442 Returns the url portion in the event that the display-string portion is empty."
1443 (let* ((rest (string-trim (elt (split-string link-line "=>") 1)))
1444 (idx (string-match "[ \t]" rest)))
1445 (string-trim (if idx
1446 (substring rest (+ idx 1))
1449 (defun elpher-collapse-dot-sequences (filename)
1450 "Collapse dot sequences in the (absolute) FILENAME.
1451 For instance, the filename \"/a/b/../c/./d\" will reduce to \"/a/c/d\""
1452 (let* ((path (split-string filename "/" t))
1453 (is-directory (string-match-p (rx (: (or "." ".." "/") line-end)) filename))
1454 (path-reversed-normalized
1455 (seq-reduce (lambda (a b)
1456 (cond ((equal b "..") (cdr a))
1460 (path-normalized (reverse path-reversed-normalized)))
1462 (concat "/" (string-join path-normalized "/") (and is-directory "/"))
1465 (defun elpher-address-from-gemini-url (url)
1466 "Extract address from URL with defaults as per gemini map files.
1467 While there's obviously some redundancy here between this function and
1468 `elpher-address-from-url', gemini map file URLs require enough special
1469 treatment that a separate function is warranted."
1470 (let ((address (url-generic-parse-url url))
1471 (current-address (elpher-page-address elpher-current-page)))
1472 (unless (and (url-type address) (not (url-fullness address))) ;avoid mangling mailto: urls
1473 (setf (url-fullness address) t)
1474 (if (url-host address) ;if there is an explicit host, filenames are absolute
1475 (if (string-empty-p (url-filename address))
1476 (setf (url-filename address) "/")) ;ensure empty filename is marked as absolute
1477 (setf (url-host address) (url-host current-address))
1478 (setf (url-portspec address) (url-portspec current-address)) ; (url-port) too slow!
1479 (unless (string-prefix-p "/" (url-filename address)) ;deal with relative links
1480 (setf (url-filename address)
1481 (concat (file-name-directory (url-filename current-address))
1482 (url-filename address)))))
1483 (when (url-host address)
1484 (setf (url-host address) (puny-encode-domain (url-host address))))
1485 (unless (url-type address)
1486 (setf (url-type address) (url-type current-address)))
1487 (when (equal (url-type address) "gemini")
1488 (setf (url-filename address)
1489 (elpher-collapse-dot-sequences (url-filename address)))))
1490 (elpher-remove-redundant-ports address)))
1492 (defun elpher-gemini-insert-link (link-line)
1493 "Insert link described by LINK-LINE into a text/gemini document."
1494 (let* ((url (elpher-gemini-get-link-url link-line))
1495 (display-string (elpher-gemini-get-link-display-string link-line))
1496 (address (elpher-address-from-gemini-url url))
1497 (type (if address (elpher-address-type address) nil))
1498 (type-map-entry (cdr (assoc type elpher-type-map))))
1499 (when display-string
1500 (insert elpher-gemini-link-string)
1502 (let* ((face (elt type-map-entry 3))
1503 (filtered-display-string (elpher-color-filter-apply display-string))
1504 (page (elpher-make-page filtered-display-string address)))
1505 (insert-text-button filtered-display-string
1508 'action #'elpher-click-link
1510 'help-echo #'elpher--page-button-help))
1511 (insert (propertize display-string 'face 'elpher-unknown)))
1514 (defvar elpher--gemini-page-headings nil
1515 "List of headings on the page.")
1517 (defun elpher-gemini-insert-header (header-line)
1518 "Insert header described by HEADER-LINE into a text/gemini document.
1519 The gemini map file line describing the header is given
1521 (when (string-match "^\\(#+\\)[ \t]*" header-line)
1522 (let* ((level (length (match-string 1 header-line)))
1523 (header (substring header-line (match-end 0)))
1525 (1 'elpher-gemini-heading1)
1526 (2 'elpher-gemini-heading2)
1527 (3 'elpher-gemini-heading3)
1529 (fill-column (if (display-graphic-p)
1531 (font-get (font-spec :name (face-font 'default)) :size))
1532 (font-get (font-spec :name (face-font face)) :size)) fill-column)))
1533 (setq elpher--gemini-page-headings (cons (cons header (point))
1534 elpher--gemini-page-headings))
1535 (unless (display-graphic-p)
1536 (insert (make-string level ?#) " "))
1537 (insert (propertize header 'face face 'rear-nonsticky t))
1540 (defun elpher-gemini-insert-text (text-line)
1541 "Insert a plain non-preformatted TEXT-LINE into a text/gemini document.
1542 This function uses Emacs' auto-fill to wrap text sensibly to a maximum
1543 width defined by `elpher-gemini-max-fill-width'."
1548 (group (or (: "*" (+ (any " \t")))
1549 (: ">" (* (any " \t"))))))))
1551 (let* ((line-prefix (match-string 1 text-line))
1552 (processed-text-line
1554 (cond ((string-prefix-p "*" line-prefix)
1556 (replace-regexp-in-string "\\*"
1557 elpher-gemini-bullet-string
1558 (match-string 0 text-line))
1559 (substring text-line (match-end 0))))
1560 ((string-prefix-p ">" line-prefix)
1561 (propertize text-line 'face 'elpher-gemini-quoted))
1564 (adaptive-fill-mode t)
1565 ;; fill-prefix is important for adaptive-fill-mode: without
1566 ;; it, multi-line list items are not indented correct
1567 (fill-prefix (if (match-string 1 text-line)
1568 (make-string (length (match-string 0 text-line)) ?\s)
1570 (insert (elpher-process-text-for-display processed-text-line))
1573 (defun elpher-render-gemini-map (data _parameters)
1574 "Render DATA as a gemini map file, PARAMETERS is currently unused."
1575 (elpher-with-clean-buffer
1576 (setq elpher--gemini-page-headings nil)
1577 (let ((preformatted nil))
1579 (setq-local fill-column (min (window-width) elpher-gemini-max-fill-width))
1580 (dolist (line (split-string data "\n"))
1582 ((string-prefix-p "```" line) (setq preformatted (not preformatted)))
1583 (preformatted (insert (elpher-process-text-for-display
1584 (propertize line 'face 'elpher-gemini-preformatted))
1586 ((string-prefix-p "=>" line)
1587 (elpher-gemini-insert-link line))
1588 ((string-prefix-p "#" line) (elpher-gemini-insert-header line))
1589 (t (elpher-gemini-insert-text line)))))
1590 (setq elpher--gemini-page-headings (nreverse elpher--gemini-page-headings))
1591 (elpher-cache-content
1592 (elpher-page-address elpher-current-page)
1595 (defun elpher-render-gemini-plain-text (data _parameters)
1596 "Render DATA as plain text file. PARAMETERS is currently unused."
1597 (elpher-with-clean-buffer
1598 (insert (elpher-process-text-for-display data))
1599 (elpher-cache-content
1600 (elpher-page-address elpher-current-page)
1604 ;; Finger page connection
1606 (defun elpher-get-finger-page (renderer)
1607 "Opens a finger connection to the current page address.
1608 The result is rendered using RENDERER."
1609 (let* ((address (elpher-page-address elpher-current-page))
1610 (content (elpher-get-cached-content address)))
1611 (if (and content (funcall renderer nil))
1612 (elpher-with-clean-buffer
1614 (elpher-restore-pos))
1615 (elpher-with-clean-buffer
1616 (insert "LOADING... (use 'u' to cancel)\n"))
1617 (condition-case the-error
1618 (let* ((kill-buffer-query-functions nil)
1619 (user (let ((filename (elpher-address-filename address)))
1620 (if (> (length filename) 1)
1621 (substring filename 1)
1622 (elpher-address-user address)))))
1623 (elpher-get-host-response address 79
1624 (concat user "\r\n")
1627 (elpher-network-error address the-error))))))
1630 ;; Telnet page connection
1632 (defun elpher-get-telnet-page (renderer)
1633 "Opens a telnet connection to the current page address (RENDERER must be nil)."
1635 (elpher-visit-previous-page)
1636 (error "Command not supported for telnet URLs"))
1637 (let* ((address (elpher-page-address elpher-current-page))
1638 (host (elpher-address-host address))
1639 (port (elpher-address-port address)))
1640 (elpher-visit-previous-page)
1646 ;; Other URL page opening
1648 (defun elpher-get-other-url-page (renderer)
1649 "Getter which attempts to open the URL specified by the current page (RENDERER must be nil)."
1651 (elpher-visit-previous-page)
1652 (error "Command not supported for general URLs"))
1653 (let* ((address (elpher-page-address elpher-current-page))
1654 (url (elpher-address-to-url address)))
1655 (elpher-visit-previous-page) ; Do first in case of non-local exits.
1656 (message "Opening URL...")
1657 (if elpher-open-urls-with-eww
1663 (defun elpher-get-file-page (renderer)
1664 "Getter which renders a local file using RENDERER.
1665 Assumes UTF-8 encoding for all text files."
1666 (let* ((address (elpher-page-address elpher-current-page))
1667 (filename (elpher-address-filename address)))
1668 (unless (file-exists-p filename)
1669 (elpher-visit-previous-page)
1670 (error "File not found"))
1671 (unless (file-readable-p filename)
1672 (elpher-visit-previous-page)
1673 (error "Could not read from file"))
1674 (let ((body (with-temp-buffer
1675 (let ((coding-system-for-read 'binary)
1676 (coding-system-for-write 'binary))
1677 (insert-file-contents-literally filename)
1678 (encode-coding-string (buffer-string) 'raw-text)))))
1680 (funcall renderer body nil)
1681 (pcase (file-name-extension filename)
1682 ((or "gmi" "gemini")
1683 (elpher-render-gemini-map (decode-coding-string body 'utf-8) nil))
1685 (elpher-render-html (decode-coding-string body 'utf-8)))
1687 (elpher-render-text (decode-coding-string body 'utf-8)))
1688 ((or "jpg" "jpeg" "gif" "png" "bmp" "tif" "tiff")
1689 (elpher-render-image body))
1690 ((or "gopher" "gophermap")
1691 (elpher-render-index (elpher-decode body)))
1693 (elpher-render-download body))))
1694 (elpher-restore-pos))))
1697 ;; Welcome page retrieval
1699 (defun elpher-get-welcome-page (renderer)
1700 "Getter which displays the welcome page (RENDERER must be nil)."
1702 (elpher-visit-previous-page)
1703 (error "Command not supported for welcome page"))
1704 (elpher-with-clean-buffer
1705 (insert " --------------------------------------------\n"
1706 " Elpher Gopher and Gemini Client \n"
1707 " version " elpher-version "\n"
1708 " --------------------------------------------\n"
1710 "Default bindings:\n"
1712 " - TAB/Shift-TAB: next/prev item on current page\n"
1713 " - RET/mouse-1: open item under cursor\n"
1714 " - m: select an item on current page by name (autocompletes)\n"
1715 " - u/mouse-3/U: return to previous page or to the start page\n"
1716 " - g: go to a particular address (gopher, gemini, finger)\n"
1717 " - o/O: open a different address selector or the root menu of the current server\n"
1718 " - d/D: download item under cursor or current page\n"
1719 " - i/I: info on item under cursor or current page\n"
1720 " - c/C: copy URL representation of item under cursor or current page\n"
1721 " - a/A: bookmark the item under cursor or current page\n"
1722 " - B: list all bookmarks\n"
1723 " - s/S: show current history stack or all previously visted pages\n"
1724 " - r: redraw current page (using cached contents if available)\n"
1725 " - R: reload current page (regenerates cache)\n"
1726 " - !: set character coding system for gopher (default is to autodetect)\n"
1727 " - T: toggle TLS gopher mode\n"
1728 " - F: forget/discard current TLS client certificate\n"
1729 " - .: display the raw server response for the current page\n"
1731 "Start your exploration of gopher space and gemini:\n")
1732 (elpher-insert-index-record "Floodgap Systems Gopher Server"
1733 (elpher-make-gopher-address ?1 "" "gopher.floodgap.com" 70))
1734 (elpher-insert-index-record "Project Gemini home page"
1735 (elpher-address-from-url "gemini://gemini.circumlunar.space/"))
1737 "Alternatively, select a search engine and enter some search terms:\n")
1738 (elpher-insert-index-record "Gopher Search Engine (Veronica-2)"
1739 (elpher-make-gopher-address ?7 "/v2/vs" "gopher.floodgap.com" 70))
1740 (elpher-insert-index-record "Gemini Search Engine (geminispace.info)"
1741 (elpher-address-from-url "gemini://geminispace.info/search"))
1743 "Your bookmarks are stored in your ")
1744 (let ((help-string "RET,mouse-1: Open bookmark list"))
1745 (insert-text-button "bookmark list"
1747 'action #'elpher-click-link
1749 'help-echo #'elpher--page-button-help
1751 (elpher-make-page "Elpher Bookmarks"
1752 (elpher-make-about-address 'bookmarks))))
1755 "(Bookmarks from legacy elpher-bookmarks files will be automatically imported.)\n"
1758 "The gopher home of the Elpher project is here:\n")
1759 (elpher-insert-index-record "The Elpher Project Page"
1760 (elpher-make-gopher-address ?1
1764 (let ((help-string "RET,mouse-1: Open Elpher info manual (if available)"))
1766 "The following info documentation is available:\n"
1768 (insert-text-button "Elpher Manual"
1774 'help-echo help-string)
1776 (insert-text-button "Changes introduced by the latest release"
1780 (info "(elpher)News"))
1782 'help-echo help-string))
1785 (concat "(These documents should be available if you have installed Elpher \n"
1786 " using MELPA. Otherwise you may have to install the manual yourself.)\n")
1788 (elpher-restore-pos)))
1790 ;; History page retrieval
1792 (defun elpher-show-history ()
1793 "Show the current contents of elpher's history stack.
1794 Use \\[elpher-show-visited-pages] to see the entire history.
1795 This is rendered using `elpher-get-history-page' via `elpher-type-map'."
1798 (elpher-make-page "Current History Stack"
1799 (elpher-make-about-address 'history))))
1801 (defun elpher-show-visited-pages ()
1802 "Show the all the pages you've visited using Elpher.
1803 Use \\[elpher-show-history] to see just the current history stack.
1804 This is rendered using `elpher-get-visited-pages-page' via `elpher-type-map'."
1807 (elpher-make-page "Elpher Visted Pages"
1808 (elpher-make-about-address 'visited-pages))))
1810 (defun elpher-get-history-page (renderer)
1811 "Getter which displays the history page (RENDERER must be nil)."
1813 (elpher-visit-previous-page)
1814 (error "Command not supported for history page"))
1815 (elpher-display-history-links elpher-history "Current history stack"))
1817 (defun elpher-get-visited-pages-page (renderer)
1818 "Getter which displays the list of visited pages (RENDERER must be nil)."
1820 (elpher-visit-previous-page)
1821 (error "Command not supported for history page"))
1822 (elpher-display-history-links
1823 (seq-filter (lambda (page)
1824 (not (elpher-address-about-p (elpher-page-address page))))
1825 elpher-visited-pages)
1826 "All visited pages"))
1828 (defun elpher-display-history-links (pages title)
1829 "Show all PAGES in an Elpher buffer with a given TITLE."
1830 (let* ((title-line (concat " ---- " title " ----"))
1831 (footer-line (make-string (length title-line) ?-)))
1832 (elpher-with-clean-buffer
1833 (insert title-line "\n\n")
1835 (dolist (page pages)
1837 (let ((display-string (elpher-page-display-string page))
1838 (address (elpher-page-address page)))
1839 (elpher-insert-index-record display-string address))))
1840 (insert "No history items found.\n"))
1841 (insert "\n " footer-line "\n"
1842 "Select an entry or press 'u' to return to the previous page.")
1843 (elpher-restore-pos))))
1848 ;; This code allows Elpher to use the standard Emacs bookmarks: `C-x r
1849 ;; m' to add a bookmark, `C-x r l' to list bookmarks (which is where
1850 ;; you can anotate bookmarks!), `C-x r b' to jump to a bookmark, and
1851 ;; so on. See the Bookmarks section in the Emacs info manual for more.
1853 (defvar elpher-bookmark-link nil
1854 "Prefer bookmarking a link or the current page.
1855 Bind this variable dynamically, or set it to t.
1856 If you set it to t, the commands \\[bookmark-set-no-overwrite]
1857 and \\[elpher-set-bookmark-no-overwrite] do the same thing.")
1859 (defun elpher-bookmark-make-record ()
1860 "Return a bookmark record.
1861 If `elpher-bookmark-link' is non-nil and point is on a link button,
1862 return a bookmark record for that link. Otherwise, return a bookmark
1863 record for the current elpher page."
1864 (let* ((button (and elpher-bookmark-link (button-at (point))))
1866 (button-get button 'elpher-page)
1867 elpher-current-page)))
1869 (error "Cannot bookmark this link"))
1870 (let* ((address (elpher-page-address page))
1871 (url (elpher-address-to-url address))
1872 (display-string (elpher-page-display-string page))
1873 (pos (if button nil (point))))
1874 (if (elpher-address-about-p address)
1875 (error "Cannot bookmark %s" display-string)
1877 (defaults . (,display-string))
1880 (handler . elpher-bookmark-jump))))))
1883 (defun elpher-bookmark-jump (bookmark)
1884 "Handler used to open a bookmark using elpher.
1885 The argument BOOKMARK is a bookmark record passed to the function.
1886 This handler is responsible for loading the bookmark in some buffer,
1887 then making that buffer the current buffer. It should not switch
1889 (let* ((url (cdr (assq 'location bookmark)))
1890 (cleaned-url (string-trim url))
1891 (page (elpher-page-from-url cleaned-url)))
1892 (elpher-with-clean-buffer
1893 (elpher-visit-page page))
1894 (set-buffer (get-buffer elpher-buffer-name))
1897 (defun elpher-bookmark-link ()
1898 "Bookmark the link at point.
1899 To bookmark the current page, use \\[elpher-bookmark-current]."
1901 (let ((elpher-bookmark-link t))
1902 (bookmark-set-no-overwrite)))
1904 (defun elpher-bookmark-current ()
1905 "Bookmark the current page.
1906 To bookmark the link at point use \\[elpher-bookmark-link]."
1908 (call-interactively #'bookmark-set-no-overwrite))
1910 (defun elpher-bookmark-import (file)
1911 "Import legacy Elpher bookmarks file FILE into Emacs bookmarks."
1912 (interactive (list (if (and (boundp 'elpher-bookmarks-file)
1913 (file-readable-p elpher-bookmarks-file))
1914 elpher-bookmarks-file
1915 (read-file-name "Old Elpher bookmarks: "
1916 user-emacs-directory nil t
1917 "elpher-bookmarks"))))
1918 (dolist (bookmark (with-temp-buffer
1919 (insert-file-contents file)
1920 (read (current-buffer))))
1921 (let* ((display-string (car bookmark))
1922 (url (cadr bookmark))
1923 (record `(,display-string
1925 (handler . elpher-bookmark-jump))))
1926 (bookmark-store display-string (cdr record) t)))
1929 (defun elpher-get-bookmarks-page (renderer)
1930 "Getter which displays the bookmarks (RENDERER must be nil)."
1932 (elpher-visit-previous-page)
1933 (error "Command not supported for bookmarks page"))
1935 (let ((old-bookmarks-file (or (and (boundp 'elpher-bookmarks-file)
1936 elpher-bookmarks-file)
1937 (locate-user-emacs-file "elpher-bookmarks"))))
1938 (when (and (file-readable-p old-bookmarks-file)
1939 (y-or-n-p (concat "Legacy elpher-bookmarks file \""
1941 "\" found. Import now?")))
1942 (elpher-bookmark-import old-bookmarks-file)
1943 (rename-file old-bookmarks-file (concat old-bookmarks-file "-legacy"))))
1945 (if (and elpher-use-emacs-bookmark-menu
1948 (elpher-visit-previous-page)
1949 (call-interactively #'bookmark-bmenu-list))
1950 (elpher-with-clean-buffer
1951 (insert " ---- Elpher Bookmarks ---- \n\n")
1952 (bookmark-maybe-load-default-file)
1953 (dolist (bookmark (bookmark-maybe-sort-alist))
1954 (when (eq #'elpher-bookmark-jump (alist-get 'handler (cdr bookmark)))
1955 (let* ((name (car bookmark))
1956 (url (alist-get 'location (cdr bookmark)))
1957 (address (elpher-address-from-url url)))
1958 (elpher-insert-index-record name address))))
1959 (when (<= (line-number-at-pos) 3)
1960 (insert "No bookmarked pages found.\n"))
1961 (insert "\n --------------------------\n\n"
1962 "Select an entry or press 'u' to return to the previous page.\n\n"
1963 "Bookmarks can be renamed or deleted via the ")
1964 (insert-text-button "Emacs bookmark menu"
1967 (call-interactively #'bookmark-bmenu-list))
1969 'help-echo "RET,mouse-1: open Emacs bookmark menu")
1970 (insert (substitute-command-keys
1971 ",\nwhich can also be opened from anywhere using '\\[bookmark-bmenu-list]'."))
1972 (elpher-restore-pos))))
1974 (defun elpher-show-bookmarks ()
1975 "Interactive function to display the current list of elpher bookmarks."
1978 (elpher-make-page "Elpher Bookmarks"
1979 (elpher-make-about-address 'bookmarks))))
1987 (defun elpher-org-export-link (link description format protocol)
1988 "Export a LINK with DESCRIPTION for the given PROTOCOL and FORMAT.
1990 FORMAT is an Org export backend. DESCRIPTION may be nil. PROTOCOL may be one
1991 of gemini, gopher or finger."
1992 (let* ((url (if (equal protocol "elpher")
1993 (string-remove-prefix "elpher:" link)
1994 (format "%s:%s" protocol link)))
1995 (desc (or description url)))
1997 (`gemini (format "=> %s %s" url desc))
1998 (`html (format "<a href=\"%s\">%s</a>" url desc))
1999 (`latex (format "\\href{%s}{%s}" url desc))
2000 (_ (if (not description)
2002 (format "%s (%s)" desc url))))))
2004 (defun elpher-org-store-link ()
2005 "Store link to an `elpher' page in Org."
2006 (when (eq major-mode 'elpher-mode)
2007 (let* ((url (elpher-info-current))
2008 (desc (car elpher-current-page))
2010 ((string-prefix-p "gemini:" url) "gemini")
2011 ((string-prefix-p "gopher:" url) "gopher")
2012 ((string-prefix-p "finger:" url) "finger")
2014 (when (equal "elpher" protocol)
2015 ;; Weird link. Or special inner link?
2016 (setq url (concat "elpher:" url)))
2017 (org-link-store-props :type protocol :link url :description desc)
2020 (defun elpher-org-follow-link (link protocol)
2021 "Visit a LINK for the given PROTOCOL.
2023 PROTOCOL may be one of gemini, gopher or finger. This method also
2024 supports the old protocol elpher, where the link is self-contained."
2025 (let ((url (if (equal protocol "elpher")
2026 (string-remove-prefix "elpher:" link)
2027 (format "%s:%s" protocol link))))
2030 (defun elpher-org-mode-integration ()
2031 "Set up `elpher' integration for `org-mode'."
2032 (org-link-set-parameters
2034 :store #'elpher-org-store-link
2035 :export (lambda (link description format _plist)
2036 (elpher-org-export-link link description format "elpher"))
2037 :follow (lambda (link _arg) (elpher-org-follow-link link "elpher")))
2038 (org-link-set-parameters
2040 :export (lambda (link description format _plist)
2041 (elpher-org-export-link link description format "gemini"))
2042 :follow (lambda (link _arg) (elpher-org-follow-link link "gemini")))
2043 (org-link-set-parameters
2045 :export (lambda (link description format _plist)
2046 (elpher-org-export-link link description format "gopher"))
2047 :follow (lambda (link _arg) (elpher-org-follow-link link "gopher")))
2048 (org-link-set-parameters
2050 :export (lambda (link description format _plist)
2051 (elpher-org-export-link link description format "finger"))
2052 :follow (lambda (link _arg) (elpher-org-follow-link link "finger"))))
2054 (add-hook 'org-mode-hook #'elpher-org-mode-integration)
2059 (defun elpher-browse-url-elpher (url &rest _args)
2060 "Browse URL using Elpher. This function is used by `browse-url'."
2061 (interactive (browse-url-interactive-arg "Elpher URL: "))
2064 ;; Use elpher to open gopher, finger and gemini links
2065 ;; For recent version of `browse-url' package
2066 (if (boundp 'browse-url-default-handlers)
2068 'browse-url-default-handlers
2069 '("^\\(gopher\\|finger\\|gemini\\)://" . elpher-browse-url-elpher))
2070 ;; Patch `browse-url-browser-function' for older ones. The value of
2071 ;; that variable is `browse-url-default-browser' by default, so
2072 ;; that's the function that gets advised.
2073 (advice-add browse-url-browser-function :before-while
2074 (lambda (url &rest _args)
2075 "Handle gemini, gopher, and finger schemes using Elpher."
2076 (let ((scheme (downcase (car (split-string url ":" t)))))
2077 (if (member scheme '("gemini" "gopher" "finger"))
2078 ;; `elpher-go' always returns nil, which will stop the
2079 ;; advice chain here in a before-while
2081 ;; chain must continue, then return t.
2084 ;; Register "gemini://" as a URI scheme so `browse-url' does the right thing
2085 (with-eval-after-load 'thingatpt
2086 (add-to-list 'thing-at-point-uri-schemes "gemini://"))
2090 ;; Make mu4e aware of the gemini world
2091 (setq mu4e~view-beginning-of-url-regexp
2092 "\\(?:https?\\|gopher\\|finger\\|gemini\\)://\\|mailto:")
2096 ;; Let elpher handle gemini, gopher links in eww buffer.
2097 (setq eww-use-browse-url
2098 "\\`mailto:\\|\\(\\`gemini\\|\\`gopher\\|\\`finger\\)://")
2101 ;;; Interactive procedures
2104 (defun elpher-next-link ()
2105 "Move point to the next link on the current page."
2109 (defun elpher-prev-link ()
2110 "Move point to the previous link on the current page."
2112 (backward-button 1))
2114 (defun elpher-follow-current-link ()
2115 "Open the link or url at point."
2120 (defun elpher-go (host-or-url)
2121 "Go to a particular gopher site HOST-OR-URL.
2122 When run interactively HOST-OR-URL is read from the minibuffer."
2123 (interactive "sGopher or Gemini URL: ")
2124 (let ((trimmed-host-or-url (string-trim host-or-url)))
2125 (unless (string-empty-p trimmed-host-or-url)
2126 (let ((page (elpher-page-from-url trimmed-host-or-url)))
2127 (switch-to-buffer elpher-buffer-name)
2128 (elpher-with-clean-buffer
2129 (elpher-visit-page page))
2130 nil)))) ; non-nil value is displayed by eshell
2132 (defun elpher-go-current ()
2133 "Go to a particular site read from the minibuffer, initialized with the current URL."
2135 (let* ((address (elpher-page-address elpher-current-page))
2136 (url (read-string "Gopher or Gemini URL: "
2137 (unless (elpher-address-about-p address)
2138 (elpher-address-to-url address)))))
2139 (unless (string-empty-p (string-trim url))
2140 (elpher-visit-page (elpher-page-from-url url)))))
2142 (defun elpher-redraw ()
2143 "Redraw current page."
2145 (elpher-visit-page elpher-current-page))
2147 (defun elpher-reload ()
2148 "Reload current page."
2150 (elpher-reload-current-page))
2152 (defun elpher-toggle-tls ()
2153 "Toggle TLS encryption mode for gopher."
2155 (setq elpher-use-tls (not elpher-use-tls))
2157 (if (gnutls-available-p)
2158 (message "TLS gopher mode enabled. (Will not affect current page until reload.)")
2159 (setq elpher-use-tls nil)
2160 (error "Cannot enable TLS gopher mode: GnuTLS not available"))
2161 (message "TLS gopher mode disabled. (Will not affect current page until reload.)")))
2163 (defun elpher-view-raw ()
2164 "View raw server response for current page."
2166 (if (elpher-address-about-p (elpher-page-address elpher-current-page))
2167 (error "This page was not generated by a server")
2168 (elpher-visit-page elpher-current-page
2169 #'elpher-render-raw)))
2171 (defun elpher-back ()
2172 "Go to previous site."
2174 (elpher-visit-previous-page))
2176 (defun elpher-back-to-start ()
2177 "Go all the way back to the start page."
2179 (setq-local elpher-current-page nil)
2180 (setq-local elpher-history nil)
2181 (elpher-visit-page (elpher-make-start-page)))
2183 (defun elpher-download ()
2184 "Download the link at point."
2186 (let ((button (button-at (point))))
2188 (let ((page (button-get button 'elpher-page)))
2190 (error "Not an elpher page"))
2191 (when (elpher-address-about-p (elpher-page-address page))
2192 (error "Cannot download %s" (elpher-page-display-string page)))
2193 (elpher-visit-page (button-get button 'elpher-page)
2194 #'elpher-render-download))
2195 (error "No link selected"))))
2197 (defun elpher-download-current ()
2198 "Download the current page."
2200 (if (elpher-address-about-p (elpher-page-address elpher-current-page))
2201 (error "Cannot download %s"
2202 (elpher-page-display-string elpher-current-page))
2203 (elpher-visit-page (elpher-make-page
2204 (elpher-page-display-string elpher-current-page)
2205 (elpher-page-address elpher-current-page))
2206 #'elpher-render-download
2209 (defun elpher--build-link-map ()
2210 "Build alist mapping link names to destination pages in current buffer."
2211 (let ((link-map nil)
2212 (b (next-button (point-min) t)))
2214 (push (cons (button-label b) b) link-map)
2215 (setq b (next-button (button-start b))))
2218 (defun elpher-jump ()
2219 "Select a directory entry by name. Similar to the info browser (m)enu command."
2221 (let* ((link-map (elpher--build-link-map)))
2223 (let ((key (let ((completion-ignore-case t))
2224 (completing-read "Directory item/link: "
2226 (if (and key (> (length key) 0))
2227 (let ((b (cdr (assoc key link-map))))
2228 (goto-char (button-start b))
2229 (button-activate b)))))))
2231 (defun elpher-root-dir ()
2232 "Visit root of current server."
2234 (let ((address (elpher-page-address elpher-current-page)))
2235 (if (not (elpher-address-about-p address))
2236 (if (or (member (url-filename address) '("/" ""))
2237 (and (elpher-address-gopher-p address)
2238 (= (length (elpher-gopher-address-selector address)) 0)))
2239 (error "Already at root directory of current server")
2240 (let ((address-copy (elpher-address-from-url
2241 (elpher-address-to-url address))))
2242 (setf (url-filename address-copy) "")
2243 (elpher-go (elpher-address-to-url address-copy))))
2244 (error "Command invalid for %s" (elpher-page-display-string elpher-current-page)))))
2246 (defun elpher-info-page (page)
2247 "Display URL of PAGE in minibuffer."
2248 (let ((address (elpher-page-address page)))
2249 (message "%s" (elpher-address-to-url address))))
2251 (defun elpher-info-link ()
2252 "Display information on page corresponding to link at point."
2254 (let ((button (button-at (point))))
2256 (error "No item selected"))
2257 (let ((page (button-get button 'elpher-page)))
2259 (error "Not an elpher page"))
2260 (elpher-info-page page))))
2262 (defun elpher-info-current ()
2263 "Display information on current page."
2265 (elpher-info-page elpher-current-page))
2267 (defun elpher-copy-page-url (page)
2268 "Copy URL representation of address of PAGE to `kill-ring'."
2269 (let* ((address (elpher-page-address page))
2270 (url (elpher-address-to-url address)))
2271 (message "Copied \"%s\" to kill-ring/clipboard." url)
2274 (defun elpher-copy-link-url ()
2275 "Copy URL of item at point to `kill-ring'."
2277 (let ((button (button-at (point))))
2279 (error "No item selected"))
2280 (let ((page (button-get button 'elpher-page)))
2282 (error "Not an elpher page"))
2283 (elpher-copy-page-url page))))
2285 (defun elpher-copy-current-url ()
2286 "Copy URL of current page to `kill-ring'."
2288 (elpher-copy-page-url elpher-current-page))
2290 (defun elpher-set-gopher-coding-system ()
2291 "Specify an explicit character coding system for gopher selectors."
2293 (let ((system (read-coding-system "Set coding system to use for gopher (default is to autodetect): " nil)))
2294 (setq elpher-user-coding-system system)
2296 (message "Gopher coding system fixed to %s. (Reload to see effect)." system)
2297 (message "Gopher coding system set to autodetect. (Reload to see effect)."))))
2303 (defvar elpher-mode-map
2304 (let ((map (make-sparse-keymap)))
2305 (define-key map (kbd "TAB") 'elpher-next-link)
2306 (define-key map (kbd "<backtab>") 'elpher-prev-link)
2307 (define-key map (kbd "C-M-i") 'elpher-prev-link)
2308 (define-key map (kbd "u") 'elpher-back)
2309 (define-key map (kbd "-") 'elpher-back)
2310 (define-key map (kbd "^") 'elpher-back)
2311 (define-key map [mouse-3] 'elpher-back)
2312 (define-key map (kbd "U") 'elpher-back-to-start)
2313 (define-key map (kbd "g") 'elpher-go)
2314 (define-key map (kbd "o") 'elpher-go-current)
2315 (define-key map (kbd "O") 'elpher-root-dir)
2316 (define-key map (kbd "s") 'elpher-show-history)
2317 (define-key map (kbd "S") 'elpher-show-visited-pages)
2318 (define-key map (kbd "r") 'elpher-redraw)
2319 (define-key map (kbd "R") 'elpher-reload)
2320 (define-key map (kbd "T") 'elpher-toggle-tls)
2321 (define-key map (kbd ".") 'elpher-view-raw)
2322 (define-key map (kbd "d") 'elpher-download)
2323 (define-key map (kbd "D") 'elpher-download-current)
2324 (define-key map (kbd "m") 'elpher-jump)
2325 (define-key map (kbd "i") 'elpher-info-link)
2326 (define-key map (kbd "I") 'elpher-info-current)
2327 (define-key map (kbd "c") 'elpher-copy-link-url)
2328 (define-key map (kbd "C") 'elpher-copy-current-url)
2329 (define-key map (kbd "a") 'elpher-bookmark-link)
2330 (define-key map (kbd "A") 'elpher-bookmark-current)
2331 (define-key map (kbd "B") 'elpher-show-bookmarks)
2332 (define-key map (kbd "!") 'elpher-set-gopher-coding-system)
2333 (define-key map (kbd "F") 'elpher-forget-current-certificate)
2334 (when (fboundp 'evil-define-key*)
2337 (kbd "TAB") 'elpher-next-link
2338 (kbd "C-") 'elpher-follow-current-link
2339 (kbd "C-t") 'elpher-back
2340 (kbd "u") 'elpher-back
2341 (kbd "-") 'elpher-back
2342 (kbd "^") 'elpher-back
2343 [mouse-3] 'elpher-back
2344 (kbd "U") 'elpher-back-to-start
2345 (kbd "g") 'elpher-go
2346 (kbd "o") 'elpher-go-current
2347 (kbd "O") 'elpher-root-dir
2348 (kbd "s") 'elpher-show-history
2349 (kbd "S") 'elpher-show-visited-pages
2350 (kbd "r") 'elpher-redraw
2351 (kbd "R") 'elpher-reload
2352 (kbd "T") 'elpher-toggle-tls
2353 (kbd ".") 'elpher-view-raw
2354 (kbd "d") 'elpher-download
2355 (kbd "D") 'elpher-download-current
2356 (kbd "m") 'elpher-jump
2357 (kbd "i") 'elpher-info-link
2358 (kbd "I") 'elpher-info-current
2359 (kbd "c") 'elpher-copy-link-url
2360 (kbd "C") 'elpher-copy-current-url
2361 (kbd "a") 'elpher-bookmark-link
2362 (kbd "A") 'elpher-bookmark-current
2363 (kbd "B") 'elpher-show-bookmarks
2364 (kbd "!") 'elpher-set-gopher-coding-system
2365 (kbd "F") 'elpher-forget-current-certificate))
2367 "Keymap for gopher client.")
2369 (define-derived-mode elpher-mode special-mode "elpher"
2370 "Major mode for elpher, an elisp gopher client.
2372 This mode is automatically enabled by the interactive
2373 functions which initialize the client, namely
2374 `elpher', and `elpher-go'."
2375 (setq-local elpher--gemini-page-headings nil)
2376 (setq-local elpher-current-page nil)
2377 (setq-local elpher-history nil)
2378 (setq-local elpher-buffer-name (buffer-name))
2379 (setq-local bookmark-make-record-function #'elpher-bookmark-make-record)
2380 (setq-local imenu-create-index-function (lambda () elpher--gemini-page-headings))
2381 (setq-local xterm-color-preserve-properties t))
2383 (when (fboundp 'evil-set-initial-state)
2384 (evil-set-initial-state 'elpher-mode 'motion))
2387 ;;; Main start procedure
2391 (defun elpher (&optional arg)
2392 "Start elpher with default landing page.
2393 The buffer used for Elpher sessions is determined by the value of
2394 ‘elpher-buffer-name’. If there is already an Elpher session active in
2395 that buffer, Emacs will simply switch to it. Otherwise, a new session
2396 will begin. A numeric prefix ARG (as in ‘\\[universal-argument] 42
2397 \\[execute-extended-command] elpher RET’) switches to the session with
2398 that number, creating it if necessary. A non numeric prefix ARG means
2399 to create a new session. Returns the buffer selected (or created)."
2401 (let* ((name (default-value 'elpher-buffer-name))
2402 (buf (cond ((numberp arg)
2403 (get-buffer-create (format "%s<%d>" name arg)))
2405 (generate-new-buffer name))
2407 (get-buffer-create name)))))
2408 (pop-to-buffer-same-window buf)
2409 (unless (buffer-modified-p)
2411 (elpher-visit-page (elpher-make-start-page))
2412 "Started Elpher."))); Otherwise (elpher) evaluates to start page string.
2414 ;;; elpher.el ends here