X-Git-Url: https://thelambdalab.xyz/gitweb/index.cgi?p=elpher.git;a=blobdiff_plain;f=elpher.el;h=a265a8f620e708b88191ba5f8e5066502d457757;hp=c0032487a2411ee3ae3133670069892e1f143f8a;hb=90dccbb77785412fd5e40c31c1659b6ed0442689;hpb=545af85cbcb053783ccce78128da2afc8cbc94c4 diff --git a/elpher.el b/elpher.el index c003248..a265a8f 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 @@ -15,13 +16,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 +;; Version: 3.2.2 ;; 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. @@ -50,7 +51,6 @@ ;; - caching of visited sites, ;; - pleasant and configurable colouring of Gopher directories, ;; - direct visualisation of image files, -;; - a simple bookmark management system, ;; - gopher connections using TLS encryption, ;; - the fledgling Gemini protocol, ;; - the greybeard Finger protocol. @@ -62,8 +62,9 @@ ;; 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, https://alexschroeder.ch/cgit/elpher. +;; 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,37 +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 "2.11.0" +(defconst elpher-version "3.2.2" "Current version of elpher.") (defconst elpher-margin-width 6 @@ -127,23 +109,30 @@ (finger elpher-get-finger-page elpher-render-text "txt" elpher-text) (telnet elpher-get-telnet-page nil "tel" elpher-telnet) (other-url elpher-get-other-url-page nil "url" elpher-other-url) - ((special bookmarks) elpher-get-bookmarks-page nil "/" elpher-index) - ((special start) elpher-get-start-page nil)) + (file elpher-get-file-page nil "~" elpher-gemini) + ((about welcome) elpher-get-welcome-page nil "E" elpher-index) + ((about bookmarks) elpher-get-bookmarks-page nil "E" elpher-index) + ((about history) elpher-get-history-page nil "E" elpher-index) + ((about 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 +;;; Declarations to avoid compiler warnings. ;; -;; buffer-local -(defvar elpher--gemini-page-headings nil - "List of headings on the page.") - -(defvar elpher--gemini-page-links nil - "List of links on the page.") +(eval-when-compile + (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 eww-use-browse-url) + (defvar thing-at-point-uri-schemes) + (defvar xterm-color-preserve-properties)) -(defvar elpher--gemini-page-links-cache (make-hash-table :test 'equal) - "Hash of addresses and page links.") ;;; Customization group ;; @@ -156,7 +145,7 @@ (defcustom elpher-open-urls-with-eww nil "If non-nil, open URL selectors using eww. -Otherwise, use the system browser via the BROWSE-URL function." +Otherwise, use the system browser via the `browse-url' function." :type '(boolean)) (defcustom elpher-use-header t @@ -219,10 +208,6 @@ May be empty." "Specify the string used for bullets when rendering gemini maps." :type '(string)) -(defcustom elpher-bookmarks-file (locate-user-emacs-file "elpher-bookmarks") - "Specify the name of the file where elpher bookmarks will be saved." - :type '(file)) - (defcustom elpher-ipv4-always nil "If non-nil, elpher will always use IPv4 to establish network connections. This can be useful when browsing from a computer that supports IPv6, because @@ -234,11 +219,23 @@ 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-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)) +(defcustom elpher-start-page-url "about:welcome" + "Specify the page displayed initially by elpher. +The default welcome screen is \"about:welcome\", while the bookmarks list +is \"about:bookmarks\". You can also specify local files via \"file:\". + +Beware that using \"about:bookmarks\" as a start page in combination with +the `elpher-use-bookmark-menu' variable set to non-nil will prevent the +Emacs bookmark menu being accessible via \\[elpher-show-bookmarks] from +the start page." + :type '(string)) + ;; Face customizations (defgroup elpher-faces nil @@ -323,21 +320,21 @@ Links can be accessed by pressing `v' ('visit') followed by the link number." ;; Address ;; An elpher "address" object is either a url object or a symbol. -;; Symbol addresses are "special", corresponding to pages generated +;; Addresses with the "about" type, corresponding to pages generated ;; dynamically for and by elpher. All others represent pages which ;; rely on content retrieved over the network. -(defun elpher-address-from-url (url-string) - "Create a ADDRESS object corresponding to the given URL-STRING." +(defun elpher-address-from-url (url-string &optional default-scheme) + "Create a ADDRESS object corresponding to the given URL-STRING. +If DEFAULT-SCHEME is non-nil, this sets the scheme of the URL when one +is not explicitly given." (let ((data (match-data))) ; Prevent parsing clobbering match data (unwind-protect (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)) + (setf (url-type url) default-scheme)) (unless (url-host url) (let ((p (split-string (url-filename url) "/" nil nil))) (setf (url-host url) (car p)) @@ -345,6 +342,8 @@ Links can be accessed by pressing `v' ('visit') followed by the link number." (if (cdr p) (concat "/" (mapconcat #'identity (cdr p) "/")) "")))) + (when (url-host url) + (setf (url-host url) (puny-encode-domain (url-host url)))) (when (or (equal "gopher" (url-type url)) (equal "gophers" (url-type url))) ;; Gopher defaults @@ -362,7 +361,7 @@ Links can be accessed by pressing `v' ('visit') followed by the link number." "Remove redundant port specifiers from ADDRESS. Here 'redundant' means that the specified port matches the default for that protocol, eg 70 for gopher." - (if (and (not (elpher-address-special-p address)) + (if (and (not (elpher-address-about-p address)) (eq (url-portspec address) ; (url-port) is too slow! (pcase (url-type address) ("gemini" 1965) @@ -395,49 +394,48 @@ requiring gopher-over-TLS." "/" (string type) selector))))) -(defun elpher-make-special-address (type) - "Create an ADDRESS object corresponding to the given special address symbol TYPE." - type) +(defun elpher-make-about-address (type) + "Create an ADDRESS object corresponding to the given about address TYPE." + (elpher-address-from-url (concat "about:" (symbol-name type)))) (defun elpher-address-to-url (address) - "Get string representation of ADDRESS, or nil if ADDRESS is special." - (if (elpher-address-special-p address) - nil - (url-encode-url (url-recreate-url address)))) + "Get string representation of ADDRESS." + (url-encode-url (url-recreate-url address))) (defun elpher-address-type (address) "Retrieve type of ADDRESS object. This is used to determine how to retrieve and render the document the address refers to, via the table `elpher-type-map'." - (if (symbolp address) - (list 'special address) - (let ((protocol (url-type address))) - (cond ((or (equal protocol "gopher") - (equal protocol "gophers")) - (list 'gopher - (if (member (url-filename address) '("" "/")) - ?1 - (string-to-char (substring (url-filename address) 1))))) - ((equal protocol "gemini") - 'gemini) - ((equal protocol "telnet") - 'telnet) - ((equal protocol "finger") - 'finger) - (t 'other-url))))) + (pcase (url-type address) + ("about" + (list 'about (intern (url-filename address)))) + ((or "gopher" "gophers") + (list 'gopher + (if (member (url-filename address) '("" "/")) + ?1 + (string-to-char (substring (url-filename address) 1))))) + ("gemini" 'gemini) + ("telnet" 'telnet) + ("finger" 'finger) + ("file" 'file) + (_ 'other-url))) + +(defun elpher-address-about-p (address) + "Return non-nil if ADDRESS is an about address." + (pcase (elpher-address-type address) (`(about ,_) t))) + +(defun elpher-address-gopher-p (address) + "Return non-nill if ADDRESS object is a gopher address." + (pcase (elpher-address-type address) (`(gopher ,_) t))) (defun elpher-address-protocol (address) - "Retrieve the transport protocol for ADDRESS. This is nil for special addresses." - (if (symbolp address) - nil - (url-type address))) + "Retrieve the transport protocol for ADDRESS." + (url-type address)) (defun elpher-address-filename (address) "Retrieve the filename component of ADDRESS. 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." @@ -450,18 +448,7 @@ For gopher addresses this is a combination of the selector type and selector." (defun elpher-address-port (address) "Retrieve port from ADDRESS object. If no address is defined, returns 0. (This is for compatibility with the URL library.)" - (if (symbolp address) - 0 - (url-port address))) - -(defun elpher-address-special-p (address) - "Return non-nil if ADDRESS object is special (e.g. start page, bookmarks page)." - (symbolp address)) - -(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")))) + (url-port address)) (defun elpher-gopher-address-selector (address) "Retrieve gopher selector from ADDRESS object." @@ -498,6 +485,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 "Start Page" + (elpher-address-from-url elpher-start-page-url))) + (defun elpher-page-display-string (page) "Retrieve the display string corresponding to PAGE." (elt page 0)) @@ -510,33 +502,67 @@ If no address is defined, returns 0. (This is for compatibility with the URL li "Set the address corresponding to PAGE to NEW-ADDRESS." (setcar (cdr page) new-address)) -(defvar elpher-current-page nil) ; buffer local -(defvar elpher-history nil) ; buffer local +(defun elpher-page-from-url (url &optional default-scheme) + "Create a page with address and display string defined by URL. +The URL is unhexed prior to its use as a display string to improve +readability. + +If DEFAULT-SCHEME is non-nil, this scheme is applied to the URL +in the instance that URL itself doesn't specify one." + (let ((address (elpher-address-from-url url default-scheme))) + (elpher-make-page (elpher-address-to-iri address) address))) + +(defun elpher-address-to-iri (address) + "Return an IRI for ADDRESS. +Decode percent-escapes and handle punycode in the domain name. +Drop the password, if any." + (let ((data (match-data))) ; Prevent parsing clobbering match data + (unwind-protect + (let* ((host (url-host address)) + (pass (url-password address))) + (when host + (setf (url-host address) (puny-decode-domain host))) + (when pass ; RFC 3986 says we should not render + (setf (url-password address) nil)) ; the password as clear text + (url-recreate-url address)) + (set-match-data data)))) + +(defvar elpher-current-page nil + "The current page for this Elpher buffer.") + +(defvar elpher-history nil + "The local history stack for this Elpher buffer. +This variable is used by `elpher-back' and +`elpher-show-history'.") + +(defvar elpher-visited-pages nil + "The global history for all Elpher buffers. +This variable is used by `elpher-show-visited-pages'.") (defun elpher-visit-page (page &optional renderer no-history) "Visit PAGE using its own renderer or RENDERER, if non-nil. -Additionally, push PAGE onto the stack of previously-visited pages, -unless NO-HISTORY is non-nil." +Additionally, push PAGE onto the history stack and the list of +previously-visited pages,unless NO-HISTORY is non-nil." (elpher-save-pos) (elpher-process-cleanup) - (unless (or no-history - (equal (elpher-page-address elpher-current-page) - (elpher-page-address page))) - (push elpher-current-page elpher-history)) + (unless no-history + (unless (or (not elpher-current-page) + (equal (elpher-page-address elpher-current-page) + (elpher-page-address page))) + (push elpher-current-page elpher-history) + (unless (or (elpher-address-about-p (elpher-page-address page)) + (and elpher-visited-pages + (equal page (car elpher-visited-pages)))) + (push page elpher-visited-pages)))) (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) @@ -548,10 +574,9 @@ unless NO-HISTORY is non-nil." (defun elpher-visit-previous-page () "Visit the previous page in the history." - (let ((previous-page (pop elpher-history))) - (if previous-page - (elpher-visit-page previous-page nil t) - (error "No previous page")))) + (if elpher-history + (elpher-visit-page (pop elpher-history) nil t) + (error "No previous page"))) (defun elpher-reload-current-page () "Reload the current page, discarding any existing cached content." @@ -570,6 +595,21 @@ unless NO-HISTORY is non-nil." (goto-char pos) (goto-char (point-min))))) +(defun elpher-get-default-url-scheme () + "Suggest a default URL scheme to use for visiting addresses based on the current page." + (if elpher-current-page + (let* ((address (elpher-page-address elpher-current-page)) + (current-type (elpher-address-type address))) + (pcase current-type + ((or (and 'file (guard (not elpher-history))) + `(about ,_)) + elpher-default-url-type) + (`(about ,_) + elpher-default-url-type) + (_ + (url-type address)))) + elpher-default-url-type)) + ;;; Buffer preparation ;; @@ -579,25 +619,28 @@ unless NO-HISTORY is non-nil." (defun elpher-update-header () "If `elpher-use-header' is true, display current page info in window header." - (if elpher-use-header + (if (and elpher-use-header elpher-current-page) (let* ((display-string (elpher-page-display-string elpher-current-page)) + (sanitized-display-string (replace-regexp-in-string "%" "%%" display-string)) (address (elpher-page-address elpher-current-page)) - (tls-string (if (and (not (elpher-address-special-p address)) + (tls-string (if (and (not (elpher-address-about-p address)) (member (elpher-address-protocol address) '("gophers" "gemini"))) " [TLS encryption]" "")) - (header (concat display-string + (header (concat sanitized-display-string (propertize tls-string 'face 'bold)))) (setq header-line-format header)))) (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) @@ -640,6 +683,56 @@ 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-page-from-url (substring-no-properties (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 ;; @@ -674,6 +767,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. @@ -689,7 +791,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) @@ -700,18 +802,22 @@ 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 ; Try again with IPv4 - ((not (or force-ipv4 socks)) + ((not (or elpher-ipv4-always force-ipv4 socks)) (message "Connection timed out. Retrying with IPv4.") (elpher-get-host-response address default-port query-string @@ -729,12 +835,12 @@ 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 - :family (and force-ipv4 'ipv4) + :family (and (or force-ipv4 + elpher-ipv4-always) + 'ipv4) :service service :buffer nil :nowait t @@ -799,6 +905,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"))))) @@ -961,25 +1068,6 @@ once they are retrieved from the gopher server." ;; Index rendering -(defun elpher-insert-index (string) - "Insert the index corresponding to STRING into the current buffer." - ;; Should be able to split directly on CRLF, but some non-conformant - ;; LF-only servers sadly exist, hence the following. - (let ((str-processed (elpher-preprocess-text-response string))) - (dolist (line (split-string str-processed "\n")) - (ignore-errors - (unless (= (length line) 0) - (let* ((type (elt line 0)) - (fields (split-string (substring line 1) "\t")) - (display-string (elt fields 0)) - (selector (elt fields 1)) - (host (elt fields 2)) - (port (if (elt fields 3) - (string-to-number (elt fields 3)) - nil)) - (address (elpher-make-gopher-address type selector host port))) - (elpher-insert-index-record display-string address))))))) - (defun elpher-insert-margin (&optional type-name) "Insert index margin, optionally containing the TYPE-NAME, into the current buffer." (if type-name @@ -1002,9 +1090,7 @@ displayed. The _WINDOW argument is currently unused." (when button (let* ((page (button-get button 'elpher-page)) (address (elpher-page-address page))) - (format "mouse-1, RET: open '%s'" (if (elpher-address-special-p address) - address - (elpher-address-to-url address)))))))) + (format "mouse-1, RET: open '%s'" (elpher-address-to-url address))))))) (defun elpher-insert-index-record (display-string &optional address) "Function to insert an index record into the current buffer. @@ -1047,43 +1133,25 @@ If ADDRESS is not supplied or nil the record is rendered as an (elpher-with-clean-buffer (if (not data) t - (elpher-insert-index data) + (let ((data-processed (elpher-preprocess-text-response data))) + (dolist (line (split-string data-processed "\n")) + (ignore-errors + (unless (= (length line) 0) + (let* ((type (elt line 0)) + (fields (split-string (substring line 1) "\t")) + (display-string (elt fields 0)) + (selector (elt fields 1)) + (host (elt fields 2)) + (port (if (elt fields 3) + (string-to-number (elt fields 3)) + nil)) + (address (elpher-make-gopher-address type selector host port))) + (elpher-insert-index-record display-string address)))))) (elpher-cache-content (elpher-page-address elpher-current-page) (buffer-string))))) ;; 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 buttinofy 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))) - -(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." - (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 @@ -1101,13 +1169,16 @@ Currently includes buttonifying URLs and processing ANSI escape codes." (if (not data) nil (if (display-images-p) - (progn - (let ((image (create-image - data - nil t))) - (elpher-with-clean-buffer - (insert-image image) - (elpher-restore-pos)))) + (let* ((image (create-image + data + nil t)) + (window (get-buffer-window elpher-buffer-name))) + (when window + (setf (image-property image :max-width) (window-body-width window t)) + (setf (image-property image :max-height) (window-body-height window t))) + (elpher-with-clean-buffer + (insert-image image) + (elpher-restore-pos))) (elpher-render-download data)))) ;; Search retrieval and rendering @@ -1241,8 +1312,7 @@ that the response was malformed." (let ((redirect-address (elpher-address-from-gemini-url response-meta))) (if (member redirect-address elpher-gemini-redirect-chain) (error "Redirect loop detected")) - (if (not (string= (elpher-address-protocol redirect-address) - "gemini")) + (if (not (eq (elpher-address-type redirect-address) 'gemini)) (error "Server tried to automatically redirect to non-gemini URL: %s" response-meta)) (elpher-page-set-address elpher-current-page redirect-address) @@ -1271,6 +1341,16 @@ that the response was malformed." (error "Gemini server response unknown: %s %s" response-code response-meta)))))) +(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." (let* ((read-answer-short t)) @@ -1383,20 +1463,23 @@ Returns the url portion in the event that the display-string portion is empty." (idx (string-match "[ \t]" rest))) (string-trim (if idx (substring rest (+ idx 1)) - rest)))) + (elpher-address-to-iri (elpher-address-from-url (elpher-decode (url-unhex-string rest)))))))) (defun elpher-collapse-dot-sequences (filename) - "Collapse dot sequences in FILENAME. -For instance, the filename /a/b/../c/./d will reduce to /a/c/d" - (let* ((path (split-string filename "/")) + "Collapse dot sequences in the (absolute) FILENAME. +For instance, the filename \"/a/b/../c/./d\" will reduce to \"/a/c/d\"" + (let* ((path (split-string filename "/" t)) + (is-directory (string-match-p (rx (: (or "." ".." "/") line-end)) filename)) (path-reversed-normalized (seq-reduce (lambda (a b) - (cond ((and a (equal b "..") (cdr a))) - ((and (not a) (equal b "..")) a) ;leading .. are dropped + (cond ((equal b "..") (cdr a)) ((equal b ".") a) (t (cons b a)))) - path nil))) - (string-join (reverse path-reversed-normalized) "/"))) + path nil)) + (path-normalized (reverse path-reversed-normalized))) + (if path-normalized + (concat "/" (string-join path-normalized "/") (and is-directory "/")) + "/"))) (defun elpher-address-from-gemini-url (url) "Extract address from URL with defaults as per gemini map files. @@ -1411,13 +1494,15 @@ treatment that a separate function is warranted." (if (string-empty-p (url-filename address)) (setf (url-filename address) "/")) ;ensure empty filename is marked as absolute (setf (url-host address) (url-host current-address)) - (setf (url-port address) (url-port current-address)) + (setf (url-portspec address) (url-portspec current-address)) ; (url-port) too slow! (unless (string-prefix-p "/" (url-filename address)) ;deal with relative links (setf (url-filename address) (concat (file-name-directory (url-filename current-address)) (url-filename address))))) + (when (url-host address) + (setf (url-host address) (puny-encode-domain (url-host address)))) (unless (url-type address) - (setf (url-type address) "gemini")) + (setf (url-type address) (url-type current-address))) (when (equal (url-type address) "gemini") (setf (url-filename address) (elpher-collapse-dot-sequences (url-filename address))))) @@ -1429,8 +1514,8 @@ treatment that a separate function is warranted." (display-string (elpher-gemini-get-link-display-string link-line)) (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))) + (type-map-entry (cdr (assoc type elpher-type-map))) + (fill-prefix (make-string (+ 1 (length elpher-gemini-link-string)) ?\s))) (when display-string (insert elpher-gemini-link-string) (if type-map-entry @@ -1444,7 +1529,7 @@ treatment that a separate function is warranted." 'follow-link t 'help-echo #'elpher--page-button-help)) (insert (propertize display-string 'face 'elpher-unknown))) - (insert "\n")))) + (newline)))) (defun elpher-gemini-insert-header (header-line) "Insert header described by HEADER-LINE into a text/gemini document. @@ -1462,19 +1547,26 @@ by HEADER-LINE." (/ (* fill-column (font-get (font-spec :name (face-font 'default)) :size)) (font-get (font-spec :name (face-font face)) :size)) fill-column))) - (setq elpher--gemini-page-headings (cons (cons header (point)) - elpher--gemini-page-headings)) (unless (display-graphic-p) (insert (make-string level ?#) " ")) - (insert (propertize header 'face face)) + (insert (propertize header + 'face face + 'gemini-heading t + 'rear-nonsticky t)) (newline)))) (defun elpher-gemini-insert-text (text-line) "Insert a plain non-preformatted TEXT-LINE into a text/gemini document. This function uses Emacs' auto-fill to wrap text sensibly to a maximum width defined by `elpher-gemini-max-fill-width'." - (string-match "\\(^[ \t]*\\)\\(\\*[ \t]+\\|>[ \t]*\\)?" text-line) - (let* ((line-prefix (match-string 2 text-line)) + (string-match + (rx (: line-start + (* (any " \t")) + (optional + (group (or (: "*" (+ (any " \t"))) + (: ">" (* (any " \t")))))))) + text-line) + (let* ((line-prefix (match-string 1 text-line)) (processed-text-line (if line-prefix (cond ((string-prefix-p "*" line-prefix) @@ -1487,19 +1579,21 @@ width defined by `elpher-gemini-max-fill-width'." (propertize text-line 'face 'elpher-gemini-quoted)) (t text-line)) text-line)) - (adaptive-fill-mode nil)) + (adaptive-fill-mode t) + ;; fill-prefix is important for adaptive-fill-mode: without + ;; it, multi-line list items are not indented correct + (fill-prefix (if (match-string 1 text-line) + (make-string (length (match-string 0 text-line)) ?\s) + nil))) (insert (elpher-process-text-for-display processed-text-line)) (newline))) (defun elpher-render-gemini-map (data _parameters) "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))) @@ -1507,25 +1601,12 @@ 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." @@ -1535,6 +1616,18 @@ width defined by `elpher-gemini-max-fill-width'." (elpher-page-address elpher-current-page) (buffer-string)))) +(defun elpher-build-current-imenu-index () + (save-excursion + (goto-char (point-min)) + (let ((match nil) + (headers nil)) + (while (setq match (text-property-search-forward 'gemini-heading t t)) + (push (cons + (buffer-substring-no-properties (prop-match-beginning match) + (prop-match-end match)) + (prop-match-beginning match)) + headers)) + (reverse headers)))) ;; Finger page connection @@ -1587,21 +1680,55 @@ The result is rendered using RENDERER." (error "Command not supported for general URLs")) (let* ((address (elpher-page-address elpher-current-page)) (url (elpher-address-to-url address))) - (progn - (elpher-visit-previous-page) ; Do first in case of non-local exits. - (message "Opening URL...") - (if elpher-open-urls-with-eww - (browse-web url) - (browse-url url))))) + (elpher-visit-previous-page) ; Do first in case of non-local exits. + (message "Opening URL...") + (if elpher-open-urls-with-eww + (browse-web url) + (browse-url url)))) +;; File page -;; Start page page retrieval - -(defun elpher-get-start-page (renderer) - "Getter which displays the start page (RENDERER must be nil)." +(defun elpher-get-file-page (renderer) + "Getter which renders a local file using RENDERER. +Assumes UTF-8 encoding for all text files." + (let* ((address (elpher-page-address elpher-current-page)) + (filename (elpher-address-filename address))) + (unless (file-exists-p filename) + (elpher-visit-previous-page) + (error "File not found")) + (unless (file-readable-p filename) + (elpher-visit-previous-page) + (error "Could not read from file")) + (let ((body (with-temp-buffer + (let ((coding-system-for-read 'binary) + (coding-system-for-write 'binary)) + (insert-file-contents-literally filename) + (encode-coding-string (buffer-string) 'raw-text))))) + (if renderer + (funcall renderer body nil) + (pcase (file-name-extension filename) + ((or "gmi" "gemini") + (elpher-render-gemini-map (decode-coding-string body 'utf-8) nil)) + ((or "htm" "html") + (elpher-render-html (decode-coding-string body 'utf-8))) + ((or "txt" "") + (elpher-render-text (decode-coding-string body 'utf-8))) + ((or "jpg" "jpeg" "gif" "png" "bmp" "tif" "tiff") + (elpher-render-image body)) + ((or "gopher" "gophermap") + (elpher-render-index (elpher-decode body))) + (_ + (elpher-render-download body)))) + (elpher-restore-pos)))) + + +;; Welcome page retrieval + +(defun elpher-get-welcome-page (renderer) + "Getter which displays the welcome page (RENDERER must be nil)." (when renderer (elpher-visit-previous-page) - (error "Command not supported for start page")) + (error "Command not supported for welcome page")) (elpher-with-clean-buffer (insert " --------------------------------------------\n" " Elpher Gopher and Gemini Client \n" @@ -1614,18 +1741,17 @@ The result is rendered using RENDERER." " - RET/mouse-1: open item under cursor\n" " - m: select an item on current page by name (autocompletes)\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" + " - o/O: open a different address selector or the root menu of the current server\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" - " - x/X: remove bookmark for item under cursor or current page\n" - " - B: visit the bookmarks page\n" + " - B: list all bookmarks\n" + " - s/S: show current history stack or all previously visted pages\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" @@ -1642,143 +1768,249 @@ The result is rendered using RENDERER." (elpher-insert-index-record "Gemini Search Engine (geminispace.info)" (elpher-address-from-url "gemini://geminispace.info/search")) (insert "\n" - "This page contains your bookmarked sites (also visit with B):\n") - (elpher-insert-index-record "Your Bookmarks" 'bookmarks) + "Your bookmarks are stored in your ") + (insert-text-button "bookmark list" + 'face 'link + 'action #'elpher-click-link + 'follow-link t + 'help-echo #'elpher--page-button-help + 'elpher-page + (elpher-make-page "Elpher Bookmarks" + (elpher-make-about-address 'bookmarks))) + (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") + "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))) -;; Bookmarks page page retrieval +;; History page retrieval + +(defun elpher-show-history () + "Show the current contents of elpher's history stack. +Use \\[elpher-show-visited-pages] to see the entire history. +This is rendered using `elpher-get-history-page' via `elpher-type-map'." + (interactive) + (elpher-visit-page + (elpher-make-page "Current History Stack" + (elpher-make-about-address 'history)))) + +(defun elpher-show-visited-pages () + "Show the all the pages you've visited using Elpher. +Use \\[elpher-show-history] to see just the current history stack. +This is rendered using `elpher-get-visited-pages-page' via `elpher-type-map'." + (interactive) + (elpher-visit-page + (elpher-make-page "Elpher Visted Pages" + (elpher-make-about-address 'visited-pages)))) + +(defun elpher-get-history-page (renderer) + "Getter which displays the history page (RENDERER must be nil)." + (when renderer + (elpher-visit-previous-page) + (error "Command not supported for history page")) + (elpher-display-history-links elpher-history "Current history stack")) + +(defun elpher-get-visited-pages-page (renderer) + "Getter which displays the list of visited pages (RENDERER must be nil)." + (when renderer + (elpher-visit-previous-page) + (error "Command not supported for history page")) + (elpher-display-history-links + (seq-filter (lambda (page) + (not (elpher-address-about-p (elpher-page-address page)))) + elpher-visited-pages) + "All visited pages")) + +(defun elpher-display-history-links (pages title) + "Show all PAGES in an Elpher buffer with a given TITLE." + (let* ((title-line (concat " ---- " title " ----")) + (footer-line (make-string (length title-line) ?-))) + (elpher-with-clean-buffer + (insert title-line "\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 "\n " footer-line "\n" + "Select an entry or press 'u' to return to the previous page.") + (elpher-restore-pos)))) + + +;;; Bookmarks + +;; This code allows Elpher to use the standard Emacs bookmarks: `C-x r +;; m' to add a bookmark, `C-x r l' to list bookmarks (which is where +;; you can anotate bookmarks!), `C-x r b' to jump to a bookmark, and +;; so on. See the Bookmarks section in the Emacs info manual for more. + +(defvar elpher-bookmark-link nil + "Prefer bookmarking a link or the current page. +Bind this variable dynamically, or set it to t. +If you set it to t, the commands \\[bookmark-set-no-overwrite] +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 +record for the current elpher page." + (let* ((button (and elpher-bookmark-link (button-at (point)))) + (page (if button + (button-get button 'elpher-page) + elpher-current-page))) + (unless page + (error "Cannot bookmark this link")) + (let* ((address (elpher-page-address page)) + (url (elpher-address-to-url address)) + (display-string (elpher-page-display-string page)) + (pos (if button nil (point)))) + (if (elpher-address-about-p address) + (error "Cannot bookmark %s" display-string) + `(,display-string + (defaults . (,display-string)) + (position . ,pos) + (location . ,url) + (handler . elpher-bookmark-jump)))))) + +;;;###autoload +(defun elpher-bookmark-jump (bookmark) + "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)) + (page (elpher-page-from-url cleaned-url))) + (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. +To bookmark the current page, use \\[elpher-bookmark-current]." + (interactive) + (let ((elpher-bookmark-link t)) + (bookmark-set-no-overwrite))) + +(defun elpher-bookmark-current () + "Bookmark the current page. +To bookmark the link at point use \\[elpher-bookmark-link]." + (interactive) + (call-interactively #'bookmark-set-no-overwrite)) + +(defun elpher-bookmark-import (file) + "Import legacy Elpher bookmarks file FILE into Emacs bookmarks." + (interactive (list (if (and (boundp 'elpher-bookmarks-file) + (file-readable-p elpher-bookmarks-file)) + elpher-bookmarks-file + (read-file-name "Old Elpher bookmarks: " + user-emacs-directory nil t + "elpher-bookmarks")))) + (dolist (bookmark (with-temp-buffer + (insert-file-contents file) + (read (current-buffer)))) + (let* ((display-string (car bookmark)) + (url (cadr bookmark)) + (record `(,display-string + (location . ,url) + (handler . elpher-bookmark-jump)))) + (bookmark-store display-string (cdr record) t))) + (bookmark-save)) (defun elpher-get-bookmarks-page (renderer) - "Getter to load and display the current bookmark list (RENDERER must be nil)." + "Getter which displays the bookmarks (RENDERER must be nil)." (when renderer (elpher-visit-previous-page) (error "Command not supported for bookmarks page")) - (elpher-with-clean-buffer - (insert "---- Bookmark list ----\n\n") - (let ((bookmarks (elpher-load-bookmarks))) - (if bookmarks - (dolist (bookmark bookmarks) - (let ((display-string (elpher-bookmark-display-string bookmark)) - (address (elpher-address-from-url (elpher-bookmark-url bookmark)))) - (elpher-insert-index-record display-string address))) - (insert "No bookmarks found.\n"))) - (insert "\n-----------------------\n" - "\n" - "- u: return to previous page\n" - "- x: delete selected bookmark\n" - "- a: rename selected bookmark\n" - "\n" - "Bookmarks are stored in the file ") - (let ((filename elpher-bookmarks-file) - (help-string "RET,mouse-1: Open bookmarks file in new buffer for editing.")) - (insert-text-button filename - 'face 'link + + (let ((old-bookmarks-file (or (and (boundp 'elpher-bookmarks-file) + elpher-bookmarks-file) + (locate-user-emacs-file "elpher-bookmarks")))) + (when (and (file-readable-p old-bookmarks-file) + (y-or-n-p (concat "Legacy elpher-bookmarks file \"" + old-bookmarks-file + "\" found. Import now?"))) + (elpher-bookmark-import old-bookmarks-file) + (rename-file old-bookmarks-file (concat old-bookmarks-file "-legacy")))) + + (if (and elpher-use-emacs-bookmark-menu + elpher-history) + (progn + (elpher-visit-previous-page) + (call-interactively #'bookmark-bmenu-list)) + (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) - (find-file filename)) + (call-interactively #'bookmark-bmenu-list)) 'follow-link t - 'help-echo help-string)) - (insert "\n") - (elpher-restore-pos))) - + '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)))) -;;; Bookmarks -;; +(defun elpher-show-bookmarks () + "Interactive function to display the current list of elpher bookmarks." + (interactive) + (elpher-visit-page + (elpher-make-page "Elpher Bookmarks" + (elpher-make-about-address 'bookmarks)))) -(defun elpher-make-bookmark (display-string url) - "Make an elpher bookmark. -DISPLAY-STRING determines how the bookmark will appear in the -bookmark list, while URL is the url of the entry." - (list display-string url)) - -(defun elpher-bookmark-display-string (bookmark) - "Get the display string of BOOKMARK." - (elt bookmark 0)) - -(defun elpher-set-bookmark-display-string (bookmark display-string) - "Set the display string of BOOKMARK to DISPLAY-STRING." - (setcar bookmark display-string)) - -(defun elpher-bookmark-url (bookmark) - "Get the address for BOOKMARK." - (elt bookmark 1)) - -(defun elpher-save-bookmarks (bookmarks) - "Record the bookmark list BOOKMARKS to the user's bookmark file. -Beware that this completely replaces the existing contents of the file." - (let ((bookmark-dir (file-name-directory elpher-bookmarks-file))) - (unless (file-directory-p bookmark-dir) - (make-directory bookmark-dir))) - (with-temp-file elpher-bookmarks-file - (erase-buffer) - (insert "; Elpher bookmarks file\n\n" - "; Bookmarks are stored as a list of (label URL) items.\n" - "; Feel free to edit by hand, but take care to ensure\n" - "; the list structure remains intact.\n\n") - (pp bookmarks (current-buffer)))) - -(defun elpher-load-bookmarks () - "Get the list of bookmarks from the users's bookmark file." - (let ((bookmarks - (with-temp-buffer - (ignore-errors - (insert-file-contents elpher-bookmarks-file) - (goto-char (point-min)) - (read (current-buffer)))))) - (if (and bookmarks (listp (cadar bookmarks))) - (progn - (message "Reading old bookmark file. (Will be updated on write.)") - (mapcar (lambda (old-bm) - (list (car old-bm) - (elpher-address-to-url (apply #'elpher-make-gopher-address - (cadr old-bm))))) - bookmarks)) - bookmarks))) - -(defun elpher-add-address-bookmark (address display-string) - "Save a bookmark for ADDRESS with label DISPLAY-STRING.))) -If ADDRESS is already bookmarked, update the label only." - (let ((bookmarks (elpher-load-bookmarks)) - (url (elpher-address-to-url address))) - (let ((existing-bookmark (rassoc (list url) bookmarks))) - (if existing-bookmark - (elpher-set-bookmark-display-string existing-bookmark display-string) - (push (elpher-make-bookmark display-string url) bookmarks))) - (elpher-save-bookmarks bookmarks))) - -(defun elpher-remove-address-bookmark (address) - "Remove any bookmark to ADDRESS." - (let ((url (elpher-address-to-url address))) - (elpher-save-bookmarks - (seq-filter (lambda (bookmark) - (not (equal (elpher-bookmark-url bookmark) url))) - (elpher-load-bookmarks))))) ;;; Integrations ;; +;;; Org + (defun elpher-org-export-link (link description format protocol) "Export a LINK with DESCRIPTION for the given PROTOCOL and FORMAT. @@ -1796,8 +2028,6 @@ of gemini, gopher or finger." url (format "%s (%s)" desc url)))))) -;; Avoid byte compilation warnings. -(declare-function org-link-store-props "ol") (defun elpher-org-store-link () "Store link to an `elpher' page in Org." (when (eq major-mode 'elpher-mode) @@ -1817,16 +2047,15 @@ of gemini, gopher or finger." (defun elpher-org-follow-link (link protocol) "Visit a LINK for the given PROTOCOL. -PROTOCOL may be one of gemini, gopher or finger. This method also support old -paramter elpher, where link is self-contained." +PROTOCOL may be one of gemini, gopher or finger. This method also +supports the old protocol elpher, where the link is self-contained." (let ((url (if (equal protocol "elpher") (string-remove-prefix "elpher:" link) (format "%s:%s" protocol link)))) (elpher-go url))) -;; Avoid byte compilation warnings. -(declare-function org-link-set-parameters "ol") -(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 @@ -1849,6 +2078,10 @@ paramter elpher, where link is self-contained." (elpher-org-export-link link description format "finger")) :follow (lambda (link _arg) (elpher-org-follow-link link "finger")))) +(add-hook 'org-mode-hook #'elpher-org-mode-integration) + +;;; Browse URL + ;;;###autoload (defun elpher-browse-url-elpher (url &rest _args) "Browse URL using Elpher. This function is used by `browse-url'." @@ -1856,24 +2089,41 @@ paramter elpher, where link is self-contained." (elpher-go url)) ;; Use elpher to open gopher, finger and gemini links -(with-eval-after-load 'browse-url - (add-to-list - 'browse-url-default-handlers - '("^\\(gopher\\|finger\\|gemini\\)://" . elpher-browse-url-elpher))) - -;; Avoid byte compilation warnings. -(eval-when-compile - (defvar thing-at-point-uri-schemes) - (defvar mu4e~view-beginning-of-url-regexp)) +;; For recent version of `browse-url' package +(if (boundp 'browse-url-default-handlers) + (add-to-list + 'browse-url-default-handlers + '("^\\(gopher\\|finger\\|gemini\\)://" . elpher-browse-url-elpher)) + ;; Patch `browse-url-browser-function' for older ones. The value of + ;; that variable is `browse-url-default-browser' by default, so + ;; that's the function that gets advised. + (advice-add browse-url-browser-function :before-while + (lambda (url &rest _args) + "Handle gemini, gopher, and finger schemes using Elpher." + (let ((scheme (downcase (car (split-string url ":" t))))) + (if (member scheme '("gemini" "gopher" "finger")) + ;; `elpher-go' always returns nil, which will stop the + ;; advice chain here in a before-while + (elpher-go url) + ;; chain must continue, then return t. + t))))) ;; Register "gemini://" as a URI scheme so `browse-url' does the right thing (with-eval-after-load 'thingatpt (add-to-list 'thing-at-point-uri-schemes "gemini://")) -(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:")) +;;; Mu4e: + +;; Make mu4e aware of the gemini world +(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 ;; @@ -1897,31 +2147,25 @@ paramter elpher, where link is self-contained." (defun elpher-go (host-or-url) "Go to a particular gopher site HOST-OR-URL. When run interactively HOST-OR-URL is read from the minibuffer." - (interactive "sGopher or Gemini URL: ") - (let* ((cleaned-host-or-url (string-trim host-or-url)) - (address (elpher-address-from-url cleaned-host-or-url)) - (page (elpher-make-page cleaned-host-or-url address))) - (switch-to-buffer elpher-buffer-name) - (elpher-visit-page page) - nil)) + (interactive (list + (read-string (format "Visit URL (default scheme %s): " (elpher-get-default-url-scheme))))) + (let ((trimmed-host-or-url (string-trim host-or-url))) + (unless (string-empty-p trimmed-host-or-url) + (let ((page (elpher-page-from-url trimmed-host-or-url + (elpher-get-default-url-scheme)))) + (switch-to-buffer elpher-buffer-name) + (elpher-with-clean-buffer + (elpher-visit-page page)) + nil)))) ; non-nil value is displayed by eshell (defun elpher-go-current () "Go to a particular site read from the minibuffer, initialized with the current URL." (interactive) - (let ((address (elpher-page-address elpher-current-page))) - (let ((url (read-string "Gopher or Gemini URL: " - (unless (elpher-address-special-p address) - (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)))) + (let* ((address (elpher-page-address elpher-current-page)) + (url (read-string (format "Visit URL (default scheme %s): " (elpher-get-default-url-scheme)) + (elpher-address-to-url address)))) + (unless (string-empty-p (string-trim url)) + (elpher-visit-page (elpher-page-from-url url) (elpher-get-default-url-scheme))))) (defun elpher-redraw () "Redraw current page." @@ -1947,7 +2191,7 @@ When run interactively HOST-OR-URL is read from the minibuffer." (defun elpher-view-raw () "View raw server response for current page." (interactive) - (if (elpher-address-special-p (elpher-page-address elpher-current-page)) + (if (elpher-address-about-p (elpher-page-address elpher-current-page)) (error "This page was not generated by a server") (elpher-visit-page elpher-current-page #'elpher-render-raw))) @@ -1962,9 +2206,7 @@ When run interactively HOST-OR-URL is read from the minibuffer." (interactive) (setq-local elpher-current-page nil) (setq-local elpher-history nil) - (let ((start-page (elpher-make-page "Elpher Start Page" - (elpher-make-special-address 'start)))) - (elpher-visit-page start-page))) + (elpher-visit-page (elpher-make-start-page))) (defun elpher-download () "Download the link at point." @@ -1972,17 +2214,18 @@ When run interactively HOST-OR-URL is read from the minibuffer." (let ((button (button-at (point)))) (if button (let ((page (button-get button 'elpher-page))) - (if (elpher-address-special-p (elpher-page-address page)) - (error "Cannot download %s" - (elpher-page-display-string page)) - (elpher-visit-page (button-get button 'elpher-page) - #'elpher-render-download))) + (unless page + (error "Not an elpher page")) + (when (elpher-address-about-p (elpher-page-address page)) + (error "Cannot download %s" (elpher-page-display-string page))) + (elpher-visit-page (button-get button 'elpher-page) + #'elpher-render-download)) (error "No link selected")))) (defun elpher-download-current () "Download the current page." (interactive) - (if (elpher-address-special-p (elpher-page-address elpher-current-page)) + (if (elpher-address-about-p (elpher-page-address elpher-current-page)) (error "Cannot download %s" (elpher-page-display-string elpher-current-page)) (elpher-visit-page (elpher-make-page @@ -1991,7 +2234,7 @@ When run interactively HOST-OR-URL is read from the minibuffer." #'elpher-render-download t))) -(defun elpher-build-link-map () +(defun elpher--build-link-map () "Build alist mapping link names to destination pages in current buffer." (let ((link-map nil) (b (next-button (point-min) t))) @@ -2003,7 +2246,7 @@ When run interactively HOST-OR-URL is read from the minibuffer." (defun elpher-jump () "Select a directory entry by name. Similar to the info browser (m)enu command." (interactive) - (let* ((link-map (elpher-build-link-map))) + (let* ((link-map (elpher--build-link-map))) (if link-map (let ((key (let ((completion-ignore-case t)) (completing-read "Directory item/link: " @@ -2017,7 +2260,7 @@ When run interactively HOST-OR-URL is read from the minibuffer." "Visit root of current server." (interactive) (let ((address (elpher-page-address elpher-current-page))) - (if (not (elpher-address-special-p address)) + (if (not (elpher-address-about-p address)) (if (or (member (url-filename address) '("/" "")) (and (elpher-address-gopher-p address) (= (length (elpher-gopher-address-selector address)) 0))) @@ -2028,89 +2271,21 @@ When run interactively HOST-OR-URL is read from the minibuffer." (elpher-go (elpher-address-to-url address-copy)))) (error "Command invalid for %s" (elpher-page-display-string elpher-current-page))))) -(defun elpher-bookmarks-current-p () - "Return non-nil if current page is a bookmarks page." - (equal (elpher-address-type (elpher-page-address elpher-current-page)) - '(special bookmarks))) - -(defun elpher-reload-bookmarks () - "Reload bookmarks if current page is a bookmarks page." - (if (elpher-bookmarks-current-p) - (elpher-reload-current-page))) - -(defun elpher-bookmark-current () - "Bookmark the current page." - (interactive) - (let ((address (elpher-page-address elpher-current-page)) - (display-string (elpher-page-display-string elpher-current-page))) - (if (not (elpher-address-special-p address)) - (let ((bookmark-display-string (read-string "Bookmark display string: " - display-string))) - (elpher-add-address-bookmark address bookmark-display-string) - (message "Bookmark added.")) - (error "Cannot bookmark %s" display-string)))) - -(defun elpher-bookmark-link () - "Bookmark the link at point." - (interactive) - (let ((button (button-at (point)))) - (if button - (let* ((page (button-get button 'elpher-page)) - (address (elpher-page-address page)) - (display-string (elpher-page-display-string page))) - (if (not (elpher-address-special-p address)) - (let ((bookmark-display-string (read-string "Bookmark display string: " - display-string))) - (elpher-add-address-bookmark address bookmark-display-string) - (elpher-reload-bookmarks) - (message "Bookmark added.")) - (error "Cannot bookmark %s" display-string))) - (error "No link selected")))) - -(defun elpher-unbookmark-current () - "Remove bookmark for the current page." - (interactive) - (let ((address (elpher-page-address elpher-current-page))) - (when (and (not (elpher-address-special-p address)) - (y-or-n-p "Really remove bookmark for the current page? ")) - (elpher-remove-address-bookmark address) - (message "Bookmark removed.")))) - -(defun elpher-unbookmark-link () - "Remove bookmark for the link at point." - (interactive) - (let ((button (button-at (point)))) - (if button - (when (y-or-n-p "Really remove bookmark for this link? ") - (let ((page (button-get button 'elpher-page))) - (elpher-remove-address-bookmark (elpher-page-address page)) - (elpher-reload-bookmarks) - (message "Bookmark removed."))) - (error "No link selected")))) - -;;;###autoload -(defun elpher-bookmarks () - "Visit bookmarks page." - (interactive) - (switch-to-buffer elpher-buffer-name) - (elpher-visit-page - (elpher-make-page "Bookmarks Page" (elpher-make-special-address 'bookmarks)))) - (defun elpher-info-page (page) - "Display information on PAGE." - (let ((display-string (elpher-page-display-string page)) - (address (elpher-page-address page))) - (if (elpher-address-special-p address) - (message "Special page: %s" display-string) - (message "%s" (elpher-address-to-url address))))) + "Display URL of PAGE in minibuffer." + (let ((address (elpher-page-address page))) + (message "%s" (elpher-address-to-url address)))) (defun elpher-info-link () "Display information on page corresponding to link at point." (interactive) (let ((button (button-at (point)))) - (if button - (elpher-info-page (button-get button 'elpher-page)) - (error "No item selected")))) + (unless button + (error "No item selected")) + (let ((page (button-get button 'elpher-page))) + (unless page + (error "Not an elpher page")) + (elpher-info-page page)))) (defun elpher-info-current () "Display information on current page." @@ -2119,20 +2294,21 @@ When run interactively HOST-OR-URL is read from the minibuffer." (defun elpher-copy-page-url (page) "Copy URL representation of address of PAGE to `kill-ring'." - (let ((address (elpher-page-address page))) - (if (elpher-address-special-p address) - (error (format "Cannot represent %s as URL" (elpher-page-display-string page))) - (let ((url (elpher-address-to-url address))) - (message "Copied \"%s\" to kill-ring/clipboard." url) - (kill-new url))))) + (let* ((address (elpher-page-address page)) + (url (elpher-address-to-url address))) + (message "Copied \"%s\" to kill-ring/clipboard." url) + (kill-new url))) (defun elpher-copy-link-url () "Copy URL of item at point to `kill-ring'." (interactive) (let ((button (button-at (point)))) - (if button - (elpher-copy-page-url (button-get button 'elpher-page)) - (error "No item selected")))) + (unless button + (error "No item selected")) + (let ((page (button-get button 'elpher-page))) + (unless page + (error "Not an elpher page")) + (elpher-copy-page-url page)))) (defun elpher-copy-current-url () "Copy URL of current page to `kill-ring'." @@ -2158,11 +2334,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 "O") 'elpher-root-dir) + (define-key map (kbd "U") 'elpher-back-to-start) (define-key map (kbd "g") 'elpher-go) (define-key map (kbd "o") 'elpher-go-current) + (define-key map (kbd "O") 'elpher-root-dir) + (define-key map (kbd "s") 'elpher-show-history) + (define-key map (kbd "S") 'elpher-show-visited-pages) (define-key map (kbd "r") 'elpher-redraw) (define-key map (kbd "R") 'elpher-reload) (define-key map (kbd "T") 'elpher-toggle-tls) @@ -2176,12 +2356,9 @@ 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 "x") 'elpher-unbookmark-link) - (define-key map (kbd "X") 'elpher-unbookmark-current) - (define-key map (kbd "B") 'elpher-bookmarks) - (define-key map (kbd "S") 'elpher-set-gopher-coding-system) + (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) - (define-key map (kbd "v") 'elpher-visit-gemini-numbered-link) (when (fboundp 'evil-define-key*) (evil-define-key* 'motion map @@ -2191,29 +2368,29 @@ 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 "o") 'elpher-go - (kbd "O") 'elpher-go-current + (kbd "U") 'elpher-back-to-start + (kbd "g") 'elpher-go + (kbd "o") 'elpher-go-current + (kbd "O") 'elpher-root-dir + (kbd "s") 'elpher-show-history + (kbd "S") 'elpher-show-visited-pages (kbd "r") 'elpher-redraw (kbd "R") 'elpher-reload (kbd "T") 'elpher-toggle-tls (kbd ".") 'elpher-view-raw (kbd "d") 'elpher-download (kbd "D") 'elpher-download-current - (kbd "J") 'elpher-jump + (kbd "m") 'elpher-jump (kbd "i") 'elpher-info-link (kbd "I") 'elpher-info-current (kbd "c") 'elpher-copy-link-url (kbd "C") 'elpher-copy-current-url (kbd "a") 'elpher-bookmark-link (kbd "A") 'elpher-bookmark-current - (kbd "x") 'elpher-unbookmark-link - (kbd "X") 'elpher-unbookmark-current - (kbd "B") 'elpher-bookmarks - (kbd "S") 'elpher-set-gopher-coding-system - (kbd "F") 'elpher-forget-current-certificate - (kbd "v") 'elpher-visit-gemini-numbered-link)) + (kbd "B") 'elpher-show-bookmarks + (kbd "!") 'elpher-set-gopher-coding-system + (kbd "F") 'elpher-forget-current-certificate)) map) "Keymap for gopher client.") @@ -2221,16 +2398,14 @@ When run interactively HOST-OR-URL is read from the minibuffer." "Major mode for elpher, an elisp gopher client. This mode is automatically enabled by the interactive -functions which initialize the gopher client, namely -`elpher', `elpher-go' and `elpher-bookmarks'." - (setq-local elpher--gemini-page-headings nil) +functions which initialize the client, namely +`elpher', and `elpher-go'." (setq-local elpher-current-page nil) (setq-local elpher-history nil) (setq-local elpher-buffer-name (buffer-name)) - - (setq-local imenu-create-index-function - (lambda () - elpher--gemini-page-headings))) + (setq-local bookmark-make-record-function #'elpher-bookmark-make-record) + (setq-local imenu-create-index-function #'elpher-build-current-imenu-index) + (setq-local xterm-color-preserve-properties t)) (when (fboundp 'evil-set-initial-state) (evil-set-initial-state 'elpher-mode 'motion)) @@ -2260,10 +2435,7 @@ to create a new session. Returns the buffer selected (or created)." (pop-to-buffer-same-window buf) (unless (buffer-modified-p) (elpher-mode) - (let ((start-page (elpher-make-page - "Elpher Start Page" - (elpher-make-special-address 'start)))) - (elpher-visit-page start-page)) + (elpher-visit-page (elpher-make-start-page)) "Started Elpher."))); Otherwise (elpher) evaluates to start page string. ;;; elpher.el ends here