Converging to vaguely acceptable network connection behaviour.
[elpher.git] / elpher.el
index fc4416c..0466a45 100644 (file)
--- a/elpher.el
+++ b/elpher.el
@@ -60,6 +60,7 @@
 (require 'shr)
 (require 'url-util)
 (require 'subr-x)
+(require 'dns)
 
 
 ;;; Global constants
@@ -175,6 +176,9 @@ 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))
 
+(defcustom elpher-connection-timeout 5
+  "Specifies the number of seconds to wait for a network connection to time out."
+  :type '(integer))
 
 ;;; Model
 ;;
@@ -487,56 +491,72 @@ away CRs and any terminating period."
 
 (defvar elpher-selector-string)
 
-(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’.
-
-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."
+(defun elpher-get-selector (address renderer &optional force-ipv4)
+  "Retrieve selector specified by ADDRESS, then render it using RENDERER.
+If FORCE-IPV4 is non-nil, explicitly look up and use IPv4 address corresponding
+to ADDRESS."
   (setq elpher-selector-string "")
   (when (equal (elpher-address-protocol address) "gophers")
-      (if (gnutls-available-p)
-          (when (not elpher-use-tls)
-            (setq elpher-use-tls t)
-            (message "Engaging TLS gopher mode."))
-        (error "Cannot retrieve TLS gopher selector: GnuTLS not available")))
-  (condition-case the-error
-      (let* ((kill-buffer-query-functions nil)
-             (port (elpher-address-port address))
-             (proc (open-network-stream "elpher-process"
-                                       nil
-                                       (elpher-address-host address)
-                                       (if (> port 0) port 70)
-                                       :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)
-        (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)
-              (not (equal (elpher-address-protocol address) "gophers"))
-              (or elpher-auto-disengage-TLS
-                  (yes-or-no-p "Could not establish encrypted connection.  Disable TLS mode? ")))
-         (progn
-           (message "Disengaging TLS gopher 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-address-to-url address) ".\n"
-                  (propertize "\n----------------\n\n" 'face 'error)
-                  "Press 'u' to return to the previous page.")))))))
+    (if (gnutls-available-p)
+        (when (not elpher-use-tls)
+          (setq elpher-use-tls t)
+          (message "Engaging TLS gopher mode."))
+      (error "Cannot retrieve TLS gopher selector: GnuTLS not available")))
+  (let* ((kill-buffer-query-functions nil)
+         (port (elpher-address-port address))
+         (host (elpher-address-host address))
+         (proc (open-network-stream "elpher-process"
+                                    nil
+                                    (if force-ipv4 (dns-query host) host)
+                                    (if (> port 0) port 70)
+                                    :type (if elpher-use-tls 'tls 'plain)
+                                    :nowait t))
+         (timer (run-at-time elpher-connection-timeout
+                             nil
+                             (lambda ()
+                               (message "timeout (status %s)" (process-status proc))
+                               (pcase (process-status proc)
+                                 ('failed
+                                  (if (and (not (equal (elpher-address-protocol address)
+                                                       "gophers"))
+                                           elpher-use-tls
+                                           (or elpher-auto-disengage-TLS
+                                               (yes-or-no-p "Could not establish encrypted connection.  Disable TLS mode?")))
+                                      (progn
+                                        (message "Disabling TLS mode.")
+                                        (setq elpher-use-tls nil)
+                                        (elpher-get-selector address renderer))))
+                                 ('connect
+                                  (elpher-process-cleanup)
+                                  (unless force-ipv4
+                                    (elpher-get-selector address renderer t))))))))
+    (set-process-coding-system proc 'binary)
+    (set-process-filter proc
+                        (lambda (_proc string)
+                          (message "filter")
+                          (cancel-timer timer)
+                          (setq elpher-selector-string
+                                (concat elpher-selector-string string))))
+    (set-process-sentinel proc
+                          (lambda (_proc event)
+                            (message "Event: %s" event)
+                            (cond
+                             ((string-prefix-p "deleted" event))
+                             ((string-prefix-p "open" event)
+                              (let ((inhibit-eol-conversion t))
+                                (process-send-string
+                                 proc
+                                 (concat (elpher-gopher-address-selector address)
+                                         "\r\n"))))
+                             (t
+                              (cancel-timer timer)
+                              (condition-case the-error
+                                  (progn
+                                    (funcall renderer elpher-selector-string)
+                                    (elpher-restore-pos))
+                                (error
+                                 (message "sentinel %s" the-error)
+                                 (elpher-network-error address the-error)))))))))
 
 (defun elpher-get-gopher-node (renderer)
   "Getter function for gopher nodes.
@@ -550,11 +570,7 @@ once they are retrieved from the gopher server."
          (elpher-restore-pos))
       (elpher-with-clean-buffer
        (insert "LOADING... (use 'u' to cancel)"))
-      (elpher-get-selector address
-                           (lambda (_proc event)
-                             (unless (string-prefix-p "deleted" event)
-                               (funcall renderer elpher-selector-string)
-                               (elpher-restore-pos)))))))
+      (elpher-get-selector address renderer))))
 
 ;; Index rendering
 
@@ -716,21 +732,19 @@ The response is rendered using the rendering function RENDERER."
 
             (elpher-with-clean-buffer
              (insert "LOADING RESULTS... (use 'u' to cancel)"))
-            (elpher-get-selector search-address
-                                 (lambda (_proc event)
-                                   (unless (string-prefix-p "deleted" event)
-                                     (funcall renderer elpher-selector-string)
-                                     (elpher-restore-pos)))))
+            (elpher-get-selector search-address renderer))
         (if aborted
             (elpher-visit-parent-node))))))
  
 ;; Raw server response rendering
 
-(defun elpher-render-raw (data &optional _mime-type-string)
-  "Display raw DATA in buffer.  MIME-TYPE-STRING is unused."
+(defun elpher-render-raw (data &optional mime-type-string)
+  "Display raw DATA in buffer.  MIME-TYPE-STRING is also displayed if provided."
   (if (not data)
       nil
     (elpher-with-clean-buffer
+     (when mime-type-string
+       (insert "MIME type specified by server: '" mime-type-string "'\n"))
      (insert data)
      (goto-char (point-min)))
     (message "Displaying raw server response.  Reload or redraw to return to standard view.")))
@@ -772,9 +786,10 @@ The response is rendered using the rendering function RENDERER."
 (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’."
+(defun elpher-get-gemini-response (address renderer &optional force-ipv4)
+  "Retrieve gemini ADDRESS, then render using RENDERER.
+If FORCE-IPV4 is non-nil, explicitly look up and use IPv4 address corresponding
+to ADDRESS."
   (setq elpher-gemini-response "")
   (if (not (gnutls-available-p))
       (error "Cannot establish gemini connection: GnuTLS not available")
@@ -782,20 +797,44 @@ The response is stored in the variable ‘elpher-gemini-response’."
         (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)
+                                          (if force-ipv4 (dns-query host) host)
                                           (if (> port 0) port 1965)
-                                          :type 'tls)))
+                                          :type 'tls
+                                          :nowait t))
+               (timer (run-at-time elpher-connection-timeout nil
+                                   (lambda ()
+                                     (elpher-process-cleanup)
+                                     (unless force-ipv4
+                                        ; Try again with IPv4
+                                       (elpher-get-gemini-response address renderer t))))))
           (set-process-coding-system proc 'binary)
           (set-process-filter proc
                               (lambda (_proc string)
+                                (cancel-timer timer)
                                 (setq elpher-gemini-response
                                       (concat elpher-gemini-response string))))
-          (set-process-sentinel proc after)
-          (let ((inhibit-eol-conversion t))
-            (process-send-string proc
-                                 (concat (elpher-address-to-url address) "\r\n"))))
+          (set-process-sentinel proc
+                                (lambda (proc event)
+                                  (cond
+                                   ((string-prefix-p "open" event)    ; request URL
+                                    (let ((inhibit-eol-conversion t))
+                                      (process-send-string
+                                       proc
+                                       (concat (elpher-address-to-url address)
+                                               "\r\n"))))
+                                   ((string-prefix-p "deleted" event)) ; do nothing
+                                   ((and (string-empty-p elpher-gemini-response)
+                                         (not force-ipv4))
+                                        ; Try again with IPv4
+                                    (cancel-timer timer)
+                                    (elpher-get-gemini-response address renderer t))
+                                   (t 
+                                    (funcall #'elpher-process-gemini-response
+                                             renderer)
+                                    (elpher-restore-pos))))))
       (error
        (error "Error initiating connection to server")))))
 
@@ -830,14 +869,8 @@ The response is assumed to be in the variable `elpher-gemini-response'."
              (let* ((query-string (read-string (concat response-meta ": ")))
                     (url (elpher-address-to-url (elpher-node-address elpher-current-node)))
                     (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)
-                                               (funcall #'elpher-process-gemini-response
-                                                        renderer)
-                                               (elpher-restore-pos))))))
+               (elpher-get-gemini-response query-address renderer)))
             (?2 ; Normal response
-             ;; (message response-header)
              (funcall renderer response-body response-meta))
             (?3 ; Redirect
              (message "Following redirect to %s" response-meta)
@@ -851,12 +884,7 @@ The response is assumed to be in the variable `elpher-gemini-response'."
                    (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)
-                                               (funcall #'elpher-process-gemini-response
-                                                        renderer)
-                                               (elpher-restore-pos))))))
+               (elpher-get-gemini-response redirect-address renderer)))
             (?4 ; Temporary failure
              (error "Gemini server reports TEMPORARY FAILURE for this request: %s %s"
                     response-code response-meta))
@@ -883,12 +911,7 @@ The response is assumed to be in the variable `elpher-gemini-response'."
           (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)
-                                          (funcall #'elpher-process-gemini-response
-                                                   renderer)
-                                          (elpher-restore-pos)))))
+          (elpher-get-gemini-response address renderer))
       (error
        (elpher-network-error address the-error)))))
 
@@ -918,6 +941,8 @@ The response is assumed to be in the variable `elpher-gemini-response'."
       (pcase mime-type
         ((or "text/gemini" "")
          (elpher-render-gemini-map body parameters))
+        ("text/html"
+         (elpher-render-html body))
         ((pred (string-prefix-p "text/"))
          (elpher-render-gemini-plain-text body parameters))
         ((pred (string-prefix-p "image/"))