X-Git-Url: https://thelambdalab.xyz/gitweb/index.cgi?a=blobdiff_plain;f=elpher.el;h=c0e67b1c1dbebfa4c8c027c9ce0b1b9833697e1a;hb=db31caf9497df363987edba1d18f9c8132a28012;hp=a0b5b39739a64960e53ae155d3403a1ed736b44a;hpb=c5405455022abcf3bd2f1f1e888c45089e3c3bde;p=elpher.git

diff --git a/elpher.el b/elpher.el
index a0b5b39..c0e67b1 100644
--- a/elpher.el
+++ b/elpher.el
@@ -103,8 +103,10 @@
     (?I elpher-get-image-node "im" elpher-image)
     (?4 elpher-get-node-download "B" elpher-binary)
     (?5 elpher-get-node-download "B" elpher-binary)
+    (?7 elpher-get-search-node "?" elpher-search)
+    (?8 elpher-get-telnet-node "?" elpher-telnet)
     (?9 elpher-get-node-download "B" elpher-binary)
-    (?7 elpher-get-search-node "?" elpher-search))
+    (?h elpher-get-url-node "W" elpher-url))
   "Association list from types to getters, margin codes and index faces.")
 
 
@@ -141,6 +143,10 @@
   '((t :inherit org-level-6))
   "Face used for url type directory records.")
 
+(defface elpher-telnet
+  '((t :inherit org-level-6))
+  "Face used for telnet type directory records.")
+
 (defface elpher-binary
   '((t :inherit org-level-7))
   "Face used for binary type directory records.")
@@ -190,15 +196,15 @@ use as the start page."
 
 (defun elpher-address-selector (address)
   "Retrieve selector from ADDRESS."
-  (car address))
+  (elt address 0))
 
 (defun elpher-address-host (address)
   "Retrieve host from ADDRESS."
-  (cadr address))
+  (elt address 1))
 
 (defun elpher-address-port (address)
   "Retrieve port from ADDRESS."
-  (caddr address))
+  (elt address 2))
 
 ;; Node
 
@@ -315,6 +321,17 @@ content and cursor position fields of the node."
         (insert " "))
     (insert (make-string elpher-margin-width ?\s))))
 
+(defun elpher-node-button-help (node)
+  "Return a string containing the help text for a button corresponding to NODE."
+  (let ((address (elpher-node-address node)))
+    (if (eq (elpher-node-getter node) #'elpher-get-url-node)
+        (let ((url (cadr (split-string (elpher-address-selector address) "URL:"))))
+          (format "mouse-1, RET: open url '%s'" url))
+      (format "mouse-1, RET: open '%s' on %s port %s"
+              (elpher-address-selector address)
+              (elpher-address-host address)
+              (elpher-address-port address)))))
+
 (defun elpher-insert-index-record (line)
   "Insert the index record corresponding to LINE into the current buffer."
   (let* ((type (elt line 0))
@@ -322,27 +339,32 @@ content and cursor position fields of the node."
          (display-string (elt fields 0))
          (selector (elt fields 1))
          (host (elt fields 2))
-         (port (elt fields 3)))
+         (port (string-to-number (elt fields 3))))
     (elpher-insert-index-record-helper type display-string selector host port)))
 
 (defun elpher-insert-index-record-helper (type display-string selector host port)
+  "Helper function to insert an index record into the current buffer.
+The contents of the record are dictated by TYPE, DISPLAY-STRING, SELECTOR, HOST
+and PORT.
+
+This function is essentially the second half of `elpher-insert-index-record',
+but broken out so that it can be used by other functions to construct indices
+on the fly."
   (let ((address (elpher-make-address selector host port))
         (type-map-entry (alist-get type elpher-type-map)))
     (if type-map-entry
-        (let ((getter (car type-map-entry))
-              (margin-code (cadr type-map-entry))
-              (face (caddr type-map-entry)))
+        (let* ((getter (car type-map-entry))
+               (margin-code (cadr type-map-entry))
+               (face (caddr type-map-entry))
+               (node (elpher-make-node elpher-current-node address getter)))
           (elpher-insert-margin margin-code)
           (insert-text-button display-string
                               'face face
-                              'elpher-node (elpher-make-node elpher-current-node
-                                                               address
-                                                               getter)
+                              'elpher-node node
                               'elpher-node-type type
                               'action #'elpher-click-link
                               'follow-link t
-                              'help-echo (format "mouse-1, RET: open '%s' on %s port %s"
-                                                 selector host port)))
+                              'help-echo (elpher-node-button-help node)))
       (pcase type
         (?i (elpher-insert-margin) ;; Information
             (insert (propertize
@@ -350,14 +372,6 @@ content and cursor position fields of the node."
                          (elpher-buttonify-urls display-string)
                        display-string)
                      'face 'elpher-info)))
-        (?h (elpher-insert-margin "W") ;; Web link
-            (let ((url (elt (split-string selector "URL:") 1)))
-              (insert-text-button display-string
-                                  'face 'elpher-url
-                                  'elpher-url url
-                                  'action #'elpher-click-url
-                                  'follow-link t
-                                  'help-echo (format "mouse-1, RET: open url %s" url))))
         (tp (elpher-insert-margin (concat (char-to-string tp) "?"))
             (insert (propertize display-string
                                 'face 'elpher-unknown-face)))))
@@ -368,13 +382,6 @@ content and cursor position fields of the node."
   (let ((node (button-get button 'elpher-node)))
     (elpher-visit-node node)))
 
-(defun elpher-click-url (button)
-  "Function called when the url link BUTTON is activated (via mouse or keypress)."
-  (let ((url (button-get button 'elpher-url)))
-    (if elpher-open-urls-with-eww
-        (browse-web url)
-      (browse-url url))))
-
 
 ;;; Selector retrieval (all kinds)
 ;;
@@ -433,44 +440,56 @@ The result is stored as a string in the variable ‘elpher-selector-string’."
 ;; Text retrieval
 
 (defconst elpher-url-regex
-  "\\(https?\\|gopher\\)://\\([a-zA-Z0-9.\-]+\\)\\(?3::[0-9]+\\)?\\(?4:/[^ \r\n\t(),]*\\)?"
+  "\\([a-zA-Z]+\\)://\\([a-zA-Z0-9.\-]+\\)\\(?3::[0-9]+\\)?\\(?4:/[^ \r\n\t(),]*\\)?"
   "Regexp used to locate and buttinofy URLs in text files loaded by elpher.")
 
+(defun elpher-make-node-from-matched-url (parent &optional string)
+  "Convert most recent `elpher-url-regex' match to a node.
+
+PARENT defines the node to set as the parent to the new node.
+
+If STRING is non-nil, this is given as an argument to all `match-string'
+calls, as is necessary if the match is performed by `string-match'."
+  (let ((url (match-string 0 string))
+        (protocol (downcase (match-string 1 string))))
+    (if (string= protocol "gopher")
+        (let* ((host (match-string 2 string))
+               (port (if (> (length (match-string 3 string))  1)
+                         (string-to-number (substring (match-string 3 string) 1))
+                       70))
+               (type-and-selector (match-string 4 string))
+               (type (if (> (length type-and-selector) 1)
+                         (elt type-and-selector 1)
+                       ?1))
+               (selector (if (> (length type-and-selector) 1)
+                             (substring type-and-selector 2)
+                           ""))
+               (address (elpher-make-address selector host port))
+               (getter (car (alist-get type elpher-type-map))))
+          (elpher-make-node elpher-current-node address getter))
+      (let* ((host (match-string 2 string))
+             (port (if (> (length (match-string 3 string)) 1)
+                       (string-to-number (substring (match-string 3 string) 1))
+                     70))
+             (selector (concat "URL:" url))
+             (address (elpher-make-address selector host port))
+             (getter (car (alist-get ?h elpher-type-map))))
+        (elpher-make-node elpher-current-node address getter)))))
+
+
 (defun elpher-buttonify-urls (string)
   "Turn substrings which look like urls in STRING into clickable buttons."
   (with-temp-buffer
     (insert string)
     (goto-char (point-min))
     (while (re-search-forward elpher-url-regex nil t)
-      (let ((url (match-string 0))
-            (protocol (downcase (match-string 1))))
-        (if (string= protocol "gopher")
-            (let* ((host (match-string 2))
-                   (port 70)
-                   (type-and-selector (match-string 4))
-                   (type (if (> (length type-and-selector) 1)
-                             (elt type-and-selector 1)
-                           ?1))
-                   (selector (if (> (length type-and-selector) 1)
-                                 (substring type-and-selector 2)
-                               ""))
-                   (address (elpher-make-address selector host port))
-                   (getter (car (alist-get type elpher-type-map))))
-              (make-text-button (match-beginning 0)
-                                (match-end 0)
-                                'elpher-node (elpher-make-node elpher-current-node
-                                                                 address
-                                                                 getter)
-                                'action #'elpher-click-link
-                                'follow-link t
-                                'help-echo (format "mouse-1, RET: open '%s' on %s port %s"
-                                                   selector host port)))
+        (let ((node (elpher-make-node-from-matched-url elpher-current-node)))
           (make-text-button (match-beginning 0)
                             (match-end 0)
-                            'elpher-url url
-                            'action #'elpher-click-url
+                            'elpher-node  node
+                            'action #'elpher-click-link
                             'follow-link t
-                            'help-echo (format "mouse-1, RET: open url %s" url)))))
+                            'help-echo (elpher-node-button-help node))))
     (buffer-string)))
 
 (defun elpher-process-text (string)
@@ -609,45 +628,84 @@ The result is stored as a string in the variable ‘elpher-selector-string’."
                                   (message (format "Download complate, saved to file %s."
                                                    elpher-download-filename)))))))))
 
+;; URL retrieval
+
+(defun elpher-get-url-node ()
+  "Getter which attempts to open the URL specified by the current node."
+  (let* ((address (elpher-node-address elpher-current-node))
+         (selector (elpher-address-selector address)))
+    (elpher-visit-parent-node) ; Do first in case of non-local exits.
+    (let ((url (elt (split-string selector "URL:") 1)))
+      (if elpher-open-urls-with-eww
+          (browse-web url)
+        (browse-url url)))))
+
+;; Telnet node connection
+
+(defun elpher-get-telnet-node ()
+  "Getter which opens a telnet connection to the server specified by the current node."
+  (let* ((address (elpher-node-address elpher-current-node))
+         (host (elpher-address-host address))
+         (port (elpher-address-port address)))
+    (elpher-visit-parent-node)
+    (telnet host port)))
+
+
 ;;; Bookmarks
 ;;
 
 (defun elpher-make-bookmark (type display-string address)
+  "Make an elpher bookmark.
+DISPLAY-STRING determines how the bookmark will appear in the bookmark list.
+
+TYPE specifies how the entry will be retrieved when selected, and is
+specified using the standard gopher entry type characters.
+
+ADDRESS is the address of the entry."
   (list type display-string address))
   
 (defun elpher-bookmark-type (bookmark)
+  "Ge the type of BOOKMARK."
   (elt bookmark 0))
 
 (defun elpher-bookmark-display-string (bookmark)
+  "Get the display string of BOOKMARK."
   (elt bookmark 1))
 
 (defun elpher-bookmark-address (bookmark)
+  "Get the address for BOOKMARK."
   (elt bookmark 2))
 
 (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")
     (erase-buffer)
     (pp bookmarks (current-buffer))))
 
 (defun elpher-load-bookmarks ()
-  (with-temp-buffer 
+  "Get the list of bookmarks from the users's bookmark file."
+  (with-temp-buffer
     (ignore-errors
       (insert-file-contents (locate-user-emacs-file "elpher-bookmarks"))
       (goto-char (point-min))
       (read (current-buffer)))))
 
 (defun elpher-add-bookmark (bookmark)
+  "Add BOOKMARK to the saved list of bookmarks."
   (let ((bookmarks (elpher-load-bookmarks)))
     (add-to-list 'bookmarks bookmark)
     (elpher-save-bookmarks bookmarks)))
 
 (defun elpher-remove-bookmark (bookmark)
+  "Remove BOOKMARK from the saved list of bookmarks."
   (elpher-save-bookmarks
    (seq-filter (lambda (this-bookmark)
                  (not (equal bookmark this-bookmark)))
                (elpher-load-bookmarks))))
      
 (defun elpher-display-bookmarks ()
+  "Display saved bookmark list."
   (interactive)
   (elpher-with-clean-buffer
    (insert
@@ -683,8 +741,8 @@ The result is stored as a string in the variable ‘elpher-selector-string’."
                                        label
                                        (elpher-node-address node)))
                 (message "Bookmarked \"%s\"" label))
-            (error "Can only bookmark gopher links, not general URLs.")))
-      (error "No link selected."))))
+            (error "Can only bookmark gopher links, not general URLs")))
+      (error "No link selected"))))
 
 (defun elpher-unbookmark-link ()
   "Remove bookmark for the link at point."
@@ -694,12 +752,12 @@ The result is stored as a string in the variable ‘elpher-selector-string’."
         (let ((node (button-get button 'elpher-node))
               (type (button-get button 'elpher-node-type)))
           (if node
-              (elpher-remove-bookmark 
+              (elpher-remove-bookmark
                (elpher-make-bookmark type
                                      (button-label button)
                                      (elpher-node-address node)))
-            (error "Can only bookmark gopher links, not general URLs.")))
-      (error "No link selected."))))
+            (error "Can only bookmark gopher links, not general URLs")))
+      (error "No link selected"))))
 
 ;;; Interactive navigation procedures
 ;;
@@ -722,16 +780,19 @@ The result is stored as a string in the variable ‘elpher-selector-string’."
 (defun elpher-go ()
   "Go to a particular gopher site."
   (interactive)
-  (switch-to-buffer "*elpher*")
-  (let* (
-         (hostname (read-string "Gopher host: "))
-         (selector (read-string "Selector (default none): " nil nil ""))
-         (port (read-string "Port (default 70): " nil nil 70))
-         (address (list selector hostname port)))
-    (elpher-visit-node
-     (elpher-make-node elpher-current-node
-                        address
-                        #'elpher-get-index-node))))
+  (let ((node
+         (let ((host-or-url (read-string "Gopher host or URL: ")))
+           (if (string-match elpher-url-regex host-or-url)
+               (elpher-make-node-from-matched-url elpher-current-node
+                                                  host-or-url)
+             (let ((selector (read-string "Selector (default none): " nil nil ""))
+                   (port (string-to-number (read-string "Port (default 70): "
+                                                        nil nil 70))))
+               (elpher-make-node elpher-current-node
+                                 (elpher-make-address selector host-or-url port)
+                                 #'elpher-get-index-node))))))
+    (switch-to-buffer "*elpher*")
+    (elpher-visit-node node)))
 
 (defun  elpher-redraw ()
   "Redraw current page."
@@ -760,7 +821,7 @@ The result is stored as a string in the variable ‘elpher-selector-string’."
   (interactive)
   (if (elpher-node-parent elpher-current-node)
       (elpher-visit-parent-node)
-    (error "No previous site.")))
+    (error "No previous site")))
 
 (defun elpher-download ()
   "Download the link at point."
@@ -771,8 +832,8 @@ The result is stored as a string in the variable ‘elpher-selector-string’."
           (if node
               (elpher-visit-node (button-get button 'elpher-node)
                                  #'elpher-get-node-download)
-            (error "Can only download gopher links, not general URLs.")))
-      (error "No link selected."))))
+            (error "Can only download gopher links, not general URLs")))
+      (error "No link selected"))))
 
 (defun elpher-build-link-map ()
   "Build alist mapping link names to destination nodes in current buffer."
@@ -809,8 +870,8 @@ The result is stored as a string in the variable ‘elpher-selector-string’."
                 (elpher-visit-node (elpher-make-node elpher-current-node
                                                      root-address
                                                      #'elpher-get-index-node)))
-            (error "Already at root directory of current server.")))
-      (error "Command invalid for Elpher start page."))))
+            (error "Already at root directory of current server")))
+      (error "Command invalid for Elpher start page"))))
 
 
 ;;; Mode and keymap