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 (defun spam-group-ham-processor-copy-p (group)
 340   (spam-group-processor-p group 'gnus-group-ham-exit-processor-copy))
 341
 342 ;;; Summary entry and exit processing.
 343
 344 (defun spam-summary-prepare ()
 345   (spam-mark-junk-as-spam-routine))
 346
 347 (add-hook 'gnus-summary-prepare-hook 'spam-summary-prepare)
 348
 349 ;; The spam processors are invoked for any group, spam or ham or neither
 350 (defun spam-summary-prepare-exit ()
 351   (unless gnus-group-is-exiting-without-update-p
 352     (gnus-message 6 "Exiting summary buffer and applying spam rules")
 353     (when (and spam-bogofilter-path
 354                (spam-group-spam-processor-bogofilter-p gnus-newsgroup-name))
 355       (gnus-message 5 "Registering spam with bogofilter")
 356       (spam-bogofilter-register-spam-routine))
 357
 358     (when (and spam-ifile-path
 359                (spam-group-spam-processor-ifile-p gnus-newsgroup-name))
 360       (gnus-message 5 "Registering spam with ifile")
 361       (spam-ifile-register-spam-routine))
 362
 363     (when (spam-group-spam-processor-stat-p gnus-newsgroup-name)
 364       (gnus-message 5 "Registering spam with spam-stat")
 365       (spam-stat-register-spam-routine))
 366
 367     (when (spam-group-spam-processor-blacklist-p gnus-newsgroup-name)
 368       (gnus-message 5 "Registering spam with the blacklist")
 369       (spam-blacklist-register-routine))
 370
 371     (if spam-move-spam-nonspam-groups-only
 372         (when (not (spam-group-spam-contents-p gnus-newsgroup-name))
 373           (spam-mark-spam-as-expired-and-move-routine
 374            (gnus-parameter-spam-process-destination gnus-newsgroup-name)))
 375       (gnus-message 5 "Marking spam as expired and moving it to %s" gnus-newsgroup-name)
 376       (spam-mark-spam-as-expired-and-move-routine
 377        (gnus-parameter-spam-process-destination gnus-newsgroup-name)))
 378
 379     ;; now we redo spam-mark-spam-as-expired-and-move-routine to only
 380     ;; expire spam, in case the above did not expire them
 381     (gnus-message 5 "Marking spam as expired without moving it")
 382     (spam-mark-spam-as-expired-and-move-routine nil)
 383
 384     (when (spam-group-ham-contents-p gnus-newsgroup-name)
 385       (when (spam-group-ham-processor-whitelist-p gnus-newsgroup-name)
 386         (gnus-message 5 "Registering ham with the whitelist")
 387         (spam-whitelist-register-routine))
 388       (when (spam-group-ham-processor-ifile-p gnus-newsgroup-name)
 389         (gnus-message 5 "Registering ham with ifile")
 390         (spam-ifile-register-ham-routine))
 391       (when (spam-group-ham-processor-bogofilter-p gnus-newsgroup-name)
 392         (gnus-message 5 "Registering ham with Bogofilter")
 393         (spam-bogofilter-register-ham-routine))
 394       (when (spam-group-ham-processor-stat-p gnus-newsgroup-name)
 395         (gnus-message 5 "Registering ham with spam-stat")
 396         (spam-stat-register-ham-routine))
 397       (when (spam-group-ham-processor-BBDB-p gnus-newsgroup-name)
 398         (gnus-message 5 "Registering ham with the BBDB")
 399         (spam-BBDB-register-routine)))
 400
 401     (when (spam-group-ham-processor-copy-p gnus-newsgroup-name)
 402       (gnus-message 5 "Copying ham")
 403       (spam-ham-move-routine
 404        (gnus-parameter-ham-process-destination gnus-newsgroup-name) t))
 405
 406     ;; now move all ham articles out of spam groups
 407     (when (spam-group-spam-contents-p gnus-newsgroup-name)
 408       (gnus-message 5 "Moving ham messages from spam group")
 409       (spam-ham-move-routine
 410        (gnus-parameter-ham-process-destination gnus-newsgroup-name)))))
 411
 412 (add-hook 'gnus-summary-prepare-exit-hook 'spam-summary-prepare-exit)
 413
 414 (defun spam-mark-junk-as-spam-routine ()
 415   ;; check the global list of group names spam-junk-mailgroups and the
 416   ;; group parameters
 417   (when (spam-group-spam-contents-p gnus-newsgroup-name)
 418     (gnus-message 5 "Marking unread articles as spam")
 419     (let ((articles gnus-newsgroup-articles)
 420           article)
 421       (while articles
 422         (setq article (pop articles))
 423         (when (eq (gnus-summary-article-mark article) gnus-unread-mark)
 424           (gnus-summary-mark-article article gnus-spam-mark))))))
 425
 426 (defun spam-mark-spam-as-expired-and-move-routine (&optional group)
 427   (gnus-summary-kill-process-mark)
 428   (let ((articles gnus-newsgroup-articles)
 429         article tomove)
 430     (dolist (article articles)
 431       (when (eq (gnus-summary-article-mark article) gnus-spam-mark)
 432         (gnus-summary-mark-article article gnus-expirable-mark)
 433         (push article tomove)))
 434
 435     ;; now do the actual move
 436     (when (and tomove
 437                (stringp group))
 438       (dolist (article tomove)
 439         (gnus-summary-set-process-mark article))
 440       (when tomove (gnus-summary-move-article nil group))))
 441   (gnus-summary-yank-process-mark))
 442
 443 (defun spam-ham-move-routine (&optional group copy)
 444   (gnus-summary-kill-process-mark)
 445   (let ((articles gnus-newsgroup-articles)
 446         article ham-mark-values mark tomove)
 447     (when (stringp group)               ; this routine will do nothing
 448                                         ; without a valid group
 449       (dolist (mark spam-ham-marks)
 450         (push (symbol-value mark) ham-mark-values))
 451       (dolist (article articles)
 452         (when (memq (gnus-summary-article-mark article) ham-mark-values)
 453           (push article tomove)))
 454
 455       ;; now do the actual move
 456       (when tomove
 457         (dolist (article tomove)
 458           (gnus-summary-set-process-mark article))
 459         (if copy
 460             (gnus-summary-copy-article nil group)
 461           (gnus-summary-move-article nil group)))))
 462   (gnus-summary-yank-process-mark))
 463
 464 (defun spam-generic-register-routine (spam-func ham-func)
 465   (let ((articles gnus-newsgroup-articles)
 466         article mark ham-articles spam-articles spam-mark-values
 467         ham-mark-values)
 468
 469     ;; marks are stored as symbolic values, so we have to dereference
 470     ;; them for memq to work.  we wouldn't have to do this if
 471     ;; gnus-summary-article-mark returned a symbol.
 472     (dolist (mark spam-ham-marks)
 473       (push (symbol-value mark) ham-mark-values))
 474
 475     (dolist (mark spam-spam-marks)
 476       (push (symbol-value mark) spam-mark-values))
 477
 478     (while articles
 479       (setq article (pop articles)
 480             mark (gnus-summary-article-mark article))
 481       (cond ((memq mark spam-mark-values) (push article spam-articles))
 482             ((memq article gnus-newsgroup-saved))
 483             ((memq mark ham-mark-values) (push article ham-articles))))
 484     (when (and ham-articles ham-func)
 485       (mapc ham-func ham-articles))     ; we use mapc because unlike
 486                                         ; mapcar it discards the
 487                                         ; return values
 488     (when (and spam-articles spam-func)
 489       (mapc spam-func spam-articles)))) ; we use mapc because unlike
 490                                         ; mapcar it discards the
 491                                         ; return values
 492
 493 (eval-and-compile
 494   (defalias 'spam-point-at-eol (if (fboundp 'point-at-eol)
 495                                    'point-at-eol
 496                                  'line-end-position)))
 497
 498 (defun spam-get-article-as-string (article)
 499   (let ((article-buffer (spam-get-article-as-buffer article))
 500                         article-string)
 501     (when article-buffer
 502       (save-window-excursion
 503         (set-buffer article-buffer)
 504         (setq article-string (buffer-string))))
 505   article-string))
 506
 507 (defun spam-get-article-as-buffer (article)
 508   (let ((article-buffer))
 509     (when (numberp article)
 510       (save-window-excursion
 511         (gnus-summary-goto-subject article)
 512         (gnus-summary-show-article t)
 513         (setq article-buffer (get-buffer gnus-article-buffer))))
 514     article-buffer))
 515
 516 ;; disabled for now
 517 ;; (defun spam-get-article-as-filename (article)
 518 ;;   (let ((article-filename))
 519 ;;     (when (numberp article)
 520 ;;       (nnml-possibly-change-directory (gnus-group-real-name gnus-newsgroup-name))
 521 ;;       (setq article-filename (expand-file-name (int-to-string article) nnml-current-directory)))
 522 ;;     (if (file-exists-p article-filename)
 523 ;;      article-filename
 524 ;;       nil)))
 525
 526 (defun spam-fetch-field-from-fast (article)
 527   "Fetch the `from' field quickly, using the internal gnus-data-list function"
 528   (if (and (numberp article)
 529            (assoc article (gnus-data-list nil)))
 530       (mail-header-from (gnus-data-header (assoc article (gnus-data-list nil))))
 531     nil))
 532
 533 (defun spam-fetch-field-subject-fast (article)
 534   "Fetch the `subject' field quickly, using the internal gnus-data-list function"
 535   (if (and (numberp article)
 536            (assoc article (gnus-data-list nil)))
 537       (mail-header-subject (gnus-data-header (assoc article (gnus-data-list nil))))
 538     nil))
 539
 540 \f
 541 ;;;; Spam determination.
 542
 543 (defvar spam-list-of-checks
 544   '((spam-use-blacklist                 .       spam-check-blacklist)
 545     (spam-use-regex-headers             .       spam-check-regex-headers)
 546     (spam-use-whitelist                 .       spam-check-whitelist)
 547     (spam-use-BBDB                      .       spam-check-BBDB)
 548     (spam-use-ifile                     .       spam-check-ifile)
 549     (spam-use-stat                      .       spam-check-stat)
 550     (spam-use-blackholes                .       spam-check-blackholes)
 551     (spam-use-bogofilter-headers        .       spam-check-bogofilter-headers)
 552     (spam-use-bogofilter                .       spam-check-bogofilter))
 553 "The spam-list-of-checks list contains pairs associating a parameter
 554 variable with a spam checking function.  If the parameter variable is
 555 true, then the checking function is called, and its value decides what
 556 happens.  Each individual check may return nil, t, or a mailgroup
 557 name.  The value nil means that the check does not yield a decision,
 558 and so, that further checks are needed.  The value t means that the
 559 message is definitely not spam, and that further spam checks should be
 560 inhibited.  Otherwise, a mailgroup name is returned where the mail
 561 should go, and further checks are also inhibited.  The usual mailgroup
 562 name is the value of `spam-split-group', meaning that the message is
 563 definitely a spam.")
 564
 565 (defvar spam-list-of-statistical-checks
 566   '(spam-use-ifile spam-use-stat spam-use-bogofilter)
 567 "The spam-list-of-statistical-checks list contains all the mail
 568 splitters that need to have the full message body available.")
 569
 570 (defun spam-split ()
 571   "Split this message into the `spam' group if it is spam.
 572 This function can be used as an entry in `nnmail-split-fancy', for
 573 example like this: (: spam-split)
 574
 575 See the Info node `(gnus)Fancy Mail Splitting' for more details."
 576   (interactive)
 577
 578   (dolist (check spam-list-of-statistical-checks)
 579     (when (symbol-value check)
 580       (widen)
 581       (gnus-message 8 "spam-split: widening the buffer (%s requires it)"
 582                     (symbol-name check))
 583       (return)))
 584 ;;   (progn (widen) (debug (buffer-string)))
 585   (let ((list-of-checks spam-list-of-checks)
 586         decision)
 587     (while (and list-of-checks (not decision))
 588       (let ((pair (pop list-of-checks)))
 589         (when (symbol-value (car pair))
 590           (gnus-message 5 "spam-split: calling the %s function" (symbol-name (cdr pair)))
 591           (setq decision (funcall (cdr pair))))))
 592     (if (eq decision t)
 593         nil
 594       decision)))
 595
 596 (defun spam-setup-widening ()
 597   (dolist (check spam-list-of-statistical-checks)
 598     (when (symbol-value check)
 599       (setq nnimap-split-download-body t)
 600       (return))))
 601
 602 (add-hook 'gnus-get-new-news-hook 'spam-setup-widening)
 603
 604 \f
 605 ;;;; Regex headers
 606
 607 (defun spam-check-regex-headers ()
 608   (let (ret found)
 609     (dolist (h-regex spam-regex-headers-ham)
 610       (unless found
 611         (goto-char (point-min))
 612         (when (re-search-forward h-regex nil t)
 613           (message "Ham regex header search positive.")
 614           (setq found t))))
 615     (dolist (s-regex spam-regex-headers-spam)
 616       (unless found
 617         (goto-char (point-min))
 618         (when (re-search-forward s-regex nil t)
 619           (message "Spam regex header search positive." (match-string 1))
 620           (setq found t)
 621           (setq ret spam-split-group))))
 622     ret))
 623
 624 \f
 625 ;;;; Blackholes.
 626
 627 (defun spam-check-blackholes ()
 628   "Check the Received headers for blackholed relays."
 629   (let ((headers (message-fetch-field "received"))
 630         ips matches)
 631     (when headers
 632       (with-temp-buffer
 633         (insert headers)
 634         (goto-char (point-min))
 635         (gnus-message 5 "Checking headers for relay addresses")
 636         (while (re-search-forward
 637                 "\\[\\([0-9]+.[0-9]+.[0-9]+.[0-9]+\\)\\]" nil t)
 638           (gnus-message 9 "Blackhole search found host IP %s." (match-string 1))
 639           (push (mapconcat 'identity
 640                            (nreverse (split-string (match-string 1) "\\."))
 641                            ".")
 642                 ips)))
 643       (dolist (server spam-blackhole-servers)
 644         (dolist (ip ips)
 645           (unless (and spam-blackhole-good-server-regex
 646                        (string-match spam-blackhole-good-server-regex ip))
 647             (let ((query-string (concat ip "." server)))
 648               (if spam-use-dig
 649                   (let ((query-result (query-dig query-string)))
 650                     (when query-result
 651                       (gnus-message 5 "(DIG): positive blackhole check '%s'" query-result)
 652                       (push (list ip server query-result)
 653                             matches)))
 654                 ;; else, if not using dig.el
 655                 (when (query-dns query-string)
 656                   (gnus-message 5 "positive blackhole check")
 657                   (push (list ip server (query-dns query-string 'TXT))
 658                         matches))))))))
 659     (when matches
 660       spam-split-group)))
 661 \f
 662 ;;;; BBDB
 663
 664 ;;; original idea for spam-check-BBDB from Alexander Kotelnikov
 665 ;;; <sacha@giotto.sj.ru>
 666
 667 ;; all this is done inside a condition-case to trap errors
 668
 669 (condition-case nil
 670     (progn
 671       (require 'bbdb)
 672       (require 'bbdb-com)
 673
 674   (defun spam-enter-ham-BBDB (from)
 675     "Enter an address into the BBDB; implies ham (non-spam) sender"
 676     (when (stringp from)
 677       (let* ((parsed-address (gnus-extract-address-components from))
 678              (name (or (car parsed-address) "Ham Sender"))
 679              (net-address (car (cdr parsed-address))))
 680         (gnus-message 5 "Adding address %s to BBDB" from)
 681         (when (and net-address
 682                    (not (bbdb-search-simple nil net-address)))
 683           (bbdb-create-internal name nil net-address nil nil
 684                                 "ham sender added by spam.el")))))
 685
 686   (defun spam-BBDB-register-routine ()
 687     (spam-generic-register-routine
 688      ;; spam function
 689      nil
 690      ;; ham function
 691      (lambda (article)
 692        (spam-enter-ham-BBDB (spam-fetch-field-from-fast article)))))
 693
 694   (defun spam-check-BBDB ()
 695     "Mail from people in the BBDB is classified as ham or non-spam"
 696     (let ((who (message-fetch-field "from")))
 697       (when who
 698         (setq who (cadr (gnus-extract-address-components who)))
 699         (if (bbdb-search-simple nil who)
 700             t
 701           (if spam-use-BBDB-exclusive
 702               spam-split-group
 703             nil))))))
 704
 705   (file-error (progn
 706                 (defalias 'bbdb-search-simple 'ignore)
 707                 (defalias 'spam-check-BBDB 'ignore)
 708                 (defalias 'spam-BBDB-register-routine 'ignore)
 709                 (defalias 'spam-enter-ham-BBDB 'ignore)
 710                 (defalias 'bbdb-create-internal 'ignore)
 711                 (defalias 'bbdb-records 'ignore))))
 712
 713 \f
 714 ;;;; ifile
 715
 716 ;;; check the ifile backend; return nil if the mail was NOT classified
 717 ;;; as spam
 718
 719 (defun spam-get-ifile-database-parameter ()
 720   "Get the command-line parameter for ifile's database from spam-ifile-database-path."
 721   (if spam-ifile-database-path
 722       (format "--db-file=%s" spam-ifile-database-path)
 723     nil))
 724
 725 (defun spam-check-ifile ()
 726   "Check the ifile backend for the classification of this message"
 727   (let ((article-buffer-name (buffer-name))
 728         category return)
 729     (with-temp-buffer
 730       (let ((temp-buffer-name (buffer-name))
 731             (db-param (spam-get-ifile-database-parameter)))
 732         (save-excursion
 733           (set-buffer article-buffer-name)
 734           (if db-param
 735               (call-process-region (point-min) (point-max) spam-ifile-path
 736                                    nil temp-buffer-name nil "-q" "-c" db-param)
 737             (call-process-region (point-min) (point-max) spam-ifile-path
 738                                  nil temp-buffer-name nil "-q" "-c")))
 739         (goto-char (point-min))
 740         (if (not (eobp))
 741             (setq category (buffer-substring (point) (spam-point-at-eol))))
 742         (when (not (zerop (length category))) ; we need a category here
 743           (if spam-ifile-all-categories
 744               (setq return category)
 745             ;; else, if spam-ifile-all-categories is not set...
 746             (when (string-equal spam-ifile-spam-category category)
 747               (setq return spam-split-group))))))
 748     return))
 749
 750 (defun spam-ifile-register-with-ifile (article-string category)
 751   "Register an article, given as a string, with a category.
 752 Uses `gnus-newsgroup-name' if category is nil (for ham registration)."
 753   (when (stringp article-string)
 754     (let ((category (or category gnus-newsgroup-name))
 755           (db-param (spam-get-ifile-database-parameter)))
 756       (with-temp-buffer
 757         (insert article-string)
 758         (if db-param
 759             (call-process-region (point-min) (point-max) spam-ifile-path
 760                                  nil nil nil
 761                                  "-h" "-i" category db-param)
 762           (call-process-region (point-min) (point-max) spam-ifile-path
 763                                nil nil nil
 764                                "-h" "-i" category))))))
 765
 766 (defun spam-ifile-register-spam-routine ()
 767   (spam-generic-register-routine
 768    (lambda (article)
 769      (spam-ifile-register-with-ifile
 770       (spam-get-article-as-string article) spam-ifile-spam-category))
 771    nil))
 772
 773 (defun spam-ifile-register-ham-routine ()
 774   (spam-generic-register-routine
 775    nil
 776    (lambda (article)
 777      (spam-ifile-register-with-ifile
 778       (spam-get-article-as-string article) spam-ifile-ham-category))))
 779
 780 \f
 781 ;;;; spam-stat
 782
 783 (condition-case nil
 784     (progn
 785       (let ((spam-stat-install-hooks nil))
 786         (require 'spam-stat))
 787
 788       (defun spam-check-stat ()
 789         "Check the spam-stat backend for the classification of this message"
 790         (let ((spam-stat-split-fancy-spam-group spam-split-group) ; override
 791               (spam-stat-buffer (buffer-name)) ; stat the current buffer
 792               category return)
 793           (spam-stat-split-fancy)))
 794
 795       (defun spam-stat-register-spam-routine ()
 796         (spam-generic-register-routine
 797          (lambda (article)
 798            (let ((article-string (spam-get-article-as-string article)))
 799              (with-temp-buffer
 800                (insert article-string)
 801                (spam-stat-buffer-is-spam))))
 802          nil))
 803
 804       (defun spam-stat-register-ham-routine ()
 805         (spam-generic-register-routine
 806          nil
 807          (lambda (article)
 808            (let ((article-string (spam-get-article-as-string article)))
 809              (with-temp-buffer
 810                (insert article-string)
 811                (spam-stat-buffer-is-non-spam))))))
 812
 813       (defun spam-maybe-spam-stat-load ()
 814         (when spam-use-stat (spam-stat-load)))
 815
 816       (defun spam-maybe-spam-stat-save ()
 817         (when spam-use-stat (spam-stat-save)))
 818
 819       ;; Add hooks for loading and saving the spam stats
 820       (add-hook 'gnus-save-newsrc-hook 'spam-maybe-spam-stat-save)
 821       (add-hook 'gnus-get-new-news-hook 'spam-maybe-spam-stat-load))
 822       (add-hook 'gnus-startup-hook 'spam-maybe-spam-stat-load))
 823
 824   (file-error (progn
 825                 (defalias 'spam-stat-register-ham-routine 'ignore)
 826                 (defalias 'spam-stat-register-spam-routine 'ignore)
 827                 (defalias 'spam-stat-buffer-is-spam 'ignore)
 828                 (defalias 'spam-stat-buffer-is-non-spam 'ignore)
 829                 (defalias 'spam-stat-split-fancy 'ignore)
 830                 (defalias 'spam-stat-load 'ignore)
 831                 (defalias 'spam-stat-save 'ignore)
 832                 (defalias 'spam-check-stat 'ignore))))
 833
 834 \f
 835
 836 ;;;; Blacklists and whitelists.
 837
 838 (defvar spam-whitelist-cache nil)
 839 (defvar spam-blacklist-cache nil)
 840
 841 (defun spam-enter-whitelist (address)
 842   "Enter ADDRESS into the whitelist."
 843   (interactive "sAddress: ")
 844   (spam-enter-list address spam-whitelist)
 845   (setq spam-whitelist-cache nil))
 846
 847 (defun spam-enter-blacklist (address)
 848   "Enter ADDRESS into the blacklist."
 849   (interactive "sAddress: ")
 850   (spam-enter-list address spam-blacklist)
 851   (setq spam-blacklist-cache nil))
 852
 853 (defun spam-enter-list (address file)
 854   "Enter ADDRESS into the given FILE, either the whitelist or the blacklist."
 855   (unless (file-exists-p (file-name-directory file))
 856     (make-directory (file-name-directory file) t))
 857   (save-excursion
 858     (set-buffer
 859      (find-file-noselect file))
 860     (goto-char (point-max))
 861     (unless (bobp)
 862       (insert "\n"))
 863     (insert address "\n")
 864     (save-buffer)))
 865
 866 ;;; returns t if the sender is in the whitelist, nil or spam-split-group otherwise
 867 (defun spam-check-whitelist ()
 868   ;; FIXME!  Should it detect when file timestamps change?
 869   (unless spam-whitelist-cache
 870     (setq spam-whitelist-cache (spam-parse-list spam-whitelist)))
 871   (if (spam-from-listed-p spam-whitelist-cache)
 872       t
 873     (if spam-use-whitelist-exclusive
 874         spam-split-group
 875       nil)))
 876
 877 (defun spam-check-blacklist ()
 878   ;; FIXME!  Should it detect when file timestamps change?
 879   (unless spam-blacklist-cache
 880     (setq spam-blacklist-cache (spam-parse-list spam-blacklist)))
 881   (and (spam-from-listed-p spam-blacklist-cache) spam-split-group))
 882
 883 (defun spam-parse-list (file)
 884   (when (file-readable-p file)
 885     (let (contents address)
 886       (with-temp-buffer
 887         (insert-file-contents file)
 888         (while (not (eobp))
 889           (setq address (buffer-substring (point) (spam-point-at-eol)))
 890           (forward-line 1)
 891           (unless (zerop (length address))
 892             (setq address (regexp-quote address))
 893             (while (string-match "\\\\\\*" address)
 894               (setq address (replace-match ".*" t t address)))
 895             (push address contents))))
 896       (nreverse contents))))
 897
 898 (defun spam-from-listed-p (cache)
 899   (let ((from (message-fetch-field "from"))
 900         found)
 901     (while cache
 902       (when (string-match (pop cache) from)
 903         (setq found t
 904               cache nil)))
 905     found))
 906
 907 (defun spam-blacklist-register-routine ()
 908   (spam-generic-register-routine
 909    ;; the spam function
 910    (lambda (article)
 911      (let ((from (spam-fetch-field-from-fast article)))
 912        (when (stringp from)
 913            (spam-enter-blacklist from))))
 914    ;; the ham function
 915    nil))
 916
 917 (defun spam-whitelist-register-routine ()
 918   (spam-generic-register-routine
 919    ;; the spam function
 920    nil
 921    ;; the ham function
 922    (lambda (article)
 923      (let ((from (spam-fetch-field-from-fast article)))
 924        (when (stringp from)
 925            (spam-enter-whitelist from))))))
 926
 927 \f
 928 ;;;; Bogofilter
 929
 930 (defun spam-check-bogofilter-headers (&optional score)
 931   (let ((header (message-fetch-field spam-bogofilter-header)))
 932       (when (and header
 933                  (string-match spam-bogofilter-bogosity-positive-spam-header
 934                                header))
 935           (if score
 936               (when (string-match "spamicity=\\([0-9.]+\\)" header)
 937                 (match-string 1 header))
 938             spam-split-group))))
 939
 940 ;; return something sensible if the score can't be determined
 941 (defun spam-bogofilter-score ()
 942   "Get the Bogofilter spamicity score"
 943   (interactive)
 944   (save-window-excursion
 945     (gnus-summary-show-article t)
 946     (set-buffer gnus-article-buffer)
 947     (let ((score (spam-check-bogofilter t)))
 948       (message "Spamicity score %s" score)
 949       (or score "0"))))
 950
 951 (defun spam-check-bogofilter (&optional score)
 952   "Check the Bogofilter backend for the classification of this message"
 953   (let ((article-buffer-name (buffer-name))
 954         return)
 955     (with-temp-buffer
 956       (let ((temp-buffer-name (buffer-name)))
 957         (save-excursion
 958           (set-buffer article-buffer-name)
 959           (if spam-bogofilter-database-directory
 960               (call-process-region (point-min) (point-max)
 961                                    spam-bogofilter-path
 962                                    nil temp-buffer-name nil "-v"
 963                                    "-d" spam-bogofilter-database-directory)
 964             (call-process-region (point-min) (point-max) spam-bogofilter-path
 965                                  nil temp-buffer-name nil "-v")))
 966         (setq return (spam-check-bogofilter-headers score))))
 967     return))
 968
 969 (defun spam-bogofilter-register-with-bogofilter (article-string spam)
 970   "Register an article, given as a string, as spam or non-spam."
 971   (when (stringp article-string)
 972     (let ((switch (if spam "-s" "-n")))
 973       (with-temp-buffer
 974         (insert article-string)
 975         (if spam-bogofilter-database-directory
 976             (call-process-region (point-min) (point-max)
 977                                  spam-bogofilter-path
 978                                  nil nil nil "-v" switch
 979                                  "-d" spam-bogofilter-database-directory)
 980           (call-process-region (point-min) (point-max) spam-bogofilter-path
 981                                nil nil nil "-v" switch))))))
 982
 983 (defun spam-bogofilter-register-spam-routine ()
 984   (spam-generic-register-routine
 985    (lambda (article)
 986      (spam-bogofilter-register-with-bogofilter
 987       (spam-get-article-as-string article) t))
 988    nil))
 989
 990 (defun spam-bogofilter-register-ham-routine ()
 991   (spam-generic-register-routine
 992    nil
 993    (lambda (article)
 994      (spam-bogofilter-register-with-bogofilter
 995       (spam-get-article-as-string article) nil))))
 996
 997 (provide 'spam)
 998
 999 ;;; spam.el ends here.