Rearrange
Hopefully this will make it a little clearer. More rearranging might happen in the future.
This commit is contained in:
parent
9f7c64aa6e
commit
469df11333
1 changed files with 255 additions and 227 deletions
476
avandu.el
476
avandu.el
|
|
@ -49,10 +49,25 @@
|
|||
(require 'url)
|
||||
(require 'simple)
|
||||
|
||||
(defconst avandu-entity-replacement-alist
|
||||
'(("hellip" . 8230)
|
||||
("qout" . 34)
|
||||
("amp" . 38)
|
||||
("nbsp" . 32))
|
||||
"What to replace the part between & and ; of HTML entities with
|
||||
names.")
|
||||
|
||||
;; Customization
|
||||
(defgroup avandu nil
|
||||
"Tiny Tiny RSS interface for emacs."
|
||||
:group 'applications)
|
||||
|
||||
;; Faces
|
||||
(defface avandu-overview-excerpt
|
||||
'((t (:inherit shadow :slant italic)))
|
||||
"Face for article excerpts in avandu overview."
|
||||
:group 'avandu)
|
||||
|
||||
(defface avandu-overview-feed
|
||||
'((((class color)
|
||||
(background dark))
|
||||
|
|
@ -63,16 +78,6 @@
|
|||
"Face for feed titles in avandu overview."
|
||||
:group 'avandu)
|
||||
|
||||
(defface avandu-overview-unread-article
|
||||
'((((class color)
|
||||
(background dark))
|
||||
(:foreground "orange3" :weight bold :family "sans"))
|
||||
(((class color)
|
||||
(background light))
|
||||
(:foregroung "red4" :weight bold :family "sans")))
|
||||
"Face for unread article titles in avandu overview."
|
||||
:group 'avandu)
|
||||
|
||||
(defface avandu-overview-read-article
|
||||
'((((class color)
|
||||
(background dark))
|
||||
|
|
@ -83,33 +88,27 @@
|
|||
"Face for read article titles in avandu overview."
|
||||
:group 'avandu)
|
||||
|
||||
(defface avandu-overview-excerpt
|
||||
'((t (:inherit shadow :slant italic)))
|
||||
"Face for article excerpts in avandu overview."
|
||||
(defface avandu-overview-unread-article
|
||||
'((((class color)
|
||||
(background dark))
|
||||
(:foreground "orange3" :weight bold :family "sans"))
|
||||
(((class color)
|
||||
(background light))
|
||||
(:foregroung "red4" :weight bold :family "sans")))
|
||||
"Face for unread article titles in avandu overview."
|
||||
:group 'avandu)
|
||||
|
||||
;; User options
|
||||
(defcustom avandu-tt-rss-api-url nil
|
||||
"URL of your Tiny Tiny RSS instance. For example:
|
||||
http://tt-rss.org/demo/api/"
|
||||
:group 'avandu
|
||||
:type 'string)
|
||||
|
||||
;; Variables
|
||||
(defvar avandu--session-id nil
|
||||
"*internal* Session id for avandu.")
|
||||
|
||||
(defvar avandu-user nil
|
||||
"Username of your Tiny Tiny RSS account.")
|
||||
|
||||
(defvar avandu-password nil
|
||||
"Password for your Tiny Tiny RSS account.")
|
||||
|
||||
(defvar avandu-feed-button-map
|
||||
(let ((map (make-sparse-keymap)))
|
||||
(set-keymap-parent map button-map)
|
||||
(define-key map "c" 'avandu-feed-catchup)
|
||||
map)
|
||||
"Keymap for feeds in `avandu-overview-mode'.")
|
||||
|
||||
(defvar avandu-article-button-map
|
||||
(let ((map (make-sparse-keymap)))
|
||||
(set-keymap-parent map button-map)
|
||||
|
|
@ -118,6 +117,13 @@
|
|||
map)
|
||||
"Keymap for articles in `avandu-overview-mode'.")
|
||||
|
||||
(defvar avandu-feed-button-map
|
||||
(let ((map (make-sparse-keymap)))
|
||||
(set-keymap-parent map button-map)
|
||||
(define-key map "c" 'avandu-feed-catchup)
|
||||
map)
|
||||
"Keymap for feeds in `avandu-overview-mode'.")
|
||||
|
||||
(defvar avandu-overview-map
|
||||
(let ((map (make-sparse-keymap)))
|
||||
(set-keymap-parent map special-mode-map)
|
||||
|
|
@ -128,152 +134,13 @@
|
|||
map)
|
||||
"Keymap for `avandu-overview-mode'.")
|
||||
|
||||
(defconst avandu-entity-replacement-alist
|
||||
'(("hellip" . 8230)
|
||||
("qout" . 34)
|
||||
("amp" . 38)
|
||||
("nbsp" . 32))
|
||||
"What to replace the part between & and ; of HTML entities with
|
||||
names.")
|
||||
(defvar avandu-password nil
|
||||
"Password for your Tiny Tiny RSS account.")
|
||||
|
||||
(define-derived-mode avandu-overview-mode special-mode "Avandu:Overview"
|
||||
"Major mode fo the avandu overview screen.
|
||||
|
||||
This screen shows the articles categorized by feed as a list. It
|
||||
doesn't sort the list, so you'll have to set that up in tt-rss.
|
||||
|
||||
\\{avandu-overview-map}
|
||||
\\<avandu-overview-map>"
|
||||
(use-local-map avandu-overview-map)
|
||||
(set (make-local-variable 'revert-buffer-function)
|
||||
#'(lambda (ignore-auto noconfirm) (avandu-list))))
|
||||
|
||||
(defun avandu--clear-data ()
|
||||
"Clean up login data. This makes for a clean slate next time."
|
||||
(setq avandu-user nil
|
||||
avandu-password nil
|
||||
avandu--session-id nil))
|
||||
|
||||
(defun avandu--get-status-id (results)
|
||||
"Get the status id from RESULTS."
|
||||
(cdr (assq 'status results)))
|
||||
|
||||
(defun avandu--get-session-id (results)
|
||||
"Get the session id from RESULTS."
|
||||
(cdr (assq 'session_id (assq 'content results))))
|
||||
|
||||
(defun avandu--check-login ()
|
||||
"Check to see if we're (still) logged in, try to login
|
||||
otherwise. Signals an error if we're not logged in *and* login
|
||||
was unsuccesful."
|
||||
(unless (or (and avandu--session-id (avandu-logged-in-p))
|
||||
(avandu-login))
|
||||
(avandu--clear-data)
|
||||
(error "Could not log in to tt-rss")))
|
||||
|
||||
(defmacro avandu-getset (var prompt &optional passwdp)
|
||||
"Ask the user for, and then save, VAR with PROMPT. Use
|
||||
`read-passwd' if PASSWDP and `read-string' otherwise."
|
||||
`(or ,var (setq ,var (,(if passwdp 'read-passwd 'read-string)
|
||||
,prompt))))
|
||||
|
||||
(defun avandu-send-command (data)
|
||||
"Send a command with parameters DATA to tt-rss. The current
|
||||
session-id is added to the request and then DATA is passed on to
|
||||
`json-encode'.
|
||||
|
||||
DATA should be an association list with at least an OP value.
|
||||
For example:
|
||||
|
||||
(avandu-send-command '((op . \"isLoggedIn\")))
|
||||
|
||||
This function returns the result of `json-read' passed over the
|
||||
returned json."
|
||||
(let* ((url-request-data
|
||||
(json-encode
|
||||
(if avandu--session-id
|
||||
(append `((sid . ,avandu--session-id))
|
||||
data)
|
||||
data)))
|
||||
(url-request-method "POST")
|
||||
(buffer (url-retrieve-synchronously avandu-tt-rss-api-url))
|
||||
result)
|
||||
(with-current-buffer buffer
|
||||
(goto-char (point-min))
|
||||
(search-forward "\n\n")
|
||||
(setq result (json-read)))
|
||||
(kill-buffer buffer)
|
||||
result))
|
||||
|
||||
(defun avandu-feed-catchup ()
|
||||
"Send a request to tt-rss to \"Catch up\" with a feed. This
|
||||
means that all the (unread) articles in a feed will be marked
|
||||
as read. After having completed this request the overview is
|
||||
reloaded."
|
||||
(interactive)
|
||||
(let* ((button (button-at (point)))
|
||||
(id (button-get button 'feed-id)))
|
||||
(avandu-send-command `((op . "catchupFeed")
|
||||
(feed_id . ,id))))
|
||||
(revert-buffer))
|
||||
|
||||
(defun avandu-mark-article-read (&optional button)
|
||||
"Send a request to tt-rss to mark an article as read.
|
||||
|
||||
BUTTON, if given, should be a button widget, as created by
|
||||
`button-insert' and such, which contains FEED-ID. If BUTTON is
|
||||
nil, it will be assumed that `point' is currently within the
|
||||
bounds of a button."
|
||||
(interactive)
|
||||
(let* ((button (or button (button-at (point))))
|
||||
(id (button-get button 'article-id)))
|
||||
(avandu-send-command `((op . "updateArticle")
|
||||
(article_ids . ,id)
|
||||
(mode . 0)
|
||||
(field . 2)))
|
||||
(button-put button 'face 'avandu-overview-read-article))
|
||||
(avandu-next-article))
|
||||
|
||||
(defun avandu-logout ()
|
||||
"Logout from Tiny Tiny RSS."
|
||||
(interactive)
|
||||
(avandu-send-command '((op . "logout")))
|
||||
(avandu--clear-data))
|
||||
|
||||
(defun avandu-logged-in-p ()
|
||||
"Send a request to tt-rss to see if we're (still) logged
|
||||
in. This function returns t if we are, or nil if we're not."
|
||||
(let* ((response (avandu-send-command '((op . "isLoggedIn"))))
|
||||
(result (cdr (assq 'status (assq 'content response)))))
|
||||
(if (eq result :json-false)
|
||||
nil
|
||||
result)))
|
||||
|
||||
(defun avandu-login ()
|
||||
"Send a request to log in to tt-rss. If `avandu-user' or
|
||||
`avandu-password' have not been specified they will be asked for
|
||||
and saved in memory. This function returns t on succes, nil
|
||||
otherwise."
|
||||
(interactive)
|
||||
(let ((result (avandu-send-command
|
||||
`((op . "login")
|
||||
(user . ,(avandu-getset avandu-user "Username: "))
|
||||
(password
|
||||
. ,(avandu-getset avandu-password "Password: " t))))))
|
||||
(if (eq (avandu--get-status-id result) 0)
|
||||
(progn
|
||||
(setq avandu--session-id (avandu--get-session-id result))
|
||||
t)
|
||||
nil)))
|
||||
|
||||
(defun avandu-new-articles-count ()
|
||||
"Send a request to tt-rss for the total number of unread
|
||||
feeds."
|
||||
(interactive)
|
||||
(avandu--check-login)
|
||||
(let ((result (avandu-send-command '((op . "getUnread")))))
|
||||
(message (cdr (assq 'unread (assq 'content result))))))
|
||||
(defvar avandu-user nil
|
||||
"Username of your Tiny Tiny RSS account.")
|
||||
|
||||
;; Macros
|
||||
(defmacro avandu--next-button-of-type (direction type)
|
||||
"Go DIRECTION and find the next button of a TYPE."
|
||||
(let ((prop (case type
|
||||
|
|
@ -300,60 +167,23 @@ feeds."
|
|||
pos (overlay-start button))))
|
||||
(goto-char pos))))
|
||||
|
||||
(defun avandu-next-article ()
|
||||
"Search forward for the next article."
|
||||
(interactive)
|
||||
(avandu--next-button-of-type forward article))
|
||||
(defmacro avandu-getset (var prompt &optional passwdp)
|
||||
"Ask the user for, and then save, VAR with PROMPT. Use
|
||||
`read-passwd' if PASSWDP and `read-string' otherwise."
|
||||
`(or ,var (setq ,var (,(if passwdp 'read-passwd 'read-string)
|
||||
,prompt))))
|
||||
|
||||
(defun avandu-previous-article ()
|
||||
"Go backward and find the next article."
|
||||
(interactive)
|
||||
(avandu--next-button-of-type backward article))
|
||||
;; Internal
|
||||
(defun avandu--check-login ()
|
||||
"Check to see if we're (still) logged in, try to login
|
||||
otherwise. Signals an error if we're not logged in *and* login
|
||||
was unsuccesful."
|
||||
(unless (or (and avandu--session-id (avandu-logged-in-p))
|
||||
(avandu-login))
|
||||
(avandu--clear-data)
|
||||
(error "Could not log in to tt-rss")))
|
||||
|
||||
(defun avandu-next-feed ()
|
||||
"Go forward and find the next feed."
|
||||
(interactive)
|
||||
(avandu--next-button-of-type forward feed))
|
||||
|
||||
(defun avandu-previous-feed ()
|
||||
"Go backward and find the next feed."
|
||||
(interactive)
|
||||
(avandu--next-button-of-type backward feed))
|
||||
|
||||
(defun avandu--insert-feed-title (id title)
|
||||
"Insert a button with the label TITLE and store ID in the
|
||||
feed-id property."
|
||||
(unless (eq (point) (point-min)) (insert-char ?\n 1))
|
||||
(insert-button
|
||||
(replace-regexp-in-string "^[ \n\t]*\\|[ \n\t]*$" "" title)
|
||||
'face 'avandu-overview-feed
|
||||
'feed-id id
|
||||
'keymap avandu-feed-button-map
|
||||
'action #'(lambda (button)
|
||||
(message "%s" (button-label button))))
|
||||
(insert-char ?\n 2))
|
||||
|
||||
(defun avandu-browse-article ()
|
||||
"Browse the current button's article url."
|
||||
(interactive)
|
||||
(let ((button (button-at (point))))
|
||||
(browse-url (button-get button 'link))
|
||||
(avandu-mark-article-read button)))
|
||||
|
||||
(defun avandu--insert-article-title (id link title)
|
||||
"Insert a button with the label TITLE and store ID and LINK in
|
||||
the article-id and link properties, respectively."
|
||||
(insert-button
|
||||
(replace-regexp-in-string "^[ \n\t]*\\|[ \n\t]*$" "" title)
|
||||
'face 'avandu-overview-unread-article
|
||||
'article-id id
|
||||
'link link
|
||||
'keymap avandu-article-button-map
|
||||
'action #'(lambda (button)
|
||||
(message "%s" (button-get button 'link))))
|
||||
(insert-char ?\n 1))
|
||||
|
||||
(defun avandu-clean-text (text)
|
||||
(defun avandu--clean-text (text)
|
||||
"Go through TEXT and remove any trailing and leading whitespace
|
||||
from it, then look for any HTML entities and either replace them
|
||||
with their char value or with the value in
|
||||
|
|
@ -385,12 +215,26 @@ with their char value or with the value in
|
|||
(setq text (buffer-string)))
|
||||
text)
|
||||
|
||||
(defun avandu--clear-data ()
|
||||
"Clean up login data. This makes for a clean slate next time."
|
||||
(setq avandu-user nil
|
||||
avandu--session-id nil)
|
||||
(clear-string avandu-password))
|
||||
|
||||
(defun avandu--get-session-id (results)
|
||||
"Get the session id from RESULTS."
|
||||
(cdr (assq 'session_id (assq 'content results))))
|
||||
|
||||
(defun avandu--get-status-id (results)
|
||||
"Get the status id from RESULTS."
|
||||
(cdr (assq 'status results)))
|
||||
|
||||
(defun avandu--insert-article-excerpt (excerpt)
|
||||
"Insert the excerpt of an article."
|
||||
(let ((start-pos (point))
|
||||
end-pos
|
||||
(text (replace-regexp-in-string
|
||||
"[ \t\n]*$" "" (avandu-clean-text excerpt))))
|
||||
"[ \t\n]*$" "" (avandu--clean-text excerpt))))
|
||||
(unless (or (not text) (string= text ""))
|
||||
(insert
|
||||
(propertize
|
||||
|
|
@ -400,6 +244,170 @@ with their char value or with the value in
|
|||
(fill-region start-pos (point))
|
||||
(insert-char ?\n 1))))
|
||||
|
||||
(defun avandu--insert-article-title (id link title)
|
||||
"Insert a button with the label TITLE and store ID and LINK in
|
||||
the article-id and link properties, respectively."
|
||||
(insert-button
|
||||
(replace-regexp-in-string "^[ \n\t]*\\|[ \n\t]*$" "" title)
|
||||
'face 'avandu-overview-unread-article
|
||||
'article-id id
|
||||
'link link
|
||||
'keymap avandu-article-button-map
|
||||
'action #'(lambda (button)
|
||||
(message "%s" (button-get button 'link))))
|
||||
(insert-char ?\n 1))
|
||||
|
||||
(defun avandu--insert-feed-title (id title)
|
||||
"Insert a button with the label TITLE and store ID in the
|
||||
feed-id property."
|
||||
(unless (eq (point) (point-min)) (insert-char ?\n 1))
|
||||
(insert-button
|
||||
(replace-regexp-in-string "^[ \n\t]*\\|[ \n\t]*$" "" title)
|
||||
'face 'avandu-overview-feed
|
||||
'feed-id id
|
||||
'keymap avandu-feed-button-map
|
||||
'action #'(lambda (button)
|
||||
(message "%s" (button-label button))))
|
||||
(insert-char ?\n 2))
|
||||
|
||||
(defun avandu--send-command (data)
|
||||
"Send a command with parameters DATA to tt-rss. The current
|
||||
session-id is added to the request and then DATA is passed on to
|
||||
`json-encode'.
|
||||
|
||||
DATA should be an association list with at least an OP value.
|
||||
For example:
|
||||
|
||||
(avandu--send-command '((op . \"isLoggedIn\")))
|
||||
|
||||
This function returns the result of `json-read' passed over the
|
||||
returned json."
|
||||
(let* ((url-request-data
|
||||
(json-encode
|
||||
(if avandu--session-id
|
||||
(append `((sid . ,avandu--session-id))
|
||||
data)
|
||||
data)))
|
||||
(url-request-method "POST")
|
||||
(buffer (url-retrieve-synchronously avandu-tt-rss-api-url))
|
||||
result)
|
||||
(with-current-buffer buffer
|
||||
(goto-char (point-min))
|
||||
(search-forward "\n\n")
|
||||
(setq result (json-read)))
|
||||
(kill-buffer buffer)
|
||||
result))
|
||||
|
||||
;; Commands
|
||||
(defun avandu-browse-article ()
|
||||
"Browse the current button's article url."
|
||||
(interactive)
|
||||
(let ((button (button-at (point))))
|
||||
(browse-url (button-get button 'link))
|
||||
(avandu-mark-article-read button)))
|
||||
|
||||
(defun avandu-feed-catchup ()
|
||||
"Send a request to tt-rss to \"Catch up\" with a feed. This
|
||||
means that all the (unread) articles in a feed will be marked
|
||||
as read. After having completed this request the overview is
|
||||
reloaded."
|
||||
(interactive)
|
||||
(let* ((button (button-at (point)))
|
||||
(id (button-get button 'feed-id)))
|
||||
(avandu--send-command `((op . "catchupFeed")
|
||||
(feed_id . ,id))))
|
||||
(revert-buffer))
|
||||
|
||||
(defun avandu-logged-in-p ()
|
||||
"Send a request to tt-rss to see if we're (still) logged
|
||||
in. This function returns t if we are, or nil if we're not."
|
||||
(let* ((response (avandu--send-command '((op . "isLoggedIn"))))
|
||||
(result (cdr (assq 'status (assq 'content response)))))
|
||||
(if (eq result :json-false)
|
||||
nil
|
||||
result)))
|
||||
|
||||
(defun avandu-login ()
|
||||
"Send a request to log in to tt-rss. If `avandu-user' or
|
||||
`avandu-password' have not been specified they will be asked for
|
||||
and saved in memory. This function returns t on succes, nil
|
||||
otherwise."
|
||||
(interactive)
|
||||
(let ((result (avandu--send-command
|
||||
`((op . "login")
|
||||
(user . ,(avandu-getset avandu-user "Username: "))
|
||||
(password
|
||||
. ,(avandu-getset avandu-password "Password: " t))))))
|
||||
(if (eq (avandu--get-status-id result) 0)
|
||||
(progn
|
||||
(setq avandu--session-id (avandu--get-session-id result))
|
||||
t)
|
||||
nil)))
|
||||
|
||||
(defun avandu-logout ()
|
||||
"Logout from Tiny Tiny RSS."
|
||||
(interactive)
|
||||
(avandu--send-command '((op . "logout")))
|
||||
(avandu--clear-data))
|
||||
|
||||
(defun avandu-mark-article-read (&optional button)
|
||||
"Send a request to tt-rss to mark an article as read.
|
||||
|
||||
BUTTON, if given, should be a button widget, as created by
|
||||
`button-insert' and such, which contains FEED-ID. If BUTTON is
|
||||
nil, it will be assumed that `point' is currently within the
|
||||
bounds of a button."
|
||||
(interactive)
|
||||
(let* ((button (or button (button-at (point))))
|
||||
(id (button-get button 'article-id)))
|
||||
(avandu--send-command `((op . "updateArticle")
|
||||
(article_ids . ,id)
|
||||
(mode . 0)
|
||||
(field . 2)))
|
||||
(button-put button 'face 'avandu-overview-read-article))
|
||||
(avandu-next-article))
|
||||
|
||||
(defun avandu-new-articles-count ()
|
||||
"Send a request to tt-rss for the total number of unread
|
||||
feeds."
|
||||
(interactive)
|
||||
(avandu--check-login)
|
||||
(let ((result (avandu--send-command '((op . "getUnread")))))
|
||||
(message (cdr (assq 'unread (assq 'content result))))))
|
||||
|
||||
(defun avandu-next-article ()
|
||||
"Search forward for the next article."
|
||||
(interactive)
|
||||
(avandu--next-button-of-type forward article))
|
||||
|
||||
(defun avandu-next-feed ()
|
||||
"Go forward and find the next feed."
|
||||
(interactive)
|
||||
(avandu--next-button-of-type forward feed))
|
||||
|
||||
(defun avandu-previous-article ()
|
||||
"Go backward and find the next article."
|
||||
(interactive)
|
||||
(avandu--next-button-of-type backward article))
|
||||
|
||||
(defun avandu-previous-feed ()
|
||||
"Go backward and find the next feed."
|
||||
(interactive)
|
||||
(avandu--next-button-of-type backward feed))
|
||||
|
||||
;; Overview
|
||||
(define-derived-mode avandu-overview-mode special-mode "Avandu:Overview"
|
||||
"Major mode fo the avandu overview screen.
|
||||
|
||||
This screen shows the articles categorized by feed as a list. It
|
||||
doesn't sort the list, so you'll have to set that up in tt-rss.
|
||||
|
||||
\\{avandu-overview-map}
|
||||
\\<avandu-overview-map>"
|
||||
(use-local-map avandu-overview-map)
|
||||
(set (make-local-variable 'revert-buffer-function)
|
||||
#'(lambda (ignore-auto noconfirm) (avandu-list))))
|
||||
|
||||
;;;###autoload
|
||||
(defun avandu-list ()
|
||||
"Request the headlines of unread articles and list them grouped
|
||||
|
|
@ -407,7 +415,7 @@ by feed."
|
|||
(interactive)
|
||||
(avandu--check-login)
|
||||
(let ((buffer (get-buffer-create "*avandu-overview*"))
|
||||
(result (avandu-send-command '((op . "getHeadlines")
|
||||
(result (avandu--send-command '((op . "getHeadlines")
|
||||
(feed_id . -4)
|
||||
(view_mode . "unread")
|
||||
(show_excerpt . t))))
|
||||
|
|
@ -449,3 +457,23 @@ by feed."
|
|||
;; (marked . :json-false)
|
||||
;; (unread . t)
|
||||
;; (id . 109))
|
||||
|
||||
;; (get-api-level)
|
||||
;; (get-version)
|
||||
;; (login user password)
|
||||
;; (logout)
|
||||
;; (is-logged-in)
|
||||
;; (get-unread)
|
||||
;; (get-counters output-mode)
|
||||
;; (get-feeds category-id unread-only limit offset)
|
||||
;; (get-categories unread-only)
|
||||
;; (get-headlines feed-id limit skip filter categoryp show-excerpt show-content view-mode include-attachments since-id search search-mode match-on)
|
||||
;; (update-article article-ids mode field data)
|
||||
;; (get-article article-id)
|
||||
;; (get-config icons-dir icons-url daemon-is-running num-feeds)
|
||||
;; (update-feed feed-id)
|
||||
;; (get-pref pref-name)
|
||||
;; (catchup-feed feed-id categoryp)
|
||||
;; (get-counters output-mode)
|
||||
;; (get-labels article-id)
|
||||
;; (set-article-label article-ids label-id assingp)
|
||||
|
|
|
|||
Loading…
Reference in a new issue