Added support for download-only binary entries.
[elpher.git] / elopher.el
index bcb528d..dfb5c77 100644 (file)
@@ -16,7 +16,8 @@
   "Width of left-hand margin used when rendering indicies.")
 
 (defconst elopher-start-index
-  (mapconcat 'identity
+  (mapconcat
+   'identity
    (list "i\tfake\tfake\t1"
          "i--------------------------------------------\tfake\tfake\t1"
          "i          Elopher Gopher Client             \tfake\tfake\t1"
@@ -30,7 +31,8 @@
          "i - u: return to parent directory entry\tfake\tfake\t1"
          "i - g: go to a particular page\tfake\tfake\t1"
          "i - r: reload current page\tfake\tfake\t1"
-         "i - t: display the current page as text (i.e. \"source\")\tfake\tfake\t1"
+         "i - d: download directory entry under cursor\tfake\tfake\t1"
+         "i - w: display the raw server response for the current page\tfake\tfake\t1"
          "i\tfake\tfake\t1"
          "iPlaces to start exploring Gopherspace:\tfake\tfake\t1"
          "i\tfake\tfake\t1"
   "Face used for image records."
   :type '(face))
 
+(defcustom elopher-binary-face '(foreground-color . "magenta")
+  "Face used for image records."
+  :type '(face))
+
 (defcustom elopher-unknown-face '(foreground-color . "red")
   "Face used for unknown record types."
   :type '(face))
@@ -141,11 +147,12 @@ Otherwise, use the system browser via the BROWSE-URL function."
 
 (defvar elopher-current-node)
 
-(defun elopher-visit-node (node &optional raw)
+(defun elopher-visit-node (node &optional getter)
   (elopher-save-pos)
+  (elopher-process-cleanup)
   (setq elopher-current-node node)
-  (if raw
-      (elopher-get-node-raw)
+  (if getter
+      (funcall getter)
     (funcall (elopher-node-getter node))))
 
 (defun elopher-visit-parent-node ()
@@ -161,6 +168,7 @@ Otherwise, use the system browser via the BROWSE-URL function."
 ;;
 
 (defmacro elopher-with-clean-buffer (&rest args)
+  "Evaluate ARGS with a clean *elopher* buffer as current."
   (list 'progn
         '(switch-to-buffer "*elopher*")
         '(elopher-mode)
@@ -201,10 +209,10 @@ Otherwise, use the system browser via the BROWSE-URL function."
          (help-string (format "mouse-1, RET: open %s on %s port %s"
                               selector host port)))
     (pcase type
-      (?i (elopher-insert-margin)
+      (?i (elopher-insert-margin)                             ; Information 
           (insert (propertize display-string
                               'face elopher-info-face)))
-      (?0 (elopher-insert-margin "T")
+      (?0 (elopher-insert-margin "T")                         ; Text
           (insert-text-button display-string
                               'face elopher-text-face
                               'elopher-node (elopher-make-node elopher-current-node
@@ -213,7 +221,7 @@ Otherwise, use the system browser via the BROWSE-URL function."
                               'action #'elopher-click-link
                               'follow-link t
                               'help-echo help-string))
-      (?1 (elopher-insert-margin "/")
+      (?1 (elopher-insert-margin "/")                         ; Index
           (insert-text-button display-string
                               'face elopher-index-face
                               'elopher-node (elopher-make-node elopher-current-node
@@ -222,21 +230,30 @@ Otherwise, use the system browser via the BROWSE-URL function."
                               'action #'elopher-click-link
                               'follow-link t
                               'help-echo help-string))
-      ((or ?g ?p ?I) (elopher-insert-margin "im")
-          (insert-text-button display-string
-                              'face elopher-image-face
-                              'elopher-node (elopher-make-node elopher-current-node
-                                                               address
-                                                               #'elopher-get-image-node)
-                              'action #'elopher-click-link
-                              'follow-link t
-                              'help-echo help-string))
+      ((or ?g ?p ?I) (elopher-insert-margin "im")             ; Image
+       (insert-text-button display-string
+                           'face elopher-image-face
+                           'elopher-node (elopher-make-node elopher-current-node
+                                                            address
+                                                            #'elopher-get-image-node)
+                           'action #'elopher-click-link
+                           'follow-link t
+                           'help-echo help-string))
+      ((or ?4 ?9) (elopher-insert-margin "B")                 ; Binary
+       (insert-text-button display-string
+                           'face elopher-binary-face
+                           'elopher-node (elopher-make-node elopher-current-node
+                                                            address
+                                                            #'elopher-get-node-download)
+                           'action #'elopher-click-link
+                           'follow-link t
+                           'help-echo help-string))
       (?7 (elopher-insert-margin "S")
           (insert-text-button display-string
                               'face elopher-search-face
                               'elopher-node (elopher-make-node elopher-current-node
-                                                              address
-                                                              #'elopher-get-search-node)
+                                                               address
+                                                               #'elopher-get-search-node)
                               'action #'elopher-click-link
                               'follow-link t
                               'help-echo help-string))
@@ -258,14 +275,17 @@ Otherwise, use the system browser via the BROWSE-URL function."
 ;;; Selector retrieval (all kinds)
 ;;
 
+(defun elopher-process-cleanup ()
+  "Immediately shut down any extant elopher process."
+  (let ((p (get-process "elopher-process")))
+    (if p (delete-process p))))
+
 (defvar elopher-selector-string)
 
 (defun elopher-get-selector (address after)
   "Retrieve selector specified by ADDRESS, then execute AFTER.
 The result is stored as a string in the variable elopher-selector-string."
   (setq elopher-selector-string "")
-  (let ((p (get-process "elopher-process")))
-    (if p (delete-process p)))
   (make-network-process
    :name "elopher-process"
    :host (elopher-address-host address)
@@ -284,24 +304,23 @@ The result is stored as a string in the variable elopher-selector-string."
     (if content
         (progn
           (elopher-with-clean-buffer
-            (insert content))
+           (insert content))
           (elopher-restore-pos))
       (if address
           (progn
             (elopher-with-clean-buffer
              (insert "LOADING DIRECTORY..."))
-            ;; (let ((inhibit-read-only t))
-              ;; (insert "LOADING DIRECTORY..."))
             (elopher-get-selector address
                                   (lambda (proc event)
-                                    (elopher-with-clean-buffer
-                                      (elopher-insert-index elopher-selector-string))
-                                    (elopher-restore-pos)
-                                    (elopher-set-node-content elopher-current-node
-                                                              (buffer-string)))))
+                                    (unless (string-prefix-p "deleted" event)
+                                      (elopher-with-clean-buffer
+                                       (elopher-insert-index elopher-selector-string))
+                                      (elopher-restore-pos)
+                                      (elopher-set-node-content elopher-current-node
+                                                                (buffer-string))))))
         (progn
           (elopher-with-clean-buffer
-            (elopher-insert-index elopher-start-index))
+           (elopher-insert-index elopher-start-index))
           (elopher-restore-pos)
           (elopher-set-node-content elopher-current-node
                                     (buffer-string)))))))
@@ -318,18 +337,19 @@ The result is stored as a string in the variable elopher-selector-string."
     (if content
         (progn
           (elopher-with-clean-buffer
-            (insert content))
+           (insert content))
           (elopher-restore-pos))
       (progn
         (elopher-with-clean-buffer
-          (insert "LOADING TEXT..."))
+         (insert "LOADING TEXT..."))
         (elopher-get-selector address
                               (lambda (proc event)
-                                (elopher-with-clean-buffer
-                                  (insert (elopher-process-text elopher-selector-string)))
-                                (elopher-restore-pos)
-                                (elopher-set-node-content elopher-current-node
-                                                          (buffer-string))))))))
+                                (unless (string-prefix-p "deleted" event)
+                                  (elopher-with-clean-buffer
+                                   (insert (elopher-process-text elopher-selector-string)))
+                                  (elopher-restore-pos)
+                                  (elopher-set-node-content elopher-current-node
+                                                            (buffer-string)))))))))
 
 ;; Image retrieval
 
@@ -339,22 +359,24 @@ The result is stored as a string in the variable elopher-selector-string."
     (if content
         (progn
           (elopher-with-clean-buffer
-            (insert-image content))
+           (insert-image content))
           (setq cursor-type nil)
           (elopher-restore-pos))
       (progn
         (elopher-with-clean-buffer
-          (insert "LOADING IMAGE..."))
+         (insert "LOADING IMAGE..."))
         (elopher-get-selector address
                               (lambda (proc event)
-                                (let ((image (create-image
-                                              (string-as-unibyte elopher-selector-string)
-                                              nil t)))
-                                  (elopher-with-clean-buffer
-                                   (insert-image image))
-                                  (setq cursor-type nil)
-                                  (elopher-restore-pos)
-                                  (elopher-set-node-content elopher-current-node image))))))))
+                                (unless (string-prefix-p "deleted" event)
+                                  (let ((image (create-image
+                                                (string-as-unibyte elopher-selector-string)
+                                                nil t)))
+                                    (elopher-with-clean-buffer
+                                     (insert-image image))
+                                    (setq cursor-type nil)
+                                    (elopher-restore-pos)
+                                    (elopher-set-node-content elopher-current-node
+                                                              image)))))))))
 
 ;; Search retrieval
 
@@ -366,7 +388,7 @@ The result is stored as a string in the variable elopher-selector-string."
           (elopher-with-clean-buffer
             (insert content))
           (elopher-restore-pos)
-          (message "Displaying cached search results. Reload to perform a new search."))
+          (message "Displaying cached search results.  Reload to perform a new search."))
       (let* ((query-string (read-string "Query: "))
              (query-selector (concat (elopher-address-selector address) "\t" query-string))
              (search-address (elopher-make-address query-selector
@@ -376,11 +398,14 @@ The result is stored as a string in the variable elopher-selector-string."
          (insert "LOADING RESULTS..."))
         (elopher-get-selector search-address
                               (lambda (proc event)
-                                (elopher-with-clean-buffer
-                                  (elopher-insert-index elopher-selector-string))
-                                (goto-char (point-min))
-                                (elopher-set-node-content elopher-current-node
-                                                          (buffer-string))))))))
+                                (unless (string-prefix-p "deleted" event)
+                                  (elopher-with-clean-buffer
+                                   (elopher-insert-index elopher-selector-string))
+                                  (goto-char (point-min))
+                                  (elopher-set-node-content elopher-current-node
+                                                            (buffer-string)))))))))
+
+;; Raw server response retrieval
 
 (defun elopher-get-node-raw ()
   (let* ((content (elopher-node-content elopher-current-node))
@@ -390,9 +415,10 @@ The result is stored as a string in the variable elopher-selector-string."
     (if address
         (elopher-get-selector address
                               (lambda (proc event)
-                                (elopher-with-clean-buffer
-                                 (insert elopher-selector-string))
-                                (goto-char (point-min))))
+                                (unless (string-prefix-p "deleted" event)
+                                  (elopher-with-clean-buffer
+                                   (insert elopher-selector-string))
+                                  (goto-char (point-min)))))
       (progn
         (elopher-with-clean-buffer
          (insert elopher-start-index))
@@ -400,6 +426,32 @@ The result is stored as a string in the variable elopher-selector-string."
   (message "Displaying raw server response.  Reload to return to standard view."))
  
 
+;; File export retrieval
+
+(defvar elopher-download-filename)
+
+(defun elopher-get-node-download ()
+  (let* ((address (elopher-node-address elopher-current-node))
+         (selector (elopher-address-selector address)))
+    (unwind-protect
+        (let* ((filename-proposal (file-name-nondirectory selector))
+               (filename (read-file-name "Save file as: "
+                                         nil nil nil
+                                         (if (> (length filename-proposal) 0)
+                                             filename-proposal
+                                           "gopher.file"))))
+          (message "Downloading...")
+          (setq elopher-download-filename filename)
+          (elopher-get-selector address
+                                (lambda (proc event)
+                                  (let ((coding-system-for-write 'binary))
+                                    (with-temp-file elopher-download-filename
+                                      (insert elopher-selector-string)))
+                                  (message (format "Download complate, saved to file %s."
+                                                   elopher-download-filename)))))
+      (elopher-visit-parent-node))))
+        
+
 ;;; Navigation procedures
 ;;
 
@@ -446,7 +498,8 @@ The result is stored as a string in the variable elopher-selector-string."
 (defun elopher-view-raw ()
   "View current page as plain text."
   (interactive)
-  (elopher-visit-node elopher-current-node t))
+  (elopher-visit-node elopher-current-node
+                      #'elopher-get-node-raw))
 
 (defun elopher-back ()
   "Go to previous site."
@@ -455,6 +508,15 @@ The result is stored as a string in the variable elopher-selector-string."
       (elopher-visit-parent-node)
     (message "No previous site.")))
 
+(defun elopher-download ()
+  "Download the link at point."
+  (interactive)
+  (let ((button (button-at (point))))
+    (if button
+        (elopher-visit-node (button-get button 'elopher-node)
+                            #'elopher-get-node-download)
+      (message "No link selected."))))
+
 
 ;;; Mode and keymap
 ;;
@@ -467,6 +529,7 @@ The result is stored as a string in the variable elopher-selector-string."
     (define-key map (kbd "g") 'elopher-go)
     (define-key map (kbd "r") 'elopher-reload)
     (define-key map (kbd "w") 'elopher-view-raw)
+    (define-key map (kbd "d") 'elopher-download)
     (when (fboundp 'evil-define-key)
       (evil-define-key 'normal map
         (kbd "C-]") 'elopher-follow-closest-link
@@ -474,7 +537,8 @@ The result is stored as a string in the variable elopher-selector-string."
         (kbd "u") 'elopher-back
         (kbd "g") 'elopher-go
         (kbd "r") 'elopher-reload
-        (kbd "w") 'elopher-view-raw))
+        (kbd "w") 'elopher-view-raw
+        (kbd "d") 'elopher-download))
     map)
   "Keymap for gopher client.")
 
@@ -484,12 +548,14 @@ The result is stored as a string in the variable elopher-selector-string."
 
 ;;; Main start procedure
 ;;
+
 (defun elopher ()
   "Start elopher with default landing page."
   (interactive)
   (setq elopher-current-node nil)
   (let ((start-node (elopher-make-node nil nil #'elopher-get-index-node)))
-    (elopher-visit-node start-node)))
+    (elopher-visit-node start-node))
+  "Started Elopher.") ; Otherwise (elopher) evaluates to start page string.
 
 ;;; elopher.el ends here