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
   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.
  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 "--UNKNOWN"
 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 "--UNKNOWN"
 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
 694 (defvar spam-cache-lookups t
 695   "Whether spam.el will try to cache lookups using `spam-caches'.")
 696
 697 (defvar spam-caches (make-hash-table
 698                      :size 10
 699                      :test 'equal)
 700   "Cache of spam detection entries.")
 701
 702 (defvar spam-old-articles nil
 703   "List of old ham and spam articles, generated when a group is entered.")
 704
 705 (defvar spam-split-disabled nil
 706   "If non-nil, `spam-split' is disabled, and always returns nil.")
 707
 708 (defvar spam-split-last-successful-check nil
 709   "Internal variable.
 710 `spam-split' will set this to nil or a spam-use-XYZ check if it
 711 finds ham or spam.")
 712
 713 ;; internal variables for backends
 714 ;; TODO: find a way to create these on the fly in spam-install-backend-super
 715 (defvar spam-use-copy nil)
 716 (defvar spam-use-move nil)
 717 (defvar spam-use-gmane nil)
 718 (defvar spam-use-resend nil)
 719
 720 ;;}}}
 721
 722 ;;{{{ convenience functions
 723
 724 (defun spam-clear-cache (symbol)
 725   "Clear the `spam-caches' entry for a check."
 726   (remhash symbol spam-caches))
 727
 728 (defun spam-xor (a b)
 729   "Logical A xor B."
 730   (and (or a b) (not (and a b))))
 731
 732 (defun spam-set-difference (list1 list2)
 733   "Return a set difference of LIST1 and LIST2.
 734 When either list is nil, the other is returned."
 735   (if (and list1 list2)
 736       ;; we have two non-nil lists
 737       (progn
 738         (dolist (item (append list1 list2))
 739           (when (and (memq item list1) (memq item list2))
 740             (setq list1 (delq item list1))
 741             (setq list2 (delq item list2))))
 742         (append list1 list2))
 743     ;; if either of the lists was nil, return the other one
 744     (if list1 list1 list2)))
 745
 746 (defun spam-group-ham-mark-p (group mark &optional spam)
 747   "Checks if MARK is considered a ham mark in GROUP."
 748   (when (stringp group)
 749     (let* ((marks (spam-group-ham-marks group spam))
 750            (marks (if (symbolp mark)
 751                       marks
 752                     (mapcar 'symbol-value marks))))
 753       (memq mark marks))))
 754
 755 (defun spam-group-spam-mark-p (group mark)
 756   "Checks if MARK is considered a spam mark in GROUP."
 757   (spam-group-ham-mark-p group mark t))
 758
 759 (defun spam-group-ham-marks (group &optional spam)
 760   "In GROUP, get all the ham marks."
 761   (when (stringp group)
 762     (let* ((marks (if spam
 763                       (gnus-parameter-spam-marks group)
 764                     (gnus-parameter-ham-marks group)))
 765            (marks (car marks))
 766            (marks (if (listp (car marks)) (car marks) marks)))
 767       marks)))
 768
 769 (defun spam-group-spam-marks (group)
 770   "In GROUP, get all the spam marks."
 771   (spam-group-ham-marks group t))
 772
 773 (defun spam-group-spam-contents-p (group)
 774   "Is GROUP a spam group?"
 775   (if (and (stringp group) (< 0 (length group)))
 776       (or (member group spam-junk-mailgroups)
 777           (memq 'gnus-group-spam-classification-spam
 778                 (gnus-parameter-spam-contents group)))
 779     nil))
 780
 781 (defun spam-group-ham-contents-p (group)
 782   "Is GROUP a ham group?"
 783   (if (stringp group)
 784       (memq 'gnus-group-spam-classification-ham
 785             (gnus-parameter-spam-contents group))
 786     nil))
 787
 788 (defun spam-classifications ()
 789   "Return list of valid classifications"
 790   '(spam ham))
 791
 792 (defun spam-classification-valid-p (classification)
 793   "Is CLASSIFICATION a valid spam/ham classification?"
 794   (memq classification (spam-classifications)))
 795
 796 (defun spam-backend-properties ()
 797   "Return list of valid classifications."
 798   '(statistical mover check hrf srf huf suf))
 799
 800 (defun spam-backend-property-valid-p (property)
 801   "Is PROPERTY a valid backend property?"
 802   (memq property (spam-backend-properties)))
 803
 804 (defun spam-backend-function-type-valid-p (type)
 805   (or (eq type 'registration)
 806       (eq type 'unregistration)))
 807
 808 (defun spam-process-type-valid-p (process-type)
 809   (or (eq process-type 'incoming)
 810       (eq process-type 'process)))
 811
 812 (defun spam-list-articles (articles classification)
 813   (let ((mark-check (if (eq classification 'spam)
 814                         'spam-group-spam-mark-p
 815                       'spam-group-ham-mark-p))
 816         alist mark-cache-yes mark-cache-no)
 817     (dolist (article articles)
 818       (let ((mark (gnus-summary-article-mark article)))
 819         (unless (or (memq mark mark-cache-yes)
 820                     (memq mark mark-cache-no))
 821           (if (funcall mark-check
 822                        gnus-newsgroup-name
 823                        mark)
 824               (push mark mark-cache-yes)
 825             (push mark mark-cache-no)))
 826         (when (memq mark mark-cache-yes)
 827           (push article alist))))
 828     alist))
 829
 830 ;;}}}
 831
 832 ;;{{{ backend installation functions and procedures
 833
 834 (defun spam-install-backend-super (backend &rest properties)
 835   "Install BACKEND for spam.el.
 836 Accepts incoming CHECK, ham registration function HRF, spam
 837 registration function SRF, ham unregistration function HUF, spam
 838 unregistration function SUF, and an indication whether the
 839 backend is STATISTICAL."
 840   (setq spam-backends (add-to-list 'spam-backends backend))
 841   (while properties
 842     (let ((property (pop properties))
 843           (value (pop properties)))
 844       (if (spam-backend-property-valid-p property)
 845           (put backend property value)
 846         (gnus-error
 847          5
 848          "spam-install-backend-super got an invalid property %s"
 849          property)))))
 850
 851 (defun spam-backend-list (&optional type)
 852   "Return a list of all the backend symbols, constrained by TYPE.
 853 When TYPE is 'non-mover, only non-mover backends are returned.
 854 When TYPE is 'mover, only mover backends are returned."
 855   (let (list)
 856     (dolist (backend spam-backends)
 857       (when (or
 858              (null type)                ;either no type was requested
 859              ;; or the type is 'mover and the backend is a mover
 860              (and
 861               (eq type 'mover)
 862               (spam-backend-mover-p backend))
 863              ;; or the type is 'non-mover and the backend is not a mover
 864              (and
 865               (eq type 'non-mover)
 866               (not (spam-backend-mover-p backend))))
 867         (push backend list)))
 868       list))
 869
 870 (defun spam-backend-check (backend)
 871   "Get the check function for BACKEND.
 872 Each individual check may return nil, t, or a mailgroup name.
 873 The value nil means that the check does not yield a decision, and
 874 so, that further checks are needed.  The value t means that the
 875 message is definitely not spam, and that further spam checks
 876 should be inhibited.  Otherwise, a mailgroup name or the symbol
 877 'spam (depending on `spam-split-symbolic-return') is returned where
 878 the mail should go, and further checks are also inhibited.  The
 879 usual mailgroup name is the value of `spam-split-group', meaning
 880 that the message is definitely a spam."
 881   (get backend 'check))
 882
 883 (defun spam-backend-valid-p (backend)
 884   "Is BACKEND valid?"
 885   (member backend (spam-backend-list)))
 886
 887 (defun spam-backend-info (backend)
 888   "Return information about BACKEND."
 889   (if (spam-backend-valid-p backend)
 890       (let (info)
 891         (setq info (format "Backend %s has the following properties:\n"
 892                            backend))
 893         (dolist (property (spam-backend-properties))
 894           (setq info (format "%s%s=%s\n"
 895                              info
 896                              property
 897                              (get backend property))))
 898         info)
 899     (gnus-error 5 "spam-backend-info was asked about an invalid backend %s"
 900                 backend)))
 901
 902 (defun spam-backend-function (backend classification type)
 903   "Get the BACKEND function for CLASSIFICATION and TYPE.
 904 TYPE is 'registration or 'unregistration.
 905 CLASSIFICATION is 'ham or 'spam."
 906   (if (and
 907        (spam-classification-valid-p classification)
 908        (spam-backend-function-type-valid-p type))
 909       (let ((retrieval
 910              (intern
 911               (format "spam-backend-%s-%s-function"
 912                       classification
 913                       type))))
 914         (funcall retrieval backend))
 915     (gnus-error
 916      5
 917      "%s was passed invalid backend %s, classification %s, or type %s"
 918      "spam-backend-function"
 919      backend
 920      classification
 921      type)))
 922
 923 (defun spam-backend-article-list-property (classification
 924                                            &optional unregister)
 925   "Property name of article list with CLASSIFICATION and UNREGISTER."
 926   (let* ((r (if unregister "unregister" "register"))
 927          (prop (format "%s-%s" classification r)))
 928     prop))
 929
 930 (defun spam-backend-get-article-todo-list (backend
 931                                            classification
 932                                            &optional unregister)
 933   "Get the articles to be processed for BACKEND and CLASSIFICATION.
 934 With UNREGISTER, get articles to be unregistered.
 935 This is a temporary storage function - nothing here persists."
 936   (get
 937    backend
 938    (intern (spam-backend-article-list-property classification unregister))))
 939
 940 (defun spam-backend-put-article-todo-list (backend classification list &optional unregister)
 941   "Set the LIST of articles to be processed for BACKEND and CLASSIFICATION.
 942 With UNREGISTER, set articles to be unregistered.
 943 This is a temporary storage function - nothing here persists."
 944   (put
 945    backend
 946    (intern (spam-backend-article-list-property classification unregister))
 947    list))
 948
 949 (defun spam-backend-ham-registration-function (backend)
 950   "Get the ham registration function for BACKEND."
 951   (get backend 'hrf))
 952
 953 (defun spam-backend-spam-registration-function (backend)
 954   "Get the spam registration function for BACKEND."
 955   (get backend 'srf))
 956
 957 (defun spam-backend-ham-unregistration-function (backend)
 958   "Get the ham unregistration function for BACKEND."
 959   (get backend 'huf))
 960
 961 (defun spam-backend-spam-unregistration-function (backend)
 962   "Get the spam unregistration function for BACKEND."
 963   (get backend 'suf))
 964
 965 (defun spam-backend-statistical-p (backend)
 966   "Is BACKEND statistical?"
 967   (get backend 'statistical))
 968
 969 (defun spam-backend-mover-p (backend)
 970   "Is BACKEND a mover?"
 971   (get backend 'mover))
 972
 973 (defun spam-install-backend-alias (backend alias)
 974   "Add ALIAS to an existing BACKEND.
 975 The previous backend settings for ALIAS are erased."
 976
 977   ;; install alias with no properties at first
 978   (spam-install-backend-super alias)
 979
 980   (dolist (property (spam-backend-properties))
 981     (put alias property (get backend property))))
 982
 983 (defun spam-install-checkonly-backend (backend check)
 984   "Install a BACKEND than can only CHECK for spam."
 985   (spam-install-backend-super backend 'check check))
 986
 987 (defun spam-install-mover-backend (backend hrf srf huf suf)
 988   "Install a BACKEND than can move articles at summary exit.
 989 Accepts ham registration function HRF, spam registration function
 990 SRF, ham unregistration function HUF, spam unregistration
 991 function SUF.  The backend has no incoming check and can't be
 992 statistical."
 993   (spam-install-backend-super
 994    backend
 995    'hrf hrf 'srf srf 'huf huf 'suf suf 'mover t))
 996
 997 (defun spam-install-nocheck-backend (backend hrf srf huf suf)
 998   "Install a BACKEND than has no check.
 999 Accepts ham registration function HRF, spam registration function
1000 SRF, ham unregistration function HUF, spam unregistration
1001 function SUF.  The backend has no incoming check and can't be
1002 statistical (it could be, but in practice that doesn't happen)."
1003   (spam-install-backend-super
1004    backend
1005    'hrf hrf 'srf srf 'huf huf 'suf suf))
1006
1007 (defun spam-install-backend (backend check hrf srf huf suf)
1008   "Install a BACKEND.
1009 Accepts incoming CHECK, ham registration function HRF, spam
1010 registration function SRF, ham unregistration function HUF, spam
1011 unregistration function SUF.  The backend won't be
1012 statistical (use `spam-install-statistical-backend' for that)."
1013   (spam-install-backend-super
1014    backend
1015    'check check 'hrf hrf 'srf srf 'huf huf 'suf suf))
1016
1017 (defun spam-install-statistical-backend (backend check hrf srf huf suf)
1018   "Install a BACKEND.
1019 Accepts incoming CHECK, ham registration function HRF, spam
1020 registration function SRF, ham unregistration function HUF, spam
1021 unregistration function SUF.  The backend will be
1022 statistical (use `spam-install-backend' for non-statistical
1023 backends)."
1024   (spam-install-backend-super
1025    backend
1026    'check check 'statistical t 'hrf hrf 'srf srf 'huf huf 'suf suf))
1027
1028 (defun spam-install-statistical-checkonly-backend (backend check)
1029   "Install a statistical BACKEND than can only CHECK for spam."
1030   (spam-install-backend-super
1031    backend
1032    'check check 'statistical t))
1033
1034 ;;}}}
1035
1036 ;;{{{ backend installations
1037 (spam-install-checkonly-backend 'spam-use-blackholes
1038                                 'spam-check-blackholes)
1039
1040 (spam-install-checkonly-backend 'spam-use-hashcash
1041                                 'spam-check-hashcash)
1042
1043 (spam-install-checkonly-backend 'spam-use-spamassassin-headers
1044                                 'spam-check-spamassassin-headers)
1045
1046 (spam-install-checkonly-backend 'spam-use-bogofilter-headers
1047                                 'spam-check-bogofilter-headers)
1048
1049 (spam-install-checkonly-backend 'spam-use-bsfilter-headers
1050                                 'spam-check-bsfilter-headers)
1051
1052 (spam-install-checkonly-backend 'spam-use-gmane-xref
1053                                 'spam-check-gmane-xref)
1054
1055 (spam-install-checkonly-backend 'spam-use-regex-headers
1056                                 'spam-check-regex-headers)
1057
1058 (spam-install-statistical-checkonly-backend 'spam-use-regex-body
1059                                             'spam-check-regex-body)
1060
1061 ;; TODO: NOTE: spam-use-ham-copy is now obsolete, use (ham spam-use-copy) instead
1062 (spam-install-mover-backend 'spam-use-move
1063                             'spam-move-ham-routine
1064                             'spam-move-spam-routine
1065                             nil
1066                             nil)
1067
1068 (spam-install-nocheck-backend 'spam-use-copy
1069                               'spam-copy-ham-routine
1070                               'spam-copy-spam-routine
1071                               nil
1072                               nil)
1073
1074 (spam-install-nocheck-backend 'spam-use-gmane
1075                               'spam-report-gmane-unregister-routine
1076                               'spam-report-gmane-register-routine
1077                               'spam-report-gmane-register-routine
1078                               'spam-report-gmane-unregister-routine)
1079
1080 (spam-install-nocheck-backend 'spam-use-resend
1081                               'spam-report-resend-register-ham-routine
1082                               'spam-report-resend-register-routine
1083                               nil
1084                               nil)
1085
1086 (spam-install-backend 'spam-use-BBDB
1087                       'spam-check-BBDB
1088                       'spam-BBDB-register-routine
1089                       nil
1090                       'spam-BBDB-unregister-routine
1091                       nil)
1092
1093 (spam-install-backend-alias 'spam-use-BBDB 'spam-use-BBDB-exclusive)
1094
1095 (spam-install-backend 'spam-use-blacklist
1096                       'spam-check-blacklist
1097                       nil
1098                       'spam-blacklist-register-routine
1099                       nil
1100                       'spam-blacklist-unregister-routine)
1101
1102 (spam-install-backend 'spam-use-whitelist
1103                       'spam-check-whitelist
1104                       'spam-whitelist-register-routine
1105                       nil
1106                       'spam-whitelist-unregister-routine
1107                       nil)
1108
1109 (spam-install-statistical-backend 'spam-use-ifile
1110                                   'spam-check-ifile
1111                                   'spam-ifile-register-ham-routine
1112                                   'spam-ifile-register-spam-routine
1113                                   'spam-ifile-unregister-ham-routine
1114                                   'spam-ifile-unregister-spam-routine)
1115
1116 (spam-install-statistical-backend 'spam-use-spamoracle
1117                                   'spam-check-spamoracle
1118                                   'spam-spamoracle-learn-ham
1119                                   'spam-spamoracle-learn-spam
1120                                   'spam-spamoracle-unlearn-ham
1121                                   'spam-spamoracle-unlearn-spam)
1122
1123 (spam-install-statistical-backend 'spam-use-stat
1124                                   'spam-check-stat
1125                                   'spam-stat-register-ham-routine
1126                                   'spam-stat-register-spam-routine
1127                                   'spam-stat-unregister-ham-routine
1128                                   'spam-stat-unregister-spam-routine)
1129
1130 (spam-install-statistical-backend 'spam-use-spamassassin
1131                                   'spam-check-spamassassin
1132                                   'spam-spamassassin-register-ham-routine
1133                                   'spam-spamassassin-register-spam-routine
1134                                   'spam-spamassassin-unregister-ham-routine
1135                                   'spam-spamassassin-unregister-spam-routine)
1136
1137 (spam-install-statistical-backend 'spam-use-bogofilter
1138                                   'spam-check-bogofilter
1139                                   'spam-bogofilter-register-ham-routine
1140                                   'spam-bogofilter-register-spam-routine
1141                                   'spam-bogofilter-unregister-ham-routine
1142                                   'spam-bogofilter-unregister-spam-routine)
1143
1144 (spam-install-statistical-backend 'spam-use-bsfilter
1145                                   'spam-check-bsfilter
1146                                   'spam-bsfilter-register-ham-routine
1147                                   'spam-bsfilter-register-spam-routine
1148                                   'spam-bsfilter-unregister-ham-routine
1149                                   'spam-bsfilter-unregister-spam-routine)
1150
1151 (spam-install-statistical-backend 'spam-use-crm114
1152                                   'spam-check-crm114
1153                                   'spam-crm114-register-ham-routine
1154                                   'spam-crm114-register-spam-routine
1155                                   ;; does CRM114 Mailfilter support unregistration?
1156                                   nil
1157                                   nil)
1158
1159 ;;}}}
1160
1161 ;;{{{ scoring and summary formatting
1162 (defun spam-necessary-extra-headers ()
1163   "Return the extra headers spam.el thinks are necessary."
1164   (let (list)
1165     (when (or spam-use-spamassassin
1166               spam-use-spamassassin-headers
1167               spam-use-regex-headers)
1168       (push 'X-Spam-Status list))
1169     (when (or spam-use-bogofilter
1170               spam-use-regex-headers)
1171       (push 'X-Bogosity list))
1172     (when (or spam-use-crm114
1173               spam-use-regex-headers)
1174       (push 'X-CRM114-Status list))
1175     list))
1176
1177 (defun spam-user-format-function-S (headers)
1178   (when headers
1179     (format "%3.2f"
1180             (spam-summary-score headers spam-summary-score-preferred-header))))
1181
1182 (defun spam-article-sort-by-spam-status (h1 h2)
1183   "Sort articles by score."
1184   (let (result)
1185     (dolist (header (spam-necessary-extra-headers))
1186       (let ((s1 (spam-summary-score h1 header))
1187             (s2 (spam-summary-score h2 header)))
1188       (unless (= s1 s2)
1189         (setq result (< s1 s2))
1190         (return))))
1191     result))
1192
1193 (defvar spam-spamassassin-score-regexp
1194   ".*\\b\\(?:score\\|hits\\)=\\(-?[0-9.]+\\)"
1195   "Regexp matching SpamAssassin score header.
1196 The first group must match the number.")
1197
1198 (defun spam-extra-header-to-number (header headers)
1199   "Transform an extra HEADER to a number, using list of HEADERS.
1200 Note this has to be fast."
1201   (let ((header-content (gnus-extra-header header headers)))
1202     (if header-content
1203         (cond
1204          ((eq header 'X-Spam-Status)
1205           (string-to-number (gnus-replace-in-string
1206                              header-content
1207                              spam-spamassassin-score-regexp
1208                              "\\1")))
1209          ;; for CRM checking, it's probably faster to just do the string match
1210          ((string-match "( pR: \\([0-9.-]+\\)" header-content)
1211           (- (string-to-number (match-string 1 header-content))))
1212          ((eq header 'X-Bogosity)
1213           (string-to-number (gnus-replace-in-string
1214                              (gnus-replace-in-string
1215                               header-content
1216                               ".*spamicity=" "")
1217                              ",.*" "")))
1218          (t nil))
1219       nil)))
1220
1221 (defun spam-summary-score (headers &optional specific-header)
1222   "Score an article for the summary buffer, as fast as possible.
1223 With SPECIFIC-HEADER, returns only that header's score.
1224 Will not return a nil score."
1225   (let (score)
1226     (dolist (header
1227              (if specific-header
1228                  (list specific-header)
1229                (spam-necessary-extra-headers)))
1230       (setq score
1231             (spam-extra-header-to-number header headers))
1232       (when score
1233         (return)))
1234     (or score 0)))
1235
1236 (defun spam-generic-score (&optional recheck)
1237   "Invoke whatever scoring method we can."
1238   (interactive "P")
1239   (cond
1240    ((or spam-use-spamassassin spam-use-spamassassin-headers)
1241     (spam-spamassassin-score recheck))
1242    ((or spam-use-bsfilter spam-use-bsfilter-headers)
1243     (spam-bsfilter-score recheck))
1244    (spam-use-crm114
1245     (spam-crm114-score))
1246    (t (spam-bogofilter-score recheck))))
1247 ;;}}}
1248
1249 ;;{{{ set up widening, processor checks
1250
1251 ;;; set up IMAP widening if it's necessary
1252 (defun spam-setup-widening ()
1253   (when (spam-widening-needed-p)
1254     (setq nnimap-split-download-body-default t)))
1255
1256 (defun spam-widening-needed-p (&optional force-symbols)
1257   (let (found)
1258     (dolist (backend (spam-backend-list))
1259       (when (and (spam-backend-statistical-p backend)
1260                  (or (symbol-value backend)
1261                      (memq backend force-symbols)))
1262         (setq found backend)))
1263     found))
1264
1265 (defvar spam-list-of-processors
1266   ;; note the nil processors are not defined in gnus.el
1267   '((gnus-group-spam-exit-processor-bogofilter   spam spam-use-bogofilter)
1268     (gnus-group-spam-exit-processor-bsfilter     spam spam-use-bsfilter)
1269     (gnus-group-spam-exit-processor-blacklist    spam spam-use-blacklist)
1270     (gnus-group-spam-exit-processor-ifile        spam spam-use-ifile)
1271     (gnus-group-spam-exit-processor-stat         spam spam-use-stat)
1272     (gnus-group-spam-exit-processor-spamoracle   spam spam-use-spamoracle)
1273     (gnus-group-spam-exit-processor-spamassassin spam spam-use-spamassassin)
1274     (gnus-group-spam-exit-processor-report-gmane spam spam-use-gmane) ;; Buggy?
1275     (gnus-group-ham-exit-processor-ifile         ham spam-use-ifile)
1276     (gnus-group-ham-exit-processor-bogofilter    ham spam-use-bogofilter)
1277     (gnus-group-ham-exit-processor-bsfilter      ham spam-use-bsfilter)
1278     (gnus-group-ham-exit-processor-stat          ham spam-use-stat)
1279     (gnus-group-ham-exit-processor-whitelist     ham spam-use-whitelist)
1280     (gnus-group-ham-exit-processor-BBDB          ham spam-use-BBDB)
1281     (gnus-group-ham-exit-processor-copy          ham spam-use-ham-copy)
1282     (gnus-group-ham-exit-processor-spamassassin  ham spam-use-spamassassin)
1283     (gnus-group-ham-exit-processor-spamoracle    ham spam-use-spamoracle))
1284   "The OBSOLETE `spam-list-of-processors' list.
1285 This list contains pairs associating the obsolete ham/spam exit
1286 processor variables with a classification and a spam-use-*
1287 variable.  When the processor variable is nil, just the
1288 classification and spam-use-* check variable are used.  This is
1289 superseded by the new spam backend code, so it's only consulted
1290 for backwards compatibility.")
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   (save-excursion
1611     (set-buffer gnus-summary-buffer)
1612     (gnus-read-header article)
1613     (nth 3 (assq article gnus-newsgroup-data))))
1614 ;;}}}
1615
1616 ;;{{{ Spam determination.
1617
1618 (defun spam-split (&rest specific-checks)
1619   "Split this message into the `spam' group if it is spam.
1620 This function can be used as an entry in the variable `nnmail-split-fancy',
1621 for example like this: (: spam-split).  It can take checks as
1622 parameters.  A string as a parameter will set the
1623 `spam-split-group' to that string.
1624
1625 See the Info node `(gnus)Fancy Mail Splitting' for more details."
1626   (interactive)
1627   (setq spam-split-last-successful-check nil)
1628   (unless spam-split-disabled
1629     (let ((spam-split-group-choice spam-split-group))
1630       (dolist (check specific-checks)
1631         (when (stringp check)
1632           (setq spam-split-group-choice check)
1633           (setq specific-checks (delq check specific-checks))))
1634
1635       (let ((spam-split-group spam-split-group-choice)
1636             (widening-needed-check (spam-widening-needed-p specific-checks)))
1637         (save-excursion
1638           (save-restriction
1639             (when widening-needed-check
1640               (widen)
1641               (gnus-message 8 "spam-split: widening the buffer (%s requires it)"
1642                             widening-needed-check))
1643             (let ((backends (spam-backend-list))
1644                   decision)
1645               (while (and backends (not decision))
1646                 (let* ((backend (pop backends))
1647                        (check-function (spam-backend-check backend))
1648                        (spam-split-group (if spam-split-symbolic-return
1649                                              'spam
1650                                            spam-split-group)))
1651                   (when (or
1652                          ;; either, given specific checks, this is one of them
1653                          (memq backend specific-checks)
1654                          ;; or, given no specific checks, spam-use-CHECK is set
1655                          (and (null specific-checks) (symbol-value backend)))
1656                     (gnus-message 6 "spam-split: calling the %s function"
1657                                   check-function)
1658                     (setq decision (funcall check-function))
1659                     ;; if we got a decision at all, save the current check
1660                     (when decision
1661                       (setq spam-split-last-successful-check backend))
1662
1663                     (when (eq decision 'spam)
1664                       (unless spam-split-symbolic-return
1665                         (gnus-error
1666                          5
1667                          (format "spam-split got %s but %s is nil"
1668                                  decision
1669                                  spam-split-symbolic-return)))))))
1670               (if (eq decision t)
1671                   (if spam-split-symbolic-return-positive 'ham nil)
1672                 decision))))))))
1673
1674 (defun spam-find-spam ()
1675   "Detect spam in the current newsgroup using `spam-split'."
1676   (interactive)
1677
1678   (let* ((group gnus-newsgroup-name)
1679          (autodetect (gnus-parameter-spam-autodetect group))
1680          (methods (gnus-parameter-spam-autodetect-methods group))
1681          (first-method (nth 0 methods))
1682          (articles (if spam-autodetect-recheck-messages
1683                        gnus-newsgroup-articles
1684                      gnus-newsgroup-unseen))
1685          article-cannot-be-faked)
1686
1687
1688     (dolist (backend methods)
1689       (when (spam-backend-statistical-p backend)
1690         (setq article-cannot-be-faked t)
1691         (return)))
1692
1693     (when (memq 'default methods)
1694       (setq article-cannot-be-faked t))
1695
1696     (when (and autodetect
1697                (not (equal first-method 'none)))
1698       (mapcar
1699        (lambda (article)
1700          (let ((id (spam-fetch-field-message-id-fast article))
1701                (subject (spam-fetch-field-subject-fast article))
1702                (sender (spam-fetch-field-from-fast article))
1703                registry-lookup)
1704
1705            (unless id
1706              (gnus-message 6 "Article %d has no message ID!" article))
1707
1708            (when (and id spam-log-to-registry)
1709              (setq registry-lookup (spam-log-registration-type id 'incoming))
1710              (when registry-lookup
1711                (gnus-message
1712                 9
1713                 "spam-find-spam: message %s was already registered incoming"
1714                 id)))
1715
1716            (let* ((spam-split-symbolic-return t)
1717                   (spam-split-symbolic-return-positive t)
1718                   (fake-headers (spam-generate-fake-headers article))
1719                   (split-return
1720                    (or registry-lookup
1721                        (with-temp-buffer
1722                          (if article-cannot-be-faked
1723                              (gnus-request-article-this-buffer
1724                               article
1725                               group)
1726                            ;; else, we fake the article
1727                            (when fake-headers (insert fake-headers)))
1728                          (if (or (null first-method)
1729                                  (equal first-method 'default))
1730                              (spam-split)
1731                            (apply 'spam-split methods))))))
1732              (if (equal split-return 'spam)
1733                  (gnus-summary-mark-article article gnus-spam-mark))
1734
1735              (when (and id split-return spam-log-to-registry)
1736                (when (zerop (gnus-registry-group-count id))
1737                  (gnus-registry-add-group
1738                   id group subject sender))
1739
1740                (unless registry-lookup
1741                  (spam-log-processing-to-registry
1742                   id
1743                   'incoming
1744                   split-return
1745                   spam-split-last-successful-check
1746                   group))))))
1747        articles))))
1748
1749 ;;}}}
1750
1751 ;;{{{ registration/unregistration functions
1752
1753 (defun spam-resolve-registrations-routine ()
1754   "Go through the backends and register or unregister articles as needed."
1755   (dolist (backend-type '(non-mover mover))
1756     (dolist (classification (spam-classifications))
1757       (dolist (backend (spam-backend-list backend-type))
1758         (let ((rlist (spam-backend-get-article-todo-list
1759                       backend classification))
1760               (ulist (spam-backend-get-article-todo-list
1761                       backend classification t))
1762               (delcount 0))
1763
1764           ;; clear the old lists right away
1765           (spam-backend-put-article-todo-list backend
1766                                               classification
1767                                               nil
1768                                               nil)
1769           (spam-backend-put-article-todo-list backend
1770                                               classification
1771                                               nil
1772                                               t)
1773
1774           ;; eliminate duplicates
1775           (dolist (article (copy-sequence ulist))
1776             (when (memq article rlist)
1777               (incf delcount)
1778               (setq rlist (delq article rlist))
1779               (setq ulist (delq article ulist))))
1780
1781           (unless (zerop delcount)
1782             (gnus-message
1783              9
1784              "%d messages were saved the trouble of unregistering and then registering"
1785              delcount))
1786
1787           ;; unregister articles
1788           (unless (zerop (length ulist))
1789             (let ((num (spam-unregister-routine classification backend ulist)))
1790               (when (> num 0)
1791                 (gnus-message
1792                  6
1793                  "%d %s messages were unregistered by backend %s."
1794                  num
1795                  classification
1796                  backend))))
1797
1798             ;; register articles
1799             (unless (zerop (length rlist))
1800               (let ((num (spam-register-routine classification backend rlist)))
1801                 (when (> num 0)
1802                   (gnus-message
1803                    6
1804                    "%d %s messages were registered by backend %s."
1805                    num
1806                    classification
1807                    backend)))))))))
1808
1809 (defun spam-unregister-routine (classification
1810                                 backend
1811                                 specific-articles)
1812   (spam-register-routine classification backend specific-articles t))
1813
1814 (defun spam-register-routine (classification
1815                               backend
1816                               specific-articles
1817                               &optional unregister)
1818   (when (and (spam-classification-valid-p classification)
1819              (spam-backend-valid-p backend))
1820     (let* ((register-function
1821             (spam-backend-function backend classification 'registration))
1822            (unregister-function
1823             (spam-backend-function backend classification 'unregistration))
1824            (run-function (if unregister
1825                              unregister-function
1826                            register-function))
1827            (log-function (if unregister
1828                              'spam-log-undo-registration
1829                            'spam-log-processing-to-registry))
1830            article articles)
1831
1832       (when run-function
1833         ;; make list of articles, using specific-articles if given
1834         (setq articles (or specific-articles
1835                            (spam-list-articles
1836                             gnus-newsgroup-articles
1837                             classification)))
1838         ;; process them
1839         (when (> (length articles) 0)
1840           (gnus-message 5 "%s %d %s articles as %s using backend %s"
1841                         (if unregister "Unregistering" "Registering")
1842                         (length articles)
1843                         (if specific-articles "specific" "")
1844                         classification
1845                         backend)
1846           (funcall run-function articles)
1847           ;; now log all the registrations (or undo them, depending on
1848           ;; unregister)
1849           (dolist (article articles)
1850             (funcall log-function
1851                      (spam-fetch-field-message-id-fast article)
1852                      'process
1853                      classification
1854                      backend
1855                      gnus-newsgroup-name))))
1856       ;; return the number of articles processed
1857       (length articles))))
1858
1859 ;;; log a ham- or spam-processor invocation to the registry
1860 (defun spam-log-processing-to-registry (id type classification backend group)
1861   (when spam-log-to-registry
1862     (if (and (stringp id)
1863              (stringp group)
1864              (spam-process-type-valid-p type)
1865              (spam-classification-valid-p classification)
1866              (spam-backend-valid-p backend))
1867         (let ((cell-list (cdr-safe (gnus-registry-fetch-extra id type)))
1868               (cell (list classification backend group)))
1869           (push cell cell-list)
1870           (gnus-registry-store-extra-entry
1871            id
1872            type
1873            cell-list))
1874
1875       (gnus-error
1876        7
1877        (format "%s call with bad ID, type, classification, spam-backend, or group"
1878                "spam-log-processing-to-registry")))))
1879
1880 ;;; check if a ham- or spam-processor registration has been done
1881 (defun spam-log-registered-p (id type)
1882   (when spam-log-to-registry
1883     (if (and (stringp id)
1884              (spam-process-type-valid-p type))
1885         (cdr-safe (gnus-registry-fetch-extra id type))
1886       (progn
1887         (gnus-error
1888          7
1889          (format "%s called with bad ID, type, classification, or spam-backend"
1890                  "spam-log-registered-p"))
1891         nil))))
1892
1893 ;;; check what a ham- or spam-processor registration says
1894 ;;; returns nil if conflicting registrations are found
1895 (defun spam-log-registration-type (id type)
1896   (let ((count 0)
1897         decision)
1898     (dolist (reg (spam-log-registered-p id type))
1899       (let ((classification (nth 0 reg)))
1900         (when (spam-classification-valid-p classification)
1901           (when (and decision
1902                      (not (eq classification decision)))
1903             (setq count (+ 1 count)))
1904           (setq decision classification))))
1905     (if (< 0 count)
1906         nil
1907       decision)))
1908
1909
1910 ;;; check if a ham- or spam-processor registration needs to be undone
1911 (defun spam-log-unregistration-needed-p (id type classification backend)
1912   (when spam-log-to-registry
1913     (if (and (stringp id)
1914              (spam-process-type-valid-p type)
1915              (spam-classification-valid-p classification)
1916              (spam-backend-valid-p backend))
1917         (let ((cell-list (cdr-safe (gnus-registry-fetch-extra id type)))
1918               found)
1919           (dolist (cell cell-list)
1920             (unless found
1921               (when (and (eq classification (nth 0 cell))
1922                          (eq backend (nth 1 cell)))
1923                 (setq found t))))
1924           found)
1925       (progn
1926         (gnus-error
1927          7
1928          (format "%s called with bad ID, type, classification, or spam-backend"
1929                  "spam-log-unregistration-needed-p"))
1930         nil))))
1931
1932
1933 ;;; undo a ham- or spam-processor registration (the group is not used)
1934 (defun spam-log-undo-registration (id type classification backend &optional group)
1935   (when (and spam-log-to-registry
1936              (spam-log-unregistration-needed-p id type classification backend))
1937     (if (and (stringp id)
1938              (spam-process-type-valid-p type)
1939              (spam-classification-valid-p classification)
1940              (spam-backend-valid-p backend))
1941         (let ((cell-list (cdr-safe (gnus-registry-fetch-extra id type)))
1942               new-cell-list found)
1943           (dolist (cell cell-list)
1944             (unless (and (eq classification (nth 0 cell))
1945                          (eq backend (nth 1 cell)))
1946               (push cell new-cell-list)))
1947           (gnus-registry-store-extra-entry
1948            id
1949            type
1950            new-cell-list))
1951       (progn
1952         (gnus-error 7 (format "%s call with bad ID, type, spam-backend, or group"
1953                               "spam-log-undo-registration"))
1954         nil))))
1955
1956 ;;}}}
1957
1958 ;;{{{ backend functions
1959
1960 ;;{{{ Gmane xrefs
1961 (defun spam-check-gmane-xref ()
1962   (let ((header (or
1963                  (message-fetch-field "Xref")
1964                  (message-fetch-field "Newsgroups"))))
1965     (when header                        ; return nil when no header
1966       (when (string-match spam-gmane-xref-spam-group
1967                           header)
1968           spam-split-group))))
1969
1970 ;;}}}
1971
1972 ;;{{{ Regex body
1973
1974 (defun spam-check-regex-body ()
1975   (let ((spam-regex-headers-ham spam-regex-body-ham)
1976         (spam-regex-headers-spam spam-regex-body-spam))
1977     (spam-check-regex-headers t)))
1978
1979 ;;}}}
1980
1981 ;;{{{ Regex headers
1982
1983 (defun spam-check-regex-headers (&optional body)
1984   (let ((type (if body "body" "header"))
1985         ret found)
1986     (dolist (h-regex spam-regex-headers-ham)
1987       (unless found
1988         (goto-char (point-min))
1989         (when (re-search-forward h-regex nil t)
1990           (message "Ham regex %s search positive." type)
1991           (setq found t))))
1992     (dolist (s-regex spam-regex-headers-spam)
1993       (unless found
1994         (goto-char (point-min))
1995         (when (re-search-forward s-regex nil t)
1996           (message "Spam regex %s search positive." type)
1997           (setq found t)
1998           (setq ret spam-split-group))))
1999     ret))
2000
2001 ;;}}}
2002
2003 ;;{{{ Blackholes.
2004
2005 (defun spam-reverse-ip-string (ip)
2006   (when (stringp ip)
2007     (mapconcat 'identity
2008                (nreverse (split-string ip "\\."))
2009                ".")))
2010
2011 (defun spam-check-blackholes ()
2012   "Check the Received headers for blackholed relays."
2013   (let ((headers (message-fetch-field "received"))
2014         ips matches)
2015     (when headers
2016       (with-temp-buffer
2017         (insert headers)
2018         (goto-char (point-min))
2019         (gnus-message 6 "Checking headers for relay addresses")
2020         (while (re-search-forward
2021                 "\\([0-9]+\\.[0-9]+\\.[0-9]+\\.[0-9]+\\)" nil t)
2022           (gnus-message 9 "Blackhole search found host IP %s." (match-string 1))
2023           (push (spam-reverse-ip-string (match-string 1))
2024                 ips)))
2025       (dolist (server spam-blackhole-servers)
2026         (dolist (ip ips)
2027           (unless (and spam-blackhole-good-server-regex
2028                        ;; match the good-server-regex against the reversed (again) IP string
2029                        (string-match
2030                         spam-blackhole-good-server-regex
2031                         (spam-reverse-ip-string ip)))
2032             (unless matches
2033               (let ((query-string (concat ip "." server)))
2034                 (if spam-use-dig
2035                     (let ((query-result (query-dig query-string)))
2036                       (when query-result
2037                         (gnus-message 6 "(DIG): positive blackhole check '%s'"
2038                                       query-result)
2039                         (push (list ip server query-result)
2040                               matches)))
2041                   ;; else, if not using dig.el
2042                   (when (dns-query query-string)
2043                     (gnus-message 6 "positive blackhole check")
2044                     (push (list ip server (dns-query query-string 'TXT))
2045                           matches)))))))))
2046     (when matches
2047       spam-split-group)))
2048 ;;}}}
2049
2050 ;;{{{ Hashcash.
2051
2052 (defun spam-check-hashcash ()
2053   "Check the headers for hashcash payments."
2054   (ignore-errors (mail-check-payment)))  ;mail-check-payment returns a boolean
2055
2056 ;;}}}
2057
2058 ;;{{{ BBDB
2059
2060 ;;; original idea for spam-check-BBDB from Alexander Kotelnikov
2061 ;;; <sacha@giotto.sj.ru>
2062
2063 ;; all this is done inside a condition-case to trap errors
2064
2065 (eval-when-compile
2066   (autoload 'bbdb-buffer "bbdb")
2067   (autoload 'bbdb-create-internal "bbdb")
2068   (autoload 'bbdb-search-simple "bbdb"))
2069
2070 ;; Autoloaded in message, which we require.
2071 (declare-function gnus-extract-address-components "gnus-util" (from))
2072
2073 (eval-and-compile
2074   (when (condition-case nil
2075             (progn
2076               (require 'bbdb)
2077               (require 'bbdb-com))
2078           (file-error
2079            ;; `bbdb-records' should not be bound as an autoload function
2080            ;; before loading bbdb because of `bbdb-hashtable-size'.
2081            (defalias 'bbdb-records 'ignore)
2082            (defalias 'spam-BBDB-register-routine 'ignore)
2083            (defalias 'spam-enter-ham-BBDB 'ignore)
2084            nil))
2085
2086     ;; when the BBDB changes, we want to clear out our cache
2087     (defun spam-clear-cache-BBDB (&rest immaterial)
2088       (spam-clear-cache 'spam-use-BBDB))
2089
2090     (add-hook 'bbdb-change-hook 'spam-clear-cache-BBDB)
2091
2092     (defun spam-enter-ham-BBDB (addresses &optional remove)
2093       "Enter an address into the BBDB; implies ham (non-spam) sender"
2094       (dolist (from addresses)
2095         (when (stringp from)
2096           (let* ((parsed-address (gnus-extract-address-components from))
2097                  (name (or (nth 0 parsed-address) "Ham Sender"))
2098                  (remove-function (if remove
2099                                       'bbdb-delete-record-internal
2100                                     'ignore))
2101                  (net-address (nth 1 parsed-address))
2102                  (record (and net-address
2103                               (bbdb-search-simple nil net-address))))
2104             (when net-address
2105               (gnus-message 6 "%s address %s %s BBDB"
2106                             (if remove "Deleting" "Adding")
2107                             from
2108                             (if remove "from" "to"))
2109               (if record
2110                   (funcall remove-function record)
2111                 (bbdb-create-internal name nil net-address nil nil
2112                                       "ham sender added by spam.el")))))))
2113
2114     (defun spam-BBDB-register-routine (articles &optional unregister)
2115       (let (addresses)
2116         (dolist (article articles)
2117           (when (stringp (spam-fetch-field-from-fast article))
2118             (push (spam-fetch-field-from-fast article) addresses)))
2119         ;; now do the register/unregister action
2120         (spam-enter-ham-BBDB addresses unregister)))
2121
2122     (defun spam-BBDB-unregister-routine (articles)
2123       (spam-BBDB-register-routine articles t))
2124
2125     (defun spam-check-BBDB ()
2126       "Mail from people in the BBDB is classified as ham or non-spam"
2127       (let ((who (message-fetch-field "from"))
2128             bbdb-cache bbdb-hashtable)
2129         (when spam-cache-lookups
2130           (setq bbdb-cache (gethash 'spam-use-BBDB spam-caches))
2131           (unless bbdb-cache
2132             (setq bbdb-cache (make-vector 17 0)) ; a good starting hash value
2133             ;; this is based on the expanded (bbdb-hashtable) macro
2134             ;; without the debugging support
2135             (with-current-buffer (bbdb-buffer)
2136               (save-excursion
2137                 (save-window-excursion
2138                   (bbdb-records nil t)
2139                   (mapatoms
2140                    (lambda (symbol)
2141                      (intern (downcase (symbol-name symbol)) bbdb-cache))
2142                    bbdb-hashtable))))
2143             (puthash 'spam-use-BBDB bbdb-cache spam-caches)))
2144         (when who
2145           (setq who (nth 1 (gnus-extract-address-components who)))
2146           (if
2147               (if spam-cache-lookups
2148                   (intern-soft (downcase who) bbdb-cache)
2149                 (bbdb-search-simple nil who))
2150               t
2151             (if spam-use-BBDB-exclusive
2152                 spam-split-group
2153               nil)))))))
2154
2155 ;;}}}
2156
2157 ;;{{{ ifile
2158
2159 ;;; check the ifile backend; return nil if the mail was NOT classified
2160 ;;; as spam
2161
2162
2163 (defun spam-get-ifile-database-parameter ()
2164   "Return the command-line parameter for ifile's database.
2165 See `spam-ifile-database'."
2166   (if spam-ifile-database
2167       (format "--db-file=%s" spam-ifile-database)
2168     nil))
2169
2170 (defun spam-check-ifile ()
2171   "Check the ifile backend for the classification of this message."
2172   (let ((article-buffer-name (buffer-name))
2173         category return)
2174     (with-temp-buffer
2175       (let ((temp-buffer-name (buffer-name))
2176             (db-param (spam-get-ifile-database-parameter)))
2177         (save-excursion
2178           (set-buffer article-buffer-name)
2179           (apply 'call-process-region
2180                  (point-min) (point-max) spam-ifile-program
2181                  nil temp-buffer-name nil "-c"
2182                  (if db-param `(,db-param "-q") `("-q"))))
2183         ;; check the return now (we're back in the temp buffer)
2184         (goto-char (point-min))
2185         (if (not (eobp))
2186             (setq category (buffer-substring (point) (point-at-eol))))
2187         (when (not (zerop (length category))) ; we need a category here
2188           (if spam-ifile-all-categories
2189               (setq return category)
2190             ;; else, if spam-ifile-all-categories is not set...
2191             (when (string-equal spam-ifile-spam-category category)
2192               (setq return spam-split-group)))))) ; note return is nil otherwise
2193     return))
2194
2195 (defun spam-ifile-register-with-ifile (articles category &optional unregister)
2196   "Register an article, given as a string, with a category.
2197 Uses `gnus-newsgroup-name' if category is nil (for ham registration)."
2198   (let ((category (or category gnus-newsgroup-name))
2199         (add-or-delete-option (if unregister "-d" "-i"))
2200         (db (spam-get-ifile-database-parameter))
2201         parameters)
2202     (with-temp-buffer
2203       (dolist (article articles)
2204         (let ((article-string (spam-get-article-as-string article)))
2205           (when (stringp article-string)
2206             (insert article-string))))
2207       (apply 'call-process-region
2208              (point-min) (point-max) spam-ifile-program
2209              nil nil nil
2210              add-or-delete-option category
2211              (if db `(,db "-h") `("-h"))))))
2212
2213 (defun spam-ifile-register-spam-routine (articles &optional unregister)
2214   (spam-ifile-register-with-ifile articles spam-ifile-spam-category unregister))
2215
2216 (defun spam-ifile-unregister-spam-routine (articles)
2217   (spam-ifile-register-spam-routine articles t))
2218
2219 (defun spam-ifile-register-ham-routine (articles &optional unregister)
2220   (spam-ifile-register-with-ifile articles spam-ifile-ham-category unregister))
2221
2222 (defun spam-ifile-unregister-ham-routine (articles)
2223   (spam-ifile-register-ham-routine articles t))
2224
2225 ;;}}}
2226
2227 ;;{{{ spam-stat
2228
2229 (eval-when-compile
2230   (autoload 'spam-stat-buffer-change-to-non-spam "spam-stat")
2231   (autoload 'spam-stat-buffer-change-to-spam "spam-stat")
2232   (autoload 'spam-stat-buffer-is-non-spam "spam-stat")
2233   (autoload 'spam-stat-buffer-is-spam "spam-stat")
2234   (autoload 'spam-stat-load "spam-stat")
2235   (autoload 'spam-stat-save "spam-stat")
2236   (autoload 'spam-stat-split-fancy "spam-stat"))
2237
2238 (eval-and-compile
2239   (when (condition-case nil
2240             (let ((spam-stat-install-hooks nil))
2241               (require 'spam-stat))
2242           (file-error
2243            (defalias 'spam-stat-register-ham-routine 'ignore)
2244            (defalias 'spam-stat-register-spam-routine 'ignore)
2245            nil))
2246
2247     (defun spam-check-stat ()
2248       "Check the spam-stat backend for the classification of this message"
2249       (let ((spam-stat-split-fancy-spam-group spam-split-group) ; override
2250             (spam-stat-buffer (buffer-name)) ; stat the current buffer
2251             category return)
2252         (spam-stat-split-fancy)))
2253
2254     (defun spam-stat-register-spam-routine (articles &optional unregister)
2255       (dolist (article articles)
2256         (let ((article-string (spam-get-article-as-string article)))
2257           (with-temp-buffer
2258             (insert article-string)
2259             (if unregister
2260                 (spam-stat-buffer-change-to-non-spam)
2261               (spam-stat-buffer-is-spam))))))
2262
2263     (defun spam-stat-unregister-spam-routine (articles)
2264       (spam-stat-register-spam-routine articles t))
2265
2266     (defun spam-stat-register-ham-routine (articles &optional unregister)
2267       (dolist (article articles)
2268         (let ((article-string (spam-get-article-as-string article)))
2269           (with-temp-buffer
2270             (insert article-string)
2271             (if unregister
2272                 (spam-stat-buffer-change-to-spam)
2273               (spam-stat-buffer-is-non-spam))))))
2274
2275     (defun spam-stat-unregister-ham-routine (articles)
2276       (spam-stat-register-ham-routine articles t))
2277
2278     (defun spam-maybe-spam-stat-load ()
2279       (when spam-use-stat (spam-stat-load)))
2280
2281     (defun spam-maybe-spam-stat-save ()
2282       (when spam-use-stat (spam-stat-save)))))
2283
2284 ;;}}}
2285
2286 ;;{{{ Blacklists and whitelists.
2287
2288 (defvar spam-whitelist-cache nil)
2289 (defvar spam-blacklist-cache nil)
2290
2291 (defun spam-kill-whole-line ()
2292   (beginning-of-line)
2293   (let ((kill-whole-line t))
2294     (kill-line)))
2295
2296 ;;; address can be a list, too
2297 (defun spam-enter-whitelist (address &optional remove)
2298   "Enter ADDRESS (list or single) into the whitelist.
2299 With a non-nil REMOVE, remove them."
2300   (interactive "sAddress: ")
2301   (spam-enter-list address spam-whitelist remove)
2302   (setq spam-whitelist-cache nil)
2303   (spam-clear-cache 'spam-use-whitelist))
2304
2305 ;;; address can be a list, too
2306 (defun spam-enter-blacklist (address &optional remove)
2307   "Enter ADDRESS (list or single) into the blacklist.
2308 With a non-nil REMOVE, remove them."
2309   (interactive "sAddress: ")
2310   (spam-enter-list address spam-blacklist remove)
2311   (setq spam-blacklist-cache nil)
2312   (spam-clear-cache 'spam-use-whitelist))
2313
2314 (defun spam-enter-list (addresses file &optional remove)
2315   "Enter ADDRESSES into the given FILE.
2316 Either the whitelist or the blacklist files can be used.
2317 With a non-nil REMOVE, remove the ADDRESSES."
2318   (if (stringp addresses)
2319       (spam-enter-list (list addresses) file remove)
2320     ;; else, we have a list of addresses here
2321     (unless (file-exists-p (file-name-directory file))
2322       (make-directory (file-name-directory file) t))
2323     (save-excursion
2324       (set-buffer
2325        (find-file-noselect file))
2326       (dolist (a addresses)
2327         (when (stringp a)
2328           (goto-char (point-min))
2329           (if (re-search-forward (regexp-quote a) nil t)
2330               ;; found the address
2331               (when remove
2332                 (spam-kill-whole-line))
2333             ;; else, the address was not found
2334             (unless remove
2335               (goto-char (point-max))
2336               (unless (bobp)
2337                 (insert "\n"))
2338               (insert a "\n")))))
2339       (save-buffer))))
2340
2341 (defun spam-filelist-build-cache (type)
2342   (let ((cache (if (eq type 'spam-use-blacklist)
2343                    spam-blacklist-cache
2344                  spam-whitelist-cache))
2345         parsed-cache)
2346     (unless (gethash type spam-caches)
2347       (while cache
2348         (let ((address (pop cache)))
2349           (unless (zerop (length address)) ; 0 for a nil address too
2350             (setq address (regexp-quote address))
2351             ;; fix regexp-quote's treatment of user-intended regexes
2352             (while (string-match "\\\\\\*" address)
2353               (setq address (replace-match ".*" t t address))))
2354           (push address parsed-cache)))
2355       (puthash type parsed-cache spam-caches))))
2356
2357 (defun spam-filelist-check-cache (type from)
2358   (when (stringp from)
2359     (spam-filelist-build-cache type)
2360     (let (found)
2361       (dolist (address (gethash type spam-caches))
2362         (when (and address (string-match address from))
2363           (setq found t)
2364           (return)))
2365       found)))
2366
2367 ;;; returns t if the sender is in the whitelist, nil or
2368 ;;; spam-split-group otherwise
2369 (defun spam-check-whitelist ()
2370   ;; FIXME!  Should it detect when file timestamps change?
2371   (unless spam-whitelist-cache
2372     (setq spam-whitelist-cache (spam-parse-list spam-whitelist)))
2373   (if (spam-from-listed-p 'spam-use-whitelist)
2374       t
2375     (if spam-use-whitelist-exclusive
2376         spam-split-group
2377       nil)))
2378
2379 (defun spam-check-blacklist ()
2380   ;; FIXME!  Should it detect when file timestamps change?
2381   (unless spam-blacklist-cache
2382     (setq spam-blacklist-cache (spam-parse-list spam-blacklist)))
2383   (and (spam-from-listed-p 'spam-use-blacklist)
2384        spam-split-group))
2385
2386 (defun spam-parse-list (file)
2387   (when (file-readable-p file)
2388     (let (contents address)
2389       (with-temp-buffer
2390         (insert-file-contents file)
2391         (while (not (eobp))
2392           (setq address (buffer-substring (point) (point-at-eol)))
2393           (forward-line 1)
2394           ;; insert the e-mail address if detected, otherwise the raw data
2395           (unless (zerop (length address))
2396             (let ((pure-address (nth 1 (gnus-extract-address-components address))))
2397               (push (or pure-address address) contents)))))
2398       (nreverse contents))))
2399
2400 (defun spam-from-listed-p (type)
2401   (let ((from (message-fetch-field "from"))
2402         found)
2403     (spam-filelist-check-cache type from)))
2404
2405 (defun spam-filelist-register-routine (articles blacklist &optional unregister)
2406   (let ((de-symbol (if blacklist 'spam-use-whitelist 'spam-use-blacklist))
2407         (declassification (if blacklist 'ham 'spam))
2408         (enter-function
2409          (if blacklist 'spam-enter-blacklist 'spam-enter-whitelist))
2410         (remove-function
2411          (if blacklist 'spam-enter-whitelist 'spam-enter-blacklist))
2412         from addresses unregister-list article-unregister-list)
2413     (dolist (article articles)
2414       (let ((from (spam-fetch-field-from-fast article))
2415             (id (spam-fetch-field-message-id-fast article))
2416             sender-ignored)
2417         (when (stringp from)
2418           (dolist (ignore-regex spam-blacklist-ignored-regexes)
2419             (when (and (not sender-ignored)
2420                        (stringp ignore-regex)
2421                        (string-match ignore-regex from))
2422               (setq sender-ignored t)))
2423           ;; remember the messages we need to unregister, unless remove is set
2424           (when (and
2425                  (null unregister)
2426                  (spam-log-unregistration-needed-p
2427                   id 'process declassification de-symbol))
2428             (push article article-unregister-list)
2429             (push from unregister-list))
2430           (unless sender-ignored
2431             (push from addresses)))))
2432
2433     (if unregister
2434         (funcall enter-function addresses t) ; unregister all these addresses
2435       ;; else, register normally and unregister what we need to
2436       (funcall remove-function unregister-list t)
2437       (dolist (article article-unregister-list)
2438         (spam-log-undo-registration
2439          (spam-fetch-field-message-id-fast article)
2440          'process
2441          declassification
2442          de-symbol))
2443       (funcall enter-function addresses nil))))
2444
2445 (defun spam-blacklist-unregister-routine (articles)
2446   (spam-blacklist-register-routine articles t))
2447
2448 (defun spam-blacklist-register-routine (articles &optional unregister)
2449   (spam-filelist-register-routine articles t unregister))
2450
2451 (defun spam-whitelist-unregister-routine (articles)
2452   (spam-whitelist-register-routine articles t))
2453
2454 (defun spam-whitelist-register-routine (articles &optional unregister)
2455   (spam-filelist-register-routine articles nil unregister))
2456
2457 ;;}}}
2458
2459 ;;{{{ Spam-report glue (gmane and resend reporting)
2460 (defun spam-report-gmane-register-routine (articles)
2461   (when articles
2462     (apply 'spam-report-gmane-spam articles)))
2463
2464 (defun spam-report-gmane-unregister-routine (articles)
2465   (when articles
2466     (apply 'spam-report-gmane-ham articles)))
2467
2468 (defun spam-report-resend-register-ham-routine (articles)
2469   (spam-report-resend-register-routine articles t))
2470
2471 (defun spam-report-resend-register-routine (articles &optional ham)
2472   (let* ((resend-to-gp
2473           (if ham
2474               (gnus-parameter-ham-resend-to gnus-newsgroup-name)
2475             (gnus-parameter-spam-resend-to gnus-newsgroup-name)))
2476          (spam-report-resend-to (or (car-safe resend-to-gp)
2477                                     spam-report-resend-to)))
2478     (spam-report-resend articles ham)))
2479
2480 ;;}}}
2481
2482 ;;{{{ Bogofilter
2483 (defun spam-check-bogofilter-headers (&optional score)
2484   (let ((header (message-fetch-field spam-bogofilter-header)))
2485     (when header                        ; return nil when no header
2486       (if score                         ; scoring mode
2487           (if (string-match "spamicity=\\([0-9.]+\\)" header)
2488               (match-string 1 header)
2489             "0")
2490         ;; spam detection mode
2491         (when (string-match spam-bogofilter-bogosity-positive-spam-header
2492                             header)
2493           spam-split-group)))))
2494
2495 ;; return something sensible if the score can't be determined
2496 (defun spam-bogofilter-score (&optional recheck)
2497   "Get the Bogofilter spamicity score."
2498   (interactive "P")
2499   (save-window-excursion
2500     (gnus-summary-show-article t)
2501     (set-buffer gnus-article-buffer)
2502     (let ((score (or (unless recheck
2503                        (spam-check-bogofilter-headers t))
2504                      (spam-check-bogofilter t))))
2505       (gnus-summary-show-article)
2506       (message "Spamicity score %s" score)
2507       (or score "0"))))
2508
2509 (defun spam-verify-bogofilter ()
2510   "Verify the Bogofilter version is sufficient."
2511   (when (eq spam-bogofilter-valid 'unknown)
2512     (setq spam-bogofilter-valid
2513           (not (string-match "^bogofilter version 0\\.\\([0-9]\\|1[01]\\)\\."
2514                              (shell-command-to-string
2515                               (format "%s -V" spam-bogofilter-program))))))
2516   spam-bogofilter-valid)
2517
2518 (defun spam-check-bogofilter (&optional score)
2519   "Check the Bogofilter backend for the classification of this message."
2520   (if (spam-verify-bogofilter)
2521       (let ((article-buffer-name (buffer-name))
2522             (db spam-bogofilter-database-directory)
2523             return)
2524         (with-temp-buffer
2525           (let ((temp-buffer-name (buffer-name)))
2526             (save-excursion
2527               (set-buffer article-buffer-name)
2528               (apply 'call-process-region
2529                      (point-min) (point-max)
2530                      spam-bogofilter-program
2531                      nil temp-buffer-name nil
2532                      (if db `("-d" ,db "-v") `("-v"))))
2533             (setq return (spam-check-bogofilter-headers score))))
2534         return)
2535     (gnus-error 5 "`spam.el' doesn't support obsolete bogofilter versions")))
2536
2537 (defun spam-bogofilter-register-with-bogofilter (articles
2538                                                  spam
2539                                                  &optional unregister)
2540   "Register an article, given as a string, as spam or non-spam."
2541   (if (spam-verify-bogofilter)
2542       (dolist (article articles)
2543         (let ((article-string (spam-get-article-as-string article))
2544               (db spam-bogofilter-database-directory)
2545               (switch (if unregister
2546                           (if spam
2547                               spam-bogofilter-spam-strong-switch
2548                             spam-bogofilter-ham-strong-switch)
2549                         (if spam
2550                             spam-bogofilter-spam-switch
2551                           spam-bogofilter-ham-switch))))
2552           (when (stringp article-string)
2553             (with-temp-buffer
2554               (insert article-string)
2555
2556               (apply 'call-process-region
2557                      (point-min) (point-max)
2558                      spam-bogofilter-program
2559                      nil nil nil switch
2560                      (if db `("-d" ,db "-v") `("-v")))))))
2561     (gnus-error 5 "`spam.el' doesn't support obsolete bogofilter versions")))
2562
2563 (defun spam-bogofilter-register-spam-routine (articles &optional unregister)
2564   (spam-bogofilter-register-with-bogofilter articles t unregister))
2565
2566 (defun spam-bogofilter-unregister-spam-routine (articles)
2567   (spam-bogofilter-register-spam-routine articles t))
2568
2569 (defun spam-bogofilter-register-ham-routine (articles &optional unregister)
2570   (spam-bogofilter-register-with-bogofilter articles nil unregister))
2571
2572 (defun spam-bogofilter-unregister-ham-routine (articles)
2573   (spam-bogofilter-register-ham-routine articles t))
2574
2575
2576 ;;}}}
2577
2578 ;;{{{ spamoracle
2579 (defun spam-check-spamoracle ()
2580   "Run spamoracle on an article to determine whether it's spam."
2581   (let ((article-buffer-name (buffer-name)))
2582     (with-temp-buffer
2583       (let ((temp-buffer-name (buffer-name)))
2584         (save-excursion
2585           (set-buffer article-buffer-name)
2586           (let ((status
2587                  (apply 'call-process-region
2588                         (point-min) (point-max)
2589                         spam-spamoracle-binary
2590                         nil temp-buffer-name nil
2591                         (if spam-spamoracle-database
2592                             `("-f" ,spam-spamoracle-database "mark")
2593                           '("mark")))))
2594             (if (eq 0 status)
2595                 (progn
2596                   (set-buffer temp-buffer-name)
2597                   (goto-char (point-min))
2598                   (when (re-search-forward "^X-Spam: yes;" nil t)
2599                     spam-split-group))
2600               (error "Error running spamoracle: %s" status))))))))
2601
2602 (defun spam-spamoracle-learn (articles article-is-spam-p &optional unregister)
2603   "Run spamoracle in training mode."
2604   (with-temp-buffer
2605     (let ((temp-buffer-name (buffer-name)))
2606       (save-excursion
2607         (goto-char (point-min))
2608         (dolist (article articles)
2609           (insert (spam-get-article-as-string article)))
2610         (let* ((arg (if (spam-xor unregister article-is-spam-p)
2611                         "-spam"
2612                       "-good"))
2613                (status
2614                 (apply 'call-process-region
2615                        (point-min) (point-max)
2616                        spam-spamoracle-binary
2617                        nil temp-buffer-name nil
2618                        (if spam-spamoracle-database
2619                            `("-f" ,spam-spamoracle-database
2620                              "add" ,arg)
2621                          `("add" ,arg)))))
2622           (unless (eq 0 status)
2623             (error "Error running spamoracle: %s" status)))))))
2624
2625 (defun spam-spamoracle-learn-ham (articles &optional unregister)
2626   (spam-spamoracle-learn articles nil unregister))
2627
2628 (defun spam-spamoracle-unlearn-ham (articles &optional unregister)
2629   (spam-spamoracle-learn-ham articles t))
2630
2631 (defun spam-spamoracle-learn-spam (articles &optional unregister)
2632   (spam-spamoracle-learn articles t unregister))
2633
2634 (defun spam-spamoracle-unlearn-spam (articles &optional unregister)
2635   (spam-spamoracle-learn-spam articles t))
2636
2637 ;;}}}
2638
2639 ;;{{{ SpamAssassin
2640 ;;; based mostly on the bogofilter code
2641 (defun spam-check-spamassassin-headers (&optional score)
2642   "Check the SpamAssassin headers for the classification of this message."
2643   (if score                             ; scoring mode
2644       (let ((header (message-fetch-field spam-spamassassin-spam-status-header)))
2645         (when header
2646           (if (string-match spam-spamassassin-score-regexp header)
2647               (match-string 1 header)
2648             "0")))
2649     ;; spam detection mode
2650     (let ((header (message-fetch-field spam-spamassassin-spam-flag-header)))
2651           (when header                  ; return nil when no header
2652             (when (string-match spam-spamassassin-positive-spam-flag-header
2653                                 header)
2654               spam-split-group)))))
2655
2656 (defun spam-check-spamassassin (&optional score)
2657   "Check the SpamAssassin backend for the classification of this message."
2658   (let ((article-buffer-name (buffer-name)))
2659     (with-temp-buffer
2660       (let ((temp-buffer-name (buffer-name)))
2661         (save-excursion
2662           (set-buffer article-buffer-name)
2663           (apply 'call-process-region
2664                  (point-min) (point-max) spam-assassin-program
2665                  nil temp-buffer-name nil spam-spamassassin-arguments))
2666         ;; check the return now (we're back in the temp buffer)
2667         (goto-char (point-min))
2668         (spam-check-spamassassin-headers score)))))
2669
2670 ;; return something sensible if the score can't be determined
2671 (defun spam-spamassassin-score (&optional recheck)
2672   "Get the SpamAssassin score"
2673   (interactive "P")
2674   (save-window-excursion
2675     (gnus-summary-show-article t)
2676     (set-buffer gnus-article-buffer)
2677     (let ((score (or (unless recheck
2678                        (spam-check-spamassassin-headers t))
2679                      (spam-check-spamassassin t))))
2680       (gnus-summary-show-article)
2681       (message "SpamAssassin score %s" score)
2682       (or score "0"))))
2683
2684 (defun spam-spamassassin-register-with-sa-learn (articles spam
2685                                                  &optional unregister)
2686   "Register articles with spamassassin's sa-learn as spam or non-spam."
2687   (if articles
2688       (let ((action (if unregister spam-sa-learn-unregister-switch
2689                       (if spam spam-sa-learn-spam-switch
2690                         spam-sa-learn-ham-switch)))
2691             (summary-buffer-name (buffer-name)))
2692         (with-temp-buffer
2693           ;; group the articles into mbox format
2694           (dolist (article articles)
2695             (let (article-string)
2696               (save-excursion
2697                 (set-buffer summary-buffer-name)
2698                 (setq article-string (spam-get-article-as-string article)))
2699               (when (stringp article-string)
2700                 (insert "From \n") ; mbox separator (sa-learn only checks the
2701                                    ; first five chars, so we can get away with
2702                                    ; a bogus line))
2703                 (insert article-string)
2704                 (insert "\n"))))
2705           ;; call sa-learn on all messages at the same time
2706           (apply 'call-process-region
2707                  (point-min) (point-max)
2708                  spam-sa-learn-program
2709                  nil nil nil "--mbox"
2710                  (if spam-sa-learn-rebuild
2711                      (list action)
2712                    `("--no-rebuild" ,action)))))))
2713
2714 (defun spam-spamassassin-register-spam-routine (articles &optional unregister)
2715   (spam-spamassassin-register-with-sa-learn articles t unregister))
2716
2717 (defun spam-spamassassin-register-ham-routine (articles &optional unregister)
2718   (spam-spamassassin-register-with-sa-learn articles nil unregister))
2719
2720 (defun spam-spamassassin-unregister-spam-routine (articles)
2721   (spam-spamassassin-register-with-sa-learn articles t t))
2722
2723 (defun spam-spamassassin-unregister-ham-routine (articles)
2724   (spam-spamassassin-register-with-sa-learn articles nil t))
2725
2726 ;;}}}
2727
2728 ;;{{{ Bsfilter
2729 ;;; based mostly on the bogofilter code
2730 (defun spam-check-bsfilter-headers (&optional score)
2731   (if score
2732       (or (nnmail-fetch-field spam-bsfilter-probability-header)
2733           "0")
2734     (let ((header (nnmail-fetch-field spam-bsfilter-header)))
2735       (when header ; return nil when no header
2736         (when (string-match "YES" header)
2737           spam-split-group)))))
2738
2739 ;; return something sensible if the score can't be determined
2740 (defun spam-bsfilter-score (&optional recheck)
2741   "Get the Bsfilter spamicity score."
2742   (interactive "P")
2743   (save-window-excursion
2744     (gnus-summary-show-article t)
2745     (set-buffer gnus-article-buffer)
2746     (let ((score (or (unless recheck
2747                        (spam-check-bsfilter-headers t))
2748                      (spam-check-bsfilter t))))
2749       (gnus-summary-show-article)
2750       (message "Spamicity score %s" score)
2751       (or score "0"))))
2752
2753 (defun spam-check-bsfilter (&optional score)
2754   "Check the Bsfilter backend for the classification of this message."
2755   (let ((article-buffer-name (buffer-name))
2756         (dir spam-bsfilter-database-directory)
2757         return)
2758     (with-temp-buffer
2759       (let ((temp-buffer-name (buffer-name)))
2760         (save-excursion
2761           (set-buffer article-buffer-name)
2762           (apply 'call-process-region
2763                  (point-min) (point-max)
2764                  spam-bsfilter-program
2765                  nil temp-buffer-name nil
2766                  "--pipe"
2767                  "--insert-flag"
2768                  "--insert-probability"
2769                  (when dir
2770                    (list "--homedir" dir))))
2771         (setq return (spam-check-bsfilter-headers score))))
2772     return))
2773
2774 (defun spam-bsfilter-register-with-bsfilter (articles
2775                                              spam
2776                                              &optional unregister)
2777   "Register an article, given as a string, as spam or non-spam."
2778   (dolist (article articles)
2779     (let ((article-string (spam-get-article-as-string article))
2780           (switch (if unregister
2781                       (if spam
2782                           spam-bsfilter-spam-strong-switch
2783                         spam-bsfilter-ham-strong-switch)
2784                     (if spam
2785                         spam-bsfilter-spam-switch
2786                       spam-bsfilter-ham-switch))))
2787       (when (stringp article-string)
2788         (with-temp-buffer
2789           (insert article-string)
2790           (apply 'call-process-region
2791                  (point-min) (point-max)
2792                  spam-bsfilter-program
2793                  nil nil nil switch
2794                  "--update"
2795                  (when spam-bsfilter-database-directory
2796                    (list "--homedir"
2797                          spam-bsfilter-database-directory))))))))
2798
2799 (defun spam-bsfilter-register-spam-routine (articles &optional unregister)
2800   (spam-bsfilter-register-with-bsfilter articles t unregister))
2801
2802 (defun spam-bsfilter-unregister-spam-routine (articles)
2803   (spam-bsfilter-register-spam-routine articles t))
2804
2805 (defun spam-bsfilter-register-ham-routine (articles &optional unregister)
2806   (spam-bsfilter-register-with-bsfilter articles nil unregister))
2807
2808 (defun spam-bsfilter-unregister-ham-routine (articles)
2809   (spam-bsfilter-register-ham-routine articles t))
2810
2811 ;;}}}
2812
2813 ;;{{{ CRM114 Mailfilter
2814 (defun spam-check-crm114-headers (&optional score)
2815   (let ((header (message-fetch-field spam-crm114-header)))
2816     (when header                        ; return nil when no header
2817       (if score                         ; scoring mode
2818           (if (string-match "( pR: \\([0-9.-]+\\)" header)
2819               (match-string 1 header)
2820             "0")
2821         ;; spam detection mode
2822         (when (string-match spam-crm114-positive-spam-header
2823                             header)
2824           spam-split-group)))))
2825
2826 ;; return something sensible if the score can't be determined
2827 (defun spam-crm114-score ()
2828   "Get the CRM114 Mailfilter pR."
2829   (interactive)
2830   (save-window-excursion
2831     (gnus-summary-show-article t)
2832     (set-buffer gnus-article-buffer)
2833     (let ((score (or (spam-check-crm114-headers t)
2834                      (spam-check-crm114 t))))
2835       (gnus-summary-show-article)
2836       (message "pR: %s" score)
2837       (or score "0"))))
2838
2839 (defun spam-check-crm114 (&optional score)
2840   "Check the CRM114 Mailfilter backend for the classification of this message."
2841   (let ((article-buffer-name (buffer-name))
2842         (db spam-crm114-database-directory)
2843         return)
2844     (with-temp-buffer
2845       (let ((temp-buffer-name (buffer-name)))
2846         (save-excursion
2847           (set-buffer article-buffer-name)
2848           (apply 'call-process-region
2849                  (point-min) (point-max)
2850                  spam-crm114-program
2851                  nil temp-buffer-name nil
2852                  (when db (list (concat "--fileprefix=" db)))))
2853         (setq return (spam-check-crm114-headers score))))
2854     return))
2855
2856 (defun spam-crm114-register-with-crm114 (articles
2857                                          spam
2858                                          &optional unregister)
2859   "Register an article, given as a string, as spam or non-spam."
2860   (dolist (article articles)
2861     (let ((article-string (spam-get-article-as-string article))
2862           (db spam-crm114-database-directory)
2863           (switch (if unregister
2864                       (if spam
2865                           spam-crm114-spam-strong-switch
2866                         spam-crm114-ham-strong-switch)
2867                     (if spam
2868                         spam-crm114-spam-switch
2869                       spam-crm114-ham-switch))))
2870       (when (stringp article-string)
2871         (with-temp-buffer
2872           (insert article-string)
2873
2874           (apply 'call-process-region
2875                  (point-min) (point-max)
2876                  spam-crm114-program
2877                  nil nil nil
2878                  (when db (list switch (concat "--fileprefix=" db)))))))))
2879
2880 (defun spam-crm114-register-spam-routine (articles &optional unregister)
2881   (spam-crm114-register-with-crm114 articles t unregister))
2882
2883 (defun spam-crm114-unregister-spam-routine (articles)
2884   (spam-crm114-register-spam-routine articles t))
2885
2886 (defun spam-crm114-register-ham-routine (articles &optional unregister)
2887   (spam-crm114-register-with-crm114 articles nil unregister))
2888
2889 (defun spam-crm114-unregister-ham-routine (articles)
2890   (spam-crm114-register-ham-routine articles t))
2891
2892 ;;}}}
2893
2894 ;;}}}
2895
2896 ;;{{{ Hooks
2897
2898 ;;;###autoload
2899 (defun spam-initialize (&rest symbols)
2900   "Install the spam.el hooks and do other initialization.
2901 When SYMBOLS is given, set those variables to t.  This is so you
2902 can call `spam-initialize' before you set spam-use-* variables on
2903 explicitly, and matters only if you need the extra headers
2904 installed through `spam-necessary-extra-headers'."
2905   (interactive)
2906
2907   (dolist (var symbols)
2908     (set var t))
2909
2910   (dolist (header (spam-necessary-extra-headers))
2911     (add-to-list 'nnmail-extra-headers header)
2912     (add-to-list 'gnus-extra-headers header))
2913
2914   (setq spam-install-hooks t)
2915   ;; TODO: How do we redo this every time the `spam' face is customized?
2916   (push '((eq mark gnus-spam-mark) . spam)
2917         gnus-summary-highlight)
2918   ;; Add hooks for loading and saving the spam stats
2919   (add-hook 'gnus-save-newsrc-hook 'spam-maybe-spam-stat-save)
2920   (add-hook 'gnus-get-top-new-news-hook 'spam-maybe-spam-stat-load)
2921   (add-hook 'gnus-startup-hook 'spam-maybe-spam-stat-load)
2922   (add-hook 'gnus-summary-prepare-exit-hook 'spam-summary-prepare-exit)
2923   (add-hook 'gnus-summary-prepare-hook 'spam-summary-prepare)
2924   (add-hook 'gnus-get-new-news-hook 'spam-setup-widening)
2925   (add-hook 'gnus-summary-prepared-hook 'spam-find-spam))
2926
2927 (defun spam-unload-hook ()
2928   "Uninstall the spam.el hooks."
2929   (interactive)
2930   (remove-hook 'gnus-save-newsrc-hook 'spam-maybe-spam-stat-save)
2931   (remove-hook 'gnus-get-top-new-news-hook 'spam-maybe-spam-stat-load)
2932   (remove-hook 'gnus-startup-hook 'spam-maybe-spam-stat-load)
2933   (remove-hook 'gnus-summary-prepare-exit-hook 'spam-summary-prepare-exit)
2934   (remove-hook 'gnus-summary-prepare-hook 'spam-summary-prepare)
2935   (remove-hook 'gnus-get-new-news-hook 'spam-setup-widening)
2936   (remove-hook 'gnus-summary-prepare-hook 'spam-find-spam))
2937
2938 (add-hook 'spam-unload-hook 'spam-unload-hook)
2939
2940 (when spam-install-hooks
2941   (spam-initialize))
2942 ;;}}}
2943
2944 (provide 'spam)
2945
2946 ;; arch-tag: 07e6e0ca-ab0a-4412-b445-1f6c72a4f27f
2947 ;;; spam.el ends here