;; Author: Tim Vaughan <tgvaughan@gmail.com>
;; Created: 11 April 2019
-;; Version: 1.4.6
+;; Version: 1.4.7
;; Keywords: comm gopher
;; Homepage: https://github.com/tgvaughan/elpher
;; Package-Requires: ((emacs "26"))
;;; 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-node-html "htm" elpher-html)
+ ((special bookmarks) elpher-get-bookmarks-node)
+ ((special start) elpher-get-start-node))
"Association list from types to getters, margin codes and index faces.")
-
;;; Customization group
;;
"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 ((url (url-generic-parse-url url-string)))
+ (if (and (url-type url)
+ (url-host url))
+ (let ((is-gopher (or (equal "gopher" (url-type url))
+ (equal "gophers" (url-type url)))))
+ (setf (url-filename url)
+ (url-unhex-string (url-filename url)))
+ (when (string-empty-p (url-filename url))
+ (if is-gopher
+ (setf (url-filename url) "1")))
+ (unless (> (url-port url) 0)
+ (if is-gopher
+ (setf (url-port url) 70)))
+ url)
+ (error "Malformed URL" url))))
+
+(defun elpher-make-gopher-address (type selector host port)
+ "Create an ADDRESS object corresponding to the given gopher directory record
+attributes: TYPE, SELECTOR, HOST and PORT."
+ (elpher-address-from-url
+ (concat "gopher://" 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-string (address)
+ "Get string representation of ADDRESS, or nil if ADDRESS is special."
+ (if (not (elpher-address-special-p address))
+ (url-encode-url (url-recreate 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 (url-filename address)) ?1))
+ ((string-equal protocol "gemini")
+ 'gemini)))))
+
+(defun elpher-address-protocol (address)
+ (if (symbolp address)
+ nil
+ (url-type address)))
+
+(defun elpher-gopher-address-selector (address)
+ "Retrieve selector from ADDRESS object."
+ (let ((filename (url-filename address)))
+ (if (> (length filename) 0)
+ (substring filename 1)
+ "")))
(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)))
- (url-encode-url
- (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))
;; 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'" type-char))
+ (else
+ (error "Unsupported address type '%S'" type)))))))
(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)
+ (if (equal (elpher-address-type address) '(gopher ?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-gopher-address-selector address)
(elpher-address-host address)
(elpher-address-port address)))))
-
(defun elpher-insert-index-record (display-string 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)))
+ (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
+ ('(gopher ?i) ;; 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")))
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
(substring type-and-selector 2)
"")) 'utf-8))
(use-tls (string= protocol "gophers"))
- (address (elpher-make-address type selector host port use-tls)))
+ (address (elpher-make-gopher-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)))
+ (address (elpher-make-gopher-address ?h selector host port)))
(elpher-make-node url address)))))
(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
(unwind-protect
(let* ((query-string (read-string "Query: "))
(query-selector (concat (elpher-address-selector address) "\t" query-string))
- (search-address (elpher-make-address ?1
+ (search-address (elpher-make-gopher-address ?1
query-selector
(elpher-address-host address)
(elpher-address-port address))))
" - 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)"))
(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))))))))
+ (elpher-make-gopher-address ?1 selector host-or-url
+ (string-to-number port-string))))))))
(switch-to-buffer "*elpher*")
(elpher-visit-node node)))
(selector (elpher-address-selector address))
(port (elpher-address-port address)))
(if (> (length selector) 0)
- (let ((root-address (elpher-make-address ?1 "" host port)))
+ (let ((root-address (elpher-make-gopher-address ?1 "" host port)))
(elpher-visit-node
(elpher-make-node (concat "gopher://" host
":" (number-to-string port)
(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."
(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)
(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
(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