Experimenting with asynchronous connections.
[elpher.git] / elpher.el
index 3d7748f..db5a820 100644 (file)
--- a/elpher.el
+++ b/elpher.el
@@ -4,7 +4,7 @@
 
 ;; Author: Tim Vaughan <tgvaughan@gmail.com>
 ;; Created: 11 April 2019
-;; Version: 2.3.2
+;; Version: 2.3.6
 ;; Keywords: comm gopher
 ;; Homepage: https://github.com/tgvaughan/elpher
 ;; Package-Requires: ((emacs "26"))
 (require 'shr)
 (require 'url-util)
 (require 'subr-x)
+(require 'dns)
 
 
 ;;; Global constants
 ;;
 
-(defconst elpher-version "2.3.2"
+(defconst elpher-version "2.3.6"
   "Current version of elpher.")
 
 (defconst elpher-margin-width 6
@@ -88,7 +89,7 @@
     (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)
+    ((special bookmarks) elpher-get-bookmarks-node nil "/" elpher-index)
     ((special start) elpher-get-start-node nil))
   "Association list from types to getters, renderers, margin codes and index faces.")
 
@@ -282,16 +283,11 @@ For gopher addresses this is a combination of the selector type and selector."
   (url-host address))
 
 (defun elpher-address-port (address)
-  "Retrieve port from ADDRESS object."
+  "Retrieve port from ADDRESS object.
+If no address is defined, returns 0.  (This is for compatibility with the URL library.)"
   (if (symbolp address)
-      nil)
-  (if (> (url-port address) 0)
-      (url-port address)
-    (or (and (or (equal (url-type address) "gopher")
-                 (equal (url-type address) "gophers"))
-             70)
-        (and (equal (url-type address) "gemini")
-             1965))))
+      0
+    (url-port address)))
 
 (defun elpher-address-special-p (address)
   "Return non-nil if ADDRESS object is special (e.g. start page, bookmarks page)."
@@ -426,11 +422,13 @@ unless PRESERVE-PARENT is non-nil."
   (if elpher-use-header
       (let* ((display-string (elpher-node-display-string elpher-current-node))
              (address (elpher-node-address elpher-current-node))
-             (url-string (if (elpher-address-special-p address)
-                             ""
-                           (concat "  -  " (elpher-address-to-url address) "")))
-             (header (replace-regexp-in-string "%" "%%" (concat display-string
-                                                                url-string))))
+             (tls-string (if (and (not (elpher-address-special-p address))
+                                  (member (elpher-address-protocol address)
+                                          '("gophers" "gemini")))
+                             " [TLS encryption]"
+                           ""))
+             (header (concat display-string
+                             (propertize tls-string 'face 'bold))))
         (setq header-line-format header))))
 
 (defmacro elpher-with-clean-buffer (&rest args)
@@ -472,7 +470,7 @@ away CRs and any terminating period."
   (elpher-with-clean-buffer
    (insert (propertize "\n---- ERROR -----\n\n" 'face 'error)
            "When attempting to retrieve " (elpher-address-to-url address) ":\n"
-           (error-message-string error) ".\n"
+           (error-message-string error) "\n"
            (propertize "\n----------------\n\n" 'face 'error)
            "Press 'u' to return to the previous page.")))
 
@@ -507,10 +505,12 @@ up to the calling function."
         (error "Cannot retrieve TLS gopher selector: GnuTLS not available")))
   (condition-case the-error
       (let* ((kill-buffer-query-functions nil)
+             (port (elpher-address-port address))
+             (host (elpher-address-host address))
              (proc (open-network-stream "elpher-process"
                                        nil
-                                       (elpher-address-host address)
-                                       (elpher-address-port address)
+                                       host
+                                       (if (> port 0) port 70)
                                        :type (if elpher-use-tls 'tls 'plain))))
         (set-process-coding-system proc 'binary)
         (set-process-filter proc
@@ -518,8 +518,9 @@ up to the calling function."
                               (setq elpher-selector-string
                                     (concat elpher-selector-string string))))
         (set-process-sentinel proc after)
-        (process-send-string proc
-                             (concat (elpher-gopher-address-selector address) "\n")))
+        (let ((inhibit-eol-conversion t))
+          (process-send-string proc
+                               (concat (elpher-gopher-address-selector address) "\r\n"))))
     (error
      (if (and (consp the-error)
               (eq (car the-error) 'gnutls-error)
@@ -593,7 +594,9 @@ once they are retrieved from the gopher server."
 (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)))
-    (format "mouse-1, RET: open '%s'" (elpher-address-to-url address))))
+    (format "mouse-1, RET: open '%s'" (if (elpher-address-special-p address)
+                                          address
+                                        (elpher-address-to-url address)))))
 
 (defun elpher-insert-index-record (display-string &optional address)
   "Function to insert an index record into the current buffer.
@@ -653,7 +656,7 @@ 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 (match-string 0)
+      (let ((node (elpher-make-node (substring-no-properties (match-string 0))
                                     (elpher-address-from-url (match-string 0)))))
           (make-text-button (match-beginning 0)
                             (match-end 0)
@@ -769,28 +772,34 @@ The response is rendered using the rendering function RENDERER."
 ;; Gemini node retrieval
 
 (defvar elpher-gemini-response)
+(defvar elpher-gemini-redirect-chain)
 
 (defun elpher-get-gemini-response (address after)
   "Retrieve gemini ADDRESS, then execute AFTER.
 The response is stored in the variable ‘elpher-gemini-response’."
   (setq elpher-gemini-response "")
   (if (not (gnutls-available-p))
-      (error "Cannot retrieve TLS selector: GnuTLS not available")
+      (error "Cannot establish gemini connection: GnuTLS not available")
     (condition-case the-error
         (let* ((kill-buffer-query-functions nil)
+               (network-security-level 'medium)
+               (port (elpher-address-port address))
+               (host (elpher-address-host address))
                (proc (open-network-stream "elpher-process"
                                           nil
-                                          (elpher-address-host address)
-                                          (elpher-address-port address)
-                                          :type 'tls)))
+                                          host
+                                          (if (> port 0) port 1965)
+                                          :type 'tls
+                                          :nowait t)))
           (set-process-coding-system proc 'binary)
           (set-process-filter proc
                               (lambda (_proc string)
                                 (setq elpher-gemini-response
                                       (concat elpher-gemini-response string))))
           (set-process-sentinel proc after)
-          (process-send-string proc
-                               (concat (elpher-address-to-url address) "\r\n")))
+          (let ((inhibit-eol-conversion t))
+            (process-send-string proc
+                                 (concat (elpher-address-to-url address) "\r\n"))))
       (error
        (error "Error initiating connection to server")))))
 
@@ -827,7 +836,8 @@ The response is assumed to be in the variable `elpher-gemini-response'."
                     (query-address (elpher-address-from-url (concat url "?" query-string))))
                (elpher-get-gemini-response query-address
                                            (lambda (_proc event)
-                                             (unless (string-prefix-p "deleted" event)
+                                             (unless (or (string-prefix-p "deleted" event)
+                                                         (string-prefix-p "open" event))
                                                (funcall #'elpher-process-gemini-response
                                                         renderer)
                                                (elpher-restore-pos))))))
@@ -836,10 +846,20 @@ The response is assumed to be in the variable `elpher-gemini-response'."
              (funcall renderer response-body response-meta))
             (?3 ; Redirect
              (message "Following redirect to %s" response-meta)
+             (if (>= (length elpher-gemini-redirect-chain) 5)
+                 (error "More than 5 consecutive redirects followed"))
              (let ((redirect-address (elpher-address-from-gemini-url response-meta)))
+               (if (member redirect-address elpher-gemini-redirect-chain)
+                   (error "Redirect loop detected"))
+               (if (not (string= (elpher-address-protocol redirect-address)
+                                 "gemini"))
+                   (error "Server tried to automatically redirect to non-gemini URL: %s"
+                          response-meta))
+               (add-to-list 'elpher-gemini-redirect-chain redirect-address)
                (elpher-get-gemini-response redirect-address
                                            (lambda (_proc event)
-                                             (unless (string-prefix-p "deleted" event)
+                                             (unless (or (string-prefix-p "deleted" event)
+                                                         (string-prefix-p "open" event))
                                                (funcall #'elpher-process-gemini-response
                                                         renderer)
                                                (elpher-restore-pos))))))
@@ -868,9 +888,11 @@ The response is assumed to be in the variable `elpher-gemini-response'."
               (elpher-restore-pos))
           (elpher-with-clean-buffer
            (insert "LOADING GEMINI... (use 'u' to cancel)"))
+          (setq elpher-gemini-redirect-chain nil)
           (elpher-get-gemini-response address
                                       (lambda (_proc event)
-                                        (unless (string-prefix-p "deleted" event)
+                                        (unless (or (string-prefix-p "deleted" event)
+                                                    (string-prefix-p "open" event))
                                           (funcall #'elpher-process-gemini-response
                                                    renderer)
                                           (elpher-restore-pos)))))
@@ -922,6 +944,19 @@ The response is assumed to be in the variable `elpher-gemini-response'."
         (string-trim (substring rest (+ idx 1)))
       "")))
 
+(defun elpher-collapse-dot-sequences (filename)
+  "Collapse dot sequences in FILENAME.
+For instance, the filename /a/b/../c/./d will reduce to /a/c/d"
+  (let* ((path (split-string filename "/"))
+         (path-reversed-normalized
+          (seq-reduce (lambda (a b)
+                        (cond ((and a (equal b "..") (cdr a)))
+                              ((and (not a) (equal b "..")) a) ;leading .. are dropped
+                              ((equal b ".") a)
+                              (t (cons b a))))
+                      path nil)))
+    (string-join (reverse path-reversed-normalized) "/")))
+
 (defun elpher-address-from-gemini-url (url)
   "Extract address from URL with defaults as per gemini map files."
   (let ((address (url-generic-parse-url url)))
@@ -935,7 +970,10 @@ The response is assumed to be in the variable `elpher-gemini-response'."
                          (url-filename (elpher-node-address elpher-current-node)))
                         (url-filename address)))))
       (unless (url-type address)
-        (setf (url-type address) "gemini")))
+        (setf (url-type address) "gemini"))
+      (if (equal (url-type address) "gemini")
+          (setf (url-filename address)
+                (elpher-collapse-dot-sequences (url-filename address)))))
     address))
 
 (defun elpher-render-gemini-map (data _parameters)
@@ -989,7 +1027,9 @@ The response is assumed to be in the variable `elpher-gemini-response'."
          (host (elpher-address-host address))
          (port (elpher-address-port address)))
     (elpher-visit-parent-node)
-    (telnet host port)))
+    (if (> port 0)
+        (telnet host port)
+      (telnet host))))
 
 ;; Start page node retrieval
 
@@ -1031,6 +1071,9 @@ The response is assumed to be in the variable `elpher-gemini-response'."
            "Alternatively, select the following item and enter some search terms:\n")
    (elpher-insert-index-record "Veronica-2 Gopher Search Engine"
                                (elpher-make-gopher-address ?7 "/v2/vs" "gopher.floodgap.com" 70))
+   (insert "\n"
+           "This page contains your bookmarked sites (also visit with B):\n")
+   (elpher-insert-index-record "Your Bookmarks" 'bookmarks)
    (insert "\n"
            "** Refer to the ")
    (let ((help-string "RET,mouse-1: Open Elpher info manual (if available)"))
@@ -1194,7 +1237,7 @@ If ADDRESS is already bookmarked, update the label only."
     (message "No current site.")))
 
 (defun elpher-toggle-tls ()
-  "Toggle TLS encryption mode."
+  "Toggle TLS encryption mode for gopher."
   (interactive)
   (setq elpher-use-tls (not elpher-use-tls))
   (if elpher-use-tls
@@ -1357,7 +1400,7 @@ If ADDRESS is already bookmarked, update the label only."
         (address (elpher-node-address node)))
     (if (elpher-address-special-p address)
         (message "Special page: %s" display-string)
-      (message (elpher-address-to-url address)))))
+      (message "%s" (elpher-address-to-url address)))))
 
 (defun elpher-info-link ()
   "Display information on node corresponding to link at point."