X-Git-Url: https://thelambdalab.xyz/gitweb/index.cgi?p=elpher.git;a=blobdiff_plain;f=elpher.el;h=29d2e2b59196c0e66a4ab639b8cb83a019dfe0da;hp=883bde8db02ba45545a1d2e74553d2532d5863e7;hb=0bf20003c52c7f2d1f78c289efa71634c8fae254;hpb=3eb647d059c6cb5b18ba3a931587c7000ef1b39e diff --git a/elpher.el b/elpher.el index 883bde8..29d2e2b 100644 --- a/elpher.el +++ b/elpher.el @@ -15,13 +15,13 @@ ;; Copyright (C) 2020 Koushk Roy ;; Copyright (C) 2020 Vee ;; Copyright (C) 2020 Simon South -;; Copyright (C) 2019-2020 Tim Vaughan +;; Copyright (C) 2019-2021 Tim Vaughan ;; Author: Tim Vaughan ;; Created: 11 April 2019 ;; Version: 2.11.0 ;; Keywords: comm gopher -;; Homepage: https://alexschroeder.ch/cgit/elpher +;; Homepage: https://thelambdalab.xyz/elpher ;; Package-Requires: ((emacs "27.1")) ;; This file is not part of GNU Emacs. @@ -62,7 +62,8 @@ ;; Elpher is under active development. Any suggestions for ;; improvements are welcome, and can be made on the official -;; project page, https://alexschroeder.ch/cgit/elpher. +;; project page, gopher://thelambdalab.xyz/elpher, or via the +;; project mailing list at https://lists.sr.ht/~michel-slm/elpher. ;;; Code: @@ -89,10 +90,11 @@ (defalias 'elpher-color-filter-apply (if (fboundp 'xterm-color-filter) (lambda (s) - (let ((xterm-color-render nil)) + (let ((_xterm-color-render nil)) (xterm-color-filter s))) 'ansi-color-filter-apply) "A function to filter out ANSI escape sequences.") + (defalias 'elpher-color-apply (if (fboundp 'xterm-color-filter) 'xterm-color-filter @@ -139,11 +141,17 @@ (defvar elpher--gemini-page-headings nil "List of headings on the page.") -(defvar elpher--gemini-page-links nil - "List of links on the page.") +;;; Declarations to avoid compiler warnings. +;; + +(eval-when-compile + (defvar bookmark-make-record-function) + (declare-function bookmark-store "bookmark") + (declare-function org-link-store-props "ol") + (declare-function org-link-set-parameters "ol") + (defvar thing-at-point-uri-schemes) + (defvar mu4e~view-beginning-of-url-regexp)) -(defvar elpher--gemini-page-links-cache (make-hash-table :test 'equal) - "Hash of addresses and page links.") ;;; Customization group ;; @@ -230,9 +238,9 @@ some servers which do not support IPv6 can take a long time to time-out." Otherwise, the SOCKS proxy is only used for connections to onion services." :type '(boolean)) -(defcustom elpher-gemini-number-links nil - "If non-nil, number links in gemini pages when rendering. -Links can be accessed by pressing `v' ('visit') followed by the link number." +(defcustom elpher-number-links nil + "If non-nil, number links in pages when rendering. +Links can be followed numerically by pressing `M' and entering by the link number." :type '(boolean)) ;; Face customizations @@ -330,8 +338,6 @@ Links can be accessed by pressing `v' ('visit') followed by the link number." (let ((url (url-generic-parse-url url-string))) (unless (and (not (url-fullness url)) (url-type url)) (setf (url-fullness url) t) - (setf (url-filename url) - (url-unhex-string (url-filename url))) (unless (url-type url) (setf (url-type url) elpher-default-url-type)) (unless (url-host url) @@ -438,7 +444,7 @@ address refers to, via the table `elpher-type-map'." For gopher addresses this is a combination of the selector type and selector." (if (symbolp address) nil - (url-filename address))) + (url-unhex-string (url-filename address)))) (defun elpher-address-host (address) "Retrieve host from ADDRESS object." @@ -462,7 +468,7 @@ If no address is defined, returns 0. (This is for compatibility with the URL li (defun elpher-address-gopher-p (address) "Return non-nill if ADDRESS object is a gopher address." (and (not (elpher-address-special-p address)) - (member (elpher-address-protocol address) '("gopher gophers")))) + (member (elpher-address-protocol address) '("gopher" "gophers")))) (defun elpher-gopher-address-selector (address) "Retrieve gopher selector from ADDRESS object." @@ -529,6 +535,7 @@ Additionally, push PAGE onto the stack of previously-visited pages, unless NO-HISTORY is non-nil." (elpher-save-pos) (elpher-process-cleanup) + (elpher-reset-link-number-counter) (unless (or no-history (equal (elpher-page-address elpher-current-page) (elpher-page-address page))) @@ -537,17 +544,12 @@ unless NO-HISTORY is non-nil." (setq-local elpher-current-page page) (let* ((address (elpher-page-address page)) (type (elpher-address-type address)) - (type-record (cdr (assoc type elpher-type-map))) - (page-links nil)) + (type-record (cdr (assoc type elpher-type-map)))) (if type-record - (progn - (funcall (car type-record) - (if renderer - renderer - (cadr type-record))) - (setq page-links (gethash address elpher--gemini-page-links-cache)) - (if page-links - (setq elpher--gemini-page-links page-links))) + (funcall (car type-record) + (if renderer + renderer + (cadr type-record))) (elpher-visit-previous-page) (pcase type (`(gopher ,type-char) @@ -700,7 +702,7 @@ unless `elpher-gemini-TLS-cert-checks' is non-nil. If non-nil, FORCE-IPV4 causes the network connection to be made over ipv4 only. (The default behaviour when this is not set depends on -the host operating system and the local network capabilities." +the host operating system and the local network capabilities.)" (if (and use-tls (not (gnutls-available-p))) (error "Use of TLS requires Emacs to be compiled with GNU TLS support") (unless (< (elpher-address-port address) 65536) @@ -1017,6 +1019,24 @@ displayed. The _WINDOW argument is currently unused." address (elpher-address-to-url address)))))))) +(defvar elpher--link-number-counter 0 + "Used to number links on elpher pages.") +(defun elpher-reset-link-number-counter () + "Reset the link number counter." + (setq-local elpher--link-number-counter 0)) + +(defun elpher--insert-text-button (label &rest properties) + "Insert a potentially-numbered button into the current buffer. +The text for the button is provided by LABEL, while the button +properties in PROPERTIES are as per `insert-text-button'." + + (if elpher-number-links + (setq-local elpher--link-number-counter (+ elpher--link-number-counter 1))) + (let ((pref (if elpher-number-links + (concat "[" (number-to-string elpher--link-number-counter) "] ") + ""))) + (apply #'insert-text-button (cons (concat pref label) properties)))) + (defun elpher-insert-index-record (display-string &optional address) "Function to insert an index record into the current buffer. The contents of the record are dictated by DISPLAY-STRING and ADDRESS. @@ -1030,12 +1050,12 @@ If ADDRESS is not supplied or nil the record is rendered as an (filtered-display-string (elpher-color-filter-apply display-string)) (page (elpher-make-page filtered-display-string address))) (elpher-insert-margin margin-code) - (insert-text-button filtered-display-string - 'face face - 'elpher-page page - 'action #'elpher-click-link - 'follow-link t - 'help-echo #'elpher--page-button-help)) + (elpher--insert-text-button filtered-display-string + 'face face + 'elpher-page page + 'action #'elpher-click-link + 'follow-link t + 'help-echo #'elpher--page-button-help)) (pcase type ('nil ;; Information (elpher-insert-margin) @@ -1282,10 +1302,15 @@ that the response was malformed." (error "Gemini server response unknown: %s %s" response-code response-meta)))))) -(unless (fboundp 'read-answer) - (defun read-answer (question answers) - "Backfill for the new read-answer code." - (completing-read question (mapcar 'identity answers)))) +(defun elpher--read-answer-polyfill (question answers) + "Polyfill for `read-answer' in Emacs 26.1. +QUESTION is a string containing a question, and ANSWERS +is a list of possible answers." + (completing-read question (mapcar 'identity answers))) + +(if (fboundp 'read-answer) + (defalias 'elpher-read-answer 'read-answer) + (defalias 'elpher-read-answer 'elpher--read-answer-polyfill)) (defun elpher-choose-client-certificate () "Prompt for a client certificate to use to establish a TLS connection." @@ -1446,19 +1471,18 @@ treatment that a separate function is warranted." (address (elpher-address-from-gemini-url url)) (type (if address (elpher-address-type address) nil)) (type-map-entry (cdr (assoc type elpher-type-map)))) - (setq elpher--gemini-page-links (append elpher--gemini-page-links `(,address))) (when display-string (insert elpher-gemini-link-string) (if type-map-entry (let* ((face (elt type-map-entry 3)) (filtered-display-string (elpher-color-filter-apply display-string)) (page (elpher-make-page filtered-display-string address))) - (insert-text-button filtered-display-string - 'face face - 'elpher-page page - 'action #'elpher-click-link - 'follow-link t - 'help-echo #'elpher--page-button-help)) + (elpher--insert-text-button filtered-display-string + 'face face + 'elpher-page page + 'action #'elpher-click-link + 'follow-link t + 'help-echo #'elpher--page-button-help)) (insert (propertize display-string 'face 'elpher-unknown))) (insert "\n")))) @@ -1516,11 +1540,9 @@ width defined by `elpher-gemini-max-fill-width'." "Render DATA as a gemini map file, PARAMETERS is currently unused." (elpher-with-clean-buffer (setq elpher--gemini-page-headings nil) - (let ((preformatted nil) - (link-counter 1)) + (let ((preformatted nil)) (auto-fill-mode 1) (setq-local fill-column (min (window-width) elpher-gemini-max-fill-width)) - (setq elpher--gemini-page-links '()) (dolist (line (split-string data "\n")) (cond ((string-prefix-p "```" line) (setq preformatted (not preformatted))) @@ -1528,25 +1550,13 @@ width defined by `elpher-gemini-max-fill-width'." (propertize line 'face 'elpher-gemini-preformatted)) "\n")) ((string-prefix-p "=>" line) - (progn - (if elpher-gemini-number-links - (insert - (concat - "[" - (number-to-string link-counter) - "] "))) - (setq link-counter (1+ link-counter)) - (elpher-gemini-insert-link line))) + (elpher-gemini-insert-link line)) ((string-prefix-p "#" line) (elpher-gemini-insert-header line)) (t (elpher-gemini-insert-text line))))) (setq elpher--gemini-page-headings (nreverse elpher--gemini-page-headings)) (elpher-cache-content (elpher-page-address elpher-current-page) - (buffer-string)) - (puthash - (elpher-page-address elpher-current-page) - elpher--gemini-page-links - elpher--gemini-page-links-cache))) + (buffer-string)))) (defun elpher-render-gemini-plain-text (data _parameters) "Render DATA as plain text file. PARAMETERS is currently unused." @@ -1633,20 +1643,19 @@ The result is rendered using RENDERER." "\n" " - TAB/Shift-TAB: next/prev item on current page\n" " - RET/mouse-1: open item under cursor\n" - " - m: select an item on current page by name (autocompletes)\n" + " - m/M: select an item on current page by name (autocompletes) or number\n" " - u/mouse-3/U: return to previous page or to the start page\n" " - o/O: visit different selector or the root menu of the current server\n" " - g: go to a particular address (gopher, gemini, finger)\n" - " - v: visit a numbered link on a gemini page\n" " - d/D: download item under cursor or current page\n" " - i/I: info on item under cursor or current page\n" " - c/C: copy URL representation of item under cursor or current page\n" " - a/A: bookmark the item under cursor or current page\n" " - B: list all bookmarks\n" - " - h/H: show history of current buffer or for all buffers\n" + " - s/S: show history of current buffer or for all buffers\n" " - r: redraw current page (using cached contents if available)\n" " - R: reload current page (regenerates cache)\n" - " - S: set character coding system for gopher (default is to autodetect)\n" + " - !: set character coding system for gopher (default is to autodetect)\n" " - T: toggle TLS gopher mode\n" " - F: forget/discard current TLS client certificate\n" " - .: display the raw server response for the current page\n" @@ -1662,6 +1671,20 @@ The result is rendered using RENDERER." (elpher-make-gopher-address ?7 "/v2/vs" "gopher.floodgap.com" 70)) (elpher-insert-index-record "Gemini Search Engine (geminispace.info)" (elpher-address-from-url "gemini://geminispace.info/search")) + (insert "\n" + "Your bookmarks are stored in your ") + (let ((help-string "RET,mouse-1: Open Emacs bookmark list")) + (elpher--insert-text-button "Emacs bookmark list" + 'face 'link + 'action (lambda (_) + (interactive) + (call-interactively #'bookmark-bmenu-list)) + 'follow-link t + 'help-echo help-string)) + (insert ".\n") + (insert (propertize + "(Bookmarks from legacy elpher-bookmarks files will be automatically imported.)\n" + 'face 'shadow)) (insert "\n" "For Elpher release news or to leave feedback, visit:\n") (elpher-insert-index-record "The Elpher Project Page" @@ -1672,13 +1695,13 @@ The result is rendered using RENDERER." (insert "\n" "** Refer to the ") (let ((help-string "RET,mouse-1: Open Elpher info manual (if available)")) - (insert-text-button "Elpher info manual" - 'face 'link - 'action (lambda (_) - (interactive) - (info "(elpher)")) - 'follow-link t - 'help-echo help-string)) + (elpher--insert-text-button "Elpher info manual" + 'face 'link + 'action (lambda (_) + (interactive) + (info "(elpher)")) + 'follow-link t + 'help-echo help-string)) (insert " for the full documentation. **\n") (insert (propertize (concat " (This should be available if you have installed Elpher using\n" @@ -1689,8 +1712,8 @@ The result is rendered using RENDERER." ;; History page retrieval (defun elpher-history () - "Show the history of pages leading to the current page -in this buffer. Use \\[elpher-history-all] to see the entire history. + "Show the history of pages leading to the current page in this buffer. +Use \\[elpher-history-all] to see the entire history. This is rendered using `elpher-get-history-page' via `elpher-type-map'." (interactive) (elpher-visit-page @@ -1702,7 +1725,7 @@ This is rendered using `elpher-get-history-page' via `elpher-type-map'." Use \\[elpher-history] to see just the history for the current buffer. This is rendered using `elpher-get-history-all-page' via `elpher-type-map'." (interactive) - (elpher-visit-page + (elpher-visit-page (elpher-make-page "Elpher History Of All Seen Pages" (elpher-make-special-address 'history-all)))) @@ -1723,13 +1746,16 @@ This is rendered using `elpher-get-history-all-page' via `elpher-type-map'." (defun elpher-show-history (pages) "Show all PAGES in the Elpher buffer." (elpher-with-clean-buffer + (insert "---- Visited link history ----\n\n") (if pages (dolist (page pages) (when page (let ((display-string (elpher-page-display-string page)) (address (elpher-page-address page))) (elpher-insert-index-record display-string address)))) - (insert "No history items found.\n")))) + (insert "No history items found.\n")) + (insert "\n----------------------------"))) + ;;; Bookmarks @@ -1747,7 +1773,7 @@ and \\[elpher-set-bookmark-no-overwrite] do the same thing.") (defun elpher-bookmark-make-record () "Return a bookmark record. If `elpher-bookmark-link' is non-nil and point is on a link button, -return a bookmark record for that link. Otherwise, return a bookmark +return a bookmark record for that link. Otherwise, return a bookmark record for the current elpher page." (let* ((button (and elpher-bookmark-link (button-at (point)))) (page (if button @@ -1779,7 +1805,7 @@ To bookmark the current page, use \\[bookmark-set-no-overwrite]." (bookmark-set-no-overwrite))) (defun elpher-bookmark-import (file) - "Import Elpher bookmarks into Emacs bookmarks." + "Import Elpher bookmarks file FILE into Emacs bookmarks." (interactive (list (if (and (boundp 'elpher-bookmarks-file) (file-readable-p elpher-bookmarks-file)) elpher-bookmarks-file @@ -1803,11 +1829,6 @@ To bookmark the current page, use \\[bookmark-set-no-overwrite]." ;;; Org -;; Avoid byte compilation warnings. -(eval-when-compile - (declare-function org-link-store-props "ol") - (declare-function org-link-set-parameters "ol")) - (defun elpher-org-export-link (link description format protocol) "Export a LINK with DESCRIPTION for the given PROTOCOL and FORMAT. @@ -1851,7 +1872,8 @@ supports the old protocol elpher, where the link is self-contained." (format "%s:%s" protocol link)))) (elpher-go url))) -(with-eval-after-load 'org +(defun elpher-org-mode-integration () + "Set up `elpher' integration for `org-mode'." (org-link-set-parameters "elpher" :store #'elpher-org-store-link @@ -1874,11 +1896,9 @@ supports the old protocol elpher, where the link is self-contained." (elpher-org-export-link link description format "finger")) :follow (lambda (link _arg) (elpher-org-follow-link link "finger")))) -;;; Browse URL +(add-hook 'org-mode-hook #'elpher-org-mode-integration) -;; Avoid byte compilation warnings. -(eval-when-compile - (defvar thing-at-point-uri-schemes)) +;;; Browse URL ;;;###autoload (defun elpher-browse-url-elpher (url &rest _args) @@ -1912,13 +1932,9 @@ supports the old protocol elpher, where the link is self-contained." ;;; Mu4e: -(eval-when-compile - (defvar mu4e~view-beginning-of-url-regexp)) - -(with-eval-after-load 'mu4e-view - ;; Make mu4e aware of the gemini world - (setq mu4e~view-beginning-of-url-regexp - "\\(?:https?\\|gopher\\|finger\\|gemini\\)://\\|mailto:")) +;; Make mu4e aware of the gemini world +(setq mu4e~view-beginning-of-url-regexp + "\\(?:https?\\|gopher\\|finger\\|gemini\\)://\\|mailto:") ;;; Interactive procedures ;; @@ -1960,15 +1976,6 @@ When run interactively HOST-OR-URL is read from the minibuffer." (elpher-address-to-url address))))) (elpher-visit-page (elpher-make-page url (elpher-address-from-url url)))))) -(defun elpher-visit-gemini-numbered-link (n) - "Visit link designated by a number N." - (interactive "nLink number: ") - (if (or (> n (length elpher--gemini-page-links)) - (< n 1)) - (user-error "Invalid link number")) - (let ((address (nth (1- n) elpher--gemini-page-links))) - (elpher-go (url-recreate-url address)))) - (defun elpher-redraw () "Redraw current page." (interactive) @@ -2057,6 +2064,17 @@ When run interactively HOST-OR-URL is read from the minibuffer." (goto-char (button-start b)) (button-activate b))))))) +(defun elpher-jump-to-number (n) + "Jump to directory entry number N." + (interactive "nDirectory item/link number: ") + (let* ((link-map (reverse (elpher-build-link-map)))) + (if link-map + (if (<= 1 n (length link-map)) + (let ((b (cdr (elt link-map (- n 1))))) + (goto-char (button-start b)) + (button-activate b)) + (error "No link with that number"))))) + (defun elpher-root-dir () "Visit root of current server." (interactive) @@ -2134,13 +2152,15 @@ When run interactively HOST-OR-URL is read from the minibuffer." (define-key map (kbd "") 'elpher-prev-link) (define-key map (kbd "C-M-i") 'elpher-prev-link) (define-key map (kbd "u") 'elpher-back) - (define-key map (kbd "U") 'elpher-back-to-start) + (define-key map (kbd "-") 'elpher-back) + (define-key map (kbd "^") 'elpher-back) (define-key map [mouse-3] 'elpher-back) + (define-key map (kbd "U") 'elpher-back-to-start) (define-key map (kbd "O") 'elpher-root-dir) (define-key map (kbd "g") 'elpher-go) (define-key map (kbd "o") 'elpher-go-current) - (define-key map (kbd "h") 'elpher-history) - (define-key map (kbd "H") 'elpher-history-all) + (define-key map (kbd "s") 'elpher-history) + (define-key map (kbd "S") 'elpher-history-all) (define-key map (kbd "r") 'elpher-redraw) (define-key map (kbd "R") 'elpher-reload) (define-key map (kbd "T") 'elpher-toggle-tls) @@ -2148,6 +2168,7 @@ When run interactively HOST-OR-URL is read from the minibuffer." (define-key map (kbd "d") 'elpher-download) (define-key map (kbd "D") 'elpher-download-current) (define-key map (kbd "m") 'elpher-jump) + (define-key map (kbd "M") 'elpher-jump-to-number) (define-key map (kbd "i") 'elpher-info-link) (define-key map (kbd "I") 'elpher-info-current) (define-key map (kbd "c") 'elpher-copy-link-url) @@ -2155,9 +2176,8 @@ When run interactively HOST-OR-URL is read from the minibuffer." (define-key map (kbd "a") 'elpher-set-bookmark-no-overwrite) (define-key map (kbd "A") 'bookmark-set-no-overwrite) (define-key map (kbd "B") 'bookmark-bmenu-list) - (define-key map (kbd "S") 'elpher-set-gopher-coding-system) + (define-key map (kbd "!") 'elpher-set-gopher-coding-system) (define-key map (kbd "F") 'elpher-forget-current-certificate) - (define-key map (kbd "v") 'elpher-visit-gemini-numbered-link) (when (fboundp 'evil-define-key*) (evil-define-key* 'motion map @@ -2167,8 +2187,8 @@ When run interactively HOST-OR-URL is read from the minibuffer." (kbd "u") 'elpher-back (kbd "-") 'elpher-back (kbd "^") 'elpher-back - (kbd "U") 'elpher-back-to-start [mouse-3] 'elpher-back + (kbd "U") 'elpher-back-to-start (kbd "o") 'elpher-go (kbd "O") 'elpher-go-current (kbd "r") 'elpher-redraw @@ -2177,7 +2197,8 @@ When run interactively HOST-OR-URL is read from the minibuffer." (kbd ".") 'elpher-view-raw (kbd "d") 'elpher-download (kbd "D") 'elpher-download-current - (kbd "J") 'elpher-jump + (kbd "m") 'elpher-jump + (kbd "M") 'elpher-jump-to-number (kbd "i") 'elpher-info-link (kbd "I") 'elpher-info-current (kbd "c") 'elpher-copy-link-url @@ -2185,9 +2206,8 @@ When run interactively HOST-OR-URL is read from the minibuffer." (kbd "a") 'elpher-set-bookmark-no-overwrite (kbd "A") 'bookmark-set-no-overwrite (kbd "B") 'bookmark-bmenu-list - (kbd "S") 'elpher-set-gopher-coding-system - (kbd "F") 'elpher-forget-current-certificate - (kbd "v") 'elpher-visit-gemini-numbered-link)) + (kbd "!") 'elpher-set-gopher-coding-system + (kbd "F") 'elpher-forget-current-certificate)) map) "Keymap for gopher client.") @@ -2202,7 +2222,7 @@ functions which initialize the client, namely (setq-local elpher-history nil) (setq-local elpher-buffer-name (buffer-name)) (setq-local bookmark-make-record-function #'elpher-bookmark-make-record) - (setq-local imenu-create-index-function #'elpher--gemini-page-headings)) + (setq-local imenu-create-index-function (lambda () elpher--gemini-page-headings))) (when (fboundp 'evil-set-initial-state) (evil-set-initial-state 'elpher-mode 'motion))