X-Git-Url: https://thelambdalab.xyz/gitweb/index.cgi?p=elpher.git;a=blobdiff_plain;f=elpher.el;h=391bc8b54ad7e9515f3b86f9e289a2e51d234699;hp=0888870b9553bd77417b483f7f7bb4e61fdff3fb;hb=2cdf02e99dbd2d7f765c08ad2f8477b4ea07d5f7;hpb=643f0bc0617e043190bbcd55579f39902bb1cd91 diff --git a/elpher.el b/elpher.el index 0888870..391bc8b 100644 --- a/elpher.el +++ b/elpher.el @@ -5,6 +5,7 @@ ;; Copyright (C) 2021 Christopher Brannon ;; Copyright (C) 2021 Omar Polo ;; Copyright (C) 2021 Noodles! +;; Copyright (C) 2021 Abhiseck Paira ;; Copyright (C) 2020-2021 Alex Schroeder ;; Copyright (C) 2020 Zhiwei Chen ;; Copyright (C) 2020 condy0919 @@ -19,7 +20,7 @@ ;; Author: Tim Vaughan ;; Created: 11 April 2019 -;; Version: 3.0.0 +;; Version: 3.1.0 ;; Keywords: comm gopher ;; Homepage: https://thelambdalab.xyz/elpher ;; Package-Requires: ((emacs "27.1")) @@ -61,8 +62,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: @@ -73,38 +74,18 @@ ;; (require 'seq) -(require 'pp) (require 'shr) (require 'url-util) (require 'subr-x) -(require 'dns) (require 'nsm) (require 'gnutls) (require 'socks) - -;;; ANSI colors or XTerm colors - -(or (require 'xterm-color nil t) - (require 'ansi-color)) - -(defalias 'elpher-color-filter-apply - (if (fboundp 'xterm-color-filter) - (lambda (s) - (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 - 'ansi-color-apply) - "A function to apply ANSI escape sequences.") +(require 'bookmark) ;;; Global constants ;; -(defconst elpher-version "3.0.0" +(defconst elpher-version "3.1.0" "Current version of elpher.") (defconst elpher-margin-width 6 @@ -129,6 +110,7 @@ (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.") @@ -138,12 +120,16 @@ ;; (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 ansi-color-context) + (defvar bookmark-make-record-function) + (defvar mu4e~view-beginning-of-url-regexp) (defvar thing-at-point-uri-schemes) - (defvar mu4e~view-beginning-of-url-regexp)) + (defvar xterm-color-preserve-properties)) ;;; Customization group @@ -231,6 +217,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 @@ -389,11 +381,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) @@ -493,6 +480,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)) @@ -596,11 +588,13 @@ previously-visited pages,unless NO-HISTORY is non-nil." (defmacro elpher-with-clean-buffer (&rest args) "Evaluate ARGS with a clean *elpher* buffer as current." + (declare (debug (body))) ;; Allow edebug to step through body `(with-current-buffer elpher-buffer-name (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) @@ -643,6 +637,57 @@ away CRs and any terminating period." (elpher-decode (replace-regexp-in-string "\n\\.\n$" "\n" (replace-regexp-in-string "\r" "" string)))) +;;; Buttonify urls + +(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 buttonify URLs in text files loaded by elpher.") + +(defun elpher-buttonify-urls (string) + "Turn substrings which look like urls in STRING into clickable buttons." + (with-temp-buffer + (insert string) + (goto-char (point-min)) + (while (re-search-forward elpher-url-regex nil t) + (let ((page (elpher-make-page (substring-no-properties (match-string 0)) + (elpher-address-from-url (match-string 0))))) + (make-text-button (match-beginning 0) + (match-end 0) + 'elpher-page page + 'action #'elpher-click-link + 'follow-link t + 'help-echo #'elpher--page-button-help + 'face 'button))) + (buffer-string))) + +;;; ANSI colors or XTerm colors (application and filtering) + +(or (require 'xterm-color nil t) + (require 'ansi-color)) + +(defalias 'elpher-color-filter-apply + (if (fboundp 'xterm-color-filter) + (lambda (s) + (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 + #'ansi-color-apply) + "A function to apply ANSI escape sequences.") + +;;; Processing text for display + +(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." + (elpher-buttonify-urls (if elpher-filter-ansi-from-text + (elpher-color-filter-apply string) + (elpher-color-apply string)))) + ;;; Network error reporting ;; @@ -677,6 +722,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) + "Create 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. @@ -713,19 +767,7 @@ the host operating system and the local network capabilities.)" :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 - :family (and force-ipv4 'ipv4) - :service service - :buffer nil - :nowait t - :tls-parameters - (and use-tls - (cons 'gnutls-x509pki - (apply #'gnutls-boot-parameters - gnutls-params)))))) - (timer (run-at-time elpher-connection-timeout nil + (timer (elpher-make-network-timer (lambda () (elpher-process-cleanup) (cond @@ -747,7 +789,19 @@ the host operating system and the local network capabilities.)" response-processor nil force-ipv4)) (t - (elpher-network-error address "Connection time-out."))))))) + (elpher-network-error address "Connection time-out.")))))) + (proc (if socks (socks-open-network-stream "elpher-process" nil host service) + (make-network-process :name "elpher-process" + :host host + :family (and force-ipv4 'ipv4) + :service service + :buffer nil + :nowait t + :tls-parameters + (and use-tls + (cons 'gnutls-x509pki + (apply #'gnutls-boot-parameters + gnutls-params))))))) (setq elpher-network-timer timer) (set-process-coding-system proc 'binary 'binary) (set-process-query-on-exit-flag proc nil) @@ -804,6 +858,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"))))) @@ -1058,34 +1113,6 @@ If ADDRESS is not supplied or nil the record is rendered as an ;; Text rendering -(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 buttonify URLs in text files loaded by elpher.") - -(defun elpher-buttonify-urls (string) - "Turn substrings which look like urls in STRING into clickable buttons." - (with-temp-buffer - (insert string) - (goto-char (point-min)) - (while (re-search-forward elpher-url-regex nil t) - (let ((page (elpher-make-page (substring-no-properties (match-string 0)) - (elpher-address-from-url (match-string 0))))) - (make-text-button (match-beginning 0) - (match-end 0) - 'elpher-page page - 'action #'elpher-click-link - 'follow-link t - 'help-echo #'elpher--page-button-help - 'face 'button))) - (buffer-string))) - -(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." - (elpher-buttonify-urls (if elpher-filter-ansi-from-text - (elpher-color-filter-apply string) - (elpher-color-apply string)))) - (defun elpher-render-text (data &optional _mime-type-string) "Render DATA as text. MIME-TYPE-STRING is unused." (elpher-with-clean-buffer @@ -1457,7 +1484,6 @@ treatment that a separate function is warranted." (insert (propertize display-string 'face 'elpher-unknown))) (insert "\n")))) -;; buffer-local (defvar elpher--gemini-page-headings nil "List of headings on the page.") @@ -1648,12 +1674,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")) - (insert-text-button "Emacs bookmark list" + (let ((help-string "RET,mouse-1: Open bookmark list")) + (insert-text-button "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") @@ -1661,26 +1687,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))) @@ -1724,7 +1759,7 @@ This is rendered using `elpher-get-visited-pages-page' via `elpher-type-map'." (defun elpher-display-history-links (pages title) "Show all PAGES in an Elpher buffer with a given TITLE." - (let* ((title-line (concat "---- " title " ----")) + (let* ((title-line (concat " ---- " title " ----")) (footer-line (make-string (length title-line) ?-))) (elpher-with-clean-buffer (insert title-line "\n\n") @@ -1735,8 +1770,8 @@ This is rendered using `elpher-get-visited-pages-page' via `elpher-type-map'." (address (elpher-page-address page))) (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.") + (insert "\n " footer-line "\n" + "Select an entry or press 'u' to return to the previous page.") (elpher-restore-pos)))) @@ -1776,9 +1811,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. @@ -1801,7 +1846,6 @@ To bookmark the link at point use \\[elpher-bookmark-link]." (read-file-name "Old Elpher bookmarks: " user-emacs-directory nil t "elpher-bookmarks")))) - (require 'bookmark) (dolist (bookmark (with-temp-buffer (insert-file-contents file) (read (current-buffer)))) @@ -1813,10 +1857,38 @@ 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")) + (elpher-with-clean-buffer + (insert " ---- Elpher Bookmarks ---- \n\n") + (bookmark-maybe-load-default-file) + (dolist (bookmark (bookmark-maybe-sort-alist)) + (when (eq #'elpher-bookmark-jump (alist-get 'handler (cdr bookmark))) + (let* ((name (car bookmark)) + (url (alist-get 'location (cdr bookmark))) + (address (elpher-address-from-url url))) + (elpher-insert-index-record name address)))) + (when (<= (line-number-at-pos) 3) + (insert "No bookmarked pages found.\n")) + (insert "\n --------------------------\n\n" + "Select an entry or press 'u' to return to the previous page.\n\n" + "Bookmarks can be renamed or deleted via 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 + ",\nwhich can also be opened from anywhere using '\\[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) @@ -1827,7 +1899,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 @@ -1942,6 +2018,12 @@ supports the old protocol elpher, where the link is self-contained." (setq mu4e~view-beginning-of-url-regexp "\\(?:https?\\|gopher\\|finger\\|gemini\\)://\\|mailto:") +;;; eww: + +;; Let elpher handle gemini, gopher links in eww buffer. +(setq eww-use-browse-url + "\\`mailto:\\|\\(\\`gemini\\|\\`gopher\\|\\`finger\\)://") + ;;; Interactive procedures ;; @@ -2169,7 +2251,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*) @@ -2201,7 +2283,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) @@ -2218,7 +2300,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))