X-Git-Url: https://thelambdalab.xyz/gitweb/index.cgi?a=blobdiff_plain;f=elopher.el;h=dfb5c776b6f0f556d1ff4962f9ab936e5d10db03;hb=20fb5d3a386e6546ed881d5005a6acb77521388d;hp=5725a4f0026461446dc7e1f49bd8973c57708940;hpb=dcb12577755c5831ed369d0e7a7f3ad350e4ca3e;p=elpher.git diff --git a/elopher.el b/elopher.el index 5725a4f..dfb5c77 100644 --- a/elopher.el +++ b/elopher.el @@ -15,8 +15,9 @@ (defconst elopher-margin-width 6 "Width of left-hand margin used when rendering indicies.") -(defconst elopher-start-page - (string-join +(defconst elopher-start-index + (mapconcat + 'identity (list "i\tfake\tfake\t1" "i--------------------------------------------\tfake\tfake\t1" "i Elopher Gopher Client \tfake\tfake\t1" @@ -24,18 +25,23 @@ "i--------------------------------------------\tfake\tfake\t1" "i\tfake\tfake\t1" "iBasic usage:\tfake\tfake\t1" - "i - tab/shift-tab: next/prev directory entry\tfake\tfake\t1" - "i - RET/mouse-1: open directory entry\tfake\tfake\t1" + "i\tfake\tfake\t1" + "i - tab/shift-tab: next/prev directory entry on current page\tfake\tfake\t1" + "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 site\tfake\tfake\t1" + "i - g: go to a particular page\tfake\tfake\t1" + "i - r: reload current page\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" "iPlaces to start exploring Gopherspace:\tfake\tfake\t1" + "i\tfake\tfake\t1" "1Floodgap Systems Gopher Server\t\tgopher.floodgap.com\t70" - "1Super-Dimensional Fortress\t\tsdf.org\t70" "i\tfake\tfake\t1" - "iTest entries:\tfake\tfake\t1" - "pXKCD comic image\t/fun/xkcd/comics/2130/2137/text_entry.png\tgopher.floodgap.com\t70" - "1Test server\t\tlocalhost\t70" + "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")) @@ -48,15 +54,41 @@ :group 'applications) (defcustom elopher-index-face '(foreground-color . "cyan") - "Face used for index records.") + "Face used for index records." + :type '(face)) + (defcustom elopher-text-face '(foreground-color . "white") - "Face used for text records.") + "Face used for text records." + :type '(face)) + (defcustom elopher-info-face '(foreground-color . "gray") - "Face used for info records.") + "Face used for info records." + :type '(face)) + (defcustom elopher-image-face '(foreground-color . "green") - "Face used for image records.") + "Face used for image records." + :type '(face)) + +(defcustom elopher-search-face '(foreground-color . "orange") + "Face used for image records." + :type '(face)) + +(defcustom elopher-http-face '(foreground-color . "yellow") + "Face used for image records." + :type '(face)) + +(defcustom elopher-binary-face '(foreground-color . "magenta") + "Face used for image records." + :type '(face)) + (defcustom elopher-unknown-face '(foreground-color . "red") - "Face used for unknown record types.") + "Face used for unknown record types." + :type '(face)) + +(defcustom elopher-open-urls-with-eww nil + "If non-nil, open URL selectors using eww. +Otherwise, use the system browser via the BROWSE-URL function." + :type '(boolean)) ;;; Model ;; @@ -77,63 +109,84 @@ ;; Node -(defun elopher-make-node (parent address getter &optional content) - (list parent address getter content)) +(defun elopher-make-node (parent address getter &optional content pos) + (list parent address getter content pos)) (defun elopher-node-parent (node) - (car node)) + (elt node 0)) (defun elopher-node-address (node) - (cadr node)) + (elt node 1)) (defun elopher-node-getter (node) - (caddr node)) + (elt node 2)) (defun elopher-node-content (node) - (cadddr node)) + (elt node 3)) + +(defun elopher-node-pos (node) + (elt node 4)) (defun elopher-set-node-content (node content) - (setcar (cdddr node) content)) + (setcar (nthcdr 3 node) content)) + +(defun elopher-set-node-pos (node 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-start-node (elopher-make-node nil nil #'elopher-get-index-node)) (defvar elopher-current-node) -(defun elopher-visit-node (node) - (elopher-prepare-buffer) +(defun elopher-visit-node (node &optional getter) + (elopher-save-pos) + (elopher-process-cleanup) (setq elopher-current-node node) - (funcall (elopher-node-getter node))) + (if getter + (funcall getter) + (funcall (elopher-node-getter node)))) (defun elopher-visit-parent-node () (let ((parent-node (elopher-node-parent elopher-current-node))) (when parent-node - (setq elopher-current-node parent-node) - (elopher-visit-node elopher-current-node)))) + (elopher-visit-node parent-node)))) (defun elopher-reload-current-node () (elopher-set-node-content elopher-current-node nil) (elopher-visit-node elopher-current-node)) - ;;; Buffer preparation ;; -(defun elopher-prepare-buffer () - (switch-to-buffer "*elopher*") - (elopher-mode) - (let ((inhibit-read-only t)) - (erase-buffer))) - +(defmacro elopher-with-clean-buffer (&rest args) + "Evaluate ARGS with a clean *elopher* buffer as current." + (list 'progn + '(switch-to-buffer "*elopher*") + '(elopher-mode) + (append (list 'let '((inhibit-read-only t)) + '(erase-buffer)) + args))) ;;; Index rendering ;; (defun elopher-insert-index (string) - "Inserts the index corresponding to STRING into the current buffer." + "Insert the index corresponding to STRING into the current buffer." (dolist (line (split-string string "\r\n")) - (unless (string-empty-p line) + (unless (= (length line) 0) (elopher-insert-index-record line)))) (defun elopher-insert-margin (&optional type-name) + "Insert index margin, optionally containing the TYPE-NAME, into the current buffer." (if type-name (progn (insert (format (concat "%" (number-to-string (- elopher-margin-width 1)) "s") @@ -145,31 +198,73 @@ (insert (make-string elopher-margin-width ?\s)))) (defun elopher-insert-index-record (line) - "Inserts the index record corresponding to LINE into the current buffer." + "Insert the index record corresponding to LINE into the current buffer." (let* ((type (elt line 0)) (fields (split-string (substring line 1) "\t")) (display-string (elt fields 0)) - (address (elopher-make-address (elt fields 1) (elt fields 2) (elt fields 3)))) + (selector (elt fields 1)) + (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) + (?i (elopher-insert-margin) ; Information (insert (propertize display-string 'face elopher-info-face))) - (?0 (elopher-insert-margin "T") + (?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)) - (?1 (elopher-insert-margin "/") + '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)) + '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") + (insert-text-button display-string + 'face elopher-search-face + 'elopher-node (elopher-make-node elopher-current-node + address + #'elopher-get-search-node) + '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 @@ -180,12 +275,17 @@ ;;; Selector retrieval (all kinds) ;; +(defun elopher-process-cleanup () + "Immediately shut down any extant elopher process." + (let ((p (get-process "elopher-process"))) + (if p (delete-process p)))) + (defvar elopher-selector-string) (defun elopher-get-selector (address after) + "Retrieve selector specified by ADDRESS, then execute AFTER. +The result is stored as a string in the variable elopher-selector-string." (setq elopher-selector-string "") - (let ((p (get-process "elopher-process"))) - (if p (delete-process p))) (make-network-process :name "elopher-process" :host (elopher-address-host address) @@ -202,36 +302,157 @@ (let ((content (elopher-node-content elopher-current-node)) (address (elopher-node-address elopher-current-node))) (if content - (insert content) + (progn + (elopher-with-clean-buffer + (insert content)) + (elopher-restore-pos)) (if address - (elopher-get-selector address - (lambda (proc event) - (let ((inhibit-read-only t)) - (erase-buffer) - (elopher-insert-index elopher-selector-string)) - (elopher-set-node-content elopher-current-node - (buffer-string)))) - (let ((inhibit-read-only t)) - (erase-buffer) - (elopher-insert-index elopher-start-page)))))) + (progn + (elopher-with-clean-buffer + (insert "LOADING DIRECTORY...")) + (elopher-get-selector address + (lambda (proc event) + (unless (string-prefix-p "deleted" event) + (elopher-with-clean-buffer + (elopher-insert-index elopher-selector-string)) + (elopher-restore-pos) + (elopher-set-node-content elopher-current-node + (buffer-string)))))) + (progn + (elopher-with-clean-buffer + (elopher-insert-index elopher-start-index)) + (elopher-restore-pos) + (elopher-set-node-content elopher-current-node + (buffer-string))))))) ;; Text retrieval +(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))) + (defun elopher-get-text-node () (let ((content (elopher-node-content elopher-current-node)) (address (elopher-node-address elopher-current-node))) (if content - (let ((inhibit-read-only t)) - (insert content)) - (elopher-get-selector address - (lambda (proc event) - (let ((inhibit-read-only t)) - (erase-buffer) - (insert elopher-selector-string)) - (elopher-set-node-content elopher-current-node - elopher-selector-string)))))) - -;;; Navigation methods + (progn + (elopher-with-clean-buffer + (insert content)) + (elopher-restore-pos)) + (progn + (elopher-with-clean-buffer + (insert "LOADING TEXT...")) + (elopher-get-selector address + (lambda (proc event) + (unless (string-prefix-p "deleted" event) + (elopher-with-clean-buffer + (insert (elopher-process-text elopher-selector-string))) + (elopher-restore-pos) + (elopher-set-node-content elopher-current-node + (buffer-string))))))))) + +;; Image retrieval + +(defun elopher-get-image-node () + (let ((content (elopher-node-content elopher-current-node)) + (address (elopher-node-address elopher-current-node))) + (if content + (progn + (elopher-with-clean-buffer + (insert-image content)) + (setq cursor-type nil) + (elopher-restore-pos)) + (progn + (elopher-with-clean-buffer + (insert "LOADING IMAGE...")) + (elopher-get-selector address + (lambda (proc event) + (unless (string-prefix-p "deleted" event) + (let ((image (create-image + (string-as-unibyte elopher-selector-string) + nil t))) + (elopher-with-clean-buffer + (insert-image image)) + (setq cursor-type nil) + (elopher-restore-pos) + (elopher-set-node-content elopher-current-node + image))))))))) + +;; Search retrieval + +(defun elopher-get-search-node () + (let* ((content (elopher-node-content elopher-current-node)) + (address (elopher-node-address elopher-current-node))) + (if content + (progn + (elopher-with-clean-buffer + (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))))))))) + +;; Raw server response retrieval + +(defun elopher-get-node-raw () + (let* ((content (elopher-node-content elopher-current-node)) + (address (elopher-node-address elopher-current-node))) + (elopher-with-clean-buffer + (insert "LOADING RAW SERVER RESPONSE...")) + (if address + (elopher-get-selector address + (lambda (proc event) + (unless (string-prefix-p "deleted" event) + (elopher-with-clean-buffer + (insert elopher-selector-string)) + (goto-char (point-min))))) + (progn + (elopher-with-clean-buffer + (insert elopher-start-index)) + (goto-char (point-min))))) + (message "Displaying raw server response. Reload to return to standard view.")) + + +;; File export retrieval + +(defvar elopher-download-filename) + +(defun elopher-get-node-download () + (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))) + (message (format "Download complate, saved to file %s." + elopher-download-filename))))) + (elopher-visit-parent-node)))) + + +;;; Navigation procedures ;; (defun elopher-next-link () @@ -246,6 +467,12 @@ (let ((node (button-get button 'elopher-node))) (elopher-visit-node node))) +(defun elopher-click-url (button) + (let ((url (button-get button 'elopher-url))) + (if elopher-open-urls-with-eww + (browse-web url) + (browse-url url)))) + (defun elopher-follow-closest-link () (interactive) (push-button)) @@ -253,9 +480,10 @@ (defun elopher-go () "Go to a particular gopher site." (interactive) - (let* ((selector "") - (hostname (read-from-minibuffer "Gopher host: ")) - (port 70) + (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))) (elopher-visit-node (elopher-make-node elopher-current-node @@ -263,21 +491,31 @@ #'elopher-get-index-node)))) (defun elopher-reload () - "Reload current site." + "Reload current page." (interactive) (elopher-reload-current-node)) +(defun elopher-view-raw () + "View current page as plain text." + (interactive) + (elopher-visit-node elopher-current-node + #'elopher-get-node-raw)) + (defun elopher-back () "Go to previous site." (interactive) - (elopher-visit-parent-node)) + (if (elopher-node-parent elopher-current-node) + (elopher-visit-parent-node) + (message "No previous site."))) -;;; Main start procedure -;; -(defun elopher () - "Start elopher with default landing page." +(defun elopher-download () + "Download the link at point." (interactive) - (elopher-visit-node elopher-start-node)) + (let ((button (button-at (point)))) + (if button + (elopher-visit-node (button-get button 'elopher-node) + #'elopher-get-node-download) + (message "No link selected.")))) ;;; Mode and keymap @@ -290,13 +528,17 @@ (define-key map (kbd "u") 'elopher-back) (define-key map (kbd "g") 'elopher-go) (define-key map (kbd "r") 'elopher-reload) - (when (require 'evil nil t) + (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 "C-t") 'elopher-back (kbd "u") 'elopher-back (kbd "g") 'elopher-go - (kbd "r") 'elopher-reload)) + (kbd "r") 'elopher-reload + (kbd "w") 'elopher-view-raw + (kbd "d") 'elopher-download)) map) "Keymap for gopher client.") @@ -304,4 +546,16 @@ "Major mode for elopher, an elisp gopher client.") +;;; Main start procedure +;; + +(defun elopher () + "Start elopher with default landing page." + (interactive) + (setq elopher-current-node nil) + (let ((start-node (elopher-make-node nil nil #'elopher-get-index-node))) + (elopher-visit-node start-node)) + "Started Elopher.") ; Otherwise (elopher) evaluates to start page string. + ;;; elopher.el ends here +