X-Git-Url: https://thelambdalab.xyz/gitweb/index.cgi?a=blobdiff_plain;f=elopher.el;h=7e45cab27db2489b328b6702ec4959bd5be379d9;hb=12320978c9fab9ad8c46e3c92d39547c30ceef69;hp=dfb5c776b6f0f556d1ff4962f9ab936e5d10db03;hpb=20fb5d3a386e6546ed881d5005a6acb77521388d;p=elpher.git diff --git a/elopher.el b/elopher.el index dfb5c77..7e45cab 100644 --- a/elopher.el +++ b/elopher.el @@ -1,8 +1,8 @@ -;;; elopher.el --- gopher client +;;; elopher.el --- elisp gopher client ;;; Commentary: -;; Simple gopher client in elisp. +;; An elisp gopher client. ;;; Code: @@ -30,7 +30,8 @@ "i - RET/mouse-1: open directory entry under cursor\tfake\tfake\t1" "i - u: return to parent directory entry\tfake\tfake\t1" "i - g: go to a particular page\tfake\tfake\t1" - "i - r: reload current 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 - d: download directory entry under cursor\tfake\tfake\t1" "i - w: display the raw server response for the current page\tfake\tfake\t1" "i\tfake\tfake\t1" @@ -43,47 +44,60 @@ "i\tfake\tfake\t1" "7Veronica-2 Gopher Search Engine\t/v2/vs\tgopher.floodgap.com\t70" ".") - "\r\n")) + "\r\n") + "Source for elopher start page.") ;;; Customization group ;; (defgroup elopher nil - "A simple gopher client." + "A gopher client." :group 'applications) -(defcustom elopher-index-face '(foreground-color . "cyan") - "Face used for index records." - :type '(face)) +(defface elopher-index + '((((background dark)) :foreground "deep sky blue") + (((background light)) :foreground "blue")) + "Face used for index records.") -(defcustom elopher-text-face '(foreground-color . "white") - "Face used for text records." - :type '(face)) +(defface elopher-text + '((((background dark)) :foreground "white") + (((background light)) :weight bold)) + "Face used for text records.") -(defcustom elopher-info-face '(foreground-color . "gray") - "Face used for info records." - :type '(face)) +(defface elopher-info '() + "Face used for info records.") -(defcustom elopher-image-face '(foreground-color . "green") - "Face used for image records." - :type '(face)) +(defface elopher-image + '((((background dark)) :foreground "green") + (t :foreground "dark green")) + "Face used for image records.") -(defcustom elopher-search-face '(foreground-color . "orange") - "Face used for image records." - :type '(face)) +(defface elopher-search + '((((background light)) :foreground "orange") + (((background dark)) :foreground "dark orange")) + "Face used for search records.") -(defcustom elopher-http-face '(foreground-color . "yellow") - "Face used for image records." - :type '(face)) +(defface elopher-url + '((((background dark)) :foreground "yellow") + (((background light)) :foreground "dark red")) + "Face used for url records.") -(defcustom elopher-binary-face '(foreground-color . "magenta") - "Face used for image records." - :type '(face)) +(defface elopher-binary + '((t :foreground "magenta")) + "Face used for binary records.") -(defcustom elopher-unknown-face '(foreground-color . "red") - "Face used for unknown record types." - :type '(face)) +(defface elopher-unknown + '((t :foreground "red")) + "Face used for unknown record types.") + +(defface elopher-margin-key + '((((background dark)) :foreground "white")) + "Face used for margin key.") + +(defface elopher-margin-brackets + '((t :foreground "blue")) + "Face used for brackets around margin key.") (defcustom elopher-open-urls-with-eww nil "If non-nil, open URL selectors using eww. @@ -96,58 +110,68 @@ Otherwise, use the system browser via the BROWSE-URL function." ;; Address (defun elopher-make-address (selector host port) + "Create an address of a gopher object with SELECTOR, HOST and PORT." (list selector host port)) (defun elopher-address-selector (address) + "Retrieve selector from ADDRESS." (car address)) (defun elopher-address-host (address) + "Retrieve host from ADDRESS." (cadr address)) (defun elopher-address-port (address) + "Retrieve port from ADDRESS." (caddr address)) ;; Node (defun elopher-make-node (parent address getter &optional content pos) + "Create a node in the gopher page hierarchy. + +PARENT specifies the parent of the node, ADDRESS specifies the address of +the gopher page, GETTER provides the getter function used to obtain this +page. + +The optional arguments CONTENT and POS can be used to fill the cached +content and cursor position fields of the node." (list parent address getter content pos)) (defun elopher-node-parent (node) + "Retrieve the parent node of NODE." (elt node 0)) (defun elopher-node-address (node) + "Retrieve the address of NODE." (elt node 1)) (defun elopher-node-getter (node) + "Retrieve the preferred getter function of NODE." (elt node 2)) (defun elopher-node-content (node) + "Retrieve the cached content of NODE, or nil if none exists." (elt node 3)) (defun elopher-node-pos (node) + "Retrieve the cached cursor position for NODE, or nil if none exists." (elt node 4)) (defun elopher-set-node-content (node content) + "Set the content cache of NODE to CONTENT." (setcar (nthcdr 3 node) content)) (defun elopher-set-node-pos (node pos) + "Set the cursor position cache of NODE to POS." (setcar (nthcdr 4 node) pos)) -(defun elopher-save-pos () - (when elopher-current-node - (elopher-set-node-pos elopher-current-node (point)))) - -(defun elopher-restore-pos () - (let ((pos (elopher-node-pos elopher-current-node))) - (if pos - (goto-char pos) - (goto-char (point-min))))) - ;; Node graph traversal (defvar elopher-current-node) (defun elopher-visit-node (node &optional getter) + "Visit NODE using its own getter or GETTER, if non-nil." (elopher-save-pos) (elopher-process-cleanup) (setq elopher-current-node node) @@ -156,14 +180,28 @@ Otherwise, use the system browser via the BROWSE-URL function." (funcall (elopher-node-getter node)))) (defun elopher-visit-parent-node () + "Visit the parent of the current node." (let ((parent-node (elopher-node-parent elopher-current-node))) (when parent-node (elopher-visit-node parent-node)))) (defun elopher-reload-current-node () + "Reload the current node, discarding any existing cached content." (elopher-set-node-content elopher-current-node nil) (elopher-visit-node elopher-current-node)) +(defun elopher-save-pos () + "Save the current position of point to the current node." + (when elopher-current-node + (elopher-set-node-pos elopher-current-node (point)))) + +(defun elopher-restore-pos () + "Restore the position of point to that cached in the current node." + (let ((pos (elopher-node-pos elopher-current-node))) + (if pos + (goto-char pos) + (goto-char (point-min))))) + ;;; Buffer preparation ;; @@ -191,12 +229,24 @@ Otherwise, use the system browser via the BROWSE-URL function." (progn (insert (format (concat "%" (number-to-string (- elopher-margin-width 1)) "s") (concat - (propertize "[" 'face '(foreground-color . "blue")) - (propertize type-name 'face '(foreground-color . "white")) - (propertize "]" 'face '(foreground-color . "blue"))))) + (propertize "[" 'face 'elopher-margin-brackets) + (propertize type-name 'face 'elopher-margin-key) + (propertize "]" 'face 'elopher-margin-brackets)))) (insert " ")) (insert (make-string elopher-margin-width ?\s)))) +(defvar elopher-type-map + '((?0 elopher-get-text-node "T" elopher-text) + (?1 elopher-get-index-node "/" elopher-index) + (?g elopher-get-image-node "im" elopher-image) + (?p elopher-get-image-node "im" elopher-image) + (?I elopher-get-image-node "im" elopher-image) + (?4 elopher-get-node-download "B" elopher-binary) + (?5 elopher-get-node-download "B" elopher-binary) + (?9 elopher-get-node-download "B" elopher-binary) + (?7 elopher-get-search-node "?" elopher-search)) + "Association list from types to getters, margin codes and index faces.") + (defun elopher-insert-index-record (line) "Insert the index record corresponding to LINE into the current buffer." (let* ((type (elt line 0)) @@ -206,69 +256,37 @@ Otherwise, use the system browser via the BROWSE-URL function." (host (elt fields 2)) (port (elt fields 3)) (address (elopher-make-address selector host port)) - (help-string (format "mouse-1, RET: open %s on %s port %s" - selector host port))) - (pcase type - (?i (elopher-insert-margin) ; Information - (insert (propertize display-string - 'face elopher-info-face))) - (?0 (elopher-insert-margin "T") ; Text - (insert-text-button display-string - 'face elopher-text-face - 'elopher-node (elopher-make-node elopher-current-node - address - #'elopher-get-text-node) - 'action #'elopher-click-link - 'follow-link t - 'help-echo help-string)) - (?1 (elopher-insert-margin "/") ; Index - (insert-text-button display-string - 'face elopher-index-face - 'elopher-node (elopher-make-node elopher-current-node - address - #'elopher-get-index-node) - 'action #'elopher-click-link - 'follow-link t - 'help-echo help-string)) - ((or ?g ?p ?I) (elopher-insert-margin "im") ; Image - (insert-text-button display-string - 'face elopher-image-face - 'elopher-node (elopher-make-node elopher-current-node - address - #'elopher-get-image-node) - 'action #'elopher-click-link - 'follow-link t - 'help-echo help-string)) - ((or ?4 ?9) (elopher-insert-margin "B") ; Binary - (insert-text-button display-string - 'face elopher-binary-face - 'elopher-node (elopher-make-node elopher-current-node - address - #'elopher-get-node-download) - 'action #'elopher-click-link - 'follow-link t - 'help-echo help-string)) - (?7 (elopher-insert-margin "S") + (type-map-entry (alist-get type elopher-type-map))) + (if type-map-entry + (let ((getter (car type-map-entry)) + (margin-code (cadr type-map-entry)) + (face (caddr type-map-entry))) + (elopher-insert-margin margin-code) (insert-text-button display-string - 'face elopher-search-face + 'face face 'elopher-node (elopher-make-node elopher-current-node address - #'elopher-get-search-node) + getter) 'action #'elopher-click-link 'follow-link t - 'help-echo help-string)) - (?h (elopher-insert-margin "W") - (let ((url (elt (split-string selector "URL:") 1))) - (insert-text-button display-string - 'face elopher-http-face - 'elopher-url url - 'action #'elopher-click-url - 'follow-link t - 'help-echo (format "mouse-1, RET: open url %s" url)))) - (?.) ; Occurs at end of index, can safely ignore. - (tp (elopher-insert-margin (concat (char-to-string tp) "?")) - (insert (propertize display-string - 'face elopher-unknown-face)))) + 'help-echo (format "mouse-1, RET: open %s on %s port %s" + selector host port))) + (pcase type + (?i (elopher-insert-margin) ; Information + (insert (propertize display-string + 'face 'elopher-info))) + (?h (elopher-insert-margin "W") ; Web link + (let ((url (elt (split-string selector "URL:") 1))) + (insert-text-button display-string + 'face 'elopher-url + 'elopher-url url + 'action #'elopher-click-url + 'follow-link t + 'help-echo (format "mouse-1, RET: open url %s" url)))) + (?.) ; Occurs at end of index, can safely ignore. + (tp (elopher-insert-margin (concat (char-to-string tp) "?")) + (insert (propertize display-string + 'face 'elopher-unknown-face))))) (insert "\n"))) @@ -299,6 +317,7 @@ The result is stored as a string in the variable elopher-selector-string." ;; Index retrieval (defun elopher-get-index-node () + "Getter which retrieves the current node contents as an index." (let ((content (elopher-node-content elopher-current-node)) (address (elopher-node-address elopher-current-node))) (if content @@ -327,11 +346,55 @@ The result is stored as a string in the variable elopher-selector-string." ;; Text retrieval +(defconst elopher-url-regex + "\\(https?\\|gopher\\)://\\([a-zA-Z0-9.\-]+\\)\\(?3::[0-9]+\\)?\\(?4:/[^ \r\n\t(),]*\\)?" + "Regexp used to locate and buttinofy URLs in text files loaded by elopher.") + +(defun elopher-buttonify-urls (string) + "Turn substrings which look like urls in STRING into clickable buttons." + (with-temp-buffer + (insert string) + (goto-char (point-min)) + (while (re-search-forward elopher-url-regex nil t) + (let ((url (match-string 0)) + (protocol (downcase (match-string 1)))) + (if (string= protocol "gopher") + (let* ((host (match-string 2)) + (port 70) + (type-and-selector (match-string 4)) + (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 (elopher-make-address selector host port)) + (getter (car (alist-get type elopher-type-map)))) + (make-text-button (match-beginning 0) + (match-end 0) + 'elopher-node (elopher-make-node elopher-current-node + address + getter) + 'action #'elopher-click-link + 'follow-link t + 'help-echo (format "mouse-1, RET: open %s on %s port %s" + selector host port))) + (make-text-button (match-beginning 0) + (match-end 0) + 'elopher-url url + 'action #'elopher-click-url + 'follow-link t + 'help-echo (format "mouse-1, RET: open url %s" url))))) + (buffer-string))) + (defun elopher-process-text (string) - (let ((chopped-str (replace-regexp-in-string "\r\n\.\r\n$" "\r\n" string))) - (replace-regexp-in-string "\r" "" chopped-str))) + "Remove CRs and trailing period from the gopher text document STRING." + (let* ((chopped-str (replace-regexp-in-string "\r\n\.\r\n$" "\r\n" string)) + (cleaned-str (replace-regexp-in-string "\r" "" chopped-str))) + (elopher-buttonify-urls cleaned-str))) (defun elopher-get-text-node () + "Getter which retrieves the current node contents as a text document." (let ((content (elopher-node-content elopher-current-node)) (address (elopher-node-address elopher-current-node))) (if content @@ -354,6 +417,7 @@ The result is stored as a string in the variable elopher-selector-string." ;; Image retrieval (defun elopher-get-image-node () + "Getter which retrieves the current node contents as an image to view." (let ((content (elopher-node-content elopher-current-node)) (address (elopher-node-address elopher-current-node))) (if content @@ -369,7 +433,8 @@ The result is stored as a string in the variable elopher-selector-string." (lambda (proc event) (unless (string-prefix-p "deleted" event) (let ((image (create-image - (string-as-unibyte elopher-selector-string) + (encode-coding-string elopher-selector-string + 'no-conversion) nil t))) (elopher-with-clean-buffer (insert-image image)) @@ -381,33 +446,40 @@ The result is stored as a string in the variable elopher-selector-string." ;; Search retrieval (defun elopher-get-search-node () - (let* ((content (elopher-node-content elopher-current-node)) - (address (elopher-node-address elopher-current-node))) + "Getter which submits a search query to the address of the current node." + (let ((content (elopher-node-content elopher-current-node)) + (address (elopher-node-address elopher-current-node)) + (aborted t)) (if content (progn (elopher-with-clean-buffer - (insert content)) + (insert content)) (elopher-restore-pos) (message "Displaying cached search results. Reload to perform a new search.")) - (let* ((query-string (read-string "Query: ")) - (query-selector (concat (elopher-address-selector address) "\t" query-string)) - (search-address (elopher-make-address query-selector - (elopher-address-host address) - (elopher-address-port address)))) - (elopher-with-clean-buffer - (insert "LOADING RESULTS...")) - (elopher-get-selector search-address - (lambda (proc event) - (unless (string-prefix-p "deleted" event) - (elopher-with-clean-buffer - (elopher-insert-index elopher-selector-string)) - (goto-char (point-min)) - (elopher-set-node-content elopher-current-node - (buffer-string))))))))) + (unwind-protect + (let* ((query-string (read-string "Query: ")) + (query-selector (concat (elopher-address-selector address) "\t" query-string)) + (search-address (elopher-make-address query-selector + (elopher-address-host address) + (elopher-address-port address)))) + (setq aborted nil) + (elopher-with-clean-buffer + (insert "LOADING RESULTS...")) + (elopher-get-selector search-address + (lambda (proc event) + (unless (string-prefix-p "deleted" event) + (elopher-with-clean-buffer + (elopher-insert-index elopher-selector-string)) + (goto-char (point-min)) + (elopher-set-node-content elopher-current-node + (buffer-string)))))) + (if aborted + (elopher-visit-parent-node)))))) ;; Raw server response retrieval (defun elopher-get-node-raw () + "Getter which retrieves the raw server response for the current node." (let* ((content (elopher-node-content elopher-current-node)) (address (elopher-node-address elopher-current-node))) (elopher-with-clean-buffer @@ -423,57 +495,61 @@ The result is stored as a string in the variable elopher-selector-string." (elopher-with-clean-buffer (insert elopher-start-index)) (goto-char (point-min))))) - (message "Displaying raw server response. Reload to return to standard view.")) + (message "Displaying raw server response. Reload or redraw to return to standard view.")) - ;; File export retrieval (defvar elopher-download-filename) (defun elopher-get-node-download () + "Getter which retrieves the current node and writes the result to a file." (let* ((address (elopher-node-address elopher-current-node)) (selector (elopher-address-selector address))) - (unwind-protect - (let* ((filename-proposal (file-name-nondirectory selector)) - (filename (read-file-name "Save file as: " - nil nil nil - (if (> (length filename-proposal) 0) - filename-proposal - "gopher.file")))) - (message "Downloading...") - (setq elopher-download-filename filename) - (elopher-get-selector address - (lambda (proc event) - (let ((coding-system-for-write 'binary)) - (with-temp-file elopher-download-filename - (insert elopher-selector-string))) + (elopher-visit-parent-node) ; Do first in case of non-local exits. + (let* ((filename-proposal (file-name-nondirectory selector)) + (filename (read-file-name "Save file as: " + nil nil nil + (if (> (length filename-proposal) 0) + filename-proposal + "gopher.file")))) + (message "Downloading...") + (setq elopher-download-filename filename) + (elopher-get-selector address + (lambda (proc event) + (let ((coding-system-for-write 'binary)) + (with-temp-file elopher-download-filename + (insert elopher-selector-string) (message (format "Download complate, saved to file %s." - elopher-download-filename))))) - (elopher-visit-parent-node)))) - + elopher-download-filename))))))))) + ;;; Navigation procedures ;; (defun elopher-next-link () + "Move point to the next link on the current page." (interactive) (forward-button 1)) (defun elopher-prev-link () + "Move point to the previous link on the current page." (interactive) (backward-button 1)) (defun elopher-click-link (button) + "Function called when the gopher link BUTTON is activated (via mouse or keypress)." (let ((node (button-get button 'elopher-node))) (elopher-visit-node node))) (defun elopher-click-url (button) + "Function called when the url link BUTTON is activated (via mouse or keypress)." (let ((url (button-get button 'elopher-url))) (if elopher-open-urls-with-eww (browse-web url) (browse-url url)))) -(defun elopher-follow-closest-link () +(defun elopher-follow-current-link () + "Open the link or url at point." (interactive) (push-button)) @@ -490,6 +566,11 @@ The result is stored as a string in the variable elopher-selector-string." address #'elopher-get-index-node)))) +(defun elopher-redraw () + "Redraw current page." + (interactive) + (elopher-visit-node elopher-current-node)) + (defun elopher-reload () "Reload current page." (interactive) @@ -513,30 +594,35 @@ The result is stored as a string in the variable elopher-selector-string." (interactive) (let ((button (button-at (point)))) (if button - (elopher-visit-node (button-get button 'elopher-node) - #'elopher-get-node-download) + (let ((node (button-get button 'elopher-node))) + (if node + (elopher-visit-node (button-get button 'elopher-node) + #'elopher-get-node-download) + (message "Can only download gopher links, not general URLs."))) (message "No link selected.")))) - ;;; Mode and keymap ;; (defvar elopher-mode-map (let ((map (make-sparse-keymap))) - (define-key map (kbd "") 'elopher-next-link) - (define-key map (kbd "") 'elopher-prev-link) + (define-key map (kbd "TAB") 'elopher-next-link) + (define-key map (kbd "") 'elopher-prev-link) (define-key map (kbd "u") 'elopher-back) (define-key map (kbd "g") 'elopher-go) - (define-key map (kbd "r") 'elopher-reload) + (define-key map (kbd "r") 'elopher-redraw) + (define-key map (kbd "R") 'elopher-reload) (define-key map (kbd "w") 'elopher-view-raw) (define-key map (kbd "d") 'elopher-download) (when (fboundp 'evil-define-key) (evil-define-key 'normal map - (kbd "C-]") 'elopher-follow-closest-link + (kbd "TAB") 'elopher-next-link + (kbd "C-]") 'elopher-follow-current-link (kbd "C-t") 'elopher-back (kbd "u") 'elopher-back (kbd "g") 'elopher-go - (kbd "r") 'elopher-reload + (kbd "r") 'elopher-redraw + (kbd "R") 'elopher-reload (kbd "w") 'elopher-view-raw (kbd "d") 'elopher-download)) map) @@ -549,6 +635,7 @@ The result is stored as a string in the variable elopher-selector-string." ;;; Main start procedure ;; +;;;###autoload (defun elopher () "Start elopher with default landing page." (interactive) @@ -558,4 +645,3 @@ The result is stored as a string in the variable elopher-selector-string." "Started Elopher.") ; Otherwise (elopher) evaluates to start page string. ;;; elopher.el ends here -