-;;; elpher.el --- a friendly gopher client.
+;;; elpher.el --- A friendly gopher client.
;; Copyright (C) 2019 Tim Vaughan
;; page containing information on key bindings and suggested starting
;; points for your gopher exploration.
-;; Faces, caching options and start page can be configured via
+;; Faces, caching and other options can be configured via
;; the Elpher customization group in Applications.
;;; Code:
(provide 'elpher)
(require 'seq)
(require 'pp)
+(require 'shr)
;;; Global constants
;;
(?g elpher-get-image-node "im" elpher-image)
(?p elpher-get-image-node "im" elpher-image)
(?I elpher-get-image-node "im" elpher-image)
+ (?d elpher-get-node-download "d" elpher-binary)
(?h elpher-get-url-node "W" elpher-url)
(bookmarks elpher-get-bookmarks-node "#" elpher-index)
(start elpher-get-start-node "#" elpher-index))
(elt address 3))
(defun elpher-address-special-p (address)
+ "Return non-nil if ADDRESS is special (e.g. start page, bookmarks page)."
(not (elpher-address-host address)))
;; Node
-(defun elpher-make-node (display-string parent address)
+(defun elpher-make-node (display-string address &optional parent)
"Create a node in the gopher page hierarchy.
DISPLAY-STRING records the display string used for the page.
-PARENT specifies the parent of the node, and ADDRESS specifies the
-address of the gopher page."
- (list display-string parent address))
+ADDRESS specifies the address of the gopher page.
+
+The optional PARENT specifies the parent node in the hierarchy.
+This is set every time the node is visited, so while it forms
+an important part of the node data there is no need to set it
+initially."
+ (list display-string address parent))
(defun elpher-node-display-string (node)
"Retrieve the display string of NODE."
(elt node 0))
-(defun elpher-node-parent (node)
- "Retrieve the parent node of NODE."
- (elt node 1))
-
(defun elpher-node-address (node)
"Retrieve the address of NODE."
+ (elt node 1))
+
+(defun elpher-node-parent (node)
+ "Retrieve the parent node of NODE."
(elt node 2))
+(defun elpher-set-node-parent (node parent)
+ "Set the parent node of NODE to be PARENT."
+ (setcar (cdr (cdr node)) parent))
+
;; Cache
(defvar elpher-content-cache (make-hash-table :test 'equal))
"Visit NODE using its own getter or GETTER, if non-nil."
(elpher-save-pos)
(elpher-process-cleanup)
+ (unless (eq node (elpher-node-parent elpher-current-node))
+ (elpher-set-node-parent node elpher-current-node))
(setq elpher-current-node node)
(if getter
(funcall getter)
(if type-map-entry
(let* ((margin-code (elt type-map-entry 1))
(face (elt type-map-entry 2))
- (node (elpher-make-node display-string elpher-current-node address)))
+ (node (elpher-make-node display-string address)))
(elpher-insert-margin margin-code)
(insert-text-button display-string
'face face
"\\([a-zA-Z]+\\)://\\([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 (parent &optional string)
+(defun elpher-make-node-from-matched-url (&optional string)
"Convert most recent `elpher-url-regex' match to a node.
-PARENT defines the node to set as the parent to the new 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))
(substring type-and-selector 2)
""))
(address (elpher-make-address type selector host port)))
- (elpher-make-node url elpher-current-node address))
+ (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 elpher-current-node address)))))
+ (elpher-make-node url address)))))
(defun elpher-buttonify-urls (string)
(insert string)
(goto-char (point-min))
(while (re-search-forward elpher-url-regex nil t)
- (let ((node (elpher-make-node-from-matched-url elpher-current-node)))
+ (let ((node (elpher-make-node-from-matched-url)))
(make-text-button (match-beginning 0)
(match-end 0)
'elpher-node node
;; URL retrieval
+(defun elpher-insert-rendered-html (string)
+ "Use shr to insert rendered view of html STRING into current buffer."
+ (let ((dom (with-temp-buffer
+ (insert string)
+ (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."
(let* ((address (elpher-node-address elpher-current-node))
(selector (elpher-address-selector address)))
- (elpher-visit-parent-node) ; Do first in case of non-local exits.
(let ((url (elt (split-string selector "URL:") 1)))
- (if elpher-open-urls-with-eww
- (browse-web url)
- (browse-url url)))))
+ (if url
+ (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))))))))))))
;; Telnet node connection
;; Bookmarks page node retrieval
(defun elpher-get-bookmarks-node ()
- "Getter which loads and displays the current bookmark list."
+ "Getter to load and display the current bookmark list."
(elpher-with-clean-buffer
(insert "---- Bookmark list ----\n\n")
(let ((bookmarks (elpher-load-bookmarks)))
"- x: delete selected bookmark\n"
"- a: rename selected bookmark\n\n"
"Bookmarks are stored in the file "
- (locate-user-emacs-file "elpher-bookmarks"))
+ (locate-user-emacs-file "elpher-bookmarks"))
(elpher-restore-pos)))
(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 elpher-current-node
- 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-current-node
(elpher-make-address ?1 selector host-or-url
(string-to-number port-string))))))))
(switch-to-buffer "*elpher*")
(interactive)
(if elpher-current-node
(if (elpher-address-special-p (elpher-node-address elpher-current-node))
- (error "This page was not generated by a server.")
+ (error "This page was not generated by a server")
(elpher-visit-node elpher-current-node
#'elpher-get-node-raw))
(message "No current site.")))
(elpher-make-node (concat "gopher://" host
":" (number-to-string port)
"/1/")
- elpher-current-node
root-address)))
(error "Already at root directory of current server")))
(error "Command invalid for this page"))))
(interactive)
(switch-to-buffer "*elpher*")
(elpher-visit-node
- (elpher-make-node "Bookmarks"
- elpher-current-node
- (elpher-make-address 'bookmarks))))
+ (elpher-make-node "Bookmarks" (elpher-make-address 'bookmarks))))
(defun elpher-info-node (node)
"Display information on NODE."
(switch-to-buffer "*elpher*")
(switch-to-buffer "*elpher*")
(setq elpher-current-node nil)
- (let ((start-node (elpher-make-node "Elpher Start Page" nil (elpher-make-address 'start))))
+ (let ((start-node (elpher-make-node "Elpher Start Page"
+ (elpher-make-address 'start))))
(elpher-visit-node start-node)))
"Started Elpher.") ; Otherwise (elpher) evaluates to start page string.