-
Notifications
You must be signed in to change notification settings - Fork 18
/
elfeed-protocol-ttrss.el
794 lines (739 loc) · 41.3 KB
/
elfeed-protocol-ttrss.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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
;;; elfeed-protocol-ttrss.el --- Tiny Tiny RSS protocol for elfeed -*- lexical-binding: t; -*-
;;; Commentary:
;; Tiny Tiny RSS protocol for elfeed.
(require 'cl-lib)
(require 'json)
(require 'url)
(require 'subr-x)
(require 'elfeed)
(require 'elfeed-protocol-common)
;;; Code:
(defcustom elfeed-protocol-ttrss-sid nil
"Tiny Tiny RSS session id.
Will generate one if is empty or invalid."
:group 'elfeed-protocol
:type 'string)
(defcustom elfeed-protocol-ttrss-maxsize 200
"Maximize entries size for each request.
As the document said, before API level 6 maximum amount of returned headlines is
capped at 60, API 6 and above sets it to 200. So set bigger than 200 just
invalid."
:group 'elfeed-protocol
:type 'integer)
(defcustom elfeed-protocol-ttrss-star-tag 'star
"Default star tag for Tiny Tiny RSS entry.
If one entry set or remove the tag,
then the starred state in Tiny Tiny RSS will be synced, too."
:group 'elfeed-protocol
:type 'symbol)
(defcustom elfeed-protocol-ttrss-publish-tag 'publish
"Default publish tag for Tiny Tiny RSS entry.
If one entry set or remove the tag,
then the published state in Tiny Tiny RSS will be synced, too."
:group 'elfeed-protocol
:type 'symbol)
(defcustom elfeed-protocol-ttrss-fetch-category-as-tag t
"If true, tag the Tiny Tiny RSS feed category to feed item."
:group 'elfeed-protocol
:type 'boolean)
(defvar elfeed-protocol-ttrss-categories (make-hash-table :test 'equal)
"Category list from Tiny Tiny RSS, will be used to tag entries with their TTRSS category.")
(defvar elfeed-protocol-ttrss-feeds (make-hash-table :test 'equal)
"Feed list from Tiny Tiny RSS, will be filled before updating operation.")
(defconst elfeed-protocol-ttrss-api-base "/api/")
(defconst elfeed-protocol-ttrss-api-max-limit 200)
(defconst elfeed-protocol-ttrss-api-status-ok 0)
(defconst elfeed-protocol-ttrss-api-status-err 1)
(defconst elfeed-protocol-ttrss-api-feed-id-starred -1)
(defconst elfeed-protocol-ttrss-api-feed-id-published -2)
(defconst elfeed-protocol-ttrss-api-feed-id-fresh -3)
(defconst elfeed-protocol-ttrss-api-feed-id-all-articles -4)
(defconst elfeed-protocol-ttrss-api-feed-id-archived 0)
(defconst elfeed-protocol-ttrss-api-view-mode-all-articles "all_articles")
(defconst elfeed-protocol-ttrss-api-view-mode-unread "unread")
(defconst elfeed-protocol-ttrss-api-view-mode-adaptive "adaptive")
(defconst elfeed-protocol-ttrss-api-view-mode-marked "marked")
(defconst elfeed-protocol-ttrss-api-view-mode-updated "updated")
(defconst elfeed-protocol-ttrss-api-update-article-field-starred 0)
(defconst elfeed-protocol-ttrss-api-update-article-field-published 1)
(defconst elfeed-protocol-ttrss-api-update-article-field-unread 2)
(defconst elfeed-protocol-ttrss-api-update-article-field-article-note 3)
(defun elfeed-protocol-ttrss-id (url)
"Get ttrss protocol id with URL."
(elfeed-protocol-id "ttrss" url))
(defun elfeed-protocol-ttrss--init-headers ()
"Get http request headers for ttrss."
`(("User-Agent" . ,elfeed-user-agent)
("Content-Type" . "application/json")))
(defun elfeed-protocol-ttrss-get-update-mark (proto-id update-action)
"Get last update mark for special UPDATE-ACTION.
PROTO-ID is the target protocol feed id. UPDATE-ACTION could be update,
update-older or update-star. If not initialized, just return -1."
(interactive (list (completing-read "Protocol Feed: " (elfeed-protocol-feed-list))
(intern (completing-read "Update action: " '(update update-older update-star)))))
(let* ((key (cond
((eq update-action 'update) :last-entry-id)
((eq update-action 'update-older) :first-entry-id)
((eq update-action 'update-star) :star-entry-skip)))
(mark (elfeed-protocol-get-feed-meta-data proto-id key)))
(if mark mark -1)))
(defun elfeed-protocol-ttrss-set-update-mark (proto-id update-action mark)
"Set last update mark to elfeed db.
PROTO-ID is the target protocol feed id. UPDATE-ACTION could be update,
update-older or update-star. MARK the target value."
(interactive (list (completing-read "Protocol Feed: " (elfeed-protocol-feed-list))
(intern (completing-read "Update action: " '(update update-older update-star)))
(read-number "Mark number: ")))
(let* ((key (cond
((eq update-action 'update) :last-entry-id)
((eq update-action 'update-older) :first-entry-id)
((eq update-action 'update-star) :star-entry-skip))))
(elfeed-protocol-set-feed-meta-data proto-id key mark)))
(defmacro elfeed-protocol-ttrss-with-fetch (host-url method data &rest body)
"Just like `elfeed-with-fetch' but special for ttrss HTTP request.
HOST-URL is the host name of Tiny Tiny RSS server, METHOD could be
\"GET\" or \"POST\", DATA is in JSON string format. Optional argument
BODY is the rest Lisp code after operation finished."
(declare (indent defun))
`(let* ((use-curl elfeed-use-curl) ; capture current value in closure
(url (concat ,host-url elfeed-protocol-ttrss-api-base))
(headers (elfeed-protocol-ttrss--init-headers))
(no-auth-url (elfeed-protocol-no-auth-url url))
(cb (lambda (status)
(if (elfeed-is-status-error status use-curl)
(let ((print-escape-newlines t))
(elfeed-handle-http-error
no-auth-url
(if use-curl elfeed-curl-error-message status)))
(progn
(unless use-curl
(elfeed-move-to-first-empty-line)
(set-buffer-multibyte t))
(when elfeed-protocol-log-trace
(elfeed-log 'debug "elfeed-protocol-ttrss: %s" (buffer-string)))
(elfeed-protocol-ttrss--parse-result ,@body)
(unless use-curl
(kill-buffer)))))))
(if use-curl
(elfeed-curl-enqueue no-auth-url cb :headers headers
:method ,method :data ,data)
(let ((url-request-extra-headers headers)
(url-request-method ,method)
(url-request-data ,data))
(url-retrieve no-auth-url cb () t t)))))
(defmacro elfeed-protocol-ttrss--parse-result (&rest body)
"Parse ttrss api result JSON buffer.
Will eval rest BODY expressions at end."
(declare (indent defun))
`(let* ((result (json-read))
(api-status (map-elt result 'status))
(content (map-elt result 'content)))
(if (eq api-status elfeed-protocol-ttrss-api-status-err)
(elfeed-log 'error "elfeed-protocol-ttrss: %s" (map-elt content 'error))
,@body)))
(defmacro elfeed-protocol-ttrss-fetch-prepare (host-url &rest body)
"Ensure logged in and feed list updated before expressions.
HOST-URL is the host name of Tiny Tiny RSS server. And will eval rest
BODY expressions after login. The success session id will saved to
`elfeed-protocol-ttrss-sid'"
(declare (indent defun))
`(if elfeed-protocol-ttrss-sid
(let* ((data-list-isloggedin `(("op" . "isLoggedIn")
("sid" . ,elfeed-protocol-ttrss-sid))))
(elfeed-log 'debug "elfeed-protocol-ttrss: check is logged in")
(elfeed-protocol-ttrss-with-fetch
,host-url "POST" (json-encode-alist data-list-isloggedin)
(if (eq (map-elt content 'status) ':json-false)
(elfeed-protocol-ttrss--login
,host-url
(lambda ()
(elfeed-protocol-ttrss--update-feed-list
,host-url (lambda () ,@body))))
(elfeed-protocol-ttrss--update-feed-list
,host-url (lambda () ,@body)))))
(elfeed-protocol-ttrss--login
,host-url
(lambda ()
(elfeed-protocol-ttrss--update-feed-list
,host-url (lambda () ,@body))))))
(defun elfeed-protocol-ttrss--login (host-url &optional callback)
"Login remote Tiny Tiny RSS server.
The success session id will saved to
`elfeed-protocol-ttrss-sid'. HOST-URL is the target Tiny Tiny RSS
server url, and will call CALLBACK after login."
(elfeed-log 'debug "elfeed-protocol-ttrss: login")
(let* ((proto-id (elfeed-protocol-ttrss-id host-url))
(user (elfeed-protocol-meta-user proto-id))
(password (elfeed-protocol-meta-password proto-id))
(data-list `(("op" . "login")
("user" . ,user)
("password" . ,password)))
(data (json-encode-alist data-list)))
(elfeed-protocol-ttrss-with-fetch
host-url "POST" data
(setq elfeed-protocol-ttrss-sid (map-elt content 'session_id))
(when callback (funcall callback)))))
(defun elfeed-protocol-ttrss--update-categories-list (host-url &optional callback)
"Update Tiny Tiny RSS server categories list.
HOST-URL is the host name of Tiny Tiny RSS server. Will call CALLBACK
at end."
(elfeed-log 'debug "elfeed-protocol-ttrss: update cagetory list")
(let* ((data-list `(("op" . "getCategories")
("sid" . ,elfeed-protocol-ttrss-sid)))
(data (json-encode-alist data-list)))
(elfeed-protocol-ttrss-with-fetch
host-url "POST" data
(elfeed-protocol-ttrss--parse-categories host-url content)
(when callback (funcall callback)))))
(defun elfeed-protocol-ttrss--parse-categories (host-url content)
"Parse the feeds JSON buffer and cache the result.
HOST-URL is the host name of Tiny Tiny RSS server. CONTENT is the
result JSON content by http request. Return cached
`elfeed-protocol-ttrss-categories'."
(let* ((proto-id (elfeed-protocol-ttrss-id host-url))
(categories content))
(puthash proto-id categories elfeed-protocol-ttrss-categories)
elfeed-protocol-ttrss-categories))
(defun elfeed-protocol-ttrss--get-category-name (host-url category-id)
"Return category name from HOST-URL for CATEGORY-ID."
(let* ((proto-id (elfeed-protocol-ttrss-id host-url))
(categories (gethash proto-id elfeed-protocol-ttrss-categories))
(category (cl-some (lambda (category)
(let ((id (cdr (assoc 'id category)))
(category-name (cdr (assoc 'title category))))
(if (eq id category-id) category-name))) categories)))
category))
(defun elfeed-protocol-ttrss--update-feed-list (host-url &optional callback)
"Update Tiny Tiny RSS server feeds list.
HOST-URL is the host name of Tiny Tiny RSS server. Will call CALLBACK
at end."
(elfeed-log 'debug "elfeed-protocol-ttrss: update feed list")
(let* ((data-list `(("op" . "getFeeds")
("sid" . ,elfeed-protocol-ttrss-sid)
("cat_id" . "-3")))
(data (json-encode-alist data-list))
(parse-feeds-func (lambda ()
(elfeed-protocol-ttrss-with-fetch
host-url "POST" data
(elfeed-protocol-ttrss--parse-feeds host-url content)
(when callback (funcall callback))))))
(if elfeed-protocol-ttrss-fetch-category-as-tag
(elfeed-protocol-ttrss--update-categories-list host-url parse-feeds-func)
(funcall parse-feeds-func))))
(defun elfeed-protocol-ttrss--parse-feeds (host-url content)
"Parse the feeds JSON buffer and fill results to db.
HOST-URL is the host name of Tiny Tiny RSS server. CONTENT is the
result JSON content by http request. Return
`elfeed-protocol-ttrss-feeds'."
(let* ((proto-id (elfeed-protocol-ttrss-id host-url))
(feeds content))
(puthash proto-id feeds elfeed-protocol-ttrss-feeds)
(cl-loop for feed across feeds do
(let* ((feed-url (map-elt feed 'feed_url))
(feed-id (elfeed-protocol-format-subfeed-id
proto-id feed-url))
(feed-title (elfeed-cleanup (map-elt feed 'title)))
(feed-db (elfeed-db-get-feed feed-id)))
(setf (elfeed-feed-url feed-db) feed-id
(elfeed-feed-title feed-db) feed-title)))
(elfeed-log 'debug "elfeed-protocol-ttrss: found %s feeds" (length feeds))
elfeed-protocol-ttrss-feeds))
(defun elfeed-protocol-ttrss--get-subfeed-url (host-url feed-id)
"Get sub feed url for the ttrss protocol feed HOST-URL and FEED-ID."
(let* ((url (catch 'found
(let* ((proto-id (elfeed-protocol-ttrss-id host-url))
(feeds (gethash proto-id elfeed-protocol-ttrss-feeds))
(length (length feeds)))
(dotimes (i length)
(let* ((feed (elt feeds i))
(id (map-elt feed 'id))
(url (map-elt feed 'feed_url)))
(when (eq id feed-id)
(throw 'found url))))))))
(unless url
(setq url elfeed-protocol-unknown-feed-url)
(elfeed-log 'warn "elfeed-protocol-ttrss: no subfeed for feed id %s, fallback to unknown feed" feed-id))
url))
(defun elfeed-protocol-ttrss--get-subfeed-id (host-url feed-url)
"Get sub feed id for the ttrss protocol feed HOST-URL and FEED-URL."
(let* ((id (catch 'found
(let* ((proto-id (elfeed-protocol-ttrss-id host-url))
(feeds (gethash proto-id elfeed-protocol-ttrss-feeds))
(length (length feeds)))
(dotimes (i length)
(let* ((feed (elt feeds i))
(id (map-elt feed 'id))
(url (map-elt feed 'feed_url)))
(when (string= url feed-url)
(throw 'found id))))))))
(unless id
(elfeed-log 'error "elfeed-protocol-ttrss: no subfeed for feed url %s" feed-url))
id))
(defun elfeed-protocol-ttrss--get-subfeed-category-id (host-url feed-id)
"Get sub feed category id for the ttrss protocol feed HOST-URL and FEED-ID."
(let* ((category-id
(catch 'found
(let* ((proto-id (elfeed-protocol-ttrss-id host-url))
(feeds (gethash proto-id elfeed-protocol-ttrss-feeds))
(length (length feeds)))
(dotimes (i length)
(let* ((feed (elt feeds i))
(id (map-elt feed 'id))
(category-id (map-elt feed 'cat_id)))
(when (eq id feed-id)
(throw 'found category-id))))))))
category-id))
(defun elfeed-protocol-ttrss--get-subfeed-id-by-title (host-url feed-title)
"Get sub feed id for the ttrss protocol feed HOST-URL and FEED-TITLE."
(let* ((id (catch 'found
(let* ((proto-id (elfeed-protocol-ttrss-id host-url))
(feeds (gethash proto-id elfeed-protocol-ttrss-feeds))
(length (length feeds)))
(dotimes (i length)
(let* ((feed (elt feeds i))
(id (map-elt feed 'id))
(title (map-elt feed 'title)))
(when (string= title feed-title)
(throw 'found id))))))))
(unless id
(elfeed-log 'error "elfeed-protocol-ttrss: no subfeed for feed title %s" feed-title))
id))
(defun elfeed-protocol-ttrss-entry-p (entry)
"Check if specific ENTRY is fetched from Tiny Tiny RSS."
(let* ((proto-id (elfeed-protocol-entry-protocol-id entry))
(proto-type (when proto-id (elfeed-protocol-type proto-id))))
(string= proto-type "ttrss")))
(defun elfeed-protocol-ttrss--parse-entries (host-url content &optional mark-state update-action callback)
"Parse the entries JSON buffer and fill results to elfeed db.
HOST-URL is the host name of Tiny Tiny RSS server. CONTENT is the result JSON
content by http request. If MARK-STATE is nil, then just not update
:last-entry-id, :first-entry-id or :star-entry-skip values. UPDATE-ACTION
could be update, update-older or update-star. If CALLBACK is not nil, will call
it with the result entries as argument. Return parsed entries."
(if (> (hash-table-count elfeed-protocol-ttrss-feeds) 0)
(let* ((proto-id (elfeed-protocol-ttrss-id host-url))
(entry-mark (elfeed-protocol-ttrss-get-update-mark proto-id update-action))
(min-entry-id -1)
(max-entry-id -1)
(first-entry-id -1)
(unread-num 0)
(starred-num 0)
(begin-time (time-to-seconds))
(headlines content)
entries)
(elfeed-log 'debug "elfeed-protocol-ttrss: %s, parsing entries, entry-mark: %d" update-action entry-mark)
(setq entries
(cl-loop for headline across headlines
when
(pcase-let* (((map ('feed_id feed-id)
('feed_title feed-title))
headline)
(feed-id
(if (null feed-id)
(elfeed-protocol-ttrss--get-subfeed-id-by-title host-url feed-title)
(if (stringp feed-id) (string-to-number feed-id) feed-id))))
feed-id)
collect
(pcase-let* (((map id ('link entry-url) title
author ('updated pub-date) ('content body)
('tags ttrss-tags) ; attachments
('feed_id feed-id)
('feed_title feed-title)
('guid guid-hash))
headline)
(id (if (stringp id) (string-to-number id) id))
(guid-hash
;; use bulit-in guid hash if exists, or just generate one
(if (null guid-hash)
(elfeed-generate-id (format "%s%s%s%s" title entry-url pub-date body))
guid-hash))
(feed-id
(if (null feed-id)
(elfeed-protocol-ttrss--get-subfeed-id-by-title host-url feed-title)
(if (stringp feed-id) (string-to-number feed-id) feed-id)))
(feed-url
(if (null feed-id)
""
(elfeed-protocol-ttrss--get-subfeed-url host-url feed-id)))
(unread (not (eq (map-elt headline 'unread)
':json-false)))
(starred (not (eq (map-elt headline 'marked)
':json-false)))
(published (not (eq (map-elt headline 'published)
':json-false)))
(namespace (elfeed-url-to-namespace feed-url))
(full-id (cons namespace (elfeed-cleanup guid-hash)))
(original (elfeed-db-get-entry full-id))
(original-date (and original
(elfeed-entry-date original)))
(category-name (when elfeed-protocol-ttrss-fetch-category-as-tag
(elfeed-protocol-ttrss--get-category-name
host-url
(elfeed-protocol-ttrss--get-subfeed-category-id host-url feed-id))))
(autotags (elfeed-protocol-feed-autotags proto-id feed-url))
(fixtags (elfeed-normalize-tags
autotags elfeed-initial-tags))
(tags (progn
(unless unread
(setq fixtags (delete 'unread fixtags)))
(when starred
(push elfeed-protocol-ttrss-star-tag fixtags))
(when category-name
(push (intern category-name) fixtags))
(when published
(push elfeed-protocol-ttrss-publish-tag fixtags))
fixtags))
(db-entry (elfeed-entry--create
:title (elfeed-cleanup title)
:id full-id
:feed-id (elfeed-protocol-format-subfeed-id
proto-id feed-url)
:link (elfeed-cleanup entry-url)
:tags tags
:date (elfeed-new-date-for-entry
original-date pub-date)
;; :enclosures nil ;; ;;TODO: fill attachments
:content body
:content-type 'html
:meta `(,@(elfeed-protocol-build-meta-author author)
,@(list :protocol-id proto-id
:id id
:guid-hash guid-hash
:feed-id feed-id)))))
(when unread (setq unread-num (1+ unread-num)))
(when starred (setq starred-num (1+ starred-num)))
;; force override unread and star tags without repeat sync operation
(when original
(if unread (elfeed-tag-1 original 'unread)
(elfeed-untag-1 original 'unread))
(if starred (elfeed-tag-1 original elfeed-protocol-ttrss-star-tag)
(elfeed-untag-1 original elfeed-protocol-ttrss-star-tag))
(if published (elfeed-tag-1 original elfeed-protocol-ttrss-publish-tag)
(elfeed-untag-1 original elfeed-protocol-ttrss-publish-tag)))
(when (> id max-entry-id)
(setq max-entry-id id))
(if (< min-entry-id 0)
(setq min-entry-id id)
(when (< id min-entry-id)
(setq min-entry-id id)))
(dolist (hook elfeed-new-entry-parse-hook)
(run-hook-with-args hook :ttrss headline db-entry))
db-entry)))
(elfeed-db-add entries)
(when callback (funcall callback entries))
;; update last entry skip count
(when mark-state
(if (>= entry-mark 0)
;; update entry mark
(cond
((eq update-action 'update-star)
(elfeed-protocol-ttrss-set-update-mark
proto-id update-action (+ entry-mark (length entries))))
((eq update-action 'update)
(elfeed-protocol-ttrss-set-update-mark
proto-id update-action (max entry-mark max-entry-id)))
((eq update-action 'update-older)
(let* ((id (max 1 (- entry-mark elfeed-protocol-ttrss-maxsize))))
(elfeed-protocol-ttrss-set-update-mark
proto-id update-action id))))
;; init entry mark
(setq first-entry-id (max 1 max-entry-id))
(cond
((eq update-action 'update)
(elfeed-protocol-ttrss-set-update-mark proto-id update-action first-entry-id)
;; set :first-entry-id same with :last-entry-id
(elfeed-protocol-ttrss-set-update-mark proto-id 'update-older first-entry-id))
((eq update-action 'update-older)
(elfeed-protocol-ttrss-set-update-mark proto-id update-action first-entry-id))
;; init star skip
((eq update-action 'update-star)
(elfeed-protocol-ttrss-set-update-mark proto-id update-action (length entries))))))
(elfeed-log 'debug "elfeed-protocol-ttrss: %s, parsed %d entries(%d unread, %d starred, min-entry-id %d, max-entry-id %d) with %fs, entry-mark: %d"
update-action (length entries) unread-num starred-num min-entry-id max-entry-id
(- (time-to-seconds) begin-time)
(elfeed-protocol-ttrss-get-update-mark proto-id update-action))
entries)
(progn
(elfeed-log 'error "elfeed-protocol-ttrss: elfeed-protocol-ttrss-feeds is nil, please call elfeed-protocol-ttrss--update-feed-list first")
nil)))
(defun elfeed-protocol-ttrss--do-update (host-url action &optional arg callback)
"Real ttrss protocol updating operations.
HOST-URL is the host name of Tiny Tiny RSS server, and user field authentication
info is always required so could find the related protocol feed id correctly,
for example \"https://user:[email protected]\". ACTION could be init, update,
update-older, update-star and update-subfeed. For init, will fetch unread,
starred and latest entries. For update and update-older, will fetch entries with
article ids, the ARG is the ids. For update-star, will fetch starred entries
after the skipped count, the ARG is the skip count. And for update-subfeed, will
fetch latest entries for special feed, the ARG is the feed id. If CALLBACK is
not nil, will call it with the result entries as argument."
(elfeed-log 'debug "elfeed-protocol-ttrss: update entries with action %s, arg %s" action arg)
(let* ((proto-id (elfeed-protocol-ttrss-id host-url))
(data-list-base `(("op" . "getHeadlines")
("sid" . ,elfeed-protocol-ttrss-sid)
("show_content" . "1")
("include_attachments" . "1")
("order_by" . "date_reverse")
("limit" . ,elfeed-protocol-ttrss-maxsize)))
(data-list-starred (append data-list-base
`(("feed_id" .
,elfeed-protocol-ttrss-api-feed-id-starred)
("view_mode" .
,elfeed-protocol-ttrss-api-view-mode-all-articles))))
(data-list-unread (append data-list-base
`(("feed_id" .
,elfeed-protocol-ttrss-api-feed-id-all-articles)
("view_mode" .
,elfeed-protocol-ttrss-api-view-mode-unread)))))
(unless elfeed--inhibit-update-init-hooks
(run-hooks 'elfeed-update-init-hooks))
(cond
;; initial sync, fetch starred, unread and latest entries
((eq action 'init)
(elfeed-protocol-ttrss-set-update-mark proto-id 'update -1)
(elfeed-protocol-ttrss-set-update-mark proto-id 'update-older -1)
(elfeed-protocol-ttrss-set-update-mark proto-id 'update-star -1)
(elfeed-protocol-clean-pending-ids proto-id)
(elfeed-protocol-ttrss-with-fetch
host-url "POST" (json-encode-alist data-list-starred)
(elfeed-protocol-ttrss--parse-entries host-url content t 'update-star callback)
(elfeed-protocol-ttrss-with-fetch
host-url "POST" (json-encode-alist data-list-unread)
(elfeed-protocol-ttrss--parse-entries host-url content t 'update callback)
(run-hook-with-args 'elfeed-update-hooks host-url))))
;; update older or latest entries
((or (eq action 'update) (eq action 'update-older))
(let* ((data-list-article `(("op" . "getArticle")
("sid" . ,elfeed-protocol-ttrss-sid)
("article_id" . ,arg))))
(elfeed-protocol-ttrss-with-fetch
host-url "POST" (json-encode-alist data-list-article)
(elfeed-protocol-ttrss--parse-entries host-url content t action callback)
(run-hook-with-args 'elfeed-update-hooks host-url))))
;; update starred entries
((eq action 'update-star)
(let* ((data-list-skip (append data-list-starred
`(("skip" . ,arg)))))
(elfeed-protocol-ttrss-with-fetch
host-url "POST" (json-encode-alist data-list-skip)
(elfeed-protocol-ttrss--parse-entries host-url content t action callback)
(run-hook-with-args 'elfeed-update-hooks host-url))))
;; update entries for special sub feed
((eq action 'update-subfeed)
(let* ((feed-id arg)
(data-list-feed (append data-list-base
`(("feed_id" . ,feed-id)
("view_mode" .
,elfeed-protocol-ttrss-api-view-mode-all-articles)))))
(elfeed-protocol-ttrss-with-fetch
host-url "POST" (json-encode-alist data-list-feed)
(elfeed-protocol-ttrss--parse-entries host-url content nil 'update callback)
(run-hook-with-args 'elfeed-update-hooks host-url)))))))
(defun elfeed-protocol-ttrss-reinit (host-url)
"Retry initial sync operation.
Will fetch unread, starred and latest entries from Tiny Tiny RSS.
HOST-URL is the host name of Tiny Tiny RSS server."
(interactive (list (elfeed-protocol-url
(completing-read "Protocol Feed: " (elfeed-protocol-feed-list)))))
(elfeed-protocol-ttrss-fetch-prepare
host-url
(elfeed-protocol-ttrss--do-update host-url 'init)))
(defun elfeed-protocol-ttrss-update-older (host-url)
"Fetch older entries.
HOST-URL is the host name of Tiny Tiny RSS server."
(interactive (list (elfeed-protocol-url
(completing-read "Protocol Feed: " (elfeed-protocol-feed-list)))))
(let* ((proto-id (elfeed-protocol-ttrss-id host-url))
(first-entry-id (elfeed-protocol-ttrss-get-update-mark proto-id 'update-older))
(ids (elfeed-protocol-generate-ids-str ","
(max 1 (- first-entry-id elfeed-protocol-ttrss-maxsize))
(max 1 (- first-entry-id 1)))))
(elfeed-protocol-ttrss-fetch-prepare
host-url
(elfeed-protocol-ttrss--do-update host-url 'update-older ids))))
(defun elfeed-protocol-ttrss-update-star (host-url)
"Fetch starred entries.
For Tiny Tiny RSS only allow fetch Maximize 200 entries each time, so if your
own much more starred entries, just run this function to fetch them all.
HOST-URL is the host name of Tiny Tiny RSS server."
(interactive (list (elfeed-protocol-url
(completing-read "Protocol Feed: " (elfeed-protocol-feed-list)))))
(let* ((proto-id (elfeed-protocol-ttrss-id host-url))
(star-skip (elfeed-protocol-ttrss-get-update-mark proto-id 'update-star)))
(elfeed-protocol-ttrss-fetch-prepare
host-url
(elfeed-protocol-ttrss--do-update host-url 'update-star star-skip))))
(defun elfeed-protocol-ttrss--update-article (host-url ids field mode)
"Notify multiple entries to be read/unread/starred/unstarred.
HOST-URL is the host name of Tiny Tiny RSS server. IDS is the
target entry ids. FIELD could be 0, 1, 2, 3 which means starred,
published, unread, and article note. MODE could be 0, 1, 2 which
means set to false, set to true and toggle."
(let* ((data-list `(("op" . "updateArticle")
("sid" . ,elfeed-protocol-ttrss-sid)
("article_ids" .
,(apply #'elfeed-protocol-join-ids-to-str "," ids))
("field" . ,field)
("mode" . ,mode)))
(data (json-encode-alist data-list)))
(when ids
(elfeed-protocol-ttrss-with-fetch
host-url "POST" data))))
(defun elfeed-protocol-ttrss-mark-read-multi (host-url ids)
"Notify multiple entries to be read.
HOST-URL is the host name of Tiny Tiny RSS server. IDS is the target entry
ids."
(elfeed-log 'debug "elfeed-protocol-ttrss: mark read, ids: %s" ids)
(elfeed-protocol-ttrss--update-article
host-url ids elfeed-protocol-ttrss-api-update-article-field-unread 0))
(defun elfeed-protocol-ttrss-mark-unread-multi (host-url ids)
"Notify multiple entries to be unread.
HOST-URL is the host name of Tiny Tiny RSS server. IDS is the target entry
ids."
(elfeed-log 'debug "elfeed-protocol-ttrss: mark unread, ids: %s" ids)
(elfeed-protocol-ttrss--update-article
host-url ids elfeed-protocol-ttrss-api-update-article-field-unread 1))
(defun elfeed-protocol-ttrss-mark-starred-multi (host-url ids)
"Notify multiple entries to be starred.
HOST-URL is the host name of Tiny Tiny RSS server. IDS is the target entry
ids."
(elfeed-log 'debug "elfeed-protocol-ttrss: mark starred, ids: %s" ids)
(elfeed-protocol-ttrss--update-article
host-url ids elfeed-protocol-ttrss-api-update-article-field-starred 1))
(defun elfeed-protocol-ttrss-mark-unstarred-multi (host-url ids)
"Notify multiple entries to be unstarred.
HOST-URL is the host name of Tiny Tiny RSS server. IDS is the target entry
ids."
(elfeed-log 'debug "elfeed-protocol-ttrss: mark unstarred, ids: %s" ids)
(elfeed-protocol-ttrss--update-article
host-url ids elfeed-protocol-ttrss-api-update-article-field-starred 0))
(defun elfeed-protocol-ttrss-mark-published-multi (host-url ids)
"Notify multiple entries to be published.
HOST-URL is the host name of Tiny Tiny RSS server. IDS is the target entry
ids."
(elfeed-log 'debug "elfeed-protocol-ttrss: mark published, ids: %s" ids)
(elfeed-protocol-ttrss--update-article
host-url ids elfeed-protocol-ttrss-api-update-article-field-published 1))
(defun elfeed-protocol-ttrss-mark-unpublished-multi (host-url ids)
"Notify multiple entries to be unpublished.
HOST-URL is the host name of Tiny Tiny RSS server. IDS is the target entry
ids."
(elfeed-log 'debug "elfeed-protocol-ttrss: mark unpublished, ids: %s" ids)
(elfeed-protocol-ttrss--update-article
host-url ids elfeed-protocol-ttrss-api-update-article-field-published 0))
(defun elfeed-protocol-ttrss-sync-pending-ids (host-url)
"Sync pending read/unread/starred/unstarred/published/unpublished entry states to Tiny Tiny RSS server.
HOST-URL is the host name of Tiny Tiny RSS server."
(let* ((proto-id (elfeed-protocol-ttrss-id host-url))
(pending-read-ids (elfeed-protocol-get-pending-ids proto-id :pending-read))
(pending-unread-ids (elfeed-protocol-get-pending-ids proto-id :pending-unread))
(pending-starred-ids (elfeed-protocol-get-pending-ids proto-id :pending-starred))
(pending-unstarred-ids (elfeed-protocol-get-pending-ids proto-id :pending-unstarred))
(pending-published-ids (elfeed-protocol-get-pending-ids proto-id :pending-published))
(pending-unpublished-ids (elfeed-protocol-get-pending-ids proto-id :pending-unpublished)))
(when pending-read-ids (elfeed-protocol-ttrss-mark-read-multi host-url pending-read-ids))
(when pending-unread-ids (elfeed-protocol-ttrss-mark-unread-multi host-url pending-unread-ids))
(when pending-starred-ids (elfeed-protocol-ttrss-mark-starred-multi host-url pending-starred-ids))
(when pending-unstarred-ids (elfeed-protocol-ttrss-mark-unstarred-multi host-url pending-unstarred-ids))
(when pending-published-ids (elfeed-protocol-ttrss-mark-published-multi host-url pending-published-ids))
(when pending-unpublished-ids (elfeed-protocol-ttrss-mark-unpublished-multi host-url pending-unpublished-ids))
(elfeed-protocol-clean-pending-ids proto-id)))
(defun elfeed-protocol-ttrss-append-pending-ids (host-url entries tag action)
"Sync unread starred and published tag states to Tiny Tiny RSS server.
HOST-URL is the host name of Tiny Tiny RSS server. ENTRIES is the
target entry objects. TAG is the action tag, for example unread,
`elfeed-protocol-ttrss-star-tag' and
`elfeed-protocol-ttrss-publish-tag', ACTION could be add or remove."
(when entries
(let* ((proto-id (elfeed-protocol-ttrss-id host-url))
(ids (cl-loop for entry in entries collect
(when (elfeed-protocol-ttrss-entry-p entry)
(elfeed-meta entry :id)))))
(cond
((eq action 'add)
(cond
((eq tag 'unread)
(elfeed-protocol-append-pending-ids proto-id :pending-unread ids)
(elfeed-protocol-remove-pending-ids proto-id :pending-read ids))
((eq tag elfeed-protocol-ttrss-star-tag)
(elfeed-protocol-append-pending-ids proto-id :pending-starred ids)
(elfeed-protocol-remove-pending-ids proto-id :pending-unstarred ids))
((eq tag elfeed-protocol-ttrss-publish-tag)
(elfeed-protocol-append-pending-ids proto-id :pending-published ids)
(elfeed-protocol-remove-pending-ids proto-id :pending-unpublished ids))))
((eq action 'remove)
(cond
((eq tag 'unread)
(elfeed-protocol-append-pending-ids proto-id :pending-read ids)
(elfeed-protocol-remove-pending-ids proto-id :pending-unread ids))
((eq tag elfeed-protocol-ttrss-star-tag)
(elfeed-protocol-append-pending-ids proto-id :pending-unstarred ids)
(elfeed-protocol-remove-pending-ids proto-id :pending-starred ids))
((eq tag elfeed-protocol-ttrss-publish-tag)
(elfeed-protocol-append-pending-ids proto-id :pending-unpublished ids)
(elfeed-protocol-remove-pending-ids proto-id :pending-published ids))))))))
(defun elfeed-protocol-ttrss-pre-tag (host-url entries &rest tags)
"Sync unread, starred and published states before tags added.
HOST-URL is the host name of Tiny Tiny RSS server. ENTRIES is the
target entry objects. TAGS is the tags are adding now."
(dolist (tag tags)
(let* ((entries-modified (cl-loop for entry in entries
unless (elfeed-tagged-p tag entry)
collect entry)))
(elfeed-protocol-ttrss-append-pending-ids host-url entries-modified tag 'add)))
(unless elfeed-protocol-lazy-sync
(elfeed-protocol-ttrss-sync-pending-ids host-url)))
(defun elfeed-protocol-ttrss-pre-untag (host-url entries &rest tags)
"Sync unread, starred and published states before tags removed.
HOST-URL is the host name of Tiny Tiny RSS server. ENTRIES is the
target entry objects. TAGS is the tags are removing now."
(dolist (tag tags)
(let* ((entries-modified (cl-loop for entry in entries
when (elfeed-tagged-p tag entry)
collect entry)))
(elfeed-protocol-ttrss-append-pending-ids host-url entries-modified tag 'remove)))
(unless elfeed-protocol-lazy-sync
(elfeed-protocol-ttrss-sync-pending-ids host-url)))
(defun elfeed-protocol-ttrss-update-subfeed (host-url feed-url &optional callback)
"Update entries under special sub feed in Tiny Tiny RSS.
HOST-URL is the host name of Tiny Tiny RSS server, FEED-URL is the
target sub feed url, if CALLBACK is not nil will call it with the
result entries as argument."
(interactive)
(let* ((feed-id (elfeed-protocol-ttrss--get-subfeed-id host-url feed-url)))
(when feed-id
(elfeed-protocol-ttrss-fetch-prepare
host-url
(elfeed-protocol-ttrss--do-update host-url 'update-subfeed feed-id callback)))))
(defun elfeed-protocol-ttrss-update (host-or-subfeed-url &optional callback)
"Tiny Tiny RSS protocol updater.
HOST-OR-SUBFEED-URL could be the host name of Tiny Tiny RSS server,
and user field authentication info is always required so could find
the related protocol feed id correctly, for example
\"https://[email protected]\". And HOST-OR-SUBFEED-URL also could be the
sub feed url, too, for example
\"https://[email protected]::https://subfeed.com\". If first time run,
it will initial sync operation, or will only fetch the updated entries
since last modified. if CALLBACK is not nil will call it with the
result entries as argument"
(interactive (list (elfeed-protocol-url
(completing-read "Protocol Feed: " (elfeed-protocol-feed-list)))))
(let* ((host-url (elfeed-protocol-host-url host-or-subfeed-url))
(feed-url (elfeed-protocol-subfeed-url host-or-subfeed-url))
(proto-id (elfeed-protocol-ttrss-id host-url)))
(elfeed-protocol-add-unknown-feed proto-id) ; add unknown feed for fallback
(elfeed-protocol-ttrss-sync-pending-ids host-url)
(if feed-url (elfeed-protocol-ttrss-update-subfeed host-url feed-url callback)
(let* ((proto-id (elfeed-protocol-ttrss-id host-url))
(last-entry-id (elfeed-protocol-ttrss-get-update-mark proto-id 'update))
(ids (elfeed-protocol-generate-ids-str
","
(1+ last-entry-id)
(+ last-entry-id elfeed-protocol-ttrss-maxsize))))
(elfeed-protocol-ttrss-fetch-prepare
host-url
(if (>= last-entry-id 0)
(elfeed-protocol-ttrss--do-update host-url 'update ids callback)
(elfeed-protocol-ttrss--do-update host-url 'init nil callback)))))))
(provide 'elfeed-protocol-ttrss)
;;; elfeed-protocol-ttrss.el ends here