-
Notifications
You must be signed in to change notification settings - Fork 18
/
elfeed-protocol.el
196 lines (168 loc) · 8.34 KB
/
elfeed-protocol.el
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
;;; elfeed-protocol.el --- Provide fever/newsblur/owncloud/ttrss protocols for elfeed -*- lexical-binding: t; -*-
;; Author: Xu Fasheng <fasheng[AT]fasheng.info>
;; URL: https://github.com/fasheng/elfeed-protocol
;; Version: 0.3.2
;; Package-Version: 20170501.1349
;; Package-Requires : ((emacs "24.4") (elfeed "2.1.1") (cl-lib "0.5"))
;; Keywords: news
;;; Commentary:
;; elfeed-protocol provide extra protocols to make self-hosting RSS
;; readers like Fever, NewsBlur, ownCloud News and Tiny TIny RSS work
;; with elfeed. See the README for full documentation.
;;
;; Usage:
;;
;; ;; curl recommend
;; (setq elfeed-use-curl t)
;; (elfeed-set-timeout 36000)
;; (setq elfeed-curl-extra-arguments '("--insecure")) ;necessary for https without a trust certificate
;;
;; ;; setup extra protocol feeds
;; (setq elfeed-protocol-feeds '(("owncloud+https://[email protected]"
;; :password "my-password")))
;;
;; ;; enable elfeed-protocol
;; (elfeed-protocol-enable)
;;; Code:
(require 'cl-lib)
(require 'elfeed)
(require 'elfeed-protocol-common)
(defgroup elfeed-protocol ()
"Provide extra protocol for elfeed."
:group 'comm)
(defcustom elfeed-protocol-feeds ()
"List of all feeds that elfeed-protocol should follow.
Similar with `elfeed-feeds'. For example:
(setq elfeed-protocol-feeds '(\"http://foo/\"
(\"http://baz/\" comic)
\"fever+https://user:[email protected]\"
(\"newsblur+https://[email protected]\"
:password \"password\")
(\"owncloud+https://[email protected]\"
:password-file \"~/.password\")
(\"ttrss+https://[email protected]\"
:use-authinfo t)
(\"fever+https://[email protected]\"
:password (password-store-get \"fever/app-pass\"))))"
:group 'elfeed-protocol
:type '(repeat (choice string
(cons string (repeat symbol)))))
(defcustom elfeed-protocol-list ()
"List of all registered extra protocols in Elfeed.
Could be modified by `elfeed-protocol-register' and
`elfeed-protocol-unregister'.
For example,
(elfeed-protocol-register \"owncloud\" 'elfeed-protocol-owncloud-update)
(elfeed-protocol-unregister \"owncloud\")"
:group 'elfeed-protocol
:type '(repeat (cons string symbol)))
(defcustom elfeed-protocol-enabled-protocols '(fever newsblur owncloud ttrss)
"Protocols that should always be loaded together when elfeed-protocol-enable.
You can also use this system to load external packages (i.e. neither elfeed-protocol
core protocols, nor external protocols). Just add symbols
to the end of the list. If the package is called elfeed-protocol-xyz.el, then you need
to add the symbol `xyz', and the package must have a call to:
(provide \\='elfeed-protocol-xyz)"
:group 'elfeed-protocol
:type '(repeat symbol))
(defun elfeed-protocol-update-func (proto-type)
"Get update function for special PROTO-TYPE."
(plist-get (cdr (assoc proto-type elfeed-protocol-list)) ':update))
(defun elfeed-protocol-pre-tag-func (proto-type)
"Get pre-tag function for special PROTO-TYPE."
(plist-get (cdr (assoc proto-type elfeed-protocol-list)) ':pre-tag))
(defun elfeed-protocol-pre-untag-func (proto-type)
"Get pre-untag function for special PROTO-TYPE."
(plist-get (cdr (assoc proto-type elfeed-protocol-list)) ':pre-untag))
(defun elfeed-protocol-register (proto-type proto-funcs)
"Register PROTO-TYPE to `elfeed-protocol-list'.
PROTO-FUNCS is a function list for :update :pre-tag(optinal)
and :pre-untag(optinal) ,
For example:
(list :update 'elfeed-protocol-xxx-update
:pre-tag 'elfeed-protocol-xxx-pre-tag
:pre-untag 'elfeed-protocol-xxx-pre-untag)"
(if (elfeed-protocol-update-func proto-type)
(setf (cdr (assoc proto-type elfeed-protocol-list)) proto-funcs)
(add-to-list 'elfeed-protocol-list (cons proto-type proto-funcs))))
(defun elfeed-protocol-unregister (proto-type)
"Unregister a protocol named PROTO-TYPE from `elfeed-protocol-list'."
(setq elfeed-protocol-list
(delq (assoc proto-type elfeed-protocol-list) elfeed-protocol-list)))
(defun elfeed-protocol-on-tag-add (entries tags)
"Dispatch for tags added.
Will split ENTRIES to groups and dispatched TAGS by different protocols."
(let* ((entry-groups (elfeed-protocol-build-entry-groups entries)))
(maphash (lambda (proto-id proto-entries)
(let* ((proto-type (elfeed-protocol-type proto-id))
(proto-url (elfeed-protocol-meta-url proto-id))
(host-url (elfeed-protocol-url proto-url))
(pre-tag-func (elfeed-protocol-pre-tag-func proto-type)))
(when pre-tag-func
(apply pre-tag-func host-url proto-entries tags))))
entry-groups)))
(defun elfeed-protocol-on-tag-remove (entries tags)
"Dispatch for tags removed.
Will split ENTRIES to groups and dispatched TAGS by different protocols."
(let* ((entry-groups (elfeed-protocol-build-entry-groups entries)))
(maphash (lambda (proto-id proto-entries)
(let* ((proto-type (elfeed-protocol-type proto-id))
(proto-url (elfeed-protocol-meta-url proto-id))
(host-url (elfeed-protocol-url proto-url))
(pre-untag-func (elfeed-protocol-pre-untag-func proto-type)))
(when pre-untag-func
(apply pre-untag-func host-url proto-entries tags))))
entry-groups)))
(defun elfeed-protocol-advice-update-feed (orig-func url)
"Advice for `elfeed-update-feed` to update protocol feed correctly.
ORIG-FUNC and URL are the needed arguments."
(interactive (list (completing-read "Feed: " (elfeed-feed-list))))
(if (elfeed-protocol-feed-p url)
(let* ((proto-type (elfeed-protocol-type url))
(update-func (elfeed-protocol-update-func proto-type)))
(if update-func
(progn
(unless elfeed--inhibit-update-init-hooks
(run-hooks 'elfeed-update-init-hooks))
(funcall update-func (elfeed-protocol-url url))
(run-hook-with-args 'elfeed-update-hooks url))
(elfeed-log 'error "elfeed-protocol: there is not updater for protocol %s"
proto-type)))
(funcall orig-func url)))
(defun elfeed-protocol-advice-feed-list ()
"Advice for `elfeed-feed-list' to avoid error checking on protocol feeds and use
`elfeed-protocol-feeds' instead of `elfeed-feeds'."
(when (eq (length elfeed-protocol-feeds) 0)
(elfeed-log 'warn "elfeed-protocol: elfeed-protocol-feeds is empty, please setup it instead of elfeed-feeds since 0.9.0"))
(cl-loop for feed in elfeed-protocol-feeds
when (listp feed) collect (car feed)
else collect feed))
;;;###autoload
(defun elfeed-protocol-enable ()
"Enable hooks and advices for elfeed-protocol."
(interactive)
(advice-add 'elfeed-feed-list :override #'elfeed-protocol-advice-feed-list)
(advice-add 'elfeed-update-feed :around #'elfeed-protocol-advice-update-feed)
(add-hook 'elfeed-tag-hooks 'elfeed-protocol-on-tag-add)
(add-hook 'elfeed-untag-hooks 'elfeed-protocol-on-tag-remove)
(dolist (protocol elfeed-protocol-enabled-protocols)
(let ((feature (intern (concat "elfeed-protocol-" (symbol-name protocol)))))
(if (require feature nil t)
(elfeed-protocol-register
(symbol-name protocol)
(list :update (intern (concat (symbol-name feature) "-update"))
:pre-tag (intern (concat (symbol-name feature) "-pre-tag"))
:pre-untag (intern (concat (symbol-name feature) "-pre-untag"))))
(error "Problems while trying to load feature `%s'" feature)))))
;;;###autoload
(defun elfeed-protocol-disable ()
"Disable hooks and advices for elfeed-protocol."
(interactive)
(advice-remove 'elfeed-feed-list #'elfeed-protocol-advice-feed-list)
(advice-remove 'elfeed-update-feed #'elfeed-protocol-advice-update-feed)
(remove-hook 'elfeed-tag-hooks 'elfeed-protocol-on-tag-add)
(remove-hook 'elfeed-untag-hooks 'elfeed-protocol-on-tag-remove)
(dolist (protocol elfeed-protocol-enabled-protocols)
(elfeed-protocol-unregister (symbol-name protocol))))
(provide 'elfeed-protocol)
;;; elfeed-protocol.el ends here