X-Git-Url: https://thelambdalab.xyz/gitweb/index.cgi?p=elpher.git;a=blobdiff_plain;f=elpher.el;h=3c8db4a8925798a778d55befc127797eea937091;hp=ab75730f95466125590bbdc57d4502ddc27f2ce3;hb=8c6839a51a399ccb45fd2c9d7387bf324eb38a67;hpb=b4f69e8bbbde380f1799e3b5190ccde1312a36e7 diff --git a/elpher.el b/elpher.el index ab75730..3c8db4a 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.7.4 +;; Version: 2.7.8 ;; 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. @@ -70,7 +70,7 @@ ;;; Global constants ;; -(defconst elpher-version "2.7.4" +(defconst elpher-version "2.7.8" "Current version of elpher.") (defconst elpher-margin-width 6 @@ -222,6 +222,10 @@ the time when the text is rendered." '((t :inherit bold :height 1.2)) "Face used for gemini heading level 3.") +(defface elpher-gemini-preformatted + '((t :inherit fixed-pitch)) + "Face used for pre-formatted gemini text blocks.") + ;;; Model ;; @@ -265,6 +269,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))) @@ -353,7 +358,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 @@ -546,9 +551,12 @@ to ADDRESS." (error "Cannot retrieve gopher selector: port number > 65536")) (condition-case nil (let* ((kill-buffer-query-functions nil) + (gnutls-verify-error nil) ; We use the NSM for verification (port (elpher-address-port address)) (host (elpher-address-host address)) (selector-string-parts nil) + (bytes-received 0) + (hkbytes-received 0) (proc (open-network-stream "elpher-process" nil (if force-ipv4 (dns-query host) host) @@ -579,7 +587,21 @@ to ADDRESS." (set-process-coding-system proc 'binary) (set-process-filter proc (lambda (_proc string) - (cancel-timer timer) + (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) + (with-current-buffer "*elpher*" + (let ((inhibit-read-only t)) + (goto-char (point-min)) + (beginning-of-line 2) + (delete-region (point) (point-max)) + (insert "(" + (number-to-string (/ hkbytes-received 10.0)) + " MB read)"))))) (setq selector-string-parts (cons string selector-string-parts)))) (set-process-sentinel proc @@ -594,7 +616,9 @@ to ADDRESS." (concat (elpher-gopher-address-selector address) "\r\n")))) (t - (cancel-timer timer) + (when timer + (cancel-timer timer) + (setq timer nil)) (funcall renderer (apply #'concat (reverse selector-string-parts))) (elpher-restore-pos))) @@ -614,7 +638,7 @@ 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) (error @@ -680,7 +704,7 @@ If ADDRESS is not supplied or nil the record is rendered as an 'follow-link t 'help-echo (elpher-page-button-help page))) (pcase type - ((or '(gopher ?i) 'nil) ;; Information + ('nil ;; Information (elpher-insert-margin) (let ((propertized-display-string (propertize display-string 'face 'elpher-info))) @@ -813,7 +837,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: " @@ -854,9 +880,12 @@ to ADDRESS." (error "Cannot establish gemini connection: port number > 65536")) (condition-case nil (let* ((kill-buffer-query-functions nil) + (gnutls-verify-error nil) ; We use the NSM for verification (port (elpher-address-port address)) (host (elpher-address-host address)) (response-string-parts nil) + (bytes-received 0) + (hkbytes-received 0) (proc (open-network-stream "elpher-process" nil (if force-ipv4 (dns-query host) host) @@ -877,6 +906,18 @@ to ADDRESS." (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) + (with-current-buffer "*elpher*" + (let ((inhibit-read-only t)) + (goto-char (point-min)) + (beginning-of-line 2) + (delete-region (point) (point-max)) + (insert "(" + (number-to-string (/ hkbytes-received 10.0)) + " MB read)"))))) (setq response-string-parts (cons string response-string-parts)))) (set-process-sentinel proc @@ -902,7 +943,7 @@ to ADDRESS." renderer) (elpher-restore-pos))) (error - (elpher-network-error address the-error)))))) + (elpher-network-error address the-error)))))) (error (error "Error initiating connection to server"))))) @@ -919,7 +960,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." @@ -973,7 +1014,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 @@ -1012,7 +1053,7 @@ that the response was malformed." ((pred (string-prefix-p "image/")) (elpher-render-image body)) (_other - (error "Unsupported MIME type %S" mime-type)))))) + (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. @@ -1105,6 +1146,15 @@ by HEADER-LINE." (_ '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." + (insert (elpher-process-text-for-display text-line)) + (let* ((prefix-end-idx (string-match "^[ \t]*\\(\*+[ \t]\\)?" text-line)) + (fill-prefix (replace-regexp-in-string "\*" " " (match-string 0 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 @@ -1114,10 +1164,12 @@ by HEADER-LINE." (dolist (line (split-string data "\n")) (cond ((string-prefix-p "```" line) (setq preformatted (not preformatted))) - (preformatted (insert (elpher-process-text-for-display line) "\n")) + (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 (insert (elpher-process-text-for-display line)) (newline))))) + (t (elpher-gemini-insert-text line))))) (elpher-cache-content (elpher-page-address elpher-current-page) (buffer-string)))) @@ -1141,7 +1193,7 @@ by HEADER-LINE." (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))) @@ -1171,7 +1223,9 @@ by HEADER-LINE." (set-process-coding-system proc 'binary) (set-process-filter proc (lambda (_proc string) - (cancel-timer timer) + (when timer + (cancel-timer timer) + (setq timer nil)) (setq selector-string-parts (cons string selector-string-parts)))) (set-process-sentinel proc @@ -1185,7 +1239,9 @@ by HEADER-LINE." proc (concat user "\r\n")))) (t - (cancel-timer timer) + (when timer + (cancel-timer timer) + (setq timer nil)) (funcall renderer (apply #'concat (reverse selector-string-parts))) (elpher-restore-pos))))))) @@ -1233,7 +1289,7 @@ by HEADER-LINE." (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" @@ -1244,7 +1300,7 @@ by HEADER-LINE." " - m: select an item on current page by name (autocompletes)\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" + " - 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" @@ -1257,13 +1313,17 @@ by HEADER-LINE." " - 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) @@ -1654,6 +1714,7 @@ 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 [mouse-3] 'elpher-back) (define-key map (kbd "O") 'elpher-root-dir) @@ -1727,6 +1788,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)))