cgit.sxemacs.org Git - gnus/blob - lisp/spam.el

   1 ;;; spam.el --- Identifying spam
   2 ;; Copyright (C) 2002, 2003 Free Software Foundation, Inc.
   3
   4 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
   5 ;; Keywords: network
   6
   7 ;; This file is part of GNU Emacs.
   8
   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)
  12 ;; any later version.
  13
  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.
  18
  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.
  23
  24 ;;; Commentary:
  25
  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.
  29
  30 ;;; The integration with Gnus is not yet complete.  See various `FIXME'
  31 ;;; comments, below, for supplementary explanations or discussions.
  32
  33 ;;; Several TODO items are marked as such
  34
  35 ;;; Code:
  36
  37 (require 'gnus-sum)
  38
  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
  42
  43 ;; autoload executable-find
  44 (eval-and-compile
  45   ;; executable-find is not autoloaded in Emacs 20
  46   (autoload 'executable-find "executable"))
  47
  48 ;; autoload query-dig
  49 (eval-and-compile
  50   (autoload 'query-dig "dig"))
  51
  52 ;; autoload query-dns
  53 (eval-and-compile
  54   (autoload 'query-dns "dns"))
  55
  56 ;;; Main parameters.
  57
  58 (defgroup spam nil
  59   "Spam configuration.")
  60
  61 (defcustom spam-directory "~/News/spam/"
  62   "Directory for spam whitelists and blacklists."
  63   :type 'directory
  64   :group 'spam)
  65
  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
  70 spam groups."
  71   :type 'boolean
  72   :group 'spam-ifile)
  73
  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."
  78   :type 'file
  79   :group 'spam)
  80
  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."
  85   :type 'file
  86   :group 'spam)
  87
  88 (defcustom spam-use-dig t
  89   "Whether query-dig should be used instead of query-dns."
  90   :type 'boolean
  91   :group 'spam)
  92
  93 (defcustom spam-use-blacklist nil
  94   "Whether the blacklist should be used by spam-split."
  95   :type 'boolean
  96   :group 'spam)
  97
  98 (defcustom spam-use-whitelist nil
  99   "Whether the whitelist should be used by spam-split."
 100   :type 'boolean
 101   :group 'spam)
 102
 103 (defcustom spam-use-whitelist-exclusive nil
 104   "Whether whitelist-exclusive should be used by spam-split.
 105 Exclusive whitelisting means that all messages from senders not in the whitelist
 106 are considered spam."
 107   :type 'boolean
 108   :group 'spam)
 109
 110 (defcustom spam-use-blackholes nil
 111   "Whether blackholes should be used by spam-split."
 112   :type 'boolean
 113   :group 'spam)
 114
 115 (defcustom spam-use-regex-headers nil
 116   "Whether a header regular expression match should be used by spam-split.
 117 Also see the variable `spam-spam-regex-headers' and `spam-ham-regex-headers'."
 118   :type 'boolean
 119   :group 'spam)
 120
 121 (defcustom spam-use-bogofilter-headers nil
 122   "Whether bogofilter headers should be used by spam-split.
 123 Enable this if you pre-process messages with Bogofilter BEFORE Gnus sees them."
 124   :type 'boolean
 125   :group 'spam)
 126
 127 (defcustom spam-use-bogofilter nil
 128   "Whether bogofilter should be invoked by spam-split.
 129 Enable this if you want Gnus to invoke Bogofilter on new messages."
 130   :type 'boolean
 131   :group 'spam)
 132
 133 (defcustom spam-use-BBDB nil
 134   "Whether BBDB should be used by spam-split."
 135   :type 'boolean
 136   :group 'spam)
 137
 138 (defcustom spam-use-BBDB-exclusive nil
 139   "Whether BBDB-exclusive should be used by spam-split.
 140 Exclusive BBDB means that all messages from senders not in the BBDB are
 141 considered spam."
 142   :type 'boolean
 143   :group 'spam)
 144
 145 (defcustom spam-use-ifile nil
 146   "Whether ifile should be used by spam-split."
 147   :type 'boolean
 148   :group 'spam)
 149
 150 (defcustom spam-use-stat nil
 151   "Whether spam-stat should be used by spam-split."
 152   :type 'boolean
 153   :group 'spam)
 154
 155 (defcustom spam-split-group "spam"
 156   "Group name where incoming spam should be put by spam-split."
 157   :type 'string
 158   :group 'spam)
 159
 160 (defcustom spam-junk-mailgroups (cons spam-split-group '("mail.junk" "poste.pourriel"))
 161   "Mailgroups with spam contents.
 162 All unmarked article in such group receive the spam mark on group entry."
 163   :type '(repeat (string :tag "Group"))
 164   :group 'spam)
 165
 166 (defcustom spam-blackhole-servers '("bl.spamcop.net" "relays.ordb.org"
 167                                     "dev.null.dk" "relays.visi.com")
 168   "List of blackhole servers."
 169   :type '(repeat (string :tag "Server"))
 170   :group 'spam)
 171
 172 (defcustom spam-blackhole-good-server-regex nil
 173   "String matching IP addresses that should not be checked in the blackholes"
 174   :type 'regexp
 175   :group 'spam)
 176
 177 (defcustom spam-ham-marks (list 'gnus-del-mark 'gnus-read-mark
 178                                 'gnus-killed-mark 'gnus-kill-file-mark
 179                                 'gnus-low-score-mark)
 180   "Marks considered as being ham (positively not spam).
 181 Such articles will be processed as ham (non-spam) on group exit."
 182   :type '(set
 183           (variable-item gnus-del-mark)
 184           (variable-item gnus-read-mark)
 185           (variable-item gnus-killed-mark)
 186           (variable-item gnus-kill-file-mark)
 187           (variable-item gnus-low-score-mark))
 188   :group 'spam)
 189
 190 (defcustom spam-spam-marks (list 'gnus-spam-mark)
 191   "Marks considered as being spam (positively spam).
 192 Such articles will be transmitted to `bogofilter -s' on group exit."
 193   :type '(set
 194           (variable-item gnus-spam-mark)
 195           (variable-item gnus-killed-mark)
 196           (variable-item gnus-kill-file-mark)
 197           (variable-item gnus-low-score-mark))
 198   :group 'spam)
 199
 200 (defcustom spam-face 'gnus-splash-face
 201   "Face for spam-marked articles"
 202   :type 'face
 203   :group 'spam)
 204
 205 (defcustom spam-regex-headers-spam '("^X-Spam-Flag: YES")
 206   "Regular expression for positive header spam matches"
 207   :type '(repeat (regexp :tag "Regular expression to match spam header"))
 208   :group 'spam)
 209
 210 (defcustom spam-regex-headers-ham '("^X-Spam-Flag: NO")
 211   "Regular expression for positive header ham matches"
 212   :type '(repeat (regexp :tag "Regular expression to match ham header"))
 213   :group 'spam)
 214
 215 (defgroup spam-ifile nil
 216   "Spam ifile configuration."
 217   :group 'spam)
 218
 219 (defcustom spam-ifile-path (executable-find "ifile")
 220   "File path of the ifile executable program."
 221   :type '(choice (file :tag "Location of ifile")
 222                  (const :tag "ifile is not installed"))
 223   :group 'spam-ifile)
 224
 225 (defcustom spam-ifile-database-path nil
 226   "File path of the ifile database."
 227   :type '(choice (file :tag "Location of the ifile database")
 228                  (const :tag "Use the default"))
 229   :group 'spam-ifile)
 230
 231 (defcustom spam-ifile-spam-category "spam"
 232   "Name of the spam ifile category."
 233   :type 'string
 234   :group 'spam-ifile)
 235
 236 (defcustom spam-ifile-ham-category nil
 237   "Name of the ham ifile category.  If nil, the current group name will
 238 be used."
 239   :type '(choice (string :tag "Use a fixed category")
 240                 (const :tag "Use the current group name"))
 241   :group 'spam-ifile)
 242
 243 (defcustom spam-ifile-all-categories nil
 244   "Whether the ifile check will return all categories, or just spam.
 245 Set this to t if you want to use the spam-split invocation of ifile as
 246 your main source of newsgroup names."
 247   :type 'boolean
 248   :group 'spam-ifile)
 249
 250 (defgroup spam-bogofilter nil
 251   "Spam bogofilter configuration."
 252   :group 'spam)
 253
 254 (defcustom spam-bogofilter-path (executable-find "bogofilter")
 255   "File path of the Bogofilter executable program."
 256   :type '(choice (file :tag "Location of bogofilter")
 257                  (const :tag "Bogofilter is not installed"))
 258   :group 'spam-bogofilter)
 259
 260 (defcustom spam-bogofilter-header "X-Bogosity"
 261   "The header that Bogofilter inserts in messages."
 262   :type 'string
 263   :group 'spam-bogofilter)
 264
 265 (defcustom spam-bogofilter-bogosity-positive-spam-header "^\\(Yes\\|Spam\\)"
 266   "The regex on `spam-bogofilter-header' for positive spam identification."
 267   :type 'regexp
 268   :group 'spam-bogofilter)
 269
 270 (defcustom spam-bogofilter-database-directory nil
 271   "Directory path of the Bogofilter databases."
 272   :type '(choice (directory :tag "Location of the Bogofilter database directory")
 273                  (const :tag "Use the default"))
 274   :group 'spam-ifile)
 275
 276 ;;; Key bindings for spam control.
 277
 278 (gnus-define-keys gnus-summary-mode-map
 279   "St" spam-bogofilter-score
 280   "Sx" gnus-summary-mark-as-spam
 281   "Mst" spam-bogofilter-score
 282   "Msx" gnus-summary-mark-as-spam
 283   "\M-d" gnus-summary-mark-as-spam)
 284
 285 ;;; How to highlight a spam summary line.
 286
 287 ;; TODO: How do we redo this every time spam-face is customized?
 288
 289 (push '((eq mark gnus-spam-mark) . spam-face)
 290       gnus-summary-highlight)
 291
 292 ;; convenience functions
 293 (defun spam-group-spam-contents-p (group)
 294   (if (stringp group)
 295       (or (member group spam-junk-mailgroups)
 296           (memq 'gnus-group-spam-classification-spam
 297                 (gnus-parameter-spam-contents group)))
 298     nil))
 299
 300 (defun spam-group-ham-contents-p (group)
 301   (if (stringp group)
 302       (memq 'gnus-group-spam-classification-ham
 303             (gnus-parameter-spam-contents group))
 304     nil))
 305
 306 (defun spam-group-processor-p (group processor)
 307   (if (and (stringp group)
 308            (symbolp processor))
 309       (member processor (car (gnus-parameter-spam-process group)))
 310     nil))
 311
 312 (defun spam-group-spam-processor-bogofilter-p (group)
 313   (spam-group-processor-p group 'gnus-group-spam-exit-processor-bogofilter))
 314
 315 (defun spam-group-spam-processor-blacklist-p (group)
 316   (spam-group-processor-p group 'gnus-group-spam-exit-processor-blacklist))
 317
 318 (defun spam-group-spam-processor-ifile-p (group)
 319   (spam-group-processor-p group 'gnus-group-spam-exit-processor-ifile))
 320
 321 (defun spam-group-ham-processor-ifile-p (group)
 322   (spam-group-processor-p group 'gnus-group-ham-exit-processor-ifile))
 323
 324 (defun spam-group-ham-processor-bogofilter-p (group)
 325   (spam-group-processor-p group 'gnus-group-ham-exit-processor-bogofilter))
 326
 327 (defun spam-group-spam-processor-stat-p (group)
 328   (spam-group-processor-p group 'gnus-group-spam-exit-processor-stat))
 329
 330 (defun spam-group-ham-processor-stat-p (group)
 331   (spam-group-processor-p group 'gnus-group-ham-exit-processor-stat))
 332
 333 (defun spam-group-ham-processor-whitelist-p (group)
 334   (spam-group-processor-p group 'gnus-group-ham-exit-processor-whitelist))
 335
 336 (defun spam-group-ham-processor-BBDB-p (group)
 337   (spam-group-processor-p group 'gnus-group-ham-exit-processor-BBDB))
 338
 339 ;;; Summary entry and exit processing.
 340
 341 (defun spam-summary-prepare ()
 342   (spam-mark-junk-as-spam-routine))
 343
 344 (add-hook 'gnus-summary-prepare-hook 'spam-summary-prepare)
 345
 346 (defun spam-summary-prepare-exit ()
 347   ;; The spam processors are invoked for any group, spam or ham or neither
 348   (gnus-message 6 "Exiting summary buffer and applying spam rules")
 349   (when (and spam-bogofilter-path
 350              (spam-group-spam-processor-bogofilter-p gnus-newsgroup-name))
 351     (gnus-message 5 "Registering spam with bogofilter")
 352     (spam-bogofilter-register-spam-routine))
 353
 354   (when (and spam-ifile-path
 355              (spam-group-spam-processor-ifile-p gnus-newsgroup-name))
 356     (gnus-message 5 "Registering spam with ifile")
 357     (spam-ifile-register-spam-routine))
 358
 359   (when (spam-group-spam-processor-stat-p gnus-newsgroup-name)
 360     (gnus-message 5 "Registering spam with spam-stat")
 361     (spam-stat-register-spam-routine))
 362
 363   (when (spam-group-spam-processor-blacklist-p gnus-newsgroup-name)
 364     (gnus-message 5 "Registering spam with the blacklist")
 365     (spam-blacklist-register-routine))
 366
 367   (if spam-move-spam-nonspam-groups-only
 368       (when (not (spam-group-spam-contents-p gnus-newsgroup-name))
 369         (spam-mark-spam-as-expired-and-move-routine
 370          (gnus-parameter-spam-process-destination gnus-newsgroup-name)))
 371     (gnus-message 5 "Marking spam as expired and moving it")
 372     (spam-mark-spam-as-expired-and-move-routine
 373      (gnus-parameter-spam-process-destination gnus-newsgroup-name)))
 374
 375   ;; now we redo spam-mark-spam-as-expired-and-move-routine to only
 376   ;; expire spam, in case the above did not expire them
 377   (spam-mark-spam-as-expired-and-move-routine nil)
 378
 379   (when (spam-group-ham-contents-p gnus-newsgroup-name)
 380     (when (spam-group-ham-processor-whitelist-p gnus-newsgroup-name)
 381       (gnus-message 5 "Registering ham with the whitelist")
 382       (spam-whitelist-register-routine))
 383     (when (spam-group-ham-processor-ifile-p gnus-newsgroup-name)
 384       (gnus-message 5 "Registering ham with ifile")
 385       (spam-ifile-register-ham-routine))
 386     (when (spam-group-ham-processor-bogofilter-p gnus-newsgroup-name)
 387       (gnus-message 5 "Registering ham with Bogofilter")
 388       (spam-bogofilter-register-ham-routine))
 389     (when (spam-group-ham-processor-stat-p gnus-newsgroup-name)
 390       (gnus-message 5 "Registering ham with spam-stat")
 391       (spam-stat-register-ham-routine))
 392     (when (spam-group-ham-processor-BBDB-p gnus-newsgroup-name)
 393       (gnus-message 5 "Registering ham with the BBDB")
 394       (spam-BBDB-register-routine)))
 395
 396   ;; now move all ham articles out of spam groups
 397   (when (spam-group-spam-contents-p gnus-newsgroup-name)
 398     (gnus-message 5 "Moving ham messages from spam group")
 399     (spam-ham-move-routine
 400      (gnus-parameter-ham-process-destination gnus-newsgroup-name))))
 401
 402 (add-hook 'gnus-summary-prepare-exit-hook 'spam-summary-prepare-exit)
 403
 404 (defun spam-mark-junk-as-spam-routine ()
 405   ;; check the global list of group names spam-junk-mailgroups and the
 406   ;; group parameters
 407   (when (spam-group-spam-contents-p gnus-newsgroup-name)
 408     (gnus-message 5 "Marking unread articles as spam")
 409     (let ((articles gnus-newsgroup-articles)
 410           article)
 411       (while articles
 412         (setq article (pop articles))
 413         (when (eq (gnus-summary-article-mark article) gnus-unread-mark)
 414           (gnus-summary-mark-article article gnus-spam-mark))))))
 415
 416 (defun spam-mark-spam-as-expired-and-move-routine (&optional group)
 417   (let ((articles gnus-newsgroup-articles)
 418         article tomove)
 419     (dolist (article articles)
 420       (gnus-summary-remove-process-mark article)
 421       (when (eq (gnus-summary-article-mark article) gnus-spam-mark)
 422         (gnus-summary-mark-article article gnus-expirable-mark)
 423         (push article tomove)))
 424
 425     ;; now do the actual move
 426     (when (stringp group)
 427       (dolist (article tomove)
 428         (gnus-summary-set-process-mark article))
 429       (gnus-summary-move-article nil group))))
 430
 431 (defun spam-ham-move-routine (&optional group)
 432   (let ((articles gnus-newsgroup-articles)
 433         article ham-mark-values mark tomove)
 434     (when (stringp group)               ; this routine will do nothing
 435                                         ; without a valid group
 436       (dolist (mark spam-ham-marks)
 437         (push (symbol-value mark) ham-mark-values))
 438       (dolist (article articles)
 439         (gnus-summary-remove-process-mark article)
 440         (when (memq (gnus-summary-article-mark article) ham-mark-values)
 441           (push article tomove)))
 442
 443       ;; now do the actual move
 444       (dolist (article tomove)
 445         (gnus-summary-set-process-mark article))
 446       (gnus-summary-move-article nil group))))
 447
 448 (defun spam-generic-register-routine (spam-func ham-func)
 449   (let ((articles gnus-newsgroup-articles)
 450         article mark ham-articles spam-articles spam-mark-values
 451         ham-mark-values)
 452
 453     ;; marks are stored as symbolic values, so we have to dereference
 454     ;; them for memq to work.  we wouldn't have to do this if
 455     ;; gnus-summary-article-mark returned a symbol.
 456     (dolist (mark spam-ham-marks)
 457       (push (symbol-value mark) ham-mark-values))
 458
 459     (dolist (mark spam-spam-marks)
 460       (push (symbol-value mark) spam-mark-values))
 461
 462     (while articles
 463       (setq article (pop articles)
 464             mark (gnus-summary-article-mark article))
 465       (cond ((memq mark spam-mark-values) (push article spam-articles))
 466             ((memq article gnus-newsgroup-saved))
 467             ((memq mark ham-mark-values) (push article ham-articles))))
 468     (when (and ham-articles ham-func)
 469       (mapc ham-func ham-articles))     ; we use mapc because unlike
 470                                         ; mapcar it discards the
 471                                         ; return values
 472     (when (and spam-articles spam-func)
 473       (mapc spam-func spam-articles)))) ; we use mapc because unlike
 474                                         ; mapcar it discards the
 475                                         ; return values
 476
 477 (eval-and-compile
 478   (defalias 'spam-point-at-eol (if (fboundp 'point-at-eol)
 479                                    'point-at-eol
 480                                  'line-end-position)))
 481
 482 (defun spam-get-article-as-string (article)
 483   (let ((article-buffer (spam-get-article-as-buffer article))
 484                         article-string)
 485     (when article-buffer
 486       (save-window-excursion
 487         (set-buffer article-buffer)
 488         (setq article-string (buffer-string))))
 489   article-string))
 490
 491 (defun spam-get-article-as-buffer (article)
 492   (let ((article-buffer))
 493     (when (numberp article)
 494       (save-window-excursion
 495         (gnus-summary-goto-subject article)
 496         (gnus-summary-show-article t)
 497         (setq article-buffer (get-buffer gnus-article-buffer))))
 498     article-buffer))
 499
 500 (defun spam-get-article-as-filename (article)
 501   (let ((article-filename))
 502     (when (numberp article)
 503       (nnml-possibly-change-directory (gnus-group-real-name gnus-newsgroup-name))
 504       (setq article-filename (expand-file-name (int-to-string article) nnml-current-directory)))
 505     (if (file-exists-p article-filename)
 506         article-filename
 507       nil)))
 508
 509 (defun spam-fetch-field-from-fast (article)
 510   "Fetch the `from' field quickly, using the internal gnus-data-list function"
 511   (if (and (numberp article)
 512            (assoc article (gnus-data-list nil)))
 513       (mail-header-from (gnus-data-header (assoc article (gnus-data-list nil))))
 514     nil))
 515
 516 (defun spam-fetch-field-subject-fast (article)
 517   "Fetch the `subject' field quickly, using the internal gnus-data-list function"
 518   (if (and (numberp article)
 519            (assoc article (gnus-data-list nil)))
 520       (mail-header-subject (gnus-data-header (assoc article (gnus-data-list nil))))
 521     nil))
 522
 523 \f
 524 ;;;; Spam determination.
 525
 526 (defvar spam-list-of-checks
 527   '((spam-use-blacklist                 .       spam-check-blacklist)
 528     (spam-use-regex-headers             .       spam-check-regex-headers)
 529     (spam-use-whitelist                 .       spam-check-whitelist)
 530     (spam-use-BBDB                      .       spam-check-BBDB)
 531     (spam-use-ifile                     .       spam-check-ifile)
 532     (spam-use-stat                      .       spam-check-stat)
 533     (spam-use-blackholes                .       spam-check-blackholes)
 534     (spam-use-bogofilter-headers        .       spam-check-bogofilter-headers)
 535     (spam-use-bogofilter                .       spam-check-bogofilter))
 536 "The spam-list-of-checks list contains pairs associating a parameter
 537 variable with a spam checking function.  If the parameter variable is
 538 true, then the checking function is called, and its value decides what
 539 happens.  Each individual check may return nil, t, or a mailgroup
 540 name.  The value nil means that the check does not yield a decision,
 541 and so, that further checks are needed.  The value t means that the
 542 message is definitely not spam, and that further spam checks should be
 543 inhibited.  Otherwise, a mailgroup name is returned where the mail
 544 should go, and further checks are also inhibited.  The usual mailgroup
 545 name is the value of `spam-split-group', meaning that the message is
 546 definitely a spam.")
 547
 548 (defun spam-split ()
 549   "Split this message into the `spam' group if it is spam.
 550 This function can be used as an entry in `nnmail-split-fancy', for
 551 example like this: (: spam-split)
 552
 553 See the Info node `(gnus)Fancy Mail Splitting' for more details."
 554   (interactive)
 555
 556   ;; load the spam-stat tables if needed
 557   (when spam-use-stat (spam-stat-load))
 558
 559   (let ((list-of-checks spam-list-of-checks)
 560         decision)
 561     (while (and list-of-checks (not decision))
 562       (let ((pair (pop list-of-checks)))
 563         (when (symbol-value (car pair))
 564           (gnus-message 5 "spam-split: calling the %s function" (symbol-name (cdr pair)))
 565           (setq decision (funcall (cdr pair))))))
 566     (if (eq decision t)
 567         nil
 568       decision)))
 569 \f
 570 ;;;; Regex headers
 571
 572 (defun spam-check-regex-headers ()
 573   (let (ret found)
 574     (dolist (h-regex spam-regex-headers-ham)
 575       (unless found
 576         (goto-char (point-min))
 577         (when (re-search-forward h-regex nil t)
 578           (message "Ham regex header search positive.")
 579           (setq found t))))
 580     (dolist (s-regex spam-regex-headers-spam)
 581       (unless found
 582         (goto-char (point-min))
 583         (when (re-search-forward s-regex nil t)
 584           (message "Spam regex header search positive." (match-string 1))
 585           (setq found t)
 586           (setq ret spam-split-group))))
 587     ret))
 588
 589 \f
 590 ;;;; Blackholes.
 591
 592 (defun spam-check-blackholes ()
 593   "Check the Received headers for blackholed relays."
 594   (let ((headers (message-fetch-field "received"))
 595         ips matches)
 596     (when headers
 597       (with-temp-buffer
 598         (insert headers)
 599         (goto-char (point-min))
 600         (gnus-message 5 "Checking headers for relay addresses")
 601         (while (re-search-forward
 602                 "\\[\\([0-9]+.[0-9]+.[0-9]+.[0-9]+\\)\\]" nil t)
 603           (gnus-message 9 "Blackhole search found host IP %s." (match-string 1))
 604           (push (mapconcat 'identity
 605                            (nreverse (split-string (match-string 1) "\\."))
 606                            ".")
 607                 ips)))
 608       (dolist (server spam-blackhole-servers)
 609         (dolist (ip ips)
 610           (unless (and spam-blackhole-good-server-regex
 611                        (string-match spam-blackhole-good-server-regex ip))
 612             (let ((query-string (concat ip "." server)))
 613               (if spam-use-dig
 614                   (let ((query-result (query-dig query-string)))
 615                     (when query-result
 616                       (gnus-message 5 "(DIG): positive blackhole check '%s'" query-result)
 617                       (push (list ip server query-result)
 618                             matches)))
 619                 ;; else, if not using dig.el
 620                 (when (query-dns query-string)
 621                   (gnus-message 5 "positive blackhole check")
 622                   (push (list ip server (query-dns query-string 'TXT))
 623                         matches))))))))
 624     (when matches
 625       spam-split-group)))
 626 \f
 627 ;;;; BBDB
 628
 629 ;;; original idea for spam-check-BBDB from Alexander Kotelnikov
 630 ;;; <sacha@giotto.sj.ru>
 631
 632 ;; all this is done inside a condition-case to trap errors
 633
 634 (condition-case nil
 635     (progn
 636       (require 'bbdb)
 637       (require 'bbdb-com)
 638
 639   (defun spam-enter-ham-BBDB (from)
 640     "Enter an address into the BBDB; implies ham (non-spam) sender"
 641     (when (stringp from)
 642       (let* ((parsed-address (gnus-extract-address-components from))
 643              (name (or (car parsed-address) "Ham Sender"))
 644              (net-address (car (cdr parsed-address))))
 645         (gnus-message 5 "Adding address %s to BBDB" from)
 646         (when (and net-address
 647                    (not (bbdb-search-simple nil net-address)))
 648           (bbdb-create-internal name nil net-address nil nil
 649                                 "ham sender added by spam.el")))))
 650
 651   (defun spam-BBDB-register-routine ()
 652     (spam-generic-register-routine
 653      ;; spam function
 654      nil
 655      ;; ham function
 656      (lambda (article)
 657        (spam-enter-ham-BBDB (spam-fetch-field-from-fast article)))))
 658
 659   (defun spam-check-BBDB ()
 660     "Mail from people in the BBDB is classified as ham or non-spam"
 661     (let ((who (message-fetch-field "from")))
 662       (when who
 663         (setq who (cadr (gnus-extract-address-components who)))
 664         (if (bbdb-search-simple nil who)
 665             t
 666           (if spam-use-BBDB-exclusive
 667               spam-split-group
 668             nil))))))
 669
 670   (file-error (progn
 671                 (defalias 'bbdb-search-simple 'ignore)
 672                 (defalias 'spam-check-BBDB 'ignore)
 673                 (defalias 'spam-BBDB-register-routine 'ignore)
 674                 (defalias 'spam-enter-ham-BBDB 'ignore)
 675                 (defalias 'bbdb-create-internal 'ignore)
 676                 (defalias 'bbdb-records 'ignore))))
 677
 678 \f
 679 ;;;; ifile
 680
 681 ;;; check the ifile backend; return nil if the mail was NOT classified
 682 ;;; as spam
 683
 684 (defun spam-get-ifile-database-parameter ()
 685   "Get the command-line parameter for ifile's database from spam-ifile-database-path."
 686   (if spam-ifile-database-path
 687       (format "--db-file=%s" spam-ifile-database-path)
 688     nil))
 689
 690 (defun spam-check-ifile ()
 691   "Check the ifile backend for the classification of this message"
 692   (let ((article-buffer-name (buffer-name))
 693         category return)
 694     (with-temp-buffer
 695       (let ((temp-buffer-name (buffer-name))
 696             (db-param (spam-get-ifile-database-parameter)))
 697         (save-excursion
 698           (set-buffer article-buffer-name)
 699           (if db-param
 700               (call-process-region (point-min) (point-max) spam-ifile-path
 701                                    nil temp-buffer-name nil "-q" "-c" db-param)
 702             (call-process-region (point-min) (point-max) spam-ifile-path
 703                                  nil temp-buffer-name nil "-q" "-c")))
 704         (goto-char (point-min))
 705         (if (not (eobp))
 706             (setq category (buffer-substring (point) (spam-point-at-eol))))
 707         (when (not (zerop (length category))) ; we need a category here
 708           (if spam-ifile-all-categories
 709               (setq return category)
 710             ;; else, if spam-ifile-all-categories is not set...
 711             (when (string-equal spam-ifile-spam-category category)
 712               (setq return spam-split-group))))))
 713     return))
 714
 715 (defun spam-ifile-register-with-ifile (article-string category)
 716   "Register an article, given as a string, with a category.
 717 Uses `gnus-newsgroup-name' if category is nil (for ham registration)."
 718   (when (stringp article-string)
 719     (let ((category (or category gnus-newsgroup-name))
 720           (db-param (spam-get-ifile-database-parameter)))
 721       (with-temp-buffer
 722         (insert-string article-string)
 723         (if db-param
 724             (call-process-region (point-min) (point-max) spam-ifile-path
 725                                  nil nil nil
 726                                  "-h" "-i" category db-param)
 727           (call-process-region (point-min) (point-max) spam-ifile-path
 728                                nil nil nil
 729                                "-h" "-i" category))))))
 730
 731 (defun spam-ifile-register-spam-routine ()
 732   (spam-generic-register-routine
 733    (lambda (article)
 734      (spam-ifile-register-with-ifile
 735       (spam-get-article-as-string article) spam-ifile-spam-category))
 736    nil))
 737
 738 (defun spam-ifile-register-ham-routine ()
 739   (spam-generic-register-routine
 740    nil
 741    (lambda (article)
 742      (spam-ifile-register-with-ifile
 743       (spam-get-article-as-string article) spam-ifile-ham-category))))
 744
 745 \f
 746 ;;;; spam-stat
 747
 748 (condition-case nil
 749     (progn
 750       (let ((spam-stat-install-hooks nil))
 751         (require 'spam-stat))
 752
 753       (defun spam-check-stat ()
 754         "Check the spam-stat backend for the classification of this message"
 755         (let ((spam-stat-split-fancy-spam-group spam-split-group) ; override
 756               (spam-stat-buffer (buffer-name)) ; stat the current buffer
 757               category return)
 758           (spam-stat-split-fancy)))
 759
 760       (defun spam-stat-register-spam-routine ()
 761         (spam-generic-register-routine
 762          (lambda (article)
 763            (let ((article-string (spam-get-article-as-string article)))
 764              (with-temp-buffer
 765                (insert-string article-string)
 766                (spam-stat-buffer-is-spam))))
 767          nil)
 768         (spam-stat-save))
 769
 770       (defun spam-stat-register-ham-routine ()
 771         (spam-generic-register-routine
 772          nil
 773          (lambda (article)
 774            (let ((article-string (spam-get-article-as-string article)))
 775              (with-temp-buffer
 776                (insert-string article-string)
 777                (spam-stat-buffer-is-non-spam)))))
 778         (spam-stat-save)))
 779
 780   (file-error (progn
 781                 (defalias 'spam-stat-register-ham-routine 'ignore)
 782                 (defalias 'spam-stat-register-spam-routine 'ignore)
 783                 (defalias 'spam-stat-buffer-is-spam 'ignore)
 784                 (defalias 'spam-stat-buffer-is-non-spam 'ignore)
 785                 (defalias 'spam-stat-split-fancy 'ignore)
 786                 (defalias 'spam-stat-load 'ignore)
 787                 (defalias 'spam-stat-save 'ignore)
 788                 (defalias 'spam-check-stat 'ignore))))
 789
 790 \f
 791
 792 ;;;; Blacklists and whitelists.
 793
 794 (defvar spam-whitelist-cache nil)
 795 (defvar spam-blacklist-cache nil)
 796
 797 (defun spam-enter-whitelist (address)
 798   "Enter ADDRESS into the whitelist."
 799   (interactive "sAddress: ")
 800   (spam-enter-list address spam-whitelist)
 801   (setq spam-whitelist-cache nil))
 802
 803 (defun spam-enter-blacklist (address)
 804   "Enter ADDRESS into the blacklist."
 805   (interactive "sAddress: ")
 806   (spam-enter-list address spam-blacklist)
 807   (setq spam-blacklist-cache nil))
 808
 809 (defun spam-enter-list (address file)
 810   "Enter ADDRESS into the given FILE, either the whitelist or the blacklist."
 811   (unless (file-exists-p (file-name-directory file))
 812     (make-directory (file-name-directory file) t))
 813   (save-excursion
 814     (set-buffer
 815      (find-file-noselect file))
 816     (goto-char (point-max))
 817     (unless (bobp)
 818       (insert "\n"))
 819     (insert address "\n")
 820     (save-buffer)))
 821
 822 ;;; returns t if the sender is in the whitelist, nil or spam-split-group otherwise
 823 (defun spam-check-whitelist ()
 824   ;; FIXME!  Should it detect when file timestamps change?
 825   (unless spam-whitelist-cache
 826     (setq spam-whitelist-cache (spam-parse-list spam-whitelist)))
 827   (if (spam-from-listed-p spam-whitelist-cache)
 828       t
 829     (if spam-use-whitelist-exclusive
 830         spam-split-group
 831       nil)))
 832
 833 (defun spam-check-blacklist ()
 834   ;; FIXME!  Should it detect when file timestamps change?
 835   (unless spam-blacklist-cache
 836     (setq spam-blacklist-cache (spam-parse-list spam-blacklist)))
 837   (and (spam-from-listed-p spam-blacklist-cache) spam-split-group))
 838
 839 (defun spam-parse-list (file)
 840   (when (file-readable-p file)
 841     (let (contents address)
 842       (with-temp-buffer
 843         (insert-file-contents file)
 844         (while (not (eobp))
 845           (setq address (buffer-substring (point) (spam-point-at-eol)))
 846           (forward-line 1)
 847           (unless (zerop (length address))
 848             (setq address (regexp-quote address))
 849             (while (string-match "\\\\\\*" address)
 850               (setq address (replace-match ".*" t t address)))
 851             (push address contents))))
 852       (nreverse contents))))
 853
 854 (defun spam-from-listed-p (cache)
 855   (let ((from (message-fetch-field "from"))
 856         found)
 857     (while cache
 858       (when (string-match (pop cache) from)
 859         (setq found t
 860               cache nil)))
 861     found))
 862
 863 (defun spam-blacklist-register-routine ()
 864   (spam-generic-register-routine
 865    ;; the spam function
 866    (lambda (article)
 867      (let ((from (spam-fetch-field-from-fast article)))
 868        (when (stringp from)
 869            (spam-enter-blacklist from))))
 870    ;; the ham function
 871    nil))
 872
 873 (defun spam-whitelist-register-routine ()
 874   (spam-generic-register-routine
 875    ;; the spam function
 876    nil
 877    ;; the ham function
 878    (lambda (article)
 879      (let ((from (spam-fetch-field-from-fast article)))
 880        (when (stringp from)
 881            (spam-enter-whitelist from))))))
 882
 883 \f
 884 ;;;; Bogofilter
 885
 886 (defun spam-check-bogofilter-headers (&optional score)
 887   (let ((header (message-fetch-field spam-bogofilter-header)))
 888       (when (and header
 889                  (string-match spam-bogofilter-bogosity-positive-spam-header
 890                                header))
 891           (if score
 892               (when (string-match "spamicity=\\([0-9.]+\\)" header)
 893                 (match-string 1 header))
 894             spam-split-group))))
 895
 896 ;; return something sensible if the score can't be determined
 897 (defun spam-bogofilter-score ()
 898   "Get the Bogofilter spamicity score"
 899   (interactive)
 900   (save-window-excursion
 901     (gnus-summary-show-article t)
 902     (set-buffer gnus-article-buffer)
 903     (let ((score (spam-check-bogofilter t)))
 904       (message "Spamicity score %s" score)
 905       (or score "0"))))
 906
 907 (defun spam-check-bogofilter (&optional score)
 908   "Check the Bogofilter backend for the classification of this message"
 909   (let ((article-buffer-name (buffer-name))
 910         return)
 911     (with-temp-buffer
 912       (let ((temp-buffer-name (buffer-name)))
 913         (save-excursion
 914           (set-buffer article-buffer-name)
 915           (if spam-bogofilter-database-directory
 916               (call-process-region (point-min) (point-max)
 917                                    spam-bogofilter-path
 918                                    nil temp-buffer-name nil "-v"
 919                                    "-d" spam-bogofilter-database-directory)
 920             (call-process-region (point-min) (point-max) spam-bogofilter-path
 921                                  nil temp-buffer-name nil "-v")))
 922         (setq return (spam-check-bogofilter-headers score))))
 923     return))
 924
 925 (defun spam-bogofilter-register-with-bogofilter (article-string spam)
 926   "Register an article, given as a string, as spam or non-spam."
 927   (when (stringp article-string)
 928     (let ((switch (if spam "-s" "-n")))
 929       (with-temp-buffer
 930         (insert-string article-string)
 931         (if spam-bogofilter-database-directory
 932             (call-process-region (point-min) (point-max)
 933                                  spam-bogofilter-path
 934                                  nil nil nil "-v" switch
 935                                  "-d" spam-bogofilter-database-directory)
 936           (call-process-region (point-min) (point-max) spam-bogofilter-path
 937                                nil nil nil "-v" switch))))))
 938
 939 (defun spam-bogofilter-register-spam-routine ()
 940   (spam-generic-register-routine
 941    (lambda (article)
 942      (spam-bogofilter-register-with-bogofilter
 943       (spam-get-article-as-string article) t))
 944    nil))
 945
 946 (defun spam-bogofilter-register-ham-routine ()
 947   (spam-generic-register-routine
 948    nil
 949    (lambda (article)
 950      (spam-bogofilter-register-with-bogofilter
 951       (spam-get-article-as-string article) nil))))
 952
 953 (provide 'spam)
 954
 955 ;;; spam.el ends here.