;; Author: Tim Vaughan <tgvaughan@gmail.com>
;; Created: 11 April 2019
-;; Version: 1.4.6
+;; Version: 2.0.0
;; Keywords: comm gopher
;; Homepage: https://github.com/tgvaughan/elpher
-;; Package-Requires: ((emacs "25"))
+;; Package-Requires: ((emacs "26"))
;; This file is not part of GNU Emacs.
;;; Code:
(provide 'elpher)
+
+;;; Dependencies
+;;
+
(require 'seq)
(require 'pp)
(require 'shr)
+(require 'url-util)
+
;;; Global constants
;;
-(defconst elpher-version "1.4.6"
+(defconst elpher-version "2.0.0"
"Current version of elpher.")
(defconst elpher-margin-width 6
"Width of left-hand margin used when rendering indicies.")
-
(defconst elpher-type-map
- '((?0 elpher-get-text-node "txt" elpher-text)
- (?1 elpher-get-index-node "/" elpher-index)
- (?4 elpher-get-node-download "bin" elpher-binary)
- (?5 elpher-get-node-download "bin" elpher-binary)
- (?7 elpher-get-search-node "?" elpher-search)
- (?8 elpher-get-telnet-node "tel" elpher-telnet)
- (?9 elpher-get-node-download "bin" elpher-binary)
- (?g elpher-get-image-node "img" elpher-image)
- (?p elpher-get-image-node "img" elpher-image)
- (?I elpher-get-image-node "img" elpher-image)
- (?d elpher-get-node-download "doc" elpher-binary)
- (?P elpher-get-node-download "doc" elpher-binary)
- (?s elpher-get-node-download "snd" elpher-binary)
- (?h elpher-get-url-node "url" elpher-url)
- (bookmarks elpher-get-bookmarks-node "#" elpher-index)
- (start elpher-get-start-node "#" elpher-index))
+ '(((gopher ?0) elpher-get-text-node "txt" elpher-text)
+ ((gopher ?1) elpher-get-index-node "/" elpher-index)
+ ((gopher ?4) elpher-get-node-download "bin" elpher-binary)
+ ((gopher ?5) elpher-get-node-download "bin" elpher-binary)
+ ((gopher ?7) elpher-get-search-node "?" elpher-search)
+ ((gopher ?8) elpher-get-telnet-node "tel" elpher-telnet)
+ ((gopher ?9) elpher-get-node-download "bin" elpher-binary)
+ ((gopher ?g) elpher-get-image-node "img" elpher-image)
+ ((gopher ?p) elpher-get-image-node "img" elpher-image)
+ ((gopher ?I) elpher-get-image-node "img" elpher-image)
+ ((gopher ?d) elpher-get-node-download "doc" elpher-binary)
+ ((gopher ?P) elpher-get-node-download "doc" elpher-binary)
+ ((gopher ?s) elpher-get-node-download "snd" elpher-binary)
+ ((gopher ?h) elpher-get-html-node "htm" elpher-html)
+ (gemini elpher-get-gemini-node "gem" elpher-gemini)
+ (other-url elpher-get-other-url-node "url" elpher-other-url)
+ ((special bookmarks) elpher-get-bookmarks-node)
+ ((special start) elpher-get-start-node))
"Association list from types to getters, margin codes and index faces.")
'((t :inherit warning))
"Face used for search type directory records.")
-(defface elpher-url
+(defface elpher-html
'((t :inherit font-lock-comment-face))
- "Face used for url type directory records.")
+ "Face used for html type directory records.")
+
+(defface elpher-gemini
+ '((t :inherit font-lock-function-name-face))
+ "Face used for html type directory records.")
+
+(defface elpher-other-url
+ '((t :inherit font-lock-comment-face))
+ "Face used for other URL type links records.")
(defface elpher-telnet
'((t :inherit font-lock-function-name-face))
"If non-nil, turns URLs matched in directories into clickable buttons."
:type '(boolean))
-(defcustom elpher-cache-images nil
- "If non-nil, cache images in memory in the same way as other content."
- :type '(boolean))
-
(defcustom elpher-use-header t
"If non-nil, display current node information in buffer header."
:type '(boolean))
;; Address
-(defun elpher-make-address (type &optional selector host port use-tls)
- "Create an address of a gopher object with TYPE, SELECTOR, HOST and PORT.
-Although selector host and port are optional, they are only omitted for
-special address types, such as 'start for the start page.
-
-Setting the USE-TLS parameter to non-nil causes Elpher to engage TLS mode
-before attempting to connect to the server."
- (if use-tls
- (list type selector host port 'tls)
- (list type selector host port)))
+;; An elpher "address" object is either a url object or a symbol.
+;; Symbol addresses are "special", corresponding to pages generated
+;; dynamically for and by elpher. All others represent pages which
+;; rely on content retrieved over the network.
+
+(defun elpher-address-from-url (url-string)
+ "Create a ADDRESS object corresponding to the given URL-STRING."
+ (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
+ ;; 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"))
+ (unless (> (url-port url) 0)
+ (setf (url-port url) 70)))
+ (when is-gemini
+ (unless (> (url-port url) 0)
+ (setf (url-port url) 1965))))
+ 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))
+ (elpher-address-from-url
+ (concat "gopher" (if tls "s" "")
+ "://" host
+ ":" (number-to-string port)
+ "/" (string type)
+ selector))))
+
+(defun elpher-make-special-address (type)
+ "Create an ADDRESS object corresponding to the given special page symbol TYPE."
+ type)
+
+(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))
(defun elpher-address-type (address)
- "Retrieve type from ADDRESS."
- (elt address 0))
-
-(defun elpher-address-selector (address)
- "Retrieve selector from ADDRESS."
- (elt address 1))
+ "Retrieve selector type from ADDRESS object."
+ (if (symbolp address)
+ (list 'special address)
+ (let ((protocol (url-type address)))
+ (cond ((or (equal protocol "gopher")
+ (equal protocol "gophers"))
+ (list 'gopher (string-to-char (substring (url-filename address) 1))))
+ ((equal protocol "gemini")
+ 'gemini)
+ (t 'other-url)))))
+
+(defun elpher-address-protocol (address)
+ (if (symbolp address)
+ nil
+ (url-type address)))
+
+(defun elpher-address-filename (address)
+ (if (symbolp address)
+ nil
+ (url-filename address)))
(defun elpher-address-host (address)
- "Retrieve host from ADDRESS."
- (elt address 2))
+ "Retrieve host from ADDRESS object."
+ (url-host address))
(defun elpher-address-port (address)
- "Retrieve port from ADDRESS."
- (elt address 3))
-
-(defun elpher-address-use-tls-p (address)
- "Return non-nil if ADDRESS is marked as needing TLS."
- (elt address 4))
+ "Retrieve port from ADDRESS object."
+ (url-port address))
(defun elpher-address-special-p (address)
- "Return non-nil if ADDRESS is special (e.g. start page, bookmarks page)."
- (not (elpher-address-host address)))
-
-(defun elpher-get-address-url (address)
- "Get URL representation of ADDRESS."
- (let ((type (elpher-address-type address))
- (selector (elpher-address-selector address))
- (bare-host (elpher-address-host address))
- (port (elpher-address-port address)))
- (let ((host (if (string-match-p ":" bare-host)
- (concat "[" bare-host "]")
- bare-host)))
- (if (and (equal type ?h)
- (string-prefix-p "URL:" selector))
- (elt (split-string selector "URL:") 1)
- (concat "gopher"
- (if (elpher-address-use-tls-p address) "s" "")
- "://"
- host
- (if (equal port 70)
- ""
- (format ":%d" port))
- "/" (string type)
- selector)))))
+ "Return non-nil if ADDRESS object is special (e.g. start page, bookmarks page)."
+ (symbolp address))
+
+(defun elpher-address-gopher-p (address)
+ "Return non-nill if ADDRESS object is a gopher address."
+ (and (not (elpher-address-special-p address))
+ (member (elpher-address-protocol address) '("gopher gophers"))))
+
+(defun elpher-gopher-address-selector (address)
+ "Retrieve gopher selector from ADDRESS object."
+ (substring (url-filename address) 2))
;; Node
(defun elpher-make-node (display-string address &optional parent)
- "Create a node in the gopher page hierarchy.
+ "Create a node in the page hierarchy.
DISPLAY-STRING records the display string used for the page.
-ADDRESS specifies the address of the gopher page.
+ADDRESS specifies the address object of the page.
The optional PARENT specifies the parent node in the hierarchy.
This is set every time the node is visited, so while it forms
(elt node 0))
(defun elpher-node-address (node)
- "Retrieve the address of NODE."
+ "Retrieve the ADDRESS object of NODE."
(elt node 1))
(defun elpher-node-parent (node)
(if getter
(funcall getter)
(let* ((address (elpher-node-address node))
- (type (elpher-address-type address)))
- (funcall (car (alist-get type elpher-type-map))))))
+ (type (elpher-address-type address))
+ (type-record (cdr (assoc type elpher-type-map))))
+ (if type-record
+ (funcall (car type-record))
+ (elpher-visit-parent-node)
+ (pcase type
+ (`(gopher ,type-char)
+ (error "Unsupported gopher selector type '%c' for '%s'"
+ type-char (elpher-address-to-url address)))
+ (else
+ (error "Unsupported address type '%S' for '%s'"
+ type (elpher-address-to-url address))))))))
(defun elpher-visit-parent-node ()
"Visit the parent of the current node."
(elpher-decode (replace-regexp-in-string "\n\.\n$" "\n"
(replace-regexp-in-string "\r" "" string))))
+
;;; Index rendering
;;
(port (if (elt fields 3)
(string-to-number (elt fields 3))
nil))
- (address (elpher-make-address type selector host port)))
+ (address (elpher-make-gopher-address type selector host port)))
(elpher-insert-index-record display-string address))))))
(defun elpher-insert-margin (&optional type-name)
(defun elpher-node-button-help (node)
"Return a string containing the help text for a button corresponding to NODE."
(let ((address (elpher-node-address node)))
- (if (eq (elpher-address-type address) ?h)
- (let ((url (cadr (split-string (elpher-address-selector address) "URL:"))))
- (format "mouse-1, RET: open url '%s'" url))
- (format "mouse-1, RET: open '%s' on %s port %s"
- (elpher-address-selector address)
- (elpher-address-host address)
- (elpher-address-port address)))))
+ (format "mouse-1, RET: open '%s'" (elpher-address-to-url address))))
-
-(defun elpher-insert-index-record (display-string address)
+(defun elpher-insert-index-record (display-string &optional address)
"Function to insert an index record into the current buffer.
-The contents of the record are dictated by DISPLAY-STRING and ADDRESS."
- (let* ((type (elpher-address-type address))
- (type-map-entry (alist-get type elpher-type-map)))
+The contents of the record are dictated by DISPLAY-STRING and ADDRESS.
+If ADDRESS is not supplied or nil the record is rendered as an
+'information' line."
+ (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))
'follow-link t
'help-echo (elpher-node-button-help node)))
(pcase type
- (?i ;; Information
+ ((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)))
- (other ;; Unknown
- (elpher-insert-margin (concat (char-to-string type) "?"))
+ (`(gopher ,selector-type) ;; Unknown
+ (elpher-insert-margin (concat (char-to-string selector-type) "?"))
(insert (propertize display-string
'face 'elpher-unknown)))))
(insert "\n")))
(elpher-visit-node node)))
-;;; Selector retrieval (all kinds)
+;;; Network error reporting
+;;
+
+(defun elpher-network-error (address error)
+ (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"
+ (propertize "\n----------------\n\n" 'face 'error)
+ "Press 'u' to return to the previous page.")))
+
+
+;;; Gopher selector retrieval (all kinds)
;;
(defun elpher-process-cleanup ()
is non-nil, this message is not displayed. Instead, the error propagates
up to the calling function."
(setq elpher-selector-string "")
- (when (elpher-address-use-tls-p address)
+ (when (equal (elpher-address-protocol address) "gophers")
(if (gnutls-available-p)
(when (not elpher-use-tls)
(setq elpher-use-tls t)
(concat elpher-selector-string string))))
(set-process-sentinel proc after)
(process-send-string proc
- (concat (elpher-address-selector address) "\n")))
+ (concat (elpher-gopher-address-selector address) "\n")))
(error
(if (and (consp the-error)
(eq (car the-error) 'gnutls-error)
- (not (elpher-address-use-tls-p address))
+ (not (equal (elpher-address-protocol address) "gophers"))
(or elpher-auto-disengage-TLS
(yes-or-no-p "Could not establish encrypted connection. Disable TLS mode? ")))
(progn
(error the-error)
(elpher-with-clean-buffer
(insert (propertize "\n---- ERROR -----\n\n" 'face 'error)
- "Failed to connect to " (elpher-get-address-url address) ".\n"
+ "Failed to connect to " (elpher-address-to-url address) ".\n"
(propertize "\n----------------\n\n" 'face 'error)
"Press 'u' to return to the previous page.")))))))
"\\([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.")
-(defun elpher-make-node-from-matched-url (&optional string)
- "Convert most recent `elpher-url-regex' match to a node.
-
-If STRING is non-nil, this is given as an argument to all `match-string'
-calls, as is necessary if the match is performed by `string-match'."
- (let ((url (match-string 0 string))
- (protocol (downcase (match-string 1 string))))
- (if (or (string= protocol "gopher")
- (string= protocol "gophers"))
- (let* ((bare-host (match-string 2 string))
- (host (if (string-prefix-p "[" bare-host)
- (substring bare-host 1 (- (length bare-host) 1))
- bare-host))
- (port (if (> (length (match-string 3 string)) 1)
- (string-to-number (substring (match-string 3 string) 1))
- 70))
- (type-and-selector (match-string 4 string))
- (type (if (> (length type-and-selector) 1)
- (elt type-and-selector 1)
- ?1))
- (selector (if (> (length type-and-selector) 1)
- (substring type-and-selector 2)
- ""))
- (use-tls (string= protocol "gophers"))
- (address (elpher-make-address type selector host port use-tls)))
- (elpher-make-node url address))
- (let* ((host (match-string 2 string))
- (port (if (> (length (match-string 3 string)) 1)
- (string-to-number (substring (match-string 3 string) 1))
- 70))
- (selector (concat "URL:" url))
- (address (elpher-make-address ?h selector host port)))
- (elpher-make-node url address)))))
-
-
(defun elpher-buttonify-urls (string)
"Turn substrings which look like urls in STRING into clickable buttons."
(with-temp-buffer
(insert string)
(goto-char (point-min))
(while (re-search-forward elpher-url-regex nil t)
- (let ((node (elpher-make-node-from-matched-url)))
+ (let ((node (elpher-make-node (match-string 0)
+ (elpher-address-from-url (match-string 0)))))
(make-text-button (match-beginning 0)
(match-end 0)
'elpher-node node
(defun elpher-get-image-node ()
"Getter which retrieves the current node contents as an image to view."
- (let* ((address (elpher-node-address elpher-current-node))
- (content (elpher-get-cached-content address)))
- (if content
+ (let* ((address (elpher-node-address elpher-current-node)))
+ (if (display-images-p)
(progn
(elpher-with-clean-buffer
- (insert-image content)
- (elpher-restore-pos)))
- (if (display-images-p)
- (progn
- (elpher-with-clean-buffer
- (insert "LOADING IMAGE... (use 'u' to cancel)"))
- (elpher-get-selector address
- (lambda (proc event)
- (unless (string-prefix-p "deleted" event)
- (let ((image (create-image
- elpher-selector-string
- nil t)))
- (elpher-with-clean-buffer
- (insert-image image)
- (elpher-restore-pos))
- (if elpher-cache-images
- (elpher-cache-content
- (elpher-node-address elpher-current-node)
- image)))))))
- (elpher-get-node-download)))))
+ (insert "LOADING IMAGE... (use 'u' to cancel)"))
+ (elpher-get-selector address
+ (lambda (proc event)
+ (unless (string-prefix-p "deleted" event)
+ (let ((image (create-image
+ elpher-selector-string
+ nil t)))
+ (elpher-with-clean-buffer
+ (insert-image image)
+ (elpher-restore-pos)))))))
+ (elpher-get-node-download))))
;; Search retrieval
(message "Displaying cached search results. Reload to perform a new search."))
(unwind-protect
(let* ((query-string (read-string "Query: "))
- (query-selector (concat (elpher-address-selector address) "\t" query-string))
- (search-address (elpher-make-address ?1
+ (query-selector (concat (elpher-gopher-address-selector address) "\t" query-string))
+ (search-address (elpher-make-gopher-address ?1
query-selector
(elpher-address-host address)
(elpher-address-port address))))
(defun elpher-get-node-download ()
"Getter which retrieves the current node and writes the result to a file."
(let* ((address (elpher-node-address elpher-current-node))
- (selector (elpher-address-selector address)))
+ (selector (elpher-gopher-address-selector address)))
(elpher-visit-parent-node) ; Do first in case of non-local exits.
(let* ((filename-proposal (file-name-nondirectory selector))
(filename (read-file-name "Save file as: "
(error
(error "Error downloading %s" elpher-download-filename))))))
-;; URL retrieval
+;; HTML node retrieval
(defun elpher-insert-rendered-html (string)
"Use shr to insert rendered view of html STRING into current buffer."
(libxml-parse-html-region (point-min) (point-max)))))
(shr-insert-document dom)))
-(defun elpher-get-url-node ()
- "Getter which attempts to open the URL specified by the current node."
+(defun elpher-get-html-node ()
+ "Getter which retrieves and renders an HTML node."
(let* ((address (elpher-node-address elpher-current-node))
- (selector (elpher-address-selector address)))
- (let ((url (elt (split-string selector "URL:") 1)))
- (if url
+ (selector (elpher-gopher-address-selector address)))
+ (let ((content (elpher-get-cached-content address)))
+ (if content
(progn
- (elpher-visit-parent-node) ; Do first in case of non-local exits.
- (message "Opening URL...")
- (if elpher-open-urls-with-eww
- (browse-web url)
- (browse-url url)))
- (let ((content (elpher-get-cached-content address)))
- (if content
- (progn
- (elpher-with-clean-buffer
- (insert content)
- (elpher-restore-pos)))
(elpher-with-clean-buffer
- (insert "LOADING HTML... (use 'u' to cancel)"))
- (elpher-get-selector address
- (lambda (proc event)
- (unless (string-prefix-p "deleted" event)
- (elpher-with-clean-buffer
- (elpher-insert-rendered-html elpher-selector-string)
- (goto-char (point-min))
- (elpher-cache-content
- (elpher-node-address elpher-current-node)
- (buffer-string))))))))))))
+ (insert content)
+ (elpher-restore-pos)))
+ (elpher-with-clean-buffer
+ (insert "LOADING HTML... (use 'u' to cancel)"))
+ (elpher-get-selector address
+ (lambda (proc event)
+ (unless (string-prefix-p "deleted" event)
+ (elpher-with-clean-buffer
+ (elpher-insert-rendered-html elpher-selector-string)
+ (goto-char (point-min))
+ (elpher-cache-content
+ (elpher-node-address elpher-current-node)
+ (buffer-string))))))))))
+
+;; Gemini node retrieval
+
+(defvar elpher-gemini-response)
+(defvar elpher-gemini-response-header)
+(defvar elpher-gemini-in-header)
+
+(defun elpher-gemini-response-code ()
+ (elt (split-string elpher-gemini-response-header) 0))
+
+(defun elpher-gemini-response-meta ()
+ (string-trim (substring elpher-gemini-response-header
+ (string-match "[ \t]+" elpher-gemini-response-header))))
+
+(defun elpher-get-gemini (address after)
+ "Retrieve gemini ADDRESS, then execute AFTER.
+The response header is stored in the variable ‘elpher-gemini-response-header’.
+If available, the response is stored in the variable ‘elpher-gemini-response’.
+
+Usually errors result in an error page being displayed. This is only
+appropriate if the selector is to be directly viewed. If PROPAGATE-ERROR
+is non-nil, this message is not displayed. Instead, the error propagates
+up to the calling function."
+ (setq elpher-gemini-response "")
+ (setq elpher-gemini-response-header "")
+ (setq elpher-gemini-in-header t)
+ (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)
+ (elpher-address-port address)
+ :type 'tls)))
+ (set-process-coding-system proc 'binary)
+ (set-process-filter proc
+ (lambda (proc string)
+ (if elpher-gemini-in-header
+ (progn
+ (setq elpher-gemini-response-header
+ (concat elpher-gemini-response-header
+ (elt (split-string string "\r\n") 0)))
+ (let ((idx (string-match "\r\n" string)))
+ (setq elpher-gemini-response
+ (substring string (+ idx 2)))
+ (setq elpher-gemini-in-header nil)))
+ (setq elpher-gemini-response
+ (concat elpher-gemini-response string)))))
+ (set-process-sentinel proc after)
+ (process-send-string proc
+ (concat (elpher-address-to-url address) "\r\n")))))
+
+(defun elpher-render-gemini-response (mime-type-raw)
+ (let* ((mime-type-full (if (string-empty-p mime-type-raw)
+ "text/gemini; charset=utf-8"
+ mime-type-raw))
+ (mime-type-split (split-string mime-type-full ";"))
+ (mime-type (string-trim (elt mime-type-split 0)))
+ (parameters (if (> (length mime-type-split) 1)
+ (string-trim (elt mime-type-split 1))
+ "")))
+ ;; (message "MIME type %S with parameters %S" mime-type parameters)
+ (pcase mime-type
+ ((or "text/gemini" "")
+ (elpher-render--mimetype-text/gemini elpher-gemini-response parameters))
+ ((pred (string-prefix-p "text/"))
+ (elpher-render--mimetype-text/plain elpher-gemini-response parameters))
+ ((pred (string-prefix-p "image/"))
+ (elpher-render--mimetype-image/* elpher-gemini-response parameters))
+ (other
+ (error "Unsupported MIME type %S" mime-type)))))
+
+(defun elpher-gemini-get-link-url (line)
+ (string-trim (elt (split-string (substring line 2)) 0)))
+
+(defun elpher-gemini-get-link-display-string (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-address-from-gemini-url (url)
+ (let ((address (url-generic-parse-url url)))
+ (unless (equal (url-type address) "mailto")
+ (setf (url-fullness address) t)
+ (unless (url-host address)
+ (setf (url-host address) (url-host (elpher-node-address elpher-current-node)))
+ (unless (string-prefix-p "/" (url-filename address))
+ (setf (url-filename address)
+ (concat (file-name-as-directory
+ (url-filename (elpher-node-address elpher-current-node)))
+ (url-filename address)))))
+ (unless (url-type address)
+ (setf (url-type address) "gemini"))
+ (unless (> (url-port address) 0)
+ (pcase (url-type address)
+ ("gemini" (setf (url-port address) 1965))
+ ("gopher" (setf (url-port address) 70)))))
+ address))
+
+(defun elpher-render--mimetype-text/gemini (data parameters)
+ (elpher-with-clean-buffer
+ (dolist (line (split-string (elpher-preprocess-text-response data) "\n"))
+ (if (string-prefix-p "=>" line)
+ (let* ((url (elpher-gemini-get-link-url line))
+ (display-string (elpher-gemini-get-link-display-string line))
+ (address (elpher-address-from-gemini-url url)))
+ (if (> (length display-string) 0)
+ (elpher-insert-index-record display-string address)
+ (elpher-insert-index-record url address)))
+ (elpher-insert-index-record line)))
+ (elpher-restore-pos)
+ (elpher-cache-content
+ (elpher-node-address elpher-current-node)
+ (buffer-string))))
+
+(defun elpher-render--mimetype-text/plain (data parameters)
+ (elpher-with-clean-buffer
+ (insert (elpher-buttonify-urls (elpher-preprocess-text-response data)))
+ (elpher-restore-pos)
+ (elpher-cache-content
+ (elpher-node-address elpher-current-node)
+ (buffer-string))))
+
+(defun elpher-render--mimetype-image/* (data parameters)
+ (let ((image (create-image data nil t)))
+ (elpher-with-clean-buffer
+ (insert-image image)
+ (elpher-restore-pos))))
+
+(defun elpher-process-gemini-response (proc event)
+ (condition-case the-error
+ (unless (string-prefix-p "deleted" event)
+ (let ((response-code (elpher-gemini-response-code))
+ (meta (elpher-gemini-response-meta)))
+ (pcase (elt response-code 0)
+ (?1 ; Input required
+ (elpher-with-clean-buffer
+ (insert "Gemini server is requesting input."))
+ (let* ((query-string (read-string (concat 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 #'elpher-process-gemini-response)))
+ (?2 ; Normal response
+ (message elpher-gemini-response-header)
+ (elpher-render-gemini-response meta))
+ (?3 ; Redirect
+ (message "Following redirect to %s" meta)
+ (let ((redirect-address (elpher-address-from-gemini-url meta)))
+ (elpher-get-gemini redirect-address #'elpher-process-gemini-response)))
+ (?4 ; Temporary failure
+ (error "Gemini server reports TEMPORARY FAILURE for this request"))
+ (?5 ; Permanent failure
+ (error "Gemini server reports PERMANENT FAILURE for this request"))
+ (?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)))))
+ (error
+ (elpher-network-error (elpher-node-address elpher-current-node) the-error))))
+
+
+(defun elpher-get-gemini-node ()
+ "Getter which retrieves and renders a Gemini node."
+ (let* ((address (elpher-node-address elpher-current-node))
+ (content (elpher-get-cached-content address)))
+ (condition-case the-error
+ (if content
+ (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 #'elpher-process-gemini-response))
+ (error
+ (elpher-network-error address the-error)))))
+
+
+
+
+;; Other URL node opening
+
+(defun elpher-get-other-url-node ()
+ "Getter which attempts to open the URL specified by the current node."
+ (let* ((address (elpher-node-address elpher-current-node))
+ (url (elpher-address-to-url address)))
+ (progn
+ (elpher-visit-parent-node) ; Do first in case of non-local exits.
+ (message "Opening URL...")
+ (if elpher-open-urls-with-eww
+ (browse-web url)
+ (browse-url url)))))
;; Telnet node connection
" - R: reload current page (regenerates cache)\n"
" - T: toggle TLS mode\n"
" - d/D: download item under cursor or current page\n"
- " - w: display the raw server response for the current page\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"
- (elpher-make-address ?1 "" "gopher.floodgap.com" 70))
+ (elpher-make-gopher-address ?1 "" "gopher.floodgap.com" 70))
(insert "\n"
"Alternatively, select the following item and enter some search terms:\n")
(elpher-insert-index-record "Veronica-2 Gopher Search Engine"
- (elpher-make-address ?7 "/v2/vs" "gopher.floodgap.com" 70))
+ (elpher-make-gopher-address ?7 "/v2/vs" "gopher.floodgap.com" 70))
(insert "\n"
"** Refer to the ")
(let ((help-string "RET,mouse-1: Open Elpher info manual (if available)"))
(if bookmarks
(dolist (bookmark bookmarks)
(let ((display-string (elpher-bookmark-display-string bookmark))
- (address (elpher-bookmark-address bookmark)))
+ (address (elpher-address-from-url (elpher-bookmark-url bookmark))))
(elpher-insert-index-record display-string address)))
(insert "No bookmarks found.\n")))
(insert "\n-----------------------\n\n"
;;; Bookmarks
;;
-(defun elpher-make-bookmark (display-string address)
+(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 address))
+ (list display-string (elpher-address-to-url address)))
(defun elpher-bookmark-display-string (bookmark)
"Get the display string of BOOKMARK."
"Set the display string of BOOKMARK to DISPLAY-STRING."
(setcar bookmark display-string))
-(defun elpher-bookmark-address (bookmark)
+(defun elpher-bookmark-url (bookmark)
"Get the address for BOOKMARK."
(elt bookmark 1))
+
(defun elpher-save-bookmarks (bookmarks)
"Record the bookmark list BOOKMARKS to the user's bookmark file.
Beware that this completely replaces the existing contents of the file."
- (with-temp-file (locate-user-emacs-file "elpher-bookmarks")
+ (with-temp-file (locate-user-emacs-file "elpher2-bookmarks")
(erase-buffer)
- (insert "; Elpher gopher bookmarks file\n\n"
- "; Bookmarks are stored as a list of (label (type selector host port))\n"
- "; s-expressions, where type is stored as a character (i.e. 49 = ?1).\n"
- "; Feel free to edit by hand, but ensure this structure remains intact.\n\n")
+ (insert "; Elpher bookmarks file\n\n"
+ "; Bookmarks are stored as a list of (label URL) items.\n"
+ "; Feel free to edit by hand, but take care to ensure\n"
+ "; the list structure remains intact.\n\n")
(pp bookmarks (current-buffer))))
(defun elpher-load-bookmarks ()
"Get the list of bookmarks from the users's bookmark file."
(with-temp-buffer
(ignore-errors
- (insert-file-contents (locate-user-emacs-file "elpher-bookmarks"))
+ (insert-file-contents (locate-user-emacs-file "elpher2-bookmarks"))
(goto-char (point-min))
(read (current-buffer)))))
(defun elpher-add-address-bookmark (address display-string)
- "Save a bookmark for ADDRESS with label DISPLAY-STRING.
+ "Save a bookmark for ADDRESS with label DISPLAY-STRING.)))
If ADDRESS is already bookmarked, update the label only."
- (let ((bookmarks (elpher-load-bookmarks)))
- (let ((existing-bookmark (rassoc (list address) bookmarks)))
+ (let ((bookmarks (elpher-load-bookmarks))
+ (url (elpher-address-to-url address)))
+ (let ((existing-bookmark (rassoc (list url) bookmarks)))
(if existing-bookmark
(elpher-set-bookmark-display-string existing-bookmark display-string)
- (add-to-list 'bookmarks (elpher-make-bookmark display-string address))))
+ (add-to-list 'bookmarks (elpher-make-bookmark display-string url))))
(elpher-save-bookmarks bookmarks)))
(defun elpher-remove-address-bookmark (address)
"Remove any bookmark to ADDRESS."
+ (let ((url (elpher-address-to-url address)))
(elpher-save-bookmarks
(seq-filter (lambda (bookmark)
- (not (equal (elpher-bookmark-address bookmark) address)))
- (elpher-load-bookmarks))))
-
+ (not (equal (elpher-bookmark-url bookmark) url)))
+ (elpher-load-bookmarks)))))
;;; Interactive procedures
;;
(push-button))
(defun elpher-go ()
- "Go to a particular gopher site read from the minibuffer.
-The site may be specified via a URL or explicitly in terms of
-host, selector and port."
+ "Go to a particular gopher site read from the minibuffer."
(interactive)
(let ((node
- (let ((host-or-url (read-string "Gopher host or URL: ")))
- (if (string-match elpher-url-regex host-or-url)
- (elpher-make-node-from-matched-url host-or-url)
- (let ((selector (read-string "Selector (default none): " nil nil ""))
- (port-string (read-string "Port (default 70): " nil nil "70")))
- (elpher-make-node (concat "gopher://" host-or-url
- ":" port-string
- "/1" selector)
- (elpher-make-address ?1 selector host-or-url
- (string-to-number port-string))))))))
+ (let ((host-or-url (read-string "Gopher or Gemini URL: ")))
+ (elpher-make-node host-or-url
+ (elpher-address-from-url host-or-url)))))
(switch-to-buffer "*elpher*")
(elpher-visit-node node)))
(let ((address (elpher-node-address elpher-current-node)))
(if (elpher-address-special-p address)
(error "Command not valid for this page")
- (let ((url (read-string "URL: " (elpher-get-address-url address))))
- (if (string-match elpher-url-regex url)
- (let ((new-node (elpher-make-node-from-matched-url url)))
- (unless (equal (elpher-node-address new-node) address)
- (elpher-visit-node new-node)))
- (error "Could not parse URL %s" url))))))
+ (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)))))))
(defun elpher-redraw ()
"Redraw current page."
(defun elpher-root-dir ()
"Visit root of current server."
(interactive)
- (let* ((address (elpher-node-address elpher-current-node))
- (host (elpher-address-host address)))
- (if host
- (let ((host (elpher-address-host address))
- (selector (elpher-address-selector address))
- (port (elpher-address-port address)))
- (if (> (length selector) 0)
- (let ((root-address (elpher-make-address ?1 "" host port)))
- (elpher-visit-node
- (elpher-make-node (concat "gopher://" host
- ":" (number-to-string port)
- "/1/")
- root-address)))
- (error "Already at root directory of current server")))
+ (let ((address (elpher-node-address elpher-current-node)))
+ (if (not (elpher-address-special-p address))
+ (if (or (member (url-filename address) '("/" ""))
+ (and (elpher-address-gopher-p address)
+ (= (length (elpher-gopher-address-selector address)) 0)))
+ (error "Already at root directory of current server")
+ (let ((address-copy (elpher-address-from-url
+ (elpher-address-to-url address))))
+ (setf (url-filename address-copy) "")
+ (elpher-visit-node
+ (elpher-make-node (elpher-address-to-url address-copy)
+ address-copy))))
(error "Command invalid for this page"))))
(defun elpher-bookmarks-current-p ()
"Return non-nil if current node is a bookmarks page."
- (eq (elpher-address-type (elpher-node-address elpher-current-node)) 'bookmarks))
+ (equal (elpher-address-type (elpher-node-address elpher-current-node))
+ '(special bookmarks)))
(defun elpher-reload-bookmarks ()
"Reload bookmarks if current node is a bookmarks page."
(interactive)
(switch-to-buffer "*elpher*")
(elpher-visit-node
- (elpher-make-node "Bookmarks Page" (elpher-make-address 'bookmarks))))
+ (elpher-make-node "Bookmarks Page" (elpher-make-special-address 'bookmarks))))
(defun elpher-info-node (node)
"Display information on NODE."
(let ((display-string (elpher-node-display-string node))
(address (elpher-node-address node)))
- (if (not (elpher-address-special-p address))
- (message "`%s' on %s port %s"
- (elpher-address-selector address)
- (elpher-address-host address)
- (elpher-address-port address))
- (message "%s" display-string))))
+ (if (elpher-address-special-p address)
+ (message "Special page: %s" display-string)
+ (message (elpher-address-to-url address)))))
(defun elpher-info-link ()
"Display information on node corresponding to link at point."
(let ((address (elpher-node-address node)))
(if (elpher-address-special-p address)
(error (format "Cannot represent %s as URL" (elpher-node-display-string node)))
- (let ((url (elpher-get-address-url address)))
+ (let ((url (elpher-address-to-url address)))
(message "Copied \"%s\" to kill-ring/clipboard." url)
(kill-new url)))))
(define-key map (kbd "r") 'elpher-redraw)
(define-key map (kbd "R") 'elpher-reload)
(define-key map (kbd "T") 'elpher-toggle-tls)
- (define-key map (kbd "w") 'elpher-view-raw)
+ (define-key map (kbd ".") 'elpher-view-raw)
(define-key map (kbd "d") 'elpher-download)
(define-key map (kbd "D") 'elpher-download-current)
(define-key map (kbd "m") 'elpher-jump)
(when (fboundp 'evil-define-key)
(evil-define-key 'motion map
(kbd "TAB") 'elpher-next-link
- (kbd "C-]") 'elpher-follow-current-link
+ (kbd "C-") 'elpher-follow-current-link
(kbd "C-t") 'elpher-back
(kbd "u") 'elpher-back
- (kbd "O") 'elpher-root-dir
(kbd "g") 'elpher-go
(kbd "o") 'elpher-go-current
(kbd "r") 'elpher-redraw
(kbd "R") 'elpher-reload
(kbd "T") 'elpher-toggle-tls
- (kbd "w") 'elpher-view-raw
+ (kbd ".") 'elpher-view-raw
(kbd "d") 'elpher-download
(kbd "D") 'elpher-download-current
(kbd "m") 'elpher-jump
"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
(switch-to-buffer "*elpher*")
(setq elpher-current-node nil)
(let ((start-node (elpher-make-node "Elpher Start Page"
- (elpher-make-address 'start))))
+ (elpher-make-special-address 'start))))
(elpher-visit-node start-node)))
"Started Elpher.") ; Otherwise (elpher) evaluates to start page string.
The Lambda Lab / projects / elpher.git / blobdiff