elmo/elmo-spam.el

   1 ;;; elmo-spam.el --- Spam filtering interface to processor.
   2
   3 ;; Copyright (C) 2003 Hiroya Murata <lapis-lazuli@pop06.odn.ne.jp>
   4 ;; Copyright (C) 2003 Yuuichi Teranishi <teranisi@gohome.org>
   5
   6 ;; Author: Hiroya Murata <lapis-lazuli@pop06.odn.ne.jp>
   7 ;; Keywords: mail, net news, spam
   8
   9 ;; This file is part of Wanderlust (Yet Another Message Interface on Emacsen).
  10
  11 ;; This program 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 2, or (at your option)
  14 ;; any later version.
  15 ;;
  16 ;; This program 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.
  20 ;;
  21 ;; You should have received a copy of the GNU General Public License
  22 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  24 ;; Boston, MA 02111-1307, USA.
  25 ;;
  26
  27 ;;; Commentary:
  28 ;;
  29
  30 ;;; Code:
  31 ;;
  32
  33 (eval-when-compile (require 'cl))
  34
  35 (require 'luna)
  36 (require 'elmo-util)
  37 (require 'elmo)
  38
  39 (defgroup elmo-spam nil
  40   "Spam configuration for wanderlust."
  41   :group 'elmo)
  42
  43 (defcustom elmo-spam-scheme nil
  44   "*Scheme of spam processor implementation. "
  45   :type '(choice (const :tag "none" nil)
  46                  (const :tag "Bogofilter" bogofilter))
  47   :group 'elmo-spam)
  48
  49 (eval-and-compile
  50   (luna-define-class elsp-generic ()))
  51
  52 ;; required method
  53 (luna-define-generic elmo-spam-buffer-spam-p (processor buffer)
  54   "Return non-nil if contents of BUFFER is spam.
  55 PROCESSOR is spam processor structure.")
  56
  57 (luna-define-generic elmo-spam-register-spam-buffer (processor buffer)
  58   "Register contents of BUFFER as spam.
  59 PROCESSOR is spam processor structure.")
  60
  61 (luna-define-generic elmo-spam-register-good-buffer (processor buffer)
  62   "Register contents of BUFFER as non spam.
  63 PROCESSOR is spam processor structure.")
  64
  65 (luna-define-generic elmo-spam-modified-p (processor)
  66   "Return non-nil if status of PROCESSOR is modified.")
  67
  68 (luna-define-generic elmo-spam-save-status (processor)
  69   "Save status of the PROCESSOR.")
  70
  71 ;; optional method
  72 (luna-define-generic elmo-spam-message-spam-p (processor folder number)
  73   "Return non-nil if the message in the FOLDER with NUMBER is spam.
  74 PROCESSOR is spam processor structure.")
  75
  76 (luna-define-generic elmo-spam-list-spam-messages (processor
  77                                                    folder &optional numbers)
  78   "Return a list of message numbers which is gussed spam.
  79 PROCESSOR is spam processor structure.
  80 FOLDER is the ELMO folder structure.
  81 If optional argument NUMBERS is specified and is a list of message numbers,
  82 messages are searched from the list.")
  83
  84 (luna-define-generic elmo-spam-register-spam-messages (processor
  85                                                        folder &optional numbers)
  86   "Register contents of messages as spam.
  87 PROCESSOR is spam processor structure.
  88 FOLDER is the ELMO folder structure.
  89 If optional argument NUMBERS is specified and is a list of message numbers,
  90 messages are searched from the list.")
  91
  92 (luna-define-generic elmo-spam-register-good-messages (processor
  93                                                        folder &optional numbers)
  94   "Register contents of messages as non spam.
  95 PROCESSOR is spam processor structure.
  96 FOLDER is the ELMO folder structure.
  97 If optional argument NUMBERS is specified and is a list of message numbers,
  98 messages are searched from the list.")
  99
 100 ;; for internal use
 101 (defun elmo-spam-message-fetch (folder number)
 102   (let (elmo-message-fetch-threshold)
 103     (elmo-message-fetch
 104      folder number
 105      (elmo-find-fetch-strategy folder
 106                                (elmo-message-entity folder number))
 107      nil (current-buffer) 'unread)))
 108
 109 ;; generic implement
 110 (luna-define-method elmo-spam-message-spam-p ((processor elsp-generic)
 111                                               folder number)
 112   (with-temp-buffer
 113     (elmo-spam-message-fetch folder number)
 114     (elmo-spam-buffer-spam-p processor (current-buffer))))
 115
 116 (luna-define-method elmo-spam-list-spam-messages ((processor elsp-generic)
 117                                                   folder &optional numbers)
 118   (let ((numbers (or numbers (elmo-folder-list-messages folder t t)))
 119         spam-list)
 120     (dolist (number numbers)
 121       (when (elmo-spam-message-spam-p processor folder number)
 122         (setq spam-list (cons number spam-list)))
 123       (elmo-progress-notify 'elmo-spam-check-spam))
 124     (nreverse spam-list)))
 125
 126 (luna-define-method elmo-spam-register-spam-messages ((processor elsp-generic)
 127                                                       folder &optional numbers)
 128   (let ((numbers (or numbers (elmo-folder-list-messages folder t t))))
 129     (with-temp-buffer
 130       (buffer-disable-undo (current-buffer))
 131       (dolist (number numbers)
 132         (erase-buffer)
 133         (elmo-spam-message-fetch folder number)
 134         (elmo-spam-register-spam-buffer processor (current-buffer))
 135         (elmo-progress-notify 'elmo-spam-register)))))
 136
 137 (luna-define-method elmo-spam-register-good-messages ((processor elsp-generic)
 138                                                       folder &optional numbers)
 139   (let ((numbers (or numbers (elmo-folder-list-messages folder t t))))
 140     (with-temp-buffer
 141       (buffer-disable-undo (current-buffer))
 142       (dolist (number numbers)
 143         (erase-buffer)
 144         (elmo-spam-message-fetch folder number)
 145         (elmo-spam-register-good-buffer processor (current-buffer))
 146         (elmo-progress-notify 'elmo-spam-register)))))
 147
 148 (provide 'elsp-generic)
 149
 150 (defvar elmo-spam-processor-internal nil)
 151
 152 (defun elmo-spam-processor ()
 153   (or elmo-spam-processor-internal
 154       (let* ((scheme (or elmo-spam-scheme 'generic))
 155              (class (intern (format "elsp-%s" scheme))))
 156         (require class)
 157         (setq elmo-spam-processor-internal
 158               (luna-make-entity class)))))
 159
 160 (require 'product)
 161 (product-provide (provide 'elmo-spam) (require 'elmo-version))
 162
 163 ;;; elmo-sapm.el ends here