X-Git-Url: https://thelambdalab.xyz/gitweb/index.cgi?p=elpher.git;a=blobdiff_plain;f=elpher.el;h=662e451ff7638fb23178788db045fde42338aa86;hp=5dc0bdfbdb9702cd70079135c7d4bf0d1975e450;hb=3cb3110e90a8f9f71bd49e6bbd2781f2e9a50285;hpb=726707d9621c149e5e7784adb6aa8de3d5d5910c diff --git a/elpher.el b/elpher.el index 5dc0bdf..662e451 100644 --- a/elpher.el +++ b/elpher.el @@ -1,4 +1,4 @@ -;;; elpher.el --- A friendly gopher and gemini client -*- lexical-binding:t -*- +;;; elpher.el --- A friendly gopher and gemini client -*- lexical-binding: t -*- ;; Copyright (C) 2021 Jens Östlund ;; Copyright (C) 2021 F. Jason Park @@ -21,8 +21,8 @@ ;; Created: 11 April 2019 ;; Version: 2.11.0 ;; Keywords: comm gopher -;; Homepage: http://thelambdalab.xyz/elpher -;; Package-Requires: ((emacs "26.2")) +;; Homepage: https://alexschroeder.ch/cgit/elpher +;; Package-Requires: ((emacs "27.1")) ;; This file is not part of GNU Emacs. @@ -63,7 +63,7 @@ ;; Elpher is under active development. Any suggestions for ;; improvements are welcome, and can be made on the official -;; project page, gopher://thelambdalab.xyz/1/projects/elpher/. +;; project page, https://alexschroeder.ch/cgit/elpher. ;;; Code: @@ -81,6 +81,7 @@ (require 'nsm) (require 'gnutls) (require 'socks) +(require 'ol) ;;; ANSI colors or XTerm colors @@ -103,7 +104,7 @@ ;;; Global constants ;; -(defconst elpher-version "2.10.2" +(defconst elpher-version "2.11.0" "Current version of elpher.") (defconst elpher-margin-width 6 @@ -136,14 +137,14 @@ ;; ;; buffer-local -(defvar elpher--gemini-page-headings '() - "Interval variable containing list of headings on page.") +(defvar elpher--gemini-page-headings nil + "List of headings on the page.") -(defvar elpher--gemini-page-links '() - "Internal variable containing list of links on page.") +(defvar elpher--gemini-page-links nil + "List of links on the page.") (defvar elpher--gemini-page-links-cache (make-hash-table :test 'equal) - "Internal variable containing hash of addresses and page links.") + "Hash of addresses and page links.") ;;; Customization group ;; @@ -165,8 +166,9 @@ Otherwise, use the system browser via the BROWSE-URL function." (defcustom elpher-auto-disengage-TLS nil "If non-nil, automatically disengage TLS following an unsuccessful connection. -While enabling this may seem convenient, it is also potentially dangerous as it -allows switching from an encrypted channel back to plain text without user input." +While enabling this may seem convenient, it is also potentially +dangerous as it allows switching from an encrypted channel back to +plain text without user input." :type '(boolean)) (defcustom elpher-connection-timeout 5 @@ -190,7 +192,7 @@ These certificates may be used for establishing authenticated TLS connections." :type '(file)) (defcustom elpher-default-url-type "gopher" - "Default URL type (i.e. schema) to assume if not explicitly given." + "Default URL type (i.e. scheme) to assume if not explicitly given." :type '(choice (const "gopher") (const "gemini"))) @@ -636,7 +638,7 @@ If LINE is non-nil, replace that line instead." "Preprocess text selector response contained in STRING. This involes decoding the character representation, and clearing away CRs and any terminating period." - (elpher-decode (replace-regexp-in-string "\n\.\n$" "\n" + (elpher-decode (replace-regexp-in-string "\n\\.\n$" "\n" (replace-regexp-in-string "\r" "" string)))) @@ -1053,7 +1055,7 @@ If ADDRESS is not supplied or nil the record is rendered as an ;; Text rendering (defconst elpher-url-regex - "\\([a-zA-Z]+\\)://\\([a-zA-Z0-9.\-]*[a-zA-Z0-9\-]\\|\[[a-zA-Z0-9:]+\]\\)\\(:[0-9]+\\)?\\(/\\([0-9a-zA-Z\-_~?/@|:.%#=&]*[0-9a-zA-Z\-_~?/@|#]\\)?\\)?" + "\\([a-zA-Z]+\\)://\\([a-zA-Z0-9.-]*[a-zA-Z0-9-]\\|\\[[a-zA-Z0-9:]+\\]\\)\\(:[0-9]+\\)?\\(/\\([0-9a-zA-Z_~?/@|:.%#=&-]*[0-9a-zA-Z_~?/@|#-]\\)?\\)?" "Regexp used to locate and buttinofy URLs in text files loaded by elpher.") (defun elpher-buttonify-urls (string) @@ -1074,7 +1076,7 @@ If ADDRESS is not supplied or nil the record is rendered as an (buffer-string))) (defconst elpher-ansi-regex "\x1b\\[[^m]*m" - "Wildly incomplete regexp used to strip out some troublesome ANSI escape sequences.") + "Incomplete regexp used to strip out some troublesome ANSI escape sequences.") (defun elpher-process-text-for-display (string) "Perform any desired processing of STRING prior to display as text. @@ -1471,14 +1473,14 @@ by HEADER-LINE." (defun elpher-gemini-insert-text (text-line) "Insert a plain non-preformatted TEXT-LINE into a text/gemini document. This function uses Emacs' auto-fill to wrap text sensibly to a maximum -width defined by elpher-gemini-max-fill-width." - (string-match "\\(^[ \t]*\\)\\(\*[ \t]+\\|>[ \t]*\\)?" text-line) +width defined by `elpher-gemini-max-fill-width'." + (string-match "\\(^[ \t]*\\)\\(\\*[ \t]+\\|>[ \t]*\\)?" text-line) (let* ((line-prefix (match-string 2 text-line)) (processed-text-line (if line-prefix (cond ((string-prefix-p "*" line-prefix) (concat - (replace-regexp-in-string "\*" + (replace-regexp-in-string "\\*" elpher-gemini-bullet-string (match-string 0 text-line)) (substring text-line (match-end 0)))) @@ -1638,8 +1640,8 @@ The result is rendered using RENDERER." "Alternatively, select a search engine and enter some search terms:\n") (elpher-insert-index-record "Gopher Search Engine (Veronica-2)" (elpher-make-gopher-address ?7 "/v2/vs" "gopher.floodgap.com" 70)) - (elpher-insert-index-record "Gemini Search Engine (GUS)" - (elpher-address-from-url "gemini://gus.guru/search")) + (elpher-insert-index-record "Gemini Search Engine (geminispace.info)" + (elpher-address-from-url "gemini://geminispace.info/search")) (insert "\n" "This page contains your bookmarked sites (also visit with B):\n") (elpher-insert-index-record "Your Bookmarks" 'bookmarks) @@ -1778,8 +1780,14 @@ If ADDRESS is already bookmarked, update the label only." ;;; Integrations ;; +;; Avoid byte compilation warnings. +(eval-when-compile + (declare-function org-link-store-props "ol") + (declare-function org-link-set-parameters "ol") + (defvar thing-at-point-uri-schemes)) + (defun elpher-org-link-store () - "Store link to an `elpher' page in org-mode." + "Store link to an `elpher' page in `org'." (when (eq major-mode 'elpher-mode) (let ((link (concat "elpher:" (elpher-info-current))) (desc (car elpher-current-page))) @@ -1789,7 +1797,7 @@ If ADDRESS is already bookmarked, update the label only." t))) (defun elpher-org-link-follow (link _args) - "Follow an `elpher' link in an `org' buffer." + "Follow an `elpher' LINK in an `org' buffer." (require 'elpher) (message (concat "Got link: " link)) (when (or @@ -1798,27 +1806,22 @@ If ADDRESS is already bookmarked, update the label only." (string-match-p "^finger://.+" link)) (elpher-go (string-remove-prefix "elpher:" link)))) -(with-eval-after-load "org" - ;; Use `org-link-set-parameters' if defined (org-mode 9+) - (if (fboundp 'org-link-set-parameters) - (org-link-set-parameters "elpher" - :store #'elpher-org-link-store - :follow #'elpher-org-link-follow) - (org-add-link-type "mu4e" 'elpher-org-link-follow) - (add-hook 'org-store-link-functions 'elpher-org-link-store))) - -(defun browse-url-elpher (url &rest _args) - "Browse URL. This function is used by `browse-url'." +(org-link-set-parameters "elpher" + :store #'elpher-org-link-store + :follow #'elpher-org-link-follow) + +;;;###autoload +(defun elpher-browse-url-elpher (url &rest _args) + "Browse URL using Elpher. This function is used by `browse-url'." (interactive (browse-url-interactive-arg "Elpher URL: ")) (elpher-go url)) -(with-eval-after-load "browse-url" - ;; Use elpher to open gopher, finger and gemini links - (when (boundp 'browse-url-default-handlers) - (add-to-list 'browse-url-default-handlers - '("^\\(gopher\\|finger\\|gemini\\)://" . browse-url-elpher))) - ;; Register "gemini://" as a URI scheme so `browse-url' does the right thing - (add-to-list 'thing-at-point-uri-schemes "gemini://")) +(add-to-list + 'browse-url-default-handlers + '("^\\(gopher\\|finger\\|gemini\\)://" . elpher-browse-url-elpher)) + +;; Register "gemini://" as a URI scheme so `browse-url' does the right thing +(add-to-list 'thing-at-point-uri-schemes "gemini://") ;;; Interactive procedures ;; @@ -1854,13 +1857,13 @@ When run interactively HOST-OR-URL is read from the minibuffer." "Go to a particular site read from the minibuffer, initialized with the current URL." (interactive) (let ((address (elpher-page-address elpher-current-page))) - (if (elpher-address-special-p address) - (error "Command invalid for this page") - (let ((url (read-string "Gopher or Gemini URL: " (elpher-address-to-url address)))) - (elpher-visit-page (elpher-make-page url (elpher-address-from-url url))))))) + (let ((url (read-string "Gopher or Gemini URL: " + (unless (elpher-address-special-p address) + (elpher-address-to-url address))))) + (elpher-visit-page (elpher-make-page url (elpher-address-from-url url)))))) (defun elpher-visit-gemini-numbered-link (n) - "Visit link designated by a number." + "Visit link designated by a number N." (interactive "nLink number: ") (if (or (> n (length elpher--gemini-page-links)) (< n 1)) @@ -2189,10 +2192,10 @@ functions which initialize the gopher client, namely The buffer used for Elpher sessions is determined by the value of ‘elpher-buffer-name’. If there is already an Elpher session active in that buffer, Emacs will simply switch to it. Otherwise, a new session -will begin. A numeric prefix arg (as in ‘C-u 42 M-x elpher RET’) -switches to the session with that number, creating it if necessary. A -nonnumeric prefix arg means to create a new session. Returns the -buffer selected (or created)." +will begin. A numeric prefix ARG (as in ‘\\[universal-argument] 42 +\\[execute-extended-command] elpher RET’) switches to the session with +that number, creating it if necessary. A non numeric prefix ARG means +to create a new session. Returns the buffer selected (or created)." (interactive "P") (let* ((name (default-value 'elpher-buffer-name)) (buf (cond ((numberp arg)