From: plugd Date: Wed, 21 Jul 2021 16:19:51 +0000 (+0200) Subject: Merge patches curated by Alex. X-Git-Tag: v3.0.0~22 X-Git-Url: https://thelambdalab.xyz/gitweb/index.cgi?p=elpher.git;a=commitdiff_plain;h=9d01af376d0575afba1593e982e57b859209d217;hp=3cddc8bdcb0a05ecd308c310bcd020f7288af4de Merge patches curated by Alex. --- diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b348ec1 --- /dev/null +++ b/.gitignore @@ -0,0 +1,13 @@ +elpher-loaddefs.el +elpher.elc +*.patch +*.tar +dir +*.info +*.html +*.pdf +*.aux +*.fn +*.fns +*.log +*.toc diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..e9cea43 --- /dev/null +++ b/Makefile @@ -0,0 +1,65 @@ +include config.mk + +.PHONY: all autoloads clean compile help info package + +.SUFFIXES: .texi .info + +all: clean package + +autoloads: $(PKG)-loaddefs.el + +compile: clean $(PKG).elc + +help: + $(info make help - show brief help) + $(info make - generate a tar file containing the package) + $(info make all - ditto) + $(info make package - ditto) + $(info make info - generate the info manual) + $(info make compile - byte-compile the package lisp files) + $(info make autoloads - create $(PKG)-loaddefs.el to load Elpher in-place) + $(info make clean - remove generated files) + @exit + +%.info: %.texi + $(MAKEINFO) --no-split $< -o $@ + +%.html: %.texi + $(MAKEINFO) --no-split --html $< -o $@ + +%.pdf: %.texi + $(MAKEINFO) --no-split --pdf $< -o $@ + +dir: $(PKG).info + $(INSTALLINFO) $? $@ + +info: $(PKG).info dir + +$(PKG)-$(VERSION).tar: $(PKG).info dir *.el COPYING + mkdir $(PKG)-$(VERSION) + cp -a $? $(PKG)-$(VERSION)/ + $(TAR) -cf $@ $(PKG)-$(VERSION) + rm -rf $(PKG)-$(VERSION) + +package: $(PKG)-$(VERSION).tar + +clean: + rm -f $(PKG).elc $(PKG)-loaddefs.el + rm -f $(PKG).info dir $(PKG)-$(VERSION).tar + rm -f $(PKG).html $(PKG).pdf $(PKG).aux $(PKG).fn $(PKG).fns $(PKG).log $(PKG).toc + +define LOADDEFS_TPL +(add-to-list 'load-path (directory-file-name\n\ +........................(or (file-name-directory #$$) (car load-path)))) +endef +#' (ends emacs font-face garbage due to previous single quote) + +$(PKG)-loaddefs.el: + $(EMACS) -L $(PWD) \ + --eval "(setq-default backup-inhibited t)" \ + --eval "(setq generated-autoload-file \"$(PWD)/$@\")" \ + --eval "(update-directory-autoloads \"$(PWD)\")" + sed -i "s/^;;; Code:$$/;;; Code:\n\n$(subst ., ,$(LOADDEFS_TPL))/" $@ + +$(PKG).elc: + $(EMACS) -f batch-byte-compile $(@:.elc=.el) diff --git a/README b/README index 5e88e6a..44899ab 100644 --- a/README +++ b/README @@ -85,12 +85,27 @@ Info directory which can be displayed using "C-h i". Contributors ------------ -Besides myself, the following people (in no particular order) have -generously provided assistance/patches for the impovement of elpher: - -* Bradley Thornton +The following people (in alphabetical order) have generously provided +assistance/patches for the impovement of elpher: + +* Alexis +* Christopher Brannon +* Zhiwei Chen +* condy0919 +* Étienne Deparis * Roy Koushik +* Simon Nicolussi +* Noodles! +* Jens Östlund +* F. Jason Park +* Omar Polo +* Koushk Roy +* Michel Alexandre Salim +* Alex Schroeder +* Daniel Semyonov * Simon South +* Bradley Thornton +* Tim Vaughan * Vee Licence diff --git a/RELEASE b/RELEASE new file mode 100644 index 0000000..ade220d --- /dev/null +++ b/RELEASE @@ -0,0 +1,15 @@ +Preparing a new Release +======================= + +When preparing a new release, set the version number: + +1. in config.mk: VERSION variable +2. in elpher.el: metadata at the top +3. in elpher.el: definition of elpher-version +4. in elpher-pkg.el: second argument to 'define-package' +5. in elpher.texi: 'settitle' declaration at the top + +Make sure the documentation is up to date and builds: + + make elpher.info elpher.html elpher.pdf + diff --git a/config.mk b/config.mk new file mode 100644 index 0000000..0c257d5 --- /dev/null +++ b/config.mk @@ -0,0 +1,7 @@ +PKG = elpher +VERSION = 2.11.0 + +INSTALLINFO = install-info +MAKEINFO = makeinfo +EMACS = emacs -Q --batch -nw +TAR = tar diff --git a/elpher-pkg.el b/elpher-pkg.el new file mode 100644 index 0000000..af4a208 --- /dev/null +++ b/elpher-pkg.el @@ -0,0 +1,9 @@ +(define-package "elpher" "2.11.0" "A friendly gopher and gemini client" + '((emacs "27.1")) + :keywords ("convenience") + :authors (("Tim Vaughan" . "plugd@thelambdalab.xyz")) + :maintainer ("Alex Schroeder" . "alex@alexschroeder.ch") + :url "https://alexschroeder.ch/cgit/elpher") +;; Local Variables: +;; no-byte-compile: t +;; end: diff --git a/elpher.el b/elpher.el index a107f07..245d301 100644 --- a/elpher.el +++ b/elpher.el @@ -1,13 +1,28 @@ -;;; elpher.el --- A friendly gopher and gemini client -*- lexical-binding:t -*- - -;; Copyright (C) 2019-2020 Tim Vaughan +;;; elpher.el --- A friendly gopher and gemini client -*- lexical-binding: t -*- + +;; Copyright (C) 2021 Jens Östlund +;; Copyright (C) 2021 F. Jason Park +;; Copyright (C) 2021 Christopher Brannon +;; Copyright (C) 2021 Omar Polo +;; Copyright (C) 2021 Noodles! +;; Copyright (C) 2020-2021 Alex Schroeder +;; Copyright (C) 2020 Zhiwei Chen +;; Copyright (C) 2020 condy0919 +;; Copyright (C) 2020 Alexis +;; Copyright (C) 2020 Étienne Deparis +;; Copyright (C) 2020 Simon Nicolussi +;; Copyright (C) 2020 Michel Alexandre Salim +;; Copyright (C) 2020 Koushk Roy +;; Copyright (C) 2020 Vee +;; Copyright (C) 2020 Simon South +;; Copyright (C) 2019-2021 Tim Vaughan ;; Author: Tim Vaughan ;; Created: 11 April 2019 -;; Version: 2.10.3 +;; Version: 2.11.0 ;; Keywords: comm gopher -;; Homepage: http://thelambdalab.xyz/elpher -;; Package-Requires: ((emacs "26.2")) +;; Homepage: https://alexschroeder.ch/cgit/elpher +;; Package-Requires: ((emacs "27.1")) ;; This file is not part of GNU Emacs. @@ -35,7 +50,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. @@ -48,7 +62,7 @@ ;; Elpher is under active development. Any suggestions for ;; improvements are welcome, and can be made on the official -;; project page, gopher://thelambdalab.xyz/1/projects/elpher/. +;; project page, https://alexschroeder.ch/cgit/elpher. ;;; Code: @@ -63,15 +77,32 @@ (require 'url-util) (require 'subr-x) (require 'dns) -(require 'ansi-color) (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.") ;;; Global constants ;; -(defconst elpher-version "2.10.3" +(defconst elpher-version "2.11.0" "Current version of elpher.") (defconst elpher-margin-width 6 @@ -95,11 +126,25 @@ (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)) + ((special start) elpher-get-start-page nil) + ((special history) elpher-get-history-page nil) + ((special history-all) elpher-get-history-all-page nil)) "Association list from types to getters, renderers, margin codes and index faces.") +;;; Internal variables +;; + +;; buffer-local +(defvar elpher--gemini-page-headings nil + "List of headings on the page.") + +(defvar elpher--gemini-page-links nil + "List of links on the page.") + +(defvar elpher--gemini-page-links-cache (make-hash-table :test 'equal) + "Hash of addresses and page links.") + ;;; Customization group ;; @@ -111,7 +156,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 @@ -120,8 +165,9 @@ Otherwise, use the system browser via the BROWSE-URL function." (defcustom elpher-auto-disengage-TLS nil "If non-nil, automatically disengage TLS following an unsuccessful connection. -While enabling this may seem convenient, it is also potentially dangerous as it -allows switching from an encrypted channel back to plain text without user input." +While enabling this may seem convenient, it is also potentially +dangerous as it allows switching from an encrypted channel back to +plain text without user input." :type '(boolean)) (defcustom elpher-connection-timeout 5 @@ -144,6 +190,11 @@ These certificates may be used for establishing authenticated TLS connections." "The command used to launch openssl when generating TLS client certificates." :type '(file)) +(defcustom elpher-default-url-type "gopher" + "Default URL type (i.e. scheme) to assume if not explicitly given." + :type '(choice (const "gopher") + (const "gemini"))) + (defcustom elpher-gemini-TLS-cert-checks nil "If non-nil, verify gemini server TLS certs using the default security level. Otherwise, certificate verification is disabled. @@ -168,16 +219,22 @@ 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 some servers which do not support IPv6 can take a long time to time-out." :type '(boolean)) +(defcustom elpher-socks-always nil + "If non-nil, elpher will establish network connections over a SOCKS proxy. +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." + :type '(boolean)) + ;; Face customizations (defgroup elpher-faces nil @@ -252,6 +309,10 @@ some servers which do not support IPv6 can take a long time to time-out." '((t :inherit fixed-pitch)) "Face used for pre-formatted gemini text blocks.") +(defface elpher-gemini-quoted + '((t :inherit font-lock-doc-face)) + "Face used for gemini quoted texts.") + ;;; Model ;; @@ -270,13 +331,17 @@ some servers which do not support IPv6 can take a long time to time-out." (unless (and (not (url-fullness url)) (url-type url)) (setf (url-fullness url) t) (unless (url-type url) - (setf (url-type url) "gopher")) + (setf (url-type url) elpher-default-url-type)) + (unless (url-host url) + (let ((p (split-string (url-filename url) "/" nil nil))) + (setf (url-host url) (car p)) + (setf (url-filename url) + (if (cdr p) + (concat "/" (mapconcat #'identity (cdr p) "/")) + "")))) (when (or (equal "gopher" (url-type url)) (equal "gophers" (url-type url))) ;; Gopher defaults - (unless (url-host url) - (setf (url-host url) (url-filename url)) - (setf (url-filename url) "")) (when (or (equal (url-filename url) "") (equal (url-filename url) "/")) (setf (url-filename url) "/1"))) @@ -328,6 +393,11 @@ requiring gopher-over-TLS." "Create an ADDRESS object corresponding to the given special address symbol TYPE." type) +(defun elpher-make-start-page () + "Create the start page." + (elpher-make-page "Elpher Start Page" + (elpher-make-special-address 'start))) + (defun elpher-address-to-url (address) "Get string representation of ADDRESS, or nil if ADDRESS is special." (if (elpher-address-special-p address) @@ -384,7 +454,7 @@ If no address is defined, returns 0. (This is for compatibility with the URL li (url-port address))) (defun elpher-address-special-p (address) - "Return non-nil if ADDRESS object is special (e.g. start page, bookmarks page)." + "Return non-nil if ADDRESS object is special (e.g. start page page)." (symbolp address)) (defun elpher-address-gopher-p (address) @@ -439,8 +509,17 @@ 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) -(defvar elpher-history nil) +(defvar elpher-current-page nil + "The current page for this Elpher buffer.") + +(defvar elpher-history nil + "The local history for this Elpher buffer. +This variable is used by `elpher-back' and +`elpher-show-history'.") + +(defvar elpher-history-all nil + "The global history for all Elpher buffers. +This variable is used by `elpher-show-history-all'.") (defun elpher-visit-page (page &optional renderer no-history) "Visit PAGE using its own renderer or RENDERER, if non-nil. @@ -451,16 +530,22 @@ unless NO-HISTORY is non-nil." (unless (or no-history (equal (elpher-page-address elpher-current-page) (elpher-page-address page))) - (push elpher-current-page elpher-history)) - (setq elpher-current-page page) + (push elpher-current-page elpher-history) + (push elpher-current-page elpher-history-all)) + (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)))) + (type-record (cdr (assoc type elpher-type-map))) + (page-links nil)) (if type-record - (funcall (car type-record) - (if renderer - renderer - (cadr 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))) (elpher-visit-previous-page) (pcase type (`(gopher ,type-char) @@ -476,7 +561,7 @@ unless NO-HISTORY is non-nil." (if previous-page (elpher-visit-page previous-page nil t) (error "No previous page")))) - + (defun elpher-reload-current-page () "Reload the current page, discarding any existing cached content." (elpher-cache-content (elpher-page-address elpher-current-page) nil) @@ -498,6 +583,9 @@ unless NO-HISTORY is non-nil." ;;; Buffer preparation ;; +(defvar elpher-buffer-name "*elpher*" + "The default name of the Elpher buffer.") + (defun elpher-update-header () "If `elpher-use-header' is true, display current page info in window header." (if elpher-use-header @@ -514,20 +602,21 @@ unless NO-HISTORY is non-nil." (defmacro elpher-with-clean-buffer (&rest args) "Evaluate ARGS with a clean *elpher* buffer as current." - (declare (debug (body))) - (list 'with-current-buffer "*elpher*" - '(elpher-mode) - (append (list 'let '((inhibit-read-only t)) - '(setq-local network-security-level - (default-value 'network-security-level)) - '(erase-buffer) - '(elpher-update-header)) - args))) + `(with-current-buffer elpher-buffer-name + (unless (eq major-mode 'elpher-mode) + ;; avoid resetting buffer-local variables + (elpher-mode)) + (let ((inhibit-read-only t)) + (setq-local network-security-level + (default-value 'network-security-level)) + (erase-buffer) + (elpher-update-header) + ,@args))) (defun elpher-buffer-message (string &optional line) "Replace first line in elpher buffer with STRING. If LINE is non-nil, replace that line instead." - (with-current-buffer "*elpher*" + (with-current-buffer elpher-buffer-name (let ((inhibit-read-only t)) (goto-char (point-min)) (if line @@ -557,7 +646,7 @@ If LINE is non-nil, replace that line instead." "Preprocess text selector response contained in STRING. This involes decoding the character representation, and clearing away CRs and any terminating period." - (elpher-decode (replace-regexp-in-string "\n\.\n$" "\n" + (elpher-decode (replace-regexp-in-string "\n\\.\n$" "\n" (replace-regexp-in-string "\r" "" string)))) @@ -615,36 +704,23 @@ the host operating system and the local network capabilities." (unless (< (elpher-address-port address) 65536) (error "Cannot establish network connection: port number > 65536")) (when (and (eq use-tls 'gemini) (not elpher-gemini-TLS-cert-checks)) - (setq-local network-security-level 'low)) + (setq-local network-security-level 'low) + (setq-local gnutls-verify-error nil)) (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))) (response-string-parts nil) (bytes-received 0) (hkbytes-received 0) - (proc (make-network-process :name "elpher-process" - :host host - :family (and force-ipv4 'ipv4) - :service (if (> port 0) port default-port) - :buffer nil - :coding 'binary - :noquery t - :nowait t - :tls-parameters - (and use-tls - (cons 'gnutls-x509pki - (gnutls-boot-parameters - :type 'gnutls-x509pki - :hostname host - :keylist - (elpher-get-current-keylist address)))))) (timer (run-at-time elpher-connection-timeout nil (lambda () (elpher-process-cleanup) (cond ; Try again with IPv4 - ((not force-ipv4) + ((not (or force-ipv4 socks)) (message "Connection timed out. Retrying with IPv4.") (elpher-get-host-response address default-port query-string @@ -661,8 +737,24 @@ the host operating system and the local network capabilities." response-processor nil force-ipv4)) (t - (elpher-network-error address "Connection time-out."))))))) + (elpher-network-error address "Connection time-out.")))))) + (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) + :service service + :buffer nil + :nowait t + :tls-parameters + (and use-tls + (cons 'gnutls-x509pki + (apply #'gnutls-boot-parameters + gnutls-params))))))) (setq elpher-network-timer timer) + (set-process-coding-system proc 'binary 'binary) + (set-process-query-on-exit-flag proc nil) (elpher-buffer-message (concat "Connecting to " host "..." " (press 'u' to abort)")) (set-process-filter proc @@ -675,10 +767,10 @@ the host operating system and the local network capabilities." (when (> new-hkbytes-received hkbytes-received) (setq hkbytes-received new-hkbytes-received) (elpher-buffer-message - (concat "(" - (number-to-string (/ hkbytes-received 10.0)) - " MB read)") - 1))) + (concat "(" + (number-to-string (/ hkbytes-received 10.0)) + " MB read)") + 1))) (setq response-string-parts (cons string response-string-parts)))) (set-process-sentinel proc @@ -695,7 +787,7 @@ the host operating system and the local network capabilities." (process-send-string proc query-string))) ((string-prefix-p "deleted" event)) ; do nothing ((and (not response-string-parts) - (not (or elpher-ipv4-always force-ipv4))) + (not (or elpher-ipv4-always force-ipv4 socks))) ; Try again with IPv4 (message "Connection failed. Retrying with IPv4.") (elpher-get-host-response address default-port @@ -711,7 +803,10 @@ the host operating system and the local network capabilities." (t (error "No response from server"))) (error - (elpher-network-error address the-error)))))) + (elpher-network-error address the-error))))) + (when socks + (if use-tls (apply #'gnutls-negotiate :process proc gnutls-params)) + (funcall (process-sentinel proc) proc "open\n"))) (error (error "Error initiating connection to server"))))) @@ -808,7 +903,7 @@ base for the installed key and certificate files." (mapcar (lambda (file) (file-name-sans-extension file)) - (directory-files elpher-certificate-directory nil "\.key$"))) + (directory-files elpher-certificate-directory nil "\\.key$"))) (defun elpher-forget-current-certificate () "Causes any current certificate to be forgotten.) @@ -930,7 +1025,7 @@ If ADDRESS is not supplied or nil the record is rendered as an (if type-map-entry (let* ((margin-code (elt type-map-entry 2)) (face (elt type-map-entry 3)) - (filtered-display-string (ansi-color-filter-apply display-string)) + (filtered-display-string (elpher-color-filter-apply display-string)) (page (elpher-make-page filtered-display-string address))) (elpher-insert-margin margin-code) (insert-text-button filtered-display-string @@ -968,7 +1063,7 @@ If ADDRESS is not supplied or nil the record is rendered as an ;; Text rendering (defconst elpher-url-regex - "\\([a-zA-Z]+\\)://\\([a-zA-Z0-9.\-]*[a-zA-Z0-9\-]\\|\[[a-zA-Z0-9:]+\]\\)\\(:[0-9]+\\)?\\(/\\([0-9a-zA-Z\-_~?/@|:.%#=&]*[0-9a-zA-Z\-_~?/@|#]\\)?\\)?" + "\\([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) @@ -979,24 +1074,24 @@ If ADDRESS is not supplied or nil the record is rendered as an (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))) + (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" - "Wildly incomplete regexp used to strip out some troublesome ANSI escape sequences.") + "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 - (ansi-color-filter-apply string) - (ansi-color-apply string)))) + (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." @@ -1029,9 +1124,9 @@ Currently includes buttonifying URLs and processing ANSI escape codes." (defun elpher-get-gopher-query-page (renderer) "Getter for gopher addresses requiring input. The response is rendered using the rendering function RENDERER." - (let* ((address (elpher-page-address elpher-current-page)) - (content (elpher-get-cached-content address)) - (aborted t)) + (let* ((address (elpher-page-address elpher-current-page)) + (content (elpher-get-cached-content address)) + (aborted t)) (if (and content (funcall renderer nil)) (elpher-with-clean-buffer (insert content) @@ -1052,7 +1147,7 @@ The response is rendered using the rendering function RENDERER." (elpher-get-gopher-response search-address renderer)) (if aborted (elpher-visit-previous-page)))))) - + ;; Raw server response rendering (defun elpher-render-raw (data &optional mime-type-string) @@ -1185,6 +1280,11 @@ that the response was malformed." (error "Gemini server response unknown: %s %s" response-code response-meta)))))) +(unless (fboundp 'read-answer) + (defun read-answer (question answers) + "Backfill for the new read-answer code." + (completing-read question (mapcar 'identity answers)))) + (defun elpher-choose-client-certificate () "Prompt for a client certificate to use to establish a TLS connection." (let* ((read-answer-short t)) @@ -1238,8 +1338,8 @@ that the response was malformed." (condition-case the-error (if (and content (funcall renderer nil)) (elpher-with-clean-buffer - (insert content) - (elpher-restore-pos)) + (insert content) + (elpher-restore-pos)) (elpher-with-clean-buffer (insert "LOADING GEMINI... (use 'u' to cancel)\n")) (setq elpher-gemini-redirect-chain nil) @@ -1344,11 +1444,12 @@ treatment that a separate function is warranted." (address (elpher-address-from-gemini-url url)) (type (if address (elpher-address-type address) nil)) (type-map-entry (cdr (assoc type elpher-type-map)))) + (setq elpher--gemini-page-links (append elpher--gemini-page-links `(,address))) (when display-string (insert elpher-gemini-link-string) (if type-map-entry (let* ((face (elt type-map-entry 3)) - (filtered-display-string (ansi-color-filter-apply display-string)) + (filtered-display-string (elpher-color-filter-apply display-string)) (page (elpher-make-page filtered-display-string address))) (insert-text-button filtered-display-string 'face face @@ -1358,7 +1459,7 @@ treatment that a separate function is warranted." 'help-echo #'elpher--page-button-help)) (insert (propertize display-string 'face 'elpher-unknown))) (insert "\n")))) - + (defun elpher-gemini-insert-header (header-line) "Insert header described by HEADER-LINE into a text/gemini document. The gemini map file line describing the header is given @@ -1366,16 +1467,17 @@ by HEADER-LINE." (when (string-match "^\\(#+\\)[ \t]*" header-line) (let* ((level (length (match-string 1 header-line))) (header (substring header-line (match-end 0))) - (face (pcase level + (face (pcase level (1 'elpher-gemini-heading1) (2 'elpher-gemini-heading2) (3 'elpher-gemini-heading3) (_ 'default))) - (fill-column (if (display-graphic-p) + (fill-column (if (display-graphic-p) (/ (* fill-column (font-get (font-spec :name (face-font 'default)) :size)) - (font-get (font-spec :name (face-font face)) :size)) - fill-column))) + (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)) @@ -1384,16 +1486,24 @@ by HEADER-LINE." (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* ((processed-text-line (if (match-string 2 text-line) - (concat - (replace-regexp-in-string "\*" - elpher-gemini-bullet-string - (match-string 0 text-line)) - (substring text-line (match-end 0))) - text-line)) - (adaptive-fill-mode nil) +width defined by `elpher-gemini-max-fill-width'." + (string-match "\\(^[ \t]*\\)\\(\\*[ \t]+\\|>[ \t]*\\)?" text-line) + (let* ((line-prefix (match-string 2 text-line)) + (processed-text-line + (if line-prefix + (cond ((string-prefix-p "*" line-prefix) + (concat + (replace-regexp-in-string "\\*" + elpher-gemini-bullet-string + (match-string 0 text-line)) + (substring text-line (match-end 0)))) + ((string-prefix-p ">" line-prefix) + (propertize text-line 'face 'elpher-gemini-quoted)) + (t text-line)) + text-line)) + (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)) nil))) @@ -1403,21 +1513,38 @@ width defined by elpher-gemini-max-fill-width." (defun elpher-render-gemini-map (data _parameters) "Render DATA as a gemini map file, PARAMETERS is currently unused." (elpher-with-clean-buffer - (let ((preformatted nil)) + (setq elpher--gemini-page-headings nil) + (let ((preformatted nil) + (link-counter 1)) (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))) (preformatted (insert (elpher-process-text-for-display (propertize line 'face 'elpher-gemini-preformatted)) "\n")) - ((string-prefix-p "=>" line) (elpher-gemini-insert-link line)) + ((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))) ((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)))) + (buffer-string)) + (puthash + (elpher-page-address elpher-current-page) + elpher--gemini-page-links + elpher--gemini-page-links-cache))) (defun elpher-render-gemini-plain-text (data _parameters) "Render DATA as plain text file. PARAMETERS is currently unused." @@ -1508,12 +1635,13 @@ The result is rendered using RENDERER." " - u/mouse-3/U: return to previous page or to the start page\n" " - o/O: visit different selector or the root menu of the current server\n" " - g: go to a particular address (gopher, gemini, finger)\n" + " - v: visit a numbered link on a gemini page\n" " - d/D: download item under cursor or current page\n" " - i/I: info on item under cursor or current page\n" " - c/C: copy URL representation of item under cursor or current page\n" " - a/A: bookmark the item under cursor or current page\n" - " - x/X: remove bookmark for item under cursor or current page\n" - " - B: visit the bookmarks page\n" + " - B: list all bookmarks\n" + " - h/H: show history of current buffer or for all buffers\n" " - r: redraw current page (using cached contents if available)\n" " - R: reload current page (regenerates cache)\n" " - S: set character coding system for gopher (default is to autodetect)\n" @@ -1532,9 +1660,6 @@ The result is rendered using RENDERER." (elpher-make-gopher-address ?7 "/v2/vs" "gopher.floodgap.com" 70)) (elpher-insert-index-record "Gemini Search Engine (geminispace.info)" (elpher-address-from-url "gemini://geminispace.info/search")) - (insert "\n" - "This page contains your bookmarked sites (also visit with B):\n") - (elpher-insert-index-record "Your Bookmarks" 'bookmarks) (insert "\n" "For Elpher release news or to leave feedback, visit:\n") (elpher-insert-index-record "The Elpher Project Page" @@ -1559,110 +1684,239 @@ The result is rendered using RENDERER." 'face 'shadow)) (elpher-restore-pos))) -;; Bookmarks page page retrieval +;; History page retrieval + +(defun elpher-history () + "Show the history of pages leading to the current page +in this buffer. Use \\[elpher-history-all] to see the entire history. +This is rendered using `elpher-get-history-page' via `elpher-type-map'." + (interactive) + (elpher-visit-page + (elpher-make-page "Elpher History Page" + (elpher-make-special-address 'history)))) + +(defun elpher-history-all () + "Show the all the pages you've visited using Elpher. +Use \\[elpher-history] to see just the history for the current buffer. +This is rendered using `elpher-get-history-all-page' via `elpher-type-map'." + (interactive) + (elpher-visit-page + (elpher-make-page "Elpher History Of All Seen Pages" + (elpher-make-special-address 'history-all)))) + +(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-show-history elpher-history)) -(defun elpher-get-bookmarks-page (renderer) - "Getter to load and display the current bookmark list (RENDERER must be nil)." +(defun elpher-get-history-all-page (renderer) + "Getter which displays the history page (RENDERER must be nil)." (when renderer (elpher-visit-previous-page) - (error "Command not supported for bookmarks page")) + (error "Command not supported for history page")) + (elpher-show-history elpher-history-all)) + +(defun elpher-show-history (pages) + "Show all PAGES in the Elpher buffer." (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 - 'action (lambda (_) - (interactive) - (find-file filename)) - 'follow-link t - 'help-echo help-string)) - (insert "\n") - (elpher-restore-pos))) - + (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")))) ;;; 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)) + (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))))) + +;;;###autoload +(defun elpher-bookmark-jump (bookmark) + "Go to a particular BOOKMARK." + (let* ((url (cdr (assq 'location bookmark)))) + (elpher-go url))) + +(defun elpher-set-bookmark-no-overwrite () + "Bookmark the link at point. +To bookmark the current page, use \\[bookmark-set-no-overwrite]." + (interactive) + (let ((elpher-bookmark-link t)) + (bookmark-set-no-overwrite))) + +(defun elpher-bookmark-import (file) + "Import Elpher bookmarks 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")))) + (require 'bookmark) + (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)) + +;;; Integrations ;; -(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." - (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))))) +;;; Org + +;; Avoid byte compilation warnings. +(eval-when-compile + (declare-function org-link-store-props "ol") + (declare-function org-link-set-parameters "ol")) + +(defun elpher-org-export-link (link description format protocol) + "Export a LINK with DESCRIPTION for the given PROTOCOL and FORMAT. + +FORMAT is an Org export backend. DESCRIPTION may be nil. PROTOCOL may be one +of gemini, gopher or finger." + (let* ((url (if (equal protocol "elpher") + (string-remove-prefix "elpher:" link) + (format "%s:%s" protocol link))) + (desc (or description url))) + (pcase format + (`gemini (format "=> %s %s" url desc)) + (`html (format "%s" url desc)) + (`latex (format "\\href{%s}{%s}" url desc)) + (_ (if (not description) + url + (format "%s (%s)" desc url)))))) + +(defun elpher-org-store-link () + "Store link to an `elpher' page in Org." + (when (eq major-mode 'elpher-mode) + (let* ((url (elpher-info-current)) + (desc (car elpher-current-page)) + (protocol (cond + ((string-prefix-p "gemini:" url) "gemini") + ((string-prefix-p "gopher:" url) "gopher") + ((string-prefix-p "finger:" url) "finger") + (t "elpher")))) + (when (equal "elpher" protocol) + ;; Weird link. Or special inner link? + (setq url (concat "elpher:" url))) + (org-link-store-props :type protocol :link url :description desc) + t))) + +(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 +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))) + +(with-eval-after-load 'org + (org-link-set-parameters + "elpher" + :store #'elpher-org-store-link + :export (lambda (link description format _plist) + (elpher-org-export-link link description format "elpher")) + :follow (lambda (link _arg) (elpher-org-follow-link link "elpher"))) + (org-link-set-parameters + "gemini" + :export (lambda (link description format _plist) + (elpher-org-export-link link description format "gemini")) + :follow (lambda (link _arg) (elpher-org-follow-link link "gemini"))) + (org-link-set-parameters + "gopher" + :export (lambda (link description format _plist) + (elpher-org-export-link link description format "gopher")) + :follow (lambda (link _arg) (elpher-org-follow-link link "gopher"))) + (org-link-set-parameters + "finger" + :export (lambda (link description format _plist) + (elpher-org-export-link link description format "finger")) + :follow (lambda (link _arg) (elpher-org-follow-link link "finger")))) + +;;; Browse URL + +;; Avoid byte compilation warnings. +(eval-when-compile + (defvar thing-at-point-uri-schemes)) + +;;;###autoload +(defun elpher-browse-url-elpher (url &rest _args) + "Browse URL using Elpher. This function is used by `browse-url'." + (interactive (browse-url-interactive-arg "Elpher URL: ")) + (elpher-go url)) + +;; Use elpher to open gopher, finger and gemini links +;; 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://")) + +;;; Mu4e: + +(eval-when-compile + (defvar mu4e~view-beginning-of-url-regexp)) + +(with-eval-after-load 'mu4e-view + ;; Make mu4e aware of the gemini world + (setq mu4e~view-beginning-of-url-regexp + "\\(?:https?\\|gopher\\|finger\\|gemini\\)://\\|mailto:")) ;;; Interactive procedures ;; @@ -1682,6 +1936,7 @@ If ADDRESS is already bookmarked, update the label only." (interactive) (push-button)) +;;;###autoload (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." @@ -1689,18 +1944,28 @@ When run interactively HOST-OR-URL is read from the minibuffer." (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*") - (elpher-visit-page page) + (switch-to-buffer elpher-buffer-name) + (elpher-with-clean-buffer + (elpher-visit-page page)) nil)) (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))) - (if (elpher-address-special-p address) - (error "Command invalid for this page") - (let ((url (read-string "Gopher or Gemini URL: " (elpher-address-to-url address)))) - (elpher-visit-page (elpher-make-page url (elpher-address-from-url url))))))) + (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)))) (defun elpher-redraw () "Redraw current page." @@ -1739,11 +2004,9 @@ When run interactively HOST-OR-URL is read from the minibuffer." (defun elpher-back-to-start () "Go all the way back to the start page." (interactive) - (setq elpher-current-page nil) - (setq elpher-history nil) - (let ((start-page (elpher-make-page "Elpher Start Page" - (elpher-make-special-address 'start)))) - (elpher-visit-page start-page))) + (setq-local elpher-current-page nil) + (setq-local elpher-history nil) + (elpher-visit-page (elpher-make-start-page))) (defun elpher-download () "Download the link at point." @@ -1807,73 +2070,6 @@ 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")))) - -(defun elpher-bookmarks () - "Visit bookmarks page." - (interactive) - (switch-to-buffer "*elpher*") - (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)) @@ -1889,7 +2085,7 @@ When run interactively HOST-OR-URL is read from the minibuffer." (if button (elpher-info-page (button-get button 'elpher-page)) (error "No item selected")))) - + (defun elpher-info-current () "Display information on current page." (interactive) @@ -1941,6 +2137,8 @@ When run interactively HOST-OR-URL is read from the minibuffer." (define-key map (kbd "O") 'elpher-root-dir) (define-key map (kbd "g") 'elpher-go) (define-key map (kbd "o") 'elpher-go-current) + (define-key map (kbd "h") 'elpher-history) + (define-key map (kbd "H") 'elpher-history-all) (define-key map (kbd "r") 'elpher-redraw) (define-key map (kbd "R") 'elpher-reload) (define-key map (kbd "T") 'elpher-toggle-tls) @@ -1952,41 +2150,42 @@ When run interactively HOST-OR-URL is read from the minibuffer." (define-key map (kbd "I") 'elpher-info-current) (define-key map (kbd "c") 'elpher-copy-link-url) (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 "a") 'elpher-set-bookmark-no-overwrite) + (define-key map (kbd "A") 'bookmark-set-no-overwrite) + (define-key map (kbd "B") 'bookmark-bmenu-list) (define-key map (kbd "S") 'elpher-set-gopher-coding-system) (define-key map (kbd "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 - (kbd "TAB") 'elpher-next-link - (kbd "C-") 'elpher-follow-current-link - (kbd "C-t") 'elpher-back - (kbd "u") 'elpher-back - (kbd "U") 'elpher-back-to-start - [mouse-3] 'elpher-back - (kbd "g") 'elpher-go - (kbd "o") 'elpher-go-current - (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 "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)) + (evil-define-key* + 'motion map + (kbd "TAB") 'elpher-next-link + (kbd "C-") 'elpher-follow-current-link + (kbd "C-t") 'elpher-back + (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 "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 "i") 'elpher-info-link + (kbd "I") 'elpher-info-current + (kbd "c") 'elpher-copy-link-url + (kbd "C") 'elpher-copy-current-url + (kbd "a") 'elpher-set-bookmark-no-overwrite + (kbd "A") 'bookmark-set-no-overwrite + (kbd "B") 'bookmark-bmenu-list + (kbd "S") 'elpher-set-gopher-coding-system + (kbd "F") 'elpher-forget-current-certificate + (kbd "v") 'elpher-visit-gemini-numbered-link)) map) "Keymap for gopher client.") @@ -1994,8 +2193,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'.") +functions which initialize the client, namely +`elpher', and `elpher-go'." + (setq-local elpher--gemini-page-headings nil) + (setq-local elpher-current-page nil) + (setq-local elpher-history nil) + (setq-local elpher-buffer-name (buffer-name)) + (setq-local bookmark-make-record-function #'elpher-bookmark-make-record) + (setq-local imenu-create-index-function #'elpher--gemini-page-headings)) (when (fboundp 'evil-set-initial-state) (evil-set-initial-state 'elpher-mode 'motion)) @@ -2005,17 +2210,27 @@ functions which initialize the gopher client, namely ;; ;;;###autoload -(defun elpher () - "Start elpher with default landing page." - (interactive) - (if (get-buffer "*elpher*") - (switch-to-buffer "*elpher*") - (switch-to-buffer "*elpher*") - (setq elpher-current-page nil) - (setq elpher-history nil) - (let ((start-page (elpher-make-page "Elpher Start Page" - (elpher-make-special-address 'start)))) - (elpher-visit-page start-page))) - "Started Elpher.") ; Otherwise (elpher) evaluates to start page string. +(defun elpher (&optional arg) + "Start elpher with default landing page. +The buffer used for Elpher sessions is determined by the value of +‘elpher-buffer-name’. If there is already an Elpher session active in +that buffer, Emacs will simply switch to it. Otherwise, a new session +will begin. A numeric prefix ARG (as in ‘\\[universal-argument] 42 +\\[execute-extended-command] elpher RET’) switches to the session with +that number, creating it if necessary. A non numeric prefix ARG means +to create a new session. Returns the buffer selected (or created)." + (interactive "P") + (let* ((name (default-value 'elpher-buffer-name)) + (buf (cond ((numberp arg) + (get-buffer-create (format "%s<%d>" name arg))) + (arg + (generate-new-buffer name)) + (t + (get-buffer-create name))))) + (pop-to-buffer-same-window buf) + (unless (buffer-modified-p) + (elpher-mode) + (elpher-visit-page (elpher-make-start-page)) + "Started Elpher."))); Otherwise (elpher) evaluates to start page string. ;;; elpher.el ends here diff --git a/elpher.texi b/elpher.texi index 7229c99..142be56 100644 --- a/elpher.texi +++ b/elpher.texi @@ -1,17 +1,19 @@ \input texinfo @c -*-texinfo-*- @setfilename elpher.info -@settitle Elpher Manual v2.10.0 +@settitle Elpher Manual v2.11.0 @dircategory Emacs @direntry -* Elpher: (elpher). A gopher and gemini client for Emacs. +* Elpher: (elpher). A gopher and gemini client for Emacs. @end direntry @copying This manual documents Elpher, a gopher and gemini client for Emacs. -Copyright @copyright{} 2019, 2020 Tim Vaughan +Copyright @copyright{} 2019, 2020 Tim Vaughan@* +Copyright @copyright{} 2021 Daniel Semyonov@* +Copyright @copyright{} 2021 Alex Schroeder @quotation The source and documentation of Elpher is free software. You can @@ -42,12 +44,6 @@ the file COPYING in the same directory as this file for more details. @top Elpher @insertcopying -@end ifnottex - -@macro keycmd{key,cmd} -@item \key\ (@code{\cmd\}) -@findex \cmd\ -@end macro @menu * Introduction:: Elpher Overview: what's this all about? @@ -73,6 +69,12 @@ Navigation @end detailmenu @end menu +@end ifnottex + +@macro keycmd{key,cmd} +@item \key\ (@code{\cmd\}) +@findex \cmd\ +@end macro @node Introduction, Installation, Top, Top @chapter Introduction @@ -98,9 +100,6 @@ auto-completing menu item navigation, direct visualization of image files where supported (no writing to disk), -@item -a bookmark management system, - @item basic support for the new ``heavier than gopher, lighter than the web'' Gemini protocol, @@ -134,10 +133,10 @@ to follow the instructions at @url{https://melpa.org/#/getting-started}. @kbd{M-x package-delete @key{RET} elpher @key{RET}}. @end example -While not recommended, it is also possible to install Elpher directly by -downloading the file @file{elpher.el} from -@url{gopher://thelambdalab.xyz/1/projects/elpher/}, adding it to a directory in -your @code{load-path}, and then adding +While not recommended, it is also possible to install Elpher directly +by downloading the file @file{elpher.el} from +@url{https://alexschroeder.ch/cgit/elpher}, adding it to a directory +in your @code{load-path}, and then adding @example (require 'elpher) @@ -183,12 +182,19 @@ rather than stick with the cached version. To do this use @key{R}. (This is particularly useful for search query results, where this allows you to perform a different search.) -That's more-or-less it. Elpher supports a number of other features, such -as bookmarking, support for different coding schemes and TLS encryption, -and a variety of customization options, all of which are explained in -the rest of this document. However the emphasis is on keeping the basic +That's more-or-less it. Elpher supports a number of other features, +such a support for different coding schemes and TLS encryption, and a +variety of customization options, all of which are explained in the +rest of this document. However the emphasis is on keeping the basic navigation experience as intuitive and responsive as possible. +Note that you can launch multiple Elpher sessions in parallel by using +a prefix: + +@example +@kbd{C-u M-x elpher @key{RET}} +@end example + @node Navigation, Bookmarks, Quick Start, Top @chapter Navigation Throughout this manual, we use the word ``page'' to refer to any @@ -223,7 +229,8 @@ links and menu items. @keycmd{@key{TAB}, elpher-next-link} Move to the next link or menu item in the file. -@keycmd{@kbd{Shift-@key{TAB}}/@key{backtab}, @code{elpher-prev-link}} +@item @kbd{Shift-@key{TAB}} or @key{BACKTAB} (@code{elpher-prev-link}) +@findex elpher-prev-link Move to the previous link or menu item in the file. @keycmd{@key{m}, elpher-jump} @@ -367,42 +374,53 @@ this will be automatically positioned on the link that was most recently followe from a given page. This means that, at least for links followed from menus and text files, the inverse of @key{u} is actually just @key{RET}. +Elpher actually maintains two histories, and there are two different +commands to access them: + +@table @asis +@keycmd{@key{h}, elpher-history} +This shows the history of the current buffer. This shows all the links +you would visit if you were to use @key{u} again and again. + +@keycmd{@key{H}, elpher-history-all} +This shows the entire Elpher browsing history. It includes all the +pages you visited using other Elpher buffers, and it includes buffers +you later killed. + +@end table @node Bookmarks, Gopher character encodings, Navigation, Top @chapter Bookmarks -Elpher has a very simple link bookmarking system involving the -following commands: +Elpher makes use of standard Emacs bookmarks. @xref{Bookmarks, , , +emacs, The Emacs Editor}. The following commands are perhaps the most +useful ones: @table @asis -@keycmd{@key{a}, elpher-bookmark-link} +@keycmd{@key{a}, elpher-set-bookmark-no-overwrite} Add a bookmark for the link at point. The minibuffer will prompt for a name for the bookmark, which defaults to the display string. -@keycmd{@key{A}, elpher-bookmark-current} +@keycmd{@key{A}, bookmark-set-no-overwrite} Add a bookmark for the current page. The minibuffer will prompt for a name for the bookmark, defaulting to the display string associated with the link that was followed to reach the current page. -@keycmd{@key{x}, elpher-unbookmark-link} -Immediately remove the bookmark (if one exists) to the link at point. - -@keycmd{@key{X}, elpher-unbookmark-current} -Immediately remove the bookmark (if one exists) to the current page. +@keycmd{@key{B}, bookmark-bmenu-list} +Open a page displaying all current bookmarks. This is where you can +delete and search bookmarks, for example. -@keycmd{@key{B}, elpher-bookmarks} -Open a page displaying all current bookmarks. Note that this bookmark -page is added to the history just as if you had opened it using a link. -Thus to return to the previous page, use @kbd{u}. This also means -that you can peruse the various bookmarks by visiting them in turn, -using @kbd{u} to return to the bookmark page (where the position of point -is cached), then moving to another bookmarked link and so on. @end table -Bookmarks are stored as a s-exp in the file @file{elpher-bookmarks} -in the user emacs directory (usually @file{~/.emacs.d/}). -Any command which modifies the list of bookmarks immediately updates -this file. +If all your bookmarks disappeared in an upgrade from 2.10 to 2.11, you +need to import the old Elpher bookmarks into your Emacs bookmarks +using + +@example +@kbd{M-x elpher-bookmark-import @key{RET}} +@end example + +Once this is done, you can delete the file with the Elpher bookmarks. @node Gopher character encodings, Encrypted gopher connections, Bookmarks, Top @chapter Gopher character encodings