;; Author: Tim Vaughan <tgvaughan@gmail.com>
;; Created: 11 April 2019
-;; Version: 1.4.2
+;; Version: 1.4.6
;; 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.
;;; Commentary:
-;; Elpher aims to provide a practical gopher client for GNU Emacs.
-;; It supports:
+;; Elpher aims to provide a practical and friendly gopher client
+;; for GNU Emacs. It supports:
-;; - intuitive keyboard and mouse-driven interface,
-;; - caching of visited sites (both content and cursor position),
+;; - intuitive keyboard and mouse-driven browsing,
+;; - out-of-the-box compatibility with evil-mode,
+;; - clickable web and gopher links *in plain text*,
+;; - caching of visited sites,
;; - pleasant and configurable colouring of Gopher directories,
;; - direct visualisation of image files,
-;; - (m)enu key support, similar to Emacs' info browser,
-;; - clickable web and gopher links in plain text,
;; - a simple bookmark management system,
-;; - support for TLS gopherholes.
+;; - connections using TLS encryption.
;; To launch Elpher, simply use 'M-x elpher'. This will open a start
;; page containing information on key bindings and suggested starting
;; points for your gopher exploration.
-;; Faces, caching and other options can be configured via
-;; the Elpher customization group in Applications.
+;; Full instructions can be found in the Elpher info manual.
+
+;; Elpher is under active development. Any suggestions for
+;; improvements are welcome!
;;; Code:
(provide 'elpher)
+
+;;; Dependencies
+;;
+
(require 'seq)
(require 'pp)
(require 'shr)
+(require 'url-util)
+
;;; Global constants
;;
-(defconst elpher-version "1.4.2"
+(defconst elpher-version "1.4.6"
"Current version of elpher.")
(defconst elpher-margin-width 6
"Width of left-hand margin used when rendering indicies.")
-(defconst elpher-start-index
- (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"
- "iUsage:\tfake\tfake\t1"
- "i\tfake\tfake\t1"
- "i - tab/shift-tab: next/prev item on current page\tfake\tfake\t1"
- "i - RET/mouse-1: open item under cursor\tfake\tfake\t1"
- "i - m: select an item on current page by name (autocompletes)\tfake\tfake\t1"
- "i - u: return to parent\tfake\tfake\t1"
- "i - O: visit the root menu of the current server\tfake\tfake\t1"
- "i - g: go to a particular gopher address\tfake\tfake\t1"
- "i - i/I: info on item under cursor or current page\tfake\tfake\t1"
- "i - c/C: copy URL representation of item under cursor or current page\tfake\tfake\t1"
- "i - a/A: bookmark the item under cursor or current page\tfake\tfake\t1"
- "i - x/X: remove bookmark for item under cursor or current page\tfake\tfake\t1"
- "i - B: visit the bookmarks page\tfake\tfake\t1"
- "i - r: redraw current page (using cached contents if available)\tfake\tfake\t1"
- "i - R: reload current page (regenerates cache)\tfake\tfake\t1"
- "i - T: toggle TLS mode\tfake\tfake\t1"
- "i - d/D: download item under cursor or current page\tfake\tfake\t1"
- "i - w: display the raw server response for the current page\tfake\tfake\t1"
- "i - S: set an explicit character coding system (default is to autodetect)\tfake\tfake\t1"
- "i\tfake\tfake\t1"
- "iWhere to start exploring Gopherspace:\tfake\tfake\t1"
- "i\tfake\tfake\t1"
- "1Floodgap Systems Gopher Server\t/\tgopher.floodgap.com\t70"
- "i\tfake\tfake\t1"
- "iAlternatively, select the following item and enter some\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.")
(defconst elpher-type-map
'((?0 elpher-get-text-node "txt" elpher-text)
(?p elpher-get-image-node "img" elpher-image)
(?I elpher-get-image-node "img" elpher-image)
(?d elpher-get-node-download "doc" elpher-binary)
- (?h elpher-get-url-node "web" elpher-url)
+ (?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))
"Association list from types to getters, margin codes and index faces.")
"If non-nil, display current node information in buffer header."
:type '(boolean))
+(defcustom elpher-auto-disengage-TLS nil
+ "If non-nil, automatically disengage TLS following an unsuccessful connection.
+While enabling this may seem convenient, it is also potentially dangerous as it
+allows switching from an encrypted channel back to plain text without user input."
+ :type '(boolean))
+
+
;;; Model
;;
"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))))))
+
;; Node
(defun elpher-make-node (display-string address &optional parent)
(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 (alist-get type elpher-type-map)))
+ (if (listp type-record)
+ (funcall (car type-record))
+ (elpher-visit-parent-node)
+ (error "Unsupported gopher selector type '%c'" type)))))
(defun elpher-visit-parent-node ()
"Visit the parent of the current node."
(error
(if (and (consp the-error)
(eq (car the-error) 'gnutls-error)
- (not (elpher-address-use-tls-p address)))
+ (not (elpher-address-use-tls-p address))
+ (or elpher-auto-disengage-TLS
+ (yes-or-no-p "Could not establish encrypted connection. Disable TLS mode? ")))
(progn
- (message "Could not establish TLS connection. Disengaging TLS mode.")
+ (message "Disengaging TLS mode.")
(setq elpher-use-tls nil)
(elpher-get-selector address after))
(elpher-process-cleanup)
;; Text retrieval
(defconst elpher-url-regex
- "\\([a-zA-Z]+\\)://\\([a-zA-Z0-9.\-]+\\)\\(?3::[0-9]+\\)?\\(?4:/[^ \r\n\t(),]*\\)?"
+ "\\([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)
(protocol (downcase (match-string 1 string))))
(if (or (string= protocol "gopher")
(string= protocol "gophers"))
- (let* ((host (match-string 2 string))
+ (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 (if (> (length type-and-selector) 1)
(elt type-and-selector 1)
?1))
- (selector (if (> (length type-and-selector) 1)
- (substring type-and-selector 2)
- ""))
+ (selector (decode-coding-string
+ (url-unhex-string
+ (if (> (length type-and-selector) 1)
+ (substring type-and-selector 2)
+ "")) 'utf-8))
(use-tls (string= protocol "gophers"))
(address (elpher-make-address type selector host port use-tls)))
(elpher-make-node url address))
(let ((address (elpher-node-address elpher-current-node)))
(elpher-with-clean-buffer
(insert "LOADING RAW SERVER RESPONSE... (use 'u' to cancel)"))
- (if address
- (elpher-get-selector address
- (lambda (proc event)
- (unless (string-prefix-p "deleted" event)
- (elpher-with-clean-buffer
- (insert elpher-selector-string)
- (goto-char (point-min))))))
- (progn
- (elpher-with-clean-buffer
- (insert elpher-start-index))
- (goto-char (point-min)))))
+ (elpher-get-selector address
+ (lambda (proc event)
+ (unless (string-prefix-p "deleted" event)
+ (elpher-with-clean-buffer
+ (insert elpher-selector-string)
+ (goto-char (point-min)))))))
(message "Displaying raw server response. Reload or redraw to return to standard view."))
;; File export retrieval
(defun elpher-get-start-node ()
"Getter which displays the start page."
(elpher-with-clean-buffer
- (elpher-insert-index elpher-start-index)
+ (insert " --------------------------------------------\n"
+ " Elpher Gopher Client \n"
+ " version " elpher-version "\n"
+ " --------------------------------------------\n"
+ "\n"
+ "Default bindings:\n"
+ "\n"
+ " - 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: return to previous page\n"
+ " - o/O: visit different selector or the root menu of the current server\n"
+ " - g: go to a particular gopher address\n"
+ " - i/I: info on item under cursor or current page\n"
+ " - c/C: copy URL representation of item under cursor or current page\n"
+ " - a/A: bookmark the item under cursor or current page\n"
+ " - x/X: remove bookmark for item under cursor or current page\n"
+ " - B: visit the bookmarks page\n"
+ " - r: redraw current page (using cached contents if available)\n"
+ " - 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"
+ " - 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))
+ (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))
+ (insert "\n"
+ "** Refer to the ")
+ (let ((help-string "RET,mouse-1: Open Elpher info manual (if available)"))
+ (insert-text-button "Elpher info manual"
+ 'face 'link
+ 'action (lambda (button)
+ (interactive)
+ (info "(elpher)"))
+ 'follow-link t
+ 'help-echo help-string))
+ (insert " for the full documentation. **\n")
+ (insert (propertize
+ (concat " (This should be available if you have installed Elpher using\n"
+ " MELPA. Otherwise you will have to install the manual yourself.)")
+ 'face 'shadow))
(elpher-restore-pos)))
;; Bookmarks page node retrieval
(not (equal (elpher-bookmark-address bookmark) address)))
(elpher-load-bookmarks))))
+
;;; Interactive procedures
;;
(switch-to-buffer "*elpher*")
(elpher-visit-node node)))
+(defun elpher-go-current ()
+ "Go to a particular site read from the minibuffer, initialized with the current URL."
+ (interactive)
+ (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))))))
+
(defun elpher-redraw ()
"Redraw current page."
(interactive)
(error "No link selected"))))
(defun elpher-bookmarks ()
- "Visit bookmarks."
+ "Visit bookmarks page."
(interactive)
(switch-to-buffer "*elpher*")
(elpher-visit-node
(interactive)
(elpher-info-node elpher-current-node))
-(defun elpher-get-address-url (address)
- "Get URL representation of ADDRESS."
- (let ((type (elpher-address-type address))
- (selector (elpher-address-selector address))
- (host (elpher-address-host address))
- (port (elpher-address-port address)))
- (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))))
-
(defun elpher-copy-node-url (node)
"Copy URL representation of address of NODE to `kill-ring'."
(let ((address (elpher-node-address node)))
(message "Coding system fixed to %s. (Reload to see effect)." system)
(message "Coding system set to autodetect. (Reload to see effect)."))))
+
;;; Mode and keymap
;;
(define-key map (kbd "u") 'elpher-back)
(define-key map (kbd "O") 'elpher-root-dir)
(define-key map (kbd "g") 'elpher-go)
+ (define-key map (kbd "o") 'elpher-go-current)
(define-key map (kbd "r") 'elpher-redraw)
(define-key map (kbd "R") 'elpher-reload)
(define-key map (kbd "T") 'elpher-toggle-tls)
(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
"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
+`elpher', `elpher-go' and `elpher-bookmarks'.")
(when (fboundp 'evil-set-initial-state)
(evil-set-initial-state 'elpher-mode 'motion))
+
;;; Main start procedure
;;
The Lambda Lab / projects / elpher.git / blobdiff