1 ;;; nnkiboze.el --- select virtual news access for Gnus
2 ;; Copyright (C) 1995,96 Free Software Foundation, Inc.
4 ;; Author: Lars Magne Ingebrigtsen <larsi@ifi.uio.no>
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
21 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
25 ;; The other access methods (nntp, nnspool, etc) are general news
26 ;; access methods. This module relies on Gnus and can not be used
36 (defvar nnkiboze-directory
37 (expand-file-name (or gnus-article-save-directory "~/News/"))
38 "nnkiboze will put its files in this directory.")
40 (defvar nnkiboze-level 9
41 "*The maximum level to be searched for articles.")
43 (defvar nnkiboze-remove-read-articles t
44 "*If non-nil, nnkiboze will remove read articles from the kiboze group.")
48 (defconst nnkiboze-version "nnkiboze 1.0"
49 "Version numbers of this version of nnkiboze.")
51 (defvar nnkiboze-current-group nil)
52 (defvar nnkiboze-current-score-group "")
53 (defvar nnkiboze-status-string "")
57 ;;; Interface functions.
59 (defun nnkiboze-retrieve-headers (articles &optional group server fetch-old)
60 (nnkiboze-possibly-change-newsgroups group)
63 (if (stringp (car articles))
65 (let ((first (car articles))
66 (last (progn (while (cdr articles) (setq articles (cdr articles)))
68 (nov (nnkiboze-nov-file-name)))
69 (if (file-exists-p nov)
71 (set-buffer nntp-server-buffer)
73 (insert-file-contents nov)
74 (goto-char (point-min))
75 (while (and (not (eobp)) (< first (read (current-buffer))))
78 (if (not (eobp)) (delete-region 1 (point)))
79 (while (and (not (eobp)) (>= last (read (current-buffer))))
82 (if (not (eobp)) (delete-region (point) (point-max)))
85 (defun nnkiboze-open-server (newsgroups &optional something)
86 "Open a virtual newsgroup that contains NEWSGROUPS."
87 (gnus-make-directory nnkiboze-directory)
88 (nnheader-init-server-buffer))
90 (defun nnkiboze-close-server (&rest dum)
94 (defalias 'nnkiboze-request-quit (symbol-function 'nnkiboze-close-server))
96 (defun nnkiboze-server-opened (&optional server)
97 "Return server process status, T or NIL.
98 If the stream is opened, return T, otherwise return NIL."
99 (and nntp-server-buffer
100 (get-buffer nntp-server-buffer)))
102 (defun nnkiboze-status-message (&optional server)
103 "Return server status response as string."
104 nnkiboze-status-string)
106 (defun nnkiboze-request-article (article &optional newsgroup server buffer)
107 "Select article by message number."
108 (nnkiboze-possibly-change-newsgroups newsgroup)
109 (if (not (numberp article))
110 ;; This is a real kludge. It might not work at times, but it
111 ;; does no harm I think. The only alternative is to offer no
112 ;; article fetching by message-id at all.
113 (nntp-request-article article newsgroup gnus-nntp-server buffer)
114 (let* ((header (gnus-summary-article-header article))
115 (xref (mail-header-xref header))
117 (or xref (error "nnkiboze: No xref"))
118 (or (string-match " \\([^ ]+\\):\\([0-9]+\\)" xref)
119 (error "nnkiboze: Malformed xref"))
120 (setq igroup (substring xref (match-beginning 1) (match-end 1)))
121 (setq iarticle (string-to-int
122 (substring xref (match-beginning 2) (match-end 2))))
123 (and (gnus-request-group igroup t)
124 (gnus-request-article iarticle igroup buffer)))))
126 (defun nnkiboze-request-group (group &optional server dont-check)
127 "Make GROUP the current newsgroup."
128 (nnkiboze-possibly-change-newsgroups group)
131 (let ((nov-file (nnkiboze-nov-file-name))
134 (set-buffer nntp-server-buffer)
136 (if (not (file-exists-p nov-file))
137 (insert (format "211 0 0 0 %s\n" group))
138 (insert-file-contents nov-file)
139 (if (zerop (buffer-size))
140 (insert (format "211 0 0 0 %s\n" group))
141 (goto-char (point-min))
142 (and (looking-at "[0-9]+") (setq beg (read (current-buffer))))
143 (goto-char (point-max))
144 (and (re-search-backward "^[0-9]" nil t)
145 (setq end (read (current-buffer))))
146 (setq total (count-lines (point-min) (point-max)))
148 (insert (format "211 %d %d %d %s\n" total beg end group)))))))
151 (defun nnkiboze-close-group (group &optional server)
152 (nnkiboze-possibly-change-newsgroups group)
153 ;; Remove NOV lines of articles that are marked as read.
154 (when (and (file-exists-p (nnkiboze-nov-file-name))
155 nnkiboze-remove-read-articles
156 (eq major-mode 'gnus-summary-mode))
158 (let ((unreads gnus-newsgroup-unreads)
159 (unselected gnus-newsgroup-unselected)
160 (version-control 'never))
161 (set-buffer (get-buffer-create "*nnkiboze work*"))
162 (buffer-disable-undo (current-buffer))
164 (let ((cur (current-buffer))
166 (insert-file-contents (nnkiboze-nov-file-name))
167 (goto-char (point-min))
168 (while (looking-at "[0-9]+")
169 (if (or (memq (setq article (read cur)) unreads)
170 (memq article unselected))
172 (delete-region (progn (beginning-of-line) (point))
173 (progn (forward-line 1) (point)))))
174 (write-file (nnkiboze-nov-file-name))
175 (kill-buffer (current-buffer)))))
176 (setq nnkiboze-current-group nil)))
178 (defun nnkiboze-request-list (&optional server)
179 (setq nnkiboze-status-string "nnkiboze: LIST is not implemented.")
182 (defun nnkiboze-request-newgroups (date &optional server)
184 (setq nnkiboze-status-string "NEWGROUPS is not supported.")
187 (defun nnkiboze-request-list-newsgroups (&optional server)
188 (setq nnkiboze-status-string "nnkiboze: LIST NEWSGROUPS is not implemented.")
191 (defalias 'nnkiboze-request-post 'nntp-request-post)
193 (defun nnkiboze-request-delete-group (group &optional force server)
194 (nnkiboze-possibly-change-newsgroups group)
196 (let ((files (list (nnkiboze-nov-file-name)
197 (concat nnkiboze-directory group ".newsrc")
198 (nnkiboze-score-file group))))
200 (and (file-exists-p (car files))
201 (file-writable-p (car files))
202 (delete-file (car files)))
203 (setq files (cdr files)))))
204 (setq nnkiboze-current-group nil))
207 ;;; Internal functions.
209 (defun nnkiboze-possibly-change-newsgroups (group)
210 (setq nnkiboze-current-group group))
212 (defun nnkiboze-prefixed-name (group)
213 (gnus-group-prefixed-name group '(nnkiboze "")))
216 (defun nnkiboze-generate-groups ()
217 "Usage: emacs -batch -l nnkiboze -f nnkiboze-generate-groups
218 Finds out what articles are to be part of the nnkiboze groups."
220 (let ((nnmail-spool-file nil)
221 (gnus-use-dribble-file nil)
222 (gnus-read-active-file t)
223 (gnus-expert-user t))
225 (let* ((gnus-newsrc-alist (gnus-copy-sequence gnus-newsrc-alist))
226 (newsrc gnus-newsrc-alist)
228 (gnus-make-hashtable-from-newsrc-alist)
229 ;; We have copied all the newsrc alist info over to local copies
230 ;; so that we can mess all we want with these lists.
232 (if (string-match "nnkiboze" (car (car newsrc)))
233 ;; For each kiboze group, we call this function to generate
235 (nnkiboze-generate-group (car (car newsrc))))
236 (setq newsrc (cdr newsrc)))))
238 (defun nnkiboze-score-file (group)
239 (list (expand-file-name
240 (concat (file-name-as-directory gnus-kill-files-directory)
241 (nnheader-translate-file-chars
242 (concat nnkiboze-current-score-group
243 "." gnus-score-file-suffix))))))
245 (defun nnkiboze-generate-group (group)
246 (let* ((info (nth 2 (gnus-gethash group gnus-newsrc-hashtb)))
247 (newsrc-file (concat nnkiboze-directory group ".newsrc"))
248 (nov-file (concat nnkiboze-directory group ".nov"))
249 (regexp (nth 1 (nth 4 info)))
251 (gnus-large-newsgroup nil)
252 (version-control 'never)
253 (gnus-score-find-score-files-function 'nnkiboze-score-file)
254 gnus-select-group-hook gnus-summary-prepare-hook
255 gnus-thread-sort-functions gnus-show-threads
257 method nnkiboze-newsrc nov-buffer gname newsrc active
259 (setq nnkiboze-current-score-group group)
260 (or info (error "No such group: %s" group))
261 ;; Load the kiboze newsrc file for this group.
262 (and (file-exists-p newsrc-file) (load newsrc-file))
263 ;; We also load the nov file for this group.
265 (set-buffer (setq nov-buffer (find-file-noselect nov-file)))
266 (buffer-disable-undo (current-buffer)))
267 ;; Go through the active hashtb and add new all groups that match the
271 (and (string-match regexp (setq gname (symbol-name group))) ; Match
272 (not (assoc gname nnkiboze-newsrc)) ; It isn't registered
273 (numberp (car (symbol-value group))) ; It is active
274 (or (> nnkiboze-level 7)
275 (and (setq glevel (nth 1 (nth 2 (gnus-gethash
276 gname gnus-newsrc-hashtb))))
277 (>= nnkiboze-level glevel)))
278 (not (string-match "^nnkiboze:" gname)) ; Exclude kibozes
279 (setq nnkiboze-newsrc
280 (cons (cons gname (1- (car (symbol-value group))))
283 ;; `newsrc' is set to the list of groups that possibly are
284 ;; component groups to this kiboze group. This list has elements
285 ;; on the form `(GROUP . NUMBER)', where NUMBER is the highest
286 ;; number that has been kibozed in GROUP in this kiboze group.
287 (setq newsrc nnkiboze-newsrc)
289 (if (not (setq active (gnus-gethash
290 (car (car newsrc)) gnus-active-hashtb)))
291 ;; This group isn't active after all, so we remove it from
292 ;; the list of component groups.
293 (setq nnkiboze-newsrc (delq (car newsrc) nnkiboze-newsrc))
294 (setq lowest (cdr (car newsrc)))
295 ;; Ok, we have a valid component group, so we jump to it.
296 (switch-to-buffer gnus-group-buffer)
297 (gnus-group-jump-to-group (car (car newsrc)))
298 ;; We set all list of article marks to nil. Since we operate
299 ;; on copies of the real lists, we can destroy anything we
301 (and (setq ginfo (nth 2 (gnus-gethash (gnus-group-group-name)
302 gnus-newsrc-hashtb)))
304 (setcar (nthcdr 3 ginfo) nil))
305 ;; We set the list of read articles to be what we expect for
306 ;; this kiboze group -- either nil or `(1 . LOWEST)'.
307 (and ginfo (setcar (nthcdr 2 ginfo)
308 (and (not (= lowest 1)) (cons 1 lowest))))
309 (if (not (and (or (not ginfo)
310 (> (length (gnus-list-of-unread-articles
313 (gnus-group-select-group nil)
314 (eq major-mode 'gnus-summary-mode))))
315 () ; No unread articles, or we couldn't enter this group.
316 ;; We are now in the group where we want to be.
317 (setq method (gnus-find-method-for-group gnus-newsgroup-name))
318 (and (eq method gnus-select-method) (setq method nil))
319 ;; We go through the list of scored articles.
320 (while gnus-newsgroup-scored
321 (if (> (car (car gnus-newsgroup-scored)) lowest)
322 ;; If it has a good score, then we enter this article
323 ;; into the kiboze group.
326 (gnus-summary-article-header
327 (car (car gnus-newsgroup-scored)))
329 (gnus-group-prefixed-name gnus-newsgroup-name method)
330 gnus-newsgroup-name)))
331 (setq gnus-newsgroup-scored (cdr gnus-newsgroup-scored)))
332 ;; That's it. We exit this group.
333 (gnus-summary-exit-no-update)))
334 (setcdr (car newsrc) (car active))
335 (setq newsrc (cdr newsrc)))
336 ;; We save the nov file.
337 (set-buffer nov-buffer)
339 (kill-buffer (current-buffer))
340 ;; We save the kiboze newsrc for this group.
341 (set-buffer (get-buffer-create "*nnkiboze work*"))
342 (buffer-disable-undo (current-buffer))
344 (insert "(setq nnkiboze-newsrc '" (prin1-to-string nnkiboze-newsrc)
346 (write-file newsrc-file)
347 (kill-buffer (current-buffer))
348 (switch-to-buffer gnus-group-buffer)
349 (gnus-group-list-groups 5 nil)))
351 (defun nnkiboze-enter-nov (buffer header group)
354 (goto-char (point-max))
355 (let ((xref (mail-header-xref header))
356 (prefix (gnus-group-real-prefix group))
359 (if (zerop (forward-line -1))
361 (setq article (1+ (read (current-buffer))))
364 (insert (int-to-string article) "\t"
365 (or (mail-header-subject header) "") "\t"
366 (or (mail-header-from header) "") "\t"
367 (or (mail-header-date header) "") "\t"
368 (or (mail-header-id header) "") "\t"
369 (or (mail-header-references header) "") "\t"
370 (int-to-string (or (mail-header-chars header) 0)) "\t"
371 (int-to-string (or (mail-header-lines header) 0)) "\t")
372 (if (or (not xref) (equal "" xref))
373 (insert "Xref: " (system-name) " " group ":"
374 (int-to-string (mail-header-number header))
376 (insert (mail-header-xref header) "\t\n")
377 (search-backward "\t" nil t)
378 (search-backward "\t" nil t)
379 (while (re-search-forward
381 (save-excursion (end-of-line) (point)) t)
383 ;; The first xref has to be the group this article
384 ;; really came for - this is the article nnkiboze
385 ;; will request when it is asked for the article.
387 (goto-char (match-beginning 0))
388 (insert prefix group ":"
389 (int-to-string (mail-header-number header)) " ")
392 (goto-char (match-beginning 0))
393 (insert prefix)))))))
395 (defun nnkiboze-nov-file-name ()
396 (concat (file-name-as-directory nnkiboze-directory)
397 (nnheader-translate-file-chars
398 (concat (nnkiboze-prefixed-name nnkiboze-current-group) ".nov"))))
402 ;;; nnkiboze.el ends here