elmo/elsp-bsfilter.el

   1 ;;; elsp-bsfilter.el --- Bsfilter support for elmo-spam.
   2
   3 ;; Copyright (C) 2004 Hiroya Murata <lapis-lazuli@pop06.odn.ne.jp>
   4 ;; Copyright (C) 2004 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 (require 'elmo-spam)
  33 (require 'luna)
  34
  35 (defgroup elmo-spam-bsfilter nil
  36   "Spam bsfilter configuration."
  37   :group 'elmo-spam)
  38
  39 (defcustom elmo-spam-bsfilter-shell-program "ruby"
  40   "*"
  41   :type 'string
  42   :group 'elmo-spam-bsfilter)
  43
  44 (defcustom elmo-spam-bsfilter-shell-switch nil
  45   "*"
  46   :type 'string
  47   :group 'elmo-spam-bsfilter)
  48
  49 (defcustom elmo-spam-bsfilter-program (exec-installed-p "bsfilter")
  50   "*Program name of the Bsfilter."
  51   :type '(string :tag "Program name of the bsfilter")
  52   :group 'elmo-spam-bsfilter)
  53
  54 (defcustom elmo-spam-bsfilter-args nil
  55   "*Argument list for bsfilter."
  56   :type '(repeat string)
  57   :group 'elmo-spam-bsfilter)
  58
  59 (defcustom elmo-spam-bsfilter-update-switch "--synchronous-auto-update"
  60   "*The switch that Bsfilter uses to update database with classify."
  61   :type 'string
  62   :group 'elmo-spam-bsfilter)
  63
  64 (defcustom elmo-spam-bsfilter-database-directory nil
  65   "*Directory path of the Bsfilter databases."
  66   :type '(choice (directory :tag "Location of the Bsfilter database directory")
  67                  (const :tag "Use the default"))
  68   :group 'elmo-spam-bsfilter)
  69
  70 (defcustom elmo-spam-bsfilter-max-files-per-process 100
  71   "Number of files processed at once."
  72   :type 'integer
  73   :group 'elmo-spam-bsfilter)
  74
  75 (defcustom elmo-spam-bsfilter-max-messages-per-process 30
  76   "Number of messages processed at once."
  77   :type 'integer
  78   :group 'elmo-spam-bsfilter)
  79
  80 (defcustom elmo-spam-bsfilter-debug nil
  81   "Non-nil to debug elmo bsfilter spam backend."
  82   :type 'boolean
  83   :group 'elmo-spam-bsfilter)
  84
  85 (eval-and-compile
  86   (luna-define-class elsp-bsfilter (elsp-generic)))
  87
  88 (defsubst elsp-bsfilter-call-bsfilter (&rest args)
  89   (apply #'call-process-region
  90          (point-min) (point-max)
  91          elmo-spam-bsfilter-shell-program
  92          nil (if elmo-spam-bsfilter-debug
  93                  (get-buffer-create "*Debug ELMO Bsfilter*"))
  94          nil
  95          (append (if elmo-spam-bsfilter-shell-switch
  96                      (list elmo-spam-bsfilter-shell-switch))
  97                  (if elmo-spam-bsfilter-program
  98                      (list elmo-spam-bsfilter-program))
  99                  elmo-spam-bsfilter-args
 100                  (if elmo-spam-bsfilter-database-directory
 101                      (list "--homedir" elmo-spam-bsfilter-database-directory))
 102                  (elmo-flatten args))))
 103
 104 (luna-define-method elmo-spam-buffer-spam-p ((processor elsp-bsfilter)
 105                                              buffer &optional register)
 106   (with-current-buffer buffer
 107     (= 0 (elsp-bsfilter-call-bsfilter
 108           (if register elmo-spam-bsfilter-update-switch)))))
 109
 110 (defsubst elsp-bsfilter-list-spam-files (targets)
 111   (let ((temp-file (and elmo-spam-bsfilter-debug
 112                         (make-temp-file "elsp-bserror"))))
 113     (unwind-protect
 114         (apply
 115          #'call-process
 116          elmo-spam-bsfilter-shell-program
 117          nil
 118          (list t temp-file)
 119          nil
 120          (append (if elmo-spam-bsfilter-shell-switch
 121                      (list elmo-spam-bsfilter-shell-switch))
 122                  (if elmo-spam-bsfilter-program
 123                      (list elmo-spam-bsfilter-program))
 124                  elmo-spam-bsfilter-args
 125                  (list "--list-spam")
 126                  (if elmo-spam-bsfilter-database-directory
 127                      (list "--homedir" elmo-spam-bsfilter-database-directory))
 128                  targets))
 129       (when (and temp-file (file-exists-p temp-file))
 130         (with-current-buffer (get-buffer-create "*Debug ELMO Bsfilter*")
 131           (goto-char (point-max))
 132           (insert-file-contents temp-file))
 133         (delete-file temp-file)))))
 134
 135 (luna-define-method elmo-spam-list-spam-messages :around
 136   ((processor elsp-bsfilter) folder &optional numbers)
 137   (if (not (elmo-folder-message-file-p folder))
 138       (luna-call-next-method)
 139     (let* ((nth-of-targets (1- (or elmo-spam-bsfilter-max-files-per-process
 140                                    100)))
 141            (numbers (or numbers (elmo-folder-list-messages folder t t)))
 142            (hash (elmo-make-hash (length numbers)))
 143            (targets (mapcar
 144                      (lambda (number)
 145                        (let ((filename (elmo-message-file-name folder number)))
 146                          (elmo-set-hash-val filename number hash)
 147                          filename))
 148                      numbers))
 149            results)
 150       (with-temp-buffer
 151         (while targets
 152           (let* ((last (nthcdr nth-of-targets targets))
 153                  (next (cdr last)))
 154             (when last
 155               (setcdr last nil))
 156             (elsp-bsfilter-list-spam-files targets)
 157             (elmo-progress-notify 'elmo-spam-check-spam (length targets))
 158             (setq targets next)))
 159         (goto-char (point-min))
 160         (while (not (eobp))
 161           (let* ((filename (buffer-substring (point) (save-excursion
 162                                                        (end-of-line)
 163                                                        (point))))
 164                  (number (elmo-get-hash-val filename hash)))
 165             (when number
 166               (setq results (cons number results)))
 167             (forward-line))))
 168       results)))
 169
 170
 171 (defsubst elsp-bsfilter-register-buffer (buffer spam restore &optional mbox)
 172   (with-current-buffer buffer
 173     (elsp-bsfilter-call-bsfilter
 174      "--update"
 175      (if restore (if spam "--sub-clean" "--sub-spam"))
 176      (if spam "--add-spam" "--add-clean")
 177      (if mbox "--mbox"))))
 178
 179 (luna-define-method elmo-spam-register-spam-buffer ((processor elsp-bsfilter)
 180                                                     buffer &optional restore)
 181   (elsp-bsfilter-register-buffer buffer t restore))
 182
 183 (luna-define-method elmo-spam-register-good-buffer ((processor elsp-bsfilter)
 184                                                     buffer &optional restore)
 185   (elsp-bsfilter-register-buffer buffer nil restore))
 186
 187 (defsubst elmo-spam-bsfilter-register-messages (folder numbers spam restore)
 188   (let ((numbers (or numbers (elmo-folder-list-messages folder t t))))
 189     (if (and (> (length numbers) 1)
 190              elmo-spam-bsfilter-max-messages-per-process
 191              (> elmo-spam-bsfilter-max-messages-per-process 0))
 192         (elmo-spam-process-messages-as-mbox
 193          folder numbers
 194          elmo-spam-bsfilter-max-messages-per-process
 195          (lambda (count spam restore)
 196            (elsp-bsfilter-register-buffer (current-buffer) spam restore 'mbox)
 197            (elmo-progress-notify 'elmo-spam-register count))
 198          spam restore)
 199       (luna-call-next-method))))
 200
 201 (luna-define-method elmo-spam-register-spam-messages :around
 202   ((processor elsp-bsfilter) folder &optional numbers restore)
 203   (elmo-spam-bsfilter-register-messages folder numbers t restore))
 204
 205 (luna-define-method elmo-spam-register-good-messages :around
 206   ((processor elsp-bsfilter) folder &optional numbers restore)
 207   (elmo-spam-bsfilter-register-messages folder numbers nil restore))
 208
 209 (require 'product)
 210 (product-provide (provide 'elsp-bsfilter) (require 'elmo-version))
 211
 212 ;;; elsp-bsfilter.el ends here