Recognize Shift-Tab from a Linux virtual console.
[elpher.git] / elpher.el
index 5d393d6..2198acf 100644 (file)
--- a/elpher.el
+++ b/elpher.el
@@ -2,9 +2,9 @@
 
 ;; Copyright (C) 2019 Tim Vaughan
 
-;; Author: Tim Vaughan <timv@ughan.xyz>
+;; Author: Tim Vaughan <plugd@thelambdalab.xyz>
 ;; Created: 11 April 2019
-;; Version: 2.6.1
+;; Version: 2.7.4
 ;; Keywords: comm gopher
 ;; Homepage: http://thelambdalab.xyz/elpher
 ;; Package-Requires: ((emacs "26"))
@@ -70,7 +70,7 @@
 ;;; Global constants
 ;;
 
-(defconst elpher-version "2.6.1"
+(defconst elpher-version "2.7.4"
   "Current version of elpher.")
 
 (defconst elpher-margin-width 6
@@ -134,12 +134,12 @@ sequences."
   :type '(boolean))
 
 (defcustom elpher-gemini-TLS-cert-checks nil
-  "If non-nil, verify gemini server TLS certificates using the default
-emacs security protocol. Otherwise, certificate verification is disabled.
+  "If non-nil, verify gemini server TLS certs using the default security level.
+Otherwise, certificate verification is disabled.
 
 This defaults to off because it is standard practice for Gemini servers
 to use self-signed certificates, meaning that most servers provide what
-emacs considers to be an invalid certificate."
+EMACS considers to be an invalid certificate."
   :type '(boolean))
 
 (defcustom elpher-gemini-max-fill-width 80
@@ -148,6 +148,10 @@ The actual width used is the minimum of this value and the window width at
 the time when the text is rendered."
   :type '(integer))
 
+(defcustom elpher-bookmarks-file (locate-user-emacs-file "elpher-bookmarks")
+  "Specify the name of the file where elpher bookmarks will be saved."
+  :type '(file))
+
 ;; Face customizations
 
 (defgroup elpher-faces nil
@@ -208,15 +212,15 @@ the time when the text is rendered."
 
 (defface elpher-gemini-heading1
   '((t :inherit bold :height 1.8))
-  "Face used for brackets around directory margin key.")
+  "Face used for gemini heading level 1.")
 
 (defface elpher-gemini-heading2
   '((t :inherit bold :height 1.5))
-  "Face used for brackets around directory margin key.")
+  "Face used for gemini heading level 2.")
 
 (defface elpher-gemini-heading3
   '((t :inherit bold :height 1.2))
-  "Face used for brackets around directory margin key.")
+  "Face used for gemini heading level 3.")
 
 ;;; Model
 ;;
@@ -261,6 +265,7 @@ The basic attributes include: TYPE, SELECTOR, HOST and PORT.
 If the optional attribute TLS is non-nil, the address will be marked as
 requiring gopher-over-TLS."
   (cond
+   ((equal type ?i) nil)
    ((and (equal type ?h)
          (string-prefix-p "URL:" selector))
     (elpher-address-from-url (elt (split-string selector "URL:") 1)))
@@ -388,6 +393,10 @@ If no address is defined, returns 0.  (This is for compatibility with the URL li
   "Retrieve the address corresponding to PAGE."
   (elt page 1))
 
+(defun elpher-page-set-address (page new-address)
+  "Set the address corresponding to PAGE to NEW-ADDRESS."
+  (setcar (cdr page) new-address))
+
 (defvar elpher-current-page nil)
 (defvar elpher-history nil)
 
@@ -424,7 +433,7 @@ unless NO-HISTORY is non-nil."
   (let ((previous-page (pop elpher-history)))
     (if previous-page
         (elpher-visit-page previous-page nil t)
-      (error "No previous page."))))
+      (error "No previous page"))))
       
 (defun elpher-reload-current-page ()
   "Reload the current page, discarding any existing cached content."
@@ -541,6 +550,8 @@ to ADDRESS."
              (port (elpher-address-port address))
              (host (elpher-address-host address))
              (selector-string-parts nil)
+             (bytes-received 0)
+             (hkbytes-received 0)
              (proc (open-network-stream "elpher-process"
                                         nil
                                         (if force-ipv4 (dns-query host) host)
@@ -571,7 +582,21 @@ to ADDRESS."
         (set-process-coding-system proc 'binary)
         (set-process-filter proc
                             (lambda (_proc string)
-                              (cancel-timer timer)
+                              (when timer
+                                (cancel-timer timer)
+                                (setq timer nil))
+                              (setq bytes-received (+ bytes-received (length string)))
+                              (let ((new-hkbytes-received (/ bytes-received 102400)))
+                                (when (> new-hkbytes-received hkbytes-received)
+                                  (setq hkbytes-received new-hkbytes-received)
+                                  (with-current-buffer "*elpher*"
+                                    (let ((inhibit-read-only t))
+                                      (goto-char (point-min))
+                                      (beginning-of-line 2)
+                                      (delete-region (point) (point-max))
+                                      (insert "("
+                                              (number-to-string (/ hkbytes-received 10.0))
+                                              " MB read)")))))
                               (setq selector-string-parts
                                     (cons string selector-string-parts))))
         (set-process-sentinel proc
@@ -586,7 +611,9 @@ to ADDRESS."
                                          (concat (elpher-gopher-address-selector address)
                                                  "\r\n"))))
                                      (t
-                                      (cancel-timer timer)
+                                      (when timer
+                                        (cancel-timer timer)
+                                        (setq timer nil))
                                       (funcall renderer (apply #'concat
                                                                (reverse selector-string-parts)))
                                       (elpher-restore-pos)))
@@ -606,7 +633,7 @@ once they are retrieved from the gopher server."
          (insert content)
          (elpher-restore-pos))
       (elpher-with-clean-buffer
-       (insert "LOADING... (use 'u' to cancel)"))
+       (insert "LOADING... (use 'u' to cancel)\n"))
       (condition-case the-error
           (elpher-get-selector address renderer)
         (error
@@ -672,7 +699,7 @@ If ADDRESS is not supplied or nil the record is rendered as an
                               'follow-link t
                               'help-echo (elpher-page-button-help page)))
       (pcase type
-        ((or '(gopher ?i) 'nil) ;; Information
+        ('nil ;; Information
          (elpher-insert-margin)
          (let ((propertized-display-string
                 (propertize display-string 'face 'elpher-info)))
@@ -805,7 +832,9 @@ The response is rendered using the rendering function RENDERER."
   (if (not data)
       nil
     (let* ((address (elpher-page-address elpher-current-page))
-           (selector (elpher-gopher-address-selector address)))
+           (selector (if (elpher-address-gopher-p address)
+                         (elpher-gopher-address-selector address)
+                       (elpher-address-filename address))))
       (elpher-visit-previous-page) ; Do first in case of non-local exits.
       (let* ((filename-proposal (file-name-nondirectory selector))
              (filename (read-file-name "Download complete. Save file as: "
@@ -849,6 +878,8 @@ to ADDRESS."
                (port (elpher-address-port address))
                (host (elpher-address-host address))
                (response-string-parts nil)
+               (bytes-received 0)
+               (hkbytes-received 0)
                (proc (open-network-stream "elpher-process"
                                           nil
                                           (if force-ipv4 (dns-query host) host)
@@ -869,6 +900,18 @@ to ADDRESS."
                                 (when timer
                                   (cancel-timer timer)
                                   (setq timer nil))
+                                (setq bytes-received (+ bytes-received (length string)))
+                                (let ((new-hkbytes-received (/ bytes-received 102400)))
+                                  (when (> new-hkbytes-received hkbytes-received)
+                                    (setq hkbytes-received new-hkbytes-received)
+                                    (with-current-buffer "*elpher*"
+                                      (let ((inhibit-read-only t))
+                                        (goto-char (point-min))
+                                        (beginning-of-line 2)
+                                        (delete-region (point) (point-max))
+                                        (insert "("
+                                                (number-to-string (/ hkbytes-received 10.0))
+                                                " MB read)")))))
                                 (setq response-string-parts
                                       (cons string response-string-parts))))
           (set-process-sentinel proc
@@ -894,7 +937,7 @@ to ADDRESS."
                                                  renderer)
                                         (elpher-restore-pos)))
                                     (error
-                                           (elpher-network-error address the-error))))))
+                                     (elpher-network-error address the-error))))))
       (error
        (error "Error initiating connection to server")))))
 
@@ -940,6 +983,7 @@ that the response was malformed."
                              "gemini"))
                (error "Server tried to automatically redirect to non-gemini URL: %s"
                       response-meta))
+           (elpher-page-set-address elpher-current-page redirect-address)
            (add-to-list 'elpher-gemini-redirect-chain redirect-address)
            (elpher-get-gemini-response redirect-address renderer)))
         (?4 ; Temporary failure
@@ -964,7 +1008,7 @@ that the response was malformed."
               (insert content)
               (elpher-restore-pos))
           (elpher-with-clean-buffer
-           (insert "LOADING GEMINI... (use 'u' to cancel)"))
+           (insert "LOADING GEMINI... (use 'u' to cancel)\n"))
           (setq elpher-gemini-redirect-chain nil)
           (elpher-get-gemini-response address renderer))
       (error
@@ -1003,19 +1047,25 @@ that the response was malformed."
         ((pred (string-prefix-p "image/"))
          (elpher-render-image body))
         (_other
-         (error "Unsupported MIME type %S" mime-type))))))
-
-(defun elpher-gemini-get-link-url (line)
-  "Extract the url portion of LINE, a gemini map file link line."
-  (string-trim (elt (split-string (substring line 2)) 0)))
-
-(defun elpher-gemini-get-link-display-string (line)
-  "Extract the display string portion of LINE, a gemini map file link line."
-  (let* ((rest (string-trim (elt (split-string line "=>") 1)))
+         (elpher-render-download body))))))
+
+(defun elpher-gemini-get-link-url (link-line)
+  "Extract the url portion of LINK-LINE, a gemini map file link line.
+Returns nil in the event that the contents of the line following the
+=> prefix are empty."
+  (let ((l (split-string (substring link-line 2))))
+    (if l
+        (string-trim (elt l 0))
+      nil)))
+
+(defun elpher-gemini-get-link-display-string (link-line)
+  "Extract the display string portion of LINK-LINE, a gemini map file link line.
+Returns the url portion in the event that the display-string portion is empty."
+  (let* ((rest (string-trim (elt (split-string link-line "=>") 1)))
          (idx (string-match "[ \t]" rest)))
-    (if idx
-        (string-trim (substring rest (+ idx 1)))
-      "")))
+    (string-trim (if idx
+                     (substring rest (+ idx 1))
+                   rest))))
 
 (defun elpher-collapse-dot-sequences (filename)
   "Collapse dot sequences in FILENAME.
@@ -1052,29 +1102,29 @@ For instance, the filename /a/b/../c/./d will reduce to /a/c/d"
     address))
 
 (defun elpher-gemini-insert-link (link-line)
-  "Insert link into a text/gemini document."
+  "Insert link described by LINK-LINE into a text/gemini document."
   (let* ((url (elpher-gemini-get-link-url link-line))
-         (display-string (let ((s (elpher-gemini-get-link-display-string link-line)))
-                           (if (string-empty-p s) url s)))
+         (display-string (elpher-gemini-get-link-display-string link-line))
          (address (elpher-address-from-gemini-url url))
          (type (if address (elpher-address-type address) nil))
          (type-map-entry (cdr (assoc type elpher-type-map))))
-    (insert "→ ")
-    (if type-map-entry
-        (let* ((face (elt type-map-entry 3))
-               (filtered-display-string (ansi-color-filter-apply display-string))
-               (page (elpher-make-page filtered-display-string address)))
-          (insert-text-button filtered-display-string
-                              'face face
-                              'elpher-page page
-                              'action #'elpher-click-link
-                              'follow-link t
-                              'help-echo (elpher-page-button-help page)))
-      (insert (propertize display-string 'face 'elpher-unknown)))
-    (insert "\n")))
+    (when display-string
+      (insert "→ ")
+      (if type-map-entry
+          (let* ((face (elt type-map-entry 3))
+                 (filtered-display-string (ansi-color-filter-apply display-string))
+                 (page (elpher-make-page filtered-display-string address)))
+            (insert-text-button filtered-display-string
+                                'face face
+                                'elpher-page page
+                                'action #'elpher-click-link
+                                'follow-link t
+                                'help-echo (elpher-page-button-help page)))
+        (insert (propertize display-string 'face 'elpher-unknown)))
+      (insert "\n"))))
   
 (defun elpher-gemini-insert-header (header-line)
-  "Insert header into a text/gemini document.
+  "Insert header described by HEADER-LINE into a text/gemini document.
 The gemini map file line describing the header is given
 by HEADER-LINE."
   (when (string-match "^\\(#+\\)[ \t]*" header-line)
@@ -1083,11 +1133,11 @@ by HEADER-LINE."
       (unless (display-graphic-p)
         (insert (make-string level ?#) " "))
       (insert (propertize header 'face
-                          (case level
-                            ((1) 'elpher-gemini-heading1)
-                            ((2) 'elpher-gemini-heading2)
-                            ((3) 'elpher-gemini-heading3)
-                            (t 'default)))
+                          (pcase level
+                            (1 'elpher-gemini-heading1)
+                            (2 'elpher-gemini-heading2)
+                            (3 'elpher-gemini-heading3)
+                            (_ 'default)))
               "\n"))))
 
 (defun elpher-render-gemini-map (data _parameters)
@@ -1126,7 +1176,7 @@ by HEADER-LINE."
          (insert content)
          (elpher-restore-pos))
       (elpher-with-clean-buffer
-       (insert "LOADING... (use 'u' to cancel)"))
+       (insert "LOADING... (use 'u' to cancel)\n"))
       (condition-case the-error
           (let* ((kill-buffer-query-functions nil)
                  (user (let ((filename (elpher-address-filename address)))
@@ -1156,7 +1206,9 @@ by HEADER-LINE."
             (set-process-coding-system proc 'binary)
             (set-process-filter proc
                                 (lambda (_proc string)
-                                  (cancel-timer timer)
+                                  (when timer
+                                    (cancel-timer timer)
+                                    (setq timer nil))
                                   (setq selector-string-parts
                                         (cons string selector-string-parts))))
             (set-process-sentinel proc
@@ -1170,7 +1222,9 @@ by HEADER-LINE."
                                              proc
                                              (concat user "\r\n"))))
                                          (t
-                                          (cancel-timer timer)
+                                          (when timer
+                                            (cancel-timer timer)
+                                            (setq timer nil))
                                           (funcall renderer (apply #'concat
                                                                    (reverse selector-string-parts)))
                                           (elpher-restore-pos)))))))
@@ -1299,7 +1353,7 @@ by HEADER-LINE."
            "- a: rename selected bookmark\n"
            "\n"
            "Bookmarks are stored in the file ")
-   (let ((filename (locate-user-emacs-file "elpher-bookmarks"))
+   (let ((filename elpher-bookmarks-file)
          (help-string "RET,mouse-1: Open bookmarks file in new buffer for editing."))
      (insert-text-button filename
                          'face 'link
@@ -1336,7 +1390,7 @@ bookmark list, while URL is the url of the entry."
 (defun elpher-save-bookmarks (bookmarks)
   "Record the bookmark list BOOKMARKS to the user's bookmark file.
 Beware that this completely replaces the existing contents of the file."
-  (with-temp-file (locate-user-emacs-file "elpher-bookmarks")
+  (with-temp-file elpher-bookmarks-file
     (erase-buffer)
     (insert "; Elpher bookmarks file\n\n"
             "; Bookmarks are stored as a list of (label URL) items.\n"
@@ -1349,7 +1403,7 @@ Beware that this completely replaces the existing contents of the file."
   (let ((bookmarks
          (with-temp-buffer
            (ignore-errors
-             (insert-file-contents (locate-user-emacs-file "elpher-bookmarks"))
+             (insert-file-contents elpher-bookmarks-file)
              (goto-char (point-min))
              (read (current-buffer))))))
     (if (and bookmarks (listp (cadar bookmarks)))
@@ -1639,6 +1693,7 @@ When run interactively HOST-OR-URL is read from the minibuffer."
   (let ((map (make-sparse-keymap)))
     (define-key map (kbd "TAB") 'elpher-next-link)
     (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 [mouse-3] 'elpher-back)
     (define-key map (kbd "O") 'elpher-root-dir)