| blob | dcd610317efc9c0ee3cb80b6aa35dd6e937a7a15 |
1 ;;; nnvirtual.el --- virtual newsgroups access for Gnus
3 ;; Copyright (C) 1994-2017 Free Software Foundation, Inc.
5 ;; Author: David Moore <dmoore@ucsd.edu>
6 ;; Lars Magne Ingebrigtsen <larsi@gnus.org>
7 ;; Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
8 ;; Keywords: news
10 ;; This file is part of GNU Emacs.
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 3 of the License, or
15 ;; (at your option) any later version.
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.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;; Commentary:
27 ;; The other access methods (nntp, nnspool, etc) are general news
28 ;; access methods. This module relies on Gnus and can not be used
29 ;; separately.
31 ;;; Code:
46 "If non-nil, always scan groups for unread articles when entering a group.
47 If this variable is nil and you read articles in a component group
48 after the virtual group has been activated, the read articles from the
57 \f
64 "Table of rules on how to map between component group and article number to virtual article number.")
73 "Compressed sequence of read articles on the virtual group as computed from the unread status of individual component groups.")
76 "Compressed marks alist for the virtual group as computed from the marks of individual component groups.")
79 "T if we have already installed the group info for this group, and shouldn't blast over it again.")
85 \f
87 ;;; Interface functions.
93 server fetch-old)
98 'headers
103 cgroup carticle article result prefix)
113 ;; FIX FIX FIX we want to check the cache!
114 ;; This is probably evil if people have set
115 ;; gnus-use-cache to nil themselves, but I
116 ;; have no way of finding the true value of it.
119 articles cgroup nil))))
121 ;; If we got HEAD headers, we convert them into NOV
122 ;; headers. This is slow, inefficient and, come to think
123 ;; of it, downright evil. So sue me. I couldn't be
124 ;; bothered to write a header parse routine that could
125 ;; parse a mixed HEAD/NOV buffer.
135 ;; We remove this article from the articles list, if
136 ;; anything is left in the articles list after going through
137 ;; the entire buffer, then those articles have been
138 ;; expired or canceled, so we appropriately update the
139 ;; component group below. They should be coming up
140 ;; generally in order, so this shouldn't be slow.
145 ;; This line has no reverse mapping, that means it
146 ;; was an extra article reference returned by nntp.
150 ;; Otherwise insert the virtual article number,
151 ;; and clean up the xrefs.
154 prefix sysname)
156 )
161 ;; Anything left in articles is expired or canceled.
162 ;; Could be smart and not tell it about articles already known?
165 )
167 ;; The headers are ready for reading, so they are inserted into
168 ;; the nntp-server-buffer, which is where Gnus expects to find
169 ;; them.
174 ;; FIX FIX FIX, we should be able to sort faster than
175 ;; this if needed, since each cgroup is sorted, we just
176 ;; need to merge
187 ;; This is a fetch by Message-ID.
199 nnvirtual-last-accessed-component-group)))
202 ;; This is a fetch by number.
217 ;; We bind this here to avoid double decoding.
226 defs))
229 t
231 nnvirtual-mapping-offsets nil
232 nnvirtual-mapping-len 0
233 nnvirtual-mapping-reads nil
234 nnvirtual-mapping-marks nil
235 nnvirtual-info-installed nil)
237 ;; Go through the newsrc alist and find all component groups.
239 group)
242 ;; Add this group to the list of component groups.
247 t)))
266 nnvirtual-mapping-len nnvirtual-mapping-len group))))
271 'unknown
277 nnvirtual-last-accessed-component-group nil))))
284 ;; The component group might be a virtual group.
288 mark)
295 t)
309 ;; Install the precomputed lists atomically, so the virtual group
310 ;; is not left in a half-way state in case of C-g.
318 t))
324 ;; copy over existing marks first, in case they set anything
326 ;; do a catchup on all component groups
329 ;; Make sure all groups are activated.
334 nnvirtual-component-groups)
340 "Return the real group and article for virtual GROUP and ARTICLE."
364 group article))
369 \f
370 ;;; Internal functions.
373 "Convert HEAD headers into NOV headers."
382 "Edit current NOV header in current buffer to have an xref to the component group, and also server prefix any existing xref lines."
383 ;; Move to beginning of Xref field, creating a slot if needed.
391 ;; Remove any spaces at the beginning of the Xref field.
400 ;; If there were existing xref lines, clean them up to have the correct
401 ;; component server prefix.
412 nil t)
422 ;; Ensure a trailing \t.
435 "Copy marks from the virtual group to the component groups.
436 If READ-P is not nil, update the (un)read status of the components.
437 If UPDATE-P is not nil, call gnus-group-update-group on the components."
447 nil
452 type groups info)
454 ;; Ok, atomically move all of the (un)read info, clear any old
455 ;; marks, and move all of the current marks. This way if someone
456 ;; hits C-g, you won't leave the component groups in a half-way state.
458 ;; move (un)read
459 ;; bind for workaround guns-update-read-articles
464 ;; clear all existing marks on the component groups
469 info
472 nil))))
474 ;; Ok, currently type-marks is an assq list with keys of a mark type,
475 ;; with data of an assq list with keys of component group names
476 ;; and the articles which correspond to that key/group pair.
482 nil t))))
484 ;; possibly update the display, it is really slow
491 "Return the prefixed name of the current nnvirtual group."
496 ;;; This is currently O(kn^2) to merge n lists of length k.
497 ;;; You could do it in O(knlogn), but we have a small n, and the
498 ;;; overhead of the other approach is probably greater.
500 "Merge many sorted lists of numbers."
506 ;;; We map between virtual articles and real articles in a manner
507 ;;; which keeps the size of the virtual active list the same as the
508 ;;; sum of the component active lists.
510 ;;; To achieve fair mixing of the groups, the last article in each of
511 ;;; N component groups will be in the last N articles in the virtual
512 ;;; group.
514 ;;; If you have 3 components A, B and C, with articles 1-8, 1-5, and
515 ;;; 6-7 respectively, then the virtual article numbers look like:
516 ;;;
517 ;;; 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
518 ;;; A1 A2 A3 A4 B1 A5 B2 A6 B3 A7 B4 C6 A8 B5 C7
520 ;;; To compute these mappings we generate a couple tables and then
521 ;;; do some fast operations on them. Tables for the example above:
522 ;;;
523 ;;; Offsets - [(A 0) (B -3) (C -1)]
524 ;;;
525 ;;; a b c d e
526 ;;; Mapping - ([ 3 0 1 3 0 ]
527 ;;; [ 6 3 2 9 3 ]
528 ;;; [ 8 6 3 15 9 ])
529 ;;;
530 ;;; (note column 'e' is different in real algorithm, which is slightly
531 ;;; different than described here, but this gives you the methodology.)
532 ;;;
533 ;;; The basic idea is this, when going from component->virtual, apply
534 ;;; the appropriate offset to the article number. Then search the first
535 ;;; column of the table for a row where 'a' is less than or equal to the
536 ;;; modified number. You can see that only group A can therefore go to
537 ;;; the first row, groups A and B to the second, and all to the last.
538 ;;; The third column of the table is telling us the number of groups
539 ;;; which might be able to reach that row (it might increase by more than
540 ;;; 1 if several groups have the same size).
541 ;;; Then column 'b' provides an additional offset you apply when you have
542 ;;; found the correct row. You then multiply by 'c' and add on the groups
543 ;;; _position_ in the offset table. The basic idea here is that on
544 ;;; any given row we are going to map back and forth using X'=X*c+Y and
545 ;;; X=(X'/c), Y=(X' mod c). Then once you've done this transformation,
546 ;;; you apply a final offset from column 'e' to give the virtual article.
547 ;;;
548 ;;; Going the other direction, you instead search on column 'd' instead
549 ;;; of 'a', and apply everything in reverse order.
551 ;;; Convert component -> virtual:
552 ;;; set num = num - Offset(group)
553 ;;; find first row in Mapping where num <= 'a'
554 ;;; num = (num-'b')*c + Position(group) + 'e'
556 ;;; Convert virtual -> component:
557 ;;; find first row in Mapping where num <= 'd'
558 ;;; num = num - 'e'
559 ;;; group_pos = num mod 'c'
560 ;;; num = (num / 'c') + 'b' + Offset(group_pos)
562 ;;; Easy no? :)
563 ;;;
564 ;;; Well actually, you need to keep column e offset smaller by the 'c'
565 ;;; column for that line, and always add 1 more when going from
566 ;;; component -> virtual. Otherwise you run into a problem with
567 ;;; unique reverse mapping.
570 "Return a cons of the component group and article corresponding to the given virtual ARTICLE."
572 entry group-pos)
585 ))
586 ))
591 "Return the virtual article number corresponding to the given component GROUP and ARTICLE."
595 entry)
597 group-pos))))
600 group-pos))))
609 group-pos
613 )))
617 "Return list of virtual article numbers for all ARTICLES in GROUP.
618 The ARTICLES should be sorted, and can be a compressed sequence.
619 If any of the article numbers has no corresponding virtual article,
620 then it is left out of the result."
627 j a)
631 ;; If this is slow, you can optimize by moving article checking
632 ;; into here. You don't have to recompute the group-pos,
633 ;; nor scan the table every time.
641 "Return an association list of component article numbers.
642 These are indexed by elements of nnvirtual-component-groups, based on
643 the sequence ARTICLES of virtual article numbers. ARTICLES should be
644 sorted, and can be a compressed sequence. If any of the article
645 numbers has no corresponding component article, then it is left out of
646 the result."
650 a i j article entry)
654 j a)
663 carticles)
664 carticles))
668 "Build the tables necessary to map between component (group, article) to virtual article.
669 Generate the set of read messages and marks for the virtual group
670 based on the marks on the component groups."
675 actives all-unreads all-marks
676 active min max size unreads marks
677 next-M next-tot
678 reads beg)
679 ;; Ok, we loop over all component groups and collect a lot of
680 ;; information:
681 ;; Into actives we place (g size max), where size is max-min+1.
682 ;; Into all-unreads we put (g unreads).
683 ;; Into all-marks we put (g marks).
684 ;; We also increment cnt and tot here, and compute M (max of sizes).
692 ;; store active information
694 ;; collect unread/mark info for later
700 marks))
703 ;; count groups, total #articles, and max size
708 nnvirtual-component-groups)
710 ;; Number of articles in the virtual group.
714 ;; We want the actives list sorted by size, to build the tables.
717 ;; Build the offset table. Largest sized groups are at the front.
724 actives))))
726 ;; Build the mapping table.
733 ;; make current row in table
735 nnvirtual-mapping-table)
736 ;; update M and tot
739 ;; subtract the current size from all entries.
741 ;; remove anything that went to 0.
748 ;; Now that the mapping tables are generated, we can convert
749 ;; and combine the separate component unreads and marks lists
750 ;; into single lists of virtual article numbers.
755 all-unreads)))
761 'nnvirtual-merge-sorted-lists
766 all-marks)))))
767 gnus-article-mark-lists))
769 ;; Remove any empty marks lists, and store.
775 ;; We need to convert the unreads to reads. We compress the
776 ;; sequence as we go, otherwise it could be huge.
778 unreads)
781 ;; try to get a range.
789 ))
795 ;; Store the reads list for later use.
798 ;; Throw flag to show we changed the info.
800 ))
804 ;;; nnvirtual.el ends here