-
-
Notifications
You must be signed in to change notification settings - Fork 84
/
Copy pathtelega-sort.el
308 lines (263 loc) · 11.8 KB
/
telega-sort.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
;;; telega-sort.el --- Chat sorting in rootbuf -*- lexical-binding:t -*-
;; Copyright (C) 2020 by Zajcev Evgeny.
;; Author: Zajcev Evgeny <zevlg@yandex.ru>
;; Created: Sat Jan 25 09:42:22 2020
;; Keywords:
;; telega is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; telega is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with telega. If not, see <http://www.gnu.org/licenses/>.
;;; ellit-org: commentary
;;
;; It is possible to sort chats in rootbuf out of Telega built-in
;; order. Sorting chats is done by some criteria. Built-in criterias
;; are in ~telega-sort-criteria-alist~. Do not insert criterias
;; directly into ~telega-sort-criteria-alist~, use
;; ~define-telega-sorter~ instead.
(require 'telega-core)
(declare-function telega-chat--update "telega-tdlib-events" (chat &rest events))
(declare-function telega-root-view--redisplay "telega-root")
(declare-function telega-chat--info "telega-chat" (chat))
(declare-function telega-chat-title "telega-chat" (chat &optional no-badges))
(defvar telega-sort-criteria-alist nil)
(defvar telega-sort--inhibit-order nil
"Bind to non-nil to inhibit chat order when sorting.")
(defvar telega-sort-map
(let ((map (make-sparse-keymap)))
(define-key map (kbd "\\") 'telega-sort-reset)
;; `a' mnemominc is to "add" some sorter
(define-key map (kbd "a") 'telega-sort-by-sorter)
(define-key map (kbd "s") 'telega-sort-by-sorter)
(define-key map (kbd "i") 'telega-sort-by-important)
(define-key map (kbd "u") 'telega-sort-by-unread-count)
(define-key map (kbd "t") 'telega-sort-by-title)
(define-key map (kbd "j") 'telega-sort-by-join-date)
(define-key map (kbd "o") 'telega-sort-by-online-members)
(define-key map (kbd "m") 'telega-sort-by-member-count)
(define-key map (kbd "v") 'telega-sort-by-chatbuf-recency)
(define-key map (kbd "!") 'telega-sort-invert)
(define-key map (kbd "d") 'telega-sort-pop-last)
(define-key map (kbd "DEL") 'telega-sort-pop-last)
map)
"Keymap for sorting commands.")
(defmacro define-telega-sorter (name order-events args &rest body)
(declare (indent 3))
(let ((fsym (intern (format "telega--sort-%S" name)))
(cmd (intern (format "telega-sort-by-%S" name))))
`(progn
(put (quote ,name) :telega-order-events (quote ,order-events))
(setq telega-sort-criteria-alist
(push (cons (quote ,name) (quote ,fsym))
telega-sort-criteria-alist))
(defun ,fsym ,args
,@body)
(defun ,cmd ()
,(format "Sort chats by `%S' criteria." name)
(interactive)
(telega-sort-set-active-criteria (list (quote ,name)))))))
(defsubst telega-sort--canonicalize-criteria (criteria)
"Return CRITERIA in canonical (i.e. list) form."
(if (listp criteria)
criteria
(list criteria)))
(defun telega-chats-compare (criteria chat1 chat2)
"Return non-nil if CHAT1 is greater than CHAT2 according to CRITERIA.
CRITERIA could be a lit of sort criterias."
(unless (listp criteria)
(setq criteria (list criteria)))
(if (null criteria)
(unless telega-sort--inhibit-order
;; NOTE: (TDLib docs) "sorted by the pair (chat.position.order,
;; chat.id) in descending order"
(let ((o1 (telega-chat-order chat1))
(o2 (telega-chat-order chat2)))
(if (equal o1 o2)
(> (plist-get chat1 :id) (plist-get chat2 :id))
(string> o1 o2))))
(let* ((cmpfun (alist-get (car criteria) telega-sort-criteria-alist))
(c1-val (funcall cmpfun chat1))
(c2-val (funcall cmpfun chat2))
(result (cond ((equal c1-val c2-val)
;; Traverse the criteria list
(telega-chats-compare (cdr criteria) chat1 chat2))
((null c1-val) nil)
((null c2-val) t)
((and (stringp c1-val) (stringp c2-val))
(string> c1-val c2-val))
(t (> c1-val c2-val)))))
(if (get (car criteria) :telega-sort-inverted)
(not result)
result))))
(defun telega-sort-chats (criteria chats)
"Sort CHATS by criteria."
(sort (copy-sequence chats) (apply-partially 'telega-chats-compare criteria)))
(defun telega-sort-by-sorter (criteria &optional arg)
"Interactively add CRITERIA to active sorter.
If prefix ARG is used, then add sort criteria, instead of
overwriting currently active one."
(interactive
(let ((cname (telega-completing-read
"Sort criteria: "
(mapcar 'symbol-name
(mapcar 'car telega-sort-criteria-alist))
nil t)))
(list (intern cname) current-prefix-arg)))
(telega-sort-set-active-criteria
(append (when arg telega--sort-criteria) (list criteria))))
(defun telega-sort-reset ()
"Reset active sorter."
(interactive)
(telega-sort-set-active-criteria nil))
(defun telega-sort-invert ()
"Invert current active sorter."
(interactive)
(telega-sort-set-active-criteria
telega--sort-criteria (not telega--sort-inverted)))
(defun telega-sort-pop-last ()
"Delete last sorter."
(interactive)
(error "`telega-sort-pop-last' not implemented."))
(defun telega-sort-set-active-criteria (criteria &optional inverted)
"Set CRITERIA as active sort criteria."
(cl-assert (listp criteria))
(when (or (not (equal telega--sort-criteria criteria))
(not (eq telega--sort-inverted inverted)))
(setq telega--sort-criteria criteria)
(setq telega--sort-inverted inverted)
(setq telega--sort-reorder-dirtiness
(apply #'append (mapcar (lambda (criteria-sym)
(get criteria-sym :telega-order-events))
telega--sort-criteria)))
;; NOTE: compare function might do weird things, so
;; `copy-sequence' is used
(setq telega--ordered-chats
(sort (copy-sequence telega--ordered-chats) #'telega-chat>))
(telega-filters--redisplay-footer)
(telega-root-view--redisplay)
))
;;; ellit-org: chat-sorting-criteria
(define-telega-sorter order () (chat)
(telega-chat-order chat))
;;; ellit-org: chat-sorting-criteria
;; - ~unread-count~, {{{where-is(telega-sort-by-unread-count,telega-root-mode-map)}}} ::
;; {{{fundoc(telega--sort-unread-count, 2)}}}
(define-telega-sorter unread-count ("updateChatReadInbox") (chat)
"Sort chats by number of unread messages in chat."
(plist-get chat :unread_count))
;;; ellit-org: chat-sorting-criteria
;; - ~title~, {{{where-is(telega-sort-by-title,telega-root-mode-map)}}} ::
;; {{{fundoc(telega--sort-title, 2)}}}
;;
;; Thanks to https://t.me/Kurvivor
(define-telega-sorter title ("updateChatTitle") (chat)
"Sort chats alphabetically by chat title."
(telega-chat-title chat))
;; Make "A" > "Z", so alphabetical order goes out-of-box
(put 'title :telega-sort-inverted t)
;;; ellit-org: chat-sorting-criteria
;; - ~member-count~, {{{where-is(telega-sort-by-member-count,telega-root-mode-map)}}} ::
;; {{{fundoc(telega--sort-member-count, 2)}}}
(define-telega-sorter member-count ("updateBasicGroup" "updateSupergroup") (chat)
"Sort chats by number of members in the chat."
(plist-get (telega-chat--info chat) :member_count))
;;; ellit-org: chat-sorting-criteria
;; - ~online-members~, {{{where-is(telega-sort-by-online-members,telega-root-mode-map)}}} ::
;; {{{fundoc(telega--sort-online-members, 2)}}}
(define-telega-sorter online-members ("updateChatOnlineMemberCount") (chat)
"Sort chats by number of online members."
(plist-get chat :x-online-count))
;;; ellit-org: chat-sorting-criteria
;; - ~join-date~, {{{where-is(telega-sort-by-join-date,telega-root-mode-map)}}} ::
;; {{{fundoc(telega--sort-join-date, 2)}}}
(define-telega-sorter join-date () (chat)
"Sort chats by join date. Last joined chats goes first."
(let ((info (telega-chat--info chat)))
(cl-case (telega--tl-type info)
(supergroup (plist-get info :date))
(basicGroup
(let* ((full-info (telega--full-info info))
(me-member
(cl-find-if (lambda (member)
(telega-me-p (telega-msg-sender member)))
(plist-get full-info :members))))
(plist-get me-member :joined_chat_date))))))
;;; ellit-org: chat-sorting-criteria
;; - ~chatbuf-recency~, {{{where-is(telega-sort-by-chatbuf-recency,telega-root-mode-map)}}} ::
;; {{{fundoc(telega--sort-chatbuf-recency, 2)}}}
(define-telega-sorter chatbuf-recency () (chat)
"Sort chats by chatbuf recency. Recently used chats goes first."
(or (with-telega-chatbuf chat
(length (memq (current-buffer) (buffer-list))))
-1))
;;; ellit-org: chat-sorting-criteria
;; - ~chatbuf-visibility~ ::
;; {{{fundoc(telega--sort-chatbuf-visibility, 2)}}}
(define-telega-sorter chatbuf-visibility () (chat)
"Sort chats by visibility in other window in DWIM style.
See https://github.com/zevlg/telega.el/issues/165"
(let ((retn (length telega--chat-buffers-alist)))
(if (get-window-with-predicate
(lambda (win)
(with-current-buffer (window-buffer win)
(when (derived-mode-p 'telega-chat-mode)
(cl-decf retn)
(eq telega-chatbuf--chat chat)))))
retn
-1)))
(define-telega-sorter chatbuf-current-is-last () (chat)
"Sort chats making current chatbuf to be last in the list."
(if (eq (current-buffer) (with-telega-chatbuf chat
(current-buffer)))
-1
0))
;;; ellit-org: chat-sorting-criteria
;; - ~chats-in-common~ ::
;; {{{fundoc(telega--sort-chats-in-common, 2)}}}
(define-telega-sorter chats-in-common ("updateUserFullInfo") (chat)
"Sort by number of chats in common.
See https://github.com/zevlg/telega.el/issues/218"
(if-let ((user (telega-chat-user chat)))
(plist-get (telega--full-info user) :group_in_common_count)
-10))
;;; ellit-org: chat-sorting-criteria
;; - ~last-seen~ ::
;; {{{fundoc(telega--sort-last-seen, 2)}}}
(define-telega-sorter last-seen ("updateUserStatus" "updateChatLastMessage") (chat)
"Sort by last seen activity.
For private chats user's last seen date is taken.
For other chats date of the last message is taken."
(if-let ((user (telega-chat-user chat)))
(let ((user-seen (telega-user--seen user)))
(if (equal user-seen "Online")
(time-to-seconds)
(or (plist-get user :telega-last-online)
(pcase (telega-user--seen user)
("Recently" (- (time-to-seconds) 3600))
("LastWeek" (- (time-to-seconds) (* 7 24 3600)))
("LastMonth" (- (time-to-seconds) (* 30 7 24 3600)))
("Offline" 10)
("Empty" 5))
0)))
(or (telega--tl-get chat :last_message :date) 0)))
;;; ellit-org: chat-sorting-criteria
;; - ~important~ ::
;; {{{fundoc(telega--sort-important, 2)}}}
(define-telega-sorter important ("updateChatUnreadMentionCount"
"updateChatUnreadReactionCount"
"updateChatReadInbox")
(chat)
"Makes chats matching `telega-important-chat-temex' on top."
(cond ((telega-chat-match-p chat 'important)
(telega-chat-order chat))
(t "10")))
;; - TODO Date of last message sent by ~telega-user-me~
;; - TODO Date of last mention (thanks to https://t.me/lainposter)
;; - TODO By custom chat temex, i.e. matching chats goes first
(provide 'telega-sort)
;;; telega-sort.el ends here