X-Git-Url: https://thelambdalab.xyz/gitweb/index.cgi?p=elpher.git;a=blobdiff_plain;f=elpher.el;h=474eee1c9f00700d424410d86525b92f0388cafc;hp=7781c0b9fd94e99d7f3ce5c038fac1ea214f3715;hb=c9175aedfaf3daeca6b2414f74ef703f2f6cbc1f;hpb=654782e6a924e1d47a69ab7ea589999083341516 diff --git a/elpher.el b/elpher.el index 7781c0b..474eee1 100644 --- a/elpher.el +++ b/elpher.el @@ -1,12 +1,12 @@ -;;; elpher.el --- A friendly gopher client. -*- lexical-binding:t -*- +;;; elpher.el --- A friendly gopher client -*- lexical-binding:t -*- ;; Copyright (C) 2019 Tim Vaughan -;; Author: Tim Vaughan +;; Author: Tim Vaughan ;; Created: 11 April 2019 -;; Version: 2.3.6 +;; Version: 2.5.2 ;; Keywords: comm gopher -;; Homepage: https://github.com/tgvaughan/elpher +;; Homepage: http://thelambdalab.xyz/elpher ;; Package-Requires: ((emacs "26")) ;; This file is not part of GNU Emacs. @@ -37,7 +37,7 @@ ;; - direct visualisation of image files, ;; - a simple bookmark management system, ;; - connections using TLS encryption, -;; - basic support for the fledgling Gemini protocol. +;; - the fledgling Gemini protocol. ;; To launch Elpher, simply use 'M-x elpher'. This will open a start ;; page containing information on key bindings and suggested starting @@ -46,7 +46,8 @@ ;; Full instructions can be found in the Elpher info manual. ;; Elpher is under active development. Any suggestions for -;; improvements are welcome! +;; improvements are welcome, and can be made on the official +;; project page, gopher://thelambdalab.xyz/1/projects/elpher/. ;;; Code: @@ -61,36 +62,37 @@ (require 'url-util) (require 'subr-x) (require 'dns) +(require 'ansi-color) ;;; Global constants ;; -(defconst elpher-version "2.3.6" +(defconst elpher-version "2.5.2" "Current version of elpher.") (defconst elpher-margin-width 6 "Width of left-hand margin used when rendering indicies.") (defconst elpher-type-map - '(((gopher ?0) elpher-get-gopher-node elpher-render-text "txt" elpher-text) - ((gopher ?1) elpher-get-gopher-node elpher-render-index "/" elpher-index) - ((gopher ?4) elpher-get-gopher-node elpher-render-download "bin" elpher-binary) - ((gopher ?5) elpher-get-gopher-node elpher-render-download "bin" elpher-binary) - ((gopher ?7) elpher-get-gopher-query-node elpher-render-index "?" elpher-search) - ((gopher ?9) elpher-get-gopher-node elpher-render-download "bin" elpher-binary) - ((gopher ?g) elpher-get-gopher-node elpher-render-image "img" elpher-image) - ((gopher ?p) elpher-get-gopher-node elpher-render-image "img" elpher-image) - ((gopher ?I) elpher-get-gopher-node elpher-render-image "img" elpher-image) - ((gopher ?d) elpher-get-gopher-node elpher-render-download "doc" elpher-binary) - ((gopher ?P) elpher-get-gopher-node elpher-render-download "doc" elpher-binary) - ((gopher ?s) elpher-get-gopher-node elpher-render-download "snd" elpher-binary) - ((gopher ?h) elpher-get-gopher-node elpher-render-html "htm" elpher-html) - (gemini elpher-get-gemini-node elpher-render-gemini "gem" elpher-gemini) - (telnet elpher-get-telnet-node nil "tel" elpher-telnet) - (other-url elpher-get-other-url-node nil "url" elpher-other-url) - ((special bookmarks) elpher-get-bookmarks-node nil "/" elpher-index) - ((special start) elpher-get-start-node nil)) + '(((gopher ?0) elpher-get-gopher-page elpher-render-text "txt" elpher-text) + ((gopher ?1) elpher-get-gopher-page elpher-render-index "/" elpher-index) + ((gopher ?4) elpher-get-gopher-page elpher-render-download "bin" elpher-binary) + ((gopher ?5) elpher-get-gopher-page elpher-render-download "bin" elpher-binary) + ((gopher ?7) elpher-get-gopher-query-page elpher-render-index "?" elpher-search) + ((gopher ?9) elpher-get-gopher-page elpher-render-download "bin" elpher-binary) + ((gopher ?g) elpher-get-gopher-page elpher-render-image "img" elpher-image) + ((gopher ?p) elpher-get-gopher-page elpher-render-image "img" elpher-image) + ((gopher ?I) elpher-get-gopher-page elpher-render-image "img" elpher-image) + ((gopher ?d) elpher-get-gopher-page elpher-render-download "doc" elpher-binary) + ((gopher ?P) elpher-get-gopher-page elpher-render-download "doc" elpher-binary) + ((gopher ?s) elpher-get-gopher-page elpher-render-download "snd" elpher-binary) + ((gopher ?h) elpher-get-gopher-page elpher-render-html "htm" elpher-html) + (gemini elpher-get-gemini-page elpher-render-gemini "gem" elpher-gemini) + (telnet elpher-get-telnet-page nil "tel" elpher-telnet) + (other-url elpher-get-other-url-page nil "url" elpher-other-url) + ((special bookmarks) elpher-get-bookmarks-page nil "/" elpher-index) + ((special start) elpher-get-start-page nil)) "Association list from types to getters, renderers, margin codes and index faces.") @@ -162,12 +164,8 @@ Otherwise, use the system browser via the BROWSE-URL function." :type '(boolean)) -(defcustom elpher-buttonify-urls-in-directories t - "If non-nil, turns URLs matched in directories into clickable buttons." - :type '(boolean)) - (defcustom elpher-use-header t - "If non-nil, display current node information in buffer header." + "If non-nil, display current page information in buffer header." :type '(boolean)) (defcustom elpher-auto-disengage-TLS nil @@ -180,6 +178,12 @@ allows switching from an encrypted channel back to plain text without user input "Specifies the number of seconds to wait for a network connection to time out." :type '(integer)) +(defcustom elpher-filter-ansi-from-text nil + "If non-nil, filter ANSI escape sequences from text. +The default behaviour is to use the ansi-color package to interpret these +sequences." + :type '(boolean)) + ;;; Model ;; @@ -240,7 +244,7 @@ requiring gopher-over-TLS." selector))))) (defun elpher-make-special-address (type) - "Create an ADDRESS object corresponding to the given special page symbol TYPE." + "Create an ADDRESS object corresponding to the given special address symbol TYPE." type) (defun elpher-address-to-url (address) @@ -307,36 +311,6 @@ If no address is defined, returns 0. (This is for compatibility with the URL li "" (substring (url-filename address) 2))) -;; Node - -(defun elpher-make-node (display-string address &optional parent) - "Create a node in the page hierarchy. - -DISPLAY-STRING records the display string used for the 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 -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-address (node) - "Retrieve the ADDRESS object 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 @@ -359,24 +333,36 @@ initially." "Set the cursor position cache for ADDRESS to POS." (puthash address pos elpher-pos-cache)) -;; Node graph traversal -(defvar elpher-current-node nil) +;; Page + +(defun elpher-make-page (display-string address) + "Create a page with DISPLAY-STRING and ADDRESS." + (list display-string address)) + +(defun elpher-page-display-string (page) + "Retrieve the display string corresponding to PAGE." + (elt page 0)) + +(defun elpher-page-address (page) + "Retrieve the address corresponding to PAGE." + (elt page 1)) -(defun elpher-visit-node (node &optional renderer preserve-parent) - "Visit NODE using its own renderer or RENDERER, if non-nil. -Additionally, set the parent of NODE to `elpher-current-node', -unless PRESERVE-PARENT is non-nil." +(defvar elpher-current-page nil) +(defvar elpher-history nil) + +(defun elpher-visit-page (page &optional renderer no-history) + "Visit PAGE using its own renderer or RENDERER, if non-nil. +Additionally, push PAGE onto the stack of previously-visited pages, +unless NO-HISTORY is non-nil." (elpher-save-pos) (elpher-process-cleanup) - (unless preserve-parent - (if (and (elpher-node-parent elpher-current-node) - (equal (elpher-node-address elpher-current-node) - (elpher-node-address node))) - (elpher-set-node-parent node (elpher-node-parent elpher-current-node)) - (elpher-set-node-parent node elpher-current-node))) - (setq elpher-current-node node) - (let* ((address (elpher-node-address node)) + (unless (or no-history + (equal (elpher-page-address elpher-current-page) + (elpher-page-address page))) + (push elpher-current-page elpher-history)) + (setq elpher-current-page page) + (let* ((address (elpher-page-address page)) (type (elpher-address-type address)) (type-record (cdr (assoc type elpher-type-map)))) (if type-record @@ -384,7 +370,7 @@ unless PRESERVE-PARENT is non-nil." (if renderer renderer (cadr type-record))) - (elpher-visit-parent-node) + (elpher-visit-previous-page) (pcase type (`(gopher ,type-char) (error "Unsupported gopher selector type '%c' for '%s'" @@ -393,25 +379,26 @@ unless PRESERVE-PARENT is non-nil." (error "Unsupported address type '%S' for '%s'" other (elpher-address-to-url address))))))) -(defun elpher-visit-parent-node () - "Visit the parent of the current node." - (let ((parent-node (elpher-node-parent elpher-current-node))) - (when parent-node - (elpher-visit-node parent-node nil t)))) +(defun elpher-visit-previous-page () + "Visit the previous page in the history." + (let ((previous-page (pop elpher-history))) + (if previous-page + (elpher-visit-page previous-page nil t) + (error "No previous page.")))) -(defun elpher-reload-current-node () - "Reload the current node, discarding any existing cached content." - (elpher-cache-content (elpher-node-address elpher-current-node) nil) - (elpher-visit-node elpher-current-node)) +(defun elpher-reload-current-page () + "Reload the current page, discarding any existing cached content." + (elpher-cache-content (elpher-page-address elpher-current-page) nil) + (elpher-visit-page elpher-current-page)) (defun elpher-save-pos () - "Save the current position of point to the current node." - (when elpher-current-node - (elpher-cache-pos (elpher-node-address elpher-current-node) (point)))) + "Save the current position of point to the current page." + (when elpher-current-page + (elpher-cache-pos (elpher-page-address elpher-current-page) (point)))) (defun elpher-restore-pos () - "Restore the position of point to that cached in the current node." - (let ((pos (elpher-get-cached-pos (elpher-node-address elpher-current-node)))) + "Restore the position of point to that cached in the current page." + (let ((pos (elpher-get-cached-pos (elpher-page-address elpher-current-page)))) (if pos (goto-char pos) (goto-char (point-min))))) @@ -421,10 +408,10 @@ unless PRESERVE-PARENT is non-nil." ;; (defun elpher-update-header () - "If `elpher-use-header' is true, display current node info in window header." + "If `elpher-use-header' is true, display current page info in window header." (if elpher-use-header - (let* ((display-string (elpher-node-display-string elpher-current-node)) - (address (elpher-node-address elpher-current-node)) + (let* ((display-string (elpher-page-display-string elpher-current-page)) + (address (elpher-page-address elpher-current-page)) (tls-string (if (and (not (elpher-address-special-p address)) (member (elpher-address-protocol address) '("gophers" "gemini"))) @@ -565,11 +552,11 @@ to ADDRESS." (error (error "Error initiating connection to server")))) -(defun elpher-get-gopher-node (renderer) - "Getter function for gopher nodes. -The RENDERER procedure is used to display the contents of the node +(defun elpher-get-gopher-page (renderer) + "Getter function for gopher pages. +The RENDERER procedure is used to display the contents of the page once they are retrieved from the gopher server." - (let* ((address (elpher-node-address elpher-current-node)) + (let* ((address (elpher-page-address elpher-current-page)) (content (elpher-get-cached-content address))) (if (and content (funcall renderer nil)) (elpher-with-clean-buffer @@ -615,9 +602,9 @@ once they are retrieved from the gopher server." (insert " ")) (insert (make-string elpher-margin-width ?\s)))) -(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))) +(defun elpher-page-button-help (page) + "Return a string containing the help text for a button corresponding to PAGE." + (let ((address (elpher-page-address page))) (format "mouse-1, RET: open '%s'" (if (elpher-address-special-p address) address (elpher-address-to-url address))))) @@ -632,22 +619,21 @@ If ADDRESS is not supplied or nil the record is rendered as an (if type-map-entry (let* ((margin-code (elt type-map-entry 2)) (face (elt type-map-entry 3)) - (node (elpher-make-node display-string address))) + (filtered-display-string (ansi-color-filter-apply display-string)) + (page (elpher-make-page filtered-display-string address))) (elpher-insert-margin margin-code) - (insert-text-button display-string + (insert-text-button filtered-display-string 'face face - 'elpher-node node + 'elpher-page page 'action #'elpher-click-link 'follow-link t - 'help-echo (elpher-node-button-help node))) + 'help-echo (elpher-page-button-help page))) (pcase type ((or '(gopher ?i) 'nil) ;; Information (elpher-insert-margin) (let ((propertized-display-string (propertize display-string 'face 'elpher-info))) - (insert (if elpher-buttonify-urls-in-directories - (elpher-buttonify-urls propertized-display-string) - propertized-display-string)))) + (insert (elpher-process-text-for-display propertized-display-string)))) (`(gopher ,selector-type) ;; Unknown (elpher-insert-margin (concat (char-to-string selector-type) "?")) (insert (propertize display-string @@ -656,8 +642,8 @@ If ADDRESS is not supplied or nil the record is rendered as an (defun elpher-click-link (button) "Function called when the gopher link BUTTON is activated (via mouse or keypress)." - (let ((node (button-get button 'elpher-node))) - (elpher-visit-node node))) + (let ((page (button-get button 'elpher-page))) + (elpher-visit-page page))) (defun elpher-render-index (data &optional _mime-type-string) "Render DATA as an index. MIME-TYPE-STRING is unused." @@ -665,14 +651,14 @@ If ADDRESS is not supplied or nil the record is rendered as an (if (not data) t (elpher-insert-index data) - (elpher-cache-content (elpher-node-address elpher-current-node) + (elpher-cache-content (elpher-page-address elpher-current-page) (buffer-string))))) ;; Text rendering (defconst elpher-url-regex - "\\([a-zA-Z]+\\)://\\([a-zA-Z0-9.\-]*[a-zA-Z0-9\-]\\|\[[a-zA-Z0-9:]+\]\\)\\(:[0-9]+\\)?\\(/\\([0-9a-zA-Z\-_~?/@|:.]*[0-9a-zA-Z\-_~?/@|]\\)?\\)?" - "Regexp used to locate and buttniofy URLs in text files loaded by elpher.") + "\\([a-zA-Z]+\\)://\\([a-zA-Z0-9.\-]*[a-zA-Z0-9\-]\\|\[[a-zA-Z0-9:]+\]\\)\\(:[0-9]+\\)?\\(/\\([0-9a-zA-Z\-_~?/@|:.%#=&]*[0-9a-zA-Z\-_~?/@|#]\\)?\\)?" + "Regexp used to locate and buttinofy URLs in text files loaded by elpher.") (defun elpher-buttonify-urls (string) "Turn substrings which look like urls in STRING into clickable buttons." @@ -680,25 +666,35 @@ If ADDRESS is not supplied or nil the record is rendered as an (insert string) (goto-char (point-min)) (while (re-search-forward elpher-url-regex nil t) - (let ((node (elpher-make-node (substring-no-properties (match-string 0)) + (let ((page (elpher-make-page (substring-no-properties (match-string 0)) (elpher-address-from-url (match-string 0))))) (make-text-button (match-beginning 0) (match-end 0) - 'elpher-node node + 'elpher-page page 'action #'elpher-click-link 'follow-link t - 'help-echo (elpher-node-button-help node) + 'help-echo (elpher-page-button-help page) 'face 'button))) (buffer-string))) +(defconst elpher-ansi-regex "\x1b\\[[^m]*m" + "Wildly incomplete regexp used to strip out some troublesome ANSI escape sequences.") + +(defun elpher-process-text-for-display (string) + "Perform any desired processing of STRING prior to display as text. +Currently includes buttonifying URLs and processing ANSI escape codes." + (elpher-buttonify-urls (if elpher-filter-ansi-from-text + (ansi-color-filter-apply string) + (ansi-color-apply string)))) + (defun elpher-render-text (data &optional _mime-type-string) "Render DATA as text. MIME-TYPE-STRING is unused." (elpher-with-clean-buffer (if (not data) t - (insert (elpher-buttonify-urls (elpher-preprocess-text-response data))) + (insert (elpher-process-text-for-display (elpher-preprocess-text-response data))) (elpher-cache-content - (elpher-node-address elpher-current-node) + (elpher-page-address elpher-current-page) (buffer-string))))) ;; Image retrieval @@ -719,10 +715,10 @@ If ADDRESS is not supplied or nil the record is rendered as an ;; Search retrieval and rendering -(defun elpher-get-gopher-query-node (renderer) +(defun elpher-get-gopher-query-page (renderer) "Getter for gopher addresses requiring input. The response is rendered using the rendering function RENDERER." - (let* ((address (elpher-node-address elpher-current-node)) + (let* ((address (elpher-page-address elpher-current-page)) (content (elpher-get-cached-content address)) (aborted t)) (if (and content (funcall renderer nil)) @@ -744,7 +740,7 @@ The response is rendered using the rendering function RENDERER." (insert "LOADING RESULTS... (use 'u' to cancel)")) (elpher-get-selector search-address renderer)) (if aborted - (elpher-visit-parent-node)))))) + (elpher-visit-previous-page)))))) ;; Raw server response rendering @@ -765,9 +761,9 @@ The response is rendered using the rendering function RENDERER." "Save DATA to file. MIME-TYPE-STRING is unused." (if (not data) nil - (let* ((address (elpher-node-address elpher-current-node)) + (let* ((address (elpher-page-address elpher-current-page)) (selector (elpher-gopher-address-selector address))) - (elpher-visit-parent-node) ; Do first in case of non-local exits. + (elpher-visit-previous-page) ; Do first in case of non-local exits. (let* ((filename-proposal (file-name-nondirectory selector)) (filename (read-file-name "Download complete. Save file as: " nil nil nil @@ -791,7 +787,7 @@ The response is rendered using the rendering function RENDERER." (libxml-parse-html-region (point-min) (point-max))))) (shr-insert-document dom))))) -;; Gemini node retrieval +;; Gemini page retrieval (defvar elpher-gemini-redirect-chain) @@ -825,7 +821,9 @@ to ADDRESS." (set-process-coding-system proc 'binary) (set-process-filter proc (lambda (_proc string) - (cancel-timer timer) + (when timer + (cancel-timer timer) + (setq timer nil)) (setq response-string (concat response-string string)))) (set-process-sentinel proc @@ -881,7 +879,7 @@ that the response was malformed." (elpher-with-clean-buffer (insert "Gemini server is requesting input.")) (let* ((query-string (read-string (concat response-meta ": "))) - (url (elpher-address-to-url (elpher-node-address elpher-current-node))) + (url (elpher-address-to-url (elpher-page-address elpher-current-page))) (query-address (elpher-address-from-url (concat url "?" query-string)))) (elpher-get-gemini-response query-address renderer))) (?2 ; Normal response @@ -911,9 +909,9 @@ that the response was malformed." (error "Gemini server response unknown: %s %s" response-code response-meta)))))) -(defun elpher-get-gemini-node (renderer) - "Getter which retrieves and renders a Gemini node and renders it using RENDERER." - (let* ((address (elpher-node-address elpher-current-node)) +(defun elpher-get-gemini-page (renderer) + "Getter which retrieves and renders a Gemini page and renders it using RENDERER." + (let* ((address (elpher-page-address elpher-current-page)) (content (elpher-get-cached-content address))) (condition-case the-error (if (and content (funcall renderer nil)) @@ -995,11 +993,11 @@ For instance, the filename /a/b/../c/./d will reduce to /a/c/d" (if (url-host address) ;if there is an explicit host, filenames are absolute (if (string-empty-p (url-filename address)) (setf (url-filename address) "/")) ;ensure empty filename is marked as absolute - (setf (url-host address) (url-host (elpher-node-address elpher-current-node))) + (setf (url-host address) (url-host (elpher-page-address elpher-current-page))) (unless (string-prefix-p "/" (url-filename address)) ;deal with relative links (setf (url-filename address) (concat (file-name-directory - (url-filename (elpher-node-address elpher-current-node))) + (url-filename (elpher-page-address elpher-current-page))) (url-filename address))))) (unless (url-type address) (setf (url-type address) "gemini")) @@ -1021,54 +1019,54 @@ For instance, the filename /a/b/../c/./d will reduce to /a/c/d" (elpher-insert-index-record url address))) (elpher-insert-index-record line))) (elpher-cache-content - (elpher-node-address elpher-current-node) + (elpher-page-address elpher-current-page) (buffer-string)))) (defun elpher-render-gemini-plain-text (data _parameters) "Render DATA as plain text file. PARAMETERS is currently unused." (elpher-with-clean-buffer - (insert (elpher-buttonify-urls data)) + (insert (elpher-process-text-for-display data)) (elpher-cache-content - (elpher-node-address elpher-current-node) + (elpher-page-address elpher-current-page) (buffer-string)))) -;; Other URL node opening +;; Other URL page opening -(defun elpher-get-other-url-node (renderer) - "Getter which attempts to open the URL specified by the current node (RENDERER must be nil)." +(defun elpher-get-other-url-page (renderer) + "Getter which attempts to open the URL specified by the current page (RENDERER must be nil)." (when renderer - (elpher-visit-parent-node) + (elpher-visit-previous-page) (error "Command not supported for general URLs")) - (let* ((address (elpher-node-address elpher-current-node)) + (let* ((address (elpher-page-address elpher-current-page)) (url (elpher-address-to-url address))) (progn - (elpher-visit-parent-node) ; Do first in case of non-local exits. + (elpher-visit-previous-page) ; 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 +;; Telnet page connection -(defun elpher-get-telnet-node (renderer) - "Opens a telnet connection to the current node address (RENDERER must be nil)." +(defun elpher-get-telnet-page (renderer) + "Opens a telnet connection to the current page address (RENDERER must be nil)." (when renderer - (elpher-visit-parent-node) + (elpher-visit-previous-page) (error "Command not supported for telnet URLs")) - (let* ((address (elpher-node-address elpher-current-node)) + (let* ((address (elpher-page-address elpher-current-page)) (host (elpher-address-host address)) (port (elpher-address-port address))) - (elpher-visit-parent-node) + (elpher-visit-previous-page) (if (> port 0) (telnet host port) (telnet host)))) -;; Start page node retrieval +;; Start page page retrieval -(defun elpher-get-start-node (renderer) +(defun elpher-get-start-page (renderer) "Getter which displays the start page (RENDERER must be nil)." (when renderer - (elpher-visit-parent-node) + (elpher-visit-previous-page) (error "Command not supported for start page")) (elpher-with-clean-buffer (insert " --------------------------------------------\n" @@ -1106,6 +1104,13 @@ For instance, the filename /a/b/../c/./d will reduce to /a/c/d" (insert "\n" "This page contains your bookmarked sites (also visit with B):\n") (elpher-insert-index-record "Your Bookmarks" 'bookmarks) + (insert "\n" + "For Elpher release news or to leave feedback, visit:\n") + (elpher-insert-index-record "The Elpher Project Page" + (elpher-make-gopher-address ?1 + "/projects/elpher/" + "thelambdalab.xyz" + 70)) (insert "\n" "** Refer to the ") (let ((help-string "RET,mouse-1: Open Elpher info manual (if available)")) @@ -1119,16 +1124,16 @@ For instance, the filename /a/b/../c/./d will reduce to /a/c/d" (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.)") + " MELPA. Otherwise you will have to install the manual yourself.)\n") 'face 'shadow)) (elpher-restore-pos))) -;; Bookmarks page node retrieval +;; Bookmarks page page retrieval -(defun elpher-get-bookmarks-node (renderer) +(defun elpher-get-bookmarks-page (renderer) "Getter to load and display the current bookmark list (RENDERER must be nil)." (when renderer - (elpher-visit-parent-node) + (elpher-visit-previous-page) (error "Command not supported for bookmarks page")) (elpher-with-clean-buffer (insert "---- Bookmark list ----\n\n") @@ -1246,38 +1251,34 @@ If ADDRESS is already bookmarked, update the label only." (interactive) (push-button)) -(defun elpher-go () - "Go to a particular gopher site read from the minibuffer." - (interactive) - (let ((node - (let ((host-or-url (read-string "Gopher or Gemini URL: "))) - (elpher-make-node host-or-url - (elpher-address-from-url host-or-url))))) +(defun elpher-go (host-or-url) + "Go to a particular gopher site HOST-OR-URL. +When run interactively HOST-OR-URL is read from the minibuffer." + (interactive "sGopher or Gemini URL: ") + (let ((page (elpher-make-page host-or-url + (elpher-address-from-url host-or-url)))) (switch-to-buffer "*elpher*") - (elpher-visit-node node))) + (elpher-visit-page page) + '())) (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))) + (let ((address (elpher-page-address elpher-current-page))) (if (elpher-address-special-p address) (error "Command invalid for this page") (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))))))) + (elpher-visit-page (elpher-make-page url (elpher-address-from-url url))))))) (defun elpher-redraw () "Redraw current page." (interactive) - (if elpher-current-node - (elpher-visit-node elpher-current-node) - (message "No current site."))) + (elpher-visit-page elpher-current-page)) (defun elpher-reload () "Reload current page." (interactive) - (if elpher-current-node - (elpher-reload-current-node) - (message "No current site."))) + (elpher-reload-current-page)) (defun elpher-toggle-tls () "Toggle TLS encryption mode for gopher." @@ -1293,48 +1294,43 @@ If ADDRESS is already bookmarked, update the label only." (defun elpher-view-raw () "View raw server response for current page." (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") - (elpher-visit-node elpher-current-node - #'elpher-render-raw)) - (message "No current site."))) + (if (elpher-address-special-p (elpher-page-address elpher-current-page)) + (error "This page was not generated by a server") + (elpher-visit-page elpher-current-page + #'elpher-render-raw))) (defun elpher-back () "Go to previous site." (interactive) - (if (elpher-node-parent elpher-current-node) - (elpher-visit-parent-node) - (error "No previous site"))) + (elpher-visit-previous-page)) (defun elpher-download () "Download the link at point." (interactive) (let ((button (button-at (point)))) (if button - (let ((node (button-get button 'elpher-node))) - (if (elpher-address-special-p (elpher-node-address node)) + (let ((page (button-get button 'elpher-page))) + (if (elpher-address-special-p (elpher-page-address page)) (error "Cannot download %s" - (elpher-node-display-string node)) - (elpher-visit-node (button-get button 'elpher-node) + (elpher-page-display-string page)) + (elpher-visit-page (button-get button 'elpher-page) #'elpher-render-download))) (error "No link selected")))) (defun elpher-download-current () "Download the current page." (interactive) - (if (elpher-address-special-p (elpher-node-address elpher-current-node)) + (if (elpher-address-special-p (elpher-page-address elpher-current-page)) (error "Cannot download %s" - (elpher-node-display-string elpher-current-node)) - (elpher-visit-node (elpher-make-node - (elpher-node-display-string elpher-current-node) - (elpher-node-address elpher-current-node) - elpher-current-node) + (elpher-page-display-string elpher-current-page)) + (elpher-visit-page (elpher-make-page + (elpher-page-display-string elpher-current-page) + (elpher-page-address elpher-current-page)) #'elpher-render-download t))) (defun elpher-build-link-map () - "Build alist mapping link names to destination nodes in current buffer." + "Build alist mapping link names to destination pages in current buffer." (let ((link-map nil) (b (next-button (point-min) t))) (while b @@ -1358,7 +1354,7 @@ If ADDRESS is already bookmarked, update the label only." (defun elpher-root-dir () "Visit root of current server." (interactive) - (let ((address (elpher-node-address elpher-current-node))) + (let ((address (elpher-page-address elpher-current-page))) (if (not (elpher-address-special-p address)) (if (or (member (url-filename address) '("/" "")) (and (elpher-address-gopher-p address) @@ -1367,26 +1363,26 @@ If ADDRESS is already bookmarked, update the label only." (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) + (elpher-visit-page + (elpher-make-page (elpher-address-to-url address-copy) address-copy)))) - (error "Command invalid for %s" (elpher-node-display-string elpher-current-node))))) + (error "Command invalid for %s" (elpher-page-display-string elpher-current-page))))) (defun elpher-bookmarks-current-p () - "Return non-nil if current node is a bookmarks page." - (equal (elpher-address-type (elpher-node-address elpher-current-node)) + "Return non-nil if current page is a bookmarks page." + (equal (elpher-address-type (elpher-page-address elpher-current-page)) '(special bookmarks))) (defun elpher-reload-bookmarks () - "Reload bookmarks if current node is a bookmarks page." + "Reload bookmarks if current page is a bookmarks page." (if (elpher-bookmarks-current-p) - (elpher-reload-current-node))) + (elpher-reload-current-page))) (defun elpher-bookmark-current () - "Bookmark the current node." + "Bookmark the current page." (interactive) - (let ((address (elpher-node-address elpher-current-node)) - (display-string (elpher-node-display-string elpher-current-node))) + (let ((address (elpher-page-address elpher-current-page)) + (display-string (elpher-page-display-string elpher-current-page))) (if (not (elpher-address-special-p address)) (let ((bookmark-display-string (read-string "Bookmark display string: " display-string))) @@ -1399,9 +1395,9 @@ If ADDRESS is already bookmarked, update the label only." (interactive) (let ((button (button-at (point)))) (if button - (let* ((node (button-get button 'elpher-node)) - (address (elpher-node-address node)) - (display-string (elpher-node-display-string node))) + (let* ((page (button-get button 'elpher-page)) + (address (elpher-page-address page)) + (display-string (elpher-page-display-string page))) (if (not (elpher-address-special-p address)) (let ((bookmark-display-string (read-string "Bookmark display string: " display-string))) @@ -1412,9 +1408,9 @@ If ADDRESS is already bookmarked, update the label only." (error "No link selected")))) (defun elpher-unbookmark-current () - "Remove bookmark for the current node." + "Remove bookmark for the current page." (interactive) - (let ((address (elpher-node-address elpher-current-node))) + (let ((address (elpher-page-address elpher-current-page))) (unless (elpher-address-special-p address) (elpher-remove-address-bookmark address) (message "Bookmark removed.")))) @@ -1424,8 +1420,8 @@ If ADDRESS is already bookmarked, update the label only." (interactive) (let ((button (button-at (point)))) (if button - (let ((node (button-get button 'elpher-node))) - (elpher-remove-address-bookmark (elpher-node-address node)) + (let ((page (button-get button 'elpher-page))) + (elpher-remove-address-bookmark (elpher-page-address page)) (elpher-reload-bookmarks) (message "Bookmark removed.")) (error "No link selected")))) @@ -1434,35 +1430,35 @@ If ADDRESS is already bookmarked, update the label only." "Visit bookmarks page." (interactive) (switch-to-buffer "*elpher*") - (elpher-visit-node - (elpher-make-node "Bookmarks Page" (elpher-make-special-address 'bookmarks)))) + (elpher-visit-page + (elpher-make-page "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))) +(defun elpher-info-page (page) + "Display information on PAGE." + (let ((display-string (elpher-page-display-string page)) + (address (elpher-page-address page))) (if (elpher-address-special-p address) (message "Special page: %s" display-string) (message "%s" (elpher-address-to-url address))))) (defun elpher-info-link () - "Display information on node corresponding to link at point." + "Display information on page corresponding to link at point." (interactive) (let ((button (button-at (point)))) (if button - (elpher-info-node (button-get button 'elpher-node)) + (elpher-info-page (button-get button 'elpher-page)) (error "No item selected")))) (defun elpher-info-current () - "Display information on current node." + "Display information on current page." (interactive) - (elpher-info-node elpher-current-node)) + (elpher-info-page elpher-current-page)) -(defun elpher-copy-node-url (node) - "Copy URL representation of address of NODE to `kill-ring'." - (let ((address (elpher-node-address node))) +(defun elpher-copy-page-url (page) + "Copy URL representation of address of PAGE to `kill-ring'." + (let ((address (elpher-page-address page))) (if (elpher-address-special-p address) - (error (format "Cannot represent %s as URL" (elpher-node-display-string node))) + (error (format "Cannot represent %s as URL" (elpher-page-display-string page))) (let ((url (elpher-address-to-url address))) (message "Copied \"%s\" to kill-ring/clipboard." url) (kill-new url))))) @@ -1472,13 +1468,13 @@ If ADDRESS is already bookmarked, update the label only." (interactive) (let ((button (button-at (point)))) (if button - (elpher-copy-node-url (button-get button 'elpher-node)) + (elpher-copy-page-url (button-get button 'elpher-page)) (error "No item selected")))) (defun elpher-copy-current-url () - "Copy URL of current node to `kill-ring'." + "Copy URL of current page to `kill-ring'." (interactive) - (elpher-copy-node-url elpher-current-node)) + (elpher-copy-page-url elpher-current-page)) (defun elpher-set-gopher-coding-system () "Specify an explicit character coding system for gopher selectors." @@ -1569,10 +1565,10 @@ functions which initialize the gopher client, namely (if (get-buffer "*elpher*") (switch-to-buffer "*elpher*") (switch-to-buffer "*elpher*") - (setq elpher-current-node nil) - (let ((start-node (elpher-make-node "Elpher Start Page" + (setq elpher-current-page nil) + (let ((start-page (elpher-make-page "Elpher Start Page" (elpher-make-special-address 'start)))) - (elpher-visit-node start-node))) + (elpher-visit-page start-page))) "Started Elpher.") ; Otherwise (elpher) evaluates to start page string. ;;; elpher.el ends here