X-Git-Url: https://thelambdalab.xyz/gitweb/index.cgi?p=elpher.git;a=blobdiff_plain;f=elpher.el;h=703e1e4938600f2fe1f99db31515b9093a5734b5;hp=0aaa06c54b0dce1437ad9db9a079f78009f6ca88;hb=efc5b2480f8e40b48298cd2617aecb7df11c032b;hpb=996f1bc282d90bff5a1b363230c85d63d6880ca4 diff --git a/elpher.el b/elpher.el index 0aaa06c..703e1e4 100644 --- a/elpher.el +++ b/elpher.el @@ -1,10 +1,10 @@ -;;; elpher.el --- Full-featured gopher client. +;;; elpher.el --- A friendly gopher client. ;; Copyright (C) 2019 Tim Vaughan ;; Author: Tim Vaughan ;; Created: 11 April 2019 -;; Version: 1.1.0 +;; Version: 1.4.3 ;; Keywords: comm gopher ;; Homepage: https://github.com/tgvaughan/elpher ;; Package-Requires: ((emacs "25")) @@ -26,36 +26,38 @@ ;;; Commentary: -;; Elpher aims to provide a full-featured 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. - -;; Visited pages are stored as a hierarchy rather than a linear history, -;; meaning that navigation between these pages is quick and easy. +;; - a simple bookmark management system, +;; - 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 options and start page can be configured via -;; the Elpher customization group in Applications. +;; Further instructions can be found in the Elpher info manual. + +;; Elpher is under active development. Any suggestions for +;; improvements are welcome! ;;; Code: (provide 'elpher) (require 'seq) (require 'pp) +(require 'shr) ;;; Global constants ;; -(defconst elpher-version "1.1.0" +(defconst elpher-version "1.4.3" "Current version of elpher.") (defconst elpher-margin-width 6 @@ -77,7 +79,7 @@ "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 menu or item\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" @@ -85,8 +87,10 @@ "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 - d: download directory entry under cursor\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" @@ -101,17 +105,18 @@ "Source for elpher start page.") (defconst elpher-type-map - '((?0 elpher-get-text-node "T" elpher-text) + '((?0 elpher-get-text-node "txt" elpher-text) (?1 elpher-get-index-node "/" elpher-index) - (?4 elpher-get-node-download "B" elpher-binary) - (?5 elpher-get-node-download "B" elpher-binary) + (?4 elpher-get-node-download "bin" elpher-binary) + (?5 elpher-get-node-download "bin" elpher-binary) (?7 elpher-get-search-node "?" elpher-search) - (?8 elpher-get-telnet-node "?" elpher-telnet) - (?9 elpher-get-node-download "B" elpher-binary) - (?g elpher-get-image-node "im" elpher-image) - (?p elpher-get-image-node "im" elpher-image) - (?I elpher-get-image-node "im" elpher-image) - (?h elpher-get-url-node "W" elpher-url) + (?8 elpher-get-telnet-node "tel" elpher-telnet) + (?9 elpher-get-node-download "bin" elpher-binary) + (?g elpher-get-image-node "img" elpher-image) + (?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) (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.") @@ -189,16 +194,28 @@ Otherwise, use the system browser via the BROWSE-URL function." "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 ;; ;; Address -(defun elpher-make-address (type &optional selector host port) +(defun elpher-make-address (type &optional selector host port use-tls) "Create an address of a gopher object with TYPE, SELECTOR, HOST and PORT. Although selector host and port are optional, they are only omitted for -special address types, such as 'start for the start page." - (list type selector host port)) +special address types, such as 'start for the start page. + +Setting the USE-TLS parameter to non-nil causes Elpher to engage TLS mode +before attempting to connect to the server." + (if use-tls + (list type selector host port 'tls) + (list type selector host port))) (defun elpher-address-type (address) "Retrieve type from ADDRESS." @@ -216,29 +233,45 @@ special address types, such as 'start for the start page." "Retrieve port from ADDRESS." (elt address 3)) +(defun elpher-address-use-tls-p (address) + "Return non-nil if ADDRESS is marked as needing TLS." + (elt address 4)) + +(defun elpher-address-special-p (address) + "Return non-nil if ADDRESS is special (e.g. start page, bookmarks page)." + (not (elpher-address-host address))) + ;; Node -(defun elpher-make-node (display-string parent address) +(defun elpher-make-node (display-string address &optional parent) "Create a node in the gopher page hierarchy. DISPLAY-STRING records the display string used for the page. -PARENT specifies the parent of the node, and ADDRESS specifies the -address of the gopher page." - (list display-string parent address)) +ADDRESS specifies the address of the gopher 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-parent (node) - "Retrieve the parent node of NODE." - (elt node 1)) - (defun elpher-node-address (node) "Retrieve the address 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 (defvar elpher-content-cache (make-hash-table :test 'equal)) @@ -264,10 +297,18 @@ address of the gopher page." (defvar elpher-current-node nil) -(defun elpher-visit-node (node &optional getter) - "Visit NODE using its own getter or GETTER, if non-nil." +(defun elpher-visit-node (node &optional getter preserve-parent) + "Visit NODE using its own getter or GETTER, if non-nil. +Additionally, set the parent of NODE to `elpher-current-node', +unless PRESERVE-PARENT 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) (if getter (funcall getter) @@ -279,7 +320,7 @@ address of the gopher page." "Visit the parent of the current node." (let ((parent-node (elpher-node-parent elpher-current-node))) (when parent-node - (elpher-visit-node parent-node)))) + (elpher-visit-node parent-node nil t)))) (defun elpher-reload-current-node () "Reload the current node, discarding any existing cached content." @@ -317,14 +358,28 @@ address of the gopher page." args))) -;;; Index rendering +;;; Text Processing ;; +(defvar elpher-user-coding-system nil + "User-specified coding system to use for decoding text responses.") + +(defun elpher-decode (string) + "Decode STRING using autodetected or user-specified coding system." + (decode-coding-string string + (if elpher-user-coding-system + elpher-user-coding-system + (detect-coding-string string t)))) + (defun elpher-preprocess-text-response (string) - "Clear away CRs and terminating period from STRING." - (replace-regexp-in-string "\n\.\n$" "\n" - (replace-regexp-in-string "\r" "" - string))) + "Preprocess text selector response contained in STRING. +This involes decoding the character representation, and clearing +away CRs and any terminating period." + (elpher-decode (replace-regexp-in-string "\n\.\n$" "\n" + (replace-regexp-in-string "\r" "" string)))) + +;;; Index rendering +;; (defun elpher-insert-index (string) "Insert the index corresponding to STRING into the current buffer." @@ -340,8 +395,9 @@ address of the gopher page." (host (elt fields 2)) (port (if (elt fields 3) (string-to-number (elt fields 3)) - nil))) - (elpher-insert-index-record display-string type selector host port)))))) + nil)) + (address (elpher-make-address type selector host port))) + (elpher-insert-index-record display-string address)))))) (defun elpher-insert-margin (&optional type-name) "Insert index margin, optionally containing the TYPE-NAME, into the current buffer." @@ -366,16 +422,16 @@ address of the gopher page." (elpher-address-host address) (elpher-address-port address))))) -(defun elpher-insert-index-record (display-string type selector host port) + +(defun elpher-insert-index-record (display-string address) "Function to insert an index record into the current buffer. -The contents of the record are dictated by TYPE, DISPLAY-STRING, SELECTOR, HOST -and PORT." - (let ((address (elpher-make-address type selector host port)) - (type-map-entry (alist-get type elpher-type-map))) +The contents of the record are dictated by DISPLAY-STRING and ADDRESS." + (let* ((type (elpher-address-type address)) + (type-map-entry (alist-get type elpher-type-map))) (if type-map-entry - (let* ((margin-code (cadr type-map-entry)) + (let* ((margin-code (elt type-map-entry 1)) (face (elt type-map-entry 2)) - (node (elpher-make-node display-string elpher-current-node address))) + (node (elpher-make-node display-string address))) (elpher-insert-margin margin-code) (insert-text-button display-string 'face face @@ -394,7 +450,7 @@ and PORT." (other ;; Unknown (elpher-insert-margin (concat (char-to-string type) "?")) (insert (propertize display-string - 'face 'elpher-unknown-face))))) + 'face 'elpher-unknown))))) (insert "\n"))) (defun elpher-click-link (button) @@ -411,21 +467,59 @@ and PORT." (let ((p (get-process "elpher-process"))) (if p (delete-process p)))) +(defvar elpher-use-tls nil + "If non-nil, use TLS to communicate with gopher servers.") + (defvar elpher-selector-string) -(defun elpher-get-selector (address after) +(defun elpher-get-selector (address after &optional propagate-error) "Retrieve selector specified by ADDRESS, then execute AFTER. -The result is stored as a string in the variable ‘elpher-selector-string’." +The result is stored as a string in the variable ‘elpher-selector-string’. + +Usually errors result in an error page being displayed. This is only +appropriate if the selector is to be directly viewed. If PROPAGATE-ERROR +is non-nil, this message is not displayed. Instead, the error propagates +up to the calling function." (setq elpher-selector-string "") - (make-network-process - :name "elpher-process" - :host (elpher-address-host address) - :service (elpher-address-port address) - :filter (lambda (proc string) - (setq elpher-selector-string (concat elpher-selector-string string))) - :sentinel after) - (process-send-string "elpher-process" - (concat (elpher-address-selector address) "\n"))) + (when (elpher-address-use-tls-p address) + (if (gnutls-available-p) + (when (not elpher-use-tls) + (setq elpher-use-tls t) + (message "Engaging TLS mode.")) + (error "Cannot retrieve TLS selector: GnuTLS not available"))) + (condition-case the-error + (let* ((kill-buffer-query-functions nil) + (proc (open-network-stream "elpher-process" + nil + (elpher-address-host address) + (elpher-address-port address) + :type (if elpher-use-tls 'tls 'plain)))) + (set-process-coding-system proc 'binary) + (set-process-filter proc + (lambda (proc string) + (setq elpher-selector-string + (concat elpher-selector-string string)))) + (set-process-sentinel proc after) + (process-send-string proc + (concat (elpher-address-selector address) "\n"))) + (error + (if (and (consp the-error) + (eq (car the-error) 'gnutls-error) + (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 "Disengaging TLS mode.") + (setq elpher-use-tls nil) + (elpher-get-selector address after)) + (elpher-process-cleanup) + (if propagate-error + (error the-error) + (elpher-with-clean-buffer + (insert (propertize "\n---- ERROR -----\n\n" 'face 'error) + "Failed to connect to " (elpher-get-address-url address) ".\n" + (propertize "\n----------------\n\n" 'face 'error) + "Press 'u' to return to the previous page."))))))) ;; Index retrieval @@ -439,7 +533,7 @@ The result is stored as a string in the variable ‘elpher-selector-string’." (insert content) (elpher-restore-pos))) (elpher-with-clean-buffer - (insert "LOADING DIRECTORY...")) + (insert "LOADING DIRECTORY... (use 'u' to cancel)")) (elpher-get-selector address (lambda (proc event) (unless (string-prefix-p "deleted" event) @@ -456,16 +550,15 @@ The result is stored as a string in the variable ‘elpher-selector-string’." "\\([a-zA-Z]+\\)://\\([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 (parent &optional string) +(defun elpher-make-node-from-matched-url (&optional string) "Convert most recent `elpher-url-regex' match to a node. -PARENT defines the node to set as the parent to the new node. - If STRING is non-nil, this is given as an argument to all `match-string' calls, as is necessary if the match is performed by `string-match'." (let ((url (match-string 0 string)) (protocol (downcase (match-string 1 string)))) - (if (string= protocol "gopher") + (if (or (string= protocol "gopher") + (string= protocol "gophers")) (let* ((host (match-string 2 string)) (port (if (> (length (match-string 3 string)) 1) (string-to-number (substring (match-string 3 string) 1)) @@ -477,15 +570,16 @@ calls, as is necessary if the match is performed by `string-match'." (selector (if (> (length type-and-selector) 1) (substring type-and-selector 2) "")) - (address (elpher-make-address type selector host port))) - (elpher-make-node url elpher-current-node address)) + (use-tls (string= protocol "gophers")) + (address (elpher-make-address type selector host port use-tls))) + (elpher-make-node url address)) (let* ((host (match-string 2 string)) (port (if (> (length (match-string 3 string)) 1) (string-to-number (substring (match-string 3 string) 1)) 70)) (selector (concat "URL:" url)) (address (elpher-make-address ?h selector host port))) - (elpher-make-node url elpher-current-node address))))) + (elpher-make-node url address))))) (defun elpher-buttonify-urls (string) @@ -494,7 +588,7 @@ calls, as is necessary if the match is performed by `string-match'." (insert string) (goto-char (point-min)) (while (re-search-forward elpher-url-regex nil t) - (let ((node (elpher-make-node-from-matched-url elpher-current-node))) + (let ((node (elpher-make-node-from-matched-url))) (make-text-button (match-beginning 0) (match-end 0) 'elpher-node node @@ -514,7 +608,7 @@ calls, as is necessary if the match is performed by `string-match'." (elpher-restore-pos))) (progn (elpher-with-clean-buffer - (insert "LOADING TEXT...")) + (insert "LOADING TEXT... (use 'u' to cancel)")) (elpher-get-selector address (lambda (proc event) (unless (string-prefix-p "deleted" event) @@ -541,14 +635,12 @@ calls, as is necessary if the match is performed by `string-match'." (if (display-images-p) (progn (elpher-with-clean-buffer - (insert "LOADING IMAGE...")) + (insert "LOADING IMAGE... (use 'u' to cancel)")) (elpher-get-selector address (lambda (proc event) (unless (string-prefix-p "deleted" event) (let ((image (create-image - (encode-coding-string - elpher-selector-string - 'no-conversion) + elpher-selector-string nil t))) (elpher-with-clean-buffer (insert-image image) @@ -581,7 +673,7 @@ calls, as is necessary if the match is performed by `string-match'." (elpher-address-port address)))) (setq aborted nil) (elpher-with-clean-buffer - (insert "LOADING RESULTS...")) + (insert "LOADING RESULTS... (use 'u' to cancel)")) (elpher-get-selector search-address (lambda (proc event) (unless (string-prefix-p "deleted" event) @@ -600,7 +692,7 @@ calls, as is necessary if the match is performed by `string-match'." "Getter which retrieves the raw server response for the current node." (let ((address (elpher-node-address elpher-current-node))) (elpher-with-clean-buffer - (insert "LOADING RAW SERVER RESPONSE...")) + (insert "LOADING RAW SERVER RESPONSE... (use 'u' to cancel)")) (if address (elpher-get-selector address (lambda (proc event) @@ -631,25 +723,56 @@ calls, as is necessary if the match is performed by `string-match'." "gopher.file")))) (message "Downloading...") (setq elpher-download-filename filename) - (elpher-get-selector address - (lambda (proc event) - (let ((coding-system-for-write 'binary)) - (with-temp-file elpher-download-filename - (insert elpher-selector-string) - (message (format "Download complate, saved to file %s." - elpher-download-filename))))))))) + (condition-case the-error + (elpher-get-selector address + (lambda (proc event) + (let ((coding-system-for-write 'binary)) + (with-temp-file elpher-download-filename + (insert elpher-selector-string) + (message (format "Download complate, saved to file %s." + elpher-download-filename))))) + t) + (error + (error "Error downloading %s" elpher-download-filename)))))) ;; URL retrieval +(defun elpher-insert-rendered-html (string) + "Use shr to insert rendered view of html STRING into current buffer." + (let ((dom (with-temp-buffer + (insert string) + (libxml-parse-html-region (point-min) (point-max))))) + (shr-insert-document dom))) + (defun elpher-get-url-node () "Getter which attempts to open the URL specified by the current node." (let* ((address (elpher-node-address elpher-current-node)) (selector (elpher-address-selector address))) - (elpher-visit-parent-node) ; Do first in case of non-local exits. (let ((url (elt (split-string selector "URL:") 1))) - (if elpher-open-urls-with-eww - (browse-web url) - (browse-url url))))) + (if url + (progn + (elpher-visit-parent-node) ; Do first in case of non-local exits. + (message "Opening URL...") + (if elpher-open-urls-with-eww + (browse-web url) + (browse-url url))) + (let ((content (elpher-get-cached-content address))) + (if content + (progn + (elpher-with-clean-buffer + (insert content) + (elpher-restore-pos))) + (elpher-with-clean-buffer + (insert "LOADING HTML... (use 'u' to cancel)")) + (elpher-get-selector address + (lambda (proc event) + (unless (string-prefix-p "deleted" event) + (elpher-with-clean-buffer + (elpher-insert-rendered-html elpher-selector-string) + (goto-char (point-min)) + (elpher-cache-content + (elpher-node-address elpher-current-node) + (buffer-string)))))))))))) ;; Telnet node connection @@ -672,22 +795,22 @@ calls, as is necessary if the match is performed by `string-match'." ;; Bookmarks page node retrieval (defun elpher-get-bookmarks-node () - "Getter which loads and displays the current bookmark list." + "Getter to load and display the current bookmark list." (elpher-with-clean-buffer - (insert "Use 'u' to return to the previous page.\n\n" - "---- Bookmark list ----\n\n") + (insert "---- Bookmark list ----\n\n") (let ((bookmarks (elpher-load-bookmarks))) (if bookmarks (dolist (bookmark bookmarks) (let ((display-string (elpher-bookmark-display-string bookmark)) (address (elpher-bookmark-address bookmark))) - (elpher-insert-index-record display-string - (elpher-address-type address) - (elpher-address-selector address) - (elpher-address-host address) - (elpher-address-port address)))) + (elpher-insert-index-record display-string address))) (insert "No bookmarks found.\n"))) - (insert "\n-----------------------") + (insert "\n-----------------------\n\n" + "- u: return to previous page\n" + "- x: delete selected bookmark\n" + "- a: rename selected bookmark\n\n" + "Bookmarks are stored in the file " + (locate-user-emacs-file "elpher-bookmarks")) (elpher-restore-pos))) @@ -704,6 +827,10 @@ bookmark list, while ADDRESS is the address of the entry." "Get the display string of BOOKMARK." (elt bookmark 0)) +(defun elpher-set-bookmark-display-string (bookmark display-string) + "Set the display string of BOOKMARK to DISPLAY-STRING." + (setcar bookmark display-string)) + (defun elpher-bookmark-address (bookmark) "Get the address for BOOKMARK." (elt bookmark 1)) @@ -713,6 +840,10 @@ bookmark list, while ADDRESS is the address of the entry." Beware that this completely replaces the existing contents of the file." (with-temp-file (locate-user-emacs-file "elpher-bookmarks") (erase-buffer) + (insert "; Elpher gopher bookmarks file\n\n" + "; Bookmarks are stored as a list of (label (type selector host port))\n" + "; s-expressions, where type is stored as a character (i.e. 49 = ?1).\n" + "; Feel free to edit by hand, but ensure this structure remains intact.\n\n") (pp bookmarks (current-buffer)))) (defun elpher-load-bookmarks () @@ -723,23 +854,22 @@ Beware that this completely replaces the existing contents of the file." (goto-char (point-min)) (read (current-buffer))))) -(defun elpher-add-node-bookmark (node) - "Add bookmark to NODE to the saved list of bookmarks." - (let ((bookmark (elpher-make-bookmark (elpher-node-display-string node) - (elpher-node-address node))) - (bookmarks (elpher-load-bookmarks))) - (add-to-list 'bookmarks bookmark) +(defun elpher-add-address-bookmark (address display-string) + "Save a bookmark for ADDRESS with label DISPLAY-STRING. +If ADDRESS is already bookmarked, update the label only." + (let ((bookmarks (elpher-load-bookmarks))) + (let ((existing-bookmark (rassoc (list address) bookmarks))) + (if existing-bookmark + (elpher-set-bookmark-display-string existing-bookmark display-string) + (add-to-list 'bookmarks (elpher-make-bookmark display-string address)))) (elpher-save-bookmarks bookmarks))) -(defun elpher-remove-node-bookmark (node) - "Remove bookmark to NODE from the saved list of bookmarks." - (let ((bookmark (elpher-make-bookmark (elpher-node-display-string node) - (elpher-node-address node)))) +(defun elpher-remove-address-bookmark (address) + "Remove any bookmark to ADDRESS." (elpher-save-bookmarks - (seq-filter (lambda (this-bookmark) - (not (equal bookmark this-bookmark))) - (elpher-load-bookmarks))))) - + (seq-filter (lambda (bookmark) + (not (equal (elpher-bookmark-address bookmark) address))) + (elpher-load-bookmarks)))) ;;; Interactive procedures ;; @@ -760,44 +890,57 @@ Beware that this completely replaces the existing contents of the file." (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 ((node (let ((host-or-url (read-string "Gopher host or URL: "))) (if (string-match elpher-url-regex host-or-url) - (elpher-make-node-from-matched-url elpher-current-node - host-or-url) + (elpher-make-node-from-matched-url host-or-url) (let ((selector (read-string "Selector (default none): " nil nil "")) (port-string (read-string "Port (default 70): " nil nil "70"))) (elpher-make-node (concat "gopher://" host-or-url ":" port-string "/1" selector) - elpher-current-node (elpher-make-address ?1 selector host-or-url (string-to-number port-string)))))))) (switch-to-buffer "*elpher*") (elpher-visit-node node))) -(defun elpher-redraw () +(defun elpher-redraw () "Redraw current page." (interactive) (if elpher-current-node (elpher-visit-node elpher-current-node) (message "No current site."))) -(defun elpher-reload () +(defun elpher-reload () "Reload current page." (interactive) (if elpher-current-node (elpher-reload-current-node) (message "No current site."))) +(defun elpher-toggle-tls () + "Toggle TLS encryption mode." + (interactive) + (setq elpher-use-tls (not elpher-use-tls)) + (if elpher-use-tls + (if (gnutls-available-p) + (message "TLS mode enabled. (Will not affect current page until reload.)") + (setq elpher-use-tls nil) + (error "Cannot enable TLS mode: GnuTLS not available")) + (message "TLS mode disabled. (Will not affect current page until reload.)"))) + (defun elpher-view-raw () - "View current page as plain text." + "View raw server response for current page." (interactive) (if elpher-current-node - (elpher-visit-node elpher-current-node - #'elpher-get-node-raw) + (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-get-node-raw)) (message "No current site."))) (defun elpher-back () @@ -813,12 +956,24 @@ Beware that this completely replaces the existing contents of the file." (let ((button (button-at (point)))) (if button (let ((node (button-get button 'elpher-node))) - (if node - (elpher-visit-node (button-get button 'elpher-node) - #'elpher-get-node-download) - (error "Can only download gopher links, not general URLs"))) + (if (elpher-address-special-p (elpher-node-address node)) + (error "Cannot download this link") + (elpher-visit-node (button-get button 'elpher-node) + #'elpher-get-node-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)) + (error "Cannot download this page") + (elpher-visit-node (elpher-make-node + (elpher-node-display-string elpher-current-node) + (elpher-node-address elpher-current-node) + elpher-current-node) + #'elpher-get-node-download + t))) + (defun elpher-build-link-map () "Build alist mapping link names to destination nodes in current buffer." (let ((link-map nil) @@ -834,7 +989,7 @@ Beware that this completely replaces the existing contents of the file." (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)))) @@ -856,13 +1011,12 @@ Beware that this completely replaces the existing contents of the file." (elpher-make-node (concat "gopher://" host ":" (number-to-string port) "/1/") - elpher-current-node root-address))) (error "Already at root directory of current server"))) (error "Command invalid for this page")))) (defun elpher-bookmarks-current-p () - "Return true if current node is a bookmarks page." + "Return non-nil if current node is a bookmarks page." (eq (elpher-address-type (elpher-node-address elpher-current-node)) 'bookmarks)) (defun elpher-reload-bookmarks () @@ -873,48 +1027,63 @@ Beware that this completely replaces the existing contents of the file." (defun elpher-bookmark-current () "Bookmark the current node." (interactive) - (if (not (elpher-bookmarks-current-p)) - (elpher-add-node-bookmark elpher-current-node))) + (let ((address (elpher-node-address elpher-current-node)) + (display-string (elpher-node-display-string elpher-current-node))) + (if (not (elpher-address-special-p address)) + (let ((bookmark-display-string (read-string "Bookmark display string: " + display-string))) + (elpher-add-address-bookmark address bookmark-display-string) + (message "Bookmark added.")) + (error "Cannot bookmark %s" display-string)))) (defun elpher-bookmark-link () "Bookmark the link at point." (interactive) (let ((button (button-at (point)))) (if button - (progn - (elpher-add-node-bookmark (button-get button 'elpher-node)) - (elpher-reload-bookmarks)) + (let* ((node (button-get button 'elpher-node)) + (address (elpher-node-address node)) + (display-string (elpher-node-display-string node))) + (if (not (elpher-address-special-p address)) + (let ((bookmark-display-string (read-string "Bookmark display string: " + display-string))) + (elpher-add-address-bookmark address bookmark-display-string) + (elpher-reload-bookmarks) + (message "Bookmark added.")) + (error "Cannot bookmark %s" display-string))) (error "No link selected")))) (defun elpher-unbookmark-current () "Remove bookmark for the current node." (interactive) - (if (not (elpher-bookmarks-current-p)) - (elpher-remove-node-bookmark elpher-current-node))) + (let ((address (elpher-node-address elpher-current-node))) + (unless (elpher-address-special-p address) + (elpher-remove-address-bookmark address) + (message "Bookmark removed.")))) (defun elpher-unbookmark-link () "Remove bookmark for the link at point." (interactive) (let ((button (button-at (point)))) (if button - (progn - (elpher-remove-node-bookmark (button-get button 'elpher-node)) - (elpher-reload-bookmarks)) + (let ((node (button-get button 'elpher-node))) + (elpher-remove-address-bookmark (elpher-node-address node)) + (elpher-reload-bookmarks) + (message "Bookmark removed.")) (error "No link selected")))) (defun elpher-bookmarks () - "Visit bookmarks." + "Visit bookmarks page." (interactive) + (switch-to-buffer "*elpher*") (elpher-visit-node - (elpher-make-node "Bookmarks" - elpher-current-node - (elpher-make-address 'bookmarks)))) + (elpher-make-node "Bookmarks Page" (elpher-make-address 'bookmarks)))) (defun elpher-info-node (node) "Display information on NODE." (let ((display-string (elpher-node-display-string node)) (address (elpher-node-address node))) - (if address + (if (not (elpher-address-special-p address)) (message "`%s' on %s port %s" (elpher-address-selector address) (elpher-address-host address) @@ -936,23 +1105,31 @@ Beware that this completely replaces the existing contents of the file." (defun elpher-get-address-url (address) "Get URL representation of ADDRESS." - (concat "gopher://" - (elpher-address-host address) - (let ((port (elpher-address-port address))) - (if (equal port 70) - "" - (format ":%d" port))) - "/" (string (elpher-address-type address)) - (elpher-address-selector 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))) - (if address - (let ((url (elpher-get-address-url address))) - (message url) - (kill-new url)) - (error (format "Cannot represent %s as URL" (elpher-node-display-string node)))))) + (if (elpher-address-special-p address) + (error (format "Cannot represent %s as URL" (elpher-node-display-string node))) + (let ((url (elpher-get-address-url address))) + (message "Copied \"%s\" to kill-ring/clipboard." url) + (kill-new url))))) (defun elpher-copy-link-url () "Copy URL of item at point to `kill-ring'." @@ -967,6 +1144,15 @@ Beware that this completely replaces the existing contents of the file." (interactive) (elpher-copy-node-url elpher-current-node)) +(defun elpher-set-coding-system () + "Specify an explicit character coding system." + (interactive) + (let ((system (read-coding-system "Set coding system to use (default is to autodetect): " nil))) + (setq elpher-user-coding-system system) + (if system + (message "Coding system fixed to %s. (Reload to see effect)." system) + (message "Coding system set to autodetect. (Reload to see effect).")))) + ;;; Mode and keymap ;; @@ -979,8 +1165,10 @@ Beware that this completely replaces the existing contents of the file." (define-key map (kbd "g") 'elpher-go) (define-key map (kbd "r") 'elpher-redraw) (define-key map (kbd "R") 'elpher-reload) + (define-key map (kbd "T") 'elpher-toggle-tls) (define-key map (kbd "w") 'elpher-view-raw) (define-key map (kbd "d") 'elpher-download) + (define-key map (kbd "D") 'elpher-download-current) (define-key map (kbd "m") 'elpher-jump) (define-key map (kbd "i") 'elpher-info-link) (define-key map (kbd "I") 'elpher-info-current) @@ -991,6 +1179,7 @@ Beware that this completely replaces the existing contents of the file." (define-key map (kbd "x") 'elpher-unbookmark-link) (define-key map (kbd "X") 'elpher-unbookmark-current) (define-key map (kbd "B") 'elpher-bookmarks) + (define-key map (kbd "S") 'elpher-set-coding-system) (when (fboundp 'evil-define-key) (evil-define-key 'motion map (kbd "TAB") 'elpher-next-link @@ -1001,8 +1190,10 @@ Beware that this completely replaces the existing contents of the file." (kbd "g") 'elpher-go (kbd "r") 'elpher-redraw (kbd "R") 'elpher-reload + (kbd "T") 'elpher-toggle-tls (kbd "w") 'elpher-view-raw (kbd "d") 'elpher-download + (kbd "D") 'elpher-download-current (kbd "m") 'elpher-jump (kbd "i") 'elpher-info-link (kbd "I") 'elpher-info-current @@ -1012,12 +1203,17 @@ Beware that this completely replaces the existing contents of the file." (kbd "A") 'elpher-bookmark-current (kbd "x") 'elpher-unbookmark-link (kbd "X") 'elpher-unbookmark-current - (kbd "B") 'elpher-bookmarks)) + (kbd "B") 'elpher-bookmarks + (kbd "S") 'elpher-set-coding-system)) map) "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)) @@ -1033,7 +1229,8 @@ Beware that this completely replaces the existing contents of the file." (switch-to-buffer "*elpher*") (switch-to-buffer "*elpher*") (setq elpher-current-node nil) - (let ((start-node (elpher-make-node "Elpher Start Page" nil (elpher-make-address 'start)))) + (let ((start-node (elpher-make-node "Elpher Start Page" + (elpher-make-address 'start)))) (elpher-visit-node start-node))) "Started Elpher.") ; Otherwise (elpher) evaluates to start page string.