X-Git-Url: https://thelambdalab.xyz/gitweb/index.cgi?p=elpher.git;a=blobdiff_plain;f=elpher.el;h=6827d0eaf09ce98ae468ed3a06f75f137c20f9d8;hp=d8193b908efdd75af0dffb0e8ddc4b8497a12236;hb=8fe5ce318b38dd84429e3f16f44f1718defe1ba6;hpb=b2c40d40dd28e506a63d61bd03fd5d385e914ff4 diff --git a/elpher.el b/elpher.el index d8193b9..6827d0e 100644 --- a/elpher.el +++ b/elpher.el @@ -1,10 +1,10 @@ -;;; elpher.el --- A friendly gopher client -*- lexical-binding:t -*- +;;; elpher.el --- A friendly gopher and gemini client -*- lexical-binding:t -*- ;; Copyright (C) 2019 Tim Vaughan -;; Author: Tim Vaughan +;; Author: Tim Vaughan ;; Created: 11 April 2019 -;; Version: 2.6.1 +;; Version: 2.7.11 ;; Keywords: comm gopher ;; Homepage: http://thelambdalab.xyz/elpher ;; Package-Requires: ((emacs "26")) @@ -26,8 +26,8 @@ ;;; Commentary: -;; Elpher aims to provide a practical and friendly gopher client -;; for GNU Emacs. It supports: +;; Elpher aims to provide a practical and friendly gopher and gemini +;; client for GNU Emacs. It supports: ;; - intuitive keyboard and mouse-driven browsing, ;; - out-of-the-box compatibility with evil-mode, @@ -36,7 +36,7 @@ ;; - pleasant and configurable colouring of Gopher directories, ;; - direct visualisation of image files, ;; - a simple bookmark management system, -;; - connections using TLS encryption, +;; - gopher connections using TLS encryption, ;; - the fledgling Gemini protocol, ;; - the greybeard Finger protocol. @@ -64,12 +64,14 @@ (require 'subr-x) (require 'dns) (require 'ansi-color) +(require 'nsm) +(require 'gnutls) ;;; Global constants ;; -(defconst elpher-version "2.6.1" +(defconst elpher-version "2.7.11" "Current version of elpher.") (defconst elpher-margin-width 6 @@ -105,8 +107,73 @@ "A gopher client." :group 'applications) +;; General appearance and customizations + +(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." + :type '(boolean)) + +(defcustom elpher-use-header t + "If non-nil, display current page information in buffer header." + :type '(boolean)) + +(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." + :type '(boolean)) + +(defcustom elpher-connection-timeout 5 + "Specifies the number of seconds to wait for a network connection to time out." + :type '(integer)) + +(defcustom elpher-filter-ansi-from-text nil + "If non-nil, filter ANSI escape sequences from text. +The default behaviour is to use the ansi-color package to interpret these +sequences." + :type '(boolean)) + +(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. + +This defaults to off because it is standard practice for Gemini servers +to use self-signed certificates, meaning that most servers provide what +EMACS considers to be an invalid certificate." + :type '(boolean)) + +(defcustom elpher-gemini-max-fill-width 80 + "Specify the maximum default width (in columns) of text/gemini documents. +The actual width used is the minimum of this value and the window width at +the time when the text is rendered." + :type '(integer)) + +(defcustom elpher-gemini-link-string "→ " + "Specify the string used to indicate links when rendering gemini maps. +May be empty." + :type '(string)) + +(defcustom elpher-gemini-bullet-string "•" + "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)) + ;; Face customizations +(defgroup elpher-faces nil + "Elpher face customizations." + :group 'elpher) + (defface elpher-index '((t :inherit font-lock-keyword-face)) "Face used for directory type directory records.") @@ -133,7 +200,7 @@ (defface elpher-gemini '((t :inherit font-lock-regexp-grouping-backslash)) - "Face used for html type directory records.") + "Face used for Gemini type directory records.") (defface elpher-other-url '((t :inherit font-lock-comment-face)) @@ -159,43 +226,21 @@ '((t :inherit shadow)) "Face used for brackets around directory margin key.") -;; Other customizations +(defface elpher-gemini-heading1 + '((t :inherit bold :height 1.8)) + "Face used for gemini heading level 1.") -(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." - :type '(boolean)) - -(defcustom elpher-use-header t - "If non-nil, display current page information in buffer header." - :type '(boolean)) - -(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." - :type '(boolean)) - -(defcustom elpher-connection-timeout 5 - "Specifies the number of seconds to wait for a network connection to time out." - :type '(integer)) - -(defcustom elpher-filter-ansi-from-text nil - "If non-nil, filter ANSI escape sequences from text. -The default behaviour is to use the ansi-color package to interpret these -sequences." - :type '(boolean)) +(defface elpher-gemini-heading2 + '((t :inherit bold :height 1.5)) + "Face used for gemini heading level 2.") -(defcustom elpher-TLS-cert-checks nil - "If non-nil, verify server TLS certificates using the default -emacs security protocol. Otherwise, certificate verification is disabled. +(defface elpher-gemini-heading3 + '((t :inherit bold :height 1.2)) + "Face used for gemini heading level 3.") -This defaults to off because it is standard practice for Gemini servers -to use self-signed certificates, meaning that most servers provide what -emacs considers to be an invalid certificate. Since non-Gemini uses such -as gophers:// are essentially edge cases that rarely occur in the wild, -this setting applies to *all* TLS connections made by Elpher." - :type '(boolean)) +(defface elpher-gemini-preformatted + '((t :inherit fixed-pitch)) + "Face used for pre-formatted gemini text blocks.") ;;; Model ;; @@ -240,6 +285,7 @@ The basic attributes include: TYPE, SELECTOR, HOST and PORT. If the optional attribute TLS is non-nil, the address will be marked as requiring gopher-over-TLS." (cond + ((equal type ?i) nil) ((and (equal type ?h) (string-prefix-p "URL:" selector)) (elpher-address-from-url (elt (split-string selector "URL:") 1))) @@ -262,9 +308,9 @@ requiring gopher-over-TLS." (defun elpher-address-to-url (address) "Get string representation of ADDRESS, or nil if ADDRESS is special." - (if (not (elpher-address-special-p address)) - (url-encode-url (url-recreate-url address)) - nil)) + (if (elpher-address-special-p address) + nil + (url-encode-url (url-recreate-url address)))) (defun elpher-address-type (address) "Retrieve type of ADDRESS object. @@ -328,7 +374,7 @@ If no address is defined, returns 0. (This is for compatibility with the URL li "Retrieve gopher selector from ADDRESS object." (if (member (url-filename address) '("" "/")) "" - (substring (url-filename address) 2))) + (url-unhex-string (substring (url-filename address) 2)))) ;; Cache @@ -367,6 +413,10 @@ If no address is defined, returns 0. (This is for compatibility with the URL li "Retrieve the address corresponding to PAGE." (elt page 1)) +(defun elpher-page-set-address (page new-address) + "Set the address corresponding to PAGE to NEW-ADDRESS." + (setcar (cdr page) new-address)) + (defvar elpher-current-page nil) (defvar elpher-history nil) @@ -403,7 +453,7 @@ unless NO-HISTORY is non-nil." (let ((previous-page (pop elpher-history))) (if previous-page (elpher-visit-page previous-page nil t) - (error "No previous page.")))) + (error "No previous page")))) (defun elpher-reload-current-page () "Reload the current page, discarding any existing cached content." @@ -445,12 +495,27 @@ unless NO-HISTORY is non-nil." (list 'with-current-buffer "*elpher*" '(elpher-mode) (append (list 'let '((inhibit-read-only t)) - '(unless elpher-TLS-cert-checks - (setq-local network-security-level 'low)) + '(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*" + (let ((inhibit-read-only t)) + (goto-char (point-min)) + (if line + (goto-line line)) + (let ((data (match-data))) + (unwind-protect + (progn + (re-search-forward "^.*$") + (replace-match string)) + (set-match-data data)))))) + ;;; Text Processing ;; @@ -486,6 +551,112 @@ ERROR can be either an error object or a string." (propertize "\n----------------\n\n" 'face 'error) "Press 'u' to return to the previous page."))) +;;; General network communication + +(defun elpher-get-host-response (address default-port query-string response-processor + &optional use-tls force-ipv4) + (if (and use-tls (not (gnutls-available-p))) + (error "Use of TLS requires Emacs to be compiled with GNU TLS support") + (unless (< (elpher-address-port address) 65536) + (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)) + (condition-case nil + (let* ((kill-buffer-query-functions nil) + (port (elpher-address-port address)) + (host (elpher-address-host address)) + (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))))) + (timer (run-at-time elpher-connection-timeout nil + (lambda () + (elpher-process-cleanup) + (cond + ; Try again with IPv4 + ((not force-ipv4) + (message "Connection timed out. Retrying with IPv4.") + (elpher-get-host-response address default-port + query-string + response-processor + use-tls t)) + ((and use-tls + (not (eq use-tls 'gemini)) + (or elpher-auto-disengage-TLS + (y-or-n-p + "TLS connetion failed. Disable TLS mode and retry? "))) + (setq elpher-use-tls nil) + (elpher-get-host-response address default-port + query-string + response-processor + nil force-ipv4)) + (t + (elpher-network-error address "Connection time-out."))))))) + (setq elpher-network-timer timer) + (elpher-buffer-message (concat "Connecting to " host "...")) + (set-process-filter proc + (lambda (_proc string) + (when timer + (cancel-timer timer) + (setq timer nil)) + (setq bytes-received (+ bytes-received (length string))) + (let ((new-hkbytes-received (/ bytes-received 102400))) + (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)") + 2))) + (setq response-string-parts + (cons string response-string-parts)))) + (set-process-sentinel proc + (lambda (proc event) + (when timer + (cancel-timer timer)) + (condition-case the-error + (cond + ((string-prefix-p "open" event) ; request URL + (elpher-buffer-message + (concat "Connected to " host ". Receiving data...\n")) + (let ((inhibit-eol-conversion t)) + (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))) + ; Try again with IPv4 + (message "Connection failed. Retrying with IPv4.") + (elpher-get-host-response address default-port + query-string + response-processor + use-tls t)) + (response-string-parts + (elpher-with-clean-buffer + (insert "Data received. Rendering...")) + (funcall response-processor + (apply #'concat (reverse response-string-parts))) + (elpher-restore-pos)) + (t + (error "No response from server."))) + (error + (elpher-network-error address the-error)))))) + (error + (error "Error initiating connection to server"))))) + + ;;; Gopher selector retrieval ;; @@ -503,76 +674,12 @@ ERROR can be either an error object or a string." (defvar elpher-use-tls nil "If non-nil, use TLS to communicate with gopher servers.") -(defun elpher-get-selector (address renderer &optional force-ipv4) - "Retrieve selector specified by ADDRESS, then render it using RENDERER. -If FORCE-IPV4 is non-nil, explicitly look up and use IPv4 address corresponding -to ADDRESS." - (when (equal (elpher-address-protocol address) "gophers") - (if (gnutls-available-p) - (when (not elpher-use-tls) - (setq elpher-use-tls t) - (message "Engaging TLS gopher mode.")) - (error "Cannot retrieve TLS gopher selector: GnuTLS not available"))) - (unless (< (elpher-address-port address) 65536) - (error "Cannot retrieve gopher selector: port number > 65536")) - (condition-case nil - (let* ((kill-buffer-query-functions nil) - (port (elpher-address-port address)) - (host (elpher-address-host address)) - (selector-string-parts nil) - (proc (open-network-stream "elpher-process" - nil - (if force-ipv4 (dns-query host) host) - (if (> port 0) port 70) - :type (if elpher-use-tls 'tls 'plain) - :nowait t)) - (timer (run-at-time elpher-connection-timeout - nil - (lambda () - (pcase (process-status proc) - ('failed - (if (and (not (equal (elpher-address-protocol address) - "gophers")) - elpher-use-tls - (or elpher-auto-disengage-TLS - (yes-or-no-p "Could not establish encrypted connection. Disable TLS mode?"))) - (progn - (message "Disabling TLS mode.") - (setq elpher-use-tls nil) - (elpher-get-selector address renderer)) - (elpher-network-error address "Could not establish encrypted connection"))) - ('connect - (elpher-process-cleanup) - (unless force-ipv4 - (message "Connection timed out. Retrying with IPv4 address.") - (elpher-get-selector address renderer t)))))))) - (setq elpher-network-timer timer) - (set-process-coding-system proc 'binary) - (set-process-filter proc - (lambda (_proc string) - (cancel-timer timer) - (setq selector-string-parts - (cons string selector-string-parts)))) - (set-process-sentinel proc - (lambda (_proc event) - (condition-case the-error - (cond - ((string-prefix-p "deleted" event)) - ((string-prefix-p "open" event) - (let ((inhibit-eol-conversion t)) - (process-send-string - proc - (concat (elpher-gopher-address-selector address) - "\r\n")))) - (t - (cancel-timer timer) - (funcall renderer (apply #'concat - (reverse selector-string-parts))) - (elpher-restore-pos))) - (error - (elpher-network-error address the-error)))))) - (error - (error "Error initiating connection to server")))) +(defun elpher-get-gopher-response (address renderer) + (elpher-get-host-response address 70 + (concat (elpher-gopher-address-selector address) "\r\n") + renderer + (or (string= (elpher-address-protocol address) "gophers") + elpher-use-tls))) (defun elpher-get-gopher-page (renderer) "Getter function for gopher pages. @@ -585,9 +692,9 @@ once they are retrieved from the gopher server." (insert content) (elpher-restore-pos)) (elpher-with-clean-buffer - (insert "LOADING... (use 'u' to cancel)")) + (insert "LOADING... (use 'u' to cancel)\n")) (condition-case the-error - (elpher-get-selector address renderer) + (elpher-get-gopher-response address renderer) (error (elpher-network-error address the-error)))))) @@ -624,12 +731,19 @@ once they are retrieved from the gopher server." (insert " ")) (insert (make-string elpher-margin-width ?\s)))) -(defun elpher-page-button-help (page) - "Return a string containing the help text for a button corresponding to PAGE." - (let ((address (elpher-page-address page))) - (format "mouse-1, RET: open '%s'" (if (elpher-address-special-p address) - address - (elpher-address-to-url address))))) +(defun elpher--page-button-help (_window buffer pos) + "Function called by Emacs to generate mouse-over text. +The arguments specify the BUFFER and the POS within the buffer of the item +for which help is required. The function returns the help to be +displayed. The _WINDOW argument is currently unused." + (with-current-buffer buffer + (let ((button (button-at pos))) + (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)))))))) (defun elpher-insert-index-record (display-string &optional address) "Function to insert an index record into the current buffer. @@ -649,9 +763,9 @@ If ADDRESS is not supplied or nil the record is rendered as an 'elpher-page page 'action #'elpher-click-link 'follow-link t - 'help-echo (elpher-page-button-help page))) + 'help-echo #'elpher--page-button-help)) (pcase type - ((or '(gopher ?i) 'nil) ;; Information + ('nil ;; Information (elpher-insert-margin) (let ((propertized-display-string (propertize display-string 'face 'elpher-info))) @@ -695,7 +809,7 @@ If ADDRESS is not supplied or nil the record is rendered as an 'elpher-page page 'action #'elpher-click-link 'follow-link t - 'help-echo (elpher-page-button-help page) + 'help-echo #'elpher--page-button-help 'face 'button))) (buffer-string))) @@ -760,7 +874,7 @@ The response is rendered using the rendering function RENDERER." (elpher-with-clean-buffer (insert "LOADING RESULTS... (use 'u' to cancel)")) - (elpher-get-selector search-address renderer)) + (elpher-get-gopher-response search-address renderer)) (if aborted (elpher-visit-previous-page)))))) @@ -784,7 +898,9 @@ The response is rendered using the rendering function RENDERER." (if (not data) nil (let* ((address (elpher-page-address elpher-current-page)) - (selector (elpher-gopher-address-selector address))) + (selector (if (elpher-address-gopher-p address) + (elpher-gopher-address-selector address) + (elpher-address-filename address)))) (elpher-visit-previous-page) ; Do first in case of non-local exits. (let* ((filename-proposal (file-name-nondirectory selector)) (filename (read-file-name "Download complete. Save file as: " @@ -813,67 +929,12 @@ The response is rendered using the rendering function RENDERER." (defvar elpher-gemini-redirect-chain) -(defun elpher-get-gemini-response (address renderer &optional force-ipv4) - "Retrieve gemini ADDRESS, then render using RENDERER. -If FORCE-IPV4 is non-nil, explicitly look up and use IPv4 address corresponding -to ADDRESS." - (if (not (gnutls-available-p)) - (error "Cannot establish gemini connection: GnuTLS not available") - (unless (< (elpher-address-port address) 65536) - (error "Cannot establish gemini connection: port number > 65536")) - (condition-case nil - (let* ((kill-buffer-query-functions nil) - (port (elpher-address-port address)) - (host (elpher-address-host address)) - (response-string-parts nil) - (proc (open-network-stream "elpher-process" - nil - (if force-ipv4 (dns-query host) host) - (if (> port 0) port 1965) - :type 'tls - :nowait t)) - (timer (run-at-time elpher-connection-timeout nil - (lambda () - (elpher-process-cleanup) - (unless force-ipv4 - ; Try again with IPv4 - (message "Connection timed out. Retrying with IPv4.") - (elpher-get-gemini-response address renderer t)))))) - (setq elpher-network-timer timer) - (set-process-coding-system proc 'binary) - (set-process-filter proc - (lambda (_proc string) - (when timer - (cancel-timer timer) - (setq timer nil)) - (setq response-string-parts - (cons string response-string-parts)))) - (set-process-sentinel proc - (lambda (proc event) - (condition-case the-error - (cond - ((string-prefix-p "open" event) ; request URL - (let ((inhibit-eol-conversion t)) - (process-send-string - proc - (concat (elpher-address-to-url address) - "\r\n")))) - ((string-prefix-p "deleted" event)) ; do nothing - ((and (not response-string-parts) - (not force-ipv4)) - ; Try again with IPv4 - (message "Connection failed. Retrying with IPv4.") - (cancel-timer timer) - (elpher-get-gemini-response address renderer t)) - (t - (funcall #'elpher-process-gemini-response - (apply #'concat (reverse response-string-parts)) - renderer) - (elpher-restore-pos))) - (error - (elpher-network-error address the-error)))))) - (error - (error "Error initiating connection to server"))))) +(defun elpher-get-gemini-response (address renderer) + (elpher-get-host-response address 1965 + (concat (elpher-address-to-url address) "\r\n") + (lambda (response-string) + (elpher-process-gemini-response response-string renderer)) + 'gemini)) (defun elpher-parse-gemini-response (response) "Parse the RESPONSE string and return a list of components. @@ -888,7 +949,7 @@ that the response was malformed." (meta (string-trim (substring header 2)))) (list code meta body)) (error "Malformed response: No response status found in header %s" header))) - (error "Malformed response: No CRLF-delimited header found")))) + (error "Malformed response: No CRLF-delimited header found in response %s" response)))) (defun elpher-process-gemini-response (response-string renderer) "Process the gemini response RESPONSE-STRING and pass the result to RENDERER." @@ -901,8 +962,10 @@ that the response was malformed." (elpher-with-clean-buffer (insert "Gemini server is requesting input.")) (let* ((query-string (read-string (concat response-meta ": "))) - (url (elpher-address-to-url (elpher-page-address elpher-current-page))) - (query-address (elpher-address-from-url (concat url "?" query-string)))) + (query-address (seq-copy (elpher-page-address elpher-current-page))) + (old-fname (url-filename query-address))) + (setf (url-filename query-address) + (concat old-fname "?" (url-build-query-string `((,query-string))))) (elpher-get-gemini-response query-address renderer))) (?2 ; Normal response (funcall renderer response-body response-meta)) @@ -917,6 +980,7 @@ that the response was malformed." "gemini")) (error "Server tried to automatically redirect to non-gemini URL: %s" response-meta)) + (elpher-page-set-address elpher-current-page redirect-address) (add-to-list 'elpher-gemini-redirect-chain redirect-address) (elpher-get-gemini-response redirect-address renderer))) (?4 ; Temporary failure @@ -941,7 +1005,7 @@ that the response was malformed." (insert content) (elpher-restore-pos)) (elpher-with-clean-buffer - (insert "LOADING GEMINI... (use 'u' to cancel)")) + (insert "LOADING GEMINI... (use 'u' to cancel)\n")) (setq elpher-gemini-redirect-chain nil) (elpher-get-gemini-response address renderer)) (error @@ -980,19 +1044,25 @@ that the response was malformed." ((pred (string-prefix-p "image/")) (elpher-render-image body)) (_other - (error "Unsupported MIME type %S" mime-type)))))) - -(defun elpher-gemini-get-link-url (line) - "Extract the url portion of LINE, a gemini map file link line." - (string-trim (elt (split-string (substring line 2)) 0))) - -(defun elpher-gemini-get-link-display-string (line) - "Extract the display string portion of LINE, a gemini map file link line." - (let* ((rest (string-trim (elt (split-string line "=>") 1))) + (elpher-render-download body)))))) + +(defun elpher-gemini-get-link-url (link-line) + "Extract the url portion of LINK-LINE, a gemini map file link line. +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)) + nil))) + +(defun elpher-gemini-get-link-display-string (link-line) + "Extract the display string portion of LINK-LINE, a gemini map file link line. +Returns the url portion in the event that the display-string portion is empty." + (let* ((rest (string-trim (elt (split-string link-line "=>") 1))) (idx (string-match "[ \t]" rest))) - (if idx - (string-trim (substring rest (+ idx 1))) - ""))) + (string-trim (if idx + (substring rest (+ idx 1)) + rest)))) (defun elpher-collapse-dot-sequences (filename) "Collapse dot sequences in FILENAME. @@ -1009,17 +1079,18 @@ For instance, the filename /a/b/../c/./d will reduce to /a/c/d" (defun elpher-address-from-gemini-url (url) "Extract address from URL with defaults as per gemini map files." - (let ((address (url-generic-parse-url url))) + (let ((address (url-generic-parse-url url)) + (current-address (elpher-page-address elpher-current-page))) (unless (and (url-type address) (not (url-fullness address))) ;avoid mangling mailto: urls (setf (url-fullness address) t) (if (url-host address) ;if there is an explicit host, filenames are absolute (if (string-empty-p (url-filename address)) (setf (url-filename address) "/")) ;ensure empty filename is marked as absolute - (setf (url-host address) (url-host (elpher-page-address elpher-current-page))) + (setf (url-host address) (url-host current-address)) + (setf (url-port address) (url-port current-address)) (unless (string-prefix-p "/" (url-filename address)) ;deal with relative links (setf (url-filename address) - (concat (file-name-directory - (url-filename (elpher-page-address elpher-current-page))) + (concat (file-name-directory (url-filename current-address)) (url-filename address))))) (unless (url-type address) (setf (url-type address) "gemini")) @@ -1029,44 +1100,78 @@ For instance, the filename /a/b/../c/./d will reduce to /a/c/d" address)) (defun elpher-gemini-insert-link (link-line) + "Insert link described by LINK-LINE into a text/gemini document." (let* ((url (elpher-gemini-get-link-url link-line)) - (display-string (let ((s (elpher-gemini-get-link-display-string link-line))) - (if (string-empty-p s) url s))) + (display-string (elpher-gemini-get-link-display-string link-line)) (address (elpher-address-from-gemini-url url)) (type (if address (elpher-address-type address) nil)) (type-map-entry (cdr (assoc type elpher-type-map)))) - (insert "→ ") - (if type-map-entry - (let* ((face (elt type-map-entry 3)) - (filtered-display-string (ansi-color-filter-apply display-string)) - (page (elpher-make-page filtered-display-string address))) - (insert-text-button filtered-display-string - 'face face - 'elpher-page page - 'action #'elpher-click-link - 'follow-link t - 'help-echo (elpher-page-button-help page))) - (insert (propertize display-string 'face 'elpher-unknown))) - (insert "\n"))) + (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)) + (page (elpher-make-page filtered-display-string address))) + (insert-text-button filtered-display-string + 'face face + 'elpher-page page + 'action #'elpher-click-link + 'follow-link t + 'help-echo #'elpher--page-button-help)) + (insert (propertize display-string 'face 'elpher-unknown))) + (insert "\n")))) (defun elpher-gemini-insert-header (header-line) - (insert header-line "\n")) - -(defun elpher--trim-prefix-p (prefix string) - (string-prefix-p prefix (string-trim-left string))) + "Insert header described by HEADER-LINE into a text/gemini document. +The gemini map file line describing the header is given +by HEADER-LINE." + (when (string-match "^\\(#+\\)[ \t]*" header-line) + (let ((level (length (match-string 1 header-line))) + (header (substring header-line (match-end 0)))) + (unless (display-graphic-p) + (insert (make-string level ?#) " ")) + (insert (propertize header 'face + (pcase level + (1 'elpher-gemini-heading1) + (2 'elpher-gemini-heading2) + (3 'elpher-gemini-heading3) + (_ 'default))) + "\n")))) + +(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) + (fill-prefix (if (match-string 2 text-line) + (replace-regexp-in-string "[>\*]" " " (match-string 0 text-line)) + nil))) + (insert (elpher-process-text-for-display processed-text-line)) + (newline))) (defun elpher-render-gemini-map (data _parameters) "Render DATA as a gemini map file, PARAMETERS is currently unused." (elpher-with-clean-buffer (let ((preformatted nil)) (auto-fill-mode 1) + (setq-local fill-column (min (window-width) elpher-gemini-max-fill-width)) (dolist (line (split-string data "\n")) (cond - ((elpher--trim-prefix-p "```" line) (setq preformatted (not preformatted))) - (preformatted (insert (elpher-process-text-for-display line) "\n")) - ((elpher--trim-prefix-p "=>" line) (elpher-gemini-insert-link line)) - ((elpher--trim-prefix-p "#" line) (elpher-gemini-insert-header line)) - (t (insert (elpher-process-text-for-display line)) (newline))))) + ((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) (elpher-gemini-insert-header line)) + (t (elpher-gemini-insert-text line))))) (elpher-cache-content (elpher-page-address elpher-current-page) (buffer-string)))) @@ -1082,7 +1187,11 @@ For instance, the filename /a/b/../c/./d will reduce to /a/c/d" ;; Finger page connection (defun elpher-get-finger-page (renderer &optional force-ipv4) - "Opens a finger connection to the current page address and renders it using RENDERER." + "Opens a finger connection to the current page address. +The result is rendered using RENDERER. When the optional argument +FORCE-IPV4 or the variable `elpher-ipv4-always' are non-nil, the +IPv4 address returned by a DNS lookup will be used explicitly in +making the connection." (let* ((address (elpher-page-address elpher-current-page)) (content (elpher-get-cached-content address))) (if (and content (funcall renderer nil)) @@ -1090,54 +1199,16 @@ For instance, the filename /a/b/../c/./d will reduce to /a/c/d" (insert content) (elpher-restore-pos)) (elpher-with-clean-buffer - (insert "LOADING... (use 'u' to cancel)")) + (insert "LOADING... (use 'u' to cancel)\n")) (condition-case the-error (let* ((kill-buffer-query-functions nil) (user (let ((filename (elpher-address-filename address))) (if (> (length filename) 1) (substring filename 1) - (elpher-address-user address)))) - (port (let ((given-port (elpher-address-port address))) - (if (> given-port 0) given-port 79))) - (host (elpher-address-host address)) - (selector-string-parts nil) - (proc (open-network-stream "elpher-process" - nil - (if force-ipv4 (dns-query host) host) - port - :type 'plain - :nowait t)) - (timer (run-at-time elpher-connection-timeout - nil - (lambda () - (pcase (process-status proc) - ('connect - (elpher-process-cleanup) - (unless force-ipv4 - (message "Connection timed out. Retrying with IPv4 address.") - (elpher-get-finger-page renderer t)))))))) - (setq elpher-network-timer timer) - (set-process-coding-system proc 'binary) - (set-process-filter proc - (lambda (_proc string) - (cancel-timer timer) - (setq selector-string-parts - (cons string selector-string-parts)))) - (set-process-sentinel proc - (lambda (_proc event) - (condition-case the-error - (cond - ((string-prefix-p "deleted" event)) - ((string-prefix-p "open" event) - (let ((inhibit-eol-conversion t)) - (process-send-string - proc - (concat user "\r\n")))) - (t - (cancel-timer timer) - (funcall renderer (apply #'concat - (reverse selector-string-parts))) - (elpher-restore-pos))))))) + (elpher-address-user address))))) + (elpher-get-host-response address 79 + (concat user "\r\n") + renderer)) (error (elpher-network-error address the-error)))))) @@ -1182,7 +1253,7 @@ For instance, the filename /a/b/../c/./d will reduce to /a/c/d" (error "Command not supported for start page")) (elpher-with-clean-buffer (insert " --------------------------------------------\n" - " Elpher Gopher Client \n" + " Elpher Gopher and Gemini Client \n" " version " elpher-version "\n" " --------------------------------------------\n" "\n" @@ -1191,9 +1262,9 @@ For instance, the filename /a/b/../c/./d will reduce to /a/c/d" " - TAB/Shift-TAB: next/prev item on current page\n" " - RET/mouse-1: open item under cursor\n" " - m: select an item on current page by name (autocompletes)\n" - " - u/mouse-3: return to previous page\n" + " - u/mouse-3/U: return to previous page or to the start page\n" " - o/O: visit different selector or the root menu of the current server\n" - " - g: go to a particular gopher address\n" + " - g: go to a particular address (gopher, gemini, finger)\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" @@ -1206,13 +1277,17 @@ For instance, the filename /a/b/../c/./d will reduce to /a/c/d" " - T: toggle TLS gopher mode\n" " - .: display the raw server response for the current page\n" "\n" - "Start your exploration of gopher space:\n") + "Start your exploration of gopher space and gemini:\n") (elpher-insert-index-record "Floodgap Systems Gopher Server" (elpher-make-gopher-address ?1 "" "gopher.floodgap.com" 70)) + (elpher-insert-index-record "Project Gemini home page" + (elpher-address-from-url "gemini://gemini.circumlunar.space/")) (insert "\n" - "Alternatively, select the following item and enter some search terms:\n") - (elpher-insert-index-record "Veronica-2 Gopher Search Engine" + "Alternatively, select a search engine and enter some search terms:\n") + (elpher-insert-index-record "Gopher Search Engine (Veronica-2)" (elpher-make-gopher-address ?7 "/v2/vs" "gopher.floodgap.com" 70)) + (elpher-insert-index-record "Gemini Search Engine (GUS)" + (elpher-address-from-url "gemini://gus.guru/search")) (insert "\n" "This page contains your bookmarked sites (also visit with B):\n") (elpher-insert-index-record "Your Bookmarks" 'bookmarks) @@ -1263,7 +1338,7 @@ For instance, the filename /a/b/../c/./d will reduce to /a/c/d" "- a: rename selected bookmark\n" "\n" "Bookmarks are stored in the file ") - (let ((filename (locate-user-emacs-file "elpher-bookmarks")) + (let ((filename elpher-bookmarks-file) (help-string "RET,mouse-1: Open bookmarks file in new buffer for editing.")) (insert-text-button filename 'face 'link @@ -1300,7 +1375,7 @@ bookmark list, while URL is the url of the entry." (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 (locate-user-emacs-file "elpher-bookmarks") + (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" @@ -1313,7 +1388,7 @@ Beware that this completely replaces the existing contents of the file." (let ((bookmarks (with-temp-buffer (ignore-errors - (insert-file-contents (locate-user-emacs-file "elpher-bookmarks")) + (insert-file-contents elpher-bookmarks-file) (goto-char (point-min)) (read (current-buffer)))))) (if (and bookmarks (listp (cadar bookmarks))) @@ -1367,11 +1442,12 @@ If ADDRESS is already bookmarked, update the label only." "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 ((page (elpher-make-page host-or-url - (elpher-address-from-url host-or-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*") (elpher-visit-page page) - '())) + nil)) (defun elpher-go-current () "Go to a particular site read from the minibuffer, initialized with the current URL." @@ -1416,6 +1492,15 @@ When run interactively HOST-OR-URL is read from the minibuffer." (interactive) (elpher-visit-previous-page)) +(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))) + (defun elpher-download () "Download the link at point." (interactive) @@ -1521,7 +1606,8 @@ When run interactively HOST-OR-URL is read from the minibuffer." "Remove bookmark for the current page." (interactive) (let ((address (elpher-page-address elpher-current-page))) - (unless (elpher-address-special-p address) + (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.")))) @@ -1530,10 +1616,11 @@ When run interactively HOST-OR-URL is read from the minibuffer." (interactive) (let ((button (button-at (point)))) (if button - (let ((page (button-get button 'elpher-page))) - (elpher-remove-address-bookmark (elpher-page-address page)) - (elpher-reload-bookmarks) - (message "Bookmark removed.")) + (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 () @@ -1603,7 +1690,9 @@ When run interactively HOST-OR-URL is read from the minibuffer." (let ((map (make-sparse-keymap))) (define-key map (kbd "TAB") 'elpher-next-link) (define-key map (kbd "") 'elpher-prev-link) + (define-key map (kbd "C-M-i") 'elpher-prev-link) (define-key map (kbd "u") 'elpher-back) + (define-key map (kbd "U") 'elpher-back-to-start) (define-key map [mouse-3] 'elpher-back) (define-key map (kbd "O") 'elpher-root-dir) (define-key map (kbd "g") 'elpher-go) @@ -1631,6 +1720,7 @@ When run interactively HOST-OR-URL is read from the minibuffer." (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 @@ -1676,6 +1766,7 @@ functions which initialize the gopher client, namely (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)))