X-Git-Url: https://thelambdalab.xyz/gitweb/index.cgi?p=elpher.git;a=blobdiff_plain;f=elpher.el;h=fcdd9f4d5c7c953aa38e0c63ef99d335a7194b81;hp=c22f7b86426c3985acd86cf677499066b1481264;hb=e2d59f11515f2879bdc2675528b74fbb9b802bea;hpb=ec368d41d17a7c06cd6dd9ac4cae719d0d324445 diff --git a/elpher.el b/elpher.el index c22f7b8..fcdd9f4 100644 --- a/elpher.el +++ b/elpher.el @@ -1,10 +1,10 @@ -;;; elpher.el --- A friendly gopher client. +;;; elpher.el --- A friendly gopher client. -*- lexical-binding:t -*- ;; Copyright (C) 2019 Tim Vaughan ;; Author: Tim Vaughan ;; Created: 11 April 2019 -;; Version: 2.0.0 +;; Version: 2.3.5 ;; Keywords: comm gopher ;; Homepage: https://github.com/tgvaughan/elpher ;; Package-Requires: ((emacs "26")) @@ -36,7 +36,8 @@ ;; - pleasant and configurable colouring of Gopher directories, ;; - direct visualisation of image files, ;; - a simple bookmark management system, -;; - connections using TLS encryption. +;; - connections using TLS encryption, +;; - basic support for the fledgling Gemini protocol. ;; To launch Elpher, simply use 'M-x elpher'. This will open a start ;; page containing information on key bindings and suggested starting @@ -58,12 +59,13 @@ (require 'pp) (require 'shr) (require 'url-util) +(require 'subr-x) ;;; Global constants ;; -(defconst elpher-version "2.0.0" +(defconst elpher-version "2.3.5" "Current version of elpher.") (defconst elpher-margin-width 6 @@ -75,7 +77,7 @@ ((gopher ?4) elpher-get-gopher-node elpher-render-download "bin" elpher-binary) ((gopher ?5) elpher-get-gopher-node elpher-render-download "bin" elpher-binary) ((gopher ?7) elpher-get-gopher-query-node elpher-render-index "?" elpher-search) - ((gopher ?9) elpher-get-gopher-node elpher-render-node-download "bin" elpher-binary) + ((gopher ?9) elpher-get-gopher-node elpher-render-download "bin" elpher-binary) ((gopher ?g) elpher-get-gopher-node elpher-render-image "img" elpher-image) ((gopher ?p) elpher-get-gopher-node elpher-render-image "img" elpher-image) ((gopher ?I) elpher-get-gopher-node elpher-render-image "img" elpher-image) @@ -88,7 +90,7 @@ (other-url elpher-get-other-url-node nil "url" elpher-other-url) ((special bookmarks) elpher-get-bookmarks-node nil) ((special start) elpher-get-start-node nil)) - "Association list from types to getters, margin codes and index faces.") + "Association list from types to getters, renderers, margin codes and index faces.") ;;; Customization group @@ -125,7 +127,7 @@ "Face used for html type directory records.") (defface elpher-gemini - '((t :inherit font-lock-function-name-face)) + '((t :inherit font-lock-regexp-grouping-backslash)) "Face used for html type directory records.") (defface elpher-other-url @@ -159,7 +161,7 @@ Otherwise, use the system browser via the BROWSE-URL function." :type '(boolean)) -(defcustom elpher-buttonify-urls-in-directories nil +(defcustom elpher-buttonify-urls-in-directories t "If non-nil, turns URLs matched in directories into clickable buttons." :type '(boolean)) @@ -189,37 +191,49 @@ allows switching from an encrypted channel back to plain text without user input (let ((data (match-data))) ; Prevent parsing clobbering match data (unwind-protect (let ((url (url-generic-parse-url url-string))) - (setf (url-fullness url) t) - (setf (url-filename url) - (url-unhex-string (url-filename url))) - (unless (url-type url) - (setf (url-type url) "gopher")) - (let ((is-gopher (or (equal "gopher" (url-type url)) - (equal "gophers" (url-type url)))) - (is-gemini (equal "gemini" (url-type url)))) - (when is-gopher + (unless (and (not (url-fullness url)) (url-type url)) + (setf (url-fullness url) t) + (setf (url-filename url) + (url-unhex-string (url-filename url))) + (unless (url-type url) + (setf (url-type url) "gopher")) + (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")))) + (setf (url-filename url) "/1"))) + (when (equal "gemini" (url-type url)) + ;; Gemini defaults + (if (equal (url-filename url) "") + (setf (url-filename url) "/")))) url) (set-match-data data)))) (defun elpher-make-gopher-address (type selector host port &optional tls) - "Create an ADDRESS object corresponding to the given gopher directory record -attributes: TYPE, SELECTOR, HOST and PORT." - (if (and (equal type ?h) - (string-prefix-p "URL:" selector)) - (elpher-address-from-url (elt (split-string selector "URL:") 1)) + "Create an ADDRESS object using gopher directory record attributes. +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 + ((and (equal type ?h) + (string-prefix-p "URL:" selector)) + (elpher-address-from-url (elt (split-string selector "URL:") 1))) + ((equal type ?8) + (elpher-address-from-url + (concat "telnet" + "://" host + ":" (number-to-string port)))) + (t (elpher-address-from-url (concat "gopher" (if tls "s" "") "://" host ":" (number-to-string port) "/" (string type) - selector)))) + selector))))) (defun elpher-make-special-address (type) "Create an ADDRESS object corresponding to the given special page symbol TYPE." @@ -232,7 +246,9 @@ attributes: TYPE, SELECTOR, HOST and PORT." nil)) (defun elpher-address-type (address) - "Retrieve selector type from ADDRESS object." + "Retrieve type of ADDRESS object. +This is used to determine how to retrieve and render the document the +address refers to, via the table `elpher-type-map'." (if (symbolp address) (list 'special address) (let ((protocol (url-type address))) @@ -244,14 +260,19 @@ attributes: TYPE, SELECTOR, HOST and PORT." (string-to-char (substring (url-filename address) 1))))) ((equal protocol "gemini") 'gemini) + ((equal protocol "telnet") + 'telnet) (t 'other-url))))) (defun elpher-address-protocol (address) + "Retrieve the transport protocol for ADDRESS. This is nil for special addresses." (if (symbolp address) nil (url-type address))) (defun elpher-address-filename (address) + "Retrieve the filename component of ADDRESS. +For gopher addresses this is a combination of the selector type and selector." (if (symbolp address) nil (url-filename address))) @@ -262,7 +283,15 @@ attributes: TYPE, SELECTOR, HOST and PORT." (defun elpher-address-port (address) "Retrieve port from ADDRESS object." - (url-port address)) + (if (symbolp address) + nil) + (if (> (url-port address) 0) + (url-port address) + (or (and (or (equal (url-type address) "gopher") + (equal (url-type address) "gophers")) + 70) + (and (equal (url-type address) "gemini") + 1965)))) (defun elpher-address-special-p (address) "Return non-nil if ADDRESS object is special (e.g. start page, bookmarks page)." @@ -361,9 +390,9 @@ unless PRESERVE-PARENT is non-nil." (`(gopher ,type-char) (error "Unsupported gopher selector type '%c' for '%s'" type-char (elpher-address-to-url address))) - (else + (other (error "Unsupported address type '%S' for '%s'" - type (elpher-address-to-url address))))))) + other (elpher-address-to-url address))))))) (defun elpher-visit-parent-node () "Visit the parent of the current node." @@ -395,7 +424,14 @@ unless PRESERVE-PARENT is non-nil." (defun elpher-update-header () "If `elpher-use-header' is true, display current node info in window header." (if elpher-use-header - (setq header-line-format (elpher-node-display-string elpher-current-node)))) + (let* ((display-string (elpher-node-display-string elpher-current-node)) + (address (elpher-node-address elpher-current-node)) + (url-string (if (elpher-address-special-p address) + "" + (concat " - " (elpher-address-to-url address) ""))) + (header (replace-regexp-in-string "%" "%%" (concat display-string + url-string)))) + (setq header-line-format header)))) (defmacro elpher-with-clean-buffer (&rest args) "Evaluate ARGS with a clean *elpher* buffer as current." @@ -428,22 +464,20 @@ away CRs and any terminating period." (replace-regexp-in-string "\r" "" string)))) -;;; Index rendering -;; - ;;; Network error reporting ;; (defun elpher-network-error (address error) + "Display ERROR message following unsuccessful negotiation with ADDRESS." (elpher-with-clean-buffer (insert (propertize "\n---- ERROR -----\n\n" 'face 'error) "When attempting to retrieve " (elpher-address-to-url address) ":\n" - (error-message-string the-error) ".\n" + (error-message-string error) "\n" (propertize "\n----------------\n\n" 'face 'error) "Press 'u' to return to the previous page."))) -;;; Gopher selector retrieval (all kinds) +;;; Gopher selector retrieval ;; (defun elpher-process-cleanup () @@ -469,25 +503,24 @@ up to the calling function." (if (gnutls-available-p) (when (not elpher-use-tls) (setq elpher-use-tls t) - (message "Engaging TLS mode.")) - (error "Cannot retrieve TLS selector: GnuTLS not available"))) + (message "Engaging TLS gopher mode.")) + (error "Cannot retrieve TLS gopher selector: GnuTLS not available"))) (condition-case the-error (let* ((kill-buffer-query-functions nil) (proc (open-network-stream "elpher-process" nil (elpher-address-host address) - (if (> (elpher-address-port address) 0) - (elpher-address-port address) - 70) + (elpher-address-port address) :type (if elpher-use-tls 'tls 'plain)))) (set-process-coding-system proc 'binary) (set-process-filter proc - (lambda (proc string) + (lambda (_proc string) (setq elpher-selector-string (concat elpher-selector-string string)))) (set-process-sentinel proc after) - (process-send-string proc - (concat (elpher-gopher-address-selector address) "\n"))) + (let ((inhibit-eol-conversion t)) + (process-send-string proc + (concat (elpher-gopher-address-selector address) "\r\n")))) (error (if (and (consp the-error) (eq (car the-error) 'gnutls-error) @@ -495,7 +528,7 @@ up to the calling function." (or elpher-auto-disengage-TLS (yes-or-no-p "Could not establish encrypted connection. Disable TLS mode? "))) (progn - (message "Disengaging TLS mode.") + (message "Disengaging TLS gopher mode.") (setq elpher-use-tls nil) (elpher-get-selector address after)) (elpher-process-cleanup) @@ -508,17 +541,19 @@ up to the calling function." "Press 'u' to return to the previous page."))))))) (defun elpher-get-gopher-node (renderer) + "Getter function for gopher nodes. +The RENDERER procedure is used to display the contents of the node +once they are retrieved from the gopher server." (let* ((address (elpher-node-address elpher-current-node)) (content (elpher-get-cached-content address))) (if (and content (funcall renderer nil)) - (progn - (elpher-with-clean-buffer) - (insert content) - (elpher-restore-pos)) + (elpher-with-clean-buffer + (insert content) + (elpher-restore-pos)) (elpher-with-clean-buffer (insert "LOADING... (use 'u' to cancel)")) (elpher-get-selector address - (lambda (proc event) + (lambda (_proc event) (unless (string-prefix-p "deleted" event) (funcall renderer elpher-selector-string) (elpher-restore-pos))))))) @@ -531,17 +566,18 @@ up to the calling function." ;; LF-only servers sadly exist, hence the following. (let ((str-processed (elpher-preprocess-text-response string))) (dolist (line (split-string str-processed "\n")) - (unless (= (length line) 0) - (let* ((type (elt line 0)) - (fields (split-string (substring line 1) "\t")) - (display-string (elt fields 0)) - (selector (elt fields 1)) - (host (elt fields 2)) - (port (if (elt fields 3) - (string-to-number (elt fields 3)) - nil)) - (address (elpher-make-gopher-address type selector host port))) - (elpher-insert-index-record display-string address)))))) + (ignore-errors + (unless (= (length line) 0) + (let* ((type (elt line 0)) + (fields (split-string (substring line 1) "\t")) + (display-string (elt fields 0)) + (selector (elt fields 1)) + (host (elt fields 2)) + (port (if (elt fields 3) + (string-to-number (elt fields 3)) + nil)) + (address (elpher-make-gopher-address type selector host port))) + (elpher-insert-index-record display-string address))))))) (defun elpher-insert-margin (&optional type-name) "Insert index margin, optionally containing the TYPE-NAME, into the current buffer." @@ -568,8 +604,8 @@ If ADDRESS is not supplied or nil the record is rendered as an (let* ((type (if address (elpher-address-type address) nil)) (type-map-entry (cdr (assoc type elpher-type-map)))) (if type-map-entry - (let* ((margin-code (elt type-map-entry 1)) - (face (elt type-map-entry 2)) + (let* ((margin-code (elt type-map-entry 2)) + (face (elt type-map-entry 3)) (node (elpher-make-node display-string address))) (elpher-insert-margin margin-code) (insert-text-button display-string @@ -581,11 +617,11 @@ If ADDRESS is not supplied or nil the record is rendered as an (pcase type ((or '(gopher ?i) 'nil) ;; Information (elpher-insert-margin) - (insert (propertize - (if elpher-buttonify-urls-in-directories - (elpher-buttonify-urls display-string) - display-string) - 'face 'elpher-info))) + (let ((propertized-display-string + (propertize display-string 'face 'elpher-info))) + (insert (if elpher-buttonify-urls-in-directories + (elpher-buttonify-urls propertized-display-string) + propertized-display-string)))) (`(gopher ,selector-type) ;; Unknown (elpher-insert-margin (concat (char-to-string selector-type) "?")) (insert (propertize display-string @@ -597,8 +633,8 @@ If ADDRESS is not supplied or nil the record is rendered as an (let ((node (button-get button 'elpher-node))) (elpher-visit-node node))) -(defun elpher-render-index (data) - "Render DATA as an index." +(defun elpher-render-index (data &optional _mime-type-string) + "Render DATA as an index. MIME-TYPE-STRING is unused." (elpher-with-clean-buffer (if (not data) t @@ -609,8 +645,8 @@ 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:]+\]\\)\\(?3::[0-9]+\\)?\\(?4:/[^<> \r\n\t(),]*\\)?" - "Regexp used to locate and buttinofy URLs in text files loaded by elpher.") + "\\([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 buttniofy URLs in text files loaded by elpher.") (defun elpher-buttonify-urls (string) "Turn substrings which look like urls in STRING into clickable buttons." @@ -618,34 +654,33 @@ If ADDRESS is not supplied or nil the record is rendered as an (insert string) (goto-char (point-min)) (while (re-search-forward elpher-url-regex nil t) - (let ((node (elpher-make-node (match-string 0) + (let ((node (elpher-make-node (substring-no-properties (match-string 0)) (elpher-address-from-url (match-string 0))))) (make-text-button (match-beginning 0) (match-end 0) 'elpher-node node 'action #'elpher-click-link 'follow-link t - 'help-echo (elpher-node-button-help node)))) + 'help-echo (elpher-node-button-help node) + 'face 'button))) (buffer-string))) -(defun elpher-render-text (data) - "Render DATA as text." +(defun elpher-render-text (data &optional _mime-type-string) + "Render DATA as text. MIME-TYPE-STRING is unused." (elpher-with-clean-buffer (if (not data) t - (insert (elpher-buttonify-urls - (elpher-preprocess-text-response) - elpher-selector-string)) + (insert (elpher-buttonify-urls (elpher-preprocess-text-response data))) (elpher-cache-content (elpher-node-address elpher-current-node) (buffer-string))))) ;; Image retrieval -(defun elpher-render-image (data) - "Display DATA as image." +(defun elpher-render-image (data &optional _mime-type-string) + "Display DATA as image. MIME-TYPE-STRING is unused." (if (not data) - f + nil (if (display-images-p) (progn (let ((image (create-image @@ -654,11 +689,13 @@ If ADDRESS is not supplied or nil the record is rendered as an (elpher-with-clean-buffer (insert-image image) (elpher-restore-pos)))) - (elpher-save-to-file data)))) + (elpher-render-download data)))) ;; Search retrieval and rendering (defun elpher-get-gopher-query-node (renderer) + "Getter for gopher addresses requiring input. +The response is rendered using the rendering function RENDERER." (let* ((address (elpher-node-address elpher-current-node)) (content (elpher-get-cached-content address)) (aborted t)) @@ -680,7 +717,7 @@ If ADDRESS is not supplied or nil the record is rendered as an (elpher-with-clean-buffer (insert "LOADING RESULTS... (use 'u' to cancel)")) (elpher-get-selector search-address - (lambda (proc event) + (lambda (_proc event) (unless (string-prefix-p "deleted" event) (funcall renderer elpher-selector-string) (elpher-restore-pos))))) @@ -689,10 +726,10 @@ If ADDRESS is not supplied or nil the record is rendered as an ;; Raw server response rendering -(defun elpher-render-raw (data) - "Display raw DATA in buffer." +(defun elpher-render-raw (data &optional _mime-type-string) + "Display raw DATA in buffer. MIME-TYPE-STRING is unused." (if (not data) - f + nil (elpher-with-clean-buffer (insert data) (goto-char (point-min))) @@ -700,10 +737,10 @@ If ADDRESS is not supplied or nil the record is rendered as an ;; File save "rendering" -(defun elpher-render-download (data) - "Save DATA to file." +(defun elpher-render-download (data &optional _mime-type-string) + "Save DATA to file. MIME-TYPE-STRING is unused." (if (not data) - f + nil (let* ((address (elpher-node-address elpher-current-node)) (selector (elpher-gopher-address-selector address))) (elpher-visit-parent-node) ; Do first in case of non-local exits. @@ -712,21 +749,21 @@ If ADDRESS is not supplied or nil the record is rendered as an nil nil nil (if (> (length filename-proposal) 0) filename-proposal - "gopher.file")))) - (with-temp-file filename - (insert elpher-selector-string) - (message (format "Saved to file %s." - elpher-download-filename))))))) + "download.file")))) + (let ((coding-system-for-write 'binary)) + (with-temp-file filename + (insert data))) + (message (format "Saved to file %s." filename)))))) ;; HTML rendering -(defun elpher-render-html (data) - "Render DATA as HTML using shr." +(defun elpher-render-html (data &optional _mime-type-string) + "Render DATA as HTML using shr. MIME-TYPE-STRING is unused." (elpher-with-clean-buffer (if (not data) t (let ((dom (with-temp-buffer - (insert string) + (insert data) (libxml-parse-html-region (point-min) (point-max))))) (shr-insert-document dom))))) @@ -734,46 +771,55 @@ If ADDRESS is not supplied or nil the record is rendered as an (defvar elpher-gemini-response) - -(defun elpher-get-gemini-response (address renderer) - "Retrieve gemini ADDRESS, then execute RENDERER on the result. +(defun elpher-get-gemini-response (address after) + "Retrieve gemini ADDRESS, then execute AFTER. The response is stored in the variable ‘elpher-gemini-response’." (setq elpher-gemini-response "") (if (not (gnutls-available-p)) - (error "Cannot retrieve TLS selector: GnuTLS not available") - (let* ((kill-buffer-query-functions nil) - (proc (open-network-stream "elpher-process" - nil - (elpher-address-host address) - (if (> (elpher-address-port address) 0) + (error "Cannot establish gemini connection: GnuTLS not available") + (condition-case the-error + (let* ((kill-buffer-query-functions nil) + (proc (open-network-stream "elpher-process" + nil + (elpher-address-host address) (elpher-address-port address) - 1965) - :type 'tls))) - (set-process-coding-system proc 'binary) - (set-process-filter proc - (lambda (proc string) - (setq elpher-gemini-response - (concat elpher-gemini-response string)))) - (set-process-sentinel proc - (lambda (proc event) - (unless (string-prefix-p "deleted" event) - (elpher-process-gemini-response #'after)))) - (process-send-string proc - (concat (elpher-address-to-url address) "\r\n"))))) + :type 'tls))) + (set-process-coding-system proc 'binary) + (set-process-filter proc + (lambda (_proc string) + (setq elpher-gemini-response + (concat elpher-gemini-response string)))) + (set-process-sentinel proc after) + (let ((inhibit-eol-conversion t)) + (process-send-string proc + (concat (elpher-address-to-url address) "\r\n")))) + (error + (error "Error initiating connection to server"))))) + +(defun elpher-parse-gemini-response (response) + "Parse the RESPONSE string and return a list of components +The list is of the form (code meta body). A response of nil implies +that the response was malformed." + (let ((header-end-idx (string-match "\r\n" response))) + (if header-end-idx + (let ((header (string-trim (substring response 0 header-end-idx))) + (body (substring response (+ header-end-idx 2)))) + (if (>= (length header) 2) + (let ((code (substring header 0 2)) + (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")))) (defun elpher-process-gemini-response (renderer) - "Process the gemini response found in the variable elpher-gemini-response and -pass the result to RENDERER." + "Process the gemini response and pass the result to RENDERER. +The response is assumed to be in the variable `elpher-gemini-response'." (condition-case the-error - (unless (string-prefix-p "deleted" event) - (let* ((response-header (car (split-string elpher-gemini-response "\r\n"))) - (response-body (substring elpher-gemini-response - (+ (string-match "\r\n" elpher-gemini-response) 2))) - (response-code (car (split-string response-header))) - (response-meta (string-trim - (substring response-header - (string-match "[ \t]+" response-header))))) + (let ((response-components (elpher-parse-gemini-response elpher-gemini-response))) + (let ((response-code (elt response-components 0)) + (response-meta (elt response-components 1)) + (response-body (elt response-components 2))) (pcase (elt response-code 0) (?1 ; Input required (elpher-with-clean-buffer @@ -781,23 +827,35 @@ pass the result to RENDERER." (let* ((query-string (read-string (concat response-meta ": "))) (url (elpher-address-to-url (elpher-node-address elpher-current-node))) (query-address (elpher-address-from-url (concat url "?" query-string)))) - (elpher-get-gemini query-address #'renderer))) + (elpher-get-gemini-response query-address + (lambda (_proc event) + (unless (string-prefix-p "deleted" event) + (funcall #'elpher-process-gemini-response + renderer) + (elpher-restore-pos)))))) (?2 ; Normal response - (message response-header) - (funcall #'renderer elpher-gemini-response)) + ;; (message response-header) + (funcall renderer response-body response-meta)) (?3 ; Redirect - (message "Following redirect to %s" meta) - (let ((redirect-address (elpher-address-from-gemini-url meta))) - (elpher-get-gemini redirect-address #'renderer))) + (message "Following redirect to %s" response-meta) + (let ((redirect-address (elpher-address-from-gemini-url response-meta))) + (elpher-get-gemini-response redirect-address + (lambda (_proc event) + (unless (string-prefix-p "deleted" event) + (funcall #'elpher-process-gemini-response + renderer) + (elpher-restore-pos)))))) (?4 ; Temporary failure - (error "Gemini server reports TEMPORARY FAILURE for this request")) + (error "Gemini server reports TEMPORARY FAILURE for this request: %s %s" + response-code response-meta)) (?5 ; Permanent failure - (error "Gemini server reports PERMANENT FAILURE for this request")) + (error "Gemini server reports PERMANENT FAILURE for this request: %s %s" + response-code response-meta)) (?6 ; Client certificate required (error "Gemini server requires client certificate (unsupported at this time)")) - (other - (error "Gemini server responded with unknown response code %S" - response-code))))) + (_other + (error "Gemini server response unknown: %s %s" + response-code response-meta))))) (error (elpher-network-error (elpher-node-address elpher-current-node) the-error)))) @@ -807,84 +865,99 @@ pass the result to RENDERER." (content (elpher-get-cached-content address))) (condition-case the-error (if (and content (funcall renderer nil)) - (progn + (elpher-with-clean-buffer (insert content) (elpher-restore-pos)) (elpher-with-clean-buffer (insert "LOADING GEMINI... (use 'u' to cancel)")) - (elpher-get-gemini address - (lambda (proc event) - (unless (string-prefix-p "deleted" event) - (funcall renderer elpher-gemini-response) - (elpher-restore-pos))))) + (elpher-get-gemini-response address + (lambda (_proc event) + (unless (string-prefix-p "deleted" event) + (funcall #'elpher-process-gemini-response + renderer) + (elpher-restore-pos))))) (error (elpher-network-error address the-error))))) -(defun elpher-render-gemini (data) - "Render gemini response DATA." - (if (not data) +(defun elpher-render-gemini (body &optional mime-type-string) + "Render gemini response BODY with rendering MIME-TYPE-STRING." + (if (not body) t - (let* ((response-header (car (split-string data "\r\n"))) - (response-body (substring data (+ (string-match "\r\n" data) 2))) - (mime-type-string (string-trim (substring response-header 2))) - (mime-type-string* (if (string-empty-p mime-type-string) + (let* ((mime-type-string* (if (or (not mime-type-string) + (string-empty-p mime-type-string)) "text/gemini; charset=utf-8" mime-type-string)) - (mime-type-split (split-string mime-type-string* ";")) + (mime-type-split (split-string mime-type-string* ";" t)) (mime-type (string-trim (car mime-type-split))) (parameters (mapcar (lambda (s) (let ((key-val (split-string s "="))) (list (downcase (string-trim (car key-val))) (downcase (string-trim (cadr key-val)))))) (cdr mime-type-split)))) - (if (and (equal "text/gemini" mime-type) - (not (assoc "charset" parameters))) - (setq parameters (cons (list "charset" "utf-8") parameters))) (when (string-prefix-p "text/" mime-type) - (if (assoc "charset" parameters) - (setq elpher-gemini-response - (decode-coding-string elpher-gemini-response - (intern (cadr (assoc "charset" parameters)))))) - (setq elpher-gemini-response - (replace-regexp-in-string "\r" "" elpher-gemini-response))) + (setq body (decode-coding-string + body + (if (assoc "charset" parameters) + (intern (cadr (assoc "charset" parameters))) + 'utf-8))) + (setq body (replace-regexp-in-string "\r" "" body))) (pcase mime-type ((or "text/gemini" "") - (elpher-render-gemini-text/gemini response-body parameters)) + (elpher-render-gemini-map body parameters)) ((pred (string-prefix-p "text/")) - (elpher-render-gemini-text/plain response-body parameters)) + (elpher-render-gemini-plain-text body parameters)) ((pred (string-prefix-p "image/")) - (elpher-render-image response-body)) - (other + (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))) (idx (string-match "[ \t]" rest))) (if idx (string-trim (substring rest (+ idx 1))) ""))) +(defun elpher-collapse-dot-sequences (filename) + "Collapse dot sequences in FILENAME. +For instance, the filename /a/b/../c/./d will reduce to /a/c/d" + (let* ((path (split-string filename "/")) + (path-reversed-normalized + (seq-reduce (lambda (a b) + (cond ((and a (equal b "..") (cdr a))) + ((and (not a) (equal b "..")) a) ;leading .. are dropped + ((equal b ".") a) + (t (cons b a)))) + path nil))) + (string-join (reverse path-reversed-normalized) "/"))) + (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))) (unless (and (url-type address) (not (url-fullness address))) ;avoid mangling mailto: urls (setf (url-fullness address) t) - (unless (url-host address) ;if there is an explicit host, filenames are explicit + (unless (url-host address) ;if there is an explicit host, filenames are absolute (setf (url-host address) (url-host (elpher-node-address elpher-current-node))) (unless (string-prefix-p "/" (url-filename address)) ;deal with relative links (setf (url-filename address) - (concat (file-name-directory + (concat (file-name-directory (url-filename (elpher-node-address elpher-current-node))) (url-filename address))))) (unless (url-type address) - (setf (url-type address) "gemini"))) + (setf (url-type address) "gemini")) + (if (equal (url-type address) "gemini") + (setf (url-filename address) + (elpher-collapse-dot-sequences (url-filename address))))) address)) -(defun elpher-render-gemini-text/gemini (data parameters) +(defun elpher-render-gemini-map (data _parameters) + "Render DATA as a gemini map file, PARAMETERS is currently unused." (elpher-with-clean-buffer (dolist (line (split-string data "\n")) (if (string-prefix-p "=>" line) @@ -899,9 +972,10 @@ pass the result to RENDERER." (elpher-node-address elpher-current-node) (buffer-string)))) -(defun elpher-render-gemini-text/plain (data parameters) +(defun elpher-render-gemini-plain-text (data _parameters) + "Render DATA as plain text file. PARAMETERS is currently unused." (elpher-with-clean-buffer - (insert (elpher-buttonify-urls (elpher-preprocess-text-response data))) + (insert (elpher-buttonify-urls data)) (elpher-cache-content (elpher-node-address elpher-current-node) (buffer-string)))) @@ -941,7 +1015,7 @@ pass the result to RENDERER." "Getter which displays the start page (RENDERER must be nil)." (when renderer (elpher-visit-parent-node) - (error "Command not supported for start page.")) + (error "Command not supported for start page")) (elpher-with-clean-buffer (insert " --------------------------------------------\n" " Elpher Gopher Client \n" @@ -953,9 +1027,10 @@ pass the result to RENDERER." " - 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: return to previous page\n" + " - u/mouse-3: return to previous page\n" " - o/O: visit different selector or the root menu of the current server\n" " - g: go to a particular gopher address\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" @@ -963,10 +1038,9 @@ pass the result to RENDERER." " - B: visit the bookmarks page\n" " - r: redraw current page (using cached contents if available)\n" " - R: reload current page (regenerates cache)\n" - " - T: toggle TLS mode\n" - " - d/D: download item under cursor or current page\n" + " - S: set character coding system for gopher (default is to autodetect)\n" + " - T: toggle TLS gopher mode\n" " - .: display the raw server response for the current page\n" - " - S: set an explicit character coding system (default is to autodetect)\n" "\n" "Start your exploration of gopher space:\n") (elpher-insert-index-record "Floodgap Systems Gopher Server" @@ -980,7 +1054,7 @@ pass the result to RENDERER." (let ((help-string "RET,mouse-1: Open Elpher info manual (if available)")) (insert-text-button "Elpher info manual" 'face 'link - 'action (lambda (button) + 'action (lambda (_) (interactive) (info "(elpher)")) 'follow-link t @@ -998,7 +1072,7 @@ pass the result to RENDERER." "Getter to load and display the current bookmark list (RENDERER must be nil)." (when renderer (elpher-visit-parent-node) - (error "Command not supported for bookmarks page.")) + (error "Command not supported for bookmarks page")) (elpher-with-clean-buffer (insert "---- Bookmark list ----\n\n") (let ((bookmarks (elpher-load-bookmarks))) @@ -1023,8 +1097,8 @@ pass the result to RENDERER." (defun elpher-make-bookmark (display-string url) "Make an elpher bookmark. DISPLAY-STRING determines how the bookmark will appear in the -bookmark list, while ADDRESS is the address of the entry." - (list display-string (elpher-address-to-url address))) +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." @@ -1038,11 +1112,10 @@ bookmark list, while ADDRESS is the address of the entry." "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 (locate-user-emacs-file "elpher2-bookmarks") + (with-temp-file (locate-user-emacs-file "elpher-bookmarks") (erase-buffer) (insert "; Elpher bookmarks file\n\n" "; Bookmarks are stored as a list of (label URL) items.\n" @@ -1052,11 +1125,21 @@ Beware that this completely replaces the existing contents of the file." (defun elpher-load-bookmarks () "Get the list of bookmarks from the users's bookmark file." - (with-temp-buffer - (ignore-errors - (insert-file-contents (locate-user-emacs-file "elpher2-bookmarks")) - (goto-char (point-min)) - (read (current-buffer))))) + (let ((bookmarks + (with-temp-buffer + (ignore-errors + (insert-file-contents (locate-user-emacs-file "elpher-bookmarks")) + (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.))) @@ -1066,7 +1149,7 @@ If ADDRESS is already bookmarked, update the label only." (let ((existing-bookmark (rassoc (list url) bookmarks))) (if existing-bookmark (elpher-set-bookmark-display-string existing-bookmark display-string) - (add-to-list 'bookmarks (elpher-make-bookmark display-string url)))) + (push (elpher-make-bookmark display-string url) bookmarks))) (elpher-save-bookmarks bookmarks))) (defun elpher-remove-address-bookmark (address) @@ -1110,7 +1193,7 @@ If ADDRESS is already bookmarked, update the label only." (interactive) (let ((address (elpher-node-address elpher-current-node))) (if (elpher-address-special-p address) - (error "Command not valid for this page") + (error "Command invalid for this page") (let ((url (read-string "Gopher or Gemini URL: " (elpher-address-to-url address)))) (elpher-visit-node (elpher-make-node url (elpher-address-from-url url))))))) @@ -1129,15 +1212,15 @@ If ADDRESS is already bookmarked, update the label only." (message "No current site."))) (defun elpher-toggle-tls () - "Toggle TLS encryption mode." + "Toggle TLS encryption mode for gopher." (interactive) (setq elpher-use-tls (not elpher-use-tls)) (if elpher-use-tls (if (gnutls-available-p) - (message "TLS mode enabled. (Will not affect current page until reload.)") + (message "TLS gopher mode enabled. (Will not affect current page until reload.)") (setq elpher-use-tls nil) - (error "Cannot enable TLS mode: GnuTLS not available")) - (message "TLS mode disabled. (Will not affect current page until reload.)"))) + (error "Cannot enable TLS gopher mode: GnuTLS not available")) + (message "TLS gopher mode disabled. (Will not affect current page until reload.)"))) (defun elpher-view-raw () "View raw server response for current page." @@ -1146,7 +1229,7 @@ If ADDRESS is already bookmarked, update the label only." (if (elpher-address-special-p (elpher-node-address elpher-current-node)) (error "This page was not generated by a server") (elpher-visit-node elpher-current-node - #'elpher-get-node-raw)) + #'elpher-render-raw)) (message "No current site."))) (defun elpher-back () @@ -1163,21 +1246,23 @@ If ADDRESS is already bookmarked, update the label only." (if button (let ((node (button-get button 'elpher-node))) (if (elpher-address-special-p (elpher-node-address node)) - (error "Cannot download this link") + (error "Cannot download %s" + (elpher-node-display-string node)) (elpher-visit-node (button-get button 'elpher-node) - #'elpher-get-node-download))) + #'elpher-render-download))) (error "No link selected")))) (defun elpher-download-current () "Download the current page." (interactive) (if (elpher-address-special-p (elpher-node-address elpher-current-node)) - (error "Cannot download this page") + (error "Cannot download %s" + (elpher-node-display-string elpher-current-node)) (elpher-visit-node (elpher-make-node (elpher-node-display-string elpher-current-node) (elpher-node-address elpher-current-node) elpher-current-node) - #'elpher-get-node-download + #'elpher-render-download t))) (defun elpher-build-link-map () @@ -1185,7 +1270,7 @@ If ADDRESS is already bookmarked, update the label only." (let ((link-map nil) (b (next-button (point-min) t))) (while b - (add-to-list 'link-map (cons (button-label b) b)) + (push (cons (button-label b) b) link-map) (setq b (next-button (button-start b)))) link-map)) @@ -1217,7 +1302,7 @@ If ADDRESS is already bookmarked, update the label only." (elpher-visit-node (elpher-make-node (elpher-address-to-url address-copy) address-copy)))) - (error "Command invalid for this page")))) + (error "Command invalid for %s" (elpher-node-display-string elpher-current-node))))) (defun elpher-bookmarks-current-p () "Return non-nil if current node is a bookmarks page." @@ -1290,7 +1375,7 @@ If ADDRESS is already bookmarked, update the label only." (address (elpher-node-address node))) (if (elpher-address-special-p address) (message "Special page: %s" display-string) - (message (elpher-address-to-url address))))) + (message "%s" (elpher-address-to-url address))))) (defun elpher-info-link () "Display information on node corresponding to link at point." @@ -1327,14 +1412,14 @@ If ADDRESS is already bookmarked, update the label only." (interactive) (elpher-copy-node-url elpher-current-node)) -(defun elpher-set-coding-system () - "Specify an explicit character coding system." +(defun elpher-set-gopher-coding-system () + "Specify an explicit character coding system for gopher selectors." (interactive) - (let ((system (read-coding-system "Set coding system to use (default is to autodetect): " nil))) + (let ((system (read-coding-system "Set coding system to use for gopher (default is to autodetect): " nil))) (setq elpher-user-coding-system system) (if system - (message "Coding system fixed to %s. (Reload to see effect)." system) - (message "Coding system set to autodetect. (Reload to see effect).")))) + (message "Gopher coding system fixed to %s. (Reload to see effect)." system) + (message "Gopher coding system set to autodetect. (Reload to see effect).")))) ;;; Mode and keymap @@ -1345,6 +1430,7 @@ If ADDRESS is already bookmarked, update the label only." (define-key map (kbd "TAB") 'elpher-next-link) (define-key map (kbd "") 'elpher-prev-link) (define-key map (kbd "u") 'elpher-back) + (define-key map [mouse-3] 'elpher-back) (define-key map (kbd "O") 'elpher-root-dir) (define-key map (kbd "g") 'elpher-go) (define-key map (kbd "o") 'elpher-go-current) @@ -1364,13 +1450,14 @@ If ADDRESS is already bookmarked, update the label only." (define-key map (kbd "x") 'elpher-unbookmark-link) (define-key map (kbd "X") 'elpher-unbookmark-current) (define-key map (kbd "B") 'elpher-bookmarks) - (define-key map (kbd "S") 'elpher-set-coding-system) - (when (fboundp 'evil-define-key) - (evil-define-key 'motion map + (define-key map (kbd "S") 'elpher-set-gopher-coding-system) + (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 + [mouse-3] 'elpher-back (kbd "g") 'elpher-go (kbd "o") 'elpher-go-current (kbd "r") 'elpher-redraw @@ -1389,12 +1476,12 @@ If ADDRESS is already bookmarked, update the label only." (kbd "x") 'elpher-unbookmark-link (kbd "X") 'elpher-unbookmark-current (kbd "B") 'elpher-bookmarks - (kbd "S") 'elpher-set-coding-system)) + (kbd "S") 'elpher-set-gopher-coding-system)) map) "Keymap for gopher client.") (define-derived-mode elpher-mode special-mode "elpher" - "Major mode for elpher, an elisp gopher client.) + "Major mode for elpher, an elisp gopher client. This mode is automatically enabled by the interactive functions which initialize the gopher client, namely