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

   1 ;;; spam.el --- Identifying spam
   2
   3 ;; Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
   4 ;;   Free Software Foundation, Inc.
   5
   6 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
   7 ;; Maintainer: Ted Zlatanov <tzz@lifelogs.com>
   8 ;; Keywords: network, spam, mail, bogofilter, BBDB, dspam, dig, whitelist, blacklist, gmane, hashcash, spamassassin, bsfilter, ifile, stat, crm114, spamoracle
   9
  10 ;; This file is part of GNU Emacs.
  11
  12 ;; GNU Emacs is free software: you can redistribute it and/or modify
  13 ;; it under the terms of the GNU General Public License as published by
  14 ;; the Free Software Foundation, either version 3 of the License, or
  15 ;; (at your option) any later version.
  16
  17 ;; GNU Emacs is distributed in the hope that it will be useful,
  18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 ;; GNU General Public License for more details.
  21
  22 ;; You should have received a copy of the GNU General Public License
  23 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  24
  25 ;;; Commentary:
  26
  27 ;;; This module addresses a few aspects of spam control under Gnus.  Page
  28 ;;; breaks are used for grouping declarations and documentation relating to
  29 ;;; each particular aspect.
  30
  31 ;;; The integration with Gnus is not yet complete.  See various `FIXME'
  32 ;;; comments, below, for supplementary explanations or discussions.
  33
  34 ;;; Several TODO items are marked as such
  35
  36 ;; TODO: cross-server splitting, remote processing, training through files
  37
  38 ;;; Code:
  39
  40 ;;{{{ compilation directives and autoloads/requires
  41
  42 ;; For Emacs <22.2 and XEmacs.
  43 (eval-and-compile
  44   (unless (fboundp 'declare-function) (defmacro declare-function (&rest r))))
  45
  46 (eval-when-compile (require 'cl))
  47
  48 (require 'message)              ;for the message-fetch-field functions
  49 (require 'gnus-sum)
  50 (require 'gnus-uu)                      ; because of key prefix issues
  51 ;;; for the definitions of group content classification and spam processors
  52 (require 'gnus)
  53
  54 (eval-when-compile (require 'spam-report))
  55 (eval-when-compile (require 'hashcash))
  56
  57 ;; for nnimap-split-download-body-default
  58 (eval-when-compile (require 'nnimap))
  59
  60 ;; autoload query-dig
  61 (autoload 'query-dig "dig")
  62
  63 ;; autoload spam-report
  64 (eval-and-compile
  65   (autoload 'spam-report-gmane "spam-report")
  66   (autoload 'spam-report-gmane-spam "spam-report")
  67   (autoload 'spam-report-gmane-ham "spam-report")
  68   (autoload 'spam-report-resend "spam-report"))
  69
  70 ;; autoload gnus-registry
  71 (autoload 'gnus-registry-group-count "gnus-registry")
  72 (autoload 'gnus-registry-add-group "gnus-registry")
  73 (autoload 'gnus-registry-store-extra-entry "gnus-registry")
  74 (autoload 'gnus-registry-fetch-extra "gnus-registry")
  75
  76 ;; autoload dns-query
  77 (autoload 'dns-query "dns")
  78
  79 ;;}}}
  80
  81 ;;{{{ Main parameters.
  82 (defvar spam-backends nil
  83   "List of spam.el backends with all the pertinent data.
  84 Populated by `spam-install-backend-super'.")
  85
  86 (defgroup spam nil
  87   "Spam configuration."
  88   :version "22.1"
  89   :group 'mail
  90   :group 'news)
  91
  92 (defcustom spam-summary-exit-behavior 'default
  93   "Exit behavior at the time of summary exit.
  94 Note that setting the `spam-use-move' or `spam-use-copy' backends on
  95 a group through group/topic parameters overrides this mechanism."
  96   :type '(choice (const 'default :tag
  97                         "Move spam out of all groups.  Move ham out of spam groups.")
  98                  (const 'move-all :tag
  99                         "Move spam out of all groups.  Move ham out of all groups.")
 100                  (const 'move-none :tag
 101                         "Never move spam or ham out of any groups."))
 102   :group 'spam)
 103
 104 (defcustom spam-directory (nnheader-concat gnus-directory "spam/")
 105   "Directory for spam whitelists and blacklists."
 106   :type 'directory
 107   :group 'spam)
 108
 109 (defcustom spam-mark-new-messages-in-spam-group-as-spam t
 110   "Whether new messages in a spam group should get the spam-mark."
 111   :type 'boolean
 112   ;; :version "22.1" ;; Gnus 5.10.8 / No Gnus 0.3
 113   :group 'spam)
 114
 115 (defcustom spam-log-to-registry nil
 116   "Whether spam/ham processing should be logged in the registry."
 117   :type 'boolean
 118   :group 'spam)
 119
 120 (defcustom spam-split-symbolic-return nil
 121   "Whether `spam-split' should work with symbols or group names."
 122   :type 'boolean
 123   :group 'spam)
 124
 125 (defcustom spam-split-symbolic-return-positive nil
 126   "Whether `spam-split' should ALWAYS work with symbols or group names.
 127 Do not set this if you use `spam-split' in a fancy split method."
 128   :type 'boolean
 129   :group 'spam)
 130
 131 (defcustom spam-mark-only-unseen-as-spam t
 132   "Whether only unseen articles should be marked as spam in spam groups.
 133 When nil, all unread articles in a spam group are marked as
 134 spam.  Set this if you want to leave an article unread in a spam group
 135 without losing it to the automatic spam-marking process."
 136   :type 'boolean
 137   :group 'spam)
 138
 139 (defcustom spam-mark-ham-unread-before-move-from-spam-group nil
 140   "Whether ham should be marked unread before it's moved.
 141 The article is moved out of a spam group according to `ham-process-destination'.
 142 This variable is an official entry in the international Longest Variable Name
 143 Competition."
 144   :type 'boolean
 145   :group 'spam)
 146
 147 (defcustom spam-disable-spam-split-during-ham-respool nil
 148   "Whether `spam-split' should be ignored while resplitting ham.
 149 This is useful to prevent ham from ending up in the same spam
 150 group after the resplit.  Don't set this to t if you have `spam-split' as the
 151 last rule in your split configuration."
 152   :type 'boolean
 153   :group 'spam)
 154
 155 (defcustom spam-autodetect-recheck-messages nil
 156   "Should spam.el recheck all meessages when autodetecting?
 157 Normally this is nil, so only unseen messages will be checked."
 158   :type 'boolean
 159   :group 'spam)
 160
 161 (defcustom spam-whitelist (expand-file-name "whitelist" spam-directory)
 162   "The location of the whitelist.
 163 The file format is one regular expression per line.
 164 The regular expression is matched against the address."
 165   :type 'file
 166   :group 'spam)
 167
 168 (defcustom spam-blacklist (expand-file-name "blacklist" spam-directory)
 169   "The location of the blacklist.
 170 The file format is one regular expression per line.
 171 The regular expression is matched against the address."
 172   :type 'file
 173   :group 'spam)
 174
 175 (defcustom spam-use-dig t
 176   "Whether `query-dig' should be used instead of `dns-query'."
 177   :type 'boolean
 178   :group 'spam)
 179
 180 (defcustom spam-use-gmane-xref nil
 181   "Whether the Gmane spam xref should be used by `spam-split'."
 182   :type 'boolean
 183   :group 'spam)
 184
 185 (defcustom spam-use-blacklist nil
 186   "Whether the blacklist should be used by `spam-split'."
 187   :type 'boolean
 188   :group 'spam)
 189
 190 (defcustom spam-blacklist-ignored-regexes nil
 191   "Regular expressions that the blacklist should ignore."
 192   :type '(repeat (regexp :tag "Regular expression to ignore when blacklisting"))
 193   :group 'spam)
 194
 195 (defcustom spam-use-whitelist nil
 196   "Whether the whitelist should be used by `spam-split'."
 197   :type 'boolean
 198   :group 'spam)
 199
 200 (defcustom spam-use-whitelist-exclusive nil
 201   "Whether whitelist-exclusive should be used by `spam-split'.
 202 Exclusive whitelisting means that all messages from senders not in the whitelist
 203 are considered spam."
 204   :type 'boolean
 205   :group 'spam)
 206
 207 (defcustom spam-use-blackholes nil
 208   "Whether blackholes should be used by `spam-split'."
 209   :type 'boolean
 210   :group 'spam)
 211
 212 (defcustom spam-use-hashcash nil
 213   "Whether hashcash payments should be detected by `spam-split'."
 214   :type 'boolean
 215   :group 'spam)
 216
 217 (defcustom spam-use-regex-headers nil
 218   "Whether a header regular expression match should be used by `spam-split'.
 219 Also see the variables `spam-regex-headers-spam' and `spam-regex-headers-ham'."
 220   :type 'boolean
 221   :group 'spam)
 222
 223 (defcustom spam-use-regex-body nil
 224   "Whether a body regular expression match should be used by `spam-split'.
 225 Also see the variables `spam-regex-body-spam' and `spam-regex-body-ham'."
 226   :type 'boolean
 227   :group 'spam)
 228
 229 (defcustom spam-use-bogofilter-headers nil
 230   "Whether bogofilter headers should be used by `spam-split'.
 231 Enable this if you pre-process messages with Bogofilter BEFORE Gnus sees them."
 232   :type 'boolean
 233   :group 'spam)
 234
 235 (defcustom spam-use-bogofilter nil
 236   "Whether bogofilter should be invoked by `spam-split'.
 237 Enable this if you want Gnus to invoke Bogofilter on new messages."
 238   :type 'boolean
 239   :group 'spam)
 240
 241 (defcustom spam-use-bsfilter-headers nil
 242   "Whether bsfilter headers should be used by `spam-split'.
 243 Enable this if you pre-process messages with Bsfilter BEFORE Gnus sees them."
 244   :type 'boolean
 245   :group 'spam)
 246
 247 (defcustom spam-use-bsfilter nil
 248   "Whether bsfilter should be invoked by `spam-split'.
 249 Enable this if you want Gnus to invoke Bsfilter on new messages."
 250   :type 'boolean
 251   :group 'spam)
 252
 253 (defcustom spam-use-BBDB nil
 254   "Whether BBDB should be used by `spam-split'."
 255   :type 'boolean
 256   :group 'spam)
 257
 258 (defcustom spam-use-BBDB-exclusive nil
 259   "Whether BBDB-exclusive should be used by `spam-split'.
 260 Exclusive BBDB means that all messages from senders not in the BBDB are
 261 considered spam."
 262   :type 'boolean
 263   :group 'spam)
 264
 265 (defcustom spam-use-ifile nil
 266   "Whether ifile should be used by `spam-split'."
 267   :type 'boolean
 268   :group 'spam)
 269
 270 (defcustom spam-use-stat nil
 271   "Whether `spam-stat' should be used by `spam-split'."
 272   :type 'boolean
 273   :group 'spam)
 274
 275 (defcustom spam-use-spamoracle nil
 276   "Whether spamoracle should be used by `spam-split'."
 277   :type 'boolean
 278   :group 'spam)
 279
 280 (defcustom spam-use-spamassassin nil
 281   "Whether spamassassin should be invoked by `spam-split'.
 282 Enable this if you want Gnus to invoke SpamAssassin on new messages."
 283   :type 'boolean
 284   :group 'spam)
 285
 286 (defcustom spam-use-spamassassin-headers nil
 287   "Whether spamassassin headers should be checked by `spam-split'.
 288 Enable this if you pre-process messages with SpamAssassin BEFORE Gnus sees
 289 them."
 290   :type 'boolean
 291   :group 'spam)
 292
 293 (defcustom spam-use-crm114 nil
 294   "Whether the CRM114 Mailfilter should be used by `spam-split'."
 295   :type 'boolean
 296   :group 'spam)
 297
 298 (defcustom spam-install-hooks (or
 299                                spam-use-dig
 300                                spam-use-gmane-xref
 301                                spam-use-blacklist
 302                                spam-use-whitelist
 303                                spam-use-whitelist-exclusive
 304                                spam-use-blackholes
 305                                spam-use-hashcash
 306                                spam-use-regex-headers
 307                                spam-use-regex-body
 308                                spam-use-bogofilter
 309                                spam-use-bogofilter-headers
 310                                spam-use-spamassassin
 311                                spam-use-spamassassin-headers
 312                                spam-use-bsfilter
 313                                spam-use-bsfilter-headers
 314                                spam-use-BBDB
 315                                spam-use-BBDB-exclusive
 316                                spam-use-ifile
 317                                spam-use-stat
 318                                spam-use-spamoracle
 319                                spam-use-crm114)
 320   "Whether the spam hooks should be installed.
 321 Default to t if one of the spam-use-* variables is set."
 322   :group 'spam
 323   :type 'boolean)
 324
 325 (defcustom spam-split-group "spam"
 326   "Group name where incoming spam should be put by `spam-split'."
 327   :type 'string
 328   :group 'spam)
 329
 330 ;;; TODO: deprecate this variable, it's confusing since it's a list of strings,
 331 ;;; not regular expressions
 332 (defcustom spam-junk-mailgroups (cons
 333                                  spam-split-group
 334                                  '("mail.junk" "poste.pourriel"))
 335   "Mailgroups with spam contents.
 336 All unmarked article in such group receive the spam mark on group entry."
 337   :type '(repeat (string :tag "Group"))
 338   :group 'spam)
 339
 340
 341 (defcustom spam-gmane-xref-spam-group "gmane.spam.detected"
 342   "The group where spam xrefs can be found on Gmane.
 343 Only meaningful if you enable `spam-use-gmane-xref'."
 344   :type 'string
 345   :group 'spam)
 346
 347 (defcustom spam-blackhole-servers '("bl.spamcop.net" "relays.ordb.org"
 348                                     "dev.null.dk" "relays.visi.com")
 349   "List of blackhole servers.
 350 Only meaningful if you enable `spam-use-blackholes'."
 351   :type '(repeat (string :tag "Server"))
 352   :group 'spam)
 353
 354 (defcustom spam-blackhole-good-server-regex nil
 355   "String matching IP addresses that should not be checked in the blackholes.
 356 Only meaningful if you enable `spam-use-blackholes'."
 357   :type '(radio (const nil) regexp)
 358   :group 'spam)
 359
 360 (defface spam
 361   '((((class color) (type tty) (background dark))
 362      (:foreground "gray80" :background "gray50"))
 363     (((class color) (type tty) (background light))
 364      (:foreground "gray50" :background "gray80"))
 365     (((class color) (background dark))
 366      (:foreground "ivory2"))
 367     (((class color) (background light))
 368      (:foreground "ivory4"))
 369     (t :inverse-video t))
 370   "Face for spam-marked articles."
 371   :group 'spam)
 372 ;; backward-compatibility alias
 373 (put 'spam-face 'face-alias 'spam)
 374 (put 'spam-face 'obsolete-face "22.1")
 375
 376 (defcustom spam-face 'spam
 377   "Face for spam-marked articles."
 378   :type 'face
 379   :group 'spam)
 380
 381 (defcustom spam-regex-headers-spam '("^X-Spam-Flag: YES")
 382   "Regular expression for positive header spam matches.
 383 Only meaningful if you enable `spam-use-regex-headers'."
 384   :type '(repeat (regexp :tag "Regular expression to match spam header"))
 385   :group 'spam)
 386
 387 (defcustom spam-regex-headers-ham '("^X-Spam-Flag: NO")
 388   "Regular expression for positive header ham matches.
 389 Only meaningful if you enable `spam-use-regex-headers'."
 390   :type '(repeat (regexp :tag "Regular expression to match ham header"))
 391   :group 'spam)
 392
 393 (defcustom spam-regex-body-spam '()
 394   "Regular expression for positive body spam matches.
 395 Only meaningful if you enable `spam-use-regex-body'."
 396   :type '(repeat (regexp :tag "Regular expression to match spam body"))
 397   :group 'spam)
 398
 399 (defcustom spam-regex-body-ham '()
 400   "Regular expression for positive body ham matches.
 401 Only meaningful if you enable `spam-use-regex-body'."
 402   :type '(repeat (regexp :tag "Regular expression to match ham body"))
 403   :group 'spam)
 404
 405 (defcustom spam-summary-score-preferred-header nil
 406   "Preferred header to use for `spam-summary-score'."
 407   :type '(choice :tag "Header name"
 408           (symbol :tag "SpamAssassin etc" X-Spam-Status)
 409           (symbol :tag "Bogofilter"       X-Bogosity)
 410           (const  :tag "No preference, take best guess." nil))
 411   :group 'spam)
 412
 413 (defgroup spam-ifile nil
 414   "Spam ifile configuration."
 415   :group 'spam)
 416
 417 (make-obsolete-variable 'spam-ifile-path 'spam-ifile-program
 418                         "Gnus 5.10.9 (Emacs 22.1)")
 419 (defcustom spam-ifile-program (executable-find "ifile")
 420   "Name of the ifile program."
 421   :type '(choice (file :tag "Location of ifile")
 422                  (const :tag "ifile is not installed"))
 423   :group 'spam-ifile)
 424
 425 (make-obsolete-variable 'spam-ifile-database-path 'spam-ifile-database
 426                         "Gnus 5.10.9 (Emacs 22.1)")
 427 (defcustom spam-ifile-database nil
 428   "File name of the ifile database."
 429   :type '(choice (file :tag "Location of the ifile database")
 430                  (const :tag "Use the default"))
 431   :group 'spam-ifile)
 432
 433 (defcustom spam-ifile-spam-category "spam"
 434   "Name of the spam ifile category."
 435   :type 'string
 436   :group 'spam-ifile)
 437
 438 (defcustom spam-ifile-ham-category nil
 439   "Name of the ham ifile category.
 440 If nil, the current group name will be used."
 441   :type '(choice (string :tag "Use a fixed category")
 442                  (const :tag "Use the current group name"))
 443   :group 'spam-ifile)
 444
 445 (defcustom spam-ifile-all-categories nil
 446   "Whether the ifile check will return all categories, or just spam.
 447 Set this to t if you want to use the `spam-split' invocation of ifile as
 448 your main source of newsgroup names."
 449   :type 'boolean
 450   :group 'spam-ifile)
 451
 452 (defgroup spam-bogofilter nil
 453   "Spam bogofilter configuration."
 454   :group 'spam)
 455
 456 (make-obsolete-variable 'spam-bogofilter-path 'spam-bogofilter-program
 457                         "Gnus 5.10.9 (Emacs 22.1)")
 458 (defcustom spam-bogofilter-program (executable-find "bogofilter")
 459   "Name of the Bogofilter program."
 460   :type '(choice (file :tag "Location of bogofilter")
 461                  (const :tag "Bogofilter is not installed"))
 462   :group 'spam-bogofilter)
 463
 464 (defvar spam-bogofilter-valid 'unknown "Is the bogofilter version valid?")
 465
 466 (defcustom spam-bogofilter-header "X-Bogosity"
 467   "The header that Bogofilter inserts in messages."
 468   :type 'string
 469   :group 'spam-bogofilter)
 470
 471 (defcustom spam-bogofilter-spam-switch "-s"
 472   "The switch that Bogofilter uses to register spam messages."
 473   :type 'string
 474   :group 'spam-bogofilter)
 475
 476 (defcustom spam-bogofilter-ham-switch "-n"
 477   "The switch that Bogofilter uses to register ham messages."
 478   :type 'string
 479   :group 'spam-bogofilter)
 480
 481 (defcustom spam-bogofilter-spam-strong-switch "-S"
 482   "The switch that Bogofilter uses to unregister ham messages."
 483   :type 'string
 484   :group 'spam-bogofilter)
 485
 486 (defcustom spam-bogofilter-ham-strong-switch "-N"
 487   "The switch that Bogofilter uses to unregister spam messages."
 488   :type 'string
 489   :group 'spam-bogofilter)
 490
 491 (defcustom spam-bogofilter-bogosity-positive-spam-header "^\\(Yes\\|Spam\\)"
 492   "The regex on `spam-bogofilter-header' for positive spam identification."
 493   :type 'regexp
 494   :group 'spam-bogofilter)
 495
 496 (defcustom spam-bogofilter-database-directory nil
 497   "Location of the Bogofilter database.
 498 When nil, use the default location."
 499   :type '(choice (directory
 500                   :tag "Location of the Bogofilter database directory")
 501                  (const :tag "Use the default"))
 502   :group 'spam-bogofilter)
 503
 504 (defgroup spam-bsfilter nil
 505   "Spam bsfilter configuration."
 506   :group 'spam)
 507
 508 (make-obsolete-variable 'spam-bsfilter-path 'spam-bsfilter-program
 509                         "Gnus 5.10.9 (Emacs 22.1)")
 510 (defcustom spam-bsfilter-program (executable-find "bsfilter")
 511   "Name of the Bsfilter program."
 512   :type '(choice (file :tag "Location of bsfilter")
 513                  (const :tag "Bsfilter is not installed"))
 514   :group 'spam-bsfilter)
 515
 516 (defcustom spam-bsfilter-header "X-Spam-Flag"
 517   "The header inserted by Bsfilter to flag spam."
 518   :type 'string
 519   :group 'spam-bsfilter)
 520
 521 (defcustom spam-bsfilter-probability-header "X-Spam-Probability"
 522   "The header that Bsfilter inserts in messages."
 523   :type 'string
 524   :group 'spam-bsfilter)
 525
 526 (defcustom spam-bsfilter-spam-switch "--add-spam"
 527   "The switch that Bsfilter uses to register spam messages."
 528   :type 'string
 529   :group 'spam-bsfilter)
 530
 531 (defcustom spam-bsfilter-ham-switch "--add-clean"
 532   "The switch that Bsfilter uses to register ham messages."
 533   :type 'string
 534   :group 'spam-bsfilter)
 535
 536 (defcustom spam-bsfilter-spam-strong-switch "--sub-spam"
 537   "The switch that Bsfilter uses to unregister ham messages."
 538   :type 'string
 539   :group 'spam-bsfilter)
 540
 541 (defcustom spam-bsfilter-ham-strong-switch "--sub-clean"
 542   "The switch that Bsfilter uses to unregister spam messages."
 543   :type 'string
 544   :group 'spam-bsfilter)
 545
 546 (defcustom spam-bsfilter-database-directory nil
 547   "Directory path of the Bsfilter databases."
 548   :type '(choice (directory
 549                   :tag "Location of the Bsfilter database directory")
 550                  (const :tag "Use the default"))
 551   :group 'spam-bsfilter)
 552
 553 (defgroup spam-spamoracle nil
 554   "Spam spamoracle configuration."
 555   :group 'spam)
 556
 557 (defcustom spam-spamoracle-database nil
 558   "Location of spamoracle database file.
 559 When nil, use the default spamoracle database."
 560   :type '(choice (directory :tag "Location of spamoracle database file.")
 561                  (const :tag "Use the default"))
 562   :group 'spam-spamoracle)
 563
 564 (defcustom spam-spamoracle-binary (executable-find "spamoracle")
 565   "Location of the spamoracle binary."
 566   :type '(choice (directory :tag "Location of the spamoracle binary")
 567                  (const :tag "Use the default"))
 568   :group 'spam-spamoracle)
 569
 570 (defgroup spam-spamassassin nil
 571   "Spam SpamAssassin configuration."
 572   :group 'spam)
 573
 574 (make-obsolete-variable 'spam-spamassassin-path
 575   'spam-spamassassin-program "Gnus 5.10.9 (Emacs 22.1)")
 576 (defcustom spam-assassin-program (executable-find "spamassassin")
 577   "Name of the spamassassin program.
 578 Hint: set this to \"spamc\" if you have spamd running.  See the spamc and
 579 spamd man pages for more information on these programs."
 580   :type '(choice (file :tag "Location of spamc")
 581                  (const :tag "spamassassin is not installed"))
 582   :group 'spam-spamassassin)
 583
 584 (defcustom spam-spamassassin-arguments ()
 585   "Arguments to pass to the spamassassin executable.
 586 This must be a list.  For example, `(\"-C\" \"configfile\")'."
 587   :type '(restricted-sexp :match-alternatives (listp))
 588   :group 'spam-spamassassin)
 589
 590 (defcustom spam-spamassassin-spam-flag-header "X-Spam-Flag"
 591   "The header inserted by SpamAssassin to flag spam."
 592   :type 'string
 593   :group 'spam-spamassassin)
 594
 595 (defcustom spam-spamassassin-positive-spam-flag-header "YES"
 596   "The regex on `spam-spamassassin-spam-flag-header' for positive spam
 597 identification"
 598   :type 'string
 599   :group 'spam-spamassassin)
 600
 601 (defcustom spam-spamassassin-spam-status-header "X-Spam-Status"
 602   "The header inserted by SpamAssassin, giving extended scoring information"
 603   :type 'string
 604   :group 'spam-spamassassin)
 605
 606 (make-obsolete-variable 'spam-sa-learn-path 'spam-sa-learn-program
 607                         "Gnus 5.10.9 (Emacs 22.1)")
 608 (defcustom spam-sa-learn-program (executable-find "sa-learn")
 609   "Name of the sa-learn program."
 610   :type '(choice (file :tag "Location of spamassassin")
 611                  (const :tag "spamassassin is not installed"))
 612   :group 'spam-spamassassin)
 613
 614 (defcustom spam-sa-learn-rebuild t
 615   "Whether sa-learn should rebuild the database every time it is called
 616 Enable this if you want sa-learn to rebuild the database automatically.  Doing
 617 this will slightly increase the running time of the spam registration process.
 618 If you choose not to do this, you will have to run \"sa-learn --rebuild\" in
 619 order for SpamAssassin to recognize the new registered spam."
 620   :type 'boolean
 621   :group 'spam-spamassassin)
 622
 623 (defcustom spam-sa-learn-spam-switch "--spam"
 624   "The switch that sa-learn uses to register spam messages."
 625   :type 'string
 626   :group 'spam-spamassassin)
 627
 628 (defcustom spam-sa-learn-ham-switch "--ham"
 629   "The switch that sa-learn uses to register ham messages."
 630   :type 'string
 631   :group 'spam-spamassassin)
 632
 633 (defcustom spam-sa-learn-unregister-switch "--forget"
 634   "The switch that sa-learn uses to unregister messages messages."
 635   :type 'string
 636   :group 'spam-spamassassin)
 637
 638 (defgroup spam-crm114 nil
 639   "Spam CRM114 Mailfilter configuration."
 640   :group 'spam)
 641
 642 (defcustom spam-crm114-program (executable-find "mailfilter.crm")
 643   "File path of the CRM114 Mailfilter executable program."
 644   :type '(choice (file :tag "Location of CRM114 Mailfilter")
 645          (const :tag "CRM114 Mailfilter is not installed"))
 646   :group 'spam-crm114)
 647
 648 (defcustom spam-crm114-header "X-CRM114-Status"
 649   "The header that CRM114 Mailfilter inserts in messages."
 650   :type 'string
 651   :group 'spam-crm114)
 652
 653 (defcustom spam-crm114-spam-switch "--learnspam"
 654   "The switch that CRM114 Mailfilter uses to register spam messages."
 655   :type 'string
 656   :group 'spam-crm114)
 657
 658 (defcustom spam-crm114-ham-switch "--learnnonspam"
 659   "The switch that CRM114 Mailfilter uses to register ham messages."
 660   :type 'string
 661   :group 'spam-crm114)
 662
 663 (defcustom spam-crm114-spam-strong-switch "--unlearn"
 664   "The switch that CRM114 Mailfilter uses to unregister ham messages."
 665   :type 'string
 666   :group 'spam-crm114)
 667
 668 (defcustom spam-crm114-ham-strong-switch "--unlearn"
 669   "The switch that CRM114 Mailfilter uses to unregister spam messages."
 670   :type 'string
 671   :group 'spam-crm114)
 672
 673 (defcustom spam-crm114-positive-spam-header "^SPAM"
 674   "The regex on `spam-crm114-header' for positive spam identification."
 675   :type 'regexp
 676   :group 'spam-crm114)
 677
 678 (defcustom spam-crm114-database-directory nil
 679   "Directory path of the CRM114 Mailfilter databases."
 680   :type '(choice (directory
 681           :tag "Location of the CRM114 Mailfilter database directory")
 682          (const :tag "Use the default"))
 683   :group 'spam-crm114)
 684
 685 ;;; Key bindings for spam control.
 686
 687 (gnus-define-keys gnus-summary-mode-map
 688   "St" spam-generic-score
 689   "Sx" gnus-summary-mark-as-spam
 690   "Mst" spam-generic-score
 691   "Msx" gnus-summary-mark-as-spam
 692   "\M-d" gnus-summary-mark-as-spam
 693   "$" gnus-summary-mark-as-spam)
 694
 695 (defvar spam-cache-lookups t
 696   "Whether spam.el will try to cache lookups using `spam-caches'.")
 697
 698 (defvar spam-caches (make-hash-table
 699                      :size 10
 700                      :test 'equal)
 701   "Cache of spam detection entries.")
 702
 703 (defvar spam-old-articles nil
 704   "List of old ham and spam articles, generated when a group is entered.")
 705
 706 (defvar spam-split-disabled nil
 707   "If non-nil, `spam-split' is disabled, and always returns nil.")
 708
 709 (defvar spam-split-last-successful-check nil
 710   "Internal variable.
 711 `spam-split' will set this to nil or a spam-use-XYZ check if it
 712 finds ham or spam.")
 713
 714 ;; internal variables for backends
 715 ;; TODO: find a way to create these on the fly in spam-install-backend-super
 716 (defvar spam-use-copy nil)
 717 (defvar spam-use-move nil)
 718 (defvar spam-use-gmane nil)
 719 (defvar spam-use-resend nil)
 720
 721 ;;}}}
 722
 723 ;;{{{ convenience functions
 724
 725 (defun spam-clear-cache (symbol)
 726   "Clear the `spam-caches' entry for a check."
 727   (remhash symbol spam-caches))
 728
 729 (defun spam-xor (a b)
 730   "Logical A xor B."
 731   (and (or a b) (not (and a b))))
 732
 733 (defun spam-set-difference (list1 list2)
 734   "Return a set difference of LIST1 and LIST2.
 735 When either list is nil, the other is returned."
 736   (if (and list1 list2)
 737       ;; we have two non-nil lists
 738       (progn
 739         (dolist (item (append list1 list2))
 740           (when (and (memq item list1) (memq item list2))
 741             (setq list1 (delq item list1))
 742             (setq list2 (delq item list2))))
 743         (append list1 list2))
 744     ;; if either of the lists was nil, return the other one
 745     (if list1 list1 list2)))
 746
 747 (defun spam-group-ham-mark-p (group mark &optional spam)
 748   "Checks if MARK is considered a ham mark in GROUP."
 749   (when (stringp group)
 750     (let* ((marks (spam-group-ham-marks group spam))
 751            (marks (if (symbolp mark)
 752                       marks
 753                     (mapcar 'symbol-value marks))))
 754       (memq mark marks))))
 755
 756 (defun spam-group-spam-mark-p (group mark)
 757   "Checks if MARK is considered a spam mark in GROUP."
 758   (spam-group-ham-mark-p group mark t))
 759
 760 (defun spam-group-ham-marks (group &optional spam)
 761   "In GROUP, get all the ham marks."
 762   (when (stringp group)
 763     (let* ((marks (if spam
 764                       (gnus-parameter-spam-marks group)
 765                     (gnus-parameter-ham-marks group)))
 766            (marks (car marks))
 767            (marks (if (listp (car marks)) (car marks) marks)))
 768       marks)))
 769
 770 (defun spam-group-spam-marks (group)
 771   "In GROUP, get all the spam marks."
 772   (spam-group-ham-marks group t))
 773
 774 (defun spam-group-spam-contents-p (group)
 775   "Is GROUP a spam group?"
 776   (if (and (stringp group) (< 0 (length group)))
 777       (or (member group spam-junk-mailgroups)
 778           (memq 'gnus-group-spam-classification-spam
 779                 (gnus-parameter-spam-contents group)))
 780     nil))
 781
 782 (defun spam-group-ham-contents-p (group)
 783   "Is GROUP a ham group?"
 784   (if (stringp group)
 785       (memq 'gnus-group-spam-classification-ham
 786             (gnus-parameter-spam-contents group))
 787     nil))
 788
 789 (defun spam-classifications ()
 790   "Return list of valid classifications"
 791   '(spam ham))
 792
 793 (defun spam-classification-valid-p (classification)
 794   "Is CLASSIFICATION a valid spam/ham classification?"
 795   (memq classification (spam-classifications)))
 796
 797 (defun spam-backend-properties ()
 798   "Return list of valid classifications."
 799   '(statistical mover check hrf srf huf suf))
 800
 801 (defun spam-backend-property-valid-p (property)
 802   "Is PROPERTY a valid backend property?"
 803   (memq property (spam-backend-properties)))
 804
 805 (defun spam-backend-function-type-valid-p (type)
 806   (or (eq type 'registration)
 807       (eq type 'unregistration)))
 808
 809 (defun spam-process-type-valid-p (process-type)
 810   (or (eq process-type 'incoming)
 811       (eq process-type 'process)))
 812
 813 (defun spam-list-articles (articles classification)
 814   (let ((mark-check (if (eq classification 'spam)
 815                         'spam-group-spam-mark-p
 816                       'spam-group-ham-mark-p))
 817         alist mark-cache-yes mark-cache-no)
 818     (dolist (article articles)
 819       (let ((mark (gnus-summary-article-mark article)))
 820         (unless (or (memq mark mark-cache-yes)
 821                     (memq mark mark-cache-no))
 822           (if (funcall mark-check
 823                        gnus-newsgroup-name
 824                        mark)
 825               (push mark mark-cache-yes)
 826             (push mark mark-cache-no)))
 827         (when (memq mark mark-cache-yes)
 828           (push article alist))))
 829     alist))
 830
 831 ;;}}}
 832
 833 ;;{{{ backend installation functions and procedures
 834
 835 (defun spam-install-backend-super (backend &rest properties)
 836   "Install BACKEND for spam.el.
 837 Accepts incoming CHECK, ham registration function HRF, spam
 838 registration function SRF, ham unregistration function HUF, spam
 839 unregistration function SUF, and an indication whether the
 840 backend is STATISTICAL."
 841   (setq spam-backends (add-to-list 'spam-backends backend))
 842   (while properties
 843     (let ((property (pop properties))
 844           (value (pop properties)))
 845       (if (spam-backend-property-valid-p property)
 846           (put backend property value)
 847         (gnus-error
 848          5
 849          "spam-install-backend-super got an invalid property %s"
 850          property)))))
 851
 852 (defun spam-backend-list (&optional type)
 853   "Return a list of all the backend symbols, constrained by TYPE.
 854 When TYPE is 'non-mover, only non-mover backends are returned.
 855 When TYPE is 'mover, only mover backends are returned."
 856   (let (list)
 857     (dolist (backend spam-backends)
 858       (when (or
 859              (null type)                ;either no type was requested
 860              ;; or the type is 'mover and the backend is a mover
 861              (and
 862               (eq type 'mover)
 863               (spam-backend-mover-p backend))
 864              ;; or the type is 'non-mover and the backend is not a mover
 865              (and
 866               (eq type 'non-mover)
 867               (not (spam-backend-mover-p backend))))
 868         (push backend list)))
 869       list))
 870
 871 (defun spam-backend-check (backend)
 872   "Get the check function for BACKEND.
 873 Each individual check may return nil, t, or a mailgroup name.
 874 The value nil means that the check does not yield a decision, and
 875 so, that further checks are needed.  The value t means that the
 876 message is definitely not spam, and that further spam checks
 877 should be inhibited.  Otherwise, a mailgroup name or the symbol
 878 'spam (depending on `spam-split-symbolic-return') is returned where
 879 the mail should go, and further checks are also inhibited.  The
 880 usual mailgroup name is the value of `spam-split-group', meaning
 881 that the message is definitely a spam."
 882   (get backend 'check))
 883
 884 (defun spam-backend-valid-p (backend)
 885   "Is BACKEND valid?"
 886   (member backend (spam-backend-list)))
 887
 888 (defun spam-backend-info (backend)
 889   "Return information about BACKEND."
 890   (if (spam-backend-valid-p backend)
 891       (let (info)
 892         (setq info (format "Backend %s has the following properties:\n"
 893                            backend))
 894         (dolist (property (spam-backend-properties))
 895           (setq info (format "%s%s=%s\n"
 896                              info
 897                              property
 898                              (get backend property))))
 899         info)
 900     (gnus-error 5 "spam-backend-info was asked about an invalid backend %s"
 901                 backend)))
 902
 903 (defun spam-backend-function (backend classification type)
 904   "Get the BACKEND function for CLASSIFICATION and TYPE.
 905 TYPE is 'registration or 'unregistration.
 906 CLASSIFICATION is 'ham or 'spam."
 907   (if (and
 908        (spam-classification-valid-p classification)
 909        (spam-backend-function-type-valid-p type))
 910       (let ((retrieval
 911              (intern
 912               (format "spam-backend-%s-%s-function"
 913                       classification
 914                       type))))
 915         (funcall retrieval backend))
 916     (gnus-error
 917      5
 918      "%s was passed invalid backend %s, classification %s, or type %s"
 919      "spam-backend-function"
 920      backend
 921      classification
 922      type)))
 923
 924 (defun spam-backend-article-list-property (classification
 925                                            &optional unregister)
 926   "Property name of article list with CLASSIFICATION and UNREGISTER."
 927   (let* ((r (if unregister "unregister" "register"))
 928          (prop (format "%s-%s" classification r)))
 929     prop))
 930
 931 (defun spam-backend-get-article-todo-list (backend
 932                                            classification
 933                                            &optional unregister)
 934   "Get the articles to be processed for BACKEND and CLASSIFICATION.
 935 With UNREGISTER, get articles to be unregistered.
 936 This is a temporary storage function - nothing here persists."
 937   (get
 938    backend
 939    (intern (spam-backend-article-list-property classification unregister))))
 940
 941 (defun spam-backend-put-article-todo-list (backend classification list &optional unregister)
 942   "Set the LIST of articles to be processed for BACKEND and CLASSIFICATION.
 943 With UNREGISTER, set articles to be unregistered.
 944 This is a temporary storage function - nothing here persists."
 945   (put
 946    backend
 947    (intern (spam-backend-article-list-property classification unregister))
 948    list))
 949
 950 (defun spam-backend-ham-registration-function (backend)
 951   "Get the ham registration function for BACKEND."
 952   (get backend 'hrf))
 953
 954 (defun spam-backend-spam-registration-function (backend)
 955   "Get the spam registration function for BACKEND."
 956   (get backend 'srf))
 957
 958 (defun spam-backend-ham-unregistration-function (backend)
 959   "Get the ham unregistration function for BACKEND."
 960   (get backend 'huf))
 961
 962 (defun spam-backend-spam-unregistration-function (backend)
 963   "Get the spam unregistration function for BACKEND."
 964   (get backend 'suf))
 965
 966 (defun spam-backend-statistical-p (backend)
 967   "Is BACKEND statistical?"
 968   (get backend 'statistical))
 969
 970 (defun spam-backend-mover-p (backend)
 971   "Is BACKEND a mover?"
 972   (get backend 'mover))
 973
 974 (defun spam-install-backend-alias (backend alias)
 975   "Add ALIAS to an existing BACKEND.
 976 The previous backend settings for ALIAS are erased."
 977
 978   ;; install alias with no properties at first
 979   (spam-install-backend-super alias)
 980
 981   (dolist (property (spam-backend-properties))
 982     (put alias property (get backend property))))
 983
 984 (defun spam-install-checkonly-backend (backend check)
 985   "Install a BACKEND than can only CHECK for spam."
 986   (spam-install-backend-super backend 'check check))
 987
 988 (defun spam-install-mover-backend (backend hrf srf huf suf)
 989   "Install a BACKEND than can move articles at summary exit.
 990 Accepts ham registration function HRF, spam registration function
 991 SRF, ham unregistration function HUF, spam unregistration
 992 function SUF.  The backend has no incoming check and can't be
 993 statistical."
 994   (spam-install-backend-super
 995    backend
 996    'hrf hrf 'srf srf 'huf huf 'suf suf 'mover t))
 997
 998 (defun spam-install-nocheck-backend (backend hrf srf huf suf)
 999   "Install a BACKEND than has no check.
1000 Accepts ham registration function HRF, spam registration function
1001 SRF, ham unregistration function HUF, spam unregistration
1002 function SUF.  The backend has no incoming check and can't be
1003 statistical (it could be, but in practice that doesn't happen)."
1004   (spam-install-backend-super
1005    backend
1006    'hrf hrf 'srf srf 'huf huf 'suf suf))
1007
1008 (defun spam-install-backend (backend check hrf srf huf suf)
1009   "Install a BACKEND.
1010 Accepts incoming CHECK, ham registration function HRF, spam
1011 registration function SRF, ham unregistration function HUF, spam
1012 unregistration function SUF.  The backend won't be
1013 statistical (use `spam-install-statistical-backend' for that)."
1014   (spam-install-backend-super
1015    backend
1016    'check check 'hrf hrf 'srf srf 'huf huf 'suf suf))
1017
1018 (defun spam-install-statistical-backend (backend check hrf srf huf suf)
1019   "Install a BACKEND.
1020 Accepts incoming CHECK, ham registration function HRF, spam
1021 registration function SRF, ham unregistration function HUF, spam
1022 unregistration function SUF.  The backend will be
1023 statistical (use `spam-install-backend' for non-statistical
1024 backends)."
1025   (spam-install-backend-super
1026    backend
1027    'check check 'statistical t 'hrf hrf 'srf srf 'huf huf 'suf suf))
1028
1029 (defun spam-install-statistical-checkonly-backend (backend check)
1030   "Install a statistical BACKEND than can only CHECK for spam."
1031   (spam-install-backend-super
1032    backend
1033    'check check 'statistical t))
1034
1035 ;;}}}
1036
1037 ;;{{{ backend installations
1038 (spam-install-checkonly-backend 'spam-use-blackholes
1039                                 'spam-check-blackholes)
1040
1041 (spam-install-checkonly-backend 'spam-use-hashcash
1042                                 'spam-check-hashcash)
1043
1044 (spam-install-checkonly-backend 'spam-use-spamassassin-headers
1045                                 'spam-check-spamassassin-headers)
1046
1047 (spam-install-checkonly-backend 'spam-use-bogofilter-headers
1048                                 'spam-check-bogofilter-headers)
1049
1050 (spam-install-checkonly-backend 'spam-use-bsfilter-headers
1051                                 'spam-check-bsfilter-headers)
1052
1053 (spam-install-checkonly-backend 'spam-use-gmane-xref
1054                                 'spam-check-gmane-xref)
1055
1056 (spam-install-checkonly-backend 'spam-use-regex-headers
1057                                 'spam-check-regex-headers)
1058
1059 (spam-install-statistical-checkonly-backend 'spam-use-regex-body
1060                                             'spam-check-regex-body)
1061
1062 ;; TODO: NOTE: spam-use-ham-copy is now obsolete, use (ham spam-use-copy) instead
1063 (spam-install-mover-backend 'spam-use-move
1064                             'spam-move-ham-routine
1065                             'spam-move-spam-routine
1066                             nil
1067                             nil)
1068
1069 (spam-install-nocheck-backend 'spam-use-copy
1070                               'spam-copy-ham-routine
1071                               'spam-copy-spam-routine
1072                               nil
1073                               nil)
1074
1075 (spam-install-nocheck-backend 'spam-use-gmane
1076                               'spam-report-gmane-unregister-routine
1077                               'spam-report-gmane-register-routine
1078                               'spam-report-gmane-register-routine
1079                               'spam-report-gmane-unregister-routine)
1080
1081 (spam-install-nocheck-backend 'spam-use-resend
1082                               'spam-report-resend-register-ham-routine
1083                               'spam-report-resend-register-routine
1084                               nil
1085                               nil)
1086
1087 (spam-install-backend 'spam-use-BBDB
1088                       'spam-check-BBDB
1089                       'spam-BBDB-register-routine
1090                       nil
1091                       'spam-BBDB-unregister-routine
1092                       nil)
1093
1094 (spam-install-backend-alias 'spam-use-BBDB 'spam-use-BBDB-exclusive)
1095
1096 (spam-install-backend 'spam-use-blacklist
1097                       'spam-check-blacklist
1098                       nil
1099                       'spam-blacklist-register-routine
1100                       nil
1101                       'spam-blacklist-unregister-routine)
1102
1103 (spam-install-backend 'spam-use-whitelist
1104                       'spam-check-whitelist
1105                       'spam-whitelist-register-routine
1106                       nil
1107                       'spam-whitelist-unregister-routine
1108                       nil)
1109
1110 (spam-install-statistical-backend 'spam-use-ifile
1111                                   'spam-check-ifile
1112                                   'spam-ifile-register-ham-routine
1113                                   'spam-ifile-register-spam-routine
1114                                   'spam-ifile-unregister-ham-routine
1115                                   'spam-ifile-unregister-spam-routine)
1116
1117 (spam-install-statistical-backend 'spam-use-spamoracle
1118                                   'spam-check-spamoracle
1119                                   'spam-spamoracle-learn-ham
1120                                   'spam-spamoracle-learn-spam
1121                                   'spam-spamoracle-unlearn-ham
1122                                   'spam-spamoracle-unlearn-spam)
1123
1124 (spam-install-statistical-backend 'spam-use-stat
1125                                   'spam-check-stat
1126                                   'spam-stat-register-ham-routine
1127                                   'spam-stat-register-spam-routine
1128                                   'spam-stat-unregister-ham-routine
1129                                   'spam-stat-unregister-spam-routine)
1130
1131 (spam-install-statistical-backend 'spam-use-spamassassin
1132                                   'spam-check-spamassassin
1133                                   'spam-spamassassin-register-ham-routine
1134                                   'spam-spamassassin-register-spam-routine
1135                                   'spam-spamassassin-unregister-ham-routine
1136                                   'spam-spamassassin-unregister-spam-routine)
1137
1138 (spam-install-statistical-backend 'spam-use-bogofilter
1139                                   'spam-check-bogofilter
1140                                   'spam-bogofilter-register-ham-routine
1141                                   'spam-bogofilter-register-spam-routine
1142                                   'spam-bogofilter-unregister-ham-routine
1143                                   'spam-bogofilter-unregister-spam-routine)
1144
1145 (spam-install-statistical-backend 'spam-use-bsfilter
1146                                   'spam-check-bsfilter
1147                                   'spam-bsfilter-register-ham-routine
1148                                   'spam-bsfilter-register-spam-routine
1149                                   'spam-bsfilter-unregister-ham-routine
1150                                   'spam-bsfilter-unregister-spam-routine)
1151
1152 (spam-install-statistical-backend 'spam-use-crm114
1153                                   'spam-check-crm114
1154                                   'spam-crm114-register-ham-routine
1155                                   'spam-crm114-register-spam-routine
1156                                   'spam-crm114-unregister-ham-routine
1157                                   'spam-crm114-unregister-spam-routine)
1158 ;;}}}
1159
1160 ;;{{{ scoring and summary formatting
1161 (defun spam-necessary-extra-headers ()
1162   "Return the extra headers spam.el thinks are necessary."
1163   (let (list)
1164     (when (or spam-use-spamassassin
1165               spam-use-spamassassin-headers
1166               spam-use-regex-headers)
1167       (push 'X-Spam-Status list))
1168     (when (or spam-use-bogofilter
1169               spam-use-regex-headers)
1170       (push 'X-Bogosity list))
1171     (when (or spam-use-crm114
1172               spam-use-regex-headers)
1173       (push 'X-CRM114-Status list))
1174     list))
1175
1176 (defun spam-user-format-function-S (headers)
1177   (when headers
1178     (format "%3.2f"
1179             (spam-summary-score headers spam-summary-score-preferred-header))))
1180
1181 (defun spam-article-sort-by-spam-status (h1 h2)
1182   "Sort articles by score."
1183   (let (result)
1184     (dolist (header (spam-necessary-extra-headers))
1185       (let ((s1 (spam-summary-score h1 header))
1186             (s2 (spam-summary-score h2 header)))
1187       (unless (= s1 s2)
1188         (setq result (< s1 s2))
1189         (return))))
1190     result))
1191
1192 (defvar spam-spamassassin-score-regexp
1193   ".*\\b\\(?:score\\|hits\\)=\\(-?[0-9.]+\\)"
1194   "Regexp matching SpamAssassin score header.
1195 The first group must match the number.")
1196
1197 (defun spam-extra-header-to-number (header headers)
1198   "Transform an extra HEADER to a number, using list of HEADERS.
1199 Note this has to be fast."
1200   (let ((header-content (gnus-extra-header header headers)))
1201     (if header-content
1202         (cond
1203          ((eq header 'X-Spam-Status)
1204           (string-to-number (gnus-replace-in-string
1205                              header-content
1206                              spam-spamassassin-score-regexp
1207                              "\\1")))
1208          ;; for CRM checking, it's probably faster to just do the string match
1209          ((string-match "( pR: \\([0-9.-]+\\)" header-content)
1210           (- (string-to-number (match-string 1 header-content))))
1211          ((eq header 'X-Bogosity)
1212           (string-to-number (gnus-replace-in-string
1213                              (gnus-replace-in-string
1214                               header-content
1215                               ".*spamicity=" "")
1216                              ",.*" "")))
1217          (t nil))
1218       nil)))
1219
1220 (defun spam-summary-score (headers &optional specific-header)
1221   "Score an article for the summary buffer, as fast as possible.
1222 With SPECIFIC-HEADER, returns only that header's score.
1223 Will not return a nil score."
1224   (let (score)
1225     (dolist (header
1226              (if specific-header
1227                  (list specific-header)
1228                (spam-necessary-extra-headers)))
1229       (setq score
1230             (spam-extra-header-to-number header headers))
1231       (when score
1232         (return)))
1233     (or score 0)))
1234
1235 (defun spam-generic-score (&optional recheck)
1236   "Invoke whatever scoring method we can."
1237   (interactive "P")
1238   (cond
1239    ((or spam-use-spamassassin spam-use-spamassassin-headers)
1240     (spam-spamassassin-score recheck))
1241    ((or spam-use-bsfilter spam-use-bsfilter-headers)
1242     (spam-bsfilter-score recheck))
1243    (spam-use-crm114
1244     (spam-crm114-score))
1245    (t (spam-bogofilter-score recheck))))
1246 ;;}}}
1247
1248 ;;{{{ set up widening, processor checks
1249
1250 ;;; set up IMAP widening if it's necessary
1251 (defun spam-setup-widening ()
1252   (when (spam-widening-needed-p)
1253     (setq nnimap-split-download-body-default t)))
1254
1255 (defun spam-widening-needed-p (&optional force-symbols)
1256   (let (found)
1257     (dolist (backend (spam-backend-list))
1258       (when (and (spam-backend-statistical-p backend)
1259                  (or (symbol-value backend)
1260                      (memq backend force-symbols)))
1261         (setq found backend)))
1262     found))
1263
1264 (defvar spam-list-of-processors
1265   ;; note the nil processors are not defined in gnus.el
1266   '((gnus-group-spam-exit-processor-bogofilter   spam spam-use-bogofilter)
1267     (gnus-group-spam-exit-processor-bsfilter     spam spam-use-bsfilter)
1268     (gnus-group-spam-exit-processor-blacklist    spam spam-use-blacklist)
1269     (gnus-group-spam-exit-processor-ifile        spam spam-use-ifile)
1270     (gnus-group-spam-exit-processor-stat         spam spam-use-stat)
1271     (gnus-group-spam-exit-processor-spamoracle   spam spam-use-spamoracle)
1272     (gnus-group-spam-exit-processor-spamassassin spam spam-use-spamassassin)
1273     (gnus-group-spam-exit-processor-report-gmane spam spam-use-gmane) ;; Buggy?
1274     (gnus-group-ham-exit-processor-ifile         ham spam-use-ifile)
1275     (gnus-group-ham-exit-processor-bogofilter    ham spam-use-bogofilter)
1276     (gnus-group-ham-exit-processor-bsfilter      ham spam-use-bsfilter)
1277     (gnus-group-ham-exit-processor-stat          ham spam-use-stat)
1278     (gnus-group-ham-exit-processor-whitelist     ham spam-use-whitelist)
1279     (gnus-group-ham-exit-processor-BBDB          ham spam-use-BBDB)
1280     (gnus-group-ham-exit-processor-copy          ham spam-use-ham-copy)
1281     (gnus-group-ham-exit-processor-spamassassin  ham spam-use-spamassassin)
1282     (gnus-group-ham-exit-processor-spamoracle    ham spam-use-spamoracle))
1283   "The OBSOLETE `spam-list-of-processors' list.
1284 This list contains pairs associating the obsolete ham/spam exit
1285 processor variables with a classification and a spam-use-*
1286 variable.  When the processor variable is nil, just the
1287 classification and spam-use-* check variable are used.  This is
1288 superseded by the new spam backend code, so it's only consulted
1289 for backwards compatibility.")
1290 (make-obsolete-variable 'spam-list-of-processors nil "22.1")
1291
1292 (defun spam-group-processor-p (group backend &optional classification)
1293   "Checks if GROUP has a BACKEND with CLASSIFICATION registered.
1294 Also accepts the obsolete processors, which can be found in
1295 gnus.el and in spam-list-of-processors.  In the case of mover
1296 backends, checks the setting of `spam-summary-exit-behavior' in
1297 addition to the set values for the group."
1298   (if (and (stringp group)
1299            (symbolp backend))
1300       (let ((old-style (assq backend spam-list-of-processors))
1301             (parameters (nth 0 (gnus-parameter-spam-process group)))
1302             found)
1303         (if old-style  ; old-style processor
1304             (spam-group-processor-p group (nth 2 old-style) (nth 1 old-style))
1305           ;; now search for the parameter
1306           (dolist (parameter parameters)
1307             (when (and (null found)
1308                        (listp parameter)
1309                        (eq classification (nth 0 parameter))
1310                        (eq backend (nth 1 parameter)))
1311               (setq found t)))
1312
1313           ;; now, if the parameter was not found, do the
1314           ;; spam-summary-exit-behavior-logic for mover backends
1315           (unless found
1316             (when (spam-backend-mover-p backend)
1317               (setq
1318                found
1319                (cond
1320                 ((eq spam-summary-exit-behavior 'move-all) t)
1321                 ((eq spam-summary-exit-behavior 'move-none) nil)
1322                 ((eq spam-summary-exit-behavior 'default)
1323                  (or (eq classification 'spam) ;move spam out of all groups
1324                      ;; move ham out of spam groups
1325                      (and (eq classification 'ham)
1326                           (spam-group-spam-contents-p group))))
1327                 (t (gnus-error 5 "Unknown spam-summary-exit-behavior: %s"
1328                                spam-summary-exit-behavior))))))
1329
1330           found))
1331     nil))
1332
1333 ;;}}}
1334
1335 ;;{{{ Summary entry and exit processing.
1336
1337 (defun spam-mark-junk-as-spam-routine ()
1338   ;; check the global list of group names spam-junk-mailgroups and the
1339   ;; group parameters
1340   (when (spam-group-spam-contents-p gnus-newsgroup-name)
1341     (gnus-message 6 "Marking %s articles as spam"
1342                   (if spam-mark-only-unseen-as-spam
1343                       "unseen"
1344                     "unread"))
1345     (let ((articles (if spam-mark-only-unseen-as-spam
1346                         gnus-newsgroup-unseen
1347                       gnus-newsgroup-unreads)))
1348       (if spam-mark-new-messages-in-spam-group-as-spam
1349           (dolist (article articles)
1350             (gnus-summary-mark-article article gnus-spam-mark))
1351         (gnus-message 9 "Did not mark new messages as spam.")))))
1352
1353 (defun spam-summary-prepare ()
1354   (setq spam-old-articles
1355         (list (cons 'ham (spam-list-articles gnus-newsgroup-articles 'ham))
1356               (cons 'spam (spam-list-articles gnus-newsgroup-articles 'spam))))
1357   (spam-mark-junk-as-spam-routine))
1358
1359 ;; The spam processors are invoked for any group, spam or ham or neither
1360 (defun spam-summary-prepare-exit ()
1361   (unless gnus-group-is-exiting-without-update-p
1362     (gnus-message 6 "Exiting summary buffer and applying spam rules")
1363
1364     ;; before we begin, remove any article limits
1365 ;    (ignore-errors
1366 ;      (gnus-summary-pop-limit t))
1367
1368     ;; first of all, unregister any articles that are no longer ham or spam
1369     ;; we have to iterate over the processors, or else we'll be too slow
1370     (dolist (classification (spam-classifications))
1371       (let* ((old-articles (cdr-safe (assq classification spam-old-articles)))
1372              (new-articles (spam-list-articles
1373                             gnus-newsgroup-articles
1374                             classification))
1375              (changed-articles (spam-set-difference new-articles old-articles)))
1376         ;; now that we have the changed articles, we go through the processors
1377         (dolist (backend (spam-backend-list))
1378           (let (unregister-list)
1379             (dolist (article changed-articles)
1380               (let ((id (spam-fetch-field-message-id-fast article)))
1381                 (when (spam-log-unregistration-needed-p
1382                        id 'process classification backend)
1383                   (push article unregister-list))))
1384             ;; call spam-register-routine with specific articles to unregister,
1385             ;; when there are articles to unregister and the check is enabled
1386             (when (and unregister-list (symbol-value backend))
1387               (spam-backend-put-article-todo-list backend
1388                                                   classification
1389                                                   unregister-list
1390                                                   t))))))
1391
1392     ;; do the non-moving backends first, then the moving ones
1393     (dolist (backend-type '(non-mover mover))
1394       (dolist (classification (spam-classifications))
1395         (dolist (backend (spam-backend-list backend-type))
1396           (when (spam-group-processor-p
1397                  gnus-newsgroup-name
1398                  backend
1399                  classification)
1400             (spam-backend-put-article-todo-list backend
1401                                                 classification
1402                                                 (spam-list-articles
1403                                                  gnus-newsgroup-articles
1404                                                  classification))))))
1405
1406     (spam-resolve-registrations-routine) ; do the registrations now
1407
1408     ;; we mark all the leftover spam articles as expired at the end
1409     (dolist (article (spam-list-articles
1410                       gnus-newsgroup-articles
1411                       'spam))
1412       (gnus-summary-mark-article article gnus-expirable-mark)))
1413
1414   (setq spam-old-articles nil))
1415
1416 ;;}}}
1417
1418 ;;{{{ spam-use-move and spam-use-copy backend support functions
1419
1420 (defun spam-copy-or-move-routine (copy groups articles classification)
1421
1422   (when (and (car-safe groups) (listp (car-safe groups)))
1423     (setq groups (pop groups)))
1424
1425   (unless (listp groups)
1426     (setq groups (list groups)))
1427
1428     ;; remove the current process mark
1429   (gnus-summary-kill-process-mark)
1430
1431   (let ((backend-supports-deletions
1432          (gnus-check-backend-function
1433           'request-move-article gnus-newsgroup-name))
1434         (respool-method (gnus-find-method-for-group gnus-newsgroup-name))
1435         article mark deletep respool)
1436
1437     (when (member 'respool groups)
1438       (setq respool t)                  ; boolean for later
1439       (setq groups '("fake"))) ; when respooling, groups are dynamic so fake it
1440
1441     ;; now do the actual move
1442     (dolist (group groups)
1443       (when (and articles (stringp group))
1444
1445         ;; first, mark the article with the process mark and, if needed,
1446         ;; the unread or expired mark (for ham and spam respectively)
1447         (dolist (article articles)
1448           (when (and (eq classification 'ham)
1449                      spam-mark-ham-unread-before-move-from-spam-group)
1450             (gnus-message 9 "Marking ham article %d unread before move"
1451                           article)
1452             (gnus-summary-mark-article article gnus-unread-mark))
1453           (when (and (eq classification 'spam)
1454                      (not copy))
1455             (gnus-message 9 "Marking spam article %d expirable before move"
1456                           article)
1457             (gnus-summary-mark-article article gnus-expirable-mark))
1458           (gnus-summary-set-process-mark article)
1459
1460           (if respool              ; respooling is with a "fake" group
1461               (let ((spam-split-disabled
1462                      (or spam-split-disabled
1463                          (and (eq classification 'ham)
1464                               spam-disable-spam-split-during-ham-respool))))
1465                 (gnus-message 9 "Respooling article %d with method %s"
1466                               article respool-method)
1467                 (gnus-summary-respool-article nil respool-method))
1468             (if (or (not backend-supports-deletions) ; else, we are not respooling
1469                     (> (length groups) 1))
1470                 (progn              ; if copying, copy and set deletep
1471                   (gnus-message 9 "Copying article %d to group %s"
1472                                 article group)
1473                   (gnus-summary-copy-article nil group)
1474                   (setq deletep t))
1475               (gnus-message 9 "Moving article %d to group %s"
1476                             article group)
1477               (gnus-summary-move-article nil group))))) ; else move articles
1478
1479       ;; now delete the articles, unless a) copy is t, and there was a copy done
1480       ;;                                 b) a move was done to a single group
1481       ;;                                 c) backend-supports-deletions is nil
1482       (unless copy
1483         (when (and deletep backend-supports-deletions)
1484           (dolist (article articles)
1485               (gnus-summary-set-process-mark article)
1486               (gnus-message 9 "Deleting article %d" article))
1487           (when articles
1488             (let ((gnus-novice-user nil)) ; don't ask me if I'm sure
1489               (gnus-summary-delete-article nil)))))
1490
1491       (gnus-summary-yank-process-mark)
1492       (length articles))))
1493
1494 (defun spam-copy-spam-routine (articles)
1495   (spam-copy-or-move-routine
1496    t
1497    (gnus-parameter-spam-process-destination gnus-newsgroup-name)
1498    articles
1499    'spam))
1500
1501 (defun spam-move-spam-routine (articles)
1502   (spam-copy-or-move-routine
1503    nil
1504    (gnus-parameter-spam-process-destination gnus-newsgroup-name)
1505    articles
1506    'spam))
1507
1508 (defun spam-copy-ham-routine (articles)
1509   (spam-copy-or-move-routine
1510    t
1511    (gnus-parameter-ham-process-destination gnus-newsgroup-name)
1512    articles
1513    'ham))
1514
1515 (defun spam-move-ham-routine (articles)
1516   (spam-copy-or-move-routine
1517    nil
1518    (gnus-parameter-ham-process-destination gnus-newsgroup-name)
1519    articles
1520    'ham))
1521
1522 ;;}}}
1523
1524 ;;{{{ article and field retrieval code
1525 (defun spam-get-article-as-string (article)
1526   (when (numberp article)
1527     (with-temp-buffer
1528       (gnus-request-article-this-buffer
1529        article
1530        gnus-newsgroup-name)
1531       (buffer-string))))
1532
1533 ;; disabled for now
1534 ;; (defun spam-get-article-as-filename (article)
1535 ;;   (let ((article-filename))
1536 ;;     (when (numberp article)
1537 ;;       (nnml-possibly-change-directory
1538 ;;        (gnus-group-real-name gnus-newsgroup-name))
1539 ;;       (setq article-filename (expand-file-name
1540 ;;                              (int-to-string article) nnml-current-directory)))
1541 ;;     (if (file-exists-p article-filename)
1542 ;;      article-filename
1543 ;;       nil)))
1544
1545 (defun spam-fetch-field-fast (article field &optional prepared-data-header)
1546   "Fetch a FIELD for ARTICLE quickly, using the internal gnus-data-list function.
1547 When PREPARED-DATA-HEADER is given, don't look in the Gnus data.
1548 When FIELD is 'number, ARTICLE can be any number (since we want
1549 to find it out)."
1550   (when (numberp article)
1551     (let* ((data-header (or prepared-data-header
1552                             (spam-fetch-article-header article))))
1553       (if (arrayp data-header)
1554         (cond
1555          ((equal field 'number)
1556           (mail-header-number data-header))
1557          ((equal field 'from)
1558           (mail-header-from data-header))
1559          ((equal field 'message-id)
1560           (mail-header-message-id data-header))
1561          ((equal field 'subject)
1562           (mail-header-subject data-header))
1563          ((equal field 'references)
1564           (mail-header-references data-header))
1565          ((equal field 'date)
1566           (mail-header-date data-header))
1567          ((equal field 'xref)
1568           (mail-header-xref data-header))
1569          ((equal field 'extra)
1570           (mail-header-extra data-header))
1571          (t
1572           (gnus-error
1573            5
1574            "spam-fetch-field-fast: unknown field %s requested"
1575            field)
1576           nil))
1577         (gnus-message 6 "Article %d has a nil data header" article)))))
1578
1579 (defun spam-fetch-field-from-fast (article &optional prepared-data-header)
1580   (spam-fetch-field-fast article 'from prepared-data-header))
1581
1582 (defun spam-fetch-field-subject-fast (article &optional prepared-data-header)
1583   (spam-fetch-field-fast article 'subject prepared-data-header))
1584
1585 (defun spam-fetch-field-message-id-fast (article &optional prepared-data-header)
1586   (spam-fetch-field-fast article 'message-id prepared-data-header))
1587
1588 (defun spam-generate-fake-headers (article)
1589   (let ((dh (spam-fetch-article-header article)))
1590     (if dh
1591         (concat
1592          (format
1593           ;; 80-character limit makes for strange constructs
1594           (concat "From: %s\nSubject: %s\nMessage-ID: %s\n"
1595                   "Date: %s\nReferences: %s\nXref: %s\n")
1596           (spam-fetch-field-fast article 'from dh)
1597           (spam-fetch-field-fast article 'subject dh)
1598           (spam-fetch-field-fast article 'message-id dh)
1599           (spam-fetch-field-fast article 'date dh)
1600           (spam-fetch-field-fast article 'references dh)
1601           (spam-fetch-field-fast article 'xref dh))
1602          (when (spam-fetch-field-fast article 'extra dh)
1603            (format "%s\n" (spam-fetch-field-fast article 'extra dh))))
1604       (gnus-message
1605        5
1606        "spam-generate-fake-headers: article %d didn't have a valid header"
1607        article))))
1608
1609 (defun spam-fetch-article-header (article)
1610   (with-current-buffer gnus-summary-buffer
1611     (gnus-read-header article)
1612     (nth 3 (assq article gnus-newsgroup-data))))
1613 ;;}}}
1614
1615 ;;{{{ Spam determination.
1616
1617 (defun spam-split (&rest specific-checks)
1618   "Split this message into the `spam' group if it is spam.
1619 This function can be used as an entry in the variable `nnmail-split-fancy',
1620 for example like this: (: spam-split).  It can take checks as
1621 parameters.  A string as a parameter will set the
1622 `spam-split-group' to that string.
1623
1624 See the Info node `(gnus)Fancy Mail Splitting' for more details."
1625   (interactive)
1626   (setq spam-split-last-successful-check nil)
1627   (unless spam-split-disabled
1628     (let ((spam-split-group-choice spam-split-group))
1629       (dolist (check specific-checks)
1630         (when (stringp check)
1631           (setq spam-split-group-choice check)
1632           (setq specific-checks (delq check specific-checks))))
1633
1634       (let ((spam-split-group spam-split-group-choice)
1635             (widening-needed-check (spam-widening-needed-p specific-checks)))
1636         (save-excursion
1637           (save-restriction
1638             (when widening-needed-check
1639               (widen)
1640               (gnus-message 8 "spam-split: widening the buffer (%s requires it)"
1641                             widening-needed-check))
1642             (let ((backends (spam-backend-list))
1643                   decision)
1644               (while (and backends (not decision))
1645                 (let* ((backend (pop backends))
1646                        (check-function (spam-backend-check backend))
1647                        (spam-split-group (if spam-split-symbolic-return
1648                                              'spam
1649                                            spam-split-group)))
1650                   (when (or
1651                          ;; either, given specific checks, this is one of them
1652                          (memq backend specific-checks)
1653                          ;; or, given no specific checks, spam-use-CHECK is set
1654                          (and (null specific-checks) (symbol-value backend)))
1655                     (gnus-message 6 "spam-split: calling the %s function"
1656                                   check-function)
1657                     (setq decision (funcall check-function))
1658                     ;; if we got a decision at all, save the current check
1659                     (when decision
1660                       (setq spam-split-last-successful-check backend))
1661
1662                     (when (eq decision 'spam)
1663                       (unless spam-split-symbolic-return
1664                         (gnus-error
1665                          5
1666                          (format "spam-split got %s but %s is nil"
1667                                  decision
1668                                  spam-split-symbolic-return)))))))
1669               (if (eq decision t)
1670                   (if spam-split-symbolic-return-positive 'ham nil)
1671                 decision))))))))
1672
1673 (defun spam-find-spam ()
1674   "Detect spam in the current newsgroup using `spam-split'."
1675   (interactive)
1676
1677   (let* ((group gnus-newsgroup-name)
1678          (autodetect (gnus-parameter-spam-autodetect group))
1679          (methods (gnus-parameter-spam-autodetect-methods group))
1680          (first-method (nth 0 methods))
1681          (articles (if spam-autodetect-recheck-messages
1682                        gnus-newsgroup-articles
1683                      gnus-newsgroup-unseen))
1684          article-cannot-be-faked)
1685
1686
1687     (dolist (backend methods)
1688       (when (spam-backend-statistical-p backend)
1689         (setq article-cannot-be-faked t)
1690         (return)))
1691
1692     (when (memq 'default methods)
1693       (setq article-cannot-be-faked t))
1694
1695     (when (and autodetect
1696                (not (equal first-method 'none)))
1697       (mapcar
1698        (lambda (article)
1699          (let ((id (spam-fetch-field-message-id-fast article))
1700                (subject (spam-fetch-field-subject-fast article))
1701                (sender (spam-fetch-field-from-fast article))
1702                registry-lookup)
1703
1704            (unless id
1705              (gnus-message 6 "Article %d has no message ID!" article))
1706
1707            (when (and id spam-log-to-registry)
1708              (setq registry-lookup (spam-log-registration-type id 'incoming))
1709              (when registry-lookup
1710                (gnus-message
1711                 9
1712                 "spam-find-spam: message %s was already registered incoming"
1713                 id)))
1714
1715            (let* ((spam-split-symbolic-return t)
1716                   (spam-split-symbolic-return-positive t)
1717                   (fake-headers (spam-generate-fake-headers article))
1718                   (split-return
1719                    (or registry-lookup
1720                        (with-temp-buffer
1721                          (if article-cannot-be-faked
1722                              (gnus-request-article-this-buffer
1723                               article
1724                               group)
1725                            ;; else, we fake the article
1726                            (when fake-headers (insert fake-headers)))
1727                          (if (or (null first-method)
1728                                  (equal first-method 'default))
1729                              (spam-split)
1730                            (apply 'spam-split methods))))))
1731              (if (equal split-return 'spam)
1732                  (gnus-summary-mark-article article gnus-spam-mark))
1733
1734              (when (and id split-return spam-log-to-registry)
1735                (when (zerop (gnus-registry-group-count id))
1736                  (gnus-registry-add-group
1737                   id group subject sender))
1738
1739                (unless registry-lookup
1740                  (spam-log-processing-to-registry
1741                   id
1742                   'incoming
1743                   split-return
1744                   spam-split-last-successful-check
1745                   group))))))
1746        articles))))
1747
1748 ;;}}}
1749
1750 ;;{{{ registration/unregistration functions
1751
1752 (defun spam-resolve-registrations-routine ()
1753   "Go through the backends and register or unregister articles as needed."
1754   (dolist (backend-type '(non-mover mover))
1755     (dolist (classification (spam-classifications))
1756       (dolist (backend (spam-backend-list backend-type))
1757         (let ((rlist (spam-backend-get-article-todo-list
1758                       backend classification))
1759               (ulist (spam-backend-get-article-todo-list
1760                       backend classification t))
1761               (delcount 0))
1762
1763           ;; clear the old lists right away
1764           (spam-backend-put-article-todo-list backend
1765                                               classification
1766                                               nil
1767                                               nil)
1768           (spam-backend-put-article-todo-list backend
1769                                               classification
1770                                               nil
1771                                               t)
1772
1773           ;; eliminate duplicates
1774           (dolist (article (copy-sequence ulist))
1775             (when (memq article rlist)
1776               (incf delcount)
1777               (setq rlist (delq article rlist))
1778               (setq ulist (delq article ulist))))
1779
1780           (unless (zerop delcount)
1781             (gnus-message
1782              9
1783              "%d messages were saved the trouble of unregistering and then registering"
1784              delcount))
1785
1786           ;; unregister articles
1787           (unless (zerop (length ulist))
1788             (let ((num (spam-unregister-routine classification backend ulist)))
1789               (when (> num 0)
1790                 (gnus-message
1791                  6
1792                  "%d %s messages were unregistered by backend %s."
1793                  num
1794                  classification
1795                  backend))))
1796
1797             ;; register articles
1798             (unless (zerop (length rlist))
1799               (let ((num (spam-register-routine classification backend rlist)))
1800                 (when (> num 0)
1801                   (gnus-message
1802                    6
1803                    "%d %s messages were registered by backend %s."
1804                    num
1805                    classification
1806                    backend)))))))))
1807
1808 (defun spam-unregister-routine (classification
1809                                 backend
1810                                 specific-articles)
1811   (spam-register-routine classification backend specific-articles t))
1812
1813 (defun spam-register-routine (classification
1814                               backend
1815                               specific-articles
1816                               &optional unregister)
1817   (when (and (spam-classification-valid-p classification)
1818              (spam-backend-valid-p backend))
1819     (let* ((register-function
1820             (spam-backend-function backend classification 'registration))
1821            (unregister-function
1822             (spam-backend-function backend classification 'unregistration))
1823            (run-function (if unregister
1824                              unregister-function
1825                            register-function))
1826            (log-function (if unregister
1827                              'spam-log-undo-registration
1828                            'spam-log-processing-to-registry))
1829            article articles)
1830
1831       (when run-function
1832         ;; make list of articles, using specific-articles if given
1833         (setq articles (or specific-articles
1834                            (spam-list-articles
1835                             gnus-newsgroup-articles
1836                             classification)))
1837         ;; process them
1838         (when (> (length articles) 0)
1839           (gnus-message 5 "%s %d %s articles as %s using backend %s"
1840                         (if unregister "Unregistering" "Registering")
1841                         (length articles)
1842                         (if specific-articles "specific" "")
1843                         classification
1844                         backend)
1845           (funcall run-function articles)
1846           ;; now log all the registrations (or undo them, depending on
1847           ;; unregister)
1848           (dolist (article articles)
1849             (funcall log-function
1850                      (spam-fetch-field-message-id-fast article)
1851                      'process
1852                      classification
1853                      backend
1854                      gnus-newsgroup-name))))
1855       ;; return the number of articles processed
1856       (length articles))))
1857
1858 ;;; log a ham- or spam-processor invocation to the registry
1859 (defun spam-log-processing-to-registry (id type classification backend group)
1860   (when spam-log-to-registry
1861     (if (and (stringp id)
1862              (stringp group)
1863              (spam-process-type-valid-p type)
1864              (spam-classification-valid-p classification)
1865              (spam-backend-valid-p backend))
1866         (let ((cell-list (cdr-safe (gnus-registry-fetch-extra id type)))
1867               (cell (list classification backend group)))
1868           (push cell cell-list)
1869           (gnus-registry-store-extra-entry
1870            id
1871            type
1872            cell-list))
1873
1874       (gnus-error
1875        7
1876        (format "%s call with bad ID, type, classification, spam-backend, or group"
1877                "spam-log-processing-to-registry")))))
1878
1879 ;;; check if a ham- or spam-processor registration has been done
1880 (defun spam-log-registered-p (id type)
1881   (when spam-log-to-registry
1882     (if (and (stringp id)
1883              (spam-process-type-valid-p type))
1884         (cdr-safe (gnus-registry-fetch-extra id type))
1885       (progn
1886         (gnus-error
1887          7
1888          (format "%s called with bad ID, type, classification, or spam-backend"
1889                  "spam-log-registered-p"))
1890         nil))))
1891
1892 ;;; check what a ham- or spam-processor registration says
1893 ;;; returns nil if conflicting registrations are found
1894 (defun spam-log-registration-type (id type)
1895   (let ((count 0)
1896         decision)
1897     (dolist (reg (spam-log-registered-p id type))
1898       (let ((classification (nth 0 reg)))
1899         (when (spam-classification-valid-p classification)
1900           (when (and decision
1901                      (not (eq classification decision)))
1902             (setq count (+ 1 count)))
1903           (setq decision classification))))
1904     (if (< 0 count)
1905         nil
1906       decision)))
1907
1908
1909 ;;; check if a ham- or spam-processor registration needs to be undone
1910 (defun spam-log-unregistration-needed-p (id type classification backend)
1911   (when spam-log-to-registry
1912     (if (and (stringp id)
1913              (spam-process-type-valid-p type)
1914              (spam-classification-valid-p classification)
1915              (spam-backend-valid-p backend))
1916         (let ((cell-list (cdr-safe (gnus-registry-fetch-extra id type)))
1917               found)
1918           (dolist (cell cell-list)
1919             (unless found
1920               (when (and (eq classification (nth 0 cell))
1921                          (eq backend (nth 1 cell)))
1922                 (setq found t))))
1923           found)
1924       (progn
1925         (gnus-error
1926          7
1927          (format "%s called with bad ID, type, classification, or spam-backend"
1928                  "spam-log-unregistration-needed-p"))
1929         nil))))
1930
1931
1932 ;;; undo a ham- or spam-processor registration (the group is not used)
1933 (defun spam-log-undo-registration (id type classification backend &optional group)
1934   (when (and spam-log-to-registry
1935              (spam-log-unregistration-needed-p id type classification backend))
1936     (if (and (stringp id)
1937              (spam-process-type-valid-p type)
1938              (spam-classification-valid-p classification)
1939              (spam-backend-valid-p backend))
1940         (let ((cell-list (cdr-safe (gnus-registry-fetch-extra id type)))
1941               new-cell-list found)
1942           (dolist (cell cell-list)
1943             (unless (and (eq classification (nth 0 cell))
1944                          (eq backend (nth 1 cell)))
1945               (push cell new-cell-list)))
1946           (gnus-registry-store-extra-entry
1947            id
1948            type
1949            new-cell-list))
1950       (progn
1951         (gnus-error 7 (format "%s call with bad ID, type, spam-backend, or group"
1952                               "spam-log-undo-registration"))
1953         nil))))
1954
1955 ;;}}}
1956
1957 ;;{{{ backend functions
1958
1959 ;;{{{ Gmane xrefs
1960 (defun spam-check-gmane-xref ()
1961   (let ((header (or
1962                  (message-fetch-field "Xref")
1963                  (message-fetch-field "Newsgroups"))))
1964     (when header                        ; return nil when no header
1965       (when (string-match spam-gmane-xref-spam-group
1966                           header)
1967           spam-split-group))))
1968
1969 ;;}}}
1970
1971 ;;{{{ Regex body
1972
1973 (defun spam-check-regex-body ()
1974   (let ((spam-regex-headers-ham spam-regex-body-ham)
1975         (spam-regex-headers-spam spam-regex-body-spam))
1976     (spam-check-regex-headers t)))
1977
1978 ;;}}}
1979
1980 ;;{{{ Regex headers
1981
1982 (defun spam-check-regex-headers (&optional body)
1983   (let ((type (if body "body" "header"))
1984         ret found)
1985     (dolist (h-regex spam-regex-headers-ham)
1986       (unless found
1987         (goto-char (point-min))
1988         (when (re-search-forward h-regex nil t)
1989           (message "Ham regex %s search positive." type)
1990           (setq found t))))
1991     (dolist (s-regex spam-regex-headers-spam)
1992       (unless found
1993         (goto-char (point-min))
1994         (when (re-search-forward s-regex nil t)
1995           (message "Spam regex %s search positive." type)
1996           (setq found t)
1997           (setq ret spam-split-group))))
1998     ret))
1999
2000 ;;}}}
2001
2002 ;;{{{ Blackholes.
2003
2004 (defun spam-reverse-ip-string (ip)
2005   (when (stringp ip)
2006     (mapconcat 'identity
2007                (nreverse (split-string ip "\\."))
2008                ".")))
2009
2010 (defun spam-check-blackholes ()
2011   "Check the Received headers for blackholed relays."
2012   (let ((headers (message-fetch-field "received"))
2013         ips matches)
2014     (when headers
2015       (with-temp-buffer
2016         (insert headers)
2017         (goto-char (point-min))
2018         (gnus-message 6 "Checking headers for relay addresses")
2019         (while (re-search-forward
2020                 "\\([0-9]+\\.[0-9]+\\.[0-9]+\\.[0-9]+\\)" nil t)
2021           (gnus-message 9 "Blackhole search found host IP %s." (match-string 1))
2022           (push (spam-reverse-ip-string (match-string 1))
2023                 ips)))
2024       (dolist (server spam-blackhole-servers)
2025         (dolist (ip ips)
2026           (unless (and spam-blackhole-good-server-regex
2027                        ;; match the good-server-regex against the reversed (again) IP string
2028                        (string-match
2029                         spam-blackhole-good-server-regex
2030                         (spam-reverse-ip-string ip)))
2031             (unless matches
2032               (let ((query-string (concat ip "." server)))
2033                 (if spam-use-dig
2034                     (let ((query-result (query-dig query-string)))
2035                       (when query-result
2036                         (gnus-message 6 "(DIG): positive blackhole check '%s'"
2037                                       query-result)
2038                         (push (list ip server query-result)
2039                               matches)))
2040                   ;; else, if not using dig.el
2041                   (when (dns-query query-string)
2042                     (gnus-message 6 "positive blackhole check")
2043                     (push (list ip server (dns-query query-string 'TXT))
2044                           matches)))))))))
2045     (when matches
2046       spam-split-group)))
2047 ;;}}}
2048
2049 ;;{{{ Hashcash.
2050
2051 (defun spam-check-hashcash ()
2052   "Check the headers for hashcash payments."
2053   (ignore-errors (mail-check-payment)))  ;mail-check-payment returns a boolean
2054
2055 ;;}}}
2056
2057 ;;{{{ BBDB
2058
2059 ;;; original idea for spam-check-BBDB from Alexander Kotelnikov
2060 ;;; <sacha@giotto.sj.ru>
2061
2062 ;; all this is done inside a condition-case to trap errors
2063
2064 (eval-when-compile
2065   (autoload 'bbdb-buffer "bbdb")
2066   (autoload 'bbdb-create-internal "bbdb")
2067   (autoload 'bbdb-search-simple "bbdb"))
2068
2069 ;; Autoloaded in message, which we require.
2070 (declare-function gnus-extract-address-components "gnus-util" (from))
2071
2072 (eval-and-compile
2073   (when (condition-case nil
2074             (progn
2075               (require 'bbdb)
2076               (require 'bbdb-com))
2077           (file-error
2078            ;; `bbdb-records' should not be bound as an autoload function
2079            ;; before loading bbdb because of `bbdb-hashtable-size'.
2080            (defalias 'bbdb-records 'ignore)
2081            (defalias 'spam-BBDB-register-routine 'ignore)
2082            (defalias 'spam-enter-ham-BBDB 'ignore)
2083            nil))
2084
2085     ;; when the BBDB changes, we want to clear out our cache
2086     (defun spam-clear-cache-BBDB (&rest immaterial)
2087       (spam-clear-cache 'spam-use-BBDB))
2088
2089     (add-hook 'bbdb-change-hook 'spam-clear-cache-BBDB)
2090
2091     (defun spam-enter-ham-BBDB (addresses &optional remove)
2092       "Enter an address into the BBDB; implies ham (non-spam) sender"
2093       (dolist (from addresses)
2094         (when (stringp from)
2095           (let* ((parsed-address (gnus-extract-address-components from))
2096                  (name (or (nth 0 parsed-address) "Ham Sender"))
2097                  (remove-function (if remove
2098                                       'bbdb-delete-record-internal
2099                                     'ignore))
2100                  (net-address (nth 1 parsed-address))
2101                  (record (and net-address
2102                               (bbdb-search-simple nil net-address))))
2103             (when net-address
2104               (gnus-message 6 "%s address %s %s BBDB"
2105                             (if remove "Deleting" "Adding")
2106                             from
2107                             (if remove "from" "to"))
2108               (if record
2109                   (funcall remove-function record)
2110                 (bbdb-create-internal name nil net-address nil nil
2111                                       "ham sender added by spam.el")))))))
2112
2113     (defun spam-BBDB-register-routine (articles &optional unregister)
2114       (let (addresses)
2115         (dolist (article articles)
2116           (when (stringp (spam-fetch-field-from-fast article))
2117             (push (spam-fetch-field-from-fast article) addresses)))
2118         ;; now do the register/unregister action
2119         (spam-enter-ham-BBDB addresses unregister)))
2120
2121     (defun spam-BBDB-unregister-routine (articles)
2122       (spam-BBDB-register-routine articles t))
2123
2124     (defun spam-check-BBDB ()
2125       "Mail from people in the BBDB is classified as ham or non-spam"
2126       (let ((who (message-fetch-field "from"))
2127             bbdb-cache bbdb-hashtable)
2128         (when spam-cache-lookups
2129           (setq bbdb-cache (gethash 'spam-use-BBDB spam-caches))
2130           (unless bbdb-cache
2131             (setq bbdb-cache (make-vector 17 0)) ; a good starting hash value
2132             ;; this is based on the expanded (bbdb-hashtable) macro
2133             ;; without the debugging support
2134             (with-current-buffer (bbdb-buffer)
2135               (save-excursion
2136                 (save-window-excursion
2137                   (bbdb-records nil t)
2138                   (mapatoms
2139                    (lambda (symbol)
2140                      (intern (downcase (symbol-name symbol)) bbdb-cache))
2141                    bbdb-hashtable))))
2142             (puthash 'spam-use-BBDB bbdb-cache spam-caches)))
2143         (when who
2144           (setq who (nth 1 (gnus-extract-address-components who)))
2145           (if
2146               (if spam-cache-lookups
2147                   (intern-soft (downcase who) bbdb-cache)
2148                 (bbdb-search-simple nil who))
2149               t
2150             (if spam-use-BBDB-exclusive
2151                 spam-split-group
2152               nil)))))))
2153
2154 ;;}}}
2155
2156 ;;{{{ ifile
2157
2158 ;;; check the ifile backend; return nil if the mail was NOT classified
2159 ;;; as spam
2160
2161
2162 (defun spam-get-ifile-database-parameter ()
2163   "Return the command-line parameter for ifile's database.
2164 See `spam-ifile-database'."
2165   (if spam-ifile-database
2166       (format "--db-file=%s" spam-ifile-database)
2167     nil))
2168
2169 (defun spam-check-ifile ()
2170   "Check the ifile backend for the classification of this message."
2171   (let ((article-buffer-name (buffer-name))
2172         category return)
2173     (with-temp-buffer
2174       (let ((temp-buffer-name (buffer-name))
2175             (db-param (spam-get-ifile-database-parameter)))
2176         (with-current-buffer article-buffer-name
2177           (apply 'call-process-region
2178                  (point-min) (point-max) spam-ifile-program
2179                  nil temp-buffer-name nil "-c"
2180                  (if db-param `(,db-param "-q") `("-q"))))
2181         ;; check the return now (we're back in the temp buffer)
2182         (goto-char (point-min))
2183         (if (not (eobp))
2184             (setq category (buffer-substring (point) (point-at-eol))))
2185         (when (not (zerop (length category))) ; we need a category here
2186           (if spam-ifile-all-categories
2187               (setq return category)
2188             ;; else, if spam-ifile-all-categories is not set...
2189             (when (string-equal spam-ifile-spam-category category)
2190               (setq return spam-split-group)))))) ; note return is nil otherwise
2191     return))
2192
2193 (defun spam-ifile-register-with-ifile (articles category &optional unregister)
2194   "Register an article, given as a string, with a category.
2195 Uses `gnus-newsgroup-name' if category is nil (for ham registration)."
2196   (let ((category (or category gnus-newsgroup-name))
2197         (add-or-delete-option (if unregister "-d" "-i"))
2198         (db (spam-get-ifile-database-parameter))
2199         parameters)
2200     (with-temp-buffer
2201       (dolist (article articles)
2202         (let ((article-string (spam-get-article-as-string article)))
2203           (when (stringp article-string)
2204             (insert article-string))))
2205       (apply 'call-process-region
2206              (point-min) (point-max) spam-ifile-program
2207              nil nil nil
2208              add-or-delete-option category
2209              (if db `(,db "-h") `("-h"))))))
2210
2211 (defun spam-ifile-register-spam-routine (articles &optional unregister)
2212   (spam-ifile-register-with-ifile articles spam-ifile-spam-category unregister))
2213
2214 (defun spam-ifile-unregister-spam-routine (articles)
2215   (spam-ifile-register-spam-routine articles t))
2216
2217 (defun spam-ifile-register-ham-routine (articles &optional unregister)
2218   (spam-ifile-register-with-ifile articles spam-ifile-ham-category unregister))
2219
2220 (defun spam-ifile-unregister-ham-routine (articles)
2221   (spam-ifile-register-ham-routine articles t))
2222
2223 ;;}}}
2224
2225 ;;{{{ spam-stat
2226
2227 (eval-when-compile
2228   (autoload 'spam-stat-buffer-change-to-non-spam "spam-stat")
2229   (autoload 'spam-stat-buffer-change-to-spam "spam-stat")
2230   (autoload 'spam-stat-buffer-is-non-spam "spam-stat")
2231   (autoload 'spam-stat-buffer-is-spam "spam-stat")
2232   (autoload 'spam-stat-load "spam-stat")
2233   (autoload 'spam-stat-save "spam-stat")
2234   (autoload 'spam-stat-split-fancy "spam-stat"))
2235
2236 (eval-and-compile
2237   (when (condition-case nil
2238             (let ((spam-stat-install-hooks nil))
2239               (require 'spam-stat))
2240           (file-error
2241            (defalias 'spam-stat-register-ham-routine 'ignore)
2242            (defalias 'spam-stat-register-spam-routine 'ignore)
2243            nil))
2244
2245     (defun spam-check-stat ()
2246       "Check the spam-stat backend for the classification of this message"
2247       (let ((spam-stat-split-fancy-spam-group spam-split-group) ; override
2248             (spam-stat-buffer (buffer-name)) ; stat the current buffer
2249             category return)
2250         (spam-stat-split-fancy)))
2251
2252     (defun spam-stat-register-spam-routine (articles &optional unregister)
2253       (dolist (article articles)
2254         (let ((article-string (spam-get-article-as-string article)))
2255           (with-temp-buffer
2256             (insert article-string)
2257             (if unregister
2258                 (spam-stat-buffer-change-to-non-spam)
2259               (spam-stat-buffer-is-spam))))))
2260
2261     (defun spam-stat-unregister-spam-routine (articles)
2262       (spam-stat-register-spam-routine articles t))
2263
2264     (defun spam-stat-register-ham-routine (articles &optional unregister)
2265       (dolist (article articles)
2266         (let ((article-string (spam-get-article-as-string article)))
2267           (with-temp-buffer
2268             (insert article-string)
2269             (if unregister
2270                 (spam-stat-buffer-change-to-spam)
2271               (spam-stat-buffer-is-non-spam))))))
2272
2273     (defun spam-stat-unregister-ham-routine (articles)
2274       (spam-stat-register-ham-routine articles t))
2275
2276     (defun spam-maybe-spam-stat-load ()
2277       (when spam-use-stat (spam-stat-load)))
2278
2279     (defun spam-maybe-spam-stat-save ()
2280       (when spam-use-stat (spam-stat-save)))))
2281
2282 ;;}}}
2283
2284 ;;{{{ Blacklists and whitelists.
2285
2286 (defvar spam-whitelist-cache nil)
2287 (defvar spam-blacklist-cache nil)
2288
2289 (defun spam-kill-whole-line ()
2290   (beginning-of-line)
2291   (let ((kill-whole-line t))
2292     (kill-line)))
2293
2294 ;;; address can be a list, too
2295 (defun spam-enter-whitelist (address &optional remove)
2296   "Enter ADDRESS (list or single) into the whitelist.
2297 With a non-nil REMOVE, remove them."
2298   (interactive "sAddress: ")
2299   (spam-enter-list address spam-whitelist remove)
2300   (setq spam-whitelist-cache nil)
2301   (spam-clear-cache 'spam-use-whitelist))
2302
2303 ;;; address can be a list, too
2304 (defun spam-enter-blacklist (address &optional remove)
2305   "Enter ADDRESS (list or single) into the blacklist.
2306 With a non-nil REMOVE, remove them."
2307   (interactive "sAddress: ")
2308   (spam-enter-list address spam-blacklist remove)
2309   (setq spam-blacklist-cache nil)
2310   (spam-clear-cache 'spam-use-whitelist))
2311
2312 (defun spam-enter-list (addresses file &optional remove)
2313   "Enter ADDRESSES into the given FILE.
2314 Either the whitelist or the blacklist files can be used.
2315 With a non-nil REMOVE, remove the ADDRESSES."
2316   (if (stringp addresses)
2317       (spam-enter-list (list addresses) file remove)
2318     ;; else, we have a list of addresses here
2319     (unless (file-exists-p (file-name-directory file))
2320       (make-directory (file-name-directory file) t))
2321     (with-current-buffer
2322        (find-file-noselect file)
2323       (dolist (a addresses)
2324         (when (stringp a)
2325           (goto-char (point-min))
2326           (if (re-search-forward (regexp-quote a) nil t)
2327               ;; found the address
2328               (when remove
2329                 (spam-kill-whole-line))
2330             ;; else, the address was not found
2331             (unless remove
2332               (goto-char (point-max))
2333               (unless (bobp)
2334                 (insert "\n"))
2335               (insert a "\n")))))
2336       (save-buffer))))
2337
2338 (defun spam-filelist-build-cache (type)
2339   (let ((cache (if (eq type 'spam-use-blacklist)
2340                    spam-blacklist-cache
2341                  spam-whitelist-cache))
2342         parsed-cache)
2343     (unless (gethash type spam-caches)
2344       (while cache
2345         (let ((address (pop cache)))
2346           (unless (zerop (length address)) ; 0 for a nil address too
2347             (setq address (regexp-quote address))
2348             ;; fix regexp-quote's treatment of user-intended regexes
2349             (while (string-match "\\\\\\*" address)
2350               (setq address (replace-match ".*" t t address))))
2351           (push address parsed-cache)))
2352       (puthash type parsed-cache spam-caches))))
2353
2354 (defun spam-filelist-check-cache (type from)
2355   (when (stringp from)
2356     (spam-filelist-build-cache type)
2357     (let (found)
2358       (dolist (address (gethash type spam-caches))
2359         (when (and address (string-match address from))
2360           (setq found t)
2361           (return)))
2362       found)))
2363
2364 ;;; returns t if the sender is in the whitelist, nil or
2365 ;;; spam-split-group otherwise
2366 (defun spam-check-whitelist ()
2367   ;; FIXME!  Should it detect when file timestamps change?
2368   (unless spam-whitelist-cache
2369     (setq spam-whitelist-cache (spam-parse-list spam-whitelist)))
2370   (if (spam-from-listed-p 'spam-use-whitelist)
2371       t
2372     (if spam-use-whitelist-exclusive
2373         spam-split-group
2374       nil)))
2375
2376 (defun spam-check-blacklist ()
2377   ;; FIXME!  Should it detect when file timestamps change?
2378   (unless spam-blacklist-cache
2379     (setq spam-blacklist-cache (spam-parse-list spam-blacklist)))
2380   (and (spam-from-listed-p 'spam-use-blacklist)
2381        spam-split-group))
2382
2383 (defun spam-parse-list (file)
2384   (when (file-readable-p file)
2385     (let (contents address)
2386       (with-temp-buffer
2387         (insert-file-contents file)
2388         (while (not (eobp))
2389           (setq address (buffer-substring (point) (point-at-eol)))
2390           (forward-line 1)
2391           ;; insert the e-mail address if detected, otherwise the raw data
2392           (unless (zerop (length address))
2393             (let ((pure-address (nth 1 (gnus-extract-address-components address))))
2394               (push (or pure-address address) contents)))))
2395       (nreverse contents))))
2396
2397 (defun spam-from-listed-p (type)
2398   (let ((from (message-fetch-field "from"))
2399         found)
2400     (spam-filelist-check-cache type from)))
2401
2402 (defun spam-filelist-register-routine (articles blacklist &optional unregister)
2403   (let ((de-symbol (if blacklist 'spam-use-whitelist 'spam-use-blacklist))
2404         (declassification (if blacklist 'ham 'spam))
2405         (enter-function
2406          (if blacklist 'spam-enter-blacklist 'spam-enter-whitelist))
2407         (remove-function
2408          (if blacklist 'spam-enter-whitelist 'spam-enter-blacklist))
2409         from addresses unregister-list article-unregister-list)
2410     (dolist (article articles)
2411       (let ((from (spam-fetch-field-from-fast article))
2412             (id (spam-fetch-field-message-id-fast article))
2413             sender-ignored)
2414         (when (stringp from)
2415           (dolist (ignore-regex spam-blacklist-ignored-regexes)
2416             (when (and (not sender-ignored)
2417                        (stringp ignore-regex)
2418                        (string-match ignore-regex from))
2419               (setq sender-ignored t)))
2420           ;; remember the messages we need to unregister, unless remove is set
2421           (when (and
2422                  (null unregister)
2423                  (spam-log-unregistration-needed-p
2424                   id 'process declassification de-symbol))
2425             (push article article-unregister-list)
2426             (push from unregister-list))
2427           (unless sender-ignored
2428             (push from addresses)))))
2429
2430     (if unregister
2431         (funcall enter-function addresses t) ; unregister all these addresses
2432       ;; else, register normally and unregister what we need to
2433       (funcall remove-function unregister-list t)
2434       (dolist (article article-unregister-list)
2435         (spam-log-undo-registration
2436          (spam-fetch-field-message-id-fast article)
2437          'process
2438          declassification
2439          de-symbol))
2440       (funcall enter-function addresses nil))))
2441
2442 (defun spam-blacklist-unregister-routine (articles)
2443   (spam-blacklist-register-routine articles t))
2444
2445 (defun spam-blacklist-register-routine (articles &optional unregister)
2446   (spam-filelist-register-routine articles t unregister))
2447
2448 (defun spam-whitelist-unregister-routine (articles)
2449   (spam-whitelist-register-routine articles t))
2450
2451 (defun spam-whitelist-register-routine (articles &optional unregister)
2452   (spam-filelist-register-routine articles nil unregister))
2453
2454 ;;}}}
2455
2456 ;;{{{ Spam-report glue (gmane and resend reporting)
2457 (defun spam-report-gmane-register-routine (articles)
2458   (when articles
2459     (apply 'spam-report-gmane-spam articles)))
2460
2461 (defun spam-report-gmane-unregister-routine (articles)
2462   (when articles
2463     (apply 'spam-report-gmane-ham articles)))
2464
2465 (defun spam-report-resend-register-ham-routine (articles)
2466   (spam-report-resend-register-routine articles t))
2467
2468 (defun spam-report-resend-register-routine (articles &optional ham)
2469   (let* ((resend-to-gp
2470           (if ham
2471               (gnus-parameter-ham-resend-to gnus-newsgroup-name)
2472             (gnus-parameter-spam-resend-to gnus-newsgroup-name)))
2473          (spam-report-resend-to (or (car-safe resend-to-gp)
2474                                     spam-report-resend-to)))
2475     (spam-report-resend articles ham)))
2476
2477 ;;}}}
2478
2479 ;;{{{ Bogofilter
2480 (defun spam-check-bogofilter-headers (&optional score)
2481   (let ((header (message-fetch-field spam-bogofilter-header)))
2482     (when header                        ; return nil when no header
2483       (if score                         ; scoring mode
2484           (if (string-match "spamicity=\\([0-9.]+\\)" header)
2485               (match-string 1 header)
2486             "0")
2487         ;; spam detection mode
2488         (when (string-match spam-bogofilter-bogosity-positive-spam-header
2489                             header)
2490           spam-split-group)))))
2491
2492 ;; return something sensible if the score can't be determined
2493 (defun spam-bogofilter-score (&optional recheck)
2494   "Get the Bogofilter spamicity score."
2495   (interactive "P")
2496   (save-window-excursion
2497     (gnus-summary-show-article t)
2498     (set-buffer gnus-article-buffer)
2499     (let ((score (or (unless recheck
2500                        (spam-check-bogofilter-headers t))
2501                      (spam-check-bogofilter t))))
2502       (gnus-summary-show-article)
2503       (message "Spamicity score %s" score)
2504       (or score "0"))))
2505
2506 (defun spam-verify-bogofilter ()
2507   "Verify the Bogofilter version is sufficient."
2508   (when (eq spam-bogofilter-valid 'unknown)
2509     (setq spam-bogofilter-valid
2510           (not (string-match "^bogofilter version 0\\.\\([0-9]\\|1[01]\\)\\."
2511                              (shell-command-to-string
2512                               (format "%s -V" spam-bogofilter-program))))))
2513   spam-bogofilter-valid)
2514
2515 (defun spam-check-bogofilter (&optional score)
2516   "Check the Bogofilter backend for the classification of this message."
2517   (if (spam-verify-bogofilter)
2518       (let ((article-buffer-name (buffer-name))
2519             (db spam-bogofilter-database-directory)
2520             return)
2521         (with-temp-buffer
2522           (let ((temp-buffer-name (buffer-name)))
2523             (with-current-buffer article-buffer-name
2524               (apply 'call-process-region
2525                      (point-min) (point-max)
2526                      spam-bogofilter-program
2527                      nil temp-buffer-name nil
2528                      (if db `("-d" ,db "-v") `("-v"))))
2529             (setq return (spam-check-bogofilter-headers score))))
2530         return)
2531     (gnus-error 5 "`spam.el' doesn't support obsolete bogofilter versions")))
2532
2533 (defun spam-bogofilter-register-with-bogofilter (articles
2534                                                  spam
2535                                                  &optional unregister)
2536   "Register an article, given as a string, as spam or non-spam."
2537   (if (spam-verify-bogofilter)
2538       (dolist (article articles)
2539         (let ((article-string (spam-get-article-as-string article))
2540               (db spam-bogofilter-database-directory)
2541               (switch (if unregister
2542                           (if spam
2543                               spam-bogofilter-spam-strong-switch
2544                             spam-bogofilter-ham-strong-switch)
2545                         (if spam
2546                             spam-bogofilter-spam-switch
2547                           spam-bogofilter-ham-switch))))
2548           (when (stringp article-string)
2549             (with-temp-buffer
2550               (insert article-string)
2551
2552               (apply 'call-process-region
2553                      (point-min) (point-max)
2554                      spam-bogofilter-program
2555                      nil nil nil switch
2556                      (if db `("-d" ,db "-v") `("-v")))))))
2557     (gnus-error 5 "`spam.el' doesn't support obsolete bogofilter versions")))
2558
2559 (defun spam-bogofilter-register-spam-routine (articles &optional unregister)
2560   (spam-bogofilter-register-with-bogofilter articles t unregister))
2561
2562 (defun spam-bogofilter-unregister-spam-routine (articles)
2563   (spam-bogofilter-register-spam-routine articles t))
2564
2565 (defun spam-bogofilter-register-ham-routine (articles &optional unregister)
2566   (spam-bogofilter-register-with-bogofilter articles nil unregister))
2567
2568 (defun spam-bogofilter-unregister-ham-routine (articles)
2569   (spam-bogofilter-register-ham-routine articles t))
2570
2571
2572 ;;}}}
2573
2574 ;;{{{ spamoracle
2575 (defun spam-check-spamoracle ()
2576   "Run spamoracle on an article to determine whether it's spam."
2577   (let ((article-buffer-name (buffer-name)))
2578     (with-temp-buffer
2579       (let ((temp-buffer-name (buffer-name)))
2580         (with-current-buffer article-buffer-name
2581           (let ((status
2582                  (apply 'call-process-region
2583                         (point-min) (point-max)
2584                         spam-spamoracle-binary
2585                         nil temp-buffer-name nil
2586                         (if spam-spamoracle-database
2587                             `("-f" ,spam-spamoracle-database "mark")
2588                           '("mark")))))
2589             (if (eq 0 status)
2590                 (progn
2591                   (set-buffer temp-buffer-name)
2592                   (goto-char (point-min))
2593                   (when (re-search-forward "^X-Spam: yes;" nil t)
2594                     spam-split-group))
2595               (error "Error running spamoracle: %s" status))))))))
2596
2597 (defun spam-spamoracle-learn (articles article-is-spam-p &optional unregister)
2598   "Run spamoracle in training mode."
2599   (with-temp-buffer
2600     (let ((temp-buffer-name (buffer-name)))
2601       (save-excursion
2602         (goto-char (point-min))
2603         (dolist (article articles)
2604           (insert (spam-get-article-as-string article)))
2605         (let* ((arg (if (spam-xor unregister article-is-spam-p)
2606                         "-spam"
2607                       "-good"))
2608                (status
2609                 (apply 'call-process-region
2610                        (point-min) (point-max)
2611                        spam-spamoracle-binary
2612                        nil temp-buffer-name nil
2613                        (if spam-spamoracle-database
2614                            `("-f" ,spam-spamoracle-database
2615                              "add" ,arg)
2616                          `("add" ,arg)))))
2617           (unless (eq 0 status)
2618             (error "Error running spamoracle: %s" status)))))))
2619
2620 (defun spam-spamoracle-learn-ham (articles &optional unregister)
2621   (spam-spamoracle-learn articles nil unregister))
2622
2623 (defun spam-spamoracle-unlearn-ham (articles &optional unregister)
2624   (spam-spamoracle-learn-ham articles t))
2625
2626 (defun spam-spamoracle-learn-spam (articles &optional unregister)
2627   (spam-spamoracle-learn articles t unregister))
2628
2629 (defun spam-spamoracle-unlearn-spam (articles &optional unregister)
2630   (spam-spamoracle-learn-spam articles t))
2631
2632 ;;}}}
2633
2634 ;;{{{ SpamAssassin
2635 ;;; based mostly on the bogofilter code
2636 (defun spam-check-spamassassin-headers (&optional score)
2637   "Check the SpamAssassin headers for the classification of this message."
2638   (if score                             ; scoring mode
2639       (let ((header (message-fetch-field spam-spamassassin-spam-status-header)))
2640         (when header
2641           (if (string-match spam-spamassassin-score-regexp header)
2642               (match-string 1 header)
2643             "0")))
2644     ;; spam detection mode
2645     (let ((header (message-fetch-field spam-spamassassin-spam-flag-header)))
2646           (when header                  ; return nil when no header
2647             (when (string-match spam-spamassassin-positive-spam-flag-header
2648                                 header)
2649               spam-split-group)))))
2650
2651 (defun spam-check-spamassassin (&optional score)
2652   "Check the SpamAssassin backend for the classification of this message."
2653   (let ((article-buffer-name (buffer-name)))
2654     (with-temp-buffer
2655       (let ((temp-buffer-name (buffer-name)))
2656         (with-current-buffer article-buffer-name
2657           (apply 'call-process-region
2658                  (point-min) (point-max) spam-assassin-program
2659                  nil temp-buffer-name nil spam-spamassassin-arguments))
2660         ;; check the return now (we're back in the temp buffer)
2661         (goto-char (point-min))
2662         (spam-check-spamassassin-headers score)))))
2663
2664 ;; return something sensible if the score can't be determined
2665 (defun spam-spamassassin-score (&optional recheck)
2666   "Get the SpamAssassin score"
2667   (interactive "P")
2668   (save-window-excursion
2669     (gnus-summary-show-article t)
2670     (set-buffer gnus-article-buffer)
2671     (let ((score (or (unless recheck
2672                        (spam-check-spamassassin-headers t))
2673                      (spam-check-spamassassin t))))
2674       (gnus-summary-show-article)
2675       (message "SpamAssassin score %s" score)
2676       (or score "0"))))
2677
2678 (defun spam-spamassassin-register-with-sa-learn (articles spam
2679                                                  &optional unregister)
2680   "Register articles with spamassassin's sa-learn as spam or non-spam."
2681   (if articles
2682       (let ((action (if unregister spam-sa-learn-unregister-switch
2683                       (if spam spam-sa-learn-spam-switch
2684                         spam-sa-learn-ham-switch)))
2685             (summary-buffer-name (buffer-name)))
2686         (with-temp-buffer
2687           ;; group the articles into mbox format
2688           (dolist (article articles)
2689             (let (article-string)
2690               (with-current-buffer summary-buffer-name
2691                 (setq article-string (spam-get-article-as-string article)))
2692               (when (stringp article-string)
2693                 (insert "From \n") ; mbox separator (sa-learn only checks the
2694                                    ; first five chars, so we can get away with
2695                                    ; a bogus line))
2696                 (insert article-string)
2697                 (insert "\n"))))
2698           ;; call sa-learn on all messages at the same time
2699           (apply 'call-process-region
2700                  (point-min) (point-max)
2701                  spam-sa-learn-program
2702                  nil nil nil "--mbox"
2703                  (if spam-sa-learn-rebuild
2704                      (list action)
2705                    `("--no-rebuild" ,action)))))))
2706
2707 (defun spam-spamassassin-register-spam-routine (articles &optional unregister)
2708   (spam-spamassassin-register-with-sa-learn articles t unregister))
2709
2710 (defun spam-spamassassin-register-ham-routine (articles &optional unregister)
2711   (spam-spamassassin-register-with-sa-learn articles nil unregister))
2712
2713 (defun spam-spamassassin-unregister-spam-routine (articles)
2714   (spam-spamassassin-register-with-sa-learn articles t t))
2715
2716 (defun spam-spamassassin-unregister-ham-routine (articles)
2717   (spam-spamassassin-register-with-sa-learn articles nil t))
2718
2719 ;;}}}
2720
2721 ;;{{{ Bsfilter
2722 ;;; based mostly on the bogofilter code
2723 (defun spam-check-bsfilter-headers (&optional score)
2724   (if score
2725       (or (nnmail-fetch-field spam-bsfilter-probability-header)
2726           "0")
2727     (let ((header (nnmail-fetch-field spam-bsfilter-header)))
2728       (when header ; return nil when no header
2729         (when (string-match "YES" header)
2730           spam-split-group)))))
2731
2732 ;; return something sensible if the score can't be determined
2733 (defun spam-bsfilter-score (&optional recheck)
2734   "Get the Bsfilter spamicity score."
2735   (interactive "P")
2736   (save-window-excursion
2737     (gnus-summary-show-article t)
2738     (set-buffer gnus-article-buffer)
2739     (let ((score (or (unless recheck
2740                        (spam-check-bsfilter-headers t))
2741                      (spam-check-bsfilter t))))
2742       (gnus-summary-show-article)
2743       (message "Spamicity score %s" score)
2744       (or score "0"))))
2745
2746 (defun spam-check-bsfilter (&optional score)
2747   "Check the Bsfilter backend for the classification of this message."
2748   (let ((article-buffer-name (buffer-name))
2749         (dir spam-bsfilter-database-directory)
2750         return)
2751     (with-temp-buffer
2752       (let ((temp-buffer-name (buffer-name)))
2753         (with-current-buffer article-buffer-name
2754           (apply 'call-process-region
2755                  (point-min) (point-max)
2756                  spam-bsfilter-program
2757                  nil temp-buffer-name nil
2758                  "--pipe"
2759                  "--insert-flag"
2760                  "--insert-probability"
2761                  (when dir
2762                    (list "--homedir" dir))))
2763         (setq return (spam-check-bsfilter-headers score))))
2764     return))
2765
2766 (defun spam-bsfilter-register-with-bsfilter (articles
2767                                              spam
2768                                              &optional unregister)
2769   "Register an article, given as a string, as spam or non-spam."
2770   (dolist (article articles)
2771     (let ((article-string (spam-get-article-as-string article))
2772           (switch (if unregister
2773                       (if spam
2774                           spam-bsfilter-spam-strong-switch
2775                         spam-bsfilter-ham-strong-switch)
2776                     (if spam
2777                         spam-bsfilter-spam-switch
2778                       spam-bsfilter-ham-switch))))
2779       (when (stringp article-string)
2780         (with-temp-buffer
2781           (insert article-string)
2782           (apply 'call-process-region
2783                  (point-min) (point-max)
2784                  spam-bsfilter-program
2785                  nil nil nil switch
2786                  "--update"
2787                  (when spam-bsfilter-database-directory
2788                    (list "--homedir"
2789                          spam-bsfilter-database-directory))))))))
2790
2791 (defun spam-bsfilter-register-spam-routine (articles &optional unregister)
2792   (spam-bsfilter-register-with-bsfilter articles t unregister))
2793
2794 (defun spam-bsfilter-unregister-spam-routine (articles)
2795   (spam-bsfilter-register-spam-routine articles t))
2796
2797 (defun spam-bsfilter-register-ham-routine (articles &optional unregister)
2798   (spam-bsfilter-register-with-bsfilter articles nil unregister))
2799
2800 (defun spam-bsfilter-unregister-ham-routine (articles)
2801   (spam-bsfilter-register-ham-routine articles t))
2802
2803 ;;}}}
2804
2805 ;;{{{ CRM114 Mailfilter
2806 (defun spam-check-crm114-headers (&optional score)
2807   (let ((header (message-fetch-field spam-crm114-header)))
2808     (when header                        ; return nil when no header
2809       (if score                         ; scoring mode
2810           (if (string-match "( pR: \\([0-9.-]+\\)" header)
2811               (match-string 1 header)
2812             "0")
2813         ;; spam detection mode
2814         (when (string-match spam-crm114-positive-spam-header
2815                             header)
2816           spam-split-group)))))
2817
2818 ;; return something sensible if the score can't be determined
2819 (defun spam-crm114-score ()
2820   "Get the CRM114 Mailfilter pR."
2821   (interactive)
2822   (save-window-excursion
2823     (gnus-summary-show-article t)
2824     (set-buffer gnus-article-buffer)
2825     (let ((score (or (spam-check-crm114-headers t)
2826                      (spam-check-crm114 t))))
2827       (gnus-summary-show-article)
2828       (message "pR: %s" score)
2829       (or score "0"))))
2830
2831 (defun spam-check-crm114 (&optional score)
2832   "Check the CRM114 Mailfilter backend for the classification of this message."
2833   (let ((article-buffer-name (buffer-name))
2834         (db spam-crm114-database-directory)
2835         return)
2836     (with-temp-buffer
2837       (let ((temp-buffer-name (buffer-name)))
2838         (with-current-buffer article-buffer-name
2839           (apply 'call-process-region
2840                  (point-min) (point-max)
2841                  spam-crm114-program
2842                  nil temp-buffer-name nil
2843                  (when db (list (concat "--fileprefix=" db)))))
2844         (setq return (spam-check-crm114-headers score))))
2845     return))
2846
2847 (defun spam-crm114-register-with-crm114 (articles
2848                                          spam
2849                                          &optional unregister)
2850   "Register an article, given as a string, as spam or non-spam."
2851   (dolist (article articles)
2852     (let ((article-string (spam-get-article-as-string article))
2853           (db spam-crm114-database-directory)
2854           (switch (if unregister
2855                       (if spam
2856                           spam-crm114-spam-strong-switch
2857                         spam-crm114-ham-strong-switch)
2858                     (if spam
2859                         spam-crm114-spam-switch
2860                       spam-crm114-ham-switch))))
2861       (when (stringp article-string)
2862         (with-temp-buffer
2863           (insert article-string)
2864
2865           (apply 'call-process-region
2866                  (point-min) (point-max)
2867                  spam-crm114-program
2868                  nil nil nil
2869                  (when db (list switch (concat "--fileprefix=" db)))))))))
2870
2871 (defun spam-crm114-register-spam-routine (articles &optional unregister)
2872   (spam-crm114-register-with-crm114 articles t unregister))
2873
2874 (defun spam-crm114-unregister-spam-routine (articles)
2875   (spam-crm114-register-spam-routine articles t))
2876
2877 (defun spam-crm114-register-ham-routine (articles &optional unregister)
2878   (spam-crm114-register-with-crm114 articles nil unregister))
2879
2880 (defun spam-crm114-unregister-ham-routine (articles)
2881   (spam-crm114-register-ham-routine articles t))
2882
2883 ;;}}}
2884
2885 ;;}}}
2886
2887 ;;{{{ Hooks
2888
2889 ;;;###autoload
2890 (defun spam-initialize (&rest symbols)
2891   "Install the spam.el hooks and do other initialization.
2892 When SYMBOLS is given, set those variables to t.  This is so you
2893 can call `spam-initialize' before you set spam-use-* variables on
2894 explicitly, and matters only if you need the extra headers
2895 installed through `spam-necessary-extra-headers'."
2896   (interactive)
2897
2898   (dolist (var symbols)
2899     (set var t))
2900
2901   (dolist (header (spam-necessary-extra-headers))
2902     (add-to-list 'nnmail-extra-headers header)
2903     (add-to-list 'gnus-extra-headers header))
2904
2905   (setq spam-install-hooks t)
2906   ;; TODO: How do we redo this every time the `spam' face is customized?
2907   (push '((eq mark gnus-spam-mark) . spam)
2908         gnus-summary-highlight)
2909   ;; Add hooks for loading and saving the spam stats
2910   (add-hook 'gnus-save-newsrc-hook 'spam-maybe-spam-stat-save)
2911   (add-hook 'gnus-get-top-new-news-hook 'spam-maybe-spam-stat-load)
2912   (add-hook 'gnus-startup-hook 'spam-maybe-spam-stat-load)
2913   (add-hook 'gnus-summary-prepare-exit-hook 'spam-summary-prepare-exit)
2914   (add-hook 'gnus-summary-prepare-hook 'spam-summary-prepare)
2915   (add-hook 'gnus-get-new-news-hook 'spam-setup-widening)
2916   (add-hook 'gnus-summary-prepared-hook 'spam-find-spam))
2917
2918 (defun spam-unload-hook ()
2919   "Uninstall the spam.el hooks."
2920   (interactive)
2921   (remove-hook 'gnus-save-newsrc-hook 'spam-maybe-spam-stat-save)
2922   (remove-hook 'gnus-get-top-new-news-hook 'spam-maybe-spam-stat-load)
2923   (remove-hook 'gnus-startup-hook 'spam-maybe-spam-stat-load)
2924   (remove-hook 'gnus-summary-prepare-exit-hook 'spam-summary-prepare-exit)
2925   (remove-hook 'gnus-summary-prepare-hook 'spam-summary-prepare)
2926   (remove-hook 'gnus-get-new-news-hook 'spam-setup-widening)
2927   (remove-hook 'gnus-summary-prepare-hook 'spam-find-spam))
2928
2929 (add-hook 'spam-unload-hook 'spam-unload-hook)
2930
2931 (when spam-install-hooks
2932   (spam-initialize))
2933 ;;}}}
2934
2935 (provide 'spam)
2936
2937 ;;; spam.el ends here