Synch to Gnus 200311251206.
[elisp/gnus.git-] / lisp / spam.el
index 0f13940..4280e26 100644 (file)
 (eval-and-compile
   (autoload 'spam-report-gmane "spam-report"))
 
+;; autoload gnus-registry
+(eval-and-compile
+  (autoload 'gnus-registry-store-extra-entry "gnus-registry")
+  (autoload 'gnus-registry-fetch-extra "gnus-registry"))
+
 ;; autoload query-dns
 (eval-and-compile
   (autoload 'query-dns "dns"))
@@ -82,6 +87,11 @@ spam groups."
   :type 'boolean
   :group 'spam)
 
+(defcustom spam-log-to-registry nil
+  "Whether spam/ham processing should be logged in the registry."
+  :type 'boolean
+  :group 'spam)
+
 (defcustom spam-process-ham-in-spam-groups nil
   "Whether ham should be processed in spam groups."
   :type 'boolean
@@ -218,7 +228,7 @@ considered spam."
                               spam-use-spamoracle)
   "Whether the spam hooks should be installed, default to t if one of
 the spam-use-* variables is set."
-  :group 'gnus-registry
+  :group 'spam
   :type 'boolean)
 
 (defcustom spam-split-group "spam"
@@ -342,7 +352,7 @@ your main source of newsgroup names."
   :group 'spam-ifile)
 
 (defgroup spam-spamoracle nil
-  "Spam ifile configuration."
+  "Spam spamoracle configuration."
   :group 'spam)
 
 (defcustom spam-spamoracle-database nil 
@@ -546,46 +556,61 @@ spamoracle database."
        (gnus-summary-mark-article article gnus-spam-mark)))))
 
 (defun spam-mark-spam-as-expired-and-move-routine (&rest groups)
-  (gnus-summary-kill-process-mark)
-  (let ((articles gnus-newsgroup-articles)
-       article tomove deletep)
-    (dolist (article articles)
-      (when (eq (gnus-summary-article-mark article) gnus-spam-mark)
-       (gnus-summary-mark-article article gnus-expirable-mark)
-       (push article tomove)))
+  (if (and groups (listp (car groups)))
+      (apply 'spam-mark-spam-as-expired-and-move-routine (car groups))
+    (gnus-summary-kill-process-mark)
+    (let ((articles gnus-newsgroup-articles)
+         (backend-supports-deletions
+          (gnus-check-backend-function
+           'request-move-article gnus-newsgroup-name))
+         article tomove deletep)
+      (dolist (article articles)
+       (when (eq (gnus-summary-article-mark article) gnus-spam-mark)
+         (gnus-summary-mark-article article gnus-expirable-mark)
+         (push article tomove)))
     
-    ;; now do the actual copies
-    (dolist (group groups)
-      (when (and tomove
-                (stringp group))
+      ;; now do the actual copies
+      (dolist (group groups)
+       (when (and tomove
+                  (stringp group))
+         (dolist (article tomove)
+           (gnus-summary-set-process-mark article))
+         (when tomove
+           (if (or (not backend-supports-deletions)
+                   (> (length groups) 1))
+               (progn 
+                 (gnus-summary-copy-article nil group)
+                 (setq deletep t))
+             (gnus-summary-move-article nil group)))))
+    
+      ;; now delete the articles, if there was a copy done, and the
+      ;; backend allows it
+      (when (and deletep backend-supports-deletions)
        (dolist (article tomove)
          (gnus-summary-set-process-mark article))
        (when tomove
-         (if (> (length groups) 1)
-             (progn 
-               (gnus-summary-copy-article nil group)
-               (setq deletep t))
-           (gnus-summary-move-article nil group)))))
-    
-    ;; now delete the articles, if there was a copy done
-    (when deletep
-      (dolist (article tomove)
-       (gnus-summary-set-process-mark article))
-      (when tomove
-       (let ((gnus-novice-user nil))   ; don't ask me if I'm sure
-         (gnus-summary-delete-article nil))))
+         (let ((gnus-novice-user nil)) ; don't ask me if I'm sure
+           (gnus-summary-delete-article nil))))
     
-    (gnus-summary-yank-process-mark)))
+      (gnus-summary-yank-process-mark))))
  
 (defun spam-ham-copy-or-move-routine (copy groups)
   (gnus-summary-kill-process-mark)
   (let ((articles gnus-newsgroup-articles)
-       article mark todo deletep)
+       (backend-supports-deletions
+        (gnus-check-backend-function
+         'request-move-article gnus-newsgroup-name))
+       (respool-method (gnus-find-method-for-group gnus-newsgroup-name))
+       article mark todo deletep respool)
     (dolist (article articles)
       (when (spam-group-ham-mark-p gnus-newsgroup-name
                                   (gnus-summary-article-mark article))
        (push article todo)))
 
+    (when (member 'respool groups)
+      (setq respool t)                 ; boolean for later
+      (setq groups '("fake"))) ; when respooling, groups are dynamic so fake it
+
     ;; now do the actual move
     (dolist (group groups)
       (when (and todo (stringp group))
@@ -594,16 +619,20 @@ spamoracle database."
            (gnus-summary-mark-article article gnus-unread-mark))
          (gnus-summary-set-process-mark article))
 
-       (if (> (length groups) 1)
-           (progn 
-             (gnus-summary-copy-article nil group)
-             (setq deletep t))
-         (gnus-summary-move-article nil group))))
-  
-    ;; now delete the articles, unless a) copy is t, and when there was a copy done
+       (if respool                        ; respooling is with a "fake" group
+           (gnus-summary-respool-article nil respool-method)
+         (if (or (not backend-supports-deletions) ; else, we are not respooling
+                 (> (length groups) 1))
+             (progn                    ; if copying, copy and set deletep
+               (gnus-summary-copy-article nil group)
+               (setq deletep t))
+           (gnus-summary-move-article nil group))))) ; else move articles
+    
+    ;; now delete the articles, unless a) copy is t, and there was a copy done
     ;;                                 b) a move was done to a single group
+    ;;                                 c) backend-supports-deletions is nil
     (unless copy
-      (when deletep
+      (when (and deletep backend-supports-deletions)
        (dolist (article todo)
          (gnus-summary-set-process-mark article))
        (when todo
@@ -613,10 +642,14 @@ spamoracle database."
   (gnus-summary-yank-process-mark))
  
 (defun spam-ham-copy-routine (&rest groups)
-  (spam-ham-copy-or-move-routine t groups))
+  (if (and groups (listp (car groups)))
+      (apply 'spam-ham-copy-routine (car groups))
+    (spam-ham-copy-or-move-routine t groups)))
  
 (defun spam-ham-move-routine (&rest groups)
-  (spam-ham-copy-or-move-routine nil groups))
+  (if (and groups (listp (car groups)))
+      (apply 'spam-ham-move-routine (car groups))
+    (spam-ham-copy-or-move-routine nil groups)))
  
 (defun spam-generic-register-routine (spam-func ham-func)
   (let ((articles gnus-newsgroup-articles)
@@ -687,6 +720,13 @@ spamoracle database."
       (mail-header-subject (gnus-data-header (assoc article (gnus-data-list nil))))
     nil))
 
+(defun spam-fetch-field-message-id-fast (article)
+  "Fetch the `subject' field quickly, using the internal gnus-data-list function"
+  (if (and (numberp article)
+          (assoc article (gnus-data-list nil)))
+      (mail-header-message-id (gnus-data-header (assoc article (gnus-data-list nil))))
+    nil))
+
 \f
 ;;;; Spam determination.
 
@@ -759,7 +799,51 @@ See the Info node `(gnus)Fancy Mail Splitting' for more details."
            (if (eq decision t)
                nil
              decision)))))))
-  
+
+;;; log a ham- or spam-processor invocation to the registry
+(defun spam-log-processing-to-registry (id type classification check group)
+  (when spam-log-to-registry
+    (if (and (stringp id)
+            (stringp group)
+            (or (eq type 'incoming)
+                (eq type 'process))
+            (or (eq classification 'spam)
+                (eq classification 'ham))
+            (assoc check spam-list-of-checks))
+       (let ((cell-list (cdr-safe (gnus-registry-fetch-extra id type)))
+              (cell (list classification check group)))
+         (push cell cell-list)
+         (gnus-registry-store-extra-entry
+          id
+          type
+          cell-list))
+
+      (gnus-message 5 (format "%s called with bad ID, type, check, or group"
+                             "spam-log-processing-to-registry")))))
+
+;;; check if a ham- or spam-processor registration needs to be undone
+(defun spam-log-unregistration-needed-p (id type classification check)
+  (when spam-log-to-registry
+    (if (and (stringp id)
+            (or (eq type 'incoming)
+                (eq type 'process))
+            (or (eq classification 'spam)
+                (eq classification 'ham))
+            (assoc check spam-list-of-checks))
+       (let ((cell-list (cdr-safe (gnus-registry-fetch-extra id type)))
+             found)
+         (dolist (cell cell-list)
+           (unless found
+             (when (and (eq classification (nth 0 cell))
+                        (eq check (nth 1 cell)))
+               (setq found t))))
+         found)
+      (progn 
+       (gnus-message 5 (format "%s called with bad ID, type, check, or group"
+                               "spam-log-unregistration-needed-p"))
+       nil))))
+
+;;; set up IMAP widening if it's necessary  
 (defun spam-setup-widening ()
   (dolist (check spam-list-of-statistical-checks)
     (when (symbol-value check)
@@ -885,6 +969,12 @@ See the Info node `(gnus)Fancy Mail Splitting' for more details."
      nil
      ;; ham function
      (lambda (article)
+       (spam-log-processing-to-registry
+       (spam-fetch-field-message-id-fast article)
+       'process
+       'ham
+       'spam-use-BBDB 
+       gnus-newsgroup-name)
        (spam-enter-ham-BBDB (spam-fetch-field-from-fast article)))))
 
   (defun spam-check-BBDB ()
@@ -962,6 +1052,12 @@ Uses `gnus-newsgroup-name' if category is nil (for ham registration)."
 (defun spam-ifile-register-spam-routine ()
   (spam-generic-register-routine 
    (lambda (article)
+     (spam-log-processing-to-registry 
+      (spam-fetch-field-message-id-fast article)
+      'process
+      'spam
+      'spam-use-ifile
+      gnus-newsgroup-name)
      (spam-ifile-register-with-ifile 
       (spam-get-article-as-string article) spam-ifile-spam-category))
    nil))
@@ -970,6 +1066,12 @@ Uses `gnus-newsgroup-name' if category is nil (for ham registration)."
   (spam-generic-register-routine 
    nil
    (lambda (article)
+     (spam-log-processing-to-registry 
+      (spam-fetch-field-message-id-fast article)
+      'process
+      'ham
+      'spam-use-ifile
+      gnus-newsgroup-name)
      (spam-ifile-register-with-ifile 
       (spam-get-article-as-string article) spam-ifile-ham-category))))
 
@@ -991,6 +1093,12 @@ Uses `gnus-newsgroup-name' if category is nil (for ham registration)."
       (defun spam-stat-register-spam-routine ()
        (spam-generic-register-routine 
         (lambda (article)
+          (spam-log-processing-to-registry 
+           (spam-fetch-field-message-id-fast article)
+           'process
+           'spam
+           'spam-use-stat
+           gnus-newsgroup-name)
           (let ((article-string (spam-get-article-as-string article)))
             (with-temp-buffer
               (insert article-string)
@@ -1001,6 +1109,12 @@ Uses `gnus-newsgroup-name' if category is nil (for ham registration)."
        (spam-generic-register-routine 
         nil
         (lambda (article)
+          (spam-log-processing-to-registry 
+           (spam-fetch-field-message-id-fast article)
+           'process
+           'ham
+           'spam-use-stat
+           gnus-newsgroup-name)
           (let ((article-string (spam-get-article-as-string article)))
             (with-temp-buffer
               (insert article-string)
@@ -1108,6 +1222,12 @@ Uses `gnus-newsgroup-name' if category is nil (for ham registration)."
   (spam-generic-register-routine 
    ;; the spam function
    (lambda (article)
+     (spam-log-processing-to-registry 
+      (spam-fetch-field-message-id-fast article)
+      'process
+      'spam
+      'spam-use-blacklist
+      gnus-newsgroup-name)
      (let ((from (spam-fetch-field-from-fast article)))
        (when (stringp from)
           (spam-enter-blacklist from))))
@@ -1120,6 +1240,12 @@ Uses `gnus-newsgroup-name' if category is nil (for ham registration)."
    nil 
    ;; the ham function
    (lambda (article)
+     (spam-log-processing-to-registry 
+      (spam-fetch-field-message-id-fast article)
+      'process
+      'ham
+      'spam-use-whitelist
+      gnus-newsgroup-name)
      (let ((from (spam-fetch-field-from-fast article)))
        (when (stringp from)
           (spam-enter-whitelist from))))))
@@ -1194,6 +1320,12 @@ Uses `gnus-newsgroup-name' if category is nil (for ham registration)."
 (defun spam-bogofilter-register-spam-routine ()
   (spam-generic-register-routine 
    (lambda (article)
+     (spam-log-processing-to-registry 
+      (spam-fetch-field-message-id-fast article)
+      'process
+      'spam
+      'spam-use-bogofilter
+      gnus-newsgroup-name)
      (spam-bogofilter-register-with-bogofilter
       (spam-get-article-as-string article) t))
    nil))
@@ -1202,6 +1334,12 @@ Uses `gnus-newsgroup-name' if category is nil (for ham registration)."
   (spam-generic-register-routine 
    nil
    (lambda (article)
+     (spam-log-processing-to-registry 
+      (spam-fetch-field-message-id-fast article)
+      'process
+      'ham
+      'spam-use-bogofilter
+      gnus-newsgroup-name)
      (spam-bogofilter-register-with-bogofilter
       (spam-get-article-as-string article) nil))))
 
@@ -1254,11 +1392,23 @@ Uses `gnus-newsgroup-name' if category is nil (for ham registration)."
   (spam-generic-register-routine 
    nil
    (lambda (article)
+     (spam-log-processing-to-registry 
+      (spam-fetch-field-message-id-fast article)
+      'process
+      'ham
+      'spam-use-spamoracle
+      gnus-newsgroup-name)
      (spam-spamoracle-learn article nil))))
 
 (defun spam-spamoracle-learn-spam ()
   (spam-generic-register-routine 
    (lambda (article)
+     (spam-log-processing-to-registry 
+      (spam-fetch-field-message-id-fast article)
+      'process
+      'spam
+      'spam-use-spamoracle
+      gnus-newsgroup-name)
      (spam-spamoracle-learn article t))
    nil))
 \f