1 ;;; gnus-nocem.el --- NoCeM pseudo-cancellation treatment
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.
28 (eval-when-compile (require 'cl))
36 (defgroup gnus-nocem nil
37 "NoCeM pseudo-cancellation treatment"
40 (defcustom gnus-nocem-groups
41 '("news.lists.filters" "news.admin.net-abuse.bulletins"
42 "alt.nocem.misc" "news.admin.net-abuse.announce")
43 "*List of groups that will be searched for NoCeM messages."
45 :type '(repeat (string :tag "Group")))
47 (defcustom gnus-nocem-issuers
48 '("AutoMoose-1" "Automoose-1" ; CancelMoose[tm]
49 "rbraver@ohww.norman.ok.us" ; Robert Braver
50 "clewis@ferret.ocunix.on.ca" ; Chris Lewis
51 "jem@xpat.com" ; Despammer from Korea
52 "snowhare@xmission.com" ; Benjamin "Snowhare" Franz
53 "red@redpoll.mrfs.oh.us (Richard E. Depew)" ; ARMM! ARMM!
55 "*List of NoCeM issuers to pay attention to.
57 This can also be a list of `(ISSUER CONDITIONS)' elements."
59 :type '(repeat (choice string sexp)))
61 (defcustom gnus-nocem-directory
62 (nnheader-concat gnus-article-save-directory "NoCeM/")
63 "*Directory where NoCeM files will be stored."
67 (defcustom gnus-nocem-expiry-wait 15
68 "*Number of days to keep NoCeM headers in the cache."
72 (defcustom gnus-nocem-verifyer 'mc-verify
73 "*Function called to verify that the NoCeM message is valid.
74 One likely value is `mc-verify'. If the function in this variable
75 isn't bound, the message will be used unconditionally."
77 :type '(radio (function-item mc-verify)
78 (function :tag "other")))
80 (defcustom gnus-nocem-liberal-fetch nil
81 "*If t try to fetch all messages which have @@NCM in the subject.
82 Otherwise don't fetch messages which have references or whose message-id
83 matches an previously scanned and verified nocem message."
87 ;;; Internal variables
89 (defvar gnus-nocem-active nil)
90 (defvar gnus-nocem-alist nil)
91 (defvar gnus-nocem-touched-alist nil)
92 (defvar gnus-nocem-hashtb nil)
93 (defvar gnus-nocem-seen-message-ids nil)
97 (defun gnus-nocem-active-file ()
98 (concat (file-name-as-directory gnus-nocem-directory) "active"))
100 (defun gnus-nocem-cache-file ()
101 (concat (file-name-as-directory gnus-nocem-directory) "cache"))
104 ;; faster lookups for group names:
107 (defvar gnus-nocem-real-group-hashtb nil
108 "Real-name mappings of subscribed groups.")
110 (defun gnus-fill-real-hashtb ()
111 "Fill up a hash table with the real-name mappings from the user's active file."
112 (setq gnus-nocem-real-group-hashtb (gnus-make-hashtable
113 (length gnus-newsrc-alist)))
114 (mapcar (lambda (group)
115 (setq group (gnus-group-real-name (car group)))
116 (gnus-sethash group t gnus-nocem-real-group-hashtb))
119 (defun gnus-nocem-scan-groups ()
120 "Scan all NoCeM groups for new NoCeM messages."
122 (let ((groups gnus-nocem-groups)
123 (gnus-inhibit-demon t)
124 group active gactive articles check-headers)
125 (gnus-make-directory gnus-nocem-directory)
126 ;; Load any previous NoCeM headers.
127 (gnus-nocem-load-cache)
128 ;; Get the group name mappings:
129 (gnus-fill-real-hashtb)
130 ;; Read the active file if it hasn't been read yet.
131 (and (file-exists-p (gnus-nocem-active-file))
132 (not gnus-nocem-active)
134 (load (gnus-nocem-active-file) t t t)))
135 ;; Go through all groups and see whether new articles have
137 (while (setq group (pop groups))
138 (if (not (setq gactive (gnus-activate-group group)))
139 () ; This group doesn't exist.
140 (setq active (nth 1 (assoc group gnus-nocem-active)))
141 (when (and (not (< (cdr gactive) (car gactive))) ; Empty group.
143 (< (cdr active) (cdr gactive))))
144 ;; Ok, there are new articles in this group, se we fetch the
147 (let ((dependencies (make-vector 10 nil))
152 (gnus-retrieve-headers
154 (gnus-uncompress-range
156 (if active (1+ (cdr active))
160 (gnus-get-newsgroup-headers-xover
161 articles nil dependencies)
162 (gnus-get-newsgroup-headers dependencies)))
163 (while (setq header (pop headers))
164 ;; We take a closer look on all articles that have
165 ;; "@@NCM" in the subject. Unless we already read
166 ;; this cross posted message. Nocem messages
167 ;; are not allowed to have references, so we can
168 ;; ignore scanning followups.
169 (and (string-match "@@NCM" (mail-header-subject header))
170 (or gnus-nocem-liberal-fetch
171 (and (or (string= "" (mail-header-references
173 (null (mail-header-references header)))
174 (not (member (mail-header-message-id header)
175 gnus-nocem-seen-message-ids))))
176 (push header check-headers)))
178 (len (length check-headers)))
179 (dolist (h check-headers)
181 7 "Checking article %d in %s for NoCeM (%d of %d)..."
182 (mail-header-number h) group (incf i) len)
183 (gnus-nocem-check-article group h)))))))
184 (setq gnus-nocem-active
185 (cons (list group gactive)
186 (delq (assoc group gnus-nocem-active)
187 gnus-nocem-active)))))
188 ;; Save the results, if any.
189 (gnus-nocem-save-cache)
190 (gnus-nocem-save-active)))
192 (defun gnus-nocem-check-article (group header)
193 "Check whether the current article is an NCM article and that we want it."
195 (let ((date (mail-header-date header))
199 (time-since (date-to-time date))
200 (days-to-time gnus-nocem-expiry-wait)))
201 (gnus-request-article-this-buffer (mail-header-number header) group)
202 (goto-char (point-min))
203 (when (re-search-forward "-----BEGIN PGP MESSAGE-----" nil t)
204 (delete-region (point-min) (match-beginning 0)))
205 (when (re-search-forward "-----END PGP MESSAGE-----\n?" nil t)
206 (delete-region (match-end 0) (point-max)))
207 (goto-char (point-min))
208 ;; The article has to have proper NoCeM headers.
209 (when (and (setq b (search-forward "\n@@BEGIN NCM HEADERS\n" nil t))
210 (setq e (search-forward "\n@@BEGIN NCM BODY\n" nil t)))
211 ;; We get the name of the issuer.
212 (narrow-to-region b e)
213 (setq issuer (mail-fetch-field "issuer")
214 type (mail-fetch-field "issuer"))
216 (if (not (gnus-nocem-message-wanted-p issuer type))
217 (message "invalid NoCeM issuer: %s" issuer)
218 (and (gnus-nocem-verify-issuer issuer) ; She is who she says she is.
219 (gnus-nocem-enter-article) ; We gobble the message.
220 (push (mail-header-message-id header) ; But don't come back for
221 gnus-nocem-seen-message-ids))))))) ; second helpings.
223 (defun gnus-nocem-message-wanted-p (issuer type)
224 (let ((issuers gnus-nocem-issuers)
225 wanted conditions condition)
227 ;; Do the quick check first.
228 ((member issuer issuers)
230 ((setq conditions (cdr (assoc issuer issuers)))
231 ;; Check whether we want this type.
232 (while (setq condition (pop conditions))
235 (setq wanted (string-match condition type)))
236 ((and (consp condition)
237 (eq (car condition) 'not)
238 (stringp (cadr condition)))
239 (setq wanted (not (string-match (cadr condition) type))))
241 (error "Invalid NoCeM condition: %S" condition))))
244 (defun gnus-nocem-verify-issuer (person)
245 "Verify using PGP that the canceler is who she says she is."
246 (if (fboundp gnus-nocem-verifyer)
248 (funcall gnus-nocem-verifyer))
249 ;; If we don't have Mailcrypt, then we use the message anyway.
252 (defun gnus-nocem-enter-article ()
253 "Enter the current article into the NoCeM cache."
254 (goto-char (point-min))
255 (let ((b (search-forward "\n@@BEGIN NCM BODY\n" nil t))
256 (e (search-forward "\n@@END NCM BODY\n" nil t))
257 (buf (current-buffer))
260 (narrow-to-region b (1+ (match-beginning 0)))
261 (goto-char (point-min))
262 (while (search-forward "\t" nil t)
265 (setq group (let ((obarray gnus-active-hashtb)) (read buf)))))
268 ((not (symbolp group))
269 ;; Ignore invalid entries.
271 ((not (boundp group))
272 ;; Make sure all entries in the hashtb are bound.
275 (when (gnus-gethash (gnus-group-real-name (symbol-name group))
276 gnus-nocem-real-group-hashtb)
279 (while (eq (char-after) ?\t)
281 (setq id (buffer-substring (point) (1- (search-forward "\t"))))
282 (unless (gnus-gethash id gnus-nocem-hashtb)
283 ;; only store if not already present
284 (gnus-sethash id t gnus-nocem-hashtb)
287 (while (eq (char-after) ?\t)
288 (forward-line 1))))))
290 (setq gnus-nocem-touched-alist t)
291 (push (cons (let ((time (current-time))) (setcdr (cdr time) nil) time)
296 (defun gnus-nocem-load-cache ()
297 "Load the NoCeM cache."
299 (unless gnus-nocem-alist
300 ;; The buffer doesn't exist, so we create it and load the NoCeM
302 (when (file-exists-p (gnus-nocem-cache-file))
303 (load (gnus-nocem-cache-file) t t t)
304 (gnus-nocem-alist-to-hashtb))))
306 (defun gnus-nocem-save-cache ()
307 "Save the NoCeM cache."
308 (when (and gnus-nocem-alist
309 gnus-nocem-touched-alist)
310 (with-temp-file (gnus-nocem-cache-file)
311 (gnus-prin1 `(setq gnus-nocem-alist ',gnus-nocem-alist)))
312 (setq gnus-nocem-touched-alist nil)))
314 (defun gnus-nocem-save-active ()
315 "Save the NoCeM active file."
316 (with-temp-file (gnus-nocem-active-file)
317 (gnus-prin1 `(setq gnus-nocem-active ',gnus-nocem-active))))
319 (defun gnus-nocem-alist-to-hashtb ()
320 "Create a hashtable from the Message-IDs we have."
321 (let* ((alist gnus-nocem-alist)
322 (pprev (cons nil alist))
324 (expiry (days-to-time gnus-nocem-expiry-wait))
326 (setq gnus-nocem-hashtb (gnus-make-hashtable (* (length alist) 51)))
327 (while (setq entry (car alist))
328 (if (not (time-less-p (time-since (car entry)) expiry))
329 ;; This entry has expired, so we remove it.
330 (setcdr prev (cdr alist))
332 ;; This is ok, so we enter it into the hashtable.
333 (setq entry (cdr entry))
335 (gnus-sethash (car entry) t gnus-nocem-hashtb)
336 (setq entry (cdr entry))))
337 (setq alist (cdr alist)))))
339 (gnus-add-shutdown 'gnus-nocem-close 'gnus)
341 (defun gnus-nocem-close ()
342 "Clear internal NoCeM variables."
343 (setq gnus-nocem-alist nil
344 gnus-nocem-hashtb nil
345 gnus-nocem-active nil
346 gnus-nocem-touched-alist nil
347 gnus-nocem-seen-message-ids nil
348 gnus-nocem-real-group-hashtb nil))
350 (defun gnus-nocem-unwanted-article-p (id)
351 "Say whether article ID in the current group is wanted."
352 (and gnus-nocem-hashtb
353 (gnus-gethash id gnus-nocem-hashtb)))
355 (provide 'gnus-nocem)
357 ;;; gnus-nocem.el ends here