X-Git-Url: https://thelambdalab.xyz/gitweb/index.cgi?p=elpher.git;a=blobdiff_plain;f=elpher.el;h=925afa3da7b47a52cba9bdc87238cfb4deab2323;hp=cfa13b985edb98e93a5da860184d9d32a8dbb8f6;hb=65621cde0534f742b5cbd9b523938b296bdd8080;hpb=a2f3bd8f2f6344ab43d4dfd201b6ef8adafd2ea2 diff --git a/elpher.el b/elpher.el index cfa13b9..925afa3 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.2.2 ;; Keywords: comm gopher ;; Homepage: https://thelambdalab.xyz/elpher ;; Package-Requires: ((emacs "27.1")) @@ -73,19 +74,18 @@ ;; (require 'seq) -(require 'pp) (require 'shr) (require 'url-util) (require 'subr-x) -(require 'dns) (require 'nsm) (require 'gnutls) (require 'socks) +(require 'bookmark) ;;; Global constants ;; -(defconst elpher-version "3.0.0" +(defconst elpher-version "3.2.2" "Current version of elpher.") (defconst elpher-margin-width 6 @@ -109,9 +109,11 @@ (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 start) elpher-get-start-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)) + (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.") @@ -127,7 +129,9 @@ (defvar ansi-color-context) (defvar bookmark-make-record-function) (defvar mu4e~view-beginning-of-url-regexp) - (defvar thing-at-point-uri-schemes)) + (defvar eww-use-browse-url) + (defvar thing-at-point-uri-schemes) + (defvar xterm-color-preserve-properties)) ;;; Customization group @@ -215,6 +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-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 @@ -299,7 +320,7 @@ Otherwise, the SOCKS proxy is only used for connections to onion services." ;; 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. @@ -311,7 +332,7 @@ Otherwise, the SOCKS proxy is only used for connections to onion services." (unless (and (not (url-fullness url)) (url-type url)) (setf (url-fullness url) t) (unless (url-type url) - (setf (url-type url) elpher-default-url-type)) + (setf (url-type url) (elpher-get-default-url-type))) (unless (url-host url) (let ((p (split-string (url-filename url) "/" nil nil))) (setf (url-host url) (car p)) @@ -332,11 +353,23 @@ Otherwise, the SOCKS proxy is only used for connections to onion services." (elpher-remove-redundant-ports url)) (set-match-data data)))) +(defun elpher-get-default-url-type () + "Get the current URL type or `elpher-default-url-type'. +If no scheme is provided for a URL, the current context specifies +the scheme to use, so if we're looking at a gemini page, then the +default type is \"gemini\" even if `elpher-default-url-type' is +\"gopher\"." + (or (and elpher-current-page + (symbol-name + (elpher-address-type + (elpher-page-address elpher-current-page)))) + elpher-default-url-type)) + (defun elpher-remove-redundant-ports (address) "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) @@ -369,49 +402,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." + (eq 'gopher (elpher-address-type address))) (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-unhex-string (url-filename address)))) + (url-unhex-string (url-filename address))) (defun elpher-address-host (address) "Retrieve host from ADDRESS object." @@ -424,18 +456,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 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." @@ -474,8 +495,8 @@ If no address is defined, returns 0. (This is for compatibility with the URL li (defun elpher-make-start-page () "Create the start page." - (elpher-make-page "Elpher Start Page" - (elpher-make-special-address 'start))) + (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." @@ -489,6 +510,36 @@ 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)) +(defun elpher-page-from-url (url) + "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." + (elpher-make-page (elpher-url-to-iri url) + (elpher-address-from-url url))) + +(defun elpher-url-to-iri (url) + "Return an IRI for URL. +Decode percent-escapes and handle punycode in the domain name. +Drop the password, if any." + (let* ((address (elpher-address-from-url (elpher-decode (url-unhex-string url)))) + (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))) + +(defun elpher-encode-url (iri) + "Return an URL for the IRI. +Encode and use percent-escapes, use punycode for the domain name +if necessary." + (let* ((address (url-generic-parse-url iri)) + (host (url-host address))) + (when host + (setf (url-host address) (puny-encode-domain host))) + (url-recreate-url address))) + (defvar elpher-current-page nil "The current page for this Elpher buffer.") @@ -508,10 +559,11 @@ previously-visited pages,unless NO-HISTORY is non-nil." (elpher-save-pos) (elpher-process-cleanup) (unless no-history - (unless (equal (elpher-page-address elpher-current-page) - (elpher-page-address page)) + (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-special-p (elpher-page-address page)) + (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)))) @@ -535,10 +587,9 @@ previously-visited pages,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." @@ -566,20 +617,22 @@ previously-visited pages,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 @@ -640,8 +693,7 @@ away CRs and any terminating period." (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))))) + (let ((page (elpher-page-from-url (substring-no-properties (match-string 0))))) (make-text-button (match-beginning 0) (match-end 0) 'elpher-page page @@ -714,7 +766,7 @@ ERROR can be either an error object or a string." (cancel-timer elpher-network-timer))) (defun elpher-make-network-timer (thunk) - "Creates a timer to run the THUNK after `elpher-connection-timeout' seconds. + "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." @@ -763,7 +815,7 @@ the host operating system and the local network capabilities.)" (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 @@ -784,7 +836,9 @@ the host operating system and the local network capabilities.)" (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 @@ -1012,25 +1066,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 @@ -1053,9 +1088,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. @@ -1098,7 +1131,20 @@ 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))))) @@ -1121,13 +1167,16 @@ If ADDRESS is not supplied or nil the record is rendered as an (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 @@ -1261,8 +1310,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) @@ -1403,7 +1451,7 @@ Returns nil in the event that the contents of the line following the => prefix are empty." (let ((l (split-string (substring link-line 2)))) (if l - (string-trim (elt l 0)) + (elpher-encode-url (string-trim (elt l 0))) nil))) (defun elpher-gemini-get-link-display-string (link-line) @@ -1413,7 +1461,7 @@ 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-url-to-iri rest))))) (defun elpher-collapse-dot-sequences (filename) "Collapse dot sequences in FILENAME. @@ -1441,13 +1489,13 @@ 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))))) (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))))) @@ -1498,15 +1546,21 @@ by HEADER-LINE." elpher--gemini-page-headings)) (unless (display-graphic-p) (insert (make-string level ?#) " ")) - (insert (propertize header 'face face)) + (insert (propertize header 'face face '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) @@ -1522,8 +1576,8 @@ width defined by `elpher-gemini-max-fill-width'." (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 2 text-line) - (replace-regexp-in-string "[>\*]" " " (match-string 0 text-line)) + (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))) @@ -1610,21 +1664,53 @@ 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)))) -;; Start page retrieval +;; File page -(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)) + (_ + (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" @@ -1665,14 +1751,15 @@ 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)) + 'action #'elpher-click-link 'follow-link t - 'help-echo help-string)) + '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" @@ -1705,8 +1792,8 @@ The result is rendered using RENDERER." 'help-echo help-string)) (insert "\n") (insert (propertize - (concat " (These documents should be available if you have installed Elpher \n" - " using MELPA. Otherwise you may 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))) @@ -1719,7 +1806,7 @@ This is rendered using `elpher-get-history-page' via `elpher-type-map'." (interactive) (elpher-visit-page (elpher-make-page "Current History Stack" - (elpher-make-special-address 'history)))) + (elpher-make-about-address 'history)))) (defun elpher-show-visited-pages () "Show the all the pages you've visited using Elpher. @@ -1728,7 +1815,7 @@ 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-special-address 'visited-pages)))) + (elpher-make-about-address 'visited-pages)))) (defun elpher-get-history-page (renderer) "Getter which displays the history page (RENDERER must be nil)." @@ -1744,13 +1831,13 @@ This is rendered using `elpher-get-visited-pages-page' via `elpher-type-map'." (error "Command not supported for history page")) (elpher-display-history-links (seq-filter (lambda (page) - (not (elpher-address-special-p (elpher-page-address 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 " ----")) + (let* ((title-line (concat " ---- " title " ----")) (footer-line (make-string (length title-line) ?-))) (elpher-with-clean-buffer (insert title-line "\n\n") @@ -1761,8 +1848,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)))) @@ -1785,20 +1872,22 @@ 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)) - (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-special-p address) - (error "Cannot bookmark %s" display-string) - `(,display-string - (defaults . (,display-string)) - (position . ,pos) - (location . ,url) - (handler . elpher-bookmark-jump))))) + (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) @@ -1809,8 +1898,7 @@ 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))) + (page (elpher-page-from-url cleaned-url))) (elpher-with-clean-buffer (elpher-visit-page page)) (set-buffer (get-buffer elpher-buffer-name)) @@ -1837,7 +1925,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)))) @@ -1849,11 +1936,12 @@ To bookmark the link at point use \\[elpher-bookmark-link]." (bookmark-store display-string (cdr record) t))) (bookmark-save)) -(defun elpher-open-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." - (interactive) +(defun elpher-get-bookmarks-page (renderer) + "Getter which displays the bookmarks (RENDERER must be nil)." + (when renderer + (elpher-visit-previous-page) + (error "Command not supported for bookmarks page")) + (let ((old-bookmarks-file (or (and (boundp 'elpher-bookmarks-file) elpher-bookmarks-file) (locate-user-emacs-file "elpher-bookmarks")))) @@ -1863,7 +1951,42 @@ 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 (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) + (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 () + "Interactive function to display the current list of elpher bookmarks." + (interactive) + (elpher-visit-page + (elpher-make-page "Elpher Bookmarks" + (elpher-make-about-address 'bookmarks)))) ;;; Integrations @@ -1984,6 +2107,7 @@ supports the old protocol elpher, where the link is self-contained." (setq eww-use-browse-url "\\`mailto:\\|\\(\\`gemini\\|\\`gopher\\|\\`finger\\)://") + ;;; Interactive procedures ;; @@ -2007,22 +2131,23 @@ supports the old protocol elpher, where the link is self-contained." "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-with-clean-buffer - (elpher-visit-page page)) - nil)) + (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))) + (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)))))) + (let* ((address (elpher-page-address elpher-current-page)) + (url (read-string "Gopher or Gemini URL: " + (unless (elpher-address-about-p address) + (elpher-address-to-url address))))) + (unless (string-empty-p (string-trim url)) + (elpher-visit-page (elpher-page-from-url url))))) (defun elpher-redraw () "Redraw current page." @@ -2048,7 +2173,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))) @@ -2071,17 +2196,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 @@ -2116,7 +2242,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))) @@ -2128,20 +2254,20 @@ When run interactively HOST-OR-URL is read from the minibuffer." (error "Command invalid for %s" (elpher-page-display-string elpher-current-page))))) (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." @@ -2150,20 +2276,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'." @@ -2211,7 +2338,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*) @@ -2243,7 +2370,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)