elmo/elmo-filter.el

   1 ;;; elmo-filter.el --- Filtered Folder Interface for ELMO.
   2
   3 ;; Copyright (C) 1998,1999,2000 Yuuichi Teranishi <teranisi@gohome.org>
   4
   5 ;; Author: Yuuichi Teranishi <teranisi@gohome.org>
   6 ;; Keywords: mail, net news
   7
   8 ;; This file is part of ELMO (Elisp Library for Message Orchestration).
   9
  10 ;; This program is free software; you can redistribute it and/or modify
  11 ;; it under the terms of the GNU General Public License as published by
  12 ;; the Free Software Foundation; either version 2, or (at your option)
  13 ;; any later version.
  14 ;;
  15 ;; This program is distributed in the hope that it will be useful,
  16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 ;; GNU General Public License for more details.
  19 ;;
  20 ;; You should have received a copy of the GNU General Public License
  21 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  23 ;; Boston, MA 02111-1307, USA.
  24 ;;
  25
  26 ;;; Commentary:
  27 ;;
  28
  29 ;;; Code:
  30 ;;
  31 (require 'elmo)
  32
  33 ;;; ELMO filter folder
  34 (eval-and-compile
  35   (luna-define-class elmo-filter-folder (elmo-folder)
  36                      (condition target require-msgdb))
  37   (luna-define-internal-accessors 'elmo-filter-folder))
  38
  39 (luna-define-method elmo-folder-initialize ((folder elmo-filter-folder)
  40                                             name)
  41   (let (pair)
  42     (setq pair (elmo-parse-search-condition name))
  43     (elmo-filter-folder-set-condition-internal folder
  44                                                (car pair))
  45     (if (string-match "^ */\\(.*\\)$" (cdr pair))
  46         (elmo-filter-folder-set-target-internal
  47          folder
  48          (elmo-make-folder (elmo-match-string 1 (cdr pair))))
  49       (error "Folder syntax error `%s'" (elmo-folder-name-internal folder)))
  50     (elmo-filter-folder-set-require-msgdb-internal
  51      folder
  52      (elmo-folder-search-requires-msgdb-p
  53       (elmo-filter-folder-target-internal folder)
  54       (elmo-filter-folder-condition-internal folder)))
  55     folder))
  56
  57 (luna-define-method elmo-folder-open-internal ((folder elmo-filter-folder))
  58   (elmo-folder-open-internal (elmo-filter-folder-target-internal folder)))
  59
  60 (luna-define-method elmo-folder-msgdb :around ((folder elmo-filter-folder))
  61   ;; Load target's msgdb if required.
  62   (if (elmo-filter-folder-require-msgdb-internal folder)
  63       (elmo-folder-msgdb (elmo-filter-folder-target-internal folder)))
  64   ;; Load msgdb of itself.
  65   (luna-call-next-method))
  66
  67 (luna-define-method elmo-folder-check ((folder elmo-filter-folder))
  68   (if (elmo-filter-folder-require-msgdb-internal folder)
  69       (elmo-folder-synchronize (elmo-filter-folder-target-internal folder))))
  70
  71 (luna-define-method elmo-folder-close-internal ((folder elmo-filter-folder))
  72   (elmo-folder-close-internal (elmo-filter-folder-target-internal folder)))
  73
  74 (luna-define-method elmo-folder-close :after ((folder elmo-filter-folder))
  75   ;; Clear target msgdb if it is used.
  76   (if (elmo-filter-folder-require-msgdb-internal folder)
  77       (elmo-folder-set-msgdb-internal (elmo-filter-folder-target-internal
  78                                        folder) nil)))
  79
  80 (luna-define-method elmo-folder-commit :around ((folder elmo-filter-folder))
  81   ;; Save target msgdb if it is used.
  82   (if (elmo-filter-folder-require-msgdb-internal folder)
  83       (elmo-folder-commit (elmo-filter-folder-target-internal folder)))
  84   (luna-call-next-method))
  85
  86 (luna-define-method elmo-folder-expand-msgdb-path ((folder
  87                                                     elmo-filter-folder))
  88   (expand-file-name
  89    (elmo-replace-string-as-filename (elmo-folder-name-internal folder))
  90    (expand-file-name "filter" elmo-msgdb-directory)))
  91
  92 (luna-define-method elmo-folder-search-requires-msgdb-p ((folder
  93                                                           elmo-filter-folder)
  94                                                          condition)
  95   (elmo-folder-search-requires-msgdb-p
  96    (elmo-filter-folder-target-internal folder) condition))
  97
  98 (luna-define-method elmo-folder-newsgroups ((folder elmo-filter-folder))
  99   (elmo-folder-newsgroups (elmo-filter-folder-target-internal folder)))
 100
 101 (luna-define-method elmo-find-fetch-strategy
 102   ((folder elmo-filter-folder) entity &optional ignore-cache)
 103   (elmo-find-fetch-strategy
 104    (elmo-filter-folder-target-internal folder)
 105    entity ignore-cache))
 106
 107 (luna-define-method elmo-folder-get-primitive-list ((folder
 108                                                      elmo-filter-folder))
 109   (elmo-folder-get-primitive-list (elmo-filter-folder-target-internal folder)))
 110
 111 (luna-define-method elmo-folder-contains-type ((folder elmo-filter-folder)
 112                                                type)
 113   (elmo-folder-contains-type
 114    (elmo-filter-folder-target-internal folder)
 115    type))
 116
 117 (luna-define-method elmo-folder-msgdb-create ((folder elmo-filter-folder)
 118                                               numlist flag-table)
 119   (if (elmo-filter-folder-require-msgdb-internal folder)
 120       (let* ((target-folder (elmo-filter-folder-target-internal folder))
 121              (len (length numlist))
 122              (new-msgdb (elmo-make-msgdb))
 123              message-id entity)
 124         (elmo-folder-check target-folder)
 125         (when (> len elmo-display-progress-threshold)
 126           (elmo-progress-set 'elmo-folder-msgdb-create
 127                              len "Creating msgdb..."))
 128         (unwind-protect
 129             (dolist (number numlist)
 130               (setq entity (elmo-message-entity target-folder number))
 131               (when entity
 132                 (elmo-msgdb-append-entity
 133                  new-msgdb entity
 134                  (elmo-message-flags target-folder number)))
 135               (elmo-progress-notify 'elmo-folder-msgdb-create))
 136           (elmo-progress-clear 'elmo-folder-msgdb-create))
 137         new-msgdb)
 138     ;; Does not require msgdb.
 139     (elmo-folder-msgdb-create
 140      (elmo-filter-folder-target-internal folder)
 141      numlist flag-table)))
 142
 143 (luna-define-method elmo-folder-append-buffer ((folder elmo-filter-folder)
 144                                                &optional flag number)
 145   (elmo-folder-append-buffer
 146    (elmo-filter-folder-target-internal folder)
 147    flag number))
 148
 149 (luna-define-method elmo-message-fetch ((folder elmo-filter-folder)
 150                                         number strategy
 151                                         &optional section outbuf unseen)
 152   (elmo-message-fetch
 153    (elmo-filter-folder-target-internal folder)
 154    number strategy section outbuf unseen))
 155
 156 (luna-define-method elmo-folder-delete-messages ((folder elmo-filter-folder)
 157                                                  numbers)
 158   (elmo-folder-delete-messages
 159    (elmo-filter-folder-target-internal folder) numbers))
 160
 161 (luna-define-method elmo-folder-list-messages-internal
 162   ((folder elmo-filter-folder) &optional nohide)
 163   (let ((target (elmo-filter-folder-target-internal folder)))
 164     (if (or (elmo-folder-plugged-p target)
 165             (not (elmo-folder-persistent-p folder)))
 166         ;; search target folder
 167         (elmo-folder-search
 168          target
 169          (elmo-filter-folder-condition-internal folder))
 170       ;; not available
 171       t)))
 172
 173 (luna-define-method elmo-folder-list-subfolders ((folder elmo-filter-folder)
 174                                                  &optional one-level)
 175   (let* ((target (elmo-filter-folder-target-internal folder))
 176          (prefix (and (string-match
 177                        (concat "^\\(.*\\)"
 178                                (regexp-quote
 179                                 (elmo-folder-name-internal
 180                                  target))
 181                                "$")
 182                        (elmo-folder-name-internal folder))
 183                       (match-string 1 (elmo-folder-name-internal
 184                                        folder)))))
 185     (elmo-mapcar-list-of-list
 186      (lambda (x) (concat prefix x))
 187      (elmo-folder-list-subfolders target one-level))))
 188
 189 (luna-define-method elmo-folder-diff :around ((folder elmo-filter-folder))
 190   (let ((condition (elmo-filter-folder-condition-internal folder))
 191         diff)
 192     (if (vectorp condition)
 193         (cond
 194          ((and (string= (elmo-filter-key condition) "flag")
 195                (or (string= (elmo-filter-value condition) "any")
 196                    (string= (elmo-filter-value condition) "digest")
 197                    (string= (elmo-filter-value condition) "unread")))
 198           (setq diff (elmo-folder-diff (elmo-filter-folder-target-internal
 199                                         folder)))
 200           (if (consp diff)
 201               (cons (car diff) (car diff))
 202             (cons (car diff) (nth 1 diff))))
 203          ((string= "last" (elmo-filter-key condition))
 204           (luna-call-next-method))
 205          (t
 206           (cons nil (cdr (elmo-folder-diff (elmo-filter-folder-target-internal
 207                                             folder))))))
 208       (luna-call-next-method))))
 209
 210 (luna-define-method elmo-folder-status ((folder elmo-filter-folder))
 211   (elmo-folder-status
 212    (elmo-filter-folder-target-internal folder)))
 213
 214 (luna-define-method elmo-folder-exists-p ((folder elmo-filter-folder))
 215   (elmo-folder-exists-p (elmo-filter-folder-target-internal folder)))
 216
 217 (luna-define-method elmo-folder-creatable-p ((folder elmo-filter-folder))
 218   (elmo-folder-creatable-p (elmo-filter-folder-target-internal folder)))
 219
 220 (luna-define-method elmo-folder-writable-p ((folder elmo-filter-folder))
 221   (elmo-folder-writable-p (elmo-filter-folder-target-internal folder)))
 222
 223 (luna-define-method elmo-folder-create ((folder elmo-filter-folder))
 224   (elmo-folder-create (elmo-filter-folder-target-internal folder)))
 225
 226 (luna-define-method elmo-folder-search ((folder elmo-filter-folder)
 227                                         condition &optional numbers)
 228   ;; search from messages in this folder
 229   (let ((result (elmo-folder-search
 230                  (elmo-filter-folder-target-internal folder)
 231                  condition
 232                  (elmo-folder-list-messages folder))))
 233     (if numbers
 234         (elmo-list-filter numbers result)
 235       result)))
 236
 237 (luna-define-method elmo-message-use-cache-p ((folder elmo-filter-folder)
 238                                               number)
 239   (elmo-message-use-cache-p (elmo-filter-folder-target-internal folder)
 240                             number))
 241
 242 (luna-define-method elmo-folder-message-file-p ((folder elmo-filter-folder))
 243   (elmo-folder-message-file-p (elmo-filter-folder-target-internal folder)))
 244
 245 (luna-define-method elmo-folder-plugged-p ((folder elmo-filter-folder))
 246   (elmo-folder-plugged-p (elmo-filter-folder-target-internal folder)))
 247
 248 (luna-define-method elmo-folder-set-plugged ((folder elmo-filter-folder)
 249                                              plugged &optional add)
 250   (elmo-folder-set-plugged (elmo-filter-folder-target-internal folder)
 251                            plugged add))
 252
 253 (luna-define-method elmo-message-file-name ((folder elmo-filter-folder)
 254                                             number)
 255   (elmo-message-file-name (elmo-filter-folder-target-internal folder)
 256                           number))
 257
 258 (luna-define-method elmo-folder-set-flag :before ((folder elmo-filter-folder)
 259                                                   numbers
 260                                                   flag
 261                                                   &optional is-local)
 262   (elmo-folder-set-flag (elmo-filter-folder-target-internal folder)
 263                         numbers flag is-local))
 264
 265 (luna-define-method elmo-folder-unset-flag :before ((folder elmo-filter-folder)
 266                                                     numbers
 267                                                     flag
 268                                                     &optional is-local)
 269   (elmo-folder-unset-flag (elmo-filter-folder-target-internal folder)
 270                           numbers flag is-local))
 271
 272 (require 'product)
 273 (product-provide (provide 'elmo-filter) (require 'elmo-version))
 274
 275 ;;; elmo-filter.el ends here