Commit | Line | Data |
---|---|---|
eec82323 | 1 | ;;; nnvirtual.el --- virtual newsgroups access for Gnus |
23f87bed | 2 | ;; Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003 |
16409b0b | 3 | ;; Free Software Foundation, Inc. |
eec82323 LMI |
4 | |
5 | ;; Author: David Moore <dmoore@ucsd.edu> | |
6748645f | 6 | ;; Lars Magne Ingebrigtsen <larsi@gnus.org> |
23f87bed | 7 | ;; Masanobu UMEDA <umerin@flab.flab.fujitsu.junet> |
eec82323 LMI |
8 | ;; Keywords: news |
9 | ||
10 | ;; This file is part of GNU Emacs. | |
11 | ||
12 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
13 | ;; it under the terms of the GNU General Public License as published by | |
14 | ;; the Free Software Foundation; either version 2, or (at your option) | |
15 | ;; any later version. | |
16 | ||
17 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
18 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
19 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
20 | ;; GNU General Public License for more details. | |
21 | ||
22 | ;; You should have received a copy of the GNU General Public License | |
23 | ;; along with GNU Emacs; see the file COPYING. If not, write to the | |
3a35cf56 LK |
24 | ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
25 | ;; Boston, MA 02110-1301, USA. | |
eec82323 LMI |
26 | |
27 | ;;; Commentary: | |
28 | ||
29 | ;; The other access methods (nntp, nnspool, etc) are general news | |
30 | ;; access methods. This module relies on Gnus and can not be used | |
31 | ;; separately. | |
32 | ||
33 | ;;; Code: | |
34 | ||
35 | (require 'nntp) | |
36 | (require 'nnheader) | |
37 | (require 'gnus) | |
38 | (require 'nnoo) | |
39 | (require 'gnus-util) | |
40 | (require 'gnus-start) | |
41 | (require 'gnus-sum) | |
6748645f | 42 | (require 'gnus-msg) |
eec82323 LMI |
43 | (eval-when-compile (require 'cl)) |
44 | ||
45 | (nnoo-declare nnvirtual) | |
46 | ||
6748645f | 47 | (defvoo nnvirtual-always-rescan t |
23f87bed | 48 | "If non-nil, always scan groups for unread articles when entering a group. |
16409b0b GM |
49 | If this variable is nil and you read articles in a component group |
50 | after the virtual group has been activated, the read articles from the | |
51 | component group will show up when you enter the virtual group.") | |
eec82323 LMI |
52 | |
53 | (defvoo nnvirtual-component-regexp nil | |
23f87bed | 54 | "Regexp to match component groups.") |
eec82323 LMI |
55 | |
56 | (defvoo nnvirtual-component-groups nil | |
57 | "Component group in this nnvirtual group.") | |
58 | ||
59 | \f | |
60 | ||
61 | (defconst nnvirtual-version "nnvirtual 1.1") | |
62 | ||
63 | (defvoo nnvirtual-current-group nil) | |
64 | ||
65 | (defvoo nnvirtual-mapping-table nil | |
16409b0b | 66 | "Table of rules on how to map between component group and article number to virtual article number.") |
eec82323 LMI |
67 | |
68 | (defvoo nnvirtual-mapping-offsets nil | |
69 | "Table indexed by component group to an offset to be applied to article numbers in that group.") | |
70 | ||
71 | (defvoo nnvirtual-mapping-len 0 | |
72 | "Number of articles in this virtual group.") | |
73 | ||
74 | (defvoo nnvirtual-mapping-reads nil | |
75 | "Compressed sequence of read articles on the virtual group as computed from the unread status of individual component groups.") | |
76 | ||
77 | (defvoo nnvirtual-mapping-marks nil | |
78 | "Compressed marks alist for the virtual group as computed from the marks of individual component groups.") | |
79 | ||
80 | (defvoo nnvirtual-info-installed nil | |
81 | "T if we have already installed the group info for this group, and shouldn't blast over it again.") | |
82 | ||
83 | (defvoo nnvirtual-status-string "") | |
84 | ||
85 | (eval-and-compile | |
86 | (autoload 'gnus-cache-articles-in-group "gnus-cache")) | |
87 | ||
88 | \f | |
89 | ||
90 | ;;; Interface functions. | |
91 | ||
92 | (nnoo-define-basics nnvirtual) | |
93 | ||
94 | ||
95 | (deffoo nnvirtual-retrieve-headers (articles &optional newsgroup | |
96 | server fetch-old) | |
97 | (when (nnvirtual-possibly-change-server server) | |
98 | (save-excursion | |
99 | (set-buffer nntp-server-buffer) | |
100 | (erase-buffer) | |
101 | (if (stringp (car articles)) | |
102 | 'headers | |
103 | (let ((vbuf (nnheader-set-temp-buffer | |
104 | (get-buffer-create " *virtual headers*"))) | |
105 | (carticles (nnvirtual-partition-sequence articles)) | |
106 | (system-name (system-name)) | |
107 | cgroup carticle article result prefix) | |
108 | (while carticles | |
109 | (setq cgroup (caar carticles)) | |
110 | (setq articles (cdar carticles)) | |
111 | (pop carticles) | |
112 | (when (and articles | |
113 | (gnus-check-server | |
114 | (gnus-find-method-for-group cgroup) t) | |
115 | (gnus-request-group cgroup t) | |
116 | (setq prefix (gnus-group-real-prefix cgroup)) | |
117 | ;; FIX FIX FIX we want to check the cache! | |
118 | ;; This is probably evil if people have set | |
119 | ;; gnus-use-cache to nil themselves, but I | |
120 | ;; have no way of finding the true value of it. | |
121 | (let ((gnus-use-cache t)) | |
122 | (setq result (gnus-retrieve-headers | |
123 | articles cgroup nil)))) | |
16409b0b GM |
124 | (set-buffer nntp-server-buffer) |
125 | ;; If we got HEAD headers, we convert them into NOV | |
126 | ;; headers. This is slow, inefficient and, come to think | |
127 | ;; of it, downright evil. So sue me. I couldn't be | |
128 | ;; bothered to write a header parse routine that could | |
129 | ;; parse a mixed HEAD/NOV buffer. | |
130 | (when (eq result 'headers) | |
131 | (nnvirtual-convert-headers)) | |
132 | (goto-char (point-min)) | |
133 | (while (not (eobp)) | |
134 | (delete-region (point) | |
135 | (progn | |
136 | (setq carticle (read nntp-server-buffer)) | |
137 | (point))) | |
138 | ||
139 | ;; We remove this article from the articles list, if | |
140 | ;; anything is left in the articles list after going through | |
141 | ;; the entire buffer, then those articles have been | |
142 | ;; expired or canceled, so we appropriately update the | |
143 | ;; component group below. They should be coming up | |
144 | ;; generally in order, so this shouldn't be slow. | |
145 | (setq articles (delq carticle articles)) | |
146 | ||
147 | (setq article (nnvirtual-reverse-map-article cgroup carticle)) | |
148 | (if (null article) | |
149 | ;; This line has no reverse mapping, that means it | |
150 | ;; was an extra article reference returned by nntp. | |
151 | (progn | |
152 | (beginning-of-line) | |
153 | (delete-region (point) (progn (forward-line 1) (point)))) | |
154 | ;; Otherwise insert the virtual article number, | |
155 | ;; and clean up the xrefs. | |
156 | (princ article nntp-server-buffer) | |
157 | (nnvirtual-update-xref-header cgroup carticle | |
158 | prefix system-name) | |
159 | (forward-line 1)) | |
160 | ) | |
161 | ||
162 | (set-buffer vbuf) | |
163 | (goto-char (point-max)) | |
164 | (insert-buffer-substring nntp-server-buffer)) | |
eec82323 LMI |
165 | ;; Anything left in articles is expired or canceled. |
166 | ;; Could be smart and not tell it about articles already known? | |
167 | (when articles | |
168 | (gnus-group-make-articles-read cgroup articles)) | |
169 | ) | |
170 | ||
171 | ;; The headers are ready for reading, so they are inserted into | |
172 | ;; the nntp-server-buffer, which is where Gnus expects to find | |
173 | ;; them. | |
174 | (prog1 | |
175 | (save-excursion | |
176 | (set-buffer nntp-server-buffer) | |
177 | (erase-buffer) | |
178 | (insert-buffer-substring vbuf) | |
179 | ;; FIX FIX FIX, we should be able to sort faster than | |
180 | ;; this if needed, since each cgroup is sorted, we just | |
181 | ;; need to merge | |
182 | (sort-numeric-fields 1 (point-min) (point-max)) | |
183 | 'nov) | |
184 | (kill-buffer vbuf))))))) | |
185 | ||
186 | ||
187 | (defvoo nnvirtual-last-accessed-component-group nil) | |
188 | ||
189 | (deffoo nnvirtual-request-article (article &optional group server buffer) | |
190 | (when (nnvirtual-possibly-change-server server) | |
191 | (if (stringp article) | |
192 | ;; This is a fetch by Message-ID. | |
193 | (cond | |
194 | ((not nnvirtual-last-accessed-component-group) | |
195 | (nnheader-report | |
196 | 'nnvirtual "Don't know what server to request from")) | |
197 | (t | |
198 | (save-excursion | |
199 | (when buffer | |
200 | (set-buffer buffer)) | |
16409b0b GM |
201 | (let* ((gnus-override-method nil) |
202 | (method (gnus-find-method-for-group | |
203 | nnvirtual-last-accessed-component-group))) | |
eec82323 LMI |
204 | (funcall (gnus-get-function method 'request-article) |
205 | article nil (nth 1 method) buffer))))) | |
206 | ;; This is a fetch by number. | |
207 | (let* ((amap (nnvirtual-map-article article)) | |
208 | (cgroup (car amap))) | |
209 | (cond | |
210 | ((not amap) | |
211 | (nnheader-report 'nnvirtual "No such article: %s" article)) | |
212 | ((not (gnus-check-group cgroup)) | |
213 | (nnheader-report | |
214 | 'nnvirtual "Can't open server where %s exists" cgroup)) | |
215 | ((not (gnus-request-group cgroup t)) | |
216 | (nnheader-report 'nnvirtual "Can't open component group %s" cgroup)) | |
217 | (t | |
218 | (setq nnvirtual-last-accessed-component-group cgroup) | |
219 | (if buffer | |
220 | (save-excursion | |
221 | (set-buffer buffer) | |
16409b0b GM |
222 | ;; We bind this here to avoid double decoding. |
223 | (let ((gnus-article-decode-hook nil)) | |
224 | (gnus-request-article-this-buffer (cdr amap) cgroup))) | |
eec82323 LMI |
225 | (gnus-request-article (cdr amap) cgroup)))))))) |
226 | ||
227 | ||
228 | (deffoo nnvirtual-open-server (server &optional defs) | |
229 | (unless (assq 'nnvirtual-component-regexp defs) | |
230 | (push `(nnvirtual-component-regexp ,server) | |
231 | defs)) | |
232 | (nnoo-change-server 'nnvirtual server defs) | |
233 | (if nnvirtual-component-groups | |
234 | t | |
235 | (setq nnvirtual-mapping-table nil | |
236 | nnvirtual-mapping-offsets nil | |
237 | nnvirtual-mapping-len 0 | |
238 | nnvirtual-mapping-reads nil | |
239 | nnvirtual-mapping-marks nil | |
240 | nnvirtual-info-installed nil) | |
241 | (when nnvirtual-component-regexp | |
242 | ;; Go through the newsrc alist and find all component groups. | |
243 | (let ((newsrc (cdr gnus-newsrc-alist)) | |
244 | group) | |
245 | (while (setq group (car (pop newsrc))) | |
246 | (when (string-match nnvirtual-component-regexp group) ; Match | |
247 | ;; Add this group to the list of component groups. | |
248 | (setq nnvirtual-component-groups | |
249 | (cons group (delete group nnvirtual-component-groups))))))) | |
250 | (if (not nnvirtual-component-groups) | |
251 | (nnheader-report 'nnvirtual "No component groups: %s" server) | |
252 | t))) | |
253 | ||
254 | ||
255 | (deffoo nnvirtual-request-group (group &optional server dont-check) | |
256 | (nnvirtual-possibly-change-server server) | |
257 | (setq nnvirtual-component-groups | |
258 | (delete (nnvirtual-current-group) nnvirtual-component-groups)) | |
259 | (cond | |
260 | ((null nnvirtual-component-groups) | |
261 | (setq nnvirtual-current-group nil) | |
262 | (nnheader-report 'nnvirtual "No component groups in %s" group)) | |
263 | (t | |
6748645f | 264 | (setq nnvirtual-current-group group) |
eec82323 LMI |
265 | (when (or (not dont-check) |
266 | nnvirtual-always-rescan) | |
6748645f LMI |
267 | (nnvirtual-create-mapping) |
268 | (when nnvirtual-always-rescan | |
269 | (nnvirtual-request-update-info | |
270 | (nnvirtual-current-group) | |
271 | (gnus-get-info (nnvirtual-current-group))))) | |
eec82323 LMI |
272 | (nnheader-insert "211 %d 1 %d %s\n" |
273 | nnvirtual-mapping-len nnvirtual-mapping-len group)))) | |
274 | ||
275 | ||
276 | (deffoo nnvirtual-request-type (group &optional article) | |
277 | (if (not article) | |
278 | 'unknown | |
6748645f LMI |
279 | (if (numberp article) |
280 | (let ((mart (nnvirtual-map-article article))) | |
281 | (if mart | |
282 | (gnus-request-type (car mart) (cdr mart)))) | |
283 | (gnus-request-type | |
284 | nnvirtual-last-accessed-component-group nil)))) | |
eec82323 LMI |
285 | |
286 | (deffoo nnvirtual-request-update-mark (group article mark) | |
287 | (let* ((nart (nnvirtual-map-article article)) | |
16409b0b | 288 | (cgroup (car nart))) |
eec82323 | 289 | (when (and nart |
16409b0b GM |
290 | (memq mark gnus-auto-expirable-marks) |
291 | ;; The component group might be a virtual group. | |
292 | (= mark (gnus-request-update-mark cgroup (cdr nart) mark)) | |
eec82323 LMI |
293 | (gnus-group-auto-expirable-p cgroup)) |
294 | (setq mark gnus-expirable-mark))) | |
295 | mark) | |
296 | ||
297 | ||
298 | (deffoo nnvirtual-close-group (group &optional server) | |
299 | (when (and (nnvirtual-possibly-change-server server) | |
300 | (not (gnus-ephemeral-group-p (nnvirtual-current-group)))) | |
301 | (nnvirtual-update-read-and-marked t t)) | |
302 | t) | |
303 | ||
304 | ||
305 | (deffoo nnvirtual-request-list (&optional server) | |
306 | (nnheader-report 'nnvirtual "LIST is not implemented.")) | |
307 | ||
308 | ||
309 | (deffoo nnvirtual-request-newgroups (date &optional server) | |
310 | (nnheader-report 'nnvirtual "NEWGROUPS is not supported.")) | |
311 | ||
312 | ||
313 | (deffoo nnvirtual-request-list-newsgroups (&optional server) | |
314 | (nnheader-report 'nnvirtual "LIST NEWSGROUPS is not implemented.")) | |
315 | ||
316 | ||
317 | (deffoo nnvirtual-request-update-info (group info &optional server) | |
318 | (when (and (nnvirtual-possibly-change-server server) | |
319 | (not nnvirtual-info-installed)) | |
320 | ;; Install the precomputed lists atomically, so the virtual group | |
321 | ;; is not left in a half-way state in case of C-g. | |
322 | (gnus-atomic-progn | |
323 | (setcar (cddr info) nnvirtual-mapping-reads) | |
324 | (if (nthcdr 3 info) | |
325 | (setcar (nthcdr 3 info) nnvirtual-mapping-marks) | |
326 | (when nnvirtual-mapping-marks | |
327 | (setcdr (nthcdr 2 info) (list nnvirtual-mapping-marks)))) | |
328 | (setq nnvirtual-info-installed t)) | |
329 | t)) | |
330 | ||
331 | ||
332 | (deffoo nnvirtual-catchup-group (group &optional server all) | |
333 | (when (and (nnvirtual-possibly-change-server server) | |
334 | (not (gnus-ephemeral-group-p (nnvirtual-current-group)))) | |
335 | ;; copy over existing marks first, in case they set anything | |
336 | (nnvirtual-update-read-and-marked nil nil) | |
337 | ;; do a catchup on all component groups | |
338 | (let ((gnus-group-marked (copy-sequence nnvirtual-component-groups)) | |
339 | (gnus-expert-user t)) | |
340 | ;; Make sure all groups are activated. | |
341 | (mapcar | |
342 | (lambda (g) | |
343 | (when (not (numberp (car (gnus-gethash g gnus-newsrc-hashtb)))) | |
344 | (gnus-activate-group g))) | |
345 | nnvirtual-component-groups) | |
346 | (save-excursion | |
347 | (set-buffer gnus-group-buffer) | |
348 | (gnus-group-catchup-current nil all))))) | |
349 | ||
350 | ||
351 | (deffoo nnvirtual-find-group-art (group article) | |
352 | "Return the real group and article for virtual GROUP and ARTICLE." | |
353 | (nnvirtual-map-article article)) | |
354 | ||
6748645f LMI |
355 | |
356 | (deffoo nnvirtual-request-post (&optional server) | |
357 | (if (not gnus-message-group-art) | |
358 | (nnheader-report 'nnvirtual "Can't post to an nnvirtual group") | |
359 | (let ((group (car (nnvirtual-find-group-art | |
360 | (car gnus-message-group-art) | |
361 | (cdr gnus-message-group-art))))) | |
362 | (gnus-request-post (gnus-find-method-for-group group))))) | |
363 | ||
16409b0b | 364 | |
a1506d29 | 365 | (deffoo nnvirtual-request-expire-articles (articles group |
16409b0b GM |
366 | &optional server force) |
367 | (nnvirtual-possibly-change-server server) | |
368 | (setq nnvirtual-component-groups | |
369 | (delete (nnvirtual-current-group) nnvirtual-component-groups)) | |
370 | (let (unexpired) | |
371 | (dolist (group nnvirtual-component-groups) | |
372 | (setq unexpired (nconc unexpired | |
373 | (mapcar | |
374 | #'(lambda (article) | |
375 | (nnvirtual-reverse-map-article | |
376 | group article)) | |
23f87bed MB |
377 | (gnus-uncompress-range |
378 | (gnus-group-expire-articles-1 group)))))) | |
379 | (sort (delq nil unexpired) '<))) | |
16409b0b | 380 | |
eec82323 LMI |
381 | \f |
382 | ;;; Internal functions. | |
383 | ||
384 | (defun nnvirtual-convert-headers () | |
385 | "Convert HEAD headers into NOV headers." | |
386 | (save-excursion | |
387 | (set-buffer nntp-server-buffer) | |
388 | (let* ((dependencies (make-vector 100 0)) | |
389 | (headers (gnus-get-newsgroup-headers dependencies)) | |
390 | header) | |
391 | (erase-buffer) | |
392 | (while (setq header (pop headers)) | |
393 | (nnheader-insert-nov header))))) | |
394 | ||
395 | ||
396 | (defun nnvirtual-update-xref-header (group article prefix system-name) | |
397 | "Edit current NOV header in current buffer to have an xref to the component group, and also server prefix any existing xref lines." | |
398 | ;; Move to beginning of Xref field, creating a slot if needed. | |
399 | (beginning-of-line) | |
400 | (looking-at | |
401 | "[^\t]*\t[^\t]*\t[^\t]*\t[^\t]*\t[^\t]*\t[^\t]*\t[^\t]*\t") | |
402 | (goto-char (match-end 0)) | |
403 | (unless (search-forward "\t" (gnus-point-at-eol) 'move) | |
404 | (insert "\t")) | |
405 | ||
406 | ;; Remove any spaces at the beginning of the Xref field. | |
16409b0b | 407 | (while (eq (char-after (1- (point))) ? ) |
eec82323 LMI |
408 | (forward-char -1) |
409 | (delete-char 1)) | |
410 | ||
411 | (insert "Xref: " system-name " " group ":") | |
412 | (princ article (current-buffer)) | |
a8151ef7 | 413 | (insert " ") |
eec82323 LMI |
414 | |
415 | ;; If there were existing xref lines, clean them up to have the correct | |
416 | ;; component server prefix. | |
a8151ef7 LMI |
417 | (save-restriction |
418 | (narrow-to-region (point) | |
419 | (or (search-forward "\t" (gnus-point-at-eol) t) | |
420 | (gnus-point-at-eol))) | |
421 | (goto-char (point-min)) | |
422 | (when (re-search-forward "Xref: *[^\n:0-9 ]+ *" nil t) | |
423 | (replace-match "" t t)) | |
424 | (goto-char (point-min)) | |
425 | (when (re-search-forward | |
6748645f | 426 | (concat (regexp-quote (gnus-group-real-name group)) ":[0-9]+") |
a8151ef7 LMI |
427 | nil t) |
428 | (replace-match "" t t)) | |
23f87bed | 429 | (unless (eobp) |
eec82323 LMI |
430 | (insert " ") |
431 | (when (not (string= "" prefix)) | |
a8151ef7 | 432 | (while (re-search-forward "[^ ]+:[0-9]+" nil t) |
eec82323 LMI |
433 | (save-excursion |
434 | (goto-char (match-beginning 0)) | |
a8151ef7 | 435 | (insert prefix)))))) |
eec82323 LMI |
436 | |
437 | ;; Ensure a trailing \t. | |
438 | (end-of-line) | |
16409b0b | 439 | (or (eq (char-after (1- (point))) ?\t) |
eec82323 LMI |
440 | (insert ?\t))) |
441 | ||
442 | ||
443 | (defun nnvirtual-possibly-change-server (server) | |
444 | (or (not server) | |
445 | (nnoo-current-server-p 'nnvirtual server) | |
446 | (nnvirtual-open-server server))) | |
447 | ||
448 | ||
449 | (defun nnvirtual-update-read-and-marked (read-p update-p) | |
450 | "Copy marks from the virtual group to the component groups. | |
451 | If READ-P is not nil, update the (un)read status of the components. | |
452 | If UPDATE-P is not nil, call gnus-group-update-group on the components." | |
453 | (when nnvirtual-current-group | |
454 | (let ((unreads (and read-p | |
455 | (nnvirtual-partition-sequence | |
456 | (gnus-list-of-unread-articles | |
457 | (nnvirtual-current-group))))) | |
16409b0b GM |
458 | (type-marks |
459 | (delq nil | |
460 | (mapcar (lambda (ml) | |
461 | (if (eq (car ml) 'score) | |
462 | nil | |
463 | (cons (car ml) | |
464 | (nnvirtual-partition-sequence (cdr ml))))) | |
465 | (gnus-info-marks (gnus-get-info | |
466 | (nnvirtual-current-group)))))) | |
eec82323 LMI |
467 | mark type groups carticles info entry) |
468 | ||
469 | ;; Ok, atomically move all of the (un)read info, clear any old | |
470 | ;; marks, and move all of the current marks. This way if someone | |
471 | ;; hits C-g, you won't leave the component groups in a half-way state. | |
16409b0b | 472 | (progn |
eec82323 | 473 | ;; move (un)read |
16409b0b GM |
474 | ;; bind for workaround guns-update-read-articles |
475 | (let ((gnus-newsgroup-active nil)) | |
eec82323 LMI |
476 | (while (setq entry (pop unreads)) |
477 | (gnus-update-read-articles (car entry) (cdr entry)))) | |
478 | ||
479 | ;; clear all existing marks on the component groups | |
480 | (setq groups nnvirtual-component-groups) | |
481 | (while groups | |
482 | (when (and (setq info (gnus-get-info (pop groups))) | |
483 | (gnus-info-marks info)) | |
16409b0b GM |
484 | (gnus-info-set-marks |
485 | info | |
486 | (if (assq 'score (gnus-info-marks info)) | |
487 | (list (assq 'score (gnus-info-marks info))) | |
488 | nil)))) | |
eec82323 LMI |
489 | |
490 | ;; Ok, currently type-marks is an assq list with keys of a mark type, | |
491 | ;; with data of an assq list with keys of component group names | |
492 | ;; and the articles which correspond to that key/group pair. | |
493 | (while (setq mark (pop type-marks)) | |
494 | (setq type (car mark)) | |
495 | (setq groups (cdr mark)) | |
496 | (while (setq carticles (pop groups)) | |
497 | (gnus-add-marked-articles (car carticles) type (cdr carticles) | |
498 | nil t)))) | |
499 | ||
500 | ;; possibly update the display, it is really slow | |
501 | (when update-p | |
502 | (setq groups nnvirtual-component-groups) | |
503 | (while groups | |
504 | (gnus-group-update-group (pop groups) t)))))) | |
505 | ||
506 | ||
507 | (defun nnvirtual-current-group () | |
508 | "Return the prefixed name of the current nnvirtual group." | |
509 | (concat "nnvirtual:" nnvirtual-current-group)) | |
510 | ||
511 | ||
512 | ||
513 | ;;; This is currently O(kn^2) to merge n lists of length k. | |
514 | ;;; You could do it in O(knlogn), but we have a small n, and the | |
515 | ;;; overhead of the other approach is probably greater. | |
516 | (defun nnvirtual-merge-sorted-lists (&rest lists) | |
517 | "Merge many sorted lists of numbers." | |
518 | (if (null (cdr lists)) | |
519 | (car lists) | |
ef3eaa35 | 520 | (sort (apply 'nconc lists) '<))) |
eec82323 LMI |
521 | |
522 | ||
523 | ;;; We map between virtual articles and real articles in a manner | |
23f87bed MB |
524 | ;;; which keeps the size of the virtual active list the same as the |
525 | ;;; sum of the component active lists. | |
526 | ||
527 | ;;; To achieve fair mixing of the groups, the last article in each of | |
528 | ;;; N component groups will be in the last N articles in the virtual | |
529 | ;;; group. | |
530 | ||
531 | ;;; If you have 3 components A, B and C, with articles 1-8, 1-5, and | |
532 | ;;; 6-7 respectively, then the virtual article numbers look like: | |
eec82323 LMI |
533 | ;;; |
534 | ;;; 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
535 | ;;; A1 A2 A3 A4 B1 A5 B2 A6 B3 A7 B4 C6 A8 B5 C7 | |
536 | ||
537 | ;;; To compute these mappings we generate a couple tables and then | |
538 | ;;; do some fast operations on them. Tables for the example above: | |
539 | ;;; | |
540 | ;;; Offsets - [(A 0) (B -3) (C -1)] | |
541 | ;;; | |
542 | ;;; a b c d e | |
543 | ;;; Mapping - ([ 3 0 1 3 0 ] | |
544 | ;;; [ 6 3 2 9 3 ] | |
545 | ;;; [ 8 6 3 15 9 ]) | |
546 | ;;; | |
547 | ;;; (note column 'e' is different in real algorithm, which is slightly | |
548 | ;;; different than described here, but this gives you the methodology.) | |
549 | ;;; | |
550 | ;;; The basic idea is this, when going from component->virtual, apply | |
551 | ;;; the appropriate offset to the article number. Then search the first | |
552 | ;;; column of the table for a row where 'a' is less than or equal to the | |
553 | ;;; modified number. You can see that only group A can therefore go to | |
554 | ;;; the first row, groups A and B to the second, and all to the last. | |
555 | ;;; The third column of the table is telling us the number of groups | |
556 | ;;; which might be able to reach that row (it might increase by more than | |
557 | ;;; 1 if several groups have the same size). | |
558 | ;;; Then column 'b' provides an additional offset you apply when you have | |
559 | ;;; found the correct row. You then multiply by 'c' and add on the groups | |
560 | ;;; _position_ in the offset table. The basic idea here is that on | |
561 | ;;; any given row we are going to map back and forth using X'=X*c+Y and | |
562 | ;;; X=(X'/c), Y=(X' mod c). Then once you've done this transformation, | |
563 | ;;; you apply a final offset from column 'e' to give the virtual article. | |
564 | ;;; | |
565 | ;;; Going the other direction, you instead search on column 'd' instead | |
566 | ;;; of 'a', and apply everything in reverse order. | |
567 | ||
568 | ;;; Convert component -> virtual: | |
569 | ;;; set num = num - Offset(group) | |
570 | ;;; find first row in Mapping where num <= 'a' | |
571 | ;;; num = (num-'b')*c + Position(group) + 'e' | |
572 | ||
573 | ;;; Convert virtual -> component: | |
574 | ;;; find first row in Mapping where num <= 'd' | |
575 | ;;; num = num - 'e' | |
576 | ;;; group_pos = num mod 'c' | |
577 | ;;; num = (num / 'c') + 'b' + Offset(group_pos) | |
578 | ||
579 | ;;; Easy no? :) | |
580 | ;;; | |
581 | ;;; Well actually, you need to keep column e offset smaller by the 'c' | |
582 | ;;; column for that line, and always add 1 more when going from | |
583 | ;;; component -> virtual. Otherwise you run into a problem with | |
584 | ;;; unique reverse mapping. | |
585 | ||
586 | (defun nnvirtual-map-article (article) | |
587 | "Return a cons of the component group and article corresponding to the given virtual ARTICLE." | |
588 | (let ((table nnvirtual-mapping-table) | |
589 | entry group-pos) | |
590 | (while (and table | |
591 | (> article (aref (car table) 3))) | |
592 | (setq table (cdr table))) | |
593 | (when (and table | |
594 | (> article 0)) | |
595 | (setq entry (car table)) | |
596 | (setq article (- article (aref entry 4) 1)) | |
597 | (setq group-pos (mod article (aref entry 2))) | |
598 | (cons (car (aref nnvirtual-mapping-offsets group-pos)) | |
599 | (+ (/ article (aref entry 2)) | |
600 | (aref entry 1) | |
601 | (cdr (aref nnvirtual-mapping-offsets group-pos))) | |
602 | )) | |
16409b0b | 603 | )) |
eec82323 LMI |
604 | |
605 | ||
606 | ||
607 | (defun nnvirtual-reverse-map-article (group article) | |
608 | "Return the virtual article number corresponding to the given component GROUP and ARTICLE." | |
6748645f LMI |
609 | (when (numberp article) |
610 | (let ((table nnvirtual-mapping-table) | |
611 | (group-pos 0) | |
612 | entry) | |
613 | (while (not (string= group (car (aref nnvirtual-mapping-offsets | |
614 | group-pos)))) | |
615 | (setq group-pos (1+ group-pos))) | |
616 | (setq article (- article (cdr (aref nnvirtual-mapping-offsets | |
eec82323 | 617 | group-pos)))) |
6748645f LMI |
618 | (while (and table |
619 | (> article (aref (car table) 0))) | |
620 | (setq table (cdr table))) | |
621 | (setq entry (car table)) | |
622 | (when (and entry | |
623 | (> article 0) | |
624 | (< group-pos (aref entry 2))) ; article not out of range below | |
625 | (+ (aref entry 4) | |
626 | group-pos | |
627 | (* (- article (aref entry 1)) | |
628 | (aref entry 2)) | |
629 | 1)) | |
630 | ))) | |
eec82323 LMI |
631 | |
632 | ||
633 | (defsubst nnvirtual-reverse-map-sequence (group articles) | |
634 | "Return list of virtual article numbers for all ARTICLES in GROUP. | |
635 | The ARTICLES should be sorted, and can be a compressed sequence. | |
636 | If any of the article numbers has no corresponding virtual article, | |
637 | then it is left out of the result." | |
638 | (when (numberp (cdr-safe articles)) | |
639 | (setq articles (list articles))) | |
640 | (let (result a i j new-a) | |
641 | (while (setq a (pop articles)) | |
642 | (if (atom a) | |
643 | (setq i a | |
644 | j a) | |
645 | (setq i (car a) | |
646 | j (cdr a))) | |
647 | (while (<= i j) | |
648 | ;; If this is slow, you can optimize by moving article checking | |
649 | ;; into here. You don't have to recompute the group-pos, | |
650 | ;; nor scan the table every time. | |
651 | (when (setq new-a (nnvirtual-reverse-map-article group i)) | |
652 | (push new-a result)) | |
653 | (setq i (1+ i)))) | |
654 | (nreverse result))) | |
655 | ||
656 | ||
657 | (defun nnvirtual-partition-sequence (articles) | |
658 | "Return an association list of component article numbers. | |
659 | These are indexed by elements of nnvirtual-component-groups, based on | |
660 | the sequence ARTICLES of virtual article numbers. ARTICLES should be | |
16409b0b | 661 | sorted, and can be a compressed sequence. If any of the article |
eec82323 LMI |
662 | numbers has no corresponding component article, then it is left out of |
663 | the result." | |
664 | (when (numberp (cdr-safe articles)) | |
665 | (setq articles (list articles))) | |
666 | (let ((carticles (mapcar (lambda (g) (list g)) | |
667 | nnvirtual-component-groups)) | |
668 | a i j article entry) | |
669 | (while (setq a (pop articles)) | |
670 | (if (atom a) | |
671 | (setq i a | |
672 | j a) | |
673 | (setq i (car a) | |
674 | j (cdr a))) | |
675 | (while (<= i j) | |
676 | (when (setq article (nnvirtual-map-article i)) | |
677 | (setq entry (assoc (car article) carticles)) | |
678 | (setcdr entry (cons (cdr article) (cdr entry)))) | |
679 | (setq i (1+ i)))) | |
ef3eaa35 RS |
680 | (mapcar (lambda (x) (setcdr x (nreverse (cdr x)))) |
681 | carticles) | |
eec82323 LMI |
682 | carticles)) |
683 | ||
684 | ||
685 | (defun nnvirtual-create-mapping () | |
686 | "Build the tables necessary to map between component (group, article) to virtual article. | |
687 | Generate the set of read messages and marks for the virtual group | |
688 | based on the marks on the component groups." | |
689 | (let ((cnt 0) | |
690 | (tot 0) | |
691 | (M 0) | |
692 | (i 0) | |
693 | actives all-unreads all-marks | |
694 | active min max size unreads marks | |
695 | next-M next-tot | |
696 | reads beg) | |
697 | ;; Ok, we loop over all component groups and collect a lot of | |
698 | ;; information: | |
699 | ;; Into actives we place (g size max), where size is max-min+1. | |
700 | ;; Into all-unreads we put (g unreads). | |
701 | ;; Into all-marks we put (g marks). | |
702 | ;; We also increment cnt and tot here, and compute M (max of sizes). | |
54b02948 DL |
703 | (mapcar (lambda (g) |
704 | (setq active (gnus-activate-group g) | |
705 | min (car active) | |
706 | max (cdr active)) | |
707 | (when (and active (>= max min) (not (zerop max))) | |
708 | ;; store active information | |
709 | (push (list g (- max min -1) max) actives) | |
710 | ;; collect unread/mark info for later | |
711 | (setq unreads (gnus-list-of-unread-articles g)) | |
712 | (setq marks (gnus-info-marks (gnus-get-info g))) | |
713 | (when gnus-use-cache | |
714 | (push (cons 'cache | |
715 | (gnus-cache-articles-in-group g)) | |
716 | marks)) | |
717 | (push (cons g unreads) all-unreads) | |
718 | (push (cons g marks) all-marks) | |
719 | ;; count groups, total #articles, and max size | |
720 | (setq size (- max min -1)) | |
721 | (setq cnt (1+ cnt) | |
722 | tot (+ tot size) | |
723 | M (max M size)))) | |
16409b0b | 724 | nnvirtual-component-groups) |
eec82323 LMI |
725 | |
726 | ;; Number of articles in the virtual group. | |
727 | (setq nnvirtual-mapping-len tot) | |
728 | ||
729 | ||
730 | ;; We want the actives list sorted by size, to build the tables. | |
731 | (setq actives (sort actives (lambda (g1 g2) (< (nth 1 g1) (nth 1 g2))))) | |
732 | ||
733 | ;; Build the offset table. Largest sized groups are at the front. | |
734 | (setq nnvirtual-mapping-offsets | |
735 | (vconcat | |
736 | (nreverse | |
737 | (mapcar (lambda (entry) | |
738 | (cons (nth 0 entry) | |
739 | (- (nth 2 entry) M))) | |
740 | actives)))) | |
741 | ||
742 | ;; Build the mapping table. | |
743 | (setq nnvirtual-mapping-table nil) | |
744 | (setq actives (mapcar (lambda (entry) (nth 1 entry)) actives)) | |
745 | (while actives | |
746 | (setq size (car actives)) | |
747 | (setq next-M (- M size)) | |
748 | (setq next-tot (- tot (* cnt size))) | |
749 | ;; make current row in table | |
750 | (push (vector M next-M cnt tot (- next-tot cnt)) | |
751 | nnvirtual-mapping-table) | |
752 | ;; update M and tot | |
753 | (setq M next-M) | |
754 | (setq tot next-tot) | |
755 | ;; subtract the current size from all entries. | |
756 | (setq actives (mapcar (lambda (x) (- x size)) actives)) | |
757 | ;; remove anything that went to 0. | |
758 | (while (and actives | |
759 | (= (car actives) 0)) | |
760 | (pop actives) | |
761 | (setq cnt (- cnt 1)))) | |
762 | ||
763 | ||
764 | ;; Now that the mapping tables are generated, we can convert | |
765 | ;; and combine the separate component unreads and marks lists | |
766 | ;; into single lists of virtual article numbers. | |
767 | (setq unreads (apply 'nnvirtual-merge-sorted-lists | |
768 | (mapcar (lambda (x) | |
769 | (nnvirtual-reverse-map-sequence | |
770 | (car x) (cdr x))) | |
771 | all-unreads))) | |
772 | (setq marks (mapcar | |
773 | (lambda (type) | |
774 | (cons (cdr type) | |
775 | (gnus-compress-sequence | |
776 | (apply | |
777 | 'nnvirtual-merge-sorted-lists | |
778 | (mapcar (lambda (x) | |
779 | (nnvirtual-reverse-map-sequence | |
780 | (car x) | |
781 | (cdr (assq (cdr type) (cdr x))))) | |
782 | all-marks))))) | |
783 | gnus-article-mark-lists)) | |
784 | ||
785 | ;; Remove any empty marks lists, and store. | |
ef3eaa35 RS |
786 | (setq nnvirtual-mapping-marks nil) |
787 | (while marks | |
788 | (if (cdr (car marks)) | |
789 | (push (car marks) nnvirtual-mapping-marks)) | |
790 | (setq marks (cdr marks))) | |
eec82323 LMI |
791 | |
792 | ;; We need to convert the unreads to reads. We compress the | |
793 | ;; sequence as we go, otherwise it could be huge. | |
794 | (while (and (<= (incf i) nnvirtual-mapping-len) | |
795 | unreads) | |
796 | (if (= i (car unreads)) | |
797 | (setq unreads (cdr unreads)) | |
798 | ;; try to get a range. | |
799 | (setq beg i) | |
800 | (while (and (<= (incf i) nnvirtual-mapping-len) | |
801 | (not (= i (car unreads))))) | |
802 | (setq i (- i 1)) | |
803 | (if (= i beg) | |
804 | (push i reads) | |
805 | (push (cons beg i) reads)) | |
806 | )) | |
807 | (when (<= i nnvirtual-mapping-len) | |
808 | (if (= i nnvirtual-mapping-len) | |
809 | (push i reads) | |
810 | (push (cons i nnvirtual-mapping-len) reads))) | |
811 | ||
812 | ;; Store the reads list for later use. | |
813 | (setq nnvirtual-mapping-reads (nreverse reads)) | |
814 | ||
815 | ;; Throw flag to show we changed the info. | |
816 | (setq nnvirtual-info-installed nil) | |
817 | )) | |
818 | ||
819 | (provide 'nnvirtual) | |
820 | ||
ab5796a9 | 821 | ;;; arch-tag: ca8c8ad9-1bd8-4b0f-9722-90dc645a45f5 |
eec82323 | 822 | ;;; nnvirtual.el ends here |