Slight refactor following merge, linting.
[elpher.git] / elpher.el
index b2db2b4..d74b655 100644 (file)
--- a/elpher.el
+++ b/elpher.el
@@ -4,7 +4,7 @@
 
 ;; Author: Tim Vaughan <plugd@thelambdalab.xyz>
 ;; Created: 11 April 2019
-;; Version: 2.7.8
+;; Version: 2.7.9
 ;; Keywords: comm gopher
 ;; Homepage: http://thelambdalab.xyz/elpher
 ;; Package-Requires: ((emacs "26"))
@@ -70,7 +70,7 @@
 ;;; Global constants
 ;;
 
-(defconst elpher-version "2.7.8"
+(defconst elpher-version "2.7.9"
   "Current version of elpher.")
 
 (defconst elpher-margin-width 6
@@ -161,6 +161,12 @@ May be empty."
   "Specify the name of the file where elpher bookmarks will be saved."
   :type '(file))
 
+(defcustom elpher-ipv4-always nil
+  "If non-nil, elpher will always use IPv4 to establish network connections.
+This can be useful when browsing from a computer that supports IPv6, because
+some servers which do not support IPv6 can take a long time to time-out."
+  :type '(boolean))
+
 ;; Face customizations
 
 (defgroup elpher-faces nil
@@ -558,6 +564,7 @@ to ADDRESS."
       (error "Cannot retrieve TLS gopher selector: GnuTLS not available")))
   (unless (< (elpher-address-port address) 65536)
     (error "Cannot retrieve gopher selector: port number > 65536"))
+  (defvar gnutls-verify-error)
   (condition-case nil
       (let* ((kill-buffer-query-functions nil)
              (gnutls-verify-error nil) ; We use the NSM for verification
@@ -568,7 +575,9 @@ to ADDRESS."
              (hkbytes-received 0)
              (proc (open-network-stream "elpher-process"
                                         nil
-                                        (if force-ipv4 (dns-query host) host)
+                                        (if (or elpher-ipv4-always force-ipv4)
+                                            (dns-query host)
+                                          host)
                                         (if (> port 0) port 70)
                                         :type (if elpher-use-tls 'tls 'plain)
                                         :nowait t))
@@ -589,7 +598,7 @@ to ADDRESS."
                                         (elpher-network-error address "Could not establish encrypted connection")))
                                      ('connect
                                       (elpher-process-cleanup)
-                                      (unless force-ipv4
+                                      (unless (or elpher-ipv4-always force-ipv4)
                                         (message "Connection timed out. Retrying with IPv4 address.")
                                         (elpher-get-selector address renderer t))))))))
         (setq elpher-network-timer timer)
@@ -894,6 +903,7 @@ to ADDRESS."
       (error "Cannot establish gemini connection: GnuTLS not available")
     (unless (< (elpher-address-port address) 65536)
       (error "Cannot establish gemini connection: port number > 65536"))
+    (defvar gnutls-verify-error)
     (condition-case nil
         (let* ((kill-buffer-query-functions nil)
                (gnutls-verify-error nil) ; We use the NSM for verification
@@ -904,14 +914,16 @@ to ADDRESS."
                (hkbytes-received 0)
                (proc (open-network-stream "elpher-process"
                                           nil
-                                          (if force-ipv4 (dns-query host) host)
+                                          (if (or elpher-ipv4-always force-ipv4)
+                                              (dns-query host)
+                                            host)
                                           (if (> port 0) port 1965)
                                           :type 'tls
                                           :nowait t))
                (timer (run-at-time elpher-connection-timeout nil
                                    (lambda ()
                                      (elpher-process-cleanup)
-                                     (unless force-ipv4
+                                     (unless (or elpher-ipv4-always force-ipv4)
                                         ; Try again with IPv4
                                        (message "Connection timed out.  Retrying with IPv4.")
                                        (elpher-get-gemini-response address renderer t))))))
@@ -948,7 +960,7 @@ to ADDRESS."
                                                    "\r\n"))))
                                        ((string-prefix-p "deleted" event)) ; do nothing
                                        ((and (not response-string-parts)
-                                             (not force-ipv4))
+                                             (not (or elpher-ipv4-always force-ipv4)))
                                         ; Try again with IPv4
                                         (message "Connection failed. Retrying with IPv4.")
                                         (cancel-timer timer)
@@ -1210,7 +1222,11 @@ width defined by elpher-gemini-max-fill-width."
 ;; Finger page connection
 
 (defun elpher-get-finger-page (renderer &optional force-ipv4)
-  "Opens a finger connection to the current page address and renders it using RENDERER."
+  "Opens a finger connection to the current page address.
+The result is rendered using RENDERER.  When the optional argument
+FORCE-IPV4 or the variable `elpher-ipv4-always' are non-nil, the
+IPv4 address returned by a DNS lookup will be used explicitly in
+making the connection."
   (let* ((address (elpher-page-address elpher-current-page))
          (content (elpher-get-cached-content address)))
     (if (and content (funcall renderer nil))
@@ -1231,7 +1247,9 @@ width defined by elpher-gemini-max-fill-width."
                  (selector-string-parts nil)
                  (proc (open-network-stream "elpher-process"
                                             nil
-                                            (if force-ipv4 (dns-query host) host)
+                                            (if (or elpher-ipv4-always force-ipv4)
+                                                (dns-query host)
+                                              host)
                                             port
                                             :type 'plain
                                             :nowait t))
@@ -1241,7 +1259,7 @@ width defined by elpher-gemini-max-fill-width."
                                        (pcase (process-status proc)
                                          ('connect
                                           (elpher-process-cleanup)
-                                          (unless force-ipv4
+                                          (unless (or elpher-ipv4-always force-ipv4)
                                             (message "Connection timed out. Retrying with IPv4 address.")
                                             (elpher-get-finger-page renderer t))))))))
             (setq elpher-network-timer timer)
@@ -1255,7 +1273,7 @@ width defined by elpher-gemini-max-fill-width."
                                         (cons string selector-string-parts))))
             (set-process-sentinel proc
                                   (lambda (_proc event)
-                                    (condition-case the-error
+                                    (condition-case _the-error
                                         (cond
                                          ((string-prefix-p "deleted" event))
                                          ((string-prefix-p "open" event)
@@ -1323,7 +1341,7 @@ width defined by elpher-gemini-max-fill-width."
            " - TAB/Shift-TAB: next/prev item on current page\n"
            " - RET/mouse-1: open item under cursor\n"
            " - m: select an item on current page by name (autocompletes)\n"
-           " - u/mouse-3: return to previous page\n"
+           " - u/mouse-3/U: return to previous page or to the start page\n"
            " - o/O: visit different selector or the root menu of the current server\n"
            " - g: go to a particular address (gopher, gemini, finger)\n"
            " - d/D: download item under cursor or current page\n"
@@ -1552,6 +1570,15 @@ When run interactively HOST-OR-URL is read from the minibuffer."
   (interactive)
   (elpher-visit-previous-page))
 
+(defun elpher-back-to-start ()
+  "Go all the way back to the start page."
+  (interactive)
+  (setq elpher-current-page nil)
+  (setq elpher-history nil)
+  (let ((start-page (elpher-make-page "Elpher Start Page"
+                                      (elpher-make-special-address 'start))))
+    (elpher-visit-page start-page)))
+
 (defun elpher-download ()
   "Download the link at point."
   (interactive)
@@ -1741,6 +1768,7 @@ When run interactively HOST-OR-URL is read from the minibuffer."
     (define-key map (kbd "<backtab>") 'elpher-prev-link)
     (define-key map (kbd "C-M-i") 'elpher-prev-link)
     (define-key map (kbd "u") 'elpher-back)
+    (define-key map (kbd "U") 'elpher-back-to-start)
     (define-key map [mouse-3] 'elpher-back)
     (define-key map (kbd "O") 'elpher-root-dir)
     (define-key map (kbd "g") 'elpher-go)
@@ -1768,6 +1796,7 @@ When run interactively HOST-OR-URL is read from the minibuffer."
         (kbd "C-") 'elpher-follow-current-link
         (kbd "C-t") 'elpher-back
         (kbd "u") 'elpher-back
+        (kbd "U") 'elpher-back-to-start
         [mouse-3] 'elpher-back
         (kbd "g") 'elpher-go
         (kbd "o") 'elpher-go-current