Made bookmarks file location customizable.
[elpher.git] / elpher.el
index ddcf10a..99178a0 100644 (file)
--- a/elpher.el
+++ b/elpher.el
@@ -4,7 +4,7 @@
 
 ;; Author: Tim Vaughan <timv@ughan.xyz>
 ;; Created: 11 April 2019
-;; Version: 2.7.0
+;; Version: 2.7.2
 ;; Keywords: comm gopher
 ;; Homepage: http://thelambdalab.xyz/elpher
 ;; Package-Requires: ((emacs "26"))
@@ -70,7 +70,7 @@
 ;;; Global constants
 ;;
 
-(defconst elpher-version "2.7.0"
+(defconst elpher-version "2.7.2"
   "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
@@ -388,6 +392,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 +432,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."
@@ -940,6 +948,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
@@ -1005,17 +1014,23 @@ that the response was malformed."
         (_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)))
+(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 +1067,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 +1098,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)
@@ -1299,7 +1314,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 +1351,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-boomarks-file
     (erase-buffer)
     (insert "; Elpher bookmarks file\n\n"
             "; Bookmarks are stored as a list of (label URL) items.\n"
@@ -1349,7 +1364,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)))