1 ;;; spam.el --- Identifying spam
2 ;; Copyright (C) 2002 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 ;;; This module addresses a few aspects of spam control under Gnus. Page
27 ;;; breaks are used for grouping declarations and documentation relating to
28 ;;; each particular aspect.
30 ;;; The integration with Gnus is not yet complete. See various `FIXME'
31 ;;; comments, below, for supplementary explanations or discussions.
33 ;;; Several TODO items are marked as such
39 (require 'gnus-uu) ; because of key prefix issues
40 (require 'gnus) ; for the definitions of group content classification and spam processors
41 (require 'message) ;for the message-fetch-field functions
43 ;; autoload executable-find
45 ;; executable-find is not autoloaded in Emacs 20
46 (autoload 'executable-find "executable"))
50 (autoload 'query-dig "dig"))
54 (autoload 'query-dns "dns"))
59 "Spam configuration.")
61 (defcustom spam-directory "~/News/spam/"
62 "Directory for spam whitelists and blacklists."
66 (defcustom spam-move-spam-nonspam-groups-only t
67 "Whether spam should be moved in non-spam groups only.
68 When nil, only ham and unclassified groups will have their spam moved
69 to the spam-process-destination. When t, spam will also be moved from
74 (defcustom spam-whitelist (expand-file-name "whitelist" spam-directory)
75 "The location of the whitelist.
76 The file format is one regular expression per line.
77 The regular expression is matched against the address."
81 (defcustom spam-blacklist (expand-file-name "blacklist" spam-directory)
82 "The location of the blacklist.
83 The file format is one regular expression per line.
84 The regular expression is matched against the address."
88 (defcustom spam-use-dig t
89 "Whether query-dig should be used instead of query-dns."
93 (defcustom spam-use-blacklist nil
94 "Whether the blacklist should be used by spam-split."
98 (defcustom spam-use-whitelist nil
99 "Whether the whitelist should be used by spam-split."
103 (defcustom spam-use-blackholes nil
104 "Whether blackholes should be used by spam-split."
108 (defcustom spam-use-regex-headers nil
109 "Whether a header regular expression match should be used by spam-split.
110 Also see the variable `spam-spam-regex-headers' and `spam-ham-regex-headers'."
114 (defcustom spam-use-bogofilter-headers nil
115 "Whether bogofilter headers should be used by spam-split.
116 Enable this if you pre-process messages with Bogofilter BEFORE Gnus sees them."
120 (defcustom spam-use-bogofilter nil
121 "Whether bogofilter should be invoked by spam-split.
122 Enable this if you want Gnus to invoke Bogofilter on new messages."
126 (defcustom spam-use-BBDB nil
127 "Whether BBDB should be used by spam-split."
131 (defcustom spam-use-ifile nil
132 "Whether ifile should be used by spam-split."
136 (defcustom spam-use-stat nil
137 "Whether spam-stat should be used by spam-split."
141 (defcustom spam-split-group "spam"
142 "Group name where incoming spam should be put by spam-split."
146 (defcustom spam-junk-mailgroups (cons spam-split-group '("mail.junk" "poste.pourriel"))
147 "Mailgroups with spam contents.
148 All unmarked article in such group receive the spam mark on group entry."
149 :type '(repeat (string :tag "Group"))
152 (defcustom spam-blackhole-servers '("bl.spamcop.net" "relays.ordb.org"
153 "dev.null.dk" "relays.visi.com")
154 "List of blackhole servers."
155 :type '(repeat (string :tag "Server"))
158 (defcustom spam-blackhole-good-server-regex nil
159 "String matching IP addresses that should not be checked in the blackholes"
163 (defcustom spam-ham-marks (list 'gnus-del-mark 'gnus-read-mark
164 'gnus-killed-mark 'gnus-kill-file-mark
165 'gnus-low-score-mark)
166 "Marks considered as being ham (positively not spam).
167 Such articles will be processed as ham (non-spam) on group exit."
169 (variable-item gnus-del-mark)
170 (variable-item gnus-read-mark)
171 (variable-item gnus-killed-mark)
172 (variable-item gnus-kill-file-mark)
173 (variable-item gnus-low-score-mark))
176 (defcustom spam-spam-marks (list 'gnus-spam-mark)
177 "Marks considered as being spam (positively spam).
178 Such articles will be transmitted to `bogofilter -s' on group exit."
180 (variable-item gnus-spam-mark)
181 (variable-item gnus-killed-mark)
182 (variable-item gnus-kill-file-mark)
183 (variable-item gnus-low-score-mark))
186 (defcustom spam-face 'gnus-splash-face
187 "Face for spam-marked articles"
191 (defcustom spam-regex-headers-spam '("^X-Spam-Flag: YES")
192 "Regular expression for positive header spam matches"
193 :type '(repeat (regexp :tag "Regular expression to match spam header"))
196 (defcustom spam-regex-headers-ham '("^X-Spam-Flag: NO")
197 "Regular expression for positive header ham matches"
198 :type '(repeat (regexp :tag "Regular expression to match ham header"))
201 (defgroup spam-ifile nil
202 "Spam ifile configuration."
205 (defcustom spam-ifile-path (executable-find "ifile")
206 "File path of the ifile executable program."
207 :type '(choice (file :tag "Location of ifile")
208 (const :tag "ifile is not installed"))
211 (defcustom spam-ifile-database-path nil
212 "File path of the ifile database."
213 :type '(choice (file :tag "Location of the ifile database")
214 (const :tag "Use the default"))
217 (defcustom spam-ifile-spam-category "spam"
218 "Name of the spam ifile category."
222 (defcustom spam-ifile-ham-category nil
223 "Name of the ham ifile category. If nil, the current group name will
225 :type '(choice (string :tag "Use a fixed category")
226 (const :tag "Use the current group name"))
229 (defcustom spam-ifile-all-categories nil
230 "Whether the ifile check will return all categories, or just spam.
231 Set this to t if you want to use the spam-split invocation of ifile as
232 your main source of newsgroup names."
236 (defgroup spam-bogofilter nil
237 "Spam bogofilter configuration."
240 (defcustom spam-bogofilter-path (executable-find "bogofilter")
241 "File path of the Bogofilter executable program."
242 :type '(choice (file :tag "Location of bogofilter")
243 (const :tag "Bogofilter is not installed"))
244 :group 'spam-bogofilter)
246 (defcustom spam-bogofilter-header "X-Bogosity"
247 "The header that Bogofilter inserts in messages."
249 :group 'spam-bogofilter)
251 (defcustom spam-bogofilter-bogosity-positive-spam-header "^\\(Yes\\|Spam\\)"
252 "The regex on `spam-bogofilter-header' for positive spam identification."
254 :group 'spam-bogofilter)
256 (defcustom spam-bogofilter-database-directory nil
257 "Directory path of the Bogofilter databases."
258 :type '(choice (directory :tag "Location of the Bogofilter database directory")
259 (const :tag "Use the default"))
262 ;;; Key bindings for spam control.
264 (gnus-define-keys gnus-summary-mode-map
265 "St" spam-bogofilter-score
266 "Sx" gnus-summary-mark-as-spam
267 "Mst" spam-bogofilter-score
268 "Msx" gnus-summary-mark-as-spam
269 "\M-d" gnus-summary-mark-as-spam)
271 ;;; How to highlight a spam summary line.
273 ;; TODO: How do we redo this every time spam-face is customized?
275 (push '((eq mark gnus-spam-mark) . spam-face)
276 gnus-summary-highlight)
278 ;; convenience functions
279 (defun spam-group-spam-contents-p (group)
281 (or (member group spam-junk-mailgroups)
282 (memq 'gnus-group-spam-classification-spam
283 (gnus-parameter-spam-contents group)))
286 (defun spam-group-ham-contents-p (group)
288 (memq 'gnus-group-spam-classification-ham
289 (gnus-parameter-spam-contents group))
292 (defun spam-group-processor-p (group processor)
293 (if (and (stringp group)
295 (member processor (car (gnus-parameter-spam-process group)))
298 (defun spam-group-spam-processor-bogofilter-p (group)
299 (spam-group-processor-p group 'gnus-group-spam-exit-processor-bogofilter))
301 (defun spam-group-spam-processor-blacklist-p (group)
302 (spam-group-processor-p group 'gnus-group-spam-exit-processor-blacklist))
304 (defun spam-group-spam-processor-ifile-p (group)
305 (spam-group-processor-p group 'gnus-group-spam-exit-processor-ifile))
307 (defun spam-group-ham-processor-ifile-p (group)
308 (spam-group-processor-p group 'gnus-group-ham-exit-processor-ifile))
310 (defun spam-group-ham-processor-bogofilter-p (group)
311 (spam-group-processor-p group 'gnus-group-ham-exit-processor-bogofilter))
313 (defun spam-group-spam-processor-stat-p (group)
314 (spam-group-processor-p group 'gnus-group-spam-exit-processor-stat))
316 (defun spam-group-ham-processor-stat-p (group)
317 (spam-group-processor-p group 'gnus-group-ham-exit-processor-stat))
319 (defun spam-group-ham-processor-whitelist-p (group)
320 (spam-group-processor-p group 'gnus-group-ham-exit-processor-whitelist))
322 (defun spam-group-ham-processor-BBDB-p (group)
323 (spam-group-processor-p group 'gnus-group-ham-exit-processor-BBDB))
325 ;;; Summary entry and exit processing.
327 (defun spam-summary-prepare ()
328 (spam-mark-junk-as-spam-routine))
330 (add-hook 'gnus-summary-prepare-hook 'spam-summary-prepare)
332 (defun spam-summary-prepare-exit ()
333 ;; The spam processors are invoked for any group, spam or ham or neither
334 (gnus-message 6 "Exiting summary buffer and applying spam rules")
335 (when (and spam-bogofilter-path
336 (spam-group-spam-processor-bogofilter-p gnus-newsgroup-name))
337 (gnus-message 5 "Registering spam with bogofilter")
338 (spam-bogofilter-register-spam-routine))
340 (when (and spam-ifile-path
341 (spam-group-spam-processor-ifile-p gnus-newsgroup-name))
342 (gnus-message 5 "Registering spam with ifile")
343 (spam-ifile-register-spam-routine))
345 (when (spam-group-spam-processor-stat-p gnus-newsgroup-name)
346 (gnus-message 5 "Registering spam with spam-stat")
347 (spam-stat-register-spam-routine))
349 (when (spam-group-spam-processor-blacklist-p gnus-newsgroup-name)
350 (gnus-message 5 "Registering spam with the blacklist")
351 (spam-blacklist-register-routine))
353 (if spam-move-spam-nonspam-groups-only
354 (when (not (spam-group-spam-contents-p gnus-newsgroup-name))
355 (spam-mark-spam-as-expired-and-move-routine
356 (gnus-parameter-spam-process-destination gnus-newsgroup-name)))
357 (gnus-message 5 "Marking spam as expired and moving it")
358 (spam-mark-spam-as-expired-and-move-routine
359 (gnus-parameter-spam-process-destination gnus-newsgroup-name)))
361 ;; now we redo spam-mark-spam-as-expired-and-move-routine to only
362 ;; expire spam, in case the above did not expire them
363 (spam-mark-spam-as-expired-and-move-routine nil)
365 (when (spam-group-ham-contents-p gnus-newsgroup-name)
366 (when (spam-group-ham-processor-whitelist-p gnus-newsgroup-name)
367 (gnus-message 5 "Registering ham with the whitelist")
368 (spam-whitelist-register-routine))
369 (when (spam-group-ham-processor-ifile-p gnus-newsgroup-name)
370 (gnus-message 5 "Registering ham with ifile")
371 (spam-ifile-register-ham-routine))
372 (when (spam-group-ham-processor-bogofilter-p gnus-newsgroup-name)
373 (gnus-message 5 "Registering ham with Bogofilter")
374 (spam-bogofilter-register-ham-routine))
375 (when (spam-group-ham-processor-stat-p gnus-newsgroup-name)
376 (gnus-message 5 "Registering ham with spam-stat")
377 (spam-stat-register-ham-routine))
378 (when (spam-group-ham-processor-BBDB-p gnus-newsgroup-name)
379 (gnus-message 5 "Registering ham with the BBDB")
380 (spam-BBDB-register-routine)))
382 ;; now move all ham articles out of spam groups
383 (when (spam-group-spam-contents-p gnus-newsgroup-name)
384 (gnus-message 5 "Moving ham messages from spam group")
385 (spam-ham-move-routine
386 (gnus-parameter-ham-process-destination gnus-newsgroup-name))))
388 (add-hook 'gnus-summary-prepare-exit-hook 'spam-summary-prepare-exit)
390 (defun spam-mark-junk-as-spam-routine ()
391 ;; check the global list of group names spam-junk-mailgroups and the
393 (when (spam-group-spam-contents-p gnus-newsgroup-name)
394 (gnus-message 5 "Marking unread articles as spam")
395 (let ((articles gnus-newsgroup-articles)
398 (setq article (pop articles))
399 (when (eq (gnus-summary-article-mark article) gnus-unread-mark)
400 (gnus-summary-mark-article article gnus-spam-mark))))))
402 (defun spam-mark-spam-as-expired-and-move-routine (&optional group)
403 (let ((articles gnus-newsgroup-articles)
406 (setq article (pop articles))
407 (when (eq (gnus-summary-article-mark article) gnus-spam-mark)
408 (gnus-summary-mark-article article gnus-expirable-mark)
409 (when (stringp group)
410 (let ((gnus-current-article article))
411 (gnus-summary-move-article nil group)))))))
413 (defun spam-ham-move-routine (&optional group)
414 (let ((articles gnus-newsgroup-articles)
415 article ham-mark-values mark)
417 (dolist (mark spam-ham-marks)
418 (push (symbol-value mark) ham-mark-values))
420 (dolist (article articles)
421 (when (and (memq (gnus-summary-article-mark article) ham-mark-values)
423 (let ((gnus-current-article article))
424 (gnus-summary-move-article nil group))))))
426 (defun spam-generic-register-routine (spam-func ham-func)
427 (let ((articles gnus-newsgroup-articles)
428 article mark ham-articles spam-articles spam-mark-values
431 ;; marks are stored as symbolic values, so we have to dereference
432 ;; them for memq to work. we wouldn't have to do this if
433 ;; gnus-summary-article-mark returned a symbol.
434 (dolist (mark spam-ham-marks)
435 (push (symbol-value mark) ham-mark-values))
437 (dolist (mark spam-spam-marks)
438 (push (symbol-value mark) spam-mark-values))
441 (setq article (pop articles)
442 mark (gnus-summary-article-mark article))
443 (cond ((memq mark spam-mark-values) (push article spam-articles))
444 ((memq article gnus-newsgroup-saved))
445 ((memq mark ham-mark-values) (push article ham-articles))))
446 (when (and ham-articles ham-func)
447 (mapc ham-func ham-articles)) ; we use mapc because unlike
448 ; mapcar it discards the
450 (when (and spam-articles spam-func)
451 (mapc spam-func spam-articles)))) ; we use mapc because unlike
452 ; mapcar it discards the
456 (defalias 'spam-point-at-eol (if (fboundp 'point-at-eol)
458 'line-end-position)))
460 (defun spam-get-article-as-string (article)
461 (let ((article-buffer (spam-get-article-as-buffer article))
464 (save-window-excursion
465 (set-buffer article-buffer)
466 (setq article-string (buffer-string))))
469 (defun spam-get-article-as-buffer (article)
470 (let ((article-buffer))
471 (when (numberp article)
472 (save-window-excursion
473 (gnus-summary-goto-subject article)
474 (gnus-summary-show-article t)
475 (setq article-buffer (get-buffer gnus-article-buffer))))
478 (defun spam-get-article-as-filename (article)
479 (let ((article-filename))
480 (when (numberp article)
481 (nnml-possibly-change-directory (gnus-group-real-name gnus-newsgroup-name))
482 (setq article-filename (expand-file-name (int-to-string article) nnml-current-directory)))
483 (if (file-exists-p article-filename)
487 (defun spam-fetch-field-from-fast (article)
488 "Fetch the `from' field quickly, using the internal gnus-data-list function"
489 (if (and (numberp article)
490 (assoc article (gnus-data-list nil)))
491 (mail-header-from (gnus-data-header (assoc article (gnus-data-list nil))))
494 (defun spam-fetch-field-subject-fast (article)
495 "Fetch the `subject' field quickly, using the internal gnus-data-list function"
496 (if (and (numberp article)
497 (assoc article (gnus-data-list nil)))
498 (mail-header-subject (gnus-data-header (assoc article (gnus-data-list nil))))
502 ;;;; Spam determination.
504 (defvar spam-list-of-checks
505 '((spam-use-blacklist . spam-check-blacklist)
506 (spam-use-regex-headers . spam-check-regex-headers)
507 (spam-use-whitelist . spam-check-whitelist)
508 (spam-use-BBDB . spam-check-BBDB)
509 (spam-use-ifile . spam-check-ifile)
510 (spam-use-stat . spam-check-stat)
511 (spam-use-blackholes . spam-check-blackholes)
512 (spam-use-bogofilter-headers . spam-check-bogofilter-headers)
513 (spam-use-bogofilter . spam-check-bogofilter))
514 "The spam-list-of-checks list contains pairs associating a parameter
515 variable with a spam checking function. If the parameter variable is
516 true, then the checking function is called, and its value decides what
517 happens. Each individual check may return nil, t, or a mailgroup
518 name. The value nil means that the check does not yield a decision,
519 and so, that further checks are needed. The value t means that the
520 message is definitely not spam, and that further spam checks should be
521 inhibited. Otherwise, a mailgroup name is returned where the mail
522 should go, and further checks are also inhibited. The usual mailgroup
523 name is the value of `spam-split-group', meaning that the message is
527 "Split this message into the `spam' group if it is spam.
528 This function can be used as an entry in `nnmail-split-fancy', for
529 example like this: (: spam-split)
531 See the Info node `(gnus)Fancy Mail Splitting' for more details."
534 ;; load the spam-stat tables if needed
535 (when spam-use-stat (spam-stat-load))
537 (let ((list-of-checks spam-list-of-checks)
539 (while (and list-of-checks (not decision))
540 (let ((pair (pop list-of-checks)))
541 (when (symbol-value (car pair))
542 (gnus-message 5 "spam-split: calling the %s function" (symbol-name (cdr pair)))
543 (setq decision (funcall (cdr pair))))))
550 (defun spam-check-regex-headers ()
552 (dolist (h-regex spam-regex-headers-ham)
554 (goto-char (point-min))
555 (when (re-search-forward h-regex nil t)
556 (message "Ham regex header search positive.")
558 (dolist (s-regex spam-regex-headers-spam)
560 (goto-char (point-min))
561 (when (re-search-forward s-regex nil t)
562 (message "Spam regex header search positive." (match-string 1))
564 (setq ret spam-split-group))))
570 (defun spam-check-blackholes ()
571 "Check the Received headers for blackholed relays."
572 (let ((headers (message-fetch-field "received"))
577 (goto-char (point-min))
578 (gnus-message 5 "Checking headers for relay addresses")
579 (while (re-search-forward
580 "\\[\\([0-9]+.[0-9]+.[0-9]+.[0-9]+\\)\\]" nil t)
581 (gnus-message 9 "Blackhole search found host IP %s." (match-string 1))
582 (push (mapconcat 'identity
583 (nreverse (split-string (match-string 1) "\\."))
586 (dolist (server spam-blackhole-servers)
588 (unless (and spam-blackhole-good-server-regex
589 (string-match spam-blackhole-good-server-regex ip))
590 (let ((query-string (concat ip "." server)))
592 (let ((query-result (query-dig query-string)))
594 (gnus-message 5 "(DIG): positive blackhole check '%s'" query-result)
595 (push (list ip server query-result)
597 ;; else, if not using dig.el
598 (when (query-dns query-string)
599 (gnus-message 5 "positive blackhole check")
600 (push (list ip server (query-dns query-string 'TXT))
607 ;;; original idea for spam-check-BBDB from Alexander Kotelnikov
608 ;;; <sacha@giotto.sj.ru>
610 ;; all this is done inside a condition-case to trap errors
617 (defun spam-enter-ham-BBDB (from)
618 "Enter an address into the BBDB; implies ham (non-spam) sender"
620 (let* ((parsed-address (gnus-extract-address-components from))
621 (name (or (car parsed-address) "Ham Sender"))
622 (net-address (car (cdr parsed-address))))
623 (gnus-message 5 "Adding address %s to BBDB" from)
624 (when (and net-address
625 (not (bbdb-search-simple nil net-address)))
626 (bbdb-create-internal name nil net-address nil nil
627 "ham sender added by spam.el")))))
629 (defun spam-BBDB-register-routine ()
630 (spam-generic-register-routine
635 (spam-enter-ham-BBDB (spam-fetch-field-from-fast article)))))
637 (defun spam-check-BBDB ()
638 "Mail from people in the BBDB is never considered spam"
639 (let ((who (message-fetch-field "from")))
641 (setq who (regexp-quote (cadr
642 (gnus-extract-address-components who))))
643 (if (bbdb-search-simple nil who)
644 nil spam-split-group)))))
647 (defalias 'bbdb-search-simple 'ignore)
648 (defalias 'spam-check-BBDB 'ignore)
649 (defalias 'spam-BBDB-register-routine 'ignore)
650 (defalias 'spam-enter-ham-BBDB 'ignore)
651 (defalias 'bbdb-create-internal 'ignore)
652 (defalias 'bbdb-records 'ignore))))
657 ;;; check the ifile backend; return nil if the mail was NOT classified
660 (defun spam-get-ifile-database-parameter ()
661 "Get the command-line parameter for ifile's database from spam-ifile-database-path."
662 (if spam-ifile-database-path
663 (format "--db-file=%s" spam-ifile-database-path)
666 (defun spam-check-ifile ()
667 "Check the ifile backend for the classification of this message"
668 (let ((article-buffer-name (buffer-name))
671 (let ((temp-buffer-name (buffer-name))
672 (db-param (spam-get-ifile-database-parameter)))
674 (set-buffer article-buffer-name)
676 (call-process-region (point-min) (point-max) spam-ifile-path
677 nil temp-buffer-name nil "-q" "-c" db-param)
678 (call-process-region (point-min) (point-max) spam-ifile-path
679 nil temp-buffer-name nil "-q" "-c")))
680 (goto-char (point-min))
682 (setq category (buffer-substring (point) (spam-point-at-eol))))
683 (when (not (zerop (length category))) ; we need a category here
684 (if spam-ifile-all-categories
685 (setq return category)
686 ;; else, if spam-ifile-all-categories is not set...
687 (when (string-equal spam-ifile-spam-category category)
688 (setq return spam-split-group))))))
691 (defun spam-ifile-register-with-ifile (article-string category)
692 "Register an article, given as a string, with a category.
693 Uses `gnus-newsgroup-name' if category is nil (for ham registration)."
694 (when (stringp article-string)
695 (let ((category (or category gnus-newsgroup-name))
696 (db-param (spam-get-ifile-database-parameter)))
698 (insert-string article-string)
700 (call-process-region (point-min) (point-max) spam-ifile-path
702 "-h" "-i" category db-param)
703 (call-process-region (point-min) (point-max) spam-ifile-path
705 "-h" "-i" category))))))
707 (defun spam-ifile-register-spam-routine ()
708 (spam-generic-register-routine
710 (spam-ifile-register-with-ifile
711 (spam-get-article-as-string article) spam-ifile-spam-category))
714 (defun spam-ifile-register-ham-routine ()
715 (spam-generic-register-routine
718 (spam-ifile-register-with-ifile
719 (spam-get-article-as-string article) spam-ifile-ham-category))))
726 (let ((spam-stat-install-hooks nil))
727 (require 'spam-stat))
729 (defun spam-check-stat ()
730 "Check the spam-stat backend for the classification of this message"
731 (let ((spam-stat-split-fancy-spam-group spam-split-group) ; override
732 (spam-stat-buffer (buffer-name)) ; stat the current buffer
734 (spam-stat-split-fancy)))
736 (defun spam-stat-register-spam-routine ()
737 (spam-generic-register-routine
739 (let ((article-string (spam-get-article-as-string article)))
741 (insert-string article-string)
742 (spam-stat-buffer-is-spam))))
746 (defun spam-stat-register-ham-routine ()
747 (spam-generic-register-routine
750 (let ((article-string (spam-get-article-as-string article)))
752 (insert-string article-string)
753 (spam-stat-buffer-is-non-spam)))))
757 (defalias 'spam-stat-register-ham-routine 'ignore)
758 (defalias 'spam-stat-register-spam-routine 'ignore)
759 (defalias 'spam-stat-buffer-is-spam 'ignore)
760 (defalias 'spam-stat-buffer-is-non-spam 'ignore)
761 (defalias 'spam-stat-split-fancy 'ignore)
762 (defalias 'spam-stat-load 'ignore)
763 (defalias 'spam-stat-save 'ignore)
764 (defalias 'spam-check-stat 'ignore))))
768 ;;;; Blacklists and whitelists.
770 (defvar spam-whitelist-cache nil)
771 (defvar spam-blacklist-cache nil)
773 (defun spam-enter-whitelist (address)
774 "Enter ADDRESS into the whitelist."
775 (interactive "sAddress: ")
776 (spam-enter-list address spam-whitelist)
777 (setq spam-whitelist-cache nil))
779 (defun spam-enter-blacklist (address)
780 "Enter ADDRESS into the blacklist."
781 (interactive "sAddress: ")
782 (spam-enter-list address spam-blacklist)
783 (setq spam-blacklist-cache nil))
785 (defun spam-enter-list (address file)
786 "Enter ADDRESS into the given FILE, either the whitelist or the blacklist."
787 (unless (file-exists-p (file-name-directory file))
788 (make-directory (file-name-directory file) t))
791 (find-file-noselect file))
792 (goto-char (point-max))
795 (insert address "\n")
798 ;;; returns nil if the sender is in the whitelist, spam-split-group otherwise
799 (defun spam-check-whitelist ()
800 ;; FIXME! Should it detect when file timestamps change?
801 (unless spam-whitelist-cache
802 (setq spam-whitelist-cache (spam-parse-list spam-whitelist)))
803 (if (spam-from-listed-p spam-whitelist-cache) nil spam-split-group))
805 (defun spam-check-blacklist ()
806 ;; FIXME! Should it detect when file timestamps change?
807 (unless spam-blacklist-cache
808 (setq spam-blacklist-cache (spam-parse-list spam-blacklist)))
809 (and (spam-from-listed-p spam-blacklist-cache) spam-split-group))
811 (defun spam-parse-list (file)
812 (when (file-readable-p file)
813 (let (contents address)
815 (insert-file-contents file)
817 (setq address (buffer-substring (point) (spam-point-at-eol)))
819 (unless (zerop (length address))
820 (setq address (regexp-quote address))
821 (while (string-match "\\\\\\*" address)
822 (setq address (replace-match ".*" t t address)))
823 (push address contents))))
824 (nreverse contents))))
826 (defun spam-from-listed-p (cache)
827 (let ((from (message-fetch-field "from"))
830 (when (string-match (pop cache) from)
835 (defun spam-blacklist-register-routine ()
836 (spam-generic-register-routine
839 (let ((from (spam-fetch-field-from-fast article)))
841 (spam-enter-blacklist from))))
845 (defun spam-whitelist-register-routine ()
846 (spam-generic-register-routine
851 (let ((from (spam-fetch-field-from-fast article)))
853 (spam-enter-whitelist from))))))
858 (defun spam-check-bogofilter-headers (&optional score)
859 (let ((header (message-fetch-field spam-bogofilter-header)))
861 (string-match spam-bogofilter-bogosity-positive-spam-header
864 (when (string-match "spamicity=\\([0-9.]+\\)" header)
865 (match-string 1 header))
868 ;; return something sensible if the score can't be determined
869 (defun spam-bogofilter-score ()
870 "Get the Bogofilter spamicity score"
872 (save-window-excursion
873 (gnus-summary-show-article t)
874 (set-buffer gnus-article-buffer)
875 (let ((score (spam-check-bogofilter t)))
876 (message "Spamicity score %s" score)
879 (defun spam-check-bogofilter (&optional score)
880 "Check the Bogofilter backend for the classification of this message"
881 (let ((article-buffer-name (buffer-name))
884 (let ((temp-buffer-name (buffer-name)))
886 (set-buffer article-buffer-name)
887 (if spam-bogofilter-database-directory
888 (call-process-region (point-min) (point-max)
890 nil temp-buffer-name nil "-v"
891 "-d" spam-bogofilter-database-directory)
892 (call-process-region (point-min) (point-max) spam-bogofilter-path
893 nil temp-buffer-name nil "-v")))
894 (setq return (spam-check-bogofilter-headers score))))
897 (defun spam-bogofilter-register-with-bogofilter (article-string spam)
898 "Register an article, given as a string, as spam or non-spam."
899 (when (stringp article-string)
900 (let ((switch (if spam "-s" "-n")))
902 (insert-string article-string)
903 (if spam-bogofilter-database-directory
904 (call-process-region (point-min) (point-max)
906 nil nil nil "-v" switch
907 "-d" spam-bogofilter-database-directory)
908 (call-process-region (point-min) (point-max) spam-bogofilter-path
909 nil nil nil "-v" switch))))))
911 (defun spam-bogofilter-register-spam-routine ()
912 (spam-generic-register-routine
914 (spam-bogofilter-register-with-bogofilter
915 (spam-get-article-as-string article) t))
918 (defun spam-bogofilter-register-ham-routine ()
919 (spam-generic-register-routine
922 (spam-bogofilter-register-with-bogofilter
923 (spam-get-article-as-string article) nil))))
927 ;;; spam.el ends here.