;; Author: Tim Vaughan <tgvaughan@gmail.com>
;; Created: 11 April 2019
-;; Version: 1.0.0
+;; Version: 1.1.1
;; Keywords: comm gopher
;; Homepage: https://github.com/tgvaughan/elpher
;; Package-Requires: ((emacs "25"))
;; - (m)enu key support, similar to Emacs' info browser,
;; - clickable web and gopher links in plain text.
-;; The caching mechanism works by maintaining a hierarchy of visited
-;; pages rather than a linear history, meaning that it is quick and
-;; easy to navigate this history.
+;; Visited pages are stored as a hierarchy rather than a linear history,
+;; meaning that navigation between these pages is quick and easy.
;; To launch Elpher, simply use 'M-x elpher'. This will open a start
;; page containing information on key bindings and suggested starting
;;; Global constants
;;
-(defconst elpher-version "1.0.0"
+(defconst elpher-version "1.1.1"
"Current version of elpher.")
(defconst elpher-margin-width 6
(mapconcat
'identity
(list "i\tfake\tfake\t1"
- "i--------------------------------------------\tfake\tfake\t1"
- "i Elpher Gopher Client \tfake\tfake\t1"
- (format "i version %s\tfake\tfake\t1" elpher-version)
- "i--------------------------------------------\tfake\tfake\t1"
+ "i --------------------------------------------\tfake\tfake\t1"
+ "i Elpher Gopher Client \tfake\tfake\t1"
+ (format "i version %s\tfake\tfake\t1" elpher-version)
+ "i --------------------------------------------\tfake\tfake\t1"
"i\tfake\tfake\t1"
"iUsage:\tfake\tfake\t1"
"i\tfake\tfake\t1"
"isearch terms:\tfake\tfake\t1"
"i\tfake\tfake\t1"
"7Veronica-2 Gopher Search Engine\t/v2/vs\tgopher.floodgap.com\t70"
- ".")
+ ".\r\n")
"\r\n")
"Source for elpher start page.")
Otherwise, use the system browser via the BROWSE-URL function."
:type '(boolean))
+(defcustom elpher-buttonify-urls-in-directories nil
+ "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))
use as the start page."
:type '(list string string integer))
-
;;; Model
;;
(defun elpher-address-selector (address)
"Retrieve selector from ADDRESS."
- (car address))
+ (elt address 0))
(defun elpher-address-host (address)
"Retrieve host from ADDRESS."
- (cadr address))
+ (elt address 1))
(defun elpher-address-port (address)
"Retrieve port from ADDRESS."
- (caddr address))
+ (elt address 2))
;; Node
;; Node graph traversal
-(defvar elpher-current-node)
+(defvar elpher-current-node nil)
(defun elpher-visit-node (node &optional getter)
"Visit NODE using its own getter or GETTER, if non-nil."
(defmacro elpher-with-clean-buffer (&rest args)
"Evaluate ARGS with a clean *elpher* buffer as current."
- (list 'progn
- '(switch-to-buffer "*elpher*")
+ (list 'with-current-buffer "*elpher*"
'(elpher-mode)
(append (list 'let '((inhibit-read-only t))
'(erase-buffer))
"Insert the index corresponding to STRING into the current buffer."
;; Should be able to split directly on CRLF, but some non-conformant
;; LF-only servers sadly exist, hence the following.
- (dolist (line (split-string (replace-regexp-in-string "\r" "" string) "\n"))
- (unless (= (length line) 0)
- (elpher-insert-index-record line))))
+ (let* ((str-no-period (replace-regexp-in-string "\r\n\.\r\n$" "\r\n" string))
+ (str-no-cr (replace-regexp-in-string "\r" "" str-no-period)))
+ (dolist (line (split-string str-no-cr "\n"))
+ (unless (= (length line) 0)
+ (elpher-insert-index-record line)))))
(defun elpher-insert-margin (&optional type-name)
"Insert index margin, optionally containing the TYPE-NAME, into the current buffer."
(if type-map-entry
(let ((getter (car type-map-entry))
(margin-code (cadr type-map-entry))
- (face (caddr type-map-entry)))
+ (face (elt type-map-entry 2)))
(elpher-insert-margin margin-code)
(insert-text-button display-string
'face face
selector host port)))
(pcase type
(?i (elpher-insert-margin) ;; Information
- (insert (propertize display-string
- 'face 'elpher-info)))
+ (insert (propertize
+ (if elpher-buttonify-urls-in-directories
+ (elpher-buttonify-urls display-string)
+ display-string)
+ 'face 'elpher-info)))
(?h (elpher-insert-margin "W") ;; Web link
(let ((url (elt (split-string selector "URL:") 1)))
(insert-text-button display-string
'action #'elpher-click-url
'follow-link t
'help-echo (format "mouse-1, RET: open url %s" url))))
- (?.) ;; Occurs at end of index, can safely ignore.
(tp (elpher-insert-margin (concat (char-to-string tp) "?"))
(insert (propertize display-string
'face 'elpher-unknown-face)))))
(if content
(progn
(elpher-with-clean-buffer
- (insert content))
- (elpher-restore-pos))
+ (insert content)
+ (elpher-restore-pos)))
(if address
(progn
(elpher-with-clean-buffer
(lambda (proc event)
(unless (string-prefix-p "deleted" event)
(elpher-with-clean-buffer
- (elpher-insert-index elpher-selector-string))
- (elpher-restore-pos)
- (elpher-set-node-content elpher-current-node
- (buffer-string))))))
+ (elpher-insert-index elpher-selector-string)
+ (elpher-restore-pos)
+ (elpher-set-node-content elpher-current-node
+ (buffer-string)))))))
(progn
(elpher-with-clean-buffer
- (elpher-insert-index elpher-start-index))
- (elpher-restore-pos)
- (elpher-set-node-content elpher-current-node
- (buffer-string)))))))
+ (elpher-insert-index elpher-start-index)
+ (elpher-restore-pos)
+ (elpher-set-node-content elpher-current-node
+ (buffer-string))))))))
;; Text retrieval
(protocol (downcase (match-string 1))))
(if (string= protocol "gopher")
(let* ((host (match-string 2))
- (port 70)
+ (port (if (match-string 3)
+ (string-to-number (substring (match-string 3) 1))
+ 70))
(type-and-selector (match-string 4))
(type (if (> (length type-and-selector) 1)
(elt type-and-selector 1)
(if content
(progn
(elpher-with-clean-buffer
- (insert content))
- (elpher-restore-pos))
+ (insert content)
+ (elpher-restore-pos)))
(progn
(elpher-with-clean-buffer
(insert "LOADING TEXT..."))
(lambda (proc event)
(unless (string-prefix-p "deleted" event)
(elpher-with-clean-buffer
- (insert (elpher-process-text elpher-selector-string)))
- (elpher-restore-pos)
- (elpher-set-node-content elpher-current-node
- (buffer-string)))))))))
+ (insert (elpher-process-text elpher-selector-string))
+ (elpher-restore-pos)
+ (elpher-set-node-content elpher-current-node
+ (buffer-string))))))))))
;; Image retrieval
(if content
(progn
(elpher-with-clean-buffer
- (insert-image content))
- (setq cursor-type nil)
- (elpher-restore-pos))
+ (insert-image content)
+ (elpher-restore-pos)))
(if (display-images-p)
(progn
(elpher-with-clean-buffer
'no-conversion)
nil t)))
(elpher-with-clean-buffer
- (insert-image image))
- (setq cursor-type nil)
- (elpher-restore-pos)
+ (insert-image image)
+ (elpher-restore-pos))
(if elpher-cache-images
(elpher-set-node-content elpher-current-node
image)))))))
(if content
(progn
(elpher-with-clean-buffer
- (insert content))
- (elpher-restore-pos)
+ (insert content)
+ (elpher-restore-pos))
(message "Displaying cached search results. Reload to perform a new search."))
(unwind-protect
(let* ((query-string (read-string "Query: "))
(lambda (proc event)
(unless (string-prefix-p "deleted" event)
(elpher-with-clean-buffer
- (insert elpher-selector-string))
- (goto-char (point-min)))))
+ (insert elpher-selector-string)
+ (goto-char (point-min))))))
(progn
(elpher-with-clean-buffer
(insert elpher-start-index))
(push-button))
(defun elpher-go ()
- "Go to a particular gopher site."
+ "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."
(interactive)
- (let* (
- (hostname (read-string "Gopher host: "))
- (selector (read-string "Selector (default none): " nil nil ""))
- (port (read-string "Port (default 70): " nil nil 70))
- (address (list selector hostname port)))
- (elpher-visit-node
- (elpher-make-node elpher-current-node
- address
- #'elpher-get-index-node))))
+ (let ((node
+ (let ((host-or-url (read-string "Gopher host or URL: ")))
+ (if (string-match elpher-url-regex host-or-url)
+ (if (not (string= (downcase (match-string 1 host-or-url)) "gopher"))
+ (error "Only gopher URLs acceptable")
+ (let* ((host (match-string 2 host-or-url))
+ (port (if (match-string 3 host-or-url)
+ (string-to-number (substring (match-string 3 host-or-url) 1))
+ 70))
+ (type-and-selector (match-string 4 host-or-url))
+ (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)
+ ""))
+ (address (elpher-make-address selector host port))
+ (getter (car (alist-get type elpher-type-map))))
+ (elpher-make-node elpher-current-node
+ address
+ getter)))
+ (let* ((selector (read-string "Selector (default none): " nil nil ""))
+ (port (read-string "Port (default 70): " nil nil 70))
+ (address (list selector host-or-url port)))
+ (elpher-make-node elpher-current-node
+ address
+ #'elpher-get-index-node))))))
+ (switch-to-buffer "*elpher*")
+ (elpher-visit-node node)))
(defun elpher-redraw ()
"Redraw current page."
(interactive)
- (elpher-visit-node elpher-current-node))
+ (if elpher-current-node
+ (elpher-visit-node elpher-current-node)
+ (message "No current site.")))
(defun elpher-reload ()
"Reload current page."
(interactive)
- (elpher-reload-current-node))
+ (if elpher-current-node
+ (elpher-reload-current-node)
+ (message "No current site.")))
(defun elpher-view-raw ()
"View current page as plain text."
(interactive)
- (elpher-visit-node elpher-current-node
- #'elpher-get-node-raw))
+ (if elpher-current-node
+ (elpher-visit-node elpher-current-node
+ #'elpher-get-node-raw)
+ (message "No current site.")))
(defun elpher-back ()
"Go to previous site."
(let* ((link-map (elpher-build-link-map)))
(if link-map
(let ((key (let ((completion-ignore-case t))
- (completing-read "Directory entry/link (tab to autocomplete): "
+ (completing-read "Directory item/link: "
link-map nil t))))
(if (and key (> (length key) 0))
(let ((b (cdr (assoc key link-map))))
(defun elpher ()
"Start elpher with default landing page."
(interactive)
- (setq elpher-current-node nil)
- (let ((start-node (elpher-make-node nil
- elpher-start-address
- #'elpher-get-index-node)))
- (elpher-visit-node start-node))
+ (if (get-buffer "*elpher*")
+ (switch-to-buffer "*elpher*")
+ (switch-to-buffer "*elpher*")
+ (setq elpher-current-node nil)
+ (let ((start-node (elpher-make-node nil
+ elpher-start-address
+ #'elpher-get-index-node)))
+ (elpher-visit-node start-node)))
"Started Elpher.") ; Otherwise (elpher) evaluates to start page string.
;;; elpher.el ends here