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 (eval-when-compile (require 'cl))
  38
  39 (require 'gnus-sum)
  40
  41 (require 'gnus-uu)                      ; because of key prefix issues
  42 (require 'gnus) ; for the definitions of group content classification and spam processors
  43 (require 'message)                      ;for the message-fetch-field functions
  44
  45 ;; for nnimap-split-download-body-default
  46 (eval-when-compile (require 'nnimap))
  47
  48 ;; autoload executable-find
  49 (eval-and-compile
  50   ;; executable-find is not autoloaded in Emacs 20
  51   (autoload 'executable-find "executable"))
  52
  53 ;; autoload query-dig
  54 (eval-and-compile
  55   (autoload 'query-dig "dig"))
  56
  57 ;; autoload spam-report
  58 (eval-and-compile
  59   (autoload 'spam-report-gmane "spam-report"))
  60
  61 ;; autoload query-dns
  62 (eval-and-compile
  63   (autoload 'query-dns "dns"))
  64
  65 ;;; Main parameters.
  66
  67 (defgroup spam nil
  68   "Spam configuration.")
  69
  70 (defcustom spam-directory "~/News/spam/"
  71   "Directory for spam whitelists and blacklists."
  72   :type 'directory
  73   :group 'spam)
  74
  75 (defcustom spam-move-spam-nonspam-groups-only t
  76   "Whether spam should be moved in non-spam groups only.
  77 When nil, only ham and unclassified groups will have their spam moved
  78 to the spam-process-destination.  When t, spam will also be moved from
  79 spam groups."
  80   :type 'boolean
  81   :group 'spam)
  82
  83 (defcustom spam-process-ham-in-nonham-groups nil
  84   "Whether ham should be processed in non-ham groups."
  85   :type 'boolean
  86   :group 'spam)
  87
  88 (defcustom spam-process-ham-in-spam-groups nil
  89   "Whether ham should be processed in spam groups."
  90   :type 'boolean
  91   :group 'spam)
  92
  93 (defcustom spam-mark-only-unseen-as-spam t
  94   "Whether only unseen articles should be marked as spam in spam
  95 groups.  When nil, all unread articles in a spam group are marked as
  96 spam.  Set this if you want to leave an article unread in a spam group
  97 without losing it to the automatic spam-marking process."
  98   :type 'boolean
  99   :group 'spam)
 100
 101 (defcustom spam-mark-ham-unread-before-move-from-spam-group nil
 102   "Whether ham should be marked unread before it's moved out of a spam
 103 group according to ham-process-destination.  This variable is an
 104 official entry in the international Longest Variable Name
 105 Competition."
 106   :type 'boolean
 107   :group 'spam)
 108
 109 (defcustom spam-whitelist (expand-file-name "whitelist" spam-directory)
 110   "The location of the whitelist.
 111 The file format is one regular expression per line.
 112 The regular expression is matched against the address."
 113   :type 'file
 114   :group 'spam)
 115
 116 (defcustom spam-blacklist (expand-file-name "blacklist" spam-directory)
 117   "The location of the blacklist.
 118 The file format is one regular expression per line.
 119 The regular expression is matched against the address."
 120   :type 'file
 121   :group 'spam)
 122
 123 (defcustom spam-use-dig t
 124   "Whether query-dig should be used instead of query-dns."
 125   :type 'boolean
 126   :group 'spam)
 127
 128 (defcustom spam-use-blacklist nil
 129   "Whether the blacklist should be used by spam-split."
 130   :type 'boolean
 131   :group 'spam)
 132
 133 (defcustom spam-use-whitelist nil
 134   "Whether the whitelist should be used by spam-split."
 135   :type 'boolean
 136   :group 'spam)
 137
 138 (defcustom spam-use-whitelist-exclusive nil
 139   "Whether whitelist-exclusive should be used by spam-split.
 140 Exclusive whitelisting means that all messages from senders not in the whitelist
 141 are considered spam."
 142   :type 'boolean
 143   :group 'spam)
 144
 145 (defcustom spam-use-blackholes nil
 146   "Whether blackholes should be used by spam-split."
 147   :type 'boolean
 148   :group 'spam)
 149
 150 (defcustom spam-use-hashcash nil
 151   "Whether hashcash payments should be detected by spam-split."
 152   :type 'boolean
 153   :group 'spam)
 154
 155 (defcustom spam-use-regex-headers nil
 156   "Whether a header regular expression match should be used by spam-split.
 157 Also see the variables `spam-regex-headers-spam' and `spam-regex-headers-ham'."
 158   :type 'boolean
 159   :group 'spam)
 160
 161 (defcustom spam-use-regex-body nil
 162   "Whether a body regular expression match should be used by spam-split.
 163 Also see the variables `spam-regex-body-spam' and `spam-regex-body-ham'."
 164   :type 'boolean
 165   :group 'spam)
 166
 167 (defcustom spam-use-bogofilter-headers nil
 168   "Whether bogofilter headers should be used by spam-split.
 169 Enable this if you pre-process messages with Bogofilter BEFORE Gnus sees them."
 170   :type 'boolean
 171   :group 'spam)
 172
 173 (defcustom spam-use-bogofilter nil
 174   "Whether bogofilter should be invoked by spam-split.
 175 Enable this if you want Gnus to invoke Bogofilter on new messages."
 176   :type 'boolean
 177   :group 'spam)
 178
 179 (defcustom spam-use-BBDB nil
 180   "Whether BBDB should be used by spam-split."
 181   :type 'boolean
 182   :group 'spam)
 183
 184 (defcustom spam-use-BBDB-exclusive nil
 185   "Whether BBDB-exclusive should be used by spam-split.
 186 Exclusive BBDB means that all messages from senders not in the BBDB are
 187 considered spam."
 188   :type 'boolean
 189   :group 'spam)
 190
 191 (defcustom spam-use-ifile nil
 192   "Whether ifile should be used by spam-split."
 193   :type 'boolean
 194   :group 'spam)
 195
 196 (defcustom spam-use-stat nil
 197   "Whether spam-stat should be used by spam-split."
 198   :type 'boolean
 199   :group 'spam)
 200
 201 (defcustom spam-use-spamoracle nil
 202   "Whether spamoracle should be used by spam-split."
 203   :type 'boolean
 204   :group 'spam)
 205
 206 (defcustom spam-install-hooks (or
 207                                spam-use-dig
 208                                spam-use-blacklist
 209                                spam-use-whitelist
 210                                spam-use-whitelist-exclusive
 211                                spam-use-blackholes
 212                                spam-use-hashcash
 213                                spam-use-regex-headers
 214                                spam-use-regex-body
 215                                spam-use-bogofilter-headers
 216                                spam-use-bogofilter
 217                                spam-use-BBDB
 218                                spam-use-BBDB-exclusive
 219                                spam-use-ifile
 220                                spam-use-stat
 221                                spam-use-spamoracle)
 222   "Whether the spam hooks should be installed, default to t if one of
 223 the spam-use-* variables is set."
 224   :group 'gnus-registry
 225   :type 'boolean)
 226
 227 (defcustom spam-split-group "spam"
 228   "Group name where incoming spam should be put by spam-split."
 229   :type 'string
 230   :group 'spam)
 231
 232 ;;; TODO: deprecate this variable, it's confusing since it's a list of strings, not regular expressions
 233 (defcustom spam-junk-mailgroups (cons spam-split-group '("mail.junk" "poste.pourriel"))
 234   "Mailgroups with spam contents.
 235 All unmarked article in such group receive the spam mark on group entry."
 236   :type '(repeat (string :tag "Group"))
 237   :group 'spam)
 238
 239 (defcustom spam-blackhole-servers '("bl.spamcop.net" "relays.ordb.org"
 240                                     "dev.null.dk" "relays.visi.com")
 241   "List of blackhole servers."
 242   :type '(repeat (string :tag "Server"))
 243   :group 'spam)
 244
 245 (defcustom spam-blackhole-good-server-regex nil
 246   "String matching IP addresses that should not be checked in the blackholes"
 247   :type '(radio (const nil)
 248                 (regexp :format "%t: %v\n" :size 0))
 249   :group 'spam)
 250
 251 (defcustom spam-face 'gnus-splash-face
 252   "Face for spam-marked articles"
 253   :type 'face
 254   :group 'spam)
 255
 256 (defcustom spam-regex-headers-spam '("^X-Spam-Flag: YES")
 257   "Regular expression for positive header spam matches"
 258   :type '(repeat (regexp :tag "Regular expression to match spam header"))
 259   :group 'spam)
 260
 261 (defcustom spam-regex-headers-ham '("^X-Spam-Flag: NO")
 262   "Regular expression for positive header ham matches"
 263   :type '(repeat (regexp :tag "Regular expression to match ham header"))
 264   :group 'spam)
 265
 266 (defcustom spam-regex-body-spam '()
 267   "Regular expression for positive body spam matches"
 268   :type '(repeat (regexp :tag "Regular expression to match spam body"))
 269   :group 'spam)
 270
 271 (defcustom spam-regex-body-ham '()
 272   "Regular expression for positive body ham matches"
 273   :type '(repeat (regexp :tag "Regular expression to match ham body"))
 274   :group 'spam)
 275
 276 (defgroup spam-ifile nil
 277   "Spam ifile configuration."
 278   :group 'spam)
 279
 280 (defcustom spam-ifile-path (executable-find "ifile")
 281   "File path of the ifile executable program."
 282   :type '(choice (file :tag "Location of ifile")
 283                  (const :tag "ifile is not installed"))
 284   :group 'spam-ifile)
 285
 286 (defcustom spam-ifile-database-path nil
 287   "File path of the ifile database."
 288   :type '(choice (file :tag "Location of the ifile database")
 289                  (const :tag "Use the default"))
 290   :group 'spam-ifile)
 291
 292 (defcustom spam-ifile-spam-category "spam"
 293   "Name of the spam ifile category."
 294   :type 'string
 295   :group 'spam-ifile)
 296
 297 (defcustom spam-ifile-ham-category nil
 298   "Name of the ham ifile category.  If nil, the current group name will
 299 be used."
 300   :type '(choice (string :tag "Use a fixed category")
 301                 (const :tag "Use the current group name"))
 302   :group 'spam-ifile)
 303
 304 (defcustom spam-ifile-all-categories nil
 305   "Whether the ifile check will return all categories, or just spam.
 306 Set this to t if you want to use the spam-split invocation of ifile as
 307 your main source of newsgroup names."
 308   :type 'boolean
 309   :group 'spam-ifile)
 310
 311 (defgroup spam-bogofilter nil
 312   "Spam bogofilter configuration."
 313   :group 'spam)
 314
 315 (defcustom spam-bogofilter-path (executable-find "bogofilter")
 316   "File path of the Bogofilter executable program."
 317   :type '(choice (file :tag "Location of bogofilter")
 318                  (const :tag "Bogofilter is not installed"))
 319   :group 'spam-bogofilter)
 320
 321 (defcustom spam-bogofilter-header "X-Bogosity"
 322   "The header that Bogofilter inserts in messages."
 323   :type 'string
 324   :group 'spam-bogofilter)
 325
 326 (defcustom spam-bogofilter-spam-switch "-s"
 327   "The switch that Bogofilter uses to register spam messages."
 328   :type 'string
 329   :group 'spam-bogofilter)
 330
 331 (defcustom spam-bogofilter-ham-switch "-n"
 332   "The switch that Bogofilter uses to register ham messages."
 333   :type 'string
 334   :group 'spam-bogofilter)
 335
 336 (defcustom spam-bogofilter-bogosity-positive-spam-header "^\\(Yes\\|Spam\\)"
 337   "The regex on `spam-bogofilter-header' for positive spam identification."
 338   :type 'regexp
 339   :group 'spam-bogofilter)
 340
 341 (defcustom spam-bogofilter-database-directory nil
 342   "Directory path of the Bogofilter databases."
 343   :type '(choice (directory :tag "Location of the Bogofilter database directory")
 344                  (const :tag "Use the default"))
 345   :group 'spam-ifile)
 346
 347 (defgroup spam-spamoracle nil
 348   "Spam ifile configuration."
 349   :group 'spam)
 350
 351 (defcustom spam-spamoracle-database nil
 352   "Location of spamoracle database file. When nil, use the default
 353 spamoracle database."
 354   :type '(choice (directory :tag "Location of spamoracle database file.")
 355                  (const :tag "Use the default"))
 356   :group 'spam-spamoracle)
 357
 358 (defcustom spam-spamoracle-binary (executable-find "spamoracle")
 359   "Location of the spamoracle binary."
 360   :type '(choice (directory :tag "Location of the spamoracle binary")
 361                  (const :tag "Use the default"))
 362   :group 'spam-spamoracle)
 363
 364 ;;; Key bindings for spam control.
 365
 366 (gnus-define-keys gnus-summary-mode-map
 367   "St" spam-bogofilter-score
 368   "Sx" gnus-summary-mark-as-spam
 369   "Mst" spam-bogofilter-score
 370   "Msx" gnus-summary-mark-as-spam
 371   "\M-d" gnus-summary-mark-as-spam)
 372
 373 ;; convenience functions
 374 (defun spam-group-ham-mark-p (group mark &optional spam)
 375   (when (stringp group)
 376     (let* ((marks (spam-group-ham-marks group spam))
 377            (marks (if (symbolp mark)
 378                       marks
 379                     (mapcar 'symbol-value marks))))
 380       (memq mark marks))))
 381
 382 (defun spam-group-spam-mark-p (group mark)
 383   (spam-group-ham-mark-p group mark t))
 384
 385 (defun spam-group-ham-marks (group &optional spam)
 386   (when (stringp group)
 387     (let* ((marks (if spam
 388                      (gnus-parameter-spam-marks group)
 389                    (gnus-parameter-ham-marks group)))
 390            (marks (car marks))
 391            (marks (if (listp (car marks)) (car marks) marks)))
 392       marks)))
 393
 394 (defun spam-group-spam-marks (group)
 395   (spam-group-ham-marks group t))
 396
 397 (defun spam-group-spam-contents-p (group)
 398   (if (stringp group)
 399       (or (member group spam-junk-mailgroups)
 400           (memq 'gnus-group-spam-classification-spam
 401                 (gnus-parameter-spam-contents group)))
 402     nil))
 403
 404 (defun spam-group-ham-contents-p (group)
 405   (if (stringp group)
 406       (memq 'gnus-group-spam-classification-ham
 407             (gnus-parameter-spam-contents group))
 408     nil))
 409
 410 (defun spam-group-processor-p (group processor)
 411   (if (and (stringp group)
 412            (symbolp processor))
 413       (member processor (car (gnus-parameter-spam-process group)))
 414     nil))
 415
 416 (defun spam-group-spam-processor-report-gmane-p (group)
 417   (spam-group-processor-p group 'gnus-group-spam-exit-processor-report-gmane))
 418
 419 (defun spam-group-spam-processor-bogofilter-p (group)
 420   (spam-group-processor-p group 'gnus-group-spam-exit-processor-bogofilter))
 421
 422 (defun spam-group-spam-processor-blacklist-p (group)
 423   (spam-group-processor-p group 'gnus-group-spam-exit-processor-blacklist))
 424
 425 (defun spam-group-spam-processor-ifile-p (group)
 426   (spam-group-processor-p group 'gnus-group-spam-exit-processor-ifile))
 427
 428 (defun spam-group-ham-processor-ifile-p (group)
 429   (spam-group-processor-p group 'gnus-group-ham-exit-processor-ifile))
 430
 431 (defun spam-group-spam-processor-spamoracle-p (group)
 432   (spam-group-processor-p group 'gnus-group-spam-exit-processor-spamoracle))
 433
 434 (defun spam-group-ham-processor-bogofilter-p (group)
 435   (spam-group-processor-p group 'gnus-group-ham-exit-processor-bogofilter))
 436
 437 (defun spam-group-spam-processor-stat-p (group)
 438   (spam-group-processor-p group 'gnus-group-spam-exit-processor-stat))
 439
 440 (defun spam-group-ham-processor-stat-p (group)
 441   (spam-group-processor-p group 'gnus-group-ham-exit-processor-stat))
 442
 443 (defun spam-group-ham-processor-whitelist-p (group)
 444   (spam-group-processor-p group 'gnus-group-ham-exit-processor-whitelist))
 445
 446 (defun spam-group-ham-processor-BBDB-p (group)
 447   (spam-group-processor-p group 'gnus-group-ham-exit-processor-BBDB))
 448
 449 (defun spam-group-ham-processor-copy-p (group)
 450   (spam-group-processor-p group 'gnus-group-ham-exit-processor-copy))
 451
 452 (defun spam-group-ham-processor-spamoracle-p (group)
 453   (spam-group-processor-p group 'gnus-group-ham-exit-processor-spamoracle))
 454
 455 ;;; Summary entry and exit processing.
 456
 457 (defun spam-summary-prepare ()
 458   (spam-mark-junk-as-spam-routine))
 459
 460 ;; The spam processors are invoked for any group, spam or ham or neither
 461 (defun spam-summary-prepare-exit ()
 462   (unless gnus-group-is-exiting-without-update-p
 463     (gnus-message 6 "Exiting summary buffer and applying spam rules")
 464     (when (and spam-bogofilter-path
 465                (spam-group-spam-processor-bogofilter-p gnus-newsgroup-name))
 466       (gnus-message 5 "Registering spam with bogofilter")
 467       (spam-bogofilter-register-spam-routine))
 468
 469     (when (and spam-ifile-path
 470                (spam-group-spam-processor-ifile-p gnus-newsgroup-name))
 471       (gnus-message 5 "Registering spam with ifile")
 472       (spam-ifile-register-spam-routine))
 473
 474     (when (spam-group-spam-processor-spamoracle-p gnus-newsgroup-name)
 475       (gnus-message 5 "Registering spam with spamoracle")
 476       (spam-spamoracle-learn-spam))
 477
 478     (when (spam-group-spam-processor-stat-p gnus-newsgroup-name)
 479       (gnus-message 5 "Registering spam with spam-stat")
 480       (spam-stat-register-spam-routine))
 481
 482     (when (spam-group-spam-processor-blacklist-p gnus-newsgroup-name)
 483       (gnus-message 5 "Registering spam with the blacklist")
 484       (spam-blacklist-register-routine))
 485
 486     (when (spam-group-spam-processor-report-gmane-p gnus-newsgroup-name)
 487       (gnus-message 5 "Registering spam with the Gmane report")
 488       (spam-report-gmane-register-routine))
 489
 490     (if spam-move-spam-nonspam-groups-only
 491         (when (not (spam-group-spam-contents-p gnus-newsgroup-name))
 492           (spam-mark-spam-as-expired-and-move-routine
 493            (gnus-parameter-spam-process-destination gnus-newsgroup-name)))
 494       (gnus-message 5 "Marking spam as expired and moving it to %s" gnus-newsgroup-name)
 495       (spam-mark-spam-as-expired-and-move-routine
 496        (gnus-parameter-spam-process-destination gnus-newsgroup-name)))
 497
 498     ;; now we redo spam-mark-spam-as-expired-and-move-routine to only
 499     ;; expire spam, in case the above did not expire them
 500     (gnus-message 5 "Marking spam as expired without moving it")
 501     (spam-mark-spam-as-expired-and-move-routine nil)
 502
 503     (when (or (spam-group-ham-contents-p gnus-newsgroup-name)
 504               (and (spam-group-spam-contents-p gnus-newsgroup-name)
 505                    spam-process-ham-in-spam-groups)
 506               spam-process-ham-in-nonham-groups)
 507       (when (spam-group-ham-processor-whitelist-p gnus-newsgroup-name)
 508         (gnus-message 5 "Registering ham with the whitelist")
 509         (spam-whitelist-register-routine))
 510       (when (spam-group-ham-processor-ifile-p gnus-newsgroup-name)
 511         (gnus-message 5 "Registering ham with ifile")
 512         (spam-ifile-register-ham-routine))
 513       (when (spam-group-ham-processor-bogofilter-p gnus-newsgroup-name)
 514         (gnus-message 5 "Registering ham with Bogofilter")
 515         (spam-bogofilter-register-ham-routine))
 516       (when (spam-group-ham-processor-stat-p gnus-newsgroup-name)
 517         (gnus-message 5 "Registering ham with spam-stat")
 518         (spam-stat-register-ham-routine))
 519       (when (spam-group-ham-processor-BBDB-p gnus-newsgroup-name)
 520         (gnus-message 5 "Registering ham with the BBDB")
 521         (spam-BBDB-register-routine))
 522       (when (spam-group-ham-processor-spamoracle-p gnus-newsgroup-name)
 523         (gnus-message 5 "Registering ham with spamoracle")
 524         (spam-spamoracle-learn-ham)))
 525
 526     (when (spam-group-ham-processor-copy-p gnus-newsgroup-name)
 527       (gnus-message 5 "Copying ham")
 528       (spam-ham-copy-routine
 529        (gnus-parameter-ham-process-destination gnus-newsgroup-name)))
 530
 531     ;; now move all ham articles out of spam groups
 532     (when (spam-group-spam-contents-p gnus-newsgroup-name)
 533       (gnus-message 5 "Moving ham messages from spam group")
 534       (spam-ham-move-routine
 535        (gnus-parameter-ham-process-destination gnus-newsgroup-name)))))
 536
 537 (defun spam-mark-junk-as-spam-routine ()
 538   ;; check the global list of group names spam-junk-mailgroups and the
 539   ;; group parameters
 540   (when (spam-group-spam-contents-p gnus-newsgroup-name)
 541     (gnus-message 5 "Marking %s articles as spam"
 542                   (if spam-mark-only-unseen-as-spam
 543                       "unseen"
 544                     "unread"))
 545     (let ((articles (if spam-mark-only-unseen-as-spam
 546                         gnus-newsgroup-unseen
 547                       gnus-newsgroup-unreads)))
 548       (dolist (article articles)
 549         (gnus-summary-mark-article article gnus-spam-mark)))))
 550
 551 (defun spam-mark-spam-as-expired-and-move-routine (&rest groups)
 552   (gnus-summary-kill-process-mark)
 553   (let ((articles gnus-newsgroup-articles)
 554         article tomove)
 555     (dolist (article articles)
 556       (when (eq (gnus-summary-article-mark article) gnus-spam-mark)
 557         (gnus-summary-mark-article article gnus-expirable-mark)
 558         (push article tomove)))
 559
 560     ;; now do the actual copies
 561     (dolist (group groups)
 562       (when (and tomove
 563                  (stringp group))
 564         (dolist (article tomove)
 565           (gnus-summary-set-process-mark article))
 566         (when tomove
 567           (gnus-summary-copy-article nil group))))
 568
 569     ;; now delete the articles
 570     (dolist (article tomove)
 571       (gnus-summary-set-process-mark article))
 572     (when tomove
 573       (gnus-summary-delete-article nil)))
 574
 575   (gnus-summary-yank-process-mark))
 576
 577 (defun spam-ham-copy-or-move-routine (copy &rest groups)
 578   (gnus-summary-kill-process-mark)
 579   (let ((articles gnus-newsgroup-articles)
 580         article mark todo)
 581     (dolist (article articles)
 582       (when (spam-group-ham-mark-p gnus-newsgroup-name
 583                                    (gnus-summary-article-mark article))
 584         (push article todo)))
 585
 586     ;; now do the actual move
 587     (dolist (group groups)
 588       (when todo
 589         (dolist (article todo)
 590           (when spam-mark-ham-unread-before-move-from-spam-group
 591             (gnus-summary-mark-article article gnus-unread-mark))
 592           (gnus-summary-set-process-mark article))
 593         (gnus-summary-copy-article nil group)))
 594
 595     ;; now delete the articles
 596     (dolist (article todo)
 597       (gnus-summary-set-process-mark article))
 598     (when todo
 599       (gnus-summary-delete-article nil)))
 600
 601   (gnus-summary-yank-process-mark))
 602
 603 (defun spam-ham-copy-routine (&rest groups)
 604   (spam-ham-copy-or-move-routine t groups))
 605
 606 (defun spam-ham-move-routine (&rest groups)
 607   (spam-ham-copy-or-move-routine nil groups))
 608
 609 (defun spam-generic-register-routine (spam-func ham-func)
 610   (let ((articles gnus-newsgroup-articles)
 611         article mark ham-articles spam-articles)
 612
 613     (while articles
 614       (setq article (pop articles)
 615             mark (gnus-summary-article-mark article))
 616       (cond ((spam-group-spam-mark-p gnus-newsgroup-name mark)
 617              (push article spam-articles))
 618             ((memq article gnus-newsgroup-saved))
 619             ((spam-group-ham-mark-p gnus-newsgroup-name mark)
 620              (push article ham-articles))))
 621
 622     (when (and ham-articles ham-func)
 623       (mapc ham-func ham-articles))     ; we use mapc because unlike
 624                                         ; mapcar it discards the
 625                                         ; return values
 626     (when (and spam-articles spam-func)
 627       (mapc spam-func spam-articles)))) ; we use mapc because unlike
 628                                         ; mapcar it discards the
 629                                         ; return values
 630
 631 (eval-and-compile
 632   (defalias 'spam-point-at-eol (if (fboundp 'point-at-eol)
 633                                    'point-at-eol
 634                                  'line-end-position)))
 635
 636 (defun spam-get-article-as-string (article)
 637   (let ((article-buffer (spam-get-article-as-buffer article))
 638                         article-string)
 639     (when article-buffer
 640       (save-window-excursion
 641         (set-buffer article-buffer)
 642         (setq article-string (buffer-string))))
 643   article-string))
 644
 645 (defun spam-get-article-as-buffer (article)
 646   (let ((article-buffer))
 647     (when (numberp article)
 648       (save-window-excursion
 649         (gnus-summary-goto-subject article)
 650         (gnus-summary-show-article t)
 651         (setq article-buffer (get-buffer gnus-article-buffer))))
 652     article-buffer))
 653
 654 ;; disabled for now
 655 ;; (defun spam-get-article-as-filename (article)
 656 ;;   (let ((article-filename))
 657 ;;     (when (numberp article)
 658 ;;       (nnml-possibly-change-directory (gnus-group-real-name gnus-newsgroup-name))
 659 ;;       (setq article-filename (expand-file-name (int-to-string article) nnml-current-directory)))
 660 ;;     (if (file-exists-p article-filename)
 661 ;;      article-filename
 662 ;;       nil)))
 663
 664 (defun spam-fetch-field-from-fast (article)
 665   "Fetch the `from' field quickly, using the internal gnus-data-list function"
 666   (if (and (numberp article)
 667            (assoc article (gnus-data-list nil)))
 668       (mail-header-from (gnus-data-header (assoc article (gnus-data-list nil))))
 669     nil))
 670
 671 (defun spam-fetch-field-subject-fast (article)
 672   "Fetch the `subject' field quickly, using the internal gnus-data-list function"
 673   (if (and (numberp article)
 674            (assoc article (gnus-data-list nil)))
 675       (mail-header-subject (gnus-data-header (assoc article (gnus-data-list nil))))
 676     nil))
 677
 678 \f
 679 ;;;; Spam determination.
 680
 681 (defvar spam-list-of-checks
 682   '((spam-use-blacklist                 .       spam-check-blacklist)
 683     (spam-use-regex-headers             .       spam-check-regex-headers)
 684     (spam-use-regex-body                .       spam-check-regex-body)
 685     (spam-use-whitelist                 .       spam-check-whitelist)
 686     (spam-use-BBDB                      .       spam-check-BBDB)
 687     (spam-use-ifile                     .       spam-check-ifile)
 688     (spam-use-spamoracle                .       spam-check-spamoracle)
 689     (spam-use-stat                      .       spam-check-stat)
 690     (spam-use-blackholes                .       spam-check-blackholes)
 691     (spam-use-hashcash                  .       spam-check-hashcash)
 692     (spam-use-bogofilter-headers        .       spam-check-bogofilter-headers)
 693     (spam-use-bogofilter                .       spam-check-bogofilter))
 694 "The spam-list-of-checks list contains pairs associating a parameter
 695 variable with a spam checking function.  If the parameter variable is
 696 true, then the checking function is called, and its value decides what
 697 happens.  Each individual check may return nil, t, or a mailgroup
 698 name.  The value nil means that the check does not yield a decision,
 699 and so, that further checks are needed.  The value t means that the
 700 message is definitely not spam, and that further spam checks should be
 701 inhibited.  Otherwise, a mailgroup name is returned where the mail
 702 should go, and further checks are also inhibited.  The usual mailgroup
 703 name is the value of `spam-split-group', meaning that the message is
 704 definitely a spam.")
 705
 706 (defvar spam-list-of-statistical-checks
 707   '(spam-use-ifile spam-use-regex-body spam-use-stat spam-use-bogofilter spam-use-spamoracle)
 708 "The spam-list-of-statistical-checks list contains all the mail
 709 splitters that need to have the full message body available.")
 710
 711 ;;;TODO: modify to invoke self with each specific check if invoked without specific checks
 712 (defun spam-split (&rest specific-checks)
 713   "Split this message into the `spam' group if it is spam.
 714 This function can be used as an entry in `nnmail-split-fancy', for
 715 example like this: (: spam-split).  It can take checks as parameters.
 716
 717 See the Info node `(gnus)Fancy Mail Splitting' for more details."
 718   (interactive)
 719   (save-excursion
 720     (save-restriction
 721       (dolist (check spam-list-of-statistical-checks)
 722         (when (symbol-value check)
 723           (widen)
 724           (gnus-message 8 "spam-split: widening the buffer (%s requires it)"
 725                         (symbol-name check))
 726           (return)))
 727       ;;   (progn (widen) (debug (buffer-string)))
 728       (let ((list-of-checks spam-list-of-checks)
 729             decision)
 730         (while (and list-of-checks (not decision))
 731           (let ((pair (pop list-of-checks)))
 732             (when (and (symbol-value (car pair))
 733                        (or (null specific-checks)
 734                            (memq (car pair) specific-checks)))
 735               (gnus-message 5 "spam-split: calling the %s function" (symbol-name (cdr pair)))
 736               (setq decision (funcall (cdr pair))))))
 737         (if (eq decision t)
 738             nil
 739           decision)))))
 740
 741 (defun spam-setup-widening ()
 742   (dolist (check spam-list-of-statistical-checks)
 743     (when (symbol-value check)
 744       (setq nnimap-split-download-body-default t))))
 745
 746 \f
 747 ;;;; Regex body
 748
 749 (defun spam-check-regex-body ()
 750   (let ((spam-regex-headers-ham spam-regex-body-ham)
 751         (spam-regex-headers-spam spam-regex-body-spam))
 752     (spam-check-regex-headers t)))
 753
 754 \f
 755 ;;;; Regex headers
 756
 757 (defun spam-check-regex-headers (&optional body)
 758   (let ((type (if body "body" "header"))
 759          ret found)
 760     (dolist (h-regex spam-regex-headers-ham)
 761       (unless found
 762         (goto-char (point-min))
 763         (when (re-search-forward h-regex nil t)
 764           (message "Ham regex %s search positive." type)
 765           (setq found t))))
 766     (dolist (s-regex spam-regex-headers-spam)
 767       (unless found
 768         (goto-char (point-min))
 769         (when (re-search-forward s-regex nil t)
 770           (message "Spam regex %s search positive." type)
 771           (setq found t)
 772           (setq ret spam-split-group))))
 773     ret))
 774
 775 \f
 776 ;;;; Blackholes.
 777
 778 (defun spam-reverse-ip-string (ip)
 779   (when (stringp ip)
 780     (mapconcat 'identity
 781                (nreverse (split-string ip "\\."))
 782                ".")))
 783
 784 (defun spam-check-blackholes ()
 785   "Check the Received headers for blackholed relays."
 786   (let ((headers (nnmail-fetch-field "received"))
 787         ips matches)
 788     (when headers
 789       (with-temp-buffer
 790         (insert headers)
 791         (goto-char (point-min))
 792         (gnus-message 5 "Checking headers for relay addresses")
 793         (while (re-search-forward
 794                 "\\([0-9]+\\.[0-9]+\\.[0-9]+\\.[0-9]+\\)" nil t)
 795           (gnus-message 9 "Blackhole search found host IP %s." (match-string 1))
 796           (push (spam-reverse-ip-string (match-string 1))
 797                 ips)))
 798       (dolist (server spam-blackhole-servers)
 799         (dolist (ip ips)
 800           (unless (and spam-blackhole-good-server-regex
 801                        ;; match the good-server-regex against the reversed (again) IP string
 802                        (string-match
 803                         spam-blackhole-good-server-regex
 804                         (spam-reverse-ip-string ip)))
 805             (unless matches
 806               (let ((query-string (concat ip "." server)))
 807                 (if spam-use-dig
 808                     (let ((query-result (query-dig query-string)))
 809                       (when query-result
 810                         (gnus-message 5 "(DIG): positive blackhole check '%s'"
 811                                       query-result)
 812                         (push (list ip server query-result)
 813                               matches)))
 814                   ;; else, if not using dig.el
 815                   (when (query-dns query-string)
 816                     (gnus-message 5 "positive blackhole check")
 817                     (push (list ip server (query-dns query-string 'TXT))
 818                           matches)))))))))
 819     (when matches
 820       spam-split-group)))
 821 \f
 822 ;;;; Hashcash.
 823
 824 (condition-case nil
 825     (progn
 826       (require 'hashcash)
 827
 828       (defun spam-check-hashcash ()
 829         "Check the headers for hashcash payments."
 830         (mail-check-payment)))          ;mail-check-payment returns a boolean
 831
 832   (file-error (progn
 833                 (defalias 'mail-check-payment 'ignore)
 834                 (defalias 'spam-check-hashcash 'ignore))))
 835 \f
 836 ;;;; BBDB
 837
 838 ;;; original idea for spam-check-BBDB from Alexander Kotelnikov
 839 ;;; <sacha@giotto.sj.ru>
 840
 841 ;; all this is done inside a condition-case to trap errors
 842
 843 (condition-case nil
 844     (progn
 845       (require 'bbdb)
 846       (require 'bbdb-com)
 847
 848   (defun spam-enter-ham-BBDB (from)
 849     "Enter an address into the BBDB; implies ham (non-spam) sender"
 850     (when (stringp from)
 851       (let* ((parsed-address (gnus-extract-address-components from))
 852              (name (or (car parsed-address) "Ham Sender"))
 853              (net-address (car (cdr parsed-address))))
 854         (gnus-message 5 "Adding address %s to BBDB" from)
 855         (when (and net-address
 856                    (not (bbdb-search-simple nil net-address)))
 857           (bbdb-create-internal name nil net-address nil nil
 858                                 "ham sender added by spam.el")))))
 859
 860   (defun spam-BBDB-register-routine ()
 861     (spam-generic-register-routine
 862      ;; spam function
 863      nil
 864      ;; ham function
 865      (lambda (article)
 866        (spam-enter-ham-BBDB (spam-fetch-field-from-fast article)))))
 867
 868   (defun spam-check-BBDB ()
 869     "Mail from people in the BBDB is classified as ham or non-spam"
 870     (let ((who (nnmail-fetch-field "from")))
 871       (when who
 872         (setq who (cadr (gnus-extract-address-components who)))
 873         (if (bbdb-search-simple nil who)
 874             t
 875           (if spam-use-BBDB-exclusive
 876               spam-split-group
 877             nil))))))
 878
 879   (file-error (progn
 880                 (defalias 'bbdb-search-simple 'ignore)
 881                 (defalias 'spam-check-BBDB 'ignore)
 882                 (defalias 'spam-BBDB-register-routine 'ignore)
 883                 (defalias 'spam-enter-ham-BBDB 'ignore)
 884                 (defalias 'bbdb-create-internal 'ignore)
 885                 (defalias 'bbdb-records 'ignore))))
 886
 887 \f
 888 ;;;; ifile
 889
 890 ;;; check the ifile backend; return nil if the mail was NOT classified
 891 ;;; as spam
 892
 893 (defun spam-get-ifile-database-parameter ()
 894   "Get the command-line parameter for ifile's database from spam-ifile-database-path."
 895   (if spam-ifile-database-path
 896       (format "--db-file=%s" spam-ifile-database-path)
 897     nil))
 898
 899 (defun spam-check-ifile ()
 900   "Check the ifile backend for the classification of this message"
 901   (let ((article-buffer-name (buffer-name))
 902         category return)
 903     (with-temp-buffer
 904       (let ((temp-buffer-name (buffer-name))
 905             (db-param (spam-get-ifile-database-parameter)))
 906         (save-excursion
 907           (set-buffer article-buffer-name)
 908           (if db-param
 909               (call-process-region (point-min) (point-max) spam-ifile-path
 910                                    nil temp-buffer-name nil "-q" "-c" db-param)
 911             (call-process-region (point-min) (point-max) spam-ifile-path
 912                                  nil temp-buffer-name nil "-q" "-c")))
 913         (goto-char (point-min))
 914         (if (not (eobp))
 915             (setq category (buffer-substring (point) (spam-point-at-eol))))
 916         (when (not (zerop (length category))) ; we need a category here
 917           (if spam-ifile-all-categories
 918               (setq return category)
 919             ;; else, if spam-ifile-all-categories is not set...
 920             (when (string-equal spam-ifile-spam-category category)
 921               (setq return spam-split-group))))))
 922     return))
 923
 924 (defun spam-ifile-register-with-ifile (article-string category)
 925   "Register an article, given as a string, with a category.
 926 Uses `gnus-newsgroup-name' if category is nil (for ham registration)."
 927   (when (stringp article-string)
 928     (let ((category (or category gnus-newsgroup-name))
 929           (db-param (spam-get-ifile-database-parameter)))
 930       (with-temp-buffer
 931         (insert article-string)
 932         (if db-param
 933             (call-process-region (point-min) (point-max) spam-ifile-path
 934                                  nil nil nil
 935                                  "-h" "-i" category db-param)
 936           (call-process-region (point-min) (point-max) spam-ifile-path
 937                                nil nil nil
 938                                "-h" "-i" category))))))
 939
 940 (defun spam-ifile-register-spam-routine ()
 941   (spam-generic-register-routine
 942    (lambda (article)
 943      (spam-ifile-register-with-ifile
 944       (spam-get-article-as-string article) spam-ifile-spam-category))
 945    nil))
 946
 947 (defun spam-ifile-register-ham-routine ()
 948   (spam-generic-register-routine
 949    nil
 950    (lambda (article)
 951      (spam-ifile-register-with-ifile
 952       (spam-get-article-as-string article) spam-ifile-ham-category))))
 953
 954 \f
 955 ;;;; spam-stat
 956
 957 (condition-case nil
 958     (progn
 959       (let ((spam-stat-install-hooks nil))
 960         (require 'spam-stat))
 961
 962       (defun spam-check-stat ()
 963         "Check the spam-stat backend for the classification of this message"
 964         (let ((spam-stat-split-fancy-spam-group spam-split-group) ; override
 965               (spam-stat-buffer (buffer-name)) ; stat the current buffer
 966               category return)
 967           (spam-stat-split-fancy)))
 968
 969       (defun spam-stat-register-spam-routine ()
 970         (spam-generic-register-routine
 971          (lambda (article)
 972            (let ((article-string (spam-get-article-as-string article)))
 973              (with-temp-buffer
 974                (insert article-string)
 975                (spam-stat-buffer-is-spam))))
 976          nil))
 977
 978       (defun spam-stat-register-ham-routine ()
 979         (spam-generic-register-routine
 980          nil
 981          (lambda (article)
 982            (let ((article-string (spam-get-article-as-string article)))
 983              (with-temp-buffer
 984                (insert article-string)
 985                (spam-stat-buffer-is-non-spam))))))
 986
 987       (defun spam-maybe-spam-stat-load ()
 988         (when spam-use-stat (spam-stat-load)))
 989
 990       (defun spam-maybe-spam-stat-save ()
 991         (when spam-use-stat (spam-stat-save))))
 992
 993   (file-error (progn
 994                 (defalias 'spam-maybe-spam-stat-load 'ignore)
 995                 (defalias 'spam-maybe-spam-stat-save 'ignore)
 996                 (defalias 'spam-stat-register-ham-routine 'ignore)
 997                 (defalias 'spam-stat-register-spam-routine 'ignore)
 998                 (defalias 'spam-stat-buffer-is-spam 'ignore)
 999                 (defalias 'spam-stat-buffer-is-non-spam 'ignore)
1000                 (defalias 'spam-stat-split-fancy 'ignore)
1001                 (defalias 'spam-stat-load 'ignore)
1002                 (defalias 'spam-stat-save 'ignore)
1003                 (defalias 'spam-check-stat 'ignore))))
1004
1005 \f
1006
1007 ;;;; Blacklists and whitelists.
1008
1009 (defvar spam-whitelist-cache nil)
1010 (defvar spam-blacklist-cache nil)
1011
1012 (defun spam-enter-whitelist (address)
1013   "Enter ADDRESS into the whitelist."
1014   (interactive "sAddress: ")
1015   (spam-enter-list address spam-whitelist)
1016   (setq spam-whitelist-cache nil))
1017
1018 (defun spam-enter-blacklist (address)
1019   "Enter ADDRESS into the blacklist."
1020   (interactive "sAddress: ")
1021   (spam-enter-list address spam-blacklist)
1022   (setq spam-blacklist-cache nil))
1023
1024 (defun spam-enter-list (address file)
1025   "Enter ADDRESS into the given FILE, either the whitelist or the blacklist."
1026   (unless (file-exists-p (file-name-directory file))
1027     (make-directory (file-name-directory file) t))
1028   (save-excursion
1029     (set-buffer
1030      (find-file-noselect file))
1031     (goto-char (point-min))
1032     (unless (re-search-forward (regexp-quote address) nil t)
1033       (goto-char (point-max))
1034       (unless (bobp)
1035         (insert "\n"))
1036       (insert address "\n")
1037       (save-buffer))))
1038
1039 ;;; returns t if the sender is in the whitelist, nil or spam-split-group otherwise
1040 (defun spam-check-whitelist ()
1041   ;; FIXME!  Should it detect when file timestamps change?
1042   (unless spam-whitelist-cache
1043     (setq spam-whitelist-cache (spam-parse-list spam-whitelist)))
1044   (if (spam-from-listed-p spam-whitelist-cache)
1045       t
1046     (if spam-use-whitelist-exclusive
1047         spam-split-group
1048       nil)))
1049
1050 (defun spam-check-blacklist ()
1051   ;; FIXME!  Should it detect when file timestamps change?
1052   (unless spam-blacklist-cache
1053     (setq spam-blacklist-cache (spam-parse-list spam-blacklist)))
1054   (and (spam-from-listed-p spam-blacklist-cache) spam-split-group))
1055
1056 (defun spam-parse-list (file)
1057   (when (file-readable-p file)
1058     (let (contents address)
1059       (with-temp-buffer
1060         (insert-file-contents file)
1061         (while (not (eobp))
1062           (setq address (buffer-substring (point) (spam-point-at-eol)))
1063           (forward-line 1)
1064           ;; insert the e-mail address if detected, otherwise the raw data
1065           (unless (zerop (length address))
1066             (let ((pure-address (cadr (gnus-extract-address-components address))))
1067               (push (or pure-address address) contents)))))
1068       (nreverse contents))))
1069
1070 (defun spam-from-listed-p (cache)
1071   (let ((from (nnmail-fetch-field "from"))
1072         found)
1073     (while cache
1074       (let ((address (pop cache)))
1075         (unless (zerop (length address)) ; 0 for a nil address too
1076           (setq address (regexp-quote address))
1077           ;; fix regexp-quote's treatment of user-intended regexes
1078           (while (string-match "\\\\\\*" address)
1079             (setq address (replace-match ".*" t t address))))
1080         (when (and address (string-match address from))
1081           (setq found t
1082                 cache nil))))
1083     found))
1084
1085 (defun spam-blacklist-register-routine ()
1086   (spam-generic-register-routine
1087    ;; the spam function
1088    (lambda (article)
1089      (let ((from (spam-fetch-field-from-fast article)))
1090        (when (stringp from)
1091            (spam-enter-blacklist from))))
1092    ;; the ham function
1093    nil))
1094
1095 (defun spam-whitelist-register-routine ()
1096   (spam-generic-register-routine
1097    ;; the spam function
1098    nil
1099    ;; the ham function
1100    (lambda (article)
1101      (let ((from (spam-fetch-field-from-fast article)))
1102        (when (stringp from)
1103            (spam-enter-whitelist from))))))
1104
1105 \f
1106 ;;;; Spam-report glue
1107 (defun spam-report-gmane-register-routine ()
1108   (spam-generic-register-routine
1109    'spam-report-gmane
1110    nil))
1111
1112 \f
1113 ;;;; Bogofilter
1114 (defun spam-check-bogofilter-headers (&optional score)
1115   (let ((header (nnmail-fetch-field spam-bogofilter-header)))
1116     (when header                        ; return nil when no header
1117       (if score                         ; scoring mode
1118           (if (string-match "spamicity=\\([0-9.]+\\)" header)
1119               (match-string 1 header)
1120             "0")
1121         ;; spam detection mode
1122         (when (string-match spam-bogofilter-bogosity-positive-spam-header
1123                             header)
1124           spam-split-group)))))
1125
1126 ;; return something sensible if the score can't be determined
1127 (defun spam-bogofilter-score ()
1128   "Get the Bogofilter spamicity score"
1129   (interactive)
1130   (save-window-excursion
1131     (gnus-summary-show-article t)
1132     (set-buffer gnus-article-buffer)
1133     (let ((score (or (spam-check-bogofilter-headers t)
1134                      (spam-check-bogofilter t))))
1135       (message "Spamicity score %s" score)
1136       (or score "0"))
1137     (gnus-summary-show-article)))
1138
1139 (defun spam-check-bogofilter (&optional score)
1140   "Check the Bogofilter backend for the classification of this message"
1141   (let ((article-buffer-name (buffer-name))
1142         return)
1143     (with-temp-buffer
1144       (let ((temp-buffer-name (buffer-name)))
1145         (save-excursion
1146           (set-buffer article-buffer-name)
1147           (if spam-bogofilter-database-directory
1148               (call-process-region (point-min) (point-max)
1149                                    spam-bogofilter-path
1150                                    nil temp-buffer-name nil "-v"
1151                                    "-d" spam-bogofilter-database-directory)
1152             (call-process-region (point-min) (point-max) spam-bogofilter-path
1153                                  nil temp-buffer-name nil "-v")))
1154         (setq return (spam-check-bogofilter-headers score))))
1155     return))
1156
1157 (defun spam-bogofilter-register-with-bogofilter (article-string spam)
1158   "Register an article, given as a string, as spam or non-spam."
1159   (when (stringp article-string)
1160     (let ((switch (if spam spam-bogofilter-spam-switch
1161                     spam-bogofilter-ham-switch)))
1162       (with-temp-buffer
1163         (insert article-string)
1164         (if spam-bogofilter-database-directory
1165             (call-process-region (point-min) (point-max)
1166                                  spam-bogofilter-path
1167                                  nil nil nil "-v" switch
1168                                  "-d" spam-bogofilter-database-directory)
1169           (call-process-region (point-min) (point-max) spam-bogofilter-path
1170                                nil nil nil "-v" switch))))))
1171
1172 (defun spam-bogofilter-register-spam-routine ()
1173   (spam-generic-register-routine
1174    (lambda (article)
1175      (spam-bogofilter-register-with-bogofilter
1176       (spam-get-article-as-string article) t))
1177    nil))
1178
1179 (defun spam-bogofilter-register-ham-routine ()
1180   (spam-generic-register-routine
1181    nil
1182    (lambda (article)
1183      (spam-bogofilter-register-with-bogofilter
1184       (spam-get-article-as-string article) nil))))
1185
1186 \f
1187 ;;;; spamoracle
1188 (defun spam-check-spamoracle ()
1189   "Run spamoracle on an article to determine whether it's spam."
1190   (let ((article-buffer-name (buffer-name)))
1191     (with-temp-buffer
1192       (let ((temp-buffer-name (buffer-name)))
1193         (save-excursion
1194           (set-buffer article-buffer-name)
1195           (let ((status
1196                  (apply 'call-process-region
1197                         (point-min) (point-max)
1198                         spam-spamoracle-binary
1199                         nil temp-buffer-name nil
1200                         (if spam-spamoracle-database
1201                             `("-f" ,spam-spamoracle-database "mark")
1202                           '("mark")))))
1203             (if (zerop status)
1204                 (progn
1205                   (set-buffer temp-buffer-name)
1206                   (goto-char (point-min))
1207                   (when (re-search-forward "^X-Spam: yes;" nil t)
1208                     spam-split-group))
1209               (error "Error running spamoracle" status))))))))
1210
1211 (defun spam-spamoracle-learn (article article-is-spam-p)
1212   "Run spamoracle in training mode."
1213   (with-temp-buffer
1214     (let ((temp-buffer-name (buffer-name)))
1215       (save-excursion
1216         (goto-char (point-min))
1217         (insert (spam-get-article-as-string article))
1218         (let* ((arg (if article-is-spam-p "-spam" "-good"))
1219                (status
1220                 (apply 'call-process-region
1221                        (point-min) (point-max)
1222                        spam-spamoracle-binary
1223                        nil temp-buffer-name nil
1224                        (if spam-spamoracle-database
1225                            `("-f" ,spam-spamoracle-database
1226                              "add" ,arg)
1227                          `("add" ,arg)))))
1228           (when (not (zerop status))
1229             (error "Error running spamoracle" status)))))))
1230
1231 (defun spam-spamoracle-learn-ham ()
1232   (spam-generic-register-routine
1233    nil
1234    (lambda (article)
1235      (spam-spamoracle-learn article nil))))
1236
1237 (defun spam-spamoracle-learn-spam ()
1238   (spam-generic-register-routine
1239    (lambda (article)
1240      (spam-spamoracle-learn article t))
1241    nil))
1242 \f
1243 ;;;; Hooks
1244
1245 ;;;###autoload
1246 (defun spam-initialize ()
1247   "Install the spam.el hooks and do other initialization"
1248   (interactive)
1249   (setq spam-install-hooks t)
1250   ;; TODO: How do we redo this every time spam-face is customized?
1251   (push '((eq mark gnus-spam-mark) . spam-face)
1252         gnus-summary-highlight)
1253   ;; Add hooks for loading and saving the spam stats
1254   (when spam-use-stat
1255     (add-hook 'gnus-save-newsrc-hook 'spam-maybe-spam-stat-save)
1256     (add-hook 'gnus-get-top-new-news-hook 'spam-maybe-spam-stat-load)
1257     (add-hook 'gnus-startup-hook 'spam-maybe-spam-stat-load))
1258   (add-hook 'gnus-summary-prepare-exit-hook 'spam-summary-prepare-exit)
1259   (add-hook 'gnus-summary-prepare-hook 'spam-summary-prepare)
1260   (add-hook 'gnus-get-new-news-hook 'spam-setup-widening))
1261
1262 (defun spam-unload-hook ()
1263   "Uninstall the spam.el hooks"
1264   (interactive)
1265   (remove-hook 'gnus-save-newsrc-hook 'spam-maybe-spam-stat-save)
1266   (remove-hook 'gnus-get-top-new-news-hook 'spam-maybe-spam-stat-load)
1267   (remove-hook 'gnus-startup-hook 'spam-maybe-spam-stat-load)
1268   (remove-hook 'gnus-summary-prepare-exit-hook 'spam-summary-prepare-exit)
1269   (remove-hook 'gnus-summary-prepare-hook 'spam-summary-prepare)
1270   (remove-hook 'gnus-get-new-news-hook 'spam-setup-widening))
1271
1272 (when spam-install-hooks
1273   (spam-initialize))
1274
1275 (provide 'spam)
1276
1277 ;;; spam.el ends here.