| blob | d06559676db7d8aa38e8e9815fb363a9271d7d40 |
1 ;;; spam.el --- Identifying spam
3 ;; Copyright (C) 2002-2014 Free Software Foundation, Inc.
5 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
6 ;; Maintainer: Ted Zlatanov <tzz@lifelogs.com>
7 ;; Keywords: network, spam, mail, bogofilter, BBDB, dspam, dig, whitelist, blacklist, gmane, hashcash, spamassassin, bsfilter, ifile, stat, crm114, spamoracle
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;;; This module addresses a few aspects of spam control under Gnus. Page
27 ;;; breaks are used for grouping declarations and documentation relating to
28 ;;; each particular aspect.
30 ;;; The integration with Gnus is not yet complete. See various `FIXME'
31 ;;; comments, below, for supplementary explanations or discussions.
33 ;;; Several TODO items are marked as such
35 ;; TODO: cross-server splitting, remote processing, training through files
37 ;;; Code:
39 ;;{{{ compilation directives and autoloads/requires
41 ;; For Emacs <22.2 and XEmacs.
50 ;;; for the definitions of group content classification and spam processors
55 ;; for nnimap-split-download-body-default
58 ;; autoload query-dig
61 ;; autoload spam-report
67 ;; autoload gnus-registry
73 ;; autoload dns-query
76 ;;}}}
78 ;;{{{ Main parameters.
80 "List of spam.el backends with all the pertinent data.
84 "Spam configuration."
90 "Exit behavior at the time of summary exit.
91 Note that setting the `spam-use-move' or `spam-use-copy' backends on
92 a group through group/topic parameters overrides this mechanism."
96 default)
99 move-all)
102 move-none))
106 "Directory for spam whitelists and blacklists."
111 "Whether new messages in a spam group should get the spam-mark."
113 ;; :version "22.1" ;; Gnus 5.10.8 / No Gnus 0.3
117 "Whether spam/ham processing should be logged in the registry."
122 "Whether `spam-split' should work with symbols or group names."
127 "Whether `spam-split' should ALWAYS work with symbols or group names.
128 Do not set this if you use `spam-split' in a fancy split method."
133 "Whether only unseen articles should be marked as spam in spam groups.
134 When nil, all unread articles in a spam group are marked as
135 spam. Set this if you want to leave an article unread in a spam group
136 without losing it to the automatic spam-marking process."
141 "Whether ham should be marked unread before it's moved.
142 The article is moved out of a spam group according to `ham-process-destination'.
143 This variable is an official entry in the international Longest Variable Name
144 Competition."
149 "Whether `spam-split' should be ignored while resplitting ham.
150 This is useful to prevent ham from ending up in the same spam
151 group after the resplit. Don't set this to t if you have `spam-split' as the
152 last rule in your split configuration."
157 "Should spam.el recheck all messages when autodetecting?
158 Normally this is nil, so only unseen messages will be checked."
163 "The location of the whitelist.
164 The file format is one regular expression per line.
165 The regular expression is matched against the address."
170 "The location of the blacklist.
171 The file format is one regular expression per line.
172 The regular expression is matched against the address."
177 "Whether `query-dig' should be used instead of `dns-query'."
182 "Whether the Gmane spam xref should be used by `spam-split'."
187 "Whether the blacklist should be used by `spam-split'."
192 "Regular expressions that the blacklist should ignore."
197 "Whether the whitelist should be used by `spam-split'."
202 "Whether whitelist-exclusive should be used by `spam-split'.
203 Exclusive whitelisting means that all messages from senders not in the whitelist
204 are considered spam."
209 "Whether blackholes should be used by `spam-split'."
214 "Whether hashcash payments should be detected by `spam-split'."
219 "Whether a header regular expression match should be used by `spam-split'.
220 Also see the variables `spam-regex-headers-spam' and `spam-regex-headers-ham'."
225 "Whether a body regular expression match should be used by `spam-split'.
226 Also see the variables `spam-regex-body-spam' and `spam-regex-body-ham'."
231 "Whether bogofilter headers should be used by `spam-split'.
232 Enable this if you pre-process messages with Bogofilter BEFORE Gnus sees them."
237 "Whether bogofilter should be invoked by `spam-split'.
238 Enable this if you want Gnus to invoke Bogofilter on new messages."
243 "Whether bsfilter headers should be used by `spam-split'.
244 Enable this if you pre-process messages with Bsfilter BEFORE Gnus sees them."
249 "Whether bsfilter should be invoked by `spam-split'.
250 Enable this if you want Gnus to invoke Bsfilter on new messages."
255 "Whether BBDB should be used by `spam-split'."
260 "Whether BBDB-exclusive should be used by `spam-split'.
261 Exclusive BBDB means that all messages from senders not in the BBDB are
262 considered spam."
267 "Whether ifile should be used by `spam-split'."
272 "Whether `spam-stat' should be used by `spam-split'."
277 "Whether spamoracle should be used by `spam-split'."
282 "Whether spamassassin should be invoked by `spam-split'.
283 Enable this if you want Gnus to invoke SpamAssassin on new messages."
288 "Whether spamassassin headers should be checked by `spam-split'.
289 Enable this if you pre-process messages with SpamAssassin BEFORE Gnus sees
290 them."
295 "Whether the CRM114 Mailfilter should be used by `spam-split'."
300 spam-use-dig
301 spam-use-gmane-xref
302 spam-use-blacklist
303 spam-use-whitelist
304 spam-use-whitelist-exclusive
305 spam-use-blackholes
306 spam-use-hashcash
307 spam-use-regex-headers
308 spam-use-regex-body
309 spam-use-bogofilter
310 spam-use-bogofilter-headers
311 spam-use-spamassassin
312 spam-use-spamassassin-headers
313 spam-use-bsfilter
314 spam-use-bsfilter-headers
315 spam-use-BBDB
316 spam-use-BBDB-exclusive
317 spam-use-ifile
318 spam-use-stat
319 spam-use-spamoracle
320 spam-use-crm114)
321 "Whether the spam hooks should be installed.
322 Default to t if one of the spam-use-* variables is set."
327 "Group name where incoming spam should be put by `spam-split'."
331 ;;; TODO: deprecate this variable, it's confusing since it's a list of strings,
332 ;;; not regular expressions
334 spam-split-group
336 "Mailgroups with spam contents.
337 All unmarked article in such group receive the spam mark on group entry."
343 "The group where spam xrefs can be found on Gmane.
344 Only meaningful if you enable `spam-use-gmane-xref'."
350 "List of blackhole servers.
351 Only meaningful if you enable `spam-use-blackholes'."
356 "String matching IP addresses that should not be checked in the blackholes.
357 Only meaningful if you enable `spam-use-blackholes'."
371 "Face for spam-marked articles."
373 ;; backward-compatibility alias
378 "Face for spam-marked articles."
383 "Regular expression for positive header spam matches.
384 Only meaningful if you enable `spam-use-regex-headers'."
389 "Regular expression for positive header ham matches.
390 Only meaningful if you enable `spam-use-regex-headers'."
395 "Regular expression for positive body spam matches.
396 Only meaningful if you enable `spam-use-regex-body'."
401 "Regular expression for positive body ham matches.
402 Only meaningful if you enable `spam-use-regex-body'."
407 "Preferred header to use for `spam-summary-score'."
415 "Spam ifile configuration."
421 "Name of the ifile program."
429 "File name of the ifile database."
435 "Name of the spam ifile category."
440 "Name of the ham ifile category.
441 If nil, the current group name will be used."
447 "Whether the ifile check will return all categories, or just spam.
448 Set this to t if you want to use the `spam-split' invocation of ifile as
449 your main source of newsgroup names."
454 "Spam bogofilter configuration."
460 "Name of the Bogofilter program."
468 "The header that Bogofilter inserts in messages."
473 "The switch that Bogofilter uses to register spam messages."
478 "The switch that Bogofilter uses to register ham messages."
483 "The switch that Bogofilter uses to unregister ham messages."
488 "The switch that Bogofilter uses to unregister spam messages."
493 "The regex on `spam-bogofilter-header' for positive spam identification."
498 "Location of the Bogofilter database.
499 When nil, use the default location."
506 "Spam bsfilter configuration."
512 "Name of the Bsfilter program."
518 "The header inserted by Bsfilter to flag spam."
523 "The header that Bsfilter inserts in messages."
528 "The switch that Bsfilter uses to register spam messages."
533 "The switch that Bsfilter uses to register ham messages."
538 "The switch that Bsfilter uses to unregister ham messages."
543 "The switch that Bsfilter uses to unregister spam messages."
548 "Directory path of the Bsfilter databases."
555 "Spam spamoracle configuration."
559 "Location of spamoracle database file.
560 When nil, use the default spamoracle database."
566 "Location of the spamoracle binary."
572 "Spam SpamAssassin configuration."
578 "Name of the spamassassin program.
580 spamd man pages for more information on these programs."
586 "Arguments to pass to the spamassassin executable.
592 "The header inserted by SpamAssassin to flag spam."
597 "The regex on `spam-spamassassin-spam-flag-header' for positive spam
598 identification"
603 "The header inserted by SpamAssassin, giving extended scoring information"
610 "Name of the sa-learn program."
616 "Whether sa-learn should rebuild the database every time it is called
617 Enable this if you want sa-learn to rebuild the database automatically. Doing
618 this will slightly increase the running time of the spam registration process.
620 order for SpamAssassin to recognize the new registered spam."
625 "The switch that sa-learn uses to register spam messages."
630 "The switch that sa-learn uses to register ham messages."
635 "The switch that sa-learn uses to unregister messages messages."
640 "Spam CRM114 Mailfilter configuration."
644 "File path of the CRM114 Mailfilter executable program."
650 "The header that CRM114 Mailfilter inserts in messages."
655 "The switch that CRM114 Mailfilter uses to register spam messages."
660 "The switch that CRM114 Mailfilter uses to register ham messages."
665 "The switch that CRM114 Mailfilter uses to unregister ham messages."
670 "The switch that CRM114 Mailfilter uses to unregister spam messages."
675 "The regex on `spam-crm114-header' for positive spam identification."
680 "Directory path of the CRM114 Mailfilter databases."
686 ;;; Key bindings for spam control.
689 "St" spam-generic-score
690 "Sx" gnus-summary-mark-as-spam
691 "Mst" spam-generic-score
692 "Msx" gnus-summary-mark-as-spam
693 "\M-d" gnus-summary-mark-as-spam
711 "Internal variable.
712 `spam-split' will set this to nil or a spam-use-XYZ check if it
715 ;; internal variables for backends
716 ;; TODO: find a way to create these on the fly in spam-install-backend-super
722 ;;}}}
724 ;;{{{ convenience functions
727 "Clear the `spam-caches' entry for a check."
731 "Logical A xor B."
735 "Return a set difference of LIST1 and LIST2.
736 When either list is nil, the other is returned."
738 ;; we have two non-nil lists
745 ;; if either of the lists was nil, return the other one
749 "Checks if MARK is considered a ham mark in GROUP."
753 marks
758 "Checks if MARK is considered a spam mark in GROUP."
762 "In GROUP, get all the ham marks."
769 marks)))
772 "In GROUP, get all the spam marks."
776 "Is GROUP a spam group?"
781 nil))
784 "Is GROUP a ham group?"
788 nil))
791 "Return list of valid classifications"
795 "Is CLASSIFICATION a valid spam/ham classification?"
799 "Return list of valid classifications."
803 "Is PROPERTY a valid backend property?"
816 'spam-group-spam-mark-p
818 alist mark-cache-yes mark-cache-no)
824 gnus-newsgroup-name
825 mark)
830 alist))
832 ;;}}}
834 ;;{{{ backend installation functions and procedures
837 "Install BACKEND for spam.el.
838 Accepts incoming CHECK, ham registration function HRF, spam
839 registration function SRF, ham unregistration function HUF, spam
840 unregistration function SUF, and an indication whether the
841 backend is STATISTICAL."
849 5
850 "spam-install-backend-super got an invalid property %s"
851 property)))))
854 "Return a list of all the backend symbols, constrained by TYPE.
855 When TYPE is 'non-mover, only non-mover backends are returned.
856 When TYPE is 'mover, only mover backends are returned."
861 ;; or the type is 'mover and the backend is a mover
865 ;; or the type is 'non-mover and the backend is not a mover
870 list))
873 "Get the check function for BACKEND.
874 Each individual check may return nil, t, or a mailgroup name.
875 The value nil means that the check does not yield a decision, and
876 so, that further checks are needed. The value t means that the
877 message is definitely not spam, and that further spam checks
878 should be inhibited. Otherwise, a mailgroup name or the symbol
879 'spam (depending on `spam-split-symbolic-return') is returned where
880 the mail should go, and further checks are also inhibited. The
881 usual mailgroup name is the value of `spam-split-group', meaning
882 that the message is definitely a spam."
886 "Is BACKEND valid?"
890 "Return information about BACKEND."
894 backend))
897 info
898 property
900 info)
902 backend)))
905 "Get the BACKEND function for CLASSIFICATION and TYPE.
906 TYPE is 'registration or 'unregistration.
907 CLASSIFICATION is 'ham or 'spam."
914 classification
915 type))))
918 5
919 "%s was passed invalid backend %s, classification %s, or type %s"
920 "spam-backend-function"
921 backend
922 classification
923 type)))
927 "Property name of article list with CLASSIFICATION and UNREGISTER."
930 prop))
933 classification
935 "Get the articles to be processed for BACKEND and CLASSIFICATION.
936 With UNREGISTER, get articles to be unregistered.
937 This is a temporary storage function - nothing here persists."
939 backend
944 "Set the LIST of articles to be processed for BACKEND and CLASSIFICATION.
945 With UNREGISTER, set articles to be unregistered.
946 This is a temporary storage function - nothing here persists."
948 backend
950 list))
953 "Get the ham registration function for BACKEND."
957 "Get the spam registration function for BACKEND."
961 "Get the ham unregistration function for BACKEND."
965 "Get the spam unregistration function for BACKEND."
969 "Is BACKEND statistical?"
973 "Is BACKEND a mover?"
977 "Add ALIAS to an existing BACKEND.
978 The previous backend settings for ALIAS are erased."
980 ;; install alias with no properties at first
987 "Install a BACKEND than can only CHECK for spam."
991 "Install a BACKEND than can move articles at summary exit.
992 Accepts ham registration function HRF, spam registration function
993 SRF, ham unregistration function HUF, spam unregistration
994 function SUF. The backend has no incoming check and can't be
995 statistical."
997 backend
1001 "Install a BACKEND than has no check.
1002 Accepts ham registration function HRF, spam registration function
1003 SRF, ham unregistration function HUF, spam unregistration
1004 function SUF. The backend has no incoming check and can't be
1005 statistical (it could be, but in practice that doesn't happen)."
1007 backend
1011 "Install a BACKEND.
1012 Accepts incoming CHECK, ham registration function HRF, spam
1013 registration function SRF, ham unregistration function HUF, spam
1014 unregistration function SUF. The backend won't be
1015 statistical (use `spam-install-statistical-backend' for that)."
1017 backend
1021 "Install a BACKEND.
1022 Accepts incoming CHECK, ham registration function HRF, spam
1023 registration function SRF, ham unregistration function HUF, spam
1024 unregistration function SUF. The backend will be
1025 statistical (use `spam-install-backend' for non-statistical
1026 backends)."
1028 backend
1032 "Install a statistical BACKEND than can only CHECK for spam."
1034 backend
1037 ;;}}}
1039 ;;{{{ backend installations
1064 ;; TODO: NOTE: spam-use-ham-copy is now obsolete, use (ham spam-use-copy)
1066 'spam-move-ham-routine
1067 'spam-move-spam-routine
1068 nil
1069 nil)
1072 'spam-copy-ham-routine
1073 'spam-copy-spam-routine
1074 nil
1075 nil)
1078 'spam-report-gmane-unregister-routine
1079 'spam-report-gmane-register-routine
1080 'spam-report-gmane-register-routine
1084 'spam-report-resend-register-ham-routine
1085 'spam-report-resend-register-routine
1086 nil
1087 nil)
1090 'spam-check-BBDB
1091 'spam-BBDB-register-routine
1092 nil
1093 'spam-BBDB-unregister-routine
1094 nil)
1099 'spam-check-blacklist
1100 nil
1101 'spam-blacklist-register-routine
1102 nil
1106 'spam-check-whitelist
1107 'spam-whitelist-register-routine
1108 nil
1109 'spam-whitelist-unregister-routine
1110 nil)
1113 'spam-check-ifile
1114 'spam-ifile-register-ham-routine
1115 'spam-ifile-register-spam-routine
1116 'spam-ifile-unregister-ham-routine
1120 'spam-check-spamoracle
1121 'spam-spamoracle-learn-ham
1122 'spam-spamoracle-learn-spam
1123 'spam-spamoracle-unlearn-ham
1127 'spam-check-stat
1128 'spam-stat-register-ham-routine
1129 'spam-stat-register-spam-routine
1130 'spam-stat-unregister-ham-routine
1134 'spam-check-spamassassin
1135 'spam-spamassassin-register-ham-routine
1136 'spam-spamassassin-register-spam-routine
1137 'spam-spamassassin-unregister-ham-routine
1141 'spam-check-bogofilter
1142 'spam-bogofilter-register-ham-routine
1143 'spam-bogofilter-register-spam-routine
1144 'spam-bogofilter-unregister-ham-routine
1148 'spam-check-bsfilter
1149 'spam-bsfilter-register-ham-routine
1150 'spam-bsfilter-register-spam-routine
1151 'spam-bsfilter-unregister-ham-routine
1155 'spam-check-crm114
1156 'spam-crm114-register-ham-routine
1157 'spam-crm114-register-spam-routine
1158 'spam-crm114-unregister-ham-routine
1160 ;;}}}
1162 ;;{{{ scoring and summary formatting
1164 "Return the extra headers spam.el thinks are necessary."
1167 spam-use-spamassassin-headers
1168 spam-use-regex-headers)
1171 spam-use-regex-headers)
1174 spam-use-regex-headers)
1176 list))
1184 "Sort articles by score."
1192 result))
1196 "Regexp matching SpamAssassin score header.
1200 "Transform an extra HEADER to a number, using list of HEADERS.
1201 Note this has to be fast."
1207 header-content
1208 spam-spamassassin-score-regexp
1210 ;; for CRM checking, it's probably faster to just do the string match
1216 header-content
1220 nil)))
1223 "Score an article for the summary buffer, as fast as possible.
1224 With SPECIFIC-HEADER, returns only that header's score.
1225 Will not return a nil score."
1238 "Invoke whatever scoring method we can."
1248 ;;}}}
1250 ;;{{{ set up widening, processor checks
1252 ;;; set up IMAP widening if it's necessary
1264 found))
1267 ;; note the nil processors are not defined in gnus.el
1285 "The OBSOLETE `spam-list-of-processors' list.
1286 This list contains pairs associating the obsolete ham/spam exit
1287 processor variables with a classification and a spam-use-*
1288 variable. When the processor variable is nil, just the
1289 classification and spam-use-* check variable are used. This is
1290 superseded by the new spam backend code, so it's only consulted
1295 "Checks if GROUP has a BACKEND with CLASSIFICATION registered.
1296 Also accepts the obsolete processors, which can be found in
1297 gnus.el and in spam-list-of-processors. In the case of mover
1298 backends, checks the setting of `spam-summary-exit-behavior' in
1299 addition to the set values for the group."
1304 found)
1307 ;; now search for the parameter
1315 ;; now, if the parameter was not found, do the
1316 ;; spam-summary-exit-behavior-logic for mover backends
1320 found
1326 ;; move ham out of spam groups
1330 spam-summary-exit-behavior))))))
1332 found))
1333 nil))
1335 ;;}}}
1337 ;;{{{ Summary entry and exit processing.
1340 ;; check the global list of group names spam-junk-mailgroups and the
1341 ;; group parameters
1345 "unseen"
1348 gnus-newsgroup-unseen
1349 gnus-newsgroup-unreads)))
1361 ;; The spam processors are invoked for any group, spam or ham or neither
1366 ;; before we begin, remove any article limits
1367 ; (ignore-errors
1368 ; (gnus-summary-pop-limit t))
1370 ;; first of all, unregister any articles that are no longer ham or spam
1371 ;; we have to iterate over the processors, or else we'll be too slow
1375 gnus-newsgroup-articles
1376 classification))
1378 ;; now that we have the changed articles, we go through the processors
1386 ;; call spam-register-routine with specific articles to unregister,
1387 ;; when there are articles to unregister and the check is enabled
1390 classification
1391 unregister-list
1392 t))))))
1394 ;; do the non-moving backends first, then the moving ones
1399 gnus-newsgroup-name
1400 backend
1401 classification)
1403 classification
1405 gnus-newsgroup-articles
1406 classification))))))
1410 ;; we mark all the leftover spam articles as expired at the end
1412 gnus-newsgroup-articles
1418 ;;}}}
1420 ;;{{{ spam-use-move and spam-use-copy backend support functions
1430 ;; remove the current process mark
1437 article mark deletep respool valid-move-destinations)
1443 ;; exclude invalid move destinations
1452 3
1453 "Sorry, can't move spam from spam group %s to spam group %s"
1454 gnus-newsgroup-name
1455 group))
1461 3
1462 "Sorry, can't move ham from ham group %s to ham group %s"
1463 gnus-newsgroup-name
1464 group)))
1469 ;; now do the actual move
1474 ;; first, mark the article with the process mark and, if needed,
1475 ;; the unread or expired mark (for ham and spam respectively)
1478 spam-mark-ham-unread-before-move-from-spam-group)
1480 article)
1485 article)
1493 spam-disable-spam-split-during-ham-respool))))
1495 article respool-method)
1497 ;; else, we are not respooling
1502 article group)
1506 article group)
1509 ;; now delete the articles, unless a) copy is t, and there was a copy done
1510 ;; b) a move was done to a single group
1511 ;; c) backend-supports-deletions is nil
1525 t
1527 articles
1532 nil
1534 articles
1539 t
1541 articles
1546 nil
1548 articles
1551 ;;}}}
1553 ;;{{{ article and field retrieval code
1558 article
1559 gnus-newsgroup-name)
1562 ;; disabled for now
1563 ;; (defun spam-get-article-as-filename (article)
1564 ;; (let ((article-filename))
1565 ;; (when (numberp article)
1566 ;; (nnml-possibly-change-directory
1567 ;; (gnus-group-real-name gnus-newsgroup-name))
1568 ;; (setq article-filename (expand-file-name
1569 ;; (int-to-string article) nnml-current-directory)))
1570 ;; (if (file-exists-p article-filename)
1571 ;; article-filename
1572 ;; nil)))
1575 "Fetch a FIELD for ARTICLE with the internal `gnus-data-list' function.
1576 When PREPARED-DATA-HEADER is given, don't look in the Gnus data.
1577 When FIELD is 'number, ARTICLE can be any number (since we want
1578 to find it out)."
1603 5
1604 "spam-fetch-field-fast: unknown field %s requested"
1605 field)
1606 nil)))))
1622 ;; 80-character limit makes for strange constructs
1634 5
1635 "spam-generate-fake-headers: article %d didn't have a valid header"
1636 article))))
1642 ;;}}}
1644 ;;{{{ Spam determination.
1647 "Split this message into the `spam' group if it is spam.
1648 This function can be used as an entry in the variable `nnmail-split-fancy',
1649 for example like this: (: spam-split). It can take checks as
1650 parameters. A string as a parameter will set the
1651 `spam-split-group' to that string.
1653 See the Info node `(gnus)Fancy Mail Splitting' for more details."
1670 widening-needed-check))
1672 decision)
1677 'spam
1678 spam-split-group)))
1680 ;; either, given specific checks, this is one of them
1682 ;; or, given no specific checks, spam-use-CHECK is set
1685 check-function)
1687 ;; if we got a decision at all, save the current check
1694 5
1696 decision
1697 spam-split-symbolic-return)))))))
1700 decision))))))))
1703 "Detect spam in the current newsgroup using `spam-split'."
1711 gnus-newsgroup-articles
1712 gnus-newsgroup-unseen))
1713 article-cannot-be-faked)
1731 registry-lookup)
1740 9
1741 "spam-find-spam: message %s was already registered incoming"
1742 id)))
1752 article
1753 group)
1754 ;; else, we fake the article
1769 id
1770 'incoming
1771 split-return
1772 spam-split-last-successful-check
1773 group))))))
1774 articles))))
1776 ;;}}}
1778 ;;{{{ registration/unregistration functions
1781 "Go through the backends and register or unregister articles as needed."
1786 backend classification))
1788 backend classification t))
1791 ;; clear the old lists right away
1793 classification
1794 nil
1795 nil)
1797 classification
1798 nil
1799 t)
1801 ;; eliminate duplicates
1810 9
1811 "%d messages did not have to unregister and then register"
1812 delcount))
1814 ;; unregister articles
1819 6
1820 "%d %s messages were unregistered by backend %s."
1821 num
1822 classification
1823 backend))))
1825 ;; register articles
1830 6
1831 "%d %s messages were registered by backend %s."
1832 num
1833 classification
1834 backend)))))))))
1837 backend
1838 specific-articles)
1842 backend
1843 specific-articles
1852 unregister-function
1853 register-function))
1855 'spam-log-undo-registration
1857 article articles)
1860 ;; make list of articles, using specific-articles if given
1863 gnus-newsgroup-articles
1864 classification)))
1865 ;; process them
1871 classification
1872 backend)
1874 ;; now log all the registrations (or undo them, depending on
1875 ;; unregister)
1879 'process
1880 classification
1881 backend
1882 gnus-newsgroup-name))))
1883 ;; return the number of articles processed
1886 ;;; log a ham- or spam-processor invocation to the registry
1900 7
1902 "%s call with bad ID, type, classification, spam-backend, or group"
1905 ;;; check if a ham- or spam-processor registration has been done
1913 7
1916 nil))))
1918 ;;; check what a ham- or spam-processor registration says
1919 ;;; returns nil if conflicting registrations are found
1922 decision)
1931 nil
1932 decision)))
1935 ;;; check if a ham- or spam-processor registration needs to be undone
1943 found)
1949 found)
1952 7
1955 nil))))
1958 ;;; undo a ham- or spam-processor registration (the group is not used)
1968 new-cell-list found)
1976 "%s call with bad ID, type, spam-backend, or group"
1978 nil))))
1980 ;;}}}
1982 ;;{{{ backend functions
1984 ;;{{{ Gmane xrefs
1991 header)
1992 spam-split-group))))
1994 ;;}}}
1996 ;;{{{ Regex body
2003 ;;}}}
2005 ;;{{{ Regex headers
2009 ret found)
2023 ret))
2025 ;;}}}
2027 ;;{{{ Blackholes.
2036 "Check the Received headers for blackholed relays."
2038 ips matches)
2048 ips)))
2052 ;; match against the reversed (again) IP string
2054 spam-blackhole-good-server-regex
2062 query-result)
2064 matches)))
2065 ;; else, if not using dig.el
2069 matches)))))))))
2071 spam-split-group)))
2072 ;;}}}
2074 ;;{{{ Hashcash.
2077 "Check the headers for hashcash payments."
2080 ;;}}}
2082 ;;{{{ BBDB
2084 ;;; original idea for spam-check-BBDB from Alexander Kotelnikov
2085 ;;; <sacha@giotto.sj.ru>
2087 ;; all this is done inside a condition-case to trap errors
2089 ;; Autoloaded in message, which we require.
2098 ;; `bbdb-records' should not be bound as an autoload function
2099 ;; before loading bbdb because of `bbdb-hashtable-size'.
2107 nil)))
2111 ;; when the BBDB changes, we want to clear out our cache
2118 "Enter an address into the BBDB; implies ham (non-spam) sender"
2124 'bbdb-delete-record-internal
2132 from
2144 ;; now do the register/unregister action
2156 "Mail from people in the BBDB is classified as ham or non-spam"
2161 t
2163 spam-split-group
2164 nil)))))))
2166 ;;}}}
2168 ;;{{{ ifile
2170 ;;; check the ifile backend; return nil if the mail was NOT classified
2171 ;;; as spam
2175 "Return the command-line parameter for ifile's database.
2176 See `spam-ifile-database'."
2179 nil))
2182 "Check the ifile backend for the classification of this message."
2184 category return)
2191 nil temp-buffer-name nil "-c"
2193 ;; check the return now (we're back in the temp buffer)
2200 ;; else, if spam-ifile-all-categories is not set...
2203 return))
2206 "Register an article, given as a string, with a category.
2207 Uses `gnus-newsgroup-name' if category is nil (for ham registration)."
2211 parameters)
2219 nil nil nil
2220 add-or-delete-option category
2235 ;;}}}
2237 ;;{{{ spam-stat
2251 "Check the spam-stat backend for the classification of this message"
2254 category return)
2287 ;;}}}
2289 ;;{{{ Blacklists and whitelists.
2299 ;;; address can be a list, too
2301 "Enter ADDRESS (list or single) into the whitelist.
2302 With a non-nil REMOVE, remove them."
2308 ;;; address can be a list, too
2310 "Enter ADDRESS (list or single) into the blacklist.
2311 With a non-nil REMOVE, remove them."
2318 "Enter ADDRESSES into the given FILE.
2319 Either the whitelist or the blacklist files can be used.
2320 With a non-nil REMOVE, remove the ADDRESSES."
2323 ;; else, we have a list of addresses here
2332 ;; found the address
2335 ;; else, the address was not found
2345 spam-blacklist-cache
2346 spam-whitelist-cache))
2347 parsed-cache)
2353 ;; fix regexp-quote's treatment of user-intended regexes
2367 found)))
2369 ;;; returns t if the sender is in the whitelist, nil or
2370 ;;; spam-split-group otherwise
2372 ;; FIXME! Should it detect when file timestamps change?
2376 t
2378 spam-split-group
2379 nil)))
2382 ;; FIXME! Should it detect when file timestamps change?
2386 spam-split-group))
2396 ;; insert the e-mail address if detected, otherwise the raw data
2405 found)
2415 from addresses unregister-list article-unregister-list)
2419 sender-ignored)
2426 ;; remember the messages we need to unregister, unless remove is set
2438 ;; else, register normally and unregister what we need to
2443 'process
2444 declassification
2445 de-symbol))
2460 ;;}}}
2462 ;;{{{ Spam-report glue (gmane and resend reporting)
2483 spam-report-resend-to)))
2486 ;;}}}
2488 ;;{{{ Bogofilter
2496 ;; spam detection mode
2498 header)
2499 spam-split-group)))))
2501 ;; return something sensible if the score can't be determined
2503 "Get the Bogofilter spamicity score."
2516 "Verify the Bogofilter version is sufficient."
2522 spam-bogofilter-valid)
2525 "Check the Bogofilter backend for the classification of this message."
2529 return)
2535 spam-bogofilter-program
2536 nil temp-buffer-name nil
2539 return)
2543 spam
2545 "Register an article, given as a string, as spam or non-spam."
2552 spam-bogofilter-spam-strong-switch
2553 spam-bogofilter-ham-strong-switch)
2555 spam-bogofilter-spam-switch
2556 spam-bogofilter-ham-switch))))
2563 spam-bogofilter-program
2564 nil nil nil switch
2581 ;;}}}
2583 ;;{{{ spamoracle
2585 "Run spamoracle on an article to determine whether it's spam."
2593 spam-spamoracle-binary
2594 nil temp-buffer-name nil
2603 spam-split-group))
2607 "Run spamoracle in training mode."
2615 "-spam"
2620 spam-spamoracle-binary
2621 nil temp-buffer-name nil
2641 ;;}}}
2643 ;;{{{ SpamAssassin
2644 ;;; based mostly on the bogofilter code
2646 "Check the SpamAssassin headers for the classification of this message."
2653 ;; spam detection mode
2657 header)
2658 spam-split-group)))))
2661 "Check the SpamAssassin backend for the classification of this message."
2668 nil temp-buffer-name nil spam-spamassassin-arguments))
2669 ;; check the return now (we're back in the temp buffer)
2673 ;; return something sensible if the score can't be determined
2675 "Get the SpamAssassin score"
2689 "Register articles with spamassassin's sa-learn as spam or non-spam."
2693 spam-sa-learn-ham-switch)))
2696 ;; group the articles into mbox format
2702 ;; mbox separator
2706 ;; call sa-learn on all messages at the same time
2709 spam-sa-learn-program
2710 nil nil nil "--mbox"
2727 ;;}}}
2729 ;;{{{ Bsfilter
2730 ;;; based mostly on the bogofilter code
2738 spam-split-group)))))
2740 ;; return something sensible if the score can't be determined
2742 "Get the Bsfilter spamicity score."
2755 "Check the Bsfilter backend for the classification of this message."
2758 return)
2764 spam-bsfilter-program
2765 nil temp-buffer-name nil
2766 "--pipe"
2767 "--insert-flag"
2768 "--insert-probability"
2772 return))
2775 spam
2777 "Register an article, given as a string, as spam or non-spam."
2782 spam-bsfilter-spam-strong-switch
2783 spam-bsfilter-ham-strong-switch)
2785 spam-bsfilter-spam-switch
2786 spam-bsfilter-ham-switch))))
2792 spam-bsfilter-program
2793 nil nil nil switch
2794 "--update"
2797 spam-bsfilter-database-directory))))))))
2811 ;;}}}
2813 ;;{{{ CRM114 Mailfilter
2821 ;; spam detection mode
2823 header)
2824 spam-split-group)))))
2826 ;; return something sensible if the score can't be determined
2828 "Get the CRM114 Mailfilter pR."
2840 "Check the CRM114 Mailfilter backend for the classification of this message."
2843 return)
2849 spam-crm114-program
2850 nil temp-buffer-name nil
2853 return))
2856 spam
2858 "Register an article, given as a string, as spam or non-spam."
2864 spam-crm114-spam-strong-switch
2865 spam-crm114-ham-strong-switch)
2867 spam-crm114-spam-switch
2868 spam-crm114-ham-switch))))
2875 spam-crm114-program
2876 nil nil nil
2891 ;;}}}
2893 ;;}}}
2895 ;;{{{ Hooks
2897 ;;;###autoload
2899 "Install the spam.el hooks and do other initialization.
2900 When SYMBOLS is given, set those variables to t. This is so you
2901 can call `spam-initialize' before you set spam-use-* variables on
2902 explicitly, and matters only if you need the extra headers
2903 installed through `spam-necessary-extra-headers'."
2914 ;; TODO: How do we redo this every time the `spam' face is customized?
2916 gnus-summary-highlight)
2917 ;; Add hooks for loading and saving the spam stats
2927 "Uninstall the spam.el hooks."
2941 ;;}}}
2945 ;;; spam.el ends here