X-Git-Url: https://thelambdalab.xyz/gitweb/index.cgi?p=elpher.git;a=blobdiff_plain;f=elpher.el;h=705880fe64c7c0ae483b5678e276f262bc4ff1bb;hp=ed0b02ac4fcdc4cba9a4428eb9a7174cd859922d;hb=55796d20a00ce100595f52ce5c3c639e8ca3d187;hpb=5b5c1b1831b3f1ed8073a4e364c3d52c881b6b3b diff --git a/elpher.el b/elpher.el index ed0b02a..705880f 100644 --- a/elpher.el +++ b/elpher.el @@ -61,8 +61,8 @@ ;; Full instructions can be found in the Elpher info manual. ;; Elpher is under active development. Any suggestions for -;; improvements are welcome, and can be made on the official -;; project page, gopher://thelambdalab.xyz/elpher, or via the +;; improvements are welcome, and can be made on the official project +;; page, gopher://thelambdalab.xyz/1/projects/elpher, or via the ;; project mailing list at https://lists.sr.ht/~michel-slm/elpher. ;;; Code: @@ -92,13 +92,13 @@ (lambda (s) (let ((_xterm-color-render nil)) (xterm-color-filter s))) - 'ansi-color-filter-apply) + #'ansi-color-filter-apply) "A function to filter out ANSI escape sequences.") (defalias 'elpher-color-apply (if (fboundp 'xterm-color-filter) - 'xterm-color-filter - 'ansi-color-apply) + #'xterm-color-filter + #'ansi-color-apply) "A function to apply ANSI escape sequences.") ;;; Global constants @@ -129,29 +129,25 @@ (telnet elpher-get-telnet-page nil "tel" elpher-telnet) (other-url elpher-get-other-url-page nil "url" elpher-other-url) ((special start) elpher-get-start-page nil "E" elpher-index) + ((special bookmarks) elpher-get-bookmarks-page nil "E" elpher-index) ((special history) elpher-get-history-page nil "E" elpher-index) ((special visited-pages) elpher-get-visited-pages-page nil "E" elpher-index)) "Association list from types to getters, renderers, margin codes and index faces.") -;;; Internal variables -;; - -;; buffer-local -(defvar elpher--gemini-page-headings nil - "List of headings on the page.") - - ;;; Declarations to avoid compiler warnings. ;; (eval-when-compile - (defvar bookmark-make-record-function) + (declare-function ansi-color-filter-apply "ansi-color") + (declare-function ansi-color-apply "ansi-color") (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 ansi-color-context) + (defvar bookmark-make-record-function) + (defvar mu4e~view-beginning-of-url-regexp) + (defvar thing-at-point-uri-schemes)) ;;; Customization group @@ -239,6 +235,12 @@ 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-use-emacs-bookmark-menu nil + "If non-nil, elpher will only use the native Emacs bookmark menu. +Otherwise, \\[elpher-show-bookmarks] will visit a special elpher bookmark +page within which all of the standard elpher keybindings are active." + :type '(boolean)) + ;; Face customizations (defgroup elpher-faces nil @@ -397,11 +399,6 @@ requiring gopher-over-TLS." "Create an ADDRESS object corresponding to the given special address symbol TYPE." type) -(defun elpher-make-start-page () - "Create the start page." - (elpher-make-page "Elpher Start Page" - (elpher-make-special-address 'start))) - (defun elpher-address-to-url (address) "Get string representation of ADDRESS, or nil if ADDRESS is special." (if (elpher-address-special-p address) @@ -501,6 +498,11 @@ If no address is defined, returns 0. (This is for compatibility with the URL li "Create a page with DISPLAY-STRING and ADDRESS." (list display-string address)) +(defun elpher-make-start-page () + "Create the start page." + (elpher-make-page "Elpher Start Page" + (elpher-make-special-address 'start))) + (defun elpher-page-display-string (page) "Retrieve the display string corresponding to PAGE." (elt page 0)) @@ -608,7 +610,8 @@ previously-visited pages,unless NO-HISTORY is non-nil." (unless (eq major-mode 'elpher-mode) ;; avoid resetting buffer-local variables (elpher-mode)) - (let ((inhibit-read-only t)) + (let ((inhibit-read-only t) + (ansi-color-context nil)) ;; clean ansi interpreter state (setq-local network-security-level (default-value 'network-security-level)) (erase-buffer) @@ -685,6 +688,15 @@ ERROR can be either an error object or a string." (if (timerp elpher-network-timer) (cancel-timer elpher-network-timer))) +(defun elpher-make-network-timer (thunk) + "Creates a timer to run the THUNK after `elpher-connection-timeout' seconds. +This is just a wraper around `run-at-time' which additionally sets the +buffer-local variable `elpher-network-timer' to allow +`elpher-process-cleanup' to also clear the timer." + (let ((timer (run-at-time elpher-connection-timeout nil thunk))) + (setq-local elpher-network-timer timer) + timer)) + (defun elpher-get-host-response (address default-port query-string response-processor &optional use-tls force-ipv4) "Generic function for retrieving data from ADDRESS. @@ -711,13 +723,17 @@ the host operating system and the local network capabilities.)" (condition-case nil (let* ((kill-buffer-query-functions nil) (port (elpher-address-port address)) - (service (if (> port 0) port default-port)) (host (elpher-address-host address)) - (socks (or elpher-socks-always (string-suffix-p ".onion" host))) + (service (if (> port 0) port default-port)) (response-string-parts nil) (bytes-received 0) (hkbytes-received 0) - (timer (run-at-time elpher-connection-timeout nil + (socks (or elpher-socks-always (string-suffix-p ".onion" host))) + (gnutls-params (list :type 'gnutls-x509pki + :hostname host + :keylist + (elpher-get-current-keylist address))) + (timer (elpher-make-network-timer (lambda () (elpher-process-cleanup) (cond @@ -740,8 +756,6 @@ the host operating system and the local network capabilities.)" nil force-ipv4)) (t (elpher-network-error address "Connection time-out.")))))) - (gnutls-params (list :type 'gnutls-x509pki :hostname host - :keylist (elpher-get-current-keylist address))) (proc (if socks (socks-open-network-stream "elpher-process" nil host service) (make-network-process :name "elpher-process" :host host @@ -810,6 +824,7 @@ the host operating system and the local network capabilities.)" (if use-tls (apply #'gnutls-negotiate :process proc gnutls-params)) (funcall (process-sentinel proc) proc "open\n"))) (error + (elpher-process-cleanup) (error "Error initiating connection to server"))))) @@ -1066,7 +1081,7 @@ If ADDRESS is not supplied or nil the record is rendered as an (defconst elpher-url-regex "\\([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_~?/@|#-]\\)?\\)?" - "Regexp used to locate and buttinofy URLs in text files loaded by elpher.") + "Regexp used to locate and buttonify URLs in text files loaded by elpher.") (defun elpher-buttonify-urls (string) "Turn substrings which look like urls in STRING into clickable buttons." @@ -1085,9 +1100,6 @@ If ADDRESS is not supplied or nil the record is rendered as an 'face 'button))) (buffer-string))) -(defconst elpher-ansi-regex "\x1b\\[[^m]*m" - "Incomplete regexp used to strip out some troublesome ANSI escape sequences.") - (defun elpher-process-text-for-display (string) "Perform any desired processing of STRING prior to display as text. Currently includes buttonifying URLs and processing ANSI escape codes." @@ -1466,6 +1478,9 @@ treatment that a separate function is warranted." (insert (propertize display-string 'face 'elpher-unknown))) (insert "\n")))) +(defvar elpher--gemini-page-headings nil + "List of headings on the page.") + (defun elpher-gemini-insert-header (header-line) "Insert header described by HEADER-LINE into a text/gemini document. The gemini map file line describing the header is given @@ -1653,12 +1668,12 @@ The result is rendered using RENDERER." (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")) + (let ((help-string "RET,mouse-1: Open bookmark list")) (insert-text-button "Emacs bookmark list" 'face 'link 'action (lambda (_) (interactive) - (call-interactively #'elpher-open-bookmarks)) + (call-interactively #'elpher-show-bookmarks)) 'follow-link t 'help-echo help-string)) (insert ".\n") @@ -1666,26 +1681,35 @@ The result is rendered using RENDERER." "(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") + "The gopher home of the Elpher project is here:\n") (elpher-insert-index-record "The Elpher Project Page" (elpher-make-gopher-address ?1 "/projects/elpher/" "thelambdalab.xyz" 70)) - (insert "\n" - "** Refer to the ") (let ((help-string "RET,mouse-1: Open Elpher info manual (if available)")) - (insert-text-button "Elpher info manual" + (insert "\n" + "The following info documentation is available:\n" + " - ") + (insert-text-button "Elpher Manual" 'face 'link 'action (lambda (_) (interactive) (info "(elpher)")) 'follow-link t - 'help-echo help-string)) - (insert " for the full documentation. **\n") + 'help-echo help-string) + (insert "\n - ") + (insert-text-button "Changes introduced by the latest release" + 'face 'link + 'action (lambda (_) + (interactive) + (info "(elpher)News")) + 'follow-link t + 'help-echo help-string)) + (insert "\n") (insert (propertize - (concat " (This should be available if you have installed Elpher using\n" - " MELPA. Otherwise you will have to install the manual yourself.)\n") + (concat " (These documents should be available if you have installed Elpher \n" + " using MELPA. Otherwise you may have to install the manual yourself.)\n") 'face 'shadow)) (elpher-restore-pos))) @@ -1741,7 +1765,7 @@ This is rendered using `elpher-get-visited-pages-page' via `elpher-type-map'." (elpher-insert-index-record display-string address)))) (insert "No history items found.\n")) (insert "\n" footer-line "\n" - "Select and entry or press 'u' to return to the previous page.") + "Select an entry or press 'u' to return to the previous page.") (elpher-restore-pos)))) @@ -1781,9 +1805,19 @@ record for the current elpher page." ;;;###autoload (defun elpher-bookmark-jump (bookmark) - "Go to a particular BOOKMARK." - (let* ((url (cdr (assq 'location bookmark)))) - (elpher-go url))) + "Handler used to open a bookmark using elpher. +The argument BOOKMARK is a bookmark record passed to the function. +This handler is responsible for loading the bookmark in some buffer, +then making that buffer the current buffer. It should not switch +to the buffer." + (let* ((url (cdr (assq 'location bookmark))) + (cleaned-url (string-trim url)) + (address (elpher-address-from-url cleaned-url)) + (page (elpher-make-page cleaned-url address))) + (elpher-with-clean-buffer + (elpher-visit-page page)) + (set-buffer (get-buffer elpher-buffer-name)) + nil)) (defun elpher-bookmark-link () "Bookmark the link at point. @@ -1818,10 +1852,40 @@ To bookmark the link at point use \\[elpher-bookmark-link]." (bookmark-store display-string (cdr record) t))) (bookmark-save)) -(defun elpher-open-bookmarks () +(defun elpher-get-bookmarks-page (renderer) + "Getter which displays the history page (RENDERER must be nil)." + (when renderer + (elpher-visit-previous-page) + (error "Command not supported for bookmarks page")) + (let* ((names (seq-filter (lambda (name) + (let ((record (bookmark-get-bookmark-record name))) + (eq (alist-get 'handler record) 'elpher-bookmark-jump))) + (bookmark-all-names)))) + (elpher-with-clean-buffer + (insert " ---- Elpher Bookmarks ---- \n\n") + (if names + (dolist (name (sort names #'string<)) + (when names + (let* ((url (alist-get 'location (bookmark-get-bookmark-record name))) + (address (elpher-address-from-url url))) + (elpher-insert-index-record name address)))) + (insert "No bookmarked pages found.\n")) + (insert "\n --------------------------\n\n" + "Select an entry or press 'u' to return to the previous page.\n\n") + (insert "To rename or delete bookmark entries, open your bookmark list\n" + "using the ") + (insert-text-button "Emacs bookmark menu" + 'action (lambda (_) + (interactive) + (call-interactively #'bookmark-bmenu-list)) + 'follow-link t + 'help-echo "RET,mouse-1: open Emacs bookmark menu") + (insert (substitute-command-keys " via '\\[bookmark-bmenu-list]'.")) + (elpher-restore-pos)))) + +(defun elpher-show-bookmarks () "Display the current list of elpher bookmarks. -This is just a call to `bookmark-bmenu-list', but we also check for a legacy -bookmark file and offer to import it." +This will also check for a legacy bookmark file and offer to import it." (interactive) (let ((old-bookmarks-file (or (and (boundp 'elpher-bookmarks-file) elpher-bookmarks-file) @@ -1832,7 +1896,11 @@ bookmark file and offer to import it." "\" found. Import now?"))) (elpher-bookmark-import old-bookmarks-file) (rename-file old-bookmarks-file (concat old-bookmarks-file "-legacy")))) - (call-interactively #'bookmark-bmenu-list)) + (if elpher-use-emacs-bookmark-menu + (call-interactively #'bookmark-bmenu-list) + (elpher-visit-page + (elpher-make-page "Elpher Bookmarks" + (elpher-make-special-address 'bookmarks))))) ;;; Integrations @@ -2174,7 +2242,7 @@ When run interactively HOST-OR-URL is read from the minibuffer." (define-key map (kbd "C") 'elpher-copy-current-url) (define-key map (kbd "a") 'elpher-bookmark-link) (define-key map (kbd "A") 'elpher-bookmark-current) - (define-key map (kbd "B") 'elpher-open-bookmarks) + (define-key map (kbd "B") 'elpher-show-bookmarks) (define-key map (kbd "!") 'elpher-set-gopher-coding-system) (define-key map (kbd "F") 'elpher-forget-current-certificate) (when (fboundp 'evil-define-key*) @@ -2206,7 +2274,7 @@ When run interactively HOST-OR-URL is read from the minibuffer." (kbd "C") 'elpher-copy-current-url (kbd "a") 'elpher-bookmark-link (kbd "A") 'elpher-bookmark-current - (kbd "B") 'elpher-open-bookmarks + (kbd "B") 'elpher-show-bookmarks (kbd "!") 'elpher-set-gopher-coding-system (kbd "F") 'elpher-forget-current-certificate)) map) @@ -2223,7 +2291,8 @@ 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 (lambda () elpher--gemini-page-headings))) + (setq-local imenu-create-index-function (lambda () elpher--gemini-page-headings)) + (setq-local xterm-color-preserve-properties t)) (when (fboundp 'evil-set-initial-state) (evil-set-initial-state 'elpher-mode 'motion))