;; Author: Tim Vaughan <plugd@thelambdalab.xyz>
;; Created: 11 April 2019
-;; Version: 2.7.8
+;; Version: 2.7.11
;; Keywords: comm gopher
;; Homepage: http://thelambdalab.xyz/elpher
;; Package-Requires: ((emacs "26"))
(require 'dns)
(require 'ansi-color)
(require 'nsm)
+(require 'gnutls)
;;; Global constants
;;
-(defconst elpher-version "2.7.8"
+(defconst elpher-version "2.7.11"
"Current version of elpher.")
(defconst elpher-margin-width 6
"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
(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.
'(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
;;
(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
;;
(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)
- (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)
- (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)
- (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
- (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
- (when timer
- (cancel-timer timer)
- (setq timer nil))
- (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.
(elpher-with-clean-buffer
(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))))))
(address (elpher-page-address page)))
(format "mouse-1, RET: open '%s'" (if (elpher-address-special-p address)
address
- (url-recreate-url 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.
(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))))))
(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."
- (unless elpher-gemini-TLS-cert-checks
- (setq-local network-security-level 'low))
- (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"))
- (defvar gnutls-verify-error)
- (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)
- (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 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
- (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.
(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))
(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"))
"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]\\)?" text-line)
+ (string-match "\\(^[ \t]*\\)\\(\*[ \t]+\\|>[ \t]*\\)?" text-line)
(let* ((processed-text-line (if (match-string 2 text-line)
(concat
(replace-regexp-in-string "\*"
(match-string 0 text-line))
(substring text-line (match-end 0)))
text-line))
- (fill-prefix (if (match-string 1 text-line)
- (replace-regexp-in-string "\*" " " (match-string 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-get-finger-page (renderer &optional force-ipv4)
"Opens a finger connection to the current page address.
The result is rendered using RENDERER. When the optional argument
-FORCE-IPV4 is non-nil, the IPv4 address returned by a DNS lookup will
-be used explicitly in making the connection."
+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))
(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)
- (when timer
- (cancel-timer timer)
- (setq timer nil))
- (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
- (when timer
- (cancel-timer timer)
- (setq timer nil))
- (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))))))
" - 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 address (gopher, gemini, finger)\n"
" - d/D: download item under cursor or current page\n"
"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."
(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)
"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."))))
(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 ()
(define-key map (kbd "<backtab>") '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)
(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
The Lambda Lab / projects / elpher.git / blobdiff