1 ;;; nnkiboze.el --- select virtual news access for Gnus
2 ;; Copyright (C) 1995,96,97,98,99 Free Software Foundation, Inc.
4 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs; see the file COPYING. If not, write to the
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 ;; Boston, MA 02111-1307, USA.
26 ;; The other access methods (nntp, nnspool, etc) are general news
27 ;; access methods. This module relies on Gnus and can't be used
37 (eval-when-compile (require 'cl))
39 (nnoo-declare nnkiboze)
40 (defvoo nnkiboze-directory (nnheader-concat gnus-directory "kiboze/")
41 "nnkiboze will put its files in this directory.")
43 (defvoo nnkiboze-level 9
44 "The maximum level to be searched for articles.")
46 (defvoo nnkiboze-remove-read-articles t
47 "If non-nil, nnkiboze will remove read articles from the kiboze group.")
49 (defvoo nnkiboze-ephemeral nil
50 "If non-nil, don't store any data anywhere.")
52 (defvoo nnkiboze-scores nil
53 "Score rules for generating the nnkiboze group.")
55 (defvoo nnkiboze-regexp nil
56 "Regexp for matching component groups.")
60 (defconst nnkiboze-version "nnkiboze 1.0")
62 (defvoo nnkiboze-current-group nil)
63 (defvoo nnkiboze-status-string "")
65 (defvoo nnkiboze-headers nil)
69 ;;; Interface functions.
71 (nnoo-define-basics nnkiboze)
73 (deffoo nnkiboze-retrieve-headers (articles &optional group server fetch-old)
74 (nnkiboze-possibly-change-group group)
75 (unless gnus-nov-is-evil
76 (if (stringp (car articles))
78 (let ((nov (nnkiboze-nov-file-name)))
79 (when (file-exists-p nov)
81 (set-buffer nntp-server-buffer)
83 (nnheader-insert-file-contents nov)
84 (nnheader-nov-delete-outside-range
85 (car articles) (car (last articles)))
88 (deffoo nnkiboze-request-article (article &optional newsgroup server buffer)
89 (nnkiboze-possibly-change-group newsgroup)
90 (if (not (numberp article))
91 ;; This is a real kludge. It might not work at times, but it
92 ;; does no harm I think. The only alternative is to offer no
93 ;; article fetching by message-id at all.
94 (nntp-request-article article newsgroup gnus-nntp-server buffer)
95 (let* ((header (gnus-summary-article-header article))
96 (xref (mail-header-xref header)))
98 (error "nnkiboze: No xref"))
99 (unless (string-match " \\([^ ]+\\):\\([0-9]+\\)" xref)
100 (error "nnkiboze: Malformed xref"))
101 (gnus-request-article (string-to-int (match-string 2 xref))
102 (match-string 1 xref)
105 (deffoo nnkiboze-request-scan (&optional group server)
106 (nnkiboze-generate-group (concat "nnkiboze:" group)))
108 (deffoo nnkiboze-request-group (group &optional server dont-check)
109 "Make GROUP the current newsgroup."
110 (nnkiboze-possibly-change-group group)
113 (let ((nov-file (nnkiboze-nov-file-name))
116 (set-buffer nntp-server-buffer)
118 (unless (file-exists-p nov-file)
119 (nnkiboze-request-scan group))
120 (if (not (file-exists-p nov-file))
121 (nnheader-report 'nnkiboze "Can't select group %s" group)
122 (nnheader-insert-file-contents nov-file)
123 (if (zerop (buffer-size))
124 (nnheader-insert "211 0 0 0 %s\n" group)
125 (goto-char (point-min))
126 (when (looking-at "[0-9]+")
127 (setq beg (read (current-buffer))))
128 (goto-char (point-max))
129 (when (re-search-backward "^[0-9]" nil t)
130 (setq end (read (current-buffer))))
131 (setq total (count-lines (point-min) (point-max)))
132 (nnheader-insert "211 %d %d %d %s\n" total beg end group)))))))
134 (deffoo nnkiboze-close-group (group &optional server)
135 (nnkiboze-possibly-change-group group)
136 ;; Remove NOV lines of articles that are marked as read.
137 (when (and (file-exists-p (nnkiboze-nov-file-name))
138 nnkiboze-remove-read-articles)
139 (with-temp-file (nnkiboze-nov-file-name)
140 (let ((cur (current-buffer)))
141 (nnheader-insert-file-contents (nnkiboze-nov-file-name))
142 (goto-char (point-min))
144 (if (not (gnus-article-read-p (read cur)))
146 (gnus-delete-line))))))
147 (setq nnkiboze-current-group nil))
149 (deffoo nnkiboze-open-server (server &optional defs)
150 (unless (assq 'nnkiboze-regexp defs)
151 (push `(nnkiboze-regexp ,server)
153 (nnoo-change-server 'nnkiboze server defs))
155 (deffoo nnkiboze-request-delete-group (group &optional force server)
156 (nnkiboze-possibly-change-group group)
159 (nnkiboze-score-file group)
160 (list (nnkiboze-nov-file-name)
161 (nnkiboze-nov-file-name ".newsrc")))))
163 (and (file-exists-p (car files))
164 (file-writable-p (car files))
165 (delete-file (car files)))
166 (setq files (cdr files)))))
167 (setq nnkiboze-current-group nil)
170 (nnoo-define-skeleton nnkiboze)
173 ;;; Internal functions.
175 (defun nnkiboze-possibly-change-group (group)
176 (setq nnkiboze-current-group group))
178 (defun nnkiboze-prefixed-name (group)
179 (gnus-group-prefixed-name group '(nnkiboze "")))
182 (defun nnkiboze-generate-groups ()
183 "\"Usage: emacs -batch -l nnkiboze -f nnkiboze-generate-groups\".
184 Finds out what articles are to be part of the nnkiboze groups."
186 (let ((nnmail-spool-file nil)
188 (gnus-use-dribble-file nil)
189 (gnus-read-active-file t)
190 (gnus-expert-user t))
192 (let* ((gnus-newsrc-alist (gnus-copy-sequence gnus-newsrc-alist))
193 (newsrc (cdr gnus-newsrc-alist))
194 gnus-newsrc-hashtb info)
195 (gnus-make-hashtable-from-newsrc-alist)
196 ;; We have copied all the newsrc alist info over to local copies
197 ;; so that we can mess all we want with these lists.
198 (while (setq info (pop newsrc))
199 (when (string-match "nnkiboze" (gnus-info-group info))
200 ;; For each kiboze group, we call this function to generate
202 (nnkiboze-generate-group (gnus-info-group info))))))
204 (defun nnkiboze-score-file (group)
205 (list (expand-file-name
206 (concat (file-name-as-directory gnus-kill-files-directory)
207 (nnheader-translate-file-chars
208 (concat (nnkiboze-prefixed-name nnkiboze-current-group)
209 "." gnus-score-file-suffix))))))
211 (defun nnkiboze-generate-group (group)
212 (let* ((info (nth 2 (gnus-gethash group gnus-newsrc-hashtb)))
213 (newsrc-file (concat nnkiboze-directory
214 (nnheader-translate-file-chars
215 (concat group ".newsrc"))))
216 (nov-file (concat nnkiboze-directory
217 (nnheader-translate-file-chars
218 (concat group ".nov"))))
219 method nnkiboze-newsrc gname newsrc active
220 ginfo lowest glevel orig-info nov-buffer
221 ;; Bind various things to nil to make group entry faster.
223 (gnus-large-newsgroup nil)
224 (gnus-score-find-score-files-function 'nnkiboze-score-file)
225 (gnus-verbose (min gnus-verbose 3))
226 gnus-select-group-hook gnus-summary-prepare-hook
227 gnus-thread-sort-functions gnus-show-threads
228 gnus-visual gnus-suppress-duplicates num-unread)
230 (error "No such group: %s" group))
231 ;; Load the kiboze newsrc file for this group.
232 (when (file-exists-p newsrc-file)
234 (with-temp-file nov-file
235 (when (file-exists-p nov-file)
236 (insert-file-contents nov-file))
237 (setq nov-buffer (current-buffer))
238 ;; Go through the active hashtb and add new all groups that match the
242 (and (string-match nnkiboze-regexp
243 (setq gname (symbol-name group))) ; Match
244 (not (assoc gname nnkiboze-newsrc)) ; It isn't registered
245 (numberp (car (symbol-value group))) ; It is active
246 (or (> nnkiboze-level 7)
247 (and (setq glevel (nth 1 (nth 2 (gnus-gethash
248 gname gnus-newsrc-hashtb))))
249 (>= nnkiboze-level glevel)))
250 (not (string-match "^nnkiboze:" gname)) ; Exclude kibozes
251 (push (cons gname (1- (car (symbol-value group))))
254 ;; `newsrc' is set to the list of groups that possibly are
255 ;; component groups to this kiboze group. This list has elements
256 ;; on the form `(GROUP . NUMBER)', where NUMBER is the highest
257 ;; number that has been kibozed in GROUP in this kiboze group.
258 (setq newsrc nnkiboze-newsrc)
260 (if (not (setq active (gnus-gethash
261 (caar newsrc) gnus-active-hashtb)))
262 ;; This group isn't active after all, so we remove it from
263 ;; the list of component groups.
264 (setq nnkiboze-newsrc (delq (car newsrc) nnkiboze-newsrc))
265 (setq lowest (cdar newsrc))
266 ;; Ok, we have a valid component group, so we jump to it.
267 (switch-to-buffer gnus-group-buffer)
268 (gnus-group-jump-to-group (caar newsrc))
269 (gnus-message 3 "nnkiboze: Checking %s..." (caar newsrc))
270 (setq ginfo (gnus-get-info (gnus-group-group-name))
271 orig-info (gnus-copy-sequence ginfo)
272 num-unread (car (gnus-gethash (caar newsrc)
273 gnus-newsrc-hashtb)))
276 ;; We set all list of article marks to nil. Since we operate
277 ;; on copies of the real lists, we can destroy anything we
280 (setcar (nthcdr 3 ginfo) nil))
281 ;; We set the list of read articles to be what we expect for
282 ;; this kiboze group -- either nil or `(1 . LOWEST)'.
284 (setcar (nthcdr 2 ginfo)
285 (and (not (= lowest 1)) (cons 1 lowest))))
286 (when (and (or (not ginfo)
287 (> (length (gnus-list-of-unread-articles
292 (gnus-group-select-group nil))
293 (eq major-mode 'gnus-summary-mode)))
294 ;; We are now in the group where we want to be.
295 (setq method (gnus-find-method-for-group
296 gnus-newsgroup-name))
297 (when (eq method gnus-select-method)
299 ;; We go through the list of scored articles.
300 (while gnus-newsgroup-scored
301 (when (> (caar gnus-newsgroup-scored) lowest)
302 ;; If it has a good score, then we enter this article
303 ;; into the kiboze group.
306 (gnus-summary-article-header
307 (caar gnus-newsgroup-scored))
308 gnus-newsgroup-name))
309 (setq gnus-newsgroup-scored (cdr gnus-newsgroup-scored)))
310 ;; That's it. We exit this group.
311 (when (eq major-mode 'gnus-summary-mode)
312 (kill-buffer (current-buffer)))))
313 ;; Restore the proper info.
315 (setcdr ginfo (cdr orig-info)))
316 (setcar (gnus-gethash (caar newsrc) gnus-newsrc-hashtb)
318 (setcdr (car newsrc) (car active))
319 (gnus-message 3 "nnkiboze: Checking %s...done" (caar newsrc))
320 (setq newsrc (cdr newsrc))))
321 ;; We save the kiboze newsrc for this group.
322 (with-temp-file newsrc-file
323 (insert "(setq nnkiboze-newsrc '")
324 (gnus-prin1 nnkiboze-newsrc)
327 (set-buffer gnus-group-buffer)
328 (gnus-group-list-groups))
331 (defun nnkiboze-enter-nov (buffer header group)
334 (goto-char (point-max))
335 (let ((prefix (gnus-group-real-prefix group))
336 (oheader (copy-sequence header))
338 (if (zerop (forward-line -1))
340 (setq article (1+ (read (current-buffer))))
343 (mail-header-set-number oheader article)
344 (nnheader-insert-nov oheader)
345 (search-backward "\t" nil t 2)
346 (if (re-search-forward " [^ ]+:[0-9]+" nil t)
347 (goto-char (match-beginning 0))
349 ;; The first Xref has to be the group this article
350 ;; really came for - this is the article nnkiboze
351 ;; will request when it is asked for the article.
352 (insert " " group ":"
353 (int-to-string (mail-header-number header)) " ")
354 (while (re-search-forward " [^ ]+:[0-9]+" nil t)
355 (goto-char (1+ (match-beginning 0)))
358 (defun nnkiboze-nov-file-name (&optional suffix)
359 (concat (file-name-as-directory nnkiboze-directory)
360 (nnheader-translate-file-chars
361 (concat (nnkiboze-prefixed-name nnkiboze-current-group)
362 (or suffix ".nov")))))
366 ;;; nnkiboze.el ends here